@boatdev/sdk 1.9.4 → 1.9.6

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 (169) hide show
  1. package/.openapi-generator/FILES +44 -0
  2. package/dist/apis/BoatApi.d.ts +305 -7
  3. package/dist/apis/BoatApi.js +764 -15
  4. package/dist/esm/apis/BoatApi.d.ts +305 -7
  5. package/dist/esm/apis/BoatApi.js +764 -15
  6. package/dist/esm/models/AccountAiUsageResponse.d.ts +83 -0
  7. package/dist/esm/models/AccountAiUsageResponse.js +78 -0
  8. package/dist/esm/models/AiProxySettings.d.ts +81 -0
  9. package/dist/esm/models/AiProxySettings.js +76 -0
  10. package/dist/esm/models/AiProxySettingsAllOfPricing.d.ts +38 -0
  11. package/dist/esm/models/AiProxySettingsAllOfPricing.js +47 -0
  12. package/dist/esm/models/AiUsageRow.d.ts +80 -0
  13. package/dist/esm/models/AiUsageRow.js +75 -0
  14. package/dist/esm/models/AiUsageTotals.d.ts +62 -0
  15. package/dist/esm/models/AiUsageTotals.js +63 -0
  16. package/dist/esm/models/CreateCredentialProfileRequest.d.ts +44 -0
  17. package/dist/esm/models/CreateCredentialProfileRequest.js +47 -0
  18. package/dist/esm/models/CredentialId.d.ts +36 -0
  19. package/dist/esm/models/CredentialId.js +54 -0
  20. package/dist/esm/models/CredentialProfile.d.ts +82 -0
  21. package/dist/esm/models/CredentialProfile.js +77 -0
  22. package/dist/esm/models/CredentialProfileDeletedResponse.d.ts +44 -0
  23. package/dist/esm/models/CredentialProfileDeletedResponse.js +51 -0
  24. package/dist/esm/models/CredentialProfileListResponse.d.ts +45 -0
  25. package/dist/esm/models/CredentialProfileListResponse.js +52 -0
  26. package/dist/esm/models/CredentialProfileOwner.d.ts +58 -0
  27. package/dist/esm/models/CredentialProfileOwner.js +62 -0
  28. package/dist/esm/models/CredentialProfileResponse.d.ts +51 -0
  29. package/dist/esm/models/CredentialProfileResponse.js +56 -0
  30. package/dist/esm/models/DeletionOperation.d.ts +1 -1
  31. package/dist/esm/models/FileUrlRequest.d.ts +38 -0
  32. package/dist/esm/models/FileUrlRequest.js +45 -0
  33. package/dist/esm/models/FileUrlResponse.d.ts +78 -0
  34. package/dist/esm/models/FileUrlResponse.js +77 -0
  35. package/dist/esm/models/ProcessListResponse.d.ts +1 -1
  36. package/dist/esm/models/SandboxAiAccessResponse.d.ts +56 -0
  37. package/dist/esm/models/SandboxAiAccessResponse.js +59 -0
  38. package/dist/esm/models/SandboxAiUsage.d.ts +64 -0
  39. package/dist/esm/models/SandboxAiUsage.js +65 -0
  40. package/dist/esm/models/SandboxAiUsageResponse.d.ts +88 -0
  41. package/dist/esm/models/SandboxAiUsageResponse.js +81 -0
  42. package/dist/esm/models/SandboxEnvironment.d.ts +13 -1
  43. package/dist/esm/models/SandboxEnvironment.js +4 -0
  44. package/dist/esm/models/SetCredentialKeyRequest.d.ts +32 -0
  45. package/dist/esm/models/SetCredentialKeyRequest.js +43 -0
  46. package/dist/esm/models/SetCustomApiRequest.d.ts +38 -0
  47. package/dist/esm/models/SetCustomApiRequest.js +47 -0
  48. package/dist/esm/models/SetSandboxAiAccessRequest.d.ts +32 -0
  49. package/dist/esm/models/SetSandboxAiAccessRequest.js +43 -0
  50. package/dist/esm/models/SnapshotSummary.d.ts +14 -0
  51. package/dist/esm/models/SnapshotSummary.js +9 -0
  52. package/dist/esm/models/UpdateAiProxyRequest.d.ts +32 -0
  53. package/dist/esm/models/UpdateAiProxyRequest.js +43 -0
  54. package/dist/esm/models/UpdateCredentialProfileRequest.d.ts +38 -0
  55. package/dist/esm/models/UpdateCredentialProfileRequest.js +43 -0
  56. package/dist/esm/models/UpdateSandboxEnvironmentRequest.d.ts +12 -0
  57. package/dist/esm/models/UpdateSandboxEnvironmentRequest.js +4 -0
  58. package/dist/esm/models/index.d.ts +22 -0
  59. package/dist/esm/models/index.js +22 -0
  60. package/dist/models/AccountAiUsageResponse.d.ts +83 -0
  61. package/dist/models/AccountAiUsageResponse.js +85 -0
  62. package/dist/models/AiProxySettings.d.ts +81 -0
  63. package/dist/models/AiProxySettings.js +83 -0
  64. package/dist/models/AiProxySettingsAllOfPricing.d.ts +38 -0
  65. package/dist/models/AiProxySettingsAllOfPricing.js +54 -0
  66. package/dist/models/AiUsageRow.d.ts +80 -0
  67. package/dist/models/AiUsageRow.js +82 -0
  68. package/dist/models/AiUsageTotals.d.ts +62 -0
  69. package/dist/models/AiUsageTotals.js +70 -0
  70. package/dist/models/CreateCredentialProfileRequest.d.ts +44 -0
  71. package/dist/models/CreateCredentialProfileRequest.js +54 -0
  72. package/dist/models/CredentialId.d.ts +36 -0
  73. package/dist/models/CredentialId.js +62 -0
  74. package/dist/models/CredentialProfile.d.ts +82 -0
  75. package/dist/models/CredentialProfile.js +84 -0
  76. package/dist/models/CredentialProfileDeletedResponse.d.ts +44 -0
  77. package/dist/models/CredentialProfileDeletedResponse.js +58 -0
  78. package/dist/models/CredentialProfileListResponse.d.ts +45 -0
  79. package/dist/models/CredentialProfileListResponse.js +59 -0
  80. package/dist/models/CredentialProfileOwner.d.ts +58 -0
  81. package/dist/models/CredentialProfileOwner.js +70 -0
  82. package/dist/models/CredentialProfileResponse.d.ts +51 -0
  83. package/dist/models/CredentialProfileResponse.js +63 -0
  84. package/dist/models/DeletionOperation.d.ts +1 -1
  85. package/dist/models/FileUrlRequest.d.ts +38 -0
  86. package/dist/models/FileUrlRequest.js +52 -0
  87. package/dist/models/FileUrlResponse.d.ts +78 -0
  88. package/dist/models/FileUrlResponse.js +85 -0
  89. package/dist/models/ProcessListResponse.d.ts +1 -1
  90. package/dist/models/SandboxAiAccessResponse.d.ts +56 -0
  91. package/dist/models/SandboxAiAccessResponse.js +66 -0
  92. package/dist/models/SandboxAiUsage.d.ts +64 -0
  93. package/dist/models/SandboxAiUsage.js +72 -0
  94. package/dist/models/SandboxAiUsageResponse.d.ts +88 -0
  95. package/dist/models/SandboxAiUsageResponse.js +88 -0
  96. package/dist/models/SandboxEnvironment.d.ts +13 -1
  97. package/dist/models/SandboxEnvironment.js +4 -0
  98. package/dist/models/SetCredentialKeyRequest.d.ts +32 -0
  99. package/dist/models/SetCredentialKeyRequest.js +50 -0
  100. package/dist/models/SetCustomApiRequest.d.ts +38 -0
  101. package/dist/models/SetCustomApiRequest.js +54 -0
  102. package/dist/models/SetSandboxAiAccessRequest.d.ts +32 -0
  103. package/dist/models/SetSandboxAiAccessRequest.js +50 -0
  104. package/dist/models/SnapshotSummary.d.ts +14 -0
  105. package/dist/models/SnapshotSummary.js +10 -1
  106. package/dist/models/UpdateAiProxyRequest.d.ts +32 -0
  107. package/dist/models/UpdateAiProxyRequest.js +50 -0
  108. package/dist/models/UpdateCredentialProfileRequest.d.ts +38 -0
  109. package/dist/models/UpdateCredentialProfileRequest.js +50 -0
  110. package/dist/models/UpdateSandboxEnvironmentRequest.d.ts +12 -0
  111. package/dist/models/UpdateSandboxEnvironmentRequest.js +4 -0
  112. package/dist/models/index.d.ts +22 -0
  113. package/dist/models/index.js +22 -0
  114. package/docs/AccountAiUsageResponse.md +48 -0
  115. package/docs/AiProxySettings.md +48 -0
  116. package/docs/AiProxySettingsAllOfPricing.md +34 -0
  117. package/docs/AiUsageRow.md +48 -0
  118. package/docs/AiUsageTotals.md +43 -0
  119. package/docs/BoatApi.md +1568 -359
  120. package/docs/CreateCredentialProfileRequest.md +36 -0
  121. package/docs/CredentialId.md +31 -0
  122. package/docs/CredentialProfile.md +49 -0
  123. package/docs/CredentialProfileDeletedResponse.md +36 -0
  124. package/docs/CredentialProfileListResponse.md +36 -0
  125. package/docs/CredentialProfileOwner.md +38 -0
  126. package/docs/CredentialProfileResponse.md +38 -0
  127. package/docs/FileUrlRequest.md +34 -0
  128. package/docs/FileUrlResponse.md +42 -0
  129. package/docs/SandboxAiAccessResponse.md +40 -0
  130. package/docs/SandboxAiUsage.md +42 -0
  131. package/docs/SandboxAiUsageResponse.md +50 -0
  132. package/docs/SandboxEnvironment.md +4 -0
  133. package/docs/SetCredentialKeyRequest.md +32 -0
  134. package/docs/SetCustomApiRequest.md +34 -0
  135. package/docs/SetSandboxAiAccessRequest.md +32 -0
  136. package/docs/SnapshotSummary.md +2 -0
  137. package/docs/UpdateAiProxyRequest.md +32 -0
  138. package/docs/UpdateCredentialProfileRequest.md +34 -0
  139. package/docs/UpdateSandboxEnvironmentRequest.md +4 -0
  140. package/package.json +1 -1
  141. package/src/apis/BoatApi.ts +1257 -105
  142. package/src/models/AccountAiUsageResponse.ts +160 -0
  143. package/src/models/AiProxySettings.ts +146 -0
  144. package/src/models/AiProxySettingsAllOfPricing.ts +75 -0
  145. package/src/models/AiUsageRow.ts +138 -0
  146. package/src/models/AiUsageTotals.ts +111 -0
  147. package/src/models/CreateCredentialProfileRequest.ts +82 -0
  148. package/src/models/CredentialId.ts +64 -0
  149. package/src/models/CredentialProfile.ts +153 -0
  150. package/src/models/CredentialProfileDeletedResponse.ts +84 -0
  151. package/src/models/CredentialProfileListResponse.ts +92 -0
  152. package/src/models/CredentialProfileOwner.ts +104 -0
  153. package/src/models/CredentialProfileResponse.ts +101 -0
  154. package/src/models/DeletionOperation.ts +1 -1
  155. package/src/models/FileUrlRequest.ts +74 -0
  156. package/src/models/FileUrlResponse.ts +131 -0
  157. package/src/models/ProcessListResponse.ts +1 -1
  158. package/src/models/SandboxAiAccessResponse.ts +102 -0
  159. package/src/models/SandboxAiUsage.ts +126 -0
  160. package/src/models/SandboxAiUsageResponse.ts +162 -0
  161. package/src/models/SandboxEnvironment.ts +17 -1
  162. package/src/models/SetCredentialKeyRequest.ts +66 -0
  163. package/src/models/SetCustomApiRequest.ts +75 -0
  164. package/src/models/SetSandboxAiAccessRequest.ts +66 -0
  165. package/src/models/SnapshotSummary.ts +17 -0
  166. package/src/models/UpdateAiProxyRequest.ts +66 -0
  167. package/src/models/UpdateCredentialProfileRequest.ts +73 -0
  168. package/src/models/UpdateSandboxEnvironmentRequest.ts +16 -0
  169. package/src/models/index.ts +22 -0
@@ -0,0 +1,38 @@
1
+ /**
2
+ * Boat Public API v1
3
+ * Public JSON API for creating, operating, prompting, observing, and exposing sandboxes from backend services, CI jobs, hosted workers, and Boat automation products. The v1 reference intentionally documents the developer integration surface only. Dashboard billing actions are not part of v1.
4
+ *
5
+ * The version of the OpenAPI document: 1.0.0
6
+ *
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 SetCustomApiRequest
16
+ */
17
+ export interface SetCustomApiRequest {
18
+ /**
19
+ * The secret. The sandbox gets it as the variable named in the path.
20
+ * @type {string}
21
+ * @memberof SetCustomApiRequest
22
+ */
23
+ value: string;
24
+ /**
25
+ * Public HTTPS base URL of the API, on the default port, with a DNS name. The sandbox gets it as `<NAME>_BASE_URL`.
26
+ * @type {string}
27
+ * @memberof SetCustomApiRequest
28
+ */
29
+ baseUrl: string;
30
+ }
31
+ /**
32
+ * Check if a given object implements the SetCustomApiRequest interface.
33
+ */
34
+ export declare function instanceOfSetCustomApiRequest(value: object): value is SetCustomApiRequest;
35
+ export declare function SetCustomApiRequestFromJSON(json: any): SetCustomApiRequest;
36
+ export declare function SetCustomApiRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): SetCustomApiRequest;
37
+ export declare function SetCustomApiRequestToJSON(json: any): SetCustomApiRequest;
38
+ export declare function SetCustomApiRequestToJSONTyped(value?: SetCustomApiRequest | null, ignoreDiscriminator?: boolean): any;
@@ -0,0 +1,54 @@
1
+ "use strict";
2
+ /* tslint:disable */
3
+ /* eslint-disable */
4
+ /**
5
+ * Boat Public API v1
6
+ * Public JSON API for creating, operating, prompting, observing, and exposing sandboxes from backend services, CI jobs, hosted workers, and Boat automation products. The v1 reference intentionally documents the developer integration surface only. Dashboard billing actions are not part of v1.
7
+ *
8
+ * The version of the OpenAPI document: 1.0.0
9
+ *
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.instanceOfSetCustomApiRequest = instanceOfSetCustomApiRequest;
17
+ exports.SetCustomApiRequestFromJSON = SetCustomApiRequestFromJSON;
18
+ exports.SetCustomApiRequestFromJSONTyped = SetCustomApiRequestFromJSONTyped;
19
+ exports.SetCustomApiRequestToJSON = SetCustomApiRequestToJSON;
20
+ exports.SetCustomApiRequestToJSONTyped = SetCustomApiRequestToJSONTyped;
21
+ /**
22
+ * Check if a given object implements the SetCustomApiRequest interface.
23
+ */
24
+ function instanceOfSetCustomApiRequest(value) {
25
+ if (!('value' in value) || value['value'] === undefined)
26
+ return false;
27
+ if (!('baseUrl' in value) || value['baseUrl'] === undefined)
28
+ return false;
29
+ return true;
30
+ }
31
+ function SetCustomApiRequestFromJSON(json) {
32
+ return SetCustomApiRequestFromJSONTyped(json, false);
33
+ }
34
+ function SetCustomApiRequestFromJSONTyped(json, ignoreDiscriminator) {
35
+ if (json == null) {
36
+ return json;
37
+ }
38
+ return {
39
+ 'value': json['value'],
40
+ 'baseUrl': json['baseUrl'],
41
+ };
42
+ }
43
+ function SetCustomApiRequestToJSON(json) {
44
+ return SetCustomApiRequestToJSONTyped(json, false);
45
+ }
46
+ function SetCustomApiRequestToJSONTyped(value, ignoreDiscriminator = false) {
47
+ if (value == null) {
48
+ return value;
49
+ }
50
+ return {
51
+ 'value': value['value'],
52
+ 'baseUrl': value['baseUrl'],
53
+ };
54
+ }
@@ -0,0 +1,32 @@
1
+ /**
2
+ * Boat Public API v1
3
+ * Public JSON API for creating, operating, prompting, observing, and exposing sandboxes from backend services, CI jobs, hosted workers, and Boat automation products. The v1 reference intentionally documents the developer integration surface only. Dashboard billing actions are not part of v1.
4
+ *
5
+ * The version of the OpenAPI document: 1.0.0
6
+ *
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 SetSandboxAiAccessRequest
16
+ */
17
+ export interface SetSandboxAiAccessRequest {
18
+ /**
19
+ *
20
+ * @type {boolean}
21
+ * @memberof SetSandboxAiAccessRequest
22
+ */
23
+ blocked: boolean;
24
+ }
25
+ /**
26
+ * Check if a given object implements the SetSandboxAiAccessRequest interface.
27
+ */
28
+ export declare function instanceOfSetSandboxAiAccessRequest(value: object): value is SetSandboxAiAccessRequest;
29
+ export declare function SetSandboxAiAccessRequestFromJSON(json: any): SetSandboxAiAccessRequest;
30
+ export declare function SetSandboxAiAccessRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): SetSandboxAiAccessRequest;
31
+ export declare function SetSandboxAiAccessRequestToJSON(json: any): SetSandboxAiAccessRequest;
32
+ export declare function SetSandboxAiAccessRequestToJSONTyped(value?: SetSandboxAiAccessRequest | null, ignoreDiscriminator?: boolean): any;
@@ -0,0 +1,50 @@
1
+ "use strict";
2
+ /* tslint:disable */
3
+ /* eslint-disable */
4
+ /**
5
+ * Boat Public API v1
6
+ * Public JSON API for creating, operating, prompting, observing, and exposing sandboxes from backend services, CI jobs, hosted workers, and Boat automation products. The v1 reference intentionally documents the developer integration surface only. Dashboard billing actions are not part of v1.
7
+ *
8
+ * The version of the OpenAPI document: 1.0.0
9
+ *
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.instanceOfSetSandboxAiAccessRequest = instanceOfSetSandboxAiAccessRequest;
17
+ exports.SetSandboxAiAccessRequestFromJSON = SetSandboxAiAccessRequestFromJSON;
18
+ exports.SetSandboxAiAccessRequestFromJSONTyped = SetSandboxAiAccessRequestFromJSONTyped;
19
+ exports.SetSandboxAiAccessRequestToJSON = SetSandboxAiAccessRequestToJSON;
20
+ exports.SetSandboxAiAccessRequestToJSONTyped = SetSandboxAiAccessRequestToJSONTyped;
21
+ /**
22
+ * Check if a given object implements the SetSandboxAiAccessRequest interface.
23
+ */
24
+ function instanceOfSetSandboxAiAccessRequest(value) {
25
+ if (!('blocked' in value) || value['blocked'] === undefined)
26
+ return false;
27
+ return true;
28
+ }
29
+ function SetSandboxAiAccessRequestFromJSON(json) {
30
+ return SetSandboxAiAccessRequestFromJSONTyped(json, false);
31
+ }
32
+ function SetSandboxAiAccessRequestFromJSONTyped(json, ignoreDiscriminator) {
33
+ if (json == null) {
34
+ return json;
35
+ }
36
+ return {
37
+ 'blocked': json['blocked'],
38
+ };
39
+ }
40
+ function SetSandboxAiAccessRequestToJSON(json) {
41
+ return SetSandboxAiAccessRequestToJSONTyped(json, false);
42
+ }
43
+ function SetSandboxAiAccessRequestToJSONTyped(value, ignoreDiscriminator = false) {
44
+ if (value == null) {
45
+ return value;
46
+ }
47
+ return {
48
+ 'blocked': value['blocked'],
49
+ };
50
+ }
@@ -87,6 +87,12 @@ export interface SnapshotSummary {
87
87
  * @memberof SnapshotSummary
88
88
  */
89
89
  contentFileCount?: number | null;
90
+ /**
91
+ * `template` = this Sandbox has snapshots off, so Boat never captures it: the row is a copy of the template, named snapshot or Sandbox it was created from. `captured` = this Sandbox has snapshots on: its own captures, plus the copies Boat makes when the Sandbox is created from a source, forked or resumed.
92
+ * @type {SnapshotSummaryOriginEnum}
93
+ * @memberof SnapshotSummary
94
+ */
95
+ origin?: SnapshotSummaryOriginEnum;
90
96
  }
91
97
  /**
92
98
  * @export
@@ -103,6 +109,14 @@ export declare const SnapshotSummaryKindEnum: {
103
109
  readonly Incremental: 'incremental';
104
110
  };
105
111
  export type SnapshotSummaryKindEnum = typeof SnapshotSummaryKindEnum[keyof typeof SnapshotSummaryKindEnum];
112
+ /**
113
+ * @export
114
+ */
115
+ export declare const SnapshotSummaryOriginEnum: {
116
+ readonly Captured: 'captured';
117
+ readonly Template: 'template';
118
+ };
119
+ export type SnapshotSummaryOriginEnum = typeof SnapshotSummaryOriginEnum[keyof typeof SnapshotSummaryOriginEnum];
106
120
  /**
107
121
  * Check if a given object implements the SnapshotSummary interface.
108
122
  */
@@ -13,7 +13,7 @@
13
13
  * Do not edit the class manually.
14
14
  */
15
15
  Object.defineProperty(exports, "__esModule", { value: true });
16
- exports.SnapshotSummaryKindEnum = exports.SnapshotSummaryStatusEnum = void 0;
16
+ exports.SnapshotSummaryOriginEnum = exports.SnapshotSummaryKindEnum = exports.SnapshotSummaryStatusEnum = void 0;
17
17
  exports.instanceOfSnapshotSummary = instanceOfSnapshotSummary;
18
18
  exports.SnapshotSummaryFromJSON = SnapshotSummaryFromJSON;
19
19
  exports.SnapshotSummaryFromJSONTyped = SnapshotSummaryFromJSONTyped;
@@ -32,6 +32,13 @@ exports.SnapshotSummaryKindEnum = {
32
32
  Base: 'base',
33
33
  Incremental: 'incremental'
34
34
  };
35
+ /**
36
+ * @export
37
+ */
38
+ exports.SnapshotSummaryOriginEnum = {
39
+ Captured: 'captured',
40
+ Template: 'template'
41
+ };
35
42
  /**
36
43
  * Check if a given object implements the SnapshotSummary interface.
37
44
  */
@@ -72,6 +79,7 @@ function SnapshotSummaryFromJSONTyped(json, ignoreDiscriminator) {
72
79
  'fileCount': json['fileCount'],
73
80
  'contentSizeBytes': json['contentSizeBytes'] == null ? undefined : json['contentSizeBytes'],
74
81
  'contentFileCount': json['contentFileCount'] == null ? undefined : json['contentFileCount'],
82
+ 'origin': json['origin'] == null ? undefined : json['origin'],
75
83
  };
76
84
  }
77
85
  function SnapshotSummaryToJSON(json) {
@@ -94,5 +102,6 @@ function SnapshotSummaryToJSONTyped(value, ignoreDiscriminator = false) {
94
102
  'fileCount': value['fileCount'],
95
103
  'contentSizeBytes': value['contentSizeBytes'],
96
104
  'contentFileCount': value['contentFileCount'],
105
+ 'origin': value['origin'],
97
106
  };
98
107
  }
@@ -0,0 +1,32 @@
1
+ /**
2
+ * Boat Public API v1
3
+ * Public JSON API for creating, operating, prompting, observing, and exposing sandboxes from backend services, CI jobs, hosted workers, and Boat automation products. The v1 reference intentionally documents the developer integration surface only. Dashboard billing actions are not part of v1.
4
+ *
5
+ * The version of the OpenAPI document: 1.0.0
6
+ *
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 UpdateAiProxyRequest
16
+ */
17
+ export interface UpdateAiProxyRequest {
18
+ /**
19
+ *
20
+ * @type {boolean}
21
+ * @memberof UpdateAiProxyRequest
22
+ */
23
+ enabled: boolean;
24
+ }
25
+ /**
26
+ * Check if a given object implements the UpdateAiProxyRequest interface.
27
+ */
28
+ export declare function instanceOfUpdateAiProxyRequest(value: object): value is UpdateAiProxyRequest;
29
+ export declare function UpdateAiProxyRequestFromJSON(json: any): UpdateAiProxyRequest;
30
+ export declare function UpdateAiProxyRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): UpdateAiProxyRequest;
31
+ export declare function UpdateAiProxyRequestToJSON(json: any): UpdateAiProxyRequest;
32
+ export declare function UpdateAiProxyRequestToJSONTyped(value?: UpdateAiProxyRequest | null, ignoreDiscriminator?: boolean): any;
@@ -0,0 +1,50 @@
1
+ "use strict";
2
+ /* tslint:disable */
3
+ /* eslint-disable */
4
+ /**
5
+ * Boat Public API v1
6
+ * Public JSON API for creating, operating, prompting, observing, and exposing sandboxes from backend services, CI jobs, hosted workers, and Boat automation products. The v1 reference intentionally documents the developer integration surface only. Dashboard billing actions are not part of v1.
7
+ *
8
+ * The version of the OpenAPI document: 1.0.0
9
+ *
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.instanceOfUpdateAiProxyRequest = instanceOfUpdateAiProxyRequest;
17
+ exports.UpdateAiProxyRequestFromJSON = UpdateAiProxyRequestFromJSON;
18
+ exports.UpdateAiProxyRequestFromJSONTyped = UpdateAiProxyRequestFromJSONTyped;
19
+ exports.UpdateAiProxyRequestToJSON = UpdateAiProxyRequestToJSON;
20
+ exports.UpdateAiProxyRequestToJSONTyped = UpdateAiProxyRequestToJSONTyped;
21
+ /**
22
+ * Check if a given object implements the UpdateAiProxyRequest interface.
23
+ */
24
+ function instanceOfUpdateAiProxyRequest(value) {
25
+ if (!('enabled' in value) || value['enabled'] === undefined)
26
+ return false;
27
+ return true;
28
+ }
29
+ function UpdateAiProxyRequestFromJSON(json) {
30
+ return UpdateAiProxyRequestFromJSONTyped(json, false);
31
+ }
32
+ function UpdateAiProxyRequestFromJSONTyped(json, ignoreDiscriminator) {
33
+ if (json == null) {
34
+ return json;
35
+ }
36
+ return {
37
+ 'enabled': json['enabled'],
38
+ };
39
+ }
40
+ function UpdateAiProxyRequestToJSON(json) {
41
+ return UpdateAiProxyRequestToJSONTyped(json, false);
42
+ }
43
+ function UpdateAiProxyRequestToJSONTyped(value, ignoreDiscriminator = false) {
44
+ if (value == null) {
45
+ return value;
46
+ }
47
+ return {
48
+ 'enabled': value['enabled'],
49
+ };
50
+ }
@@ -0,0 +1,38 @@
1
+ /**
2
+ * Boat Public API v1
3
+ * Public JSON API for creating, operating, prompting, observing, and exposing sandboxes from backend services, CI jobs, hosted workers, and Boat automation products. The v1 reference intentionally documents the developer integration surface only. Dashboard billing actions are not part of v1.
4
+ *
5
+ * The version of the OpenAPI document: 1.0.0
6
+ *
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 UpdateCredentialProfileRequest
16
+ */
17
+ export interface UpdateCredentialProfileRequest {
18
+ /**
19
+ * New profile name.
20
+ * @type {string}
21
+ * @memberof UpdateCredentialProfileRequest
22
+ */
23
+ name?: string;
24
+ /**
25
+ * Send true to make this profile its owner's default. The previous default loses the flag. False is ignored; make another profile the default instead.
26
+ * @type {boolean}
27
+ * @memberof UpdateCredentialProfileRequest
28
+ */
29
+ isDefault?: boolean;
30
+ }
31
+ /**
32
+ * Check if a given object implements the UpdateCredentialProfileRequest interface.
33
+ */
34
+ export declare function instanceOfUpdateCredentialProfileRequest(value: object): value is UpdateCredentialProfileRequest;
35
+ export declare function UpdateCredentialProfileRequestFromJSON(json: any): UpdateCredentialProfileRequest;
36
+ export declare function UpdateCredentialProfileRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): UpdateCredentialProfileRequest;
37
+ export declare function UpdateCredentialProfileRequestToJSON(json: any): UpdateCredentialProfileRequest;
38
+ export declare function UpdateCredentialProfileRequestToJSONTyped(value?: UpdateCredentialProfileRequest | null, ignoreDiscriminator?: boolean): any;
@@ -0,0 +1,50 @@
1
+ "use strict";
2
+ /* tslint:disable */
3
+ /* eslint-disable */
4
+ /**
5
+ * Boat Public API v1
6
+ * Public JSON API for creating, operating, prompting, observing, and exposing sandboxes from backend services, CI jobs, hosted workers, and Boat automation products. The v1 reference intentionally documents the developer integration surface only. Dashboard billing actions are not part of v1.
7
+ *
8
+ * The version of the OpenAPI document: 1.0.0
9
+ *
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.instanceOfUpdateCredentialProfileRequest = instanceOfUpdateCredentialProfileRequest;
17
+ exports.UpdateCredentialProfileRequestFromJSON = UpdateCredentialProfileRequestFromJSON;
18
+ exports.UpdateCredentialProfileRequestFromJSONTyped = UpdateCredentialProfileRequestFromJSONTyped;
19
+ exports.UpdateCredentialProfileRequestToJSON = UpdateCredentialProfileRequestToJSON;
20
+ exports.UpdateCredentialProfileRequestToJSONTyped = UpdateCredentialProfileRequestToJSONTyped;
21
+ /**
22
+ * Check if a given object implements the UpdateCredentialProfileRequest interface.
23
+ */
24
+ function instanceOfUpdateCredentialProfileRequest(value) {
25
+ return true;
26
+ }
27
+ function UpdateCredentialProfileRequestFromJSON(json) {
28
+ return UpdateCredentialProfileRequestFromJSONTyped(json, false);
29
+ }
30
+ function UpdateCredentialProfileRequestFromJSONTyped(json, ignoreDiscriminator) {
31
+ if (json == null) {
32
+ return json;
33
+ }
34
+ return {
35
+ 'name': json['name'] == null ? undefined : json['name'],
36
+ 'isDefault': json['isDefault'] == null ? undefined : json['isDefault'],
37
+ };
38
+ }
39
+ function UpdateCredentialProfileRequestToJSON(json) {
40
+ return UpdateCredentialProfileRequestToJSONTyped(json, false);
41
+ }
42
+ function UpdateCredentialProfileRequestToJSONTyped(value, ignoreDiscriminator = false) {
43
+ if (value == null) {
44
+ return value;
45
+ }
46
+ return {
47
+ 'name': value['name'],
48
+ 'isDefault': value['isDefault'],
49
+ };
50
+ }
@@ -59,6 +59,18 @@ export interface UpdateSandboxEnvironmentRequest {
59
59
  * @memberof UpdateSandboxEnvironmentRequest
60
60
  */
61
61
  passAgentsCredentials?: boolean;
62
+ /**
63
+ * Id or name of a credential profile you can use, or null for the sandbox owner's default profile. Unknown profiles return `404 credential_profile_not_found`.
64
+ * @type {string}
65
+ * @memberof UpdateSandboxEnvironmentRequest
66
+ */
67
+ credentialProfileId?: string | null;
68
+ /**
69
+ * With `safeForThirdParties` true, pass AI credentials as proxy placeholders. Setting true needs the AI credentials proxy on for the profile owner, else `400 ai_proxy_off`.
70
+ * @type {boolean}
71
+ * @memberof UpdateSandboxEnvironmentRequest
72
+ */
73
+ proxyAiCredentials?: boolean;
62
74
  /**
63
75
  * Full .env-style content for the new version.
64
76
  * @type {string}
@@ -41,6 +41,8 @@ function UpdateSandboxEnvironmentRequestFromJSONTyped(json, ignoreDiscriminator)
41
41
  'passSecrets': json['passSecrets'] == null ? undefined : json['passSecrets'],
42
42
  'passSandboxCredentials': json['passSandboxCredentials'] == null ? undefined : json['passSandboxCredentials'],
43
43
  'passAgentsCredentials': json['passAgentsCredentials'] == null ? undefined : json['passAgentsCredentials'],
44
+ 'credentialProfileId': json['credentialProfileId'] == null ? undefined : json['credentialProfileId'],
45
+ 'proxyAiCredentials': json['proxyAiCredentials'] == null ? undefined : json['proxyAiCredentials'],
44
46
  'envContents': json['envContents'] == null ? undefined : json['envContents'],
45
47
  'secretFiles': json['secretFiles'] == null ? undefined : (json['secretFiles'].map(SecretFile_1.SecretFileFromJSON)),
46
48
  'repositories': json['repositories'] == null ? undefined : (json['repositories'].map(UpdateSandboxEnvironmentRequestRepositoriesInner_1.UpdateSandboxEnvironmentRequestRepositoriesInnerFromJSON)),
@@ -61,6 +63,8 @@ function UpdateSandboxEnvironmentRequestToJSONTyped(value, ignoreDiscriminator =
61
63
  'passSecrets': value['passSecrets'],
62
64
  'passSandboxCredentials': value['passSandboxCredentials'],
63
65
  'passAgentsCredentials': value['passAgentsCredentials'],
66
+ 'credentialProfileId': value['credentialProfileId'],
67
+ 'proxyAiCredentials': value['proxyAiCredentials'],
64
68
  'envContents': value['envContents'],
65
69
  'secretFiles': value['secretFiles'] == null ? undefined : (value['secretFiles'].map(SecretFile_1.SecretFileToJSON)),
66
70
  'repositories': value['repositories'] == null ? undefined : (value['repositories'].map(UpdateSandboxEnvironmentRequestRepositoriesInner_1.UpdateSandboxEnvironmentRequestRepositoriesInnerToJSON)),
@@ -1,7 +1,12 @@
1
+ export * from './AccountAiUsageResponse';
1
2
  export * from './ActiveOrgResponse';
2
3
  export * from './ActiveOrgResponseAllOfActive';
3
4
  export * from './ActiveOrgUpdateRequest';
4
5
  export * from './AddEnvironmentRepoRequest';
6
+ export * from './AiProxySettings';
7
+ export * from './AiProxySettingsAllOfPricing';
8
+ export * from './AiUsageRow';
9
+ export * from './AiUsageTotals';
5
10
  export * from './ApiKey';
6
11
  export * from './ApiKeyCatalog';
7
12
  export * from './ApiKeyCatalogScopeResources';
@@ -30,11 +35,18 @@ export * from './CommandStreamFrame';
30
35
  export * from './CompletionEvent';
31
36
  export * from './Conversation';
32
37
  export * from './ConversationsResponse';
38
+ export * from './CreateCredentialProfileRequest';
33
39
  export * from './CreateSandboxEnvironmentRequest';
34
40
  export * from './CreateSandboxRequest';
35
41
  export * from './CreateSandboxResponse';
36
42
  export * from './CreateScopedApiKey503Response';
37
43
  export * from './CreateScopedApiKeyRequest';
44
+ export * from './CredentialId';
45
+ export * from './CredentialProfile';
46
+ export * from './CredentialProfileDeletedResponse';
47
+ export * from './CredentialProfileListResponse';
48
+ export * from './CredentialProfileOwner';
49
+ export * from './CredentialProfileResponse';
38
50
  export * from './DataRetentionPolicyResponse';
39
51
  export * from './DataRetentionUpdateRequest';
40
52
  export * from './DeletionOperation';
@@ -48,6 +60,8 @@ export * from './ErrorEnvelopeError';
48
60
  export * from './ErrorEvent';
49
61
  export * from './EventsResponse';
50
62
  export * from './FileReadResponse';
63
+ export * from './FileUrlRequest';
64
+ export * from './FileUrlResponse';
51
65
  export * from './FileWriteRequest';
52
66
  export * from './FileWriteResponse';
53
67
  export * from './ForkRequest';
@@ -97,6 +111,9 @@ export * from './ResumeRequest';
97
111
  export * from './RotateApiKey409Response';
98
112
  export * from './Sandbox';
99
113
  export * from './SandboxActionResponse';
114
+ export * from './SandboxAiAccessResponse';
115
+ export * from './SandboxAiUsage';
116
+ export * from './SandboxAiUsageResponse';
100
117
  export * from './SandboxEnvironment';
101
118
  export * from './SandboxEnvironmentListResponse';
102
119
  export * from './SandboxEnvironmentResponse';
@@ -111,8 +128,11 @@ export * from './SecretFile';
111
128
  export * from './SecretsResponse';
112
129
  export * from './SecretsUpdateRequest';
113
130
  export * from './SelectedRepository';
131
+ export * from './SetCredentialKeyRequest';
132
+ export * from './SetCustomApiRequest';
114
133
  export * from './SetEnvironmentSecretFileRequest';
115
134
  export * from './SetEnvironmentVarRequest';
135
+ export * from './SetSandboxAiAccessRequest';
116
136
  export * from './Share200Response';
117
137
  export * from './SnapshotChunk';
118
138
  export * from './SnapshotDownloadResponse';
@@ -140,6 +160,8 @@ export * from './TelemetrySetRequest';
140
160
  export * from './TelemetrySetResponse';
141
161
  export * from './TelemetryTestResult';
142
162
  export * from './UnknownEvent';
163
+ export * from './UpdateAiProxyRequest';
164
+ export * from './UpdateCredentialProfileRequest';
143
165
  export * from './UpdateSandboxEnvironmentRequest';
144
166
  export * from './UpdateSandboxEnvironmentRequestRepositoriesInner';
145
167
  export * from './UpdateSandboxRequest';
@@ -16,10 +16,15 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
16
16
  Object.defineProperty(exports, "__esModule", { value: true });
17
17
  /* tslint:disable */
18
18
  /* eslint-disable */
19
+ __exportStar(require("./AccountAiUsageResponse"), exports);
19
20
  __exportStar(require("./ActiveOrgResponse"), exports);
20
21
  __exportStar(require("./ActiveOrgResponseAllOfActive"), exports);
21
22
  __exportStar(require("./ActiveOrgUpdateRequest"), exports);
22
23
  __exportStar(require("./AddEnvironmentRepoRequest"), exports);
24
+ __exportStar(require("./AiProxySettings"), exports);
25
+ __exportStar(require("./AiProxySettingsAllOfPricing"), exports);
26
+ __exportStar(require("./AiUsageRow"), exports);
27
+ __exportStar(require("./AiUsageTotals"), exports);
23
28
  __exportStar(require("./ApiKey"), exports);
24
29
  __exportStar(require("./ApiKeyCatalog"), exports);
25
30
  __exportStar(require("./ApiKeyCatalogScopeResources"), exports);
@@ -48,11 +53,18 @@ __exportStar(require("./CommandStreamFrame"), exports);
48
53
  __exportStar(require("./CompletionEvent"), exports);
49
54
  __exportStar(require("./Conversation"), exports);
50
55
  __exportStar(require("./ConversationsResponse"), exports);
56
+ __exportStar(require("./CreateCredentialProfileRequest"), exports);
51
57
  __exportStar(require("./CreateSandboxEnvironmentRequest"), exports);
52
58
  __exportStar(require("./CreateSandboxRequest"), exports);
53
59
  __exportStar(require("./CreateSandboxResponse"), exports);
54
60
  __exportStar(require("./CreateScopedApiKey503Response"), exports);
55
61
  __exportStar(require("./CreateScopedApiKeyRequest"), exports);
62
+ __exportStar(require("./CredentialId"), exports);
63
+ __exportStar(require("./CredentialProfile"), exports);
64
+ __exportStar(require("./CredentialProfileDeletedResponse"), exports);
65
+ __exportStar(require("./CredentialProfileListResponse"), exports);
66
+ __exportStar(require("./CredentialProfileOwner"), exports);
67
+ __exportStar(require("./CredentialProfileResponse"), exports);
56
68
  __exportStar(require("./DataRetentionPolicyResponse"), exports);
57
69
  __exportStar(require("./DataRetentionUpdateRequest"), exports);
58
70
  __exportStar(require("./DeletionOperation"), exports);
@@ -66,6 +78,8 @@ __exportStar(require("./ErrorEnvelopeError"), exports);
66
78
  __exportStar(require("./ErrorEvent"), exports);
67
79
  __exportStar(require("./EventsResponse"), exports);
68
80
  __exportStar(require("./FileReadResponse"), exports);
81
+ __exportStar(require("./FileUrlRequest"), exports);
82
+ __exportStar(require("./FileUrlResponse"), exports);
69
83
  __exportStar(require("./FileWriteRequest"), exports);
70
84
  __exportStar(require("./FileWriteResponse"), exports);
71
85
  __exportStar(require("./ForkRequest"), exports);
@@ -115,6 +129,9 @@ __exportStar(require("./ResumeRequest"), exports);
115
129
  __exportStar(require("./RotateApiKey409Response"), exports);
116
130
  __exportStar(require("./Sandbox"), exports);
117
131
  __exportStar(require("./SandboxActionResponse"), exports);
132
+ __exportStar(require("./SandboxAiAccessResponse"), exports);
133
+ __exportStar(require("./SandboxAiUsage"), exports);
134
+ __exportStar(require("./SandboxAiUsageResponse"), exports);
118
135
  __exportStar(require("./SandboxEnvironment"), exports);
119
136
  __exportStar(require("./SandboxEnvironmentListResponse"), exports);
120
137
  __exportStar(require("./SandboxEnvironmentResponse"), exports);
@@ -129,8 +146,11 @@ __exportStar(require("./SecretFile"), exports);
129
146
  __exportStar(require("./SecretsResponse"), exports);
130
147
  __exportStar(require("./SecretsUpdateRequest"), exports);
131
148
  __exportStar(require("./SelectedRepository"), exports);
149
+ __exportStar(require("./SetCredentialKeyRequest"), exports);
150
+ __exportStar(require("./SetCustomApiRequest"), exports);
132
151
  __exportStar(require("./SetEnvironmentSecretFileRequest"), exports);
133
152
  __exportStar(require("./SetEnvironmentVarRequest"), exports);
153
+ __exportStar(require("./SetSandboxAiAccessRequest"), exports);
134
154
  __exportStar(require("./Share200Response"), exports);
135
155
  __exportStar(require("./SnapshotChunk"), exports);
136
156
  __exportStar(require("./SnapshotDownloadResponse"), exports);
@@ -158,6 +178,8 @@ __exportStar(require("./TelemetrySetRequest"), exports);
158
178
  __exportStar(require("./TelemetrySetResponse"), exports);
159
179
  __exportStar(require("./TelemetryTestResult"), exports);
160
180
  __exportStar(require("./UnknownEvent"), exports);
181
+ __exportStar(require("./UpdateAiProxyRequest"), exports);
182
+ __exportStar(require("./UpdateCredentialProfileRequest"), exports);
161
183
  __exportStar(require("./UpdateSandboxEnvironmentRequest"), exports);
162
184
  __exportStar(require("./UpdateSandboxEnvironmentRequestRepositoriesInner"), exports);
163
185
  __exportStar(require("./UpdateSandboxRequest"), exports);
@@ -0,0 +1,48 @@
1
+
2
+ # AccountAiUsageResponse
3
+
4
+
5
+ ## Properties
6
+
7
+ Name | Type
8
+ ------------ | -------------
9
+ `ok` | boolean
10
+ `type` | string
11
+ `accountId` | string
12
+ `profileId` | string
13
+ `since` | Date
14
+ `sandboxes` | [Array&lt;SandboxAiUsage&gt;](SandboxAiUsage.md)
15
+ `usage` | [Array&lt;AiUsageRow&gt;](AiUsageRow.md)
16
+ `totals` | [AiUsageTotals](AiUsageTotals.md)
17
+ `dollars` | number
18
+
19
+ ## Example
20
+
21
+ ```typescript
22
+ import type { AccountAiUsageResponse } from '@boatdev/sdk'
23
+
24
+ // TODO: Update the object below with actual values
25
+ const example = {
26
+ "ok": null,
27
+ "type": null,
28
+ "accountId": null,
29
+ "profileId": null,
30
+ "since": null,
31
+ "sandboxes": null,
32
+ "usage": null,
33
+ "totals": null,
34
+ "dollars": null,
35
+ } satisfies AccountAiUsageResponse
36
+
37
+ console.log(example)
38
+
39
+ // Convert the instance to a JSON string
40
+ const exampleJSON: string = JSON.stringify(example)
41
+ console.log(exampleJSON)
42
+
43
+ // Parse the JSON string back to an object
44
+ const exampleParsed = JSON.parse(exampleJSON) as AccountAiUsageResponse
45
+ console.log(exampleParsed)
46
+ ```
47
+
48
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)