@boatdev/sdk 1.9.2 → 1.9.4

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (164) hide show
  1. package/.openapi-generator/FILES +28 -0
  2. package/dist/apis/BoatApi.d.ts +192 -4
  3. package/dist/apis/BoatApi.js +452 -5
  4. package/dist/esm/apis/BoatApi.d.ts +192 -4
  5. package/dist/esm/apis/BoatApi.js +451 -4
  6. package/dist/esm/models/CommandAttachFrame.d.ts +121 -0
  7. package/dist/esm/models/CommandAttachFrame.js +83 -0
  8. package/dist/esm/models/CommandInfoResponse.d.ts +52 -0
  9. package/dist/esm/models/CommandInfoResponse.js +58 -0
  10. package/dist/esm/models/CommandListResponse.d.ts +58 -0
  11. package/dist/esm/models/CommandListResponse.js +62 -0
  12. package/dist/esm/models/CommandLogsResponse.d.ts +109 -0
  13. package/dist/esm/models/CommandLogsResponse.js +99 -0
  14. package/dist/esm/models/CommandRecord.d.ts +132 -0
  15. package/dist/esm/models/CommandRecord.js +105 -0
  16. package/dist/esm/models/CommandResponse.d.ts +6 -0
  17. package/dist/esm/models/CommandResponse.js +2 -0
  18. package/dist/esm/models/CommandStartedResponse.d.ts +6 -0
  19. package/dist/esm/models/CommandStartedResponse.js +2 -0
  20. package/dist/esm/models/CommandStatusResponse.d.ts +32 -2
  21. package/dist/esm/models/CommandStatusResponse.js +10 -0
  22. package/dist/esm/models/CommandStopResponse.d.ts +70 -0
  23. package/dist/esm/models/CommandStopResponse.js +70 -0
  24. package/dist/esm/models/CommandStreamFrame.d.ts +6 -0
  25. package/dist/esm/models/CommandStreamFrame.js +2 -0
  26. package/dist/esm/models/CreateSandboxRequest.d.ts +6 -0
  27. package/dist/esm/models/CreateSandboxRequest.js +2 -0
  28. package/dist/esm/models/DataRetentionPolicyResponse.d.ts +12 -0
  29. package/dist/esm/models/DataRetentionPolicyResponse.js +4 -0
  30. package/dist/esm/models/DataRetentionUpdateRequest.d.ts +7 -1
  31. package/dist/esm/models/DataRetentionUpdateRequest.js +2 -0
  32. package/dist/esm/models/ForkRequest.d.ts +6 -0
  33. package/dist/esm/models/ForkRequest.js +2 -0
  34. package/dist/esm/models/HostPortRequest.d.ts +6 -0
  35. package/dist/esm/models/HostPortRequest.js +2 -0
  36. package/dist/esm/models/HostPortResponse.d.ts +6 -0
  37. package/dist/esm/models/HostPortResponse.js +2 -0
  38. package/dist/esm/models/ProcessListResponse.d.ts +70 -0
  39. package/dist/esm/models/ProcessListResponse.js +70 -0
  40. package/dist/esm/models/Sandbox.d.ts +6 -0
  41. package/dist/esm/models/Sandbox.js +2 -0
  42. package/dist/esm/models/SandboxProcess.d.ts +74 -0
  43. package/dist/esm/models/SandboxProcess.js +59 -0
  44. package/dist/esm/models/TelemetryConfig.d.ts +57 -0
  45. package/dist/esm/models/TelemetryConfig.js +60 -0
  46. package/dist/esm/models/TelemetryConfigLastError.d.ts +44 -0
  47. package/dist/esm/models/TelemetryConfigLastError.js +51 -0
  48. package/dist/esm/models/TelemetryResponse.d.ts +45 -0
  49. package/dist/esm/models/TelemetryResponse.js +52 -0
  50. package/dist/esm/models/TelemetrySetRequest.d.ts +40 -0
  51. package/dist/esm/models/TelemetrySetRequest.js +45 -0
  52. package/dist/esm/models/TelemetrySetResponse.d.ts +52 -0
  53. package/dist/esm/models/TelemetrySetResponse.js +57 -0
  54. package/dist/esm/models/TelemetryTestResult.d.ts +44 -0
  55. package/dist/esm/models/TelemetryTestResult.js +51 -0
  56. package/dist/esm/models/index.d.ts +14 -0
  57. package/dist/esm/models/index.js +14 -0
  58. package/dist/models/CommandAttachFrame.d.ts +121 -0
  59. package/dist/models/CommandAttachFrame.js +91 -0
  60. package/dist/models/CommandInfoResponse.d.ts +52 -0
  61. package/dist/models/CommandInfoResponse.js +66 -0
  62. package/dist/models/CommandListResponse.d.ts +58 -0
  63. package/dist/models/CommandListResponse.js +70 -0
  64. package/dist/models/CommandLogsResponse.d.ts +109 -0
  65. package/dist/models/CommandLogsResponse.js +107 -0
  66. package/dist/models/CommandRecord.d.ts +132 -0
  67. package/dist/models/CommandRecord.js +113 -0
  68. package/dist/models/CommandResponse.d.ts +6 -0
  69. package/dist/models/CommandResponse.js +2 -0
  70. package/dist/models/CommandStartedResponse.d.ts +6 -0
  71. package/dist/models/CommandStartedResponse.js +2 -0
  72. package/dist/models/CommandStatusResponse.d.ts +32 -2
  73. package/dist/models/CommandStatusResponse.js +10 -0
  74. package/dist/models/CommandStopResponse.d.ts +70 -0
  75. package/dist/models/CommandStopResponse.js +78 -0
  76. package/dist/models/CommandStreamFrame.d.ts +6 -0
  77. package/dist/models/CommandStreamFrame.js +2 -0
  78. package/dist/models/CreateSandboxRequest.d.ts +6 -0
  79. package/dist/models/CreateSandboxRequest.js +2 -0
  80. package/dist/models/DataRetentionPolicyResponse.d.ts +12 -0
  81. package/dist/models/DataRetentionPolicyResponse.js +4 -0
  82. package/dist/models/DataRetentionUpdateRequest.d.ts +7 -1
  83. package/dist/models/DataRetentionUpdateRequest.js +2 -0
  84. package/dist/models/ForkRequest.d.ts +6 -0
  85. package/dist/models/ForkRequest.js +2 -0
  86. package/dist/models/HostPortRequest.d.ts +6 -0
  87. package/dist/models/HostPortRequest.js +2 -0
  88. package/dist/models/HostPortResponse.d.ts +6 -0
  89. package/dist/models/HostPortResponse.js +2 -0
  90. package/dist/models/ProcessListResponse.d.ts +70 -0
  91. package/dist/models/ProcessListResponse.js +78 -0
  92. package/dist/models/Sandbox.d.ts +6 -0
  93. package/dist/models/Sandbox.js +2 -0
  94. package/dist/models/SandboxProcess.d.ts +74 -0
  95. package/dist/models/SandboxProcess.js +66 -0
  96. package/dist/models/TelemetryConfig.d.ts +57 -0
  97. package/dist/models/TelemetryConfig.js +67 -0
  98. package/dist/models/TelemetryConfigLastError.d.ts +44 -0
  99. package/dist/models/TelemetryConfigLastError.js +58 -0
  100. package/dist/models/TelemetryResponse.d.ts +45 -0
  101. package/dist/models/TelemetryResponse.js +59 -0
  102. package/dist/models/TelemetrySetRequest.d.ts +40 -0
  103. package/dist/models/TelemetrySetRequest.js +52 -0
  104. package/dist/models/TelemetrySetResponse.d.ts +52 -0
  105. package/dist/models/TelemetrySetResponse.js +64 -0
  106. package/dist/models/TelemetryTestResult.d.ts +44 -0
  107. package/dist/models/TelemetryTestResult.js +58 -0
  108. package/dist/models/index.d.ts +14 -0
  109. package/dist/models/index.js +14 -0
  110. package/docs/BoatApi.md +715 -11
  111. package/docs/Command200Response.md +2 -0
  112. package/docs/CommandAttachFrame.md +53 -0
  113. package/docs/CommandInfoResponse.md +36 -0
  114. package/docs/CommandListResponse.md +38 -0
  115. package/docs/CommandLogsResponse.md +50 -0
  116. package/docs/CommandRecord.md +59 -0
  117. package/docs/CommandResponse.md +2 -0
  118. package/docs/CommandStartedResponse.md +2 -0
  119. package/docs/CommandStatusResponse.md +10 -0
  120. package/docs/CommandStopResponse.md +42 -0
  121. package/docs/CommandStreamFrame.md +2 -0
  122. package/docs/CreateSandboxRequest.md +2 -0
  123. package/docs/DataRetentionPolicyResponse.md +4 -0
  124. package/docs/DataRetentionUpdateRequest.md +3 -1
  125. package/docs/ForkRequest.md +2 -0
  126. package/docs/HostPortRequest.md +2 -0
  127. package/docs/HostPortResponse.md +2 -0
  128. package/docs/ProcessListResponse.md +42 -0
  129. package/docs/Sandbox.md +2 -0
  130. package/docs/SandboxProcess.md +46 -0
  131. package/docs/TelemetryConfig.md +40 -0
  132. package/docs/TelemetryConfigLastError.md +37 -0
  133. package/docs/TelemetryResponse.md +36 -0
  134. package/docs/TelemetrySetRequest.md +34 -0
  135. package/docs/TelemetrySetResponse.md +38 -0
  136. package/docs/TelemetryTestResult.md +36 -0
  137. package/package.json +1 -1
  138. package/src/apis/BoatApi.ts +671 -4
  139. package/src/models/CommandAttachFrame.ts +179 -0
  140. package/src/models/CommandInfoResponse.ts +102 -0
  141. package/src/models/CommandListResponse.ts +111 -0
  142. package/src/models/CommandLogsResponse.ts +175 -0
  143. package/src/models/CommandRecord.ts +204 -0
  144. package/src/models/CommandResponse.ts +8 -0
  145. package/src/models/CommandStartedResponse.ts +8 -0
  146. package/src/models/CommandStatusResponse.ts +42 -2
  147. package/src/models/CommandStopResponse.ts +129 -0
  148. package/src/models/CommandStreamFrame.ts +8 -0
  149. package/src/models/CreateSandboxRequest.ts +8 -0
  150. package/src/models/DataRetentionPolicyResponse.ts +16 -0
  151. package/src/models/DataRetentionUpdateRequest.ts +9 -1
  152. package/src/models/ForkRequest.ts +8 -0
  153. package/src/models/HostPortRequest.ts +8 -0
  154. package/src/models/HostPortResponse.ts +8 -0
  155. package/src/models/ProcessListResponse.ts +129 -0
  156. package/src/models/Sandbox.ts +8 -0
  157. package/src/models/SandboxProcess.ts +123 -0
  158. package/src/models/TelemetryConfig.ts +110 -0
  159. package/src/models/TelemetryConfigLastError.ts +84 -0
  160. package/src/models/TelemetryResponse.ts +92 -0
  161. package/src/models/TelemetrySetRequest.ts +74 -0
  162. package/src/models/TelemetrySetResponse.ts +108 -0
  163. package/src/models/TelemetryTestResult.ts +84 -0
  164. package/src/models/index.ts +14 -0
@@ -0,0 +1,113 @@
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.CommandRecordStatusEnum = exports.CommandRecordModeEnum = void 0;
17
+ exports.instanceOfCommandRecord = instanceOfCommandRecord;
18
+ exports.CommandRecordFromJSON = CommandRecordFromJSON;
19
+ exports.CommandRecordFromJSONTyped = CommandRecordFromJSONTyped;
20
+ exports.CommandRecordToJSON = CommandRecordToJSON;
21
+ exports.CommandRecordToJSONTyped = CommandRecordToJSONTyped;
22
+ /**
23
+ * @export
24
+ */
25
+ exports.CommandRecordModeEnum = {
26
+ Sync: 'sync',
27
+ Stream: 'stream',
28
+ Detached: 'detached',
29
+ Process: 'process'
30
+ };
31
+ /**
32
+ * @export
33
+ */
34
+ exports.CommandRecordStatusEnum = {
35
+ Running: 'running',
36
+ Exited: 'exited',
37
+ TimedOut: 'timed_out',
38
+ Failed: 'failed',
39
+ Killed: 'killed',
40
+ Lost: 'lost'
41
+ };
42
+ /**
43
+ * Check if a given object implements the CommandRecord interface.
44
+ */
45
+ function instanceOfCommandRecord(value) {
46
+ if (!('commandId' in value) || value['commandId'] === undefined)
47
+ return false;
48
+ if (!('sandboxId' in value) || value['sandboxId'] === undefined)
49
+ return false;
50
+ if (!('command' in value) || value['command'] === undefined)
51
+ return false;
52
+ if (!('mode' in value) || value['mode'] === undefined)
53
+ return false;
54
+ if (!('status' in value) || value['status'] === undefined)
55
+ return false;
56
+ if (!('stdoutBytes' in value) || value['stdoutBytes'] === undefined)
57
+ return false;
58
+ if (!('stderrBytes' in value) || value['stderrBytes'] === undefined)
59
+ return false;
60
+ if (!('outputTruncated' in value) || value['outputTruncated'] === undefined)
61
+ return false;
62
+ if (!('startedAt' in value) || value['startedAt'] === undefined)
63
+ return false;
64
+ return true;
65
+ }
66
+ function CommandRecordFromJSON(json) {
67
+ return CommandRecordFromJSONTyped(json, false);
68
+ }
69
+ function CommandRecordFromJSONTyped(json, ignoreDiscriminator) {
70
+ if (json == null) {
71
+ return json;
72
+ }
73
+ return {
74
+ 'commandId': json['commandId'],
75
+ 'sandboxId': json['sandboxId'],
76
+ 'command': json['command'],
77
+ 'cwd': json['cwd'] == null ? undefined : json['cwd'],
78
+ 'mode': json['mode'],
79
+ 'processId': json['processId'] == null ? undefined : json['processId'],
80
+ 'status': json['status'],
81
+ 'exitCode': json['exitCode'] == null ? undefined : json['exitCode'],
82
+ 'signal': json['signal'] == null ? undefined : json['signal'],
83
+ 'stdoutBytes': json['stdoutBytes'],
84
+ 'stderrBytes': json['stderrBytes'],
85
+ 'outputTruncated': json['outputTruncated'],
86
+ 'startedAt': (new Date(json['startedAt'])),
87
+ 'finishedAt': json['finishedAt'] == null ? undefined : (new Date(json['finishedAt'])),
88
+ };
89
+ }
90
+ function CommandRecordToJSON(json) {
91
+ return CommandRecordToJSONTyped(json, false);
92
+ }
93
+ function CommandRecordToJSONTyped(value, ignoreDiscriminator = false) {
94
+ if (value == null) {
95
+ return value;
96
+ }
97
+ return {
98
+ 'commandId': value['commandId'],
99
+ 'sandboxId': value['sandboxId'],
100
+ 'command': value['command'],
101
+ 'cwd': value['cwd'],
102
+ 'mode': value['mode'],
103
+ 'processId': value['processId'],
104
+ 'status': value['status'],
105
+ 'exitCode': value['exitCode'],
106
+ 'signal': value['signal'],
107
+ 'stdoutBytes': value['stdoutBytes'],
108
+ 'stderrBytes': value['stderrBytes'],
109
+ 'outputTruncated': value['outputTruncated'],
110
+ 'startedAt': value['startedAt'].toISOString(),
111
+ 'finishedAt': value['finishedAt'] == null ? value['finishedAt'] : value['finishedAt'].toISOString(),
112
+ };
113
+ }
@@ -33,6 +33,12 @@ export interface CommandResponse {
33
33
  * @memberof CommandResponse
34
34
  */
35
35
  success: boolean;
36
+ /**
37
+ * The command's record in the command history.
38
+ * @type {string}
39
+ * @memberof CommandResponse
40
+ */
41
+ commandId?: string;
36
42
  /**
37
43
  *
38
44
  * @type {number}
@@ -56,6 +56,7 @@ function CommandResponseFromJSONTyped(json, ignoreDiscriminator) {
56
56
  'ok': json['ok'],
57
57
  'type': json['type'],
58
58
  'success': json['success'],
59
+ 'commandId': json['commandId'] == null ? undefined : json['commandId'],
59
60
  'exitCode': json['exitCode'],
60
61
  'signal': json['signal'] == null ? undefined : json['signal'],
61
62
  'oomKilled': json['oomKilled'] == null ? undefined : json['oomKilled'],
@@ -80,6 +81,7 @@ function CommandResponseToJSONTyped(value, ignoreDiscriminator = false) {
80
81
  'ok': value['ok'],
81
82
  'type': value['type'],
82
83
  'success': value['success'],
84
+ 'commandId': value['commandId'],
83
85
  'exitCode': value['exitCode'],
84
86
  'signal': value['signal'],
85
87
  'oomKilled': value['oomKilled'],
@@ -33,6 +33,12 @@ export interface CommandStartedResponse {
33
33
  * @memberof CommandStartedResponse
34
34
  */
35
35
  success: boolean;
36
+ /**
37
+ * The command's record in the command history. Its output is copied there every 30 s.
38
+ * @type {string}
39
+ * @memberof CommandStartedResponse
40
+ */
41
+ commandId?: string;
36
42
  /**
37
43
  * Process id to poll with the command status endpoint.
38
44
  * @type {number}
@@ -56,6 +56,7 @@ function CommandStartedResponseFromJSONTyped(json, ignoreDiscriminator) {
56
56
  'ok': json['ok'],
57
57
  'type': json['type'],
58
58
  'success': json['success'],
59
+ 'commandId': json['commandId'] == null ? undefined : json['commandId'],
59
60
  'processId': json['processId'],
60
61
  'pid': json['pid'],
61
62
  'command': json['command'],
@@ -76,6 +77,7 @@ function CommandStartedResponseToJSONTyped(value, ignoreDiscriminator = false) {
76
77
  'ok': value['ok'],
77
78
  'type': value['type'],
78
79
  'success': value['success'],
80
+ 'commandId': value['commandId'],
79
81
  'processId': value['processId'],
80
82
  'pid': value['pid'],
81
83
  'command': value['command'],
@@ -106,13 +106,13 @@ export interface CommandStatusResponse {
106
106
  */
107
107
  finishedAt?: Date | null;
108
108
  /**
109
- * Tail of the stdout log file.
109
+ * Tail of the stdout log file. With `stdoutOffset`: the stdout written since that offset.
110
110
  * @type {string}
111
111
  * @memberof CommandStatusResponse
112
112
  */
113
113
  stdout: string;
114
114
  /**
115
- * Tail of the stderr log file.
115
+ * Tail of the stderr log file. With `stderrOffset`: the stderr written since that offset.
116
116
  * @type {string}
117
117
  * @memberof CommandStatusResponse
118
118
  */
@@ -141,6 +141,36 @@ export interface CommandStatusResponse {
141
141
  * @memberof CommandStatusResponse
142
142
  */
143
143
  errLogPath?: string;
144
+ /**
145
+ * Byte offset where `stdout` starts: the offset you asked for, or 0 when the log was replaced.
146
+ * @type {number}
147
+ * @memberof CommandStatusResponse
148
+ */
149
+ stdoutOffset?: number;
150
+ /**
151
+ * Byte offset where `stderr` starts: the offset you asked for, or 0 when the log was replaced.
152
+ * @type {number}
153
+ * @memberof CommandStatusResponse
154
+ */
155
+ stderrOffset?: number;
156
+ /**
157
+ * The `stdoutOffset` for the next read.
158
+ * @type {number}
159
+ * @memberof CommandStatusResponse
160
+ */
161
+ stdoutNextOffset?: number;
162
+ /**
163
+ * The `stderrOffset` for the next read.
164
+ * @type {number}
165
+ * @memberof CommandStatusResponse
166
+ */
167
+ stderrNextOffset?: number;
168
+ /**
169
+ * True when more output is already written. Read again at once.
170
+ * @type {boolean}
171
+ * @memberof CommandStatusResponse
172
+ */
173
+ more?: boolean;
144
174
  }
145
175
  /**
146
176
  * @export
@@ -86,6 +86,11 @@ function CommandStatusResponseFromJSONTyped(json, ignoreDiscriminator) {
86
86
  'stderrTruncated': json['stderrTruncated'] == null ? undefined : json['stderrTruncated'],
87
87
  'logPath': json['logPath'] == null ? undefined : json['logPath'],
88
88
  'errLogPath': json['errLogPath'] == null ? undefined : json['errLogPath'],
89
+ 'stdoutOffset': json['stdoutOffset'] == null ? undefined : json['stdoutOffset'],
90
+ 'stderrOffset': json['stderrOffset'] == null ? undefined : json['stderrOffset'],
91
+ 'stdoutNextOffset': json['stdoutNextOffset'] == null ? undefined : json['stdoutNextOffset'],
92
+ 'stderrNextOffset': json['stderrNextOffset'] == null ? undefined : json['stderrNextOffset'],
93
+ 'more': json['more'] == null ? undefined : json['more'],
89
94
  };
90
95
  }
91
96
  function CommandStatusResponseToJSON(json) {
@@ -117,5 +122,10 @@ function CommandStatusResponseToJSONTyped(value, ignoreDiscriminator = false) {
117
122
  'stderrTruncated': value['stderrTruncated'],
118
123
  'logPath': value['logPath'],
119
124
  'errLogPath': value['errLogPath'],
125
+ 'stdoutOffset': value['stdoutOffset'],
126
+ 'stderrOffset': value['stderrOffset'],
127
+ 'stdoutNextOffset': value['stdoutNextOffset'],
128
+ 'stderrNextOffset': value['stderrNextOffset'],
129
+ 'more': value['more'],
120
130
  };
121
131
  }
@@ -0,0 +1,70 @@
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
+ import type { CommandRecord } from './CommandRecord';
13
+ /**
14
+ *
15
+ * @export
16
+ * @interface CommandStopResponse
17
+ */
18
+ export interface CommandStopResponse {
19
+ /**
20
+ *
21
+ * @type {boolean}
22
+ * @memberof CommandStopResponse
23
+ */
24
+ ok: boolean;
25
+ /**
26
+ *
27
+ * @type {CommandStopResponseTypeEnum}
28
+ * @memberof CommandStopResponse
29
+ */
30
+ type: CommandStopResponseTypeEnum;
31
+ /**
32
+ *
33
+ * @type {number}
34
+ * @memberof CommandStopResponse
35
+ */
36
+ processId: number;
37
+ /**
38
+ * Always false after a stop.
39
+ * @type {boolean}
40
+ * @memberof CommandStopResponse
41
+ */
42
+ running: boolean;
43
+ /**
44
+ * False when the process had already ended.
45
+ * @type {boolean}
46
+ * @memberof CommandStopResponse
47
+ */
48
+ signaled: boolean;
49
+ /**
50
+ * The history record of the command, with its final state.
51
+ * @type {CommandRecord}
52
+ * @memberof CommandStopResponse
53
+ */
54
+ command: CommandRecord | null;
55
+ }
56
+ /**
57
+ * @export
58
+ */
59
+ export declare const CommandStopResponseTypeEnum: {
60
+ readonly CommandStopped: 'command.stopped';
61
+ };
62
+ export type CommandStopResponseTypeEnum = typeof CommandStopResponseTypeEnum[keyof typeof CommandStopResponseTypeEnum];
63
+ /**
64
+ * Check if a given object implements the CommandStopResponse interface.
65
+ */
66
+ export declare function instanceOfCommandStopResponse(value: object): value is CommandStopResponse;
67
+ export declare function CommandStopResponseFromJSON(json: any): CommandStopResponse;
68
+ export declare function CommandStopResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): CommandStopResponse;
69
+ export declare function CommandStopResponseToJSON(json: any): CommandStopResponse;
70
+ export declare function CommandStopResponseToJSONTyped(value?: CommandStopResponse | null, ignoreDiscriminator?: boolean): any;
@@ -0,0 +1,78 @@
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.CommandStopResponseTypeEnum = void 0;
17
+ exports.instanceOfCommandStopResponse = instanceOfCommandStopResponse;
18
+ exports.CommandStopResponseFromJSON = CommandStopResponseFromJSON;
19
+ exports.CommandStopResponseFromJSONTyped = CommandStopResponseFromJSONTyped;
20
+ exports.CommandStopResponseToJSON = CommandStopResponseToJSON;
21
+ exports.CommandStopResponseToJSONTyped = CommandStopResponseToJSONTyped;
22
+ const CommandRecord_1 = require("./CommandRecord");
23
+ /**
24
+ * @export
25
+ */
26
+ exports.CommandStopResponseTypeEnum = {
27
+ CommandStopped: 'command.stopped'
28
+ };
29
+ /**
30
+ * Check if a given object implements the CommandStopResponse interface.
31
+ */
32
+ function instanceOfCommandStopResponse(value) {
33
+ if (!('ok' in value) || value['ok'] === undefined)
34
+ return false;
35
+ if (!('type' in value) || value['type'] === undefined)
36
+ return false;
37
+ if (!('processId' in value) || value['processId'] === undefined)
38
+ return false;
39
+ if (!('running' in value) || value['running'] === undefined)
40
+ return false;
41
+ if (!('signaled' in value) || value['signaled'] === undefined)
42
+ return false;
43
+ if (!('command' in value) || value['command'] === undefined)
44
+ return false;
45
+ return true;
46
+ }
47
+ function CommandStopResponseFromJSON(json) {
48
+ return CommandStopResponseFromJSONTyped(json, false);
49
+ }
50
+ function CommandStopResponseFromJSONTyped(json, ignoreDiscriminator) {
51
+ if (json == null) {
52
+ return json;
53
+ }
54
+ return {
55
+ 'ok': json['ok'],
56
+ 'type': json['type'],
57
+ 'processId': json['processId'],
58
+ 'running': json['running'],
59
+ 'signaled': json['signaled'],
60
+ 'command': (0, CommandRecord_1.CommandRecordFromJSON)(json['command']),
61
+ };
62
+ }
63
+ function CommandStopResponseToJSON(json) {
64
+ return CommandStopResponseToJSONTyped(json, false);
65
+ }
66
+ function CommandStopResponseToJSONTyped(value, ignoreDiscriminator = false) {
67
+ if (value == null) {
68
+ return value;
69
+ }
70
+ return {
71
+ 'ok': value['ok'],
72
+ 'type': value['type'],
73
+ 'processId': value['processId'],
74
+ 'running': value['running'],
75
+ 'signaled': value['signaled'],
76
+ 'command': (0, CommandRecord_1.CommandRecordToJSON)(value['command']),
77
+ };
78
+ }
@@ -21,6 +21,12 @@ export interface CommandStreamFrame {
21
21
  * @memberof CommandStreamFrame
22
22
  */
23
23
  type: CommandStreamFrameTypeEnum;
24
+ /**
25
+ * started: the command's record in the command history.
26
+ * @type {string}
27
+ * @memberof CommandStreamFrame
28
+ */
29
+ commandId?: string;
24
30
  /**
25
31
  * stdout/stderr: the chunk of output, UTF-8.
26
32
  * @type {string}
@@ -46,6 +46,7 @@ function CommandStreamFrameFromJSONTyped(json, ignoreDiscriminator) {
46
46
  }
47
47
  return {
48
48
  'type': json['type'],
49
+ 'commandId': json['commandId'] == null ? undefined : json['commandId'],
49
50
  'data': json['data'] == null ? undefined : json['data'],
50
51
  'exitCode': json['exitCode'] == null ? undefined : json['exitCode'],
51
52
  'success': json['success'] == null ? undefined : json['success'],
@@ -64,6 +65,7 @@ function CommandStreamFrameToJSONTyped(value, ignoreDiscriminator = false) {
64
65
  }
65
66
  return {
66
67
  'type': value['type'],
68
+ 'commandId': value['commandId'],
67
69
  'data': value['data'],
68
70
  'exitCode': value['exitCode'],
69
71
  'success': value['success'],
@@ -53,6 +53,12 @@ export interface CreateSandboxRequest {
53
53
  * @memberof CreateSandboxRequest
54
54
  */
55
55
  snapshots?: boolean;
56
+ /**
57
+ * Pass `false` for monitoring off. Boat keeps no command or process output, process list or CPU/RAM samples for this sandbox, and its history, processes and metrics calls answer 409 `monitoring_off`. Live output of a running command still works. While the account default is on, `true` is refused with 409 `monitoring_off_for_account`.
58
+ * @type {boolean}
59
+ * @memberof CreateSandboxRequest
60
+ */
61
+ monitoring?: boolean;
56
62
  /**
57
63
  * Pass `true` to get a sandbox only if a machine of this type is ready right now. The call answers within about 1.5 s: either the usual `202` with the sandbox, or `503` `no_ready_machine` with nothing created, billed, or counted against your start limits, so you can retry or fall back at once. Without it, a create waits for a machine to be built when none is ready. Works with `from`; fork and resume take it too.
58
64
  * @type {boolean}
@@ -48,6 +48,7 @@ function CreateSandboxRequestFromJSONTyped(json, ignoreDiscriminator) {
48
48
  'environment': json['environment'] == null ? undefined : json['environment'],
49
49
  'noEnv': json['noEnv'] == null ? undefined : json['noEnv'],
50
50
  'snapshots': json['snapshots'] == null ? undefined : json['snapshots'],
51
+ 'monitoring': json['monitoring'] == null ? undefined : json['monitoring'],
51
52
  'failFast': json['failFast'] == null ? undefined : json['failFast'],
52
53
  'setupScript': json['setupScript'] == null ? undefined : json['setupScript'],
53
54
  'org': json['org'] == null ? undefined : json['org'],
@@ -69,6 +70,7 @@ function CreateSandboxRequestToJSONTyped(value, ignoreDiscriminator = false) {
69
70
  'environment': value['environment'],
70
71
  'noEnv': value['noEnv'],
71
72
  'snapshots': value['snapshots'],
73
+ 'monitoring': value['monitoring'],
72
74
  'failFast': value['failFast'],
73
75
  'setupScript': value['setupScript'],
74
76
  'org': value['org'],
@@ -63,6 +63,18 @@ export interface DataRetentionPolicyResponse {
63
63
  * @memberof DataRetentionPolicyResponse
64
64
  */
65
65
  snapshotsOffAt?: Date | null;
66
+ /**
67
+ * When true, every new sandbox of this account is created with monitoring off.
68
+ * @type {boolean}
69
+ * @memberof DataRetentionPolicyResponse
70
+ */
71
+ monitoringOff?: boolean;
72
+ /**
73
+ *
74
+ * @type {Date}
75
+ * @memberof DataRetentionPolicyResponse
76
+ */
77
+ monitoringOffAt?: Date | null;
66
78
  }
67
79
  /**
68
80
  * @export
@@ -56,6 +56,8 @@ function DataRetentionPolicyResponseFromJSONTyped(json, ignoreDiscriminator) {
56
56
  'acceptedDeletionOperationsIrreversible': json['acceptedDeletionOperationsIrreversible'] == null ? undefined : json['acceptedDeletionOperationsIrreversible'],
57
57
  'snapshotsOff': json['snapshotsOff'] == null ? undefined : json['snapshotsOff'],
58
58
  'snapshotsOffAt': json['snapshotsOffAt'] == null ? undefined : (new Date(json['snapshotsOffAt'])),
59
+ 'monitoringOff': json['monitoringOff'] == null ? undefined : json['monitoringOff'],
60
+ 'monitoringOffAt': json['monitoringOffAt'] == null ? undefined : (new Date(json['monitoringOffAt'])),
59
61
  };
60
62
  }
61
63
  function DataRetentionPolicyResponseToJSON(json) {
@@ -74,5 +76,7 @@ function DataRetentionPolicyResponseToJSONTyped(value, ignoreDiscriminator = fal
74
76
  'acceptedDeletionOperationsIrreversible': value['acceptedDeletionOperationsIrreversible'],
75
77
  'snapshotsOff': value['snapshotsOff'],
76
78
  'snapshotsOffAt': value['snapshotsOffAt'] == null ? value['snapshotsOffAt'] : value['snapshotsOffAt'].toISOString(),
79
+ 'monitoringOff': value['monitoringOff'],
80
+ 'monitoringOffAt': value['monitoringOffAt'] == null ? value['monitoringOffAt'] : value['monitoringOffAt'].toISOString(),
77
81
  };
78
82
  }
@@ -10,7 +10,7 @@
10
10
  * Do not edit the class manually.
11
11
  */
12
12
  /**
13
- * Pass `enabled` to change zero data retention, or `snapshotsOff` alone to change the account's snapshots-off setting.
13
+ * Pass `enabled` to change zero data retention, or `snapshotsOff` or `monitoringOff` alone to change that account setting.
14
14
  * @export
15
15
  * @interface DataRetentionUpdateRequest
16
16
  */
@@ -27,6 +27,12 @@ export interface DataRetentionUpdateRequest {
27
27
  * @memberof DataRetentionUpdateRequest
28
28
  */
29
29
  snapshotsOff?: boolean;
30
+ /**
31
+ * Turn monitoring off for every sandbox created from now on. Existing sandboxes keep their setting. While on, a create or fork that passes `monitoring: true` is refused with 409 `monitoring_off_for_account`.
32
+ * @type {boolean}
33
+ * @memberof DataRetentionUpdateRequest
34
+ */
35
+ monitoringOff?: boolean;
30
36
  /**
31
37
  * Required when enabling and must exactly equal `delete archived sandbox data`.
32
38
  * @type {DataRetentionUpdateRequestConfirmationEnum}
@@ -41,6 +41,7 @@ function DataRetentionUpdateRequestFromJSONTyped(json, ignoreDiscriminator) {
41
41
  return {
42
42
  'enabled': json['enabled'] == null ? undefined : json['enabled'],
43
43
  'snapshotsOff': json['snapshotsOff'] == null ? undefined : json['snapshotsOff'],
44
+ 'monitoringOff': json['monitoringOff'] == null ? undefined : json['monitoringOff'],
44
45
  'confirmation': json['confirmation'] == null ? undefined : json['confirmation'],
45
46
  };
46
47
  }
@@ -54,6 +55,7 @@ function DataRetentionUpdateRequestToJSONTyped(value, ignoreDiscriminator = fals
54
55
  return {
55
56
  'enabled': value['enabled'],
56
57
  'snapshotsOff': value['snapshotsOff'],
58
+ 'monitoringOff': value['monitoringOff'],
57
59
  'confirmation': value['confirmation'],
58
60
  };
59
61
  }
@@ -21,6 +21,12 @@ export interface ForkRequest {
21
21
  * @memberof ForkRequest
22
22
  */
23
23
  failFast?: boolean;
24
+ /**
25
+ * `false` creates the fork with monitoring off: Boat keeps no command or process output, process list or CPU/RAM samples for it. Omitted, the fork keeps the source sandbox's setting. `true` turns it on for the fork, unless the account has monitoring off by default (`409` `monitoring_off_for_account`).
26
+ * @type {boolean}
27
+ * @memberof ForkRequest
28
+ */
29
+ monitoring?: boolean;
24
30
  /**
25
31
  * Replaces the env the fork would otherwise inherit from the source sandbox. Same validation rules as `CreateSandboxRequest.env`.
26
32
  * @type {{ [key: string]: string; }}
@@ -43,6 +43,7 @@ function ForkRequestFromJSONTyped(json, ignoreDiscriminator) {
43
43
  }
44
44
  return {
45
45
  'failFast': json['failFast'] == null ? undefined : json['failFast'],
46
+ 'monitoring': json['monitoring'] == null ? undefined : json['monitoring'],
46
47
  'env': json['env'] == null ? undefined : json['env'],
47
48
  'environment': json['environment'] == null ? undefined : json['environment'],
48
49
  'noEnv': json['noEnv'] == null ? undefined : json['noEnv'],
@@ -59,6 +60,7 @@ function ForkRequestToJSONTyped(value, ignoreDiscriminator = false) {
59
60
  }
60
61
  return {
61
62
  'failFast': value['failFast'],
63
+ 'monitoring': value['monitoring'],
62
64
  'env': value['env'],
63
65
  'environment': value['environment'],
64
66
  'noEnv': value['noEnv'],
@@ -27,6 +27,12 @@ export interface HostPortRequest {
27
27
  * @memberof HostPortRequest
28
28
  */
29
29
  _public?: boolean;
30
+ /**
31
+ * Set when the service listens on localhost (`127.0.0.1` or `::1`) only. The sandbox relays the URL to it. Leave unset for a service bound to `0.0.0.0`. Each call sets the value again.
32
+ * @type {boolean}
33
+ * @memberof HostPortRequest
34
+ */
35
+ localhost?: boolean;
30
36
  /**
31
37
  * Display title for the hosted port.
32
38
  * @type {string}
@@ -36,6 +36,7 @@ function HostPortRequestFromJSONTyped(json, ignoreDiscriminator) {
36
36
  return {
37
37
  'port': json['port'],
38
38
  '_public': json['public'] == null ? undefined : json['public'],
39
+ 'localhost': json['localhost'] == null ? undefined : json['localhost'],
39
40
  'title': json['title'] == null ? undefined : json['title'],
40
41
  };
41
42
  }
@@ -49,6 +50,7 @@ function HostPortRequestToJSONTyped(value, ignoreDiscriminator = false) {
49
50
  return {
50
51
  'port': value['port'],
51
52
  'public': value['_public'],
53
+ 'localhost': value['localhost'],
52
54
  'title': value['title'],
53
55
  };
54
56
  }
@@ -57,6 +57,12 @@ export interface HostPortResponse {
57
57
  * @memberof HostPortResponse
58
58
  */
59
59
  access?: HostPortResponseAccessEnum;
60
+ /**
61
+ * The sandbox relays the URL to a service that listens on localhost only.
62
+ * @type {boolean}
63
+ * @memberof HostPortResponse
64
+ */
65
+ localhost?: boolean;
60
66
  }
61
67
  /**
62
68
  * @export
@@ -51,6 +51,7 @@ function HostPortResponseFromJSONTyped(json, ignoreDiscriminator) {
51
51
  'url': json['url'] == null ? undefined : json['url'],
52
52
  'isProtected': json['isProtected'] == null ? undefined : json['isProtected'],
53
53
  'access': json['access'] == null ? undefined : json['access'],
54
+ 'localhost': json['localhost'] == null ? undefined : json['localhost'],
54
55
  };
55
56
  }
56
57
  function HostPortResponseToJSON(json) {
@@ -68,5 +69,6 @@ function HostPortResponseToJSONTyped(value, ignoreDiscriminator = false) {
68
69
  'url': value['url'],
69
70
  'isProtected': value['isProtected'],
70
71
  'access': value['access'],
72
+ 'localhost': value['localhost'],
71
73
  };
72
74
  }