mixpeek 0.81.1

package/dist/api/bucket-uploads-api.d.ts

@@ -0,0 +1,661 @@
+/**
+ * Mixpeek API
+ * This is the Mixpeek API, providing access to various endpoints for data processing and retrieval.
+ *
+ * The version of the OpenAPI document: 0.81.1
+ * Contact: info@mixpeek.com
+ *
+ * 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 { Configuration } from '../configuration';
+import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios';
+import { type RequestArgs, BaseAPI } from '../base';
+import type { BatchConfirmRequest } from '../models';
+import type { BatchConfirmResponse } from '../models';
+import type { BatchUploadRequest } from '../models';
+import type { BatchUploadResponse } from '../models';
+import type { ConfirmUploadRequest } from '../models';
+import type { ConfirmUploadResponse } from '../models';
+import type { CreateUploadRequest } from '../models';
+import type { ListUploadsRequest } from '../models';
+import type { ListUploadsResponse } from '../models';
+import type { UploadResponse } from '../models';
+/**
+ * BucketUploadsApi - axios parameter creator
+ * @export
+ */
+export declare const BucketUploadsApiAxiosParamCreator: (configuration?: Configuration) => {
+    /**
+     * Verify S3 upload completion and create bucket object.      After uploading to S3 using the presigned URL, call this endpoint to:     1. Verify the file exists in S3     2. Validate ETag and file size (if provided)     3. Create bucket object (default, unless create_object_on_confirm=false)     4. Update upload status to COMPLETED      **Sync vs Async**:     - Files < 100MB: Processed synchronously (~100ms)     - Files >= 100MB or async=true: Processed asynchronously (returns task_id)      **Duplicate Detection**:     - If file hash matches existing upload, marks as duplicate     - References original object_id if available
+     * @summary Confirm Upload
+     * @param {string} bucketIdentifier The unique identifier of the bucket
+     * @param {string} uploadId The unique identifier of the upload
+     * @param {ConfirmUploadRequest} confirmUploadRequest
+     * @param {boolean} [async] Process confirmation asynchronously (recommended for files &gt;&#x3D; 100MB)
+     * @param {string} [authorization] REQUIRED: Bearer token authentication using your API key. Format: \&#39;Bearer sk_xxxxxxxxxxxxx\&#39;. You can create API keys in the Mixpeek dashboard under Organization Settings.
+     * @param {string} [authorization2]
+     * @param {string} [xNamespace] REQUIRED: Namespace identifier for scoping this request. All resources (collections, buckets, taxonomies, etc.) are scoped to a namespace. You can provide either the namespace name or namespace ID. Format: ns_xxxxxxxxxxxxx (ID) or a custom name like \&#39;my-namespace\&#39;
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    confirmUploadBuckets: (bucketIdentifier: string, uploadId: string, confirmUploadRequest: ConfirmUploadRequest, async?: boolean, authorization?: string, authorization2?: string, xNamespace?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Confirm multiple uploads in a single request (processed asynchronously).      Maximum 100 confirmations per batch.     All uploads must belong to the same bucket.      Returns a task_id to track progress via GET /v1/tasks/{task_id}.
+     * @summary Batch Confirm Uploads
+     * @param {string} bucketIdentifier The unique identifier of the bucket
+     * @param {BatchConfirmRequest} batchConfirmRequest
+     * @param {string} [authorization] REQUIRED: Bearer token authentication using your API key. Format: \&#39;Bearer sk_xxxxxxxxxxxxx\&#39;. You can create API keys in the Mixpeek dashboard under Organization Settings.
+     * @param {string} [authorization2]
+     * @param {string} [xNamespace] REQUIRED: Namespace identifier for scoping this request. All resources (collections, buckets, taxonomies, etc.) are scoped to a namespace. You can provide either the namespace name or namespace ID. Format: ns_xxxxxxxxxxxxx (ID) or a custom name like \&#39;my-namespace\&#39;
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    confirmUploadsBatchBuckets: (bucketIdentifier: string, batchConfirmRequest: BatchConfirmRequest, authorization?: string, authorization2?: string, xNamespace?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Generate a presigned URL for direct S3 upload.      This endpoint validates all requirements BEFORE generating the presigned URL,     ensuring immediate feedback if something is wrong (bucket inactive, quota exceeded, etc.).      **Duplicate Detection (Enabled by Default)**:     - If `file_hash` provided and `skip_duplicates=true`: Checks for existing upload     - If duplicate found: Returns existing upload (200 OK) with `is_duplicate=true`     - If new file: Returns presigned URL (201 Created) with `is_duplicate=false`      **Two-Step Flow**:     1. Call this endpoint → Get presigned URL     2. PUT file to presigned URL → Upload directly to S3     3. Call confirm endpoint → Verify upload and create object
+     * @summary Create Upload
+     * @param {string} bucketIdentifier The unique identifier of the bucket
+     * @param {CreateUploadRequest} createUploadRequest
+     * @param {string} [authorization] REQUIRED: Bearer token authentication using your API key. Format: \&#39;Bearer sk_xxxxxxxxxxxxx\&#39;. You can create API keys in the Mixpeek dashboard under Organization Settings.
+     * @param {string} [authorization2]
+     * @param {string} [xNamespace] REQUIRED: Namespace identifier for scoping this request. All resources (collections, buckets, taxonomies, etc.) are scoped to a namespace. You can provide either the namespace name or namespace ID. Format: ns_xxxxxxxxxxxxx (ID) or a custom name like \&#39;my-namespace\&#39;
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createUploadBuckets: (bucketIdentifier: string, createUploadRequest: CreateUploadRequest, authorization?: string, authorization2?: string, xNamespace?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Generate multiple presigned URLs in a single request.      All uploads belong to the same bucket (from path parameter).     Maximum 100 uploads per batch.      Shared metadata is merged with individual upload metadata (individual takes precedence).
+     * @summary Batch Create Uploads
+     * @param {string} bucketIdentifier The unique identifier of the bucket
+     * @param {BatchUploadRequest} batchUploadRequest
+     * @param {string} [authorization] REQUIRED: Bearer token authentication using your API key. Format: \&#39;Bearer sk_xxxxxxxxxxxxx\&#39;. You can create API keys in the Mixpeek dashboard under Organization Settings.
+     * @param {string} [authorization2]
+     * @param {string} [xNamespace] REQUIRED: Namespace identifier for scoping this request. All resources (collections, buckets, taxonomies, etc.) are scoped to a namespace. You can provide either the namespace name or namespace ID. Format: ns_xxxxxxxxxxxxx (ID) or a custom name like \&#39;my-namespace\&#39;
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createUploadsBatchBuckets: (bucketIdentifier: string, batchUploadRequest: BatchUploadRequest, authorization?: string, authorization2?: string, xNamespace?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Cancel an upload and optionally delete the S3 object.      Cannot cancel uploads with status COMPLETED.     Can cancel uploads with status: PENDING, IN_PROGRESS, FAILED.
+     * @summary Delete Upload
+     * @param {string} bucketIdentifier The unique identifier of the bucket
+     * @param {string} uploadId The unique identifier of the upload
+     * @param {boolean} [deleteS3Object] Whether to delete the S3 object
+     * @param {string} [authorization] REQUIRED: Bearer token authentication using your API key. Format: \&#39;Bearer sk_xxxxxxxxxxxxx\&#39;. You can create API keys in the Mixpeek dashboard under Organization Settings.
+     * @param {string} [authorization2]
+     * @param {string} [xNamespace] REQUIRED: Namespace identifier for scoping this request. All resources (collections, buckets, taxonomies, etc.) are scoped to a namespace. You can provide either the namespace name or namespace ID. Format: ns_xxxxxxxxxxxxx (ID) or a custom name like \&#39;my-namespace\&#39;
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    deleteUploadBuckets: (bucketIdentifier: string, uploadId: string, deleteS3Object?: boolean, authorization?: string, authorization2?: string, xNamespace?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Retrieve an upload by its ID.      Use this to check upload status, get S3 key, or retrieve created object_id after confirmation.      **Presigned URLs**: Set `return_presigned_urls=true` query parameter to generate fresh presigned download URLs (default: false).     The presigned URLs expire after 1 hour and allow direct download from S3.
+     * @summary Get Upload
+     * @param {string} bucketIdentifier The unique identifier of the bucket
+     * @param {string} uploadId The unique identifier of the upload
+     * @param {boolean} [returnPresignedUrls] Generate fresh presigned download URLs for all blobs with S3 storage
+     * @param {string} [authorization] REQUIRED: Bearer token authentication using your API key. Format: \&#39;Bearer sk_xxxxxxxxxxxxx\&#39;. You can create API keys in the Mixpeek dashboard under Organization Settings.
+     * @param {string} [authorization2]
+     * @param {string} [xNamespace] REQUIRED: Namespace identifier for scoping this request. All resources (collections, buckets, taxonomies, etc.) are scoped to a namespace. You can provide either the namespace name or namespace ID. Format: ns_xxxxxxxxxxxxx (ID) or a custom name like \&#39;my-namespace\&#39;
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getUploadBuckets: (bucketIdentifier: string, uploadId: string, returnPresignedUrls?: boolean, authorization?: string, authorization2?: string, xNamespace?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * List uploads in a bucket with filtering, sorting, search, and pagination.      **Filtering**: Use LogicalOperator with shorthand syntax     - Simple: `{\"status\": \"PENDING\", \"metadata.campaign\": \"summer_2024\"}`     - Complex: `{\"AND\": [{\"field\": \"file_size_bytes\", \"operator\": \"gte\", \"value\": 1000000}]}`      **Sorting**: Specify field and direction     - Example: `{\"field\": \"created_at\", \"direction\": \"desc\"}`      **Search**: Full-text search across filename and metadata     - Example: `\"search\": \"video\"`      **Pagination**: Use limit and offset     - Example: `\"limit\": 50, \"offset\": 100`
+     * @summary List Uploads
+     * @param {string} bucketIdentifier The unique identifier of the bucket
+     * @param {number} [limit]
+     * @param {number} [offset]
+     * @param {string} [cursor]
+     * @param {boolean} [includeTotal]
+     * @param {string} [authorization] REQUIRED: Bearer token authentication using your API key. Format: \&#39;Bearer sk_xxxxxxxxxxxxx\&#39;. You can create API keys in the Mixpeek dashboard under Organization Settings.
+     * @param {string} [authorization2]
+     * @param {string} [xNamespace] REQUIRED: Namespace identifier for scoping this request. All resources (collections, buckets, taxonomies, etc.) are scoped to a namespace. You can provide either the namespace name or namespace ID. Format: ns_xxxxxxxxxxxxx (ID) or a custom name like \&#39;my-namespace\&#39;
+     * @param {ListUploadsRequest} [listUploadsRequest]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listUploadsBuckets: (bucketIdentifier: string, limit?: number, offset?: number, cursor?: string, includeTotal?: boolean, authorization?: string, authorization2?: string, xNamespace?: string, listUploadsRequest?: ListUploadsRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+};
+/**
+ * BucketUploadsApi - functional programming interface
+ * @export
+ */
+export declare const BucketUploadsApiFp: (configuration?: Configuration) => {
+    /**
+     * Verify S3 upload completion and create bucket object.      After uploading to S3 using the presigned URL, call this endpoint to:     1. Verify the file exists in S3     2. Validate ETag and file size (if provided)     3. Create bucket object (default, unless create_object_on_confirm=false)     4. Update upload status to COMPLETED      **Sync vs Async**:     - Files < 100MB: Processed synchronously (~100ms)     - Files >= 100MB or async=true: Processed asynchronously (returns task_id)      **Duplicate Detection**:     - If file hash matches existing upload, marks as duplicate     - References original object_id if available
+     * @summary Confirm Upload
+     * @param {string} bucketIdentifier The unique identifier of the bucket
+     * @param {string} uploadId The unique identifier of the upload
+     * @param {ConfirmUploadRequest} confirmUploadRequest
+     * @param {boolean} [async] Process confirmation asynchronously (recommended for files &gt;&#x3D; 100MB)
+     * @param {string} [authorization] REQUIRED: Bearer token authentication using your API key. Format: \&#39;Bearer sk_xxxxxxxxxxxxx\&#39;. You can create API keys in the Mixpeek dashboard under Organization Settings.
+     * @param {string} [authorization2]
+     * @param {string} [xNamespace] REQUIRED: Namespace identifier for scoping this request. All resources (collections, buckets, taxonomies, etc.) are scoped to a namespace. You can provide either the namespace name or namespace ID. Format: ns_xxxxxxxxxxxxx (ID) or a custom name like \&#39;my-namespace\&#39;
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    confirmUploadBuckets(bucketIdentifier: string, uploadId: string, confirmUploadRequest: ConfirmUploadRequest, async?: boolean, authorization?: string, authorization2?: string, xNamespace?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ConfirmUploadResponse>>;
+    /**
+     * Confirm multiple uploads in a single request (processed asynchronously).      Maximum 100 confirmations per batch.     All uploads must belong to the same bucket.      Returns a task_id to track progress via GET /v1/tasks/{task_id}.
+     * @summary Batch Confirm Uploads
+     * @param {string} bucketIdentifier The unique identifier of the bucket
+     * @param {BatchConfirmRequest} batchConfirmRequest
+     * @param {string} [authorization] REQUIRED: Bearer token authentication using your API key. Format: \&#39;Bearer sk_xxxxxxxxxxxxx\&#39;. You can create API keys in the Mixpeek dashboard under Organization Settings.
+     * @param {string} [authorization2]
+     * @param {string} [xNamespace] REQUIRED: Namespace identifier for scoping this request. All resources (collections, buckets, taxonomies, etc.) are scoped to a namespace. You can provide either the namespace name or namespace ID. Format: ns_xxxxxxxxxxxxx (ID) or a custom name like \&#39;my-namespace\&#39;
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    confirmUploadsBatchBuckets(bucketIdentifier: string, batchConfirmRequest: BatchConfirmRequest, authorization?: string, authorization2?: string, xNamespace?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BatchConfirmResponse>>;
+    /**
+     * Generate a presigned URL for direct S3 upload.      This endpoint validates all requirements BEFORE generating the presigned URL,     ensuring immediate feedback if something is wrong (bucket inactive, quota exceeded, etc.).      **Duplicate Detection (Enabled by Default)**:     - If `file_hash` provided and `skip_duplicates=true`: Checks for existing upload     - If duplicate found: Returns existing upload (200 OK) with `is_duplicate=true`     - If new file: Returns presigned URL (201 Created) with `is_duplicate=false`      **Two-Step Flow**:     1. Call this endpoint → Get presigned URL     2. PUT file to presigned URL → Upload directly to S3     3. Call confirm endpoint → Verify upload and create object
+     * @summary Create Upload
+     * @param {string} bucketIdentifier The unique identifier of the bucket
+     * @param {CreateUploadRequest} createUploadRequest
+     * @param {string} [authorization] REQUIRED: Bearer token authentication using your API key. Format: \&#39;Bearer sk_xxxxxxxxxxxxx\&#39;. You can create API keys in the Mixpeek dashboard under Organization Settings.
+     * @param {string} [authorization2]
+     * @param {string} [xNamespace] REQUIRED: Namespace identifier for scoping this request. All resources (collections, buckets, taxonomies, etc.) are scoped to a namespace. You can provide either the namespace name or namespace ID. Format: ns_xxxxxxxxxxxxx (ID) or a custom name like \&#39;my-namespace\&#39;
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createUploadBuckets(bucketIdentifier: string, createUploadRequest: CreateUploadRequest, authorization?: string, authorization2?: string, xNamespace?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UploadResponse>>;
+    /**
+     * Generate multiple presigned URLs in a single request.      All uploads belong to the same bucket (from path parameter).     Maximum 100 uploads per batch.      Shared metadata is merged with individual upload metadata (individual takes precedence).
+     * @summary Batch Create Uploads
+     * @param {string} bucketIdentifier The unique identifier of the bucket
+     * @param {BatchUploadRequest} batchUploadRequest
+     * @param {string} [authorization] REQUIRED: Bearer token authentication using your API key. Format: \&#39;Bearer sk_xxxxxxxxxxxxx\&#39;. You can create API keys in the Mixpeek dashboard under Organization Settings.
+     * @param {string} [authorization2]
+     * @param {string} [xNamespace] REQUIRED: Namespace identifier for scoping this request. All resources (collections, buckets, taxonomies, etc.) are scoped to a namespace. You can provide either the namespace name or namespace ID. Format: ns_xxxxxxxxxxxxx (ID) or a custom name like \&#39;my-namespace\&#39;
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createUploadsBatchBuckets(bucketIdentifier: string, batchUploadRequest: BatchUploadRequest, authorization?: string, authorization2?: string, xNamespace?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BatchUploadResponse>>;
+    /**
+     * Cancel an upload and optionally delete the S3 object.      Cannot cancel uploads with status COMPLETED.     Can cancel uploads with status: PENDING, IN_PROGRESS, FAILED.
+     * @summary Delete Upload
+     * @param {string} bucketIdentifier The unique identifier of the bucket
+     * @param {string} uploadId The unique identifier of the upload
+     * @param {boolean} [deleteS3Object] Whether to delete the S3 object
+     * @param {string} [authorization] REQUIRED: Bearer token authentication using your API key. Format: \&#39;Bearer sk_xxxxxxxxxxxxx\&#39;. You can create API keys in the Mixpeek dashboard under Organization Settings.
+     * @param {string} [authorization2]
+     * @param {string} [xNamespace] REQUIRED: Namespace identifier for scoping this request. All resources (collections, buckets, taxonomies, etc.) are scoped to a namespace. You can provide either the namespace name or namespace ID. Format: ns_xxxxxxxxxxxxx (ID) or a custom name like \&#39;my-namespace\&#39;
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    deleteUploadBuckets(bucketIdentifier: string, uploadId: string, deleteS3Object?: boolean, authorization?: string, authorization2?: string, xNamespace?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
+    /**
+     * Retrieve an upload by its ID.      Use this to check upload status, get S3 key, or retrieve created object_id after confirmation.      **Presigned URLs**: Set `return_presigned_urls=true` query parameter to generate fresh presigned download URLs (default: false).     The presigned URLs expire after 1 hour and allow direct download from S3.
+     * @summary Get Upload
+     * @param {string} bucketIdentifier The unique identifier of the bucket
+     * @param {string} uploadId The unique identifier of the upload
+     * @param {boolean} [returnPresignedUrls] Generate fresh presigned download URLs for all blobs with S3 storage
+     * @param {string} [authorization] REQUIRED: Bearer token authentication using your API key. Format: \&#39;Bearer sk_xxxxxxxxxxxxx\&#39;. You can create API keys in the Mixpeek dashboard under Organization Settings.
+     * @param {string} [authorization2]
+     * @param {string} [xNamespace] REQUIRED: Namespace identifier for scoping this request. All resources (collections, buckets, taxonomies, etc.) are scoped to a namespace. You can provide either the namespace name or namespace ID. Format: ns_xxxxxxxxxxxxx (ID) or a custom name like \&#39;my-namespace\&#39;
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getUploadBuckets(bucketIdentifier: string, uploadId: string, returnPresignedUrls?: boolean, authorization?: string, authorization2?: string, xNamespace?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>;
+    /**
+     * List uploads in a bucket with filtering, sorting, search, and pagination.      **Filtering**: Use LogicalOperator with shorthand syntax     - Simple: `{\"status\": \"PENDING\", \"metadata.campaign\": \"summer_2024\"}`     - Complex: `{\"AND\": [{\"field\": \"file_size_bytes\", \"operator\": \"gte\", \"value\": 1000000}]}`      **Sorting**: Specify field and direction     - Example: `{\"field\": \"created_at\", \"direction\": \"desc\"}`      **Search**: Full-text search across filename and metadata     - Example: `\"search\": \"video\"`      **Pagination**: Use limit and offset     - Example: `\"limit\": 50, \"offset\": 100`
+     * @summary List Uploads
+     * @param {string} bucketIdentifier The unique identifier of the bucket
+     * @param {number} [limit]
+     * @param {number} [offset]
+     * @param {string} [cursor]
+     * @param {boolean} [includeTotal]
+     * @param {string} [authorization] REQUIRED: Bearer token authentication using your API key. Format: \&#39;Bearer sk_xxxxxxxxxxxxx\&#39;. You can create API keys in the Mixpeek dashboard under Organization Settings.
+     * @param {string} [authorization2]
+     * @param {string} [xNamespace] REQUIRED: Namespace identifier for scoping this request. All resources (collections, buckets, taxonomies, etc.) are scoped to a namespace. You can provide either the namespace name or namespace ID. Format: ns_xxxxxxxxxxxxx (ID) or a custom name like \&#39;my-namespace\&#39;
+     * @param {ListUploadsRequest} [listUploadsRequest]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listUploadsBuckets(bucketIdentifier: string, limit?: number, offset?: number, cursor?: string, includeTotal?: boolean, authorization?: string, authorization2?: string, xNamespace?: string, listUploadsRequest?: ListUploadsRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListUploadsResponse>>;
+};
+/**
+ * BucketUploadsApi - factory interface
+ * @export
+ */
+export declare const BucketUploadsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
+    /**
+     * Verify S3 upload completion and create bucket object.      After uploading to S3 using the presigned URL, call this endpoint to:     1. Verify the file exists in S3     2. Validate ETag and file size (if provided)     3. Create bucket object (default, unless create_object_on_confirm=false)     4. Update upload status to COMPLETED      **Sync vs Async**:     - Files < 100MB: Processed synchronously (~100ms)     - Files >= 100MB or async=true: Processed asynchronously (returns task_id)      **Duplicate Detection**:     - If file hash matches existing upload, marks as duplicate     - References original object_id if available
+     * @summary Confirm Upload
+     * @param {BucketUploadsApiConfirmUploadBucketsRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    confirmUploadBuckets(requestParameters: BucketUploadsApiConfirmUploadBucketsRequest, options?: RawAxiosRequestConfig): AxiosPromise<ConfirmUploadResponse>;
+    /**
+     * Confirm multiple uploads in a single request (processed asynchronously).      Maximum 100 confirmations per batch.     All uploads must belong to the same bucket.      Returns a task_id to track progress via GET /v1/tasks/{task_id}.
+     * @summary Batch Confirm Uploads
+     * @param {BucketUploadsApiConfirmUploadsBatchBucketsRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    confirmUploadsBatchBuckets(requestParameters: BucketUploadsApiConfirmUploadsBatchBucketsRequest, options?: RawAxiosRequestConfig): AxiosPromise<BatchConfirmResponse>;
+    /**
+     * Generate a presigned URL for direct S3 upload.      This endpoint validates all requirements BEFORE generating the presigned URL,     ensuring immediate feedback if something is wrong (bucket inactive, quota exceeded, etc.).      **Duplicate Detection (Enabled by Default)**:     - If `file_hash` provided and `skip_duplicates=true`: Checks for existing upload     - If duplicate found: Returns existing upload (200 OK) with `is_duplicate=true`     - If new file: Returns presigned URL (201 Created) with `is_duplicate=false`      **Two-Step Flow**:     1. Call this endpoint → Get presigned URL     2. PUT file to presigned URL → Upload directly to S3     3. Call confirm endpoint → Verify upload and create object
+     * @summary Create Upload
+     * @param {BucketUploadsApiCreateUploadBucketsRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createUploadBuckets(requestParameters: BucketUploadsApiCreateUploadBucketsRequest, options?: RawAxiosRequestConfig): AxiosPromise<UploadResponse>;
+    /**
+     * Generate multiple presigned URLs in a single request.      All uploads belong to the same bucket (from path parameter).     Maximum 100 uploads per batch.      Shared metadata is merged with individual upload metadata (individual takes precedence).
+     * @summary Batch Create Uploads
+     * @param {BucketUploadsApiCreateUploadsBatchBucketsRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createUploadsBatchBuckets(requestParameters: BucketUploadsApiCreateUploadsBatchBucketsRequest, options?: RawAxiosRequestConfig): AxiosPromise<BatchUploadResponse>;
+    /**
+     * Cancel an upload and optionally delete the S3 object.      Cannot cancel uploads with status COMPLETED.     Can cancel uploads with status: PENDING, IN_PROGRESS, FAILED.
+     * @summary Delete Upload
+     * @param {BucketUploadsApiDeleteUploadBucketsRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    deleteUploadBuckets(requestParameters: BucketUploadsApiDeleteUploadBucketsRequest, options?: RawAxiosRequestConfig): AxiosPromise<void>;
+    /**
+     * Retrieve an upload by its ID.      Use this to check upload status, get S3 key, or retrieve created object_id after confirmation.      **Presigned URLs**: Set `return_presigned_urls=true` query parameter to generate fresh presigned download URLs (default: false).     The presigned URLs expire after 1 hour and allow direct download from S3.
+     * @summary Get Upload
+     * @param {BucketUploadsApiGetUploadBucketsRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getUploadBuckets(requestParameters: BucketUploadsApiGetUploadBucketsRequest, options?: RawAxiosRequestConfig): AxiosPromise<any>;
+    /**
+     * List uploads in a bucket with filtering, sorting, search, and pagination.      **Filtering**: Use LogicalOperator with shorthand syntax     - Simple: `{\"status\": \"PENDING\", \"metadata.campaign\": \"summer_2024\"}`     - Complex: `{\"AND\": [{\"field\": \"file_size_bytes\", \"operator\": \"gte\", \"value\": 1000000}]}`      **Sorting**: Specify field and direction     - Example: `{\"field\": \"created_at\", \"direction\": \"desc\"}`      **Search**: Full-text search across filename and metadata     - Example: `\"search\": \"video\"`      **Pagination**: Use limit and offset     - Example: `\"limit\": 50, \"offset\": 100`
+     * @summary List Uploads
+     * @param {BucketUploadsApiListUploadsBucketsRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listUploadsBuckets(requestParameters: BucketUploadsApiListUploadsBucketsRequest, options?: RawAxiosRequestConfig): AxiosPromise<ListUploadsResponse>;
+};
+/**
+ * Request parameters for confirmUploadBuckets operation in BucketUploadsApi.
+ * @export
+ * @interface BucketUploadsApiConfirmUploadBucketsRequest
+ */
+export interface BucketUploadsApiConfirmUploadBucketsRequest {
+    /**
+     * The unique identifier of the bucket
+     * @type {string}
+     * @memberof BucketUploadsApiConfirmUploadBuckets
+     */
+    readonly bucketIdentifier: string;
+    /**
+     * The unique identifier of the upload
+     * @type {string}
+     * @memberof BucketUploadsApiConfirmUploadBuckets
+     */
+    readonly uploadId: string;
+    /**
+     *
+     * @type {ConfirmUploadRequest}
+     * @memberof BucketUploadsApiConfirmUploadBuckets
+     */
+    readonly confirmUploadRequest: ConfirmUploadRequest;
+    /**
+     * Process confirmation asynchronously (recommended for files &gt;&#x3D; 100MB)
+     * @type {boolean}
+     * @memberof BucketUploadsApiConfirmUploadBuckets
+     */
+    readonly async?: boolean;
+    /**
+     * REQUIRED: Bearer token authentication using your API key. Format: \&#39;Bearer sk_xxxxxxxxxxxxx\&#39;. You can create API keys in the Mixpeek dashboard under Organization Settings.
+     * @type {string}
+     * @memberof BucketUploadsApiConfirmUploadBuckets
+     */
+    readonly authorization?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof BucketUploadsApiConfirmUploadBuckets
+     */
+    readonly authorization2?: string;
+    /**
+     * REQUIRED: Namespace identifier for scoping this request. All resources (collections, buckets, taxonomies, etc.) are scoped to a namespace. You can provide either the namespace name or namespace ID. Format: ns_xxxxxxxxxxxxx (ID) or a custom name like \&#39;my-namespace\&#39;
+     * @type {string}
+     * @memberof BucketUploadsApiConfirmUploadBuckets
+     */
+    readonly xNamespace?: string;
+}
+/**
+ * Request parameters for confirmUploadsBatchBuckets operation in BucketUploadsApi.
+ * @export
+ * @interface BucketUploadsApiConfirmUploadsBatchBucketsRequest
+ */
+export interface BucketUploadsApiConfirmUploadsBatchBucketsRequest {
+    /**
+     * The unique identifier of the bucket
+     * @type {string}
+     * @memberof BucketUploadsApiConfirmUploadsBatchBuckets
+     */
+    readonly bucketIdentifier: string;
+    /**
+     *
+     * @type {BatchConfirmRequest}
+     * @memberof BucketUploadsApiConfirmUploadsBatchBuckets
+     */
+    readonly batchConfirmRequest: BatchConfirmRequest;
+    /**
+     * REQUIRED: Bearer token authentication using your API key. Format: \&#39;Bearer sk_xxxxxxxxxxxxx\&#39;. You can create API keys in the Mixpeek dashboard under Organization Settings.
+     * @type {string}
+     * @memberof BucketUploadsApiConfirmUploadsBatchBuckets
+     */
+    readonly authorization?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof BucketUploadsApiConfirmUploadsBatchBuckets
+     */
+    readonly authorization2?: string;
+    /**
+     * REQUIRED: Namespace identifier for scoping this request. All resources (collections, buckets, taxonomies, etc.) are scoped to a namespace. You can provide either the namespace name or namespace ID. Format: ns_xxxxxxxxxxxxx (ID) or a custom name like \&#39;my-namespace\&#39;
+     * @type {string}
+     * @memberof BucketUploadsApiConfirmUploadsBatchBuckets
+     */
+    readonly xNamespace?: string;
+}
+/**
+ * Request parameters for createUploadBuckets operation in BucketUploadsApi.
+ * @export
+ * @interface BucketUploadsApiCreateUploadBucketsRequest
+ */
+export interface BucketUploadsApiCreateUploadBucketsRequest {
+    /**
+     * The unique identifier of the bucket
+     * @type {string}
+     * @memberof BucketUploadsApiCreateUploadBuckets
+     */
+    readonly bucketIdentifier: string;
+    /**
+     *
+     * @type {CreateUploadRequest}
+     * @memberof BucketUploadsApiCreateUploadBuckets
+     */
+    readonly createUploadRequest: CreateUploadRequest;
+    /**
+     * REQUIRED: Bearer token authentication using your API key. Format: \&#39;Bearer sk_xxxxxxxxxxxxx\&#39;. You can create API keys in the Mixpeek dashboard under Organization Settings.
+     * @type {string}
+     * @memberof BucketUploadsApiCreateUploadBuckets
+     */
+    readonly authorization?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof BucketUploadsApiCreateUploadBuckets
+     */
+    readonly authorization2?: string;
+    /**
+     * REQUIRED: Namespace identifier for scoping this request. All resources (collections, buckets, taxonomies, etc.) are scoped to a namespace. You can provide either the namespace name or namespace ID. Format: ns_xxxxxxxxxxxxx (ID) or a custom name like \&#39;my-namespace\&#39;
+     * @type {string}
+     * @memberof BucketUploadsApiCreateUploadBuckets
+     */
+    readonly xNamespace?: string;
+}
+/**
+ * Request parameters for createUploadsBatchBuckets operation in BucketUploadsApi.
+ * @export
+ * @interface BucketUploadsApiCreateUploadsBatchBucketsRequest
+ */
+export interface BucketUploadsApiCreateUploadsBatchBucketsRequest {
+    /**
+     * The unique identifier of the bucket
+     * @type {string}
+     * @memberof BucketUploadsApiCreateUploadsBatchBuckets
+     */
+    readonly bucketIdentifier: string;
+    /**
+     *
+     * @type {BatchUploadRequest}
+     * @memberof BucketUploadsApiCreateUploadsBatchBuckets
+     */
+    readonly batchUploadRequest: BatchUploadRequest;
+    /**
+     * REQUIRED: Bearer token authentication using your API key. Format: \&#39;Bearer sk_xxxxxxxxxxxxx\&#39;. You can create API keys in the Mixpeek dashboard under Organization Settings.
+     * @type {string}
+     * @memberof BucketUploadsApiCreateUploadsBatchBuckets
+     */
+    readonly authorization?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof BucketUploadsApiCreateUploadsBatchBuckets
+     */
+    readonly authorization2?: string;
+    /**
+     * REQUIRED: Namespace identifier for scoping this request. All resources (collections, buckets, taxonomies, etc.) are scoped to a namespace. You can provide either the namespace name or namespace ID. Format: ns_xxxxxxxxxxxxx (ID) or a custom name like \&#39;my-namespace\&#39;
+     * @type {string}
+     * @memberof BucketUploadsApiCreateUploadsBatchBuckets
+     */
+    readonly xNamespace?: string;
+}
+/**
+ * Request parameters for deleteUploadBuckets operation in BucketUploadsApi.
+ * @export
+ * @interface BucketUploadsApiDeleteUploadBucketsRequest
+ */
+export interface BucketUploadsApiDeleteUploadBucketsRequest {
+    /**
+     * The unique identifier of the bucket
+     * @type {string}
+     * @memberof BucketUploadsApiDeleteUploadBuckets
+     */
+    readonly bucketIdentifier: string;
+    /**
+     * The unique identifier of the upload
+     * @type {string}
+     * @memberof BucketUploadsApiDeleteUploadBuckets
+     */
+    readonly uploadId: string;
+    /**
+     * Whether to delete the S3 object
+     * @type {boolean}
+     * @memberof BucketUploadsApiDeleteUploadBuckets
+     */
+    readonly deleteS3Object?: boolean;
+    /**
+     * REQUIRED: Bearer token authentication using your API key. Format: \&#39;Bearer sk_xxxxxxxxxxxxx\&#39;. You can create API keys in the Mixpeek dashboard under Organization Settings.
+     * @type {string}
+     * @memberof BucketUploadsApiDeleteUploadBuckets
+     */
+    readonly authorization?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof BucketUploadsApiDeleteUploadBuckets
+     */
+    readonly authorization2?: string;
+    /**
+     * REQUIRED: Namespace identifier for scoping this request. All resources (collections, buckets, taxonomies, etc.) are scoped to a namespace. You can provide either the namespace name or namespace ID. Format: ns_xxxxxxxxxxxxx (ID) or a custom name like \&#39;my-namespace\&#39;
+     * @type {string}
+     * @memberof BucketUploadsApiDeleteUploadBuckets
+     */
+    readonly xNamespace?: string;
+}
+/**
+ * Request parameters for getUploadBuckets operation in BucketUploadsApi.
+ * @export
+ * @interface BucketUploadsApiGetUploadBucketsRequest
+ */
+export interface BucketUploadsApiGetUploadBucketsRequest {
+    /**
+     * The unique identifier of the bucket
+     * @type {string}
+     * @memberof BucketUploadsApiGetUploadBuckets
+     */
+    readonly bucketIdentifier: string;
+    /**
+     * The unique identifier of the upload
+     * @type {string}
+     * @memberof BucketUploadsApiGetUploadBuckets
+     */
+    readonly uploadId: string;
+    /**
+     * Generate fresh presigned download URLs for all blobs with S3 storage
+     * @type {boolean}
+     * @memberof BucketUploadsApiGetUploadBuckets
+     */
+    readonly returnPresignedUrls?: boolean;
+    /**
+     * REQUIRED: Bearer token authentication using your API key. Format: \&#39;Bearer sk_xxxxxxxxxxxxx\&#39;. You can create API keys in the Mixpeek dashboard under Organization Settings.
+     * @type {string}
+     * @memberof BucketUploadsApiGetUploadBuckets
+     */
+    readonly authorization?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof BucketUploadsApiGetUploadBuckets
+     */
+    readonly authorization2?: string;
+    /**
+     * REQUIRED: Namespace identifier for scoping this request. All resources (collections, buckets, taxonomies, etc.) are scoped to a namespace. You can provide either the namespace name or namespace ID. Format: ns_xxxxxxxxxxxxx (ID) or a custom name like \&#39;my-namespace\&#39;
+     * @type {string}
+     * @memberof BucketUploadsApiGetUploadBuckets
+     */
+    readonly xNamespace?: string;
+}
+/**
+ * Request parameters for listUploadsBuckets operation in BucketUploadsApi.
+ * @export
+ * @interface BucketUploadsApiListUploadsBucketsRequest
+ */
+export interface BucketUploadsApiListUploadsBucketsRequest {
+    /**
+     * The unique identifier of the bucket
+     * @type {string}
+     * @memberof BucketUploadsApiListUploadsBuckets
+     */
+    readonly bucketIdentifier: string;
+    /**
+     *
+     * @type {number}
+     * @memberof BucketUploadsApiListUploadsBuckets
+     */
+    readonly limit?: number;
+    /**
+     *
+     * @type {number}
+     * @memberof BucketUploadsApiListUploadsBuckets
+     */
+    readonly offset?: number;
+    /**
+     *
+     * @type {string}
+     * @memberof BucketUploadsApiListUploadsBuckets
+     */
+    readonly cursor?: string;
+    /**
+     *
+     * @type {boolean}
+     * @memberof BucketUploadsApiListUploadsBuckets
+     */
+    readonly includeTotal?: boolean;
+    /**
+     * REQUIRED: Bearer token authentication using your API key. Format: \&#39;Bearer sk_xxxxxxxxxxxxx\&#39;. You can create API keys in the Mixpeek dashboard under Organization Settings.
+     * @type {string}
+     * @memberof BucketUploadsApiListUploadsBuckets
+     */
+    readonly authorization?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof BucketUploadsApiListUploadsBuckets
+     */
+    readonly authorization2?: string;
+    /**
+     * REQUIRED: Namespace identifier for scoping this request. All resources (collections, buckets, taxonomies, etc.) are scoped to a namespace. You can provide either the namespace name or namespace ID. Format: ns_xxxxxxxxxxxxx (ID) or a custom name like \&#39;my-namespace\&#39;
+     * @type {string}
+     * @memberof BucketUploadsApiListUploadsBuckets
+     */
+    readonly xNamespace?: string;
+    /**
+     *
+     * @type {ListUploadsRequest}
+     * @memberof BucketUploadsApiListUploadsBuckets
+     */
+    readonly listUploadsRequest?: ListUploadsRequest;
+}
+/**
+ * BucketUploadsApi - object-oriented interface
+ * @export
+ * @class BucketUploadsApi
+ * @extends {BaseAPI}
+ */
+export declare class BucketUploadsApi extends BaseAPI {
+    /**
+     * Verify S3 upload completion and create bucket object.      After uploading to S3 using the presigned URL, call this endpoint to:     1. Verify the file exists in S3     2. Validate ETag and file size (if provided)     3. Create bucket object (default, unless create_object_on_confirm=false)     4. Update upload status to COMPLETED      **Sync vs Async**:     - Files < 100MB: Processed synchronously (~100ms)     - Files >= 100MB or async=true: Processed asynchronously (returns task_id)      **Duplicate Detection**:     - If file hash matches existing upload, marks as duplicate     - References original object_id if available
+     * @summary Confirm Upload
+     * @param {BucketUploadsApiConfirmUploadBucketsRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof BucketUploadsApi
+     */
+    confirmUploadBuckets(requestParameters: BucketUploadsApiConfirmUploadBucketsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ConfirmUploadResponse, any, {}>>;
+    /**
+     * Confirm multiple uploads in a single request (processed asynchronously).      Maximum 100 confirmations per batch.     All uploads must belong to the same bucket.      Returns a task_id to track progress via GET /v1/tasks/{task_id}.
+     * @summary Batch Confirm Uploads
+     * @param {BucketUploadsApiConfirmUploadsBatchBucketsRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof BucketUploadsApi
+     */
+    confirmUploadsBatchBuckets(requestParameters: BucketUploadsApiConfirmUploadsBatchBucketsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<BatchConfirmResponse, any, {}>>;
+    /**
+     * Generate a presigned URL for direct S3 upload.      This endpoint validates all requirements BEFORE generating the presigned URL,     ensuring immediate feedback if something is wrong (bucket inactive, quota exceeded, etc.).      **Duplicate Detection (Enabled by Default)**:     - If `file_hash` provided and `skip_duplicates=true`: Checks for existing upload     - If duplicate found: Returns existing upload (200 OK) with `is_duplicate=true`     - If new file: Returns presigned URL (201 Created) with `is_duplicate=false`      **Two-Step Flow**:     1. Call this endpoint → Get presigned URL     2. PUT file to presigned URL → Upload directly to S3     3. Call confirm endpoint → Verify upload and create object
+     * @summary Create Upload
+     * @param {BucketUploadsApiCreateUploadBucketsRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof BucketUploadsApi
+     */
+    createUploadBuckets(requestParameters: BucketUploadsApiCreateUploadBucketsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<UploadResponse, any, {}>>;
+    /**
+     * Generate multiple presigned URLs in a single request.      All uploads belong to the same bucket (from path parameter).     Maximum 100 uploads per batch.      Shared metadata is merged with individual upload metadata (individual takes precedence).
+     * @summary Batch Create Uploads
+     * @param {BucketUploadsApiCreateUploadsBatchBucketsRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof BucketUploadsApi
+     */
+    createUploadsBatchBuckets(requestParameters: BucketUploadsApiCreateUploadsBatchBucketsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<BatchUploadResponse, any, {}>>;
+    /**
+     * Cancel an upload and optionally delete the S3 object.      Cannot cancel uploads with status COMPLETED.     Can cancel uploads with status: PENDING, IN_PROGRESS, FAILED.
+     * @summary Delete Upload
+     * @param {BucketUploadsApiDeleteUploadBucketsRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof BucketUploadsApi
+     */
+    deleteUploadBuckets(requestParameters: BucketUploadsApiDeleteUploadBucketsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
+    /**
+     * Retrieve an upload by its ID.      Use this to check upload status, get S3 key, or retrieve created object_id after confirmation.      **Presigned URLs**: Set `return_presigned_urls=true` query parameter to generate fresh presigned download URLs (default: false).     The presigned URLs expire after 1 hour and allow direct download from S3.
+     * @summary Get Upload
+     * @param {BucketUploadsApiGetUploadBucketsRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof BucketUploadsApi
+     */
+    getUploadBuckets(requestParameters: BucketUploadsApiGetUploadBucketsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<any, any, {}>>;
+    /**
+     * List uploads in a bucket with filtering, sorting, search, and pagination.      **Filtering**: Use LogicalOperator with shorthand syntax     - Simple: `{\"status\": \"PENDING\", \"metadata.campaign\": \"summer_2024\"}`     - Complex: `{\"AND\": [{\"field\": \"file_size_bytes\", \"operator\": \"gte\", \"value\": 1000000}]}`      **Sorting**: Specify field and direction     - Example: `{\"field\": \"created_at\", \"direction\": \"desc\"}`      **Search**: Full-text search across filename and metadata     - Example: `\"search\": \"video\"`      **Pagination**: Use limit and offset     - Example: `\"limit\": 50, \"offset\": 100`
+     * @summary List Uploads
+     * @param {BucketUploadsApiListUploadsBucketsRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof BucketUploadsApi
+     */
+    listUploadsBuckets(requestParameters: BucketUploadsApiListUploadsBucketsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ListUploadsResponse, any, {}>>;
+}
+//# sourceMappingURL=bucket-uploads-api.d.ts.map