@cirrobio/api-client 0.9.0 → 0.9.2

package/README.md

@@ -36,7 +36,7 @@ navigate to the folder of your consuming project and run one of the following co
 _published:_
 
 ```
-npm install @cirrobio/api-client@0.4.4 --save
+npm install @cirrobio/api-client@0.9.2 --save
 ```
 
 _unPublished (not recommended):_

package/dist/apis/AuditApi.d.ts

@@ -0,0 +1,60 @@
+/**
+ * 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 { AuditEvent } from '../models/index';
+export interface GetEventRequest {
+    auditEventId: string;
+}
+export interface ListEventsRequest {
+    username?: string;
+    entityType?: ListEventsEntityTypeEnum;
+    entityId?: string;
+}
+/**
+ *
+ */
+export declare class AuditApi extends runtime.BaseAPI {
+    /**
+     * Get audit event detailed information
+     * Get audit event
+     */
+    getEventRaw(requestParameters: GetEventRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AuditEvent>>;
+    /**
+     * Get audit event detailed information
+     * Get audit event
+     */
+    getEvent(requestParameters: GetEventRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AuditEvent>;
+    /**
+     * Gets a list of audit events
+     * List audit events
+     */
+    listEventsRaw(requestParameters: ListEventsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<AuditEvent>>>;
+    /**
+     * Gets a list of audit events
+     * List audit events
+     */
+    listEvents(requestParameters?: ListEventsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<AuditEvent>>;
+}
+/**
+  * @export
+  * @enum {string}
+  */
+export declare enum ListEventsEntityTypeEnum {
+    Project = "Project",
+    Sample = "Sample",
+    Dataset = "Dataset",
+    User = "User",
+    BillingAccount = "BillingAccount",
+    Process = "Process",
+    NotebookInstance = "NotebookInstance",
+    UserProjectAssignment = "UserProjectAssignment"
+}

package/dist/apis/AuditApi.js

@@ -0,0 +1,114 @@
+"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 __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());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ListEventsEntityTypeEnum = exports.AuditApi = void 0;
+const runtime = require("../runtime");
+const index_1 = require("../models/index");
+/**
+ *
+ */
+class AuditApi extends runtime.BaseAPI {
+    /**
+     * Get audit event detailed information
+     * Get audit event
+     */
+    getEventRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (requestParameters.auditEventId === null || requestParameters.auditEventId === undefined) {
+                throw new runtime.RequiredError('auditEventId', 'Required parameter requestParameters.auditEventId was null or undefined when calling getEvent.');
+            }
+            const queryParameters = {};
+            const headerParameters = {};
+            const response = yield this.request({
+                path: `/audit-events/{auditEventId}`.replace(`{${"auditEventId"}}`, encodeURIComponent(String(requestParameters.auditEventId))),
+                method: 'GET',
+                headers: headerParameters,
+                query: queryParameters,
+            }, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.AuditEventFromJSON)(jsonValue));
+        });
+    }
+    /**
+     * Get audit event detailed information
+     * Get audit event
+     */
+    getEvent(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.getEventRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+    /**
+     * Gets a list of audit events
+     * List audit events
+     */
+    listEventsRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const queryParameters = {};
+            if (requestParameters.username !== undefined) {
+                queryParameters['username'] = requestParameters.username;
+            }
+            if (requestParameters.entityType !== undefined) {
+                queryParameters['entityType'] = requestParameters.entityType;
+            }
+            if (requestParameters.entityId !== undefined) {
+                queryParameters['entityId'] = requestParameters.entityId;
+            }
+            const headerParameters = {};
+            const response = yield this.request({
+                path: `/audit-events`,
+                method: 'GET',
+                headers: headerParameters,
+                query: queryParameters,
+            }, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => jsonValue.map(index_1.AuditEventFromJSON));
+        });
+    }
+    /**
+     * Gets a list of audit events
+     * List audit events
+     */
+    listEvents(requestParameters = {}, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.listEventsRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+}
+exports.AuditApi = AuditApi;
+/**
+  * @export
+  * @enum {string}
+  */
+var ListEventsEntityTypeEnum;
+(function (ListEventsEntityTypeEnum) {
+    ListEventsEntityTypeEnum["Project"] = "Project";
+    ListEventsEntityTypeEnum["Sample"] = "Sample";
+    ListEventsEntityTypeEnum["Dataset"] = "Dataset";
+    ListEventsEntityTypeEnum["User"] = "User";
+    ListEventsEntityTypeEnum["BillingAccount"] = "BillingAccount";
+    ListEventsEntityTypeEnum["Process"] = "Process";
+    ListEventsEntityTypeEnum["NotebookInstance"] = "NotebookInstance";
+    ListEventsEntityTypeEnum["UserProjectAssignment"] = "UserProjectAssignment";
+})(ListEventsEntityTypeEnum = exports.ListEventsEntityTypeEnum || (exports.ListEventsEntityTypeEnum = {}));

package/dist/apis/BillingApi.d.ts

@@ -0,0 +1,71 @@
+/**
+ * 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, BillingAccountRequest, CreateResponse } from '../models/index';
+export interface CreateBillingAccountRequest {
+    billingAccountRequest: BillingAccountRequest;
+}
+export interface DeleteBillingAccountRequest {
+    billingAccountId: string;
+}
+export interface GetBillingAccountsRequest {
+    includeArchived?: boolean;
+}
+export interface UpdateBillingAccountRequest {
+    billingAccountId: string;
+    billingAccountRequest: BillingAccountRequest;
+}
+/**
+ *
+ */
+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(requestParameters: GetBillingAccountsRequest, 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(requestParameters?: GetBillingAccountsRequest, 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,186 @@
+"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 __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());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BillingApi = void 0;
+const runtime = require("../runtime");
+const index_1 = require("../models/index");
+/**
+ *
+ */
+class BillingApi extends runtime.BaseAPI {
+    /**
+     * Creates a billing account
+     * Create billing account
+     */
+    createBillingAccountRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (requestParameters.billingAccountRequest === null || requestParameters.billingAccountRequest === undefined) {
+                throw new runtime.RequiredError('billingAccountRequest', 'Required parameter requestParameters.billingAccountRequest was null or undefined when calling createBillingAccount.');
+            }
+            const queryParameters = {};
+            const headerParameters = {};
+            headerParameters['Content-Type'] = 'application/json';
+            if (this.configuration && this.configuration.accessToken) {
+                const token = this.configuration.accessToken;
+                const tokenString = yield token("accessToken", []);
+                if (tokenString) {
+                    headerParameters["Authorization"] = `Bearer ${tokenString}`;
+                }
+            }
+            const response = yield this.request({
+                path: `/billing`,
+                method: 'POST',
+                headers: headerParameters,
+                query: queryParameters,
+                body: (0, index_1.BillingAccountRequestToJSON)(requestParameters.billingAccountRequest),
+            }, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.CreateResponseFromJSON)(jsonValue));
+        });
+    }
+    /**
+     * Creates a billing account
+     * Create billing account
+     */
+    createBillingAccount(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.createBillingAccountRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+    /**
+     * Deletes a billing account
+     * Delete billing account
+     */
+    deleteBillingAccountRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (requestParameters.billingAccountId === null || requestParameters.billingAccountId === undefined) {
+                throw new runtime.RequiredError('billingAccountId', 'Required parameter requestParameters.billingAccountId was null or undefined when calling deleteBillingAccount.');
+            }
+            const queryParameters = {};
+            const headerParameters = {};
+            if (this.configuration && this.configuration.accessToken) {
+                const token = this.configuration.accessToken;
+                const tokenString = yield token("accessToken", []);
+                if (tokenString) {
+                    headerParameters["Authorization"] = `Bearer ${tokenString}`;
+                }
+            }
+            const response = yield this.request({
+                path: `/billing/{billingAccountId}`.replace(`{${"billingAccountId"}}`, encodeURIComponent(String(requestParameters.billingAccountId))),
+                method: 'DELETE',
+                headers: headerParameters,
+                query: queryParameters,
+            }, initOverrides);
+            return new runtime.VoidApiResponse(response);
+        });
+    }
+    /**
+     * Deletes a billing account
+     * Delete billing account
+     */
+    deleteBillingAccount(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            yield this.deleteBillingAccountRaw(requestParameters, initOverrides);
+        });
+    }
+    /**
+     * Gets a list of billing accounts the current user has access to
+     * List billing accounts
+     */
+    getBillingAccountsRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const queryParameters = {};
+            if (requestParameters.includeArchived !== undefined) {
+                queryParameters['includeArchived'] = requestParameters.includeArchived;
+            }
+            const headerParameters = {};
+            if (this.configuration && this.configuration.accessToken) {
+                const token = this.configuration.accessToken;
+                const tokenString = yield token("accessToken", []);
+                if (tokenString) {
+                    headerParameters["Authorization"] = `Bearer ${tokenString}`;
+                }
+            }
+            const response = yield this.request({
+                path: `/billing`,
+                method: 'GET',
+                headers: headerParameters,
+                query: queryParameters,
+            }, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => jsonValue.map(index_1.BillingAccountFromJSON));
+        });
+    }
+    /**
+     * Gets a list of billing accounts the current user has access to
+     * List billing accounts
+     */
+    getBillingAccounts(requestParameters = {}, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.getBillingAccountsRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+    /**
+     * Updates a billing account
+     * Update billing account
+     */
+    updateBillingAccountRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            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.billingAccountRequest === null || requestParameters.billingAccountRequest === undefined) {
+                throw new runtime.RequiredError('billingAccountRequest', 'Required parameter requestParameters.billingAccountRequest was null or undefined when calling updateBillingAccount.');
+            }
+            const queryParameters = {};
+            const headerParameters = {};
+            headerParameters['Content-Type'] = 'application/json';
+            if (this.configuration && this.configuration.accessToken) {
+                const token = this.configuration.accessToken;
+                const tokenString = yield token("accessToken", []);
+                if (tokenString) {
+                    headerParameters["Authorization"] = `Bearer ${tokenString}`;
+                }
+            }
+            const response = yield this.request({
+                path: `/billing/{billingAccountId}`.replace(`{${"billingAccountId"}}`, encodeURIComponent(String(requestParameters.billingAccountId))),
+                method: 'PUT',
+                headers: headerParameters,
+                query: queryParameters,
+                body: (0, index_1.BillingAccountRequestToJSON)(requestParameters.billingAccountRequest),
+            }, initOverrides);
+            return new runtime.VoidApiResponse(response);
+        });
+    }
+    /**
+     * Updates a billing account
+     * Update billing account
+     */
+    updateBillingAccount(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            yield this.updateBillingAccountRaw(requestParameters, initOverrides);
+        });
+    }
+}
+exports.BillingApi = BillingApi;

package/dist/apis/ComputeEnvironmentApi.d.ts

@@ -0,0 +1,124 @@
+/**
+ * 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 { AgentDetail, AgentInput, ComputeEnvironmentConfiguration, ComputeEnvironmentConfigurationInput, CreateResponse } from '../models/index';
+export interface CreateAgentRequest {
+    agentInput: AgentInput;
+}
+export interface CreateComputeEnvironmentRequest {
+    projectId: string;
+    computeEnvironmentConfigurationInput: ComputeEnvironmentConfigurationInput;
+}
+export interface DeleteAgentRequest {
+    agentId: string;
+}
+export interface DeleteComputeEnvironmentRequest {
+    projectId: string;
+    computeEnvironmentId: string;
+}
+export interface GetComputeEnvironmentsRequest {
+    projectId: string;
+}
+export interface UpdateAgentRequest {
+    agentId: string;
+    agentInput: AgentInput;
+}
+export interface UpdateComputeEnvironmentRequest {
+    projectId: string;
+    computeEnvironmentId: string;
+    computeEnvironmentConfigurationInput: ComputeEnvironmentConfigurationInput;
+}
+/**
+ *
+ */
+export declare class ComputeEnvironmentApi extends runtime.BaseAPI {
+    /**
+     * Create a new agent
+     * Create agent
+     */
+    createAgentRaw(requestParameters: CreateAgentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CreateResponse>>;
+    /**
+     * Create a new agent
+     * Create agent
+     */
+    createAgent(requestParameters: CreateAgentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CreateResponse>;
+    /**
+     * Create a new compute environment for a project
+     * Create compute environment
+     */
+    createComputeEnvironmentRaw(requestParameters: CreateComputeEnvironmentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CreateResponse>>;
+    /**
+     * Create a new compute environment for a project
+     * Create compute environment
+     */
+    createComputeEnvironment(requestParameters: CreateComputeEnvironmentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CreateResponse>;
+    /**
+     * Delete an agent
+     * Delete agent
+     */
+    deleteAgentRaw(requestParameters: DeleteAgentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * Delete an agent
+     * Delete agent
+     */
+    deleteAgent(requestParameters: DeleteAgentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     * Delete a compute environment for a project
+     * Delete compute environment
+     */
+    deleteComputeEnvironmentRaw(requestParameters: DeleteComputeEnvironmentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * Delete a compute environment for a project
+     * Delete compute environment
+     */
+    deleteComputeEnvironment(requestParameters: DeleteComputeEnvironmentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     * Get a list of agents
+     * Get agents
+     */
+    getAgentsRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<AgentDetail>>>;
+    /**
+     * Get a list of agents
+     * Get agents
+     */
+    getAgents(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<AgentDetail>>;
+    /**
+     * Get a list of compute environments for a project
+     * Get compute environments
+     */
+    getComputeEnvironmentsRaw(requestParameters: GetComputeEnvironmentsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<ComputeEnvironmentConfiguration>>>;
+    /**
+     * Get a list of compute environments for a project
+     * Get compute environments
+     */
+    getComputeEnvironments(requestParameters: GetComputeEnvironmentsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<ComputeEnvironmentConfiguration>>;
+    /**
+     * Update an agent
+     * Update agent
+     */
+    updateAgentRaw(requestParameters: UpdateAgentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * Update an agent
+     * Update agent
+     */
+    updateAgent(requestParameters: UpdateAgentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     * Update a compute environment for a project
+     * Update compute environment
+     */
+    updateComputeEnvironmentRaw(requestParameters: UpdateComputeEnvironmentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * Update a compute environment for a project
+     * Update compute environment
+     */
+    updateComputeEnvironment(requestParameters: UpdateComputeEnvironmentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+}