@cirrobio/api-client 0.1.2 → 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.
@@ -22,11 +22,13 @@ src/models/AWSCredentials.ts
22
22
  src/models/AccessType.ts
23
23
  src/models/AllowedDataType.ts
24
24
  src/models/AuditEvent.ts
25
+ src/models/AuthInfo.ts
25
26
  src/models/BillingAccount.ts
26
27
  src/models/BillingAccountRequest.ts
27
28
  src/models/BillingMethod.ts
28
29
  src/models/BudgetPeriod.ts
29
30
  src/models/CloudAccount.ts
31
+ src/models/CloudAccountType.ts
30
32
  src/models/ColumnDefinition.ts
31
33
  src/models/Contact.ts
32
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.2 --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}
@@ -0,0 +1,49 @@
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
+ *
14
+ * @export
15
+ * @interface AuthInfo
16
+ */
17
+ export interface AuthInfo {
18
+ /**
19
+ *
20
+ * @type {string}
21
+ * @memberof AuthInfo
22
+ */
23
+ userPoolId: string;
24
+ /**
25
+ *
26
+ * @type {string}
27
+ * @memberof AuthInfo
28
+ */
29
+ sdkAppId: string;
30
+ /**
31
+ *
32
+ * @type {string}
33
+ * @memberof AuthInfo
34
+ */
35
+ uiAppId: string;
36
+ /**
37
+ *
38
+ * @type {string}
39
+ * @memberof AuthInfo
40
+ */
41
+ endpoint: string;
42
+ }
43
+ /**
44
+ * Check if a given object implements the AuthInfo interface.
45
+ */
46
+ export declare function instanceOfAuthInfo(value: object): boolean;
47
+ export declare function AuthInfoFromJSON(json: any): AuthInfo;
48
+ export declare function AuthInfoFromJSONTyped(json: any, ignoreDiscriminator: boolean): AuthInfo;
49
+ export declare function AuthInfoToJSON(value?: AuthInfo | null): any;
@@ -0,0 +1,59 @@
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.AuthInfoToJSON = exports.AuthInfoFromJSONTyped = exports.AuthInfoFromJSON = exports.instanceOfAuthInfo = void 0;
17
+ /**
18
+ * Check if a given object implements the AuthInfo interface.
19
+ */
20
+ function instanceOfAuthInfo(value) {
21
+ var isInstance = true;
22
+ isInstance = isInstance && "userPoolId" in value;
23
+ isInstance = isInstance && "sdkAppId" in value;
24
+ isInstance = isInstance && "uiAppId" in value;
25
+ isInstance = isInstance && "endpoint" in value;
26
+ return isInstance;
27
+ }
28
+ exports.instanceOfAuthInfo = instanceOfAuthInfo;
29
+ function AuthInfoFromJSON(json) {
30
+ return AuthInfoFromJSONTyped(json, false);
31
+ }
32
+ exports.AuthInfoFromJSON = AuthInfoFromJSON;
33
+ function AuthInfoFromJSONTyped(json, ignoreDiscriminator) {
34
+ if ((json === undefined) || (json === null)) {
35
+ return json;
36
+ }
37
+ return {
38
+ 'userPoolId': json['userPoolId'],
39
+ 'sdkAppId': json['sdkAppId'],
40
+ 'uiAppId': json['uiAppId'],
41
+ 'endpoint': json['endpoint'],
42
+ };
43
+ }
44
+ exports.AuthInfoFromJSONTyped = AuthInfoFromJSONTyped;
45
+ function AuthInfoToJSON(value) {
46
+ if (value === undefined) {
47
+ return undefined;
48
+ }
49
+ if (value === null) {
50
+ return null;
51
+ }
52
+ return {
53
+ 'userPoolId': value.userPoolId,
54
+ 'sdkAppId': value.sdkAppId,
55
+ 'uiAppId': value.uiAppId,
56
+ 'endpoint': value.endpoint,
57
+ };
58
+ }
59
+ exports.AuthInfoToJSON = AuthInfoToJSON;
@@ -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;
@@ -34,6 +34,12 @@ export interface NotebookInstance {
34
34
  * @memberof NotebookInstance
35
35
  */
36
36
  status: Status;
37
+ /**
38
+ *
39
+ * @type {string}
40
+ * @memberof NotebookInstance
41
+ */
42
+ statusMessage: string;
37
43
  /**
38
44
  *
39
45
  * @type {string}
@@ -23,6 +23,7 @@ function instanceOfNotebookInstance(value) {
23
23
  isInstance = isInstance && "id" in value;
24
24
  isInstance = isInstance && "name" in value;
25
25
  isInstance = isInstance && "status" in value;
26
+ isInstance = isInstance && "statusMessage" in value;
26
27
  isInstance = isInstance && "instanceType" in value;
27
28
  isInstance = isInstance && "acceleratorTypes" in value;
28
29
  isInstance = isInstance && "volumeSizeGB" in value;
@@ -44,6 +45,7 @@ function NotebookInstanceFromJSONTyped(json, ignoreDiscriminator) {
44
45
  'id': json['id'],
45
46
  'name': json['name'],
46
47
  'status': (0, Status_1.StatusFromJSON)(json['status']),
48
+ 'statusMessage': json['statusMessage'],
47
49
  'instanceType': json['instanceType'],
48
50
  'acceleratorTypes': json['acceleratorTypes'],
49
51
  'volumeSizeGB': json['volumeSizeGB'],
@@ -64,6 +66,7 @@ function NotebookInstanceToJSON(value) {
64
66
  'id': value.id,
65
67
  'name': value.name,
66
68
  'status': (0, Status_1.StatusToJSON)(value.status),
69
+ 'statusMessage': value.statusMessage,
67
70
  'instanceType': value.instanceType,
68
71
  'acceleratorTypes': value.acceleratorTypes,
69
72
  'volumeSizeGB': value.volumeSizeGB,
@@ -21,7 +21,7 @@ export interface ProjectSettings {
21
21
  * @type {number}
22
22
  * @memberof ProjectSettings
23
23
  */
24
- budgetAmount?: number;
24
+ budgetAmount: number;
25
25
  /**
26
26
  *
27
27
  * @type {BudgetPeriod}
@@ -77,17 +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>;
85
- /**
86
- * Creates a default VPC for the compute environment, if false, VPC ID must be provided
87
- * @type {boolean}
88
- * @memberof ProjectSettings
89
- */
90
- createVpc?: boolean;
84
+ serviceConnections?: Array<string>;
91
85
  /**
92
86
  * VPC that the compute environment will use
93
87
  * @type {string}
@@ -101,7 +95,13 @@ export interface ProjectSettings {
101
95
  */
102
96
  batchSubnets?: Array<string> | null;
103
97
  /**
104
- * KMS Key ARN to encrypt S3 objects, one will be created if the arn is not provided
98
+ * List of subnets that the sagemaker instances will use
99
+ * @type {Array<string>}
100
+ * @memberof ProjectSettings
101
+ */
102
+ sagemakerSubnets?: Array<string> | null;
103
+ /**
104
+ * KMS Key ARN to encrypt S3 objects, if not provided, default bucket encryption will be used
105
105
  * @type {string}
106
106
  * @memberof ProjectSettings
107
107
  */
@@ -21,8 +21,8 @@ var BudgetPeriod_1 = require("./BudgetPeriod");
21
21
  */
22
22
  function instanceOfProjectSettings(value) {
23
23
  var isInstance = true;
24
+ isInstance = isInstance && "budgetAmount" in value;
24
25
  isInstance = isInstance && "budgetPeriod" in value;
25
- isInstance = isInstance && "serviceConnections" in value;
26
26
  return isInstance;
27
27
  }
28
28
  exports.instanceOfProjectSettings = instanceOfProjectSettings;
@@ -35,7 +35,7 @@ function ProjectSettingsFromJSONTyped(json, ignoreDiscriminator) {
35
35
  return json;
36
36
  }
37
37
  return {
38
- 'budgetAmount': !(0, runtime_1.exists)(json, 'budgetAmount') ? undefined : json['budgetAmount'],
38
+ 'budgetAmount': json['budgetAmount'],
39
39
  'budgetPeriod': (0, BudgetPeriod_1.BudgetPeriodFromJSON)(json['budgetPeriod']),
40
40
  'dragenAmi': !(0, runtime_1.exists)(json, 'dragenAmi') ? undefined : json['dragenAmi'],
41
41
  'enableCompute': !(0, runtime_1.exists)(json, 'enableCompute') ? undefined : json['enableCompute'],
@@ -45,10 +45,10 @@ function ProjectSettingsFromJSONTyped(json, ignoreDiscriminator) {
45
45
  'maxF1VCPU': !(0, runtime_1.exists)(json, 'maxF1VCPU') ? undefined : json['maxF1VCPU'],
46
46
  'maxSpotVCPU': !(0, runtime_1.exists)(json, 'maxSpotVCPU') ? undefined : json['maxSpotVCPU'],
47
47
  'retentionPolicyDays': !(0, runtime_1.exists)(json, 'retentionPolicyDays') ? undefined : json['retentionPolicyDays'],
48
- 'serviceConnections': json['serviceConnections'],
49
- 'createVpc': !(0, runtime_1.exists)(json, 'createVpc') ? undefined : json['createVpc'],
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
  }
@@ -72,9 +72,9 @@ function ProjectSettingsToJSON(value) {
72
72
  'maxSpotVCPU': value.maxSpotVCPU,
73
73
  'retentionPolicyDays': value.retentionPolicyDays,
74
74
  'serviceConnections': value.serviceConnections,
75
- 'createVpc': value.createVpc,
76
75
  'vpcId': value.vpcId,
77
76
  'batchSubnets': value.batchSubnets,
77
+ 'sagemakerSubnets': value.sagemakerSubnets,
78
78
  'kmsArn': value.kmsArn,
79
79
  };
80
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
  */
@@ -9,6 +9,7 @@
9
9
  * https://openapi-generator.tech
10
10
  * Do not edit the class manually.
11
11
  */
12
+ import type { AuthInfo } from './AuthInfo';
12
13
  import type { ResourcesInfo } from './ResourcesInfo';
13
14
  import type { TenantInfo } from './TenantInfo';
14
15
  /**
@@ -22,19 +23,19 @@ export interface SystemInfoResponse {
22
23
  * @type {string}
23
24
  * @memberof SystemInfoResponse
24
25
  */
25
- sdkAppId: string;
26
+ resourcesBucket: string;
26
27
  /**
27
28
  *
28
29
  * @type {string}
29
30
  * @memberof SystemInfoResponse
30
31
  */
31
- resourcesBucket: string;
32
+ referencesBucket: string;
32
33
  /**
33
34
  *
34
35
  * @type {string}
35
36
  * @memberof SystemInfoResponse
36
37
  */
37
- referencesBucket: string;
38
+ liveEndpoint: string;
38
39
  /**
39
40
  *
40
41
  * @type {string}
@@ -47,6 +48,12 @@ export interface SystemInfoResponse {
47
48
  * @memberof SystemInfoResponse
48
49
  */
49
50
  systemMessage: string;
51
+ /**
52
+ *
53
+ * @type {boolean}
54
+ * @memberof SystemInfoResponse
55
+ */
56
+ maintenanceModeEnabled: boolean;
50
57
  /**
51
58
  *
52
59
  * @type {string}
@@ -71,6 +78,12 @@ export interface SystemInfoResponse {
71
78
  * @memberof SystemInfoResponse
72
79
  */
73
80
  tenantInfo: TenantInfo;
81
+ /**
82
+ *
83
+ * @type {AuthInfo}
84
+ * @memberof SystemInfoResponse
85
+ */
86
+ auth: AuthInfo;
74
87
  }
75
88
  /**
76
89
  * Check if a given object implements the SystemInfoResponse interface.
@@ -14,6 +14,7 @@
14
14
  */
15
15
  Object.defineProperty(exports, "__esModule", { value: true });
16
16
  exports.SystemInfoResponseToJSON = exports.SystemInfoResponseFromJSONTyped = exports.SystemInfoResponseFromJSON = exports.instanceOfSystemInfoResponse = void 0;
17
+ var AuthInfo_1 = require("./AuthInfo");
17
18
  var ResourcesInfo_1 = require("./ResourcesInfo");
18
19
  var TenantInfo_1 = require("./TenantInfo");
19
20
  /**
@@ -21,15 +22,17 @@ var TenantInfo_1 = require("./TenantInfo");
21
22
  */
22
23
  function instanceOfSystemInfoResponse(value) {
23
24
  var isInstance = true;
24
- isInstance = isInstance && "sdkAppId" in value;
25
25
  isInstance = isInstance && "resourcesBucket" in value;
26
26
  isInstance = isInstance && "referencesBucket" in value;
27
+ isInstance = isInstance && "liveEndpoint" in value;
27
28
  isInstance = isInstance && "region" in value;
28
29
  isInstance = isInstance && "systemMessage" in value;
30
+ isInstance = isInstance && "maintenanceModeEnabled" in value;
29
31
  isInstance = isInstance && "commitHash" in value;
30
32
  isInstance = isInstance && "version" in value;
31
33
  isInstance = isInstance && "resourcesInfo" in value;
32
34
  isInstance = isInstance && "tenantInfo" in value;
35
+ isInstance = isInstance && "auth" in value;
33
36
  return isInstance;
34
37
  }
35
38
  exports.instanceOfSystemInfoResponse = instanceOfSystemInfoResponse;
@@ -42,15 +45,17 @@ function SystemInfoResponseFromJSONTyped(json, ignoreDiscriminator) {
42
45
  return json;
43
46
  }
44
47
  return {
45
- 'sdkAppId': json['sdkAppId'],
46
48
  'resourcesBucket': json['resourcesBucket'],
47
49
  'referencesBucket': json['referencesBucket'],
50
+ 'liveEndpoint': json['liveEndpoint'],
48
51
  'region': json['region'],
49
52
  'systemMessage': json['systemMessage'],
53
+ 'maintenanceModeEnabled': json['maintenanceModeEnabled'],
50
54
  'commitHash': json['commitHash'],
51
55
  'version': json['version'],
52
56
  'resourcesInfo': (0, ResourcesInfo_1.ResourcesInfoFromJSON)(json['resourcesInfo']),
53
57
  'tenantInfo': (0, TenantInfo_1.TenantInfoFromJSON)(json['tenantInfo']),
58
+ 'auth': (0, AuthInfo_1.AuthInfoFromJSON)(json['auth']),
54
59
  };
55
60
  }
56
61
  exports.SystemInfoResponseFromJSONTyped = SystemInfoResponseFromJSONTyped;
@@ -62,15 +67,17 @@ function SystemInfoResponseToJSON(value) {
62
67
  return null;
63
68
  }
64
69
  return {
65
- 'sdkAppId': value.sdkAppId,
66
70
  'resourcesBucket': value.resourcesBucket,
67
71
  'referencesBucket': value.referencesBucket,
72
+ 'liveEndpoint': value.liveEndpoint,
68
73
  'region': value.region,
69
74
  'systemMessage': value.systemMessage,
75
+ 'maintenanceModeEnabled': value.maintenanceModeEnabled,
70
76
  'commitHash': value.commitHash,
71
77
  'version': value.version,
72
78
  'resourcesInfo': (0, ResourcesInfo_1.ResourcesInfoToJSON)(value.resourcesInfo),
73
79
  'tenantInfo': (0, TenantInfo_1.TenantInfoToJSON)(value.tenantInfo),
80
+ 'auth': (0, AuthInfo_1.AuthInfoToJSON)(value.auth),
74
81
  };
75
82
  }
76
83
  exports.SystemInfoResponseToJSON = SystemInfoResponseToJSON;
@@ -2,11 +2,13 @@ export * from './AWSCredentials';
2
2
  export * from './AccessType';
3
3
  export * from './AllowedDataType';
4
4
  export * from './AuditEvent';
5
+ export * from './AuthInfo';
5
6
  export * from './BillingAccount';
6
7
  export * from './BillingAccountRequest';
7
8
  export * from './BillingMethod';
8
9
  export * from './BudgetPeriod';
9
10
  export * from './CloudAccount';
11
+ export * from './CloudAccountType';
10
12
  export * from './ColumnDefinition';
11
13
  export * from './Contact';
12
14
  export * from './CreateNotebookInstanceRequest';
@@ -20,11 +20,13 @@ __exportStar(require("./AWSCredentials"), exports);
20
20
  __exportStar(require("./AccessType"), exports);
21
21
  __exportStar(require("./AllowedDataType"), exports);
22
22
  __exportStar(require("./AuditEvent"), exports);
23
+ __exportStar(require("./AuthInfo"), exports);
23
24
  __exportStar(require("./BillingAccount"), exports);
24
25
  __exportStar(require("./BillingAccountRequest"), exports);
25
26
  __exportStar(require("./BillingMethod"), exports);
26
27
  __exportStar(require("./BudgetPeriod"), exports);
27
28
  __exportStar(require("./CloudAccount"), exports);
29
+ __exportStar(require("./CloudAccountType"), exports);
28
30
  __exportStar(require("./ColumnDefinition"), exports);
29
31
  __exportStar(require("./Contact"), exports);
30
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.2",
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}
@@ -0,0 +1,93 @@
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 AuthInfo
20
+ */
21
+ export interface AuthInfo {
22
+ /**
23
+ *
24
+ * @type {string}
25
+ * @memberof AuthInfo
26
+ */
27
+ userPoolId: string;
28
+ /**
29
+ *
30
+ * @type {string}
31
+ * @memberof AuthInfo
32
+ */
33
+ sdkAppId: string;
34
+ /**
35
+ *
36
+ * @type {string}
37
+ * @memberof AuthInfo
38
+ */
39
+ uiAppId: string;
40
+ /**
41
+ *
42
+ * @type {string}
43
+ * @memberof AuthInfo
44
+ */
45
+ endpoint: string;
46
+ }
47
+
48
+ /**
49
+ * Check if a given object implements the AuthInfo interface.
50
+ */
51
+ export function instanceOfAuthInfo(value: object): boolean {
52
+ let isInstance = true;
53
+ isInstance = isInstance && "userPoolId" in value;
54
+ isInstance = isInstance && "sdkAppId" in value;
55
+ isInstance = isInstance && "uiAppId" in value;
56
+ isInstance = isInstance && "endpoint" in value;
57
+
58
+ return isInstance;
59
+ }
60
+
61
+ export function AuthInfoFromJSON(json: any): AuthInfo {
62
+ return AuthInfoFromJSONTyped(json, false);
63
+ }
64
+
65
+ export function AuthInfoFromJSONTyped(json: any, ignoreDiscriminator: boolean): AuthInfo {
66
+ if ((json === undefined) || (json === null)) {
67
+ return json;
68
+ }
69
+ return {
70
+
71
+ 'userPoolId': json['userPoolId'],
72
+ 'sdkAppId': json['sdkAppId'],
73
+ 'uiAppId': json['uiAppId'],
74
+ 'endpoint': json['endpoint'],
75
+ };
76
+ }
77
+
78
+ export function AuthInfoToJSON(value?: AuthInfo | null): any {
79
+ if (value === undefined) {
80
+ return undefined;
81
+ }
82
+ if (value === null) {
83
+ return null;
84
+ }
85
+ return {
86
+
87
+ 'userPoolId': value.userPoolId,
88
+ 'sdkAppId': value.sdkAppId,
89
+ 'uiAppId': value.uiAppId,
90
+ 'endpoint': value.endpoint,
91
+ };
92
+ }
93
+
@@ -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
+
@@ -44,6 +44,12 @@ export interface NotebookInstance {
44
44
  * @memberof NotebookInstance
45
45
  */
46
46
  status: Status;
47
+ /**
48
+ *
49
+ * @type {string}
50
+ * @memberof NotebookInstance
51
+ */
52
+ statusMessage: string;
47
53
  /**
48
54
  *
49
55
  * @type {string}
@@ -90,6 +96,7 @@ export function instanceOfNotebookInstance(value: object): boolean {
90
96
  isInstance = isInstance && "id" in value;
91
97
  isInstance = isInstance && "name" in value;
92
98
  isInstance = isInstance && "status" in value;
99
+ isInstance = isInstance && "statusMessage" in value;
93
100
  isInstance = isInstance && "instanceType" in value;
94
101
  isInstance = isInstance && "acceleratorTypes" in value;
95
102
  isInstance = isInstance && "volumeSizeGB" in value;
@@ -113,6 +120,7 @@ export function NotebookInstanceFromJSONTyped(json: any, ignoreDiscriminator: bo
113
120
  'id': json['id'],
114
121
  'name': json['name'],
115
122
  'status': StatusFromJSON(json['status']),
123
+ 'statusMessage': json['statusMessage'],
116
124
  'instanceType': json['instanceType'],
117
125
  'acceleratorTypes': json['acceleratorTypes'],
118
126
  'volumeSizeGB': json['volumeSizeGB'],
@@ -134,6 +142,7 @@ export function NotebookInstanceToJSON(value?: NotebookInstance | null): any {
134
142
  'id': value.id,
135
143
  'name': value.name,
136
144
  'status': StatusToJSON(value.status),
145
+ 'statusMessage': value.statusMessage,
137
146
  'instanceType': value.instanceType,
138
147
  'acceleratorTypes': value.acceleratorTypes,
139
148
  'volumeSizeGB': value.volumeSizeGB,
@@ -31,7 +31,7 @@ export interface ProjectSettings {
31
31
  * @type {number}
32
32
  * @memberof ProjectSettings
33
33
  */
34
- budgetAmount?: number;
34
+ budgetAmount: number;
35
35
  /**
36
36
  *
37
37
  * @type {BudgetPeriod}
@@ -87,17 +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>;
95
- /**
96
- * Creates a default VPC for the compute environment, if false, VPC ID must be provided
97
- * @type {boolean}
98
- * @memberof ProjectSettings
99
- */
100
- createVpc?: boolean;
94
+ serviceConnections?: Array<string>;
101
95
  /**
102
96
  * VPC that the compute environment will use
103
97
  * @type {string}
@@ -111,7 +105,13 @@ export interface ProjectSettings {
111
105
  */
112
106
  batchSubnets?: Array<string> | null;
113
107
  /**
114
- * KMS Key ARN to encrypt S3 objects, one will be created if the arn is not provided
108
+ * List of subnets that the sagemaker instances will use
109
+ * @type {Array<string>}
110
+ * @memberof ProjectSettings
111
+ */
112
+ sagemakerSubnets?: Array<string> | null;
113
+ /**
114
+ * KMS Key ARN to encrypt S3 objects, if not provided, default bucket encryption will be used
115
115
  * @type {string}
116
116
  * @memberof ProjectSettings
117
117
  */
@@ -123,8 +123,8 @@ export interface ProjectSettings {
123
123
  */
124
124
  export function instanceOfProjectSettings(value: object): boolean {
125
125
  let isInstance = true;
126
+ isInstance = isInstance && "budgetAmount" in value;
126
127
  isInstance = isInstance && "budgetPeriod" in value;
127
- isInstance = isInstance && "serviceConnections" in value;
128
128
 
129
129
  return isInstance;
130
130
  }
@@ -139,7 +139,7 @@ export function ProjectSettingsFromJSONTyped(json: any, ignoreDiscriminator: boo
139
139
  }
140
140
  return {
141
141
 
142
- 'budgetAmount': !exists(json, 'budgetAmount') ? undefined : json['budgetAmount'],
142
+ 'budgetAmount': json['budgetAmount'],
143
143
  'budgetPeriod': BudgetPeriodFromJSON(json['budgetPeriod']),
144
144
  'dragenAmi': !exists(json, 'dragenAmi') ? undefined : json['dragenAmi'],
145
145
  'enableCompute': !exists(json, 'enableCompute') ? undefined : json['enableCompute'],
@@ -149,10 +149,10 @@ export function ProjectSettingsFromJSONTyped(json: any, ignoreDiscriminator: boo
149
149
  'maxF1VCPU': !exists(json, 'maxF1VCPU') ? undefined : json['maxF1VCPU'],
150
150
  'maxSpotVCPU': !exists(json, 'maxSpotVCPU') ? undefined : json['maxSpotVCPU'],
151
151
  'retentionPolicyDays': !exists(json, 'retentionPolicyDays') ? undefined : json['retentionPolicyDays'],
152
- 'serviceConnections': json['serviceConnections'],
153
- 'createVpc': !exists(json, 'createVpc') ? undefined : json['createVpc'],
152
+ 'serviceConnections': !exists(json, 'serviceConnections') ? undefined : json['serviceConnections'],
154
153
  'vpcId': !exists(json, 'vpcId') ? undefined : json['vpcId'],
155
154
  'batchSubnets': !exists(json, 'batchSubnets') ? undefined : json['batchSubnets'],
155
+ 'sagemakerSubnets': !exists(json, 'sagemakerSubnets') ? undefined : json['sagemakerSubnets'],
156
156
  'kmsArn': !exists(json, 'kmsArn') ? undefined : json['kmsArn'],
157
157
  };
158
158
  }
@@ -177,9 +177,9 @@ export function ProjectSettingsToJSON(value?: ProjectSettings | null): any {
177
177
  'maxSpotVCPU': value.maxSpotVCPU,
178
178
  'retentionPolicyDays': value.retentionPolicyDays,
179
179
  'serviceConnections': value.serviceConnections,
180
- 'createVpc': value.createVpc,
181
180
  'vpcId': value.vpcId,
182
181
  'batchSubnets': value.batchSubnets,
182
+ 'sagemakerSubnets': value.sagemakerSubnets,
183
183
  'kmsArn': value.kmsArn,
184
184
  };
185
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
  */
@@ -13,6 +13,12 @@
13
13
  */
14
14
 
15
15
  import { exists, mapValues } from '../runtime';
16
+ import type { AuthInfo } from './AuthInfo';
17
+ import {
18
+ AuthInfoFromJSON,
19
+ AuthInfoFromJSONTyped,
20
+ AuthInfoToJSON,
21
+ } from './AuthInfo';
16
22
  import type { ResourcesInfo } from './ResourcesInfo';
17
23
  import {
18
24
  ResourcesInfoFromJSON,
@@ -37,19 +43,19 @@ export interface SystemInfoResponse {
37
43
  * @type {string}
38
44
  * @memberof SystemInfoResponse
39
45
  */
40
- sdkAppId: string;
46
+ resourcesBucket: string;
41
47
  /**
42
48
  *
43
49
  * @type {string}
44
50
  * @memberof SystemInfoResponse
45
51
  */
46
- resourcesBucket: string;
52
+ referencesBucket: string;
47
53
  /**
48
54
  *
49
55
  * @type {string}
50
56
  * @memberof SystemInfoResponse
51
57
  */
52
- referencesBucket: string;
58
+ liveEndpoint: string;
53
59
  /**
54
60
  *
55
61
  * @type {string}
@@ -62,6 +68,12 @@ export interface SystemInfoResponse {
62
68
  * @memberof SystemInfoResponse
63
69
  */
64
70
  systemMessage: string;
71
+ /**
72
+ *
73
+ * @type {boolean}
74
+ * @memberof SystemInfoResponse
75
+ */
76
+ maintenanceModeEnabled: boolean;
65
77
  /**
66
78
  *
67
79
  * @type {string}
@@ -86,6 +98,12 @@ export interface SystemInfoResponse {
86
98
  * @memberof SystemInfoResponse
87
99
  */
88
100
  tenantInfo: TenantInfo;
101
+ /**
102
+ *
103
+ * @type {AuthInfo}
104
+ * @memberof SystemInfoResponse
105
+ */
106
+ auth: AuthInfo;
89
107
  }
90
108
 
91
109
  /**
@@ -93,15 +111,17 @@ export interface SystemInfoResponse {
93
111
  */
94
112
  export function instanceOfSystemInfoResponse(value: object): boolean {
95
113
  let isInstance = true;
96
- isInstance = isInstance && "sdkAppId" in value;
97
114
  isInstance = isInstance && "resourcesBucket" in value;
98
115
  isInstance = isInstance && "referencesBucket" in value;
116
+ isInstance = isInstance && "liveEndpoint" in value;
99
117
  isInstance = isInstance && "region" in value;
100
118
  isInstance = isInstance && "systemMessage" in value;
119
+ isInstance = isInstance && "maintenanceModeEnabled" in value;
101
120
  isInstance = isInstance && "commitHash" in value;
102
121
  isInstance = isInstance && "version" in value;
103
122
  isInstance = isInstance && "resourcesInfo" in value;
104
123
  isInstance = isInstance && "tenantInfo" in value;
124
+ isInstance = isInstance && "auth" in value;
105
125
 
106
126
  return isInstance;
107
127
  }
@@ -116,15 +136,17 @@ export function SystemInfoResponseFromJSONTyped(json: any, ignoreDiscriminator:
116
136
  }
117
137
  return {
118
138
 
119
- 'sdkAppId': json['sdkAppId'],
120
139
  'resourcesBucket': json['resourcesBucket'],
121
140
  'referencesBucket': json['referencesBucket'],
141
+ 'liveEndpoint': json['liveEndpoint'],
122
142
  'region': json['region'],
123
143
  'systemMessage': json['systemMessage'],
144
+ 'maintenanceModeEnabled': json['maintenanceModeEnabled'],
124
145
  'commitHash': json['commitHash'],
125
146
  'version': json['version'],
126
147
  'resourcesInfo': ResourcesInfoFromJSON(json['resourcesInfo']),
127
148
  'tenantInfo': TenantInfoFromJSON(json['tenantInfo']),
149
+ 'auth': AuthInfoFromJSON(json['auth']),
128
150
  };
129
151
  }
130
152
 
@@ -137,15 +159,17 @@ export function SystemInfoResponseToJSON(value?: SystemInfoResponse | null): any
137
159
  }
138
160
  return {
139
161
 
140
- 'sdkAppId': value.sdkAppId,
141
162
  'resourcesBucket': value.resourcesBucket,
142
163
  'referencesBucket': value.referencesBucket,
164
+ 'liveEndpoint': value.liveEndpoint,
143
165
  'region': value.region,
144
166
  'systemMessage': value.systemMessage,
167
+ 'maintenanceModeEnabled': value.maintenanceModeEnabled,
145
168
  'commitHash': value.commitHash,
146
169
  'version': value.version,
147
170
  'resourcesInfo': ResourcesInfoToJSON(value.resourcesInfo),
148
171
  'tenantInfo': TenantInfoToJSON(value.tenantInfo),
172
+ 'auth': AuthInfoToJSON(value.auth),
149
173
  };
150
174
  }
151
175
 
@@ -4,11 +4,13 @@ export * from './AWSCredentials';
4
4
  export * from './AccessType';
5
5
  export * from './AllowedDataType';
6
6
  export * from './AuditEvent';
7
+ export * from './AuthInfo';
7
8
  export * from './BillingAccount';
8
9
  export * from './BillingAccountRequest';
9
10
  export * from './BillingMethod';
10
11
  export * from './BudgetPeriod';
11
12
  export * from './CloudAccount';
13
+ export * from './CloudAccountType';
12
14
  export * from './ColumnDefinition';
13
15
  export * from './Contact';
14
16
  export * from './CreateNotebookInstanceRequest';