RecipientIdentityPhoneNumber
in package
implements
ModelInterface, ArrayAccess
RecipientIdentityPhoneNumber 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
- getCountryCode() : string|null
- Gets country_code
- getCountryCodeLock() : string|null
- Gets country_code_lock
- getCountryCodeMetadata() : PropertyMetadata
- Gets country_code_metadata
- getExtension() : string|null
- Gets extension
- getExtensionMetadata() : PropertyMetadata
- Gets extension_metadata
- getModelName() : string
- The original name of the model.
- getNumber() : string|null
- Gets number
- getNumberMetadata() : PropertyMetadata
- Gets number_metadata
- 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.
- setCountryCode() : $this
- Sets country_code
- setCountryCodeLock() : $this
- Sets country_code_lock
- setCountryCodeMetadata() : $this
- Sets country_code_metadata
- setExtension() : $this
- Sets extension
- setExtensionMetadata() : $this
- Sets extension_metadata
- setNumber() : $this
- Sets number
- setNumberMetadata() : $this
- Sets number_metadata
- 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
= ['country_code' => 'countryCode', 'country_code_lock' => 'countryCodeLock', 'country_code_metadata' => 'countryCodeMetadata', 'extension' => 'extension', 'extension_metadata' => 'extensionMetadata', 'number' => 'number', 'number_metadata' => 'numberMetadata']
$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
= ['country_code' => 'getCountryCode', 'country_code_lock' => 'getCountryCodeLock', 'country_code_metadata' => 'getCountryCodeMetadata', 'extension' => 'getExtension', 'extension_metadata' => 'getExtensionMetadata', 'number' => 'getNumber', 'number_metadata' => 'getNumberMetadata']
$setters
Array of attributes to setter functions (for deserialization of responses)
protected
static array<string|int, string>
$setters
= ['country_code' => 'setCountryCode', 'country_code_lock' => 'setCountryCodeLock', 'country_code_metadata' => 'setCountryCodeMetadata', 'extension' => 'setExtension', 'extension_metadata' => 'setExtensionMetadata', 'number' => 'setNumber', 'number_metadata' => 'setNumberMetadata']
$swaggerFormats
Array of property to format mappings. Used for (de)serialization
protected
static array<string|int, string>
$swaggerFormats
= ['country_code' => null, 'country_code_lock' => null, 'country_code_metadata' => null, 'extension' => null, 'extension_metadata' => null, 'number' => null, 'number_metadata' => null]
$swaggerModelName
The original name of the model.
protected
static string
$swaggerModelName
= 'recipientIdentityPhoneNumber'
$swaggerTypes
Array of property to type mappings. Used for (de)serialization
protected
static array<string|int, string>
$swaggerTypes
= ['country_code' => '?string', 'country_code_lock' => '?string', 'country_code_metadata' => '\\DocuSign\\eSign\\Model\\PropertyMetadata', 'extension' => '?string', 'extension_metadata' => '\\DocuSign\\eSign\\Model\\PropertyMetadata', 'number' => '?string', 'number_metadata' => '\\DocuSign\\eSign\\Model\\PropertyMetadata']
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> —getCountryCode()
Gets country_code
public
getCountryCode() : string|null
Return values
string|null —getCountryCodeLock()
Gets country_code_lock
public
getCountryCodeLock() : string|null
Return values
string|null —getCountryCodeMetadata()
Gets country_code_metadata
public
getCountryCodeMetadata() : PropertyMetadata
Return values
PropertyMetadata —getExtension()
Gets extension
public
getExtension() : string|null
Return values
string|null —getExtensionMetadata()
Gets extension_metadata
public
getExtensionMetadata() : PropertyMetadata
Return values
PropertyMetadata —getModelName()
The original name of the model.
public
getModelName() : string
Return values
string —getNumber()
Gets number
public
getNumber() : string|null
Return values
string|null —getNumberMetadata()
Gets number_metadata
public
getNumberMetadata() : PropertyMetadata
Return values
PropertyMetadata —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 —setCountryCode()
Sets country_code
public
setCountryCode(string|null $country_code) : $this
Parameters
- $country_code : string|null
Return values
$this —setCountryCodeLock()
Sets country_code_lock
public
setCountryCodeLock(string|null $country_code_lock) : $this
Parameters
- $country_code_lock : string|null
Return values
$this —setCountryCodeMetadata()
Sets country_code_metadata
public
setCountryCodeMetadata(PropertyMetadata $country_code_metadata) : $this
Parameters
- $country_code_metadata : PropertyMetadata
-
Metadata that indicates if the
countryCodeproperty is editable.
Return values
$this —setExtension()
Sets extension
public
setExtension(string|null $extension) : $this
Parameters
- $extension : string|null
Return values
$this —setExtensionMetadata()
Sets extension_metadata
public
setExtensionMetadata(PropertyMetadata $extension_metadata) : $this
Parameters
- $extension_metadata : PropertyMetadata
-
Metadata that indicates if the
extensionproperty is editable.
Return values
$this —setNumber()
Sets number
public
setNumber(string|null $number) : $this
Parameters
- $number : string|null
Return values
$this —setNumberMetadata()
Sets number_metadata
public
setNumberMetadata(PropertyMetadata $number_metadata) : $this
Parameters
- $number_metadata : PropertyMetadata
-
Metadata that indicates if the
numberproperty is editable.
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