@boatdev/sdk 1.7.0 → 1.9.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.
- package/.openapi-generator/FILES +12 -0
- package/dist/apis/BoatApi.d.ts +102 -4
- package/dist/apis/BoatApi.js +233 -4
- package/dist/esm/apis/BoatApi.d.ts +102 -4
- package/dist/esm/apis/BoatApi.js +233 -4
- package/dist/esm/http2-fetch.d.ts +1 -0
- package/dist/esm/http2-fetch.js +203 -0
- package/dist/esm/models/CreateSandboxRequest.d.ts +4 -3
- package/dist/esm/models/CreateSandboxRequest.js +2 -1
- package/dist/esm/models/ForkRequest.d.ts +2 -1
- package/dist/esm/models/ForkRequest.js +2 -1
- package/dist/esm/models/NamedSnapshotShare.d.ts +76 -0
- package/dist/esm/models/NamedSnapshotShare.js +74 -0
- package/dist/esm/models/NamedSnapshotShareCreatedResponse.d.ts +64 -0
- package/dist/esm/models/NamedSnapshotShareCreatedResponse.js +66 -0
- package/dist/esm/models/NamedSnapshotShareListResponse.d.ts +58 -0
- package/dist/esm/models/NamedSnapshotShareListResponse.js +62 -0
- package/dist/esm/models/NamedSnapshotShareRevokedResponse.d.ts +58 -0
- package/dist/esm/models/NamedSnapshotShareRevokedResponse.js +62 -0
- package/dist/esm/models/Recover200Response.d.ts +57 -0
- package/dist/esm/models/Recover200Response.js +53 -0
- package/dist/esm/models/ResumeRequest.d.ts +2 -1
- package/dist/esm/models/ResumeRequest.js +2 -1
- package/dist/esm/models/Sandbox.d.ts +2 -1
- package/dist/esm/models/Sandbox.js +2 -1
- package/dist/esm/models/SandboxUsageResponse.d.ts +2 -1
- package/dist/esm/models/SandboxUsageResponse.js +2 -1
- package/dist/esm/models/StopOperation.d.ts +1 -1
- package/dist/esm/models/StopOperationResponse.d.ts +58 -0
- package/dist/esm/models/StopOperationResponse.js +62 -0
- package/dist/esm/models/StopRequest.d.ts +1 -1
- package/dist/esm/models/UpdateSandboxRequest.d.ts +1 -1
- package/dist/esm/models/index.d.ts +6 -0
- package/dist/esm/models/index.js +6 -0
- package/dist/esm/runtime.js +2 -1
- package/dist/http2-fetch.d.ts +1 -0
- package/dist/http2-fetch.js +239 -0
- package/dist/models/CreateSandboxRequest.d.ts +4 -3
- package/dist/models/CreateSandboxRequest.js +2 -1
- package/dist/models/ForkRequest.d.ts +2 -1
- package/dist/models/ForkRequest.js +2 -1
- package/dist/models/NamedSnapshotShare.d.ts +76 -0
- package/dist/models/NamedSnapshotShare.js +82 -0
- package/dist/models/NamedSnapshotShareCreatedResponse.d.ts +64 -0
- package/dist/models/NamedSnapshotShareCreatedResponse.js +74 -0
- package/dist/models/NamedSnapshotShareListResponse.d.ts +58 -0
- package/dist/models/NamedSnapshotShareListResponse.js +70 -0
- package/dist/models/NamedSnapshotShareRevokedResponse.d.ts +58 -0
- package/dist/models/NamedSnapshotShareRevokedResponse.js +70 -0
- package/dist/models/Recover200Response.d.ts +57 -0
- package/dist/models/Recover200Response.js +61 -0
- package/dist/models/ResumeRequest.d.ts +2 -1
- package/dist/models/ResumeRequest.js +2 -1
- package/dist/models/Sandbox.d.ts +2 -1
- package/dist/models/Sandbox.js +2 -1
- package/dist/models/SandboxUsageResponse.d.ts +2 -1
- package/dist/models/SandboxUsageResponse.js +2 -1
- package/dist/models/StopOperation.d.ts +1 -1
- package/dist/models/StopOperationResponse.d.ts +58 -0
- package/dist/models/StopOperationResponse.js +70 -0
- package/dist/models/StopRequest.d.ts +1 -1
- package/dist/models/UpdateSandboxRequest.d.ts +1 -1
- package/dist/models/index.d.ts +6 -0
- package/dist/models/index.js +6 -0
- package/dist/runtime.js +9 -8
- package/docs/BoatApi.md +385 -2
- package/docs/NamedSnapshotShare.md +45 -0
- package/docs/NamedSnapshotShareCreatedResponse.md +40 -0
- package/docs/NamedSnapshotShareListResponse.md +38 -0
- package/docs/NamedSnapshotShareRevokedResponse.md +38 -0
- package/docs/Recover200Response.md +38 -0
- package/docs/StopOperationResponse.md +38 -0
- package/package.json +1 -1
- package/src/apis/BoatApi.ts +348 -4
- package/src/http2-fetch.ts +179 -0
- package/src/models/CreateSandboxRequest.ts +5 -4
- package/src/models/ForkRequest.ts +3 -2
- package/src/models/NamedSnapshotShare.ts +131 -0
- package/src/models/NamedSnapshotShareCreatedResponse.ts +120 -0
- package/src/models/NamedSnapshotShareListResponse.ts +111 -0
- package/src/models/NamedSnapshotShareRevokedResponse.ts +111 -0
- package/src/models/Recover200Response.ts +99 -0
- package/src/models/ResumeRequest.ts +3 -2
- package/src/models/Sandbox.ts +3 -2
- package/src/models/SandboxUsageResponse.ts +3 -2
- package/src/models/StopOperation.ts +1 -1
- package/src/models/StopOperationResponse.ts +111 -0
- package/src/models/StopRequest.ts +1 -1
- package/src/models/UpdateSandboxRequest.ts +1 -1
- package/src/models/index.ts +6 -0
- package/src/runtime.ts +2 -1
|
@@ -25,7 +25,8 @@ exports.SandboxUsageResponseToJSONTyped = SandboxUsageResponseToJSONTyped;
|
|
|
25
25
|
exports.SandboxUsageResponseSandboxTypeEnum = {
|
|
26
26
|
Small: 'small',
|
|
27
27
|
Default: 'default',
|
|
28
|
-
Large: 'large'
|
|
28
|
+
Large: 'large',
|
|
29
|
+
Xlarge: 'xlarge'
|
|
29
30
|
};
|
|
30
31
|
/**
|
|
31
32
|
* Check if a given object implements the SandboxUsageResponse interface.
|
|
@@ -28,7 +28,7 @@ export interface StopOperation {
|
|
|
28
28
|
*/
|
|
29
29
|
status: StopOperationStatusEnum;
|
|
30
30
|
/**
|
|
31
|
-
* When the stop was accepted.
|
|
31
|
+
* When the stop was accepted. On the sandbox, null once it has ended. Read by id (`GET /sandboxes/{sandboxId}/stops/{stopId}`), it is kept.
|
|
32
32
|
* @type {Date}
|
|
33
33
|
* @memberof StopOperation
|
|
34
34
|
*/
|
|
@@ -0,0 +1,58 @@
|
|
|
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 { StopOperation } from './StopOperation';
|
|
13
|
+
/**
|
|
14
|
+
*
|
|
15
|
+
* @export
|
|
16
|
+
* @interface StopOperationResponse
|
|
17
|
+
*/
|
|
18
|
+
export interface StopOperationResponse {
|
|
19
|
+
/**
|
|
20
|
+
*
|
|
21
|
+
* @type {boolean}
|
|
22
|
+
* @memberof StopOperationResponse
|
|
23
|
+
*/
|
|
24
|
+
ok: boolean;
|
|
25
|
+
/**
|
|
26
|
+
*
|
|
27
|
+
* @type {StopOperationResponseTypeEnum}
|
|
28
|
+
* @memberof StopOperationResponse
|
|
29
|
+
*/
|
|
30
|
+
type: StopOperationResponseTypeEnum;
|
|
31
|
+
/**
|
|
32
|
+
*
|
|
33
|
+
* @type {string}
|
|
34
|
+
* @memberof StopOperationResponse
|
|
35
|
+
*/
|
|
36
|
+
id: string;
|
|
37
|
+
/**
|
|
38
|
+
*
|
|
39
|
+
* @type {StopOperation}
|
|
40
|
+
* @memberof StopOperationResponse
|
|
41
|
+
*/
|
|
42
|
+
stop: StopOperation;
|
|
43
|
+
}
|
|
44
|
+
/**
|
|
45
|
+
* @export
|
|
46
|
+
*/
|
|
47
|
+
export declare const StopOperationResponseTypeEnum: {
|
|
48
|
+
readonly StopStatus: 'stop.status';
|
|
49
|
+
};
|
|
50
|
+
export type StopOperationResponseTypeEnum = typeof StopOperationResponseTypeEnum[keyof typeof StopOperationResponseTypeEnum];
|
|
51
|
+
/**
|
|
52
|
+
* Check if a given object implements the StopOperationResponse interface.
|
|
53
|
+
*/
|
|
54
|
+
export declare function instanceOfStopOperationResponse(value: object): value is StopOperationResponse;
|
|
55
|
+
export declare function StopOperationResponseFromJSON(json: any): StopOperationResponse;
|
|
56
|
+
export declare function StopOperationResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): StopOperationResponse;
|
|
57
|
+
export declare function StopOperationResponseToJSON(json: any): StopOperationResponse;
|
|
58
|
+
export declare function StopOperationResponseToJSONTyped(value?: StopOperationResponse | null, ignoreDiscriminator?: boolean): any;
|
|
@@ -0,0 +1,70 @@
|
|
|
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.StopOperationResponseTypeEnum = void 0;
|
|
17
|
+
exports.instanceOfStopOperationResponse = instanceOfStopOperationResponse;
|
|
18
|
+
exports.StopOperationResponseFromJSON = StopOperationResponseFromJSON;
|
|
19
|
+
exports.StopOperationResponseFromJSONTyped = StopOperationResponseFromJSONTyped;
|
|
20
|
+
exports.StopOperationResponseToJSON = StopOperationResponseToJSON;
|
|
21
|
+
exports.StopOperationResponseToJSONTyped = StopOperationResponseToJSONTyped;
|
|
22
|
+
const StopOperation_1 = require("./StopOperation");
|
|
23
|
+
/**
|
|
24
|
+
* @export
|
|
25
|
+
*/
|
|
26
|
+
exports.StopOperationResponseTypeEnum = {
|
|
27
|
+
StopStatus: 'stop.status'
|
|
28
|
+
};
|
|
29
|
+
/**
|
|
30
|
+
* Check if a given object implements the StopOperationResponse interface.
|
|
31
|
+
*/
|
|
32
|
+
function instanceOfStopOperationResponse(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 (!('id' in value) || value['id'] === undefined)
|
|
38
|
+
return false;
|
|
39
|
+
if (!('stop' in value) || value['stop'] === undefined)
|
|
40
|
+
return false;
|
|
41
|
+
return true;
|
|
42
|
+
}
|
|
43
|
+
function StopOperationResponseFromJSON(json) {
|
|
44
|
+
return StopOperationResponseFromJSONTyped(json, false);
|
|
45
|
+
}
|
|
46
|
+
function StopOperationResponseFromJSONTyped(json, ignoreDiscriminator) {
|
|
47
|
+
if (json == null) {
|
|
48
|
+
return json;
|
|
49
|
+
}
|
|
50
|
+
return {
|
|
51
|
+
'ok': json['ok'],
|
|
52
|
+
'type': json['type'],
|
|
53
|
+
'id': json['id'],
|
|
54
|
+
'stop': (0, StopOperation_1.StopOperationFromJSON)(json['stop']),
|
|
55
|
+
};
|
|
56
|
+
}
|
|
57
|
+
function StopOperationResponseToJSON(json) {
|
|
58
|
+
return StopOperationResponseToJSONTyped(json, false);
|
|
59
|
+
}
|
|
60
|
+
function StopOperationResponseToJSONTyped(value, ignoreDiscriminator = false) {
|
|
61
|
+
if (value == null) {
|
|
62
|
+
return value;
|
|
63
|
+
}
|
|
64
|
+
return {
|
|
65
|
+
'ok': value['ok'],
|
|
66
|
+
'type': value['type'],
|
|
67
|
+
'id': value['id'],
|
|
68
|
+
'stop': (0, StopOperation_1.StopOperationToJSON)(value['stop']),
|
|
69
|
+
};
|
|
70
|
+
}
|
|
@@ -16,7 +16,7 @@
|
|
|
16
16
|
*/
|
|
17
17
|
export interface StopRequest {
|
|
18
18
|
/**
|
|
19
|
-
* Stop the sandbox even if its disk cannot be snapshotted.
|
|
19
|
+
* Stop the sandbox even if its disk cannot be snapshotted. It keeps its last successful snapshot and everything written since then is permanently LOST. Without this, a sandbox whose snapshot pipeline is failing is left running rather than discarding your work, and you are not billed for that time. Only use this after a stop has already been refused.
|
|
20
20
|
* @type {boolean}
|
|
21
21
|
* @memberof StopRequest
|
|
22
22
|
*/
|
|
@@ -22,7 +22,7 @@ export interface UpdateSandboxRequest {
|
|
|
22
22
|
*/
|
|
23
23
|
name?: string;
|
|
24
24
|
/**
|
|
25
|
-
* New
|
|
25
|
+
* New auto-stop TTL. The deadline becomes now + `ttlSeconds`, so calling this again extends a running sandbox's life. `null` disables auto-stop.
|
|
26
26
|
* @type {number}
|
|
27
27
|
* @memberof UpdateSandboxRequest
|
|
28
28
|
*/
|
package/dist/models/index.d.ts
CHANGED
|
@@ -63,6 +63,10 @@ export * from './NamedSnapshotInfoResponse';
|
|
|
63
63
|
export * from './NamedSnapshotListResponse';
|
|
64
64
|
export * from './NamedSnapshotSaveRequest';
|
|
65
65
|
export * from './NamedSnapshotSavingResponse';
|
|
66
|
+
export * from './NamedSnapshotShare';
|
|
67
|
+
export * from './NamedSnapshotShareCreatedResponse';
|
|
68
|
+
export * from './NamedSnapshotShareListResponse';
|
|
69
|
+
export * from './NamedSnapshotShareRevokedResponse';
|
|
66
70
|
export * from './Org';
|
|
67
71
|
export * from './OrgListResponse';
|
|
68
72
|
export * from './PageInfo';
|
|
@@ -74,6 +78,7 @@ export * from './PromptRequest';
|
|
|
74
78
|
export * from './PromptResponse';
|
|
75
79
|
export * from './PromptRun';
|
|
76
80
|
export * from './PromptRunResponse';
|
|
81
|
+
export * from './Recover200Response';
|
|
77
82
|
export * from './RepoSelectionRequest';
|
|
78
83
|
export * from './RepoSelectionResponse';
|
|
79
84
|
export * from './ReposResponse';
|
|
@@ -117,6 +122,7 @@ export * from './SteerEventData';
|
|
|
117
122
|
export * from './SteerRequest';
|
|
118
123
|
export * from './SteerResponse';
|
|
119
124
|
export * from './StopOperation';
|
|
125
|
+
export * from './StopOperationResponse';
|
|
120
126
|
export * from './StopRequest';
|
|
121
127
|
export * from './SuccessBase';
|
|
122
128
|
export * from './UnknownEvent';
|
package/dist/models/index.js
CHANGED
|
@@ -81,6 +81,10 @@ __exportStar(require("./NamedSnapshotInfoResponse"), exports);
|
|
|
81
81
|
__exportStar(require("./NamedSnapshotListResponse"), exports);
|
|
82
82
|
__exportStar(require("./NamedSnapshotSaveRequest"), exports);
|
|
83
83
|
__exportStar(require("./NamedSnapshotSavingResponse"), exports);
|
|
84
|
+
__exportStar(require("./NamedSnapshotShare"), exports);
|
|
85
|
+
__exportStar(require("./NamedSnapshotShareCreatedResponse"), exports);
|
|
86
|
+
__exportStar(require("./NamedSnapshotShareListResponse"), exports);
|
|
87
|
+
__exportStar(require("./NamedSnapshotShareRevokedResponse"), exports);
|
|
84
88
|
__exportStar(require("./Org"), exports);
|
|
85
89
|
__exportStar(require("./OrgListResponse"), exports);
|
|
86
90
|
__exportStar(require("./PageInfo"), exports);
|
|
@@ -92,6 +96,7 @@ __exportStar(require("./PromptRequest"), exports);
|
|
|
92
96
|
__exportStar(require("./PromptResponse"), exports);
|
|
93
97
|
__exportStar(require("./PromptRun"), exports);
|
|
94
98
|
__exportStar(require("./PromptRunResponse"), exports);
|
|
99
|
+
__exportStar(require("./Recover200Response"), exports);
|
|
95
100
|
__exportStar(require("./RepoSelectionRequest"), exports);
|
|
96
101
|
__exportStar(require("./RepoSelectionResponse"), exports);
|
|
97
102
|
__exportStar(require("./ReposResponse"), exports);
|
|
@@ -135,6 +140,7 @@ __exportStar(require("./SteerEventData"), exports);
|
|
|
135
140
|
__exportStar(require("./SteerRequest"), exports);
|
|
136
141
|
__exportStar(require("./SteerResponse"), exports);
|
|
137
142
|
__exportStar(require("./StopOperation"), exports);
|
|
143
|
+
__exportStar(require("./StopOperationResponse"), exports);
|
|
138
144
|
__exportStar(require("./StopRequest"), exports);
|
|
139
145
|
__exportStar(require("./SuccessBase"), exports);
|
|
140
146
|
__exportStar(require("./UnknownEvent"), exports);
|
package/dist/runtime.js
CHANGED
|
@@ -1,4 +1,12 @@
|
|
|
1
1
|
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.TextApiResponse = exports.BlobApiResponse = exports.VoidApiResponse = exports.JSONApiResponse = exports.COLLECTION_FORMATS = exports.RequiredError = exports.FetchError = exports.ResponseError = exports.BaseAPI = exports.DefaultConfig = exports.Configuration = exports.BASE_PATH = void 0;
|
|
4
|
+
exports.querystring = querystring;
|
|
5
|
+
exports.exists = exists;
|
|
6
|
+
exports.mapValues = mapValues;
|
|
7
|
+
exports.canConsumeForm = canConsumeForm;
|
|
8
|
+
exports.unflattenBody = unflattenBody;
|
|
9
|
+
const http2_fetch_1 = require("./http2-fetch");
|
|
2
10
|
/* tslint:disable */
|
|
3
11
|
/* eslint-disable */
|
|
4
12
|
/**
|
|
@@ -12,13 +20,6 @@
|
|
|
12
20
|
* https://openapi-generator.tech
|
|
13
21
|
* Do not edit the class manually.
|
|
14
22
|
*/
|
|
15
|
-
Object.defineProperty(exports, "__esModule", { value: true });
|
|
16
|
-
exports.TextApiResponse = exports.BlobApiResponse = exports.VoidApiResponse = exports.JSONApiResponse = exports.COLLECTION_FORMATS = exports.RequiredError = exports.FetchError = exports.ResponseError = exports.BaseAPI = exports.DefaultConfig = exports.Configuration = exports.BASE_PATH = void 0;
|
|
17
|
-
exports.querystring = querystring;
|
|
18
|
-
exports.exists = exists;
|
|
19
|
-
exports.mapValues = mapValues;
|
|
20
|
-
exports.canConsumeForm = canConsumeForm;
|
|
21
|
-
exports.unflattenBody = unflattenBody;
|
|
22
23
|
exports.BASE_PATH = "https://boat.dev/api/v1".replace(/\/+$/, "");
|
|
23
24
|
class Configuration {
|
|
24
25
|
constructor(configuration = {}) {
|
|
@@ -86,7 +87,7 @@ class BaseAPI {
|
|
|
86
87
|
}
|
|
87
88
|
let response = undefined;
|
|
88
89
|
try {
|
|
89
|
-
response = await (this.configuration.fetchApi ||
|
|
90
|
+
response = await (this.configuration.fetchApi || http2_fetch_1.defaultFetch)(fetchParams.url, fetchParams.init);
|
|
90
91
|
}
|
|
91
92
|
catch (e) {
|
|
92
93
|
for (const middleware of this.middleware) {
|