@cirrobio/api-client 0.0.29-alpha → 0.0.31-alpha

package/.openapi-generator/FILES

@@ -33,9 +33,10 @@ src/models/DashboardRequest.ts
 src/models/Dataset.ts
 src/models/DatasetAssetsManifest.ts
 src/models/DatasetDetail.ts
-src/models/DatasetFile.ts
 src/models/DatasetViz.ts
+src/models/ErrorMessage.ts
 src/models/Executor.ts
+src/models/FileEntry.ts
 src/models/FileNamePattern.ts
 src/models/FileRequirements.ts
 src/models/FormSchema.ts
@@ -52,9 +53,9 @@ src/models/OpenNotebookInstanceResponse.ts
 src/models/PaginatedResponseDatasetListDto.ts
 src/models/PaginatedResponseSampleDto.ts
 src/models/PipelineCode.ts
+src/models/PortalErrorResponse.ts
 src/models/Process.ts
 src/models/ProcessDetail.ts
-src/models/ProcessDetailAllOfPipelineCode.ts
 src/models/Project.ts
 src/models/ProjectDetail.ts
 src/models/ProjectMetrics.ts
@@ -74,6 +75,7 @@ src/models/SetUserProjectRoleRequest.ts
 src/models/SftpCredentials.ts
 src/models/Status.ts
 src/models/StopExecutionResponse.ts
+src/models/SyncStatus.ts
 src/models/SystemInfoResponse.ts
 src/models/Tag.ts
 src/models/Task.ts

package/README.md

@@ -36,7 +36,7 @@ navigate to the folder of your consuming project and run one of the following co
 _published:_
 
 ```
-npm install @cirrobio/api-client@0.0.29-alpha --save
+npm install @cirrobio/api-client@0.0.31-alpha --save
 ```
 
 _unPublished (not recommended):_

package/dist/apis/ReferencesApi.d.ts

@@ -42,10 +42,10 @@ export declare class ReferencesApi extends runtime.BaseAPI {
      * List available references for a given project
      * Get project references
      */
-    getReferencesForProjectRaw(requestParameters: GetReferencesForProjectRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Reference>>;
+    getReferencesForProjectRaw(requestParameters: GetReferencesForProjectRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<Reference>>>;
     /**
      * List available references for a given project
      * Get project references
      */
-    getReferencesForProject(requestParameters: GetReferencesForProjectRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Reference>;
+    getReferencesForProject(requestParameters: GetReferencesForProjectRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<Reference>>;
 }

package/dist/apis/ReferencesApi.js

@@ -211,7 +211,7 @@ var ReferencesApi = /** @class */ (function (_super) {
                         }, initOverrides)];
                     case 3:
                         response = _a.sent();
-                        return [2 /*return*/, new runtime.JSONApiResponse(response, function (jsonValue) { return (0, index_1.ReferenceFromJSON)(jsonValue); })];
+                        return [2 /*return*/, new runtime.JSONApiResponse(response, function (jsonValue) { return jsonValue.map(index_1.ReferenceFromJSON); })];
                 }
             });
         });

package/dist/models/CustomPipelineSettings.d.ts

@@ -9,8 +9,9 @@
  * https://openapi-generator.tech
  * Do not edit the class manually.
  */
+import type { SyncStatus } from './SyncStatus';
 /**
- *
+ * Used to describe the location of the process definition dependencies
  * @export
  * @interface CustomPipelineSettings
  */
@@ -34,19 +35,19 @@ export interface CustomPipelineSettings {
      */
     folder?: string;
     /**
-     *
+     * Time of last sync
      * @type {Date}
      * @memberof CustomPipelineSettings
      */
     lastSync?: Date | null;
     /**
      *
-     * @type {string}
+     * @type {SyncStatus}
      * @memberof CustomPipelineSettings
      */
-    syncStatus?: string | null;
+    syncStatus?: SyncStatus | null;
     /**
-     *
+     * Commit hash of the last successful sync
      * @type {string}
      * @memberof CustomPipelineSettings
      */

package/dist/models/CustomPipelineSettings.js

@@ -15,6 +15,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.CustomPipelineSettingsToJSON = exports.CustomPipelineSettingsFromJSONTyped = exports.CustomPipelineSettingsFromJSON = exports.instanceOfCustomPipelineSettings = void 0;
 var runtime_1 = require("../runtime");
+var SyncStatus_1 = require("./SyncStatus");
 /**
  * Check if a given object implements the CustomPipelineSettings interface.
  */
@@ -37,7 +38,7 @@ function CustomPipelineSettingsFromJSONTyped(json, ignoreDiscriminator) {
         'branch': !(0, runtime_1.exists)(json, 'branch') ? undefined : json['branch'],
         'folder': !(0, runtime_1.exists)(json, 'folder') ? undefined : json['folder'],
         'lastSync': !(0, runtime_1.exists)(json, 'lastSync') ? undefined : (json['lastSync'] === null ? null : new Date(json['lastSync'])),
-        'syncStatus': !(0, runtime_1.exists)(json, 'syncStatus') ? undefined : json['syncStatus'],
+        'syncStatus': !(0, runtime_1.exists)(json, 'syncStatus') ? undefined : (0, SyncStatus_1.SyncStatusFromJSON)(json['syncStatus']),
         'commitHash': !(0, runtime_1.exists)(json, 'commitHash') ? undefined : json['commitHash'],
     };
 }
@@ -54,7 +55,7 @@ function CustomPipelineSettingsToJSON(value) {
         'branch': value.branch,
         'folder': value.folder,
         'lastSync': value.lastSync === undefined ? undefined : (value.lastSync === null ? null : value.lastSync.toISOString()),
-        'syncStatus': value.syncStatus,
+        'syncStatus': (0, SyncStatus_1.SyncStatusToJSON)(value.syncStatus),
         'commitHash': value.commitHash,
     };
 }

package/dist/models/DatasetAssetsManifest.d.ts

@@ -9,8 +9,8 @@
  * https://openapi-generator.tech
  * Do not edit the class manually.
  */
-import type { DatasetFile } from './DatasetFile';
 import type { DatasetViz } from './DatasetViz';
+import type { FileEntry } from './FileEntry';
 /**
  *
  * @export
@@ -25,10 +25,10 @@ export interface DatasetAssetsManifest {
     domain?: string;
     /**
      * List of files in the dataset, including metadata
-     * @type {Array<DatasetFile>}
+     * @type {Array<FileEntry>}
      * @memberof DatasetAssetsManifest
      */
-    files?: Array<DatasetFile>;
+    files?: Array<FileEntry>;
     /**
      * List of viz to render for the dataset
      * @type {Array<DatasetViz>}

package/dist/models/DatasetAssetsManifest.js

@@ -15,8 +15,8 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.DatasetAssetsManifestToJSON = exports.DatasetAssetsManifestFromJSONTyped = exports.DatasetAssetsManifestFromJSON = exports.instanceOfDatasetAssetsManifest = void 0;
 var runtime_1 = require("../runtime");
-var DatasetFile_1 = require("./DatasetFile");
 var DatasetViz_1 = require("./DatasetViz");
+var FileEntry_1 = require("./FileEntry");
 /**
  * Check if a given object implements the DatasetAssetsManifest interface.
  */
@@ -35,7 +35,7 @@ function DatasetAssetsManifestFromJSONTyped(json, ignoreDiscriminator) {
     }
     return {
         'domain': !(0, runtime_1.exists)(json, 'domain') ? undefined : json['domain'],
-        'files': !(0, runtime_1.exists)(json, 'files') ? undefined : (json['files'].map(DatasetFile_1.DatasetFileFromJSON)),
+        'files': !(0, runtime_1.exists)(json, 'files') ? undefined : (json['files'].map(FileEntry_1.FileEntryFromJSON)),
         'viz': !(0, runtime_1.exists)(json, 'viz') ? undefined : (json['viz'].map(DatasetViz_1.DatasetVizFromJSON)),
     };
 }
@@ -49,7 +49,7 @@ function DatasetAssetsManifestToJSON(value) {
     }
     return {
         'domain': value.domain,
-        'files': value.files === undefined ? undefined : (value.files.map(DatasetFile_1.DatasetFileToJSON)),
+        'files': value.files === undefined ? undefined : (value.files.map(FileEntry_1.FileEntryToJSON)),
         'viz': value.viz === undefined ? undefined : (value.viz.map(DatasetViz_1.DatasetVizToJSON)),
     };
 }

package/dist/models/ErrorMessage.d.ts

@@ -0,0 +1,31 @@
+/**
+ * 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 ErrorMessage
+ */
+export interface ErrorMessage {
+    /**
+     *
+     * @type {string}
+     * @memberof ErrorMessage
+     */
+    message: string;
+}
+/**
+ * Check if a given object implements the ErrorMessage interface.
+ */
+export declare function instanceOfErrorMessage(value: object): boolean;
+export declare function ErrorMessageFromJSON(json: any): ErrorMessage;
+export declare function ErrorMessageFromJSONTyped(json: any, ignoreDiscriminator: boolean): ErrorMessage;
+export declare function ErrorMessageToJSON(value?: ErrorMessage | null): any;

package/dist/models/ErrorMessage.js

@@ -0,0 +1,50 @@
+"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.ErrorMessageToJSON = exports.ErrorMessageFromJSONTyped = exports.ErrorMessageFromJSON = exports.instanceOfErrorMessage = void 0;
+/**
+ * Check if a given object implements the ErrorMessage interface.
+ */
+function instanceOfErrorMessage(value) {
+    var isInstance = true;
+    isInstance = isInstance && "message" in value;
+    return isInstance;
+}
+exports.instanceOfErrorMessage = instanceOfErrorMessage;
+function ErrorMessageFromJSON(json) {
+    return ErrorMessageFromJSONTyped(json, false);
+}
+exports.ErrorMessageFromJSON = ErrorMessageFromJSON;
+function ErrorMessageFromJSONTyped(json, ignoreDiscriminator) {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        'message': json['message'],
+    };
+}
+exports.ErrorMessageFromJSONTyped = ErrorMessageFromJSONTyped;
+function ErrorMessageToJSON(value) {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        'message': value.message,
+    };
+}
+exports.ErrorMessageToJSON = ErrorMessageToJSON;

package/dist/models/FileEntry.d.ts

@@ -0,0 +1,45 @@
+/**
+ * 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 FileEntry
+ */
+export interface FileEntry {
+    /**
+     * Relative path to file
+     * @type {string}
+     * @memberof FileEntry
+     */
+    path?: string;
+    /**
+     * File size (in bytes)
+     * @type {number}
+     * @memberof FileEntry
+     */
+    size?: number;
+    /**
+     * Metadata associated with the file
+     * @type {{ [key: string]: string; }}
+     * @memberof FileEntry
+     */
+    metadata?: {
+        [key: string]: string;
+    };
+}
+/**
+ * Check if a given object implements the FileEntry interface.
+ */
+export declare function instanceOfFileEntry(value: object): boolean;
+export declare function FileEntryFromJSON(json: any): FileEntry;
+export declare function FileEntryFromJSONTyped(json: any, ignoreDiscriminator: boolean): FileEntry;
+export declare function FileEntryToJSON(value?: FileEntry | null): any;

package/dist/models/FileEntry.js

@@ -0,0 +1,54 @@
+"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.FileEntryToJSON = exports.FileEntryFromJSONTyped = exports.FileEntryFromJSON = exports.instanceOfFileEntry = void 0;
+var runtime_1 = require("../runtime");
+/**
+ * Check if a given object implements the FileEntry interface.
+ */
+function instanceOfFileEntry(value) {
+    var isInstance = true;
+    return isInstance;
+}
+exports.instanceOfFileEntry = instanceOfFileEntry;
+function FileEntryFromJSON(json) {
+    return FileEntryFromJSONTyped(json, false);
+}
+exports.FileEntryFromJSON = FileEntryFromJSON;
+function FileEntryFromJSONTyped(json, ignoreDiscriminator) {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        'path': !(0, runtime_1.exists)(json, 'path') ? undefined : json['path'],
+        'size': !(0, runtime_1.exists)(json, 'size') ? undefined : json['size'],
+        'metadata': !(0, runtime_1.exists)(json, 'metadata') ? undefined : json['metadata'],
+    };
+}
+exports.FileEntryFromJSONTyped = FileEntryFromJSONTyped;
+function FileEntryToJSON(value) {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        'path': value.path,
+        'size': value.size,
+        'metadata': value.metadata,
+    };
+}
+exports.FileEntryToJSON = FileEntryToJSON;

package/dist/models/PipelineCode.d.ts

@@ -11,7 +11,7 @@
  */
 import type { RepositoryType } from './RepositoryType';
 /**
- * Used to describe the pipeline analysis code
+ * Used to describe the pipeline analysis code, not required for ingest processes
  * @export
  * @interface PipelineCode
  */
@@ -27,7 +27,7 @@ export interface PipelineCode {
      * @type {string}
      * @memberof PipelineCode
      */
-    version?: string;
+    version: string;
     /**
      *
      * @type {RepositoryType}
@@ -39,7 +39,7 @@ export interface PipelineCode {
      * @type {string}
      * @memberof PipelineCode
      */
-    entryPoint?: string;
+    entryPoint: string;
 }
 /**
  * Check if a given object implements the PipelineCode interface.

package/dist/models/PipelineCode.js

@@ -22,6 +22,8 @@ var RepositoryType_1 = require("./RepositoryType");
 function instanceOfPipelineCode(value) {
     var isInstance = true;
     isInstance = isInstance && "repositoryPath" in value;
+    isInstance = isInstance && "version" in value;
+    isInstance = isInstance && "entryPoint" in value;
     return isInstance;
 }
 exports.instanceOfPipelineCode = instanceOfPipelineCode;
@@ -35,9 +37,9 @@ function PipelineCodeFromJSONTyped(json, ignoreDiscriminator) {
     }
     return {
         'repositoryPath': json['repositoryPath'],
-        'version': !(0, runtime_1.exists)(json, 'version') ? undefined : json['version'],
+        'version': json['version'],
         'repositoryType': !(0, runtime_1.exists)(json, 'repositoryType') ? undefined : (0, RepositoryType_1.RepositoryTypeFromJSON)(json['repositoryType']),
-        'entryPoint': !(0, runtime_1.exists)(json, 'entryPoint') ? undefined : json['entryPoint'],
+        'entryPoint': json['entryPoint'],
     };
 }
 exports.PipelineCodeFromJSONTyped = PipelineCodeFromJSONTyped;

package/dist/models/PortalErrorResponse.d.ts

@@ -0,0 +1,50 @@
+/**
+ * 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 type { ErrorMessage } from './ErrorMessage';
+/**
+ *
+ * @export
+ * @interface PortalErrorResponse
+ */
+export interface PortalErrorResponse {
+    /**
+     *
+     * @type {number}
+     * @memberof PortalErrorResponse
+     */
+    statusCode: number;
+    /**
+     *
+     * @type {string}
+     * @memberof PortalErrorResponse
+     */
+    errorCode: string;
+    /**
+     *
+     * @type {string}
+     * @memberof PortalErrorResponse
+     */
+    errorDetail: string;
+    /**
+     *
+     * @type {Array<ErrorMessage>}
+     * @memberof PortalErrorResponse
+     */
+    errors: Array<ErrorMessage>;
+}
+/**
+ * Check if a given object implements the PortalErrorResponse interface.
+ */
+export declare function instanceOfPortalErrorResponse(value: object): boolean;
+export declare function PortalErrorResponseFromJSON(json: any): PortalErrorResponse;
+export declare function PortalErrorResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): PortalErrorResponse;
+export declare function PortalErrorResponseToJSON(value?: PortalErrorResponse | null): any;

package/dist/models/PortalErrorResponse.js

@@ -0,0 +1,60 @@
+"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.PortalErrorResponseToJSON = exports.PortalErrorResponseFromJSONTyped = exports.PortalErrorResponseFromJSON = exports.instanceOfPortalErrorResponse = void 0;
+var ErrorMessage_1 = require("./ErrorMessage");
+/**
+ * Check if a given object implements the PortalErrorResponse interface.
+ */
+function instanceOfPortalErrorResponse(value) {
+    var isInstance = true;
+    isInstance = isInstance && "statusCode" in value;
+    isInstance = isInstance && "errorCode" in value;
+    isInstance = isInstance && "errorDetail" in value;
+    isInstance = isInstance && "errors" in value;
+    return isInstance;
+}
+exports.instanceOfPortalErrorResponse = instanceOfPortalErrorResponse;
+function PortalErrorResponseFromJSON(json) {
+    return PortalErrorResponseFromJSONTyped(json, false);
+}
+exports.PortalErrorResponseFromJSON = PortalErrorResponseFromJSON;
+function PortalErrorResponseFromJSONTyped(json, ignoreDiscriminator) {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        'statusCode': json['statusCode'],
+        'errorCode': json['errorCode'],
+        'errorDetail': json['errorDetail'],
+        'errors': (json['errors'].map(ErrorMessage_1.ErrorMessageFromJSON)),
+    };
+}
+exports.PortalErrorResponseFromJSONTyped = PortalErrorResponseFromJSONTyped;
+function PortalErrorResponseToJSON(value) {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        'statusCode': value.statusCode,
+        'errorCode': value.errorCode,
+        'errorDetail': value.errorDetail,
+        'errors': (value.errors.map(ErrorMessage_1.ErrorMessageToJSON)),
+    };
+}
+exports.PortalErrorResponseToJSON = PortalErrorResponseToJSON;

package/dist/models/Process.d.ts

@@ -33,7 +33,7 @@ export interface Process {
      * @type {string}
      * @memberof Process
      */
-    description: string;
+    description?: string;
     /**
      *
      * @type {Executor}
@@ -51,7 +51,7 @@ export interface Process {
      * @type {string}
      * @memberof Process
      */
-    fileRequirementsMessage?: string | null;
+    fileRequirementsMessage?: string;
     /**
      * IDs of pipelines that can be ran downstream
      * @type {Array<string>}
@@ -59,7 +59,7 @@ export interface Process {
      */
     childProcessIds?: Array<string>;
     /**
-     * IDs of pipelines that can be ran upstream
+     * IDs of pipelines that can run this pipeline
      * @type {Array<string>}
      * @memberof Process
      */

package/dist/models/Process.js

@@ -22,7 +22,6 @@ var Executor_1 = require("./Executor");
 function instanceOfProcess(value) {
     var isInstance = true;
     isInstance = isInstance && "id" in value;
-    isInstance = isInstance && "description" in value;
     return isInstance;
 }
 exports.instanceOfProcess = instanceOfProcess;
@@ -37,7 +36,7 @@ function ProcessFromJSONTyped(json, ignoreDiscriminator) {
     return {
         'id': json['id'],
         'name': !(0, runtime_1.exists)(json, 'name') ? undefined : json['name'],
-        'description': json['description'],
+        'description': !(0, runtime_1.exists)(json, 'description') ? undefined : json['description'],
         'executor': !(0, runtime_1.exists)(json, 'executor') ? undefined : (0, Executor_1.ExecutorFromJSON)(json['executor']),
         'documentationUrl': !(0, runtime_1.exists)(json, 'documentationUrl') ? undefined : json['documentationUrl'],
         'fileRequirementsMessage': !(0, runtime_1.exists)(json, 'fileRequirementsMessage') ? undefined : json['fileRequirementsMessage'],

package/dist/models/ProcessDetail.d.ts

@@ -11,7 +11,7 @@
  */
 import type { CustomPipelineSettings } from './CustomPipelineSettings';
 import type { Executor } from './Executor';
-import type { ProcessDetailAllOfPipelineCode } from './ProcessDetailAllOfPipelineCode';
+import type { PipelineCode } from './PipelineCode';
 /**
  *
  * @export
@@ -47,13 +47,13 @@ export interface ProcessDetail {
      * @type {string}
      * @memberof ProcessDetail
      */
-    documentationUrl: string;
+    documentationUrl?: string | null;
     /**
      *
      * @type {string}
      * @memberof ProcessDetail
      */
-    fileRequirementsMessage: string;
+    fileRequirementsMessage?: string | null;
     /**
      *
      * @type {Array<string>}
@@ -71,7 +71,7 @@ export interface ProcessDetail {
      * @type {string}
      * @memberof ProcessDetail
      */
-    owner: string;
+    owner?: string;
     /**
      *
      * @type {Array<string>}
@@ -80,10 +80,10 @@ export interface ProcessDetail {
     linkedProjectIds: Array<string>;
     /**
      *
-     * @type {ProcessDetailAllOfPipelineCode}
+     * @type {PipelineCode}
      * @memberof ProcessDetail
      */
-    pipelineCode: ProcessDetailAllOfPipelineCode;
+    pipelineCode?: PipelineCode | null;
     /**
      *
      * @type {CustomPipelineSettings}
@@ -91,11 +91,11 @@ export interface ProcessDetail {
      */
     customSettings: CustomPipelineSettings;
     /**
-     *
+     * Whether the process is marked for removal
      * @type {boolean}
      * @memberof ProcessDetail
      */
-    isArchived: boolean;
+    isArchived?: boolean;
 }
 /**
  * Check if a given object implements the ProcessDetail interface.