Documentation

SenderEmailNotifications
in package
implements ModelInterface, ArrayAccess

SenderEmailNotifications Class Doc Comment

Tags
category

Class

description

Contains the settings for the email notifications that senders receive about the envelopes that they send.

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
getChangedSigner()  : string|null
Gets changed_signer
getClickwrapResponsesLimitNotificationEmail()  : string|null
Gets clickwrap_responses_limit_notification_email
getCommentsOnlyPrivateAndMention()  : string|null
Gets comments_only_private_and_mention
getCommentsReceiveAll()  : string|null
Gets comments_receive_all
getDeliveryFailed()  : string|null
Gets delivery_failed
getEnvelopeComplete()  : string|null
Gets envelope_complete
getModelName()  : string
The original name of the model.
getOfflineSigningFailed()  : string|null
Gets offline_signing_failed
getPowerformResponsesLimitNotificationEmail()  : string|null
Gets powerform_responses_limit_notification_email
getPurgeDocuments()  : string|null
Gets purge_documents
getRecipientViewed()  : string|null
Gets recipient_viewed
getSenderEnvelopeDeclined()  : string|null
Gets sender_envelope_declined
getters()  : array<string|int, mixed>
Array of attributes to getter functions (for serialization of requests)
getWithdrawnConsent()  : string|null
Gets withdrawn_consent
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.
setChangedSigner()  : $this
Sets changed_signer
setClickwrapResponsesLimitNotificationEmail()  : $this
Sets clickwrap_responses_limit_notification_email
setCommentsOnlyPrivateAndMention()  : $this
Sets comments_only_private_and_mention
setCommentsReceiveAll()  : $this
Sets comments_receive_all
setDeliveryFailed()  : $this
Sets delivery_failed
setEnvelopeComplete()  : $this
Sets envelope_complete
setOfflineSigningFailed()  : $this
Sets offline_signing_failed
setPowerformResponsesLimitNotificationEmail()  : $this
Sets powerform_responses_limit_notification_email
setPurgeDocuments()  : $this
Sets purge_documents
setRecipientViewed()  : $this
Sets recipient_viewed
setSenderEnvelopeDeclined()  : $this
Sets sender_envelope_declined
setters()  : array<string|int, mixed>
Array of attributes to setter functions (for deserialization of responses)
setWithdrawnConsent()  : $this
Sets withdrawn_consent
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 = ['changed_signer' => 'changedSigner', 'clickwrap_responses_limit_notification_email' => 'clickwrapResponsesLimitNotificationEmail', 'comments_only_private_and_mention' => 'commentsOnlyPrivateAndMention', 'comments_receive_all' => 'commentsReceiveAll', 'delivery_failed' => 'deliveryFailed', 'envelope_complete' => 'envelopeComplete', 'offline_signing_failed' => 'offlineSigningFailed', 'powerform_responses_limit_notification_email' => 'powerformResponsesLimitNotificationEmail', 'purge_documents' => 'purgeDocuments', 'recipient_viewed' => 'recipientViewed', 'sender_envelope_declined' => 'senderEnvelopeDeclined', 'withdrawn_consent' => 'withdrawnConsent']

$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 = ['changed_signer' => 'getChangedSigner', 'clickwrap_responses_limit_notification_email' => 'getClickwrapResponsesLimitNotificationEmail', 'comments_only_private_and_mention' => 'getCommentsOnlyPrivateAndMention', 'comments_receive_all' => 'getCommentsReceiveAll', 'delivery_failed' => 'getDeliveryFailed', 'envelope_complete' => 'getEnvelopeComplete', 'offline_signing_failed' => 'getOfflineSigningFailed', 'powerform_responses_limit_notification_email' => 'getPowerformResponsesLimitNotificationEmail', 'purge_documents' => 'getPurgeDocuments', 'recipient_viewed' => 'getRecipientViewed', 'sender_envelope_declined' => 'getSenderEnvelopeDeclined', 'withdrawn_consent' => 'getWithdrawnConsent']

$setters

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

protected static array<string|int, string> $setters = ['changed_signer' => 'setChangedSigner', 'clickwrap_responses_limit_notification_email' => 'setClickwrapResponsesLimitNotificationEmail', 'comments_only_private_and_mention' => 'setCommentsOnlyPrivateAndMention', 'comments_receive_all' => 'setCommentsReceiveAll', 'delivery_failed' => 'setDeliveryFailed', 'envelope_complete' => 'setEnvelopeComplete', 'offline_signing_failed' => 'setOfflineSigningFailed', 'powerform_responses_limit_notification_email' => 'setPowerformResponsesLimitNotificationEmail', 'purge_documents' => 'setPurgeDocuments', 'recipient_viewed' => 'setRecipientViewed', 'sender_envelope_declined' => 'setSenderEnvelopeDeclined', 'withdrawn_consent' => 'setWithdrawnConsent']

$swaggerFormats

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

protected static array<string|int, string> $swaggerFormats = ['changed_signer' => null, 'clickwrap_responses_limit_notification_email' => null, 'comments_only_private_and_mention' => null, 'comments_receive_all' => null, 'delivery_failed' => null, 'envelope_complete' => null, 'offline_signing_failed' => null, 'powerform_responses_limit_notification_email' => null, 'purge_documents' => null, 'recipient_viewed' => null, 'sender_envelope_declined' => null, 'withdrawn_consent' => null]

$swaggerModelName

The original name of the model.

protected static string $swaggerModelName = 'senderEmailNotifications'

$swaggerTypes

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

protected static array<string|int, string> $swaggerTypes = ['changed_signer' => '?string', 'clickwrap_responses_limit_notification_email' => '?string', 'comments_only_private_and_mention' => '?string', 'comments_receive_all' => '?string', 'delivery_failed' => '?string', 'envelope_complete' => '?string', 'offline_signing_failed' => '?string', 'powerform_responses_limit_notification_email' => '?string', 'purge_documents' => '?string', 'recipient_viewed' => '?string', 'sender_envelope_declined' => '?string', 'withdrawn_consent' => '?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>

getChangedSigner()

Gets changed_signer

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

getClickwrapResponsesLimitNotificationEmail()

Gets clickwrap_responses_limit_notification_email

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

getDeliveryFailed()

Gets delivery_failed

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

getEnvelopeComplete()

Gets envelope_complete

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

getOfflineSigningFailed()

Gets offline_signing_failed

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

getPowerformResponsesLimitNotificationEmail()

Gets powerform_responses_limit_notification_email

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

getPurgeDocuments()

Gets purge_documents

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

getRecipientViewed()

Gets recipient_viewed

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

getSenderEnvelopeDeclined()

Gets sender_envelope_declined

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

getWithdrawnConsent()

Gets withdrawn_consent

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

setChangedSigner()

Sets changed_signer

public setChangedSigner(string|null $changed_signer) : $this
Parameters
$changed_signer : string|null

When set to true, the sender receives notification if the signer changes.

Return values
$this

setClickwrapResponsesLimitNotificationEmail()

Sets clickwrap_responses_limit_notification_email

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

setDeliveryFailed()

Sets delivery_failed

public setDeliveryFailed(string|null $delivery_failed) : $this
Parameters
$delivery_failed : string|null

When set to true, the sender receives notification if the delivery of the envelope fails.

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

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

setPowerformResponsesLimitNotificationEmail()

Sets powerform_responses_limit_notification_email

public setPowerformResponsesLimitNotificationEmail(string|null $powerform_responses_limit_notification_email) : $this
Parameters
$powerform_responses_limit_notification_email : string|null
Return values
$this

setPurgeDocuments()

Sets purge_documents

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

setRecipientViewed()

Sets recipient_viewed

public setRecipientViewed(string|null $recipient_viewed) : $this
Parameters
$recipient_viewed : string|null

When set to true, the sender receives notification that the recipient viewed the enveloper.

Return values
$this

setSenderEnvelopeDeclined()

Sets sender_envelope_declined

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

setWithdrawnConsent()

Sets withdrawn_consent

public setWithdrawnConsent(string|null $withdrawn_consent) : $this
Parameters
$withdrawn_consent : string|null

When set to true, the user receives notification if consent is withdrawn.

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