DodoPayments.Products.LocalizedPrices (dodo_payments v0.1.0)

Localized price operations for a product.

Summary

Types

Parameters for localized_prices_create. Exact fields use atom keys; string-keyed and mixed-key maps remain supported. Source: locked upstream resources/products/localized-prices.ts declaration LocalizedPriceCreateParams.

update_params()

Parameters for localized_prices_update. Exact fields use atom keys; string-keyed and mixed-key maps remain supported. Source: locked upstream resources/products/localized-prices.ts declaration LocalizedPriceUpdateParams.

Functions

archive(client, product_id, id, opts \\ [])

Calls Dodo operation localized_prices_archive (DELETE /products/{product_id}/localized-prices/{id}). Required parameters: none.

create(client, product_id, params)

Calls Dodo operation localized_prices_create (POST /products/{product_id}/localized-prices). Required parameters: :amount, :currency.

create(client, product_id, params, opts)

Calls Dodo operation localized_prices_create (POST /products/{product_id}/localized-prices). Required parameters: :amount, :currency.

list(client, product_id, opts \\ [])

Calls Dodo operation localized_prices_list (GET /products/{product_id}/localized-prices). Required parameters: none.

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

Calls Dodo operation localized_prices_retrieve (GET /products/{product_id}/localized-prices/{id}). Required parameters: none.

update(client, product_id, id)

Calls Dodo operation localized_prices_update (PATCH /products/{product_id}/localized-prices/{id}). Required parameters: none.

update(client, product_id, id, opts)

Calls Dodo operation localized_prices_update (PATCH /products/{product_id}/localized-prices/{id}). Required parameters: none.

update(client, product_id, id, params, opts)

Calls Dodo operation localized_prices_update (PATCH /products/{product_id}/localized-prices/{id}). Required parameters: none.

Types

create_params()

@type create_params() ::
  %{
    :amount => number(),
    :currency => DodoPayments.Enums.currency(),
    optional(:country_code) => DodoPayments.Enums.country_code(),
    optional(String.t()) => DodoPayments.RequestTypes.input_value()
  }
  | DodoPayments.RequestTypes.compatibility_params()

update_params()

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

Functions

archive(client, product_id, id, opts \\ [])

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

Calls Dodo operation localized_prices_archive (DELETE /products/{product_id}/localized-prices/{id}). Required parameters: none.

Options are request-local.

create(client, product_id, params)

@spec create(DodoPayments.Client.t(), String.t() | integer(), create_params()) ::
  {:ok, DodoPayments.LocalizedPrice.t()} | {:error, Exception.t()}

Calls Dodo operation localized_prices_create (POST /products/{product_id}/localized-prices). Required parameters: :amount, :currency.

API parameters must be supplied as a map.

create(client, product_id, params, opts)

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

Calls Dodo operation localized_prices_create (POST /products/{product_id}/localized-prices). Required parameters: :amount, :currency.

The final argument contains request-local options.

list(client, product_id, opts \\ [])

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

Calls Dodo operation localized_prices_list (GET /products/{product_id}/localized-prices). Required parameters: none.

Options are request-local.

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

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

Calls Dodo operation localized_prices_retrieve (GET /products/{product_id}/localized-prices/{id}). Required parameters: none.

Options are request-local.

update(client, product_id, id)

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

Calls Dodo operation localized_prices_update (PATCH /products/{product_id}/localized-prices/{id}). Required parameters: none.

Calls the operation with an empty parameter map.

update(client, product_id, id, opts)

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

Calls Dodo operation localized_prices_update (PATCH /products/{product_id}/localized-prices/{id}). Required parameters: none.

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

update(client, product_id, id, params, opts)

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

Calls Dodo operation localized_prices_update (PATCH /products/{product_id}/localized-prices/{id}). Required parameters: none.

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