LicenseKeys
LicenseKeys API operations.
Summary
Functions
Activate License Key
Deactivate License Key
Get License Key
List License Keys
Update License Key
Validate License Key
Functions
@spec activate_license_key(PolarExpress.Client.t(), map(), keyword()) :: {:ok, PolarExpress.Schemas.LicenseKeyActivationRead.t()} | {:error, PolarExpress.Error.t()}
Activate License Key
Activate a license key instance.
Scopes: license_keys:write
See PolarExpress.Params.LicenseKeysActivateLicenseKeyParams for parameter details.
@spec deactivate_license_key(PolarExpress.Client.t(), map(), keyword()) :: {:ok, term()} | {:error, PolarExpress.Error.t()}
Deactivate License Key
Deactivate a license key instance.
Scopes: license_keys:write
See PolarExpress.Params.LicenseKeysDeactivateLicenseKeyParams for parameter details.
@spec get_activation( PolarExpress.Client.t(), String.t(), String.t(), map(), keyword() ) :: {:ok, PolarExpress.Schemas.LicenseKeyActivationRead.t()} | {:error, PolarExpress.Error.t()}
Get Activation
Get a license key activation.
Scopes: license_keys:read license_keys:write
See PolarExpress.Params.LicenseKeysGetActivationParams for parameter details.
@spec get_license_key(PolarExpress.Client.t(), String.t(), map(), keyword()) :: {:ok, PolarExpress.Schemas.LicenseKeyWithActivations.t()} | {:error, PolarExpress.Error.t()}
Get License Key
Get a license key.
Scopes: license_keys:read license_keys:write
See PolarExpress.Params.LicenseKeysGetLicenseKeyParams for parameter details.
@spec list_license_keys(PolarExpress.Client.t(), map(), keyword()) :: {:ok, PolarExpress.ListObject.t()} | {:error, PolarExpress.Error.t()}
List License Keys
Get license keys connected to the given organization & filters.
Scopes: license_keys:read license_keys:write
See PolarExpress.Params.LicenseKeysListLicenseKeysParams for parameter details.
@spec update_license_key(PolarExpress.Client.t(), String.t(), map(), keyword()) :: {:ok, PolarExpress.Schemas.LicenseKeyRead.t()} | {:error, PolarExpress.Error.t()}
Update License Key
Update a license key.
Scopes: license_keys:write
See PolarExpress.Params.LicenseKeysUpdateLicenseKeyParams for parameter details.
@spec validate_license_key(PolarExpress.Client.t(), map(), keyword()) :: {:ok, PolarExpress.Schemas.ValidatedLicenseKey.t()} | {:error, PolarExpress.Error.t()}
Validate License Key
Validate a license key.
Scopes: license_keys:write
See PolarExpress.Params.LicenseKeysValidateLicenseKeyParams for parameter details.