@cirrobio/api-client 0.1.30 → 0.2.0

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 (45) hide show
  1. package/.openapi-generator/FILES +11 -0
  2. package/README.md +1 -1
  3. package/dist/apis/SharingApi.d.ts +129 -0
  4. package/dist/apis/SharingApi.js +539 -0
  5. package/dist/apis/ToolsApi.d.ts +31 -0
  6. package/dist/apis/ToolsApi.js +137 -0
  7. package/dist/apis/index.d.ts +2 -0
  8. package/dist/apis/index.js +2 -0
  9. package/dist/models/DatasetCondition.d.ts +38 -0
  10. package/dist/models/DatasetCondition.js +54 -0
  11. package/dist/models/DatasetConditionField.d.ts +24 -0
  12. package/dist/models/DatasetConditionField.js +39 -0
  13. package/dist/models/MoveDatasetInput.d.ts +43 -0
  14. package/dist/models/MoveDatasetInput.js +56 -0
  15. package/dist/models/MoveDatasetResponse.d.ts +43 -0
  16. package/dist/models/MoveDatasetResponse.js +56 -0
  17. package/dist/models/NamedItem.d.ts +37 -0
  18. package/dist/models/NamedItem.js +53 -0
  19. package/dist/models/ProjectSettings.d.ts +6 -0
  20. package/dist/models/ProjectSettings.js +2 -0
  21. package/dist/models/Share.d.ts +86 -0
  22. package/dist/models/Share.js +78 -0
  23. package/dist/models/ShareDetail.d.ts +106 -0
  24. package/dist/models/ShareDetail.js +89 -0
  25. package/dist/models/ShareInput.d.ts +62 -0
  26. package/dist/models/ShareInput.js +65 -0
  27. package/dist/models/ShareType.d.ts +24 -0
  28. package/dist/models/ShareType.js +39 -0
  29. package/dist/models/index.d.ts +9 -0
  30. package/dist/models/index.js +9 -0
  31. package/package.json +1 -1
  32. package/src/apis/SharingApi.ts +432 -0
  33. package/src/apis/ToolsApi.ts +80 -0
  34. package/src/apis/index.ts +2 -0
  35. package/src/models/DatasetCondition.ts +82 -0
  36. package/src/models/DatasetConditionField.ts +38 -0
  37. package/src/models/MoveDatasetInput.ts +84 -0
  38. package/src/models/MoveDatasetResponse.ts +84 -0
  39. package/src/models/NamedItem.ts +75 -0
  40. package/src/models/ProjectSettings.ts +8 -0
  41. package/src/models/Share.ts +154 -0
  42. package/src/models/ShareDetail.ts +192 -0
  43. package/src/models/ShareInput.ts +116 -0
  44. package/src/models/ShareType.ts +38 -0
  45. package/src/models/index.ts +9 -0
@@ -0,0 +1,84 @@
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 MoveDatasetInput
20
+ */
21
+ export interface MoveDatasetInput {
22
+ /**
23
+ *
24
+ * @type {string}
25
+ * @memberof MoveDatasetInput
26
+ */
27
+ datasetId: string;
28
+ /**
29
+ *
30
+ * @type {string}
31
+ * @memberof MoveDatasetInput
32
+ */
33
+ sourceProjectId: string;
34
+ /**
35
+ *
36
+ * @type {string}
37
+ * @memberof MoveDatasetInput
38
+ */
39
+ targetProjectId: string;
40
+ }
41
+
42
+ /**
43
+ * Check if a given object implements the MoveDatasetInput interface.
44
+ */
45
+ export function instanceOfMoveDatasetInput(value: object): boolean {
46
+ let isInstance = true;
47
+ isInstance = isInstance && "datasetId" in value;
48
+ isInstance = isInstance && "sourceProjectId" in value;
49
+ isInstance = isInstance && "targetProjectId" in value;
50
+
51
+ return isInstance;
52
+ }
53
+
54
+ export function MoveDatasetInputFromJSON(json: any): MoveDatasetInput {
55
+ return MoveDatasetInputFromJSONTyped(json, false);
56
+ }
57
+
58
+ export function MoveDatasetInputFromJSONTyped(json: any, ignoreDiscriminator: boolean): MoveDatasetInput {
59
+ if ((json === undefined) || (json === null)) {
60
+ return json;
61
+ }
62
+ return {
63
+
64
+ 'datasetId': json['datasetId'],
65
+ 'sourceProjectId': json['sourceProjectId'],
66
+ 'targetProjectId': json['targetProjectId'],
67
+ };
68
+ }
69
+
70
+ export function MoveDatasetInputToJSON(value?: MoveDatasetInput | null): any {
71
+ if (value === undefined) {
72
+ return undefined;
73
+ }
74
+ if (value === null) {
75
+ return null;
76
+ }
77
+ return {
78
+
79
+ 'datasetId': value.datasetId,
80
+ 'sourceProjectId': value.sourceProjectId,
81
+ 'targetProjectId': value.targetProjectId,
82
+ };
83
+ }
84
+
@@ -0,0 +1,84 @@
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 MoveDatasetResponse
20
+ */
21
+ export interface MoveDatasetResponse {
22
+ /**
23
+ *
24
+ * @type {string}
25
+ * @memberof MoveDatasetResponse
26
+ */
27
+ s3CopyCommand: string;
28
+ /**
29
+ *
30
+ * @type {string}
31
+ * @memberof MoveDatasetResponse
32
+ */
33
+ s3DeleteCommand: string;
34
+ /**
35
+ *
36
+ * @type {Array<string>}
37
+ * @memberof MoveDatasetResponse
38
+ */
39
+ samplesNotMoved: Array<string>;
40
+ }
41
+
42
+ /**
43
+ * Check if a given object implements the MoveDatasetResponse interface.
44
+ */
45
+ export function instanceOfMoveDatasetResponse(value: object): boolean {
46
+ let isInstance = true;
47
+ isInstance = isInstance && "s3CopyCommand" in value;
48
+ isInstance = isInstance && "s3DeleteCommand" in value;
49
+ isInstance = isInstance && "samplesNotMoved" in value;
50
+
51
+ return isInstance;
52
+ }
53
+
54
+ export function MoveDatasetResponseFromJSON(json: any): MoveDatasetResponse {
55
+ return MoveDatasetResponseFromJSONTyped(json, false);
56
+ }
57
+
58
+ export function MoveDatasetResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): MoveDatasetResponse {
59
+ if ((json === undefined) || (json === null)) {
60
+ return json;
61
+ }
62
+ return {
63
+
64
+ 's3CopyCommand': json['s3CopyCommand'],
65
+ 's3DeleteCommand': json['s3DeleteCommand'],
66
+ 'samplesNotMoved': json['samplesNotMoved'],
67
+ };
68
+ }
69
+
70
+ export function MoveDatasetResponseToJSON(value?: MoveDatasetResponse | null): any {
71
+ if (value === undefined) {
72
+ return undefined;
73
+ }
74
+ if (value === null) {
75
+ return null;
76
+ }
77
+ return {
78
+
79
+ 's3CopyCommand': value.s3CopyCommand,
80
+ 's3DeleteCommand': value.s3DeleteCommand,
81
+ 'samplesNotMoved': value.samplesNotMoved,
82
+ };
83
+ }
84
+
@@ -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 NamedItem
20
+ */
21
+ export interface NamedItem {
22
+ /**
23
+ *
24
+ * @type {string}
25
+ * @memberof NamedItem
26
+ */
27
+ id: string;
28
+ /**
29
+ *
30
+ * @type {string}
31
+ * @memberof NamedItem
32
+ */
33
+ name: string;
34
+ }
35
+
36
+ /**
37
+ * Check if a given object implements the NamedItem interface.
38
+ */
39
+ export function instanceOfNamedItem(value: object): boolean {
40
+ let isInstance = true;
41
+ isInstance = isInstance && "id" in value;
42
+ isInstance = isInstance && "name" in value;
43
+
44
+ return isInstance;
45
+ }
46
+
47
+ export function NamedItemFromJSON(json: any): NamedItem {
48
+ return NamedItemFromJSONTyped(json, false);
49
+ }
50
+
51
+ export function NamedItemFromJSONTyped(json: any, ignoreDiscriminator: boolean): NamedItem {
52
+ if ((json === undefined) || (json === null)) {
53
+ return json;
54
+ }
55
+ return {
56
+
57
+ 'id': json['id'],
58
+ 'name': json['name'],
59
+ };
60
+ }
61
+
62
+ export function NamedItemToJSON(value?: NamedItem | null): any {
63
+ if (value === undefined) {
64
+ return undefined;
65
+ }
66
+ if (value === null) {
67
+ return null;
68
+ }
69
+ return {
70
+
71
+ 'id': value.id,
72
+ 'name': value.name,
73
+ };
74
+ }
75
+
@@ -128,6 +128,12 @@ export interface ProjectSettings {
128
128
  * @memberof ProjectSettings
129
129
  */
130
130
  isDiscoverable?: boolean | null;
131
+ /**
132
+ * Enables the project to be shared with other projects
133
+ * @type {boolean}
134
+ * @memberof ProjectSettings
135
+ */
136
+ isShareable?: boolean | null;
131
137
  }
132
138
 
133
139
  /**
@@ -168,6 +174,7 @@ export function ProjectSettingsFromJSONTyped(json: any, ignoreDiscriminator: boo
168
174
  'sagemakerSubnets': !exists(json, 'sagemakerSubnets') ? undefined : json['sagemakerSubnets'],
169
175
  'kmsArn': !exists(json, 'kmsArn') ? undefined : json['kmsArn'],
170
176
  'isDiscoverable': !exists(json, 'isDiscoverable') ? undefined : json['isDiscoverable'],
177
+ 'isShareable': !exists(json, 'isShareable') ? undefined : json['isShareable'],
171
178
  };
172
179
  }
173
180
 
@@ -197,6 +204,7 @@ export function ProjectSettingsToJSON(value?: ProjectSettings | null): any {
197
204
  'sagemakerSubnets': value.sagemakerSubnets,
198
205
  'kmsArn': value.kmsArn,
199
206
  'isDiscoverable': value.isDiscoverable,
207
+ 'isShareable': value.isShareable,
200
208
  };
201
209
  }
202
210
 
@@ -0,0 +1,154 @@
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 { ShareType } from './ShareType';
17
+ import {
18
+ ShareTypeFromJSON,
19
+ ShareTypeFromJSONTyped,
20
+ ShareTypeToJSON,
21
+ } from './ShareType';
22
+
23
+ /**
24
+ *
25
+ * @export
26
+ * @interface Share
27
+ */
28
+ export interface Share {
29
+ /**
30
+ *
31
+ * @type {string}
32
+ * @memberof Share
33
+ */
34
+ id: string;
35
+ /**
36
+ *
37
+ * @type {string}
38
+ * @memberof Share
39
+ */
40
+ name: string;
41
+ /**
42
+ *
43
+ * @type {string}
44
+ * @memberof Share
45
+ */
46
+ description: string;
47
+ /**
48
+ * The ID of the project that owns the share
49
+ * @type {string}
50
+ * @memberof Share
51
+ */
52
+ originatingProjectId: string;
53
+ /**
54
+ *
55
+ * @type {ShareType}
56
+ * @memberof Share
57
+ */
58
+ shareType: ShareType;
59
+ /**
60
+ *
61
+ * @type {Array<string>}
62
+ * @memberof Share
63
+ */
64
+ classificationIds: Array<string>;
65
+ /**
66
+ *
67
+ * @type {Array<string>}
68
+ * @memberof Share
69
+ */
70
+ keywords: Array<string>;
71
+ /**
72
+ *
73
+ * @type {string}
74
+ * @memberof Share
75
+ */
76
+ createdBy: string;
77
+ /**
78
+ *
79
+ * @type {Date}
80
+ * @memberof Share
81
+ */
82
+ createdAt: Date;
83
+ /**
84
+ *
85
+ * @type {Date}
86
+ * @memberof Share
87
+ */
88
+ updatedAt: Date;
89
+ }
90
+
91
+ /**
92
+ * Check if a given object implements the Share interface.
93
+ */
94
+ export function instanceOfShare(value: object): boolean {
95
+ let isInstance = true;
96
+ isInstance = isInstance && "id" in value;
97
+ isInstance = isInstance && "name" in value;
98
+ isInstance = isInstance && "description" in value;
99
+ isInstance = isInstance && "originatingProjectId" in value;
100
+ isInstance = isInstance && "shareType" in value;
101
+ isInstance = isInstance && "classificationIds" in value;
102
+ isInstance = isInstance && "keywords" in value;
103
+ isInstance = isInstance && "createdBy" in value;
104
+ isInstance = isInstance && "createdAt" in value;
105
+ isInstance = isInstance && "updatedAt" in value;
106
+
107
+ return isInstance;
108
+ }
109
+
110
+ export function ShareFromJSON(json: any): Share {
111
+ return ShareFromJSONTyped(json, false);
112
+ }
113
+
114
+ export function ShareFromJSONTyped(json: any, ignoreDiscriminator: boolean): Share {
115
+ if ((json === undefined) || (json === null)) {
116
+ return json;
117
+ }
118
+ return {
119
+
120
+ 'id': json['id'],
121
+ 'name': json['name'],
122
+ 'description': json['description'],
123
+ 'originatingProjectId': json['originatingProjectId'],
124
+ 'shareType': ShareTypeFromJSON(json['shareType']),
125
+ 'classificationIds': json['classificationIds'],
126
+ 'keywords': json['keywords'],
127
+ 'createdBy': json['createdBy'],
128
+ 'createdAt': (new Date(json['createdAt'])),
129
+ 'updatedAt': (new Date(json['updatedAt'])),
130
+ };
131
+ }
132
+
133
+ export function ShareToJSON(value?: Share | null): any {
134
+ if (value === undefined) {
135
+ return undefined;
136
+ }
137
+ if (value === null) {
138
+ return null;
139
+ }
140
+ return {
141
+
142
+ 'id': value.id,
143
+ 'name': value.name,
144
+ 'description': value.description,
145
+ 'originatingProjectId': value.originatingProjectId,
146
+ 'shareType': ShareTypeToJSON(value.shareType),
147
+ 'classificationIds': value.classificationIds,
148
+ 'keywords': value.keywords,
149
+ 'createdBy': value.createdBy,
150
+ 'createdAt': (value.createdAt.toISOString()),
151
+ 'updatedAt': (value.updatedAt.toISOString()),
152
+ };
153
+ }
154
+
@@ -0,0 +1,192 @@
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 { DatasetCondition } from './DatasetCondition';
17
+ import {
18
+ DatasetConditionFromJSON,
19
+ DatasetConditionFromJSONTyped,
20
+ DatasetConditionToJSON,
21
+ } from './DatasetCondition';
22
+ import type { NamedItem } from './NamedItem';
23
+ import {
24
+ NamedItemFromJSON,
25
+ NamedItemFromJSONTyped,
26
+ NamedItemToJSON,
27
+ } from './NamedItem';
28
+ import type { ShareType } from './ShareType';
29
+ import {
30
+ ShareTypeFromJSON,
31
+ ShareTypeFromJSONTyped,
32
+ ShareTypeToJSON,
33
+ } from './ShareType';
34
+
35
+ /**
36
+ *
37
+ * @export
38
+ * @interface ShareDetail
39
+ */
40
+ export interface ShareDetail {
41
+ /**
42
+ *
43
+ * @type {string}
44
+ * @memberof ShareDetail
45
+ */
46
+ id: string;
47
+ /**
48
+ *
49
+ * @type {string}
50
+ * @memberof ShareDetail
51
+ */
52
+ name: string;
53
+ /**
54
+ *
55
+ * @type {string}
56
+ * @memberof ShareDetail
57
+ */
58
+ description: string;
59
+ /**
60
+ *
61
+ * @type {NamedItem}
62
+ * @memberof ShareDetail
63
+ */
64
+ originatingProject: NamedItem;
65
+ /**
66
+ *
67
+ * @type {ShareType}
68
+ * @memberof ShareDetail
69
+ */
70
+ shareType: ShareType;
71
+ /**
72
+ *
73
+ * @type {Array<NamedItem>}
74
+ * @memberof ShareDetail
75
+ */
76
+ sharedProjects: Array<NamedItem>;
77
+ /**
78
+ * The conditions under which the dataset is shared
79
+ * @type {Array<DatasetCondition>}
80
+ * @memberof ShareDetail
81
+ */
82
+ conditions?: Array<DatasetCondition>;
83
+ /**
84
+ *
85
+ * @type {Array<string>}
86
+ * @memberof ShareDetail
87
+ */
88
+ keywords: Array<string>;
89
+ /**
90
+ *
91
+ * @type {Array<string>}
92
+ * @memberof ShareDetail
93
+ */
94
+ classificationIds: Array<string>;
95
+ /**
96
+ *
97
+ * @type {boolean}
98
+ * @memberof ShareDetail
99
+ */
100
+ isSubscribed: boolean;
101
+ /**
102
+ *
103
+ * @type {string}
104
+ * @memberof ShareDetail
105
+ */
106
+ createdBy: string;
107
+ /**
108
+ *
109
+ * @type {Date}
110
+ * @memberof ShareDetail
111
+ */
112
+ createdAt: Date;
113
+ /**
114
+ *
115
+ * @type {Date}
116
+ * @memberof ShareDetail
117
+ */
118
+ updatedAt: Date;
119
+ }
120
+
121
+ /**
122
+ * Check if a given object implements the ShareDetail interface.
123
+ */
124
+ export function instanceOfShareDetail(value: object): boolean {
125
+ let isInstance = true;
126
+ isInstance = isInstance && "id" in value;
127
+ isInstance = isInstance && "name" in value;
128
+ isInstance = isInstance && "description" in value;
129
+ isInstance = isInstance && "originatingProject" in value;
130
+ isInstance = isInstance && "shareType" in value;
131
+ isInstance = isInstance && "sharedProjects" in value;
132
+ isInstance = isInstance && "keywords" in value;
133
+ isInstance = isInstance && "classificationIds" in value;
134
+ isInstance = isInstance && "isSubscribed" in value;
135
+ isInstance = isInstance && "createdBy" in value;
136
+ isInstance = isInstance && "createdAt" in value;
137
+ isInstance = isInstance && "updatedAt" in value;
138
+
139
+ return isInstance;
140
+ }
141
+
142
+ export function ShareDetailFromJSON(json: any): ShareDetail {
143
+ return ShareDetailFromJSONTyped(json, false);
144
+ }
145
+
146
+ export function ShareDetailFromJSONTyped(json: any, ignoreDiscriminator: boolean): ShareDetail {
147
+ if ((json === undefined) || (json === null)) {
148
+ return json;
149
+ }
150
+ return {
151
+
152
+ 'id': json['id'],
153
+ 'name': json['name'],
154
+ 'description': json['description'],
155
+ 'originatingProject': NamedItemFromJSON(json['originatingProject']),
156
+ 'shareType': ShareTypeFromJSON(json['shareType']),
157
+ 'sharedProjects': ((json['sharedProjects'] as Array<any>).map(NamedItemFromJSON)),
158
+ 'conditions': !exists(json, 'conditions') ? undefined : ((json['conditions'] as Array<any>).map(DatasetConditionFromJSON)),
159
+ 'keywords': json['keywords'],
160
+ 'classificationIds': json['classificationIds'],
161
+ 'isSubscribed': json['isSubscribed'],
162
+ 'createdBy': json['createdBy'],
163
+ 'createdAt': (new Date(json['createdAt'])),
164
+ 'updatedAt': (new Date(json['updatedAt'])),
165
+ };
166
+ }
167
+
168
+ export function ShareDetailToJSON(value?: ShareDetail | null): any {
169
+ if (value === undefined) {
170
+ return undefined;
171
+ }
172
+ if (value === null) {
173
+ return null;
174
+ }
175
+ return {
176
+
177
+ 'id': value.id,
178
+ 'name': value.name,
179
+ 'description': value.description,
180
+ 'originatingProject': NamedItemToJSON(value.originatingProject),
181
+ 'shareType': ShareTypeToJSON(value.shareType),
182
+ 'sharedProjects': ((value.sharedProjects as Array<any>).map(NamedItemToJSON)),
183
+ 'conditions': value.conditions === undefined ? undefined : ((value.conditions as Array<any>).map(DatasetConditionToJSON)),
184
+ 'keywords': value.keywords,
185
+ 'classificationIds': value.classificationIds,
186
+ 'isSubscribed': value.isSubscribed,
187
+ 'createdBy': value.createdBy,
188
+ 'createdAt': (value.createdAt.toISOString()),
189
+ 'updatedAt': (value.updatedAt.toISOString()),
190
+ };
191
+ }
192
+