EnvelopeTransferRuleRequest
in package
implements
ModelInterface, ArrayAccess
EnvelopeTransferRuleRequest 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
- getCarbonCopyOriginalOwner() : string|null
- Gets carbon_copy_original_owner
- getEnabled() : string|null
- Gets enabled
- getEnvelopeTransferRuleId() : string|null
- Gets envelope_transfer_rule_id
- getEventType() : string|null
- Gets event_type
- getFromGroups() : array<string|int, Group>
- Gets from_groups
- getFromUsers() : array<string|int, UserInformation>
- Gets from_users
- getModelName() : string
- The original name of the model.
- getModifiedDate() : string|null
- Gets modified_date
- getModifiedUser() : UserInformation
- Gets modified_user
- getters() : array<string|int, mixed>
- Array of attributes to getter functions (for serialization of requests)
- getToFolder() : Folder
- Gets to_folder
- getToUser() : UserInformation
- Gets to_user
- 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.
- setCarbonCopyOriginalOwner() : $this
- Sets carbon_copy_original_owner
- setEnabled() : $this
- Sets enabled
- setEnvelopeTransferRuleId() : $this
- Sets envelope_transfer_rule_id
- setEventType() : $this
- Sets event_type
- setFromGroups() : $this
- Sets from_groups
- setFromUsers() : $this
- Sets from_users
- setModifiedDate() : $this
- Sets modified_date
- setModifiedUser() : $this
- Sets modified_user
- setters() : array<string|int, mixed>
- Array of attributes to setter functions (for deserialization of responses)
- setToFolder() : $this
- Sets to_folder
- setToUser() : $this
- Sets to_user
- 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
= ['carbon_copy_original_owner' => 'carbonCopyOriginalOwner', 'enabled' => 'enabled', 'envelope_transfer_rule_id' => 'envelopeTransferRuleId', 'event_type' => 'eventType', 'from_groups' => 'fromGroups', 'from_users' => 'fromUsers', 'modified_date' => 'modifiedDate', 'modified_user' => 'modifiedUser', 'to_folder' => 'toFolder', 'to_user' => 'toUser']
$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
= ['carbon_copy_original_owner' => 'getCarbonCopyOriginalOwner', 'enabled' => 'getEnabled', 'envelope_transfer_rule_id' => 'getEnvelopeTransferRuleId', 'event_type' => 'getEventType', 'from_groups' => 'getFromGroups', 'from_users' => 'getFromUsers', 'modified_date' => 'getModifiedDate', 'modified_user' => 'getModifiedUser', 'to_folder' => 'getToFolder', 'to_user' => 'getToUser']
$setters
Array of attributes to setter functions (for deserialization of responses)
protected
static array<string|int, string>
$setters
= ['carbon_copy_original_owner' => 'setCarbonCopyOriginalOwner', 'enabled' => 'setEnabled', 'envelope_transfer_rule_id' => 'setEnvelopeTransferRuleId', 'event_type' => 'setEventType', 'from_groups' => 'setFromGroups', 'from_users' => 'setFromUsers', 'modified_date' => 'setModifiedDate', 'modified_user' => 'setModifiedUser', 'to_folder' => 'setToFolder', 'to_user' => 'setToUser']
$swaggerFormats
Array of property to format mappings. Used for (de)serialization
protected
static array<string|int, string>
$swaggerFormats
= ['carbon_copy_original_owner' => null, 'enabled' => null, 'envelope_transfer_rule_id' => null, 'event_type' => null, 'from_groups' => null, 'from_users' => null, 'modified_date' => null, 'modified_user' => null, 'to_folder' => null, 'to_user' => null]
$swaggerModelName
The original name of the model.
protected
static string
$swaggerModelName
= 'envelopeTransferRuleRequest'
$swaggerTypes
Array of property to type mappings. Used for (de)serialization
protected
static array<string|int, string>
$swaggerTypes
= ['carbon_copy_original_owner' => '?string', 'enabled' => '?string', 'envelope_transfer_rule_id' => '?string', 'event_type' => '?string', 'from_groups' => '\\DocuSign\\eSign\\Model\\Group[]', 'from_users' => '\\DocuSign\\eSign\\Model\\UserInformation[]', 'modified_date' => '?string', 'modified_user' => '\\DocuSign\\eSign\\Model\\UserInformation', 'to_folder' => '\\DocuSign\\eSign\\Model\\Folder', 'to_user' => '\\DocuSign\\eSign\\Model\\UserInformation']
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> —getCarbonCopyOriginalOwner()
Gets carbon_copy_original_owner
public
getCarbonCopyOriginalOwner() : string|null
Return values
string|null —getEnabled()
Gets enabled
public
getEnabled() : string|null
Return values
string|null —getEnvelopeTransferRuleId()
Gets envelope_transfer_rule_id
public
getEnvelopeTransferRuleId() : string|null
Return values
string|null —getEventType()
Gets event_type
public
getEventType() : string|null
Return values
string|null —getFromGroups()
Gets from_groups
public
getFromGroups() : array<string|int, Group>
Return values
array<string|int, Group> —getFromUsers()
Gets from_users
public
getFromUsers() : array<string|int, UserInformation>
Return values
array<string|int, UserInformation> —getModelName()
The original name of the model.
public
getModelName() : string
Return values
string —getModifiedDate()
Gets modified_date
public
getModifiedDate() : string|null
Return values
string|null —getModifiedUser()
Gets modified_user
public
getModifiedUser() : UserInformation
Return values
UserInformation —getters()
Array of attributes to getter functions (for serialization of requests)
public
static getters() : array<string|int, mixed>
Return values
array<string|int, mixed> —getToFolder()
Gets to_folder
public
getToFolder() : Folder
Return values
Folder —getToUser()
Gets to_user
public
getToUser() : UserInformation
Return values
UserInformation —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 —setCarbonCopyOriginalOwner()
Sets carbon_copy_original_owner
public
setCarbonCopyOriginalOwner(string|null $carbon_copy_original_owner) : $this
Parameters
- $carbon_copy_original_owner : string|null
Return values
$this —setEnabled()
Sets enabled
public
setEnabled(string|null $enabled) : $this
Parameters
- $enabled : string|null
Return values
$this —setEnvelopeTransferRuleId()
Sets envelope_transfer_rule_id
public
setEnvelopeTransferRuleId(string|null $envelope_transfer_rule_id) : $this
Parameters
- $envelope_transfer_rule_id : string|null
Return values
$this —setEventType()
Sets event_type
public
setEventType(string|null $event_type) : $this
Parameters
- $event_type : string|null
Return values
$this —setFromGroups()
Sets from_groups
public
setFromGroups(array<string|int, Group> $from_groups) : $this
Parameters
- $from_groups : array<string|int, Group>
Return values
$this —setFromUsers()
Sets from_users
public
setFromUsers(array<string|int, UserInformation> $from_users) : $this
Parameters
- $from_users : array<string|int, UserInformation>
Return values
$this —setModifiedDate()
Sets modified_date
public
setModifiedDate(string|null $modified_date) : $this
Parameters
- $modified_date : string|null
Return values
$this —setModifiedUser()
Sets modified_user
public
setModifiedUser(UserInformation $modified_user) : $this
Parameters
- $modified_user : UserInformation
-
Information about the user who last modified the envelope transfer rule.
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> —setToFolder()
Sets to_folder
public
setToFolder(Folder $to_folder) : $this
Parameters
- $to_folder : Folder
-
Information about the destination folder to which the envelope is transferred.
Return values
$this —setToUser()
Sets to_user
public
setToUser(UserInformation $to_user) : $this
Parameters
- $to_user : UserInformation
-
Information about the user to which the envelope is transferred.
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