DodoPayments.CreditEntitlements (dodo_payments v0.1.0)

Credit entitlement definitions. These are distinct from fulfilment entitlements.

Summary

Types

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

list_params()

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

update_params()

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

Functions

create(client, params)

Calls Dodo operation credit_entitlements_create (POST /credit-entitlements). Required parameters: :name, :overage_enabled, :precision, :rollover_enabled, :unit.

create(client, params, opts)

Calls Dodo operation credit_entitlements_create (POST /credit-entitlements). Required parameters: :name, :overage_enabled, :precision, :rollover_enabled, :unit.

delete(client, id, opts \\ [])

Calls Dodo operation credit_entitlements_delete (DELETE /credit-entitlements/{id}). Required parameters: none.

list(client)

Calls Dodo operation credit_entitlements_list (GET /credit-entitlements). Required parameters: none. Numbered pagination is zero-based.

list(client, opts)

Calls Dodo operation credit_entitlements_list (GET /credit-entitlements). Required parameters: none. Numbered pagination is zero-based.

list(client, params, opts)

Calls Dodo operation credit_entitlements_list (GET /credit-entitlements). Required parameters: none. Numbered pagination is zero-based.

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

Calls Dodo operation credit_entitlements_retrieve (GET /credit-entitlements/{id}). Required parameters: none.

undelete(client, id, opts \\ [])

Calls Dodo operation credit_entitlements_undelete (POST /credit-entitlements/{id}/undelete). Required parameters: none.

update(client, id)

Calls Dodo operation credit_entitlements_update (PATCH /credit-entitlements/{id}). Required parameters: none.

update(client, id, opts)

Calls Dodo operation credit_entitlements_update (PATCH /credit-entitlements/{id}). Required parameters: none.

update(client, id, params, opts)

Calls Dodo operation credit_entitlements_update (PATCH /credit-entitlements/{id}). Required parameters: none.

Types

create_params()

@type create_params() ::
  %{
    :name => String.t(),
    :overage_enabled => boolean(),
    :precision => number(),
    :rollover_enabled => boolean(),
    :unit => String.t(),
    optional(:currency) => DodoPayments.Enums.currency(),
    optional(:description) => String.t(),
    optional(:expires_after_days) => number(),
    optional(:max_rollover_count) => number(),
    optional(:overage_behavior) => DodoPayments.Enums.cbb_overage_behavior(),
    optional(:overage_limit) => number(),
    optional(:price_per_unit) => String.t(),
    optional(:rollover_percentage) => number(),
    optional(:rollover_timeframe_count) => number(),
    optional(:rollover_timeframe_interval) =>
      DodoPayments.Enums.time_interval(),
    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(:deleted) => boolean(),
    optional(String.t()) => DodoPayments.RequestTypes.input_value()
  }
  | DodoPayments.RequestTypes.compatibility_params()

update_params()

@type update_params() ::
  %{
    optional(:currency) => DodoPayments.Enums.currency(),
    optional(:description) => String.t(),
    optional(:expires_after_days) => number(),
    optional(:max_rollover_count) => number(),
    optional(:name) => String.t(),
    optional(:overage_behavior) => DodoPayments.Enums.cbb_overage_behavior(),
    optional(:overage_enabled) => boolean(),
    optional(:overage_limit) => number(),
    optional(:price_per_unit) => String.t(),
    optional(:rollover_enabled) => boolean(),
    optional(:rollover_percentage) => number(),
    optional(:rollover_timeframe_count) => number(),
    optional(:rollover_timeframe_interval) =>
      DodoPayments.Enums.time_interval(),
    optional(:unit) => String.t(),
    optional(String.t()) => DodoPayments.RequestTypes.input_value()
  }
  | DodoPayments.RequestTypes.compatibility_params()

Functions

create(client, params)

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

Calls Dodo operation credit_entitlements_create (POST /credit-entitlements). Required parameters: :name, :overage_enabled, :precision, :rollover_enabled, :unit.

API parameters must be supplied as a map.

create(client, params, opts)

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

Calls Dodo operation credit_entitlements_create (POST /credit-entitlements). Required parameters: :name, :overage_enabled, :precision, :rollover_enabled, :unit.

The final argument contains request-local options.

delete(client, id, opts \\ [])

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

Calls Dodo operation credit_entitlements_delete (DELETE /credit-entitlements/{id}). Required parameters: none.

Options are request-local.

list(client)

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

Calls Dodo operation credit_entitlements_list (GET /credit-entitlements). 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.CreditEntitlement.t())
   | DodoPayments.Response.t(
       DodoPayments.Page.Numbered.t(DodoPayments.CreditEntitlement.t())
     )}
  | {:error, Exception.t()}

Calls Dodo operation credit_entitlements_list (GET /credit-entitlements). 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.CreditEntitlement.t())
   | DodoPayments.Response.t(
       DodoPayments.Page.Numbered.t(DodoPayments.CreditEntitlement.t())
     )}
  | {:error, Exception.t()}

Calls Dodo operation credit_entitlements_list (GET /credit-entitlements). Required parameters: none. Numbered pagination is zero-based.

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

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

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

Calls Dodo operation credit_entitlements_retrieve (GET /credit-entitlements/{id}). Required parameters: none.

Options are request-local.

undelete(client, id, opts \\ [])

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

Calls Dodo operation credit_entitlements_undelete (POST /credit-entitlements/{id}/undelete). Required parameters: none.

Options are request-local.

update(client, id)

@spec update(DodoPayments.Client.t(), String.t() | integer()) ::
  {:ok, nil} | {:error, Exception.t()}

Calls Dodo operation credit_entitlements_update (PATCH /credit-entitlements/{id}). Required parameters: none.

Calls the operation with an empty parameter map.

update(client, id, opts)

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

Calls Dodo operation credit_entitlements_update (PATCH /credit-entitlements/{id}). Required parameters: none.

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

update(client, id, params, opts)

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

Calls Dodo operation credit_entitlements_update (PATCH /credit-entitlements/{id}). Required parameters: none.

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