@cirrobio/api-client 0.0.25-alpha → 0.0.27-alpha

package/.openapi-generator/FILES

@@ -17,6 +17,7 @@ src/apis/SystemApi.ts
 src/apis/UsersApi.ts
 src/apis/index.ts
 src/index.ts
+src/models/AllowedDataType.ts
 src/models/BillingAccount.ts
 src/models/BillingAccountRequest.ts
 src/models/BillingMethod.ts
@@ -35,6 +36,8 @@ src/models/DatasetDetail.ts
 src/models/DatasetFile.ts
 src/models/DatasetViz.ts
 src/models/Executor.ts
+src/models/FileNamePattern.ts
+src/models/FileRequirements.ts
 src/models/FormSchema.ts
 src/models/GenerateSftpCredentialsRequest.ts
 src/models/GetExecutionLogsResponse.ts
@@ -76,6 +79,7 @@ src/models/UpdateUserRequest.ts
 src/models/UploadDatasetCreateResponse.ts
 src/models/UploadDatasetRequest.ts
 src/models/User.ts
+src/models/ValidateFileRequirementsRequest.ts
 src/models/index.ts
 src/runtime.ts
 tsconfig.json

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.25-alpha --save
+npm install @cirrobio/api-client@0.0.27-alpha --save
 ```
 
 _unPublished (not recommended):_

package/dist/apis/ProcessesApi.d.ts

@@ -10,7 +10,7 @@
  * Do not edit the class manually.
  */
 import * as runtime from '../runtime';
-import type { FormSchema, Process, ProcessDetail } from '../models/index';
+import type { FileRequirements, FormSchema, Process, ProcessDetail, ValidateFileRequirementsRequest } from '../models/index';
 export interface GetProcessRequest {
     processId: string;
 }
@@ -20,6 +20,10 @@ export interface GetProcessParametersRequest {
 export interface GetProcessesRequest {
     includeArchived?: boolean;
 }
+export interface ValidateFileRequirementsOperationRequest {
+    processId: string;
+    validateFileRequirementsRequest: ValidateFileRequirementsRequest;
+}
 /**
  *
  */
@@ -54,4 +58,14 @@ export declare class ProcessesApi extends runtime.BaseAPI {
      * List processes
      */
     getProcesses(requestParameters?: GetProcessesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<Process>>;
+    /**
+     * Checks the input file names with the expected files for a data type (ingest processes only)
+     * Validate file requirements
+     */
+    validateFileRequirementsRaw(requestParameters: ValidateFileRequirementsOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<FileRequirements>>;
+    /**
+     * Checks the input file names with the expected files for a data type (ingest processes only)
+     * Validate file requirements
+     */
+    validateFileRequirements(requestParameters: ValidateFileRequirementsOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<FileRequirements>;
 }

package/dist/apis/ProcessesApi.js

@@ -241,6 +241,66 @@ var ProcessesApi = /** @class */ (function (_super) {
             });
         });
     };
+    /**
+     * Checks the input file names with the expected files for a data type (ingest processes only)
+     * Validate file requirements
+     */
+    ProcessesApi.prototype.validateFileRequirementsRaw = function (requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function () {
+            var queryParameters, headerParameters, token, tokenString, response;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0:
+                        if (requestParameters.processId === null || requestParameters.processId === undefined) {
+                            throw new runtime.RequiredError('processId', 'Required parameter requestParameters.processId was null or undefined when calling validateFileRequirements.');
+                        }
+                        if (requestParameters.validateFileRequirementsRequest === null || requestParameters.validateFileRequirementsRequest === undefined) {
+                            throw new runtime.RequiredError('validateFileRequirementsRequest', 'Required parameter requestParameters.validateFileRequirementsRequest was null or undefined when calling validateFileRequirements.');
+                        }
+                        queryParameters = {};
+                        headerParameters = {};
+                        headerParameters['Content-Type'] = 'application/json';
+                        if (!(this.configuration && this.configuration.accessToken)) return [3 /*break*/, 2];
+                        token = this.configuration.accessToken;
+                        return [4 /*yield*/, token("accessToken", [])];
+                    case 1:
+                        tokenString = _a.sent();
+                        if (tokenString) {
+                            headerParameters["Authorization"] = "Bearer ".concat(tokenString);
+                        }
+                        _a.label = 2;
+                    case 2: return [4 /*yield*/, this.request({
+                            path: "/processes/{processId}/validate-files".replace("{".concat("processId", "}"), encodeURIComponent(String(requestParameters.processId))),
+                            method: 'POST',
+                            headers: headerParameters,
+                            query: queryParameters,
+                            body: (0, index_1.ValidateFileRequirementsRequestToJSON)(requestParameters.validateFileRequirementsRequest),
+                        }, initOverrides)];
+                    case 3:
+                        response = _a.sent();
+                        return [2 /*return*/, new runtime.JSONApiResponse(response, function (jsonValue) { return (0, index_1.FileRequirementsFromJSON)(jsonValue); })];
+                }
+            });
+        });
+    };
+    /**
+     * Checks the input file names with the expected files for a data type (ingest processes only)
+     * Validate file requirements
+     */
+    ProcessesApi.prototype.validateFileRequirements = function (requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function () {
+            var response;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0: return [4 /*yield*/, this.validateFileRequirementsRaw(requestParameters, initOverrides)];
+                    case 1:
+                        response = _a.sent();
+                        return [4 /*yield*/, response.value()];
+                    case 2: return [2 /*return*/, _a.sent()];
+                }
+            });
+        });
+    };
     return ProcessesApi;
 }(runtime.BaseAPI));
 exports.ProcessesApi = ProcessesApi;

package/dist/models/AllowedDataType.d.ts

@@ -0,0 +1,44 @@
+/**
+ * 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 { FileNamePattern } from './FileNamePattern';
+/**
+ *
+ * @export
+ * @interface AllowedDataType
+ */
+export interface AllowedDataType {
+    /**
+     *
+     * @type {string}
+     * @memberof AllowedDataType
+     */
+    description: string;
+    /**
+     *
+     * @type {string}
+     * @memberof AllowedDataType
+     */
+    errorMsg: string;
+    /**
+     *
+     * @type {Array<FileNamePattern>}
+     * @memberof AllowedDataType
+     */
+    allowedPatterns: Array<FileNamePattern>;
+}
+/**
+ * Check if a given object implements the AllowedDataType interface.
+ */
+export declare function instanceOfAllowedDataType(value: object): boolean;
+export declare function AllowedDataTypeFromJSON(json: any): AllowedDataType;
+export declare function AllowedDataTypeFromJSONTyped(json: any, ignoreDiscriminator: boolean): AllowedDataType;
+export declare function AllowedDataTypeToJSON(value?: AllowedDataType | null): any;

package/dist/models/AllowedDataType.js

@@ -0,0 +1,57 @@
+"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.AllowedDataTypeToJSON = exports.AllowedDataTypeFromJSONTyped = exports.AllowedDataTypeFromJSON = exports.instanceOfAllowedDataType = void 0;
+var FileNamePattern_1 = require("./FileNamePattern");
+/**
+ * Check if a given object implements the AllowedDataType interface.
+ */
+function instanceOfAllowedDataType(value) {
+    var isInstance = true;
+    isInstance = isInstance && "description" in value;
+    isInstance = isInstance && "errorMsg" in value;
+    isInstance = isInstance && "allowedPatterns" in value;
+    return isInstance;
+}
+exports.instanceOfAllowedDataType = instanceOfAllowedDataType;
+function AllowedDataTypeFromJSON(json) {
+    return AllowedDataTypeFromJSONTyped(json, false);
+}
+exports.AllowedDataTypeFromJSON = AllowedDataTypeFromJSON;
+function AllowedDataTypeFromJSONTyped(json, ignoreDiscriminator) {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        'description': json['description'],
+        'errorMsg': json['errorMsg'],
+        'allowedPatterns': (json['allowedPatterns'].map(FileNamePattern_1.FileNamePatternFromJSON)),
+    };
+}
+exports.AllowedDataTypeFromJSONTyped = AllowedDataTypeFromJSONTyped;
+function AllowedDataTypeToJSON(value) {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        'description': value.description,
+        'errorMsg': value.errorMsg,
+        'allowedPatterns': (value.allowedPatterns.map(FileNamePattern_1.FileNamePatternToJSON)),
+    };
+}
+exports.AllowedDataTypeToJSON = AllowedDataTypeToJSON;

package/dist/models/FileNamePattern.d.ts

@@ -0,0 +1,43 @@
+/**
+ * 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 FileNamePattern
+ */
+export interface FileNamePattern {
+    /**
+     *
+     * @type {string}
+     * @memberof FileNamePattern
+     */
+    exampleName: string;
+    /**
+     *
+     * @type {string}
+     * @memberof FileNamePattern
+     */
+    description: string;
+    /**
+     *
+     * @type {string}
+     * @memberof FileNamePattern
+     */
+    sampleMatchingPattern: string;
+}
+/**
+ * Check if a given object implements the FileNamePattern interface.
+ */
+export declare function instanceOfFileNamePattern(value: object): boolean;
+export declare function FileNamePatternFromJSON(json: any): FileNamePattern;
+export declare function FileNamePatternFromJSONTyped(json: any, ignoreDiscriminator: boolean): FileNamePattern;
+export declare function FileNamePatternToJSON(value?: FileNamePattern | null): any;

package/dist/models/FileNamePattern.js

@@ -0,0 +1,56 @@
+"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.FileNamePatternToJSON = exports.FileNamePatternFromJSONTyped = exports.FileNamePatternFromJSON = exports.instanceOfFileNamePattern = void 0;
+/**
+ * Check if a given object implements the FileNamePattern interface.
+ */
+function instanceOfFileNamePattern(value) {
+    var isInstance = true;
+    isInstance = isInstance && "exampleName" in value;
+    isInstance = isInstance && "description" in value;
+    isInstance = isInstance && "sampleMatchingPattern" in value;
+    return isInstance;
+}
+exports.instanceOfFileNamePattern = instanceOfFileNamePattern;
+function FileNamePatternFromJSON(json) {
+    return FileNamePatternFromJSONTyped(json, false);
+}
+exports.FileNamePatternFromJSON = FileNamePatternFromJSON;
+function FileNamePatternFromJSONTyped(json, ignoreDiscriminator) {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        'exampleName': json['exampleName'],
+        'description': json['description'],
+        'sampleMatchingPattern': json['sampleMatchingPattern'],
+    };
+}
+exports.FileNamePatternFromJSONTyped = FileNamePatternFromJSONTyped;
+function FileNamePatternToJSON(value) {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        'exampleName': value.exampleName,
+        'description': value.description,
+        'sampleMatchingPattern': value.sampleMatchingPattern,
+    };
+}
+exports.FileNamePatternToJSON = FileNamePatternToJSON;

package/dist/models/FileRequirements.d.ts

@@ -0,0 +1,44 @@
+/**
+ * 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 { AllowedDataType } from './AllowedDataType';
+/**
+ *
+ * @export
+ * @interface FileRequirements
+ */
+export interface FileRequirements {
+    /**
+     *
+     * @type {Array<string>}
+     * @memberof FileRequirements
+     */
+    files: Array<string>;
+    /**
+     *
+     * @type {string}
+     * @memberof FileRequirements
+     */
+    errorMsg: string;
+    /**
+     *
+     * @type {Array<AllowedDataType>}
+     * @memberof FileRequirements
+     */
+    allowedDataTypes: Array<AllowedDataType>;
+}
+/**
+ * Check if a given object implements the FileRequirements interface.
+ */
+export declare function instanceOfFileRequirements(value: object): boolean;
+export declare function FileRequirementsFromJSON(json: any): FileRequirements;
+export declare function FileRequirementsFromJSONTyped(json: any, ignoreDiscriminator: boolean): FileRequirements;
+export declare function FileRequirementsToJSON(value?: FileRequirements | null): any;

package/dist/models/FileRequirements.js

@@ -0,0 +1,57 @@
+"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.FileRequirementsToJSON = exports.FileRequirementsFromJSONTyped = exports.FileRequirementsFromJSON = exports.instanceOfFileRequirements = void 0;
+var AllowedDataType_1 = require("./AllowedDataType");
+/**
+ * Check if a given object implements the FileRequirements interface.
+ */
+function instanceOfFileRequirements(value) {
+    var isInstance = true;
+    isInstance = isInstance && "files" in value;
+    isInstance = isInstance && "errorMsg" in value;
+    isInstance = isInstance && "allowedDataTypes" in value;
+    return isInstance;
+}
+exports.instanceOfFileRequirements = instanceOfFileRequirements;
+function FileRequirementsFromJSON(json) {
+    return FileRequirementsFromJSONTyped(json, false);
+}
+exports.FileRequirementsFromJSON = FileRequirementsFromJSON;
+function FileRequirementsFromJSONTyped(json, ignoreDiscriminator) {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        'files': json['files'],
+        'errorMsg': json['errorMsg'],
+        'allowedDataTypes': (json['allowedDataTypes'].map(AllowedDataType_1.AllowedDataTypeFromJSON)),
+    };
+}
+exports.FileRequirementsFromJSONTyped = FileRequirementsFromJSONTyped;
+function FileRequirementsToJSON(value) {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        'files': value.files,
+        'errorMsg': value.errorMsg,
+        'allowedDataTypes': (value.allowedDataTypes.map(AllowedDataType_1.AllowedDataTypeToJSON)),
+    };
+}
+exports.FileRequirementsToJSON = FileRequirementsToJSON;

package/dist/models/ValidateDataInputsRequest.d.ts

@@ -0,0 +1,37 @@
+/**
+ * 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 ValidateDataInputsRequest
+ */
+export interface ValidateDataInputsRequest {
+    /**
+     *
+     * @type {string}
+     * @memberof ValidateDataInputsRequest
+     */
+    sampleSheet: string;
+    /**
+     *
+     * @type {Array<string>}
+     * @memberof ValidateDataInputsRequest
+     */
+    fileNames: Array<string>;
+}
+/**
+ * Check if a given object implements the ValidateDataInputsRequest interface.
+ */
+export declare function instanceOfValidateDataInputsRequest(value: object): boolean;
+export declare function ValidateDataInputsRequestFromJSON(json: any): ValidateDataInputsRequest;
+export declare function ValidateDataInputsRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): ValidateDataInputsRequest;
+export declare function ValidateDataInputsRequestToJSON(value?: ValidateDataInputsRequest | null): any;

package/dist/models/ValidateDataInputsRequest.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.ValidateDataInputsRequestToJSON = exports.ValidateDataInputsRequestFromJSONTyped = exports.ValidateDataInputsRequestFromJSON = exports.instanceOfValidateDataInputsRequest = void 0;
+/**
+ * Check if a given object implements the ValidateDataInputsRequest interface.
+ */
+function instanceOfValidateDataInputsRequest(value) {
+    var isInstance = true;
+    isInstance = isInstance && "sampleSheet" in value;
+    isInstance = isInstance && "fileNames" in value;
+    return isInstance;
+}
+exports.instanceOfValidateDataInputsRequest = instanceOfValidateDataInputsRequest;
+function ValidateDataInputsRequestFromJSON(json) {
+    return ValidateDataInputsRequestFromJSONTyped(json, false);
+}
+exports.ValidateDataInputsRequestFromJSON = ValidateDataInputsRequestFromJSON;
+function ValidateDataInputsRequestFromJSONTyped(json, ignoreDiscriminator) {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        'sampleSheet': json['sampleSheet'],
+        'fileNames': json['fileNames'],
+    };
+}
+exports.ValidateDataInputsRequestFromJSONTyped = ValidateDataInputsRequestFromJSONTyped;
+function ValidateDataInputsRequestToJSON(value) {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        'sampleSheet': value.sampleSheet,
+        'fileNames': value.fileNames,
+    };
+}
+exports.ValidateDataInputsRequestToJSON = ValidateDataInputsRequestToJSON;

package/dist/models/ValidateDataInputsResponse.d.ts

@@ -0,0 +1,44 @@
+/**
+ * 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 { AllowedDataType } from './AllowedDataType';
+/**
+ *
+ * @export
+ * @interface ValidateDataInputsResponse
+ */
+export interface ValidateDataInputsResponse {
+    /**
+     *
+     * @type {Array<string>}
+     * @memberof ValidateDataInputsResponse
+     */
+    files: Array<string>;
+    /**
+     *
+     * @type {string}
+     * @memberof ValidateDataInputsResponse
+     */
+    errorMsg: string;
+    /**
+     *
+     * @type {Array<AllowedDataType>}
+     * @memberof ValidateDataInputsResponse
+     */
+    allowedDataTypes: Array<AllowedDataType>;
+}
+/**
+ * Check if a given object implements the ValidateDataInputsResponse interface.
+ */
+export declare function instanceOfValidateDataInputsResponse(value: object): boolean;
+export declare function ValidateDataInputsResponseFromJSON(json: any): ValidateDataInputsResponse;
+export declare function ValidateDataInputsResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): ValidateDataInputsResponse;
+export declare function ValidateDataInputsResponseToJSON(value?: ValidateDataInputsResponse | null): any;

package/dist/models/ValidateDataInputsResponse.js

@@ -0,0 +1,57 @@
+"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.ValidateDataInputsResponseToJSON = exports.ValidateDataInputsResponseFromJSONTyped = exports.ValidateDataInputsResponseFromJSON = exports.instanceOfValidateDataInputsResponse = void 0;
+var AllowedDataType_1 = require("./AllowedDataType");
+/**
+ * Check if a given object implements the ValidateDataInputsResponse interface.
+ */
+function instanceOfValidateDataInputsResponse(value) {
+    var isInstance = true;
+    isInstance = isInstance && "files" in value;
+    isInstance = isInstance && "errorMsg" in value;
+    isInstance = isInstance && "allowedDataTypes" in value;
+    return isInstance;
+}
+exports.instanceOfValidateDataInputsResponse = instanceOfValidateDataInputsResponse;
+function ValidateDataInputsResponseFromJSON(json) {
+    return ValidateDataInputsResponseFromJSONTyped(json, false);
+}
+exports.ValidateDataInputsResponseFromJSON = ValidateDataInputsResponseFromJSON;
+function ValidateDataInputsResponseFromJSONTyped(json, ignoreDiscriminator) {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        'files': json['files'],
+        'errorMsg': json['errorMsg'],
+        'allowedDataTypes': (json['allowedDataTypes'].map(AllowedDataType_1.AllowedDataTypeFromJSON)),
+    };
+}
+exports.ValidateDataInputsResponseFromJSONTyped = ValidateDataInputsResponseFromJSONTyped;
+function ValidateDataInputsResponseToJSON(value) {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        'files': value.files,
+        'errorMsg': value.errorMsg,
+        'allowedDataTypes': (value.allowedDataTypes.map(AllowedDataType_1.AllowedDataTypeToJSON)),
+    };
+}
+exports.ValidateDataInputsResponseToJSON = ValidateDataInputsResponseToJSON;

package/dist/models/ValidateFileRequirementsRequest.d.ts

@@ -0,0 +1,37 @@
+/**
+ * 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 ValidateFileRequirementsRequest
+ */
+export interface ValidateFileRequirementsRequest {
+    /**
+     *
+     * @type {string}
+     * @memberof ValidateFileRequirementsRequest
+     */
+    sampleSheet: string;
+    /**
+     *
+     * @type {Array<string>}
+     * @memberof ValidateFileRequirementsRequest
+     */
+    fileNames: Array<string>;
+}
+/**
+ * Check if a given object implements the ValidateFileRequirementsRequest interface.
+ */
+export declare function instanceOfValidateFileRequirementsRequest(value: object): boolean;
+export declare function ValidateFileRequirementsRequestFromJSON(json: any): ValidateFileRequirementsRequest;
+export declare function ValidateFileRequirementsRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): ValidateFileRequirementsRequest;
+export declare function ValidateFileRequirementsRequestToJSON(value?: ValidateFileRequirementsRequest | null): any;

package/dist/models/ValidateFileRequirementsRequest.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.ValidateFileRequirementsRequestToJSON = exports.ValidateFileRequirementsRequestFromJSONTyped = exports.ValidateFileRequirementsRequestFromJSON = exports.instanceOfValidateFileRequirementsRequest = void 0;
+/**
+ * Check if a given object implements the ValidateFileRequirementsRequest interface.
+ */
+function instanceOfValidateFileRequirementsRequest(value) {
+    var isInstance = true;
+    isInstance = isInstance && "sampleSheet" in value;
+    isInstance = isInstance && "fileNames" in value;
+    return isInstance;
+}
+exports.instanceOfValidateFileRequirementsRequest = instanceOfValidateFileRequirementsRequest;
+function ValidateFileRequirementsRequestFromJSON(json) {
+    return ValidateFileRequirementsRequestFromJSONTyped(json, false);
+}
+exports.ValidateFileRequirementsRequestFromJSON = ValidateFileRequirementsRequestFromJSON;
+function ValidateFileRequirementsRequestFromJSONTyped(json, ignoreDiscriminator) {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        'sampleSheet': json['sampleSheet'],
+        'fileNames': json['fileNames'],
+    };
+}
+exports.ValidateFileRequirementsRequestFromJSONTyped = ValidateFileRequirementsRequestFromJSONTyped;
+function ValidateFileRequirementsRequestToJSON(value) {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        'sampleSheet': value.sampleSheet,
+        'fileNames': value.fileNames,
+    };
+}
+exports.ValidateFileRequirementsRequestToJSON = ValidateFileRequirementsRequestToJSON;

package/dist/models/index.d.ts

@@ -1,3 +1,4 @@
+export * from './AllowedDataType';
 export * from './BillingAccount';
 export * from './BillingAccountRequest';
 export * from './BillingMethod';
@@ -16,6 +17,8 @@ export * from './DatasetDetail';
 export * from './DatasetFile';
 export * from './DatasetViz';
 export * from './Executor';
+export * from './FileNamePattern';
+export * from './FileRequirements';
 export * from './FormSchema';
 export * from './GenerateSftpCredentialsRequest';
 export * from './GetExecutionLogsResponse';
@@ -57,3 +60,4 @@ export * from './UpdateUserRequest';
 export * from './UploadDatasetCreateResponse';
 export * from './UploadDatasetRequest';
 export * from './User';
+export * from './ValidateFileRequirementsRequest';

package/dist/models/index.js

@@ -16,6 +16,7 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 Object.defineProperty(exports, "__esModule", { value: true });
 /* tslint:disable */
 /* eslint-disable */
+__exportStar(require("./AllowedDataType"), exports);
 __exportStar(require("./BillingAccount"), exports);
 __exportStar(require("./BillingAccountRequest"), exports);
 __exportStar(require("./BillingMethod"), exports);
@@ -34,6 +35,8 @@ __exportStar(require("./DatasetDetail"), exports);
 __exportStar(require("./DatasetFile"), exports);
 __exportStar(require("./DatasetViz"), exports);
 __exportStar(require("./Executor"), exports);
+__exportStar(require("./FileNamePattern"), exports);
+__exportStar(require("./FileRequirements"), exports);
 __exportStar(require("./FormSchema"), exports);
 __exportStar(require("./GenerateSftpCredentialsRequest"), exports);
 __exportStar(require("./GetExecutionLogsResponse"), exports);
@@ -75,3 +78,4 @@ __exportStar(require("./UpdateUserRequest"), exports);
 __exportStar(require("./UploadDatasetCreateResponse"), exports);
 __exportStar(require("./UploadDatasetRequest"), exports);
 __exportStar(require("./User"), exports);
+__exportStar(require("./ValidateFileRequirementsRequest"), exports);

package/package.json

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

package/src/apis/ProcessesApi.ts

@@ -15,17 +15,23 @@
 
 import * as runtime from '../runtime';
 import type {
+  FileRequirements,
   FormSchema,
   Process,
   ProcessDetail,
+  ValidateFileRequirementsRequest,
 } from '../models/index';
 import {
+    FileRequirementsFromJSON,
+    FileRequirementsToJSON,
     FormSchemaFromJSON,
     FormSchemaToJSON,
     ProcessFromJSON,
     ProcessToJSON,
     ProcessDetailFromJSON,
     ProcessDetailToJSON,
+    ValidateFileRequirementsRequestFromJSON,
+    ValidateFileRequirementsRequestToJSON,
 } from '../models/index';
 
 export interface GetProcessRequest {
@@ -40,6 +46,11 @@ export interface GetProcessesRequest {
     includeArchived?: boolean;
 }
 
+export interface ValidateFileRequirementsOperationRequest {
+    processId: string;
+    validateFileRequirementsRequest: ValidateFileRequirementsRequest;
+}
+
 /**
  * 
  */
@@ -165,4 +176,51 @@ export class ProcessesApi extends runtime.BaseAPI {
         return await response.value();
     }
 
+    /**
+     * Checks the input file names with the expected files for a data type (ingest processes only)
+     * Validate file requirements
+     */
+    async validateFileRequirementsRaw(requestParameters: ValidateFileRequirementsOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<FileRequirements>> {
+        if (requestParameters.processId === null || requestParameters.processId === undefined) {
+            throw new runtime.RequiredError('processId','Required parameter requestParameters.processId was null or undefined when calling validateFileRequirements.');
+        }
+
+        if (requestParameters.validateFileRequirementsRequest === null || requestParameters.validateFileRequirementsRequest === undefined) {
+            throw new runtime.RequiredError('validateFileRequirementsRequest','Required parameter requestParameters.validateFileRequirementsRequest was null or undefined when calling validateFileRequirements.');
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        headerParameters['Content-Type'] = 'application/json';
+
+        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}/validate-files`.replace(`{${"processId"}}`, encodeURIComponent(String(requestParameters.processId))),
+            method: 'POST',
+            headers: headerParameters,
+            query: queryParameters,
+            body: ValidateFileRequirementsRequestToJSON(requestParameters.validateFileRequirementsRequest),
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => FileRequirementsFromJSON(jsonValue));
+    }
+
+    /**
+     * Checks the input file names with the expected files for a data type (ingest processes only)
+     * Validate file requirements
+     */
+    async validateFileRequirements(requestParameters: ValidateFileRequirementsOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<FileRequirements> {
+        const response = await this.validateFileRequirementsRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
 }

package/src/models/AllowedDataType.ts

@@ -0,0 +1,91 @@
+/* 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 { FileNamePattern } from './FileNamePattern';
+import {
+    FileNamePatternFromJSON,
+    FileNamePatternFromJSONTyped,
+    FileNamePatternToJSON,
+} from './FileNamePattern';
+
+/**
+ * 
+ * @export
+ * @interface AllowedDataType
+ */
+export interface AllowedDataType {
+    /**
+     * 
+     * @type {string}
+     * @memberof AllowedDataType
+     */
+    description: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof AllowedDataType
+     */
+    errorMsg: string;
+    /**
+     * 
+     * @type {Array<FileNamePattern>}
+     * @memberof AllowedDataType
+     */
+    allowedPatterns: Array<FileNamePattern>;
+}
+
+/**
+ * Check if a given object implements the AllowedDataType interface.
+ */
+export function instanceOfAllowedDataType(value: object): boolean {
+    let isInstance = true;
+    isInstance = isInstance && "description" in value;
+    isInstance = isInstance && "errorMsg" in value;
+    isInstance = isInstance && "allowedPatterns" in value;
+
+    return isInstance;
+}
+
+export function AllowedDataTypeFromJSON(json: any): AllowedDataType {
+    return AllowedDataTypeFromJSONTyped(json, false);
+}
+
+export function AllowedDataTypeFromJSONTyped(json: any, ignoreDiscriminator: boolean): AllowedDataType {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        
+        'description': json['description'],
+        'errorMsg': json['errorMsg'],
+        'allowedPatterns': ((json['allowedPatterns'] as Array<any>).map(FileNamePatternFromJSON)),
+    };
+}
+
+export function AllowedDataTypeToJSON(value?: AllowedDataType | null): any {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        
+        'description': value.description,
+        'errorMsg': value.errorMsg,
+        'allowedPatterns': ((value.allowedPatterns as Array<any>).map(FileNamePatternToJSON)),
+    };
+}
+

package/src/models/FileNamePattern.ts

@@ -0,0 +1,84 @@
+/* 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 FileNamePattern
+ */
+export interface FileNamePattern {
+    /**
+     * 
+     * @type {string}
+     * @memberof FileNamePattern
+     */
+    exampleName: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof FileNamePattern
+     */
+    description: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof FileNamePattern
+     */
+    sampleMatchingPattern: string;
+}
+
+/**
+ * Check if a given object implements the FileNamePattern interface.
+ */
+export function instanceOfFileNamePattern(value: object): boolean {
+    let isInstance = true;
+    isInstance = isInstance && "exampleName" in value;
+    isInstance = isInstance && "description" in value;
+    isInstance = isInstance && "sampleMatchingPattern" in value;
+
+    return isInstance;
+}
+
+export function FileNamePatternFromJSON(json: any): FileNamePattern {
+    return FileNamePatternFromJSONTyped(json, false);
+}
+
+export function FileNamePatternFromJSONTyped(json: any, ignoreDiscriminator: boolean): FileNamePattern {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        
+        'exampleName': json['exampleName'],
+        'description': json['description'],
+        'sampleMatchingPattern': json['sampleMatchingPattern'],
+    };
+}
+
+export function FileNamePatternToJSON(value?: FileNamePattern | null): any {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        
+        'exampleName': value.exampleName,
+        'description': value.description,
+        'sampleMatchingPattern': value.sampleMatchingPattern,
+    };
+}
+

package/src/models/FileRequirements.ts

@@ -0,0 +1,91 @@
+/* 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 { AllowedDataType } from './AllowedDataType';
+import {
+    AllowedDataTypeFromJSON,
+    AllowedDataTypeFromJSONTyped,
+    AllowedDataTypeToJSON,
+} from './AllowedDataType';
+
+/**
+ * 
+ * @export
+ * @interface FileRequirements
+ */
+export interface FileRequirements {
+    /**
+     * 
+     * @type {Array<string>}
+     * @memberof FileRequirements
+     */
+    files: Array<string>;
+    /**
+     * 
+     * @type {string}
+     * @memberof FileRequirements
+     */
+    errorMsg: string;
+    /**
+     * 
+     * @type {Array<AllowedDataType>}
+     * @memberof FileRequirements
+     */
+    allowedDataTypes: Array<AllowedDataType>;
+}
+
+/**
+ * Check if a given object implements the FileRequirements interface.
+ */
+export function instanceOfFileRequirements(value: object): boolean {
+    let isInstance = true;
+    isInstance = isInstance && "files" in value;
+    isInstance = isInstance && "errorMsg" in value;
+    isInstance = isInstance && "allowedDataTypes" in value;
+
+    return isInstance;
+}
+
+export function FileRequirementsFromJSON(json: any): FileRequirements {
+    return FileRequirementsFromJSONTyped(json, false);
+}
+
+export function FileRequirementsFromJSONTyped(json: any, ignoreDiscriminator: boolean): FileRequirements {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        
+        'files': json['files'],
+        'errorMsg': json['errorMsg'],
+        'allowedDataTypes': ((json['allowedDataTypes'] as Array<any>).map(AllowedDataTypeFromJSON)),
+    };
+}
+
+export function FileRequirementsToJSON(value?: FileRequirements | null): any {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        
+        'files': value.files,
+        'errorMsg': value.errorMsg,
+        'allowedDataTypes': ((value.allowedDataTypes as Array<any>).map(AllowedDataTypeToJSON)),
+    };
+}
+

package/src/models/ValidateFileRequirementsRequest.ts

@@ -0,0 +1,75 @@
+/* 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 ValidateFileRequirementsRequest
+ */
+export interface ValidateFileRequirementsRequest {
+    /**
+     * 
+     * @type {string}
+     * @memberof ValidateFileRequirementsRequest
+     */
+    sampleSheet: string;
+    /**
+     * 
+     * @type {Array<string>}
+     * @memberof ValidateFileRequirementsRequest
+     */
+    fileNames: Array<string>;
+}
+
+/**
+ * Check if a given object implements the ValidateFileRequirementsRequest interface.
+ */
+export function instanceOfValidateFileRequirementsRequest(value: object): boolean {
+    let isInstance = true;
+    isInstance = isInstance && "sampleSheet" in value;
+    isInstance = isInstance && "fileNames" in value;
+
+    return isInstance;
+}
+
+export function ValidateFileRequirementsRequestFromJSON(json: any): ValidateFileRequirementsRequest {
+    return ValidateFileRequirementsRequestFromJSONTyped(json, false);
+}
+
+export function ValidateFileRequirementsRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): ValidateFileRequirementsRequest {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        
+        'sampleSheet': json['sampleSheet'],
+        'fileNames': json['fileNames'],
+    };
+}
+
+export function ValidateFileRequirementsRequestToJSON(value?: ValidateFileRequirementsRequest | null): any {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        
+        'sampleSheet': value.sampleSheet,
+        'fileNames': value.fileNames,
+    };
+}
+

package/src/models/index.ts

@@ -1,5 +1,6 @@
 /* tslint:disable */
 /* eslint-disable */
+export * from './AllowedDataType';
 export * from './BillingAccount';
 export * from './BillingAccountRequest';
 export * from './BillingMethod';
@@ -18,6 +19,8 @@ export * from './DatasetDetail';
 export * from './DatasetFile';
 export * from './DatasetViz';
 export * from './Executor';
+export * from './FileNamePattern';
+export * from './FileRequirements';
 export * from './FormSchema';
 export * from './GenerateSftpCredentialsRequest';
 export * from './GetExecutionLogsResponse';
@@ -59,3 +62,4 @@ export * from './UpdateUserRequest';
 export * from './UploadDatasetCreateResponse';
 export * from './UploadDatasetRequest';
 export * from './User';
+export * from './ValidateFileRequirementsRequest';