@cirrobio/api-client 0.2.2 → 0.2.4

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.
package/README.md CHANGED
@@ -36,7 +36,7 @@ navigate to the folder of your consuming project and run one of the following co
36
36
  _published:_
37
37
 
38
38
  ```
39
- npm install @cirrobio/api-client@0.2.2 --save
39
+ npm install @cirrobio/api-client@0.2.4 --save
40
40
  ```
41
41
 
42
42
  _unPublished (not recommended):_
@@ -549,8 +549,8 @@ var ProjectsApi = /** @class */ (function (_super) {
549
549
  }
550
550
  _a.label = 2;
551
551
  case 2: return [4 /*yield*/, this.request({
552
- path: "/projects",
553
- method: 'OPTIONS',
552
+ path: "/projects/options",
553
+ method: 'GET',
554
554
  headers: headerParameters,
555
555
  query: queryParameters,
556
556
  }, initOverrides)];
@@ -16,6 +16,7 @@
16
16
  */
17
17
  export declare enum AccessType {
18
18
  DatasetUpload = "DATASET_UPLOAD",
19
+ SharedDatasetDownload = "SHARED_DATASET_DOWNLOAD",
19
20
  SamplesheetUpload = "SAMPLESHEET_UPLOAD",
20
21
  ReferenceUpload = "REFERENCE_UPLOAD",
21
22
  ProjectDownload = "PROJECT_DOWNLOAD",
@@ -22,6 +22,7 @@ exports.AccessTypeToJSON = exports.AccessTypeFromJSONTyped = exports.AccessTypeF
22
22
  var AccessType;
23
23
  (function (AccessType) {
24
24
  AccessType["DatasetUpload"] = "DATASET_UPLOAD";
25
+ AccessType["SharedDatasetDownload"] = "SHARED_DATASET_DOWNLOAD";
25
26
  AccessType["SamplesheetUpload"] = "SAMPLESHEET_UPLOAD";
26
27
  AccessType["ReferenceUpload"] = "REFERENCE_UPLOAD";
27
28
  AccessType["ProjectDownload"] = "PROJECT_DOWNLOAD";
@@ -39,6 +39,12 @@ export interface CreateNotebookInstanceRequest {
39
39
  * @memberof CreateNotebookInstanceRequest
40
40
  */
41
41
  volumeSizeGB: number;
42
+ /**
43
+ * Whether the notebook is shared with the project
44
+ * @type {boolean}
45
+ * @memberof CreateNotebookInstanceRequest
46
+ */
47
+ isSharedWithProject?: boolean;
42
48
  }
43
49
  /**
44
50
  * Check if a given object implements the CreateNotebookInstanceRequest interface.
@@ -14,6 +14,7 @@
14
14
  */
15
15
  Object.defineProperty(exports, "__esModule", { value: true });
16
16
  exports.CreateNotebookInstanceRequestToJSON = exports.CreateNotebookInstanceRequestFromJSONTyped = exports.CreateNotebookInstanceRequestFromJSON = exports.instanceOfCreateNotebookInstanceRequest = void 0;
17
+ var runtime_1 = require("../runtime");
17
18
  /**
18
19
  * Check if a given object implements the CreateNotebookInstanceRequest interface.
19
20
  */
@@ -39,6 +40,7 @@ function CreateNotebookInstanceRequestFromJSONTyped(json, ignoreDiscriminator) {
39
40
  'instanceType': json['instanceType'],
40
41
  'acceleratorTypes': json['acceleratorTypes'],
41
42
  'volumeSizeGB': json['volumeSizeGB'],
43
+ 'isSharedWithProject': !(0, runtime_1.exists)(json, 'isSharedWithProject') ? undefined : json['isSharedWithProject'],
42
44
  };
43
45
  }
44
46
  exports.CreateNotebookInstanceRequestFromJSONTyped = CreateNotebookInstanceRequestFromJSONTyped;
@@ -54,6 +56,7 @@ function CreateNotebookInstanceRequestToJSON(value) {
54
56
  'instanceType': value.instanceType,
55
57
  'acceleratorTypes': value.acceleratorTypes,
56
58
  'volumeSizeGB': value.volumeSizeGB,
59
+ 'isSharedWithProject': value.isSharedWithProject,
57
60
  };
58
61
  }
59
62
  exports.CreateNotebookInstanceRequestToJSON = CreateNotebookInstanceRequestToJSON;
@@ -106,6 +106,12 @@ export interface DatasetDetail {
106
106
  * @memberof DatasetDetail
107
107
  */
108
108
  share?: NamedItem | null;
109
+ /**
110
+ *
111
+ * @type {boolean}
112
+ * @memberof DatasetDetail
113
+ */
114
+ isViewRestricted: boolean;
109
115
  /**
110
116
  *
111
117
  * @type {string}
@@ -36,6 +36,7 @@ function instanceOfDatasetDetail(value) {
36
36
  isInstance = isInstance && "tags" in value;
37
37
  isInstance = isInstance && "params" in value;
38
38
  isInstance = isInstance && "info" in value;
39
+ isInstance = isInstance && "isViewRestricted" in value;
39
40
  isInstance = isInstance && "createdBy" in value;
40
41
  isInstance = isInstance && "createdAt" in value;
41
42
  isInstance = isInstance && "updatedAt" in value;
@@ -65,6 +66,7 @@ function DatasetDetailFromJSONTyped(json, ignoreDiscriminator) {
65
66
  'params': json['params'],
66
67
  'info': json['info'],
67
68
  'share': !(0, runtime_1.exists)(json, 'share') ? undefined : (0, NamedItem_1.NamedItemFromJSON)(json['share']),
69
+ 'isViewRestricted': json['isViewRestricted'],
68
70
  'createdBy': json['createdBy'],
69
71
  'createdAt': (new Date(json['createdAt'])),
70
72
  'updatedAt': (new Date(json['updatedAt'])),
@@ -93,6 +95,7 @@ function DatasetDetailToJSON(value) {
93
95
  'params': value.params,
94
96
  'info': value.info,
95
97
  'share': (0, NamedItem_1.NamedItemToJSON)(value.share),
98
+ 'isViewRestricted': value.isViewRestricted,
96
99
  'createdBy': value.createdBy,
97
100
  'createdAt': (value.createdAt.toISOString()),
98
101
  'updatedAt': (value.updatedAt.toISOString()),
@@ -17,9 +17,7 @@
17
17
  export declare enum GovernanceType {
18
18
  Document = "DOCUMENT",
19
19
  Agreement = "AGREEMENT",
20
- Training = "TRAINING",
21
- Contact = "CONTACT",
22
- Classification = "CLASSIFICATION"
20
+ Training = "TRAINING"
23
21
  }
24
22
  export declare function GovernanceTypeFromJSON(json: any): GovernanceType;
25
23
  export declare function GovernanceTypeFromJSONTyped(json: any, ignoreDiscriminator: boolean): GovernanceType;
@@ -24,8 +24,6 @@ var GovernanceType;
24
24
  GovernanceType["Document"] = "DOCUMENT";
25
25
  GovernanceType["Agreement"] = "AGREEMENT";
26
26
  GovernanceType["Training"] = "TRAINING";
27
- GovernanceType["Contact"] = "CONTACT";
28
- GovernanceType["Classification"] = "CLASSIFICATION";
29
27
  })(GovernanceType = exports.GovernanceType || (exports.GovernanceType = {}));
30
28
  function GovernanceTypeFromJSON(json) {
31
29
  return GovernanceTypeFromJSONTyped(json, false);
@@ -58,6 +58,12 @@ export interface NotebookInstance {
58
58
  * @memberof NotebookInstance
59
59
  */
60
60
  volumeSizeGB: number;
61
+ /**
62
+ *
63
+ * @type {boolean}
64
+ * @memberof NotebookInstance
65
+ */
66
+ isSharedWithProject: boolean;
61
67
  /**
62
68
  *
63
69
  * @type {string}
@@ -27,6 +27,7 @@ function instanceOfNotebookInstance(value) {
27
27
  isInstance = isInstance && "instanceType" in value;
28
28
  isInstance = isInstance && "acceleratorTypes" in value;
29
29
  isInstance = isInstance && "volumeSizeGB" in value;
30
+ isInstance = isInstance && "isSharedWithProject" in value;
30
31
  isInstance = isInstance && "createdBy" in value;
31
32
  isInstance = isInstance && "createdAt" in value;
32
33
  isInstance = isInstance && "updatedAt" in value;
@@ -49,6 +50,7 @@ function NotebookInstanceFromJSONTyped(json, ignoreDiscriminator) {
49
50
  'instanceType': json['instanceType'],
50
51
  'acceleratorTypes': json['acceleratorTypes'],
51
52
  'volumeSizeGB': json['volumeSizeGB'],
53
+ 'isSharedWithProject': json['isSharedWithProject'],
52
54
  'createdBy': json['createdBy'],
53
55
  'createdAt': (new Date(json['createdAt'])),
54
56
  'updatedAt': (new Date(json['updatedAt'])),
@@ -70,6 +72,7 @@ function NotebookInstanceToJSON(value) {
70
72
  'instanceType': value.instanceType,
71
73
  'acceleratorTypes': value.acceleratorTypes,
72
74
  'volumeSizeGB': value.volumeSizeGB,
75
+ 'isSharedWithProject': value.isSharedWithProject,
73
76
  'createdBy': value.createdBy,
74
77
  'createdAt': (value.createdAt.toISOString()),
75
78
  'updatedAt': (value.updatedAt.toISOString()),
@@ -78,6 +78,12 @@ export interface ShareDetail {
78
78
  * @memberof ShareDetail
79
79
  */
80
80
  isSubscribed: boolean;
81
+ /**
82
+ *
83
+ * @type {boolean}
84
+ * @memberof ShareDetail
85
+ */
86
+ isViewRestricted: boolean;
81
87
  /**
82
88
  *
83
89
  * @type {string}
@@ -32,6 +32,7 @@ function instanceOfShareDetail(value) {
32
32
  isInstance = isInstance && "keywords" in value;
33
33
  isInstance = isInstance && "classificationIds" in value;
34
34
  isInstance = isInstance && "isSubscribed" in value;
35
+ isInstance = isInstance && "isViewRestricted" in value;
35
36
  isInstance = isInstance && "createdBy" in value;
36
37
  isInstance = isInstance && "createdAt" in value;
37
38
  isInstance = isInstance && "updatedAt" in value;
@@ -57,6 +58,7 @@ function ShareDetailFromJSONTyped(json, ignoreDiscriminator) {
57
58
  'keywords': json['keywords'],
58
59
  'classificationIds': json['classificationIds'],
59
60
  'isSubscribed': json['isSubscribed'],
61
+ 'isViewRestricted': json['isViewRestricted'],
60
62
  'createdBy': json['createdBy'],
61
63
  'createdAt': (new Date(json['createdAt'])),
62
64
  'updatedAt': (new Date(json['updatedAt'])),
@@ -81,6 +83,7 @@ function ShareDetailToJSON(value) {
81
83
  'keywords': value.keywords,
82
84
  'classificationIds': value.classificationIds,
83
85
  'isSubscribed': value.isSubscribed,
86
+ 'isViewRestricted': value.isViewRestricted,
84
87
  'createdBy': value.createdBy,
85
88
  'createdAt': (value.createdAt.toISOString()),
86
89
  'updatedAt': (value.updatedAt.toISOString()),
@@ -52,6 +52,12 @@ export interface ShareInput {
52
52
  * @memberof ShareInput
53
53
  */
54
54
  sharedProjectIds?: Array<string>;
55
+ /**
56
+ * Whether files within the share are restricted from viewing or downloading
57
+ * @type {boolean}
58
+ * @memberof ShareInput
59
+ */
60
+ isViewRestricted?: boolean;
55
61
  }
56
62
  /**
57
63
  * Check if a given object implements the ShareInput interface.
@@ -43,6 +43,7 @@ function ShareInputFromJSONTyped(json, ignoreDiscriminator) {
43
43
  'conditions': (json['conditions'].map(DatasetCondition_1.DatasetConditionFromJSON)),
44
44
  'keywords': !(0, runtime_1.exists)(json, 'keywords') ? undefined : json['keywords'],
45
45
  'sharedProjectIds': !(0, runtime_1.exists)(json, 'sharedProjectIds') ? undefined : json['sharedProjectIds'],
46
+ 'isViewRestricted': !(0, runtime_1.exists)(json, 'isViewRestricted') ? undefined : json['isViewRestricted'],
46
47
  };
47
48
  }
48
49
  exports.ShareInputFromJSONTyped = ShareInputFromJSONTyped;
@@ -60,6 +61,7 @@ function ShareInputToJSON(value) {
60
61
  'conditions': (value.conditions.map(DatasetCondition_1.DatasetConditionToJSON)),
61
62
  'keywords': value.keywords,
62
63
  'sharedProjectIds': value.sharedProjectIds,
64
+ 'isViewRestricted': value.isViewRestricted,
63
65
  };
64
66
  }
65
67
  exports.ShareInputToJSON = ShareInputToJSON;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@cirrobio/api-client",
3
- "version": "0.2.2",
3
+ "version": "0.2.4",
4
4
  "description": "API client for Cirro",
5
5
  "author": "CirroBio",
6
6
  "repository": {
@@ -477,8 +477,8 @@ export class ProjectsApi extends runtime.BaseAPI {
477
477
  }
478
478
  }
479
479
  const response = await this.request({
480
- path: `/projects`,
481
- method: 'OPTIONS',
480
+ path: `/projects/options`,
481
+ method: 'GET',
482
482
  headers: headerParameters,
483
483
  query: queryParameters,
484
484
  }, initOverrides);
@@ -19,6 +19,7 @@
19
19
  */
20
20
  export enum AccessType {
21
21
  DatasetUpload = 'DATASET_UPLOAD',
22
+ SharedDatasetDownload = 'SHARED_DATASET_DOWNLOAD',
22
23
  SamplesheetUpload = 'SAMPLESHEET_UPLOAD',
23
24
  ReferenceUpload = 'REFERENCE_UPLOAD',
24
25
  ProjectDownload = 'PROJECT_DOWNLOAD',
@@ -43,6 +43,12 @@ export interface CreateNotebookInstanceRequest {
43
43
  * @memberof CreateNotebookInstanceRequest
44
44
  */
45
45
  volumeSizeGB: number;
46
+ /**
47
+ * Whether the notebook is shared with the project
48
+ * @type {boolean}
49
+ * @memberof CreateNotebookInstanceRequest
50
+ */
51
+ isSharedWithProject?: boolean;
46
52
  }
47
53
 
48
54
  /**
@@ -72,6 +78,7 @@ export function CreateNotebookInstanceRequestFromJSONTyped(json: any, ignoreDisc
72
78
  'instanceType': json['instanceType'],
73
79
  'acceleratorTypes': json['acceleratorTypes'],
74
80
  'volumeSizeGB': json['volumeSizeGB'],
81
+ 'isSharedWithProject': !exists(json, 'isSharedWithProject') ? undefined : json['isSharedWithProject'],
75
82
  };
76
83
  }
77
84
 
@@ -88,6 +95,7 @@ export function CreateNotebookInstanceRequestToJSON(value?: CreateNotebookInstan
88
95
  'instanceType': value.instanceType,
89
96
  'acceleratorTypes': value.acceleratorTypes,
90
97
  'volumeSizeGB': value.volumeSizeGB,
98
+ 'isSharedWithProject': value.isSharedWithProject,
91
99
  };
92
100
  }
93
101
 
@@ -122,6 +122,12 @@ export interface DatasetDetail {
122
122
  * @memberof DatasetDetail
123
123
  */
124
124
  share?: NamedItem | null;
125
+ /**
126
+ *
127
+ * @type {boolean}
128
+ * @memberof DatasetDetail
129
+ */
130
+ isViewRestricted: boolean;
125
131
  /**
126
132
  *
127
133
  * @type {string}
@@ -160,6 +166,7 @@ export function instanceOfDatasetDetail(value: object): boolean {
160
166
  isInstance = isInstance && "tags" in value;
161
167
  isInstance = isInstance && "params" in value;
162
168
  isInstance = isInstance && "info" in value;
169
+ isInstance = isInstance && "isViewRestricted" in value;
163
170
  isInstance = isInstance && "createdBy" in value;
164
171
  isInstance = isInstance && "createdAt" in value;
165
172
  isInstance = isInstance && "updatedAt" in value;
@@ -191,6 +198,7 @@ export function DatasetDetailFromJSONTyped(json: any, ignoreDiscriminator: boole
191
198
  'params': json['params'],
192
199
  'info': json['info'],
193
200
  'share': !exists(json, 'share') ? undefined : NamedItemFromJSON(json['share']),
201
+ 'isViewRestricted': json['isViewRestricted'],
194
202
  'createdBy': json['createdBy'],
195
203
  'createdAt': (new Date(json['createdAt'])),
196
204
  'updatedAt': (new Date(json['updatedAt'])),
@@ -220,6 +228,7 @@ export function DatasetDetailToJSON(value?: DatasetDetail | null): any {
220
228
  'params': value.params,
221
229
  'info': value.info,
222
230
  'share': NamedItemToJSON(value.share),
231
+ 'isViewRestricted': value.isViewRestricted,
223
232
  'createdBy': value.createdBy,
224
233
  'createdAt': (value.createdAt.toISOString()),
225
234
  'updatedAt': (value.updatedAt.toISOString()),
@@ -20,9 +20,7 @@
20
20
  export enum GovernanceType {
21
21
  Document = 'DOCUMENT',
22
22
  Agreement = 'AGREEMENT',
23
- Training = 'TRAINING',
24
- Contact = 'CONTACT',
25
- Classification = 'CLASSIFICATION'
23
+ Training = 'TRAINING'
26
24
  }
27
25
 
28
26
 
@@ -68,6 +68,12 @@ export interface NotebookInstance {
68
68
  * @memberof NotebookInstance
69
69
  */
70
70
  volumeSizeGB: number;
71
+ /**
72
+ *
73
+ * @type {boolean}
74
+ * @memberof NotebookInstance
75
+ */
76
+ isSharedWithProject: boolean;
71
77
  /**
72
78
  *
73
79
  * @type {string}
@@ -100,6 +106,7 @@ export function instanceOfNotebookInstance(value: object): boolean {
100
106
  isInstance = isInstance && "instanceType" in value;
101
107
  isInstance = isInstance && "acceleratorTypes" in value;
102
108
  isInstance = isInstance && "volumeSizeGB" in value;
109
+ isInstance = isInstance && "isSharedWithProject" in value;
103
110
  isInstance = isInstance && "createdBy" in value;
104
111
  isInstance = isInstance && "createdAt" in value;
105
112
  isInstance = isInstance && "updatedAt" in value;
@@ -124,6 +131,7 @@ export function NotebookInstanceFromJSONTyped(json: any, ignoreDiscriminator: bo
124
131
  'instanceType': json['instanceType'],
125
132
  'acceleratorTypes': json['acceleratorTypes'],
126
133
  'volumeSizeGB': json['volumeSizeGB'],
134
+ 'isSharedWithProject': json['isSharedWithProject'],
127
135
  'createdBy': json['createdBy'],
128
136
  'createdAt': (new Date(json['createdAt'])),
129
137
  'updatedAt': (new Date(json['updatedAt'])),
@@ -146,6 +154,7 @@ export function NotebookInstanceToJSON(value?: NotebookInstance | null): any {
146
154
  'instanceType': value.instanceType,
147
155
  'acceleratorTypes': value.acceleratorTypes,
148
156
  'volumeSizeGB': value.volumeSizeGB,
157
+ 'isSharedWithProject': value.isSharedWithProject,
149
158
  'createdBy': value.createdBy,
150
159
  'createdAt': (value.createdAt.toISOString()),
151
160
  'updatedAt': (value.updatedAt.toISOString()),
@@ -98,6 +98,12 @@ export interface ShareDetail {
98
98
  * @memberof ShareDetail
99
99
  */
100
100
  isSubscribed: boolean;
101
+ /**
102
+ *
103
+ * @type {boolean}
104
+ * @memberof ShareDetail
105
+ */
106
+ isViewRestricted: boolean;
101
107
  /**
102
108
  *
103
109
  * @type {string}
@@ -133,6 +139,7 @@ export function instanceOfShareDetail(value: object): boolean {
133
139
  isInstance = isInstance && "keywords" in value;
134
140
  isInstance = isInstance && "classificationIds" in value;
135
141
  isInstance = isInstance && "isSubscribed" in value;
142
+ isInstance = isInstance && "isViewRestricted" in value;
136
143
  isInstance = isInstance && "createdBy" in value;
137
144
  isInstance = isInstance && "createdAt" in value;
138
145
  isInstance = isInstance && "updatedAt" in value;
@@ -160,6 +167,7 @@ export function ShareDetailFromJSONTyped(json: any, ignoreDiscriminator: boolean
160
167
  'keywords': json['keywords'],
161
168
  'classificationIds': json['classificationIds'],
162
169
  'isSubscribed': json['isSubscribed'],
170
+ 'isViewRestricted': json['isViewRestricted'],
163
171
  'createdBy': json['createdBy'],
164
172
  'createdAt': (new Date(json['createdAt'])),
165
173
  'updatedAt': (new Date(json['updatedAt'])),
@@ -185,6 +193,7 @@ export function ShareDetailToJSON(value?: ShareDetail | null): any {
185
193
  'keywords': value.keywords,
186
194
  'classificationIds': value.classificationIds,
187
195
  'isSubscribed': value.isSubscribed,
196
+ 'isViewRestricted': value.isViewRestricted,
188
197
  'createdBy': value.createdBy,
189
198
  'createdAt': (value.createdAt.toISOString()),
190
199
  'updatedAt': (value.updatedAt.toISOString()),
@@ -62,6 +62,12 @@ export interface ShareInput {
62
62
  * @memberof ShareInput
63
63
  */
64
64
  sharedProjectIds?: Array<string>;
65
+ /**
66
+ * Whether files within the share are restricted from viewing or downloading
67
+ * @type {boolean}
68
+ * @memberof ShareInput
69
+ */
70
+ isViewRestricted?: boolean;
65
71
  }
66
72
 
67
73
  /**
@@ -93,6 +99,7 @@ export function ShareInputFromJSONTyped(json: any, ignoreDiscriminator: boolean)
93
99
  'conditions': ((json['conditions'] as Array<any>).map(DatasetConditionFromJSON)),
94
100
  'keywords': !exists(json, 'keywords') ? undefined : json['keywords'],
95
101
  'sharedProjectIds': !exists(json, 'sharedProjectIds') ? undefined : json['sharedProjectIds'],
102
+ 'isViewRestricted': !exists(json, 'isViewRestricted') ? undefined : json['isViewRestricted'],
96
103
  };
97
104
  }
98
105
 
@@ -111,6 +118,7 @@ export function ShareInputToJSON(value?: ShareInput | null): any {
111
118
  'conditions': ((value.conditions as Array<any>).map(DatasetConditionToJSON)),
112
119
  'keywords': value.keywords,
113
120
  'sharedProjectIds': value.sharedProjectIds,
121
+ 'isViewRestricted': value.isViewRestricted,
114
122
  };
115
123
  }
116
124