@boatdev/sdk 1.0.1 → 1.1.0

package/dist/models/DeletionOperationListResponse.d.ts

@@ -0,0 +1,52 @@
+/**
+ * Boat Public API v1
+ * 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.
+ *
+ * The version of the OpenAPI document: 1.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import type { DeletionOperation } from './DeletionOperation';
+/**
+ *
+ * @export
+ * @interface DeletionOperationListResponse
+ */
+export interface DeletionOperationListResponse {
+    /**
+     *
+     * @type {boolean}
+     * @memberof DeletionOperationListResponse
+     */
+    ok: boolean;
+    /**
+     *
+     * @type {DeletionOperationListResponseTypeEnum}
+     * @memberof DeletionOperationListResponse
+     */
+    type: DeletionOperationListResponseTypeEnum;
+    /**
+     *
+     * @type {Array<DeletionOperation>}
+     * @memberof DeletionOperationListResponse
+     */
+    operations: Array<DeletionOperation>;
+}
+/**
+ * @export
+ */
+export declare const DeletionOperationListResponseTypeEnum: {
+    readonly SnapshotDeleting: 'snapshot.deleting';
+};
+export type DeletionOperationListResponseTypeEnum = typeof DeletionOperationListResponseTypeEnum[keyof typeof DeletionOperationListResponseTypeEnum];
+/**
+ * Check if a given object implements the DeletionOperationListResponse interface.
+ */
+export declare function instanceOfDeletionOperationListResponse(value: object): value is DeletionOperationListResponse;
+export declare function DeletionOperationListResponseFromJSON(json: any): DeletionOperationListResponse;
+export declare function DeletionOperationListResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): DeletionOperationListResponse;
+export declare function DeletionOperationListResponseToJSON(json: any): DeletionOperationListResponse;
+export declare function DeletionOperationListResponseToJSONTyped(value?: DeletionOperationListResponse | null, ignoreDiscriminator?: boolean): any;

package/dist/models/DeletionOperationListResponse.js

@@ -0,0 +1,66 @@
+"use strict";
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Boat Public API v1
+ * 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.
+ *
+ * The version of the OpenAPI document: 1.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DeletionOperationListResponseTypeEnum = void 0;
+exports.instanceOfDeletionOperationListResponse = instanceOfDeletionOperationListResponse;
+exports.DeletionOperationListResponseFromJSON = DeletionOperationListResponseFromJSON;
+exports.DeletionOperationListResponseFromJSONTyped = DeletionOperationListResponseFromJSONTyped;
+exports.DeletionOperationListResponseToJSON = DeletionOperationListResponseToJSON;
+exports.DeletionOperationListResponseToJSONTyped = DeletionOperationListResponseToJSONTyped;
+const DeletionOperation_1 = require("./DeletionOperation");
+/**
+ * @export
+ */
+exports.DeletionOperationListResponseTypeEnum = {
+    SnapshotDeleting: 'snapshot.deleting'
+};
+/**
+ * Check if a given object implements the DeletionOperationListResponse interface.
+ */
+function instanceOfDeletionOperationListResponse(value) {
+    if (!('ok' in value) || value['ok'] === undefined)
+        return false;
+    if (!('type' in value) || value['type'] === undefined)
+        return false;
+    if (!('operations' in value) || value['operations'] === undefined)
+        return false;
+    return true;
+}
+function DeletionOperationListResponseFromJSON(json) {
+    return DeletionOperationListResponseFromJSONTyped(json, false);
+}
+function DeletionOperationListResponseFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'ok': json['ok'],
+        'type': json['type'],
+        'operations': (json['operations'].map(DeletionOperation_1.DeletionOperationFromJSON)),
+    };
+}
+function DeletionOperationListResponseToJSON(json) {
+    return DeletionOperationListResponseToJSONTyped(json, false);
+}
+function DeletionOperationListResponseToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'ok': value['ok'],
+        'type': value['type'],
+        'operations': (value['operations'].map(DeletionOperation_1.DeletionOperationToJSON)),
+    };
+}

package/dist/models/index.d.ts

@@ -31,6 +31,7 @@ export * from './CreateScopedApiKeyRequest';
 export * from './DataRetentionPolicyResponse';
 export * from './DataRetentionUpdateRequest';
 export * from './DeletionOperation';
+export * from './DeletionOperationListResponse';
 export * from './DeletionOperationResponse';
 export * from './DesktopRequest';
 export * from './DesktopResponse';

package/dist/models/index.js

@@ -49,6 +49,7 @@ __exportStar(require("./CreateScopedApiKeyRequest"), exports);
 __exportStar(require("./DataRetentionPolicyResponse"), exports);
 __exportStar(require("./DataRetentionUpdateRequest"), exports);
 __exportStar(require("./DeletionOperation"), exports);
+__exportStar(require("./DeletionOperationListResponse"), exports);
 __exportStar(require("./DeletionOperationResponse"), exports);
 __exportStar(require("./DesktopRequest"), exports);
 __exportStar(require("./DesktopResponse"), exports);

package/dist/runtime.d.ts

@@ -182,3 +182,11 @@ export declare class TextApiResponse {
     constructor(raw: Response);
     value(): Promise<string>;
 }
+/**
+ * A body-taking call's parameters with the body's fields inline, next to the
+ * path/query/header parameters: `fork({ sandboxId, type: 'small' })` is
+ * `fork({ sandboxId, forkRequest: { type: 'small' } })`. Both shapes are accepted.
+ */
+export type FlatBody<R, K extends keyof R> = Omit<R, K> & NonNullable<R[K]>;
+/** Turns either call shape into the wrapped one the generated code sends. */
+export declare function unflattenBody<R>(input: object, bodyKey: string, paramKeys: string[], sharedKeys: string[]): R;

package/dist/runtime.js

@@ -18,6 +18,7 @@ exports.querystring = querystring;
 exports.exists = exists;
 exports.mapValues = mapValues;
 exports.canConsumeForm = canConsumeForm;
+exports.unflattenBody = unflattenBody;
 exports.BASE_PATH = "https://boat.dev/api/v1".replace(/\/+$/, "");
 class Configuration {
     constructor(configuration = {}) {
@@ -351,3 +352,21 @@ class TextApiResponse {
     ;
 }
 exports.TextApiResponse = TextApiResponse;
+/** Turns either call shape into the wrapped one the generated code sends. */
+function unflattenBody(input, bodyKey, paramKeys, sharedKeys) {
+    if (input == null || bodyKey in input)
+        return input;
+    const params = {};
+    const body = {};
+    for (const [k, v] of Object.entries(input)) {
+        const isParam = paramKeys.indexOf(k) !== -1;
+        if (isParam)
+            params[k] = v;
+        if (!isParam || sharedKeys.indexOf(k) !== -1)
+            body[k] = v;
+    }
+    // No body field given: send no body, exactly like the wrapped call with the key omitted.
+    if (Object.keys(body).length > 0)
+        params[bodyKey] = body;
+    return params;
+}

package/docs/BoatApi.md

@@ -21,6 +21,7 @@ All URIs are relative to *https://boat.dev/api/v1*
 | [**deleteEnvironmentVar**](BoatApi.md#deleteenvironmentvar) | **DELETE** /environments/{environmentId}/vars/{key} | Remove one environment variable |
 | [**deleteNamedSnapshot**](BoatApi.md#deletenamedsnapshot) | **DELETE** /named-snapshots/{name} | Remove a named snapshot |
 | [**deleteSandbox**](BoatApi.md#deletesandbox) | **DELETE** /sandboxes/{sandboxId} | Permanently delete sandbox data |
+| [**deleteSandboxSnapshots**](BoatApi.md#deletesandboxsnapshots) | **DELETE** /sandboxes/{sandboxId}/snapshots | Permanently delete all snapshots of a sandbox |
 | [**deleteSnapshot**](BoatApi.md#deletesnapshot) | **DELETE** /snapshots/{snapshotId} | Permanently delete snapshot data |
 | [**deleteWebhook**](BoatApi.md#deletewebhook) | **DELETE** /webhooks/{webhookId} | Delete webhook |
 | [**desktop**](BoatApi.md#desktopoperation) | **POST** /sandboxes/{sandboxId}/desktop | Get desktop streaming URL |
@@ -1352,13 +1353,91 @@ example().catch(console.error);
 [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
 
 
+## deleteSandboxSnapshots
+
+> DeletionOperationListResponse deleteSandboxSnapshots(sandboxId, xAsciiConfirmDelete)
+
+Permanently delete all snapshots of a sandbox
+
+Accept irreversible deletion of every unpinned snapshot of this sandbox. The sandbox itself and its named snapshots stay. Snapshots disappear from lists, restores and forks immediately; their stored data is purged in the background. Set `X-Ascii-Confirm-Delete` to the sandbox id.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  BoatApi,
+} from '@boatdev/sdk';
+import type { DeleteSandboxSnapshotsRequest } from '@boatdev/sdk';
+
+async function example() {
+  console.log("🚀 Testing @boatdev/sdk SDK...");
+  const config = new Configuration({ 
+    // Configure HTTP bearer authorization: BoatBearerAuth
+    accessToken: "YOUR BEARER TOKEN",
+  });
+  const api = new BoatApi(config);
+
+  const body = {
+    // string | Public Sandbox id returned by create/list/get sandbox calls.
+    sandboxId: sandboxId_example,
+    // string | Must exactly equal the target `sandboxId` or `snapshotId`. A missing or mismatched value returns `409` without accepting deletion.
+    xAsciiConfirmDelete: xAsciiConfirmDelete_example,
+  } satisfies DeleteSandboxSnapshotsRequest;
+
+  try {
+    const data = await api.deleteSandboxSnapshots(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **sandboxId** | `string` | Public Sandbox id returned by create/list/get sandbox calls. | [Defaults to `undefined`] |
+| **xAsciiConfirmDelete** | `string` | Must exactly equal the target `sandboxId` or `snapshotId`. A missing or mismatched value returns `409` without accepting deletion. | [Defaults to `undefined`] |
+
+### Return type
+
+[**DeletionOperationListResponse**](DeletionOperationListResponse.md)
+
+### Authorization
+
+[BoatBearerAuth](../README.md#BoatBearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **202** | One accepted deletion operation per snapshot. |  -  |
+| **401** | Missing or invalid bearer token. |  -  |
+| **403** | Authenticated token is not allowed to perform this action. |  -  |
+| **404** | Resource not found. |  -  |
+| **409** | Request conflicts with current account or sandbox state. |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
 ## deleteSnapshot
 
 > DeletionOperationResponse deleteSnapshot(snapshotId, xAsciiConfirmDelete)
 
 Permanently delete snapshot data
 
-Accept irreversible background deletion of an unpinned snapshot owned by the authenticated account. Snapshots required by another incremental snapshot or active restore return `409`. Poll the returned operation until `completed`.
+Accept irreversible deletion of an unpinned snapshot owned by the authenticated account. Any such snapshot is accepted: it disappears from lists, restores and forks immediately, and its stored data is purged in the background once nothing still reads it (see the operation\'s `stage`). `409` only means `X-Ascii-Confirm-Delete` is missing or wrong.
 
 ### Example
 

package/docs/DeletionOperation.md

@@ -11,6 +11,8 @@ Name | Type
 `targetId` | string
 `reason` | string
 `status` | string
+`stage` | string
+`expectedBy` | Date
 `attemptCount` | number
 `requestedAt` | Date
 `completedAt` | Date
@@ -27,6 +29,8 @@ const example = {
   "targetId": null,
   "reason": null,
   "status": null,
+  "stage": null,
+  "expectedBy": null,
   "attemptCount": null,
   "requestedAt": null,
   "completedAt": null,

package/docs/DeletionOperationListResponse.md

@@ -0,0 +1,36 @@
+
+# DeletionOperationListResponse
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`ok` | boolean
+`type` | string
+`operations` | [Array<DeletionOperation>](DeletionOperation.md)
+
+## Example
+
+```typescript
+import type { DeletionOperationListResponse } from '@boatdev/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "ok": null,
+  "type": null,
+  "operations": null,
+} satisfies DeletionOperationListResponse
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as DeletionOperationListResponse
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@boatdev/sdk",
-  "version": "1.0.1",
+  "version": "1.1.0",
   "description": "OpenAPI client for @boatdev/sdk",
   "author": "OpenAPI-Generator",
   "license": "MIT",