DodoPayments.LicenseKeyInstances (dodo_payments v0.1.0)

Merchant inspection of activated license-key instances.

Summary

Types

Parameters for license_key_instances_list. Exact fields use atom keys; string-keyed and mixed-key maps remain supported. Source: locked upstream resources/license-key-instances.ts declaration LicenseKeyInstanceListParams.

update_params()

Parameters for license_key_instances_update. Exact fields use atom keys; string-keyed and mixed-key maps remain supported. Source: locked upstream resources/license-key-instances.ts declaration LicenseKeyInstanceUpdateParams.

Functions

list(client)

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

list(client, opts)

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

list(client, params, opts)

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

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

Calls Dodo operation license_key_instances_retrieve (GET /license_key_instances/{id}). Required parameters: none.

update(client, id, params)

Calls Dodo operation license_key_instances_update (PATCH /license_key_instances/{id}). Required parameters: :name.

update(client, id, params, opts)

Calls Dodo operation license_key_instances_update (PATCH /license_key_instances/{id}). Required parameters: :name.

Types

list_params()

@type list_params() ::
  %{
    optional(:page_number) => number(),
    optional(:page_size) => number(),
    optional(:grant_id) => String.t(),
    optional(:license_key_id) => String.t(),
    optional(String.t()) => DodoPayments.RequestTypes.input_value()
  }
  | DodoPayments.RequestTypes.compatibility_params()

update_params()

@type update_params() ::
  %{
    :name => String.t(),
    optional(String.t()) => DodoPayments.RequestTypes.input_value()
  }
  | DodoPayments.RequestTypes.compatibility_params()

Functions

list(client)

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

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

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

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

Calls Dodo operation license_key_instances_retrieve (GET /license_key_instances/{id}). Required parameters: none.

Options are request-local.

update(client, id, params)

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

Calls Dodo operation license_key_instances_update (PATCH /license_key_instances/{id}). Required parameters: :name.

API parameters must be supplied as a map.

update(client, id, params, opts)

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

Calls Dodo operation license_key_instances_update (PATCH /license_key_instances/{id}). Required parameters: :name.

The final argument contains request-local options.