Documentation

SignerEmailNotifications
in package
implements ModelInterface, ArrayAccess

SignerEmailNotifications Class Doc Comment

Tags
category

Class

description

An array of email notifications that specifies the email the user receives when they are a sender. When the specific email notification is set to true, the user receives those types of email notifications from DocuSign. The user inherits the default account sender email notification settings when the user is created.

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
getAgentNotification()  : string|null
Gets agent_notification
getCarbonCopyNotification()  : string|null
Gets carbon_copy_notification
getCertifiedDeliveryNotification()  : string|null
Gets certified_delivery_notification
getCommentsOnlyPrivateAndMention()  : string|null
Gets comments_only_private_and_mention
getCommentsReceiveAll()  : string|null
Gets comments_receive_all
getDocumentMarkupActivation()  : string|null
Gets document_markup_activation
getEnvelopeActivation()  : string|null
Gets envelope_activation
getEnvelopeComplete()  : string|null
Gets envelope_complete
getEnvelopeCorrected()  : string|null
Gets envelope_corrected
getEnvelopeDeclined()  : string|null
Gets envelope_declined
getEnvelopeVoided()  : string|null
Gets envelope_voided
getFaxReceived()  : string|null
Gets fax_received
getModelName()  : string
The original name of the model.
getOfflineSigningFailed()  : string|null
Gets offline_signing_failed
getPurgeDocuments()  : string|null
Gets purge_documents
getReassignedSigner()  : string|null
Gets reassigned_signer
getters()  : array<string|int, mixed>
Array of attributes to getter functions (for serialization of requests)
getWhenSigningGroupMember()  : string|null
Gets when_signing_group_member
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.
setAgentNotification()  : $this
Sets agent_notification
setCarbonCopyNotification()  : $this
Sets carbon_copy_notification
setCertifiedDeliveryNotification()  : $this
Sets certified_delivery_notification
setCommentsOnlyPrivateAndMention()  : $this
Sets comments_only_private_and_mention
setCommentsReceiveAll()  : $this
Sets comments_receive_all
setDocumentMarkupActivation()  : $this
Sets document_markup_activation
setEnvelopeActivation()  : $this
Sets envelope_activation
setEnvelopeComplete()  : $this
Sets envelope_complete
setEnvelopeCorrected()  : $this
Sets envelope_corrected
setEnvelopeDeclined()  : $this
Sets envelope_declined
setEnvelopeVoided()  : $this
Sets envelope_voided
setFaxReceived()  : $this
Sets fax_received
setOfflineSigningFailed()  : $this
Sets offline_signing_failed
setPurgeDocuments()  : $this
Sets purge_documents
setReassignedSigner()  : $this
Sets reassigned_signer
setters()  : array<string|int, mixed>
Array of attributes to setter functions (for deserialization of responses)
setWhenSigningGroupMember()  : $this
Sets when_signing_group_member
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 = ['agent_notification' => 'agentNotification', 'carbon_copy_notification' => 'carbonCopyNotification', 'certified_delivery_notification' => 'certifiedDeliveryNotification', 'comments_only_private_and_mention' => 'commentsOnlyPrivateAndMention', 'comments_receive_all' => 'commentsReceiveAll', 'document_markup_activation' => 'documentMarkupActivation', 'envelope_activation' => 'envelopeActivation', 'envelope_complete' => 'envelopeComplete', 'envelope_corrected' => 'envelopeCorrected', 'envelope_declined' => 'envelopeDeclined', 'envelope_voided' => 'envelopeVoided', 'fax_received' => 'faxReceived', 'offline_signing_failed' => 'offlineSigningFailed', 'purge_documents' => 'purgeDocuments', 'reassigned_signer' => 'reassignedSigner', 'when_signing_group_member' => 'whenSigningGroupMember']

$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 = ['agent_notification' => 'getAgentNotification', 'carbon_copy_notification' => 'getCarbonCopyNotification', 'certified_delivery_notification' => 'getCertifiedDeliveryNotification', 'comments_only_private_and_mention' => 'getCommentsOnlyPrivateAndMention', 'comments_receive_all' => 'getCommentsReceiveAll', 'document_markup_activation' => 'getDocumentMarkupActivation', 'envelope_activation' => 'getEnvelopeActivation', 'envelope_complete' => 'getEnvelopeComplete', 'envelope_corrected' => 'getEnvelopeCorrected', 'envelope_declined' => 'getEnvelopeDeclined', 'envelope_voided' => 'getEnvelopeVoided', 'fax_received' => 'getFaxReceived', 'offline_signing_failed' => 'getOfflineSigningFailed', 'purge_documents' => 'getPurgeDocuments', 'reassigned_signer' => 'getReassignedSigner', 'when_signing_group_member' => 'getWhenSigningGroupMember']

$setters

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

protected static array<string|int, string> $setters = ['agent_notification' => 'setAgentNotification', 'carbon_copy_notification' => 'setCarbonCopyNotification', 'certified_delivery_notification' => 'setCertifiedDeliveryNotification', 'comments_only_private_and_mention' => 'setCommentsOnlyPrivateAndMention', 'comments_receive_all' => 'setCommentsReceiveAll', 'document_markup_activation' => 'setDocumentMarkupActivation', 'envelope_activation' => 'setEnvelopeActivation', 'envelope_complete' => 'setEnvelopeComplete', 'envelope_corrected' => 'setEnvelopeCorrected', 'envelope_declined' => 'setEnvelopeDeclined', 'envelope_voided' => 'setEnvelopeVoided', 'fax_received' => 'setFaxReceived', 'offline_signing_failed' => 'setOfflineSigningFailed', 'purge_documents' => 'setPurgeDocuments', 'reassigned_signer' => 'setReassignedSigner', 'when_signing_group_member' => 'setWhenSigningGroupMember']

$swaggerFormats

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

protected static array<string|int, string> $swaggerFormats = ['agent_notification' => null, 'carbon_copy_notification' => null, 'certified_delivery_notification' => null, 'comments_only_private_and_mention' => null, 'comments_receive_all' => null, 'document_markup_activation' => null, 'envelope_activation' => null, 'envelope_complete' => null, 'envelope_corrected' => null, 'envelope_declined' => null, 'envelope_voided' => null, 'fax_received' => null, 'offline_signing_failed' => null, 'purge_documents' => null, 'reassigned_signer' => null, 'when_signing_group_member' => null]

$swaggerModelName

The original name of the model.

protected static string $swaggerModelName = 'signerEmailNotifications'

$swaggerTypes

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

protected static array<string|int, string> $swaggerTypes = ['agent_notification' => '?string', 'carbon_copy_notification' => '?string', 'certified_delivery_notification' => '?string', 'comments_only_private_and_mention' => '?string', 'comments_receive_all' => '?string', 'document_markup_activation' => '?string', 'envelope_activation' => '?string', 'envelope_complete' => '?string', 'envelope_corrected' => '?string', 'envelope_declined' => '?string', 'envelope_voided' => '?string', 'fax_received' => '?string', 'offline_signing_failed' => '?string', 'purge_documents' => '?string', 'reassigned_signer' => '?string', 'when_signing_group_member' => '?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> —

getAgentNotification()

Gets agent_notification

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

getCarbonCopyNotification()

Gets carbon_copy_notification

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

getCertifiedDeliveryNotification()

Gets certified_delivery_notification

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

getCommentsOnlyPrivateAndMention()

Gets comments_only_private_and_mention

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

getCommentsReceiveAll()

Gets comments_receive_all

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

getDocumentMarkupActivation()

Gets document_markup_activation

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

getEnvelopeActivation()

Gets envelope_activation

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

getEnvelopeComplete()

Gets envelope_complete

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

getEnvelopeCorrected()

Gets envelope_corrected

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

getEnvelopeDeclined()

Gets envelope_declined

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

getEnvelopeVoided()

Gets envelope_voided

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

getOfflineSigningFailed()

Gets offline_signing_failed

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

getPurgeDocuments()

Gets purge_documents

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

getReassignedSigner()

Gets reassigned_signer

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

getWhenSigningGroupMember()

Gets when_signing_group_member

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

setAgentNotification()

Sets agent_notification

public setAgentNotification(string|null $agent_notification) : $this
Parameters
$agent_notification : string|null

When set to true, the user receives agent notification emails.

Return values
$this —

setCarbonCopyNotification()

Sets carbon_copy_notification

public setCarbonCopyNotification(string|null $carbon_copy_notification) : $this
Parameters
$carbon_copy_notification : string|null

When set to true, the user receives notifications of carbon copy deliveries.

Return values
$this —

setCertifiedDeliveryNotification()

Sets certified_delivery_notification

public setCertifiedDeliveryNotification(string|null $certified_delivery_notification) : $this
Parameters
$certified_delivery_notification : string|null

When set to true, the user receives notifications of certified deliveries.

Return values
$this —

setCommentsOnlyPrivateAndMention()

Sets comments_only_private_and_mention

public setCommentsOnlyPrivateAndMention(string|null $comments_only_private_and_mention) : $this
Parameters
$comments_only_private_and_mention : string|null
Return values
$this —

setCommentsReceiveAll()

Sets comments_receive_all

public setCommentsReceiveAll(string|null $comments_receive_all) : $this
Parameters
$comments_receive_all : string|null
Return values
$this —

setDocumentMarkupActivation()

Sets document_markup_activation

public setDocumentMarkupActivation(string|null $document_markup_activation) : $this
Parameters
$document_markup_activation : string|null

When set to true, the user receives notification that document markup has been activated.

Return values
$this —

setEnvelopeActivation()

Sets envelope_activation

public setEnvelopeActivation(string|null $envelope_activation) : $this
Parameters
$envelope_activation : string|null

When set to true, the user receives notification that the envelope has been activated.

Return values
$this —

setEnvelopeComplete()

Sets envelope_complete

public setEnvelopeComplete(string|null $envelope_complete) : $this
Parameters
$envelope_complete : string|null

When set to true, the user receives notification that the envelope has been completed.

Return values
$this —

setEnvelopeCorrected()

Sets envelope_corrected

public setEnvelopeCorrected(string|null $envelope_corrected) : $this
Parameters
$envelope_corrected : string|null

When set to true, the user receives notification that the envelope has been corrected.

Return values
$this —

setEnvelopeDeclined()

Sets envelope_declined

public setEnvelopeDeclined(string|null $envelope_declined) : $this
Parameters
$envelope_declined : string|null

When set to true, the user receives notification that the envelope has been declined.

Return values
$this —

setEnvelopeVoided()

Sets envelope_voided

public setEnvelopeVoided(string|null $envelope_voided) : $this
Parameters
$envelope_voided : string|null

When set to true, the user receives notification that the envelope has been voided.

Return values
$this —

setFaxReceived()

Sets fax_received

public setFaxReceived(string|null $fax_received) : $this
Parameters
$fax_received : string|null

Reserved:

Return values
$this —

setOfflineSigningFailed()

Sets offline_signing_failed

public setOfflineSigningFailed(string|null $offline_signing_failed) : $this
Parameters
$offline_signing_failed : string|null

When set to true, the user receives notification if the offline signing failed.

Return values
$this —

setPurgeDocuments()

Sets purge_documents

public setPurgeDocuments(string|null $purge_documents) : $this
Parameters
$purge_documents : string|null

When set to true, the user receives notification of document purges.

Return values
$this —

setReassignedSigner()

Sets reassigned_signer

public setReassignedSigner(string|null $reassigned_signer) : $this
Parameters
$reassigned_signer : string|null

When set to true, the user receives notification that the envelope has been reassigned.

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

setWhenSigningGroupMember()

Sets when_signing_group_member

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