mixpeek 0.81.1

package/dist/models/s3-role-credentials.d.ts

@@ -0,0 +1,41 @@
+/**
+ * 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.
+ */
+/**
+ * AWS S3 IAM role assumption credentials (RECOMMENDED for production).  IAM role assumption provides secure, temporary credentials for accessing customer S3 buckets without sharing long-lived access keys. This is the recommended authentication method for production deployments.  How It Works:     1. Customer creates an IAM role in their AWS account     2. Role trust policy allows Mixpeek AWS account to assume the role     3. External ID provides additional security against confused deputy attacks     4. Mixpeek assumes the role and receives temporary credentials (auto-renewed)     5. Temporary credentials are used to access the customer\'s S3 bucket  Prerequisites:     1. Create IAM role in customer AWS account     2. Attach policy granting s3:GetObject, s3:ListBucket permissions     3. Configure trust relationship to allow Mixpeek account     4. Use organization-specific external_id for security     5. Share role ARN with Mixpeek  Security Advantages:     - No long-lived credentials shared with third parties     - Temporary credentials automatically rotate (1-hour sessions by default)     - Customer retains full control and can revoke access anytime     - External ID prevents confused deputy attacks     - Audit trail in CloudTrail for all access  Use Cases:     - Production deployments accessing customer S3 buckets     - Enterprise integrations requiring strong security     - Multi-tenant environments with customer-owned storage     - Compliance-sensitive workloads (HIPAA, SOC 2, etc.)
+ * @export
+ * @interface S3RoleCredentials
+ */
+export interface S3RoleCredentials {
+    /**
+     *
+     * @type {string}
+     * @memberof S3RoleCredentials
+     */
+    'type'?: S3RoleCredentialsTypeEnum;
+    /**
+     * REQUIRED. Amazon Resource Name (ARN) of the IAM role to assume. This role must exist in the customer\'s AWS account and have a trust relationship configured to allow Mixpeek to assume it. Format: arn:aws:iam::{account-id}:role/{role-name} Example trust policy should allow principal: arn:aws:iam::{mixpeek-account}:root Recommended role name: mixpeek-storage-sync-role
+     * @type {string}
+     * @memberof S3RoleCredentials
+     */
+    'role_arn': string;
+    /**
+     * REQUIRED. External ID for secure role assumption (prevents confused deputy attacks). This value should be unique to your organization and kept confidential. Mixpeek provides this value during connection setup. Must match the ExternalId condition in the role\'s trust policy. Format: Recommended pattern is mixpeek-{organization_id} Security: Include this in the trust policy Condition statement
+     * @type {string}
+     * @memberof S3RoleCredentials
+     */
+    'external_id': string;
+}
+export declare const S3RoleCredentialsTypeEnum: {
+    readonly IamRole: "iam_role";
+};
+export type S3RoleCredentialsTypeEnum = typeof S3RoleCredentialsTypeEnum[keyof typeof S3RoleCredentialsTypeEnum];
+//# sourceMappingURL=s3-role-credentials.d.ts.map

package/dist/models/s3-role-credentials.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"s3-role-credentials.d.ts","sourceRoot":"","sources":["../../models/s3-role-credentials.ts"],"names":[],"mappings":"AAEA;;;;;;;;;;GAUG;AAIH;;;;GAIG;AACH,MAAM,WAAW,iBAAiB;IAC9B;;;;OAIG;IACH,MAAM,CAAC,EAAE,yBAAyB,CAAC;IACnC;;;;OAIG;IACH,UAAU,EAAE,MAAM,CAAC;IACnB;;;;OAIG;IACH,aAAa,EAAE,MAAM,CAAC;CACzB;AAED,eAAO,MAAM,yBAAyB;;CAE5B,CAAC;AAEX,MAAM,MAAM,yBAAyB,GAAG,OAAO,yBAAyB,CAAC,MAAM,OAAO,yBAAyB,CAAC,CAAC"}

package/dist/models/s3-tag-source.d.ts

@@ -0,0 +1,35 @@
+/**
+ * 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.
+ */
+/**
+ * Extract value from an S3/Tigris object tag.  S3 object tags are key-value pairs attached to objects, commonly used for categorization, cost allocation, and metadata. Tags are limited to 10 per object with keys up to 128 chars and values up to 256 chars.  Provider Compatibility: S3, Tigris, MinIO, DigitalOcean Spaces, Wasabi  Example S3 CLI to set tag:     aws s3api put-object-tagging --bucket my-bucket --key video.mp4 \\         --tagging \'TagSet=[{Key=category,Value=marketing}]\'  Example mapping:     {\"type\": \"tag\", \"key\": \"category\"} -> extracts \"marketing\" from the tag  Attributes:     type: Must be \"tag\" to identify this source type     key: The tag key to extract (case-sensitive, max 128 chars)
+ * @export
+ * @interface S3TagSource
+ */
+export interface S3TagSource {
+    /**
+     * Source type identifier. Must be \'tag\' for S3/Tigris object tags.
+     * @type {string}
+     * @memberof S3TagSource
+     */
+    'type'?: S3TagSourceTypeEnum;
+    /**
+     * The tag key to extract. Case-sensitive. Must match the exact tag key on the S3/Tigris object. Common examples: \'category\', \'project\', \'owner\', \'environment\'. Maximum length: 128 characters.
+     * @type {string}
+     * @memberof S3TagSource
+     */
+    'key': string;
+}
+export declare const S3TagSourceTypeEnum: {
+    readonly Tag: "tag";
+};
+export type S3TagSourceTypeEnum = typeof S3TagSourceTypeEnum[keyof typeof S3TagSourceTypeEnum];
+//# sourceMappingURL=s3-tag-source.d.ts.map

package/dist/models/s3-tag-source.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"s3-tag-source.d.ts","sourceRoot":"","sources":["../../models/s3-tag-source.ts"],"names":[],"mappings":"AAEA;;;;;;;;;;GAUG;AAIH;;;;GAIG;AACH,MAAM,WAAW,WAAW;IACxB;;;;OAIG;IACH,MAAM,CAAC,EAAE,mBAAmB,CAAC;IAC7B;;;;OAIG;IACH,KAAK,EAAE,MAAM,CAAC;CACjB;AAED,eAAO,MAAM,mBAAmB;;CAEtB,CAAC;AAEX,MAAM,MAAM,mBAAmB,GAAG,OAAO,mBAAmB,CAAC,MAAM,OAAO,mBAAmB,CAAC,CAAC"}

package/dist/models/schema-mapping-input.d.ts

@@ -0,0 +1,28 @@
+/**
+ * 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 { MappingsValue } from './mappings-value';
+/**
+ * Complete schema mapping configuration for a sync.  Defines how source data (files, tags, metadata, columns) maps to the target bucket schema. Each key is a target field/blob name in the bucket.  **Key Concepts:** - Keys are target bucket schema field names - Values define the source and extraction method - At least one blob mapping is typically required for file syncs - Field mappings extract metadata alongside the file content  **Provider Examples:**  **S3/Tigris Video Sync:** ```json {     \"content\": {         \"target_type\": \"blob\",         \"source\": {\"type\": \"file\"},         \"blob_type\": \"video\"     },     \"category\": {         \"target_type\": \"field\",         \"source\": {\"type\": \"tag\", \"key\": \"category\"}     },     \"source_bucket\": {         \"target_type\": \"field\",         \"source\": {\"type\": \"constant\", \"value\": \"production-videos\"}     } } ```  **Snowflake Customer Table Sync:** ```json {     \"customer_name\": {         \"target_type\": \"field\",         \"source\": {\"type\": \"column\", \"name\": \"NAME\"}     },     \"profile_image\": {         \"target_type\": \"blob\",         \"source\": {\"type\": \"column\", \"name\": \"AVATAR_URL\"},         \"blob_type\": \"image\"     },     \"segment\": {         \"target_type\": \"field\",         \"source\": {\"type\": \"column\", \"name\": \"CUSTOMER_SEGMENT\"},         \"transform\": \"lowercase\"     } } ```  **Google Drive with Folder Categories:** ```json {     \"content\": {         \"target_type\": \"blob\",         \"source\": {\"type\": \"file\"},         \"blob_type\": \"auto\"     },     \"department\": {         \"target_type\": \"field\",         \"source\": {\"type\": \"folder_path\", \"segment\": 0},         \"transform\": \"lowercase\"     },     \"description\": {         \"target_type\": \"field\",         \"source\": {\"type\": \"drive_property\", \"key\": \"description\"}     } } ```  Attributes:     mappings: Dictionary mapping target field names to their source extractors
+ * @export
+ * @interface SchemaMappingInput
+ */
+export interface SchemaMappingInput {
+    /**
+     * Dictionary mapping target field names to their source extractors. Keys are bucket schema field names (e.g., \'content\', \'category\'). Values are mapping entries defining how to extract and store the data. At least one blob mapping (target_type=\'blob\') is recommended for file syncs.
+     * @type {{ [key: string]: MappingsValue; }}
+     * @memberof SchemaMappingInput
+     */
+    'mappings': {
+        [key: string]: MappingsValue;
+    };
+}
+//# sourceMappingURL=schema-mapping-input.d.ts.map

package/dist/models/schema-mapping-input.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"schema-mapping-input.d.ts","sourceRoot":"","sources":["../../models/schema-mapping-input.ts"],"names":[],"mappings":"AAEA;;;;;;;;;;GAUG;AAKH,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,kBAAkB,CAAC;AAEtD;;;;GAIG;AACH,MAAM,WAAW,kBAAkB;IAC/B;;;;OAIG;IACH,UAAU,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,aAAa,CAAC;KAAE,CAAC;CACjD"}

package/dist/models/schema-mapping-output.d.ts

@@ -0,0 +1,28 @@
+/**
+ * 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 { MappingsValue } from './mappings-value';
+/**
+ * Complete schema mapping configuration for a sync.  Defines how source data (files, tags, metadata, columns) maps to the target bucket schema. Each key is a target field/blob name in the bucket.  **Key Concepts:** - Keys are target bucket schema field names - Values define the source and extraction method - At least one blob mapping is typically required for file syncs - Field mappings extract metadata alongside the file content  **Provider Examples:**  **S3/Tigris Video Sync:** ```json {     \"content\": {         \"target_type\": \"blob\",         \"source\": {\"type\": \"file\"},         \"blob_type\": \"video\"     },     \"category\": {         \"target_type\": \"field\",         \"source\": {\"type\": \"tag\", \"key\": \"category\"}     },     \"source_bucket\": {         \"target_type\": \"field\",         \"source\": {\"type\": \"constant\", \"value\": \"production-videos\"}     } } ```  **Snowflake Customer Table Sync:** ```json {     \"customer_name\": {         \"target_type\": \"field\",         \"source\": {\"type\": \"column\", \"name\": \"NAME\"}     },     \"profile_image\": {         \"target_type\": \"blob\",         \"source\": {\"type\": \"column\", \"name\": \"AVATAR_URL\"},         \"blob_type\": \"image\"     },     \"segment\": {         \"target_type\": \"field\",         \"source\": {\"type\": \"column\", \"name\": \"CUSTOMER_SEGMENT\"},         \"transform\": \"lowercase\"     } } ```  **Google Drive with Folder Categories:** ```json {     \"content\": {         \"target_type\": \"blob\",         \"source\": {\"type\": \"file\"},         \"blob_type\": \"auto\"     },     \"department\": {         \"target_type\": \"field\",         \"source\": {\"type\": \"folder_path\", \"segment\": 0},         \"transform\": \"lowercase\"     },     \"description\": {         \"target_type\": \"field\",         \"source\": {\"type\": \"drive_property\", \"key\": \"description\"}     } } ```  Attributes:     mappings: Dictionary mapping target field names to their source extractors
+ * @export
+ * @interface SchemaMappingOutput
+ */
+export interface SchemaMappingOutput {
+    /**
+     * Dictionary mapping target field names to their source extractors. Keys are bucket schema field names (e.g., \'content\', \'category\'). Values are mapping entries defining how to extract and store the data. At least one blob mapping (target_type=\'blob\') is recommended for file syncs.
+     * @type {{ [key: string]: MappingsValue; }}
+     * @memberof SchemaMappingOutput
+     */
+    'mappings': {
+        [key: string]: MappingsValue;
+    };
+}
+//# sourceMappingURL=schema-mapping-output.d.ts.map

package/dist/models/schema-mapping-output.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"schema-mapping-output.d.ts","sourceRoot":"","sources":["../../models/schema-mapping-output.ts"],"names":[],"mappings":"AAEA;;;;;;;;;;GAUG;AAKH,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,kBAAkB,CAAC;AAEtD;;;;GAIG;AACH,MAAM,WAAW,mBAAmB;IAChC;;;;OAIG;IACH,UAAU,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,aAAa,CAAC;KAAE,CAAC;CACjD"}

package/dist/models/schema-sync-request.d.ts

@@ -0,0 +1,37 @@
+/**
+ * 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.
+ */
+/**
+ * Request to sync a collection\'s schema by sampling documents.  Used by: - Manual API calls from users - Automatic triggers from BatchJobPoller
+ * @export
+ * @interface SchemaSyncRequest
+ */
+export interface SchemaSyncRequest {
+    /**
+     * Number of documents to sample for schema discovery
+     * @type {number}
+     * @memberof SchemaSyncRequest
+     */
+    'sample_size'?: number;
+    /**
+     * Force schema sync even if within debounce window. Default: false (respects 5-minute debounce)
+     * @type {boolean}
+     * @memberof SchemaSyncRequest
+     */
+    'force'?: boolean;
+    /**
+     * Automatically update downstream collections that use this collection as source. Default: true
+     * @type {boolean}
+     * @memberof SchemaSyncRequest
+     */
+    'cascade_to_downstream'?: boolean;
+}
+//# sourceMappingURL=schema-sync-request.d.ts.map

package/dist/models/schema-sync-request.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"schema-sync-request.d.ts","sourceRoot":"","sources":["../../models/schema-sync-request.ts"],"names":[],"mappings":"AAEA;;;;;;;;;;GAUG;AAIH;;;;GAIG;AACH,MAAM,WAAW,iBAAiB;IAC9B;;;;OAIG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB;;;;OAIG;IACH,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB;;;;OAIG;IACH,uBAAuB,CAAC,EAAE,OAAO,CAAC;CACrC"}

package/dist/models/schema-sync-response.d.ts

@@ -0,0 +1,73 @@
+/**
+ * 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.
+ */
+/**
+ * Response from schema sync operation.
+ * @export
+ * @interface SchemaSyncResponse
+ */
+export interface SchemaSyncResponse {
+    /**
+     * Whether schema sync succeeded
+     * @type {boolean}
+     * @memberof SchemaSyncResponse
+     */
+    'success': boolean;
+    /**
+     * Collection that was synced
+     * @type {string}
+     * @memberof SchemaSyncResponse
+     */
+    'collection_id': string;
+    /**
+     * New schema version
+     * @type {number}
+     * @memberof SchemaSyncResponse
+     */
+    'schema_version': number;
+    /**
+     * Previous schema version
+     * @type {number}
+     * @memberof SchemaSyncResponse
+     */
+    'previous_version': number;
+    /**
+     * List of new fields discovered
+     * @type {Array<string>}
+     * @memberof SchemaSyncResponse
+     */
+    'fields_added'?: Array<string>;
+    /**
+     * Total fields in output_schema
+     * @type {number}
+     * @memberof SchemaSyncResponse
+     */
+    'fields_total': number;
+    /**
+     * Number of documents sampled
+     * @type {number}
+     * @memberof SchemaSyncResponse
+     */
+    'documents_sampled': number;
+    /**
+     * Downstream collections that were updated
+     * @type {Array<string>}
+     * @memberof SchemaSyncResponse
+     */
+    'downstream_collections_updated'?: Array<string>;
+    /**
+     * Additional message or error
+     * @type {string}
+     * @memberof SchemaSyncResponse
+     */
+    'message'?: string;
+}
+//# sourceMappingURL=schema-sync-response.d.ts.map

package/dist/models/schema-sync-response.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"schema-sync-response.d.ts","sourceRoot":"","sources":["../../models/schema-sync-response.ts"],"names":[],"mappings":"AAEA;;;;;;;;;;GAUG;AAIH;;;;GAIG;AACH,MAAM,WAAW,kBAAkB;IAC/B;;;;OAIG;IACH,SAAS,EAAE,OAAO,CAAC;IACnB;;;;OAIG;IACH,eAAe,EAAE,MAAM,CAAC;IACxB;;;;OAIG;IACH,gBAAgB,EAAE,MAAM,CAAC;IACzB;;;;OAIG;IACH,kBAAkB,EAAE,MAAM,CAAC;IAC3B;;;;OAIG;IACH,cAAc,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAC/B;;;;OAIG;IACH,cAAc,EAAE,MAAM,CAAC;IACvB;;;;OAIG;IACH,mBAAmB,EAAE,MAAM,CAAC;IAC5B;;;;OAIG;IACH,gCAAgC,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IACjD;;;;OAIG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;CACtB"}

package/dist/models/schema-sync-skipped-response.d.ts

@@ -0,0 +1,55 @@
+/**
+ * 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.
+ */
+/**
+ * Response when schema sync was skipped (debounce or disabled).
+ * @export
+ * @interface SchemaSyncSkippedResponse
+ */
+export interface SchemaSyncSkippedResponse {
+    /**
+     * Request succeeded
+     * @type {boolean}
+     * @memberof SchemaSyncSkippedResponse
+     */
+    'success'?: boolean;
+    /**
+     * Schema sync was skipped
+     * @type {boolean}
+     * @memberof SchemaSyncSkippedResponse
+     */
+    'skipped'?: boolean;
+    /**
+     * Why sync was skipped
+     * @type {string}
+     * @memberof SchemaSyncSkippedResponse
+     */
+    'reason': string;
+    /**
+     * Collection ID
+     * @type {string}
+     * @memberof SchemaSyncSkippedResponse
+     */
+    'collection_id': string;
+    /**
+     * Current schema version
+     * @type {number}
+     * @memberof SchemaSyncSkippedResponse
+     */
+    'schema_version': number;
+    /**
+     * Last sync timestamp
+     * @type {string}
+     * @memberof SchemaSyncSkippedResponse
+     */
+    'last_sync'?: string;
+}
+//# sourceMappingURL=schema-sync-skipped-response.d.ts.map

package/dist/models/schema-sync-skipped-response.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"schema-sync-skipped-response.d.ts","sourceRoot":"","sources":["../../models/schema-sync-skipped-response.ts"],"names":[],"mappings":"AAEA;;;;;;;;;;GAUG;AAIH;;;;GAIG;AACH,MAAM,WAAW,yBAAyB;IACtC;;;;OAIG;IACH,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB;;;;OAIG;IACH,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB;;;;OAIG;IACH,QAAQ,EAAE,MAAM,CAAC;IACjB;;;;OAIG;IACH,eAAe,EAAE,MAAM,CAAC;IACxB;;;;OAIG;IACH,gBAAgB,EAAE,MAAM,CAAC;IACzB;;;;OAIG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;CACxB"}

package/dist/models/scroll-pagination-params.d.ts

@@ -0,0 +1,44 @@
+/**
+ * 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 { PaginationMethod } from './pagination-method';
+/**
+ * Scroll-style pagination maintaining server-side context for TTL.  Best for: Bulk exports, batch processing, iterating through all results  How it works: - Server maintains a snapshot of results - First request: scroll_id=null, returns scroll_id - Subsequent requests: use scroll_id from response - Context expires after scroll_ttl seconds - Consistent view of data (point-in-time snapshot)  Tradeoffs: - Requires server-side state (memory/cache) - TTL means sessions can expire - Not suitable for long-lived sessions - Good for background jobs, not user-facing UIs  Use when: - Exporting large datasets - Batch processing all results - Background jobs iterating through results - You need consistent point-in-time view  Example flow: 1. Request: {\"method\": \"scroll\", \"limit\": 100, \"scroll_id\": null} 2. Response: {\"documents\": [...], \"scroll_id\": \"xyz789\", \"has_next\": true} 3. Request: {\"method\": \"scroll\", \"limit\": 100, \"scroll_id\": \"xyz789\"}
+ * @export
+ * @interface ScrollPaginationParams
+ */
+export interface ScrollPaginationParams {
+    /**
+     * Constant identifying scroll pagination (REQUIRED).
+     * @type {PaginationMethod}
+     * @memberof ScrollPaginationParams
+     */
+    'method'?: PaginationMethod;
+    /**
+     * Number of documents to fetch per scroll page (REQUIRED). Default: 100.
+     * @type {number}
+     * @memberof ScrollPaginationParams
+     */
+    'limit'?: number;
+    /**
+     * Server-issued scroll session identifier (OPTIONAL). null for first request, then use scroll_id from response
+     * @type {string}
+     * @memberof ScrollPaginationParams
+     */
+    'scroll_id'?: string;
+    /**
+     * Seconds to keep scroll context alive (REQUIRED). Default: 300 (5 minutes).
+     * @type {number}
+     * @memberof ScrollPaginationParams
+     */
+    'scroll_ttl'?: number;
+}
+//# sourceMappingURL=scroll-pagination-params.d.ts.map

package/dist/models/scroll-pagination-params.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"scroll-pagination-params.d.ts","sourceRoot":"","sources":["../../models/scroll-pagination-params.ts"],"names":[],"mappings":"AAEA;;;;;;;;;;GAUG;AAKH,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,qBAAqB,CAAC;AAE5D;;;;GAIG;AACH,MAAM,WAAW,sBAAsB;IACnC;;;;OAIG;IACH,QAAQ,CAAC,EAAE,gBAAgB,CAAC;IAC5B;;;;OAIG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB;;;;OAIG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB;;;;OAIG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;CACzB"}

package/dist/models/search-interaction.d.ts

@@ -0,0 +1,90 @@
+/**
+ * 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 { InteractionType } from './interaction-type';
+/**
+ * Records a user interaction with a search result.  This model captures user behavior signals that can be used to improve retrieval quality. Each interaction represents a user action (click, view, feedback) on a specific document returned by a retriever.  Use Cases:     - Track which search results users actually click on     - Collect explicit feedback (thumbs up/down) on result quality     - Monitor engagement metrics (time spent viewing, sharing)     - Identify problematic queries (zero results, immediate refinements)     - Power Learning to Rank models with real user behavior  Requirements:     - feature_id: REQUIRED - The document/feature that was interacted with     - interaction_type: REQUIRED - Type(s) of interaction that occurred     - position: REQUIRED - Where in results list the interaction occurred (for LTR)     - query_snapshot: HIGHLY RECOMMENDED - Query input for training optimization     - document_score: HIGHLY RECOMMENDED - Initial score for LTR training     - result_set_size: OPTIONAL - Total results shown (for context)     - metadata: OPTIONAL - Additional context about the interaction     - user_id: OPTIONAL - For personalization and user-specific metrics     - session_id: OPTIONAL - For tracking multi-query sessions     - execution_id: OPTIONAL - Link to full execution context     - retriever_id: OPTIONAL - For multi-retriever analytics  Related Concepts:     - Retrievers: Interactions measure retriever performance     - Evaluations: Interactions provide real-world complement to offline evaluation     - Learning to Rank: Interactions train ranking models
+ * @export
+ * @interface SearchInteraction
+ */
+export interface SearchInteraction {
+    /**
+     * ID of the document/feature that was interacted with. REQUIRED. This should be the document_id returned in retriever results. Used to track which specific items users engage with.
+     * @type {string}
+     * @memberof SearchInteraction
+     */
+    'feature_id': string;
+    /**
+     * List of interaction types that occurred. REQUIRED. Multiple types can be recorded simultaneously (e.g., VIEW + CLICK + LONG_VIEW for a result the user engaged with). Use the InteractionType enum values.
+     * @type {Array<InteractionType>}
+     * @memberof SearchInteraction
+     */
+    'interaction_type': Array<InteractionType>;
+    /**
+     * Position in search results where interaction occurred (0-indexed). REQUIRED. Critical for Learning to Rank - helps identify position bias. E.g., position=0 means first result, position=9 means 10th result. Higher engagement at lower positions suggests higher quality.
+     * @type {number}
+     * @memberof SearchInteraction
+     */
+    'position': number;
+    /**
+     * Additional context about the interaction. NOT REQUIRED. Can include device, duration, viewport info, etc. Use this to enrich interaction data with application-specific context.
+     * @type {{ [key: string]: any; }}
+     * @memberof SearchInteraction
+     */
+    'metadata'?: {
+        [key: string]: any;
+    };
+    /**
+     * Customer\'s authenticated user identifier. NOT REQUIRED. Persists across sessions for long-term tracking. Enables personalization and user-specific metrics. Use your application\'s user ID format.
+     * @type {string}
+     * @memberof SearchInteraction
+     */
+    'user_id'?: string;
+    /**
+     * Temporary identifier for a single search session. NOT REQUIRED. Typically 30min-1hr duration. Tracks anonymous and authenticated users within a session. Use to group related queries and understand search journeys.
+     * @type {string}
+     * @memberof SearchInteraction
+     */
+    'session_id'?: string;
+    /**
+     * ID of the retriever execution that generated these results. NOT REQUIRED but HIGHLY RECOMMENDED for training and optimization. Links the interaction back to the exact search query, pipeline configuration, and stage execution that produced the results the user saw. Essential for: fine-tuning embeddings, training rerankers, query understanding, and tracing which pipeline configs produce better user engagement. Retrieve from the retriever execution response and pass to interactions.
+     * @type {string}
+     * @memberof SearchInteraction
+     */
+    'execution_id'?: string;
+    /**
+     * ID of the retriever that was executed. NOT REQUIRED but RECOMMENDED for multi-retriever analytics. Enables comparing performance across different retriever configurations. If execution_id is provided, retriever_id can be inferred from the execution record.
+     * @type {string}
+     * @memberof SearchInteraction
+     */
+    'retriever_id'?: string;
+    /**
+     * Snapshot of the query input that generated these results. HIGHLY RECOMMENDED for training optimization. Storing the query directly enables 10-100x faster training data extraction by avoiding expensive joins to execution records. Use the same format as retriever query input (e.g., {\'text\': \'...\', \'filters\': {...}}). Essential for: embedding fine-tuning (query-document pairs), query expansion learning, and analyzing which query patterns lead to better engagement. NOT REQUIRED but strongly recommended for production use cases involving model training.
+     * @type {{ [key: string]: any; }}
+     * @memberof SearchInteraction
+     */
+    'query_snapshot'?: {
+        [key: string]: any;
+    };
+    /**
+     * Initial retrieval score of this document when shown to the user. HIGHLY RECOMMENDED for Learning to Rank (LTR). This is a critical feature for reranker training - helps the model learn how to adjust initial scores based on user engagement. Should match the score from the retriever execution results. NOT REQUIRED but strongly recommended for LTR and reranker training.
+     * @type {number}
+     * @memberof SearchInteraction
+     */
+    'document_score'?: number;
+    /**
+     * Total number of results shown to the user in this search. NOT REQUIRED but useful for context. Helps understand interaction patterns - clicking position 5 of 10 results is different from position 5 of 100 results. Useful for position bias correction and CTR analysis.
+     * @type {number}
+     * @memberof SearchInteraction
+     */
+    'result_set_size'?: number;
+}
+//# sourceMappingURL=search-interaction.d.ts.map

package/dist/models/search-interaction.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"search-interaction.d.ts","sourceRoot":"","sources":["../../models/search-interaction.ts"],"names":[],"mappings":"AAEA;;;;;;;;;;GAUG;AAKH,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,oBAAoB,CAAC;AAE1D;;;;GAIG;AACH,MAAM,WAAW,iBAAiB;IAC9B;;;;OAIG;IACH,YAAY,EAAE,MAAM,CAAC;IACrB;;;;OAIG;IACH,kBAAkB,EAAE,KAAK,CAAC,eAAe,CAAC,CAAC;IAC3C;;;;OAIG;IACH,UAAU,EAAE,MAAM,CAAC;IACnB;;;;OAIG;IACH,UAAU,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAC;KAAE,CAAC;IACrC;;;;OAIG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB;;;;OAIG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB;;;;OAIG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB;;;;OAIG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB;;;;OAIG;IACH,gBAAgB,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAC;KAAE,CAAC;IAC3C;;;;OAIG;IACH,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B;;;;OAIG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;CAC9B"}

package/dist/models/search-request.d.ts

@@ -0,0 +1,53 @@
+/**
+ * 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.
+ */
+/**
+ * Request model for searching across resource names and IDs.  Search is performed across all resource types within the authenticated namespace. The search is case-insensitive and supports partial matching on both names and IDs.  Use Cases:     - Find resources by partial name match     - Locate resources by ID prefix     - Filter search to specific resource types     - Paginate through large result sets  Requirements:     - query: REQUIRED - Search term (minimum 1 character)     - resource_types: OPTIONAL - Filter by specific types     - limit: OPTIONAL - Results per page (1-100, default 20)     - offset: OPTIONAL - Pagination offset (default 0)
+ * @export
+ * @interface SearchRequest
+ */
+export interface SearchRequest {
+    /**
+     * Search term to match against resource names and IDs. REQUIRED. Minimum 1 character. Case-insensitive partial matching is performed. Matches against: bucket_name, bucket_id, collection_name, collection_id, retriever_name, retriever_id, taxonomy_name, taxonomy_id, cluster_name, cluster_id, namespace_name, namespace_id. Example: \'prod\' matches \'production-videos\', \'bkt_prod123\', \'Products Collection\'.
+     * @type {string}
+     * @memberof SearchRequest
+     */
+    'query': string;
+    /**
+     * Filter search to specific resource types. OPTIONAL - If not provided, searches all resource types. Valid values: \'bucket\', \'collection\', \'retriever\', \'taxonomy\', \'cluster\', \'published_retriever\', \'namespace\'. Example: [\'bucket\', \'collection\'] searches only buckets and collections.
+     * @type {Array<string>}
+     * @memberof SearchRequest
+     */
+    'resource_types'?: Array<SearchRequestResourceTypesEnum>;
+    /**
+     * Maximum number of results to return. OPTIONAL - Defaults to 20. Minimum: 1, Maximum: 100. Use with offset for pagination.
+     * @type {number}
+     * @memberof SearchRequest
+     */
+    'limit'?: number;
+    /**
+     * Number of results to skip for pagination. OPTIONAL - Defaults to 0. Minimum: 0. Use with limit for pagination. Example: offset=20 with limit=20 returns results 21-40.
+     * @type {number}
+     * @memberof SearchRequest
+     */
+    'offset'?: number;
+}
+export declare const SearchRequestResourceTypesEnum: {
+    readonly Bucket: "bucket";
+    readonly Collection: "collection";
+    readonly Retriever: "retriever";
+    readonly Taxonomy: "taxonomy";
+    readonly Cluster: "cluster";
+    readonly PublishedRetriever: "published_retriever";
+    readonly Namespace: "namespace";
+};
+export type SearchRequestResourceTypesEnum = typeof SearchRequestResourceTypesEnum[keyof typeof SearchRequestResourceTypesEnum];
+//# sourceMappingURL=search-request.d.ts.map

package/dist/models/search-request.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"search-request.d.ts","sourceRoot":"","sources":["../../models/search-request.ts"],"names":[],"mappings":"AAEA;;;;;;;;;;GAUG;AAIH;;;;GAIG;AACH,MAAM,WAAW,aAAa;IAC1B;;;;OAIG;IACH,OAAO,EAAE,MAAM,CAAC;IAChB;;;;OAIG;IACH,gBAAgB,CAAC,EAAE,KAAK,CAAC,8BAA8B,CAAC,CAAC;IACzD;;;;OAIG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB;;;;OAIG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;CACrB;AAED,eAAO,MAAM,8BAA8B;;;;;;;;CAQjC,CAAC;AAEX,MAAM,MAAM,8BAA8B,GAAG,OAAO,8BAA8B,CAAC,MAAM,OAAO,8BAA8B,CAAC,CAAC"}

package/dist/models/search-response.d.ts

@@ -0,0 +1,44 @@
+/**
+ * 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 { SearchResultItem } from './search-result-item';
+/**
+ * Response model for resource search results.  Contains paginated search results with metadata about total matches and pagination state. Results are sorted by relevance (exact matches first, then partial matches) and creation time (newest first).  Use Cases:     - Display search results to users     - Implement pagination UI     - Show total result counts     - Navigate through large result sets  Fields:     - results: List of matched resources     - total: Total number of matches (before pagination)     - limit: Results per page (from request)     - offset: Current pagination offset (from request)
+ * @export
+ * @interface SearchResponse
+ */
+export interface SearchResponse {
+    /**
+     * List of matched resources. REQUIRED. May be empty if no matches found. Sorted by: 1) Exact matches first, 2) Partial matches, 3) Created timestamp descending. Length is min(total - offset, limit). Each result contains full resource metadata for display.
+     * @type {Array<SearchResultItem>}
+     * @memberof SearchResponse
+     */
+    'results': Array<SearchResultItem>;
+    /**
+     * Total number of matches across all pages. REQUIRED. Count before pagination is applied. Use to calculate total pages: ceil(total / limit). May be 0 if no matches found. Example: total=50 with limit=20 means 3 pages of results.
+     * @type {number}
+     * @memberof SearchResponse
+     */
+    'total': number;
+    /**
+     * Results per page (from request). REQUIRED. Echo of the limit parameter from the request. Range: 1-100.
+     * @type {number}
+     * @memberof SearchResponse
+     */
+    'limit': number;
+    /**
+     * Current pagination offset (from request). REQUIRED. Echo of the offset parameter from the request. Number of results skipped. Example: offset=20 means results start from the 21st match.
+     * @type {number}
+     * @memberof SearchResponse
+     */
+    'offset': number;
+}
+//# sourceMappingURL=search-response.d.ts.map

package/dist/models/search-response.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"search-response.d.ts","sourceRoot":"","sources":["../../models/search-response.ts"],"names":[],"mappings":"AAEA;;;;;;;;;;GAUG;AAKH,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,sBAAsB,CAAC;AAE7D;;;;GAIG;AACH,MAAM,WAAW,cAAc;IAC3B;;;;OAIG;IACH,SAAS,EAAE,KAAK,CAAC,gBAAgB,CAAC,CAAC;IACnC;;;;OAIG;IACH,OAAO,EAAE,MAAM,CAAC;IAChB;;;;OAIG;IACH,OAAO,EAAE,MAAM,CAAC;IAChB;;;;OAIG;IACH,QAAQ,EAAE,MAAM,CAAC;CACpB"}