RecipientAdditionalNotification
in package
implements
ModelInterface, ArrayAccess
RecipientAdditionalNotification 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
- getModelName() : string
- The original name of the model.
- getPhoneNumber() : RecipientPhoneNumber
- Gets phone_number
- getSecondaryDeliveryMethod() : string|null
- Gets secondary_delivery_method
- getSecondaryDeliveryMethodMetadata() : PropertyMetadata
- Gets secondary_delivery_method_metadata
- getSecondaryDeliveryStatus() : string|null
- Gets secondary_delivery_status
- 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.
- setPhoneNumber() : $this
- Sets phone_number
- setSecondaryDeliveryMethod() : $this
- Sets secondary_delivery_method
- setSecondaryDeliveryMethodMetadata() : $this
- Sets secondary_delivery_method_metadata
- setSecondaryDeliveryStatus() : $this
- Sets secondary_delivery_status
- 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
= ['phone_number' => 'phoneNumber', 'secondary_delivery_method' => 'secondaryDeliveryMethod', 'secondary_delivery_method_metadata' => 'secondaryDeliveryMethodMetadata', 'secondary_delivery_status' => 'secondaryDeliveryStatus']
$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
= ['phone_number' => 'getPhoneNumber', 'secondary_delivery_method' => 'getSecondaryDeliveryMethod', 'secondary_delivery_method_metadata' => 'getSecondaryDeliveryMethodMetadata', 'secondary_delivery_status' => 'getSecondaryDeliveryStatus']
$setters
Array of attributes to setter functions (for deserialization of responses)
protected
static array<string|int, string>
$setters
= ['phone_number' => 'setPhoneNumber', 'secondary_delivery_method' => 'setSecondaryDeliveryMethod', 'secondary_delivery_method_metadata' => 'setSecondaryDeliveryMethodMetadata', 'secondary_delivery_status' => 'setSecondaryDeliveryStatus']
$swaggerFormats
Array of property to format mappings. Used for (de)serialization
protected
static array<string|int, string>
$swaggerFormats
= ['phone_number' => null, 'secondary_delivery_method' => null, 'secondary_delivery_method_metadata' => null, 'secondary_delivery_status' => null]
$swaggerModelName
The original name of the model.
protected
static string
$swaggerModelName
= 'recipientAdditionalNotification'
$swaggerTypes
Array of property to type mappings. Used for (de)serialization
protected
static array<string|int, string>
$swaggerTypes
= ['phone_number' => '\\DocuSign\\eSign\\Model\\RecipientPhoneNumber', 'secondary_delivery_method' => '?string', 'secondary_delivery_method_metadata' => '\\DocuSign\\eSign\\Model\\PropertyMetadata', 'secondary_delivery_status' => '?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> —getModelName()
The original name of the model.
public
getModelName() : string
Return values
string —getPhoneNumber()
Gets phone_number
public
getPhoneNumber() : RecipientPhoneNumber
Return values
RecipientPhoneNumber —getSecondaryDeliveryMethod()
Gets secondary_delivery_method
public
getSecondaryDeliveryMethod() : string|null
Return values
string|null —getSecondaryDeliveryMethodMetadata()
Gets secondary_delivery_method_metadata
public
getSecondaryDeliveryMethodMetadata() : PropertyMetadata
Return values
PropertyMetadata —getSecondaryDeliveryStatus()
Gets secondary_delivery_status
public
getSecondaryDeliveryStatus() : 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 —setPhoneNumber()
Sets phone_number
public
setPhoneNumber(RecipientPhoneNumber $phone_number) : $this
Parameters
- $phone_number : RecipientPhoneNumber
-
The phone number to receive the additional notifcation.
Return values
$this —setSecondaryDeliveryMethod()
Sets secondary_delivery_method
public
setSecondaryDeliveryMethod(string|null $secondary_delivery_method) : $this
Parameters
- $secondary_delivery_method : string|null
Return values
$this —setSecondaryDeliveryMethodMetadata()
Sets secondary_delivery_method_metadata
public
setSecondaryDeliveryMethodMetadata(PropertyMetadata $secondary_delivery_method_metadata) : $this
Parameters
- $secondary_delivery_method_metadata : PropertyMetadata
-
Metadata about the delivery method.
Return values
$this —setSecondaryDeliveryStatus()
Sets secondary_delivery_status
public
setSecondaryDeliveryStatus(string|null $secondary_delivery_status) : $this
Parameters
- $secondary_delivery_status : string|null
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