@cirrobio/api-client 0.0.1

package/.openapi-generator/FILES

@@ -0,0 +1,54 @@
+.gitignore
+.npmignore
+README.md
+package.json
+src/apis/BillingApi.ts
+src/apis/DatasetsApi.ts
+src/apis/ExecutionApi.ts
+src/apis/MetricsApi.ts
+src/apis/NotebooksApi.ts
+src/apis/ProcessesApi.ts
+src/apis/ProjectsApi.ts
+src/apis/SystemApi.ts
+src/apis/UsersApi.ts
+src/apis/index.ts
+src/index.ts
+src/models/BillingAccount.ts
+src/models/BillingMethod.ts
+src/models/BudgetPeriod.ts
+src/models/CloudAccount.ts
+src/models/Contact.ts
+src/models/CreateNotebookInstanceRequest.ts
+src/models/CreateResponse.ts
+src/models/CustomerType.ts
+src/models/Dataset.ts
+src/models/DatasetDetail.ts
+src/models/DatasetType.ts
+src/models/Executor.ts
+src/models/FormSchema.ts
+src/models/GetExecutionLogsResponse.ts
+src/models/LogEntry.ts
+src/models/NotebookInstance.ts
+src/models/OpenNotebookInstanceResponse.ts
+src/models/Process.ts
+src/models/Project.ts
+src/models/ProjectDetail.ts
+src/models/ProjectMetrics.ts
+src/models/ProjectRequest.ts
+src/models/ProjectRole.ts
+src/models/ProjectSettings.ts
+src/models/ReferenceType.ts
+src/models/Region.ts
+src/models/RegisterDatasetRequest.ts
+src/models/ServiceConnection.ts
+src/models/SetUserProjectRoleRequest.ts
+src/models/StopExecutionResponse.ts
+src/models/SystemInfoResponse.ts
+src/models/Tag.ts
+src/models/Task.ts
+src/models/UpdateDatasetRequest.ts
+src/models/UpdateUserRequest.ts
+src/models/User.ts
+src/models/index.ts
+src/runtime.ts
+tsconfig.json

package/.openapi-generator/VERSION

@@ -0,0 +1 @@
+7.0.1

package/.openapi-generator-ignore

@@ -0,0 +1,23 @@
+# OpenAPI Generator Ignore
+# Generated by openapi-generator https://github.com/openapitools/openapi-generator
+
+# Use this file to prevent files from being overwritten by the generator.
+# The patterns follow closely to .gitignore or .dockerignore.
+
+# As an example, the C# client generator defines ApiClient.cs.
+# You can make changes and tell OpenAPI Generator to ignore just this file by uncommenting the following line:
+#ApiClient.cs
+
+# You can match any string of characters against a directory, file or extension with a single asterisk (*):
+#foo/*/qux
+# The above matches foo/bar/qux and foo/baz/qux, but not foo/bar/baz/qux
+
+# You can recursively match patterns against a directory, file or extension with a double asterisk (**):
+#foo/**/qux
+# This matches foo/bar/qux, foo/baz/qux, and foo/bar/baz/qux
+
+# You can also negate patterns with an exclamation (!).
+# For example, you can ignore all files in a docs folder with the file extension .md:
+#docs/*.md
+# Then explicitly reverse the ignore rule for a single file:
+#!docs/README.md

package/README.md

@@ -0,0 +1,45 @@
+## Cirro API Client (TypeScript)
+
+This is an API client for Cirro.
+
+Environment
+* Node.js
+* Webpack
+* Browserify
+
+Language level
+* ES5 - you must have a Promises/A+ library installed
+* ES6
+
+Module system
+* CommonJS
+* ES6 module system
+
+It can be used in both TypeScript and JavaScript. In TypeScript, the definition should be automatically resolved via `package.json`. ([Reference](http://www.typescriptlang.org/docs/handbook/typings-for-npm-packages.html))
+
+### Building
+
+To build and compile the typescript sources to javascript use:
+```
+npm install
+npm run build
+```
+
+### Publishing
+
+First build the package then run ```npm publish```
+
+### Consuming
+
+navigate to the folder of your consuming project and run one of the following commands.
+
+_published:_
+
+```
+npm install @cirrobio/api-client@0.0.1 --save
+```
+
+_unPublished (not recommended):_
+
+```
+npm install PATH_TO_GENERATED_PACKAGE --save

package/dist/apis/BillingApi.d.ts

@@ -0,0 +1,68 @@
+/**
+ * Cirro Data
+ * Cirro Data Platform service API
+ *
+ * The version of the OpenAPI document: latest
+ * Contact: support@cirro.bio
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import * as runtime from '../runtime';
+import type { BillingAccount, CreateResponse } from '../models/index';
+export interface CreateBillingAccountRequest {
+    billingAccount: BillingAccount;
+}
+export interface DeleteBillingAccountRequest {
+    billingAccountId: string;
+}
+export interface UpdateBillingAccountRequest {
+    billingAccountId: string;
+    billingAccount: BillingAccount;
+}
+/**
+ *
+ */
+export declare class BillingApi extends runtime.BaseAPI {
+    /**
+     * Creates a billing account
+     * Create billing account
+     */
+    createBillingAccountRaw(requestParameters: CreateBillingAccountRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CreateResponse>>;
+    /**
+     * Creates a billing account
+     * Create billing account
+     */
+    createBillingAccount(requestParameters: CreateBillingAccountRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CreateResponse>;
+    /**
+     * Deletes a billing account
+     * Delete billing account
+     */
+    deleteBillingAccountRaw(requestParameters: DeleteBillingAccountRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * Deletes a billing account
+     * Delete billing account
+     */
+    deleteBillingAccount(requestParameters: DeleteBillingAccountRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     * Gets a list of billing accounts the current user has access to
+     * List billing accounts
+     */
+    getBillingAccountsRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<BillingAccount>>>;
+    /**
+     * Gets a list of billing accounts the current user has access to
+     * List billing accounts
+     */
+    getBillingAccounts(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<BillingAccount>>;
+    /**
+     * Updates a billing account
+     * Update billing account
+     */
+    updateBillingAccountRaw(requestParameters: UpdateBillingAccountRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * Updates a billing account
+     * Update billing account
+     */
+    updateBillingAccount(requestParameters: UpdateBillingAccountRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+}

package/dist/apis/BillingApi.js

@@ -0,0 +1,264 @@
+"use strict";
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Cirro Data
+ * Cirro Data Platform service API
+ *
+ * The version of the OpenAPI document: latest
+ * Contact: support@cirro.bio
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+var __extends = (this && this.__extends) || (function () {
+    var extendStatics = function (d, b) {
+        extendStatics = Object.setPrototypeOf ||
+            ({ __proto__: [] } instanceof Array && function (d, b) { d.__proto__ = b; }) ||
+            function (d, b) { for (var p in b) if (Object.prototype.hasOwnProperty.call(b, p)) d[p] = b[p]; };
+        return extendStatics(d, b);
+    };
+    return function (d, b) {
+        if (typeof b !== "function" && b !== null)
+            throw new TypeError("Class extends value " + String(b) + " is not a constructor or null");
+        extendStatics(d, b);
+        function __() { this.constructor = d; }
+        d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __());
+    };
+})();
+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 __generator = (this && this.__generator) || function (thisArg, body) {
+    var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;
+    return g = { next: verb(0), "throw": verb(1), "return": verb(2) }, typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
+    function verb(n) { return function (v) { return step([n, v]); }; }
+    function step(op) {
+        if (f) throw new TypeError("Generator is already executing.");
+        while (g && (g = 0, op[0] && (_ = 0)), _) try {
+            if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
+            if (y = 0, t) op = [op[0] & 2, t.value];
+            switch (op[0]) {
+                case 0: case 1: t = op; break;
+                case 4: _.label++; return { value: op[1], done: false };
+                case 5: _.label++; y = op[1]; op = [0]; continue;
+                case 7: op = _.ops.pop(); _.trys.pop(); continue;
+                default:
+                    if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
+                    if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
+                    if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
+                    if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
+                    if (t[2]) _.ops.pop();
+                    _.trys.pop(); continue;
+            }
+            op = body.call(thisArg, _);
+        } catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
+        if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
+    }
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BillingApi = void 0;
+var runtime = require("../runtime");
+var index_1 = require("../models/index");
+/**
+ *
+ */
+var BillingApi = /** @class */ (function (_super) {
+    __extends(BillingApi, _super);
+    function BillingApi() {
+        return _super !== null && _super.apply(this, arguments) || this;
+    }
+    /**
+     * Creates a billing account
+     * Create billing account
+     */
+    BillingApi.prototype.createBillingAccountRaw = function (requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function () {
+            var queryParameters, headerParameters, response;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0:
+                        if (requestParameters.billingAccount === null || requestParameters.billingAccount === undefined) {
+                            throw new runtime.RequiredError('billingAccount', 'Required parameter requestParameters.billingAccount was null or undefined when calling createBillingAccount.');
+                        }
+                        queryParameters = {};
+                        headerParameters = {};
+                        headerParameters['Content-Type'] = 'application/json';
+                        return [4 /*yield*/, this.request({
+                                path: "/billing",
+                                method: 'POST',
+                                headers: headerParameters,
+                                query: queryParameters,
+                                body: (0, index_1.BillingAccountToJSON)(requestParameters.billingAccount),
+                            }, initOverrides)];
+                    case 1:
+                        response = _a.sent();
+                        return [2 /*return*/, new runtime.JSONApiResponse(response, function (jsonValue) { return (0, index_1.CreateResponseFromJSON)(jsonValue); })];
+                }
+            });
+        });
+    };
+    /**
+     * Creates a billing account
+     * Create billing account
+     */
+    BillingApi.prototype.createBillingAccount = function (requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function () {
+            var response;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0: return [4 /*yield*/, this.createBillingAccountRaw(requestParameters, initOverrides)];
+                    case 1:
+                        response = _a.sent();
+                        return [4 /*yield*/, response.value()];
+                    case 2: return [2 /*return*/, _a.sent()];
+                }
+            });
+        });
+    };
+    /**
+     * Deletes a billing account
+     * Delete billing account
+     */
+    BillingApi.prototype.deleteBillingAccountRaw = function (requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function () {
+            var queryParameters, headerParameters, response;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0:
+                        if (requestParameters.billingAccountId === null || requestParameters.billingAccountId === undefined) {
+                            throw new runtime.RequiredError('billingAccountId', 'Required parameter requestParameters.billingAccountId was null or undefined when calling deleteBillingAccount.');
+                        }
+                        queryParameters = {};
+                        headerParameters = {};
+                        return [4 /*yield*/, this.request({
+                                path: "/billing/{billingAccountId}".replace("{".concat("billingAccountId", "}"), encodeURIComponent(String(requestParameters.billingAccountId))),
+                                method: 'DELETE',
+                                headers: headerParameters,
+                                query: queryParameters,
+                            }, initOverrides)];
+                    case 1:
+                        response = _a.sent();
+                        return [2 /*return*/, new runtime.VoidApiResponse(response)];
+                }
+            });
+        });
+    };
+    /**
+     * Deletes a billing account
+     * Delete billing account
+     */
+    BillingApi.prototype.deleteBillingAccount = function (requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function () {
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0: return [4 /*yield*/, this.deleteBillingAccountRaw(requestParameters, initOverrides)];
+                    case 1:
+                        _a.sent();
+                        return [2 /*return*/];
+                }
+            });
+        });
+    };
+    /**
+     * Gets a list of billing accounts the current user has access to
+     * List billing accounts
+     */
+    BillingApi.prototype.getBillingAccountsRaw = function (initOverrides) {
+        return __awaiter(this, void 0, void 0, function () {
+            var queryParameters, headerParameters, response;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0:
+                        queryParameters = {};
+                        headerParameters = {};
+                        return [4 /*yield*/, this.request({
+                                path: "/billing",
+                                method: 'GET',
+                                headers: headerParameters,
+                                query: queryParameters,
+                            }, initOverrides)];
+                    case 1:
+                        response = _a.sent();
+                        return [2 /*return*/, new runtime.JSONApiResponse(response, function (jsonValue) { return jsonValue.map(index_1.BillingAccountFromJSON); })];
+                }
+            });
+        });
+    };
+    /**
+     * Gets a list of billing accounts the current user has access to
+     * List billing accounts
+     */
+    BillingApi.prototype.getBillingAccounts = function (initOverrides) {
+        return __awaiter(this, void 0, void 0, function () {
+            var response;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0: return [4 /*yield*/, this.getBillingAccountsRaw(initOverrides)];
+                    case 1:
+                        response = _a.sent();
+                        return [4 /*yield*/, response.value()];
+                    case 2: return [2 /*return*/, _a.sent()];
+                }
+            });
+        });
+    };
+    /**
+     * Updates a billing account
+     * Update billing account
+     */
+    BillingApi.prototype.updateBillingAccountRaw = function (requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function () {
+            var queryParameters, headerParameters, response;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0:
+                        if (requestParameters.billingAccountId === null || requestParameters.billingAccountId === undefined) {
+                            throw new runtime.RequiredError('billingAccountId', 'Required parameter requestParameters.billingAccountId was null or undefined when calling updateBillingAccount.');
+                        }
+                        if (requestParameters.billingAccount === null || requestParameters.billingAccount === undefined) {
+                            throw new runtime.RequiredError('billingAccount', 'Required parameter requestParameters.billingAccount was null or undefined when calling updateBillingAccount.');
+                        }
+                        queryParameters = {};
+                        headerParameters = {};
+                        headerParameters['Content-Type'] = 'application/json';
+                        return [4 /*yield*/, this.request({
+                                path: "/billing/{billingAccountId}".replace("{".concat("billingAccountId", "}"), encodeURIComponent(String(requestParameters.billingAccountId))),
+                                method: 'PUT',
+                                headers: headerParameters,
+                                query: queryParameters,
+                                body: (0, index_1.BillingAccountToJSON)(requestParameters.billingAccount),
+                            }, initOverrides)];
+                    case 1:
+                        response = _a.sent();
+                        return [2 /*return*/, new runtime.VoidApiResponse(response)];
+                }
+            });
+        });
+    };
+    /**
+     * Updates a billing account
+     * Update billing account
+     */
+    BillingApi.prototype.updateBillingAccount = function (requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function () {
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0: return [4 /*yield*/, this.updateBillingAccountRaw(requestParameters, initOverrides)];
+                    case 1:
+                        _a.sent();
+                        return [2 /*return*/];
+                }
+            });
+        });
+    };
+    return BillingApi;
+}(runtime.BaseAPI));
+exports.BillingApi = BillingApi;

package/dist/apis/DatasetsApi.d.ts

@@ -0,0 +1,88 @@
+/**
+ * Cirro Data
+ * Cirro Data Platform service API
+ *
+ * The version of the OpenAPI document: latest
+ * Contact: support@cirro.bio
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import * as runtime from '../runtime';
+import type { CreateResponse, Dataset, DatasetDetail, RegisterDatasetRequest, UpdateDatasetRequest } from '../models/index';
+export interface DeleteDatasetRequest {
+    projectId: string;
+    datasetId: string;
+}
+export interface GetDatasetRequest {
+    datasetId: string;
+    projectId: string;
+}
+export interface GetDatasetsRequest {
+    projectId: string;
+}
+export interface RegisterDatasetOperationRequest {
+    projectId: string;
+    registerDatasetRequest: RegisterDatasetRequest;
+}
+export interface UpdateDatasetOperationRequest {
+    projectId: string;
+    datasetId: string;
+    updateDatasetRequest: UpdateDatasetRequest;
+}
+/**
+ *
+ */
+export declare class DatasetsApi extends runtime.BaseAPI {
+    /**
+     * Deletes the dataset, files are saved according to the project\'s retention time.
+     * Delete a dataset
+     */
+    deleteDatasetRaw(requestParameters: DeleteDatasetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<string>>;
+    /**
+     * Deletes the dataset, files are saved according to the project\'s retention time.
+     * Delete a dataset
+     */
+    deleteDataset(requestParameters: DeleteDatasetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<string>;
+    /**
+     * Gets detailed information about a dataset
+     * Get dataset
+     */
+    getDatasetRaw(requestParameters: GetDatasetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<DatasetDetail>>;
+    /**
+     * Gets detailed information about a dataset
+     * Get dataset
+     */
+    getDataset(requestParameters: GetDatasetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<DatasetDetail>;
+    /**
+     * Retrieves a list of datasets for a given project
+     * List datasets
+     */
+    getDatasetsRaw(requestParameters: GetDatasetsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<Dataset>>>;
+    /**
+     * Retrieves a list of datasets for a given project
+     * List datasets
+     */
+    getDatasets(requestParameters: GetDatasetsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<Dataset>>;
+    /**
+     * Registers a dataset in the system
+     * Register dataset
+     */
+    registerDatasetRaw(requestParameters: RegisterDatasetOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CreateResponse>>;
+    /**
+     * Registers a dataset in the system
+     * Register dataset
+     */
+    registerDataset(requestParameters: RegisterDatasetOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CreateResponse>;
+    /**
+     * Update info on a dataset
+     * Update dataset
+     */
+    updateDatasetRaw(requestParameters: UpdateDatasetOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<DatasetDetail>>;
+    /**
+     * Update info on a dataset
+     * Update dataset
+     */
+    updateDataset(requestParameters: UpdateDatasetOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<DatasetDetail>;
+}