DodoPayments.Customers.Wallets.LedgerEntries (dodo_payments v0.1.0)

Customer wallet adjustments and history.

Summary

Types

Parameters for customer_wallet_ledger_entries_create. Exact fields use atom keys; string-keyed and mixed-key maps remain supported. Source: locked upstream resources/customers/wallets/ledger-entries.ts declaration LedgerEntryCreateParams.

list_params()

Parameters for customer_wallet_ledger_entries_list. Exact fields use atom keys; string-keyed and mixed-key maps remain supported. Source: locked upstream resources/customers/wallets/ledger-entries.ts declaration LedgerEntryListParams.

Functions

create(client, customer_id, params)

Calls Dodo operation customer_wallet_ledger_entries_create (POST /customers/{customer_id}/wallets/ledger-entries). Required parameters: :amount, :currency, :entry_type.

create(client, customer_id, params, opts)

Calls Dodo operation customer_wallet_ledger_entries_create (POST /customers/{customer_id}/wallets/ledger-entries). Required parameters: :amount, :currency, :entry_type.

list(client, customer_id)

Calls Dodo operation customer_wallet_ledger_entries_list (GET /customers/{customer_id}/wallets/ledger-entries). Required parameters: none. Numbered pagination is zero-based.

list(client, customer_id, opts)

Calls Dodo operation customer_wallet_ledger_entries_list (GET /customers/{customer_id}/wallets/ledger-entries). Required parameters: none. Numbered pagination is zero-based.

list(client, customer_id, params, opts)

Calls Dodo operation customer_wallet_ledger_entries_list (GET /customers/{customer_id}/wallets/ledger-entries). Required parameters: none. Numbered pagination is zero-based.

Types

create_params()

@type create_params() ::
  %{
    :amount => number(),
    :currency => DodoPayments.Enums.currency(),
    :entry_type => DodoPayments.Enums.ledger_entry_type(),
    optional(:idempotency_key) => String.t(),
    optional(:reason) => String.t(),
    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(:currency) => DodoPayments.Enums.currency(),
    optional(String.t()) => DodoPayments.RequestTypes.input_value()
  }
  | DodoPayments.RequestTypes.compatibility_params()

Functions

create(client, customer_id, params)

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

Calls Dodo operation customer_wallet_ledger_entries_create (POST /customers/{customer_id}/wallets/ledger-entries). Required parameters: :amount, :currency, :entry_type.

API parameters must be supplied as a map.

create(client, customer_id, params, opts)

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

Calls Dodo operation customer_wallet_ledger_entries_create (POST /customers/{customer_id}/wallets/ledger-entries). Required parameters: :amount, :currency, :entry_type.

The final argument contains request-local options.

list(client, customer_id)

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

Calls Dodo operation customer_wallet_ledger_entries_list (GET /customers/{customer_id}/wallets/ledger-entries). Required parameters: none. Numbered pagination is zero-based.

Calls the operation with an empty parameter map.

list(client, customer_id, opts)

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

Calls Dodo operation customer_wallet_ledger_entries_list (GET /customers/{customer_id}/wallets/ledger-entries). Required parameters: none. Numbered pagination is zero-based.

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

list(client, customer_id, params, opts)

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

Calls Dodo operation customer_wallet_ledger_entries_list (GET /customers/{customer_id}/wallets/ledger-entries). Required parameters: none. Numbered pagination is zero-based.

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