@cirrobio/api-client 0.1.26 → 0.1.28

package/.openapi-generator/FILES

@@ -24,6 +24,9 @@ src/index.ts
 src/models/AWSCredentials.ts
 src/models/AccessType.ts
 src/models/Agent.ts
+src/models/AgentDetail.ts
+src/models/AgentInput.ts
+src/models/AgentRegistration.ts
 src/models/AgentStatus.ts
 src/models/AllowedDataType.ts
 src/models/ApproveProjectAccessRequest.ts
@@ -75,6 +78,7 @@ src/models/NotebookInstanceStatusResponse.ts
 src/models/OpenNotebookInstanceResponse.ts
 src/models/PaginatedResponseDatasetListDto.ts
 src/models/PaginatedResponseSampleDto.ts
+src/models/PaginatedResponseUserDto.ts
 src/models/PipelineCode.ts
 src/models/PipelineCost.ts
 src/models/PortalErrorResponse.ts

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.1.26 --save
+npm install @cirrobio/api-client@0.1.28 --save
 ```
 
 _unPublished (not recommended):_

package/dist/apis/ComputeEnvironmentApi.d.ts

@@ -10,14 +10,54 @@
  * Do not edit the class manually.
  */
 import * as runtime from '../runtime';
-import type { ComputeEnvironmentConfiguration } from '../models/index';
+import type { AgentDetail, AgentInput, ComputeEnvironmentConfiguration, CreateResponse } from '../models/index';
+export interface CreateAgentRequest {
+    agentInput: AgentInput;
+}
+export interface DeleteAgentRequest {
+    agentId: string;
+}
 export interface GetComputeEnvironmentsRequest {
     projectId: string;
 }
+export interface UpdateAgentRequest {
+    agentId: string;
+    agentInput: AgentInput;
+}
 /**
  *
  */
 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>;
+    /**
+     * 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>;
+    /**
+     * 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
@@ -28,4 +68,14 @@ export declare class ComputeEnvironmentApi extends runtime.BaseAPI {
      * 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>;
 }

package/dist/apis/ComputeEnvironmentApi.js

@@ -75,6 +75,168 @@ var ComputeEnvironmentApi = /** @class */ (function (_super) {
     function ComputeEnvironmentApi() {
         return _super !== null && _super.apply(this, arguments) || this;
     }
+    /**
+     * Create a new agent
+     * Create agent
+     */
+    ComputeEnvironmentApi.prototype.createAgentRaw = function (requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function () {
+            var queryParameters, headerParameters, token, tokenString, response;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0:
+                        if (requestParameters.agentInput === null || requestParameters.agentInput === undefined) {
+                            throw new runtime.RequiredError('agentInput', 'Required parameter requestParameters.agentInput was null or undefined when calling createAgent.');
+                        }
+                        queryParameters = {};
+                        headerParameters = {};
+                        headerParameters['Content-Type'] = 'application/json';
+                        if (!(this.configuration && this.configuration.accessToken)) return [3 /*break*/, 2];
+                        token = this.configuration.accessToken;
+                        return [4 /*yield*/, token("accessToken", [])];
+                    case 1:
+                        tokenString = _a.sent();
+                        if (tokenString) {
+                            headerParameters["Authorization"] = "Bearer ".concat(tokenString);
+                        }
+                        _a.label = 2;
+                    case 2: return [4 /*yield*/, this.request({
+                            path: "/agents",
+                            method: 'POST',
+                            headers: headerParameters,
+                            query: queryParameters,
+                            body: (0, index_1.AgentInputToJSON)(requestParameters.agentInput),
+                        }, initOverrides)];
+                    case 3:
+                        response = _a.sent();
+                        return [2 /*return*/, new runtime.JSONApiResponse(response, function (jsonValue) { return (0, index_1.CreateResponseFromJSON)(jsonValue); })];
+                }
+            });
+        });
+    };
+    /**
+     * Create a new agent
+     * Create agent
+     */
+    ComputeEnvironmentApi.prototype.createAgent = 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.createAgentRaw(requestParameters, initOverrides)];
+                    case 1:
+                        response = _a.sent();
+                        return [4 /*yield*/, response.value()];
+                    case 2: return [2 /*return*/, _a.sent()];
+                }
+            });
+        });
+    };
+    /**
+     * Delete an agent
+     * Delete agent
+     */
+    ComputeEnvironmentApi.prototype.deleteAgentRaw = function (requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function () {
+            var queryParameters, headerParameters, token, tokenString, response;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0:
+                        if (requestParameters.agentId === null || requestParameters.agentId === undefined) {
+                            throw new runtime.RequiredError('agentId', 'Required parameter requestParameters.agentId was null or undefined when calling deleteAgent.');
+                        }
+                        queryParameters = {};
+                        headerParameters = {};
+                        if (!(this.configuration && this.configuration.accessToken)) return [3 /*break*/, 2];
+                        token = this.configuration.accessToken;
+                        return [4 /*yield*/, token("accessToken", [])];
+                    case 1:
+                        tokenString = _a.sent();
+                        if (tokenString) {
+                            headerParameters["Authorization"] = "Bearer ".concat(tokenString);
+                        }
+                        _a.label = 2;
+                    case 2: return [4 /*yield*/, this.request({
+                            path: "/agents/{agentId}".replace("{".concat("agentId", "}"), encodeURIComponent(String(requestParameters.agentId))),
+                            method: 'DELETE',
+                            headers: headerParameters,
+                            query: queryParameters,
+                        }, initOverrides)];
+                    case 3:
+                        response = _a.sent();
+                        return [2 /*return*/, new runtime.VoidApiResponse(response)];
+                }
+            });
+        });
+    };
+    /**
+     * Delete an agent
+     * Delete agent
+     */
+    ComputeEnvironmentApi.prototype.deleteAgent = 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.deleteAgentRaw(requestParameters, initOverrides)];
+                    case 1:
+                        _a.sent();
+                        return [2 /*return*/];
+                }
+            });
+        });
+    };
+    /**
+     * Get a list of agents
+     * Get agents
+     */
+    ComputeEnvironmentApi.prototype.getAgentsRaw = function (initOverrides) {
+        return __awaiter(this, void 0, void 0, function () {
+            var queryParameters, headerParameters, token, tokenString, response;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0:
+                        queryParameters = {};
+                        headerParameters = {};
+                        if (!(this.configuration && this.configuration.accessToken)) return [3 /*break*/, 2];
+                        token = this.configuration.accessToken;
+                        return [4 /*yield*/, token("accessToken", [])];
+                    case 1:
+                        tokenString = _a.sent();
+                        if (tokenString) {
+                            headerParameters["Authorization"] = "Bearer ".concat(tokenString);
+                        }
+                        _a.label = 2;
+                    case 2: return [4 /*yield*/, this.request({
+                            path: "/agents",
+                            method: 'GET',
+                            headers: headerParameters,
+                            query: queryParameters,
+                        }, initOverrides)];
+                    case 3:
+                        response = _a.sent();
+                        return [2 /*return*/, new runtime.JSONApiResponse(response, function (jsonValue) { return jsonValue.map(index_1.AgentDetailFromJSON); })];
+                }
+            });
+        });
+    };
+    /**
+     * Get a list of agents
+     * Get agents
+     */
+    ComputeEnvironmentApi.prototype.getAgents = 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.getAgentsRaw(initOverrides)];
+                    case 1:
+                        response = _a.sent();
+                        return [4 /*yield*/, response.value()];
+                    case 2: return [2 /*return*/, _a.sent()];
+                }
+            });
+        });
+    };
     /**
      * Get a list of compute environments for a project
      * Get compute environments
@@ -130,6 +292,64 @@ var ComputeEnvironmentApi = /** @class */ (function (_super) {
             });
         });
     };
+    /**
+     * Update an agent
+     * Update agent
+     */
+    ComputeEnvironmentApi.prototype.updateAgentRaw = function (requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function () {
+            var queryParameters, headerParameters, token, tokenString, response;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0:
+                        if (requestParameters.agentId === null || requestParameters.agentId === undefined) {
+                            throw new runtime.RequiredError('agentId', 'Required parameter requestParameters.agentId was null or undefined when calling updateAgent.');
+                        }
+                        if (requestParameters.agentInput === null || requestParameters.agentInput === undefined) {
+                            throw new runtime.RequiredError('agentInput', 'Required parameter requestParameters.agentInput was null or undefined when calling updateAgent.');
+                        }
+                        queryParameters = {};
+                        headerParameters = {};
+                        headerParameters['Content-Type'] = 'application/json';
+                        if (!(this.configuration && this.configuration.accessToken)) return [3 /*break*/, 2];
+                        token = this.configuration.accessToken;
+                        return [4 /*yield*/, token("accessToken", [])];
+                    case 1:
+                        tokenString = _a.sent();
+                        if (tokenString) {
+                            headerParameters["Authorization"] = "Bearer ".concat(tokenString);
+                        }
+                        _a.label = 2;
+                    case 2: return [4 /*yield*/, this.request({
+                            path: "/agents/{agentId}".replace("{".concat("agentId", "}"), encodeURIComponent(String(requestParameters.agentId))),
+                            method: 'PUT',
+                            headers: headerParameters,
+                            query: queryParameters,
+                            body: (0, index_1.AgentInputToJSON)(requestParameters.agentInput),
+                        }, initOverrides)];
+                    case 3:
+                        response = _a.sent();
+                        return [2 /*return*/, new runtime.VoidApiResponse(response)];
+                }
+            });
+        });
+    };
+    /**
+     * Update an agent
+     * Update agent
+     */
+    ComputeEnvironmentApi.prototype.updateAgent = 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.updateAgentRaw(requestParameters, initOverrides)];
+                    case 1:
+                        _a.sent();
+                        return [2 /*return*/];
+                }
+            });
+        });
+    };
     return ComputeEnvironmentApi;
 }(runtime.BaseAPI));
 exports.ComputeEnvironmentApi = ComputeEnvironmentApi;

package/dist/apis/UsersApi.d.ts

@@ -10,16 +10,18 @@
  * Do not edit the class manually.
  */
 import * as runtime from '../runtime';
-import type { InviteUserRequest, InviteUserResponse, UpdateUserRequest, User, UserDetail } from '../models/index';
+import type { InviteUserRequest, InviteUserResponse, PaginatedResponseUserDto, UpdateUserRequest, User, UserDetail } from '../models/index';
 export interface GetUserRequest {
     username: string;
 }
-export interface GetUsersRequest {
-    username: string;
-}
 export interface InviteUserOperationRequest {
     inviteUserRequest: InviteUserRequest;
 }
+export interface ListUsersRequest {
+    username?: string | null;
+    limit?: number;
+    nextToken?: string;
+}
 export interface SignOutUserRequest {
     username: string;
 }
@@ -41,16 +43,6 @@ export declare class UsersApi extends runtime.BaseAPI {
      * Get user
      */
     getUser(requestParameters: GetUserRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<UserDetail>;
-    /**
-     * Gets a list of users matching the username pattern
-     * List users
-     */
-    getUsersRaw(requestParameters: GetUsersRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<User>>>;
-    /**
-     * Gets a list of users matching the username pattern
-     * List users
-     */
-    getUsers(requestParameters: GetUsersRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<User>>;
     /**
      * Invites a user to the system
      * Invite user
@@ -61,6 +53,16 @@ export declare class UsersApi extends runtime.BaseAPI {
      * Invite user
      */
     inviteUser(requestParameters: InviteUserOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<InviteUserResponse>;
+    /**
+     * Gets a list of users, matching an optional username pattern
+     * List users
+     */
+    listUsersRaw(requestParameters: ListUsersRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PaginatedResponseUserDto>>;
+    /**
+     * Gets a list of users, matching an optional username pattern
+     * List users
+     */
+    listUsers(requestParameters?: ListUsersRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PaginatedResponseUserDto>;
     /**
      * Signs user out from all sessions
      * Sign out user

package/dist/apis/UsersApi.js

@@ -131,23 +131,21 @@ var UsersApi = /** @class */ (function (_super) {
         });
     };
     /**
-     * Gets a list of users matching the username pattern
-     * List users
+     * Invites a user to the system
+     * Invite user
      */
-    UsersApi.prototype.getUsersRaw = function (requestParameters, initOverrides) {
+    UsersApi.prototype.inviteUserRaw = function (requestParameters, initOverrides) {
         return __awaiter(this, void 0, void 0, function () {
             var queryParameters, headerParameters, token, tokenString, response;
             return __generator(this, function (_a) {
                 switch (_a.label) {
                     case 0:
-                        if (requestParameters.username === null || requestParameters.username === undefined) {
-                            throw new runtime.RequiredError('username', 'Required parameter requestParameters.username was null or undefined when calling getUsers.');
+                        if (requestParameters.inviteUserRequest === null || requestParameters.inviteUserRequest === undefined) {
+                            throw new runtime.RequiredError('inviteUserRequest', 'Required parameter requestParameters.inviteUserRequest was null or undefined when calling inviteUser.');
                         }
                         queryParameters = {};
-                        if (requestParameters.username !== undefined) {
-                            queryParameters['username'] = requestParameters.username;
-                        }
                         headerParameters = {};
+                        headerParameters['Content-Type'] = 'application/json';
                         if (!(this.configuration && this.configuration.accessToken)) return [3 /*break*/, 2];
                         token = this.configuration.accessToken;
                         return [4 /*yield*/, token("accessToken", [])];
@@ -159,27 +157,28 @@ var UsersApi = /** @class */ (function (_super) {
                         _a.label = 2;
                     case 2: return [4 /*yield*/, this.request({
                             path: "/users",
-                            method: 'GET',
+                            method: 'POST',
                             headers: headerParameters,
                             query: queryParameters,
+                            body: (0, index_1.InviteUserRequestToJSON)(requestParameters.inviteUserRequest),
                         }, initOverrides)];
                     case 3:
                         response = _a.sent();
-                        return [2 /*return*/, new runtime.JSONApiResponse(response, function (jsonValue) { return jsonValue.map(index_1.UserFromJSON); })];
+                        return [2 /*return*/, new runtime.JSONApiResponse(response, function (jsonValue) { return (0, index_1.InviteUserResponseFromJSON)(jsonValue); })];
                 }
             });
         });
     };
     /**
-     * Gets a list of users matching the username pattern
-     * List users
+     * Invites a user to the system
+     * Invite user
      */
-    UsersApi.prototype.getUsers = function (requestParameters, initOverrides) {
+    UsersApi.prototype.inviteUser = 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.getUsersRaw(requestParameters, initOverrides)];
+                    case 0: return [4 /*yield*/, this.inviteUserRaw(requestParameters, initOverrides)];
                     case 1:
                         response = _a.sent();
                         return [4 /*yield*/, response.value()];
@@ -189,21 +188,26 @@ var UsersApi = /** @class */ (function (_super) {
         });
     };
     /**
-     * Invites a user to the system
-     * Invite user
+     * Gets a list of users, matching an optional username pattern
+     * List users
      */
-    UsersApi.prototype.inviteUserRaw = function (requestParameters, initOverrides) {
+    UsersApi.prototype.listUsersRaw = function (requestParameters, initOverrides) {
         return __awaiter(this, void 0, void 0, function () {
             var queryParameters, headerParameters, token, tokenString, response;
             return __generator(this, function (_a) {
                 switch (_a.label) {
                     case 0:
-                        if (requestParameters.inviteUserRequest === null || requestParameters.inviteUserRequest === undefined) {
-                            throw new runtime.RequiredError('inviteUserRequest', 'Required parameter requestParameters.inviteUserRequest was null or undefined when calling inviteUser.');
-                        }
                         queryParameters = {};
+                        if (requestParameters.username !== undefined) {
+                            queryParameters['username'] = requestParameters.username;
+                        }
+                        if (requestParameters.limit !== undefined) {
+                            queryParameters['limit'] = requestParameters.limit;
+                        }
+                        if (requestParameters.nextToken !== undefined) {
+                            queryParameters['nextToken'] = requestParameters.nextToken;
+                        }
                         headerParameters = {};
-                        headerParameters['Content-Type'] = 'application/json';
                         if (!(this.configuration && this.configuration.accessToken)) return [3 /*break*/, 2];
                         token = this.configuration.accessToken;
                         return [4 /*yield*/, token("accessToken", [])];
@@ -215,28 +219,28 @@ var UsersApi = /** @class */ (function (_super) {
                         _a.label = 2;
                     case 2: return [4 /*yield*/, this.request({
                             path: "/users",
-                            method: 'POST',
+                            method: 'GET',
                             headers: headerParameters,
                             query: queryParameters,
-                            body: (0, index_1.InviteUserRequestToJSON)(requestParameters.inviteUserRequest),
                         }, initOverrides)];
                     case 3:
                         response = _a.sent();
-                        return [2 /*return*/, new runtime.JSONApiResponse(response, function (jsonValue) { return (0, index_1.InviteUserResponseFromJSON)(jsonValue); })];
+                        return [2 /*return*/, new runtime.JSONApiResponse(response, function (jsonValue) { return (0, index_1.PaginatedResponseUserDtoFromJSON)(jsonValue); })];
                 }
             });
         });
     };
     /**
-     * Invites a user to the system
-     * Invite user
+     * Gets a list of users, matching an optional username pattern
+     * List users
      */
-    UsersApi.prototype.inviteUser = function (requestParameters, initOverrides) {
+    UsersApi.prototype.listUsers = function (requestParameters, initOverrides) {
+        if (requestParameters === void 0) { requestParameters = {}; }
         return __awaiter(this, void 0, void 0, function () {
             var response;
             return __generator(this, function (_a) {
                 switch (_a.label) {
-                    case 0: return [4 /*yield*/, this.inviteUserRaw(requestParameters, initOverrides)];
+                    case 0: return [4 /*yield*/, this.listUsersRaw(requestParameters, initOverrides)];
                     case 1:
                         response = _a.sent();
                         return [4 /*yield*/, response.value()];

package/dist/models/AgentDetail.d.ts

@@ -0,0 +1,91 @@
+/**
+ * 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 type { AgentRegistration } from './AgentRegistration';
+import type { AgentStatus } from './AgentStatus';
+/**
+ *
+ * @export
+ * @interface AgentDetail
+ */
+export interface AgentDetail {
+    /**
+     *
+     * @type {string}
+     * @memberof AgentDetail
+     */
+    id: string;
+    /**
+     *
+     * @type {string}
+     * @memberof AgentDetail
+     */
+    name: string;
+    /**
+     *
+     * @type {string}
+     * @memberof AgentDetail
+     */
+    agentRoleArn: string;
+    /**
+     *
+     * @type {AgentStatus}
+     * @memberof AgentDetail
+     */
+    status: AgentStatus;
+    /**
+     *
+     * @type {AgentRegistration}
+     * @memberof AgentDetail
+     */
+    registration?: AgentRegistration | null;
+    /**
+     *
+     * @type {{ [key: string]: string; }}
+     * @memberof AgentDetail
+     */
+    tags?: {
+        [key: string]: string;
+    } | null;
+    /**
+     *
+     * @type {{ [key: string]: string; }}
+     * @memberof AgentDetail
+     */
+    environmentConfiguration?: {
+        [key: string]: string;
+    } | null;
+    /**
+     *
+     * @type {string}
+     * @memberof AgentDetail
+     */
+    createdBy: string;
+    /**
+     *
+     * @type {Date}
+     * @memberof AgentDetail
+     */
+    createdAt: Date;
+    /**
+     *
+     * @type {Date}
+     * @memberof AgentDetail
+     */
+    updatedAt: Date;
+}
+/**
+ * Check if a given object implements the AgentDetail interface.
+ */
+export declare function instanceOfAgentDetail(value: object): boolean;
+export declare function AgentDetailFromJSON(json: any): AgentDetail;
+export declare function AgentDetailFromJSONTyped(json: any, ignoreDiscriminator: boolean): AgentDetail;
+export declare function AgentDetailToJSON(value?: AgentDetail | null): any;