@cirrobio/api-client 0.0.27-alpha → 0.0.29-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 (47) hide show
  1. package/.openapi-generator/FILES +3 -0
  2. package/README.md +1 -1
  3. package/dist/apis/ProcessesApi.d.ts +54 -1
  4. package/dist/apis/ProcessesApi.js +223 -0
  5. package/dist/models/CustomPipelineSettings.d.ts +8 -8
  6. package/dist/models/CustomPipelineSettings.js +7 -11
  7. package/dist/models/CustomPipelineSettingsDto1.d.ts +61 -0
  8. package/dist/models/CustomPipelineSettingsDto1.js +65 -0
  9. package/dist/models/CustomProcessRequest.d.ts +99 -0
  10. package/dist/models/CustomProcessRequest.js +83 -0
  11. package/dist/models/CustomProcessRequestPipelineCode.d.ts +50 -0
  12. package/dist/models/CustomProcessRequestPipelineCode.js +58 -0
  13. package/dist/models/Executor.d.ts +1 -1
  14. package/dist/models/Executor.js +1 -1
  15. package/dist/models/FileNamePattern.d.ts +0 -6
  16. package/dist/models/FileNamePattern.js +0 -3
  17. package/dist/models/GenerateSftpCredentialsRequest.d.ts +2 -2
  18. package/dist/models/GenerateSftpCredentialsRequest.js +2 -2
  19. package/dist/models/PipelineCode.d.ts +50 -0
  20. package/dist/models/PipelineCode.js +58 -0
  21. package/dist/models/Process.d.ts +3 -3
  22. package/dist/models/Process.js +2 -1
  23. package/dist/models/ProcessDetail.d.ts +10 -3
  24. package/dist/models/ProcessDetail.js +6 -2
  25. package/dist/models/ProcessDetailAllOfPipelineCode.d.ts +50 -0
  26. package/dist/models/ProcessDetailAllOfPipelineCode.js +58 -0
  27. package/dist/models/RepositoryType.d.ts +25 -0
  28. package/dist/models/RepositoryType.js +40 -0
  29. package/dist/models/index.d.ts +3 -0
  30. package/dist/models/index.js +3 -0
  31. package/package.json +1 -1
  32. package/src/apis/ProcessesApi.ts +191 -0
  33. package/src/models/CustomPipelineSettings.ts +14 -19
  34. package/src/models/Executor.ts +1 -1
  35. package/src/models/FileNamePattern.ts +0 -9
  36. package/src/models/GenerateSftpCredentialsRequest.ts +3 -4
  37. package/src/models/PipelineCode.ts +97 -0
  38. package/src/models/Process.ts +5 -4
  39. package/src/models/ProcessDetail.ts +20 -4
  40. package/src/models/ProcessDetailAllOfPipelineCode.ts +97 -0
  41. package/src/models/RepositoryType.ts +39 -0
  42. package/src/models/index.ts +3 -0
  43. package/src/models/CreateDashboardRequest.ts +0 -65
  44. package/src/models/DatasetType.ts +0 -37
  45. package/src/models/Region.ts +0 -65
  46. package/src/models/RegisterDatasetRequest.ts +0 -92
  47. package/src/models/RegisterPublicDataRequest.ts +0 -83
@@ -25,6 +25,12 @@ import {
25
25
  ExecutorFromJSONTyped,
26
26
  ExecutorToJSON,
27
27
  } from './Executor';
28
+ import type { ProcessDetailAllOfPipelineCode } from './ProcessDetailAllOfPipelineCode';
29
+ import {
30
+ ProcessDetailAllOfPipelineCodeFromJSON,
31
+ ProcessDetailAllOfPipelineCodeFromJSONTyped,
32
+ ProcessDetailAllOfPipelineCodeToJSON,
33
+ } from './ProcessDetailAllOfPipelineCode';
28
34
 
29
35
  /**
30
36
  *
@@ -33,7 +39,7 @@ import {
33
39
  */
34
40
  export interface ProcessDetail {
35
41
  /**
36
- * Unique ID of the Process
42
+ *
37
43
  * @type {string}
38
44
  * @memberof ProcessDetail
39
45
  */
@@ -63,11 +69,11 @@ export interface ProcessDetail {
63
69
  */
64
70
  documentationUrl: string;
65
71
  /**
66
- * Description of the files to be uploaded (optional)
72
+ *
67
73
  * @type {string}
68
74
  * @memberof ProcessDetail
69
75
  */
70
- fileRequirementsMessage?: string;
76
+ fileRequirementsMessage: string;
71
77
  /**
72
78
  *
73
79
  * @type {Array<string>}
@@ -92,6 +98,12 @@ export interface ProcessDetail {
92
98
  * @memberof ProcessDetail
93
99
  */
94
100
  linkedProjectIds: Array<string>;
101
+ /**
102
+ *
103
+ * @type {ProcessDetailAllOfPipelineCode}
104
+ * @memberof ProcessDetail
105
+ */
106
+ pipelineCode: ProcessDetailAllOfPipelineCode;
95
107
  /**
96
108
  *
97
109
  * @type {CustomPipelineSettings}
@@ -116,10 +128,12 @@ export function instanceOfProcessDetail(value: object): boolean {
116
128
  isInstance = isInstance && "description" in value;
117
129
  isInstance = isInstance && "executor" in value;
118
130
  isInstance = isInstance && "documentationUrl" in value;
131
+ isInstance = isInstance && "fileRequirementsMessage" in value;
119
132
  isInstance = isInstance && "childProcessIds" in value;
120
133
  isInstance = isInstance && "parentProcessIds" in value;
121
134
  isInstance = isInstance && "owner" in value;
122
135
  isInstance = isInstance && "linkedProjectIds" in value;
136
+ isInstance = isInstance && "pipelineCode" in value;
123
137
  isInstance = isInstance && "customSettings" in value;
124
138
  isInstance = isInstance && "isArchived" in value;
125
139
 
@@ -141,11 +155,12 @@ export function ProcessDetailFromJSONTyped(json: any, ignoreDiscriminator: boole
141
155
  'description': json['description'],
142
156
  'executor': ExecutorFromJSON(json['executor']),
143
157
  'documentationUrl': json['documentationUrl'],
144
- 'fileRequirementsMessage': !exists(json, 'fileRequirementsMessage') ? undefined : json['fileRequirementsMessage'],
158
+ 'fileRequirementsMessage': json['fileRequirementsMessage'],
145
159
  'childProcessIds': json['childProcessIds'],
146
160
  'parentProcessIds': json['parentProcessIds'],
147
161
  'owner': json['owner'],
148
162
  'linkedProjectIds': json['linkedProjectIds'],
163
+ 'pipelineCode': ProcessDetailAllOfPipelineCodeFromJSON(json['pipelineCode']),
149
164
  'customSettings': CustomPipelineSettingsFromJSON(json['customSettings']),
150
165
  'isArchived': json['isArchived'],
151
166
  };
@@ -170,6 +185,7 @@ export function ProcessDetailToJSON(value?: ProcessDetail | null): any {
170
185
  'parentProcessIds': value.parentProcessIds,
171
186
  'owner': value.owner,
172
187
  'linkedProjectIds': value.linkedProjectIds,
188
+ 'pipelineCode': ProcessDetailAllOfPipelineCodeToJSON(value.pipelineCode),
173
189
  'customSettings': CustomPipelineSettingsToJSON(value.customSettings),
174
190
  'isArchived': value.isArchived,
175
191
  };
@@ -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 ProcessDetailAllOfPipelineCode
27
+ */
28
+ export interface ProcessDetailAllOfPipelineCode {
29
+ /**
30
+ * GitHub repository which contains the workflow code
31
+ * @type {string}
32
+ * @memberof ProcessDetailAllOfPipelineCode
33
+ */
34
+ repositoryPath: string;
35
+ /**
36
+ * Branch, tag, or commit hash of the pipeline code
37
+ * @type {string}
38
+ * @memberof ProcessDetailAllOfPipelineCode
39
+ */
40
+ version?: string;
41
+ /**
42
+ *
43
+ * @type {RepositoryType}
44
+ * @memberof ProcessDetailAllOfPipelineCode
45
+ */
46
+ repositoryType?: RepositoryType;
47
+ /**
48
+ * Main script for running the pipeline
49
+ * @type {string}
50
+ * @memberof ProcessDetailAllOfPipelineCode
51
+ */
52
+ entryPoint?: string;
53
+ }
54
+
55
+ /**
56
+ * Check if a given object implements the ProcessDetailAllOfPipelineCode interface.
57
+ */
58
+ export function instanceOfProcessDetailAllOfPipelineCode(value: object): boolean {
59
+ let isInstance = true;
60
+ isInstance = isInstance && "repositoryPath" in value;
61
+
62
+ return isInstance;
63
+ }
64
+
65
+ export function ProcessDetailAllOfPipelineCodeFromJSON(json: any): ProcessDetailAllOfPipelineCode {
66
+ return ProcessDetailAllOfPipelineCodeFromJSONTyped(json, false);
67
+ }
68
+
69
+ export function ProcessDetailAllOfPipelineCodeFromJSONTyped(json: any, ignoreDiscriminator: boolean): ProcessDetailAllOfPipelineCode {
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 ProcessDetailAllOfPipelineCodeToJSON(value?: ProcessDetailAllOfPipelineCode | 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
+
@@ -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
+
@@ -34,8 +34,10 @@ export * from './NotebookInstanceStatusResponse';
34
34
  export * from './OpenNotebookInstanceResponse';
35
35
  export * from './PaginatedResponseDatasetListDto';
36
36
  export * from './PaginatedResponseSampleDto';
37
+ export * from './PipelineCode';
37
38
  export * from './Process';
38
39
  export * from './ProcessDetail';
40
+ export * from './ProcessDetailAllOfPipelineCode';
39
41
  export * from './Project';
40
42
  export * from './ProjectDetail';
41
43
  export * from './ProjectMetrics';
@@ -45,6 +47,7 @@ export * from './ProjectSettings';
45
47
  export * from './ProjectUser';
46
48
  export * from './Reference';
47
49
  export * from './ReferenceType';
50
+ export * from './RepositoryType';
48
51
  export * from './RunAnalysisRequest';
49
52
  export * from './S3Credentials';
50
53
  export * from './Sample';
@@ -1,65 +0,0 @@
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
- /**
17
- *
18
- * @export
19
- * @interface CreateDashboardRequest
20
- */
21
- export interface CreateDashboardRequest {
22
- /**
23
- *
24
- * @type {object}
25
- * @memberof CreateDashboardRequest
26
- */
27
- dashboardRequest?: object;
28
- }
29
-
30
- /**
31
- * Check if a given object implements the CreateDashboardRequest interface.
32
- */
33
- export function instanceOfCreateDashboardRequest(value: object): boolean {
34
- let isInstance = true;
35
-
36
- return isInstance;
37
- }
38
-
39
- export function CreateDashboardRequestFromJSON(json: any): CreateDashboardRequest {
40
- return CreateDashboardRequestFromJSONTyped(json, false);
41
- }
42
-
43
- export function CreateDashboardRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): CreateDashboardRequest {
44
- if ((json === undefined) || (json === null)) {
45
- return json;
46
- }
47
- return {
48
-
49
- 'dashboardRequest': !exists(json, 'dashboardRequest') ? undefined : json['dashboardRequest'],
50
- };
51
- }
52
-
53
- export function CreateDashboardRequestToJSON(value?: CreateDashboardRequest | null): any {
54
- if (value === undefined) {
55
- return undefined;
56
- }
57
- if (value === null) {
58
- return null;
59
- }
60
- return {
61
-
62
- 'dashboardRequest': value.dashboardRequest,
63
- };
64
- }
65
-
@@ -1,37 +0,0 @@
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
- *
17
- * @export
18
- * @enum {string}
19
- */
20
- export enum DatasetType {
21
- Upload = 'UPLOAD',
22
- Public = 'PUBLIC'
23
- }
24
-
25
-
26
- export function DatasetTypeFromJSON(json: any): DatasetType {
27
- return DatasetTypeFromJSONTyped(json, false);
28
- }
29
-
30
- export function DatasetTypeFromJSONTyped(json: any, ignoreDiscriminator: boolean): DatasetType {
31
- return json as DatasetType;
32
- }
33
-
34
- export function DatasetTypeToJSON(value?: DatasetType | null): any {
35
- return value as any;
36
- }
37
-
@@ -1,65 +0,0 @@
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
- /**
17
- *
18
- * @export
19
- * @interface Region
20
- */
21
- export interface Region {
22
- /**
23
- *
24
- * @type {boolean}
25
- * @memberof Region
26
- */
27
- globalRegion?: boolean;
28
- }
29
-
30
- /**
31
- * Check if a given object implements the Region interface.
32
- */
33
- export function instanceOfRegion(value: object): boolean {
34
- let isInstance = true;
35
-
36
- return isInstance;
37
- }
38
-
39
- export function RegionFromJSON(json: any): Region {
40
- return RegionFromJSONTyped(json, false);
41
- }
42
-
43
- export function RegionFromJSONTyped(json: any, ignoreDiscriminator: boolean): Region {
44
- if ((json === undefined) || (json === null)) {
45
- return json;
46
- }
47
- return {
48
-
49
- 'globalRegion': !exists(json, 'globalRegion') ? undefined : json['globalRegion'],
50
- };
51
- }
52
-
53
- export function RegionToJSON(value?: Region | null): any {
54
- if (value === undefined) {
55
- return undefined;
56
- }
57
- if (value === null) {
58
- return null;
59
- }
60
- return {
61
-
62
- 'globalRegion': value.globalRegion,
63
- };
64
- }
65
-
@@ -1,92 +0,0 @@
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
- /**
17
- *
18
- * @export
19
- * @interface RegisterDatasetRequest
20
- */
21
- export interface RegisterDatasetRequest {
22
- /**
23
- *
24
- * @type {string}
25
- * @memberof RegisterDatasetRequest
26
- */
27
- name: string;
28
- /**
29
- *
30
- * @type {string}
31
- * @memberof RegisterDatasetRequest
32
- */
33
- description: string;
34
- /**
35
- *
36
- * @type {string}
37
- * @memberof RegisterDatasetRequest
38
- */
39
- processId: string;
40
- /**
41
- * List of file names (with relative paths) that will be uploaded
42
- * @type {Array<string>}
43
- * @memberof RegisterDatasetRequest
44
- */
45
- expectedFiles?: Array<string>;
46
- }
47
-
48
- /**
49
- * Check if a given object implements the RegisterDatasetRequest interface.
50
- */
51
- export function instanceOfRegisterDatasetRequest(value: object): boolean {
52
- let isInstance = true;
53
- isInstance = isInstance && "name" in value;
54
- isInstance = isInstance && "description" in value;
55
- isInstance = isInstance && "processId" in value;
56
-
57
- return isInstance;
58
- }
59
-
60
- export function RegisterDatasetRequestFromJSON(json: any): RegisterDatasetRequest {
61
- return RegisterDatasetRequestFromJSONTyped(json, false);
62
- }
63
-
64
- export function RegisterDatasetRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): RegisterDatasetRequest {
65
- if ((json === undefined) || (json === null)) {
66
- return json;
67
- }
68
- return {
69
-
70
- 'name': json['name'],
71
- 'description': json['description'],
72
- 'processId': json['processId'],
73
- 'expectedFiles': !exists(json, 'expectedFiles') ? undefined : json['expectedFiles'],
74
- };
75
- }
76
-
77
- export function RegisterDatasetRequestToJSON(value?: RegisterDatasetRequest | null): any {
78
- if (value === undefined) {
79
- return undefined;
80
- }
81
- if (value === null) {
82
- return null;
83
- }
84
- return {
85
-
86
- 'name': value.name,
87
- 'description': value.description,
88
- 'processId': value.processId,
89
- 'expectedFiles': value.expectedFiles,
90
- };
91
- }
92
-
@@ -1,83 +0,0 @@
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
- /**
17
- *
18
- * @export
19
- * @interface RegisterPublicDataRequest
20
- */
21
- export interface RegisterPublicDataRequest {
22
- /**
23
- *
24
- * @type {string}
25
- * @memberof RegisterPublicDataRequest
26
- */
27
- name: string;
28
- /**
29
- *
30
- * @type {string}
31
- * @memberof RegisterPublicDataRequest
32
- */
33
- description: string;
34
- /**
35
- * List of SRA/ENA/DDBJ/GEO/Synapse IDs
36
- * @type {Array<string>}
37
- * @memberof RegisterPublicDataRequest
38
- */
39
- publicIds?: Array<string>;
40
- }
41
-
42
- /**
43
- * Check if a given object implements the RegisterPublicDataRequest interface.
44
- */
45
- export function instanceOfRegisterPublicDataRequest(value: object): boolean {
46
- let isInstance = true;
47
- isInstance = isInstance && "name" in value;
48
- isInstance = isInstance && "description" in value;
49
-
50
- return isInstance;
51
- }
52
-
53
- export function RegisterPublicDataRequestFromJSON(json: any): RegisterPublicDataRequest {
54
- return RegisterPublicDataRequestFromJSONTyped(json, false);
55
- }
56
-
57
- export function RegisterPublicDataRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): RegisterPublicDataRequest {
58
- if ((json === undefined) || (json === null)) {
59
- return json;
60
- }
61
- return {
62
-
63
- 'name': json['name'],
64
- 'description': json['description'],
65
- 'publicIds': !exists(json, 'publicIds') ? undefined : json['publicIds'],
66
- };
67
- }
68
-
69
- export function RegisterPublicDataRequestToJSON(value?: RegisterPublicDataRequest | null): any {
70
- if (value === undefined) {
71
- return undefined;
72
- }
73
- if (value === null) {
74
- return null;
75
- }
76
- return {
77
-
78
- 'name': value.name,
79
- 'description': value.description,
80
- 'publicIds': value.publicIds,
81
- };
82
- }
83
-