DodoPayments.Entitlements (dodo_payments v0.1.0)

Fulfilment entitlement definitions.

Summary

Types

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

list_params()

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

update_params()

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

Functions

create(client, params)

Calls Dodo operation entitlements_create (POST /entitlements). Required parameters: :integration_config, :integration_type, :name.

create(client, params, opts)

Calls Dodo operation entitlements_create (POST /entitlements). Required parameters: :integration_config, :integration_type, :name.

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

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

list(client)

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

list(client, opts)

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

list(client, params, opts)

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

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

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

update(client, id)

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

update(client, id, opts)

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

update(client, id, params, opts)

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

Types

create_params()

@type create_params() ::
  %{
    :integration_config =>
      DodoPayments.RequestTypes.entitlement_integration_config(),
    :integration_type => DodoPayments.Enums.entitlement_integration_type(),
    :name => String.t(),
    optional(:description) => String.t(),
    optional(:metadata) => DodoPayments.RequestTypes.flat_metadata(),
    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(:integration_type) =>
      DodoPayments.Enums.entitlement_integration_type(),
    optional(String.t()) => DodoPayments.RequestTypes.input_value()
  }
  | DodoPayments.RequestTypes.compatibility_params()

update_params()

@type update_params() ::
  %{
    optional(:description) => String.t(),
    optional(:integration_config) =>
      DodoPayments.RequestTypes.entitlement_integration_config(),
    optional(:metadata) => DodoPayments.RequestTypes.flat_metadata(),
    optional(:name) => 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.Entitlement.t()} | {:error, Exception.t()}

Calls Dodo operation entitlements_create (POST /entitlements). Required parameters: :integration_config, :integration_type, :name.

API parameters must be supplied as a map.

create(client, params, opts)

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

Calls Dodo operation entitlements_create (POST /entitlements). Required parameters: :integration_config, :integration_type, :name.

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 entitlements_delete (DELETE /entitlements/{id}). Required parameters: none.

Options are request-local.

list(client)

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

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

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

Calls Dodo operation entitlements_list (GET /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.Entitlement.t()
   | DodoPayments.Response.t(DodoPayments.Entitlement.t())}
  | {:error, Exception.t()}

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

Options are request-local.

update(client, id)

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

Calls Dodo operation entitlements_update (PATCH /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,
   DodoPayments.Entitlement.t()
   | DodoPayments.Response.t(DodoPayments.Entitlement.t())}
  | {:error, Exception.t()}

Calls Dodo operation entitlements_update (PATCH /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,
   DodoPayments.Entitlement.t()
   | DodoPayments.Response.t(DodoPayments.Entitlement.t())}
  | {:error, Exception.t()}

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

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