@mixedbread/sdk 0.55.0 → 0.57.0

package/src/resources/files/files.ts

@@ -0,0 +1,239 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../core/resource';
+import * as UploadsAPI from './uploads';
+import {
+  MultipartUploadPart,
+  MultipartUploadPartURL,
+  UploadAbortResponse,
+  UploadCompleteParams,
+  UploadCreateParams,
+  UploadCreateResponse,
+  UploadListResponse,
+  UploadRetrieveResponse,
+  Uploads,
+} from './uploads';
+import { APIPromise } from '../../core/api-promise';
+import { Cursor, type CursorParams, PagePromise } from '../../core/pagination';
+import { type Uploadable } from '../../core/uploads';
+import { buildHeaders } from '../../internal/headers';
+import { RequestOptions } from '../../internal/request-options';
+import { multipartFormRequestOptions } from '../../internal/uploads';
+import { path } from '../../internal/utils/path';
+import { handleFileCreate, type MultipartUploadConfig } from '../../lib/upload-file';
+
+export class Files extends APIResource {
+  uploads: UploadsAPI.Uploads = new UploadsAPI.Uploads(this._client);
+
+  /**
+   * Upload a new file.
+   *
+   * Args: file: The file to upload.
+   *
+   * Returns: FileResponse: The response containing the details of the uploaded file.
+   */
+  create(body: FileCreateParams, options?: RequestOptions): APIPromise<FileObject> {
+    return handleFileCreate(this._client, body, options);
+  }
+
+  /**
+   * Retrieve details of a specific file by its ID.
+   *
+   * Args: file_id: The ID of the file to retrieve.
+   *
+   * Returns: FileResponse: The response containing the file details.
+   */
+  retrieve(fileID: string, options?: RequestOptions): APIPromise<FileObject> {
+    return this._client.get(path`/v1/files/${fileID}`, options);
+  }
+
+  /**
+   * Update the details of a specific file.
+   *
+   * Args: file_id: The ID of the file to update. file: The new details for the file.
+   *
+   * Returns: FileObject: The updated file details.
+   */
+  update(fileID: string, body: FileUpdateParams, options?: RequestOptions): APIPromise<FileObject> {
+    return this._client.post(
+      path`/v1/files/${fileID}`,
+      multipartFormRequestOptions({ body, ...options }, this._client),
+    );
+  }
+
+  /**
+   * List all files for the authenticated user.
+   *
+   * Args: pagination: The pagination options
+   *
+   * Returns: A list of files belonging to the user.
+   */
+  list(
+    query: FileListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): PagePromise<FileObjectsCursor, FileObject> {
+    return this._client.getAPIList('/v1/files', Cursor<FileObject>, { query, ...options });
+  }
+
+  /**
+   * Delete a specific file by its ID.
+   *
+   * Args: file_id: The ID of the file to delete.
+   *
+   * Returns: FileDeleted: The response containing the details of the deleted file.
+   */
+  delete(fileID: string, options?: RequestOptions): APIPromise<FileDeleteResponse> {
+    return this._client.delete(path`/v1/files/${fileID}`, options);
+  }
+
+  /**
+   * Download a specific file by its ID.
+   *
+   * Args: file_id: The ID of the file to download.
+   *
+   * Returns: FileStreamResponse: The response containing the file to be downloaded.
+   */
+  content(fileID: string, options?: RequestOptions): APIPromise<Response> {
+    return this._client.get(path`/v1/files/${fileID}/content`, {
+      ...options,
+      headers: buildHeaders([{ Accept: 'application/octet-stream' }, options?.headers]),
+      __binaryResponse: true,
+    });
+  }
+}
+
+export type FileObjectsCursor = Cursor<FileObject>;
+
+/**
+ * A model representing a file object in the system.
+ *
+ * This model contains metadata about files stored in the system, including
+ * identifiers, size information, and timestamps.
+ */
+export interface FileObject {
+  /**
+   * Unique identifier for the file
+   */
+  id: string;
+
+  /**
+   * Name of the file including extension
+   */
+  filename: string;
+
+  /**
+   * Size of the file in bytes
+   */
+  bytes: number;
+
+  /**
+   * MIME type of the file
+   */
+  mime_type: string;
+
+  /**
+   * Version of the file
+   */
+  version: number;
+
+  /**
+   * Timestamp when the file was created
+   */
+  created_at: string;
+
+  /**
+   * Timestamp when the file was last updated
+   */
+  updated_at: string;
+}
+
+/**
+ * Pagination model that includes total count of items.
+ */
+export interface PaginationWithTotal {
+  /**
+   * Maximum number of items to return per page
+   */
+  limit?: number;
+
+  /**
+   * Offset of the first item to return
+   */
+  offset?: number;
+
+  /**
+   * Total number of items available
+   */
+  total?: number;
+}
+
+export interface FileDeleteResponse {
+  /**
+   * The ID of the deleted file
+   */
+  id: string;
+
+  /**
+   * Whether the file was deleted
+   */
+  deleted?: boolean;
+
+  /**
+   * The type of the deleted object
+   */
+  object?: 'file';
+}
+
+export interface FileCreateParams {
+  /**
+   * The file to upload
+   */
+  file: Uploadable;
+
+  /**
+   * Optional configuration for automatic multipart uploads.
+   * When the file size exceeds the threshold (default 100MB), the SDK
+   * will automatically use multipart upload with presigned URLs.
+   */
+  multipartUpload?: MultipartUploadConfig;
+}
+
+export interface FileUpdateParams {
+  /**
+   * The file to update
+   */
+  file: Uploadable;
+}
+
+export interface FileListParams extends CursorParams {
+  /**
+   * Search query for fuzzy matching over name and description fields
+   */
+  q?: string | null;
+}
+
+Files.Uploads = Uploads;
+
+export declare namespace Files {
+  export {
+    type FileObject as FileObject,
+    type PaginationWithTotal as PaginationWithTotal,
+    type FileDeleteResponse as FileDeleteResponse,
+    type FileObjectsCursor as FileObjectsCursor,
+    type FileCreateParams as FileCreateParams,
+    type FileUpdateParams as FileUpdateParams,
+    type FileListParams as FileListParams,
+  };
+
+  export {
+    Uploads as Uploads,
+    type MultipartUploadPart as MultipartUploadPart,
+    type MultipartUploadPartURL as MultipartUploadPartURL,
+    type UploadCreateResponse as UploadCreateResponse,
+    type UploadRetrieveResponse as UploadRetrieveResponse,
+    type UploadListResponse as UploadListResponse,
+    type UploadAbortResponse as UploadAbortResponse,
+    type UploadCreateParams as UploadCreateParams,
+    type UploadCompleteParams as UploadCompleteParams,
+  };
+}

package/src/resources/files/index.ts

@@ -0,0 +1,23 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export {
+  Files,
+  type FileObject,
+  type PaginationWithTotal,
+  type FileDeleteResponse,
+  type FileCreateParams,
+  type FileUpdateParams,
+  type FileListParams,
+  type FileObjectsCursor,
+} from './files';
+export {
+  Uploads,
+  type MultipartUploadPart,
+  type MultipartUploadPartURL,
+  type UploadCreateResponse,
+  type UploadRetrieveResponse,
+  type UploadListResponse,
+  type UploadAbortResponse,
+  type UploadCreateParams,
+  type UploadCompleteParams,
+} from './uploads';

package/src/resources/files/uploads.ts

@@ -0,0 +1,229 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../core/resource';
+import * as FilesAPI from './files';
+import { APIPromise } from '../../core/api-promise';
+import { RequestOptions } from '../../internal/request-options';
+import { path } from '../../internal/utils/path';
+
+export class Uploads extends APIResource {
+  /**
+   * Initiate a multipart upload and receive presigned URLs for uploading parts
+   * directly to storage.
+   */
+  create(body: UploadCreateParams, options?: RequestOptions): APIPromise<UploadCreateResponse> {
+    return this._client.post('/v1/files/uploads', { body, ...options });
+  }
+
+  /**
+   * Get a multipart upload's details with fresh presigned URLs for any parts not yet
+   * uploaded.
+   */
+  retrieve(uploadID: string, options?: RequestOptions): APIPromise<UploadRetrieveResponse> {
+    return this._client.get(path`/v1/files/uploads/${uploadID}`, options);
+  }
+
+  /**
+   * List all in-progress multipart uploads for the authenticated organization.
+   */
+  list(options?: RequestOptions): APIPromise<UploadListResponse> {
+    return this._client.get('/v1/files/uploads', options);
+  }
+
+  /**
+   * Abort a multipart upload and clean up any uploaded parts.
+   */
+  abort(uploadID: string, options?: RequestOptions): APIPromise<UploadAbortResponse> {
+    return this._client.post(path`/v1/files/uploads/${uploadID}/abort`, options);
+  }
+
+  /**
+   * Complete a multipart upload after all parts have been uploaded. Creates the file
+   * object and returns it.
+   */
+  complete(
+    uploadID: string,
+    body: UploadCompleteParams,
+    options?: RequestOptions,
+  ): APIPromise<FilesAPI.FileObject> {
+    return this._client.post(path`/v1/files/uploads/${uploadID}/complete`, { body, ...options });
+  }
+}
+
+export interface MultipartUploadPart {
+  /**
+   * 1-based part number
+   */
+  part_number: number;
+
+  /**
+   * ETag returned by the storage backend after uploading the part
+   */
+  etag: string;
+}
+
+export interface MultipartUploadPartURL {
+  /**
+   * 1-based part number
+   */
+  part_number: number;
+
+  /**
+   * Presigned URL for uploading this part
+   */
+  url: string;
+}
+
+export interface UploadCreateResponse {
+  /**
+   * The multipart upload ID (use this to complete or abort)
+   */
+  id: string;
+
+  /**
+   * Presigned URLs for uploading parts
+   */
+  part_urls: Array<MultipartUploadPartURL>;
+}
+
+export interface UploadRetrieveResponse {
+  /**
+   * The multipart upload record ID
+   */
+  id: string;
+
+  /**
+   * Original filename
+   */
+  filename: string;
+
+  /**
+   * Total file size in bytes
+   */
+  file_size: number;
+
+  /**
+   * MIME type of the file
+   */
+  mime_type: string;
+
+  /**
+   * Number of parts the file was split into
+   */
+  part_count: number;
+
+  /**
+   * When the upload was initiated
+   */
+  created_at: string;
+
+  /**
+   * Parts that have already been uploaded
+   */
+  completed_parts: Array<MultipartUploadPart>;
+
+  /**
+   * Presigned URLs for the parts that still need to be uploaded
+   */
+  part_urls: Array<MultipartUploadPartURL>;
+}
+
+export interface UploadListResponse {
+  /**
+   * List of in-progress multipart uploads
+   */
+  data: Array<UploadListResponse.Data>;
+}
+
+export namespace UploadListResponse {
+  export interface Data {
+    /**
+     * The multipart upload record ID
+     */
+    id: string;
+
+    /**
+     * Original filename
+     */
+    filename: string;
+
+    /**
+     * Total file size in bytes
+     */
+    file_size: number;
+
+    /**
+     * MIME type of the file
+     */
+    mime_type: string;
+
+    /**
+     * Number of parts the file was split into
+     */
+    part_count: number;
+
+    /**
+     * When the upload was initiated
+     */
+    created_at: string;
+  }
+}
+
+export interface UploadAbortResponse {
+  /**
+   * The ID of the deleted file
+   */
+  id: string;
+
+  /**
+   * Whether the file was deleted
+   */
+  deleted?: boolean;
+
+  /**
+   * The type of the deleted object
+   */
+  object?: 'file';
+}
+
+export interface UploadCreateParams {
+  /**
+   * Name of the file including extension
+   */
+  filename: string;
+
+  /**
+   * Total size of the file in bytes
+   */
+  file_size: number;
+
+  /**
+   * MIME type of the file
+   */
+  mime_type: string;
+
+  /**
+   * Number of parts to split the upload into
+   */
+  part_count?: number;
+}
+
+export interface UploadCompleteParams {
+  /**
+   * List of completed parts with their ETags
+   */
+  parts: Array<MultipartUploadPart>;
+}
+
+export declare namespace Uploads {
+  export {
+    type MultipartUploadPart as MultipartUploadPart,
+    type MultipartUploadPartURL as MultipartUploadPartURL,
+    type UploadCreateResponse as UploadCreateResponse,
+    type UploadRetrieveResponse as UploadRetrieveResponse,
+    type UploadListResponse as UploadListResponse,
+    type UploadAbortResponse as UploadAbortResponse,
+    type UploadCreateParams as UploadCreateParams,
+    type UploadCompleteParams as UploadCompleteParams,
+  };
+}

package/src/resources/files.ts

@@ -1,203 +1,3 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
-import { APIResource } from '../core/resource';
-import { APIPromise } from '../core/api-promise';
-import { Cursor, type CursorParams, PagePromise } from '../core/pagination';
-import { type Uploadable } from '../core/uploads';
-import { buildHeaders } from '../internal/headers';
-import { RequestOptions } from '../internal/request-options';
-import { multipartFormRequestOptions } from '../internal/uploads';
-import { path } from '../internal/utils/path';
-
-export class Files extends APIResource {
-  /**
-   * Upload a new file.
-   *
-   * Args: file: The file to upload.
-   *
-   * Returns: FileResponse: The response containing the details of the uploaded file.
-   */
-  create(body: FileCreateParams, options?: RequestOptions): APIPromise<FileObject> {
-    return this._client.post('/v1/files', multipartFormRequestOptions({ body, ...options }, this._client));
-  }
-
-  /**
-   * Retrieve details of a specific file by its ID.
-   *
-   * Args: file_id: The ID of the file to retrieve.
-   *
-   * Returns: FileResponse: The response containing the file details.
-   */
-  retrieve(fileID: string, options?: RequestOptions): APIPromise<FileObject> {
-    return this._client.get(path`/v1/files/${fileID}`, options);
-  }
-
-  /**
-   * Update the details of a specific file.
-   *
-   * Args: file_id: The ID of the file to update. file: The new details for the file.
-   *
-   * Returns: FileObject: The updated file details.
-   */
-  update(fileID: string, body: FileUpdateParams, options?: RequestOptions): APIPromise<FileObject> {
-    return this._client.post(
-      path`/v1/files/${fileID}`,
-      multipartFormRequestOptions({ body, ...options }, this._client),
-    );
-  }
-
-  /**
-   * List all files for the authenticated user.
-   *
-   * Args: pagination: The pagination options
-   *
-   * Returns: A list of files belonging to the user.
-   */
-  list(
-    query: FileListParams | null | undefined = {},
-    options?: RequestOptions,
-  ): PagePromise<FileObjectsCursor, FileObject> {
-    return this._client.getAPIList('/v1/files', Cursor<FileObject>, { query, ...options });
-  }
-
-  /**
-   * Delete a specific file by its ID.
-   *
-   * Args: file_id: The ID of the file to delete.
-   *
-   * Returns: FileDeleted: The response containing the details of the deleted file.
-   */
-  delete(fileID: string, options?: RequestOptions): APIPromise<FileDeleteResponse> {
-    return this._client.delete(path`/v1/files/${fileID}`, options);
-  }
-
-  /**
-   * Download a specific file by its ID.
-   *
-   * Args: file_id: The ID of the file to download.
-   *
-   * Returns: FileStreamResponse: The response containing the file to be downloaded.
-   */
-  content(fileID: string, options?: RequestOptions): APIPromise<Response> {
-    return this._client.get(path`/v1/files/${fileID}/content`, {
-      ...options,
-      headers: buildHeaders([{ Accept: 'application/octet-stream' }, options?.headers]),
-      __binaryResponse: true,
-    });
-  }
-}
-
-export type FileObjectsCursor = Cursor<FileObject>;
-
-/**
- * A model representing a file object in the system.
- *
- * This model contains metadata about files stored in the system, including
- * identifiers, size information, and timestamps.
- */
-export interface FileObject {
-  /**
-   * Unique identifier for the file
-   */
-  id: string;
-
-  /**
-   * Name of the file including extension
-   */
-  filename: string;
-
-  /**
-   * Size of the file in bytes
-   */
-  bytes: number;
-
-  /**
-   * MIME type of the file
-   */
-  mime_type: string;
-
-  /**
-   * Version of the file
-   */
-  version: number;
-
-  /**
-   * Timestamp when the file was created
-   */
-  created_at: string;
-
-  /**
-   * Timestamp when the file was last updated
-   */
-  updated_at: string;
-}
-
-/**
- * Pagination model that includes total count of items.
- */
-export interface PaginationWithTotal {
-  /**
-   * Maximum number of items to return per page
-   */
-  limit?: number;
-
-  /**
-   * Offset of the first item to return
-   */
-  offset?: number;
-
-  /**
-   * Total number of items available
-   */
-  total?: number;
-}
-
-export interface FileDeleteResponse {
-  /**
-   * The ID of the deleted file
-   */
-  id: string;
-
-  /**
-   * Whether the file was deleted
-   */
-  deleted?: boolean;
-
-  /**
-   * The type of the deleted object
-   */
-  object?: 'file';
-}
-
-export interface FileCreateParams {
-  /**
-   * The file to upload
-   */
-  file: Uploadable;
-}
-
-export interface FileUpdateParams {
-  /**
-   * The file to update
-   */
-  file: Uploadable;
-}
-
-export interface FileListParams extends CursorParams {
-  /**
-   * Search query for fuzzy matching over name and description fields
-   */
-  q?: string | null;
-}
-
-export declare namespace Files {
-  export {
-    type FileObject as FileObject,
-    type PaginationWithTotal as PaginationWithTotal,
-    type FileDeleteResponse as FileDeleteResponse,
-    type FileObjectsCursor as FileObjectsCursor,
-    type FileCreateParams as FileCreateParams,
-    type FileUpdateParams as FileUpdateParams,
-    type FileListParams as FileListParams,
-  };
-}
+export * from './files/index';

package/src/resources/index.ts

@@ -36,7 +36,7 @@ export {
   type FileUpdateParams,
   type FileListParams,
   type FileObjectsCursor,
-} from './files';
+} from './files/files';
 export { Parsing } from './parsing/parsing';
 export {
   Stores,