Documentation

RecipientPreviewRequest
in package
implements ModelInterface, ArrayAccess

RecipientPreviewRequest Class Doc Comment

Tags
category

Class

description

This request object contains the information necessary to create a recipient preview.

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
getAssertionId()  : string|null
Gets assertion_id
getAuthenticationInstant()  : string|null
Gets authentication_instant
getAuthenticationMethod()  : string|null
Gets authentication_method
getClientUrLs()  : RecipientTokenClientURLs
Gets client_ur_ls
getModelName()  : string
The original name of the model.
getPingFrequency()  : string|null
Gets ping_frequency
getPingUrl()  : string|null
Gets ping_url
getRecipientId()  : string|null
Gets recipient_id
getReturnUrl()  : string|null
Gets return_url
getSecurityDomain()  : string|null
Gets security_domain
getters()  : array<string|int, mixed>
Array of attributes to getter functions (for serialization of requests)
getXFrameOptions()  : string|null
Gets x_frame_options
getXFrameOptionsAllowFromUrl()  : string|null
Gets x_frame_options_allow_from_url
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.
setAssertionId()  : $this
Sets assertion_id
setAuthenticationInstant()  : $this
Sets authentication_instant
setAuthenticationMethod()  : $this
Sets authentication_method
setClientUrLs()  : $this
Sets client_ur_ls
setPingFrequency()  : $this
Sets ping_frequency
setPingUrl()  : $this
Sets ping_url
setRecipientId()  : $this
Sets recipient_id
setReturnUrl()  : $this
Sets return_url
setSecurityDomain()  : $this
Sets security_domain
setters()  : array<string|int, mixed>
Array of attributes to setter functions (for deserialization of responses)
setXFrameOptions()  : $this
Sets x_frame_options
setXFrameOptionsAllowFromUrl()  : $this
Sets x_frame_options_allow_from_url
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 = ['assertion_id' => 'assertionId', 'authentication_instant' => 'authenticationInstant', 'authentication_method' => 'authenticationMethod', 'client_ur_ls' => 'clientURLs', 'ping_frequency' => 'pingFrequency', 'ping_url' => 'pingUrl', 'recipient_id' => 'recipientId', 'return_url' => 'returnUrl', 'security_domain' => 'securityDomain', 'x_frame_options' => 'xFrameOptions', 'x_frame_options_allow_from_url' => 'xFrameOptionsAllowFromUrl']

$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 = ['assertion_id' => 'getAssertionId', 'authentication_instant' => 'getAuthenticationInstant', 'authentication_method' => 'getAuthenticationMethod', 'client_ur_ls' => 'getClientUrLs', 'ping_frequency' => 'getPingFrequency', 'ping_url' => 'getPingUrl', 'recipient_id' => 'getRecipientId', 'return_url' => 'getReturnUrl', 'security_domain' => 'getSecurityDomain', 'x_frame_options' => 'getXFrameOptions', 'x_frame_options_allow_from_url' => 'getXFrameOptionsAllowFromUrl']

$setters

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

protected static array<string|int, string> $setters = ['assertion_id' => 'setAssertionId', 'authentication_instant' => 'setAuthenticationInstant', 'authentication_method' => 'setAuthenticationMethod', 'client_ur_ls' => 'setClientUrLs', 'ping_frequency' => 'setPingFrequency', 'ping_url' => 'setPingUrl', 'recipient_id' => 'setRecipientId', 'return_url' => 'setReturnUrl', 'security_domain' => 'setSecurityDomain', 'x_frame_options' => 'setXFrameOptions', 'x_frame_options_allow_from_url' => 'setXFrameOptionsAllowFromUrl']

$swaggerFormats

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

protected static array<string|int, string> $swaggerFormats = ['assertion_id' => null, 'authentication_instant' => null, 'authentication_method' => null, 'client_ur_ls' => null, 'ping_frequency' => null, 'ping_url' => null, 'recipient_id' => null, 'return_url' => null, 'security_domain' => null, 'x_frame_options' => null, 'x_frame_options_allow_from_url' => null]

$swaggerModelName

The original name of the model.

protected static string $swaggerModelName = 'recipientPreviewRequest'

$swaggerTypes

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

protected static array<string|int, string> $swaggerTypes = ['assertion_id' => '?string', 'authentication_instant' => '?string', 'authentication_method' => '?string', 'client_ur_ls' => '\\DocuSign\\eSign\\Model\\RecipientTokenClientURLs', 'ping_frequency' => '?string', 'ping_url' => '?string', 'recipient_id' => '?string', 'return_url' => '?string', 'security_domain' => '?string', 'x_frame_options' => '?string', 'x_frame_options_allow_from_url' => '?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>

getAssertionId()

Gets assertion_id

public getAssertionId() : string|null
Return values
string|null

getAuthenticationInstant()

Gets authentication_instant

public getAuthenticationInstant() : string|null
Return values
string|null

getAuthenticationMethod()

Gets authentication_method

public getAuthenticationMethod() : string|null
Return values
string|null

getModelName()

The original name of the model.

public getModelName() : string
Return values
string

getPingFrequency()

Gets ping_frequency

public getPingFrequency() : string|null
Return values
string|null

getRecipientId()

Gets recipient_id

public getRecipientId() : string|null
Return values
string|null

getSecurityDomain()

Gets security_domain

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

getXFrameOptions()

Gets x_frame_options

public getXFrameOptions() : string|null
Return values
string|null

getXFrameOptionsAllowFromUrl()

Gets x_frame_options_allow_from_url

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

setAssertionId()

Sets assertion_id

public setAssertionId(string|null $assertion_id) : $this
Parameters
$assertion_id : string|null
Return values
$this

setAuthenticationInstant()

Sets authentication_instant

public setAuthenticationInstant(string|null $authentication_instant) : $this
Parameters
$authentication_instant : string|null
Return values
$this

setAuthenticationMethod()

Sets authentication_method

public setAuthenticationMethod(string|null $authentication_method) : $this
Parameters
$authentication_method : string|null
Return values
$this

setPingFrequency()

Sets ping_frequency

public setPingFrequency(string|null $ping_frequency) : $this
Parameters
$ping_frequency : string|null
Return values
$this

setPingUrl()

Sets ping_url

public setPingUrl(string|null $ping_url) : $this
Parameters
$ping_url : string|null
Return values
$this

setRecipientId()

Sets recipient_id

public setRecipientId(string|null $recipient_id) : $this
Parameters
$recipient_id : string|null

Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.

Return values
$this

setReturnUrl()

Sets return_url

public setReturnUrl(string|null $return_url) : $this
Parameters
$return_url : string|null
Return values
$this

setSecurityDomain()

Sets security_domain

public setSecurityDomain(string|null $security_domain) : $this
Parameters
$security_domain : 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>

setXFrameOptions()

Sets x_frame_options

public setXFrameOptions(string|null $x_frame_options) : $this
Parameters
$x_frame_options : string|null
Return values
$this

setXFrameOptionsAllowFromUrl()

Sets x_frame_options_allow_from_url

public setXFrameOptionsAllowFromUrl(string|null $x_frame_options_allow_from_url) : $this
Parameters
$x_frame_options_allow_from_url : string|null
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