DodoPayments.Brands (dodo_payments v0.1.0)

Brand and brand-image operations.

Summary

Types

Parameters for brands_archive. Exact fields use atom keys; string-keyed and mixed-key maps remain supported. Source: locked upstream resources/brands.ts declaration BrandArchiveParams.

create_params()

Parameters for brands_create. Exact fields use atom keys; string-keyed and mixed-key maps remain supported. Source: locked upstream resources/brands.ts declaration BrandCreateParams.

list_params()

Parameters for brands_list. Exact fields use atom keys; string-keyed and mixed-key maps remain supported. Source: locked upstream resources/brands.ts declaration BrandListParams.

update_params()

Parameters for brands_update. Exact fields use atom keys; string-keyed and mixed-key maps remain supported. Source: locked upstream resources/brands.ts declaration BrandUpdateParams.

Functions

archive(client, id)

Calls Dodo operation brands_archive (POST /brands/{id}/archive). Required parameters: none.

archive(client, id, opts)

Calls Dodo operation brands_archive (POST /brands/{id}/archive). Required parameters: none.

archive(client, id, params, opts)

Calls Dodo operation brands_archive (POST /brands/{id}/archive). Required parameters: none.

create(client)

Calls Dodo operation brands_create (POST /brands). Required parameters: none.

create(client, opts)

Calls Dodo operation brands_create (POST /brands). Required parameters: none.

create(client, params, opts)

Calls Dodo operation brands_create (POST /brands). Required parameters: none.

list(client)

Calls Dodo operation brands_list (GET /brands). Required parameters: none.

list(client, opts)

Calls Dodo operation brands_list (GET /brands). Required parameters: none.

list(client, params, opts)

Calls Dodo operation brands_list (GET /brands). Required parameters: none.

retrieve(client, id, opts \\ [])

Calls Dodo operation brands_retrieve (GET /brands/{id}). Required parameters: none.

update(client, id)

Calls Dodo operation brands_update (PATCH /brands/{id}). Required parameters: none.

update(client, id, opts)

Calls Dodo operation brands_update (PATCH /brands/{id}). Required parameters: none.

update(client, id, params, opts)

Calls Dodo operation brands_update (PATCH /brands/{id}). Required parameters: none.

update_images(client, id, opts \\ [])

Calls Dodo operation brands_update_images (PUT /brands/{id}/images). Required parameters: none.

Types

archive_params()

@type archive_params() ::
  %{
    optional(:move_products_to) => String.t(),
    optional(String.t()) => DodoPayments.RequestTypes.input_value()
  }
  | DodoPayments.RequestTypes.compatibility_params()

Parameters for brands_archive. Exact fields use atom keys; string-keyed and mixed-key maps remain supported. Source: locked upstream resources/brands.ts declaration BrandArchiveParams.

create_params()

@type create_params() ::
  %{
    optional(:description) => String.t(),
    optional(:name) => String.t(),
    optional(:statement_descriptor) => String.t(),
    optional(:support_email) => String.t(),
    optional(:url) => String.t(),
    optional(String.t()) => DodoPayments.RequestTypes.input_value()
  }
  | DodoPayments.RequestTypes.compatibility_params()

Parameters for brands_create. Exact fields use atom keys; string-keyed and mixed-key maps remain supported. Source: locked upstream resources/brands.ts declaration BrandCreateParams.

list_params()

@type list_params() ::
  %{
    optional(:include_archived) => boolean(),
    optional(String.t()) => DodoPayments.RequestTypes.input_value()
  }
  | DodoPayments.RequestTypes.compatibility_params()

Parameters for brands_list. Exact fields use atom keys; string-keyed and mixed-key maps remain supported. Source: locked upstream resources/brands.ts declaration BrandListParams.

update_params()

@type update_params() ::
  %{
    optional(:description) => String.t(),
    optional(:image_id) => String.t(),
    optional(:name) => String.t(),
    optional(:statement_descriptor) => String.t(),
    optional(:support_email) => String.t(),
    optional(:url) => String.t(),
    optional(String.t()) => DodoPayments.RequestTypes.input_value()
  }
  | DodoPayments.RequestTypes.compatibility_params()

Parameters for brands_update. Exact fields use atom keys; string-keyed and mixed-key maps remain supported. Source: locked upstream resources/brands.ts declaration BrandUpdateParams.

Functions

archive(client, id)

@spec archive(DodoPayments.Client.t(), String.t() | integer()) ::
  {:ok, DodoPayments.BrandArchiveResponse.t()} | {:error, Exception.t()}

Calls Dodo operation brands_archive (POST /brands/{id}/archive). Required parameters: none.

Calls the operation with an empty parameter map.

archive(client, id, opts)

@spec archive(
  DodoPayments.Client.t(),
  String.t() | integer(),
  archive_params() | nil | keyword()
) ::
  {:ok,
   DodoPayments.BrandArchiveResponse.t()
   | DodoPayments.Response.t(DodoPayments.BrandArchiveResponse.t())}
  | {:error, Exception.t()}

Calls Dodo operation brands_archive (POST /brands/{id}/archive). Required parameters: none.

Pass a map for Dodo parameters or a keyword list for request-local options.

archive(client, id, params, opts)

@spec archive(
  DodoPayments.Client.t(),
  String.t() | integer(),
  archive_params() | nil,
  keyword()
) ::
  {:ok,
   DodoPayments.BrandArchiveResponse.t()
   | DodoPayments.Response.t(DodoPayments.BrandArchiveResponse.t())}
  | {:error, Exception.t()}

Calls Dodo operation brands_archive (POST /brands/{id}/archive). Required parameters: none.

Accepts both a Dodo parameter map and request-local options.

create(client)

@spec create(DodoPayments.Client.t()) ::
  {:ok, DodoPayments.Brand.t()} | {:error, Exception.t()}

Calls Dodo operation brands_create (POST /brands). Required parameters: none.

Calls the operation with an empty parameter map.

create(client, opts)

@spec create(DodoPayments.Client.t(), create_params() | nil | keyword()) ::
  {:ok,
   DodoPayments.Brand.t() | DodoPayments.Response.t(DodoPayments.Brand.t())}
  | {:error, Exception.t()}

Calls Dodo operation brands_create (POST /brands). Required parameters: none.

Pass a map for Dodo parameters or a keyword list for request-local options.

create(client, params, opts)

@spec create(DodoPayments.Client.t(), create_params() | nil, keyword()) ::
  {:ok,
   DodoPayments.Brand.t() | DodoPayments.Response.t(DodoPayments.Brand.t())}
  | {:error, Exception.t()}

Calls Dodo operation brands_create (POST /brands). Required parameters: none.

Accepts both a Dodo parameter map and request-local options.

list(client)

@spec list(DodoPayments.Client.t()) ::
  {:ok, DodoPayments.BrandListResponse.t()} | {:error, Exception.t()}

Calls Dodo operation brands_list (GET /brands). Required parameters: none.

Calls the operation with an empty parameter map.

list(client, opts)

@spec list(DodoPayments.Client.t(), list_params() | nil | keyword()) ::
  {:ok,
   DodoPayments.BrandListResponse.t()
   | DodoPayments.Response.t(DodoPayments.BrandListResponse.t())}
  | {:error, Exception.t()}

Calls Dodo operation brands_list (GET /brands). Required parameters: none.

Pass a map for Dodo parameters or a keyword list for request-local options.

list(client, params, opts)

@spec list(DodoPayments.Client.t(), list_params() | nil, keyword()) ::
  {:ok,
   DodoPayments.BrandListResponse.t()
   | DodoPayments.Response.t(DodoPayments.BrandListResponse.t())}
  | {:error, Exception.t()}

Calls Dodo operation brands_list (GET /brands). Required parameters: none.

Accepts both a Dodo parameter map and request-local options.

retrieve(client, id, opts \\ [])

@spec retrieve(DodoPayments.Client.t(), String.t() | integer(), keyword()) ::
  {:ok,
   DodoPayments.Brand.t() | DodoPayments.Response.t(DodoPayments.Brand.t())}
  | {:error, Exception.t()}

Calls Dodo operation brands_retrieve (GET /brands/{id}). Required parameters: none.

Options are request-local.

update(client, id)

@spec update(DodoPayments.Client.t(), String.t() | integer()) ::
  {:ok, DodoPayments.Brand.t()} | {:error, Exception.t()}

Calls Dodo operation brands_update (PATCH /brands/{id}). Required parameters: none.

Calls the operation with an empty parameter map.

update(client, id, opts)

@spec update(
  DodoPayments.Client.t(),
  String.t() | integer(),
  update_params() | nil | keyword()
) ::
  {:ok,
   DodoPayments.Brand.t() | DodoPayments.Response.t(DodoPayments.Brand.t())}
  | {:error, Exception.t()}

Calls Dodo operation brands_update (PATCH /brands/{id}). Required parameters: none.

Pass a map for Dodo parameters or a keyword list for request-local options.

update(client, id, params, opts)

@spec update(
  DodoPayments.Client.t(),
  String.t() | integer(),
  update_params() | nil,
  keyword()
) ::
  {:ok,
   DodoPayments.Brand.t() | DodoPayments.Response.t(DodoPayments.Brand.t())}
  | {:error, Exception.t()}

Calls Dodo operation brands_update (PATCH /brands/{id}). Required parameters: none.

Accepts both a Dodo parameter map and request-local options.

update_images(client, id, opts \\ [])

@spec update_images(DodoPayments.Client.t(), String.t() | integer(), keyword()) ::
  {:ok,
   DodoPayments.PresignedImageUpload.t()
   | DodoPayments.Response.t(DodoPayments.PresignedImageUpload.t())}
  | {:error, Exception.t()}

Calls Dodo operation brands_update_images (PUT /brands/{id}/images). Required parameters: none.

Options are request-local.