@cryptlex/web-api-client-2 • Docs

WARNING: This repository is a WIP. We do not recommend using this in Production.

A TypeScript client to access the Cryptlex Web API.

Quick start

import { CryptlexClientConfiguration } from '@cryptlex/web-api-client';

const configuration = new CryptlexClientConfiguration({
    // Set to the appropriate base path based on your Cryptlex account (US, EU, On-Premise)
    basePath: 'https://api.cryptlex.com/v3',
    accessToken: 'SET_ACCESS_TOKEN',
})

const licenseApi = new CryptlexLicensesApi(configuration);

await licenseApi.createLicense({
    createLicenseRequest: {
        productId: 'PRODUCT_ID'
    }
});

Classes

CryptlexAccountsApi

Extends

• BaseAPI

Constructors

new CryptlexAccountsApi()

new CryptlexAccountsApi(configuration): CryptlexAccountsApi

Parameters

• configuration: CryptlexClientConfiguration= DefaultConfig

Returns

CryptlexAccountsApi

Inherited from

runtime.BaseAPI.constructor

Source

src/runtime.ts:85

Methods

createAccount()

createAccount(requestParameters, initOverrides?): Promise<ApiResponse<SignupDto>>

Creates a new user account. Create an account

Parameters

• requestParameters: CreateAccountOperationRequest

• initOverrides?: RequestInit | InitOverrideFunction

Returns

Promise<ApiResponse<SignupDto>>

Source

src/apis/AccountsApi.ts:47

getAccount()

getAccount(requestParameters, initOverrides?): Promise<ApiResponse<TenantDto>>

Retrieves the details of an existing account. Retrieve an account

Parameters

• requestParameters: GetAccountRequest

• initOverrides?: RequestInit | InitOverrideFunction

Returns

Promise<ApiResponse<TenantDto>>

Source

src/apis/AccountsApi.ts:75

updateAccount()

updateAccount(requestParameters, initOverrides?): Promise<ApiResponse<TenantDto>>

Updates the specified account by setting the values of the parameters passed. Any parameters not provided will be left unchanged. Update an account

Parameters

• requestParameters: UpdateAccountRequest

• initOverrides?: RequestInit | InitOverrideFunction

Returns

Promise<ApiResponse<TenantDto>>

Source

src/apis/AccountsApi.ts:108

updatePlanAccount()

updatePlanAccount(requestParameters, initOverrides?): Promise<ApiResponse<TenantDto>>

Updates the account plan. Update account plan

Parameters

• requestParameters: UpdatePlanAccountRequest

• initOverrides?: RequestInit | InitOverrideFunction

Returns

Promise<ApiResponse<TenantDto>>

Source

src/apis/AccountsApi.ts:151

updateStatusAccount()

updateStatusAccount(requestParameters, initOverrides?): Promise<ApiResponse<TenantDto>>

Updates the account status. Update account status

Parameters

• requestParameters: UpdateStatusAccountRequest

• initOverrides?: RequestInit | InitOverrideFunction

Returns

Promise<ApiResponse<TenantDto>>

Source

src/apis/AccountsApi.ts:194

CryptlexActivationLogsApi

Extends

• BaseAPI

Constructors

new CryptlexActivationLogsApi()

new CryptlexActivationLogsApi(configuration): CryptlexActivationLogsApi

Parameters

• configuration: CryptlexClientConfiguration= DefaultConfig

Returns

CryptlexActivationLogsApi

Inherited from

runtime.BaseAPI.constructor

Source

src/runtime.ts:85

Methods

exportActivationLogs()

exportActivationLogs(requestParameters, initOverrides?): Promise<ApiResponse<void>>

Exports activation logs in the csv format. Export activation logs

Parameters

• requestParameters: ExportActivationLogsRequest

• initOverrides?: RequestInit | InitOverrideFunction

Returns

Promise<ApiResponse<void>>

Source

src/apis/ActivationLogsApi.ts:44

getActivationLog()

getActivationLog(requestParameters, initOverrides?): Promise<ApiResponse<ActivationLogDto>>

Retrieves the details of an existing activation log. Retrieve an activation log

Parameters

• requestParameters: GetActivationLogRequest

• initOverrides?: RequestInit | InitOverrideFunction

Returns

Promise<ApiResponse<ActivationLogDto>>

Source

src/apis/ActivationLogsApi.ts:90

getAllActivationLogs()

getAllActivationLogs(requestParameters, initOverrides?): Promise<ApiResponse<ActivationLogDto[]>>

Returns a list of activation logs. The activation logs are returned sorted by creation date in ascending order. List all activation logs

Parameters

• requestParameters: GetAllActivationLogsRequest

• initOverrides?: RequestInit | InitOverrideFunction

Returns

Promise<ApiResponse<ActivationLogDto[]>>

Source

src/apis/ActivationLogsApi.ts:123

CryptlexActivationsApi

Extends

• BaseAPI

Constructors

new CryptlexActivationsApi()

new CryptlexActivationsApi(configuration): CryptlexActivationsApi

Parameters

• configuration: CryptlexClientConfiguration= DefaultConfig

Returns

CryptlexActivationsApi

Inherited from

runtime.BaseAPI.constructor

Source

src/runtime.ts:85

Methods

createActivation()

createActivation(requestParameters, initOverrides?): Promise<ApiResponse<ActivationTokenDto>>

Creates a new activation. Create an activation

Parameters

• requestParameters: CreateActivationOperationRequest

• initOverrides?: RequestInit | InitOverrideFunction

Returns

Promise<ApiResponse<ActivationTokenDto>>

Source

src/apis/ActivationsApi.ts:93

createOfflineActivation()

createOfflineActivation(requestParameters, initOverrides?): Promise<ApiResponse<OfflineActivationDto>>

Creates a new offline activation. Create an offline activation

Parameters

• requestParameters: CreateOfflineActivationOperationRequest

• initOverrides?: RequestInit | InitOverrideFunction

Returns

Promise<ApiResponse<OfflineActivationDto>>

Source

src/apis/ActivationsApi.ts:121

deactivateActivation()

deactivateActivation(requestParameters, initOverrides?): Promise<ApiResponse<void>>

Permanently deletes an activation. It cannot be undone. Delete an activation

Parameters

• requestParameters: DeactivateActivationOperationRequest

• initOverrides?: RequestInit | InitOverrideFunction

Returns

Promise<ApiResponse<void>>

Source

src/apis/ActivationsApi.ts:157

deactivateOfflineActivation()

deactivateOfflineActivation(requestParameters, initOverrides?): Promise<ApiResponse<void>>

Permanently deletes an activation using offline deactivation request. It cannot be undone. Delete an activation offline

Parameters

• requestParameters: DeactivateOfflineActivationOperationRequest

• initOverrides?: RequestInit | InitOverrideFunction

Returns

Promise<ApiResponse<void>>

Source

src/apis/ActivationsApi.ts:192

deleteActivation()

deleteActivation(requestParameters, initOverrides?): Promise<ApiResponse<void>>

Permanently deletes an activation. It cannot be undone. Delete an activation

Parameters

• requestParameters: DeleteActivationRequest

• initOverrides?: RequestInit | InitOverrideFunction

Returns

Promise<ApiResponse<void>>

Source

src/apis/ActivationsApi.ts:228

exportActivations()

exportActivations(requestParameters, initOverrides?): Promise<ApiResponse<void>>

Exports activations in the csv format. Export activations

Parameters

• requestParameters: ExportActivationsRequest

• initOverrides?: RequestInit | InitOverrideFunction

Returns

Promise<ApiResponse<void>>

Source

src/apis/ActivationsApi.ts:253

getActivation()

getActivation(requestParameters, initOverrides?): Promise<ApiResponse<ActivationDto>>

Retrieves the details of an existing activation. Retrieve an activation

Parameters

• requestParameters: GetActivationRequest

• initOverrides?: RequestInit | InitOverrideFunction

Returns

Promise<ApiResponse<ActivationDto>>

Source

src/apis/ActivationsApi.ts:315

getAllActivations()

getAllActivations(requestParameters, initOverrides?): Promise<ApiResponse<ActivationDto[]>>

Returns a list of activations. The activations are returned sorted by creation date in ascending order. List all activations

Parameters

• requestParameters: GetAllActivationsRequest

• initOverrides?: RequestInit | InitOverrideFunction

Returns

Promise<ApiResponse<ActivationDto[]>>

Source

src/apis/ActivationsApi.ts:348

incrementMeterAttributeActivation()

incrementMeterAttributeActivation(requestParameters, initOverrides?): Promise<ApiResponse<ActivationMeterAttributeIncrementResponseDto>>

Increments the activation meter attribute uses. Increment an activation meter attribute

Parameters

• requestParameters: IncrementMeterAttributeActivationOperationRequest

• initOverrides?: RequestInit | InitOverrideFunction

Returns

Promise<ApiResponse<ActivationMeterAttributeIncrementResponseDto>>

Source

src/apis/ActivationsApi.ts:422

updateActivation()

updateActivation(requestParameters, initOverrides?): Promise<ApiResponse<ActivationTokenDto>>

Updates the specified activation by setting the values of the parameters passed. Any parameters not provided will be left unchanged. Update an activation

Parameters

• requestParameters: UpdateActivationRequest

• initOverrides?: RequestInit | InitOverrideFunction

Returns

Promise<ApiResponse<ActivationTokenDto>>

Source

src/apis/ActivationsApi.ts:457

CryptlexAnalyticsApi

Extends

• BaseAPI

Constructors

new CryptlexAnalyticsApi()

new CryptlexAnalyticsApi(configuration): CryptlexAnalyticsApi

Parameters

• configuration: CryptlexClientConfiguration= DefaultConfig

Returns

CryptlexAnalyticsApi

Inherited from

runtime.BaseAPI.constructor

Source

src/runtime.ts:85

Methods

getActivationsAnalytics()

getActivationsAnalytics(requestParameters, initOverrides?): Promise<ApiResponse<ActivationsByDateDto[]>>

Retrieve activations as time series data. Retrieve activations by time

Parameters

• requestParameters: GetActivationsAnalyticsRequest

• initOverrides?: RequestInit | InitOverrideFunction

Returns

Promise<ApiResponse<ActivationsByDateDto[]>>

Source

src/apis/AnalyticsApi.ts:99

getActivationsByCountryAnalytics()

getActivationsByCountryAnalytics(requestParameters, initOverrides?): Promise<ApiResponse<ActivationsByCountryDto[]>>

Retrieve activations by geo-location. Retrieve activations by geo-location

Parameters

• requestParameters: GetActivationsByCountryAnalyticsRequest

• initOverrides?: RequestInit | InitOverrideFunction

Returns

Promise<ApiResponse<ActivationsByCountryDto[]>>

Source

src/apis/AnalyticsApi.ts:141

getActivationsByOsAnalytics()

getActivationsByOsAnalytics(requestParameters, initOverrides?): Promise<ApiResponse<ActivationsByOsDto[]>>

Retrieve activations by OS. Retrieve activations by OS

Parameters

• requestParameters: GetActivationsByOsAnalyticsRequest

• initOverrides?: RequestInit | InitOverrideFunction

Returns

Promise<ApiResponse<ActivationsByOsDto[]>>

Source

src/apis/AnalyticsApi.ts:183

getActivationsByOsVersionAnalytics()

getActivationsByOsVersionAnalytics(requestParameters, initOverrides?): Promise<ApiResponse<ActivationsByOsVersionDto[]>>

Retrieve activations by OS version. Retrieve activations by OS version

Parameters

• requestParameters: GetActivationsByOsVersionAnalyticsRequest

• initOverrides?: RequestInit | InitOverrideFunction

Returns

Promise<ApiResponse<ActivationsByOsVersionDto[]>>

Source

src/apis/AnalyticsApi.ts:225

getActivationsByReleaseVersionAnalytics()

getActivationsByReleaseVersionAnalytics(requestParameters, initOverrides?): Promise<ApiResponse<ActivationsByReleaseVersionDto[]>>

Retrieve activations by release version. Retrieve activations by release version

Parameters

• requestParameters: GetActivationsByReleaseVersionAnalyticsRequest

• initOverrides?: RequestInit | InitOverrideFunction

Returns

Promise<ApiResponse<ActivationsByReleaseVersionDto[]>>

Source

src/apis/AnalyticsApi.ts:267

getActivationsByVmAnalytics()

getActivationsByVmAnalytics(requestParameters, initOverrides?): Promise<ApiResponse<ActivationsByVmDto[]>>

Retrieve activations by virtual machines. Retrieve activations by virtual machines

Parameters

• requestParameters: GetActivationsByVmAnalyticsRequest

• initOverrides?: RequestInit | InitOverrideFunction

Returns

Promise<ApiResponse<ActivationsByVmDto[]>>

Source

src/apis/AnalyticsApi.ts:309

getLicenseStatsAnalytics()

getLicenseStatsAnalytics(initOverrides?): Promise<ApiResponse<LicenseStatsDto>>

Retrieves the licenses' stats. Retrieve licenses' stats

Parameters

• initOverrides?: RequestInit | InitOverrideFunction

Returns

Promise<ApiResponse<LicenseStatsDto>>

Source

src/apis/AnalyticsApi.ts:351

getStatsAnalytics()

getStatsAnalytics(initOverrides?): Promise<ApiResponse<AccountStatsDto>>

Retrieves the account stats. Retrieve account stats

Parameters

• initOverrides?: RequestInit | InitOverrideFunction

Returns

Promise<ApiResponse<AccountStatsDto>>

Source

src/apis/AnalyticsApi.ts:377

getTrialActivationsAnalytics()

getTrialActivationsAnalytics(requestParameters, initOverrides?): Promise<ApiResponse<ActivationsByDateDto[]>>

Retrieve trial activations as time series data. Retrieve trial activations by time

Parameters

• requestParameters: GetTrialActivationsAnalyticsRequest

• initOverrides?: RequestInit | InitOverrideFunction

Returns

Promise<ApiResponse<ActivationsByDateDto[]>>

Source

src/apis/AnalyticsApi.ts:403

getTrialActivationsByCountryAnalytics()

getTrialActivationsByCountryAnalytics(requestParameters, initOverrides?): Promise<ApiResponse<ActivationsByCountryDto[]>>

Retrieve trial activations by geo-location. Retrieve trial activations by geo-location

Parameters

• requestParameters: GetTrialActivationsByCountryAnalyticsRequest

• initOverrides?: RequestInit | InitOverrideFunction

Returns

Promise<ApiResponse<ActivationsByCountryDto[]>>

Source

src/apis/AnalyticsApi.ts:441

getTrialActivationsByOsAnalytics()

getTrialActivationsByOsAnalytics(requestParameters, initOverrides?): Promise<ApiResponse<ActivationsByOsDto[]>>

Retrieve trial activations by OS. Retrieve trial activations by OS

Parameters

• requestParameters: GetTrialActivationsByOsAnalyticsRequest

• initOverrides?: RequestInit | InitOverrideFunction

Returns

Promise<ApiResponse<ActivationsByOsDto[]>>

Source

src/apis/AnalyticsApi.ts:479

getTrialActivationsByOsVersionAnalytics()

getTrialActivationsByOsVersionAnalytics(requestParameters, initOverrides?): Promise<ApiResponse<ActivationsByOsVersionDto[]>>

Retrieve trial activations by OS version. Retrieve trial activations by OS version

Parameters

• requestParameters: GetTrialActivationsByOsVersionAnalyticsRequest

• initOverrides?: RequestInit | InitOverrideFunction

Returns

Promise<ApiResponse<ActivationsByOsVersionDto[]>>

Source

src/apis/AnalyticsApi.ts:517

getTrialActivationsByVmAnalytics()

getTrialActivationsByVmAnalytics(requestParameters, initOverrides?): Promise<ApiResponse<ActivationsByVmDto[]>>

Retrieve trial activations by virtual machines. Retrieve trial activations by virtual machines

Parameters

• requestParameters: GetTrialActivationsByVmAnalyticsRequest

• initOverrides?: RequestInit | InitOverrideFunction

Returns

Promise<ApiResponse<ActivationsByVmDto[]>>

Source

src/apis/AnalyticsApi.ts:555

CryptlexAuthenticationApi

Extends

• BaseAPI

Constructors

new CryptlexAuthenticationApi()

new CryptlexAuthenticationApi(configuration): CryptlexAuthenticationApi

Parameters

• configuration: CryptlexClientConfiguration= DefaultConfig

Returns

CryptlexAuthenticationApi

Inherited from

runtime.BaseAPI.constructor

Source

src/runtime.ts:85

Methods

assertionConsumerServiceAuthentication()

assertionConsumerServiceAuthentication(requestParameters, initOverrides?): Promise<ApiResponse<void>>

Redirects to the service provider's return URL (relay state). SAML assertion consumer service

Parameters

• requestParameters: AssertionConsumerServiceAuthenticationRequest

• initOverrides?: RequestInit | InitOverrideFunction

Returns

Promise<ApiResponse<void>>

Source

src/apis/AuthenticationApi.ts:51

googleLoginAuthentication()

googleLoginAuthentication(requestParameters, initOverrides?): Promise<ApiResponse<AccessTokenDto>>

Returns an access token. Log into the account using Google

Parameters

• requestParameters: GoogleLoginAuthenticationOperationRequest

• initOverrides?: RequestInit | InitOverrideFunction

Returns

Promise<ApiResponse<AccessTokenDto>>

Source

src/apis/AuthenticationApi.ts:76

initiateSingleSignOnAuthentication()

initiateSingleSignOnAuthentication(requestParameters, initOverrides?): Promise<ApiResponse<void>>

Redirects to the identity provider's SSO login page. Initiate SAML SSO login

Parameters

• requestParameters: InitiateSingleSignOnAuthenticationRequest

• initOverrides?: RequestInit | InitOverrideFunction

Returns

Promise<ApiResponse<void>>

Source

src/apis/AuthenticationApi.ts:108

loginAuthentication()

loginAuthentication(requestParameters, initOverrides?): Promise<ApiResponse<AccessTokenDto>>

Returns an access token. Log into the account

Parameters

• requestParameters: LoginAuthenticationOperationRequest

• initOverrides?: RequestInit | InitOverrideFunction

Returns

Promise<ApiResponse<AccessTokenDto>>

Source

src/apis/AuthenticationApi.ts:137

sendPasswordResetEmailAuthentication()

sendPasswordResetEmailAuthentication(requestParameters, initOverrides?): Promise<ApiResponse<void>>

Sends the reset password email. Send reset password email

Parameters

• requestParameters: SendPasswordResetEmailAuthenticationOperationRequest

• initOverrides?: RequestInit | InitOverrideFunction

Returns

Promise<ApiResponse<void>>

Source

src/apis/AuthenticationApi.ts:169

verifySamlConfigurationAuthentication()

verifySamlConfigurationAuthentication(requestParameters, initOverrides?): Promise<ApiResponse<void>>

Checks whether SSO is enabled for the account. Check whether SSO is enabled

Parameters

• requestParameters: VerifySamlConfigurationAuthenticationOperationRequest

• initOverrides?: RequestInit | InitOverrideFunction

Returns

Promise<ApiResponse<void>>

Source

src/apis/AuthenticationApi.ts:201

CryptlexAutomatedEmailEventLogsApi

Extends

• BaseAPI

Constructors

new CryptlexAutomatedEmailEventLogsApi()

new CryptlexAutomatedEmailEventLogsApi(configuration): CryptlexAutomatedEmailEventLogsApi

Parameters

• configuration: CryptlexClientConfiguration= DefaultConfig

Returns

CryptlexAutomatedEmailEventLogsApi

Inherited from

runtime.BaseAPI.constructor

Source

src/runtime.ts:85

Methods

getAllAutomatedEmailEventLogs()

getAllAutomatedEmailEventLogs(requestParameters, initOverrides?): Promise<ApiResponse<AutomatedEmailEventLogDto[]>>

Returns a list of automated email event logs. The automated email event logs are returned sorted by creation date in ascending order. List all automated email event logs

Parameters

• requestParameters: GetAllAutomatedEmailEventLogsRequest

• initOverrides?: RequestInit | InitOverrideFunction

Returns

Promise<ApiResponse<AutomatedEmailEventLogDto[]>>

Source

src/apis/AutomatedEmailEventLogsApi.ts:38

getAutomatedEmailEventLog()

getAutomatedEmailEventLog(requestParameters, initOverrides?): Promise<ApiResponse<AutomatedEmailEventLogDto>>

Retrieves the details of an existing automated email event log. Retrieve an automated email event log

Parameters

• requestParameters: GetAutomatedEmailEventLogRequest

• initOverrides?: RequestInit | InitOverrideFunction

Returns

Promise<ApiResponse<AutomatedEmailEventLogDto>>

Source

src/apis/AutomatedEmailEventLogsApi.ts:88

resendAutomatedEmailEventLog()

resendAutomatedEmailEventLog(requestParameters, initOverrides?): Promise<ApiResponse<void>>

Resends the automated email mail. Resend the automated email mail

Parameters

• requestParameters: ResendAutomatedEmailEventLogRequest

• initOverrides?: RequestInit | InitOverrideFunction

Returns

Promise<ApiResponse<void>>

Source

src/apis/AutomatedEmailEventLogsApi.ts:121

CryptlexAutomatedEmailsApi

Extends

• BaseAPI

Constructors

new CryptlexAutomatedEmailsApi()

new CryptlexAutomatedEmailsApi(configuration): CryptlexAutomatedEmailsApi

Parameters

• configuration: CryptlexClientConfiguration= DefaultConfig

Returns

CryptlexAutomatedEmailsApi

Inherited from

runtime.BaseAPI.constructor

Source

src/runtime.ts:85

Methods

createAutomatedEmail()

createAutomatedEmail(requestParameters, initOverrides?): Promise<ApiResponse<EmailTemplateDto>>

Creates a new automated email. Create an automated email

Parameters

• requestParameters: CreateAutomatedEmailOperationRequest

• initOverrides?: RequestInit | InitOverrideFunction

Returns

Promise<ApiResponse<EmailTemplateDto>>

Source

src/apis/AutomatedEmailsApi.ts:47

deleteAutomatedEmail()

deleteAutomatedEmail(requestParameters, initOverrides?): Promise<ApiResponse<void>>

Permanently deletes an automated email. It cannot be undone. Delete an automated email

Parameters

• requestParameters: DeleteAutomatedEmailRequest

• initOverrides?: RequestInit | InitOverrideFunction

Returns

Promise<ApiResponse<void>>

Source

src/apis/AutomatedEmailsApi.ts:83

getAllAutomatedEmails()

getAllAutomatedEmails(requestParameters, initOverrides?): Promise<ApiResponse<EmailTemplateDto[]>>

Returns a list of automated emails. The automated emails are returned sorted by creation date in ascending order. List all automated emails

Parameters

• requestParameters: GetAllAutomatedEmailsRequest

• initOverrides?: RequestInit | InitOverrideFunction

Returns

Promise<ApiResponse<EmailTemplateDto[]>>

Source

src/apis/AutomatedEmailsApi.ts:116

getAutomatedEmail()

getAutomatedEmail(requestParameters, initOverrides?): Promise<ApiResponse<EmailTemplateDto>>

Retrieves the details of an existing automated email. Retrieve an automated email

Parameters

• requestParameters: GetAutomatedEmailRequest

• initOverrides?: RequestInit | InitOverrideFunction

Returns

Promise<ApiResponse<EmailTemplateDto>>

Source

src/apis/AutomatedEmailsApi.ts:162

updateAutomatedEmail()

updateAutomatedEmail(requestParameters, initOverrides?): Promise<ApiResponse<EmailTemplateDto>>

Updates the specified automated email by setting the values of the parameters passed. Any parameters not provided will be left unchanged. Update an automated email

Parameters

• requestParameters: UpdateAutomatedEmailRequest

• initOverrides?: RequestInit | InitOverrideFunction

Returns

Promise<ApiResponse<EmailTemplateDto>>

Source

src/apis/AutomatedEmailsApi.ts:195

CryptlexClientConfiguration

Constructors

new CryptlexClientConfiguration()

new CryptlexClientConfiguration(configuration): CryptlexClientConfiguration

Parameters

• configuration: CryptlexClientConfigurationParameters= {}

Returns

CryptlexClientConfiguration

Source

src/runtime.ts:33

Accessors

accessToken

get accessToken(): (name?, scopes?) => string | Promise<string>

Returns

Function

Parameters

• name?: string

• scopes?: string[]

Returns

string | Promise<string>

Source

src/runtime.ts:58

basePath

get basePath(): string

Returns

string

Source

src/runtime.ts:39

config

set config(configuration): void

Parameters

• configuration: CryptlexClientConfiguration

Source

src/runtime.ts:35

fetchApi

get fetchApi(): (input, init?) => Promise<Response>

Returns

Function

Parameters

• input: RequestInfo | URL

• init?: RequestInit

Returns

Promise<Response>

Source

src/runtime.ts:43

headers

get headers(): HTTPHeaders

Returns

HTTPHeaders

Source

src/runtime.ts:66

middleware

get middleware(): Middleware[]

Returns

Middleware[]

Source

src/runtime.ts:47

CryptlexCreditCardsApi

Extends

• BaseAPI

Constructors

new CryptlexCreditCardsApi()

new CryptlexCreditCardsApi(configuration): CryptlexCreditCardsApi

Parameters

• configuration: CryptlexClientConfiguration= DefaultConfig

Returns

CryptlexCreditCardsApi

Inherited from

runtime.BaseAPI.constructor

Source

src/runtime.ts:85

Methods

createCreditCard()

createCreditCard(requestParameters, initOverrides?): Promise<ApiResponse<CreditCardDto>>

Creates a new credit card. Create a credit card

Parameters

• requestParameters: CreateCreditCardOperationRequest

• initOverrides?: RequestInit | InitOverrideFunction

Returns

Promise<ApiResponse<CreditCardDto>>

Source

src/apis/CreditCardsApi.ts:34

deleteCreditCard()

deleteCreditCard(requestParameters, initOverrides?): Promise<ApiResponse<void>>

Permanently deletes a credit card. It cannot be undone. Delete a credit card

Parameters

• requestParameters: DeleteCreditCardRequest

• initOverrides?: RequestInit | InitOverrideFunction

Returns

Promise<ApiResponse<void>>

Source

src/apis/CreditCardsApi.ts:70

getAllCreditCards()

getAllCreditCards(requestParameters, initOverrides?): Promise<ApiResponse<CreditCardDto[]>>

Returns a list of credit cards. The credit cards are returned sorted by creation date in ascending order. List all credit cards

Parameters

• requestParameters: GetAllCreditCardsRequest

• initOverrides?: RequestInit | InitOverrideFunction

Returns

Promise<ApiResponse<CreditCardDto[]>>

Source

src/apis/CreditCardsApi.ts:103

CryptlexEventLogsApi

Extends

• BaseAPI

Constructors

new CryptlexEventLogsApi()

new CryptlexEventLogsApi(configuration): CryptlexEventLogsApi

Parameters

• configuration: CryptlexClientConfiguration= DefaultConfig

Returns

CryptlexEventLogsApi

Inherited from

runtime.BaseAPI.constructor

Source

src/runtime.ts:85

Methods

getAllEventLogs()

getAllEventLogs(requestParameters, initOverrides?): Promise<ApiResponse<EventLogDto[]>>

Returns a list of event logs. The event logs are returned sorted by creation date in ascending order. List all event logs

Parameters

• requestParameters: GetAllEventLogsRequest

• initOverrides?: RequestInit | InitOverrideFunction

Returns

Promise<ApiResponse<EventLogDto[]>>

Source

src/apis/EventLogsApi.ts:38

getEventLog()

getEventLog(requestParameters, initOverrides?): Promise<ApiResponse<EventLogDto>>

Retrieves the details of an existing event log. Retrieve an event log

Parameters

• requestParameters: GetEventLogRequest

• initOverrides?: RequestInit | InitOverrideFunction

Returns

Promise<ApiResponse<EventLogDto>>

Source

src/apis/EventLogsApi.ts:100

CryptlexFeatureFlagsApi

Extends

• BaseAPI

Constructors

new CryptlexFeatureFlagsApi()

new CryptlexFeatureFlagsApi(configuration): CryptlexFeatureFlagsApi

Parameters

• configuration: CryptlexClientConfiguration= DefaultConfig

Returns

CryptlexFeatureFlagsApi

Inherited from

runtime.BaseAPI.constructor

Source

src/runtime.ts:85

Methods

createFeatureFlag()

createFeatureFlag(requestParameters, initOverrides?): Promise<ApiResponse<FeatureFlagDto>>

Creates a new feature flag. Create a feature flag

Parameters

• requestParameters: CreateFeatureFlagOperationRequest

• initOverrides?: RequestInit | InitOverrideFunction

Returns

Promise<ApiResponse<FeatureFlagDto>>

Source

src/apis/FeatureFlagsApi.ts:50

deleteFeatureFlag()

deleteFeatureFlag(requestParameters, initOverrides?): Promise<ApiResponse<void>>

Permanently deletes a feature flag. It cannot be undone. Delete a feature flag

Parameters

• requestParameters: DeleteFeatureFlagRequest

• initOverrides?: RequestInit | InitOverrideFunction

Returns

Promise<ApiResponse<void>>

Source

src/apis/FeatureFlagsApi.ts:86

getAllFeatureFlags()

getAllFeatureFlags(requestParameters, initOverrides?): Promise<ApiResponse<FeatureFlagDto[]>>

Returns a list of feature flags. The feature flags are returned sorted by creation date in ascending order. List all feature flags

Parameters

• requestParameters: GetAllFeatureFlagsRequest

• initOverrides?: RequestInit | InitOverrideFunction

Returns

Promise<ApiResponse<FeatureFlagDto[]>>

Source

src/apis/FeatureFlagsApi.ts:119

getFeatureFlag()

getFeatureFlag(requestParameters, initOverrides?): Promise<ApiResponse<FeatureFlagDto>>

Retrieves the details of an existing feature flag. Retrieve a feature flag

Parameters

• requestParameters: GetFeatureFlagRequest

• initOverrides?: RequestInit | InitOverrideFunction

Returns

Promise<ApiResponse<FeatureFlagDto>>

Source

src/apis/FeatureFlagsApi.ts:173

updateFeatureFlag()

updateFeatureFlag(requestParameters, initOverrides?): Promise<ApiResponse<FeatureFlagDto>>

Updates the specified feature flag by setting the values of the parameters passed. Any parameters not provided will be left unchanged. Update a feature flag

Parameters

• requestParameters: UpdateFeatureFlagRequest

• initOverrides?: RequestInit | InitOverrideFunction

Returns

Promise<ApiResponse<FeatureFlagDto>>

Source

src/apis/FeatureFlagsApi.ts:206

CryptlexInvoicesApi

Extends

• BaseAPI

Constructors

new CryptlexInvoicesApi()

new CryptlexInvoicesApi(configuration): CryptlexInvoicesApi

Parameters

• configuration: CryptlexClientConfiguration= DefaultConfig

Returns

CryptlexInvoicesApi

Inherited from

runtime.BaseAPI.constructor

Source

src/runtime.ts:85

Methods

getAllInvoices()

getAllInvoices(requestParameters, initOverrides?): Promise<ApiResponse<InvoiceDto[]>>

Returns a list of invoices. The invoices are returned sorted by creation date in ascending order. List all invoices

Parameters

• requestParameters: GetAllInvoicesRequest

• initOverrides?: RequestInit | InitOverrideFunction

Returns

Promise<ApiResponse<InvoiceDto[]>>

Source

src/apis/InvoicesApi.ts:30

getInvoice()

getInvoice(requestParameters, initOverrides?): Promise<ApiResponse<InvoiceUrlDto>>

Retrieves the details of an existing invoice. Retrieve an invoice

Parameters

• requestParameters: GetInvoiceRequest

• initOverrides?: RequestInit | InitOverrideFunction

Returns

Promise<ApiResponse<InvoiceUrlDto>>

Source

src/apis/InvoicesApi.ts:68

CryptlexLicenseTemplatesApi

Extends

• BaseAPI

Constructors

new CryptlexLicenseTemplatesApi()

new CryptlexLicenseTemplatesApi(configuration): CryptlexLicenseTemplatesApi

Parameters

• configuration: CryptlexClientConfiguration= DefaultConfig

Returns

CryptlexLicenseTemplatesApi

Inherited from

runtime.BaseAPI.constructor

Source

src/runtime.ts:85

Methods

createLicenseTemplate()

createLicenseTemplate(requestParameters, initOverrides?): Promise<ApiResponse<LicensePolicyDto>>

Creates a new license template. Create a license template

Parameters

• requestParameters: CreateLicenseTemplateOperationRequest

• initOverrides?: RequestInit | InitOverrideFunction

Returns

Promise<ApiResponse<LicensePolicyDto>>

Source

src/apis/LicenseTemplatesApi.ts:47

deleteLicenseTemplate()

deleteLicenseTemplate(requestParameters, initOverrides?): Promise<ApiResponse<void>>

Permanently deletes a license template. It cannot be undone. Delete a license template

Parameters

• requestParameters: DeleteLicenseTemplateRequest

• initOverrides?: RequestInit | InitOverrideFunction

Returns

Promise<ApiResponse<void>>

Source

src/apis/LicenseTemplatesApi.ts:83

getAllLicenseTemplates()

getAllLicenseTemplates(requestParameters, initOverrides?): Promise<ApiResponse<LicensePolicyDto[]>>

Returns a list of license templates. The license templates are returned sorted by creation date in ascending order. List all license templates

Parameters

• requestParameters: GetAllLicenseTemplatesRequest

• initOverrides?: RequestInit | InitOverrideFunction

Returns

Promise<ApiResponse<LicensePolicyDto[]>>

Source

src/apis/LicenseTemplatesApi.ts:116

getLicenseTemplate()

getLicenseTemplate(requestParameters, initOverrides?): Promise<ApiResponse<LicensePolicyDto>>

Retrieves the details of an existing license template. Retrieve a license template

Parameters

• requestParameters: GetLicenseTemplateRequest

• initOverrides?: RequestInit | InitOverrideFunction

Returns

Promise<ApiResponse<LicensePolicyDto>>

Source

src/apis/LicenseTemplatesApi.ts:162

updateLicenseTemplate()

updateLicenseTemplate(requestParameters, initOverrides?): Promise<ApiResponse<LicensePolicyDto>>

Updates the specified license template by setting the values of the parameters passed. Any parameters not provided will be left unchanged. Update a license template

Parameters

• requestParameters: UpdateLicenseTemplateRequest

• initOverrides?: RequestInit | InitOverrideFunction

Returns

Promise<ApiResponse<LicensePolicyDto>>

Source

src/apis/LicenseTemplatesApi.ts:195

CryptlexLicensesApi

Extends

• BaseAPI

Constructors

new CryptlexLicensesApi()

new CryptlexLicensesApi(configuration): CryptlexLicensesApi

Parameters

• configuration: CryptlexClientConfiguration= DefaultConfig

Returns

CryptlexLicensesApi

Inherited from

runtime.BaseAPI.constructor

Source

src/runtime.ts:85

Methods

createLicense()

createLicense(requestParameters, initOverrides?): Promise<ApiResponse<LicenseDto>>

Creates a new license. Create a license

Parameters

• requestParameters: CreateLicenseOperationRequest

• initOverrides?: RequestInit | InitOverrideFunction

Returns

Promise<ApiResponse<LicenseDto>>

Source

src/apis/LicensesApi.ts:143

deleteLicense()

deleteLicense(requestParameters, initOverrides?): Promise<ApiResponse<void>>

Permanently deletes a license. It cannot be undone. Delete a license

Parameters

• requestParameters: DeleteLicenseRequest

• initOverrides?: RequestInit | InitOverrideFunction

Returns

Promise<ApiResponse<void>>

Source

src/apis/LicensesApi.ts:179

deleteMetadataLicense()

deleteMetadataLicense(requestParameters, initOverrides?): Promise<ApiResponse<void>>

Permanently deletes a license metadata field. It cannot be undone. Delete a license metadata field

Parameters

• requestParameters: DeleteMetadataLicenseRequest

• initOverrides?: RequestInit | InitOverrideFunction

Returns

Promise<ApiResponse<void>>

Source

src/apis/LicensesApi.ts:212

deleteMeterAttributeLicense()

deleteMeterAttributeLicense(requestParameters, initOverrides?): Promise<ApiResponse<void>>

Permanently deletes a license meter attribute. It cannot be undone. Delete a license meter attribute

Parameters

• requestParameters: DeleteMeterAttributeLicenseRequest

• initOverrides?: RequestInit | InitOverrideFunction

Returns

Promise<ApiResponse<void>>

Source

src/apis/LicensesApi.ts:245

exportLicenses()

exportLicenses(requestParameters, initOverrides?): Promise<ApiResponse<void>>

Exports all licenses in the csv format. Export all licenses

Parameters

• requestParameters: ExportLicensesRequest

• initOverrides?: RequestInit | InitOverrideFunction

Returns

Promise<ApiResponse<void>>

Source

src/apis/LicensesApi.ts:278

extendLicense()

extendLicense(requestParameters, initOverrides?): Promise<[ApiResponse](README.md#apiresponset