@cirrobio/api-client 0.0.3-alpha → 0.0.5-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 (53) hide show
  1. package/.openapi-generator/FILES +6 -0
  2. package/README.md +1 -1
  3. package/dist/apis/MetadataApi.d.ts +29 -0
  4. package/dist/apis/MetadataApi.js +133 -0
  5. package/dist/apis/NotebooksApi.js +6 -6
  6. package/dist/apis/ProcessesApi.d.ts +26 -10
  7. package/dist/apis/ProcessesApi.js +70 -11
  8. package/dist/apis/ProjectsApi.d.ts +4 -4
  9. package/dist/apis/ProjectsApi.js +4 -4
  10. package/dist/apis/ReferencesApi.d.ts +51 -0
  11. package/dist/apis/ReferencesApi.js +239 -0
  12. package/dist/apis/SystemApi.d.ts +1 -11
  13. package/dist/apis/SystemApi.js +0 -52
  14. package/dist/apis/index.d.ts +2 -0
  15. package/dist/apis/index.js +2 -0
  16. package/dist/models/CustomPipelineSettings.d.ts +61 -0
  17. package/dist/models/CustomPipelineSettings.js +60 -0
  18. package/dist/models/Process.d.ts +19 -1
  19. package/dist/models/Process.js +8 -1
  20. package/dist/models/ProcessDetail.d.ts +99 -0
  21. package/dist/models/ProcessDetail.js +85 -0
  22. package/dist/models/ProjectMetrics.d.ts +8 -6
  23. package/dist/models/ProjectMetrics.js +3 -4
  24. package/dist/models/ProjectSettings.d.ts +24 -0
  25. package/dist/models/ProjectSettings.js +8 -0
  26. package/dist/models/Reference.d.ts +55 -0
  27. package/dist/models/Reference.js +62 -0
  28. package/dist/models/ReferenceType.d.ts +20 -0
  29. package/dist/models/ReferenceType.js +9 -0
  30. package/dist/models/Sample.d.ts +39 -0
  31. package/dist/models/Sample.js +53 -0
  32. package/dist/models/ServiceConnection.d.ts +6 -0
  33. package/dist/models/ServiceConnection.js +3 -0
  34. package/dist/models/index.d.ts +4 -0
  35. package/dist/models/index.js +4 -0
  36. package/package.json +1 -1
  37. package/src/apis/MetadataApi.ts +72 -0
  38. package/src/apis/NotebooksApi.ts +6 -6
  39. package/src/apis/ProcessesApi.ts +67 -12
  40. package/src/apis/ProjectsApi.ts +4 -4
  41. package/src/apis/ReferencesApi.ts +149 -0
  42. package/src/apis/SystemApi.ts +0 -39
  43. package/src/apis/index.ts +2 -0
  44. package/src/models/CustomPipelineSettings.ts +105 -0
  45. package/src/models/Process.ts +27 -2
  46. package/src/models/ProcessDetail.ts +177 -0
  47. package/src/models/ProjectMetrics.ts +7 -9
  48. package/src/models/ProjectSettings.ts +32 -0
  49. package/src/models/Reference.ts +102 -0
  50. package/src/models/ReferenceType.ts +27 -0
  51. package/src/models/Sample.ts +75 -0
  52. package/src/models/ServiceConnection.ts +9 -0
  53. package/src/models/index.ts +4 -0
@@ -0,0 +1,177 @@
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 { CustomPipelineSettings } from './CustomPipelineSettings';
17
+ import {
18
+ CustomPipelineSettingsFromJSON,
19
+ CustomPipelineSettingsFromJSONTyped,
20
+ CustomPipelineSettingsToJSON,
21
+ } from './CustomPipelineSettings';
22
+ import type { Executor } from './Executor';
23
+ import {
24
+ ExecutorFromJSON,
25
+ ExecutorFromJSONTyped,
26
+ ExecutorToJSON,
27
+ } from './Executor';
28
+
29
+ /**
30
+ *
31
+ * @export
32
+ * @interface ProcessDetail
33
+ */
34
+ export interface ProcessDetail {
35
+ /**
36
+ * Unique ID of the Process
37
+ * @type {string}
38
+ * @memberof ProcessDetail
39
+ */
40
+ id: string;
41
+ /**
42
+ *
43
+ * @type {string}
44
+ * @memberof ProcessDetail
45
+ */
46
+ name: string;
47
+ /**
48
+ *
49
+ * @type {string}
50
+ * @memberof ProcessDetail
51
+ */
52
+ description: string;
53
+ /**
54
+ *
55
+ * @type {Executor}
56
+ * @memberof ProcessDetail
57
+ */
58
+ executor: Executor;
59
+ /**
60
+ *
61
+ * @type {string}
62
+ * @memberof ProcessDetail
63
+ */
64
+ documentationUrl: string;
65
+ /**
66
+ * Description of the files to be uploaded (optional)
67
+ * @type {string}
68
+ * @memberof ProcessDetail
69
+ */
70
+ fileRequirementsMessage?: string;
71
+ /**
72
+ *
73
+ * @type {Array<string>}
74
+ * @memberof ProcessDetail
75
+ */
76
+ childProcessIds: Array<string>;
77
+ /**
78
+ *
79
+ * @type {Array<string>}
80
+ * @memberof ProcessDetail
81
+ */
82
+ parentProcessIds: Array<string>;
83
+ /**
84
+ *
85
+ * @type {string}
86
+ * @memberof ProcessDetail
87
+ */
88
+ owner: string;
89
+ /**
90
+ *
91
+ * @type {Array<string>}
92
+ * @memberof ProcessDetail
93
+ */
94
+ linkedProjectIds: Array<string>;
95
+ /**
96
+ *
97
+ * @type {CustomPipelineSettings}
98
+ * @memberof ProcessDetail
99
+ */
100
+ customSettings: CustomPipelineSettings;
101
+ /**
102
+ *
103
+ * @type {boolean}
104
+ * @memberof ProcessDetail
105
+ */
106
+ isArchived: boolean;
107
+ }
108
+
109
+ /**
110
+ * Check if a given object implements the ProcessDetail interface.
111
+ */
112
+ export function instanceOfProcessDetail(value: object): boolean {
113
+ let isInstance = true;
114
+ isInstance = isInstance && "id" in value;
115
+ isInstance = isInstance && "name" in value;
116
+ isInstance = isInstance && "description" in value;
117
+ isInstance = isInstance && "executor" in value;
118
+ isInstance = isInstance && "documentationUrl" in value;
119
+ isInstance = isInstance && "childProcessIds" in value;
120
+ isInstance = isInstance && "parentProcessIds" in value;
121
+ isInstance = isInstance && "owner" in value;
122
+ isInstance = isInstance && "linkedProjectIds" in value;
123
+ isInstance = isInstance && "customSettings" in value;
124
+ isInstance = isInstance && "isArchived" in value;
125
+
126
+ return isInstance;
127
+ }
128
+
129
+ export function ProcessDetailFromJSON(json: any): ProcessDetail {
130
+ return ProcessDetailFromJSONTyped(json, false);
131
+ }
132
+
133
+ export function ProcessDetailFromJSONTyped(json: any, ignoreDiscriminator: boolean): ProcessDetail {
134
+ if ((json === undefined) || (json === null)) {
135
+ return json;
136
+ }
137
+ return {
138
+
139
+ 'id': json['id'],
140
+ 'name': json['name'],
141
+ 'description': json['description'],
142
+ 'executor': ExecutorFromJSON(json['executor']),
143
+ 'documentationUrl': json['documentationUrl'],
144
+ 'fileRequirementsMessage': !exists(json, 'fileRequirementsMessage') ? undefined : json['fileRequirementsMessage'],
145
+ 'childProcessIds': json['childProcessIds'],
146
+ 'parentProcessIds': json['parentProcessIds'],
147
+ 'owner': json['owner'],
148
+ 'linkedProjectIds': json['linkedProjectIds'],
149
+ 'customSettings': CustomPipelineSettingsFromJSON(json['customSettings']),
150
+ 'isArchived': json['isArchived'],
151
+ };
152
+ }
153
+
154
+ export function ProcessDetailToJSON(value?: ProcessDetail | null): any {
155
+ if (value === undefined) {
156
+ return undefined;
157
+ }
158
+ if (value === null) {
159
+ return null;
160
+ }
161
+ return {
162
+
163
+ 'id': value.id,
164
+ 'name': value.name,
165
+ 'description': value.description,
166
+ 'executor': ExecutorToJSON(value.executor),
167
+ 'documentationUrl': value.documentationUrl,
168
+ 'fileRequirementsMessage': value.fileRequirementsMessage,
169
+ 'childProcessIds': value.childProcessIds,
170
+ 'parentProcessIds': value.parentProcessIds,
171
+ 'owner': value.owner,
172
+ 'linkedProjectIds': value.linkedProjectIds,
173
+ 'customSettings': CustomPipelineSettingsToJSON(value.customSettings),
174
+ 'isArchived': value.isArchived,
175
+ };
176
+ }
177
+
@@ -26,17 +26,17 @@ export interface ProjectMetrics {
26
26
  */
27
27
  projectId: string;
28
28
  /**
29
- *
30
- * @type {{ [key: string]: any; }}
29
+ * Costs by service by month
30
+ * @type {{ [key: string]: { [key: string]: number; }; }}
31
31
  * @memberof ProjectMetrics
32
32
  */
33
- costs: { [key: string]: any; };
33
+ costs?: { [key: string]: { [key: string]: number; }; };
34
34
  /**
35
- *
35
+ * Storage usage by tier by day
36
36
  * @type {{ [key: string]: any; }}
37
37
  * @memberof ProjectMetrics
38
38
  */
39
- storageMetrics: { [key: string]: any; };
39
+ storageMetrics?: { [key: string]: any; };
40
40
  }
41
41
 
42
42
  /**
@@ -45,8 +45,6 @@ export interface ProjectMetrics {
45
45
  export function instanceOfProjectMetrics(value: object): boolean {
46
46
  let isInstance = true;
47
47
  isInstance = isInstance && "projectId" in value;
48
- isInstance = isInstance && "costs" in value;
49
- isInstance = isInstance && "storageMetrics" in value;
50
48
 
51
49
  return isInstance;
52
50
  }
@@ -62,8 +60,8 @@ export function ProjectMetricsFromJSONTyped(json: any, ignoreDiscriminator: bool
62
60
  return {
63
61
 
64
62
  'projectId': json['projectId'],
65
- 'costs': json['costs'],
66
- 'storageMetrics': json['storageMetrics'],
63
+ 'costs': !exists(json, 'costs') ? undefined : json['costs'],
64
+ 'storageMetrics': !exists(json, 'storageMetrics') ? undefined : json['storageMetrics'],
67
65
  };
68
66
  }
69
67
 
@@ -92,6 +92,30 @@ export interface ProjectSettings {
92
92
  * @memberof ProjectSettings
93
93
  */
94
94
  serviceConnections?: Array<string>;
95
+ /**
96
+ *
97
+ * @type {boolean}
98
+ * @memberof ProjectSettings
99
+ */
100
+ createVpc?: boolean;
101
+ /**
102
+ *
103
+ * @type {string}
104
+ * @memberof ProjectSettings
105
+ */
106
+ vpcId?: string;
107
+ /**
108
+ *
109
+ * @type {Array<string>}
110
+ * @memberof ProjectSettings
111
+ */
112
+ batchSubnets?: Array<string>;
113
+ /**
114
+ *
115
+ * @type {string}
116
+ * @memberof ProjectSettings
117
+ */
118
+ kmsArn?: string;
95
119
  }
96
120
 
97
121
  /**
@@ -124,6 +148,10 @@ export function ProjectSettingsFromJSONTyped(json: any, ignoreDiscriminator: boo
124
148
  'maxSpotVCPU': !exists(json, 'maxSpotVCPU') ? undefined : json['maxSpotVCPU'],
125
149
  'retentionPolicyDays': !exists(json, 'retentionPolicyDays') ? undefined : json['retentionPolicyDays'],
126
150
  'serviceConnections': !exists(json, 'serviceConnections') ? undefined : json['serviceConnections'],
151
+ 'createVpc': !exists(json, 'createVpc') ? undefined : json['createVpc'],
152
+ 'vpcId': !exists(json, 'vpcId') ? undefined : json['vpcId'],
153
+ 'batchSubnets': !exists(json, 'batchSubnets') ? undefined : json['batchSubnets'],
154
+ 'kmsArn': !exists(json, 'kmsArn') ? undefined : json['kmsArn'],
127
155
  };
128
156
  }
129
157
 
@@ -147,6 +175,10 @@ export function ProjectSettingsToJSON(value?: ProjectSettings | null): any {
147
175
  'maxSpotVCPU': value.maxSpotVCPU,
148
176
  'retentionPolicyDays': value.retentionPolicyDays,
149
177
  'serviceConnections': value.serviceConnections,
178
+ 'createVpc': value.createVpc,
179
+ 'vpcId': value.vpcId,
180
+ 'batchSubnets': value.batchSubnets,
181
+ 'kmsArn': value.kmsArn,
150
182
  };
151
183
  }
152
184
 
@@ -0,0 +1,102 @@
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 Reference
20
+ */
21
+ export interface Reference {
22
+ /**
23
+ *
24
+ * @type {string}
25
+ * @memberof Reference
26
+ */
27
+ name: string;
28
+ /**
29
+ *
30
+ * @type {string}
31
+ * @memberof Reference
32
+ */
33
+ referenceType: string;
34
+ /**
35
+ *
36
+ * @type {Array<string>}
37
+ * @memberof Reference
38
+ */
39
+ files: Array<string>;
40
+ /**
41
+ *
42
+ * @type {string}
43
+ * @memberof Reference
44
+ */
45
+ createdBy: string;
46
+ /**
47
+ *
48
+ * @type {Date}
49
+ * @memberof Reference
50
+ */
51
+ createdAt: Date;
52
+ }
53
+
54
+ /**
55
+ * Check if a given object implements the Reference interface.
56
+ */
57
+ export function instanceOfReference(value: object): boolean {
58
+ let isInstance = true;
59
+ isInstance = isInstance && "name" in value;
60
+ isInstance = isInstance && "referenceType" in value;
61
+ isInstance = isInstance && "files" in value;
62
+ isInstance = isInstance && "createdBy" in value;
63
+ isInstance = isInstance && "createdAt" in value;
64
+
65
+ return isInstance;
66
+ }
67
+
68
+ export function ReferenceFromJSON(json: any): Reference {
69
+ return ReferenceFromJSONTyped(json, false);
70
+ }
71
+
72
+ export function ReferenceFromJSONTyped(json: any, ignoreDiscriminator: boolean): Reference {
73
+ if ((json === undefined) || (json === null)) {
74
+ return json;
75
+ }
76
+ return {
77
+
78
+ 'name': json['name'],
79
+ 'referenceType': json['referenceType'],
80
+ 'files': json['files'],
81
+ 'createdBy': json['createdBy'],
82
+ 'createdAt': (new Date(json['createdAt'])),
83
+ };
84
+ }
85
+
86
+ export function ReferenceToJSON(value?: Reference | null): any {
87
+ if (value === undefined) {
88
+ return undefined;
89
+ }
90
+ if (value === null) {
91
+ return null;
92
+ }
93
+ return {
94
+
95
+ 'name': value.name,
96
+ 'referenceType': value.referenceType,
97
+ 'files': value.files,
98
+ 'createdBy': value.createdBy,
99
+ 'createdAt': (value.createdAt.toISOString()),
100
+ };
101
+ }
102
+
@@ -25,6 +25,24 @@ export interface ReferenceType {
25
25
  * @memberof ReferenceType
26
26
  */
27
27
  name: string;
28
+ /**
29
+ *
30
+ * @type {string}
31
+ * @memberof ReferenceType
32
+ */
33
+ description: string;
34
+ /**
35
+ *
36
+ * @type {string}
37
+ * @memberof ReferenceType
38
+ */
39
+ directory: string;
40
+ /**
41
+ *
42
+ * @type {Array<{ [key: string]: any; }>}
43
+ * @memberof ReferenceType
44
+ */
45
+ validation: Array<{ [key: string]: any; }>;
28
46
  }
29
47
 
30
48
  /**
@@ -33,6 +51,9 @@ export interface ReferenceType {
33
51
  export function instanceOfReferenceType(value: object): boolean {
34
52
  let isInstance = true;
35
53
  isInstance = isInstance && "name" in value;
54
+ isInstance = isInstance && "description" in value;
55
+ isInstance = isInstance && "directory" in value;
56
+ isInstance = isInstance && "validation" in value;
36
57
 
37
58
  return isInstance;
38
59
  }
@@ -48,6 +69,9 @@ export function ReferenceTypeFromJSONTyped(json: any, ignoreDiscriminator: boole
48
69
  return {
49
70
 
50
71
  'name': json['name'],
72
+ 'description': json['description'],
73
+ 'directory': json['directory'],
74
+ 'validation': json['validation'],
51
75
  };
52
76
  }
53
77
 
@@ -61,6 +85,9 @@ export function ReferenceTypeToJSON(value?: ReferenceType | null): any {
61
85
  return {
62
86
 
63
87
  'name': value.name,
88
+ 'description': value.description,
89
+ 'directory': value.directory,
90
+ 'validation': value.validation,
64
91
  };
65
92
  }
66
93
 
@@ -0,0 +1,75 @@
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 Sample
20
+ */
21
+ export interface Sample {
22
+ /**
23
+ *
24
+ * @type {string}
25
+ * @memberof Sample
26
+ */
27
+ name: string;
28
+ /**
29
+ *
30
+ * @type {{ [key: string]: any; }}
31
+ * @memberof Sample
32
+ */
33
+ metadata: { [key: string]: any; };
34
+ }
35
+
36
+ /**
37
+ * Check if a given object implements the Sample interface.
38
+ */
39
+ export function instanceOfSample(value: object): boolean {
40
+ let isInstance = true;
41
+ isInstance = isInstance && "name" in value;
42
+ isInstance = isInstance && "metadata" in value;
43
+
44
+ return isInstance;
45
+ }
46
+
47
+ export function SampleFromJSON(json: any): Sample {
48
+ return SampleFromJSONTyped(json, false);
49
+ }
50
+
51
+ export function SampleFromJSONTyped(json: any, ignoreDiscriminator: boolean): Sample {
52
+ if ((json === undefined) || (json === null)) {
53
+ return json;
54
+ }
55
+ return {
56
+
57
+ 'name': json['name'],
58
+ 'metadata': json['metadata'],
59
+ };
60
+ }
61
+
62
+ export function SampleToJSON(value?: Sample | null): any {
63
+ if (value === undefined) {
64
+ return undefined;
65
+ }
66
+ if (value === null) {
67
+ return null;
68
+ }
69
+ return {
70
+
71
+ 'name': value.name,
72
+ 'metadata': value.metadata,
73
+ };
74
+ }
75
+
@@ -25,6 +25,12 @@ export interface ServiceConnection {
25
25
  * @memberof ServiceConnection
26
26
  */
27
27
  name: string;
28
+ /**
29
+ *
30
+ * @type {string}
31
+ * @memberof ServiceConnection
32
+ */
33
+ description: string;
28
34
  }
29
35
 
30
36
  /**
@@ -33,6 +39,7 @@ export interface ServiceConnection {
33
39
  export function instanceOfServiceConnection(value: object): boolean {
34
40
  let isInstance = true;
35
41
  isInstance = isInstance && "name" in value;
42
+ isInstance = isInstance && "description" in value;
36
43
 
37
44
  return isInstance;
38
45
  }
@@ -48,6 +55,7 @@ export function ServiceConnectionFromJSONTyped(json: any, ignoreDiscriminator: b
48
55
  return {
49
56
 
50
57
  'name': json['name'],
58
+ 'description': json['description'],
51
59
  };
52
60
  }
53
61
 
@@ -61,6 +69,7 @@ export function ServiceConnectionToJSON(value?: ServiceConnection | null): any {
61
69
  return {
62
70
 
63
71
  'name': value.name,
72
+ 'description': value.description,
64
73
  };
65
74
  }
66
75
 
@@ -7,6 +7,7 @@ export * from './CloudAccount';
7
7
  export * from './Contact';
8
8
  export * from './CreateNotebookInstanceRequest';
9
9
  export * from './CreateResponse';
10
+ export * from './CustomPipelineSettings';
10
11
  export * from './CustomerType';
11
12
  export * from './Dataset';
12
13
  export * from './DatasetDetail';
@@ -18,15 +19,18 @@ export * from './LogEntry';
18
19
  export * from './NotebookInstance';
19
20
  export * from './OpenNotebookInstanceResponse';
20
21
  export * from './Process';
22
+ export * from './ProcessDetail';
21
23
  export * from './Project';
22
24
  export * from './ProjectDetail';
23
25
  export * from './ProjectMetrics';
24
26
  export * from './ProjectRequest';
25
27
  export * from './ProjectRole';
26
28
  export * from './ProjectSettings';
29
+ export * from './Reference';
27
30
  export * from './ReferenceType';
28
31
  export * from './Region';
29
32
  export * from './RegisterDatasetRequest';
33
+ export * from './Sample';
30
34
  export * from './ServiceConnection';
31
35
  export * from './SetUserProjectRoleRequest';
32
36
  export * from './StopExecutionResponse';