@seekora-ai/search-sdk 0.2.16 → 0.2.17
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/client.d.ts +3 -13
- package/dist/client.js +19 -131
- package/dist/generated/api.d.ts +373 -619
- package/dist/generated/api.js +298 -739
- package/dist/generated/base.d.ts +1 -1
- package/dist/generated/base.js +1 -1
- package/dist/generated/common.d.ts +1 -1
- package/dist/generated/common.js +1 -1
- package/dist/generated/configuration.d.ts +1 -1
- package/dist/generated/configuration.js +1 -1
- package/dist/generated/index.d.ts +1 -1
- package/dist/generated/index.js +1 -1
- package/package.json +1 -1
package/dist/generated/api.d.ts
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
/**
|
|
2
2
|
* Seekora APIs
|
|
3
|
-
* Seekora provides search, suggestions, and store management APIs.
|
|
3
|
+
* Seekora provides search, suggestions, and store management APIs.
|
|
4
4
|
*
|
|
5
5
|
* The version of the OpenAPI document: 1.0
|
|
6
6
|
*
|
|
@@ -16,6 +16,28 @@ import { BaseAPI } from './base';
|
|
|
16
16
|
export interface AnalyticsBatchPostRequest {
|
|
17
17
|
'events'?: Array<DataTypesEventPayload>;
|
|
18
18
|
}
|
|
19
|
+
export interface DataTypesAnalyticsConfigBatchLimits {
|
|
20
|
+
'max_event_size_bytes'?: number;
|
|
21
|
+
'max_events_per_batch'?: number;
|
|
22
|
+
}
|
|
23
|
+
export interface DataTypesAnalyticsConfigData {
|
|
24
|
+
'batch_limits'?: DataTypesAnalyticsConfigBatchLimits;
|
|
25
|
+
'funnel_stages'?: DataTypesAnalyticsConfigFunnelStages;
|
|
26
|
+
'metadata_guidelines'?: DataTypesAnalyticsConfigMetadataGuidelines;
|
|
27
|
+
'optional_fields'?: Array<string>;
|
|
28
|
+
'required_fields'?: Array<string>;
|
|
29
|
+
'supported_event_categories'?: Array<string>;
|
|
30
|
+
'supported_event_types'?: Array<string>;
|
|
31
|
+
}
|
|
32
|
+
export interface DataTypesAnalyticsConfigFunnelStages {
|
|
33
|
+
'description'?: string;
|
|
34
|
+
'examples'?: Array<string>;
|
|
35
|
+
}
|
|
36
|
+
export interface DataTypesAnalyticsConfigMetadataGuidelines {
|
|
37
|
+
'max_keys'?: number;
|
|
38
|
+
'max_value_length'?: number;
|
|
39
|
+
'reserved_keys'?: Array<string>;
|
|
40
|
+
}
|
|
19
41
|
export interface DataTypesAutocompleteSuggestion {
|
|
20
42
|
'highlight'?: {
|
|
21
43
|
[key: string]: any;
|
|
@@ -23,6 +45,16 @@ export interface DataTypesAutocompleteSuggestion {
|
|
|
23
45
|
'score'?: number;
|
|
24
46
|
'text'?: string;
|
|
25
47
|
}
|
|
48
|
+
export interface DataTypesBatchEventData {
|
|
49
|
+
'error_count'?: number;
|
|
50
|
+
'errors'?: Array<string>;
|
|
51
|
+
'processed_count'?: number;
|
|
52
|
+
'processed_events'?: Array<DataTypesBatchEventProcessedItem>;
|
|
53
|
+
}
|
|
54
|
+
export interface DataTypesBatchEventProcessedItem {
|
|
55
|
+
'event_id'?: string;
|
|
56
|
+
'timestamp'?: string;
|
|
57
|
+
}
|
|
26
58
|
export interface DataTypesBulkDocumentRequest {
|
|
27
59
|
/**
|
|
28
60
|
* Array of document operations
|
|
@@ -145,32 +177,6 @@ export interface DataTypesConfigurationSchemaResponseWrapper {
|
|
|
145
177
|
'message'?: string;
|
|
146
178
|
'status'?: number;
|
|
147
179
|
}
|
|
148
|
-
export interface DataTypesCreateStoreRequest {
|
|
149
|
-
/**
|
|
150
|
-
* Optional: array of documents to import immediately
|
|
151
|
-
*/
|
|
152
|
-
'dataset'?: Array<{
|
|
153
|
-
[key: string]: any;
|
|
154
|
-
}>;
|
|
155
|
-
'industry'?: string;
|
|
156
|
-
'location'?: string;
|
|
157
|
-
'storeName': string;
|
|
158
|
-
}
|
|
159
|
-
export interface DataTypesCreateStoreResponse {
|
|
160
|
-
/**
|
|
161
|
-
* Job ID if dataset was imported
|
|
162
|
-
*/
|
|
163
|
-
'importJobId'?: string;
|
|
164
|
-
/**
|
|
165
|
-
* Number of documents imported
|
|
166
|
-
*/
|
|
167
|
-
'importedCount'?: number;
|
|
168
|
-
'storeId'?: number;
|
|
169
|
-
'storeName'?: string;
|
|
170
|
-
'xStoreId'?: string;
|
|
171
|
-
'xStoreSecret'?: string;
|
|
172
|
-
'xStoreWriteSecret'?: string;
|
|
173
|
-
}
|
|
174
180
|
export interface DataTypesDocumentRequest {
|
|
175
181
|
/**
|
|
176
182
|
* Action: insert, update, upsert, delete (for bulk operations)
|
|
@@ -340,16 +346,13 @@ export interface DataTypesDropdownRecommendationsConfig {
|
|
|
340
346
|
}
|
|
341
347
|
export interface DataTypesEventPayload {
|
|
342
348
|
/**
|
|
343
|
-
*
|
|
349
|
+
* Experiment identifier
|
|
344
350
|
*/
|
|
345
351
|
'ab_test_id'?: string;
|
|
346
352
|
/**
|
|
347
353
|
* Variant assignment
|
|
348
354
|
*/
|
|
349
355
|
'ab_variant'?: string;
|
|
350
|
-
/**
|
|
351
|
-
* ============================================================================ Analytics & Metadata ============================================================================
|
|
352
|
-
*/
|
|
353
356
|
'analytics_tags'?: Array<string>;
|
|
354
357
|
/**
|
|
355
358
|
* V3 anonymous user ID
|
|
@@ -372,9 +375,6 @@ export interface DataTypesEventPayload {
|
|
|
372
375
|
* query, product, category, brand, trending, recent
|
|
373
376
|
*/
|
|
374
377
|
'click_type'?: string;
|
|
375
|
-
/**
|
|
376
|
-
* ============================================================================ Click/Interaction Event Fields (V3) ============================================================================
|
|
377
|
-
*/
|
|
378
378
|
'clicked_item_id'?: string;
|
|
379
379
|
'clicked_value'?: string;
|
|
380
380
|
'color_depth'?: number;
|
|
@@ -389,22 +389,16 @@ export interface DataTypesEventPayload {
|
|
|
389
389
|
*/
|
|
390
390
|
'conversion_type'?: string;
|
|
391
391
|
'correlation_id'?: string;
|
|
392
|
-
/**
|
|
393
|
-
* ============================================================================ Geo Context (V3) ============================================================================
|
|
394
|
-
*/
|
|
395
392
|
'country'?: string;
|
|
396
393
|
'country_code'?: string;
|
|
397
394
|
'currency'?: string;
|
|
398
395
|
'custom_json'?: string;
|
|
399
396
|
/**
|
|
400
|
-
*
|
|
397
|
+
* URL user navigates to after click
|
|
401
398
|
*/
|
|
402
399
|
'destination_url'?: string;
|
|
403
400
|
'device_fingerprint'?: string;
|
|
404
401
|
'device_type'?: string;
|
|
405
|
-
/**
|
|
406
|
-
* ============================================================================ Core Event Information (V3) ============================================================================
|
|
407
|
-
*/
|
|
408
402
|
'event_id'?: string;
|
|
409
403
|
'event_name'?: string;
|
|
410
404
|
/**
|
|
@@ -418,9 +412,6 @@ export interface DataTypesEventPayload {
|
|
|
418
412
|
* 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
|
|
419
413
|
*/
|
|
420
414
|
'insert_id'?: string;
|
|
421
|
-
/**
|
|
422
|
-
* ============================================================================ Device Context (V3) ============================================================================
|
|
423
|
-
*/
|
|
424
415
|
'ip'?: string;
|
|
425
416
|
'is_attributed'?: number;
|
|
426
417
|
/**
|
|
@@ -437,9 +428,6 @@ export interface DataTypesEventPayload {
|
|
|
437
428
|
'metadata'?: {
|
|
438
429
|
[key: string]: any;
|
|
439
430
|
};
|
|
440
|
-
/**
|
|
441
|
-
* ============================================================================ Suggestion Impression Fields (V3) ============================================================================
|
|
442
|
-
*/
|
|
443
431
|
'normalized_query'?: string;
|
|
444
432
|
/**
|
|
445
433
|
* Organization Context (V3 naming)
|
|
@@ -458,9 +446,6 @@ export interface DataTypesEventPayload {
|
|
|
458
446
|
'position'?: number;
|
|
459
447
|
'products_count'?: number;
|
|
460
448
|
'quantity'?: number;
|
|
461
|
-
/**
|
|
462
|
-
* ============================================================================ Search Event Fields ============================================================================
|
|
463
|
-
*/
|
|
464
449
|
'query'?: string;
|
|
465
450
|
'recent_count'?: number;
|
|
466
451
|
'region'?: string;
|
|
@@ -497,14 +482,8 @@ export interface DataTypesEventPayload {
|
|
|
497
482
|
'utm_campaign'?: string;
|
|
498
483
|
'utm_content'?: string;
|
|
499
484
|
'utm_medium'?: string;
|
|
500
|
-
/**
|
|
501
|
-
* ============================================================================ UTM Parameters ============================================================================
|
|
502
|
-
*/
|
|
503
485
|
'utm_source'?: string;
|
|
504
486
|
'utm_term'?: string;
|
|
505
|
-
/**
|
|
506
|
-
* ============================================================================ Business Context ============================================================================
|
|
507
|
-
*/
|
|
508
487
|
'value'?: number;
|
|
509
488
|
'viewport_height'?: number;
|
|
510
489
|
'viewport_width'?: number;
|
|
@@ -513,15 +492,13 @@ export interface DataTypesEventPayload {
|
|
|
513
492
|
*/
|
|
514
493
|
'xstoreid'?: string;
|
|
515
494
|
}
|
|
516
|
-
export interface
|
|
517
|
-
'
|
|
518
|
-
'
|
|
519
|
-
[key: string]: any;
|
|
520
|
-
};
|
|
521
|
-
'variant_id'?: string;
|
|
495
|
+
export interface DataTypesEventSubmitData {
|
|
496
|
+
'event_id'?: string;
|
|
497
|
+
'timestamp'?: string;
|
|
522
498
|
}
|
|
523
|
-
export interface
|
|
524
|
-
'
|
|
499
|
+
export interface DataTypesEventValidateData {
|
|
500
|
+
'event_name'?: string;
|
|
501
|
+
'event_type'?: string;
|
|
525
502
|
}
|
|
526
503
|
export interface DataTypesFacetRange {
|
|
527
504
|
/**
|
|
@@ -547,12 +524,6 @@ export interface DataTypesFacetRangeConfig {
|
|
|
547
524
|
*/
|
|
548
525
|
'ranges'?: Array<DataTypesFacetRange>;
|
|
549
526
|
}
|
|
550
|
-
export interface DataTypesFacetValuesSearchRequest {
|
|
551
|
-
'facet_query': string;
|
|
552
|
-
'filter'?: string;
|
|
553
|
-
'max_values'?: number;
|
|
554
|
-
'q'?: string;
|
|
555
|
-
}
|
|
556
527
|
export interface DataTypesFacetValuesSearchResponse {
|
|
557
528
|
'facet_name'?: string;
|
|
558
529
|
'values'?: Array<DataTypesFilterValue>;
|
|
@@ -660,13 +631,6 @@ export interface DataTypesFilteredTabConfig {
|
|
|
660
631
|
*/
|
|
661
632
|
'sort_by'?: string;
|
|
662
633
|
}
|
|
663
|
-
export interface DataTypesFiltersRequest {
|
|
664
|
-
'disjunctive_facets'?: Array<string>;
|
|
665
|
-
'facet_by'?: string;
|
|
666
|
-
'filter'?: string;
|
|
667
|
-
'max_facet_values'?: number;
|
|
668
|
-
'q'?: string;
|
|
669
|
-
}
|
|
670
634
|
export interface DataTypesFiltersResponse {
|
|
671
635
|
'filters'?: Array<DataTypesFilterField>;
|
|
672
636
|
'total_results'?: number;
|
|
@@ -686,8 +650,23 @@ export interface DataTypesFiltersSchemaResponseWrapper {
|
|
|
686
650
|
'message'?: string;
|
|
687
651
|
'status'?: number;
|
|
688
652
|
}
|
|
689
|
-
export interface
|
|
690
|
-
'data'?:
|
|
653
|
+
export interface DataTypesGenericResponseDataTypesAnalyticsConfigData {
|
|
654
|
+
'data'?: DataTypesAnalyticsConfigData;
|
|
655
|
+
'message'?: string;
|
|
656
|
+
'status'?: number;
|
|
657
|
+
}
|
|
658
|
+
export interface DataTypesGenericResponseDataTypesBatchEventData {
|
|
659
|
+
'data'?: DataTypesBatchEventData;
|
|
660
|
+
'message'?: string;
|
|
661
|
+
'status'?: number;
|
|
662
|
+
}
|
|
663
|
+
export interface DataTypesGenericResponseDataTypesEventSubmitData {
|
|
664
|
+
'data'?: DataTypesEventSubmitData;
|
|
665
|
+
'message'?: string;
|
|
666
|
+
'status'?: number;
|
|
667
|
+
}
|
|
668
|
+
export interface DataTypesGenericResponseDataTypesEventValidateData {
|
|
669
|
+
'data'?: DataTypesEventValidateData;
|
|
691
670
|
'message'?: string;
|
|
692
671
|
'status'?: number;
|
|
693
672
|
}
|
|
@@ -883,6 +862,10 @@ export interface DataTypesOnboardingStatus {
|
|
|
883
862
|
* Whether store is fully onboarded
|
|
884
863
|
*/
|
|
885
864
|
'is_complete'?: boolean;
|
|
865
|
+
/**
|
|
866
|
+
* Whether the check was unreliable due to transient infrastructure errors
|
|
867
|
+
*/
|
|
868
|
+
'is_degraded'?: boolean;
|
|
886
869
|
/**
|
|
887
870
|
* List of missing components
|
|
888
871
|
*/
|
|
@@ -984,70 +967,6 @@ export interface DataTypesSchemaResponseWrapper {
|
|
|
984
967
|
'message'?: string;
|
|
985
968
|
'status'?: number;
|
|
986
969
|
}
|
|
987
|
-
export interface DataTypesSearchRequest {
|
|
988
|
-
'analytics_tags'?: Array<string>;
|
|
989
|
-
/**
|
|
990
|
-
* Anonymous/cookie ID for personalization
|
|
991
|
-
*/
|
|
992
|
-
'anon_id'?: string;
|
|
993
|
-
'apply_rules'?: boolean;
|
|
994
|
-
'cache_results'?: boolean;
|
|
995
|
-
'exact_match_boost'?: boolean;
|
|
996
|
-
'facet_by'?: string;
|
|
997
|
-
'facet_search_text'?: string;
|
|
998
|
-
'field_weights'?: Array<number>;
|
|
999
|
-
'filter'?: string;
|
|
1000
|
-
'full_snippet_fields'?: Array<string>;
|
|
1001
|
-
'group_field'?: string;
|
|
1002
|
-
'group_size'?: number;
|
|
1003
|
-
'include_snippets'?: boolean;
|
|
1004
|
-
'include_suggestions'?: boolean;
|
|
1005
|
-
'infix_mode'?: string;
|
|
1006
|
-
'max_facet_values'?: number;
|
|
1007
|
-
'omit_fields'?: Array<string>;
|
|
1008
|
-
'page'?: number;
|
|
1009
|
-
'per_page'?: number;
|
|
1010
|
-
'prefix_mode'?: string;
|
|
1011
|
-
'preset_name'?: string;
|
|
1012
|
-
'q': string;
|
|
1013
|
-
'require_all_terms'?: boolean;
|
|
1014
|
-
'return_fields'?: Array<string>;
|
|
1015
|
-
/**
|
|
1016
|
-
* Advanced query controls (public-friendly field names)
|
|
1017
|
-
*/
|
|
1018
|
-
'search_fields'?: Array<string>;
|
|
1019
|
-
'search_timeout_ms'?: number;
|
|
1020
|
-
/**
|
|
1021
|
-
* Session ID for session-based personalization
|
|
1022
|
-
*/
|
|
1023
|
-
'session_id'?: string;
|
|
1024
|
-
'snippet_fields'?: Array<string>;
|
|
1025
|
-
'snippet_min_len'?: number;
|
|
1026
|
-
'snippet_prefix'?: string;
|
|
1027
|
-
'snippet_suffix'?: string;
|
|
1028
|
-
'snippet_token_limit'?: number;
|
|
1029
|
-
'sort'?: string;
|
|
1030
|
-
/**
|
|
1031
|
-
* IDs of stopword sets to use
|
|
1032
|
-
*/
|
|
1033
|
-
'stopword_sets'?: Array<string>;
|
|
1034
|
-
'suggestions_limit'?: number;
|
|
1035
|
-
/**
|
|
1036
|
-
* IDs of synonym sets to use
|
|
1037
|
-
*/
|
|
1038
|
-
'synonym_sets'?: Array<string>;
|
|
1039
|
-
'typo_max'?: number;
|
|
1040
|
-
'typo_min_len_1'?: number;
|
|
1041
|
-
'typo_min_len_2'?: number;
|
|
1042
|
-
/**
|
|
1043
|
-
* Personalization fields (optional, backward compatible)
|
|
1044
|
-
*/
|
|
1045
|
-
'user_id'?: string;
|
|
1046
|
-
/**
|
|
1047
|
-
* If true, returns only display fields instead of full document (used in public API only)
|
|
1048
|
-
*/
|
|
1049
|
-
'widget_mode'?: boolean;
|
|
1050
|
-
}
|
|
1051
970
|
export interface DataTypesSearchResponse {
|
|
1052
971
|
'facets'?: any;
|
|
1053
972
|
'page'?: number;
|
|
@@ -1118,6 +1037,152 @@ export interface DataTypesStopwordEntry {
|
|
|
1118
1037
|
*/
|
|
1119
1038
|
'stopwords'?: Array<string>;
|
|
1120
1039
|
}
|
|
1040
|
+
export interface DataTypesStoreConfigUpdateRequest {
|
|
1041
|
+
/**
|
|
1042
|
+
* Optional: If set, updates the public search flag
|
|
1043
|
+
*/
|
|
1044
|
+
'allow_public_search'?: boolean;
|
|
1045
|
+
'collection_alias'?: string;
|
|
1046
|
+
'collection_name'?: string;
|
|
1047
|
+
'default_sorting_field'?: string;
|
|
1048
|
+
/**
|
|
1049
|
+
* Default stopwords set ID to use in searches
|
|
1050
|
+
*/
|
|
1051
|
+
'default_stopwords_set'?: string;
|
|
1052
|
+
'drop_tokens_threshold'?: number;
|
|
1053
|
+
/**
|
|
1054
|
+
* Dropdown recommendations configuration
|
|
1055
|
+
*/
|
|
1056
|
+
'dropdown_recommendations_config'?: DataTypesDropdownRecommendationsConfig;
|
|
1057
|
+
'embed'?: string;
|
|
1058
|
+
'enable_autocomplete'?: boolean;
|
|
1059
|
+
'enable_highlight'?: boolean;
|
|
1060
|
+
'enable_overrides'?: boolean;
|
|
1061
|
+
'enable_smart_autocomplete'?: boolean;
|
|
1062
|
+
/**
|
|
1063
|
+
* Enable stemming on search collections
|
|
1064
|
+
*/
|
|
1065
|
+
'enable_stemming'?: boolean;
|
|
1066
|
+
'enable_typo_highlight'?: boolean;
|
|
1067
|
+
'enable_typo_tolerance'?: boolean;
|
|
1068
|
+
/**
|
|
1069
|
+
* No omitempty to preserve empty arrays
|
|
1070
|
+
*/
|
|
1071
|
+
'exclude_fields'?: Array<string>;
|
|
1072
|
+
'exhaustive_search'?: boolean;
|
|
1073
|
+
/**
|
|
1074
|
+
* No omitempty to preserve empty arrays
|
|
1075
|
+
*/
|
|
1076
|
+
'facet_by'?: Array<string>;
|
|
1077
|
+
'facet_query'?: string;
|
|
1078
|
+
/**
|
|
1079
|
+
* No omitempty to preserve empty arrays
|
|
1080
|
+
*/
|
|
1081
|
+
'facet_ranges'?: Array<DataTypesFacetRangeConfig>;
|
|
1082
|
+
'filter_by'?: string;
|
|
1083
|
+
'group_by'?: string;
|
|
1084
|
+
'group_limit'?: number;
|
|
1085
|
+
/**
|
|
1086
|
+
* No omitempty to preserve empty arrays
|
|
1087
|
+
*/
|
|
1088
|
+
'hidden_facet_fields'?: Array<string>;
|
|
1089
|
+
/**
|
|
1090
|
+
* No omitempty to preserve empty arrays
|
|
1091
|
+
*/
|
|
1092
|
+
'hidden_fields'?: Array<string>;
|
|
1093
|
+
/**
|
|
1094
|
+
* No omitempty to preserve empty arrays
|
|
1095
|
+
*/
|
|
1096
|
+
'hidden_filter_fields'?: Array<string>;
|
|
1097
|
+
'highlight_affix_num_tokens'?: number;
|
|
1098
|
+
'highlight_end_tag'?: string;
|
|
1099
|
+
/**
|
|
1100
|
+
* No omitempty to preserve empty arrays
|
|
1101
|
+
*/
|
|
1102
|
+
'highlight_fields'?: Array<string>;
|
|
1103
|
+
/**
|
|
1104
|
+
* No omitempty to preserve empty arrays
|
|
1105
|
+
*/
|
|
1106
|
+
'highlight_full_fields'?: Array<string>;
|
|
1107
|
+
'highlight_start_tag'?: string;
|
|
1108
|
+
'image_url'?: string;
|
|
1109
|
+
/**
|
|
1110
|
+
* No omitempty to preserve empty arrays
|
|
1111
|
+
*/
|
|
1112
|
+
'include_fields'?: Array<string>;
|
|
1113
|
+
/**
|
|
1114
|
+
* \"always\", \"fallback\", or \"off\"
|
|
1115
|
+
*/
|
|
1116
|
+
'infix'?: string;
|
|
1117
|
+
'locale'?: string;
|
|
1118
|
+
'max_candidates'?: number;
|
|
1119
|
+
'max_facet_values'?: number;
|
|
1120
|
+
'min_len_1typo'?: number;
|
|
1121
|
+
'min_len_2typo'?: number;
|
|
1122
|
+
'num_typos'?: number;
|
|
1123
|
+
'page'?: number;
|
|
1124
|
+
'per_page'?: number;
|
|
1125
|
+
'prefix'?: string;
|
|
1126
|
+
'preset'?: string;
|
|
1127
|
+
'primary_text'?: string;
|
|
1128
|
+
'prioritize_exact_match'?: boolean;
|
|
1129
|
+
/**
|
|
1130
|
+
* Required: Query string
|
|
1131
|
+
*/
|
|
1132
|
+
'q'?: string;
|
|
1133
|
+
/**
|
|
1134
|
+
* Required: Array of search fields
|
|
1135
|
+
*/
|
|
1136
|
+
'query_by'?: Array<string>;
|
|
1137
|
+
/**
|
|
1138
|
+
* Optional: Relative field weights as array (no omitempty to preserve empty arrays)
|
|
1139
|
+
*/
|
|
1140
|
+
'query_by_weights'?: Array<number>;
|
|
1141
|
+
/**
|
|
1142
|
+
* Query suggestions configuration
|
|
1143
|
+
*/
|
|
1144
|
+
'query_suggestions_config'?: DataTypesQuerySuggestionsConfig;
|
|
1145
|
+
'query_syntax'?: boolean;
|
|
1146
|
+
'search_cutoff_ms'?: number;
|
|
1147
|
+
/**
|
|
1148
|
+
* \"text\", \"vector\", \"hybrid\"
|
|
1149
|
+
*/
|
|
1150
|
+
'search_strategy'?: string;
|
|
1151
|
+
'secondary_text'?: string;
|
|
1152
|
+
'semantic_ranker'?: boolean;
|
|
1153
|
+
'snippet_threshold'?: number;
|
|
1154
|
+
/**
|
|
1155
|
+
* No omitempty to preserve empty arrays
|
|
1156
|
+
*/
|
|
1157
|
+
'sort_by'?: Array<DataTypesSortField>;
|
|
1158
|
+
/**
|
|
1159
|
+
* Locale for stemming (e.g., \"en\", \"fr\", \"de\")
|
|
1160
|
+
*/
|
|
1161
|
+
'stemming_locale'?: string;
|
|
1162
|
+
/**
|
|
1163
|
+
* Flattened stopwords and synonyms fields
|
|
1164
|
+
*/
|
|
1165
|
+
'stopwords'?: Array<DataTypesStopwordEntry>;
|
|
1166
|
+
/**
|
|
1167
|
+
* No omitempty to preserve empty arrays
|
|
1168
|
+
*/
|
|
1169
|
+
'symbols_to_index'?: Array<string>;
|
|
1170
|
+
/**
|
|
1171
|
+
* No omitempty to preserve empty arrays
|
|
1172
|
+
*/
|
|
1173
|
+
'synonyms'?: Array<DataTypesSynonymEntry>;
|
|
1174
|
+
'tertiary_text'?: string;
|
|
1175
|
+
/**
|
|
1176
|
+
* Optional: Search-only scoped API key
|
|
1177
|
+
*/
|
|
1178
|
+
'token'?: string;
|
|
1179
|
+
/**
|
|
1180
|
+
* No omitempty to preserve empty arrays
|
|
1181
|
+
*/
|
|
1182
|
+
'token_separators'?: Array<string>;
|
|
1183
|
+
'use_cache'?: boolean;
|
|
1184
|
+
'vector_query'?: string;
|
|
1185
|
+
}
|
|
1121
1186
|
export interface DataTypesStoreConfigWithOnboardingResponse {
|
|
1122
1187
|
/**
|
|
1123
1188
|
* If true, allows search without authentication
|
|
@@ -1140,7 +1205,6 @@ export interface DataTypesStoreInfoResponse {
|
|
|
1140
1205
|
'createdAt'?: string;
|
|
1141
1206
|
'isActive'?: boolean;
|
|
1142
1207
|
'location'?: string;
|
|
1143
|
-
'storeId'?: number;
|
|
1144
1208
|
'storeName'?: string;
|
|
1145
1209
|
'xStoreId'?: string;
|
|
1146
1210
|
}
|
|
@@ -1498,88 +1562,6 @@ export interface QuerySuggestionsServiceQuerySuggestionsConfig {
|
|
|
1498
1562
|
*/
|
|
1499
1563
|
'supported_time_ranges'?: Array<string>;
|
|
1500
1564
|
}
|
|
1501
|
-
export interface QuerySuggestionsServiceQuerySuggestionsRequest {
|
|
1502
|
-
/**
|
|
1503
|
-
* Filter suggestions by analytics tags
|
|
1504
|
-
*/
|
|
1505
|
-
'analytics_tags'?: Array<string>;
|
|
1506
|
-
/**
|
|
1507
|
-
* Anonymous/cookie ID for personalization
|
|
1508
|
-
*/
|
|
1509
|
-
'anon_id'?: string;
|
|
1510
|
-
/**
|
|
1511
|
-
* Disable fuzzy matching
|
|
1512
|
-
*/
|
|
1513
|
-
'disable_typo_tolerance'?: boolean;
|
|
1514
|
-
/**
|
|
1515
|
-
* Filtered tabs (optional, overrides config if provided)
|
|
1516
|
-
*/
|
|
1517
|
-
'filtered_tabs'?: Array<DataTypesFilteredTabConfig>;
|
|
1518
|
-
/**
|
|
1519
|
-
* Number of suggestions to return (default: 5)
|
|
1520
|
-
*/
|
|
1521
|
-
'hitsPerPage'?: number;
|
|
1522
|
-
/**
|
|
1523
|
-
* Include category information
|
|
1524
|
-
*/
|
|
1525
|
-
'include_categories'?: boolean;
|
|
1526
|
-
/**
|
|
1527
|
-
* Optional: disable parts of dropdown when include_dropdown_recommendations=true (default true = include)
|
|
1528
|
-
*/
|
|
1529
|
-
'include_dropdown_product_list'?: boolean;
|
|
1530
|
-
/**
|
|
1531
|
-
* Rich dropdown recommendations (optional, data-agnostic)
|
|
1532
|
-
*/
|
|
1533
|
-
'include_dropdown_recommendations'?: boolean;
|
|
1534
|
-
/**
|
|
1535
|
-
* Empty query recommendations - show meaningful suggestions when no query is entered When true and query is empty, returns popular/trending suggestions instead of an empty array
|
|
1536
|
-
*/
|
|
1537
|
-
'include_empty_query_recommendations'?: boolean;
|
|
1538
|
-
/**
|
|
1539
|
-
* Include facet information
|
|
1540
|
-
*/
|
|
1541
|
-
'include_facets'?: boolean;
|
|
1542
|
-
/**
|
|
1543
|
-
* When false, omit filtered_tabs from dropdown extensions (default true)
|
|
1544
|
-
*/
|
|
1545
|
-
'include_filtered_tabs'?: boolean;
|
|
1546
|
-
/**
|
|
1547
|
-
* Max categories per suggestion (default: 3)
|
|
1548
|
-
*/
|
|
1549
|
-
'max_categories'?: number;
|
|
1550
|
-
/**
|
|
1551
|
-
* Max facets per suggestion (default: 5)
|
|
1552
|
-
*/
|
|
1553
|
-
'max_facets'?: number;
|
|
1554
|
-
/**
|
|
1555
|
-
* Minimum popularity threshold
|
|
1556
|
-
*/
|
|
1557
|
-
'min_popularity'?: number;
|
|
1558
|
-
/**
|
|
1559
|
-
* Page number for pagination (default: 0)
|
|
1560
|
-
*/
|
|
1561
|
-
'page'?: number;
|
|
1562
|
-
/**
|
|
1563
|
-
* Partial query to get suggestions for
|
|
1564
|
-
*/
|
|
1565
|
-
'query'?: string;
|
|
1566
|
-
/**
|
|
1567
|
-
* Session ID for session-based personalization
|
|
1568
|
-
*/
|
|
1569
|
-
'session_id'?: string;
|
|
1570
|
-
/**
|
|
1571
|
-
* \"any\" or \"all\" for analytics tags
|
|
1572
|
-
*/
|
|
1573
|
-
'tags_match_mode'?: string;
|
|
1574
|
-
/**
|
|
1575
|
-
* \"7d\", \"30d\", \"90d\" (default: \"30d\")
|
|
1576
|
-
*/
|
|
1577
|
-
'time_range'?: string;
|
|
1578
|
-
/**
|
|
1579
|
-
* Personalization fields (optional, backward compatible)
|
|
1580
|
-
*/
|
|
1581
|
-
'user_id'?: string;
|
|
1582
|
-
}
|
|
1583
1565
|
export interface QuerySuggestionsServiceQuerySuggestionsResponse {
|
|
1584
1566
|
/**
|
|
1585
1567
|
* Rich dropdown recommendations (optional, only when include_dropdown_recommendations=true)
|
|
@@ -1819,7 +1801,7 @@ export interface QuerySuggestionsServiceUpdateSuggestionConfigRequest {
|
|
|
1819
1801
|
*/
|
|
1820
1802
|
'minimum_hits'?: number;
|
|
1821
1803
|
/**
|
|
1822
|
-
*
|
|
1804
|
+
* Extended fields
|
|
1823
1805
|
*/
|
|
1824
1806
|
'minimum_letters'?: number;
|
|
1825
1807
|
/**
|
|
@@ -1944,7 +1926,7 @@ export declare const AnalyticsEventsApiFp: (configuration?: Configuration) => {
|
|
|
1944
1926
|
* @param {*} [options] Override http request option.
|
|
1945
1927
|
* @throws {RequiredError}
|
|
1946
1928
|
*/
|
|
1947
|
-
analyticsBatchPost(xStoreid: string, xStoresecret: string, analyticsBatchPostRequest: AnalyticsBatchPostRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<
|
|
1929
|
+
analyticsBatchPost(xStoreid: string, xStoresecret: string, analyticsBatchPostRequest: AnalyticsBatchPostRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesGenericResponseDataTypesBatchEventData>>;
|
|
1948
1930
|
/**
|
|
1949
1931
|
* Retrieve analytics configuration including supported event types, batch limits, and funnel stages for client integration
|
|
1950
1932
|
* @summary Get Analytics Configuration
|
|
@@ -1953,7 +1935,7 @@ export declare const AnalyticsEventsApiFp: (configuration?: Configuration) => {
|
|
|
1953
1935
|
* @param {*} [options] Override http request option.
|
|
1954
1936
|
* @throws {RequiredError}
|
|
1955
1937
|
*/
|
|
1956
|
-
analyticsConfigGet(xStoreid: string, xStoresecret: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<
|
|
1938
|
+
analyticsConfigGet(xStoreid: string, xStoresecret: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesGenericResponseDataTypesAnalyticsConfigData>>;
|
|
1957
1939
|
/**
|
|
1958
1940
|
* Submit a single analytics event for tracking user interactions, search behavior, and conversions
|
|
1959
1941
|
* @summary Submit Analytics Event
|
|
@@ -1963,7 +1945,7 @@ export declare const AnalyticsEventsApiFp: (configuration?: Configuration) => {
|
|
|
1963
1945
|
* @param {*} [options] Override http request option.
|
|
1964
1946
|
* @throws {RequiredError}
|
|
1965
1947
|
*/
|
|
1966
|
-
analyticsEventPost(xStoreid: string, xStoresecret: string, dataTypesEventPayload: DataTypesEventPayload, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<
|
|
1948
|
+
analyticsEventPost(xStoreid: string, xStoresecret: string, dataTypesEventPayload: DataTypesEventPayload, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesGenericResponseDataTypesEventSubmitData>>;
|
|
1967
1949
|
/**
|
|
1968
1950
|
* Retrieve the complete event schema including required and optional fields, data types, and validation rules
|
|
1969
1951
|
* @summary Get Event Schema
|
|
@@ -1982,7 +1964,7 @@ export declare const AnalyticsEventsApiFp: (configuration?: Configuration) => {
|
|
|
1982
1964
|
* @param {*} [options] Override http request option.
|
|
1983
1965
|
* @throws {RequiredError}
|
|
1984
1966
|
*/
|
|
1985
|
-
analyticsValidatePost(xStoreid: string, xStoresecret: string, dataTypesEventPayload: DataTypesEventPayload, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<
|
|
1967
|
+
analyticsValidatePost(xStoreid: string, xStoresecret: string, dataTypesEventPayload: DataTypesEventPayload, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesGenericResponseDataTypesEventValidateData>>;
|
|
1986
1968
|
};
|
|
1987
1969
|
/**
|
|
1988
1970
|
* AnalyticsEventsApi - factory interface
|
|
@@ -1997,7 +1979,7 @@ export declare const AnalyticsEventsApiFactory: (configuration?: Configuration,
|
|
|
1997
1979
|
* @param {*} [options] Override http request option.
|
|
1998
1980
|
* @throws {RequiredError}
|
|
1999
1981
|
*/
|
|
2000
|
-
analyticsBatchPost(xStoreid: string, xStoresecret: string, analyticsBatchPostRequest: AnalyticsBatchPostRequest, options?: RawAxiosRequestConfig): AxiosPromise<
|
|
1982
|
+
analyticsBatchPost(xStoreid: string, xStoresecret: string, analyticsBatchPostRequest: AnalyticsBatchPostRequest, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesGenericResponseDataTypesBatchEventData>;
|
|
2001
1983
|
/**
|
|
2002
1984
|
* Retrieve analytics configuration including supported event types, batch limits, and funnel stages for client integration
|
|
2003
1985
|
* @summary Get Analytics Configuration
|
|
@@ -2006,7 +1988,7 @@ export declare const AnalyticsEventsApiFactory: (configuration?: Configuration,
|
|
|
2006
1988
|
* @param {*} [options] Override http request option.
|
|
2007
1989
|
* @throws {RequiredError}
|
|
2008
1990
|
*/
|
|
2009
|
-
analyticsConfigGet(xStoreid: string, xStoresecret: string, options?: RawAxiosRequestConfig): AxiosPromise<
|
|
1991
|
+
analyticsConfigGet(xStoreid: string, xStoresecret: string, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesGenericResponseDataTypesAnalyticsConfigData>;
|
|
2010
1992
|
/**
|
|
2011
1993
|
* Submit a single analytics event for tracking user interactions, search behavior, and conversions
|
|
2012
1994
|
* @summary Submit Analytics Event
|
|
@@ -2016,7 +1998,7 @@ export declare const AnalyticsEventsApiFactory: (configuration?: Configuration,
|
|
|
2016
1998
|
* @param {*} [options] Override http request option.
|
|
2017
1999
|
* @throws {RequiredError}
|
|
2018
2000
|
*/
|
|
2019
|
-
analyticsEventPost(xStoreid: string, xStoresecret: string, dataTypesEventPayload: DataTypesEventPayload, options?: RawAxiosRequestConfig): AxiosPromise<
|
|
2001
|
+
analyticsEventPost(xStoreid: string, xStoresecret: string, dataTypesEventPayload: DataTypesEventPayload, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesGenericResponseDataTypesEventSubmitData>;
|
|
2020
2002
|
/**
|
|
2021
2003
|
* Retrieve the complete event schema including required and optional fields, data types, and validation rules
|
|
2022
2004
|
* @summary Get Event Schema
|
|
@@ -2035,7 +2017,7 @@ export declare const AnalyticsEventsApiFactory: (configuration?: Configuration,
|
|
|
2035
2017
|
* @param {*} [options] Override http request option.
|
|
2036
2018
|
* @throws {RequiredError}
|
|
2037
2019
|
*/
|
|
2038
|
-
analyticsValidatePost(xStoreid: string, xStoresecret: string, dataTypesEventPayload: DataTypesEventPayload, options?: RawAxiosRequestConfig): AxiosPromise<
|
|
2020
|
+
analyticsValidatePost(xStoreid: string, xStoresecret: string, dataTypesEventPayload: DataTypesEventPayload, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesGenericResponseDataTypesEventValidateData>;
|
|
2039
2021
|
};
|
|
2040
2022
|
/**
|
|
2041
2023
|
* AnalyticsEventsApi - object-oriented interface
|
|
@@ -2050,7 +2032,7 @@ export declare class AnalyticsEventsApi extends BaseAPI {
|
|
|
2050
2032
|
* @param {*} [options] Override http request option.
|
|
2051
2033
|
* @throws {RequiredError}
|
|
2052
2034
|
*/
|
|
2053
|
-
analyticsBatchPost(xStoreid: string, xStoresecret: string, analyticsBatchPostRequest: AnalyticsBatchPostRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<
|
|
2035
|
+
analyticsBatchPost(xStoreid: string, xStoresecret: string, analyticsBatchPostRequest: AnalyticsBatchPostRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesGenericResponseDataTypesBatchEventData, any, {}>>;
|
|
2054
2036
|
/**
|
|
2055
2037
|
* Retrieve analytics configuration including supported event types, batch limits, and funnel stages for client integration
|
|
2056
2038
|
* @summary Get Analytics Configuration
|
|
@@ -2059,7 +2041,7 @@ export declare class AnalyticsEventsApi extends BaseAPI {
|
|
|
2059
2041
|
* @param {*} [options] Override http request option.
|
|
2060
2042
|
* @throws {RequiredError}
|
|
2061
2043
|
*/
|
|
2062
|
-
analyticsConfigGet(xStoreid: string, xStoresecret: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<
|
|
2044
|
+
analyticsConfigGet(xStoreid: string, xStoresecret: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesGenericResponseDataTypesAnalyticsConfigData, any, {}>>;
|
|
2063
2045
|
/**
|
|
2064
2046
|
* Submit a single analytics event for tracking user interactions, search behavior, and conversions
|
|
2065
2047
|
* @summary Submit Analytics Event
|
|
@@ -2069,7 +2051,7 @@ export declare class AnalyticsEventsApi extends BaseAPI {
|
|
|
2069
2051
|
* @param {*} [options] Override http request option.
|
|
2070
2052
|
* @throws {RequiredError}
|
|
2071
2053
|
*/
|
|
2072
|
-
analyticsEventPost(xStoreid: string, xStoresecret: string, dataTypesEventPayload: DataTypesEventPayload, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<
|
|
2054
|
+
analyticsEventPost(xStoreid: string, xStoresecret: string, dataTypesEventPayload: DataTypesEventPayload, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesGenericResponseDataTypesEventSubmitData, any, {}>>;
|
|
2073
2055
|
/**
|
|
2074
2056
|
* Retrieve the complete event schema including required and optional fields, data types, and validation rules
|
|
2075
2057
|
* @summary Get Event Schema
|
|
@@ -2088,7 +2070,7 @@ export declare class AnalyticsEventsApi extends BaseAPI {
|
|
|
2088
2070
|
* @param {*} [options] Override http request option.
|
|
2089
2071
|
* @throws {RequiredError}
|
|
2090
2072
|
*/
|
|
2091
|
-
analyticsValidatePost(xStoreid: string, xStoresecret: string, dataTypesEventPayload: DataTypesEventPayload, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<
|
|
2073
|
+
analyticsValidatePost(xStoreid: string, xStoresecret: string, dataTypesEventPayload: DataTypesEventPayload, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesGenericResponseDataTypesEventValidateData, any, {}>>;
|
|
2092
2074
|
}
|
|
2093
2075
|
/**
|
|
2094
2076
|
* FiltersApi - axios parameter creator
|
|
@@ -2100,21 +2082,28 @@ export declare const FiltersApiAxiosParamCreator: (configuration?: Configuration
|
|
|
2100
2082
|
* @param {string} xStoreid Store ID (from dashboard)
|
|
2101
2083
|
* @param {string} xStoresecret Store read secret (from dashboard)
|
|
2102
2084
|
* @param {string} facetName Facet field name (e.g., brand, category)
|
|
2103
|
-
* @param {
|
|
2085
|
+
* @param {string} facetQuery Prefix to search within the facet values
|
|
2086
|
+
* @param {string} [q] Search query to scope results
|
|
2087
|
+
* @param {string} [filter] Filter expression to scope results
|
|
2088
|
+
* @param {number} [maxValues] Maximum number of facet values to return
|
|
2104
2089
|
* @param {*} [options] Override http request option.
|
|
2105
2090
|
* @throws {RequiredError}
|
|
2106
2091
|
*/
|
|
2107
|
-
|
|
2092
|
+
v1FiltersFacetNameValuesGet: (xStoreid: string, xStoresecret: string, facetName: string, facetQuery: string, q?: string, filter?: string, maxValues?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
2108
2093
|
/**
|
|
2109
2094
|
* Get filter values and counts for configured facets. Use this to build faceted navigation UIs. Supports disjunctive faceting for OR-based filter combinations.
|
|
2110
2095
|
* @summary Get Filters
|
|
2111
2096
|
* @param {string} xStoreid Store ID (from dashboard)
|
|
2112
2097
|
* @param {string} xStoresecret Store read secret (from dashboard)
|
|
2113
|
-
* @param {
|
|
2098
|
+
* @param {string} [q] Search query to scope filter counts
|
|
2099
|
+
* @param {string} [filter] Filter expression (e.g. brand:=Nike)
|
|
2100
|
+
* @param {string} [facetBy] Comma-separated list of facet fields to return
|
|
2101
|
+
* @param {number} [maxFacetValues] Maximum number of values per facet
|
|
2102
|
+
* @param {string} [disjunctiveFacets] Comma-separated facet fields to treat as disjunctive (OR)
|
|
2114
2103
|
* @param {*} [options] Override http request option.
|
|
2115
2104
|
* @throws {RequiredError}
|
|
2116
2105
|
*/
|
|
2117
|
-
|
|
2106
|
+
v1FiltersGet: (xStoreid: string, xStoresecret: string, q?: string, filter?: string, facetBy?: string, maxFacetValues?: number, disjunctiveFacets?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
2118
2107
|
/**
|
|
2119
2108
|
* Get available filter field metadata including types, sortability, and configured ranges. Useful for dynamically building filter UIs.
|
|
2120
2109
|
* @summary Get Filters Schema
|
|
@@ -2135,21 +2124,28 @@ export declare const FiltersApiFp: (configuration?: Configuration) => {
|
|
|
2135
2124
|
* @param {string} xStoreid Store ID (from dashboard)
|
|
2136
2125
|
* @param {string} xStoresecret Store read secret (from dashboard)
|
|
2137
2126
|
* @param {string} facetName Facet field name (e.g., brand, category)
|
|
2138
|
-
* @param {
|
|
2127
|
+
* @param {string} facetQuery Prefix to search within the facet values
|
|
2128
|
+
* @param {string} [q] Search query to scope results
|
|
2129
|
+
* @param {string} [filter] Filter expression to scope results
|
|
2130
|
+
* @param {number} [maxValues] Maximum number of facet values to return
|
|
2139
2131
|
* @param {*} [options] Override http request option.
|
|
2140
2132
|
* @throws {RequiredError}
|
|
2141
2133
|
*/
|
|
2142
|
-
|
|
2134
|
+
v1FiltersFacetNameValuesGet(xStoreid: string, xStoresecret: string, facetName: string, facetQuery: string, q?: string, filter?: string, maxValues?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesFacetValuesSearchResponseWrapper>>;
|
|
2143
2135
|
/**
|
|
2144
2136
|
* Get filter values and counts for configured facets. Use this to build faceted navigation UIs. Supports disjunctive faceting for OR-based filter combinations.
|
|
2145
2137
|
* @summary Get Filters
|
|
2146
2138
|
* @param {string} xStoreid Store ID (from dashboard)
|
|
2147
2139
|
* @param {string} xStoresecret Store read secret (from dashboard)
|
|
2148
|
-
* @param {
|
|
2140
|
+
* @param {string} [q] Search query to scope filter counts
|
|
2141
|
+
* @param {string} [filter] Filter expression (e.g. brand:=Nike)
|
|
2142
|
+
* @param {string} [facetBy] Comma-separated list of facet fields to return
|
|
2143
|
+
* @param {number} [maxFacetValues] Maximum number of values per facet
|
|
2144
|
+
* @param {string} [disjunctiveFacets] Comma-separated facet fields to treat as disjunctive (OR)
|
|
2149
2145
|
* @param {*} [options] Override http request option.
|
|
2150
2146
|
* @throws {RequiredError}
|
|
2151
2147
|
*/
|
|
2152
|
-
|
|
2148
|
+
v1FiltersGet(xStoreid: string, xStoresecret: string, q?: string, filter?: string, facetBy?: string, maxFacetValues?: number, disjunctiveFacets?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesFiltersResponseWrapper>>;
|
|
2153
2149
|
/**
|
|
2154
2150
|
* Get available filter field metadata including types, sortability, and configured ranges. Useful for dynamically building filter UIs.
|
|
2155
2151
|
* @summary Get Filters Schema
|
|
@@ -2170,21 +2166,28 @@ export declare const FiltersApiFactory: (configuration?: Configuration, basePath
|
|
|
2170
2166
|
* @param {string} xStoreid Store ID (from dashboard)
|
|
2171
2167
|
* @param {string} xStoresecret Store read secret (from dashboard)
|
|
2172
2168
|
* @param {string} facetName Facet field name (e.g., brand, category)
|
|
2173
|
-
* @param {
|
|
2169
|
+
* @param {string} facetQuery Prefix to search within the facet values
|
|
2170
|
+
* @param {string} [q] Search query to scope results
|
|
2171
|
+
* @param {string} [filter] Filter expression to scope results
|
|
2172
|
+
* @param {number} [maxValues] Maximum number of facet values to return
|
|
2174
2173
|
* @param {*} [options] Override http request option.
|
|
2175
2174
|
* @throws {RequiredError}
|
|
2176
2175
|
*/
|
|
2177
|
-
|
|
2176
|
+
v1FiltersFacetNameValuesGet(xStoreid: string, xStoresecret: string, facetName: string, facetQuery: string, q?: string, filter?: string, maxValues?: number, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesFacetValuesSearchResponseWrapper>;
|
|
2178
2177
|
/**
|
|
2179
2178
|
* Get filter values and counts for configured facets. Use this to build faceted navigation UIs. Supports disjunctive faceting for OR-based filter combinations.
|
|
2180
2179
|
* @summary Get Filters
|
|
2181
2180
|
* @param {string} xStoreid Store ID (from dashboard)
|
|
2182
2181
|
* @param {string} xStoresecret Store read secret (from dashboard)
|
|
2183
|
-
* @param {
|
|
2182
|
+
* @param {string} [q] Search query to scope filter counts
|
|
2183
|
+
* @param {string} [filter] Filter expression (e.g. brand:=Nike)
|
|
2184
|
+
* @param {string} [facetBy] Comma-separated list of facet fields to return
|
|
2185
|
+
* @param {number} [maxFacetValues] Maximum number of values per facet
|
|
2186
|
+
* @param {string} [disjunctiveFacets] Comma-separated facet fields to treat as disjunctive (OR)
|
|
2184
2187
|
* @param {*} [options] Override http request option.
|
|
2185
2188
|
* @throws {RequiredError}
|
|
2186
2189
|
*/
|
|
2187
|
-
|
|
2190
|
+
v1FiltersGet(xStoreid: string, xStoresecret: string, q?: string, filter?: string, facetBy?: string, maxFacetValues?: number, disjunctiveFacets?: string, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesFiltersResponseWrapper>;
|
|
2188
2191
|
/**
|
|
2189
2192
|
* Get available filter field metadata including types, sortability, and configured ranges. Useful for dynamically building filter UIs.
|
|
2190
2193
|
* @summary Get Filters Schema
|
|
@@ -2205,21 +2208,28 @@ export declare class FiltersApi extends BaseAPI {
|
|
|
2205
2208
|
* @param {string} xStoreid Store ID (from dashboard)
|
|
2206
2209
|
* @param {string} xStoresecret Store read secret (from dashboard)
|
|
2207
2210
|
* @param {string} facetName Facet field name (e.g., brand, category)
|
|
2208
|
-
* @param {
|
|
2211
|
+
* @param {string} facetQuery Prefix to search within the facet values
|
|
2212
|
+
* @param {string} [q] Search query to scope results
|
|
2213
|
+
* @param {string} [filter] Filter expression to scope results
|
|
2214
|
+
* @param {number} [maxValues] Maximum number of facet values to return
|
|
2209
2215
|
* @param {*} [options] Override http request option.
|
|
2210
2216
|
* @throws {RequiredError}
|
|
2211
2217
|
*/
|
|
2212
|
-
|
|
2218
|
+
v1FiltersFacetNameValuesGet(xStoreid: string, xStoresecret: string, facetName: string, facetQuery: string, q?: string, filter?: string, maxValues?: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesFacetValuesSearchResponseWrapper, any, {}>>;
|
|
2213
2219
|
/**
|
|
2214
2220
|
* Get filter values and counts for configured facets. Use this to build faceted navigation UIs. Supports disjunctive faceting for OR-based filter combinations.
|
|
2215
2221
|
* @summary Get Filters
|
|
2216
2222
|
* @param {string} xStoreid Store ID (from dashboard)
|
|
2217
2223
|
* @param {string} xStoresecret Store read secret (from dashboard)
|
|
2218
|
-
* @param {
|
|
2224
|
+
* @param {string} [q] Search query to scope filter counts
|
|
2225
|
+
* @param {string} [filter] Filter expression (e.g. brand:=Nike)
|
|
2226
|
+
* @param {string} [facetBy] Comma-separated list of facet fields to return
|
|
2227
|
+
* @param {number} [maxFacetValues] Maximum number of values per facet
|
|
2228
|
+
* @param {string} [disjunctiveFacets] Comma-separated facet fields to treat as disjunctive (OR)
|
|
2219
2229
|
* @param {*} [options] Override http request option.
|
|
2220
2230
|
* @throws {RequiredError}
|
|
2221
2231
|
*/
|
|
2222
|
-
|
|
2232
|
+
v1FiltersGet(xStoreid: string, xStoresecret: string, q?: string, filter?: string, facetBy?: string, maxFacetValues?: number, disjunctiveFacets?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesFiltersResponseWrapper, any, {}>>;
|
|
2223
2233
|
/**
|
|
2224
2234
|
* Get available filter field metadata including types, sortability, and configured ranges. Useful for dynamically building filter UIs.
|
|
2225
2235
|
* @summary Get Filters Schema
|
|
@@ -2276,19 +2286,6 @@ export declare const QuerySuggestionsApiAxiosParamCreator: (configuration?: Conf
|
|
|
2276
2286
|
* @throws {RequiredError}
|
|
2277
2287
|
*/
|
|
2278
2288
|
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>;
|
|
2279
|
-
/**
|
|
2280
|
-
* 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.
|
|
2281
|
-
* @summary Get query suggestions (POST)
|
|
2282
|
-
* @param {string} xStoreid Store ID (from dashboard)
|
|
2283
|
-
* @param {string} xStoresecret Store read secret
|
|
2284
|
-
* @param {string} [xUserId] User ID for personalization
|
|
2285
|
-
* @param {string} [xAnonId] Anonymous user ID for personalization
|
|
2286
|
-
* @param {string} [xSessionId] Session ID for personalization
|
|
2287
|
-
* @param {QuerySuggestionsServiceQuerySuggestionsRequest} [querySuggestionsServiceQuerySuggestionsRequest] Request (query, hitsPerPage, analytics_tags, filtered_tabs, etc.)
|
|
2288
|
-
* @param {*} [options] Override http request option.
|
|
2289
|
-
* @throws {RequiredError}
|
|
2290
|
-
*/
|
|
2291
|
-
v1SuggestionsQueriesPost: (xStoreid: string, xStoresecret: string, xUserId?: string, xAnonId?: string, xSessionId?: string, querySuggestionsServiceQuerySuggestionsRequest?: QuerySuggestionsServiceQuerySuggestionsRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
2292
2289
|
};
|
|
2293
2290
|
/**
|
|
2294
2291
|
* QuerySuggestionsApi - functional programming interface
|
|
@@ -2336,19 +2333,6 @@ export declare const QuerySuggestionsApiFp: (configuration?: Configuration) => {
|
|
|
2336
2333
|
* @throws {RequiredError}
|
|
2337
2334
|
*/
|
|
2338
2335
|
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>>;
|
|
2339
|
-
/**
|
|
2340
|
-
* 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.
|
|
2341
|
-
* @summary Get query suggestions (POST)
|
|
2342
|
-
* @param {string} xStoreid Store ID (from dashboard)
|
|
2343
|
-
* @param {string} xStoresecret Store read secret
|
|
2344
|
-
* @param {string} [xUserId] User ID for personalization
|
|
2345
|
-
* @param {string} [xAnonId] Anonymous user ID for personalization
|
|
2346
|
-
* @param {string} [xSessionId] Session ID for personalization
|
|
2347
|
-
* @param {QuerySuggestionsServiceQuerySuggestionsRequest} [querySuggestionsServiceQuerySuggestionsRequest] Request (query, hitsPerPage, analytics_tags, filtered_tabs, etc.)
|
|
2348
|
-
* @param {*} [options] Override http request option.
|
|
2349
|
-
* @throws {RequiredError}
|
|
2350
|
-
*/
|
|
2351
|
-
v1SuggestionsQueriesPost(xStoreid: string, xStoresecret: string, xUserId?: string, xAnonId?: string, xSessionId?: string, querySuggestionsServiceQuerySuggestionsRequest?: QuerySuggestionsServiceQuerySuggestionsRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<QuerySuggestionsServiceQuerySuggestionsAPIResponse>>;
|
|
2352
2336
|
};
|
|
2353
2337
|
/**
|
|
2354
2338
|
* QuerySuggestionsApi - factory interface
|
|
@@ -2396,19 +2380,6 @@ export declare const QuerySuggestionsApiFactory: (configuration?: Configuration,
|
|
|
2396
2380
|
* @throws {RequiredError}
|
|
2397
2381
|
*/
|
|
2398
2382
|
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>;
|
|
2399
|
-
/**
|
|
2400
|
-
* 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.
|
|
2401
|
-
* @summary Get query suggestions (POST)
|
|
2402
|
-
* @param {string} xStoreid Store ID (from dashboard)
|
|
2403
|
-
* @param {string} xStoresecret Store read secret
|
|
2404
|
-
* @param {string} [xUserId] User ID for personalization
|
|
2405
|
-
* @param {string} [xAnonId] Anonymous user ID for personalization
|
|
2406
|
-
* @param {string} [xSessionId] Session ID for personalization
|
|
2407
|
-
* @param {QuerySuggestionsServiceQuerySuggestionsRequest} [querySuggestionsServiceQuerySuggestionsRequest] Request (query, hitsPerPage, analytics_tags, filtered_tabs, etc.)
|
|
2408
|
-
* @param {*} [options] Override http request option.
|
|
2409
|
-
* @throws {RequiredError}
|
|
2410
|
-
*/
|
|
2411
|
-
v1SuggestionsQueriesPost(xStoreid: string, xStoresecret: string, xUserId?: string, xAnonId?: string, xSessionId?: string, querySuggestionsServiceQuerySuggestionsRequest?: QuerySuggestionsServiceQuerySuggestionsRequest, options?: RawAxiosRequestConfig): AxiosPromise<QuerySuggestionsServiceQuerySuggestionsAPIResponse>;
|
|
2412
2383
|
};
|
|
2413
2384
|
/**
|
|
2414
2385
|
* QuerySuggestionsApi - object-oriented interface
|
|
@@ -2456,19 +2427,6 @@ export declare class QuerySuggestionsApi extends BaseAPI {
|
|
|
2456
2427
|
* @throws {RequiredError}
|
|
2457
2428
|
*/
|
|
2458
2429
|
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, {}>>;
|
|
2459
|
-
/**
|
|
2460
|
-
* 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.
|
|
2461
|
-
* @summary Get query suggestions (POST)
|
|
2462
|
-
* @param {string} xStoreid Store ID (from dashboard)
|
|
2463
|
-
* @param {string} xStoresecret Store read secret
|
|
2464
|
-
* @param {string} [xUserId] User ID for personalization
|
|
2465
|
-
* @param {string} [xAnonId] Anonymous user ID for personalization
|
|
2466
|
-
* @param {string} [xSessionId] Session ID for personalization
|
|
2467
|
-
* @param {QuerySuggestionsServiceQuerySuggestionsRequest} [querySuggestionsServiceQuerySuggestionsRequest] Request (query, hitsPerPage, analytics_tags, filtered_tabs, etc.)
|
|
2468
|
-
* @param {*} [options] Override http request option.
|
|
2469
|
-
* @throws {RequiredError}
|
|
2470
|
-
*/
|
|
2471
|
-
v1SuggestionsQueriesPost(xStoreid: string, xStoresecret: string, xUserId?: string, xAnonId?: string, xSessionId?: string, querySuggestionsServiceQuerySuggestionsRequest?: QuerySuggestionsServiceQuerySuggestionsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<QuerySuggestionsServiceQuerySuggestionsAPIResponse, any, {}>>;
|
|
2472
2430
|
}
|
|
2473
2431
|
export declare const V1SuggestionsQueriesGetTagsMatchModeEnum: {
|
|
2474
2432
|
readonly Any: "any";
|
|
@@ -2481,70 +2439,6 @@ export declare const V1SuggestionsQueriesGetTimeRangeEnum: {
|
|
|
2481
2439
|
readonly _90d: "90d";
|
|
2482
2440
|
};
|
|
2483
2441
|
export type V1SuggestionsQueriesGetTimeRangeEnum = typeof V1SuggestionsQueriesGetTimeRangeEnum[keyof typeof V1SuggestionsQueriesGetTimeRangeEnum];
|
|
2484
|
-
/**
|
|
2485
|
-
* SDKExperimentsApi - axios parameter creator
|
|
2486
|
-
*/
|
|
2487
|
-
export declare const SDKExperimentsApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
2488
|
-
/**
|
|
2489
|
-
* Returns variant assignments for all running experiments for the requesting user. Uses hash-based consistent assignment.
|
|
2490
|
-
* @summary Get experiment assignments for a user
|
|
2491
|
-
* @param {string} xStoreid Store ID
|
|
2492
|
-
* @param {string} xStoresecret Store read secret
|
|
2493
|
-
* @param {string} [xUserId] User ID (provide either x-user-id or x-anon-id)
|
|
2494
|
-
* @param {string} [xAnonId] Anonymous ID (provide either x-user-id or x-anon-id)
|
|
2495
|
-
* @param {*} [options] Override http request option.
|
|
2496
|
-
* @throws {RequiredError}
|
|
2497
|
-
*/
|
|
2498
|
-
v1ExperimentsAssignmentGet: (xStoreid: string, xStoresecret: string, xUserId?: string, xAnonId?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
2499
|
-
};
|
|
2500
|
-
/**
|
|
2501
|
-
* SDKExperimentsApi - functional programming interface
|
|
2502
|
-
*/
|
|
2503
|
-
export declare const SDKExperimentsApiFp: (configuration?: Configuration) => {
|
|
2504
|
-
/**
|
|
2505
|
-
* Returns variant assignments for all running experiments for the requesting user. Uses hash-based consistent assignment.
|
|
2506
|
-
* @summary Get experiment assignments for a user
|
|
2507
|
-
* @param {string} xStoreid Store ID
|
|
2508
|
-
* @param {string} xStoresecret Store read secret
|
|
2509
|
-
* @param {string} [xUserId] User ID (provide either x-user-id or x-anon-id)
|
|
2510
|
-
* @param {string} [xAnonId] Anonymous ID (provide either x-user-id or x-anon-id)
|
|
2511
|
-
* @param {*} [options] Override http request option.
|
|
2512
|
-
* @throws {RequiredError}
|
|
2513
|
-
*/
|
|
2514
|
-
v1ExperimentsAssignmentGet(xStoreid: string, xStoresecret: string, xUserId?: string, xAnonId?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesExperimentAssignmentResponse>>;
|
|
2515
|
-
};
|
|
2516
|
-
/**
|
|
2517
|
-
* SDKExperimentsApi - factory interface
|
|
2518
|
-
*/
|
|
2519
|
-
export declare const SDKExperimentsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
2520
|
-
/**
|
|
2521
|
-
* Returns variant assignments for all running experiments for the requesting user. Uses hash-based consistent assignment.
|
|
2522
|
-
* @summary Get experiment assignments for a user
|
|
2523
|
-
* @param {string} xStoreid Store ID
|
|
2524
|
-
* @param {string} xStoresecret Store read secret
|
|
2525
|
-
* @param {string} [xUserId] User ID (provide either x-user-id or x-anon-id)
|
|
2526
|
-
* @param {string} [xAnonId] Anonymous ID (provide either x-user-id or x-anon-id)
|
|
2527
|
-
* @param {*} [options] Override http request option.
|
|
2528
|
-
* @throws {RequiredError}
|
|
2529
|
-
*/
|
|
2530
|
-
v1ExperimentsAssignmentGet(xStoreid: string, xStoresecret: string, xUserId?: string, xAnonId?: string, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesExperimentAssignmentResponse>;
|
|
2531
|
-
};
|
|
2532
|
-
/**
|
|
2533
|
-
* SDKExperimentsApi - object-oriented interface
|
|
2534
|
-
*/
|
|
2535
|
-
export declare class SDKExperimentsApi extends BaseAPI {
|
|
2536
|
-
/**
|
|
2537
|
-
* Returns variant assignments for all running experiments for the requesting user. Uses hash-based consistent assignment.
|
|
2538
|
-
* @summary Get experiment assignments for a user
|
|
2539
|
-
* @param {string} xStoreid Store ID
|
|
2540
|
-
* @param {string} xStoresecret Store read secret
|
|
2541
|
-
* @param {string} [xUserId] User ID (provide either x-user-id or x-anon-id)
|
|
2542
|
-
* @param {string} [xAnonId] Anonymous ID (provide either x-user-id or x-anon-id)
|
|
2543
|
-
* @param {*} [options] Override http request option.
|
|
2544
|
-
* @throws {RequiredError}
|
|
2545
|
-
*/
|
|
2546
|
-
v1ExperimentsAssignmentGet(xStoreid: string, xStoresecret: string, xUserId?: string, xAnonId?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesExperimentAssignmentResponse, any, {}>>;
|
|
2547
|
-
}
|
|
2548
2442
|
/**
|
|
2549
2443
|
* SearchApi - axios parameter creator
|
|
2550
2444
|
*/
|
|
@@ -2599,19 +2493,6 @@ export declare const SearchApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
2599
2493
|
* @throws {RequiredError}
|
|
2600
2494
|
*/
|
|
2601
2495
|
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>;
|
|
2602
|
-
/**
|
|
2603
|
-
* 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.
|
|
2604
|
-
* @summary Search (POST)
|
|
2605
|
-
* @param {string} xStoreid Store ID (from dashboard)
|
|
2606
|
-
* @param {string} xStoresecret Store read secret (from dashboard)
|
|
2607
|
-
* @param {DataTypesSearchRequest} dataTypesSearchRequest Search query, filters, pagination, and options
|
|
2608
|
-
* @param {string} [xUserId] User ID for personalization
|
|
2609
|
-
* @param {string} [xAnonId] Anonymous user ID for personalization
|
|
2610
|
-
* @param {string} [xSessionId] Session ID for personalization
|
|
2611
|
-
* @param {*} [options] Override http request option.
|
|
2612
|
-
* @throws {RequiredError}
|
|
2613
|
-
*/
|
|
2614
|
-
v1SearchPost: (xStoreid: string, xStoresecret: string, dataTypesSearchRequest: DataTypesSearchRequest, xUserId?: string, xAnonId?: string, xSessionId?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
2615
2496
|
};
|
|
2616
2497
|
/**
|
|
2617
2498
|
* SearchApi - functional programming interface
|
|
@@ -2667,19 +2548,6 @@ export declare const SearchApiFp: (configuration?: Configuration) => {
|
|
|
2667
2548
|
* @throws {RequiredError}
|
|
2668
2549
|
*/
|
|
2669
2550
|
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<DataTypesSearchResponseWrapper>>;
|
|
2670
|
-
/**
|
|
2671
|
-
* 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.
|
|
2672
|
-
* @summary Search (POST)
|
|
2673
|
-
* @param {string} xStoreid Store ID (from dashboard)
|
|
2674
|
-
* @param {string} xStoresecret Store read secret (from dashboard)
|
|
2675
|
-
* @param {DataTypesSearchRequest} dataTypesSearchRequest Search query, filters, pagination, and options
|
|
2676
|
-
* @param {string} [xUserId] User ID for personalization
|
|
2677
|
-
* @param {string} [xAnonId] Anonymous user ID for personalization
|
|
2678
|
-
* @param {string} [xSessionId] Session ID for personalization
|
|
2679
|
-
* @param {*} [options] Override http request option.
|
|
2680
|
-
* @throws {RequiredError}
|
|
2681
|
-
*/
|
|
2682
|
-
v1SearchPost(xStoreid: string, xStoresecret: string, dataTypesSearchRequest: DataTypesSearchRequest, xUserId?: string, xAnonId?: string, xSessionId?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesSearchResponseWrapper>>;
|
|
2683
2551
|
};
|
|
2684
2552
|
/**
|
|
2685
2553
|
* SearchApi - factory interface
|
|
@@ -2735,19 +2603,6 @@ export declare const SearchApiFactory: (configuration?: Configuration, basePath?
|
|
|
2735
2603
|
* @throws {RequiredError}
|
|
2736
2604
|
*/
|
|
2737
2605
|
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<DataTypesSearchResponseWrapper>;
|
|
2738
|
-
/**
|
|
2739
|
-
* 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.
|
|
2740
|
-
* @summary Search (POST)
|
|
2741
|
-
* @param {string} xStoreid Store ID (from dashboard)
|
|
2742
|
-
* @param {string} xStoresecret Store read secret (from dashboard)
|
|
2743
|
-
* @param {DataTypesSearchRequest} dataTypesSearchRequest Search query, filters, pagination, and options
|
|
2744
|
-
* @param {string} [xUserId] User ID for personalization
|
|
2745
|
-
* @param {string} [xAnonId] Anonymous user ID for personalization
|
|
2746
|
-
* @param {string} [xSessionId] Session ID for personalization
|
|
2747
|
-
* @param {*} [options] Override http request option.
|
|
2748
|
-
* @throws {RequiredError}
|
|
2749
|
-
*/
|
|
2750
|
-
v1SearchPost(xStoreid: string, xStoresecret: string, dataTypesSearchRequest: DataTypesSearchRequest, xUserId?: string, xAnonId?: string, xSessionId?: string, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesSearchResponseWrapper>;
|
|
2751
2606
|
};
|
|
2752
2607
|
/**
|
|
2753
2608
|
* SearchApi - object-oriented interface
|
|
@@ -2803,621 +2658,520 @@ export declare class SearchApi extends BaseAPI {
|
|
|
2803
2658
|
* @throws {RequiredError}
|
|
2804
2659
|
*/
|
|
2805
2660
|
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<DataTypesSearchResponseWrapper, any, {}>>;
|
|
2806
|
-
/**
|
|
2807
|
-
* 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.
|
|
2808
|
-
* @summary Search (POST)
|
|
2809
|
-
* @param {string} xStoreid Store ID (from dashboard)
|
|
2810
|
-
* @param {string} xStoresecret Store read secret (from dashboard)
|
|
2811
|
-
* @param {DataTypesSearchRequest} dataTypesSearchRequest Search query, filters, pagination, and options
|
|
2812
|
-
* @param {string} [xUserId] User ID for personalization
|
|
2813
|
-
* @param {string} [xAnonId] Anonymous user ID for personalization
|
|
2814
|
-
* @param {string} [xSessionId] Session ID for personalization
|
|
2815
|
-
* @param {*} [options] Override http request option.
|
|
2816
|
-
* @throws {RequiredError}
|
|
2817
|
-
*/
|
|
2818
|
-
v1SearchPost(xStoreid: string, xStoresecret: string, dataTypesSearchRequest: DataTypesSearchRequest, xUserId?: string, xAnonId?: string, xSessionId?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesSearchResponseWrapper, any, {}>>;
|
|
2819
2661
|
}
|
|
2820
2662
|
/**
|
|
2821
2663
|
* StoreManagementApi - axios parameter creator
|
|
2822
2664
|
*/
|
|
2823
2665
|
export declare const StoreManagementApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
2824
2666
|
/**
|
|
2825
|
-
*
|
|
2826
|
-
* @summary Create Store (Public SDK API)
|
|
2827
|
-
* @param {string} authorization Bearer JWT Token
|
|
2828
|
-
* @param {DataTypesCreateStoreRequest} dataTypesCreateStoreRequest Store creation request
|
|
2829
|
-
* @param {*} [options] Override http request option.
|
|
2830
|
-
* @throws {RequiredError}
|
|
2831
|
-
*/
|
|
2832
|
-
apiV1StoresPost: (authorization: string, dataTypesCreateStoreRequest: DataTypesCreateStoreRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
2833
|
-
/**
|
|
2834
|
-
* Returns search and query-suggestions configuration for the store. **Auth:** `x-storeid` and `x-storesecret`. Path `xStoreID` must match the `x-storeid` header.
|
|
2667
|
+
* Returns search and query-suggestions configuration for the store. **Auth:** `x-storeid` and `x-storesecret`.
|
|
2835
2668
|
* @summary Get store configuration
|
|
2836
2669
|
* @param {string} xStoreid Store ID (from dashboard)
|
|
2837
2670
|
* @param {string} xStoresecret Store read secret
|
|
2838
|
-
* @param {string} xStoreID Store ID (must match x-storeid header)
|
|
2839
2671
|
* @param {*} [options] Override http request option.
|
|
2840
2672
|
* @throws {RequiredError}
|
|
2841
2673
|
*/
|
|
2842
|
-
|
|
2674
|
+
apiV1StoresConfigGet: (xStoreid: string, xStoresecret: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
2843
2675
|
/**
|
|
2844
|
-
* Update search and store settings. Partial updates supported. **Auth:** `x-storeid` and `x-store-write-secret`.
|
|
2676
|
+
* Update search and store settings. Partial updates supported. **Auth:** `x-storeid` and `x-store-write-secret`.
|
|
2845
2677
|
* @summary Update store configuration
|
|
2846
2678
|
* @param {string} xStoreid Store ID (from dashboard)
|
|
2847
2679
|
* @param {string} xStoreWriteSecret Store write secret
|
|
2848
|
-
* @param {
|
|
2849
|
-
* @param {DataTypesIndexConfig} dataTypesIndexConfig Fields to update (partial)
|
|
2680
|
+
* @param {DataTypesStoreConfigUpdateRequest} dataTypesStoreConfigUpdateRequest Fields to update (partial, includes allow_public_search)
|
|
2850
2681
|
* @param {*} [options] Override http request option.
|
|
2851
2682
|
* @throws {RequiredError}
|
|
2852
2683
|
*/
|
|
2853
|
-
|
|
2684
|
+
apiV1StoresConfigPut: (xStoreid: string, xStoreWriteSecret: string, dataTypesStoreConfigUpdateRequest: DataTypesStoreConfigUpdateRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
2854
2685
|
/**
|
|
2855
|
-
* Returns metadata for all configurable store fields (types, defaults, validation). **Auth:** `x-storeid` and `x-storesecret`.
|
|
2686
|
+
* Returns metadata for all configurable store fields (types, defaults, validation). **Auth:** `x-storeid` and `x-storesecret`.
|
|
2856
2687
|
* @summary Get store config schema
|
|
2857
2688
|
* @param {string} xStoreid Store ID (from dashboard)
|
|
2858
2689
|
* @param {string} xStoresecret Store read secret
|
|
2859
|
-
* @param {string} xStoreID Store ID (must match x-storeid header)
|
|
2860
2690
|
* @param {*} [options] Override http request option.
|
|
2861
2691
|
* @throws {RequiredError}
|
|
2862
2692
|
*/
|
|
2863
|
-
|
|
2693
|
+
apiV1StoresConfigSchemaGet: (xStoreid: string, xStoresecret: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
2864
2694
|
/**
|
|
2865
|
-
* Run multiple document operations in one request (insert, update, upsert, delete). **Auth:** `x-storeid` and `x-store-write-secret`.
|
|
2695
|
+
* Run multiple document operations in one request (insert, update, upsert, delete). **Auth:** `x-storeid` and `x-store-write-secret`. Each item can specify its own action.
|
|
2866
2696
|
* @summary Bulk index documents
|
|
2867
2697
|
* @param {string} xStoreid Store ID (from dashboard)
|
|
2868
2698
|
* @param {string} xStoreWriteSecret Store write secret
|
|
2869
|
-
* @param {string} xStoreID Store ID (must match x-storeid header)
|
|
2870
2699
|
* @param {DataTypesBulkDocumentRequest} dataTypesBulkDocumentRequest List of operations
|
|
2871
2700
|
* @param {*} [options] Override http request option.
|
|
2872
2701
|
* @throws {RequiredError}
|
|
2873
2702
|
*/
|
|
2874
|
-
|
|
2703
|
+
apiV1StoresDocumentsBulkPost: (xStoreid: string, xStoreWriteSecret: string, dataTypesBulkDocumentRequest: DataTypesBulkDocumentRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
2875
2704
|
/**
|
|
2876
|
-
* Removes all documents from the store\'s search index; schema is preserved. **Auth:** `x-storeid` and `x-store-write-secret`.
|
|
2705
|
+
* Removes all documents from the store\'s search index; schema is preserved. **Auth:** `x-storeid` and `x-store-write-secret`.
|
|
2877
2706
|
* @summary Clear all documents
|
|
2878
2707
|
* @param {string} xStoreid Store ID (from dashboard)
|
|
2879
2708
|
* @param {string} xStoreWriteSecret Store write secret
|
|
2880
|
-
* @param {string} xStoreID Store ID (must match x-storeid header)
|
|
2881
2709
|
* @param {*} [options] Override http request option.
|
|
2882
2710
|
* @throws {RequiredError}
|
|
2883
2711
|
*/
|
|
2884
|
-
|
|
2712
|
+
apiV1StoresDocumentsDelete: (xStoreid: string, xStoreWriteSecret: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
2885
2713
|
/**
|
|
2886
|
-
* Remove a document from the store\'s search index by ID. **Auth:** `x-storeid` and `x-store-write-secret`.
|
|
2714
|
+
* Remove a document from the store\'s search index by ID. **Auth:** `x-storeid` and `x-store-write-secret`.
|
|
2887
2715
|
* @summary Delete a document
|
|
2888
2716
|
* @param {string} xStoreid Store ID (from dashboard)
|
|
2889
2717
|
* @param {string} xStoreWriteSecret Store write secret
|
|
2890
|
-
* @param {string} xStoreID Store ID (must match x-storeid header)
|
|
2891
2718
|
* @param {string} documentID Document ID to delete
|
|
2892
2719
|
* @param {*} [options] Override http request option.
|
|
2893
2720
|
* @throws {RequiredError}
|
|
2894
2721
|
*/
|
|
2895
|
-
|
|
2722
|
+
apiV1StoresDocumentsDocumentIDDelete: (xStoreid: string, xStoreWriteSecret: string, documentID: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
2896
2723
|
/**
|
|
2897
|
-
* Retrieve a single document from the store\'s search index by ID. **Auth:** `x-storeid` and `x-storesecret
|
|
2724
|
+
* Retrieve a single document from the store\'s search index by ID. **Auth:** `x-storeid` and `x-storesecret`. Used by product pages and PDP.
|
|
2898
2725
|
* @summary Get a document by ID
|
|
2899
2726
|
* @param {string} xStoreid Store ID (from dashboard)
|
|
2900
2727
|
* @param {string} xStoresecret Store read secret
|
|
2901
|
-
* @param {string} xStoreID Store ID (must match x-storeid header)
|
|
2902
2728
|
* @param {string} documentID Document ID to retrieve
|
|
2903
2729
|
* @param {*} [options] Override http request option.
|
|
2904
2730
|
* @throws {RequiredError}
|
|
2905
2731
|
*/
|
|
2906
|
-
|
|
2732
|
+
apiV1StoresDocumentsDocumentIDGet: (xStoreid: string, xStoresecret: string, documentID: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
2907
2733
|
/**
|
|
2908
|
-
* Add or update one document in the store\'s search index. **Auth:** `x-storeid` and `x-store-write-secret`.
|
|
2734
|
+
* Add or update one document in the store\'s search index. **Auth:** `x-storeid` and `x-store-write-secret`. If you omit document ID, one is generated; existing documents with the same ID are updated.
|
|
2909
2735
|
* @summary Index a single document
|
|
2910
2736
|
* @param {string} xStoreid Store ID (from dashboard)
|
|
2911
2737
|
* @param {string} xStoreWriteSecret Store write secret
|
|
2912
|
-
* @param {string} xStoreID Store ID (must match x-storeid header)
|
|
2913
2738
|
* @param {DataTypesDocumentRequest} dataTypesDocumentRequest Document fields to index
|
|
2914
2739
|
* @param {*} [options] Override http request option.
|
|
2915
2740
|
* @throws {RequiredError}
|
|
2916
2741
|
*/
|
|
2917
|
-
|
|
2742
|
+
apiV1StoresDocumentsPost: (xStoreid: string, xStoreWriteSecret: string, dataTypesDocumentRequest: DataTypesDocumentRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
2918
2743
|
/**
|
|
2919
|
-
* Returns basic store details (name, location, status). **Auth:** `x-storeid` and `x-storesecret`.
|
|
2744
|
+
* Returns basic store details (name, location, status). **Auth:** `x-storeid` and `x-storesecret`.
|
|
2920
2745
|
* @summary Get store info
|
|
2921
2746
|
* @param {string} xStoreid Store ID (from dashboard)
|
|
2922
2747
|
* @param {string} xStoresecret Store read secret
|
|
2923
|
-
* @param {string} xStoreID Store ID (must match x-storeid header)
|
|
2924
2748
|
* @param {*} [options] Override http request option.
|
|
2925
2749
|
* @throws {RequiredError}
|
|
2926
2750
|
*/
|
|
2927
|
-
|
|
2751
|
+
apiV1StoresGet: (xStoreid: string, xStoresecret: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
2928
2752
|
/**
|
|
2929
|
-
* Returns autocomplete/suggestions configuration for the store. **Auth:** `x-storeid` and `x-storesecret`.
|
|
2753
|
+
* Returns autocomplete/suggestions configuration for the store. **Auth:** `x-storeid` and `x-storesecret`.
|
|
2930
2754
|
* @summary Get query suggestions configuration
|
|
2931
2755
|
* @param {string} xStoreid Store ID (from dashboard)
|
|
2932
2756
|
* @param {string} xStoresecret Store read secret
|
|
2933
|
-
* @param {string} xStoreID Store ID (must match x-storeid header)
|
|
2934
2757
|
* @param {*} [options] Override http request option.
|
|
2935
2758
|
* @throws {RequiredError}
|
|
2936
2759
|
*/
|
|
2937
|
-
|
|
2760
|
+
apiV1StoresQuerySuggestionsConfigGet: (xStoreid: string, xStoresecret: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
2938
2761
|
/**
|
|
2939
|
-
* Update autocomplete/suggestions settings for the store. Partial updates supported. **Auth:** `x-storeid` and `x-store-write-secret`.
|
|
2762
|
+
* Update autocomplete/suggestions settings for the store. Partial updates supported. **Auth:** `x-storeid` and `x-store-write-secret`.
|
|
2940
2763
|
* @summary Update query suggestions configuration
|
|
2941
2764
|
* @param {string} xStoreid Store ID (from dashboard)
|
|
2942
2765
|
* @param {string} xStoreWriteSecret Store write secret
|
|
2943
|
-
* @param {string} xStoreID Store ID (must match x-storeid header)
|
|
2944
2766
|
* @param {QuerySuggestionsServiceUpdateSuggestionConfigRequest} querySuggestionsServiceUpdateSuggestionConfigRequest Fields to update (partial)
|
|
2945
2767
|
* @param {*} [options] Override http request option.
|
|
2946
2768
|
* @throws {RequiredError}
|
|
2947
2769
|
*/
|
|
2948
|
-
|
|
2770
|
+
apiV1StoresQuerySuggestionsConfigPut: (xStoreid: string, xStoreWriteSecret: string, querySuggestionsServiceUpdateSuggestionConfigRequest: QuerySuggestionsServiceUpdateSuggestionConfigRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
2949
2771
|
/**
|
|
2950
|
-
* Returns the current search index schema (fields and options) for the store. **Auth:** `x-storeid` and `x-storesecret`.
|
|
2772
|
+
* Returns the current search index schema (fields and options) for the store. **Auth:** `x-storeid` and `x-storesecret`.
|
|
2951
2773
|
* @summary Get index schema
|
|
2952
2774
|
* @param {string} xStoreid Store ID (from dashboard)
|
|
2953
2775
|
* @param {string} xStoresecret Store read secret
|
|
2954
|
-
* @param {string} xStoreID Store ID (must match x-storeid header)
|
|
2955
2776
|
* @param {*} [options] Override http request option.
|
|
2956
2777
|
* @throws {RequiredError}
|
|
2957
2778
|
*/
|
|
2958
|
-
|
|
2779
|
+
apiV1StoresSchemaGet: (xStoreid: string, xStoresecret: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
2959
2780
|
/**
|
|
2960
|
-
* 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`.
|
|
2781
|
+
* 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`.
|
|
2961
2782
|
* @summary Create or update index schema
|
|
2962
2783
|
* @param {string} xStoreid Store ID (from dashboard)
|
|
2963
2784
|
* @param {string} xStoreWriteSecret Store write secret
|
|
2964
|
-
* @param {string} xStoreID Store ID (must match x-storeid header)
|
|
2965
2785
|
* @param {DataTypesCollectionSchemaRequest} dataTypesCollectionSchemaRequest Schema definition and mode
|
|
2966
2786
|
* @param {*} [options] Override http request option.
|
|
2967
2787
|
* @throws {RequiredError}
|
|
2968
2788
|
*/
|
|
2969
|
-
|
|
2789
|
+
apiV1StoresSchemaPost: (xStoreid: string, xStoreWriteSecret: string, dataTypesCollectionSchemaRequest: DataTypesCollectionSchemaRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
2970
2790
|
};
|
|
2971
2791
|
/**
|
|
2972
2792
|
* StoreManagementApi - functional programming interface
|
|
2973
2793
|
*/
|
|
2974
2794
|
export declare const StoreManagementApiFp: (configuration?: Configuration) => {
|
|
2975
2795
|
/**
|
|
2976
|
-
*
|
|
2977
|
-
* @summary Create Store (Public SDK API)
|
|
2978
|
-
* @param {string} authorization Bearer JWT Token
|
|
2979
|
-
* @param {DataTypesCreateStoreRequest} dataTypesCreateStoreRequest Store creation request
|
|
2980
|
-
* @param {*} [options] Override http request option.
|
|
2981
|
-
* @throws {RequiredError}
|
|
2982
|
-
*/
|
|
2983
|
-
apiV1StoresPost(authorization: string, dataTypesCreateStoreRequest: DataTypesCreateStoreRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesGenericResponseDataTypesCreateStoreResponse>>;
|
|
2984
|
-
/**
|
|
2985
|
-
* Returns search and query-suggestions configuration for the store. **Auth:** `x-storeid` and `x-storesecret`. Path `xStoreID` must match the `x-storeid` header.
|
|
2796
|
+
* Returns search and query-suggestions configuration for the store. **Auth:** `x-storeid` and `x-storesecret`.
|
|
2986
2797
|
* @summary Get store configuration
|
|
2987
2798
|
* @param {string} xStoreid Store ID (from dashboard)
|
|
2988
2799
|
* @param {string} xStoresecret Store read secret
|
|
2989
|
-
* @param {string} xStoreID Store ID (must match x-storeid header)
|
|
2990
2800
|
* @param {*} [options] Override http request option.
|
|
2991
2801
|
* @throws {RequiredError}
|
|
2992
2802
|
*/
|
|
2993
|
-
|
|
2803
|
+
apiV1StoresConfigGet(xStoreid: string, xStoresecret: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesGenericResponseDataTypesStoreConfigWithOnboardingResponse>>;
|
|
2994
2804
|
/**
|
|
2995
|
-
* Update search and store settings. Partial updates supported. **Auth:** `x-storeid` and `x-store-write-secret`.
|
|
2805
|
+
* Update search and store settings. Partial updates supported. **Auth:** `x-storeid` and `x-store-write-secret`.
|
|
2996
2806
|
* @summary Update store configuration
|
|
2997
2807
|
* @param {string} xStoreid Store ID (from dashboard)
|
|
2998
2808
|
* @param {string} xStoreWriteSecret Store write secret
|
|
2999
|
-
* @param {
|
|
3000
|
-
* @param {DataTypesIndexConfig} dataTypesIndexConfig Fields to update (partial)
|
|
2809
|
+
* @param {DataTypesStoreConfigUpdateRequest} dataTypesStoreConfigUpdateRequest Fields to update (partial, includes allow_public_search)
|
|
3001
2810
|
* @param {*} [options] Override http request option.
|
|
3002
2811
|
* @throws {RequiredError}
|
|
3003
2812
|
*/
|
|
3004
|
-
|
|
2813
|
+
apiV1StoresConfigPut(xStoreid: string, xStoreWriteSecret: string, dataTypesStoreConfigUpdateRequest: DataTypesStoreConfigUpdateRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesIndexConfigResponseWrapper>>;
|
|
3005
2814
|
/**
|
|
3006
|
-
* Returns metadata for all configurable store fields (types, defaults, validation). **Auth:** `x-storeid` and `x-storesecret`.
|
|
2815
|
+
* Returns metadata for all configurable store fields (types, defaults, validation). **Auth:** `x-storeid` and `x-storesecret`.
|
|
3007
2816
|
* @summary Get store config schema
|
|
3008
2817
|
* @param {string} xStoreid Store ID (from dashboard)
|
|
3009
2818
|
* @param {string} xStoresecret Store read secret
|
|
3010
|
-
* @param {string} xStoreID Store ID (must match x-storeid header)
|
|
3011
2819
|
* @param {*} [options] Override http request option.
|
|
3012
2820
|
* @throws {RequiredError}
|
|
3013
2821
|
*/
|
|
3014
|
-
|
|
2822
|
+
apiV1StoresConfigSchemaGet(xStoreid: string, xStoresecret: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesConfigurationSchemaResponseWrapper>>;
|
|
3015
2823
|
/**
|
|
3016
|
-
* Run multiple document operations in one request (insert, update, upsert, delete). **Auth:** `x-storeid` and `x-store-write-secret`.
|
|
2824
|
+
* Run multiple document operations in one request (insert, update, upsert, delete). **Auth:** `x-storeid` and `x-store-write-secret`. Each item can specify its own action.
|
|
3017
2825
|
* @summary Bulk index documents
|
|
3018
2826
|
* @param {string} xStoreid Store ID (from dashboard)
|
|
3019
2827
|
* @param {string} xStoreWriteSecret Store write secret
|
|
3020
|
-
* @param {string} xStoreID Store ID (must match x-storeid header)
|
|
3021
2828
|
* @param {DataTypesBulkDocumentRequest} dataTypesBulkDocumentRequest List of operations
|
|
3022
2829
|
* @param {*} [options] Override http request option.
|
|
3023
2830
|
* @throws {RequiredError}
|
|
3024
2831
|
*/
|
|
3025
|
-
|
|
2832
|
+
apiV1StoresDocumentsBulkPost(xStoreid: string, xStoreWriteSecret: string, dataTypesBulkDocumentRequest: DataTypesBulkDocumentRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesBulkDocumentResponseWrapper>>;
|
|
3026
2833
|
/**
|
|
3027
|
-
* Removes all documents from the store\'s search index; schema is preserved. **Auth:** `x-storeid` and `x-store-write-secret`.
|
|
2834
|
+
* Removes all documents from the store\'s search index; schema is preserved. **Auth:** `x-storeid` and `x-store-write-secret`.
|
|
3028
2835
|
* @summary Clear all documents
|
|
3029
2836
|
* @param {string} xStoreid Store ID (from dashboard)
|
|
3030
2837
|
* @param {string} xStoreWriteSecret Store write secret
|
|
3031
|
-
* @param {string} xStoreID Store ID (must match x-storeid header)
|
|
3032
2838
|
* @param {*} [options] Override http request option.
|
|
3033
2839
|
* @throws {RequiredError}
|
|
3034
2840
|
*/
|
|
3035
|
-
|
|
2841
|
+
apiV1StoresDocumentsDelete(xStoreid: string, xStoreWriteSecret: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesClearDocumentsResponseWrapper>>;
|
|
3036
2842
|
/**
|
|
3037
|
-
* Remove a document from the store\'s search index by ID. **Auth:** `x-storeid` and `x-store-write-secret`.
|
|
2843
|
+
* Remove a document from the store\'s search index by ID. **Auth:** `x-storeid` and `x-store-write-secret`.
|
|
3038
2844
|
* @summary Delete a document
|
|
3039
2845
|
* @param {string} xStoreid Store ID (from dashboard)
|
|
3040
2846
|
* @param {string} xStoreWriteSecret Store write secret
|
|
3041
|
-
* @param {string} xStoreID Store ID (must match x-storeid header)
|
|
3042
2847
|
* @param {string} documentID Document ID to delete
|
|
3043
2848
|
* @param {*} [options] Override http request option.
|
|
3044
2849
|
* @throws {RequiredError}
|
|
3045
2850
|
*/
|
|
3046
|
-
|
|
2851
|
+
apiV1StoresDocumentsDocumentIDDelete(xStoreid: string, xStoreWriteSecret: string, documentID: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesDocumentResponseWrapper>>;
|
|
3047
2852
|
/**
|
|
3048
|
-
* Retrieve a single document from the store\'s search index by ID. **Auth:** `x-storeid` and `x-storesecret
|
|
2853
|
+
* Retrieve a single document from the store\'s search index by ID. **Auth:** `x-storeid` and `x-storesecret`. Used by product pages and PDP.
|
|
3049
2854
|
* @summary Get a document by ID
|
|
3050
2855
|
* @param {string} xStoreid Store ID (from dashboard)
|
|
3051
2856
|
* @param {string} xStoresecret Store read secret
|
|
3052
|
-
* @param {string} xStoreID Store ID (must match x-storeid header)
|
|
3053
2857
|
* @param {string} documentID Document ID to retrieve
|
|
3054
2858
|
* @param {*} [options] Override http request option.
|
|
3055
2859
|
* @throws {RequiredError}
|
|
3056
2860
|
*/
|
|
3057
|
-
|
|
2861
|
+
apiV1StoresDocumentsDocumentIDGet(xStoreid: string, xStoresecret: string, documentID: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesDocumentResponseWrapper>>;
|
|
3058
2862
|
/**
|
|
3059
|
-
* Add or update one document in the store\'s search index. **Auth:** `x-storeid` and `x-store-write-secret`.
|
|
2863
|
+
* Add or update one document in the store\'s search index. **Auth:** `x-storeid` and `x-store-write-secret`. If you omit document ID, one is generated; existing documents with the same ID are updated.
|
|
3060
2864
|
* @summary Index a single document
|
|
3061
2865
|
* @param {string} xStoreid Store ID (from dashboard)
|
|
3062
2866
|
* @param {string} xStoreWriteSecret Store write secret
|
|
3063
|
-
* @param {string} xStoreID Store ID (must match x-storeid header)
|
|
3064
2867
|
* @param {DataTypesDocumentRequest} dataTypesDocumentRequest Document fields to index
|
|
3065
2868
|
* @param {*} [options] Override http request option.
|
|
3066
2869
|
* @throws {RequiredError}
|
|
3067
2870
|
*/
|
|
3068
|
-
|
|
2871
|
+
apiV1StoresDocumentsPost(xStoreid: string, xStoreWriteSecret: string, dataTypesDocumentRequest: DataTypesDocumentRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesDocumentResponseWrapper>>;
|
|
3069
2872
|
/**
|
|
3070
|
-
* Returns basic store details (name, location, status). **Auth:** `x-storeid` and `x-storesecret`.
|
|
2873
|
+
* Returns basic store details (name, location, status). **Auth:** `x-storeid` and `x-storesecret`.
|
|
3071
2874
|
* @summary Get store info
|
|
3072
2875
|
* @param {string} xStoreid Store ID (from dashboard)
|
|
3073
2876
|
* @param {string} xStoresecret Store read secret
|
|
3074
|
-
* @param {string} xStoreID Store ID (must match x-storeid header)
|
|
3075
2877
|
* @param {*} [options] Override http request option.
|
|
3076
2878
|
* @throws {RequiredError}
|
|
3077
2879
|
*/
|
|
3078
|
-
|
|
2880
|
+
apiV1StoresGet(xStoreid: string, xStoresecret: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesGenericResponseDataTypesStoreInfoResponse>>;
|
|
3079
2881
|
/**
|
|
3080
|
-
* Returns autocomplete/suggestions configuration for the store. **Auth:** `x-storeid` and `x-storesecret`.
|
|
2882
|
+
* Returns autocomplete/suggestions configuration for the store. **Auth:** `x-storeid` and `x-storesecret`.
|
|
3081
2883
|
* @summary Get query suggestions configuration
|
|
3082
2884
|
* @param {string} xStoreid Store ID (from dashboard)
|
|
3083
2885
|
* @param {string} xStoresecret Store read secret
|
|
3084
|
-
* @param {string} xStoreID Store ID (must match x-storeid header)
|
|
3085
2886
|
* @param {*} [options] Override http request option.
|
|
3086
2887
|
* @throws {RequiredError}
|
|
3087
2888
|
*/
|
|
3088
|
-
|
|
2889
|
+
apiV1StoresQuerySuggestionsConfigGet(xStoreid: string, xStoresecret: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<QuerySuggestionsServiceQuerySuggestionsAPIResponse>>;
|
|
3089
2890
|
/**
|
|
3090
|
-
* Update autocomplete/suggestions settings for the store. Partial updates supported. **Auth:** `x-storeid` and `x-store-write-secret`.
|
|
2891
|
+
* Update autocomplete/suggestions settings for the store. Partial updates supported. **Auth:** `x-storeid` and `x-store-write-secret`.
|
|
3091
2892
|
* @summary Update query suggestions configuration
|
|
3092
2893
|
* @param {string} xStoreid Store ID (from dashboard)
|
|
3093
2894
|
* @param {string} xStoreWriteSecret Store write secret
|
|
3094
|
-
* @param {string} xStoreID Store ID (must match x-storeid header)
|
|
3095
2895
|
* @param {QuerySuggestionsServiceUpdateSuggestionConfigRequest} querySuggestionsServiceUpdateSuggestionConfigRequest Fields to update (partial)
|
|
3096
2896
|
* @param {*} [options] Override http request option.
|
|
3097
2897
|
* @throws {RequiredError}
|
|
3098
2898
|
*/
|
|
3099
|
-
|
|
2899
|
+
apiV1StoresQuerySuggestionsConfigPut(xStoreid: string, xStoreWriteSecret: string, querySuggestionsServiceUpdateSuggestionConfigRequest: QuerySuggestionsServiceUpdateSuggestionConfigRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<QuerySuggestionsServiceQuerySuggestionsAPIResponse>>;
|
|
3100
2900
|
/**
|
|
3101
|
-
* Returns the current search index schema (fields and options) for the store. **Auth:** `x-storeid` and `x-storesecret`.
|
|
2901
|
+
* Returns the current search index schema (fields and options) for the store. **Auth:** `x-storeid` and `x-storesecret`.
|
|
3102
2902
|
* @summary Get index schema
|
|
3103
2903
|
* @param {string} xStoreid Store ID (from dashboard)
|
|
3104
2904
|
* @param {string} xStoresecret Store read secret
|
|
3105
|
-
* @param {string} xStoreID Store ID (must match x-storeid header)
|
|
3106
2905
|
* @param {*} [options] Override http request option.
|
|
3107
2906
|
* @throws {RequiredError}
|
|
3108
2907
|
*/
|
|
3109
|
-
|
|
2908
|
+
apiV1StoresSchemaGet(xStoreid: string, xStoresecret: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesSchemaResponseWrapper>>;
|
|
3110
2909
|
/**
|
|
3111
|
-
* 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`.
|
|
2910
|
+
* 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`.
|
|
3112
2911
|
* @summary Create or update index schema
|
|
3113
2912
|
* @param {string} xStoreid Store ID (from dashboard)
|
|
3114
2913
|
* @param {string} xStoreWriteSecret Store write secret
|
|
3115
|
-
* @param {string} xStoreID Store ID (must match x-storeid header)
|
|
3116
2914
|
* @param {DataTypesCollectionSchemaRequest} dataTypesCollectionSchemaRequest Schema definition and mode
|
|
3117
2915
|
* @param {*} [options] Override http request option.
|
|
3118
2916
|
* @throws {RequiredError}
|
|
3119
2917
|
*/
|
|
3120
|
-
|
|
2918
|
+
apiV1StoresSchemaPost(xStoreid: string, xStoreWriteSecret: string, dataTypesCollectionSchemaRequest: DataTypesCollectionSchemaRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesSchemaResponseWrapper>>;
|
|
3121
2919
|
};
|
|
3122
2920
|
/**
|
|
3123
2921
|
* StoreManagementApi - factory interface
|
|
3124
2922
|
*/
|
|
3125
2923
|
export declare const StoreManagementApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
3126
2924
|
/**
|
|
3127
|
-
*
|
|
3128
|
-
* @summary Create Store (Public SDK API)
|
|
3129
|
-
* @param {string} authorization Bearer JWT Token
|
|
3130
|
-
* @param {DataTypesCreateStoreRequest} dataTypesCreateStoreRequest Store creation request
|
|
3131
|
-
* @param {*} [options] Override http request option.
|
|
3132
|
-
* @throws {RequiredError}
|
|
3133
|
-
*/
|
|
3134
|
-
apiV1StoresPost(authorization: string, dataTypesCreateStoreRequest: DataTypesCreateStoreRequest, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesGenericResponseDataTypesCreateStoreResponse>;
|
|
3135
|
-
/**
|
|
3136
|
-
* Returns search and query-suggestions configuration for the store. **Auth:** `x-storeid` and `x-storesecret`. Path `xStoreID` must match the `x-storeid` header.
|
|
2925
|
+
* Returns search and query-suggestions configuration for the store. **Auth:** `x-storeid` and `x-storesecret`.
|
|
3137
2926
|
* @summary Get store configuration
|
|
3138
2927
|
* @param {string} xStoreid Store ID (from dashboard)
|
|
3139
2928
|
* @param {string} xStoresecret Store read secret
|
|
3140
|
-
* @param {string} xStoreID Store ID (must match x-storeid header)
|
|
3141
2929
|
* @param {*} [options] Override http request option.
|
|
3142
2930
|
* @throws {RequiredError}
|
|
3143
2931
|
*/
|
|
3144
|
-
|
|
2932
|
+
apiV1StoresConfigGet(xStoreid: string, xStoresecret: string, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesGenericResponseDataTypesStoreConfigWithOnboardingResponse>;
|
|
3145
2933
|
/**
|
|
3146
|
-
* Update search and store settings. Partial updates supported. **Auth:** `x-storeid` and `x-store-write-secret`.
|
|
2934
|
+
* Update search and store settings. Partial updates supported. **Auth:** `x-storeid` and `x-store-write-secret`.
|
|
3147
2935
|
* @summary Update store configuration
|
|
3148
2936
|
* @param {string} xStoreid Store ID (from dashboard)
|
|
3149
2937
|
* @param {string} xStoreWriteSecret Store write secret
|
|
3150
|
-
* @param {
|
|
3151
|
-
* @param {DataTypesIndexConfig} dataTypesIndexConfig Fields to update (partial)
|
|
2938
|
+
* @param {DataTypesStoreConfigUpdateRequest} dataTypesStoreConfigUpdateRequest Fields to update (partial, includes allow_public_search)
|
|
3152
2939
|
* @param {*} [options] Override http request option.
|
|
3153
2940
|
* @throws {RequiredError}
|
|
3154
2941
|
*/
|
|
3155
|
-
|
|
2942
|
+
apiV1StoresConfigPut(xStoreid: string, xStoreWriteSecret: string, dataTypesStoreConfigUpdateRequest: DataTypesStoreConfigUpdateRequest, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesIndexConfigResponseWrapper>;
|
|
3156
2943
|
/**
|
|
3157
|
-
* Returns metadata for all configurable store fields (types, defaults, validation). **Auth:** `x-storeid` and `x-storesecret`.
|
|
2944
|
+
* Returns metadata for all configurable store fields (types, defaults, validation). **Auth:** `x-storeid` and `x-storesecret`.
|
|
3158
2945
|
* @summary Get store config schema
|
|
3159
2946
|
* @param {string} xStoreid Store ID (from dashboard)
|
|
3160
2947
|
* @param {string} xStoresecret Store read secret
|
|
3161
|
-
* @param {string} xStoreID Store ID (must match x-storeid header)
|
|
3162
2948
|
* @param {*} [options] Override http request option.
|
|
3163
2949
|
* @throws {RequiredError}
|
|
3164
2950
|
*/
|
|
3165
|
-
|
|
2951
|
+
apiV1StoresConfigSchemaGet(xStoreid: string, xStoresecret: string, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesConfigurationSchemaResponseWrapper>;
|
|
3166
2952
|
/**
|
|
3167
|
-
* Run multiple document operations in one request (insert, update, upsert, delete). **Auth:** `x-storeid` and `x-store-write-secret`.
|
|
2953
|
+
* Run multiple document operations in one request (insert, update, upsert, delete). **Auth:** `x-storeid` and `x-store-write-secret`. Each item can specify its own action.
|
|
3168
2954
|
* @summary Bulk index documents
|
|
3169
2955
|
* @param {string} xStoreid Store ID (from dashboard)
|
|
3170
2956
|
* @param {string} xStoreWriteSecret Store write secret
|
|
3171
|
-
* @param {string} xStoreID Store ID (must match x-storeid header)
|
|
3172
2957
|
* @param {DataTypesBulkDocumentRequest} dataTypesBulkDocumentRequest List of operations
|
|
3173
2958
|
* @param {*} [options] Override http request option.
|
|
3174
2959
|
* @throws {RequiredError}
|
|
3175
2960
|
*/
|
|
3176
|
-
|
|
2961
|
+
apiV1StoresDocumentsBulkPost(xStoreid: string, xStoreWriteSecret: string, dataTypesBulkDocumentRequest: DataTypesBulkDocumentRequest, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesBulkDocumentResponseWrapper>;
|
|
3177
2962
|
/**
|
|
3178
|
-
* Removes all documents from the store\'s search index; schema is preserved. **Auth:** `x-storeid` and `x-store-write-secret`.
|
|
2963
|
+
* Removes all documents from the store\'s search index; schema is preserved. **Auth:** `x-storeid` and `x-store-write-secret`.
|
|
3179
2964
|
* @summary Clear all documents
|
|
3180
2965
|
* @param {string} xStoreid Store ID (from dashboard)
|
|
3181
2966
|
* @param {string} xStoreWriteSecret Store write secret
|
|
3182
|
-
* @param {string} xStoreID Store ID (must match x-storeid header)
|
|
3183
2967
|
* @param {*} [options] Override http request option.
|
|
3184
2968
|
* @throws {RequiredError}
|
|
3185
2969
|
*/
|
|
3186
|
-
|
|
2970
|
+
apiV1StoresDocumentsDelete(xStoreid: string, xStoreWriteSecret: string, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesClearDocumentsResponseWrapper>;
|
|
3187
2971
|
/**
|
|
3188
|
-
* Remove a document from the store\'s search index by ID. **Auth:** `x-storeid` and `x-store-write-secret`.
|
|
2972
|
+
* Remove a document from the store\'s search index by ID. **Auth:** `x-storeid` and `x-store-write-secret`.
|
|
3189
2973
|
* @summary Delete a document
|
|
3190
2974
|
* @param {string} xStoreid Store ID (from dashboard)
|
|
3191
2975
|
* @param {string} xStoreWriteSecret Store write secret
|
|
3192
|
-
* @param {string} xStoreID Store ID (must match x-storeid header)
|
|
3193
2976
|
* @param {string} documentID Document ID to delete
|
|
3194
2977
|
* @param {*} [options] Override http request option.
|
|
3195
2978
|
* @throws {RequiredError}
|
|
3196
2979
|
*/
|
|
3197
|
-
|
|
2980
|
+
apiV1StoresDocumentsDocumentIDDelete(xStoreid: string, xStoreWriteSecret: string, documentID: string, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesDocumentResponseWrapper>;
|
|
3198
2981
|
/**
|
|
3199
|
-
* Retrieve a single document from the store\'s search index by ID. **Auth:** `x-storeid` and `x-storesecret
|
|
2982
|
+
* Retrieve a single document from the store\'s search index by ID. **Auth:** `x-storeid` and `x-storesecret`. Used by product pages and PDP.
|
|
3200
2983
|
* @summary Get a document by ID
|
|
3201
2984
|
* @param {string} xStoreid Store ID (from dashboard)
|
|
3202
2985
|
* @param {string} xStoresecret Store read secret
|
|
3203
|
-
* @param {string} xStoreID Store ID (must match x-storeid header)
|
|
3204
2986
|
* @param {string} documentID Document ID to retrieve
|
|
3205
2987
|
* @param {*} [options] Override http request option.
|
|
3206
2988
|
* @throws {RequiredError}
|
|
3207
2989
|
*/
|
|
3208
|
-
|
|
2990
|
+
apiV1StoresDocumentsDocumentIDGet(xStoreid: string, xStoresecret: string, documentID: string, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesDocumentResponseWrapper>;
|
|
3209
2991
|
/**
|
|
3210
|
-
* Add or update one document in the store\'s search index. **Auth:** `x-storeid` and `x-store-write-secret`.
|
|
2992
|
+
* Add or update one document in the store\'s search index. **Auth:** `x-storeid` and `x-store-write-secret`. If you omit document ID, one is generated; existing documents with the same ID are updated.
|
|
3211
2993
|
* @summary Index a single document
|
|
3212
2994
|
* @param {string} xStoreid Store ID (from dashboard)
|
|
3213
2995
|
* @param {string} xStoreWriteSecret Store write secret
|
|
3214
|
-
* @param {string} xStoreID Store ID (must match x-storeid header)
|
|
3215
2996
|
* @param {DataTypesDocumentRequest} dataTypesDocumentRequest Document fields to index
|
|
3216
2997
|
* @param {*} [options] Override http request option.
|
|
3217
2998
|
* @throws {RequiredError}
|
|
3218
2999
|
*/
|
|
3219
|
-
|
|
3000
|
+
apiV1StoresDocumentsPost(xStoreid: string, xStoreWriteSecret: string, dataTypesDocumentRequest: DataTypesDocumentRequest, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesDocumentResponseWrapper>;
|
|
3220
3001
|
/**
|
|
3221
|
-
* Returns basic store details (name, location, status). **Auth:** `x-storeid` and `x-storesecret`.
|
|
3002
|
+
* Returns basic store details (name, location, status). **Auth:** `x-storeid` and `x-storesecret`.
|
|
3222
3003
|
* @summary Get store info
|
|
3223
3004
|
* @param {string} xStoreid Store ID (from dashboard)
|
|
3224
3005
|
* @param {string} xStoresecret Store read secret
|
|
3225
|
-
* @param {string} xStoreID Store ID (must match x-storeid header)
|
|
3226
3006
|
* @param {*} [options] Override http request option.
|
|
3227
3007
|
* @throws {RequiredError}
|
|
3228
3008
|
*/
|
|
3229
|
-
|
|
3009
|
+
apiV1StoresGet(xStoreid: string, xStoresecret: string, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesGenericResponseDataTypesStoreInfoResponse>;
|
|
3230
3010
|
/**
|
|
3231
|
-
* Returns autocomplete/suggestions configuration for the store. **Auth:** `x-storeid` and `x-storesecret`.
|
|
3011
|
+
* Returns autocomplete/suggestions configuration for the store. **Auth:** `x-storeid` and `x-storesecret`.
|
|
3232
3012
|
* @summary Get query suggestions configuration
|
|
3233
3013
|
* @param {string} xStoreid Store ID (from dashboard)
|
|
3234
3014
|
* @param {string} xStoresecret Store read secret
|
|
3235
|
-
* @param {string} xStoreID Store ID (must match x-storeid header)
|
|
3236
3015
|
* @param {*} [options] Override http request option.
|
|
3237
3016
|
* @throws {RequiredError}
|
|
3238
3017
|
*/
|
|
3239
|
-
|
|
3018
|
+
apiV1StoresQuerySuggestionsConfigGet(xStoreid: string, xStoresecret: string, options?: RawAxiosRequestConfig): AxiosPromise<QuerySuggestionsServiceQuerySuggestionsAPIResponse>;
|
|
3240
3019
|
/**
|
|
3241
|
-
* Update autocomplete/suggestions settings for the store. Partial updates supported. **Auth:** `x-storeid` and `x-store-write-secret`.
|
|
3020
|
+
* Update autocomplete/suggestions settings for the store. Partial updates supported. **Auth:** `x-storeid` and `x-store-write-secret`.
|
|
3242
3021
|
* @summary Update query suggestions configuration
|
|
3243
3022
|
* @param {string} xStoreid Store ID (from dashboard)
|
|
3244
3023
|
* @param {string} xStoreWriteSecret Store write secret
|
|
3245
|
-
* @param {string} xStoreID Store ID (must match x-storeid header)
|
|
3246
3024
|
* @param {QuerySuggestionsServiceUpdateSuggestionConfigRequest} querySuggestionsServiceUpdateSuggestionConfigRequest Fields to update (partial)
|
|
3247
3025
|
* @param {*} [options] Override http request option.
|
|
3248
3026
|
* @throws {RequiredError}
|
|
3249
3027
|
*/
|
|
3250
|
-
|
|
3028
|
+
apiV1StoresQuerySuggestionsConfigPut(xStoreid: string, xStoreWriteSecret: string, querySuggestionsServiceUpdateSuggestionConfigRequest: QuerySuggestionsServiceUpdateSuggestionConfigRequest, options?: RawAxiosRequestConfig): AxiosPromise<QuerySuggestionsServiceQuerySuggestionsAPIResponse>;
|
|
3251
3029
|
/**
|
|
3252
|
-
* Returns the current search index schema (fields and options) for the store. **Auth:** `x-storeid` and `x-storesecret`.
|
|
3030
|
+
* Returns the current search index schema (fields and options) for the store. **Auth:** `x-storeid` and `x-storesecret`.
|
|
3253
3031
|
* @summary Get index schema
|
|
3254
3032
|
* @param {string} xStoreid Store ID (from dashboard)
|
|
3255
3033
|
* @param {string} xStoresecret Store read secret
|
|
3256
|
-
* @param {string} xStoreID Store ID (must match x-storeid header)
|
|
3257
3034
|
* @param {*} [options] Override http request option.
|
|
3258
3035
|
* @throws {RequiredError}
|
|
3259
3036
|
*/
|
|
3260
|
-
|
|
3037
|
+
apiV1StoresSchemaGet(xStoreid: string, xStoresecret: string, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesSchemaResponseWrapper>;
|
|
3261
3038
|
/**
|
|
3262
|
-
* 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`.
|
|
3039
|
+
* 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`.
|
|
3263
3040
|
* @summary Create or update index schema
|
|
3264
3041
|
* @param {string} xStoreid Store ID (from dashboard)
|
|
3265
3042
|
* @param {string} xStoreWriteSecret Store write secret
|
|
3266
|
-
* @param {string} xStoreID Store ID (must match x-storeid header)
|
|
3267
3043
|
* @param {DataTypesCollectionSchemaRequest} dataTypesCollectionSchemaRequest Schema definition and mode
|
|
3268
3044
|
* @param {*} [options] Override http request option.
|
|
3269
3045
|
* @throws {RequiredError}
|
|
3270
3046
|
*/
|
|
3271
|
-
|
|
3047
|
+
apiV1StoresSchemaPost(xStoreid: string, xStoreWriteSecret: string, dataTypesCollectionSchemaRequest: DataTypesCollectionSchemaRequest, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesSchemaResponseWrapper>;
|
|
3272
3048
|
};
|
|
3273
3049
|
/**
|
|
3274
3050
|
* StoreManagementApi - object-oriented interface
|
|
3275
3051
|
*/
|
|
3276
3052
|
export declare class StoreManagementApi extends BaseAPI {
|
|
3277
3053
|
/**
|
|
3278
|
-
*
|
|
3279
|
-
* @summary Create Store (Public SDK API)
|
|
3280
|
-
* @param {string} authorization Bearer JWT Token
|
|
3281
|
-
* @param {DataTypesCreateStoreRequest} dataTypesCreateStoreRequest Store creation request
|
|
3282
|
-
* @param {*} [options] Override http request option.
|
|
3283
|
-
* @throws {RequiredError}
|
|
3284
|
-
*/
|
|
3285
|
-
apiV1StoresPost(authorization: string, dataTypesCreateStoreRequest: DataTypesCreateStoreRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesGenericResponseDataTypesCreateStoreResponse, any, {}>>;
|
|
3286
|
-
/**
|
|
3287
|
-
* Returns search and query-suggestions configuration for the store. **Auth:** `x-storeid` and `x-storesecret`. Path `xStoreID` must match the `x-storeid` header.
|
|
3054
|
+
* Returns search and query-suggestions configuration for the store. **Auth:** `x-storeid` and `x-storesecret`.
|
|
3288
3055
|
* @summary Get store configuration
|
|
3289
3056
|
* @param {string} xStoreid Store ID (from dashboard)
|
|
3290
3057
|
* @param {string} xStoresecret Store read secret
|
|
3291
|
-
* @param {string} xStoreID Store ID (must match x-storeid header)
|
|
3292
3058
|
* @param {*} [options] Override http request option.
|
|
3293
3059
|
* @throws {RequiredError}
|
|
3294
3060
|
*/
|
|
3295
|
-
|
|
3061
|
+
apiV1StoresConfigGet(xStoreid: string, xStoresecret: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesGenericResponseDataTypesStoreConfigWithOnboardingResponse, any, {}>>;
|
|
3296
3062
|
/**
|
|
3297
|
-
* Update search and store settings. Partial updates supported. **Auth:** `x-storeid` and `x-store-write-secret`.
|
|
3063
|
+
* Update search and store settings. Partial updates supported. **Auth:** `x-storeid` and `x-store-write-secret`.
|
|
3298
3064
|
* @summary Update store configuration
|
|
3299
3065
|
* @param {string} xStoreid Store ID (from dashboard)
|
|
3300
3066
|
* @param {string} xStoreWriteSecret Store write secret
|
|
3301
|
-
* @param {
|
|
3302
|
-
* @param {DataTypesIndexConfig} dataTypesIndexConfig Fields to update (partial)
|
|
3067
|
+
* @param {DataTypesStoreConfigUpdateRequest} dataTypesStoreConfigUpdateRequest Fields to update (partial, includes allow_public_search)
|
|
3303
3068
|
* @param {*} [options] Override http request option.
|
|
3304
3069
|
* @throws {RequiredError}
|
|
3305
3070
|
*/
|
|
3306
|
-
|
|
3071
|
+
apiV1StoresConfigPut(xStoreid: string, xStoreWriteSecret: string, dataTypesStoreConfigUpdateRequest: DataTypesStoreConfigUpdateRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesIndexConfigResponseWrapper, any, {}>>;
|
|
3307
3072
|
/**
|
|
3308
|
-
* Returns metadata for all configurable store fields (types, defaults, validation). **Auth:** `x-storeid` and `x-storesecret`.
|
|
3073
|
+
* Returns metadata for all configurable store fields (types, defaults, validation). **Auth:** `x-storeid` and `x-storesecret`.
|
|
3309
3074
|
* @summary Get store config schema
|
|
3310
3075
|
* @param {string} xStoreid Store ID (from dashboard)
|
|
3311
3076
|
* @param {string} xStoresecret Store read secret
|
|
3312
|
-
* @param {string} xStoreID Store ID (must match x-storeid header)
|
|
3313
3077
|
* @param {*} [options] Override http request option.
|
|
3314
3078
|
* @throws {RequiredError}
|
|
3315
3079
|
*/
|
|
3316
|
-
|
|
3080
|
+
apiV1StoresConfigSchemaGet(xStoreid: string, xStoresecret: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesConfigurationSchemaResponseWrapper, any, {}>>;
|
|
3317
3081
|
/**
|
|
3318
|
-
* Run multiple document operations in one request (insert, update, upsert, delete). **Auth:** `x-storeid` and `x-store-write-secret`.
|
|
3082
|
+
* Run multiple document operations in one request (insert, update, upsert, delete). **Auth:** `x-storeid` and `x-store-write-secret`. Each item can specify its own action.
|
|
3319
3083
|
* @summary Bulk index documents
|
|
3320
3084
|
* @param {string} xStoreid Store ID (from dashboard)
|
|
3321
3085
|
* @param {string} xStoreWriteSecret Store write secret
|
|
3322
|
-
* @param {string} xStoreID Store ID (must match x-storeid header)
|
|
3323
3086
|
* @param {DataTypesBulkDocumentRequest} dataTypesBulkDocumentRequest List of operations
|
|
3324
3087
|
* @param {*} [options] Override http request option.
|
|
3325
3088
|
* @throws {RequiredError}
|
|
3326
3089
|
*/
|
|
3327
|
-
|
|
3090
|
+
apiV1StoresDocumentsBulkPost(xStoreid: string, xStoreWriteSecret: string, dataTypesBulkDocumentRequest: DataTypesBulkDocumentRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesBulkDocumentResponseWrapper, any, {}>>;
|
|
3328
3091
|
/**
|
|
3329
|
-
* Removes all documents from the store\'s search index; schema is preserved. **Auth:** `x-storeid` and `x-store-write-secret`.
|
|
3092
|
+
* Removes all documents from the store\'s search index; schema is preserved. **Auth:** `x-storeid` and `x-store-write-secret`.
|
|
3330
3093
|
* @summary Clear all documents
|
|
3331
3094
|
* @param {string} xStoreid Store ID (from dashboard)
|
|
3332
3095
|
* @param {string} xStoreWriteSecret Store write secret
|
|
3333
|
-
* @param {string} xStoreID Store ID (must match x-storeid header)
|
|
3334
3096
|
* @param {*} [options] Override http request option.
|
|
3335
3097
|
* @throws {RequiredError}
|
|
3336
3098
|
*/
|
|
3337
|
-
|
|
3099
|
+
apiV1StoresDocumentsDelete(xStoreid: string, xStoreWriteSecret: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesClearDocumentsResponseWrapper, any, {}>>;
|
|
3338
3100
|
/**
|
|
3339
|
-
* Remove a document from the store\'s search index by ID. **Auth:** `x-storeid` and `x-store-write-secret`.
|
|
3101
|
+
* Remove a document from the store\'s search index by ID. **Auth:** `x-storeid` and `x-store-write-secret`.
|
|
3340
3102
|
* @summary Delete a document
|
|
3341
3103
|
* @param {string} xStoreid Store ID (from dashboard)
|
|
3342
3104
|
* @param {string} xStoreWriteSecret Store write secret
|
|
3343
|
-
* @param {string} xStoreID Store ID (must match x-storeid header)
|
|
3344
3105
|
* @param {string} documentID Document ID to delete
|
|
3345
3106
|
* @param {*} [options] Override http request option.
|
|
3346
3107
|
* @throws {RequiredError}
|
|
3347
3108
|
*/
|
|
3348
|
-
|
|
3109
|
+
apiV1StoresDocumentsDocumentIDDelete(xStoreid: string, xStoreWriteSecret: string, documentID: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesDocumentResponseWrapper, any, {}>>;
|
|
3349
3110
|
/**
|
|
3350
|
-
* Retrieve a single document from the store\'s search index by ID. **Auth:** `x-storeid` and `x-storesecret
|
|
3111
|
+
* Retrieve a single document from the store\'s search index by ID. **Auth:** `x-storeid` and `x-storesecret`. Used by product pages and PDP.
|
|
3351
3112
|
* @summary Get a document by ID
|
|
3352
3113
|
* @param {string} xStoreid Store ID (from dashboard)
|
|
3353
3114
|
* @param {string} xStoresecret Store read secret
|
|
3354
|
-
* @param {string} xStoreID Store ID (must match x-storeid header)
|
|
3355
3115
|
* @param {string} documentID Document ID to retrieve
|
|
3356
3116
|
* @param {*} [options] Override http request option.
|
|
3357
3117
|
* @throws {RequiredError}
|
|
3358
3118
|
*/
|
|
3359
|
-
|
|
3119
|
+
apiV1StoresDocumentsDocumentIDGet(xStoreid: string, xStoresecret: string, documentID: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesDocumentResponseWrapper, any, {}>>;
|
|
3360
3120
|
/**
|
|
3361
|
-
* Add or update one document in the store\'s search index. **Auth:** `x-storeid` and `x-store-write-secret`.
|
|
3121
|
+
* Add or update one document in the store\'s search index. **Auth:** `x-storeid` and `x-store-write-secret`. If you omit document ID, one is generated; existing documents with the same ID are updated.
|
|
3362
3122
|
* @summary Index a single document
|
|
3363
3123
|
* @param {string} xStoreid Store ID (from dashboard)
|
|
3364
3124
|
* @param {string} xStoreWriteSecret Store write secret
|
|
3365
|
-
* @param {string} xStoreID Store ID (must match x-storeid header)
|
|
3366
3125
|
* @param {DataTypesDocumentRequest} dataTypesDocumentRequest Document fields to index
|
|
3367
3126
|
* @param {*} [options] Override http request option.
|
|
3368
3127
|
* @throws {RequiredError}
|
|
3369
3128
|
*/
|
|
3370
|
-
|
|
3129
|
+
apiV1StoresDocumentsPost(xStoreid: string, xStoreWriteSecret: string, dataTypesDocumentRequest: DataTypesDocumentRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesDocumentResponseWrapper, any, {}>>;
|
|
3371
3130
|
/**
|
|
3372
|
-
* Returns basic store details (name, location, status). **Auth:** `x-storeid` and `x-storesecret`.
|
|
3131
|
+
* Returns basic store details (name, location, status). **Auth:** `x-storeid` and `x-storesecret`.
|
|
3373
3132
|
* @summary Get store info
|
|
3374
3133
|
* @param {string} xStoreid Store ID (from dashboard)
|
|
3375
3134
|
* @param {string} xStoresecret Store read secret
|
|
3376
|
-
* @param {string} xStoreID Store ID (must match x-storeid header)
|
|
3377
3135
|
* @param {*} [options] Override http request option.
|
|
3378
3136
|
* @throws {RequiredError}
|
|
3379
3137
|
*/
|
|
3380
|
-
|
|
3138
|
+
apiV1StoresGet(xStoreid: string, xStoresecret: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesGenericResponseDataTypesStoreInfoResponse, any, {}>>;
|
|
3381
3139
|
/**
|
|
3382
|
-
* Returns autocomplete/suggestions configuration for the store. **Auth:** `x-storeid` and `x-storesecret`.
|
|
3140
|
+
* Returns autocomplete/suggestions configuration for the store. **Auth:** `x-storeid` and `x-storesecret`.
|
|
3383
3141
|
* @summary Get query suggestions configuration
|
|
3384
3142
|
* @param {string} xStoreid Store ID (from dashboard)
|
|
3385
3143
|
* @param {string} xStoresecret Store read secret
|
|
3386
|
-
* @param {string} xStoreID Store ID (must match x-storeid header)
|
|
3387
3144
|
* @param {*} [options] Override http request option.
|
|
3388
3145
|
* @throws {RequiredError}
|
|
3389
3146
|
*/
|
|
3390
|
-
|
|
3147
|
+
apiV1StoresQuerySuggestionsConfigGet(xStoreid: string, xStoresecret: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<QuerySuggestionsServiceQuerySuggestionsAPIResponse, any, {}>>;
|
|
3391
3148
|
/**
|
|
3392
|
-
* Update autocomplete/suggestions settings for the store. Partial updates supported. **Auth:** `x-storeid` and `x-store-write-secret`.
|
|
3149
|
+
* Update autocomplete/suggestions settings for the store. Partial updates supported. **Auth:** `x-storeid` and `x-store-write-secret`.
|
|
3393
3150
|
* @summary Update query suggestions configuration
|
|
3394
3151
|
* @param {string} xStoreid Store ID (from dashboard)
|
|
3395
3152
|
* @param {string} xStoreWriteSecret Store write secret
|
|
3396
|
-
* @param {string} xStoreID Store ID (must match x-storeid header)
|
|
3397
3153
|
* @param {QuerySuggestionsServiceUpdateSuggestionConfigRequest} querySuggestionsServiceUpdateSuggestionConfigRequest Fields to update (partial)
|
|
3398
3154
|
* @param {*} [options] Override http request option.
|
|
3399
3155
|
* @throws {RequiredError}
|
|
3400
3156
|
*/
|
|
3401
|
-
|
|
3157
|
+
apiV1StoresQuerySuggestionsConfigPut(xStoreid: string, xStoreWriteSecret: string, querySuggestionsServiceUpdateSuggestionConfigRequest: QuerySuggestionsServiceUpdateSuggestionConfigRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<QuerySuggestionsServiceQuerySuggestionsAPIResponse, any, {}>>;
|
|
3402
3158
|
/**
|
|
3403
|
-
* Returns the current search index schema (fields and options) for the store. **Auth:** `x-storeid` and `x-storesecret`.
|
|
3159
|
+
* Returns the current search index schema (fields and options) for the store. **Auth:** `x-storeid` and `x-storesecret`.
|
|
3404
3160
|
* @summary Get index schema
|
|
3405
3161
|
* @param {string} xStoreid Store ID (from dashboard)
|
|
3406
3162
|
* @param {string} xStoresecret Store read secret
|
|
3407
|
-
* @param {string} xStoreID Store ID (must match x-storeid header)
|
|
3408
3163
|
* @param {*} [options] Override http request option.
|
|
3409
3164
|
* @throws {RequiredError}
|
|
3410
3165
|
*/
|
|
3411
|
-
|
|
3166
|
+
apiV1StoresSchemaGet(xStoreid: string, xStoresecret: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesSchemaResponseWrapper, any, {}>>;
|
|
3412
3167
|
/**
|
|
3413
|
-
* 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`.
|
|
3168
|
+
* 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`.
|
|
3414
3169
|
* @summary Create or update index schema
|
|
3415
3170
|
* @param {string} xStoreid Store ID (from dashboard)
|
|
3416
3171
|
* @param {string} xStoreWriteSecret Store write secret
|
|
3417
|
-
* @param {string} xStoreID Store ID (must match x-storeid header)
|
|
3418
3172
|
* @param {DataTypesCollectionSchemaRequest} dataTypesCollectionSchemaRequest Schema definition and mode
|
|
3419
3173
|
* @param {*} [options] Override http request option.
|
|
3420
3174
|
* @throws {RequiredError}
|
|
3421
3175
|
*/
|
|
3422
|
-
|
|
3176
|
+
apiV1StoresSchemaPost(xStoreid: string, xStoreWriteSecret: string, dataTypesCollectionSchemaRequest: DataTypesCollectionSchemaRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesSchemaResponseWrapper, any, {}>>;
|
|
3423
3177
|
}
|