@cirrobio/api-client 0.1.27 → 0.1.28

package/dist/models/AgentRegistration.js

@@ -0,0 +1,62 @@
+"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.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AgentRegistrationToJSON = exports.AgentRegistrationFromJSONTyped = exports.AgentRegistrationFromJSON = exports.instanceOfAgentRegistration = void 0;
+/**
+ * Check if a given object implements the AgentRegistration interface.
+ */
+function instanceOfAgentRegistration(value) {
+    var isInstance = true;
+    isInstance = isInstance && "localIp" in value;
+    isInstance = isInstance && "remoteIp" in value;
+    isInstance = isInstance && "agentVersion" in value;
+    isInstance = isInstance && "hostname" in value;
+    isInstance = isInstance && "os" in value;
+    return isInstance;
+}
+exports.instanceOfAgentRegistration = instanceOfAgentRegistration;
+function AgentRegistrationFromJSON(json) {
+    return AgentRegistrationFromJSONTyped(json, false);
+}
+exports.AgentRegistrationFromJSON = AgentRegistrationFromJSON;
+function AgentRegistrationFromJSONTyped(json, ignoreDiscriminator) {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        'localIp': json['localIp'],
+        'remoteIp': json['remoteIp'],
+        'agentVersion': json['agentVersion'],
+        'hostname': json['hostname'],
+        'os': json['os'],
+    };
+}
+exports.AgentRegistrationFromJSONTyped = AgentRegistrationFromJSONTyped;
+function AgentRegistrationToJSON(value) {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        'localIp': value.localIp,
+        'remoteIp': value.remoteIp,
+        'agentVersion': value.agentVersion,
+        'hostname': value.hostname,
+        'os': value.os,
+    };
+}
+exports.AgentRegistrationToJSON = AgentRegistrationToJSON;

package/dist/models/index.d.ts

@@ -1,6 +1,9 @@
 export * from './AWSCredentials';
 export * from './AccessType';
 export * from './Agent';
+export * from './AgentDetail';
+export * from './AgentInput';
+export * from './AgentRegistration';
 export * from './AgentStatus';
 export * from './AllowedDataType';
 export * from './ApproveProjectAccessRequest';

package/dist/models/index.js

@@ -19,6 +19,9 @@ Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./AWSCredentials"), exports);
 __exportStar(require("./AccessType"), exports);
 __exportStar(require("./Agent"), exports);
+__exportStar(require("./AgentDetail"), exports);
+__exportStar(require("./AgentInput"), exports);
+__exportStar(require("./AgentRegistration"), exports);
 __exportStar(require("./AgentStatus"), exports);
 __exportStar(require("./AllowedDataType"), exports);
 __exportStar(require("./ApproveProjectAccessRequest"), exports);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cirrobio/api-client",
-  "version": "0.1.27",
+  "version": "0.1.28",
   "description": "API client for Cirro",
   "author": "CirroBio",
   "repository": {

package/src/apis/ComputeEnvironmentApi.ts

@@ -15,22 +15,162 @@
 
 import * as runtime from '../runtime';
 import type {
+  AgentDetail,
+  AgentInput,
   ComputeEnvironmentConfiguration,
+  CreateResponse,
 } from '../models/index';
 import {
+    AgentDetailFromJSON,
+    AgentDetailToJSON,
+    AgentInputFromJSON,
+    AgentInputToJSON,
     ComputeEnvironmentConfigurationFromJSON,
     ComputeEnvironmentConfigurationToJSON,
+    CreateResponseFromJSON,
+    CreateResponseToJSON,
 } 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 class ComputeEnvironmentApi extends runtime.BaseAPI {
 
+    /**
+     * Create a new agent
+     * Create agent
+     */
+    async createAgentRaw(requestParameters: CreateAgentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CreateResponse>> {
+        if (requestParameters.agentInput === null || requestParameters.agentInput === undefined) {
+            throw new runtime.RequiredError('agentInput','Required parameter requestParameters.agentInput was null or undefined when calling createAgent.');
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        headerParameters['Content-Type'] = 'application/json';
+
+        if (this.configuration && this.configuration.accessToken) {
+            const token = this.configuration.accessToken;
+            const tokenString = await token("accessToken", []);
+
+            if (tokenString) {
+                headerParameters["Authorization"] = `Bearer ${tokenString}`;
+            }
+        }
+        const response = await this.request({
+            path: `/agents`,
+            method: 'POST',
+            headers: headerParameters,
+            query: queryParameters,
+            body: AgentInputToJSON(requestParameters.agentInput),
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => CreateResponseFromJSON(jsonValue));
+    }
+
+    /**
+     * Create a new agent
+     * Create agent
+     */
+    async createAgent(requestParameters: CreateAgentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CreateResponse> {
+        const response = await this.createAgentRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Delete an agent
+     * Delete agent
+     */
+    async deleteAgentRaw(requestParameters: DeleteAgentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>> {
+        if (requestParameters.agentId === null || requestParameters.agentId === undefined) {
+            throw new runtime.RequiredError('agentId','Required parameter requestParameters.agentId was null or undefined when calling deleteAgent.');
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        if (this.configuration && this.configuration.accessToken) {
+            const token = this.configuration.accessToken;
+            const tokenString = await token("accessToken", []);
+
+            if (tokenString) {
+                headerParameters["Authorization"] = `Bearer ${tokenString}`;
+            }
+        }
+        const response = await this.request({
+            path: `/agents/{agentId}`.replace(`{${"agentId"}}`, encodeURIComponent(String(requestParameters.agentId))),
+            method: 'DELETE',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+
+        return new runtime.VoidApiResponse(response);
+    }
+
+    /**
+     * Delete an agent
+     * Delete agent
+     */
+    async deleteAgent(requestParameters: DeleteAgentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void> {
+        await this.deleteAgentRaw(requestParameters, initOverrides);
+    }
+
+    /**
+     * Get a list of agents
+     * Get agents
+     */
+    async getAgentsRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<AgentDetail>>> {
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        if (this.configuration && this.configuration.accessToken) {
+            const token = this.configuration.accessToken;
+            const tokenString = await token("accessToken", []);
+
+            if (tokenString) {
+                headerParameters["Authorization"] = `Bearer ${tokenString}`;
+            }
+        }
+        const response = await this.request({
+            path: `/agents`,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => jsonValue.map(AgentDetailFromJSON));
+    }
+
+    /**
+     * Get a list of agents
+     * Get agents
+     */
+    async getAgents(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<AgentDetail>> {
+        const response = await this.getAgentsRaw(initOverrides);
+        return await response.value();
+    }
+
     /**
      * Get a list of compute environments for a project
      * Get compute environments
@@ -71,4 +211,50 @@ export class ComputeEnvironmentApi extends runtime.BaseAPI {
         return await response.value();
     }
 
+    /**
+     * Update an agent
+     * Update agent
+     */
+    async updateAgentRaw(requestParameters: UpdateAgentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>> {
+        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.');
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        headerParameters['Content-Type'] = 'application/json';
+
+        if (this.configuration && this.configuration.accessToken) {
+            const token = this.configuration.accessToken;
+            const tokenString = await token("accessToken", []);
+
+            if (tokenString) {
+                headerParameters["Authorization"] = `Bearer ${tokenString}`;
+            }
+        }
+        const response = await this.request({
+            path: `/agents/{agentId}`.replace(`{${"agentId"}}`, encodeURIComponent(String(requestParameters.agentId))),
+            method: 'PUT',
+            headers: headerParameters,
+            query: queryParameters,
+            body: AgentInputToJSON(requestParameters.agentInput),
+        }, initOverrides);
+
+        return new runtime.VoidApiResponse(response);
+    }
+
+    /**
+     * Update an agent
+     * Update agent
+     */
+    async updateAgent(requestParameters: UpdateAgentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void> {
+        await this.updateAgentRaw(requestParameters, initOverrides);
+    }
+
 }

package/src/apis/UsersApi.ts

@@ -46,7 +46,7 @@ export interface InviteUserOperationRequest {
 }
 
 export interface ListUsersRequest {
-    username?: string;
+    username?: string | null;
     limit?: number;
     nextToken?: string;
 }

package/src/models/AgentDetail.ts

@@ -0,0 +1,157 @@
+/* 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.
+ */
+
+import { exists, mapValues } from '../runtime';
+import type { AgentRegistration } from './AgentRegistration';
+import {
+    AgentRegistrationFromJSON,
+    AgentRegistrationFromJSONTyped,
+    AgentRegistrationToJSON,
+} from './AgentRegistration';
+import type { AgentStatus } from './AgentStatus';
+import {
+    AgentStatusFromJSON,
+    AgentStatusFromJSONTyped,
+    AgentStatusToJSON,
+} 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 function instanceOfAgentDetail(value: object): boolean {
+    let isInstance = true;
+    isInstance = isInstance && "id" in value;
+    isInstance = isInstance && "name" in value;
+    isInstance = isInstance && "agentRoleArn" in value;
+    isInstance = isInstance && "status" in value;
+    isInstance = isInstance && "createdBy" in value;
+    isInstance = isInstance && "createdAt" in value;
+    isInstance = isInstance && "updatedAt" in value;
+
+    return isInstance;
+}
+
+export function AgentDetailFromJSON(json: any): AgentDetail {
+    return AgentDetailFromJSONTyped(json, false);
+}
+
+export function AgentDetailFromJSONTyped(json: any, ignoreDiscriminator: boolean): AgentDetail {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        
+        'id': json['id'],
+        'name': json['name'],
+        'agentRoleArn': json['agentRoleArn'],
+        'status': AgentStatusFromJSON(json['status']),
+        'registration': !exists(json, 'registration') ? undefined : AgentRegistrationFromJSON(json['registration']),
+        'tags': !exists(json, 'tags') ? undefined : json['tags'],
+        'environmentConfiguration': !exists(json, 'environmentConfiguration') ? undefined : json['environmentConfiguration'],
+        'createdBy': json['createdBy'],
+        'createdAt': (new Date(json['createdAt'])),
+        'updatedAt': (new Date(json['updatedAt'])),
+    };
+}
+
+export function AgentDetailToJSON(value?: AgentDetail | null): any {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        
+        'id': value.id,
+        'name': value.name,
+        'agentRoleArn': value.agentRoleArn,
+        'status': AgentStatusToJSON(value.status),
+        'registration': AgentRegistrationToJSON(value.registration),
+        'tags': value.tags,
+        'environmentConfiguration': value.environmentConfiguration,
+        'createdBy': value.createdBy,
+        'createdAt': (value.createdAt.toISOString()),
+        'updatedAt': (value.updatedAt.toISOString()),
+    };
+}
+

package/src/models/AgentInput.ts

@@ -0,0 +1,107 @@
+/* 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.
+ */
+
+import { exists, mapValues } from '../runtime';
+/**
+ * 
+ * @export
+ * @interface AgentInput
+ */
+export interface AgentInput {
+    /**
+     * The unique ID of the agent (required on create)
+     * @type {string}
+     * @memberof AgentInput
+     */
+    id?: string | null;
+    /**
+     * The display name of the agent
+     * @type {string}
+     * @memberof AgentInput
+     */
+    name: string;
+    /**
+     * Arn of the AWS IAM role or user that the agent will use (JSONSchema format)
+     * @type {string}
+     * @memberof AgentInput
+     */
+    agentRoleArn: string;
+    /**
+     * The configuration options available for the agent 
+     * @type {{ [key: string]: any; }}
+     * @memberof AgentInput
+     */
+    configurationOptionsSchema?: { [key: string]: any; } | null;
+    /**
+     * The environment configuration for the agent
+     * @type {{ [key: string]: string; }}
+     * @memberof AgentInput
+     */
+    environmentConfiguration?: { [key: string]: string; } | null;
+    /**
+     * The tags associated with the agent displayed to the user
+     * @type {{ [key: string]: string; }}
+     * @memberof AgentInput
+     */
+    tags?: { [key: string]: string; } | null;
+}
+
+/**
+ * Check if a given object implements the AgentInput interface.
+ */
+export function instanceOfAgentInput(value: object): boolean {
+    let isInstance = true;
+    isInstance = isInstance && "name" in value;
+    isInstance = isInstance && "agentRoleArn" in value;
+
+    return isInstance;
+}
+
+export function AgentInputFromJSON(json: any): AgentInput {
+    return AgentInputFromJSONTyped(json, false);
+}
+
+export function AgentInputFromJSONTyped(json: any, ignoreDiscriminator: boolean): AgentInput {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        
+        'id': !exists(json, 'id') ? undefined : json['id'],
+        'name': json['name'],
+        'agentRoleArn': json['agentRoleArn'],
+        'configurationOptionsSchema': !exists(json, 'configurationOptionsSchema') ? undefined : json['configurationOptionsSchema'],
+        'environmentConfiguration': !exists(json, 'environmentConfiguration') ? undefined : json['environmentConfiguration'],
+        'tags': !exists(json, 'tags') ? undefined : json['tags'],
+    };
+}
+
+export function AgentInputToJSON(value?: AgentInput | null): any {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        
+        'id': value.id,
+        'name': value.name,
+        'agentRoleArn': value.agentRoleArn,
+        'configurationOptionsSchema': value.configurationOptionsSchema,
+        'environmentConfiguration': value.environmentConfiguration,
+        'tags': value.tags,
+    };
+}
+

package/src/models/AgentRegistration.ts

@@ -0,0 +1,102 @@
+/* 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.
+ */
+
+import { exists, mapValues } from '../runtime';
+/**
+ * 
+ * @export
+ * @interface AgentRegistration
+ */
+export interface AgentRegistration {
+    /**
+     * 
+     * @type {string}
+     * @memberof AgentRegistration
+     */
+    localIp: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof AgentRegistration
+     */
+    remoteIp: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof AgentRegistration
+     */
+    agentVersion: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof AgentRegistration
+     */
+    hostname: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof AgentRegistration
+     */
+    os: string;
+}
+
+/**
+ * Check if a given object implements the AgentRegistration interface.
+ */
+export function instanceOfAgentRegistration(value: object): boolean {
+    let isInstance = true;
+    isInstance = isInstance && "localIp" in value;
+    isInstance = isInstance && "remoteIp" in value;
+    isInstance = isInstance && "agentVersion" in value;
+    isInstance = isInstance && "hostname" in value;
+    isInstance = isInstance && "os" in value;
+
+    return isInstance;
+}
+
+export function AgentRegistrationFromJSON(json: any): AgentRegistration {
+    return AgentRegistrationFromJSONTyped(json, false);
+}
+
+export function AgentRegistrationFromJSONTyped(json: any, ignoreDiscriminator: boolean): AgentRegistration {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        
+        'localIp': json['localIp'],
+        'remoteIp': json['remoteIp'],
+        'agentVersion': json['agentVersion'],
+        'hostname': json['hostname'],
+        'os': json['os'],
+    };
+}
+
+export function AgentRegistrationToJSON(value?: AgentRegistration | null): any {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        
+        'localIp': value.localIp,
+        'remoteIp': value.remoteIp,
+        'agentVersion': value.agentVersion,
+        'hostname': value.hostname,
+        'os': value.os,
+    };
+}
+

package/src/models/index.ts

@@ -3,6 +3,9 @@
 export * from './AWSCredentials';
 export * from './AccessType';
 export * from './Agent';
+export * from './AgentDetail';
+export * from './AgentInput';
+export * from './AgentRegistration';
 export * from './AgentStatus';
 export * from './AllowedDataType';
 export * from './ApproveProjectAccessRequest';