@cirrobio/api-client 0.1.26 → 0.1.28

package/src/apis/UsersApi.ts

@@ -17,6 +17,7 @@ import * as runtime from '../runtime';
 import type {
   InviteUserRequest,
   InviteUserResponse,
+  PaginatedResponseUserDto,
   UpdateUserRequest,
   User,
   UserDetail,
@@ -26,6 +27,8 @@ import {
     InviteUserRequestToJSON,
     InviteUserResponseFromJSON,
     InviteUserResponseToJSON,
+    PaginatedResponseUserDtoFromJSON,
+    PaginatedResponseUserDtoToJSON,
     UpdateUserRequestFromJSON,
     UpdateUserRequestToJSON,
     UserFromJSON,
@@ -38,14 +41,16 @@ 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;
 }
@@ -101,22 +106,20 @@ export class UsersApi extends runtime.BaseAPI {
     }
 
     /**
-     * Gets a list of users matching the username pattern
-     * List users
+     * Invites a user to the system
+     * Invite user
      */
-    async getUsersRaw(requestParameters: GetUsersRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<User>>> {
-        if (requestParameters.username === null || requestParameters.username === undefined) {
-            throw new runtime.RequiredError('username','Required parameter requestParameters.username was null or undefined when calling getUsers.');
+    async inviteUserRaw(requestParameters: InviteUserOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<InviteUserResponse>> {
+        if (requestParameters.inviteUserRequest === null || requestParameters.inviteUserRequest === undefined) {
+            throw new runtime.RequiredError('inviteUserRequest','Required parameter requestParameters.inviteUserRequest was null or undefined when calling inviteUser.');
         }
 
         const queryParameters: any = {};
 
-        if (requestParameters.username !== undefined) {
-            queryParameters['username'] = requestParameters.username;
-        }
-
         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", []);
@@ -127,37 +130,44 @@ export class UsersApi extends runtime.BaseAPI {
         }
         const response = await this.request({
             path: `/users`,
-            method: 'GET',
+            method: 'POST',
             headers: headerParameters,
             query: queryParameters,
+            body: InviteUserRequestToJSON(requestParameters.inviteUserRequest),
         }, initOverrides);
 
-        return new runtime.JSONApiResponse(response, (jsonValue) => jsonValue.map(UserFromJSON));
+        return new runtime.JSONApiResponse(response, (jsonValue) => InviteUserResponseFromJSON(jsonValue));
     }
 
     /**
-     * Gets a list of users matching the username pattern
-     * List users
+     * Invites a user to the system
+     * Invite user
      */
-    async getUsers(requestParameters: GetUsersRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<User>> {
-        const response = await this.getUsersRaw(requestParameters, initOverrides);
+    async inviteUser(requestParameters: InviteUserOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<InviteUserResponse> {
+        const response = await this.inviteUserRaw(requestParameters, initOverrides);
         return await response.value();
     }
 
     /**
-     * Invites a user to the system
-     * Invite user
+     * Gets a list of users, matching an optional username pattern
+     * List users
      */
-    async inviteUserRaw(requestParameters: InviteUserOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<InviteUserResponse>> {
-        if (requestParameters.inviteUserRequest === null || requestParameters.inviteUserRequest === undefined) {
-            throw new runtime.RequiredError('inviteUserRequest','Required parameter requestParameters.inviteUserRequest was null or undefined when calling inviteUser.');
+    async listUsersRaw(requestParameters: ListUsersRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PaginatedResponseUserDto>> {
+        const queryParameters: any = {};
+
+        if (requestParameters.username !== undefined) {
+            queryParameters['username'] = requestParameters.username;
         }
 
-        const queryParameters: any = {};
+        if (requestParameters.limit !== undefined) {
+            queryParameters['limit'] = requestParameters.limit;
+        }
 
-        const headerParameters: runtime.HTTPHeaders = {};
+        if (requestParameters.nextToken !== undefined) {
+            queryParameters['nextToken'] = requestParameters.nextToken;
+        }
 
-        headerParameters['Content-Type'] = 'application/json';
+        const headerParameters: runtime.HTTPHeaders = {};
 
         if (this.configuration && this.configuration.accessToken) {
             const token = this.configuration.accessToken;
@@ -169,21 +179,20 @@ export class UsersApi extends runtime.BaseAPI {
         }
         const response = await this.request({
             path: `/users`,
-            method: 'POST',
+            method: 'GET',
             headers: headerParameters,
             query: queryParameters,
-            body: InviteUserRequestToJSON(requestParameters.inviteUserRequest),
         }, initOverrides);
 
-        return new runtime.JSONApiResponse(response, (jsonValue) => InviteUserResponseFromJSON(jsonValue));
+        return new runtime.JSONApiResponse(response, (jsonValue) => PaginatedResponseUserDtoFromJSON(jsonValue));
     }
 
     /**
-     * Invites a user to the system
-     * Invite user
+     * Gets a list of users, matching an optional username pattern
+     * List users
      */
-    async inviteUser(requestParameters: InviteUserOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<InviteUserResponse> {
-        const response = await this.inviteUserRaw(requestParameters, initOverrides);
+    async listUsers(requestParameters: ListUsersRequest = {}, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PaginatedResponseUserDto> {
+        const response = await this.listUsersRaw(requestParameters, initOverrides);
         return await response.value();
     }
 

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/PaginatedResponseUserDto.ts

@@ -0,0 +1,82 @@
+/* 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 { User } from './User';
+import {
+    UserFromJSON,
+    UserFromJSONTyped,
+    UserToJSON,
+} from './User';
+
+/**
+ * 
+ * @export
+ * @interface PaginatedResponseUserDto
+ */
+export interface PaginatedResponseUserDto {
+    /**
+     * 
+     * @type {Array<User>}
+     * @memberof PaginatedResponseUserDto
+     */
+    data: Array<User>;
+    /**
+     * 
+     * @type {string}
+     * @memberof PaginatedResponseUserDto
+     */
+    nextToken: string;
+}
+
+/**
+ * Check if a given object implements the PaginatedResponseUserDto interface.
+ */
+export function instanceOfPaginatedResponseUserDto(value: object): boolean {
+    let isInstance = true;
+    isInstance = isInstance && "data" in value;
+    isInstance = isInstance && "nextToken" in value;
+
+    return isInstance;
+}
+
+export function PaginatedResponseUserDtoFromJSON(json: any): PaginatedResponseUserDto {
+    return PaginatedResponseUserDtoFromJSONTyped(json, false);
+}
+
+export function PaginatedResponseUserDtoFromJSONTyped(json: any, ignoreDiscriminator: boolean): PaginatedResponseUserDto {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        
+        'data': ((json['data'] as Array<any>).map(UserFromJSON)),
+        'nextToken': json['nextToken'],
+    };
+}
+
+export function PaginatedResponseUserDtoToJSON(value?: PaginatedResponseUserDto | null): any {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        
+        'data': ((value.data as Array<any>).map(UserToJSON)),
+        'nextToken': value.nextToken,
+    };
+}
+

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';
@@ -54,6 +57,7 @@ export * from './NotebookInstanceStatusResponse';
 export * from './OpenNotebookInstanceResponse';
 export * from './PaginatedResponseDatasetListDto';
 export * from './PaginatedResponseSampleDto';
+export * from './PaginatedResponseUserDto';
 export * from './PipelineCode';
 export * from './PipelineCost';
 export * from './PortalErrorResponse';