DodoPayments.Products.ShortLinks (dodo_payments v0.1.0)

Product short-link operations.

Summary

Types

Parameters for product_short_links_create. Exact fields use atom keys; string-keyed and mixed-key maps remain supported. Source: locked upstream resources/products/short-links.ts declaration ShortLinkCreateParams.

list_params()

Parameters for product_short_links_list. Exact fields use atom keys; string-keyed and mixed-key maps remain supported. Source: locked upstream resources/products/short-links.ts declaration ShortLinkListParams.

Functions

create(client, id, params)

Calls Dodo operation product_short_links_create (POST /products/{id}/short_links). Required parameters: :slug.

create(client, id, params, opts)

Calls Dodo operation product_short_links_create (POST /products/{id}/short_links). Required parameters: :slug.

list(client)

Calls Dodo operation product_short_links_list (GET /products/short_links). Required parameters: none. Numbered pagination is zero-based.

list(client, opts)

Calls Dodo operation product_short_links_list (GET /products/short_links). Required parameters: none. Numbered pagination is zero-based.

list(client, params, opts)

Calls Dodo operation product_short_links_list (GET /products/short_links). Required parameters: none. Numbered pagination is zero-based.

Types

create_params()

@type create_params() ::
  %{
    :slug => String.t(),
    optional(:static_checkout_params) => DodoPayments.RequestTypes.string_map(),
    optional(String.t()) => DodoPayments.RequestTypes.input_value()
  }
  | DodoPayments.RequestTypes.compatibility_params()

list_params()

@type list_params() ::
  %{
    optional(:page_number) => number(),
    optional(:page_size) => number(),
    optional(:product_id) => String.t(),
    optional(String.t()) => DodoPayments.RequestTypes.input_value()
  }
  | DodoPayments.RequestTypes.compatibility_params()

Functions

create(client, id, params)

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

Calls Dodo operation product_short_links_create (POST /products/{id}/short_links). Required parameters: :slug.

API parameters must be supplied as a map.

create(client, id, params, opts)

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

Calls Dodo operation product_short_links_create (POST /products/{id}/short_links). Required parameters: :slug.

The final argument contains request-local options.

list(client)

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

Calls Dodo operation product_short_links_list (GET /products/short_links). Required parameters: none. Numbered pagination is zero-based.

Calls the operation with an empty parameter map.

list(client, opts)

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

Calls Dodo operation product_short_links_list (GET /products/short_links). Required parameters: none. Numbered pagination is zero-based.

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.Page.Numbered.t(DodoPayments.ShortLink.t())
   | DodoPayments.Response.t(
       DodoPayments.Page.Numbered.t(DodoPayments.ShortLink.t())
     )}
  | {:error, Exception.t()}

Calls Dodo operation product_short_links_list (GET /products/short_links). Required parameters: none. Numbered pagination is zero-based.

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