mixpeek 0.81.1

package/dist/models/stat-item.d.ts

@@ -0,0 +1,31 @@
+/**
+ * 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.
+ */
+/**
+ * A single stat item for the stats bar.
+ * @export
+ * @interface StatItem
+ */
+export interface StatItem {
+    /**
+     * Stat label (e.g. \'Total Ads\')
+     * @type {string}
+     * @memberof StatItem
+     */
+    'label': string;
+    /**
+     * Stat value (e.g. \'12,400+\')
+     * @type {string}
+     * @memberof StatItem
+     */
+    'value': string;
+}
+//# sourceMappingURL=stat-item.d.ts.map

package/dist/models/stat-item.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"stat-item.d.ts","sourceRoot":"","sources":["../../models/stat-item.ts"],"names":[],"mappings":"AAEA;;;;;;;;;;GAUG;AAIH;;;;GAIG;AACH,MAAM,WAAW,QAAQ;IACrB;;;;OAIG;IACH,OAAO,EAAE,MAAM,CAAC;IAChB;;;;OAIG;IACH,OAAO,EAAE,MAAM,CAAC;CACnB"}

package/dist/models/step-analytics-config-input.d.ts

@@ -0,0 +1,57 @@
+/**
+ * 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 { CovariateConfig } from './covariate-config';
+import type { StepKeySource } from './step-key-source';
+/**
+ * Configuration for step-by-step transition analytics on taxonomy assignments.  Enables analysis of how documents progress through taxonomy labels as a temporal sequence, answering questions like: - How long from \"inquiry\" to \"closed_won\"? - What % of \"inquiry\" emails reach \"proposal\"? - Which sender domains correlate with faster progression?  Use Cases:     1. Email Thread Analysis:        - Track progression: inquiry → followup → proposal → closed_won        - Identify which subject lines correlate with faster closure      2. Content Workflow Tracking:        - Monitor: draft → review → approved → published        - Find bottlenecks and optimization opportunities      3. Safety Compliance Monitoring:        - Trace: violation_detected → investigated → resolved        - Track resolution times and success rates  Attributes:     timestamp_field: Document field containing event timestamp     sequence_id_field: Field that groups related documents into sequences     step_key_source: How to extract the step identifier (label/node_id/custom field)     step_key_field_path: Required if step_key_source=\'field_path\'     covariates: List of predictor variables to analyze for conversion lift     max_sequence_duration_days: Filter out sequences longer than this (data quality)  Example:     ```python     # Email thread analysis configuration     StepAnalyticsConfig(         timestamp_field=\"Date\",  # Email timestamp         sequence_id_field=\"Thread-Index\",  # Groups emails in same thread         step_key_source=\"assignment_label\",  # Use taxonomy label as step         covariates=[             CovariateConfig(                 field_path=\"sender_domain\",                 covariate_type=\"categorical\",                 name=\"Sender Domain\"             ),             CovariateConfig(                 field_path=\"word_count\",                 covariate_type=\"numeric\",                 name=\"Email Length\"             )         ],         max_sequence_duration_days=90  # Ignore threads >90 days     )     ```
+ * @export
+ * @interface StepAnalyticsConfigInput
+ */
+export interface StepAnalyticsConfigInput {
+    /**
+     * Document field containing event timestamp (e.g., \'Date\', \'created_at\', \'metadata.timestamp\')
+     * @type {string}
+     * @memberof StepAnalyticsConfigInput
+     */
+    'timestamp_field': string;
+    /**
+     * Document field that groups related items into a sequence (e.g., \'Thread-Index\', \'session_id\', \'user_id\')
+     * @type {string}
+     * @memberof StepAnalyticsConfigInput
+     */
+    'sequence_id_field': string;
+    /**
+     * How to determine the \'step\' for each document (label, node_id, or custom field)
+     * @type {StepKeySource}
+     * @memberof StepAnalyticsConfigInput
+     */
+    'step_key_source'?: StepKeySource;
+    /**
+     * Required if step_key_source=\'field_path\'. Dot-notation path to step value in document.
+     * @type {string}
+     * @memberof StepAnalyticsConfigInput
+     */
+    'step_key_field_path'?: string;
+    /**
+     * Predictor fields to analyze for conversion lift (categorical, numeric, embedding, cluster)
+     * @type {Array<CovariateConfig>}
+     * @memberof StepAnalyticsConfigInput
+     */
+    'covariates'?: Array<CovariateConfig>;
+    /**
+     * Maximum allowed duration for a sequence. Sequences beyond this are flagged as data quality issues.
+     * @type {number}
+     * @memberof StepAnalyticsConfigInput
+     */
+    'max_sequence_duration_days'?: number;
+}
+//# sourceMappingURL=step-analytics-config-input.d.ts.map

package/dist/models/step-analytics-config-input.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"step-analytics-config-input.d.ts","sourceRoot":"","sources":["../../models/step-analytics-config-input.ts"],"names":[],"mappings":"AAEA;;;;;;;;;;GAUG;AAKH,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,oBAAoB,CAAC;AAG1D,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,mBAAmB,CAAC;AAEvD;;;;GAIG;AACH,MAAM,WAAW,wBAAwB;IACrC;;;;OAIG;IACH,iBAAiB,EAAE,MAAM,CAAC;IAC1B;;;;OAIG;IACH,mBAAmB,EAAE,MAAM,CAAC;IAC5B;;;;OAIG;IACH,iBAAiB,CAAC,EAAE,aAAa,CAAC;IAClC;;;;OAIG;IACH,qBAAqB,CAAC,EAAE,MAAM,CAAC;IAC/B;;;;OAIG;IACH,YAAY,CAAC,EAAE,KAAK,CAAC,eAAe,CAAC,CAAC;IACtC;;;;OAIG;IACH,4BAA4B,CAAC,EAAE,MAAM,CAAC;CACzC"}

package/dist/models/step-analytics-config-output.d.ts

@@ -0,0 +1,57 @@
+/**
+ * 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 { CovariateConfig } from './covariate-config';
+import type { StepKeySource } from './step-key-source';
+/**
+ * Configuration for step-by-step transition analytics on taxonomy assignments.  Enables analysis of how documents progress through taxonomy labels as a temporal sequence, answering questions like: - How long from \"inquiry\" to \"closed_won\"? - What % of \"inquiry\" emails reach \"proposal\"? - Which sender domains correlate with faster progression?  Use Cases:     1. Email Thread Analysis:        - Track progression: inquiry → followup → proposal → closed_won        - Identify which subject lines correlate with faster closure      2. Content Workflow Tracking:        - Monitor: draft → review → approved → published        - Find bottlenecks and optimization opportunities      3. Safety Compliance Monitoring:        - Trace: violation_detected → investigated → resolved        - Track resolution times and success rates  Attributes:     timestamp_field: Document field containing event timestamp     sequence_id_field: Field that groups related documents into sequences     step_key_source: How to extract the step identifier (label/node_id/custom field)     step_key_field_path: Required if step_key_source=\'field_path\'     covariates: List of predictor variables to analyze for conversion lift     max_sequence_duration_days: Filter out sequences longer than this (data quality)  Example:     ```python     # Email thread analysis configuration     StepAnalyticsConfig(         timestamp_field=\"Date\",  # Email timestamp         sequence_id_field=\"Thread-Index\",  # Groups emails in same thread         step_key_source=\"assignment_label\",  # Use taxonomy label as step         covariates=[             CovariateConfig(                 field_path=\"sender_domain\",                 covariate_type=\"categorical\",                 name=\"Sender Domain\"             ),             CovariateConfig(                 field_path=\"word_count\",                 covariate_type=\"numeric\",                 name=\"Email Length\"             )         ],         max_sequence_duration_days=90  # Ignore threads >90 days     )     ```
+ * @export
+ * @interface StepAnalyticsConfigOutput
+ */
+export interface StepAnalyticsConfigOutput {
+    /**
+     * Document field containing event timestamp (e.g., \'Date\', \'created_at\', \'metadata.timestamp\')
+     * @type {string}
+     * @memberof StepAnalyticsConfigOutput
+     */
+    'timestamp_field': string;
+    /**
+     * Document field that groups related items into a sequence (e.g., \'Thread-Index\', \'session_id\', \'user_id\')
+     * @type {string}
+     * @memberof StepAnalyticsConfigOutput
+     */
+    'sequence_id_field': string;
+    /**
+     * How to determine the \'step\' for each document (label, node_id, or custom field)
+     * @type {StepKeySource}
+     * @memberof StepAnalyticsConfigOutput
+     */
+    'step_key_source'?: StepKeySource;
+    /**
+     * Required if step_key_source=\'field_path\'. Dot-notation path to step value in document.
+     * @type {string}
+     * @memberof StepAnalyticsConfigOutput
+     */
+    'step_key_field_path'?: string;
+    /**
+     * Predictor fields to analyze for conversion lift (categorical, numeric, embedding, cluster)
+     * @type {Array<CovariateConfig>}
+     * @memberof StepAnalyticsConfigOutput
+     */
+    'covariates'?: Array<CovariateConfig>;
+    /**
+     * Maximum allowed duration for a sequence. Sequences beyond this are flagged as data quality issues.
+     * @type {number}
+     * @memberof StepAnalyticsConfigOutput
+     */
+    'max_sequence_duration_days'?: number;
+}
+//# sourceMappingURL=step-analytics-config-output.d.ts.map

package/dist/models/step-analytics-config-output.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"step-analytics-config-output.d.ts","sourceRoot":"","sources":["../../models/step-analytics-config-output.ts"],"names":[],"mappings":"AAEA;;;;;;;;;;GAUG;AAKH,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,oBAAoB,CAAC;AAG1D,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,mBAAmB,CAAC;AAEvD;;;;GAIG;AACH,MAAM,WAAW,yBAAyB;IACtC;;;;OAIG;IACH,iBAAiB,EAAE,MAAM,CAAC;IAC1B;;;;OAIG;IACH,mBAAmB,EAAE,MAAM,CAAC;IAC5B;;;;OAIG;IACH,iBAAiB,CAAC,EAAE,aAAa,CAAC;IAClC;;;;OAIG;IACH,qBAAqB,CAAC,EAAE,MAAM,CAAC;IAC/B;;;;OAIG;IACH,YAAY,CAAC,EAAE,KAAK,CAAC,eAAe,CAAC,CAAC;IACtC;;;;OAIG;IACH,4BAA4B,CAAC,EAAE,MAAM,CAAC;CACzC"}

package/dist/models/step-info.d.ts

@@ -0,0 +1,49 @@
+/**
+ * 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.
+ */
+/**
+ * Information about a single step in the taxonomy analytics data.  Attributes:     step_key: The step identifier (e.g., \"inquiry\", \"closed_won\")     event_count: Number of events with this step     sequence_count: Number of unique sequences with this step     first_seen: ISO timestamp of earliest event with this step     last_seen: ISO timestamp of most recent event with this step
+ * @export
+ * @interface StepInfo
+ */
+export interface StepInfo {
+    /**
+     * Step identifier
+     * @type {string}
+     * @memberof StepInfo
+     */
+    'step_key': string;
+    /**
+     * Total events for this step
+     * @type {number}
+     * @memberof StepInfo
+     */
+    'event_count': number;
+    /**
+     * Unique sequences with this step
+     * @type {number}
+     * @memberof StepInfo
+     */
+    'sequence_count': number;
+    /**
+     * Earliest event timestamp (ISO format)
+     * @type {string}
+     * @memberof StepInfo
+     */
+    'first_seen': string;
+    /**
+     * Most recent event timestamp (ISO format)
+     * @type {string}
+     * @memberof StepInfo
+     */
+    'last_seen': string;
+}
+//# sourceMappingURL=step-info.d.ts.map

package/dist/models/step-info.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"step-info.d.ts","sourceRoot":"","sources":["../../models/step-info.ts"],"names":[],"mappings":"AAEA;;;;;;;;;;GAUG;AAIH;;;;GAIG;AACH,MAAM,WAAW,QAAQ;IACrB;;;;OAIG;IACH,UAAU,EAAE,MAAM,CAAC;IACnB;;;;OAIG;IACH,aAAa,EAAE,MAAM,CAAC;IACtB;;;;OAIG;IACH,gBAAgB,EAAE,MAAM,CAAC;IACzB;;;;OAIG;IACH,YAAY,EAAE,MAAM,CAAC;IACrB;;;;OAIG;IACH,WAAW,EAAE,MAAM,CAAC;CACvB"}

package/dist/models/step-key-source.d.ts

@@ -0,0 +1,23 @@
+/**
+ * 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.
+ */
+/**
+ * Defines how to extract the step key from documents for sequence analysis.  The step key identifies which stage/state a document is in for transition analytics.  Examples:     ASSIGNMENT_LABEL: Use the taxonomy\'s assigned label (e.g., \"inquiry\", \"proposal\")     ASSIGNMENT_NODE_ID: Use the taxonomy node ID (e.g., \"node_sales_inquiry\")     FIELD_PATH: Use a custom document field (e.g., \"metadata.workflow_stage\")
+ * @export
+ * @enum {string}
+ */
+export declare const StepKeySource: {
+    readonly AssignmentLabel: "assignment_label";
+    readonly AssignmentNodeId: "assignment_node_id";
+    readonly FieldPath: "field_path";
+};
+export type StepKeySource = typeof StepKeySource[keyof typeof StepKeySource];
+//# sourceMappingURL=step-key-source.d.ts.map

package/dist/models/step-key-source.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"step-key-source.d.ts","sourceRoot":"","sources":["../../models/step-key-source.ts"],"names":[],"mappings":"AAEA;;;;;;;;;;GAUG;AAIH;;;;GAIG;AAEH,eAAO,MAAM,aAAa;;;;CAIhB,CAAC;AAEX,MAAM,MAAM,aAAa,GAAG,OAAO,aAAa,CAAC,MAAM,OAAO,aAAa,CAAC,CAAC"}

package/dist/models/step-transition-request.d.ts

@@ -0,0 +1,70 @@
+/**
+ * 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 { StepAnalyticsConfigInput } from './step-analytics-config-input';
+/**
+ * API request model for step transition analytics.  This model extends the engine query model with API-specific validation and documentation.  Use this to analyze how documents transition from one taxonomy step to another, computing conversion rates, durations, and predictor lifts.  Example:     ```json     {         \"collection_id\": \"col_emails\",         \"taxonomy_id\": \"tax_sales_stages\",         \"from_step\": \"inquiry\",         \"to_step\": \"closed_won\",         \"max_window_days\": 90,         \"min_support\": 10     }     ```  Response includes:     - Conversion rate (% reaching to_step)     - Duration statistics (mean, median, p90, p95)     - Top predictors (covariates with highest lift)
+ * @export
+ * @interface StepTransitionRequest
+ */
+export interface StepTransitionRequest {
+    /**
+     * Collection to analyze for step transitions
+     * @type {string}
+     * @memberof StepTransitionRequest
+     */
+    'collection_id': string;
+    /**
+     * Taxonomy ID (each taxonomy_id is immutable, clone creates new ID)
+     * @type {string}
+     * @memberof StepTransitionRequest
+     */
+    'taxonomy_id': string;
+    /**
+     * Starting step label (e.g., \'inquiry\', \'draft\')
+     * @type {string}
+     * @memberof StepTransitionRequest
+     */
+    'from_step': string;
+    /**
+     * Ending step label (e.g., \'closed_won\', \'published\')
+     * @type {string}
+     * @memberof StepTransitionRequest
+     */
+    'to_step': string;
+    /**
+     * Maximum days between from_step and to_step. Sequences exceeding this are excluded.
+     * @type {number}
+     * @memberof StepTransitionRequest
+     */
+    'max_window_days'?: number;
+    /**
+     * Optional filters for events (e.g., {\'metadata.region\': \'US\'})
+     * @type {{ [key: string]: any; }}
+     * @memberof StepTransitionRequest
+     */
+    'filters'?: {
+        [key: string]: any;
+    };
+    /**
+     * Override taxonomy\'s default step_analytics config for this query
+     * @type {StepAnalyticsConfigInput}
+     * @memberof StepTransitionRequest
+     */
+    'override_step_analytics'?: StepAnalyticsConfigInput;
+    /**
+     * Minimum number of sequences required for valid analysis
+     * @type {number}
+     * @memberof StepTransitionRequest
+     */
+    'min_support'?: number;
+}
+//# sourceMappingURL=step-transition-request.d.ts.map

package/dist/models/step-transition-request.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"step-transition-request.d.ts","sourceRoot":"","sources":["../../models/step-transition-request.ts"],"names":[],"mappings":"AAEA;;;;;;;;;;GAUG;AAKH,OAAO,KAAK,EAAE,wBAAwB,EAAE,MAAM,+BAA+B,CAAC;AAE9E;;;;GAIG;AACH,MAAM,WAAW,qBAAqB;IAClC;;;;OAIG;IACH,eAAe,EAAE,MAAM,CAAC;IACxB;;;;OAIG;IACH,aAAa,EAAE,MAAM,CAAC;IACtB;;;;OAIG;IACH,WAAW,EAAE,MAAM,CAAC;IACpB;;;;OAIG;IACH,SAAS,EAAE,MAAM,CAAC;IAClB;;;;OAIG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B;;;;OAIG;IACH,SAAS,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAC;KAAE,CAAC;IACpC;;;;OAIG;IACH,yBAAyB,CAAC,EAAE,wBAAwB,CAAC;IACrD;;;;OAIG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;CAC1B"}

package/dist/models/step-transition-response.d.ts

@@ -0,0 +1,71 @@
+/**
+ * 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 { DurationStats } from './duration-stats';
+import type { PredictorLift } from './predictor-lift';
+/**
+ * API response model for step transition analytics.  Contains comprehensive statistics about the A→B transition including conversion metrics, duration analysis, and predictor insights.  Example Response:     ```json     {         \"from_step\": \"inquiry\",         \"to_step\": \"closed_won\",         \"count\": 1000,         \"converted\": 350,         \"conversion_rate\": 0.35,         \"durations_sec\": {             \"mean\": 432000.0,             \"median\": 345600.0,             \"p50\": 345600.0,             \"p90\": 691200.0,             \"p95\": 864000.0,             \"std_dev\": 172800.0,             \"min\": 86400.0,             \"max\": 1209600.0         },         \"top_predictors\": [             {                 \"field\": \"Sender Domain\",                 \"value\": \"enterprise.com\",                 \"count\": 150,                 \"conversion_rate\": 0.75,                 \"lift\": 2.14             }         ],         \"metadata\": {             \"collection_id\": \"col_emails\",             \"taxonomy_id\": \"tax_sales_stages\",             \"total_events_analyzed\": 5432         }     }     ```
+ * @export
+ * @interface StepTransitionResponse
+ */
+export interface StepTransitionResponse {
+    /**
+     * Starting step
+     * @type {string}
+     * @memberof StepTransitionResponse
+     */
+    'from_step': string;
+    /**
+     * Ending step
+     * @type {string}
+     * @memberof StepTransitionResponse
+     */
+    'to_step': string;
+    /**
+     * Total number of sequences starting at from_step
+     * @type {number}
+     * @memberof StepTransitionResponse
+     */
+    'count': number;
+    /**
+     * Number of sequences that reached to_step
+     * @type {number}
+     * @memberof StepTransitionResponse
+     */
+    'converted': number;
+    /**
+     * Percentage that converted (converted / count)
+     * @type {number}
+     * @memberof StepTransitionResponse
+     */
+    'conversion_rate': number;
+    /**
+     * Duration statistics (None if no conversions)
+     * @type {DurationStats}
+     * @memberof StepTransitionResponse
+     */
+    'durations_sec'?: DurationStats;
+    /**
+     * Covariates with highest lift (sorted by absolute lift)
+     * @type {Array<PredictorLift>}
+     * @memberof StepTransitionResponse
+     */
+    'top_predictors'?: Array<PredictorLift>;
+    /**
+     * Additional metadata (collection_id, event counts, etc.)
+     * @type {{ [key: string]: any; }}
+     * @memberof StepTransitionResponse
+     */
+    'metadata'?: {
+        [key: string]: any;
+    };
+}
+//# sourceMappingURL=step-transition-response.d.ts.map

package/dist/models/step-transition-response.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"step-transition-response.d.ts","sourceRoot":"","sources":["../../models/step-transition-response.ts"],"names":[],"mappings":"AAEA;;;;;;;;;;GAUG;AAKH,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,kBAAkB,CAAC;AAGtD,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,kBAAkB,CAAC;AAEtD;;;;GAIG;AACH,MAAM,WAAW,sBAAsB;IACnC;;;;OAIG;IACH,WAAW,EAAE,MAAM,CAAC;IACpB;;;;OAIG;IACH,SAAS,EAAE,MAAM,CAAC;IAClB;;;;OAIG;IACH,OAAO,EAAE,MAAM,CAAC;IAChB;;;;OAIG;IACH,WAAW,EAAE,MAAM,CAAC;IACpB;;;;OAIG;IACH,iBAAiB,EAAE,MAAM,CAAC;IAC1B;;;;OAIG;IACH,eAAe,CAAC,EAAE,aAAa,CAAC;IAChC;;;;OAIG;IACH,gBAAgB,CAAC,EAAE,KAAK,CAAC,aAAa,CAAC,CAAC;IACxC;;;;OAIG;IACH,UAAU,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAC;KAAE,CAAC;CACxC"}

package/dist/models/storage-connection-create-request.d.ts

@@ -0,0 +1,60 @@
+/**
+ * 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 { StorageProvider } from './storage-provider';
+/**
+ * Request payload for creating a new storage connection.  Use this to connect Mixpeek to external storage providers like Google Drive or S3. The connection will be tested before being saved (unless test_before_save is False).  **Use Cases:** - Connect to team Google Drive for automated file ingestion - Link customer S3 buckets for batch processing - Set up storage connections for sync operations  **Security:** - Credentials are encrypted at rest using MongoDB field-level encryption - Credentials never appear in API responses or logs - Connection is tested before saving to validate credentials  **Examples:** ```python # Google Drive connection {     \"name\": \"Marketing Drive\",     \"provider_type\": \"google_drive\",     \"provider_config\": {         \"credentials\": {...},         \"shared_drive_id\": \"0AH-Xabc123\"     },     \"description\": \"Team drive for marketing assets\" } ```
+ * @export
+ * @interface StorageConnectionCreateRequest
+ */
+export interface StorageConnectionCreateRequest {
+    /**
+     * REQUIRED. Human-readable name for the storage connection. Must be unique within the organization. Displayed in dashboards and sync logs. Format: 1-100 characters, descriptive of the connection\'s purpose.
+     * @type {string}
+     * @memberof StorageConnectionCreateRequest
+     */
+    'name': string;
+    /**
+     * REQUIRED. Storage provider to connect to. Supported providers: google_drive, s3, snowflake, sharepoint, tigris. Determines which authentication and sync logic is used.
+     * @type {StorageProvider}
+     * @memberof StorageConnectionCreateRequest
+     */
+    'provider_type': StorageProvider;
+    /**
+     * REQUIRED. Provider-specific configuration including credentials. Structure varies by provider_type. SECURITY: Sensitive credential fields (private_key, secret_access_key, client_secret, refresh_token, session_token) are automatically encrypted at rest and never appear in responses or logs.
+     * @type {{ [key: string]: any; }}
+     * @memberof StorageConnectionCreateRequest
+     */
+    'provider_config': {
+        [key: string]: any;
+    };
+    /**
+     * OPTIONAL. Description explaining the connection\'s purpose and scope. Helpful for team collaboration and documentation. Format: Up to 500 characters.
+     * @type {string}
+     * @memberof StorageConnectionCreateRequest
+     */
+    'description'?: string;
+    /**
+     * OPTIONAL. Arbitrary key-value metadata for tagging and categorization. Common uses: team tags, cost center codes, project identifiers.
+     * @type {{ [key: string]: any; }}
+     * @memberof StorageConnectionCreateRequest
+     */
+    'metadata'?: {
+        [key: string]: any;
+    };
+    /**
+     * OPTIONAL. Whether to validate credentials before saving the connection. Defaults to True. If True, connection will be tested against the provider before creation. If False, connection is saved without validation (use with caution).
+     * @type {boolean}
+     * @memberof StorageConnectionCreateRequest
+     */
+    'test_before_save'?: boolean;
+}
+//# sourceMappingURL=storage-connection-create-request.d.ts.map

package/dist/models/storage-connection-create-request.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"storage-connection-create-request.d.ts","sourceRoot":"","sources":["../../models/storage-connection-create-request.ts"],"names":[],"mappings":"AAEA;;;;;;;;;;GAUG;AAKH,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,oBAAoB,CAAC;AAE1D;;;;GAIG;AACH,MAAM,WAAW,8BAA8B;IAC3C;;;;OAIG;IACH,MAAM,EAAE,MAAM,CAAC;IACf;;;;OAIG;IACH,eAAe,EAAE,eAAe,CAAC;IACjC;;;;OAIG;IACH,iBAAiB,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAC;KAAE,CAAC;IAC3C;;;;OAIG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB;;;;OAIG;IACH,UAAU,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAC;KAAE,CAAC;IACrC;;;;OAIG;IACH,kBAAkB,CAAC,EAAE,OAAO,CAAC;CAChC"}

package/dist/models/storage-connection-list-response.d.ts

@@ -0,0 +1,39 @@
+/**
+ * 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 { PaginationResponse } from './pagination-response';
+import type { StorageConnectionModel } from './storage-connection-model';
+/**
+ * Response envelope for listing storage connections.  Contains paginated results and metadata about the listing operation.
+ * @export
+ * @interface StorageConnectionListResponse
+ */
+export interface StorageConnectionListResponse {
+    /**
+     * List of storage connections matching the request filters. Results are paginated according to the pagination parameters. SECURITY: Sensitive credential fields are automatically redacted.
+     * @type {Array<StorageConnectionModel>}
+     * @memberof StorageConnectionListResponse
+     */
+    'results': Array<StorageConnectionModel>;
+    /**
+     * Pagination metadata including total count, page number, page size, and navigation links for next/previous pages.
+     * @type {PaginationResponse}
+     * @memberof StorageConnectionListResponse
+     */
+    'pagination': PaginationResponse;
+    /**
+     * Total number of connections matching the filters (before pagination). Use this to calculate total pages and display pagination controls.
+     * @type {number}
+     * @memberof StorageConnectionListResponse
+     */
+    'total': number;
+}
+//# sourceMappingURL=storage-connection-list-response.d.ts.map

package/dist/models/storage-connection-list-response.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"storage-connection-list-response.d.ts","sourceRoot":"","sources":["../../models/storage-connection-list-response.ts"],"names":[],"mappings":"AAEA;;;;;;;;;;GAUG;AAKH,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,uBAAuB,CAAC;AAGhE,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,4BAA4B,CAAC;AAEzE;;;;GAIG;AACH,MAAM,WAAW,6BAA6B;IAC1C;;;;OAIG;IACH,SAAS,EAAE,KAAK,CAAC,sBAAsB,CAAC,CAAC;IACzC;;;;OAIG;IACH,YAAY,EAAE,kBAAkB,CAAC;IACjC;;;;OAIG;IACH,OAAO,EAAE,MAAM,CAAC;CACnB"}

package/dist/models/storage-connection-model.d.ts

@@ -0,0 +1,114 @@
+/**
+ * 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 { ProviderConfig } from './provider-config';
+import type { StorageProvider } from './storage-provider';
+import type { TaskStatusEnum } from './task-status-enum';
+/**
+ * Canonical representation of an external storage provider connection.  Storage connections enable Mixpeek to access external cloud storage providers (Google Drive, S3, etc.) for automated file ingestion and synchronization. Each connection represents a configured integration with credentials, health monitoring, and usage tracking.  Lifecycle States:     - ACTIVE: Connection is healthy and ready for sync operations     - SUSPENDED: Temporarily disabled by user (credentials preserved)     - FAILED: Health checks failing (may need credential refresh)     - ARCHIVED: Permanently retired (cannot be reactivated)  Security:     - Sensitive credential fields are encrypted at rest using MongoDB       client-side field level encryption (CSFLE)     - Credentials never appear in API responses or logs     - Failed authentication attempts are logged in last_error     - Consecutive failures trigger automatic suspension  Use Cases:     - Connect to team Google Drive for document ingestion     - Sync files from customer S3 buckets     - Monitor and process uploaded media files     - Schedule periodic sync operations  Health Monitoring:     - Automatic health checks validate connectivity and credentials     - consecutive_failures tracks authentication/network issues     - Auto-disable after 5 consecutive failures to prevent lockout     - last_error stores diagnostic information for debugging
+ * @export
+ * @interface StorageConnectionModel
+ */
+export interface StorageConnectionModel {
+    /**
+     * Unique identifier for the storage connection. Auto-generated with \'conn_\' prefix followed by secure random token. Format: conn_{15-character alphanumeric}. Used for API operations and audit trails.
+     * @type {string}
+     * @memberof StorageConnectionModel
+     */
+    'connection_id'?: string;
+    /**
+     * REQUIRED. Organization internal identifier for multi-tenancy scoping. All connection operations are scoped to this organization. Format: int_{24-character secure token}.
+     * @type {string}
+     * @memberof StorageConnectionModel
+     */
+    'internal_id': string;
+    /**
+     * REQUIRED. Storage provider implementation to use. Determines which client adapter is loaded for sync operations. Supported: google_drive, s3, snowflake, sharepoint, tigris.
+     * @type {StorageProvider}
+     * @memberof StorageConnectionModel
+     */
+    'provider_type': StorageProvider;
+    /**
+     *
+     * @type {ProviderConfig}
+     * @memberof StorageConnectionModel
+     */
+    'provider_config': ProviderConfig;
+    /**
+     * REQUIRED. Human-readable connection name for identification. Displayed in dashboards, sync logs, and API responses. Must be unique within the organization for clarity. Format: 1-100 characters, descriptive of the connection\'s purpose.
+     * @type {string}
+     * @memberof StorageConnectionModel
+     */
+    'name': string;
+    /**
+     * NOT REQUIRED. Optional description explaining the connection\'s purpose and scope. Helpful for team collaboration and documentation. Format: Up to 500 characters.
+     * @type {string}
+     * @memberof StorageConnectionModel
+     */
+    'description'?: string;
+    /**
+     * Operational status of the connection. ACTIVE: Connection is healthy and ready for use in sync operations. SUSPENDED: Temporarily disabled by user, credentials preserved but sync paused. FAILED: Health checks failing, credentials may be invalid or expired. ARCHIVED: Permanently retired, cannot be reactivated. Status transitions automatically based on health checks and user actions.
+     * @type {TaskStatusEnum}
+     * @memberof StorageConnectionModel
+     */
+    'status'?: TaskStatusEnum;
+    /**
+     * Quick boolean flag for filtering active connections in queries. True when status is ACTIVE, False for SUSPENDED/FAILED/ARCHIVED. Maintained automatically when status changes. Use for efficient filtering: db.connections.find({\'is_active\': True})
+     * @type {boolean}
+     * @memberof StorageConnectionModel
+     */
+    'is_active'?: boolean;
+    /**
+     * NOT REQUIRED. UTC timestamp of the most recent successful sync operation. Updated automatically after each successful file sync/list operation. None if connection has never been used. Useful for identifying stale connections and usage analytics.
+     * @type {string}
+     * @memberof StorageConnectionModel
+     */
+    'last_used_at'?: string;
+    /**
+     * NOT REQUIRED. Most recent error message from failed health check or sync. Populated when authentication fails, network errors occur, or permissions denied. None when connection is healthy. Format: Error message truncated to 1000 characters. Used for diagnostics and troubleshooting.
+     * @type {string}
+     * @memberof StorageConnectionModel
+     */
+    'last_error'?: string;
+    /**
+     * Counter tracking consecutive failed health checks or sync attempts. Incremented on each failure, reset to 0 on success. Used to implement automatic connection suspension. Auto-suspend after 5 consecutive failures to prevent account lockout. Range: 0 to infinity (typically 0-10).
+     * @type {number}
+     * @memberof StorageConnectionModel
+     */
+    'consecutive_failures'?: number;
+    /**
+     * UTC timestamp when the connection was created. Auto-generated using shared.utilities.helpers.current_time(). Immutable after creation. Format: ISO 8601 datetime.
+     * @type {string}
+     * @memberof StorageConnectionModel
+     */
+    'created_at'?: string;
+    /**
+     * UTC timestamp of the most recent update to the connection. Updated automatically on any field modification. Tracks configuration changes, status updates, and credential refreshes. Format: ISO 8601 datetime.
+     * @type {string}
+     * @memberof StorageConnectionModel
+     */
+    'updated_at'?: string;
+    /**
+     * REQUIRED. User identifier of the user who created this connection. Used for audit trails and permission checks. Format: usr_{15-character alphanumeric}. Immutable after creation.
+     * @type {string}
+     * @memberof StorageConnectionModel
+     */
+    'created_by_user_id': string;
+    /**
+     * Arbitrary key-value metadata provided by the user. Useful for tagging, categorization, and custom annotations. NOT REQUIRED - defaults to empty dictionary. Common uses: team tags, cost center codes, project identifiers.
+     * @type {{ [key: string]: any; }}
+     * @memberof StorageConnectionModel
+     */
+    'metadata'?: {
+        [key: string]: any;
+    };
+}
+//# sourceMappingURL=storage-connection-model.d.ts.map

package/dist/models/storage-connection-model.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"storage-connection-model.d.ts","sourceRoot":"","sources":["../../models/storage-connection-model.ts"],"names":[],"mappings":"AAEA;;;;;;;;;;GAUG;AAKH,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,mBAAmB,CAAC;AAGxD,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,oBAAoB,CAAC;AAG1D,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,oBAAoB,CAAC;AAEzD;;;;GAIG;AACH,MAAM,WAAW,sBAAsB;IACnC;;;;OAIG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB;;;;OAIG;IACH,aAAa,EAAE,MAAM,CAAC;IACtB;;;;OAIG;IACH,eAAe,EAAE,eAAe,CAAC;IACjC;;;;OAIG;IACH,iBAAiB,EAAE,cAAc,CAAC;IAClC;;;;OAIG;IACH,MAAM,EAAE,MAAM,CAAC;IACf;;;;OAIG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB;;;;OAIG;IACH,QAAQ,CAAC,EAAE,cAAc,CAAC;IAC1B;;;;OAIG;IACH,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB;;;;OAIG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB;;;;OAIG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB;;;;OAIG;IACH,sBAAsB,CAAC,EAAE,MAAM,CAAC;IAChC;;;;OAIG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB;;;;OAIG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB;;;;OAIG;IACH,oBAAoB,EAAE,MAAM,CAAC;IAC7B;;;;OAIG;IACH,UAAU,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAC;KAAE,CAAC;CACxC"}