DodoPayments.Customers.Entitlements (dodo_payments v0.1.0)

Fulfilment entitlements and grants belonging to a customer.

Summary

Types

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

Functions

list(client, customer_id, opts \\ [])

Calls Dodo operation customer_entitlements_list (GET /customers/{customer_id}/entitlements). Required parameters: none.

list_grants(client, customer_id)

Calls Dodo operation customer_entitlement_grants_list (GET /customers/{customer_id}/entitlement-grants). Required parameters: none. Numbered pagination is zero-based.

list_grants(client, customer_id, opts)

Calls Dodo operation customer_entitlement_grants_list (GET /customers/{customer_id}/entitlement-grants). Required parameters: none. Numbered pagination is zero-based.

list_grants(client, customer_id, params, opts)

Calls Dodo operation customer_entitlement_grants_list (GET /customers/{customer_id}/entitlement-grants). Required parameters: none. Numbered pagination is zero-based.

Types

list_grants_params()

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

Functions

list(client, customer_id, opts \\ [])

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

Calls Dodo operation customer_entitlements_list (GET /customers/{customer_id}/entitlements). Required parameters: none.

Options are request-local.

list_grants(client, customer_id)

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

Calls Dodo operation customer_entitlement_grants_list (GET /customers/{customer_id}/entitlement-grants). Required parameters: none. Numbered pagination is zero-based.

Calls the operation with an empty parameter map.

list_grants(client, customer_id, opts)

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

Calls Dodo operation customer_entitlement_grants_list (GET /customers/{customer_id}/entitlement-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, customer_id, params, opts)

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

Calls Dodo operation customer_entitlement_grants_list (GET /customers/{customer_id}/entitlement-grants). Required parameters: none. Numbered pagination is zero-based.

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