Package com.docusign.esign.api

Class TemplatesApi

  • public class TemplatesApi
extends Object
    TemplatesApi class.

    • Constructor Detail

      • TemplatesApi

        public TemplatesApi()
        TemplatesApi.

      • TemplatesApi

        public TemplatesApi​(ApiClient apiClient)
        TemplatesApi.

    • Method Detail

      • getApiClient

        public ApiClient getApiClient()
        getApiClient Method.
        Returns:
        ApiClient

      • setApiClient

        public void setApiClient​(ApiClient apiClient)
        setApiClient Method.

      • createCustomFields

        public CustomFields createCustomFields​(String accountId,
                                       String templateId,
                                       TemplateCustomFields templateCustomFields)
                                throws ApiException
        Creates custom document fields in an existing template document.. Creates custom document fields in an existing template document.
        Parameters:
        accountId - The external account number (int) or account ID Guid. (required)
        templateId - The ID of the template being accessed. (required)
        templateCustomFields - (optional)
        Returns:
        CustomFields
        Throws:
        ApiException - if fails to make API call

      • createCustomFieldsWithHttpInfo

        public ApiResponse<CustomFields> createCustomFieldsWithHttpInfo​(String accountId,
                                                                String templateId,
                                                                TemplateCustomFields templateCustomFields)
                                                         throws ApiException
        Creates custom document fields in an existing template document. Creates custom document fields in an existing template document.
        Parameters:
        accountId - The external account number (int) or account ID Guid. (required)
        templateId - The ID of the template being accessed. (required)
        templateCustomFields - (optional)
        Returns:
        CustomFields
        Throws:
        ApiException - if fails to make API call

      • createDocumentFields

        public DocumentFieldsInformation createDocumentFields​(String accountId,
                                                      String templateId,
                                                      String documentId,
                                                      DocumentFieldsInformation documentFieldsInformation)
                                               throws ApiException
        Creates custom document fields in an existing template document.. Creates custom document fields in an existing template document.
        Parameters:
        accountId - The external account number (int) or account ID Guid. (required)
        templateId - The ID of the template being accessed. (required)
        documentId - The ID of the document being accessed. (required)
        documentFieldsInformation - (optional)
        Returns:
        DocumentFieldsInformation
        Throws:
        ApiException - if fails to make API call

      • createDocumentFieldsWithHttpInfo

        public ApiResponse<DocumentFieldsInformation> createDocumentFieldsWithHttpInfo​(String accountId,
                                                                               String templateId,
                                                                               String documentId,
                                                                               DocumentFieldsInformation documentFieldsInformation)
                                                                        throws ApiException
        Creates custom document fields in an existing template document. Creates custom document fields in an existing template document.
        Parameters:
        accountId - The external account number (int) or account ID Guid. (required)
        templateId - The ID of the template being accessed. (required)
        documentId - The ID of the document being accessed. (required)
        documentFieldsInformation - (optional)
        Returns:
        DocumentFieldsInformation
        Throws:
        ApiException - if fails to make API call

      • createEditView

        public ViewUrl createEditView​(String accountId,
                              String templateId,
                              ReturnUrlRequest returnUrlRequest)
                       throws ApiException
        Provides a URL to start an edit view of the Template UI. This method returns a URL for starting an edit view of a template that uses the DocuSign Template UI.
        Parameters:
        accountId - The external account number (int) or account ID Guid. (required)
        templateId - The ID of the template being accessed. (required)
        returnUrlRequest - (optional)
        Returns:
        ViewUrl
        Throws:
        ApiException - if fails to make API call

      • createEditViewWithHttpInfo

        public ApiResponse<ViewUrl> createEditViewWithHttpInfo​(String accountId,
                                                       String templateId,
                                                       ReturnUrlRequest returnUrlRequest)
                                                throws ApiException
        Provides a URL to start an edit view of the Template UI This method returns a URL for starting an edit view of a template that uses the DocuSign Template UI.
        Parameters:
        accountId - The external account number (int) or account ID Guid. (required)
        templateId - The ID of the template being accessed. (required)
        returnUrlRequest - (optional)
        Returns:
        ViewUrl
        Throws:
        ApiException - if fails to make API call

      • createLock

        public LockInformation createLock​(String accountId,
                                  String templateId,
                                  LockRequest lockRequest)
                           throws ApiException
        Lock a template.. Locks the specified template, and sets the time until the lock expires, to prevent other users or recipients from accessing and changing the template. ###### Note: Users must have envelope locking capability enabled to use this function (the userSetting property `canLockEnvelopes` must be set to **true** for the user).
        Parameters:
        accountId - The external account number (int) or account ID Guid. (required)
        templateId - The ID of the template being accessed. (required)
        lockRequest - (optional)
        Returns:
        LockInformation
        Throws:
        ApiException - if fails to make API call

      • createLockWithHttpInfo

        public ApiResponse<LockInformation> createLockWithHttpInfo​(String accountId,
                                                           String templateId,
                                                           LockRequest lockRequest)
                                                    throws ApiException
        Lock a template. Locks the specified template, and sets the time until the lock expires, to prevent other users or recipients from accessing and changing the template. ###### Note: Users must have envelope locking capability enabled to use this function (the userSetting property `canLockEnvelopes` must be set to **true** for the user).
        Parameters:
        accountId - The external account number (int) or account ID Guid. (required)
        templateId - The ID of the template being accessed. (required)
        lockRequest - (optional)
        Returns:
        LockInformation
        Throws:
        ApiException - if fails to make API call

      • createRecipients

        public Recipients createRecipients​(String accountId,
                                   String templateId,
                                   TemplateRecipients templateRecipients)
                            throws ApiException
        Adds tabs for a recipient.. Adds one or more recipients to a template.
        Parameters:
        accountId - The external account number (int) or account ID Guid. (required)
        templateId - The ID of the template being accessed. (required)
        templateRecipients - (optional)
        Returns:
        Recipients
        Throws:
        ApiException

      • createRecipients

        public Recipients createRecipients​(String accountId,
                                   String templateId,
                                   TemplateRecipients templateRecipients,
                                   TemplatesApi.CreateRecipientsOptions options)
                            throws ApiException
        Adds tabs for a recipient.. Adds one or more recipients to a template.
        Parameters:
        accountId - The external account number (int) or account ID Guid. (required)
        templateId - The ID of the template being accessed. (required)
        templateRecipients - (optional)
        options - for modifying the method behavior.
        Returns:
        Recipients
        Throws:
        ApiException - if fails to make API call

      • createRecipientsWithHttpInfo

        public ApiResponse<Recipients> createRecipientsWithHttpInfo​(String accountId,
                                                            String templateId,
                                                            TemplateRecipients templateRecipients,
                                                            TemplatesApi.CreateRecipientsOptions options)
                                                     throws ApiException
        Adds tabs for a recipient. Adds one or more recipients to a template.
        Parameters:
        accountId - The external account number (int) or account ID Guid. (required)
        templateId - The ID of the template being accessed. (required)
        templateRecipients - (optional)
        options - for modifying the method behavior.
        Returns:
        Recipients
        Throws:
        ApiException - if fails to make API call

      • createTabs

        public Tabs createTabs​(String accountId,
                       String templateId,
                       String recipientId,
                       TemplateTabs templateTabs)
                throws ApiException
        Adds tabs for a recipient.. Adds one or more tabs for a recipient.
        Parameters:
        accountId - The external account number (int) or account ID Guid. (required)
        templateId - The ID of the template being accessed. (required)
        recipientId - The ID of the recipient being accessed. (required)
        templateTabs - (optional)
        Returns:
        Tabs
        Throws:
        ApiException - if fails to make API call

      • createTabsWithHttpInfo

        public ApiResponse<Tabs> createTabsWithHttpInfo​(String accountId,
                                                String templateId,
                                                String recipientId,
                                                TemplateTabs templateTabs)
                                         throws ApiException
        Adds tabs for a recipient. Adds one or more tabs for a recipient.
        Parameters:
        accountId - The external account number (int) or account ID Guid. (required)
        templateId - The ID of the template being accessed. (required)
        recipientId - The ID of the recipient being accessed. (required)
        templateTabs - (optional)
        Returns:
        Tabs
        Throws:
        ApiException - if fails to make API call

      • createTemplate

        public TemplateSummary createTemplate​(String accountId,
                                      EnvelopeTemplate envelopeTemplate)
                               throws ApiException
        Creates an envelope from a template.. Creates a template definition using a multipart request. ###Template Email Subject Merge Fields Call this endpoint to insert a recipient name and email address merge fields into the email subject line when creating or sending from a template. The merge fields, based on the recipient's role name, are added to the `emailSubject` property when the template is created or when the template is used to create an envelope. After a template sender adds the name and email information for the recipient and sends the envelope, the recipient information is automatically merged into the appropriate fields in the email subject line. Both the sender and the recipients will see the information in the email subject line for any emails associated with the template. This provides an easy way for senders to organize their envelope emails without having to open an envelope to check the recipient. ###### Note: If merging the recipient information into the subject line causes the subject line to exceed 100 characters, then any characters over the 100 character limit are not included in the subject line. For cases where the recipient name or email is expected to be long, you should consider placing the merge field at the start of the email subject. To add a recipient's name in the subject line add the following text in the `emailSubject` property when creating the template or when sending an envelope from a template: [[<roleName>_UserName]] Example: `\"emailSubject\":\"[[Signer 1_UserName]], Please sign this NDA\",` To add a recipient's email address in the subject line add the following text in the `emailSubject` property when creating the template or when sending an envelope from a template: [[<roleName>_Email]] Example: `\"emailSubject\":\"[[Signer 1_Email]], Please sign this NDA\",` In both cases the <roleName> is the recipient's contents of the `roleName` property in the template. For cases where another recipient (such as an Agent, Editor, or Intermediary recipient) is entering the name and email information for the recipient included in the email subject, then [[<roleName>_UserName]] or [[<roleName>_Email]] is shown in the email subject.
        Parameters:
        accountId - The external account number (int) or account ID Guid. (required)
        envelopeTemplate - (optional)
        Returns:
        TemplateSummary
        Throws:
        ApiException - if fails to make API call

      • createTemplateWithHttpInfo

        public ApiResponse<TemplateSummary> createTemplateWithHttpInfo​(String accountId,
                                                               EnvelopeTemplate envelopeTemplate)
                                                        throws ApiException
        Creates an envelope from a template. Creates a template definition using a multipart request. ###Template Email Subject Merge Fields Call this endpoint to insert a recipient name and email address merge fields into the email subject line when creating or sending from a template. The merge fields, based on the recipient's role name, are added to the `emailSubject` property when the template is created or when the template is used to create an envelope. After a template sender adds the name and email information for the recipient and sends the envelope, the recipient information is automatically merged into the appropriate fields in the email subject line. Both the sender and the recipients will see the information in the email subject line for any emails associated with the template. This provides an easy way for senders to organize their envelope emails without having to open an envelope to check the recipient. ###### Note: If merging the recipient information into the subject line causes the subject line to exceed 100 characters, then any characters over the 100 character limit are not included in the subject line. For cases where the recipient name or email is expected to be long, you should consider placing the merge field at the start of the email subject. To add a recipient's name in the subject line add the following text in the `emailSubject` property when creating the template or when sending an envelope from a template: [[<roleName>_UserName]] Example: `\"emailSubject\":\"[[Signer 1_UserName]], Please sign this NDA\",` To add a recipient's email address in the subject line add the following text in the `emailSubject` property when creating the template or when sending an envelope from a template: [[<roleName>_Email]] Example: `\"emailSubject\":\"[[Signer 1_Email]], Please sign this NDA\",` In both cases the <roleName> is the recipient's contents of the `roleName` property in the template. For cases where another recipient (such as an Agent, Editor, or Intermediary recipient) is entering the name and email information for the recipient included in the email subject, then [[<roleName>_UserName]] or [[<roleName>_Email]] is shown in the email subject.
        Parameters:
        accountId - The external account number (int) or account ID Guid. (required)
        envelopeTemplate - (optional)
        Returns:
        TemplateSummary
        Throws:
        ApiException - if fails to make API call

      • createTemplateDocumentResponsiveHtmlPreview

        public DocumentHtmlDefinitions createTemplateDocumentResponsiveHtmlPreview​(String accountId,
                                                                           String templateId,
                                                                           String documentId,
                                                                           DocumentHtmlDefinition documentHtmlDefinition)
                                                                    throws ApiException
        Post Responsive HTML Preview for a document in a template.. Creates a preview of the [responsive](/docs/esign-rest-api/esign101/concepts/responsive/), HTML version of a specific template document. This method enables you to preview a PDF document conversion to responsive HTML across device types prior to sending. The request body is a `documentHtmlDefinition` object, which holds the responsive signing parameters that define how to generate the HTML version of the signing document.
        Parameters:
        accountId - The external account number (int) or account ID Guid. (required)
        templateId - The ID of the template being accessed. (required)
        documentId - The ID of the document being accessed. (required)
        documentHtmlDefinition - (optional)
        Returns:
        DocumentHtmlDefinitions
        Throws:
        ApiException - if fails to make API call

      • createTemplateDocumentResponsiveHtmlPreviewWithHttpInfo

        public ApiResponse<DocumentHtmlDefinitions> createTemplateDocumentResponsiveHtmlPreviewWithHttpInfo​(String accountId,
                                                                                                    String templateId,
                                                                                                    String documentId,
                                                                                                    DocumentHtmlDefinition documentHtmlDefinition)
                                                                                             throws ApiException
        Post Responsive HTML Preview for a document in a template. Creates a preview of the [responsive](/docs/esign-rest-api/esign101/concepts/responsive/), HTML version of a specific template document. This method enables you to preview a PDF document conversion to responsive HTML across device types prior to sending. The request body is a `documentHtmlDefinition` object, which holds the responsive signing parameters that define how to generate the HTML version of the signing document.
        Parameters:
        accountId - The external account number (int) or account ID Guid. (required)
        templateId - The ID of the template being accessed. (required)
        documentId - The ID of the document being accessed. (required)
        documentHtmlDefinition - (optional)
        Returns:
        DocumentHtmlDefinitions
        Throws:
        ApiException - if fails to make API call

      • createTemplateDocumentTabs

        public Tabs createTemplateDocumentTabs​(String accountId,
                                       String templateId,
                                       String documentId,
                                       TemplateTabs templateTabs)
                                throws ApiException
        Adds the tabs to a tempate. Adds tabs to the document specified by `documentId` in the template specified by `templateId`. In the request body, you only need to specify the tabs that your are adding. For example, to add a text [prefill tab](/docs/esign-rest-api/reference/templates/templatedocumenttabs/create/#definition__templatetabs_prefilltabs), your request body might look like this: ``` { \"prefillTabs\": { \"textTabs\": [ { \"value\": \"a prefill text tab\", \"pageNumber\": \"1\", \"documentId\": \"1\", \"xPosition\": 316, \"yPosition\": 97 } ] } } ```
        Parameters:
        accountId - The external account number (int) or account ID Guid. (required)
        templateId - The ID of the template being accessed. (required)
        documentId - The ID of the document being accessed. (required)
        templateTabs - (optional)
        Returns:
        Tabs
        Throws:
        ApiException - if fails to make API call

      • createTemplateDocumentTabsWithHttpInfo

        public ApiResponse<Tabs> createTemplateDocumentTabsWithHttpInfo​(String accountId,
                                                                String templateId,
                                                                String documentId,
                                                                TemplateTabs templateTabs)
                                                         throws ApiException
        Adds the tabs to a tempate Adds tabs to the document specified by `documentId` in the template specified by `templateId`. In the request body, you only need to specify the tabs that your are adding. For example, to add a text [prefill tab](/docs/esign-rest-api/reference/templates/templatedocumenttabs/create/#definition__templatetabs_prefilltabs), your request body might look like this: ``` { \"prefillTabs\": { \"textTabs\": [ { \"value\": \"a prefill text tab\", \"pageNumber\": \"1\", \"documentId\": \"1\", \"xPosition\": 316, \"yPosition\": 97 } ] } } ```
        Parameters:
        accountId - The external account number (int) or account ID Guid. (required)
        templateId - The ID of the template being accessed. (required)
        documentId - The ID of the document being accessed. (required)
        templateTabs - (optional)
        Returns:
        Tabs
        Throws:
        ApiException - if fails to make API call

      • createTemplateRecipientPreview

        public ViewUrl createTemplateRecipientPreview​(String accountId,
                                              String templateId,
                                              RecipientPreviewRequest recipientPreviewRequest)
                                       throws ApiException
        Provides a URL to start a recipient view of the Envelope UI. This method returns a URL for a template recipient preview in the DocuSign UI that you can embed in your application. You use this method to enable the sender to preview the recipients' experience. For more information, see [Preview and Send](https://support.docusign.com/en/guides/ndse-user-guide-send-your-documents).
        Parameters:
        accountId - The external account number (int) or account ID Guid. (required)
        templateId - The ID of the template being accessed. (required)
        recipientPreviewRequest - (optional)
        Returns:
        ViewUrl
        Throws:
        ApiException - if fails to make API call

      • createTemplateRecipientPreviewWithHttpInfo

        public ApiResponse<ViewUrl> createTemplateRecipientPreviewWithHttpInfo​(String accountId,
                                                                       String templateId,
                                                                       RecipientPreviewRequest recipientPreviewRequest)
                                                                throws ApiException
        Provides a URL to start a recipient view of the Envelope UI This method returns a URL for a template recipient preview in the DocuSign UI that you can embed in your application. You use this method to enable the sender to preview the recipients' experience. For more information, see [Preview and Send](https://support.docusign.com/en/guides/ndse-user-guide-send-your-documents).
        Parameters:
        accountId - The external account number (int) or account ID Guid. (required)
        templateId - The ID of the template being accessed. (required)
        recipientPreviewRequest - (optional)
        Returns:
        ViewUrl
        Throws:
        ApiException - if fails to make API call

      • createTemplateResponsiveHtmlPreview

        public DocumentHtmlDefinitions createTemplateResponsiveHtmlPreview​(String accountId,
                                                                   String templateId,
                                                                   DocumentHtmlDefinition documentHtmlDefinition)
                                                            throws ApiException
        Get Responsive HTML Preview for all documents in a template.. Creates a preview of the [responsive](/docs/esign-rest-api/esign101/concepts/responsive/), HTML versions of all of the documents associated with a template. This method enables you to preview the PDF document conversions to responsive HTML across device types prior to sending. The request body is a `documentHtmlDefinition` object, which holds the responsive signing parameters that define how to generate the HTML version of the documents.
        Parameters:
        accountId - The external account number (int) or account ID Guid. (required)
        templateId - The ID of the template being accessed. (required)
        documentHtmlDefinition - (optional)
        Returns:
        DocumentHtmlDefinitions
        Throws:
        ApiException - if fails to make API call

      • createTemplateResponsiveHtmlPreviewWithHttpInfo

        public ApiResponse<DocumentHtmlDefinitions> createTemplateResponsiveHtmlPreviewWithHttpInfo​(String accountId,
                                                                                            String templateId,
                                                                                            DocumentHtmlDefinition documentHtmlDefinition)
                                                                                     throws ApiException
        Get Responsive HTML Preview for all documents in a template. Creates a preview of the [responsive](/docs/esign-rest-api/esign101/concepts/responsive/), HTML versions of all of the documents associated with a template. This method enables you to preview the PDF document conversions to responsive HTML across device types prior to sending. The request body is a `documentHtmlDefinition` object, which holds the responsive signing parameters that define how to generate the HTML version of the documents.
        Parameters:
        accountId - The external account number (int) or account ID Guid. (required)
        templateId - The ID of the template being accessed. (required)
        documentHtmlDefinition - (optional)
        Returns:
        DocumentHtmlDefinitions
        Throws:
        ApiException - if fails to make API call

      • deleteBulkRecipients

        public BulkRecipientsUpdateResponse deleteBulkRecipients​(String accountId,
                                                         String templateId,
                                                         String recipientId)
                                                  throws ApiException
        Deletes the bulk recipient list on a template.. Deletes the bulk recipient list on a template.
        Parameters:
        accountId - The external account number (int) or account ID Guid. (required)
        templateId - The ID of the template being accessed. (required)
        recipientId - The ID of the recipient being accessed. (required)
        Returns:
        BulkRecipientsUpdateResponse
        Throws:
        ApiException - if fails to make API call

      • deleteBulkRecipientsWithHttpInfo

        public ApiResponse<BulkRecipientsUpdateResponse> deleteBulkRecipientsWithHttpInfo​(String accountId,
                                                                                  String templateId,
                                                                                  String recipientId)
                                                                           throws ApiException
        Deletes the bulk recipient list on a template. Deletes the bulk recipient list on a template.
        Parameters:
        accountId - The external account number (int) or account ID Guid. (required)
        templateId - The ID of the template being accessed. (required)
        recipientId - The ID of the recipient being accessed. (required)
        Returns:
        BulkRecipientsUpdateResponse
        Throws:
        ApiException - if fails to make API call

      • deleteCustomFields

        public CustomFields deleteCustomFields​(String accountId,
                                       String templateId,
                                       TemplateCustomFields templateCustomFields)
                                throws ApiException
        Deletes envelope custom fields in a template.. Deletes envelope custom fields in a template.
        Parameters:
        accountId - The external account number (int) or account ID Guid. (required)
        templateId - The ID of the template being accessed. (required)
        templateCustomFields - (optional)
        Returns:
        CustomFields
        Throws:
        ApiException - if fails to make API call

      • deleteCustomFieldsWithHttpInfo

        public ApiResponse<CustomFields> deleteCustomFieldsWithHttpInfo​(String accountId,
                                                                String templateId,
                                                                TemplateCustomFields templateCustomFields)
                                                         throws ApiException
        Deletes envelope custom fields in a template. Deletes envelope custom fields in a template.
        Parameters:
        accountId - The external account number (int) or account ID Guid. (required)
        templateId - The ID of the template being accessed. (required)
        templateCustomFields - (optional)
        Returns:
        CustomFields
        Throws:
        ApiException - if fails to make API call

      • deleteDocumentFields

        public DocumentFieldsInformation deleteDocumentFields​(String accountId,
                                                      String templateId,
                                                      String documentId,
                                                      DocumentFieldsInformation documentFieldsInformation)
                                               throws ApiException
        Deletes custom document fields from an existing template document.. Deletes custom document fields from an existing template document.
        Parameters:
        accountId - The external account number (int) or account ID Guid. (required)
        templateId - The ID of the template being accessed. (required)
        documentId - The ID of the document being accessed. (required)
        documentFieldsInformation - (optional)
        Returns:
        DocumentFieldsInformation
        Throws:
        ApiException - if fails to make API call

      • deleteDocumentFieldsWithHttpInfo

        public ApiResponse<DocumentFieldsInformation> deleteDocumentFieldsWithHttpInfo​(String accountId,
                                                                               String templateId,
                                                                               String documentId,
                                                                               DocumentFieldsInformation documentFieldsInformation)
                                                                        throws ApiException
        Deletes custom document fields from an existing template document. Deletes custom document fields from an existing template document.
        Parameters:
        accountId - The external account number (int) or account ID Guid. (required)
        templateId - The ID of the template being accessed. (required)
        documentId - The ID of the document being accessed. (required)
        documentFieldsInformation - (optional)
        Returns:
        DocumentFieldsInformation
        Throws:
        ApiException - if fails to make API call

      • deleteDocumentPage

        public void deleteDocumentPage​(String accountId,
                               String templateId,
                               String documentId,
                               String pageNumber,
                               PageRequest pageRequest)
                        throws ApiException
        Deletes a page from a document in an template.. Deletes a page from a document in a template based on the page number.
        Parameters:
        accountId - The external account number (int) or account ID Guid. (required)
        templateId - The ID of the template being accessed. (required)
        documentId - The ID of the document being accessed. (required)
        pageNumber - The page number being accessed. (required)
        pageRequest - (optional)
        Throws:
        ApiException - if fails to make API call

      • deleteDocumentPageWithHttpInfo

        public ApiResponse<Object> deleteDocumentPageWithHttpInfo​(String accountId,
                                                          String templateId,
                                                          String documentId,
                                                          String pageNumber,
                                                          PageRequest pageRequest)
                                                   throws ApiException
        Deletes a page from a document in an template. Deletes a page from a document in a template based on the page number.
        Parameters:
        accountId - The external account number (int) or account ID Guid. (required)
        templateId - The ID of the template being accessed. (required)
        documentId - The ID of the document being accessed. (required)
        pageNumber - The page number being accessed. (required)
        pageRequest - (optional)
        Throws:
        ApiException - if fails to make API call

      • deleteDocuments

        public TemplateDocumentsResult deleteDocuments​(String accountId,
                                               String templateId,
                                               EnvelopeDefinition envelopeDefinition)
                                        throws ApiException
        Deletes documents from a template.. Deletes one or more documents from an existing template.
        Parameters:
        accountId - The external account number (int) or account ID Guid. (required)
        templateId - The ID of the template being accessed. (required)
        envelopeDefinition - (optional)
        Returns:
        TemplateDocumentsResult
        Throws:
        ApiException - if fails to make API call

      • deleteDocumentsWithHttpInfo

        public ApiResponse<TemplateDocumentsResult> deleteDocumentsWithHttpInfo​(String accountId,
                                                                        String templateId,
                                                                        EnvelopeDefinition envelopeDefinition)
                                                                 throws ApiException
        Deletes documents from a template. Deletes one or more documents from an existing template.
        Parameters:
        accountId - The external account number (int) or account ID Guid. (required)
        templateId - The ID of the template being accessed. (required)
        envelopeDefinition - (optional)
        Returns:
        TemplateDocumentsResult
        Throws:
        ApiException - if fails to make API call

      • deleteGroupShare

        public GroupInformation deleteGroupShare​(String accountId,
                                         String templateId,
                                         String templatePart,
                                         GroupInformation groupInformation)
                                  throws ApiException
        Removes a member group's sharing permissions for a template.. Removes a member group's sharing permissions for a specified template.
        Parameters:
        accountId - The external account number (int) or account ID Guid. (required)
        templateId - The ID of the template being accessed. (required)
        templatePart - Currently, the only defined part is **groups**. (required)
        groupInformation - (optional)
        Returns:
        GroupInformation
        Throws:
        ApiException - if fails to make API call

      • deleteGroupShareWithHttpInfo

        public ApiResponse<GroupInformation> deleteGroupShareWithHttpInfo​(String accountId,
                                                                  String templateId,
                                                                  String templatePart,
                                                                  GroupInformation groupInformation)
                                                           throws ApiException
        Removes a member group's sharing permissions for a template. Removes a member group's sharing permissions for a specified template.
        Parameters:
        accountId - The external account number (int) or account ID Guid. (required)
        templateId - The ID of the template being accessed. (required)
        templatePart - Currently, the only defined part is **groups**. (required)
        groupInformation - (optional)
        Returns:
        GroupInformation
        Throws:
        ApiException - if fails to make API call

      • deleteLock

        public LockInformation deleteLock​(String accountId,
                                  String templateId,
                                  LockRequest lockRequest)
                           throws ApiException
        Deletes a template lock.. Deletes the lock from the specified template. The `X-DocuSign-Edit` header must be included in the request.
        Parameters:
        accountId - The external account number (int) or account ID Guid. (required)
        templateId - The ID of the template being accessed. (required)
        lockRequest - (optional)
        Returns:
        LockInformation
        Throws:
        ApiException - if fails to make API call

      • deleteLockWithHttpInfo

        public ApiResponse<LockInformation> deleteLockWithHttpInfo​(String accountId,
                                                           String templateId,
                                                           LockRequest lockRequest)
                                                    throws ApiException
        Deletes a template lock. Deletes the lock from the specified template. The `X-DocuSign-Edit` header must be included in the request.
        Parameters:
        accountId - The external account number (int) or account ID Guid. (required)
        templateId - The ID of the template being accessed. (required)
        lockRequest - (optional)
        Returns:
        LockInformation
        Throws:
        ApiException - if fails to make API call

      • deleteRecipient

        public Recipients deleteRecipient​(String accountId,
                                  String templateId,
                                  String recipientId,
                                  TemplateRecipients templateRecipients)
                           throws ApiException
        Deletes the specified recipient file from a template.. Deletes the specified recipient file from the specified template.
        Parameters:
        accountId - The external account number (int) or account ID Guid. (required)
        templateId - The ID of the template being accessed. (required)
        recipientId - The ID of the recipient being accessed. (required)
        templateRecipients - (optional)
        Returns:
        Recipients
        Throws:
        ApiException - if fails to make API call

      • deleteRecipientWithHttpInfo

        public ApiResponse<Recipients> deleteRecipientWithHttpInfo​(String accountId,
                                                           String templateId,
                                                           String recipientId,
                                                           TemplateRecipients templateRecipients)
                                                    throws ApiException
        Deletes the specified recipient file from a template. Deletes the specified recipient file from the specified template.
        Parameters:
        accountId - The external account number (int) or account ID Guid. (required)
        templateId - The ID of the template being accessed. (required)
        recipientId - The ID of the recipient being accessed. (required)
        templateRecipients - (optional)
        Returns:
        Recipients
        Throws:
        ApiException - if fails to make API call

      • deleteRecipients

        public Recipients deleteRecipients​(String accountId,
                                   String templateId,
                                   TemplateRecipients templateRecipients)
                            throws ApiException
        Deletes recipients from a template.. Deletes one or more recipients from a template. Recipients to be deleted are listed in the request, with the `recipientId` being used as the key for deleting recipients.
        Parameters:
        accountId - The external account number (int) or account ID Guid. (required)
        templateId - The ID of the template being accessed. (required)
        templateRecipients - (optional)
        Returns:
        Recipients
        Throws:
        ApiException - if fails to make API call

      • deleteRecipientsWithHttpInfo

        public ApiResponse<Recipients> deleteRecipientsWithHttpInfo​(String accountId,
                                                            String templateId,
                                                            TemplateRecipients templateRecipients)
                                                     throws ApiException
        Deletes recipients from a template. Deletes one or more recipients from a template. Recipients to be deleted are listed in the request, with the `recipientId` being used as the key for deleting recipients.
        Parameters:
        accountId - The external account number (int) or account ID Guid. (required)
        templateId - The ID of the template being accessed. (required)
        templateRecipients - (optional)
        Returns:
        Recipients
        Throws:
        ApiException - if fails to make API call

      • deleteTabs

        public Tabs deleteTabs​(String accountId,
                       String templateId,
                       String recipientId,
                       TemplateTabs templateTabs)
                throws ApiException
        Deletes the tabs associated with a recipient in a template.. Deletes one or more tabs associated with a recipient in a template.
        Parameters:
        accountId - The external account number (int) or account ID Guid. (required)
        templateId - The ID of the template being accessed. (required)
        recipientId - The ID of the recipient being accessed. (required)
        templateTabs - (optional)
        Returns:
        Tabs
        Throws:
        ApiException - if fails to make API call

      • deleteTabsWithHttpInfo

        public ApiResponse<Tabs> deleteTabsWithHttpInfo​(String accountId,
                                                String templateId,
                                                String recipientId,
                                                TemplateTabs templateTabs)
                                         throws ApiException
        Deletes the tabs associated with a recipient in a template. Deletes one or more tabs associated with a recipient in a template.
        Parameters:
        accountId - The external account number (int) or account ID Guid. (required)
        templateId - The ID of the template being accessed. (required)
        recipientId - The ID of the recipient being accessed. (required)
        templateTabs - (optional)
        Returns:
        Tabs
        Throws:
        ApiException - if fails to make API call

      • deleteTemplateDocumentTabs

        public Tabs deleteTemplateDocumentTabs​(String accountId,
                                       String templateId,
                                       String documentId,
                                       TemplateTabs templateTabs)
                                throws ApiException
        Deletes tabs from an envelope document. Deletes tabs from the document specified by `documentId` in the template specified by `templateId`.
        Parameters:
        accountId - The external account number (int) or account ID Guid. (required)
        templateId - The ID of the template being accessed. (required)
        documentId - The ID of the document being accessed. (required)
        templateTabs - (optional)
        Returns:
        Tabs
        Throws:
        ApiException - if fails to make API call

      • deleteTemplateDocumentTabsWithHttpInfo

        public ApiResponse<Tabs> deleteTemplateDocumentTabsWithHttpInfo​(String accountId,
                                                                String templateId,
                                                                String documentId,
                                                                TemplateTabs templateTabs)
                                                         throws ApiException
        Deletes tabs from an envelope document Deletes tabs from the document specified by `documentId` in the template specified by `templateId`.
        Parameters:
        accountId - The external account number (int) or account ID Guid. (required)
        templateId - The ID of the template being accessed. (required)
        documentId - The ID of the document being accessed. (required)
        templateTabs - (optional)
        Returns:
        Tabs
        Throws:
        ApiException - if fails to make API call

      • get

        public EnvelopeTemplate get​(String accountId,
                            String templateId)
                     throws ApiException
        Gets a list of templates for a specified account.. Retrieves the definition of the specified template.
        Parameters:
        accountId - The external account number (int) or account ID Guid. (required)
        templateId - The ID of the template being accessed. (required)
        Returns:
        EnvelopeTemplate
        Throws:
        ApiException

      • get

        public EnvelopeTemplate get​(String accountId,
                            String templateId,
                            TemplatesApi.GetOptions options)
                     throws ApiException
        Gets a list of templates for a specified account.. Retrieves the definition of the specified template.
        Parameters:
        accountId - The external account number (int) or account ID Guid. (required)
        templateId - The ID of the template being accessed. (required)
        options - for modifying the method behavior.
        Returns:
        EnvelopeTemplate
        Throws:
        ApiException - if fails to make API call

      • getWithHttpInfo

        public ApiResponse<EnvelopeTemplate> getWithHttpInfo​(String accountId,
                                                     String templateId,
                                                     TemplatesApi.GetOptions options)
                                              throws ApiException
        Gets a list of templates for a specified account. Retrieves the definition of the specified template.
        Parameters:
        accountId - The external account number (int) or account ID Guid. (required)
        templateId - The ID of the template being accessed. (required)
        options - for modifying the method behavior.
        Returns:
        EnvelopeTemplate
        Throws:
        ApiException - if fails to make API call

      • getDocument

        public byte[] getDocument​(String accountId,
                          String templateId,
                          String documentId)
                   throws ApiException
        Gets PDF documents from a template.. Retrieves one or more PDF documents from the specified template. You can specify the ID of the document to retrieve or can specify `combined` to retrieve all documents in the template as one pdf.
        Parameters:
        accountId - The external account number (int) or account ID Guid. (required)
        templateId - The ID of the template being accessed. (required)
        documentId - The ID of the document being accessed. (required)
        Returns:
        byte[]
        Throws:
        ApiException

      • getDocument

        public byte[] getDocument​(String accountId,
                          String templateId,
                          String documentId,
                          TemplatesApi.GetDocumentOptions options)
                   throws ApiException
        Gets PDF documents from a template.. Retrieves one or more PDF documents from the specified template. You can specify the ID of the document to retrieve or can specify `combined` to retrieve all documents in the template as one pdf.
        Parameters:
        accountId - The external account number (int) or account ID Guid. (required)
        templateId - The ID of the template being accessed. (required)
        documentId - The ID of the document being accessed. (required)
        options - for modifying the method behavior.
        Returns:
        byte[]
        Throws:
        ApiException - if fails to make API call

      • getDocumentWithHttpInfo

        public ApiResponse<byte[]> getDocumentWithHttpInfo​(String accountId,
                                                   String templateId,
                                                   String documentId,
                                                   TemplatesApi.GetDocumentOptions options)
                                            throws ApiException
        Gets PDF documents from a template. Retrieves one or more PDF documents from the specified template. You can specify the ID of the document to retrieve or can specify `combined` to retrieve all documents in the template as one pdf.
        Parameters:
        accountId - The external account number (int) or account ID Guid. (required)
        templateId - The ID of the template being accessed. (required)
        documentId - The ID of the document being accessed. (required)
        options - for modifying the method behavior.
        Returns:
        byte[]
        Throws:
        ApiException - if fails to make API call

      • getDocumentPageImage

        public byte[] getDocumentPageImage​(String accountId,
                                   String templateId,
                                   String documentId,
                                   String pageNumber)
                            throws ApiException
        Gets a page image from a template for display.. Retrieves a page image for display from the specified template.
        Parameters:
        accountId - The external account number (int) or account ID Guid. (required)
        templateId - The ID of the template being accessed. (required)
        documentId - The ID of the document being accessed. (required)
        pageNumber - The page number being accessed. (required)
        Returns:
        byte[]
        Throws:
        ApiException

      • getDocumentPageImage

        public byte[] getDocumentPageImage​(String accountId,
                                   String templateId,
                                   String documentId,
                                   String pageNumber,
                                   TemplatesApi.GetDocumentPageImageOptions options)
                            throws ApiException
        Gets a page image from a template for display.. Retrieves a page image for display from the specified template.
        Parameters:
        accountId - The external account number (int) or account ID Guid. (required)
        templateId - The ID of the template being accessed. (required)
        documentId - The ID of the document being accessed. (required)
        pageNumber - The page number being accessed. (required)
        options - for modifying the method behavior.
        Returns:
        byte[]
        Throws:
        ApiException - if fails to make API call

      • getDocumentPageImageWithHttpInfo

        public ApiResponse<byte[]> getDocumentPageImageWithHttpInfo​(String accountId,
                                                            String templateId,
                                                            String documentId,
                                                            String pageNumber,
                                                            TemplatesApi.GetDocumentPageImageOptions options)
                                                     throws ApiException
        Gets a page image from a template for display. Retrieves a page image for display from the specified template.
        Parameters:
        accountId - The external account number (int) or account ID Guid. (required)
        templateId - The ID of the template being accessed. (required)
        documentId - The ID of the document being accessed. (required)
        pageNumber - The page number being accessed. (required)
        options - for modifying the method behavior.
        Returns:
        byte[]
        Throws:
        ApiException - if fails to make API call

      • getDocumentTabs

        public Tabs getDocumentTabs​(String accountId,
                            String templateId,
                            String documentId)
                     throws ApiException
        Returns tabs on the document.. Returns the tabs on the document specified by `documentId` in the template specified by `templateId`.
        Parameters:
        accountId - The external account number (int) or account ID Guid. (required)
        templateId - The ID of the template being accessed. (required)
        documentId - The ID of the document being accessed. (required)
        Returns:
        Tabs
        Throws:
        ApiException

      • getDocumentTabs

        public Tabs getDocumentTabs​(String accountId,
                            String templateId,
                            String documentId,
                            TemplatesApi.GetDocumentTabsOptions options)
                     throws ApiException
        Returns tabs on the document.. Returns the tabs on the document specified by `documentId` in the template specified by `templateId`.
        Parameters:
        accountId - The external account number (int) or account ID Guid. (required)
        templateId - The ID of the template being accessed. (required)
        documentId - The ID of the document being accessed. (required)
        options - for modifying the method behavior.
        Returns:
        Tabs
        Throws:
        ApiException - if fails to make API call

      • getDocumentTabsWithHttpInfo

        public ApiResponse<Tabs> getDocumentTabsWithHttpInfo​(String accountId,
                                                     String templateId,
                                                     String documentId,
                                                     TemplatesApi.GetDocumentTabsOptions options)
                                              throws ApiException
        Returns tabs on the document. Returns the tabs on the document specified by `documentId` in the template specified by `templateId`.
        Parameters:
        accountId - The external account number (int) or account ID Guid. (required)
        templateId - The ID of the template being accessed. (required)
        documentId - The ID of the document being accessed. (required)
        options - for modifying the method behavior.
        Returns:
        Tabs
        Throws:
        ApiException - if fails to make API call

      • getLock

        public LockInformation getLock​(String accountId,
                               String templateId)
                        throws ApiException
        Gets template lock information.. Retrieves general information about the template lock. If the call is made by the user who has the lock and the request has the same integrator key as original, then the `X-DocuSign-Edit` header field and additional lock information is included in the response. This allows users to recover a lost editing session token and the `X-DocuSign-Edit` header.
        Parameters:
        accountId - The external account number (int) or account ID Guid. (required)
        templateId - The ID of the template being accessed. (required)
        Returns:
        LockInformation
        Throws:
        ApiException - if fails to make API call

      • getLockWithHttpInfo

        public ApiResponse<LockInformation> getLockWithHttpInfo​(String accountId,
                                                        String templateId)
                                                 throws ApiException
        Gets template lock information. Retrieves general information about the template lock. If the call is made by the user who has the lock and the request has the same integrator key as original, then the `X-DocuSign-Edit` header field and additional lock information is included in the response. This allows users to recover a lost editing session token and the `X-DocuSign-Edit` header.
        Parameters:
        accountId - The external account number (int) or account ID Guid. (required)
        templateId - The ID of the template being accessed. (required)
        Returns:
        LockInformation
        Throws:
        ApiException - if fails to make API call

      • getNotificationSettings

        public Notification getNotificationSettings​(String accountId,
                                            String templateId)
                                     throws ApiException
        Gets template notification information.. Retrieves the envelope notification, reminders and expirations, information for an existing template.
        Parameters:
        accountId - The external account number (int) or account ID Guid. (required)
        templateId - The ID of the template being accessed. (required)
        Returns:
        Notification
        Throws:
        ApiException - if fails to make API call

      • getNotificationSettingsWithHttpInfo

        public ApiResponse<Notification> getNotificationSettingsWithHttpInfo​(String accountId,
                                                                     String templateId)
                                                              throws ApiException
        Gets template notification information. Retrieves the envelope notification, reminders and expirations, information for an existing template.
        Parameters:
        accountId - The external account number (int) or account ID Guid. (required)
        templateId - The ID of the template being accessed. (required)
        Returns:
        Notification
        Throws:
        ApiException - if fails to make API call

      • getPageTabs

        public Tabs getPageTabs​(String accountId,
                        String templateId,
                        String documentId,
                        String pageNumber)
                 throws ApiException
        Returns tabs on the specified page.. Returns the tabs from the page specified by `pageNumber` of the document specified by `documentId` in the template specified by `templateId`.
        Parameters:
        accountId - The external account number (int) or account ID Guid. (required)
        templateId - The ID of the template being accessed. (required)
        documentId - The ID of the document being accessed. (required)
        pageNumber - The page number being accessed. (required)
        Returns:
        Tabs
        Throws:
        ApiException - if fails to make API call

      • getPageTabsWithHttpInfo

        public ApiResponse<Tabs> getPageTabsWithHttpInfo​(String accountId,
                                                 String templateId,
                                                 String documentId,
                                                 String pageNumber)
                                          throws ApiException
        Returns tabs on the specified page. Returns the tabs from the page specified by `pageNumber` of the document specified by `documentId` in the template specified by `templateId`.
        Parameters:
        accountId - The external account number (int) or account ID Guid. (required)
        templateId - The ID of the template being accessed. (required)
        documentId - The ID of the document being accessed. (required)
        pageNumber - The page number being accessed. (required)
        Returns:
        Tabs
        Throws:
        ApiException - if fails to make API call

      • getPages

        public PageImages getPages​(String accountId,
                           String templateId,
                           String documentId)
                    throws ApiException
        Returns document page image(s) based on input.. Returns images of the pages in a template document for display based on the parameters that you specify.
        Parameters:
        accountId - The external account number (int) or account ID Guid. (required)
        templateId - The ID of the template being accessed. (required)
        documentId - The ID of the document being accessed. (required)
        Returns:
        PageImages
        Throws:
        ApiException

      • getPages

        public PageImages getPages​(String accountId,
                           String templateId,
                           String documentId,
                           TemplatesApi.GetPagesOptions options)
                    throws ApiException
        Returns document page image(s) based on input.. Returns images of the pages in a template document for display based on the parameters that you specify.
        Parameters:
        accountId - The external account number (int) or account ID Guid. (required)
        templateId - The ID of the template being accessed. (required)
        documentId - The ID of the document being accessed. (required)
        options - for modifying the method behavior.
        Returns:
        PageImages
        Throws:
        ApiException - if fails to make API call

      • getPagesWithHttpInfo

        public ApiResponse<PageImages> getPagesWithHttpInfo​(String accountId,
                                                    String templateId,
                                                    String documentId,
                                                    TemplatesApi.GetPagesOptions options)
                                             throws ApiException
        Returns document page image(s) based on input. Returns images of the pages in a template document for display based on the parameters that you specify.
        Parameters:
        accountId - The external account number (int) or account ID Guid. (required)
        templateId - The ID of the template being accessed. (required)
        documentId - The ID of the document being accessed. (required)
        options - for modifying the method behavior.
        Returns:
        PageImages
        Throws:
        ApiException - if fails to make API call

      • getTemplateDocumentHtmlDefinitions

        public DocumentHtmlDefinitionOriginals getTemplateDocumentHtmlDefinitions​(String accountId,
                                                                          String templateId,
                                                                          String documentId)
                                                                   throws ApiException
        Get the Original HTML Definition used to generate the Responsive HTML for a given document in a template..
        Parameters:
        accountId - The external account number (int) or account ID Guid. (required)
        templateId - The ID of the template being accessed. (required)
        documentId - The ID of the document being accessed. (required)
        Returns:
        DocumentHtmlDefinitionOriginals
        Throws:
        ApiException - if fails to make API call

      • getTemplateDocumentHtmlDefinitionsWithHttpInfo

        public ApiResponse<DocumentHtmlDefinitionOriginals> getTemplateDocumentHtmlDefinitionsWithHttpInfo​(String accountId,
                                                                                                   String templateId,
                                                                                                   String documentId)
                                                                                            throws ApiException
        Get the Original HTML Definition used to generate the Responsive HTML for a given document in a template.
        Parameters:
        accountId - The external account number (int) or account ID Guid. (required)
        templateId - The ID of the template being accessed. (required)
        documentId - The ID of the document being accessed. (required)
        Returns:
        DocumentHtmlDefinitionOriginals
        Throws:
        ApiException - if fails to make API call

      • getTemplateHtmlDefinitions

        public DocumentHtmlDefinitionOriginals getTemplateHtmlDefinitions​(String accountId,
                                                                  String templateId)
                                                           throws ApiException
        Get the Original HTML Definition used to generate the Responsive HTML for the template..
        Parameters:
        accountId - The external account number (int) or account ID Guid. (required)
        templateId - The ID of the template being accessed. (required)
        Returns:
        DocumentHtmlDefinitionOriginals
        Throws:
        ApiException - if fails to make API call

      • getTemplateHtmlDefinitionsWithHttpInfo

        public ApiResponse<DocumentHtmlDefinitionOriginals> getTemplateHtmlDefinitionsWithHttpInfo​(String accountId,
                                                                                           String templateId)
                                                                                    throws ApiException
        Get the Original HTML Definition used to generate the Responsive HTML for the template.
        Parameters:
        accountId - The external account number (int) or account ID Guid. (required)
        templateId - The ID of the template being accessed. (required)
        Returns:
        DocumentHtmlDefinitionOriginals
        Throws:
        ApiException - if fails to make API call

      • listBulkRecipients

        public BulkRecipientsResponse listBulkRecipients​(String accountId,
                                                 String templateId,
                                                 String recipientId)
                                          throws ApiException
        Gets the bulk recipient file from a template.. Retrieves the bulk recipient file information from a template that has a bulk recipient.
        Parameters:
        accountId - The external account number (int) or account ID Guid. (required)
        templateId - The ID of the template being accessed. (required)
        recipientId - The ID of the recipient being accessed. (required)
        Returns:
        BulkRecipientsResponse
        Throws:
        ApiException

      • listBulkRecipients

        public BulkRecipientsResponse listBulkRecipients​(String accountId,
                                                 String templateId,
                                                 String recipientId,
                                                 TemplatesApi.ListBulkRecipientsOptions options)
                                          throws ApiException
        Gets the bulk recipient file from a template.. Retrieves the bulk recipient file information from a template that has a bulk recipient.
        Parameters:
        accountId - The external account number (int) or account ID Guid. (required)
        templateId - The ID of the template being accessed. (required)
        recipientId - The ID of the recipient being accessed. (required)
        options - for modifying the method behavior.
        Returns:
        BulkRecipientsResponse
        Throws:
        ApiException - if fails to make API call

      • listBulkRecipientsWithHttpInfo

        public ApiResponse<BulkRecipientsResponse> listBulkRecipientsWithHttpInfo​(String accountId,
                                                                          String templateId,
                                                                          String recipientId,
                                                                          TemplatesApi.ListBulkRecipientsOptions options)
                                                                   throws ApiException
        Gets the bulk recipient file from a template. Retrieves the bulk recipient file information from a template that has a bulk recipient.
        Parameters:
        accountId - The external account number (int) or account ID Guid. (required)
        templateId - The ID of the template being accessed. (required)
        recipientId - The ID of the recipient being accessed. (required)
        options - for modifying the method behavior.
        Returns:
        BulkRecipientsResponse
        Throws:
        ApiException - if fails to make API call

      • listCustomFields

        public CustomFields listCustomFields​(String accountId,
                                     String templateId)
                              throws ApiException
        Gets the custom document fields from a template.. Retrieves the custom document field information from an existing template.
        Parameters:
        accountId - The external account number (int) or account ID Guid. (required)
        templateId - The ID of the template being accessed. (required)
        Returns:
        CustomFields
        Throws:
        ApiException - if fails to make API call

      • listCustomFieldsWithHttpInfo

        public ApiResponse<CustomFields> listCustomFieldsWithHttpInfo​(String accountId,
                                                              String templateId)
                                                       throws ApiException
        Gets the custom document fields from a template. Retrieves the custom document field information from an existing template.
        Parameters:
        accountId - The external account number (int) or account ID Guid. (required)
        templateId - The ID of the template being accessed. (required)
        Returns:
        CustomFields
        Throws:
        ApiException - if fails to make API call

      • listDocumentFields

        public DocumentFieldsInformation listDocumentFields​(String accountId,
                                                    String templateId,
                                                    String documentId)
                                             throws ApiException
        Gets the custom document fields for a an existing template document.. Retrieves the custom document fields for an existing template document.
        Parameters:
        accountId - The external account number (int) or account ID Guid. (required)
        templateId - The ID of the template being accessed. (required)
        documentId - The ID of the document being accessed. (required)
        Returns:
        DocumentFieldsInformation
        Throws:
        ApiException - if fails to make API call

      • listDocumentFieldsWithHttpInfo

        public ApiResponse<DocumentFieldsInformation> listDocumentFieldsWithHttpInfo​(String accountId,
                                                                             String templateId,
                                                                             String documentId)
                                                                      throws ApiException
        Gets the custom document fields for a an existing template document. Retrieves the custom document fields for an existing template document.
        Parameters:
        accountId - The external account number (int) or account ID Guid. (required)
        templateId - The ID of the template being accessed. (required)
        documentId - The ID of the document being accessed. (required)
        Returns:
        DocumentFieldsInformation
        Throws:
        ApiException - if fails to make API call

      • listDocuments

        public TemplateDocumentsResult listDocuments​(String accountId,
                                             String templateId)
                                      throws ApiException
        Gets a list of documents associated with a template.. Retrieves a list of documents associated with the specified template.
        Parameters:
        accountId - The external account number (int) or account ID Guid. (required)
        templateId - The ID of the template being accessed. (required)
        Returns:
        TemplateDocumentsResult
        Throws:
        ApiException

      • listDocuments

        public TemplateDocumentsResult listDocuments​(String accountId,
                                             String templateId,
                                             TemplatesApi.ListDocumentsOptions options)
                                      throws ApiException
        Gets a list of documents associated with a template.. Retrieves a list of documents associated with the specified template.
        Parameters:
        accountId - The external account number (int) or account ID Guid. (required)
        templateId - The ID of the template being accessed. (required)
        options - for modifying the method behavior.
        Returns:
        TemplateDocumentsResult
        Throws:
        ApiException - if fails to make API call

      • listDocumentsWithHttpInfo

        public ApiResponse<TemplateDocumentsResult> listDocumentsWithHttpInfo​(String accountId,
                                                                      String templateId,
                                                                      TemplatesApi.ListDocumentsOptions options)
                                                               throws ApiException
        Gets a list of documents associated with a template. Retrieves a list of documents associated with the specified template.
        Parameters:
        accountId - The external account number (int) or account ID Guid. (required)
        templateId - The ID of the template being accessed. (required)
        options - for modifying the method behavior.
        Returns:
        TemplateDocumentsResult
        Throws:
        ApiException - if fails to make API call

      • listRecipients

        public Recipients listRecipients​(String accountId,
                                 String templateId)
                          throws ApiException
        Gets recipient information from a template.. Retrieves the information for all recipients in the specified template.
        Parameters:
        accountId - The external account number (int) or account ID Guid. (required)
        templateId - The ID of the template being accessed. (required)
        Returns:
        Recipients
        Throws:
        ApiException

      • listRecipients

        public Recipients listRecipients​(String accountId,
                                 String templateId,
                                 TemplatesApi.ListRecipientsOptions options)
                          throws ApiException
        Gets recipient information from a template.. Retrieves the information for all recipients in the specified template.
        Parameters:
        accountId - The external account number (int) or account ID Guid. (required)
        templateId - The ID of the template being accessed. (required)
        options - for modifying the method behavior.
        Returns:
        Recipients
        Throws:
        ApiException - if fails to make API call

      • listRecipientsWithHttpInfo

        public ApiResponse<Recipients> listRecipientsWithHttpInfo​(String accountId,
                                                          String templateId,
                                                          TemplatesApi.ListRecipientsOptions options)
                                                   throws ApiException
        Gets recipient information from a template. Retrieves the information for all recipients in the specified template.
        Parameters:
        accountId - The external account number (int) or account ID Guid. (required)
        templateId - The ID of the template being accessed. (required)
        options - for modifying the method behavior.
        Returns:
        Recipients
        Throws:
        ApiException - if fails to make API call

      • listTabs

        public Tabs listTabs​(String accountId,
                     String templateId,
                     String recipientId)
              throws ApiException
        Gets the tabs information for a signer or sign-in-person recipient in a template.. Gets the tabs information for a signer or sign-in-person recipient in a template.
        Parameters:
        accountId - The external account number (int) or account ID Guid. (required)
        templateId - The ID of the template being accessed. (required)
        recipientId - The ID of the recipient being accessed. (required)
        Returns:
        Tabs
        Throws:
        ApiException

      • listTabs

        public Tabs listTabs​(String accountId,
                     String templateId,
                     String recipientId,
                     TemplatesApi.ListTabsOptions options)
              throws ApiException
        Gets the tabs information for a signer or sign-in-person recipient in a template.. Gets the tabs information for a signer or sign-in-person recipient in a template.
        Parameters:
        accountId - The external account number (int) or account ID Guid. (required)
        templateId - The ID of the template being accessed. (required)
        recipientId - The ID of the recipient being accessed. (required)
        options - for modifying the method behavior.
        Returns:
        Tabs
        Throws:
        ApiException - if fails to make API call

      • listTabsWithHttpInfo

        public ApiResponse<Tabs> listTabsWithHttpInfo​(String accountId,
                                              String templateId,
                                              String recipientId,
                                              TemplatesApi.ListTabsOptions options)
                                       throws ApiException
        Gets the tabs information for a signer or sign-in-person recipient in a template. Gets the tabs information for a signer or sign-in-person recipient in a template.
        Parameters:
        accountId - The external account number (int) or account ID Guid. (required)
        templateId - The ID of the template being accessed. (required)
        recipientId - The ID of the recipient being accessed. (required)
        options - for modifying the method behavior.
        Returns:
        Tabs
        Throws:
        ApiException - if fails to make API call

      • listTemplates

        public EnvelopeTemplateResults listTemplates​(String accountId)
                                      throws ApiException
        Gets the definition of a template.. Retrieves the list of templates for the specified account. The request can be limited to a specific folder.
        Parameters:
        accountId - The external account number (int) or account ID Guid. (required)
        Returns:
        EnvelopeTemplateResults
        Throws:
        ApiException

      • listTemplates

        public EnvelopeTemplateResults listTemplates​(String accountId,
                                             TemplatesApi.ListTemplatesOptions options)
                                      throws ApiException
        Gets the definition of a template.. Retrieves the list of templates for the specified account. The request can be limited to a specific folder.
        Parameters:
        accountId - The external account number (int) or account ID Guid. (required)
        options - for modifying the method behavior.
        Returns:
        EnvelopeTemplateResults
        Throws:
        ApiException - if fails to make API call

      • listTemplatesWithHttpInfo

        public ApiResponse<EnvelopeTemplateResults> listTemplatesWithHttpInfo​(String accountId,
                                                                      TemplatesApi.ListTemplatesOptions options)
                                                               throws ApiException
        Gets the definition of a template. Retrieves the list of templates for the specified account. The request can be limited to a specific folder.
        Parameters:
        accountId - The external account number (int) or account ID Guid. (required)
        options - for modifying the method behavior.
        Returns:
        EnvelopeTemplateResults
        Throws:
        ApiException - if fails to make API call

      • rotateDocumentPage

        public void rotateDocumentPage​(String accountId,
                               String templateId,
                               String documentId,
                               String pageNumber,
                               PageRequest pageRequest)
                        throws ApiException
        Rotates page image from a template for display.. Rotates page image from a template for display. The page image can be rotated to the left or right.
        Parameters:
        accountId - The external account number (int) or account ID Guid. (required)
        templateId - The ID of the template being accessed. (required)
        documentId - The ID of the document being accessed. (required)
        pageNumber - The page number being accessed. (required)
        pageRequest - (optional)
        Throws:
        ApiException - if fails to make API call

      • rotateDocumentPageWithHttpInfo

        public ApiResponse<Object> rotateDocumentPageWithHttpInfo​(String accountId,
                                                          String templateId,
                                                          String documentId,
                                                          String pageNumber,
                                                          PageRequest pageRequest)
                                                   throws ApiException
        Rotates page image from a template for display. Rotates page image from a template for display. The page image can be rotated to the left or right.
        Parameters:
        accountId - The external account number (int) or account ID Guid. (required)
        templateId - The ID of the template being accessed. (required)
        documentId - The ID of the document being accessed. (required)
        pageNumber - The page number being accessed. (required)
        pageRequest - (optional)
        Throws:
        ApiException - if fails to make API call

      • update

        public TemplateUpdateSummary update​(String accountId,
                                    String templateId,
                                    EnvelopeTemplate envelopeTemplate)
                             throws ApiException
        Updates an existing template.. Updates an existing template.
        Parameters:
        accountId - The external account number (int) or account ID Guid. (required)
        templateId - The ID of the template being accessed. (required)
        envelopeTemplate - (optional)
        Returns:
        TemplateUpdateSummary
        Throws:
        ApiException - if fails to make API call

      • updateWithHttpInfo

        public ApiResponse<TemplateUpdateSummary> updateWithHttpInfo​(String accountId,
                                                             String templateId,
                                                             EnvelopeTemplate envelopeTemplate)
                                                      throws ApiException
        Updates an existing template. Updates an existing template.
        Parameters:
        accountId - The external account number (int) or account ID Guid. (required)
        templateId - The ID of the template being accessed. (required)
        envelopeTemplate - (optional)
        Returns:
        TemplateUpdateSummary
        Throws:
        ApiException - if fails to make API call

      • updateCustomFields

        public CustomFields updateCustomFields​(String accountId,
                                       String templateId,
                                       TemplateCustomFields templateCustomFields)
                                throws ApiException
        Updates envelope custom fields in a template.. Updates the custom fields in a template. Each custom field used in a template must have a unique name.
        Parameters:
        accountId - The external account number (int) or account ID Guid. (required)
        templateId - The ID of the template being accessed. (required)
        templateCustomFields - (optional)
        Returns:
        CustomFields
        Throws:
        ApiException - if fails to make API call

      • updateCustomFieldsWithHttpInfo

        public ApiResponse<CustomFields> updateCustomFieldsWithHttpInfo​(String accountId,
                                                                String templateId,
                                                                TemplateCustomFields templateCustomFields)
                                                         throws ApiException
        Updates envelope custom fields in a template. Updates the custom fields in a template. Each custom field used in a template must have a unique name.
        Parameters:
        accountId - The external account number (int) or account ID Guid. (required)
        templateId - The ID of the template being accessed. (required)
        templateCustomFields - (optional)
        Returns:
        CustomFields
        Throws:
        ApiException - if fails to make API call

      • updateDocument

        public EnvelopeDocument updateDocument​(String accountId,
                                       String templateId,
                                       String documentId,
                                       EnvelopeDefinition envelopeDefinition)
                                throws ApiException
        Adds a document to a template document.. Adds the specified document to an existing template document.
        Parameters:
        accountId - The external account number (int) or account ID Guid. (required)
        templateId - The ID of the template being accessed. (required)
        documentId - The ID of the document being accessed. (required)
        envelopeDefinition - (optional)
        Returns:
        EnvelopeDocument
        Throws:
        ApiException

      • updateDocument

        public EnvelopeDocument updateDocument​(String accountId,
                                       String templateId,
                                       String documentId,
                                       EnvelopeDefinition envelopeDefinition,
                                       TemplatesApi.UpdateDocumentOptions options)
                                throws ApiException
        Adds a document to a template document.. Adds the specified document to an existing template document.
        Parameters:
        accountId - The external account number (int) or account ID Guid. (required)
        templateId - The ID of the template being accessed. (required)
        documentId - The ID of the document being accessed. (required)
        envelopeDefinition - (optional)
        options - for modifying the method behavior.
        Returns:
        EnvelopeDocument
        Throws:
        ApiException - if fails to make API call

      • updateDocumentWithHttpInfo

        public ApiResponse<EnvelopeDocument> updateDocumentWithHttpInfo​(String accountId,
                                                                String templateId,
                                                                String documentId,
                                                                EnvelopeDefinition envelopeDefinition,
                                                                TemplatesApi.UpdateDocumentOptions options)
                                                         throws ApiException
        Adds a document to a template document. Adds the specified document to an existing template document.
        Parameters:
        accountId - The external account number (int) or account ID Guid. (required)
        templateId - The ID of the template being accessed. (required)
        documentId - The ID of the document being accessed. (required)
        envelopeDefinition - (optional)
        options - for modifying the method behavior.
        Returns:
        EnvelopeDocument
        Throws:
        ApiException - if fails to make API call

      • updateDocumentFields

        public DocumentFieldsInformation updateDocumentFields​(String accountId,
                                                      String templateId,
                                                      String documentId,
                                                      DocumentFieldsInformation documentFieldsInformation)
                                               throws ApiException
        Updates existing custom document fields in an existing template document.. Updates existing custom document fields in an existing template document.
        Parameters:
        accountId - The external account number (int) or account ID Guid. (required)
        templateId - The ID of the template being accessed. (required)
        documentId - The ID of the document being accessed. (required)
        documentFieldsInformation - (optional)
        Returns:
        DocumentFieldsInformation
        Throws:
        ApiException - if fails to make API call

      • updateDocumentFieldsWithHttpInfo

        public ApiResponse<DocumentFieldsInformation> updateDocumentFieldsWithHttpInfo​(String accountId,
                                                                               String templateId,
                                                                               String documentId,
                                                                               DocumentFieldsInformation documentFieldsInformation)
                                                                        throws ApiException
        Updates existing custom document fields in an existing template document. Updates existing custom document fields in an existing template document.
        Parameters:
        accountId - The external account number (int) or account ID Guid. (required)
        templateId - The ID of the template being accessed. (required)
        documentId - The ID of the document being accessed. (required)
        documentFieldsInformation - (optional)
        Returns:
        DocumentFieldsInformation
        Throws:
        ApiException - if fails to make API call

      • updateDocuments

        public TemplateDocumentsResult updateDocuments​(String accountId,
                                               String templateId,
                                               EnvelopeDefinition envelopeDefinition)
                                        throws ApiException
        Adds documents to a template document.. Adds one or more documents to an existing template document.
        Parameters:
        accountId - The external account number (int) or account ID Guid. (required)
        templateId - The ID of the template being accessed. (required)
        envelopeDefinition - (optional)
        Returns:
        TemplateDocumentsResult
        Throws:
        ApiException - if fails to make API call

      • updateDocumentsWithHttpInfo

        public ApiResponse<TemplateDocumentsResult> updateDocumentsWithHttpInfo​(String accountId,
                                                                        String templateId,
                                                                        EnvelopeDefinition envelopeDefinition)
                                                                 throws ApiException
        Adds documents to a template document. Adds one or more documents to an existing template document.
        Parameters:
        accountId - The external account number (int) or account ID Guid. (required)
        templateId - The ID of the template being accessed. (required)
        envelopeDefinition - (optional)
        Returns:
        TemplateDocumentsResult
        Throws:
        ApiException - if fails to make API call

      • updateGroupShare

        public GroupInformation updateGroupShare​(String accountId,
                                         String templateId,
                                         String templatePart,
                                         GroupInformation groupInformation)
                                  throws ApiException
        Shares a template with a group. Shares a template with the specified members group.
        Parameters:
        accountId - The external account number (int) or account ID Guid. (required)
        templateId - The ID of the template being accessed. (required)
        templatePart - Currently, the only defined part is **groups**. (required)
        groupInformation - (optional)
        Returns:
        GroupInformation
        Throws:
        ApiException - if fails to make API call

      • updateGroupShareWithHttpInfo

        public ApiResponse<GroupInformation> updateGroupShareWithHttpInfo​(String accountId,
                                                                  String templateId,
                                                                  String templatePart,
                                                                  GroupInformation groupInformation)
                                                           throws ApiException
        Shares a template with a group Shares a template with the specified members group.
        Parameters:
        accountId - The external account number (int) or account ID Guid. (required)
        templateId - The ID of the template being accessed. (required)
        templatePart - Currently, the only defined part is **groups**. (required)
        groupInformation - (optional)
        Returns:
        GroupInformation
        Throws:
        ApiException - if fails to make API call

      • updateLock

        public LockInformation updateLock​(String accountId,
                                  String templateId,
                                  LockRequest lockRequest)
                           throws ApiException
        Updates a template lock.. Updates the lock duration time or update the `lockedByApp` property information for the specified template. The user and integrator key must match the user specified by the `lockByUser` property and integrator key information and the `X-DocuSign-Edit` header must be included or an error will be generated.
        Parameters:
        accountId - The external account number (int) or account ID Guid. (required)
        templateId - The ID of the template being accessed. (required)
        lockRequest - (optional)
        Returns:
        LockInformation
        Throws:
        ApiException - if fails to make API call

      • updateLockWithHttpInfo

        public ApiResponse<LockInformation> updateLockWithHttpInfo​(String accountId,
                                                           String templateId,
                                                           LockRequest lockRequest)
                                                    throws ApiException
        Updates a template lock. Updates the lock duration time or update the `lockedByApp` property information for the specified template. The user and integrator key must match the user specified by the `lockByUser` property and integrator key information and the `X-DocuSign-Edit` header must be included or an error will be generated.
        Parameters:
        accountId - The external account number (int) or account ID Guid. (required)
        templateId - The ID of the template being accessed. (required)
        lockRequest - (optional)
        Returns:
        LockInformation
        Throws:
        ApiException - if fails to make API call

      • updateNotificationSettings

        public Notification updateNotificationSettings​(String accountId,
                                               String templateId,
                                               TemplateNotificationRequest templateNotificationRequest)
                                        throws ApiException
        Updates the notification structure for an existing template.. Updates the notification structure for an existing template. Use this endpoint to set reminder and expiration notifications.
        Parameters:
        accountId - The external account number (int) or account ID Guid. (required)
        templateId - The ID of the template being accessed. (required)
        templateNotificationRequest - (optional)
        Returns:
        Notification
        Throws:
        ApiException - if fails to make API call

      • updateNotificationSettingsWithHttpInfo

        public ApiResponse<Notification> updateNotificationSettingsWithHttpInfo​(String accountId,
                                                                        String templateId,
                                                                        TemplateNotificationRequest templateNotificationRequest)
                                                                 throws ApiException
        Updates the notification structure for an existing template. Updates the notification structure for an existing template. Use this endpoint to set reminder and expiration notifications.
        Parameters:
        accountId - The external account number (int) or account ID Guid. (required)
        templateId - The ID of the template being accessed. (required)
        templateNotificationRequest - (optional)
        Returns:
        Notification
        Throws:
        ApiException - if fails to make API call

      • updateRecipients

        public RecipientsUpdateSummary updateRecipients​(String accountId,
                                                String templateId,
                                                TemplateRecipients templateRecipients)
                                         throws ApiException
        Updates recipients in a template.. Updates recipients in a template. You can edit the following properties: `email`, `userName`, `routingOrder`, `faxNumber`, `deliveryMethod`, `accessCode`, and `requireIdLookup`.
        Parameters:
        accountId - The external account number (int) or account ID Guid. (required)
        templateId - The ID of the template being accessed. (required)
        templateRecipients - (optional)
        Returns:
        RecipientsUpdateSummary
        Throws:
        ApiException

      • updateRecipients

        public RecipientsUpdateSummary updateRecipients​(String accountId,
                                                String templateId,
                                                TemplateRecipients templateRecipients,
                                                TemplatesApi.UpdateRecipientsOptions options)
                                         throws ApiException
        Updates recipients in a template.. Updates recipients in a template. You can edit the following properties: `email`, `userName`, `routingOrder`, `faxNumber`, `deliveryMethod`, `accessCode`, and `requireIdLookup`.
        Parameters:
        accountId - The external account number (int) or account ID Guid. (required)
        templateId - The ID of the template being accessed. (required)
        templateRecipients - (optional)
        options - for modifying the method behavior.
        Returns:
        RecipientsUpdateSummary
        Throws:
        ApiException - if fails to make API call

      • updateRecipientsWithHttpInfo

        public ApiResponse<RecipientsUpdateSummary> updateRecipientsWithHttpInfo​(String accountId,
                                                                         String templateId,
                                                                         TemplateRecipients templateRecipients,
                                                                         TemplatesApi.UpdateRecipientsOptions options)
                                                                  throws ApiException
        Updates recipients in a template. Updates recipients in a template. You can edit the following properties: `email`, `userName`, `routingOrder`, `faxNumber`, `deliveryMethod`, `accessCode`, and `requireIdLookup`.
        Parameters:
        accountId - The external account number (int) or account ID Guid. (required)
        templateId - The ID of the template being accessed. (required)
        templateRecipients - (optional)
        options - for modifying the method behavior.
        Returns:
        RecipientsUpdateSummary
        Throws:
        ApiException - if fails to make API call

      • updateTabs

        public Tabs updateTabs​(String accountId,
                       String templateId,
                       String recipientId,
                       TemplateTabs templateTabs)
                throws ApiException
        Updates the tabs for a recipient.. Updates one or more tabs for a recipient in a template.
        Parameters:
        accountId - The external account number (int) or account ID Guid. (required)
        templateId - The ID of the template being accessed. (required)
        recipientId - The ID of the recipient being accessed. (required)
        templateTabs - (optional)
        Returns:
        Tabs
        Throws:
        ApiException - if fails to make API call

      • updateTabsWithHttpInfo

        public ApiResponse<Tabs> updateTabsWithHttpInfo​(String accountId,
                                                String templateId,
                                                String recipientId,
                                                TemplateTabs templateTabs)
                                         throws ApiException
        Updates the tabs for a recipient. Updates one or more tabs for a recipient in a template.
        Parameters:
        accountId - The external account number (int) or account ID Guid. (required)
        templateId - The ID of the template being accessed. (required)
        recipientId - The ID of the recipient being accessed. (required)
        templateTabs - (optional)
        Returns:
        Tabs
        Throws:
        ApiException - if fails to make API call

      • updateTemplateDocumentTabs

        public Tabs updateTemplateDocumentTabs​(String accountId,
                                       String templateId,
                                       String documentId,
                                       TemplateTabs templateTabs)
                                throws ApiException
        Updates the tabs for a template. Updates tabs in the document specified by `documentId` in the template specified by `templateId`.
        Parameters:
        accountId - The external account number (int) or account ID Guid. (required)
        templateId - The ID of the template being accessed. (required)
        documentId - The ID of the document being accessed. (required)
        templateTabs - (optional)
        Returns:
        Tabs
        Throws:
        ApiException - if fails to make API call

      • updateTemplateDocumentTabsWithHttpInfo

        public ApiResponse<Tabs> updateTemplateDocumentTabsWithHttpInfo​(String accountId,
                                                                String templateId,
                                                                String documentId,
                                                                TemplateTabs templateTabs)
                                                         throws ApiException
        Updates the tabs for a template Updates tabs in the document specified by `documentId` in the template specified by `templateId`.
        Parameters:
        accountId - The external account number (int) or account ID Guid. (required)
        templateId - The ID of the template being accessed. (required)
        documentId - The ID of the document being accessed. (required)
        templateTabs - (optional)
        Returns:
        Tabs
        Throws:
        ApiException - if fails to make API call