@quantcdn/quant-client 3.0.0 → 3.0.2

package/dist/api/apis.d.ts

@@ -1,6 +1,8 @@
 /// <reference types="node" />
 export * from './applicationsApi';
 import { ApplicationsApi } from './applicationsApi';
+export * from './backupManagementApi';
+import { BackupManagementApi } from './backupManagementApi';
 export * from './commandsApi';
 import { CommandsApi } from './commandsApi';
 export * from './composeApi';
@@ -27,4 +29,4 @@ export declare class HttpError extends Error {
     constructor(response: http.IncomingMessage, body: any, statusCode?: number | undefined);
 }
 export { RequestFile } from '../model/models';
-export declare const APIS: (typeof ApplicationsApi | typeof CommandsApi | typeof ComposeApi | typeof ContainersApi | typeof CronApi | typeof EnvironmentsApi | typeof SSHAccessApi | typeof ScalingPolicyApi | typeof VariablesApi | typeof VolumesApi)[];
+export declare const APIS: (typeof ApplicationsApi | typeof BackupManagementApi | typeof CommandsApi | typeof ComposeApi | typeof ContainersApi | typeof CronApi | typeof EnvironmentsApi | typeof SSHAccessApi | typeof ScalingPolicyApi | typeof VariablesApi | typeof VolumesApi)[];

package/dist/api/apis.js

@@ -17,6 +17,8 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.APIS = exports.HttpError = void 0;
 __exportStar(require("./applicationsApi"), exports);
 const applicationsApi_1 = require("./applicationsApi");
+__exportStar(require("./backupManagementApi"), exports);
+const backupManagementApi_1 = require("./backupManagementApi");
 __exportStar(require("./commandsApi"), exports);
 const commandsApi_1 = require("./commandsApi");
 __exportStar(require("./composeApi"), exports);
@@ -45,4 +47,4 @@ class HttpError extends Error {
     }
 }
 exports.HttpError = HttpError;
-exports.APIS = [applicationsApi_1.ApplicationsApi, commandsApi_1.CommandsApi, composeApi_1.ComposeApi, containersApi_1.ContainersApi, cronApi_1.CronApi, environmentsApi_1.EnvironmentsApi, sSHAccessApi_1.SSHAccessApi, scalingPolicyApi_1.ScalingPolicyApi, variablesApi_1.VariablesApi, volumesApi_1.VolumesApi];
+exports.APIS = [applicationsApi_1.ApplicationsApi, backupManagementApi_1.BackupManagementApi, commandsApi_1.CommandsApi, composeApi_1.ComposeApi, containersApi_1.ContainersApi, cronApi_1.CronApi, environmentsApi_1.EnvironmentsApi, sSHAccessApi_1.SSHAccessApi, scalingPolicyApi_1.ScalingPolicyApi, variablesApi_1.VariablesApi, volumesApi_1.VolumesApi];

package/dist/api/backupManagementApi.d.ts

@@ -0,0 +1,106 @@
+/**
+ * QuantCloud API
+ * QuantCloud API
+ *
+ * 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.
+ */
+/// <reference types="node" />
+import http from 'http';
+import { CreateBackup202Response } from '../model/createBackup202Response';
+import { CreateBackupRequest } from '../model/createBackupRequest';
+import { DeleteBackup200Response } from '../model/deleteBackup200Response';
+import { DownloadBackup200Response } from '../model/downloadBackup200Response';
+import { ListBackups200Response } from '../model/listBackups200Response';
+import { Authentication, Interceptor } from '../model/models';
+export declare enum BackupManagementApiApiKeys {
+}
+export declare class BackupManagementApi {
+    protected _basePath: string;
+    protected _defaultHeaders: any;
+    protected _useQuerystring: boolean;
+    protected authentications: {
+        default: Authentication;
+    };
+    protected interceptors: Interceptor[];
+    constructor(basePath?: string);
+    set useQuerystring(value: boolean);
+    set basePath(basePath: string);
+    set defaultHeaders(defaultHeaders: any);
+    get defaultHeaders(): any;
+    get basePath(): string;
+    setDefaultAuthentication(auth: Authentication): void;
+    setApiKey(key: BackupManagementApiApiKeys, value: string): void;
+    addInterceptor(interceptor: Interceptor): void;
+    /**
+     *
+     * @summary Create a backup for an environment
+     * @param organisation The organisation ID
+     * @param application The application ID
+     * @param environment The environment ID
+     * @param type The backup type
+     * @param createBackupRequest
+     */
+    createBackup(organisation: string, application: string, environment: string, type: 'database' | 'filesystem', createBackupRequest?: CreateBackupRequest, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<{
+        response: http.IncomingMessage;
+        body: CreateBackup202Response;
+    }>;
+    /**
+     *
+     * @summary Delete a backup
+     * @param organisation The organisation ID
+     * @param application The application ID
+     * @param environment The environment ID
+     * @param type The backup type
+     * @param backupId The backup ID
+     */
+    deleteBackup(organisation: string, application: string, environment: string, type: 'database' | 'filesystem', backupId: string, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<{
+        response: http.IncomingMessage;
+        body: DeleteBackup200Response;
+    }>;
+    /**
+     *
+     * @summary Generate a download URL for a backup
+     * @param organisation The organisation ID
+     * @param application The application ID
+     * @param environment The environment ID
+     * @param type The backup type
+     * @param backupId The backup ID
+     */
+    downloadBackup(organisation: string, application: string, environment: string, type: 'database' | 'filesystem', backupId: string, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<{
+        response: http.IncomingMessage;
+        body: DownloadBackup200Response;
+    }>;
+    /**
+     *
+     * @summary List backups for an environment
+     * @param organisation The organisation ID
+     * @param application The application ID
+     * @param environment The environment ID
+     * @param type The backup type
+     */
+    listBackups(organisation: string, application: string, environment: string, type: 'database' | 'filesystem', options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<{
+        response: http.IncomingMessage;
+        body: ListBackups200Response;
+    }>;
+}

package/dist/api/backupManagementApi.js

@@ -0,0 +1,440 @@
+"use strict";
+/**
+ * QuantCloud API
+ * QuantCloud API
+ *
+ * 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.
+ */
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BackupManagementApi = exports.BackupManagementApiApiKeys = void 0;
+const request_1 = __importDefault(require("request"));
+const models_1 = require("../model/models");
+const apis_1 = require("./apis");
+let defaultBasePath = 'http://localhost';
+// ===============================================
+// This file is autogenerated - Please do not edit
+// ===============================================
+var BackupManagementApiApiKeys;
+(function (BackupManagementApiApiKeys) {
+})(BackupManagementApiApiKeys = exports.BackupManagementApiApiKeys || (exports.BackupManagementApiApiKeys = {}));
+class BackupManagementApi {
+    constructor(basePathOrUsername, password, basePath) {
+        this._basePath = defaultBasePath;
+        this._defaultHeaders = {};
+        this._useQuerystring = false;
+        this.authentications = {
+            'default': new models_1.VoidAuth(),
+        };
+        this.interceptors = [];
+        if (password) {
+            if (basePath) {
+                this.basePath = basePath;
+            }
+        }
+        else {
+            if (basePathOrUsername) {
+                this.basePath = basePathOrUsername;
+            }
+        }
+    }
+    set useQuerystring(value) {
+        this._useQuerystring = value;
+    }
+    set basePath(basePath) {
+        this._basePath = basePath;
+    }
+    set defaultHeaders(defaultHeaders) {
+        this._defaultHeaders = defaultHeaders;
+    }
+    get defaultHeaders() {
+        return this._defaultHeaders;
+    }
+    get basePath() {
+        return this._basePath;
+    }
+    setDefaultAuthentication(auth) {
+        this.authentications.default = auth;
+    }
+    setApiKey(key, value) {
+        this.authentications[BackupManagementApiApiKeys[key]].apiKey = value;
+    }
+    addInterceptor(interceptor) {
+        this.interceptors.push(interceptor);
+    }
+    /**
+     *
+     * @summary Create a backup for an environment
+     * @param organisation The organisation ID
+     * @param application The application ID
+     * @param environment The environment ID
+     * @param type The backup type
+     * @param createBackupRequest
+     */
+    createBackup(organisation, application, environment, type, createBackupRequest, options = { headers: {} }) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const localVarPath = this.basePath + '/organisations/{organisation}/applications/{application}/environments/{environment}/backups/{type}'
+                .replace('{' + 'organisation' + '}', encodeURIComponent(String(organisation)))
+                .replace('{' + 'application' + '}', encodeURIComponent(String(application)))
+                .replace('{' + 'environment' + '}', encodeURIComponent(String(environment)))
+                .replace('{' + 'type' + '}', encodeURIComponent(String(type)));
+            let localVarQueryParameters = {};
+            let localVarHeaderParams = 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 = {};
+            // verify required parameter 'organisation' is not null or undefined
+            if (organisation === null || organisation === undefined) {
+                throw new Error('Required parameter organisation was null or undefined when calling createBackup.');
+            }
+            // verify required parameter 'application' is not null or undefined
+            if (application === null || application === undefined) {
+                throw new Error('Required parameter application was null or undefined when calling createBackup.');
+            }
+            // verify required parameter 'environment' is not null or undefined
+            if (environment === null || environment === undefined) {
+                throw new Error('Required parameter environment was null or undefined when calling createBackup.');
+            }
+            // verify required parameter 'type' is not null or undefined
+            if (type === null || type === undefined) {
+                throw new Error('Required parameter type was null or undefined when calling createBackup.');
+            }
+            Object.assign(localVarHeaderParams, options.headers);
+            let localVarUseFormData = false;
+            let localVarRequestOptions = {
+                method: 'POST',
+                qs: localVarQueryParameters,
+                headers: localVarHeaderParams,
+                uri: localVarPath,
+                useQuerystring: this._useQuerystring,
+                json: true,
+                body: models_1.ObjectSerializer.serialize(createBackupRequest, "CreateBackupRequest")
+            };
+            let authenticationPromise = Promise.resolve();
+            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) {
+                        localVarRequestOptions.formData = localVarFormParams;
+                    }
+                    else {
+                        localVarRequestOptions.form = localVarFormParams;
+                    }
+                }
+                return new Promise((resolve, reject) => {
+                    (0, request_1.default)(localVarRequestOptions, (error, response, body) => {
+                        if (error) {
+                            reject(error);
+                        }
+                        else {
+                            if (response.statusCode && response.statusCode >= 200 && response.statusCode <= 299) {
+                                body = models_1.ObjectSerializer.deserialize(body, "CreateBackup202Response");
+                                resolve({ response: response, body: body });
+                            }
+                            else {
+                                reject(new apis_1.HttpError(response, body, response.statusCode));
+                            }
+                        }
+                    });
+                });
+            });
+        });
+    }
+    /**
+     *
+     * @summary Delete a backup
+     * @param organisation The organisation ID
+     * @param application The application ID
+     * @param environment The environment ID
+     * @param type The backup type
+     * @param backupId The backup ID
+     */
+    deleteBackup(organisation, application, environment, type, backupId, options = { headers: {} }) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const localVarPath = this.basePath + '/organisations/{organisation}/applications/{application}/environments/{environment}/backups/{type}/{backupId}'
+                .replace('{' + 'organisation' + '}', encodeURIComponent(String(organisation)))
+                .replace('{' + 'application' + '}', encodeURIComponent(String(application)))
+                .replace('{' + 'environment' + '}', encodeURIComponent(String(environment)))
+                .replace('{' + 'type' + '}', encodeURIComponent(String(type)))
+                .replace('{' + 'backupId' + '}', encodeURIComponent(String(backupId)));
+            let localVarQueryParameters = {};
+            let localVarHeaderParams = 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 = {};
+            // verify required parameter 'organisation' is not null or undefined
+            if (organisation === null || organisation === undefined) {
+                throw new Error('Required parameter organisation was null or undefined when calling deleteBackup.');
+            }
+            // verify required parameter 'application' is not null or undefined
+            if (application === null || application === undefined) {
+                throw new Error('Required parameter application was null or undefined when calling deleteBackup.');
+            }
+            // verify required parameter 'environment' is not null or undefined
+            if (environment === null || environment === undefined) {
+                throw new Error('Required parameter environment was null or undefined when calling deleteBackup.');
+            }
+            // verify required parameter 'type' is not null or undefined
+            if (type === null || type === undefined) {
+                throw new Error('Required parameter type was null or undefined when calling deleteBackup.');
+            }
+            // verify required parameter 'backupId' is not null or undefined
+            if (backupId === null || backupId === undefined) {
+                throw new Error('Required parameter backupId was null or undefined when calling deleteBackup.');
+            }
+            Object.assign(localVarHeaderParams, options.headers);
+            let localVarUseFormData = false;
+            let localVarRequestOptions = {
+                method: 'DELETE',
+                qs: localVarQueryParameters,
+                headers: localVarHeaderParams,
+                uri: localVarPath,
+                useQuerystring: this._useQuerystring,
+                json: true,
+            };
+            let authenticationPromise = Promise.resolve();
+            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) {
+                        localVarRequestOptions.formData = localVarFormParams;
+                    }
+                    else {
+                        localVarRequestOptions.form = localVarFormParams;
+                    }
+                }
+                return new Promise((resolve, reject) => {
+                    (0, request_1.default)(localVarRequestOptions, (error, response, body) => {
+                        if (error) {
+                            reject(error);
+                        }
+                        else {
+                            if (response.statusCode && response.statusCode >= 200 && response.statusCode <= 299) {
+                                body = models_1.ObjectSerializer.deserialize(body, "DeleteBackup200Response");
+                                resolve({ response: response, body: body });
+                            }
+                            else {
+                                reject(new apis_1.HttpError(response, body, response.statusCode));
+                            }
+                        }
+                    });
+                });
+            });
+        });
+    }
+    /**
+     *
+     * @summary Generate a download URL for a backup
+     * @param organisation The organisation ID
+     * @param application The application ID
+     * @param environment The environment ID
+     * @param type The backup type
+     * @param backupId The backup ID
+     */
+    downloadBackup(organisation, application, environment, type, backupId, options = { headers: {} }) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const localVarPath = this.basePath + '/organisations/{organisation}/applications/{application}/environments/{environment}/backups/{type}/{backupId}/download'
+                .replace('{' + 'organisation' + '}', encodeURIComponent(String(organisation)))
+                .replace('{' + 'application' + '}', encodeURIComponent(String(application)))
+                .replace('{' + 'environment' + '}', encodeURIComponent(String(environment)))
+                .replace('{' + 'type' + '}', encodeURIComponent(String(type)))
+                .replace('{' + 'backupId' + '}', encodeURIComponent(String(backupId)));
+            let localVarQueryParameters = {};
+            let localVarHeaderParams = 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 = {};
+            // verify required parameter 'organisation' is not null or undefined
+            if (organisation === null || organisation === undefined) {
+                throw new Error('Required parameter organisation was null or undefined when calling downloadBackup.');
+            }
+            // verify required parameter 'application' is not null or undefined
+            if (application === null || application === undefined) {
+                throw new Error('Required parameter application was null or undefined when calling downloadBackup.');
+            }
+            // verify required parameter 'environment' is not null or undefined
+            if (environment === null || environment === undefined) {
+                throw new Error('Required parameter environment was null or undefined when calling downloadBackup.');
+            }
+            // verify required parameter 'type' is not null or undefined
+            if (type === null || type === undefined) {
+                throw new Error('Required parameter type was null or undefined when calling downloadBackup.');
+            }
+            // verify required parameter 'backupId' is not null or undefined
+            if (backupId === null || backupId === undefined) {
+                throw new Error('Required parameter backupId was null or undefined when calling downloadBackup.');
+            }
+            Object.assign(localVarHeaderParams, options.headers);
+            let localVarUseFormData = false;
+            let localVarRequestOptions = {
+                method: 'GET',
+                qs: localVarQueryParameters,
+                headers: localVarHeaderParams,
+                uri: localVarPath,
+                useQuerystring: this._useQuerystring,
+                json: true,
+            };
+            let authenticationPromise = Promise.resolve();
+            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) {
+                        localVarRequestOptions.formData = localVarFormParams;
+                    }
+                    else {
+                        localVarRequestOptions.form = localVarFormParams;
+                    }
+                }
+                return new Promise((resolve, reject) => {
+                    (0, request_1.default)(localVarRequestOptions, (error, response, body) => {
+                        if (error) {
+                            reject(error);
+                        }
+                        else {
+                            if (response.statusCode && response.statusCode >= 200 && response.statusCode <= 299) {
+                                body = models_1.ObjectSerializer.deserialize(body, "DownloadBackup200Response");
+                                resolve({ response: response, body: body });
+                            }
+                            else {
+                                reject(new apis_1.HttpError(response, body, response.statusCode));
+                            }
+                        }
+                    });
+                });
+            });
+        });
+    }
+    /**
+     *
+     * @summary List backups for an environment
+     * @param organisation The organisation ID
+     * @param application The application ID
+     * @param environment The environment ID
+     * @param type The backup type
+     */
+    listBackups(organisation, application, environment, type, options = { headers: {} }) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const localVarPath = this.basePath + '/organisations/{organisation}/applications/{application}/environments/{environment}/backups/{type}'
+                .replace('{' + 'organisation' + '}', encodeURIComponent(String(organisation)))
+                .replace('{' + 'application' + '}', encodeURIComponent(String(application)))
+                .replace('{' + 'environment' + '}', encodeURIComponent(String(environment)))
+                .replace('{' + 'type' + '}', encodeURIComponent(String(type)));
+            let localVarQueryParameters = {};
+            let localVarHeaderParams = 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 = {};
+            // verify required parameter 'organisation' is not null or undefined
+            if (organisation === null || organisation === undefined) {
+                throw new Error('Required parameter organisation was null or undefined when calling listBackups.');
+            }
+            // verify required parameter 'application' is not null or undefined
+            if (application === null || application === undefined) {
+                throw new Error('Required parameter application was null or undefined when calling listBackups.');
+            }
+            // verify required parameter 'environment' is not null or undefined
+            if (environment === null || environment === undefined) {
+                throw new Error('Required parameter environment was null or undefined when calling listBackups.');
+            }
+            // verify required parameter 'type' is not null or undefined
+            if (type === null || type === undefined) {
+                throw new Error('Required parameter type was null or undefined when calling listBackups.');
+            }
+            Object.assign(localVarHeaderParams, options.headers);
+            let localVarUseFormData = false;
+            let localVarRequestOptions = {
+                method: 'GET',
+                qs: localVarQueryParameters,
+                headers: localVarHeaderParams,
+                uri: localVarPath,
+                useQuerystring: this._useQuerystring,
+                json: true,
+            };
+            let authenticationPromise = Promise.resolve();
+            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) {
+                        localVarRequestOptions.formData = localVarFormParams;
+                    }
+                    else {
+                        localVarRequestOptions.form = localVarFormParams;
+                    }
+                }
+                return new Promise((resolve, reject) => {
+                    (0, request_1.default)(localVarRequestOptions, (error, response, body) => {
+                        if (error) {
+                            reject(error);
+                        }
+                        else {
+                            if (response.statusCode && response.statusCode >= 200 && response.statusCode <= 299) {
+                                body = models_1.ObjectSerializer.deserialize(body, "ListBackups200Response");
+                                resolve({ response: response, body: body });
+                            }
+                            else {
+                                reject(new apis_1.HttpError(response, body, response.statusCode));
+                            }
+                        }
+                    });
+                });
+            });
+        });
+    }
+}
+exports.BackupManagementApi = BackupManagementApi;

package/dist/api/sSHAccessApi.d.ts

@@ -35,9 +35,9 @@ export declare class SSHAccessApi {
     /**
      *
      * @summary Get SSH access credentials for an environment
-     * @param organisation The organisation ID
-     * @param application The application ID
-     * @param environment The environment ID
+     * @param organisation The organisation machine name
+     * @param application The application name
+     * @param environment The environment name
      */
     getSshAccessCredentials(organisation: string, application: string, environment: string, options?: {
         headers: {

package/dist/api/sSHAccessApi.js

@@ -81,9 +81,9 @@ class SSHAccessApi {
     /**
      *
      * @summary Get SSH access credentials for an environment
-     * @param organisation The organisation ID
-     * @param application The application ID
-     * @param environment The environment ID
+     * @param organisation The organisation machine name
+     * @param application The application name
+     * @param environment The environment name
      */
     getSshAccessCredentials(organisation, application, environment, options = { headers: {} }) {
         return __awaiter(this, void 0, void 0, function* () {

package/dist/model/createBackup202Response.d.ts

@@ -0,0 +1,27 @@
+/**
+ * QuantCloud API
+ * QuantCloud API
+ *
+ * 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.
+ */
+export declare class CreateBackup202Response {
+    'backupId'?: string;
+    'status'?: string;
+    'message'?: string;
+    static discriminator: string | undefined;
+    static attributeTypeMap: Array<{
+        name: string;
+        baseName: string;
+        type: string;
+    }>;
+    static getAttributeTypeMap(): {
+        name: string;
+        baseName: string;
+        type: string;
+    }[];
+}

package/dist/model/createBackup202Response.js

@@ -0,0 +1,38 @@
+"use strict";
+/**
+ * QuantCloud API
+ * QuantCloud API
+ *
+ * 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.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CreateBackup202Response = void 0;
+class CreateBackup202Response {
+    static getAttributeTypeMap() {
+        return CreateBackup202Response.attributeTypeMap;
+    }
+}
+exports.CreateBackup202Response = CreateBackup202Response;
+CreateBackup202Response.discriminator = undefined;
+CreateBackup202Response.attributeTypeMap = [
+    {
+        "name": "backupId",
+        "baseName": "backupId",
+        "type": "string"
+    },
+    {
+        "name": "status",
+        "baseName": "status",
+        "type": "string"
+    },
+    {
+        "name": "message",
+        "baseName": "message",
+        "type": "string"
+    }
+];

package/dist/model/createBackupRequest.d.ts

@@ -0,0 +1,32 @@
+/**
+ * QuantCloud API
+ * QuantCloud API
+ *
+ * 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.
+ */
+export declare class CreateBackupRequest {
+    /**
+    * Optional backup description
+    */
+    'description'?: string;
+    /**
+    * Optional retention period in days
+    */
+    'retentionDays'?: number;
+    static discriminator: string | undefined;
+    static attributeTypeMap: Array<{
+        name: string;
+        baseName: string;
+        type: string;
+    }>;
+    static getAttributeTypeMap(): {
+        name: string;
+        baseName: string;
+        type: string;
+    }[];
+}

package/dist/model/createBackupRequest.js

@@ -0,0 +1,33 @@
+"use strict";
+/**
+ * QuantCloud API
+ * QuantCloud API
+ *
+ * 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.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CreateBackupRequest = void 0;
+class CreateBackupRequest {
+    static getAttributeTypeMap() {
+        return CreateBackupRequest.attributeTypeMap;
+    }
+}
+exports.CreateBackupRequest = CreateBackupRequest;
+CreateBackupRequest.discriminator = undefined;
+CreateBackupRequest.attributeTypeMap = [
+    {
+        "name": "description",
+        "baseName": "description",
+        "type": "string"
+    },
+    {
+        "name": "retentionDays",
+        "baseName": "retentionDays",
+        "type": "number"
+    }
+];

package/dist/model/deleteBackup200Response.d.ts

@@ -0,0 +1,26 @@
+/**
+ * QuantCloud API
+ * QuantCloud API
+ *
+ * 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.
+ */
+export declare class DeleteBackup200Response {
+    'message'?: string;
+    'backupId'?: string;
+    static discriminator: string | undefined;
+    static attributeTypeMap: Array<{
+        name: string;
+        baseName: string;
+        type: string;
+    }>;
+    static getAttributeTypeMap(): {
+        name: string;
+        baseName: string;
+        type: string;
+    }[];
+}

package/dist/model/deleteBackup200Response.js

@@ -0,0 +1,33 @@
+"use strict";
+/**
+ * QuantCloud API
+ * QuantCloud API
+ *
+ * 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.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DeleteBackup200Response = void 0;
+class DeleteBackup200Response {
+    static getAttributeTypeMap() {
+        return DeleteBackup200Response.attributeTypeMap;
+    }
+}
+exports.DeleteBackup200Response = DeleteBackup200Response;
+DeleteBackup200Response.discriminator = undefined;
+DeleteBackup200Response.attributeTypeMap = [
+    {
+        "name": "message",
+        "baseName": "message",
+        "type": "string"
+    },
+    {
+        "name": "backupId",
+        "baseName": "backupId",
+        "type": "string"
+    }
+];

package/dist/model/downloadBackup200Response.d.ts

@@ -0,0 +1,36 @@
+/**
+ * QuantCloud API
+ * QuantCloud API
+ *
+ * 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.
+ */
+export declare class DownloadBackup200Response {
+    /**
+    * Pre-signed S3 URL for download
+    */
+    'downloadUrl'?: string;
+    /**
+    * URL expiration time
+    */
+    'expiresAt'?: Date;
+    /**
+    * Suggested filename for download
+    */
+    'filename'?: string;
+    static discriminator: string | undefined;
+    static attributeTypeMap: Array<{
+        name: string;
+        baseName: string;
+        type: string;
+    }>;
+    static getAttributeTypeMap(): {
+        name: string;
+        baseName: string;
+        type: string;
+    }[];
+}

package/dist/model/downloadBackup200Response.js

@@ -0,0 +1,38 @@
+"use strict";
+/**
+ * QuantCloud API
+ * QuantCloud API
+ *
+ * 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.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DownloadBackup200Response = void 0;
+class DownloadBackup200Response {
+    static getAttributeTypeMap() {
+        return DownloadBackup200Response.attributeTypeMap;
+    }
+}
+exports.DownloadBackup200Response = DownloadBackup200Response;
+DownloadBackup200Response.discriminator = undefined;
+DownloadBackup200Response.attributeTypeMap = [
+    {
+        "name": "downloadUrl",
+        "baseName": "downloadUrl",
+        "type": "string"
+    },
+    {
+        "name": "expiresAt",
+        "baseName": "expiresAt",
+        "type": "Date"
+    },
+    {
+        "name": "filename",
+        "baseName": "filename",
+        "type": "string"
+    }
+];

package/dist/model/listBackups200Response.d.ts

@@ -0,0 +1,28 @@
+/**
+ * QuantCloud API
+ * QuantCloud API
+ *
+ * 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 { ListBackups200ResponseBackupsInner } from './listBackups200ResponseBackupsInner';
+export declare class ListBackups200Response {
+    'backups'?: Array<ListBackups200ResponseBackupsInner>;
+    'count'?: number;
+    'message'?: string;
+    static discriminator: string | undefined;
+    static attributeTypeMap: Array<{
+        name: string;
+        baseName: string;
+        type: string;
+    }>;
+    static getAttributeTypeMap(): {
+        name: string;
+        baseName: string;
+        type: string;
+    }[];
+}

package/dist/model/listBackups200Response.js

@@ -0,0 +1,38 @@
+"use strict";
+/**
+ * QuantCloud API
+ * QuantCloud API
+ *
+ * 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.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ListBackups200Response = void 0;
+class ListBackups200Response {
+    static getAttributeTypeMap() {
+        return ListBackups200Response.attributeTypeMap;
+    }
+}
+exports.ListBackups200Response = ListBackups200Response;
+ListBackups200Response.discriminator = undefined;
+ListBackups200Response.attributeTypeMap = [
+    {
+        "name": "backups",
+        "baseName": "backups",
+        "type": "Array<ListBackups200ResponseBackupsInner>"
+    },
+    {
+        "name": "count",
+        "baseName": "count",
+        "type": "number"
+    },
+    {
+        "name": "message",
+        "baseName": "message",
+        "type": "string"
+    }
+];

package/dist/model/listBackups200ResponseBackupsInner.d.ts

@@ -0,0 +1,37 @@
+/**
+ * QuantCloud API
+ * QuantCloud API
+ *
+ * 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.
+ */
+export declare class ListBackups200ResponseBackupsInner {
+    'backupId'?: string;
+    'status'?: string;
+    'type'?: string;
+    'engine'?: string;
+    'description'?: string;
+    'createdAt'?: Date;
+    'updatedAt'?: Date;
+    'taskArn'?: string;
+    's3Key'?: string;
+    'bucketName'?: string;
+    'size'?: number;
+    'sizeFormatted'?: string;
+    'fileExists'?: boolean;
+    static discriminator: string | undefined;
+    static attributeTypeMap: Array<{
+        name: string;
+        baseName: string;
+        type: string;
+    }>;
+    static getAttributeTypeMap(): {
+        name: string;
+        baseName: string;
+        type: string;
+    }[];
+}

package/dist/model/listBackups200ResponseBackupsInner.js

@@ -0,0 +1,88 @@
+"use strict";
+/**
+ * QuantCloud API
+ * QuantCloud API
+ *
+ * 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.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ListBackups200ResponseBackupsInner = void 0;
+class ListBackups200ResponseBackupsInner {
+    static getAttributeTypeMap() {
+        return ListBackups200ResponseBackupsInner.attributeTypeMap;
+    }
+}
+exports.ListBackups200ResponseBackupsInner = ListBackups200ResponseBackupsInner;
+ListBackups200ResponseBackupsInner.discriminator = undefined;
+ListBackups200ResponseBackupsInner.attributeTypeMap = [
+    {
+        "name": "backupId",
+        "baseName": "backupId",
+        "type": "string"
+    },
+    {
+        "name": "status",
+        "baseName": "status",
+        "type": "string"
+    },
+    {
+        "name": "type",
+        "baseName": "type",
+        "type": "string"
+    },
+    {
+        "name": "engine",
+        "baseName": "engine",
+        "type": "string"
+    },
+    {
+        "name": "description",
+        "baseName": "description",
+        "type": "string"
+    },
+    {
+        "name": "createdAt",
+        "baseName": "createdAt",
+        "type": "Date"
+    },
+    {
+        "name": "updatedAt",
+        "baseName": "updatedAt",
+        "type": "Date"
+    },
+    {
+        "name": "taskArn",
+        "baseName": "taskArn",
+        "type": "string"
+    },
+    {
+        "name": "s3Key",
+        "baseName": "s3Key",
+        "type": "string"
+    },
+    {
+        "name": "bucketName",
+        "baseName": "bucketName",
+        "type": "string"
+    },
+    {
+        "name": "size",
+        "baseName": "size",
+        "type": "number"
+    },
+    {
+        "name": "sizeFormatted",
+        "baseName": "sizeFormatted",
+        "type": "string"
+    },
+    {
+        "name": "fileExists",
+        "baseName": "fileExists",
+        "type": "boolean"
+    }
+];

package/dist/model/models.d.ts

@@ -9,16 +9,22 @@ export * from './container';
 export * from './containerEnvironmentInner';
 export * from './containerImageReference';
 export * from './containerMountPointsInner';
+export * from './createBackup202Response';
+export * from './createBackupRequest';
 export * from './createCommandRequest';
 export * from './createCronJob422Response';
 export * from './createCronJobRequest';
 export * from './createEnvironmentRequest';
 export * from './cron';
 export * from './cronRun';
+export * from './deleteBackup200Response';
+export * from './downloadBackup200Response';
 export * from './environment';
 export * from './getEcrLoginCredentials200Response';
 export * from './getSshAccessCredentials200Response';
 export * from './getSshAccessCredentials200ResponseCredentials';
+export * from './listBackups200Response';
+export * from './listBackups200ResponseBackupsInner';
 export * from './scalingPolicy';
 export * from './syncOperation';
 export * from './syncToEnvironmentRequest';

package/dist/model/models.js

@@ -22,16 +22,22 @@ __exportStar(require("./container"), exports);
 __exportStar(require("./containerEnvironmentInner"), exports);
 __exportStar(require("./containerImageReference"), exports);
 __exportStar(require("./containerMountPointsInner"), exports);
+__exportStar(require("./createBackup202Response"), exports);
+__exportStar(require("./createBackupRequest"), exports);
 __exportStar(require("./createCommandRequest"), exports);
 __exportStar(require("./createCronJob422Response"), exports);
 __exportStar(require("./createCronJobRequest"), exports);
 __exportStar(require("./createEnvironmentRequest"), exports);
 __exportStar(require("./cron"), exports);
 __exportStar(require("./cronRun"), exports);
+__exportStar(require("./deleteBackup200Response"), exports);
+__exportStar(require("./downloadBackup200Response"), exports);
 __exportStar(require("./environment"), exports);
 __exportStar(require("./getEcrLoginCredentials200Response"), exports);
 __exportStar(require("./getSshAccessCredentials200Response"), exports);
 __exportStar(require("./getSshAccessCredentials200ResponseCredentials"), exports);
+__exportStar(require("./listBackups200Response"), exports);
+__exportStar(require("./listBackups200ResponseBackupsInner"), exports);
 __exportStar(require("./scalingPolicy"), exports);
 __exportStar(require("./syncOperation"), exports);
 __exportStar(require("./syncToEnvironmentRequest"), exports);
@@ -50,16 +56,22 @@ const container_1 = require("./container");
 const containerEnvironmentInner_1 = require("./containerEnvironmentInner");
 const containerImageReference_1 = require("./containerImageReference");
 const containerMountPointsInner_1 = require("./containerMountPointsInner");
+const createBackup202Response_1 = require("./createBackup202Response");
+const createBackupRequest_1 = require("./createBackupRequest");
 const createCommandRequest_1 = require("./createCommandRequest");
 const createCronJob422Response_1 = require("./createCronJob422Response");
 const createCronJobRequest_1 = require("./createCronJobRequest");
 const createEnvironmentRequest_1 = require("./createEnvironmentRequest");
 const cron_1 = require("./cron");
 const cronRun_1 = require("./cronRun");
+const deleteBackup200Response_1 = require("./deleteBackup200Response");
+const downloadBackup200Response_1 = require("./downloadBackup200Response");
 const environment_1 = require("./environment");
 const getEcrLoginCredentials200Response_1 = require("./getEcrLoginCredentials200Response");
 const getSshAccessCredentials200Response_1 = require("./getSshAccessCredentials200Response");
 const getSshAccessCredentials200ResponseCredentials_1 = require("./getSshAccessCredentials200ResponseCredentials");
+const listBackups200Response_1 = require("./listBackups200Response");
+const listBackups200ResponseBackupsInner_1 = require("./listBackups200ResponseBackupsInner");
 const scalingPolicy_1 = require("./scalingPolicy");
 const syncOperation_1 = require("./syncOperation");
 const syncToEnvironmentRequest_1 = require("./syncToEnvironmentRequest");
@@ -95,16 +107,22 @@ let typeMap = {
     "ContainerEnvironmentInner": containerEnvironmentInner_1.ContainerEnvironmentInner,
     "ContainerImageReference": containerImageReference_1.ContainerImageReference,
     "ContainerMountPointsInner": containerMountPointsInner_1.ContainerMountPointsInner,
+    "CreateBackup202Response": createBackup202Response_1.CreateBackup202Response,
+    "CreateBackupRequest": createBackupRequest_1.CreateBackupRequest,
     "CreateCommandRequest": createCommandRequest_1.CreateCommandRequest,
     "CreateCronJob422Response": createCronJob422Response_1.CreateCronJob422Response,
     "CreateCronJobRequest": createCronJobRequest_1.CreateCronJobRequest,
     "CreateEnvironmentRequest": createEnvironmentRequest_1.CreateEnvironmentRequest,
     "Cron": cron_1.Cron,
     "CronRun": cronRun_1.CronRun,
+    "DeleteBackup200Response": deleteBackup200Response_1.DeleteBackup200Response,
+    "DownloadBackup200Response": downloadBackup200Response_1.DownloadBackup200Response,
     "Environment": environment_1.Environment,
     "GetEcrLoginCredentials200Response": getEcrLoginCredentials200Response_1.GetEcrLoginCredentials200Response,
     "GetSshAccessCredentials200Response": getSshAccessCredentials200Response_1.GetSshAccessCredentials200Response,
     "GetSshAccessCredentials200ResponseCredentials": getSshAccessCredentials200ResponseCredentials_1.GetSshAccessCredentials200ResponseCredentials,
+    "ListBackups200Response": listBackups200Response_1.ListBackups200Response,
+    "ListBackups200ResponseBackupsInner": listBackups200ResponseBackupsInner_1.ListBackups200ResponseBackupsInner,
     "ScalingPolicy": scalingPolicy_1.ScalingPolicy,
     "SyncOperation": syncOperation_1.SyncOperation,
     "SyncToEnvironmentRequest": syncToEnvironmentRequest_1.SyncToEnvironmentRequest,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@quantcdn/quant-client",
-  "version": "3.0.0",
+  "version": "3.0.2",
   "description": "TypeScript client for Quant Cloud API",
   "main": "dist/api.js",
   "types": "dist/api.d.ts",
@@ -22,10 +22,10 @@
   "devDependencies": {
     "typescript": "^4.9.5",
     "@types/node": "^18.14.0",
-    "@types/request": "^2.48.8"
+    "@types/request": "^2.48.13"
   },
   "dependencies": {
     "axios": "^1.3.4",
     "request": "^2.88.2"
   }
-} 
+}