@cirrobio/api-client 0.0.3-alpha → 0.0.5-alpha

package/dist/models/ProcessDetail.js

@@ -0,0 +1,85 @@
+"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.ProcessDetailToJSON = exports.ProcessDetailFromJSONTyped = exports.ProcessDetailFromJSON = exports.instanceOfProcessDetail = void 0;
+var runtime_1 = require("../runtime");
+var CustomPipelineSettings_1 = require("./CustomPipelineSettings");
+var Executor_1 = require("./Executor");
+/**
+ * Check if a given object implements the ProcessDetail interface.
+ */
+function instanceOfProcessDetail(value) {
+    var isInstance = true;
+    isInstance = isInstance && "id" in value;
+    isInstance = isInstance && "name" in value;
+    isInstance = isInstance && "description" in value;
+    isInstance = isInstance && "executor" in value;
+    isInstance = isInstance && "documentationUrl" in value;
+    isInstance = isInstance && "childProcessIds" in value;
+    isInstance = isInstance && "parentProcessIds" in value;
+    isInstance = isInstance && "owner" in value;
+    isInstance = isInstance && "linkedProjectIds" in value;
+    isInstance = isInstance && "customSettings" in value;
+    isInstance = isInstance && "isArchived" in value;
+    return isInstance;
+}
+exports.instanceOfProcessDetail = instanceOfProcessDetail;
+function ProcessDetailFromJSON(json) {
+    return ProcessDetailFromJSONTyped(json, false);
+}
+exports.ProcessDetailFromJSON = ProcessDetailFromJSON;
+function ProcessDetailFromJSONTyped(json, ignoreDiscriminator) {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        'id': json['id'],
+        'name': json['name'],
+        'description': json['description'],
+        'executor': (0, Executor_1.ExecutorFromJSON)(json['executor']),
+        'documentationUrl': json['documentationUrl'],
+        'fileRequirementsMessage': !(0, runtime_1.exists)(json, 'fileRequirementsMessage') ? undefined : json['fileRequirementsMessage'],
+        'childProcessIds': json['childProcessIds'],
+        'parentProcessIds': json['parentProcessIds'],
+        'owner': json['owner'],
+        'linkedProjectIds': json['linkedProjectIds'],
+        'customSettings': (0, CustomPipelineSettings_1.CustomPipelineSettingsFromJSON)(json['customSettings']),
+        'isArchived': json['isArchived'],
+    };
+}
+exports.ProcessDetailFromJSONTyped = ProcessDetailFromJSONTyped;
+function ProcessDetailToJSON(value) {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        'id': value.id,
+        'name': value.name,
+        'description': value.description,
+        'executor': (0, Executor_1.ExecutorToJSON)(value.executor),
+        'documentationUrl': value.documentationUrl,
+        'fileRequirementsMessage': value.fileRequirementsMessage,
+        'childProcessIds': value.childProcessIds,
+        'parentProcessIds': value.parentProcessIds,
+        'owner': value.owner,
+        'linkedProjectIds': value.linkedProjectIds,
+        'customSettings': (0, CustomPipelineSettings_1.CustomPipelineSettingsToJSON)(value.customSettings),
+        'isArchived': value.isArchived,
+    };
+}
+exports.ProcessDetailToJSON = ProcessDetailToJSON;

package/dist/models/ProjectMetrics.d.ts

@@ -22,19 +22,21 @@ export interface ProjectMetrics {
      */
     projectId: string;
     /**
-     *
-     * @type {{ [key: string]: any; }}
+     * Costs by service by month
+     * @type {{ [key: string]: { [key: string]: number; }; }}
      * @memberof ProjectMetrics
      */
-    costs: {
-        [key: string]: any;
+    costs?: {
+        [key: string]: {
+            [key: string]: number;
+        };
     };
     /**
-     *
+     * Storage usage by tier by day
      * @type {{ [key: string]: any; }}
      * @memberof ProjectMetrics
      */
-    storageMetrics: {
+    storageMetrics?: {
         [key: string]: any;
     };
 }

package/dist/models/ProjectMetrics.js

@@ -14,14 +14,13 @@
  */
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ProjectMetricsToJSON = exports.ProjectMetricsFromJSONTyped = exports.ProjectMetricsFromJSON = exports.instanceOfProjectMetrics = void 0;
+var runtime_1 = require("../runtime");
 /**
  * Check if a given object implements the ProjectMetrics interface.
  */
 function instanceOfProjectMetrics(value) {
     var isInstance = true;
     isInstance = isInstance && "projectId" in value;
-    isInstance = isInstance && "costs" in value;
-    isInstance = isInstance && "storageMetrics" in value;
     return isInstance;
 }
 exports.instanceOfProjectMetrics = instanceOfProjectMetrics;
@@ -35,8 +34,8 @@ function ProjectMetricsFromJSONTyped(json, ignoreDiscriminator) {
     }
     return {
         'projectId': json['projectId'],
-        'costs': json['costs'],
-        'storageMetrics': json['storageMetrics'],
+        'costs': !(0, runtime_1.exists)(json, 'costs') ? undefined : json['costs'],
+        'storageMetrics': !(0, runtime_1.exists)(json, 'storageMetrics') ? undefined : json['storageMetrics'],
     };
 }
 exports.ProjectMetricsFromJSONTyped = ProjectMetricsFromJSONTyped;

package/dist/models/ProjectSettings.d.ts

@@ -82,6 +82,30 @@ export interface ProjectSettings {
      * @memberof ProjectSettings
      */
     serviceConnections?: Array<string>;
+    /**
+     *
+     * @type {boolean}
+     * @memberof ProjectSettings
+     */
+    createVpc?: boolean;
+    /**
+     *
+     * @type {string}
+     * @memberof ProjectSettings
+     */
+    vpcId?: string;
+    /**
+     *
+     * @type {Array<string>}
+     * @memberof ProjectSettings
+     */
+    batchSubnets?: Array<string>;
+    /**
+     *
+     * @type {string}
+     * @memberof ProjectSettings
+     */
+    kmsArn?: string;
 }
 /**
  * Check if a given object implements the ProjectSettings interface.

package/dist/models/ProjectSettings.js

@@ -44,6 +44,10 @@ function ProjectSettingsFromJSONTyped(json, ignoreDiscriminator) {
         'maxSpotVCPU': !(0, runtime_1.exists)(json, 'maxSpotVCPU') ? undefined : json['maxSpotVCPU'],
         'retentionPolicyDays': !(0, runtime_1.exists)(json, 'retentionPolicyDays') ? undefined : json['retentionPolicyDays'],
         'serviceConnections': !(0, runtime_1.exists)(json, 'serviceConnections') ? undefined : json['serviceConnections'],
+        'createVpc': !(0, runtime_1.exists)(json, 'createVpc') ? undefined : json['createVpc'],
+        'vpcId': !(0, runtime_1.exists)(json, 'vpcId') ? undefined : json['vpcId'],
+        'batchSubnets': !(0, runtime_1.exists)(json, 'batchSubnets') ? undefined : json['batchSubnets'],
+        'kmsArn': !(0, runtime_1.exists)(json, 'kmsArn') ? undefined : json['kmsArn'],
     };
 }
 exports.ProjectSettingsFromJSONTyped = ProjectSettingsFromJSONTyped;
@@ -66,6 +70,10 @@ function ProjectSettingsToJSON(value) {
         'maxSpotVCPU': value.maxSpotVCPU,
         'retentionPolicyDays': value.retentionPolicyDays,
         'serviceConnections': value.serviceConnections,
+        'createVpc': value.createVpc,
+        'vpcId': value.vpcId,
+        'batchSubnets': value.batchSubnets,
+        'kmsArn': value.kmsArn,
     };
 }
 exports.ProjectSettingsToJSON = ProjectSettingsToJSON;

package/dist/models/Reference.d.ts

@@ -0,0 +1,55 @@
+/**
+ * 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
+ * @interface Reference
+ */
+export interface Reference {
+    /**
+     *
+     * @type {string}
+     * @memberof Reference
+     */
+    name: string;
+    /**
+     *
+     * @type {string}
+     * @memberof Reference
+     */
+    referenceType: string;
+    /**
+     *
+     * @type {Array<string>}
+     * @memberof Reference
+     */
+    files: Array<string>;
+    /**
+     *
+     * @type {string}
+     * @memberof Reference
+     */
+    createdBy: string;
+    /**
+     *
+     * @type {Date}
+     * @memberof Reference
+     */
+    createdAt: Date;
+}
+/**
+ * Check if a given object implements the Reference interface.
+ */
+export declare function instanceOfReference(value: object): boolean;
+export declare function ReferenceFromJSON(json: any): Reference;
+export declare function ReferenceFromJSONTyped(json: any, ignoreDiscriminator: boolean): Reference;
+export declare function ReferenceToJSON(value?: Reference | null): any;

package/dist/models/Reference.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.ReferenceToJSON = exports.ReferenceFromJSONTyped = exports.ReferenceFromJSON = exports.instanceOfReference = void 0;
+/**
+ * Check if a given object implements the Reference interface.
+ */
+function instanceOfReference(value) {
+    var isInstance = true;
+    isInstance = isInstance && "name" in value;
+    isInstance = isInstance && "referenceType" in value;
+    isInstance = isInstance && "files" in value;
+    isInstance = isInstance && "createdBy" in value;
+    isInstance = isInstance && "createdAt" in value;
+    return isInstance;
+}
+exports.instanceOfReference = instanceOfReference;
+function ReferenceFromJSON(json) {
+    return ReferenceFromJSONTyped(json, false);
+}
+exports.ReferenceFromJSON = ReferenceFromJSON;
+function ReferenceFromJSONTyped(json, ignoreDiscriminator) {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        'name': json['name'],
+        'referenceType': json['referenceType'],
+        'files': json['files'],
+        'createdBy': json['createdBy'],
+        'createdAt': (new Date(json['createdAt'])),
+    };
+}
+exports.ReferenceFromJSONTyped = ReferenceFromJSONTyped;
+function ReferenceToJSON(value) {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        'name': value.name,
+        'referenceType': value.referenceType,
+        'files': value.files,
+        'createdBy': value.createdBy,
+        'createdAt': (value.createdAt.toISOString()),
+    };
+}
+exports.ReferenceToJSON = ReferenceToJSON;

package/dist/models/ReferenceType.d.ts

@@ -21,6 +21,26 @@ export interface ReferenceType {
      * @memberof ReferenceType
      */
     name: string;
+    /**
+     *
+     * @type {string}
+     * @memberof ReferenceType
+     */
+    description: string;
+    /**
+     *
+     * @type {string}
+     * @memberof ReferenceType
+     */
+    directory: string;
+    /**
+     *
+     * @type {Array<{ [key: string]: any; }>}
+     * @memberof ReferenceType
+     */
+    validation: Array<{
+        [key: string]: any;
+    }>;
 }
 /**
  * Check if a given object implements the ReferenceType interface.

package/dist/models/ReferenceType.js

@@ -20,6 +20,9 @@ exports.ReferenceTypeToJSON = exports.ReferenceTypeFromJSONTyped = exports.Refer
 function instanceOfReferenceType(value) {
     var isInstance = true;
     isInstance = isInstance && "name" in value;
+    isInstance = isInstance && "description" in value;
+    isInstance = isInstance && "directory" in value;
+    isInstance = isInstance && "validation" in value;
     return isInstance;
 }
 exports.instanceOfReferenceType = instanceOfReferenceType;
@@ -33,6 +36,9 @@ function ReferenceTypeFromJSONTyped(json, ignoreDiscriminator) {
     }
     return {
         'name': json['name'],
+        'description': json['description'],
+        'directory': json['directory'],
+        'validation': json['validation'],
     };
 }
 exports.ReferenceTypeFromJSONTyped = ReferenceTypeFromJSONTyped;
@@ -45,6 +51,9 @@ function ReferenceTypeToJSON(value) {
     }
     return {
         'name': value.name,
+        'description': value.description,
+        'directory': value.directory,
+        'validation': value.validation,
     };
 }
 exports.ReferenceTypeToJSON = ReferenceTypeToJSON;

package/dist/models/Sample.d.ts

@@ -0,0 +1,39 @@
+/**
+ * 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
+ * @interface Sample
+ */
+export interface Sample {
+    /**
+     *
+     * @type {string}
+     * @memberof Sample
+     */
+    name: string;
+    /**
+     *
+     * @type {{ [key: string]: any; }}
+     * @memberof Sample
+     */
+    metadata: {
+        [key: string]: any;
+    };
+}
+/**
+ * Check if a given object implements the Sample interface.
+ */
+export declare function instanceOfSample(value: object): boolean;
+export declare function SampleFromJSON(json: any): Sample;
+export declare function SampleFromJSONTyped(json: any, ignoreDiscriminator: boolean): Sample;
+export declare function SampleToJSON(value?: Sample | null): any;

package/dist/models/Sample.js

@@ -0,0 +1,53 @@
+"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.SampleToJSON = exports.SampleFromJSONTyped = exports.SampleFromJSON = exports.instanceOfSample = void 0;
+/**
+ * Check if a given object implements the Sample interface.
+ */
+function instanceOfSample(value) {
+    var isInstance = true;
+    isInstance = isInstance && "name" in value;
+    isInstance = isInstance && "metadata" in value;
+    return isInstance;
+}
+exports.instanceOfSample = instanceOfSample;
+function SampleFromJSON(json) {
+    return SampleFromJSONTyped(json, false);
+}
+exports.SampleFromJSON = SampleFromJSON;
+function SampleFromJSONTyped(json, ignoreDiscriminator) {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        'name': json['name'],
+        'metadata': json['metadata'],
+    };
+}
+exports.SampleFromJSONTyped = SampleFromJSONTyped;
+function SampleToJSON(value) {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        'name': value.name,
+        'metadata': value.metadata,
+    };
+}
+exports.SampleToJSON = SampleToJSON;

package/dist/models/ServiceConnection.d.ts

@@ -21,6 +21,12 @@ export interface ServiceConnection {
      * @memberof ServiceConnection
      */
     name: string;
+    /**
+     *
+     * @type {string}
+     * @memberof ServiceConnection
+     */
+    description: string;
 }
 /**
  * Check if a given object implements the ServiceConnection interface.

package/dist/models/ServiceConnection.js

@@ -20,6 +20,7 @@ exports.ServiceConnectionToJSON = exports.ServiceConnectionFromJSONTyped = expor
 function instanceOfServiceConnection(value) {
     var isInstance = true;
     isInstance = isInstance && "name" in value;
+    isInstance = isInstance && "description" in value;
     return isInstance;
 }
 exports.instanceOfServiceConnection = instanceOfServiceConnection;
@@ -33,6 +34,7 @@ function ServiceConnectionFromJSONTyped(json, ignoreDiscriminator) {
     }
     return {
         'name': json['name'],
+        'description': json['description'],
     };
 }
 exports.ServiceConnectionFromJSONTyped = ServiceConnectionFromJSONTyped;
@@ -45,6 +47,7 @@ function ServiceConnectionToJSON(value) {
     }
     return {
         'name': value.name,
+        'description': value.description,
     };
 }
 exports.ServiceConnectionToJSON = ServiceConnectionToJSON;

package/dist/models/index.d.ts

@@ -5,6 +5,7 @@ export * from './CloudAccount';
 export * from './Contact';
 export * from './CreateNotebookInstanceRequest';
 export * from './CreateResponse';
+export * from './CustomPipelineSettings';
 export * from './CustomerType';
 export * from './Dataset';
 export * from './DatasetDetail';
@@ -16,15 +17,18 @@ export * from './LogEntry';
 export * from './NotebookInstance';
 export * from './OpenNotebookInstanceResponse';
 export * from './Process';
+export * from './ProcessDetail';
 export * from './Project';
 export * from './ProjectDetail';
 export * from './ProjectMetrics';
 export * from './ProjectRequest';
 export * from './ProjectRole';
 export * from './ProjectSettings';
+export * from './Reference';
 export * from './ReferenceType';
 export * from './Region';
 export * from './RegisterDatasetRequest';
+export * from './Sample';
 export * from './ServiceConnection';
 export * from './SetUserProjectRoleRequest';
 export * from './StopExecutionResponse';

package/dist/models/index.js

@@ -23,6 +23,7 @@ __exportStar(require("./CloudAccount"), exports);
 __exportStar(require("./Contact"), exports);
 __exportStar(require("./CreateNotebookInstanceRequest"), exports);
 __exportStar(require("./CreateResponse"), exports);
+__exportStar(require("./CustomPipelineSettings"), exports);
 __exportStar(require("./CustomerType"), exports);
 __exportStar(require("./Dataset"), exports);
 __exportStar(require("./DatasetDetail"), exports);
@@ -34,15 +35,18 @@ __exportStar(require("./LogEntry"), exports);
 __exportStar(require("./NotebookInstance"), exports);
 __exportStar(require("./OpenNotebookInstanceResponse"), exports);
 __exportStar(require("./Process"), exports);
+__exportStar(require("./ProcessDetail"), exports);
 __exportStar(require("./Project"), exports);
 __exportStar(require("./ProjectDetail"), exports);
 __exportStar(require("./ProjectMetrics"), exports);
 __exportStar(require("./ProjectRequest"), exports);
 __exportStar(require("./ProjectRole"), exports);
 __exportStar(require("./ProjectSettings"), exports);
+__exportStar(require("./Reference"), exports);
 __exportStar(require("./ReferenceType"), exports);
 __exportStar(require("./Region"), exports);
 __exportStar(require("./RegisterDatasetRequest"), exports);
+__exportStar(require("./Sample"), exports);
 __exportStar(require("./ServiceConnection"), exports);
 __exportStar(require("./SetUserProjectRoleRequest"), exports);
 __exportStar(require("./StopExecutionResponse"), exports);

package/package.json

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

package/src/apis/MetadataApi.ts

@@ -0,0 +1,72 @@
+/* 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 * as runtime from '../runtime';
+import type {
+  Sample,
+} from '../models/index';
+import {
+    SampleFromJSON,
+    SampleToJSON,
+} from '../models/index';
+
+export interface GetProjectSamplesRequest {
+    projectId: string;
+}
+
+/**
+ * 
+ */
+export class MetadataApi extends runtime.BaseAPI {
+
+    /**
+     * Get project samples
+     */
+    async getProjectSamplesRaw(requestParameters: GetProjectSamplesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<Sample>>> {
+        if (requestParameters.projectId === null || requestParameters.projectId === undefined) {
+            throw new runtime.RequiredError('projectId','Required parameter requestParameters.projectId was null or undefined when calling getProjectSamples.');
+        }
+
+        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: `/projects/{projectId}/metadata/samples`.replace(`{${"projectId"}}`, encodeURIComponent(String(requestParameters.projectId))),
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => jsonValue.map(SampleFromJSON));
+    }
+
+    /**
+     * Get project samples
+     */
+    async getProjectSamples(requestParameters: GetProjectSamplesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<Sample>> {
+        const response = await this.getProjectSamplesRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+}