DodoPayments.CreditEntitlements.Balances (dodo_payments v0.1.0)

Per-customer balances for a credit entitlement. Lists are zero-based.

Summary

Types

Parameters for credit_balance_ledger_entries_create. Exact fields use atom keys; string-keyed and mixed-key maps remain supported. Source: locked upstream resources/credit-entitlements/balances.ts declaration BalanceCreateLedgerEntryParams.

list_grants_params()

Parameters for credit_balance_grants_list. Exact fields use atom keys; string-keyed and mixed-key maps remain supported. Source: locked upstream resources/credit-entitlements/balances.ts declaration BalanceListGrantsParams.

list_ledger_params()

Parameters for credit_balance_ledger_list. Exact fields use atom keys; string-keyed and mixed-key maps remain supported. Source: locked upstream resources/credit-entitlements/balances.ts declaration BalanceListLedgerParams.

list_params()

Parameters for credit_balances_list. Exact fields use atom keys; string-keyed and mixed-key maps remain supported. Source: locked upstream resources/credit-entitlements/balances.ts declaration BalanceListParams.

Functions

create_ledger_entry(client, credit_entitlement_id, customer_id, params)

Calls Dodo operation credit_balance_ledger_entries_create (POST /credit-entitlements/{credit_entitlement_id}/balances/{customer_id}/ledger-entries). Required parameters: :amount, :entry_type.

create_ledger_entry(client, credit_entitlement_id, customer_id, params, opts)

Calls Dodo operation credit_balance_ledger_entries_create (POST /credit-entitlements/{credit_entitlement_id}/balances/{customer_id}/ledger-entries). Required parameters: :amount, :entry_type.

list(client, credit_entitlement_id)

Calls Dodo operation credit_balances_list (GET /credit-entitlements/{credit_entitlement_id}/balances). Required parameters: none. Numbered pagination is zero-based.

list(client, credit_entitlement_id, opts)

Calls Dodo operation credit_balances_list (GET /credit-entitlements/{credit_entitlement_id}/balances). Required parameters: none. Numbered pagination is zero-based.

list(client, credit_entitlement_id, params, opts)

Calls Dodo operation credit_balances_list (GET /credit-entitlements/{credit_entitlement_id}/balances). Required parameters: none. Numbered pagination is zero-based.

list_grants(client, credit_entitlement_id, customer_id)

Calls Dodo operation credit_balance_grants_list (GET /credit-entitlements/{credit_entitlement_id}/balances/{customer_id}/grants). Required parameters: none. Numbered pagination is zero-based.

list_grants(client, credit_entitlement_id, customer_id, opts)

Calls Dodo operation credit_balance_grants_list (GET /credit-entitlements/{credit_entitlement_id}/balances/{customer_id}/grants). Required parameters: none. Numbered pagination is zero-based.

list_grants(client, credit_entitlement_id, customer_id, params, opts)

Calls Dodo operation credit_balance_grants_list (GET /credit-entitlements/{credit_entitlement_id}/balances/{customer_id}/grants). Required parameters: none. Numbered pagination is zero-based.

list_ledger(client, credit_entitlement_id, customer_id)

Calls Dodo operation credit_balance_ledger_list (GET /credit-entitlements/{credit_entitlement_id}/balances/{customer_id}/ledger). Required parameters: none. Numbered pagination is zero-based.

list_ledger(client, credit_entitlement_id, customer_id, opts)

Calls Dodo operation credit_balance_ledger_list (GET /credit-entitlements/{credit_entitlement_id}/balances/{customer_id}/ledger). Required parameters: none. Numbered pagination is zero-based.

list_ledger(client, credit_entitlement_id, customer_id, params, opts)

Calls Dodo operation credit_balance_ledger_list (GET /credit-entitlements/{credit_entitlement_id}/balances/{customer_id}/ledger). Required parameters: none. Numbered pagination is zero-based.

retrieve(client, credit_entitlement_id, customer_id, opts \\ [])

Calls Dodo operation credit_balances_retrieve (GET /credit-entitlements/{credit_entitlement_id}/balances/{customer_id}). Required parameters: none.

Types

create_ledger_entry_params()

@type create_ledger_entry_params() ::
  %{
    :amount => String.t(),
    :entry_type => DodoPayments.Enums.ledger_entry_type(),
    optional(:expires_at) => String.t(),
    optional(:idempotency_key) => String.t(),
    optional(:metadata) => DodoPayments.RequestTypes.flat_metadata(),
    optional(:reason) => String.t(),
    optional(String.t()) => DodoPayments.RequestTypes.input_value()
  }
  | DodoPayments.RequestTypes.compatibility_params()

list_grants_params()

@type list_grants_params() ::
  %{
    optional(:page_number) => number(),
    optional(:page_size) => number(),
    optional(:status) => DodoPayments.Enums.credit_grant_status(),
    optional(String.t()) => DodoPayments.RequestTypes.input_value()
  }
  | DodoPayments.RequestTypes.compatibility_params()

list_ledger_params()

@type list_ledger_params() ::
  %{
    optional(:page_number) => number(),
    optional(:page_size) => number(),
    optional(:end_date) => String.t(),
    optional(:start_date) => String.t(),
    optional(:transaction_type) => 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(:customer_id) => String.t(),
    optional(String.t()) => DodoPayments.RequestTypes.input_value()
  }
  | DodoPayments.RequestTypes.compatibility_params()

Functions

create_ledger_entry(client, credit_entitlement_id, customer_id, params)

@spec create_ledger_entry(
  DodoPayments.Client.t(),
  String.t() | integer(),
  String.t() | integer(),
  create_ledger_entry_params()
) ::
  {:ok, DodoPayments.CreditLedgerEntryCreateResponse.t()}
  | {:error, Exception.t()}

Calls Dodo operation credit_balance_ledger_entries_create (POST /credit-entitlements/{credit_entitlement_id}/balances/{customer_id}/ledger-entries). Required parameters: :amount, :entry_type.

API parameters must be supplied as a map.

create_ledger_entry(client, credit_entitlement_id, customer_id, params, opts)

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

Calls Dodo operation credit_balance_ledger_entries_create (POST /credit-entitlements/{credit_entitlement_id}/balances/{customer_id}/ledger-entries). Required parameters: :amount, :entry_type.

The final argument contains request-local options.

list(client, credit_entitlement_id)

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

Calls Dodo operation credit_balances_list (GET /credit-entitlements/{credit_entitlement_id}/balances). Required parameters: none. Numbered pagination is zero-based.

Calls the operation with an empty parameter map.

list(client, credit_entitlement_id, opts)

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

Calls Dodo operation credit_balances_list (GET /credit-entitlements/{credit_entitlement_id}/balances). Required parameters: none. Numbered pagination is zero-based.

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

list(client, credit_entitlement_id, params, opts)

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

Calls Dodo operation credit_balances_list (GET /credit-entitlements/{credit_entitlement_id}/balances). Required parameters: none. Numbered pagination is zero-based.

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

list_grants(client, credit_entitlement_id, customer_id)

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

Calls Dodo operation credit_balance_grants_list (GET /credit-entitlements/{credit_entitlement_id}/balances/{customer_id}/grants). Required parameters: none. Numbered pagination is zero-based.

Calls the operation with an empty parameter map.

list_grants(client, credit_entitlement_id, customer_id, opts)

@spec list_grants(
  DodoPayments.Client.t(),
  String.t() | integer(),
  String.t() | integer(),
  list_grants_params() | nil | keyword()
) ::
  {:ok,
   DodoPayments.Page.Numbered.t(DodoPayments.CreditGrant.t())
   | DodoPayments.Response.t(
       DodoPayments.Page.Numbered.t(DodoPayments.CreditGrant.t())
     )}
  | {:error, Exception.t()}

Calls Dodo operation credit_balance_grants_list (GET /credit-entitlements/{credit_entitlement_id}/balances/{customer_id}/grants). Required parameters: none. Numbered pagination is zero-based.

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

list_grants(client, credit_entitlement_id, customer_id, params, opts)

@spec list_grants(
  DodoPayments.Client.t(),
  String.t() | integer(),
  String.t() | integer(),
  list_grants_params() | nil,
  keyword()
) ::
  {:ok,
   DodoPayments.Page.Numbered.t(DodoPayments.CreditGrant.t())
   | DodoPayments.Response.t(
       DodoPayments.Page.Numbered.t(DodoPayments.CreditGrant.t())
     )}
  | {:error, Exception.t()}

Calls Dodo operation credit_balance_grants_list (GET /credit-entitlements/{credit_entitlement_id}/balances/{customer_id}/grants). Required parameters: none. Numbered pagination is zero-based.

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

list_ledger(client, credit_entitlement_id, customer_id)

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

Calls Dodo operation credit_balance_ledger_list (GET /credit-entitlements/{credit_entitlement_id}/balances/{customer_id}/ledger). Required parameters: none. Numbered pagination is zero-based.

Calls the operation with an empty parameter map.

list_ledger(client, credit_entitlement_id, customer_id, opts)

@spec list_ledger(
  DodoPayments.Client.t(),
  String.t() | integer(),
  String.t() | integer(),
  list_ledger_params() | nil | keyword()
) ::
  {:ok,
   DodoPayments.Page.Numbered.t(DodoPayments.CreditLedgerEntry.t())
   | DodoPayments.Response.t(
       DodoPayments.Page.Numbered.t(DodoPayments.CreditLedgerEntry.t())
     )}
  | {:error, Exception.t()}

Calls Dodo operation credit_balance_ledger_list (GET /credit-entitlements/{credit_entitlement_id}/balances/{customer_id}/ledger). Required parameters: none. Numbered pagination is zero-based.

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

list_ledger(client, credit_entitlement_id, customer_id, params, opts)

@spec list_ledger(
  DodoPayments.Client.t(),
  String.t() | integer(),
  String.t() | integer(),
  list_ledger_params() | nil,
  keyword()
) ::
  {:ok,
   DodoPayments.Page.Numbered.t(DodoPayments.CreditLedgerEntry.t())
   | DodoPayments.Response.t(
       DodoPayments.Page.Numbered.t(DodoPayments.CreditLedgerEntry.t())
     )}
  | {:error, Exception.t()}

Calls Dodo operation credit_balance_ledger_list (GET /credit-entitlements/{credit_entitlement_id}/balances/{customer_id}/ledger). Required parameters: none. Numbered pagination is zero-based.

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

retrieve(client, credit_entitlement_id, customer_id, opts \\ [])

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

Calls Dodo operation credit_balances_retrieve (GET /credit-entitlements/{credit_entitlement_id}/balances/{customer_id}). Required parameters: none.

Options are request-local.