@boatdev/sdk 1.9.3 → 1.9.5
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 +4 -0
- package/dist/apis/BoatApi.d.ts +42 -4
- package/dist/apis/BoatApi.js +102 -4
- package/dist/esm/apis/BoatApi.d.ts +42 -4
- package/dist/esm/apis/BoatApi.js +102 -4
- package/dist/esm/models/DeletionOperation.d.ts +1 -1
- package/dist/esm/models/FileUrlRequest.d.ts +38 -0
- package/dist/esm/models/FileUrlRequest.js +45 -0
- package/dist/esm/models/FileUrlResponse.d.ts +78 -0
- package/dist/esm/models/FileUrlResponse.js +77 -0
- package/dist/esm/models/HostPortRequest.d.ts +6 -0
- package/dist/esm/models/HostPortRequest.js +2 -0
- package/dist/esm/models/HostPortResponse.d.ts +6 -0
- package/dist/esm/models/HostPortResponse.js +2 -0
- package/dist/esm/models/SnapshotSummary.d.ts +14 -0
- package/dist/esm/models/SnapshotSummary.js +9 -0
- package/dist/esm/models/index.d.ts +2 -0
- package/dist/esm/models/index.js +2 -0
- package/dist/models/DeletionOperation.d.ts +1 -1
- package/dist/models/FileUrlRequest.d.ts +38 -0
- package/dist/models/FileUrlRequest.js +52 -0
- package/dist/models/FileUrlResponse.d.ts +78 -0
- package/dist/models/FileUrlResponse.js +85 -0
- package/dist/models/HostPortRequest.d.ts +6 -0
- package/dist/models/HostPortRequest.js +2 -0
- package/dist/models/HostPortResponse.d.ts +6 -0
- package/dist/models/HostPortResponse.js +2 -0
- package/dist/models/SnapshotSummary.d.ts +14 -0
- package/dist/models/SnapshotSummary.js +10 -1
- package/dist/models/index.d.ts +2 -0
- package/dist/models/index.js +2 -0
- package/docs/BoatApi.md +160 -2
- package/docs/FileUrlRequest.md +34 -0
- package/docs/FileUrlResponse.md +42 -0
- package/docs/HostPortRequest.md +2 -0
- package/docs/HostPortResponse.md +2 -0
- package/docs/SnapshotSummary.md +2 -0
- package/package.json +1 -1
- package/src/apis/BoatApi.ts +156 -4
- package/src/models/DeletionOperation.ts +1 -1
- package/src/models/FileUrlRequest.ts +74 -0
- package/src/models/FileUrlResponse.ts +131 -0
- package/src/models/HostPortRequest.ts +8 -0
- package/src/models/HostPortResponse.ts +8 -0
- package/src/models/SnapshotSummary.ts +17 -0
- package/src/models/index.ts +2 -0
|
@@ -0,0 +1,78 @@
|
|
|
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 FileUrlResponse
|
|
16
|
+
*/
|
|
17
|
+
export interface FileUrlResponse {
|
|
18
|
+
/**
|
|
19
|
+
*
|
|
20
|
+
* @type {boolean}
|
|
21
|
+
* @memberof FileUrlResponse
|
|
22
|
+
*/
|
|
23
|
+
ok: boolean;
|
|
24
|
+
/**
|
|
25
|
+
*
|
|
26
|
+
* @type {FileUrlResponseTypeEnum}
|
|
27
|
+
* @memberof FileUrlResponse
|
|
28
|
+
*/
|
|
29
|
+
type: FileUrlResponseTypeEnum;
|
|
30
|
+
/**
|
|
31
|
+
* The signed URL. Send the request straight to it; it needs no Authorization header.
|
|
32
|
+
* @type {string}
|
|
33
|
+
* @memberof FileUrlResponse
|
|
34
|
+
*/
|
|
35
|
+
url: string;
|
|
36
|
+
/**
|
|
37
|
+
* GET downloads the file. PUT uploads the request body as the file.
|
|
38
|
+
* @type {FileUrlResponseMethodEnum}
|
|
39
|
+
* @memberof FileUrlResponse
|
|
40
|
+
*/
|
|
41
|
+
method: FileUrlResponseMethodEnum;
|
|
42
|
+
/**
|
|
43
|
+
* The canonical path the URL is bound to.
|
|
44
|
+
* @type {string}
|
|
45
|
+
* @memberof FileUrlResponse
|
|
46
|
+
*/
|
|
47
|
+
path: string;
|
|
48
|
+
/**
|
|
49
|
+
*
|
|
50
|
+
* @type {Date}
|
|
51
|
+
* @memberof FileUrlResponse
|
|
52
|
+
*/
|
|
53
|
+
expiresAt: Date;
|
|
54
|
+
}
|
|
55
|
+
/**
|
|
56
|
+
* @export
|
|
57
|
+
*/
|
|
58
|
+
export declare const FileUrlResponseTypeEnum: {
|
|
59
|
+
readonly FileDownloadUrl: 'file.download_url';
|
|
60
|
+
readonly FileUploadUrl: 'file.upload_url';
|
|
61
|
+
};
|
|
62
|
+
export type FileUrlResponseTypeEnum = typeof FileUrlResponseTypeEnum[keyof typeof FileUrlResponseTypeEnum];
|
|
63
|
+
/**
|
|
64
|
+
* @export
|
|
65
|
+
*/
|
|
66
|
+
export declare const FileUrlResponseMethodEnum: {
|
|
67
|
+
readonly Get: 'GET';
|
|
68
|
+
readonly Put: 'PUT';
|
|
69
|
+
};
|
|
70
|
+
export type FileUrlResponseMethodEnum = typeof FileUrlResponseMethodEnum[keyof typeof FileUrlResponseMethodEnum];
|
|
71
|
+
/**
|
|
72
|
+
* Check if a given object implements the FileUrlResponse interface.
|
|
73
|
+
*/
|
|
74
|
+
export declare function instanceOfFileUrlResponse(value: object): value is FileUrlResponse;
|
|
75
|
+
export declare function FileUrlResponseFromJSON(json: any): FileUrlResponse;
|
|
76
|
+
export declare function FileUrlResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): FileUrlResponse;
|
|
77
|
+
export declare function FileUrlResponseToJSON(json: any): FileUrlResponse;
|
|
78
|
+
export declare function FileUrlResponseToJSONTyped(value?: FileUrlResponse | null, ignoreDiscriminator?: boolean): any;
|
|
@@ -0,0 +1,77 @@
|
|
|
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 FileUrlResponseTypeEnum = {
|
|
18
|
+
FileDownloadUrl: 'file.download_url',
|
|
19
|
+
FileUploadUrl: 'file.upload_url'
|
|
20
|
+
};
|
|
21
|
+
/**
|
|
22
|
+
* @export
|
|
23
|
+
*/
|
|
24
|
+
export const FileUrlResponseMethodEnum = {
|
|
25
|
+
Get: 'GET',
|
|
26
|
+
Put: 'PUT'
|
|
27
|
+
};
|
|
28
|
+
/**
|
|
29
|
+
* Check if a given object implements the FileUrlResponse interface.
|
|
30
|
+
*/
|
|
31
|
+
export function instanceOfFileUrlResponse(value) {
|
|
32
|
+
if (!('ok' in value) || value['ok'] === undefined)
|
|
33
|
+
return false;
|
|
34
|
+
if (!('type' in value) || value['type'] === undefined)
|
|
35
|
+
return false;
|
|
36
|
+
if (!('url' in value) || value['url'] === undefined)
|
|
37
|
+
return false;
|
|
38
|
+
if (!('method' in value) || value['method'] === undefined)
|
|
39
|
+
return false;
|
|
40
|
+
if (!('path' in value) || value['path'] === undefined)
|
|
41
|
+
return false;
|
|
42
|
+
if (!('expiresAt' in value) || value['expiresAt'] === undefined)
|
|
43
|
+
return false;
|
|
44
|
+
return true;
|
|
45
|
+
}
|
|
46
|
+
export function FileUrlResponseFromJSON(json) {
|
|
47
|
+
return FileUrlResponseFromJSONTyped(json, false);
|
|
48
|
+
}
|
|
49
|
+
export function FileUrlResponseFromJSONTyped(json, ignoreDiscriminator) {
|
|
50
|
+
if (json == null) {
|
|
51
|
+
return json;
|
|
52
|
+
}
|
|
53
|
+
return {
|
|
54
|
+
'ok': json['ok'],
|
|
55
|
+
'type': json['type'],
|
|
56
|
+
'url': json['url'],
|
|
57
|
+
'method': json['method'],
|
|
58
|
+
'path': json['path'],
|
|
59
|
+
'expiresAt': (new Date(json['expiresAt'])),
|
|
60
|
+
};
|
|
61
|
+
}
|
|
62
|
+
export function FileUrlResponseToJSON(json) {
|
|
63
|
+
return FileUrlResponseToJSONTyped(json, false);
|
|
64
|
+
}
|
|
65
|
+
export function FileUrlResponseToJSONTyped(value, ignoreDiscriminator = false) {
|
|
66
|
+
if (value == null) {
|
|
67
|
+
return value;
|
|
68
|
+
}
|
|
69
|
+
return {
|
|
70
|
+
'ok': value['ok'],
|
|
71
|
+
'type': value['type'],
|
|
72
|
+
'url': value['url'],
|
|
73
|
+
'method': value['method'],
|
|
74
|
+
'path': value['path'],
|
|
75
|
+
'expiresAt': value['expiresAt'].toISOString(),
|
|
76
|
+
};
|
|
77
|
+
}
|
|
@@ -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}
|
|
@@ -29,6 +29,7 @@ export function HostPortRequestFromJSONTyped(json, ignoreDiscriminator) {
|
|
|
29
29
|
return {
|
|
30
30
|
'port': json['port'],
|
|
31
31
|
'_public': json['public'] == null ? undefined : json['public'],
|
|
32
|
+
'localhost': json['localhost'] == null ? undefined : json['localhost'],
|
|
32
33
|
'title': json['title'] == null ? undefined : json['title'],
|
|
33
34
|
};
|
|
34
35
|
}
|
|
@@ -42,6 +43,7 @@ export function HostPortRequestToJSONTyped(value, ignoreDiscriminator = false) {
|
|
|
42
43
|
return {
|
|
43
44
|
'port': value['port'],
|
|
44
45
|
'public': value['_public'],
|
|
46
|
+
'localhost': value['localhost'],
|
|
45
47
|
'title': value['title'],
|
|
46
48
|
};
|
|
47
49
|
}
|
|
@@ -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
|
|
@@ -43,6 +43,7 @@ export function HostPortResponseFromJSONTyped(json, ignoreDiscriminator) {
|
|
|
43
43
|
'url': json['url'] == null ? undefined : json['url'],
|
|
44
44
|
'isProtected': json['isProtected'] == null ? undefined : json['isProtected'],
|
|
45
45
|
'access': json['access'] == null ? undefined : json['access'],
|
|
46
|
+
'localhost': json['localhost'] == null ? undefined : json['localhost'],
|
|
46
47
|
};
|
|
47
48
|
}
|
|
48
49
|
export function HostPortResponseToJSON(json) {
|
|
@@ -60,5 +61,6 @@ export function HostPortResponseToJSONTyped(value, ignoreDiscriminator = false)
|
|
|
60
61
|
'url': value['url'],
|
|
61
62
|
'isProtected': value['isProtected'],
|
|
62
63
|
'access': value['access'],
|
|
64
|
+
'localhost': value['localhost'],
|
|
63
65
|
};
|
|
64
66
|
}
|
|
@@ -87,6 +87,12 @@ export interface SnapshotSummary {
|
|
|
87
87
|
* @memberof SnapshotSummary
|
|
88
88
|
*/
|
|
89
89
|
contentFileCount?: number | null;
|
|
90
|
+
/**
|
|
91
|
+
* `template` = this Sandbox has snapshots off, so Boat never captures it: the row is a copy of the template, named snapshot or Sandbox it was created from. `captured` = this Sandbox has snapshots on: its own captures, plus the copies Boat makes when the Sandbox is created from a source, forked or resumed.
|
|
92
|
+
* @type {SnapshotSummaryOriginEnum}
|
|
93
|
+
* @memberof SnapshotSummary
|
|
94
|
+
*/
|
|
95
|
+
origin?: SnapshotSummaryOriginEnum;
|
|
90
96
|
}
|
|
91
97
|
/**
|
|
92
98
|
* @export
|
|
@@ -103,6 +109,14 @@ export declare const SnapshotSummaryKindEnum: {
|
|
|
103
109
|
readonly Incremental: 'incremental';
|
|
104
110
|
};
|
|
105
111
|
export type SnapshotSummaryKindEnum = typeof SnapshotSummaryKindEnum[keyof typeof SnapshotSummaryKindEnum];
|
|
112
|
+
/**
|
|
113
|
+
* @export
|
|
114
|
+
*/
|
|
115
|
+
export declare const SnapshotSummaryOriginEnum: {
|
|
116
|
+
readonly Captured: 'captured';
|
|
117
|
+
readonly Template: 'template';
|
|
118
|
+
};
|
|
119
|
+
export type SnapshotSummaryOriginEnum = typeof SnapshotSummaryOriginEnum[keyof typeof SnapshotSummaryOriginEnum];
|
|
106
120
|
/**
|
|
107
121
|
* Check if a given object implements the SnapshotSummary interface.
|
|
108
122
|
*/
|
|
@@ -24,6 +24,13 @@ export const SnapshotSummaryKindEnum = {
|
|
|
24
24
|
Base: 'base',
|
|
25
25
|
Incremental: 'incremental'
|
|
26
26
|
};
|
|
27
|
+
/**
|
|
28
|
+
* @export
|
|
29
|
+
*/
|
|
30
|
+
export const SnapshotSummaryOriginEnum = {
|
|
31
|
+
Captured: 'captured',
|
|
32
|
+
Template: 'template'
|
|
33
|
+
};
|
|
27
34
|
/**
|
|
28
35
|
* Check if a given object implements the SnapshotSummary interface.
|
|
29
36
|
*/
|
|
@@ -64,6 +71,7 @@ export function SnapshotSummaryFromJSONTyped(json, ignoreDiscriminator) {
|
|
|
64
71
|
'fileCount': json['fileCount'],
|
|
65
72
|
'contentSizeBytes': json['contentSizeBytes'] == null ? undefined : json['contentSizeBytes'],
|
|
66
73
|
'contentFileCount': json['contentFileCount'] == null ? undefined : json['contentFileCount'],
|
|
74
|
+
'origin': json['origin'] == null ? undefined : json['origin'],
|
|
67
75
|
};
|
|
68
76
|
}
|
|
69
77
|
export function SnapshotSummaryToJSON(json) {
|
|
@@ -86,5 +94,6 @@ export function SnapshotSummaryToJSONTyped(value, ignoreDiscriminator = false) {
|
|
|
86
94
|
'fileCount': value['fileCount'],
|
|
87
95
|
'contentSizeBytes': value['contentSizeBytes'],
|
|
88
96
|
'contentFileCount': value['contentFileCount'],
|
|
97
|
+
'origin': value['origin'],
|
|
89
98
|
};
|
|
90
99
|
}
|
|
@@ -48,6 +48,8 @@ export * from './ErrorEnvelopeError';
|
|
|
48
48
|
export * from './ErrorEvent';
|
|
49
49
|
export * from './EventsResponse';
|
|
50
50
|
export * from './FileReadResponse';
|
|
51
|
+
export * from './FileUrlRequest';
|
|
52
|
+
export * from './FileUrlResponse';
|
|
51
53
|
export * from './FileWriteRequest';
|
|
52
54
|
export * from './FileWriteResponse';
|
|
53
55
|
export * from './ForkRequest';
|
package/dist/esm/models/index.js
CHANGED
|
@@ -50,6 +50,8 @@ export * from './ErrorEnvelopeError';
|
|
|
50
50
|
export * from './ErrorEvent';
|
|
51
51
|
export * from './EventsResponse';
|
|
52
52
|
export * from './FileReadResponse';
|
|
53
|
+
export * from './FileUrlRequest';
|
|
54
|
+
export * from './FileUrlResponse';
|
|
53
55
|
export * from './FileWriteRequest';
|
|
54
56
|
export * from './FileWriteResponse';
|
|
55
57
|
export * from './ForkRequest';
|
|
@@ -46,7 +46,7 @@ export interface DeletionOperation {
|
|
|
46
46
|
*/
|
|
47
47
|
status: DeletionOperationStatusEnum;
|
|
48
48
|
/**
|
|
49
|
-
* What the background purge is doing. The target is already gone from every list, restore and fork once the operation exists. `waiting_for_uploads`: stored data is erased once the last upload URL issued for it expires (`expectedBy`). `kept_for_newer_snapshots`: a newer snapshot
|
|
49
|
+
* What the background purge is doing. The target is already gone from every list, restore and fork once the operation exists. `waiting_for_uploads`: stored data is erased once the last upload URL issued for it expires (`expectedBy`). `kept_for_newer_snapshots`: a newer snapshot, or a sandbox forked or deployed from it, still builds on this data; it goes when they go. `waiting_for_restore`: a sandbox is still restoring from it. `retrying`: a transient fault, retried automatically.
|
|
50
50
|
* @type {DeletionOperationStageEnum}
|
|
51
51
|
* @memberof DeletionOperation
|
|
52
52
|
*/
|
|
@@ -0,0 +1,38 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Boat Public API v1
|
|
3
|
+
* Public JSON API for creating, operating, prompting, observing, and exposing sandboxes from backend services, CI jobs, hosted workers, and Boat automation products. The v1 reference intentionally documents the developer integration surface only. Dashboard billing actions are not part of v1.
|
|
4
|
+
*
|
|
5
|
+
* The version of the OpenAPI document: 1.0.0
|
|
6
|
+
*
|
|
7
|
+
*
|
|
8
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
9
|
+
* https://openapi-generator.tech
|
|
10
|
+
* Do not edit the class manually.
|
|
11
|
+
*/
|
|
12
|
+
/**
|
|
13
|
+
*
|
|
14
|
+
* @export
|
|
15
|
+
* @interface FileUrlRequest
|
|
16
|
+
*/
|
|
17
|
+
export interface FileUrlRequest {
|
|
18
|
+
/**
|
|
19
|
+
* Absolute path, or path relative to the sandbox work directory (/home/user). It must resolve under /home/user or /tmp.
|
|
20
|
+
* @type {string}
|
|
21
|
+
* @memberof FileUrlRequest
|
|
22
|
+
*/
|
|
23
|
+
path: string;
|
|
24
|
+
/**
|
|
25
|
+
* How long the URL stays valid.
|
|
26
|
+
* @type {number}
|
|
27
|
+
* @memberof FileUrlRequest
|
|
28
|
+
*/
|
|
29
|
+
ttlSeconds?: number;
|
|
30
|
+
}
|
|
31
|
+
/**
|
|
32
|
+
* Check if a given object implements the FileUrlRequest interface.
|
|
33
|
+
*/
|
|
34
|
+
export declare function instanceOfFileUrlRequest(value: object): value is FileUrlRequest;
|
|
35
|
+
export declare function FileUrlRequestFromJSON(json: any): FileUrlRequest;
|
|
36
|
+
export declare function FileUrlRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): FileUrlRequest;
|
|
37
|
+
export declare function FileUrlRequestToJSON(json: any): FileUrlRequest;
|
|
38
|
+
export declare function FileUrlRequestToJSONTyped(value?: FileUrlRequest | null, ignoreDiscriminator?: boolean): any;
|
|
@@ -0,0 +1,52 @@
|
|
|
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.instanceOfFileUrlRequest = instanceOfFileUrlRequest;
|
|
17
|
+
exports.FileUrlRequestFromJSON = FileUrlRequestFromJSON;
|
|
18
|
+
exports.FileUrlRequestFromJSONTyped = FileUrlRequestFromJSONTyped;
|
|
19
|
+
exports.FileUrlRequestToJSON = FileUrlRequestToJSON;
|
|
20
|
+
exports.FileUrlRequestToJSONTyped = FileUrlRequestToJSONTyped;
|
|
21
|
+
/**
|
|
22
|
+
* Check if a given object implements the FileUrlRequest interface.
|
|
23
|
+
*/
|
|
24
|
+
function instanceOfFileUrlRequest(value) {
|
|
25
|
+
if (!('path' in value) || value['path'] === undefined)
|
|
26
|
+
return false;
|
|
27
|
+
return true;
|
|
28
|
+
}
|
|
29
|
+
function FileUrlRequestFromJSON(json) {
|
|
30
|
+
return FileUrlRequestFromJSONTyped(json, false);
|
|
31
|
+
}
|
|
32
|
+
function FileUrlRequestFromJSONTyped(json, ignoreDiscriminator) {
|
|
33
|
+
if (json == null) {
|
|
34
|
+
return json;
|
|
35
|
+
}
|
|
36
|
+
return {
|
|
37
|
+
'path': json['path'],
|
|
38
|
+
'ttlSeconds': json['ttlSeconds'] == null ? undefined : json['ttlSeconds'],
|
|
39
|
+
};
|
|
40
|
+
}
|
|
41
|
+
function FileUrlRequestToJSON(json) {
|
|
42
|
+
return FileUrlRequestToJSONTyped(json, false);
|
|
43
|
+
}
|
|
44
|
+
function FileUrlRequestToJSONTyped(value, ignoreDiscriminator = false) {
|
|
45
|
+
if (value == null) {
|
|
46
|
+
return value;
|
|
47
|
+
}
|
|
48
|
+
return {
|
|
49
|
+
'path': value['path'],
|
|
50
|
+
'ttlSeconds': value['ttlSeconds'],
|
|
51
|
+
};
|
|
52
|
+
}
|
|
@@ -0,0 +1,78 @@
|
|
|
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 FileUrlResponse
|
|
16
|
+
*/
|
|
17
|
+
export interface FileUrlResponse {
|
|
18
|
+
/**
|
|
19
|
+
*
|
|
20
|
+
* @type {boolean}
|
|
21
|
+
* @memberof FileUrlResponse
|
|
22
|
+
*/
|
|
23
|
+
ok: boolean;
|
|
24
|
+
/**
|
|
25
|
+
*
|
|
26
|
+
* @type {FileUrlResponseTypeEnum}
|
|
27
|
+
* @memberof FileUrlResponse
|
|
28
|
+
*/
|
|
29
|
+
type: FileUrlResponseTypeEnum;
|
|
30
|
+
/**
|
|
31
|
+
* The signed URL. Send the request straight to it; it needs no Authorization header.
|
|
32
|
+
* @type {string}
|
|
33
|
+
* @memberof FileUrlResponse
|
|
34
|
+
*/
|
|
35
|
+
url: string;
|
|
36
|
+
/**
|
|
37
|
+
* GET downloads the file. PUT uploads the request body as the file.
|
|
38
|
+
* @type {FileUrlResponseMethodEnum}
|
|
39
|
+
* @memberof FileUrlResponse
|
|
40
|
+
*/
|
|
41
|
+
method: FileUrlResponseMethodEnum;
|
|
42
|
+
/**
|
|
43
|
+
* The canonical path the URL is bound to.
|
|
44
|
+
* @type {string}
|
|
45
|
+
* @memberof FileUrlResponse
|
|
46
|
+
*/
|
|
47
|
+
path: string;
|
|
48
|
+
/**
|
|
49
|
+
*
|
|
50
|
+
* @type {Date}
|
|
51
|
+
* @memberof FileUrlResponse
|
|
52
|
+
*/
|
|
53
|
+
expiresAt: Date;
|
|
54
|
+
}
|
|
55
|
+
/**
|
|
56
|
+
* @export
|
|
57
|
+
*/
|
|
58
|
+
export declare const FileUrlResponseTypeEnum: {
|
|
59
|
+
readonly FileDownloadUrl: 'file.download_url';
|
|
60
|
+
readonly FileUploadUrl: 'file.upload_url';
|
|
61
|
+
};
|
|
62
|
+
export type FileUrlResponseTypeEnum = typeof FileUrlResponseTypeEnum[keyof typeof FileUrlResponseTypeEnum];
|
|
63
|
+
/**
|
|
64
|
+
* @export
|
|
65
|
+
*/
|
|
66
|
+
export declare const FileUrlResponseMethodEnum: {
|
|
67
|
+
readonly Get: 'GET';
|
|
68
|
+
readonly Put: 'PUT';
|
|
69
|
+
};
|
|
70
|
+
export type FileUrlResponseMethodEnum = typeof FileUrlResponseMethodEnum[keyof typeof FileUrlResponseMethodEnum];
|
|
71
|
+
/**
|
|
72
|
+
* Check if a given object implements the FileUrlResponse interface.
|
|
73
|
+
*/
|
|
74
|
+
export declare function instanceOfFileUrlResponse(value: object): value is FileUrlResponse;
|
|
75
|
+
export declare function FileUrlResponseFromJSON(json: any): FileUrlResponse;
|
|
76
|
+
export declare function FileUrlResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): FileUrlResponse;
|
|
77
|
+
export declare function FileUrlResponseToJSON(json: any): FileUrlResponse;
|
|
78
|
+
export declare function FileUrlResponseToJSONTyped(value?: FileUrlResponse | null, ignoreDiscriminator?: boolean): any;
|
|
@@ -0,0 +1,85 @@
|
|
|
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.FileUrlResponseMethodEnum = exports.FileUrlResponseTypeEnum = void 0;
|
|
17
|
+
exports.instanceOfFileUrlResponse = instanceOfFileUrlResponse;
|
|
18
|
+
exports.FileUrlResponseFromJSON = FileUrlResponseFromJSON;
|
|
19
|
+
exports.FileUrlResponseFromJSONTyped = FileUrlResponseFromJSONTyped;
|
|
20
|
+
exports.FileUrlResponseToJSON = FileUrlResponseToJSON;
|
|
21
|
+
exports.FileUrlResponseToJSONTyped = FileUrlResponseToJSONTyped;
|
|
22
|
+
/**
|
|
23
|
+
* @export
|
|
24
|
+
*/
|
|
25
|
+
exports.FileUrlResponseTypeEnum = {
|
|
26
|
+
FileDownloadUrl: 'file.download_url',
|
|
27
|
+
FileUploadUrl: 'file.upload_url'
|
|
28
|
+
};
|
|
29
|
+
/**
|
|
30
|
+
* @export
|
|
31
|
+
*/
|
|
32
|
+
exports.FileUrlResponseMethodEnum = {
|
|
33
|
+
Get: 'GET',
|
|
34
|
+
Put: 'PUT'
|
|
35
|
+
};
|
|
36
|
+
/**
|
|
37
|
+
* Check if a given object implements the FileUrlResponse interface.
|
|
38
|
+
*/
|
|
39
|
+
function instanceOfFileUrlResponse(value) {
|
|
40
|
+
if (!('ok' in value) || value['ok'] === undefined)
|
|
41
|
+
return false;
|
|
42
|
+
if (!('type' in value) || value['type'] === undefined)
|
|
43
|
+
return false;
|
|
44
|
+
if (!('url' in value) || value['url'] === undefined)
|
|
45
|
+
return false;
|
|
46
|
+
if (!('method' in value) || value['method'] === undefined)
|
|
47
|
+
return false;
|
|
48
|
+
if (!('path' in value) || value['path'] === undefined)
|
|
49
|
+
return false;
|
|
50
|
+
if (!('expiresAt' in value) || value['expiresAt'] === undefined)
|
|
51
|
+
return false;
|
|
52
|
+
return true;
|
|
53
|
+
}
|
|
54
|
+
function FileUrlResponseFromJSON(json) {
|
|
55
|
+
return FileUrlResponseFromJSONTyped(json, false);
|
|
56
|
+
}
|
|
57
|
+
function FileUrlResponseFromJSONTyped(json, ignoreDiscriminator) {
|
|
58
|
+
if (json == null) {
|
|
59
|
+
return json;
|
|
60
|
+
}
|
|
61
|
+
return {
|
|
62
|
+
'ok': json['ok'],
|
|
63
|
+
'type': json['type'],
|
|
64
|
+
'url': json['url'],
|
|
65
|
+
'method': json['method'],
|
|
66
|
+
'path': json['path'],
|
|
67
|
+
'expiresAt': (new Date(json['expiresAt'])),
|
|
68
|
+
};
|
|
69
|
+
}
|
|
70
|
+
function FileUrlResponseToJSON(json) {
|
|
71
|
+
return FileUrlResponseToJSONTyped(json, false);
|
|
72
|
+
}
|
|
73
|
+
function FileUrlResponseToJSONTyped(value, ignoreDiscriminator = false) {
|
|
74
|
+
if (value == null) {
|
|
75
|
+
return value;
|
|
76
|
+
}
|
|
77
|
+
return {
|
|
78
|
+
'ok': value['ok'],
|
|
79
|
+
'type': value['type'],
|
|
80
|
+
'url': value['url'],
|
|
81
|
+
'method': value['method'],
|
|
82
|
+
'path': value['path'],
|
|
83
|
+
'expiresAt': value['expiresAt'].toISOString(),
|
|
84
|
+
};
|
|
85
|
+
}
|
|
@@ -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
|
}
|
|
@@ -87,6 +87,12 @@ export interface SnapshotSummary {
|
|
|
87
87
|
* @memberof SnapshotSummary
|
|
88
88
|
*/
|
|
89
89
|
contentFileCount?: number | null;
|
|
90
|
+
/**
|
|
91
|
+
* `template` = this Sandbox has snapshots off, so Boat never captures it: the row is a copy of the template, named snapshot or Sandbox it was created from. `captured` = this Sandbox has snapshots on: its own captures, plus the copies Boat makes when the Sandbox is created from a source, forked or resumed.
|
|
92
|
+
* @type {SnapshotSummaryOriginEnum}
|
|
93
|
+
* @memberof SnapshotSummary
|
|
94
|
+
*/
|
|
95
|
+
origin?: SnapshotSummaryOriginEnum;
|
|
90
96
|
}
|
|
91
97
|
/**
|
|
92
98
|
* @export
|
|
@@ -103,6 +109,14 @@ export declare const SnapshotSummaryKindEnum: {
|
|
|
103
109
|
readonly Incremental: 'incremental';
|
|
104
110
|
};
|
|
105
111
|
export type SnapshotSummaryKindEnum = typeof SnapshotSummaryKindEnum[keyof typeof SnapshotSummaryKindEnum];
|
|
112
|
+
/**
|
|
113
|
+
* @export
|
|
114
|
+
*/
|
|
115
|
+
export declare const SnapshotSummaryOriginEnum: {
|
|
116
|
+
readonly Captured: 'captured';
|
|
117
|
+
readonly Template: 'template';
|
|
118
|
+
};
|
|
119
|
+
export type SnapshotSummaryOriginEnum = typeof SnapshotSummaryOriginEnum[keyof typeof SnapshotSummaryOriginEnum];
|
|
106
120
|
/**
|
|
107
121
|
* Check if a given object implements the SnapshotSummary interface.
|
|
108
122
|
*/
|