docusign

# NOTE: This class is auto generated by the swagger code generator program.
# https://github.com/swagger-api/swagger-codegen.git
# Do not edit the class manually.

defmodule DocuSign.Api.GroupBrands do
  @moduledoc """
  API calls for all endpoints tagged `GroupBrands`.
  """

  alias DocuSign.Connection
  import DocuSign.RequestBuilder

  @doc """
  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

  {:ok, %DocuSign.Model.GroupBrands{}} on success
  {:error, info} on failure
  """
  @spec brands_delete_group_brands(Tesla.Env.client(), String.t(), String.t(), keyword()) ::
          {:ok, DocuSign.Model.GroupBrands.t()} | {:error, Tesla.Env.t()}
  def brands_delete_group_brands(connection, account_id, group_id, opts \\ []) do
    optional_params = %{
      brandsRequest: :body
    }

    %{}
    |> method(:delete)
    |> url("/v2/accounts/#{account_id}/groups/#{group_id}/brands")
    |> add_optional_params(optional_params, opts)
    |> Enum.into([])
    |> (&Connection.request(connection, &1)).()
    |> decode(%DocuSign.Model.GroupBrands{})
  end

  @doc """
  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

  {:ok, %DocuSign.Model.GroupBrands{}} on success
  {:error, info} on failure
  """
  @spec brands_get_group_brands(Tesla.Env.client(), String.t(), String.t(), keyword()) ::
          {:ok, DocuSign.Model.GroupBrands.t()} | {:error, Tesla.Env.t()}
  def brands_get_group_brands(connection, account_id, group_id, _opts \\ []) do
    %{}
    |> method(:get)
    |> url("/v2/accounts/#{account_id}/groups/#{group_id}/brands")
    |> Enum.into([])
    |> (&Connection.request(connection, &1)).()
    |> decode(%DocuSign.Model.GroupBrands{})
  end

  @doc """
  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

  {:ok, %DocuSign.Model.GroupBrands{}} on success
  {:error, info} on failure
  """
  @spec brands_put_group_brands(Tesla.Env.client(), String.t(), String.t(), keyword()) ::
          {:ok, DocuSign.Model.GroupBrands.t()} | {:error, Tesla.Env.t()}
  def brands_put_group_brands(connection, account_id, group_id, opts \\ []) do
    optional_params = %{
      brandsRequest: :body
    }

    %{}
    |> method(:put)
    |> url("/v2/accounts/#{account_id}/groups/#{group_id}/brands")
    |> add_optional_params(optional_params, opts)
    |> Enum.into([])
    |> (&Connection.request(connection, &1)).()
    |> decode(%DocuSign.Model.GroupBrands{})
  end
end