DodoPayments.Refunds (dodo_payments v0.1.0)

Refund creation and inspection.

Summary

Types

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

list_params()

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

Functions

create(client, params)

Calls Dodo operation refunds_create (POST /refunds). Required parameters: :payment_id.

create(client, params, opts)

Calls Dodo operation refunds_create (POST /refunds). Required parameters: :payment_id.

list(client)

Calls Dodo operation refunds_list (GET /refunds). Required parameters: none. Numbered pagination is zero-based.

list(client, opts)

Calls Dodo operation refunds_list (GET /refunds). Required parameters: none. Numbered pagination is zero-based.

list(client, params, opts)

Calls Dodo operation refunds_list (GET /refunds). Required parameters: none. Numbered pagination is zero-based.

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

Calls Dodo operation refunds_retrieve (GET /refunds/{refund_id}). Required parameters: none.

Types

create_params()

@type create_params() ::
  %{
    :payment_id => String.t(),
    optional(:items) => [DodoPayments.RequestTypes.refund_item()],
    optional(:metadata) => DodoPayments.RequestTypes.flat_metadata(),
    optional(:reason) => String.t(),
    optional(String.t()) => DodoPayments.RequestTypes.input_value()
  }
  | DodoPayments.RequestTypes.compatibility_params()

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

list_params()

@type list_params() ::
  %{
    optional(:page_number) => number(),
    optional(:page_size) => number(),
    optional(:created_at_gte) => String.t(),
    optional(:created_at_lte) => String.t(),
    optional(:customer_id) => String.t(),
    optional(:status) => DodoPayments.Enums.refund_status(),
    optional(:subscription_id) => String.t(),
    optional(String.t()) => DodoPayments.RequestTypes.input_value()
  }
  | DodoPayments.RequestTypes.compatibility_params()

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

Functions

create(client, params)

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

Calls Dodo operation refunds_create (POST /refunds). Required parameters: :payment_id.

API parameters must be supplied as a map.

create(client, params, opts)

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

Calls Dodo operation refunds_create (POST /refunds). Required parameters: :payment_id.

The final argument contains request-local options.

list(client)

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

Calls Dodo operation refunds_list (GET /refunds). 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.Refund.t())
   | DodoPayments.Response.t(
       DodoPayments.Page.Numbered.t(DodoPayments.Refund.t())
     )}
  | {:error, Exception.t()}

Calls Dodo operation refunds_list (GET /refunds). 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.Refund.t())
   | DodoPayments.Response.t(
       DodoPayments.Page.Numbered.t(DodoPayments.Refund.t())
     )}
  | {:error, Exception.t()}

Calls Dodo operation refunds_list (GET /refunds). Required parameters: none. Numbered pagination is zero-based.

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

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

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

Calls Dodo operation refunds_retrieve (GET /refunds/{refund_id}). Required parameters: none.

Options are request-local.