DodoPayments.Payouts (dodo_payments v0.1.0)

Dodo payout inspection.

Summary

Types

Parameters for payout_breakup_details_list. Exact fields use atom keys; string-keyed and mixed-key maps remain supported. Source: locked upstream resources/payouts/breakup/details.ts declaration DetailListParams.

list_params()

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

Functions

download_breakup_csv(client, payout_id, opts \\ [])

Calls Dodo operation payout_breakup_csv_download (GET /payouts/{payout_id}/breakup/details/csv). Required parameters: none.

list(client)

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

list(client, opts)

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

list(client, params, opts)

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

list_breakup_details(client, payout_id)

Calls Dodo operation payout_breakup_details_list (GET /payouts/{payout_id}/breakup/details). Required parameters: none. Numbered pagination is zero-based.

list_breakup_details(client, payout_id, opts)

Calls Dodo operation payout_breakup_details_list (GET /payouts/{payout_id}/breakup/details). Required parameters: none. Numbered pagination is zero-based.

list_breakup_details(client, payout_id, params, opts)

Calls Dodo operation payout_breakup_details_list (GET /payouts/{payout_id}/breakup/details). Required parameters: none. Numbered pagination is zero-based.

retrieve_breakup(client, payout_id, opts \\ [])

Calls Dodo operation payout_breakup_retrieve (GET /payouts/{payout_id}/breakup). Required parameters: none.

Types

list_breakup_details_params()

@type list_breakup_details_params() ::
  %{
    optional(:page_number) => number(),
    optional(:page_size) => number(),
    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(:created_at_gte) => String.t(),
    optional(:created_at_lte) => String.t(),
    optional(String.t()) => DodoPayments.RequestTypes.input_value()
  }
  | DodoPayments.RequestTypes.compatibility_params()

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

Functions

download_breakup_csv(client, payout_id, opts \\ [])

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

Calls Dodo operation payout_breakup_csv_download (GET /payouts/{payout_id}/breakup/details/csv). Required parameters: none.

Options are request-local.

list(client)

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

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

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

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

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

list_breakup_details(client, payout_id)

@spec list_breakup_details(DodoPayments.Client.t(), String.t() | integer()) ::
  {:ok, DodoPayments.Page.Numbered.t(DodoPayments.PayoutBreakupDetail.t())}
  | {:error, Exception.t()}

Calls Dodo operation payout_breakup_details_list (GET /payouts/{payout_id}/breakup/details). Required parameters: none. Numbered pagination is zero-based.

Calls the operation with an empty parameter map.

list_breakup_details(client, payout_id, opts)

@spec list_breakup_details(
  DodoPayments.Client.t(),
  String.t() | integer(),
  list_breakup_details_params() | nil | keyword()
) ::
  {:ok,
   DodoPayments.Page.Numbered.t(DodoPayments.PayoutBreakupDetail.t())
   | DodoPayments.Response.t(
       DodoPayments.Page.Numbered.t(DodoPayments.PayoutBreakupDetail.t())
     )}
  | {:error, Exception.t()}

Calls Dodo operation payout_breakup_details_list (GET /payouts/{payout_id}/breakup/details). Required parameters: none. Numbered pagination is zero-based.

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

list_breakup_details(client, payout_id, params, opts)

@spec list_breakup_details(
  DodoPayments.Client.t(),
  String.t() | integer(),
  list_breakup_details_params() | nil,
  keyword()
) ::
  {:ok,
   DodoPayments.Page.Numbered.t(DodoPayments.PayoutBreakupDetail.t())
   | DodoPayments.Response.t(
       DodoPayments.Page.Numbered.t(DodoPayments.PayoutBreakupDetail.t())
     )}
  | {:error, Exception.t()}

Calls Dodo operation payout_breakup_details_list (GET /payouts/{payout_id}/breakup/details). Required parameters: none. Numbered pagination is zero-based.

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

retrieve_breakup(client, payout_id, opts \\ [])

@spec retrieve_breakup(DodoPayments.Client.t(), String.t() | integer(), keyword()) ::
  {:ok,
   [DodoPayments.PayoutBreakupItem.t()]
   | DodoPayments.Response.t([DodoPayments.PayoutBreakupItem.t()])}
  | {:error, Exception.t()}

Calls Dodo operation payout_breakup_retrieve (GET /payouts/{payout_id}/breakup). Required parameters: none.

Options are request-local.