@quantcdn/quant-client 2.0.13 → 3.0.1

package/README.md

@@ -1,88 +1,65 @@
-# QuantCDN client API
+# Quant TypeScript Client
 
-Provides a client to common API interfaces on QuantCDN.
+A TypeScript client for the Quant API.
 
-## Install
+## Installation
 
-The preferred method for installation is via npm.
-
-```
-npm i @quantcdn/quant-client
+```bash
+npm install quant-ts-client
 ```
 
 ## Usage
 
-- Import `types` form '@quantcdn/quant-client' to correctly type parameters
-- All responses are generated using the `PaginatedResponse` object which provides an async iterator
-
-```
-import { QuantClient, types } from '@quantcdn/quant-client'
-
-const config:types.Config = {
-  organization: process.env.QUANT_CUSTOMER,
-  project: process.env.QUANT_PROJECT,
-  token: process.env.QUANT_TOKEN
-}
-
-// If making organization API requests with the client you need to provide bearer
-# config.bearer = process.env.QUANT_BEARER_TOKEN
-
-// Create a new client instance.
-const client = new QuantClient(config)
-
-// Perform requests to the project API.
-const p:types.URLPayload = {"url": "/*"}
-client.project.purge(p).then(async res => {
-   const r = await res.first()
-   console.log(r)
-})
-
-// Ping the API to verify details.
-client.project.ping().then(async res => {
-  const b = await res.first()
-  console.log(b)
-})
-
-// Access project metadata.
-client.project.meta().then(async res => {
-  // res.first() will return the first page of the paginated response.
-  for await (const i of res) {
-    console.log(i)
-  }
-})
+```typescript
+import { EnvironmentsApi, Configuration } from 'quant-ts-client';
+
+// Create a configuration with your API key
+const config = new Configuration({
+  apiKey: 'YOUR_API_KEY',
+  basePath: 'YOUR_BASE_URL' // Optional if using the default base URL
+});
+
+// Initialize an API instance
+const environmentsApi = new EnvironmentsApi(config);
+
+// Example: Get all environments
+environmentsApi.getAllEnvironments()
+  .then(response => {
+    console.log(response.data);
+  })
+  .catch(error => {
+    console.error(error);
+  });
 ```
 
-## Available methods
+## Available APIs
 
-The `QuantClient` class has three properties to access different APIs that are exposed by Quant. These are `project`, `organization`, `search`. Both the project and search clients are project specific.
+The client provides access to the following API endpoints:
 
-### `client.project`
+- `ApplicationsApi`
+- `CommandsApi`
+- `ComposeApi`
+- `ContainersApi`
+- `CronApi`
+- `EnvironmentsApi`
+- `ScalingPolicyApi`
+- `VariablesApi`
+- `VolumesApi`
 
-| Method    | Description                            | Parameters            |
-| --------- | -------------------------------------- | --------------------- |
-| ping      | Ping the API to validate credentials   |                       |
-| meta      | Access the global meta for the project |                       |
-| markup    | Send a HTML file                       | types.MarkupPayload   |
-| file      | Send a non-HTML file                   | types.FilePayload     |
-| publish   | Publish a URL                          | types.PublishPayload  |
-| unpublish | Unpublish a URL                        | types.PublishPayload  |
-| redirect  | Create a redirect                      | types.RedirectPayload |
-| proxy     | Create an origin proxy                 | types.ProxyPayload    |
-| delete    | Delete a resource                      | types.URLPayload      |
-| revisions | Show revisions for a URL               | types.URLPayload      |
-| purge     | Purge cache for the given URL          | types.URLPayload      |
+## Development
 
-### `client.organization`
+### Building the package
 
-| Method  | Description                          | Parameters           |
-| ------- | ------------------------------------ | -------------------- |
-| wafLogs | Access WAF logs for the organization | types.WafLogsPayload |
+```bash
+npm run build
+```
+
+### Publishing the package
+
+```bash
+npm publish
+```
 
-### `client.search`
+## License
 
-| Method | Description                 | Parameters               |
-| ------ | --------------------------- | ------------------------ |
-| index  | Add a new item to the index | types.SearchIndexPayload |
-| remove | Remove a URL form the index | types.URLPayload         |
-| clear  | Clear the projects index    |                          |
-| status | Get the index status        |                          |
+MIT 

package/dist/api/apis.d.ts

@@ -0,0 +1,32 @@
+/// <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';
+import { ComposeApi } from './composeApi';
+export * from './containersApi';
+import { ContainersApi } from './containersApi';
+export * from './cronApi';
+import { CronApi } from './cronApi';
+export * from './environmentsApi';
+import { EnvironmentsApi } from './environmentsApi';
+export * from './sSHAccessApi';
+import { SSHAccessApi } from './sSHAccessApi';
+export * from './scalingPolicyApi';
+import { ScalingPolicyApi } from './scalingPolicyApi';
+export * from './variablesApi';
+import { VariablesApi } from './variablesApi';
+export * from './volumesApi';
+import { VolumesApi } from './volumesApi';
+import * as http from 'http';
+export declare class HttpError extends Error {
+    response: http.IncomingMessage;
+    body: any;
+    statusCode?: number | undefined;
+    constructor(response: http.IncomingMessage, body: any, statusCode?: number | undefined);
+}
+export { RequestFile } from '../model/models';
+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

@@ -0,0 +1,50 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+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);
+const composeApi_1 = require("./composeApi");
+__exportStar(require("./containersApi"), exports);
+const containersApi_1 = require("./containersApi");
+__exportStar(require("./cronApi"), exports);
+const cronApi_1 = require("./cronApi");
+__exportStar(require("./environmentsApi"), exports);
+const environmentsApi_1 = require("./environmentsApi");
+__exportStar(require("./sSHAccessApi"), exports);
+const sSHAccessApi_1 = require("./sSHAccessApi");
+__exportStar(require("./scalingPolicyApi"), exports);
+const scalingPolicyApi_1 = require("./scalingPolicyApi");
+__exportStar(require("./variablesApi"), exports);
+const variablesApi_1 = require("./variablesApi");
+__exportStar(require("./volumesApi"), exports);
+const volumesApi_1 = require("./volumesApi");
+class HttpError extends Error {
+    constructor(response, body, statusCode) {
+        super('HTTP request failed');
+        this.response = response;
+        this.body = body;
+        this.statusCode = statusCode;
+        this.name = 'HttpError';
+    }
+}
+exports.HttpError = HttpError;
+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/applicationsApi.d.ts

@@ -0,0 +1,104 @@
+/**
+ * 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 { Application } from '../model/application';
+import { GetEcrLoginCredentials200Response } from '../model/getEcrLoginCredentials200Response';
+import { Authentication, Interceptor } from '../model/models';
+export declare enum ApplicationsApiApiKeys {
+}
+export declare class ApplicationsApi {
+    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: ApplicationsApiApiKeys, value: string): void;
+    addInterceptor(interceptor: Interceptor): void;
+    /**
+     *
+     * @summary Create a new application
+     * @param organisation The organisation ID
+     * @param application
+     */
+    createApplication(organisation: string, application: Application, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<{
+        response: http.IncomingMessage;
+        body: Application;
+    }>;
+    /**
+     *
+     * @summary Delete an application
+     * @param organisation The organisation ID
+     * @param application The application ID
+     */
+    deleteApplication(organisation: string, application: string, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<{
+        response: http.IncomingMessage;
+        body?: any;
+    }>;
+    /**
+     *
+     * @summary Get a single application
+     * @param organisation The organisation ID
+     * @param application The application ID
+     */
+    getApplication(organisation: string, application: string, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<{
+        response: http.IncomingMessage;
+        body: Application;
+    }>;
+    /**
+     *
+     * @summary Get ECR login credentials
+     * @param organisation The organisation ID
+     */
+    getEcrLoginCredentials(organisation: string, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<{
+        response: http.IncomingMessage;
+        body: GetEcrLoginCredentials200Response;
+    }>;
+    /**
+     *
+     * @summary Get all applications for an organisation
+     * @param organisation The organisation ID
+     */
+    listApplications(organisation: string, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<{
+        response: http.IncomingMessage;
+        body: Array<Application>;
+    }>;
+}