@cirrobio/api-client 0.0.10-alpha → 0.0.12-alpha

package/src/models/PaginatedResponseDatasetListDto.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 { Dataset } from './Dataset';
+import {
+    DatasetFromJSON,
+    DatasetFromJSONTyped,
+    DatasetToJSON,
+} from './Dataset';
+
+/**
+ * 
+ * @export
+ * @interface PaginatedResponseDatasetListDto
+ */
+export interface PaginatedResponseDatasetListDto {
+    /**
+     * 
+     * @type {Array<Dataset>}
+     * @memberof PaginatedResponseDatasetListDto
+     */
+    data: Array<Dataset>;
+    /**
+     * 
+     * @type {string}
+     * @memberof PaginatedResponseDatasetListDto
+     */
+    nextToken: string;
+}
+
+/**
+ * Check if a given object implements the PaginatedResponseDatasetListDto interface.
+ */
+export function instanceOfPaginatedResponseDatasetListDto(value: object): boolean {
+    let isInstance = true;
+    isInstance = isInstance && "data" in value;
+    isInstance = isInstance && "nextToken" in value;
+
+    return isInstance;
+}
+
+export function PaginatedResponseDatasetListDtoFromJSON(json: any): PaginatedResponseDatasetListDto {
+    return PaginatedResponseDatasetListDtoFromJSONTyped(json, false);
+}
+
+export function PaginatedResponseDatasetListDtoFromJSONTyped(json: any, ignoreDiscriminator: boolean): PaginatedResponseDatasetListDto {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        
+        'data': ((json['data'] as Array<any>).map(DatasetFromJSON)),
+        'nextToken': json['nextToken'],
+    };
+}
+
+export function PaginatedResponseDatasetListDtoToJSON(value?: PaginatedResponseDatasetListDto | null): any {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        
+        'data': ((value.data as Array<any>).map(DatasetToJSON)),
+        'nextToken': value.nextToken,
+    };
+}
+

package/src/models/Project.ts

@@ -13,6 +13,12 @@
  */
 
 import { exists, mapValues } from '../runtime';
+import type { Status } from './Status';
+import {
+    StatusFromJSON,
+    StatusFromJSONTyped,
+    StatusToJSON,
+} from './Status';
 import type { Tag } from './Tag';
 import {
     TagFromJSON,
@@ -46,16 +52,22 @@ export interface Project {
     description: string;
     /**
      * 
-     * @type {string}
+     * @type {Status}
      * @memberof Project
      */
-    status: string;
+    status: Status;
     /**
      * 
      * @type {Array<Tag>}
      * @memberof Project
      */
     tags: Array<Tag>;
+    /**
+     * 
+     * @type {string}
+     * @memberof Project
+     */
+    billingAccountId: string;
 }
 
 /**
@@ -68,6 +80,7 @@ export function instanceOfProject(value: object): boolean {
     isInstance = isInstance && "description" in value;
     isInstance = isInstance && "status" in value;
     isInstance = isInstance && "tags" in value;
+    isInstance = isInstance && "billingAccountId" in value;
 
     return isInstance;
 }
@@ -85,8 +98,9 @@ export function ProjectFromJSONTyped(json: any, ignoreDiscriminator: boolean): P
         'id': json['id'],
         'name': json['name'],
         'description': json['description'],
-        'status': json['status'],
+        'status': StatusFromJSON(json['status']),
         'tags': ((json['tags'] as Array<any>).map(TagFromJSON)),
+        'billingAccountId': json['billingAccountId'],
     };
 }
 
@@ -102,8 +116,9 @@ export function ProjectToJSON(value?: Project | null): any {
         'id': value.id,
         'name': value.name,
         'description': value.description,
-        'status': value.status,
+        'status': StatusToJSON(value.status),
         'tags': ((value.tags as Array<any>).map(TagToJSON)),
+        'billingAccountId': value.billingAccountId,
     };
 }
 

package/src/models/ProjectDetail.ts

@@ -25,6 +25,12 @@ import {
     ProjectSettingsFromJSONTyped,
     ProjectSettingsToJSON,
 } from './ProjectSettings';
+import type { Status } from './Status';
+import {
+    StatusFromJSON,
+    StatusFromJSONTyped,
+    StatusToJSON,
+} from './Status';
 import type { Tag } from './Tag';
 import {
     TagFromJSON,
@@ -70,10 +76,10 @@ export interface ProjectDetail {
     contacts: Array<Contact>;
     /**
      * 
-     * @type {string}
+     * @type {Status}
      * @memberof ProjectDetail
      */
-    status: string;
+    status: Status;
     /**
      * 
      * @type {ProjectSettings}
@@ -100,16 +106,16 @@ export interface ProjectDetail {
     createdBy: string;
     /**
      * 
-     * @type {string}
+     * @type {Date}
      * @memberof ProjectDetail
      */
-    createdAt: string;
+    createdAt: Date;
     /**
      * 
-     * @type {string}
+     * @type {Date}
      * @memberof ProjectDetail
      */
-    updatedAt: string;
+    updatedAt: Date;
 }
 
 /**
@@ -148,13 +154,13 @@ export function ProjectDetailFromJSONTyped(json: any, ignoreDiscriminator: boole
         'description': json['description'],
         'billingAccountId': json['billingAccountId'],
         'contacts': ((json['contacts'] as Array<any>).map(ContactFromJSON)),
-        'status': json['status'],
+        'status': StatusFromJSON(json['status']),
         'settings': ProjectSettingsFromJSON(json['settings']),
         'statusMessage': json['statusMessage'],
         'tags': ((json['tags'] as Array<any>).map(TagFromJSON)),
         'createdBy': json['createdBy'],
-        'createdAt': json['createdAt'],
-        'updatedAt': json['updatedAt'],
+        'createdAt': (new Date(json['createdAt'])),
+        'updatedAt': (new Date(json['updatedAt'])),
     };
 }
 
@@ -172,13 +178,13 @@ export function ProjectDetailToJSON(value?: ProjectDetail | null): any {
         'description': value.description,
         'billingAccountId': value.billingAccountId,
         'contacts': ((value.contacts as Array<any>).map(ContactToJSON)),
-        'status': value.status,
+        'status': StatusToJSON(value.status),
         'settings': ProjectSettingsToJSON(value.settings),
         'statusMessage': value.statusMessage,
         'tags': ((value.tags as Array<any>).map(TagToJSON)),
         'createdBy': value.createdBy,
-        'createdAt': value.createdAt,
-        'updatedAt': value.updatedAt,
+        'createdAt': (value.createdAt.toISOString()),
+        'updatedAt': (value.updatedAt.toISOString()),
     };
 }
 

package/src/models/ProjectSettings.ts

@@ -27,11 +27,11 @@ import {
  */
 export interface ProjectSettings {
     /**
-     * 
+     * Total allowed cost for the budget period
      * @type {number}
      * @memberof ProjectSettings
      */
-    budgetAmount: number;
+    budgetAmount?: number;
     /**
      * 
      * @type {BudgetPeriod}
@@ -39,53 +39,53 @@ export interface ProjectSettings {
      */
     budgetPeriod: BudgetPeriod;
     /**
-     * 
+     * AMI ID for the DRAGEN compute environment (if enabled)
      * @type {string}
      * @memberof ProjectSettings
      */
-    dragenAmi: string;
+    dragenAmi?: string | null;
     /**
-     * 
+     * Enables the default compute environment
      * @type {boolean}
      * @memberof ProjectSettings
      */
-    enableCompute: boolean;
+    enableCompute?: boolean;
     /**
-     * 
+     * Enables the DRAGEN compute environment
      * @type {boolean}
      * @memberof ProjectSettings
      */
-    enableDragen: boolean;
+    enableDragen?: boolean;
     /**
-     * 
+     * Enables the AWS Backup service for S3
      * @type {boolean}
      * @memberof ProjectSettings
      */
-    enableBackup: boolean;
+    enableBackup?: boolean;
     /**
-     * 
+     * Enables access to files over SFTP
      * @type {boolean}
      * @memberof ProjectSettings
      */
-    enableSftp: boolean;
+    enableSftp?: boolean;
     /**
-     * 
+     * Service quota limit for On Demand F1 instances
      * @type {number}
      * @memberof ProjectSettings
      */
-    maxF1VCPU: number;
+    maxF1VCPU?: number;
     /**
-     * 
+     * Service quota limit for SPOT instances
      * @type {number}
      * @memberof ProjectSettings
      */
-    maxSpotVCPU: number;
+    maxSpotVCPU?: number;
     /**
-     * 
+     * Days to keep deleted datasets before being permanently erased
      * @type {number}
      * @memberof ProjectSettings
      */
-    retentionPolicyDays: number;
+    retentionPolicyDays?: number;
     /**
      * 
      * @type {Array<string>}
@@ -93,29 +93,29 @@ export interface ProjectSettings {
      */
     serviceConnections: Array<string>;
     /**
-     * 
+     * Creates a default VPC for the compute environment, if false, VPC ID must be provided
      * @type {boolean}
      * @memberof ProjectSettings
      */
-    createVpc: boolean;
+    createVpc?: boolean;
     /**
-     * 
+     * VPC that the compute environment will use
      * @type {string}
      * @memberof ProjectSettings
      */
-    vpcId: string;
+    vpcId?: string | null;
     /**
-     * 
+     * List of subnets that the compute environment will use
      * @type {Array<string>}
      * @memberof ProjectSettings
      */
-    batchSubnets: Array<string>;
+    batchSubnets?: Array<string> | null;
     /**
-     * 
+     * KMS Key ARN to encrypt S3 objects, one will be created if the arn is not provided
      * @type {string}
      * @memberof ProjectSettings
      */
-    kmsArn: string;
+    kmsArn?: string | null;
 }
 
 /**
@@ -123,21 +123,8 @@ export interface ProjectSettings {
  */
 export function instanceOfProjectSettings(value: object): boolean {
     let isInstance = true;
-    isInstance = isInstance && "budgetAmount" in value;
     isInstance = isInstance && "budgetPeriod" in value;
-    isInstance = isInstance && "dragenAmi" in value;
-    isInstance = isInstance && "enableCompute" in value;
-    isInstance = isInstance && "enableDragen" in value;
-    isInstance = isInstance && "enableBackup" in value;
-    isInstance = isInstance && "enableSftp" in value;
-    isInstance = isInstance && "maxF1VCPU" in value;
-    isInstance = isInstance && "maxSpotVCPU" in value;
-    isInstance = isInstance && "retentionPolicyDays" in value;
     isInstance = isInstance && "serviceConnections" in value;
-    isInstance = isInstance && "createVpc" in value;
-    isInstance = isInstance && "vpcId" in value;
-    isInstance = isInstance && "batchSubnets" in value;
-    isInstance = isInstance && "kmsArn" in value;
 
     return isInstance;
 }
@@ -152,21 +139,21 @@ export function ProjectSettingsFromJSONTyped(json: any, ignoreDiscriminator: boo
     }
     return {
         
-        'budgetAmount': json['budgetAmount'],
+        'budgetAmount': !exists(json, 'budgetAmount') ? undefined : json['budgetAmount'],
         'budgetPeriod': BudgetPeriodFromJSON(json['budgetPeriod']),
-        'dragenAmi': json['dragenAmi'],
-        'enableCompute': json['enableCompute'],
-        'enableDragen': json['enableDragen'],
-        'enableBackup': json['enableBackup'],
-        'enableSftp': json['enableSftp'],
-        'maxF1VCPU': json['maxF1VCPU'],
-        'maxSpotVCPU': json['maxSpotVCPU'],
-        'retentionPolicyDays': json['retentionPolicyDays'],
+        'dragenAmi': !exists(json, 'dragenAmi') ? undefined : json['dragenAmi'],
+        'enableCompute': !exists(json, 'enableCompute') ? undefined : json['enableCompute'],
+        'enableDragen': !exists(json, 'enableDragen') ? undefined : json['enableDragen'],
+        'enableBackup': !exists(json, 'enableBackup') ? undefined : json['enableBackup'],
+        'enableSftp': !exists(json, 'enableSftp') ? undefined : json['enableSftp'],
+        'maxF1VCPU': !exists(json, 'maxF1VCPU') ? undefined : json['maxF1VCPU'],
+        'maxSpotVCPU': !exists(json, 'maxSpotVCPU') ? undefined : json['maxSpotVCPU'],
+        'retentionPolicyDays': !exists(json, 'retentionPolicyDays') ? undefined : json['retentionPolicyDays'],
         'serviceConnections': json['serviceConnections'],
-        'createVpc': json['createVpc'],
-        'vpcId': json['vpcId'],
-        'batchSubnets': json['batchSubnets'],
-        'kmsArn': json['kmsArn'],
+        'createVpc': !exists(json, 'createVpc') ? undefined : json['createVpc'],
+        'vpcId': !exists(json, 'vpcId') ? undefined : json['vpcId'],
+        'batchSubnets': !exists(json, 'batchSubnets') ? undefined : json['batchSubnets'],
+        'kmsArn': !exists(json, 'kmsArn') ? undefined : json['kmsArn'],
     };
 }
 

package/src/models/RegisterDatasetRequest.ts

@@ -21,10 +21,28 @@ import { exists, mapValues } from '../runtime';
 export interface RegisterDatasetRequest {
     /**
      * 
-     * @type {RegisterDatasetRequest}
+     * @type {string}
      * @memberof RegisterDatasetRequest
      */
-    registerDatasetRequest?: RegisterDatasetRequest;
+    name: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof RegisterDatasetRequest
+     */
+    description: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof RegisterDatasetRequest
+     */
+    processId: string;
+    /**
+     * List of file names (with relative paths) that will be uploaded
+     * @type {Array<string>}
+     * @memberof RegisterDatasetRequest
+     */
+    expectedFiles?: Array<string>;
 }
 
 /**
@@ -32,6 +50,9 @@ export interface RegisterDatasetRequest {
  */
 export function instanceOfRegisterDatasetRequest(value: object): boolean {
     let isInstance = true;
+    isInstance = isInstance && "name" in value;
+    isInstance = isInstance && "description" in value;
+    isInstance = isInstance && "processId" in value;
 
     return isInstance;
 }
@@ -46,7 +67,10 @@ export function RegisterDatasetRequestFromJSONTyped(json: any, ignoreDiscriminat
     }
     return {
         
-        'registerDatasetRequest': !exists(json, 'registerDatasetRequest') ? undefined : RegisterDatasetRequestFromJSON(json['registerDatasetRequest']),
+        'name': json['name'],
+        'description': json['description'],
+        'processId': json['processId'],
+        'expectedFiles': !exists(json, 'expectedFiles') ? undefined : json['expectedFiles'],
     };
 }
 
@@ -59,7 +83,10 @@ export function RegisterDatasetRequestToJSON(value?: RegisterDatasetRequest | nu
     }
     return {
         
-        'registerDatasetRequest': RegisterDatasetRequestToJSON(value.registerDatasetRequest),
+        'name': value.name,
+        'description': value.description,
+        'processId': value.processId,
+        'expectedFiles': value.expectedFiles,
     };
 }
 

package/src/models/RegisterPublicDataRequest.ts

@@ -0,0 +1,83 @@
+/* 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 RegisterPublicDataRequest
+ */
+export interface RegisterPublicDataRequest {
+    /**
+     * 
+     * @type {string}
+     * @memberof RegisterPublicDataRequest
+     */
+    name: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof RegisterPublicDataRequest
+     */
+    description: string;
+    /**
+     * List of SRA/ENA/DDBJ/GEO/Synapse IDs
+     * @type {Array<string>}
+     * @memberof RegisterPublicDataRequest
+     */
+    publicIds?: Array<string>;
+}
+
+/**
+ * Check if a given object implements the RegisterPublicDataRequest interface.
+ */
+export function instanceOfRegisterPublicDataRequest(value: object): boolean {
+    let isInstance = true;
+    isInstance = isInstance && "name" in value;
+    isInstance = isInstance && "description" in value;
+
+    return isInstance;
+}
+
+export function RegisterPublicDataRequestFromJSON(json: any): RegisterPublicDataRequest {
+    return RegisterPublicDataRequestFromJSONTyped(json, false);
+}
+
+export function RegisterPublicDataRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): RegisterPublicDataRequest {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        
+        'name': json['name'],
+        'description': json['description'],
+        'publicIds': !exists(json, 'publicIds') ? undefined : json['publicIds'],
+    };
+}
+
+export function RegisterPublicDataRequestToJSON(value?: RegisterPublicDataRequest | null): any {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        
+        'name': value.name,
+        'description': value.description,
+        'publicIds': value.publicIds,
+    };
+}
+

package/src/models/Sample.ts

@@ -19,6 +19,12 @@ import { exists, mapValues } from '../runtime';
  * @interface Sample
  */
 export interface Sample {
+    /**
+     * 
+     * @type {string}
+     * @memberof Sample
+     */
+    id: string;
     /**
      * 
      * @type {string}
@@ -31,6 +37,18 @@ export interface Sample {
      * @memberof Sample
      */
     metadata: { [key: string]: any; };
+    /**
+     * 
+     * @type {Date}
+     * @memberof Sample
+     */
+    createdAt: Date;
+    /**
+     * 
+     * @type {Date}
+     * @memberof Sample
+     */
+    updatedAt: Date;
 }
 
 /**
@@ -38,8 +56,11 @@ export interface Sample {
  */
 export function instanceOfSample(value: object): boolean {
     let isInstance = true;
+    isInstance = isInstance && "id" in value;
     isInstance = isInstance && "name" in value;
     isInstance = isInstance && "metadata" in value;
+    isInstance = isInstance && "createdAt" in value;
+    isInstance = isInstance && "updatedAt" in value;
 
     return isInstance;
 }
@@ -54,8 +75,11 @@ export function SampleFromJSONTyped(json: any, ignoreDiscriminator: boolean): Sa
     }
     return {
         
+        'id': json['id'],
         'name': json['name'],
         'metadata': json['metadata'],
+        'createdAt': (new Date(json['createdAt'])),
+        'updatedAt': (new Date(json['updatedAt'])),
     };
 }
 
@@ -68,8 +92,11 @@ export function SampleToJSON(value?: Sample | null): any {
     }
     return {
         
+        'id': value.id,
         'name': value.name,
         'metadata': value.metadata,
+        'createdAt': (value.createdAt.toISOString()),
+        'updatedAt': (value.updatedAt.toISOString()),
     };
 }
 

package/src/models/Status.ts

@@ -0,0 +1,43 @@
+/* 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.
+ */
+
+/**
+ * 
+ * @export
+ * @enum {string}
+ */
+export enum Status {
+    Completed = 'COMPLETED',
+    Pending = 'PENDING',
+    Running = 'RUNNING',
+    Archived = 'ARCHIVED',
+    Deleted = 'DELETED',
+    Deleting = 'DELETING',
+    Delete = 'DELETE',
+    Failed = 'FAILED'
+}
+
+
+export function StatusFromJSON(json: any): Status {
+    return StatusFromJSONTyped(json, false);
+}
+
+export function StatusFromJSONTyped(json: any, ignoreDiscriminator: boolean): Status {
+    return json as Status;
+}
+
+export function StatusToJSON(value?: Status | null): any {
+    return value as any;
+}
+