502 lines
38 KiB
TypeScript
502 lines
38 KiB
TypeScript
|
/**
|
|||
|
|
* Hetzner Cloud API
|
|||
|
|
* This is the official documentation for the Hetzner Cloud API. ## Introduction The Hetzner Cloud API operates over HTTPS and uses JSON as its data format. The API is a RESTful API and utilizes HTTP methods and HTTP status codes to specify requests and responses. As an alternative to working directly with our API you may also consider to use: - Our CLI program [hcloud](https://github.com/hetznercloud/cli) - Our [library for Go](https://github.com/hetznercloud/hcloud-go) - Our [library for Python](https://github.com/hetznercloud/hcloud-python) Also you can find a [list of libraries, tools, and integrations on GitHub](https://github.com/hetznercloud/awesome-hcloud). If you are developing integrations based on our API and your product is Open Source you may be eligible for a free one time €50 (excl. VAT) credit on your account. Please contact us via the the support page on your Cloud Console and let us know the following: - The type of integration you would like to develop - Link to the GitHub repo you will use for the Project - Link to some other Open Source work you have already done (if you have done so) ## Getting Started To get started using the API you first need an API token. Sign in into the [Hetzner Cloud Console](https://console.hetzner.cloud/) choose a Project, go to `Security` → `API Tokens`, and generate a new token. Make sure to copy the token because it won’t be shown to you again. A token is bound to a Project, to interact with the API of another Project you have to create a new token inside the Project. Let’s say your new token is `LRK9DAWQ1ZAEFSrCNEEzLCUwhYX1U3g7wMg4dTlkkDC96fyDuyJ39nVbVjCKSDfj`. You’re now ready to do your first request against the API. To get a list of all Servers in your Project, issue the example request on the right side using [curl](https://curl.se/). Make sure to replace the token in the example command with the token you have just created. Since your Project probably does not contain any Servers yet, the example response will look like the response on the right side. We will almost always provide a resource root like `servers` inside the example response. A response can also contain a `meta` object with information like [Pagination](#pagination). **Example Request** ```bash curl -H \"Authorization: Bearer LRK9DAWQ1ZAEFSrCNEEzLCUwhYX1U3g7wMg4dTlkkDC96fyDuyJ39nVbVjCKSDfj\" \\ https://api.hetzner.cloud/v1/servers ``` **Example Response** ```json { \"servers\": [], \"meta\": { \"pagination\": { \"page\": 1, \"per_page\": 25, \"previous_page\": null, \"next_page\": null, \"last_page\": 1, \"total_entries\": 0 } } } ``` ## Authentication All requests to the Hetzner Cloud API must be authenticated via a API token. Include your secret API token in every request you send to the API with the `Authorization` HTTP header. To create a new API token for your Project, switch into the [Hetzner Cloud Console](https://console.hetzner.cloud/) choose a Project, go to `Security` → `API Tokens`, and generate a new token. **Example Authorization header** ```http Authorization: Bearer LRK9DAWQ1ZAEFSrCNEEzLCUwhYX1U3g7wMg4dTlkkDC96fyDuyJ39nVbVjCKSDfj ``` ## Errors Errors are indicated by HTTP status codes. Further, the response of the request which generated the error contains an error code, an error message, and, optionally, error details. The schema of the error details object depends on the error code. The error response contains the following keys: | Keys | Meaning | | --------- | --------------------------------------------------------------------- | | `code` | Short string indicating the type of error (machine-parsable) | | `message` | Textual description on what has gone wrong | | `details` | An object providing for details on the error (schema depends on code) | **Example response** ```json { \"error\": { \"code\": \"invalid_input\", \"message\": \"invalid input in field \'broken_field\': is too
|
|||
|
|
*
|
|||
|
|
* The version of the OpenAPI document: 1.0.0
|
|||
|
|
*
|
|||
|
|
*
|
|||
|
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|||
|
|
* https://openapi-generator.tech
|
|||
|
|
* Do not edit the class manually.
|
|||
|
|
*/
|
|||
|
|
|
|||
|
|
|
|||
|
|
import localVarRequest from 'request';
|
|||
|
|
import http from 'http';
|
|||
|
|
|
|||
|
|
/* tslint:disable:no-unused-locals */
|
|||
|
|
import { ActionResponse } from '../model/actionResponse';
|
|||
|
|
import { ActionsResponse } from '../model/actionsResponse';
|
|||
|
|
|
|||
|
|
import { ObjectSerializer, Authentication, VoidAuth, Interceptor } from '../model/models';
|
|||
|
|
import { HttpBasicAuth, HttpBearerAuth, ApiKeyAuth, OAuth } from '../model/models';
|
|||
|
|
|
|||
|
|
import { HttpError, RequestFile } from './apis';
|
|||
|
|
|
|||
|
|
let defaultBasePath = 'https://api.hetzner.cloud/v1';
|
|||
|
|
|
|||
|
|
// ===============================================
|
|||
|
|
// This file is autogenerated - Please do not edit
|
|||
|
|
// ===============================================
|
|||
|
|
|
|||
|
|
export enum CertificateActionsApiApiKeys {
|
|||
|
|
}
|
|||
|
|
|
|||
|
|
export class CertificateActionsApi {
|
|||
|
|
protected _basePath = defaultBasePath;
|
|||
|
|
protected _defaultHeaders : any = {};
|
|||
|
|
protected _useQuerystring : boolean = false;
|
|||
|
|
|
|||
|
|
protected authentications = {
|
|||
|
|
'default': <Authentication>new VoidAuth(),
|
|||
|
|
'APIToken': new HttpBearerAuth(),
|
|||
|
|
}
|
|||
|
|
|
|||
|
|
protected interceptors: Interceptor[] = [];
|
|||
|
|
|
|||
|
|
constructor(basePath?: string);
|
|||
|
|
constructor(basePathOrUsername: string, password?: string, basePath?: string) {
|
|||
|
|
if (password) {
|
|||
|
|
if (basePath) {
|
|||
|
|
this.basePath = basePath;
|
|||
|
|
}
|
|||
|
|
} else {
|
|||
|
|
if (basePathOrUsername) {
|
|||
|
|
this.basePath = basePathOrUsername
|
|||
|
|
}
|
|||
|
|
}
|
|||
|
|
}
|
|||
|
|
|
|||
|
|
set useQuerystring(value: boolean) {
|
|||
|
|
this._useQuerystring = value;
|
|||
|
|
}
|
|||
|
|
|
|||
|
|
set basePath(basePath: string) {
|
|||
|
|
this._basePath = basePath;
|
|||
|
|
}
|
|||
|
|
|
|||
|
|
set defaultHeaders(defaultHeaders: any) {
|
|||
|
|
this._defaultHeaders = defaultHeaders;
|
|||
|
|
}
|
|||
|
|
|
|||
|
|
get defaultHeaders() {
|
|||
|
|
return this._defaultHeaders;
|
|||
|
|
}
|
|||
|
|
|
|||
|
|
get basePath() {
|
|||
|
|
return this._basePath;
|
|||
|
|
}
|
|||
|
|
|
|||
|
|
public setDefaultAuthentication(auth: Authentication) {
|
|||
|
|
this.authentications.default = auth;
|
|||
|
|
}
|
|||
|
|
|
|||
|
|
public setApiKey(key: CertificateActionsApiApiKeys, value: string) {
|
|||
|
|
(this.authentications as any)[CertificateActionsApiApiKeys[key]].apiKey = value;
|
|||
|
|
}
|
|||
|
|
|
|||
|
|
set accessToken(accessToken: string | (() => string)) {
|
|||
|
|
this.authentications.APIToken.accessToken = accessToken;
|
|||
|
|
}
|
|||
|
|
|
|||
|
|
public addInterceptor(interceptor: Interceptor) {
|
|||
|
|
this.interceptors.push(interceptor);
|
|||
|
|
}
|
|||
|
|
|
|||
|
|
/**
|
|||
|
|
* Returns all Action objects. You can `sort` the results by using the sort URI parameter, and filter them with the `status` and `id` parameter.
|
|||
|
|
* @summary Get all Actions
|
|||
|
|
* @param id Can be used multiple times, the response will contain only Actions with specified IDs.
|
|||
|
|
* @param sort Can be used multiple times.
|
|||
|
|
* @param status Can be used multiple times, the response will contain only Actions with specified statuses
|
|||
|
|
* @param page Page to load.
|
|||
|
|
* @param perPage Items to load per page.
|
|||
|
|
*/
|
|||
|
|
public async certificatesActionsGet (id?: number, sort?: 'id' | 'id:asc' | 'id:desc' | 'command' | 'command:asc' | 'command:desc' | 'status' | 'status:asc' | 'status:desc' | 'started' | 'started:asc' | 'started:desc' | 'finished' | 'finished:asc' | 'finished:desc', status?: 'running' | 'success' | 'error', page?: number, perPage?: number, options: {headers: {[name: string]: string}} = {headers: {}}) : Promise<{ response: http.IncomingMessage; body: ActionsResponse; }> {
|
|||
|
|
const localVarPath = this.basePath + '/certificates/actions';
|
|||
|
|
let localVarQueryParameters: any = {};
|
|||
|
|
let localVarHeaderParams: any = (<any>Object).assign({}, this._defaultHeaders);
|
|||
|
|
const produces = ['application/json'];
|
|||
|
|
// give precedence to 'application/json'
|
|||
|
|
if (produces.indexOf('application/json') >= 0) {
|
|||
|
|
localVarHeaderParams.Accept = 'application/json';
|
|||
|
|
} else {
|
|||
|
|
localVarHeaderParams.Accept = produces.join(',');
|
|||
|
|
}
|
|||
|
|
let localVarFormParams: any = {};
|
|||
|
|
|
|||
|
|
if (id !== undefined) {
|
|||
|
|
localVarQueryParameters['id'] = ObjectSerializer.serialize(id, "number");
|
|||
|
|
}
|
|||
|
|
|
|||
|
|
if (sort !== undefined) {
|
|||
|
|
localVarQueryParameters['sort'] = ObjectSerializer.serialize(sort, "'id' | 'id:asc' | 'id:desc' | 'command' | 'command:asc' | 'command:desc' | 'status' | 'status:asc' | 'status:desc' | 'started' | 'started:asc' | 'started:desc' | 'finished' | 'finished:asc' | 'finished:desc'");
|
|||
|
|
}
|
|||
|
|
|
|||
|
|
if (status !== undefined) {
|
|||
|
|
localVarQueryParameters['status'] = ObjectSerializer.serialize(status, "'running' | 'success' | 'error'");
|
|||
|
|
}
|
|||
|
|
|
|||
|
|
if (page !== undefined) {
|
|||
|
|
localVarQueryParameters['page'] = ObjectSerializer.serialize(page, "number");
|
|||
|
|
}
|
|||
|
|
|
|||
|
|
if (perPage !== undefined) {
|
|||
|
|
localVarQueryParameters['per_page'] = ObjectSerializer.serialize(perPage, "number");
|
|||
|
|
}
|
|||
|
|
|
|||
|
|
(<any>Object).assign(localVarHeaderParams, options.headers);
|
|||
|
|
|
|||
|
|
let localVarUseFormData = false;
|
|||
|
|
|
|||
|
|
let localVarRequestOptions: localVarRequest.Options = {
|
|||
|
|
method: 'GET',
|
|||
|
|
qs: localVarQueryParameters,
|
|||
|
|
headers: localVarHeaderParams,
|
|||
|
|
uri: localVarPath,
|
|||
|
|
useQuerystring: this._useQuerystring,
|
|||
|
|
json: true,
|
|||
|
|
};
|
|||
|
|
|
|||
|
|
let authenticationPromise = Promise.resolve();
|
|||
|
|
if (this.authentications.APIToken.accessToken) {
|
|||
|
|
authenticationPromise = authenticationPromise.then(() => this.authentications.APIToken.applyToRequest(localVarRequestOptions));
|
|||
|
|
}
|
|||
|
|
authenticationPromise = authenticationPromise.then(() => this.authentications.default.applyToRequest(localVarRequestOptions));
|
|||
|
|
|
|||
|
|
let interceptorPromise = authenticationPromise;
|
|||
|
|
for (const interceptor of this.interceptors) {
|
|||
|
|
interceptorPromise = interceptorPromise.then(() => interceptor(localVarRequestOptions));
|
|||
|
|
}
|
|||
|
|
|
|||
|
|
return interceptorPromise.then(() => {
|
|||
|
|
if (Object.keys(localVarFormParams).length) {
|
|||
|
|
if (localVarUseFormData) {
|
|||
|
|
(<any>localVarRequestOptions).formData = localVarFormParams;
|
|||
|
|
} else {
|
|||
|
|
localVarRequestOptions.form = localVarFormParams;
|
|||
|
|
}
|
|||
|
|
}
|
|||
|
|
return new Promise<{ response: http.IncomingMessage; body: ActionsResponse; }>((resolve, reject) => {
|
|||
|
|
localVarRequest(localVarRequestOptions, (error, response, body) => {
|
|||
|
|
if (error) {
|
|||
|
|
reject(error);
|
|||
|
|
} else {
|
|||
|
|
if (response.statusCode && response.statusCode >= 200 && response.statusCode <= 299) {
|
|||
|
|
body = ObjectSerializer.deserialize(body, "ActionsResponse");
|
|||
|
|
resolve({ response: response, body: body });
|
|||
|
|
} else {
|
|||
|
|
reject(new HttpError(response, body, response.statusCode));
|
|||
|
|
}
|
|||
|
|
}
|
|||
|
|
});
|
|||
|
|
});
|
|||
|
|
});
|
|||
|
|
}
|
|||
|
|
/**
|
|||
|
|
* Returns a specific Action object.
|
|||
|
|
* @summary Get an Action
|
|||
|
|
* @param id ID of the Action.
|
|||
|
|
*/
|
|||
|
|
public async certificatesActionsIdGet (id: number, options: {headers: {[name: string]: string}} = {headers: {}}) : Promise<{ response: http.IncomingMessage; body: ActionResponse; }> {
|
|||
|
|
const localVarPath = this.basePath + '/certificates/actions/{id}'
|
|||
|
|
.replace('{' + 'id' + '}', encodeURIComponent(String(id)));
|
|||
|
|
let localVarQueryParameters: any = {};
|
|||
|
|
let localVarHeaderParams: any = (<any>Object).assign({}, this._defaultHeaders);
|
|||
|
|
const produces = ['application/json'];
|
|||
|
|
// give precedence to 'application/json'
|
|||
|
|
if (produces.indexOf('application/json') >= 0) {
|
|||
|
|
localVarHeaderParams.Accept = 'application/json';
|
|||
|
|
} else {
|
|||
|
|
localVarHeaderParams.Accept = produces.join(',');
|
|||
|
|
}
|
|||
|
|
let localVarFormParams: any = {};
|
|||
|
|
|
|||
|
|
// verify required parameter 'id' is not null or undefined
|
|||
|
|
if (id === null || id === undefined) {
|
|||
|
|
throw new Error('Required parameter id was null or undefined when calling certificatesActionsIdGet.');
|
|||
|
|
}
|
|||
|
|
|
|||
|
|
(<any>Object).assign(localVarHeaderParams, options.headers);
|
|||
|
|
|
|||
|
|
let localVarUseFormData = false;
|
|||
|
|
|
|||
|
|
let localVarRequestOptions: localVarRequest.Options = {
|
|||
|
|
method: 'GET',
|
|||
|
|
qs: localVarQueryParameters,
|
|||
|
|
headers: localVarHeaderParams,
|
|||
|
|
uri: localVarPath,
|
|||
|
|
useQuerystring: this._useQuerystring,
|
|||
|
|
json: true,
|
|||
|
|
};
|
|||
|
|
|
|||
|
|
let authenticationPromise = Promise.resolve();
|
|||
|
|
if (this.authentications.APIToken.accessToken) {
|
|||
|
|
authenticationPromise = authenticationPromise.then(() => this.authentications.APIToken.applyToRequest(localVarRequestOptions));
|
|||
|
|
}
|
|||
|
|
authenticationPromise = authenticationPromise.then(() => this.authentications.default.applyToRequest(localVarRequestOptions));
|
|||
|
|
|
|||
|
|
let interceptorPromise = authenticationPromise;
|
|||
|
|
for (const interceptor of this.interceptors) {
|
|||
|
|
interceptorPromise = interceptorPromise.then(() => interceptor(localVarRequestOptions));
|
|||
|
|
}
|
|||
|
|
|
|||
|
|
return interceptorPromise.then(() => {
|
|||
|
|
if (Object.keys(localVarFormParams).length) {
|
|||
|
|
if (localVarUseFormData) {
|
|||
|
|
(<any>localVarRequestOptions).formData = localVarFormParams;
|
|||
|
|
} else {
|
|||
|
|
localVarRequestOptions.form = localVarFormParams;
|
|||
|
|
}
|
|||
|
|
}
|
|||
|
|
return new Promise<{ response: http.IncomingMessage; body: ActionResponse; }>((resolve, reject) => {
|
|||
|
|
localVarRequest(localVarRequestOptions, (error, response, body) => {
|
|||
|
|
if (error) {
|
|||
|
|
reject(error);
|
|||
|
|
} else {
|
|||
|
|
if (response.statusCode && response.statusCode >= 200 && response.statusCode <= 299) {
|
|||
|
|
body = ObjectSerializer.deserialize(body, "ActionResponse");
|
|||
|
|
resolve({ response: response, body: body });
|
|||
|
|
} else {
|
|||
|
|
reject(new HttpError(response, body, response.statusCode));
|
|||
|
|
}
|
|||
|
|
}
|
|||
|
|
});
|
|||
|
|
});
|
|||
|
|
});
|
|||
|
|
}
|
|||
|
|
/**
|
|||
|
|
* Returns a specific Action for a Certificate. Only type `managed` Certificates have Actions.
|
|||
|
|
* @summary Get an Action for a Certificate
|
|||
|
|
* @param id ID of the Certificate
|
|||
|
|
* @param actionId ID of the Action
|
|||
|
|
*/
|
|||
|
|
public async certificatesIdActionsActionIdGet (id: number, actionId: number, options: {headers: {[name: string]: string}} = {headers: {}}) : Promise<{ response: http.IncomingMessage; body: ActionResponse; }> {
|
|||
|
|
const localVarPath = this.basePath + '/certificates/{id}/actions/{action_id}'
|
|||
|
|
.replace('{' + 'id' + '}', encodeURIComponent(String(id)))
|
|||
|
|
.replace('{' + 'action_id' + '}', encodeURIComponent(String(actionId)));
|
|||
|
|
let localVarQueryParameters: any = {};
|
|||
|
|
let localVarHeaderParams: any = (<any>Object).assign({}, this._defaultHeaders);
|
|||
|
|
const produces = ['application/json'];
|
|||
|
|
// give precedence to 'application/json'
|
|||
|
|
if (produces.indexOf('application/json') >= 0) {
|
|||
|
|
localVarHeaderParams.Accept = 'application/json';
|
|||
|
|
} else {
|
|||
|
|
localVarHeaderParams.Accept = produces.join(',');
|
|||
|
|
}
|
|||
|
|
let localVarFormParams: any = {};
|
|||
|
|
|
|||
|
|
// verify required parameter 'id' is not null or undefined
|
|||
|
|
if (id === null || id === undefined) {
|
|||
|
|
throw new Error('Required parameter id was null or undefined when calling certificatesIdActionsActionIdGet.');
|
|||
|
|
}
|
|||
|
|
|
|||
|
|
// verify required parameter 'actionId' is not null or undefined
|
|||
|
|
if (actionId === null || actionId === undefined) {
|
|||
|
|
throw new Error('Required parameter actionId was null or undefined when calling certificatesIdActionsActionIdGet.');
|
|||
|
|
}
|
|||
|
|
|
|||
|
|
(<any>Object).assign(localVarHeaderParams, options.headers);
|
|||
|
|
|
|||
|
|
let localVarUseFormData = false;
|
|||
|
|
|
|||
|
|
let localVarRequestOptions: localVarRequest.Options = {
|
|||
|
|
method: 'GET',
|
|||
|
|
qs: localVarQueryParameters,
|
|||
|
|
headers: localVarHeaderParams,
|
|||
|
|
uri: localVarPath,
|
|||
|
|
useQuerystring: this._useQuerystring,
|
|||
|
|
json: true,
|
|||
|
|
};
|
|||
|
|
|
|||
|
|
let authenticationPromise = Promise.resolve();
|
|||
|
|
if (this.authentications.APIToken.accessToken) {
|
|||
|
|
authenticationPromise = authenticationPromise.then(() => this.authentications.APIToken.applyToRequest(localVarRequestOptions));
|
|||
|
|
}
|
|||
|
|
authenticationPromise = authenticationPromise.then(() => this.authentications.default.applyToRequest(localVarRequestOptions));
|
|||
|
|
|
|||
|
|
let interceptorPromise = authenticationPromise;
|
|||
|
|
for (const interceptor of this.interceptors) {
|
|||
|
|
interceptorPromise = interceptorPromise.then(() => interceptor(localVarRequestOptions));
|
|||
|
|
}
|
|||
|
|
|
|||
|
|
return interceptorPromise.then(() => {
|
|||
|
|
if (Object.keys(localVarFormParams).length) {
|
|||
|
|
if (localVarUseFormData) {
|
|||
|
|
(<any>localVarRequestOptions).formData = localVarFormParams;
|
|||
|
|
} else {
|
|||
|
|
localVarRequestOptions.form = localVarFormParams;
|
|||
|
|
}
|
|||
|
|
}
|
|||
|
|
return new Promise<{ response: http.IncomingMessage; body: ActionResponse; }>((resolve, reject) => {
|
|||
|
|
localVarRequest(localVarRequestOptions, (error, response, body) => {
|
|||
|
|
if (error) {
|
|||
|
|
reject(error);
|
|||
|
|
} else {
|
|||
|
|
if (response.statusCode && response.statusCode >= 200 && response.statusCode <= 299) {
|
|||
|
|
body = ObjectSerializer.deserialize(body, "ActionResponse");
|
|||
|
|
resolve({ response: response, body: body });
|
|||
|
|
} else {
|
|||
|
|
reject(new HttpError(response, body, response.statusCode));
|
|||
|
|
}
|
|||
|
|
}
|
|||
|
|
});
|
|||
|
|
});
|
|||
|
|
});
|
|||
|
|
}
|
|||
|
|
/**
|
|||
|
|
* Returns all Action objects for a Certificate. You can sort the results by using the `sort` URI parameter, and filter them with the `status` parameter. Only type `managed` Certificates can have Actions. For type `uploaded` Certificates the `actions` key will always contain an empty array.
|
|||
|
|
* @summary Get all Actions for a Certificate
|
|||
|
|
* @param id ID of the Action.
|
|||
|
|
* @param sort Can be used multiple times.
|
|||
|
|
* @param status Can be used multiple times, the response will contain only Actions with specified statuses
|
|||
|
|
* @param page Page to load.
|
|||
|
|
* @param perPage Items to load per page.
|
|||
|
|
*/
|
|||
|
|
public async certificatesIdActionsGet (id: number, sort?: 'id' | 'id:asc' | 'id:desc' | 'command' | 'command:asc' | 'command:desc' | 'status' | 'status:asc' | 'status:desc' | 'started' | 'started:asc' | 'started:desc' | 'finished' | 'finished:asc' | 'finished:desc', status?: 'running' | 'success' | 'error', page?: number, perPage?: number, options: {headers: {[name: string]: string}} = {headers: {}}) : Promise<{ response: http.IncomingMessage; body: ActionsResponse; }> {
|
|||
|
|
const localVarPath = this.basePath + '/certificates/{id}/actions'
|
|||
|
|
.replace('{' + 'id' + '}', encodeURIComponent(String(id)));
|
|||
|
|
let localVarQueryParameters: any = {};
|
|||
|
|
let localVarHeaderParams: any = (<any>Object).assign({}, this._defaultHeaders);
|
|||
|
|
const produces = ['application/json'];
|
|||
|
|
// give precedence to 'application/json'
|
|||
|
|
if (produces.indexOf('application/json') >= 0) {
|
|||
|
|
localVarHeaderParams.Accept = 'application/json';
|
|||
|
|
} else {
|
|||
|
|
localVarHeaderParams.Accept = produces.join(',');
|
|||
|
|
}
|
|||
|
|
let localVarFormParams: any = {};
|
|||
|
|
|
|||
|
|
// verify required parameter 'id' is not null or undefined
|
|||
|
|
if (id === null || id === undefined) {
|
|||
|
|
throw new Error('Required parameter id was null or undefined when calling certificatesIdActionsGet.');
|
|||
|
|
}
|
|||
|
|
|
|||
|
|
if (sort !== undefined) {
|
|||
|
|
localVarQueryParameters['sort'] = ObjectSerializer.serialize(sort, "'id' | 'id:asc' | 'id:desc' | 'command' | 'command:asc' | 'command:desc' | 'status' | 'status:asc' | 'status:desc' | 'started' | 'started:asc' | 'started:desc' | 'finished' | 'finished:asc' | 'finished:desc'");
|
|||
|
|
}
|
|||
|
|
|
|||
|
|
if (status !== undefined) {
|
|||
|
|
localVarQueryParameters['status'] = ObjectSerializer.serialize(status, "'running' | 'success' | 'error'");
|
|||
|
|
}
|
|||
|
|
|
|||
|
|
if (page !== undefined) {
|
|||
|
|
localVarQueryParameters['page'] = ObjectSerializer.serialize(page, "number");
|
|||
|
|
}
|
|||
|
|
|
|||
|
|
if (perPage !== undefined) {
|
|||
|
|
localVarQueryParameters['per_page'] = ObjectSerializer.serialize(perPage, "number");
|
|||
|
|
}
|
|||
|
|
|
|||
|
|
(<any>Object).assign(localVarHeaderParams, options.headers);
|
|||
|
|
|
|||
|
|
let localVarUseFormData = false;
|
|||
|
|
|
|||
|
|
let localVarRequestOptions: localVarRequest.Options = {
|
|||
|
|
method: 'GET',
|
|||
|
|
qs: localVarQueryParameters,
|
|||
|
|
headers: localVarHeaderParams,
|
|||
|
|
uri: localVarPath,
|
|||
|
|
useQuerystring: this._useQuerystring,
|
|||
|
|
json: true,
|
|||
|
|
};
|
|||
|
|
|
|||
|
|
let authenticationPromise = Promise.resolve();
|
|||
|
|
if (this.authentications.APIToken.accessToken) {
|
|||
|
|
authenticationPromise = authenticationPromise.then(() => this.authentications.APIToken.applyToRequest(localVarRequestOptions));
|
|||
|
|
}
|
|||
|
|
authenticationPromise = authenticationPromise.then(() => this.authentications.default.applyToRequest(localVarRequestOptions));
|
|||
|
|
|
|||
|
|
let interceptorPromise = authenticationPromise;
|
|||
|
|
for (const interceptor of this.interceptors) {
|
|||
|
|
interceptorPromise = interceptorPromise.then(() => interceptor(localVarRequestOptions));
|
|||
|
|
}
|
|||
|
|
|
|||
|
|
return interceptorPromise.then(() => {
|
|||
|
|
if (Object.keys(localVarFormParams).length) {
|
|||
|
|
if (localVarUseFormData) {
|
|||
|
|
(<any>localVarRequestOptions).formData = localVarFormParams;
|
|||
|
|
} else {
|
|||
|
|
localVarRequestOptions.form = localVarFormParams;
|
|||
|
|
}
|
|||
|
|
}
|
|||
|
|
return new Promise<{ response: http.IncomingMessage; body: ActionsResponse; }>((resolve, reject) => {
|
|||
|
|
localVarRequest(localVarRequestOptions, (error, response, body) => {
|
|||
|
|
if (error) {
|
|||
|
|
reject(error);
|
|||
|
|
} else {
|
|||
|
|
if (response.statusCode && response.statusCode >= 200 && response.statusCode <= 299) {
|
|||
|
|
body = ObjectSerializer.deserialize(body, "ActionsResponse");
|
|||
|
|
resolve({ response: response, body: body });
|
|||
|
|
} else {
|
|||
|
|
reject(new HttpError(response, body, response.statusCode));
|
|||
|
|
}
|
|||
|
|
}
|
|||
|
|
});
|
|||
|
|
});
|
|||
|
|
});
|
|||
|
|
}
|
|||
|
|
/**
|
|||
|
|
* Retry a failed Certificate issuance or renewal. Only applicable if the type of the Certificate is `managed` and the issuance or renewal status is `failed`. #### Call specific error codes | Code | Description | |---------------------------------------------------------|---------------------------------------------------------------------------| | `caa_record_does_not_allow_ca` | CAA record does not allow certificate authority | | `ca_dns_validation_failed` | Certificate Authority: DNS validation failed | | `ca_too_many_authorizations_failed_recently` | Certificate Authority: Too many authorizations failed recently | | `ca_too_many_certificates_issued_for_registered_domain` | Certificate Authority: Too many certificates issued for registered domain | | `ca_too_many_duplicate_certificates` | Certificate Authority: Too many duplicate certificates | | `could_not_verify_domain_delegated_to_zone` | Could not verify domain delegated to zone | | `dns_zone_not_found` | DNS zone not found | | `dns_zone_is_secondary_zone` | DNS zone is a secondary zone |
|
|||
|
|
* @summary Retry Issuance or Renewal
|
|||
|
|
* @param id ID of the Certificate
|
|||
|
|
*/
|
|||
|
|
public async certificatesIdActionsRetryPost (id: number, options: {headers: {[name: string]: string}} = {headers: {}}) : Promise<{ response: http.IncomingMessage; body: ActionResponse; }> {
|
|||
|
|
const localVarPath = this.basePath + '/certificates/{id}/actions/retry'
|
|||
|
|
.replace('{' + 'id' + '}', encodeURIComponent(String(id)));
|
|||
|
|
let localVarQueryParameters: any = {};
|
|||
|
|
let localVarHeaderParams: any = (<any>Object).assign({}, this._defaultHeaders);
|
|||
|
|
const produces = ['application/json'];
|
|||
|
|
// give precedence to 'application/json'
|
|||
|
|
if (produces.indexOf('application/json') >= 0) {
|
|||
|
|
localVarHeaderParams.Accept = 'application/json';
|
|||
|
|
} else {
|
|||
|
|
localVarHeaderParams.Accept = produces.join(',');
|
|||
|
|
}
|
|||
|
|
let localVarFormParams: any = {};
|
|||
|
|
|
|||
|
|
// verify required parameter 'id' is not null or undefined
|
|||
|
|
if (id === null || id === undefined) {
|
|||
|
|
throw new Error('Required parameter id was null or undefined when calling certificatesIdActionsRetryPost.');
|
|||
|
|
}
|
|||
|
|
|
|||
|
|
(<any>Object).assign(localVarHeaderParams, options.headers);
|
|||
|
|
|
|||
|
|
let localVarUseFormData = false;
|
|||
|
|
|
|||
|
|
let localVarRequestOptions: localVarRequest.Options = {
|
|||
|
|
method: 'POST',
|
|||
|
|
qs: localVarQueryParameters,
|
|||
|
|
headers: localVarHeaderParams,
|
|||
|
|
uri: localVarPath,
|
|||
|
|
useQuerystring: this._useQuerystring,
|
|||
|
|
json: true,
|
|||
|
|
};
|
|||
|
|
|
|||
|
|
let authenticationPromise = Promise.resolve();
|
|||
|
|
if (this.authentications.APIToken.accessToken) {
|
|||
|
|
authenticationPromise = authenticationPromise.then(() => this.authentications.APIToken.applyToRequest(localVarRequestOptions));
|
|||
|
|
}
|
|||
|
|
authenticationPromise = authenticationPromise.then(() => this.authentications.default.applyToRequest(localVarRequestOptions));
|
|||
|
|
|
|||
|
|
let interceptorPromise = authenticationPromise;
|
|||
|
|
for (const interceptor of this.interceptors) {
|
|||
|
|
interceptorPromise = interceptorPromise.then(() => interceptor(localVarRequestOptions));
|
|||
|
|
}
|
|||
|
|
|
|||
|
|
return interceptorPromise.then(() => {
|
|||
|
|
if (Object.keys(localVarFormParams).length) {
|
|||
|
|
if (localVarUseFormData) {
|
|||
|
|
(<any>localVarRequestOptions).formData = localVarFormParams;
|
|||
|
|
} else {
|
|||
|
|
localVarRequestOptions.form = localVarFormParams;
|
|||
|
|
}
|
|||
|
|
}
|
|||
|
|
return new Promise<{ response: http.IncomingMessage; body: ActionResponse; }>((resolve, reject) => {
|
|||
|
|
localVarRequest(localVarRequestOptions, (error, response, body) => {
|
|||
|
|
if (error) {
|
|||
|
|
reject(error);
|
|||
|
|
} else {
|
|||
|
|
if (response.statusCode && response.statusCode >= 200 && response.statusCode <= 299) {
|
|||
|
|
body = ObjectSerializer.deserialize(body, "ActionResponse");
|
|||
|
|
resolve({ response: response, body: body });
|
|||
|
|
} else {
|
|||
|
|
reject(new HttpError(response, body, response.statusCode));
|
|||
|
|
}
|
|||
|
|
}
|
|||
|
|
});
|
|||
|
|
});
|
|||
|
|
});
|
|||
|
|
}
|
|||
|
|
}
|