Documentation

BulkSendingCopyRecipient
in package
implements ModelInterface, ArrayAccess

BulkSendingCopyRecipient Class Doc Comment

Tags
category

Class

description

This object contains details about a bulk send recipient.

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
getClientUserId()  : string|null
Gets client_user_id
getCustomFields()  : array<string|int, ?string>
Gets custom_fields
getDeliveryMethod()  : string|null
Gets delivery_method
getEmail()  : string|null
Gets email
getEmailNotification()  : RecipientEmailNotification
Gets email_notification
getEmbeddedRecipientStartUrl()  : string|null
Gets embedded_recipient_start_url
getFaxNumber()  : string|null
Gets fax_number
getHostEmail()  : string|null
Gets host_email
getHostName()  : string|null
Gets host_name
getIdCheckConfigurationName()  : string|null
Gets id_check_configuration_name
getIdCheckInformationInput()  : IdCheckInformationInput
Gets id_check_information_input
getIdentificationMethod()  : string|null
Gets identification_method
getIdentityVerification()  : RecipientIdentityVerification
Gets identity_verification
getModelName()  : string
The original name of the model.
getName()  : string|null
Gets name
getNote()  : string|null
Gets note
getPhoneAuthentication()  : RecipientPhoneAuthentication
Gets phone_authentication
getRecipientId()  : string|null
Gets recipient_id
getRecipientSignatureProviders()  : array<string|int, RecipientSignatureProvider>
Gets recipient_signature_providers
getRoleName()  : string|null
Gets role_name
getSignerName()  : string|null
Gets signer_name
getSigningGroupId()  : string|null
Gets signing_group_id
getSmsAuthentication()  : RecipientSMSAuthentication
Gets sms_authentication
getSocialAuthentications()  : array<string|int, SocialAuthentication>
Gets social_authentications
getTabs()  : array<string|int, BulkSendingCopyTab>
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
setClientUserId()  : $this
Sets client_user_id
setCustomFields()  : $this
Sets custom_fields
setDeliveryMethod()  : $this
Sets delivery_method
setEmail()  : $this
Sets email
setEmailNotification()  : $this
Sets email_notification
setEmbeddedRecipientStartUrl()  : $this
Sets embedded_recipient_start_url
setFaxNumber()  : $this
Sets fax_number
setHostEmail()  : $this
Sets host_email
setHostName()  : $this
Sets host_name
setIdCheckConfigurationName()  : $this
Sets id_check_configuration_name
setIdCheckInformationInput()  : $this
Sets id_check_information_input
setIdentificationMethod()  : $this
Sets identification_method
setIdentityVerification()  : $this
Sets identity_verification
setName()  : $this
Sets name
setNote()  : $this
Sets note
setPhoneAuthentication()  : $this
Sets phone_authentication
setRecipientId()  : $this
Sets recipient_id
setRecipientSignatureProviders()  : $this
Sets recipient_signature_providers
setRoleName()  : $this
Sets role_name
setSignerName()  : $this
Sets signer_name
setSigningGroupId()  : $this
Sets signing_group_id
setSmsAuthentication()  : $this
Sets sms_authentication
setSocialAuthentications()  : $this
Sets social_authentications
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', 'client_user_id' => 'clientUserId', 'custom_fields' => 'customFields', 'delivery_method' => 'deliveryMethod', 'email' => 'email', 'email_notification' => 'emailNotification', 'embedded_recipient_start_url' => 'embeddedRecipientStartURL', 'fax_number' => 'faxNumber', 'host_email' => 'hostEmail', 'host_name' => 'hostName', 'id_check_configuration_name' => 'idCheckConfigurationName', 'id_check_information_input' => 'idCheckInformationInput', 'identification_method' => 'identificationMethod', 'identity_verification' => 'identityVerification', 'name' => 'name', 'note' => 'note', 'phone_authentication' => 'phoneAuthentication', 'recipient_id' => 'recipientId', 'recipient_signature_providers' => 'recipientSignatureProviders', 'role_name' => 'roleName', 'signer_name' => 'signerName', 'signing_group_id' => 'signingGroupId', 'sms_authentication' => 'smsAuthentication', 'social_authentications' => 'socialAuthentications', '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', 'client_user_id' => 'getClientUserId', 'custom_fields' => 'getCustomFields', 'delivery_method' => 'getDeliveryMethod', 'email' => 'getEmail', 'email_notification' => 'getEmailNotification', 'embedded_recipient_start_url' => 'getEmbeddedRecipientStartUrl', 'fax_number' => 'getFaxNumber', 'host_email' => 'getHostEmail', 'host_name' => 'getHostName', 'id_check_configuration_name' => 'getIdCheckConfigurationName', 'id_check_information_input' => 'getIdCheckInformationInput', 'identification_method' => 'getIdentificationMethod', 'identity_verification' => 'getIdentityVerification', 'name' => 'getName', 'note' => 'getNote', 'phone_authentication' => 'getPhoneAuthentication', 'recipient_id' => 'getRecipientId', 'recipient_signature_providers' => 'getRecipientSignatureProviders', 'role_name' => 'getRoleName', 'signer_name' => 'getSignerName', 'signing_group_id' => 'getSigningGroupId', 'sms_authentication' => 'getSmsAuthentication', 'social_authentications' => 'getSocialAuthentications', 'tabs' => 'getTabs']

$setters

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

protected static array<string|int, string> $setters = ['access_code' => 'setAccessCode', 'client_user_id' => 'setClientUserId', 'custom_fields' => 'setCustomFields', 'delivery_method' => 'setDeliveryMethod', 'email' => 'setEmail', 'email_notification' => 'setEmailNotification', 'embedded_recipient_start_url' => 'setEmbeddedRecipientStartUrl', 'fax_number' => 'setFaxNumber', 'host_email' => 'setHostEmail', 'host_name' => 'setHostName', 'id_check_configuration_name' => 'setIdCheckConfigurationName', 'id_check_information_input' => 'setIdCheckInformationInput', 'identification_method' => 'setIdentificationMethod', 'identity_verification' => 'setIdentityVerification', 'name' => 'setName', 'note' => 'setNote', 'phone_authentication' => 'setPhoneAuthentication', 'recipient_id' => 'setRecipientId', 'recipient_signature_providers' => 'setRecipientSignatureProviders', 'role_name' => 'setRoleName', 'signer_name' => 'setSignerName', 'signing_group_id' => 'setSigningGroupId', 'sms_authentication' => 'setSmsAuthentication', 'social_authentications' => 'setSocialAuthentications', 'tabs' => 'setTabs']

$swaggerFormats

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

protected static array<string|int, string> $swaggerFormats = ['access_code' => null, 'client_user_id' => null, 'custom_fields' => null, 'delivery_method' => null, 'email' => null, 'email_notification' => null, 'embedded_recipient_start_url' => null, 'fax_number' => null, 'host_email' => null, 'host_name' => null, 'id_check_configuration_name' => null, 'id_check_information_input' => null, 'identification_method' => null, 'identity_verification' => null, 'name' => null, 'note' => null, 'phone_authentication' => null, 'recipient_id' => null, 'recipient_signature_providers' => null, 'role_name' => null, 'signer_name' => null, 'signing_group_id' => null, 'sms_authentication' => null, 'social_authentications' => null, 'tabs' => null]

$swaggerModelName

The original name of the model.

protected static string $swaggerModelName = 'bulkSendingCopyRecipient'

$swaggerTypes

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

protected static array<string|int, string> $swaggerTypes = ['access_code' => '?string', 'client_user_id' => '?string', 'custom_fields' => '?string[]', 'delivery_method' => '?string', 'email' => '?string', 'email_notification' => '\\DocuSign\\eSign\\Model\\RecipientEmailNotification', 'embedded_recipient_start_url' => '?string', 'fax_number' => '?string', 'host_email' => '?string', 'host_name' => '?string', 'id_check_configuration_name' => '?string', 'id_check_information_input' => '\\DocuSign\\eSign\\Model\\IdCheckInformationInput', 'identification_method' => '?string', 'identity_verification' => '\\DocuSign\\eSign\\Model\\RecipientIdentityVerification', 'name' => '?string', 'note' => '?string', 'phone_authentication' => '\\DocuSign\\eSign\\Model\\RecipientPhoneAuthentication', 'recipient_id' => '?string', 'recipient_signature_providers' => '\\DocuSign\\eSign\\Model\\RecipientSignatureProvider[]', 'role_name' => '?string', 'signer_name' => '?string', 'signing_group_id' => '?string', 'sms_authentication' => '\\DocuSign\\eSign\\Model\\RecipientSMSAuthentication', 'social_authentications' => '\\DocuSign\\eSign\\Model\\SocialAuthentication[]', 'tabs' => '\\DocuSign\\eSign\\Model\\BulkSendingCopyTab[]']

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

getClientUserId()

Gets client_user_id

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

getCustomFields()

Gets custom_fields

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

getDeliveryMethod()

Gets delivery_method

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

getEmbeddedRecipientStartUrl()

Gets embedded_recipient_start_url

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

getIdCheckConfigurationName()

Gets id_check_configuration_name

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

getIdentificationMethod()

Gets identification_method

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

setCustomFields()

Sets custom_fields

public setCustomFields(array<string|int, ?string> $custom_fields) : $this
Parameters
$custom_fields : array<string|int, ?string>

An optional array of strings that allows the sender to provide custom data about the recipient. This information is returned in the envelope status but otherwise not used by DocuSign. Each customField string can be a maximum of 100 characters.

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

setFaxNumber()

Sets fax_number

public setFaxNumber(string|null $fax_number) : $this
Parameters
$fax_number : string|null

Reserved:

Return values
$this —

setHostEmail()

Sets host_email

public setHostEmail(string|null $host_email) : $this
Parameters
$host_email : string|null
Return values
$this —

setHostName()

Sets host_name

public setHostName(string|null $host_name) : $this
Parameters
$host_name : string|null
Return values
$this —

setIdCheckConfigurationName()

Sets id_check_configuration_name

public setIdCheckConfigurationName(string|null $id_check_configuration_name) : $this
Parameters
$id_check_configuration_name : string|null

Specifies authentication check by name. The names used here must be the same as the authentication type names used by the account (these name can also be found in the web console sending interface in the Identify list for a recipient,) This overrides any default authentication setting. Example: Your account has ID Check and SMS Authentication available and in the web console Identify list these appear as 'ID Check $' and 'SMS Auth $'. To use ID check in an envelope, the idCheckConfigurationName should be 'ID Check '. If you wanted to use SMS, it would be 'SMS Auth $' and you would need to add you would need to add phone number information to the smsAuthentication node.

Return values
$this —

setIdentificationMethod()

Sets identification_method

public setIdentificationMethod(string|null $identification_method) : $this
Parameters
$identification_method : string|null
Return values
$this —

setName()

Sets name

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

setNote()

Sets note

public setNote(string|null $note) : $this
Parameters
$note : string|null

Specifies a note that is unique to this recipient. This note is sent to the recipient via the signing email. The note displays in the signing UI near the upper left corner of the document on the signing screen. Maximum Length: 1000 characters.

Return values
$this —

setPhoneAuthentication()

Sets phone_authentication

public setPhoneAuthentication(RecipientPhoneAuthentication $phone_authentication) : $this
Parameters
$phone_authentication : RecipientPhoneAuthentication

When idCheckConfigurationName is set to Phone Auth $, you use this complex type to provide the recipient authentication method details. It contains the following elements: * recipMayProvideNumber: Boolean. When true, the recipient can use whatever phone number they choose. * senderProvidedNumbers: ArrayOfStrings. A list of phone numbers the recipient can use. * recordVoicePrint: Reserved for DocuSign. * validateRecipProvidedNumber: Reserved for DocuSign.

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 —

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 —

setSignerName()

Sets signer_name

public setSignerName(string|null $signer_name) : $this
Parameters
$signer_name : string|null
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 —

setSmsAuthentication()

Sets sms_authentication

public setSmsAuthentication(RecipientSMSAuthentication $sms_authentication) : $this
Parameters
$sms_authentication : RecipientSMSAuthentication

When idCheckConfigurationName is set to SMS Auth $, you use this complex type to provide the recipient authentication method details. It contains the element senderProvidedNumbers, which is an array of phone numbers that the recipient can use for SMS text authentication.

Return values
$this —

setSocialAuthentications()

Sets social_authentications

public setSocialAuthentications(array<string|int, SocialAuthentication> $social_authentications) : $this
Parameters
$social_authentications : array<string|int, SocialAuthentication>

Lists the social ID type that can be used for recipient authentication.

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