DisplayApplianceEnvelope
in package
implements
ArrayAccess
DisplayApplianceEnvelope Class Doc Comment
Tags
Interfaces, Classes, Traits and Enums
- ArrayAccess
Table of Contents
- DISCRIMINATOR = null
- $attributeMap : array<string|int, string>
- Array of attributes where the key is the local name, and the value is the original name
- $container : array<string|int, mixed>
- Associative array for storing property values
- $getters : array<string|int, string>
- Array of attributes to getter functions (for serialization of requests)
- $setters : array<string|int, string>
- Array of attributes to setter functions (for deserialization of responses)
- $swaggerModelName : string
- The original name of the model.
- $swaggerTypes : array<string|int, string>
- Array of property to type mappings. Used for (de)serialization
- __construct() : mixed
- Constructor
- __toString() : string
- Gets the string presentation of the object
- attributeMap() : mixed
- getAddDemoStamp() : bool
- Gets add_demo_stamp
- getAllowMultipleAttachments() : bool
- Gets allow_multiple_attachments
- getBurnDefaultTabData() : bool
- Gets burn_default_tab_data
- getConvertPdfFields() : bool
- Gets convert_pdf_fields
- getEnvelopeId() : string
- Gets envelope_id
- getEnvelopeType() : string
- Gets envelope_type
- getIncludeSigsBeforeComplete() : bool
- Gets include_sigs_before_complete
- getIsConcatMode() : bool
- Gets is_concat_mode
- getIsEnvelopeIdStampingEnabled() : bool
- Gets is_envelope_id_stamping_enabled
- getPdfFormConversionFontScale100() : bool
- Gets pdf_form_conversion_font_scale100
- getShouldFlatten() : bool
- Gets should_flatten
- getShowEnvelopeChanges() : bool
- Gets show_envelope_changes
- getSignOnline() : bool
- Gets sign_online
- getStatus() : string
- Gets status
- getters() : mixed
- getUserId() : string
- Gets user_id
- listInvalidProperties() : array<string|int, mixed>
- show all the invalid properties with reasons.
- offsetExists() : bool
- Returns true if offset exists. False otherwise.
- offsetGet() : mixed
- Gets offset.
- offsetSet() : void
- Sets value based on offset.
- offsetUnset() : void
- Unsets offset.
- setAddDemoStamp() : $this
- Sets add_demo_stamp
- setAllowMultipleAttachments() : $this
- Sets allow_multiple_attachments
- setBurnDefaultTabData() : $this
- Sets burn_default_tab_data
- setConvertPdfFields() : $this
- Sets convert_pdf_fields
- setEnvelopeId() : $this
- Sets envelope_id
- setEnvelopeType() : $this
- Sets envelope_type
- setIncludeSigsBeforeComplete() : $this
- Sets include_sigs_before_complete
- setIsConcatMode() : $this
- Sets is_concat_mode
- setIsEnvelopeIdStampingEnabled() : $this
- Sets is_envelope_id_stamping_enabled
- setPdfFormConversionFontScale100() : $this
- Sets pdf_form_conversion_font_scale100
- setShouldFlatten() : $this
- Sets should_flatten
- setShowEnvelopeChanges() : $this
- Sets show_envelope_changes
- setSignOnline() : $this
- Sets sign_online
- setStatus() : $this
- Sets status
- setters() : mixed
- setUserId() : $this
- Sets user_id
- swaggerTypes() : mixed
- valid() : bool
- validate all the properties in the model return true if all passed
Constants
DISCRIMINATOR
public
mixed
DISCRIMINATOR
= null
Properties
$attributeMap
Array of attributes where the key is the local name, and the value is the original name
protected
static array<string|int, string>
$attributeMap
= ['add_demo_stamp' => 'addDemoStamp', 'allow_multiple_attachments' => 'allowMultipleAttachments', 'burn_default_tab_data' => 'burnDefaultTabData', 'convert_pdf_fields' => 'convertPdfFields', 'envelope_id' => 'envelopeId', 'envelope_type' => 'envelopeType', 'include_sigs_before_complete' => 'includeSigsBeforeComplete', 'is_concat_mode' => 'isConcatMode', 'is_envelope_id_stamping_enabled' => 'isEnvelopeIDStampingEnabled', 'pdf_form_conversion_font_scale100' => 'pdfFormConversionFontScale100', 'should_flatten' => 'shouldFlatten', 'show_envelope_changes' => 'showEnvelopeChanges', 'sign_online' => 'signOnline', 'status' => 'status', 'user_id' => 'userId']
$container
Associative array for storing property values
protected
array<string|int, mixed>
$container
= []
$getters
Array of attributes to getter functions (for serialization of requests)
protected
static array<string|int, string>
$getters
= ['add_demo_stamp' => 'getAddDemoStamp', 'allow_multiple_attachments' => 'getAllowMultipleAttachments', 'burn_default_tab_data' => 'getBurnDefaultTabData', 'convert_pdf_fields' => 'getConvertPdfFields', 'envelope_id' => 'getEnvelopeId', 'envelope_type' => 'getEnvelopeType', 'include_sigs_before_complete' => 'getIncludeSigsBeforeComplete', 'is_concat_mode' => 'getIsConcatMode', 'is_envelope_id_stamping_enabled' => 'getIsEnvelopeIdStampingEnabled', 'pdf_form_conversion_font_scale100' => 'getPdfFormConversionFontScale100', 'should_flatten' => 'getShouldFlatten', 'show_envelope_changes' => 'getShowEnvelopeChanges', 'sign_online' => 'getSignOnline', 'status' => 'getStatus', 'user_id' => 'getUserId']
$setters
Array of attributes to setter functions (for deserialization of responses)
protected
static array<string|int, string>
$setters
= ['add_demo_stamp' => 'setAddDemoStamp', 'allow_multiple_attachments' => 'setAllowMultipleAttachments', 'burn_default_tab_data' => 'setBurnDefaultTabData', 'convert_pdf_fields' => 'setConvertPdfFields', 'envelope_id' => 'setEnvelopeId', 'envelope_type' => 'setEnvelopeType', 'include_sigs_before_complete' => 'setIncludeSigsBeforeComplete', 'is_concat_mode' => 'setIsConcatMode', 'is_envelope_id_stamping_enabled' => 'setIsEnvelopeIdStampingEnabled', 'pdf_form_conversion_font_scale100' => 'setPdfFormConversionFontScale100', 'should_flatten' => 'setShouldFlatten', 'show_envelope_changes' => 'setShowEnvelopeChanges', 'sign_online' => 'setSignOnline', 'status' => 'setStatus', 'user_id' => 'setUserId']
$swaggerModelName
The original name of the model.
protected
static string
$swaggerModelName
= 'displayApplianceEnvelope'
$swaggerTypes
Array of property to type mappings. Used for (de)serialization
protected
static array<string|int, string>
$swaggerTypes
= ['add_demo_stamp' => 'bool', 'allow_multiple_attachments' => 'bool', 'burn_default_tab_data' => 'bool', 'convert_pdf_fields' => 'bool', 'envelope_id' => 'string', 'envelope_type' => 'string', 'include_sigs_before_complete' => 'bool', 'is_concat_mode' => 'bool', 'is_envelope_id_stamping_enabled' => 'bool', 'pdf_form_conversion_font_scale100' => 'bool', 'should_flatten' => 'bool', 'show_envelope_changes' => 'bool', 'sign_online' => 'bool', 'status' => 'string', 'user_id' => 'string']
Methods
__construct()
Constructor
public
__construct([array<string|int, mixed> $data = null ]) : mixed
Parameters
- $data : array<string|int, mixed> = null
-
Associated array of property values initializing the model
Return values
mixed —__toString()
Gets the string presentation of the object
public
__toString() : string
Return values
string —attributeMap()
public
static attributeMap() : mixed
Return values
mixed —getAddDemoStamp()
Gets add_demo_stamp
public
getAddDemoStamp() : bool
Return values
bool —getAllowMultipleAttachments()
Gets allow_multiple_attachments
public
getAllowMultipleAttachments() : bool
Return values
bool —getBurnDefaultTabData()
Gets burn_default_tab_data
public
getBurnDefaultTabData() : bool
Return values
bool —getConvertPdfFields()
Gets convert_pdf_fields
public
getConvertPdfFields() : bool
Return values
bool —getEnvelopeId()
Gets envelope_id
public
getEnvelopeId() : string
Return values
string —getEnvelopeType()
Gets envelope_type
public
getEnvelopeType() : string
Return values
string —getIncludeSigsBeforeComplete()
Gets include_sigs_before_complete
public
getIncludeSigsBeforeComplete() : bool
Return values
bool —getIsConcatMode()
Gets is_concat_mode
public
getIsConcatMode() : bool
Return values
bool —getIsEnvelopeIdStampingEnabled()
Gets is_envelope_id_stamping_enabled
public
getIsEnvelopeIdStampingEnabled() : bool
Return values
bool —getPdfFormConversionFontScale100()
Gets pdf_form_conversion_font_scale100
public
getPdfFormConversionFontScale100() : bool
Return values
bool —getShouldFlatten()
Gets should_flatten
public
getShouldFlatten() : bool
Return values
bool —getShowEnvelopeChanges()
Gets show_envelope_changes
public
getShowEnvelopeChanges() : bool
Return values
bool —getSignOnline()
Gets sign_online
public
getSignOnline() : bool
Return values
bool —getStatus()
Gets status
public
getStatus() : string
Return values
string —getters()
public
static getters() : mixed
Return values
mixed —getUserId()
Gets user_id
public
getUserId() : string
Return values
string —listInvalidProperties()
show all the invalid properties with reasons.
public
listInvalidProperties() : array<string|int, mixed>
Return values
array<string|int, mixed> —invalid properties with reasons
offsetExists()
Returns true if offset exists. False otherwise.
public
offsetExists(int $offset) : bool
Parameters
- $offset : int
-
Offset
Return values
bool —offsetGet()
Gets offset.
public
offsetGet(int $offset) : mixed
Parameters
- $offset : int
-
Offset
Return values
mixed —offsetSet()
Sets value based on offset.
public
offsetSet(int $offset, mixed $value) : void
Parameters
- $offset : int
-
Offset
- $value : mixed
-
Value to be set
Return values
void —offsetUnset()
Unsets offset.
public
offsetUnset(int $offset) : void
Parameters
- $offset : int
-
Offset
Return values
void —setAddDemoStamp()
Sets add_demo_stamp
public
setAddDemoStamp(bool $add_demo_stamp) : $this
Parameters
- $add_demo_stamp : bool
Return values
$this —setAllowMultipleAttachments()
Sets allow_multiple_attachments
public
setAllowMultipleAttachments(bool $allow_multiple_attachments) : $this
Parameters
- $allow_multiple_attachments : bool
Return values
$this —setBurnDefaultTabData()
Sets burn_default_tab_data
public
setBurnDefaultTabData(bool $burn_default_tab_data) : $this
Parameters
- $burn_default_tab_data : bool
Return values
$this —setConvertPdfFields()
Sets convert_pdf_fields
public
setConvertPdfFields(bool $convert_pdf_fields) : $this
Parameters
- $convert_pdf_fields : bool
Return values
$this —setEnvelopeId()
Sets envelope_id
public
setEnvelopeId(string $envelope_id) : $this
Parameters
- $envelope_id : string
-
The envelope ID of the envelope status that failed to post.
Return values
$this —setEnvelopeType()
Sets envelope_type
public
setEnvelopeType(string $envelope_type) : $this
Parameters
- $envelope_type : string
Return values
$this —setIncludeSigsBeforeComplete()
Sets include_sigs_before_complete
public
setIncludeSigsBeforeComplete(bool $include_sigs_before_complete) : $this
Parameters
- $include_sigs_before_complete : bool
Return values
$this —setIsConcatMode()
Sets is_concat_mode
public
setIsConcatMode(bool $is_concat_mode) : $this
Parameters
- $is_concat_mode : bool
Return values
$this —setIsEnvelopeIdStampingEnabled()
Sets is_envelope_id_stamping_enabled
public
setIsEnvelopeIdStampingEnabled(bool $is_envelope_id_stamping_enabled) : $this
Parameters
- $is_envelope_id_stamping_enabled : bool
Return values
$this —setPdfFormConversionFontScale100()
Sets pdf_form_conversion_font_scale100
public
setPdfFormConversionFontScale100(bool $pdf_form_conversion_font_scale100) : $this
Parameters
- $pdf_form_conversion_font_scale100 : bool
Return values
$this —setShouldFlatten()
Sets should_flatten
public
setShouldFlatten(bool $should_flatten) : $this
Parameters
- $should_flatten : bool
Return values
$this —setShowEnvelopeChanges()
Sets show_envelope_changes
public
setShowEnvelopeChanges(bool $show_envelope_changes) : $this
Parameters
- $show_envelope_changes : bool
Return values
$this —setSignOnline()
Sets sign_online
public
setSignOnline(bool $sign_online) : $this
Parameters
- $sign_online : bool
Return values
$this —setStatus()
Sets status
public
setStatus(string $status) : $this
Parameters
- $status : string
-
Indicates the envelope status. Valid values are: * sent - The envelope is sent to the recipients. * created - The envelope is saved as a draft and can be modified and sent later.
Return values
$this —setters()
public
static setters() : mixed
Return values
mixed —setUserId()
Sets user_id
public
setUserId(string $user_id) : $this
Parameters
- $user_id : string
Return values
$this —swaggerTypes()
public
static swaggerTypes() : mixed
Return values
mixed —valid()
validate all the properties in the model return true if all passed
public
valid() : bool
Return values
bool —True if all properteis are valid