@seekora-ai/admin-api 1.1.85 → 1.1.87

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.
package/dist/api.d.ts CHANGED
@@ -3448,6 +3448,383 @@ export interface AnalyticsCreateFunnelRequestBody {
3448
3448
  */
3449
3449
  'store_id'?: number;
3450
3450
  }
3451
+ /**
3452
+ *
3453
+ * @export
3454
+ * @interface AnalyticsCustomEventFieldBreakdown
3455
+ */
3456
+ export interface AnalyticsCustomEventFieldBreakdown {
3457
+ /**
3458
+ *
3459
+ * @type {string}
3460
+ * @memberof AnalyticsCustomEventFieldBreakdown
3461
+ */
3462
+ 'event_name'?: string;
3463
+ /**
3464
+ *
3465
+ * @type {string}
3466
+ * @memberof AnalyticsCustomEventFieldBreakdown
3467
+ */
3468
+ 'field_name'?: string;
3469
+ /**
3470
+ *
3471
+ * @type {string}
3472
+ * @memberof AnalyticsCustomEventFieldBreakdown
3473
+ */
3474
+ 'field_slot'?: string;
3475
+ /**
3476
+ *
3477
+ * @type {Array<AnalyticsFieldBreakdownEntry>}
3478
+ * @memberof AnalyticsCustomEventFieldBreakdown
3479
+ */
3480
+ 'values'?: Array<AnalyticsFieldBreakdownEntry>;
3481
+ }
3482
+ /**
3483
+ *
3484
+ * @export
3485
+ * @interface AnalyticsCustomEventFieldBreakdownRequestBody
3486
+ */
3487
+ export interface AnalyticsCustomEventFieldBreakdownRequestBody {
3488
+ /**
3489
+ *
3490
+ * @type {string}
3491
+ * @memberof AnalyticsCustomEventFieldBreakdownRequestBody
3492
+ */
3493
+ 'end_date': string;
3494
+ /**
3495
+ *
3496
+ * @type {string}
3497
+ * @memberof AnalyticsCustomEventFieldBreakdownRequestBody
3498
+ */
3499
+ 'event_name': string;
3500
+ /**
3501
+ *
3502
+ * @type {string}
3503
+ * @memberof AnalyticsCustomEventFieldBreakdownRequestBody
3504
+ */
3505
+ 'field_slot': string;
3506
+ /**
3507
+ * hour, day, week, month
3508
+ * @type {string}
3509
+ * @memberof AnalyticsCustomEventFieldBreakdownRequestBody
3510
+ */
3511
+ 'granularity'?: string;
3512
+ /**
3513
+ *
3514
+ * @type {number}
3515
+ * @memberof AnalyticsCustomEventFieldBreakdownRequestBody
3516
+ */
3517
+ 'limit'?: number;
3518
+ /**
3519
+ *
3520
+ * @type {number}
3521
+ * @memberof AnalyticsCustomEventFieldBreakdownRequestBody
3522
+ */
3523
+ 'page'?: number;
3524
+ /**
3525
+ *
3526
+ * @type {number}
3527
+ * @memberof AnalyticsCustomEventFieldBreakdownRequestBody
3528
+ */
3529
+ 'page_size'?: number;
3530
+ /**
3531
+ *
3532
+ * @type {string}
3533
+ * @memberof AnalyticsCustomEventFieldBreakdownRequestBody
3534
+ */
3535
+ 'start_date': string;
3536
+ /**
3537
+ *
3538
+ * @type {string}
3539
+ * @memberof AnalyticsCustomEventFieldBreakdownRequestBody
3540
+ */
3541
+ 'xstoreid'?: string;
3542
+ }
3543
+ /**
3544
+ *
3545
+ * @export
3546
+ * @interface AnalyticsCustomEventMetrics
3547
+ */
3548
+ export interface AnalyticsCustomEventMetrics {
3549
+ /**
3550
+ *
3551
+ * @type {Array<SeekoraGoSrcServicesAnalyticsTimeSeriesPoint>}
3552
+ * @memberof AnalyticsCustomEventMetrics
3553
+ */
3554
+ 'time_series'?: Array<SeekoraGoSrcServicesAnalyticsTimeSeriesPoint>;
3555
+ /**
3556
+ *
3557
+ * @type {number}
3558
+ * @memberof AnalyticsCustomEventMetrics
3559
+ */
3560
+ 'total_events'?: number;
3561
+ /**
3562
+ *
3563
+ * @type {number}
3564
+ * @memberof AnalyticsCustomEventMetrics
3565
+ */
3566
+ 'unique_event_types'?: number;
3567
+ /**
3568
+ *
3569
+ * @type {number}
3570
+ * @memberof AnalyticsCustomEventMetrics
3571
+ */
3572
+ 'unique_sessions'?: number;
3573
+ /**
3574
+ *
3575
+ * @type {number}
3576
+ * @memberof AnalyticsCustomEventMetrics
3577
+ */
3578
+ 'unique_users'?: number;
3579
+ }
3580
+ /**
3581
+ *
3582
+ * @export
3583
+ * @interface AnalyticsCustomEventMetricsRequestBody
3584
+ */
3585
+ export interface AnalyticsCustomEventMetricsRequestBody {
3586
+ /**
3587
+ *
3588
+ * @type {string}
3589
+ * @memberof AnalyticsCustomEventMetricsRequestBody
3590
+ */
3591
+ 'end_date': string;
3592
+ /**
3593
+ *
3594
+ * @type {string}
3595
+ * @memberof AnalyticsCustomEventMetricsRequestBody
3596
+ */
3597
+ 'event_name'?: string;
3598
+ /**
3599
+ * hour, day, week, month
3600
+ * @type {string}
3601
+ * @memberof AnalyticsCustomEventMetricsRequestBody
3602
+ */
3603
+ 'granularity'?: string;
3604
+ /**
3605
+ *
3606
+ * @type {number}
3607
+ * @memberof AnalyticsCustomEventMetricsRequestBody
3608
+ */
3609
+ 'page'?: number;
3610
+ /**
3611
+ *
3612
+ * @type {number}
3613
+ * @memberof AnalyticsCustomEventMetricsRequestBody
3614
+ */
3615
+ 'page_size'?: number;
3616
+ /**
3617
+ *
3618
+ * @type {string}
3619
+ * @memberof AnalyticsCustomEventMetricsRequestBody
3620
+ */
3621
+ 'start_date': string;
3622
+ /**
3623
+ *
3624
+ * @type {string}
3625
+ * @memberof AnalyticsCustomEventMetricsRequestBody
3626
+ */
3627
+ 'xstoreid'?: string;
3628
+ }
3629
+ /**
3630
+ *
3631
+ * @export
3632
+ * @interface AnalyticsCustomEventRow
3633
+ */
3634
+ export interface AnalyticsCustomEventRow {
3635
+ /**
3636
+ *
3637
+ * @type {string}
3638
+ * @memberof AnalyticsCustomEventRow
3639
+ */
3640
+ 'event_id'?: string;
3641
+ /**
3642
+ *
3643
+ * @type {string}
3644
+ * @memberof AnalyticsCustomEventRow
3645
+ */
3646
+ 'event_name'?: string;
3647
+ /**
3648
+ *
3649
+ * @type {string}
3650
+ * @memberof AnalyticsCustomEventRow
3651
+ */
3652
+ 'event_ts'?: string;
3653
+ /**
3654
+ *
3655
+ * @type {{ [key: string]: any; }}
3656
+ * @memberof AnalyticsCustomEventRow
3657
+ */
3658
+ 'fields'?: {
3659
+ [key: string]: any;
3660
+ };
3661
+ /**
3662
+ *
3663
+ * @type {string}
3664
+ * @memberof AnalyticsCustomEventRow
3665
+ */
3666
+ 'session_id'?: string;
3667
+ /**
3668
+ *
3669
+ * @type {string}
3670
+ * @memberof AnalyticsCustomEventRow
3671
+ */
3672
+ 'user_key'?: string;
3673
+ }
3674
+ /**
3675
+ *
3676
+ * @export
3677
+ * @interface AnalyticsCustomEventStreamRequestBody
3678
+ */
3679
+ export interface AnalyticsCustomEventStreamRequestBody {
3680
+ /**
3681
+ *
3682
+ * @type {string}
3683
+ * @memberof AnalyticsCustomEventStreamRequestBody
3684
+ */
3685
+ 'end_date': string;
3686
+ /**
3687
+ *
3688
+ * @type {string}
3689
+ * @memberof AnalyticsCustomEventStreamRequestBody
3690
+ */
3691
+ 'event_name'?: string;
3692
+ /**
3693
+ * hour, day, week, month
3694
+ * @type {string}
3695
+ * @memberof AnalyticsCustomEventStreamRequestBody
3696
+ */
3697
+ 'granularity'?: string;
3698
+ /**
3699
+ *
3700
+ * @type {number}
3701
+ * @memberof AnalyticsCustomEventStreamRequestBody
3702
+ */
3703
+ 'page'?: number;
3704
+ /**
3705
+ *
3706
+ * @type {number}
3707
+ * @memberof AnalyticsCustomEventStreamRequestBody
3708
+ */
3709
+ 'page_size'?: number;
3710
+ /**
3711
+ *
3712
+ * @type {string}
3713
+ * @memberof AnalyticsCustomEventStreamRequestBody
3714
+ */
3715
+ 'start_date': string;
3716
+ /**
3717
+ *
3718
+ * @type {string}
3719
+ * @memberof AnalyticsCustomEventStreamRequestBody
3720
+ */
3721
+ 'xstoreid'?: string;
3722
+ }
3723
+ /**
3724
+ *
3725
+ * @export
3726
+ * @interface AnalyticsCustomEventSummary
3727
+ */
3728
+ export interface AnalyticsCustomEventSummary {
3729
+ /**
3730
+ *
3731
+ * @type {number}
3732
+ * @memberof AnalyticsCustomEventSummary
3733
+ */
3734
+ 'event_count'?: number;
3735
+ /**
3736
+ *
3737
+ * @type {string}
3738
+ * @memberof AnalyticsCustomEventSummary
3739
+ */
3740
+ 'event_name'?: string;
3741
+ /**
3742
+ *
3743
+ * @type {string}
3744
+ * @memberof AnalyticsCustomEventSummary
3745
+ */
3746
+ 'last_seen'?: string;
3747
+ /**
3748
+ *
3749
+ * @type {number}
3750
+ * @memberof AnalyticsCustomEventSummary
3751
+ */
3752
+ 'unique_users'?: number;
3753
+ }
3754
+ /**
3755
+ *
3756
+ * @export
3757
+ * @interface AnalyticsCustomEventTimeSeriesPoint
3758
+ */
3759
+ export interface AnalyticsCustomEventTimeSeriesPoint {
3760
+ /**
3761
+ *
3762
+ * @type {number}
3763
+ * @memberof AnalyticsCustomEventTimeSeriesPoint
3764
+ */
3765
+ 'count'?: number;
3766
+ /**
3767
+ *
3768
+ * @type {string}
3769
+ * @memberof AnalyticsCustomEventTimeSeriesPoint
3770
+ */
3771
+ 'event_name'?: string;
3772
+ /**
3773
+ *
3774
+ * @type {string}
3775
+ * @memberof AnalyticsCustomEventTimeSeriesPoint
3776
+ */
3777
+ 'timestamp'?: string;
3778
+ }
3779
+ /**
3780
+ *
3781
+ * @export
3782
+ * @interface AnalyticsCustomEventTimeSeriesRequestBody
3783
+ */
3784
+ export interface AnalyticsCustomEventTimeSeriesRequestBody {
3785
+ /**
3786
+ *
3787
+ * @type {string}
3788
+ * @memberof AnalyticsCustomEventTimeSeriesRequestBody
3789
+ */
3790
+ 'end_date': string;
3791
+ /**
3792
+ *
3793
+ * @type {string}
3794
+ * @memberof AnalyticsCustomEventTimeSeriesRequestBody
3795
+ */
3796
+ 'event_name'?: string;
3797
+ /**
3798
+ * hour, day, week, month
3799
+ * @type {string}
3800
+ * @memberof AnalyticsCustomEventTimeSeriesRequestBody
3801
+ */
3802
+ 'granularity'?: string;
3803
+ /**
3804
+ *
3805
+ * @type {number}
3806
+ * @memberof AnalyticsCustomEventTimeSeriesRequestBody
3807
+ */
3808
+ 'page'?: number;
3809
+ /**
3810
+ *
3811
+ * @type {number}
3812
+ * @memberof AnalyticsCustomEventTimeSeriesRequestBody
3813
+ */
3814
+ 'page_size'?: number;
3815
+ /**
3816
+ *
3817
+ * @type {string}
3818
+ * @memberof AnalyticsCustomEventTimeSeriesRequestBody
3819
+ */
3820
+ 'start_date': string;
3821
+ /**
3822
+ *
3823
+ * @type {string}
3824
+ * @memberof AnalyticsCustomEventTimeSeriesRequestBody
3825
+ */
3826
+ 'xstoreid'?: string;
3827
+ }
3451
3828
  /**
3452
3829
  *
3453
3830
  * @export
@@ -3752,6 +4129,25 @@ export interface AnalyticsExtendedKPIResponse {
3752
4129
  */
3753
4130
  'xstoreid'?: string;
3754
4131
  }
4132
+ /**
4133
+ *
4134
+ * @export
4135
+ * @interface AnalyticsFieldBreakdownEntry
4136
+ */
4137
+ export interface AnalyticsFieldBreakdownEntry {
4138
+ /**
4139
+ *
4140
+ * @type {number}
4141
+ * @memberof AnalyticsFieldBreakdownEntry
4142
+ */
4143
+ 'count'?: number;
4144
+ /**
4145
+ *
4146
+ * @type {string}
4147
+ * @memberof AnalyticsFieldBreakdownEntry
4148
+ */
4149
+ 'value'?: string;
4150
+ }
3755
4151
  /**
3756
4152
  *
3757
4153
  * @export
@@ -6831,6 +7227,12 @@ export interface AnalyticsKPIMetrics {
6831
7227
  * @memberof AnalyticsKPIMetrics
6832
7228
  */
6833
7229
  'revenue_currency'?: string;
7230
+ /**
7231
+ *
7232
+ * @type {number}
7233
+ * @memberof AnalyticsKPIMetrics
7234
+ */
7235
+ 'total_custom_events'?: number;
6834
7236
  /**
6835
7237
  *
6836
7238
  * @type {number}
@@ -6886,6 +7288,12 @@ export interface AnalyticsKPIPointExtended {
6886
7288
  * @memberof AnalyticsKPIPointExtended
6887
7289
  */
6888
7290
  'ctr'?: number;
7291
+ /**
7292
+ *
7293
+ * @type {number}
7294
+ * @memberof AnalyticsKPIPointExtended
7295
+ */
7296
+ 'custom_events'?: number;
6889
7297
  /**
6890
7298
  *
6891
7299
  * @type {number}
@@ -7134,6 +7542,43 @@ export interface AnalyticsOverviewComparison {
7134
7542
  */
7135
7543
  'revenue'?: AnalyticsPeriodComparison;
7136
7544
  }
7545
+ /**
7546
+ *
7547
+ * @export
7548
+ * @interface AnalyticsPaginatedResponseAnalyticsCustomEventRow
7549
+ */
7550
+ export interface AnalyticsPaginatedResponseAnalyticsCustomEventRow {
7551
+ /**
7552
+ *
7553
+ * @type {Array<AnalyticsCustomEventRow>}
7554
+ * @memberof AnalyticsPaginatedResponseAnalyticsCustomEventRow
7555
+ */
7556
+ 'data'?: Array<AnalyticsCustomEventRow>;
7557
+ /**
7558
+ *
7559
+ * @type {number}
7560
+ * @memberof AnalyticsPaginatedResponseAnalyticsCustomEventRow
7561
+ */
7562
+ 'page'?: number;
7563
+ /**
7564
+ *
7565
+ * @type {number}
7566
+ * @memberof AnalyticsPaginatedResponseAnalyticsCustomEventRow
7567
+ */
7568
+ 'page_size'?: number;
7569
+ /**
7570
+ *
7571
+ * @type {number}
7572
+ * @memberof AnalyticsPaginatedResponseAnalyticsCustomEventRow
7573
+ */
7574
+ 'total'?: number;
7575
+ /**
7576
+ *
7577
+ * @type {number}
7578
+ * @memberof AnalyticsPaginatedResponseAnalyticsCustomEventRow
7579
+ */
7580
+ 'total_pages'?: number;
7581
+ }
7137
7582
  /**
7138
7583
  *
7139
7584
  * @export
@@ -10670,6 +11115,61 @@ export interface AnalyticsTimeWindow {
10670
11115
  */
10671
11116
  'start_date'?: string;
10672
11117
  }
11118
+ /**
11119
+ *
11120
+ * @export
11121
+ * @interface AnalyticsTopCustomEventsRequestBody
11122
+ */
11123
+ export interface AnalyticsTopCustomEventsRequestBody {
11124
+ /**
11125
+ *
11126
+ * @type {string}
11127
+ * @memberof AnalyticsTopCustomEventsRequestBody
11128
+ */
11129
+ 'end_date': string;
11130
+ /**
11131
+ * hour, day, week, month
11132
+ * @type {string}
11133
+ * @memberof AnalyticsTopCustomEventsRequestBody
11134
+ */
11135
+ 'granularity'?: string;
11136
+ /**
11137
+ *
11138
+ * @type {number}
11139
+ * @memberof AnalyticsTopCustomEventsRequestBody
11140
+ */
11141
+ 'limit'?: number;
11142
+ /**
11143
+ *
11144
+ * @type {number}
11145
+ * @memberof AnalyticsTopCustomEventsRequestBody
11146
+ */
11147
+ 'page'?: number;
11148
+ /**
11149
+ *
11150
+ * @type {number}
11151
+ * @memberof AnalyticsTopCustomEventsRequestBody
11152
+ */
11153
+ 'page_size'?: number;
11154
+ /**
11155
+ *
11156
+ * @type {string}
11157
+ * @memberof AnalyticsTopCustomEventsRequestBody
11158
+ */
11159
+ 'sort_by'?: string;
11160
+ /**
11161
+ *
11162
+ * @type {string}
11163
+ * @memberof AnalyticsTopCustomEventsRequestBody
11164
+ */
11165
+ 'start_date': string;
11166
+ /**
11167
+ *
11168
+ * @type {string}
11169
+ * @memberof AnalyticsTopCustomEventsRequestBody
11170
+ */
11171
+ 'xstoreid'?: string;
11172
+ }
10673
11173
  /**
10674
11174
  *
10675
11175
  * @export
@@ -17180,6 +17680,19 @@ export interface DataTypesExperimentAssignment {
17180
17680
  */
17181
17681
  'variant_id'?: string;
17182
17682
  }
17683
+ /**
17684
+ *
17685
+ * @export
17686
+ * @interface DataTypesExperimentAssignmentResponse
17687
+ */
17688
+ export interface DataTypesExperimentAssignmentResponse {
17689
+ /**
17690
+ *
17691
+ * @type {Array<DataTypesExperimentAssignment>}
17692
+ * @memberof DataTypesExperimentAssignmentResponse
17693
+ */
17694
+ 'assignments'?: Array<DataTypesExperimentAssignment>;
17695
+ }
17183
17696
  /**
17184
17697
  *
17185
17698
  * @export
@@ -17443,6 +17956,81 @@ export interface DataTypesFacetRangeConfig {
17443
17956
  */
17444
17957
  'ranges'?: Array<DataTypesFacetRange>;
17445
17958
  }
17959
+ /**
17960
+ *
17961
+ * @export
17962
+ * @interface DataTypesFacetValuesSearchRequest
17963
+ */
17964
+ export interface DataTypesFacetValuesSearchRequest {
17965
+ /**
17966
+ *
17967
+ * @type {string}
17968
+ * @memberof DataTypesFacetValuesSearchRequest
17969
+ */
17970
+ 'facet_query': string;
17971
+ /**
17972
+ *
17973
+ * @type {string}
17974
+ * @memberof DataTypesFacetValuesSearchRequest
17975
+ */
17976
+ 'filter'?: string;
17977
+ /**
17978
+ *
17979
+ * @type {number}
17980
+ * @memberof DataTypesFacetValuesSearchRequest
17981
+ */
17982
+ 'max_values'?: number;
17983
+ /**
17984
+ *
17985
+ * @type {string}
17986
+ * @memberof DataTypesFacetValuesSearchRequest
17987
+ */
17988
+ 'q'?: string;
17989
+ }
17990
+ /**
17991
+ *
17992
+ * @export
17993
+ * @interface DataTypesFacetValuesSearchResponse
17994
+ */
17995
+ export interface DataTypesFacetValuesSearchResponse {
17996
+ /**
17997
+ *
17998
+ * @type {string}
17999
+ * @memberof DataTypesFacetValuesSearchResponse
18000
+ */
18001
+ 'facet_name'?: string;
18002
+ /**
18003
+ *
18004
+ * @type {Array<DataTypesFilterValue>}
18005
+ * @memberof DataTypesFacetValuesSearchResponse
18006
+ */
18007
+ 'values'?: Array<DataTypesFilterValue>;
18008
+ }
18009
+ /**
18010
+ *
18011
+ * @export
18012
+ * @interface DataTypesFacetValuesSearchResponseWrapper
18013
+ */
18014
+ export interface DataTypesFacetValuesSearchResponseWrapper {
18015
+ /**
18016
+ *
18017
+ * @type {DataTypesFacetValuesSearchResponse}
18018
+ * @memberof DataTypesFacetValuesSearchResponseWrapper
18019
+ */
18020
+ 'data'?: DataTypesFacetValuesSearchResponse;
18021
+ /**
18022
+ *
18023
+ * @type {string}
18024
+ * @memberof DataTypesFacetValuesSearchResponseWrapper
18025
+ */
18026
+ 'message'?: string;
18027
+ /**
18028
+ *
18029
+ * @type {number}
18030
+ * @memberof DataTypesFacetValuesSearchResponseWrapper
18031
+ */
18032
+ 'status'?: number;
18033
+ }
17446
18034
  /**
17447
18035
  *
17448
18036
  * @export
@@ -17837,6 +18425,142 @@ export interface DataTypesFieldMetadata {
17837
18425
  */
17838
18426
  'type'?: string;
17839
18427
  }
18428
+ /**
18429
+ *
18430
+ * @export
18431
+ * @interface DataTypesFilterField
18432
+ */
18433
+ export interface DataTypesFilterField {
18434
+ /**
18435
+ *
18436
+ * @type {string}
18437
+ * @memberof DataTypesFilterField
18438
+ */
18439
+ 'field'?: string;
18440
+ /**
18441
+ *
18442
+ * @type {DataTypesFilterStats}
18443
+ * @memberof DataTypesFilterField
18444
+ */
18445
+ 'stats'?: DataTypesFilterStats;
18446
+ /**
18447
+ *
18448
+ * @type {number}
18449
+ * @memberof DataTypesFilterField
18450
+ */
18451
+ 'total_values'?: number;
18452
+ /**
18453
+ * \"categorical\", \"numeric\", \"boolean\"
18454
+ * @type {string}
18455
+ * @memberof DataTypesFilterField
18456
+ */
18457
+ 'type'?: string;
18458
+ /**
18459
+ *
18460
+ * @type {Array<DataTypesFilterValue>}
18461
+ * @memberof DataTypesFilterField
18462
+ */
18463
+ 'values'?: Array<DataTypesFilterValue>;
18464
+ }
18465
+ /**
18466
+ *
18467
+ * @export
18468
+ * @interface DataTypesFilterSchemaField
18469
+ */
18470
+ export interface DataTypesFilterSchemaField {
18471
+ /**
18472
+ *
18473
+ * @type {boolean}
18474
+ * @memberof DataTypesFilterSchemaField
18475
+ */
18476
+ 'facetable'?: boolean;
18477
+ /**
18478
+ * \"categorical\", \"numeric\", \"boolean\"
18479
+ * @type {string}
18480
+ * @memberof DataTypesFilterSchemaField
18481
+ */
18482
+ 'filter_type'?: string;
18483
+ /**
18484
+ *
18485
+ * @type {string}
18486
+ * @memberof DataTypesFilterSchemaField
18487
+ */
18488
+ 'name'?: string;
18489
+ /**
18490
+ *
18491
+ * @type {Array<DataTypesFacetRange>}
18492
+ * @memberof DataTypesFilterSchemaField
18493
+ */
18494
+ 'ranges'?: Array<DataTypesFacetRange>;
18495
+ /**
18496
+ *
18497
+ * @type {boolean}
18498
+ * @memberof DataTypesFilterSchemaField
18499
+ */
18500
+ 'sortable'?: boolean;
18501
+ /**
18502
+ *
18503
+ * @type {string}
18504
+ * @memberof DataTypesFilterSchemaField
18505
+ */
18506
+ 'type'?: string;
18507
+ }
18508
+ /**
18509
+ *
18510
+ * @export
18511
+ * @interface DataTypesFilterStats
18512
+ */
18513
+ export interface DataTypesFilterStats {
18514
+ /**
18515
+ *
18516
+ * @type {number}
18517
+ * @memberof DataTypesFilterStats
18518
+ */
18519
+ 'avg'?: number;
18520
+ /**
18521
+ *
18522
+ * @type {number}
18523
+ * @memberof DataTypesFilterStats
18524
+ */
18525
+ 'max'?: number;
18526
+ /**
18527
+ *
18528
+ * @type {number}
18529
+ * @memberof DataTypesFilterStats
18530
+ */
18531
+ 'min'?: number;
18532
+ /**
18533
+ *
18534
+ * @type {number}
18535
+ * @memberof DataTypesFilterStats
18536
+ */
18537
+ 'sum'?: number;
18538
+ }
18539
+ /**
18540
+ *
18541
+ * @export
18542
+ * @interface DataTypesFilterValue
18543
+ */
18544
+ export interface DataTypesFilterValue {
18545
+ /**
18546
+ *
18547
+ * @type {number}
18548
+ * @memberof DataTypesFilterValue
18549
+ */
18550
+ 'count'?: number;
18551
+ /**
18552
+ *
18553
+ * @type {string}
18554
+ * @memberof DataTypesFilterValue
18555
+ */
18556
+ 'highlighted'?: string;
18557
+ /**
18558
+ *
18559
+ * @type {string}
18560
+ * @memberof DataTypesFilterValue
18561
+ */
18562
+ 'value'?: string;
18563
+ }
17840
18564
  /**
17841
18565
  *
17842
18566
  * @export
@@ -17894,6 +18618,137 @@ export interface DataTypesFilteredTabConfig {
17894
18618
  */
17895
18619
  'sort_by'?: string;
17896
18620
  }
18621
+ /**
18622
+ *
18623
+ * @export
18624
+ * @interface DataTypesFiltersRequest
18625
+ */
18626
+ export interface DataTypesFiltersRequest {
18627
+ /**
18628
+ *
18629
+ * @type {Array<string>}
18630
+ * @memberof DataTypesFiltersRequest
18631
+ */
18632
+ 'disjunctive_facets'?: Array<string>;
18633
+ /**
18634
+ *
18635
+ * @type {string}
18636
+ * @memberof DataTypesFiltersRequest
18637
+ */
18638
+ 'facet_by'?: string;
18639
+ /**
18640
+ *
18641
+ * @type {string}
18642
+ * @memberof DataTypesFiltersRequest
18643
+ */
18644
+ 'filter'?: string;
18645
+ /**
18646
+ *
18647
+ * @type {number}
18648
+ * @memberof DataTypesFiltersRequest
18649
+ */
18650
+ 'max_facet_values'?: number;
18651
+ /**
18652
+ *
18653
+ * @type {string}
18654
+ * @memberof DataTypesFiltersRequest
18655
+ */
18656
+ 'q'?: string;
18657
+ }
18658
+ /**
18659
+ *
18660
+ * @export
18661
+ * @interface DataTypesFiltersResponse
18662
+ */
18663
+ export interface DataTypesFiltersResponse {
18664
+ /**
18665
+ *
18666
+ * @type {Array<DataTypesFilterField>}
18667
+ * @memberof DataTypesFiltersResponse
18668
+ */
18669
+ 'filters'?: Array<DataTypesFilterField>;
18670
+ /**
18671
+ *
18672
+ * @type {number}
18673
+ * @memberof DataTypesFiltersResponse
18674
+ */
18675
+ 'total_results'?: number;
18676
+ }
18677
+ /**
18678
+ *
18679
+ * @export
18680
+ * @interface DataTypesFiltersResponseWrapper
18681
+ */
18682
+ export interface DataTypesFiltersResponseWrapper {
18683
+ /**
18684
+ *
18685
+ * @type {DataTypesFiltersResponse}
18686
+ * @memberof DataTypesFiltersResponseWrapper
18687
+ */
18688
+ 'data'?: DataTypesFiltersResponse;
18689
+ /**
18690
+ *
18691
+ * @type {string}
18692
+ * @memberof DataTypesFiltersResponseWrapper
18693
+ */
18694
+ 'message'?: string;
18695
+ /**
18696
+ *
18697
+ * @type {number}
18698
+ * @memberof DataTypesFiltersResponseWrapper
18699
+ */
18700
+ 'status'?: number;
18701
+ }
18702
+ /**
18703
+ *
18704
+ * @export
18705
+ * @interface DataTypesFiltersSchemaResponse
18706
+ */
18707
+ export interface DataTypesFiltersSchemaResponse {
18708
+ /**
18709
+ *
18710
+ * @type {Array<string>}
18711
+ * @memberof DataTypesFiltersSchemaResponse
18712
+ */
18713
+ 'default_facets'?: Array<string>;
18714
+ /**
18715
+ *
18716
+ * @type {Array<DataTypesFilterSchemaField>}
18717
+ * @memberof DataTypesFiltersSchemaResponse
18718
+ */
18719
+ 'fields'?: Array<DataTypesFilterSchemaField>;
18720
+ /**
18721
+ *
18722
+ * @type {number}
18723
+ * @memberof DataTypesFiltersSchemaResponse
18724
+ */
18725
+ 'max_facet_values'?: number;
18726
+ }
18727
+ /**
18728
+ *
18729
+ * @export
18730
+ * @interface DataTypesFiltersSchemaResponseWrapper
18731
+ */
18732
+ export interface DataTypesFiltersSchemaResponseWrapper {
18733
+ /**
18734
+ *
18735
+ * @type {DataTypesFiltersSchemaResponse}
18736
+ * @memberof DataTypesFiltersSchemaResponseWrapper
18737
+ */
18738
+ 'data'?: DataTypesFiltersSchemaResponse;
18739
+ /**
18740
+ *
18741
+ * @type {string}
18742
+ * @memberof DataTypesFiltersSchemaResponseWrapper
18743
+ */
18744
+ 'message'?: string;
18745
+ /**
18746
+ *
18747
+ * @type {number}
18748
+ * @memberof DataTypesFiltersSchemaResponseWrapper
18749
+ */
18750
+ 'status'?: number;
18751
+ }
17897
18752
  /**
17898
18753
  *
17899
18754
  * @export
@@ -18324,6 +19179,56 @@ export interface DataTypesGenericResponseAnalyticsConversionMetrics {
18324
19179
  */
18325
19180
  'status'?: number;
18326
19181
  }
19182
+ /**
19183
+ *
19184
+ * @export
19185
+ * @interface DataTypesGenericResponseAnalyticsCustomEventFieldBreakdown
19186
+ */
19187
+ export interface DataTypesGenericResponseAnalyticsCustomEventFieldBreakdown {
19188
+ /**
19189
+ *
19190
+ * @type {AnalyticsCustomEventFieldBreakdown}
19191
+ * @memberof DataTypesGenericResponseAnalyticsCustomEventFieldBreakdown
19192
+ */
19193
+ 'data'?: AnalyticsCustomEventFieldBreakdown;
19194
+ /**
19195
+ *
19196
+ * @type {string}
19197
+ * @memberof DataTypesGenericResponseAnalyticsCustomEventFieldBreakdown
19198
+ */
19199
+ 'message'?: string;
19200
+ /**
19201
+ *
19202
+ * @type {number}
19203
+ * @memberof DataTypesGenericResponseAnalyticsCustomEventFieldBreakdown
19204
+ */
19205
+ 'status'?: number;
19206
+ }
19207
+ /**
19208
+ *
19209
+ * @export
19210
+ * @interface DataTypesGenericResponseAnalyticsCustomEventMetrics
19211
+ */
19212
+ export interface DataTypesGenericResponseAnalyticsCustomEventMetrics {
19213
+ /**
19214
+ *
19215
+ * @type {AnalyticsCustomEventMetrics}
19216
+ * @memberof DataTypesGenericResponseAnalyticsCustomEventMetrics
19217
+ */
19218
+ 'data'?: AnalyticsCustomEventMetrics;
19219
+ /**
19220
+ *
19221
+ * @type {string}
19222
+ * @memberof DataTypesGenericResponseAnalyticsCustomEventMetrics
19223
+ */
19224
+ 'message'?: string;
19225
+ /**
19226
+ *
19227
+ * @type {number}
19228
+ * @memberof DataTypesGenericResponseAnalyticsCustomEventMetrics
19229
+ */
19230
+ 'status'?: number;
19231
+ }
18327
19232
  /**
18328
19233
  *
18329
19234
  * @export
@@ -18474,6 +19379,31 @@ export interface DataTypesGenericResponseAnalyticsModelComparisonResponse {
18474
19379
  */
18475
19380
  'status'?: number;
18476
19381
  }
19382
+ /**
19383
+ *
19384
+ * @export
19385
+ * @interface DataTypesGenericResponseAnalyticsPaginatedResponseAnalyticsCustomEventRow
19386
+ */
19387
+ export interface DataTypesGenericResponseAnalyticsPaginatedResponseAnalyticsCustomEventRow {
19388
+ /**
19389
+ *
19390
+ * @type {AnalyticsPaginatedResponseAnalyticsCustomEventRow}
19391
+ * @memberof DataTypesGenericResponseAnalyticsPaginatedResponseAnalyticsCustomEventRow
19392
+ */
19393
+ 'data'?: AnalyticsPaginatedResponseAnalyticsCustomEventRow;
19394
+ /**
19395
+ *
19396
+ * @type {string}
19397
+ * @memberof DataTypesGenericResponseAnalyticsPaginatedResponseAnalyticsCustomEventRow
19398
+ */
19399
+ 'message'?: string;
19400
+ /**
19401
+ *
19402
+ * @type {number}
19403
+ * @memberof DataTypesGenericResponseAnalyticsPaginatedResponseAnalyticsCustomEventRow
19404
+ */
19405
+ 'status'?: number;
19406
+ }
18477
19407
  /**
18478
19408
  *
18479
19409
  * @export
@@ -18699,6 +19629,56 @@ export interface DataTypesGenericResponseAny {
18699
19629
  */
18700
19630
  'status'?: number;
18701
19631
  }
19632
+ /**
19633
+ *
19634
+ * @export
19635
+ * @interface DataTypesGenericResponseArrayAnalyticsCustomEventSummary
19636
+ */
19637
+ export interface DataTypesGenericResponseArrayAnalyticsCustomEventSummary {
19638
+ /**
19639
+ *
19640
+ * @type {Array<AnalyticsCustomEventSummary>}
19641
+ * @memberof DataTypesGenericResponseArrayAnalyticsCustomEventSummary
19642
+ */
19643
+ 'data'?: Array<AnalyticsCustomEventSummary>;
19644
+ /**
19645
+ *
19646
+ * @type {string}
19647
+ * @memberof DataTypesGenericResponseArrayAnalyticsCustomEventSummary
19648
+ */
19649
+ 'message'?: string;
19650
+ /**
19651
+ *
19652
+ * @type {number}
19653
+ * @memberof DataTypesGenericResponseArrayAnalyticsCustomEventSummary
19654
+ */
19655
+ 'status'?: number;
19656
+ }
19657
+ /**
19658
+ *
19659
+ * @export
19660
+ * @interface DataTypesGenericResponseArrayAnalyticsCustomEventTimeSeriesPoint
19661
+ */
19662
+ export interface DataTypesGenericResponseArrayAnalyticsCustomEventTimeSeriesPoint {
19663
+ /**
19664
+ *
19665
+ * @type {Array<AnalyticsCustomEventTimeSeriesPoint>}
19666
+ * @memberof DataTypesGenericResponseArrayAnalyticsCustomEventTimeSeriesPoint
19667
+ */
19668
+ 'data'?: Array<AnalyticsCustomEventTimeSeriesPoint>;
19669
+ /**
19670
+ *
19671
+ * @type {string}
19672
+ * @memberof DataTypesGenericResponseArrayAnalyticsCustomEventTimeSeriesPoint
19673
+ */
19674
+ 'message'?: string;
19675
+ /**
19676
+ *
19677
+ * @type {number}
19678
+ * @memberof DataTypesGenericResponseArrayAnalyticsCustomEventTimeSeriesPoint
19679
+ */
19680
+ 'status'?: number;
19681
+ }
18702
19682
  /**
18703
19683
  *
18704
19684
  * @export
@@ -20246,6 +21226,12 @@ export interface DataTypesIndexConfig {
20246
21226
  * @memberof DataTypesIndexConfig
20247
21227
  */
20248
21228
  'enable_smart_autocomplete'?: boolean;
21229
+ /**
21230
+ * Enable stemming on search collections
21231
+ * @type {boolean}
21232
+ * @memberof DataTypesIndexConfig
21233
+ */
21234
+ 'enable_stemming'?: boolean;
20249
21235
  /**
20250
21236
  *
20251
21237
  * @type {boolean}
@@ -20510,6 +21496,12 @@ export interface DataTypesIndexConfig {
20510
21496
  * @memberof DataTypesIndexConfig
20511
21497
  */
20512
21498
  'sort_by'?: Array<DataTypesSortField>;
21499
+ /**
21500
+ * Locale for stemming (e.g., \"en\", \"fr\", \"de\")
21501
+ * @type {string}
21502
+ * @memberof DataTypesIndexConfig
21503
+ */
21504
+ 'stemming_locale'?: string;
20513
21505
  /**
20514
21506
  * Flattened stopwords and synonyms fields
20515
21507
  * @type {Array<DataTypesStopwordEntry>}
@@ -28275,6 +29267,12 @@ export interface DataTypesSchemaBasedDefaults {
28275
29267
  * @memberof DataTypesSchemaBasedDefaults
28276
29268
  */
28277
29269
  'include_fields'?: Array<string>;
29270
+ /**
29271
+ *
29272
+ * @type {Array<string>}
29273
+ * @memberof DataTypesSchemaBasedDefaults
29274
+ */
29275
+ 'numeric_facetable_fields'?: Array<string>;
28278
29276
  /**
28279
29277
  *
28280
29278
  * @type {Array<string>}
@@ -34807,6 +35805,12 @@ export interface ModelsCreateCustomEventFieldRequest {
34807
35805
  * @memberof ModelsCreateCustomEventFieldRequest
34808
35806
  */
34809
35807
  'allowed_values'?: Array<string>;
35808
+ /**
35809
+ * for array type: string, number, boolean, datetime, object, mixed
35810
+ * @type {string}
35811
+ * @memberof ModelsCreateCustomEventFieldRequest
35812
+ */
35813
+ 'array_item_type'?: string;
34810
35814
  /**
34811
35815
  *
34812
35816
  * @type {string}
@@ -34987,12 +35991,66 @@ export interface ModelsMergeProfilesResponse {
34987
35991
  * @interface ModelsNestedPropertyDefinition
34988
35992
  */
34989
35993
  export interface ModelsNestedPropertyDefinition {
35994
+ /**
35995
+ *
35996
+ * @type {Array<any>}
35997
+ * @memberof ModelsNestedPropertyDefinition
35998
+ */
35999
+ 'allowed_values'?: Array<any>;
36000
+ /**
36001
+ * if array_item_type is object
36002
+ * @type {ModelsNestedPropertyDefinition}
36003
+ * @memberof ModelsNestedPropertyDefinition
36004
+ */
36005
+ 'array_item_schema'?: ModelsNestedPropertyDefinition;
36006
+ /**
36007
+ * For array type: define the type of array items
36008
+ * @type {string}
36009
+ * @memberof ModelsNestedPropertyDefinition
36010
+ */
36011
+ 'array_item_type'?: string;
36012
+ /**
36013
+ *
36014
+ * @type {string}
36015
+ * @memberof ModelsNestedPropertyDefinition
36016
+ */
36017
+ 'description'?: string;
36018
+ /**
36019
+ * string max length / array max items
36020
+ * @type {number}
36021
+ * @memberof ModelsNestedPropertyDefinition
36022
+ */
36023
+ 'max_length'?: number;
36024
+ /**
36025
+ *
36026
+ * @type {number}
36027
+ * @memberof ModelsNestedPropertyDefinition
36028
+ */
36029
+ 'max_value'?: number;
36030
+ /**
36031
+ * string min length / array min items
36032
+ * @type {number}
36033
+ * @memberof ModelsNestedPropertyDefinition
36034
+ */
36035
+ 'min_length'?: number;
36036
+ /**
36037
+ *
36038
+ * @type {number}
36039
+ * @memberof ModelsNestedPropertyDefinition
36040
+ */
36041
+ 'min_value'?: number;
34990
36042
  /**
34991
36043
  *
34992
36044
  * @type {string}
34993
36045
  * @memberof ModelsNestedPropertyDefinition
34994
36046
  */
34995
36047
  'name'?: string;
36048
+ /**
36049
+ * For object type: nested properties (recursive)
36050
+ * @type {Array<ModelsNestedPropertyDefinition>}
36051
+ * @memberof ModelsNestedPropertyDefinition
36052
+ */
36053
+ 'properties'?: Array<ModelsNestedPropertyDefinition>;
34996
36054
  /**
34997
36055
  *
34998
36056
  * @type {boolean}
@@ -35005,6 +36063,12 @@ export interface ModelsNestedPropertyDefinition {
35005
36063
  * @memberof ModelsNestedPropertyDefinition
35006
36064
  */
35007
36065
  'type'?: string;
36066
+ /**
36067
+ * Validation for string/number/array types
36068
+ * @type {string}
36069
+ * @memberof ModelsNestedPropertyDefinition
36070
+ */
36071
+ 'validation_regex'?: string;
35008
36072
  }
35009
36073
  /**
35010
36074
  *
@@ -35158,6 +36222,12 @@ export interface ModelsUpdateCustomEventFieldRequest {
35158
36222
  * @memberof ModelsUpdateCustomEventFieldRequest
35159
36223
  */
35160
36224
  'allowed_values'?: Array<string>;
36225
+ /**
36226
+ * for array type: string, number, boolean, datetime, object, mixed
36227
+ * @type {string}
36228
+ * @memberof ModelsUpdateCustomEventFieldRequest
36229
+ */
36230
+ 'array_item_type'?: string;
35161
36231
  /**
35162
36232
  *
35163
36233
  * @type {string}
@@ -36477,6 +37547,12 @@ export interface QuerySuggestionsServiceQuerySuggestionConfig {
36477
37547
  * @memberof QuerySuggestionsServiceQuerySuggestionConfig
36478
37548
  */
36479
37549
  'enable_rules'?: boolean;
37550
+ /**
37551
+ * Stemming configuration
37552
+ * @type {boolean}
37553
+ * @memberof QuerySuggestionsServiceQuerySuggestionConfig
37554
+ */
37555
+ 'enable_stemming'?: boolean;
36480
37556
  /**
36481
37557
  * Whether query suggestions are enabled for the store
36482
37558
  * @type {boolean}
@@ -36549,6 +37625,12 @@ export interface QuerySuggestionsServiceQuerySuggestionConfig {
36549
37625
  * @memberof QuerySuggestionsServiceQuerySuggestionConfig
36550
37626
  */
36551
37627
  'special_chars'?: boolean;
37628
+ /**
37629
+ * Locale for stemming (derived from Languages[0], fallback \"en\")
37630
+ * @type {string}
37631
+ * @memberof QuerySuggestionsServiceQuerySuggestionConfig
37632
+ */
37633
+ 'stemming_locale'?: string;
36552
37634
  /**
36553
37635
  * Whether to sync enabled suggestions to Typesense
36554
37636
  * @type {boolean}
@@ -37513,6 +38595,12 @@ export interface QuerySuggestionsServiceUpdateSuggestionConfigRequest {
37513
38595
  * @memberof QuerySuggestionsServiceUpdateSuggestionConfigRequest
37514
38596
  */
37515
38597
  'enable_rules'?: boolean;
38598
+ /**
38599
+ * Enable stemming on query suggestions collection
38600
+ * @type {boolean}
38601
+ * @memberof QuerySuggestionsServiceUpdateSuggestionConfigRequest
38602
+ */
38603
+ 'enable_stemming'?: boolean;
37516
38604
  /**
37517
38605
  * Enable/disable query suggestions for the store
37518
38606
  * @type {boolean}
@@ -37567,6 +38655,12 @@ export interface QuerySuggestionsServiceUpdateSuggestionConfigRequest {
37567
38655
  * @memberof QuerySuggestionsServiceUpdateSuggestionConfigRequest
37568
38656
  */
37569
38657
  'special_chars'?: boolean;
38658
+ /**
38659
+ * Locale for stemming
38660
+ * @type {string}
38661
+ * @memberof QuerySuggestionsServiceUpdateSuggestionConfigRequest
38662
+ */
38663
+ 'stemming_locale'?: string;
37570
38664
  /**
37571
38665
  * Enable/disable syncing suggestions to Typesense
37572
38666
  * @type {boolean}
@@ -49750,6 +50844,237 @@ export declare class CustomEventsApi extends BaseAPI {
49750
50844
  [key: string]: any;
49751
50845
  }, any, {}>>;
49752
50846
  }
50847
+ /**
50848
+ * CustomEventsAnalyticsApi - axios parameter creator
50849
+ * @export
50850
+ */
50851
+ export declare const CustomEventsAnalyticsApiAxiosParamCreator: (configuration?: Configuration) => {
50852
+ /**
50853
+ * Returns a breakdown of values for a specific field slot of a custom event
50854
+ * @summary Get Custom Event Field Breakdown
50855
+ * @param {string} xStoreID Store ID
50856
+ * @param {string} authorization Bearer JWT token
50857
+ * @param {AnalyticsCustomEventFieldBreakdownRequestBody} analyticsCustomEventFieldBreakdownRequestBody Field breakdown request
50858
+ * @param {*} [options] Override http request option.
50859
+ * @throws {RequiredError}
50860
+ */
50861
+ adminAnalyticsStoreXStoreIDCustomEventsAnalyticsFieldBreakdownPost: (xStoreID: string, authorization: string, analyticsCustomEventFieldBreakdownRequestBody: AnalyticsCustomEventFieldBreakdownRequestBody, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
50862
+ /**
50863
+ * Returns aggregated custom event metrics including total events, unique users, unique sessions, and unique event types
50864
+ * @summary Get Custom Event Metrics
50865
+ * @param {string} xStoreID Store ID
50866
+ * @param {string} authorization Bearer JWT token
50867
+ * @param {AnalyticsCustomEventMetricsRequestBody} analyticsCustomEventMetricsRequestBody Custom event metrics request
50868
+ * @param {*} [options] Override http request option.
50869
+ * @throws {RequiredError}
50870
+ */
50871
+ adminAnalyticsStoreXStoreIDCustomEventsAnalyticsMetricsPost: (xStoreID: string, authorization: string, analyticsCustomEventMetricsRequestBody: AnalyticsCustomEventMetricsRequestBody, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
50872
+ /**
50873
+ * Returns paginated raw custom events with field data
50874
+ * @summary Get Custom Event Stream
50875
+ * @param {string} xStoreID Store ID
50876
+ * @param {string} authorization Bearer JWT token
50877
+ * @param {AnalyticsCustomEventStreamRequestBody} analyticsCustomEventStreamRequestBody Event stream request
50878
+ * @param {*} [options] Override http request option.
50879
+ * @throws {RequiredError}
50880
+ */
50881
+ adminAnalyticsStoreXStoreIDCustomEventsAnalyticsStreamPost: (xStoreID: string, authorization: string, analyticsCustomEventStreamRequestBody: AnalyticsCustomEventStreamRequestBody, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
50882
+ /**
50883
+ * Returns time series data for custom events grouped by event name and time bucket
50884
+ * @summary Get Custom Event Time Series
50885
+ * @param {string} xStoreID Store ID
50886
+ * @param {string} authorization Bearer JWT token
50887
+ * @param {AnalyticsCustomEventTimeSeriesRequestBody} analyticsCustomEventTimeSeriesRequestBody Time series request
50888
+ * @param {*} [options] Override http request option.
50889
+ * @throws {RequiredError}
50890
+ */
50891
+ adminAnalyticsStoreXStoreIDCustomEventsAnalyticsTimeSeriesPost: (xStoreID: string, authorization: string, analyticsCustomEventTimeSeriesRequestBody: AnalyticsCustomEventTimeSeriesRequestBody, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
50892
+ /**
50893
+ * Returns the top custom events by count or unique users
50894
+ * @summary Get Top Custom Events
50895
+ * @param {string} xStoreID Store ID
50896
+ * @param {string} authorization Bearer JWT token
50897
+ * @param {AnalyticsTopCustomEventsRequestBody} analyticsTopCustomEventsRequestBody Top events request
50898
+ * @param {*} [options] Override http request option.
50899
+ * @throws {RequiredError}
50900
+ */
50901
+ adminAnalyticsStoreXStoreIDCustomEventsAnalyticsTopEventsPost: (xStoreID: string, authorization: string, analyticsTopCustomEventsRequestBody: AnalyticsTopCustomEventsRequestBody, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
50902
+ };
50903
+ /**
50904
+ * CustomEventsAnalyticsApi - functional programming interface
50905
+ * @export
50906
+ */
50907
+ export declare const CustomEventsAnalyticsApiFp: (configuration?: Configuration) => {
50908
+ /**
50909
+ * Returns a breakdown of values for a specific field slot of a custom event
50910
+ * @summary Get Custom Event Field Breakdown
50911
+ * @param {string} xStoreID Store ID
50912
+ * @param {string} authorization Bearer JWT token
50913
+ * @param {AnalyticsCustomEventFieldBreakdownRequestBody} analyticsCustomEventFieldBreakdownRequestBody Field breakdown request
50914
+ * @param {*} [options] Override http request option.
50915
+ * @throws {RequiredError}
50916
+ */
50917
+ adminAnalyticsStoreXStoreIDCustomEventsAnalyticsFieldBreakdownPost(xStoreID: string, authorization: string, analyticsCustomEventFieldBreakdownRequestBody: AnalyticsCustomEventFieldBreakdownRequestBody, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesGenericResponseAnalyticsCustomEventFieldBreakdown>>;
50918
+ /**
50919
+ * Returns aggregated custom event metrics including total events, unique users, unique sessions, and unique event types
50920
+ * @summary Get Custom Event Metrics
50921
+ * @param {string} xStoreID Store ID
50922
+ * @param {string} authorization Bearer JWT token
50923
+ * @param {AnalyticsCustomEventMetricsRequestBody} analyticsCustomEventMetricsRequestBody Custom event metrics request
50924
+ * @param {*} [options] Override http request option.
50925
+ * @throws {RequiredError}
50926
+ */
50927
+ adminAnalyticsStoreXStoreIDCustomEventsAnalyticsMetricsPost(xStoreID: string, authorization: string, analyticsCustomEventMetricsRequestBody: AnalyticsCustomEventMetricsRequestBody, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesGenericResponseAnalyticsCustomEventMetrics>>;
50928
+ /**
50929
+ * Returns paginated raw custom events with field data
50930
+ * @summary Get Custom Event Stream
50931
+ * @param {string} xStoreID Store ID
50932
+ * @param {string} authorization Bearer JWT token
50933
+ * @param {AnalyticsCustomEventStreamRequestBody} analyticsCustomEventStreamRequestBody Event stream request
50934
+ * @param {*} [options] Override http request option.
50935
+ * @throws {RequiredError}
50936
+ */
50937
+ adminAnalyticsStoreXStoreIDCustomEventsAnalyticsStreamPost(xStoreID: string, authorization: string, analyticsCustomEventStreamRequestBody: AnalyticsCustomEventStreamRequestBody, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesGenericResponseAnalyticsPaginatedResponseAnalyticsCustomEventRow>>;
50938
+ /**
50939
+ * Returns time series data for custom events grouped by event name and time bucket
50940
+ * @summary Get Custom Event Time Series
50941
+ * @param {string} xStoreID Store ID
50942
+ * @param {string} authorization Bearer JWT token
50943
+ * @param {AnalyticsCustomEventTimeSeriesRequestBody} analyticsCustomEventTimeSeriesRequestBody Time series request
50944
+ * @param {*} [options] Override http request option.
50945
+ * @throws {RequiredError}
50946
+ */
50947
+ adminAnalyticsStoreXStoreIDCustomEventsAnalyticsTimeSeriesPost(xStoreID: string, authorization: string, analyticsCustomEventTimeSeriesRequestBody: AnalyticsCustomEventTimeSeriesRequestBody, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesGenericResponseArrayAnalyticsCustomEventTimeSeriesPoint>>;
50948
+ /**
50949
+ * Returns the top custom events by count or unique users
50950
+ * @summary Get Top Custom Events
50951
+ * @param {string} xStoreID Store ID
50952
+ * @param {string} authorization Bearer JWT token
50953
+ * @param {AnalyticsTopCustomEventsRequestBody} analyticsTopCustomEventsRequestBody Top events request
50954
+ * @param {*} [options] Override http request option.
50955
+ * @throws {RequiredError}
50956
+ */
50957
+ adminAnalyticsStoreXStoreIDCustomEventsAnalyticsTopEventsPost(xStoreID: string, authorization: string, analyticsTopCustomEventsRequestBody: AnalyticsTopCustomEventsRequestBody, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesGenericResponseArrayAnalyticsCustomEventSummary>>;
50958
+ };
50959
+ /**
50960
+ * CustomEventsAnalyticsApi - factory interface
50961
+ * @export
50962
+ */
50963
+ export declare const CustomEventsAnalyticsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
50964
+ /**
50965
+ * Returns a breakdown of values for a specific field slot of a custom event
50966
+ * @summary Get Custom Event Field Breakdown
50967
+ * @param {string} xStoreID Store ID
50968
+ * @param {string} authorization Bearer JWT token
50969
+ * @param {AnalyticsCustomEventFieldBreakdownRequestBody} analyticsCustomEventFieldBreakdownRequestBody Field breakdown request
50970
+ * @param {*} [options] Override http request option.
50971
+ * @throws {RequiredError}
50972
+ */
50973
+ adminAnalyticsStoreXStoreIDCustomEventsAnalyticsFieldBreakdownPost(xStoreID: string, authorization: string, analyticsCustomEventFieldBreakdownRequestBody: AnalyticsCustomEventFieldBreakdownRequestBody, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesGenericResponseAnalyticsCustomEventFieldBreakdown>;
50974
+ /**
50975
+ * Returns aggregated custom event metrics including total events, unique users, unique sessions, and unique event types
50976
+ * @summary Get Custom Event Metrics
50977
+ * @param {string} xStoreID Store ID
50978
+ * @param {string} authorization Bearer JWT token
50979
+ * @param {AnalyticsCustomEventMetricsRequestBody} analyticsCustomEventMetricsRequestBody Custom event metrics request
50980
+ * @param {*} [options] Override http request option.
50981
+ * @throws {RequiredError}
50982
+ */
50983
+ adminAnalyticsStoreXStoreIDCustomEventsAnalyticsMetricsPost(xStoreID: string, authorization: string, analyticsCustomEventMetricsRequestBody: AnalyticsCustomEventMetricsRequestBody, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesGenericResponseAnalyticsCustomEventMetrics>;
50984
+ /**
50985
+ * Returns paginated raw custom events with field data
50986
+ * @summary Get Custom Event Stream
50987
+ * @param {string} xStoreID Store ID
50988
+ * @param {string} authorization Bearer JWT token
50989
+ * @param {AnalyticsCustomEventStreamRequestBody} analyticsCustomEventStreamRequestBody Event stream request
50990
+ * @param {*} [options] Override http request option.
50991
+ * @throws {RequiredError}
50992
+ */
50993
+ adminAnalyticsStoreXStoreIDCustomEventsAnalyticsStreamPost(xStoreID: string, authorization: string, analyticsCustomEventStreamRequestBody: AnalyticsCustomEventStreamRequestBody, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesGenericResponseAnalyticsPaginatedResponseAnalyticsCustomEventRow>;
50994
+ /**
50995
+ * Returns time series data for custom events grouped by event name and time bucket
50996
+ * @summary Get Custom Event Time Series
50997
+ * @param {string} xStoreID Store ID
50998
+ * @param {string} authorization Bearer JWT token
50999
+ * @param {AnalyticsCustomEventTimeSeriesRequestBody} analyticsCustomEventTimeSeriesRequestBody Time series request
51000
+ * @param {*} [options] Override http request option.
51001
+ * @throws {RequiredError}
51002
+ */
51003
+ adminAnalyticsStoreXStoreIDCustomEventsAnalyticsTimeSeriesPost(xStoreID: string, authorization: string, analyticsCustomEventTimeSeriesRequestBody: AnalyticsCustomEventTimeSeriesRequestBody, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesGenericResponseArrayAnalyticsCustomEventTimeSeriesPoint>;
51004
+ /**
51005
+ * Returns the top custom events by count or unique users
51006
+ * @summary Get Top Custom Events
51007
+ * @param {string} xStoreID Store ID
51008
+ * @param {string} authorization Bearer JWT token
51009
+ * @param {AnalyticsTopCustomEventsRequestBody} analyticsTopCustomEventsRequestBody Top events request
51010
+ * @param {*} [options] Override http request option.
51011
+ * @throws {RequiredError}
51012
+ */
51013
+ adminAnalyticsStoreXStoreIDCustomEventsAnalyticsTopEventsPost(xStoreID: string, authorization: string, analyticsTopCustomEventsRequestBody: AnalyticsTopCustomEventsRequestBody, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesGenericResponseArrayAnalyticsCustomEventSummary>;
51014
+ };
51015
+ /**
51016
+ * CustomEventsAnalyticsApi - object-oriented interface
51017
+ * @export
51018
+ * @class CustomEventsAnalyticsApi
51019
+ * @extends {BaseAPI}
51020
+ */
51021
+ export declare class CustomEventsAnalyticsApi extends BaseAPI {
51022
+ /**
51023
+ * Returns a breakdown of values for a specific field slot of a custom event
51024
+ * @summary Get Custom Event Field Breakdown
51025
+ * @param {string} xStoreID Store ID
51026
+ * @param {string} authorization Bearer JWT token
51027
+ * @param {AnalyticsCustomEventFieldBreakdownRequestBody} analyticsCustomEventFieldBreakdownRequestBody Field breakdown request
51028
+ * @param {*} [options] Override http request option.
51029
+ * @throws {RequiredError}
51030
+ * @memberof CustomEventsAnalyticsApi
51031
+ */
51032
+ adminAnalyticsStoreXStoreIDCustomEventsAnalyticsFieldBreakdownPost(xStoreID: string, authorization: string, analyticsCustomEventFieldBreakdownRequestBody: AnalyticsCustomEventFieldBreakdownRequestBody, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesGenericResponseAnalyticsCustomEventFieldBreakdown, any, {}>>;
51033
+ /**
51034
+ * Returns aggregated custom event metrics including total events, unique users, unique sessions, and unique event types
51035
+ * @summary Get Custom Event Metrics
51036
+ * @param {string} xStoreID Store ID
51037
+ * @param {string} authorization Bearer JWT token
51038
+ * @param {AnalyticsCustomEventMetricsRequestBody} analyticsCustomEventMetricsRequestBody Custom event metrics request
51039
+ * @param {*} [options] Override http request option.
51040
+ * @throws {RequiredError}
51041
+ * @memberof CustomEventsAnalyticsApi
51042
+ */
51043
+ adminAnalyticsStoreXStoreIDCustomEventsAnalyticsMetricsPost(xStoreID: string, authorization: string, analyticsCustomEventMetricsRequestBody: AnalyticsCustomEventMetricsRequestBody, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesGenericResponseAnalyticsCustomEventMetrics, any, {}>>;
51044
+ /**
51045
+ * Returns paginated raw custom events with field data
51046
+ * @summary Get Custom Event Stream
51047
+ * @param {string} xStoreID Store ID
51048
+ * @param {string} authorization Bearer JWT token
51049
+ * @param {AnalyticsCustomEventStreamRequestBody} analyticsCustomEventStreamRequestBody Event stream request
51050
+ * @param {*} [options] Override http request option.
51051
+ * @throws {RequiredError}
51052
+ * @memberof CustomEventsAnalyticsApi
51053
+ */
51054
+ adminAnalyticsStoreXStoreIDCustomEventsAnalyticsStreamPost(xStoreID: string, authorization: string, analyticsCustomEventStreamRequestBody: AnalyticsCustomEventStreamRequestBody, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesGenericResponseAnalyticsPaginatedResponseAnalyticsCustomEventRow, any, {}>>;
51055
+ /**
51056
+ * Returns time series data for custom events grouped by event name and time bucket
51057
+ * @summary Get Custom Event Time Series
51058
+ * @param {string} xStoreID Store ID
51059
+ * @param {string} authorization Bearer JWT token
51060
+ * @param {AnalyticsCustomEventTimeSeriesRequestBody} analyticsCustomEventTimeSeriesRequestBody Time series request
51061
+ * @param {*} [options] Override http request option.
51062
+ * @throws {RequiredError}
51063
+ * @memberof CustomEventsAnalyticsApi
51064
+ */
51065
+ adminAnalyticsStoreXStoreIDCustomEventsAnalyticsTimeSeriesPost(xStoreID: string, authorization: string, analyticsCustomEventTimeSeriesRequestBody: AnalyticsCustomEventTimeSeriesRequestBody, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesGenericResponseArrayAnalyticsCustomEventTimeSeriesPoint, any, {}>>;
51066
+ /**
51067
+ * Returns the top custom events by count or unique users
51068
+ * @summary Get Top Custom Events
51069
+ * @param {string} xStoreID Store ID
51070
+ * @param {string} authorization Bearer JWT token
51071
+ * @param {AnalyticsTopCustomEventsRequestBody} analyticsTopCustomEventsRequestBody Top events request
51072
+ * @param {*} [options] Override http request option.
51073
+ * @throws {RequiredError}
51074
+ * @memberof CustomEventsAnalyticsApi
51075
+ */
51076
+ adminAnalyticsStoreXStoreIDCustomEventsAnalyticsTopEventsPost(xStoreID: string, authorization: string, analyticsTopCustomEventsRequestBody: AnalyticsTopCustomEventsRequestBody, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesGenericResponseArrayAnalyticsCustomEventSummary, any, {}>>;
51077
+ }
49753
51078
  /**
49754
51079
  * CustomStopwordsApi - axios parameter creator
49755
51080
  * @export
@@ -51212,16 +52537,6 @@ export declare const ExperimentsApiAxiosParamCreator: (configuration?: Configura
51212
52537
  * @throws {RequiredError}
51213
52538
  */
51214
52539
  v1AdminExperimentsPost: (dataTypesCreateExperimentRequest: DataTypesCreateExperimentRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
51215
- /**
51216
- * Returns variant assignments for all running experiments for the requesting user. Uses hash-based consistent assignment.
51217
- * @summary Get experiment assignments for a user
51218
- * @param {string} xStoreid Store ID
51219
- * @param {string} [xUserId] User ID (provide either x-user-id or x-anon-id)
51220
- * @param {string} [xAnonId] Anonymous ID (provide either x-user-id or x-anon-id)
51221
- * @param {*} [options] Override http request option.
51222
- * @throws {RequiredError}
51223
- */
51224
- v1ExperimentsAssignmentGet: (xStoreid: string, xUserId?: string, xAnonId?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
51225
52540
  };
51226
52541
  /**
51227
52542
  * ExperimentsApi - functional programming interface
@@ -51303,18 +52618,6 @@ export declare const ExperimentsApiFp: (configuration?: Configuration) => {
51303
52618
  * @throws {RequiredError}
51304
52619
  */
51305
52620
  v1AdminExperimentsPost(dataTypesCreateExperimentRequest: DataTypesCreateExperimentRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesExperiment>>;
51306
- /**
51307
- * Returns variant assignments for all running experiments for the requesting user. Uses hash-based consistent assignment.
51308
- * @summary Get experiment assignments for a user
51309
- * @param {string} xStoreid Store ID
51310
- * @param {string} [xUserId] User ID (provide either x-user-id or x-anon-id)
51311
- * @param {string} [xAnonId] Anonymous ID (provide either x-user-id or x-anon-id)
51312
- * @param {*} [options] Override http request option.
51313
- * @throws {RequiredError}
51314
- */
51315
- v1ExperimentsAssignmentGet(xStoreid: string, xUserId?: string, xAnonId?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<{
51316
- [key: string]: Array<DataTypesExperimentAssignment>;
51317
- }>>;
51318
52621
  };
51319
52622
  /**
51320
52623
  * ExperimentsApi - factory interface
@@ -51396,18 +52699,6 @@ export declare const ExperimentsApiFactory: (configuration?: Configuration, base
51396
52699
  * @throws {RequiredError}
51397
52700
  */
51398
52701
  v1AdminExperimentsPost(dataTypesCreateExperimentRequest: DataTypesCreateExperimentRequest, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesExperiment>;
51399
- /**
51400
- * Returns variant assignments for all running experiments for the requesting user. Uses hash-based consistent assignment.
51401
- * @summary Get experiment assignments for a user
51402
- * @param {string} xStoreid Store ID
51403
- * @param {string} [xUserId] User ID (provide either x-user-id or x-anon-id)
51404
- * @param {string} [xAnonId] Anonymous ID (provide either x-user-id or x-anon-id)
51405
- * @param {*} [options] Override http request option.
51406
- * @throws {RequiredError}
51407
- */
51408
- v1ExperimentsAssignmentGet(xStoreid: string, xUserId?: string, xAnonId?: string, options?: RawAxiosRequestConfig): AxiosPromise<{
51409
- [key: string]: Array<DataTypesExperimentAssignment>;
51410
- }>;
51411
52702
  };
51412
52703
  /**
51413
52704
  * ExperimentsApi - object-oriented interface
@@ -51500,19 +52791,6 @@ export declare class ExperimentsApi extends BaseAPI {
51500
52791
  * @memberof ExperimentsApi
51501
52792
  */
51502
52793
  v1AdminExperimentsPost(dataTypesCreateExperimentRequest: DataTypesCreateExperimentRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesExperiment, any, {}>>;
51503
- /**
51504
- * Returns variant assignments for all running experiments for the requesting user. Uses hash-based consistent assignment.
51505
- * @summary Get experiment assignments for a user
51506
- * @param {string} xStoreid Store ID
51507
- * @param {string} [xUserId] User ID (provide either x-user-id or x-anon-id)
51508
- * @param {string} [xAnonId] Anonymous ID (provide either x-user-id or x-anon-id)
51509
- * @param {*} [options] Override http request option.
51510
- * @throws {RequiredError}
51511
- * @memberof ExperimentsApi
51512
- */
51513
- v1ExperimentsAssignmentGet(xStoreid: string, xUserId?: string, xAnonId?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<{
51514
- [key: string]: DataTypesExperimentAssignment[];
51515
- }, any, {}>>;
51516
52794
  }
51517
52795
  /**
51518
52796
  * ExternalAPINotificationsApi - axios parameter creator
@@ -52022,177 +53300,270 @@ export declare class FeatureLimitsAdminApi extends BaseAPI {
52022
53300
  adminV1FeatureLimitsResetPost(featureName: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesResponse, any, {}>>;
52023
53301
  }
52024
53302
  /**
52025
- * ItemAnalyticsApi - axios parameter creator
53303
+ * FiltersApi - axios parameter creator
52026
53304
  * @export
52027
53305
  */
52028
- export declare const ItemAnalyticsApiAxiosParamCreator: (configuration?: Configuration) => {
53306
+ export declare const FiltersApiAxiosParamCreator: (configuration?: Configuration) => {
52029
53307
  /**
52030
- * Compare performance metrics between multiple items to identify top and underperforming products
52031
- * @summary Get Item Comparison Analytics
52032
- * @param {string} xStoreID Store ID
52033
- * @param {string} itemIds Comma-separated list of item IDs to compare (minimum 2)
52034
- * @param {string} [startTime] Start time in RFC3339 format
52035
- * @param {string} [endTime] End time in RFC3339 format
53308
+ * Search within a facet\'s values (admin-authenticated version)
53309
+ * @summary Admin Search Facet Values
53310
+ * @param {string} xStoreID X-Store ID
53311
+ * @param {string} facetName Facet field name
53312
+ * @param {DataTypesFacetValuesSearchRequest} dataTypesFacetValuesSearchRequest Facet search query
52036
53313
  * @param {*} [options] Override http request option.
52037
53314
  * @throws {RequiredError}
52038
53315
  */
52039
- adminAnalyticsStoreXStoreIDItemsComparisonGet: (xStoreID: string, itemIds: string, startTime?: string, endTime?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
53316
+ adminV1FiltersXStoreIDFacetNameValuesPost: (xStoreID: string, facetName: string, dataTypesFacetValuesSearchRequest: DataTypesFacetValuesSearchRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
52040
53317
  /**
52041
- * Analyze how items are discovered through search queries, filters, and sorts with position distribution data
52042
- * @summary Get Item Discovery Analytics
52043
- * @param {string} xStoreID Store ID
52044
- * @param {string} [startTime] Start time in RFC3339 format
52045
- * @param {string} [endTime] End time in RFC3339 format
52046
- * @param {string} [itemIds] Comma-separated list of item IDs to filter
52047
- * @param {string} [queries] Comma-separated list of queries to filter
52048
- * @param {number} [itemLimit] Maximum number of items to return
52049
- * @param {number} [minImpressions] Minimum number of impressions required
52050
- * @param {number} [limit] Maximum number of results (legacy - use page_size instead)
52051
- * @param {number} [offset] Offset for pagination (legacy - use page instead)
52052
- * @param {number} [page] Page number for pagination
52053
- * @param {number} [pageSize] Number of results per page
52054
- * @param {AdminAnalyticsStoreXStoreIDItemsDiscoveryGetSortByEnum} [sortBy] Field to sort by
52055
- * @param {AdminAnalyticsStoreXStoreIDItemsDiscoveryGetSortOrderEnum} [sortOrder] Sort direction
52056
- * @param {string} [sort] Combined sort parameter in format \&#39;field:direction\&#39;
53318
+ * Get filter values and counts (admin-authenticated version)
53319
+ * @summary Admin Get Filters
53320
+ * @param {string} xStoreID X-Store ID
53321
+ * @param {DataTypesFiltersRequest} [dataTypesFiltersRequest] Filter options
52057
53322
  * @param {*} [options] Override http request option.
52058
53323
  * @throws {RequiredError}
52059
53324
  */
52060
- adminAnalyticsStoreXStoreIDItemsDiscoveryGet: (xStoreID: string, startTime?: string, endTime?: string, itemIds?: string, queries?: string, itemLimit?: number, minImpressions?: number, limit?: number, offset?: number, page?: number, pageSize?: number, sortBy?: AdminAnalyticsStoreXStoreIDItemsDiscoveryGetSortByEnum, sortOrder?: AdminAnalyticsStoreXStoreIDItemsDiscoveryGetSortOrderEnum, sort?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
53325
+ adminV1FiltersXStoreIDPost: (xStoreID: string, dataTypesFiltersRequest?: DataTypesFiltersRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
52061
53326
  /**
52062
- * Retrieve general item performance analytics including impressions, clicks, conversions, and revenue metrics
52063
- * @summary Get Item Analytics
52064
- * @param {string} xStoreID Store ID
52065
- * @param {string} [startTime] Start time in RFC3339 format
52066
- * @param {string} [endTime] End time in RFC3339 format
52067
- * @param {string} [search] Search term to filter items (case-insensitive partial match on item IDs and related data)
52068
- * @param {string} [itemIds] Comma-separated list of item IDs to filter
52069
- * @param {number} [itemLimit] Maximum number of items to return
52070
- * @param {number} [minImpressions] Minimum number of impressions required
52071
- * @param {number} [maxPosition] Maximum position to include
52072
- * @param {AdminAnalyticsStoreXStoreIDItemsGetSortByEnum} [sortBy] Field to sort by
52073
- * @param {AdminAnalyticsStoreXStoreIDItemsGetSortOrderEnum} [sortOrder] Sort direction
52074
- * @param {string} [sort] Combined sort parameter in format \&#39;field:direction\&#39;
52075
- * @param {number} [limit] Maximum number of results (legacy - use page_size instead)
52076
- * @param {number} [offset] Offset for pagination (legacy - use page instead)
52077
- * @param {number} [page] Page number for pagination
52078
- * @param {number} [pageSize] Number of results per page
53327
+ * Get filter field metadata (admin-authenticated version)
53328
+ * @summary Admin Get Filters Schema
53329
+ * @param {string} xStoreID X-Store ID
52079
53330
  * @param {*} [options] Override http request option.
52080
53331
  * @throws {RequiredError}
52081
53332
  */
52082
- adminAnalyticsStoreXStoreIDItemsGet: (xStoreID: string, startTime?: string, endTime?: string, search?: string, itemIds?: string, itemLimit?: number, minImpressions?: number, maxPosition?: number, sortBy?: AdminAnalyticsStoreXStoreIDItemsGetSortByEnum, sortOrder?: AdminAnalyticsStoreXStoreIDItemsGetSortOrderEnum, sort?: string, limit?: number, offset?: number, page?: number, pageSize?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
53333
+ adminV1FiltersXStoreIDSchemaGet: (xStoreID: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
52083
53334
  /**
52084
- * Retrieve detailed analytics for a specific item including performance metrics and discovery data
52085
- * @summary Get Item Details
52086
- * @param {string} xStoreID Store ID
52087
- * @param {string} itemId Item ID
52088
- * @param {string} [startTime] Start time in RFC3339 format
52089
- * @param {string} [endTime] End time in RFC3339 format
53335
+ * Search or autocomplete within a single facet\'s values. Useful for facets with many values (e.g., brands) where you need typeahead search.
53336
+ * @summary Search Facet Values
53337
+ * @param {string} xStoreid Store ID (from dashboard)
53338
+ * @param {string} xStoresecret Store read secret (from dashboard)
53339
+ * @param {string} facetName Facet field name (e.g., brand, category)
53340
+ * @param {DataTypesFacetValuesSearchRequest} dataTypesFacetValuesSearchRequest Facet search query
52090
53341
  * @param {*} [options] Override http request option.
52091
53342
  * @throws {RequiredError}
52092
53343
  */
52093
- adminAnalyticsStoreXStoreIDItemsItemIdGet: (xStoreID: string, itemId: string, startTime?: string, endTime?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
53344
+ v1FiltersFacetNameValuesPost: (xStoreid: string, xStoresecret: string, facetName: string, dataTypesFacetValuesSearchRequest: DataTypesFacetValuesSearchRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
52094
53345
  /**
52095
- * Retrieve comprehensive analytics insights for a specific item including all core metrics (Total Searches, Results Shown, Impressions, Clicks, Conversions, Revenue, CTR, CVR, Conversion Rate per Search, No-Click Rate, Avg Result Rank, Avg Click Position), popular queries, filters, position distribution, geo analytics, and performance metrics with pagination support for subsections and optional comparison mode
52096
- * @summary Get Item Insights
52097
- * @param {string} xStoreID Store ID
52098
- * @param {string} itemId Item ID to analyze
52099
- * @param {string} [startTime] Start time in RFC3339 format
52100
- * @param {string} [endTime] End time in RFC3339 format
52101
- * @param {string} [analyticsTags] Comma-separated analytics tags to filter (e.g., \&#39;campaign:summer,source:email\&#39;)
52102
- * @param {AdminAnalyticsStoreXStoreIDItemsItemIdInsightsGetTagsMatchModeEnum} [tagsMatchMode] How to match multiple analytics tags
52103
- * @param {string} [tagsExclude] Comma-separated analytics tags to exclude
52104
- * @param {string} [tagKeyFilter] Filter by tag key pattern (matches tags starting with key:)
52105
- * @param {string} [tagValueFilter] Filter by tag value pattern (matches tags ending with :value)
52106
- * @param {boolean} [compareMode] Enable comparison mode to compare with another time period/tag set
52107
- * @param {string} [compareStartTime] Comparison period start time in RFC3339 format
52108
- * @param {string} [compareEndTime] Comparison period end time in RFC3339 format
52109
- * @param {string} [compareAnalyticsTags] Comma-separated analytics tags for comparison period
52110
- * @param {AdminAnalyticsStoreXStoreIDItemsItemIdInsightsGetCompareTagsMatchModeEnum} [compareTagsMatchMode] How to match comparison analytics tags
52111
- * @param {string} [compareTagsExclude] Comma-separated analytics tags to exclude in comparison
52112
- * @param {string} [compareTagKeyFilter] Tag key filter for comparison period
52113
- * @param {string} [compareTagValueFilter] Tag value filter for comparison period
52114
- * @param {number} [resultsPage] Page number for popular queries pagination
52115
- * @param {number} [resultsPageSize] Number of queries per page for popular queries
52116
- * @param {string} [itemQueriesSearch] Search term to filter popular queries (case-insensitive partial match on query text)
52117
- * @param {number} [filtersPage] Page number for popular filters pagination
52118
- * @param {number} [filtersPageSize] Number of filters per page
52119
- * @param {string} [itemFiltersSearch] Search term to filter popular filters (case-insensitive partial match on filter keys/values)
52120
- * @param {number} [geoPage] Page number for geo analytics pagination
52121
- * @param {number} [geoPageSize] Number of geo locations per page
52122
- * @param {string} [itemGeoSearch] Search term to filter geo analytics (case-insensitive partial match on country/region/city)
52123
- * @param {AdminAnalyticsStoreXStoreIDItemsItemIdInsightsGetGroupByEnum} [groupBy] Include performance trends by date
53346
+ * Get filter values and counts for configured facets. Use this to build faceted navigation UIs. Supports disjunctive faceting for OR-based filter combinations.
53347
+ * @summary Get Filters
53348
+ * @param {string} xStoreid Store ID (from dashboard)
53349
+ * @param {string} xStoresecret Store read secret (from dashboard)
53350
+ * @param {DataTypesFiltersRequest} [dataTypesFiltersRequest] Filter options
52124
53351
  * @param {*} [options] Override http request option.
52125
53352
  * @throws {RequiredError}
52126
53353
  */
52127
- adminAnalyticsStoreXStoreIDItemsItemIdInsightsGet: (xStoreID: string, itemId: string, startTime?: string, endTime?: string, analyticsTags?: string, tagsMatchMode?: AdminAnalyticsStoreXStoreIDItemsItemIdInsightsGetTagsMatchModeEnum, tagsExclude?: string, tagKeyFilter?: string, tagValueFilter?: string, compareMode?: boolean, compareStartTime?: string, compareEndTime?: string, compareAnalyticsTags?: string, compareTagsMatchMode?: AdminAnalyticsStoreXStoreIDItemsItemIdInsightsGetCompareTagsMatchModeEnum, compareTagsExclude?: string, compareTagKeyFilter?: string, compareTagValueFilter?: string, resultsPage?: number, resultsPageSize?: number, itemQueriesSearch?: string, filtersPage?: number, filtersPageSize?: number, itemFiltersSearch?: string, geoPage?: number, geoPageSize?: number, itemGeoSearch?: string, groupBy?: AdminAnalyticsStoreXStoreIDItemsItemIdInsightsGetGroupByEnum, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
53354
+ v1FiltersPost: (xStoreid: string, xStoresecret: string, dataTypesFiltersRequest?: DataTypesFiltersRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
52128
53355
  /**
52129
- * Retrieve detailed performance metrics for items including click-through rates, conversion rates, and revenue data
52130
- * @summary Get Item Performance Analytics
52131
- * @param {string} xStoreID Store ID
52132
- * @param {string} [startTime] Start time in RFC3339 format
52133
- * @param {string} [endTime] End time in RFC3339 format
52134
- * @param {string} [itemIds] Comma-separated list of item IDs to filter
52135
- * @param {number} [itemLimit] Maximum number of items to return
52136
- * @param {number} [minImpressions] Minimum number of impressions required
52137
- * @param {number} [maxPosition] Maximum position to include
52138
- * @param {AdminAnalyticsStoreXStoreIDItemsPerformanceGetSortByEnum} [sortBy] Field to sort by
52139
- * @param {AdminAnalyticsStoreXStoreIDItemsPerformanceGetSortOrderEnum} [sortOrder] Sort direction
52140
- * @param {string} [sort] Combined sort parameter in format \&#39;field:direction\&#39;
52141
- * @param {number} [limit] Maximum number of results (legacy - use page_size instead)
52142
- * @param {number} [offset] Offset for pagination (legacy - use page instead)
52143
- * @param {number} [page] Page number for pagination
52144
- * @param {number} [pageSize] Number of results per page
53356
+ * Get available filter field metadata including types, sortability, and configured ranges. Useful for dynamically building filter UIs.
53357
+ * @summary Get Filters Schema
53358
+ * @param {string} xStoreid Store ID (from dashboard)
53359
+ * @param {string} xStoresecret Store read secret (from dashboard)
52145
53360
  * @param {*} [options] Override http request option.
52146
53361
  * @throws {RequiredError}
52147
53362
  */
52148
- adminAnalyticsStoreXStoreIDItemsPerformanceGet: (xStoreID: string, startTime?: string, endTime?: string, itemIds?: string, itemLimit?: number, minImpressions?: number, maxPosition?: number, sortBy?: AdminAnalyticsStoreXStoreIDItemsPerformanceGetSortByEnum, sortOrder?: AdminAnalyticsStoreXStoreIDItemsPerformanceGetSortOrderEnum, sort?: string, limit?: number, offset?: number, page?: number, pageSize?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
53363
+ v1FiltersSchemaGet: (xStoreid: string, xStoresecret: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
53364
+ };
53365
+ /**
53366
+ * FiltersApi - functional programming interface
53367
+ * @export
53368
+ */
53369
+ export declare const FiltersApiFp: (configuration?: Configuration) => {
52149
53370
  /**
52150
- * Retrieve item performance trends over time showing how items perform across different time periods
52151
- * @summary Get Item Performance Trends
52152
- * @param {string} xStoreID Store ID
52153
- * @param {string} [startTime] Start time in RFC3339 format
52154
- * @param {string} [endTime] End time in RFC3339 format
52155
- * @param {AdminAnalyticsStoreXStoreIDItemsTrendsGetGranularityEnum} [granularity] Time granularity for trends
52156
- * @param {string} [itemIds] Comma-separated list of item IDs to filter
52157
- * @param {number} [itemLimit] Maximum number of items to return
52158
- * @param {number} [limit] Maximum number of results (legacy - use page_size instead)
52159
- * @param {number} [offset] Offset for pagination (legacy - use page instead)
52160
- * @param {number} [page] Page number for pagination
52161
- * @param {number} [pageSize] Number of results per page
52162
- * @param {AdminAnalyticsStoreXStoreIDItemsTrendsGetSortByEnum} [sortBy] Field to sort by
52163
- * @param {AdminAnalyticsStoreXStoreIDItemsTrendsGetSortOrderEnum} [sortOrder] Sort direction
52164
- * @param {string} [sort] Combined sort parameter in format \&#39;field:direction\&#39;
53371
+ * Search within a facet\'s values (admin-authenticated version)
53372
+ * @summary Admin Search Facet Values
53373
+ * @param {string} xStoreID X-Store ID
53374
+ * @param {string} facetName Facet field name
53375
+ * @param {DataTypesFacetValuesSearchRequest} dataTypesFacetValuesSearchRequest Facet search query
52165
53376
  * @param {*} [options] Override http request option.
52166
53377
  * @throws {RequiredError}
52167
53378
  */
52168
- adminAnalyticsStoreXStoreIDItemsTrendsGet: (xStoreID: string, startTime?: string, endTime?: string, granularity?: AdminAnalyticsStoreXStoreIDItemsTrendsGetGranularityEnum, itemIds?: string, itemLimit?: number, limit?: number, offset?: number, page?: number, pageSize?: number, sortBy?: AdminAnalyticsStoreXStoreIDItemsTrendsGetSortByEnum, sortOrder?: AdminAnalyticsStoreXStoreIDItemsTrendsGetSortOrderEnum, sort?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
53379
+ adminV1FiltersXStoreIDFacetNameValuesPost(xStoreID: string, facetName: string, dataTypesFacetValuesSearchRequest: DataTypesFacetValuesSearchRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesFacetValuesSearchResponseWrapper>>;
52169
53380
  /**
52170
- * Analyze query performance with item context showing how queries perform in discovering and ranking items
52171
- * @summary Get Query Item Performance Analytics
52172
- * @param {string} xStoreID Store ID
52173
- * @param {string} [startTime] Start time in RFC3339 format
52174
- * @param {string} [endTime] End time in RFC3339 format
52175
- * @param {string} [queries] Comma-separated list of queries to filter
52176
- * @param {string} [itemIds] Comma-separated list of item IDs to filter
52177
- * @param {number} [queryLimit] Maximum number of queries to return
52178
- * @param {number} [minImpressions] Minimum number of impressions required
52179
- * @param {number} [limit] Maximum number of results (legacy - use page_size instead)
52180
- * @param {number} [offset] Offset for pagination (legacy - use page instead)
52181
- * @param {number} [page] Page number for pagination
52182
- * @param {number} [pageSize] Number of results per page
52183
- * @param {AdminAnalyticsStoreXStoreIDQueriesItemPerformanceGetSortByEnum} [sortBy] Field to sort by
52184
- * @param {AdminAnalyticsStoreXStoreIDQueriesItemPerformanceGetSortOrderEnum} [sortOrder] Sort direction
52185
- * @param {string} [sort] Combined sort parameter in format \&#39;field:direction\&#39;
53381
+ * Get filter values and counts (admin-authenticated version)
53382
+ * @summary Admin Get Filters
53383
+ * @param {string} xStoreID X-Store ID
53384
+ * @param {DataTypesFiltersRequest} [dataTypesFiltersRequest] Filter options
52186
53385
  * @param {*} [options] Override http request option.
52187
53386
  * @throws {RequiredError}
52188
53387
  */
52189
- adminAnalyticsStoreXStoreIDQueriesItemPerformanceGet: (xStoreID: string, startTime?: string, endTime?: string, queries?: string, itemIds?: string, queryLimit?: number, minImpressions?: number, limit?: number, offset?: number, page?: number, pageSize?: number, sortBy?: AdminAnalyticsStoreXStoreIDQueriesItemPerformanceGetSortByEnum, sortOrder?: AdminAnalyticsStoreXStoreIDQueriesItemPerformanceGetSortOrderEnum, sort?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
53388
+ adminV1FiltersXStoreIDPost(xStoreID: string, dataTypesFiltersRequest?: DataTypesFiltersRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesFiltersResponseWrapper>>;
53389
+ /**
53390
+ * Get filter field metadata (admin-authenticated version)
53391
+ * @summary Admin Get Filters Schema
53392
+ * @param {string} xStoreID X-Store ID
53393
+ * @param {*} [options] Override http request option.
53394
+ * @throws {RequiredError}
53395
+ */
53396
+ adminV1FiltersXStoreIDSchemaGet(xStoreID: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesFiltersSchemaResponseWrapper>>;
53397
+ /**
53398
+ * Search or autocomplete within a single facet\'s values. Useful for facets with many values (e.g., brands) where you need typeahead search.
53399
+ * @summary Search Facet Values
53400
+ * @param {string} xStoreid Store ID (from dashboard)
53401
+ * @param {string} xStoresecret Store read secret (from dashboard)
53402
+ * @param {string} facetName Facet field name (e.g., brand, category)
53403
+ * @param {DataTypesFacetValuesSearchRequest} dataTypesFacetValuesSearchRequest Facet search query
53404
+ * @param {*} [options] Override http request option.
53405
+ * @throws {RequiredError}
53406
+ */
53407
+ v1FiltersFacetNameValuesPost(xStoreid: string, xStoresecret: string, facetName: string, dataTypesFacetValuesSearchRequest: DataTypesFacetValuesSearchRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesFacetValuesSearchResponseWrapper>>;
53408
+ /**
53409
+ * Get filter values and counts for configured facets. Use this to build faceted navigation UIs. Supports disjunctive faceting for OR-based filter combinations.
53410
+ * @summary Get Filters
53411
+ * @param {string} xStoreid Store ID (from dashboard)
53412
+ * @param {string} xStoresecret Store read secret (from dashboard)
53413
+ * @param {DataTypesFiltersRequest} [dataTypesFiltersRequest] Filter options
53414
+ * @param {*} [options] Override http request option.
53415
+ * @throws {RequiredError}
53416
+ */
53417
+ v1FiltersPost(xStoreid: string, xStoresecret: string, dataTypesFiltersRequest?: DataTypesFiltersRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesFiltersResponseWrapper>>;
53418
+ /**
53419
+ * Get available filter field metadata including types, sortability, and configured ranges. Useful for dynamically building filter UIs.
53420
+ * @summary Get Filters Schema
53421
+ * @param {string} xStoreid Store ID (from dashboard)
53422
+ * @param {string} xStoresecret Store read secret (from dashboard)
53423
+ * @param {*} [options] Override http request option.
53424
+ * @throws {RequiredError}
53425
+ */
53426
+ v1FiltersSchemaGet(xStoreid: string, xStoresecret: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesFiltersSchemaResponseWrapper>>;
52190
53427
  };
52191
53428
  /**
52192
- * ItemAnalyticsApi - functional programming interface
53429
+ * FiltersApi - factory interface
52193
53430
  * @export
52194
53431
  */
52195
- export declare const ItemAnalyticsApiFp: (configuration?: Configuration) => {
53432
+ export declare const FiltersApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
53433
+ /**
53434
+ * Search within a facet\'s values (admin-authenticated version)
53435
+ * @summary Admin Search Facet Values
53436
+ * @param {string} xStoreID X-Store ID
53437
+ * @param {string} facetName Facet field name
53438
+ * @param {DataTypesFacetValuesSearchRequest} dataTypesFacetValuesSearchRequest Facet search query
53439
+ * @param {*} [options] Override http request option.
53440
+ * @throws {RequiredError}
53441
+ */
53442
+ adminV1FiltersXStoreIDFacetNameValuesPost(xStoreID: string, facetName: string, dataTypesFacetValuesSearchRequest: DataTypesFacetValuesSearchRequest, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesFacetValuesSearchResponseWrapper>;
53443
+ /**
53444
+ * Get filter values and counts (admin-authenticated version)
53445
+ * @summary Admin Get Filters
53446
+ * @param {string} xStoreID X-Store ID
53447
+ * @param {DataTypesFiltersRequest} [dataTypesFiltersRequest] Filter options
53448
+ * @param {*} [options] Override http request option.
53449
+ * @throws {RequiredError}
53450
+ */
53451
+ adminV1FiltersXStoreIDPost(xStoreID: string, dataTypesFiltersRequest?: DataTypesFiltersRequest, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesFiltersResponseWrapper>;
53452
+ /**
53453
+ * Get filter field metadata (admin-authenticated version)
53454
+ * @summary Admin Get Filters Schema
53455
+ * @param {string} xStoreID X-Store ID
53456
+ * @param {*} [options] Override http request option.
53457
+ * @throws {RequiredError}
53458
+ */
53459
+ adminV1FiltersXStoreIDSchemaGet(xStoreID: string, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesFiltersSchemaResponseWrapper>;
53460
+ /**
53461
+ * Search or autocomplete within a single facet\'s values. Useful for facets with many values (e.g., brands) where you need typeahead search.
53462
+ * @summary Search Facet Values
53463
+ * @param {string} xStoreid Store ID (from dashboard)
53464
+ * @param {string} xStoresecret Store read secret (from dashboard)
53465
+ * @param {string} facetName Facet field name (e.g., brand, category)
53466
+ * @param {DataTypesFacetValuesSearchRequest} dataTypesFacetValuesSearchRequest Facet search query
53467
+ * @param {*} [options] Override http request option.
53468
+ * @throws {RequiredError}
53469
+ */
53470
+ v1FiltersFacetNameValuesPost(xStoreid: string, xStoresecret: string, facetName: string, dataTypesFacetValuesSearchRequest: DataTypesFacetValuesSearchRequest, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesFacetValuesSearchResponseWrapper>;
53471
+ /**
53472
+ * Get filter values and counts for configured facets. Use this to build faceted navigation UIs. Supports disjunctive faceting for OR-based filter combinations.
53473
+ * @summary Get Filters
53474
+ * @param {string} xStoreid Store ID (from dashboard)
53475
+ * @param {string} xStoresecret Store read secret (from dashboard)
53476
+ * @param {DataTypesFiltersRequest} [dataTypesFiltersRequest] Filter options
53477
+ * @param {*} [options] Override http request option.
53478
+ * @throws {RequiredError}
53479
+ */
53480
+ v1FiltersPost(xStoreid: string, xStoresecret: string, dataTypesFiltersRequest?: DataTypesFiltersRequest, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesFiltersResponseWrapper>;
53481
+ /**
53482
+ * Get available filter field metadata including types, sortability, and configured ranges. Useful for dynamically building filter UIs.
53483
+ * @summary Get Filters Schema
53484
+ * @param {string} xStoreid Store ID (from dashboard)
53485
+ * @param {string} xStoresecret Store read secret (from dashboard)
53486
+ * @param {*} [options] Override http request option.
53487
+ * @throws {RequiredError}
53488
+ */
53489
+ v1FiltersSchemaGet(xStoreid: string, xStoresecret: string, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesFiltersSchemaResponseWrapper>;
53490
+ };
53491
+ /**
53492
+ * FiltersApi - object-oriented interface
53493
+ * @export
53494
+ * @class FiltersApi
53495
+ * @extends {BaseAPI}
53496
+ */
53497
+ export declare class FiltersApi extends BaseAPI {
53498
+ /**
53499
+ * Search within a facet\'s values (admin-authenticated version)
53500
+ * @summary Admin Search Facet Values
53501
+ * @param {string} xStoreID X-Store ID
53502
+ * @param {string} facetName Facet field name
53503
+ * @param {DataTypesFacetValuesSearchRequest} dataTypesFacetValuesSearchRequest Facet search query
53504
+ * @param {*} [options] Override http request option.
53505
+ * @throws {RequiredError}
53506
+ * @memberof FiltersApi
53507
+ */
53508
+ adminV1FiltersXStoreIDFacetNameValuesPost(xStoreID: string, facetName: string, dataTypesFacetValuesSearchRequest: DataTypesFacetValuesSearchRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesFacetValuesSearchResponseWrapper, any, {}>>;
53509
+ /**
53510
+ * Get filter values and counts (admin-authenticated version)
53511
+ * @summary Admin Get Filters
53512
+ * @param {string} xStoreID X-Store ID
53513
+ * @param {DataTypesFiltersRequest} [dataTypesFiltersRequest] Filter options
53514
+ * @param {*} [options] Override http request option.
53515
+ * @throws {RequiredError}
53516
+ * @memberof FiltersApi
53517
+ */
53518
+ adminV1FiltersXStoreIDPost(xStoreID: string, dataTypesFiltersRequest?: DataTypesFiltersRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesFiltersResponseWrapper, any, {}>>;
53519
+ /**
53520
+ * Get filter field metadata (admin-authenticated version)
53521
+ * @summary Admin Get Filters Schema
53522
+ * @param {string} xStoreID X-Store ID
53523
+ * @param {*} [options] Override http request option.
53524
+ * @throws {RequiredError}
53525
+ * @memberof FiltersApi
53526
+ */
53527
+ adminV1FiltersXStoreIDSchemaGet(xStoreID: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesFiltersSchemaResponseWrapper, any, {}>>;
53528
+ /**
53529
+ * Search or autocomplete within a single facet\'s values. Useful for facets with many values (e.g., brands) where you need typeahead search.
53530
+ * @summary Search Facet Values
53531
+ * @param {string} xStoreid Store ID (from dashboard)
53532
+ * @param {string} xStoresecret Store read secret (from dashboard)
53533
+ * @param {string} facetName Facet field name (e.g., brand, category)
53534
+ * @param {DataTypesFacetValuesSearchRequest} dataTypesFacetValuesSearchRequest Facet search query
53535
+ * @param {*} [options] Override http request option.
53536
+ * @throws {RequiredError}
53537
+ * @memberof FiltersApi
53538
+ */
53539
+ v1FiltersFacetNameValuesPost(xStoreid: string, xStoresecret: string, facetName: string, dataTypesFacetValuesSearchRequest: DataTypesFacetValuesSearchRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesFacetValuesSearchResponseWrapper, any, {}>>;
53540
+ /**
53541
+ * Get filter values and counts for configured facets. Use this to build faceted navigation UIs. Supports disjunctive faceting for OR-based filter combinations.
53542
+ * @summary Get Filters
53543
+ * @param {string} xStoreid Store ID (from dashboard)
53544
+ * @param {string} xStoresecret Store read secret (from dashboard)
53545
+ * @param {DataTypesFiltersRequest} [dataTypesFiltersRequest] Filter options
53546
+ * @param {*} [options] Override http request option.
53547
+ * @throws {RequiredError}
53548
+ * @memberof FiltersApi
53549
+ */
53550
+ v1FiltersPost(xStoreid: string, xStoresecret: string, dataTypesFiltersRequest?: DataTypesFiltersRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesFiltersResponseWrapper, any, {}>>;
53551
+ /**
53552
+ * Get available filter field metadata including types, sortability, and configured ranges. Useful for dynamically building filter UIs.
53553
+ * @summary Get Filters Schema
53554
+ * @param {string} xStoreid Store ID (from dashboard)
53555
+ * @param {string} xStoresecret Store read secret (from dashboard)
53556
+ * @param {*} [options] Override http request option.
53557
+ * @throws {RequiredError}
53558
+ * @memberof FiltersApi
53559
+ */
53560
+ v1FiltersSchemaGet(xStoreid: string, xStoresecret: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesFiltersSchemaResponseWrapper, any, {}>>;
53561
+ }
53562
+ /**
53563
+ * ItemAnalyticsApi - axios parameter creator
53564
+ * @export
53565
+ */
53566
+ export declare const ItemAnalyticsApiAxiosParamCreator: (configuration?: Configuration) => {
52196
53567
  /**
52197
53568
  * Compare performance metrics between multiple items to identify top and underperforming products
52198
53569
  * @summary Get Item Comparison Analytics
@@ -52203,7 +53574,7 @@ export declare const ItemAnalyticsApiFp: (configuration?: Configuration) => {
52203
53574
  * @param {*} [options] Override http request option.
52204
53575
  * @throws {RequiredError}
52205
53576
  */
52206
- adminAnalyticsStoreXStoreIDItemsComparisonGet(xStoreID: string, itemIds: string, startTime?: string, endTime?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AdminAnalyticsStoreXStoreIDItemsComparisonGet200Response>>;
53577
+ adminAnalyticsStoreXStoreIDItemsComparisonGet: (xStoreID: string, itemIds: string, startTime?: string, endTime?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
52207
53578
  /**
52208
53579
  * Analyze how items are discovered through search queries, filters, and sorts with position distribution data
52209
53580
  * @summary Get Item Discovery Analytics
@@ -52224,7 +53595,174 @@ export declare const ItemAnalyticsApiFp: (configuration?: Configuration) => {
52224
53595
  * @param {*} [options] Override http request option.
52225
53596
  * @throws {RequiredError}
52226
53597
  */
52227
- adminAnalyticsStoreXStoreIDItemsDiscoveryGet(xStoreID: string, startTime?: string, endTime?: string, itemIds?: string, queries?: string, itemLimit?: number, minImpressions?: number, limit?: number, offset?: number, page?: number, pageSize?: number, sortBy?: AdminAnalyticsStoreXStoreIDItemsDiscoveryGetSortByEnum, sortOrder?: AdminAnalyticsStoreXStoreIDItemsDiscoveryGetSortOrderEnum, sort?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AdminAnalyticsStoreXStoreIDItemsDiscoveryGet200Response>>;
53598
+ adminAnalyticsStoreXStoreIDItemsDiscoveryGet: (xStoreID: string, startTime?: string, endTime?: string, itemIds?: string, queries?: string, itemLimit?: number, minImpressions?: number, limit?: number, offset?: number, page?: number, pageSize?: number, sortBy?: AdminAnalyticsStoreXStoreIDItemsDiscoveryGetSortByEnum, sortOrder?: AdminAnalyticsStoreXStoreIDItemsDiscoveryGetSortOrderEnum, sort?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
53599
+ /**
53600
+ * Retrieve general item performance analytics including impressions, clicks, conversions, and revenue metrics
53601
+ * @summary Get Item Analytics
53602
+ * @param {string} xStoreID Store ID
53603
+ * @param {string} [startTime] Start time in RFC3339 format
53604
+ * @param {string} [endTime] End time in RFC3339 format
53605
+ * @param {string} [search] Search term to filter items (case-insensitive partial match on item IDs and related data)
53606
+ * @param {string} [itemIds] Comma-separated list of item IDs to filter
53607
+ * @param {number} [itemLimit] Maximum number of items to return
53608
+ * @param {number} [minImpressions] Minimum number of impressions required
53609
+ * @param {number} [maxPosition] Maximum position to include
53610
+ * @param {AdminAnalyticsStoreXStoreIDItemsGetSortByEnum} [sortBy] Field to sort by
53611
+ * @param {AdminAnalyticsStoreXStoreIDItemsGetSortOrderEnum} [sortOrder] Sort direction
53612
+ * @param {string} [sort] Combined sort parameter in format \&#39;field:direction\&#39;
53613
+ * @param {number} [limit] Maximum number of results (legacy - use page_size instead)
53614
+ * @param {number} [offset] Offset for pagination (legacy - use page instead)
53615
+ * @param {number} [page] Page number for pagination
53616
+ * @param {number} [pageSize] Number of results per page
53617
+ * @param {*} [options] Override http request option.
53618
+ * @throws {RequiredError}
53619
+ */
53620
+ adminAnalyticsStoreXStoreIDItemsGet: (xStoreID: string, startTime?: string, endTime?: string, search?: string, itemIds?: string, itemLimit?: number, minImpressions?: number, maxPosition?: number, sortBy?: AdminAnalyticsStoreXStoreIDItemsGetSortByEnum, sortOrder?: AdminAnalyticsStoreXStoreIDItemsGetSortOrderEnum, sort?: string, limit?: number, offset?: number, page?: number, pageSize?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
53621
+ /**
53622
+ * Retrieve detailed analytics for a specific item including performance metrics and discovery data
53623
+ * @summary Get Item Details
53624
+ * @param {string} xStoreID Store ID
53625
+ * @param {string} itemId Item ID
53626
+ * @param {string} [startTime] Start time in RFC3339 format
53627
+ * @param {string} [endTime] End time in RFC3339 format
53628
+ * @param {*} [options] Override http request option.
53629
+ * @throws {RequiredError}
53630
+ */
53631
+ adminAnalyticsStoreXStoreIDItemsItemIdGet: (xStoreID: string, itemId: string, startTime?: string, endTime?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
53632
+ /**
53633
+ * Retrieve comprehensive analytics insights for a specific item including all core metrics (Total Searches, Results Shown, Impressions, Clicks, Conversions, Revenue, CTR, CVR, Conversion Rate per Search, No-Click Rate, Avg Result Rank, Avg Click Position), popular queries, filters, position distribution, geo analytics, and performance metrics with pagination support for subsections and optional comparison mode
53634
+ * @summary Get Item Insights
53635
+ * @param {string} xStoreID Store ID
53636
+ * @param {string} itemId Item ID to analyze
53637
+ * @param {string} [startTime] Start time in RFC3339 format
53638
+ * @param {string} [endTime] End time in RFC3339 format
53639
+ * @param {string} [analyticsTags] Comma-separated analytics tags to filter (e.g., \&#39;campaign:summer,source:email\&#39;)
53640
+ * @param {AdminAnalyticsStoreXStoreIDItemsItemIdInsightsGetTagsMatchModeEnum} [tagsMatchMode] How to match multiple analytics tags
53641
+ * @param {string} [tagsExclude] Comma-separated analytics tags to exclude
53642
+ * @param {string} [tagKeyFilter] Filter by tag key pattern (matches tags starting with key:)
53643
+ * @param {string} [tagValueFilter] Filter by tag value pattern (matches tags ending with :value)
53644
+ * @param {boolean} [compareMode] Enable comparison mode to compare with another time period/tag set
53645
+ * @param {string} [compareStartTime] Comparison period start time in RFC3339 format
53646
+ * @param {string} [compareEndTime] Comparison period end time in RFC3339 format
53647
+ * @param {string} [compareAnalyticsTags] Comma-separated analytics tags for comparison period
53648
+ * @param {AdminAnalyticsStoreXStoreIDItemsItemIdInsightsGetCompareTagsMatchModeEnum} [compareTagsMatchMode] How to match comparison analytics tags
53649
+ * @param {string} [compareTagsExclude] Comma-separated analytics tags to exclude in comparison
53650
+ * @param {string} [compareTagKeyFilter] Tag key filter for comparison period
53651
+ * @param {string} [compareTagValueFilter] Tag value filter for comparison period
53652
+ * @param {number} [resultsPage] Page number for popular queries pagination
53653
+ * @param {number} [resultsPageSize] Number of queries per page for popular queries
53654
+ * @param {string} [itemQueriesSearch] Search term to filter popular queries (case-insensitive partial match on query text)
53655
+ * @param {number} [filtersPage] Page number for popular filters pagination
53656
+ * @param {number} [filtersPageSize] Number of filters per page
53657
+ * @param {string} [itemFiltersSearch] Search term to filter popular filters (case-insensitive partial match on filter keys/values)
53658
+ * @param {number} [geoPage] Page number for geo analytics pagination
53659
+ * @param {number} [geoPageSize] Number of geo locations per page
53660
+ * @param {string} [itemGeoSearch] Search term to filter geo analytics (case-insensitive partial match on country/region/city)
53661
+ * @param {AdminAnalyticsStoreXStoreIDItemsItemIdInsightsGetGroupByEnum} [groupBy] Include performance trends by date
53662
+ * @param {*} [options] Override http request option.
53663
+ * @throws {RequiredError}
53664
+ */
53665
+ adminAnalyticsStoreXStoreIDItemsItemIdInsightsGet: (xStoreID: string, itemId: string, startTime?: string, endTime?: string, analyticsTags?: string, tagsMatchMode?: AdminAnalyticsStoreXStoreIDItemsItemIdInsightsGetTagsMatchModeEnum, tagsExclude?: string, tagKeyFilter?: string, tagValueFilter?: string, compareMode?: boolean, compareStartTime?: string, compareEndTime?: string, compareAnalyticsTags?: string, compareTagsMatchMode?: AdminAnalyticsStoreXStoreIDItemsItemIdInsightsGetCompareTagsMatchModeEnum, compareTagsExclude?: string, compareTagKeyFilter?: string, compareTagValueFilter?: string, resultsPage?: number, resultsPageSize?: number, itemQueriesSearch?: string, filtersPage?: number, filtersPageSize?: number, itemFiltersSearch?: string, geoPage?: number, geoPageSize?: number, itemGeoSearch?: string, groupBy?: AdminAnalyticsStoreXStoreIDItemsItemIdInsightsGetGroupByEnum, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
53666
+ /**
53667
+ * Retrieve detailed performance metrics for items including click-through rates, conversion rates, and revenue data
53668
+ * @summary Get Item Performance Analytics
53669
+ * @param {string} xStoreID Store ID
53670
+ * @param {string} [startTime] Start time in RFC3339 format
53671
+ * @param {string} [endTime] End time in RFC3339 format
53672
+ * @param {string} [itemIds] Comma-separated list of item IDs to filter
53673
+ * @param {number} [itemLimit] Maximum number of items to return
53674
+ * @param {number} [minImpressions] Minimum number of impressions required
53675
+ * @param {number} [maxPosition] Maximum position to include
53676
+ * @param {AdminAnalyticsStoreXStoreIDItemsPerformanceGetSortByEnum} [sortBy] Field to sort by
53677
+ * @param {AdminAnalyticsStoreXStoreIDItemsPerformanceGetSortOrderEnum} [sortOrder] Sort direction
53678
+ * @param {string} [sort] Combined sort parameter in format \&#39;field:direction\&#39;
53679
+ * @param {number} [limit] Maximum number of results (legacy - use page_size instead)
53680
+ * @param {number} [offset] Offset for pagination (legacy - use page instead)
53681
+ * @param {number} [page] Page number for pagination
53682
+ * @param {number} [pageSize] Number of results per page
53683
+ * @param {*} [options] Override http request option.
53684
+ * @throws {RequiredError}
53685
+ */
53686
+ adminAnalyticsStoreXStoreIDItemsPerformanceGet: (xStoreID: string, startTime?: string, endTime?: string, itemIds?: string, itemLimit?: number, minImpressions?: number, maxPosition?: number, sortBy?: AdminAnalyticsStoreXStoreIDItemsPerformanceGetSortByEnum, sortOrder?: AdminAnalyticsStoreXStoreIDItemsPerformanceGetSortOrderEnum, sort?: string, limit?: number, offset?: number, page?: number, pageSize?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
53687
+ /**
53688
+ * Retrieve item performance trends over time showing how items perform across different time periods
53689
+ * @summary Get Item Performance Trends
53690
+ * @param {string} xStoreID Store ID
53691
+ * @param {string} [startTime] Start time in RFC3339 format
53692
+ * @param {string} [endTime] End time in RFC3339 format
53693
+ * @param {AdminAnalyticsStoreXStoreIDItemsTrendsGetGranularityEnum} [granularity] Time granularity for trends
53694
+ * @param {string} [itemIds] Comma-separated list of item IDs to filter
53695
+ * @param {number} [itemLimit] Maximum number of items to return
53696
+ * @param {number} [limit] Maximum number of results (legacy - use page_size instead)
53697
+ * @param {number} [offset] Offset for pagination (legacy - use page instead)
53698
+ * @param {number} [page] Page number for pagination
53699
+ * @param {number} [pageSize] Number of results per page
53700
+ * @param {AdminAnalyticsStoreXStoreIDItemsTrendsGetSortByEnum} [sortBy] Field to sort by
53701
+ * @param {AdminAnalyticsStoreXStoreIDItemsTrendsGetSortOrderEnum} [sortOrder] Sort direction
53702
+ * @param {string} [sort] Combined sort parameter in format \&#39;field:direction\&#39;
53703
+ * @param {*} [options] Override http request option.
53704
+ * @throws {RequiredError}
53705
+ */
53706
+ adminAnalyticsStoreXStoreIDItemsTrendsGet: (xStoreID: string, startTime?: string, endTime?: string, granularity?: AdminAnalyticsStoreXStoreIDItemsTrendsGetGranularityEnum, itemIds?: string, itemLimit?: number, limit?: number, offset?: number, page?: number, pageSize?: number, sortBy?: AdminAnalyticsStoreXStoreIDItemsTrendsGetSortByEnum, sortOrder?: AdminAnalyticsStoreXStoreIDItemsTrendsGetSortOrderEnum, sort?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
53707
+ /**
53708
+ * Analyze query performance with item context showing how queries perform in discovering and ranking items
53709
+ * @summary Get Query Item Performance Analytics
53710
+ * @param {string} xStoreID Store ID
53711
+ * @param {string} [startTime] Start time in RFC3339 format
53712
+ * @param {string} [endTime] End time in RFC3339 format
53713
+ * @param {string} [queries] Comma-separated list of queries to filter
53714
+ * @param {string} [itemIds] Comma-separated list of item IDs to filter
53715
+ * @param {number} [queryLimit] Maximum number of queries to return
53716
+ * @param {number} [minImpressions] Minimum number of impressions required
53717
+ * @param {number} [limit] Maximum number of results (legacy - use page_size instead)
53718
+ * @param {number} [offset] Offset for pagination (legacy - use page instead)
53719
+ * @param {number} [page] Page number for pagination
53720
+ * @param {number} [pageSize] Number of results per page
53721
+ * @param {AdminAnalyticsStoreXStoreIDQueriesItemPerformanceGetSortByEnum} [sortBy] Field to sort by
53722
+ * @param {AdminAnalyticsStoreXStoreIDQueriesItemPerformanceGetSortOrderEnum} [sortOrder] Sort direction
53723
+ * @param {string} [sort] Combined sort parameter in format \&#39;field:direction\&#39;
53724
+ * @param {*} [options] Override http request option.
53725
+ * @throws {RequiredError}
53726
+ */
53727
+ adminAnalyticsStoreXStoreIDQueriesItemPerformanceGet: (xStoreID: string, startTime?: string, endTime?: string, queries?: string, itemIds?: string, queryLimit?: number, minImpressions?: number, limit?: number, offset?: number, page?: number, pageSize?: number, sortBy?: AdminAnalyticsStoreXStoreIDQueriesItemPerformanceGetSortByEnum, sortOrder?: AdminAnalyticsStoreXStoreIDQueriesItemPerformanceGetSortOrderEnum, sort?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
53728
+ };
53729
+ /**
53730
+ * ItemAnalyticsApi - functional programming interface
53731
+ * @export
53732
+ */
53733
+ export declare const ItemAnalyticsApiFp: (configuration?: Configuration) => {
53734
+ /**
53735
+ * Compare performance metrics between multiple items to identify top and underperforming products
53736
+ * @summary Get Item Comparison Analytics
53737
+ * @param {string} xStoreID Store ID
53738
+ * @param {string} itemIds Comma-separated list of item IDs to compare (minimum 2)
53739
+ * @param {string} [startTime] Start time in RFC3339 format
53740
+ * @param {string} [endTime] End time in RFC3339 format
53741
+ * @param {*} [options] Override http request option.
53742
+ * @throws {RequiredError}
53743
+ */
53744
+ adminAnalyticsStoreXStoreIDItemsComparisonGet(xStoreID: string, itemIds: string, startTime?: string, endTime?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AdminAnalyticsStoreXStoreIDItemsComparisonGet200Response>>;
53745
+ /**
53746
+ * Analyze how items are discovered through search queries, filters, and sorts with position distribution data
53747
+ * @summary Get Item Discovery Analytics
53748
+ * @param {string} xStoreID Store ID
53749
+ * @param {string} [startTime] Start time in RFC3339 format
53750
+ * @param {string} [endTime] End time in RFC3339 format
53751
+ * @param {string} [itemIds] Comma-separated list of item IDs to filter
53752
+ * @param {string} [queries] Comma-separated list of queries to filter
53753
+ * @param {number} [itemLimit] Maximum number of items to return
53754
+ * @param {number} [minImpressions] Minimum number of impressions required
53755
+ * @param {number} [limit] Maximum number of results (legacy - use page_size instead)
53756
+ * @param {number} [offset] Offset for pagination (legacy - use page instead)
53757
+ * @param {number} [page] Page number for pagination
53758
+ * @param {number} [pageSize] Number of results per page
53759
+ * @param {AdminAnalyticsStoreXStoreIDItemsDiscoveryGetSortByEnum} [sortBy] Field to sort by
53760
+ * @param {AdminAnalyticsStoreXStoreIDItemsDiscoveryGetSortOrderEnum} [sortOrder] Sort direction
53761
+ * @param {string} [sort] Combined sort parameter in format \&#39;field:direction\&#39;
53762
+ * @param {*} [options] Override http request option.
53763
+ * @throws {RequiredError}
53764
+ */
53765
+ adminAnalyticsStoreXStoreIDItemsDiscoveryGet(xStoreID: string, startTime?: string, endTime?: string, itemIds?: string, queries?: string, itemLimit?: number, minImpressions?: number, limit?: number, offset?: number, page?: number, pageSize?: number, sortBy?: AdminAnalyticsStoreXStoreIDItemsDiscoveryGetSortByEnum, sortOrder?: AdminAnalyticsStoreXStoreIDItemsDiscoveryGetSortOrderEnum, sort?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AdminAnalyticsStoreXStoreIDItemsDiscoveryGet200Response>>;
52228
53766
  /**
52229
53767
  * Retrieve general item performance analytics including impressions, clicks, conversions, and revenue metrics
52230
53768
  * @summary Get Item Analytics
@@ -60418,771 +61956,254 @@ export declare class RolesApi extends BaseAPI {
60418
61956
  adminRolesRoleIdPermissionsPut(roleId: number, dataTypesSlimUpdateRolePermissionsRequest: DataTypesSlimUpdateRolePermissionsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesResponse, any, {}>>;
60419
61957
  }
60420
61958
  /**
60421
- * SDKDocumentsApi - axios parameter creator
61959
+ * SDKExperimentsApi - axios parameter creator
60422
61960
  * @export
60423
61961
  */
60424
- export declare const SDKDocumentsApiAxiosParamCreator: (configuration?: Configuration) => {
60425
- /**
60426
- * 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.
60427
- * @summary Bulk index documents
60428
- * @param {string} xStoreid Store ID (from dashboard)
60429
- * @param {string} xStoreWriteSecret Store write secret
60430
- * @param {string} xStoreID Store ID (must match x-storeid header)
60431
- * @param {DataTypesBulkDocumentRequest} dataTypesBulkDocumentRequest List of operations
60432
- * @param {*} [options] Override http request option.
60433
- * @throws {RequiredError}
60434
- */
60435
- apiV1StoresXStoreIDDocumentsBulkPost: (xStoreid: string, xStoreWriteSecret: string, xStoreID: string, dataTypesBulkDocumentRequest: DataTypesBulkDocumentRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
60436
- /**
60437
- * 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.
60438
- * @summary Delete a document
60439
- * @param {string} xStoreid Store ID (from dashboard)
60440
- * @param {string} xStoreWriteSecret Store write secret
60441
- * @param {string} xStoreID Store ID (must match x-storeid header)
60442
- * @param {string} documentID Document ID to delete
60443
- * @param {*} [options] Override http request option.
60444
- * @throws {RequiredError}
60445
- */
60446
- apiV1StoresXStoreIDDocumentsDocumentIDDelete: (xStoreid: string, xStoreWriteSecret: string, xStoreID: string, documentID: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
61962
+ export declare const SDKExperimentsApiAxiosParamCreator: (configuration?: Configuration) => {
60447
61963
  /**
60448
- * 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.
60449
- * @summary Index a single document
60450
- * @param {string} xStoreid Store ID (from dashboard)
60451
- * @param {string} xStoreWriteSecret Store write secret
60452
- * @param {string} xStoreID Store ID (must match x-storeid header)
60453
- * @param {DataTypesDocumentRequest} dataTypesDocumentRequest Document fields to index
61964
+ * Returns variant assignments for all running experiments for the requesting user. Uses hash-based consistent assignment.
61965
+ * @summary Get experiment assignments for a user
61966
+ * @param {string} xStoreid Store ID
61967
+ * @param {string} xStoresecret Store read secret
61968
+ * @param {string} [xUserId] User ID (provide either x-user-id or x-anon-id)
61969
+ * @param {string} [xAnonId] Anonymous ID (provide either x-user-id or x-anon-id)
60454
61970
  * @param {*} [options] Override http request option.
60455
61971
  * @throws {RequiredError}
60456
61972
  */
60457
- apiV1StoresXStoreIDDocumentsPost: (xStoreid: string, xStoreWriteSecret: string, xStoreID: string, dataTypesDocumentRequest: DataTypesDocumentRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
61973
+ v1ExperimentsAssignmentGet: (xStoreid: string, xStoresecret: string, xUserId?: string, xAnonId?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
60458
61974
  };
60459
61975
  /**
60460
- * SDKDocumentsApi - functional programming interface
61976
+ * SDKExperimentsApi - functional programming interface
60461
61977
  * @export
60462
61978
  */
60463
- export declare const SDKDocumentsApiFp: (configuration?: Configuration) => {
60464
- /**
60465
- * 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.
60466
- * @summary Bulk index documents
60467
- * @param {string} xStoreid Store ID (from dashboard)
60468
- * @param {string} xStoreWriteSecret Store write secret
60469
- * @param {string} xStoreID Store ID (must match x-storeid header)
60470
- * @param {DataTypesBulkDocumentRequest} dataTypesBulkDocumentRequest List of operations
60471
- * @param {*} [options] Override http request option.
60472
- * @throws {RequiredError}
60473
- */
60474
- apiV1StoresXStoreIDDocumentsBulkPost(xStoreid: string, xStoreWriteSecret: string, xStoreID: string, dataTypesBulkDocumentRequest: DataTypesBulkDocumentRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesBulkDocumentResponseWrapper>>;
60475
- /**
60476
- * 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.
60477
- * @summary Delete a document
60478
- * @param {string} xStoreid Store ID (from dashboard)
60479
- * @param {string} xStoreWriteSecret Store write secret
60480
- * @param {string} xStoreID Store ID (must match x-storeid header)
60481
- * @param {string} documentID Document ID to delete
60482
- * @param {*} [options] Override http request option.
60483
- * @throws {RequiredError}
60484
- */
60485
- apiV1StoresXStoreIDDocumentsDocumentIDDelete(xStoreid: string, xStoreWriteSecret: string, xStoreID: string, documentID: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesDocumentResponseWrapper>>;
61979
+ export declare const SDKExperimentsApiFp: (configuration?: Configuration) => {
60486
61980
  /**
60487
- * 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.
60488
- * @summary Index a single document
60489
- * @param {string} xStoreid Store ID (from dashboard)
60490
- * @param {string} xStoreWriteSecret Store write secret
60491
- * @param {string} xStoreID Store ID (must match x-storeid header)
60492
- * @param {DataTypesDocumentRequest} dataTypesDocumentRequest Document fields to index
61981
+ * Returns variant assignments for all running experiments for the requesting user. Uses hash-based consistent assignment.
61982
+ * @summary Get experiment assignments for a user
61983
+ * @param {string} xStoreid Store ID
61984
+ * @param {string} xStoresecret Store read secret
61985
+ * @param {string} [xUserId] User ID (provide either x-user-id or x-anon-id)
61986
+ * @param {string} [xAnonId] Anonymous ID (provide either x-user-id or x-anon-id)
60493
61987
  * @param {*} [options] Override http request option.
60494
61988
  * @throws {RequiredError}
60495
61989
  */
60496
- apiV1StoresXStoreIDDocumentsPost(xStoreid: string, xStoreWriteSecret: string, xStoreID: string, dataTypesDocumentRequest: DataTypesDocumentRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesDocumentResponseWrapper>>;
61990
+ v1ExperimentsAssignmentGet(xStoreid: string, xStoresecret: string, xUserId?: string, xAnonId?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesExperimentAssignmentResponse>>;
60497
61991
  };
60498
61992
  /**
60499
- * SDKDocumentsApi - factory interface
61993
+ * SDKExperimentsApi - factory interface
60500
61994
  * @export
60501
61995
  */
60502
- export declare const SDKDocumentsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
60503
- /**
60504
- * 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.
60505
- * @summary Bulk index documents
60506
- * @param {string} xStoreid Store ID (from dashboard)
60507
- * @param {string} xStoreWriteSecret Store write secret
60508
- * @param {string} xStoreID Store ID (must match x-storeid header)
60509
- * @param {DataTypesBulkDocumentRequest} dataTypesBulkDocumentRequest List of operations
60510
- * @param {*} [options] Override http request option.
60511
- * @throws {RequiredError}
60512
- */
60513
- apiV1StoresXStoreIDDocumentsBulkPost(xStoreid: string, xStoreWriteSecret: string, xStoreID: string, dataTypesBulkDocumentRequest: DataTypesBulkDocumentRequest, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesBulkDocumentResponseWrapper>;
60514
- /**
60515
- * 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.
60516
- * @summary Delete a document
60517
- * @param {string} xStoreid Store ID (from dashboard)
60518
- * @param {string} xStoreWriteSecret Store write secret
60519
- * @param {string} xStoreID Store ID (must match x-storeid header)
60520
- * @param {string} documentID Document ID to delete
60521
- * @param {*} [options] Override http request option.
60522
- * @throws {RequiredError}
60523
- */
60524
- apiV1StoresXStoreIDDocumentsDocumentIDDelete(xStoreid: string, xStoreWriteSecret: string, xStoreID: string, documentID: string, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesDocumentResponseWrapper>;
61996
+ export declare const SDKExperimentsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
60525
61997
  /**
60526
- * 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.
60527
- * @summary Index a single document
60528
- * @param {string} xStoreid Store ID (from dashboard)
60529
- * @param {string} xStoreWriteSecret Store write secret
60530
- * @param {string} xStoreID Store ID (must match x-storeid header)
60531
- * @param {DataTypesDocumentRequest} dataTypesDocumentRequest Document fields to index
61998
+ * Returns variant assignments for all running experiments for the requesting user. Uses hash-based consistent assignment.
61999
+ * @summary Get experiment assignments for a user
62000
+ * @param {string} xStoreid Store ID
62001
+ * @param {string} xStoresecret Store read secret
62002
+ * @param {string} [xUserId] User ID (provide either x-user-id or x-anon-id)
62003
+ * @param {string} [xAnonId] Anonymous ID (provide either x-user-id or x-anon-id)
60532
62004
  * @param {*} [options] Override http request option.
60533
62005
  * @throws {RequiredError}
60534
62006
  */
60535
- apiV1StoresXStoreIDDocumentsPost(xStoreid: string, xStoreWriteSecret: string, xStoreID: string, dataTypesDocumentRequest: DataTypesDocumentRequest, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesDocumentResponseWrapper>;
62007
+ v1ExperimentsAssignmentGet(xStoreid: string, xStoresecret: string, xUserId?: string, xAnonId?: string, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesExperimentAssignmentResponse>;
60536
62008
  };
60537
62009
  /**
60538
- * SDKDocumentsApi - object-oriented interface
62010
+ * SDKExperimentsApi - object-oriented interface
60539
62011
  * @export
60540
- * @class SDKDocumentsApi
62012
+ * @class SDKExperimentsApi
60541
62013
  * @extends {BaseAPI}
60542
62014
  */
60543
- export declare class SDKDocumentsApi extends BaseAPI {
62015
+ export declare class SDKExperimentsApi extends BaseAPI {
60544
62016
  /**
60545
- * 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.
60546
- * @summary Bulk index documents
60547
- * @param {string} xStoreid Store ID (from dashboard)
60548
- * @param {string} xStoreWriteSecret Store write secret
60549
- * @param {string} xStoreID Store ID (must match x-storeid header)
60550
- * @param {DataTypesBulkDocumentRequest} dataTypesBulkDocumentRequest List of operations
62017
+ * Returns variant assignments for all running experiments for the requesting user. Uses hash-based consistent assignment.
62018
+ * @summary Get experiment assignments for a user
62019
+ * @param {string} xStoreid Store ID
62020
+ * @param {string} xStoresecret Store read secret
62021
+ * @param {string} [xUserId] User ID (provide either x-user-id or x-anon-id)
62022
+ * @param {string} [xAnonId] Anonymous ID (provide either x-user-id or x-anon-id)
60551
62023
  * @param {*} [options] Override http request option.
60552
62024
  * @throws {RequiredError}
60553
- * @memberof SDKDocumentsApi
62025
+ * @memberof SDKExperimentsApi
60554
62026
  */
60555
- apiV1StoresXStoreIDDocumentsBulkPost(xStoreid: string, xStoreWriteSecret: string, xStoreID: string, dataTypesBulkDocumentRequest: DataTypesBulkDocumentRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesBulkDocumentResponseWrapper, any, {}>>;
62027
+ v1ExperimentsAssignmentGet(xStoreid: string, xStoresecret: string, xUserId?: string, xAnonId?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesExperimentAssignmentResponse, any, {}>>;
62028
+ }
62029
+ /**
62030
+ * SearchApi - axios parameter creator
62031
+ * @export
62032
+ */
62033
+ export declare const SearchApiAxiosParamCreator: (configuration?: Configuration) => {
60556
62034
  /**
60557
- * 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.
60558
- * @summary Delete a document
60559
- * @param {string} xStoreid Store ID (from dashboard)
60560
- * @param {string} xStoreWriteSecret Store write secret
60561
- * @param {string} xStoreID Store ID (must match x-storeid header)
60562
- * @param {string} documentID Document ID to delete
62035
+ * Search documents with combined widget and document data, autocomplete suggestions, and configurable stopwords/synonyms
62036
+ * @summary Admin Search API
62037
+ * @param {string} xStoreID X-Store ID
62038
+ * @param {DataTypesAdminSearchRequest} dataTypesAdminSearchRequest Admin search request with optional stopword_sets and synonym_sets for granular control
60563
62039
  * @param {*} [options] Override http request option.
60564
62040
  * @throws {RequiredError}
60565
- * @memberof SDKDocumentsApi
60566
62041
  */
60567
- apiV1StoresXStoreIDDocumentsDocumentIDDelete(xStoreid: string, xStoreWriteSecret: string, xStoreID: string, documentID: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesDocumentResponseWrapper, any, {}>>;
62042
+ adminV1SearchXStoreIDPost: (xStoreID: string, dataTypesAdminSearchRequest: DataTypesAdminSearchRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
60568
62043
  /**
60569
- * 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.
60570
- * @summary Index a single document
60571
- * @param {string} xStoreid Store ID (from dashboard)
60572
- * @param {string} xStoreWriteSecret Store write secret
60573
- * @param {string} xStoreID Store ID (must match x-storeid header)
60574
- * @param {DataTypesDocumentRequest} dataTypesDocumentRequest Document fields to index
62044
+ * Get metadata about all configurable fields for dynamic form generation
62045
+ * @summary Get Configuration Schema
62046
+ * @param {string} [indexname] Index name to get field options from
60575
62047
  * @param {*} [options] Override http request option.
60576
62048
  * @throws {RequiredError}
60577
- * @memberof SDKDocumentsApi
60578
62049
  */
60579
- apiV1StoresXStoreIDDocumentsPost(xStoreid: string, xStoreWriteSecret: string, xStoreID: string, dataTypesDocumentRequest: DataTypesDocumentRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesDocumentResponseWrapper, any, {}>>;
60580
- }
60581
- /**
60582
- * SDKQuerySuggestionsConfigApi - axios parameter creator
60583
- * @export
60584
- */
60585
- export declare const SDKQuerySuggestionsConfigApiAxiosParamCreator: (configuration?: Configuration) => {
62050
+ v1IndexConfigSchemaGet: (indexname?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
60586
62051
  /**
60587
- * Returns autocomplete/suggestions configuration for the store. **Auth:** `x-storeid` and `x-storesecret`. Path `xStoreID` must match the `x-storeid` header.
60588
- * @summary Get query suggestions configuration
60589
- * @param {string} xStoreid Store ID (from dashboard)
60590
- * @param {string} xStoresecret Store read secret
60591
- * @param {string} xStoreID Store ID (must match x-storeid header)
62052
+ * Get the current index configuration
62053
+ * @summary Get Index Config
62054
+ * @param {string} indexname Index Name
60592
62055
  * @param {*} [options] Override http request option.
60593
62056
  * @throws {RequiredError}
60594
62057
  */
60595
- apiV1StoresXStoreIDQuerySuggestionsConfigGet: (xStoreid: string, xStoresecret: string, xStoreID: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
62058
+ v1IndexIndexnameConfigGet: (indexname: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
60596
62059
  /**
60597
- * 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.
60598
- * @summary Update query suggestions configuration
60599
- * @param {string} xStoreid Store ID (from dashboard)
60600
- * @param {string} xStoreWriteSecret Store write secret
60601
- * @param {string} xStoreID Store ID (must match x-storeid header)
60602
- * @param {QuerySuggestionsServiceUpdateSuggestionConfigRequest} querySuggestionsServiceUpdateSuggestionConfigRequest Fields to update (partial)
62060
+ * Configure the index for search
62061
+ * @summary Index Config
62062
+ * @param {string} indexname Index Name
62063
+ * @param {DataTypesIndexConfig} dataTypesIndexConfig Index configuration
60603
62064
  * @param {*} [options] Override http request option.
60604
62065
  * @throws {RequiredError}
60605
62066
  */
60606
- apiV1StoresXStoreIDQuerySuggestionsConfigPut: (xStoreid: string, xStoreWriteSecret: string, xStoreID: string, querySuggestionsServiceUpdateSuggestionConfigRequest: QuerySuggestionsServiceUpdateSuggestionConfigRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
60607
- };
60608
- /**
60609
- * SDKQuerySuggestionsConfigApi - functional programming interface
60610
- * @export
60611
- */
60612
- export declare const SDKQuerySuggestionsConfigApiFp: (configuration?: Configuration) => {
62067
+ v1IndexIndexnameConfigPost: (indexname: string, dataTypesIndexConfig: DataTypesIndexConfig, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
60613
62068
  /**
60614
- * Returns autocomplete/suggestions configuration for the store. **Auth:** `x-storeid` and `x-storesecret`. Path `xStoreID` must match the `x-storeid` header.
60615
- * @summary Get query suggestions configuration
60616
- * @param {string} xStoreid Store ID (from dashboard)
60617
- * @param {string} xStoresecret Store read secret
60618
- * @param {string} xStoreID Store ID (must match x-storeid header)
62069
+ * Update a single property of the index configuration
62070
+ * @summary Update Index Config Property
62071
+ * @param {string} indexname Index Name
62072
+ * @param {string} property Property name
62073
+ * @param {object} body Property value
60619
62074
  * @param {*} [options] Override http request option.
60620
62075
  * @throws {RequiredError}
60621
62076
  */
60622
- apiV1StoresXStoreIDQuerySuggestionsConfigGet(xStoreid: string, xStoresecret: string, xStoreID: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<QuerySuggestionsServiceQuerySuggestionsAPIResponse>>;
62077
+ v1IndexIndexnameConfigPropertyPatch: (indexname: string, property: string, body: object, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
60623
62078
  /**
60624
- * 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.
60625
- * @summary Update query suggestions configuration
60626
- * @param {string} xStoreid Store ID (from dashboard)
60627
- * @param {string} xStoreWriteSecret Store write secret
60628
- * @param {string} xStoreID Store ID (must match x-storeid header)
60629
- * @param {QuerySuggestionsServiceUpdateSuggestionConfigRequest} querySuggestionsServiceUpdateSuggestionConfigRequest Fields to update (partial)
62079
+ * Get default configuration values computed from the Typesense schema
62080
+ * @summary Get Schema-Based Defaults
62081
+ * @param {string} indexname Index Name
60630
62082
  * @param {*} [options] Override http request option.
60631
62083
  * @throws {RequiredError}
60632
62084
  */
60633
- apiV1StoresXStoreIDQuerySuggestionsConfigPut(xStoreid: string, xStoreWriteSecret: string, xStoreID: string, querySuggestionsServiceUpdateSuggestionConfigRequest: QuerySuggestionsServiceUpdateSuggestionConfigRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<QuerySuggestionsServiceQuerySuggestionsAPIResponse>>;
60634
- };
60635
- /**
60636
- * SDKQuerySuggestionsConfigApi - factory interface
60637
- * @export
60638
- */
60639
- export declare const SDKQuerySuggestionsConfigApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
62085
+ v1IndexIndexnameDefaultsGet: (indexname: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
60640
62086
  /**
60641
- * Returns autocomplete/suggestions configuration for the store. **Auth:** `x-storeid` and `x-storesecret`. Path `xStoreID` must match the `x-storeid` header.
60642
- * @summary Get query suggestions configuration
62087
+ * 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.
62088
+ * @summary Search (GET)
60643
62089
  * @param {string} xStoreid Store ID (from dashboard)
60644
- * @param {string} xStoresecret Store read secret
60645
- * @param {string} xStoreID Store ID (must match x-storeid header)
62090
+ * @param {string} xStoresecret Store read secret (from dashboard)
62091
+ * @param {string} q Search query
62092
+ * @param {string} [xUserId] User ID for personalization
62093
+ * @param {string} [xAnonId] Anonymous user ID for personalization
62094
+ * @param {string} [xSessionId] Session ID for personalization
62095
+ * @param {number} [page] Page number (default: 1)
62096
+ * @param {number} [perPage] Items per page (default: 10)
62097
+ * @param {string} [sortBy] Sort option (e.g., price:asc, created_at:desc)
62098
+ * @param {string} [filterBy] Filter string (e.g., category:shirts)
62099
+ * @param {string} [facetBy] Facet fields (comma-separated)
62100
+ * @param {number} [maxFacetValues] Maximum facet values to return
62101
+ * @param {boolean} [widgetMode] Return widget-formatted results
62102
+ * @param {boolean} [includeSuggestions] Include autocomplete suggestions
62103
+ * @param {number} [suggestionsLimit] Number of suggestions to return
62104
+ * @param {string} [analyticsTags] Analytics tags (comma-separated)
62105
+ * @param {string} [stopwordSets] Stopword set IDs (comma-separated)
62106
+ * @param {string} [synonymSets] Synonym set IDs (comma-separated)
62107
+ * @param {string} [searchFields] Fields to search in (comma-separated)
62108
+ * @param {string} [returnFields] Fields to return (comma-separated)
62109
+ * @param {string} [omitFields] Fields to omit (comma-separated)
62110
+ * @param {string} [snippetFields] Fields to generate snippets for (comma-separated)
62111
+ * @param {string} [fullSnippetFields] Fields to include full snippet (comma-separated)
62112
+ * @param {string} [fieldWeights] Field weights as comma-separated integers (e.g., 3,2,1)
62113
+ * @param {string} [groupField] Field to group results by
62114
+ * @param {number} [groupSize] Number of results per group
62115
+ * @param {string} [snippetPrefix] Prefix for highlighted snippets
62116
+ * @param {string} [snippetSuffix] Suffix for highlighted snippets
62117
+ * @param {number} [snippetTokenLimit] Maximum tokens in snippet
62118
+ * @param {number} [snippetMinLen] Minimum snippet length
62119
+ * @param {boolean} [includeSnippets] Include snippets in results
62120
+ * @param {string} [prefixMode] Prefix matching mode (e.g., always, fallback, off)
62121
+ * @param {string} [infixMode] Infix matching mode (e.g., always, fallback, off)
62122
+ * @param {number} [typoMax] Maximum typo tolerance
62123
+ * @param {number} [typoMinLen1] Min word length for 1 typo
62124
+ * @param {number} [typoMinLen2] Min word length for 2 typos
62125
+ * @param {number} [searchTimeoutMs] Search timeout in milliseconds
62126
+ * @param {boolean} [requireAllTerms] Require all search terms to match
62127
+ * @param {boolean} [exactMatchBoost] Boost exact matches
62128
+ * @param {boolean} [cacheResults] Cache search results
62129
+ * @param {boolean} [applyRules] Apply search rules
62130
+ * @param {string} [presetName] Search preset name to use
62131
+ * @param {string} [facetSearchText] Text to filter facet values
60646
62132
  * @param {*} [options] Override http request option.
60647
62133
  * @throws {RequiredError}
60648
62134
  */
60649
- apiV1StoresXStoreIDQuerySuggestionsConfigGet(xStoreid: string, xStoresecret: string, xStoreID: string, options?: RawAxiosRequestConfig): AxiosPromise<QuerySuggestionsServiceQuerySuggestionsAPIResponse>;
62135
+ 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>;
60650
62136
  /**
60651
- * 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.
60652
- * @summary Update query suggestions configuration
62137
+ * 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.
62138
+ * @summary Search (POST)
60653
62139
  * @param {string} xStoreid Store ID (from dashboard)
60654
- * @param {string} xStoreWriteSecret Store write secret
60655
- * @param {string} xStoreID Store ID (must match x-storeid header)
60656
- * @param {QuerySuggestionsServiceUpdateSuggestionConfigRequest} querySuggestionsServiceUpdateSuggestionConfigRequest Fields to update (partial)
62140
+ * @param {string} xStoresecret Store read secret (from dashboard)
62141
+ * @param {DataTypesPublicSearchRequest} dataTypesPublicSearchRequest Search query, filters, pagination, and options
62142
+ * @param {string} [xUserId] User ID for personalization
62143
+ * @param {string} [xAnonId] Anonymous user ID for personalization
62144
+ * @param {string} [xSessionId] Session ID for personalization
60657
62145
  * @param {*} [options] Override http request option.
60658
62146
  * @throws {RequiredError}
60659
62147
  */
60660
- apiV1StoresXStoreIDQuerySuggestionsConfigPut(xStoreid: string, xStoreWriteSecret: string, xStoreID: string, querySuggestionsServiceUpdateSuggestionConfigRequest: QuerySuggestionsServiceUpdateSuggestionConfigRequest, options?: RawAxiosRequestConfig): AxiosPromise<QuerySuggestionsServiceQuerySuggestionsAPIResponse>;
62148
+ v1SearchPost: (xStoreid: string, xStoresecret: string, dataTypesPublicSearchRequest: DataTypesPublicSearchRequest, xUserId?: string, xAnonId?: string, xSessionId?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
60661
62149
  };
60662
62150
  /**
60663
- * SDKQuerySuggestionsConfigApi - object-oriented interface
62151
+ * SearchApi - functional programming interface
60664
62152
  * @export
60665
- * @class SDKQuerySuggestionsConfigApi
60666
- * @extends {BaseAPI}
60667
62153
  */
60668
- export declare class SDKQuerySuggestionsConfigApi extends BaseAPI {
62154
+ export declare const SearchApiFp: (configuration?: Configuration) => {
60669
62155
  /**
60670
- * Returns autocomplete/suggestions configuration for the store. **Auth:** `x-storeid` and `x-storesecret`. Path `xStoreID` must match the `x-storeid` header.
60671
- * @summary Get query suggestions configuration
60672
- * @param {string} xStoreid Store ID (from dashboard)
60673
- * @param {string} xStoresecret Store read secret
60674
- * @param {string} xStoreID Store ID (must match x-storeid header)
62156
+ * Search documents with combined widget and document data, autocomplete suggestions, and configurable stopwords/synonyms
62157
+ * @summary Admin Search API
62158
+ * @param {string} xStoreID X-Store ID
62159
+ * @param {DataTypesAdminSearchRequest} dataTypesAdminSearchRequest Admin search request with optional stopword_sets and synonym_sets for granular control
60675
62160
  * @param {*} [options] Override http request option.
60676
62161
  * @throws {RequiredError}
60677
- * @memberof SDKQuerySuggestionsConfigApi
60678
62162
  */
60679
- apiV1StoresXStoreIDQuerySuggestionsConfigGet(xStoreid: string, xStoresecret: string, xStoreID: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<QuerySuggestionsServiceQuerySuggestionsAPIResponse, any, {}>>;
62163
+ adminV1SearchXStoreIDPost(xStoreID: string, dataTypesAdminSearchRequest: DataTypesAdminSearchRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesCombinedSearchResponseWrapper>>;
60680
62164
  /**
60681
- * 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.
60682
- * @summary Update query suggestions configuration
60683
- * @param {string} xStoreid Store ID (from dashboard)
60684
- * @param {string} xStoreWriteSecret Store write secret
60685
- * @param {string} xStoreID Store ID (must match x-storeid header)
60686
- * @param {QuerySuggestionsServiceUpdateSuggestionConfigRequest} querySuggestionsServiceUpdateSuggestionConfigRequest Fields to update (partial)
62165
+ * Get metadata about all configurable fields for dynamic form generation
62166
+ * @summary Get Configuration Schema
62167
+ * @param {string} [indexname] Index name to get field options from
60687
62168
  * @param {*} [options] Override http request option.
60688
62169
  * @throws {RequiredError}
60689
- * @memberof SDKQuerySuggestionsConfigApi
60690
62170
  */
60691
- apiV1StoresXStoreIDQuerySuggestionsConfigPut(xStoreid: string, xStoreWriteSecret: string, xStoreID: string, querySuggestionsServiceUpdateSuggestionConfigRequest: QuerySuggestionsServiceUpdateSuggestionConfigRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<QuerySuggestionsServiceQuerySuggestionsAPIResponse, any, {}>>;
60692
- }
60693
- /**
60694
- * SDKSchemaApi - axios parameter creator
60695
- * @export
60696
- */
60697
- export declare const SDKSchemaApiAxiosParamCreator: (configuration?: Configuration) => {
62171
+ v1IndexConfigSchemaGet(indexname?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesConfigurationSchemaResponseWrapper>>;
60698
62172
  /**
60699
- * 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.
60700
- * @summary Clear all documents
60701
- * @param {string} xStoreid Store ID (from dashboard)
60702
- * @param {string} xStoreWriteSecret Store write secret
60703
- * @param {string} xStoreID Store ID (must match x-storeid header)
62173
+ * Get the current index configuration
62174
+ * @summary Get Index Config
62175
+ * @param {string} indexname Index Name
60704
62176
  * @param {*} [options] Override http request option.
60705
62177
  * @throws {RequiredError}
60706
62178
  */
60707
- apiV1StoresXStoreIDDocumentsDelete: (xStoreid: string, xStoreWriteSecret: string, xStoreID: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
62179
+ v1IndexIndexnameConfigGet(indexname: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesIndexConfigResponseWrapper>>;
60708
62180
  /**
60709
- * 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.
60710
- * @summary Get index schema
60711
- * @param {string} xStoreid Store ID (from dashboard)
60712
- * @param {string} xStoresecret Store read secret
60713
- * @param {string} xStoreID Store ID (must match x-storeid header)
62181
+ * Configure the index for search
62182
+ * @summary Index Config
62183
+ * @param {string} indexname Index Name
62184
+ * @param {DataTypesIndexConfig} dataTypesIndexConfig Index configuration
60714
62185
  * @param {*} [options] Override http request option.
60715
62186
  * @throws {RequiredError}
60716
62187
  */
60717
- apiV1StoresXStoreIDSchemaGet: (xStoreid: string, xStoresecret: string, xStoreID: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
62188
+ v1IndexIndexnameConfigPost(indexname: string, dataTypesIndexConfig: DataTypesIndexConfig, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesResponse>>;
60718
62189
  /**
60719
- * 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.
60720
- * @summary Create or update index schema
60721
- * @param {string} xStoreid Store ID (from dashboard)
60722
- * @param {string} xStoreWriteSecret Store write secret
60723
- * @param {string} xStoreID Store ID (must match x-storeid header)
60724
- * @param {DataTypesCollectionSchemaRequest} dataTypesCollectionSchemaRequest Schema definition and mode
62190
+ * Update a single property of the index configuration
62191
+ * @summary Update Index Config Property
62192
+ * @param {string} indexname Index Name
62193
+ * @param {string} property Property name
62194
+ * @param {object} body Property value
60725
62195
  * @param {*} [options] Override http request option.
60726
62196
  * @throws {RequiredError}
60727
62197
  */
60728
- apiV1StoresXStoreIDSchemaPost: (xStoreid: string, xStoreWriteSecret: string, xStoreID: string, dataTypesCollectionSchemaRequest: DataTypesCollectionSchemaRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
60729
- };
60730
- /**
60731
- * SDKSchemaApi - functional programming interface
60732
- * @export
60733
- */
60734
- export declare const SDKSchemaApiFp: (configuration?: Configuration) => {
62198
+ v1IndexIndexnameConfigPropertyPatch(indexname: string, property: string, body: object, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesResponse>>;
60735
62199
  /**
60736
- * 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.
60737
- * @summary Clear all documents
60738
- * @param {string} xStoreid Store ID (from dashboard)
60739
- * @param {string} xStoreWriteSecret Store write secret
60740
- * @param {string} xStoreID Store ID (must match x-storeid header)
62200
+ * Get default configuration values computed from the Typesense schema
62201
+ * @summary Get Schema-Based Defaults
62202
+ * @param {string} indexname Index Name
60741
62203
  * @param {*} [options] Override http request option.
60742
62204
  * @throws {RequiredError}
60743
62205
  */
60744
- apiV1StoresXStoreIDDocumentsDelete(xStoreid: string, xStoreWriteSecret: string, xStoreID: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesClearDocumentsResponseWrapper>>;
60745
- /**
60746
- * 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.
60747
- * @summary Get index schema
60748
- * @param {string} xStoreid Store ID (from dashboard)
60749
- * @param {string} xStoresecret Store read secret
60750
- * @param {string} xStoreID Store ID (must match x-storeid header)
60751
- * @param {*} [options] Override http request option.
60752
- * @throws {RequiredError}
60753
- */
60754
- apiV1StoresXStoreIDSchemaGet(xStoreid: string, xStoresecret: string, xStoreID: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesSchemaResponseWrapper>>;
60755
- /**
60756
- * 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.
60757
- * @summary Create or update index schema
60758
- * @param {string} xStoreid Store ID (from dashboard)
60759
- * @param {string} xStoreWriteSecret Store write secret
60760
- * @param {string} xStoreID Store ID (must match x-storeid header)
60761
- * @param {DataTypesCollectionSchemaRequest} dataTypesCollectionSchemaRequest Schema definition and mode
60762
- * @param {*} [options] Override http request option.
60763
- * @throws {RequiredError}
60764
- */
60765
- apiV1StoresXStoreIDSchemaPost(xStoreid: string, xStoreWriteSecret: string, xStoreID: string, dataTypesCollectionSchemaRequest: DataTypesCollectionSchemaRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesSchemaResponseWrapper>>;
60766
- };
60767
- /**
60768
- * SDKSchemaApi - factory interface
60769
- * @export
60770
- */
60771
- export declare const SDKSchemaApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
60772
- /**
60773
- * 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.
60774
- * @summary Clear all documents
60775
- * @param {string} xStoreid Store ID (from dashboard)
60776
- * @param {string} xStoreWriteSecret Store write secret
60777
- * @param {string} xStoreID Store ID (must match x-storeid header)
60778
- * @param {*} [options] Override http request option.
60779
- * @throws {RequiredError}
60780
- */
60781
- apiV1StoresXStoreIDDocumentsDelete(xStoreid: string, xStoreWriteSecret: string, xStoreID: string, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesClearDocumentsResponseWrapper>;
60782
- /**
60783
- * 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.
60784
- * @summary Get index schema
60785
- * @param {string} xStoreid Store ID (from dashboard)
60786
- * @param {string} xStoresecret Store read secret
60787
- * @param {string} xStoreID Store ID (must match x-storeid header)
60788
- * @param {*} [options] Override http request option.
60789
- * @throws {RequiredError}
60790
- */
60791
- apiV1StoresXStoreIDSchemaGet(xStoreid: string, xStoresecret: string, xStoreID: string, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesSchemaResponseWrapper>;
60792
- /**
60793
- * 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.
60794
- * @summary Create or update index schema
60795
- * @param {string} xStoreid Store ID (from dashboard)
60796
- * @param {string} xStoreWriteSecret Store write secret
60797
- * @param {string} xStoreID Store ID (must match x-storeid header)
60798
- * @param {DataTypesCollectionSchemaRequest} dataTypesCollectionSchemaRequest Schema definition and mode
60799
- * @param {*} [options] Override http request option.
60800
- * @throws {RequiredError}
60801
- */
60802
- apiV1StoresXStoreIDSchemaPost(xStoreid: string, xStoreWriteSecret: string, xStoreID: string, dataTypesCollectionSchemaRequest: DataTypesCollectionSchemaRequest, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesSchemaResponseWrapper>;
60803
- };
60804
- /**
60805
- * SDKSchemaApi - object-oriented interface
60806
- * @export
60807
- * @class SDKSchemaApi
60808
- * @extends {BaseAPI}
60809
- */
60810
- export declare class SDKSchemaApi extends BaseAPI {
60811
- /**
60812
- * 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.
60813
- * @summary Clear all documents
60814
- * @param {string} xStoreid Store ID (from dashboard)
60815
- * @param {string} xStoreWriteSecret Store write secret
60816
- * @param {string} xStoreID Store ID (must match x-storeid header)
60817
- * @param {*} [options] Override http request option.
60818
- * @throws {RequiredError}
60819
- * @memberof SDKSchemaApi
60820
- */
60821
- apiV1StoresXStoreIDDocumentsDelete(xStoreid: string, xStoreWriteSecret: string, xStoreID: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesClearDocumentsResponseWrapper, any, {}>>;
60822
- /**
60823
- * 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.
60824
- * @summary Get index schema
60825
- * @param {string} xStoreid Store ID (from dashboard)
60826
- * @param {string} xStoresecret Store read secret
60827
- * @param {string} xStoreID Store ID (must match x-storeid header)
60828
- * @param {*} [options] Override http request option.
60829
- * @throws {RequiredError}
60830
- * @memberof SDKSchemaApi
60831
- */
60832
- apiV1StoresXStoreIDSchemaGet(xStoreid: string, xStoresecret: string, xStoreID: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesSchemaResponseWrapper, any, {}>>;
60833
- /**
60834
- * 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.
60835
- * @summary Create or update index schema
60836
- * @param {string} xStoreid Store ID (from dashboard)
60837
- * @param {string} xStoreWriteSecret Store write secret
60838
- * @param {string} xStoreID Store ID (must match x-storeid header)
60839
- * @param {DataTypesCollectionSchemaRequest} dataTypesCollectionSchemaRequest Schema definition and mode
60840
- * @param {*} [options] Override http request option.
60841
- * @throws {RequiredError}
60842
- * @memberof SDKSchemaApi
60843
- */
60844
- apiV1StoresXStoreIDSchemaPost(xStoreid: string, xStoreWriteSecret: string, xStoreID: string, dataTypesCollectionSchemaRequest: DataTypesCollectionSchemaRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesSchemaResponseWrapper, any, {}>>;
60845
- }
60846
- /**
60847
- * SDKStoreConfigApi - axios parameter creator
60848
- * @export
60849
- */
60850
- export declare const SDKStoreConfigApiAxiosParamCreator: (configuration?: Configuration) => {
60851
- /**
60852
- * Returns search and query-suggestions configuration for the store. **Auth:** `x-storeid` and `x-storesecret`. Path `xStoreID` must match the `x-storeid` header.
60853
- * @summary Get store configuration
60854
- * @param {string} xStoreid Store ID (from dashboard)
60855
- * @param {string} xStoresecret Store read secret
60856
- * @param {string} xStoreID Store ID (must match x-storeid header)
60857
- * @param {*} [options] Override http request option.
60858
- * @throws {RequiredError}
60859
- */
60860
- apiV1StoresXStoreIDConfigGet: (xStoreid: string, xStoresecret: string, xStoreID: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
60861
- /**
60862
- * Update search and store settings. Partial updates supported. **Auth:** `x-storeid` and `x-store-write-secret`. Path `xStoreID` must match the `x-storeid` header.
60863
- * @summary Update store configuration
60864
- * @param {string} xStoreid Store ID (from dashboard)
60865
- * @param {string} xStoreWriteSecret Store write secret
60866
- * @param {string} xStoreID Store ID (must match x-storeid header)
60867
- * @param {DataTypesIndexConfig} dataTypesIndexConfig Fields to update (partial)
60868
- * @param {*} [options] Override http request option.
60869
- * @throws {RequiredError}
60870
- */
60871
- apiV1StoresXStoreIDConfigPut: (xStoreid: string, xStoreWriteSecret: string, xStoreID: string, dataTypesIndexConfig: DataTypesIndexConfig, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
60872
- /**
60873
- * Returns metadata for all configurable store fields (types, defaults, validation). **Auth:** `x-storeid` and `x-storesecret`. Path `xStoreID` must match the `x-storeid` header.
60874
- * @summary Get store config schema
60875
- * @param {string} xStoreid Store ID (from dashboard)
60876
- * @param {string} xStoresecret Store read secret
60877
- * @param {string} xStoreID Store ID (must match x-storeid header)
60878
- * @param {*} [options] Override http request option.
60879
- * @throws {RequiredError}
60880
- */
60881
- apiV1StoresXStoreIDConfigSchemaGet: (xStoreid: string, xStoresecret: string, xStoreID: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
60882
- };
60883
- /**
60884
- * SDKStoreConfigApi - functional programming interface
60885
- * @export
60886
- */
60887
- export declare const SDKStoreConfigApiFp: (configuration?: Configuration) => {
60888
- /**
60889
- * Returns search and query-suggestions configuration for the store. **Auth:** `x-storeid` and `x-storesecret`. Path `xStoreID` must match the `x-storeid` header.
60890
- * @summary Get store configuration
60891
- * @param {string} xStoreid Store ID (from dashboard)
60892
- * @param {string} xStoresecret Store read secret
60893
- * @param {string} xStoreID Store ID (must match x-storeid header)
60894
- * @param {*} [options] Override http request option.
60895
- * @throws {RequiredError}
60896
- */
60897
- apiV1StoresXStoreIDConfigGet(xStoreid: string, xStoresecret: string, xStoreID: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesGenericResponseDataTypesStoreConfigWithOnboardingResponse>>;
60898
- /**
60899
- * Update search and store settings. Partial updates supported. **Auth:** `x-storeid` and `x-store-write-secret`. Path `xStoreID` must match the `x-storeid` header.
60900
- * @summary Update store configuration
60901
- * @param {string} xStoreid Store ID (from dashboard)
60902
- * @param {string} xStoreWriteSecret Store write secret
60903
- * @param {string} xStoreID Store ID (must match x-storeid header)
60904
- * @param {DataTypesIndexConfig} dataTypesIndexConfig Fields to update (partial)
60905
- * @param {*} [options] Override http request option.
60906
- * @throws {RequiredError}
60907
- */
60908
- apiV1StoresXStoreIDConfigPut(xStoreid: string, xStoreWriteSecret: string, xStoreID: string, dataTypesIndexConfig: DataTypesIndexConfig, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesIndexConfigResponseWrapper>>;
60909
- /**
60910
- * Returns metadata for all configurable store fields (types, defaults, validation). **Auth:** `x-storeid` and `x-storesecret`. Path `xStoreID` must match the `x-storeid` header.
60911
- * @summary Get store config schema
60912
- * @param {string} xStoreid Store ID (from dashboard)
60913
- * @param {string} xStoresecret Store read secret
60914
- * @param {string} xStoreID Store ID (must match x-storeid header)
60915
- * @param {*} [options] Override http request option.
60916
- * @throws {RequiredError}
60917
- */
60918
- apiV1StoresXStoreIDConfigSchemaGet(xStoreid: string, xStoresecret: string, xStoreID: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesConfigurationSchemaResponseWrapper>>;
60919
- };
60920
- /**
60921
- * SDKStoreConfigApi - factory interface
60922
- * @export
60923
- */
60924
- export declare const SDKStoreConfigApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
60925
- /**
60926
- * Returns search and query-suggestions configuration for the store. **Auth:** `x-storeid` and `x-storesecret`. Path `xStoreID` must match the `x-storeid` header.
60927
- * @summary Get store configuration
60928
- * @param {string} xStoreid Store ID (from dashboard)
60929
- * @param {string} xStoresecret Store read secret
60930
- * @param {string} xStoreID Store ID (must match x-storeid header)
60931
- * @param {*} [options] Override http request option.
60932
- * @throws {RequiredError}
60933
- */
60934
- apiV1StoresXStoreIDConfigGet(xStoreid: string, xStoresecret: string, xStoreID: string, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesGenericResponseDataTypesStoreConfigWithOnboardingResponse>;
60935
- /**
60936
- * Update search and store settings. Partial updates supported. **Auth:** `x-storeid` and `x-store-write-secret`. Path `xStoreID` must match the `x-storeid` header.
60937
- * @summary Update store configuration
60938
- * @param {string} xStoreid Store ID (from dashboard)
60939
- * @param {string} xStoreWriteSecret Store write secret
60940
- * @param {string} xStoreID Store ID (must match x-storeid header)
60941
- * @param {DataTypesIndexConfig} dataTypesIndexConfig Fields to update (partial)
60942
- * @param {*} [options] Override http request option.
60943
- * @throws {RequiredError}
60944
- */
60945
- apiV1StoresXStoreIDConfigPut(xStoreid: string, xStoreWriteSecret: string, xStoreID: string, dataTypesIndexConfig: DataTypesIndexConfig, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesIndexConfigResponseWrapper>;
60946
- /**
60947
- * Returns metadata for all configurable store fields (types, defaults, validation). **Auth:** `x-storeid` and `x-storesecret`. Path `xStoreID` must match the `x-storeid` header.
60948
- * @summary Get store config schema
60949
- * @param {string} xStoreid Store ID (from dashboard)
60950
- * @param {string} xStoresecret Store read secret
60951
- * @param {string} xStoreID Store ID (must match x-storeid header)
60952
- * @param {*} [options] Override http request option.
60953
- * @throws {RequiredError}
60954
- */
60955
- apiV1StoresXStoreIDConfigSchemaGet(xStoreid: string, xStoresecret: string, xStoreID: string, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesConfigurationSchemaResponseWrapper>;
60956
- };
60957
- /**
60958
- * SDKStoreConfigApi - object-oriented interface
60959
- * @export
60960
- * @class SDKStoreConfigApi
60961
- * @extends {BaseAPI}
60962
- */
60963
- export declare class SDKStoreConfigApi extends BaseAPI {
60964
- /**
60965
- * Returns search and query-suggestions configuration for the store. **Auth:** `x-storeid` and `x-storesecret`. Path `xStoreID` must match the `x-storeid` header.
60966
- * @summary Get store configuration
60967
- * @param {string} xStoreid Store ID (from dashboard)
60968
- * @param {string} xStoresecret Store read secret
60969
- * @param {string} xStoreID Store ID (must match x-storeid header)
60970
- * @param {*} [options] Override http request option.
60971
- * @throws {RequiredError}
60972
- * @memberof SDKStoreConfigApi
60973
- */
60974
- apiV1StoresXStoreIDConfigGet(xStoreid: string, xStoresecret: string, xStoreID: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesGenericResponseDataTypesStoreConfigWithOnboardingResponse, any, {}>>;
60975
- /**
60976
- * Update search and store settings. Partial updates supported. **Auth:** `x-storeid` and `x-store-write-secret`. Path `xStoreID` must match the `x-storeid` header.
60977
- * @summary Update store configuration
60978
- * @param {string} xStoreid Store ID (from dashboard)
60979
- * @param {string} xStoreWriteSecret Store write secret
60980
- * @param {string} xStoreID Store ID (must match x-storeid header)
60981
- * @param {DataTypesIndexConfig} dataTypesIndexConfig Fields to update (partial)
60982
- * @param {*} [options] Override http request option.
60983
- * @throws {RequiredError}
60984
- * @memberof SDKStoreConfigApi
60985
- */
60986
- apiV1StoresXStoreIDConfigPut(xStoreid: string, xStoreWriteSecret: string, xStoreID: string, dataTypesIndexConfig: DataTypesIndexConfig, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesIndexConfigResponseWrapper, any, {}>>;
60987
- /**
60988
- * Returns metadata for all configurable store fields (types, defaults, validation). **Auth:** `x-storeid` and `x-storesecret`. Path `xStoreID` must match the `x-storeid` header.
60989
- * @summary Get store config schema
60990
- * @param {string} xStoreid Store ID (from dashboard)
60991
- * @param {string} xStoresecret Store read secret
60992
- * @param {string} xStoreID Store ID (must match x-storeid header)
60993
- * @param {*} [options] Override http request option.
60994
- * @throws {RequiredError}
60995
- * @memberof SDKStoreConfigApi
60996
- */
60997
- apiV1StoresXStoreIDConfigSchemaGet(xStoreid: string, xStoresecret: string, xStoreID: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesConfigurationSchemaResponseWrapper, any, {}>>;
60998
- }
60999
- /**
61000
- * SDKStoreCreationApi - axios parameter creator
61001
- * @export
61002
- */
61003
- export declare const SDKStoreCreationApiAxiosParamCreator: (configuration?: Configuration) => {
61004
- /**
61005
- * Creates a new store with minimal information. Returns store credentials (xStoreID, xStoreSecret, xStoreWriteSecret) immediately. This is a public API for SDK integration. Requires JWT authentication.
61006
- * @summary Create Store (Public SDK API)
61007
- * @param {string} authorization Bearer JWT Token
61008
- * @param {DataTypesPublicCreateStoreRequest} dataTypesPublicCreateStoreRequest Store creation request
61009
- * @param {*} [options] Override http request option.
61010
- * @throws {RequiredError}
61011
- */
61012
- apiV1StoresPost: (authorization: string, dataTypesPublicCreateStoreRequest: DataTypesPublicCreateStoreRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
61013
- };
61014
- /**
61015
- * SDKStoreCreationApi - functional programming interface
61016
- * @export
61017
- */
61018
- export declare const SDKStoreCreationApiFp: (configuration?: Configuration) => {
61019
- /**
61020
- * Creates a new store with minimal information. Returns store credentials (xStoreID, xStoreSecret, xStoreWriteSecret) immediately. This is a public API for SDK integration. Requires JWT authentication.
61021
- * @summary Create Store (Public SDK API)
61022
- * @param {string} authorization Bearer JWT Token
61023
- * @param {DataTypesPublicCreateStoreRequest} dataTypesPublicCreateStoreRequest Store creation request
61024
- * @param {*} [options] Override http request option.
61025
- * @throws {RequiredError}
61026
- */
61027
- apiV1StoresPost(authorization: string, dataTypesPublicCreateStoreRequest: DataTypesPublicCreateStoreRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesGenericResponseDataTypesPublicCreateStoreResponse>>;
61028
- };
61029
- /**
61030
- * SDKStoreCreationApi - factory interface
61031
- * @export
61032
- */
61033
- export declare const SDKStoreCreationApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
61034
- /**
61035
- * Creates a new store with minimal information. Returns store credentials (xStoreID, xStoreSecret, xStoreWriteSecret) immediately. This is a public API for SDK integration. Requires JWT authentication.
61036
- * @summary Create Store (Public SDK API)
61037
- * @param {string} authorization Bearer JWT Token
61038
- * @param {DataTypesPublicCreateStoreRequest} dataTypesPublicCreateStoreRequest Store creation request
61039
- * @param {*} [options] Override http request option.
61040
- * @throws {RequiredError}
61041
- */
61042
- apiV1StoresPost(authorization: string, dataTypesPublicCreateStoreRequest: DataTypesPublicCreateStoreRequest, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesGenericResponseDataTypesPublicCreateStoreResponse>;
61043
- };
61044
- /**
61045
- * SDKStoreCreationApi - object-oriented interface
61046
- * @export
61047
- * @class SDKStoreCreationApi
61048
- * @extends {BaseAPI}
61049
- */
61050
- export declare class SDKStoreCreationApi extends BaseAPI {
61051
- /**
61052
- * Creates a new store with minimal information. Returns store credentials (xStoreID, xStoreSecret, xStoreWriteSecret) immediately. This is a public API for SDK integration. Requires JWT authentication.
61053
- * @summary Create Store (Public SDK API)
61054
- * @param {string} authorization Bearer JWT Token
61055
- * @param {DataTypesPublicCreateStoreRequest} dataTypesPublicCreateStoreRequest Store creation request
61056
- * @param {*} [options] Override http request option.
61057
- * @throws {RequiredError}
61058
- * @memberof SDKStoreCreationApi
61059
- */
61060
- apiV1StoresPost(authorization: string, dataTypesPublicCreateStoreRequest: DataTypesPublicCreateStoreRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesGenericResponseDataTypesPublicCreateStoreResponse, any, {}>>;
61061
- }
61062
- /**
61063
- * SDKStoreInfoApi - axios parameter creator
61064
- * @export
61065
- */
61066
- export declare const SDKStoreInfoApiAxiosParamCreator: (configuration?: Configuration) => {
61067
- /**
61068
- * Returns basic store details (name, location, status). **Auth:** `x-storeid` and `x-storesecret`. Path `xStoreID` must match the `x-storeid` header.
61069
- * @summary Get store info
61070
- * @param {string} xStoreid Store ID (from dashboard)
61071
- * @param {string} xStoresecret Store read secret
61072
- * @param {string} xStoreID Store ID (must match x-storeid header)
61073
- * @param {*} [options] Override http request option.
61074
- * @throws {RequiredError}
61075
- */
61076
- apiV1StoresXStoreIDGet: (xStoreid: string, xStoresecret: string, xStoreID: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
61077
- };
61078
- /**
61079
- * SDKStoreInfoApi - functional programming interface
61080
- * @export
61081
- */
61082
- export declare const SDKStoreInfoApiFp: (configuration?: Configuration) => {
61083
- /**
61084
- * Returns basic store details (name, location, status). **Auth:** `x-storeid` and `x-storesecret`. Path `xStoreID` must match the `x-storeid` header.
61085
- * @summary Get store info
61086
- * @param {string} xStoreid Store ID (from dashboard)
61087
- * @param {string} xStoresecret Store read secret
61088
- * @param {string} xStoreID Store ID (must match x-storeid header)
61089
- * @param {*} [options] Override http request option.
61090
- * @throws {RequiredError}
61091
- */
61092
- apiV1StoresXStoreIDGet(xStoreid: string, xStoresecret: string, xStoreID: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesGenericResponseDataTypesPublicStoreInfoResponse>>;
61093
- };
61094
- /**
61095
- * SDKStoreInfoApi - factory interface
61096
- * @export
61097
- */
61098
- export declare const SDKStoreInfoApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
61099
- /**
61100
- * Returns basic store details (name, location, status). **Auth:** `x-storeid` and `x-storesecret`. Path `xStoreID` must match the `x-storeid` header.
61101
- * @summary Get store info
61102
- * @param {string} xStoreid Store ID (from dashboard)
61103
- * @param {string} xStoresecret Store read secret
61104
- * @param {string} xStoreID Store ID (must match x-storeid header)
61105
- * @param {*} [options] Override http request option.
61106
- * @throws {RequiredError}
61107
- */
61108
- apiV1StoresXStoreIDGet(xStoreid: string, xStoresecret: string, xStoreID: string, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesGenericResponseDataTypesPublicStoreInfoResponse>;
61109
- };
61110
- /**
61111
- * SDKStoreInfoApi - object-oriented interface
61112
- * @export
61113
- * @class SDKStoreInfoApi
61114
- * @extends {BaseAPI}
61115
- */
61116
- export declare class SDKStoreInfoApi extends BaseAPI {
61117
- /**
61118
- * Returns basic store details (name, location, status). **Auth:** `x-storeid` and `x-storesecret`. Path `xStoreID` must match the `x-storeid` header.
61119
- * @summary Get store info
61120
- * @param {string} xStoreid Store ID (from dashboard)
61121
- * @param {string} xStoresecret Store read secret
61122
- * @param {string} xStoreID Store ID (must match x-storeid header)
61123
- * @param {*} [options] Override http request option.
61124
- * @throws {RequiredError}
61125
- * @memberof SDKStoreInfoApi
61126
- */
61127
- apiV1StoresXStoreIDGet(xStoreid: string, xStoresecret: string, xStoreID: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesGenericResponseDataTypesPublicStoreInfoResponse, any, {}>>;
61128
- }
61129
- /**
61130
- * SearchApi - axios parameter creator
61131
- * @export
61132
- */
61133
- export declare const SearchApiAxiosParamCreator: (configuration?: Configuration) => {
61134
- /**
61135
- * Search documents with combined widget and document data, autocomplete suggestions, and configurable stopwords/synonyms
61136
- * @summary Admin Search API
61137
- * @param {string} xStoreID X-Store ID
61138
- * @param {DataTypesAdminSearchRequest} dataTypesAdminSearchRequest Admin search request with optional stopword_sets and synonym_sets for granular control
61139
- * @param {*} [options] Override http request option.
61140
- * @throws {RequiredError}
61141
- */
61142
- adminV1SearchXStoreIDPost: (xStoreID: string, dataTypesAdminSearchRequest: DataTypesAdminSearchRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
61143
- /**
61144
- * Get metadata about all configurable fields for dynamic form generation
61145
- * @summary Get Configuration Schema
61146
- * @param {string} [indexname] Index name to get field options from
61147
- * @param {*} [options] Override http request option.
61148
- * @throws {RequiredError}
61149
- */
61150
- v1IndexConfigSchemaGet: (indexname?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
61151
- /**
61152
- * Get the current index configuration
61153
- * @summary Get Index Config
61154
- * @param {string} indexname Index Name
61155
- * @param {*} [options] Override http request option.
61156
- * @throws {RequiredError}
61157
- */
61158
- v1IndexIndexnameConfigGet: (indexname: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
61159
- /**
61160
- * Configure the index for search
61161
- * @summary Index Config
61162
- * @param {string} indexname Index Name
61163
- * @param {DataTypesIndexConfig} dataTypesIndexConfig Index configuration
61164
- * @param {*} [options] Override http request option.
61165
- * @throws {RequiredError}
61166
- */
61167
- v1IndexIndexnameConfigPost: (indexname: string, dataTypesIndexConfig: DataTypesIndexConfig, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
61168
- /**
61169
- * Update a single property of the index configuration
61170
- * @summary Update Index Config Property
61171
- * @param {string} indexname Index Name
61172
- * @param {string} property Property name
61173
- * @param {object} body Property value
61174
- * @param {*} [options] Override http request option.
61175
- * @throws {RequiredError}
61176
- */
61177
- v1IndexIndexnameConfigPropertyPatch: (indexname: string, property: string, body: object, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
61178
- /**
61179
- * Get default configuration values computed from the Typesense schema
61180
- * @summary Get Schema-Based Defaults
61181
- * @param {string} indexname Index Name
61182
- * @param {*} [options] Override http request option.
61183
- * @throws {RequiredError}
61184
- */
61185
- v1IndexIndexnameDefaultsGet: (indexname: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
62206
+ v1IndexIndexnameDefaultsGet(indexname: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesSchemaBasedDefaultsResponseWrapper>>;
61186
62207
  /**
61187
62208
  * 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.
61188
62209
  * @summary Search (GET)
@@ -61232,7 +62253,7 @@ export declare const SearchApiAxiosParamCreator: (configuration?: Configuration)
61232
62253
  * @param {*} [options] Override http request option.
61233
62254
  * @throws {RequiredError}
61234
62255
  */
61235
- 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>;
62256
+ 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>>;
61236
62257
  /**
61237
62258
  * 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.
61238
62259
  * @summary Search (POST)
@@ -61245,13 +62266,13 @@ export declare const SearchApiAxiosParamCreator: (configuration?: Configuration)
61245
62266
  * @param {*} [options] Override http request option.
61246
62267
  * @throws {RequiredError}
61247
62268
  */
61248
- v1SearchPost: (xStoreid: string, xStoresecret: string, dataTypesPublicSearchRequest: DataTypesPublicSearchRequest, xUserId?: string, xAnonId?: string, xSessionId?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
62269
+ v1SearchPost(xStoreid: string, xStoresecret: string, dataTypesPublicSearchRequest: DataTypesPublicSearchRequest, xUserId?: string, xAnonId?: string, xSessionId?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesOfficialSearchResponseWrapper>>;
61249
62270
  };
61250
62271
  /**
61251
- * SearchApi - functional programming interface
62272
+ * SearchApi - factory interface
61252
62273
  * @export
61253
62274
  */
61254
- export declare const SearchApiFp: (configuration?: Configuration) => {
62275
+ export declare const SearchApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
61255
62276
  /**
61256
62277
  * Search documents with combined widget and document data, autocomplete suggestions, and configurable stopwords/synonyms
61257
62278
  * @summary Admin Search API
@@ -61260,7 +62281,7 @@ export declare const SearchApiFp: (configuration?: Configuration) => {
61260
62281
  * @param {*} [options] Override http request option.
61261
62282
  * @throws {RequiredError}
61262
62283
  */
61263
- adminV1SearchXStoreIDPost(xStoreID: string, dataTypesAdminSearchRequest: DataTypesAdminSearchRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesCombinedSearchResponseWrapper>>;
62284
+ adminV1SearchXStoreIDPost(xStoreID: string, dataTypesAdminSearchRequest: DataTypesAdminSearchRequest, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesCombinedSearchResponseWrapper>;
61264
62285
  /**
61265
62286
  * Get metadata about all configurable fields for dynamic form generation
61266
62287
  * @summary Get Configuration Schema
@@ -61268,7 +62289,7 @@ export declare const SearchApiFp: (configuration?: Configuration) => {
61268
62289
  * @param {*} [options] Override http request option.
61269
62290
  * @throws {RequiredError}
61270
62291
  */
61271
- v1IndexConfigSchemaGet(indexname?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesConfigurationSchemaResponseWrapper>>;
62292
+ v1IndexConfigSchemaGet(indexname?: string, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesConfigurationSchemaResponseWrapper>;
61272
62293
  /**
61273
62294
  * Get the current index configuration
61274
62295
  * @summary Get Index Config
@@ -61276,7 +62297,7 @@ export declare const SearchApiFp: (configuration?: Configuration) => {
61276
62297
  * @param {*} [options] Override http request option.
61277
62298
  * @throws {RequiredError}
61278
62299
  */
61279
- v1IndexIndexnameConfigGet(indexname: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesIndexConfigResponseWrapper>>;
62300
+ v1IndexIndexnameConfigGet(indexname: string, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesIndexConfigResponseWrapper>;
61280
62301
  /**
61281
62302
  * Configure the index for search
61282
62303
  * @summary Index Config
@@ -61285,7 +62306,7 @@ export declare const SearchApiFp: (configuration?: Configuration) => {
61285
62306
  * @param {*} [options] Override http request option.
61286
62307
  * @throws {RequiredError}
61287
62308
  */
61288
- v1IndexIndexnameConfigPost(indexname: string, dataTypesIndexConfig: DataTypesIndexConfig, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesResponse>>;
62309
+ v1IndexIndexnameConfigPost(indexname: string, dataTypesIndexConfig: DataTypesIndexConfig, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesResponse>;
61289
62310
  /**
61290
62311
  * Update a single property of the index configuration
61291
62312
  * @summary Update Index Config Property
@@ -61295,7 +62316,7 @@ export declare const SearchApiFp: (configuration?: Configuration) => {
61295
62316
  * @param {*} [options] Override http request option.
61296
62317
  * @throws {RequiredError}
61297
62318
  */
61298
- v1IndexIndexnameConfigPropertyPatch(indexname: string, property: string, body: object, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesResponse>>;
62319
+ v1IndexIndexnameConfigPropertyPatch(indexname: string, property: string, body: object, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesResponse>;
61299
62320
  /**
61300
62321
  * Get default configuration values computed from the Typesense schema
61301
62322
  * @summary Get Schema-Based Defaults
@@ -61303,7 +62324,7 @@ export declare const SearchApiFp: (configuration?: Configuration) => {
61303
62324
  * @param {*} [options] Override http request option.
61304
62325
  * @throws {RequiredError}
61305
62326
  */
61306
- v1IndexIndexnameDefaultsGet(indexname: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesSchemaBasedDefaultsResponseWrapper>>;
62327
+ v1IndexIndexnameDefaultsGet(indexname: string, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesSchemaBasedDefaultsResponseWrapper>;
61307
62328
  /**
61308
62329
  * 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.
61309
62330
  * @summary Search (GET)
@@ -61353,7 +62374,7 @@ export declare const SearchApiFp: (configuration?: Configuration) => {
61353
62374
  * @param {*} [options] Override http request option.
61354
62375
  * @throws {RequiredError}
61355
62376
  */
61356
- 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>>;
62377
+ 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>;
61357
62378
  /**
61358
62379
  * 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.
61359
62380
  * @summary Search (POST)
@@ -61366,13 +62387,15 @@ export declare const SearchApiFp: (configuration?: Configuration) => {
61366
62387
  * @param {*} [options] Override http request option.
61367
62388
  * @throws {RequiredError}
61368
62389
  */
61369
- v1SearchPost(xStoreid: string, xStoresecret: string, dataTypesPublicSearchRequest: DataTypesPublicSearchRequest, xUserId?: string, xAnonId?: string, xSessionId?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesOfficialSearchResponseWrapper>>;
62390
+ v1SearchPost(xStoreid: string, xStoresecret: string, dataTypesPublicSearchRequest: DataTypesPublicSearchRequest, xUserId?: string, xAnonId?: string, xSessionId?: string, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesOfficialSearchResponseWrapper>;
61370
62391
  };
61371
62392
  /**
61372
- * SearchApi - factory interface
62393
+ * SearchApi - object-oriented interface
61373
62394
  * @export
62395
+ * @class SearchApi
62396
+ * @extends {BaseAPI}
61374
62397
  */
61375
- export declare const SearchApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
62398
+ export declare class SearchApi extends BaseAPI {
61376
62399
  /**
61377
62400
  * Search documents with combined widget and document data, autocomplete suggestions, and configurable stopwords/synonyms
61378
62401
  * @summary Admin Search API
@@ -61380,24 +62403,27 @@ export declare const SearchApiFactory: (configuration?: Configuration, basePath?
61380
62403
  * @param {DataTypesAdminSearchRequest} dataTypesAdminSearchRequest Admin search request with optional stopword_sets and synonym_sets for granular control
61381
62404
  * @param {*} [options] Override http request option.
61382
62405
  * @throws {RequiredError}
62406
+ * @memberof SearchApi
61383
62407
  */
61384
- adminV1SearchXStoreIDPost(xStoreID: string, dataTypesAdminSearchRequest: DataTypesAdminSearchRequest, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesCombinedSearchResponseWrapper>;
62408
+ adminV1SearchXStoreIDPost(xStoreID: string, dataTypesAdminSearchRequest: DataTypesAdminSearchRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesCombinedSearchResponseWrapper, any, {}>>;
61385
62409
  /**
61386
62410
  * Get metadata about all configurable fields for dynamic form generation
61387
62411
  * @summary Get Configuration Schema
61388
62412
  * @param {string} [indexname] Index name to get field options from
61389
62413
  * @param {*} [options] Override http request option.
61390
62414
  * @throws {RequiredError}
62415
+ * @memberof SearchApi
61391
62416
  */
61392
- v1IndexConfigSchemaGet(indexname?: string, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesConfigurationSchemaResponseWrapper>;
62417
+ v1IndexConfigSchemaGet(indexname?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesConfigurationSchemaResponseWrapper, any, {}>>;
61393
62418
  /**
61394
62419
  * Get the current index configuration
61395
62420
  * @summary Get Index Config
61396
62421
  * @param {string} indexname Index Name
61397
62422
  * @param {*} [options] Override http request option.
61398
62423
  * @throws {RequiredError}
62424
+ * @memberof SearchApi
61399
62425
  */
61400
- v1IndexIndexnameConfigGet(indexname: string, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesIndexConfigResponseWrapper>;
62426
+ v1IndexIndexnameConfigGet(indexname: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesIndexConfigResponseWrapper, any, {}>>;
61401
62427
  /**
61402
62428
  * Configure the index for search
61403
62429
  * @summary Index Config
@@ -61405,8 +62431,9 @@ export declare const SearchApiFactory: (configuration?: Configuration, basePath?
61405
62431
  * @param {DataTypesIndexConfig} dataTypesIndexConfig Index configuration
61406
62432
  * @param {*} [options] Override http request option.
61407
62433
  * @throws {RequiredError}
62434
+ * @memberof SearchApi
61408
62435
  */
61409
- v1IndexIndexnameConfigPost(indexname: string, dataTypesIndexConfig: DataTypesIndexConfig, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesResponse>;
62436
+ v1IndexIndexnameConfigPost(indexname: string, dataTypesIndexConfig: DataTypesIndexConfig, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesResponse, any, {}>>;
61410
62437
  /**
61411
62438
  * Update a single property of the index configuration
61412
62439
  * @summary Update Index Config Property
@@ -61415,16 +62442,18 @@ export declare const SearchApiFactory: (configuration?: Configuration, basePath?
61415
62442
  * @param {object} body Property value
61416
62443
  * @param {*} [options] Override http request option.
61417
62444
  * @throws {RequiredError}
62445
+ * @memberof SearchApi
61418
62446
  */
61419
- v1IndexIndexnameConfigPropertyPatch(indexname: string, property: string, body: object, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesResponse>;
62447
+ v1IndexIndexnameConfigPropertyPatch(indexname: string, property: string, body: object, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesResponse, any, {}>>;
61420
62448
  /**
61421
62449
  * Get default configuration values computed from the Typesense schema
61422
62450
  * @summary Get Schema-Based Defaults
61423
62451
  * @param {string} indexname Index Name
61424
62452
  * @param {*} [options] Override http request option.
61425
62453
  * @throws {RequiredError}
62454
+ * @memberof SearchApi
61426
62455
  */
61427
- v1IndexIndexnameDefaultsGet(indexname: string, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesSchemaBasedDefaultsResponseWrapper>;
62456
+ v1IndexIndexnameDefaultsGet(indexname: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesSchemaBasedDefaultsResponseWrapper, any, {}>>;
61428
62457
  /**
61429
62458
  * 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.
61430
62459
  * @summary Search (GET)
@@ -61473,8 +62502,9 @@ export declare const SearchApiFactory: (configuration?: Configuration, basePath?
61473
62502
  * @param {string} [facetSearchText] Text to filter facet values
61474
62503
  * @param {*} [options] Override http request option.
61475
62504
  * @throws {RequiredError}
62505
+ * @memberof SearchApi
61476
62506
  */
61477
- 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>;
62507
+ 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, {}>>;
61478
62508
  /**
61479
62509
  * 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.
61480
62510
  * @summary Search (POST)
@@ -61486,185 +62516,55 @@ export declare const SearchApiFactory: (configuration?: Configuration, basePath?
61486
62516
  * @param {string} [xSessionId] Session ID for personalization
61487
62517
  * @param {*} [options] Override http request option.
61488
62518
  * @throws {RequiredError}
62519
+ * @memberof SearchApi
61489
62520
  */
61490
- v1SearchPost(xStoreid: string, xStoresecret: string, dataTypesPublicSearchRequest: DataTypesPublicSearchRequest, xUserId?: string, xAnonId?: string, xSessionId?: string, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesOfficialSearchResponseWrapper>;
61491
- };
62521
+ v1SearchPost(xStoreid: string, xStoresecret: string, dataTypesPublicSearchRequest: DataTypesPublicSearchRequest, xUserId?: string, xAnonId?: string, xSessionId?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesOfficialSearchResponseWrapper, any, {}>>;
62522
+ }
61492
62523
  /**
61493
- * SearchApi - object-oriented interface
62524
+ * StopwordsApi - axios parameter creator
61494
62525
  * @export
61495
- * @class SearchApi
61496
- * @extends {BaseAPI}
61497
62526
  */
61498
- export declare class SearchApi extends BaseAPI {
62527
+ export declare const StopwordsApiAxiosParamCreator: (configuration?: Configuration) => {
61499
62528
  /**
61500
- * Search documents with combined widget and document data, autocomplete suggestions, and configurable stopwords/synonyms
61501
- * @summary Admin Search API
61502
- * @param {string} xStoreID X-Store ID
61503
- * @param {DataTypesAdminSearchRequest} dataTypesAdminSearchRequest Admin search request with optional stopword_sets and synonym_sets for granular control
62529
+ * Fetches available languages/locales with pagination
62530
+ * @summary Get available languages
62531
+ * @param {string} [type] Type filter (stopwords, synonyms)
62532
+ * @param {number} [page] Page number (default: 1)
62533
+ * @param {number} [limit] Items per page (default: 10)
61504
62534
  * @param {*} [options] Override http request option.
61505
62535
  * @throws {RequiredError}
61506
- * @memberof SearchApi
61507
62536
  */
61508
- adminV1SearchXStoreIDPost(xStoreID: string, dataTypesAdminSearchRequest: DataTypesAdminSearchRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesCombinedSearchResponseWrapper, any, {}>>;
62537
+ adminStoresStopwordsLanguagesGet: (type?: string, page?: number, limit?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
61509
62538
  /**
61510
- * Get metadata about all configurable fields for dynamic form generation
61511
- * @summary Get Configuration Schema
61512
- * @param {string} [indexname] Index name to get field options from
62539
+ * Enables or disables a specific word for a store. Supports default words, store-specific words, and custom words.
62540
+ * @summary Update word status for store
62541
+ * @param {string} xStoreID X-Store ID
62542
+ * @param {DataTypesUpdateWordStatusRequest} dataTypesUpdateWordStatusRequest Word status update request. Use wordid for default words, store_language_wordid for store-specific words, or custom_wordid for custom words. Set word_type accordingly.
61513
62543
  * @param {*} [options] Override http request option.
61514
62544
  * @throws {RequiredError}
61515
- * @memberof SearchApi
61516
62545
  */
61517
- v1IndexConfigSchemaGet(indexname?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesConfigurationSchemaResponseWrapper, any, {}>>;
62546
+ adminStoresXStoreIDStopwordsWordStatusPut: (xStoreID: string, dataTypesUpdateWordStatusRequest: DataTypesUpdateWordStatusRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
61518
62547
  /**
61519
- * Get the current index configuration
61520
- * @summary Get Index Config
61521
- * @param {string} indexname Index Name
62548
+ * Fetches a single word list by language with pagination on words within the wordlist
62549
+ * @summary Get word lists by language
62550
+ * @param {string} xStoreID X-Store ID
62551
+ * @param {string} [lang] Language locale filter (e.g. \&#39;en\&#39;, \&#39;ar\&#39;)
62552
+ * @param {string} [type] Type filter (stopwords, synonyms)
62553
+ * @param {number} [page] Page number (default: 1)
62554
+ * @param {number} [limit] Items per page (default: 10)
61522
62555
  * @param {*} [options] Override http request option.
61523
62556
  * @throws {RequiredError}
61524
- * @memberof SearchApi
61525
62557
  */
61526
- v1IndexIndexnameConfigGet(indexname: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesIndexConfigResponseWrapper, any, {}>>;
62558
+ adminStoresXStoreIDStopwordsWordlistsGet: (xStoreID: string, lang?: string, type?: string, page?: number, limit?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
61527
62559
  /**
61528
- * Configure the index for search
61529
- * @summary Index Config
61530
- * @param {string} indexname Index Name
61531
- * @param {DataTypesIndexConfig} dataTypesIndexConfig Index configuration
61532
- * @param {*} [options] Override http request option.
61533
- * @throws {RequiredError}
61534
- * @memberof SearchApi
61535
- */
61536
- v1IndexIndexnameConfigPost(indexname: string, dataTypesIndexConfig: DataTypesIndexConfig, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesResponse, any, {}>>;
61537
- /**
61538
- * Update a single property of the index configuration
61539
- * @summary Update Index Config Property
61540
- * @param {string} indexname Index Name
61541
- * @param {string} property Property name
61542
- * @param {object} body Property value
61543
- * @param {*} [options] Override http request option.
61544
- * @throws {RequiredError}
61545
- * @memberof SearchApi
61546
- */
61547
- v1IndexIndexnameConfigPropertyPatch(indexname: string, property: string, body: object, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesResponse, any, {}>>;
61548
- /**
61549
- * Get default configuration values computed from the Typesense schema
61550
- * @summary Get Schema-Based Defaults
61551
- * @param {string} indexname Index Name
61552
- * @param {*} [options] Override http request option.
61553
- * @throws {RequiredError}
61554
- * @memberof SearchApi
61555
- */
61556
- v1IndexIndexnameDefaultsGet(indexname: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesSchemaBasedDefaultsResponseWrapper, any, {}>>;
61557
- /**
61558
- * 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.
61559
- * @summary Search (GET)
61560
- * @param {string} xStoreid Store ID (from dashboard)
61561
- * @param {string} xStoresecret Store read secret (from dashboard)
61562
- * @param {string} q Search query
61563
- * @param {string} [xUserId] User ID for personalization
61564
- * @param {string} [xAnonId] Anonymous user ID for personalization
61565
- * @param {string} [xSessionId] Session ID for personalization
61566
- * @param {number} [page] Page number (default: 1)
61567
- * @param {number} [perPage] Items per page (default: 10)
61568
- * @param {string} [sortBy] Sort option (e.g., price:asc, created_at:desc)
61569
- * @param {string} [filterBy] Filter string (e.g., category:shirts)
61570
- * @param {string} [facetBy] Facet fields (comma-separated)
61571
- * @param {number} [maxFacetValues] Maximum facet values to return
61572
- * @param {boolean} [widgetMode] Return widget-formatted results
61573
- * @param {boolean} [includeSuggestions] Include autocomplete suggestions
61574
- * @param {number} [suggestionsLimit] Number of suggestions to return
61575
- * @param {string} [analyticsTags] Analytics tags (comma-separated)
61576
- * @param {string} [stopwordSets] Stopword set IDs (comma-separated)
61577
- * @param {string} [synonymSets] Synonym set IDs (comma-separated)
61578
- * @param {string} [searchFields] Fields to search in (comma-separated)
61579
- * @param {string} [returnFields] Fields to return (comma-separated)
61580
- * @param {string} [omitFields] Fields to omit (comma-separated)
61581
- * @param {string} [snippetFields] Fields to generate snippets for (comma-separated)
61582
- * @param {string} [fullSnippetFields] Fields to include full snippet (comma-separated)
61583
- * @param {string} [fieldWeights] Field weights as comma-separated integers (e.g., 3,2,1)
61584
- * @param {string} [groupField] Field to group results by
61585
- * @param {number} [groupSize] Number of results per group
61586
- * @param {string} [snippetPrefix] Prefix for highlighted snippets
61587
- * @param {string} [snippetSuffix] Suffix for highlighted snippets
61588
- * @param {number} [snippetTokenLimit] Maximum tokens in snippet
61589
- * @param {number} [snippetMinLen] Minimum snippet length
61590
- * @param {boolean} [includeSnippets] Include snippets in results
61591
- * @param {string} [prefixMode] Prefix matching mode (e.g., always, fallback, off)
61592
- * @param {string} [infixMode] Infix matching mode (e.g., always, fallback, off)
61593
- * @param {number} [typoMax] Maximum typo tolerance
61594
- * @param {number} [typoMinLen1] Min word length for 1 typo
61595
- * @param {number} [typoMinLen2] Min word length for 2 typos
61596
- * @param {number} [searchTimeoutMs] Search timeout in milliseconds
61597
- * @param {boolean} [requireAllTerms] Require all search terms to match
61598
- * @param {boolean} [exactMatchBoost] Boost exact matches
61599
- * @param {boolean} [cacheResults] Cache search results
61600
- * @param {boolean} [applyRules] Apply search rules
61601
- * @param {string} [presetName] Search preset name to use
61602
- * @param {string} [facetSearchText] Text to filter facet values
61603
- * @param {*} [options] Override http request option.
61604
- * @throws {RequiredError}
61605
- * @memberof SearchApi
61606
- */
61607
- 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, {}>>;
61608
- /**
61609
- * 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.
61610
- * @summary Search (POST)
61611
- * @param {string} xStoreid Store ID (from dashboard)
61612
- * @param {string} xStoresecret Store read secret (from dashboard)
61613
- * @param {DataTypesPublicSearchRequest} dataTypesPublicSearchRequest Search query, filters, pagination, and options
61614
- * @param {string} [xUserId] User ID for personalization
61615
- * @param {string} [xAnonId] Anonymous user ID for personalization
61616
- * @param {string} [xSessionId] Session ID for personalization
61617
- * @param {*} [options] Override http request option.
61618
- * @throws {RequiredError}
61619
- * @memberof SearchApi
61620
- */
61621
- v1SearchPost(xStoreid: string, xStoresecret: string, dataTypesPublicSearchRequest: DataTypesPublicSearchRequest, xUserId?: string, xAnonId?: string, xSessionId?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesOfficialSearchResponseWrapper, any, {}>>;
61622
- }
61623
- /**
61624
- * StopwordsApi - axios parameter creator
61625
- * @export
61626
- */
61627
- export declare const StopwordsApiAxiosParamCreator: (configuration?: Configuration) => {
61628
- /**
61629
- * Fetches available languages/locales with pagination
61630
- * @summary Get available languages
61631
- * @param {string} [type] Type filter (stopwords, synonyms)
61632
- * @param {number} [page] Page number (default: 1)
61633
- * @param {number} [limit] Items per page (default: 10)
61634
- * @param {*} [options] Override http request option.
61635
- * @throws {RequiredError}
61636
- */
61637
- adminStoresStopwordsLanguagesGet: (type?: string, page?: number, limit?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
61638
- /**
61639
- * Enables or disables a specific word for a store. Supports default words, store-specific words, and custom words.
61640
- * @summary Update word status for store
61641
- * @param {string} xStoreID X-Store ID
61642
- * @param {DataTypesUpdateWordStatusRequest} dataTypesUpdateWordStatusRequest Word status update request. Use wordid for default words, store_language_wordid for store-specific words, or custom_wordid for custom words. Set word_type accordingly.
61643
- * @param {*} [options] Override http request option.
61644
- * @throws {RequiredError}
61645
- */
61646
- adminStoresXStoreIDStopwordsWordStatusPut: (xStoreID: string, dataTypesUpdateWordStatusRequest: DataTypesUpdateWordStatusRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
61647
- /**
61648
- * Fetches a single word list by language with pagination on words within the wordlist
61649
- * @summary Get word lists by language
61650
- * @param {string} xStoreID X-Store ID
61651
- * @param {string} [lang] Language locale filter (e.g. \&#39;en\&#39;, \&#39;ar\&#39;)
61652
- * @param {string} [type] Type filter (stopwords, synonyms)
61653
- * @param {number} [page] Page number (default: 1)
61654
- * @param {number} [limit] Items per page (default: 10)
61655
- * @param {*} [options] Override http request option.
61656
- * @throws {RequiredError}
61657
- */
61658
- adminStoresXStoreIDStopwordsWordlistsGet: (xStoreID: string, lang?: string, type?: string, page?: number, limit?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
61659
- /**
61660
- * Fetches a single word list by language with pagination on words, including store-specific enabled/disabled status and store-specific added words. Supports search functionality.
61661
- * @summary Get word lists by language (includes store-specific words)
61662
- * @param {string} xStoreID X-Store ID
61663
- * @param {string} [lang] Language locale filter (e.g. \&#39;en\&#39;, \&#39;ar\&#39;)
61664
- * @param {string} [type] Type filter (stopwords, synonyms)
61665
- * @param {string} [q] Search query to filter words (case-insensitive)
61666
- * @param {number} [page] Page number (default: 1)
61667
- * @param {number} [limit] Items per page (default: 10)
62560
+ * Fetches a single word list by language with pagination on words, including store-specific enabled/disabled status and store-specific added words. Supports search functionality.
62561
+ * @summary Get word lists by language (includes store-specific words)
62562
+ * @param {string} xStoreID X-Store ID
62563
+ * @param {string} [lang] Language locale filter (e.g. \&#39;en\&#39;, \&#39;ar\&#39;)
62564
+ * @param {string} [type] Type filter (stopwords, synonyms)
62565
+ * @param {string} [q] Search query to filter words (case-insensitive)
62566
+ * @param {number} [page] Page number (default: 1)
62567
+ * @param {number} [limit] Items per page (default: 10)
61668
62568
  * @param {*} [options] Override http request option.
61669
62569
  * @throws {RequiredError}
61670
62570
  */
@@ -62606,6 +63506,630 @@ export declare class StoreDocumentsApi extends BaseAPI {
62606
63506
  */
62607
63507
  adminStoresXStoreIDDocumentsPost(xStoreID: string, dataTypesDocumentRequest: DataTypesDocumentRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesDocumentResponseWrapper, any, {}>>;
62608
63508
  }
63509
+ /**
63510
+ * StoreManagementApi - axios parameter creator
63511
+ * @export
63512
+ */
63513
+ export declare const StoreManagementApiAxiosParamCreator: (configuration?: Configuration) => {
63514
+ /**
63515
+ * Creates a new store with minimal information. Returns store credentials (xStoreID, xStoreSecret, xStoreWriteSecret) immediately. This is a public API for SDK integration. Requires JWT authentication.
63516
+ * @summary Create Store (Public SDK API)
63517
+ * @param {string} authorization Bearer JWT Token
63518
+ * @param {DataTypesPublicCreateStoreRequest} dataTypesPublicCreateStoreRequest Store creation request
63519
+ * @param {*} [options] Override http request option.
63520
+ * @throws {RequiredError}
63521
+ */
63522
+ apiV1StoresPost: (authorization: string, dataTypesPublicCreateStoreRequest: DataTypesPublicCreateStoreRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
63523
+ /**
63524
+ * Returns search and query-suggestions configuration for the store. **Auth:** `x-storeid` and `x-storesecret`. Path `xStoreID` must match the `x-storeid` header.
63525
+ * @summary Get store configuration
63526
+ * @param {string} xStoreid Store ID (from dashboard)
63527
+ * @param {string} xStoresecret Store read secret
63528
+ * @param {string} xStoreID Store ID (must match x-storeid header)
63529
+ * @param {*} [options] Override http request option.
63530
+ * @throws {RequiredError}
63531
+ */
63532
+ apiV1StoresXStoreIDConfigGet: (xStoreid: string, xStoresecret: string, xStoreID: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
63533
+ /**
63534
+ * Update search and store settings. Partial updates supported. **Auth:** `x-storeid` and `x-store-write-secret`. Path `xStoreID` must match the `x-storeid` header.
63535
+ * @summary Update store configuration
63536
+ * @param {string} xStoreid Store ID (from dashboard)
63537
+ * @param {string} xStoreWriteSecret Store write secret
63538
+ * @param {string} xStoreID Store ID (must match x-storeid header)
63539
+ * @param {DataTypesIndexConfig} dataTypesIndexConfig Fields to update (partial)
63540
+ * @param {*} [options] Override http request option.
63541
+ * @throws {RequiredError}
63542
+ */
63543
+ apiV1StoresXStoreIDConfigPut: (xStoreid: string, xStoreWriteSecret: string, xStoreID: string, dataTypesIndexConfig: DataTypesIndexConfig, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
63544
+ /**
63545
+ * Returns metadata for all configurable store fields (types, defaults, validation). **Auth:** `x-storeid` and `x-storesecret`. Path `xStoreID` must match the `x-storeid` header.
63546
+ * @summary Get store config schema
63547
+ * @param {string} xStoreid Store ID (from dashboard)
63548
+ * @param {string} xStoresecret Store read secret
63549
+ * @param {string} xStoreID Store ID (must match x-storeid header)
63550
+ * @param {*} [options] Override http request option.
63551
+ * @throws {RequiredError}
63552
+ */
63553
+ apiV1StoresXStoreIDConfigSchemaGet: (xStoreid: string, xStoresecret: string, xStoreID: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
63554
+ /**
63555
+ * 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.
63556
+ * @summary Bulk index documents
63557
+ * @param {string} xStoreid Store ID (from dashboard)
63558
+ * @param {string} xStoreWriteSecret Store write secret
63559
+ * @param {string} xStoreID Store ID (must match x-storeid header)
63560
+ * @param {DataTypesBulkDocumentRequest} dataTypesBulkDocumentRequest List of operations
63561
+ * @param {*} [options] Override http request option.
63562
+ * @throws {RequiredError}
63563
+ */
63564
+ apiV1StoresXStoreIDDocumentsBulkPost: (xStoreid: string, xStoreWriteSecret: string, xStoreID: string, dataTypesBulkDocumentRequest: DataTypesBulkDocumentRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
63565
+ /**
63566
+ * 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.
63567
+ * @summary Clear all documents
63568
+ * @param {string} xStoreid Store ID (from dashboard)
63569
+ * @param {string} xStoreWriteSecret Store write secret
63570
+ * @param {string} xStoreID Store ID (must match x-storeid header)
63571
+ * @param {*} [options] Override http request option.
63572
+ * @throws {RequiredError}
63573
+ */
63574
+ apiV1StoresXStoreIDDocumentsDelete: (xStoreid: string, xStoreWriteSecret: string, xStoreID: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
63575
+ /**
63576
+ * 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.
63577
+ * @summary Delete a document
63578
+ * @param {string} xStoreid Store ID (from dashboard)
63579
+ * @param {string} xStoreWriteSecret Store write secret
63580
+ * @param {string} xStoreID Store ID (must match x-storeid header)
63581
+ * @param {string} documentID Document ID to delete
63582
+ * @param {*} [options] Override http request option.
63583
+ * @throws {RequiredError}
63584
+ */
63585
+ apiV1StoresXStoreIDDocumentsDocumentIDDelete: (xStoreid: string, xStoreWriteSecret: string, xStoreID: string, documentID: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
63586
+ /**
63587
+ * 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.
63588
+ * @summary Get a document by ID
63589
+ * @param {string} xStoreid Store ID (from dashboard)
63590
+ * @param {string} xStoresecret Store read secret
63591
+ * @param {string} xStoreID Store ID (must match x-storeid header)
63592
+ * @param {string} documentID Document ID to retrieve
63593
+ * @param {*} [options] Override http request option.
63594
+ * @throws {RequiredError}
63595
+ */
63596
+ apiV1StoresXStoreIDDocumentsDocumentIDGet: (xStoreid: string, xStoresecret: string, xStoreID: string, documentID: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
63597
+ /**
63598
+ * 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.
63599
+ * @summary Index a single document
63600
+ * @param {string} xStoreid Store ID (from dashboard)
63601
+ * @param {string} xStoreWriteSecret Store write secret
63602
+ * @param {string} xStoreID Store ID (must match x-storeid header)
63603
+ * @param {DataTypesDocumentRequest} dataTypesDocumentRequest Document fields to index
63604
+ * @param {*} [options] Override http request option.
63605
+ * @throws {RequiredError}
63606
+ */
63607
+ apiV1StoresXStoreIDDocumentsPost: (xStoreid: string, xStoreWriteSecret: string, xStoreID: string, dataTypesDocumentRequest: DataTypesDocumentRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
63608
+ /**
63609
+ * Returns basic store details (name, location, status). **Auth:** `x-storeid` and `x-storesecret`. Path `xStoreID` must match the `x-storeid` header.
63610
+ * @summary Get store info
63611
+ * @param {string} xStoreid Store ID (from dashboard)
63612
+ * @param {string} xStoresecret Store read secret
63613
+ * @param {string} xStoreID Store ID (must match x-storeid header)
63614
+ * @param {*} [options] Override http request option.
63615
+ * @throws {RequiredError}
63616
+ */
63617
+ apiV1StoresXStoreIDGet: (xStoreid: string, xStoresecret: string, xStoreID: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
63618
+ /**
63619
+ * Returns autocomplete/suggestions configuration for the store. **Auth:** `x-storeid` and `x-storesecret`. Path `xStoreID` must match the `x-storeid` header.
63620
+ * @summary Get query suggestions configuration
63621
+ * @param {string} xStoreid Store ID (from dashboard)
63622
+ * @param {string} xStoresecret Store read secret
63623
+ * @param {string} xStoreID Store ID (must match x-storeid header)
63624
+ * @param {*} [options] Override http request option.
63625
+ * @throws {RequiredError}
63626
+ */
63627
+ apiV1StoresXStoreIDQuerySuggestionsConfigGet: (xStoreid: string, xStoresecret: string, xStoreID: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
63628
+ /**
63629
+ * 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.
63630
+ * @summary Update query suggestions configuration
63631
+ * @param {string} xStoreid Store ID (from dashboard)
63632
+ * @param {string} xStoreWriteSecret Store write secret
63633
+ * @param {string} xStoreID Store ID (must match x-storeid header)
63634
+ * @param {QuerySuggestionsServiceUpdateSuggestionConfigRequest} querySuggestionsServiceUpdateSuggestionConfigRequest Fields to update (partial)
63635
+ * @param {*} [options] Override http request option.
63636
+ * @throws {RequiredError}
63637
+ */
63638
+ apiV1StoresXStoreIDQuerySuggestionsConfigPut: (xStoreid: string, xStoreWriteSecret: string, xStoreID: string, querySuggestionsServiceUpdateSuggestionConfigRequest: QuerySuggestionsServiceUpdateSuggestionConfigRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
63639
+ /**
63640
+ * 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.
63641
+ * @summary Get index schema
63642
+ * @param {string} xStoreid Store ID (from dashboard)
63643
+ * @param {string} xStoresecret Store read secret
63644
+ * @param {string} xStoreID Store ID (must match x-storeid header)
63645
+ * @param {*} [options] Override http request option.
63646
+ * @throws {RequiredError}
63647
+ */
63648
+ apiV1StoresXStoreIDSchemaGet: (xStoreid: string, xStoresecret: string, xStoreID: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
63649
+ /**
63650
+ * 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.
63651
+ * @summary Create or update index schema
63652
+ * @param {string} xStoreid Store ID (from dashboard)
63653
+ * @param {string} xStoreWriteSecret Store write secret
63654
+ * @param {string} xStoreID Store ID (must match x-storeid header)
63655
+ * @param {DataTypesCollectionSchemaRequest} dataTypesCollectionSchemaRequest Schema definition and mode
63656
+ * @param {*} [options] Override http request option.
63657
+ * @throws {RequiredError}
63658
+ */
63659
+ apiV1StoresXStoreIDSchemaPost: (xStoreid: string, xStoreWriteSecret: string, xStoreID: string, dataTypesCollectionSchemaRequest: DataTypesCollectionSchemaRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
63660
+ };
63661
+ /**
63662
+ * StoreManagementApi - functional programming interface
63663
+ * @export
63664
+ */
63665
+ export declare const StoreManagementApiFp: (configuration?: Configuration) => {
63666
+ /**
63667
+ * Creates a new store with minimal information. Returns store credentials (xStoreID, xStoreSecret, xStoreWriteSecret) immediately. This is a public API for SDK integration. Requires JWT authentication.
63668
+ * @summary Create Store (Public SDK API)
63669
+ * @param {string} authorization Bearer JWT Token
63670
+ * @param {DataTypesPublicCreateStoreRequest} dataTypesPublicCreateStoreRequest Store creation request
63671
+ * @param {*} [options] Override http request option.
63672
+ * @throws {RequiredError}
63673
+ */
63674
+ apiV1StoresPost(authorization: string, dataTypesPublicCreateStoreRequest: DataTypesPublicCreateStoreRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesGenericResponseDataTypesPublicCreateStoreResponse>>;
63675
+ /**
63676
+ * Returns search and query-suggestions configuration for the store. **Auth:** `x-storeid` and `x-storesecret`. Path `xStoreID` must match the `x-storeid` header.
63677
+ * @summary Get store configuration
63678
+ * @param {string} xStoreid Store ID (from dashboard)
63679
+ * @param {string} xStoresecret Store read secret
63680
+ * @param {string} xStoreID Store ID (must match x-storeid header)
63681
+ * @param {*} [options] Override http request option.
63682
+ * @throws {RequiredError}
63683
+ */
63684
+ apiV1StoresXStoreIDConfigGet(xStoreid: string, xStoresecret: string, xStoreID: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesGenericResponseDataTypesStoreConfigWithOnboardingResponse>>;
63685
+ /**
63686
+ * Update search and store settings. Partial updates supported. **Auth:** `x-storeid` and `x-store-write-secret`. Path `xStoreID` must match the `x-storeid` header.
63687
+ * @summary Update store configuration
63688
+ * @param {string} xStoreid Store ID (from dashboard)
63689
+ * @param {string} xStoreWriteSecret Store write secret
63690
+ * @param {string} xStoreID Store ID (must match x-storeid header)
63691
+ * @param {DataTypesIndexConfig} dataTypesIndexConfig Fields to update (partial)
63692
+ * @param {*} [options] Override http request option.
63693
+ * @throws {RequiredError}
63694
+ */
63695
+ apiV1StoresXStoreIDConfigPut(xStoreid: string, xStoreWriteSecret: string, xStoreID: string, dataTypesIndexConfig: DataTypesIndexConfig, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesIndexConfigResponseWrapper>>;
63696
+ /**
63697
+ * Returns metadata for all configurable store fields (types, defaults, validation). **Auth:** `x-storeid` and `x-storesecret`. Path `xStoreID` must match the `x-storeid` header.
63698
+ * @summary Get store config schema
63699
+ * @param {string} xStoreid Store ID (from dashboard)
63700
+ * @param {string} xStoresecret Store read secret
63701
+ * @param {string} xStoreID Store ID (must match x-storeid header)
63702
+ * @param {*} [options] Override http request option.
63703
+ * @throws {RequiredError}
63704
+ */
63705
+ apiV1StoresXStoreIDConfigSchemaGet(xStoreid: string, xStoresecret: string, xStoreID: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesConfigurationSchemaResponseWrapper>>;
63706
+ /**
63707
+ * 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.
63708
+ * @summary Bulk index documents
63709
+ * @param {string} xStoreid Store ID (from dashboard)
63710
+ * @param {string} xStoreWriteSecret Store write secret
63711
+ * @param {string} xStoreID Store ID (must match x-storeid header)
63712
+ * @param {DataTypesBulkDocumentRequest} dataTypesBulkDocumentRequest List of operations
63713
+ * @param {*} [options] Override http request option.
63714
+ * @throws {RequiredError}
63715
+ */
63716
+ apiV1StoresXStoreIDDocumentsBulkPost(xStoreid: string, xStoreWriteSecret: string, xStoreID: string, dataTypesBulkDocumentRequest: DataTypesBulkDocumentRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesBulkDocumentResponseWrapper>>;
63717
+ /**
63718
+ * 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.
63719
+ * @summary Clear all documents
63720
+ * @param {string} xStoreid Store ID (from dashboard)
63721
+ * @param {string} xStoreWriteSecret Store write secret
63722
+ * @param {string} xStoreID Store ID (must match x-storeid header)
63723
+ * @param {*} [options] Override http request option.
63724
+ * @throws {RequiredError}
63725
+ */
63726
+ apiV1StoresXStoreIDDocumentsDelete(xStoreid: string, xStoreWriteSecret: string, xStoreID: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesClearDocumentsResponseWrapper>>;
63727
+ /**
63728
+ * 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.
63729
+ * @summary Delete a document
63730
+ * @param {string} xStoreid Store ID (from dashboard)
63731
+ * @param {string} xStoreWriteSecret Store write secret
63732
+ * @param {string} xStoreID Store ID (must match x-storeid header)
63733
+ * @param {string} documentID Document ID to delete
63734
+ * @param {*} [options] Override http request option.
63735
+ * @throws {RequiredError}
63736
+ */
63737
+ apiV1StoresXStoreIDDocumentsDocumentIDDelete(xStoreid: string, xStoreWriteSecret: string, xStoreID: string, documentID: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesDocumentResponseWrapper>>;
63738
+ /**
63739
+ * 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.
63740
+ * @summary Get a document by ID
63741
+ * @param {string} xStoreid Store ID (from dashboard)
63742
+ * @param {string} xStoresecret Store read secret
63743
+ * @param {string} xStoreID Store ID (must match x-storeid header)
63744
+ * @param {string} documentID Document ID to retrieve
63745
+ * @param {*} [options] Override http request option.
63746
+ * @throws {RequiredError}
63747
+ */
63748
+ apiV1StoresXStoreIDDocumentsDocumentIDGet(xStoreid: string, xStoresecret: string, xStoreID: string, documentID: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesDocumentResponseWrapper>>;
63749
+ /**
63750
+ * 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.
63751
+ * @summary Index a single document
63752
+ * @param {string} xStoreid Store ID (from dashboard)
63753
+ * @param {string} xStoreWriteSecret Store write secret
63754
+ * @param {string} xStoreID Store ID (must match x-storeid header)
63755
+ * @param {DataTypesDocumentRequest} dataTypesDocumentRequest Document fields to index
63756
+ * @param {*} [options] Override http request option.
63757
+ * @throws {RequiredError}
63758
+ */
63759
+ apiV1StoresXStoreIDDocumentsPost(xStoreid: string, xStoreWriteSecret: string, xStoreID: string, dataTypesDocumentRequest: DataTypesDocumentRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesDocumentResponseWrapper>>;
63760
+ /**
63761
+ * Returns basic store details (name, location, status). **Auth:** `x-storeid` and `x-storesecret`. Path `xStoreID` must match the `x-storeid` header.
63762
+ * @summary Get store info
63763
+ * @param {string} xStoreid Store ID (from dashboard)
63764
+ * @param {string} xStoresecret Store read secret
63765
+ * @param {string} xStoreID Store ID (must match x-storeid header)
63766
+ * @param {*} [options] Override http request option.
63767
+ * @throws {RequiredError}
63768
+ */
63769
+ apiV1StoresXStoreIDGet(xStoreid: string, xStoresecret: string, xStoreID: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesGenericResponseDataTypesPublicStoreInfoResponse>>;
63770
+ /**
63771
+ * Returns autocomplete/suggestions configuration for the store. **Auth:** `x-storeid` and `x-storesecret`. Path `xStoreID` must match the `x-storeid` header.
63772
+ * @summary Get query suggestions configuration
63773
+ * @param {string} xStoreid Store ID (from dashboard)
63774
+ * @param {string} xStoresecret Store read secret
63775
+ * @param {string} xStoreID Store ID (must match x-storeid header)
63776
+ * @param {*} [options] Override http request option.
63777
+ * @throws {RequiredError}
63778
+ */
63779
+ apiV1StoresXStoreIDQuerySuggestionsConfigGet(xStoreid: string, xStoresecret: string, xStoreID: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<QuerySuggestionsServiceQuerySuggestionsAPIResponse>>;
63780
+ /**
63781
+ * 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.
63782
+ * @summary Update query suggestions configuration
63783
+ * @param {string} xStoreid Store ID (from dashboard)
63784
+ * @param {string} xStoreWriteSecret Store write secret
63785
+ * @param {string} xStoreID Store ID (must match x-storeid header)
63786
+ * @param {QuerySuggestionsServiceUpdateSuggestionConfigRequest} querySuggestionsServiceUpdateSuggestionConfigRequest Fields to update (partial)
63787
+ * @param {*} [options] Override http request option.
63788
+ * @throws {RequiredError}
63789
+ */
63790
+ apiV1StoresXStoreIDQuerySuggestionsConfigPut(xStoreid: string, xStoreWriteSecret: string, xStoreID: string, querySuggestionsServiceUpdateSuggestionConfigRequest: QuerySuggestionsServiceUpdateSuggestionConfigRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<QuerySuggestionsServiceQuerySuggestionsAPIResponse>>;
63791
+ /**
63792
+ * 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.
63793
+ * @summary Get index schema
63794
+ * @param {string} xStoreid Store ID (from dashboard)
63795
+ * @param {string} xStoresecret Store read secret
63796
+ * @param {string} xStoreID Store ID (must match x-storeid header)
63797
+ * @param {*} [options] Override http request option.
63798
+ * @throws {RequiredError}
63799
+ */
63800
+ apiV1StoresXStoreIDSchemaGet(xStoreid: string, xStoresecret: string, xStoreID: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesSchemaResponseWrapper>>;
63801
+ /**
63802
+ * 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.
63803
+ * @summary Create or update index schema
63804
+ * @param {string} xStoreid Store ID (from dashboard)
63805
+ * @param {string} xStoreWriteSecret Store write secret
63806
+ * @param {string} xStoreID Store ID (must match x-storeid header)
63807
+ * @param {DataTypesCollectionSchemaRequest} dataTypesCollectionSchemaRequest Schema definition and mode
63808
+ * @param {*} [options] Override http request option.
63809
+ * @throws {RequiredError}
63810
+ */
63811
+ apiV1StoresXStoreIDSchemaPost(xStoreid: string, xStoreWriteSecret: string, xStoreID: string, dataTypesCollectionSchemaRequest: DataTypesCollectionSchemaRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesSchemaResponseWrapper>>;
63812
+ };
63813
+ /**
63814
+ * StoreManagementApi - factory interface
63815
+ * @export
63816
+ */
63817
+ export declare const StoreManagementApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
63818
+ /**
63819
+ * Creates a new store with minimal information. Returns store credentials (xStoreID, xStoreSecret, xStoreWriteSecret) immediately. This is a public API for SDK integration. Requires JWT authentication.
63820
+ * @summary Create Store (Public SDK API)
63821
+ * @param {string} authorization Bearer JWT Token
63822
+ * @param {DataTypesPublicCreateStoreRequest} dataTypesPublicCreateStoreRequest Store creation request
63823
+ * @param {*} [options] Override http request option.
63824
+ * @throws {RequiredError}
63825
+ */
63826
+ apiV1StoresPost(authorization: string, dataTypesPublicCreateStoreRequest: DataTypesPublicCreateStoreRequest, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesGenericResponseDataTypesPublicCreateStoreResponse>;
63827
+ /**
63828
+ * Returns search and query-suggestions configuration for the store. **Auth:** `x-storeid` and `x-storesecret`. Path `xStoreID` must match the `x-storeid` header.
63829
+ * @summary Get store configuration
63830
+ * @param {string} xStoreid Store ID (from dashboard)
63831
+ * @param {string} xStoresecret Store read secret
63832
+ * @param {string} xStoreID Store ID (must match x-storeid header)
63833
+ * @param {*} [options] Override http request option.
63834
+ * @throws {RequiredError}
63835
+ */
63836
+ apiV1StoresXStoreIDConfigGet(xStoreid: string, xStoresecret: string, xStoreID: string, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesGenericResponseDataTypesStoreConfigWithOnboardingResponse>;
63837
+ /**
63838
+ * Update search and store settings. Partial updates supported. **Auth:** `x-storeid` and `x-store-write-secret`. Path `xStoreID` must match the `x-storeid` header.
63839
+ * @summary Update store configuration
63840
+ * @param {string} xStoreid Store ID (from dashboard)
63841
+ * @param {string} xStoreWriteSecret Store write secret
63842
+ * @param {string} xStoreID Store ID (must match x-storeid header)
63843
+ * @param {DataTypesIndexConfig} dataTypesIndexConfig Fields to update (partial)
63844
+ * @param {*} [options] Override http request option.
63845
+ * @throws {RequiredError}
63846
+ */
63847
+ apiV1StoresXStoreIDConfigPut(xStoreid: string, xStoreWriteSecret: string, xStoreID: string, dataTypesIndexConfig: DataTypesIndexConfig, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesIndexConfigResponseWrapper>;
63848
+ /**
63849
+ * Returns metadata for all configurable store fields (types, defaults, validation). **Auth:** `x-storeid` and `x-storesecret`. Path `xStoreID` must match the `x-storeid` header.
63850
+ * @summary Get store config schema
63851
+ * @param {string} xStoreid Store ID (from dashboard)
63852
+ * @param {string} xStoresecret Store read secret
63853
+ * @param {string} xStoreID Store ID (must match x-storeid header)
63854
+ * @param {*} [options] Override http request option.
63855
+ * @throws {RequiredError}
63856
+ */
63857
+ apiV1StoresXStoreIDConfigSchemaGet(xStoreid: string, xStoresecret: string, xStoreID: string, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesConfigurationSchemaResponseWrapper>;
63858
+ /**
63859
+ * 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.
63860
+ * @summary Bulk index documents
63861
+ * @param {string} xStoreid Store ID (from dashboard)
63862
+ * @param {string} xStoreWriteSecret Store write secret
63863
+ * @param {string} xStoreID Store ID (must match x-storeid header)
63864
+ * @param {DataTypesBulkDocumentRequest} dataTypesBulkDocumentRequest List of operations
63865
+ * @param {*} [options] Override http request option.
63866
+ * @throws {RequiredError}
63867
+ */
63868
+ apiV1StoresXStoreIDDocumentsBulkPost(xStoreid: string, xStoreWriteSecret: string, xStoreID: string, dataTypesBulkDocumentRequest: DataTypesBulkDocumentRequest, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesBulkDocumentResponseWrapper>;
63869
+ /**
63870
+ * 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.
63871
+ * @summary Clear all documents
63872
+ * @param {string} xStoreid Store ID (from dashboard)
63873
+ * @param {string} xStoreWriteSecret Store write secret
63874
+ * @param {string} xStoreID Store ID (must match x-storeid header)
63875
+ * @param {*} [options] Override http request option.
63876
+ * @throws {RequiredError}
63877
+ */
63878
+ apiV1StoresXStoreIDDocumentsDelete(xStoreid: string, xStoreWriteSecret: string, xStoreID: string, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesClearDocumentsResponseWrapper>;
63879
+ /**
63880
+ * 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.
63881
+ * @summary Delete a document
63882
+ * @param {string} xStoreid Store ID (from dashboard)
63883
+ * @param {string} xStoreWriteSecret Store write secret
63884
+ * @param {string} xStoreID Store ID (must match x-storeid header)
63885
+ * @param {string} documentID Document ID to delete
63886
+ * @param {*} [options] Override http request option.
63887
+ * @throws {RequiredError}
63888
+ */
63889
+ apiV1StoresXStoreIDDocumentsDocumentIDDelete(xStoreid: string, xStoreWriteSecret: string, xStoreID: string, documentID: string, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesDocumentResponseWrapper>;
63890
+ /**
63891
+ * 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.
63892
+ * @summary Get a document by ID
63893
+ * @param {string} xStoreid Store ID (from dashboard)
63894
+ * @param {string} xStoresecret Store read secret
63895
+ * @param {string} xStoreID Store ID (must match x-storeid header)
63896
+ * @param {string} documentID Document ID to retrieve
63897
+ * @param {*} [options] Override http request option.
63898
+ * @throws {RequiredError}
63899
+ */
63900
+ apiV1StoresXStoreIDDocumentsDocumentIDGet(xStoreid: string, xStoresecret: string, xStoreID: string, documentID: string, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesDocumentResponseWrapper>;
63901
+ /**
63902
+ * 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.
63903
+ * @summary Index a single document
63904
+ * @param {string} xStoreid Store ID (from dashboard)
63905
+ * @param {string} xStoreWriteSecret Store write secret
63906
+ * @param {string} xStoreID Store ID (must match x-storeid header)
63907
+ * @param {DataTypesDocumentRequest} dataTypesDocumentRequest Document fields to index
63908
+ * @param {*} [options] Override http request option.
63909
+ * @throws {RequiredError}
63910
+ */
63911
+ apiV1StoresXStoreIDDocumentsPost(xStoreid: string, xStoreWriteSecret: string, xStoreID: string, dataTypesDocumentRequest: DataTypesDocumentRequest, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesDocumentResponseWrapper>;
63912
+ /**
63913
+ * Returns basic store details (name, location, status). **Auth:** `x-storeid` and `x-storesecret`. Path `xStoreID` must match the `x-storeid` header.
63914
+ * @summary Get store info
63915
+ * @param {string} xStoreid Store ID (from dashboard)
63916
+ * @param {string} xStoresecret Store read secret
63917
+ * @param {string} xStoreID Store ID (must match x-storeid header)
63918
+ * @param {*} [options] Override http request option.
63919
+ * @throws {RequiredError}
63920
+ */
63921
+ apiV1StoresXStoreIDGet(xStoreid: string, xStoresecret: string, xStoreID: string, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesGenericResponseDataTypesPublicStoreInfoResponse>;
63922
+ /**
63923
+ * Returns autocomplete/suggestions configuration for the store. **Auth:** `x-storeid` and `x-storesecret`. Path `xStoreID` must match the `x-storeid` header.
63924
+ * @summary Get query suggestions configuration
63925
+ * @param {string} xStoreid Store ID (from dashboard)
63926
+ * @param {string} xStoresecret Store read secret
63927
+ * @param {string} xStoreID Store ID (must match x-storeid header)
63928
+ * @param {*} [options] Override http request option.
63929
+ * @throws {RequiredError}
63930
+ */
63931
+ apiV1StoresXStoreIDQuerySuggestionsConfigGet(xStoreid: string, xStoresecret: string, xStoreID: string, options?: RawAxiosRequestConfig): AxiosPromise<QuerySuggestionsServiceQuerySuggestionsAPIResponse>;
63932
+ /**
63933
+ * 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.
63934
+ * @summary Update query suggestions configuration
63935
+ * @param {string} xStoreid Store ID (from dashboard)
63936
+ * @param {string} xStoreWriteSecret Store write secret
63937
+ * @param {string} xStoreID Store ID (must match x-storeid header)
63938
+ * @param {QuerySuggestionsServiceUpdateSuggestionConfigRequest} querySuggestionsServiceUpdateSuggestionConfigRequest Fields to update (partial)
63939
+ * @param {*} [options] Override http request option.
63940
+ * @throws {RequiredError}
63941
+ */
63942
+ apiV1StoresXStoreIDQuerySuggestionsConfigPut(xStoreid: string, xStoreWriteSecret: string, xStoreID: string, querySuggestionsServiceUpdateSuggestionConfigRequest: QuerySuggestionsServiceUpdateSuggestionConfigRequest, options?: RawAxiosRequestConfig): AxiosPromise<QuerySuggestionsServiceQuerySuggestionsAPIResponse>;
63943
+ /**
63944
+ * 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.
63945
+ * @summary Get index schema
63946
+ * @param {string} xStoreid Store ID (from dashboard)
63947
+ * @param {string} xStoresecret Store read secret
63948
+ * @param {string} xStoreID Store ID (must match x-storeid header)
63949
+ * @param {*} [options] Override http request option.
63950
+ * @throws {RequiredError}
63951
+ */
63952
+ apiV1StoresXStoreIDSchemaGet(xStoreid: string, xStoresecret: string, xStoreID: string, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesSchemaResponseWrapper>;
63953
+ /**
63954
+ * 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.
63955
+ * @summary Create or update index schema
63956
+ * @param {string} xStoreid Store ID (from dashboard)
63957
+ * @param {string} xStoreWriteSecret Store write secret
63958
+ * @param {string} xStoreID Store ID (must match x-storeid header)
63959
+ * @param {DataTypesCollectionSchemaRequest} dataTypesCollectionSchemaRequest Schema definition and mode
63960
+ * @param {*} [options] Override http request option.
63961
+ * @throws {RequiredError}
63962
+ */
63963
+ apiV1StoresXStoreIDSchemaPost(xStoreid: string, xStoreWriteSecret: string, xStoreID: string, dataTypesCollectionSchemaRequest: DataTypesCollectionSchemaRequest, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesSchemaResponseWrapper>;
63964
+ };
63965
+ /**
63966
+ * StoreManagementApi - object-oriented interface
63967
+ * @export
63968
+ * @class StoreManagementApi
63969
+ * @extends {BaseAPI}
63970
+ */
63971
+ export declare class StoreManagementApi extends BaseAPI {
63972
+ /**
63973
+ * Creates a new store with minimal information. Returns store credentials (xStoreID, xStoreSecret, xStoreWriteSecret) immediately. This is a public API for SDK integration. Requires JWT authentication.
63974
+ * @summary Create Store (Public SDK API)
63975
+ * @param {string} authorization Bearer JWT Token
63976
+ * @param {DataTypesPublicCreateStoreRequest} dataTypesPublicCreateStoreRequest Store creation request
63977
+ * @param {*} [options] Override http request option.
63978
+ * @throws {RequiredError}
63979
+ * @memberof StoreManagementApi
63980
+ */
63981
+ apiV1StoresPost(authorization: string, dataTypesPublicCreateStoreRequest: DataTypesPublicCreateStoreRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesGenericResponseDataTypesPublicCreateStoreResponse, any, {}>>;
63982
+ /**
63983
+ * Returns search and query-suggestions configuration for the store. **Auth:** `x-storeid` and `x-storesecret`. Path `xStoreID` must match the `x-storeid` header.
63984
+ * @summary Get store configuration
63985
+ * @param {string} xStoreid Store ID (from dashboard)
63986
+ * @param {string} xStoresecret Store read secret
63987
+ * @param {string} xStoreID Store ID (must match x-storeid header)
63988
+ * @param {*} [options] Override http request option.
63989
+ * @throws {RequiredError}
63990
+ * @memberof StoreManagementApi
63991
+ */
63992
+ apiV1StoresXStoreIDConfigGet(xStoreid: string, xStoresecret: string, xStoreID: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesGenericResponseDataTypesStoreConfigWithOnboardingResponse, any, {}>>;
63993
+ /**
63994
+ * Update search and store settings. Partial updates supported. **Auth:** `x-storeid` and `x-store-write-secret`. Path `xStoreID` must match the `x-storeid` header.
63995
+ * @summary Update store configuration
63996
+ * @param {string} xStoreid Store ID (from dashboard)
63997
+ * @param {string} xStoreWriteSecret Store write secret
63998
+ * @param {string} xStoreID Store ID (must match x-storeid header)
63999
+ * @param {DataTypesIndexConfig} dataTypesIndexConfig Fields to update (partial)
64000
+ * @param {*} [options] Override http request option.
64001
+ * @throws {RequiredError}
64002
+ * @memberof StoreManagementApi
64003
+ */
64004
+ apiV1StoresXStoreIDConfigPut(xStoreid: string, xStoreWriteSecret: string, xStoreID: string, dataTypesIndexConfig: DataTypesIndexConfig, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesIndexConfigResponseWrapper, any, {}>>;
64005
+ /**
64006
+ * Returns metadata for all configurable store fields (types, defaults, validation). **Auth:** `x-storeid` and `x-storesecret`. Path `xStoreID` must match the `x-storeid` header.
64007
+ * @summary Get store config schema
64008
+ * @param {string} xStoreid Store ID (from dashboard)
64009
+ * @param {string} xStoresecret Store read secret
64010
+ * @param {string} xStoreID Store ID (must match x-storeid header)
64011
+ * @param {*} [options] Override http request option.
64012
+ * @throws {RequiredError}
64013
+ * @memberof StoreManagementApi
64014
+ */
64015
+ apiV1StoresXStoreIDConfigSchemaGet(xStoreid: string, xStoresecret: string, xStoreID: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesConfigurationSchemaResponseWrapper, any, {}>>;
64016
+ /**
64017
+ * 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.
64018
+ * @summary Bulk index documents
64019
+ * @param {string} xStoreid Store ID (from dashboard)
64020
+ * @param {string} xStoreWriteSecret Store write secret
64021
+ * @param {string} xStoreID Store ID (must match x-storeid header)
64022
+ * @param {DataTypesBulkDocumentRequest} dataTypesBulkDocumentRequest List of operations
64023
+ * @param {*} [options] Override http request option.
64024
+ * @throws {RequiredError}
64025
+ * @memberof StoreManagementApi
64026
+ */
64027
+ apiV1StoresXStoreIDDocumentsBulkPost(xStoreid: string, xStoreWriteSecret: string, xStoreID: string, dataTypesBulkDocumentRequest: DataTypesBulkDocumentRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesBulkDocumentResponseWrapper, any, {}>>;
64028
+ /**
64029
+ * 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.
64030
+ * @summary Clear all documents
64031
+ * @param {string} xStoreid Store ID (from dashboard)
64032
+ * @param {string} xStoreWriteSecret Store write secret
64033
+ * @param {string} xStoreID Store ID (must match x-storeid header)
64034
+ * @param {*} [options] Override http request option.
64035
+ * @throws {RequiredError}
64036
+ * @memberof StoreManagementApi
64037
+ */
64038
+ apiV1StoresXStoreIDDocumentsDelete(xStoreid: string, xStoreWriteSecret: string, xStoreID: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesClearDocumentsResponseWrapper, any, {}>>;
64039
+ /**
64040
+ * 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.
64041
+ * @summary Delete a document
64042
+ * @param {string} xStoreid Store ID (from dashboard)
64043
+ * @param {string} xStoreWriteSecret Store write secret
64044
+ * @param {string} xStoreID Store ID (must match x-storeid header)
64045
+ * @param {string} documentID Document ID to delete
64046
+ * @param {*} [options] Override http request option.
64047
+ * @throws {RequiredError}
64048
+ * @memberof StoreManagementApi
64049
+ */
64050
+ apiV1StoresXStoreIDDocumentsDocumentIDDelete(xStoreid: string, xStoreWriteSecret: string, xStoreID: string, documentID: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesDocumentResponseWrapper, any, {}>>;
64051
+ /**
64052
+ * 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.
64053
+ * @summary Get a document by ID
64054
+ * @param {string} xStoreid Store ID (from dashboard)
64055
+ * @param {string} xStoresecret Store read secret
64056
+ * @param {string} xStoreID Store ID (must match x-storeid header)
64057
+ * @param {string} documentID Document ID to retrieve
64058
+ * @param {*} [options] Override http request option.
64059
+ * @throws {RequiredError}
64060
+ * @memberof StoreManagementApi
64061
+ */
64062
+ apiV1StoresXStoreIDDocumentsDocumentIDGet(xStoreid: string, xStoresecret: string, xStoreID: string, documentID: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesDocumentResponseWrapper, any, {}>>;
64063
+ /**
64064
+ * 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.
64065
+ * @summary Index a single document
64066
+ * @param {string} xStoreid Store ID (from dashboard)
64067
+ * @param {string} xStoreWriteSecret Store write secret
64068
+ * @param {string} xStoreID Store ID (must match x-storeid header)
64069
+ * @param {DataTypesDocumentRequest} dataTypesDocumentRequest Document fields to index
64070
+ * @param {*} [options] Override http request option.
64071
+ * @throws {RequiredError}
64072
+ * @memberof StoreManagementApi
64073
+ */
64074
+ apiV1StoresXStoreIDDocumentsPost(xStoreid: string, xStoreWriteSecret: string, xStoreID: string, dataTypesDocumentRequest: DataTypesDocumentRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesDocumentResponseWrapper, any, {}>>;
64075
+ /**
64076
+ * Returns basic store details (name, location, status). **Auth:** `x-storeid` and `x-storesecret`. Path `xStoreID` must match the `x-storeid` header.
64077
+ * @summary Get store info
64078
+ * @param {string} xStoreid Store ID (from dashboard)
64079
+ * @param {string} xStoresecret Store read secret
64080
+ * @param {string} xStoreID Store ID (must match x-storeid header)
64081
+ * @param {*} [options] Override http request option.
64082
+ * @throws {RequiredError}
64083
+ * @memberof StoreManagementApi
64084
+ */
64085
+ apiV1StoresXStoreIDGet(xStoreid: string, xStoresecret: string, xStoreID: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesGenericResponseDataTypesPublicStoreInfoResponse, any, {}>>;
64086
+ /**
64087
+ * Returns autocomplete/suggestions configuration for the store. **Auth:** `x-storeid` and `x-storesecret`. Path `xStoreID` must match the `x-storeid` header.
64088
+ * @summary Get query suggestions configuration
64089
+ * @param {string} xStoreid Store ID (from dashboard)
64090
+ * @param {string} xStoresecret Store read secret
64091
+ * @param {string} xStoreID Store ID (must match x-storeid header)
64092
+ * @param {*} [options] Override http request option.
64093
+ * @throws {RequiredError}
64094
+ * @memberof StoreManagementApi
64095
+ */
64096
+ apiV1StoresXStoreIDQuerySuggestionsConfigGet(xStoreid: string, xStoresecret: string, xStoreID: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<QuerySuggestionsServiceQuerySuggestionsAPIResponse, any, {}>>;
64097
+ /**
64098
+ * 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.
64099
+ * @summary Update query suggestions configuration
64100
+ * @param {string} xStoreid Store ID (from dashboard)
64101
+ * @param {string} xStoreWriteSecret Store write secret
64102
+ * @param {string} xStoreID Store ID (must match x-storeid header)
64103
+ * @param {QuerySuggestionsServiceUpdateSuggestionConfigRequest} querySuggestionsServiceUpdateSuggestionConfigRequest Fields to update (partial)
64104
+ * @param {*} [options] Override http request option.
64105
+ * @throws {RequiredError}
64106
+ * @memberof StoreManagementApi
64107
+ */
64108
+ apiV1StoresXStoreIDQuerySuggestionsConfigPut(xStoreid: string, xStoreWriteSecret: string, xStoreID: string, querySuggestionsServiceUpdateSuggestionConfigRequest: QuerySuggestionsServiceUpdateSuggestionConfigRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<QuerySuggestionsServiceQuerySuggestionsAPIResponse, any, {}>>;
64109
+ /**
64110
+ * 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.
64111
+ * @summary Get index schema
64112
+ * @param {string} xStoreid Store ID (from dashboard)
64113
+ * @param {string} xStoresecret Store read secret
64114
+ * @param {string} xStoreID Store ID (must match x-storeid header)
64115
+ * @param {*} [options] Override http request option.
64116
+ * @throws {RequiredError}
64117
+ * @memberof StoreManagementApi
64118
+ */
64119
+ apiV1StoresXStoreIDSchemaGet(xStoreid: string, xStoresecret: string, xStoreID: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesSchemaResponseWrapper, any, {}>>;
64120
+ /**
64121
+ * 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.
64122
+ * @summary Create or update index schema
64123
+ * @param {string} xStoreid Store ID (from dashboard)
64124
+ * @param {string} xStoreWriteSecret Store write secret
64125
+ * @param {string} xStoreID Store ID (must match x-storeid header)
64126
+ * @param {DataTypesCollectionSchemaRequest} dataTypesCollectionSchemaRequest Schema definition and mode
64127
+ * @param {*} [options] Override http request option.
64128
+ * @throws {RequiredError}
64129
+ * @memberof StoreManagementApi
64130
+ */
64131
+ apiV1StoresXStoreIDSchemaPost(xStoreid: string, xStoreWriteSecret: string, xStoreID: string, dataTypesCollectionSchemaRequest: DataTypesCollectionSchemaRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesSchemaResponseWrapper, any, {}>>;
64132
+ }
62609
64133
  /**
62610
64134
  * StoresApi - axios parameter creator
62611
64135
  * @export
@@ -62707,7 +64231,7 @@ export declare const StoresApiAxiosParamCreator: (configuration?: Configuration)
62707
64231
  */
62708
64232
  adminStoresXStoreIDAnalyticsTimeseriesGet: (xStoreID: string, metric: string, startDate?: string, endDate?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
62709
64233
  /**
62710
- * Retrieve detailed information for a specific API usage event including headers, request body, and response body
64234
+ * Retrieve detailed information for a specific API usage event including headers, request body, and response body.
62711
64235
  * @summary Get Specific API Usage Event
62712
64236
  * @param {string} xStoreID Store ID
62713
64237
  * @param {string} eventID Event ID (UUID)
@@ -62935,7 +64459,7 @@ export declare const StoresApiFp: (configuration?: Configuration) => {
62935
64459
  */
62936
64460
  adminStoresXStoreIDAnalyticsTimeseriesGet(xStoreID: string, metric: string, startDate?: string, endDate?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<StoreRouteTimeSeriesResponse>>;
62937
64461
  /**
62938
- * Retrieve detailed information for a specific API usage event including headers, request body, and response body
64462
+ * Retrieve detailed information for a specific API usage event including headers, request body, and response body.
62939
64463
  * @summary Get Specific API Usage Event
62940
64464
  * @param {string} xStoreID Store ID
62941
64465
  * @param {string} eventID Event ID (UUID)
@@ -63163,7 +64687,7 @@ export declare const StoresApiFactory: (configuration?: Configuration, basePath?
63163
64687
  */
63164
64688
  adminStoresXStoreIDAnalyticsTimeseriesGet(xStoreID: string, metric: string, startDate?: string, endDate?: string, options?: RawAxiosRequestConfig): AxiosPromise<StoreRouteTimeSeriesResponse>;
63165
64689
  /**
63166
- * Retrieve detailed information for a specific API usage event including headers, request body, and response body
64690
+ * Retrieve detailed information for a specific API usage event including headers, request body, and response body.
63167
64691
  * @summary Get Specific API Usage Event
63168
64692
  * @param {string} xStoreID Store ID
63169
64693
  * @param {string} eventID Event ID (UUID)
@@ -63404,7 +64928,7 @@ export declare class StoresApi extends BaseAPI {
63404
64928
  */
63405
64929
  adminStoresXStoreIDAnalyticsTimeseriesGet(xStoreID: string, metric: string, startDate?: string, endDate?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<StoreRouteTimeSeriesResponse, any, {}>>;
63406
64930
  /**
63407
- * Retrieve detailed information for a specific API usage event including headers, request body, and response body
64931
+ * Retrieve detailed information for a specific API usage event including headers, request body, and response body.
63408
64932
  * @summary Get Specific API Usage Event
63409
64933
  * @param {string} xStoreID Store ID
63410
64934
  * @param {string} eventID Event ID (UUID)