Package com.docusign.esign.model

Class ConnectCustomConfiguration

  • public class ConnectCustomConfiguration
extends java.lang.Object
    ConnectCustomConfiguration.

    • Constructor Detail

      • ConnectCustomConfiguration

        public ConnectCustomConfiguration()

    • Method Detail

      • allowEnvelopePublish

        public ConnectCustomConfiguration allowEnvelopePublish​(java.lang.String allowEnvelopePublish)
        allowEnvelopePublish.
        Returns:
        ConnectCustomConfiguration

      • getAllowEnvelopePublish

        public java.lang.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​(java.lang.String allowEnvelopePublish)
        setAllowEnvelopePublish.

      • allowSalesforcePublish

        public ConnectCustomConfiguration allowSalesforcePublish​(java.lang.String allowSalesforcePublish)
        allowSalesforcePublish.
        Returns:
        ConnectCustomConfiguration

      • getAllowSalesforcePublish

        public java.lang.String getAllowSalesforcePublish()
        .
        Returns:
        allowSalesforcePublish

      • setAllowSalesforcePublish

        public void setAllowSalesforcePublish​(java.lang.String allowSalesforcePublish)
        setAllowSalesforcePublish.

      • allUsers

        public ConnectCustomConfiguration allUsers​(java.lang.String allUsers)
        allUsers.
        Returns:
        ConnectCustomConfiguration

      • getAllUsers

        public java.lang.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​(java.lang.String allUsers)
        setAllUsers.

      • configurationType

        public ConnectCustomConfiguration configurationType​(java.lang.String configurationType)
        configurationType.
        Returns:
        ConnectCustomConfiguration

      • getConfigurationType

        public java.lang.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​(java.lang.String configurationType)
        setConfigurationType.

      • connectId

        public ConnectCustomConfiguration connectId​(java.lang.String connectId)
        connectId.
        Returns:
        ConnectCustomConfiguration

      • getConnectId

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

      • setConnectId

        public void setConnectId​(java.lang.String connectId)
        setConnectId.

      • deliveryMode

        public ConnectCustomConfiguration deliveryMode​(java.lang.String deliveryMode)
        deliveryMode.
        Returns:
        ConnectCustomConfiguration

      • getDeliveryMode

        public java.lang.String getDeliveryMode()
        .
        Returns:
        deliveryMode

      • setDeliveryMode

        public void setDeliveryMode​(java.lang.String deliveryMode)
        setDeliveryMode.

      • enableLog

        public ConnectCustomConfiguration enableLog​(java.lang.String enableLog)
        enableLog.
        Returns:
        ConnectCustomConfiguration

      • getEnableLog

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

      • setEnableLog

        public void setEnableLog​(java.lang.String enableLog)
        setEnableLog.

      • envelopeEvents

        public ConnectCustomConfiguration envelopeEvents​(java.util.List<java.lang.String> envelopeEvents)
        envelopeEvents.
        Returns:
        ConnectCustomConfiguration

      • addEnvelopeEventsItem

        public ConnectCustomConfiguration addEnvelopeEventsItem​(java.lang.String envelopeEventsItem)
        addEnvelopeEventsItem.
        Returns:
        ConnectCustomConfiguration

      • getEnvelopeEvents

        public java.util.List<java.lang.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​(java.util.List<java.lang.String> envelopeEvents)
        setEnvelopeEvents.

      • getEventData

        public ConnectEventData getEventData()
        Get eventData.
        Returns:
        eventData

      • setEventData

        public void setEventData​(ConnectEventData eventData)
        setEventData.

      • events

        public ConnectCustomConfiguration events​(java.util.List<java.lang.String> events)
        events.
        Returns:
        ConnectCustomConfiguration

      • addEventsItem

        public ConnectCustomConfiguration addEventsItem​(java.lang.String eventsItem)
        addEventsItem.
        Returns:
        ConnectCustomConfiguration

      • getEvents

        public java.util.List<java.lang.String> getEvents()
        .
        Returns:
        events

      • setEvents

        public void setEvents​(java.util.List<java.lang.String> events)
        setEvents.

      • externalFolderId

        public ConnectCustomConfiguration externalFolderId​(java.lang.String externalFolderId)
        externalFolderId.
        Returns:
        ConnectCustomConfiguration

      • getExternalFolderId

        public java.lang.String getExternalFolderId()
        .
        Returns:
        externalFolderId

      • setExternalFolderId

        public void setExternalFolderId​(java.lang.String externalFolderId)
        setExternalFolderId.

      • externalFolderLabel

        public ConnectCustomConfiguration externalFolderLabel​(java.lang.String externalFolderLabel)
        externalFolderLabel.
        Returns:
        ConnectCustomConfiguration

      • getExternalFolderLabel

        public java.lang.String getExternalFolderLabel()
        .
        Returns:
        externalFolderLabel

      • setExternalFolderLabel

        public void setExternalFolderLabel​(java.lang.String externalFolderLabel)
        setExternalFolderLabel.

      • includeCertificateOfCompletion

        public ConnectCustomConfiguration includeCertificateOfCompletion​(java.lang.String includeCertificateOfCompletion)
        includeCertificateOfCompletion.
        Returns:
        ConnectCustomConfiguration

      • getIncludeCertificateOfCompletion

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

      • setIncludeCertificateOfCompletion

        public void setIncludeCertificateOfCompletion​(java.lang.String includeCertificateOfCompletion)
        setIncludeCertificateOfCompletion.

      • includeCertSoapHeader

        public ConnectCustomConfiguration includeCertSoapHeader​(java.lang.String includeCertSoapHeader)
        includeCertSoapHeader.
        Returns:
        ConnectCustomConfiguration

      • getIncludeCertSoapHeader

        public java.lang.String getIncludeCertSoapHeader()
        .
        Returns:
        includeCertSoapHeader

      • setIncludeCertSoapHeader

        public void setIncludeCertSoapHeader​(java.lang.String includeCertSoapHeader)
        setIncludeCertSoapHeader.

      • includeDocumentFields

        public ConnectCustomConfiguration includeDocumentFields​(java.lang.String includeDocumentFields)
        includeDocumentFields.
        Returns:
        ConnectCustomConfiguration

      • getIncludeDocumentFields

        public java.lang.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​(java.lang.String includeDocumentFields)
        setIncludeDocumentFields.

      • includeDocuments

        public ConnectCustomConfiguration includeDocuments​(java.lang.String includeDocuments)
        includeDocuments.
        Returns:
        ConnectCustomConfiguration

      • getIncludeDocuments

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

      • setIncludeDocuments

        public void setIncludeDocuments​(java.lang.String includeDocuments)
        setIncludeDocuments.

      • includeEnvelopeVoidReason

        public ConnectCustomConfiguration includeEnvelopeVoidReason​(java.lang.String includeEnvelopeVoidReason)
        includeEnvelopeVoidReason.
        Returns:
        ConnectCustomConfiguration

      • getIncludeEnvelopeVoidReason

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

      • setIncludeEnvelopeVoidReason

        public void setIncludeEnvelopeVoidReason​(java.lang.String includeEnvelopeVoidReason)
        setIncludeEnvelopeVoidReason.

      • includeHMAC

        public ConnectCustomConfiguration includeHMAC​(java.lang.String includeHMAC)
        includeHMAC.
        Returns:
        ConnectCustomConfiguration

      • getIncludeHMAC

        public java.lang.String getIncludeHMAC()
        .
        Returns:
        includeHMAC

      • setIncludeHMAC

        public void setIncludeHMAC​(java.lang.String includeHMAC)
        setIncludeHMAC.

      • includeSenderAccountasCustomField

        public ConnectCustomConfiguration includeSenderAccountasCustomField​(java.lang.String includeSenderAccountasCustomField)
        includeSenderAccountasCustomField.
        Returns:
        ConnectCustomConfiguration

      • getIncludeSenderAccountasCustomField

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

      • setIncludeSenderAccountasCustomField

        public void setIncludeSenderAccountasCustomField​(java.lang.String includeSenderAccountasCustomField)
        setIncludeSenderAccountasCustomField.

      • includeTimeZoneInformation

        public ConnectCustomConfiguration includeTimeZoneInformation​(java.lang.String includeTimeZoneInformation)
        includeTimeZoneInformation.
        Returns:
        ConnectCustomConfiguration

      • getIncludeTimeZoneInformation

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

      • setIncludeTimeZoneInformation

        public void setIncludeTimeZoneInformation​(java.lang.String includeTimeZoneInformation)
        setIncludeTimeZoneInformation.

      • getName

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

      • setName

        public void setName​(java.lang.String name)
        setName.

      • password

        public ConnectCustomConfiguration password​(java.lang.String password)
        password.
        Returns:
        ConnectCustomConfiguration

      • getPassword

        public java.lang.String getPassword()
        .
        Returns:
        password

      • setPassword

        public void setPassword​(java.lang.String password)
        setPassword.

      • recipientEvents

        public ConnectCustomConfiguration recipientEvents​(java.util.List<java.lang.String> recipientEvents)
        recipientEvents.
        Returns:
        ConnectCustomConfiguration

      • addRecipientEventsItem

        public ConnectCustomConfiguration addRecipientEventsItem​(java.lang.String recipientEventsItem)
        addRecipientEventsItem.
        Returns:
        ConnectCustomConfiguration

      • getRecipientEvents

        public java.util.List<java.lang.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​(java.util.List<java.lang.String> recipientEvents)
        setRecipientEvents.

      • requireMutualTls

        public ConnectCustomConfiguration requireMutualTls​(java.lang.String requireMutualTls)
        requireMutualTls.
        Returns:
        ConnectCustomConfiguration

      • getRequireMutualTls

        public java.lang.String getRequireMutualTls()
        .
        Returns:
        requireMutualTls

      • setRequireMutualTls

        public void setRequireMutualTls​(java.lang.String requireMutualTls)
        setRequireMutualTls.

      • requiresAcknowledgement

        public ConnectCustomConfiguration requiresAcknowledgement​(java.lang.String requiresAcknowledgement)
        requiresAcknowledgement.
        Returns:
        ConnectCustomConfiguration

      • getRequiresAcknowledgement

        public java.lang.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​(java.lang.String requiresAcknowledgement)
        setRequiresAcknowledgement.

      • salesforceApiVersion

        public ConnectCustomConfiguration salesforceApiVersion​(java.lang.String salesforceApiVersion)
        salesforceApiVersion.
        Returns:
        ConnectCustomConfiguration

      • getSalesforceApiVersion

        public java.lang.String getSalesforceApiVersion()
        .
        Returns:
        salesforceApiVersion

      • setSalesforceApiVersion

        public void setSalesforceApiVersion​(java.lang.String salesforceApiVersion)
        setSalesforceApiVersion.

      • salesforceAuthcode

        public ConnectCustomConfiguration salesforceAuthcode​(java.lang.String salesforceAuthcode)
        salesforceAuthcode.
        Returns:
        ConnectCustomConfiguration

      • getSalesforceAuthcode

        public java.lang.String getSalesforceAuthcode()
        .
        Returns:
        salesforceAuthcode

      • setSalesforceAuthcode

        public void setSalesforceAuthcode​(java.lang.String salesforceAuthcode)
        setSalesforceAuthcode.

      • salesforceCallBackUrl

        public ConnectCustomConfiguration salesforceCallBackUrl​(java.lang.String salesforceCallBackUrl)
        salesforceCallBackUrl.
        Returns:
        ConnectCustomConfiguration

      • getSalesforceCallBackUrl

        public java.lang.String getSalesforceCallBackUrl()
        .
        Returns:
        salesforceCallBackUrl

      • setSalesforceCallBackUrl

        public void setSalesforceCallBackUrl​(java.lang.String salesforceCallBackUrl)
        setSalesforceCallBackUrl.

      • salesforceDocumentsAsContentFiles

        public ConnectCustomConfiguration salesforceDocumentsAsContentFiles​(java.lang.String salesforceDocumentsAsContentFiles)
        salesforceDocumentsAsContentFiles.
        Returns:
        ConnectCustomConfiguration

      • getSalesforceDocumentsAsContentFiles

        public java.lang.String getSalesforceDocumentsAsContentFiles()
        .
        Returns:
        salesforceDocumentsAsContentFiles

      • setSalesforceDocumentsAsContentFiles

        public void setSalesforceDocumentsAsContentFiles​(java.lang.String salesforceDocumentsAsContentFiles)
        setSalesforceDocumentsAsContentFiles.

      • senderOverride

        public ConnectCustomConfiguration senderOverride​(java.lang.String senderOverride)
        senderOverride.
        Returns:
        ConnectCustomConfiguration

      • getSenderOverride

        public java.lang.String getSenderOverride()
        .
        Returns:
        senderOverride

      • setSenderOverride

        public void setSenderOverride​(java.lang.String senderOverride)
        setSenderOverride.

      • senderSelectableItems

        public ConnectCustomConfiguration senderSelectableItems​(java.util.List<java.lang.String> senderSelectableItems)
        senderSelectableItems.
        Returns:
        ConnectCustomConfiguration

      • addSenderSelectableItemsItem

        public ConnectCustomConfiguration addSenderSelectableItemsItem​(java.lang.String senderSelectableItemsItem)
        addSenderSelectableItemsItem.
        Returns:
        ConnectCustomConfiguration

      • getSenderSelectableItems

        public java.util.List<java.lang.String> getSenderSelectableItems()
        .
        Returns:
        senderSelectableItems

      • setSenderSelectableItems

        public void setSenderSelectableItems​(java.util.List<java.lang.String> senderSelectableItems)
        setSenderSelectableItems.

      • signMessageWithX509Certificate

        public ConnectCustomConfiguration signMessageWithX509Certificate​(java.lang.String signMessageWithX509Certificate)
        signMessageWithX509Certificate.
        Returns:
        ConnectCustomConfiguration

      • getSignMessageWithX509Certificate

        public java.lang.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​(java.lang.String signMessageWithX509Certificate)
        setSignMessageWithX509Certificate.

      • soapNamespace

        public ConnectCustomConfiguration soapNamespace​(java.lang.String soapNamespace)
        soapNamespace.
        Returns:
        ConnectCustomConfiguration

      • getSoapNamespace

        public java.lang.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​(java.lang.String soapNamespace)
        setSoapNamespace.

      • urlToPublishTo

        public ConnectCustomConfiguration urlToPublishTo​(java.lang.String urlToPublishTo)
        urlToPublishTo.
        Returns:
        ConnectCustomConfiguration

      • getUrlToPublishTo

        public java.lang.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​(java.lang.String urlToPublishTo)
        setUrlToPublishTo.

      • userIds

        public ConnectCustomConfiguration userIds​(java.util.List<java.lang.String> userIds)
        userIds.
        Returns:
        ConnectCustomConfiguration

      • addUserIdsItem

        public ConnectCustomConfiguration addUserIdsItem​(java.lang.String userIdsItem)
        addUserIdsItem.
        Returns:
        ConnectCustomConfiguration

      • getUserIds

        public java.util.List<java.lang.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​(java.util.List<java.lang.String> userIds)
        setUserIds.

      • userName

        public ConnectCustomConfiguration userName​(java.lang.String userName)
        userName.
        Returns:
        ConnectCustomConfiguration

      • getUserName

        public java.lang.String getUserName()
        .
        Returns:
        userName

      • setUserName

        public void setUserName​(java.lang.String userName)
        setUserName.

      • useSoapInterface

        public ConnectCustomConfiguration useSoapInterface​(java.lang.String useSoapInterface)
        useSoapInterface.
        Returns:
        ConnectCustomConfiguration

      • getUseSoapInterface

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

      • setUseSoapInterface

        public void setUseSoapInterface​(java.lang.String useSoapInterface)
        setUseSoapInterface.

      • equals

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

      • hashCode

        public int hashCode()
        Returns the HashCode.
        Overrides:
        hashCode in class java.lang.Object

      • toString

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