DocuSign.Api.GroupBrands (DocuSign v0.3.3) View Source

API calls for all endpoints tagged GroupBrands.

Link to this section Summary

Functions

Deletes brand information from the requested group. Deletes brand information from the requested group.

Gets group brand ID Information. Retrieves information about the brands associated with the requested group.

Adds group brand ID information to a group. Adds group brand ID information to a group.

Link to this section Functions

Link to this function

brands_delete_group_brands(connection, account_id, group_id, opts \\ [])

View Source

Specs

brands_delete_group_brands(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword()
) :: {:ok, DocuSign.Model.GroupBrands.t()} | {:error, Tesla.Env.t()}

Deletes brand information from the requested group. Deletes brand information from the requested group.

Parameters

  • connection (DocuSign.Connection): Connection to server
  • account_id (String.t): The external account number (int) or account ID Guid.
  • group_id (String.t): The ID of the group being accessed.
  • opts (KeywordList): [optional] Optional parameters
    • :brands_request (BrandsRequest):

Returns

} on success {:error, info} on failure

Link to this function

brands_get_group_brands(connection, account_id, group_id, opts \\ [])

View Source

Specs

brands_get_group_brands(Tesla.Env.client(), String.t(), String.t(), keyword()) ::
  {:ok, DocuSign.Model.GroupBrands.t()} | {:error, Tesla.Env.t()}

Gets group brand ID Information. Retrieves information about the brands associated with the requested group.

Parameters

  • connection (DocuSign.Connection): Connection to server
  • account_id (String.t): The external account number (int) or account ID Guid.
  • group_id (String.t): The ID of the group being accessed.
  • opts (KeywordList): [optional] Optional parameters

Returns

} on success {:error, info} on failure

Link to this function

brands_put_group_brands(connection, account_id, group_id, opts \\ [])

View Source

Specs

brands_put_group_brands(Tesla.Env.client(), String.t(), String.t(), keyword()) ::
  {:ok, DocuSign.Model.GroupBrands.t()} | {:error, Tesla.Env.t()}

Adds group brand ID information to a group. Adds group brand ID information to a group.

Parameters

  • connection (DocuSign.Connection): Connection to server
  • account_id (String.t): The external account number (int) or account ID Guid.
  • group_id (String.t): The ID of the group being accessed.
  • opts (KeywordList): [optional] Optional parameters
    • :brands_request (BrandsRequest):

Returns

} on success {:error, info} on failure