Documentation

EventNotification
in package
implements ModelInterface, ArrayAccess

EventNotification Class Doc Comment

Tags
category

Class

description

This optional complex element allows a message to be sent a specified URL when the envelope or recipient changes status. It is similar to DocuSign Connect. For example, if an envelope changes from "Sent" to "Delivered", a message containing the updated envelope status and optionally the documents is sent to the URL. When an eventNotification is attached to an envelope using the API, it only applies to the envelope (treating the envelope as the sender). This is different from envelopes created through the console user interface, where the user is treated as the sender.

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
getDeliveryMode()  : string|null
Gets delivery_mode
getEnvelopeEvents()  : array<string|int, EnvelopeEvent>
Gets envelope_events
getEventData()  : ConnectEventData
Gets event_data
getEvents()  : array<string|int, ?string>
Gets events
getIncludeCertificateOfCompletion()  : string|null
Gets include_certificate_of_completion
getIncludeCertificateWithSoap()  : string|null
Gets include_certificate_with_soap
getIncludeDocumentFields()  : string|null
Gets include_document_fields
getIncludeDocuments()  : string|null
Gets include_documents
getIncludeEnvelopeVoidReason()  : string|null
Gets include_envelope_void_reason
getIncludeHmac()  : string|null
Gets include_hmac
getIncludeOAuth()  : string|null
Gets include_o_auth
getIncludeSenderAccountAsCustomField()  : string|null
Gets include_sender_account_as_custom_field
getIncludeTimeZone()  : string|null
Gets include_time_zone
getIntegratorManaged()  : string|null
Gets integrator_managed
getLoggingEnabled()  : string|null
Gets logging_enabled
getModelName()  : string
The original name of the model.
getRecipientEvents()  : array<string|int, RecipientEvent>
Gets recipient_events
getRequireAcknowledgment()  : string|null
Gets require_acknowledgment
getSignMessageWithX509Cert()  : string|null
Gets sign_message_with_x509_cert
getSoapNameSpace()  : string|null
Gets soap_name_space
getters()  : array<string|int, mixed>
Array of attributes to getter functions (for serialization of requests)
getUrl()  : string|null
Gets url
getUseSoapInterface()  : string|null
Gets use_soap_interface
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.
setDeliveryMode()  : $this
Sets delivery_mode
setEnvelopeEvents()  : $this
Sets envelope_events
setEventData()  : $this
Sets event_data
setEvents()  : $this
Sets events
setIncludeCertificateOfCompletion()  : $this
Sets include_certificate_of_completion
setIncludeCertificateWithSoap()  : $this
Sets include_certificate_with_soap
setIncludeDocumentFields()  : $this
Sets include_document_fields
setIncludeDocuments()  : $this
Sets include_documents
setIncludeEnvelopeVoidReason()  : $this
Sets include_envelope_void_reason
setIncludeHmac()  : $this
Sets include_hmac
setIncludeOAuth()  : $this
Sets include_o_auth
setIncludeSenderAccountAsCustomField()  : $this
Sets include_sender_account_as_custom_field
setIncludeTimeZone()  : $this
Sets include_time_zone
setIntegratorManaged()  : $this
Sets integrator_managed
setLoggingEnabled()  : $this
Sets logging_enabled
setRecipientEvents()  : $this
Sets recipient_events
setRequireAcknowledgment()  : $this
Sets require_acknowledgment
setSignMessageWithX509Cert()  : $this
Sets sign_message_with_x509_cert
setSoapNameSpace()  : $this
Sets soap_name_space
setters()  : array<string|int, mixed>
Array of attributes to setter functions (for deserialization of responses)
setUrl()  : $this
Sets url
setUseSoapInterface()  : $this
Sets use_soap_interface
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 = ['delivery_mode' => 'deliveryMode', 'envelope_events' => 'envelopeEvents', 'event_data' => 'eventData', 'events' => 'events', 'include_certificate_of_completion' => 'includeCertificateOfCompletion', 'include_certificate_with_soap' => 'includeCertificateWithSoap', 'include_document_fields' => 'includeDocumentFields', 'include_documents' => 'includeDocuments', 'include_envelope_void_reason' => 'includeEnvelopeVoidReason', 'include_hmac' => 'includeHMAC', 'include_o_auth' => 'includeOAuth', 'include_sender_account_as_custom_field' => 'includeSenderAccountAsCustomField', 'include_time_zone' => 'includeTimeZone', 'integrator_managed' => 'integratorManaged', 'logging_enabled' => 'loggingEnabled', 'recipient_events' => 'recipientEvents', 'require_acknowledgment' => 'requireAcknowledgment', 'sign_message_with_x509_cert' => 'signMessageWithX509Cert', 'soap_name_space' => 'soapNameSpace', 'url' => 'url', 'use_soap_interface' => 'useSoapInterface']

$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 = ['delivery_mode' => 'getDeliveryMode', 'envelope_events' => 'getEnvelopeEvents', 'event_data' => 'getEventData', 'events' => 'getEvents', 'include_certificate_of_completion' => 'getIncludeCertificateOfCompletion', 'include_certificate_with_soap' => 'getIncludeCertificateWithSoap', 'include_document_fields' => 'getIncludeDocumentFields', 'include_documents' => 'getIncludeDocuments', 'include_envelope_void_reason' => 'getIncludeEnvelopeVoidReason', 'include_hmac' => 'getIncludeHmac', 'include_o_auth' => 'getIncludeOAuth', 'include_sender_account_as_custom_field' => 'getIncludeSenderAccountAsCustomField', 'include_time_zone' => 'getIncludeTimeZone', 'integrator_managed' => 'getIntegratorManaged', 'logging_enabled' => 'getLoggingEnabled', 'recipient_events' => 'getRecipientEvents', 'require_acknowledgment' => 'getRequireAcknowledgment', 'sign_message_with_x509_cert' => 'getSignMessageWithX509Cert', 'soap_name_space' => 'getSoapNameSpace', 'url' => 'getUrl', 'use_soap_interface' => 'getUseSoapInterface']

$setters

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

protected static array<string|int, string> $setters = ['delivery_mode' => 'setDeliveryMode', 'envelope_events' => 'setEnvelopeEvents', 'event_data' => 'setEventData', 'events' => 'setEvents', 'include_certificate_of_completion' => 'setIncludeCertificateOfCompletion', 'include_certificate_with_soap' => 'setIncludeCertificateWithSoap', 'include_document_fields' => 'setIncludeDocumentFields', 'include_documents' => 'setIncludeDocuments', 'include_envelope_void_reason' => 'setIncludeEnvelopeVoidReason', 'include_hmac' => 'setIncludeHmac', 'include_o_auth' => 'setIncludeOAuth', 'include_sender_account_as_custom_field' => 'setIncludeSenderAccountAsCustomField', 'include_time_zone' => 'setIncludeTimeZone', 'integrator_managed' => 'setIntegratorManaged', 'logging_enabled' => 'setLoggingEnabled', 'recipient_events' => 'setRecipientEvents', 'require_acknowledgment' => 'setRequireAcknowledgment', 'sign_message_with_x509_cert' => 'setSignMessageWithX509Cert', 'soap_name_space' => 'setSoapNameSpace', 'url' => 'setUrl', 'use_soap_interface' => 'setUseSoapInterface']

$swaggerFormats

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

protected static array<string|int, string> $swaggerFormats = ['delivery_mode' => null, 'envelope_events' => null, 'event_data' => null, 'events' => null, 'include_certificate_of_completion' => null, 'include_certificate_with_soap' => null, 'include_document_fields' => null, 'include_documents' => null, 'include_envelope_void_reason' => null, 'include_hmac' => null, 'include_o_auth' => null, 'include_sender_account_as_custom_field' => null, 'include_time_zone' => null, 'integrator_managed' => null, 'logging_enabled' => null, 'recipient_events' => null, 'require_acknowledgment' => null, 'sign_message_with_x509_cert' => null, 'soap_name_space' => null, 'url' => null, 'use_soap_interface' => null]

$swaggerModelName

The original name of the model.

protected static string $swaggerModelName = 'eventNotification'

$swaggerTypes

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

protected static array<string|int, string> $swaggerTypes = ['delivery_mode' => '?string', 'envelope_events' => '\\DocuSign\\eSign\\Model\\EnvelopeEvent[]', 'event_data' => '\\DocuSign\\eSign\\Model\\ConnectEventData', 'events' => '?string[]', 'include_certificate_of_completion' => '?string', 'include_certificate_with_soap' => '?string', 'include_document_fields' => '?string', 'include_documents' => '?string', 'include_envelope_void_reason' => '?string', 'include_hmac' => '?string', 'include_o_auth' => '?string', 'include_sender_account_as_custom_field' => '?string', 'include_time_zone' => '?string', 'integrator_managed' => '?string', 'logging_enabled' => '?string', 'recipient_events' => '\\DocuSign\\eSign\\Model\\RecipientEvent[]', 'require_acknowledgment' => '?string', 'sign_message_with_x509_cert' => '?string', 'soap_name_space' => '?string', 'url' => '?string', 'use_soap_interface' => '?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> —

getDeliveryMode()

Gets delivery_mode

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

getEvents()

Gets events

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

getIncludeCertificateOfCompletion()

Gets include_certificate_of_completion

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

getIncludeCertificateWithSoap()

Gets include_certificate_with_soap

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

getIncludeDocumentFields()

Gets include_document_fields

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

getIncludeDocuments()

Gets include_documents

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

getIncludeEnvelopeVoidReason()

Gets include_envelope_void_reason

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

getIncludeHmac()

Gets include_hmac

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

getIncludeOAuth()

Gets include_o_auth

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

getIncludeSenderAccountAsCustomField()

Gets include_sender_account_as_custom_field

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

getIncludeTimeZone()

Gets include_time_zone

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

getIntegratorManaged()

Gets integrator_managed

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

getLoggingEnabled()

Gets logging_enabled

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

getModelName()

The original name of the model.

public getModelName() : string
Return values
string —

getRequireAcknowledgment()

Gets require_acknowledgment

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

getSignMessageWithX509Cert()

Gets sign_message_with_x509_cert

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

getSoapNameSpace()

Gets soap_name_space

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

getUrl()

Gets url

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

getUseSoapInterface()

Gets use_soap_interface

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

setDeliveryMode()

Sets delivery_mode

public setDeliveryMode(string|null $delivery_mode) : $this
Parameters
$delivery_mode : string|null
Return values
$this —

setEnvelopeEvents()

Sets envelope_events

public setEnvelopeEvents(array<string|int, EnvelopeEvent> $envelope_events) : $this
Parameters
$envelope_events : array<string|int, EnvelopeEvent>

A list of envelope-level event statuses that will trigger Connect to send updates to the endpoint specified in the url property. To receive notifications, you must include either an envelopeEvents node or a recipientEvents node. You do not need to specify both.

Return values
$this —

setEvents()

Sets events

public setEvents(array<string|int, ?string> $events) : $this
Parameters
$events : array<string|int, ?string>
Return values
$this —

setIncludeCertificateOfCompletion()

Sets include_certificate_of_completion

public setIncludeCertificateOfCompletion(string|null $include_certificate_of_completion) : $this
Parameters
$include_certificate_of_completion : string|null

When set to true, the Connect Service includes the Certificate of Completion with completed envelopes.

Return values
$this —

setIncludeCertificateWithSoap()

Sets include_certificate_with_soap

public setIncludeCertificateWithSoap(string|null $include_certificate_with_soap) : $this
Parameters
$include_certificate_with_soap : string|null

When set to true, this tells the Connect service to send the DocuSign signedby certificate as part of the outgoing SOAP xml. This appears in the XML as wsse:BinarySecurityToken.

Return values
$this —

setIncludeDocumentFields()

Sets include_document_fields

public setIncludeDocumentFields(string|null $include_document_fields) : $this
Parameters
$include_document_fields : string|null

When set to true, the Document Fields associated with envelope documents are included in the data. Document Fields are optional custom name-value pairs added to documents using the API.

Return values
$this —

setIncludeDocuments()

Sets include_documents

public setIncludeDocuments(string|null $include_documents) : $this
Parameters
$include_documents : string|null

When set to true, the PDF documents are included in the message along with the updated XML.

Return values
$this —

setIncludeEnvelopeVoidReason()

Sets include_envelope_void_reason

public setIncludeEnvelopeVoidReason(string|null $include_envelope_void_reason) : $this
Parameters
$include_envelope_void_reason : string|null

When set to true, this tells the Connect Service to include the void reason, as entered by the person that voided the envelope, in the message.

Return values
$this —

setIncludeHmac()

Sets include_hmac

public setIncludeHmac(string|null $include_hmac) : $this
Parameters
$include_hmac : string|null
Return values
$this —

setIncludeOAuth()

Sets include_o_auth

public setIncludeOAuth(string|null $include_o_auth) : $this
Parameters
$include_o_auth : string|null
Return values
$this —

setIncludeSenderAccountAsCustomField()

Sets include_sender_account_as_custom_field

public setIncludeSenderAccountAsCustomField(string|null $include_sender_account_as_custom_field) : $this
Parameters
$include_sender_account_as_custom_field : string|null

When set to true, the sender account ID is included as a envelope custom field in the data.

Return values
$this —

setIncludeTimeZone()

Sets include_time_zone

public setIncludeTimeZone(string|null $include_time_zone) : $this
Parameters
$include_time_zone : string|null

When set to true, the envelope time zone information is included in the message.

Return values
$this —

setIntegratorManaged()

Sets integrator_managed

public setIntegratorManaged(string|null $integrator_managed) : $this
Parameters
$integrator_managed : string|null
Return values
$this —

setLoggingEnabled()

Sets logging_enabled

public setLoggingEnabled(string|null $logging_enabled) : $this
Parameters
$logging_enabled : string|null

When set to true, logging is turned on for envelope events on the Web Console Connect page.

Return values
$this —

setRecipientEvents()

Sets recipient_events

public setRecipientEvents(array<string|int, RecipientEvent> $recipient_events) : $this
Parameters
$recipient_events : array<string|int, RecipientEvent>

A list of recipient event statuses that will trigger Connect to send updates to the endpoint specified in the url property. To receive notifications, you must include either an envelopeEvents node or a recipientEvents node. You do not need to specify both.

Return values
$this —

setRequireAcknowledgment()

Sets require_acknowledgment

public setRequireAcknowledgment(string|null $require_acknowledgment) : $this
Parameters
$require_acknowledgment : string|null

When set to true, the DocuSign Connect service checks that the message was received and retries on failures.

Return values
$this —

setSignMessageWithX509Cert()

Sets sign_message_with_x509_cert

public setSignMessageWithX509Cert(string|null $sign_message_with_x509_cert) : $this
Parameters
$sign_message_with_x509_cert : string|null

When set to true, messages are signed with an X509 certificate. This provides support for 2-way SSL in the envelope.

Return values
$this —

setSoapNameSpace()

Sets soap_name_space

public setSoapNameSpace(string|null $soap_name_space) : $this
Parameters
$soap_name_space : string|null

This lists the namespace in the SOAP listener provided.

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

setUrl()

Sets url

public setUrl(string|null $url) : $this
Parameters
$url : string|null

Specifies the endpoint to which envelope updates are sent. Udpates are sent as XML unless useSoapInterface property is set to true.

Return values
$this —

setUseSoapInterface()

Sets use_soap_interface

public setUseSoapInterface(string|null $use_soap_interface) : $this
Parameters
$use_soap_interface : string|null

When set to true, this tells the Connect service that the user's endpoint has implemented a SOAP interface.

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