@boatdev/sdk 1.0.0 → 1.0.1

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 (226) hide show
  1. package/.openapi-generator/FILES +20 -0
  2. package/dist/apis/BoatApi.d.ts +36 -2
  3. package/dist/apis/BoatApi.js +86 -2
  4. package/dist/esm/apis/BoatApi.d.ts +36 -2
  5. package/dist/esm/apis/BoatApi.js +86 -2
  6. package/dist/esm/models/ActiveOrgResponse.d.ts +52 -0
  7. package/dist/esm/models/ActiveOrgResponse.js +58 -0
  8. package/dist/esm/models/ActiveOrgResponseAllOfActive.d.ts +52 -0
  9. package/dist/esm/models/ActiveOrgResponseAllOfActive.js +58 -0
  10. package/dist/esm/models/ActiveOrgUpdateRequest.d.ts +32 -0
  11. package/dist/esm/models/ActiveOrgUpdateRequest.js +43 -0
  12. package/dist/esm/models/CommandResponse.d.ts +6 -0
  13. package/dist/esm/models/CommandResponse.js +2 -0
  14. package/dist/esm/models/CommandStatusResponse.d.ts +6 -0
  15. package/dist/esm/models/CommandStatusResponse.js +2 -0
  16. package/dist/esm/models/CreateSandboxRequest.d.ts +2 -3
  17. package/dist/esm/models/CreateSandboxRequest.js +1 -2
  18. package/dist/esm/models/CreateSandboxResponse.d.ts +8 -1
  19. package/dist/esm/models/CreateSandboxResponse.js +4 -1
  20. package/dist/esm/models/ForkRequest.d.ts +1 -2
  21. package/dist/esm/models/ForkRequest.js +1 -2
  22. package/dist/esm/models/LimitsFields.d.ts +80 -0
  23. package/dist/esm/models/LimitsFields.js +28 -0
  24. package/dist/esm/models/LimitsFieldsCurrentLimits.d.ts +6 -0
  25. package/dist/esm/models/LimitsFieldsCurrentLimits.js +2 -0
  26. package/dist/esm/models/LimitsFieldsGiftLimit.d.ts +50 -0
  27. package/dist/esm/models/LimitsFieldsGiftLimit.js +47 -0
  28. package/dist/esm/models/LimitsFieldsSandboxPlanTiersInner.d.ts +80 -0
  29. package/dist/esm/models/LimitsFieldsSandboxPlanTiersInner.js +57 -0
  30. package/dist/esm/models/LimitsResponse.d.ts +80 -0
  31. package/dist/esm/models/LimitsResponse.js +28 -0
  32. package/dist/esm/models/MeResponseAllOfUser.d.ts +109 -0
  33. package/dist/esm/models/MeResponseAllOfUser.js +47 -0
  34. package/dist/esm/models/Org.d.ts +84 -0
  35. package/dist/esm/models/Org.js +79 -0
  36. package/dist/esm/models/OrgListResponse.d.ts +58 -0
  37. package/dist/esm/models/OrgListResponse.js +62 -0
  38. package/dist/esm/models/PromptEventData.d.ts +20 -0
  39. package/dist/esm/models/PromptEventData.js +8 -0
  40. package/dist/esm/models/PromptEventDataAttachmentsInner.d.ts +44 -0
  41. package/dist/esm/models/PromptEventDataAttachmentsInner.js +45 -0
  42. package/dist/esm/models/PromptEventDataCitationsInner.d.ts +50 -0
  43. package/dist/esm/models/PromptEventDataCitationsInner.js +47 -0
  44. package/dist/esm/models/RepoSelectionResponse.d.ts +6 -0
  45. package/dist/esm/models/RepoSelectionResponse.js +2 -0
  46. package/dist/esm/models/ReposResponse.d.ts +6 -0
  47. package/dist/esm/models/ReposResponse.js +2 -0
  48. package/dist/esm/models/Repository.d.ts +18 -0
  49. package/dist/esm/models/Repository.js +6 -0
  50. package/dist/esm/models/ResponseEventData.d.ts +6 -0
  51. package/dist/esm/models/ResponseEventData.js +2 -0
  52. package/dist/esm/models/ResumeRequest.d.ts +1 -2
  53. package/dist/esm/models/ResumeRequest.js +1 -2
  54. package/dist/esm/models/Sandbox.d.ts +43 -4
  55. package/dist/esm/models/Sandbox.js +21 -3
  56. package/dist/esm/models/SandboxActionResponse.d.ts +12 -0
  57. package/dist/esm/models/SandboxActionResponse.js +4 -0
  58. package/dist/esm/models/SandboxEnvironment.d.ts +12 -0
  59. package/dist/esm/models/SandboxEnvironment.js +4 -0
  60. package/dist/esm/models/SandboxEnvironmentListResponse.d.ts +26 -0
  61. package/dist/esm/models/SandboxEnvironmentListResponse.js +16 -0
  62. package/dist/esm/models/SandboxInfoResponse.d.ts +6 -0
  63. package/dist/esm/models/SandboxInfoResponse.js +2 -0
  64. package/dist/esm/models/SandboxTeam.d.ts +38 -0
  65. package/dist/esm/models/SandboxTeam.js +47 -0
  66. package/dist/esm/models/SandboxUsageResponse.d.ts +1 -2
  67. package/dist/esm/models/SandboxUsageResponse.js +1 -2
  68. package/dist/esm/models/SecretsResponse.d.ts +6 -0
  69. package/dist/esm/models/SecretsResponse.js +2 -0
  70. package/dist/esm/models/SelectedRepository.d.ts +18 -0
  71. package/dist/esm/models/SelectedRepository.js +6 -0
  72. package/dist/esm/models/SnapshotChunk.d.ts +2 -2
  73. package/dist/esm/models/SnapshotSummary.d.ts +3 -3
  74. package/dist/esm/models/SshKeyResponse.d.ts +12 -0
  75. package/dist/esm/models/SshKeyResponse.js +4 -0
  76. package/dist/esm/models/UpgradeSandboxEnvironmentResponse.d.ts +18 -0
  77. package/dist/esm/models/UpgradeSandboxEnvironmentResponse.js +6 -0
  78. package/dist/esm/models/index.d.ts +10 -0
  79. package/dist/esm/models/index.js +10 -0
  80. package/dist/models/ActiveOrgResponse.d.ts +52 -0
  81. package/dist/models/ActiveOrgResponse.js +66 -0
  82. package/dist/models/ActiveOrgResponseAllOfActive.d.ts +52 -0
  83. package/dist/models/ActiveOrgResponseAllOfActive.js +66 -0
  84. package/dist/models/ActiveOrgUpdateRequest.d.ts +32 -0
  85. package/dist/models/ActiveOrgUpdateRequest.js +50 -0
  86. package/dist/models/CommandResponse.d.ts +6 -0
  87. package/dist/models/CommandResponse.js +2 -0
  88. package/dist/models/CommandStatusResponse.d.ts +6 -0
  89. package/dist/models/CommandStatusResponse.js +2 -0
  90. package/dist/models/CreateSandboxRequest.d.ts +2 -3
  91. package/dist/models/CreateSandboxRequest.js +1 -2
  92. package/dist/models/CreateSandboxResponse.d.ts +8 -1
  93. package/dist/models/CreateSandboxResponse.js +4 -1
  94. package/dist/models/ForkRequest.d.ts +1 -2
  95. package/dist/models/ForkRequest.js +1 -2
  96. package/dist/models/LimitsFields.d.ts +80 -0
  97. package/dist/models/LimitsFields.js +28 -0
  98. package/dist/models/LimitsFieldsCurrentLimits.d.ts +6 -0
  99. package/dist/models/LimitsFieldsCurrentLimits.js +2 -0
  100. package/dist/models/LimitsFieldsGiftLimit.d.ts +50 -0
  101. package/dist/models/LimitsFieldsGiftLimit.js +54 -0
  102. package/dist/models/LimitsFieldsSandboxPlanTiersInner.d.ts +80 -0
  103. package/dist/models/LimitsFieldsSandboxPlanTiersInner.js +64 -0
  104. package/dist/models/LimitsResponse.d.ts +80 -0
  105. package/dist/models/LimitsResponse.js +28 -0
  106. package/dist/models/MeResponseAllOfUser.d.ts +109 -0
  107. package/dist/models/MeResponseAllOfUser.js +48 -0
  108. package/dist/models/Org.d.ts +84 -0
  109. package/dist/models/Org.js +87 -0
  110. package/dist/models/OrgListResponse.d.ts +58 -0
  111. package/dist/models/OrgListResponse.js +70 -0
  112. package/dist/models/PromptEventData.d.ts +20 -0
  113. package/dist/models/PromptEventData.js +8 -0
  114. package/dist/models/PromptEventDataAttachmentsInner.d.ts +44 -0
  115. package/dist/models/PromptEventDataAttachmentsInner.js +52 -0
  116. package/dist/models/PromptEventDataCitationsInner.d.ts +50 -0
  117. package/dist/models/PromptEventDataCitationsInner.js +54 -0
  118. package/dist/models/RepoSelectionResponse.d.ts +6 -0
  119. package/dist/models/RepoSelectionResponse.js +2 -0
  120. package/dist/models/ReposResponse.d.ts +6 -0
  121. package/dist/models/ReposResponse.js +2 -0
  122. package/dist/models/Repository.d.ts +18 -0
  123. package/dist/models/Repository.js +6 -0
  124. package/dist/models/ResponseEventData.d.ts +6 -0
  125. package/dist/models/ResponseEventData.js +2 -0
  126. package/dist/models/ResumeRequest.d.ts +1 -2
  127. package/dist/models/ResumeRequest.js +1 -2
  128. package/dist/models/Sandbox.d.ts +43 -4
  129. package/dist/models/Sandbox.js +22 -4
  130. package/dist/models/SandboxActionResponse.d.ts +12 -0
  131. package/dist/models/SandboxActionResponse.js +4 -0
  132. package/dist/models/SandboxEnvironment.d.ts +12 -0
  133. package/dist/models/SandboxEnvironment.js +4 -0
  134. package/dist/models/SandboxEnvironmentListResponse.d.ts +26 -0
  135. package/dist/models/SandboxEnvironmentListResponse.js +17 -0
  136. package/dist/models/SandboxInfoResponse.d.ts +6 -0
  137. package/dist/models/SandboxInfoResponse.js +2 -0
  138. package/dist/models/SandboxTeam.d.ts +38 -0
  139. package/dist/models/SandboxTeam.js +54 -0
  140. package/dist/models/SandboxUsageResponse.d.ts +1 -2
  141. package/dist/models/SandboxUsageResponse.js +1 -2
  142. package/dist/models/SecretsResponse.d.ts +6 -0
  143. package/dist/models/SecretsResponse.js +2 -0
  144. package/dist/models/SelectedRepository.d.ts +18 -0
  145. package/dist/models/SelectedRepository.js +6 -0
  146. package/dist/models/SnapshotChunk.d.ts +2 -2
  147. package/dist/models/SnapshotSummary.d.ts +3 -3
  148. package/dist/models/SshKeyResponse.d.ts +12 -0
  149. package/dist/models/SshKeyResponse.js +4 -0
  150. package/dist/models/UpgradeSandboxEnvironmentResponse.d.ts +18 -0
  151. package/dist/models/UpgradeSandboxEnvironmentResponse.js +6 -0
  152. package/dist/models/index.d.ts +10 -0
  153. package/dist/models/index.js +10 -0
  154. package/docs/ActiveOrgResponse.md +36 -0
  155. package/docs/ActiveOrgResponseAllOfActive.md +36 -0
  156. package/docs/ActiveOrgUpdateRequest.md +32 -0
  157. package/docs/BoatApi.md +148 -7
  158. package/docs/Command200Response.md +2 -0
  159. package/docs/CommandResponse.md +2 -0
  160. package/docs/CommandStatusResponse.md +2 -0
  161. package/docs/CreateSandboxResponse.md +2 -0
  162. package/docs/LimitsFields.md +26 -0
  163. package/docs/LimitsFieldsCurrentLimits.md +2 -0
  164. package/docs/LimitsFieldsGiftLimit.md +39 -0
  165. package/docs/LimitsFieldsSandboxPlanTiersInner.md +48 -0
  166. package/docs/LimitsResponse.md +26 -0
  167. package/docs/MeResponseAllOfUser.md +30 -0
  168. package/docs/Org.md +44 -0
  169. package/docs/OrgListResponse.md +38 -0
  170. package/docs/PromptEventData.md +6 -0
  171. package/docs/PromptEventDataAttachmentsInner.md +36 -0
  172. package/docs/PromptEventDataCitationsInner.md +38 -0
  173. package/docs/RepoSelectionResponse.md +2 -0
  174. package/docs/ReposResponse.md +2 -0
  175. package/docs/Repository.md +6 -0
  176. package/docs/ResponseEventData.md +2 -0
  177. package/docs/Sandbox.md +10 -0
  178. package/docs/SandboxActionResponse.md +4 -0
  179. package/docs/SandboxEnvironment.md +4 -0
  180. package/docs/SandboxEnvironmentListResponse.md +4 -0
  181. package/docs/SandboxInfoResponse.md +2 -0
  182. package/docs/SandboxTeam.md +35 -0
  183. package/docs/SecretsResponse.md +2 -0
  184. package/docs/SelectedRepository.md +6 -0
  185. package/docs/SshKeyResponse.md +4 -0
  186. package/docs/UpgradeSandboxEnvironmentResponse.md +6 -0
  187. package/package.json +1 -1
  188. package/src/apis/BoatApi.ts +125 -2
  189. package/src/models/ActiveOrgResponse.ts +102 -0
  190. package/src/models/ActiveOrgResponseAllOfActive.ts +95 -0
  191. package/src/models/ActiveOrgUpdateRequest.ts +66 -0
  192. package/src/models/CommandResponse.ts +8 -0
  193. package/src/models/CommandStatusResponse.ts +8 -0
  194. package/src/models/CreateSandboxRequest.ts +3 -4
  195. package/src/models/CreateSandboxResponse.ts +11 -2
  196. package/src/models/ForkRequest.ts +2 -3
  197. package/src/models/LimitsFields.ts +118 -0
  198. package/src/models/LimitsFieldsCurrentLimits.ts +8 -0
  199. package/src/models/LimitsFieldsGiftLimit.ts +89 -0
  200. package/src/models/LimitsFieldsSandboxPlanTiersInner.ts +129 -0
  201. package/src/models/LimitsResponse.ts +118 -0
  202. package/src/models/MeResponseAllOfUser.ts +143 -0
  203. package/src/models/Org.ts +139 -0
  204. package/src/models/OrgListResponse.ts +111 -0
  205. package/src/models/PromptEventData.ts +39 -0
  206. package/src/models/PromptEventDataAttachmentsInner.ts +81 -0
  207. package/src/models/PromptEventDataCitationsInner.ts +89 -0
  208. package/src/models/RepoSelectionResponse.ts +8 -0
  209. package/src/models/ReposResponse.ts +8 -0
  210. package/src/models/Repository.ts +24 -0
  211. package/src/models/ResponseEventData.ts +8 -0
  212. package/src/models/ResumeRequest.ts +2 -3
  213. package/src/models/Sandbox.ts +63 -6
  214. package/src/models/SandboxActionResponse.ts +16 -0
  215. package/src/models/SandboxEnvironment.ts +16 -0
  216. package/src/models/SandboxEnvironmentListResponse.ts +34 -0
  217. package/src/models/SandboxInfoResponse.ts +8 -0
  218. package/src/models/SandboxTeam.ts +75 -0
  219. package/src/models/SandboxUsageResponse.ts +2 -3
  220. package/src/models/SecretsResponse.ts +8 -0
  221. package/src/models/SelectedRepository.ts +24 -0
  222. package/src/models/SnapshotChunk.ts +2 -2
  223. package/src/models/SnapshotSummary.ts +3 -3
  224. package/src/models/SshKeyResponse.ts +16 -0
  225. package/src/models/UpgradeSandboxEnvironmentResponse.ts +24 -0
  226. package/src/models/index.ts +10 -0
@@ -0,0 +1,52 @@
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 ActiveOrgResponseAllOfActive
16
+ */
17
+ export interface ActiveOrgResponseAllOfActive {
18
+ /**
19
+ *
20
+ * @type {string}
21
+ * @memberof ActiveOrgResponseAllOfActive
22
+ */
23
+ id: string;
24
+ /**
25
+ *
26
+ * @type {string}
27
+ * @memberof ActiveOrgResponseAllOfActive
28
+ */
29
+ name: string;
30
+ /**
31
+ *
32
+ * @type {ActiveOrgResponseAllOfActiveTypeEnum}
33
+ * @memberof ActiveOrgResponseAllOfActive
34
+ */
35
+ type: ActiveOrgResponseAllOfActiveTypeEnum;
36
+ }
37
+ /**
38
+ * @export
39
+ */
40
+ export declare const ActiveOrgResponseAllOfActiveTypeEnum: {
41
+ readonly Personal: 'personal';
42
+ readonly Org: 'org';
43
+ };
44
+ export type ActiveOrgResponseAllOfActiveTypeEnum = typeof ActiveOrgResponseAllOfActiveTypeEnum[keyof typeof ActiveOrgResponseAllOfActiveTypeEnum];
45
+ /**
46
+ * Check if a given object implements the ActiveOrgResponseAllOfActive interface.
47
+ */
48
+ export declare function instanceOfActiveOrgResponseAllOfActive(value: object): value is ActiveOrgResponseAllOfActive;
49
+ export declare function ActiveOrgResponseAllOfActiveFromJSON(json: any): ActiveOrgResponseAllOfActive;
50
+ export declare function ActiveOrgResponseAllOfActiveFromJSONTyped(json: any, ignoreDiscriminator: boolean): ActiveOrgResponseAllOfActive;
51
+ export declare function ActiveOrgResponseAllOfActiveToJSON(json: any): ActiveOrgResponseAllOfActive;
52
+ export declare function ActiveOrgResponseAllOfActiveToJSONTyped(value?: ActiveOrgResponseAllOfActive | null, ignoreDiscriminator?: boolean): any;
@@ -0,0 +1,58 @@
1
+ /* tslint:disable */
2
+ /* eslint-disable */
3
+ /**
4
+ * Boat Public API v1
5
+ * 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.
6
+ *
7
+ * The version of the OpenAPI document: 1.0.0
8
+ *
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
+ * @export
16
+ */
17
+ export const ActiveOrgResponseAllOfActiveTypeEnum = {
18
+ Personal: 'personal',
19
+ Org: 'org'
20
+ };
21
+ /**
22
+ * Check if a given object implements the ActiveOrgResponseAllOfActive interface.
23
+ */
24
+ export function instanceOfActiveOrgResponseAllOfActive(value) {
25
+ if (!('id' in value) || value['id'] === undefined)
26
+ return false;
27
+ if (!('name' in value) || value['name'] === undefined)
28
+ return false;
29
+ if (!('type' in value) || value['type'] === undefined)
30
+ return false;
31
+ return true;
32
+ }
33
+ export function ActiveOrgResponseAllOfActiveFromJSON(json) {
34
+ return ActiveOrgResponseAllOfActiveFromJSONTyped(json, false);
35
+ }
36
+ export function ActiveOrgResponseAllOfActiveFromJSONTyped(json, ignoreDiscriminator) {
37
+ if (json == null) {
38
+ return json;
39
+ }
40
+ return {
41
+ 'id': json['id'],
42
+ 'name': json['name'],
43
+ 'type': json['type'],
44
+ };
45
+ }
46
+ export function ActiveOrgResponseAllOfActiveToJSON(json) {
47
+ return ActiveOrgResponseAllOfActiveToJSONTyped(json, false);
48
+ }
49
+ export function ActiveOrgResponseAllOfActiveToJSONTyped(value, ignoreDiscriminator = false) {
50
+ if (value == null) {
51
+ return value;
52
+ }
53
+ return {
54
+ 'id': value['id'],
55
+ 'name': value['name'],
56
+ 'type': value['type'],
57
+ };
58
+ }
@@ -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 ActiveOrgUpdateRequest
16
+ */
17
+ export interface ActiveOrgUpdateRequest {
18
+ /**
19
+ * Organization id or name you belong to; `personal`, your own id or `null` for personal.
20
+ * @type {string}
21
+ * @memberof ActiveOrgUpdateRequest
22
+ */
23
+ org: string | null;
24
+ }
25
+ /**
26
+ * Check if a given object implements the ActiveOrgUpdateRequest interface.
27
+ */
28
+ export declare function instanceOfActiveOrgUpdateRequest(value: object): value is ActiveOrgUpdateRequest;
29
+ export declare function ActiveOrgUpdateRequestFromJSON(json: any): ActiveOrgUpdateRequest;
30
+ export declare function ActiveOrgUpdateRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): ActiveOrgUpdateRequest;
31
+ export declare function ActiveOrgUpdateRequestToJSON(json: any): ActiveOrgUpdateRequest;
32
+ export declare function ActiveOrgUpdateRequestToJSONTyped(value?: ActiveOrgUpdateRequest | null, ignoreDiscriminator?: boolean): any;
@@ -0,0 +1,43 @@
1
+ /* tslint:disable */
2
+ /* eslint-disable */
3
+ /**
4
+ * Boat Public API v1
5
+ * 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.
6
+ *
7
+ * The version of the OpenAPI document: 1.0.0
8
+ *
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
+ * Check if a given object implements the ActiveOrgUpdateRequest interface.
16
+ */
17
+ export function instanceOfActiveOrgUpdateRequest(value) {
18
+ if (!('org' in value) || value['org'] === undefined)
19
+ return false;
20
+ return true;
21
+ }
22
+ export function ActiveOrgUpdateRequestFromJSON(json) {
23
+ return ActiveOrgUpdateRequestFromJSONTyped(json, false);
24
+ }
25
+ export function ActiveOrgUpdateRequestFromJSONTyped(json, ignoreDiscriminator) {
26
+ if (json == null) {
27
+ return json;
28
+ }
29
+ return {
30
+ 'org': json['org'],
31
+ };
32
+ }
33
+ export function ActiveOrgUpdateRequestToJSON(json) {
34
+ return ActiveOrgUpdateRequestToJSONTyped(json, false);
35
+ }
36
+ export function ActiveOrgUpdateRequestToJSONTyped(value, ignoreDiscriminator = false) {
37
+ if (value == null) {
38
+ return value;
39
+ }
40
+ return {
41
+ 'org': value['org'],
42
+ };
43
+ }
@@ -45,6 +45,12 @@ export interface CommandResponse {
45
45
  * @memberof CommandResponse
46
46
  */
47
47
  signal?: string | null;
48
+ /**
49
+ * True when the memory ceiling killed the command or one of its processes and the command failed.
50
+ * @type {boolean}
51
+ * @memberof CommandResponse
52
+ */
53
+ oomKilled?: boolean;
48
54
  /**
49
55
  *
50
56
  * @type {string}
@@ -50,6 +50,7 @@ export function CommandResponseFromJSONTyped(json, ignoreDiscriminator) {
50
50
  'success': json['success'],
51
51
  'exitCode': json['exitCode'],
52
52
  'signal': json['signal'] == null ? undefined : json['signal'],
53
+ 'oomKilled': json['oomKilled'] == null ? undefined : json['oomKilled'],
53
54
  'stdout': json['stdout'],
54
55
  'stderr': json['stderr'],
55
56
  'stdoutTruncated': json['stdoutTruncated'] == null ? undefined : json['stdoutTruncated'],
@@ -73,6 +74,7 @@ export function CommandResponseToJSONTyped(value, ignoreDiscriminator = false) {
73
74
  'success': value['success'],
74
75
  'exitCode': value['exitCode'],
75
76
  'signal': value['signal'],
77
+ 'oomKilled': value['oomKilled'],
76
78
  'stdout': value['stdout'],
77
79
  'stderr': value['stderr'],
78
80
  'stdoutTruncated': value['stdoutTruncated'],
@@ -75,6 +75,12 @@ export interface CommandStatusResponse {
75
75
  * @memberof CommandStatusResponse
76
76
  */
77
77
  signal?: string | null;
78
+ /**
79
+ * True when the memory ceiling killed the command or one of its processes and the command failed.
80
+ * @type {boolean}
81
+ * @memberof CommandStatusResponse
82
+ */
83
+ oomKilled?: boolean;
78
84
  /**
79
85
  *
80
86
  * @type {string}
@@ -67,6 +67,7 @@ export function CommandStatusResponseFromJSONTyped(json, ignoreDiscriminator) {
67
67
  'running': json['running'],
68
68
  'exitCode': json['exitCode'],
69
69
  'signal': json['signal'] == null ? undefined : json['signal'],
70
+ 'oomKilled': json['oomKilled'] == null ? undefined : json['oomKilled'],
70
71
  'command': json['command'] == null ? undefined : json['command'],
71
72
  'cwd': json['cwd'] == null ? undefined : json['cwd'],
72
73
  'startedAt': json['startedAt'] == null ? undefined : (new Date(json['startedAt'])),
@@ -97,6 +98,7 @@ export function CommandStatusResponseToJSONTyped(value, ignoreDiscriminator = fa
97
98
  'running': value['running'],
98
99
  'exitCode': value['exitCode'],
99
100
  'signal': value['signal'],
101
+ 'oomKilled': value['oomKilled'],
100
102
  'command': value['command'],
101
103
  'cwd': value['cwd'],
102
104
  'startedAt': value['startedAt'] == null ? value['startedAt'] : value['startedAt'].toISOString(),
@@ -16,7 +16,7 @@
16
16
  */
17
17
  export interface CreateSandboxRequest {
18
18
  /**
19
- * Machine size. `small` consumes machine time at half rate and `large` at twice the default rate (see the Billing guide). `xlarge` costs $0.20 per running hour, requires the effective $100 plan or higher, and requires an explicit bare-metal operator allocation. A fork inherits the source sandbox's type unless the fork request passes its own, and resume and fork can move a sandbox between sizes.
19
+ * Machine size. `small` consumes machine time at half rate and `large` at twice the default rate (see the Billing guide). A fork inherits the source sandbox's type unless the fork request passes its own, and resume and fork can move a sandbox between sizes.
20
20
  * @type {CreateSandboxRequestTypeEnum}
21
21
  * @memberof CreateSandboxRequest
22
22
  */
@@ -54,7 +54,7 @@ export interface CreateSandboxRequest {
54
54
  */
55
55
  setupScript?: string;
56
56
  /**
57
- * Bill this sandbox to a team you belong to (the team's shared wallet). Your own account id means personal billing. Listing, snapshots, and environments stay yours: the org is a wallet, not a shared workspace. Takes precedence over `teamId` and over the `X-Boat-Org` / `?org=` request scope.
57
+ * Bill this sandbox to an organization you belong to (its shared wallet), by id or by name as `GET /orgs` lists it; `personal` or your own account id means personal billing. Omitted, the `X-Boat-Org` / `?org=` request scope applies, then the account's active wallet (`PATCH /orgs/active`), then personal. Listing, snapshots, and environments stay yours: the org is a wallet, not a shared workspace. Takes precedence over `teamId`.
58
58
  * @type {string}
59
59
  * @memberof CreateSandboxRequest
60
60
  */
@@ -79,7 +79,6 @@ export declare const CreateSandboxRequestTypeEnum: {
79
79
  readonly Small: 'small';
80
80
  readonly Default: 'default';
81
81
  readonly Large: 'large';
82
- readonly Xlarge: 'xlarge';
83
82
  };
84
83
  export type CreateSandboxRequestTypeEnum = typeof CreateSandboxRequestTypeEnum[keyof typeof CreateSandboxRequestTypeEnum];
85
84
  /**
@@ -17,8 +17,7 @@
17
17
  export const CreateSandboxRequestTypeEnum = {
18
18
  Small: 'small',
19
19
  Default: 'default',
20
- Large: 'large',
21
- Xlarge: 'xlarge'
20
+ Large: 'large'
22
21
  };
23
22
  /**
24
23
  * Check if a given object implements the CreateSandboxRequest interface.
@@ -29,7 +29,7 @@ export interface CreateSandboxResponse {
29
29
  */
30
30
  type: CreateSandboxResponseTypeEnum;
31
31
  /**
32
- *
32
+ * `ready` only when an idempotent retry finds a sandbox that is already past provisioning.
33
33
  * @type {CreateSandboxResponseStatusEnum}
34
34
  * @memberof CreateSandboxResponse
35
35
  */
@@ -46,6 +46,12 @@ export interface CreateSandboxResponse {
46
46
  * @memberof CreateSandboxResponse
47
47
  */
48
48
  sandbox: Sandbox;
49
+ /**
50
+ * Present when a fair-use cap on a gifted account shortened the requested auto-stop time.
51
+ * @type {string}
52
+ * @memberof CreateSandboxResponse
53
+ */
54
+ giftLimitNotice?: string;
49
55
  }
50
56
  /**
51
57
  * @export
@@ -59,6 +65,7 @@ export type CreateSandboxResponseTypeEnum = typeof CreateSandboxResponseTypeEnum
59
65
  */
60
66
  export declare const CreateSandboxResponseStatusEnum: {
61
67
  readonly Provisioning: 'provisioning';
68
+ readonly Ready: 'ready';
62
69
  };
63
70
  export type CreateSandboxResponseStatusEnum = typeof CreateSandboxResponseStatusEnum[keyof typeof CreateSandboxResponseStatusEnum];
64
71
  /**
@@ -22,7 +22,8 @@ export const CreateSandboxResponseTypeEnum = {
22
22
  * @export
23
23
  */
24
24
  export const CreateSandboxResponseStatusEnum = {
25
- Provisioning: 'provisioning'
25
+ Provisioning: 'provisioning',
26
+ Ready: 'ready'
26
27
  };
27
28
  /**
28
29
  * Check if a given object implements the CreateSandboxResponse interface.
@@ -53,6 +54,7 @@ export function CreateSandboxResponseFromJSONTyped(json, ignoreDiscriminator) {
53
54
  'status': json['status'],
54
55
  'ttlSeconds': json['ttlSeconds'],
55
56
  'sandbox': SandboxFromJSON(json['sandbox']),
57
+ 'giftLimitNotice': json['giftLimitNotice'] == null ? undefined : json['giftLimitNotice'],
56
58
  };
57
59
  }
58
60
  export function CreateSandboxResponseToJSON(json) {
@@ -68,5 +70,6 @@ export function CreateSandboxResponseToJSONTyped(value, ignoreDiscriminator = fa
68
70
  'status': value['status'],
69
71
  'ttlSeconds': value['ttlSeconds'],
70
72
  'sandbox': SandboxToJSON(value['sandbox']),
73
+ 'giftLimitNotice': value['giftLimitNotice'],
71
74
  };
72
75
  }
@@ -36,7 +36,7 @@ export interface ForkRequest {
36
36
  */
37
37
  noEnv?: boolean;
38
38
  /**
39
- * Machine size for the fork. Omit to inherit the source sandbox's type. The source sandbox is never modified. Shrinking is rejected with `type_too_small` when the source's data would not fit the smaller disk. `xlarge` requires the effective $100 plan or higher and an explicit bare-metal operator allocation.
39
+ * Machine size for the fork. Omit to inherit the source sandbox's type. The source sandbox is never modified. Shrinking is rejected with `type_too_small` when the source's data would not fit the smaller disk.
40
40
  * @type {ForkRequestTypeEnum}
41
41
  * @memberof ForkRequest
42
42
  */
@@ -55,7 +55,6 @@ export declare const ForkRequestTypeEnum: {
55
55
  readonly Small: 'small';
56
56
  readonly Default: 'default';
57
57
  readonly Large: 'large';
58
- readonly Xlarge: 'xlarge';
59
58
  };
60
59
  export type ForkRequestTypeEnum = typeof ForkRequestTypeEnum[keyof typeof ForkRequestTypeEnum];
61
60
  /**
@@ -17,8 +17,7 @@
17
17
  export const ForkRequestTypeEnum = {
18
18
  Small: 'small',
19
19
  Default: 'default',
20
- Large: 'large',
21
- Xlarge: 'xlarge'
20
+ Large: 'large'
22
21
  };
23
22
  /**
24
23
  * Check if a given object implements the ForkRequest interface.
@@ -9,9 +9,11 @@
9
9
  * https://openapi-generator.tech
10
10
  * Do not edit the class manually.
11
11
  */
12
+ import type { LimitsFieldsGiftLimit } from './LimitsFieldsGiftLimit';
12
13
  import type { LimitsFieldsCurrentLimits } from './LimitsFieldsCurrentLimits';
13
14
  import type { LimitsFieldsStartLimits } from './LimitsFieldsStartLimits';
14
15
  import type { LimitsFieldsStarts } from './LimitsFieldsStarts';
16
+ import type { LimitsFieldsSandboxPlanTiersInner } from './LimitsFieldsSandboxPlanTiersInner';
15
17
  /**
16
18
  *
17
19
  * @export
@@ -197,6 +199,84 @@ export interface LimitsFields {
197
199
  * @memberof LimitsFields
198
200
  */
199
201
  creditSecondsPerDollar?: number;
202
+ /**
203
+ * Current plan key, or `trial` before any payment.
204
+ * @type {string}
205
+ * @memberof LimitsFields
206
+ */
207
+ sandboxPlanKey?: string;
208
+ /**
209
+ * Monthly price of the current plan in dollars.
210
+ * @type {number}
211
+ * @memberof LimitsFields
212
+ */
213
+ sandboxPlanDollars?: number;
214
+ /**
215
+ * Every plan tier and its limits.
216
+ * @type {Array<LimitsFieldsSandboxPlanTiersInner>}
217
+ * @memberof LimitsFields
218
+ */
219
+ sandboxPlanTiers?: Array<LimitsFieldsSandboxPlanTiersInner>;
220
+ /**
221
+ *
222
+ * @type {string}
223
+ * @memberof LimitsFields
224
+ */
225
+ accountPlan?: string;
226
+ /**
227
+ * `service` for service accounts, otherwise null.
228
+ * @type {string}
229
+ * @memberof LimitsFields
230
+ */
231
+ plan?: string | null;
232
+ /**
233
+ * `Service` for service accounts, otherwise null.
234
+ * @type {string}
235
+ * @memberof LimitsFields
236
+ */
237
+ planName?: string | null;
238
+ /**
239
+ *
240
+ * @type {boolean}
241
+ * @memberof LimitsFields
242
+ */
243
+ serviceAccount?: boolean;
244
+ /**
245
+ * True when the account has no machine-time or start limits.
246
+ * @type {boolean}
247
+ * @memberof LimitsFields
248
+ */
249
+ unlimited?: boolean;
250
+ /**
251
+ * True when an organization has an active per-seat plan.
252
+ * @type {boolean}
253
+ * @memberof LimitsFields
254
+ */
255
+ hasSeatPlan?: boolean;
256
+ /**
257
+ * Machine time used in the last 24 hours, in seconds. Useful to estimate how long the balance lasts.
258
+ * @type {number}
259
+ * @memberof LimitsFields
260
+ */
261
+ last24hUsageSeconds?: number;
262
+ /**
263
+ * Lifetime machine-time allowance for a trial that never paid. Null once the account has paid or has a plan.
264
+ * @type {number}
265
+ * @memberof LimitsFields
266
+ */
267
+ trialComputeCapSeconds?: number | null;
268
+ /**
269
+ * The trial limits in one readable line. Null on paid accounts.
270
+ * @type {string}
271
+ * @memberof LimitsFields
272
+ */
273
+ trialLine?: string | null;
274
+ /**
275
+ *
276
+ * @type {LimitsFieldsGiftLimit}
277
+ * @memberof LimitsFields
278
+ */
279
+ giftLimit?: LimitsFieldsGiftLimit;
200
280
  /**
201
281
  * Account access state returned by the current backend. Billing endpoints are not part of v1.
202
282
  * @type {string}
@@ -11,9 +11,11 @@
11
11
  * https://openapi-generator.tech
12
12
  * Do not edit the class manually.
13
13
  */
14
+ import { LimitsFieldsGiftLimitFromJSON, LimitsFieldsGiftLimitToJSON, } from './LimitsFieldsGiftLimit';
14
15
  import { LimitsFieldsCurrentLimitsFromJSON, LimitsFieldsCurrentLimitsToJSON, } from './LimitsFieldsCurrentLimits';
15
16
  import { LimitsFieldsStartLimitsFromJSON, LimitsFieldsStartLimitsToJSON, } from './LimitsFieldsStartLimits';
16
17
  import { LimitsFieldsStartsFromJSON, LimitsFieldsStartsToJSON, } from './LimitsFieldsStarts';
18
+ import { LimitsFieldsSandboxPlanTiersInnerFromJSON, LimitsFieldsSandboxPlanTiersInnerToJSON, } from './LimitsFieldsSandboxPlanTiersInner';
17
19
  /**
18
20
  * Check if a given object implements the LimitsFields interface.
19
21
  */
@@ -66,6 +68,19 @@ export function LimitsFieldsFromJSONTyped(json, ignoreDiscriminator) {
66
68
  'creditUsedSeconds': json['creditUsedSeconds'] == null ? undefined : json['creditUsedSeconds'],
67
69
  'liveUsageSeconds': json['liveUsageSeconds'] == null ? undefined : json['liveUsageSeconds'],
68
70
  'creditSecondsPerDollar': json['creditSecondsPerDollar'] == null ? undefined : json['creditSecondsPerDollar'],
71
+ 'sandboxPlanKey': json['sandboxPlanKey'] == null ? undefined : json['sandboxPlanKey'],
72
+ 'sandboxPlanDollars': json['sandboxPlanDollars'] == null ? undefined : json['sandboxPlanDollars'],
73
+ 'sandboxPlanTiers': json['sandboxPlanTiers'] == null ? undefined : (json['sandboxPlanTiers'].map(LimitsFieldsSandboxPlanTiersInnerFromJSON)),
74
+ 'accountPlan': json['accountPlan'] == null ? undefined : json['accountPlan'],
75
+ 'plan': json['plan'] == null ? undefined : json['plan'],
76
+ 'planName': json['planName'] == null ? undefined : json['planName'],
77
+ 'serviceAccount': json['serviceAccount'] == null ? undefined : json['serviceAccount'],
78
+ 'unlimited': json['unlimited'] == null ? undefined : json['unlimited'],
79
+ 'hasSeatPlan': json['hasSeatPlan'] == null ? undefined : json['hasSeatPlan'],
80
+ 'last24hUsageSeconds': json['last24hUsageSeconds'] == null ? undefined : json['last24hUsageSeconds'],
81
+ 'trialComputeCapSeconds': json['trialComputeCapSeconds'] == null ? undefined : json['trialComputeCapSeconds'],
82
+ 'trialLine': json['trialLine'] == null ? undefined : json['trialLine'],
83
+ 'giftLimit': json['giftLimit'] == null ? undefined : LimitsFieldsGiftLimitFromJSON(json['giftLimit']),
69
84
  'billingStatus': json['billingStatus'],
70
85
  'subscriptionStatus': json['subscriptionStatus'] == null ? undefined : json['subscriptionStatus'],
71
86
  'subscriptionCancelAtPeriodEnd': json['subscriptionCancelAtPeriodEnd'] == null ? undefined : json['subscriptionCancelAtPeriodEnd'],
@@ -115,6 +130,19 @@ export function LimitsFieldsToJSONTyped(value, ignoreDiscriminator = false) {
115
130
  'creditUsedSeconds': value['creditUsedSeconds'],
116
131
  'liveUsageSeconds': value['liveUsageSeconds'],
117
132
  'creditSecondsPerDollar': value['creditSecondsPerDollar'],
133
+ 'sandboxPlanKey': value['sandboxPlanKey'],
134
+ 'sandboxPlanDollars': value['sandboxPlanDollars'],
135
+ 'sandboxPlanTiers': value['sandboxPlanTiers'] == null ? undefined : (value['sandboxPlanTiers'].map(LimitsFieldsSandboxPlanTiersInnerToJSON)),
136
+ 'accountPlan': value['accountPlan'],
137
+ 'plan': value['plan'],
138
+ 'planName': value['planName'],
139
+ 'serviceAccount': value['serviceAccount'],
140
+ 'unlimited': value['unlimited'],
141
+ 'hasSeatPlan': value['hasSeatPlan'],
142
+ 'last24hUsageSeconds': value['last24hUsageSeconds'],
143
+ 'trialComputeCapSeconds': value['trialComputeCapSeconds'],
144
+ 'trialLine': value['trialLine'],
145
+ 'giftLimit': LimitsFieldsGiftLimitToJSON(value['giftLimit']),
118
146
  'billingStatus': value['billingStatus'],
119
147
  'subscriptionStatus': value['subscriptionStatus'],
120
148
  'subscriptionCancelAtPeriodEnd': value['subscriptionCancelAtPeriodEnd'],
@@ -28,6 +28,12 @@ export interface LimitsFieldsCurrentLimits {
28
28
  * @memberof LimitsFieldsCurrentLimits
29
29
  */
30
30
  creationRatePerMinute?: number;
31
+ /**
32
+ *
33
+ * @type {number}
34
+ * @memberof LimitsFieldsCurrentLimits
35
+ */
36
+ creationRequestsPerHour?: number | null;
31
37
  /**
32
38
  *
33
39
  * @type {number}
@@ -28,6 +28,7 @@ export function LimitsFieldsCurrentLimitsFromJSONTyped(json, ignoreDiscriminator
28
28
  ...json,
29
29
  'activeSandboxes': json['activeSandboxes'] == null ? undefined : json['activeSandboxes'],
30
30
  'creationRatePerMinute': json['creationRatePerMinute'] == null ? undefined : json['creationRatePerMinute'],
31
+ 'creationRequestsPerHour': json['creationRequestsPerHour'] == null ? undefined : json['creationRequestsPerHour'],
31
32
  'creationRequestsPerDay': json['creationRequestsPerDay'] == null ? undefined : json['creationRequestsPerDay'],
32
33
  };
33
34
  }
@@ -42,6 +43,7 @@ export function LimitsFieldsCurrentLimitsToJSONTyped(value, ignoreDiscriminator
42
43
  ...value,
43
44
  'activeSandboxes': value['activeSandboxes'],
44
45
  'creationRatePerMinute': value['creationRatePerMinute'],
46
+ 'creationRequestsPerHour': value['creationRequestsPerHour'],
45
47
  'creationRequestsPerDay': value['creationRequestsPerDay'],
46
48
  };
47
49
  }
@@ -0,0 +1,50 @@
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
+ * Fair-use caps on a gifted account, or null when there are none.
14
+ * @export
15
+ * @interface LimitsFieldsGiftLimit
16
+ */
17
+ export interface LimitsFieldsGiftLimit {
18
+ /**
19
+ *
20
+ * @type {number}
21
+ * @memberof LimitsFieldsGiftLimit
22
+ */
23
+ maxActiveSandboxes?: number | null;
24
+ /**
25
+ *
26
+ * @type {number}
27
+ * @memberof LimitsFieldsGiftLimit
28
+ */
29
+ maxTtlSeconds?: number | null;
30
+ /**
31
+ * The caps in one readable line.
32
+ * @type {string}
33
+ * @memberof LimitsFieldsGiftLimit
34
+ */
35
+ line?: string | null;
36
+ /**
37
+ * The same text shown when a cap is hit.
38
+ * @type {string}
39
+ * @memberof LimitsFieldsGiftLimit
40
+ */
41
+ message?: string;
42
+ }
43
+ /**
44
+ * Check if a given object implements the LimitsFieldsGiftLimit interface.
45
+ */
46
+ export declare function instanceOfLimitsFieldsGiftLimit(value: object): value is LimitsFieldsGiftLimit;
47
+ export declare function LimitsFieldsGiftLimitFromJSON(json: any): LimitsFieldsGiftLimit;
48
+ export declare function LimitsFieldsGiftLimitFromJSONTyped(json: any, ignoreDiscriminator: boolean): LimitsFieldsGiftLimit;
49
+ export declare function LimitsFieldsGiftLimitToJSON(json: any): LimitsFieldsGiftLimit;
50
+ export declare function LimitsFieldsGiftLimitToJSONTyped(value?: LimitsFieldsGiftLimit | null, ignoreDiscriminator?: boolean): any;
@@ -0,0 +1,47 @@
1
+ /* tslint:disable */
2
+ /* eslint-disable */
3
+ /**
4
+ * Boat Public API v1
5
+ * 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.
6
+ *
7
+ * The version of the OpenAPI document: 1.0.0
8
+ *
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
+ * Check if a given object implements the LimitsFieldsGiftLimit interface.
16
+ */
17
+ export function instanceOfLimitsFieldsGiftLimit(value) {
18
+ return true;
19
+ }
20
+ export function LimitsFieldsGiftLimitFromJSON(json) {
21
+ return LimitsFieldsGiftLimitFromJSONTyped(json, false);
22
+ }
23
+ export function LimitsFieldsGiftLimitFromJSONTyped(json, ignoreDiscriminator) {
24
+ if (json == null) {
25
+ return json;
26
+ }
27
+ return {
28
+ 'maxActiveSandboxes': json['maxActiveSandboxes'] == null ? undefined : json['maxActiveSandboxes'],
29
+ 'maxTtlSeconds': json['maxTtlSeconds'] == null ? undefined : json['maxTtlSeconds'],
30
+ 'line': json['line'] == null ? undefined : json['line'],
31
+ 'message': json['message'] == null ? undefined : json['message'],
32
+ };
33
+ }
34
+ export function LimitsFieldsGiftLimitToJSON(json) {
35
+ return LimitsFieldsGiftLimitToJSONTyped(json, false);
36
+ }
37
+ export function LimitsFieldsGiftLimitToJSONTyped(value, ignoreDiscriminator = false) {
38
+ if (value == null) {
39
+ return value;
40
+ }
41
+ return {
42
+ 'maxActiveSandboxes': value['maxActiveSandboxes'],
43
+ 'maxTtlSeconds': value['maxTtlSeconds'],
44
+ 'line': value['line'],
45
+ 'message': value['message'],
46
+ };
47
+ }