View Source DocuSign.Api.FavoriteTemplates (DocuSign v1.2.0)

API calls for all endpoints tagged FavoriteTemplates.

Summary

Functions

favorite_templates_get_favorite_templates(connection, account_id, opts \\ [])

Retrieves the list of favorite templates for the account. Retrieves the list of favorite templates for the account.

favorite_templates_put_favorite_template(connection, account_id, opts \\ [])

Set one or more templates as account favorites. Set one or more templates as account favorites. Your request should include each template as a separate favoriteTemplatesContentItem JSON object, like this: { "favoriteTemplates": [ { "templateId": "6bc0584f-xxxx-xxxx-xxxx-35ab28cc44e1" }, { "templateId": "8ae9b3452-xxxx-xxxx-xxx-ac0de23fa57f" } ] }

favorite_templates_un_favorite_template(connection, account_id, opts \\ [])

Remove one or more templates from the account favorites. Remove one or more templates from the account favorites. Your request should include each template to remove as a separate favoriteTemplatesContentItem JSON object, like this: { "favoriteTemplates": [ { "templateId": "6bc0584f-xxxx-xxxx-xxxx-35ab28cc44e1" }, { "templateId": "8ae9b3452-xxxx-xxxx-xxx-ac0de23fa57f" } ] } The response includes the IDs of the templates that were successfully removed from your favorites. To get the account's remaining favorite templates, use the getFavoriteTemplates endpoint.

Functions

Link to this function

favorite_templates_get_favorite_templates(connection, account_id, opts \\ [])

View Source 
@spec favorite_templates_get_favorite_templates(
  Tesla.Env.client(),
  String.t(),
  keyword()
) ::
  {:ok, DocuSign.Model.FavoriteTemplatesInfo.t()}
  | {:ok, DocuSign.Model.ErrorDetails.t()}
  | {:error, Tesla.Env.t()}

Retrieves the list of favorite templates for the account. Retrieves the list of favorite templates for the account.

Parameters

  • connection (DocuSign.Connection): Connection to server
  • account_id (String.t): The external account number (int) or account ID GUID.
  • opts (keyword): Optional parameters

Returns

  • {:ok, DocuSign.Model.FavoriteTemplatesInfo.t} on success
  • {:error, Tesla.Env.t} on failure
Link to this function

favorite_templates_put_favorite_template(connection, account_id, opts \\ [])

View Source 
@spec favorite_templates_put_favorite_template(
  Tesla.Env.client(),
  String.t(),
  keyword()
) ::
  {:ok, DocuSign.Model.FavoriteTemplatesInfo.t()}
  | {:ok, DocuSign.Model.ErrorDetails.t()}
  | {:error, Tesla.Env.t()}

Set one or more templates as account favorites. Set one or more templates as account favorites. Your request should include each template as a separate favoriteTemplatesContentItem JSON object, like this: { "favoriteTemplates": [ { "templateId": "6bc0584f-xxxx-xxxx-xxxx-35ab28cc44e1" }, { "templateId": "8ae9b3452-xxxx-xxxx-xxx-ac0de23fa57f" } ] }

Parameters

  • connection (DocuSign.Connection): Connection to server
  • account_id (String.t): The external account number (int) or account ID GUID.
  • opts (keyword): Optional parameters
    • :body (FavoriteTemplatesInfo):

Returns

  • {:ok, DocuSign.Model.FavoriteTemplatesInfo.t} on success
  • {:error, Tesla.Env.t} on failure
Link to this function

favorite_templates_un_favorite_template(connection, account_id, opts \\ [])

View Source 
@spec favorite_templates_un_favorite_template(
  Tesla.Env.client(),
  String.t(),
  keyword()
) ::
  {:ok, DocuSign.Model.FavoriteTemplatesInfo.t()}
  | {:ok, DocuSign.Model.ErrorDetails.t()}
  | {:error, Tesla.Env.t()}

Remove one or more templates from the account favorites. Remove one or more templates from the account favorites. Your request should include each template to remove as a separate favoriteTemplatesContentItem JSON object, like this: { "favoriteTemplates": [ { "templateId": "6bc0584f-xxxx-xxxx-xxxx-35ab28cc44e1" }, { "templateId": "8ae9b3452-xxxx-xxxx-xxx-ac0de23fa57f" } ] } The response includes the IDs of the templates that were successfully removed from your favorites. To get the account's remaining favorite templates, use the getFavoriteTemplates endpoint.

Parameters

  • connection (DocuSign.Connection): Connection to server
  • account_id (String.t): The external account number (int) or account ID GUID.
  • opts (keyword): Optional parameters
    • :body (FavoriteTemplatesInfo):

Returns

  • {:ok, DocuSign.Model.FavoriteTemplatesInfo.t} on success
  • {:error, Tesla.Env.t} on failure