Class TemplateApi

java.lang.Object
com.boldsign.api.TemplateApi
public class TemplateApi extends Object

  • Constructor Details

    • TemplateApi

      public TemplateApi()

    • TemplateApi

      public TemplateApi(ApiClient apiClient)

  • Method Details

    • getApiClient

      public ApiClient getApiClient()

    • setApiClient

      public void setApiClient(ApiClient apiClient)

    • getHostIndex

      public int getHostIndex()

    • setHostIndex

      public void setHostIndex(int hostIndex)

    • getCustomBaseUrl

      public String getCustomBaseUrl()

    • setCustomBaseUrl

      public void setCustomBaseUrl(String customBaseUrl)

    • addTagCall

      public okhttp3.Call addTagCall(TemplateTag templateTag, ApiCallback _callback) throws ApiException
      Build call for addTag
      Parameters:
      templateTag - ContainsTemplateId and Label Names for AddingTags. (optional)
      _callback - Callback for upload/download progress
      Returns:
      Call to execute
      Throws:
      ApiException - If fail to serialize the request body object
      Http Response Details:
      Status Code Description Response Headers
      200 OK -
      400 Bad Request -
      401 Unauthorized -

    • addTag

      public void addTag(TemplateTag templateTag) throws ApiException
      Add the Tags in Templates.
      Parameters:
      templateTag - ContainsTemplateId and Label Names for AddingTags. (optional)
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      Http Response Details:
      Status Code Description Response Headers
      200 OK -
      400 Bad Request -
      401 Unauthorized -

    • addTagWithHttpInfo

      public ApiResponse<Void> addTagWithHttpInfo(TemplateTag templateTag) throws ApiException
      Add the Tags in Templates.
      Parameters:
      templateTag - ContainsTemplateId and Label Names for AddingTags. (optional)
      Returns:
      ApiResponse<Void>
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      Http Response Details:
      Status Code Description Response Headers
      200 OK -
      400 Bad Request -
      401 Unauthorized -

    • addTagAsync

      public okhttp3.Call addTagAsync(TemplateTag templateTag, ApiCallback<Void> _callback) throws ApiException
      Add the Tags in Templates. (asynchronously)
      Parameters:
      templateTag - ContainsTemplateId and Label Names for AddingTags. (optional)
      _callback - The callback to be executed when the API call finishes
      Returns:
      The request call
      Throws:
      ApiException - If fail to process the API call, e.g. serializing the request body object
      Http Response Details:
      Status Code Description Response Headers
      200 OK -
      400 Bad Request -
      401 Unauthorized -

    • createEmbeddedRequestUrlTemplateCall

      public okhttp3.Call createEmbeddedRequestUrlTemplateCall(String templateId, EmbeddedSendTemplateFormRequest embeddedSendTemplateFormRequest, ApiCallback _callback) throws ApiException
      Build call for createEmbeddedRequestUrlTemplate
      Parameters:
      templateId - The template id. (required)
      embeddedSendTemplateFormRequest - Embedded send template json request. (optional)
      _callback - Callback for upload/download progress
      Returns:
      Call to execute
      Throws:
      ApiException - If fail to serialize the request body object
      Http Response Details:
      Status Code Description Response Headers
      201 Created -
      422 Unprocessable Content -
      401 Unauthorized -

    • createEmbeddedRequestUrlTemplate

      public EmbeddedSendCreated createEmbeddedRequestUrlTemplate(String templateId, EmbeddedSendTemplateFormRequest embeddedSendTemplateFormRequest) throws ApiException
      Generates a send URL using a template which embeds document sending process into your application.
      Parameters:
      templateId - The template id. (required)
      embeddedSendTemplateFormRequest - Embedded send template json request. (optional)
      Returns:
      EmbeddedSendCreated
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      Http Response Details:
      Status Code Description Response Headers
      201 Created -
      422 Unprocessable Content -
      401 Unauthorized -

    • createEmbeddedRequestUrlTemplateWithHttpInfo

      public ApiResponse<EmbeddedSendCreated> createEmbeddedRequestUrlTemplateWithHttpInfo(String templateId, EmbeddedSendTemplateFormRequest embeddedSendTemplateFormRequest) throws ApiException
      Generates a send URL using a template which embeds document sending process into your application.
      Parameters:
      templateId - The template id. (required)
      embeddedSendTemplateFormRequest - Embedded send template json request. (optional)
      Returns:
      ApiResponse<EmbeddedSendCreated>
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      Http Response Details:
      Status Code Description Response Headers
      201 Created -
      422 Unprocessable Content -
      401 Unauthorized -

    • createEmbeddedRequestUrlTemplateAsync

      public okhttp3.Call createEmbeddedRequestUrlTemplateAsync(String templateId, EmbeddedSendTemplateFormRequest embeddedSendTemplateFormRequest, ApiCallback<EmbeddedSendCreated> _callback) throws ApiException
      Generates a send URL using a template which embeds document sending process into your application. (asynchronously)
      Parameters:
      templateId - The template id. (required)
      embeddedSendTemplateFormRequest - Embedded send template json request. (optional)
      _callback - The callback to be executed when the API call finishes
      Returns:
      The request call
      Throws:
      ApiException - If fail to process the API call, e.g. serializing the request body object
      Http Response Details:
      Status Code Description Response Headers
      201 Created -
      422 Unprocessable Content -
      401 Unauthorized -

    • createEmbeddedTemplateUrlCall

      public okhttp3.Call createEmbeddedTemplateUrlCall(EmbeddedCreateTemplateRequest embeddedCreateTemplateRequest, ApiCallback _callback) throws ApiException
      Build call for createEmbeddedTemplateUrl
      Parameters:
      embeddedCreateTemplateRequest - The create embedded template request body. (optional)
      _callback - Callback for upload/download progress
      Returns:
      Call to execute
      Throws:
      ApiException - If fail to serialize the request body object
      Http Response Details:
      Status Code Description Response Headers
      201 Created -
      401 Unauthorized -
      422 Unprocessable Content -

    • createEmbeddedTemplateUrl

      public EmbeddedTemplateCreated createEmbeddedTemplateUrl(EmbeddedCreateTemplateRequest embeddedCreateTemplateRequest) throws ApiException
      Generates a create URL to embeds template create process into your application.
      Parameters:
      embeddedCreateTemplateRequest - The create embedded template request body. (optional)
      Returns:
      EmbeddedTemplateCreated
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      Http Response Details:
      Status Code Description Response Headers
      201 Created -
      401 Unauthorized -
      422 Unprocessable Content -

    • createEmbeddedTemplateUrlWithHttpInfo

      public ApiResponse<EmbeddedTemplateCreated> createEmbeddedTemplateUrlWithHttpInfo(EmbeddedCreateTemplateRequest embeddedCreateTemplateRequest) throws ApiException
      Generates a create URL to embeds template create process into your application.
      Parameters:
      embeddedCreateTemplateRequest - The create embedded template request body. (optional)
      Returns:
      ApiResponse<EmbeddedTemplateCreated>
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      Http Response Details:
      Status Code Description Response Headers
      201 Created -
      401 Unauthorized -
      422 Unprocessable Content -

    • createEmbeddedTemplateUrlAsync

      public okhttp3.Call createEmbeddedTemplateUrlAsync(EmbeddedCreateTemplateRequest embeddedCreateTemplateRequest, ApiCallback<EmbeddedTemplateCreated> _callback) throws ApiException
      Generates a create URL to embeds template create process into your application. (asynchronously)
      Parameters:
      embeddedCreateTemplateRequest - The create embedded template request body. (optional)
      _callback - The callback to be executed when the API call finishes
      Returns:
      The request call
      Throws:
      ApiException - If fail to process the API call, e.g. serializing the request body object
      Http Response Details:
      Status Code Description Response Headers
      201 Created -
      401 Unauthorized -
      422 Unprocessable Content -

    • createTemplateCall

      public okhttp3.Call createTemplateCall(CreateTemplateRequest createTemplateRequest, ApiCallback _callback) throws ApiException
      Build call for createTemplate
      Parameters:
      createTemplateRequest - The create template request body. (optional)
      _callback - Callback for upload/download progress
      Returns:
      Call to execute
      Throws:
      ApiException - If fail to serialize the request body object
      Http Response Details:
      Status Code Description Response Headers
      201 Created -
      401 Unauthorized -
      403 Forbidden -
      422 Unprocessable Content -

    • createTemplate

      public TemplateCreated createTemplate(CreateTemplateRequest createTemplateRequest) throws ApiException
      Creates a new template.
      Parameters:
      createTemplateRequest - The create template request body. (optional)
      Returns:
      TemplateCreated
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      Http Response Details:
      Status Code Description Response Headers
      201 Created -
      401 Unauthorized -
      403 Forbidden -
      422 Unprocessable Content -

    • createTemplateWithHttpInfo

      public ApiResponse<TemplateCreated> createTemplateWithHttpInfo(CreateTemplateRequest createTemplateRequest) throws ApiException
      Creates a new template.
      Parameters:
      createTemplateRequest - The create template request body. (optional)
      Returns:
      ApiResponse<TemplateCreated>
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      Http Response Details:
      Status Code Description Response Headers
      201 Created -
      401 Unauthorized -
      403 Forbidden -
      422 Unprocessable Content -

    • createTemplateAsync

      public okhttp3.Call createTemplateAsync(CreateTemplateRequest createTemplateRequest, ApiCallback<TemplateCreated> _callback) throws ApiException
      Creates a new template. (asynchronously)
      Parameters:
      createTemplateRequest - The create template request body. (optional)
      _callback - The callback to be executed when the API call finishes
      Returns:
      The request call
      Throws:
      ApiException - If fail to process the API call, e.g. serializing the request body object
      Http Response Details:
      Status Code Description Response Headers
      201 Created -
      401 Unauthorized -
      403 Forbidden -
      422 Unprocessable Content -

    • deleteTemplateCall

      public okhttp3.Call deleteTemplateCall(String templateId, String onBehalfOf, ApiCallback _callback) throws ApiException
      Build call for deleteTemplate
      Parameters:
      templateId - The template id. (required)
      onBehalfOf - The on behalfof email address. (optional)
      _callback - Callback for upload/download progress
      Returns:
      Call to execute
      Throws:
      ApiException - If fail to serialize the request body object
      Http Response Details:
      Status Code Description Response Headers
      204 No Content -
      401 Unauthorized -
      403 Forbidden -

    • deleteTemplate

      public void deleteTemplate(String templateId, String onBehalfOf) throws ApiException
      Deletes a template.
      Parameters:
      templateId - The template id. (required)
      onBehalfOf - The on behalfof email address. (optional)
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      Http Response Details:
      Status Code Description Response Headers
      204 No Content -
      401 Unauthorized -
      403 Forbidden -

    • deleteTemplateWithHttpInfo

      public ApiResponse<Void> deleteTemplateWithHttpInfo(String templateId, String onBehalfOf) throws ApiException
      Deletes a template.
      Parameters:
      templateId - The template id. (required)
      onBehalfOf - The on behalfof email address. (optional)
      Returns:
      ApiResponse<Void>
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      Http Response Details:
      Status Code Description Response Headers
      204 No Content -
      401 Unauthorized -
      403 Forbidden -

    • deleteTemplateAsync

      public okhttp3.Call deleteTemplateAsync(String templateId, String onBehalfOf, ApiCallback<Void> _callback) throws ApiException
      Deletes a template. (asynchronously)
      Parameters:
      templateId - The template id. (required)
      onBehalfOf - The on behalfof email address. (optional)
      _callback - The callback to be executed when the API call finishes
      Returns:
      The request call
      Throws:
      ApiException - If fail to process the API call, e.g. serializing the request body object
      Http Response Details:
      Status Code Description Response Headers
      204 No Content -
      401 Unauthorized -
      403 Forbidden -

    • deleteTagCall

      public okhttp3.Call deleteTagCall(TemplateTag templateTag, ApiCallback _callback) throws ApiException
      Build call for deleteTag
      Parameters:
      templateTag - Contains TemplateId and LabelNames for Adding Tags. (optional)
      _callback - Callback for upload/download progress
      Returns:
      Call to execute
      Throws:
      ApiException - If fail to serialize the request body object
      Http Response Details:
      Status Code Description Response Headers
      200 OK -
      401 Unauthorized -
      400 Bad Request -

    • deleteTag

      public void deleteTag(TemplateTag templateTag) throws ApiException
      Delete the Tags in Templates.
      Parameters:
      templateTag - Contains TemplateId and LabelNames for Adding Tags. (optional)
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      Http Response Details:
      Status Code Description Response Headers
      200 OK -
      401 Unauthorized -
      400 Bad Request -

    • deleteTagWithHttpInfo

      public ApiResponse<Void> deleteTagWithHttpInfo(TemplateTag templateTag) throws ApiException
      Delete the Tags in Templates.
      Parameters:
      templateTag - Contains TemplateId and LabelNames for Adding Tags. (optional)
      Returns:
      ApiResponse<Void>
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      Http Response Details:
      Status Code Description Response Headers
      200 OK -
      401 Unauthorized -
      400 Bad Request -

    • deleteTagAsync

      public okhttp3.Call deleteTagAsync(TemplateTag templateTag, ApiCallback<Void> _callback) throws ApiException
      Delete the Tags in Templates. (asynchronously)
      Parameters:
      templateTag - Contains TemplateId and LabelNames for Adding Tags. (optional)
      _callback - The callback to be executed when the API call finishes
      Returns:
      The request call
      Throws:
      ApiException - If fail to process the API call, e.g. serializing the request body object
      Http Response Details:
      Status Code Description Response Headers
      200 OK -
      401 Unauthorized -
      400 Bad Request -

    • downloadCall

      public okhttp3.Call downloadCall(String templateId, String onBehalfOf, ApiCallback _callback) throws ApiException
      Build call for download
      Parameters:
      templateId - Template Id. (required)
      onBehalfOf - The on behalfof email address. (optional)
      _callback - Callback for upload/download progress
      Returns:
      Call to execute
      Throws:
      ApiException - If fail to serialize the request body object
      Http Response Details:
      Status Code Description Response Headers
      200 OK -
      401 Unauthorized -
      400 Bad Request -

    • download

      public File download(String templateId, String onBehalfOf) throws ApiException
      Download the template.
      Parameters:
      templateId - Template Id. (required)
      onBehalfOf - The on behalfof email address. (optional)
      Returns:
      File
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      Http Response Details:
      Status Code Description Response Headers
      200 OK -
      401 Unauthorized -
      400 Bad Request -

    • downloadWithHttpInfo

      public ApiResponse<File> downloadWithHttpInfo(String templateId, String onBehalfOf) throws ApiException
      Download the template.
      Parameters:
      templateId - Template Id. (required)
      onBehalfOf - The on behalfof email address. (optional)
      Returns:
      ApiResponse<File>
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      Http Response Details:
      Status Code Description Response Headers
      200 OK -
      401 Unauthorized -
      400 Bad Request -

    • downloadAsync

      public okhttp3.Call downloadAsync(String templateId, String onBehalfOf, ApiCallback<File> _callback) throws ApiException
      Download the template. (asynchronously)
      Parameters:
      templateId - Template Id. (required)
      onBehalfOf - The on behalfof email address. (optional)
      _callback - The callback to be executed when the API call finishes
      Returns:
      The request call
      Throws:
      ApiException - If fail to process the API call, e.g. serializing the request body object
      Http Response Details:
      Status Code Description Response Headers
      200 OK -
      401 Unauthorized -
      400 Bad Request -

    • editTemplateCall

      public okhttp3.Call editTemplateCall(String templateId, EditTemplateRequest editTemplateRequest, ApiCallback _callback) throws ApiException
      Build call for editTemplate
      Parameters:
      templateId - The template id. (required)
      editTemplateRequest - The edit template request body. (required)
      _callback - Callback for upload/download progress
      Returns:
      Call to execute
      Throws:
      ApiException - If fail to serialize the request body object
      Http Response Details:
      Status Code Description Response Headers
      204 No Content -
      400 Bad Request -
      422 Unprocessable Content -
      401 Unauthorized -

    • editTemplate

      public void editTemplate(String templateId, EditTemplateRequest editTemplateRequest) throws ApiException
      Edit and updates an existing template.
      Parameters:
      templateId - The template id. (required)
      editTemplateRequest - The edit template request body. (required)
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      Http Response Details:
      Status Code Description Response Headers
      204 No Content -
      400 Bad Request -
      422 Unprocessable Content -
      401 Unauthorized -

    • editTemplateWithHttpInfo

      public ApiResponse<Void> editTemplateWithHttpInfo(String templateId, EditTemplateRequest editTemplateRequest) throws ApiException
      Edit and updates an existing template.
      Parameters:
      templateId - The template id. (required)
      editTemplateRequest - The edit template request body. (required)
      Returns:
      ApiResponse<Void>
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      Http Response Details:
      Status Code Description Response Headers
      204 No Content -
      400 Bad Request -
      422 Unprocessable Content -
      401 Unauthorized -

    • editTemplateAsync

      public okhttp3.Call editTemplateAsync(String templateId, EditTemplateRequest editTemplateRequest, ApiCallback<Void> _callback) throws ApiException
      Edit and updates an existing template. (asynchronously)
      Parameters:
      templateId - The template id. (required)
      editTemplateRequest - The edit template request body. (required)
      _callback - The callback to be executed when the API call finishes
      Returns:
      The request call
      Throws:
      ApiException - If fail to process the API call, e.g. serializing the request body object
      Http Response Details:
      Status Code Description Response Headers
      204 No Content -
      400 Bad Request -
      422 Unprocessable Content -
      401 Unauthorized -

    • getEmbeddedTemplateEditUrlCall

      public okhttp3.Call getEmbeddedTemplateEditUrlCall(String templateId, EmbeddedTemplateEditRequest embeddedTemplateEditRequest, ApiCallback _callback) throws ApiException
      Build call for getEmbeddedTemplateEditUrl
      Parameters:
      templateId - The template id. (required)
      embeddedTemplateEditRequest - The embedded edit template request body. (optional)
      _callback - Callback for upload/download progress
      Returns:
      Call to execute
      Throws:
      ApiException - If fail to serialize the request body object
      Http Response Details:
      Status Code Description Response Headers
      201 Created -
      400 Bad Request -
      401 Unauthorized -

    • getEmbeddedTemplateEditUrl

      public EmbeddedTemplateEdited getEmbeddedTemplateEditUrl(String templateId, EmbeddedTemplateEditRequest embeddedTemplateEditRequest) throws ApiException
      Generates a edit URL to embeds template edit process into your application.
      Parameters:
      templateId - The template id. (required)
      embeddedTemplateEditRequest - The embedded edit template request body. (optional)
      Returns:
      EmbeddedTemplateEdited
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      Http Response Details:
      Status Code Description Response Headers
      201 Created -
      400 Bad Request -
      401 Unauthorized -

    • getEmbeddedTemplateEditUrlWithHttpInfo

      public ApiResponse<EmbeddedTemplateEdited> getEmbeddedTemplateEditUrlWithHttpInfo(String templateId, EmbeddedTemplateEditRequest embeddedTemplateEditRequest) throws ApiException
      Generates a edit URL to embeds template edit process into your application.
      Parameters:
      templateId - The template id. (required)
      embeddedTemplateEditRequest - The embedded edit template request body. (optional)
      Returns:
      ApiResponse<EmbeddedTemplateEdited>
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      Http Response Details:
      Status Code Description Response Headers
      201 Created -
      400 Bad Request -
      401 Unauthorized -

    • getEmbeddedTemplateEditUrlAsync

      public okhttp3.Call getEmbeddedTemplateEditUrlAsync(String templateId, EmbeddedTemplateEditRequest embeddedTemplateEditRequest, ApiCallback<EmbeddedTemplateEdited> _callback) throws ApiException
      Generates a edit URL to embeds template edit process into your application. (asynchronously)
      Parameters:
      templateId - The template id. (required)
      embeddedTemplateEditRequest - The embedded edit template request body. (optional)
      _callback - The callback to be executed when the API call finishes
      Returns:
      The request call
      Throws:
      ApiException - If fail to process the API call, e.g. serializing the request body object
      Http Response Details:
      Status Code Description Response Headers
      201 Created -
      400 Bad Request -
      401 Unauthorized -

    • getPropertiesCall

      public okhttp3.Call getPropertiesCall(String templateId, ApiCallback _callback) throws ApiException
      Build call for getProperties
      Parameters:
      templateId - Template Id. (required)
      _callback - Callback for upload/download progress
      Returns:
      Call to execute
      Throws:
      ApiException - If fail to serialize the request body object
      Http Response Details:
      Status Code Description Response Headers
      200 OK -
      401 Unauthorized -
      403 Forbidden -

    • getProperties

      public TemplateProperties getProperties(String templateId) throws ApiException
      Get summary of the template.
      Parameters:
      templateId - Template Id. (required)
      Returns:
      TemplateProperties
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      Http Response Details:
      Status Code Description Response Headers
      200 OK -
      401 Unauthorized -
      403 Forbidden -

    • getPropertiesWithHttpInfo

      public ApiResponse<TemplateProperties> getPropertiesWithHttpInfo(String templateId) throws ApiException
      Get summary of the template.
      Parameters:
      templateId - Template Id. (required)
      Returns:
      ApiResponse<TemplateProperties>
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      Http Response Details:
      Status Code Description Response Headers
      200 OK -
      401 Unauthorized -
      403 Forbidden -

    • getPropertiesAsync

      public okhttp3.Call getPropertiesAsync(String templateId, ApiCallback<TemplateProperties> _callback) throws ApiException
      Get summary of the template. (asynchronously)
      Parameters:
      templateId - Template Id. (required)
      _callback - The callback to be executed when the API call finishes
      Returns:
      The request call
      Throws:
      ApiException - If fail to process the API call, e.g. serializing the request body object
      Http Response Details:
      Status Code Description Response Headers
      200 OK -
      401 Unauthorized -
      403 Forbidden -

    • listTemplatesCall

      public okhttp3.Call listTemplatesCall(Integer page, String templateType, Integer pageSize, String searchKey, List<String> onBehalfOf, List<String> createdBy, List<String> templateLabels, OffsetDateTime startDate, OffsetDateTime endDate, List<String> brandIds, ApiCallback _callback) throws ApiException
      Build call for listTemplates
      Parameters:
      page - (required)
      templateType - (optional)
      pageSize - (optional, default to 10)
      searchKey - (optional)
      onBehalfOf - The sender identity's email used to filter the templates returned in the API. The API will return templates that were sent on behalf of the specified email address. (optional)
      createdBy - The templates can be listed by the creator of the template. (optional)
      templateLabels - Labels of the template. (optional)
      startDate - Start date of the template (optional)
      endDate - End date of the template (optional)
      brandIds - BrandId(s) of the template. (optional)
      _callback - Callback for upload/download progress
      Returns:
      Call to execute
      Throws:
      ApiException - If fail to serialize the request body object
      Http Response Details:
      Status Code Description Response Headers
      200 OK -
      401 Unauthorized -

    • listTemplates

      public TemplateRecords listTemplates(Integer page, String templateType, Integer pageSize, String searchKey, List<String> onBehalfOf, List<String> createdBy, List<String> templateLabels, OffsetDateTime startDate, OffsetDateTime endDate, List<String> brandIds) throws ApiException
      List all the templates.
      Parameters:
      page - (required)
      templateType - (optional)
      pageSize - (optional, default to 10)
      searchKey - (optional)
      onBehalfOf - The sender identity's email used to filter the templates returned in the API. The API will return templates that were sent on behalf of the specified email address. (optional)
      createdBy - The templates can be listed by the creator of the template. (optional)
      templateLabels - Labels of the template. (optional)
      startDate - Start date of the template (optional)
      endDate - End date of the template (optional)
      brandIds - BrandId(s) of the template. (optional)
      Returns:
      TemplateRecords
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      Http Response Details:
      Status Code Description Response Headers
      200 OK -
      401 Unauthorized -

    • listTemplatesWithHttpInfo

      public ApiResponse<TemplateRecords> listTemplatesWithHttpInfo(Integer page, String templateType, Integer pageSize, String searchKey, List<String> onBehalfOf, List<String> createdBy, List<String> templateLabels, OffsetDateTime startDate, OffsetDateTime endDate, List<String> brandIds) throws ApiException
      List all the templates.
      Parameters:
      page - (required)
      templateType - (optional)
      pageSize - (optional, default to 10)
      searchKey - (optional)
      onBehalfOf - The sender identity's email used to filter the templates returned in the API. The API will return templates that were sent on behalf of the specified email address. (optional)
      createdBy - The templates can be listed by the creator of the template. (optional)
      templateLabels - Labels of the template. (optional)
      startDate - Start date of the template (optional)
      endDate - End date of the template (optional)
      brandIds - BrandId(s) of the template. (optional)
      Returns:
      ApiResponse<TemplateRecords>
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      Http Response Details:
      Status Code Description Response Headers
      200 OK -
      401 Unauthorized -

    • listTemplatesAsync

      public okhttp3.Call listTemplatesAsync(Integer page, String templateType, Integer pageSize, String searchKey, List<String> onBehalfOf, List<String> createdBy, List<String> templateLabels, OffsetDateTime startDate, OffsetDateTime endDate, List<String> brandIds, ApiCallback<TemplateRecords> _callback) throws ApiException
      List all the templates. (asynchronously)
      Parameters:
      page - (required)
      templateType - (optional)
      pageSize - (optional, default to 10)
      searchKey - (optional)
      onBehalfOf - The sender identity's email used to filter the templates returned in the API. The API will return templates that were sent on behalf of the specified email address. (optional)
      createdBy - The templates can be listed by the creator of the template. (optional)
      templateLabels - Labels of the template. (optional)
      startDate - Start date of the template (optional)
      endDate - End date of the template (optional)
      brandIds - BrandId(s) of the template. (optional)
      _callback - The callback to be executed when the API call finishes
      Returns:
      The request call
      Throws:
      ApiException - If fail to process the API call, e.g. serializing the request body object
      Http Response Details:
      Status Code Description Response Headers
      200 OK -
      401 Unauthorized -

    • mergeAndSendCall

      public okhttp3.Call mergeAndSendCall(MergeAndSendForSignForm mergeAndSendForSignForm, ApiCallback _callback) throws ApiException
      Build call for mergeAndSend
      Parameters:
      mergeAndSendForSignForm - The merge and send details as JSON. (optional)
      _callback - Callback for upload/download progress
      Returns:
      Call to execute
      Throws:
      ApiException - If fail to serialize the request body object
      Http Response Details:
      Status Code Description Response Headers
      201 Created -
      422 Unprocessable Content -
      401 Unauthorized -

    • mergeAndSend

      public DocumentCreated mergeAndSend(MergeAndSendForSignForm mergeAndSendForSignForm) throws ApiException
      Send the document by merging multiple templates.
      Parameters:
      mergeAndSendForSignForm - The merge and send details as JSON. (optional)
      Returns:
      DocumentCreated
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      Http Response Details:
      Status Code Description Response Headers
      201 Created -
      422 Unprocessable Content -
      401 Unauthorized -

    • mergeAndSendWithHttpInfo

      public ApiResponse<DocumentCreated> mergeAndSendWithHttpInfo(MergeAndSendForSignForm mergeAndSendForSignForm) throws ApiException
      Send the document by merging multiple templates.
      Parameters:
      mergeAndSendForSignForm - The merge and send details as JSON. (optional)
      Returns:
      ApiResponse<DocumentCreated>
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      Http Response Details:
      Status Code Description Response Headers
      201 Created -
      422 Unprocessable Content -
      401 Unauthorized -

    • mergeAndSendAsync

      public okhttp3.Call mergeAndSendAsync(MergeAndSendForSignForm mergeAndSendForSignForm, ApiCallback<DocumentCreated> _callback) throws ApiException
      Send the document by merging multiple templates. (asynchronously)
      Parameters:
      mergeAndSendForSignForm - The merge and send details as JSON. (optional)
      _callback - The callback to be executed when the API call finishes
      Returns:
      The request call
      Throws:
      ApiException - If fail to process the API call, e.g. serializing the request body object
      Http Response Details:
      Status Code Description Response Headers
      201 Created -
      422 Unprocessable Content -
      401 Unauthorized -

    • mergeCreateEmbeddedRequestUrlTemplateCall

      public okhttp3.Call mergeCreateEmbeddedRequestUrlTemplateCall(EmbeddedMergeTemplateFormRequest embeddedMergeTemplateFormRequest, ApiCallback _callback) throws ApiException
      Build call for mergeCreateEmbeddedRequestUrlTemplate
      Parameters:
      embeddedMergeTemplateFormRequest - Embedded merge and send template json request. (optional)
      _callback - Callback for upload/download progress
      Returns:
      Call to execute
      Throws:
      ApiException - If fail to serialize the request body object
      Http Response Details:
      Status Code Description Response Headers
      201 Created -
      422 Unprocessable Content -
      401 Unauthorized -

    • mergeCreateEmbeddedRequestUrlTemplate

      public EmbeddedSendCreated mergeCreateEmbeddedRequestUrlTemplate(EmbeddedMergeTemplateFormRequest embeddedMergeTemplateFormRequest) throws ApiException
      Generates a merge request URL using a template that combines document merging and sending processes into your application.
      Parameters:
      embeddedMergeTemplateFormRequest - Embedded merge and send template json request. (optional)
      Returns:
      EmbeddedSendCreated
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      Http Response Details:
      Status Code Description Response Headers
      201 Created -
      422 Unprocessable Content -
      401 Unauthorized -

    • mergeCreateEmbeddedRequestUrlTemplateWithHttpInfo

      public ApiResponse<EmbeddedSendCreated> mergeCreateEmbeddedRequestUrlTemplateWithHttpInfo(EmbeddedMergeTemplateFormRequest embeddedMergeTemplateFormRequest) throws ApiException
      Generates a merge request URL using a template that combines document merging and sending processes into your application.
      Parameters:
      embeddedMergeTemplateFormRequest - Embedded merge and send template json request. (optional)
      Returns:
      ApiResponse<EmbeddedSendCreated>
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      Http Response Details:
      Status Code Description Response Headers
      201 Created -
      422 Unprocessable Content -
      401 Unauthorized -

    • mergeCreateEmbeddedRequestUrlTemplateAsync

      public okhttp3.Call mergeCreateEmbeddedRequestUrlTemplateAsync(EmbeddedMergeTemplateFormRequest embeddedMergeTemplateFormRequest, ApiCallback<EmbeddedSendCreated> _callback) throws ApiException
      Generates a merge request URL using a template that combines document merging and sending processes into your application. (asynchronously)
      Parameters:
      embeddedMergeTemplateFormRequest - Embedded merge and send template json request. (optional)
      _callback - The callback to be executed when the API call finishes
      Returns:
      The request call
      Throws:
      ApiException - If fail to process the API call, e.g. serializing the request body object
      Http Response Details:
      Status Code Description Response Headers
      201 Created -
      422 Unprocessable Content -
      401 Unauthorized -

    • sendUsingTemplateCall

      public okhttp3.Call sendUsingTemplateCall(String templateId, SendForSignFromTemplateForm sendForSignFromTemplateForm, ApiCallback _callback) throws ApiException
      Build call for sendUsingTemplate
      Parameters:
      templateId - The template id. (required)
      sendForSignFromTemplateForm - The send template details as JSON. (optional)
      _callback - Callback for upload/download progress
      Returns:
      Call to execute
      Throws:
      ApiException - If fail to serialize the request body object
      Http Response Details:
      Status Code Description Response Headers
      201 Created -
      401 Unauthorized -
      422 Unprocessable Content -

    • sendUsingTemplate

      public DocumentCreated sendUsingTemplate(String templateId, SendForSignFromTemplateForm sendForSignFromTemplateForm) throws ApiException
      Send a document for signature using a Template.
      Parameters:
      templateId - The template id. (required)
      sendForSignFromTemplateForm - The send template details as JSON. (optional)
      Returns:
      DocumentCreated
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      Http Response Details:
      Status Code Description Response Headers
      201 Created -
      401 Unauthorized -
      422 Unprocessable Content -

    • sendUsingTemplateWithHttpInfo

      public ApiResponse<DocumentCreated> sendUsingTemplateWithHttpInfo(String templateId, SendForSignFromTemplateForm sendForSignFromTemplateForm) throws ApiException
      Send a document for signature using a Template.
      Parameters:
      templateId - The template id. (required)
      sendForSignFromTemplateForm - The send template details as JSON. (optional)
      Returns:
      ApiResponse<DocumentCreated>
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      Http Response Details:
      Status Code Description Response Headers
      201 Created -
      401 Unauthorized -
      422 Unprocessable Content -

    • sendUsingTemplateAsync

      public okhttp3.Call sendUsingTemplateAsync(String templateId, SendForSignFromTemplateForm sendForSignFromTemplateForm, ApiCallback<DocumentCreated> _callback) throws ApiException
      Send a document for signature using a Template. (asynchronously)
      Parameters:
      templateId - The template id. (required)
      sendForSignFromTemplateForm - The send template details as JSON. (optional)
      _callback - The callback to be executed when the API call finishes
      Returns:
      The request call
      Throws:
      ApiException - If fail to process the API call, e.g. serializing the request body object
      Http Response Details:
      Status Code Description Response Headers
      201 Created -
      401 Unauthorized -
      422 Unprocessable Content -