@quantcdn/quant-client 2.0.13 → 3.0.1

package/dist/api/environmentsApi.d.ts

@@ -0,0 +1,194 @@
+/**
+ * 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 { CreateEnvironmentRequest } from '../model/createEnvironmentRequest';
+import { Environment } from '../model/environment';
+import { SyncOperation } from '../model/syncOperation';
+import { SyncToEnvironmentRequest } from '../model/syncToEnvironmentRequest';
+import { UpdateEnvironmentRequest } from '../model/updateEnvironmentRequest';
+import { UpdateEnvironmentStateRequest } from '../model/updateEnvironmentStateRequest';
+import { Authentication, Interceptor } from '../model/models';
+export declare enum EnvironmentsApiApiKeys {
+}
+export declare class EnvironmentsApi {
+    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: EnvironmentsApiApiKeys, value: string): void;
+    addInterceptor(interceptor: Interceptor): void;
+    /**
+     *
+     * @summary Create a new environment
+     * @param organisation The organisation ID
+     * @param application The application ID
+     * @param createEnvironmentRequest
+     */
+    createEnvironment(organisation: string, application: string, createEnvironmentRequest: CreateEnvironmentRequest, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<{
+        response: http.IncomingMessage;
+        body: Environment;
+    }>;
+    /**
+     *
+     * @summary Delete an environment
+     * @param organisation The organisation ID
+     * @param application The application ID
+     * @param environment The environment ID
+     */
+    deleteEnvironment(organisation: string, application: string, environment: string, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<{
+        response: http.IncomingMessage;
+        body?: any;
+    }>;
+    /**
+     *
+     * @summary Get a single environment
+     * @param organisation The organisation ID
+     * @param application The application ID
+     * @param environment The environment ID
+     */
+    getEnvironment(organisation: string, application: string, environment: string, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<{
+        response: http.IncomingMessage;
+        body: Environment;
+    }>;
+    /**
+     *
+     * @summary Get the logs for an environment
+     * @param organisation The organisation ID
+     * @param application The application ID
+     * @param environment The environment ID
+     */
+    getEnvironmentLogs(organisation: string, application: string, environment: string, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<{
+        response: http.IncomingMessage;
+        body?: any;
+    }>;
+    /**
+     *
+     * @summary Get the metrics for an environment
+     * @param organisation The organisation ID
+     * @param application The application ID
+     * @param environment The environment ID
+     */
+    getEnvironmentMetrics(organisation: string, application: string, environment: string, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<{
+        response: http.IncomingMessage;
+        body?: any;
+    }>;
+    /**
+     *
+     * @summary Get all environments for an application
+     * @param organisation The organisation ID
+     * @param application The application ID
+     */
+    listEnvironments(organisation: string, application: string, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<{
+        response: http.IncomingMessage;
+        body: Array<Environment>;
+    }>;
+    /**
+     *
+     * @summary List the sync operations for an environment
+     * @param organisation The organisation ID
+     * @param application The application ID
+     * @param environment The environment ID
+     * @param type The sync type
+     */
+    listSyncOperations(organisation: string, application: string, environment: string, type: 'database' | 'filesystem', options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<{
+        response: http.IncomingMessage;
+        body: Array<SyncOperation>;
+    }>;
+    /**
+     *
+     * @summary Perform a sync operation from a source environment to the current environment
+     * @param organisation The organisation ID
+     * @param application The application ID
+     * @param environment The environment ID
+     * @param type The sync type
+     * @param syncToEnvironmentRequest
+     */
+    syncToEnvironment(organisation: string, application: string, environment: string, type: 'database' | 'filesystem', syncToEnvironmentRequest: SyncToEnvironmentRequest, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<{
+        response: http.IncomingMessage;
+        body: SyncOperation;
+    }>;
+    /**
+     *
+     * @summary Update the compose for an environment
+     * @param organisation The organisation ID
+     * @param application The application ID
+     * @param environment The environment ID
+     * @param updateEnvironmentRequest
+     */
+    updateEnvironment(organisation: string, application: string, environment: string, updateEnvironmentRequest: UpdateEnvironmentRequest, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<{
+        response: http.IncomingMessage;
+        body?: any;
+    }>;
+    /**
+     *
+     * @summary Update the state of an environment
+     * @param organisation The organisation ID
+     * @param application The application ID
+     * @param environment The environment ID
+     * @param updateEnvironmentStateRequest
+     */
+    updateEnvironmentState(organisation: string, application: string, environment: string, updateEnvironmentStateRequest: UpdateEnvironmentStateRequest, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<{
+        response: http.IncomingMessage;
+        body?: any;
+    }>;
+}