@cirrobio/api-client 0.12.2 → 0.12.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@1.0.0 --save
39
+ npm install @cirrobio/api-client@0.12.4 --save
40
40
  ```
41
41
 
42
42
  _unPublished (not recommended):_
@@ -132,6 +132,12 @@ export interface DatasetDetail {
132
132
  * @memberof DatasetDetail
133
133
  */
134
134
  isViewRestricted: boolean;
135
+ /**
136
+ * Total size of dataset files (in bytes)
137
+ * @type {number}
138
+ * @memberof DatasetDetail
139
+ */
140
+ totalSizeBytes?: number | null;
135
141
  /**
136
142
  *
137
143
  * @type {string}
@@ -67,6 +67,7 @@ export function DatasetDetailFromJSONTyped(json, ignoreDiscriminator) {
67
67
  'info': json['info'],
68
68
  'share': !exists(json, 'share') ? undefined : NamedItemFromJSON(json['share']),
69
69
  'isViewRestricted': json['isViewRestricted'],
70
+ 'totalSizeBytes': !exists(json, 'totalSizeBytes') ? undefined : json['totalSizeBytes'],
70
71
  'createdBy': json['createdBy'],
71
72
  'createdAt': (new Date(json['createdAt'])),
72
73
  'updatedAt': (new Date(json['updatedAt'])),
@@ -98,6 +99,7 @@ export function DatasetDetailToJSON(value) {
98
99
  'info': value.info,
99
100
  'share': NamedItemToJSON(value.share),
100
101
  'isViewRestricted': value.isViewRestricted,
102
+ 'totalSizeBytes': value.totalSizeBytes,
101
103
  'createdBy': value.createdBy,
102
104
  'createdAt': (value.createdAt.toISOString()),
103
105
  'updatedAt': (value.updatedAt.toISOString()),
@@ -22,6 +22,7 @@ export declare enum EntityType {
22
22
  Process = "PROCESS",
23
23
  Reference = "REFERENCE",
24
24
  Notebook = "NOTEBOOK",
25
+ Workspace = "WORKSPACE",
25
26
  Sample = "SAMPLE",
26
27
  Share = "SHARE",
27
28
  Tag = "TAG",
@@ -25,6 +25,7 @@ export var EntityType;
25
25
  EntityType["Process"] = "PROCESS";
26
26
  EntityType["Reference"] = "REFERENCE";
27
27
  EntityType["Notebook"] = "NOTEBOOK";
28
+ EntityType["Workspace"] = "WORKSPACE";
28
29
  EntityType["Sample"] = "SAMPLE";
29
30
  EntityType["Share"] = "SHARE";
30
31
  EntityType["Tag"] = "TAG";
@@ -40,6 +40,27 @@ export interface ImportDataRequest {
40
40
  * @memberof ImportDataRequest
41
41
  */
42
42
  tags?: Array<Tag> | null;
43
+ /**
44
+ * Method to download FastQ files
45
+ * @type {string}
46
+ * @memberof ImportDataRequest
47
+ */
48
+ downloadMethod?: ImportDataRequestDownloadMethodEnum;
49
+ /**
50
+ * dbGaP repository key (used to access protected data on SRA)
51
+ * @type {string}
52
+ * @memberof ImportDataRequest
53
+ */
54
+ dbgapKey?: string | null;
55
+ }
56
+ /**
57
+ * @export
58
+ * @enum {string}
59
+ */
60
+ export declare enum ImportDataRequestDownloadMethodEnum {
61
+ Sratools = "sratools",
62
+ Ftp = "ftp",
63
+ Aspera = "aspera"
43
64
  }
44
65
  /**
45
66
  * Check if a given object implements the ImportDataRequest interface.
@@ -13,6 +13,16 @@
13
13
  */
14
14
  import { exists } from '../runtime';
15
15
  import { TagFromJSON, TagToJSON, } from './Tag';
16
+ /**
17
+ * @export
18
+ * @enum {string}
19
+ */
20
+ export var ImportDataRequestDownloadMethodEnum;
21
+ (function (ImportDataRequestDownloadMethodEnum) {
22
+ ImportDataRequestDownloadMethodEnum["Sratools"] = "sratools";
23
+ ImportDataRequestDownloadMethodEnum["Ftp"] = "ftp";
24
+ ImportDataRequestDownloadMethodEnum["Aspera"] = "aspera";
25
+ })(ImportDataRequestDownloadMethodEnum || (ImportDataRequestDownloadMethodEnum = {}));
16
26
  /**
17
27
  * Check if a given object implements the ImportDataRequest interface.
18
28
  */
@@ -34,6 +44,8 @@ export function ImportDataRequestFromJSONTyped(json, ignoreDiscriminator) {
34
44
  'description': !exists(json, 'description') ? undefined : json['description'],
35
45
  'publicIds': json['publicIds'],
36
46
  'tags': !exists(json, 'tags') ? undefined : (json['tags'] === null ? null : json['tags'].map(TagFromJSON)),
47
+ 'downloadMethod': !exists(json, 'downloadMethod') ? undefined : json['downloadMethod'],
48
+ 'dbgapKey': !exists(json, 'dbgapKey') ? undefined : json['dbgapKey'],
37
49
  };
38
50
  }
39
51
  export function ImportDataRequestToJSON(value) {
@@ -48,5 +60,7 @@ export function ImportDataRequestToJSON(value) {
48
60
  'description': value.description,
49
61
  'publicIds': value.publicIds,
50
62
  'tags': value.tags === undefined ? undefined : (value.tags === null ? null : value.tags.map(TagToJSON)),
63
+ 'downloadMethod': value.downloadMethod,
64
+ 'dbgapKey': value.dbgapKey,
51
65
  };
52
66
  }
@@ -97,7 +97,7 @@ export interface Workspace {
97
97
  * @type {Date}
98
98
  * @memberof Workspace
99
99
  */
100
- startedAt: Date;
100
+ startedAt?: Date | null;
101
101
  /**
102
102
  *
103
103
  * @type {Date}
@@ -33,7 +33,6 @@ export function instanceOfWorkspace(value) {
33
33
  isInstance = isInstance && "sharingType" in value;
34
34
  isInstance = isInstance && "createdBy" in value;
35
35
  isInstance = isInstance && "createdAt" in value;
36
- isInstance = isInstance && "startedAt" in value;
37
36
  isInstance = isInstance && "updatedAt" in value;
38
37
  return isInstance;
39
38
  }
@@ -57,7 +56,7 @@ export function WorkspaceFromJSONTyped(json, ignoreDiscriminator) {
57
56
  'sessions': !exists(json, 'sessions') ? undefined : (json['sessions'] === null ? null : json['sessions'].map(WorkspaceSessionFromJSON)),
58
57
  'createdBy': json['createdBy'],
59
58
  'createdAt': (new Date(json['createdAt'])),
60
- 'startedAt': (new Date(json['startedAt'])),
59
+ 'startedAt': !exists(json, 'startedAt') ? undefined : (json['startedAt'] === null ? null : new Date(json['startedAt'])),
61
60
  'updatedAt': (new Date(json['updatedAt'])),
62
61
  };
63
62
  }
@@ -81,7 +80,7 @@ export function WorkspaceToJSON(value) {
81
80
  'sessions': value.sessions === undefined ? undefined : (value.sessions === null ? null : value.sessions.map(WorkspaceSessionToJSON)),
82
81
  'createdBy': value.createdBy,
83
82
  'createdAt': (value.createdAt.toISOString()),
84
- 'startedAt': (value.startedAt.toISOString()),
83
+ 'startedAt': value.startedAt === undefined ? undefined : (value.startedAt === null ? null : value.startedAt.toISOString()),
85
84
  'updatedAt': (value.updatedAt.toISOString()),
86
85
  };
87
86
  }
@@ -54,6 +54,12 @@ export interface WorkspaceInput {
54
54
  * @memberof WorkspaceInput
55
55
  */
56
56
  sharingType: SharingType;
57
+ /**
58
+ * Time period (in hours) to automatically stop the workspace if running
59
+ * @type {number}
60
+ * @memberof WorkspaceInput
61
+ */
62
+ autoStopTimeout?: number | null;
57
63
  }
58
64
  /**
59
65
  * Check if a given object implements the WorkspaceInput interface.
@@ -40,6 +40,7 @@ export function WorkspaceInputFromJSONTyped(json, ignoreDiscriminator) {
40
40
  'environmentId': !exists(json, 'environmentId') ? undefined : json['environmentId'],
41
41
  'computeConfig': WorkspaceComputeConfigFromJSON(json['computeConfig']),
42
42
  'sharingType': SharingTypeFromJSON(json['sharingType']),
43
+ 'autoStopTimeout': !exists(json, 'autoStopTimeout') ? undefined : json['autoStopTimeout'],
43
44
  };
44
45
  }
45
46
  export function WorkspaceInputToJSON(value) {
@@ -56,5 +57,6 @@ export function WorkspaceInputToJSON(value) {
56
57
  'environmentId': value.environmentId,
57
58
  'computeConfig': WorkspaceComputeConfigToJSON(value.computeConfig),
58
59
  'sharingType': SharingTypeToJSON(value.sharingType),
60
+ 'autoStopTimeout': value.autoStopTimeout,
59
61
  };
60
62
  }
@@ -132,6 +132,12 @@ export interface DatasetDetail {
132
132
  * @memberof DatasetDetail
133
133
  */
134
134
  isViewRestricted: boolean;
135
+ /**
136
+ * Total size of dataset files (in bytes)
137
+ * @type {number}
138
+ * @memberof DatasetDetail
139
+ */
140
+ totalSizeBytes?: number | null;
135
141
  /**
136
142
  *
137
143
  * @type {string}
@@ -72,6 +72,7 @@ function DatasetDetailFromJSONTyped(json, ignoreDiscriminator) {
72
72
  'info': json['info'],
73
73
  'share': !(0, runtime_1.exists)(json, 'share') ? undefined : (0, NamedItem_1.NamedItemFromJSON)(json['share']),
74
74
  'isViewRestricted': json['isViewRestricted'],
75
+ 'totalSizeBytes': !(0, runtime_1.exists)(json, 'totalSizeBytes') ? undefined : json['totalSizeBytes'],
75
76
  'createdBy': json['createdBy'],
76
77
  'createdAt': (new Date(json['createdAt'])),
77
78
  'updatedAt': (new Date(json['updatedAt'])),
@@ -104,6 +105,7 @@ function DatasetDetailToJSON(value) {
104
105
  'info': value.info,
105
106
  'share': (0, NamedItem_1.NamedItemToJSON)(value.share),
106
107
  'isViewRestricted': value.isViewRestricted,
108
+ 'totalSizeBytes': value.totalSizeBytes,
107
109
  'createdBy': value.createdBy,
108
110
  'createdAt': (value.createdAt.toISOString()),
109
111
  'updatedAt': (value.updatedAt.toISOString()),
@@ -22,6 +22,7 @@ export declare enum EntityType {
22
22
  Process = "PROCESS",
23
23
  Reference = "REFERENCE",
24
24
  Notebook = "NOTEBOOK",
25
+ Workspace = "WORKSPACE",
25
26
  Sample = "SAMPLE",
26
27
  Share = "SHARE",
27
28
  Tag = "TAG",
@@ -28,6 +28,7 @@ var EntityType;
28
28
  EntityType["Process"] = "PROCESS";
29
29
  EntityType["Reference"] = "REFERENCE";
30
30
  EntityType["Notebook"] = "NOTEBOOK";
31
+ EntityType["Workspace"] = "WORKSPACE";
31
32
  EntityType["Sample"] = "SAMPLE";
32
33
  EntityType["Share"] = "SHARE";
33
34
  EntityType["Tag"] = "TAG";
@@ -40,6 +40,27 @@ export interface ImportDataRequest {
40
40
  * @memberof ImportDataRequest
41
41
  */
42
42
  tags?: Array<Tag> | null;
43
+ /**
44
+ * Method to download FastQ files
45
+ * @type {string}
46
+ * @memberof ImportDataRequest
47
+ */
48
+ downloadMethod?: ImportDataRequestDownloadMethodEnum;
49
+ /**
50
+ * dbGaP repository key (used to access protected data on SRA)
51
+ * @type {string}
52
+ * @memberof ImportDataRequest
53
+ */
54
+ dbgapKey?: string | null;
55
+ }
56
+ /**
57
+ * @export
58
+ * @enum {string}
59
+ */
60
+ export declare enum ImportDataRequestDownloadMethodEnum {
61
+ Sratools = "sratools",
62
+ Ftp = "ftp",
63
+ Aspera = "aspera"
43
64
  }
44
65
  /**
45
66
  * Check if a given object implements the ImportDataRequest interface.
@@ -13,9 +13,19 @@
13
13
  * Do not edit the class manually.
14
14
  */
15
15
  Object.defineProperty(exports, "__esModule", { value: true });
16
- exports.ImportDataRequestToJSON = exports.ImportDataRequestFromJSONTyped = exports.ImportDataRequestFromJSON = exports.instanceOfImportDataRequest = void 0;
16
+ exports.ImportDataRequestToJSON = exports.ImportDataRequestFromJSONTyped = exports.ImportDataRequestFromJSON = exports.instanceOfImportDataRequest = exports.ImportDataRequestDownloadMethodEnum = void 0;
17
17
  const runtime_1 = require("../runtime");
18
18
  const Tag_1 = require("./Tag");
19
+ /**
20
+ * @export
21
+ * @enum {string}
22
+ */
23
+ var ImportDataRequestDownloadMethodEnum;
24
+ (function (ImportDataRequestDownloadMethodEnum) {
25
+ ImportDataRequestDownloadMethodEnum["Sratools"] = "sratools";
26
+ ImportDataRequestDownloadMethodEnum["Ftp"] = "ftp";
27
+ ImportDataRequestDownloadMethodEnum["Aspera"] = "aspera";
28
+ })(ImportDataRequestDownloadMethodEnum = exports.ImportDataRequestDownloadMethodEnum || (exports.ImportDataRequestDownloadMethodEnum = {}));
19
29
  /**
20
30
  * Check if a given object implements the ImportDataRequest interface.
21
31
  */
@@ -39,6 +49,8 @@ function ImportDataRequestFromJSONTyped(json, ignoreDiscriminator) {
39
49
  'description': !(0, runtime_1.exists)(json, 'description') ? undefined : json['description'],
40
50
  'publicIds': json['publicIds'],
41
51
  'tags': !(0, runtime_1.exists)(json, 'tags') ? undefined : (json['tags'] === null ? null : json['tags'].map(Tag_1.TagFromJSON)),
52
+ 'downloadMethod': !(0, runtime_1.exists)(json, 'downloadMethod') ? undefined : json['downloadMethod'],
53
+ 'dbgapKey': !(0, runtime_1.exists)(json, 'dbgapKey') ? undefined : json['dbgapKey'],
42
54
  };
43
55
  }
44
56
  exports.ImportDataRequestFromJSONTyped = ImportDataRequestFromJSONTyped;
@@ -54,6 +66,8 @@ function ImportDataRequestToJSON(value) {
54
66
  'description': value.description,
55
67
  'publicIds': value.publicIds,
56
68
  'tags': value.tags === undefined ? undefined : (value.tags === null ? null : value.tags.map(Tag_1.TagToJSON)),
69
+ 'downloadMethod': value.downloadMethod,
70
+ 'dbgapKey': value.dbgapKey,
57
71
  };
58
72
  }
59
73
  exports.ImportDataRequestToJSON = ImportDataRequestToJSON;
@@ -97,7 +97,7 @@ export interface Workspace {
97
97
  * @type {Date}
98
98
  * @memberof Workspace
99
99
  */
100
- startedAt: Date;
100
+ startedAt?: Date | null;
101
101
  /**
102
102
  *
103
103
  * @type {Date}
@@ -36,7 +36,6 @@ function instanceOfWorkspace(value) {
36
36
  isInstance = isInstance && "sharingType" in value;
37
37
  isInstance = isInstance && "createdBy" in value;
38
38
  isInstance = isInstance && "createdAt" in value;
39
- isInstance = isInstance && "startedAt" in value;
40
39
  isInstance = isInstance && "updatedAt" in value;
41
40
  return isInstance;
42
41
  }
@@ -62,7 +61,7 @@ function WorkspaceFromJSONTyped(json, ignoreDiscriminator) {
62
61
  'sessions': !(0, runtime_1.exists)(json, 'sessions') ? undefined : (json['sessions'] === null ? null : json['sessions'].map(WorkspaceSession_1.WorkspaceSessionFromJSON)),
63
62
  'createdBy': json['createdBy'],
64
63
  'createdAt': (new Date(json['createdAt'])),
65
- 'startedAt': (new Date(json['startedAt'])),
64
+ 'startedAt': !(0, runtime_1.exists)(json, 'startedAt') ? undefined : (json['startedAt'] === null ? null : new Date(json['startedAt'])),
66
65
  'updatedAt': (new Date(json['updatedAt'])),
67
66
  };
68
67
  }
@@ -87,7 +86,7 @@ function WorkspaceToJSON(value) {
87
86
  'sessions': value.sessions === undefined ? undefined : (value.sessions === null ? null : value.sessions.map(WorkspaceSession_1.WorkspaceSessionToJSON)),
88
87
  'createdBy': value.createdBy,
89
88
  'createdAt': (value.createdAt.toISOString()),
90
- 'startedAt': (value.startedAt.toISOString()),
89
+ 'startedAt': value.startedAt === undefined ? undefined : (value.startedAt === null ? null : value.startedAt.toISOString()),
91
90
  'updatedAt': (value.updatedAt.toISOString()),
92
91
  };
93
92
  }
@@ -54,6 +54,12 @@ export interface WorkspaceInput {
54
54
  * @memberof WorkspaceInput
55
55
  */
56
56
  sharingType: SharingType;
57
+ /**
58
+ * Time period (in hours) to automatically stop the workspace if running
59
+ * @type {number}
60
+ * @memberof WorkspaceInput
61
+ */
62
+ autoStopTimeout?: number | null;
57
63
  }
58
64
  /**
59
65
  * Check if a given object implements the WorkspaceInput interface.
@@ -45,6 +45,7 @@ function WorkspaceInputFromJSONTyped(json, ignoreDiscriminator) {
45
45
  'environmentId': !(0, runtime_1.exists)(json, 'environmentId') ? undefined : json['environmentId'],
46
46
  'computeConfig': (0, WorkspaceComputeConfig_1.WorkspaceComputeConfigFromJSON)(json['computeConfig']),
47
47
  'sharingType': (0, SharingType_1.SharingTypeFromJSON)(json['sharingType']),
48
+ 'autoStopTimeout': !(0, runtime_1.exists)(json, 'autoStopTimeout') ? undefined : json['autoStopTimeout'],
48
49
  };
49
50
  }
50
51
  exports.WorkspaceInputFromJSONTyped = WorkspaceInputFromJSONTyped;
@@ -62,6 +63,7 @@ function WorkspaceInputToJSON(value) {
62
63
  'environmentId': value.environmentId,
63
64
  'computeConfig': (0, WorkspaceComputeConfig_1.WorkspaceComputeConfigToJSON)(value.computeConfig),
64
65
  'sharingType': (0, SharingType_1.SharingTypeToJSON)(value.sharingType),
66
+ 'autoStopTimeout': value.autoStopTimeout,
65
67
  };
66
68
  }
67
69
  exports.WorkspaceInputToJSON = WorkspaceInputToJSON;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@cirrobio/api-client",
3
- "version": "0.12.2",
3
+ "version": "0.12.4",
4
4
  "description": "API client for Cirro",
5
5
  "author": "CirroBio",
6
6
  "repository": {