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

package/src/apis/ProcessesApi.ts

@@ -17,30 +17,81 @@ import * as runtime from '../runtime';
 import type {
   FormSchema,
   Process,
+  ProcessDetail,
 } from '../models/index';
 import {
     FormSchemaFromJSON,
     FormSchemaToJSON,
     ProcessFromJSON,
     ProcessToJSON,
+    ProcessDetailFromJSON,
+    ProcessDetailToJSON,
 } from '../models/index';
 
-export interface GetProcessFormRequest {
+export interface GetProcessRequest {
     processId: string;
 }
 
+export interface GetProcessParametersRequest {
+    processId: string;
+}
+
+export interface GetProcessesRequest {
+    includeArchived?: boolean;
+}
+
 /**
  * 
  */
 export class ProcessesApi extends runtime.BaseAPI {
 
+    /**
+     * Retrieves detailed information on a process
+     * Get Process
+     */
+    async getProcessRaw(requestParameters: GetProcessRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ProcessDetail>> {
+        if (requestParameters.processId === null || requestParameters.processId === undefined) {
+            throw new runtime.RequiredError('processId','Required parameter requestParameters.processId was null or undefined when calling getProcess.');
+        }
+
+        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: `/processes/{processId}`.replace(`{${"processId"}}`, encodeURIComponent(String(requestParameters.processId))),
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => ProcessDetailFromJSON(jsonValue));
+    }
+
+    /**
+     * Retrieves detailed information on a process
+     * Get Process
+     */
+    async getProcess(requestParameters: GetProcessRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ProcessDetail> {
+        const response = await this.getProcessRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
     /**
      * Retrieves the input parameters for a process
      * Get Process Parameters
      */
-    async getProcessFormRaw(requestParameters: GetProcessFormRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<FormSchema>> {
+    async getProcessParametersRaw(requestParameters: GetProcessParametersRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<FormSchema>> {
         if (requestParameters.processId === null || requestParameters.processId === undefined) {
-            throw new runtime.RequiredError('processId','Required parameter requestParameters.processId was null or undefined when calling getProcessForm.');
+            throw new runtime.RequiredError('processId','Required parameter requestParameters.processId was null or undefined when calling getProcessParameters.');
         }
 
         const queryParameters: any = {};
@@ -69,8 +120,8 @@ export class ProcessesApi extends runtime.BaseAPI {
      * Retrieves the input parameters for a process
      * Get Process Parameters
      */
-    async getProcessForm(requestParameters: GetProcessFormRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<FormSchema> {
-        const response = await this.getProcessFormRaw(requestParameters, initOverrides);
+    async getProcessParameters(requestParameters: GetProcessParametersRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<FormSchema> {
+        const response = await this.getProcessParametersRaw(requestParameters, initOverrides);
         return await response.value();
     }
 
@@ -78,9 +129,13 @@ export class ProcessesApi extends runtime.BaseAPI {
      * Retrieves a list of available processes
      * List Processes
      */
-    async getProcessesRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<Process>>> {
+    async getProcessesRaw(requestParameters: GetProcessesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<Process>>> {
         const queryParameters: any = {};
 
+        if (requestParameters.includeArchived !== undefined) {
+            queryParameters['includeArchived'] = requestParameters.includeArchived;
+        }
+
         const headerParameters: runtime.HTTPHeaders = {};
 
         if (this.configuration && this.configuration.accessToken) {
@@ -105,8 +160,8 @@ export class ProcessesApi extends runtime.BaseAPI {
      * Retrieves a list of available processes
      * List Processes
      */
-    async getProcesses(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<Process>> {
-        const response = await this.getProcessesRaw(initOverrides);
+    async getProcesses(requestParameters: GetProcessesRequest = {}, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<Process>> {
+        const response = await this.getProcessesRaw(requestParameters, initOverrides);
         return await response.value();
     }
 

package/src/apis/index.ts

@@ -3,6 +3,7 @@
 export * from './BillingApi';
 export * from './DatasetsApi';
 export * from './ExecutionApi';
+export * from './MetadataApi';
 export * from './MetricsApi';
 export * from './NotebooksApi';
 export * from './ProcessesApi';

package/src/models/CustomPipelineSettings.ts

@@ -0,0 +1,105 @@
+/* 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 CustomPipelineSettings
+ */
+export interface CustomPipelineSettings {
+    /**
+     * 
+     * @type {string}
+     * @memberof CustomPipelineSettings
+     */
+    repository?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof CustomPipelineSettings
+     */
+    branch?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof CustomPipelineSettings
+     */
+    folder?: string;
+    /**
+     * 
+     * @type {Date}
+     * @memberof CustomPipelineSettings
+     */
+    lastSync?: Date;
+    /**
+     * 
+     * @type {string}
+     * @memberof CustomPipelineSettings
+     */
+    syncStatus?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof CustomPipelineSettings
+     */
+    commitHash?: string;
+}
+
+/**
+ * Check if a given object implements the CustomPipelineSettings interface.
+ */
+export function instanceOfCustomPipelineSettings(value: object): boolean {
+    let isInstance = true;
+
+    return isInstance;
+}
+
+export function CustomPipelineSettingsFromJSON(json: any): CustomPipelineSettings {
+    return CustomPipelineSettingsFromJSONTyped(json, false);
+}
+
+export function CustomPipelineSettingsFromJSONTyped(json: any, ignoreDiscriminator: boolean): CustomPipelineSettings {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        
+        'repository': !exists(json, 'repository') ? undefined : json['repository'],
+        'branch': !exists(json, 'branch') ? undefined : json['branch'],
+        'folder': !exists(json, 'folder') ? undefined : json['folder'],
+        'lastSync': !exists(json, 'lastSync') ? undefined : (new Date(json['lastSync'])),
+        'syncStatus': !exists(json, 'syncStatus') ? undefined : json['syncStatus'],
+        'commitHash': !exists(json, 'commitHash') ? undefined : json['commitHash'],
+    };
+}
+
+export function CustomPipelineSettingsToJSON(value?: CustomPipelineSettings | null): any {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        
+        'repository': value.repository,
+        'branch': value.branch,
+        'folder': value.folder,
+        'lastSync': value.lastSync === undefined ? undefined : (value.lastSync.toISOString()),
+        'syncStatus': value.syncStatus,
+        'commitHash': value.commitHash,
+    };
+}
+

package/src/models/Process.ts

@@ -31,7 +31,7 @@ export interface Process {
      * @type {string}
      * @memberof Process
      */
-    id?: string;
+    id: string;
     /**
      * 
      * @type {string}
@@ -68,6 +68,24 @@ export interface Process {
      * @memberof Process
      */
     childProcessIds?: Array<string>;
+    /**
+     * IDs of pipelines that can be ran upstream
+     * @type {Array<string>}
+     * @memberof Process
+     */
+    parentProcessIds?: Array<string>;
+    /**
+     * Username of the pipeline creator (blank if Cirro curated)
+     * @type {string}
+     * @memberof Process
+     */
+    owner?: string;
+    /**
+     * Projects that can run this pipeline
+     * @type {Array<string>}
+     * @memberof Process
+     */
+    linkedProjectIds?: Array<string>;
 }
 
 /**
@@ -75,6 +93,7 @@ export interface Process {
  */
 export function instanceOfProcess(value: object): boolean {
     let isInstance = true;
+    isInstance = isInstance && "id" in value;
 
     return isInstance;
 }
@@ -89,13 +108,16 @@ export function ProcessFromJSONTyped(json: any, ignoreDiscriminator: boolean): P
     }
     return {
         
-        'id': !exists(json, 'id') ? undefined : json['id'],
+        'id': json['id'],
         'name': !exists(json, 'name') ? undefined : json['name'],
         'description': !exists(json, 'description') ? undefined : json['description'],
         'executor': !exists(json, 'executor') ? undefined : ExecutorFromJSON(json['executor']),
         'documentationUrl': !exists(json, 'documentationUrl') ? undefined : json['documentationUrl'],
         'fileRequirementsMessage': !exists(json, 'fileRequirementsMessage') ? undefined : json['fileRequirementsMessage'],
         'childProcessIds': !exists(json, 'childProcessIds') ? undefined : json['childProcessIds'],
+        'parentProcessIds': !exists(json, 'parentProcessIds') ? undefined : json['parentProcessIds'],
+        'owner': !exists(json, 'owner') ? undefined : json['owner'],
+        'linkedProjectIds': !exists(json, 'linkedProjectIds') ? undefined : json['linkedProjectIds'],
     };
 }
 
@@ -115,6 +137,9 @@ export function ProcessToJSON(value?: Process | null): any {
         'documentationUrl': value.documentationUrl,
         'fileRequirementsMessage': value.fileRequirementsMessage,
         'childProcessIds': value.childProcessIds,
+        'parentProcessIds': value.parentProcessIds,
+        'owner': value.owner,
+        'linkedProjectIds': value.linkedProjectIds,
     };
 }
 

package/src/models/ProcessDetail.ts

@@ -0,0 +1,177 @@
+/* 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 { CustomPipelineSettings } from './CustomPipelineSettings';
+import {
+    CustomPipelineSettingsFromJSON,
+    CustomPipelineSettingsFromJSONTyped,
+    CustomPipelineSettingsToJSON,
+} from './CustomPipelineSettings';
+import type { Executor } from './Executor';
+import {
+    ExecutorFromJSON,
+    ExecutorFromJSONTyped,
+    ExecutorToJSON,
+} from './Executor';
+
+/**
+ * 
+ * @export
+ * @interface ProcessDetail
+ */
+export interface ProcessDetail {
+    /**
+     * Unique ID of the Process
+     * @type {string}
+     * @memberof ProcessDetail
+     */
+    id: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof ProcessDetail
+     */
+    name: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof ProcessDetail
+     */
+    description: string;
+    /**
+     * 
+     * @type {Executor}
+     * @memberof ProcessDetail
+     */
+    executor: Executor;
+    /**
+     * 
+     * @type {string}
+     * @memberof ProcessDetail
+     */
+    documentationUrl: string;
+    /**
+     * Description of the files to be uploaded (optional)
+     * @type {string}
+     * @memberof ProcessDetail
+     */
+    fileRequirementsMessage?: string;
+    /**
+     * 
+     * @type {Array<string>}
+     * @memberof ProcessDetail
+     */
+    childProcessIds: Array<string>;
+    /**
+     * 
+     * @type {Array<string>}
+     * @memberof ProcessDetail
+     */
+    parentProcessIds: Array<string>;
+    /**
+     * 
+     * @type {string}
+     * @memberof ProcessDetail
+     */
+    owner: string;
+    /**
+     * 
+     * @type {Array<string>}
+     * @memberof ProcessDetail
+     */
+    linkedProjectIds: Array<string>;
+    /**
+     * 
+     * @type {CustomPipelineSettings}
+     * @memberof ProcessDetail
+     */
+    customSettings: CustomPipelineSettings;
+    /**
+     * 
+     * @type {boolean}
+     * @memberof ProcessDetail
+     */
+    isArchived: boolean;
+}
+
+/**
+ * Check if a given object implements the ProcessDetail interface.
+ */
+export function instanceOfProcessDetail(value: object): boolean {
+    let 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;
+}
+
+export function ProcessDetailFromJSON(json: any): ProcessDetail {
+    return ProcessDetailFromJSONTyped(json, false);
+}
+
+export function ProcessDetailFromJSONTyped(json: any, ignoreDiscriminator: boolean): ProcessDetail {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        
+        'id': json['id'],
+        'name': json['name'],
+        'description': json['description'],
+        'executor': ExecutorFromJSON(json['executor']),
+        'documentationUrl': json['documentationUrl'],
+        'fileRequirementsMessage': !exists(json, 'fileRequirementsMessage') ? undefined : json['fileRequirementsMessage'],
+        'childProcessIds': json['childProcessIds'],
+        'parentProcessIds': json['parentProcessIds'],
+        'owner': json['owner'],
+        'linkedProjectIds': json['linkedProjectIds'],
+        'customSettings': CustomPipelineSettingsFromJSON(json['customSettings']),
+        'isArchived': json['isArchived'],
+    };
+}
+
+export function ProcessDetailToJSON(value?: ProcessDetail | null): any {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        
+        'id': value.id,
+        'name': value.name,
+        'description': value.description,
+        'executor': ExecutorToJSON(value.executor),
+        'documentationUrl': value.documentationUrl,
+        'fileRequirementsMessage': value.fileRequirementsMessage,
+        'childProcessIds': value.childProcessIds,
+        'parentProcessIds': value.parentProcessIds,
+        'owner': value.owner,
+        'linkedProjectIds': value.linkedProjectIds,
+        'customSettings': CustomPipelineSettingsToJSON(value.customSettings),
+        'isArchived': value.isArchived,
+    };
+}
+

package/src/models/ProjectMetrics.ts

@@ -26,17 +26,17 @@ 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: { [key: string]: any; };
+    storageMetrics?: { [key: string]: any; };
 }
 
 /**
@@ -45,8 +45,6 @@ export interface ProjectMetrics {
 export function instanceOfProjectMetrics(value: object): boolean {
     let isInstance = true;
     isInstance = isInstance && "projectId" in value;
-    isInstance = isInstance && "costs" in value;
-    isInstance = isInstance && "storageMetrics" in value;
 
     return isInstance;
 }
@@ -62,8 +60,8 @@ export function ProjectMetricsFromJSONTyped(json: any, ignoreDiscriminator: bool
     return {
         
         'projectId': json['projectId'],
-        'costs': json['costs'],
-        'storageMetrics': json['storageMetrics'],
+        'costs': !exists(json, 'costs') ? undefined : json['costs'],
+        'storageMetrics': !exists(json, 'storageMetrics') ? undefined : json['storageMetrics'],
     };
 }
 

package/src/models/ProjectSettings.ts

@@ -92,6 +92,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;
 }
 
 /**
@@ -124,6 +148,10 @@ export function ProjectSettingsFromJSONTyped(json: any, ignoreDiscriminator: boo
         'maxSpotVCPU': !exists(json, 'maxSpotVCPU') ? undefined : json['maxSpotVCPU'],
         'retentionPolicyDays': !exists(json, 'retentionPolicyDays') ? undefined : json['retentionPolicyDays'],
         'serviceConnections': !exists(json, 'serviceConnections') ? undefined : json['serviceConnections'],
+        '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'],
     };
 }
 
@@ -147,6 +175,10 @@ export function ProjectSettingsToJSON(value?: ProjectSettings | null): any {
         'maxSpotVCPU': value.maxSpotVCPU,
         'retentionPolicyDays': value.retentionPolicyDays,
         'serviceConnections': value.serviceConnections,
+        'createVpc': value.createVpc,
+        'vpcId': value.vpcId,
+        'batchSubnets': value.batchSubnets,
+        'kmsArn': value.kmsArn,
     };
 }
 

package/src/models/ReferenceType.ts

@@ -25,6 +25,24 @@ 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; }>;
 }
 
 /**
@@ -33,6 +51,9 @@ export interface ReferenceType {
 export function instanceOfReferenceType(value: object): boolean {
     let isInstance = true;
     isInstance = isInstance && "name" in value;
+    isInstance = isInstance && "description" in value;
+    isInstance = isInstance && "directory" in value;
+    isInstance = isInstance && "validation" in value;
 
     return isInstance;
 }
@@ -48,6 +69,9 @@ export function ReferenceTypeFromJSONTyped(json: any, ignoreDiscriminator: boole
     return {
         
         'name': json['name'],
+        'description': json['description'],
+        'directory': json['directory'],
+        'validation': json['validation'],
     };
 }
 
@@ -61,6 +85,9 @@ export function ReferenceTypeToJSON(value?: ReferenceType | null): any {
     return {
         
         'name': value.name,
+        'description': value.description,
+        'directory': value.directory,
+        'validation': value.validation,
     };
 }