module:model/ConnectCustomConfiguration

module:model/ConnectCustomConfiguration

new module:model/ConnectCustomConfiguration()

Source:

Constructs a new ConnectCustomConfiguration.
The connectCustomConfiguration object describes how Connect is configured for your account.

Members

(inner) allowEnvelopePublish :String

Source:

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.

Type:
  • String

(inner) allowSalesforcePublish :String

Source:
Type:
  • String

(inner) allUsers :String

Source:

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.

Type:
  • String

(inner) allUsersExcept :String

Source:
Type:
  • String

(inner) configurationType :String

Source:

If merge field's are being used, specifies the type of the merge field. The only supported value is salesforce.

Type:
  • String

(inner) connectId :String

Source:

Specifies the DocuSign generated ID for the Connect configuration.

Type:
  • String

(inner) deliveryMode :String

Source:
Type:
  • String

(inner) disabledBy :String

Source:
Type:
  • String

(inner) enableLog :String

Source:

This turns Connect logging on or off. When set to true, logging is turned on.

Type:
  • String

(inner) envelopeEvents :Array.<String>

Source:

A comma separated list of �Envelope� related events that are tracked through Connect. The possible event values are: Sent, Delivered, Completed, Declined, and Voided.

Type:
  • Array.<String>

(inner) eventData :module:model/ConnectEventData

Source:

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

Type:

(inner) events :Array.<String>

Source:
Type:
  • Array.<String>

(inner) externalFolderId :String

Source:
Type:
  • String

(inner) externalFolderLabel :String

Source:
Type:
  • String

(inner) groupIds :Array.<String>

Source:
Type:
  • Array.<String>

(inner) includeCertificateOfCompletion :String

Source:

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

Type:
  • String

(inner) includeCertSoapHeader :String

Source:
Type:
  • String

(inner) includeDocumentFields :String

Source:

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.

Type:
  • String

(inner) includeDocuments :String

Source:

When set to true, Connect will send the PDF document along with the update XML.

Type:
  • String

(inner) includeEnvelopeVoidReason :String

Source:

When set to true, Connect will include the voidedReason for voided envelopes.

Type:
  • String

(inner) includeHMAC :String

Source:
Type:
  • String

(inner) includeOAuth :String

Source:
Type:
  • String

(inner) includeSenderAccountasCustomField :String

Source:

When set to true, Connect will include the sender account as Custom Field in the data.

Type:
  • String

(inner) includeTimeZoneInformation :String

Source:

When set to true, Connect will include the envelope time zone information.

Type:
  • String

(inner) integratorManaged :String

Source:
Type:
  • String

(inner) name :String

Source:

The name of the Connect configuration. The name helps identify the configuration in the list.

Type:
  • String

(inner) password :String

Source:
Type:
  • String

(inner) recipientEvents :Array.<String>

Source:

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.

Type:
  • Array.<String>

(inner) requireMutualTls :String

Source:
Type:
  • String

(inner) requiresAcknowledgement :String

Source:

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.

Type:
  • String

(inner) salesforceApiVersion :String

Source:
Type:
  • String

(inner) salesforceAuthcode :String

Source:
Type:
  • String

(inner) salesforceCallBackUrl :String

Source:
Type:
  • String

(inner) salesforceDocumentsAsContentFiles :String

Source:
Type:
  • String

(inner) senderOverride :String

Source:
Type:
  • String

(inner) senderSelectableItems :Array.<String>

Source:
Type:
  • Array.<String>

(inner) sfObjects :Array.<module:model/ConnectSalesforceObject>

Source:
Type:

(inner) signMessageWithX509Certificate :String

Source:

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

Type:
  • String

(inner) soapNamespace :String

Source:

The namespace of the SOAP interface. The namespace value must be set if useSoapInterface is set to true.

Type:
  • String

(inner) urlToPublishTo :String

Source:

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

Type:
  • String

(inner) userIds :Array.<String>

Source:

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.

Type:
  • Array.<String>

(inner) userName :String

Source:
Type:
  • String

(inner) useSoapInterface :String

Source:

When set to true, indicates that the urlToPublishTo property contains a SOAP endpoint.

Type:
  • String

Methods

(static) constructFromObject(data, obj) → {module:model/ConnectCustomConfiguration}

Source:

Constructs a ConnectCustomConfiguration from a plain JavaScript object, optionally creating a new instance.
Copies all relevant properties from data to obj if supplied or a new instance if not.

Parameters:
Name Type Description
data Object

The plain JavaScript object bearing properties of interest.
obj module:model/ConnectCustomConfiguration

Optional instance to populate.
Returns:

The populated ConnectCustomConfiguration instance.

Type
module:model/ConnectCustomConfiguration