@seekora-ai/search-sdk 0.2.12 → 0.2.14

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -1,6 +1,6 @@
1
1
  /**
2
2
  * Seekora APIs
3
- * This is an API with JWT authentication.
3
+ * Seekora provides search, suggestions, and store management APIs. **Admin APIs** require JWT (Bearer token from login). **Public/SDK APIs** (search, stores, suggestions, documents) use store credentials: send `x-storeid` (Store ID) and either `x-storesecret` (read) or `x-store-write-secret` (write) in headers. Get these from the Seekora dashboard. Base path for public v1 APIs: `/api/v1`.
4
4
  *
5
5
  * The version of the OpenAPI document: 1.0
6
6
  *
@@ -385,6 +385,90 @@ export interface AnalyticsCreateFunnelRequestBody {
385
385
  'steps': Array<SeekoraGoSrcServicesAnalyticsFunnelStep>;
386
386
  'store_id'?: number;
387
387
  }
388
+ export interface AnalyticsCustomEventFieldBreakdown {
389
+ 'event_name'?: string;
390
+ 'field_name'?: string;
391
+ 'field_slot'?: string;
392
+ 'values'?: Array<AnalyticsFieldBreakdownEntry>;
393
+ }
394
+ export interface AnalyticsCustomEventFieldBreakdownRequestBody {
395
+ 'end_date': string;
396
+ 'event_name': string;
397
+ 'field_slot': string;
398
+ /**
399
+ * hour, day, week, month
400
+ */
401
+ 'granularity'?: string;
402
+ 'limit'?: number;
403
+ 'page'?: number;
404
+ 'page_size'?: number;
405
+ 'start_date': string;
406
+ 'xstoreid'?: string;
407
+ }
408
+ export interface AnalyticsCustomEventMetrics {
409
+ 'time_series'?: Array<SeekoraGoSrcServicesAnalyticsTimeSeriesPoint>;
410
+ 'total_events'?: number;
411
+ 'unique_event_types'?: number;
412
+ 'unique_sessions'?: number;
413
+ 'unique_users'?: number;
414
+ }
415
+ export interface AnalyticsCustomEventMetricsRequestBody {
416
+ 'end_date': string;
417
+ 'event_name'?: string;
418
+ /**
419
+ * hour, day, week, month
420
+ */
421
+ 'granularity'?: string;
422
+ 'page'?: number;
423
+ 'page_size'?: number;
424
+ 'start_date': string;
425
+ 'xstoreid'?: string;
426
+ }
427
+ export interface AnalyticsCustomEventRow {
428
+ 'event_id'?: string;
429
+ 'event_name'?: string;
430
+ 'event_ts'?: string;
431
+ 'fields'?: {
432
+ [key: string]: any;
433
+ };
434
+ 'session_id'?: string;
435
+ 'user_key'?: string;
436
+ }
437
+ export interface AnalyticsCustomEventStreamRequestBody {
438
+ 'end_date': string;
439
+ 'event_name'?: string;
440
+ /**
441
+ * hour, day, week, month
442
+ */
443
+ 'granularity'?: string;
444
+ 'page'?: number;
445
+ 'page_size'?: number;
446
+ 'start_date': string;
447
+ 'xstoreid'?: string;
448
+ }
449
+ export interface AnalyticsCustomEventSummary {
450
+ 'event_count'?: number;
451
+ 'event_name'?: string;
452
+ 'last_seen'?: string;
453
+ 'unique_users'?: number;
454
+ }
455
+ export interface AnalyticsCustomEventTimeSeriesPoint {
456
+ 'count'?: number;
457
+ 'event_name'?: string;
458
+ 'timestamp'?: string;
459
+ }
460
+ export interface AnalyticsCustomEventTimeSeriesRequestBody {
461
+ 'end_date': string;
462
+ 'event_name'?: string;
463
+ /**
464
+ * hour, day, week, month
465
+ */
466
+ 'granularity'?: string;
467
+ 'page'?: number;
468
+ 'page_size'?: number;
469
+ 'start_date': string;
470
+ 'xstoreid'?: string;
471
+ }
388
472
  export interface AnalyticsCustomQueryRequest {
389
473
  'end_time'?: string;
390
474
  'granularity'?: string;
@@ -471,6 +555,10 @@ export interface AnalyticsExtendedKPIResponse {
471
555
  'target_currency'?: string;
472
556
  'xstoreid'?: string;
473
557
  }
558
+ export interface AnalyticsFieldBreakdownEntry {
559
+ 'count'?: number;
560
+ 'value'?: string;
561
+ }
474
562
  export interface AnalyticsFilterAnalyticsResponse {
475
563
  'combinations'?: Array<AnalyticsFilterCombination>;
476
564
  /**
@@ -1446,6 +1534,7 @@ export interface AnalyticsKPIMetrics {
1446
1534
  [key: string]: number;
1447
1535
  };
1448
1536
  'revenue_currency'?: string;
1537
+ 'total_custom_events'?: number;
1449
1538
  'total_searches'?: number;
1450
1539
  'total_users'?: number;
1451
1540
  }
@@ -1459,6 +1548,7 @@ export interface AnalyticsKPIPointExtended {
1459
1548
  * Click-through rate
1460
1549
  */
1461
1550
  'ctr'?: number;
1551
+ 'custom_events'?: number;
1462
1552
  'no_result_rate'?: number;
1463
1553
  'no_results'?: number;
1464
1554
  'purchases'?: number;
@@ -1474,7 +1564,6 @@ export interface AnalyticsKPIPointExtended {
1474
1564
  export interface AnalyticsMergeProfilesRequestBody {
1475
1565
  'anonymous_id': string;
1476
1566
  'authenticated_id': string;
1477
- 'xstoreid'?: string;
1478
1567
  }
1479
1568
  export interface AnalyticsModelComparisonRequest {
1480
1569
  'end_date': string;
@@ -1508,6 +1597,13 @@ export interface AnalyticsOverviewComparison {
1508
1597
  'requests'?: AnalyticsPeriodComparison;
1509
1598
  'revenue'?: AnalyticsPeriodComparison;
1510
1599
  }
1600
+ export interface AnalyticsPaginatedResponseAnalyticsCustomEventRow {
1601
+ 'data'?: Array<AnalyticsCustomEventRow>;
1602
+ 'page'?: number;
1603
+ 'page_size'?: number;
1604
+ 'total'?: number;
1605
+ 'total_pages'?: number;
1606
+ }
1511
1607
  export interface AnalyticsPaginationInfo {
1512
1608
  'has_more'?: boolean;
1513
1609
  'limit'?: number;
@@ -2512,6 +2608,19 @@ export interface AnalyticsTimeWindow {
2512
2608
  'end_date'?: string;
2513
2609
  'start_date'?: string;
2514
2610
  }
2611
+ export interface AnalyticsTopCustomEventsRequestBody {
2612
+ 'end_date': string;
2613
+ /**
2614
+ * hour, day, week, month
2615
+ */
2616
+ 'granularity'?: string;
2617
+ 'limit'?: number;
2618
+ 'page'?: number;
2619
+ 'page_size'?: number;
2620
+ 'sort_by'?: string;
2621
+ 'start_date': string;
2622
+ 'xstoreid'?: string;
2623
+ }
2515
2624
  export interface AnalyticsTopQueriesRequestBody {
2516
2625
  'end_date': string;
2517
2626
  /**
@@ -3025,7 +3134,6 @@ export interface DataTypesBillingAlertRequest {
3025
3134
  }
3026
3135
  export declare const DataTypesBillingAlertRequestAlertTypeEnum: {
3027
3136
  readonly LowBalance: "low_balance";
3028
- readonly ExpiringCredits: "expiring_credits";
3029
3137
  readonly DaysRemaining: "days_remaining";
3030
3138
  };
3031
3139
  export type DataTypesBillingAlertRequestAlertTypeEnum = typeof DataTypesBillingAlertRequestAlertTypeEnum[keyof typeof DataTypesBillingAlertRequestAlertTypeEnum];
@@ -3063,6 +3171,42 @@ export interface DataTypesBillingOrderDetailsResponse {
3063
3171
  'receipts'?: Array<DataTypesReceipt>;
3064
3172
  'transactions'?: Array<DataTypesOrderTransactionDisplay>;
3065
3173
  }
3174
+ export interface DataTypesBillingOverviewNewResponse {
3175
+ /**
3176
+ * Credit balance information
3177
+ */
3178
+ 'credit_balance'?: DataTypesCreditBalanceInfo;
3179
+ 'currency'?: string;
3180
+ /**
3181
+ * Current plan information
3182
+ */
3183
+ 'current_plan'?: DataTypesCurrentPlanInfo;
3184
+ /**
3185
+ * Next charge information (for subscriptions)
3186
+ */
3187
+ 'next_charge'?: DataTypesNextChargeInfo;
3188
+ /**
3189
+ * Projected runout information
3190
+ */
3191
+ 'projected_runout'?: DataTypesProjectedRunoutInfo;
3192
+ /**
3193
+ * Total spent
3194
+ */
3195
+ 'total_spent'?: number;
3196
+ /**
3197
+ * Detailed usage metrics for ALL consumables
3198
+ */
3199
+ 'usage_metrics'?: DataTypesDetailedUsageMetrics;
3200
+ /**
3201
+ * Usage summary for current period
3202
+ */
3203
+ 'usage_summary'?: DataTypesUsageSummary;
3204
+ }
3205
+ export interface DataTypesBooleanFeatureMetric {
3206
+ 'display_label'?: string;
3207
+ 'enabled'?: boolean;
3208
+ 'feature_name'?: string;
3209
+ }
3066
3210
  export interface DataTypesBulkDocumentRequest {
3067
3211
  /**
3068
3212
  * Array of document operations
@@ -3304,6 +3448,35 @@ export interface DataTypesConfigurationSchemaResponseWrapper {
3304
3448
  'message'?: string;
3305
3449
  'status'?: number;
3306
3450
  }
3451
+ export interface DataTypesConsumableMetric {
3452
+ 'current_usage'?: number;
3453
+ 'description'?: string;
3454
+ 'display_label'?: string;
3455
+ 'feature_name'?: string;
3456
+ 'is_unlimited'?: boolean;
3457
+ 'limit'?: number;
3458
+ 'next_reset'?: string;
3459
+ 'remaining'?: number;
3460
+ /**
3461
+ * \"monthly\", \"never\", etc.
3462
+ */
3463
+ 'reset_period'?: string;
3464
+ 'usage_percentage'?: number;
3465
+ /**
3466
+ * \"normal\", \"warning\", \"critical\"
3467
+ */
3468
+ 'warning_level'?: string;
3469
+ }
3470
+ export interface DataTypesConsumptionHistoryResponse {
3471
+ 'consumptions'?: Array<DataTypesCreditConsumption>;
3472
+ 'pagination'?: DataTypesPaginationInfo;
3473
+ 'summary'?: DataTypesConsumptionSummary;
3474
+ }
3475
+ export interface DataTypesConsumptionSummary {
3476
+ 'total_consumptions'?: number;
3477
+ 'total_credits_used'?: number;
3478
+ 'unique_endpoints'?: number;
3479
+ }
3307
3480
  /**
3308
3481
  * Request payload for creating a new analytics rule
3309
3482
  */
@@ -3331,6 +3504,22 @@ export declare const DataTypesCreateCustomWordListRequestTypeEnum: {
3331
3504
  readonly Synonyms: "synonyms";
3332
3505
  };
3333
3506
  export type DataTypesCreateCustomWordListRequestTypeEnum = typeof DataTypesCreateCustomWordListRequestTypeEnum[keyof typeof DataTypesCreateCustomWordListRequestTypeEnum];
3507
+ export interface DataTypesCreateExperimentRequest {
3508
+ 'audience_filter'?: object;
3509
+ 'description'?: string;
3510
+ 'experiment_id': string;
3511
+ 'experiment_type': DataTypesExperimentType;
3512
+ 'hypothesis'?: string;
3513
+ 'max_duration_days'?: number;
3514
+ 'min_sample_size'?: number;
3515
+ 'name': string;
3516
+ 'primary_metric': string;
3517
+ 'scheduled_end_at'?: string;
3518
+ 'scheduled_start_at'?: string;
3519
+ 'secondary_metrics'?: Array<string>;
3520
+ 'traffic_percentage'?: number;
3521
+ 'variants': Array<DataTypesExperimentVariant>;
3522
+ }
3334
3523
  export interface DataTypesCreateLimitRequestDto {
3335
3524
  /**
3336
3525
  * Predefined API call limit per month
@@ -3742,6 +3931,32 @@ export interface DataTypesCreditAdjustmentDto {
3742
3931
  'description'?: string;
3743
3932
  'status'?: string;
3744
3933
  }
3934
+ export interface DataTypesCreditBalanceInfo {
3935
+ 'subscription_credits_available'?: number;
3936
+ 'subscription_credits_consumed'?: number;
3937
+ 'subscription_credits_total'?: number;
3938
+ 'topup_credits_available'?: number;
3939
+ 'topup_credits_consumed'?: number;
3940
+ 'topup_credits_total'?: number;
3941
+ 'total_consumed_this_cycle'?: number;
3942
+ 'total_credits'?: number;
3943
+ }
3944
+ export interface DataTypesCreditConsumption {
3945
+ 'api_endpoint'?: string;
3946
+ 'consumed_at'?: string;
3947
+ 'consumption_id'?: number;
3948
+ 'credit_source'?: string;
3949
+ 'credits_consumed'?: number;
3950
+ 'execution_time_ms'?: number;
3951
+ 'fifo_details'?: {
3952
+ [key: string]: any;
3953
+ };
3954
+ 'http_method'?: string;
3955
+ 'org_id'?: number;
3956
+ 'request_id'?: string;
3957
+ 'response_status'?: number;
3958
+ 'store_id'?: number;
3959
+ }
3745
3960
  export interface DataTypesCreditPlan {
3746
3961
  'bonus_credits'?: number;
3747
3962
  'created_at'?: string;
@@ -3760,6 +3975,9 @@ export interface DataTypesCreditPlan {
3760
3975
  'plan_id'?: number;
3761
3976
  'plan_name': string;
3762
3977
  'price': number;
3978
+ /**
3979
+ * Deprecated: kept for DB compat, ignored
3980
+ */
3763
3981
  'validity_days'?: number;
3764
3982
  }
3765
3983
  export interface DataTypesCreditPlanDetails {
@@ -3907,6 +4125,53 @@ export interface DataTypesDefaultMenu {
3907
4125
  'route'?: string;
3908
4126
  'sortOrder'?: number;
3909
4127
  }
4128
+ export interface DataTypesDetailedUsageMetrics {
4129
+ /**
4130
+ * Analytics
4131
+ */
4132
+ 'analytics_events'?: DataTypesConsumableMetric;
4133
+ 'analytics_events_total'?: DataTypesConsumableMetric;
4134
+ 'analytics_history'?: DataTypesConsumableMetric;
4135
+ 'api_access'?: DataTypesBooleanFeatureMetric;
4136
+ 'api_calls'?: DataTypesConsumableMetric;
4137
+ /**
4138
+ * Credits and API
4139
+ */
4140
+ 'credits'?: DataTypesConsumableMetric;
4141
+ 'credits_used'?: DataTypesConsumableMetric;
4142
+ /**
4143
+ * Boolean features
4144
+ */
4145
+ 'custom_domain'?: DataTypesBooleanFeatureMetric;
4146
+ 'query_suggestions'?: DataTypesConsumableMetric;
4147
+ 'record_size'?: DataTypesConsumableMetric;
4148
+ /**
4149
+ * Records/Documents
4150
+ */
4151
+ 'records'?: DataTypesConsumableMetric;
4152
+ 'reports'?: DataTypesStringFeatureMetric;
4153
+ 'rules'?: DataTypesConsumableMetric;
4154
+ /**
4155
+ * Search features
4156
+ */
4157
+ 'search_requests'?: DataTypesConsumableMetric;
4158
+ 'stopwords'?: DataTypesConsumableMetric;
4159
+ /**
4160
+ * Store-related
4161
+ */
4162
+ 'stores'?: DataTypesConsumableMetric;
4163
+ /**
4164
+ * String features
4165
+ */
4166
+ 'support_level'?: DataTypesStringFeatureMetric;
4167
+ 'synonyms'?: DataTypesConsumableMetric;
4168
+ /**
4169
+ * Team
4170
+ */
4171
+ 'team_members'?: DataTypesConsumableMetric;
4172
+ 'webhooks'?: DataTypesBooleanFeatureMetric;
4173
+ 'white_labeling'?: DataTypesBooleanFeatureMetric;
4174
+ }
3910
4175
  export interface DataTypesDocumentListResponse {
3911
4176
  /**
3912
4177
  * Array of documents
@@ -4137,6 +4402,14 @@ export interface DataTypesErrorMetaResponse {
4137
4402
  'status'?: number;
4138
4403
  }
4139
4404
  export interface DataTypesEventPayload {
4405
+ /**
4406
+ * ============================================================================ A/B Testing (V3) ============================================================================
4407
+ */
4408
+ 'ab_test_id'?: string;
4409
+ /**
4410
+ * Variant assignment
4411
+ */
4412
+ 'ab_variant'?: string;
4140
4413
  /**
4141
4414
  * ============================================================================ Analytics & Metadata ============================================================================
4142
4415
  */
@@ -4154,6 +4427,10 @@ export interface DataTypesEventPayload {
4154
4427
  'browser_version'?: string;
4155
4428
  'categories_count'?: number;
4156
4429
  'city'?: string;
4430
+ /**
4431
+ * new_tab, same_page, in_page
4432
+ */
4433
+ 'click_target'?: string;
4157
4434
  /**
4158
4435
  * query, product, category, brand, trending, recent
4159
4436
  */
@@ -4182,6 +4459,10 @@ export interface DataTypesEventPayload {
4182
4459
  'country_code'?: string;
4183
4460
  'currency'?: string;
4184
4461
  'custom_json'?: string;
4462
+ /**
4463
+ * ============================================================================ Navigation Tracking (V3) ============================================================================
4464
+ */
4465
+ 'destination_url'?: string;
4185
4466
  'device_fingerprint'?: string;
4186
4467
  'device_type'?: string;
4187
4468
  /**
@@ -4256,6 +4537,10 @@ export interface DataTypesEventPayload {
4256
4537
  */
4257
4538
  'section'?: string;
4258
4539
  'session_id'?: string;
4540
+ /**
4541
+ * URL where click originated
4542
+ */
4543
+ 'source_url'?: string;
4259
4544
  'suggestion_id'?: string;
4260
4545
  'suggestion_popularity'?: number;
4261
4546
  'suggestion_source'?: string;
@@ -4291,6 +4576,103 @@ export interface DataTypesEventPayload {
4291
4576
  */
4292
4577
  'xstoreid'?: string;
4293
4578
  }
4579
+ export interface DataTypesExperiment {
4580
+ 'audience_filter'?: object;
4581
+ 'confidence_level'?: number;
4582
+ 'created_at'?: string;
4583
+ 'created_by'?: number;
4584
+ 'description'?: string;
4585
+ 'ended_at'?: string;
4586
+ 'experiment_id'?: string;
4587
+ 'experiment_type'?: DataTypesExperimentType;
4588
+ 'final_results'?: object;
4589
+ 'hypothesis'?: string;
4590
+ 'id'?: number;
4591
+ 'max_duration_days'?: number;
4592
+ 'min_sample_size'?: number;
4593
+ 'name'?: string;
4594
+ 'org_id'?: number;
4595
+ 'primary_metric'?: string;
4596
+ 'scheduled_end_at'?: string;
4597
+ 'scheduled_start_at'?: string;
4598
+ 'secondary_metrics'?: Array<string>;
4599
+ 'started_at'?: string;
4600
+ 'statistical_significance'?: number;
4601
+ 'status'?: DataTypesExperimentStatus;
4602
+ 'store_id'?: number;
4603
+ 'traffic_percentage'?: number;
4604
+ 'updated_at'?: string;
4605
+ 'updated_by'?: number;
4606
+ 'variants'?: Array<DataTypesExperimentVariant>;
4607
+ 'winner_variant'?: string;
4608
+ }
4609
+ export interface DataTypesExperimentAssignment {
4610
+ 'experiment_id'?: string;
4611
+ 'variant_config'?: {
4612
+ [key: string]: any;
4613
+ };
4614
+ 'variant_id'?: string;
4615
+ }
4616
+ export interface DataTypesExperimentAssignmentResponse {
4617
+ 'assignments'?: Array<DataTypesExperimentAssignment>;
4618
+ }
4619
+ export interface DataTypesExperimentResults {
4620
+ 'confidence_level'?: number;
4621
+ 'conversion_lift'?: number;
4622
+ 'ctr_lift'?: number;
4623
+ 'ended_at'?: string;
4624
+ 'experiment_id'?: string;
4625
+ 'is_significant'?: boolean;
4626
+ 'name'?: string;
4627
+ 'revenue_lift'?: number;
4628
+ 'started_at'?: string;
4629
+ 'status'?: DataTypesExperimentStatus;
4630
+ 'variants'?: Array<DataTypesExperimentVariantResult>;
4631
+ 'winner'?: string;
4632
+ }
4633
+ export declare const DataTypesExperimentStatus: {
4634
+ readonly ExperimentStatusDraft: "draft";
4635
+ readonly ExperimentStatusScheduled: "scheduled";
4636
+ readonly ExperimentStatusRunning: "running";
4637
+ readonly ExperimentStatusPaused: "paused";
4638
+ readonly ExperimentStatusCompleted: "completed";
4639
+ readonly ExperimentStatusArchived: "archived";
4640
+ };
4641
+ export type DataTypesExperimentStatus = typeof DataTypesExperimentStatus[keyof typeof DataTypesExperimentStatus];
4642
+ export declare const DataTypesExperimentType: {
4643
+ readonly ExperimentTypeSearchRanking: "search_ranking";
4644
+ readonly ExperimentTypeRecommendation: "recommendation";
4645
+ readonly ExperimentTypePersonalization: "personalization";
4646
+ readonly ExperimentTypeUI: "ui";
4647
+ readonly ExperimentTypePricing: "pricing";
4648
+ readonly ExperimentTypeOther: "other";
4649
+ };
4650
+ export type DataTypesExperimentType = typeof DataTypesExperimentType[keyof typeof DataTypesExperimentType];
4651
+ export interface DataTypesExperimentVariant {
4652
+ 'config'?: {
4653
+ [key: string]: any;
4654
+ };
4655
+ 'id'?: string;
4656
+ 'name'?: string;
4657
+ /**
4658
+ * Traffic weight percentage (e.g., 50 = 50%)
4659
+ */
4660
+ 'weight'?: number;
4661
+ }
4662
+ export interface DataTypesExperimentVariantResult {
4663
+ 'avg_latency_ms'?: number;
4664
+ 'conversion_rate'?: number;
4665
+ 'conversions'?: number;
4666
+ 'ctr'?: number;
4667
+ 'revenue'?: number;
4668
+ 'revenue_per_user'?: number;
4669
+ 'total_clicks'?: number;
4670
+ 'total_searches'?: number;
4671
+ 'unique_users'?: number;
4672
+ 'variant_id'?: string;
4673
+ 'variant_name'?: string;
4674
+ 'zero_result_rate'?: number;
4675
+ }
4294
4676
  export interface DataTypesFacetRange {
4295
4677
  /**
4296
4678
  * Range start (inclusive), omit for no lower bound
@@ -4315,6 +4697,21 @@ export interface DataTypesFacetRangeConfig {
4315
4697
  */
4316
4698
  'ranges'?: Array<DataTypesFacetRange>;
4317
4699
  }
4700
+ export interface DataTypesFacetValuesSearchRequest {
4701
+ 'facet_query': string;
4702
+ 'filter'?: string;
4703
+ 'max_values'?: number;
4704
+ 'q'?: string;
4705
+ }
4706
+ export interface DataTypesFacetValuesSearchResponse {
4707
+ 'facet_name'?: string;
4708
+ 'values'?: Array<DataTypesFilterValue>;
4709
+ }
4710
+ export interface DataTypesFacetValuesSearchResponseWrapper {
4711
+ 'data'?: DataTypesFacetValuesSearchResponse;
4712
+ 'message'?: string;
4713
+ 'status'?: number;
4714
+ }
4318
4715
  export interface DataTypesFeatureCheckResult {
4319
4716
  'allowed'?: boolean;
4320
4717
  'current_usage'?: number;
@@ -4422,6 +4819,38 @@ export interface DataTypesFieldMetadata {
4422
4819
  */
4423
4820
  'type'?: string;
4424
4821
  }
4822
+ export interface DataTypesFilterField {
4823
+ 'field'?: string;
4824
+ 'stats'?: DataTypesFilterStats;
4825
+ 'total_values'?: number;
4826
+ /**
4827
+ * \"categorical\", \"numeric\", \"boolean\"
4828
+ */
4829
+ 'type'?: string;
4830
+ 'values'?: Array<DataTypesFilterValue>;
4831
+ }
4832
+ export interface DataTypesFilterSchemaField {
4833
+ 'facetable'?: boolean;
4834
+ /**
4835
+ * \"categorical\", \"numeric\", \"boolean\"
4836
+ */
4837
+ 'filter_type'?: string;
4838
+ 'name'?: string;
4839
+ 'ranges'?: Array<DataTypesFacetRange>;
4840
+ 'sortable'?: boolean;
4841
+ 'type'?: string;
4842
+ }
4843
+ export interface DataTypesFilterStats {
4844
+ 'avg'?: number;
4845
+ 'max'?: number;
4846
+ 'min'?: number;
4847
+ 'sum'?: number;
4848
+ }
4849
+ export interface DataTypesFilterValue {
4850
+ 'count'?: number;
4851
+ 'highlighted'?: string;
4852
+ 'value'?: string;
4853
+ }
4425
4854
  export interface DataTypesFilteredTabConfig {
4426
4855
  /**
4427
4856
  * Optional description for the tab
@@ -4458,6 +4887,32 @@ export interface DataTypesFilteredTabConfig {
4458
4887
  */
4459
4888
  'sort_by'?: string;
4460
4889
  }
4890
+ export interface DataTypesFiltersRequest {
4891
+ 'disjunctive_facets'?: Array<string>;
4892
+ 'facet_by'?: string;
4893
+ 'filter'?: string;
4894
+ 'max_facet_values'?: number;
4895
+ 'q'?: string;
4896
+ }
4897
+ export interface DataTypesFiltersResponse {
4898
+ 'filters'?: Array<DataTypesFilterField>;
4899
+ 'total_results'?: number;
4900
+ }
4901
+ export interface DataTypesFiltersResponseWrapper {
4902
+ 'data'?: DataTypesFiltersResponse;
4903
+ 'message'?: string;
4904
+ 'status'?: number;
4905
+ }
4906
+ export interface DataTypesFiltersSchemaResponse {
4907
+ 'default_facets'?: Array<string>;
4908
+ 'fields'?: Array<DataTypesFilterSchemaField>;
4909
+ 'max_facet_values'?: number;
4910
+ }
4911
+ export interface DataTypesFiltersSchemaResponseWrapper {
4912
+ 'data'?: DataTypesFiltersSchemaResponse;
4913
+ 'message'?: string;
4914
+ 'status'?: number;
4915
+ }
4461
4916
  export interface DataTypesForgotPasswordRequest {
4462
4917
  'email': string;
4463
4918
  }
@@ -4558,12 +5013,22 @@ export interface DataTypesGenericResponseAnalyticsConversionMetrics {
4558
5013
  'message'?: string;
4559
5014
  'status'?: number;
4560
5015
  }
4561
- export interface DataTypesGenericResponseAnalyticsFunnel {
4562
- 'data'?: AnalyticsFunnel;
5016
+ export interface DataTypesGenericResponseAnalyticsCustomEventFieldBreakdown {
5017
+ 'data'?: AnalyticsCustomEventFieldBreakdown;
4563
5018
  'message'?: string;
4564
5019
  'status'?: number;
4565
5020
  }
4566
- export interface DataTypesGenericResponseAnalyticsFunnelData {
5021
+ export interface DataTypesGenericResponseAnalyticsCustomEventMetrics {
5022
+ 'data'?: AnalyticsCustomEventMetrics;
5023
+ 'message'?: string;
5024
+ 'status'?: number;
5025
+ }
5026
+ export interface DataTypesGenericResponseAnalyticsFunnel {
5027
+ 'data'?: AnalyticsFunnel;
5028
+ 'message'?: string;
5029
+ 'status'?: number;
5030
+ }
5031
+ export interface DataTypesGenericResponseAnalyticsFunnelData {
4567
5032
  'data'?: AnalyticsFunnelData;
4568
5033
  'message'?: string;
4569
5034
  'status'?: number;
@@ -4588,6 +5053,11 @@ export interface DataTypesGenericResponseAnalyticsModelComparisonResponse {
4588
5053
  'message'?: string;
4589
5054
  'status'?: number;
4590
5055
  }
5056
+ export interface DataTypesGenericResponseAnalyticsPaginatedResponseAnalyticsCustomEventRow {
5057
+ 'data'?: AnalyticsPaginatedResponseAnalyticsCustomEventRow;
5058
+ 'message'?: string;
5059
+ 'status'?: number;
5060
+ }
4591
5061
  export interface DataTypesGenericResponseAnalyticsPerformanceBySurfaceResponse {
4592
5062
  'data'?: AnalyticsPerformanceBySurfaceResponse;
4593
5063
  'message'?: string;
@@ -4633,6 +5103,16 @@ export interface DataTypesGenericResponseAny {
4633
5103
  'message'?: string;
4634
5104
  'status'?: number;
4635
5105
  }
5106
+ export interface DataTypesGenericResponseArrayAnalyticsCustomEventSummary {
5107
+ 'data'?: Array<AnalyticsCustomEventSummary>;
5108
+ 'message'?: string;
5109
+ 'status'?: number;
5110
+ }
5111
+ export interface DataTypesGenericResponseArrayAnalyticsCustomEventTimeSeriesPoint {
5112
+ 'data'?: Array<AnalyticsCustomEventTimeSeriesPoint>;
5113
+ 'message'?: string;
5114
+ 'status'?: number;
5115
+ }
4636
5116
  export interface DataTypesGenericResponseArrayAnalyticsFunnel {
4637
5117
  'data'?: Array<AnalyticsFunnel>;
4638
5118
  'message'?: string;
@@ -4708,6 +5188,16 @@ export interface DataTypesGenericResponseDataTypesBillingOrderDetailsResponse {
4708
5188
  'message'?: string;
4709
5189
  'status'?: number;
4710
5190
  }
5191
+ export interface DataTypesGenericResponseDataTypesBillingOverviewNewResponse {
5192
+ 'data'?: DataTypesBillingOverviewNewResponse;
5193
+ 'message'?: string;
5194
+ 'status'?: number;
5195
+ }
5196
+ export interface DataTypesGenericResponseDataTypesConsumptionHistoryResponse {
5197
+ 'data'?: DataTypesConsumptionHistoryResponse;
5198
+ 'message'?: string;
5199
+ 'status'?: number;
5200
+ }
4711
5201
  export interface DataTypesGenericResponseDataTypesCreditsConsumedGraphResponse {
4712
5202
  'data'?: DataTypesCreditsConsumedGraphResponse;
4713
5203
  'message'?: string;
@@ -5005,6 +5495,10 @@ export interface DataTypesIndexConfig {
5005
5495
  'enable_highlight'?: boolean;
5006
5496
  'enable_overrides'?: boolean;
5007
5497
  'enable_smart_autocomplete'?: boolean;
5498
+ /**
5499
+ * Enable stemming on search collections
5500
+ */
5501
+ 'enable_stemming'?: boolean;
5008
5502
  'enable_typo_highlight'?: boolean;
5009
5503
  'enable_typo_tolerance'?: boolean;
5010
5504
  /**
@@ -5097,6 +5591,10 @@ export interface DataTypesIndexConfig {
5097
5591
  * No omitempty to preserve empty arrays
5098
5592
  */
5099
5593
  'sort_by'?: Array<DataTypesSortField>;
5594
+ /**
5595
+ * Locale for stemming (e.g., \"en\", \"fr\", \"de\")
5596
+ */
5597
+ 'stemming_locale'?: string;
5100
5598
  /**
5101
5599
  * Flattened stopwords and synonyms fields
5102
5600
  */
@@ -5778,6 +6276,13 @@ export interface DataTypesNewsLetterRequestsListResponse {
5778
6276
  'message'?: string;
5779
6277
  'status'?: number;
5780
6278
  }
6279
+ export interface DataTypesNextChargeInfo {
6280
+ 'amount'?: number;
6281
+ 'charge_date'?: string;
6282
+ 'currency'?: string;
6283
+ 'description'?: string;
6284
+ 'subscription_id'?: number;
6285
+ }
5781
6286
  export interface DataTypesNotification {
5782
6287
  'action_label'?: string;
5783
6288
  /**
@@ -6345,6 +6850,10 @@ export interface DataTypesOrgMemberWithUser {
6345
6850
  'email'?: string;
6346
6851
  'first_name'?: string;
6347
6852
  'is_active'?: boolean;
6853
+ /**
6854
+ * True if user is the organization owner (non-deletable)
6855
+ */
6856
+ 'is_owner'?: boolean;
6348
6857
  /**
6349
6858
  * True if user has custom/user-specific role
6350
6859
  */
@@ -6639,6 +7148,12 @@ export interface DataTypesOverrideActions {
6639
7148
  'sort'?: string;
6640
7149
  'stop_processing'?: boolean;
6641
7150
  }
7151
+ export interface DataTypesPaginationInfo {
7152
+ 'limit'?: number;
7153
+ 'page'?: number;
7154
+ 'total'?: number;
7155
+ 'total_pages'?: number;
7156
+ }
6642
7157
  export interface DataTypesParentMenu {
6643
7158
  /**
6644
7159
  * VARCHAR(100), nullable
@@ -6992,6 +7507,15 @@ export interface DataTypesProfileResponseWrapper {
6992
7507
  'message'?: string;
6993
7508
  'status'?: number;
6994
7509
  }
7510
+ export interface DataTypesProjectedRunoutInfo {
7511
+ 'average_daily_consumption'?: number;
7512
+ 'days_remaining'?: number;
7513
+ 'projected_runout_date'?: string;
7514
+ /**
7515
+ * \"normal\", \"warning\", \"critical\"
7516
+ */
7517
+ 'warning_level'?: string;
7518
+ }
6995
7519
  export interface DataTypesPublicCreateStoreRequest {
6996
7520
  /**
6997
7521
  * Optional: array of documents to import immediately
@@ -7396,6 +7920,10 @@ export interface DataTypesRole {
7396
7920
  * BOOLEAN, DEFAULT FALSE
7397
7921
  */
7398
7922
  'isDeleted'?: boolean;
7923
+ /**
7924
+ * BOOLEAN, DEFAULT FALSE - TRUE for system-created roles (non-editable)
7925
+ */
7926
+ 'isSystemCreated'?: boolean;
7399
7927
  /**
7400
7928
  * BOOLEAN, DEFAULT FALSE - TRUE for user-specific custom roles
7401
7929
  */
@@ -7716,6 +8244,7 @@ export interface DataTypesSchemaBasedDefaults {
7716
8244
  'facetable_fields'?: Array<string>;
7717
8245
  'highlightable_fields'?: Array<string>;
7718
8246
  'include_fields'?: Array<string>;
8247
+ 'numeric_facetable_fields'?: Array<string>;
7719
8248
  'query_by'?: Array<string>;
7720
8249
  'sortable_fields'?: Array<DataTypesSortField>;
7721
8250
  }
@@ -7945,6 +8474,115 @@ export interface DataTypesSetUserCustomPermissionsRequest {
7945
8474
  */
7946
8475
  'storeAccessGrouped'?: Array<DataTypesGroupedStoreAccess>;
7947
8476
  }
8477
+ export interface DataTypesSlimGroupedPermissionsRequest {
8478
+ 'modules'?: Array<DataTypesSlimModuleGroupRequest>;
8479
+ }
8480
+ export interface DataTypesSlimGroupedRolePermissions {
8481
+ 'modules'?: Array<DataTypesSlimModuleGroup>;
8482
+ }
8483
+ export interface DataTypesSlimGroupedStoreAccess {
8484
+ 'access_level'?: string;
8485
+ 'can_add'?: boolean;
8486
+ 'can_approve'?: boolean;
8487
+ 'can_delete'?: boolean;
8488
+ 'can_modify'?: boolean;
8489
+ 'can_view'?: boolean;
8490
+ 'full_access'?: boolean;
8491
+ 'modules'?: Array<DataTypesSlimModuleGroup>;
8492
+ 'storeId'?: number;
8493
+ 'storeName'?: string;
8494
+ }
8495
+ export interface DataTypesSlimMenu {
8496
+ 'icon'?: string;
8497
+ 'isParentMenu'?: boolean;
8498
+ 'menuId'?: number;
8499
+ 'menuName'?: string;
8500
+ 'moduleType'?: string;
8501
+ 'parentId'?: number;
8502
+ 'sortOrder'?: number;
8503
+ }
8504
+ export interface DataTypesSlimModuleGroup {
8505
+ 'groups'?: Array<DataTypesSlimParentMenuGroup>;
8506
+ 'moduleType'?: string;
8507
+ }
8508
+ export interface DataTypesSlimModuleGroupRequest {
8509
+ 'groups'?: Array<DataTypesSlimParentMenuGroupRequest>;
8510
+ 'moduleType'?: string;
8511
+ }
8512
+ export interface DataTypesSlimParentMenuGroup {
8513
+ 'children'?: Array<DataTypesSlimRoleRightWithMenu>;
8514
+ 'parentMenu'?: DataTypesSlimRoleRightWithMenu;
8515
+ }
8516
+ export interface DataTypesSlimParentMenuGroupRequest {
8517
+ 'children'?: Array<DataTypesSlimPermissionEntry>;
8518
+ 'parentMenu'?: DataTypesSlimPermissionEntry;
8519
+ }
8520
+ export interface DataTypesSlimPermissionEntry {
8521
+ 'canAdd'?: boolean;
8522
+ 'canApprove'?: boolean;
8523
+ 'canDelete'?: boolean;
8524
+ 'canModify'?: boolean;
8525
+ 'canView'?: boolean;
8526
+ 'fullAccess'?: boolean;
8527
+ 'isEnabled'?: boolean;
8528
+ 'menuId': number;
8529
+ }
8530
+ export interface DataTypesSlimRolePermissionsResponse {
8531
+ 'allStoresFullAccess'?: boolean;
8532
+ 'fullAccess'?: boolean;
8533
+ 'orgLevelMenusGrouped'?: DataTypesSlimGroupedRolePermissions;
8534
+ 'roleId'?: number;
8535
+ 'roleName'?: string;
8536
+ 'storeAccessGrouped'?: Array<DataTypesSlimGroupedStoreAccess>;
8537
+ }
8538
+ export interface DataTypesSlimRoleRightWithMenu {
8539
+ 'canAdd'?: boolean;
8540
+ 'canApprove'?: boolean;
8541
+ 'canDelete'?: boolean;
8542
+ 'canModify'?: boolean;
8543
+ 'canView'?: boolean;
8544
+ 'fullAccess'?: boolean;
8545
+ 'isEnabled'?: boolean;
8546
+ 'menu'?: DataTypesSlimMenu;
8547
+ 'menuId'?: number;
8548
+ 'roleRightId'?: number;
8549
+ }
8550
+ export interface DataTypesSlimStoreAccessRequest {
8551
+ 'access_level'?: string;
8552
+ 'can_add'?: boolean;
8553
+ 'can_approve'?: boolean;
8554
+ 'can_delete'?: boolean;
8555
+ 'can_modify'?: boolean;
8556
+ 'can_view'?: boolean;
8557
+ 'full_access'?: boolean;
8558
+ 'modules'?: Array<DataTypesSlimModuleGroupRequest>;
8559
+ 'storeId': number;
8560
+ }
8561
+ export interface DataTypesSlimUpdateRolePermissionsRequest {
8562
+ 'allStoresFullAccess'?: boolean;
8563
+ 'fullAccess'?: boolean;
8564
+ 'orgLevelMenusGrouped'?: DataTypesSlimGroupedPermissionsRequest;
8565
+ 'roleId'?: number;
8566
+ 'storeAccessGrouped'?: Array<DataTypesSlimStoreAccessRequest>;
8567
+ }
8568
+ export interface DataTypesSlimUpdateUserRolePermissionsRequest {
8569
+ 'allStoresFullAccess'?: boolean;
8570
+ 'fullAccess'?: boolean;
8571
+ 'orgLevelMenusGrouped'?: DataTypesSlimGroupedPermissionsRequest;
8572
+ 'storeAccessGrouped'?: Array<DataTypesSlimStoreAccessRequest>;
8573
+ 'userId'?: number;
8574
+ }
8575
+ export interface DataTypesSlimUserRolePermissionsResponse {
8576
+ 'allStoresFullAccess'?: boolean;
8577
+ 'fullAccess'?: boolean;
8578
+ 'orgLevelMenusGrouped'?: DataTypesSlimGroupedRolePermissions;
8579
+ 'roleId'?: number;
8580
+ 'roleName'?: string;
8581
+ 'storeAccessGrouped'?: Array<DataTypesSlimGroupedStoreAccess>;
8582
+ 'useCustomPermissions'?: boolean;
8583
+ 'userId'?: number;
8584
+ 'userSpecificRoleId'?: number;
8585
+ }
7948
8586
  export interface DataTypesSortField {
7949
8587
  /**
7950
8588
  * \"asc\" or \"desc\"
@@ -8253,6 +8891,11 @@ export interface DataTypesStoresListResponse {
8253
8891
  'message'?: string;
8254
8892
  'status'?: number;
8255
8893
  }
8894
+ export interface DataTypesStringFeatureMetric {
8895
+ 'display_label'?: string;
8896
+ 'feature_name'?: string;
8897
+ 'value'?: string;
8898
+ }
8256
8899
  export interface DataTypesSubMenuAccess {
8257
8900
  /**
8258
8901
  * Store IDs user has access to (for store-specific menus)
@@ -8613,6 +9256,20 @@ export interface DataTypesUpdateCustomWordListRequest {
8613
9256
  'name'?: string;
8614
9257
  'words'?: Array<string>;
8615
9258
  }
9259
+ export interface DataTypesUpdateExperimentRequest {
9260
+ 'audience_filter'?: object;
9261
+ 'description'?: string;
9262
+ 'hypothesis'?: string;
9263
+ 'max_duration_days'?: number;
9264
+ 'min_sample_size'?: number;
9265
+ 'name'?: string;
9266
+ 'primary_metric'?: string;
9267
+ 'scheduled_end_at'?: string;
9268
+ 'scheduled_start_at'?: string;
9269
+ 'secondary_metrics'?: Array<string>;
9270
+ 'traffic_percentage'?: number;
9271
+ 'variants'?: Array<DataTypesExperimentVariant>;
9272
+ }
8616
9273
  export interface DataTypesUpdateIndexSchemaRequest {
8617
9274
  'fields'?: Array<DataTypesUpdateIndexSchemaRequestFieldsInner>;
8618
9275
  'symbols_to_index'?: Array<string>;
@@ -8741,33 +9398,6 @@ export interface DataTypesUpdateProfileRequest {
8741
9398
  */
8742
9399
  'userphone': string;
8743
9400
  }
8744
- export interface DataTypesUpdateRolePermissionsRequest {
8745
- /**
8746
- * Full access to all stores for all users with this role
8747
- */
8748
- 'allStoresFullAccess'?: boolean;
8749
- /**
8750
- * Full access at role level (applies to all stores)
8751
- */
8752
- 'fullAccess'?: boolean;
8753
- /**
8754
- * Org-level menu/route permissions (flat format - for backward compatibility)
8755
- */
8756
- 'orgLevelMenus'?: Array<DataTypesRoleRightRequestDto>;
8757
- /**
8758
- * Grouped structures (preferred format for frontend)
8759
- */
8760
- 'orgLevelMenusGrouped'?: DataTypesGroupedRolePermissions;
8761
- 'roleId': number;
8762
- /**
8763
- * Store-level menu/route permissions (flat format - for backward compatibility)
8764
- */
8765
- 'storeAccess'?: Array<DataTypesStoreLevelMenuRight>;
8766
- /**
8767
- * Store-level menus grouped by module and parent
8768
- */
8769
- 'storeAccessGrouped'?: Array<DataTypesGroupedStoreAccess>;
8770
- }
8771
9401
  export interface DataTypesUpdateSchemaResponse {
8772
9402
  'data'?: string;
8773
9403
  'message'?: string;
@@ -8811,33 +9441,6 @@ export declare const DataTypesUpdateStoreAccessRequestAccessLevelEnum: {
8811
9441
  readonly Admin: "admin";
8812
9442
  };
8813
9443
  export type DataTypesUpdateStoreAccessRequestAccessLevelEnum = typeof DataTypesUpdateStoreAccessRequestAccessLevelEnum[keyof typeof DataTypesUpdateStoreAccessRequestAccessLevelEnum];
8814
- export interface DataTypesUpdateUserRolePermissionsRequest {
8815
- /**
8816
- * Full access to all stores for all users with this role
8817
- */
8818
- 'allStoresFullAccess'?: boolean;
8819
- /**
8820
- * Full access at user-specific role level
8821
- */
8822
- 'fullAccess'?: boolean;
8823
- /**
8824
- * Org-level menu/route permissions (flat format - for backward compatibility)
8825
- */
8826
- 'orgLevelMenus'?: Array<DataTypesRoleRightRequestDto>;
8827
- /**
8828
- * Grouped structures (preferred format for frontend)
8829
- */
8830
- 'orgLevelMenusGrouped'?: DataTypesGroupedRolePermissions;
8831
- /**
8832
- * Store-level menu/route permissions (flat format - for backward compatibility)
8833
- */
8834
- 'storeAccess'?: Array<DataTypesStoreLevelMenuRight>;
8835
- /**
8836
- * Store-level menus grouped by module and parent
8837
- */
8838
- 'storeAccessGrouped'?: Array<DataTypesGroupedStoreAccess>;
8839
- 'userId': number;
8840
- }
8841
9444
  export interface DataTypesUpdateWordStatusRequest {
8842
9445
  /**
8843
9446
  * For custom words
@@ -8900,6 +9503,16 @@ export interface DataTypesUsageBreakdownRow {
8900
9503
  'search_requests'?: number;
8901
9504
  'timestamp'?: string;
8902
9505
  }
9506
+ export interface DataTypesUsageSummary {
9507
+ /**
9508
+ * \"This month\", \"Last 30 days\", etc.
9509
+ */
9510
+ 'period'?: string;
9511
+ 'records'?: number;
9512
+ 'search_requests'?: number;
9513
+ 'store_count'?: number;
9514
+ 'total_credits_used'?: number;
9515
+ }
8903
9516
  export interface DataTypesUser {
8904
9517
  'createdDateTime'?: string;
8905
9518
  'createdUserId'?: number;
@@ -8971,45 +9584,6 @@ export interface DataTypesUserResponse {
8971
9584
  'message'?: string;
8972
9585
  'status'?: number;
8973
9586
  }
8974
- export interface DataTypesUserRolePermissionsResponse {
8975
- /**
8976
- * Full access to all stores for all users with this role
8977
- */
8978
- 'allStoresFullAccess'?: boolean;
8979
- /**
8980
- * All menus available to modifying user
8981
- */
8982
- 'availableMenus'?: Array<DataTypesMenu>;
8983
- /**
8984
- * All stores available to modifying user
8985
- */
8986
- 'availableStores'?: Array<DataTypesStore>;
8987
- /**
8988
- * Full access at user-specific role level
8989
- */
8990
- 'fullAccess'?: boolean;
8991
- /**
8992
- * Org-level menu/route permissions (flat list - for backward compatibility)
8993
- */
8994
- 'orgLevelMenus'?: Array<DataTypesRoleRightWithMenu>;
8995
- /**
8996
- * Grouped structures for frontend display
8997
- */
8998
- 'orgLevelMenusGrouped'?: DataTypesGroupedRolePermissions;
8999
- 'roleId'?: number;
9000
- 'roleName'?: string;
9001
- /**
9002
- * Store-level menu/route permissions (includes store access fields)
9003
- */
9004
- 'storeAccess'?: Array<DataTypesStoreLevelMenuRightWithMenu>;
9005
- /**
9006
- * Store-level menus grouped by module and parent
9007
- */
9008
- 'storeAccessGrouped'?: Array<DataTypesGroupedStoreAccess>;
9009
- 'useCustomPermissions'?: boolean;
9010
- 'userId'?: number;
9011
- 'userSpecificRoleId'?: number;
9012
- }
9013
9587
  export interface DataTypesUserStoreAccess {
9014
9588
  'access_level'?: string;
9015
9589
  'can_add'?: boolean;
@@ -9202,12 +9776,49 @@ export interface FeatureLimitServiceAPICallStatus {
9202
9776
  'usage_percent'?: number;
9203
9777
  }
9204
9778
  export interface FeatureLimitServiceCreditStatus {
9779
+ /**
9780
+ * Remaining in THIS cycle (total - consumed_this_cycle)
9781
+ */
9205
9782
  'available'?: number;
9206
- 'consumed'?: number;
9207
- 'expiring_credits'?: number;
9208
- 'expiry_date'?: string;
9783
+ /**
9784
+ * Credits consumed in THIS billing cycle
9785
+ */
9786
+ 'consumed_this_cycle'?: number;
9787
+ /**
9788
+ * Billing cycle end date
9789
+ */
9790
+ 'cycle_end'?: string;
9791
+ /**
9792
+ * Billing cycle start date
9793
+ */
9794
+ 'cycle_start'?: string;
9795
+ /**
9796
+ * True if actual balance (subscription + topup) <= 0
9797
+ */
9209
9798
  'is_exhausted'?: boolean;
9799
+ /**
9800
+ * All-time consumed credits
9801
+ */
9802
+ 'lifetime_consumed'?: number;
9803
+ /**
9804
+ * All-time purchased credits
9805
+ */
9806
+ 'lifetime_purchased'?: number;
9807
+ /**
9808
+ * Actual subscription balance (includes rollover across cycles)
9809
+ */
9810
+ 'subscription_available'?: number;
9811
+ /**
9812
+ * Actual top-up balance (purchased credits, never expire)
9813
+ */
9814
+ 'topup_available'?: number;
9815
+ /**
9816
+ * THIS cycle\'s allocated credits (e.g., 1,600,000/month)
9817
+ */
9210
9818
  'total'?: number;
9819
+ /**
9820
+ * consumed_this_cycle / total * 100
9821
+ */
9211
9822
  'usage_percent'?: number;
9212
9823
  }
9213
9824
  export interface FeatureLimitServiceFeatureStatus {
@@ -9427,6 +10038,10 @@ export interface ModelsAffinityScore {
9427
10038
  }
9428
10039
  export interface ModelsCreateCustomEventFieldRequest {
9429
10040
  'allowed_values'?: Array<string>;
10041
+ /**
10042
+ * for array type: string, number, boolean, datetime, object, mixed
10043
+ */
10044
+ 'array_item_type'?: string;
9430
10045
  'default_value'?: string;
9431
10046
  'description'?: string;
9432
10047
  'display_name'?: string;
@@ -9443,7 +10058,15 @@ export interface ModelsCreateCustomEventFieldRequest {
9443
10058
  'is_required'?: boolean;
9444
10059
  'max_length'?: number;
9445
10060
  'max_value'?: number;
10061
+ /**
10062
+ * string min length; array min items
10063
+ */
10064
+ 'min_length'?: number;
9446
10065
  'min_value'?: number;
10066
+ /**
10067
+ * for object type
10068
+ */
10069
+ 'nested_schema'?: Array<ModelsNestedPropertyDefinition>;
9447
10070
  'validation_regex'?: string;
9448
10071
  }
9449
10072
  export declare const ModelsCreateCustomEventFieldRequestFieldTypeEnum: {
@@ -9452,6 +10075,7 @@ export declare const ModelsCreateCustomEventFieldRequestFieldTypeEnum: {
9452
10075
  readonly Boolean: "boolean";
9453
10076
  readonly Datetime: "datetime";
9454
10077
  readonly Array: "array";
10078
+ readonly Object: "object";
9455
10079
  };
9456
10080
  export type ModelsCreateCustomEventFieldRequestFieldTypeEnum = typeof ModelsCreateCustomEventFieldRequestFieldTypeEnum[keyof typeof ModelsCreateCustomEventFieldRequestFieldTypeEnum];
9457
10081
  export interface ModelsCreateCustomEventTypeRequest {
@@ -9478,6 +10102,42 @@ export interface ModelsMergeProfilesResponse {
9478
10102
  'profiles_affected'?: number;
9479
10103
  'success'?: boolean;
9480
10104
  }
10105
+ export interface ModelsNestedPropertyDefinition {
10106
+ 'allowed_values'?: Array<any>;
10107
+ /**
10108
+ * if array_item_type is object
10109
+ */
10110
+ 'array_item_schema'?: ModelsNestedPropertyDefinition;
10111
+ /**
10112
+ * For array type: define the type of array items
10113
+ */
10114
+ 'array_item_type'?: string;
10115
+ 'description'?: string;
10116
+ /**
10117
+ * string max length / array max items
10118
+ */
10119
+ 'max_length'?: number;
10120
+ 'max_value'?: number;
10121
+ /**
10122
+ * string min length / array min items
10123
+ */
10124
+ 'min_length'?: number;
10125
+ 'min_value'?: number;
10126
+ 'name'?: string;
10127
+ /**
10128
+ * For object type: nested properties (recursive)
10129
+ */
10130
+ 'properties'?: Array<ModelsNestedPropertyDefinition>;
10131
+ 'required'?: boolean;
10132
+ /**
10133
+ * string, number, boolean, datetime, array, object
10134
+ */
10135
+ 'type'?: string;
10136
+ /**
10137
+ * Validation for string/number/array types
10138
+ */
10139
+ 'validation_regex'?: string;
10140
+ }
9481
10141
  export interface ModelsPersonalizationContext {
9482
10142
  'avg_order_value'?: number;
9483
10143
  'commerce_score'?: number;
@@ -9520,6 +10180,10 @@ export interface ModelsSimilarUser {
9520
10180
  }
9521
10181
  export interface ModelsUpdateCustomEventFieldRequest {
9522
10182
  'allowed_values'?: Array<string>;
10183
+ /**
10184
+ * for array type: string, number, boolean, datetime, object, mixed
10185
+ */
10186
+ 'array_item_type'?: string;
9523
10187
  'default_value'?: string;
9524
10188
  'description'?: string;
9525
10189
  'display_name'?: string;
@@ -9528,7 +10192,9 @@ export interface ModelsUpdateCustomEventFieldRequest {
9528
10192
  'is_required'?: boolean;
9529
10193
  'max_length'?: number;
9530
10194
  'max_value'?: number;
10195
+ 'min_length'?: number;
9531
10196
  'min_value'?: number;
10197
+ 'nested_schema'?: Array<ModelsNestedPropertyDefinition>;
9532
10198
  'validation_regex'?: string;
9533
10199
  }
9534
10200
  export interface ModelsUpdateCustomEventTypeRequest {
@@ -10027,6 +10693,10 @@ export interface QuerySuggestionsServiceQuerySuggestionConfig {
10027
10693
  * Improve relevance using Rules
10028
10694
  */
10029
10695
  'enable_rules'?: boolean;
10696
+ /**
10697
+ * Stemming configuration
10698
+ */
10699
+ 'enable_stemming'?: boolean;
10030
10700
  /**
10031
10701
  * Whether query suggestions are enabled for the store
10032
10702
  */
@@ -10075,6 +10745,10 @@ export interface QuerySuggestionsServiceQuerySuggestionConfig {
10075
10745
  * Enable special characters in tokenization (maps to token_separators and symbols_to_index)
10076
10746
  */
10077
10747
  'special_chars'?: boolean;
10748
+ /**
10749
+ * Locale for stemming (derived from Languages[0], fallback \"en\")
10750
+ */
10751
+ 'stemming_locale'?: string;
10078
10752
  /**
10079
10753
  * Whether to sync enabled suggestions to Typesense
10080
10754
  */
@@ -10607,6 +11281,10 @@ export interface QuerySuggestionsServiceUpdateSuggestionConfigRequest {
10607
11281
  * Enable rules
10608
11282
  */
10609
11283
  'enable_rules'?: boolean;
11284
+ /**
11285
+ * Enable stemming on query suggestions collection
11286
+ */
11287
+ 'enable_stemming'?: boolean;
10610
11288
  /**
10611
11289
  * Enable/disable query suggestions for the store
10612
11290
  */
@@ -10643,6 +11321,10 @@ export interface QuerySuggestionsServiceUpdateSuggestionConfigRequest {
10643
11321
  * Enable special characters in tokenization
10644
11322
  */
10645
11323
  'special_chars'?: boolean;
11324
+ /**
11325
+ * Locale for stemming
11326
+ */
11327
+ 'stemming_locale'?: string;
10646
11328
  /**
10647
11329
  * Enable/disable syncing suggestions to Typesense
10648
11330
  */
@@ -11329,61 +12011,201 @@ export declare class AnalyticsEventsApi extends BaseAPI {
11329
12011
  */
11330
12012
  analyticsValidatePost(xStoreid: string, xStoresecret: string, dataTypesEventPayload: DataTypesEventPayload, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesResponse, any, {}>>;
11331
12013
  }
12014
+ /**
12015
+ * FiltersApi - axios parameter creator
12016
+ */
12017
+ export declare const FiltersApiAxiosParamCreator: (configuration?: Configuration) => {
12018
+ /**
12019
+ * Search or autocomplete within a single facet\'s values. Useful for facets with many values (e.g., brands) where you need typeahead search.
12020
+ * @summary Search Facet Values
12021
+ * @param {string} xStoreid Store ID (from dashboard)
12022
+ * @param {string} xStoresecret Store read secret (from dashboard)
12023
+ * @param {string} facetName Facet field name (e.g., brand, category)
12024
+ * @param {DataTypesFacetValuesSearchRequest} dataTypesFacetValuesSearchRequest Facet search query
12025
+ * @param {*} [options] Override http request option.
12026
+ * @throws {RequiredError}
12027
+ */
12028
+ v1FiltersFacetNameValuesPost: (xStoreid: string, xStoresecret: string, facetName: string, dataTypesFacetValuesSearchRequest: DataTypesFacetValuesSearchRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
12029
+ /**
12030
+ * Get filter values and counts for configured facets. Use this to build faceted navigation UIs. Supports disjunctive faceting for OR-based filter combinations.
12031
+ * @summary Get Filters
12032
+ * @param {string} xStoreid Store ID (from dashboard)
12033
+ * @param {string} xStoresecret Store read secret (from dashboard)
12034
+ * @param {DataTypesFiltersRequest} [dataTypesFiltersRequest] Filter options
12035
+ * @param {*} [options] Override http request option.
12036
+ * @throws {RequiredError}
12037
+ */
12038
+ v1FiltersPost: (xStoreid: string, xStoresecret: string, dataTypesFiltersRequest?: DataTypesFiltersRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
12039
+ /**
12040
+ * Get available filter field metadata including types, sortability, and configured ranges. Useful for dynamically building filter UIs.
12041
+ * @summary Get Filters Schema
12042
+ * @param {string} xStoreid Store ID (from dashboard)
12043
+ * @param {string} xStoresecret Store read secret (from dashboard)
12044
+ * @param {*} [options] Override http request option.
12045
+ * @throws {RequiredError}
12046
+ */
12047
+ v1FiltersSchemaGet: (xStoreid: string, xStoresecret: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
12048
+ };
12049
+ /**
12050
+ * FiltersApi - functional programming interface
12051
+ */
12052
+ export declare const FiltersApiFp: (configuration?: Configuration) => {
12053
+ /**
12054
+ * Search or autocomplete within a single facet\'s values. Useful for facets with many values (e.g., brands) where you need typeahead search.
12055
+ * @summary Search Facet Values
12056
+ * @param {string} xStoreid Store ID (from dashboard)
12057
+ * @param {string} xStoresecret Store read secret (from dashboard)
12058
+ * @param {string} facetName Facet field name (e.g., brand, category)
12059
+ * @param {DataTypesFacetValuesSearchRequest} dataTypesFacetValuesSearchRequest Facet search query
12060
+ * @param {*} [options] Override http request option.
12061
+ * @throws {RequiredError}
12062
+ */
12063
+ v1FiltersFacetNameValuesPost(xStoreid: string, xStoresecret: string, facetName: string, dataTypesFacetValuesSearchRequest: DataTypesFacetValuesSearchRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesFacetValuesSearchResponseWrapper>>;
12064
+ /**
12065
+ * Get filter values and counts for configured facets. Use this to build faceted navigation UIs. Supports disjunctive faceting for OR-based filter combinations.
12066
+ * @summary Get Filters
12067
+ * @param {string} xStoreid Store ID (from dashboard)
12068
+ * @param {string} xStoresecret Store read secret (from dashboard)
12069
+ * @param {DataTypesFiltersRequest} [dataTypesFiltersRequest] Filter options
12070
+ * @param {*} [options] Override http request option.
12071
+ * @throws {RequiredError}
12072
+ */
12073
+ v1FiltersPost(xStoreid: string, xStoresecret: string, dataTypesFiltersRequest?: DataTypesFiltersRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesFiltersResponseWrapper>>;
12074
+ /**
12075
+ * Get available filter field metadata including types, sortability, and configured ranges. Useful for dynamically building filter UIs.
12076
+ * @summary Get Filters Schema
12077
+ * @param {string} xStoreid Store ID (from dashboard)
12078
+ * @param {string} xStoresecret Store read secret (from dashboard)
12079
+ * @param {*} [options] Override http request option.
12080
+ * @throws {RequiredError}
12081
+ */
12082
+ v1FiltersSchemaGet(xStoreid: string, xStoresecret: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesFiltersSchemaResponseWrapper>>;
12083
+ };
12084
+ /**
12085
+ * FiltersApi - factory interface
12086
+ */
12087
+ export declare const FiltersApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
12088
+ /**
12089
+ * Search or autocomplete within a single facet\'s values. Useful for facets with many values (e.g., brands) where you need typeahead search.
12090
+ * @summary Search Facet Values
12091
+ * @param {string} xStoreid Store ID (from dashboard)
12092
+ * @param {string} xStoresecret Store read secret (from dashboard)
12093
+ * @param {string} facetName Facet field name (e.g., brand, category)
12094
+ * @param {DataTypesFacetValuesSearchRequest} dataTypesFacetValuesSearchRequest Facet search query
12095
+ * @param {*} [options] Override http request option.
12096
+ * @throws {RequiredError}
12097
+ */
12098
+ v1FiltersFacetNameValuesPost(xStoreid: string, xStoresecret: string, facetName: string, dataTypesFacetValuesSearchRequest: DataTypesFacetValuesSearchRequest, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesFacetValuesSearchResponseWrapper>;
12099
+ /**
12100
+ * Get filter values and counts for configured facets. Use this to build faceted navigation UIs. Supports disjunctive faceting for OR-based filter combinations.
12101
+ * @summary Get Filters
12102
+ * @param {string} xStoreid Store ID (from dashboard)
12103
+ * @param {string} xStoresecret Store read secret (from dashboard)
12104
+ * @param {DataTypesFiltersRequest} [dataTypesFiltersRequest] Filter options
12105
+ * @param {*} [options] Override http request option.
12106
+ * @throws {RequiredError}
12107
+ */
12108
+ v1FiltersPost(xStoreid: string, xStoresecret: string, dataTypesFiltersRequest?: DataTypesFiltersRequest, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesFiltersResponseWrapper>;
12109
+ /**
12110
+ * Get available filter field metadata including types, sortability, and configured ranges. Useful for dynamically building filter UIs.
12111
+ * @summary Get Filters Schema
12112
+ * @param {string} xStoreid Store ID (from dashboard)
12113
+ * @param {string} xStoresecret Store read secret (from dashboard)
12114
+ * @param {*} [options] Override http request option.
12115
+ * @throws {RequiredError}
12116
+ */
12117
+ v1FiltersSchemaGet(xStoreid: string, xStoresecret: string, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesFiltersSchemaResponseWrapper>;
12118
+ };
12119
+ /**
12120
+ * FiltersApi - object-oriented interface
12121
+ */
12122
+ export declare class FiltersApi extends BaseAPI {
12123
+ /**
12124
+ * Search or autocomplete within a single facet\'s values. Useful for facets with many values (e.g., brands) where you need typeahead search.
12125
+ * @summary Search Facet Values
12126
+ * @param {string} xStoreid Store ID (from dashboard)
12127
+ * @param {string} xStoresecret Store read secret (from dashboard)
12128
+ * @param {string} facetName Facet field name (e.g., brand, category)
12129
+ * @param {DataTypesFacetValuesSearchRequest} dataTypesFacetValuesSearchRequest Facet search query
12130
+ * @param {*} [options] Override http request option.
12131
+ * @throws {RequiredError}
12132
+ */
12133
+ v1FiltersFacetNameValuesPost(xStoreid: string, xStoresecret: string, facetName: string, dataTypesFacetValuesSearchRequest: DataTypesFacetValuesSearchRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesFacetValuesSearchResponseWrapper, any, {}>>;
12134
+ /**
12135
+ * Get filter values and counts for configured facets. Use this to build faceted navigation UIs. Supports disjunctive faceting for OR-based filter combinations.
12136
+ * @summary Get Filters
12137
+ * @param {string} xStoreid Store ID (from dashboard)
12138
+ * @param {string} xStoresecret Store read secret (from dashboard)
12139
+ * @param {DataTypesFiltersRequest} [dataTypesFiltersRequest] Filter options
12140
+ * @param {*} [options] Override http request option.
12141
+ * @throws {RequiredError}
12142
+ */
12143
+ v1FiltersPost(xStoreid: string, xStoresecret: string, dataTypesFiltersRequest?: DataTypesFiltersRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesFiltersResponseWrapper, any, {}>>;
12144
+ /**
12145
+ * Get available filter field metadata including types, sortability, and configured ranges. Useful for dynamically building filter UIs.
12146
+ * @summary Get Filters Schema
12147
+ * @param {string} xStoreid Store ID (from dashboard)
12148
+ * @param {string} xStoresecret Store read secret (from dashboard)
12149
+ * @param {*} [options] Override http request option.
12150
+ * @throws {RequiredError}
12151
+ */
12152
+ v1FiltersSchemaGet(xStoreid: string, xStoresecret: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesFiltersSchemaResponseWrapper, any, {}>>;
12153
+ }
11332
12154
  /**
11333
12155
  * QuerySuggestionsApi - axios parameter creator
11334
12156
  */
11335
12157
  export declare const QuerySuggestionsApiAxiosParamCreator: (configuration?: Configuration) => {
11336
12158
  /**
11337
- * Retrieve configuration settings for query suggestions API including limits, supported time ranges, and default values
11338
- * @summary Get Query Suggestions Configuration
11339
- * @param {string} xStoreid Store ID
11340
- * @param {string} xStoresecret Store Secret
12159
+ * Returns limits, supported time ranges, and default values for the query suggestions API. **Auth:** `x-storeid` and `x-storesecret`.
12160
+ * @summary Get suggestions configuration
12161
+ * @param {string} xStoreid Store ID (from dashboard)
12162
+ * @param {string} xStoresecret Store read secret
11341
12163
  * @param {*} [options] Override http request option.
11342
12164
  * @throws {RequiredError}
11343
12165
  */
11344
12166
  v1SuggestionsConfigGet: (xStoreid: string, xStoresecret: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
11345
12167
  /**
11346
- * Retrieve query suggestions based on search analytics data with popularity ranking and optional category/facet enrichment. Supports partial query matching, analytics tags filtering, configurable time ranges, and dropdown recommendations with filtered tabs. Supports personalization via x-user-id, x-anon-id, x-session-id headers. Full feature parity with POST endpoint.
11347
- * @summary Get Query Suggestions
11348
- * @param {string} xStoreid Store ID
11349
- * @param {string} xStoresecret Store Secret
11350
- * @param {string} [xUserId] User ID for personalization (logged-in user)
11351
- * @param {string} [xAnonId] Anonymous ID for personalization (cookie/device ID)
12168
+ * Autocomplete suggestions for search, ranked by popularity. **Auth:** `x-storeid` and `x-storesecret` (from dashboard). Optional: `x-user-id`, `x-anon-id`, `x-session-id` for personalization. Supports partial query, filters (analytics_tags), time range (7d/30d/90d), categories, facets, and dropdown recommendations. Use `query` or `q` for the partial search string.
12169
+ * @summary Get query suggestions (GET)
12170
+ * @param {string} xStoreid Store ID (from dashboard)
12171
+ * @param {string} xStoresecret Store read secret
12172
+ * @param {string} [xUserId] User ID for personalization
12173
+ * @param {string} [xAnonId] Anonymous user ID for personalization
11352
12174
  * @param {string} [xSessionId] Session ID for personalization
11353
- * @param {string} [query] Partial query to get suggestions for (supports both \&#39;query\&#39; and \&#39;q\&#39;)
11354
- * @param {string} [q] Alias for \&#39;query\&#39; parameter
11355
- * @param {number} [hitsPerPage] Number of suggestions to return
11356
- * @param {number} [page] Page number for pagination
11357
- * @param {string} [analyticsTags] Comma-separated analytics tags to filter suggestions
11358
- * @param {V1SuggestionsQueriesGetTagsMatchModeEnum} [tagsMatchMode] How to match analytics tags
11359
- * @param {boolean} [includeCategories] Include category information in suggestions
11360
- * @param {boolean} [includeFacets] Include popular facets/filters information
11361
- * @param {boolean} [includeDropdownRecommendations] Include rich dropdown recommendations (trending products, filtered tabs)
11362
- * @param {boolean} [includeDropdownProductList] Include product list in dropdown recommendations
11363
- * @param {boolean} [includeFilteredTabs] Include filtered tabs in dropdown recommendations
11364
- * @param {boolean} [includeEmptyQueryRecommendations] Return popular suggestions when query is empty
11365
- * @param {number} [maxCategories] Maximum categories per suggestion
11366
- * @param {number} [maxFacets] Maximum facets per suggestion
11367
- * @param {number} [minPopularity] Minimum popularity threshold
11368
- * @param {V1SuggestionsQueriesGetTimeRangeEnum} [timeRange] Time range for analytics data
11369
- * @param {boolean} [disableTypoTolerance] Disable fuzzy/typo-tolerant matching
11370
- * @param {string} [filteredTabs] URL-encoded JSON array of filtered tab configurations (e.g., [{\\
11371
- * @param {string} [userId] User ID for personalization (query param fallback, header takes precedence)
11372
- * @param {string} [anonId] Anonymous ID for personalization (query param fallback, header takes precedence)
11373
- * @param {string} [sessionId] Session ID for personalization (query param fallback, header takes precedence)
12175
+ * @param {string} [query] Partial query (use \&#39;query\&#39; or \&#39;q\&#39;)
12176
+ * @param {string} [q] Alias for query
12177
+ * @param {number} [hitsPerPage] Suggestions to return
12178
+ * @param {number} [page] Page for pagination
12179
+ * @param {string} [analyticsTags] Comma-separated tags to filter
12180
+ * @param {V1SuggestionsQueriesGetTagsMatchModeEnum} [tagsMatchMode] Match mode for tags
12181
+ * @param {boolean} [includeCategories] Include category in suggestions
12182
+ * @param {boolean} [includeFacets] Include facet info
12183
+ * @param {boolean} [includeDropdownRecommendations] Include dropdown recommendations
12184
+ * @param {boolean} [includeDropdownProductList] Include product list in dropdown
12185
+ * @param {boolean} [includeFilteredTabs] Include filtered tabs
12186
+ * @param {boolean} [includeEmptyQueryRecommendations] Popular suggestions when query empty
12187
+ * @param {number} [maxCategories] Max categories per suggestion
12188
+ * @param {number} [maxFacets] Max facets per suggestion
12189
+ * @param {number} [minPopularity] Min popularity
12190
+ * @param {V1SuggestionsQueriesGetTimeRangeEnum} [timeRange] Data time range
12191
+ * @param {boolean} [disableTypoTolerance] Disable fuzzy matching
12192
+ * @param {string} [filteredTabs] URL-encoded JSON array of tab configs
12193
+ * @param {string} [userId] User ID (fallback if header not set)
12194
+ * @param {string} [anonId] Anonymous ID (fallback)
12195
+ * @param {string} [sessionId] Session ID (fallback)
11374
12196
  * @param {*} [options] Override http request option.
11375
12197
  * @throws {RequiredError}
11376
12198
  */
11377
12199
  v1SuggestionsQueriesGet: (xStoreid: string, xStoresecret: string, xUserId?: string, xAnonId?: string, xSessionId?: string, query?: string, q?: string, hitsPerPage?: number, page?: number, analyticsTags?: string, tagsMatchMode?: V1SuggestionsQueriesGetTagsMatchModeEnum, includeCategories?: boolean, includeFacets?: boolean, includeDropdownRecommendations?: boolean, includeDropdownProductList?: boolean, includeFilteredTabs?: boolean, includeEmptyQueryRecommendations?: boolean, maxCategories?: number, maxFacets?: number, minPopularity?: number, timeRange?: V1SuggestionsQueriesGetTimeRangeEnum, disableTypoTolerance?: boolean, filteredTabs?: string, userId?: string, anonId?: string, sessionId?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
11378
12200
  /**
11379
- * Same as GET endpoint with full feature parity. Retrieve query suggestions with optional JSON body (query, hitsPerPage, analytics_tags, filtered_tabs, dropdown recommendations, etc.). Use POST when sending complex filtered_tabs as JSON is more convenient than URL-encoded query params. Supports personalization via x-user-id, x-anon-id, x-session-id headers. Both GET and POST return identical responses.
11380
- * @summary Post Query Suggestions
11381
- * @param {string} xStoreid Store ID
11382
- * @param {string} xStoresecret Store Secret
11383
- * @param {string} [xUserId] User ID for personalization (logged-in user)
11384
- * @param {string} [xAnonId] Anonymous ID for personalization (cookie/device ID)
12201
+ * Same as GET; use POST to send a JSON body (e.g. complex filtered_tabs). **Auth:** `x-storeid` and `x-storesecret`. Optional personalization headers: `x-user-id`, `x-anon-id`, `x-session-id`. Request body can include query, hitsPerPage, analytics_tags, include_categories, include_facets, filtered_tabs, etc.
12202
+ * @summary Get query suggestions (POST)
12203
+ * @param {string} xStoreid Store ID (from dashboard)
12204
+ * @param {string} xStoresecret Store read secret
12205
+ * @param {string} [xUserId] User ID for personalization
12206
+ * @param {string} [xAnonId] Anonymous user ID for personalization
11385
12207
  * @param {string} [xSessionId] Session ID for personalization
11386
- * @param {QuerySuggestionsServiceQuerySuggestionsRequest} [querySuggestionsServiceQuerySuggestionsRequest] Query suggestions request (query, hitsPerPage, page, analytics_tags, include_categories, include_facets, include_dropdown_recommendations, filtered_tabs, etc.)
12208
+ * @param {QuerySuggestionsServiceQuerySuggestionsRequest} [querySuggestionsServiceQuerySuggestionsRequest] Request (query, hitsPerPage, analytics_tags, filtered_tabs, etc.)
11387
12209
  * @param {*} [options] Override http request option.
11388
12210
  * @throws {RequiredError}
11389
12211
  */
@@ -11394,56 +12216,56 @@ export declare const QuerySuggestionsApiAxiosParamCreator: (configuration?: Conf
11394
12216
  */
11395
12217
  export declare const QuerySuggestionsApiFp: (configuration?: Configuration) => {
11396
12218
  /**
11397
- * Retrieve configuration settings for query suggestions API including limits, supported time ranges, and default values
11398
- * @summary Get Query Suggestions Configuration
11399
- * @param {string} xStoreid Store ID
11400
- * @param {string} xStoresecret Store Secret
12219
+ * Returns limits, supported time ranges, and default values for the query suggestions API. **Auth:** `x-storeid` and `x-storesecret`.
12220
+ * @summary Get suggestions configuration
12221
+ * @param {string} xStoreid Store ID (from dashboard)
12222
+ * @param {string} xStoresecret Store read secret
11401
12223
  * @param {*} [options] Override http request option.
11402
12224
  * @throws {RequiredError}
11403
12225
  */
11404
12226
  v1SuggestionsConfigGet(xStoreid: string, xStoresecret: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<V1SuggestionsConfigGet200Response>>;
11405
12227
  /**
11406
- * Retrieve query suggestions based on search analytics data with popularity ranking and optional category/facet enrichment. Supports partial query matching, analytics tags filtering, configurable time ranges, and dropdown recommendations with filtered tabs. Supports personalization via x-user-id, x-anon-id, x-session-id headers. Full feature parity with POST endpoint.
11407
- * @summary Get Query Suggestions
11408
- * @param {string} xStoreid Store ID
11409
- * @param {string} xStoresecret Store Secret
11410
- * @param {string} [xUserId] User ID for personalization (logged-in user)
11411
- * @param {string} [xAnonId] Anonymous ID for personalization (cookie/device ID)
12228
+ * Autocomplete suggestions for search, ranked by popularity. **Auth:** `x-storeid` and `x-storesecret` (from dashboard). Optional: `x-user-id`, `x-anon-id`, `x-session-id` for personalization. Supports partial query, filters (analytics_tags), time range (7d/30d/90d), categories, facets, and dropdown recommendations. Use `query` or `q` for the partial search string.
12229
+ * @summary Get query suggestions (GET)
12230
+ * @param {string} xStoreid Store ID (from dashboard)
12231
+ * @param {string} xStoresecret Store read secret
12232
+ * @param {string} [xUserId] User ID for personalization
12233
+ * @param {string} [xAnonId] Anonymous user ID for personalization
11412
12234
  * @param {string} [xSessionId] Session ID for personalization
11413
- * @param {string} [query] Partial query to get suggestions for (supports both \&#39;query\&#39; and \&#39;q\&#39;)
11414
- * @param {string} [q] Alias for \&#39;query\&#39; parameter
11415
- * @param {number} [hitsPerPage] Number of suggestions to return
11416
- * @param {number} [page] Page number for pagination
11417
- * @param {string} [analyticsTags] Comma-separated analytics tags to filter suggestions
11418
- * @param {V1SuggestionsQueriesGetTagsMatchModeEnum} [tagsMatchMode] How to match analytics tags
11419
- * @param {boolean} [includeCategories] Include category information in suggestions
11420
- * @param {boolean} [includeFacets] Include popular facets/filters information
11421
- * @param {boolean} [includeDropdownRecommendations] Include rich dropdown recommendations (trending products, filtered tabs)
11422
- * @param {boolean} [includeDropdownProductList] Include product list in dropdown recommendations
11423
- * @param {boolean} [includeFilteredTabs] Include filtered tabs in dropdown recommendations
11424
- * @param {boolean} [includeEmptyQueryRecommendations] Return popular suggestions when query is empty
11425
- * @param {number} [maxCategories] Maximum categories per suggestion
11426
- * @param {number} [maxFacets] Maximum facets per suggestion
11427
- * @param {number} [minPopularity] Minimum popularity threshold
11428
- * @param {V1SuggestionsQueriesGetTimeRangeEnum} [timeRange] Time range for analytics data
11429
- * @param {boolean} [disableTypoTolerance] Disable fuzzy/typo-tolerant matching
11430
- * @param {string} [filteredTabs] URL-encoded JSON array of filtered tab configurations (e.g., [{\\
11431
- * @param {string} [userId] User ID for personalization (query param fallback, header takes precedence)
11432
- * @param {string} [anonId] Anonymous ID for personalization (query param fallback, header takes precedence)
11433
- * @param {string} [sessionId] Session ID for personalization (query param fallback, header takes precedence)
12235
+ * @param {string} [query] Partial query (use \&#39;query\&#39; or \&#39;q\&#39;)
12236
+ * @param {string} [q] Alias for query
12237
+ * @param {number} [hitsPerPage] Suggestions to return
12238
+ * @param {number} [page] Page for pagination
12239
+ * @param {string} [analyticsTags] Comma-separated tags to filter
12240
+ * @param {V1SuggestionsQueriesGetTagsMatchModeEnum} [tagsMatchMode] Match mode for tags
12241
+ * @param {boolean} [includeCategories] Include category in suggestions
12242
+ * @param {boolean} [includeFacets] Include facet info
12243
+ * @param {boolean} [includeDropdownRecommendations] Include dropdown recommendations
12244
+ * @param {boolean} [includeDropdownProductList] Include product list in dropdown
12245
+ * @param {boolean} [includeFilteredTabs] Include filtered tabs
12246
+ * @param {boolean} [includeEmptyQueryRecommendations] Popular suggestions when query empty
12247
+ * @param {number} [maxCategories] Max categories per suggestion
12248
+ * @param {number} [maxFacets] Max facets per suggestion
12249
+ * @param {number} [minPopularity] Min popularity
12250
+ * @param {V1SuggestionsQueriesGetTimeRangeEnum} [timeRange] Data time range
12251
+ * @param {boolean} [disableTypoTolerance] Disable fuzzy matching
12252
+ * @param {string} [filteredTabs] URL-encoded JSON array of tab configs
12253
+ * @param {string} [userId] User ID (fallback if header not set)
12254
+ * @param {string} [anonId] Anonymous ID (fallback)
12255
+ * @param {string} [sessionId] Session ID (fallback)
11434
12256
  * @param {*} [options] Override http request option.
11435
12257
  * @throws {RequiredError}
11436
12258
  */
11437
12259
  v1SuggestionsQueriesGet(xStoreid: string, xStoresecret: string, xUserId?: string, xAnonId?: string, xSessionId?: string, query?: string, q?: string, hitsPerPage?: number, page?: number, analyticsTags?: string, tagsMatchMode?: V1SuggestionsQueriesGetTagsMatchModeEnum, includeCategories?: boolean, includeFacets?: boolean, includeDropdownRecommendations?: boolean, includeDropdownProductList?: boolean, includeFilteredTabs?: boolean, includeEmptyQueryRecommendations?: boolean, maxCategories?: number, maxFacets?: number, minPopularity?: number, timeRange?: V1SuggestionsQueriesGetTimeRangeEnum, disableTypoTolerance?: boolean, filteredTabs?: string, userId?: string, anonId?: string, sessionId?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<QuerySuggestionsServiceQuerySuggestionsAPIResponse>>;
11438
12260
  /**
11439
- * Same as GET endpoint with full feature parity. Retrieve query suggestions with optional JSON body (query, hitsPerPage, analytics_tags, filtered_tabs, dropdown recommendations, etc.). Use POST when sending complex filtered_tabs as JSON is more convenient than URL-encoded query params. Supports personalization via x-user-id, x-anon-id, x-session-id headers. Both GET and POST return identical responses.
11440
- * @summary Post Query Suggestions
11441
- * @param {string} xStoreid Store ID
11442
- * @param {string} xStoresecret Store Secret
11443
- * @param {string} [xUserId] User ID for personalization (logged-in user)
11444
- * @param {string} [xAnonId] Anonymous ID for personalization (cookie/device ID)
12261
+ * Same as GET; use POST to send a JSON body (e.g. complex filtered_tabs). **Auth:** `x-storeid` and `x-storesecret`. Optional personalization headers: `x-user-id`, `x-anon-id`, `x-session-id`. Request body can include query, hitsPerPage, analytics_tags, include_categories, include_facets, filtered_tabs, etc.
12262
+ * @summary Get query suggestions (POST)
12263
+ * @param {string} xStoreid Store ID (from dashboard)
12264
+ * @param {string} xStoresecret Store read secret
12265
+ * @param {string} [xUserId] User ID for personalization
12266
+ * @param {string} [xAnonId] Anonymous user ID for personalization
11445
12267
  * @param {string} [xSessionId] Session ID for personalization
11446
- * @param {QuerySuggestionsServiceQuerySuggestionsRequest} [querySuggestionsServiceQuerySuggestionsRequest] Query suggestions request (query, hitsPerPage, page, analytics_tags, include_categories, include_facets, include_dropdown_recommendations, filtered_tabs, etc.)
12268
+ * @param {QuerySuggestionsServiceQuerySuggestionsRequest} [querySuggestionsServiceQuerySuggestionsRequest] Request (query, hitsPerPage, analytics_tags, filtered_tabs, etc.)
11447
12269
  * @param {*} [options] Override http request option.
11448
12270
  * @throws {RequiredError}
11449
12271
  */
@@ -11454,56 +12276,56 @@ export declare const QuerySuggestionsApiFp: (configuration?: Configuration) => {
11454
12276
  */
11455
12277
  export declare const QuerySuggestionsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
11456
12278
  /**
11457
- * Retrieve configuration settings for query suggestions API including limits, supported time ranges, and default values
11458
- * @summary Get Query Suggestions Configuration
11459
- * @param {string} xStoreid Store ID
11460
- * @param {string} xStoresecret Store Secret
12279
+ * Returns limits, supported time ranges, and default values for the query suggestions API. **Auth:** `x-storeid` and `x-storesecret`.
12280
+ * @summary Get suggestions configuration
12281
+ * @param {string} xStoreid Store ID (from dashboard)
12282
+ * @param {string} xStoresecret Store read secret
11461
12283
  * @param {*} [options] Override http request option.
11462
12284
  * @throws {RequiredError}
11463
12285
  */
11464
12286
  v1SuggestionsConfigGet(xStoreid: string, xStoresecret: string, options?: RawAxiosRequestConfig): AxiosPromise<V1SuggestionsConfigGet200Response>;
11465
12287
  /**
11466
- * Retrieve query suggestions based on search analytics data with popularity ranking and optional category/facet enrichment. Supports partial query matching, analytics tags filtering, configurable time ranges, and dropdown recommendations with filtered tabs. Supports personalization via x-user-id, x-anon-id, x-session-id headers. Full feature parity with POST endpoint.
11467
- * @summary Get Query Suggestions
11468
- * @param {string} xStoreid Store ID
11469
- * @param {string} xStoresecret Store Secret
11470
- * @param {string} [xUserId] User ID for personalization (logged-in user)
11471
- * @param {string} [xAnonId] Anonymous ID for personalization (cookie/device ID)
12288
+ * Autocomplete suggestions for search, ranked by popularity. **Auth:** `x-storeid` and `x-storesecret` (from dashboard). Optional: `x-user-id`, `x-anon-id`, `x-session-id` for personalization. Supports partial query, filters (analytics_tags), time range (7d/30d/90d), categories, facets, and dropdown recommendations. Use `query` or `q` for the partial search string.
12289
+ * @summary Get query suggestions (GET)
12290
+ * @param {string} xStoreid Store ID (from dashboard)
12291
+ * @param {string} xStoresecret Store read secret
12292
+ * @param {string} [xUserId] User ID for personalization
12293
+ * @param {string} [xAnonId] Anonymous user ID for personalization
11472
12294
  * @param {string} [xSessionId] Session ID for personalization
11473
- * @param {string} [query] Partial query to get suggestions for (supports both \&#39;query\&#39; and \&#39;q\&#39;)
11474
- * @param {string} [q] Alias for \&#39;query\&#39; parameter
11475
- * @param {number} [hitsPerPage] Number of suggestions to return
11476
- * @param {number} [page] Page number for pagination
11477
- * @param {string} [analyticsTags] Comma-separated analytics tags to filter suggestions
11478
- * @param {V1SuggestionsQueriesGetTagsMatchModeEnum} [tagsMatchMode] How to match analytics tags
11479
- * @param {boolean} [includeCategories] Include category information in suggestions
11480
- * @param {boolean} [includeFacets] Include popular facets/filters information
11481
- * @param {boolean} [includeDropdownRecommendations] Include rich dropdown recommendations (trending products, filtered tabs)
11482
- * @param {boolean} [includeDropdownProductList] Include product list in dropdown recommendations
11483
- * @param {boolean} [includeFilteredTabs] Include filtered tabs in dropdown recommendations
11484
- * @param {boolean} [includeEmptyQueryRecommendations] Return popular suggestions when query is empty
11485
- * @param {number} [maxCategories] Maximum categories per suggestion
11486
- * @param {number} [maxFacets] Maximum facets per suggestion
11487
- * @param {number} [minPopularity] Minimum popularity threshold
11488
- * @param {V1SuggestionsQueriesGetTimeRangeEnum} [timeRange] Time range for analytics data
11489
- * @param {boolean} [disableTypoTolerance] Disable fuzzy/typo-tolerant matching
11490
- * @param {string} [filteredTabs] URL-encoded JSON array of filtered tab configurations (e.g., [{\\
11491
- * @param {string} [userId] User ID for personalization (query param fallback, header takes precedence)
11492
- * @param {string} [anonId] Anonymous ID for personalization (query param fallback, header takes precedence)
11493
- * @param {string} [sessionId] Session ID for personalization (query param fallback, header takes precedence)
12295
+ * @param {string} [query] Partial query (use \&#39;query\&#39; or \&#39;q\&#39;)
12296
+ * @param {string} [q] Alias for query
12297
+ * @param {number} [hitsPerPage] Suggestions to return
12298
+ * @param {number} [page] Page for pagination
12299
+ * @param {string} [analyticsTags] Comma-separated tags to filter
12300
+ * @param {V1SuggestionsQueriesGetTagsMatchModeEnum} [tagsMatchMode] Match mode for tags
12301
+ * @param {boolean} [includeCategories] Include category in suggestions
12302
+ * @param {boolean} [includeFacets] Include facet info
12303
+ * @param {boolean} [includeDropdownRecommendations] Include dropdown recommendations
12304
+ * @param {boolean} [includeDropdownProductList] Include product list in dropdown
12305
+ * @param {boolean} [includeFilteredTabs] Include filtered tabs
12306
+ * @param {boolean} [includeEmptyQueryRecommendations] Popular suggestions when query empty
12307
+ * @param {number} [maxCategories] Max categories per suggestion
12308
+ * @param {number} [maxFacets] Max facets per suggestion
12309
+ * @param {number} [minPopularity] Min popularity
12310
+ * @param {V1SuggestionsQueriesGetTimeRangeEnum} [timeRange] Data time range
12311
+ * @param {boolean} [disableTypoTolerance] Disable fuzzy matching
12312
+ * @param {string} [filteredTabs] URL-encoded JSON array of tab configs
12313
+ * @param {string} [userId] User ID (fallback if header not set)
12314
+ * @param {string} [anonId] Anonymous ID (fallback)
12315
+ * @param {string} [sessionId] Session ID (fallback)
11494
12316
  * @param {*} [options] Override http request option.
11495
12317
  * @throws {RequiredError}
11496
12318
  */
11497
12319
  v1SuggestionsQueriesGet(xStoreid: string, xStoresecret: string, xUserId?: string, xAnonId?: string, xSessionId?: string, query?: string, q?: string, hitsPerPage?: number, page?: number, analyticsTags?: string, tagsMatchMode?: V1SuggestionsQueriesGetTagsMatchModeEnum, includeCategories?: boolean, includeFacets?: boolean, includeDropdownRecommendations?: boolean, includeDropdownProductList?: boolean, includeFilteredTabs?: boolean, includeEmptyQueryRecommendations?: boolean, maxCategories?: number, maxFacets?: number, minPopularity?: number, timeRange?: V1SuggestionsQueriesGetTimeRangeEnum, disableTypoTolerance?: boolean, filteredTabs?: string, userId?: string, anonId?: string, sessionId?: string, options?: RawAxiosRequestConfig): AxiosPromise<QuerySuggestionsServiceQuerySuggestionsAPIResponse>;
11498
12320
  /**
11499
- * Same as GET endpoint with full feature parity. Retrieve query suggestions with optional JSON body (query, hitsPerPage, analytics_tags, filtered_tabs, dropdown recommendations, etc.). Use POST when sending complex filtered_tabs as JSON is more convenient than URL-encoded query params. Supports personalization via x-user-id, x-anon-id, x-session-id headers. Both GET and POST return identical responses.
11500
- * @summary Post Query Suggestions
11501
- * @param {string} xStoreid Store ID
11502
- * @param {string} xStoresecret Store Secret
11503
- * @param {string} [xUserId] User ID for personalization (logged-in user)
11504
- * @param {string} [xAnonId] Anonymous ID for personalization (cookie/device ID)
12321
+ * Same as GET; use POST to send a JSON body (e.g. complex filtered_tabs). **Auth:** `x-storeid` and `x-storesecret`. Optional personalization headers: `x-user-id`, `x-anon-id`, `x-session-id`. Request body can include query, hitsPerPage, analytics_tags, include_categories, include_facets, filtered_tabs, etc.
12322
+ * @summary Get query suggestions (POST)
12323
+ * @param {string} xStoreid Store ID (from dashboard)
12324
+ * @param {string} xStoresecret Store read secret
12325
+ * @param {string} [xUserId] User ID for personalization
12326
+ * @param {string} [xAnonId] Anonymous user ID for personalization
11505
12327
  * @param {string} [xSessionId] Session ID for personalization
11506
- * @param {QuerySuggestionsServiceQuerySuggestionsRequest} [querySuggestionsServiceQuerySuggestionsRequest] Query suggestions request (query, hitsPerPage, page, analytics_tags, include_categories, include_facets, include_dropdown_recommendations, filtered_tabs, etc.)
12328
+ * @param {QuerySuggestionsServiceQuerySuggestionsRequest} [querySuggestionsServiceQuerySuggestionsRequest] Request (query, hitsPerPage, analytics_tags, filtered_tabs, etc.)
11507
12329
  * @param {*} [options] Override http request option.
11508
12330
  * @throws {RequiredError}
11509
12331
  */
@@ -11514,56 +12336,56 @@ export declare const QuerySuggestionsApiFactory: (configuration?: Configuration,
11514
12336
  */
11515
12337
  export declare class QuerySuggestionsApi extends BaseAPI {
11516
12338
  /**
11517
- * Retrieve configuration settings for query suggestions API including limits, supported time ranges, and default values
11518
- * @summary Get Query Suggestions Configuration
11519
- * @param {string} xStoreid Store ID
11520
- * @param {string} xStoresecret Store Secret
12339
+ * Returns limits, supported time ranges, and default values for the query suggestions API. **Auth:** `x-storeid` and `x-storesecret`.
12340
+ * @summary Get suggestions configuration
12341
+ * @param {string} xStoreid Store ID (from dashboard)
12342
+ * @param {string} xStoresecret Store read secret
11521
12343
  * @param {*} [options] Override http request option.
11522
12344
  * @throws {RequiredError}
11523
12345
  */
11524
12346
  v1SuggestionsConfigGet(xStoreid: string, xStoresecret: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<V1SuggestionsConfigGet200Response, any, {}>>;
11525
12347
  /**
11526
- * Retrieve query suggestions based on search analytics data with popularity ranking and optional category/facet enrichment. Supports partial query matching, analytics tags filtering, configurable time ranges, and dropdown recommendations with filtered tabs. Supports personalization via x-user-id, x-anon-id, x-session-id headers. Full feature parity with POST endpoint.
11527
- * @summary Get Query Suggestions
11528
- * @param {string} xStoreid Store ID
11529
- * @param {string} xStoresecret Store Secret
11530
- * @param {string} [xUserId] User ID for personalization (logged-in user)
11531
- * @param {string} [xAnonId] Anonymous ID for personalization (cookie/device ID)
12348
+ * Autocomplete suggestions for search, ranked by popularity. **Auth:** `x-storeid` and `x-storesecret` (from dashboard). Optional: `x-user-id`, `x-anon-id`, `x-session-id` for personalization. Supports partial query, filters (analytics_tags), time range (7d/30d/90d), categories, facets, and dropdown recommendations. Use `query` or `q` for the partial search string.
12349
+ * @summary Get query suggestions (GET)
12350
+ * @param {string} xStoreid Store ID (from dashboard)
12351
+ * @param {string} xStoresecret Store read secret
12352
+ * @param {string} [xUserId] User ID for personalization
12353
+ * @param {string} [xAnonId] Anonymous user ID for personalization
11532
12354
  * @param {string} [xSessionId] Session ID for personalization
11533
- * @param {string} [query] Partial query to get suggestions for (supports both \&#39;query\&#39; and \&#39;q\&#39;)
11534
- * @param {string} [q] Alias for \&#39;query\&#39; parameter
11535
- * @param {number} [hitsPerPage] Number of suggestions to return
11536
- * @param {number} [page] Page number for pagination
11537
- * @param {string} [analyticsTags] Comma-separated analytics tags to filter suggestions
11538
- * @param {V1SuggestionsQueriesGetTagsMatchModeEnum} [tagsMatchMode] How to match analytics tags
11539
- * @param {boolean} [includeCategories] Include category information in suggestions
11540
- * @param {boolean} [includeFacets] Include popular facets/filters information
11541
- * @param {boolean} [includeDropdownRecommendations] Include rich dropdown recommendations (trending products, filtered tabs)
11542
- * @param {boolean} [includeDropdownProductList] Include product list in dropdown recommendations
11543
- * @param {boolean} [includeFilteredTabs] Include filtered tabs in dropdown recommendations
11544
- * @param {boolean} [includeEmptyQueryRecommendations] Return popular suggestions when query is empty
11545
- * @param {number} [maxCategories] Maximum categories per suggestion
11546
- * @param {number} [maxFacets] Maximum facets per suggestion
11547
- * @param {number} [minPopularity] Minimum popularity threshold
11548
- * @param {V1SuggestionsQueriesGetTimeRangeEnum} [timeRange] Time range for analytics data
11549
- * @param {boolean} [disableTypoTolerance] Disable fuzzy/typo-tolerant matching
11550
- * @param {string} [filteredTabs] URL-encoded JSON array of filtered tab configurations (e.g., [{\\
11551
- * @param {string} [userId] User ID for personalization (query param fallback, header takes precedence)
11552
- * @param {string} [anonId] Anonymous ID for personalization (query param fallback, header takes precedence)
11553
- * @param {string} [sessionId] Session ID for personalization (query param fallback, header takes precedence)
12355
+ * @param {string} [query] Partial query (use \&#39;query\&#39; or \&#39;q\&#39;)
12356
+ * @param {string} [q] Alias for query
12357
+ * @param {number} [hitsPerPage] Suggestions to return
12358
+ * @param {number} [page] Page for pagination
12359
+ * @param {string} [analyticsTags] Comma-separated tags to filter
12360
+ * @param {V1SuggestionsQueriesGetTagsMatchModeEnum} [tagsMatchMode] Match mode for tags
12361
+ * @param {boolean} [includeCategories] Include category in suggestions
12362
+ * @param {boolean} [includeFacets] Include facet info
12363
+ * @param {boolean} [includeDropdownRecommendations] Include dropdown recommendations
12364
+ * @param {boolean} [includeDropdownProductList] Include product list in dropdown
12365
+ * @param {boolean} [includeFilteredTabs] Include filtered tabs
12366
+ * @param {boolean} [includeEmptyQueryRecommendations] Popular suggestions when query empty
12367
+ * @param {number} [maxCategories] Max categories per suggestion
12368
+ * @param {number} [maxFacets] Max facets per suggestion
12369
+ * @param {number} [minPopularity] Min popularity
12370
+ * @param {V1SuggestionsQueriesGetTimeRangeEnum} [timeRange] Data time range
12371
+ * @param {boolean} [disableTypoTolerance] Disable fuzzy matching
12372
+ * @param {string} [filteredTabs] URL-encoded JSON array of tab configs
12373
+ * @param {string} [userId] User ID (fallback if header not set)
12374
+ * @param {string} [anonId] Anonymous ID (fallback)
12375
+ * @param {string} [sessionId] Session ID (fallback)
11554
12376
  * @param {*} [options] Override http request option.
11555
12377
  * @throws {RequiredError}
11556
12378
  */
11557
12379
  v1SuggestionsQueriesGet(xStoreid: string, xStoresecret: string, xUserId?: string, xAnonId?: string, xSessionId?: string, query?: string, q?: string, hitsPerPage?: number, page?: number, analyticsTags?: string, tagsMatchMode?: V1SuggestionsQueriesGetTagsMatchModeEnum, includeCategories?: boolean, includeFacets?: boolean, includeDropdownRecommendations?: boolean, includeDropdownProductList?: boolean, includeFilteredTabs?: boolean, includeEmptyQueryRecommendations?: boolean, maxCategories?: number, maxFacets?: number, minPopularity?: number, timeRange?: V1SuggestionsQueriesGetTimeRangeEnum, disableTypoTolerance?: boolean, filteredTabs?: string, userId?: string, anonId?: string, sessionId?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<QuerySuggestionsServiceQuerySuggestionsAPIResponse, any, {}>>;
11558
12380
  /**
11559
- * Same as GET endpoint with full feature parity. Retrieve query suggestions with optional JSON body (query, hitsPerPage, analytics_tags, filtered_tabs, dropdown recommendations, etc.). Use POST when sending complex filtered_tabs as JSON is more convenient than URL-encoded query params. Supports personalization via x-user-id, x-anon-id, x-session-id headers. Both GET and POST return identical responses.
11560
- * @summary Post Query Suggestions
11561
- * @param {string} xStoreid Store ID
11562
- * @param {string} xStoresecret Store Secret
11563
- * @param {string} [xUserId] User ID for personalization (logged-in user)
11564
- * @param {string} [xAnonId] Anonymous ID for personalization (cookie/device ID)
12381
+ * Same as GET; use POST to send a JSON body (e.g. complex filtered_tabs). **Auth:** `x-storeid` and `x-storesecret`. Optional personalization headers: `x-user-id`, `x-anon-id`, `x-session-id`. Request body can include query, hitsPerPage, analytics_tags, include_categories, include_facets, filtered_tabs, etc.
12382
+ * @summary Get query suggestions (POST)
12383
+ * @param {string} xStoreid Store ID (from dashboard)
12384
+ * @param {string} xStoresecret Store read secret
12385
+ * @param {string} [xUserId] User ID for personalization
12386
+ * @param {string} [xAnonId] Anonymous user ID for personalization
11565
12387
  * @param {string} [xSessionId] Session ID for personalization
11566
- * @param {QuerySuggestionsServiceQuerySuggestionsRequest} [querySuggestionsServiceQuerySuggestionsRequest] Query suggestions request (query, hitsPerPage, page, analytics_tags, include_categories, include_facets, include_dropdown_recommendations, filtered_tabs, etc.)
12388
+ * @param {QuerySuggestionsServiceQuerySuggestionsRequest} [querySuggestionsServiceQuerySuggestionsRequest] Request (query, hitsPerPage, analytics_tags, filtered_tabs, etc.)
11567
12389
  * @param {*} [options] Override http request option.
11568
12390
  * @throws {RequiredError}
11569
12391
  */
@@ -11585,34 +12407,45 @@ export type V1SuggestionsQueriesGetTimeRangeEnum = typeof V1SuggestionsQueriesGe
11585
12407
  */
11586
12408
  export declare const SDKDocumentsApiAxiosParamCreator: (configuration?: Configuration) => {
11587
12409
  /**
11588
- * Performs bulk insert, update, upsert, or delete operations on documents using the public SDK API. Requires x-store-write-secret for authentication. Each document may specify its own action (insert, update, upsert, delete).
11589
- * @summary Bulk index documents (Public SDK API)
11590
- * @param {string} xStoreid Store ID
11591
- * @param {string} xStoreWriteSecret Store Write Secret (required for write operations)
11592
- * @param {string} xStoreID X-Store ID (must match x-storeid header)
11593
- * @param {DataTypesBulkDocumentRequest} dataTypesBulkDocumentRequest Bulk operation data
12410
+ * Run multiple document operations in one request (insert, update, upsert, delete). **Auth:** `x-storeid` and `x-store-write-secret`. Path `xStoreID` must match the `x-storeid` header. Each item can specify its own action.
12411
+ * @summary Bulk index documents
12412
+ * @param {string} xStoreid Store ID (from dashboard)
12413
+ * @param {string} xStoreWriteSecret Store write secret
12414
+ * @param {string} xStoreID Store ID (must match x-storeid header)
12415
+ * @param {DataTypesBulkDocumentRequest} dataTypesBulkDocumentRequest List of operations
11594
12416
  * @param {*} [options] Override http request option.
11595
12417
  * @throws {RequiredError}
11596
12418
  */
11597
12419
  apiV1StoresXStoreIDDocumentsBulkPost: (xStoreid: string, xStoreWriteSecret: string, xStoreID: string, dataTypesBulkDocumentRequest: DataTypesBulkDocumentRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
11598
12420
  /**
11599
- * Deletes a document by ID from a store using the public SDK API. Requires x-store-write-secret for authentication.
11600
- * @summary Delete a document (Public SDK API)
11601
- * @param {string} xStoreid Store ID
11602
- * @param {string} xStoreWriteSecret Store Write Secret (required for write operations)
11603
- * @param {string} xStoreID X-Store ID (must match x-storeid header)
12421
+ * Remove a document from the store\'s search index by ID. **Auth:** `x-storeid` and `x-store-write-secret`. Path `xStoreID` must match the `x-storeid` header.
12422
+ * @summary Delete a document
12423
+ * @param {string} xStoreid Store ID (from dashboard)
12424
+ * @param {string} xStoreWriteSecret Store write secret
12425
+ * @param {string} xStoreID Store ID (must match x-storeid header)
11604
12426
  * @param {string} documentID Document ID to delete
11605
12427
  * @param {*} [options] Override http request option.
11606
12428
  * @throws {RequiredError}
11607
12429
  */
11608
12430
  apiV1StoresXStoreIDDocumentsDocumentIDDelete: (xStoreid: string, xStoreWriteSecret: string, xStoreID: string, documentID: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
11609
12431
  /**
11610
- * Indexes a new document into a store using the public SDK API. Requires x-store-write-secret for authentication. If ID is provided, it will be used; otherwise, a hash-based ID will be generated. If a document with the same hash already exists, it will be updated.
11611
- * @summary Index a single document (Public SDK API)
11612
- * @param {string} xStoreid Store ID
11613
- * @param {string} xStoreWriteSecret Store Write Secret (required for write operations)
11614
- * @param {string} xStoreID X-Store ID (must match x-storeid header)
11615
- * @param {DataTypesDocumentRequest} dataTypesDocumentRequest Document data
12432
+ * Retrieve a single document from the store\'s search index by ID. **Auth:** `x-storeid` and `x-storesecret` (read secret). Path `xStoreID` must match the `x-storeid` header. Used by product pages and PDP.
12433
+ * @summary Get a document by ID
12434
+ * @param {string} xStoreid Store ID (from dashboard)
12435
+ * @param {string} xStoresecret Store read secret
12436
+ * @param {string} xStoreID Store ID (must match x-storeid header)
12437
+ * @param {string} documentID Document ID to retrieve
12438
+ * @param {*} [options] Override http request option.
12439
+ * @throws {RequiredError}
12440
+ */
12441
+ apiV1StoresXStoreIDDocumentsDocumentIDGet: (xStoreid: string, xStoresecret: string, xStoreID: string, documentID: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
12442
+ /**
12443
+ * Add or update one document in the store\'s search index. **Auth:** `x-storeid` and `x-store-write-secret`. Path `xStoreID` must match the `x-storeid` header. If you omit document ID, one is generated; existing documents with the same ID are updated.
12444
+ * @summary Index a single document
12445
+ * @param {string} xStoreid Store ID (from dashboard)
12446
+ * @param {string} xStoreWriteSecret Store write secret
12447
+ * @param {string} xStoreID Store ID (must match x-storeid header)
12448
+ * @param {DataTypesDocumentRequest} dataTypesDocumentRequest Document fields to index
11616
12449
  * @param {*} [options] Override http request option.
11617
12450
  * @throws {RequiredError}
11618
12451
  */
@@ -11623,34 +12456,45 @@ export declare const SDKDocumentsApiAxiosParamCreator: (configuration?: Configur
11623
12456
  */
11624
12457
  export declare const SDKDocumentsApiFp: (configuration?: Configuration) => {
11625
12458
  /**
11626
- * Performs bulk insert, update, upsert, or delete operations on documents using the public SDK API. Requires x-store-write-secret for authentication. Each document may specify its own action (insert, update, upsert, delete).
11627
- * @summary Bulk index documents (Public SDK API)
11628
- * @param {string} xStoreid Store ID
11629
- * @param {string} xStoreWriteSecret Store Write Secret (required for write operations)
11630
- * @param {string} xStoreID X-Store ID (must match x-storeid header)
11631
- * @param {DataTypesBulkDocumentRequest} dataTypesBulkDocumentRequest Bulk operation data
12459
+ * Run multiple document operations in one request (insert, update, upsert, delete). **Auth:** `x-storeid` and `x-store-write-secret`. Path `xStoreID` must match the `x-storeid` header. Each item can specify its own action.
12460
+ * @summary Bulk index documents
12461
+ * @param {string} xStoreid Store ID (from dashboard)
12462
+ * @param {string} xStoreWriteSecret Store write secret
12463
+ * @param {string} xStoreID Store ID (must match x-storeid header)
12464
+ * @param {DataTypesBulkDocumentRequest} dataTypesBulkDocumentRequest List of operations
11632
12465
  * @param {*} [options] Override http request option.
11633
12466
  * @throws {RequiredError}
11634
12467
  */
11635
12468
  apiV1StoresXStoreIDDocumentsBulkPost(xStoreid: string, xStoreWriteSecret: string, xStoreID: string, dataTypesBulkDocumentRequest: DataTypesBulkDocumentRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesBulkDocumentResponseWrapper>>;
11636
12469
  /**
11637
- * Deletes a document by ID from a store using the public SDK API. Requires x-store-write-secret for authentication.
11638
- * @summary Delete a document (Public SDK API)
11639
- * @param {string} xStoreid Store ID
11640
- * @param {string} xStoreWriteSecret Store Write Secret (required for write operations)
11641
- * @param {string} xStoreID X-Store ID (must match x-storeid header)
12470
+ * Remove a document from the store\'s search index by ID. **Auth:** `x-storeid` and `x-store-write-secret`. Path `xStoreID` must match the `x-storeid` header.
12471
+ * @summary Delete a document
12472
+ * @param {string} xStoreid Store ID (from dashboard)
12473
+ * @param {string} xStoreWriteSecret Store write secret
12474
+ * @param {string} xStoreID Store ID (must match x-storeid header)
11642
12475
  * @param {string} documentID Document ID to delete
11643
12476
  * @param {*} [options] Override http request option.
11644
12477
  * @throws {RequiredError}
11645
12478
  */
11646
12479
  apiV1StoresXStoreIDDocumentsDocumentIDDelete(xStoreid: string, xStoreWriteSecret: string, xStoreID: string, documentID: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesDocumentResponseWrapper>>;
11647
12480
  /**
11648
- * Indexes a new document into a store using the public SDK API. Requires x-store-write-secret for authentication. If ID is provided, it will be used; otherwise, a hash-based ID will be generated. If a document with the same hash already exists, it will be updated.
11649
- * @summary Index a single document (Public SDK API)
11650
- * @param {string} xStoreid Store ID
11651
- * @param {string} xStoreWriteSecret Store Write Secret (required for write operations)
11652
- * @param {string} xStoreID X-Store ID (must match x-storeid header)
11653
- * @param {DataTypesDocumentRequest} dataTypesDocumentRequest Document data
12481
+ * Retrieve a single document from the store\'s search index by ID. **Auth:** `x-storeid` and `x-storesecret` (read secret). Path `xStoreID` must match the `x-storeid` header. Used by product pages and PDP.
12482
+ * @summary Get a document by ID
12483
+ * @param {string} xStoreid Store ID (from dashboard)
12484
+ * @param {string} xStoresecret Store read secret
12485
+ * @param {string} xStoreID Store ID (must match x-storeid header)
12486
+ * @param {string} documentID Document ID to retrieve
12487
+ * @param {*} [options] Override http request option.
12488
+ * @throws {RequiredError}
12489
+ */
12490
+ apiV1StoresXStoreIDDocumentsDocumentIDGet(xStoreid: string, xStoresecret: string, xStoreID: string, documentID: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesDocumentResponseWrapper>>;
12491
+ /**
12492
+ * Add or update one document in the store\'s search index. **Auth:** `x-storeid` and `x-store-write-secret`. Path `xStoreID` must match the `x-storeid` header. If you omit document ID, one is generated; existing documents with the same ID are updated.
12493
+ * @summary Index a single document
12494
+ * @param {string} xStoreid Store ID (from dashboard)
12495
+ * @param {string} xStoreWriteSecret Store write secret
12496
+ * @param {string} xStoreID Store ID (must match x-storeid header)
12497
+ * @param {DataTypesDocumentRequest} dataTypesDocumentRequest Document fields to index
11654
12498
  * @param {*} [options] Override http request option.
11655
12499
  * @throws {RequiredError}
11656
12500
  */
@@ -11661,34 +12505,45 @@ export declare const SDKDocumentsApiFp: (configuration?: Configuration) => {
11661
12505
  */
11662
12506
  export declare const SDKDocumentsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
11663
12507
  /**
11664
- * Performs bulk insert, update, upsert, or delete operations on documents using the public SDK API. Requires x-store-write-secret for authentication. Each document may specify its own action (insert, update, upsert, delete).
11665
- * @summary Bulk index documents (Public SDK API)
11666
- * @param {string} xStoreid Store ID
11667
- * @param {string} xStoreWriteSecret Store Write Secret (required for write operations)
11668
- * @param {string} xStoreID X-Store ID (must match x-storeid header)
11669
- * @param {DataTypesBulkDocumentRequest} dataTypesBulkDocumentRequest Bulk operation data
12508
+ * Run multiple document operations in one request (insert, update, upsert, delete). **Auth:** `x-storeid` and `x-store-write-secret`. Path `xStoreID` must match the `x-storeid` header. Each item can specify its own action.
12509
+ * @summary Bulk index documents
12510
+ * @param {string} xStoreid Store ID (from dashboard)
12511
+ * @param {string} xStoreWriteSecret Store write secret
12512
+ * @param {string} xStoreID Store ID (must match x-storeid header)
12513
+ * @param {DataTypesBulkDocumentRequest} dataTypesBulkDocumentRequest List of operations
11670
12514
  * @param {*} [options] Override http request option.
11671
12515
  * @throws {RequiredError}
11672
12516
  */
11673
12517
  apiV1StoresXStoreIDDocumentsBulkPost(xStoreid: string, xStoreWriteSecret: string, xStoreID: string, dataTypesBulkDocumentRequest: DataTypesBulkDocumentRequest, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesBulkDocumentResponseWrapper>;
11674
12518
  /**
11675
- * Deletes a document by ID from a store using the public SDK API. Requires x-store-write-secret for authentication.
11676
- * @summary Delete a document (Public SDK API)
11677
- * @param {string} xStoreid Store ID
11678
- * @param {string} xStoreWriteSecret Store Write Secret (required for write operations)
11679
- * @param {string} xStoreID X-Store ID (must match x-storeid header)
12519
+ * Remove a document from the store\'s search index by ID. **Auth:** `x-storeid` and `x-store-write-secret`. Path `xStoreID` must match the `x-storeid` header.
12520
+ * @summary Delete a document
12521
+ * @param {string} xStoreid Store ID (from dashboard)
12522
+ * @param {string} xStoreWriteSecret Store write secret
12523
+ * @param {string} xStoreID Store ID (must match x-storeid header)
11680
12524
  * @param {string} documentID Document ID to delete
11681
12525
  * @param {*} [options] Override http request option.
11682
12526
  * @throws {RequiredError}
11683
12527
  */
11684
12528
  apiV1StoresXStoreIDDocumentsDocumentIDDelete(xStoreid: string, xStoreWriteSecret: string, xStoreID: string, documentID: string, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesDocumentResponseWrapper>;
11685
12529
  /**
11686
- * Indexes a new document into a store using the public SDK API. Requires x-store-write-secret for authentication. If ID is provided, it will be used; otherwise, a hash-based ID will be generated. If a document with the same hash already exists, it will be updated.
11687
- * @summary Index a single document (Public SDK API)
11688
- * @param {string} xStoreid Store ID
11689
- * @param {string} xStoreWriteSecret Store Write Secret (required for write operations)
11690
- * @param {string} xStoreID X-Store ID (must match x-storeid header)
11691
- * @param {DataTypesDocumentRequest} dataTypesDocumentRequest Document data
12530
+ * Retrieve a single document from the store\'s search index by ID. **Auth:** `x-storeid` and `x-storesecret` (read secret). Path `xStoreID` must match the `x-storeid` header. Used by product pages and PDP.
12531
+ * @summary Get a document by ID
12532
+ * @param {string} xStoreid Store ID (from dashboard)
12533
+ * @param {string} xStoresecret Store read secret
12534
+ * @param {string} xStoreID Store ID (must match x-storeid header)
12535
+ * @param {string} documentID Document ID to retrieve
12536
+ * @param {*} [options] Override http request option.
12537
+ * @throws {RequiredError}
12538
+ */
12539
+ apiV1StoresXStoreIDDocumentsDocumentIDGet(xStoreid: string, xStoresecret: string, xStoreID: string, documentID: string, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesDocumentResponseWrapper>;
12540
+ /**
12541
+ * Add or update one document in the store\'s search index. **Auth:** `x-storeid` and `x-store-write-secret`. Path `xStoreID` must match the `x-storeid` header. If you omit document ID, one is generated; existing documents with the same ID are updated.
12542
+ * @summary Index a single document
12543
+ * @param {string} xStoreid Store ID (from dashboard)
12544
+ * @param {string} xStoreWriteSecret Store write secret
12545
+ * @param {string} xStoreID Store ID (must match x-storeid header)
12546
+ * @param {DataTypesDocumentRequest} dataTypesDocumentRequest Document fields to index
11692
12547
  * @param {*} [options] Override http request option.
11693
12548
  * @throws {RequiredError}
11694
12549
  */
@@ -11699,60 +12554,135 @@ export declare const SDKDocumentsApiFactory: (configuration?: Configuration, bas
11699
12554
  */
11700
12555
  export declare class SDKDocumentsApi extends BaseAPI {
11701
12556
  /**
11702
- * Performs bulk insert, update, upsert, or delete operations on documents using the public SDK API. Requires x-store-write-secret for authentication. Each document may specify its own action (insert, update, upsert, delete).
11703
- * @summary Bulk index documents (Public SDK API)
11704
- * @param {string} xStoreid Store ID
11705
- * @param {string} xStoreWriteSecret Store Write Secret (required for write operations)
11706
- * @param {string} xStoreID X-Store ID (must match x-storeid header)
11707
- * @param {DataTypesBulkDocumentRequest} dataTypesBulkDocumentRequest Bulk operation data
12557
+ * Run multiple document operations in one request (insert, update, upsert, delete). **Auth:** `x-storeid` and `x-store-write-secret`. Path `xStoreID` must match the `x-storeid` header. Each item can specify its own action.
12558
+ * @summary Bulk index documents
12559
+ * @param {string} xStoreid Store ID (from dashboard)
12560
+ * @param {string} xStoreWriteSecret Store write secret
12561
+ * @param {string} xStoreID Store ID (must match x-storeid header)
12562
+ * @param {DataTypesBulkDocumentRequest} dataTypesBulkDocumentRequest List of operations
11708
12563
  * @param {*} [options] Override http request option.
11709
12564
  * @throws {RequiredError}
11710
12565
  */
11711
12566
  apiV1StoresXStoreIDDocumentsBulkPost(xStoreid: string, xStoreWriteSecret: string, xStoreID: string, dataTypesBulkDocumentRequest: DataTypesBulkDocumentRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesBulkDocumentResponseWrapper, any, {}>>;
11712
12567
  /**
11713
- * Deletes a document by ID from a store using the public SDK API. Requires x-store-write-secret for authentication.
11714
- * @summary Delete a document (Public SDK API)
11715
- * @param {string} xStoreid Store ID
11716
- * @param {string} xStoreWriteSecret Store Write Secret (required for write operations)
11717
- * @param {string} xStoreID X-Store ID (must match x-storeid header)
12568
+ * Remove a document from the store\'s search index by ID. **Auth:** `x-storeid` and `x-store-write-secret`. Path `xStoreID` must match the `x-storeid` header.
12569
+ * @summary Delete a document
12570
+ * @param {string} xStoreid Store ID (from dashboard)
12571
+ * @param {string} xStoreWriteSecret Store write secret
12572
+ * @param {string} xStoreID Store ID (must match x-storeid header)
11718
12573
  * @param {string} documentID Document ID to delete
11719
12574
  * @param {*} [options] Override http request option.
11720
12575
  * @throws {RequiredError}
11721
12576
  */
11722
12577
  apiV1StoresXStoreIDDocumentsDocumentIDDelete(xStoreid: string, xStoreWriteSecret: string, xStoreID: string, documentID: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesDocumentResponseWrapper, any, {}>>;
11723
12578
  /**
11724
- * Indexes a new document into a store using the public SDK API. Requires x-store-write-secret for authentication. If ID is provided, it will be used; otherwise, a hash-based ID will be generated. If a document with the same hash already exists, it will be updated.
11725
- * @summary Index a single document (Public SDK API)
11726
- * @param {string} xStoreid Store ID
11727
- * @param {string} xStoreWriteSecret Store Write Secret (required for write operations)
11728
- * @param {string} xStoreID X-Store ID (must match x-storeid header)
11729
- * @param {DataTypesDocumentRequest} dataTypesDocumentRequest Document data
12579
+ * Retrieve a single document from the store\'s search index by ID. **Auth:** `x-storeid` and `x-storesecret` (read secret). Path `xStoreID` must match the `x-storeid` header. Used by product pages and PDP.
12580
+ * @summary Get a document by ID
12581
+ * @param {string} xStoreid Store ID (from dashboard)
12582
+ * @param {string} xStoresecret Store read secret
12583
+ * @param {string} xStoreID Store ID (must match x-storeid header)
12584
+ * @param {string} documentID Document ID to retrieve
12585
+ * @param {*} [options] Override http request option.
12586
+ * @throws {RequiredError}
12587
+ */
12588
+ apiV1StoresXStoreIDDocumentsDocumentIDGet(xStoreid: string, xStoresecret: string, xStoreID: string, documentID: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesDocumentResponseWrapper, any, {}>>;
12589
+ /**
12590
+ * Add or update one document in the store\'s search index. **Auth:** `x-storeid` and `x-store-write-secret`. Path `xStoreID` must match the `x-storeid` header. If you omit document ID, one is generated; existing documents with the same ID are updated.
12591
+ * @summary Index a single document
12592
+ * @param {string} xStoreid Store ID (from dashboard)
12593
+ * @param {string} xStoreWriteSecret Store write secret
12594
+ * @param {string} xStoreID Store ID (must match x-storeid header)
12595
+ * @param {DataTypesDocumentRequest} dataTypesDocumentRequest Document fields to index
11730
12596
  * @param {*} [options] Override http request option.
11731
12597
  * @throws {RequiredError}
11732
12598
  */
11733
12599
  apiV1StoresXStoreIDDocumentsPost(xStoreid: string, xStoreWriteSecret: string, xStoreID: string, dataTypesDocumentRequest: DataTypesDocumentRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesDocumentResponseWrapper, any, {}>>;
11734
12600
  }
12601
+ /**
12602
+ * SDKExperimentsApi - axios parameter creator
12603
+ */
12604
+ export declare const SDKExperimentsApiAxiosParamCreator: (configuration?: Configuration) => {
12605
+ /**
12606
+ * Returns variant assignments for all running experiments for the requesting user. Uses hash-based consistent assignment.
12607
+ * @summary Get experiment assignments for a user
12608
+ * @param {string} xStoreid Store ID
12609
+ * @param {string} xStoresecret Store read secret
12610
+ * @param {string} [xUserId] User ID (provide either x-user-id or x-anon-id)
12611
+ * @param {string} [xAnonId] Anonymous ID (provide either x-user-id or x-anon-id)
12612
+ * @param {*} [options] Override http request option.
12613
+ * @throws {RequiredError}
12614
+ */
12615
+ v1ExperimentsAssignmentGet: (xStoreid: string, xStoresecret: string, xUserId?: string, xAnonId?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
12616
+ };
12617
+ /**
12618
+ * SDKExperimentsApi - functional programming interface
12619
+ */
12620
+ export declare const SDKExperimentsApiFp: (configuration?: Configuration) => {
12621
+ /**
12622
+ * Returns variant assignments for all running experiments for the requesting user. Uses hash-based consistent assignment.
12623
+ * @summary Get experiment assignments for a user
12624
+ * @param {string} xStoreid Store ID
12625
+ * @param {string} xStoresecret Store read secret
12626
+ * @param {string} [xUserId] User ID (provide either x-user-id or x-anon-id)
12627
+ * @param {string} [xAnonId] Anonymous ID (provide either x-user-id or x-anon-id)
12628
+ * @param {*} [options] Override http request option.
12629
+ * @throws {RequiredError}
12630
+ */
12631
+ v1ExperimentsAssignmentGet(xStoreid: string, xStoresecret: string, xUserId?: string, xAnonId?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesExperimentAssignmentResponse>>;
12632
+ };
12633
+ /**
12634
+ * SDKExperimentsApi - factory interface
12635
+ */
12636
+ export declare const SDKExperimentsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
12637
+ /**
12638
+ * Returns variant assignments for all running experiments for the requesting user. Uses hash-based consistent assignment.
12639
+ * @summary Get experiment assignments for a user
12640
+ * @param {string} xStoreid Store ID
12641
+ * @param {string} xStoresecret Store read secret
12642
+ * @param {string} [xUserId] User ID (provide either x-user-id or x-anon-id)
12643
+ * @param {string} [xAnonId] Anonymous ID (provide either x-user-id or x-anon-id)
12644
+ * @param {*} [options] Override http request option.
12645
+ * @throws {RequiredError}
12646
+ */
12647
+ v1ExperimentsAssignmentGet(xStoreid: string, xStoresecret: string, xUserId?: string, xAnonId?: string, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesExperimentAssignmentResponse>;
12648
+ };
12649
+ /**
12650
+ * SDKExperimentsApi - object-oriented interface
12651
+ */
12652
+ export declare class SDKExperimentsApi extends BaseAPI {
12653
+ /**
12654
+ * Returns variant assignments for all running experiments for the requesting user. Uses hash-based consistent assignment.
12655
+ * @summary Get experiment assignments for a user
12656
+ * @param {string} xStoreid Store ID
12657
+ * @param {string} xStoresecret Store read secret
12658
+ * @param {string} [xUserId] User ID (provide either x-user-id or x-anon-id)
12659
+ * @param {string} [xAnonId] Anonymous ID (provide either x-user-id or x-anon-id)
12660
+ * @param {*} [options] Override http request option.
12661
+ * @throws {RequiredError}
12662
+ */
12663
+ v1ExperimentsAssignmentGet(xStoreid: string, xStoresecret: string, xUserId?: string, xAnonId?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesExperimentAssignmentResponse, any, {}>>;
12664
+ }
11735
12665
  /**
11736
12666
  * SDKQuerySuggestionsConfigApi - axios parameter creator
11737
12667
  */
11738
12668
  export declare const SDKQuerySuggestionsConfigApiAxiosParamCreator: (configuration?: Configuration) => {
11739
12669
  /**
11740
- * Retrieves the store-specific query suggestions configuration using x-store ID and read secret. This is a public API for SDK integration, similar to Algolia\'s GET /1/configs/{configID} endpoint. Uses read secret (x-storesecret).
11741
- * @summary Get Query Suggestions Config (Public SDK API)
11742
- * @param {string} xStoreid Store ID
11743
- * @param {string} xStoresecret Store Read Secret (for read operations)
11744
- * @param {string} xStoreID X-Store ID (must match x-storeid header)
12670
+ * Returns autocomplete/suggestions configuration for the store. **Auth:** `x-storeid` and `x-storesecret`. Path `xStoreID` must match the `x-storeid` header.
12671
+ * @summary Get query suggestions configuration
12672
+ * @param {string} xStoreid Store ID (from dashboard)
12673
+ * @param {string} xStoresecret Store read secret
12674
+ * @param {string} xStoreID Store ID (must match x-storeid header)
11745
12675
  * @param {*} [options] Override http request option.
11746
12676
  * @throws {RequiredError}
11747
12677
  */
11748
12678
  apiV1StoresXStoreIDQuerySuggestionsConfigGet: (xStoreid: string, xStoresecret: string, xStoreID: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
11749
12679
  /**
11750
- * Updates the store-specific query suggestions configuration using x-store ID and write secret. Supports partial updates. This is a public API for SDK integration, similar to Algolia\'s PUT /1/configs/{configID} endpoint. Requires write secret (x-store-write-secret).
11751
- * @summary Update Query Suggestions Config (Public SDK API)
11752
- * @param {string} xStoreid Store ID
11753
- * @param {string} xStoreWriteSecret Store Write Secret (required for write operations)
11754
- * @param {string} xStoreID X-Store ID (must match x-storeid header)
11755
- * @param {QuerySuggestionsServiceUpdateSuggestionConfigRequest} querySuggestionsServiceUpdateSuggestionConfigRequest Query suggestions configuration (partial updates supported)
12680
+ * Update autocomplete/suggestions settings for the store. Partial updates supported. **Auth:** `x-storeid` and `x-store-write-secret`. Path `xStoreID` must match the `x-storeid` header.
12681
+ * @summary Update query suggestions configuration
12682
+ * @param {string} xStoreid Store ID (from dashboard)
12683
+ * @param {string} xStoreWriteSecret Store write secret
12684
+ * @param {string} xStoreID Store ID (must match x-storeid header)
12685
+ * @param {QuerySuggestionsServiceUpdateSuggestionConfigRequest} querySuggestionsServiceUpdateSuggestionConfigRequest Fields to update (partial)
11756
12686
  * @param {*} [options] Override http request option.
11757
12687
  * @throws {RequiredError}
11758
12688
  */
@@ -11763,22 +12693,22 @@ export declare const SDKQuerySuggestionsConfigApiAxiosParamCreator: (configurati
11763
12693
  */
11764
12694
  export declare const SDKQuerySuggestionsConfigApiFp: (configuration?: Configuration) => {
11765
12695
  /**
11766
- * Retrieves the store-specific query suggestions configuration using x-store ID and read secret. This is a public API for SDK integration, similar to Algolia\'s GET /1/configs/{configID} endpoint. Uses read secret (x-storesecret).
11767
- * @summary Get Query Suggestions Config (Public SDK API)
11768
- * @param {string} xStoreid Store ID
11769
- * @param {string} xStoresecret Store Read Secret (for read operations)
11770
- * @param {string} xStoreID X-Store ID (must match x-storeid header)
12696
+ * Returns autocomplete/suggestions configuration for the store. **Auth:** `x-storeid` and `x-storesecret`. Path `xStoreID` must match the `x-storeid` header.
12697
+ * @summary Get query suggestions configuration
12698
+ * @param {string} xStoreid Store ID (from dashboard)
12699
+ * @param {string} xStoresecret Store read secret
12700
+ * @param {string} xStoreID Store ID (must match x-storeid header)
11771
12701
  * @param {*} [options] Override http request option.
11772
12702
  * @throws {RequiredError}
11773
12703
  */
11774
12704
  apiV1StoresXStoreIDQuerySuggestionsConfigGet(xStoreid: string, xStoresecret: string, xStoreID: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<QuerySuggestionsServiceQuerySuggestionsAPIResponse>>;
11775
12705
  /**
11776
- * Updates the store-specific query suggestions configuration using x-store ID and write secret. Supports partial updates. This is a public API for SDK integration, similar to Algolia\'s PUT /1/configs/{configID} endpoint. Requires write secret (x-store-write-secret).
11777
- * @summary Update Query Suggestions Config (Public SDK API)
11778
- * @param {string} xStoreid Store ID
11779
- * @param {string} xStoreWriteSecret Store Write Secret (required for write operations)
11780
- * @param {string} xStoreID X-Store ID (must match x-storeid header)
11781
- * @param {QuerySuggestionsServiceUpdateSuggestionConfigRequest} querySuggestionsServiceUpdateSuggestionConfigRequest Query suggestions configuration (partial updates supported)
12706
+ * Update autocomplete/suggestions settings for the store. Partial updates supported. **Auth:** `x-storeid` and `x-store-write-secret`. Path `xStoreID` must match the `x-storeid` header.
12707
+ * @summary Update query suggestions configuration
12708
+ * @param {string} xStoreid Store ID (from dashboard)
12709
+ * @param {string} xStoreWriteSecret Store write secret
12710
+ * @param {string} xStoreID Store ID (must match x-storeid header)
12711
+ * @param {QuerySuggestionsServiceUpdateSuggestionConfigRequest} querySuggestionsServiceUpdateSuggestionConfigRequest Fields to update (partial)
11782
12712
  * @param {*} [options] Override http request option.
11783
12713
  * @throws {RequiredError}
11784
12714
  */
@@ -11789,22 +12719,22 @@ export declare const SDKQuerySuggestionsConfigApiFp: (configuration?: Configurat
11789
12719
  */
11790
12720
  export declare const SDKQuerySuggestionsConfigApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
11791
12721
  /**
11792
- * Retrieves the store-specific query suggestions configuration using x-store ID and read secret. This is a public API for SDK integration, similar to Algolia\'s GET /1/configs/{configID} endpoint. Uses read secret (x-storesecret).
11793
- * @summary Get Query Suggestions Config (Public SDK API)
11794
- * @param {string} xStoreid Store ID
11795
- * @param {string} xStoresecret Store Read Secret (for read operations)
11796
- * @param {string} xStoreID X-Store ID (must match x-storeid header)
12722
+ * Returns autocomplete/suggestions configuration for the store. **Auth:** `x-storeid` and `x-storesecret`. Path `xStoreID` must match the `x-storeid` header.
12723
+ * @summary Get query suggestions configuration
12724
+ * @param {string} xStoreid Store ID (from dashboard)
12725
+ * @param {string} xStoresecret Store read secret
12726
+ * @param {string} xStoreID Store ID (must match x-storeid header)
11797
12727
  * @param {*} [options] Override http request option.
11798
12728
  * @throws {RequiredError}
11799
12729
  */
11800
12730
  apiV1StoresXStoreIDQuerySuggestionsConfigGet(xStoreid: string, xStoresecret: string, xStoreID: string, options?: RawAxiosRequestConfig): AxiosPromise<QuerySuggestionsServiceQuerySuggestionsAPIResponse>;
11801
12731
  /**
11802
- * Updates the store-specific query suggestions configuration using x-store ID and write secret. Supports partial updates. This is a public API for SDK integration, similar to Algolia\'s PUT /1/configs/{configID} endpoint. Requires write secret (x-store-write-secret).
11803
- * @summary Update Query Suggestions Config (Public SDK API)
11804
- * @param {string} xStoreid Store ID
11805
- * @param {string} xStoreWriteSecret Store Write Secret (required for write operations)
11806
- * @param {string} xStoreID X-Store ID (must match x-storeid header)
11807
- * @param {QuerySuggestionsServiceUpdateSuggestionConfigRequest} querySuggestionsServiceUpdateSuggestionConfigRequest Query suggestions configuration (partial updates supported)
12732
+ * Update autocomplete/suggestions settings for the store. Partial updates supported. **Auth:** `x-storeid` and `x-store-write-secret`. Path `xStoreID` must match the `x-storeid` header.
12733
+ * @summary Update query suggestions configuration
12734
+ * @param {string} xStoreid Store ID (from dashboard)
12735
+ * @param {string} xStoreWriteSecret Store write secret
12736
+ * @param {string} xStoreID Store ID (must match x-storeid header)
12737
+ * @param {QuerySuggestionsServiceUpdateSuggestionConfigRequest} querySuggestionsServiceUpdateSuggestionConfigRequest Fields to update (partial)
11808
12738
  * @param {*} [options] Override http request option.
11809
12739
  * @throws {RequiredError}
11810
12740
  */
@@ -11815,22 +12745,22 @@ export declare const SDKQuerySuggestionsConfigApiFactory: (configuration?: Confi
11815
12745
  */
11816
12746
  export declare class SDKQuerySuggestionsConfigApi extends BaseAPI {
11817
12747
  /**
11818
- * Retrieves the store-specific query suggestions configuration using x-store ID and read secret. This is a public API for SDK integration, similar to Algolia\'s GET /1/configs/{configID} endpoint. Uses read secret (x-storesecret).
11819
- * @summary Get Query Suggestions Config (Public SDK API)
11820
- * @param {string} xStoreid Store ID
11821
- * @param {string} xStoresecret Store Read Secret (for read operations)
11822
- * @param {string} xStoreID X-Store ID (must match x-storeid header)
12748
+ * Returns autocomplete/suggestions configuration for the store. **Auth:** `x-storeid` and `x-storesecret`. Path `xStoreID` must match the `x-storeid` header.
12749
+ * @summary Get query suggestions configuration
12750
+ * @param {string} xStoreid Store ID (from dashboard)
12751
+ * @param {string} xStoresecret Store read secret
12752
+ * @param {string} xStoreID Store ID (must match x-storeid header)
11823
12753
  * @param {*} [options] Override http request option.
11824
12754
  * @throws {RequiredError}
11825
12755
  */
11826
12756
  apiV1StoresXStoreIDQuerySuggestionsConfigGet(xStoreid: string, xStoresecret: string, xStoreID: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<QuerySuggestionsServiceQuerySuggestionsAPIResponse, any, {}>>;
11827
12757
  /**
11828
- * Updates the store-specific query suggestions configuration using x-store ID and write secret. Supports partial updates. This is a public API for SDK integration, similar to Algolia\'s PUT /1/configs/{configID} endpoint. Requires write secret (x-store-write-secret).
11829
- * @summary Update Query Suggestions Config (Public SDK API)
11830
- * @param {string} xStoreid Store ID
11831
- * @param {string} xStoreWriteSecret Store Write Secret (required for write operations)
11832
- * @param {string} xStoreID X-Store ID (must match x-storeid header)
11833
- * @param {QuerySuggestionsServiceUpdateSuggestionConfigRequest} querySuggestionsServiceUpdateSuggestionConfigRequest Query suggestions configuration (partial updates supported)
12758
+ * Update autocomplete/suggestions settings for the store. Partial updates supported. **Auth:** `x-storeid` and `x-store-write-secret`. Path `xStoreID` must match the `x-storeid` header.
12759
+ * @summary Update query suggestions configuration
12760
+ * @param {string} xStoreid Store ID (from dashboard)
12761
+ * @param {string} xStoreWriteSecret Store write secret
12762
+ * @param {string} xStoreID Store ID (must match x-storeid header)
12763
+ * @param {QuerySuggestionsServiceUpdateSuggestionConfigRequest} querySuggestionsServiceUpdateSuggestionConfigRequest Fields to update (partial)
11834
12764
  * @param {*} [options] Override http request option.
11835
12765
  * @throws {RequiredError}
11836
12766
  */
@@ -11841,32 +12771,32 @@ export declare class SDKQuerySuggestionsConfigApi extends BaseAPI {
11841
12771
  */
11842
12772
  export declare const SDKSchemaApiAxiosParamCreator: (configuration?: Configuration) => {
11843
12773
  /**
11844
- * Deletes all documents from a store\'s collection without deleting the collection itself. Requires x-store-write-secret for authentication.
11845
- * @summary Clear All Documents (Public SDK API)
11846
- * @param {string} xStoreid Store ID
11847
- * @param {string} xStoreWriteSecret Store Write Secret
11848
- * @param {string} xStoreID X-Store ID (must match x-storeid header)
12774
+ * Removes all documents from the store\'s search index; schema is preserved. **Auth:** `x-storeid` and `x-store-write-secret`. Path `xStoreID` must match the `x-storeid` header.
12775
+ * @summary Clear all documents
12776
+ * @param {string} xStoreid Store ID (from dashboard)
12777
+ * @param {string} xStoreWriteSecret Store write secret
12778
+ * @param {string} xStoreID Store ID (must match x-storeid header)
11849
12779
  * @param {*} [options] Override http request option.
11850
12780
  * @throws {RequiredError}
11851
12781
  */
11852
12782
  apiV1StoresXStoreIDDocumentsDelete: (xStoreid: string, xStoreWriteSecret: string, xStoreID: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
11853
12783
  /**
11854
- * Retrieves the current collection schema for a store. Requires x-storesecret (read secret) for authentication.
11855
- * @summary Get Collection Schema (Public SDK API)
11856
- * @param {string} xStoreid Store ID
11857
- * @param {string} xStoresecret Store Read Secret
11858
- * @param {string} xStoreID X-Store ID (must match x-storeid header)
12784
+ * Returns the current search index schema (fields and options) for the store. **Auth:** `x-storeid` and `x-storesecret`. Path `xStoreID` must match the `x-storeid` header.
12785
+ * @summary Get index schema
12786
+ * @param {string} xStoreid Store ID (from dashboard)
12787
+ * @param {string} xStoresecret Store read secret
12788
+ * @param {string} xStoreID Store ID (must match x-storeid header)
11859
12789
  * @param {*} [options] Override http request option.
11860
12790
  * @throws {RequiredError}
11861
12791
  */
11862
12792
  apiV1StoresXStoreIDSchemaGet: (xStoreid: string, xStoresecret: string, xStoreID: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
11863
12793
  /**
11864
- * Creates a new collection schema or updates an existing one. Mode can be \'additive\' (add new fields, preserve data) or \'replace\' (delete and recreate collection). Requires x-store-write-secret for authentication.
11865
- * @summary Create or Update Collection Schema (Public SDK API)
11866
- * @param {string} xStoreid Store ID
11867
- * @param {string} xStoreWriteSecret Store Write Secret
11868
- * @param {string} xStoreID X-Store ID (must match x-storeid header)
11869
- * @param {DataTypesCollectionSchemaRequest} dataTypesCollectionSchemaRequest Schema request
12794
+ * Define or update the search index schema (field names, types, searchable/facet options). Mode: `additive` (add fields, keep data) or `replace` (recreate index). **Auth:** `x-storeid` and `x-store-write-secret`. Path `xStoreID` must match the `x-storeid` header.
12795
+ * @summary Create or update index schema
12796
+ * @param {string} xStoreid Store ID (from dashboard)
12797
+ * @param {string} xStoreWriteSecret Store write secret
12798
+ * @param {string} xStoreID Store ID (must match x-storeid header)
12799
+ * @param {DataTypesCollectionSchemaRequest} dataTypesCollectionSchemaRequest Schema definition and mode
11870
12800
  * @param {*} [options] Override http request option.
11871
12801
  * @throws {RequiredError}
11872
12802
  */
@@ -11877,32 +12807,32 @@ export declare const SDKSchemaApiAxiosParamCreator: (configuration?: Configurati
11877
12807
  */
11878
12808
  export declare const SDKSchemaApiFp: (configuration?: Configuration) => {
11879
12809
  /**
11880
- * Deletes all documents from a store\'s collection without deleting the collection itself. Requires x-store-write-secret for authentication.
11881
- * @summary Clear All Documents (Public SDK API)
11882
- * @param {string} xStoreid Store ID
11883
- * @param {string} xStoreWriteSecret Store Write Secret
11884
- * @param {string} xStoreID X-Store ID (must match x-storeid header)
12810
+ * Removes all documents from the store\'s search index; schema is preserved. **Auth:** `x-storeid` and `x-store-write-secret`. Path `xStoreID` must match the `x-storeid` header.
12811
+ * @summary Clear all documents
12812
+ * @param {string} xStoreid Store ID (from dashboard)
12813
+ * @param {string} xStoreWriteSecret Store write secret
12814
+ * @param {string} xStoreID Store ID (must match x-storeid header)
11885
12815
  * @param {*} [options] Override http request option.
11886
12816
  * @throws {RequiredError}
11887
12817
  */
11888
12818
  apiV1StoresXStoreIDDocumentsDelete(xStoreid: string, xStoreWriteSecret: string, xStoreID: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesClearDocumentsResponseWrapper>>;
11889
12819
  /**
11890
- * Retrieves the current collection schema for a store. Requires x-storesecret (read secret) for authentication.
11891
- * @summary Get Collection Schema (Public SDK API)
11892
- * @param {string} xStoreid Store ID
11893
- * @param {string} xStoresecret Store Read Secret
11894
- * @param {string} xStoreID X-Store ID (must match x-storeid header)
12820
+ * Returns the current search index schema (fields and options) for the store. **Auth:** `x-storeid` and `x-storesecret`. Path `xStoreID` must match the `x-storeid` header.
12821
+ * @summary Get index schema
12822
+ * @param {string} xStoreid Store ID (from dashboard)
12823
+ * @param {string} xStoresecret Store read secret
12824
+ * @param {string} xStoreID Store ID (must match x-storeid header)
11895
12825
  * @param {*} [options] Override http request option.
11896
12826
  * @throws {RequiredError}
11897
12827
  */
11898
12828
  apiV1StoresXStoreIDSchemaGet(xStoreid: string, xStoresecret: string, xStoreID: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesSchemaResponseWrapper>>;
11899
12829
  /**
11900
- * Creates a new collection schema or updates an existing one. Mode can be \'additive\' (add new fields, preserve data) or \'replace\' (delete and recreate collection). Requires x-store-write-secret for authentication.
11901
- * @summary Create or Update Collection Schema (Public SDK API)
11902
- * @param {string} xStoreid Store ID
11903
- * @param {string} xStoreWriteSecret Store Write Secret
11904
- * @param {string} xStoreID X-Store ID (must match x-storeid header)
11905
- * @param {DataTypesCollectionSchemaRequest} dataTypesCollectionSchemaRequest Schema request
12830
+ * Define or update the search index schema (field names, types, searchable/facet options). Mode: `additive` (add fields, keep data) or `replace` (recreate index). **Auth:** `x-storeid` and `x-store-write-secret`. Path `xStoreID` must match the `x-storeid` header.
12831
+ * @summary Create or update index schema
12832
+ * @param {string} xStoreid Store ID (from dashboard)
12833
+ * @param {string} xStoreWriteSecret Store write secret
12834
+ * @param {string} xStoreID Store ID (must match x-storeid header)
12835
+ * @param {DataTypesCollectionSchemaRequest} dataTypesCollectionSchemaRequest Schema definition and mode
11906
12836
  * @param {*} [options] Override http request option.
11907
12837
  * @throws {RequiredError}
11908
12838
  */
@@ -11913,32 +12843,32 @@ export declare const SDKSchemaApiFp: (configuration?: Configuration) => {
11913
12843
  */
11914
12844
  export declare const SDKSchemaApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
11915
12845
  /**
11916
- * Deletes all documents from a store\'s collection without deleting the collection itself. Requires x-store-write-secret for authentication.
11917
- * @summary Clear All Documents (Public SDK API)
11918
- * @param {string} xStoreid Store ID
11919
- * @param {string} xStoreWriteSecret Store Write Secret
11920
- * @param {string} xStoreID X-Store ID (must match x-storeid header)
12846
+ * Removes all documents from the store\'s search index; schema is preserved. **Auth:** `x-storeid` and `x-store-write-secret`. Path `xStoreID` must match the `x-storeid` header.
12847
+ * @summary Clear all documents
12848
+ * @param {string} xStoreid Store ID (from dashboard)
12849
+ * @param {string} xStoreWriteSecret Store write secret
12850
+ * @param {string} xStoreID Store ID (must match x-storeid header)
11921
12851
  * @param {*} [options] Override http request option.
11922
12852
  * @throws {RequiredError}
11923
12853
  */
11924
12854
  apiV1StoresXStoreIDDocumentsDelete(xStoreid: string, xStoreWriteSecret: string, xStoreID: string, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesClearDocumentsResponseWrapper>;
11925
12855
  /**
11926
- * Retrieves the current collection schema for a store. Requires x-storesecret (read secret) for authentication.
11927
- * @summary Get Collection Schema (Public SDK API)
11928
- * @param {string} xStoreid Store ID
11929
- * @param {string} xStoresecret Store Read Secret
11930
- * @param {string} xStoreID X-Store ID (must match x-storeid header)
12856
+ * Returns the current search index schema (fields and options) for the store. **Auth:** `x-storeid` and `x-storesecret`. Path `xStoreID` must match the `x-storeid` header.
12857
+ * @summary Get index schema
12858
+ * @param {string} xStoreid Store ID (from dashboard)
12859
+ * @param {string} xStoresecret Store read secret
12860
+ * @param {string} xStoreID Store ID (must match x-storeid header)
11931
12861
  * @param {*} [options] Override http request option.
11932
12862
  * @throws {RequiredError}
11933
12863
  */
11934
12864
  apiV1StoresXStoreIDSchemaGet(xStoreid: string, xStoresecret: string, xStoreID: string, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesSchemaResponseWrapper>;
11935
12865
  /**
11936
- * Creates a new collection schema or updates an existing one. Mode can be \'additive\' (add new fields, preserve data) or \'replace\' (delete and recreate collection). Requires x-store-write-secret for authentication.
11937
- * @summary Create or Update Collection Schema (Public SDK API)
11938
- * @param {string} xStoreid Store ID
11939
- * @param {string} xStoreWriteSecret Store Write Secret
11940
- * @param {string} xStoreID X-Store ID (must match x-storeid header)
11941
- * @param {DataTypesCollectionSchemaRequest} dataTypesCollectionSchemaRequest Schema request
12866
+ * Define or update the search index schema (field names, types, searchable/facet options). Mode: `additive` (add fields, keep data) or `replace` (recreate index). **Auth:** `x-storeid` and `x-store-write-secret`. Path `xStoreID` must match the `x-storeid` header.
12867
+ * @summary Create or update index schema
12868
+ * @param {string} xStoreid Store ID (from dashboard)
12869
+ * @param {string} xStoreWriteSecret Store write secret
12870
+ * @param {string} xStoreID Store ID (must match x-storeid header)
12871
+ * @param {DataTypesCollectionSchemaRequest} dataTypesCollectionSchemaRequest Schema definition and mode
11942
12872
  * @param {*} [options] Override http request option.
11943
12873
  * @throws {RequiredError}
11944
12874
  */
@@ -11949,32 +12879,32 @@ export declare const SDKSchemaApiFactory: (configuration?: Configuration, basePa
11949
12879
  */
11950
12880
  export declare class SDKSchemaApi extends BaseAPI {
11951
12881
  /**
11952
- * Deletes all documents from a store\'s collection without deleting the collection itself. Requires x-store-write-secret for authentication.
11953
- * @summary Clear All Documents (Public SDK API)
11954
- * @param {string} xStoreid Store ID
11955
- * @param {string} xStoreWriteSecret Store Write Secret
11956
- * @param {string} xStoreID X-Store ID (must match x-storeid header)
12882
+ * Removes all documents from the store\'s search index; schema is preserved. **Auth:** `x-storeid` and `x-store-write-secret`. Path `xStoreID` must match the `x-storeid` header.
12883
+ * @summary Clear all documents
12884
+ * @param {string} xStoreid Store ID (from dashboard)
12885
+ * @param {string} xStoreWriteSecret Store write secret
12886
+ * @param {string} xStoreID Store ID (must match x-storeid header)
11957
12887
  * @param {*} [options] Override http request option.
11958
12888
  * @throws {RequiredError}
11959
12889
  */
11960
12890
  apiV1StoresXStoreIDDocumentsDelete(xStoreid: string, xStoreWriteSecret: string, xStoreID: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesClearDocumentsResponseWrapper, any, {}>>;
11961
12891
  /**
11962
- * Retrieves the current collection schema for a store. Requires x-storesecret (read secret) for authentication.
11963
- * @summary Get Collection Schema (Public SDK API)
11964
- * @param {string} xStoreid Store ID
11965
- * @param {string} xStoresecret Store Read Secret
11966
- * @param {string} xStoreID X-Store ID (must match x-storeid header)
12892
+ * Returns the current search index schema (fields and options) for the store. **Auth:** `x-storeid` and `x-storesecret`. Path `xStoreID` must match the `x-storeid` header.
12893
+ * @summary Get index schema
12894
+ * @param {string} xStoreid Store ID (from dashboard)
12895
+ * @param {string} xStoresecret Store read secret
12896
+ * @param {string} xStoreID Store ID (must match x-storeid header)
11967
12897
  * @param {*} [options] Override http request option.
11968
12898
  * @throws {RequiredError}
11969
12899
  */
11970
12900
  apiV1StoresXStoreIDSchemaGet(xStoreid: string, xStoresecret: string, xStoreID: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesSchemaResponseWrapper, any, {}>>;
11971
12901
  /**
11972
- * Creates a new collection schema or updates an existing one. Mode can be \'additive\' (add new fields, preserve data) or \'replace\' (delete and recreate collection). Requires x-store-write-secret for authentication.
11973
- * @summary Create or Update Collection Schema (Public SDK API)
11974
- * @param {string} xStoreid Store ID
11975
- * @param {string} xStoreWriteSecret Store Write Secret
11976
- * @param {string} xStoreID X-Store ID (must match x-storeid header)
11977
- * @param {DataTypesCollectionSchemaRequest} dataTypesCollectionSchemaRequest Schema request
12902
+ * Define or update the search index schema (field names, types, searchable/facet options). Mode: `additive` (add fields, keep data) or `replace` (recreate index). **Auth:** `x-storeid` and `x-store-write-secret`. Path `xStoreID` must match the `x-storeid` header.
12903
+ * @summary Create or update index schema
12904
+ * @param {string} xStoreid Store ID (from dashboard)
12905
+ * @param {string} xStoreWriteSecret Store write secret
12906
+ * @param {string} xStoreID Store ID (must match x-storeid header)
12907
+ * @param {DataTypesCollectionSchemaRequest} dataTypesCollectionSchemaRequest Schema definition and mode
11978
12908
  * @param {*} [options] Override http request option.
11979
12909
  * @throws {RequiredError}
11980
12910
  */
@@ -11985,32 +12915,32 @@ export declare class SDKSchemaApi extends BaseAPI {
11985
12915
  */
11986
12916
  export declare const SDKStoreConfigApiAxiosParamCreator: (configuration?: Configuration) => {
11987
12917
  /**
11988
- * Retrieves the store configuration (search config and query suggestions config) using x-store ID and read secret. This is a public API for SDK integration. Uses read secret (x-storesecret). Includes both search configuration and query suggestions configuration in a single response.
11989
- * @summary Get Store Config (Public SDK API)
11990
- * @param {string} xStoreid Store ID
11991
- * @param {string} xStoresecret Store Read Secret (for read operations)
11992
- * @param {string} xStoreID X-Store ID (must match x-storeid header)
12918
+ * Returns search and query-suggestions configuration for the store. **Auth:** `x-storeid` and `x-storesecret`. Path `xStoreID` must match the `x-storeid` header.
12919
+ * @summary Get store configuration
12920
+ * @param {string} xStoreid Store ID (from dashboard)
12921
+ * @param {string} xStoresecret Store read secret
12922
+ * @param {string} xStoreID Store ID (must match x-storeid header)
11993
12923
  * @param {*} [options] Override http request option.
11994
12924
  * @throws {RequiredError}
11995
12925
  */
11996
12926
  apiV1StoresXStoreIDConfigGet: (xStoreid: string, xStoresecret: string, xStoreID: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
11997
12927
  /**
11998
- * Updates the store configuration using x-store ID and write secret. Supports partial updates. This is a public API for SDK integration. Requires write secret for security.
11999
- * @summary Update Store Config (Public SDK API)
12000
- * @param {string} xStoreid Store ID
12001
- * @param {string} xStoreWriteSecret Store Write Secret (required for write operations)
12002
- * @param {string} xStoreID X-Store ID (must match x-storeid header)
12003
- * @param {DataTypesIndexConfig} dataTypesIndexConfig Store configuration (partial updates supported)
12928
+ * Update search and store settings. Partial updates supported. **Auth:** `x-storeid` and `x-store-write-secret`. Path `xStoreID` must match the `x-storeid` header.
12929
+ * @summary Update store configuration
12930
+ * @param {string} xStoreid Store ID (from dashboard)
12931
+ * @param {string} xStoreWriteSecret Store write secret
12932
+ * @param {string} xStoreID Store ID (must match x-storeid header)
12933
+ * @param {DataTypesIndexConfig} dataTypesIndexConfig Fields to update (partial)
12004
12934
  * @param {*} [options] Override http request option.
12005
12935
  * @throws {RequiredError}
12006
12936
  */
12007
12937
  apiV1StoresXStoreIDConfigPut: (xStoreid: string, xStoreWriteSecret: string, xStoreID: string, dataTypesIndexConfig: DataTypesIndexConfig, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
12008
12938
  /**
12009
- * Get metadata about all configurable fields for store configuration. This is a public API for SDK integration.
12010
- * @summary Get Store Config Schema (Public SDK API)
12011
- * @param {string} xStoreid Store ID
12012
- * @param {string} xStoresecret Store Secret
12013
- * @param {string} xStoreID X-Store ID (must match x-storeid header)
12939
+ * Returns metadata for all configurable store fields (types, defaults, validation). **Auth:** `x-storeid` and `x-storesecret`. Path `xStoreID` must match the `x-storeid` header.
12940
+ * @summary Get store config schema
12941
+ * @param {string} xStoreid Store ID (from dashboard)
12942
+ * @param {string} xStoresecret Store read secret
12943
+ * @param {string} xStoreID Store ID (must match x-storeid header)
12014
12944
  * @param {*} [options] Override http request option.
12015
12945
  * @throws {RequiredError}
12016
12946
  */
@@ -12021,32 +12951,32 @@ export declare const SDKStoreConfigApiAxiosParamCreator: (configuration?: Config
12021
12951
  */
12022
12952
  export declare const SDKStoreConfigApiFp: (configuration?: Configuration) => {
12023
12953
  /**
12024
- * Retrieves the store configuration (search config and query suggestions config) using x-store ID and read secret. This is a public API for SDK integration. Uses read secret (x-storesecret). Includes both search configuration and query suggestions configuration in a single response.
12025
- * @summary Get Store Config (Public SDK API)
12026
- * @param {string} xStoreid Store ID
12027
- * @param {string} xStoresecret Store Read Secret (for read operations)
12028
- * @param {string} xStoreID X-Store ID (must match x-storeid header)
12954
+ * Returns search and query-suggestions configuration for the store. **Auth:** `x-storeid` and `x-storesecret`. Path `xStoreID` must match the `x-storeid` header.
12955
+ * @summary Get store configuration
12956
+ * @param {string} xStoreid Store ID (from dashboard)
12957
+ * @param {string} xStoresecret Store read secret
12958
+ * @param {string} xStoreID Store ID (must match x-storeid header)
12029
12959
  * @param {*} [options] Override http request option.
12030
12960
  * @throws {RequiredError}
12031
12961
  */
12032
12962
  apiV1StoresXStoreIDConfigGet(xStoreid: string, xStoresecret: string, xStoreID: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesGenericResponseDataTypesStoreConfigWithOnboardingResponse>>;
12033
12963
  /**
12034
- * Updates the store configuration using x-store ID and write secret. Supports partial updates. This is a public API for SDK integration. Requires write secret for security.
12035
- * @summary Update Store Config (Public SDK API)
12036
- * @param {string} xStoreid Store ID
12037
- * @param {string} xStoreWriteSecret Store Write Secret (required for write operations)
12038
- * @param {string} xStoreID X-Store ID (must match x-storeid header)
12039
- * @param {DataTypesIndexConfig} dataTypesIndexConfig Store configuration (partial updates supported)
12964
+ * Update search and store settings. Partial updates supported. **Auth:** `x-storeid` and `x-store-write-secret`. Path `xStoreID` must match the `x-storeid` header.
12965
+ * @summary Update store configuration
12966
+ * @param {string} xStoreid Store ID (from dashboard)
12967
+ * @param {string} xStoreWriteSecret Store write secret
12968
+ * @param {string} xStoreID Store ID (must match x-storeid header)
12969
+ * @param {DataTypesIndexConfig} dataTypesIndexConfig Fields to update (partial)
12040
12970
  * @param {*} [options] Override http request option.
12041
12971
  * @throws {RequiredError}
12042
12972
  */
12043
12973
  apiV1StoresXStoreIDConfigPut(xStoreid: string, xStoreWriteSecret: string, xStoreID: string, dataTypesIndexConfig: DataTypesIndexConfig, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesIndexConfigResponseWrapper>>;
12044
12974
  /**
12045
- * Get metadata about all configurable fields for store configuration. This is a public API for SDK integration.
12046
- * @summary Get Store Config Schema (Public SDK API)
12047
- * @param {string} xStoreid Store ID
12048
- * @param {string} xStoresecret Store Secret
12049
- * @param {string} xStoreID X-Store ID (must match x-storeid header)
12975
+ * Returns metadata for all configurable store fields (types, defaults, validation). **Auth:** `x-storeid` and `x-storesecret`. Path `xStoreID` must match the `x-storeid` header.
12976
+ * @summary Get store config schema
12977
+ * @param {string} xStoreid Store ID (from dashboard)
12978
+ * @param {string} xStoresecret Store read secret
12979
+ * @param {string} xStoreID Store ID (must match x-storeid header)
12050
12980
  * @param {*} [options] Override http request option.
12051
12981
  * @throws {RequiredError}
12052
12982
  */
@@ -12057,32 +12987,32 @@ export declare const SDKStoreConfigApiFp: (configuration?: Configuration) => {
12057
12987
  */
12058
12988
  export declare const SDKStoreConfigApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
12059
12989
  /**
12060
- * Retrieves the store configuration (search config and query suggestions config) using x-store ID and read secret. This is a public API for SDK integration. Uses read secret (x-storesecret). Includes both search configuration and query suggestions configuration in a single response.
12061
- * @summary Get Store Config (Public SDK API)
12062
- * @param {string} xStoreid Store ID
12063
- * @param {string} xStoresecret Store Read Secret (for read operations)
12064
- * @param {string} xStoreID X-Store ID (must match x-storeid header)
12990
+ * Returns search and query-suggestions configuration for the store. **Auth:** `x-storeid` and `x-storesecret`. Path `xStoreID` must match the `x-storeid` header.
12991
+ * @summary Get store configuration
12992
+ * @param {string} xStoreid Store ID (from dashboard)
12993
+ * @param {string} xStoresecret Store read secret
12994
+ * @param {string} xStoreID Store ID (must match x-storeid header)
12065
12995
  * @param {*} [options] Override http request option.
12066
12996
  * @throws {RequiredError}
12067
12997
  */
12068
12998
  apiV1StoresXStoreIDConfigGet(xStoreid: string, xStoresecret: string, xStoreID: string, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesGenericResponseDataTypesStoreConfigWithOnboardingResponse>;
12069
12999
  /**
12070
- * Updates the store configuration using x-store ID and write secret. Supports partial updates. This is a public API for SDK integration. Requires write secret for security.
12071
- * @summary Update Store Config (Public SDK API)
12072
- * @param {string} xStoreid Store ID
12073
- * @param {string} xStoreWriteSecret Store Write Secret (required for write operations)
12074
- * @param {string} xStoreID X-Store ID (must match x-storeid header)
12075
- * @param {DataTypesIndexConfig} dataTypesIndexConfig Store configuration (partial updates supported)
13000
+ * Update search and store settings. Partial updates supported. **Auth:** `x-storeid` and `x-store-write-secret`. Path `xStoreID` must match the `x-storeid` header.
13001
+ * @summary Update store configuration
13002
+ * @param {string} xStoreid Store ID (from dashboard)
13003
+ * @param {string} xStoreWriteSecret Store write secret
13004
+ * @param {string} xStoreID Store ID (must match x-storeid header)
13005
+ * @param {DataTypesIndexConfig} dataTypesIndexConfig Fields to update (partial)
12076
13006
  * @param {*} [options] Override http request option.
12077
13007
  * @throws {RequiredError}
12078
13008
  */
12079
13009
  apiV1StoresXStoreIDConfigPut(xStoreid: string, xStoreWriteSecret: string, xStoreID: string, dataTypesIndexConfig: DataTypesIndexConfig, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesIndexConfigResponseWrapper>;
12080
13010
  /**
12081
- * Get metadata about all configurable fields for store configuration. This is a public API for SDK integration.
12082
- * @summary Get Store Config Schema (Public SDK API)
12083
- * @param {string} xStoreid Store ID
12084
- * @param {string} xStoresecret Store Secret
12085
- * @param {string} xStoreID X-Store ID (must match x-storeid header)
13011
+ * Returns metadata for all configurable store fields (types, defaults, validation). **Auth:** `x-storeid` and `x-storesecret`. Path `xStoreID` must match the `x-storeid` header.
13012
+ * @summary Get store config schema
13013
+ * @param {string} xStoreid Store ID (from dashboard)
13014
+ * @param {string} xStoresecret Store read secret
13015
+ * @param {string} xStoreID Store ID (must match x-storeid header)
12086
13016
  * @param {*} [options] Override http request option.
12087
13017
  * @throws {RequiredError}
12088
13018
  */
@@ -12093,32 +13023,32 @@ export declare const SDKStoreConfigApiFactory: (configuration?: Configuration, b
12093
13023
  */
12094
13024
  export declare class SDKStoreConfigApi extends BaseAPI {
12095
13025
  /**
12096
- * Retrieves the store configuration (search config and query suggestions config) using x-store ID and read secret. This is a public API for SDK integration. Uses read secret (x-storesecret). Includes both search configuration and query suggestions configuration in a single response.
12097
- * @summary Get Store Config (Public SDK API)
12098
- * @param {string} xStoreid Store ID
12099
- * @param {string} xStoresecret Store Read Secret (for read operations)
12100
- * @param {string} xStoreID X-Store ID (must match x-storeid header)
13026
+ * Returns search and query-suggestions configuration for the store. **Auth:** `x-storeid` and `x-storesecret`. Path `xStoreID` must match the `x-storeid` header.
13027
+ * @summary Get store configuration
13028
+ * @param {string} xStoreid Store ID (from dashboard)
13029
+ * @param {string} xStoresecret Store read secret
13030
+ * @param {string} xStoreID Store ID (must match x-storeid header)
12101
13031
  * @param {*} [options] Override http request option.
12102
13032
  * @throws {RequiredError}
12103
13033
  */
12104
13034
  apiV1StoresXStoreIDConfigGet(xStoreid: string, xStoresecret: string, xStoreID: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesGenericResponseDataTypesStoreConfigWithOnboardingResponse, any, {}>>;
12105
13035
  /**
12106
- * Updates the store configuration using x-store ID and write secret. Supports partial updates. This is a public API for SDK integration. Requires write secret for security.
12107
- * @summary Update Store Config (Public SDK API)
12108
- * @param {string} xStoreid Store ID
12109
- * @param {string} xStoreWriteSecret Store Write Secret (required for write operations)
12110
- * @param {string} xStoreID X-Store ID (must match x-storeid header)
12111
- * @param {DataTypesIndexConfig} dataTypesIndexConfig Store configuration (partial updates supported)
13036
+ * Update search and store settings. Partial updates supported. **Auth:** `x-storeid` and `x-store-write-secret`. Path `xStoreID` must match the `x-storeid` header.
13037
+ * @summary Update store configuration
13038
+ * @param {string} xStoreid Store ID (from dashboard)
13039
+ * @param {string} xStoreWriteSecret Store write secret
13040
+ * @param {string} xStoreID Store ID (must match x-storeid header)
13041
+ * @param {DataTypesIndexConfig} dataTypesIndexConfig Fields to update (partial)
12112
13042
  * @param {*} [options] Override http request option.
12113
13043
  * @throws {RequiredError}
12114
13044
  */
12115
13045
  apiV1StoresXStoreIDConfigPut(xStoreid: string, xStoreWriteSecret: string, xStoreID: string, dataTypesIndexConfig: DataTypesIndexConfig, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesIndexConfigResponseWrapper, any, {}>>;
12116
13046
  /**
12117
- * Get metadata about all configurable fields for store configuration. This is a public API for SDK integration.
12118
- * @summary Get Store Config Schema (Public SDK API)
12119
- * @param {string} xStoreid Store ID
12120
- * @param {string} xStoresecret Store Secret
12121
- * @param {string} xStoreID X-Store ID (must match x-storeid header)
13047
+ * Returns metadata for all configurable store fields (types, defaults, validation). **Auth:** `x-storeid` and `x-storesecret`. Path `xStoreID` must match the `x-storeid` header.
13048
+ * @summary Get store config schema
13049
+ * @param {string} xStoreid Store ID (from dashboard)
13050
+ * @param {string} xStoresecret Store read secret
13051
+ * @param {string} xStoreID Store ID (must match x-storeid header)
12122
13052
  * @param {*} [options] Override http request option.
12123
13053
  * @throws {RequiredError}
12124
13054
  */
@@ -12185,11 +13115,11 @@ export declare class SDKStoreCreationApi extends BaseAPI {
12185
13115
  */
12186
13116
  export declare const SDKStoreInfoApiAxiosParamCreator: (configuration?: Configuration) => {
12187
13117
  /**
12188
- * Retrieves basic store information (name, location, status) using x-store ID and read secret. This is a public API for SDK integration. Uses read secret (x-storesecret).
12189
- * @summary Get Store Info (Public SDK API)
12190
- * @param {string} xStoreid Store ID
12191
- * @param {string} xStoresecret Store Read Secret (for read operations)
12192
- * @param {string} xStoreID X-Store ID (must match x-storeid header)
13118
+ * Returns basic store details (name, location, status). **Auth:** `x-storeid` and `x-storesecret`. Path `xStoreID` must match the `x-storeid` header.
13119
+ * @summary Get store info
13120
+ * @param {string} xStoreid Store ID (from dashboard)
13121
+ * @param {string} xStoresecret Store read secret
13122
+ * @param {string} xStoreID Store ID (must match x-storeid header)
12193
13123
  * @param {*} [options] Override http request option.
12194
13124
  * @throws {RequiredError}
12195
13125
  */
@@ -12200,11 +13130,11 @@ export declare const SDKStoreInfoApiAxiosParamCreator: (configuration?: Configur
12200
13130
  */
12201
13131
  export declare const SDKStoreInfoApiFp: (configuration?: Configuration) => {
12202
13132
  /**
12203
- * Retrieves basic store information (name, location, status) using x-store ID and read secret. This is a public API for SDK integration. Uses read secret (x-storesecret).
12204
- * @summary Get Store Info (Public SDK API)
12205
- * @param {string} xStoreid Store ID
12206
- * @param {string} xStoresecret Store Read Secret (for read operations)
12207
- * @param {string} xStoreID X-Store ID (must match x-storeid header)
13133
+ * Returns basic store details (name, location, status). **Auth:** `x-storeid` and `x-storesecret`. Path `xStoreID` must match the `x-storeid` header.
13134
+ * @summary Get store info
13135
+ * @param {string} xStoreid Store ID (from dashboard)
13136
+ * @param {string} xStoresecret Store read secret
13137
+ * @param {string} xStoreID Store ID (must match x-storeid header)
12208
13138
  * @param {*} [options] Override http request option.
12209
13139
  * @throws {RequiredError}
12210
13140
  */
@@ -12215,11 +13145,11 @@ export declare const SDKStoreInfoApiFp: (configuration?: Configuration) => {
12215
13145
  */
12216
13146
  export declare const SDKStoreInfoApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
12217
13147
  /**
12218
- * Retrieves basic store information (name, location, status) using x-store ID and read secret. This is a public API for SDK integration. Uses read secret (x-storesecret).
12219
- * @summary Get Store Info (Public SDK API)
12220
- * @param {string} xStoreid Store ID
12221
- * @param {string} xStoresecret Store Read Secret (for read operations)
12222
- * @param {string} xStoreID X-Store ID (must match x-storeid header)
13148
+ * Returns basic store details (name, location, status). **Auth:** `x-storeid` and `x-storesecret`. Path `xStoreID` must match the `x-storeid` header.
13149
+ * @summary Get store info
13150
+ * @param {string} xStoreid Store ID (from dashboard)
13151
+ * @param {string} xStoresecret Store read secret
13152
+ * @param {string} xStoreID Store ID (must match x-storeid header)
12223
13153
  * @param {*} [options] Override http request option.
12224
13154
  * @throws {RequiredError}
12225
13155
  */
@@ -12230,11 +13160,11 @@ export declare const SDKStoreInfoApiFactory: (configuration?: Configuration, bas
12230
13160
  */
12231
13161
  export declare class SDKStoreInfoApi extends BaseAPI {
12232
13162
  /**
12233
- * Retrieves basic store information (name, location, status) using x-store ID and read secret. This is a public API for SDK integration. Uses read secret (x-storesecret).
12234
- * @summary Get Store Info (Public SDK API)
12235
- * @param {string} xStoreid Store ID
12236
- * @param {string} xStoresecret Store Read Secret (for read operations)
12237
- * @param {string} xStoreID X-Store ID (must match x-storeid header)
13163
+ * Returns basic store details (name, location, status). **Auth:** `x-storeid` and `x-storesecret`. Path `xStoreID` must match the `x-storeid` header.
13164
+ * @summary Get store info
13165
+ * @param {string} xStoreid Store ID (from dashboard)
13166
+ * @param {string} xStoresecret Store read secret
13167
+ * @param {string} xStoreID Store ID (must match x-storeid header)
12238
13168
  * @param {*} [options] Override http request option.
12239
13169
  * @throws {RequiredError}
12240
13170
  */
@@ -12245,13 +13175,13 @@ export declare class SDKStoreInfoApi extends BaseAPI {
12245
13175
  */
12246
13176
  export declare const SearchApiAxiosParamCreator: (configuration?: Configuration) => {
12247
13177
  /**
12248
- * Search documents using query parameters. Supports all features of POST endpoint.
12249
- * @summary Public Search API (GET)
12250
- * @param {string} xStoreid Store ID
12251
- * @param {string} xStoresecret Store Secret
13178
+ * Same as POST search; all parameters are passed as query params. **Authentication:** `x-storeid` and `x-storesecret` headers. Use `q` for the search query; optional params: `page`, `per_page`, `filter_by`, `sort_by`, `facet_by`, `widget_mode`, `include_suggestions`, etc.
13179
+ * @summary Search (GET)
13180
+ * @param {string} xStoreid Store ID (from dashboard)
13181
+ * @param {string} xStoresecret Store read secret (from dashboard)
12252
13182
  * @param {string} q Search query
12253
13183
  * @param {string} [xUserId] User ID for personalization
12254
- * @param {string} [xAnonId] Anonymous ID for personalization
13184
+ * @param {string} [xAnonId] Anonymous user ID for personalization
12255
13185
  * @param {string} [xSessionId] Session ID for personalization
12256
13186
  * @param {number} [page] Page number (default: 1)
12257
13187
  * @param {number} [perPage] Items per page (default: 10)
@@ -12295,13 +13225,13 @@ export declare const SearchApiAxiosParamCreator: (configuration?: Configuration)
12295
13225
  */
12296
13226
  v1SearchGet: (xStoreid: string, xStoresecret: string, q: string, xUserId?: string, xAnonId?: string, xSessionId?: string, page?: number, perPage?: number, sortBy?: string, filterBy?: string, facetBy?: string, maxFacetValues?: number, widgetMode?: boolean, includeSuggestions?: boolean, suggestionsLimit?: number, analyticsTags?: string, stopwordSets?: string, synonymSets?: string, searchFields?: string, returnFields?: string, omitFields?: string, snippetFields?: string, fullSnippetFields?: string, fieldWeights?: string, groupField?: string, groupSize?: number, snippetPrefix?: string, snippetSuffix?: string, snippetTokenLimit?: number, snippetMinLen?: number, includeSnippets?: boolean, prefixMode?: string, infixMode?: string, typoMax?: number, typoMinLen1?: number, typoMinLen2?: number, searchTimeoutMs?: number, requireAllTerms?: boolean, exactMatchBoost?: boolean, cacheResults?: boolean, applyRules?: boolean, presetName?: string, facetSearchText?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
12297
13227
  /**
12298
- * Search documents using store credentials with optional autocomplete suggestions and configurable stopwords/synonyms. Supports personalization via x-user-id, x-anon-id, x-session-id headers.
12299
- * @summary Public Search API
12300
- * @param {string} xStoreid Store ID
12301
- * @param {string} xStoresecret Store Secret
12302
- * @param {DataTypesPublicSearchRequest} dataTypesPublicSearchRequest Search request with optional stopword_sets and synonym_sets for granular control
12303
- * @param {string} [xUserId] User ID for personalization (logged-in user)
12304
- * @param {string} [xAnonId] Anonymous ID for personalization (cookie/device ID)
13228
+ * Run a full-text search for your store. **Authentication:** Send `x-storeid` and `x-storesecret` (from Seekora dashboard). Optional: `x-user-id`, `x-anon-id`, `x-session-id` for personalization. Supports pagination, filters, facets, sorting, snippets, and autocomplete suggestions. Use `widget_mode: true` for lightweight widget results.
13229
+ * @summary Search (POST)
13230
+ * @param {string} xStoreid Store ID (from dashboard)
13231
+ * @param {string} xStoresecret Store read secret (from dashboard)
13232
+ * @param {DataTypesPublicSearchRequest} dataTypesPublicSearchRequest Search query, filters, pagination, and options
13233
+ * @param {string} [xUserId] User ID for personalization
13234
+ * @param {string} [xAnonId] Anonymous user ID for personalization
12305
13235
  * @param {string} [xSessionId] Session ID for personalization
12306
13236
  * @param {*} [options] Override http request option.
12307
13237
  * @throws {RequiredError}
@@ -12313,13 +13243,13 @@ export declare const SearchApiAxiosParamCreator: (configuration?: Configuration)
12313
13243
  */
12314
13244
  export declare const SearchApiFp: (configuration?: Configuration) => {
12315
13245
  /**
12316
- * Search documents using query parameters. Supports all features of POST endpoint.
12317
- * @summary Public Search API (GET)
12318
- * @param {string} xStoreid Store ID
12319
- * @param {string} xStoresecret Store Secret
13246
+ * Same as POST search; all parameters are passed as query params. **Authentication:** `x-storeid` and `x-storesecret` headers. Use `q` for the search query; optional params: `page`, `per_page`, `filter_by`, `sort_by`, `facet_by`, `widget_mode`, `include_suggestions`, etc.
13247
+ * @summary Search (GET)
13248
+ * @param {string} xStoreid Store ID (from dashboard)
13249
+ * @param {string} xStoresecret Store read secret (from dashboard)
12320
13250
  * @param {string} q Search query
12321
13251
  * @param {string} [xUserId] User ID for personalization
12322
- * @param {string} [xAnonId] Anonymous ID for personalization
13252
+ * @param {string} [xAnonId] Anonymous user ID for personalization
12323
13253
  * @param {string} [xSessionId] Session ID for personalization
12324
13254
  * @param {number} [page] Page number (default: 1)
12325
13255
  * @param {number} [perPage] Items per page (default: 10)
@@ -12363,13 +13293,13 @@ export declare const SearchApiFp: (configuration?: Configuration) => {
12363
13293
  */
12364
13294
  v1SearchGet(xStoreid: string, xStoresecret: string, q: string, xUserId?: string, xAnonId?: string, xSessionId?: string, page?: number, perPage?: number, sortBy?: string, filterBy?: string, facetBy?: string, maxFacetValues?: number, widgetMode?: boolean, includeSuggestions?: boolean, suggestionsLimit?: number, analyticsTags?: string, stopwordSets?: string, synonymSets?: string, searchFields?: string, returnFields?: string, omitFields?: string, snippetFields?: string, fullSnippetFields?: string, fieldWeights?: string, groupField?: string, groupSize?: number, snippetPrefix?: string, snippetSuffix?: string, snippetTokenLimit?: number, snippetMinLen?: number, includeSnippets?: boolean, prefixMode?: string, infixMode?: string, typoMax?: number, typoMinLen1?: number, typoMinLen2?: number, searchTimeoutMs?: number, requireAllTerms?: boolean, exactMatchBoost?: boolean, cacheResults?: boolean, applyRules?: boolean, presetName?: string, facetSearchText?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesOfficialSearchResponseWrapper>>;
12365
13295
  /**
12366
- * Search documents using store credentials with optional autocomplete suggestions and configurable stopwords/synonyms. Supports personalization via x-user-id, x-anon-id, x-session-id headers.
12367
- * @summary Public Search API
12368
- * @param {string} xStoreid Store ID
12369
- * @param {string} xStoresecret Store Secret
12370
- * @param {DataTypesPublicSearchRequest} dataTypesPublicSearchRequest Search request with optional stopword_sets and synonym_sets for granular control
12371
- * @param {string} [xUserId] User ID for personalization (logged-in user)
12372
- * @param {string} [xAnonId] Anonymous ID for personalization (cookie/device ID)
13296
+ * Run a full-text search for your store. **Authentication:** Send `x-storeid` and `x-storesecret` (from Seekora dashboard). Optional: `x-user-id`, `x-anon-id`, `x-session-id` for personalization. Supports pagination, filters, facets, sorting, snippets, and autocomplete suggestions. Use `widget_mode: true` for lightweight widget results.
13297
+ * @summary Search (POST)
13298
+ * @param {string} xStoreid Store ID (from dashboard)
13299
+ * @param {string} xStoresecret Store read secret (from dashboard)
13300
+ * @param {DataTypesPublicSearchRequest} dataTypesPublicSearchRequest Search query, filters, pagination, and options
13301
+ * @param {string} [xUserId] User ID for personalization
13302
+ * @param {string} [xAnonId] Anonymous user ID for personalization
12373
13303
  * @param {string} [xSessionId] Session ID for personalization
12374
13304
  * @param {*} [options] Override http request option.
12375
13305
  * @throws {RequiredError}
@@ -12381,13 +13311,13 @@ export declare const SearchApiFp: (configuration?: Configuration) => {
12381
13311
  */
12382
13312
  export declare const SearchApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
12383
13313
  /**
12384
- * Search documents using query parameters. Supports all features of POST endpoint.
12385
- * @summary Public Search API (GET)
12386
- * @param {string} xStoreid Store ID
12387
- * @param {string} xStoresecret Store Secret
13314
+ * Same as POST search; all parameters are passed as query params. **Authentication:** `x-storeid` and `x-storesecret` headers. Use `q` for the search query; optional params: `page`, `per_page`, `filter_by`, `sort_by`, `facet_by`, `widget_mode`, `include_suggestions`, etc.
13315
+ * @summary Search (GET)
13316
+ * @param {string} xStoreid Store ID (from dashboard)
13317
+ * @param {string} xStoresecret Store read secret (from dashboard)
12388
13318
  * @param {string} q Search query
12389
13319
  * @param {string} [xUserId] User ID for personalization
12390
- * @param {string} [xAnonId] Anonymous ID for personalization
13320
+ * @param {string} [xAnonId] Anonymous user ID for personalization
12391
13321
  * @param {string} [xSessionId] Session ID for personalization
12392
13322
  * @param {number} [page] Page number (default: 1)
12393
13323
  * @param {number} [perPage] Items per page (default: 10)
@@ -12431,13 +13361,13 @@ export declare const SearchApiFactory: (configuration?: Configuration, basePath?
12431
13361
  */
12432
13362
  v1SearchGet(xStoreid: string, xStoresecret: string, q: string, xUserId?: string, xAnonId?: string, xSessionId?: string, page?: number, perPage?: number, sortBy?: string, filterBy?: string, facetBy?: string, maxFacetValues?: number, widgetMode?: boolean, includeSuggestions?: boolean, suggestionsLimit?: number, analyticsTags?: string, stopwordSets?: string, synonymSets?: string, searchFields?: string, returnFields?: string, omitFields?: string, snippetFields?: string, fullSnippetFields?: string, fieldWeights?: string, groupField?: string, groupSize?: number, snippetPrefix?: string, snippetSuffix?: string, snippetTokenLimit?: number, snippetMinLen?: number, includeSnippets?: boolean, prefixMode?: string, infixMode?: string, typoMax?: number, typoMinLen1?: number, typoMinLen2?: number, searchTimeoutMs?: number, requireAllTerms?: boolean, exactMatchBoost?: boolean, cacheResults?: boolean, applyRules?: boolean, presetName?: string, facetSearchText?: string, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesOfficialSearchResponseWrapper>;
12433
13363
  /**
12434
- * Search documents using store credentials with optional autocomplete suggestions and configurable stopwords/synonyms. Supports personalization via x-user-id, x-anon-id, x-session-id headers.
12435
- * @summary Public Search API
12436
- * @param {string} xStoreid Store ID
12437
- * @param {string} xStoresecret Store Secret
12438
- * @param {DataTypesPublicSearchRequest} dataTypesPublicSearchRequest Search request with optional stopword_sets and synonym_sets for granular control
12439
- * @param {string} [xUserId] User ID for personalization (logged-in user)
12440
- * @param {string} [xAnonId] Anonymous ID for personalization (cookie/device ID)
13364
+ * Run a full-text search for your store. **Authentication:** Send `x-storeid` and `x-storesecret` (from Seekora dashboard). Optional: `x-user-id`, `x-anon-id`, `x-session-id` for personalization. Supports pagination, filters, facets, sorting, snippets, and autocomplete suggestions. Use `widget_mode: true` for lightweight widget results.
13365
+ * @summary Search (POST)
13366
+ * @param {string} xStoreid Store ID (from dashboard)
13367
+ * @param {string} xStoresecret Store read secret (from dashboard)
13368
+ * @param {DataTypesPublicSearchRequest} dataTypesPublicSearchRequest Search query, filters, pagination, and options
13369
+ * @param {string} [xUserId] User ID for personalization
13370
+ * @param {string} [xAnonId] Anonymous user ID for personalization
12441
13371
  * @param {string} [xSessionId] Session ID for personalization
12442
13372
  * @param {*} [options] Override http request option.
12443
13373
  * @throws {RequiredError}
@@ -12449,13 +13379,13 @@ export declare const SearchApiFactory: (configuration?: Configuration, basePath?
12449
13379
  */
12450
13380
  export declare class SearchApi extends BaseAPI {
12451
13381
  /**
12452
- * Search documents using query parameters. Supports all features of POST endpoint.
12453
- * @summary Public Search API (GET)
12454
- * @param {string} xStoreid Store ID
12455
- * @param {string} xStoresecret Store Secret
13382
+ * Same as POST search; all parameters are passed as query params. **Authentication:** `x-storeid` and `x-storesecret` headers. Use `q` for the search query; optional params: `page`, `per_page`, `filter_by`, `sort_by`, `facet_by`, `widget_mode`, `include_suggestions`, etc.
13383
+ * @summary Search (GET)
13384
+ * @param {string} xStoreid Store ID (from dashboard)
13385
+ * @param {string} xStoresecret Store read secret (from dashboard)
12456
13386
  * @param {string} q Search query
12457
13387
  * @param {string} [xUserId] User ID for personalization
12458
- * @param {string} [xAnonId] Anonymous ID for personalization
13388
+ * @param {string} [xAnonId] Anonymous user ID for personalization
12459
13389
  * @param {string} [xSessionId] Session ID for personalization
12460
13390
  * @param {number} [page] Page number (default: 1)
12461
13391
  * @param {number} [perPage] Items per page (default: 10)
@@ -12499,13 +13429,13 @@ export declare class SearchApi extends BaseAPI {
12499
13429
  */
12500
13430
  v1SearchGet(xStoreid: string, xStoresecret: string, q: string, xUserId?: string, xAnonId?: string, xSessionId?: string, page?: number, perPage?: number, sortBy?: string, filterBy?: string, facetBy?: string, maxFacetValues?: number, widgetMode?: boolean, includeSuggestions?: boolean, suggestionsLimit?: number, analyticsTags?: string, stopwordSets?: string, synonymSets?: string, searchFields?: string, returnFields?: string, omitFields?: string, snippetFields?: string, fullSnippetFields?: string, fieldWeights?: string, groupField?: string, groupSize?: number, snippetPrefix?: string, snippetSuffix?: string, snippetTokenLimit?: number, snippetMinLen?: number, includeSnippets?: boolean, prefixMode?: string, infixMode?: string, typoMax?: number, typoMinLen1?: number, typoMinLen2?: number, searchTimeoutMs?: number, requireAllTerms?: boolean, exactMatchBoost?: boolean, cacheResults?: boolean, applyRules?: boolean, presetName?: string, facetSearchText?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesOfficialSearchResponseWrapper, any, {}>>;
12501
13431
  /**
12502
- * Search documents using store credentials with optional autocomplete suggestions and configurable stopwords/synonyms. Supports personalization via x-user-id, x-anon-id, x-session-id headers.
12503
- * @summary Public Search API
12504
- * @param {string} xStoreid Store ID
12505
- * @param {string} xStoresecret Store Secret
12506
- * @param {DataTypesPublicSearchRequest} dataTypesPublicSearchRequest Search request with optional stopword_sets and synonym_sets for granular control
12507
- * @param {string} [xUserId] User ID for personalization (logged-in user)
12508
- * @param {string} [xAnonId] Anonymous ID for personalization (cookie/device ID)
13432
+ * Run a full-text search for your store. **Authentication:** Send `x-storeid` and `x-storesecret` (from Seekora dashboard). Optional: `x-user-id`, `x-anon-id`, `x-session-id` for personalization. Supports pagination, filters, facets, sorting, snippets, and autocomplete suggestions. Use `widget_mode: true` for lightweight widget results.
13433
+ * @summary Search (POST)
13434
+ * @param {string} xStoreid Store ID (from dashboard)
13435
+ * @param {string} xStoresecret Store read secret (from dashboard)
13436
+ * @param {DataTypesPublicSearchRequest} dataTypesPublicSearchRequest Search query, filters, pagination, and options
13437
+ * @param {string} [xUserId] User ID for personalization
13438
+ * @param {string} [xAnonId] Anonymous user ID for personalization
12509
13439
  * @param {string} [xSessionId] Session ID for personalization
12510
13440
  * @param {*} [options] Override http request option.
12511
13441
  * @throws {RequiredError}