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

API calls for all endpoints tagged AccountBrands.

Link to this section Summary

Functions

Returns the specified account's list of branding resources (metadata).

Deletes one or more brand profiles. Deletes one or more brand profiles from an account. The Account Branding feature (accountSettings properties `canSelfBrandSend` and `canSelfBrandSend`) must be set to true to use this call.

Gets a list of brand profiles. Retrieves the list of brand profiles associated with the account and the default brand profiles. The Account Branding feature (accountSettings properties `canSelfBrandSend` and `canSelfBrandSend`) must be set to true for the account to use this call.

Creates one or more brand profile files for the account. Creates one or more brand profile files for the account. The Account Branding feature (accountSettings properties `canSelfBrandSend` and `canSelfBrandSig`) must be set to true for the account to use this call. An error is returned if `brandId` property for a brand profile is already set for the account. To upload a new version of an existing brand profile, you must delete the profile and then upload the newer version. When brand profile files are being uploaded, they must be combined into one zip file and the `Content-Type` must be `application/zip`.

Link to this section Functions

Link to this function

brand_delete_brand(connection, account_id, brand_id, opts \\ [])

View Source

Specs

brand_delete_brand(Tesla.Env.client(), String.t(), String.t(), keyword()) ::
  {:ok, nil} | {:error, Tesla.Env.t()}

Removes a brand.

Parameters

  • connection (DocuSign.Connection): Connection to server
  • account_id (String.t): The external account number (int) or account ID Guid.
  • brand_id (String.t): The unique identifier of a brand.
  • opts (KeywordList): [optional] Optional parameters

Returns

} on success {:error, info} on failure

Link to this function

brand_export_get_brand_export_file(connection, account_id, brand_id, opts \\ [])

View Source

Specs

brand_export_get_brand_export_file(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword()
) :: {:ok, nil} | {:error, Tesla.Env.t()}

Export a specific brand.

Parameters

  • connection (DocuSign.Connection): Connection to server
  • account_id (String.t): The external account number (int) or account ID Guid.
  • brand_id (String.t): The unique identifier of a brand.
  • opts (KeywordList): [optional] Optional parameters

Returns

} on success {:error, info} on failure

Link to this function

brand_get_brand(connection, account_id, brand_id, opts \\ [])

View Source

Specs

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

Get information for a specific brand.

Parameters

  • connection (DocuSign.Connection): Connection to server
  • account_id (String.t): The external account number (int) or account ID Guid.
  • brand_id (String.t): The unique identifier of a brand.
  • opts (KeywordList): [optional] Optional parameters
    • :include_external_references (String.t):
    • :include_logos (String.t):

Returns

} on success {:error, info} on failure

Link to this function

brand_logo_delete_brand_logo(connection, account_id, brand_id, logo_type, opts \\ [])

View Source

Specs

brand_logo_delete_brand_logo(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  String.t(),
  keyword()
) :: {:ok, nil} | {:error, Tesla.Env.t()}

Delete one branding logo.

Parameters

  • connection (DocuSign.Connection): Connection to server
  • account_id (String.t): The external account number (int) or account ID Guid.
  • brand_id (String.t): The unique identifier of a brand.
  • logo_type (String.t): One of Primary, Secondary or Email.
  • opts (KeywordList): [optional] Optional parameters

Returns

} on success {:error, info} on failure

Link to this function

brand_logo_get_brand_logo(connection, account_id, brand_id, logo_type, opts \\ [])

View Source

Specs

brand_logo_get_brand_logo(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  String.t(),
  keyword()
) :: {:ok, nil} | {:error, Tesla.Env.t()}

Obtains the specified image for a brand.

Parameters

  • connection (DocuSign.Connection): Connection to server
  • account_id (String.t): The external account number (int) or account ID Guid.
  • brand_id (String.t): The unique identifier of a brand.
  • logo_type (String.t): One of Primary, Secondary or Email.
  • opts (KeywordList): [optional] Optional parameters

Returns

} on success {:error, info} on failure

Link to this function

brand_logo_put_brand_logo(connection, account_id, brand_id, logo_type, opts \\ [])

View Source

Specs

brand_logo_put_brand_logo(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  String.t(),
  keyword()
) :: {:ok, nil} | {:error, Tesla.Env.t()}

Put one branding logo.

Parameters

  • connection (DocuSign.Connection): Connection to server
  • account_id (String.t): The external account number (int) or account ID Guid.
  • brand_id (String.t): The unique identifier of a brand.
  • logo_type (String.t): One of Primary, Secondary or Email.
  • opts (KeywordList): [optional] Optional parameters

Returns

} on success {:error, info} on failure

Link to this function

brand_put_brand(connection, account_id, brand_id, opts \\ [])

View Source

Specs

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

Updates an existing brand.

Parameters

  • connection (DocuSign.Connection): Connection to server
  • account_id (String.t): The external account number (int) or account ID Guid.
  • brand_id (String.t): The unique identifier of a brand.
  • opts (KeywordList): [optional] Optional parameters
    • :brand (Brand):

Returns

} on success {:error, info} on failure

Link to this function

brand_resources_get_brand_resources(connection, account_id, brand_id, resource_content_type, opts \\ [])

View Source

Specs

brand_resources_get_brand_resources(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  String.t(),
  keyword()
) :: {:ok, nil} | {:error, Tesla.Env.t()}

Returns the specified branding resource file.

Parameters

  • connection (DocuSign.Connection): Connection to server
  • account_id (String.t): The external account number (int) or account ID Guid.
  • brand_id (String.t): The unique identifier of a brand.
  • resource_content_type (String.t):
  • opts (KeywordList): [optional] Optional parameters
    • :langcode (String.t):
    • :return_master (String.t):

Returns

} on success {:error, info} on failure

Link to this function

brand_resources_get_brand_resources_list(connection, account_id, brand_id, opts \\ [])

View Source

Specs

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

Returns the specified account's list of branding resources (metadata).

Parameters

  • connection (DocuSign.Connection): Connection to server
  • account_id (String.t): The external account number (int) or account ID Guid.
  • brand_id (String.t): The unique identifier of a brand.
  • opts (KeywordList): [optional] Optional parameters

Returns

} on success {:error, info} on failure

Link to this function

brand_resources_put_brand_resources(connection, account_id, brand_id, resource_content_type, opts \\ [])

View Source

Specs

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

Uploads a branding resource file.

Parameters

  • connection (DocuSign.Connection): Connection to server
  • account_id (String.t): The external account number (int) or account ID Guid.
  • brand_id (String.t): The unique identifier of a brand.
  • resource_content_type (String.t):
  • opts (KeywordList): [optional] Optional parameters

Returns

} on success {:error, info} on failure

Link to this function

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

View Source

Specs

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

Deletes one or more brand profiles. Deletes one or more brand profiles from an account. The Account Branding feature (accountSettings properties `canSelfBrandSend` and `canSelfBrandSend`) must be set to true to use this call.

Parameters

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

Returns

} on success {:error, info} on failure

Link to this function

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

View Source

Specs

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

Gets a list of brand profiles. Retrieves the list of brand profiles associated with the account and the default brand profiles. The Account Branding feature (accountSettings properties `canSelfBrandSend` and `canSelfBrandSend`) must be set to true for the account to use this call.

Parameters

  • connection (DocuSign.Connection): Connection to server
  • account_id (String.t): The external account number (int) or account ID Guid.
  • opts (KeywordList): [optional] Optional parameters
    • :exclude_distributor_brand (String.t): When set to true, excludes distributor brand information from the response set.
    • :include_logos (String.t): When set to true, returns the logos associated with the brand.

Returns

} on success {:error, info} on failure

Link to this function

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

View Source

Specs

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

Creates one or more brand profile files for the account. Creates one or more brand profile files for the account. The Account Branding feature (accountSettings properties `canSelfBrandSend` and `canSelfBrandSig`) must be set to true for the account to use this call. An error is returned if `brandId` property for a brand profile is already set for the account. To upload a new version of an existing brand profile, you must delete the profile and then upload the newer version. When brand profile files are being uploaded, they must be combined into one zip file and the `Content-Type` must be `application/zip`.

Parameters

  • connection (DocuSign.Connection): Connection to server
  • account_id (String.t): The external account number (int) or account ID Guid.
  • opts (KeywordList): [optional] Optional parameters
    • :brand (Brand):

Returns

} on success {:error, info} on failure