@cirrobio/api-client 0.2.20 → 0.2.22

package/.openapi-generator/FILES

@@ -55,6 +55,7 @@ src/models/CustomPipelineSettings.ts
 src/models/CustomerType.ts
 src/models/Dashboard.ts
 src/models/DashboardRequest.ts
+src/models/DataFile.ts
 src/models/Dataset.ts
 src/models/DatasetAssetsManifest.ts
 src/models/DatasetCondition.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.2.20 --save
+npm install @cirrobio/api-client@0.2.22 --save
 ```
 
 _unPublished (not recommended):_

package/dist/apis/GovernanceApi.d.ts

@@ -43,6 +43,9 @@ export interface GetContactRequest {
 export interface GetRequirementRequest {
     requirementId: string;
 }
+export interface GetRequirementsRequest {
+    projectId?: string;
+}
 export interface GetRequirementsByProjectRequest {
     projectId: string;
 }
@@ -186,12 +189,12 @@ export declare class GovernanceApi extends runtime.BaseAPI {
      * Retrieve a list of governance requirements
      * Get requirements
      */
-    getRequirementsRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<GovernanceRequirement>>>;
+    getRequirementsRaw(requestParameters: GetRequirementsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<GovernanceRequirement>>>;
     /**
      * Retrieve a list of governance requirements
      * Get requirements
      */
-    getRequirements(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<GovernanceRequirement>>;
+    getRequirements(requestParameters?: GetRequirementsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<GovernanceRequirement>>;
     /**
      * Retrieve governance requirements for a project with fulfillment information for the current user
      * Get project requirements

package/dist/apis/GovernanceApi.js

@@ -741,13 +741,16 @@ var GovernanceApi = /** @class */ (function (_super) {
      * Retrieve a list of governance requirements
      * Get requirements
      */
-    GovernanceApi.prototype.getRequirementsRaw = function (initOverrides) {
+    GovernanceApi.prototype.getRequirementsRaw = 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:
                         queryParameters = {};
+                        if (requestParameters.projectId !== undefined) {
+                            queryParameters['projectId'] = requestParameters.projectId;
+                        }
                         headerParameters = {};
                         if (!(this.configuration && this.configuration.accessToken)) return [3 /*break*/, 2];
                         token = this.configuration.accessToken;
@@ -775,12 +778,13 @@ var GovernanceApi = /** @class */ (function (_super) {
      * Retrieve a list of governance requirements
      * Get requirements
      */
-    GovernanceApi.prototype.getRequirements = function (initOverrides) {
+    GovernanceApi.prototype.getRequirements = function (requestParameters, initOverrides) {
+        if (requestParameters === void 0) { requestParameters = {}; }
         return __awaiter(this, void 0, void 0, function () {
             var response;
             return __generator(this, function (_a) {
                 switch (_a.label) {
-                    case 0: return [4 /*yield*/, this.getRequirementsRaw(initOverrides)];
+                    case 0: return [4 /*yield*/, this.getRequirementsRaw(requestParameters, initOverrides)];
                     case 1:
                         response = _a.sent();
                         return [4 /*yield*/, response.value()];

package/dist/apis/MetadataApi.d.ts

@@ -11,6 +11,10 @@
  */
 import * as runtime from '../runtime';
 import type { FormSchema, PaginatedResponseSampleDto, Sample, SampleRequest } from '../models/index';
+export interface GetDatasetSamplesRequest {
+    projectId: string;
+    datasetId: string;
+}
 export interface GetProjectSamplesRequest {
     projectId: string;
     limit?: number;
@@ -32,6 +36,16 @@ export interface UpdateSampleRequest {
  *
  */
 export declare class MetadataApi extends runtime.BaseAPI {
+    /**
+     * Retrieves a list of samples associated with a dataset along with their metadata
+     * Get dataset samples
+     */
+    getDatasetSamplesRaw(requestParameters: GetDatasetSamplesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<Sample>>>;
+    /**
+     * Retrieves a list of samples associated with a dataset along with their metadata
+     * Get dataset samples
+     */
+    getDatasetSamples(requestParameters: GetDatasetSamplesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<Sample>>;
     /**
      * Retrieves a list of samples associated with a project along with their metadata
      * Get project samples

package/dist/apis/MetadataApi.js

@@ -75,6 +75,64 @@ var MetadataApi = /** @class */ (function (_super) {
     function MetadataApi() {
         return _super !== null && _super.apply(this, arguments) || this;
     }
+    /**
+     * Retrieves a list of samples associated with a dataset along with their metadata
+     * Get dataset samples
+     */
+    MetadataApi.prototype.getDatasetSamplesRaw = 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.projectId === null || requestParameters.projectId === undefined) {
+                            throw new runtime.RequiredError('projectId', 'Required parameter requestParameters.projectId was null or undefined when calling getDatasetSamples.');
+                        }
+                        if (requestParameters.datasetId === null || requestParameters.datasetId === undefined) {
+                            throw new runtime.RequiredError('datasetId', 'Required parameter requestParameters.datasetId was null or undefined when calling getDatasetSamples.');
+                        }
+                        queryParameters = {};
+                        headerParameters = {};
+                        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: "/projects/{projectId}/datasets/{datasetId}/samples".replace("{".concat("projectId", "}"), encodeURIComponent(String(requestParameters.projectId))).replace("{".concat("datasetId", "}"), encodeURIComponent(String(requestParameters.datasetId))),
+                            method: 'GET',
+                            headers: headerParameters,
+                            query: queryParameters,
+                        }, initOverrides)];
+                    case 3:
+                        response = _a.sent();
+                        return [2 /*return*/, new runtime.JSONApiResponse(response, function (jsonValue) { return jsonValue.map(index_1.SampleFromJSON); })];
+                }
+            });
+        });
+    };
+    /**
+     * Retrieves a list of samples associated with a dataset along with their metadata
+     * Get dataset samples
+     */
+    MetadataApi.prototype.getDatasetSamples = 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.getDatasetSamplesRaw(requestParameters, initOverrides)];
+                    case 1:
+                        response = _a.sent();
+                        return [4 /*yield*/, response.value()];
+                    case 2: return [2 /*return*/, _a.sent()];
+                }
+            });
+        });
+    };
     /**
      * Retrieves a list of samples associated with a project along with their metadata
      * Get project samples

package/dist/models/DataFile.d.ts

@@ -0,0 +1,39 @@
+/**
+ * Cirro Data
+ * Cirro Data Platform service API
+ *
+ * The version of the OpenAPI document: latest
+ * Contact: support@cirro.bio
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ *
+ * @export
+ * @interface DataFile
+ */
+export interface DataFile {
+    /**
+     *
+     * @type {string}
+     * @memberof DataFile
+     */
+    path: string;
+    /**
+     *
+     * @type {{ [key: string]: any; }}
+     * @memberof DataFile
+     */
+    metadata: {
+        [key: string]: any;
+    };
+}
+/**
+ * Check if a given object implements the DataFile interface.
+ */
+export declare function instanceOfDataFile(value: object): boolean;
+export declare function DataFileFromJSON(json: any): DataFile;
+export declare function DataFileFromJSONTyped(json: any, ignoreDiscriminator: boolean): DataFile;
+export declare function DataFileToJSON(value?: DataFile | null): any;

package/dist/models/DataFile.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.DataFileToJSON = exports.DataFileFromJSONTyped = exports.DataFileFromJSON = exports.instanceOfDataFile = void 0;
+/**
+ * Check if a given object implements the DataFile interface.
+ */
+function instanceOfDataFile(value) {
+    var isInstance = true;
+    isInstance = isInstance && "path" in value;
+    isInstance = isInstance && "metadata" in value;
+    return isInstance;
+}
+exports.instanceOfDataFile = instanceOfDataFile;
+function DataFileFromJSON(json) {
+    return DataFileFromJSONTyped(json, false);
+}
+exports.DataFileFromJSON = DataFileFromJSON;
+function DataFileFromJSONTyped(json, ignoreDiscriminator) {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        'path': json['path'],
+        'metadata': json['metadata'],
+    };
+}
+exports.DataFileFromJSONTyped = DataFileFromJSONTyped;
+function DataFileToJSON(value) {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        'path': value.path,
+        'metadata': value.metadata,
+    };
+}
+exports.DataFileToJSON = DataFileToJSON;

package/dist/models/GovernanceRequirement.d.ts

@@ -56,6 +56,12 @@ export interface GovernanceRequirement {
      * @memberof GovernanceRequirement
      */
     scope: GovernanceScope;
+    /**
+     * The project ID if the requirement is project scope
+     * @type {string}
+     * @memberof GovernanceRequirement
+     */
+    projectId?: string;
     /**
      *
      * @type {GovernanceScope}

package/dist/models/GovernanceRequirement.js

@@ -54,6 +54,7 @@ function GovernanceRequirementFromJSONTyped(json, ignoreDiscriminator) {
         'type': (0, GovernanceType_1.GovernanceTypeFromJSON)(json['type']),
         'path': json['path'],
         'scope': (0, GovernanceScope_1.GovernanceScopeFromJSON)(json['scope']),
+        'projectId': !(0, runtime_1.exists)(json, 'projectId') ? undefined : json['projectId'],
         'acceptance': !(0, runtime_1.exists)(json, 'acceptance') ? undefined : (0, GovernanceScope_1.GovernanceScopeFromJSON)(json['acceptance']),
         'contactIds': json['contactIds'],
         'expiration': (0, GovernanceExpiry_1.GovernanceExpiryFromJSON)(json['expiration']),
@@ -82,6 +83,7 @@ function GovernanceRequirementToJSON(value) {
         'type': (0, GovernanceType_1.GovernanceTypeToJSON)(value.type),
         'path': value.path,
         'scope': (0, GovernanceScope_1.GovernanceScopeToJSON)(value.scope),
+        'projectId': value.projectId,
         'acceptance': (0, GovernanceScope_1.GovernanceScopeToJSON)(value.acceptance),
         'contactIds': value.contactIds,
         'expiration': (0, GovernanceExpiry_1.GovernanceExpiryToJSON)(value.expiration),

package/dist/models/Process.d.ts

@@ -100,6 +100,12 @@ export interface Process {
      * @memberof Process
      */
     allowMultipleSources?: boolean;
+    /**
+     * Whether the pipeline uses the Cirro-provided sample sheet
+     * @type {boolean}
+     * @memberof Process
+     */
+    usesSampleSheet?: boolean;
     /**
      * Whether the pipeline is marked as archived
      * @type {boolean}

package/dist/models/Process.js

@@ -52,6 +52,7 @@ function ProcessFromJSONTyped(json, ignoreDiscriminator) {
         'owner': !(0, runtime_1.exists)(json, 'owner') ? undefined : json['owner'],
         'linkedProjectIds': !(0, runtime_1.exists)(json, 'linkedProjectIds') ? undefined : json['linkedProjectIds'],
         'allowMultipleSources': !(0, runtime_1.exists)(json, 'allowMultipleSources') ? undefined : json['allowMultipleSources'],
+        'usesSampleSheet': !(0, runtime_1.exists)(json, 'usesSampleSheet') ? undefined : json['usesSampleSheet'],
         'isArchived': !(0, runtime_1.exists)(json, 'isArchived') ? undefined : json['isArchived'],
     };
 }
@@ -78,6 +79,7 @@ function ProcessToJSON(value) {
         'owner': value.owner,
         'linkedProjectIds': value.linkedProjectIds,
         'allowMultipleSources': value.allowMultipleSources,
+        'usesSampleSheet': value.usesSampleSheet,
         'isArchived': value.isArchived,
     };
 }

package/dist/models/ProcessDetail.d.ts

@@ -115,6 +115,12 @@ export interface ProcessDetail {
      * @memberof ProcessDetail
      */
     allowMultipleSources?: boolean;
+    /**
+     * Whether the pipeline uses the Cirro-provided sample sheet
+     * @type {boolean}
+     * @memberof ProcessDetail
+     */
+    usesSampleSheet?: boolean;
     /**
      *
      * @type {CustomPipelineSettings}

package/dist/models/ProcessDetail.js

@@ -59,6 +59,7 @@ function ProcessDetailFromJSONTyped(json, ignoreDiscriminator) {
         'linkedProjectIds': json['linkedProjectIds'],
         'isTenantWide': !(0, runtime_1.exists)(json, 'isTenantWide') ? undefined : json['isTenantWide'],
         'allowMultipleSources': !(0, runtime_1.exists)(json, 'allowMultipleSources') ? undefined : json['allowMultipleSources'],
+        'usesSampleSheet': !(0, runtime_1.exists)(json, 'usesSampleSheet') ? undefined : json['usesSampleSheet'],
         'customSettings': !(0, runtime_1.exists)(json, 'customSettings') ? undefined : (0, CustomPipelineSettings_1.CustomPipelineSettingsFromJSON)(json['customSettings']),
         'isArchived': !(0, runtime_1.exists)(json, 'isArchived') ? undefined : json['isArchived'],
         'fileMappingRules': !(0, runtime_1.exists)(json, 'fileMappingRules') ? undefined : (json['fileMappingRules'] === null ? null : json['fileMappingRules'].map(FileMappingRule_1.FileMappingRuleFromJSON)),
@@ -89,6 +90,7 @@ function ProcessDetailToJSON(value) {
         'linkedProjectIds': value.linkedProjectIds,
         'isTenantWide': value.isTenantWide,
         'allowMultipleSources': value.allowMultipleSources,
+        'usesSampleSheet': value.usesSampleSheet,
         'customSettings': (0, CustomPipelineSettings_1.CustomPipelineSettingsToJSON)(value.customSettings),
         'isArchived': value.isArchived,
         'fileMappingRules': value.fileMappingRules === undefined ? undefined : (value.fileMappingRules === null ? null : value.fileMappingRules.map(FileMappingRule_1.FileMappingRuleToJSON)),

package/dist/models/RequirementInput.d.ts

@@ -44,6 +44,12 @@ export interface RequirementInput {
      * @memberof RequirementInput
      */
     scope: GovernanceScope;
+    /**
+     *
+     * @type {string}
+     * @memberof RequirementInput
+     */
+    projectId?: string | null;
     /**
      *
      * @type {GovernanceScope}

package/dist/models/RequirementInput.js

@@ -47,6 +47,7 @@ function RequirementInputFromJSONTyped(json, ignoreDiscriminator) {
         'description': json['description'],
         'type': (0, GovernanceType_1.GovernanceTypeFromJSON)(json['type']),
         'scope': (0, GovernanceScope_1.GovernanceScopeFromJSON)(json['scope']),
+        'projectId': !(0, runtime_1.exists)(json, 'projectId') ? undefined : json['projectId'],
         'acceptance': !(0, runtime_1.exists)(json, 'acceptance') ? undefined : (0, GovernanceScope_1.GovernanceScopeFromJSON)(json['acceptance']),
         'contactIds': json['contactIds'],
         'expiration': (0, GovernanceExpiry_1.GovernanceExpiryFromJSON)(json['expiration']),
@@ -70,6 +71,7 @@ function RequirementInputToJSON(value) {
         'description': value.description,
         'type': (0, GovernanceType_1.GovernanceTypeToJSON)(value.type),
         'scope': (0, GovernanceScope_1.GovernanceScopeToJSON)(value.scope),
+        'projectId': value.projectId,
         'acceptance': (0, GovernanceScope_1.GovernanceScopeToJSON)(value.acceptance),
         'contactIds': value.contactIds,
         'expiration': (0, GovernanceExpiry_1.GovernanceExpiryToJSON)(value.expiration),

package/dist/models/RunAnalysisRequest.d.ts

@@ -39,6 +39,12 @@ export interface RunAnalysisRequest {
      * @memberof RunAnalysisRequest
      */
     sourceDatasetIds: Array<string>;
+    /**
+     * Samples within the source datasets that will be used as inputs to this workflow. If not specified, all samples will be used.
+     * @type {Array<string>}
+     * @memberof RunAnalysisRequest
+     */
+    sourceSampleIds?: Array<string> | null;
     /**
      * Used for caching task execution. If the parameters are the same as the dataset specified here, it will re-use the output to minimize duplicate work
      * @type {string}

package/dist/models/RunAnalysisRequest.js

@@ -41,6 +41,7 @@ function RunAnalysisRequestFromJSONTyped(json, ignoreDiscriminator) {
         'description': !(0, runtime_1.exists)(json, 'description') ? undefined : json['description'],
         'processId': json['processId'],
         'sourceDatasetIds': json['sourceDatasetIds'],
+        'sourceSampleIds': !(0, runtime_1.exists)(json, 'sourceSampleIds') ? undefined : json['sourceSampleIds'],
         'resumeDatasetId': !(0, runtime_1.exists)(json, 'resumeDatasetId') ? undefined : json['resumeDatasetId'],
         'params': json['params'],
         'notificationEmails': json['notificationEmails'],
@@ -60,6 +61,7 @@ function RunAnalysisRequestToJSON(value) {
         'description': value.description,
         'processId': value.processId,
         'sourceDatasetIds': value.sourceDatasetIds,
+        'sourceSampleIds': value.sourceSampleIds,
         'resumeDatasetId': value.resumeDatasetId,
         'params': value.params,
         'notificationEmails': value.notificationEmails,

package/dist/models/Sample.d.ts

@@ -9,6 +9,7 @@
  * https://openapi-generator.tech
  * Do not edit the class manually.
  */
+import type { DataFile } from './DataFile';
 /**
  *
  * @export
@@ -35,6 +36,12 @@ export interface Sample {
     metadata?: {
         [key: string]: any;
     } | null;
+    /**
+     * Files associated with this sample
+     * @type {Array<DataFile>}
+     * @memberof Sample
+     */
+    files?: Array<DataFile> | null;
     /**
      *
      * @type {Array<string>}

package/dist/models/Sample.js

@@ -15,6 +15,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.SampleToJSON = exports.SampleFromJSONTyped = exports.SampleFromJSON = exports.instanceOfSample = void 0;
 var runtime_1 = require("../runtime");
+var DataFile_1 = require("./DataFile");
 /**
  * Check if a given object implements the Sample interface.
  */
@@ -37,6 +38,7 @@ function SampleFromJSONTyped(json, ignoreDiscriminator) {
         'id': json['id'],
         'name': json['name'],
         'metadata': !(0, runtime_1.exists)(json, 'metadata') ? undefined : json['metadata'],
+        'files': !(0, runtime_1.exists)(json, 'files') ? undefined : (json['files'] === null ? null : json['files'].map(DataFile_1.DataFileFromJSON)),
         'datasetIds': !(0, runtime_1.exists)(json, 'datasetIds') ? undefined : json['datasetIds'],
         'createdAt': !(0, runtime_1.exists)(json, 'createdAt') ? undefined : (json['createdAt'] === null ? null : new Date(json['createdAt'])),
         'updatedAt': !(0, runtime_1.exists)(json, 'updatedAt') ? undefined : (json['updatedAt'] === null ? null : new Date(json['updatedAt'])),
@@ -54,6 +56,7 @@ function SampleToJSON(value) {
         'id': value.id,
         'name': value.name,
         'metadata': value.metadata,
+        'files': value.files === undefined ? undefined : (value.files === null ? null : value.files.map(DataFile_1.DataFileToJSON)),
         'datasetIds': value.datasetIds,
         'createdAt': value.createdAt === undefined ? undefined : (value.createdAt === null ? null : value.createdAt.toISOString()),
         'updatedAt': value.updatedAt === undefined ? undefined : (value.updatedAt === null ? null : value.updatedAt.toISOString()),

package/dist/models/index.d.ts

@@ -30,6 +30,7 @@ export * from './CustomPipelineSettings';
 export * from './CustomerType';
 export * from './Dashboard';
 export * from './DashboardRequest';
+export * from './DataFile';
 export * from './Dataset';
 export * from './DatasetAssetsManifest';
 export * from './DatasetCondition';

package/dist/models/index.js

@@ -48,6 +48,7 @@ __exportStar(require("./CustomPipelineSettings"), exports);
 __exportStar(require("./CustomerType"), exports);
 __exportStar(require("./Dashboard"), exports);
 __exportStar(require("./DashboardRequest"), exports);
+__exportStar(require("./DataFile"), exports);
 __exportStar(require("./Dataset"), exports);
 __exportStar(require("./DatasetAssetsManifest"), exports);
 __exportStar(require("./DatasetCondition"), exports);

package/package.json

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

package/src/apis/GovernanceApi.ts

@@ -88,6 +88,10 @@ export interface GetRequirementRequest {
     requirementId: string;
 }
 
+export interface GetRequirementsRequest {
+    projectId?: string;
+}
+
 export interface GetRequirementsByProjectRequest {
     projectId: string;
 }
@@ -605,9 +609,13 @@ export class GovernanceApi extends runtime.BaseAPI {
      * Retrieve a list of governance requirements
      * Get requirements
      */
-    async getRequirementsRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<GovernanceRequirement>>> {
+    async getRequirementsRaw(requestParameters: GetRequirementsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<GovernanceRequirement>>> {
         const queryParameters: any = {};
 
+        if (requestParameters.projectId !== undefined) {
+            queryParameters['projectId'] = requestParameters.projectId;
+        }
+
         const headerParameters: runtime.HTTPHeaders = {};
 
         if (this.configuration && this.configuration.accessToken) {
@@ -632,8 +640,8 @@ export class GovernanceApi extends runtime.BaseAPI {
      * Retrieve a list of governance requirements
      * Get requirements
      */
-    async getRequirements(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<GovernanceRequirement>> {
-        const response = await this.getRequirementsRaw(initOverrides);
+    async getRequirements(requestParameters: GetRequirementsRequest = {}, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<GovernanceRequirement>> {
+        const response = await this.getRequirementsRaw(requestParameters, initOverrides);
         return await response.value();
     }
 

package/src/apis/MetadataApi.ts

@@ -31,6 +31,11 @@ import {
     SampleRequestToJSON,
 } from '../models/index';
 
+export interface GetDatasetSamplesRequest {
+    projectId: string;
+    datasetId: string;
+}
+
 export interface GetProjectSamplesRequest {
     projectId: string;
     limit?: number;
@@ -57,6 +62,50 @@ export interface UpdateSampleRequest {
  */
 export class MetadataApi extends runtime.BaseAPI {
 
+    /**
+     * Retrieves a list of samples associated with a dataset along with their metadata
+     * Get dataset samples
+     */
+    async getDatasetSamplesRaw(requestParameters: GetDatasetSamplesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<Sample>>> {
+        if (requestParameters.projectId === null || requestParameters.projectId === undefined) {
+            throw new runtime.RequiredError('projectId','Required parameter requestParameters.projectId was null or undefined when calling getDatasetSamples.');
+        }
+
+        if (requestParameters.datasetId === null || requestParameters.datasetId === undefined) {
+            throw new runtime.RequiredError('datasetId','Required parameter requestParameters.datasetId was null or undefined when calling getDatasetSamples.');
+        }
+
+        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}/datasets/{datasetId}/samples`.replace(`{${"projectId"}}`, encodeURIComponent(String(requestParameters.projectId))).replace(`{${"datasetId"}}`, encodeURIComponent(String(requestParameters.datasetId))),
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => jsonValue.map(SampleFromJSON));
+    }
+
+    /**
+     * Retrieves a list of samples associated with a dataset along with their metadata
+     * Get dataset samples
+     */
+    async getDatasetSamples(requestParameters: GetDatasetSamplesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<Sample>> {
+        const response = await this.getDatasetSamplesRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
     /**
      * Retrieves a list of samples associated with a project along with their metadata
      * Get project samples

package/src/models/DataFile.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 DataFile
+ */
+export interface DataFile {
+    /**
+     * 
+     * @type {string}
+     * @memberof DataFile
+     */
+    path: string;
+    /**
+     * 
+     * @type {{ [key: string]: any; }}
+     * @memberof DataFile
+     */
+    metadata: { [key: string]: any; };
+}
+
+/**
+ * Check if a given object implements the DataFile interface.
+ */
+export function instanceOfDataFile(value: object): boolean {
+    let isInstance = true;
+    isInstance = isInstance && "path" in value;
+    isInstance = isInstance && "metadata" in value;
+
+    return isInstance;
+}
+
+export function DataFileFromJSON(json: any): DataFile {
+    return DataFileFromJSONTyped(json, false);
+}
+
+export function DataFileFromJSONTyped(json: any, ignoreDiscriminator: boolean): DataFile {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        
+        'path': json['path'],
+        'metadata': json['metadata'],
+    };
+}
+
+export function DataFileToJSON(value?: DataFile | null): any {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        
+        'path': value.path,
+        'metadata': value.metadata,
+    };
+}
+

package/src/models/GovernanceRequirement.ts

@@ -86,6 +86,12 @@ export interface GovernanceRequirement {
      * @memberof GovernanceRequirement
      */
     scope: GovernanceScope;
+    /**
+     * The project ID if the requirement is project scope
+     * @type {string}
+     * @memberof GovernanceRequirement
+     */
+    projectId?: string;
     /**
      * 
      * @type {GovernanceScope}
@@ -190,6 +196,7 @@ export function GovernanceRequirementFromJSONTyped(json: any, ignoreDiscriminato
         'type': GovernanceTypeFromJSON(json['type']),
         'path': json['path'],
         'scope': GovernanceScopeFromJSON(json['scope']),
+        'projectId': !exists(json, 'projectId') ? undefined : json['projectId'],
         'acceptance': !exists(json, 'acceptance') ? undefined : GovernanceScopeFromJSON(json['acceptance']),
         'contactIds': json['contactIds'],
         'expiration': GovernanceExpiryFromJSON(json['expiration']),
@@ -219,6 +226,7 @@ export function GovernanceRequirementToJSON(value?: GovernanceRequirement | null
         'type': GovernanceTypeToJSON(value.type),
         'path': value.path,
         'scope': GovernanceScopeToJSON(value.scope),
+        'projectId': value.projectId,
         'acceptance': GovernanceScopeToJSON(value.acceptance),
         'contactIds': value.contactIds,
         'expiration': GovernanceExpiryToJSON(value.expiration),

package/src/models/Process.ts

@@ -110,6 +110,12 @@ export interface Process {
      * @memberof Process
      */
     allowMultipleSources?: boolean;
+    /**
+     * Whether the pipeline uses the Cirro-provided sample sheet
+     * @type {boolean}
+     * @memberof Process
+     */
+    usesSampleSheet?: boolean;
     /**
      * Whether the pipeline is marked as archived
      * @type {boolean}
@@ -156,6 +162,7 @@ export function ProcessFromJSONTyped(json: any, ignoreDiscriminator: boolean): P
         'owner': !exists(json, 'owner') ? undefined : json['owner'],
         'linkedProjectIds': !exists(json, 'linkedProjectIds') ? undefined : json['linkedProjectIds'],
         'allowMultipleSources': !exists(json, 'allowMultipleSources') ? undefined : json['allowMultipleSources'],
+        'usesSampleSheet': !exists(json, 'usesSampleSheet') ? undefined : json['usesSampleSheet'],
         'isArchived': !exists(json, 'isArchived') ? undefined : json['isArchived'],
     };
 }
@@ -183,6 +190,7 @@ export function ProcessToJSON(value?: Process | null): any {
         'owner': value.owner,
         'linkedProjectIds': value.linkedProjectIds,
         'allowMultipleSources': value.allowMultipleSources,
+        'usesSampleSheet': value.usesSampleSheet,
         'isArchived': value.isArchived,
     };
 }

package/src/models/ProcessDetail.ts

@@ -140,6 +140,12 @@ export interface ProcessDetail {
      * @memberof ProcessDetail
      */
     allowMultipleSources?: boolean;
+    /**
+     * Whether the pipeline uses the Cirro-provided sample sheet
+     * @type {boolean}
+     * @memberof ProcessDetail
+     */
+    usesSampleSheet?: boolean;
     /**
      * 
      * @type {CustomPipelineSettings}
@@ -202,6 +208,7 @@ export function ProcessDetailFromJSONTyped(json: any, ignoreDiscriminator: boole
         'linkedProjectIds': json['linkedProjectIds'],
         'isTenantWide': !exists(json, 'isTenantWide') ? undefined : json['isTenantWide'],
         'allowMultipleSources': !exists(json, 'allowMultipleSources') ? undefined : json['allowMultipleSources'],
+        'usesSampleSheet': !exists(json, 'usesSampleSheet') ? undefined : json['usesSampleSheet'],
         'customSettings': !exists(json, 'customSettings') ? undefined : CustomPipelineSettingsFromJSON(json['customSettings']),
         'isArchived': !exists(json, 'isArchived') ? undefined : json['isArchived'],
         'fileMappingRules': !exists(json, 'fileMappingRules') ? undefined : (json['fileMappingRules'] === null ? null : (json['fileMappingRules'] as Array<any>).map(FileMappingRuleFromJSON)),
@@ -233,6 +240,7 @@ export function ProcessDetailToJSON(value?: ProcessDetail | null): any {
         'linkedProjectIds': value.linkedProjectIds,
         'isTenantWide': value.isTenantWide,
         'allowMultipleSources': value.allowMultipleSources,
+        'usesSampleSheet': value.usesSampleSheet,
         'customSettings': CustomPipelineSettingsToJSON(value.customSettings),
         'isArchived': value.isArchived,
         'fileMappingRules': value.fileMappingRules === undefined ? undefined : (value.fileMappingRules === null ? null : (value.fileMappingRules as Array<any>).map(FileMappingRuleToJSON)),

package/src/models/RequirementInput.ts

@@ -74,6 +74,12 @@ export interface RequirementInput {
      * @memberof RequirementInput
      */
     scope: GovernanceScope;
+    /**
+     * 
+     * @type {string}
+     * @memberof RequirementInput
+     */
+    projectId?: string | null;
     /**
      * 
      * @type {GovernanceScope}
@@ -153,6 +159,7 @@ export function RequirementInputFromJSONTyped(json: any, ignoreDiscriminator: bo
         'description': json['description'],
         'type': GovernanceTypeFromJSON(json['type']),
         'scope': GovernanceScopeFromJSON(json['scope']),
+        'projectId': !exists(json, 'projectId') ? undefined : json['projectId'],
         'acceptance': !exists(json, 'acceptance') ? undefined : GovernanceScopeFromJSON(json['acceptance']),
         'contactIds': json['contactIds'],
         'expiration': GovernanceExpiryFromJSON(json['expiration']),
@@ -177,6 +184,7 @@ export function RequirementInputToJSON(value?: RequirementInput | null): any {
         'description': value.description,
         'type': GovernanceTypeToJSON(value.type),
         'scope': GovernanceScopeToJSON(value.scope),
+        'projectId': value.projectId,
         'acceptance': GovernanceScopeToJSON(value.acceptance),
         'contactIds': value.contactIds,
         'expiration': GovernanceExpiryToJSON(value.expiration),

package/src/models/RunAnalysisRequest.ts

@@ -43,6 +43,12 @@ export interface RunAnalysisRequest {
      * @memberof RunAnalysisRequest
      */
     sourceDatasetIds: Array<string>;
+    /**
+     * Samples within the source datasets that will be used as inputs to this workflow. If not specified, all samples will be used.
+     * @type {Array<string>}
+     * @memberof RunAnalysisRequest
+     */
+    sourceSampleIds?: Array<string> | null;
     /**
      * Used for caching task execution. If the parameters are the same as the dataset specified here, it will re-use the output to minimize duplicate work
      * @type {string}
@@ -97,6 +103,7 @@ export function RunAnalysisRequestFromJSONTyped(json: any, ignoreDiscriminator:
         'description': !exists(json, 'description') ? undefined : json['description'],
         'processId': json['processId'],
         'sourceDatasetIds': json['sourceDatasetIds'],
+        'sourceSampleIds': !exists(json, 'sourceSampleIds') ? undefined : json['sourceSampleIds'],
         'resumeDatasetId': !exists(json, 'resumeDatasetId') ? undefined : json['resumeDatasetId'],
         'params': json['params'],
         'notificationEmails': json['notificationEmails'],
@@ -117,6 +124,7 @@ export function RunAnalysisRequestToJSON(value?: RunAnalysisRequest | null): any
         'description': value.description,
         'processId': value.processId,
         'sourceDatasetIds': value.sourceDatasetIds,
+        'sourceSampleIds': value.sourceSampleIds,
         'resumeDatasetId': value.resumeDatasetId,
         'params': value.params,
         'notificationEmails': value.notificationEmails,

package/src/models/Sample.ts

@@ -13,6 +13,13 @@
  */
 
 import { exists, mapValues } from '../runtime';
+import type { DataFile } from './DataFile';
+import {
+    DataFileFromJSON,
+    DataFileFromJSONTyped,
+    DataFileToJSON,
+} from './DataFile';
+
 /**
  * 
  * @export
@@ -37,6 +44,12 @@ export interface Sample {
      * @memberof Sample
      */
     metadata?: { [key: string]: any; } | null;
+    /**
+     * Files associated with this sample
+     * @type {Array<DataFile>}
+     * @memberof Sample
+     */
+    files?: Array<DataFile> | null;
     /**
      * 
      * @type {Array<string>}
@@ -81,6 +94,7 @@ export function SampleFromJSONTyped(json: any, ignoreDiscriminator: boolean): Sa
         'id': json['id'],
         'name': json['name'],
         'metadata': !exists(json, 'metadata') ? undefined : json['metadata'],
+        'files': !exists(json, 'files') ? undefined : (json['files'] === null ? null : (json['files'] as Array<any>).map(DataFileFromJSON)),
         'datasetIds': !exists(json, 'datasetIds') ? undefined : json['datasetIds'],
         'createdAt': !exists(json, 'createdAt') ? undefined : (json['createdAt'] === null ? null : new Date(json['createdAt'])),
         'updatedAt': !exists(json, 'updatedAt') ? undefined : (json['updatedAt'] === null ? null : new Date(json['updatedAt'])),
@@ -99,6 +113,7 @@ export function SampleToJSON(value?: Sample | null): any {
         'id': value.id,
         'name': value.name,
         'metadata': value.metadata,
+        'files': value.files === undefined ? undefined : (value.files === null ? null : (value.files as Array<any>).map(DataFileToJSON)),
         'datasetIds': value.datasetIds,
         'createdAt': value.createdAt === undefined ? undefined : (value.createdAt === null ? null : value.createdAt.toISOString()),
         'updatedAt': value.updatedAt === undefined ? undefined : (value.updatedAt === null ? null : value.updatedAt.toISOString()),

package/src/models/index.ts

@@ -32,6 +32,7 @@ export * from './CustomPipelineSettings';
 export * from './CustomerType';
 export * from './Dashboard';
 export * from './DashboardRequest';
+export * from './DataFile';
 export * from './Dataset';
 export * from './DatasetAssetsManifest';
 export * from './DatasetCondition';