@boatdev/sdk 1.0.0 → 1.1.0

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 (244) hide show
  1. package/.openapi-generator/FILES +22 -0
  2. package/README.md +8 -26
  3. package/dist/apis/BoatApi.d.ts +132 -79
  4. package/dist/apis/BoatApi.js +188 -29
  5. package/dist/esm/apis/BoatApi.d.ts +132 -79
  6. package/dist/esm/apis/BoatApi.js +188 -29
  7. package/dist/esm/models/ActiveOrgResponse.d.ts +52 -0
  8. package/dist/esm/models/ActiveOrgResponse.js +58 -0
  9. package/dist/esm/models/ActiveOrgResponseAllOfActive.d.ts +52 -0
  10. package/dist/esm/models/ActiveOrgResponseAllOfActive.js +58 -0
  11. package/dist/esm/models/ActiveOrgUpdateRequest.d.ts +32 -0
  12. package/dist/esm/models/ActiveOrgUpdateRequest.js +43 -0
  13. package/dist/esm/models/CommandResponse.d.ts +6 -0
  14. package/dist/esm/models/CommandResponse.js +2 -0
  15. package/dist/esm/models/CommandStatusResponse.d.ts +6 -0
  16. package/dist/esm/models/CommandStatusResponse.js +2 -0
  17. package/dist/esm/models/CreateSandboxRequest.d.ts +2 -3
  18. package/dist/esm/models/CreateSandboxRequest.js +1 -2
  19. package/dist/esm/models/CreateSandboxResponse.d.ts +8 -1
  20. package/dist/esm/models/CreateSandboxResponse.js +4 -1
  21. package/dist/esm/models/DeletionOperation.d.ts +24 -0
  22. package/dist/esm/models/DeletionOperation.js +15 -0
  23. package/dist/esm/models/DeletionOperationListResponse.d.ts +52 -0
  24. package/dist/esm/models/DeletionOperationListResponse.js +58 -0
  25. package/dist/esm/models/ForkRequest.d.ts +1 -2
  26. package/dist/esm/models/ForkRequest.js +1 -2
  27. package/dist/esm/models/LimitsFields.d.ts +80 -0
  28. package/dist/esm/models/LimitsFields.js +28 -0
  29. package/dist/esm/models/LimitsFieldsCurrentLimits.d.ts +6 -0
  30. package/dist/esm/models/LimitsFieldsCurrentLimits.js +2 -0
  31. package/dist/esm/models/LimitsFieldsGiftLimit.d.ts +50 -0
  32. package/dist/esm/models/LimitsFieldsGiftLimit.js +47 -0
  33. package/dist/esm/models/LimitsFieldsSandboxPlanTiersInner.d.ts +80 -0
  34. package/dist/esm/models/LimitsFieldsSandboxPlanTiersInner.js +57 -0
  35. package/dist/esm/models/LimitsResponse.d.ts +80 -0
  36. package/dist/esm/models/LimitsResponse.js +28 -0
  37. package/dist/esm/models/MeResponseAllOfUser.d.ts +109 -0
  38. package/dist/esm/models/MeResponseAllOfUser.js +47 -0
  39. package/dist/esm/models/Org.d.ts +84 -0
  40. package/dist/esm/models/Org.js +79 -0
  41. package/dist/esm/models/OrgListResponse.d.ts +58 -0
  42. package/dist/esm/models/OrgListResponse.js +62 -0
  43. package/dist/esm/models/PromptEventData.d.ts +20 -0
  44. package/dist/esm/models/PromptEventData.js +8 -0
  45. package/dist/esm/models/PromptEventDataAttachmentsInner.d.ts +44 -0
  46. package/dist/esm/models/PromptEventDataAttachmentsInner.js +45 -0
  47. package/dist/esm/models/PromptEventDataCitationsInner.d.ts +50 -0
  48. package/dist/esm/models/PromptEventDataCitationsInner.js +47 -0
  49. package/dist/esm/models/RepoSelectionResponse.d.ts +6 -0
  50. package/dist/esm/models/RepoSelectionResponse.js +2 -0
  51. package/dist/esm/models/ReposResponse.d.ts +6 -0
  52. package/dist/esm/models/ReposResponse.js +2 -0
  53. package/dist/esm/models/Repository.d.ts +18 -0
  54. package/dist/esm/models/Repository.js +6 -0
  55. package/dist/esm/models/ResponseEventData.d.ts +6 -0
  56. package/dist/esm/models/ResponseEventData.js +2 -0
  57. package/dist/esm/models/ResumeRequest.d.ts +1 -2
  58. package/dist/esm/models/ResumeRequest.js +1 -2
  59. package/dist/esm/models/Sandbox.d.ts +43 -4
  60. package/dist/esm/models/Sandbox.js +21 -3
  61. package/dist/esm/models/SandboxActionResponse.d.ts +12 -0
  62. package/dist/esm/models/SandboxActionResponse.js +4 -0
  63. package/dist/esm/models/SandboxEnvironment.d.ts +12 -0
  64. package/dist/esm/models/SandboxEnvironment.js +4 -0
  65. package/dist/esm/models/SandboxEnvironmentListResponse.d.ts +26 -0
  66. package/dist/esm/models/SandboxEnvironmentListResponse.js +16 -0
  67. package/dist/esm/models/SandboxInfoResponse.d.ts +6 -0
  68. package/dist/esm/models/SandboxInfoResponse.js +2 -0
  69. package/dist/esm/models/SandboxTeam.d.ts +38 -0
  70. package/dist/esm/models/SandboxTeam.js +47 -0
  71. package/dist/esm/models/SandboxUsageResponse.d.ts +1 -2
  72. package/dist/esm/models/SandboxUsageResponse.js +1 -2
  73. package/dist/esm/models/SecretsResponse.d.ts +6 -0
  74. package/dist/esm/models/SecretsResponse.js +2 -0
  75. package/dist/esm/models/SelectedRepository.d.ts +18 -0
  76. package/dist/esm/models/SelectedRepository.js +6 -0
  77. package/dist/esm/models/SnapshotChunk.d.ts +2 -2
  78. package/dist/esm/models/SnapshotSummary.d.ts +3 -3
  79. package/dist/esm/models/SshKeyResponse.d.ts +12 -0
  80. package/dist/esm/models/SshKeyResponse.js +4 -0
  81. package/dist/esm/models/UpgradeSandboxEnvironmentResponse.d.ts +18 -0
  82. package/dist/esm/models/UpgradeSandboxEnvironmentResponse.js +6 -0
  83. package/dist/esm/models/index.d.ts +11 -0
  84. package/dist/esm/models/index.js +11 -0
  85. package/dist/esm/runtime.d.ts +8 -0
  86. package/dist/esm/runtime.js +18 -0
  87. package/dist/models/ActiveOrgResponse.d.ts +52 -0
  88. package/dist/models/ActiveOrgResponse.js +66 -0
  89. package/dist/models/ActiveOrgResponseAllOfActive.d.ts +52 -0
  90. package/dist/models/ActiveOrgResponseAllOfActive.js +66 -0
  91. package/dist/models/ActiveOrgUpdateRequest.d.ts +32 -0
  92. package/dist/models/ActiveOrgUpdateRequest.js +50 -0
  93. package/dist/models/CommandResponse.d.ts +6 -0
  94. package/dist/models/CommandResponse.js +2 -0
  95. package/dist/models/CommandStatusResponse.d.ts +6 -0
  96. package/dist/models/CommandStatusResponse.js +2 -0
  97. package/dist/models/CreateSandboxRequest.d.ts +2 -3
  98. package/dist/models/CreateSandboxRequest.js +1 -2
  99. package/dist/models/CreateSandboxResponse.d.ts +8 -1
  100. package/dist/models/CreateSandboxResponse.js +4 -1
  101. package/dist/models/DeletionOperation.d.ts +24 -0
  102. package/dist/models/DeletionOperation.js +16 -1
  103. package/dist/models/DeletionOperationListResponse.d.ts +52 -0
  104. package/dist/models/DeletionOperationListResponse.js +66 -0
  105. package/dist/models/ForkRequest.d.ts +1 -2
  106. package/dist/models/ForkRequest.js +1 -2
  107. package/dist/models/LimitsFields.d.ts +80 -0
  108. package/dist/models/LimitsFields.js +28 -0
  109. package/dist/models/LimitsFieldsCurrentLimits.d.ts +6 -0
  110. package/dist/models/LimitsFieldsCurrentLimits.js +2 -0
  111. package/dist/models/LimitsFieldsGiftLimit.d.ts +50 -0
  112. package/dist/models/LimitsFieldsGiftLimit.js +54 -0
  113. package/dist/models/LimitsFieldsSandboxPlanTiersInner.d.ts +80 -0
  114. package/dist/models/LimitsFieldsSandboxPlanTiersInner.js +64 -0
  115. package/dist/models/LimitsResponse.d.ts +80 -0
  116. package/dist/models/LimitsResponse.js +28 -0
  117. package/dist/models/MeResponseAllOfUser.d.ts +109 -0
  118. package/dist/models/MeResponseAllOfUser.js +48 -0
  119. package/dist/models/Org.d.ts +84 -0
  120. package/dist/models/Org.js +87 -0
  121. package/dist/models/OrgListResponse.d.ts +58 -0
  122. package/dist/models/OrgListResponse.js +70 -0
  123. package/dist/models/PromptEventData.d.ts +20 -0
  124. package/dist/models/PromptEventData.js +8 -0
  125. package/dist/models/PromptEventDataAttachmentsInner.d.ts +44 -0
  126. package/dist/models/PromptEventDataAttachmentsInner.js +52 -0
  127. package/dist/models/PromptEventDataCitationsInner.d.ts +50 -0
  128. package/dist/models/PromptEventDataCitationsInner.js +54 -0
  129. package/dist/models/RepoSelectionResponse.d.ts +6 -0
  130. package/dist/models/RepoSelectionResponse.js +2 -0
  131. package/dist/models/ReposResponse.d.ts +6 -0
  132. package/dist/models/ReposResponse.js +2 -0
  133. package/dist/models/Repository.d.ts +18 -0
  134. package/dist/models/Repository.js +6 -0
  135. package/dist/models/ResponseEventData.d.ts +6 -0
  136. package/dist/models/ResponseEventData.js +2 -0
  137. package/dist/models/ResumeRequest.d.ts +1 -2
  138. package/dist/models/ResumeRequest.js +1 -2
  139. package/dist/models/Sandbox.d.ts +43 -4
  140. package/dist/models/Sandbox.js +22 -4
  141. package/dist/models/SandboxActionResponse.d.ts +12 -0
  142. package/dist/models/SandboxActionResponse.js +4 -0
  143. package/dist/models/SandboxEnvironment.d.ts +12 -0
  144. package/dist/models/SandboxEnvironment.js +4 -0
  145. package/dist/models/SandboxEnvironmentListResponse.d.ts +26 -0
  146. package/dist/models/SandboxEnvironmentListResponse.js +17 -0
  147. package/dist/models/SandboxInfoResponse.d.ts +6 -0
  148. package/dist/models/SandboxInfoResponse.js +2 -0
  149. package/dist/models/SandboxTeam.d.ts +38 -0
  150. package/dist/models/SandboxTeam.js +54 -0
  151. package/dist/models/SandboxUsageResponse.d.ts +1 -2
  152. package/dist/models/SandboxUsageResponse.js +1 -2
  153. package/dist/models/SecretsResponse.d.ts +6 -0
  154. package/dist/models/SecretsResponse.js +2 -0
  155. package/dist/models/SelectedRepository.d.ts +18 -0
  156. package/dist/models/SelectedRepository.js +6 -0
  157. package/dist/models/SnapshotChunk.d.ts +2 -2
  158. package/dist/models/SnapshotSummary.d.ts +3 -3
  159. package/dist/models/SshKeyResponse.d.ts +12 -0
  160. package/dist/models/SshKeyResponse.js +4 -0
  161. package/dist/models/UpgradeSandboxEnvironmentResponse.d.ts +18 -0
  162. package/dist/models/UpgradeSandboxEnvironmentResponse.js +6 -0
  163. package/dist/models/index.d.ts +11 -0
  164. package/dist/models/index.js +11 -0
  165. package/dist/runtime.d.ts +8 -0
  166. package/dist/runtime.js +19 -0
  167. package/docs/ActiveOrgResponse.md +36 -0
  168. package/docs/ActiveOrgResponseAllOfActive.md +36 -0
  169. package/docs/ActiveOrgUpdateRequest.md +32 -0
  170. package/docs/BoatApi.md +228 -8
  171. package/docs/Command200Response.md +2 -0
  172. package/docs/CommandResponse.md +2 -0
  173. package/docs/CommandStatusResponse.md +2 -0
  174. package/docs/CreateSandboxResponse.md +2 -0
  175. package/docs/DeletionOperation.md +4 -0
  176. package/docs/DeletionOperationListResponse.md +36 -0
  177. package/docs/LimitsFields.md +26 -0
  178. package/docs/LimitsFieldsCurrentLimits.md +2 -0
  179. package/docs/LimitsFieldsGiftLimit.md +39 -0
  180. package/docs/LimitsFieldsSandboxPlanTiersInner.md +48 -0
  181. package/docs/LimitsResponse.md +26 -0
  182. package/docs/MeResponseAllOfUser.md +30 -0
  183. package/docs/Org.md +44 -0
  184. package/docs/OrgListResponse.md +38 -0
  185. package/docs/PromptEventData.md +6 -0
  186. package/docs/PromptEventDataAttachmentsInner.md +36 -0
  187. package/docs/PromptEventDataCitationsInner.md +38 -0
  188. package/docs/RepoSelectionResponse.md +2 -0
  189. package/docs/ReposResponse.md +2 -0
  190. package/docs/Repository.md +6 -0
  191. package/docs/ResponseEventData.md +2 -0
  192. package/docs/Sandbox.md +10 -0
  193. package/docs/SandboxActionResponse.md +4 -0
  194. package/docs/SandboxEnvironment.md +4 -0
  195. package/docs/SandboxEnvironmentListResponse.md +4 -0
  196. package/docs/SandboxInfoResponse.md +2 -0
  197. package/docs/SandboxTeam.md +35 -0
  198. package/docs/SecretsResponse.md +2 -0
  199. package/docs/SelectedRepository.md +6 -0
  200. package/docs/SshKeyResponse.md +4 -0
  201. package/docs/UpgradeSandboxEnvironmentResponse.md +6 -0
  202. package/package.json +1 -1
  203. package/src/apis/BoatApi.ts +304 -79
  204. package/src/models/ActiveOrgResponse.ts +102 -0
  205. package/src/models/ActiveOrgResponseAllOfActive.ts +95 -0
  206. package/src/models/ActiveOrgUpdateRequest.ts +66 -0
  207. package/src/models/CommandResponse.ts +8 -0
  208. package/src/models/CommandStatusResponse.ts +8 -0
  209. package/src/models/CreateSandboxRequest.ts +3 -4
  210. package/src/models/CreateSandboxResponse.ts +11 -2
  211. package/src/models/DeletionOperation.ts +29 -0
  212. package/src/models/DeletionOperationListResponse.ts +102 -0
  213. package/src/models/ForkRequest.ts +2 -3
  214. package/src/models/LimitsFields.ts +118 -0
  215. package/src/models/LimitsFieldsCurrentLimits.ts +8 -0
  216. package/src/models/LimitsFieldsGiftLimit.ts +89 -0
  217. package/src/models/LimitsFieldsSandboxPlanTiersInner.ts +129 -0
  218. package/src/models/LimitsResponse.ts +118 -0
  219. package/src/models/MeResponseAllOfUser.ts +143 -0
  220. package/src/models/Org.ts +139 -0
  221. package/src/models/OrgListResponse.ts +111 -0
  222. package/src/models/PromptEventData.ts +39 -0
  223. package/src/models/PromptEventDataAttachmentsInner.ts +81 -0
  224. package/src/models/PromptEventDataCitationsInner.ts +89 -0
  225. package/src/models/RepoSelectionResponse.ts +8 -0
  226. package/src/models/ReposResponse.ts +8 -0
  227. package/src/models/Repository.ts +24 -0
  228. package/src/models/ResponseEventData.ts +8 -0
  229. package/src/models/ResumeRequest.ts +2 -3
  230. package/src/models/Sandbox.ts +63 -6
  231. package/src/models/SandboxActionResponse.ts +16 -0
  232. package/src/models/SandboxEnvironment.ts +16 -0
  233. package/src/models/SandboxEnvironmentListResponse.ts +34 -0
  234. package/src/models/SandboxInfoResponse.ts +8 -0
  235. package/src/models/SandboxTeam.ts +75 -0
  236. package/src/models/SandboxUsageResponse.ts +2 -3
  237. package/src/models/SecretsResponse.ts +8 -0
  238. package/src/models/SelectedRepository.ts +24 -0
  239. package/src/models/SnapshotChunk.ts +2 -2
  240. package/src/models/SnapshotSummary.ts +3 -3
  241. package/src/models/SshKeyResponse.ts +16 -0
  242. package/src/models/UpgradeSandboxEnvironmentResponse.ts +24 -0
  243. package/src/models/index.ts +11 -0
  244. package/src/runtime.ts +23 -0
@@ -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
+ }
@@ -0,0 +1,80 @@
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 LimitsFieldsSandboxPlanTiersInner
16
+ */
17
+ export interface LimitsFieldsSandboxPlanTiersInner {
18
+ /**
19
+ *
20
+ * @type {string}
21
+ * @memberof LimitsFieldsSandboxPlanTiersInner
22
+ */
23
+ key?: string;
24
+ /**
25
+ *
26
+ * @type {number}
27
+ * @memberof LimitsFieldsSandboxPlanTiersInner
28
+ */
29
+ dollars?: number;
30
+ /**
31
+ *
32
+ * @type {string}
33
+ * @memberof LimitsFieldsSandboxPlanTiersInner
34
+ */
35
+ displayPrice?: string;
36
+ /**
37
+ *
38
+ * @type {number}
39
+ * @memberof LimitsFieldsSandboxPlanTiersInner
40
+ */
41
+ maxActiveSandboxes?: number;
42
+ /**
43
+ *
44
+ * @type {number}
45
+ * @memberof LimitsFieldsSandboxPlanTiersInner
46
+ */
47
+ startsPerMinute?: number;
48
+ /**
49
+ *
50
+ * @type {number}
51
+ * @memberof LimitsFieldsSandboxPlanTiersInner
52
+ */
53
+ startsPerHour?: number;
54
+ /**
55
+ *
56
+ * @type {number}
57
+ * @memberof LimitsFieldsSandboxPlanTiersInner
58
+ */
59
+ startsPerDay?: number;
60
+ /**
61
+ * Machine time included each month.
62
+ * @type {number}
63
+ * @memberof LimitsFieldsSandboxPlanTiersInner
64
+ */
65
+ includedSeconds?: number;
66
+ /**
67
+ * Whether this tier can be bought right now.
68
+ * @type {boolean}
69
+ * @memberof LimitsFieldsSandboxPlanTiersInner
70
+ */
71
+ purchasable?: boolean;
72
+ }
73
+ /**
74
+ * Check if a given object implements the LimitsFieldsSandboxPlanTiersInner interface.
75
+ */
76
+ export declare function instanceOfLimitsFieldsSandboxPlanTiersInner(value: object): value is LimitsFieldsSandboxPlanTiersInner;
77
+ export declare function LimitsFieldsSandboxPlanTiersInnerFromJSON(json: any): LimitsFieldsSandboxPlanTiersInner;
78
+ export declare function LimitsFieldsSandboxPlanTiersInnerFromJSONTyped(json: any, ignoreDiscriminator: boolean): LimitsFieldsSandboxPlanTiersInner;
79
+ export declare function LimitsFieldsSandboxPlanTiersInnerToJSON(json: any): LimitsFieldsSandboxPlanTiersInner;
80
+ export declare function LimitsFieldsSandboxPlanTiersInnerToJSONTyped(value?: LimitsFieldsSandboxPlanTiersInner | null, ignoreDiscriminator?: boolean): any;
@@ -0,0 +1,57 @@
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 LimitsFieldsSandboxPlanTiersInner interface.
16
+ */
17
+ export function instanceOfLimitsFieldsSandboxPlanTiersInner(value) {
18
+ return true;
19
+ }
20
+ export function LimitsFieldsSandboxPlanTiersInnerFromJSON(json) {
21
+ return LimitsFieldsSandboxPlanTiersInnerFromJSONTyped(json, false);
22
+ }
23
+ export function LimitsFieldsSandboxPlanTiersInnerFromJSONTyped(json, ignoreDiscriminator) {
24
+ if (json == null) {
25
+ return json;
26
+ }
27
+ return {
28
+ 'key': json['key'] == null ? undefined : json['key'],
29
+ 'dollars': json['dollars'] == null ? undefined : json['dollars'],
30
+ 'displayPrice': json['displayPrice'] == null ? undefined : json['displayPrice'],
31
+ 'maxActiveSandboxes': json['maxActiveSandboxes'] == null ? undefined : json['maxActiveSandboxes'],
32
+ 'startsPerMinute': json['startsPerMinute'] == null ? undefined : json['startsPerMinute'],
33
+ 'startsPerHour': json['startsPerHour'] == null ? undefined : json['startsPerHour'],
34
+ 'startsPerDay': json['startsPerDay'] == null ? undefined : json['startsPerDay'],
35
+ 'includedSeconds': json['includedSeconds'] == null ? undefined : json['includedSeconds'],
36
+ 'purchasable': json['purchasable'] == null ? undefined : json['purchasable'],
37
+ };
38
+ }
39
+ export function LimitsFieldsSandboxPlanTiersInnerToJSON(json) {
40
+ return LimitsFieldsSandboxPlanTiersInnerToJSONTyped(json, false);
41
+ }
42
+ export function LimitsFieldsSandboxPlanTiersInnerToJSONTyped(value, ignoreDiscriminator = false) {
43
+ if (value == null) {
44
+ return value;
45
+ }
46
+ return {
47
+ 'key': value['key'],
48
+ 'dollars': value['dollars'],
49
+ 'displayPrice': value['displayPrice'],
50
+ 'maxActiveSandboxes': value['maxActiveSandboxes'],
51
+ 'startsPerMinute': value['startsPerMinute'],
52
+ 'startsPerHour': value['startsPerHour'],
53
+ 'startsPerDay': value['startsPerDay'],
54
+ 'includedSeconds': value['includedSeconds'],
55
+ 'purchasable': value['purchasable'],
56
+ };
57
+ }
@@ -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
@@ -208,6 +210,84 @@ export interface LimitsResponse {
208
210
  * @memberof LimitsResponse
209
211
  */
210
212
  creditSecondsPerDollar?: number;
213
+ /**
214
+ * Current plan key, or `trial` before any payment.
215
+ * @type {string}
216
+ * @memberof LimitsResponse
217
+ */
218
+ sandboxPlanKey?: string;
219
+ /**
220
+ * Monthly price of the current plan in dollars.
221
+ * @type {number}
222
+ * @memberof LimitsResponse
223
+ */
224
+ sandboxPlanDollars?: number;
225
+ /**
226
+ * Every plan tier and its limits.
227
+ * @type {Array<LimitsFieldsSandboxPlanTiersInner>}
228
+ * @memberof LimitsResponse
229
+ */
230
+ sandboxPlanTiers?: Array<LimitsFieldsSandboxPlanTiersInner>;
231
+ /**
232
+ *
233
+ * @type {string}
234
+ * @memberof LimitsResponse
235
+ */
236
+ accountPlan?: string;
237
+ /**
238
+ * `service` for service accounts, otherwise null.
239
+ * @type {string}
240
+ * @memberof LimitsResponse
241
+ */
242
+ plan?: string;
243
+ /**
244
+ * `Service` for service accounts, otherwise null.
245
+ * @type {string}
246
+ * @memberof LimitsResponse
247
+ */
248
+ planName?: string;
249
+ /**
250
+ *
251
+ * @type {boolean}
252
+ * @memberof LimitsResponse
253
+ */
254
+ serviceAccount?: boolean;
255
+ /**
256
+ * True when the account has no machine-time or start limits.
257
+ * @type {boolean}
258
+ * @memberof LimitsResponse
259
+ */
260
+ unlimited?: boolean;
261
+ /**
262
+ * True when an organization has an active per-seat plan.
263
+ * @type {boolean}
264
+ * @memberof LimitsResponse
265
+ */
266
+ hasSeatPlan?: boolean;
267
+ /**
268
+ * Machine time used in the last 24 hours, in seconds. Useful to estimate how long the balance lasts.
269
+ * @type {number}
270
+ * @memberof LimitsResponse
271
+ */
272
+ last24hUsageSeconds?: number;
273
+ /**
274
+ * Lifetime machine-time allowance for a trial that never paid. Null once the account has paid or has a plan.
275
+ * @type {number}
276
+ * @memberof LimitsResponse
277
+ */
278
+ trialComputeCapSeconds?: number;
279
+ /**
280
+ * The trial limits in one readable line. Null on paid accounts.
281
+ * @type {string}
282
+ * @memberof LimitsResponse
283
+ */
284
+ trialLine?: string;
285
+ /**
286
+ *
287
+ * @type {LimitsFieldsGiftLimit}
288
+ * @memberof LimitsResponse
289
+ */
290
+ giftLimit?: LimitsFieldsGiftLimit;
211
291
  /**
212
292
  * Account access state returned by the current backend. Billing endpoints are not part of v1.
213
293
  * @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 LimitsResponse interface.
19
21
  */
@@ -71,6 +73,19 @@ export function LimitsResponseFromJSONTyped(json, ignoreDiscriminator) {
71
73
  'creditUsedSeconds': json['creditUsedSeconds'] == null ? undefined : json['creditUsedSeconds'],
72
74
  'liveUsageSeconds': json['liveUsageSeconds'] == null ? undefined : json['liveUsageSeconds'],
73
75
  'creditSecondsPerDollar': json['creditSecondsPerDollar'] == null ? undefined : json['creditSecondsPerDollar'],
76
+ 'sandboxPlanKey': json['sandboxPlanKey'] == null ? undefined : json['sandboxPlanKey'],
77
+ 'sandboxPlanDollars': json['sandboxPlanDollars'] == null ? undefined : json['sandboxPlanDollars'],
78
+ 'sandboxPlanTiers': json['sandboxPlanTiers'] == null ? undefined : (json['sandboxPlanTiers'].map(LimitsFieldsSandboxPlanTiersInnerFromJSON)),
79
+ 'accountPlan': json['accountPlan'] == null ? undefined : json['accountPlan'],
80
+ 'plan': json['plan'] == null ? undefined : json['plan'],
81
+ 'planName': json['planName'] == null ? undefined : json['planName'],
82
+ 'serviceAccount': json['serviceAccount'] == null ? undefined : json['serviceAccount'],
83
+ 'unlimited': json['unlimited'] == null ? undefined : json['unlimited'],
84
+ 'hasSeatPlan': json['hasSeatPlan'] == null ? undefined : json['hasSeatPlan'],
85
+ 'last24hUsageSeconds': json['last24hUsageSeconds'] == null ? undefined : json['last24hUsageSeconds'],
86
+ 'trialComputeCapSeconds': json['trialComputeCapSeconds'] == null ? undefined : json['trialComputeCapSeconds'],
87
+ 'trialLine': json['trialLine'] == null ? undefined : json['trialLine'],
88
+ 'giftLimit': json['giftLimit'] == null ? undefined : LimitsFieldsGiftLimitFromJSON(json['giftLimit']),
74
89
  'billingStatus': json['billingStatus'],
75
90
  'subscriptionStatus': json['subscriptionStatus'] == null ? undefined : json['subscriptionStatus'],
76
91
  'subscriptionCancelAtPeriodEnd': json['subscriptionCancelAtPeriodEnd'] == null ? undefined : json['subscriptionCancelAtPeriodEnd'],
@@ -121,6 +136,19 @@ export function LimitsResponseToJSONTyped(value, ignoreDiscriminator = false) {
121
136
  'creditUsedSeconds': value['creditUsedSeconds'],
122
137
  'liveUsageSeconds': value['liveUsageSeconds'],
123
138
  'creditSecondsPerDollar': value['creditSecondsPerDollar'],
139
+ 'sandboxPlanKey': value['sandboxPlanKey'],
140
+ 'sandboxPlanDollars': value['sandboxPlanDollars'],
141
+ 'sandboxPlanTiers': value['sandboxPlanTiers'] == null ? undefined : (value['sandboxPlanTiers'].map(LimitsFieldsSandboxPlanTiersInnerToJSON)),
142
+ 'accountPlan': value['accountPlan'],
143
+ 'plan': value['plan'],
144
+ 'planName': value['planName'],
145
+ 'serviceAccount': value['serviceAccount'],
146
+ 'unlimited': value['unlimited'],
147
+ 'hasSeatPlan': value['hasSeatPlan'],
148
+ 'last24hUsageSeconds': value['last24hUsageSeconds'],
149
+ 'trialComputeCapSeconds': value['trialComputeCapSeconds'],
150
+ 'trialLine': value['trialLine'],
151
+ 'giftLimit': LimitsFieldsGiftLimitToJSON(value['giftLimit']),
124
152
  'billingStatus': value['billingStatus'],
125
153
  'subscriptionStatus': value['subscriptionStatus'],
126
154
  'subscriptionCancelAtPeriodEnd': value['subscriptionCancelAtPeriodEnd'],
@@ -15,6 +15,12 @@
15
15
  * @interface MeResponseAllOfUser
16
16
  */
17
17
  export interface MeResponseAllOfUser {
18
+ /**
19
+ * Your account id.
20
+ * @type {string}
21
+ * @memberof MeResponseAllOfUser
22
+ */
23
+ id?: string;
18
24
  /**
19
25
  *
20
26
  * @type {string}
@@ -27,6 +33,90 @@ export interface MeResponseAllOfUser {
27
33
  * @memberof MeResponseAllOfUser
28
34
  */
29
35
  email?: string | null;
36
+ /**
37
+ *
38
+ * @type {string}
39
+ * @memberof MeResponseAllOfUser
40
+ */
41
+ displayName?: string;
42
+ /**
43
+ * The login method the account was created with.
44
+ * @type {MeResponseAllOfUserConnectionMethodEnum}
45
+ * @memberof MeResponseAllOfUser
46
+ */
47
+ connectionMethod?: MeResponseAllOfUserConnectionMethodEnum;
48
+ /**
49
+ * Every login method linked to the account.
50
+ * @type {Array<string>}
51
+ * @memberof MeResponseAllOfUser
52
+ */
53
+ connectionMethods?: Array<string>;
54
+ /**
55
+ *
56
+ * @type {string}
57
+ * @memberof MeResponseAllOfUser
58
+ */
59
+ accountPlan?: string;
60
+ /**
61
+ *
62
+ * @type {boolean}
63
+ * @memberof MeResponseAllOfUser
64
+ */
65
+ serviceAccount?: boolean;
66
+ /**
67
+ *
68
+ * @type {MeResponseAllOfUserAccountStatusEnum}
69
+ * @memberof MeResponseAllOfUser
70
+ */
71
+ accountStatus?: MeResponseAllOfUserAccountStatusEnum;
72
+ /**
73
+ *
74
+ * @type {boolean}
75
+ * @memberof MeResponseAllOfUser
76
+ */
77
+ suspended?: boolean;
78
+ /**
79
+ *
80
+ * @type {Date}
81
+ * @memberof MeResponseAllOfUser
82
+ */
83
+ suspendedAt?: Date | null;
84
+ /**
85
+ *
86
+ * @type {string}
87
+ * @memberof MeResponseAllOfUser
88
+ */
89
+ suspendedReason?: string | null;
90
+ /**
91
+ *
92
+ * @type {boolean}
93
+ * @memberof MeResponseAllOfUser
94
+ */
95
+ closed?: boolean;
96
+ /**
97
+ *
98
+ * @type {Date}
99
+ * @memberof MeResponseAllOfUser
100
+ */
101
+ closedAt?: Date | null;
102
+ /**
103
+ * When a closed account's data is scheduled for deletion.
104
+ * @type {Date}
105
+ * @memberof MeResponseAllOfUser
106
+ */
107
+ purgeAt?: Date | null;
108
+ /**
109
+ * When a closed account's data was deleted.
110
+ * @type {Date}
111
+ * @memberof MeResponseAllOfUser
112
+ */
113
+ purgedAt?: Date | null;
114
+ /**
115
+ * Address to contact about a suspended or closed account.
116
+ * @type {string}
117
+ * @memberof MeResponseAllOfUser
118
+ */
119
+ closureContactEmail?: string;
30
120
  /**
31
121
  * Whether archived sandbox data is configured for deletion instead of retention.
32
122
  * @type {boolean}
@@ -40,6 +130,25 @@ export interface MeResponseAllOfUser {
40
130
  */
41
131
  zeroDataRetentionEnabledAt?: Date | null;
42
132
  }
133
+ /**
134
+ * @export
135
+ */
136
+ export declare const MeResponseAllOfUserConnectionMethodEnum: {
137
+ readonly Github: 'github';
138
+ readonly Google: 'google';
139
+ readonly Email: 'email';
140
+ readonly Service: 'service';
141
+ };
142
+ export type MeResponseAllOfUserConnectionMethodEnum = typeof MeResponseAllOfUserConnectionMethodEnum[keyof typeof MeResponseAllOfUserConnectionMethodEnum];
143
+ /**
144
+ * @export
145
+ */
146
+ export declare const MeResponseAllOfUserAccountStatusEnum: {
147
+ readonly Active: 'active';
148
+ readonly Suspended: 'suspended';
149
+ readonly Closed: 'closed';
150
+ };
151
+ export type MeResponseAllOfUserAccountStatusEnum = typeof MeResponseAllOfUserAccountStatusEnum[keyof typeof MeResponseAllOfUserAccountStatusEnum];
43
152
  /**
44
153
  * Check if a given object implements the MeResponseAllOfUser interface.
45
154
  */
@@ -11,6 +11,23 @@
11
11
  * https://openapi-generator.tech
12
12
  * Do not edit the class manually.
13
13
  */
14
+ /**
15
+ * @export
16
+ */
17
+ export const MeResponseAllOfUserConnectionMethodEnum = {
18
+ Github: 'github',
19
+ Google: 'google',
20
+ Email: 'email',
21
+ Service: 'service'
22
+ };
23
+ /**
24
+ * @export
25
+ */
26
+ export const MeResponseAllOfUserAccountStatusEnum = {
27
+ Active: 'active',
28
+ Suspended: 'suspended',
29
+ Closed: 'closed'
30
+ };
14
31
  /**
15
32
  * Check if a given object implements the MeResponseAllOfUser interface.
16
33
  */
@@ -25,8 +42,23 @@ export function MeResponseAllOfUserFromJSONTyped(json, ignoreDiscriminator) {
25
42
  return json;
26
43
  }
27
44
  return {
45
+ 'id': json['id'] == null ? undefined : json['id'],
28
46
  'login': json['login'] == null ? undefined : json['login'],
29
47
  'email': json['email'] == null ? undefined : json['email'],
48
+ 'displayName': json['displayName'] == null ? undefined : json['displayName'],
49
+ 'connectionMethod': json['connectionMethod'] == null ? undefined : json['connectionMethod'],
50
+ 'connectionMethods': json['connectionMethods'] == null ? undefined : json['connectionMethods'],
51
+ 'accountPlan': json['accountPlan'] == null ? undefined : json['accountPlan'],
52
+ 'serviceAccount': json['serviceAccount'] == null ? undefined : json['serviceAccount'],
53
+ 'accountStatus': json['accountStatus'] == null ? undefined : json['accountStatus'],
54
+ 'suspended': json['suspended'] == null ? undefined : json['suspended'],
55
+ 'suspendedAt': json['suspendedAt'] == null ? undefined : (new Date(json['suspendedAt'])),
56
+ 'suspendedReason': json['suspendedReason'] == null ? undefined : json['suspendedReason'],
57
+ 'closed': json['closed'] == null ? undefined : json['closed'],
58
+ 'closedAt': json['closedAt'] == null ? undefined : (new Date(json['closedAt'])),
59
+ 'purgeAt': json['purgeAt'] == null ? undefined : (new Date(json['purgeAt'])),
60
+ 'purgedAt': json['purgedAt'] == null ? undefined : (new Date(json['purgedAt'])),
61
+ 'closureContactEmail': json['closureContactEmail'] == null ? undefined : json['closureContactEmail'],
30
62
  'zeroDataRetention': json['zeroDataRetention'] == null ? undefined : json['zeroDataRetention'],
31
63
  'zeroDataRetentionEnabledAt': json['zeroDataRetentionEnabledAt'] == null ? undefined : (new Date(json['zeroDataRetentionEnabledAt'])),
32
64
  };
@@ -39,8 +71,23 @@ export function MeResponseAllOfUserToJSONTyped(value, ignoreDiscriminator = fals
39
71
  return value;
40
72
  }
41
73
  return {
74
+ 'id': value['id'],
42
75
  'login': value['login'],
43
76
  'email': value['email'],
77
+ 'displayName': value['displayName'],
78
+ 'connectionMethod': value['connectionMethod'],
79
+ 'connectionMethods': value['connectionMethods'],
80
+ 'accountPlan': value['accountPlan'],
81
+ 'serviceAccount': value['serviceAccount'],
82
+ 'accountStatus': value['accountStatus'],
83
+ 'suspended': value['suspended'],
84
+ 'suspendedAt': value['suspendedAt'] == null ? value['suspendedAt'] : value['suspendedAt'].toISOString(),
85
+ 'suspendedReason': value['suspendedReason'],
86
+ 'closed': value['closed'],
87
+ 'closedAt': value['closedAt'] == null ? value['closedAt'] : value['closedAt'].toISOString(),
88
+ 'purgeAt': value['purgeAt'] == null ? value['purgeAt'] : value['purgeAt'].toISOString(),
89
+ 'purgedAt': value['purgedAt'] == null ? value['purgedAt'] : value['purgedAt'].toISOString(),
90
+ 'closureContactEmail': value['closureContactEmail'],
44
91
  'zeroDataRetention': value['zeroDataRetention'],
45
92
  'zeroDataRetentionEnabledAt': value['zeroDataRetentionEnabledAt'] == null ? value['zeroDataRetentionEnabledAt'] : value['zeroDataRetentionEnabledAt'].toISOString(),
46
93
  };