@boatdev/sdk 1.9.4 → 1.9.5

package/.openapi-generator/FILES

@@ -53,6 +53,8 @@ docs/ErrorEnvelopeError.md
 docs/ErrorEvent.md
 docs/EventsResponse.md
 docs/FileReadResponse.md
+docs/FileUrlRequest.md
+docs/FileUrlResponse.md
 docs/FileWriteRequest.md
 docs/FileWriteResponse.md
 docs/ForkRequest.md
@@ -215,6 +217,8 @@ src/models/ErrorEnvelopeError.ts
 src/models/ErrorEvent.ts
 src/models/EventsResponse.ts
 src/models/FileReadResponse.ts
+src/models/FileUrlRequest.ts
+src/models/FileUrlResponse.ts
 src/models/FileWriteRequest.ts
 src/models/FileWriteResponse.ts
 src/models/ForkRequest.ts

package/dist/apis/BoatApi.d.ts

@@ -39,6 +39,8 @@ import { type DesktopResponse } from '../models/DesktopResponse';
 import { type EnvironmentItemChangeResponse } from '../models/EnvironmentItemChangeResponse';
 import { type EventsResponse } from '../models/EventsResponse';
 import { type FileReadResponse } from '../models/FileReadResponse';
+import { type FileUrlRequest } from '../models/FileUrlRequest';
+import { type FileUrlResponse } from '../models/FileUrlResponse';
 import { type FileWriteRequest } from '../models/FileWriteRequest';
 import { type FileWriteResponse } from '../models/FileWriteResponse';
 import { type ForkRequest } from '../models/ForkRequest';
@@ -150,6 +152,10 @@ export interface CreateRequest {
     xBoatOrg?: string;
     createSandboxRequest?: CreateSandboxRequest;
 }
+export interface CreateDownloadUrlRequest {
+    sandboxId: string;
+    fileUrlRequest: FileUrlRequest;
+}
 export interface CreateEnvironmentRequest {
     createSandboxEnvironmentRequest: CreateSandboxEnvironmentRequest;
 }
@@ -159,6 +165,10 @@ export interface CreateScopedApiKeyOperationRequest {
 export interface CreateSnapshotShareRequest {
     name: string;
 }
+export interface CreateUploadUrlRequest {
+    sandboxId: string;
+    fileUrlRequest: FileUrlRequest;
+}
 export interface CreateWebhookRequest {
     webhookCreateRequest: WebhookCreateRequest;
 }
@@ -556,6 +566,20 @@ export declare class BoatApi extends runtime.BaseAPI {
      * Create sandbox
      */
     create(requestParameters?: CreateRequest | runtime.FlatBody<CreateRequest, 'createSandboxRequest'>, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CreateSandboxResponse>;
+    /**
+     * Creates request options for createDownloadUrl without sending the request
+     */
+    createDownloadUrlRequestOpts(input: CreateDownloadUrlRequest | runtime.FlatBody<CreateDownloadUrlRequest, 'fileUrlRequest'>): Promise<runtime.RequestOpts>;
+    /**
+     * Returns a short-lived URL that the sandbox serves itself. GET it to download the file as raw bytes, with no size limit and no Authorization header. The URL is bound to this path and expires after `ttlSeconds` (default 15 minutes, at most 1 hour). Needs `file.read`. Treat the URL as a secret until it expires.
+     * Get a download URL for a sandbox file
+     */
+    createDownloadUrlRaw(requestParameters: CreateDownloadUrlRequest | runtime.FlatBody<CreateDownloadUrlRequest, 'fileUrlRequest'>, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<FileUrlResponse>>;
+    /**
+     * Returns a short-lived URL that the sandbox serves itself. GET it to download the file as raw bytes, with no size limit and no Authorization header. The URL is bound to this path and expires after `ttlSeconds` (default 15 minutes, at most 1 hour). Needs `file.read`. Treat the URL as a secret until it expires.
+     * Get a download URL for a sandbox file
+     */
+    createDownloadUrl(requestParameters: CreateDownloadUrlRequest | runtime.FlatBody<CreateDownloadUrlRequest, 'fileUrlRequest'>, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<FileUrlResponse>;
     /**
      * Creates request options for createEnvironment without sending the request
      */
@@ -598,6 +622,20 @@ export declare class BoatApi extends runtime.BaseAPI {
      * Share a named snapshot
      */
     createSnapshotShare(requestParameters: CreateSnapshotShareRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<NamedSnapshotShareCreatedResponse>;
+    /**
+     * Creates request options for createUploadUrl without sending the request
+     */
+    createUploadUrlRequestOpts(input: CreateUploadUrlRequest | runtime.FlatBody<CreateUploadUrlRequest, 'fileUrlRequest'>): Promise<runtime.RequestOpts>;
+    /**
+     * Returns a short-lived URL that the sandbox serves itself. PUT the file as the raw request body to write it, with no size limit and no Authorization header. Missing directories are created; an existing file is replaced only once the upload completes. The URL is bound to this path and expires after `ttlSeconds` (default 15 minutes, at most 1 hour). Needs `file.write`. Treat the URL as a secret until it expires.
+     * Get an upload URL for a sandbox file
+     */
+    createUploadUrlRaw(requestParameters: CreateUploadUrlRequest | runtime.FlatBody<CreateUploadUrlRequest, 'fileUrlRequest'>, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<FileUrlResponse>>;
+    /**
+     * Returns a short-lived URL that the sandbox serves itself. PUT the file as the raw request body to write it, with no size limit and no Authorization header. Missing directories are created; an existing file is replaced only once the upload completes. The URL is bound to this path and expires after `ttlSeconds` (default 15 minutes, at most 1 hour). Needs `file.write`. Treat the URL as a secret until it expires.
+     * Get an upload URL for a sandbox file
+     */
+    createUploadUrl(requestParameters: CreateUploadUrlRequest | runtime.FlatBody<CreateUploadUrlRequest, 'fileUrlRequest'>, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<FileUrlResponse>;
     /**
      * Creates request options for createWebhook without sending the request
      */
@@ -1159,12 +1197,12 @@ export declare class BoatApi extends runtime.BaseAPI {
      */
     readFileRequestOpts(requestParameters: ReadFileRequest): Promise<runtime.RequestOpts>;
     /**
-     * Files up to 5 MiB. Use `GET /sandboxes/{sandboxId}/artifacts` for files up to 50 MiB, and SCP over SSH for larger ones.
+     * Files up to 5 MiB. For a larger file, use `POST /sandboxes/{sandboxId}/files/download-url`.
      * Read a file from a sandbox
      */
     readFileRaw(requestParameters: ReadFileRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<FileReadResponse>>;
     /**
-     * Files up to 5 MiB. Use `GET /sandboxes/{sandboxId}/artifacts` for files up to 50 MiB, and SCP over SSH for larger ones.
+     * Files up to 5 MiB. For a larger file, use `POST /sandboxes/{sandboxId}/files/download-url`.
      * Read a file from a sandbox
      */
     readFile(requestParameters: ReadFileRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<FileReadResponse>;
@@ -1545,12 +1583,12 @@ export declare class BoatApi extends runtime.BaseAPI {
      */
     writeFileRequestOpts(input: WriteFileRequest | runtime.FlatBody<WriteFileRequest, 'fileWriteRequest'>): Promise<runtime.RequestOpts>;
     /**
-     * Files up to 5 MiB after decoding. Use SCP over SSH for larger files.
+     * Files up to 5 MiB after decoding. For a larger file, use `POST /sandboxes/{sandboxId}/files/upload-url`.
      * Write a file in a sandbox
      */
     writeFileRaw(requestParameters: WriteFileRequest | runtime.FlatBody<WriteFileRequest, 'fileWriteRequest'>, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<FileWriteResponse>>;
     /**
-     * Files up to 5 MiB after decoding. Use SCP over SSH for larger files.
+     * Files up to 5 MiB after decoding. For a larger file, use `POST /sandboxes/{sandboxId}/files/upload-url`.
      * Write a file in a sandbox
      */
     writeFile(requestParameters: WriteFileRequest | runtime.FlatBody<WriteFileRequest, 'fileWriteRequest'>, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<FileWriteResponse>;

package/dist/apis/BoatApi.js

@@ -77,6 +77,8 @@ const DesktopResponse_1 = require("../models/DesktopResponse");
 const EnvironmentItemChangeResponse_1 = require("../models/EnvironmentItemChangeResponse");
 const EventsResponse_1 = require("../models/EventsResponse");
 const FileReadResponse_1 = require("../models/FileReadResponse");
+const FileUrlRequest_1 = require("../models/FileUrlRequest");
+const FileUrlResponse_1 = require("../models/FileUrlResponse");
 const FileWriteRequest_1 = require("../models/FileWriteRequest");
 const FileWriteResponse_1 = require("../models/FileWriteResponse");
 const ForkRequest_1 = require("../models/ForkRequest");
@@ -675,6 +677,54 @@ class BoatApi extends runtime.BaseAPI {
         const response = await this.createRaw(requestParameters, initOverrides);
         return await response.value();
     }
+    /**
+     * Creates request options for createDownloadUrl without sending the request
+     */
+    async createDownloadUrlRequestOpts(input) {
+        const requestParameters = runtime.unflattenBody(input, 'fileUrlRequest', ['sandboxId'], []);
+        if (requestParameters['sandboxId'] == null) {
+            throw new runtime.RequiredError('sandboxId', 'Required parameter "sandboxId" was null or undefined when calling createDownloadUrl().');
+        }
+        if (requestParameters['fileUrlRequest'] == null) {
+            throw new runtime.RequiredError('fileUrlRequest', 'Required parameter "fileUrlRequest" was null or undefined when calling createDownloadUrl().');
+        }
+        const queryParameters = {};
+        const headerParameters = {};
+        headerParameters['Content-Type'] = 'application/json';
+        if (this.configuration && this.configuration.accessToken) {
+            const token = this.configuration.accessToken;
+            const tokenString = await token("BoatBearerAuth", []);
+            if (tokenString) {
+                headerParameters["Authorization"] = `Bearer ${tokenString}`;
+            }
+        }
+        let urlPath = `/sandboxes/{sandboxId}/files/download-url`;
+        urlPath = urlPath.replace('{sandboxId}', encodeURIComponent(String(requestParameters['sandboxId'])));
+        return {
+            path: urlPath,
+            method: 'POST',
+            headers: headerParameters,
+            query: queryParameters,
+            body: (0, FileUrlRequest_1.FileUrlRequestToJSON)(requestParameters['fileUrlRequest']),
+        };
+    }
+    /**
+     * Returns a short-lived URL that the sandbox serves itself. GET it to download the file as raw bytes, with no size limit and no Authorization header. The URL is bound to this path and expires after `ttlSeconds` (default 15 minutes, at most 1 hour). Needs `file.read`. Treat the URL as a secret until it expires.
+     * Get a download URL for a sandbox file
+     */
+    async createDownloadUrlRaw(requestParameters, initOverrides) {
+        const requestOptions = await this.createDownloadUrlRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+        return new runtime.JSONApiResponse(response, (jsonValue) => (0, FileUrlResponse_1.FileUrlResponseFromJSON)(jsonValue));
+    }
+    /**
+     * Returns a short-lived URL that the sandbox serves itself. GET it to download the file as raw bytes, with no size limit and no Authorization header. The URL is bound to this path and expires after `ttlSeconds` (default 15 minutes, at most 1 hour). Needs `file.read`. Treat the URL as a secret until it expires.
+     * Get a download URL for a sandbox file
+     */
+    async createDownloadUrl(requestParameters, initOverrides) {
+        const response = await this.createDownloadUrlRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
     /**
      * Creates request options for createEnvironment without sending the request
      */
@@ -805,6 +855,54 @@ class BoatApi extends runtime.BaseAPI {
         const response = await this.createSnapshotShareRaw(requestParameters, initOverrides);
         return await response.value();
     }
+    /**
+     * Creates request options for createUploadUrl without sending the request
+     */
+    async createUploadUrlRequestOpts(input) {
+        const requestParameters = runtime.unflattenBody(input, 'fileUrlRequest', ['sandboxId'], []);
+        if (requestParameters['sandboxId'] == null) {
+            throw new runtime.RequiredError('sandboxId', 'Required parameter "sandboxId" was null or undefined when calling createUploadUrl().');
+        }
+        if (requestParameters['fileUrlRequest'] == null) {
+            throw new runtime.RequiredError('fileUrlRequest', 'Required parameter "fileUrlRequest" was null or undefined when calling createUploadUrl().');
+        }
+        const queryParameters = {};
+        const headerParameters = {};
+        headerParameters['Content-Type'] = 'application/json';
+        if (this.configuration && this.configuration.accessToken) {
+            const token = this.configuration.accessToken;
+            const tokenString = await token("BoatBearerAuth", []);
+            if (tokenString) {
+                headerParameters["Authorization"] = `Bearer ${tokenString}`;
+            }
+        }
+        let urlPath = `/sandboxes/{sandboxId}/files/upload-url`;
+        urlPath = urlPath.replace('{sandboxId}', encodeURIComponent(String(requestParameters['sandboxId'])));
+        return {
+            path: urlPath,
+            method: 'POST',
+            headers: headerParameters,
+            query: queryParameters,
+            body: (0, FileUrlRequest_1.FileUrlRequestToJSON)(requestParameters['fileUrlRequest']),
+        };
+    }
+    /**
+     * Returns a short-lived URL that the sandbox serves itself. PUT the file as the raw request body to write it, with no size limit and no Authorization header. Missing directories are created; an existing file is replaced only once the upload completes. The URL is bound to this path and expires after `ttlSeconds` (default 15 minutes, at most 1 hour). Needs `file.write`. Treat the URL as a secret until it expires.
+     * Get an upload URL for a sandbox file
+     */
+    async createUploadUrlRaw(requestParameters, initOverrides) {
+        const requestOptions = await this.createUploadUrlRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+        return new runtime.JSONApiResponse(response, (jsonValue) => (0, FileUrlResponse_1.FileUrlResponseFromJSON)(jsonValue));
+    }
+    /**
+     * Returns a short-lived URL that the sandbox serves itself. PUT the file as the raw request body to write it, with no size limit and no Authorization header. Missing directories are created; an existing file is replaced only once the upload completes. The URL is bound to this path and expires after `ttlSeconds` (default 15 minutes, at most 1 hour). Needs `file.write`. Treat the URL as a secret until it expires.
+     * Get an upload URL for a sandbox file
+     */
+    async createUploadUrl(requestParameters, initOverrides) {
+        const response = await this.createUploadUrlRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
     /**
      * Creates request options for createWebhook without sending the request
      */
@@ -2597,7 +2695,7 @@ class BoatApi extends runtime.BaseAPI {
         };
     }
     /**
-     * Files up to 5 MiB. Use `GET /sandboxes/{sandboxId}/artifacts` for files up to 50 MiB, and SCP over SSH for larger ones.
+     * Files up to 5 MiB. For a larger file, use `POST /sandboxes/{sandboxId}/files/download-url`.
      * Read a file from a sandbox
      */
     async readFileRaw(requestParameters, initOverrides) {
@@ -2606,7 +2704,7 @@ class BoatApi extends runtime.BaseAPI {
         return new runtime.JSONApiResponse(response, (jsonValue) => (0, FileReadResponse_1.FileReadResponseFromJSON)(jsonValue));
     }
     /**
-     * Files up to 5 MiB. Use `GET /sandboxes/{sandboxId}/artifacts` for files up to 50 MiB, and SCP over SSH for larger ones.
+     * Files up to 5 MiB. For a larger file, use `POST /sandboxes/{sandboxId}/files/download-url`.
      * Read a file from a sandbox
      */
     async readFile(requestParameters, initOverrides) {
@@ -3881,7 +3979,7 @@ class BoatApi extends runtime.BaseAPI {
         };
     }
     /**
-     * Files up to 5 MiB after decoding. Use SCP over SSH for larger files.
+     * Files up to 5 MiB after decoding. For a larger file, use `POST /sandboxes/{sandboxId}/files/upload-url`.
      * Write a file in a sandbox
      */
     async writeFileRaw(requestParameters, initOverrides) {
@@ -3890,7 +3988,7 @@ class BoatApi extends runtime.BaseAPI {
         return new runtime.JSONApiResponse(response, (jsonValue) => (0, FileWriteResponse_1.FileWriteResponseFromJSON)(jsonValue));
     }
     /**
-     * Files up to 5 MiB after decoding. Use SCP over SSH for larger files.
+     * Files up to 5 MiB after decoding. For a larger file, use `POST /sandboxes/{sandboxId}/files/upload-url`.
      * Write a file in a sandbox
      */
     async writeFile(requestParameters, initOverrides) {

package/dist/esm/apis/BoatApi.d.ts

@@ -39,6 +39,8 @@ import { type DesktopResponse } from '../models/DesktopResponse';
 import { type EnvironmentItemChangeResponse } from '../models/EnvironmentItemChangeResponse';
 import { type EventsResponse } from '../models/EventsResponse';
 import { type FileReadResponse } from '../models/FileReadResponse';
+import { type FileUrlRequest } from '../models/FileUrlRequest';
+import { type FileUrlResponse } from '../models/FileUrlResponse';
 import { type FileWriteRequest } from '../models/FileWriteRequest';
 import { type FileWriteResponse } from '../models/FileWriteResponse';
 import { type ForkRequest } from '../models/ForkRequest';
@@ -150,6 +152,10 @@ export interface CreateRequest {
     xBoatOrg?: string;
     createSandboxRequest?: CreateSandboxRequest;
 }
+export interface CreateDownloadUrlRequest {
+    sandboxId: string;
+    fileUrlRequest: FileUrlRequest;
+}
 export interface CreateEnvironmentRequest {
     createSandboxEnvironmentRequest: CreateSandboxEnvironmentRequest;
 }
@@ -159,6 +165,10 @@ export interface CreateScopedApiKeyOperationRequest {
 export interface CreateSnapshotShareRequest {
     name: string;
 }
+export interface CreateUploadUrlRequest {
+    sandboxId: string;
+    fileUrlRequest: FileUrlRequest;
+}
 export interface CreateWebhookRequest {
     webhookCreateRequest: WebhookCreateRequest;
 }
@@ -556,6 +566,20 @@ export declare class BoatApi extends runtime.BaseAPI {
      * Create sandbox
      */
     create(requestParameters?: CreateRequest | runtime.FlatBody<CreateRequest, 'createSandboxRequest'>, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CreateSandboxResponse>;
+    /**
+     * Creates request options for createDownloadUrl without sending the request
+     */
+    createDownloadUrlRequestOpts(input: CreateDownloadUrlRequest | runtime.FlatBody<CreateDownloadUrlRequest, 'fileUrlRequest'>): Promise<runtime.RequestOpts>;
+    /**
+     * Returns a short-lived URL that the sandbox serves itself. GET it to download the file as raw bytes, with no size limit and no Authorization header. The URL is bound to this path and expires after `ttlSeconds` (default 15 minutes, at most 1 hour). Needs `file.read`. Treat the URL as a secret until it expires.
+     * Get a download URL for a sandbox file
+     */
+    createDownloadUrlRaw(requestParameters: CreateDownloadUrlRequest | runtime.FlatBody<CreateDownloadUrlRequest, 'fileUrlRequest'>, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<FileUrlResponse>>;
+    /**
+     * Returns a short-lived URL that the sandbox serves itself. GET it to download the file as raw bytes, with no size limit and no Authorization header. The URL is bound to this path and expires after `ttlSeconds` (default 15 minutes, at most 1 hour). Needs `file.read`. Treat the URL as a secret until it expires.
+     * Get a download URL for a sandbox file
+     */
+    createDownloadUrl(requestParameters: CreateDownloadUrlRequest | runtime.FlatBody<CreateDownloadUrlRequest, 'fileUrlRequest'>, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<FileUrlResponse>;
     /**
      * Creates request options for createEnvironment without sending the request
      */
@@ -598,6 +622,20 @@ export declare class BoatApi extends runtime.BaseAPI {
      * Share a named snapshot
      */
     createSnapshotShare(requestParameters: CreateSnapshotShareRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<NamedSnapshotShareCreatedResponse>;
+    /**
+     * Creates request options for createUploadUrl without sending the request
+     */
+    createUploadUrlRequestOpts(input: CreateUploadUrlRequest | runtime.FlatBody<CreateUploadUrlRequest, 'fileUrlRequest'>): Promise<runtime.RequestOpts>;
+    /**
+     * Returns a short-lived URL that the sandbox serves itself. PUT the file as the raw request body to write it, with no size limit and no Authorization header. Missing directories are created; an existing file is replaced only once the upload completes. The URL is bound to this path and expires after `ttlSeconds` (default 15 minutes, at most 1 hour). Needs `file.write`. Treat the URL as a secret until it expires.
+     * Get an upload URL for a sandbox file
+     */
+    createUploadUrlRaw(requestParameters: CreateUploadUrlRequest | runtime.FlatBody<CreateUploadUrlRequest, 'fileUrlRequest'>, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<FileUrlResponse>>;
+    /**
+     * Returns a short-lived URL that the sandbox serves itself. PUT the file as the raw request body to write it, with no size limit and no Authorization header. Missing directories are created; an existing file is replaced only once the upload completes. The URL is bound to this path and expires after `ttlSeconds` (default 15 minutes, at most 1 hour). Needs `file.write`. Treat the URL as a secret until it expires.
+     * Get an upload URL for a sandbox file
+     */
+    createUploadUrl(requestParameters: CreateUploadUrlRequest | runtime.FlatBody<CreateUploadUrlRequest, 'fileUrlRequest'>, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<FileUrlResponse>;
     /**
      * Creates request options for createWebhook without sending the request
      */
@@ -1159,12 +1197,12 @@ export declare class BoatApi extends runtime.BaseAPI {
      */
     readFileRequestOpts(requestParameters: ReadFileRequest): Promise<runtime.RequestOpts>;
     /**
-     * Files up to 5 MiB. Use `GET /sandboxes/{sandboxId}/artifacts` for files up to 50 MiB, and SCP over SSH for larger ones.
+     * Files up to 5 MiB. For a larger file, use `POST /sandboxes/{sandboxId}/files/download-url`.
      * Read a file from a sandbox
      */
     readFileRaw(requestParameters: ReadFileRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<FileReadResponse>>;
     /**
-     * Files up to 5 MiB. Use `GET /sandboxes/{sandboxId}/artifacts` for files up to 50 MiB, and SCP over SSH for larger ones.
+     * Files up to 5 MiB. For a larger file, use `POST /sandboxes/{sandboxId}/files/download-url`.
      * Read a file from a sandbox
      */
     readFile(requestParameters: ReadFileRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<FileReadResponse>;
@@ -1545,12 +1583,12 @@ export declare class BoatApi extends runtime.BaseAPI {
      */
     writeFileRequestOpts(input: WriteFileRequest | runtime.FlatBody<WriteFileRequest, 'fileWriteRequest'>): Promise<runtime.RequestOpts>;
     /**
-     * Files up to 5 MiB after decoding. Use SCP over SSH for larger files.
+     * Files up to 5 MiB after decoding. For a larger file, use `POST /sandboxes/{sandboxId}/files/upload-url`.
      * Write a file in a sandbox
      */
     writeFileRaw(requestParameters: WriteFileRequest | runtime.FlatBody<WriteFileRequest, 'fileWriteRequest'>, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<FileWriteResponse>>;
     /**
-     * Files up to 5 MiB after decoding. Use SCP over SSH for larger files.
+     * Files up to 5 MiB after decoding. For a larger file, use `POST /sandboxes/{sandboxId}/files/upload-url`.
      * Write a file in a sandbox
      */
     writeFile(requestParameters: WriteFileRequest | runtime.FlatBody<WriteFileRequest, 'fileWriteRequest'>, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<FileWriteResponse>;

package/dist/esm/apis/BoatApi.js

@@ -41,6 +41,8 @@ import { DesktopResponseFromJSON, } from '../models/DesktopResponse';
 import { EnvironmentItemChangeResponseFromJSON, } from '../models/EnvironmentItemChangeResponse';
 import { EventsResponseFromJSON, } from '../models/EventsResponse';
 import { FileReadResponseFromJSON, } from '../models/FileReadResponse';
+import { FileUrlRequestToJSON, } from '../models/FileUrlRequest';
+import { FileUrlResponseFromJSON, } from '../models/FileUrlResponse';
 import { FileWriteRequestToJSON, } from '../models/FileWriteRequest';
 import { FileWriteResponseFromJSON, } from '../models/FileWriteResponse';
 import { ForkRequestToJSON, } from '../models/ForkRequest';
@@ -639,6 +641,54 @@ export class BoatApi extends runtime.BaseAPI {
         const response = await this.createRaw(requestParameters, initOverrides);
         return await response.value();
     }
+    /**
+     * Creates request options for createDownloadUrl without sending the request
+     */
+    async createDownloadUrlRequestOpts(input) {
+        const requestParameters = runtime.unflattenBody(input, 'fileUrlRequest', ['sandboxId'], []);
+        if (requestParameters['sandboxId'] == null) {
+            throw new runtime.RequiredError('sandboxId', 'Required parameter "sandboxId" was null or undefined when calling createDownloadUrl().');
+        }
+        if (requestParameters['fileUrlRequest'] == null) {
+            throw new runtime.RequiredError('fileUrlRequest', 'Required parameter "fileUrlRequest" was null or undefined when calling createDownloadUrl().');
+        }
+        const queryParameters = {};
+        const headerParameters = {};
+        headerParameters['Content-Type'] = 'application/json';
+        if (this.configuration && this.configuration.accessToken) {
+            const token = this.configuration.accessToken;
+            const tokenString = await token("BoatBearerAuth", []);
+            if (tokenString) {
+                headerParameters["Authorization"] = `Bearer ${tokenString}`;
+            }
+        }
+        let urlPath = `/sandboxes/{sandboxId}/files/download-url`;
+        urlPath = urlPath.replace('{sandboxId}', encodeURIComponent(String(requestParameters['sandboxId'])));
+        return {
+            path: urlPath,
+            method: 'POST',
+            headers: headerParameters,
+            query: queryParameters,
+            body: FileUrlRequestToJSON(requestParameters['fileUrlRequest']),
+        };
+    }
+    /**
+     * Returns a short-lived URL that the sandbox serves itself. GET it to download the file as raw bytes, with no size limit and no Authorization header. The URL is bound to this path and expires after `ttlSeconds` (default 15 minutes, at most 1 hour). Needs `file.read`. Treat the URL as a secret until it expires.
+     * Get a download URL for a sandbox file
+     */
+    async createDownloadUrlRaw(requestParameters, initOverrides) {
+        const requestOptions = await this.createDownloadUrlRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+        return new runtime.JSONApiResponse(response, (jsonValue) => FileUrlResponseFromJSON(jsonValue));
+    }
+    /**
+     * Returns a short-lived URL that the sandbox serves itself. GET it to download the file as raw bytes, with no size limit and no Authorization header. The URL is bound to this path and expires after `ttlSeconds` (default 15 minutes, at most 1 hour). Needs `file.read`. Treat the URL as a secret until it expires.
+     * Get a download URL for a sandbox file
+     */
+    async createDownloadUrl(requestParameters, initOverrides) {
+        const response = await this.createDownloadUrlRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
     /**
      * Creates request options for createEnvironment without sending the request
      */
@@ -769,6 +819,54 @@ export class BoatApi extends runtime.BaseAPI {
         const response = await this.createSnapshotShareRaw(requestParameters, initOverrides);
         return await response.value();
     }
+    /**
+     * Creates request options for createUploadUrl without sending the request
+     */
+    async createUploadUrlRequestOpts(input) {
+        const requestParameters = runtime.unflattenBody(input, 'fileUrlRequest', ['sandboxId'], []);
+        if (requestParameters['sandboxId'] == null) {
+            throw new runtime.RequiredError('sandboxId', 'Required parameter "sandboxId" was null or undefined when calling createUploadUrl().');
+        }
+        if (requestParameters['fileUrlRequest'] == null) {
+            throw new runtime.RequiredError('fileUrlRequest', 'Required parameter "fileUrlRequest" was null or undefined when calling createUploadUrl().');
+        }
+        const queryParameters = {};
+        const headerParameters = {};
+        headerParameters['Content-Type'] = 'application/json';
+        if (this.configuration && this.configuration.accessToken) {
+            const token = this.configuration.accessToken;
+            const tokenString = await token("BoatBearerAuth", []);
+            if (tokenString) {
+                headerParameters["Authorization"] = `Bearer ${tokenString}`;
+            }
+        }
+        let urlPath = `/sandboxes/{sandboxId}/files/upload-url`;
+        urlPath = urlPath.replace('{sandboxId}', encodeURIComponent(String(requestParameters['sandboxId'])));
+        return {
+            path: urlPath,
+            method: 'POST',
+            headers: headerParameters,
+            query: queryParameters,
+            body: FileUrlRequestToJSON(requestParameters['fileUrlRequest']),
+        };
+    }
+    /**
+     * Returns a short-lived URL that the sandbox serves itself. PUT the file as the raw request body to write it, with no size limit and no Authorization header. Missing directories are created; an existing file is replaced only once the upload completes. The URL is bound to this path and expires after `ttlSeconds` (default 15 minutes, at most 1 hour). Needs `file.write`. Treat the URL as a secret until it expires.
+     * Get an upload URL for a sandbox file
+     */
+    async createUploadUrlRaw(requestParameters, initOverrides) {
+        const requestOptions = await this.createUploadUrlRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+        return new runtime.JSONApiResponse(response, (jsonValue) => FileUrlResponseFromJSON(jsonValue));
+    }
+    /**
+     * Returns a short-lived URL that the sandbox serves itself. PUT the file as the raw request body to write it, with no size limit and no Authorization header. Missing directories are created; an existing file is replaced only once the upload completes. The URL is bound to this path and expires after `ttlSeconds` (default 15 minutes, at most 1 hour). Needs `file.write`. Treat the URL as a secret until it expires.
+     * Get an upload URL for a sandbox file
+     */
+    async createUploadUrl(requestParameters, initOverrides) {
+        const response = await this.createUploadUrlRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
     /**
      * Creates request options for createWebhook without sending the request
      */
@@ -2561,7 +2659,7 @@ export class BoatApi extends runtime.BaseAPI {
         };
     }
     /**
-     * Files up to 5 MiB. Use `GET /sandboxes/{sandboxId}/artifacts` for files up to 50 MiB, and SCP over SSH for larger ones.
+     * Files up to 5 MiB. For a larger file, use `POST /sandboxes/{sandboxId}/files/download-url`.
      * Read a file from a sandbox
      */
     async readFileRaw(requestParameters, initOverrides) {
@@ -2570,7 +2668,7 @@ export class BoatApi extends runtime.BaseAPI {
         return new runtime.JSONApiResponse(response, (jsonValue) => FileReadResponseFromJSON(jsonValue));
     }
     /**
-     * Files up to 5 MiB. Use `GET /sandboxes/{sandboxId}/artifacts` for files up to 50 MiB, and SCP over SSH for larger ones.
+     * Files up to 5 MiB. For a larger file, use `POST /sandboxes/{sandboxId}/files/download-url`.
      * Read a file from a sandbox
      */
     async readFile(requestParameters, initOverrides) {
@@ -3845,7 +3943,7 @@ export class BoatApi extends runtime.BaseAPI {
         };
     }
     /**
-     * Files up to 5 MiB after decoding. Use SCP over SSH for larger files.
+     * Files up to 5 MiB after decoding. For a larger file, use `POST /sandboxes/{sandboxId}/files/upload-url`.
      * Write a file in a sandbox
      */
     async writeFileRaw(requestParameters, initOverrides) {
@@ -3854,7 +3952,7 @@ export class BoatApi extends runtime.BaseAPI {
         return new runtime.JSONApiResponse(response, (jsonValue) => FileWriteResponseFromJSON(jsonValue));
     }
     /**
-     * Files up to 5 MiB after decoding. Use SCP over SSH for larger files.
+     * Files up to 5 MiB after decoding. For a larger file, use `POST /sandboxes/{sandboxId}/files/upload-url`.
      * Write a file in a sandbox
      */
     async writeFile(requestParameters, initOverrides) {

package/dist/esm/models/DeletionOperation.d.ts

@@ -46,7 +46,7 @@ export interface DeletionOperation {
      */
     status: DeletionOperationStatusEnum;
     /**
-     * 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 you kept is built on this one; its data goes when they go. `waiting_for_restore`: a sandbox is still restoring from it. `retrying`: a transient fault, retried automatically.
+     * 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.
      * @type {DeletionOperationStageEnum}
      * @memberof DeletionOperation
      */

package/dist/esm/models/FileUrlRequest.d.ts

@@ -0,0 +1,38 @@
+/**
+ * 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.
+ */
+/**
+ *
+ * @export
+ * @interface FileUrlRequest
+ */
+export interface FileUrlRequest {
+    /**
+     * Absolute path, or path relative to the sandbox work directory (/home/user). It must resolve under /home/user or /tmp.
+     * @type {string}
+     * @memberof FileUrlRequest
+     */
+    path: string;
+    /**
+     * How long the URL stays valid.
+     * @type {number}
+     * @memberof FileUrlRequest
+     */
+    ttlSeconds?: number;
+}
+/**
+ * Check if a given object implements the FileUrlRequest interface.
+ */
+export declare function instanceOfFileUrlRequest(value: object): value is FileUrlRequest;
+export declare function FileUrlRequestFromJSON(json: any): FileUrlRequest;
+export declare function FileUrlRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): FileUrlRequest;
+export declare function FileUrlRequestToJSON(json: any): FileUrlRequest;
+export declare function FileUrlRequestToJSONTyped(value?: FileUrlRequest | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/FileUrlRequest.js

@@ -0,0 +1,45 @@
+/* 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.
+ */
+/**
+ * Check if a given object implements the FileUrlRequest interface.
+ */
+export function instanceOfFileUrlRequest(value) {
+    if (!('path' in value) || value['path'] === undefined)
+        return false;
+    return true;
+}
+export function FileUrlRequestFromJSON(json) {
+    return FileUrlRequestFromJSONTyped(json, false);
+}
+export function FileUrlRequestFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'path': json['path'],
+        'ttlSeconds': json['ttlSeconds'] == null ? undefined : json['ttlSeconds'],
+    };
+}
+export function FileUrlRequestToJSON(json) {
+    return FileUrlRequestToJSONTyped(json, false);
+}
+export function FileUrlRequestToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'path': value['path'],
+        'ttlSeconds': value['ttlSeconds'],
+    };
+}