@qernal/[email protected]

This generator creates TypeScript/JavaScript client that utilizes axios. The generated Node module can be used in the following environments:

Environment

• Node.js
• Webpack
• Browserify

Language level

• ES5 - you must have a Promises/A+ library installed
• ES6

Module system

• CommonJS
• ES6 module system

It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via package.json. (Reference)

Building

To build and compile the typescript sources to javascript use:

npm install
npm run build

Publishing

First build the package then run npm publish

Consuming

navigate to the folder of your consuming project and run one of the following commands.

published:

npm install @qernal/[email protected] --save

unPublished (not recommended):

npm install PATH_TO_GENERATED_PACKAGE --save

Documentation for API Endpoints

All URIs are relative to https://chaos.qernal.com/v1

Class	Method	HTTP request	Description
BillingApi	accountsPaymentMethodsCreate	POST /billing/accounts/{billing_account_id}/payment-methods	Create a new payment method for a billing account
BillingApi	accountsPaymentMethodsList	GET /billing/accounts/{billing_account_id}/payment-methods	List payment methods for a billing account
BillingApi	billingAccountsCreate	POST /billing/accounts	Create billing account
BillingApi	billingAccountsDelete	DELETE /billing/accounts/{billing_account_id}	Delete billing account
BillingApi	billingAccountsGet	GET /billing/accounts/{billing_account_id}	Get billing account
BillingApi	billingAccountsList	GET /billing/accounts	List billing accounts
BillingApi	billingAccountsUpdate	PUT /billing/accounts/{billing_account_id}	Update billing account
BillingApi	paymentMethodsDelete	DELETE /billing/payment-methods/{billing_payment_method_id}	Delete a specific payment method
BillingApi	paymentMethodsGet	GET /billing/payment-methods/{billing_payment_method_id}	Retrieve metadata for a specific payment method
BillingApi	paymentMethodsUpdate	PUT /billing/payment-methods/{billing_payment_method_id}	Update a specific payment method
FunctionsApi	functionsCreate	POST /functions	Create function
FunctionsApi	functionsDelete	DELETE /functions/{function_id}	Delete function
FunctionsApi	functionsGet	GET /functions/{function_id}	Get function (latest revision)
FunctionsApi	functionsRevisionsGet	GET /functions/{function_id}/revisions/{function_revision_id}	Get a specific revision of a function
FunctionsApi	functionsRevisionsList	GET /functions/{function_id}/revisions	List all revisions for a function
FunctionsApi	functionsUpdate	PUT /functions/{function_id}	Update function
FunctionsApi	projectsFunctionsList	GET /projects/{project_id}/functions	List all functions within a project
HostsApi	projectsHostsCreate	POST /projects/{project_id}/hosts	Create host for project
HostsApi	projectsHostsDelete	DELETE /projects/{project_id}/hosts/{hostname}	Delete specific host by hostname
HostsApi	projectsHostsGet	GET /projects/{project_id}/hosts/{hostname}	Get specific host by hostname
HostsApi	projectsHostsList	GET /projects/{project_id}/hosts	List hosts for project
HostsApi	projectsHostsUpdate	PUT /projects/{project_id}/hosts/{hostname}	Update specific host by hostname
HostsApi	projectsHostsVerifyCreate	POST /projects/{project_id}/hosts/{hostname}/verify	Schedule host verification task
LogsApi	logsList	GET /logs	Get logs
MetricsApi	metricsAggregationsList	GET /metrics/aggregations/{metric_aggregation_type}	Get metrics
OrganisationsApi	organisationsCreate	POST /organisations	Create organisations
OrganisationsApi	organisationsDelete	DELETE /organisations/{organisation_id}	Delete an organisation
OrganisationsApi	organisationsGet	GET /organisations/{organisation_id}	Get an organisation
OrganisationsApi	organisationsList	GET /organisations	List organisations
OrganisationsApi	organisationsQuotasGet	GET /organisations/{organisation_id}/quotas/{quota_entity_quota}	Get specific organisation quota
OrganisationsApi	organisationsQuotasList	GET /organisations/{organisation_id}/quotas	List organisation quotas
OrganisationsApi	organisationsUpdate	PUT /organisations/{organisation_id}	Update an organisation
ProjectsApi	organisationsProjectsList	GET /organisations/{organisation_id}/projects	Get all projects within an organisation
ProjectsApi	projectsCreate	POST /projects	Create project
ProjectsApi	projectsDelete	DELETE /projects/{project_id}	Delete project
ProjectsApi	projectsGet	GET /projects/{project_id}	Get project
ProjectsApi	projectsList	GET /projects	List projects
ProjectsApi	projectsQuotasGet	GET /projects/{project_id}/quotas/{quota_entity_quota}	Get specific project quota
ProjectsApi	projectsQuotasList	GET /projects/{project_id}/quotas	List project quotas
ProjectsApi	projectsUpdate	PUT /projects/{project_id}	Update project
ProvidersApi	providersList	GET /providers	Get available providers
QuotasApi	organisationsQuotasGet	GET /organisations/{organisation_id}/quotas/{quota_entity_quota}	Get specific organisation quota
QuotasApi	organisationsQuotasList	GET /organisations/{organisation_id}/quotas	List organisation quotas
QuotasApi	projectsQuotasGet	GET /projects/{project_id}/quotas/{quota_entity_quota}	Get specific project quota
QuotasApi	projectsQuotasList	GET /projects/{project_id}/quotas	List project quotas
QuotasApi	usersQuotasGet	GET /users/{user_id}/quotas/{quota_entity_quota}	Get specific user quota
QuotasApi	usersQuotasList	GET /users/{user_id}/quotas	List user quotas
SecretsApi	projectsSecretsCreate	POST /projects/{project_id}/secrets	Create project secret
SecretsApi	projectsSecretsDelete	DELETE /projects/{project_id}/secrets/{secret_name}	Delete project secret
SecretsApi	projectsSecretsGet	GET /projects/{project_id}/secrets/{secret_name}	Get project secret
SecretsApi	projectsSecretsList	GET /projects/{project_id}/secrets	List project secrets of a specific type
SecretsApi	projectsSecretsUpdate	PUT /projects/{project_id}/secrets/{secret_name}	Update project secret
TokensApi	authTokensCreate	POST /auth/tokens	Create new auth token
TokensApi	authTokensDelete	DELETE /auth/tokens/{token_id}	Delete token
TokensApi	authTokensGet	GET /auth/tokens/{token_id}	Get token information
TokensApi	authTokensList	GET /auth/tokens	List all user auth tokens
TokensApi	authTokensUpdate	PUT /auth/tokens/{token_id}	Update token
UsersApi	usersQuotasGet	GET /users/{user_id}/quotas/{quota_entity_quota}	Get specific user quota
UsersApi	usersQuotasList	GET /users/{user_id}/quotas	List user quotas

Documentation For Models

• AuthToken
• AuthTokenBody
• AuthTokenMeta
• AuthTokenPatch
• BadRequestResponse
• BadRequestResponseFields
• BillingAccount
• BillingAccountBody
• ConflictResponse
• DeletedResponse
• Function
• FunctionBody
• FunctionCompliance
• FunctionDeployment
• FunctionDeploymentBody
• FunctionEnv
• FunctionReplicas
• FunctionReplicasAffinity
• FunctionRoute
• FunctionScaling
• FunctionSize
• FunctionType
• Host
• HostBody
• HostBodyPatch
• HostVerificationStatus
• ListFunction
• ListLogResponse
• ListProviderResponse
• Location
• Log
• LogLog
• LogsListFTimestampsParameter
• MetricHttpAggregation
• MetricHttpAggregationHttpCodes
• MetricHttpAggregationHttpCodesBucketsInner
• MetricHttpAggregationHttpCodesBucketsInnerHistogram
• MetricResourceAggregation
• MetricResourceAggregationResources
• MetricResourceAggregationResourcesBucketsInner
• MetricResourceAggregationResourcesBucketsInnerHistogram
• MetricResourceAggregationResourcesBucketsInnerHistogramBucketsInner
• MetricResourceAggregationResourcesBucketsInnerHistogramBucketsInnerCounter
• MetricResourceAggregationResourcesBucketsInnerHistogramBucketsInnerGauge
• MetricsAggregationsList200Response
• ModelDate
• NotFoundResponse
• Organisation
• OrganisationBody
• OrganisationsListPageParameter
• PaginationLinks
• PaginationMeta
• PaymentMethod
• PaymentMethodAddress
• PaymentMethodBody
• PaymentMethodCreate
• PaymentMethodCreateLinks
• Project
• ProjectBody
• ProjectBodyPatch
• Provider
• ProviderLocations
• Quota
• Secret
• SecretBody
• SecretBodyPatch
• SecretCertificate
• SecretCreatePayload
• SecretCreateType
• SecretEnvironment
• SecretMeta
• SecretMetaCertificatePayload
• SecretMetaDek
• SecretMetaPayload
• SecretMetaRegistryPayload
• SecretMetaType
• SecretPayload
• SecretRegistry
• UnauthorisedResponse

Documentation For Authorization

Authentication schemes defined for the API:

token

• Type: Bearer authentication

cookie

• Type: API key
• API key parameter name: qernal_kratos_session
• Location: