DodoPayments.Licenses (dodo_payments v0.1.0)

Credential-free runtime license activation, deactivation and validation.

Summary

Types

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

deactivate_params()

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

validate_params()

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

Functions

activate(client, params)

Calls Dodo operation licenses_activate (POST /licenses/activate). Required parameters: :license_key, :name.

activate(client, params, opts)

Calls Dodo operation licenses_activate (POST /licenses/activate). Required parameters: :license_key, :name.

deactivate(client, params)

Calls Dodo operation licenses_deactivate (POST /licenses/deactivate). Required parameters: :license_key, :license_key_instance_id.

deactivate(client, params, opts)

Calls Dodo operation licenses_deactivate (POST /licenses/deactivate). Required parameters: :license_key, :license_key_instance_id.

validate(client, params)

Calls Dodo operation licenses_validate (POST /licenses/validate). Required parameters: :license_key.

validate(client, params, opts)

Calls Dodo operation licenses_validate (POST /licenses/validate). Required parameters: :license_key.

Types

activate_params()

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

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

deactivate_params()

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

validate_params()

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

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

Functions

activate(client, params)

@spec activate(DodoPayments.Client.t(), activate_params()) ::
  {:ok, DodoPayments.License.t()} | {:error, Exception.t()}

Calls Dodo operation licenses_activate (POST /licenses/activate). Required parameters: :license_key, :name.

API parameters must be supplied as a map.

activate(client, params, opts)

@spec activate(DodoPayments.Client.t(), activate_params(), keyword()) ::
  {:ok,
   DodoPayments.License.t() | DodoPayments.Response.t(DodoPayments.License.t())}
  | {:error, Exception.t()}

Calls Dodo operation licenses_activate (POST /licenses/activate). Required parameters: :license_key, :name.

The final argument contains request-local options.

deactivate(client, params)

@spec deactivate(DodoPayments.Client.t(), deactivate_params()) ::
  {:ok, nil} | {:error, Exception.t()}

Calls Dodo operation licenses_deactivate (POST /licenses/deactivate). Required parameters: :license_key, :license_key_instance_id.

API parameters must be supplied as a map.

deactivate(client, params, opts)

@spec deactivate(DodoPayments.Client.t(), deactivate_params(), keyword()) ::
  {:ok, nil | DodoPayments.Response.t(nil)} | {:error, Exception.t()}

Calls Dodo operation licenses_deactivate (POST /licenses/deactivate). Required parameters: :license_key, :license_key_instance_id.

The final argument contains request-local options.

validate(client, params)

@spec validate(DodoPayments.Client.t(), validate_params()) ::
  {:ok, DodoPayments.License.t()} | {:error, Exception.t()}

Calls Dodo operation licenses_validate (POST /licenses/validate). Required parameters: :license_key.

API parameters must be supplied as a map.

validate(client, params, opts)

@spec validate(DodoPayments.Client.t(), validate_params(), keyword()) ::
  {:ok,
   DodoPayments.License.t() | DodoPayments.Response.t(DodoPayments.License.t())}
  | {:error, Exception.t()}

Calls Dodo operation licenses_validate (POST /licenses/validate). Required parameters: :license_key.

The final argument contains request-local options.