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

API calls for all endpoints tagged GroupBrands.

Summary

Functions

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

Deletes brand information from a group. This method deletes one or more brands from a group.

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

Gets the brand information for a group. This method returns information about the brands associated with a group.

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

Adds an existing brand to a group. This method adds one or more existing brands to a group based on the groupId.

Functions

Link to this function

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

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

Deletes brand information from a group. This method deletes one or more brands from 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.
  • opts (keyword): Optional parameters
    • :body (BrandsRequest):

Returns

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

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

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

Gets the brand information for a group. This method returns information about the brands associated with 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.
  • opts (keyword): Optional parameters

Returns

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

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

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

Adds an existing brand to a group. This method adds one or more existing brands to a group based on the groupId.

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 (keyword): Optional parameters
    • :body (BrandsRequest):

Returns

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