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

package/src/apis/NotebooksApi.ts

@@ -91,7 +91,7 @@ export class NotebooksApi extends runtime.BaseAPI {
             }
         }
         const response = await this.request({
-            path: `/projects/{projectId}/notebooks/instance`.replace(`{${"projectId"}}`, encodeURIComponent(String(requestParameters.projectId))),
+            path: `/projects/{projectId}/notebook-instances`.replace(`{${"projectId"}}`, encodeURIComponent(String(requestParameters.projectId))),
             method: 'POST',
             headers: headerParameters,
             query: queryParameters,
@@ -132,7 +132,7 @@ export class NotebooksApi extends runtime.BaseAPI {
             }
         }
         const response = await this.request({
-            path: `/projects/{projectId}/notebooks/instance/{notebookInstanceId}`.replace(`{${"notebookInstanceId"}}`, encodeURIComponent(String(requestParameters.notebookInstanceId))).replace(`{${"projectId"}}`, encodeURIComponent(String(requestParameters.projectId))),
+            path: `/projects/{projectId}/notebook-instances/{notebookInstanceId}`.replace(`{${"notebookInstanceId"}}`, encodeURIComponent(String(requestParameters.notebookInstanceId))).replace(`{${"projectId"}}`, encodeURIComponent(String(requestParameters.projectId))),
             method: 'DELETE',
             headers: headerParameters,
             query: queryParameters,
@@ -171,7 +171,7 @@ export class NotebooksApi extends runtime.BaseAPI {
             }
         }
         const response = await this.request({
-            path: `/projects/{projectId}/notebooks/instance/{notebookInstanceId}:generate-url`.replace(`{${"notebookInstanceId"}}`, encodeURIComponent(String(requestParameters.notebookInstanceId))).replace(`{${"projectId"}}`, encodeURIComponent(String(requestParameters.projectId))),
+            path: `/projects/{projectId}/notebook-instances/{notebookInstanceId}:generate-url`.replace(`{${"notebookInstanceId"}}`, encodeURIComponent(String(requestParameters.notebookInstanceId))).replace(`{${"projectId"}}`, encodeURIComponent(String(requestParameters.projectId))),
             method: 'GET',
             headers: headerParameters,
             query: queryParameters,
@@ -211,7 +211,7 @@ export class NotebooksApi extends runtime.BaseAPI {
             }
         }
         const response = await this.request({
-            path: `/projects/{projectId}/notebooks/instance/{notebookInstanceId}:status`.replace(`{${"notebookInstanceId"}}`, encodeURIComponent(String(requestParameters.notebookInstanceId))).replace(`{${"projectId"}}`, encodeURIComponent(String(requestParameters.projectId))),
+            path: `/projects/{projectId}/notebook-instances/{notebookInstanceId}:status`.replace(`{${"notebookInstanceId"}}`, encodeURIComponent(String(requestParameters.notebookInstanceId))).replace(`{${"projectId"}}`, encodeURIComponent(String(requestParameters.projectId))),
             method: 'GET',
             headers: headerParameters,
             query: queryParameters,
@@ -251,7 +251,7 @@ export class NotebooksApi extends runtime.BaseAPI {
             }
         }
         const response = await this.request({
-            path: `/projects/{projectId}/notebooks/instance`.replace(`{${"projectId"}}`, encodeURIComponent(String(requestParameters.projectId))),
+            path: `/projects/{projectId}/notebook-instances`.replace(`{${"projectId"}}`, encodeURIComponent(String(requestParameters.projectId))),
             method: 'GET',
             headers: headerParameters,
             query: queryParameters,
@@ -291,7 +291,7 @@ export class NotebooksApi extends runtime.BaseAPI {
             }
         }
         const response = await this.request({
-            path: `/projects/{projectId}/notebooks/instance/{notebookInstanceId}:stop`.replace(`{${"notebookInstanceId"}}`, encodeURIComponent(String(requestParameters.notebookInstanceId))).replace(`{${"projectId"}}`, encodeURIComponent(String(requestParameters.projectId))),
+            path: `/projects/{projectId}/notebook-instances/{notebookInstanceId}:stop`.replace(`{${"notebookInstanceId"}}`, encodeURIComponent(String(requestParameters.notebookInstanceId))).replace(`{${"projectId"}}`, encodeURIComponent(String(requestParameters.projectId))),
             method: 'POST',
             headers: headerParameters,
             query: queryParameters,

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
+     * 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 = {};
@@ -67,20 +118,24 @@ export class ProcessesApi extends runtime.BaseAPI {
 
     /**
      * Retrieves the input parameters for a process
-     * Get Process Parameters
+     * 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();
     }
 
     /**
      * Retrieves a list of available processes
-     * List 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) {
@@ -103,10 +158,10 @@ export class ProcessesApi extends runtime.BaseAPI {
 
     /**
      * Retrieves a list of available processes
-     * List 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/ProjectsApi.ts

@@ -111,7 +111,7 @@ export class ProjectsApi extends runtime.BaseAPI {
 
     /**
      * Get detailed project information
-     * Get Project
+     * Get project
      */
     async getProjectRaw(requestParameters: GetProjectRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ProjectDetail>> {
         if (requestParameters.projectId === null || requestParameters.projectId === undefined) {
@@ -142,7 +142,7 @@ export class ProjectsApi extends runtime.BaseAPI {
 
     /**
      * Get detailed project information
-     * Get Project
+     * Get project
      */
     async getProject(requestParameters: GetProjectRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ProjectDetail> {
         const response = await this.getProjectRaw(requestParameters, initOverrides);
@@ -151,7 +151,7 @@ export class ProjectsApi extends runtime.BaseAPI {
 
     /**
      * Retrieve a list of projects
-     * Get Projects
+     * Get projects
      */
     async getProjectsRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<Project>>> {
         const queryParameters: any = {};
@@ -178,7 +178,7 @@ export class ProjectsApi extends runtime.BaseAPI {
 
     /**
      * Retrieve a list of projects
-     * Get Projects
+     * Get projects
      */
     async getProjects(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<Project>> {
         const response = await this.getProjectsRaw(initOverrides);

package/src/apis/ReferencesApi.ts

@@ -0,0 +1,149 @@
+/* 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 {
+  Reference,
+  ReferenceType,
+} from '../models/index';
+import {
+    ReferenceFromJSON,
+    ReferenceToJSON,
+    ReferenceTypeFromJSON,
+    ReferenceTypeToJSON,
+} from '../models/index';
+
+export interface GetReferencesForProjectRequest {
+    projectId: string;
+}
+
+/**
+ * 
+ */
+export class ReferencesApi extends runtime.BaseAPI {
+
+    /**
+     * List available reference types
+     * Get reference types
+     */
+    async getReferenceTypesRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<ReferenceType>>> {
+        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: `/reference-types`,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => jsonValue.map(ReferenceTypeFromJSON));
+    }
+
+    /**
+     * List available reference types
+     * Get reference types
+     */
+    async getReferenceTypes(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<ReferenceType>> {
+        const response = await this.getReferenceTypesRaw(initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * List available references (available to everyone)
+     * Get global references
+     */
+    async getReferencesRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<Reference>>> {
+        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: `/references`,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => jsonValue.map(ReferenceFromJSON));
+    }
+
+    /**
+     * List available references (available to everyone)
+     * Get global references
+     */
+    async getReferences(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<Reference>> {
+        const response = await this.getReferencesRaw(initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * List available references for a given project
+     * Get project references
+     */
+    async getReferencesForProjectRaw(requestParameters: GetReferencesForProjectRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Reference>> {
+        if (requestParameters.projectId === null || requestParameters.projectId === undefined) {
+            throw new runtime.RequiredError('projectId','Required parameter requestParameters.projectId was null or undefined when calling getReferencesForProject.');
+        }
+
+        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}/references`.replace(`{${"projectId"}}`, encodeURIComponent(String(requestParameters.projectId))),
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => ReferenceFromJSON(jsonValue));
+    }
+
+    /**
+     * List available references for a given project
+     * Get project references
+     */
+    async getReferencesForProject(requestParameters: GetReferencesForProjectRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Reference> {
+        const response = await this.getReferencesForProjectRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+}

package/src/apis/SystemApi.ts

@@ -15,13 +15,10 @@
 
 import * as runtime from '../runtime';
 import type {
-  ReferenceType,
   ServiceConnection,
   SystemInfoResponse,
 } from '../models/index';
 import {
-    ReferenceTypeFromJSON,
-    ReferenceTypeToJSON,
     ServiceConnectionFromJSON,
     ServiceConnectionToJSON,
     SystemInfoResponseFromJSON,
@@ -33,42 +30,6 @@ import {
  */
 export class SystemApi extends runtime.BaseAPI {
 
-    /**
-     * List available reference types
-     * Get reference types
-     */
-    async getReferenceTypesRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<ReferenceType>>> {
-        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: `/reference-types`,
-            method: 'GET',
-            headers: headerParameters,
-            query: queryParameters,
-        }, initOverrides);
-
-        return new runtime.JSONApiResponse(response, (jsonValue) => jsonValue.map(ReferenceTypeFromJSON));
-    }
-
-    /**
-     * List available reference types
-     * Get reference types
-     */
-    async getReferenceTypes(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<ReferenceType>> {
-        const response = await this.getReferenceTypesRaw(initOverrides);
-        return await response.value();
-    }
-
     /**
      * List available service connections
      * Get service connections

package/src/apis/index.ts

@@ -3,9 +3,11 @@
 export * from './BillingApi';
 export * from './DatasetsApi';
 export * from './ExecutionApi';
+export * from './MetadataApi';
 export * from './MetricsApi';
 export * from './NotebooksApi';
 export * from './ProcessesApi';
 export * from './ProjectsApi';
+export * from './ReferencesApi';
 export * from './SystemApi';
 export * from './UsersApi';

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,
     };
 }