@boatdev/sdk 1.8.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.
Files changed (40) hide show
  1. package/.openapi-generator/FILES +8 -0
  2. package/dist/apis/BoatApi.d.ts +55 -0
  3. package/dist/apis/BoatApi.js +133 -0
  4. package/dist/esm/apis/BoatApi.d.ts +55 -0
  5. package/dist/esm/apis/BoatApi.js +133 -0
  6. package/dist/esm/models/CreateSandboxRequest.d.ts +1 -1
  7. package/dist/esm/models/NamedSnapshotShare.d.ts +76 -0
  8. package/dist/esm/models/NamedSnapshotShare.js +74 -0
  9. package/dist/esm/models/NamedSnapshotShareCreatedResponse.d.ts +64 -0
  10. package/dist/esm/models/NamedSnapshotShareCreatedResponse.js +66 -0
  11. package/dist/esm/models/NamedSnapshotShareListResponse.d.ts +58 -0
  12. package/dist/esm/models/NamedSnapshotShareListResponse.js +62 -0
  13. package/dist/esm/models/NamedSnapshotShareRevokedResponse.d.ts +58 -0
  14. package/dist/esm/models/NamedSnapshotShareRevokedResponse.js +62 -0
  15. package/dist/esm/models/index.d.ts +4 -0
  16. package/dist/esm/models/index.js +4 -0
  17. package/dist/models/CreateSandboxRequest.d.ts +1 -1
  18. package/dist/models/NamedSnapshotShare.d.ts +76 -0
  19. package/dist/models/NamedSnapshotShare.js +82 -0
  20. package/dist/models/NamedSnapshotShareCreatedResponse.d.ts +64 -0
  21. package/dist/models/NamedSnapshotShareCreatedResponse.js +74 -0
  22. package/dist/models/NamedSnapshotShareListResponse.d.ts +58 -0
  23. package/dist/models/NamedSnapshotShareListResponse.js +70 -0
  24. package/dist/models/NamedSnapshotShareRevokedResponse.d.ts +58 -0
  25. package/dist/models/NamedSnapshotShareRevokedResponse.js +70 -0
  26. package/dist/models/index.d.ts +4 -0
  27. package/dist/models/index.js +4 -0
  28. package/docs/BoatApi.md +225 -0
  29. package/docs/NamedSnapshotShare.md +45 -0
  30. package/docs/NamedSnapshotShareCreatedResponse.md +40 -0
  31. package/docs/NamedSnapshotShareListResponse.md +38 -0
  32. package/docs/NamedSnapshotShareRevokedResponse.md +38 -0
  33. package/package.json +1 -1
  34. package/src/apis/BoatApi.ts +201 -0
  35. package/src/models/CreateSandboxRequest.ts +1 -1
  36. package/src/models/NamedSnapshotShare.ts +131 -0
  37. package/src/models/NamedSnapshotShareCreatedResponse.ts +120 -0
  38. package/src/models/NamedSnapshotShareListResponse.ts +111 -0
  39. package/src/models/NamedSnapshotShareRevokedResponse.ts +111 -0
  40. package/src/models/index.ts +4 -0
@@ -0,0 +1,64 @@
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 { NamedSnapshotShare } from './NamedSnapshotShare';
13
+ /**
14
+ *
15
+ * @export
16
+ * @interface NamedSnapshotShareCreatedResponse
17
+ */
18
+ export interface NamedSnapshotShareCreatedResponse {
19
+ /**
20
+ *
21
+ * @type {boolean}
22
+ * @memberof NamedSnapshotShareCreatedResponse
23
+ */
24
+ ok: boolean;
25
+ /**
26
+ *
27
+ * @type {NamedSnapshotShareCreatedResponseTypeEnum}
28
+ * @memberof NamedSnapshotShareCreatedResponse
29
+ */
30
+ type: NamedSnapshotShareCreatedResponseTypeEnum;
31
+ /**
32
+ * The named snapshot the code deploys.
33
+ * @type {string}
34
+ * @memberof NamedSnapshotShareCreatedResponse
35
+ */
36
+ name: string;
37
+ /**
38
+ * The share code, for example `bsh_...`. Boat shows it only in this response. Store it now; you cannot get it again.
39
+ * @type {string}
40
+ * @memberof NamedSnapshotShareCreatedResponse
41
+ */
42
+ shareCode: string;
43
+ /**
44
+ *
45
+ * @type {NamedSnapshotShare}
46
+ * @memberof NamedSnapshotShareCreatedResponse
47
+ */
48
+ share: NamedSnapshotShare;
49
+ }
50
+ /**
51
+ * @export
52
+ */
53
+ export declare const NamedSnapshotShareCreatedResponseTypeEnum: {
54
+ readonly SnapshotShareCreated: 'snapshot.share.created';
55
+ };
56
+ export type NamedSnapshotShareCreatedResponseTypeEnum = typeof NamedSnapshotShareCreatedResponseTypeEnum[keyof typeof NamedSnapshotShareCreatedResponseTypeEnum];
57
+ /**
58
+ * Check if a given object implements the NamedSnapshotShareCreatedResponse interface.
59
+ */
60
+ export declare function instanceOfNamedSnapshotShareCreatedResponse(value: object): value is NamedSnapshotShareCreatedResponse;
61
+ export declare function NamedSnapshotShareCreatedResponseFromJSON(json: any): NamedSnapshotShareCreatedResponse;
62
+ export declare function NamedSnapshotShareCreatedResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): NamedSnapshotShareCreatedResponse;
63
+ export declare function NamedSnapshotShareCreatedResponseToJSON(json: any): NamedSnapshotShareCreatedResponse;
64
+ export declare function NamedSnapshotShareCreatedResponseToJSONTyped(value?: NamedSnapshotShareCreatedResponse | null, ignoreDiscriminator?: boolean): any;
@@ -0,0 +1,74 @@
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.NamedSnapshotShareCreatedResponseTypeEnum = void 0;
17
+ exports.instanceOfNamedSnapshotShareCreatedResponse = instanceOfNamedSnapshotShareCreatedResponse;
18
+ exports.NamedSnapshotShareCreatedResponseFromJSON = NamedSnapshotShareCreatedResponseFromJSON;
19
+ exports.NamedSnapshotShareCreatedResponseFromJSONTyped = NamedSnapshotShareCreatedResponseFromJSONTyped;
20
+ exports.NamedSnapshotShareCreatedResponseToJSON = NamedSnapshotShareCreatedResponseToJSON;
21
+ exports.NamedSnapshotShareCreatedResponseToJSONTyped = NamedSnapshotShareCreatedResponseToJSONTyped;
22
+ const NamedSnapshotShare_1 = require("./NamedSnapshotShare");
23
+ /**
24
+ * @export
25
+ */
26
+ exports.NamedSnapshotShareCreatedResponseTypeEnum = {
27
+ SnapshotShareCreated: 'snapshot.share.created'
28
+ };
29
+ /**
30
+ * Check if a given object implements the NamedSnapshotShareCreatedResponse interface.
31
+ */
32
+ function instanceOfNamedSnapshotShareCreatedResponse(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 (!('name' in value) || value['name'] === undefined)
38
+ return false;
39
+ if (!('shareCode' in value) || value['shareCode'] === undefined)
40
+ return false;
41
+ if (!('share' in value) || value['share'] === undefined)
42
+ return false;
43
+ return true;
44
+ }
45
+ function NamedSnapshotShareCreatedResponseFromJSON(json) {
46
+ return NamedSnapshotShareCreatedResponseFromJSONTyped(json, false);
47
+ }
48
+ function NamedSnapshotShareCreatedResponseFromJSONTyped(json, ignoreDiscriminator) {
49
+ if (json == null) {
50
+ return json;
51
+ }
52
+ return {
53
+ 'ok': json['ok'],
54
+ 'type': json['type'],
55
+ 'name': json['name'],
56
+ 'shareCode': json['shareCode'],
57
+ 'share': (0, NamedSnapshotShare_1.NamedSnapshotShareFromJSON)(json['share']),
58
+ };
59
+ }
60
+ function NamedSnapshotShareCreatedResponseToJSON(json) {
61
+ return NamedSnapshotShareCreatedResponseToJSONTyped(json, false);
62
+ }
63
+ function NamedSnapshotShareCreatedResponseToJSONTyped(value, ignoreDiscriminator = false) {
64
+ if (value == null) {
65
+ return value;
66
+ }
67
+ return {
68
+ 'ok': value['ok'],
69
+ 'type': value['type'],
70
+ 'name': value['name'],
71
+ 'shareCode': value['shareCode'],
72
+ 'share': (0, NamedSnapshotShare_1.NamedSnapshotShareToJSON)(value['share']),
73
+ };
74
+ }
@@ -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 { NamedSnapshotShare } from './NamedSnapshotShare';
13
+ /**
14
+ *
15
+ * @export
16
+ * @interface NamedSnapshotShareListResponse
17
+ */
18
+ export interface NamedSnapshotShareListResponse {
19
+ /**
20
+ *
21
+ * @type {boolean}
22
+ * @memberof NamedSnapshotShareListResponse
23
+ */
24
+ ok: boolean;
25
+ /**
26
+ *
27
+ * @type {NamedSnapshotShareListResponseTypeEnum}
28
+ * @memberof NamedSnapshotShareListResponse
29
+ */
30
+ type: NamedSnapshotShareListResponseTypeEnum;
31
+ /**
32
+ *
33
+ * @type {string}
34
+ * @memberof NamedSnapshotShareListResponse
35
+ */
36
+ name: string;
37
+ /**
38
+ *
39
+ * @type {Array<NamedSnapshotShare>}
40
+ * @memberof NamedSnapshotShareListResponse
41
+ */
42
+ shares: Array<NamedSnapshotShare>;
43
+ }
44
+ /**
45
+ * @export
46
+ */
47
+ export declare const NamedSnapshotShareListResponseTypeEnum: {
48
+ readonly SnapshotShareList: 'snapshot.share.list';
49
+ };
50
+ export type NamedSnapshotShareListResponseTypeEnum = typeof NamedSnapshotShareListResponseTypeEnum[keyof typeof NamedSnapshotShareListResponseTypeEnum];
51
+ /**
52
+ * Check if a given object implements the NamedSnapshotShareListResponse interface.
53
+ */
54
+ export declare function instanceOfNamedSnapshotShareListResponse(value: object): value is NamedSnapshotShareListResponse;
55
+ export declare function NamedSnapshotShareListResponseFromJSON(json: any): NamedSnapshotShareListResponse;
56
+ export declare function NamedSnapshotShareListResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): NamedSnapshotShareListResponse;
57
+ export declare function NamedSnapshotShareListResponseToJSON(json: any): NamedSnapshotShareListResponse;
58
+ export declare function NamedSnapshotShareListResponseToJSONTyped(value?: NamedSnapshotShareListResponse | 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.NamedSnapshotShareListResponseTypeEnum = void 0;
17
+ exports.instanceOfNamedSnapshotShareListResponse = instanceOfNamedSnapshotShareListResponse;
18
+ exports.NamedSnapshotShareListResponseFromJSON = NamedSnapshotShareListResponseFromJSON;
19
+ exports.NamedSnapshotShareListResponseFromJSONTyped = NamedSnapshotShareListResponseFromJSONTyped;
20
+ exports.NamedSnapshotShareListResponseToJSON = NamedSnapshotShareListResponseToJSON;
21
+ exports.NamedSnapshotShareListResponseToJSONTyped = NamedSnapshotShareListResponseToJSONTyped;
22
+ const NamedSnapshotShare_1 = require("./NamedSnapshotShare");
23
+ /**
24
+ * @export
25
+ */
26
+ exports.NamedSnapshotShareListResponseTypeEnum = {
27
+ SnapshotShareList: 'snapshot.share.list'
28
+ };
29
+ /**
30
+ * Check if a given object implements the NamedSnapshotShareListResponse interface.
31
+ */
32
+ function instanceOfNamedSnapshotShareListResponse(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 (!('name' in value) || value['name'] === undefined)
38
+ return false;
39
+ if (!('shares' in value) || value['shares'] === undefined)
40
+ return false;
41
+ return true;
42
+ }
43
+ function NamedSnapshotShareListResponseFromJSON(json) {
44
+ return NamedSnapshotShareListResponseFromJSONTyped(json, false);
45
+ }
46
+ function NamedSnapshotShareListResponseFromJSONTyped(json, ignoreDiscriminator) {
47
+ if (json == null) {
48
+ return json;
49
+ }
50
+ return {
51
+ 'ok': json['ok'],
52
+ 'type': json['type'],
53
+ 'name': json['name'],
54
+ 'shares': (json['shares'].map(NamedSnapshotShare_1.NamedSnapshotShareFromJSON)),
55
+ };
56
+ }
57
+ function NamedSnapshotShareListResponseToJSON(json) {
58
+ return NamedSnapshotShareListResponseToJSONTyped(json, false);
59
+ }
60
+ function NamedSnapshotShareListResponseToJSONTyped(value, ignoreDiscriminator = false) {
61
+ if (value == null) {
62
+ return value;
63
+ }
64
+ return {
65
+ 'ok': value['ok'],
66
+ 'type': value['type'],
67
+ 'name': value['name'],
68
+ 'shares': (value['shares'].map(NamedSnapshotShare_1.NamedSnapshotShareToJSON)),
69
+ };
70
+ }
@@ -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 { NamedSnapshotShare } from './NamedSnapshotShare';
13
+ /**
14
+ *
15
+ * @export
16
+ * @interface NamedSnapshotShareRevokedResponse
17
+ */
18
+ export interface NamedSnapshotShareRevokedResponse {
19
+ /**
20
+ *
21
+ * @type {boolean}
22
+ * @memberof NamedSnapshotShareRevokedResponse
23
+ */
24
+ ok: boolean;
25
+ /**
26
+ *
27
+ * @type {NamedSnapshotShareRevokedResponseTypeEnum}
28
+ * @memberof NamedSnapshotShareRevokedResponse
29
+ */
30
+ type: NamedSnapshotShareRevokedResponseTypeEnum;
31
+ /**
32
+ *
33
+ * @type {string}
34
+ * @memberof NamedSnapshotShareRevokedResponse
35
+ */
36
+ name: string;
37
+ /**
38
+ *
39
+ * @type {NamedSnapshotShare}
40
+ * @memberof NamedSnapshotShareRevokedResponse
41
+ */
42
+ share: NamedSnapshotShare;
43
+ }
44
+ /**
45
+ * @export
46
+ */
47
+ export declare const NamedSnapshotShareRevokedResponseTypeEnum: {
48
+ readonly SnapshotShareRevoked: 'snapshot.share.revoked';
49
+ };
50
+ export type NamedSnapshotShareRevokedResponseTypeEnum = typeof NamedSnapshotShareRevokedResponseTypeEnum[keyof typeof NamedSnapshotShareRevokedResponseTypeEnum];
51
+ /**
52
+ * Check if a given object implements the NamedSnapshotShareRevokedResponse interface.
53
+ */
54
+ export declare function instanceOfNamedSnapshotShareRevokedResponse(value: object): value is NamedSnapshotShareRevokedResponse;
55
+ export declare function NamedSnapshotShareRevokedResponseFromJSON(json: any): NamedSnapshotShareRevokedResponse;
56
+ export declare function NamedSnapshotShareRevokedResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): NamedSnapshotShareRevokedResponse;
57
+ export declare function NamedSnapshotShareRevokedResponseToJSON(json: any): NamedSnapshotShareRevokedResponse;
58
+ export declare function NamedSnapshotShareRevokedResponseToJSONTyped(value?: NamedSnapshotShareRevokedResponse | 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.NamedSnapshotShareRevokedResponseTypeEnum = void 0;
17
+ exports.instanceOfNamedSnapshotShareRevokedResponse = instanceOfNamedSnapshotShareRevokedResponse;
18
+ exports.NamedSnapshotShareRevokedResponseFromJSON = NamedSnapshotShareRevokedResponseFromJSON;
19
+ exports.NamedSnapshotShareRevokedResponseFromJSONTyped = NamedSnapshotShareRevokedResponseFromJSONTyped;
20
+ exports.NamedSnapshotShareRevokedResponseToJSON = NamedSnapshotShareRevokedResponseToJSON;
21
+ exports.NamedSnapshotShareRevokedResponseToJSONTyped = NamedSnapshotShareRevokedResponseToJSONTyped;
22
+ const NamedSnapshotShare_1 = require("./NamedSnapshotShare");
23
+ /**
24
+ * @export
25
+ */
26
+ exports.NamedSnapshotShareRevokedResponseTypeEnum = {
27
+ SnapshotShareRevoked: 'snapshot.share.revoked'
28
+ };
29
+ /**
30
+ * Check if a given object implements the NamedSnapshotShareRevokedResponse interface.
31
+ */
32
+ function instanceOfNamedSnapshotShareRevokedResponse(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 (!('name' in value) || value['name'] === undefined)
38
+ return false;
39
+ if (!('share' in value) || value['share'] === undefined)
40
+ return false;
41
+ return true;
42
+ }
43
+ function NamedSnapshotShareRevokedResponseFromJSON(json) {
44
+ return NamedSnapshotShareRevokedResponseFromJSONTyped(json, false);
45
+ }
46
+ function NamedSnapshotShareRevokedResponseFromJSONTyped(json, ignoreDiscriminator) {
47
+ if (json == null) {
48
+ return json;
49
+ }
50
+ return {
51
+ 'ok': json['ok'],
52
+ 'type': json['type'],
53
+ 'name': json['name'],
54
+ 'share': (0, NamedSnapshotShare_1.NamedSnapshotShareFromJSON)(json['share']),
55
+ };
56
+ }
57
+ function NamedSnapshotShareRevokedResponseToJSON(json) {
58
+ return NamedSnapshotShareRevokedResponseToJSONTyped(json, false);
59
+ }
60
+ function NamedSnapshotShareRevokedResponseToJSONTyped(value, ignoreDiscriminator = false) {
61
+ if (value == null) {
62
+ return value;
63
+ }
64
+ return {
65
+ 'ok': value['ok'],
66
+ 'type': value['type'],
67
+ 'name': value['name'],
68
+ 'share': (0, NamedSnapshotShare_1.NamedSnapshotShareToJSON)(value['share']),
69
+ };
70
+ }
@@ -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';
@@ -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);
package/docs/BoatApi.md CHANGED
@@ -14,6 +14,7 @@ All URIs are relative to *https://boat.dev/api/v1*
14
14
  | [**create**](BoatApi.md#create) | **POST** /sandboxes | Create sandbox |
15
15
  | [**createEnvironment**](BoatApi.md#createenvironment) | **POST** /environments | Create a sandbox environment |
16
16
  | [**createScopedApiKey**](BoatApi.md#createscopedapikeyoperation) | **POST** /api-keys/scoped | Create a scoped API key |
17
+ | [**createSnapshotShare**](BoatApi.md#createsnapshotshare) | **POST** /named-snapshots/{name}/shares | Share a named snapshot |
17
18
  | [**createWebhook**](BoatApi.md#createwebhook) | **POST** /webhooks | Create webhook |
18
19
  | [**deleteEnvironment**](BoatApi.md#deleteenvironment) | **DELETE** /environments/{environmentId} | Delete a sandbox environment |
19
20
  | [**deleteEnvironmentRepo**](BoatApi.md#deleteenvironmentrepo) | **DELETE** /environments/{environmentId}/repos/{repositoryId} | Remove a repository from an environment |
@@ -44,6 +45,7 @@ All URIs are relative to *https://boat.dev/api/v1*
44
45
  | [**listNamedSnapshots**](BoatApi.md#listnamedsnapshots) | **GET** /named-snapshots | List named snapshots |
45
46
  | [**listOrganizations**](BoatApi.md#listorganizations) | **GET** /orgs | List organizations |
46
47
  | [**listSandboxSnapshots**](BoatApi.md#listsandboxsnapshots) | **GET** /sandboxes/{sandboxId}/snapshots | List boat snapshots |
48
+ | [**listSnapshotShares**](BoatApi.md#listsnapshotshares) | **GET** /named-snapshots/{name}/shares | List share codes of a named snapshot |
47
49
  | [**listSnapshots**](BoatApi.md#listsnapshots) | **GET** /snapshots | List snapshots |
48
50
  | [**listWebhooks**](BoatApi.md#listwebhooks) | **GET** /webhooks | List webhooks |
49
51
  | [**me**](BoatApi.md#me) | **GET** /me | Get current Boat user |
@@ -54,6 +56,7 @@ All URIs are relative to *https://boat.dev/api/v1*
54
56
  | [**repos**](BoatApi.md#repos) | **GET** /repos | List GitHub repositories available to Boat |
55
57
  | [**resume**](BoatApi.md#resumeoperation) | **POST** /sandboxes/{sandboxId}/resume | Resume sandbox |
56
58
  | [**revokeApiKey**](BoatApi.md#revokeapikey) | **DELETE** /api-keys/{apiKeyId} | Revoke an API key |
59
+ | [**revokeSnapshotShare**](BoatApi.md#revokesnapshotshare) | **DELETE** /named-snapshots/{name}/shares/{shareId} | Revoke a share code |
57
60
  | [**rotateApiKey**](BoatApi.md#rotateapikey) | **POST** /api-keys/{apiKeyId}/rotate | Rotate an API key |
58
61
  | [**rotateWebhookSigningSecret**](BoatApi.md#rotatewebhooksigningsecret) | **POST** /webhooks/{webhookId}/rotate | Rotate webhook signing secret |
59
62
  | [**sandboxes**](BoatApi.md#sandboxes) | **GET** /sandboxes | List sandboxes |
@@ -831,6 +834,79 @@ example().catch(console.error);
831
834
  [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
832
835
 
833
836
 
837
+ ## createSnapshotShare
838
+
839
+ > NamedSnapshotShareCreatedResponse createSnapshotShare(name)
840
+
841
+ Share a named snapshot
842
+
843
+ Make a secret code that lets any Boat account create a sandbox from this named snapshot (&#x60;boat snapshot share &lt;name&gt;&#x60; in the CLI). The response shows the code once; Boat stores only a hash. Re-saving the name changes what the code deploys. Removing the name removes its codes. Everything on the disk is shared, so do not keep secrets in files on it. Needs &#x60;snapshot.write&#x60;.
844
+
845
+ ### Example
846
+
847
+ ```ts
848
+ import {
849
+ Configuration,
850
+ BoatApi,
851
+ } from '@boatdev/sdk';
852
+ import type { CreateSnapshotShareRequest } from '@boatdev/sdk';
853
+
854
+ async function example() {
855
+ console.log("🚀 Testing @boatdev/sdk SDK...");
856
+ const config = new Configuration({
857
+ // Configure HTTP bearer authorization: BoatBearerAuth
858
+ accessToken: "YOUR BEARER TOKEN",
859
+ });
860
+ const api = new BoatApi(config);
861
+
862
+ const body = {
863
+ // string
864
+ name: name_example,
865
+ } satisfies CreateSnapshotShareRequest;
866
+
867
+ try {
868
+ const data = await api.createSnapshotShare(body);
869
+ console.log(data);
870
+ } catch (error) {
871
+ console.error(error);
872
+ }
873
+ }
874
+
875
+ // Run the test
876
+ example().catch(console.error);
877
+ ```
878
+
879
+ ### Parameters
880
+
881
+
882
+ | Name | Type | Description | Notes |
883
+ |------------- | ------------- | ------------- | -------------|
884
+ | **name** | `string` | | [Defaults to `undefined`] |
885
+
886
+ ### Return type
887
+
888
+ [**NamedSnapshotShareCreatedResponse**](NamedSnapshotShareCreatedResponse.md)
889
+
890
+ ### Authorization
891
+
892
+ [BoatBearerAuth](../README.md#BoatBearerAuth)
893
+
894
+ ### HTTP request headers
895
+
896
+ - **Content-Type**: Not defined
897
+ - **Accept**: `application/json`
898
+
899
+
900
+ ### HTTP response details
901
+ | Status code | Description | Response headers |
902
+ |-------------|-------------|------------------|
903
+ | **201** | Code created. Store &#x60;shareCode&#x60; now; Boat does not show it again. | - |
904
+ | **401** | Missing or invalid bearer token. | - |
905
+ | **404** | Resource not found. | - |
906
+
907
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
908
+
909
+
834
910
  ## createWebhook
835
911
 
836
912
  > WebhookSecretResponse createWebhook(webhookCreateRequest)
@@ -3080,6 +3156,79 @@ example().catch(console.error);
3080
3156
  [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
3081
3157
 
3082
3158
 
3159
+ ## listSnapshotShares
3160
+
3161
+ > NamedSnapshotShareListResponse listSnapshotShares(name)
3162
+
3163
+ List share codes of a named snapshot
3164
+
3165
+ List the share codes of a named snapshot, active and revoked (&#x60;boat snapshot shares &lt;name&gt;&#x60; in the CLI). The full codes are not returned. Needs &#x60;snapshot.read&#x60;.
3166
+
3167
+ ### Example
3168
+
3169
+ ```ts
3170
+ import {
3171
+ Configuration,
3172
+ BoatApi,
3173
+ } from '@boatdev/sdk';
3174
+ import type { ListSnapshotSharesRequest } from '@boatdev/sdk';
3175
+
3176
+ async function example() {
3177
+ console.log("🚀 Testing @boatdev/sdk SDK...");
3178
+ const config = new Configuration({
3179
+ // Configure HTTP bearer authorization: BoatBearerAuth
3180
+ accessToken: "YOUR BEARER TOKEN",
3181
+ });
3182
+ const api = new BoatApi(config);
3183
+
3184
+ const body = {
3185
+ // string
3186
+ name: name_example,
3187
+ } satisfies ListSnapshotSharesRequest;
3188
+
3189
+ try {
3190
+ const data = await api.listSnapshotShares(body);
3191
+ console.log(data);
3192
+ } catch (error) {
3193
+ console.error(error);
3194
+ }
3195
+ }
3196
+
3197
+ // Run the test
3198
+ example().catch(console.error);
3199
+ ```
3200
+
3201
+ ### Parameters
3202
+
3203
+
3204
+ | Name | Type | Description | Notes |
3205
+ |------------- | ------------- | ------------- | -------------|
3206
+ | **name** | `string` | | [Defaults to `undefined`] |
3207
+
3208
+ ### Return type
3209
+
3210
+ [**NamedSnapshotShareListResponse**](NamedSnapshotShareListResponse.md)
3211
+
3212
+ ### Authorization
3213
+
3214
+ [BoatBearerAuth](../README.md#BoatBearerAuth)
3215
+
3216
+ ### HTTP request headers
3217
+
3218
+ - **Content-Type**: Not defined
3219
+ - **Accept**: `application/json`
3220
+
3221
+
3222
+ ### HTTP response details
3223
+ | Status code | Description | Response headers |
3224
+ |-------------|-------------|------------------|
3225
+ | **200** | The snapshot\&#39;s share codes. | - |
3226
+ | **401** | Missing or invalid bearer token. | - |
3227
+ | **404** | Resource not found. | - |
3228
+
3229
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
3230
+
3231
+
3083
3232
  ## listSnapshots
3084
3233
 
3085
3234
  > SnapshotListResponse listSnapshots(limit, cursor, sort)
@@ -3834,6 +3983,82 @@ example().catch(console.error);
3834
3983
  [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
3835
3984
 
3836
3985
 
3986
+ ## revokeSnapshotShare
3987
+
3988
+ > NamedSnapshotShareRevokedResponse revokeSnapshotShare(name, shareId)
3989
+
3990
+ Revoke a share code
3991
+
3992
+ Revoke a share code (&#x60;boat snapshot unshare &lt;name&gt; &lt;share-id&gt;&#x60; in the CLI). The code stops creating new sandboxes. Sandboxes already created from it keep their own copy. Needs &#x60;snapshot.write&#x60;.
3993
+
3994
+ ### Example
3995
+
3996
+ ```ts
3997
+ import {
3998
+ Configuration,
3999
+ BoatApi,
4000
+ } from '@boatdev/sdk';
4001
+ import type { RevokeSnapshotShareRequest } from '@boatdev/sdk';
4002
+
4003
+ async function example() {
4004
+ console.log("🚀 Testing @boatdev/sdk SDK...");
4005
+ const config = new Configuration({
4006
+ // Configure HTTP bearer authorization: BoatBearerAuth
4007
+ accessToken: "YOUR BEARER TOKEN",
4008
+ });
4009
+ const api = new BoatApi(config);
4010
+
4011
+ const body = {
4012
+ // string
4013
+ name: name_example,
4014
+ // string | Share id, for example `shr_...`.
4015
+ shareId: shareId_example,
4016
+ } satisfies RevokeSnapshotShareRequest;
4017
+
4018
+ try {
4019
+ const data = await api.revokeSnapshotShare(body);
4020
+ console.log(data);
4021
+ } catch (error) {
4022
+ console.error(error);
4023
+ }
4024
+ }
4025
+
4026
+ // Run the test
4027
+ example().catch(console.error);
4028
+ ```
4029
+
4030
+ ### Parameters
4031
+
4032
+
4033
+ | Name | Type | Description | Notes |
4034
+ |------------- | ------------- | ------------- | -------------|
4035
+ | **name** | `string` | | [Defaults to `undefined`] |
4036
+ | **shareId** | `string` | Share id, for example &#x60;shr_...&#x60;. | [Defaults to `undefined`] |
4037
+
4038
+ ### Return type
4039
+
4040
+ [**NamedSnapshotShareRevokedResponse**](NamedSnapshotShareRevokedResponse.md)
4041
+
4042
+ ### Authorization
4043
+
4044
+ [BoatBearerAuth](../README.md#BoatBearerAuth)
4045
+
4046
+ ### HTTP request headers
4047
+
4048
+ - **Content-Type**: Not defined
4049
+ - **Accept**: `application/json`
4050
+
4051
+
4052
+ ### HTTP response details
4053
+ | Status code | Description | Response headers |
4054
+ |-------------|-------------|------------------|
4055
+ | **200** | Revoked. | - |
4056
+ | **401** | Missing or invalid bearer token. | - |
4057
+ | **404** | Resource not found. | - |
4058
+
4059
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
4060
+
4061
+
3837
4062
  ## rotateApiKey
3838
4063
 
3839
4064
  > ApiKeySecretResponse rotateApiKey(apiKeyId)