@seekora-ai/admin-api 1.1.80 → 1.1.82

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/esm/api.d.ts CHANGED
@@ -1,6 +1,6 @@
1
1
  /**
2
2
  * Seekora APIs
3
- * This is an API with JWT authentication.
3
+ * Seekora provides search, suggestions, and store management APIs. **Admin APIs** require JWT (Bearer token from login). **Public/SDK APIs** (search, stores, suggestions, documents) use store credentials: send `x-storeid` (Store ID) and either `x-storesecret` (read) or `x-store-write-secret` (write) in headers. Get these from the Seekora dashboard. Base path for public v1 APIs: `/api/v1`.
4
4
  *
5
5
  * The version of the OpenAPI document: 1.0
6
6
  *
@@ -6961,12 +6961,6 @@ export interface AnalyticsMergeProfilesRequestBody {
6961
6961
  * @memberof AnalyticsMergeProfilesRequestBody
6962
6962
  */
6963
6963
  'authenticated_id': string;
6964
- /**
6965
- *
6966
- * @type {string}
6967
- * @memberof AnalyticsMergeProfilesRequestBody
6968
- */
6969
- 'xstoreid'?: string;
6970
6964
  }
6971
6965
  /**
6972
6966
  *
@@ -12868,6 +12862,12 @@ export interface DataTypesCombinedSearchResponse {
12868
12862
  * @memberof DataTypesCombinedSearchResponse
12869
12863
  */
12870
12864
  'search_id'?: string;
12865
+ /**
12866
+ * Available sort options based on schema
12867
+ * @type {Array<DataTypesSortOption>}
12868
+ * @memberof DataTypesCombinedSearchResponse
12869
+ */
12870
+ 'sort_options'?: Array<DataTypesSortOption>;
12871
12871
  /**
12872
12872
  *
12873
12873
  * @type {Array<DataTypesAutocompleteSuggestion>}
@@ -15981,6 +15981,12 @@ export interface DataTypesEventPayload {
15981
15981
  * @memberof DataTypesEventPayload
15982
15982
  */
15983
15983
  'connection_type'?: string;
15984
+ /**
15985
+ * add_to_cart, wishlist, purchase, etc.
15986
+ * @type {string}
15987
+ * @memberof DataTypesEventPayload
15988
+ */
15989
+ 'conversion_type'?: string;
15984
15990
  /**
15985
15991
  *
15986
15992
  * @type {string}
@@ -16059,6 +16065,12 @@ export interface DataTypesEventPayload {
16059
16065
  * @memberof DataTypesEventPayload
16060
16066
  */
16061
16067
  'impression_duration_ms'?: number;
16068
+ /**
16069
+ * Deduplication (industry standard: Segment, Amplitude, Mixpanel pattern) Format: {user_key}_{event_type}_{item_id}_{timestamp_window} Backend can deduplicate by this key within configurable window
16070
+ * @type {string}
16071
+ * @memberof DataTypesEventPayload
16072
+ */
16073
+ 'insert_id'?: string;
16062
16074
  /**
16063
16075
  * ============================================================================ Device Context (V3) ============================================================================
16064
16076
  * @type {string}
@@ -16175,6 +16187,12 @@ export interface DataTypesEventPayload {
16175
16187
  * @memberof DataTypesEventPayload
16176
16188
  */
16177
16189
  'products_count'?: number;
16190
+ /**
16191
+ *
16192
+ * @type {number}
16193
+ * @memberof DataTypesEventPayload
16194
+ */
16195
+ 'quantity'?: number;
16178
16196
  /**
16179
16197
  * ============================================================================ Search Event Fields ============================================================================
16180
16198
  * @type {string}
@@ -22770,6 +22788,12 @@ export interface DataTypesOfficialSearchResponse {
22770
22788
  * @memberof DataTypesOfficialSearchResponse
22771
22789
  */
22772
22790
  'search_id'?: string;
22791
+ /**
22792
+ * Available sort options based on schema
22793
+ * @type {Array<DataTypesSortOption>}
22794
+ * @memberof DataTypesOfficialSearchResponse
22795
+ */
22796
+ 'sort_options'?: Array<DataTypesSortOption>;
22773
22797
  /**
22774
22798
  *
22775
22799
  * @type {Array<DataTypesAutocompleteSuggestion>}
@@ -23520,6 +23544,12 @@ export interface DataTypesOrgMemberWithUser {
23520
23544
  * @memberof DataTypesOrgMemberWithUser
23521
23545
  */
23522
23546
  'is_active'?: boolean;
23547
+ /**
23548
+ * True if user is the organization owner (non-deletable)
23549
+ * @type {boolean}
23550
+ * @memberof DataTypesOrgMemberWithUser
23551
+ */
23552
+ 'is_owner'?: boolean;
23523
23553
  /**
23524
23554
  * True if user has custom/user-specific role
23525
23555
  * @type {boolean}
@@ -26397,6 +26427,12 @@ export interface DataTypesRole {
26397
26427
  * @memberof DataTypesRole
26398
26428
  */
26399
26429
  'isDeleted'?: boolean;
26430
+ /**
26431
+ * BOOLEAN, DEFAULT FALSE - TRUE for system-created roles (non-editable)
26432
+ * @type {boolean}
26433
+ * @memberof DataTypesRole
26434
+ */
26435
+ 'isSystemCreated'?: boolean;
26400
26436
  /**
26401
26437
  * BOOLEAN, DEFAULT FALSE - TRUE for user-specific custom roles
26402
26438
  * @type {boolean}
@@ -27836,6 +27872,37 @@ export interface DataTypesSortField {
27836
27872
  */
27837
27873
  'field'?: string;
27838
27874
  }
27875
+ /**
27876
+ *
27877
+ * @export
27878
+ * @interface DataTypesSortOption
27879
+ */
27880
+ export interface DataTypesSortOption {
27881
+ /**
27882
+ * \"asc\" or \"desc\"
27883
+ * @type {string}
27884
+ * @memberof DataTypesSortOption
27885
+ */
27886
+ 'direction'?: string;
27887
+ /**
27888
+ * Field name (e.g., \"price\", \"created_at\")
27889
+ * @type {string}
27890
+ * @memberof DataTypesSortOption
27891
+ */
27892
+ 'field'?: string;
27893
+ /**
27894
+ * Human-readable label (e.g., \"Price: Low to High\")
27895
+ * @type {string}
27896
+ * @memberof DataTypesSortOption
27897
+ */
27898
+ 'label'?: string;
27899
+ /**
27900
+ * Combined value for API (e.g., \"price:asc\")
27901
+ * @type {string}
27902
+ * @memberof DataTypesSortOption
27903
+ */
27904
+ 'value'?: string;
27905
+ }
27839
27906
  /**
27840
27907
  *
27841
27908
  * @export
@@ -33077,12 +33144,24 @@ export interface ModelsCreateCustomEventFieldRequest {
33077
33144
  * @memberof ModelsCreateCustomEventFieldRequest
33078
33145
  */
33079
33146
  'max_value'?: number;
33147
+ /**
33148
+ * string min length; array min items
33149
+ * @type {number}
33150
+ * @memberof ModelsCreateCustomEventFieldRequest
33151
+ */
33152
+ 'min_length'?: number;
33080
33153
  /**
33081
33154
  *
33082
33155
  * @type {number}
33083
33156
  * @memberof ModelsCreateCustomEventFieldRequest
33084
33157
  */
33085
33158
  'min_value'?: number;
33159
+ /**
33160
+ * for object type
33161
+ * @type {Array<ModelsNestedPropertyDefinition>}
33162
+ * @memberof ModelsCreateCustomEventFieldRequest
33163
+ */
33164
+ 'nested_schema'?: Array<ModelsNestedPropertyDefinition>;
33086
33165
  /**
33087
33166
  *
33088
33167
  * @type {string}
@@ -33096,6 +33175,7 @@ export declare const ModelsCreateCustomEventFieldRequestFieldTypeEnum: {
33096
33175
  readonly Boolean: "boolean";
33097
33176
  readonly Datetime: "datetime";
33098
33177
  readonly Array: "array";
33178
+ readonly Object: "object";
33099
33179
  };
33100
33180
  export type ModelsCreateCustomEventFieldRequestFieldTypeEnum = typeof ModelsCreateCustomEventFieldRequestFieldTypeEnum[keyof typeof ModelsCreateCustomEventFieldRequestFieldTypeEnum];
33101
33181
  /**
@@ -33178,6 +33258,31 @@ export interface ModelsMergeProfilesResponse {
33178
33258
  */
33179
33259
  'success'?: boolean;
33180
33260
  }
33261
+ /**
33262
+ *
33263
+ * @export
33264
+ * @interface ModelsNestedPropertyDefinition
33265
+ */
33266
+ export interface ModelsNestedPropertyDefinition {
33267
+ /**
33268
+ *
33269
+ * @type {string}
33270
+ * @memberof ModelsNestedPropertyDefinition
33271
+ */
33272
+ 'name'?: string;
33273
+ /**
33274
+ *
33275
+ * @type {boolean}
33276
+ * @memberof ModelsNestedPropertyDefinition
33277
+ */
33278
+ 'required'?: boolean;
33279
+ /**
33280
+ * string, number, boolean, datetime, array, object
33281
+ * @type {string}
33282
+ * @memberof ModelsNestedPropertyDefinition
33283
+ */
33284
+ 'type'?: string;
33285
+ }
33181
33286
  /**
33182
33287
  *
33183
33288
  * @export
@@ -33378,12 +33483,24 @@ export interface ModelsUpdateCustomEventFieldRequest {
33378
33483
  * @memberof ModelsUpdateCustomEventFieldRequest
33379
33484
  */
33380
33485
  'max_value'?: number;
33486
+ /**
33487
+ *
33488
+ * @type {number}
33489
+ * @memberof ModelsUpdateCustomEventFieldRequest
33490
+ */
33491
+ 'min_length'?: number;
33381
33492
  /**
33382
33493
  *
33383
33494
  * @type {number}
33384
33495
  * @memberof ModelsUpdateCustomEventFieldRequest
33385
33496
  */
33386
33497
  'min_value'?: number;
33498
+ /**
33499
+ *
33500
+ * @type {Array<ModelsNestedPropertyDefinition>}
33501
+ * @memberof ModelsUpdateCustomEventFieldRequest
33502
+ */
33503
+ 'nested_schema'?: Array<ModelsNestedPropertyDefinition>;
33387
33504
  /**
33388
33505
  *
33389
33506
  * @type {string}
@@ -35227,6 +35344,12 @@ export interface QuerySuggestionsServiceQuerySuggestionsRequest {
35227
35344
  * @memberof QuerySuggestionsServiceQuerySuggestionsRequest
35228
35345
  */
35229
35346
  'include_categories'?: boolean;
35347
+ /**
35348
+ * Optional: disable parts of dropdown when include_dropdown_recommendations=true (default true = include)
35349
+ * @type {boolean}
35350
+ * @memberof QuerySuggestionsServiceQuerySuggestionsRequest
35351
+ */
35352
+ 'include_dropdown_product_list'?: boolean;
35230
35353
  /**
35231
35354
  * Rich dropdown recommendations (optional, data-agnostic)
35232
35355
  * @type {boolean}
@@ -35245,6 +35368,12 @@ export interface QuerySuggestionsServiceQuerySuggestionsRequest {
35245
35368
  * @memberof QuerySuggestionsServiceQuerySuggestionsRequest
35246
35369
  */
35247
35370
  'include_facets'?: boolean;
35371
+ /**
35372
+ * When false, omit filtered_tabs from dropdown extensions (default true)
35373
+ * @type {boolean}
35374
+ * @memberof QuerySuggestionsServiceQuerySuggestionsRequest
35375
+ */
35376
+ 'include_filtered_tabs'?: boolean;
35248
35377
  /**
35249
35378
  * Max categories per suggestion (default: 3)
35250
35379
  * @type {number}
@@ -36716,31 +36845,31 @@ export interface V1AdminNotificationsTemplatesCodeSendPostRequest {
36716
36845
  */
36717
36846
  export interface V1ConnectorsSourcesSourceidUploaddataPostRequest {
36718
36847
  /**
36719
- * Config [json_upload, csv_upload]
36848
+ * Config (e.g. json_upload, csv_upload)
36720
36849
  * @type {string}
36721
36850
  * @memberof V1ConnectorsSourcesSourceidUploaddataPostRequest
36722
36851
  */
36723
36852
  'Config': string;
36724
36853
  /**
36725
- * File
36854
+ * File to upload
36726
36855
  * @type {File}
36727
36856
  * @memberof V1ConnectorsSourcesSourceidUploaddataPostRequest
36728
36857
  */
36729
36858
  'File': File;
36730
36859
  /**
36731
- * Name
36860
+ * Source name
36732
36861
  * @type {string}
36733
36862
  * @memberof V1ConnectorsSourcesSourceidUploaddataPostRequest
36734
36863
  */
36735
36864
  'Name': string;
36736
36865
  /**
36737
- * SourceTemplateId
36866
+ * Optional template ID
36738
36867
  * @type {string}
36739
36868
  * @memberof V1ConnectorsSourcesSourceidUploaddataPostRequest
36740
36869
  */
36741
36870
  'SourceTemplateId'?: string;
36742
36871
  /**
36743
- * Type
36872
+ * Data type
36744
36873
  * @type {string}
36745
36874
  * @memberof V1ConnectorsSourcesSourceidUploaddataPostRequest
36746
36875
  */
@@ -44075,6 +44204,14 @@ export declare const BillingDashboardApiAxiosParamCreator: (configuration?: Conf
44075
44204
  * @throws {RequiredError}
44076
44205
  */
44077
44206
  adminBillingInvoicesIdGet: (id: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
44207
+ /**
44208
+ * Returns a fresh presigned URL for the invoice PDF. Use this for viewing the invoice in the browser; the URL expires after 1 hour.
44209
+ * @summary Get invoice PDF signed URL
44210
+ * @param {string} id Invoice ID
44211
+ * @param {*} [options] Override http request option.
44212
+ * @throws {RequiredError}
44213
+ */
44214
+ adminBillingInvoicesIdPdfUrlGet: (id: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
44078
44215
  /**
44079
44216
  * Updates an existing invoice
44080
44217
  * @summary Update invoice
@@ -44214,6 +44351,14 @@ export declare const BillingDashboardApiAxiosParamCreator: (configuration?: Conf
44214
44351
  * @throws {RequiredError}
44215
44352
  */
44216
44353
  adminBillingReceiptsIdGet: (id: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
44354
+ /**
44355
+ * Returns a fresh presigned URL for the receipt PDF. Use this for viewing the receipt in the browser; the URL expires after 1 hour.
44356
+ * @summary Get receipt PDF signed URL
44357
+ * @param {number} id Receipt ID
44358
+ * @param {*} [options] Override http request option.
44359
+ * @throws {RequiredError}
44360
+ */
44361
+ adminBillingReceiptsIdPdfUrlGet: (id: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
44217
44362
  /**
44218
44363
  * Returns saved payment cards from Razorpay for the organization
44219
44364
  * @summary Get saved payment cards
@@ -44453,6 +44598,14 @@ export declare const BillingDashboardApiFp: (configuration?: Configuration) => {
44453
44598
  * @throws {RequiredError}
44454
44599
  */
44455
44600
  adminBillingInvoicesIdGet(id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesResponse>>;
44601
+ /**
44602
+ * Returns a fresh presigned URL for the invoice PDF. Use this for viewing the invoice in the browser; the URL expires after 1 hour.
44603
+ * @summary Get invoice PDF signed URL
44604
+ * @param {string} id Invoice ID
44605
+ * @param {*} [options] Override http request option.
44606
+ * @throws {RequiredError}
44607
+ */
44608
+ adminBillingInvoicesIdPdfUrlGet(id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesResponse>>;
44456
44609
  /**
44457
44610
  * Updates an existing invoice
44458
44611
  * @summary Update invoice
@@ -44592,6 +44745,14 @@ export declare const BillingDashboardApiFp: (configuration?: Configuration) => {
44592
44745
  * @throws {RequiredError}
44593
44746
  */
44594
44747
  adminBillingReceiptsIdGet(id: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesGenericResponseDataTypesReceipt>>;
44748
+ /**
44749
+ * Returns a fresh presigned URL for the receipt PDF. Use this for viewing the receipt in the browser; the URL expires after 1 hour.
44750
+ * @summary Get receipt PDF signed URL
44751
+ * @param {number} id Receipt ID
44752
+ * @param {*} [options] Override http request option.
44753
+ * @throws {RequiredError}
44754
+ */
44755
+ adminBillingReceiptsIdPdfUrlGet(id: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesResponse>>;
44595
44756
  /**
44596
44757
  * Returns saved payment cards from Razorpay for the organization
44597
44758
  * @summary Get saved payment cards
@@ -44831,6 +44992,14 @@ export declare const BillingDashboardApiFactory: (configuration?: Configuration,
44831
44992
  * @throws {RequiredError}
44832
44993
  */
44833
44994
  adminBillingInvoicesIdGet(id: string, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesResponse>;
44995
+ /**
44996
+ * Returns a fresh presigned URL for the invoice PDF. Use this for viewing the invoice in the browser; the URL expires after 1 hour.
44997
+ * @summary Get invoice PDF signed URL
44998
+ * @param {string} id Invoice ID
44999
+ * @param {*} [options] Override http request option.
45000
+ * @throws {RequiredError}
45001
+ */
45002
+ adminBillingInvoicesIdPdfUrlGet(id: string, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesResponse>;
44834
45003
  /**
44835
45004
  * Updates an existing invoice
44836
45005
  * @summary Update invoice
@@ -44970,6 +45139,14 @@ export declare const BillingDashboardApiFactory: (configuration?: Configuration,
44970
45139
  * @throws {RequiredError}
44971
45140
  */
44972
45141
  adminBillingReceiptsIdGet(id: number, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesGenericResponseDataTypesReceipt>;
45142
+ /**
45143
+ * Returns a fresh presigned URL for the receipt PDF. Use this for viewing the receipt in the browser; the URL expires after 1 hour.
45144
+ * @summary Get receipt PDF signed URL
45145
+ * @param {number} id Receipt ID
45146
+ * @param {*} [options] Override http request option.
45147
+ * @throws {RequiredError}
45148
+ */
45149
+ adminBillingReceiptsIdPdfUrlGet(id: number, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesResponse>;
44973
45150
  /**
44974
45151
  * Returns saved payment cards from Razorpay for the organization
44975
45152
  * @summary Get saved payment cards
@@ -45228,6 +45405,15 @@ export declare class BillingDashboardApi extends BaseAPI {
45228
45405
  * @memberof BillingDashboardApi
45229
45406
  */
45230
45407
  adminBillingInvoicesIdGet(id: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesResponse, any, {}>>;
45408
+ /**
45409
+ * Returns a fresh presigned URL for the invoice PDF. Use this for viewing the invoice in the browser; the URL expires after 1 hour.
45410
+ * @summary Get invoice PDF signed URL
45411
+ * @param {string} id Invoice ID
45412
+ * @param {*} [options] Override http request option.
45413
+ * @throws {RequiredError}
45414
+ * @memberof BillingDashboardApi
45415
+ */
45416
+ adminBillingInvoicesIdPdfUrlGet(id: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesResponse, any, {}>>;
45231
45417
  /**
45232
45418
  * Updates an existing invoice
45233
45419
  * @summary Update invoice
@@ -45381,6 +45567,15 @@ export declare class BillingDashboardApi extends BaseAPI {
45381
45567
  * @memberof BillingDashboardApi
45382
45568
  */
45383
45569
  adminBillingReceiptsIdGet(id: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesGenericResponseDataTypesReceipt, any, {}>>;
45570
+ /**
45571
+ * Returns a fresh presigned URL for the receipt PDF. Use this for viewing the receipt in the browser; the URL expires after 1 hour.
45572
+ * @summary Get receipt PDF signed URL
45573
+ * @param {number} id Receipt ID
45574
+ * @param {*} [options] Override http request option.
45575
+ * @throws {RequiredError}
45576
+ * @memberof BillingDashboardApi
45577
+ */
45578
+ adminBillingReceiptsIdPdfUrlGet(id: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesResponse, any, {}>>;
45384
45579
  /**
45385
45580
  * Returns saved payment cards from Razorpay for the organization
45386
45581
  * @summary Get saved payment cards
@@ -46102,102 +46297,110 @@ export declare const ConnectorsApiAxiosParamCreator: (configuration?: Configurat
46102
46297
  /**
46103
46298
  * List all connectors with optional filtering
46104
46299
  * @summary List Connectors
46300
+ * @param {string} xStoreID Store ID
46105
46301
  * @param {string} authorization Bearer JWT token
46106
46302
  * @param {string} [connectorType] Filter by connector type (import, export)
46107
46303
  * @param {string} [provider] Filter by provider
46108
46304
  * @param {boolean} [isActive] Filter by active status
46109
- * @param {number} [storeId] Filter by store ID
46110
46305
  * @param {number} [limit] Number of results (default: 50)
46111
46306
  * @param {number} [offset] Offset for pagination
46112
46307
  * @param {*} [options] Override http request option.
46113
46308
  * @throws {RequiredError}
46114
46309
  */
46115
- v1ConnectorsGet: (authorization: string, connectorType?: string, provider?: string, isActive?: boolean, storeId?: number, limit?: number, offset?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
46310
+ adminAnalyticsStoreXStoreIDConnectorsGet: (xStoreID: string, authorization: string, connectorType?: string, provider?: string, isActive?: boolean, limit?: number, offset?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
46116
46311
  /**
46117
46312
  * Delete a connector and its sync history
46118
46313
  * @summary Delete Connector
46314
+ * @param {string} xStoreID Store ID
46119
46315
  * @param {string} authorization Bearer JWT token
46120
46316
  * @param {number} id Connector ID
46121
46317
  * @param {*} [options] Override http request option.
46122
46318
  * @throws {RequiredError}
46123
46319
  */
46124
- v1ConnectorsIdDelete: (authorization: string, id: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
46320
+ adminAnalyticsStoreXStoreIDConnectorsIdDelete: (xStoreID: string, authorization: string, id: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
46125
46321
  /**
46126
46322
  * Retrieve a specific connector by ID
46127
46323
  * @summary Get Connector
46324
+ * @param {string} xStoreID Store ID
46128
46325
  * @param {string} authorization Bearer JWT token
46129
46326
  * @param {number} id Connector ID
46130
46327
  * @param {*} [options] Override http request option.
46131
46328
  * @throws {RequiredError}
46132
46329
  */
46133
- v1ConnectorsIdGet: (authorization: string, id: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
46330
+ adminAnalyticsStoreXStoreIDConnectorsIdGet: (xStoreID: string, authorization: string, id: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
46134
46331
  /**
46135
46332
  * Get sync history for a connector
46136
46333
  * @summary Get Sync History
46334
+ * @param {string} xStoreID Store ID
46137
46335
  * @param {string} authorization Bearer JWT token
46138
46336
  * @param {number} id Connector ID
46139
46337
  * @param {number} [limit] Number of results (default: 20)
46140
46338
  * @param {*} [options] Override http request option.
46141
46339
  * @throws {RequiredError}
46142
46340
  */
46143
- v1ConnectorsIdHistoryGet: (authorization: string, id: number, limit?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
46341
+ adminAnalyticsStoreXStoreIDConnectorsIdHistoryGet: (xStoreID: string, authorization: string, id: number, limit?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
46144
46342
  /**
46145
46343
  * Update an existing connector
46146
46344
  * @summary Update Connector
46345
+ * @param {string} xStoreID Store ID
46147
46346
  * @param {string} authorization Bearer JWT token
46148
46347
  * @param {number} id Connector ID
46149
46348
  * @param {ConnectorsUpdateConnectorRequest} connectorsUpdateConnectorRequest Updated connector configuration
46150
46349
  * @param {*} [options] Override http request option.
46151
46350
  * @throws {RequiredError}
46152
46351
  */
46153
- v1ConnectorsIdPut: (authorization: string, id: number, connectorsUpdateConnectorRequest: ConnectorsUpdateConnectorRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
46352
+ adminAnalyticsStoreXStoreIDConnectorsIdPut: (xStoreID: string, authorization: string, id: number, connectorsUpdateConnectorRequest: ConnectorsUpdateConnectorRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
46154
46353
  /**
46155
46354
  * Trigger a sync operation for a connector
46156
46355
  * @summary Trigger Sync
46356
+ * @param {string} xStoreID Store ID
46157
46357
  * @param {string} authorization Bearer JWT token
46158
46358
  * @param {number} id Connector ID
46159
46359
  * @param {*} [options] Override http request option.
46160
46360
  * @throws {RequiredError}
46161
46361
  */
46162
- v1ConnectorsIdSyncPost: (authorization: string, id: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
46362
+ adminAnalyticsStoreXStoreIDConnectorsIdSyncPost: (xStoreID: string, authorization: string, id: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
46163
46363
  /**
46164
46364
  * Test the connection to a connector\'s external service
46165
46365
  * @summary Test Connection
46366
+ * @param {string} xStoreID Store ID
46166
46367
  * @param {string} authorization Bearer JWT token
46167
46368
  * @param {number} id Connector ID
46168
46369
  * @param {*} [options] Override http request option.
46169
46370
  * @throws {RequiredError}
46170
46371
  */
46171
- v1ConnectorsIdTestPost: (authorization: string, id: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
46172
- /**
46173
- * Retrieves validation errors for a specific job ID if any invalid records were found during data upload
46174
- * @summary Get validation errors for a job
46175
- * @param {string} jobid Job ID
46176
- * @param {*} [options] Override http request option.
46177
- * @throws {RequiredError}
46178
- */
46179
- v1ConnectorsJobstatusJobidValidationErrorsGet: (jobid: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
46372
+ adminAnalyticsStoreXStoreIDConnectorsIdTestPost: (xStoreID: string, authorization: string, id: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
46180
46373
  /**
46181
46374
  * Create a new analytics connector for importing or exporting events
46182
46375
  * @summary Create Connector
46376
+ * @param {string} xStoreID Store ID
46183
46377
  * @param {string} authorization Bearer JWT token
46184
46378
  * @param {ConnectorsCreateConnectorRequest} connectorsCreateConnectorRequest Connector configuration
46185
46379
  * @param {*} [options] Override http request option.
46186
46380
  * @throws {RequiredError}
46187
46381
  */
46188
- v1ConnectorsPost: (authorization: string, connectorsCreateConnectorRequest: ConnectorsCreateConnectorRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
46382
+ adminAnalyticsStoreXStoreIDConnectorsPost: (xStoreID: string, authorization: string, connectorsCreateConnectorRequest: ConnectorsCreateConnectorRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
46189
46383
  /**
46190
46384
  * Get list of available connector providers
46191
46385
  * @summary Get Available Providers
46386
+ * @param {string} xStoreID Store ID
46192
46387
  * @param {string} authorization Bearer JWT token
46193
46388
  * @param {string} [type] Connector type (import, export)
46194
46389
  * @param {*} [options] Override http request option.
46195
46390
  * @throws {RequiredError}
46196
46391
  */
46197
- v1ConnectorsProvidersGet: (authorization: string, type?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
46392
+ adminAnalyticsStoreXStoreIDConnectorsProvidersGet: (xStoreID: string, authorization: string, type?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
46198
46393
  /**
46199
- * Test search
46200
- * @summary Test search
46394
+ * Returns validation errors for an upload job (e.g. invalid rows). Use the job ID returned from the upload endpoint. **Auth:** store credentials or JWT.
46395
+ * @summary Get validation errors for a job
46396
+ * @param {string} jobid Job ID from upload response
46397
+ * @param {*} [options] Override http request option.
46398
+ * @throws {RequiredError}
46399
+ */
46400
+ v1ConnectorsJobstatusJobidValidationErrorsGet: (jobid: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
46401
+ /**
46402
+ * Run a test search against a connector index. **Auth:** store credentials. Query param `q` is required. Use to verify connector sync results.
46403
+ * @summary Test search for an index
46201
46404
  * @param {string} index Index name
46202
46405
  * @param {string} q Search query
46203
46406
  * @param {*} [options] Override http request option.
@@ -46205,25 +46408,25 @@ export declare const ConnectorsApiAxiosParamCreator: (configuration?: Configurat
46205
46408
  */
46206
46409
  v1ConnectorsSearchIndexGet: (index: string, q: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
46207
46410
  /**
46208
- * Get all sources
46209
- * @summary Get all sources
46411
+ * List all data sources for the store. **Auth:** `x-storeid` and `x-storesecret`.
46412
+ * @summary List data sources
46210
46413
  * @param {*} [options] Override http request option.
46211
46414
  * @throws {RequiredError}
46212
46415
  */
46213
46416
  v1ConnectorsSourcesGet: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
46214
46417
  /**
46215
- * Create source
46216
- * @summary Create source
46217
- * @param {DataTypesCreateSourceRequest} dataTypesCreateSourceRequest Source
46418
+ * Register a new data source for the store. **Auth:** `x-storeid` and `x-storesecret`. Used by connector integrations to sync data into the search index.
46419
+ * @summary Create data source
46420
+ * @param {DataTypesCreateSourceRequest} dataTypesCreateSourceRequest Source configuration
46218
46421
  * @param {*} [options] Override http request option.
46219
46422
  * @throws {RequiredError}
46220
46423
  */
46221
46424
  v1ConnectorsSourcesPost: (dataTypesCreateSourceRequest: DataTypesCreateSourceRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
46222
46425
  /**
46223
- * Update source config by id
46224
- * @summary Update source config by id
46426
+ * Update configuration for a data source. **Auth:** store credentials or JWT. Body: `config` object with key-value settings.
46427
+ * @summary Update source config
46225
46428
  * @param {string} sourceId Source ID
46226
- * @param {{ [key: string]: any; }} requestBody Config
46429
+ * @param {{ [key: string]: any; }} requestBody Config key-value map
46227
46430
  * @param {*} [options] Override http request option.
46228
46431
  * @throws {RequiredError}
46229
46432
  */
@@ -46231,23 +46434,24 @@ export declare const ConnectorsApiAxiosParamCreator: (configuration?: Configurat
46231
46434
  [key: string]: any;
46232
46435
  }, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
46233
46436
  /**
46234
- * Get source by id
46235
- * @summary Get source by id
46437
+ * Fetch a single data source by ID. **Auth:** `x-storeid` and `x-storesecret`.
46438
+ * @summary Get source by ID
46439
+ * @param {string} sourceId Source ID
46236
46440
  * @param {*} [options] Override http request option.
46237
46441
  * @throws {RequiredError}
46238
46442
  */
46239
- v1ConnectorsSourcesSourceIdGet: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
46443
+ v1ConnectorsSourcesSourceIdGet: (sourceId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
46240
46444
  /**
46241
- * Update Index schema
46242
- * @summary Update Index schema
46243
- * @param {string} sourceid Source ID to update schema
46244
- * @param {DataTypesUpdateIndexSchemaRequest} dataTypesUpdateIndexSchemaRequest Schema
46445
+ * Update the search index schema for a connector source. **Auth:** `x-storeid` and `x-storesecret`. Body: schema definition.
46446
+ * @summary Update source index schema
46447
+ * @param {string} sourceid Source ID
46448
+ * @param {DataTypesUpdateIndexSchemaRequest} dataTypesUpdateIndexSchemaRequest Schema definition
46245
46449
  * @param {*} [options] Override http request option.
46246
46450
  * @throws {RequiredError}
46247
46451
  */
46248
46452
  v1ConnectorsSourcesSourceidUpdateschemaPost: (sourceid: string, dataTypesUpdateIndexSchemaRequest: DataTypesUpdateIndexSchemaRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
46249
46453
  /**
46250
- * Upload source data
46454
+ * Upload a file (JSON or CSV) to a data source for indexing. **Auth:** `x-storeid` and `x-storesecret`. Use form-data: Name, Type, Config (e.g. json_upload, csv_upload), and File.
46251
46455
  * @summary Upload source data
46252
46456
  * @param {V1ConnectorsSourcesSourceidUploaddataPostRequest} [v1ConnectorsSourcesSourceidUploaddataPostRequest]
46253
46457
  * @param {*} [options] Override http request option.
@@ -46255,18 +46459,18 @@ export declare const ConnectorsApiAxiosParamCreator: (configuration?: Configurat
46255
46459
  */
46256
46460
  v1ConnectorsSourcesSourceidUploaddataPost: (v1ConnectorsSourcesSourceidUploaddataPostRequest?: V1ConnectorsSourcesSourceidUploaddataPostRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
46257
46461
  /**
46258
- * Create task
46259
- * @summary Create task
46260
- * @param {DataTypesCreateTaskRequest} dataTypesCreateTaskRequest Task
46462
+ * Create a sync task for a data source. **Auth:** `x-storeid` and `x-storesecret`. Task defines when and how to sync data.
46463
+ * @summary Create connector task
46464
+ * @param {DataTypesCreateTaskRequest} dataTypesCreateTaskRequest Task configuration
46261
46465
  * @param {*} [options] Override http request option.
46262
46466
  * @throws {RequiredError}
46263
46467
  */
46264
46468
  v1ConnectorsTasksPost: (dataTypesCreateTaskRequest: DataTypesCreateTaskRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
46265
46469
  /**
46266
- * Trigger task run
46470
+ * Run a connector sync task once. **Auth:** `x-storeid` and `x-storesecret`. Body can include initiated_by (user ID).
46267
46471
  * @summary Trigger task run
46268
46472
  * @param {string} taskId Task ID
46269
- * @param {number} body Initiated by
46473
+ * @param {number} body User ID who triggered the run
46270
46474
  * @param {*} [options] Override http request option.
46271
46475
  * @throws {RequiredError}
46272
46476
  */
@@ -46280,120 +46484,128 @@ export declare const ConnectorsApiFp: (configuration?: Configuration) => {
46280
46484
  /**
46281
46485
  * List all connectors with optional filtering
46282
46486
  * @summary List Connectors
46487
+ * @param {string} xStoreID Store ID
46283
46488
  * @param {string} authorization Bearer JWT token
46284
46489
  * @param {string} [connectorType] Filter by connector type (import, export)
46285
46490
  * @param {string} [provider] Filter by provider
46286
46491
  * @param {boolean} [isActive] Filter by active status
46287
- * @param {number} [storeId] Filter by store ID
46288
46492
  * @param {number} [limit] Number of results (default: 50)
46289
46493
  * @param {number} [offset] Offset for pagination
46290
46494
  * @param {*} [options] Override http request option.
46291
46495
  * @throws {RequiredError}
46292
46496
  */
46293
- v1ConnectorsGet(authorization: string, connectorType?: string, provider?: string, isActive?: boolean, storeId?: number, limit?: number, offset?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<{
46497
+ adminAnalyticsStoreXStoreIDConnectorsGet(xStoreID: string, authorization: string, connectorType?: string, provider?: string, isActive?: boolean, limit?: number, offset?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<{
46294
46498
  [key: string]: any;
46295
46499
  }>>;
46296
46500
  /**
46297
46501
  * Delete a connector and its sync history
46298
46502
  * @summary Delete Connector
46503
+ * @param {string} xStoreID Store ID
46299
46504
  * @param {string} authorization Bearer JWT token
46300
46505
  * @param {number} id Connector ID
46301
46506
  * @param {*} [options] Override http request option.
46302
46507
  * @throws {RequiredError}
46303
46508
  */
46304
- v1ConnectorsIdDelete(authorization: string, id: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<{
46509
+ adminAnalyticsStoreXStoreIDConnectorsIdDelete(xStoreID: string, authorization: string, id: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<{
46305
46510
  [key: string]: any;
46306
46511
  }>>;
46307
46512
  /**
46308
46513
  * Retrieve a specific connector by ID
46309
46514
  * @summary Get Connector
46515
+ * @param {string} xStoreID Store ID
46310
46516
  * @param {string} authorization Bearer JWT token
46311
46517
  * @param {number} id Connector ID
46312
46518
  * @param {*} [options] Override http request option.
46313
46519
  * @throws {RequiredError}
46314
46520
  */
46315
- v1ConnectorsIdGet(authorization: string, id: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<{
46521
+ adminAnalyticsStoreXStoreIDConnectorsIdGet(xStoreID: string, authorization: string, id: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<{
46316
46522
  [key: string]: any;
46317
46523
  }>>;
46318
46524
  /**
46319
46525
  * Get sync history for a connector
46320
46526
  * @summary Get Sync History
46527
+ * @param {string} xStoreID Store ID
46321
46528
  * @param {string} authorization Bearer JWT token
46322
46529
  * @param {number} id Connector ID
46323
46530
  * @param {number} [limit] Number of results (default: 20)
46324
46531
  * @param {*} [options] Override http request option.
46325
46532
  * @throws {RequiredError}
46326
46533
  */
46327
- v1ConnectorsIdHistoryGet(authorization: string, id: number, limit?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<{
46534
+ adminAnalyticsStoreXStoreIDConnectorsIdHistoryGet(xStoreID: string, authorization: string, id: number, limit?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<{
46328
46535
  [key: string]: any;
46329
46536
  }>>;
46330
46537
  /**
46331
46538
  * Update an existing connector
46332
46539
  * @summary Update Connector
46540
+ * @param {string} xStoreID Store ID
46333
46541
  * @param {string} authorization Bearer JWT token
46334
46542
  * @param {number} id Connector ID
46335
46543
  * @param {ConnectorsUpdateConnectorRequest} connectorsUpdateConnectorRequest Updated connector configuration
46336
46544
  * @param {*} [options] Override http request option.
46337
46545
  * @throws {RequiredError}
46338
46546
  */
46339
- v1ConnectorsIdPut(authorization: string, id: number, connectorsUpdateConnectorRequest: ConnectorsUpdateConnectorRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<{
46547
+ adminAnalyticsStoreXStoreIDConnectorsIdPut(xStoreID: string, authorization: string, id: number, connectorsUpdateConnectorRequest: ConnectorsUpdateConnectorRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<{
46340
46548
  [key: string]: any;
46341
46549
  }>>;
46342
46550
  /**
46343
46551
  * Trigger a sync operation for a connector
46344
46552
  * @summary Trigger Sync
46553
+ * @param {string} xStoreID Store ID
46345
46554
  * @param {string} authorization Bearer JWT token
46346
46555
  * @param {number} id Connector ID
46347
46556
  * @param {*} [options] Override http request option.
46348
46557
  * @throws {RequiredError}
46349
46558
  */
46350
- v1ConnectorsIdSyncPost(authorization: string, id: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<{
46559
+ adminAnalyticsStoreXStoreIDConnectorsIdSyncPost(xStoreID: string, authorization: string, id: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<{
46351
46560
  [key: string]: any;
46352
46561
  }>>;
46353
46562
  /**
46354
46563
  * Test the connection to a connector\'s external service
46355
46564
  * @summary Test Connection
46565
+ * @param {string} xStoreID Store ID
46356
46566
  * @param {string} authorization Bearer JWT token
46357
46567
  * @param {number} id Connector ID
46358
46568
  * @param {*} [options] Override http request option.
46359
46569
  * @throws {RequiredError}
46360
46570
  */
46361
- v1ConnectorsIdTestPost(authorization: string, id: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<{
46571
+ adminAnalyticsStoreXStoreIDConnectorsIdTestPost(xStoreID: string, authorization: string, id: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<{
46362
46572
  [key: string]: any;
46363
46573
  }>>;
46364
- /**
46365
- * Retrieves validation errors for a specific job ID if any invalid records were found during data upload
46366
- * @summary Get validation errors for a job
46367
- * @param {string} jobid Job ID
46368
- * @param {*} [options] Override http request option.
46369
- * @throws {RequiredError}
46370
- */
46371
- v1ConnectorsJobstatusJobidValidationErrorsGet(jobid: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesValidationErrorResponse>>;
46372
46574
  /**
46373
46575
  * Create a new analytics connector for importing or exporting events
46374
46576
  * @summary Create Connector
46577
+ * @param {string} xStoreID Store ID
46375
46578
  * @param {string} authorization Bearer JWT token
46376
46579
  * @param {ConnectorsCreateConnectorRequest} connectorsCreateConnectorRequest Connector configuration
46377
46580
  * @param {*} [options] Override http request option.
46378
46581
  * @throws {RequiredError}
46379
46582
  */
46380
- v1ConnectorsPost(authorization: string, connectorsCreateConnectorRequest: ConnectorsCreateConnectorRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<{
46583
+ adminAnalyticsStoreXStoreIDConnectorsPost(xStoreID: string, authorization: string, connectorsCreateConnectorRequest: ConnectorsCreateConnectorRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<{
46381
46584
  [key: string]: any;
46382
46585
  }>>;
46383
46586
  /**
46384
46587
  * Get list of available connector providers
46385
46588
  * @summary Get Available Providers
46589
+ * @param {string} xStoreID Store ID
46386
46590
  * @param {string} authorization Bearer JWT token
46387
46591
  * @param {string} [type] Connector type (import, export)
46388
46592
  * @param {*} [options] Override http request option.
46389
46593
  * @throws {RequiredError}
46390
46594
  */
46391
- v1ConnectorsProvidersGet(authorization: string, type?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<{
46595
+ adminAnalyticsStoreXStoreIDConnectorsProvidersGet(xStoreID: string, authorization: string, type?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<{
46392
46596
  [key: string]: any;
46393
46597
  }>>;
46394
46598
  /**
46395
- * Test search
46396
- * @summary Test search
46599
+ * Returns validation errors for an upload job (e.g. invalid rows). Use the job ID returned from the upload endpoint. **Auth:** store credentials or JWT.
46600
+ * @summary Get validation errors for a job
46601
+ * @param {string} jobid Job ID from upload response
46602
+ * @param {*} [options] Override http request option.
46603
+ * @throws {RequiredError}
46604
+ */
46605
+ v1ConnectorsJobstatusJobidValidationErrorsGet(jobid: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesValidationErrorResponse>>;
46606
+ /**
46607
+ * Run a test search against a connector index. **Auth:** store credentials. Query param `q` is required. Use to verify connector sync results.
46608
+ * @summary Test search for an index
46397
46609
  * @param {string} index Index name
46398
46610
  * @param {string} q Search query
46399
46611
  * @param {*} [options] Override http request option.
@@ -46401,25 +46613,25 @@ export declare const ConnectorsApiFp: (configuration?: Configuration) => {
46401
46613
  */
46402
46614
  v1ConnectorsSearchIndexGet(index: string, q: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesSearchResultResponse>>;
46403
46615
  /**
46404
- * Get all sources
46405
- * @summary Get all sources
46616
+ * List all data sources for the store. **Auth:** `x-storeid` and `x-storesecret`.
46617
+ * @summary List data sources
46406
46618
  * @param {*} [options] Override http request option.
46407
46619
  * @throws {RequiredError}
46408
46620
  */
46409
46621
  v1ConnectorsSourcesGet(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesSourcesListResponse>>;
46410
46622
  /**
46411
- * Create source
46412
- * @summary Create source
46413
- * @param {DataTypesCreateSourceRequest} dataTypesCreateSourceRequest Source
46623
+ * Register a new data source for the store. **Auth:** `x-storeid` and `x-storesecret`. Used by connector integrations to sync data into the search index.
46624
+ * @summary Create data source
46625
+ * @param {DataTypesCreateSourceRequest} dataTypesCreateSourceRequest Source configuration
46414
46626
  * @param {*} [options] Override http request option.
46415
46627
  * @throws {RequiredError}
46416
46628
  */
46417
46629
  v1ConnectorsSourcesPost(dataTypesCreateSourceRequest: DataTypesCreateSourceRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesCreateSourceResponse>>;
46418
46630
  /**
46419
- * Update source config by id
46420
- * @summary Update source config by id
46631
+ * Update configuration for a data source. **Auth:** store credentials or JWT. Body: `config` object with key-value settings.
46632
+ * @summary Update source config
46421
46633
  * @param {string} sourceId Source ID
46422
- * @param {{ [key: string]: any; }} requestBody Config
46634
+ * @param {{ [key: string]: any; }} requestBody Config key-value map
46423
46635
  * @param {*} [options] Override http request option.
46424
46636
  * @throws {RequiredError}
46425
46637
  */
@@ -46427,23 +46639,24 @@ export declare const ConnectorsApiFp: (configuration?: Configuration) => {
46427
46639
  [key: string]: any;
46428
46640
  }, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesResponse>>;
46429
46641
  /**
46430
- * Get source by id
46431
- * @summary Get source by id
46642
+ * Fetch a single data source by ID. **Auth:** `x-storeid` and `x-storesecret`.
46643
+ * @summary Get source by ID
46644
+ * @param {string} sourceId Source ID
46432
46645
  * @param {*} [options] Override http request option.
46433
46646
  * @throws {RequiredError}
46434
46647
  */
46435
- v1ConnectorsSourcesSourceIdGet(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesUpdateSourceConfigResponseWrapper>>;
46648
+ v1ConnectorsSourcesSourceIdGet(sourceId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesUpdateSourceConfigResponseWrapper>>;
46436
46649
  /**
46437
- * Update Index schema
46438
- * @summary Update Index schema
46439
- * @param {string} sourceid Source ID to update schema
46440
- * @param {DataTypesUpdateIndexSchemaRequest} dataTypesUpdateIndexSchemaRequest Schema
46650
+ * Update the search index schema for a connector source. **Auth:** `x-storeid` and `x-storesecret`. Body: schema definition.
46651
+ * @summary Update source index schema
46652
+ * @param {string} sourceid Source ID
46653
+ * @param {DataTypesUpdateIndexSchemaRequest} dataTypesUpdateIndexSchemaRequest Schema definition
46441
46654
  * @param {*} [options] Override http request option.
46442
46655
  * @throws {RequiredError}
46443
46656
  */
46444
46657
  v1ConnectorsSourcesSourceidUpdateschemaPost(sourceid: string, dataTypesUpdateIndexSchemaRequest: DataTypesUpdateIndexSchemaRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesUpdateSchemaResponse>>;
46445
46658
  /**
46446
- * Upload source data
46659
+ * Upload a file (JSON or CSV) to a data source for indexing. **Auth:** `x-storeid` and `x-storesecret`. Use form-data: Name, Type, Config (e.g. json_upload, csv_upload), and File.
46447
46660
  * @summary Upload source data
46448
46661
  * @param {V1ConnectorsSourcesSourceidUploaddataPostRequest} [v1ConnectorsSourcesSourceidUploaddataPostRequest]
46449
46662
  * @param {*} [options] Override http request option.
@@ -46451,18 +46664,18 @@ export declare const ConnectorsApiFp: (configuration?: Configuration) => {
46451
46664
  */
46452
46665
  v1ConnectorsSourcesSourceidUploaddataPost(v1ConnectorsSourcesSourceidUploaddataPostRequest?: V1ConnectorsSourcesSourceidUploaddataPostRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesUploadSourceDataResponseWrapper>>;
46453
46666
  /**
46454
- * Create task
46455
- * @summary Create task
46456
- * @param {DataTypesCreateTaskRequest} dataTypesCreateTaskRequest Task
46667
+ * Create a sync task for a data source. **Auth:** `x-storeid` and `x-storesecret`. Task defines when and how to sync data.
46668
+ * @summary Create connector task
46669
+ * @param {DataTypesCreateTaskRequest} dataTypesCreateTaskRequest Task configuration
46457
46670
  * @param {*} [options] Override http request option.
46458
46671
  * @throws {RequiredError}
46459
46672
  */
46460
46673
  v1ConnectorsTasksPost(dataTypesCreateTaskRequest: DataTypesCreateTaskRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesCreateTaskResponse>>;
46461
46674
  /**
46462
- * Trigger task run
46675
+ * Run a connector sync task once. **Auth:** `x-storeid` and `x-storesecret`. Body can include initiated_by (user ID).
46463
46676
  * @summary Trigger task run
46464
46677
  * @param {string} taskId Task ID
46465
- * @param {number} body Initiated by
46678
+ * @param {number} body User ID who triggered the run
46466
46679
  * @param {*} [options] Override http request option.
46467
46680
  * @throws {RequiredError}
46468
46681
  */
@@ -46476,120 +46689,128 @@ export declare const ConnectorsApiFactory: (configuration?: Configuration, baseP
46476
46689
  /**
46477
46690
  * List all connectors with optional filtering
46478
46691
  * @summary List Connectors
46692
+ * @param {string} xStoreID Store ID
46479
46693
  * @param {string} authorization Bearer JWT token
46480
46694
  * @param {string} [connectorType] Filter by connector type (import, export)
46481
46695
  * @param {string} [provider] Filter by provider
46482
46696
  * @param {boolean} [isActive] Filter by active status
46483
- * @param {number} [storeId] Filter by store ID
46484
46697
  * @param {number} [limit] Number of results (default: 50)
46485
46698
  * @param {number} [offset] Offset for pagination
46486
46699
  * @param {*} [options] Override http request option.
46487
46700
  * @throws {RequiredError}
46488
46701
  */
46489
- v1ConnectorsGet(authorization: string, connectorType?: string, provider?: string, isActive?: boolean, storeId?: number, limit?: number, offset?: number, options?: RawAxiosRequestConfig): AxiosPromise<{
46702
+ adminAnalyticsStoreXStoreIDConnectorsGet(xStoreID: string, authorization: string, connectorType?: string, provider?: string, isActive?: boolean, limit?: number, offset?: number, options?: RawAxiosRequestConfig): AxiosPromise<{
46490
46703
  [key: string]: any;
46491
46704
  }>;
46492
46705
  /**
46493
46706
  * Delete a connector and its sync history
46494
46707
  * @summary Delete Connector
46708
+ * @param {string} xStoreID Store ID
46495
46709
  * @param {string} authorization Bearer JWT token
46496
46710
  * @param {number} id Connector ID
46497
46711
  * @param {*} [options] Override http request option.
46498
46712
  * @throws {RequiredError}
46499
46713
  */
46500
- v1ConnectorsIdDelete(authorization: string, id: number, options?: RawAxiosRequestConfig): AxiosPromise<{
46714
+ adminAnalyticsStoreXStoreIDConnectorsIdDelete(xStoreID: string, authorization: string, id: number, options?: RawAxiosRequestConfig): AxiosPromise<{
46501
46715
  [key: string]: any;
46502
46716
  }>;
46503
46717
  /**
46504
46718
  * Retrieve a specific connector by ID
46505
46719
  * @summary Get Connector
46720
+ * @param {string} xStoreID Store ID
46506
46721
  * @param {string} authorization Bearer JWT token
46507
46722
  * @param {number} id Connector ID
46508
46723
  * @param {*} [options] Override http request option.
46509
46724
  * @throws {RequiredError}
46510
46725
  */
46511
- v1ConnectorsIdGet(authorization: string, id: number, options?: RawAxiosRequestConfig): AxiosPromise<{
46726
+ adminAnalyticsStoreXStoreIDConnectorsIdGet(xStoreID: string, authorization: string, id: number, options?: RawAxiosRequestConfig): AxiosPromise<{
46512
46727
  [key: string]: any;
46513
46728
  }>;
46514
46729
  /**
46515
46730
  * Get sync history for a connector
46516
46731
  * @summary Get Sync History
46732
+ * @param {string} xStoreID Store ID
46517
46733
  * @param {string} authorization Bearer JWT token
46518
46734
  * @param {number} id Connector ID
46519
46735
  * @param {number} [limit] Number of results (default: 20)
46520
46736
  * @param {*} [options] Override http request option.
46521
46737
  * @throws {RequiredError}
46522
46738
  */
46523
- v1ConnectorsIdHistoryGet(authorization: string, id: number, limit?: number, options?: RawAxiosRequestConfig): AxiosPromise<{
46739
+ adminAnalyticsStoreXStoreIDConnectorsIdHistoryGet(xStoreID: string, authorization: string, id: number, limit?: number, options?: RawAxiosRequestConfig): AxiosPromise<{
46524
46740
  [key: string]: any;
46525
46741
  }>;
46526
46742
  /**
46527
46743
  * Update an existing connector
46528
46744
  * @summary Update Connector
46745
+ * @param {string} xStoreID Store ID
46529
46746
  * @param {string} authorization Bearer JWT token
46530
46747
  * @param {number} id Connector ID
46531
46748
  * @param {ConnectorsUpdateConnectorRequest} connectorsUpdateConnectorRequest Updated connector configuration
46532
46749
  * @param {*} [options] Override http request option.
46533
46750
  * @throws {RequiredError}
46534
46751
  */
46535
- v1ConnectorsIdPut(authorization: string, id: number, connectorsUpdateConnectorRequest: ConnectorsUpdateConnectorRequest, options?: RawAxiosRequestConfig): AxiosPromise<{
46752
+ adminAnalyticsStoreXStoreIDConnectorsIdPut(xStoreID: string, authorization: string, id: number, connectorsUpdateConnectorRequest: ConnectorsUpdateConnectorRequest, options?: RawAxiosRequestConfig): AxiosPromise<{
46536
46753
  [key: string]: any;
46537
46754
  }>;
46538
46755
  /**
46539
46756
  * Trigger a sync operation for a connector
46540
46757
  * @summary Trigger Sync
46758
+ * @param {string} xStoreID Store ID
46541
46759
  * @param {string} authorization Bearer JWT token
46542
46760
  * @param {number} id Connector ID
46543
46761
  * @param {*} [options] Override http request option.
46544
46762
  * @throws {RequiredError}
46545
46763
  */
46546
- v1ConnectorsIdSyncPost(authorization: string, id: number, options?: RawAxiosRequestConfig): AxiosPromise<{
46764
+ adminAnalyticsStoreXStoreIDConnectorsIdSyncPost(xStoreID: string, authorization: string, id: number, options?: RawAxiosRequestConfig): AxiosPromise<{
46547
46765
  [key: string]: any;
46548
46766
  }>;
46549
46767
  /**
46550
46768
  * Test the connection to a connector\'s external service
46551
46769
  * @summary Test Connection
46770
+ * @param {string} xStoreID Store ID
46552
46771
  * @param {string} authorization Bearer JWT token
46553
46772
  * @param {number} id Connector ID
46554
46773
  * @param {*} [options] Override http request option.
46555
46774
  * @throws {RequiredError}
46556
46775
  */
46557
- v1ConnectorsIdTestPost(authorization: string, id: number, options?: RawAxiosRequestConfig): AxiosPromise<{
46776
+ adminAnalyticsStoreXStoreIDConnectorsIdTestPost(xStoreID: string, authorization: string, id: number, options?: RawAxiosRequestConfig): AxiosPromise<{
46558
46777
  [key: string]: any;
46559
46778
  }>;
46560
- /**
46561
- * Retrieves validation errors for a specific job ID if any invalid records were found during data upload
46562
- * @summary Get validation errors for a job
46563
- * @param {string} jobid Job ID
46564
- * @param {*} [options] Override http request option.
46565
- * @throws {RequiredError}
46566
- */
46567
- v1ConnectorsJobstatusJobidValidationErrorsGet(jobid: string, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesValidationErrorResponse>;
46568
46779
  /**
46569
46780
  * Create a new analytics connector for importing or exporting events
46570
46781
  * @summary Create Connector
46782
+ * @param {string} xStoreID Store ID
46571
46783
  * @param {string} authorization Bearer JWT token
46572
46784
  * @param {ConnectorsCreateConnectorRequest} connectorsCreateConnectorRequest Connector configuration
46573
46785
  * @param {*} [options] Override http request option.
46574
46786
  * @throws {RequiredError}
46575
46787
  */
46576
- v1ConnectorsPost(authorization: string, connectorsCreateConnectorRequest: ConnectorsCreateConnectorRequest, options?: RawAxiosRequestConfig): AxiosPromise<{
46788
+ adminAnalyticsStoreXStoreIDConnectorsPost(xStoreID: string, authorization: string, connectorsCreateConnectorRequest: ConnectorsCreateConnectorRequest, options?: RawAxiosRequestConfig): AxiosPromise<{
46577
46789
  [key: string]: any;
46578
46790
  }>;
46579
46791
  /**
46580
46792
  * Get list of available connector providers
46581
46793
  * @summary Get Available Providers
46794
+ * @param {string} xStoreID Store ID
46582
46795
  * @param {string} authorization Bearer JWT token
46583
46796
  * @param {string} [type] Connector type (import, export)
46584
46797
  * @param {*} [options] Override http request option.
46585
46798
  * @throws {RequiredError}
46586
46799
  */
46587
- v1ConnectorsProvidersGet(authorization: string, type?: string, options?: RawAxiosRequestConfig): AxiosPromise<{
46800
+ adminAnalyticsStoreXStoreIDConnectorsProvidersGet(xStoreID: string, authorization: string, type?: string, options?: RawAxiosRequestConfig): AxiosPromise<{
46588
46801
  [key: string]: any;
46589
46802
  }>;
46590
46803
  /**
46591
- * Test search
46592
- * @summary Test search
46804
+ * Returns validation errors for an upload job (e.g. invalid rows). Use the job ID returned from the upload endpoint. **Auth:** store credentials or JWT.
46805
+ * @summary Get validation errors for a job
46806
+ * @param {string} jobid Job ID from upload response
46807
+ * @param {*} [options] Override http request option.
46808
+ * @throws {RequiredError}
46809
+ */
46810
+ v1ConnectorsJobstatusJobidValidationErrorsGet(jobid: string, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesValidationErrorResponse>;
46811
+ /**
46812
+ * Run a test search against a connector index. **Auth:** store credentials. Query param `q` is required. Use to verify connector sync results.
46813
+ * @summary Test search for an index
46593
46814
  * @param {string} index Index name
46594
46815
  * @param {string} q Search query
46595
46816
  * @param {*} [options] Override http request option.
@@ -46597,25 +46818,25 @@ export declare const ConnectorsApiFactory: (configuration?: Configuration, baseP
46597
46818
  */
46598
46819
  v1ConnectorsSearchIndexGet(index: string, q: string, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesSearchResultResponse>;
46599
46820
  /**
46600
- * Get all sources
46601
- * @summary Get all sources
46821
+ * List all data sources for the store. **Auth:** `x-storeid` and `x-storesecret`.
46822
+ * @summary List data sources
46602
46823
  * @param {*} [options] Override http request option.
46603
46824
  * @throws {RequiredError}
46604
46825
  */
46605
46826
  v1ConnectorsSourcesGet(options?: RawAxiosRequestConfig): AxiosPromise<DataTypesSourcesListResponse>;
46606
46827
  /**
46607
- * Create source
46608
- * @summary Create source
46609
- * @param {DataTypesCreateSourceRequest} dataTypesCreateSourceRequest Source
46828
+ * Register a new data source for the store. **Auth:** `x-storeid` and `x-storesecret`. Used by connector integrations to sync data into the search index.
46829
+ * @summary Create data source
46830
+ * @param {DataTypesCreateSourceRequest} dataTypesCreateSourceRequest Source configuration
46610
46831
  * @param {*} [options] Override http request option.
46611
46832
  * @throws {RequiredError}
46612
46833
  */
46613
46834
  v1ConnectorsSourcesPost(dataTypesCreateSourceRequest: DataTypesCreateSourceRequest, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesCreateSourceResponse>;
46614
46835
  /**
46615
- * Update source config by id
46616
- * @summary Update source config by id
46836
+ * Update configuration for a data source. **Auth:** store credentials or JWT. Body: `config` object with key-value settings.
46837
+ * @summary Update source config
46617
46838
  * @param {string} sourceId Source ID
46618
- * @param {{ [key: string]: any; }} requestBody Config
46839
+ * @param {{ [key: string]: any; }} requestBody Config key-value map
46619
46840
  * @param {*} [options] Override http request option.
46620
46841
  * @throws {RequiredError}
46621
46842
  */
@@ -46623,23 +46844,24 @@ export declare const ConnectorsApiFactory: (configuration?: Configuration, baseP
46623
46844
  [key: string]: any;
46624
46845
  }, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesResponse>;
46625
46846
  /**
46626
- * Get source by id
46627
- * @summary Get source by id
46847
+ * Fetch a single data source by ID. **Auth:** `x-storeid` and `x-storesecret`.
46848
+ * @summary Get source by ID
46849
+ * @param {string} sourceId Source ID
46628
46850
  * @param {*} [options] Override http request option.
46629
46851
  * @throws {RequiredError}
46630
46852
  */
46631
- v1ConnectorsSourcesSourceIdGet(options?: RawAxiosRequestConfig): AxiosPromise<DataTypesUpdateSourceConfigResponseWrapper>;
46853
+ v1ConnectorsSourcesSourceIdGet(sourceId: string, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesUpdateSourceConfigResponseWrapper>;
46632
46854
  /**
46633
- * Update Index schema
46634
- * @summary Update Index schema
46635
- * @param {string} sourceid Source ID to update schema
46636
- * @param {DataTypesUpdateIndexSchemaRequest} dataTypesUpdateIndexSchemaRequest Schema
46855
+ * Update the search index schema for a connector source. **Auth:** `x-storeid` and `x-storesecret`. Body: schema definition.
46856
+ * @summary Update source index schema
46857
+ * @param {string} sourceid Source ID
46858
+ * @param {DataTypesUpdateIndexSchemaRequest} dataTypesUpdateIndexSchemaRequest Schema definition
46637
46859
  * @param {*} [options] Override http request option.
46638
46860
  * @throws {RequiredError}
46639
46861
  */
46640
46862
  v1ConnectorsSourcesSourceidUpdateschemaPost(sourceid: string, dataTypesUpdateIndexSchemaRequest: DataTypesUpdateIndexSchemaRequest, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesUpdateSchemaResponse>;
46641
46863
  /**
46642
- * Upload source data
46864
+ * Upload a file (JSON or CSV) to a data source for indexing. **Auth:** `x-storeid` and `x-storesecret`. Use form-data: Name, Type, Config (e.g. json_upload, csv_upload), and File.
46643
46865
  * @summary Upload source data
46644
46866
  * @param {V1ConnectorsSourcesSourceidUploaddataPostRequest} [v1ConnectorsSourcesSourceidUploaddataPostRequest]
46645
46867
  * @param {*} [options] Override http request option.
@@ -46647,18 +46869,18 @@ export declare const ConnectorsApiFactory: (configuration?: Configuration, baseP
46647
46869
  */
46648
46870
  v1ConnectorsSourcesSourceidUploaddataPost(v1ConnectorsSourcesSourceidUploaddataPostRequest?: V1ConnectorsSourcesSourceidUploaddataPostRequest, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesUploadSourceDataResponseWrapper>;
46649
46871
  /**
46650
- * Create task
46651
- * @summary Create task
46652
- * @param {DataTypesCreateTaskRequest} dataTypesCreateTaskRequest Task
46872
+ * Create a sync task for a data source. **Auth:** `x-storeid` and `x-storesecret`. Task defines when and how to sync data.
46873
+ * @summary Create connector task
46874
+ * @param {DataTypesCreateTaskRequest} dataTypesCreateTaskRequest Task configuration
46653
46875
  * @param {*} [options] Override http request option.
46654
46876
  * @throws {RequiredError}
46655
46877
  */
46656
46878
  v1ConnectorsTasksPost(dataTypesCreateTaskRequest: DataTypesCreateTaskRequest, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesCreateTaskResponse>;
46657
46879
  /**
46658
- * Trigger task run
46880
+ * Run a connector sync task once. **Auth:** `x-storeid` and `x-storesecret`. Body can include initiated_by (user ID).
46659
46881
  * @summary Trigger task run
46660
46882
  * @param {string} taskId Task ID
46661
- * @param {number} body Initiated by
46883
+ * @param {number} body User ID who triggered the run
46662
46884
  * @param {*} [options] Override http request option.
46663
46885
  * @throws {RequiredError}
46664
46886
  */
@@ -46674,47 +46896,50 @@ export declare class ConnectorsApi extends BaseAPI {
46674
46896
  /**
46675
46897
  * List all connectors with optional filtering
46676
46898
  * @summary List Connectors
46899
+ * @param {string} xStoreID Store ID
46677
46900
  * @param {string} authorization Bearer JWT token
46678
46901
  * @param {string} [connectorType] Filter by connector type (import, export)
46679
46902
  * @param {string} [provider] Filter by provider
46680
46903
  * @param {boolean} [isActive] Filter by active status
46681
- * @param {number} [storeId] Filter by store ID
46682
46904
  * @param {number} [limit] Number of results (default: 50)
46683
46905
  * @param {number} [offset] Offset for pagination
46684
46906
  * @param {*} [options] Override http request option.
46685
46907
  * @throws {RequiredError}
46686
46908
  * @memberof ConnectorsApi
46687
46909
  */
46688
- v1ConnectorsGet(authorization: string, connectorType?: string, provider?: string, isActive?: boolean, storeId?: number, limit?: number, offset?: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<{
46910
+ adminAnalyticsStoreXStoreIDConnectorsGet(xStoreID: string, authorization: string, connectorType?: string, provider?: string, isActive?: boolean, limit?: number, offset?: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<{
46689
46911
  [key: string]: any;
46690
46912
  }, any, {}>>;
46691
46913
  /**
46692
46914
  * Delete a connector and its sync history
46693
46915
  * @summary Delete Connector
46916
+ * @param {string} xStoreID Store ID
46694
46917
  * @param {string} authorization Bearer JWT token
46695
46918
  * @param {number} id Connector ID
46696
46919
  * @param {*} [options] Override http request option.
46697
46920
  * @throws {RequiredError}
46698
46921
  * @memberof ConnectorsApi
46699
46922
  */
46700
- v1ConnectorsIdDelete(authorization: string, id: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<{
46923
+ adminAnalyticsStoreXStoreIDConnectorsIdDelete(xStoreID: string, authorization: string, id: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<{
46701
46924
  [key: string]: any;
46702
46925
  }, any, {}>>;
46703
46926
  /**
46704
46927
  * Retrieve a specific connector by ID
46705
46928
  * @summary Get Connector
46929
+ * @param {string} xStoreID Store ID
46706
46930
  * @param {string} authorization Bearer JWT token
46707
46931
  * @param {number} id Connector ID
46708
46932
  * @param {*} [options] Override http request option.
46709
46933
  * @throws {RequiredError}
46710
46934
  * @memberof ConnectorsApi
46711
46935
  */
46712
- v1ConnectorsIdGet(authorization: string, id: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<{
46936
+ adminAnalyticsStoreXStoreIDConnectorsIdGet(xStoreID: string, authorization: string, id: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<{
46713
46937
  [key: string]: any;
46714
46938
  }, any, {}>>;
46715
46939
  /**
46716
46940
  * Get sync history for a connector
46717
46941
  * @summary Get Sync History
46942
+ * @param {string} xStoreID Store ID
46718
46943
  * @param {string} authorization Bearer JWT token
46719
46944
  * @param {number} id Connector ID
46720
46945
  * @param {number} [limit] Number of results (default: 20)
@@ -46722,12 +46947,13 @@ export declare class ConnectorsApi extends BaseAPI {
46722
46947
  * @throws {RequiredError}
46723
46948
  * @memberof ConnectorsApi
46724
46949
  */
46725
- v1ConnectorsIdHistoryGet(authorization: string, id: number, limit?: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<{
46950
+ adminAnalyticsStoreXStoreIDConnectorsIdHistoryGet(xStoreID: string, authorization: string, id: number, limit?: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<{
46726
46951
  [key: string]: any;
46727
46952
  }, any, {}>>;
46728
46953
  /**
46729
46954
  * Update an existing connector
46730
46955
  * @summary Update Connector
46956
+ * @param {string} xStoreID Store ID
46731
46957
  * @param {string} authorization Bearer JWT token
46732
46958
  * @param {number} id Connector ID
46733
46959
  * @param {ConnectorsUpdateConnectorRequest} connectorsUpdateConnectorRequest Updated connector configuration
@@ -46735,69 +46961,73 @@ export declare class ConnectorsApi extends BaseAPI {
46735
46961
  * @throws {RequiredError}
46736
46962
  * @memberof ConnectorsApi
46737
46963
  */
46738
- v1ConnectorsIdPut(authorization: string, id: number, connectorsUpdateConnectorRequest: ConnectorsUpdateConnectorRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<{
46964
+ adminAnalyticsStoreXStoreIDConnectorsIdPut(xStoreID: string, authorization: string, id: number, connectorsUpdateConnectorRequest: ConnectorsUpdateConnectorRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<{
46739
46965
  [key: string]: any;
46740
46966
  }, any, {}>>;
46741
46967
  /**
46742
46968
  * Trigger a sync operation for a connector
46743
46969
  * @summary Trigger Sync
46970
+ * @param {string} xStoreID Store ID
46744
46971
  * @param {string} authorization Bearer JWT token
46745
46972
  * @param {number} id Connector ID
46746
46973
  * @param {*} [options] Override http request option.
46747
46974
  * @throws {RequiredError}
46748
46975
  * @memberof ConnectorsApi
46749
46976
  */
46750
- v1ConnectorsIdSyncPost(authorization: string, id: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<{
46977
+ adminAnalyticsStoreXStoreIDConnectorsIdSyncPost(xStoreID: string, authorization: string, id: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<{
46751
46978
  [key: string]: any;
46752
46979
  }, any, {}>>;
46753
46980
  /**
46754
46981
  * Test the connection to a connector\'s external service
46755
46982
  * @summary Test Connection
46983
+ * @param {string} xStoreID Store ID
46756
46984
  * @param {string} authorization Bearer JWT token
46757
46985
  * @param {number} id Connector ID
46758
46986
  * @param {*} [options] Override http request option.
46759
46987
  * @throws {RequiredError}
46760
46988
  * @memberof ConnectorsApi
46761
46989
  */
46762
- v1ConnectorsIdTestPost(authorization: string, id: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<{
46990
+ adminAnalyticsStoreXStoreIDConnectorsIdTestPost(xStoreID: string, authorization: string, id: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<{
46763
46991
  [key: string]: any;
46764
46992
  }, any, {}>>;
46765
- /**
46766
- * Retrieves validation errors for a specific job ID if any invalid records were found during data upload
46767
- * @summary Get validation errors for a job
46768
- * @param {string} jobid Job ID
46769
- * @param {*} [options] Override http request option.
46770
- * @throws {RequiredError}
46771
- * @memberof ConnectorsApi
46772
- */
46773
- v1ConnectorsJobstatusJobidValidationErrorsGet(jobid: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesValidationErrorResponse, any, {}>>;
46774
46993
  /**
46775
46994
  * Create a new analytics connector for importing or exporting events
46776
46995
  * @summary Create Connector
46996
+ * @param {string} xStoreID Store ID
46777
46997
  * @param {string} authorization Bearer JWT token
46778
46998
  * @param {ConnectorsCreateConnectorRequest} connectorsCreateConnectorRequest Connector configuration
46779
46999
  * @param {*} [options] Override http request option.
46780
47000
  * @throws {RequiredError}
46781
47001
  * @memberof ConnectorsApi
46782
47002
  */
46783
- v1ConnectorsPost(authorization: string, connectorsCreateConnectorRequest: ConnectorsCreateConnectorRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<{
47003
+ adminAnalyticsStoreXStoreIDConnectorsPost(xStoreID: string, authorization: string, connectorsCreateConnectorRequest: ConnectorsCreateConnectorRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<{
46784
47004
  [key: string]: any;
46785
47005
  }, any, {}>>;
46786
47006
  /**
46787
47007
  * Get list of available connector providers
46788
47008
  * @summary Get Available Providers
47009
+ * @param {string} xStoreID Store ID
46789
47010
  * @param {string} authorization Bearer JWT token
46790
47011
  * @param {string} [type] Connector type (import, export)
46791
47012
  * @param {*} [options] Override http request option.
46792
47013
  * @throws {RequiredError}
46793
47014
  * @memberof ConnectorsApi
46794
47015
  */
46795
- v1ConnectorsProvidersGet(authorization: string, type?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<{
47016
+ adminAnalyticsStoreXStoreIDConnectorsProvidersGet(xStoreID: string, authorization: string, type?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<{
46796
47017
  [key: string]: any;
46797
47018
  }, any, {}>>;
46798
47019
  /**
46799
- * Test search
46800
- * @summary Test search
47020
+ * Returns validation errors for an upload job (e.g. invalid rows). Use the job ID returned from the upload endpoint. **Auth:** store credentials or JWT.
47021
+ * @summary Get validation errors for a job
47022
+ * @param {string} jobid Job ID from upload response
47023
+ * @param {*} [options] Override http request option.
47024
+ * @throws {RequiredError}
47025
+ * @memberof ConnectorsApi
47026
+ */
47027
+ v1ConnectorsJobstatusJobidValidationErrorsGet(jobid: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesValidationErrorResponse, any, {}>>;
47028
+ /**
47029
+ * Run a test search against a connector index. **Auth:** store credentials. Query param `q` is required. Use to verify connector sync results.
47030
+ * @summary Test search for an index
46801
47031
  * @param {string} index Index name
46802
47032
  * @param {string} q Search query
46803
47033
  * @param {*} [options] Override http request option.
@@ -46806,27 +47036,27 @@ export declare class ConnectorsApi extends BaseAPI {
46806
47036
  */
46807
47037
  v1ConnectorsSearchIndexGet(index: string, q: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesSearchResultResponse, any, {}>>;
46808
47038
  /**
46809
- * Get all sources
46810
- * @summary Get all sources
47039
+ * List all data sources for the store. **Auth:** `x-storeid` and `x-storesecret`.
47040
+ * @summary List data sources
46811
47041
  * @param {*} [options] Override http request option.
46812
47042
  * @throws {RequiredError}
46813
47043
  * @memberof ConnectorsApi
46814
47044
  */
46815
47045
  v1ConnectorsSourcesGet(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesSourcesListResponse, any, {}>>;
46816
47046
  /**
46817
- * Create source
46818
- * @summary Create source
46819
- * @param {DataTypesCreateSourceRequest} dataTypesCreateSourceRequest Source
47047
+ * Register a new data source for the store. **Auth:** `x-storeid` and `x-storesecret`. Used by connector integrations to sync data into the search index.
47048
+ * @summary Create data source
47049
+ * @param {DataTypesCreateSourceRequest} dataTypesCreateSourceRequest Source configuration
46820
47050
  * @param {*} [options] Override http request option.
46821
47051
  * @throws {RequiredError}
46822
47052
  * @memberof ConnectorsApi
46823
47053
  */
46824
47054
  v1ConnectorsSourcesPost(dataTypesCreateSourceRequest: DataTypesCreateSourceRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesCreateSourceResponse, any, {}>>;
46825
47055
  /**
46826
- * Update source config by id
46827
- * @summary Update source config by id
47056
+ * Update configuration for a data source. **Auth:** store credentials or JWT. Body: `config` object with key-value settings.
47057
+ * @summary Update source config
46828
47058
  * @param {string} sourceId Source ID
46829
- * @param {{ [key: string]: any; }} requestBody Config
47059
+ * @param {{ [key: string]: any; }} requestBody Config key-value map
46830
47060
  * @param {*} [options] Override http request option.
46831
47061
  * @throws {RequiredError}
46832
47062
  * @memberof ConnectorsApi
@@ -46835,25 +47065,26 @@ export declare class ConnectorsApi extends BaseAPI {
46835
47065
  [key: string]: any;
46836
47066
  }, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesResponse, any, {}>>;
46837
47067
  /**
46838
- * Get source by id
46839
- * @summary Get source by id
47068
+ * Fetch a single data source by ID. **Auth:** `x-storeid` and `x-storesecret`.
47069
+ * @summary Get source by ID
47070
+ * @param {string} sourceId Source ID
46840
47071
  * @param {*} [options] Override http request option.
46841
47072
  * @throws {RequiredError}
46842
47073
  * @memberof ConnectorsApi
46843
47074
  */
46844
- v1ConnectorsSourcesSourceIdGet(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesUpdateSourceConfigResponseWrapper, any, {}>>;
47075
+ v1ConnectorsSourcesSourceIdGet(sourceId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesUpdateSourceConfigResponseWrapper, any, {}>>;
46845
47076
  /**
46846
- * Update Index schema
46847
- * @summary Update Index schema
46848
- * @param {string} sourceid Source ID to update schema
46849
- * @param {DataTypesUpdateIndexSchemaRequest} dataTypesUpdateIndexSchemaRequest Schema
47077
+ * Update the search index schema for a connector source. **Auth:** `x-storeid` and `x-storesecret`. Body: schema definition.
47078
+ * @summary Update source index schema
47079
+ * @param {string} sourceid Source ID
47080
+ * @param {DataTypesUpdateIndexSchemaRequest} dataTypesUpdateIndexSchemaRequest Schema definition
46850
47081
  * @param {*} [options] Override http request option.
46851
47082
  * @throws {RequiredError}
46852
47083
  * @memberof ConnectorsApi
46853
47084
  */
46854
47085
  v1ConnectorsSourcesSourceidUpdateschemaPost(sourceid: string, dataTypesUpdateIndexSchemaRequest: DataTypesUpdateIndexSchemaRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesUpdateSchemaResponse, any, {}>>;
46855
47086
  /**
46856
- * Upload source data
47087
+ * Upload a file (JSON or CSV) to a data source for indexing. **Auth:** `x-storeid` and `x-storesecret`. Use form-data: Name, Type, Config (e.g. json_upload, csv_upload), and File.
46857
47088
  * @summary Upload source data
46858
47089
  * @param {V1ConnectorsSourcesSourceidUploaddataPostRequest} [v1ConnectorsSourcesSourceidUploaddataPostRequest]
46859
47090
  * @param {*} [options] Override http request option.
@@ -46862,19 +47093,19 @@ export declare class ConnectorsApi extends BaseAPI {
46862
47093
  */
46863
47094
  v1ConnectorsSourcesSourceidUploaddataPost(v1ConnectorsSourcesSourceidUploaddataPostRequest?: V1ConnectorsSourcesSourceidUploaddataPostRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesUploadSourceDataResponseWrapper, any, {}>>;
46864
47095
  /**
46865
- * Create task
46866
- * @summary Create task
46867
- * @param {DataTypesCreateTaskRequest} dataTypesCreateTaskRequest Task
47096
+ * Create a sync task for a data source. **Auth:** `x-storeid` and `x-storesecret`. Task defines when and how to sync data.
47097
+ * @summary Create connector task
47098
+ * @param {DataTypesCreateTaskRequest} dataTypesCreateTaskRequest Task configuration
46868
47099
  * @param {*} [options] Override http request option.
46869
47100
  * @throws {RequiredError}
46870
47101
  * @memberof ConnectorsApi
46871
47102
  */
46872
47103
  v1ConnectorsTasksPost(dataTypesCreateTaskRequest: DataTypesCreateTaskRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesCreateTaskResponse, any, {}>>;
46873
47104
  /**
46874
- * Trigger task run
47105
+ * Run a connector sync task once. **Auth:** `x-storeid` and `x-storesecret`. Body can include initiated_by (user ID).
46875
47106
  * @summary Trigger task run
46876
47107
  * @param {string} taskId Task ID
46877
- * @param {number} body Initiated by
47108
+ * @param {number} body User ID who triggered the run
46878
47109
  * @param {*} [options] Override http request option.
46879
47110
  * @throws {RequiredError}
46880
47111
  * @memberof ConnectorsApi
@@ -46939,7 +47170,7 @@ export declare const CreditsApiAxiosParamCreator: (configuration?: Configuration
46939
47170
  */
46940
47171
  creditsConsumptionHistoryGet: (page?: number, limit?: number, endpoint?: string, startDate?: string, endDate?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
46941
47172
  /**
46942
- * Get all active credit plans available for purchase with detailed pricing and features
47173
+ * Returns all active credit plans with pricing and features. No authentication required. Use when displaying plan options to users (e.g. pricing page).
46943
47174
  * @summary Get available credit plans
46944
47175
  * @param {*} [options] Override http request option.
46945
47176
  * @throws {RequiredError}
@@ -47024,7 +47255,7 @@ export declare const CreditsApiFp: (configuration?: Configuration) => {
47024
47255
  */
47025
47256
  creditsConsumptionHistoryGet(page?: number, limit?: number, endpoint?: string, startDate?: string, endDate?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesResponse>>;
47026
47257
  /**
47027
- * Get all active credit plans available for purchase with detailed pricing and features
47258
+ * Returns all active credit plans with pricing and features. No authentication required. Use when displaying plan options to users (e.g. pricing page).
47028
47259
  * @summary Get available credit plans
47029
47260
  * @param {*} [options] Override http request option.
47030
47261
  * @throws {RequiredError}
@@ -47109,7 +47340,7 @@ export declare const CreditsApiFactory: (configuration?: Configuration, basePath
47109
47340
  */
47110
47341
  creditsConsumptionHistoryGet(page?: number, limit?: number, endpoint?: string, startDate?: string, endDate?: string, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesResponse>;
47111
47342
  /**
47112
- * Get all active credit plans available for purchase with detailed pricing and features
47343
+ * Returns all active credit plans with pricing and features. No authentication required. Use when displaying plan options to users (e.g. pricing page).
47113
47344
  * @summary Get available credit plans
47114
47345
  * @param {*} [options] Override http request option.
47115
47346
  * @throws {RequiredError}
@@ -47202,7 +47433,7 @@ export declare class CreditsApi extends BaseAPI {
47202
47433
  */
47203
47434
  creditsConsumptionHistoryGet(page?: number, limit?: number, endpoint?: string, startDate?: string, endDate?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesResponse, any, {}>>;
47204
47435
  /**
47205
- * Get all active credit plans available for purchase with detailed pricing and features
47436
+ * Returns all active credit plans with pricing and features. No authentication required. Use when displaying plan options to users (e.g. pricing page).
47206
47437
  * @summary Get available credit plans
47207
47438
  * @param {*} [options] Override http request option.
47208
47439
  * @throws {RequiredError}
@@ -47250,10 +47481,10 @@ export type CreditsTransactionsGetTypeEnum = typeof CreditsTransactionsGetTypeEn
47250
47481
  */
47251
47482
  export declare const CustomEventsApiAxiosParamCreator: (configuration?: Configuration) => {
47252
47483
  /**
47253
- * Retrieve a paginated list of custom event types with optional filtering by store, category, and active status.
47484
+ * Retrieve a paginated list of custom event types with optional filtering by category and active status.
47254
47485
  * @summary List Custom Event Types
47486
+ * @param {string} xStoreID Store ID
47255
47487
  * @param {string} authorization Bearer JWT token
47256
- * @param {number} [storeId] Filter by store ID
47257
47488
  * @param {boolean} [isActive] Filter by active status
47258
47489
  * @param {string} [category] Filter by category (user_journey, system, business, custom)
47259
47490
  * @param {string} [search] Search in event names, display names, and descriptions
@@ -47266,29 +47497,32 @@ export declare const CustomEventsApiAxiosParamCreator: (configuration?: Configur
47266
47497
  * @param {*} [options] Override http request option.
47267
47498
  * @throws {RequiredError}
47268
47499
  */
47269
- v1AnalyticsCustomEventsGet: (authorization: string, storeId?: number, isActive?: boolean, category?: string, search?: string, page?: number, pageSize?: number, limit?: number, offset?: number, sortBy?: string, sortOrder?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
47500
+ adminAnalyticsStoreXStoreIDCustomEventsGet: (xStoreID: string, authorization: string, isActive?: boolean, category?: string, search?: string, page?: number, pageSize?: number, limit?: number, offset?: number, sortBy?: string, sortOrder?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
47270
47501
  /**
47271
47502
  * Permanently delete a custom event type and all its field definitions. This operation cannot be undone.
47272
47503
  * @summary Delete Custom Event Type
47504
+ * @param {string} xStoreID Store ID
47273
47505
  * @param {string} authorization Bearer JWT token
47274
47506
  * @param {number} id Event Type ID
47275
47507
  * @param {*} [options] Override http request option.
47276
47508
  * @throws {RequiredError}
47277
47509
  */
47278
- v1AnalyticsCustomEventsIdDelete: (authorization: string, id: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
47510
+ adminAnalyticsStoreXStoreIDCustomEventsIdDelete: (xStoreID: string, authorization: string, id: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
47279
47511
  /**
47280
47512
  * Remove a field definition from a custom event type. This operation cannot be undone.
47281
47513
  * @summary Remove Field
47514
+ * @param {string} xStoreID Store ID
47282
47515
  * @param {string} authorization Bearer JWT token
47283
47516
  * @param {number} id Event Type ID
47284
47517
  * @param {number} fid Field ID
47285
47518
  * @param {*} [options] Override http request option.
47286
47519
  * @throws {RequiredError}
47287
47520
  */
47288
- v1AnalyticsCustomEventsIdFieldsFidDelete: (authorization: string, id: number, fid: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
47521
+ adminAnalyticsStoreXStoreIDCustomEventsIdFieldsFidDelete: (xStoreID: string, authorization: string, id: number, fid: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
47289
47522
  /**
47290
47523
  * Update an existing field definition. Note: field_slot and field_type cannot be changed after creation.
47291
47524
  * @summary Update Field
47525
+ * @param {string} xStoreID Store ID
47292
47526
  * @param {string} authorization Bearer JWT token
47293
47527
  * @param {number} id Event Type ID
47294
47528
  * @param {number} fid Field ID
@@ -47296,64 +47530,70 @@ export declare const CustomEventsApiAxiosParamCreator: (configuration?: Configur
47296
47530
  * @param {*} [options] Override http request option.
47297
47531
  * @throws {RequiredError}
47298
47532
  */
47299
- v1AnalyticsCustomEventsIdFieldsFidPut: (authorization: string, id: number, fid: number, modelsUpdateCustomEventFieldRequest: ModelsUpdateCustomEventFieldRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
47533
+ adminAnalyticsStoreXStoreIDCustomEventsIdFieldsFidPut: (xStoreID: string, authorization: string, id: number, fid: number, modelsUpdateCustomEventFieldRequest: ModelsUpdateCustomEventFieldRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
47300
47534
  /**
47301
47535
  * Add a new field definition to a custom event type. Fields define the data structure for custom events.
47302
47536
  * @summary Add Field to Custom Event Type
47537
+ * @param {string} xStoreID Store ID
47303
47538
  * @param {string} authorization Bearer JWT token
47304
47539
  * @param {number} id Event Type ID
47305
47540
  * @param {ModelsCreateCustomEventFieldRequest} modelsCreateCustomEventFieldRequest Field configuration
47306
47541
  * @param {*} [options] Override http request option.
47307
47542
  * @throws {RequiredError}
47308
47543
  */
47309
- v1AnalyticsCustomEventsIdFieldsPost: (authorization: string, id: number, modelsCreateCustomEventFieldRequest: ModelsCreateCustomEventFieldRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
47544
+ adminAnalyticsStoreXStoreIDCustomEventsIdFieldsPost: (xStoreID: string, authorization: string, id: number, modelsCreateCustomEventFieldRequest: ModelsCreateCustomEventFieldRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
47310
47545
  /**
47311
47546
  * Retrieve a specific custom event type by its ID, including all field definitions.
47312
47547
  * @summary Get Custom Event Type
47548
+ * @param {string} xStoreID Store ID
47313
47549
  * @param {string} authorization Bearer JWT token
47314
47550
  * @param {number} id Event Type ID
47315
47551
  * @param {*} [options] Override http request option.
47316
47552
  * @throws {RequiredError}
47317
47553
  */
47318
- v1AnalyticsCustomEventsIdGet: (authorization: string, id: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
47554
+ adminAnalyticsStoreXStoreIDCustomEventsIdGet: (xStoreID: string, authorization: string, id: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
47319
47555
  /**
47320
47556
  * Update an existing custom event type. Supports partial updates.
47321
47557
  * @summary Update Custom Event Type
47558
+ * @param {string} xStoreID Store ID
47322
47559
  * @param {string} authorization Bearer JWT token
47323
47560
  * @param {number} id Event Type ID
47324
47561
  * @param {ModelsUpdateCustomEventTypeRequest} modelsUpdateCustomEventTypeRequest Updated event type configuration
47325
47562
  * @param {*} [options] Override http request option.
47326
47563
  * @throws {RequiredError}
47327
47564
  */
47328
- v1AnalyticsCustomEventsIdPut: (authorization: string, id: number, modelsUpdateCustomEventTypeRequest: ModelsUpdateCustomEventTypeRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
47565
+ adminAnalyticsStoreXStoreIDCustomEventsIdPut: (xStoreID: string, authorization: string, id: number, modelsUpdateCustomEventTypeRequest: ModelsUpdateCustomEventTypeRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
47329
47566
  /**
47330
47567
  * Get available slot numbers for string and numeric fields. String fields use slots 1-25, numeric fields use slots 1-15.
47331
47568
  * @summary Get Available Slots
47569
+ * @param {string} xStoreID Store ID
47332
47570
  * @param {string} authorization Bearer JWT token
47333
47571
  * @param {number} id Event Type ID
47334
47572
  * @param {*} [options] Override http request option.
47335
47573
  * @throws {RequiredError}
47336
47574
  */
47337
- v1AnalyticsCustomEventsIdSlotsGet: (authorization: string, id: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
47575
+ adminAnalyticsStoreXStoreIDCustomEventsIdSlotsGet: (xStoreID: string, authorization: string, id: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
47338
47576
  /**
47339
47577
  * Validate an event payload against the custom event type schema. Returns validation errors if the payload doesn\'t match the schema.
47340
47578
  * @summary Validate Event Payload
47579
+ * @param {string} xStoreID Store ID
47341
47580
  * @param {string} authorization Bearer JWT token
47342
47581
  * @param {number} id Event Type ID
47343
47582
  * @param {ModelsValidatePayloadRequest} modelsValidatePayloadRequest Payload to validate
47344
47583
  * @param {*} [options] Override http request option.
47345
47584
  * @throws {RequiredError}
47346
47585
  */
47347
- v1AnalyticsCustomEventsIdValidatePost: (authorization: string, id: number, modelsValidatePayloadRequest: ModelsValidatePayloadRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
47586
+ adminAnalyticsStoreXStoreIDCustomEventsIdValidatePost: (xStoreID: string, authorization: string, id: number, modelsValidatePayloadRequest: ModelsValidatePayloadRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
47348
47587
  /**
47349
47588
  * Create a new custom event type for your organization. Custom event types define the schema for tracking custom business events.
47350
47589
  * @summary Create Custom Event Type
47590
+ * @param {string} xStoreID Store ID
47351
47591
  * @param {string} authorization Bearer JWT token
47352
47592
  * @param {ModelsCreateCustomEventTypeRequest} modelsCreateCustomEventTypeRequest Event type configuration
47353
47593
  * @param {*} [options] Override http request option.
47354
47594
  * @throws {RequiredError}
47355
47595
  */
47356
- v1AnalyticsCustomEventsPost: (authorization: string, modelsCreateCustomEventTypeRequest: ModelsCreateCustomEventTypeRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
47596
+ adminAnalyticsStoreXStoreIDCustomEventsPost: (xStoreID: string, authorization: string, modelsCreateCustomEventTypeRequest: ModelsCreateCustomEventTypeRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
47357
47597
  };
47358
47598
  /**
47359
47599
  * CustomEventsApi - functional programming interface
@@ -47361,10 +47601,10 @@ export declare const CustomEventsApiAxiosParamCreator: (configuration?: Configur
47361
47601
  */
47362
47602
  export declare const CustomEventsApiFp: (configuration?: Configuration) => {
47363
47603
  /**
47364
- * Retrieve a paginated list of custom event types with optional filtering by store, category, and active status.
47604
+ * Retrieve a paginated list of custom event types with optional filtering by category and active status.
47365
47605
  * @summary List Custom Event Types
47606
+ * @param {string} xStoreID Store ID
47366
47607
  * @param {string} authorization Bearer JWT token
47367
- * @param {number} [storeId] Filter by store ID
47368
47608
  * @param {boolean} [isActive] Filter by active status
47369
47609
  * @param {string} [category] Filter by category (user_journey, system, business, custom)
47370
47610
  * @param {string} [search] Search in event names, display names, and descriptions
@@ -47377,35 +47617,38 @@ export declare const CustomEventsApiFp: (configuration?: Configuration) => {
47377
47617
  * @param {*} [options] Override http request option.
47378
47618
  * @throws {RequiredError}
47379
47619
  */
47380
- v1AnalyticsCustomEventsGet(authorization: string, storeId?: number, isActive?: boolean, category?: string, search?: string, page?: number, pageSize?: number, limit?: number, offset?: number, sortBy?: string, sortOrder?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<{
47620
+ adminAnalyticsStoreXStoreIDCustomEventsGet(xStoreID: string, authorization: string, isActive?: boolean, category?: string, search?: string, page?: number, pageSize?: number, limit?: number, offset?: number, sortBy?: string, sortOrder?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<{
47381
47621
  [key: string]: any;
47382
47622
  }>>;
47383
47623
  /**
47384
47624
  * Permanently delete a custom event type and all its field definitions. This operation cannot be undone.
47385
47625
  * @summary Delete Custom Event Type
47626
+ * @param {string} xStoreID Store ID
47386
47627
  * @param {string} authorization Bearer JWT token
47387
47628
  * @param {number} id Event Type ID
47388
47629
  * @param {*} [options] Override http request option.
47389
47630
  * @throws {RequiredError}
47390
47631
  */
47391
- v1AnalyticsCustomEventsIdDelete(authorization: string, id: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<{
47632
+ adminAnalyticsStoreXStoreIDCustomEventsIdDelete(xStoreID: string, authorization: string, id: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<{
47392
47633
  [key: string]: any;
47393
47634
  }>>;
47394
47635
  /**
47395
47636
  * Remove a field definition from a custom event type. This operation cannot be undone.
47396
47637
  * @summary Remove Field
47638
+ * @param {string} xStoreID Store ID
47397
47639
  * @param {string} authorization Bearer JWT token
47398
47640
  * @param {number} id Event Type ID
47399
47641
  * @param {number} fid Field ID
47400
47642
  * @param {*} [options] Override http request option.
47401
47643
  * @throws {RequiredError}
47402
47644
  */
47403
- v1AnalyticsCustomEventsIdFieldsFidDelete(authorization: string, id: number, fid: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<{
47645
+ adminAnalyticsStoreXStoreIDCustomEventsIdFieldsFidDelete(xStoreID: string, authorization: string, id: number, fid: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<{
47404
47646
  [key: string]: any;
47405
47647
  }>>;
47406
47648
  /**
47407
47649
  * Update an existing field definition. Note: field_slot and field_type cannot be changed after creation.
47408
47650
  * @summary Update Field
47651
+ * @param {string} xStoreID Store ID
47409
47652
  * @param {string} authorization Bearer JWT token
47410
47653
  * @param {number} id Event Type ID
47411
47654
  * @param {number} fid Field ID
@@ -47413,76 +47656,82 @@ export declare const CustomEventsApiFp: (configuration?: Configuration) => {
47413
47656
  * @param {*} [options] Override http request option.
47414
47657
  * @throws {RequiredError}
47415
47658
  */
47416
- v1AnalyticsCustomEventsIdFieldsFidPut(authorization: string, id: number, fid: number, modelsUpdateCustomEventFieldRequest: ModelsUpdateCustomEventFieldRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<{
47659
+ adminAnalyticsStoreXStoreIDCustomEventsIdFieldsFidPut(xStoreID: string, authorization: string, id: number, fid: number, modelsUpdateCustomEventFieldRequest: ModelsUpdateCustomEventFieldRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<{
47417
47660
  [key: string]: any;
47418
47661
  }>>;
47419
47662
  /**
47420
47663
  * Add a new field definition to a custom event type. Fields define the data structure for custom events.
47421
47664
  * @summary Add Field to Custom Event Type
47665
+ * @param {string} xStoreID Store ID
47422
47666
  * @param {string} authorization Bearer JWT token
47423
47667
  * @param {number} id Event Type ID
47424
47668
  * @param {ModelsCreateCustomEventFieldRequest} modelsCreateCustomEventFieldRequest Field configuration
47425
47669
  * @param {*} [options] Override http request option.
47426
47670
  * @throws {RequiredError}
47427
47671
  */
47428
- v1AnalyticsCustomEventsIdFieldsPost(authorization: string, id: number, modelsCreateCustomEventFieldRequest: ModelsCreateCustomEventFieldRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<{
47672
+ adminAnalyticsStoreXStoreIDCustomEventsIdFieldsPost(xStoreID: string, authorization: string, id: number, modelsCreateCustomEventFieldRequest: ModelsCreateCustomEventFieldRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<{
47429
47673
  [key: string]: any;
47430
47674
  }>>;
47431
47675
  /**
47432
47676
  * Retrieve a specific custom event type by its ID, including all field definitions.
47433
47677
  * @summary Get Custom Event Type
47678
+ * @param {string} xStoreID Store ID
47434
47679
  * @param {string} authorization Bearer JWT token
47435
47680
  * @param {number} id Event Type ID
47436
47681
  * @param {*} [options] Override http request option.
47437
47682
  * @throws {RequiredError}
47438
47683
  */
47439
- v1AnalyticsCustomEventsIdGet(authorization: string, id: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<{
47684
+ adminAnalyticsStoreXStoreIDCustomEventsIdGet(xStoreID: string, authorization: string, id: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<{
47440
47685
  [key: string]: any;
47441
47686
  }>>;
47442
47687
  /**
47443
47688
  * Update an existing custom event type. Supports partial updates.
47444
47689
  * @summary Update Custom Event Type
47690
+ * @param {string} xStoreID Store ID
47445
47691
  * @param {string} authorization Bearer JWT token
47446
47692
  * @param {number} id Event Type ID
47447
47693
  * @param {ModelsUpdateCustomEventTypeRequest} modelsUpdateCustomEventTypeRequest Updated event type configuration
47448
47694
  * @param {*} [options] Override http request option.
47449
47695
  * @throws {RequiredError}
47450
47696
  */
47451
- v1AnalyticsCustomEventsIdPut(authorization: string, id: number, modelsUpdateCustomEventTypeRequest: ModelsUpdateCustomEventTypeRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<{
47697
+ adminAnalyticsStoreXStoreIDCustomEventsIdPut(xStoreID: string, authorization: string, id: number, modelsUpdateCustomEventTypeRequest: ModelsUpdateCustomEventTypeRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<{
47452
47698
  [key: string]: any;
47453
47699
  }>>;
47454
47700
  /**
47455
47701
  * Get available slot numbers for string and numeric fields. String fields use slots 1-25, numeric fields use slots 1-15.
47456
47702
  * @summary Get Available Slots
47703
+ * @param {string} xStoreID Store ID
47457
47704
  * @param {string} authorization Bearer JWT token
47458
47705
  * @param {number} id Event Type ID
47459
47706
  * @param {*} [options] Override http request option.
47460
47707
  * @throws {RequiredError}
47461
47708
  */
47462
- v1AnalyticsCustomEventsIdSlotsGet(authorization: string, id: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<{
47709
+ adminAnalyticsStoreXStoreIDCustomEventsIdSlotsGet(xStoreID: string, authorization: string, id: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<{
47463
47710
  [key: string]: any;
47464
47711
  }>>;
47465
47712
  /**
47466
47713
  * Validate an event payload against the custom event type schema. Returns validation errors if the payload doesn\'t match the schema.
47467
47714
  * @summary Validate Event Payload
47715
+ * @param {string} xStoreID Store ID
47468
47716
  * @param {string} authorization Bearer JWT token
47469
47717
  * @param {number} id Event Type ID
47470
47718
  * @param {ModelsValidatePayloadRequest} modelsValidatePayloadRequest Payload to validate
47471
47719
  * @param {*} [options] Override http request option.
47472
47720
  * @throws {RequiredError}
47473
47721
  */
47474
- v1AnalyticsCustomEventsIdValidatePost(authorization: string, id: number, modelsValidatePayloadRequest: ModelsValidatePayloadRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<{
47722
+ adminAnalyticsStoreXStoreIDCustomEventsIdValidatePost(xStoreID: string, authorization: string, id: number, modelsValidatePayloadRequest: ModelsValidatePayloadRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<{
47475
47723
  [key: string]: any;
47476
47724
  }>>;
47477
47725
  /**
47478
47726
  * Create a new custom event type for your organization. Custom event types define the schema for tracking custom business events.
47479
47727
  * @summary Create Custom Event Type
47728
+ * @param {string} xStoreID Store ID
47480
47729
  * @param {string} authorization Bearer JWT token
47481
47730
  * @param {ModelsCreateCustomEventTypeRequest} modelsCreateCustomEventTypeRequest Event type configuration
47482
47731
  * @param {*} [options] Override http request option.
47483
47732
  * @throws {RequiredError}
47484
47733
  */
47485
- v1AnalyticsCustomEventsPost(authorization: string, modelsCreateCustomEventTypeRequest: ModelsCreateCustomEventTypeRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<{
47734
+ adminAnalyticsStoreXStoreIDCustomEventsPost(xStoreID: string, authorization: string, modelsCreateCustomEventTypeRequest: ModelsCreateCustomEventTypeRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<{
47486
47735
  [key: string]: any;
47487
47736
  }>>;
47488
47737
  };
@@ -47492,10 +47741,10 @@ export declare const CustomEventsApiFp: (configuration?: Configuration) => {
47492
47741
  */
47493
47742
  export declare const CustomEventsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
47494
47743
  /**
47495
- * Retrieve a paginated list of custom event types with optional filtering by store, category, and active status.
47744
+ * Retrieve a paginated list of custom event types with optional filtering by category and active status.
47496
47745
  * @summary List Custom Event Types
47746
+ * @param {string} xStoreID Store ID
47497
47747
  * @param {string} authorization Bearer JWT token
47498
- * @param {number} [storeId] Filter by store ID
47499
47748
  * @param {boolean} [isActive] Filter by active status
47500
47749
  * @param {string} [category] Filter by category (user_journey, system, business, custom)
47501
47750
  * @param {string} [search] Search in event names, display names, and descriptions
@@ -47508,35 +47757,38 @@ export declare const CustomEventsApiFactory: (configuration?: Configuration, bas
47508
47757
  * @param {*} [options] Override http request option.
47509
47758
  * @throws {RequiredError}
47510
47759
  */
47511
- v1AnalyticsCustomEventsGet(authorization: string, storeId?: number, isActive?: boolean, category?: string, search?: string, page?: number, pageSize?: number, limit?: number, offset?: number, sortBy?: string, sortOrder?: string, options?: RawAxiosRequestConfig): AxiosPromise<{
47760
+ adminAnalyticsStoreXStoreIDCustomEventsGet(xStoreID: string, authorization: string, isActive?: boolean, category?: string, search?: string, page?: number, pageSize?: number, limit?: number, offset?: number, sortBy?: string, sortOrder?: string, options?: RawAxiosRequestConfig): AxiosPromise<{
47512
47761
  [key: string]: any;
47513
47762
  }>;
47514
47763
  /**
47515
47764
  * Permanently delete a custom event type and all its field definitions. This operation cannot be undone.
47516
47765
  * @summary Delete Custom Event Type
47766
+ * @param {string} xStoreID Store ID
47517
47767
  * @param {string} authorization Bearer JWT token
47518
47768
  * @param {number} id Event Type ID
47519
47769
  * @param {*} [options] Override http request option.
47520
47770
  * @throws {RequiredError}
47521
47771
  */
47522
- v1AnalyticsCustomEventsIdDelete(authorization: string, id: number, options?: RawAxiosRequestConfig): AxiosPromise<{
47772
+ adminAnalyticsStoreXStoreIDCustomEventsIdDelete(xStoreID: string, authorization: string, id: number, options?: RawAxiosRequestConfig): AxiosPromise<{
47523
47773
  [key: string]: any;
47524
47774
  }>;
47525
47775
  /**
47526
47776
  * Remove a field definition from a custom event type. This operation cannot be undone.
47527
47777
  * @summary Remove Field
47778
+ * @param {string} xStoreID Store ID
47528
47779
  * @param {string} authorization Bearer JWT token
47529
47780
  * @param {number} id Event Type ID
47530
47781
  * @param {number} fid Field ID
47531
47782
  * @param {*} [options] Override http request option.
47532
47783
  * @throws {RequiredError}
47533
47784
  */
47534
- v1AnalyticsCustomEventsIdFieldsFidDelete(authorization: string, id: number, fid: number, options?: RawAxiosRequestConfig): AxiosPromise<{
47785
+ adminAnalyticsStoreXStoreIDCustomEventsIdFieldsFidDelete(xStoreID: string, authorization: string, id: number, fid: number, options?: RawAxiosRequestConfig): AxiosPromise<{
47535
47786
  [key: string]: any;
47536
47787
  }>;
47537
47788
  /**
47538
47789
  * Update an existing field definition. Note: field_slot and field_type cannot be changed after creation.
47539
47790
  * @summary Update Field
47791
+ * @param {string} xStoreID Store ID
47540
47792
  * @param {string} authorization Bearer JWT token
47541
47793
  * @param {number} id Event Type ID
47542
47794
  * @param {number} fid Field ID
@@ -47544,76 +47796,82 @@ export declare const CustomEventsApiFactory: (configuration?: Configuration, bas
47544
47796
  * @param {*} [options] Override http request option.
47545
47797
  * @throws {RequiredError}
47546
47798
  */
47547
- v1AnalyticsCustomEventsIdFieldsFidPut(authorization: string, id: number, fid: number, modelsUpdateCustomEventFieldRequest: ModelsUpdateCustomEventFieldRequest, options?: RawAxiosRequestConfig): AxiosPromise<{
47799
+ adminAnalyticsStoreXStoreIDCustomEventsIdFieldsFidPut(xStoreID: string, authorization: string, id: number, fid: number, modelsUpdateCustomEventFieldRequest: ModelsUpdateCustomEventFieldRequest, options?: RawAxiosRequestConfig): AxiosPromise<{
47548
47800
  [key: string]: any;
47549
47801
  }>;
47550
47802
  /**
47551
47803
  * Add a new field definition to a custom event type. Fields define the data structure for custom events.
47552
47804
  * @summary Add Field to Custom Event Type
47805
+ * @param {string} xStoreID Store ID
47553
47806
  * @param {string} authorization Bearer JWT token
47554
47807
  * @param {number} id Event Type ID
47555
47808
  * @param {ModelsCreateCustomEventFieldRequest} modelsCreateCustomEventFieldRequest Field configuration
47556
47809
  * @param {*} [options] Override http request option.
47557
47810
  * @throws {RequiredError}
47558
47811
  */
47559
- v1AnalyticsCustomEventsIdFieldsPost(authorization: string, id: number, modelsCreateCustomEventFieldRequest: ModelsCreateCustomEventFieldRequest, options?: RawAxiosRequestConfig): AxiosPromise<{
47812
+ adminAnalyticsStoreXStoreIDCustomEventsIdFieldsPost(xStoreID: string, authorization: string, id: number, modelsCreateCustomEventFieldRequest: ModelsCreateCustomEventFieldRequest, options?: RawAxiosRequestConfig): AxiosPromise<{
47560
47813
  [key: string]: any;
47561
47814
  }>;
47562
47815
  /**
47563
47816
  * Retrieve a specific custom event type by its ID, including all field definitions.
47564
47817
  * @summary Get Custom Event Type
47818
+ * @param {string} xStoreID Store ID
47565
47819
  * @param {string} authorization Bearer JWT token
47566
47820
  * @param {number} id Event Type ID
47567
47821
  * @param {*} [options] Override http request option.
47568
47822
  * @throws {RequiredError}
47569
47823
  */
47570
- v1AnalyticsCustomEventsIdGet(authorization: string, id: number, options?: RawAxiosRequestConfig): AxiosPromise<{
47824
+ adminAnalyticsStoreXStoreIDCustomEventsIdGet(xStoreID: string, authorization: string, id: number, options?: RawAxiosRequestConfig): AxiosPromise<{
47571
47825
  [key: string]: any;
47572
47826
  }>;
47573
47827
  /**
47574
47828
  * Update an existing custom event type. Supports partial updates.
47575
47829
  * @summary Update Custom Event Type
47830
+ * @param {string} xStoreID Store ID
47576
47831
  * @param {string} authorization Bearer JWT token
47577
47832
  * @param {number} id Event Type ID
47578
47833
  * @param {ModelsUpdateCustomEventTypeRequest} modelsUpdateCustomEventTypeRequest Updated event type configuration
47579
47834
  * @param {*} [options] Override http request option.
47580
47835
  * @throws {RequiredError}
47581
47836
  */
47582
- v1AnalyticsCustomEventsIdPut(authorization: string, id: number, modelsUpdateCustomEventTypeRequest: ModelsUpdateCustomEventTypeRequest, options?: RawAxiosRequestConfig): AxiosPromise<{
47837
+ adminAnalyticsStoreXStoreIDCustomEventsIdPut(xStoreID: string, authorization: string, id: number, modelsUpdateCustomEventTypeRequest: ModelsUpdateCustomEventTypeRequest, options?: RawAxiosRequestConfig): AxiosPromise<{
47583
47838
  [key: string]: any;
47584
47839
  }>;
47585
47840
  /**
47586
47841
  * Get available slot numbers for string and numeric fields. String fields use slots 1-25, numeric fields use slots 1-15.
47587
47842
  * @summary Get Available Slots
47843
+ * @param {string} xStoreID Store ID
47588
47844
  * @param {string} authorization Bearer JWT token
47589
47845
  * @param {number} id Event Type ID
47590
47846
  * @param {*} [options] Override http request option.
47591
47847
  * @throws {RequiredError}
47592
47848
  */
47593
- v1AnalyticsCustomEventsIdSlotsGet(authorization: string, id: number, options?: RawAxiosRequestConfig): AxiosPromise<{
47849
+ adminAnalyticsStoreXStoreIDCustomEventsIdSlotsGet(xStoreID: string, authorization: string, id: number, options?: RawAxiosRequestConfig): AxiosPromise<{
47594
47850
  [key: string]: any;
47595
47851
  }>;
47596
47852
  /**
47597
47853
  * Validate an event payload against the custom event type schema. Returns validation errors if the payload doesn\'t match the schema.
47598
47854
  * @summary Validate Event Payload
47855
+ * @param {string} xStoreID Store ID
47599
47856
  * @param {string} authorization Bearer JWT token
47600
47857
  * @param {number} id Event Type ID
47601
47858
  * @param {ModelsValidatePayloadRequest} modelsValidatePayloadRequest Payload to validate
47602
47859
  * @param {*} [options] Override http request option.
47603
47860
  * @throws {RequiredError}
47604
47861
  */
47605
- v1AnalyticsCustomEventsIdValidatePost(authorization: string, id: number, modelsValidatePayloadRequest: ModelsValidatePayloadRequest, options?: RawAxiosRequestConfig): AxiosPromise<{
47862
+ adminAnalyticsStoreXStoreIDCustomEventsIdValidatePost(xStoreID: string, authorization: string, id: number, modelsValidatePayloadRequest: ModelsValidatePayloadRequest, options?: RawAxiosRequestConfig): AxiosPromise<{
47606
47863
  [key: string]: any;
47607
47864
  }>;
47608
47865
  /**
47609
47866
  * Create a new custom event type for your organization. Custom event types define the schema for tracking custom business events.
47610
47867
  * @summary Create Custom Event Type
47868
+ * @param {string} xStoreID Store ID
47611
47869
  * @param {string} authorization Bearer JWT token
47612
47870
  * @param {ModelsCreateCustomEventTypeRequest} modelsCreateCustomEventTypeRequest Event type configuration
47613
47871
  * @param {*} [options] Override http request option.
47614
47872
  * @throws {RequiredError}
47615
47873
  */
47616
- v1AnalyticsCustomEventsPost(authorization: string, modelsCreateCustomEventTypeRequest: ModelsCreateCustomEventTypeRequest, options?: RawAxiosRequestConfig): AxiosPromise<{
47874
+ adminAnalyticsStoreXStoreIDCustomEventsPost(xStoreID: string, authorization: string, modelsCreateCustomEventTypeRequest: ModelsCreateCustomEventTypeRequest, options?: RawAxiosRequestConfig): AxiosPromise<{
47617
47875
  [key: string]: any;
47618
47876
  }>;
47619
47877
  };
@@ -47625,10 +47883,10 @@ export declare const CustomEventsApiFactory: (configuration?: Configuration, bas
47625
47883
  */
47626
47884
  export declare class CustomEventsApi extends BaseAPI {
47627
47885
  /**
47628
- * Retrieve a paginated list of custom event types with optional filtering by store, category, and active status.
47886
+ * Retrieve a paginated list of custom event types with optional filtering by category and active status.
47629
47887
  * @summary List Custom Event Types
47888
+ * @param {string} xStoreID Store ID
47630
47889
  * @param {string} authorization Bearer JWT token
47631
- * @param {number} [storeId] Filter by store ID
47632
47890
  * @param {boolean} [isActive] Filter by active status
47633
47891
  * @param {string} [category] Filter by category (user_journey, system, business, custom)
47634
47892
  * @param {string} [search] Search in event names, display names, and descriptions
@@ -47642,24 +47900,26 @@ export declare class CustomEventsApi extends BaseAPI {
47642
47900
  * @throws {RequiredError}
47643
47901
  * @memberof CustomEventsApi
47644
47902
  */
47645
- v1AnalyticsCustomEventsGet(authorization: string, storeId?: number, isActive?: boolean, category?: string, search?: string, page?: number, pageSize?: number, limit?: number, offset?: number, sortBy?: string, sortOrder?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<{
47903
+ adminAnalyticsStoreXStoreIDCustomEventsGet(xStoreID: string, authorization: string, isActive?: boolean, category?: string, search?: string, page?: number, pageSize?: number, limit?: number, offset?: number, sortBy?: string, sortOrder?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<{
47646
47904
  [key: string]: any;
47647
47905
  }, any, {}>>;
47648
47906
  /**
47649
47907
  * Permanently delete a custom event type and all its field definitions. This operation cannot be undone.
47650
47908
  * @summary Delete Custom Event Type
47909
+ * @param {string} xStoreID Store ID
47651
47910
  * @param {string} authorization Bearer JWT token
47652
47911
  * @param {number} id Event Type ID
47653
47912
  * @param {*} [options] Override http request option.
47654
47913
  * @throws {RequiredError}
47655
47914
  * @memberof CustomEventsApi
47656
47915
  */
47657
- v1AnalyticsCustomEventsIdDelete(authorization: string, id: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<{
47916
+ adminAnalyticsStoreXStoreIDCustomEventsIdDelete(xStoreID: string, authorization: string, id: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<{
47658
47917
  [key: string]: any;
47659
47918
  }, any, {}>>;
47660
47919
  /**
47661
47920
  * Remove a field definition from a custom event type. This operation cannot be undone.
47662
47921
  * @summary Remove Field
47922
+ * @param {string} xStoreID Store ID
47663
47923
  * @param {string} authorization Bearer JWT token
47664
47924
  * @param {number} id Event Type ID
47665
47925
  * @param {number} fid Field ID
@@ -47667,12 +47927,13 @@ export declare class CustomEventsApi extends BaseAPI {
47667
47927
  * @throws {RequiredError}
47668
47928
  * @memberof CustomEventsApi
47669
47929
  */
47670
- v1AnalyticsCustomEventsIdFieldsFidDelete(authorization: string, id: number, fid: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<{
47930
+ adminAnalyticsStoreXStoreIDCustomEventsIdFieldsFidDelete(xStoreID: string, authorization: string, id: number, fid: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<{
47671
47931
  [key: string]: any;
47672
47932
  }, any, {}>>;
47673
47933
  /**
47674
47934
  * Update an existing field definition. Note: field_slot and field_type cannot be changed after creation.
47675
47935
  * @summary Update Field
47936
+ * @param {string} xStoreID Store ID
47676
47937
  * @param {string} authorization Bearer JWT token
47677
47938
  * @param {number} id Event Type ID
47678
47939
  * @param {number} fid Field ID
@@ -47681,12 +47942,13 @@ export declare class CustomEventsApi extends BaseAPI {
47681
47942
  * @throws {RequiredError}
47682
47943
  * @memberof CustomEventsApi
47683
47944
  */
47684
- v1AnalyticsCustomEventsIdFieldsFidPut(authorization: string, id: number, fid: number, modelsUpdateCustomEventFieldRequest: ModelsUpdateCustomEventFieldRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<{
47945
+ adminAnalyticsStoreXStoreIDCustomEventsIdFieldsFidPut(xStoreID: string, authorization: string, id: number, fid: number, modelsUpdateCustomEventFieldRequest: ModelsUpdateCustomEventFieldRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<{
47685
47946
  [key: string]: any;
47686
47947
  }, any, {}>>;
47687
47948
  /**
47688
47949
  * Add a new field definition to a custom event type. Fields define the data structure for custom events.
47689
47950
  * @summary Add Field to Custom Event Type
47951
+ * @param {string} xStoreID Store ID
47690
47952
  * @param {string} authorization Bearer JWT token
47691
47953
  * @param {number} id Event Type ID
47692
47954
  * @param {ModelsCreateCustomEventFieldRequest} modelsCreateCustomEventFieldRequest Field configuration
@@ -47694,24 +47956,26 @@ export declare class CustomEventsApi extends BaseAPI {
47694
47956
  * @throws {RequiredError}
47695
47957
  * @memberof CustomEventsApi
47696
47958
  */
47697
- v1AnalyticsCustomEventsIdFieldsPost(authorization: string, id: number, modelsCreateCustomEventFieldRequest: ModelsCreateCustomEventFieldRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<{
47959
+ adminAnalyticsStoreXStoreIDCustomEventsIdFieldsPost(xStoreID: string, authorization: string, id: number, modelsCreateCustomEventFieldRequest: ModelsCreateCustomEventFieldRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<{
47698
47960
  [key: string]: any;
47699
47961
  }, any, {}>>;
47700
47962
  /**
47701
47963
  * Retrieve a specific custom event type by its ID, including all field definitions.
47702
47964
  * @summary Get Custom Event Type
47965
+ * @param {string} xStoreID Store ID
47703
47966
  * @param {string} authorization Bearer JWT token
47704
47967
  * @param {number} id Event Type ID
47705
47968
  * @param {*} [options] Override http request option.
47706
47969
  * @throws {RequiredError}
47707
47970
  * @memberof CustomEventsApi
47708
47971
  */
47709
- v1AnalyticsCustomEventsIdGet(authorization: string, id: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<{
47972
+ adminAnalyticsStoreXStoreIDCustomEventsIdGet(xStoreID: string, authorization: string, id: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<{
47710
47973
  [key: string]: any;
47711
47974
  }, any, {}>>;
47712
47975
  /**
47713
47976
  * Update an existing custom event type. Supports partial updates.
47714
47977
  * @summary Update Custom Event Type
47978
+ * @param {string} xStoreID Store ID
47715
47979
  * @param {string} authorization Bearer JWT token
47716
47980
  * @param {number} id Event Type ID
47717
47981
  * @param {ModelsUpdateCustomEventTypeRequest} modelsUpdateCustomEventTypeRequest Updated event type configuration
@@ -47719,24 +47983,26 @@ export declare class CustomEventsApi extends BaseAPI {
47719
47983
  * @throws {RequiredError}
47720
47984
  * @memberof CustomEventsApi
47721
47985
  */
47722
- v1AnalyticsCustomEventsIdPut(authorization: string, id: number, modelsUpdateCustomEventTypeRequest: ModelsUpdateCustomEventTypeRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<{
47986
+ adminAnalyticsStoreXStoreIDCustomEventsIdPut(xStoreID: string, authorization: string, id: number, modelsUpdateCustomEventTypeRequest: ModelsUpdateCustomEventTypeRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<{
47723
47987
  [key: string]: any;
47724
47988
  }, any, {}>>;
47725
47989
  /**
47726
47990
  * Get available slot numbers for string and numeric fields. String fields use slots 1-25, numeric fields use slots 1-15.
47727
47991
  * @summary Get Available Slots
47992
+ * @param {string} xStoreID Store ID
47728
47993
  * @param {string} authorization Bearer JWT token
47729
47994
  * @param {number} id Event Type ID
47730
47995
  * @param {*} [options] Override http request option.
47731
47996
  * @throws {RequiredError}
47732
47997
  * @memberof CustomEventsApi
47733
47998
  */
47734
- v1AnalyticsCustomEventsIdSlotsGet(authorization: string, id: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<{
47999
+ adminAnalyticsStoreXStoreIDCustomEventsIdSlotsGet(xStoreID: string, authorization: string, id: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<{
47735
48000
  [key: string]: any;
47736
48001
  }, any, {}>>;
47737
48002
  /**
47738
48003
  * Validate an event payload against the custom event type schema. Returns validation errors if the payload doesn\'t match the schema.
47739
48004
  * @summary Validate Event Payload
48005
+ * @param {string} xStoreID Store ID
47740
48006
  * @param {string} authorization Bearer JWT token
47741
48007
  * @param {number} id Event Type ID
47742
48008
  * @param {ModelsValidatePayloadRequest} modelsValidatePayloadRequest Payload to validate
@@ -47744,19 +48010,20 @@ export declare class CustomEventsApi extends BaseAPI {
47744
48010
  * @throws {RequiredError}
47745
48011
  * @memberof CustomEventsApi
47746
48012
  */
47747
- v1AnalyticsCustomEventsIdValidatePost(authorization: string, id: number, modelsValidatePayloadRequest: ModelsValidatePayloadRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<{
48013
+ adminAnalyticsStoreXStoreIDCustomEventsIdValidatePost(xStoreID: string, authorization: string, id: number, modelsValidatePayloadRequest: ModelsValidatePayloadRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<{
47748
48014
  [key: string]: any;
47749
48015
  }, any, {}>>;
47750
48016
  /**
47751
48017
  * Create a new custom event type for your organization. Custom event types define the schema for tracking custom business events.
47752
48018
  * @summary Create Custom Event Type
48019
+ * @param {string} xStoreID Store ID
47753
48020
  * @param {string} authorization Bearer JWT token
47754
48021
  * @param {ModelsCreateCustomEventTypeRequest} modelsCreateCustomEventTypeRequest Event type configuration
47755
48022
  * @param {*} [options] Override http request option.
47756
48023
  * @throws {RequiredError}
47757
48024
  * @memberof CustomEventsApi
47758
48025
  */
47759
- v1AnalyticsCustomEventsPost(authorization: string, modelsCreateCustomEventTypeRequest: ModelsCreateCustomEventTypeRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<{
48026
+ adminAnalyticsStoreXStoreIDCustomEventsPost(xStoreID: string, authorization: string, modelsCreateCustomEventTypeRequest: ModelsCreateCustomEventTypeRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<{
47760
48027
  [key: string]: any;
47761
48028
  }, any, {}>>;
47762
48029
  }
@@ -48764,27 +49031,27 @@ export declare const DocumentationApiAxiosParamCreator: (configuration?: Configu
48764
49031
  */
48765
49032
  v1DocsRecreateCollectionPost: (xDocsAPIKey: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
48766
49033
  /**
48767
- * Scrapes the documentation site and indexes all pages in Typesense. Requires X-Docs-API-Key header. Returns 404 if API key is missing or invalid.
49034
+ * Crawls the configured documentation site and indexes all pages for search. Requires X-Docs-API-Key header. Returns 404 if API key is missing or invalid. Used by doc search integration.
48768
49035
  * @summary Scrape and index documentation
48769
- * @param {string} xDocsAPIKey Documentation API Secret Key
49036
+ * @param {string} xDocsAPIKey Documentation API key (from dashboard)
48770
49037
  * @param {*} [options] Override http request option.
48771
49038
  * @throws {RequiredError}
48772
49039
  */
48773
49040
  v1DocsScrapePost: (xDocsAPIKey: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
48774
49041
  /**
48775
- * Searches the indexed documentation using Typesense. This is a public endpoint that does not require authentication.
49042
+ * Full-text search over the indexed documentation. No authentication required. Optional X-Docs-API-Key may be used for higher rate limits. Use `query` and optional `limit` (default 10, max 100).
48776
49043
  * @summary Search documentation
48777
49044
  * @param {string} query Search query
48778
- * @param {number} [limit] Maximum number of results (default: 10, max: 100)
49045
+ * @param {number} [limit] Max results (default: 10, max: 100)
48779
49046
  * @param {*} [options] Override http request option.
48780
49047
  * @throws {RequiredError}
48781
49048
  */
48782
49049
  v1DocsSearchPost: (query: string, limit?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
48783
49050
  /**
48784
- * Returns dropdown-style suggestions as raw search results. Frontend handles grouping. No authentication required.
48785
- * @summary Get search suggestions
48786
- * @param {string} query Search query
48787
- * @param {number} [limit] Number of suggestions (default: 6, max: 20)
49051
+ * Autocomplete suggestions for documentation search. No authentication required. Use for dropdown/typeahead UIs. Empty query returns no suggestions.
49052
+ * @summary Get doc search suggestions
49053
+ * @param {string} query Partial search query
49054
+ * @param {number} [limit] Max suggestions (default: 6, max: 20)
48788
49055
  * @param {*} [options] Override http request option.
48789
49056
  * @throws {RequiredError}
48790
49057
  */
@@ -48847,9 +49114,9 @@ export declare const DocumentationApiFp: (configuration?: Configuration) => {
48847
49114
  [key: string]: any;
48848
49115
  }>>;
48849
49116
  /**
48850
- * Scrapes the documentation site and indexes all pages in Typesense. Requires X-Docs-API-Key header. Returns 404 if API key is missing or invalid.
49117
+ * Crawls the configured documentation site and indexes all pages for search. Requires X-Docs-API-Key header. Returns 404 if API key is missing or invalid. Used by doc search integration.
48851
49118
  * @summary Scrape and index documentation
48852
- * @param {string} xDocsAPIKey Documentation API Secret Key
49119
+ * @param {string} xDocsAPIKey Documentation API key (from dashboard)
48853
49120
  * @param {*} [options] Override http request option.
48854
49121
  * @throws {RequiredError}
48855
49122
  */
@@ -48857,10 +49124,10 @@ export declare const DocumentationApiFp: (configuration?: Configuration) => {
48857
49124
  [key: string]: any;
48858
49125
  }>>;
48859
49126
  /**
48860
- * Searches the indexed documentation using Typesense. This is a public endpoint that does not require authentication.
49127
+ * Full-text search over the indexed documentation. No authentication required. Optional X-Docs-API-Key may be used for higher rate limits. Use `query` and optional `limit` (default 10, max 100).
48861
49128
  * @summary Search documentation
48862
49129
  * @param {string} query Search query
48863
- * @param {number} [limit] Maximum number of results (default: 10, max: 100)
49130
+ * @param {number} [limit] Max results (default: 10, max: 100)
48864
49131
  * @param {*} [options] Override http request option.
48865
49132
  * @throws {RequiredError}
48866
49133
  */
@@ -48868,10 +49135,10 @@ export declare const DocumentationApiFp: (configuration?: Configuration) => {
48868
49135
  [key: string]: any;
48869
49136
  }>>;
48870
49137
  /**
48871
- * Returns dropdown-style suggestions as raw search results. Frontend handles grouping. No authentication required.
48872
- * @summary Get search suggestions
48873
- * @param {string} query Search query
48874
- * @param {number} [limit] Number of suggestions (default: 6, max: 20)
49138
+ * Autocomplete suggestions for documentation search. No authentication required. Use for dropdown/typeahead UIs. Empty query returns no suggestions.
49139
+ * @summary Get doc search suggestions
49140
+ * @param {string} query Partial search query
49141
+ * @param {number} [limit] Max suggestions (default: 6, max: 20)
48875
49142
  * @param {*} [options] Override http request option.
48876
49143
  * @throws {RequiredError}
48877
49144
  */
@@ -48938,9 +49205,9 @@ export declare const DocumentationApiFactory: (configuration?: Configuration, ba
48938
49205
  [key: string]: any;
48939
49206
  }>;
48940
49207
  /**
48941
- * Scrapes the documentation site and indexes all pages in Typesense. Requires X-Docs-API-Key header. Returns 404 if API key is missing or invalid.
49208
+ * Crawls the configured documentation site and indexes all pages for search. Requires X-Docs-API-Key header. Returns 404 if API key is missing or invalid. Used by doc search integration.
48942
49209
  * @summary Scrape and index documentation
48943
- * @param {string} xDocsAPIKey Documentation API Secret Key
49210
+ * @param {string} xDocsAPIKey Documentation API key (from dashboard)
48944
49211
  * @param {*} [options] Override http request option.
48945
49212
  * @throws {RequiredError}
48946
49213
  */
@@ -48948,10 +49215,10 @@ export declare const DocumentationApiFactory: (configuration?: Configuration, ba
48948
49215
  [key: string]: any;
48949
49216
  }>;
48950
49217
  /**
48951
- * Searches the indexed documentation using Typesense. This is a public endpoint that does not require authentication.
49218
+ * Full-text search over the indexed documentation. No authentication required. Optional X-Docs-API-Key may be used for higher rate limits. Use `query` and optional `limit` (default 10, max 100).
48952
49219
  * @summary Search documentation
48953
49220
  * @param {string} query Search query
48954
- * @param {number} [limit] Maximum number of results (default: 10, max: 100)
49221
+ * @param {number} [limit] Max results (default: 10, max: 100)
48955
49222
  * @param {*} [options] Override http request option.
48956
49223
  * @throws {RequiredError}
48957
49224
  */
@@ -48959,10 +49226,10 @@ export declare const DocumentationApiFactory: (configuration?: Configuration, ba
48959
49226
  [key: string]: any;
48960
49227
  }>;
48961
49228
  /**
48962
- * Returns dropdown-style suggestions as raw search results. Frontend handles grouping. No authentication required.
48963
- * @summary Get search suggestions
48964
- * @param {string} query Search query
48965
- * @param {number} [limit] Number of suggestions (default: 6, max: 20)
49229
+ * Autocomplete suggestions for documentation search. No authentication required. Use for dropdown/typeahead UIs. Empty query returns no suggestions.
49230
+ * @summary Get doc search suggestions
49231
+ * @param {string} query Partial search query
49232
+ * @param {number} [limit] Max suggestions (default: 6, max: 20)
48966
49233
  * @param {*} [options] Override http request option.
48967
49234
  * @throws {RequiredError}
48968
49235
  */
@@ -49035,9 +49302,9 @@ export declare class DocumentationApi extends BaseAPI {
49035
49302
  [key: string]: any;
49036
49303
  }, any, {}>>;
49037
49304
  /**
49038
- * Scrapes the documentation site and indexes all pages in Typesense. Requires X-Docs-API-Key header. Returns 404 if API key is missing or invalid.
49305
+ * Crawls the configured documentation site and indexes all pages for search. Requires X-Docs-API-Key header. Returns 404 if API key is missing or invalid. Used by doc search integration.
49039
49306
  * @summary Scrape and index documentation
49040
- * @param {string} xDocsAPIKey Documentation API Secret Key
49307
+ * @param {string} xDocsAPIKey Documentation API key (from dashboard)
49041
49308
  * @param {*} [options] Override http request option.
49042
49309
  * @throws {RequiredError}
49043
49310
  * @memberof DocumentationApi
@@ -49046,10 +49313,10 @@ export declare class DocumentationApi extends BaseAPI {
49046
49313
  [key: string]: any;
49047
49314
  }, any, {}>>;
49048
49315
  /**
49049
- * Searches the indexed documentation using Typesense. This is a public endpoint that does not require authentication.
49316
+ * Full-text search over the indexed documentation. No authentication required. Optional X-Docs-API-Key may be used for higher rate limits. Use `query` and optional `limit` (default 10, max 100).
49050
49317
  * @summary Search documentation
49051
49318
  * @param {string} query Search query
49052
- * @param {number} [limit] Maximum number of results (default: 10, max: 100)
49319
+ * @param {number} [limit] Max results (default: 10, max: 100)
49053
49320
  * @param {*} [options] Override http request option.
49054
49321
  * @throws {RequiredError}
49055
49322
  * @memberof DocumentationApi
@@ -49058,10 +49325,10 @@ export declare class DocumentationApi extends BaseAPI {
49058
49325
  [key: string]: any;
49059
49326
  }, any, {}>>;
49060
49327
  /**
49061
- * Returns dropdown-style suggestions as raw search results. Frontend handles grouping. No authentication required.
49062
- * @summary Get search suggestions
49063
- * @param {string} query Search query
49064
- * @param {number} [limit] Number of suggestions (default: 6, max: 20)
49328
+ * Autocomplete suggestions for documentation search. No authentication required. Use for dropdown/typeahead UIs. Empty query returns no suggestions.
49329
+ * @summary Get doc search suggestions
49330
+ * @param {string} query Partial search query
49331
+ * @param {number} [limit] Max suggestions (default: 6, max: 20)
49065
49332
  * @param {*} [options] Override http request option.
49066
49333
  * @throws {RequiredError}
49067
49334
  * @memberof DocumentationApi
@@ -55278,47 +55545,56 @@ export declare class PluralsDeclensionsApi extends BaseAPI {
55278
55545
  */
55279
55546
  export declare const QuerySuggestionsApiAxiosParamCreator: (configuration?: Configuration) => {
55280
55547
  /**
55281
- * Retrieve configuration settings for query suggestions API including limits, supported time ranges, and default values
55282
- * @summary Get Query Suggestions Configuration
55283
- * @param {string} xStoreid Store ID
55284
- * @param {string} xStoresecret Store Secret
55548
+ * Returns limits, supported time ranges, and default values for the query suggestions API. **Auth:** `x-storeid` and `x-storesecret`.
55549
+ * @summary Get suggestions configuration
55550
+ * @param {string} xStoreid Store ID (from dashboard)
55551
+ * @param {string} xStoresecret Store read secret
55285
55552
  * @param {*} [options] Override http request option.
55286
55553
  * @throws {RequiredError}
55287
55554
  */
55288
55555
  v1SuggestionsConfigGet: (xStoreid: string, xStoresecret: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
55289
55556
  /**
55290
- * Retrieve query suggestions based on search analytics data with popularity ranking and optional category/facet enrichment. Supports partial query matching, analytics tags filtering, and configurable time ranges. Supports personalization via x-user-id, x-anon-id, x-session-id headers.
55291
- * @summary Get Query Suggestions
55292
- * @param {string} xStoreid Store ID
55293
- * @param {string} xStoresecret Store Secret
55294
- * @param {string} [xUserId] User ID for personalization (logged-in user)
55295
- * @param {string} [xAnonId] Anonymous ID for personalization (cookie/device ID)
55557
+ * Autocomplete suggestions for search, ranked by popularity. **Auth:** `x-storeid` and `x-storesecret` (from dashboard). Optional: `x-user-id`, `x-anon-id`, `x-session-id` for personalization. Supports partial query, filters (analytics_tags), time range (7d/30d/90d), categories, facets, and dropdown recommendations. Use `query` or `q` for the partial search string.
55558
+ * @summary Get query suggestions (GET)
55559
+ * @param {string} xStoreid Store ID (from dashboard)
55560
+ * @param {string} xStoresecret Store read secret
55561
+ * @param {string} [xUserId] User ID for personalization
55562
+ * @param {string} [xAnonId] Anonymous user ID for personalization
55296
55563
  * @param {string} [xSessionId] Session ID for personalization
55297
- * @param {string} [query] Partial query to get suggestions for
55298
- * @param {number} [hitsPerPage] Number of suggestions to return
55299
- * @param {number} [page] Page number for pagination
55300
- * @param {string} [analyticsTags] Comma-separated analytics tags to filter suggestions
55301
- * @param {V1SuggestionsQueriesGetTagsMatchModeEnum} [tagsMatchMode] How to match analytics tags
55302
- * @param {boolean} [includeCategories] Include category information in suggestions
55303
- * @param {boolean} [includeFacets] Include popular facets/filters information
55304
- * @param {number} [maxCategories] Maximum categories per suggestion
55305
- * @param {number} [maxFacets] Maximum facets per suggestion
55306
- * @param {number} [minPopularity] Minimum popularity threshold
55307
- * @param {V1SuggestionsQueriesGetTimeRangeEnum} [timeRange] Time range for analytics data
55308
- * @param {boolean} [disableTypoTolerance] Disable fuzzy/typo-tolerant matching
55309
- * @param {*} [options] Override http request option.
55310
- * @throws {RequiredError}
55311
- */
55312
- v1SuggestionsQueriesGet: (xStoreid: string, xStoresecret: string, xUserId?: string, xAnonId?: string, xSessionId?: string, query?: string, hitsPerPage?: number, page?: number, analyticsTags?: string, tagsMatchMode?: V1SuggestionsQueriesGetTagsMatchModeEnum, includeCategories?: boolean, includeFacets?: boolean, maxCategories?: number, maxFacets?: number, minPopularity?: number, timeRange?: V1SuggestionsQueriesGetTimeRangeEnum, disableTypoTolerance?: boolean, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
55313
- /**
55314
- * Same as GET: retrieve query suggestions with optional body (query, hitsPerPage, analytics_tags, filtered_tabs, etc.). Use POST when sending filtered_tabs or larger payloads. Supports personalization via x-user-id, x-anon-id, x-session-id headers.
55315
- * @summary Post Query Suggestions
55316
- * @param {string} xStoreid Store ID
55317
- * @param {string} xStoresecret Store Secret
55318
- * @param {string} [xUserId] User ID for personalization (logged-in user)
55319
- * @param {string} [xAnonId] Anonymous ID for personalization (cookie/device ID)
55564
+ * @param {string} [query] Partial query (use \&#39;query\&#39; or \&#39;q\&#39;)
55565
+ * @param {string} [q] Alias for query
55566
+ * @param {number} [hitsPerPage] Suggestions to return
55567
+ * @param {number} [page] Page for pagination
55568
+ * @param {string} [analyticsTags] Comma-separated tags to filter
55569
+ * @param {V1SuggestionsQueriesGetTagsMatchModeEnum} [tagsMatchMode] Match mode for tags
55570
+ * @param {boolean} [includeCategories] Include category in suggestions
55571
+ * @param {boolean} [includeFacets] Include facet info
55572
+ * @param {boolean} [includeDropdownRecommendations] Include dropdown recommendations
55573
+ * @param {boolean} [includeDropdownProductList] Include product list in dropdown
55574
+ * @param {boolean} [includeFilteredTabs] Include filtered tabs
55575
+ * @param {boolean} [includeEmptyQueryRecommendations] Popular suggestions when query empty
55576
+ * @param {number} [maxCategories] Max categories per suggestion
55577
+ * @param {number} [maxFacets] Max facets per suggestion
55578
+ * @param {number} [minPopularity] Min popularity
55579
+ * @param {V1SuggestionsQueriesGetTimeRangeEnum} [timeRange] Data time range
55580
+ * @param {boolean} [disableTypoTolerance] Disable fuzzy matching
55581
+ * @param {string} [filteredTabs] URL-encoded JSON array of tab configs
55582
+ * @param {string} [userId] User ID (fallback if header not set)
55583
+ * @param {string} [anonId] Anonymous ID (fallback)
55584
+ * @param {string} [sessionId] Session ID (fallback)
55585
+ * @param {*} [options] Override http request option.
55586
+ * @throws {RequiredError}
55587
+ */
55588
+ v1SuggestionsQueriesGet: (xStoreid: string, xStoresecret: string, xUserId?: string, xAnonId?: string, xSessionId?: string, query?: string, q?: string, hitsPerPage?: number, page?: number, analyticsTags?: string, tagsMatchMode?: V1SuggestionsQueriesGetTagsMatchModeEnum, includeCategories?: boolean, includeFacets?: boolean, includeDropdownRecommendations?: boolean, includeDropdownProductList?: boolean, includeFilteredTabs?: boolean, includeEmptyQueryRecommendations?: boolean, maxCategories?: number, maxFacets?: number, minPopularity?: number, timeRange?: V1SuggestionsQueriesGetTimeRangeEnum, disableTypoTolerance?: boolean, filteredTabs?: string, userId?: string, anonId?: string, sessionId?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
55589
+ /**
55590
+ * Same as GET; use POST to send a JSON body (e.g. complex filtered_tabs). **Auth:** `x-storeid` and `x-storesecret`. Optional personalization headers: `x-user-id`, `x-anon-id`, `x-session-id`. Request body can include query, hitsPerPage, analytics_tags, include_categories, include_facets, filtered_tabs, etc.
55591
+ * @summary Get query suggestions (POST)
55592
+ * @param {string} xStoreid Store ID (from dashboard)
55593
+ * @param {string} xStoresecret Store read secret
55594
+ * @param {string} [xUserId] User ID for personalization
55595
+ * @param {string} [xAnonId] Anonymous user ID for personalization
55320
55596
  * @param {string} [xSessionId] Session ID for personalization
55321
- * @param {QuerySuggestionsServiceQuerySuggestionsRequest} [querySuggestionsServiceQuerySuggestionsRequest] Query suggestions request (query, hitsPerPage, page, analytics_tags, include_categories, include_facets, filtered_tabs, etc.)
55597
+ * @param {QuerySuggestionsServiceQuerySuggestionsRequest} [querySuggestionsServiceQuerySuggestionsRequest] Request (query, hitsPerPage, analytics_tags, filtered_tabs, etc.)
55322
55598
  * @param {*} [options] Override http request option.
55323
55599
  * @throws {RequiredError}
55324
55600
  */
@@ -55330,47 +55606,56 @@ export declare const QuerySuggestionsApiAxiosParamCreator: (configuration?: Conf
55330
55606
  */
55331
55607
  export declare const QuerySuggestionsApiFp: (configuration?: Configuration) => {
55332
55608
  /**
55333
- * Retrieve configuration settings for query suggestions API including limits, supported time ranges, and default values
55334
- * @summary Get Query Suggestions Configuration
55335
- * @param {string} xStoreid Store ID
55336
- * @param {string} xStoresecret Store Secret
55609
+ * Returns limits, supported time ranges, and default values for the query suggestions API. **Auth:** `x-storeid` and `x-storesecret`.
55610
+ * @summary Get suggestions configuration
55611
+ * @param {string} xStoreid Store ID (from dashboard)
55612
+ * @param {string} xStoresecret Store read secret
55337
55613
  * @param {*} [options] Override http request option.
55338
55614
  * @throws {RequiredError}
55339
55615
  */
55340
55616
  v1SuggestionsConfigGet(xStoreid: string, xStoresecret: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<V1SuggestionsConfigGet200Response>>;
55341
55617
  /**
55342
- * Retrieve query suggestions based on search analytics data with popularity ranking and optional category/facet enrichment. Supports partial query matching, analytics tags filtering, and configurable time ranges. Supports personalization via x-user-id, x-anon-id, x-session-id headers.
55343
- * @summary Get Query Suggestions
55344
- * @param {string} xStoreid Store ID
55345
- * @param {string} xStoresecret Store Secret
55346
- * @param {string} [xUserId] User ID for personalization (logged-in user)
55347
- * @param {string} [xAnonId] Anonymous ID for personalization (cookie/device ID)
55618
+ * Autocomplete suggestions for search, ranked by popularity. **Auth:** `x-storeid` and `x-storesecret` (from dashboard). Optional: `x-user-id`, `x-anon-id`, `x-session-id` for personalization. Supports partial query, filters (analytics_tags), time range (7d/30d/90d), categories, facets, and dropdown recommendations. Use `query` or `q` for the partial search string.
55619
+ * @summary Get query suggestions (GET)
55620
+ * @param {string} xStoreid Store ID (from dashboard)
55621
+ * @param {string} xStoresecret Store read secret
55622
+ * @param {string} [xUserId] User ID for personalization
55623
+ * @param {string} [xAnonId] Anonymous user ID for personalization
55348
55624
  * @param {string} [xSessionId] Session ID for personalization
55349
- * @param {string} [query] Partial query to get suggestions for
55350
- * @param {number} [hitsPerPage] Number of suggestions to return
55351
- * @param {number} [page] Page number for pagination
55352
- * @param {string} [analyticsTags] Comma-separated analytics tags to filter suggestions
55353
- * @param {V1SuggestionsQueriesGetTagsMatchModeEnum} [tagsMatchMode] How to match analytics tags
55354
- * @param {boolean} [includeCategories] Include category information in suggestions
55355
- * @param {boolean} [includeFacets] Include popular facets/filters information
55356
- * @param {number} [maxCategories] Maximum categories per suggestion
55357
- * @param {number} [maxFacets] Maximum facets per suggestion
55358
- * @param {number} [minPopularity] Minimum popularity threshold
55359
- * @param {V1SuggestionsQueriesGetTimeRangeEnum} [timeRange] Time range for analytics data
55360
- * @param {boolean} [disableTypoTolerance] Disable fuzzy/typo-tolerant matching
55361
- * @param {*} [options] Override http request option.
55362
- * @throws {RequiredError}
55363
- */
55364
- v1SuggestionsQueriesGet(xStoreid: string, xStoresecret: string, xUserId?: string, xAnonId?: string, xSessionId?: string, query?: string, hitsPerPage?: number, page?: number, analyticsTags?: string, tagsMatchMode?: V1SuggestionsQueriesGetTagsMatchModeEnum, includeCategories?: boolean, includeFacets?: boolean, maxCategories?: number, maxFacets?: number, minPopularity?: number, timeRange?: V1SuggestionsQueriesGetTimeRangeEnum, disableTypoTolerance?: boolean, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<QuerySuggestionsServiceQuerySuggestionsAPIResponse>>;
55365
- /**
55366
- * Same as GET: retrieve query suggestions with optional body (query, hitsPerPage, analytics_tags, filtered_tabs, etc.). Use POST when sending filtered_tabs or larger payloads. Supports personalization via x-user-id, x-anon-id, x-session-id headers.
55367
- * @summary Post Query Suggestions
55368
- * @param {string} xStoreid Store ID
55369
- * @param {string} xStoresecret Store Secret
55370
- * @param {string} [xUserId] User ID for personalization (logged-in user)
55371
- * @param {string} [xAnonId] Anonymous ID for personalization (cookie/device ID)
55625
+ * @param {string} [query] Partial query (use \&#39;query\&#39; or \&#39;q\&#39;)
55626
+ * @param {string} [q] Alias for query
55627
+ * @param {number} [hitsPerPage] Suggestions to return
55628
+ * @param {number} [page] Page for pagination
55629
+ * @param {string} [analyticsTags] Comma-separated tags to filter
55630
+ * @param {V1SuggestionsQueriesGetTagsMatchModeEnum} [tagsMatchMode] Match mode for tags
55631
+ * @param {boolean} [includeCategories] Include category in suggestions
55632
+ * @param {boolean} [includeFacets] Include facet info
55633
+ * @param {boolean} [includeDropdownRecommendations] Include dropdown recommendations
55634
+ * @param {boolean} [includeDropdownProductList] Include product list in dropdown
55635
+ * @param {boolean} [includeFilteredTabs] Include filtered tabs
55636
+ * @param {boolean} [includeEmptyQueryRecommendations] Popular suggestions when query empty
55637
+ * @param {number} [maxCategories] Max categories per suggestion
55638
+ * @param {number} [maxFacets] Max facets per suggestion
55639
+ * @param {number} [minPopularity] Min popularity
55640
+ * @param {V1SuggestionsQueriesGetTimeRangeEnum} [timeRange] Data time range
55641
+ * @param {boolean} [disableTypoTolerance] Disable fuzzy matching
55642
+ * @param {string} [filteredTabs] URL-encoded JSON array of tab configs
55643
+ * @param {string} [userId] User ID (fallback if header not set)
55644
+ * @param {string} [anonId] Anonymous ID (fallback)
55645
+ * @param {string} [sessionId] Session ID (fallback)
55646
+ * @param {*} [options] Override http request option.
55647
+ * @throws {RequiredError}
55648
+ */
55649
+ v1SuggestionsQueriesGet(xStoreid: string, xStoresecret: string, xUserId?: string, xAnonId?: string, xSessionId?: string, query?: string, q?: string, hitsPerPage?: number, page?: number, analyticsTags?: string, tagsMatchMode?: V1SuggestionsQueriesGetTagsMatchModeEnum, includeCategories?: boolean, includeFacets?: boolean, includeDropdownRecommendations?: boolean, includeDropdownProductList?: boolean, includeFilteredTabs?: boolean, includeEmptyQueryRecommendations?: boolean, maxCategories?: number, maxFacets?: number, minPopularity?: number, timeRange?: V1SuggestionsQueriesGetTimeRangeEnum, disableTypoTolerance?: boolean, filteredTabs?: string, userId?: string, anonId?: string, sessionId?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<QuerySuggestionsServiceQuerySuggestionsAPIResponse>>;
55650
+ /**
55651
+ * Same as GET; use POST to send a JSON body (e.g. complex filtered_tabs). **Auth:** `x-storeid` and `x-storesecret`. Optional personalization headers: `x-user-id`, `x-anon-id`, `x-session-id`. Request body can include query, hitsPerPage, analytics_tags, include_categories, include_facets, filtered_tabs, etc.
55652
+ * @summary Get query suggestions (POST)
55653
+ * @param {string} xStoreid Store ID (from dashboard)
55654
+ * @param {string} xStoresecret Store read secret
55655
+ * @param {string} [xUserId] User ID for personalization
55656
+ * @param {string} [xAnonId] Anonymous user ID for personalization
55372
55657
  * @param {string} [xSessionId] Session ID for personalization
55373
- * @param {QuerySuggestionsServiceQuerySuggestionsRequest} [querySuggestionsServiceQuerySuggestionsRequest] Query suggestions request (query, hitsPerPage, page, analytics_tags, include_categories, include_facets, filtered_tabs, etc.)
55658
+ * @param {QuerySuggestionsServiceQuerySuggestionsRequest} [querySuggestionsServiceQuerySuggestionsRequest] Request (query, hitsPerPage, analytics_tags, filtered_tabs, etc.)
55374
55659
  * @param {*} [options] Override http request option.
55375
55660
  * @throws {RequiredError}
55376
55661
  */
@@ -55382,47 +55667,56 @@ export declare const QuerySuggestionsApiFp: (configuration?: Configuration) => {
55382
55667
  */
55383
55668
  export declare const QuerySuggestionsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
55384
55669
  /**
55385
- * Retrieve configuration settings for query suggestions API including limits, supported time ranges, and default values
55386
- * @summary Get Query Suggestions Configuration
55387
- * @param {string} xStoreid Store ID
55388
- * @param {string} xStoresecret Store Secret
55670
+ * Returns limits, supported time ranges, and default values for the query suggestions API. **Auth:** `x-storeid` and `x-storesecret`.
55671
+ * @summary Get suggestions configuration
55672
+ * @param {string} xStoreid Store ID (from dashboard)
55673
+ * @param {string} xStoresecret Store read secret
55389
55674
  * @param {*} [options] Override http request option.
55390
55675
  * @throws {RequiredError}
55391
55676
  */
55392
55677
  v1SuggestionsConfigGet(xStoreid: string, xStoresecret: string, options?: RawAxiosRequestConfig): AxiosPromise<V1SuggestionsConfigGet200Response>;
55393
55678
  /**
55394
- * Retrieve query suggestions based on search analytics data with popularity ranking and optional category/facet enrichment. Supports partial query matching, analytics tags filtering, and configurable time ranges. Supports personalization via x-user-id, x-anon-id, x-session-id headers.
55395
- * @summary Get Query Suggestions
55396
- * @param {string} xStoreid Store ID
55397
- * @param {string} xStoresecret Store Secret
55398
- * @param {string} [xUserId] User ID for personalization (logged-in user)
55399
- * @param {string} [xAnonId] Anonymous ID for personalization (cookie/device ID)
55679
+ * Autocomplete suggestions for search, ranked by popularity. **Auth:** `x-storeid` and `x-storesecret` (from dashboard). Optional: `x-user-id`, `x-anon-id`, `x-session-id` for personalization. Supports partial query, filters (analytics_tags), time range (7d/30d/90d), categories, facets, and dropdown recommendations. Use `query` or `q` for the partial search string.
55680
+ * @summary Get query suggestions (GET)
55681
+ * @param {string} xStoreid Store ID (from dashboard)
55682
+ * @param {string} xStoresecret Store read secret
55683
+ * @param {string} [xUserId] User ID for personalization
55684
+ * @param {string} [xAnonId] Anonymous user ID for personalization
55400
55685
  * @param {string} [xSessionId] Session ID for personalization
55401
- * @param {string} [query] Partial query to get suggestions for
55402
- * @param {number} [hitsPerPage] Number of suggestions to return
55403
- * @param {number} [page] Page number for pagination
55404
- * @param {string} [analyticsTags] Comma-separated analytics tags to filter suggestions
55405
- * @param {V1SuggestionsQueriesGetTagsMatchModeEnum} [tagsMatchMode] How to match analytics tags
55406
- * @param {boolean} [includeCategories] Include category information in suggestions
55407
- * @param {boolean} [includeFacets] Include popular facets/filters information
55408
- * @param {number} [maxCategories] Maximum categories per suggestion
55409
- * @param {number} [maxFacets] Maximum facets per suggestion
55410
- * @param {number} [minPopularity] Minimum popularity threshold
55411
- * @param {V1SuggestionsQueriesGetTimeRangeEnum} [timeRange] Time range for analytics data
55412
- * @param {boolean} [disableTypoTolerance] Disable fuzzy/typo-tolerant matching
55413
- * @param {*} [options] Override http request option.
55414
- * @throws {RequiredError}
55415
- */
55416
- v1SuggestionsQueriesGet(xStoreid: string, xStoresecret: string, xUserId?: string, xAnonId?: string, xSessionId?: string, query?: string, hitsPerPage?: number, page?: number, analyticsTags?: string, tagsMatchMode?: V1SuggestionsQueriesGetTagsMatchModeEnum, includeCategories?: boolean, includeFacets?: boolean, maxCategories?: number, maxFacets?: number, minPopularity?: number, timeRange?: V1SuggestionsQueriesGetTimeRangeEnum, disableTypoTolerance?: boolean, options?: RawAxiosRequestConfig): AxiosPromise<QuerySuggestionsServiceQuerySuggestionsAPIResponse>;
55417
- /**
55418
- * Same as GET: retrieve query suggestions with optional body (query, hitsPerPage, analytics_tags, filtered_tabs, etc.). Use POST when sending filtered_tabs or larger payloads. Supports personalization via x-user-id, x-anon-id, x-session-id headers.
55419
- * @summary Post Query Suggestions
55420
- * @param {string} xStoreid Store ID
55421
- * @param {string} xStoresecret Store Secret
55422
- * @param {string} [xUserId] User ID for personalization (logged-in user)
55423
- * @param {string} [xAnonId] Anonymous ID for personalization (cookie/device ID)
55686
+ * @param {string} [query] Partial query (use \&#39;query\&#39; or \&#39;q\&#39;)
55687
+ * @param {string} [q] Alias for query
55688
+ * @param {number} [hitsPerPage] Suggestions to return
55689
+ * @param {number} [page] Page for pagination
55690
+ * @param {string} [analyticsTags] Comma-separated tags to filter
55691
+ * @param {V1SuggestionsQueriesGetTagsMatchModeEnum} [tagsMatchMode] Match mode for tags
55692
+ * @param {boolean} [includeCategories] Include category in suggestions
55693
+ * @param {boolean} [includeFacets] Include facet info
55694
+ * @param {boolean} [includeDropdownRecommendations] Include dropdown recommendations
55695
+ * @param {boolean} [includeDropdownProductList] Include product list in dropdown
55696
+ * @param {boolean} [includeFilteredTabs] Include filtered tabs
55697
+ * @param {boolean} [includeEmptyQueryRecommendations] Popular suggestions when query empty
55698
+ * @param {number} [maxCategories] Max categories per suggestion
55699
+ * @param {number} [maxFacets] Max facets per suggestion
55700
+ * @param {number} [minPopularity] Min popularity
55701
+ * @param {V1SuggestionsQueriesGetTimeRangeEnum} [timeRange] Data time range
55702
+ * @param {boolean} [disableTypoTolerance] Disable fuzzy matching
55703
+ * @param {string} [filteredTabs] URL-encoded JSON array of tab configs
55704
+ * @param {string} [userId] User ID (fallback if header not set)
55705
+ * @param {string} [anonId] Anonymous ID (fallback)
55706
+ * @param {string} [sessionId] Session ID (fallback)
55707
+ * @param {*} [options] Override http request option.
55708
+ * @throws {RequiredError}
55709
+ */
55710
+ v1SuggestionsQueriesGet(xStoreid: string, xStoresecret: string, xUserId?: string, xAnonId?: string, xSessionId?: string, query?: string, q?: string, hitsPerPage?: number, page?: number, analyticsTags?: string, tagsMatchMode?: V1SuggestionsQueriesGetTagsMatchModeEnum, includeCategories?: boolean, includeFacets?: boolean, includeDropdownRecommendations?: boolean, includeDropdownProductList?: boolean, includeFilteredTabs?: boolean, includeEmptyQueryRecommendations?: boolean, maxCategories?: number, maxFacets?: number, minPopularity?: number, timeRange?: V1SuggestionsQueriesGetTimeRangeEnum, disableTypoTolerance?: boolean, filteredTabs?: string, userId?: string, anonId?: string, sessionId?: string, options?: RawAxiosRequestConfig): AxiosPromise<QuerySuggestionsServiceQuerySuggestionsAPIResponse>;
55711
+ /**
55712
+ * Same as GET; use POST to send a JSON body (e.g. complex filtered_tabs). **Auth:** `x-storeid` and `x-storesecret`. Optional personalization headers: `x-user-id`, `x-anon-id`, `x-session-id`. Request body can include query, hitsPerPage, analytics_tags, include_categories, include_facets, filtered_tabs, etc.
55713
+ * @summary Get query suggestions (POST)
55714
+ * @param {string} xStoreid Store ID (from dashboard)
55715
+ * @param {string} xStoresecret Store read secret
55716
+ * @param {string} [xUserId] User ID for personalization
55717
+ * @param {string} [xAnonId] Anonymous user ID for personalization
55424
55718
  * @param {string} [xSessionId] Session ID for personalization
55425
- * @param {QuerySuggestionsServiceQuerySuggestionsRequest} [querySuggestionsServiceQuerySuggestionsRequest] Query suggestions request (query, hitsPerPage, page, analytics_tags, include_categories, include_facets, filtered_tabs, etc.)
55719
+ * @param {QuerySuggestionsServiceQuerySuggestionsRequest} [querySuggestionsServiceQuerySuggestionsRequest] Request (query, hitsPerPage, analytics_tags, filtered_tabs, etc.)
55426
55720
  * @param {*} [options] Override http request option.
55427
55721
  * @throws {RequiredError}
55428
55722
  */
@@ -55436,49 +55730,58 @@ export declare const QuerySuggestionsApiFactory: (configuration?: Configuration,
55436
55730
  */
55437
55731
  export declare class QuerySuggestionsApi extends BaseAPI {
55438
55732
  /**
55439
- * Retrieve configuration settings for query suggestions API including limits, supported time ranges, and default values
55440
- * @summary Get Query Suggestions Configuration
55441
- * @param {string} xStoreid Store ID
55442
- * @param {string} xStoresecret Store Secret
55733
+ * Returns limits, supported time ranges, and default values for the query suggestions API. **Auth:** `x-storeid` and `x-storesecret`.
55734
+ * @summary Get suggestions configuration
55735
+ * @param {string} xStoreid Store ID (from dashboard)
55736
+ * @param {string} xStoresecret Store read secret
55443
55737
  * @param {*} [options] Override http request option.
55444
55738
  * @throws {RequiredError}
55445
55739
  * @memberof QuerySuggestionsApi
55446
55740
  */
55447
55741
  v1SuggestionsConfigGet(xStoreid: string, xStoresecret: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<V1SuggestionsConfigGet200Response, any, {}>>;
55448
55742
  /**
55449
- * Retrieve query suggestions based on search analytics data with popularity ranking and optional category/facet enrichment. Supports partial query matching, analytics tags filtering, and configurable time ranges. Supports personalization via x-user-id, x-anon-id, x-session-id headers.
55450
- * @summary Get Query Suggestions
55451
- * @param {string} xStoreid Store ID
55452
- * @param {string} xStoresecret Store Secret
55453
- * @param {string} [xUserId] User ID for personalization (logged-in user)
55454
- * @param {string} [xAnonId] Anonymous ID for personalization (cookie/device ID)
55743
+ * Autocomplete suggestions for search, ranked by popularity. **Auth:** `x-storeid` and `x-storesecret` (from dashboard). Optional: `x-user-id`, `x-anon-id`, `x-session-id` for personalization. Supports partial query, filters (analytics_tags), time range (7d/30d/90d), categories, facets, and dropdown recommendations. Use `query` or `q` for the partial search string.
55744
+ * @summary Get query suggestions (GET)
55745
+ * @param {string} xStoreid Store ID (from dashboard)
55746
+ * @param {string} xStoresecret Store read secret
55747
+ * @param {string} [xUserId] User ID for personalization
55748
+ * @param {string} [xAnonId] Anonymous user ID for personalization
55455
55749
  * @param {string} [xSessionId] Session ID for personalization
55456
- * @param {string} [query] Partial query to get suggestions for
55457
- * @param {number} [hitsPerPage] Number of suggestions to return
55458
- * @param {number} [page] Page number for pagination
55459
- * @param {string} [analyticsTags] Comma-separated analytics tags to filter suggestions
55460
- * @param {V1SuggestionsQueriesGetTagsMatchModeEnum} [tagsMatchMode] How to match analytics tags
55461
- * @param {boolean} [includeCategories] Include category information in suggestions
55462
- * @param {boolean} [includeFacets] Include popular facets/filters information
55463
- * @param {number} [maxCategories] Maximum categories per suggestion
55464
- * @param {number} [maxFacets] Maximum facets per suggestion
55465
- * @param {number} [minPopularity] Minimum popularity threshold
55466
- * @param {V1SuggestionsQueriesGetTimeRangeEnum} [timeRange] Time range for analytics data
55467
- * @param {boolean} [disableTypoTolerance] Disable fuzzy/typo-tolerant matching
55750
+ * @param {string} [query] Partial query (use \&#39;query\&#39; or \&#39;q\&#39;)
55751
+ * @param {string} [q] Alias for query
55752
+ * @param {number} [hitsPerPage] Suggestions to return
55753
+ * @param {number} [page] Page for pagination
55754
+ * @param {string} [analyticsTags] Comma-separated tags to filter
55755
+ * @param {V1SuggestionsQueriesGetTagsMatchModeEnum} [tagsMatchMode] Match mode for tags
55756
+ * @param {boolean} [includeCategories] Include category in suggestions
55757
+ * @param {boolean} [includeFacets] Include facet info
55758
+ * @param {boolean} [includeDropdownRecommendations] Include dropdown recommendations
55759
+ * @param {boolean} [includeDropdownProductList] Include product list in dropdown
55760
+ * @param {boolean} [includeFilteredTabs] Include filtered tabs
55761
+ * @param {boolean} [includeEmptyQueryRecommendations] Popular suggestions when query empty
55762
+ * @param {number} [maxCategories] Max categories per suggestion
55763
+ * @param {number} [maxFacets] Max facets per suggestion
55764
+ * @param {number} [minPopularity] Min popularity
55765
+ * @param {V1SuggestionsQueriesGetTimeRangeEnum} [timeRange] Data time range
55766
+ * @param {boolean} [disableTypoTolerance] Disable fuzzy matching
55767
+ * @param {string} [filteredTabs] URL-encoded JSON array of tab configs
55768
+ * @param {string} [userId] User ID (fallback if header not set)
55769
+ * @param {string} [anonId] Anonymous ID (fallback)
55770
+ * @param {string} [sessionId] Session ID (fallback)
55468
55771
  * @param {*} [options] Override http request option.
55469
55772
  * @throws {RequiredError}
55470
55773
  * @memberof QuerySuggestionsApi
55471
55774
  */
55472
- v1SuggestionsQueriesGet(xStoreid: string, xStoresecret: string, xUserId?: string, xAnonId?: string, xSessionId?: string, query?: string, hitsPerPage?: number, page?: number, analyticsTags?: string, tagsMatchMode?: V1SuggestionsQueriesGetTagsMatchModeEnum, includeCategories?: boolean, includeFacets?: boolean, maxCategories?: number, maxFacets?: number, minPopularity?: number, timeRange?: V1SuggestionsQueriesGetTimeRangeEnum, disableTypoTolerance?: boolean, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<QuerySuggestionsServiceQuerySuggestionsAPIResponse, any, {}>>;
55775
+ v1SuggestionsQueriesGet(xStoreid: string, xStoresecret: string, xUserId?: string, xAnonId?: string, xSessionId?: string, query?: string, q?: string, hitsPerPage?: number, page?: number, analyticsTags?: string, tagsMatchMode?: V1SuggestionsQueriesGetTagsMatchModeEnum, includeCategories?: boolean, includeFacets?: boolean, includeDropdownRecommendations?: boolean, includeDropdownProductList?: boolean, includeFilteredTabs?: boolean, includeEmptyQueryRecommendations?: boolean, maxCategories?: number, maxFacets?: number, minPopularity?: number, timeRange?: V1SuggestionsQueriesGetTimeRangeEnum, disableTypoTolerance?: boolean, filteredTabs?: string, userId?: string, anonId?: string, sessionId?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<QuerySuggestionsServiceQuerySuggestionsAPIResponse, any, {}>>;
55473
55776
  /**
55474
- * Same as GET: retrieve query suggestions with optional body (query, hitsPerPage, analytics_tags, filtered_tabs, etc.). Use POST when sending filtered_tabs or larger payloads. Supports personalization via x-user-id, x-anon-id, x-session-id headers.
55475
- * @summary Post Query Suggestions
55476
- * @param {string} xStoreid Store ID
55477
- * @param {string} xStoresecret Store Secret
55478
- * @param {string} [xUserId] User ID for personalization (logged-in user)
55479
- * @param {string} [xAnonId] Anonymous ID for personalization (cookie/device ID)
55777
+ * Same as GET; use POST to send a JSON body (e.g. complex filtered_tabs). **Auth:** `x-storeid` and `x-storesecret`. Optional personalization headers: `x-user-id`, `x-anon-id`, `x-session-id`. Request body can include query, hitsPerPage, analytics_tags, include_categories, include_facets, filtered_tabs, etc.
55778
+ * @summary Get query suggestions (POST)
55779
+ * @param {string} xStoreid Store ID (from dashboard)
55780
+ * @param {string} xStoresecret Store read secret
55781
+ * @param {string} [xUserId] User ID for personalization
55782
+ * @param {string} [xAnonId] Anonymous user ID for personalization
55480
55783
  * @param {string} [xSessionId] Session ID for personalization
55481
- * @param {QuerySuggestionsServiceQuerySuggestionsRequest} [querySuggestionsServiceQuerySuggestionsRequest] Query suggestions request (query, hitsPerPage, page, analytics_tags, include_categories, include_facets, filtered_tabs, etc.)
55784
+ * @param {QuerySuggestionsServiceQuerySuggestionsRequest} [querySuggestionsServiceQuerySuggestionsRequest] Request (query, hitsPerPage, analytics_tags, filtered_tabs, etc.)
55482
55785
  * @param {*} [options] Override http request option.
55483
55786
  * @throws {RequiredError}
55484
55787
  * @memberof QuerySuggestionsApi
@@ -58017,34 +58320,34 @@ export declare class RolesApi extends BaseAPI {
58017
58320
  */
58018
58321
  export declare const SDKDocumentsApiAxiosParamCreator: (configuration?: Configuration) => {
58019
58322
  /**
58020
- * Performs bulk insert, update, upsert, or delete operations on documents using the public SDK API. Requires x-store-write-secret for authentication. Each document may specify its own action (insert, update, upsert, delete).
58021
- * @summary Bulk index documents (Public SDK API)
58022
- * @param {string} xStoreid Store ID
58023
- * @param {string} xStoreWriteSecret Store Write Secret (required for write operations)
58024
- * @param {string} xStoreID X-Store ID (must match x-storeid header)
58025
- * @param {DataTypesBulkDocumentRequest} dataTypesBulkDocumentRequest Bulk operation data
58323
+ * 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.
58324
+ * @summary Bulk index documents
58325
+ * @param {string} xStoreid Store ID (from dashboard)
58326
+ * @param {string} xStoreWriteSecret Store write secret
58327
+ * @param {string} xStoreID Store ID (must match x-storeid header)
58328
+ * @param {DataTypesBulkDocumentRequest} dataTypesBulkDocumentRequest List of operations
58026
58329
  * @param {*} [options] Override http request option.
58027
58330
  * @throws {RequiredError}
58028
58331
  */
58029
58332
  apiV1StoresXStoreIDDocumentsBulkPost: (xStoreid: string, xStoreWriteSecret: string, xStoreID: string, dataTypesBulkDocumentRequest: DataTypesBulkDocumentRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
58030
58333
  /**
58031
- * Deletes a document by ID from a store using the public SDK API. Requires x-store-write-secret for authentication.
58032
- * @summary Delete a document (Public SDK API)
58033
- * @param {string} xStoreid Store ID
58034
- * @param {string} xStoreWriteSecret Store Write Secret (required for write operations)
58035
- * @param {string} xStoreID X-Store ID (must match x-storeid header)
58334
+ * 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.
58335
+ * @summary Delete a document
58336
+ * @param {string} xStoreid Store ID (from dashboard)
58337
+ * @param {string} xStoreWriteSecret Store write secret
58338
+ * @param {string} xStoreID Store ID (must match x-storeid header)
58036
58339
  * @param {string} documentID Document ID to delete
58037
58340
  * @param {*} [options] Override http request option.
58038
58341
  * @throws {RequiredError}
58039
58342
  */
58040
58343
  apiV1StoresXStoreIDDocumentsDocumentIDDelete: (xStoreid: string, xStoreWriteSecret: string, xStoreID: string, documentID: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
58041
58344
  /**
58042
- * Indexes a new document into a store using the public SDK API. Requires x-store-write-secret for authentication. If ID is provided, it will be used; otherwise, a hash-based ID will be generated. If a document with the same hash already exists, it will be updated.
58043
- * @summary Index a single document (Public SDK API)
58044
- * @param {string} xStoreid Store ID
58045
- * @param {string} xStoreWriteSecret Store Write Secret (required for write operations)
58046
- * @param {string} xStoreID X-Store ID (must match x-storeid header)
58047
- * @param {DataTypesDocumentRequest} dataTypesDocumentRequest Document data
58345
+ * 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.
58346
+ * @summary Index a single document
58347
+ * @param {string} xStoreid Store ID (from dashboard)
58348
+ * @param {string} xStoreWriteSecret Store write secret
58349
+ * @param {string} xStoreID Store ID (must match x-storeid header)
58350
+ * @param {DataTypesDocumentRequest} dataTypesDocumentRequest Document fields to index
58048
58351
  * @param {*} [options] Override http request option.
58049
58352
  * @throws {RequiredError}
58050
58353
  */
@@ -58056,34 +58359,34 @@ export declare const SDKDocumentsApiAxiosParamCreator: (configuration?: Configur
58056
58359
  */
58057
58360
  export declare const SDKDocumentsApiFp: (configuration?: Configuration) => {
58058
58361
  /**
58059
- * Performs bulk insert, update, upsert, or delete operations on documents using the public SDK API. Requires x-store-write-secret for authentication. Each document may specify its own action (insert, update, upsert, delete).
58060
- * @summary Bulk index documents (Public SDK API)
58061
- * @param {string} xStoreid Store ID
58062
- * @param {string} xStoreWriteSecret Store Write Secret (required for write operations)
58063
- * @param {string} xStoreID X-Store ID (must match x-storeid header)
58064
- * @param {DataTypesBulkDocumentRequest} dataTypesBulkDocumentRequest Bulk operation data
58362
+ * 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.
58363
+ * @summary Bulk index documents
58364
+ * @param {string} xStoreid Store ID (from dashboard)
58365
+ * @param {string} xStoreWriteSecret Store write secret
58366
+ * @param {string} xStoreID Store ID (must match x-storeid header)
58367
+ * @param {DataTypesBulkDocumentRequest} dataTypesBulkDocumentRequest List of operations
58065
58368
  * @param {*} [options] Override http request option.
58066
58369
  * @throws {RequiredError}
58067
58370
  */
58068
58371
  apiV1StoresXStoreIDDocumentsBulkPost(xStoreid: string, xStoreWriteSecret: string, xStoreID: string, dataTypesBulkDocumentRequest: DataTypesBulkDocumentRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesBulkDocumentResponseWrapper>>;
58069
58372
  /**
58070
- * Deletes a document by ID from a store using the public SDK API. Requires x-store-write-secret for authentication.
58071
- * @summary Delete a document (Public SDK API)
58072
- * @param {string} xStoreid Store ID
58073
- * @param {string} xStoreWriteSecret Store Write Secret (required for write operations)
58074
- * @param {string} xStoreID X-Store ID (must match x-storeid header)
58373
+ * 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.
58374
+ * @summary Delete a document
58375
+ * @param {string} xStoreid Store ID (from dashboard)
58376
+ * @param {string} xStoreWriteSecret Store write secret
58377
+ * @param {string} xStoreID Store ID (must match x-storeid header)
58075
58378
  * @param {string} documentID Document ID to delete
58076
58379
  * @param {*} [options] Override http request option.
58077
58380
  * @throws {RequiredError}
58078
58381
  */
58079
58382
  apiV1StoresXStoreIDDocumentsDocumentIDDelete(xStoreid: string, xStoreWriteSecret: string, xStoreID: string, documentID: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesDocumentResponseWrapper>>;
58080
58383
  /**
58081
- * Indexes a new document into a store using the public SDK API. Requires x-store-write-secret for authentication. If ID is provided, it will be used; otherwise, a hash-based ID will be generated. If a document with the same hash already exists, it will be updated.
58082
- * @summary Index a single document (Public SDK API)
58083
- * @param {string} xStoreid Store ID
58084
- * @param {string} xStoreWriteSecret Store Write Secret (required for write operations)
58085
- * @param {string} xStoreID X-Store ID (must match x-storeid header)
58086
- * @param {DataTypesDocumentRequest} dataTypesDocumentRequest Document data
58384
+ * 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.
58385
+ * @summary Index a single document
58386
+ * @param {string} xStoreid Store ID (from dashboard)
58387
+ * @param {string} xStoreWriteSecret Store write secret
58388
+ * @param {string} xStoreID Store ID (must match x-storeid header)
58389
+ * @param {DataTypesDocumentRequest} dataTypesDocumentRequest Document fields to index
58087
58390
  * @param {*} [options] Override http request option.
58088
58391
  * @throws {RequiredError}
58089
58392
  */
@@ -58095,34 +58398,34 @@ export declare const SDKDocumentsApiFp: (configuration?: Configuration) => {
58095
58398
  */
58096
58399
  export declare const SDKDocumentsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
58097
58400
  /**
58098
- * Performs bulk insert, update, upsert, or delete operations on documents using the public SDK API. Requires x-store-write-secret for authentication. Each document may specify its own action (insert, update, upsert, delete).
58099
- * @summary Bulk index documents (Public SDK API)
58100
- * @param {string} xStoreid Store ID
58101
- * @param {string} xStoreWriteSecret Store Write Secret (required for write operations)
58102
- * @param {string} xStoreID X-Store ID (must match x-storeid header)
58103
- * @param {DataTypesBulkDocumentRequest} dataTypesBulkDocumentRequest Bulk operation data
58401
+ * 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.
58402
+ * @summary Bulk index documents
58403
+ * @param {string} xStoreid Store ID (from dashboard)
58404
+ * @param {string} xStoreWriteSecret Store write secret
58405
+ * @param {string} xStoreID Store ID (must match x-storeid header)
58406
+ * @param {DataTypesBulkDocumentRequest} dataTypesBulkDocumentRequest List of operations
58104
58407
  * @param {*} [options] Override http request option.
58105
58408
  * @throws {RequiredError}
58106
58409
  */
58107
58410
  apiV1StoresXStoreIDDocumentsBulkPost(xStoreid: string, xStoreWriteSecret: string, xStoreID: string, dataTypesBulkDocumentRequest: DataTypesBulkDocumentRequest, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesBulkDocumentResponseWrapper>;
58108
58411
  /**
58109
- * Deletes a document by ID from a store using the public SDK API. Requires x-store-write-secret for authentication.
58110
- * @summary Delete a document (Public SDK API)
58111
- * @param {string} xStoreid Store ID
58112
- * @param {string} xStoreWriteSecret Store Write Secret (required for write operations)
58113
- * @param {string} xStoreID X-Store ID (must match x-storeid header)
58412
+ * 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.
58413
+ * @summary Delete a document
58414
+ * @param {string} xStoreid Store ID (from dashboard)
58415
+ * @param {string} xStoreWriteSecret Store write secret
58416
+ * @param {string} xStoreID Store ID (must match x-storeid header)
58114
58417
  * @param {string} documentID Document ID to delete
58115
58418
  * @param {*} [options] Override http request option.
58116
58419
  * @throws {RequiredError}
58117
58420
  */
58118
58421
  apiV1StoresXStoreIDDocumentsDocumentIDDelete(xStoreid: string, xStoreWriteSecret: string, xStoreID: string, documentID: string, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesDocumentResponseWrapper>;
58119
58422
  /**
58120
- * Indexes a new document into a store using the public SDK API. Requires x-store-write-secret for authentication. If ID is provided, it will be used; otherwise, a hash-based ID will be generated. If a document with the same hash already exists, it will be updated.
58121
- * @summary Index a single document (Public SDK API)
58122
- * @param {string} xStoreid Store ID
58123
- * @param {string} xStoreWriteSecret Store Write Secret (required for write operations)
58124
- * @param {string} xStoreID X-Store ID (must match x-storeid header)
58125
- * @param {DataTypesDocumentRequest} dataTypesDocumentRequest Document data
58423
+ * 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.
58424
+ * @summary Index a single document
58425
+ * @param {string} xStoreid Store ID (from dashboard)
58426
+ * @param {string} xStoreWriteSecret Store write secret
58427
+ * @param {string} xStoreID Store ID (must match x-storeid header)
58428
+ * @param {DataTypesDocumentRequest} dataTypesDocumentRequest Document fields to index
58126
58429
  * @param {*} [options] Override http request option.
58127
58430
  * @throws {RequiredError}
58128
58431
  */
@@ -58136,23 +58439,23 @@ export declare const SDKDocumentsApiFactory: (configuration?: Configuration, bas
58136
58439
  */
58137
58440
  export declare class SDKDocumentsApi extends BaseAPI {
58138
58441
  /**
58139
- * Performs bulk insert, update, upsert, or delete operations on documents using the public SDK API. Requires x-store-write-secret for authentication. Each document may specify its own action (insert, update, upsert, delete).
58140
- * @summary Bulk index documents (Public SDK API)
58141
- * @param {string} xStoreid Store ID
58142
- * @param {string} xStoreWriteSecret Store Write Secret (required for write operations)
58143
- * @param {string} xStoreID X-Store ID (must match x-storeid header)
58144
- * @param {DataTypesBulkDocumentRequest} dataTypesBulkDocumentRequest Bulk operation data
58442
+ * 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.
58443
+ * @summary Bulk index documents
58444
+ * @param {string} xStoreid Store ID (from dashboard)
58445
+ * @param {string} xStoreWriteSecret Store write secret
58446
+ * @param {string} xStoreID Store ID (must match x-storeid header)
58447
+ * @param {DataTypesBulkDocumentRequest} dataTypesBulkDocumentRequest List of operations
58145
58448
  * @param {*} [options] Override http request option.
58146
58449
  * @throws {RequiredError}
58147
58450
  * @memberof SDKDocumentsApi
58148
58451
  */
58149
58452
  apiV1StoresXStoreIDDocumentsBulkPost(xStoreid: string, xStoreWriteSecret: string, xStoreID: string, dataTypesBulkDocumentRequest: DataTypesBulkDocumentRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesBulkDocumentResponseWrapper, any, {}>>;
58150
58453
  /**
58151
- * Deletes a document by ID from a store using the public SDK API. Requires x-store-write-secret for authentication.
58152
- * @summary Delete a document (Public SDK API)
58153
- * @param {string} xStoreid Store ID
58154
- * @param {string} xStoreWriteSecret Store Write Secret (required for write operations)
58155
- * @param {string} xStoreID X-Store ID (must match x-storeid header)
58454
+ * 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.
58455
+ * @summary Delete a document
58456
+ * @param {string} xStoreid Store ID (from dashboard)
58457
+ * @param {string} xStoreWriteSecret Store write secret
58458
+ * @param {string} xStoreID Store ID (must match x-storeid header)
58156
58459
  * @param {string} documentID Document ID to delete
58157
58460
  * @param {*} [options] Override http request option.
58158
58461
  * @throws {RequiredError}
@@ -58160,12 +58463,12 @@ export declare class SDKDocumentsApi extends BaseAPI {
58160
58463
  */
58161
58464
  apiV1StoresXStoreIDDocumentsDocumentIDDelete(xStoreid: string, xStoreWriteSecret: string, xStoreID: string, documentID: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesDocumentResponseWrapper, any, {}>>;
58162
58465
  /**
58163
- * Indexes a new document into a store using the public SDK API. Requires x-store-write-secret for authentication. If ID is provided, it will be used; otherwise, a hash-based ID will be generated. If a document with the same hash already exists, it will be updated.
58164
- * @summary Index a single document (Public SDK API)
58165
- * @param {string} xStoreid Store ID
58166
- * @param {string} xStoreWriteSecret Store Write Secret (required for write operations)
58167
- * @param {string} xStoreID X-Store ID (must match x-storeid header)
58168
- * @param {DataTypesDocumentRequest} dataTypesDocumentRequest Document data
58466
+ * 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.
58467
+ * @summary Index a single document
58468
+ * @param {string} xStoreid Store ID (from dashboard)
58469
+ * @param {string} xStoreWriteSecret Store write secret
58470
+ * @param {string} xStoreID Store ID (must match x-storeid header)
58471
+ * @param {DataTypesDocumentRequest} dataTypesDocumentRequest Document fields to index
58169
58472
  * @param {*} [options] Override http request option.
58170
58473
  * @throws {RequiredError}
58171
58474
  * @memberof SDKDocumentsApi
@@ -58178,22 +58481,22 @@ export declare class SDKDocumentsApi extends BaseAPI {
58178
58481
  */
58179
58482
  export declare const SDKQuerySuggestionsConfigApiAxiosParamCreator: (configuration?: Configuration) => {
58180
58483
  /**
58181
- * Retrieves the store-specific query suggestions configuration using x-store ID and read secret. This is a public API for SDK integration, similar to Algolia\'s GET /1/configs/{configID} endpoint. Uses read secret (x-storesecret).
58182
- * @summary Get Query Suggestions Config (Public SDK API)
58183
- * @param {string} xStoreid Store ID
58184
- * @param {string} xStoresecret Store Read Secret (for read operations)
58185
- * @param {string} xStoreID X-Store ID (must match x-storeid header)
58484
+ * Returns autocomplete/suggestions configuration for the store. **Auth:** `x-storeid` and `x-storesecret`. Path `xStoreID` must match the `x-storeid` header.
58485
+ * @summary Get query suggestions configuration
58486
+ * @param {string} xStoreid Store ID (from dashboard)
58487
+ * @param {string} xStoresecret Store read secret
58488
+ * @param {string} xStoreID Store ID (must match x-storeid header)
58186
58489
  * @param {*} [options] Override http request option.
58187
58490
  * @throws {RequiredError}
58188
58491
  */
58189
58492
  apiV1StoresXStoreIDQuerySuggestionsConfigGet: (xStoreid: string, xStoresecret: string, xStoreID: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
58190
58493
  /**
58191
- * Updates the store-specific query suggestions configuration using x-store ID and write secret. Supports partial updates. This is a public API for SDK integration, similar to Algolia\'s PUT /1/configs/{configID} endpoint. Requires write secret (x-store-write-secret).
58192
- * @summary Update Query Suggestions Config (Public SDK API)
58193
- * @param {string} xStoreid Store ID
58194
- * @param {string} xStoreWriteSecret Store Write Secret (required for write operations)
58195
- * @param {string} xStoreID X-Store ID (must match x-storeid header)
58196
- * @param {QuerySuggestionsServiceUpdateSuggestionConfigRequest} querySuggestionsServiceUpdateSuggestionConfigRequest Query suggestions configuration (partial updates supported)
58494
+ * 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.
58495
+ * @summary Update query suggestions configuration
58496
+ * @param {string} xStoreid Store ID (from dashboard)
58497
+ * @param {string} xStoreWriteSecret Store write secret
58498
+ * @param {string} xStoreID Store ID (must match x-storeid header)
58499
+ * @param {QuerySuggestionsServiceUpdateSuggestionConfigRequest} querySuggestionsServiceUpdateSuggestionConfigRequest Fields to update (partial)
58197
58500
  * @param {*} [options] Override http request option.
58198
58501
  * @throws {RequiredError}
58199
58502
  */
@@ -58205,22 +58508,22 @@ export declare const SDKQuerySuggestionsConfigApiAxiosParamCreator: (configurati
58205
58508
  */
58206
58509
  export declare const SDKQuerySuggestionsConfigApiFp: (configuration?: Configuration) => {
58207
58510
  /**
58208
- * Retrieves the store-specific query suggestions configuration using x-store ID and read secret. This is a public API for SDK integration, similar to Algolia\'s GET /1/configs/{configID} endpoint. Uses read secret (x-storesecret).
58209
- * @summary Get Query Suggestions Config (Public SDK API)
58210
- * @param {string} xStoreid Store ID
58211
- * @param {string} xStoresecret Store Read Secret (for read operations)
58212
- * @param {string} xStoreID X-Store ID (must match x-storeid header)
58511
+ * Returns autocomplete/suggestions configuration for the store. **Auth:** `x-storeid` and `x-storesecret`. Path `xStoreID` must match the `x-storeid` header.
58512
+ * @summary Get query suggestions configuration
58513
+ * @param {string} xStoreid Store ID (from dashboard)
58514
+ * @param {string} xStoresecret Store read secret
58515
+ * @param {string} xStoreID Store ID (must match x-storeid header)
58213
58516
  * @param {*} [options] Override http request option.
58214
58517
  * @throws {RequiredError}
58215
58518
  */
58216
58519
  apiV1StoresXStoreIDQuerySuggestionsConfigGet(xStoreid: string, xStoresecret: string, xStoreID: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<QuerySuggestionsServiceQuerySuggestionsAPIResponse>>;
58217
58520
  /**
58218
- * Updates the store-specific query suggestions configuration using x-store ID and write secret. Supports partial updates. This is a public API for SDK integration, similar to Algolia\'s PUT /1/configs/{configID} endpoint. Requires write secret (x-store-write-secret).
58219
- * @summary Update Query Suggestions Config (Public SDK API)
58220
- * @param {string} xStoreid Store ID
58221
- * @param {string} xStoreWriteSecret Store Write Secret (required for write operations)
58222
- * @param {string} xStoreID X-Store ID (must match x-storeid header)
58223
- * @param {QuerySuggestionsServiceUpdateSuggestionConfigRequest} querySuggestionsServiceUpdateSuggestionConfigRequest Query suggestions configuration (partial updates supported)
58521
+ * 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.
58522
+ * @summary Update query suggestions configuration
58523
+ * @param {string} xStoreid Store ID (from dashboard)
58524
+ * @param {string} xStoreWriteSecret Store write secret
58525
+ * @param {string} xStoreID Store ID (must match x-storeid header)
58526
+ * @param {QuerySuggestionsServiceUpdateSuggestionConfigRequest} querySuggestionsServiceUpdateSuggestionConfigRequest Fields to update (partial)
58224
58527
  * @param {*} [options] Override http request option.
58225
58528
  * @throws {RequiredError}
58226
58529
  */
@@ -58232,22 +58535,22 @@ export declare const SDKQuerySuggestionsConfigApiFp: (configuration?: Configurat
58232
58535
  */
58233
58536
  export declare const SDKQuerySuggestionsConfigApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
58234
58537
  /**
58235
- * Retrieves the store-specific query suggestions configuration using x-store ID and read secret. This is a public API for SDK integration, similar to Algolia\'s GET /1/configs/{configID} endpoint. Uses read secret (x-storesecret).
58236
- * @summary Get Query Suggestions Config (Public SDK API)
58237
- * @param {string} xStoreid Store ID
58238
- * @param {string} xStoresecret Store Read Secret (for read operations)
58239
- * @param {string} xStoreID X-Store ID (must match x-storeid header)
58538
+ * Returns autocomplete/suggestions configuration for the store. **Auth:** `x-storeid` and `x-storesecret`. Path `xStoreID` must match the `x-storeid` header.
58539
+ * @summary Get query suggestions configuration
58540
+ * @param {string} xStoreid Store ID (from dashboard)
58541
+ * @param {string} xStoresecret Store read secret
58542
+ * @param {string} xStoreID Store ID (must match x-storeid header)
58240
58543
  * @param {*} [options] Override http request option.
58241
58544
  * @throws {RequiredError}
58242
58545
  */
58243
58546
  apiV1StoresXStoreIDQuerySuggestionsConfigGet(xStoreid: string, xStoresecret: string, xStoreID: string, options?: RawAxiosRequestConfig): AxiosPromise<QuerySuggestionsServiceQuerySuggestionsAPIResponse>;
58244
58547
  /**
58245
- * Updates the store-specific query suggestions configuration using x-store ID and write secret. Supports partial updates. This is a public API for SDK integration, similar to Algolia\'s PUT /1/configs/{configID} endpoint. Requires write secret (x-store-write-secret).
58246
- * @summary Update Query Suggestions Config (Public SDK API)
58247
- * @param {string} xStoreid Store ID
58248
- * @param {string} xStoreWriteSecret Store Write Secret (required for write operations)
58249
- * @param {string} xStoreID X-Store ID (must match x-storeid header)
58250
- * @param {QuerySuggestionsServiceUpdateSuggestionConfigRequest} querySuggestionsServiceUpdateSuggestionConfigRequest Query suggestions configuration (partial updates supported)
58548
+ * 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.
58549
+ * @summary Update query suggestions configuration
58550
+ * @param {string} xStoreid Store ID (from dashboard)
58551
+ * @param {string} xStoreWriteSecret Store write secret
58552
+ * @param {string} xStoreID Store ID (must match x-storeid header)
58553
+ * @param {QuerySuggestionsServiceUpdateSuggestionConfigRequest} querySuggestionsServiceUpdateSuggestionConfigRequest Fields to update (partial)
58251
58554
  * @param {*} [options] Override http request option.
58252
58555
  * @throws {RequiredError}
58253
58556
  */
@@ -58261,23 +58564,23 @@ export declare const SDKQuerySuggestionsConfigApiFactory: (configuration?: Confi
58261
58564
  */
58262
58565
  export declare class SDKQuerySuggestionsConfigApi extends BaseAPI {
58263
58566
  /**
58264
- * Retrieves the store-specific query suggestions configuration using x-store ID and read secret. This is a public API for SDK integration, similar to Algolia\'s GET /1/configs/{configID} endpoint. Uses read secret (x-storesecret).
58265
- * @summary Get Query Suggestions Config (Public SDK API)
58266
- * @param {string} xStoreid Store ID
58267
- * @param {string} xStoresecret Store Read Secret (for read operations)
58268
- * @param {string} xStoreID X-Store ID (must match x-storeid header)
58567
+ * Returns autocomplete/suggestions configuration for the store. **Auth:** `x-storeid` and `x-storesecret`. Path `xStoreID` must match the `x-storeid` header.
58568
+ * @summary Get query suggestions configuration
58569
+ * @param {string} xStoreid Store ID (from dashboard)
58570
+ * @param {string} xStoresecret Store read secret
58571
+ * @param {string} xStoreID Store ID (must match x-storeid header)
58269
58572
  * @param {*} [options] Override http request option.
58270
58573
  * @throws {RequiredError}
58271
58574
  * @memberof SDKQuerySuggestionsConfigApi
58272
58575
  */
58273
58576
  apiV1StoresXStoreIDQuerySuggestionsConfigGet(xStoreid: string, xStoresecret: string, xStoreID: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<QuerySuggestionsServiceQuerySuggestionsAPIResponse, any, {}>>;
58274
58577
  /**
58275
- * Updates the store-specific query suggestions configuration using x-store ID and write secret. Supports partial updates. This is a public API for SDK integration, similar to Algolia\'s PUT /1/configs/{configID} endpoint. Requires write secret (x-store-write-secret).
58276
- * @summary Update Query Suggestions Config (Public SDK API)
58277
- * @param {string} xStoreid Store ID
58278
- * @param {string} xStoreWriteSecret Store Write Secret (required for write operations)
58279
- * @param {string} xStoreID X-Store ID (must match x-storeid header)
58280
- * @param {QuerySuggestionsServiceUpdateSuggestionConfigRequest} querySuggestionsServiceUpdateSuggestionConfigRequest Query suggestions configuration (partial updates supported)
58578
+ * 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.
58579
+ * @summary Update query suggestions configuration
58580
+ * @param {string} xStoreid Store ID (from dashboard)
58581
+ * @param {string} xStoreWriteSecret Store write secret
58582
+ * @param {string} xStoreID Store ID (must match x-storeid header)
58583
+ * @param {QuerySuggestionsServiceUpdateSuggestionConfigRequest} querySuggestionsServiceUpdateSuggestionConfigRequest Fields to update (partial)
58281
58584
  * @param {*} [options] Override http request option.
58282
58585
  * @throws {RequiredError}
58283
58586
  * @memberof SDKQuerySuggestionsConfigApi
@@ -58290,32 +58593,32 @@ export declare class SDKQuerySuggestionsConfigApi extends BaseAPI {
58290
58593
  */
58291
58594
  export declare const SDKSchemaApiAxiosParamCreator: (configuration?: Configuration) => {
58292
58595
  /**
58293
- * Deletes all documents from a store\'s collection without deleting the collection itself. Requires x-store-write-secret for authentication.
58294
- * @summary Clear All Documents (Public SDK API)
58295
- * @param {string} xStoreid Store ID
58296
- * @param {string} xStoreWriteSecret Store Write Secret
58297
- * @param {string} xStoreID X-Store ID (must match x-storeid header)
58596
+ * 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.
58597
+ * @summary Clear all documents
58598
+ * @param {string} xStoreid Store ID (from dashboard)
58599
+ * @param {string} xStoreWriteSecret Store write secret
58600
+ * @param {string} xStoreID Store ID (must match x-storeid header)
58298
58601
  * @param {*} [options] Override http request option.
58299
58602
  * @throws {RequiredError}
58300
58603
  */
58301
58604
  apiV1StoresXStoreIDDocumentsDelete: (xStoreid: string, xStoreWriteSecret: string, xStoreID: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
58302
58605
  /**
58303
- * Retrieves the current collection schema for a store. Requires x-storesecret (read secret) for authentication.
58304
- * @summary Get Collection Schema (Public SDK API)
58305
- * @param {string} xStoreid Store ID
58306
- * @param {string} xStoresecret Store Read Secret
58307
- * @param {string} xStoreID X-Store ID (must match x-storeid header)
58606
+ * 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.
58607
+ * @summary Get index schema
58608
+ * @param {string} xStoreid Store ID (from dashboard)
58609
+ * @param {string} xStoresecret Store read secret
58610
+ * @param {string} xStoreID Store ID (must match x-storeid header)
58308
58611
  * @param {*} [options] Override http request option.
58309
58612
  * @throws {RequiredError}
58310
58613
  */
58311
58614
  apiV1StoresXStoreIDSchemaGet: (xStoreid: string, xStoresecret: string, xStoreID: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
58312
58615
  /**
58313
- * Creates a new collection schema or updates an existing one. Mode can be \'additive\' (add new fields, preserve data) or \'replace\' (delete and recreate collection). Requires x-store-write-secret for authentication.
58314
- * @summary Create or Update Collection Schema (Public SDK API)
58315
- * @param {string} xStoreid Store ID
58316
- * @param {string} xStoreWriteSecret Store Write Secret
58317
- * @param {string} xStoreID X-Store ID (must match x-storeid header)
58318
- * @param {DataTypesCollectionSchemaRequest} dataTypesCollectionSchemaRequest Schema request
58616
+ * 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.
58617
+ * @summary Create or update index schema
58618
+ * @param {string} xStoreid Store ID (from dashboard)
58619
+ * @param {string} xStoreWriteSecret Store write secret
58620
+ * @param {string} xStoreID Store ID (must match x-storeid header)
58621
+ * @param {DataTypesCollectionSchemaRequest} dataTypesCollectionSchemaRequest Schema definition and mode
58319
58622
  * @param {*} [options] Override http request option.
58320
58623
  * @throws {RequiredError}
58321
58624
  */
@@ -58327,32 +58630,32 @@ export declare const SDKSchemaApiAxiosParamCreator: (configuration?: Configurati
58327
58630
  */
58328
58631
  export declare const SDKSchemaApiFp: (configuration?: Configuration) => {
58329
58632
  /**
58330
- * Deletes all documents from a store\'s collection without deleting the collection itself. Requires x-store-write-secret for authentication.
58331
- * @summary Clear All Documents (Public SDK API)
58332
- * @param {string} xStoreid Store ID
58333
- * @param {string} xStoreWriteSecret Store Write Secret
58334
- * @param {string} xStoreID X-Store ID (must match x-storeid header)
58633
+ * 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.
58634
+ * @summary Clear all documents
58635
+ * @param {string} xStoreid Store ID (from dashboard)
58636
+ * @param {string} xStoreWriteSecret Store write secret
58637
+ * @param {string} xStoreID Store ID (must match x-storeid header)
58335
58638
  * @param {*} [options] Override http request option.
58336
58639
  * @throws {RequiredError}
58337
58640
  */
58338
58641
  apiV1StoresXStoreIDDocumentsDelete(xStoreid: string, xStoreWriteSecret: string, xStoreID: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesClearDocumentsResponseWrapper>>;
58339
58642
  /**
58340
- * Retrieves the current collection schema for a store. Requires x-storesecret (read secret) for authentication.
58341
- * @summary Get Collection Schema (Public SDK API)
58342
- * @param {string} xStoreid Store ID
58343
- * @param {string} xStoresecret Store Read Secret
58344
- * @param {string} xStoreID X-Store ID (must match x-storeid header)
58643
+ * 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.
58644
+ * @summary Get index schema
58645
+ * @param {string} xStoreid Store ID (from dashboard)
58646
+ * @param {string} xStoresecret Store read secret
58647
+ * @param {string} xStoreID Store ID (must match x-storeid header)
58345
58648
  * @param {*} [options] Override http request option.
58346
58649
  * @throws {RequiredError}
58347
58650
  */
58348
58651
  apiV1StoresXStoreIDSchemaGet(xStoreid: string, xStoresecret: string, xStoreID: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesSchemaResponseWrapper>>;
58349
58652
  /**
58350
- * Creates a new collection schema or updates an existing one. Mode can be \'additive\' (add new fields, preserve data) or \'replace\' (delete and recreate collection). Requires x-store-write-secret for authentication.
58351
- * @summary Create or Update Collection Schema (Public SDK API)
58352
- * @param {string} xStoreid Store ID
58353
- * @param {string} xStoreWriteSecret Store Write Secret
58354
- * @param {string} xStoreID X-Store ID (must match x-storeid header)
58355
- * @param {DataTypesCollectionSchemaRequest} dataTypesCollectionSchemaRequest Schema request
58653
+ * 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.
58654
+ * @summary Create or update index schema
58655
+ * @param {string} xStoreid Store ID (from dashboard)
58656
+ * @param {string} xStoreWriteSecret Store write secret
58657
+ * @param {string} xStoreID Store ID (must match x-storeid header)
58658
+ * @param {DataTypesCollectionSchemaRequest} dataTypesCollectionSchemaRequest Schema definition and mode
58356
58659
  * @param {*} [options] Override http request option.
58357
58660
  * @throws {RequiredError}
58358
58661
  */
@@ -58364,32 +58667,32 @@ export declare const SDKSchemaApiFp: (configuration?: Configuration) => {
58364
58667
  */
58365
58668
  export declare const SDKSchemaApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
58366
58669
  /**
58367
- * Deletes all documents from a store\'s collection without deleting the collection itself. Requires x-store-write-secret for authentication.
58368
- * @summary Clear All Documents (Public SDK API)
58369
- * @param {string} xStoreid Store ID
58370
- * @param {string} xStoreWriteSecret Store Write Secret
58371
- * @param {string} xStoreID X-Store ID (must match x-storeid header)
58670
+ * 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.
58671
+ * @summary Clear all documents
58672
+ * @param {string} xStoreid Store ID (from dashboard)
58673
+ * @param {string} xStoreWriteSecret Store write secret
58674
+ * @param {string} xStoreID Store ID (must match x-storeid header)
58372
58675
  * @param {*} [options] Override http request option.
58373
58676
  * @throws {RequiredError}
58374
58677
  */
58375
58678
  apiV1StoresXStoreIDDocumentsDelete(xStoreid: string, xStoreWriteSecret: string, xStoreID: string, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesClearDocumentsResponseWrapper>;
58376
58679
  /**
58377
- * Retrieves the current collection schema for a store. Requires x-storesecret (read secret) for authentication.
58378
- * @summary Get Collection Schema (Public SDK API)
58379
- * @param {string} xStoreid Store ID
58380
- * @param {string} xStoresecret Store Read Secret
58381
- * @param {string} xStoreID X-Store ID (must match x-storeid header)
58680
+ * 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.
58681
+ * @summary Get index schema
58682
+ * @param {string} xStoreid Store ID (from dashboard)
58683
+ * @param {string} xStoresecret Store read secret
58684
+ * @param {string} xStoreID Store ID (must match x-storeid header)
58382
58685
  * @param {*} [options] Override http request option.
58383
58686
  * @throws {RequiredError}
58384
58687
  */
58385
58688
  apiV1StoresXStoreIDSchemaGet(xStoreid: string, xStoresecret: string, xStoreID: string, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesSchemaResponseWrapper>;
58386
58689
  /**
58387
- * Creates a new collection schema or updates an existing one. Mode can be \'additive\' (add new fields, preserve data) or \'replace\' (delete and recreate collection). Requires x-store-write-secret for authentication.
58388
- * @summary Create or Update Collection Schema (Public SDK API)
58389
- * @param {string} xStoreid Store ID
58390
- * @param {string} xStoreWriteSecret Store Write Secret
58391
- * @param {string} xStoreID X-Store ID (must match x-storeid header)
58392
- * @param {DataTypesCollectionSchemaRequest} dataTypesCollectionSchemaRequest Schema request
58690
+ * 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.
58691
+ * @summary Create or update index schema
58692
+ * @param {string} xStoreid Store ID (from dashboard)
58693
+ * @param {string} xStoreWriteSecret Store write secret
58694
+ * @param {string} xStoreID Store ID (must match x-storeid header)
58695
+ * @param {DataTypesCollectionSchemaRequest} dataTypesCollectionSchemaRequest Schema definition and mode
58393
58696
  * @param {*} [options] Override http request option.
58394
58697
  * @throws {RequiredError}
58395
58698
  */
@@ -58403,34 +58706,34 @@ export declare const SDKSchemaApiFactory: (configuration?: Configuration, basePa
58403
58706
  */
58404
58707
  export declare class SDKSchemaApi extends BaseAPI {
58405
58708
  /**
58406
- * Deletes all documents from a store\'s collection without deleting the collection itself. Requires x-store-write-secret for authentication.
58407
- * @summary Clear All Documents (Public SDK API)
58408
- * @param {string} xStoreid Store ID
58409
- * @param {string} xStoreWriteSecret Store Write Secret
58410
- * @param {string} xStoreID X-Store ID (must match x-storeid header)
58709
+ * 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.
58710
+ * @summary Clear all documents
58711
+ * @param {string} xStoreid Store ID (from dashboard)
58712
+ * @param {string} xStoreWriteSecret Store write secret
58713
+ * @param {string} xStoreID Store ID (must match x-storeid header)
58411
58714
  * @param {*} [options] Override http request option.
58412
58715
  * @throws {RequiredError}
58413
58716
  * @memberof SDKSchemaApi
58414
58717
  */
58415
58718
  apiV1StoresXStoreIDDocumentsDelete(xStoreid: string, xStoreWriteSecret: string, xStoreID: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesClearDocumentsResponseWrapper, any, {}>>;
58416
58719
  /**
58417
- * Retrieves the current collection schema for a store. Requires x-storesecret (read secret) for authentication.
58418
- * @summary Get Collection Schema (Public SDK API)
58419
- * @param {string} xStoreid Store ID
58420
- * @param {string} xStoresecret Store Read Secret
58421
- * @param {string} xStoreID X-Store ID (must match x-storeid header)
58720
+ * 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.
58721
+ * @summary Get index schema
58722
+ * @param {string} xStoreid Store ID (from dashboard)
58723
+ * @param {string} xStoresecret Store read secret
58724
+ * @param {string} xStoreID Store ID (must match x-storeid header)
58422
58725
  * @param {*} [options] Override http request option.
58423
58726
  * @throws {RequiredError}
58424
58727
  * @memberof SDKSchemaApi
58425
58728
  */
58426
58729
  apiV1StoresXStoreIDSchemaGet(xStoreid: string, xStoresecret: string, xStoreID: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesSchemaResponseWrapper, any, {}>>;
58427
58730
  /**
58428
- * Creates a new collection schema or updates an existing one. Mode can be \'additive\' (add new fields, preserve data) or \'replace\' (delete and recreate collection). Requires x-store-write-secret for authentication.
58429
- * @summary Create or Update Collection Schema (Public SDK API)
58430
- * @param {string} xStoreid Store ID
58431
- * @param {string} xStoreWriteSecret Store Write Secret
58432
- * @param {string} xStoreID X-Store ID (must match x-storeid header)
58433
- * @param {DataTypesCollectionSchemaRequest} dataTypesCollectionSchemaRequest Schema request
58731
+ * 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.
58732
+ * @summary Create or update index schema
58733
+ * @param {string} xStoreid Store ID (from dashboard)
58734
+ * @param {string} xStoreWriteSecret Store write secret
58735
+ * @param {string} xStoreID Store ID (must match x-storeid header)
58736
+ * @param {DataTypesCollectionSchemaRequest} dataTypesCollectionSchemaRequest Schema definition and mode
58434
58737
  * @param {*} [options] Override http request option.
58435
58738
  * @throws {RequiredError}
58436
58739
  * @memberof SDKSchemaApi
@@ -58443,32 +58746,32 @@ export declare class SDKSchemaApi extends BaseAPI {
58443
58746
  */
58444
58747
  export declare const SDKStoreConfigApiAxiosParamCreator: (configuration?: Configuration) => {
58445
58748
  /**
58446
- * Retrieves the store configuration (search config and query suggestions config) using x-store ID and read secret. This is a public API for SDK integration. Uses read secret (x-storesecret). Includes both search configuration and query suggestions configuration in a single response.
58447
- * @summary Get Store Config (Public SDK API)
58448
- * @param {string} xStoreid Store ID
58449
- * @param {string} xStoresecret Store Read Secret (for read operations)
58450
- * @param {string} xStoreID X-Store ID (must match x-storeid header)
58749
+ * Returns search and query-suggestions configuration for the store. **Auth:** `x-storeid` and `x-storesecret`. Path `xStoreID` must match the `x-storeid` header.
58750
+ * @summary Get store configuration
58751
+ * @param {string} xStoreid Store ID (from dashboard)
58752
+ * @param {string} xStoresecret Store read secret
58753
+ * @param {string} xStoreID Store ID (must match x-storeid header)
58451
58754
  * @param {*} [options] Override http request option.
58452
58755
  * @throws {RequiredError}
58453
58756
  */
58454
58757
  apiV1StoresXStoreIDConfigGet: (xStoreid: string, xStoresecret: string, xStoreID: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
58455
58758
  /**
58456
- * Updates the store configuration using x-store ID and write secret. Supports partial updates. This is a public API for SDK integration. Requires write secret for security.
58457
- * @summary Update Store Config (Public SDK API)
58458
- * @param {string} xStoreid Store ID
58459
- * @param {string} xStoreWriteSecret Store Write Secret (required for write operations)
58460
- * @param {string} xStoreID X-Store ID (must match x-storeid header)
58461
- * @param {DataTypesIndexConfig} dataTypesIndexConfig Store configuration (partial updates supported)
58759
+ * Update search and store settings. Partial updates supported. **Auth:** `x-storeid` and `x-store-write-secret`. Path `xStoreID` must match the `x-storeid` header.
58760
+ * @summary Update store configuration
58761
+ * @param {string} xStoreid Store ID (from dashboard)
58762
+ * @param {string} xStoreWriteSecret Store write secret
58763
+ * @param {string} xStoreID Store ID (must match x-storeid header)
58764
+ * @param {DataTypesIndexConfig} dataTypesIndexConfig Fields to update (partial)
58462
58765
  * @param {*} [options] Override http request option.
58463
58766
  * @throws {RequiredError}
58464
58767
  */
58465
58768
  apiV1StoresXStoreIDConfigPut: (xStoreid: string, xStoreWriteSecret: string, xStoreID: string, dataTypesIndexConfig: DataTypesIndexConfig, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
58466
58769
  /**
58467
- * Get metadata about all configurable fields for store configuration. This is a public API for SDK integration.
58468
- * @summary Get Store Config Schema (Public SDK API)
58469
- * @param {string} xStoreid Store ID
58470
- * @param {string} xStoresecret Store Secret
58471
- * @param {string} xStoreID X-Store ID (must match x-storeid header)
58770
+ * Returns metadata for all configurable store fields (types, defaults, validation). **Auth:** `x-storeid` and `x-storesecret`. Path `xStoreID` must match the `x-storeid` header.
58771
+ * @summary Get store config schema
58772
+ * @param {string} xStoreid Store ID (from dashboard)
58773
+ * @param {string} xStoresecret Store read secret
58774
+ * @param {string} xStoreID Store ID (must match x-storeid header)
58472
58775
  * @param {*} [options] Override http request option.
58473
58776
  * @throws {RequiredError}
58474
58777
  */
@@ -58480,32 +58783,32 @@ export declare const SDKStoreConfigApiAxiosParamCreator: (configuration?: Config
58480
58783
  */
58481
58784
  export declare const SDKStoreConfigApiFp: (configuration?: Configuration) => {
58482
58785
  /**
58483
- * Retrieves the store configuration (search config and query suggestions config) using x-store ID and read secret. This is a public API for SDK integration. Uses read secret (x-storesecret). Includes both search configuration and query suggestions configuration in a single response.
58484
- * @summary Get Store Config (Public SDK API)
58485
- * @param {string} xStoreid Store ID
58486
- * @param {string} xStoresecret Store Read Secret (for read operations)
58487
- * @param {string} xStoreID X-Store ID (must match x-storeid header)
58786
+ * Returns search and query-suggestions configuration for the store. **Auth:** `x-storeid` and `x-storesecret`. Path `xStoreID` must match the `x-storeid` header.
58787
+ * @summary Get store configuration
58788
+ * @param {string} xStoreid Store ID (from dashboard)
58789
+ * @param {string} xStoresecret Store read secret
58790
+ * @param {string} xStoreID Store ID (must match x-storeid header)
58488
58791
  * @param {*} [options] Override http request option.
58489
58792
  * @throws {RequiredError}
58490
58793
  */
58491
58794
  apiV1StoresXStoreIDConfigGet(xStoreid: string, xStoresecret: string, xStoreID: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesGenericResponseDataTypesStoreConfigWithOnboardingResponse>>;
58492
58795
  /**
58493
- * Updates the store configuration using x-store ID and write secret. Supports partial updates. This is a public API for SDK integration. Requires write secret for security.
58494
- * @summary Update Store Config (Public SDK API)
58495
- * @param {string} xStoreid Store ID
58496
- * @param {string} xStoreWriteSecret Store Write Secret (required for write operations)
58497
- * @param {string} xStoreID X-Store ID (must match x-storeid header)
58498
- * @param {DataTypesIndexConfig} dataTypesIndexConfig Store configuration (partial updates supported)
58796
+ * Update search and store settings. Partial updates supported. **Auth:** `x-storeid` and `x-store-write-secret`. Path `xStoreID` must match the `x-storeid` header.
58797
+ * @summary Update store configuration
58798
+ * @param {string} xStoreid Store ID (from dashboard)
58799
+ * @param {string} xStoreWriteSecret Store write secret
58800
+ * @param {string} xStoreID Store ID (must match x-storeid header)
58801
+ * @param {DataTypesIndexConfig} dataTypesIndexConfig Fields to update (partial)
58499
58802
  * @param {*} [options] Override http request option.
58500
58803
  * @throws {RequiredError}
58501
58804
  */
58502
58805
  apiV1StoresXStoreIDConfigPut(xStoreid: string, xStoreWriteSecret: string, xStoreID: string, dataTypesIndexConfig: DataTypesIndexConfig, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesIndexConfigResponseWrapper>>;
58503
58806
  /**
58504
- * Get metadata about all configurable fields for store configuration. This is a public API for SDK integration.
58505
- * @summary Get Store Config Schema (Public SDK API)
58506
- * @param {string} xStoreid Store ID
58507
- * @param {string} xStoresecret Store Secret
58508
- * @param {string} xStoreID X-Store ID (must match x-storeid header)
58807
+ * Returns metadata for all configurable store fields (types, defaults, validation). **Auth:** `x-storeid` and `x-storesecret`. Path `xStoreID` must match the `x-storeid` header.
58808
+ * @summary Get store config schema
58809
+ * @param {string} xStoreid Store ID (from dashboard)
58810
+ * @param {string} xStoresecret Store read secret
58811
+ * @param {string} xStoreID Store ID (must match x-storeid header)
58509
58812
  * @param {*} [options] Override http request option.
58510
58813
  * @throws {RequiredError}
58511
58814
  */
@@ -58517,32 +58820,32 @@ export declare const SDKStoreConfigApiFp: (configuration?: Configuration) => {
58517
58820
  */
58518
58821
  export declare const SDKStoreConfigApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
58519
58822
  /**
58520
- * Retrieves the store configuration (search config and query suggestions config) using x-store ID and read secret. This is a public API for SDK integration. Uses read secret (x-storesecret). Includes both search configuration and query suggestions configuration in a single response.
58521
- * @summary Get Store Config (Public SDK API)
58522
- * @param {string} xStoreid Store ID
58523
- * @param {string} xStoresecret Store Read Secret (for read operations)
58524
- * @param {string} xStoreID X-Store ID (must match x-storeid header)
58823
+ * Returns search and query-suggestions configuration for the store. **Auth:** `x-storeid` and `x-storesecret`. Path `xStoreID` must match the `x-storeid` header.
58824
+ * @summary Get store configuration
58825
+ * @param {string} xStoreid Store ID (from dashboard)
58826
+ * @param {string} xStoresecret Store read secret
58827
+ * @param {string} xStoreID Store ID (must match x-storeid header)
58525
58828
  * @param {*} [options] Override http request option.
58526
58829
  * @throws {RequiredError}
58527
58830
  */
58528
58831
  apiV1StoresXStoreIDConfigGet(xStoreid: string, xStoresecret: string, xStoreID: string, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesGenericResponseDataTypesStoreConfigWithOnboardingResponse>;
58529
58832
  /**
58530
- * Updates the store configuration using x-store ID and write secret. Supports partial updates. This is a public API for SDK integration. Requires write secret for security.
58531
- * @summary Update Store Config (Public SDK API)
58532
- * @param {string} xStoreid Store ID
58533
- * @param {string} xStoreWriteSecret Store Write Secret (required for write operations)
58534
- * @param {string} xStoreID X-Store ID (must match x-storeid header)
58535
- * @param {DataTypesIndexConfig} dataTypesIndexConfig Store configuration (partial updates supported)
58833
+ * Update search and store settings. Partial updates supported. **Auth:** `x-storeid` and `x-store-write-secret`. Path `xStoreID` must match the `x-storeid` header.
58834
+ * @summary Update store configuration
58835
+ * @param {string} xStoreid Store ID (from dashboard)
58836
+ * @param {string} xStoreWriteSecret Store write secret
58837
+ * @param {string} xStoreID Store ID (must match x-storeid header)
58838
+ * @param {DataTypesIndexConfig} dataTypesIndexConfig Fields to update (partial)
58536
58839
  * @param {*} [options] Override http request option.
58537
58840
  * @throws {RequiredError}
58538
58841
  */
58539
58842
  apiV1StoresXStoreIDConfigPut(xStoreid: string, xStoreWriteSecret: string, xStoreID: string, dataTypesIndexConfig: DataTypesIndexConfig, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesIndexConfigResponseWrapper>;
58540
58843
  /**
58541
- * Get metadata about all configurable fields for store configuration. This is a public API for SDK integration.
58542
- * @summary Get Store Config Schema (Public SDK API)
58543
- * @param {string} xStoreid Store ID
58544
- * @param {string} xStoresecret Store Secret
58545
- * @param {string} xStoreID X-Store ID (must match x-storeid header)
58844
+ * Returns metadata for all configurable store fields (types, defaults, validation). **Auth:** `x-storeid` and `x-storesecret`. Path `xStoreID` must match the `x-storeid` header.
58845
+ * @summary Get store config schema
58846
+ * @param {string} xStoreid Store ID (from dashboard)
58847
+ * @param {string} xStoresecret Store read secret
58848
+ * @param {string} xStoreID Store ID (must match x-storeid header)
58546
58849
  * @param {*} [options] Override http request option.
58547
58850
  * @throws {RequiredError}
58548
58851
  */
@@ -58556,34 +58859,34 @@ export declare const SDKStoreConfigApiFactory: (configuration?: Configuration, b
58556
58859
  */
58557
58860
  export declare class SDKStoreConfigApi extends BaseAPI {
58558
58861
  /**
58559
- * Retrieves the store configuration (search config and query suggestions config) using x-store ID and read secret. This is a public API for SDK integration. Uses read secret (x-storesecret). Includes both search configuration and query suggestions configuration in a single response.
58560
- * @summary Get Store Config (Public SDK API)
58561
- * @param {string} xStoreid Store ID
58562
- * @param {string} xStoresecret Store Read Secret (for read operations)
58563
- * @param {string} xStoreID X-Store ID (must match x-storeid header)
58862
+ * Returns search and query-suggestions configuration for the store. **Auth:** `x-storeid` and `x-storesecret`. Path `xStoreID` must match the `x-storeid` header.
58863
+ * @summary Get store configuration
58864
+ * @param {string} xStoreid Store ID (from dashboard)
58865
+ * @param {string} xStoresecret Store read secret
58866
+ * @param {string} xStoreID Store ID (must match x-storeid header)
58564
58867
  * @param {*} [options] Override http request option.
58565
58868
  * @throws {RequiredError}
58566
58869
  * @memberof SDKStoreConfigApi
58567
58870
  */
58568
58871
  apiV1StoresXStoreIDConfigGet(xStoreid: string, xStoresecret: string, xStoreID: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesGenericResponseDataTypesStoreConfigWithOnboardingResponse, any, {}>>;
58569
58872
  /**
58570
- * Updates the store configuration using x-store ID and write secret. Supports partial updates. This is a public API for SDK integration. Requires write secret for security.
58571
- * @summary Update Store Config (Public SDK API)
58572
- * @param {string} xStoreid Store ID
58573
- * @param {string} xStoreWriteSecret Store Write Secret (required for write operations)
58574
- * @param {string} xStoreID X-Store ID (must match x-storeid header)
58575
- * @param {DataTypesIndexConfig} dataTypesIndexConfig Store configuration (partial updates supported)
58873
+ * Update search and store settings. Partial updates supported. **Auth:** `x-storeid` and `x-store-write-secret`. Path `xStoreID` must match the `x-storeid` header.
58874
+ * @summary Update store configuration
58875
+ * @param {string} xStoreid Store ID (from dashboard)
58876
+ * @param {string} xStoreWriteSecret Store write secret
58877
+ * @param {string} xStoreID Store ID (must match x-storeid header)
58878
+ * @param {DataTypesIndexConfig} dataTypesIndexConfig Fields to update (partial)
58576
58879
  * @param {*} [options] Override http request option.
58577
58880
  * @throws {RequiredError}
58578
58881
  * @memberof SDKStoreConfigApi
58579
58882
  */
58580
58883
  apiV1StoresXStoreIDConfigPut(xStoreid: string, xStoreWriteSecret: string, xStoreID: string, dataTypesIndexConfig: DataTypesIndexConfig, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesIndexConfigResponseWrapper, any, {}>>;
58581
58884
  /**
58582
- * Get metadata about all configurable fields for store configuration. This is a public API for SDK integration.
58583
- * @summary Get Store Config Schema (Public SDK API)
58584
- * @param {string} xStoreid Store ID
58585
- * @param {string} xStoresecret Store Secret
58586
- * @param {string} xStoreID X-Store ID (must match x-storeid header)
58885
+ * Returns metadata for all configurable store fields (types, defaults, validation). **Auth:** `x-storeid` and `x-storesecret`. Path `xStoreID` must match the `x-storeid` header.
58886
+ * @summary Get store config schema
58887
+ * @param {string} xStoreid Store ID (from dashboard)
58888
+ * @param {string} xStoresecret Store read secret
58889
+ * @param {string} xStoreID Store ID (must match x-storeid header)
58587
58890
  * @param {*} [options] Override http request option.
58588
58891
  * @throws {RequiredError}
58589
58892
  * @memberof SDKStoreConfigApi
@@ -58659,11 +58962,11 @@ export declare class SDKStoreCreationApi extends BaseAPI {
58659
58962
  */
58660
58963
  export declare const SDKStoreInfoApiAxiosParamCreator: (configuration?: Configuration) => {
58661
58964
  /**
58662
- * Retrieves basic store information (name, location, status) using x-store ID and read secret. This is a public API for SDK integration. Uses read secret (x-storesecret).
58663
- * @summary Get Store Info (Public SDK API)
58664
- * @param {string} xStoreid Store ID
58665
- * @param {string} xStoresecret Store Read Secret (for read operations)
58666
- * @param {string} xStoreID X-Store ID (must match x-storeid header)
58965
+ * Returns basic store details (name, location, status). **Auth:** `x-storeid` and `x-storesecret`. Path `xStoreID` must match the `x-storeid` header.
58966
+ * @summary Get store info
58967
+ * @param {string} xStoreid Store ID (from dashboard)
58968
+ * @param {string} xStoresecret Store read secret
58969
+ * @param {string} xStoreID Store ID (must match x-storeid header)
58667
58970
  * @param {*} [options] Override http request option.
58668
58971
  * @throws {RequiredError}
58669
58972
  */
@@ -58675,11 +58978,11 @@ export declare const SDKStoreInfoApiAxiosParamCreator: (configuration?: Configur
58675
58978
  */
58676
58979
  export declare const SDKStoreInfoApiFp: (configuration?: Configuration) => {
58677
58980
  /**
58678
- * Retrieves basic store information (name, location, status) using x-store ID and read secret. This is a public API for SDK integration. Uses read secret (x-storesecret).
58679
- * @summary Get Store Info (Public SDK API)
58680
- * @param {string} xStoreid Store ID
58681
- * @param {string} xStoresecret Store Read Secret (for read operations)
58682
- * @param {string} xStoreID X-Store ID (must match x-storeid header)
58981
+ * Returns basic store details (name, location, status). **Auth:** `x-storeid` and `x-storesecret`. Path `xStoreID` must match the `x-storeid` header.
58982
+ * @summary Get store info
58983
+ * @param {string} xStoreid Store ID (from dashboard)
58984
+ * @param {string} xStoresecret Store read secret
58985
+ * @param {string} xStoreID Store ID (must match x-storeid header)
58683
58986
  * @param {*} [options] Override http request option.
58684
58987
  * @throws {RequiredError}
58685
58988
  */
@@ -58691,11 +58994,11 @@ export declare const SDKStoreInfoApiFp: (configuration?: Configuration) => {
58691
58994
  */
58692
58995
  export declare const SDKStoreInfoApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
58693
58996
  /**
58694
- * Retrieves basic store information (name, location, status) using x-store ID and read secret. This is a public API for SDK integration. Uses read secret (x-storesecret).
58695
- * @summary Get Store Info (Public SDK API)
58696
- * @param {string} xStoreid Store ID
58697
- * @param {string} xStoresecret Store Read Secret (for read operations)
58698
- * @param {string} xStoreID X-Store ID (must match x-storeid header)
58997
+ * Returns basic store details (name, location, status). **Auth:** `x-storeid` and `x-storesecret`. Path `xStoreID` must match the `x-storeid` header.
58998
+ * @summary Get store info
58999
+ * @param {string} xStoreid Store ID (from dashboard)
59000
+ * @param {string} xStoresecret Store read secret
59001
+ * @param {string} xStoreID Store ID (must match x-storeid header)
58699
59002
  * @param {*} [options] Override http request option.
58700
59003
  * @throws {RequiredError}
58701
59004
  */
@@ -58709,11 +59012,11 @@ export declare const SDKStoreInfoApiFactory: (configuration?: Configuration, bas
58709
59012
  */
58710
59013
  export declare class SDKStoreInfoApi extends BaseAPI {
58711
59014
  /**
58712
- * Retrieves basic store information (name, location, status) using x-store ID and read secret. This is a public API for SDK integration. Uses read secret (x-storesecret).
58713
- * @summary Get Store Info (Public SDK API)
58714
- * @param {string} xStoreid Store ID
58715
- * @param {string} xStoresecret Store Read Secret (for read operations)
58716
- * @param {string} xStoreID X-Store ID (must match x-storeid header)
59015
+ * Returns basic store details (name, location, status). **Auth:** `x-storeid` and `x-storesecret`. Path `xStoreID` must match the `x-storeid` header.
59016
+ * @summary Get store info
59017
+ * @param {string} xStoreid Store ID (from dashboard)
59018
+ * @param {string} xStoresecret Store read secret
59019
+ * @param {string} xStoreID Store ID (must match x-storeid header)
58717
59020
  * @param {*} [options] Override http request option.
58718
59021
  * @throws {RequiredError}
58719
59022
  * @memberof SDKStoreInfoApi
@@ -58778,13 +59081,63 @@ export declare const SearchApiAxiosParamCreator: (configuration?: Configuration)
58778
59081
  */
58779
59082
  v1IndexIndexnameDefaultsGet: (indexname: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
58780
59083
  /**
58781
- * Search documents using store credentials with optional autocomplete suggestions and configurable stopwords/synonyms. Supports personalization via x-user-id, x-anon-id, x-session-id headers.
58782
- * @summary Public Search API
58783
- * @param {string} xStoreid Store ID
58784
- * @param {string} xStoresecret Store Secret
58785
- * @param {DataTypesPublicSearchRequest} dataTypesPublicSearchRequest Search request with optional stopword_sets and synonym_sets for granular control
58786
- * @param {string} [xUserId] User ID for personalization (logged-in user)
58787
- * @param {string} [xAnonId] Anonymous ID for personalization (cookie/device ID)
59084
+ * 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.
59085
+ * @summary Search (GET)
59086
+ * @param {string} xStoreid Store ID (from dashboard)
59087
+ * @param {string} xStoresecret Store read secret (from dashboard)
59088
+ * @param {string} q Search query
59089
+ * @param {string} [xUserId] User ID for personalization
59090
+ * @param {string} [xAnonId] Anonymous user ID for personalization
59091
+ * @param {string} [xSessionId] Session ID for personalization
59092
+ * @param {number} [page] Page number (default: 1)
59093
+ * @param {number} [perPage] Items per page (default: 10)
59094
+ * @param {string} [sortBy] Sort option (e.g., price:asc, created_at:desc)
59095
+ * @param {string} [filterBy] Filter string (e.g., category:shirts)
59096
+ * @param {string} [facetBy] Facet fields (comma-separated)
59097
+ * @param {number} [maxFacetValues] Maximum facet values to return
59098
+ * @param {boolean} [widgetMode] Return widget-formatted results
59099
+ * @param {boolean} [includeSuggestions] Include autocomplete suggestions
59100
+ * @param {number} [suggestionsLimit] Number of suggestions to return
59101
+ * @param {string} [analyticsTags] Analytics tags (comma-separated)
59102
+ * @param {string} [stopwordSets] Stopword set IDs (comma-separated)
59103
+ * @param {string} [synonymSets] Synonym set IDs (comma-separated)
59104
+ * @param {string} [searchFields] Fields to search in (comma-separated)
59105
+ * @param {string} [returnFields] Fields to return (comma-separated)
59106
+ * @param {string} [omitFields] Fields to omit (comma-separated)
59107
+ * @param {string} [snippetFields] Fields to generate snippets for (comma-separated)
59108
+ * @param {string} [fullSnippetFields] Fields to include full snippet (comma-separated)
59109
+ * @param {string} [fieldWeights] Field weights as comma-separated integers (e.g., 3,2,1)
59110
+ * @param {string} [groupField] Field to group results by
59111
+ * @param {number} [groupSize] Number of results per group
59112
+ * @param {string} [snippetPrefix] Prefix for highlighted snippets
59113
+ * @param {string} [snippetSuffix] Suffix for highlighted snippets
59114
+ * @param {number} [snippetTokenLimit] Maximum tokens in snippet
59115
+ * @param {number} [snippetMinLen] Minimum snippet length
59116
+ * @param {boolean} [includeSnippets] Include snippets in results
59117
+ * @param {string} [prefixMode] Prefix matching mode (e.g., always, fallback, off)
59118
+ * @param {string} [infixMode] Infix matching mode (e.g., always, fallback, off)
59119
+ * @param {number} [typoMax] Maximum typo tolerance
59120
+ * @param {number} [typoMinLen1] Min word length for 1 typo
59121
+ * @param {number} [typoMinLen2] Min word length for 2 typos
59122
+ * @param {number} [searchTimeoutMs] Search timeout in milliseconds
59123
+ * @param {boolean} [requireAllTerms] Require all search terms to match
59124
+ * @param {boolean} [exactMatchBoost] Boost exact matches
59125
+ * @param {boolean} [cacheResults] Cache search results
59126
+ * @param {boolean} [applyRules] Apply search rules
59127
+ * @param {string} [presetName] Search preset name to use
59128
+ * @param {string} [facetSearchText] Text to filter facet values
59129
+ * @param {*} [options] Override http request option.
59130
+ * @throws {RequiredError}
59131
+ */
59132
+ 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>;
59133
+ /**
59134
+ * 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.
59135
+ * @summary Search (POST)
59136
+ * @param {string} xStoreid Store ID (from dashboard)
59137
+ * @param {string} xStoresecret Store read secret (from dashboard)
59138
+ * @param {DataTypesPublicSearchRequest} dataTypesPublicSearchRequest Search query, filters, pagination, and options
59139
+ * @param {string} [xUserId] User ID for personalization
59140
+ * @param {string} [xAnonId] Anonymous user ID for personalization
58788
59141
  * @param {string} [xSessionId] Session ID for personalization
58789
59142
  * @param {*} [options] Override http request option.
58790
59143
  * @throws {RequiredError}
@@ -58849,13 +59202,63 @@ export declare const SearchApiFp: (configuration?: Configuration) => {
58849
59202
  */
58850
59203
  v1IndexIndexnameDefaultsGet(indexname: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesSchemaBasedDefaultsResponseWrapper>>;
58851
59204
  /**
58852
- * Search documents using store credentials with optional autocomplete suggestions and configurable stopwords/synonyms. Supports personalization via x-user-id, x-anon-id, x-session-id headers.
58853
- * @summary Public Search API
58854
- * @param {string} xStoreid Store ID
58855
- * @param {string} xStoresecret Store Secret
58856
- * @param {DataTypesPublicSearchRequest} dataTypesPublicSearchRequest Search request with optional stopword_sets and synonym_sets for granular control
58857
- * @param {string} [xUserId] User ID for personalization (logged-in user)
58858
- * @param {string} [xAnonId] Anonymous ID for personalization (cookie/device ID)
59205
+ * 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.
59206
+ * @summary Search (GET)
59207
+ * @param {string} xStoreid Store ID (from dashboard)
59208
+ * @param {string} xStoresecret Store read secret (from dashboard)
59209
+ * @param {string} q Search query
59210
+ * @param {string} [xUserId] User ID for personalization
59211
+ * @param {string} [xAnonId] Anonymous user ID for personalization
59212
+ * @param {string} [xSessionId] Session ID for personalization
59213
+ * @param {number} [page] Page number (default: 1)
59214
+ * @param {number} [perPage] Items per page (default: 10)
59215
+ * @param {string} [sortBy] Sort option (e.g., price:asc, created_at:desc)
59216
+ * @param {string} [filterBy] Filter string (e.g., category:shirts)
59217
+ * @param {string} [facetBy] Facet fields (comma-separated)
59218
+ * @param {number} [maxFacetValues] Maximum facet values to return
59219
+ * @param {boolean} [widgetMode] Return widget-formatted results
59220
+ * @param {boolean} [includeSuggestions] Include autocomplete suggestions
59221
+ * @param {number} [suggestionsLimit] Number of suggestions to return
59222
+ * @param {string} [analyticsTags] Analytics tags (comma-separated)
59223
+ * @param {string} [stopwordSets] Stopword set IDs (comma-separated)
59224
+ * @param {string} [synonymSets] Synonym set IDs (comma-separated)
59225
+ * @param {string} [searchFields] Fields to search in (comma-separated)
59226
+ * @param {string} [returnFields] Fields to return (comma-separated)
59227
+ * @param {string} [omitFields] Fields to omit (comma-separated)
59228
+ * @param {string} [snippetFields] Fields to generate snippets for (comma-separated)
59229
+ * @param {string} [fullSnippetFields] Fields to include full snippet (comma-separated)
59230
+ * @param {string} [fieldWeights] Field weights as comma-separated integers (e.g., 3,2,1)
59231
+ * @param {string} [groupField] Field to group results by
59232
+ * @param {number} [groupSize] Number of results per group
59233
+ * @param {string} [snippetPrefix] Prefix for highlighted snippets
59234
+ * @param {string} [snippetSuffix] Suffix for highlighted snippets
59235
+ * @param {number} [snippetTokenLimit] Maximum tokens in snippet
59236
+ * @param {number} [snippetMinLen] Minimum snippet length
59237
+ * @param {boolean} [includeSnippets] Include snippets in results
59238
+ * @param {string} [prefixMode] Prefix matching mode (e.g., always, fallback, off)
59239
+ * @param {string} [infixMode] Infix matching mode (e.g., always, fallback, off)
59240
+ * @param {number} [typoMax] Maximum typo tolerance
59241
+ * @param {number} [typoMinLen1] Min word length for 1 typo
59242
+ * @param {number} [typoMinLen2] Min word length for 2 typos
59243
+ * @param {number} [searchTimeoutMs] Search timeout in milliseconds
59244
+ * @param {boolean} [requireAllTerms] Require all search terms to match
59245
+ * @param {boolean} [exactMatchBoost] Boost exact matches
59246
+ * @param {boolean} [cacheResults] Cache search results
59247
+ * @param {boolean} [applyRules] Apply search rules
59248
+ * @param {string} [presetName] Search preset name to use
59249
+ * @param {string} [facetSearchText] Text to filter facet values
59250
+ * @param {*} [options] Override http request option.
59251
+ * @throws {RequiredError}
59252
+ */
59253
+ 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>>;
59254
+ /**
59255
+ * 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.
59256
+ * @summary Search (POST)
59257
+ * @param {string} xStoreid Store ID (from dashboard)
59258
+ * @param {string} xStoresecret Store read secret (from dashboard)
59259
+ * @param {DataTypesPublicSearchRequest} dataTypesPublicSearchRequest Search query, filters, pagination, and options
59260
+ * @param {string} [xUserId] User ID for personalization
59261
+ * @param {string} [xAnonId] Anonymous user ID for personalization
58859
59262
  * @param {string} [xSessionId] Session ID for personalization
58860
59263
  * @param {*} [options] Override http request option.
58861
59264
  * @throws {RequiredError}
@@ -58920,13 +59323,63 @@ export declare const SearchApiFactory: (configuration?: Configuration, basePath?
58920
59323
  */
58921
59324
  v1IndexIndexnameDefaultsGet(indexname: string, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesSchemaBasedDefaultsResponseWrapper>;
58922
59325
  /**
58923
- * Search documents using store credentials with optional autocomplete suggestions and configurable stopwords/synonyms. Supports personalization via x-user-id, x-anon-id, x-session-id headers.
58924
- * @summary Public Search API
58925
- * @param {string} xStoreid Store ID
58926
- * @param {string} xStoresecret Store Secret
58927
- * @param {DataTypesPublicSearchRequest} dataTypesPublicSearchRequest Search request with optional stopword_sets and synonym_sets for granular control
58928
- * @param {string} [xUserId] User ID for personalization (logged-in user)
58929
- * @param {string} [xAnonId] Anonymous ID for personalization (cookie/device ID)
59326
+ * 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.
59327
+ * @summary Search (GET)
59328
+ * @param {string} xStoreid Store ID (from dashboard)
59329
+ * @param {string} xStoresecret Store read secret (from dashboard)
59330
+ * @param {string} q Search query
59331
+ * @param {string} [xUserId] User ID for personalization
59332
+ * @param {string} [xAnonId] Anonymous user ID for personalization
59333
+ * @param {string} [xSessionId] Session ID for personalization
59334
+ * @param {number} [page] Page number (default: 1)
59335
+ * @param {number} [perPage] Items per page (default: 10)
59336
+ * @param {string} [sortBy] Sort option (e.g., price:asc, created_at:desc)
59337
+ * @param {string} [filterBy] Filter string (e.g., category:shirts)
59338
+ * @param {string} [facetBy] Facet fields (comma-separated)
59339
+ * @param {number} [maxFacetValues] Maximum facet values to return
59340
+ * @param {boolean} [widgetMode] Return widget-formatted results
59341
+ * @param {boolean} [includeSuggestions] Include autocomplete suggestions
59342
+ * @param {number} [suggestionsLimit] Number of suggestions to return
59343
+ * @param {string} [analyticsTags] Analytics tags (comma-separated)
59344
+ * @param {string} [stopwordSets] Stopword set IDs (comma-separated)
59345
+ * @param {string} [synonymSets] Synonym set IDs (comma-separated)
59346
+ * @param {string} [searchFields] Fields to search in (comma-separated)
59347
+ * @param {string} [returnFields] Fields to return (comma-separated)
59348
+ * @param {string} [omitFields] Fields to omit (comma-separated)
59349
+ * @param {string} [snippetFields] Fields to generate snippets for (comma-separated)
59350
+ * @param {string} [fullSnippetFields] Fields to include full snippet (comma-separated)
59351
+ * @param {string} [fieldWeights] Field weights as comma-separated integers (e.g., 3,2,1)
59352
+ * @param {string} [groupField] Field to group results by
59353
+ * @param {number} [groupSize] Number of results per group
59354
+ * @param {string} [snippetPrefix] Prefix for highlighted snippets
59355
+ * @param {string} [snippetSuffix] Suffix for highlighted snippets
59356
+ * @param {number} [snippetTokenLimit] Maximum tokens in snippet
59357
+ * @param {number} [snippetMinLen] Minimum snippet length
59358
+ * @param {boolean} [includeSnippets] Include snippets in results
59359
+ * @param {string} [prefixMode] Prefix matching mode (e.g., always, fallback, off)
59360
+ * @param {string} [infixMode] Infix matching mode (e.g., always, fallback, off)
59361
+ * @param {number} [typoMax] Maximum typo tolerance
59362
+ * @param {number} [typoMinLen1] Min word length for 1 typo
59363
+ * @param {number} [typoMinLen2] Min word length for 2 typos
59364
+ * @param {number} [searchTimeoutMs] Search timeout in milliseconds
59365
+ * @param {boolean} [requireAllTerms] Require all search terms to match
59366
+ * @param {boolean} [exactMatchBoost] Boost exact matches
59367
+ * @param {boolean} [cacheResults] Cache search results
59368
+ * @param {boolean} [applyRules] Apply search rules
59369
+ * @param {string} [presetName] Search preset name to use
59370
+ * @param {string} [facetSearchText] Text to filter facet values
59371
+ * @param {*} [options] Override http request option.
59372
+ * @throws {RequiredError}
59373
+ */
59374
+ 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>;
59375
+ /**
59376
+ * 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.
59377
+ * @summary Search (POST)
59378
+ * @param {string} xStoreid Store ID (from dashboard)
59379
+ * @param {string} xStoresecret Store read secret (from dashboard)
59380
+ * @param {DataTypesPublicSearchRequest} dataTypesPublicSearchRequest Search query, filters, pagination, and options
59381
+ * @param {string} [xUserId] User ID for personalization
59382
+ * @param {string} [xAnonId] Anonymous user ID for personalization
58930
59383
  * @param {string} [xSessionId] Session ID for personalization
58931
59384
  * @param {*} [options] Override http request option.
58932
59385
  * @throws {RequiredError}
@@ -58999,13 +59452,64 @@ export declare class SearchApi extends BaseAPI {
58999
59452
  */
59000
59453
  v1IndexIndexnameDefaultsGet(indexname: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesSchemaBasedDefaultsResponseWrapper, any, {}>>;
59001
59454
  /**
59002
- * Search documents using store credentials with optional autocomplete suggestions and configurable stopwords/synonyms. Supports personalization via x-user-id, x-anon-id, x-session-id headers.
59003
- * @summary Public Search API
59004
- * @param {string} xStoreid Store ID
59005
- * @param {string} xStoresecret Store Secret
59006
- * @param {DataTypesPublicSearchRequest} dataTypesPublicSearchRequest Search request with optional stopword_sets and synonym_sets for granular control
59007
- * @param {string} [xUserId] User ID for personalization (logged-in user)
59008
- * @param {string} [xAnonId] Anonymous ID for personalization (cookie/device ID)
59455
+ * 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.
59456
+ * @summary Search (GET)
59457
+ * @param {string} xStoreid Store ID (from dashboard)
59458
+ * @param {string} xStoresecret Store read secret (from dashboard)
59459
+ * @param {string} q Search query
59460
+ * @param {string} [xUserId] User ID for personalization
59461
+ * @param {string} [xAnonId] Anonymous user ID for personalization
59462
+ * @param {string} [xSessionId] Session ID for personalization
59463
+ * @param {number} [page] Page number (default: 1)
59464
+ * @param {number} [perPage] Items per page (default: 10)
59465
+ * @param {string} [sortBy] Sort option (e.g., price:asc, created_at:desc)
59466
+ * @param {string} [filterBy] Filter string (e.g., category:shirts)
59467
+ * @param {string} [facetBy] Facet fields (comma-separated)
59468
+ * @param {number} [maxFacetValues] Maximum facet values to return
59469
+ * @param {boolean} [widgetMode] Return widget-formatted results
59470
+ * @param {boolean} [includeSuggestions] Include autocomplete suggestions
59471
+ * @param {number} [suggestionsLimit] Number of suggestions to return
59472
+ * @param {string} [analyticsTags] Analytics tags (comma-separated)
59473
+ * @param {string} [stopwordSets] Stopword set IDs (comma-separated)
59474
+ * @param {string} [synonymSets] Synonym set IDs (comma-separated)
59475
+ * @param {string} [searchFields] Fields to search in (comma-separated)
59476
+ * @param {string} [returnFields] Fields to return (comma-separated)
59477
+ * @param {string} [omitFields] Fields to omit (comma-separated)
59478
+ * @param {string} [snippetFields] Fields to generate snippets for (comma-separated)
59479
+ * @param {string} [fullSnippetFields] Fields to include full snippet (comma-separated)
59480
+ * @param {string} [fieldWeights] Field weights as comma-separated integers (e.g., 3,2,1)
59481
+ * @param {string} [groupField] Field to group results by
59482
+ * @param {number} [groupSize] Number of results per group
59483
+ * @param {string} [snippetPrefix] Prefix for highlighted snippets
59484
+ * @param {string} [snippetSuffix] Suffix for highlighted snippets
59485
+ * @param {number} [snippetTokenLimit] Maximum tokens in snippet
59486
+ * @param {number} [snippetMinLen] Minimum snippet length
59487
+ * @param {boolean} [includeSnippets] Include snippets in results
59488
+ * @param {string} [prefixMode] Prefix matching mode (e.g., always, fallback, off)
59489
+ * @param {string} [infixMode] Infix matching mode (e.g., always, fallback, off)
59490
+ * @param {number} [typoMax] Maximum typo tolerance
59491
+ * @param {number} [typoMinLen1] Min word length for 1 typo
59492
+ * @param {number} [typoMinLen2] Min word length for 2 typos
59493
+ * @param {number} [searchTimeoutMs] Search timeout in milliseconds
59494
+ * @param {boolean} [requireAllTerms] Require all search terms to match
59495
+ * @param {boolean} [exactMatchBoost] Boost exact matches
59496
+ * @param {boolean} [cacheResults] Cache search results
59497
+ * @param {boolean} [applyRules] Apply search rules
59498
+ * @param {string} [presetName] Search preset name to use
59499
+ * @param {string} [facetSearchText] Text to filter facet values
59500
+ * @param {*} [options] Override http request option.
59501
+ * @throws {RequiredError}
59502
+ * @memberof SearchApi
59503
+ */
59504
+ 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, {}>>;
59505
+ /**
59506
+ * 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.
59507
+ * @summary Search (POST)
59508
+ * @param {string} xStoreid Store ID (from dashboard)
59509
+ * @param {string} xStoresecret Store read secret (from dashboard)
59510
+ * @param {DataTypesPublicSearchRequest} dataTypesPublicSearchRequest Search query, filters, pagination, and options
59511
+ * @param {string} [xUserId] User ID for personalization
59512
+ * @param {string} [xAnonId] Anonymous user ID for personalization
59009
59513
  * @param {string} [xSessionId] Session ID for personalization
59010
59514
  * @param {*} [options] Override http request option.
59011
59515
  * @throws {RequiredError}
@@ -62711,71 +63215,72 @@ export declare const UserProfilesApiAxiosParamCreator: (configuration?: Configur
62711
63215
  /**
62712
63216
  * Returns the user profile for an authenticated user token
62713
63217
  * @summary Get User Profile by Auth Token
63218
+ * @param {string} xStoreID Store ID
62714
63219
  * @param {string} authToken Authenticated user token
62715
- * @param {string} [xstoreid] Store ID filter
62716
63220
  * @param {*} [options] Override http request option.
62717
63221
  * @throws {RequiredError}
62718
63222
  */
62719
- v1AnalyticsProfilesByAuthTokenAuthTokenGet: (authToken: string, xstoreid?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
63223
+ adminAnalyticsStoreXStoreIDProfilesByAuthTokenAuthTokenGet: (xStoreID: string, authToken: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
62720
63224
  /**
62721
63225
  * Merges an anonymous user profile into an authenticated user profile
62722
63226
  * @summary Merge User Profiles
63227
+ * @param {string} xStoreID Store ID
62723
63228
  * @param {AnalyticsMergeProfilesRequestBody} analyticsMergeProfilesRequestBody Merge request
62724
63229
  * @param {*} [options] Override http request option.
62725
63230
  * @throws {RequiredError}
62726
63231
  */
62727
- v1AnalyticsProfilesMergePost: (analyticsMergeProfilesRequestBody: AnalyticsMergeProfilesRequestBody, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
63232
+ adminAnalyticsStoreXStoreIDProfilesMergePost: (xStoreID: string, analyticsMergeProfilesRequestBody: AnalyticsMergeProfilesRequestBody, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
62728
63233
  /**
62729
63234
  * Returns paginated events for a user with optional filtering
62730
63235
  * @summary Get User Events
63236
+ * @param {string} xStoreID Store ID
62731
63237
  * @param {string} userKey User key (user_id or anonymous_id)
62732
63238
  * @param {Array<string>} [eventTypes] Filter by event types (search, click, conversion, view, recommendation)
62733
63239
  * @param {string} [startDate] Start date (YYYY-MM-DD)
62734
63240
  * @param {string} [endDate] End date (YYYY-MM-DD)
62735
63241
  * @param {number} [page] Page number (default 1)
62736
63242
  * @param {number} [pageSize] Page size (default 50, max 500)
62737
- * @param {string} [xstoreid] Store ID filter
62738
63243
  * @param {*} [options] Override http request option.
62739
63244
  * @throws {RequiredError}
62740
63245
  */
62741
- v1AnalyticsProfilesUserKeyEventsGet: (userKey: string, eventTypes?: Array<string>, startDate?: string, endDate?: string, page?: number, pageSize?: number, xstoreid?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
63246
+ adminAnalyticsStoreXStoreIDProfilesUserKeyEventsGet: (xStoreID: string, userKey: string, eventTypes?: Array<string>, startDate?: string, endDate?: string, page?: number, pageSize?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
62742
63247
  /**
62743
63248
  * Returns the user profile with computed traits, affinities, and recent activity
62744
63249
  * @summary Get User Profile
63250
+ * @param {string} xStoreID Store ID
62745
63251
  * @param {string} userKey User key (user_id or anonymous_id)
62746
- * @param {string} [xstoreid] Store ID filter
62747
63252
  * @param {*} [options] Override http request option.
62748
63253
  * @throws {RequiredError}
62749
63254
  */
62750
- v1AnalyticsProfilesUserKeyGet: (userKey: string, xstoreid?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
63255
+ adminAnalyticsStoreXStoreIDProfilesUserKeyGet: (xStoreID: string, userKey: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
62751
63256
  /**
62752
63257
  * Returns all data needed for personalizing the user experience
62753
63258
  * @summary Get Personalization Context
63259
+ * @param {string} xStoreID Store ID
62754
63260
  * @param {string} userKey User key (user_id or anonymous_id)
62755
- * @param {string} [xstoreid] Store ID filter
62756
63261
  * @param {*} [options] Override http request option.
62757
63262
  * @throws {RequiredError}
62758
63263
  */
62759
- v1AnalyticsProfilesUserKeyPersonalizationGet: (userKey: string, xstoreid?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
63264
+ adminAnalyticsStoreXStoreIDProfilesUserKeyPersonalizationGet: (xStoreID: string, userKey: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
62760
63265
  /**
62761
63266
  * Returns the segments a user belongs to based on their behavior
62762
63267
  * @summary Get User Segments
63268
+ * @param {string} xStoreID Store ID
62763
63269
  * @param {string} userKey User key (user_id or anonymous_id)
62764
- * @param {string} [xstoreid] Store ID filter
62765
63270
  * @param {*} [options] Override http request option.
62766
63271
  * @throws {RequiredError}
62767
63272
  */
62768
- v1AnalyticsProfilesUserKeySegmentsGet: (userKey: string, xstoreid?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
63273
+ adminAnalyticsStoreXStoreIDProfilesUserKeySegmentsGet: (xStoreID: string, userKey: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
62769
63274
  /**
62770
63275
  * Returns users with similar behavior patterns for lookalike targeting
62771
63276
  * @summary Get Similar Users
63277
+ * @param {string} xStoreID Store ID
62772
63278
  * @param {string} userKey User key (user_id or anonymous_id)
62773
63279
  * @param {number} [limit] Number of similar users to return (default 10, max 100)
62774
- * @param {string} [xstoreid] Store ID filter
62775
63280
  * @param {*} [options] Override http request option.
62776
63281
  * @throws {RequiredError}
62777
63282
  */
62778
- v1AnalyticsProfilesUserKeySimilarGet: (userKey: string, limit?: number, xstoreid?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
63283
+ adminAnalyticsStoreXStoreIDProfilesUserKeySimilarGet: (xStoreID: string, userKey: string, limit?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
62779
63284
  };
62780
63285
  /**
62781
63286
  * UserProfilesApi - functional programming interface
@@ -62785,71 +63290,72 @@ export declare const UserProfilesApiFp: (configuration?: Configuration) => {
62785
63290
  /**
62786
63291
  * Returns the user profile for an authenticated user token
62787
63292
  * @summary Get User Profile by Auth Token
63293
+ * @param {string} xStoreID Store ID
62788
63294
  * @param {string} authToken Authenticated user token
62789
- * @param {string} [xstoreid] Store ID filter
62790
63295
  * @param {*} [options] Override http request option.
62791
63296
  * @throws {RequiredError}
62792
63297
  */
62793
- v1AnalyticsProfilesByAuthTokenAuthTokenGet(authToken: string, xstoreid?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesGenericResponseModelsUserProfile>>;
63298
+ adminAnalyticsStoreXStoreIDProfilesByAuthTokenAuthTokenGet(xStoreID: string, authToken: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesGenericResponseModelsUserProfile>>;
62794
63299
  /**
62795
63300
  * Merges an anonymous user profile into an authenticated user profile
62796
63301
  * @summary Merge User Profiles
63302
+ * @param {string} xStoreID Store ID
62797
63303
  * @param {AnalyticsMergeProfilesRequestBody} analyticsMergeProfilesRequestBody Merge request
62798
63304
  * @param {*} [options] Override http request option.
62799
63305
  * @throws {RequiredError}
62800
63306
  */
62801
- v1AnalyticsProfilesMergePost(analyticsMergeProfilesRequestBody: AnalyticsMergeProfilesRequestBody, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesGenericResponseModelsMergeProfilesResponse>>;
63307
+ adminAnalyticsStoreXStoreIDProfilesMergePost(xStoreID: string, analyticsMergeProfilesRequestBody: AnalyticsMergeProfilesRequestBody, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesGenericResponseModelsMergeProfilesResponse>>;
62802
63308
  /**
62803
63309
  * Returns paginated events for a user with optional filtering
62804
63310
  * @summary Get User Events
63311
+ * @param {string} xStoreID Store ID
62805
63312
  * @param {string} userKey User key (user_id or anonymous_id)
62806
63313
  * @param {Array<string>} [eventTypes] Filter by event types (search, click, conversion, view, recommendation)
62807
63314
  * @param {string} [startDate] Start date (YYYY-MM-DD)
62808
63315
  * @param {string} [endDate] End date (YYYY-MM-DD)
62809
63316
  * @param {number} [page] Page number (default 1)
62810
63317
  * @param {number} [pageSize] Page size (default 50, max 500)
62811
- * @param {string} [xstoreid] Store ID filter
62812
63318
  * @param {*} [options] Override http request option.
62813
63319
  * @throws {RequiredError}
62814
63320
  */
62815
- v1AnalyticsProfilesUserKeyEventsGet(userKey: string, eventTypes?: Array<string>, startDate?: string, endDate?: string, page?: number, pageSize?: number, xstoreid?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesGenericResponseModelsUserEventsResponse>>;
63321
+ adminAnalyticsStoreXStoreIDProfilesUserKeyEventsGet(xStoreID: string, userKey: string, eventTypes?: Array<string>, startDate?: string, endDate?: string, page?: number, pageSize?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesGenericResponseModelsUserEventsResponse>>;
62816
63322
  /**
62817
63323
  * Returns the user profile with computed traits, affinities, and recent activity
62818
63324
  * @summary Get User Profile
63325
+ * @param {string} xStoreID Store ID
62819
63326
  * @param {string} userKey User key (user_id or anonymous_id)
62820
- * @param {string} [xstoreid] Store ID filter
62821
63327
  * @param {*} [options] Override http request option.
62822
63328
  * @throws {RequiredError}
62823
63329
  */
62824
- v1AnalyticsProfilesUserKeyGet(userKey: string, xstoreid?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesGenericResponseModelsUserProfile>>;
63330
+ adminAnalyticsStoreXStoreIDProfilesUserKeyGet(xStoreID: string, userKey: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesGenericResponseModelsUserProfile>>;
62825
63331
  /**
62826
63332
  * Returns all data needed for personalizing the user experience
62827
63333
  * @summary Get Personalization Context
63334
+ * @param {string} xStoreID Store ID
62828
63335
  * @param {string} userKey User key (user_id or anonymous_id)
62829
- * @param {string} [xstoreid] Store ID filter
62830
63336
  * @param {*} [options] Override http request option.
62831
63337
  * @throws {RequiredError}
62832
63338
  */
62833
- v1AnalyticsProfilesUserKeyPersonalizationGet(userKey: string, xstoreid?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesGenericResponseModelsPersonalizationContext>>;
63339
+ adminAnalyticsStoreXStoreIDProfilesUserKeyPersonalizationGet(xStoreID: string, userKey: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesGenericResponseModelsPersonalizationContext>>;
62834
63340
  /**
62835
63341
  * Returns the segments a user belongs to based on their behavior
62836
63342
  * @summary Get User Segments
63343
+ * @param {string} xStoreID Store ID
62837
63344
  * @param {string} userKey User key (user_id or anonymous_id)
62838
- * @param {string} [xstoreid] Store ID filter
62839
63345
  * @param {*} [options] Override http request option.
62840
63346
  * @throws {RequiredError}
62841
63347
  */
62842
- v1AnalyticsProfilesUserKeySegmentsGet(userKey: string, xstoreid?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesGenericResponseArrayString>>;
63348
+ adminAnalyticsStoreXStoreIDProfilesUserKeySegmentsGet(xStoreID: string, userKey: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesGenericResponseArrayString>>;
62843
63349
  /**
62844
63350
  * Returns users with similar behavior patterns for lookalike targeting
62845
63351
  * @summary Get Similar Users
63352
+ * @param {string} xStoreID Store ID
62846
63353
  * @param {string} userKey User key (user_id or anonymous_id)
62847
63354
  * @param {number} [limit] Number of similar users to return (default 10, max 100)
62848
- * @param {string} [xstoreid] Store ID filter
62849
63355
  * @param {*} [options] Override http request option.
62850
63356
  * @throws {RequiredError}
62851
63357
  */
62852
- v1AnalyticsProfilesUserKeySimilarGet(userKey: string, limit?: number, xstoreid?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesGenericResponseArrayModelsSimilarUser>>;
63358
+ adminAnalyticsStoreXStoreIDProfilesUserKeySimilarGet(xStoreID: string, userKey: string, limit?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesGenericResponseArrayModelsSimilarUser>>;
62853
63359
  };
62854
63360
  /**
62855
63361
  * UserProfilesApi - factory interface
@@ -62859,71 +63365,72 @@ export declare const UserProfilesApiFactory: (configuration?: Configuration, bas
62859
63365
  /**
62860
63366
  * Returns the user profile for an authenticated user token
62861
63367
  * @summary Get User Profile by Auth Token
63368
+ * @param {string} xStoreID Store ID
62862
63369
  * @param {string} authToken Authenticated user token
62863
- * @param {string} [xstoreid] Store ID filter
62864
63370
  * @param {*} [options] Override http request option.
62865
63371
  * @throws {RequiredError}
62866
63372
  */
62867
- v1AnalyticsProfilesByAuthTokenAuthTokenGet(authToken: string, xstoreid?: string, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesGenericResponseModelsUserProfile>;
63373
+ adminAnalyticsStoreXStoreIDProfilesByAuthTokenAuthTokenGet(xStoreID: string, authToken: string, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesGenericResponseModelsUserProfile>;
62868
63374
  /**
62869
63375
  * Merges an anonymous user profile into an authenticated user profile
62870
63376
  * @summary Merge User Profiles
63377
+ * @param {string} xStoreID Store ID
62871
63378
  * @param {AnalyticsMergeProfilesRequestBody} analyticsMergeProfilesRequestBody Merge request
62872
63379
  * @param {*} [options] Override http request option.
62873
63380
  * @throws {RequiredError}
62874
63381
  */
62875
- v1AnalyticsProfilesMergePost(analyticsMergeProfilesRequestBody: AnalyticsMergeProfilesRequestBody, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesGenericResponseModelsMergeProfilesResponse>;
63382
+ adminAnalyticsStoreXStoreIDProfilesMergePost(xStoreID: string, analyticsMergeProfilesRequestBody: AnalyticsMergeProfilesRequestBody, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesGenericResponseModelsMergeProfilesResponse>;
62876
63383
  /**
62877
63384
  * Returns paginated events for a user with optional filtering
62878
63385
  * @summary Get User Events
63386
+ * @param {string} xStoreID Store ID
62879
63387
  * @param {string} userKey User key (user_id or anonymous_id)
62880
63388
  * @param {Array<string>} [eventTypes] Filter by event types (search, click, conversion, view, recommendation)
62881
63389
  * @param {string} [startDate] Start date (YYYY-MM-DD)
62882
63390
  * @param {string} [endDate] End date (YYYY-MM-DD)
62883
63391
  * @param {number} [page] Page number (default 1)
62884
63392
  * @param {number} [pageSize] Page size (default 50, max 500)
62885
- * @param {string} [xstoreid] Store ID filter
62886
63393
  * @param {*} [options] Override http request option.
62887
63394
  * @throws {RequiredError}
62888
63395
  */
62889
- v1AnalyticsProfilesUserKeyEventsGet(userKey: string, eventTypes?: Array<string>, startDate?: string, endDate?: string, page?: number, pageSize?: number, xstoreid?: string, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesGenericResponseModelsUserEventsResponse>;
63396
+ adminAnalyticsStoreXStoreIDProfilesUserKeyEventsGet(xStoreID: string, userKey: string, eventTypes?: Array<string>, startDate?: string, endDate?: string, page?: number, pageSize?: number, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesGenericResponseModelsUserEventsResponse>;
62890
63397
  /**
62891
63398
  * Returns the user profile with computed traits, affinities, and recent activity
62892
63399
  * @summary Get User Profile
63400
+ * @param {string} xStoreID Store ID
62893
63401
  * @param {string} userKey User key (user_id or anonymous_id)
62894
- * @param {string} [xstoreid] Store ID filter
62895
63402
  * @param {*} [options] Override http request option.
62896
63403
  * @throws {RequiredError}
62897
63404
  */
62898
- v1AnalyticsProfilesUserKeyGet(userKey: string, xstoreid?: string, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesGenericResponseModelsUserProfile>;
63405
+ adminAnalyticsStoreXStoreIDProfilesUserKeyGet(xStoreID: string, userKey: string, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesGenericResponseModelsUserProfile>;
62899
63406
  /**
62900
63407
  * Returns all data needed for personalizing the user experience
62901
63408
  * @summary Get Personalization Context
63409
+ * @param {string} xStoreID Store ID
62902
63410
  * @param {string} userKey User key (user_id or anonymous_id)
62903
- * @param {string} [xstoreid] Store ID filter
62904
63411
  * @param {*} [options] Override http request option.
62905
63412
  * @throws {RequiredError}
62906
63413
  */
62907
- v1AnalyticsProfilesUserKeyPersonalizationGet(userKey: string, xstoreid?: string, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesGenericResponseModelsPersonalizationContext>;
63414
+ adminAnalyticsStoreXStoreIDProfilesUserKeyPersonalizationGet(xStoreID: string, userKey: string, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesGenericResponseModelsPersonalizationContext>;
62908
63415
  /**
62909
63416
  * Returns the segments a user belongs to based on their behavior
62910
63417
  * @summary Get User Segments
63418
+ * @param {string} xStoreID Store ID
62911
63419
  * @param {string} userKey User key (user_id or anonymous_id)
62912
- * @param {string} [xstoreid] Store ID filter
62913
63420
  * @param {*} [options] Override http request option.
62914
63421
  * @throws {RequiredError}
62915
63422
  */
62916
- v1AnalyticsProfilesUserKeySegmentsGet(userKey: string, xstoreid?: string, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesGenericResponseArrayString>;
63423
+ adminAnalyticsStoreXStoreIDProfilesUserKeySegmentsGet(xStoreID: string, userKey: string, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesGenericResponseArrayString>;
62917
63424
  /**
62918
63425
  * Returns users with similar behavior patterns for lookalike targeting
62919
63426
  * @summary Get Similar Users
63427
+ * @param {string} xStoreID Store ID
62920
63428
  * @param {string} userKey User key (user_id or anonymous_id)
62921
63429
  * @param {number} [limit] Number of similar users to return (default 10, max 100)
62922
- * @param {string} [xstoreid] Store ID filter
62923
63430
  * @param {*} [options] Override http request option.
62924
63431
  * @throws {RequiredError}
62925
63432
  */
62926
- v1AnalyticsProfilesUserKeySimilarGet(userKey: string, limit?: number, xstoreid?: string, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesGenericResponseArrayModelsSimilarUser>;
63433
+ adminAnalyticsStoreXStoreIDProfilesUserKeySimilarGet(xStoreID: string, userKey: string, limit?: number, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesGenericResponseArrayModelsSimilarUser>;
62927
63434
  };
62928
63435
  /**
62929
63436
  * UserProfilesApi - object-oriented interface
@@ -62935,78 +63442,79 @@ export declare class UserProfilesApi extends BaseAPI {
62935
63442
  /**
62936
63443
  * Returns the user profile for an authenticated user token
62937
63444
  * @summary Get User Profile by Auth Token
63445
+ * @param {string} xStoreID Store ID
62938
63446
  * @param {string} authToken Authenticated user token
62939
- * @param {string} [xstoreid] Store ID filter
62940
63447
  * @param {*} [options] Override http request option.
62941
63448
  * @throws {RequiredError}
62942
63449
  * @memberof UserProfilesApi
62943
63450
  */
62944
- v1AnalyticsProfilesByAuthTokenAuthTokenGet(authToken: string, xstoreid?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesGenericResponseModelsUserProfile, any, {}>>;
63451
+ adminAnalyticsStoreXStoreIDProfilesByAuthTokenAuthTokenGet(xStoreID: string, authToken: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesGenericResponseModelsUserProfile, any, {}>>;
62945
63452
  /**
62946
63453
  * Merges an anonymous user profile into an authenticated user profile
62947
63454
  * @summary Merge User Profiles
63455
+ * @param {string} xStoreID Store ID
62948
63456
  * @param {AnalyticsMergeProfilesRequestBody} analyticsMergeProfilesRequestBody Merge request
62949
63457
  * @param {*} [options] Override http request option.
62950
63458
  * @throws {RequiredError}
62951
63459
  * @memberof UserProfilesApi
62952
63460
  */
62953
- v1AnalyticsProfilesMergePost(analyticsMergeProfilesRequestBody: AnalyticsMergeProfilesRequestBody, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesGenericResponseModelsMergeProfilesResponse, any, {}>>;
63461
+ adminAnalyticsStoreXStoreIDProfilesMergePost(xStoreID: string, analyticsMergeProfilesRequestBody: AnalyticsMergeProfilesRequestBody, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesGenericResponseModelsMergeProfilesResponse, any, {}>>;
62954
63462
  /**
62955
63463
  * Returns paginated events for a user with optional filtering
62956
63464
  * @summary Get User Events
63465
+ * @param {string} xStoreID Store ID
62957
63466
  * @param {string} userKey User key (user_id or anonymous_id)
62958
63467
  * @param {Array<string>} [eventTypes] Filter by event types (search, click, conversion, view, recommendation)
62959
63468
  * @param {string} [startDate] Start date (YYYY-MM-DD)
62960
63469
  * @param {string} [endDate] End date (YYYY-MM-DD)
62961
63470
  * @param {number} [page] Page number (default 1)
62962
63471
  * @param {number} [pageSize] Page size (default 50, max 500)
62963
- * @param {string} [xstoreid] Store ID filter
62964
63472
  * @param {*} [options] Override http request option.
62965
63473
  * @throws {RequiredError}
62966
63474
  * @memberof UserProfilesApi
62967
63475
  */
62968
- v1AnalyticsProfilesUserKeyEventsGet(userKey: string, eventTypes?: Array<string>, startDate?: string, endDate?: string, page?: number, pageSize?: number, xstoreid?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesGenericResponseModelsUserEventsResponse, any, {}>>;
63476
+ adminAnalyticsStoreXStoreIDProfilesUserKeyEventsGet(xStoreID: string, userKey: string, eventTypes?: Array<string>, startDate?: string, endDate?: string, page?: number, pageSize?: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesGenericResponseModelsUserEventsResponse, any, {}>>;
62969
63477
  /**
62970
63478
  * Returns the user profile with computed traits, affinities, and recent activity
62971
63479
  * @summary Get User Profile
63480
+ * @param {string} xStoreID Store ID
62972
63481
  * @param {string} userKey User key (user_id or anonymous_id)
62973
- * @param {string} [xstoreid] Store ID filter
62974
63482
  * @param {*} [options] Override http request option.
62975
63483
  * @throws {RequiredError}
62976
63484
  * @memberof UserProfilesApi
62977
63485
  */
62978
- v1AnalyticsProfilesUserKeyGet(userKey: string, xstoreid?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesGenericResponseModelsUserProfile, any, {}>>;
63486
+ adminAnalyticsStoreXStoreIDProfilesUserKeyGet(xStoreID: string, userKey: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesGenericResponseModelsUserProfile, any, {}>>;
62979
63487
  /**
62980
63488
  * Returns all data needed for personalizing the user experience
62981
63489
  * @summary Get Personalization Context
63490
+ * @param {string} xStoreID Store ID
62982
63491
  * @param {string} userKey User key (user_id or anonymous_id)
62983
- * @param {string} [xstoreid] Store ID filter
62984
63492
  * @param {*} [options] Override http request option.
62985
63493
  * @throws {RequiredError}
62986
63494
  * @memberof UserProfilesApi
62987
63495
  */
62988
- v1AnalyticsProfilesUserKeyPersonalizationGet(userKey: string, xstoreid?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesGenericResponseModelsPersonalizationContext, any, {}>>;
63496
+ adminAnalyticsStoreXStoreIDProfilesUserKeyPersonalizationGet(xStoreID: string, userKey: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesGenericResponseModelsPersonalizationContext, any, {}>>;
62989
63497
  /**
62990
63498
  * Returns the segments a user belongs to based on their behavior
62991
63499
  * @summary Get User Segments
63500
+ * @param {string} xStoreID Store ID
62992
63501
  * @param {string} userKey User key (user_id or anonymous_id)
62993
- * @param {string} [xstoreid] Store ID filter
62994
63502
  * @param {*} [options] Override http request option.
62995
63503
  * @throws {RequiredError}
62996
63504
  * @memberof UserProfilesApi
62997
63505
  */
62998
- v1AnalyticsProfilesUserKeySegmentsGet(userKey: string, xstoreid?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesGenericResponseArrayString, any, {}>>;
63506
+ adminAnalyticsStoreXStoreIDProfilesUserKeySegmentsGet(xStoreID: string, userKey: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesGenericResponseArrayString, any, {}>>;
62999
63507
  /**
63000
63508
  * Returns users with similar behavior patterns for lookalike targeting
63001
63509
  * @summary Get Similar Users
63510
+ * @param {string} xStoreID Store ID
63002
63511
  * @param {string} userKey User key (user_id or anonymous_id)
63003
63512
  * @param {number} [limit] Number of similar users to return (default 10, max 100)
63004
- * @param {string} [xstoreid] Store ID filter
63005
63513
  * @param {*} [options] Override http request option.
63006
63514
  * @throws {RequiredError}
63007
63515
  * @memberof UserProfilesApi
63008
63516
  */
63009
- v1AnalyticsProfilesUserKeySimilarGet(userKey: string, limit?: number, xstoreid?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesGenericResponseArrayModelsSimilarUser, any, {}>>;
63517
+ adminAnalyticsStoreXStoreIDProfilesUserKeySimilarGet(xStoreID: string, userKey: string, limit?: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesGenericResponseArrayModelsSimilarUser, any, {}>>;
63010
63518
  }
63011
63519
  /**
63012
63520
  * WebhooksApi - axios parameter creator