DodoPayments.LicenseKeys (dodo_payments v0.1.0)

Merchant management of license keys.

Summary

Types

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

list_params()

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

update_params()

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

Functions

create(client, params)

Calls Dodo operation license_keys_create (POST /license_keys). Required parameters: :customer_id, :key, :product_id.

create(client, params, opts)

Calls Dodo operation license_keys_create (POST /license_keys). Required parameters: :customer_id, :key, :product_id.

list(client)

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

list(client, opts)

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

list(client, params, opts)

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

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

Calls Dodo operation license_keys_retrieve (GET /license_keys/{id}). Required parameters: none.

update(client, id)

Calls Dodo operation license_keys_update (PATCH /license_keys/{id}). Required parameters: none.

update(client, id, opts)

Calls Dodo operation license_keys_update (PATCH /license_keys/{id}). Required parameters: none.

update(client, id, params, opts)

Calls Dodo operation license_keys_update (PATCH /license_keys/{id}). Required parameters: none.

Types

create_params()

@type create_params() ::
  %{
    :customer_id => String.t(),
    :key => String.t(),
    :product_id => String.t(),
    optional(:activations_limit) => number(),
    optional(:expires_at) => 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(:created_at_gte) => String.t(),
    optional(:created_at_lte) => String.t(),
    optional(:customer_id) => String.t(),
    optional(:product_id) => String.t(),
    optional(:source) => DodoPayments.Enums.license_key_source(),
    optional(:status) => DodoPayments.Enums.license_key_status(),
    optional(String.t()) => DodoPayments.RequestTypes.input_value()
  }
  | DodoPayments.RequestTypes.compatibility_params()

update_params()

@type update_params() ::
  %{
    optional(:activations_limit) => number(),
    optional(:disabled) => boolean(),
    optional(:expires_at) => 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.LicenseKey.t()} | {:error, Exception.t()}

Calls Dodo operation license_keys_create (POST /license_keys). Required parameters: :customer_id, :key, :product_id.

API parameters must be supplied as a map.

create(client, params, opts)

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

Calls Dodo operation license_keys_create (POST /license_keys). Required parameters: :customer_id, :key, :product_id.

The final argument contains request-local options.

list(client)

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

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

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

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

Calls Dodo operation license_keys_retrieve (GET /license_keys/{id}). Required parameters: none.

Options are request-local.

update(client, id)

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

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

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

Calls Dodo operation license_keys_update (PATCH /license_keys/{id}). Required parameters: none.

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