Class ConnectCustomConfiguration


  • public class ConnectCustomConfiguration
    extends Object
    The `connectCustomConfiguration` object describes how Connect is configured for your account..
    • Constructor Detail

      • ConnectCustomConfiguration

        public ConnectCustomConfiguration()
    • Method Detail

      • allowEnvelopePublish

        public ConnectCustomConfiguration allowEnvelopePublish​(String allowEnvelopePublish)
        allowEnvelopePublish.
        Returns:
        ConnectCustomConfiguration
      • getAllowEnvelopePublish

        public String getAllowEnvelopePublish()
        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..
        Returns:
        allowEnvelopePublish
      • setAllowEnvelopePublish

        public void setAllowEnvelopePublish​(String allowEnvelopePublish)
        setAllowEnvelopePublish.
      • allowSalesforcePublish

        public ConnectCustomConfiguration allowSalesforcePublish​(String allowSalesforcePublish)
        allowSalesforcePublish.
        Returns:
        ConnectCustomConfiguration
      • getAllowSalesforcePublish

        public String getAllowSalesforcePublish()
        .
        Returns:
        allowSalesforcePublish
      • setAllowSalesforcePublish

        public void setAllowSalesforcePublish​(String allowSalesforcePublish)
        setAllowSalesforcePublish.
      • getAllUsers

        public String getAllUsers()
        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..
        Returns:
        allUsers
      • setAllUsers

        public void setAllUsers​(String allUsers)
        setAllUsers.
      • getAllUsersExcept

        public String getAllUsersExcept()
        .
        Returns:
        allUsersExcept
      • setAllUsersExcept

        public void setAllUsersExcept​(String allUsersExcept)
        setAllUsersExcept.
      • getConfigurationType

        public String getConfigurationType()
        If merge field's are being used, specifies the type of the merge field. The only supported value is **salesforce**..
        Returns:
        configurationType
      • setConfigurationType

        public void setConfigurationType​(String configurationType)
        setConfigurationType.
      • getConnectId

        public String getConnectId()
        Specifies the DocuSign generated ID for the Connect configuration. .
        Returns:
        connectId
      • setConnectId

        public void setConnectId​(String connectId)
        setConnectId.
      • getDeliveryMode

        public String getDeliveryMode()
        .
        Returns:
        deliveryMode
      • setDeliveryMode

        public void setDeliveryMode​(String deliveryMode)
        setDeliveryMode.
      • getDisabledBy

        public String getDisabledBy()
        .
        Returns:
        disabledBy
      • setDisabledBy

        public void setDisabledBy​(String disabledBy)
        setDisabledBy.
      • getEnableLog

        public String getEnableLog()
        This turns Connect logging on or off. When set to **true**, logging is turned on..
        Returns:
        enableLog
      • setEnableLog

        public void setEnableLog​(String enableLog)
        setEnableLog.
      • addEnvelopeEventsItem

        public ConnectCustomConfiguration addEnvelopeEventsItem​(String envelopeEventsItem)
        addEnvelopeEventsItem.
        Returns:
        ConnectCustomConfiguration
      • getEnvelopeEvents

        public List<String> getEnvelopeEvents()
        A comma separated list of �Envelope� related events that are tracked through Connect. The possible event values are: Sent, Delivered, Completed, Declined, and Voided..
        Returns:
        envelopeEvents
      • setEnvelopeEvents

        public void setEnvelopeEvents​(List<String> envelopeEvents)
        setEnvelopeEvents.
      • getEventData

        public ConnectEventData getEventData()
        Allows you to specify the format of the information the Connect webhooks returns. For more information, see [Connect webhooks with JSON notifications](https://www.docusign.com/blog/developers/connect-webhooks-json-notifications).
        Returns:
        eventData
      • setEventData

        public void setEventData​(ConnectEventData eventData)
        setEventData.
      • getEvents

        public List<String> getEvents()
        .
        Returns:
        events
      • setEvents

        public void setEvents​(List<String> events)
        setEvents.
      • getExternalFolderId

        public String getExternalFolderId()
        .
        Returns:
        externalFolderId
      • setExternalFolderId

        public void setExternalFolderId​(String externalFolderId)
        setExternalFolderId.
      • externalFolderLabel

        public ConnectCustomConfiguration externalFolderLabel​(String externalFolderLabel)
        externalFolderLabel.
        Returns:
        ConnectCustomConfiguration
      • getExternalFolderLabel

        public String getExternalFolderLabel()
        .
        Returns:
        externalFolderLabel
      • setExternalFolderLabel

        public void setExternalFolderLabel​(String externalFolderLabel)
        setExternalFolderLabel.
      • getGroupIds

        public List<String> getGroupIds()
        .
        Returns:
        groupIds
      • setGroupIds

        public void setGroupIds​(List<String> groupIds)
        setGroupIds.
      • includeCertificateOfCompletion

        public ConnectCustomConfiguration includeCertificateOfCompletion​(String includeCertificateOfCompletion)
        includeCertificateOfCompletion.
        Returns:
        ConnectCustomConfiguration
      • getIncludeCertificateOfCompletion

        public String getIncludeCertificateOfCompletion()
        When set to **true**, the Connect Service includes the Certificate of Completion with completed envelopes. .
        Returns:
        includeCertificateOfCompletion
      • setIncludeCertificateOfCompletion

        public void setIncludeCertificateOfCompletion​(String includeCertificateOfCompletion)
        setIncludeCertificateOfCompletion.
      • includeCertSoapHeader

        public ConnectCustomConfiguration includeCertSoapHeader​(String includeCertSoapHeader)
        includeCertSoapHeader.
        Returns:
        ConnectCustomConfiguration
      • getIncludeCertSoapHeader

        public String getIncludeCertSoapHeader()
        .
        Returns:
        includeCertSoapHeader
      • setIncludeCertSoapHeader

        public void setIncludeCertSoapHeader​(String includeCertSoapHeader)
        setIncludeCertSoapHeader.
      • includeDocumentFields

        public ConnectCustomConfiguration includeDocumentFields​(String includeDocumentFields)
        includeDocumentFields.
        Returns:
        ConnectCustomConfiguration
      • getIncludeDocumentFields

        public String getIncludeDocumentFields()
        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. .
        Returns:
        includeDocumentFields
      • setIncludeDocumentFields

        public void setIncludeDocumentFields​(String includeDocumentFields)
        setIncludeDocumentFields.
      • getIncludeDocuments

        public String getIncludeDocuments()
        When set to **true**, Connect will send the PDF document along with the update XML..
        Returns:
        includeDocuments
      • setIncludeDocuments

        public void setIncludeDocuments​(String includeDocuments)
        setIncludeDocuments.
      • includeEnvelopeVoidReason

        public ConnectCustomConfiguration includeEnvelopeVoidReason​(String includeEnvelopeVoidReason)
        includeEnvelopeVoidReason.
        Returns:
        ConnectCustomConfiguration
      • getIncludeEnvelopeVoidReason

        public String getIncludeEnvelopeVoidReason()
        When set to **true**, Connect will include the voidedReason for voided envelopes..
        Returns:
        includeEnvelopeVoidReason
      • setIncludeEnvelopeVoidReason

        public void setIncludeEnvelopeVoidReason​(String includeEnvelopeVoidReason)
        setIncludeEnvelopeVoidReason.
      • getIncludeHMAC

        public String getIncludeHMAC()
        .
        Returns:
        includeHMAC
      • setIncludeHMAC

        public void setIncludeHMAC​(String includeHMAC)
        setIncludeHMAC.
      • includeSenderAccountasCustomField

        public ConnectCustomConfiguration includeSenderAccountasCustomField​(String includeSenderAccountasCustomField)
        includeSenderAccountasCustomField.
        Returns:
        ConnectCustomConfiguration
      • getIncludeSenderAccountasCustomField

        public String getIncludeSenderAccountasCustomField()
        When set to **true**, Connect will include the sender account as Custom Field in the data..
        Returns:
        includeSenderAccountasCustomField
      • setIncludeSenderAccountasCustomField

        public void setIncludeSenderAccountasCustomField​(String includeSenderAccountasCustomField)
        setIncludeSenderAccountasCustomField.
      • includeTimeZoneInformation

        public ConnectCustomConfiguration includeTimeZoneInformation​(String includeTimeZoneInformation)
        includeTimeZoneInformation.
        Returns:
        ConnectCustomConfiguration
      • getIncludeTimeZoneInformation

        public String getIncludeTimeZoneInformation()
        When set to **true**, Connect will include the envelope time zone information..
        Returns:
        includeTimeZoneInformation
      • setIncludeTimeZoneInformation

        public void setIncludeTimeZoneInformation​(String includeTimeZoneInformation)
        setIncludeTimeZoneInformation.
      • getName

        public String getName()
        The name of the Connect configuration. The name helps identify the configuration in the list..
        Returns:
        name
      • setName

        public void setName​(String name)
        setName.
      • getPassword

        public String getPassword()
        .
        Returns:
        password
      • setPassword

        public void setPassword​(String password)
        setPassword.
      • addRecipientEventsItem

        public ConnectCustomConfiguration addRecipientEventsItem​(String recipientEventsItem)
        addRecipientEventsItem.
        Returns:
        ConnectCustomConfiguration
      • getRecipientEvents

        public List<String> getRecipientEvents()
        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..
        Returns:
        recipientEvents
      • setRecipientEvents

        public void setRecipientEvents​(List<String> recipientEvents)
        setRecipientEvents.
      • getRequireMutualTls

        public String getRequireMutualTls()
        .
        Returns:
        requireMutualTls
      • setRequireMutualTls

        public void setRequireMutualTls​(String requireMutualTls)
        setRequireMutualTls.
      • requiresAcknowledgement

        public ConnectCustomConfiguration requiresAcknowledgement​(String requiresAcknowledgement)
        requiresAcknowledgement.
        Returns:
        ConnectCustomConfiguration
      • getRequiresAcknowledgement

        public String getRequiresAcknowledgement()
        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..
        Returns:
        requiresAcknowledgement
      • setRequiresAcknowledgement

        public void setRequiresAcknowledgement​(String requiresAcknowledgement)
        setRequiresAcknowledgement.
      • salesforceApiVersion

        public ConnectCustomConfiguration salesforceApiVersion​(String salesforceApiVersion)
        salesforceApiVersion.
        Returns:
        ConnectCustomConfiguration
      • getSalesforceApiVersion

        public String getSalesforceApiVersion()
        .
        Returns:
        salesforceApiVersion
      • setSalesforceApiVersion

        public void setSalesforceApiVersion​(String salesforceApiVersion)
        setSalesforceApiVersion.
      • salesforceAuthcode

        public ConnectCustomConfiguration salesforceAuthcode​(String salesforceAuthcode)
        salesforceAuthcode.
        Returns:
        ConnectCustomConfiguration
      • getSalesforceAuthcode

        public String getSalesforceAuthcode()
        .
        Returns:
        salesforceAuthcode
      • setSalesforceAuthcode

        public void setSalesforceAuthcode​(String salesforceAuthcode)
        setSalesforceAuthcode.
      • salesforceCallBackUrl

        public ConnectCustomConfiguration salesforceCallBackUrl​(String salesforceCallBackUrl)
        salesforceCallBackUrl.
        Returns:
        ConnectCustomConfiguration
      • getSalesforceCallBackUrl

        public String getSalesforceCallBackUrl()
        .
        Returns:
        salesforceCallBackUrl
      • setSalesforceCallBackUrl

        public void setSalesforceCallBackUrl​(String salesforceCallBackUrl)
        setSalesforceCallBackUrl.
      • salesforceDocumentsAsContentFiles

        public ConnectCustomConfiguration salesforceDocumentsAsContentFiles​(String salesforceDocumentsAsContentFiles)
        salesforceDocumentsAsContentFiles.
        Returns:
        ConnectCustomConfiguration
      • getSalesforceDocumentsAsContentFiles

        public String getSalesforceDocumentsAsContentFiles()
        .
        Returns:
        salesforceDocumentsAsContentFiles
      • setSalesforceDocumentsAsContentFiles

        public void setSalesforceDocumentsAsContentFiles​(String salesforceDocumentsAsContentFiles)
        setSalesforceDocumentsAsContentFiles.
      • getSenderOverride

        public String getSenderOverride()
        .
        Returns:
        senderOverride
      • setSenderOverride

        public void setSenderOverride​(String senderOverride)
        setSenderOverride.
      • senderSelectableItems

        public ConnectCustomConfiguration senderSelectableItems​(List<String> senderSelectableItems)
        senderSelectableItems.
        Returns:
        ConnectCustomConfiguration
      • addSenderSelectableItemsItem

        public ConnectCustomConfiguration addSenderSelectableItemsItem​(String senderSelectableItemsItem)
        addSenderSelectableItemsItem.
        Returns:
        ConnectCustomConfiguration
      • getSenderSelectableItems

        public List<String> getSenderSelectableItems()
        .
        Returns:
        senderSelectableItems
      • setSenderSelectableItems

        public void setSenderSelectableItems​(List<String> senderSelectableItems)
        setSenderSelectableItems.
      • signMessageWithX509Certificate

        public ConnectCustomConfiguration signMessageWithX509Certificate​(String signMessageWithX509Certificate)
        signMessageWithX509Certificate.
        Returns:
        ConnectCustomConfiguration
      • getSignMessageWithX509Certificate

        public String getSignMessageWithX509Certificate()
        When set to **true**, Connect messages are signed with an X509 certificate. This provides support for 2-way SSL..
        Returns:
        signMessageWithX509Certificate
      • setSignMessageWithX509Certificate

        public void setSignMessageWithX509Certificate​(String signMessageWithX509Certificate)
        setSignMessageWithX509Certificate.
      • getSoapNamespace

        public String getSoapNamespace()
        The namespace of the SOAP interface. The namespace value must be set if useSoapInterface is set to true..
        Returns:
        soapNamespace
      • setSoapNamespace

        public void setSoapNamespace​(String soapNamespace)
        setSoapNamespace.
      • getUrlToPublishTo

        public String getUrlToPublishTo()
        This is the web address and name of your listener or Retrieving Service endpoint. You need to include HTTPS:// in the web address..
        Returns:
        urlToPublishTo
      • setUrlToPublishTo

        public void setUrlToPublishTo​(String urlToPublishTo)
        setUrlToPublishTo.
      • getUserIds

        public List<String> getUserIds()
        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..
        Returns:
        userIds
      • setUserIds

        public void setUserIds​(List<String> userIds)
        setUserIds.
      • getUserName

        public String getUserName()
        .
        Returns:
        userName
      • setUserName

        public void setUserName​(String userName)
        setUserName.
      • getUseSoapInterface

        public String getUseSoapInterface()
        When set to **true**, indicates that the `urlToPublishTo` property contains a SOAP endpoint..
        Returns:
        useSoapInterface
      • setUseSoapInterface

        public void setUseSoapInterface​(String useSoapInterface)
        setUseSoapInterface.
      • equals

        public boolean equals​(Object o)
        Compares objects.
        Overrides:
        equals in class Object
        Returns:
        true or false depending on comparison result.
      • hashCode

        public int hashCode()
        Returns the HashCode.
        Overrides:
        hashCode in class Object
      • toString

        public String toString()
        Converts the given object to string.
        Overrides:
        toString in class Object