BccEmailArchive
in package
implements
ModelInterface, ArrayAccess
BccEmailArchive Class Doc Comment
Tags
Interfaces, Classes, Traits and Enums
- ModelInterface
- Interface abstracting model access.
- 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)
- $swaggerFormats : array<string|int, string>
- Array of property to format mappings. Used for (de)serialization
- $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() : array<string|int, mixed>
- Array of attributes where the key is the local name, and the value is the original name
- getAccountId() : string|null
- Gets account_id
- getBccEmailArchiveId() : string|null
- Gets bcc_email_archive_id
- getCreated() : string|null
- Gets created
- getCreatedBy() : UserInfo
- Gets created_by
- getEmail() : string|null
- Gets email
- getEmailNotificationId() : string|null
- Gets email_notification_id
- getModelName() : string
- The original name of the model.
- getModified() : string|null
- Gets modified
- getModifiedBy() : UserInfo
- Gets modified_by
- getStatus() : string|null
- Gets status
- getters() : array<string|int, mixed>
- Array of attributes to getter functions (for serialization of requests)
- getUri() : string|null
- Gets uri
- 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.
- setAccountId() : $this
- Sets account_id
- setBccEmailArchiveId() : $this
- Sets bcc_email_archive_id
- setCreated() : $this
- Sets created
- setCreatedBy() : $this
- Sets created_by
- setEmail() : $this
- Sets email
- setEmailNotificationId() : $this
- Sets email_notification_id
- setModified() : $this
- Sets modified
- setModifiedBy() : $this
- Sets modified_by
- setStatus() : $this
- Sets status
- setters() : array<string|int, mixed>
- Array of attributes to setter functions (for deserialization of responses)
- setUri() : $this
- Sets uri
- swaggerFormats() : array<string|int, mixed>
- Array of property to format mappings. Used for (de)serialization
- swaggerTypes() : array<string|int, mixed>
- Array of property to type mappings. Used for (de)serialization
- 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
= ['account_id' => 'accountId', 'bcc_email_archive_id' => 'bccEmailArchiveId', 'created' => 'created', 'created_by' => 'createdBy', 'email' => 'email', 'email_notification_id' => 'emailNotificationId', 'modified' => 'modified', 'modified_by' => 'modifiedBy', 'status' => 'status', 'uri' => 'uri']
$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
= ['account_id' => 'getAccountId', 'bcc_email_archive_id' => 'getBccEmailArchiveId', 'created' => 'getCreated', 'created_by' => 'getCreatedBy', 'email' => 'getEmail', 'email_notification_id' => 'getEmailNotificationId', 'modified' => 'getModified', 'modified_by' => 'getModifiedBy', 'status' => 'getStatus', 'uri' => 'getUri']
$setters
Array of attributes to setter functions (for deserialization of responses)
protected
static array<string|int, string>
$setters
= ['account_id' => 'setAccountId', 'bcc_email_archive_id' => 'setBccEmailArchiveId', 'created' => 'setCreated', 'created_by' => 'setCreatedBy', 'email' => 'setEmail', 'email_notification_id' => 'setEmailNotificationId', 'modified' => 'setModified', 'modified_by' => 'setModifiedBy', 'status' => 'setStatus', 'uri' => 'setUri']
$swaggerFormats
Array of property to format mappings. Used for (de)serialization
protected
static array<string|int, string>
$swaggerFormats
= ['account_id' => null, 'bcc_email_archive_id' => null, 'created' => null, 'created_by' => null, 'email' => null, 'email_notification_id' => null, 'modified' => null, 'modified_by' => null, 'status' => null, 'uri' => null]
$swaggerModelName
The original name of the model.
protected
static string
$swaggerModelName
= 'bccEmailArchive'
$swaggerTypes
Array of property to type mappings. Used for (de)serialization
protected
static array<string|int, string>
$swaggerTypes
= ['account_id' => '?string', 'bcc_email_archive_id' => '?string', 'created' => '?string', 'created_by' => '\\DocuSign\\eSign\\Model\\UserInfo', 'email' => '?string', 'email_notification_id' => '?string', 'modified' => '?string', 'modified_by' => '\\DocuSign\\eSign\\Model\\UserInfo', 'status' => '?string', 'uri' => '?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()
Array of attributes where the key is the local name, and the value is the original name
public
static attributeMap() : array<string|int, mixed>
Return values
array<string|int, mixed> —getAccountId()
Gets account_id
public
getAccountId() : string|null
Return values
string|null —getBccEmailArchiveId()
Gets bcc_email_archive_id
public
getBccEmailArchiveId() : string|null
Return values
string|null —getCreated()
Gets created
public
getCreated() : string|null
Return values
string|null —getCreatedBy()
Gets created_by
public
getCreatedBy() : UserInfo
Return values
UserInfo —getEmail()
Gets email
public
getEmail() : string|null
Return values
string|null —getEmailNotificationId()
Gets email_notification_id
public
getEmailNotificationId() : string|null
Return values
string|null —getModelName()
The original name of the model.
public
getModelName() : string
Return values
string —getModified()
Gets modified
public
getModified() : string|null
Return values
string|null —getModifiedBy()
Gets modified_by
public
getModifiedBy() : UserInfo
Return values
UserInfo —getStatus()
Gets status
public
getStatus() : string|null
Return values
string|null —getters()
Array of attributes to getter functions (for serialization of requests)
public
static getters() : array<string|int, mixed>
Return values
array<string|int, mixed> —getUri()
Gets uri
public
getUri() : string|null
Return values
string|null —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 —setAccountId()
Sets account_id
public
setAccountId(string|null $account_id) : $this
Parameters
- $account_id : string|null
-
The account ID associated with the envelope.
Return values
$this —setBccEmailArchiveId()
Sets bcc_email_archive_id
public
setBccEmailArchiveId(string|null $bcc_email_archive_id) : $this
Parameters
- $bcc_email_archive_id : string|null
Return values
$this —setCreated()
Sets created
public
setCreated(string|null $created) : $this
Parameters
- $created : string|null
Return values
$this —setCreatedBy()
Sets created_by
public
setCreatedBy(UserInfo $created_by) : $this
Parameters
- $created_by : UserInfo
-
Details about the user who created the BCC email archive configuration.
Return values
$this —setEmail()
Sets email
public
setEmail(string|null $email) : $this
Parameters
- $email : string|null
Return values
$this —setEmailNotificationId()
Sets email_notification_id
public
setEmailNotificationId(string|null $email_notification_id) : $this
Parameters
- $email_notification_id : string|null
Return values
$this —setModified()
Sets modified
public
setModified(string|null $modified) : $this
Parameters
- $modified : string|null
Return values
$this —setModifiedBy()
Sets modified_by
public
setModifiedBy(UserInfo $modified_by) : $this
Parameters
- $modified_by : UserInfo
-
Details about the user who last modified the BCC email archive configuration.
Return values
$this —setStatus()
Sets status
public
setStatus(string|null $status) : $this
Parameters
- $status : string|null
-
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()
Array of attributes to setter functions (for deserialization of responses)
public
static setters() : array<string|int, mixed>
Return values
array<string|int, mixed> —setUri()
Sets uri
public
setUri(string|null $uri) : $this
Parameters
- $uri : string|null
Return values
$this —swaggerFormats()
Array of property to format mappings. Used for (de)serialization
public
static swaggerFormats() : array<string|int, mixed>
Return values
array<string|int, mixed> —swaggerTypes()
Array of property to type mappings. Used for (de)serialization
public
static swaggerTypes() : array<string|int, mixed>
Return values
array<string|int, mixed> —valid()
Validate all the properties in the model return true if all passed
public
valid() : bool
Return values
bool —True if all properties are valid