@cirrobio/api-client 0.0.26-alpha → 0.0.28-alpha

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (38) hide show
  1. package/.openapi-generator/FILES +7 -2
  2. package/README.md +1 -1
  3. package/dist/apis/ProcessesApi.d.ts +60 -7
  4. package/dist/apis/ProcessesApi.js +234 -11
  5. package/dist/models/CustomPipelineSettingsDto1.d.ts +61 -0
  6. package/dist/models/CustomPipelineSettingsDto1.js +65 -0
  7. package/dist/models/CustomProcessRequest.d.ts +99 -0
  8. package/dist/models/CustomProcessRequest.js +83 -0
  9. package/dist/models/CustomProcessRequestPipelineCode.d.ts +50 -0
  10. package/dist/models/CustomProcessRequestPipelineCode.js +58 -0
  11. package/dist/models/FileNamePattern.d.ts +0 -6
  12. package/dist/models/FileNamePattern.js +0 -3
  13. package/dist/models/FileRequirements.d.ts +44 -0
  14. package/dist/models/FileRequirements.js +57 -0
  15. package/dist/models/GenerateSftpCredentialsRequest.d.ts +2 -2
  16. package/dist/models/GenerateSftpCredentialsRequest.js +2 -2
  17. package/dist/models/PipelineCode.d.ts +50 -0
  18. package/dist/models/PipelineCode.js +58 -0
  19. package/dist/models/ProcessDetail.d.ts +1 -1
  20. package/dist/models/RepositoryType.d.ts +25 -0
  21. package/dist/models/RepositoryType.js +40 -0
  22. package/dist/models/ValidateFileRequirementsRequest.d.ts +37 -0
  23. package/dist/models/ValidateFileRequirementsRequest.js +53 -0
  24. package/dist/models/index.d.ts +7 -2
  25. package/dist/models/index.js +7 -2
  26. package/package.json +1 -1
  27. package/src/apis/ProcessesApi.ts +213 -19
  28. package/src/models/CustomPipelineSettingsDto1.ts +111 -0
  29. package/src/models/CustomProcessRequest.ts +175 -0
  30. package/src/models/CustomProcessRequestPipelineCode.ts +97 -0
  31. package/src/models/FileNamePattern.ts +0 -9
  32. package/src/models/{ValidateDataInputsResponse.ts → FileRequirements.ts} +11 -11
  33. package/src/models/GenerateSftpCredentialsRequest.ts +3 -4
  34. package/src/models/PipelineCode.ts +97 -0
  35. package/src/models/ProcessDetail.ts +1 -1
  36. package/src/models/RepositoryType.ts +39 -0
  37. package/src/models/{ValidateDataInputsRequest.ts → ValidateFileRequirementsRequest.ts} +10 -10
  38. package/src/models/index.ts +7 -2
@@ -0,0 +1,97 @@
1
+ /* tslint:disable */
2
+ /* eslint-disable */
3
+ /**
4
+ * Cirro Data
5
+ * Cirro Data Platform service API
6
+ *
7
+ * The version of the OpenAPI document: latest
8
+ * Contact: support@cirro.bio
9
+ *
10
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
11
+ * https://openapi-generator.tech
12
+ * Do not edit the class manually.
13
+ */
14
+
15
+ import { exists, mapValues } from '../runtime';
16
+ import type { RepositoryType } from './RepositoryType';
17
+ import {
18
+ RepositoryTypeFromJSON,
19
+ RepositoryTypeFromJSONTyped,
20
+ RepositoryTypeToJSON,
21
+ } from './RepositoryType';
22
+
23
+ /**
24
+ *
25
+ * @export
26
+ * @interface CustomProcessRequestPipelineCode
27
+ */
28
+ export interface CustomProcessRequestPipelineCode {
29
+ /**
30
+ * GitHub repository which contains the workflow code
31
+ * @type {string}
32
+ * @memberof CustomProcessRequestPipelineCode
33
+ */
34
+ repositoryPath: string;
35
+ /**
36
+ * Branch, tag, or commit hash of the pipeline code
37
+ * @type {string}
38
+ * @memberof CustomProcessRequestPipelineCode
39
+ */
40
+ version?: string;
41
+ /**
42
+ *
43
+ * @type {RepositoryType}
44
+ * @memberof CustomProcessRequestPipelineCode
45
+ */
46
+ repositoryType?: RepositoryType;
47
+ /**
48
+ * Main script for running the pipeline
49
+ * @type {string}
50
+ * @memberof CustomProcessRequestPipelineCode
51
+ */
52
+ entryPoint?: string;
53
+ }
54
+
55
+ /**
56
+ * Check if a given object implements the CustomProcessRequestPipelineCode interface.
57
+ */
58
+ export function instanceOfCustomProcessRequestPipelineCode(value: object): boolean {
59
+ let isInstance = true;
60
+ isInstance = isInstance && "repositoryPath" in value;
61
+
62
+ return isInstance;
63
+ }
64
+
65
+ export function CustomProcessRequestPipelineCodeFromJSON(json: any): CustomProcessRequestPipelineCode {
66
+ return CustomProcessRequestPipelineCodeFromJSONTyped(json, false);
67
+ }
68
+
69
+ export function CustomProcessRequestPipelineCodeFromJSONTyped(json: any, ignoreDiscriminator: boolean): CustomProcessRequestPipelineCode {
70
+ if ((json === undefined) || (json === null)) {
71
+ return json;
72
+ }
73
+ return {
74
+
75
+ 'repositoryPath': json['repositoryPath'],
76
+ 'version': !exists(json, 'version') ? undefined : json['version'],
77
+ 'repositoryType': !exists(json, 'repositoryType') ? undefined : RepositoryTypeFromJSON(json['repositoryType']),
78
+ 'entryPoint': !exists(json, 'entryPoint') ? undefined : json['entryPoint'],
79
+ };
80
+ }
81
+
82
+ export function CustomProcessRequestPipelineCodeToJSON(value?: CustomProcessRequestPipelineCode | null): any {
83
+ if (value === undefined) {
84
+ return undefined;
85
+ }
86
+ if (value === null) {
87
+ return null;
88
+ }
89
+ return {
90
+
91
+ 'repositoryPath': value.repositoryPath,
92
+ 'version': value.version,
93
+ 'repositoryType': RepositoryTypeToJSON(value.repositoryType),
94
+ 'entryPoint': value.entryPoint,
95
+ };
96
+ }
97
+
@@ -31,12 +31,6 @@ export interface FileNamePattern {
31
31
  * @memberof FileNamePattern
32
32
  */
33
33
  description: string;
34
- /**
35
- *
36
- * @type {string}
37
- * @memberof FileNamePattern
38
- */
39
- sampleMatchingPattern: string;
40
34
  }
41
35
 
42
36
  /**
@@ -46,7 +40,6 @@ export function instanceOfFileNamePattern(value: object): boolean {
46
40
  let isInstance = true;
47
41
  isInstance = isInstance && "exampleName" in value;
48
42
  isInstance = isInstance && "description" in value;
49
- isInstance = isInstance && "sampleMatchingPattern" in value;
50
43
 
51
44
  return isInstance;
52
45
  }
@@ -63,7 +56,6 @@ export function FileNamePatternFromJSONTyped(json: any, ignoreDiscriminator: boo
63
56
 
64
57
  'exampleName': json['exampleName'],
65
58
  'description': json['description'],
66
- 'sampleMatchingPattern': json['sampleMatchingPattern'],
67
59
  };
68
60
  }
69
61
 
@@ -78,7 +70,6 @@ export function FileNamePatternToJSON(value?: FileNamePattern | null): any {
78
70
 
79
71
  'exampleName': value.exampleName,
80
72
  'description': value.description,
81
- 'sampleMatchingPattern': value.sampleMatchingPattern,
82
73
  };
83
74
  }
84
75
 
@@ -23,33 +23,33 @@ import {
23
23
  /**
24
24
  *
25
25
  * @export
26
- * @interface ValidateDataInputsResponse
26
+ * @interface FileRequirements
27
27
  */
28
- export interface ValidateDataInputsResponse {
28
+ export interface FileRequirements {
29
29
  /**
30
30
  *
31
31
  * @type {Array<string>}
32
- * @memberof ValidateDataInputsResponse
32
+ * @memberof FileRequirements
33
33
  */
34
34
  files: Array<string>;
35
35
  /**
36
36
  *
37
37
  * @type {string}
38
- * @memberof ValidateDataInputsResponse
38
+ * @memberof FileRequirements
39
39
  */
40
40
  errorMsg: string;
41
41
  /**
42
42
  *
43
43
  * @type {Array<AllowedDataType>}
44
- * @memberof ValidateDataInputsResponse
44
+ * @memberof FileRequirements
45
45
  */
46
46
  allowedDataTypes: Array<AllowedDataType>;
47
47
  }
48
48
 
49
49
  /**
50
- * Check if a given object implements the ValidateDataInputsResponse interface.
50
+ * Check if a given object implements the FileRequirements interface.
51
51
  */
52
- export function instanceOfValidateDataInputsResponse(value: object): boolean {
52
+ export function instanceOfFileRequirements(value: object): boolean {
53
53
  let isInstance = true;
54
54
  isInstance = isInstance && "files" in value;
55
55
  isInstance = isInstance && "errorMsg" in value;
@@ -58,11 +58,11 @@ export function instanceOfValidateDataInputsResponse(value: object): boolean {
58
58
  return isInstance;
59
59
  }
60
60
 
61
- export function ValidateDataInputsResponseFromJSON(json: any): ValidateDataInputsResponse {
62
- return ValidateDataInputsResponseFromJSONTyped(json, false);
61
+ export function FileRequirementsFromJSON(json: any): FileRequirements {
62
+ return FileRequirementsFromJSONTyped(json, false);
63
63
  }
64
64
 
65
- export function ValidateDataInputsResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): ValidateDataInputsResponse {
65
+ export function FileRequirementsFromJSONTyped(json: any, ignoreDiscriminator: boolean): FileRequirements {
66
66
  if ((json === undefined) || (json === null)) {
67
67
  return json;
68
68
  }
@@ -74,7 +74,7 @@ export function ValidateDataInputsResponseFromJSONTyped(json: any, ignoreDiscrim
74
74
  };
75
75
  }
76
76
 
77
- export function ValidateDataInputsResponseToJSON(value?: ValidateDataInputsResponse | null): any {
77
+ export function FileRequirementsToJSON(value?: FileRequirements | null): any {
78
78
  if (value === undefined) {
79
79
  return undefined;
80
80
  }
@@ -20,11 +20,11 @@ import { exists, mapValues } from '../runtime';
20
20
  */
21
21
  export interface GenerateSftpCredentialsRequest {
22
22
  /**
23
- *
23
+ * Number of days the credentials are valid for
24
24
  * @type {number}
25
25
  * @memberof GenerateSftpCredentialsRequest
26
26
  */
27
- lifetimeDays: number;
27
+ lifetimeDays?: number;
28
28
  }
29
29
 
30
30
  /**
@@ -32,7 +32,6 @@ export interface GenerateSftpCredentialsRequest {
32
32
  */
33
33
  export function instanceOfGenerateSftpCredentialsRequest(value: object): boolean {
34
34
  let isInstance = true;
35
- isInstance = isInstance && "lifetimeDays" in value;
36
35
 
37
36
  return isInstance;
38
37
  }
@@ -47,7 +46,7 @@ export function GenerateSftpCredentialsRequestFromJSONTyped(json: any, ignoreDis
47
46
  }
48
47
  return {
49
48
 
50
- 'lifetimeDays': json['lifetimeDays'],
49
+ 'lifetimeDays': !exists(json, 'lifetimeDays') ? undefined : json['lifetimeDays'],
51
50
  };
52
51
  }
53
52
 
@@ -0,0 +1,97 @@
1
+ /* tslint:disable */
2
+ /* eslint-disable */
3
+ /**
4
+ * Cirro Data
5
+ * Cirro Data Platform service API
6
+ *
7
+ * The version of the OpenAPI document: latest
8
+ * Contact: support@cirro.bio
9
+ *
10
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
11
+ * https://openapi-generator.tech
12
+ * Do not edit the class manually.
13
+ */
14
+
15
+ import { exists, mapValues } from '../runtime';
16
+ import type { RepositoryType } from './RepositoryType';
17
+ import {
18
+ RepositoryTypeFromJSON,
19
+ RepositoryTypeFromJSONTyped,
20
+ RepositoryTypeToJSON,
21
+ } from './RepositoryType';
22
+
23
+ /**
24
+ * Used to describe the pipeline analysis code
25
+ * @export
26
+ * @interface PipelineCode
27
+ */
28
+ export interface PipelineCode {
29
+ /**
30
+ * GitHub repository which contains the workflow code
31
+ * @type {string}
32
+ * @memberof PipelineCode
33
+ */
34
+ repositoryPath: string;
35
+ /**
36
+ * Branch, tag, or commit hash of the pipeline code
37
+ * @type {string}
38
+ * @memberof PipelineCode
39
+ */
40
+ version?: string;
41
+ /**
42
+ *
43
+ * @type {RepositoryType}
44
+ * @memberof PipelineCode
45
+ */
46
+ repositoryType?: RepositoryType;
47
+ /**
48
+ * Main script for running the pipeline
49
+ * @type {string}
50
+ * @memberof PipelineCode
51
+ */
52
+ entryPoint?: string;
53
+ }
54
+
55
+ /**
56
+ * Check if a given object implements the PipelineCode interface.
57
+ */
58
+ export function instanceOfPipelineCode(value: object): boolean {
59
+ let isInstance = true;
60
+ isInstance = isInstance && "repositoryPath" in value;
61
+
62
+ return isInstance;
63
+ }
64
+
65
+ export function PipelineCodeFromJSON(json: any): PipelineCode {
66
+ return PipelineCodeFromJSONTyped(json, false);
67
+ }
68
+
69
+ export function PipelineCodeFromJSONTyped(json: any, ignoreDiscriminator: boolean): PipelineCode {
70
+ if ((json === undefined) || (json === null)) {
71
+ return json;
72
+ }
73
+ return {
74
+
75
+ 'repositoryPath': json['repositoryPath'],
76
+ 'version': !exists(json, 'version') ? undefined : json['version'],
77
+ 'repositoryType': !exists(json, 'repositoryType') ? undefined : RepositoryTypeFromJSON(json['repositoryType']),
78
+ 'entryPoint': !exists(json, 'entryPoint') ? undefined : json['entryPoint'],
79
+ };
80
+ }
81
+
82
+ export function PipelineCodeToJSON(value?: PipelineCode | null): any {
83
+ if (value === undefined) {
84
+ return undefined;
85
+ }
86
+ if (value === null) {
87
+ return null;
88
+ }
89
+ return {
90
+
91
+ 'repositoryPath': value.repositoryPath,
92
+ 'version': value.version,
93
+ 'repositoryType': RepositoryTypeToJSON(value.repositoryType),
94
+ 'entryPoint': value.entryPoint,
95
+ };
96
+ }
97
+
@@ -33,7 +33,7 @@ import {
33
33
  */
34
34
  export interface ProcessDetail {
35
35
  /**
36
- * Unique ID of the Process
36
+ *
37
37
  * @type {string}
38
38
  * @memberof ProcessDetail
39
39
  */
@@ -0,0 +1,39 @@
1
+ /* tslint:disable */
2
+ /* eslint-disable */
3
+ /**
4
+ * Cirro Data
5
+ * Cirro Data Platform service API
6
+ *
7
+ * The version of the OpenAPI document: latest
8
+ * Contact: support@cirro.bio
9
+ *
10
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
11
+ * https://openapi-generator.tech
12
+ * Do not edit the class manually.
13
+ */
14
+
15
+ /**
16
+ * Type of repository
17
+ * @export
18
+ * @enum {string}
19
+ */
20
+ export enum RepositoryType {
21
+ None = 'NONE',
22
+ Aws = 'AWS',
23
+ GithubPublic = 'GITHUB_PUBLIC',
24
+ GithubPrivate = 'GITHUB_PRIVATE'
25
+ }
26
+
27
+
28
+ export function RepositoryTypeFromJSON(json: any): RepositoryType {
29
+ return RepositoryTypeFromJSONTyped(json, false);
30
+ }
31
+
32
+ export function RepositoryTypeFromJSONTyped(json: any, ignoreDiscriminator: boolean): RepositoryType {
33
+ return json as RepositoryType;
34
+ }
35
+
36
+ export function RepositoryTypeToJSON(value?: RepositoryType | null): any {
37
+ return value as any;
38
+ }
39
+
@@ -16,27 +16,27 @@ import { exists, mapValues } from '../runtime';
16
16
  /**
17
17
  *
18
18
  * @export
19
- * @interface ValidateDataInputsRequest
19
+ * @interface ValidateFileRequirementsRequest
20
20
  */
21
- export interface ValidateDataInputsRequest {
21
+ export interface ValidateFileRequirementsRequest {
22
22
  /**
23
23
  *
24
24
  * @type {string}
25
- * @memberof ValidateDataInputsRequest
25
+ * @memberof ValidateFileRequirementsRequest
26
26
  */
27
27
  sampleSheet: string;
28
28
  /**
29
29
  *
30
30
  * @type {Array<string>}
31
- * @memberof ValidateDataInputsRequest
31
+ * @memberof ValidateFileRequirementsRequest
32
32
  */
33
33
  fileNames: Array<string>;
34
34
  }
35
35
 
36
36
  /**
37
- * Check if a given object implements the ValidateDataInputsRequest interface.
37
+ * Check if a given object implements the ValidateFileRequirementsRequest interface.
38
38
  */
39
- export function instanceOfValidateDataInputsRequest(value: object): boolean {
39
+ export function instanceOfValidateFileRequirementsRequest(value: object): boolean {
40
40
  let isInstance = true;
41
41
  isInstance = isInstance && "sampleSheet" in value;
42
42
  isInstance = isInstance && "fileNames" in value;
@@ -44,11 +44,11 @@ export function instanceOfValidateDataInputsRequest(value: object): boolean {
44
44
  return isInstance;
45
45
  }
46
46
 
47
- export function ValidateDataInputsRequestFromJSON(json: any): ValidateDataInputsRequest {
48
- return ValidateDataInputsRequestFromJSONTyped(json, false);
47
+ export function ValidateFileRequirementsRequestFromJSON(json: any): ValidateFileRequirementsRequest {
48
+ return ValidateFileRequirementsRequestFromJSONTyped(json, false);
49
49
  }
50
50
 
51
- export function ValidateDataInputsRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): ValidateDataInputsRequest {
51
+ export function ValidateFileRequirementsRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): ValidateFileRequirementsRequest {
52
52
  if ((json === undefined) || (json === null)) {
53
53
  return json;
54
54
  }
@@ -59,7 +59,7 @@ export function ValidateDataInputsRequestFromJSONTyped(json: any, ignoreDiscrimi
59
59
  };
60
60
  }
61
61
 
62
- export function ValidateDataInputsRequestToJSON(value?: ValidateDataInputsRequest | null): any {
62
+ export function ValidateFileRequirementsRequestToJSON(value?: ValidateFileRequirementsRequest | null): any {
63
63
  if (value === undefined) {
64
64
  return undefined;
65
65
  }
@@ -10,6 +10,9 @@ export * from './Contact';
10
10
  export * from './CreateNotebookInstanceRequest';
11
11
  export * from './CreateResponse';
12
12
  export * from './CustomPipelineSettings';
13
+ export * from './CustomPipelineSettingsDto1';
14
+ export * from './CustomProcessRequest';
15
+ export * from './CustomProcessRequestPipelineCode';
13
16
  export * from './CustomerType';
14
17
  export * from './Dashboard';
15
18
  export * from './DashboardRequest';
@@ -20,6 +23,7 @@ export * from './DatasetFile';
20
23
  export * from './DatasetViz';
21
24
  export * from './Executor';
22
25
  export * from './FileNamePattern';
26
+ export * from './FileRequirements';
23
27
  export * from './FormSchema';
24
28
  export * from './GenerateSftpCredentialsRequest';
25
29
  export * from './GetExecutionLogsResponse';
@@ -33,6 +37,7 @@ export * from './NotebookInstanceStatusResponse';
33
37
  export * from './OpenNotebookInstanceResponse';
34
38
  export * from './PaginatedResponseDatasetListDto';
35
39
  export * from './PaginatedResponseSampleDto';
40
+ export * from './PipelineCode';
36
41
  export * from './Process';
37
42
  export * from './ProcessDetail';
38
43
  export * from './Project';
@@ -44,6 +49,7 @@ export * from './ProjectSettings';
44
49
  export * from './ProjectUser';
45
50
  export * from './Reference';
46
51
  export * from './ReferenceType';
52
+ export * from './RepositoryType';
47
53
  export * from './RunAnalysisRequest';
48
54
  export * from './S3Credentials';
49
55
  export * from './Sample';
@@ -61,5 +67,4 @@ export * from './UpdateUserRequest';
61
67
  export * from './UploadDatasetCreateResponse';
62
68
  export * from './UploadDatasetRequest';
63
69
  export * from './User';
64
- export * from './ValidateDataInputsRequest';
65
- export * from './ValidateDataInputsResponse';
70
+ export * from './ValidateFileRequirementsRequest';