Documentation

ConnectCustomConfiguration
in package

DocuSign

eSign

implements ModelInterface, ArrayAccess

ConnectCustomConfiguration Class Doc Comment

Interfaces, Classes, Traits and Enums

ModelInterface: Interface abstracting model access.
ArrayAccess

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
getAllowEnvelopePublish() : string|null: Gets allow_envelope_publish
getAllowSalesforcePublish() : string|null: Gets allow_salesforce_publish
getAllUsers() : string|null: Gets all_users
getAllUsersExcept() : string|null: Gets all_users_except
getConfigurationType() : string|null: Gets configuration_type
getConnectId() : string|null: Gets connect_id
getDeliveryMode() : string|null: Gets delivery_mode
getDisabledBy() : string|null: Gets disabled_by
getEnableLog() : string|null: Gets enable_log
getEnvelopeEvents() : array<string|int, ?string>: Gets envelope_events
getEventData() : ConnectEventData: Gets event_data
getEvents() : array<string|int, ?string>: Gets events
getExternalFolderId() : string|null: Gets external_folder_id
getExternalFolderLabel() : string|null: Gets external_folder_label
getGroupIds() : array<string|int, ?string>: Gets group_ids
getIncludeCertificateOfCompletion() : string|null: Gets include_certificate_of_completion
getIncludeCertSoapHeader() : string|null: Gets include_cert_soap_header
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_accountas_custom_field
getIncludeTimeZoneInformation() : string|null: Gets include_time_zone_information
getIntegratorManaged() : string|null: Gets integrator_managed
getModelName() : string: The original name of the model.
getName() : string|null: Gets name
getPassword() : string|null: Gets password
getRecipientEvents() : array<string|int, ?string>: Gets recipient_events
getRequireMutualTls() : string|null: Gets require_mutual_tls
getRequiresAcknowledgement() : string|null: Gets requires_acknowledgement
getSalesforceApiVersion() : string|null: Gets salesforce_api_version
getSalesforceAuthcode() : string|null: Gets salesforce_authcode
getSalesforceCallBackUrl() : string|null: Gets salesforce_call_back_url
getSalesforceDocumentsAsContentFiles() : string|null: Gets salesforce_documents_as_content_files
getSenderOverride() : string|null: Gets sender_override
getSenderSelectableItems() : array<string|int, ?string>: Gets sender_selectable_items
getSfObjects() : array<string|int, ConnectSalesforceObject>: Gets sf_objects
getSignMessageWithX509Certificate() : string|null: Gets sign_message_with_x509_certificate
getSoapNamespace() : string|null: Gets soap_namespace
getters() : array<string|int, mixed>: Array of attributes to getter functions (for serialization of requests)
getUrlToPublishTo() : string|null: Gets url_to_publish_to
getUserIds() : array<string|int, ?string>: Gets user_ids
getUserName() : string|null: Gets user_name
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.
setAllowEnvelopePublish() : $this: Sets allow_envelope_publish
setAllowSalesforcePublish() : $this: Sets allow_salesforce_publish
setAllUsers() : $this: Sets all_users
setAllUsersExcept() : $this: Sets all_users_except
setConfigurationType() : $this: Sets configuration_type
setConnectId() : $this: Sets connect_id
setDeliveryMode() : $this: Sets delivery_mode
setDisabledBy() : $this: Sets disabled_by
setEnableLog() : $this: Sets enable_log
setEnvelopeEvents() : $this: Sets envelope_events
setEventData() : $this: Sets event_data
setEvents() : $this: Sets events
setExternalFolderId() : $this: Sets external_folder_id
setExternalFolderLabel() : $this: Sets external_folder_label
setGroupIds() : $this: Sets group_ids
setIncludeCertificateOfCompletion() : $this: Sets include_certificate_of_completion
setIncludeCertSoapHeader() : $this: Sets include_cert_soap_header
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_accountas_custom_field
setIncludeTimeZoneInformation() : $this: Sets include_time_zone_information
setIntegratorManaged() : $this: Sets integrator_managed
setName() : $this: Sets name
setPassword() : $this: Sets password
setRecipientEvents() : $this: Sets recipient_events
setRequireMutualTls() : $this: Sets require_mutual_tls
setRequiresAcknowledgement() : $this: Sets requires_acknowledgement
setSalesforceApiVersion() : $this: Sets salesforce_api_version
setSalesforceAuthcode() : $this: Sets salesforce_authcode
setSalesforceCallBackUrl() : $this: Sets salesforce_call_back_url
setSalesforceDocumentsAsContentFiles() : $this: Sets salesforce_documents_as_content_files
setSenderOverride() : $this: Sets sender_override
setSenderSelectableItems() : $this: Sets sender_selectable_items
setSfObjects() : $this: Sets sf_objects
setSignMessageWithX509Certificate() : $this: Sets sign_message_with_x509_certificate
setSoapNamespace() : $this: Sets soap_namespace
setters() : array<string|int, mixed>: Array of attributes to setter functions (for deserialization of responses)
setUrlToPublishTo() : $this: Sets url_to_publish_to
setUserIds() : $this: Sets user_ids
setUserName() : $this: Sets user_name
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

DISCRIMINATOR


    public
        mixed
    DISCRIMINATOR
    = null

$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
     = ['allow_envelope_publish' => 'allowEnvelopePublish', 'allow_salesforce_publish' => 'allowSalesforcePublish', 'all_users' => 'allUsers', 'all_users_except' => 'allUsersExcept', 'configuration_type' => 'configurationType', 'connect_id' => 'connectId', 'delivery_mode' => 'deliveryMode', 'disabled_by' => 'disabledBy', 'enable_log' => 'enableLog', 'envelope_events' => 'envelopeEvents', 'event_data' => 'eventData', 'events' => 'events', 'external_folder_id' => 'externalFolderId', 'external_folder_label' => 'externalFolderLabel', 'group_ids' => 'groupIds', 'include_certificate_of_completion' => 'includeCertificateOfCompletion', 'include_cert_soap_header' => 'includeCertSoapHeader', 'include_document_fields' => 'includeDocumentFields', 'include_documents' => 'includeDocuments', 'include_envelope_void_reason' => 'includeEnvelopeVoidReason', 'include_hmac' => 'includeHMAC', 'include_o_auth' => 'includeOAuth', 'include_sender_accountas_custom_field' => 'includeSenderAccountasCustomField', 'include_time_zone_information' => 'includeTimeZoneInformation', 'integrator_managed' => 'integratorManaged', 'name' => 'name', 'password' => 'password', 'recipient_events' => 'recipientEvents', 'require_mutual_tls' => 'requireMutualTls', 'requires_acknowledgement' => 'requiresAcknowledgement', 'salesforce_api_version' => 'salesforceApiVersion', 'salesforce_authcode' => 'salesforceAuthcode', 'salesforce_call_back_url' => 'salesforceCallBackUrl', 'salesforce_documents_as_content_files' => 'salesforceDocumentsAsContentFiles', 'sender_override' => 'senderOverride', 'sender_selectable_items' => 'senderSelectableItems', 'sf_objects' => 'sfObjects', 'sign_message_with_x509_certificate' => 'signMessageWithX509Certificate', 'soap_namespace' => 'soapNamespace', 'url_to_publish_to' => 'urlToPublishTo', 'user_ids' => 'userIds', 'user_name' => 'userName', '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
     = ['allow_envelope_publish' => 'getAllowEnvelopePublish', 'allow_salesforce_publish' => 'getAllowSalesforcePublish', 'all_users' => 'getAllUsers', 'all_users_except' => 'getAllUsersExcept', 'configuration_type' => 'getConfigurationType', 'connect_id' => 'getConnectId', 'delivery_mode' => 'getDeliveryMode', 'disabled_by' => 'getDisabledBy', 'enable_log' => 'getEnableLog', 'envelope_events' => 'getEnvelopeEvents', 'event_data' => 'getEventData', 'events' => 'getEvents', 'external_folder_id' => 'getExternalFolderId', 'external_folder_label' => 'getExternalFolderLabel', 'group_ids' => 'getGroupIds', 'include_certificate_of_completion' => 'getIncludeCertificateOfCompletion', 'include_cert_soap_header' => 'getIncludeCertSoapHeader', 'include_document_fields' => 'getIncludeDocumentFields', 'include_documents' => 'getIncludeDocuments', 'include_envelope_void_reason' => 'getIncludeEnvelopeVoidReason', 'include_hmac' => 'getIncludeHmac', 'include_o_auth' => 'getIncludeOAuth', 'include_sender_accountas_custom_field' => 'getIncludeSenderAccountasCustomField', 'include_time_zone_information' => 'getIncludeTimeZoneInformation', 'integrator_managed' => 'getIntegratorManaged', 'name' => 'getName', 'password' => 'getPassword', 'recipient_events' => 'getRecipientEvents', 'require_mutual_tls' => 'getRequireMutualTls', 'requires_acknowledgement' => 'getRequiresAcknowledgement', 'salesforce_api_version' => 'getSalesforceApiVersion', 'salesforce_authcode' => 'getSalesforceAuthcode', 'salesforce_call_back_url' => 'getSalesforceCallBackUrl', 'salesforce_documents_as_content_files' => 'getSalesforceDocumentsAsContentFiles', 'sender_override' => 'getSenderOverride', 'sender_selectable_items' => 'getSenderSelectableItems', 'sf_objects' => 'getSfObjects', 'sign_message_with_x509_certificate' => 'getSignMessageWithX509Certificate', 'soap_namespace' => 'getSoapNamespace', 'url_to_publish_to' => 'getUrlToPublishTo', 'user_ids' => 'getUserIds', 'user_name' => 'getUserName', 'use_soap_interface' => 'getUseSoapInterface']

$setters

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


    protected
    static    array<string|int, string>
    $setters
     = ['allow_envelope_publish' => 'setAllowEnvelopePublish', 'allow_salesforce_publish' => 'setAllowSalesforcePublish', 'all_users' => 'setAllUsers', 'all_users_except' => 'setAllUsersExcept', 'configuration_type' => 'setConfigurationType', 'connect_id' => 'setConnectId', 'delivery_mode' => 'setDeliveryMode', 'disabled_by' => 'setDisabledBy', 'enable_log' => 'setEnableLog', 'envelope_events' => 'setEnvelopeEvents', 'event_data' => 'setEventData', 'events' => 'setEvents', 'external_folder_id' => 'setExternalFolderId', 'external_folder_label' => 'setExternalFolderLabel', 'group_ids' => 'setGroupIds', 'include_certificate_of_completion' => 'setIncludeCertificateOfCompletion', 'include_cert_soap_header' => 'setIncludeCertSoapHeader', 'include_document_fields' => 'setIncludeDocumentFields', 'include_documents' => 'setIncludeDocuments', 'include_envelope_void_reason' => 'setIncludeEnvelopeVoidReason', 'include_hmac' => 'setIncludeHmac', 'include_o_auth' => 'setIncludeOAuth', 'include_sender_accountas_custom_field' => 'setIncludeSenderAccountasCustomField', 'include_time_zone_information' => 'setIncludeTimeZoneInformation', 'integrator_managed' => 'setIntegratorManaged', 'name' => 'setName', 'password' => 'setPassword', 'recipient_events' => 'setRecipientEvents', 'require_mutual_tls' => 'setRequireMutualTls', 'requires_acknowledgement' => 'setRequiresAcknowledgement', 'salesforce_api_version' => 'setSalesforceApiVersion', 'salesforce_authcode' => 'setSalesforceAuthcode', 'salesforce_call_back_url' => 'setSalesforceCallBackUrl', 'salesforce_documents_as_content_files' => 'setSalesforceDocumentsAsContentFiles', 'sender_override' => 'setSenderOverride', 'sender_selectable_items' => 'setSenderSelectableItems', 'sf_objects' => 'setSfObjects', 'sign_message_with_x509_certificate' => 'setSignMessageWithX509Certificate', 'soap_namespace' => 'setSoapNamespace', 'url_to_publish_to' => 'setUrlToPublishTo', 'user_ids' => 'setUserIds', 'user_name' => 'setUserName', 'use_soap_interface' => 'setUseSoapInterface']

$swaggerFormats

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


    protected
    static    array<string|int, string>
    $swaggerFormats
     = ['allow_envelope_publish' => null, 'allow_salesforce_publish' => null, 'all_users' => null, 'all_users_except' => null, 'configuration_type' => null, 'connect_id' => null, 'delivery_mode' => null, 'disabled_by' => null, 'enable_log' => null, 'envelope_events' => null, 'event_data' => null, 'events' => null, 'external_folder_id' => null, 'external_folder_label' => null, 'group_ids' => null, 'include_certificate_of_completion' => null, 'include_cert_soap_header' => null, 'include_document_fields' => null, 'include_documents' => null, 'include_envelope_void_reason' => null, 'include_hmac' => null, 'include_o_auth' => null, 'include_sender_accountas_custom_field' => null, 'include_time_zone_information' => null, 'integrator_managed' => null, 'name' => null, 'password' => null, 'recipient_events' => null, 'require_mutual_tls' => null, 'requires_acknowledgement' => null, 'salesforce_api_version' => null, 'salesforce_authcode' => null, 'salesforce_call_back_url' => null, 'salesforce_documents_as_content_files' => null, 'sender_override' => null, 'sender_selectable_items' => null, 'sf_objects' => null, 'sign_message_with_x509_certificate' => null, 'soap_namespace' => null, 'url_to_publish_to' => null, 'user_ids' => null, 'user_name' => null, 'use_soap_interface' => null]

$swaggerModelName

The original name of the model.


    protected
    static    string
    $swaggerModelName
     = 'connectCustomConfiguration'

$swaggerTypes

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


    protected
    static    array<string|int, string>
    $swaggerTypes
     = ['allow_envelope_publish' => '?string', 'allow_salesforce_publish' => '?string', 'all_users' => '?string', 'all_users_except' => '?string', 'configuration_type' => '?string', 'connect_id' => '?string', 'delivery_mode' => '?string', 'disabled_by' => '?string', 'enable_log' => '?string', 'envelope_events' => '?string[]', 'event_data' => '\\DocuSign\\eSign\\Model\\ConnectEventData', 'events' => '?string[]', 'external_folder_id' => '?string', 'external_folder_label' => '?string', 'group_ids' => '?string[]', 'include_certificate_of_completion' => '?string', 'include_cert_soap_header' => '?string', 'include_document_fields' => '?string', 'include_documents' => '?string', 'include_envelope_void_reason' => '?string', 'include_hmac' => '?string', 'include_o_auth' => '?string', 'include_sender_accountas_custom_field' => '?string', 'include_time_zone_information' => '?string', 'integrator_managed' => '?string', 'name' => '?string', 'password' => '?string', 'recipient_events' => '?string[]', 'require_mutual_tls' => '?string', 'requires_acknowledgement' => '?string', 'salesforce_api_version' => '?string', 'salesforce_authcode' => '?string', 'salesforce_call_back_url' => '?string', 'salesforce_documents_as_content_files' => '?string', 'sender_override' => '?string', 'sender_selectable_items' => '?string[]', 'sf_objects' => '\\DocuSign\\eSign\\Model\\ConnectSalesforceObject[]', 'sign_message_with_x509_certificate' => '?string', 'soap_namespace' => '?string', 'url_to_publish_to' => '?string', 'user_ids' => '?string[]', 'user_name' => '?string', 'use_soap_interface' => '?string']

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

getAllowEnvelopePublish()

Gets allow_envelope_publish


    public
                getAllowEnvelopePublish() : string|null

Return values

string|null —

getAllowSalesforcePublish()

Gets allow_salesforce_publish


    public
                getAllowSalesforcePublish() : string|null

Return values

string|null —

getAllUsers()

Gets all_users


    public
                getAllUsers() : string|null

Return values

string|null —

getAllUsersExcept()

Gets all_users_except


    public
                getAllUsersExcept() : string|null

Return values

string|null —

getConfigurationType()

Gets configuration_type


    public
                getConfigurationType() : string|null

Return values

string|null —

getConnectId()

Gets connect_id


    public
                getConnectId() : string|null

Return values

string|null —

getDeliveryMode()

Gets delivery_mode


    public
                getDeliveryMode() : string|null

Return values

string|null —

getDisabledBy()

Gets disabled_by


    public
                getDisabledBy() : string|null

Return values

string|null —

getEnableLog()

Gets enable_log


    public
                getEnableLog() : string|null

Return values

string|null —

getEnvelopeEvents()

Gets envelope_events


    public
                getEnvelopeEvents() : array<string|int, ?string>

Return values

array<string|int, ?string> —

getEventData()

Gets event_data


    public
                getEventData() : ConnectEventData

Return values

ConnectEventData —

getEvents()

Gets events


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

Return values

array<string|int, ?string> —

getExternalFolderId()

Gets external_folder_id


    public
                getExternalFolderId() : string|null

Return values

string|null —

getExternalFolderLabel()

Gets external_folder_label


    public
                getExternalFolderLabel() : string|null

Return values

string|null —

getGroupIds()

Gets group_ids


    public
                getGroupIds() : array<string|int, ?string>

Return values

array<string|int, ?string> —

getIncludeCertificateOfCompletion()

Gets include_certificate_of_completion


    public
                getIncludeCertificateOfCompletion() : string|null

Return values

string|null —

getIncludeCertSoapHeader()

Gets include_cert_soap_header


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


    public
                getIncludeSenderAccountasCustomField() : string|null

Return values

string|null —

getIncludeTimeZoneInformation()

Gets include_time_zone_information


    public
                getIncludeTimeZoneInformation() : string|null

Return values

string|null —

getIntegratorManaged()

Gets integrator_managed


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

getPassword()

Gets password


    public
                getPassword() : string|null

Return values

string|null —

getRecipientEvents()

Gets recipient_events


    public
                getRecipientEvents() : array<string|int, ?string>

Return values

array<string|int, ?string> —

getRequireMutualTls()

Gets require_mutual_tls


    public
                getRequireMutualTls() : string|null

Return values

string|null —

getRequiresAcknowledgement()

Gets requires_acknowledgement


    public
                getRequiresAcknowledgement() : string|null

Return values

string|null —

getSalesforceApiVersion()

Gets salesforce_api_version


    public
                getSalesforceApiVersion() : string|null

Return values

string|null —

getSalesforceAuthcode()

Gets salesforce_authcode


    public
                getSalesforceAuthcode() : string|null

Return values

string|null —

getSalesforceCallBackUrl()

Gets salesforce_call_back_url


    public
                getSalesforceCallBackUrl() : string|null

Return values

string|null —

getSalesforceDocumentsAsContentFiles()

Gets salesforce_documents_as_content_files


    public
                getSalesforceDocumentsAsContentFiles() : string|null

Return values

string|null —

getSenderOverride()

Gets sender_override


    public
                getSenderOverride() : string|null

Return values

string|null —

getSenderSelectableItems()

Gets sender_selectable_items


    public
                getSenderSelectableItems() : array<string|int, ?string>

Return values

array<string|int, ?string> —

getSfObjects()

Gets sf_objects


    public
                getSfObjects() : array<string|int, ConnectSalesforceObject>

Return values

array<string|int, ConnectSalesforceObject> —

getSignMessageWithX509Certificate()

Gets sign_message_with_x509_certificate


    public
                getSignMessageWithX509Certificate() : string|null

Return values

string|null —

getSoapNamespace()

Gets soap_namespace


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

getUrlToPublishTo()

Gets url_to_publish_to


    public
                getUrlToPublishTo() : string|null

Return values

string|null —

getUserIds()

Gets user_ids


    public
                getUserIds() : array<string|int, ?string>

Return values

array<string|int, ?string> —

getUserName()

Gets user_name


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

setAllowEnvelopePublish()

Sets allow_envelope_publish


    public
                setAllowEnvelopePublish(string|null $allow_envelope_publish) : $this

Parameters

$allow_envelope_publish : string|null: When set to true, data is sent to the urlToPublishTo web address. This option can be set to false to stop sending data while maintaining the Connect configuration information.

Return values

$this —

setAllowSalesforcePublish()

Sets allow_salesforce_publish


    public
                setAllowSalesforcePublish(string|null $allow_salesforce_publish) : $this

Parameters

$allow_salesforce_publish : string|null

Return values

$this —

setAllUsers()

Sets all_users


    public
                setAllUsers(string|null $all_users) : $this

Parameters

$all_users : string|null: When set to true, the tracked envelope and recipient events for all users, including users that are added a later time, are sent through Connect.

Return values

$this —

setAllUsersExcept()

Sets all_users_except


    public
                setAllUsersExcept(string|null $all_users_except) : $this

Parameters

$all_users_except : string|null

Return values

$this —

setConfigurationType()

Sets configuration_type


    public
                setConfigurationType(string|null $configuration_type) : $this

Parameters

$configuration_type : string|null: If merge field's are being used, specifies the type of the merge field. The only supported value is salesforce.

Return values

$this —

setConnectId()

Sets connect_id


    public
                setConnectId(string|null $connect_id) : $this

Parameters

$connect_id : string|null: Specifies the DocuSign generated ID for the Connect configuration.

Return values

$this —

setDeliveryMode()

Sets delivery_mode


    public
                setDeliveryMode(string|null $delivery_mode) : $this

Parameters

$delivery_mode : string|null

Return values

$this —

setDisabledBy()

Sets disabled_by


    public
                setDisabledBy(string|null $disabled_by) : $this

Parameters

$disabled_by : string|null

Return values

$this —

setEnableLog()

Sets enable_log


    public
                setEnableLog(string|null $enable_log) : $this

Parameters

$enable_log : string|null: This turns Connect logging on or off. When set to true, logging is turned on.

Return values

$this —

setEnvelopeEvents()

Sets envelope_events


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

Parameters

$envelope_events : array<string|int, ?string>: A comma separated list of ï¿½Envelopeï¿½ related events that are tracked through Connect. The possible event values are: Sent, Delivered, Completed, Declined, and Voided.

Return values

$this —

setEventData()

Sets event_data


    public
                setEventData(ConnectEventData $event_data) : $this

Parameters

$event_data : ConnectEventData: Allows you to specify the format of the information the Connect webhooks returns. For more information, see Connect webhooks with JSON notifications

Return values

$this —

setEvents()

Sets events


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

Parameters

$events : array<string|int, ?string>

Return values

$this —

setExternalFolderId()

Sets external_folder_id


    public
                setExternalFolderId(string|null $external_folder_id) : $this

Parameters

$external_folder_id : string|null

Return values

$this —

setExternalFolderLabel()

Sets external_folder_label


    public
                setExternalFolderLabel(string|null $external_folder_label) : $this

Parameters

$external_folder_label : string|null

Return values

$this —

setGroupIds()

Sets group_ids


    public
                setGroupIds(array<string|int, ?string> $group_ids) : $this

Parameters

$group_ids : 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 —

setIncludeCertSoapHeader()

Sets include_cert_soap_header


    public
                setIncludeCertSoapHeader(string|null $include_cert_soap_header) : $this

Parameters

$include_cert_soap_header : string|null

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, Connect will send the PDF document along with the update 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, Connect will include the voidedReason for voided envelopes.

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_accountas_custom_field


    public
                setIncludeSenderAccountasCustomField(string|null $include_sender_accountas_custom_field) : $this

Parameters

$include_sender_accountas_custom_field : string|null: When set to true, Connect will include the sender account as Custom Field in the data.

Return values

$this —

setIncludeTimeZoneInformation()

Sets include_time_zone_information


    public
                setIncludeTimeZoneInformation(string|null $include_time_zone_information) : $this

Parameters

$include_time_zone_information : string|null: When set to true, Connect will include the envelope time zone information.

Return values

$this —

setIntegratorManaged()

Sets integrator_managed


    public
                setIntegratorManaged(string|null $integrator_managed) : $this

Parameters

$integrator_managed : string|null

Return values

$this —

setName()

Sets name


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

Parameters

$name : string|null: The name of the Connect configuration. The name helps identify the configuration in the list.

Return values

$this —

setPassword()

Sets password


    public
                setPassword(string|null $password) : $this

Parameters

$password : string|null

Return values

$this —

setRecipientEvents()

Sets recipient_events


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

Parameters

$recipient_events : array<string|int, ?string>: A comma separated list of ï¿½Recipientï¿½ related events that are tracked through Connect. The possible event values are: Sent, Delivered, Completed, Declined, AuthenticationFailed, and AutoResponded.

Return values

$this —

setRequireMutualTls()

Sets require_mutual_tls


    public
                setRequireMutualTls(string|null $require_mutual_tls) : $this

Parameters

$require_mutual_tls : string|null

Return values

$this —

setRequiresAcknowledgement()

Sets requires_acknowledgement


    public
                setRequiresAcknowledgement(string|null $requires_acknowledgement) : $this

Parameters

$requires_acknowledgement : string|null: When set to true, and a publication message fails to be acknowledged, the message goes back into the queue and the system will retry delivery after a successful acknowledgement is received. If the delivery fails a second time, the message is not returned to the queue for sending until Connect receives a successful acknowledgement and it has been at least 24 hours since the previous retry. There is a maximum of ten retries Alternately, you can use Republish Connect Information to manually republish the envelope information.

Return values

$this —

setSalesforceApiVersion()

Sets salesforce_api_version


    public
                setSalesforceApiVersion(string|null $salesforce_api_version) : $this

Parameters

$salesforce_api_version : string|null

Return values

$this —

setSalesforceAuthcode()

Sets salesforce_authcode


    public
                setSalesforceAuthcode(string|null $salesforce_authcode) : $this

Parameters

$salesforce_authcode : string|null

Return values

$this —

setSalesforceCallBackUrl()

Sets salesforce_call_back_url


    public
                setSalesforceCallBackUrl(string|null $salesforce_call_back_url) : $this

Parameters

$salesforce_call_back_url : string|null

Return values

$this —

setSalesforceDocumentsAsContentFiles()

Sets salesforce_documents_as_content_files


    public
                setSalesforceDocumentsAsContentFiles(string|null $salesforce_documents_as_content_files) : $this

Parameters

$salesforce_documents_as_content_files : string|null

Return values

$this —

setSenderOverride()

Sets sender_override


    public
                setSenderOverride(string|null $sender_override) : $this

Parameters

$sender_override : string|null

Return values

$this —

setSenderSelectableItems()

Sets sender_selectable_items


    public
                setSenderSelectableItems(array<string|int, ?string> $sender_selectable_items) : $this

Parameters

$sender_selectable_items : array<string|int, ?string>

Return values

$this —

setSfObjects()

Sets sf_objects


    public
                setSfObjects(array<string|int, ConnectSalesforceObject> $sf_objects) : $this

Parameters

$sf_objects : array<string|int, ConnectSalesforceObject>

Return values

$this —

setSignMessageWithX509Certificate()

Sets sign_message_with_x509_certificate


    public
                setSignMessageWithX509Certificate(string|null $sign_message_with_x509_certificate) : $this

Parameters

$sign_message_with_x509_certificate : string|null: When set to true, Connect messages are signed with an X509 certificate. This provides support for 2-way SSL.

Return values

$this —

setSoapNamespace()

Sets soap_namespace


    public
                setSoapNamespace(string|null $soap_namespace) : $this

Parameters

$soap_namespace : string|null: The namespace of the SOAP interface. The namespace value must be set if useSoapInterface is set to true.

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

setUrlToPublishTo()

Sets url_to_publish_to


    public
                setUrlToPublishTo(string|null $url_to_publish_to) : $this

Parameters

$url_to_publish_to : string|null: This is the web address and name of your listener or Retrieving Service endpoint. You need to include HTTPS:// in the web address.

Return values

$this —

setUserIds()

Sets user_ids


    public
                setUserIds(array<string|int, ?string> $user_ids) : $this

Parameters

$user_ids : array<string|int, ?string>: A comma separated list of userIds. This sets the users associated with the tracked envelope and recipient events. When one of the event occurs for a set user, the information is sent through Connect. ###### Note: If allUsers is set to ï¿½falseï¿½ then you must provide a list of user idï¿½s.

Return values

$this —

setUserName()

Sets user_name


    public
                setUserName(string|null $user_name) : $this

Parameters

$user_name : string|null

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, indicates that the urlToPublishTo property contains a SOAP endpoint.

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

ConnectCustomConfiguration in package DocuSign eSign implements ModelInterface, ArrayAccess

Tags

Interfaces, Classes, Traits and Enums

Table of Contents

Constants

DISCRIMINATOR

Properties

$attributeMap

$container

$getters

$setters

$swaggerFormats

$swaggerModelName

$swaggerTypes

Methods

__construct()

Parameters

Return values

__toString()

Return values

attributeMap()

Return values

getAllowEnvelopePublish()

Return values

getAllowSalesforcePublish()

Return values

getAllUsers()

Return values

getAllUsersExcept()

Return values

getConfigurationType()

Return values

getConnectId()

Return values

getDeliveryMode()

Return values

getDisabledBy()

Return values

getEnableLog()

Return values

getEnvelopeEvents()

Return values

getEventData()

Return values

getEvents()

Return values

getExternalFolderId()

Return values

getExternalFolderLabel()

Return values

getGroupIds()

Return values

getIncludeCertificateOfCompletion()

Return values

getIncludeCertSoapHeader()

Return values

getIncludeDocumentFields()

Return values

getIncludeDocuments()

Return values

getIncludeEnvelopeVoidReason()

Return values

getIncludeHmac()

Return values

getIncludeOAuth()

Return values

getIncludeSenderAccountasCustomField()

Return values

getIncludeTimeZoneInformation()

Return values

getIntegratorManaged()

Return values

getModelName()

Return values

getName()

Return values

getPassword()

Return values

getRecipientEvents()

Return values

ConnectCustomConfiguration
in package

DocuSign

eSign

implements ModelInterface, ArrayAccess