@seekora-ai/search-sdk 0.2.16 → 0.2.18
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 +48 -13
- package/dist/client.js +144 -131
- package/dist/config.d.ts +3 -3
- package/dist/config.js +9 -4
- package/dist/generated/api.d.ts +420 -367
- package/dist/generated/api.js +353 -508
- 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/dist/index.d.ts +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
|
}
|
|
@@ -860,6 +839,14 @@ export interface DataTypesIndexField {
|
|
|
860
839
|
'stats'?: DataTypesNumericFieldStats;
|
|
861
840
|
'type'?: string;
|
|
862
841
|
}
|
|
842
|
+
export interface DataTypesMultiSearchRequest {
|
|
843
|
+
'searches': Array<DataTypesSearchRequest>;
|
|
844
|
+
}
|
|
845
|
+
export interface DataTypesMultiSearchResponseWrapper {
|
|
846
|
+
'data'?: Array<DataTypesSearchResponse>;
|
|
847
|
+
'message'?: string;
|
|
848
|
+
'status'?: number;
|
|
849
|
+
}
|
|
863
850
|
export interface DataTypesNumericFieldStats {
|
|
864
851
|
/**
|
|
865
852
|
* Number of documents with this field
|
|
@@ -883,6 +870,10 @@ export interface DataTypesOnboardingStatus {
|
|
|
883
870
|
* Whether store is fully onboarded
|
|
884
871
|
*/
|
|
885
872
|
'is_complete'?: boolean;
|
|
873
|
+
/**
|
|
874
|
+
* Whether the check was unreliable due to transient infrastructure errors
|
|
875
|
+
*/
|
|
876
|
+
'is_degraded'?: boolean;
|
|
886
877
|
/**
|
|
887
878
|
* List of missing components
|
|
888
879
|
*/
|
|
@@ -1073,6 +1064,7 @@ export interface DataTypesSearchResult {
|
|
|
1073
1064
|
'document'?: {
|
|
1074
1065
|
[key: string]: any;
|
|
1075
1066
|
};
|
|
1067
|
+
'group_key'?: Array<any>;
|
|
1076
1068
|
'highlight'?: {
|
|
1077
1069
|
[key: string]: any;
|
|
1078
1070
|
};
|
|
@@ -1118,6 +1110,152 @@ export interface DataTypesStopwordEntry {
|
|
|
1118
1110
|
*/
|
|
1119
1111
|
'stopwords'?: Array<string>;
|
|
1120
1112
|
}
|
|
1113
|
+
export interface DataTypesStoreConfigUpdateRequest {
|
|
1114
|
+
/**
|
|
1115
|
+
* Optional: If set, updates the public search flag
|
|
1116
|
+
*/
|
|
1117
|
+
'allow_public_search'?: boolean;
|
|
1118
|
+
'collection_alias'?: string;
|
|
1119
|
+
'collection_name'?: string;
|
|
1120
|
+
'default_sorting_field'?: string;
|
|
1121
|
+
/**
|
|
1122
|
+
* Default stopwords set ID to use in searches
|
|
1123
|
+
*/
|
|
1124
|
+
'default_stopwords_set'?: string;
|
|
1125
|
+
'drop_tokens_threshold'?: number;
|
|
1126
|
+
/**
|
|
1127
|
+
* Dropdown recommendations configuration
|
|
1128
|
+
*/
|
|
1129
|
+
'dropdown_recommendations_config'?: DataTypesDropdownRecommendationsConfig;
|
|
1130
|
+
'embed'?: string;
|
|
1131
|
+
'enable_autocomplete'?: boolean;
|
|
1132
|
+
'enable_highlight'?: boolean;
|
|
1133
|
+
'enable_overrides'?: boolean;
|
|
1134
|
+
'enable_smart_autocomplete'?: boolean;
|
|
1135
|
+
/**
|
|
1136
|
+
* Enable stemming on search collections
|
|
1137
|
+
*/
|
|
1138
|
+
'enable_stemming'?: boolean;
|
|
1139
|
+
'enable_typo_highlight'?: boolean;
|
|
1140
|
+
'enable_typo_tolerance'?: boolean;
|
|
1141
|
+
/**
|
|
1142
|
+
* No omitempty to preserve empty arrays
|
|
1143
|
+
*/
|
|
1144
|
+
'exclude_fields'?: Array<string>;
|
|
1145
|
+
'exhaustive_search'?: boolean;
|
|
1146
|
+
/**
|
|
1147
|
+
* No omitempty to preserve empty arrays
|
|
1148
|
+
*/
|
|
1149
|
+
'facet_by'?: Array<string>;
|
|
1150
|
+
'facet_query'?: string;
|
|
1151
|
+
/**
|
|
1152
|
+
* No omitempty to preserve empty arrays
|
|
1153
|
+
*/
|
|
1154
|
+
'facet_ranges'?: Array<DataTypesFacetRangeConfig>;
|
|
1155
|
+
'filter_by'?: string;
|
|
1156
|
+
'group_by'?: string;
|
|
1157
|
+
'group_limit'?: number;
|
|
1158
|
+
/**
|
|
1159
|
+
* No omitempty to preserve empty arrays
|
|
1160
|
+
*/
|
|
1161
|
+
'hidden_facet_fields'?: Array<string>;
|
|
1162
|
+
/**
|
|
1163
|
+
* No omitempty to preserve empty arrays
|
|
1164
|
+
*/
|
|
1165
|
+
'hidden_fields'?: Array<string>;
|
|
1166
|
+
/**
|
|
1167
|
+
* No omitempty to preserve empty arrays
|
|
1168
|
+
*/
|
|
1169
|
+
'hidden_filter_fields'?: Array<string>;
|
|
1170
|
+
'highlight_affix_num_tokens'?: number;
|
|
1171
|
+
'highlight_end_tag'?: string;
|
|
1172
|
+
/**
|
|
1173
|
+
* No omitempty to preserve empty arrays
|
|
1174
|
+
*/
|
|
1175
|
+
'highlight_fields'?: Array<string>;
|
|
1176
|
+
/**
|
|
1177
|
+
* No omitempty to preserve empty arrays
|
|
1178
|
+
*/
|
|
1179
|
+
'highlight_full_fields'?: Array<string>;
|
|
1180
|
+
'highlight_start_tag'?: string;
|
|
1181
|
+
'image_url'?: string;
|
|
1182
|
+
/**
|
|
1183
|
+
* No omitempty to preserve empty arrays
|
|
1184
|
+
*/
|
|
1185
|
+
'include_fields'?: Array<string>;
|
|
1186
|
+
/**
|
|
1187
|
+
* \"always\", \"fallback\", or \"off\"
|
|
1188
|
+
*/
|
|
1189
|
+
'infix'?: string;
|
|
1190
|
+
'locale'?: string;
|
|
1191
|
+
'max_candidates'?: number;
|
|
1192
|
+
'max_facet_values'?: number;
|
|
1193
|
+
'min_len_1typo'?: number;
|
|
1194
|
+
'min_len_2typo'?: number;
|
|
1195
|
+
'num_typos'?: number;
|
|
1196
|
+
'page'?: number;
|
|
1197
|
+
'per_page'?: number;
|
|
1198
|
+
'prefix'?: string;
|
|
1199
|
+
'preset'?: string;
|
|
1200
|
+
'primary_text'?: string;
|
|
1201
|
+
'prioritize_exact_match'?: boolean;
|
|
1202
|
+
/**
|
|
1203
|
+
* Required: Query string
|
|
1204
|
+
*/
|
|
1205
|
+
'q'?: string;
|
|
1206
|
+
/**
|
|
1207
|
+
* Required: Array of search fields
|
|
1208
|
+
*/
|
|
1209
|
+
'query_by'?: Array<string>;
|
|
1210
|
+
/**
|
|
1211
|
+
* Optional: Relative field weights as array (no omitempty to preserve empty arrays)
|
|
1212
|
+
*/
|
|
1213
|
+
'query_by_weights'?: Array<number>;
|
|
1214
|
+
/**
|
|
1215
|
+
* Query suggestions configuration
|
|
1216
|
+
*/
|
|
1217
|
+
'query_suggestions_config'?: DataTypesQuerySuggestionsConfig;
|
|
1218
|
+
'query_syntax'?: boolean;
|
|
1219
|
+
'search_cutoff_ms'?: number;
|
|
1220
|
+
/**
|
|
1221
|
+
* \"text\", \"vector\", \"hybrid\"
|
|
1222
|
+
*/
|
|
1223
|
+
'search_strategy'?: string;
|
|
1224
|
+
'secondary_text'?: string;
|
|
1225
|
+
'semantic_ranker'?: boolean;
|
|
1226
|
+
'snippet_threshold'?: number;
|
|
1227
|
+
/**
|
|
1228
|
+
* No omitempty to preserve empty arrays
|
|
1229
|
+
*/
|
|
1230
|
+
'sort_by'?: Array<DataTypesSortField>;
|
|
1231
|
+
/**
|
|
1232
|
+
* Locale for stemming (e.g., \"en\", \"fr\", \"de\")
|
|
1233
|
+
*/
|
|
1234
|
+
'stemming_locale'?: string;
|
|
1235
|
+
/**
|
|
1236
|
+
* Flattened stopwords and synonyms fields
|
|
1237
|
+
*/
|
|
1238
|
+
'stopwords'?: Array<DataTypesStopwordEntry>;
|
|
1239
|
+
/**
|
|
1240
|
+
* No omitempty to preserve empty arrays
|
|
1241
|
+
*/
|
|
1242
|
+
'symbols_to_index'?: Array<string>;
|
|
1243
|
+
/**
|
|
1244
|
+
* No omitempty to preserve empty arrays
|
|
1245
|
+
*/
|
|
1246
|
+
'synonyms'?: Array<DataTypesSynonymEntry>;
|
|
1247
|
+
'tertiary_text'?: string;
|
|
1248
|
+
/**
|
|
1249
|
+
* Optional: Search-only scoped API key
|
|
1250
|
+
*/
|
|
1251
|
+
'token'?: string;
|
|
1252
|
+
/**
|
|
1253
|
+
* No omitempty to preserve empty arrays
|
|
1254
|
+
*/
|
|
1255
|
+
'token_separators'?: Array<string>;
|
|
1256
|
+
'use_cache'?: boolean;
|
|
1257
|
+
'vector_query'?: string;
|
|
1258
|
+
}
|
|
1121
1259
|
export interface DataTypesStoreConfigWithOnboardingResponse {
|
|
1122
1260
|
/**
|
|
1123
1261
|
* If true, allows search without authentication
|
|
@@ -1140,7 +1278,6 @@ export interface DataTypesStoreInfoResponse {
|
|
|
1140
1278
|
'createdAt'?: string;
|
|
1141
1279
|
'isActive'?: boolean;
|
|
1142
1280
|
'location'?: string;
|
|
1143
|
-
'storeId'?: number;
|
|
1144
1281
|
'storeName'?: string;
|
|
1145
1282
|
'xStoreId'?: string;
|
|
1146
1283
|
}
|
|
@@ -1819,7 +1956,7 @@ export interface QuerySuggestionsServiceUpdateSuggestionConfigRequest {
|
|
|
1819
1956
|
*/
|
|
1820
1957
|
'minimum_hits'?: number;
|
|
1821
1958
|
/**
|
|
1822
|
-
*
|
|
1959
|
+
* Extended fields
|
|
1823
1960
|
*/
|
|
1824
1961
|
'minimum_letters'?: number;
|
|
1825
1962
|
/**
|
|
@@ -1944,7 +2081,7 @@ export declare const AnalyticsEventsApiFp: (configuration?: Configuration) => {
|
|
|
1944
2081
|
* @param {*} [options] Override http request option.
|
|
1945
2082
|
* @throws {RequiredError}
|
|
1946
2083
|
*/
|
|
1947
|
-
analyticsBatchPost(xStoreid: string, xStoresecret: string, analyticsBatchPostRequest: AnalyticsBatchPostRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<
|
|
2084
|
+
analyticsBatchPost(xStoreid: string, xStoresecret: string, analyticsBatchPostRequest: AnalyticsBatchPostRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesGenericResponseDataTypesBatchEventData>>;
|
|
1948
2085
|
/**
|
|
1949
2086
|
* Retrieve analytics configuration including supported event types, batch limits, and funnel stages for client integration
|
|
1950
2087
|
* @summary Get Analytics Configuration
|
|
@@ -1953,7 +2090,7 @@ export declare const AnalyticsEventsApiFp: (configuration?: Configuration) => {
|
|
|
1953
2090
|
* @param {*} [options] Override http request option.
|
|
1954
2091
|
* @throws {RequiredError}
|
|
1955
2092
|
*/
|
|
1956
|
-
analyticsConfigGet(xStoreid: string, xStoresecret: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<
|
|
2093
|
+
analyticsConfigGet(xStoreid: string, xStoresecret: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesGenericResponseDataTypesAnalyticsConfigData>>;
|
|
1957
2094
|
/**
|
|
1958
2095
|
* Submit a single analytics event for tracking user interactions, search behavior, and conversions
|
|
1959
2096
|
* @summary Submit Analytics Event
|
|
@@ -1963,7 +2100,7 @@ export declare const AnalyticsEventsApiFp: (configuration?: Configuration) => {
|
|
|
1963
2100
|
* @param {*} [options] Override http request option.
|
|
1964
2101
|
* @throws {RequiredError}
|
|
1965
2102
|
*/
|
|
1966
|
-
analyticsEventPost(xStoreid: string, xStoresecret: string, dataTypesEventPayload: DataTypesEventPayload, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<
|
|
2103
|
+
analyticsEventPost(xStoreid: string, xStoresecret: string, dataTypesEventPayload: DataTypesEventPayload, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesGenericResponseDataTypesEventSubmitData>>;
|
|
1967
2104
|
/**
|
|
1968
2105
|
* Retrieve the complete event schema including required and optional fields, data types, and validation rules
|
|
1969
2106
|
* @summary Get Event Schema
|
|
@@ -1982,7 +2119,7 @@ export declare const AnalyticsEventsApiFp: (configuration?: Configuration) => {
|
|
|
1982
2119
|
* @param {*} [options] Override http request option.
|
|
1983
2120
|
* @throws {RequiredError}
|
|
1984
2121
|
*/
|
|
1985
|
-
analyticsValidatePost(xStoreid: string, xStoresecret: string, dataTypesEventPayload: DataTypesEventPayload, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<
|
|
2122
|
+
analyticsValidatePost(xStoreid: string, xStoresecret: string, dataTypesEventPayload: DataTypesEventPayload, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesGenericResponseDataTypesEventValidateData>>;
|
|
1986
2123
|
};
|
|
1987
2124
|
/**
|
|
1988
2125
|
* AnalyticsEventsApi - factory interface
|
|
@@ -1997,7 +2134,7 @@ export declare const AnalyticsEventsApiFactory: (configuration?: Configuration,
|
|
|
1997
2134
|
* @param {*} [options] Override http request option.
|
|
1998
2135
|
* @throws {RequiredError}
|
|
1999
2136
|
*/
|
|
2000
|
-
analyticsBatchPost(xStoreid: string, xStoresecret: string, analyticsBatchPostRequest: AnalyticsBatchPostRequest, options?: RawAxiosRequestConfig): AxiosPromise<
|
|
2137
|
+
analyticsBatchPost(xStoreid: string, xStoresecret: string, analyticsBatchPostRequest: AnalyticsBatchPostRequest, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesGenericResponseDataTypesBatchEventData>;
|
|
2001
2138
|
/**
|
|
2002
2139
|
* Retrieve analytics configuration including supported event types, batch limits, and funnel stages for client integration
|
|
2003
2140
|
* @summary Get Analytics Configuration
|
|
@@ -2006,7 +2143,7 @@ export declare const AnalyticsEventsApiFactory: (configuration?: Configuration,
|
|
|
2006
2143
|
* @param {*} [options] Override http request option.
|
|
2007
2144
|
* @throws {RequiredError}
|
|
2008
2145
|
*/
|
|
2009
|
-
analyticsConfigGet(xStoreid: string, xStoresecret: string, options?: RawAxiosRequestConfig): AxiosPromise<
|
|
2146
|
+
analyticsConfigGet(xStoreid: string, xStoresecret: string, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesGenericResponseDataTypesAnalyticsConfigData>;
|
|
2010
2147
|
/**
|
|
2011
2148
|
* Submit a single analytics event for tracking user interactions, search behavior, and conversions
|
|
2012
2149
|
* @summary Submit Analytics Event
|
|
@@ -2016,7 +2153,7 @@ export declare const AnalyticsEventsApiFactory: (configuration?: Configuration,
|
|
|
2016
2153
|
* @param {*} [options] Override http request option.
|
|
2017
2154
|
* @throws {RequiredError}
|
|
2018
2155
|
*/
|
|
2019
|
-
analyticsEventPost(xStoreid: string, xStoresecret: string, dataTypesEventPayload: DataTypesEventPayload, options?: RawAxiosRequestConfig): AxiosPromise<
|
|
2156
|
+
analyticsEventPost(xStoreid: string, xStoresecret: string, dataTypesEventPayload: DataTypesEventPayload, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesGenericResponseDataTypesEventSubmitData>;
|
|
2020
2157
|
/**
|
|
2021
2158
|
* Retrieve the complete event schema including required and optional fields, data types, and validation rules
|
|
2022
2159
|
* @summary Get Event Schema
|
|
@@ -2035,7 +2172,7 @@ export declare const AnalyticsEventsApiFactory: (configuration?: Configuration,
|
|
|
2035
2172
|
* @param {*} [options] Override http request option.
|
|
2036
2173
|
* @throws {RequiredError}
|
|
2037
2174
|
*/
|
|
2038
|
-
analyticsValidatePost(xStoreid: string, xStoresecret: string, dataTypesEventPayload: DataTypesEventPayload, options?: RawAxiosRequestConfig): AxiosPromise<
|
|
2175
|
+
analyticsValidatePost(xStoreid: string, xStoresecret: string, dataTypesEventPayload: DataTypesEventPayload, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesGenericResponseDataTypesEventValidateData>;
|
|
2039
2176
|
};
|
|
2040
2177
|
/**
|
|
2041
2178
|
* AnalyticsEventsApi - object-oriented interface
|
|
@@ -2050,7 +2187,7 @@ export declare class AnalyticsEventsApi extends BaseAPI {
|
|
|
2050
2187
|
* @param {*} [options] Override http request option.
|
|
2051
2188
|
* @throws {RequiredError}
|
|
2052
2189
|
*/
|
|
2053
|
-
analyticsBatchPost(xStoreid: string, xStoresecret: string, analyticsBatchPostRequest: AnalyticsBatchPostRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<
|
|
2190
|
+
analyticsBatchPost(xStoreid: string, xStoresecret: string, analyticsBatchPostRequest: AnalyticsBatchPostRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesGenericResponseDataTypesBatchEventData, any, {}>>;
|
|
2054
2191
|
/**
|
|
2055
2192
|
* Retrieve analytics configuration including supported event types, batch limits, and funnel stages for client integration
|
|
2056
2193
|
* @summary Get Analytics Configuration
|
|
@@ -2059,7 +2196,7 @@ export declare class AnalyticsEventsApi extends BaseAPI {
|
|
|
2059
2196
|
* @param {*} [options] Override http request option.
|
|
2060
2197
|
* @throws {RequiredError}
|
|
2061
2198
|
*/
|
|
2062
|
-
analyticsConfigGet(xStoreid: string, xStoresecret: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<
|
|
2199
|
+
analyticsConfigGet(xStoreid: string, xStoresecret: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesGenericResponseDataTypesAnalyticsConfigData, any, {}>>;
|
|
2063
2200
|
/**
|
|
2064
2201
|
* Submit a single analytics event for tracking user interactions, search behavior, and conversions
|
|
2065
2202
|
* @summary Submit Analytics Event
|
|
@@ -2069,7 +2206,7 @@ export declare class AnalyticsEventsApi extends BaseAPI {
|
|
|
2069
2206
|
* @param {*} [options] Override http request option.
|
|
2070
2207
|
* @throws {RequiredError}
|
|
2071
2208
|
*/
|
|
2072
|
-
analyticsEventPost(xStoreid: string, xStoresecret: string, dataTypesEventPayload: DataTypesEventPayload, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<
|
|
2209
|
+
analyticsEventPost(xStoreid: string, xStoresecret: string, dataTypesEventPayload: DataTypesEventPayload, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesGenericResponseDataTypesEventSubmitData, any, {}>>;
|
|
2073
2210
|
/**
|
|
2074
2211
|
* Retrieve the complete event schema including required and optional fields, data types, and validation rules
|
|
2075
2212
|
* @summary Get Event Schema
|
|
@@ -2088,7 +2225,7 @@ export declare class AnalyticsEventsApi extends BaseAPI {
|
|
|
2088
2225
|
* @param {*} [options] Override http request option.
|
|
2089
2226
|
* @throws {RequiredError}
|
|
2090
2227
|
*/
|
|
2091
|
-
analyticsValidatePost(xStoreid: string, xStoresecret: string, dataTypesEventPayload: DataTypesEventPayload, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<
|
|
2228
|
+
analyticsValidatePost(xStoreid: string, xStoresecret: string, dataTypesEventPayload: DataTypesEventPayload, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesGenericResponseDataTypesEventValidateData, any, {}>>;
|
|
2092
2229
|
}
|
|
2093
2230
|
/**
|
|
2094
2231
|
* FiltersApi - axios parameter creator
|
|
@@ -2100,21 +2237,28 @@ export declare const FiltersApiAxiosParamCreator: (configuration?: Configuration
|
|
|
2100
2237
|
* @param {string} xStoreid Store ID (from dashboard)
|
|
2101
2238
|
* @param {string} xStoresecret Store read secret (from dashboard)
|
|
2102
2239
|
* @param {string} facetName Facet field name (e.g., brand, category)
|
|
2103
|
-
* @param {
|
|
2240
|
+
* @param {string} facetQuery Prefix to search within the facet values
|
|
2241
|
+
* @param {string} [q] Search query to scope results
|
|
2242
|
+
* @param {string} [filter] Filter expression to scope results
|
|
2243
|
+
* @param {number} [maxValues] Maximum number of facet values to return
|
|
2104
2244
|
* @param {*} [options] Override http request option.
|
|
2105
2245
|
* @throws {RequiredError}
|
|
2106
2246
|
*/
|
|
2107
|
-
|
|
2247
|
+
v1FiltersFacetNameValuesGet: (xStoreid: string, xStoresecret: string, facetName: string, facetQuery: string, q?: string, filter?: string, maxValues?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
2108
2248
|
/**
|
|
2109
2249
|
* Get filter values and counts for configured facets. Use this to build faceted navigation UIs. Supports disjunctive faceting for OR-based filter combinations.
|
|
2110
2250
|
* @summary Get Filters
|
|
2111
2251
|
* @param {string} xStoreid Store ID (from dashboard)
|
|
2112
2252
|
* @param {string} xStoresecret Store read secret (from dashboard)
|
|
2113
|
-
* @param {
|
|
2253
|
+
* @param {string} [q] Search query to scope filter counts
|
|
2254
|
+
* @param {string} [filter] Filter expression (e.g. brand:=Nike)
|
|
2255
|
+
* @param {string} [facetBy] Comma-separated list of facet fields to return
|
|
2256
|
+
* @param {number} [maxFacetValues] Maximum number of values per facet
|
|
2257
|
+
* @param {string} [disjunctiveFacets] Comma-separated facet fields to treat as disjunctive (OR)
|
|
2114
2258
|
* @param {*} [options] Override http request option.
|
|
2115
2259
|
* @throws {RequiredError}
|
|
2116
2260
|
*/
|
|
2117
|
-
|
|
2261
|
+
v1FiltersGet: (xStoreid: string, xStoresecret: string, q?: string, filter?: string, facetBy?: string, maxFacetValues?: number, disjunctiveFacets?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
2118
2262
|
/**
|
|
2119
2263
|
* Get available filter field metadata including types, sortability, and configured ranges. Useful for dynamically building filter UIs.
|
|
2120
2264
|
* @summary Get Filters Schema
|
|
@@ -2135,21 +2279,28 @@ export declare const FiltersApiFp: (configuration?: Configuration) => {
|
|
|
2135
2279
|
* @param {string} xStoreid Store ID (from dashboard)
|
|
2136
2280
|
* @param {string} xStoresecret Store read secret (from dashboard)
|
|
2137
2281
|
* @param {string} facetName Facet field name (e.g., brand, category)
|
|
2138
|
-
* @param {
|
|
2282
|
+
* @param {string} facetQuery Prefix to search within the facet values
|
|
2283
|
+
* @param {string} [q] Search query to scope results
|
|
2284
|
+
* @param {string} [filter] Filter expression to scope results
|
|
2285
|
+
* @param {number} [maxValues] Maximum number of facet values to return
|
|
2139
2286
|
* @param {*} [options] Override http request option.
|
|
2140
2287
|
* @throws {RequiredError}
|
|
2141
2288
|
*/
|
|
2142
|
-
|
|
2289
|
+
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
2290
|
/**
|
|
2144
2291
|
* Get filter values and counts for configured facets. Use this to build faceted navigation UIs. Supports disjunctive faceting for OR-based filter combinations.
|
|
2145
2292
|
* @summary Get Filters
|
|
2146
2293
|
* @param {string} xStoreid Store ID (from dashboard)
|
|
2147
2294
|
* @param {string} xStoresecret Store read secret (from dashboard)
|
|
2148
|
-
* @param {
|
|
2295
|
+
* @param {string} [q] Search query to scope filter counts
|
|
2296
|
+
* @param {string} [filter] Filter expression (e.g. brand:=Nike)
|
|
2297
|
+
* @param {string} [facetBy] Comma-separated list of facet fields to return
|
|
2298
|
+
* @param {number} [maxFacetValues] Maximum number of values per facet
|
|
2299
|
+
* @param {string} [disjunctiveFacets] Comma-separated facet fields to treat as disjunctive (OR)
|
|
2149
2300
|
* @param {*} [options] Override http request option.
|
|
2150
2301
|
* @throws {RequiredError}
|
|
2151
2302
|
*/
|
|
2152
|
-
|
|
2303
|
+
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
2304
|
/**
|
|
2154
2305
|
* Get available filter field metadata including types, sortability, and configured ranges. Useful for dynamically building filter UIs.
|
|
2155
2306
|
* @summary Get Filters Schema
|
|
@@ -2170,21 +2321,28 @@ export declare const FiltersApiFactory: (configuration?: Configuration, basePath
|
|
|
2170
2321
|
* @param {string} xStoreid Store ID (from dashboard)
|
|
2171
2322
|
* @param {string} xStoresecret Store read secret (from dashboard)
|
|
2172
2323
|
* @param {string} facetName Facet field name (e.g., brand, category)
|
|
2173
|
-
* @param {
|
|
2324
|
+
* @param {string} facetQuery Prefix to search within the facet values
|
|
2325
|
+
* @param {string} [q] Search query to scope results
|
|
2326
|
+
* @param {string} [filter] Filter expression to scope results
|
|
2327
|
+
* @param {number} [maxValues] Maximum number of facet values to return
|
|
2174
2328
|
* @param {*} [options] Override http request option.
|
|
2175
2329
|
* @throws {RequiredError}
|
|
2176
2330
|
*/
|
|
2177
|
-
|
|
2331
|
+
v1FiltersFacetNameValuesGet(xStoreid: string, xStoresecret: string, facetName: string, facetQuery: string, q?: string, filter?: string, maxValues?: number, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesFacetValuesSearchResponseWrapper>;
|
|
2178
2332
|
/**
|
|
2179
2333
|
* Get filter values and counts for configured facets. Use this to build faceted navigation UIs. Supports disjunctive faceting for OR-based filter combinations.
|
|
2180
2334
|
* @summary Get Filters
|
|
2181
2335
|
* @param {string} xStoreid Store ID (from dashboard)
|
|
2182
2336
|
* @param {string} xStoresecret Store read secret (from dashboard)
|
|
2183
|
-
* @param {
|
|
2337
|
+
* @param {string} [q] Search query to scope filter counts
|
|
2338
|
+
* @param {string} [filter] Filter expression (e.g. brand:=Nike)
|
|
2339
|
+
* @param {string} [facetBy] Comma-separated list of facet fields to return
|
|
2340
|
+
* @param {number} [maxFacetValues] Maximum number of values per facet
|
|
2341
|
+
* @param {string} [disjunctiveFacets] Comma-separated facet fields to treat as disjunctive (OR)
|
|
2184
2342
|
* @param {*} [options] Override http request option.
|
|
2185
2343
|
* @throws {RequiredError}
|
|
2186
2344
|
*/
|
|
2187
|
-
|
|
2345
|
+
v1FiltersGet(xStoreid: string, xStoresecret: string, q?: string, filter?: string, facetBy?: string, maxFacetValues?: number, disjunctiveFacets?: string, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesFiltersResponseWrapper>;
|
|
2188
2346
|
/**
|
|
2189
2347
|
* Get available filter field metadata including types, sortability, and configured ranges. Useful for dynamically building filter UIs.
|
|
2190
2348
|
* @summary Get Filters Schema
|
|
@@ -2205,21 +2363,28 @@ export declare class FiltersApi extends BaseAPI {
|
|
|
2205
2363
|
* @param {string} xStoreid Store ID (from dashboard)
|
|
2206
2364
|
* @param {string} xStoresecret Store read secret (from dashboard)
|
|
2207
2365
|
* @param {string} facetName Facet field name (e.g., brand, category)
|
|
2208
|
-
* @param {
|
|
2366
|
+
* @param {string} facetQuery Prefix to search within the facet values
|
|
2367
|
+
* @param {string} [q] Search query to scope results
|
|
2368
|
+
* @param {string} [filter] Filter expression to scope results
|
|
2369
|
+
* @param {number} [maxValues] Maximum number of facet values to return
|
|
2209
2370
|
* @param {*} [options] Override http request option.
|
|
2210
2371
|
* @throws {RequiredError}
|
|
2211
2372
|
*/
|
|
2212
|
-
|
|
2373
|
+
v1FiltersFacetNameValuesGet(xStoreid: string, xStoresecret: string, facetName: string, facetQuery: string, q?: string, filter?: string, maxValues?: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesFacetValuesSearchResponseWrapper, any, {}>>;
|
|
2213
2374
|
/**
|
|
2214
2375
|
* Get filter values and counts for configured facets. Use this to build faceted navigation UIs. Supports disjunctive faceting for OR-based filter combinations.
|
|
2215
2376
|
* @summary Get Filters
|
|
2216
2377
|
* @param {string} xStoreid Store ID (from dashboard)
|
|
2217
2378
|
* @param {string} xStoresecret Store read secret (from dashboard)
|
|
2218
|
-
* @param {
|
|
2379
|
+
* @param {string} [q] Search query to scope filter counts
|
|
2380
|
+
* @param {string} [filter] Filter expression (e.g. brand:=Nike)
|
|
2381
|
+
* @param {string} [facetBy] Comma-separated list of facet fields to return
|
|
2382
|
+
* @param {number} [maxFacetValues] Maximum number of values per facet
|
|
2383
|
+
* @param {string} [disjunctiveFacets] Comma-separated facet fields to treat as disjunctive (OR)
|
|
2219
2384
|
* @param {*} [options] Override http request option.
|
|
2220
2385
|
* @throws {RequiredError}
|
|
2221
2386
|
*/
|
|
2222
|
-
|
|
2387
|
+
v1FiltersGet(xStoreid: string, xStoresecret: string, q?: string, filter?: string, facetBy?: string, maxFacetValues?: number, disjunctiveFacets?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesFiltersResponseWrapper, any, {}>>;
|
|
2223
2388
|
/**
|
|
2224
2389
|
* Get available filter field metadata including types, sortability, and configured ranges. Useful for dynamically building filter UIs.
|
|
2225
2390
|
* @summary Get Filters Schema
|
|
@@ -2482,73 +2647,19 @@ export declare const V1SuggestionsQueriesGetTimeRangeEnum: {
|
|
|
2482
2647
|
};
|
|
2483
2648
|
export type V1SuggestionsQueriesGetTimeRangeEnum = typeof V1SuggestionsQueriesGetTimeRangeEnum[keyof typeof V1SuggestionsQueriesGetTimeRangeEnum];
|
|
2484
2649
|
/**
|
|
2485
|
-
*
|
|
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
|
|
2650
|
+
* SearchApi - axios parameter creator
|
|
2534
2651
|
*/
|
|
2535
|
-
export declare
|
|
2652
|
+
export declare const SearchApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
2536
2653
|
/**
|
|
2537
|
-
*
|
|
2538
|
-
* @summary
|
|
2539
|
-
* @param {string} xStoreid Store ID
|
|
2540
|
-
* @param {string} xStoresecret Store read secret
|
|
2541
|
-
* @param {
|
|
2542
|
-
* @param {string} [xAnonId] Anonymous ID (provide either x-user-id or x-anon-id)
|
|
2654
|
+
* Execute multiple search queries in a single request. Each query is independent and can have its own filters, pagination, and sorting. Maximum 10 queries per request. **Authentication:** Send `x-storeid` and `x-storesecret` headers.
|
|
2655
|
+
* @summary Multi-Search (POST)
|
|
2656
|
+
* @param {string} xStoreid Store ID (from dashboard)
|
|
2657
|
+
* @param {string} xStoresecret Store read secret (from dashboard)
|
|
2658
|
+
* @param {DataTypesMultiSearchRequest} dataTypesMultiSearchRequest Array of search queries
|
|
2543
2659
|
* @param {*} [options] Override http request option.
|
|
2544
2660
|
* @throws {RequiredError}
|
|
2545
2661
|
*/
|
|
2546
|
-
|
|
2547
|
-
}
|
|
2548
|
-
/**
|
|
2549
|
-
* SearchApi - axios parameter creator
|
|
2550
|
-
*/
|
|
2551
|
-
export declare const SearchApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
2662
|
+
v1MultiSearchPost: (xStoreid: string, xStoresecret: string, dataTypesMultiSearchRequest: DataTypesMultiSearchRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
2552
2663
|
/**
|
|
2553
2664
|
* Same as POST search; all parameters are passed as query params. **Authentication:** `x-storeid` and `x-storesecret` headers. Use `q` for the search query; optional params: `page`, `per_page`, `filter_by`, `sort_by`, `facet_by`, `widget_mode`, `include_suggestions`, etc.
|
|
2554
2665
|
* @summary Search (GET)
|
|
@@ -2617,6 +2728,16 @@ export declare const SearchApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
2617
2728
|
* SearchApi - functional programming interface
|
|
2618
2729
|
*/
|
|
2619
2730
|
export declare const SearchApiFp: (configuration?: Configuration) => {
|
|
2731
|
+
/**
|
|
2732
|
+
* Execute multiple search queries in a single request. Each query is independent and can have its own filters, pagination, and sorting. Maximum 10 queries per request. **Authentication:** Send `x-storeid` and `x-storesecret` headers.
|
|
2733
|
+
* @summary Multi-Search (POST)
|
|
2734
|
+
* @param {string} xStoreid Store ID (from dashboard)
|
|
2735
|
+
* @param {string} xStoresecret Store read secret (from dashboard)
|
|
2736
|
+
* @param {DataTypesMultiSearchRequest} dataTypesMultiSearchRequest Array of search queries
|
|
2737
|
+
* @param {*} [options] Override http request option.
|
|
2738
|
+
* @throws {RequiredError}
|
|
2739
|
+
*/
|
|
2740
|
+
v1MultiSearchPost(xStoreid: string, xStoresecret: string, dataTypesMultiSearchRequest: DataTypesMultiSearchRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesMultiSearchResponseWrapper>>;
|
|
2620
2741
|
/**
|
|
2621
2742
|
* Same as POST search; all parameters are passed as query params. **Authentication:** `x-storeid` and `x-storesecret` headers. Use `q` for the search query; optional params: `page`, `per_page`, `filter_by`, `sort_by`, `facet_by`, `widget_mode`, `include_suggestions`, etc.
|
|
2622
2743
|
* @summary Search (GET)
|
|
@@ -2685,6 +2806,16 @@ export declare const SearchApiFp: (configuration?: Configuration) => {
|
|
|
2685
2806
|
* SearchApi - factory interface
|
|
2686
2807
|
*/
|
|
2687
2808
|
export declare const SearchApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
2809
|
+
/**
|
|
2810
|
+
* Execute multiple search queries in a single request. Each query is independent and can have its own filters, pagination, and sorting. Maximum 10 queries per request. **Authentication:** Send `x-storeid` and `x-storesecret` headers.
|
|
2811
|
+
* @summary Multi-Search (POST)
|
|
2812
|
+
* @param {string} xStoreid Store ID (from dashboard)
|
|
2813
|
+
* @param {string} xStoresecret Store read secret (from dashboard)
|
|
2814
|
+
* @param {DataTypesMultiSearchRequest} dataTypesMultiSearchRequest Array of search queries
|
|
2815
|
+
* @param {*} [options] Override http request option.
|
|
2816
|
+
* @throws {RequiredError}
|
|
2817
|
+
*/
|
|
2818
|
+
v1MultiSearchPost(xStoreid: string, xStoresecret: string, dataTypesMultiSearchRequest: DataTypesMultiSearchRequest, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesMultiSearchResponseWrapper>;
|
|
2688
2819
|
/**
|
|
2689
2820
|
* Same as POST search; all parameters are passed as query params. **Authentication:** `x-storeid` and `x-storesecret` headers. Use `q` for the search query; optional params: `page`, `per_page`, `filter_by`, `sort_by`, `facet_by`, `widget_mode`, `include_suggestions`, etc.
|
|
2690
2821
|
* @summary Search (GET)
|
|
@@ -2753,6 +2884,16 @@ export declare const SearchApiFactory: (configuration?: Configuration, basePath?
|
|
|
2753
2884
|
* SearchApi - object-oriented interface
|
|
2754
2885
|
*/
|
|
2755
2886
|
export declare class SearchApi extends BaseAPI {
|
|
2887
|
+
/**
|
|
2888
|
+
* Execute multiple search queries in a single request. Each query is independent and can have its own filters, pagination, and sorting. Maximum 10 queries per request. **Authentication:** Send `x-storeid` and `x-storesecret` headers.
|
|
2889
|
+
* @summary Multi-Search (POST)
|
|
2890
|
+
* @param {string} xStoreid Store ID (from dashboard)
|
|
2891
|
+
* @param {string} xStoresecret Store read secret (from dashboard)
|
|
2892
|
+
* @param {DataTypesMultiSearchRequest} dataTypesMultiSearchRequest Array of search queries
|
|
2893
|
+
* @param {*} [options] Override http request option.
|
|
2894
|
+
* @throws {RequiredError}
|
|
2895
|
+
*/
|
|
2896
|
+
v1MultiSearchPost(xStoreid: string, xStoresecret: string, dataTypesMultiSearchRequest: DataTypesMultiSearchRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesMultiSearchResponseWrapper, any, {}>>;
|
|
2756
2897
|
/**
|
|
2757
2898
|
* Same as POST search; all parameters are passed as query params. **Authentication:** `x-storeid` and `x-storesecret` headers. Use `q` for the search query; optional params: `page`, `per_page`, `filter_by`, `sort_by`, `facet_by`, `widget_mode`, `include_suggestions`, etc.
|
|
2758
2899
|
* @summary Search (GET)
|
|
@@ -2822,602 +2963,514 @@ export declare class SearchApi extends BaseAPI {
|
|
|
2822
2963
|
*/
|
|
2823
2964
|
export declare const StoreManagementApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
2824
2965
|
/**
|
|
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.
|
|
2966
|
+
* Returns search and query-suggestions configuration for the store. **Auth:** `x-storeid` and `x-storesecret`.
|
|
2835
2967
|
* @summary Get store configuration
|
|
2836
2968
|
* @param {string} xStoreid Store ID (from dashboard)
|
|
2837
2969
|
* @param {string} xStoresecret Store read secret
|
|
2838
|
-
* @param {string} xStoreID Store ID (must match x-storeid header)
|
|
2839
2970
|
* @param {*} [options] Override http request option.
|
|
2840
2971
|
* @throws {RequiredError}
|
|
2841
2972
|
*/
|
|
2842
|
-
|
|
2973
|
+
apiV1StoresConfigGet: (xStoreid: string, xStoresecret: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
2843
2974
|
/**
|
|
2844
|
-
* Update search and store settings. Partial updates supported. **Auth:** `x-storeid` and `x-store-write-secret`.
|
|
2975
|
+
* Update search and store settings. Partial updates supported. **Auth:** `x-storeid` and `x-store-write-secret`.
|
|
2845
2976
|
* @summary Update store configuration
|
|
2846
2977
|
* @param {string} xStoreid Store ID (from dashboard)
|
|
2847
2978
|
* @param {string} xStoreWriteSecret Store write secret
|
|
2848
|
-
* @param {
|
|
2849
|
-
* @param {DataTypesIndexConfig} dataTypesIndexConfig Fields to update (partial)
|
|
2979
|
+
* @param {DataTypesStoreConfigUpdateRequest} dataTypesStoreConfigUpdateRequest Fields to update (partial, includes allow_public_search)
|
|
2850
2980
|
* @param {*} [options] Override http request option.
|
|
2851
2981
|
* @throws {RequiredError}
|
|
2852
2982
|
*/
|
|
2853
|
-
|
|
2983
|
+
apiV1StoresConfigPut: (xStoreid: string, xStoreWriteSecret: string, dataTypesStoreConfigUpdateRequest: DataTypesStoreConfigUpdateRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
2854
2984
|
/**
|
|
2855
|
-
* Returns metadata for all configurable store fields (types, defaults, validation). **Auth:** `x-storeid` and `x-storesecret`.
|
|
2985
|
+
* Returns metadata for all configurable store fields (types, defaults, validation). **Auth:** `x-storeid` and `x-storesecret`.
|
|
2856
2986
|
* @summary Get store config schema
|
|
2857
2987
|
* @param {string} xStoreid Store ID (from dashboard)
|
|
2858
2988
|
* @param {string} xStoresecret Store read secret
|
|
2859
|
-
* @param {string} xStoreID Store ID (must match x-storeid header)
|
|
2860
2989
|
* @param {*} [options] Override http request option.
|
|
2861
2990
|
* @throws {RequiredError}
|
|
2862
2991
|
*/
|
|
2863
|
-
|
|
2992
|
+
apiV1StoresConfigSchemaGet: (xStoreid: string, xStoresecret: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
2864
2993
|
/**
|
|
2865
|
-
* Run multiple document operations in one request (insert, update, upsert, delete). **Auth:** `x-storeid` and `x-store-write-secret`.
|
|
2994
|
+
* 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
2995
|
* @summary Bulk index documents
|
|
2867
2996
|
* @param {string} xStoreid Store ID (from dashboard)
|
|
2868
2997
|
* @param {string} xStoreWriteSecret Store write secret
|
|
2869
|
-
* @param {string} xStoreID Store ID (must match x-storeid header)
|
|
2870
2998
|
* @param {DataTypesBulkDocumentRequest} dataTypesBulkDocumentRequest List of operations
|
|
2871
2999
|
* @param {*} [options] Override http request option.
|
|
2872
3000
|
* @throws {RequiredError}
|
|
2873
3001
|
*/
|
|
2874
|
-
|
|
3002
|
+
apiV1StoresDocumentsBulkPost: (xStoreid: string, xStoreWriteSecret: string, dataTypesBulkDocumentRequest: DataTypesBulkDocumentRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
2875
3003
|
/**
|
|
2876
|
-
* Removes all documents from the store\'s search index; schema is preserved. **Auth:** `x-storeid` and `x-store-write-secret`.
|
|
3004
|
+
* Removes all documents from the store\'s search index; schema is preserved. **Auth:** `x-storeid` and `x-store-write-secret`.
|
|
2877
3005
|
* @summary Clear all documents
|
|
2878
3006
|
* @param {string} xStoreid Store ID (from dashboard)
|
|
2879
3007
|
* @param {string} xStoreWriteSecret Store write secret
|
|
2880
|
-
* @param {string} xStoreID Store ID (must match x-storeid header)
|
|
2881
3008
|
* @param {*} [options] Override http request option.
|
|
2882
3009
|
* @throws {RequiredError}
|
|
2883
3010
|
*/
|
|
2884
|
-
|
|
3011
|
+
apiV1StoresDocumentsDelete: (xStoreid: string, xStoreWriteSecret: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
2885
3012
|
/**
|
|
2886
|
-
* Remove a document from the store\'s search index by ID. **Auth:** `x-storeid` and `x-store-write-secret`.
|
|
3013
|
+
* Remove a document from the store\'s search index by ID. **Auth:** `x-storeid` and `x-store-write-secret`.
|
|
2887
3014
|
* @summary Delete a document
|
|
2888
3015
|
* @param {string} xStoreid Store ID (from dashboard)
|
|
2889
3016
|
* @param {string} xStoreWriteSecret Store write secret
|
|
2890
|
-
* @param {string} xStoreID Store ID (must match x-storeid header)
|
|
2891
3017
|
* @param {string} documentID Document ID to delete
|
|
2892
3018
|
* @param {*} [options] Override http request option.
|
|
2893
3019
|
* @throws {RequiredError}
|
|
2894
3020
|
*/
|
|
2895
|
-
|
|
3021
|
+
apiV1StoresDocumentsDocumentIDDelete: (xStoreid: string, xStoreWriteSecret: string, documentID: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
2896
3022
|
/**
|
|
2897
|
-
* Retrieve a single document from the store\'s search index by ID. **Auth:** `x-storeid` and `x-storesecret
|
|
3023
|
+
* 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
3024
|
* @summary Get a document by ID
|
|
2899
3025
|
* @param {string} xStoreid Store ID (from dashboard)
|
|
2900
3026
|
* @param {string} xStoresecret Store read secret
|
|
2901
|
-
* @param {string} xStoreID Store ID (must match x-storeid header)
|
|
2902
3027
|
* @param {string} documentID Document ID to retrieve
|
|
2903
3028
|
* @param {*} [options] Override http request option.
|
|
2904
3029
|
* @throws {RequiredError}
|
|
2905
3030
|
*/
|
|
2906
|
-
|
|
3031
|
+
apiV1StoresDocumentsDocumentIDGet: (xStoreid: string, xStoresecret: string, documentID: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
2907
3032
|
/**
|
|
2908
|
-
* Add or update one document in the store\'s search index. **Auth:** `x-storeid` and `x-store-write-secret`.
|
|
3033
|
+
* 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
3034
|
* @summary Index a single document
|
|
2910
3035
|
* @param {string} xStoreid Store ID (from dashboard)
|
|
2911
3036
|
* @param {string} xStoreWriteSecret Store write secret
|
|
2912
|
-
* @param {string} xStoreID Store ID (must match x-storeid header)
|
|
2913
3037
|
* @param {DataTypesDocumentRequest} dataTypesDocumentRequest Document fields to index
|
|
2914
3038
|
* @param {*} [options] Override http request option.
|
|
2915
3039
|
* @throws {RequiredError}
|
|
2916
3040
|
*/
|
|
2917
|
-
|
|
3041
|
+
apiV1StoresDocumentsPost: (xStoreid: string, xStoreWriteSecret: string, dataTypesDocumentRequest: DataTypesDocumentRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
2918
3042
|
/**
|
|
2919
|
-
* Returns basic store details (name, location, status). **Auth:** `x-storeid` and `x-storesecret`.
|
|
3043
|
+
* Returns basic store details (name, location, status). **Auth:** `x-storeid` and `x-storesecret`.
|
|
2920
3044
|
* @summary Get store info
|
|
2921
3045
|
* @param {string} xStoreid Store ID (from dashboard)
|
|
2922
3046
|
* @param {string} xStoresecret Store read secret
|
|
2923
|
-
* @param {string} xStoreID Store ID (must match x-storeid header)
|
|
2924
3047
|
* @param {*} [options] Override http request option.
|
|
2925
3048
|
* @throws {RequiredError}
|
|
2926
3049
|
*/
|
|
2927
|
-
|
|
3050
|
+
apiV1StoresGet: (xStoreid: string, xStoresecret: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
2928
3051
|
/**
|
|
2929
|
-
* Returns autocomplete/suggestions configuration for the store. **Auth:** `x-storeid` and `x-storesecret`.
|
|
3052
|
+
* Returns autocomplete/suggestions configuration for the store. **Auth:** `x-storeid` and `x-storesecret`.
|
|
2930
3053
|
* @summary Get query suggestions configuration
|
|
2931
3054
|
* @param {string} xStoreid Store ID (from dashboard)
|
|
2932
3055
|
* @param {string} xStoresecret Store read secret
|
|
2933
|
-
* @param {string} xStoreID Store ID (must match x-storeid header)
|
|
2934
3056
|
* @param {*} [options] Override http request option.
|
|
2935
3057
|
* @throws {RequiredError}
|
|
2936
3058
|
*/
|
|
2937
|
-
|
|
3059
|
+
apiV1StoresQuerySuggestionsConfigGet: (xStoreid: string, xStoresecret: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
2938
3060
|
/**
|
|
2939
|
-
* Update autocomplete/suggestions settings for the store. Partial updates supported. **Auth:** `x-storeid` and `x-store-write-secret`.
|
|
3061
|
+
* Update autocomplete/suggestions settings for the store. Partial updates supported. **Auth:** `x-storeid` and `x-store-write-secret`.
|
|
2940
3062
|
* @summary Update query suggestions configuration
|
|
2941
3063
|
* @param {string} xStoreid Store ID (from dashboard)
|
|
2942
3064
|
* @param {string} xStoreWriteSecret Store write secret
|
|
2943
|
-
* @param {string} xStoreID Store ID (must match x-storeid header)
|
|
2944
3065
|
* @param {QuerySuggestionsServiceUpdateSuggestionConfigRequest} querySuggestionsServiceUpdateSuggestionConfigRequest Fields to update (partial)
|
|
2945
3066
|
* @param {*} [options] Override http request option.
|
|
2946
3067
|
* @throws {RequiredError}
|
|
2947
3068
|
*/
|
|
2948
|
-
|
|
3069
|
+
apiV1StoresQuerySuggestionsConfigPut: (xStoreid: string, xStoreWriteSecret: string, querySuggestionsServiceUpdateSuggestionConfigRequest: QuerySuggestionsServiceUpdateSuggestionConfigRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
2949
3070
|
/**
|
|
2950
|
-
* Returns the current search index schema (fields and options) for the store. **Auth:** `x-storeid` and `x-storesecret`.
|
|
3071
|
+
* Returns the current search index schema (fields and options) for the store. **Auth:** `x-storeid` and `x-storesecret`.
|
|
2951
3072
|
* @summary Get index schema
|
|
2952
3073
|
* @param {string} xStoreid Store ID (from dashboard)
|
|
2953
3074
|
* @param {string} xStoresecret Store read secret
|
|
2954
|
-
* @param {string} xStoreID Store ID (must match x-storeid header)
|
|
2955
3075
|
* @param {*} [options] Override http request option.
|
|
2956
3076
|
* @throws {RequiredError}
|
|
2957
3077
|
*/
|
|
2958
|
-
|
|
3078
|
+
apiV1StoresSchemaGet: (xStoreid: string, xStoresecret: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
2959
3079
|
/**
|
|
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`.
|
|
3080
|
+
* 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
3081
|
* @summary Create or update index schema
|
|
2962
3082
|
* @param {string} xStoreid Store ID (from dashboard)
|
|
2963
3083
|
* @param {string} xStoreWriteSecret Store write secret
|
|
2964
|
-
* @param {string} xStoreID Store ID (must match x-storeid header)
|
|
2965
3084
|
* @param {DataTypesCollectionSchemaRequest} dataTypesCollectionSchemaRequest Schema definition and mode
|
|
2966
3085
|
* @param {*} [options] Override http request option.
|
|
2967
3086
|
* @throws {RequiredError}
|
|
2968
3087
|
*/
|
|
2969
|
-
|
|
3088
|
+
apiV1StoresSchemaPost: (xStoreid: string, xStoreWriteSecret: string, dataTypesCollectionSchemaRequest: DataTypesCollectionSchemaRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
2970
3089
|
};
|
|
2971
3090
|
/**
|
|
2972
3091
|
* StoreManagementApi - functional programming interface
|
|
2973
3092
|
*/
|
|
2974
3093
|
export declare const StoreManagementApiFp: (configuration?: Configuration) => {
|
|
2975
3094
|
/**
|
|
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.
|
|
3095
|
+
* Returns search and query-suggestions configuration for the store. **Auth:** `x-storeid` and `x-storesecret`.
|
|
2986
3096
|
* @summary Get store configuration
|
|
2987
3097
|
* @param {string} xStoreid Store ID (from dashboard)
|
|
2988
3098
|
* @param {string} xStoresecret Store read secret
|
|
2989
|
-
* @param {string} xStoreID Store ID (must match x-storeid header)
|
|
2990
3099
|
* @param {*} [options] Override http request option.
|
|
2991
3100
|
* @throws {RequiredError}
|
|
2992
3101
|
*/
|
|
2993
|
-
|
|
3102
|
+
apiV1StoresConfigGet(xStoreid: string, xStoresecret: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesGenericResponseDataTypesStoreConfigWithOnboardingResponse>>;
|
|
2994
3103
|
/**
|
|
2995
|
-
* Update search and store settings. Partial updates supported. **Auth:** `x-storeid` and `x-store-write-secret`.
|
|
3104
|
+
* Update search and store settings. Partial updates supported. **Auth:** `x-storeid` and `x-store-write-secret`.
|
|
2996
3105
|
* @summary Update store configuration
|
|
2997
3106
|
* @param {string} xStoreid Store ID (from dashboard)
|
|
2998
3107
|
* @param {string} xStoreWriteSecret Store write secret
|
|
2999
|
-
* @param {
|
|
3000
|
-
* @param {DataTypesIndexConfig} dataTypesIndexConfig Fields to update (partial)
|
|
3108
|
+
* @param {DataTypesStoreConfigUpdateRequest} dataTypesStoreConfigUpdateRequest Fields to update (partial, includes allow_public_search)
|
|
3001
3109
|
* @param {*} [options] Override http request option.
|
|
3002
3110
|
* @throws {RequiredError}
|
|
3003
3111
|
*/
|
|
3004
|
-
|
|
3112
|
+
apiV1StoresConfigPut(xStoreid: string, xStoreWriteSecret: string, dataTypesStoreConfigUpdateRequest: DataTypesStoreConfigUpdateRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesIndexConfigResponseWrapper>>;
|
|
3005
3113
|
/**
|
|
3006
|
-
* Returns metadata for all configurable store fields (types, defaults, validation). **Auth:** `x-storeid` and `x-storesecret`.
|
|
3114
|
+
* Returns metadata for all configurable store fields (types, defaults, validation). **Auth:** `x-storeid` and `x-storesecret`.
|
|
3007
3115
|
* @summary Get store config schema
|
|
3008
3116
|
* @param {string} xStoreid Store ID (from dashboard)
|
|
3009
3117
|
* @param {string} xStoresecret Store read secret
|
|
3010
|
-
* @param {string} xStoreID Store ID (must match x-storeid header)
|
|
3011
3118
|
* @param {*} [options] Override http request option.
|
|
3012
3119
|
* @throws {RequiredError}
|
|
3013
3120
|
*/
|
|
3014
|
-
|
|
3121
|
+
apiV1StoresConfigSchemaGet(xStoreid: string, xStoresecret: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesConfigurationSchemaResponseWrapper>>;
|
|
3015
3122
|
/**
|
|
3016
|
-
* Run multiple document operations in one request (insert, update, upsert, delete). **Auth:** `x-storeid` and `x-store-write-secret`.
|
|
3123
|
+
* 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
3124
|
* @summary Bulk index documents
|
|
3018
3125
|
* @param {string} xStoreid Store ID (from dashboard)
|
|
3019
3126
|
* @param {string} xStoreWriteSecret Store write secret
|
|
3020
|
-
* @param {string} xStoreID Store ID (must match x-storeid header)
|
|
3021
3127
|
* @param {DataTypesBulkDocumentRequest} dataTypesBulkDocumentRequest List of operations
|
|
3022
3128
|
* @param {*} [options] Override http request option.
|
|
3023
3129
|
* @throws {RequiredError}
|
|
3024
3130
|
*/
|
|
3025
|
-
|
|
3131
|
+
apiV1StoresDocumentsBulkPost(xStoreid: string, xStoreWriteSecret: string, dataTypesBulkDocumentRequest: DataTypesBulkDocumentRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesBulkDocumentResponseWrapper>>;
|
|
3026
3132
|
/**
|
|
3027
|
-
* Removes all documents from the store\'s search index; schema is preserved. **Auth:** `x-storeid` and `x-store-write-secret`.
|
|
3133
|
+
* Removes all documents from the store\'s search index; schema is preserved. **Auth:** `x-storeid` and `x-store-write-secret`.
|
|
3028
3134
|
* @summary Clear all documents
|
|
3029
3135
|
* @param {string} xStoreid Store ID (from dashboard)
|
|
3030
3136
|
* @param {string} xStoreWriteSecret Store write secret
|
|
3031
|
-
* @param {string} xStoreID Store ID (must match x-storeid header)
|
|
3032
3137
|
* @param {*} [options] Override http request option.
|
|
3033
3138
|
* @throws {RequiredError}
|
|
3034
3139
|
*/
|
|
3035
|
-
|
|
3140
|
+
apiV1StoresDocumentsDelete(xStoreid: string, xStoreWriteSecret: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesClearDocumentsResponseWrapper>>;
|
|
3036
3141
|
/**
|
|
3037
|
-
* Remove a document from the store\'s search index by ID. **Auth:** `x-storeid` and `x-store-write-secret`.
|
|
3142
|
+
* Remove a document from the store\'s search index by ID. **Auth:** `x-storeid` and `x-store-write-secret`.
|
|
3038
3143
|
* @summary Delete a document
|
|
3039
3144
|
* @param {string} xStoreid Store ID (from dashboard)
|
|
3040
3145
|
* @param {string} xStoreWriteSecret Store write secret
|
|
3041
|
-
* @param {string} xStoreID Store ID (must match x-storeid header)
|
|
3042
3146
|
* @param {string} documentID Document ID to delete
|
|
3043
3147
|
* @param {*} [options] Override http request option.
|
|
3044
3148
|
* @throws {RequiredError}
|
|
3045
3149
|
*/
|
|
3046
|
-
|
|
3150
|
+
apiV1StoresDocumentsDocumentIDDelete(xStoreid: string, xStoreWriteSecret: string, documentID: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesDocumentResponseWrapper>>;
|
|
3047
3151
|
/**
|
|
3048
|
-
* Retrieve a single document from the store\'s search index by ID. **Auth:** `x-storeid` and `x-storesecret
|
|
3152
|
+
* 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
3153
|
* @summary Get a document by ID
|
|
3050
3154
|
* @param {string} xStoreid Store ID (from dashboard)
|
|
3051
3155
|
* @param {string} xStoresecret Store read secret
|
|
3052
|
-
* @param {string} xStoreID Store ID (must match x-storeid header)
|
|
3053
3156
|
* @param {string} documentID Document ID to retrieve
|
|
3054
3157
|
* @param {*} [options] Override http request option.
|
|
3055
3158
|
* @throws {RequiredError}
|
|
3056
3159
|
*/
|
|
3057
|
-
|
|
3160
|
+
apiV1StoresDocumentsDocumentIDGet(xStoreid: string, xStoresecret: string, documentID: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesDocumentResponseWrapper>>;
|
|
3058
3161
|
/**
|
|
3059
|
-
* Add or update one document in the store\'s search index. **Auth:** `x-storeid` and `x-store-write-secret`.
|
|
3162
|
+
* 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
3163
|
* @summary Index a single document
|
|
3061
3164
|
* @param {string} xStoreid Store ID (from dashboard)
|
|
3062
3165
|
* @param {string} xStoreWriteSecret Store write secret
|
|
3063
|
-
* @param {string} xStoreID Store ID (must match x-storeid header)
|
|
3064
3166
|
* @param {DataTypesDocumentRequest} dataTypesDocumentRequest Document fields to index
|
|
3065
3167
|
* @param {*} [options] Override http request option.
|
|
3066
3168
|
* @throws {RequiredError}
|
|
3067
3169
|
*/
|
|
3068
|
-
|
|
3170
|
+
apiV1StoresDocumentsPost(xStoreid: string, xStoreWriteSecret: string, dataTypesDocumentRequest: DataTypesDocumentRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesDocumentResponseWrapper>>;
|
|
3069
3171
|
/**
|
|
3070
|
-
* Returns basic store details (name, location, status). **Auth:** `x-storeid` and `x-storesecret`.
|
|
3172
|
+
* Returns basic store details (name, location, status). **Auth:** `x-storeid` and `x-storesecret`.
|
|
3071
3173
|
* @summary Get store info
|
|
3072
3174
|
* @param {string} xStoreid Store ID (from dashboard)
|
|
3073
3175
|
* @param {string} xStoresecret Store read secret
|
|
3074
|
-
* @param {string} xStoreID Store ID (must match x-storeid header)
|
|
3075
3176
|
* @param {*} [options] Override http request option.
|
|
3076
3177
|
* @throws {RequiredError}
|
|
3077
3178
|
*/
|
|
3078
|
-
|
|
3179
|
+
apiV1StoresGet(xStoreid: string, xStoresecret: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesGenericResponseDataTypesStoreInfoResponse>>;
|
|
3079
3180
|
/**
|
|
3080
|
-
* Returns autocomplete/suggestions configuration for the store. **Auth:** `x-storeid` and `x-storesecret`.
|
|
3181
|
+
* Returns autocomplete/suggestions configuration for the store. **Auth:** `x-storeid` and `x-storesecret`.
|
|
3081
3182
|
* @summary Get query suggestions configuration
|
|
3082
3183
|
* @param {string} xStoreid Store ID (from dashboard)
|
|
3083
3184
|
* @param {string} xStoresecret Store read secret
|
|
3084
|
-
* @param {string} xStoreID Store ID (must match x-storeid header)
|
|
3085
3185
|
* @param {*} [options] Override http request option.
|
|
3086
3186
|
* @throws {RequiredError}
|
|
3087
3187
|
*/
|
|
3088
|
-
|
|
3188
|
+
apiV1StoresQuerySuggestionsConfigGet(xStoreid: string, xStoresecret: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<QuerySuggestionsServiceQuerySuggestionsAPIResponse>>;
|
|
3089
3189
|
/**
|
|
3090
|
-
* Update autocomplete/suggestions settings for the store. Partial updates supported. **Auth:** `x-storeid` and `x-store-write-secret`.
|
|
3190
|
+
* Update autocomplete/suggestions settings for the store. Partial updates supported. **Auth:** `x-storeid` and `x-store-write-secret`.
|
|
3091
3191
|
* @summary Update query suggestions configuration
|
|
3092
3192
|
* @param {string} xStoreid Store ID (from dashboard)
|
|
3093
3193
|
* @param {string} xStoreWriteSecret Store write secret
|
|
3094
|
-
* @param {string} xStoreID Store ID (must match x-storeid header)
|
|
3095
3194
|
* @param {QuerySuggestionsServiceUpdateSuggestionConfigRequest} querySuggestionsServiceUpdateSuggestionConfigRequest Fields to update (partial)
|
|
3096
3195
|
* @param {*} [options] Override http request option.
|
|
3097
3196
|
* @throws {RequiredError}
|
|
3098
3197
|
*/
|
|
3099
|
-
|
|
3198
|
+
apiV1StoresQuerySuggestionsConfigPut(xStoreid: string, xStoreWriteSecret: string, querySuggestionsServiceUpdateSuggestionConfigRequest: QuerySuggestionsServiceUpdateSuggestionConfigRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<QuerySuggestionsServiceQuerySuggestionsAPIResponse>>;
|
|
3100
3199
|
/**
|
|
3101
|
-
* Returns the current search index schema (fields and options) for the store. **Auth:** `x-storeid` and `x-storesecret`.
|
|
3200
|
+
* Returns the current search index schema (fields and options) for the store. **Auth:** `x-storeid` and `x-storesecret`.
|
|
3102
3201
|
* @summary Get index schema
|
|
3103
3202
|
* @param {string} xStoreid Store ID (from dashboard)
|
|
3104
3203
|
* @param {string} xStoresecret Store read secret
|
|
3105
|
-
* @param {string} xStoreID Store ID (must match x-storeid header)
|
|
3106
3204
|
* @param {*} [options] Override http request option.
|
|
3107
3205
|
* @throws {RequiredError}
|
|
3108
3206
|
*/
|
|
3109
|
-
|
|
3207
|
+
apiV1StoresSchemaGet(xStoreid: string, xStoresecret: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesSchemaResponseWrapper>>;
|
|
3110
3208
|
/**
|
|
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`.
|
|
3209
|
+
* 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
3210
|
* @summary Create or update index schema
|
|
3113
3211
|
* @param {string} xStoreid Store ID (from dashboard)
|
|
3114
3212
|
* @param {string} xStoreWriteSecret Store write secret
|
|
3115
|
-
* @param {string} xStoreID Store ID (must match x-storeid header)
|
|
3116
3213
|
* @param {DataTypesCollectionSchemaRequest} dataTypesCollectionSchemaRequest Schema definition and mode
|
|
3117
3214
|
* @param {*} [options] Override http request option.
|
|
3118
3215
|
* @throws {RequiredError}
|
|
3119
3216
|
*/
|
|
3120
|
-
|
|
3217
|
+
apiV1StoresSchemaPost(xStoreid: string, xStoreWriteSecret: string, dataTypesCollectionSchemaRequest: DataTypesCollectionSchemaRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesSchemaResponseWrapper>>;
|
|
3121
3218
|
};
|
|
3122
3219
|
/**
|
|
3123
3220
|
* StoreManagementApi - factory interface
|
|
3124
3221
|
*/
|
|
3125
3222
|
export declare const StoreManagementApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
3126
3223
|
/**
|
|
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.
|
|
3224
|
+
* Returns search and query-suggestions configuration for the store. **Auth:** `x-storeid` and `x-storesecret`.
|
|
3137
3225
|
* @summary Get store configuration
|
|
3138
3226
|
* @param {string} xStoreid Store ID (from dashboard)
|
|
3139
3227
|
* @param {string} xStoresecret Store read secret
|
|
3140
|
-
* @param {string} xStoreID Store ID (must match x-storeid header)
|
|
3141
3228
|
* @param {*} [options] Override http request option.
|
|
3142
3229
|
* @throws {RequiredError}
|
|
3143
3230
|
*/
|
|
3144
|
-
|
|
3231
|
+
apiV1StoresConfigGet(xStoreid: string, xStoresecret: string, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesGenericResponseDataTypesStoreConfigWithOnboardingResponse>;
|
|
3145
3232
|
/**
|
|
3146
|
-
* Update search and store settings. Partial updates supported. **Auth:** `x-storeid` and `x-store-write-secret`.
|
|
3233
|
+
* Update search and store settings. Partial updates supported. **Auth:** `x-storeid` and `x-store-write-secret`.
|
|
3147
3234
|
* @summary Update store configuration
|
|
3148
3235
|
* @param {string} xStoreid Store ID (from dashboard)
|
|
3149
3236
|
* @param {string} xStoreWriteSecret Store write secret
|
|
3150
|
-
* @param {
|
|
3151
|
-
* @param {DataTypesIndexConfig} dataTypesIndexConfig Fields to update (partial)
|
|
3237
|
+
* @param {DataTypesStoreConfigUpdateRequest} dataTypesStoreConfigUpdateRequest Fields to update (partial, includes allow_public_search)
|
|
3152
3238
|
* @param {*} [options] Override http request option.
|
|
3153
3239
|
* @throws {RequiredError}
|
|
3154
3240
|
*/
|
|
3155
|
-
|
|
3241
|
+
apiV1StoresConfigPut(xStoreid: string, xStoreWriteSecret: string, dataTypesStoreConfigUpdateRequest: DataTypesStoreConfigUpdateRequest, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesIndexConfigResponseWrapper>;
|
|
3156
3242
|
/**
|
|
3157
|
-
* Returns metadata for all configurable store fields (types, defaults, validation). **Auth:** `x-storeid` and `x-storesecret`.
|
|
3243
|
+
* Returns metadata for all configurable store fields (types, defaults, validation). **Auth:** `x-storeid` and `x-storesecret`.
|
|
3158
3244
|
* @summary Get store config schema
|
|
3159
3245
|
* @param {string} xStoreid Store ID (from dashboard)
|
|
3160
3246
|
* @param {string} xStoresecret Store read secret
|
|
3161
|
-
* @param {string} xStoreID Store ID (must match x-storeid header)
|
|
3162
3247
|
* @param {*} [options] Override http request option.
|
|
3163
3248
|
* @throws {RequiredError}
|
|
3164
3249
|
*/
|
|
3165
|
-
|
|
3250
|
+
apiV1StoresConfigSchemaGet(xStoreid: string, xStoresecret: string, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesConfigurationSchemaResponseWrapper>;
|
|
3166
3251
|
/**
|
|
3167
|
-
* Run multiple document operations in one request (insert, update, upsert, delete). **Auth:** `x-storeid` and `x-store-write-secret`.
|
|
3252
|
+
* 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
3253
|
* @summary Bulk index documents
|
|
3169
3254
|
* @param {string} xStoreid Store ID (from dashboard)
|
|
3170
3255
|
* @param {string} xStoreWriteSecret Store write secret
|
|
3171
|
-
* @param {string} xStoreID Store ID (must match x-storeid header)
|
|
3172
3256
|
* @param {DataTypesBulkDocumentRequest} dataTypesBulkDocumentRequest List of operations
|
|
3173
3257
|
* @param {*} [options] Override http request option.
|
|
3174
3258
|
* @throws {RequiredError}
|
|
3175
3259
|
*/
|
|
3176
|
-
|
|
3260
|
+
apiV1StoresDocumentsBulkPost(xStoreid: string, xStoreWriteSecret: string, dataTypesBulkDocumentRequest: DataTypesBulkDocumentRequest, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesBulkDocumentResponseWrapper>;
|
|
3177
3261
|
/**
|
|
3178
|
-
* Removes all documents from the store\'s search index; schema is preserved. **Auth:** `x-storeid` and `x-store-write-secret`.
|
|
3262
|
+
* Removes all documents from the store\'s search index; schema is preserved. **Auth:** `x-storeid` and `x-store-write-secret`.
|
|
3179
3263
|
* @summary Clear all documents
|
|
3180
3264
|
* @param {string} xStoreid Store ID (from dashboard)
|
|
3181
3265
|
* @param {string} xStoreWriteSecret Store write secret
|
|
3182
|
-
* @param {string} xStoreID Store ID (must match x-storeid header)
|
|
3183
3266
|
* @param {*} [options] Override http request option.
|
|
3184
3267
|
* @throws {RequiredError}
|
|
3185
3268
|
*/
|
|
3186
|
-
|
|
3269
|
+
apiV1StoresDocumentsDelete(xStoreid: string, xStoreWriteSecret: string, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesClearDocumentsResponseWrapper>;
|
|
3187
3270
|
/**
|
|
3188
|
-
* Remove a document from the store\'s search index by ID. **Auth:** `x-storeid` and `x-store-write-secret`.
|
|
3271
|
+
* Remove a document from the store\'s search index by ID. **Auth:** `x-storeid` and `x-store-write-secret`.
|
|
3189
3272
|
* @summary Delete a document
|
|
3190
3273
|
* @param {string} xStoreid Store ID (from dashboard)
|
|
3191
3274
|
* @param {string} xStoreWriteSecret Store write secret
|
|
3192
|
-
* @param {string} xStoreID Store ID (must match x-storeid header)
|
|
3193
3275
|
* @param {string} documentID Document ID to delete
|
|
3194
3276
|
* @param {*} [options] Override http request option.
|
|
3195
3277
|
* @throws {RequiredError}
|
|
3196
3278
|
*/
|
|
3197
|
-
|
|
3279
|
+
apiV1StoresDocumentsDocumentIDDelete(xStoreid: string, xStoreWriteSecret: string, documentID: string, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesDocumentResponseWrapper>;
|
|
3198
3280
|
/**
|
|
3199
|
-
* Retrieve a single document from the store\'s search index by ID. **Auth:** `x-storeid` and `x-storesecret
|
|
3281
|
+
* 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
3282
|
* @summary Get a document by ID
|
|
3201
3283
|
* @param {string} xStoreid Store ID (from dashboard)
|
|
3202
3284
|
* @param {string} xStoresecret Store read secret
|
|
3203
|
-
* @param {string} xStoreID Store ID (must match x-storeid header)
|
|
3204
3285
|
* @param {string} documentID Document ID to retrieve
|
|
3205
3286
|
* @param {*} [options] Override http request option.
|
|
3206
3287
|
* @throws {RequiredError}
|
|
3207
3288
|
*/
|
|
3208
|
-
|
|
3289
|
+
apiV1StoresDocumentsDocumentIDGet(xStoreid: string, xStoresecret: string, documentID: string, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesDocumentResponseWrapper>;
|
|
3209
3290
|
/**
|
|
3210
|
-
* Add or update one document in the store\'s search index. **Auth:** `x-storeid` and `x-store-write-secret`.
|
|
3291
|
+
* 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
3292
|
* @summary Index a single document
|
|
3212
3293
|
* @param {string} xStoreid Store ID (from dashboard)
|
|
3213
3294
|
* @param {string} xStoreWriteSecret Store write secret
|
|
3214
|
-
* @param {string} xStoreID Store ID (must match x-storeid header)
|
|
3215
3295
|
* @param {DataTypesDocumentRequest} dataTypesDocumentRequest Document fields to index
|
|
3216
3296
|
* @param {*} [options] Override http request option.
|
|
3217
3297
|
* @throws {RequiredError}
|
|
3218
3298
|
*/
|
|
3219
|
-
|
|
3299
|
+
apiV1StoresDocumentsPost(xStoreid: string, xStoreWriteSecret: string, dataTypesDocumentRequest: DataTypesDocumentRequest, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesDocumentResponseWrapper>;
|
|
3220
3300
|
/**
|
|
3221
|
-
* Returns basic store details (name, location, status). **Auth:** `x-storeid` and `x-storesecret`.
|
|
3301
|
+
* Returns basic store details (name, location, status). **Auth:** `x-storeid` and `x-storesecret`.
|
|
3222
3302
|
* @summary Get store info
|
|
3223
3303
|
* @param {string} xStoreid Store ID (from dashboard)
|
|
3224
3304
|
* @param {string} xStoresecret Store read secret
|
|
3225
|
-
* @param {string} xStoreID Store ID (must match x-storeid header)
|
|
3226
3305
|
* @param {*} [options] Override http request option.
|
|
3227
3306
|
* @throws {RequiredError}
|
|
3228
3307
|
*/
|
|
3229
|
-
|
|
3308
|
+
apiV1StoresGet(xStoreid: string, xStoresecret: string, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesGenericResponseDataTypesStoreInfoResponse>;
|
|
3230
3309
|
/**
|
|
3231
|
-
* Returns autocomplete/suggestions configuration for the store. **Auth:** `x-storeid` and `x-storesecret`.
|
|
3310
|
+
* Returns autocomplete/suggestions configuration for the store. **Auth:** `x-storeid` and `x-storesecret`.
|
|
3232
3311
|
* @summary Get query suggestions configuration
|
|
3233
3312
|
* @param {string} xStoreid Store ID (from dashboard)
|
|
3234
3313
|
* @param {string} xStoresecret Store read secret
|
|
3235
|
-
* @param {string} xStoreID Store ID (must match x-storeid header)
|
|
3236
3314
|
* @param {*} [options] Override http request option.
|
|
3237
3315
|
* @throws {RequiredError}
|
|
3238
3316
|
*/
|
|
3239
|
-
|
|
3317
|
+
apiV1StoresQuerySuggestionsConfigGet(xStoreid: string, xStoresecret: string, options?: RawAxiosRequestConfig): AxiosPromise<QuerySuggestionsServiceQuerySuggestionsAPIResponse>;
|
|
3240
3318
|
/**
|
|
3241
|
-
* Update autocomplete/suggestions settings for the store. Partial updates supported. **Auth:** `x-storeid` and `x-store-write-secret`.
|
|
3319
|
+
* Update autocomplete/suggestions settings for the store. Partial updates supported. **Auth:** `x-storeid` and `x-store-write-secret`.
|
|
3242
3320
|
* @summary Update query suggestions configuration
|
|
3243
3321
|
* @param {string} xStoreid Store ID (from dashboard)
|
|
3244
3322
|
* @param {string} xStoreWriteSecret Store write secret
|
|
3245
|
-
* @param {string} xStoreID Store ID (must match x-storeid header)
|
|
3246
3323
|
* @param {QuerySuggestionsServiceUpdateSuggestionConfigRequest} querySuggestionsServiceUpdateSuggestionConfigRequest Fields to update (partial)
|
|
3247
3324
|
* @param {*} [options] Override http request option.
|
|
3248
3325
|
* @throws {RequiredError}
|
|
3249
3326
|
*/
|
|
3250
|
-
|
|
3327
|
+
apiV1StoresQuerySuggestionsConfigPut(xStoreid: string, xStoreWriteSecret: string, querySuggestionsServiceUpdateSuggestionConfigRequest: QuerySuggestionsServiceUpdateSuggestionConfigRequest, options?: RawAxiosRequestConfig): AxiosPromise<QuerySuggestionsServiceQuerySuggestionsAPIResponse>;
|
|
3251
3328
|
/**
|
|
3252
|
-
* Returns the current search index schema (fields and options) for the store. **Auth:** `x-storeid` and `x-storesecret`.
|
|
3329
|
+
* Returns the current search index schema (fields and options) for the store. **Auth:** `x-storeid` and `x-storesecret`.
|
|
3253
3330
|
* @summary Get index schema
|
|
3254
3331
|
* @param {string} xStoreid Store ID (from dashboard)
|
|
3255
3332
|
* @param {string} xStoresecret Store read secret
|
|
3256
|
-
* @param {string} xStoreID Store ID (must match x-storeid header)
|
|
3257
3333
|
* @param {*} [options] Override http request option.
|
|
3258
3334
|
* @throws {RequiredError}
|
|
3259
3335
|
*/
|
|
3260
|
-
|
|
3336
|
+
apiV1StoresSchemaGet(xStoreid: string, xStoresecret: string, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesSchemaResponseWrapper>;
|
|
3261
3337
|
/**
|
|
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`.
|
|
3338
|
+
* 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
3339
|
* @summary Create or update index schema
|
|
3264
3340
|
* @param {string} xStoreid Store ID (from dashboard)
|
|
3265
3341
|
* @param {string} xStoreWriteSecret Store write secret
|
|
3266
|
-
* @param {string} xStoreID Store ID (must match x-storeid header)
|
|
3267
3342
|
* @param {DataTypesCollectionSchemaRequest} dataTypesCollectionSchemaRequest Schema definition and mode
|
|
3268
3343
|
* @param {*} [options] Override http request option.
|
|
3269
3344
|
* @throws {RequiredError}
|
|
3270
3345
|
*/
|
|
3271
|
-
|
|
3346
|
+
apiV1StoresSchemaPost(xStoreid: string, xStoreWriteSecret: string, dataTypesCollectionSchemaRequest: DataTypesCollectionSchemaRequest, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesSchemaResponseWrapper>;
|
|
3272
3347
|
};
|
|
3273
3348
|
/**
|
|
3274
3349
|
* StoreManagementApi - object-oriented interface
|
|
3275
3350
|
*/
|
|
3276
3351
|
export declare class StoreManagementApi extends BaseAPI {
|
|
3277
3352
|
/**
|
|
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.
|
|
3353
|
+
* Returns search and query-suggestions configuration for the store. **Auth:** `x-storeid` and `x-storesecret`.
|
|
3288
3354
|
* @summary Get store configuration
|
|
3289
3355
|
* @param {string} xStoreid Store ID (from dashboard)
|
|
3290
3356
|
* @param {string} xStoresecret Store read secret
|
|
3291
|
-
* @param {string} xStoreID Store ID (must match x-storeid header)
|
|
3292
3357
|
* @param {*} [options] Override http request option.
|
|
3293
3358
|
* @throws {RequiredError}
|
|
3294
3359
|
*/
|
|
3295
|
-
|
|
3360
|
+
apiV1StoresConfigGet(xStoreid: string, xStoresecret: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesGenericResponseDataTypesStoreConfigWithOnboardingResponse, any, {}>>;
|
|
3296
3361
|
/**
|
|
3297
|
-
* Update search and store settings. Partial updates supported. **Auth:** `x-storeid` and `x-store-write-secret`.
|
|
3362
|
+
* Update search and store settings. Partial updates supported. **Auth:** `x-storeid` and `x-store-write-secret`.
|
|
3298
3363
|
* @summary Update store configuration
|
|
3299
3364
|
* @param {string} xStoreid Store ID (from dashboard)
|
|
3300
3365
|
* @param {string} xStoreWriteSecret Store write secret
|
|
3301
|
-
* @param {
|
|
3302
|
-
* @param {DataTypesIndexConfig} dataTypesIndexConfig Fields to update (partial)
|
|
3366
|
+
* @param {DataTypesStoreConfigUpdateRequest} dataTypesStoreConfigUpdateRequest Fields to update (partial, includes allow_public_search)
|
|
3303
3367
|
* @param {*} [options] Override http request option.
|
|
3304
3368
|
* @throws {RequiredError}
|
|
3305
3369
|
*/
|
|
3306
|
-
|
|
3370
|
+
apiV1StoresConfigPut(xStoreid: string, xStoreWriteSecret: string, dataTypesStoreConfigUpdateRequest: DataTypesStoreConfigUpdateRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesIndexConfigResponseWrapper, any, {}>>;
|
|
3307
3371
|
/**
|
|
3308
|
-
* Returns metadata for all configurable store fields (types, defaults, validation). **Auth:** `x-storeid` and `x-storesecret`.
|
|
3372
|
+
* Returns metadata for all configurable store fields (types, defaults, validation). **Auth:** `x-storeid` and `x-storesecret`.
|
|
3309
3373
|
* @summary Get store config schema
|
|
3310
3374
|
* @param {string} xStoreid Store ID (from dashboard)
|
|
3311
3375
|
* @param {string} xStoresecret Store read secret
|
|
3312
|
-
* @param {string} xStoreID Store ID (must match x-storeid header)
|
|
3313
3376
|
* @param {*} [options] Override http request option.
|
|
3314
3377
|
* @throws {RequiredError}
|
|
3315
3378
|
*/
|
|
3316
|
-
|
|
3379
|
+
apiV1StoresConfigSchemaGet(xStoreid: string, xStoresecret: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesConfigurationSchemaResponseWrapper, any, {}>>;
|
|
3317
3380
|
/**
|
|
3318
|
-
* Run multiple document operations in one request (insert, update, upsert, delete). **Auth:** `x-storeid` and `x-store-write-secret`.
|
|
3381
|
+
* 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
3382
|
* @summary Bulk index documents
|
|
3320
3383
|
* @param {string} xStoreid Store ID (from dashboard)
|
|
3321
3384
|
* @param {string} xStoreWriteSecret Store write secret
|
|
3322
|
-
* @param {string} xStoreID Store ID (must match x-storeid header)
|
|
3323
3385
|
* @param {DataTypesBulkDocumentRequest} dataTypesBulkDocumentRequest List of operations
|
|
3324
3386
|
* @param {*} [options] Override http request option.
|
|
3325
3387
|
* @throws {RequiredError}
|
|
3326
3388
|
*/
|
|
3327
|
-
|
|
3389
|
+
apiV1StoresDocumentsBulkPost(xStoreid: string, xStoreWriteSecret: string, dataTypesBulkDocumentRequest: DataTypesBulkDocumentRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesBulkDocumentResponseWrapper, any, {}>>;
|
|
3328
3390
|
/**
|
|
3329
|
-
* Removes all documents from the store\'s search index; schema is preserved. **Auth:** `x-storeid` and `x-store-write-secret`.
|
|
3391
|
+
* Removes all documents from the store\'s search index; schema is preserved. **Auth:** `x-storeid` and `x-store-write-secret`.
|
|
3330
3392
|
* @summary Clear all documents
|
|
3331
3393
|
* @param {string} xStoreid Store ID (from dashboard)
|
|
3332
3394
|
* @param {string} xStoreWriteSecret Store write secret
|
|
3333
|
-
* @param {string} xStoreID Store ID (must match x-storeid header)
|
|
3334
3395
|
* @param {*} [options] Override http request option.
|
|
3335
3396
|
* @throws {RequiredError}
|
|
3336
3397
|
*/
|
|
3337
|
-
|
|
3398
|
+
apiV1StoresDocumentsDelete(xStoreid: string, xStoreWriteSecret: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesClearDocumentsResponseWrapper, any, {}>>;
|
|
3338
3399
|
/**
|
|
3339
|
-
* Remove a document from the store\'s search index by ID. **Auth:** `x-storeid` and `x-store-write-secret`.
|
|
3400
|
+
* Remove a document from the store\'s search index by ID. **Auth:** `x-storeid` and `x-store-write-secret`.
|
|
3340
3401
|
* @summary Delete a document
|
|
3341
3402
|
* @param {string} xStoreid Store ID (from dashboard)
|
|
3342
3403
|
* @param {string} xStoreWriteSecret Store write secret
|
|
3343
|
-
* @param {string} xStoreID Store ID (must match x-storeid header)
|
|
3344
3404
|
* @param {string} documentID Document ID to delete
|
|
3345
3405
|
* @param {*} [options] Override http request option.
|
|
3346
3406
|
* @throws {RequiredError}
|
|
3347
3407
|
*/
|
|
3348
|
-
|
|
3408
|
+
apiV1StoresDocumentsDocumentIDDelete(xStoreid: string, xStoreWriteSecret: string, documentID: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesDocumentResponseWrapper, any, {}>>;
|
|
3349
3409
|
/**
|
|
3350
|
-
* Retrieve a single document from the store\'s search index by ID. **Auth:** `x-storeid` and `x-storesecret
|
|
3410
|
+
* 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
3411
|
* @summary Get a document by ID
|
|
3352
3412
|
* @param {string} xStoreid Store ID (from dashboard)
|
|
3353
3413
|
* @param {string} xStoresecret Store read secret
|
|
3354
|
-
* @param {string} xStoreID Store ID (must match x-storeid header)
|
|
3355
3414
|
* @param {string} documentID Document ID to retrieve
|
|
3356
3415
|
* @param {*} [options] Override http request option.
|
|
3357
3416
|
* @throws {RequiredError}
|
|
3358
3417
|
*/
|
|
3359
|
-
|
|
3418
|
+
apiV1StoresDocumentsDocumentIDGet(xStoreid: string, xStoresecret: string, documentID: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesDocumentResponseWrapper, any, {}>>;
|
|
3360
3419
|
/**
|
|
3361
|
-
* Add or update one document in the store\'s search index. **Auth:** `x-storeid` and `x-store-write-secret`.
|
|
3420
|
+
* 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
3421
|
* @summary Index a single document
|
|
3363
3422
|
* @param {string} xStoreid Store ID (from dashboard)
|
|
3364
3423
|
* @param {string} xStoreWriteSecret Store write secret
|
|
3365
|
-
* @param {string} xStoreID Store ID (must match x-storeid header)
|
|
3366
3424
|
* @param {DataTypesDocumentRequest} dataTypesDocumentRequest Document fields to index
|
|
3367
3425
|
* @param {*} [options] Override http request option.
|
|
3368
3426
|
* @throws {RequiredError}
|
|
3369
3427
|
*/
|
|
3370
|
-
|
|
3428
|
+
apiV1StoresDocumentsPost(xStoreid: string, xStoreWriteSecret: string, dataTypesDocumentRequest: DataTypesDocumentRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesDocumentResponseWrapper, any, {}>>;
|
|
3371
3429
|
/**
|
|
3372
|
-
* Returns basic store details (name, location, status). **Auth:** `x-storeid` and `x-storesecret`.
|
|
3430
|
+
* Returns basic store details (name, location, status). **Auth:** `x-storeid` and `x-storesecret`.
|
|
3373
3431
|
* @summary Get store info
|
|
3374
3432
|
* @param {string} xStoreid Store ID (from dashboard)
|
|
3375
3433
|
* @param {string} xStoresecret Store read secret
|
|
3376
|
-
* @param {string} xStoreID Store ID (must match x-storeid header)
|
|
3377
3434
|
* @param {*} [options] Override http request option.
|
|
3378
3435
|
* @throws {RequiredError}
|
|
3379
3436
|
*/
|
|
3380
|
-
|
|
3437
|
+
apiV1StoresGet(xStoreid: string, xStoresecret: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesGenericResponseDataTypesStoreInfoResponse, any, {}>>;
|
|
3381
3438
|
/**
|
|
3382
|
-
* Returns autocomplete/suggestions configuration for the store. **Auth:** `x-storeid` and `x-storesecret`.
|
|
3439
|
+
* Returns autocomplete/suggestions configuration for the store. **Auth:** `x-storeid` and `x-storesecret`.
|
|
3383
3440
|
* @summary Get query suggestions configuration
|
|
3384
3441
|
* @param {string} xStoreid Store ID (from dashboard)
|
|
3385
3442
|
* @param {string} xStoresecret Store read secret
|
|
3386
|
-
* @param {string} xStoreID Store ID (must match x-storeid header)
|
|
3387
3443
|
* @param {*} [options] Override http request option.
|
|
3388
3444
|
* @throws {RequiredError}
|
|
3389
3445
|
*/
|
|
3390
|
-
|
|
3446
|
+
apiV1StoresQuerySuggestionsConfigGet(xStoreid: string, xStoresecret: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<QuerySuggestionsServiceQuerySuggestionsAPIResponse, any, {}>>;
|
|
3391
3447
|
/**
|
|
3392
|
-
* Update autocomplete/suggestions settings for the store. Partial updates supported. **Auth:** `x-storeid` and `x-store-write-secret`.
|
|
3448
|
+
* Update autocomplete/suggestions settings for the store. Partial updates supported. **Auth:** `x-storeid` and `x-store-write-secret`.
|
|
3393
3449
|
* @summary Update query suggestions configuration
|
|
3394
3450
|
* @param {string} xStoreid Store ID (from dashboard)
|
|
3395
3451
|
* @param {string} xStoreWriteSecret Store write secret
|
|
3396
|
-
* @param {string} xStoreID Store ID (must match x-storeid header)
|
|
3397
3452
|
* @param {QuerySuggestionsServiceUpdateSuggestionConfigRequest} querySuggestionsServiceUpdateSuggestionConfigRequest Fields to update (partial)
|
|
3398
3453
|
* @param {*} [options] Override http request option.
|
|
3399
3454
|
* @throws {RequiredError}
|
|
3400
3455
|
*/
|
|
3401
|
-
|
|
3456
|
+
apiV1StoresQuerySuggestionsConfigPut(xStoreid: string, xStoreWriteSecret: string, querySuggestionsServiceUpdateSuggestionConfigRequest: QuerySuggestionsServiceUpdateSuggestionConfigRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<QuerySuggestionsServiceQuerySuggestionsAPIResponse, any, {}>>;
|
|
3402
3457
|
/**
|
|
3403
|
-
* Returns the current search index schema (fields and options) for the store. **Auth:** `x-storeid` and `x-storesecret`.
|
|
3458
|
+
* Returns the current search index schema (fields and options) for the store. **Auth:** `x-storeid` and `x-storesecret`.
|
|
3404
3459
|
* @summary Get index schema
|
|
3405
3460
|
* @param {string} xStoreid Store ID (from dashboard)
|
|
3406
3461
|
* @param {string} xStoresecret Store read secret
|
|
3407
|
-
* @param {string} xStoreID Store ID (must match x-storeid header)
|
|
3408
3462
|
* @param {*} [options] Override http request option.
|
|
3409
3463
|
* @throws {RequiredError}
|
|
3410
3464
|
*/
|
|
3411
|
-
|
|
3465
|
+
apiV1StoresSchemaGet(xStoreid: string, xStoresecret: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesSchemaResponseWrapper, any, {}>>;
|
|
3412
3466
|
/**
|
|
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`.
|
|
3467
|
+
* 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
3468
|
* @summary Create or update index schema
|
|
3415
3469
|
* @param {string} xStoreid Store ID (from dashboard)
|
|
3416
3470
|
* @param {string} xStoreWriteSecret Store write secret
|
|
3417
|
-
* @param {string} xStoreID Store ID (must match x-storeid header)
|
|
3418
3471
|
* @param {DataTypesCollectionSchemaRequest} dataTypesCollectionSchemaRequest Schema definition and mode
|
|
3419
3472
|
* @param {*} [options] Override http request option.
|
|
3420
3473
|
* @throws {RequiredError}
|
|
3421
3474
|
*/
|
|
3422
|
-
|
|
3475
|
+
apiV1StoresSchemaPost(xStoreid: string, xStoreWriteSecret: string, dataTypesCollectionSchemaRequest: DataTypesCollectionSchemaRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesSchemaResponseWrapper, any, {}>>;
|
|
3423
3476
|
}
|