@cirrobio/api-client 0.1.3 → 0.1.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.
@@ -28,6 +28,7 @@ src/models/BillingAccountRequest.ts
28
28
  src/models/BillingMethod.ts
29
29
  src/models/BudgetPeriod.ts
30
30
  src/models/CloudAccount.ts
31
+ src/models/CloudAccountType.ts
31
32
  src/models/ColumnDefinition.ts
32
33
  src/models/Contact.ts
33
34
  src/models/CreateNotebookInstanceRequest.ts
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.1.3 --save
39
+ npm install @cirrobio/api-client@0.1.4 --save
40
40
  ```
41
41
 
42
42
  _unPublished (not recommended):_
@@ -52,7 +52,7 @@ export interface AuditEvent {
52
52
  */
53
53
  eventDetail?: {
54
54
  [key: string]: any;
55
- };
55
+ } | null;
56
56
  /**
57
57
  * The changes made to the entity (if applicable)
58
58
  * @type {{ [key: string]: string; }}
@@ -60,7 +60,7 @@ export interface AuditEvent {
60
60
  */
61
61
  changes?: {
62
62
  [key: string]: string;
63
- };
63
+ } | null;
64
64
  /**
65
65
  * The username of the user who performed the action
66
66
  * @type {string}
@@ -9,6 +9,7 @@
9
9
  * https://openapi-generator.tech
10
10
  * Do not edit the class manually.
11
11
  */
12
+ import type { CloudAccountType } from './CloudAccountType';
12
13
  /**
13
14
  *
14
15
  * @export
@@ -28,11 +29,17 @@ export interface CloudAccount {
28
29
  */
29
30
  accountName?: string;
30
31
  /**
31
- * AWS Region Code
32
+ * AWS Region Code (defaults to region of Cirro app)
32
33
  * @type {string}
33
34
  * @memberof CloudAccount
34
35
  */
35
36
  regionName?: string;
37
+ /**
38
+ *
39
+ * @type {CloudAccountType}
40
+ * @memberof CloudAccount
41
+ */
42
+ accountType: CloudAccountType;
36
43
  }
37
44
  /**
38
45
  * Check if a given object implements the CloudAccount interface.
@@ -15,11 +15,13 @@
15
15
  Object.defineProperty(exports, "__esModule", { value: true });
16
16
  exports.CloudAccountToJSON = exports.CloudAccountFromJSONTyped = exports.CloudAccountFromJSON = exports.instanceOfCloudAccount = void 0;
17
17
  var runtime_1 = require("../runtime");
18
+ var CloudAccountType_1 = require("./CloudAccountType");
18
19
  /**
19
20
  * Check if a given object implements the CloudAccount interface.
20
21
  */
21
22
  function instanceOfCloudAccount(value) {
22
23
  var isInstance = true;
24
+ isInstance = isInstance && "accountType" in value;
23
25
  return isInstance;
24
26
  }
25
27
  exports.instanceOfCloudAccount = instanceOfCloudAccount;
@@ -35,6 +37,7 @@ function CloudAccountFromJSONTyped(json, ignoreDiscriminator) {
35
37
  'accountId': !(0, runtime_1.exists)(json, 'accountId') ? undefined : json['accountId'],
36
38
  'accountName': !(0, runtime_1.exists)(json, 'accountName') ? undefined : json['accountName'],
37
39
  'regionName': !(0, runtime_1.exists)(json, 'regionName') ? undefined : json['regionName'],
40
+ 'accountType': (0, CloudAccountType_1.CloudAccountTypeFromJSON)(json['accountType']),
38
41
  };
39
42
  }
40
43
  exports.CloudAccountFromJSONTyped = CloudAccountFromJSONTyped;
@@ -49,6 +52,7 @@ function CloudAccountToJSON(value) {
49
52
  'accountId': value.accountId,
50
53
  'accountName': value.accountName,
51
54
  'regionName': value.regionName,
55
+ 'accountType': (0, CloudAccountType_1.CloudAccountTypeToJSON)(value.accountType),
52
56
  };
53
57
  }
54
58
  exports.CloudAccountToJSON = CloudAccountToJSON;
@@ -0,0 +1,23 @@
1
+ /**
2
+ * Cirro Data
3
+ * Cirro Data Platform service API
4
+ *
5
+ * The version of the OpenAPI document: latest
6
+ * Contact: support@cirro.bio
7
+ *
8
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
+ * https://openapi-generator.tech
10
+ * Do not edit the class manually.
11
+ */
12
+ /**
13
+ * Type of cloud account (Hosted by Cirro, or Bring your own account)
14
+ * @export
15
+ * @enum {string}
16
+ */
17
+ export declare enum CloudAccountType {
18
+ Hosted = "HOSTED",
19
+ Byoa = "BYOA"
20
+ }
21
+ export declare function CloudAccountTypeFromJSON(json: any): CloudAccountType;
22
+ export declare function CloudAccountTypeFromJSONTyped(json: any, ignoreDiscriminator: boolean): CloudAccountType;
23
+ export declare function CloudAccountTypeToJSON(value?: CloudAccountType | null): any;
@@ -0,0 +1,38 @@
1
+ "use strict";
2
+ /* tslint:disable */
3
+ /* eslint-disable */
4
+ /**
5
+ * Cirro Data
6
+ * Cirro Data Platform service API
7
+ *
8
+ * The version of the OpenAPI document: latest
9
+ * Contact: support@cirro.bio
10
+ *
11
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
12
+ * https://openapi-generator.tech
13
+ * Do not edit the class manually.
14
+ */
15
+ Object.defineProperty(exports, "__esModule", { value: true });
16
+ exports.CloudAccountTypeToJSON = exports.CloudAccountTypeFromJSONTyped = exports.CloudAccountTypeFromJSON = exports.CloudAccountType = void 0;
17
+ /**
18
+ * Type of cloud account (Hosted by Cirro, or Bring your own account)
19
+ * @export
20
+ * @enum {string}
21
+ */
22
+ var CloudAccountType;
23
+ (function (CloudAccountType) {
24
+ CloudAccountType["Hosted"] = "HOSTED";
25
+ CloudAccountType["Byoa"] = "BYOA";
26
+ })(CloudAccountType = exports.CloudAccountType || (exports.CloudAccountType = {}));
27
+ function CloudAccountTypeFromJSON(json) {
28
+ return CloudAccountTypeFromJSONTyped(json, false);
29
+ }
30
+ exports.CloudAccountTypeFromJSON = CloudAccountTypeFromJSON;
31
+ function CloudAccountTypeFromJSONTyped(json, ignoreDiscriminator) {
32
+ return json;
33
+ }
34
+ exports.CloudAccountTypeFromJSONTyped = CloudAccountTypeFromJSONTyped;
35
+ function CloudAccountTypeToJSON(value) {
36
+ return value;
37
+ }
38
+ exports.CloudAccountTypeToJSON = CloudAccountTypeToJSON;
@@ -77,11 +77,11 @@ export interface ProjectSettings {
77
77
  */
78
78
  retentionPolicyDays?: number;
79
79
  /**
80
- *
80
+ * List of service connections to enable
81
81
  * @type {Array<string>}
82
82
  * @memberof ProjectSettings
83
83
  */
84
- serviceConnections: Array<string>;
84
+ serviceConnections?: Array<string>;
85
85
  /**
86
86
  * VPC that the compute environment will use
87
87
  * @type {string}
@@ -89,11 +89,17 @@ export interface ProjectSettings {
89
89
  */
90
90
  vpcId?: string | null;
91
91
  /**
92
- *
92
+ * List of subnets that the compute environment will use
93
93
  * @type {Array<string>}
94
94
  * @memberof ProjectSettings
95
95
  */
96
96
  batchSubnets?: Array<string> | null;
97
+ /**
98
+ * List of subnets that the sagemaker instances will use
99
+ * @type {Array<string>}
100
+ * @memberof ProjectSettings
101
+ */
102
+ sagemakerSubnets?: Array<string> | null;
97
103
  /**
98
104
  * KMS Key ARN to encrypt S3 objects, if not provided, default bucket encryption will be used
99
105
  * @type {string}
@@ -23,7 +23,6 @@ function instanceOfProjectSettings(value) {
23
23
  var isInstance = true;
24
24
  isInstance = isInstance && "budgetAmount" in value;
25
25
  isInstance = isInstance && "budgetPeriod" in value;
26
- isInstance = isInstance && "serviceConnections" in value;
27
26
  return isInstance;
28
27
  }
29
28
  exports.instanceOfProjectSettings = instanceOfProjectSettings;
@@ -46,9 +45,10 @@ function ProjectSettingsFromJSONTyped(json, ignoreDiscriminator) {
46
45
  'maxF1VCPU': !(0, runtime_1.exists)(json, 'maxF1VCPU') ? undefined : json['maxF1VCPU'],
47
46
  'maxSpotVCPU': !(0, runtime_1.exists)(json, 'maxSpotVCPU') ? undefined : json['maxSpotVCPU'],
48
47
  'retentionPolicyDays': !(0, runtime_1.exists)(json, 'retentionPolicyDays') ? undefined : json['retentionPolicyDays'],
49
- 'serviceConnections': json['serviceConnections'],
48
+ 'serviceConnections': !(0, runtime_1.exists)(json, 'serviceConnections') ? undefined : json['serviceConnections'],
50
49
  'vpcId': !(0, runtime_1.exists)(json, 'vpcId') ? undefined : json['vpcId'],
51
50
  'batchSubnets': !(0, runtime_1.exists)(json, 'batchSubnets') ? undefined : json['batchSubnets'],
51
+ 'sagemakerSubnets': !(0, runtime_1.exists)(json, 'sagemakerSubnets') ? undefined : json['sagemakerSubnets'],
52
52
  'kmsArn': !(0, runtime_1.exists)(json, 'kmsArn') ? undefined : json['kmsArn'],
53
53
  };
54
54
  }
@@ -74,6 +74,7 @@ function ProjectSettingsToJSON(value) {
74
74
  'serviceConnections': value.serviceConnections,
75
75
  'vpcId': value.vpcId,
76
76
  'batchSubnets': value.batchSubnets,
77
+ 'sagemakerSubnets': value.sagemakerSubnets,
77
78
  'kmsArn': value.kmsArn,
78
79
  };
79
80
  }
@@ -10,7 +10,7 @@
10
10
  * Do not edit the class manually.
11
11
  */
12
12
  /**
13
- * Status of last sync
13
+ * Status of the last sync operation
14
14
  * @export
15
15
  * @enum {string}
16
16
  */
@@ -15,7 +15,7 @@
15
15
  Object.defineProperty(exports, "__esModule", { value: true });
16
16
  exports.SyncStatusToJSON = exports.SyncStatusFromJSONTyped = exports.SyncStatusFromJSON = exports.SyncStatus = void 0;
17
17
  /**
18
- * Status of last sync
18
+ * Status of the last sync operation
19
19
  * @export
20
20
  * @enum {string}
21
21
  */
@@ -8,6 +8,7 @@ export * from './BillingAccountRequest';
8
8
  export * from './BillingMethod';
9
9
  export * from './BudgetPeriod';
10
10
  export * from './CloudAccount';
11
+ export * from './CloudAccountType';
11
12
  export * from './ColumnDefinition';
12
13
  export * from './Contact';
13
14
  export * from './CreateNotebookInstanceRequest';
@@ -26,6 +26,7 @@ __exportStar(require("./BillingAccountRequest"), exports);
26
26
  __exportStar(require("./BillingMethod"), exports);
27
27
  __exportStar(require("./BudgetPeriod"), exports);
28
28
  __exportStar(require("./CloudAccount"), exports);
29
+ __exportStar(require("./CloudAccountType"), exports);
29
30
  __exportStar(require("./ColumnDefinition"), exports);
30
31
  __exportStar(require("./Contact"), exports);
31
32
  __exportStar(require("./CreateNotebookInstanceRequest"), exports);
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@cirrobio/api-client",
3
- "version": "0.1.3",
3
+ "version": "0.1.4",
4
4
  "description": "API client for Cirro",
5
5
  "author": "CirroBio",
6
6
  "repository": {
@@ -54,13 +54,13 @@ export interface AuditEvent {
54
54
  * @type {{ [key: string]: any; }}
55
55
  * @memberof AuditEvent
56
56
  */
57
- eventDetail?: { [key: string]: any; };
57
+ eventDetail?: { [key: string]: any; } | null;
58
58
  /**
59
59
  * The changes made to the entity (if applicable)
60
60
  * @type {{ [key: string]: string; }}
61
61
  * @memberof AuditEvent
62
62
  */
63
- changes?: { [key: string]: string; };
63
+ changes?: { [key: string]: string; } | null;
64
64
  /**
65
65
  * The username of the user who performed the action
66
66
  * @type {string}
@@ -13,6 +13,13 @@
13
13
  */
14
14
 
15
15
  import { exists, mapValues } from '../runtime';
16
+ import type { CloudAccountType } from './CloudAccountType';
17
+ import {
18
+ CloudAccountTypeFromJSON,
19
+ CloudAccountTypeFromJSONTyped,
20
+ CloudAccountTypeToJSON,
21
+ } from './CloudAccountType';
22
+
16
23
  /**
17
24
  *
18
25
  * @export
@@ -32,11 +39,17 @@ export interface CloudAccount {
32
39
  */
33
40
  accountName?: string;
34
41
  /**
35
- * AWS Region Code
42
+ * AWS Region Code (defaults to region of Cirro app)
36
43
  * @type {string}
37
44
  * @memberof CloudAccount
38
45
  */
39
46
  regionName?: string;
47
+ /**
48
+ *
49
+ * @type {CloudAccountType}
50
+ * @memberof CloudAccount
51
+ */
52
+ accountType: CloudAccountType;
40
53
  }
41
54
 
42
55
  /**
@@ -44,6 +57,7 @@ export interface CloudAccount {
44
57
  */
45
58
  export function instanceOfCloudAccount(value: object): boolean {
46
59
  let isInstance = true;
60
+ isInstance = isInstance && "accountType" in value;
47
61
 
48
62
  return isInstance;
49
63
  }
@@ -61,6 +75,7 @@ export function CloudAccountFromJSONTyped(json: any, ignoreDiscriminator: boolea
61
75
  'accountId': !exists(json, 'accountId') ? undefined : json['accountId'],
62
76
  'accountName': !exists(json, 'accountName') ? undefined : json['accountName'],
63
77
  'regionName': !exists(json, 'regionName') ? undefined : json['regionName'],
78
+ 'accountType': CloudAccountTypeFromJSON(json['accountType']),
64
79
  };
65
80
  }
66
81
 
@@ -76,6 +91,7 @@ export function CloudAccountToJSON(value?: CloudAccount | null): any {
76
91
  'accountId': value.accountId,
77
92
  'accountName': value.accountName,
78
93
  'regionName': value.regionName,
94
+ 'accountType': CloudAccountTypeToJSON(value.accountType),
79
95
  };
80
96
  }
81
97
 
@@ -0,0 +1,37 @@
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 cloud account (Hosted by Cirro, or Bring your own account)
17
+ * @export
18
+ * @enum {string}
19
+ */
20
+ export enum CloudAccountType {
21
+ Hosted = 'HOSTED',
22
+ Byoa = 'BYOA'
23
+ }
24
+
25
+
26
+ export function CloudAccountTypeFromJSON(json: any): CloudAccountType {
27
+ return CloudAccountTypeFromJSONTyped(json, false);
28
+ }
29
+
30
+ export function CloudAccountTypeFromJSONTyped(json: any, ignoreDiscriminator: boolean): CloudAccountType {
31
+ return json as CloudAccountType;
32
+ }
33
+
34
+ export function CloudAccountTypeToJSON(value?: CloudAccountType | null): any {
35
+ return value as any;
36
+ }
37
+
@@ -87,11 +87,11 @@ export interface ProjectSettings {
87
87
  */
88
88
  retentionPolicyDays?: number;
89
89
  /**
90
- *
90
+ * List of service connections to enable
91
91
  * @type {Array<string>}
92
92
  * @memberof ProjectSettings
93
93
  */
94
- serviceConnections: Array<string>;
94
+ serviceConnections?: Array<string>;
95
95
  /**
96
96
  * VPC that the compute environment will use
97
97
  * @type {string}
@@ -99,11 +99,17 @@ export interface ProjectSettings {
99
99
  */
100
100
  vpcId?: string | null;
101
101
  /**
102
- *
102
+ * List of subnets that the compute environment will use
103
103
  * @type {Array<string>}
104
104
  * @memberof ProjectSettings
105
105
  */
106
106
  batchSubnets?: Array<string> | null;
107
+ /**
108
+ * List of subnets that the sagemaker instances will use
109
+ * @type {Array<string>}
110
+ * @memberof ProjectSettings
111
+ */
112
+ sagemakerSubnets?: Array<string> | null;
107
113
  /**
108
114
  * KMS Key ARN to encrypt S3 objects, if not provided, default bucket encryption will be used
109
115
  * @type {string}
@@ -119,7 +125,6 @@ export function instanceOfProjectSettings(value: object): boolean {
119
125
  let isInstance = true;
120
126
  isInstance = isInstance && "budgetAmount" in value;
121
127
  isInstance = isInstance && "budgetPeriod" in value;
122
- isInstance = isInstance && "serviceConnections" in value;
123
128
 
124
129
  return isInstance;
125
130
  }
@@ -144,9 +149,10 @@ export function ProjectSettingsFromJSONTyped(json: any, ignoreDiscriminator: boo
144
149
  'maxF1VCPU': !exists(json, 'maxF1VCPU') ? undefined : json['maxF1VCPU'],
145
150
  'maxSpotVCPU': !exists(json, 'maxSpotVCPU') ? undefined : json['maxSpotVCPU'],
146
151
  'retentionPolicyDays': !exists(json, 'retentionPolicyDays') ? undefined : json['retentionPolicyDays'],
147
- 'serviceConnections': json['serviceConnections'],
152
+ 'serviceConnections': !exists(json, 'serviceConnections') ? undefined : json['serviceConnections'],
148
153
  'vpcId': !exists(json, 'vpcId') ? undefined : json['vpcId'],
149
154
  'batchSubnets': !exists(json, 'batchSubnets') ? undefined : json['batchSubnets'],
155
+ 'sagemakerSubnets': !exists(json, 'sagemakerSubnets') ? undefined : json['sagemakerSubnets'],
150
156
  'kmsArn': !exists(json, 'kmsArn') ? undefined : json['kmsArn'],
151
157
  };
152
158
  }
@@ -173,6 +179,7 @@ export function ProjectSettingsToJSON(value?: ProjectSettings | null): any {
173
179
  'serviceConnections': value.serviceConnections,
174
180
  'vpcId': value.vpcId,
175
181
  'batchSubnets': value.batchSubnets,
182
+ 'sagemakerSubnets': value.sagemakerSubnets,
176
183
  'kmsArn': value.kmsArn,
177
184
  };
178
185
  }
@@ -13,7 +13,7 @@
13
13
  */
14
14
 
15
15
  /**
16
- * Status of last sync
16
+ * Status of the last sync operation
17
17
  * @export
18
18
  * @enum {string}
19
19
  */
@@ -10,6 +10,7 @@ export * from './BillingAccountRequest';
10
10
  export * from './BillingMethod';
11
11
  export * from './BudgetPeriod';
12
12
  export * from './CloudAccount';
13
+ export * from './CloudAccountType';
13
14
  export * from './ColumnDefinition';
14
15
  export * from './Contact';
15
16
  export * from './CreateNotebookInstanceRequest';