Documentation

RecipientPhoneAuthentication
in package
implements ModelInterface, ArrayAccess

RecipientPhoneAuthentication Class Doc Comment

Tags
category

Class

description

A complex type that Contains the elements: * recipMayProvideNumber - Boolean. When set to true, the recipient can use whatever phone number they choose. * senderProvidedNumbers - ArrayOfString. A list of phone numbers the recipient can use. * recordVoicePrint - Reserved. * validateRecipProvidedNumber - Reserved.

author

Swagger Codegen team apihelp@docusign.com

license

The DocuSign PHP Client SDK is licensed under the MIT License.

link
https://github.com/swagger-api/swagger-codegen

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.
getRecipMayProvideNumber()  : string|null
Gets recip_may_provide_number
getRecipMayProvideNumberMetadata()  : PropertyMetadata
Gets recip_may_provide_number_metadata
getRecordVoicePrint()  : string|null
Gets record_voice_print
getRecordVoicePrintMetadata()  : PropertyMetadata
Gets record_voice_print_metadata
getSenderProvidedNumbers()  : array<string|int, ?string>
Gets sender_provided_numbers
getSenderProvidedNumbersMetadata()  : PropertyMetadata
Gets sender_provided_numbers_metadata
getters()  : array<string|int, mixed>
Array of attributes to getter functions (for serialization of requests)
getValidateRecipProvidedNumber()  : string|null
Gets validate_recip_provided_number
getValidateRecipProvidedNumberMetadata()  : PropertyMetadata
Gets validate_recip_provided_number_metadata
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.
setRecipMayProvideNumber()  : $this
Sets recip_may_provide_number
setRecipMayProvideNumberMetadata()  : $this
Sets recip_may_provide_number_metadata
setRecordVoicePrint()  : $this
Sets record_voice_print
setRecordVoicePrintMetadata()  : $this
Sets record_voice_print_metadata
setSenderProvidedNumbers()  : $this
Sets sender_provided_numbers
setSenderProvidedNumbersMetadata()  : $this
Sets sender_provided_numbers_metadata
setters()  : array<string|int, mixed>
Array of attributes to setter functions (for deserialization of responses)
setValidateRecipProvidedNumber()  : $this
Sets validate_recip_provided_number
setValidateRecipProvidedNumberMetadata()  : $this
Sets validate_recip_provided_number_metadata
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

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 = ['recip_may_provide_number' => 'recipMayProvideNumber', 'recip_may_provide_number_metadata' => 'recipMayProvideNumberMetadata', 'record_voice_print' => 'recordVoicePrint', 'record_voice_print_metadata' => 'recordVoicePrintMetadata', 'sender_provided_numbers' => 'senderProvidedNumbers', 'sender_provided_numbers_metadata' => 'senderProvidedNumbersMetadata', 'validate_recip_provided_number' => 'validateRecipProvidedNumber', 'validate_recip_provided_number_metadata' => 'validateRecipProvidedNumberMetadata']

$getters

Array of attributes to getter functions (for serialization of requests)

protected static array<string|int, string> $getters = ['recip_may_provide_number' => 'getRecipMayProvideNumber', 'recip_may_provide_number_metadata' => 'getRecipMayProvideNumberMetadata', 'record_voice_print' => 'getRecordVoicePrint', 'record_voice_print_metadata' => 'getRecordVoicePrintMetadata', 'sender_provided_numbers' => 'getSenderProvidedNumbers', 'sender_provided_numbers_metadata' => 'getSenderProvidedNumbersMetadata', 'validate_recip_provided_number' => 'getValidateRecipProvidedNumber', 'validate_recip_provided_number_metadata' => 'getValidateRecipProvidedNumberMetadata']

$setters

Array of attributes to setter functions (for deserialization of responses)

protected static array<string|int, string> $setters = ['recip_may_provide_number' => 'setRecipMayProvideNumber', 'recip_may_provide_number_metadata' => 'setRecipMayProvideNumberMetadata', 'record_voice_print' => 'setRecordVoicePrint', 'record_voice_print_metadata' => 'setRecordVoicePrintMetadata', 'sender_provided_numbers' => 'setSenderProvidedNumbers', 'sender_provided_numbers_metadata' => 'setSenderProvidedNumbersMetadata', 'validate_recip_provided_number' => 'setValidateRecipProvidedNumber', 'validate_recip_provided_number_metadata' => 'setValidateRecipProvidedNumberMetadata']

$swaggerFormats

Array of property to format mappings. Used for (de)serialization

protected static array<string|int, string> $swaggerFormats = ['recip_may_provide_number' => null, 'recip_may_provide_number_metadata' => null, 'record_voice_print' => null, 'record_voice_print_metadata' => null, 'sender_provided_numbers' => null, 'sender_provided_numbers_metadata' => null, 'validate_recip_provided_number' => null, 'validate_recip_provided_number_metadata' => null]

$swaggerModelName

The original name of the model.

protected static string $swaggerModelName = 'recipientPhoneAuthentication'

$swaggerTypes

Array of property to type mappings. Used for (de)serialization

protected static array<string|int, string> $swaggerTypes = ['recip_may_provide_number' => '?string', 'recip_may_provide_number_metadata' => '\\DocuSign\\eSign\\Model\\PropertyMetadata', 'record_voice_print' => '?string', 'record_voice_print_metadata' => '\\DocuSign\\eSign\\Model\\PropertyMetadata', 'sender_provided_numbers' => '?string[]', 'sender_provided_numbers_metadata' => '\\DocuSign\\eSign\\Model\\PropertyMetadata', 'validate_recip_provided_number' => '?string', 'validate_recip_provided_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 —

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> —

getRecipMayProvideNumber()

Gets recip_may_provide_number

public getRecipMayProvideNumber() : string|null
Return values
string|null —

getSenderProvidedNumbers()

Gets sender_provided_numbers

public getSenderProvidedNumbers() : array<string|int, ?string>
Return values
array<string|int, ?string> —

getters()

Array of attributes to getter functions (for serialization of requests)

public static getters() : array<string|int, mixed>
Return values
array<string|int, mixed> —

getValidateRecipProvidedNumber()

Gets validate_recip_provided_number

public getValidateRecipProvidedNumber() : 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 —

setRecipMayProvideNumber()

Sets recip_may_provide_number

public setRecipMayProvideNumber(string|null $recip_may_provide_number) : $this
Parameters
$recip_may_provide_number : string|null

Boolean. When set to true, the recipient can supply a phone number their choice.

Return values
$this —

setRecipMayProvideNumberMetadata()

Sets recip_may_provide_number_metadata

public setRecipMayProvideNumberMetadata(PropertyMetadata $recip_may_provide_number_metadata) : $this
Parameters
$recip_may_provide_number_metadata : PropertyMetadata

Metadata that indicates whether the recipMayProvideNumber property can be edited.

Return values
$this —

setRecordVoicePrint()

Sets record_voice_print

public setRecordVoicePrint(string|null $record_voice_print) : $this
Parameters
$record_voice_print : string|null

Reserved.

Return values
$this —

setSenderProvidedNumbers()

Sets sender_provided_numbers

public setSenderProvidedNumbers(array<string|int, ?string> $sender_provided_numbers) : $this
Parameters
$sender_provided_numbers : array<string|int, ?string>

An Array containing a list of phone numbers the recipient may use for SMS text authentication.

Return values
$this —

setSenderProvidedNumbersMetadata()

Sets sender_provided_numbers_metadata

public setSenderProvidedNumbersMetadata(PropertyMetadata $sender_provided_numbers_metadata) : $this
Parameters
$sender_provided_numbers_metadata : PropertyMetadata

Metadata that indicates whether the senderProvidedNumbers property can be edited.

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> —

setValidateRecipProvidedNumber()

Sets validate_recip_provided_number

public setValidateRecipProvidedNumber(string|null $validate_recip_provided_number) : $this
Parameters
$validate_recip_provided_number : string|null

Reserved.

Return values
$this —

setValidateRecipProvidedNumberMetadata()

Sets validate_recip_provided_number_metadata

public setValidateRecipProvidedNumberMetadata(PropertyMetadata $validate_recip_provided_number_metadata) : $this
Parameters
$validate_recip_provided_number_metadata : PropertyMetadata

Reserved for DocuSign.

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

Search results