Contact
in package
implements
ModelInterface, ArrayAccess
Contact 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
- getCloudProvider() : string|null
- Gets cloud_provider
- getCloudProviderContainerId() : string|null
- Gets cloud_provider_container_id
- getContactId() : string|null
- Gets contact_id
- getContactPhoneNumbers() : array<string|int, ContactPhoneNumber>
- Gets contact_phone_numbers
- getContactUri() : string|null
- Gets contact_uri
- getEmails() : array<string|int, ?string>
- Gets emails
- getErrorDetails() : ErrorDetails
- Gets error_details
- getIsOwner() : bool|null
- Gets is_owner
- getModelName() : string
- The original name of the model.
- getName() : string|null
- Gets name
- getNotaryContactDetails() : NotaryContactDetails
- Gets notary_contact_details
- getOrganization() : string|null
- Gets organization
- getRoomContactType() : string|null
- Gets room_contact_type
- getShared() : string|null
- Gets shared
- getSigningGroup() : string|null
- Gets signing_group
- getSigningGroupName() : string|null
- Gets signing_group_name
- getters() : array<string|int, mixed>
- Array of attributes to getter functions (for serialization of requests)
- 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.
- setCloudProvider() : $this
- Sets cloud_provider
- setCloudProviderContainerId() : $this
- Sets cloud_provider_container_id
- setContactId() : $this
- Sets contact_id
- setContactPhoneNumbers() : $this
- Sets contact_phone_numbers
- setContactUri() : $this
- Sets contact_uri
- setEmails() : $this
- Sets emails
- setErrorDetails() : $this
- Sets error_details
- setIsOwner() : $this
- Sets is_owner
- setName() : $this
- Sets name
- setNotaryContactDetails() : $this
- Sets notary_contact_details
- setOrganization() : $this
- Sets organization
- setRoomContactType() : $this
- Sets room_contact_type
- setShared() : $this
- Sets shared
- setSigningGroup() : $this
- Sets signing_group
- setSigningGroupName() : $this
- Sets signing_group_name
- setters() : array<string|int, mixed>
- Array of attributes to setter functions (for deserialization of responses)
- 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
= ['cloud_provider' => 'cloudProvider', 'cloud_provider_container_id' => 'cloudProviderContainerId', 'contact_id' => 'contactId', 'contact_phone_numbers' => 'contactPhoneNumbers', 'contact_uri' => 'contactUri', 'emails' => 'emails', 'error_details' => 'errorDetails', 'is_owner' => 'isOwner', 'name' => 'name', 'notary_contact_details' => 'notaryContactDetails', 'organization' => 'organization', 'room_contact_type' => 'roomContactType', 'shared' => 'shared', 'signing_group' => 'signingGroup', 'signing_group_name' => 'signingGroupName']
$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
= ['cloud_provider' => 'getCloudProvider', 'cloud_provider_container_id' => 'getCloudProviderContainerId', 'contact_id' => 'getContactId', 'contact_phone_numbers' => 'getContactPhoneNumbers', 'contact_uri' => 'getContactUri', 'emails' => 'getEmails', 'error_details' => 'getErrorDetails', 'is_owner' => 'getIsOwner', 'name' => 'getName', 'notary_contact_details' => 'getNotaryContactDetails', 'organization' => 'getOrganization', 'room_contact_type' => 'getRoomContactType', 'shared' => 'getShared', 'signing_group' => 'getSigningGroup', 'signing_group_name' => 'getSigningGroupName']
$setters
Array of attributes to setter functions (for deserialization of responses)
protected
static array<string|int, string>
$setters
= ['cloud_provider' => 'setCloudProvider', 'cloud_provider_container_id' => 'setCloudProviderContainerId', 'contact_id' => 'setContactId', 'contact_phone_numbers' => 'setContactPhoneNumbers', 'contact_uri' => 'setContactUri', 'emails' => 'setEmails', 'error_details' => 'setErrorDetails', 'is_owner' => 'setIsOwner', 'name' => 'setName', 'notary_contact_details' => 'setNotaryContactDetails', 'organization' => 'setOrganization', 'room_contact_type' => 'setRoomContactType', 'shared' => 'setShared', 'signing_group' => 'setSigningGroup', 'signing_group_name' => 'setSigningGroupName']
$swaggerFormats
Array of property to format mappings. Used for (de)serialization
protected
static array<string|int, string>
$swaggerFormats
= ['cloud_provider' => null, 'cloud_provider_container_id' => null, 'contact_id' => null, 'contact_phone_numbers' => null, 'contact_uri' => null, 'emails' => null, 'error_details' => null, 'is_owner' => null, 'name' => null, 'notary_contact_details' => null, 'organization' => null, 'room_contact_type' => null, 'shared' => null, 'signing_group' => null, 'signing_group_name' => null]
$swaggerModelName
The original name of the model.
protected
static string
$swaggerModelName
= 'contact'
$swaggerTypes
Array of property to type mappings. Used for (de)serialization
protected
static array<string|int, string>
$swaggerTypes
= ['cloud_provider' => '?string', 'cloud_provider_container_id' => '?string', 'contact_id' => '?string', 'contact_phone_numbers' => '\\DocuSign\\eSign\\Model\\ContactPhoneNumber[]', 'contact_uri' => '?string', 'emails' => '?string[]', 'error_details' => '\\DocuSign\\eSign\\Model\\ErrorDetails', 'is_owner' => '?bool', 'name' => '?string', 'notary_contact_details' => '\\DocuSign\\eSign\\Model\\NotaryContactDetails', 'organization' => '?string', 'room_contact_type' => '?string', 'shared' => '?string', 'signing_group' => '?string', 'signing_group_name' => '?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> —getCloudProvider()
Gets cloud_provider
public
getCloudProvider() : string|null
Return values
string|null —getCloudProviderContainerId()
Gets cloud_provider_container_id
public
getCloudProviderContainerId() : string|null
Return values
string|null —getContactId()
Gets contact_id
public
getContactId() : string|null
Return values
string|null —getContactPhoneNumbers()
Gets contact_phone_numbers
public
getContactPhoneNumbers() : array<string|int, ContactPhoneNumber>
Return values
array<string|int, ContactPhoneNumber> —getContactUri()
Gets contact_uri
public
getContactUri() : string|null
Return values
string|null —getEmails()
Gets emails
public
getEmails() : array<string|int, ?string>
Return values
array<string|int, ?string> —getErrorDetails()
Gets error_details
public
getErrorDetails() : ErrorDetails
Return values
ErrorDetails —getIsOwner()
Gets is_owner
public
getIsOwner() : bool|null
Return values
bool|null —getModelName()
The original name of the model.
public
getModelName() : string
Return values
string —getName()
Gets name
public
getName() : string|null
Return values
string|null —getNotaryContactDetails()
Gets notary_contact_details
public
getNotaryContactDetails() : NotaryContactDetails
Return values
NotaryContactDetails —getOrganization()
Gets organization
public
getOrganization() : string|null
Return values
string|null —getRoomContactType()
Gets room_contact_type
public
getRoomContactType() : string|null
Return values
string|null —getShared()
Gets shared
public
getShared() : string|null
Return values
string|null —getSigningGroup()
Gets signing_group
public
getSigningGroup() : string|null
Return values
string|null —getSigningGroupName()
Gets signing_group_name
public
getSigningGroupName() : 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> —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 —setCloudProvider()
Sets cloud_provider
public
setCloudProvider(string|null $cloud_provider) : $this
Parameters
- $cloud_provider : string|null
Return values
$this —setCloudProviderContainerId()
Sets cloud_provider_container_id
public
setCloudProviderContainerId(string|null $cloud_provider_container_id) : $this
Parameters
- $cloud_provider_container_id : string|null
Return values
$this —setContactId()
Sets contact_id
public
setContactId(string|null $contact_id) : $this
Parameters
- $contact_id : string|null
Return values
$this —setContactPhoneNumbers()
Sets contact_phone_numbers
public
setContactPhoneNumbers(array<string|int, ContactPhoneNumber> $contact_phone_numbers) : $this
Parameters
- $contact_phone_numbers : array<string|int, ContactPhoneNumber>
Return values
$this —setContactUri()
Sets contact_uri
public
setContactUri(string|null $contact_uri) : $this
Parameters
- $contact_uri : string|null
Return values
$this —setEmails()
Sets emails
public
setEmails(array<string|int, ?string> $emails) : $this
Parameters
- $emails : array<string|int, ?string>
Return values
$this —setErrorDetails()
Sets error_details
public
setErrorDetails(ErrorDetails $error_details) : $this
Parameters
- $error_details : ErrorDetails
-
Array or errors.
Return values
$this —setIsOwner()
Sets is_owner
public
setIsOwner(bool|null $is_owner) : $this
Parameters
- $is_owner : bool|null
Return values
$this —setName()
Sets name
public
setName(string|null $name) : $this
Parameters
- $name : string|null
Return values
$this —setNotaryContactDetails()
Sets notary_contact_details
public
setNotaryContactDetails(NotaryContactDetails $notary_contact_details) : $this
Parameters
- $notary_contact_details : NotaryContactDetails
Return values
$this —setOrganization()
Sets organization
public
setOrganization(string|null $organization) : $this
Parameters
- $organization : string|null
Return values
$this —setRoomContactType()
Sets room_contact_type
public
setRoomContactType(string|null $room_contact_type) : $this
Parameters
- $room_contact_type : string|null
Return values
$this —setShared()
Sets shared
public
setShared(string|null $shared) : $this
Parameters
- $shared : string|null
-
When set to true, this custom tab is shared.
Return values
$this —setSigningGroup()
Sets signing_group
public
setSigningGroup(string|null $signing_group) : $this
Parameters
- $signing_group : string|null
Return values
$this —setSigningGroupName()
Sets signing_group_name
public
setSigningGroupName(string|null $signing_group_name) : $this
Parameters
- $signing_group_name : string|null
-
The display name for the signing group. Maximum Length: 100 characters.
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> —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