Documentation

TemplateRole
in package
implements ModelInterface, ArrayAccess

TemplateRole Class Doc Comment

Tags
category

Class

description

Information about a specific role.

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
getAccessCode()  : string|null
Gets access_code
getAdditionalNotifications()  : array<string|int, RecipientAdditionalNotification>
Gets additional_notifications
getClientUserId()  : string|null
Gets client_user_id
getDefaultRecipient()  : string|null
Gets default_recipient
getDeliveryMethod()  : string|null
Gets delivery_method
getEmail()  : string|null
Gets email
getEmailNotification()  : RecipientEmailNotification
Gets email_notification
getEmbeddedRecipientStartUrl()  : string|null
Gets embedded_recipient_start_url
getInPersonSignerName()  : string|null
Gets in_person_signer_name
getModelName()  : string
The original name of the model.
getName()  : string|null
Gets name
getPhoneNumber()  : RecipientPhoneNumber
Gets phone_number
getRecipientSignatureProviders()  : array<string|int, RecipientSignatureProvider>
Gets recipient_signature_providers
getRoleName()  : string|null
Gets role_name
getRoutingOrder()  : string|null
Gets routing_order
getSigningGroupId()  : string|null
Gets signing_group_id
getTabs()  : Tabs
Gets tabs
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.
setAccessCode()  : $this
Sets access_code
setAdditionalNotifications()  : $this
Sets additional_notifications
setClientUserId()  : $this
Sets client_user_id
setDefaultRecipient()  : $this
Sets default_recipient
setDeliveryMethod()  : $this
Sets delivery_method
setEmail()  : $this
Sets email
setEmailNotification()  : $this
Sets email_notification
setEmbeddedRecipientStartUrl()  : $this
Sets embedded_recipient_start_url
setInPersonSignerName()  : $this
Sets in_person_signer_name
setName()  : $this
Sets name
setPhoneNumber()  : $this
Sets phone_number
setRecipientSignatureProviders()  : $this
Sets recipient_signature_providers
setRoleName()  : $this
Sets role_name
setRoutingOrder()  : $this
Sets routing_order
setSigningGroupId()  : $this
Sets signing_group_id
setTabs()  : $this
Sets tabs
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

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 = ['access_code' => 'accessCode', 'additional_notifications' => 'additionalNotifications', 'client_user_id' => 'clientUserId', 'default_recipient' => 'defaultRecipient', 'delivery_method' => 'deliveryMethod', 'email' => 'email', 'email_notification' => 'emailNotification', 'embedded_recipient_start_url' => 'embeddedRecipientStartURL', 'in_person_signer_name' => 'inPersonSignerName', 'name' => 'name', 'phone_number' => 'phoneNumber', 'recipient_signature_providers' => 'recipientSignatureProviders', 'role_name' => 'roleName', 'routing_order' => 'routingOrder', 'signing_group_id' => 'signingGroupId', 'tabs' => 'tabs']

$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 = ['access_code' => 'getAccessCode', 'additional_notifications' => 'getAdditionalNotifications', 'client_user_id' => 'getClientUserId', 'default_recipient' => 'getDefaultRecipient', 'delivery_method' => 'getDeliveryMethod', 'email' => 'getEmail', 'email_notification' => 'getEmailNotification', 'embedded_recipient_start_url' => 'getEmbeddedRecipientStartUrl', 'in_person_signer_name' => 'getInPersonSignerName', 'name' => 'getName', 'phone_number' => 'getPhoneNumber', 'recipient_signature_providers' => 'getRecipientSignatureProviders', 'role_name' => 'getRoleName', 'routing_order' => 'getRoutingOrder', 'signing_group_id' => 'getSigningGroupId', 'tabs' => 'getTabs']

$setters

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

protected static array<string|int, string> $setters = ['access_code' => 'setAccessCode', 'additional_notifications' => 'setAdditionalNotifications', 'client_user_id' => 'setClientUserId', 'default_recipient' => 'setDefaultRecipient', 'delivery_method' => 'setDeliveryMethod', 'email' => 'setEmail', 'email_notification' => 'setEmailNotification', 'embedded_recipient_start_url' => 'setEmbeddedRecipientStartUrl', 'in_person_signer_name' => 'setInPersonSignerName', 'name' => 'setName', 'phone_number' => 'setPhoneNumber', 'recipient_signature_providers' => 'setRecipientSignatureProviders', 'role_name' => 'setRoleName', 'routing_order' => 'setRoutingOrder', 'signing_group_id' => 'setSigningGroupId', 'tabs' => 'setTabs']

$swaggerFormats

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

protected static array<string|int, string> $swaggerFormats = ['access_code' => null, 'additional_notifications' => null, 'client_user_id' => null, 'default_recipient' => null, 'delivery_method' => null, 'email' => null, 'email_notification' => null, 'embedded_recipient_start_url' => null, 'in_person_signer_name' => null, 'name' => null, 'phone_number' => null, 'recipient_signature_providers' => null, 'role_name' => null, 'routing_order' => null, 'signing_group_id' => null, 'tabs' => null]

$swaggerModelName

The original name of the model.

protected static string $swaggerModelName = 'templateRole'

$swaggerTypes

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

protected static array<string|int, string> $swaggerTypes = ['access_code' => '?string', 'additional_notifications' => '\\DocuSign\\eSign\\Model\\RecipientAdditionalNotification[]', 'client_user_id' => '?string', 'default_recipient' => '?string', 'delivery_method' => '?string', 'email' => '?string', 'email_notification' => '\\DocuSign\\eSign\\Model\\RecipientEmailNotification', 'embedded_recipient_start_url' => '?string', 'in_person_signer_name' => '?string', 'name' => '?string', 'phone_number' => '\\DocuSign\\eSign\\Model\\RecipientPhoneNumber', 'recipient_signature_providers' => '\\DocuSign\\eSign\\Model\\RecipientSignatureProvider[]', 'role_name' => '?string', 'routing_order' => '?string', 'signing_group_id' => '?string', 'tabs' => '\\DocuSign\\eSign\\Model\\Tabs']

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

getAccessCode()

Gets access_code

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

getClientUserId()

Gets client_user_id

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

getDefaultRecipient()

Gets default_recipient

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

getDeliveryMethod()

Gets delivery_method

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

getEmail()

Gets email

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

getEmbeddedRecipientStartUrl()

Gets embedded_recipient_start_url

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

getInPersonSignerName()

Gets in_person_signer_name

public getInPersonSignerName() : string|null
Return values
string|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 —

getRoleName()

Gets role_name

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

getRoutingOrder()

Gets routing_order

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

getSigningGroupId()

Gets signing_group_id

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

setAccessCode()

Sets access_code

public setAccessCode(string|null $access_code) : $this
Parameters
$access_code : string|null

If a value is provided, the recipient must enter the value as the access code to view and sign the envelope. Maximum Length: 50 characters and it must conform to the account's access code format setting. If blank, but the signer accessCode property is set in the envelope, then that value is used. If blank and the signer accessCode property is not set, then the access code is not required.

Return values
$this —

setClientUserId()

Sets client_user_id

public setClientUserId(string|null $client_user_id) : $this
Parameters
$client_user_id : string|null

Specifies whether the recipient is embedded or remote. If the clientUserId property is not null then the recipient is embedded. Note that if the ClientUserId property is set and either SignerMustHaveAccount or SignerMustLoginToSign property of the account settings is set to true, an error is generated on sending.ng. Maximum length: 100 characters.

Return values
$this —

setDefaultRecipient()

Sets default_recipient

public setDefaultRecipient(string|null $default_recipient) : $this
Parameters
$default_recipient : string|null

When set to true, this recipient is the default recipient and any tabs generated by the transformPdfFields option are mapped to this recipient.

Return values
$this —

setDeliveryMethod()

Sets delivery_method

public setDeliveryMethod(string|null $delivery_method) : $this
Parameters
$delivery_method : string|null

Reserved: For DocuSign use only.

Return values
$this —

setEmail()

Sets email

public setEmail(string|null $email) : $this
Parameters
$email : string|null

Specifies the email associated with a role name.

Return values
$this —

setEmailNotification()

Sets email_notification

public setEmailNotification(RecipientEmailNotification $email_notification) : $this
Parameters
$email_notification : RecipientEmailNotification

A complex type that contains information sets the language of the recipient's email information. IMPORTANT: If you enable email notification for one recipient, you must enable email notification for all recipients as it overrides the Envelope Subject and EmailBlurb property settings.

Return values
$this —

setEmbeddedRecipientStartUrl()

Sets embedded_recipient_start_url

public setEmbeddedRecipientStartUrl(string|null $embedded_recipient_start_url) : $this
Parameters
$embedded_recipient_start_url : string|null

Specifies a sender provided valid URL string for redirecting an embedded recipient. When using this option, the embedded recipient still receives an email from DocuSign, just as a remote recipient would. When the document link in the email is clicked the recipient is redirected, through DocuSign, to the supplied URL to complete their actions. When routing to the URL, the sender's system (the server responding to the URL) must request a recipient token to launch a signing session. If set to SIGN_AT_DOCUSIGN, the recipient is directed to an embedded signing or viewing process directly at DocuSign. The signing or viewing action is initiated by the DocuSign system and the transaction activity and Certificate of Completion records will reflect this. In all other ways the process is identical to an embedded signing or viewing operation that is launched by any partner. It is important to remember that in a typical embedded workflow the authentication of an embedded recipient is the responsibility of the sending application, DocuSign expects that senders will follow their own process for establishing the recipient's identity. In this workflow the recipient goes through the sending application before the embedded signing or viewing process in initiated. However, when the sending application sets EmbeddedRecipientStartURL=SIGN_AT_DOCUSIGN, the recipient goes directly to the embedded signing or viewing process bypassing the sending application and any authentication steps the sending application would use. In this case, DocuSign recommends that you use one of the normal DocuSign authentication features (Access Code, Phone Authentication, SMS Authentication, etc.) to verify the identity of the recipient. If the clientUserId property is NOT set, and the embeddedRecipientStartURL is set, DocuSign will ignore the redirect URL and launch the standard signing process for the email recipient. Information can be appended to the embedded recipient start URL using merge fields. The available merge fields items are: envelopeId, recipientId, recipientName, recipientEmail, and customFields. The customFields property must be set fort the recipient or envelope. The merge fields are enclosed in double brackets. Example: http://senderHost/[[mergeField1]]/ beginSigningSession? [[mergeField2]]&[[mergeField3]]

Return values
$this —

setInPersonSignerName()

Sets in_person_signer_name

public setInPersonSignerName(string|null $in_person_signer_name) : $this
Parameters
$in_person_signer_name : string|null

Specifies the full legal name of the signer in person signer template roles. Maximum Length: 100 characters.

Return values
$this —

setName()

Sets name

public setName(string|null $name) : $this
Parameters
$name : string|null

Specifies the recipient's name.

Return values
$this —

setRoleName()

Sets role_name

public setRoleName(string|null $role_name) : $this
Parameters
$role_name : string|null

Optional element. Specifies the role name associated with the recipient.

This is required when working with template recipients.

Return values
$this —

setRoutingOrder()

Sets routing_order

public setRoutingOrder(string|null $routing_order) : $this
Parameters
$routing_order : string|null

Specifies the routing order of the recipient in the envelope.

Return values
$this —

setSigningGroupId()

Sets signing_group_id

public setSigningGroupId(string|null $signing_group_id) : $this
Parameters
$signing_group_id : string|null

When set to true and the feature is enabled in the sender's account, the signing recipient is required to draw signatures and initials at each signature/initial tab ( instead of adopting a signature/initial style or only drawing a signature/initial once).

Return values
$this —

setTabs()

Sets tabs

public setTabs(Tabs $tabs) : $this
Parameters
$tabs : Tabs

A list of tabs, which are represented graphically as symbols on documents at the time of signing. Tabs show recipients where to sign, initial, or enter data. They may also display data to the recipients.

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

Search results