@seekora-ai/search-sdk 0.2.12 → 0.2.14
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/client.d.ts +98 -3
- package/dist/client.js +149 -2
- package/dist/generated/api.d.ts +1492 -562
- package/dist/generated/api.js +1002 -465
- 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.js
CHANGED
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
/* eslint-disable */
|
|
4
4
|
/**
|
|
5
5
|
* Seekora APIs
|
|
6
|
-
*
|
|
6
|
+
* Seekora provides search, suggestions, and store management APIs. **Admin APIs** require JWT (Bearer token from login). **Public/SDK APIs** (search, stores, suggestions, documents) use store credentials: send `x-storeid` (Store ID) and either `x-storesecret` (read) or `x-store-write-secret` (write) in headers. Get these from the Seekora dashboard. Base path for public v1 APIs: `/api/v1`.
|
|
7
7
|
*
|
|
8
8
|
* The version of the OpenAPI document: 1.0
|
|
9
9
|
*
|
|
@@ -16,8 +16,8 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
|
|
|
16
16
|
return (mod && mod.__esModule) ? mod : { "default": mod };
|
|
17
17
|
};
|
|
18
18
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
19
|
-
exports.
|
|
20
|
-
exports.SearchApi = exports.SearchApiFactory = exports.SearchApiFp = exports.SearchApiAxiosParamCreator = exports.SDKStoreInfoApi = exports.SDKStoreInfoApiFactory = exports.SDKStoreInfoApiFp = exports.SDKStoreInfoApiAxiosParamCreator = exports.SDKStoreCreationApi = exports.SDKStoreCreationApiFactory = exports.SDKStoreCreationApiFp = exports.SDKStoreCreationApiAxiosParamCreator = exports.SDKStoreConfigApi = exports.SDKStoreConfigApiFactory = exports.SDKStoreConfigApiFp = exports.SDKStoreConfigApiAxiosParamCreator = exports.SDKSchemaApi = exports.SDKSchemaApiFactory = exports.SDKSchemaApiFp = exports.SDKSchemaApiAxiosParamCreator = exports.SDKQuerySuggestionsConfigApi = exports.SDKQuerySuggestionsConfigApiFactory = exports.SDKQuerySuggestionsConfigApiFp = exports.SDKQuerySuggestionsConfigApiAxiosParamCreator = exports.SDKDocumentsApi = exports.SDKDocumentsApiFactory = exports.SDKDocumentsApiFp = exports.SDKDocumentsApiAxiosParamCreator = exports.V1SuggestionsQueriesGetTimeRangeEnum = exports.V1SuggestionsQueriesGetTagsMatchModeEnum = exports.QuerySuggestionsApi = exports.QuerySuggestionsApiFactory = exports.QuerySuggestionsApiFp = exports.QuerySuggestionsApiAxiosParamCreator = void 0;
|
|
19
|
+
exports.AnalyticsEventsApiFp = exports.AnalyticsEventsApiAxiosParamCreator = exports.AnalyticsApi = exports.AnalyticsApiFactory = exports.AnalyticsApiFp = exports.AnalyticsApiAxiosParamCreator = exports.AnalyticsActivityLogsGetActionEnum = exports.ActivityLogsApi = exports.ActivityLogsApiFactory = exports.ActivityLogsApiFp = exports.ActivityLogsApiAxiosParamCreator = exports.RefundRefundPreviewRequestDtoRefundTypeEnum = exports.QuerySuggestionsServiceRuleType = exports.QuerySuggestionsServiceQuerySuggestionStatus = exports.QuerySuggestionsServiceQuerySuggestionSource = exports.QuerySuggestionsServiceBulkOperation = exports.QuerySuggestionsServiceBannedMatchType = exports.ModelsCreateCustomEventFieldRequestFieldTypeEnum = exports.MenuRoutesAddMenuRequestModuleTypeEnum = exports.MenuRoutesAddMenuRequestMenuLocationEnum = exports.MenuRoutesAddMenuRequestMenuLevelEnum = exports.DataTypesUpdateWordStatusRequestWordTypeEnum = exports.DataTypesUpdateStoreAccessRequestAccessLevelEnum = exports.DataTypesUpdatePluralDeclensionRequestTypeEnum = exports.DataTypesUpdateMemberRoleRequestMemberRoleEnum = exports.DataTypesStoreLevelMenuRightAccessLevelEnum = exports.DataTypesStoreAccessRequestAccessLevelEnum = exports.DataTypesRefundCalculationRequestDtoRefundTypeEnum = exports.DataTypesRefundApprovalDtoActionEnum = exports.DataTypesProcessRefundRequestDtoRefundTypeEnum = exports.DataTypesNotificationType = exports.DataTypesNotificationStatus = exports.DataTypesNotificationPriority = exports.DataTypesNotificationChannel = exports.DataTypesGrantStoreAccessRequestAccessLevelEnum = exports.DataTypesExperimentType = exports.DataTypesExperimentStatus = exports.DataTypesCreateTaskRequestTypeEnum = exports.DataTypesCreateTaskRequestIndexingStrategyEnum = exports.DataTypesCreateTaskRequestFrequencyEnum = exports.DataTypesCreateRefundRequestDtoRefundTypeEnum = exports.DataTypesCreatePluralDeclensionRequestTypeEnum = exports.DataTypesCreatePaymentOrderRequestPaymentTypeEnum = exports.DataTypesCreateCustomWordListRequestTypeEnum = exports.DataTypesBillingAlertRequestThresholdUnitEnum = exports.DataTypesBillingAlertRequestAlertTypeEnum = exports.DataTypesAcceptInvitationWithOAuthRequestTypeEnum = exports.ConnectorsCreateConnectorRequestConnectorTypeEnum = exports.AnalyticsThresholdType = exports.AnalyticsRuleType = void 0;
|
|
20
|
+
exports.SearchApi = exports.SearchApiFactory = exports.SearchApiFp = exports.SearchApiAxiosParamCreator = exports.SDKStoreInfoApi = exports.SDKStoreInfoApiFactory = exports.SDKStoreInfoApiFp = exports.SDKStoreInfoApiAxiosParamCreator = exports.SDKStoreCreationApi = exports.SDKStoreCreationApiFactory = exports.SDKStoreCreationApiFp = exports.SDKStoreCreationApiAxiosParamCreator = exports.SDKStoreConfigApi = exports.SDKStoreConfigApiFactory = exports.SDKStoreConfigApiFp = exports.SDKStoreConfigApiAxiosParamCreator = exports.SDKSchemaApi = exports.SDKSchemaApiFactory = exports.SDKSchemaApiFp = exports.SDKSchemaApiAxiosParamCreator = exports.SDKQuerySuggestionsConfigApi = exports.SDKQuerySuggestionsConfigApiFactory = exports.SDKQuerySuggestionsConfigApiFp = exports.SDKQuerySuggestionsConfigApiAxiosParamCreator = exports.SDKExperimentsApi = exports.SDKExperimentsApiFactory = exports.SDKExperimentsApiFp = exports.SDKExperimentsApiAxiosParamCreator = exports.SDKDocumentsApi = exports.SDKDocumentsApiFactory = exports.SDKDocumentsApiFp = exports.SDKDocumentsApiAxiosParamCreator = exports.V1SuggestionsQueriesGetTimeRangeEnum = exports.V1SuggestionsQueriesGetTagsMatchModeEnum = exports.QuerySuggestionsApi = exports.QuerySuggestionsApiFactory = exports.QuerySuggestionsApiFp = exports.QuerySuggestionsApiAxiosParamCreator = exports.FiltersApi = exports.FiltersApiFactory = exports.FiltersApiFp = exports.FiltersApiAxiosParamCreator = exports.AnalyticsEventsApi = exports.AnalyticsEventsApiFactory = void 0;
|
|
21
21
|
const axios_1 = __importDefault(require("axios"));
|
|
22
22
|
// Some imports not used depending on template conditions
|
|
23
23
|
// @ts-ignore
|
|
@@ -49,7 +49,6 @@ exports.DataTypesAcceptInvitationWithOAuthRequestTypeEnum = {
|
|
|
49
49
|
};
|
|
50
50
|
exports.DataTypesBillingAlertRequestAlertTypeEnum = {
|
|
51
51
|
LowBalance: 'low_balance',
|
|
52
|
-
ExpiringCredits: 'expiring_credits',
|
|
53
52
|
DaysRemaining: 'days_remaining'
|
|
54
53
|
};
|
|
55
54
|
exports.DataTypesBillingAlertRequestThresholdUnitEnum = {
|
|
@@ -93,6 +92,22 @@ exports.DataTypesCreateTaskRequestTypeEnum = {
|
|
|
93
92
|
Manual: 'manual',
|
|
94
93
|
PluginConnector: 'plugin_connector'
|
|
95
94
|
};
|
|
95
|
+
exports.DataTypesExperimentStatus = {
|
|
96
|
+
ExperimentStatusDraft: 'draft',
|
|
97
|
+
ExperimentStatusScheduled: 'scheduled',
|
|
98
|
+
ExperimentStatusRunning: 'running',
|
|
99
|
+
ExperimentStatusPaused: 'paused',
|
|
100
|
+
ExperimentStatusCompleted: 'completed',
|
|
101
|
+
ExperimentStatusArchived: 'archived'
|
|
102
|
+
};
|
|
103
|
+
exports.DataTypesExperimentType = {
|
|
104
|
+
ExperimentTypeSearchRanking: 'search_ranking',
|
|
105
|
+
ExperimentTypeRecommendation: 'recommendation',
|
|
106
|
+
ExperimentTypePersonalization: 'personalization',
|
|
107
|
+
ExperimentTypeUI: 'ui',
|
|
108
|
+
ExperimentTypePricing: 'pricing',
|
|
109
|
+
ExperimentTypeOther: 'other'
|
|
110
|
+
};
|
|
96
111
|
exports.DataTypesGrantStoreAccessRequestAccessLevelEnum = {
|
|
97
112
|
Read: 'read',
|
|
98
113
|
Write: 'write',
|
|
@@ -197,7 +212,8 @@ exports.ModelsCreateCustomEventFieldRequestFieldTypeEnum = {
|
|
|
197
212
|
Number: 'number',
|
|
198
213
|
Boolean: 'boolean',
|
|
199
214
|
Datetime: 'datetime',
|
|
200
|
-
Array: 'array'
|
|
215
|
+
Array: 'array',
|
|
216
|
+
Object: 'object'
|
|
201
217
|
};
|
|
202
218
|
exports.QuerySuggestionsServiceBannedMatchType = {
|
|
203
219
|
BannedMatchIs: 'is',
|
|
@@ -647,6 +663,8 @@ const AnalyticsEventsApiAxiosParamCreator = function (configuration) {
|
|
|
647
663
|
const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options };
|
|
648
664
|
const localVarHeaderParameter = {};
|
|
649
665
|
const localVarQueryParameter = {};
|
|
666
|
+
// authentication ApiKeyAuth required
|
|
667
|
+
await (0, common_1.setApiKeyToObject)(localVarHeaderParameter, "x-storesecret", configuration);
|
|
650
668
|
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
651
669
|
localVarHeaderParameter['Accept'] = 'application/json';
|
|
652
670
|
if (xStoreid != null) {
|
|
@@ -687,6 +705,8 @@ const AnalyticsEventsApiAxiosParamCreator = function (configuration) {
|
|
|
687
705
|
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options };
|
|
688
706
|
const localVarHeaderParameter = {};
|
|
689
707
|
const localVarQueryParameter = {};
|
|
708
|
+
// authentication ApiKeyAuth required
|
|
709
|
+
await (0, common_1.setApiKeyToObject)(localVarHeaderParameter, "x-storesecret", configuration);
|
|
690
710
|
localVarHeaderParameter['Accept'] = 'application/json';
|
|
691
711
|
if (xStoreid != null) {
|
|
692
712
|
localVarHeaderParameter['x-storeid'] = String(xStoreid);
|
|
@@ -728,6 +748,8 @@ const AnalyticsEventsApiAxiosParamCreator = function (configuration) {
|
|
|
728
748
|
const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options };
|
|
729
749
|
const localVarHeaderParameter = {};
|
|
730
750
|
const localVarQueryParameter = {};
|
|
751
|
+
// authentication ApiKeyAuth required
|
|
752
|
+
await (0, common_1.setApiKeyToObject)(localVarHeaderParameter, "x-storesecret", configuration);
|
|
731
753
|
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
732
754
|
localVarHeaderParameter['Accept'] = 'application/json';
|
|
733
755
|
if (xStoreid != null) {
|
|
@@ -768,6 +790,8 @@ const AnalyticsEventsApiAxiosParamCreator = function (configuration) {
|
|
|
768
790
|
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options };
|
|
769
791
|
const localVarHeaderParameter = {};
|
|
770
792
|
const localVarQueryParameter = {};
|
|
793
|
+
// authentication ApiKeyAuth required
|
|
794
|
+
await (0, common_1.setApiKeyToObject)(localVarHeaderParameter, "x-storesecret", configuration);
|
|
771
795
|
localVarHeaderParameter['Accept'] = 'application/json';
|
|
772
796
|
if (xStoreid != null) {
|
|
773
797
|
localVarHeaderParameter['x-storeid'] = String(xStoreid);
|
|
@@ -809,6 +833,8 @@ const AnalyticsEventsApiAxiosParamCreator = function (configuration) {
|
|
|
809
833
|
const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options };
|
|
810
834
|
const localVarHeaderParameter = {};
|
|
811
835
|
const localVarQueryParameter = {};
|
|
836
|
+
// authentication ApiKeyAuth required
|
|
837
|
+
await (0, common_1.setApiKeyToObject)(localVarHeaderParameter, "x-storesecret", configuration);
|
|
812
838
|
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
813
839
|
localVarHeaderParameter['Accept'] = 'application/json';
|
|
814
840
|
if (xStoreid != null) {
|
|
@@ -1042,16 +1068,291 @@ class AnalyticsEventsApi extends base_1.BaseAPI {
|
|
|
1042
1068
|
}
|
|
1043
1069
|
}
|
|
1044
1070
|
exports.AnalyticsEventsApi = AnalyticsEventsApi;
|
|
1071
|
+
/**
|
|
1072
|
+
* FiltersApi - axios parameter creator
|
|
1073
|
+
*/
|
|
1074
|
+
const FiltersApiAxiosParamCreator = function (configuration) {
|
|
1075
|
+
return {
|
|
1076
|
+
/**
|
|
1077
|
+
* Search or autocomplete within a single facet\'s values. Useful for facets with many values (e.g., brands) where you need typeahead search.
|
|
1078
|
+
* @summary Search Facet Values
|
|
1079
|
+
* @param {string} xStoreid Store ID (from dashboard)
|
|
1080
|
+
* @param {string} xStoresecret Store read secret (from dashboard)
|
|
1081
|
+
* @param {string} facetName Facet field name (e.g., brand, category)
|
|
1082
|
+
* @param {DataTypesFacetValuesSearchRequest} dataTypesFacetValuesSearchRequest Facet search query
|
|
1083
|
+
* @param {*} [options] Override http request option.
|
|
1084
|
+
* @throws {RequiredError}
|
|
1085
|
+
*/
|
|
1086
|
+
v1FiltersFacetNameValuesPost: async (xStoreid, xStoresecret, facetName, dataTypesFacetValuesSearchRequest, options = {}) => {
|
|
1087
|
+
// verify required parameter 'xStoreid' is not null or undefined
|
|
1088
|
+
(0, common_1.assertParamExists)('v1FiltersFacetNameValuesPost', 'xStoreid', xStoreid);
|
|
1089
|
+
// verify required parameter 'xStoresecret' is not null or undefined
|
|
1090
|
+
(0, common_1.assertParamExists)('v1FiltersFacetNameValuesPost', 'xStoresecret', xStoresecret);
|
|
1091
|
+
// verify required parameter 'facetName' is not null or undefined
|
|
1092
|
+
(0, common_1.assertParamExists)('v1FiltersFacetNameValuesPost', 'facetName', facetName);
|
|
1093
|
+
// verify required parameter 'dataTypesFacetValuesSearchRequest' is not null or undefined
|
|
1094
|
+
(0, common_1.assertParamExists)('v1FiltersFacetNameValuesPost', 'dataTypesFacetValuesSearchRequest', dataTypesFacetValuesSearchRequest);
|
|
1095
|
+
const localVarPath = `/v1/filters/{facetName}/values`
|
|
1096
|
+
.replace(`{${"facetName"}}`, encodeURIComponent(String(facetName)));
|
|
1097
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
1098
|
+
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
1099
|
+
let baseOptions;
|
|
1100
|
+
if (configuration) {
|
|
1101
|
+
baseOptions = configuration.baseOptions;
|
|
1102
|
+
}
|
|
1103
|
+
const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options };
|
|
1104
|
+
const localVarHeaderParameter = {};
|
|
1105
|
+
const localVarQueryParameter = {};
|
|
1106
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
1107
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
1108
|
+
if (xStoreid != null) {
|
|
1109
|
+
localVarHeaderParameter['x-storeid'] = String(xStoreid);
|
|
1110
|
+
}
|
|
1111
|
+
if (xStoresecret != null) {
|
|
1112
|
+
localVarHeaderParameter['x-storesecret'] = String(xStoresecret);
|
|
1113
|
+
}
|
|
1114
|
+
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
1115
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
1116
|
+
localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
|
|
1117
|
+
localVarRequestOptions.data = (0, common_1.serializeDataIfNeeded)(dataTypesFacetValuesSearchRequest, localVarRequestOptions, configuration);
|
|
1118
|
+
return {
|
|
1119
|
+
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
1120
|
+
options: localVarRequestOptions,
|
|
1121
|
+
};
|
|
1122
|
+
},
|
|
1123
|
+
/**
|
|
1124
|
+
* Get filter values and counts for configured facets. Use this to build faceted navigation UIs. Supports disjunctive faceting for OR-based filter combinations.
|
|
1125
|
+
* @summary Get Filters
|
|
1126
|
+
* @param {string} xStoreid Store ID (from dashboard)
|
|
1127
|
+
* @param {string} xStoresecret Store read secret (from dashboard)
|
|
1128
|
+
* @param {DataTypesFiltersRequest} [dataTypesFiltersRequest] Filter options
|
|
1129
|
+
* @param {*} [options] Override http request option.
|
|
1130
|
+
* @throws {RequiredError}
|
|
1131
|
+
*/
|
|
1132
|
+
v1FiltersPost: async (xStoreid, xStoresecret, dataTypesFiltersRequest, options = {}) => {
|
|
1133
|
+
// verify required parameter 'xStoreid' is not null or undefined
|
|
1134
|
+
(0, common_1.assertParamExists)('v1FiltersPost', 'xStoreid', xStoreid);
|
|
1135
|
+
// verify required parameter 'xStoresecret' is not null or undefined
|
|
1136
|
+
(0, common_1.assertParamExists)('v1FiltersPost', 'xStoresecret', xStoresecret);
|
|
1137
|
+
const localVarPath = `/v1/filters`;
|
|
1138
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
1139
|
+
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
1140
|
+
let baseOptions;
|
|
1141
|
+
if (configuration) {
|
|
1142
|
+
baseOptions = configuration.baseOptions;
|
|
1143
|
+
}
|
|
1144
|
+
const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options };
|
|
1145
|
+
const localVarHeaderParameter = {};
|
|
1146
|
+
const localVarQueryParameter = {};
|
|
1147
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
1148
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
1149
|
+
if (xStoreid != null) {
|
|
1150
|
+
localVarHeaderParameter['x-storeid'] = String(xStoreid);
|
|
1151
|
+
}
|
|
1152
|
+
if (xStoresecret != null) {
|
|
1153
|
+
localVarHeaderParameter['x-storesecret'] = String(xStoresecret);
|
|
1154
|
+
}
|
|
1155
|
+
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
1156
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
1157
|
+
localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
|
|
1158
|
+
localVarRequestOptions.data = (0, common_1.serializeDataIfNeeded)(dataTypesFiltersRequest, localVarRequestOptions, configuration);
|
|
1159
|
+
return {
|
|
1160
|
+
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
1161
|
+
options: localVarRequestOptions,
|
|
1162
|
+
};
|
|
1163
|
+
},
|
|
1164
|
+
/**
|
|
1165
|
+
* Get available filter field metadata including types, sortability, and configured ranges. Useful for dynamically building filter UIs.
|
|
1166
|
+
* @summary Get Filters Schema
|
|
1167
|
+
* @param {string} xStoreid Store ID (from dashboard)
|
|
1168
|
+
* @param {string} xStoresecret Store read secret (from dashboard)
|
|
1169
|
+
* @param {*} [options] Override http request option.
|
|
1170
|
+
* @throws {RequiredError}
|
|
1171
|
+
*/
|
|
1172
|
+
v1FiltersSchemaGet: async (xStoreid, xStoresecret, options = {}) => {
|
|
1173
|
+
// verify required parameter 'xStoreid' is not null or undefined
|
|
1174
|
+
(0, common_1.assertParamExists)('v1FiltersSchemaGet', 'xStoreid', xStoreid);
|
|
1175
|
+
// verify required parameter 'xStoresecret' is not null or undefined
|
|
1176
|
+
(0, common_1.assertParamExists)('v1FiltersSchemaGet', 'xStoresecret', xStoresecret);
|
|
1177
|
+
const localVarPath = `/v1/filters/schema`;
|
|
1178
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
1179
|
+
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
1180
|
+
let baseOptions;
|
|
1181
|
+
if (configuration) {
|
|
1182
|
+
baseOptions = configuration.baseOptions;
|
|
1183
|
+
}
|
|
1184
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options };
|
|
1185
|
+
const localVarHeaderParameter = {};
|
|
1186
|
+
const localVarQueryParameter = {};
|
|
1187
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
1188
|
+
if (xStoreid != null) {
|
|
1189
|
+
localVarHeaderParameter['x-storeid'] = String(xStoreid);
|
|
1190
|
+
}
|
|
1191
|
+
if (xStoresecret != null) {
|
|
1192
|
+
localVarHeaderParameter['x-storesecret'] = String(xStoresecret);
|
|
1193
|
+
}
|
|
1194
|
+
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
1195
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
1196
|
+
localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
|
|
1197
|
+
return {
|
|
1198
|
+
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
1199
|
+
options: localVarRequestOptions,
|
|
1200
|
+
};
|
|
1201
|
+
},
|
|
1202
|
+
};
|
|
1203
|
+
};
|
|
1204
|
+
exports.FiltersApiAxiosParamCreator = FiltersApiAxiosParamCreator;
|
|
1205
|
+
/**
|
|
1206
|
+
* FiltersApi - functional programming interface
|
|
1207
|
+
*/
|
|
1208
|
+
const FiltersApiFp = function (configuration) {
|
|
1209
|
+
const localVarAxiosParamCreator = (0, exports.FiltersApiAxiosParamCreator)(configuration);
|
|
1210
|
+
return {
|
|
1211
|
+
/**
|
|
1212
|
+
* Search or autocomplete within a single facet\'s values. Useful for facets with many values (e.g., brands) where you need typeahead search.
|
|
1213
|
+
* @summary Search Facet Values
|
|
1214
|
+
* @param {string} xStoreid Store ID (from dashboard)
|
|
1215
|
+
* @param {string} xStoresecret Store read secret (from dashboard)
|
|
1216
|
+
* @param {string} facetName Facet field name (e.g., brand, category)
|
|
1217
|
+
* @param {DataTypesFacetValuesSearchRequest} dataTypesFacetValuesSearchRequest Facet search query
|
|
1218
|
+
* @param {*} [options] Override http request option.
|
|
1219
|
+
* @throws {RequiredError}
|
|
1220
|
+
*/
|
|
1221
|
+
async v1FiltersFacetNameValuesPost(xStoreid, xStoresecret, facetName, dataTypesFacetValuesSearchRequest, options) {
|
|
1222
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.v1FiltersFacetNameValuesPost(xStoreid, xStoresecret, facetName, dataTypesFacetValuesSearchRequest, options);
|
|
1223
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
1224
|
+
const localVarOperationServerBasePath = base_1.operationServerMap['FiltersApi.v1FiltersFacetNameValuesPost']?.[localVarOperationServerIndex]?.url;
|
|
1225
|
+
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
1226
|
+
},
|
|
1227
|
+
/**
|
|
1228
|
+
* Get filter values and counts for configured facets. Use this to build faceted navigation UIs. Supports disjunctive faceting for OR-based filter combinations.
|
|
1229
|
+
* @summary Get Filters
|
|
1230
|
+
* @param {string} xStoreid Store ID (from dashboard)
|
|
1231
|
+
* @param {string} xStoresecret Store read secret (from dashboard)
|
|
1232
|
+
* @param {DataTypesFiltersRequest} [dataTypesFiltersRequest] Filter options
|
|
1233
|
+
* @param {*} [options] Override http request option.
|
|
1234
|
+
* @throws {RequiredError}
|
|
1235
|
+
*/
|
|
1236
|
+
async v1FiltersPost(xStoreid, xStoresecret, dataTypesFiltersRequest, options) {
|
|
1237
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.v1FiltersPost(xStoreid, xStoresecret, dataTypesFiltersRequest, options);
|
|
1238
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
1239
|
+
const localVarOperationServerBasePath = base_1.operationServerMap['FiltersApi.v1FiltersPost']?.[localVarOperationServerIndex]?.url;
|
|
1240
|
+
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
1241
|
+
},
|
|
1242
|
+
/**
|
|
1243
|
+
* Get available filter field metadata including types, sortability, and configured ranges. Useful for dynamically building filter UIs.
|
|
1244
|
+
* @summary Get Filters Schema
|
|
1245
|
+
* @param {string} xStoreid Store ID (from dashboard)
|
|
1246
|
+
* @param {string} xStoresecret Store read secret (from dashboard)
|
|
1247
|
+
* @param {*} [options] Override http request option.
|
|
1248
|
+
* @throws {RequiredError}
|
|
1249
|
+
*/
|
|
1250
|
+
async v1FiltersSchemaGet(xStoreid, xStoresecret, options) {
|
|
1251
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.v1FiltersSchemaGet(xStoreid, xStoresecret, options);
|
|
1252
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
1253
|
+
const localVarOperationServerBasePath = base_1.operationServerMap['FiltersApi.v1FiltersSchemaGet']?.[localVarOperationServerIndex]?.url;
|
|
1254
|
+
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
1255
|
+
},
|
|
1256
|
+
};
|
|
1257
|
+
};
|
|
1258
|
+
exports.FiltersApiFp = FiltersApiFp;
|
|
1259
|
+
/**
|
|
1260
|
+
* FiltersApi - factory interface
|
|
1261
|
+
*/
|
|
1262
|
+
const FiltersApiFactory = function (configuration, basePath, axios) {
|
|
1263
|
+
const localVarFp = (0, exports.FiltersApiFp)(configuration);
|
|
1264
|
+
return {
|
|
1265
|
+
/**
|
|
1266
|
+
* Search or autocomplete within a single facet\'s values. Useful for facets with many values (e.g., brands) where you need typeahead search.
|
|
1267
|
+
* @summary Search Facet Values
|
|
1268
|
+
* @param {string} xStoreid Store ID (from dashboard)
|
|
1269
|
+
* @param {string} xStoresecret Store read secret (from dashboard)
|
|
1270
|
+
* @param {string} facetName Facet field name (e.g., brand, category)
|
|
1271
|
+
* @param {DataTypesFacetValuesSearchRequest} dataTypesFacetValuesSearchRequest Facet search query
|
|
1272
|
+
* @param {*} [options] Override http request option.
|
|
1273
|
+
* @throws {RequiredError}
|
|
1274
|
+
*/
|
|
1275
|
+
v1FiltersFacetNameValuesPost(xStoreid, xStoresecret, facetName, dataTypesFacetValuesSearchRequest, options) {
|
|
1276
|
+
return localVarFp.v1FiltersFacetNameValuesPost(xStoreid, xStoresecret, facetName, dataTypesFacetValuesSearchRequest, options).then((request) => request(axios, basePath));
|
|
1277
|
+
},
|
|
1278
|
+
/**
|
|
1279
|
+
* Get filter values and counts for configured facets. Use this to build faceted navigation UIs. Supports disjunctive faceting for OR-based filter combinations.
|
|
1280
|
+
* @summary Get Filters
|
|
1281
|
+
* @param {string} xStoreid Store ID (from dashboard)
|
|
1282
|
+
* @param {string} xStoresecret Store read secret (from dashboard)
|
|
1283
|
+
* @param {DataTypesFiltersRequest} [dataTypesFiltersRequest] Filter options
|
|
1284
|
+
* @param {*} [options] Override http request option.
|
|
1285
|
+
* @throws {RequiredError}
|
|
1286
|
+
*/
|
|
1287
|
+
v1FiltersPost(xStoreid, xStoresecret, dataTypesFiltersRequest, options) {
|
|
1288
|
+
return localVarFp.v1FiltersPost(xStoreid, xStoresecret, dataTypesFiltersRequest, options).then((request) => request(axios, basePath));
|
|
1289
|
+
},
|
|
1290
|
+
/**
|
|
1291
|
+
* Get available filter field metadata including types, sortability, and configured ranges. Useful for dynamically building filter UIs.
|
|
1292
|
+
* @summary Get Filters Schema
|
|
1293
|
+
* @param {string} xStoreid Store ID (from dashboard)
|
|
1294
|
+
* @param {string} xStoresecret Store read secret (from dashboard)
|
|
1295
|
+
* @param {*} [options] Override http request option.
|
|
1296
|
+
* @throws {RequiredError}
|
|
1297
|
+
*/
|
|
1298
|
+
v1FiltersSchemaGet(xStoreid, xStoresecret, options) {
|
|
1299
|
+
return localVarFp.v1FiltersSchemaGet(xStoreid, xStoresecret, options).then((request) => request(axios, basePath));
|
|
1300
|
+
},
|
|
1301
|
+
};
|
|
1302
|
+
};
|
|
1303
|
+
exports.FiltersApiFactory = FiltersApiFactory;
|
|
1304
|
+
/**
|
|
1305
|
+
* FiltersApi - object-oriented interface
|
|
1306
|
+
*/
|
|
1307
|
+
class FiltersApi extends base_1.BaseAPI {
|
|
1308
|
+
/**
|
|
1309
|
+
* Search or autocomplete within a single facet\'s values. Useful for facets with many values (e.g., brands) where you need typeahead search.
|
|
1310
|
+
* @summary Search Facet Values
|
|
1311
|
+
* @param {string} xStoreid Store ID (from dashboard)
|
|
1312
|
+
* @param {string} xStoresecret Store read secret (from dashboard)
|
|
1313
|
+
* @param {string} facetName Facet field name (e.g., brand, category)
|
|
1314
|
+
* @param {DataTypesFacetValuesSearchRequest} dataTypesFacetValuesSearchRequest Facet search query
|
|
1315
|
+
* @param {*} [options] Override http request option.
|
|
1316
|
+
* @throws {RequiredError}
|
|
1317
|
+
*/
|
|
1318
|
+
v1FiltersFacetNameValuesPost(xStoreid, xStoresecret, facetName, dataTypesFacetValuesSearchRequest, options) {
|
|
1319
|
+
return (0, exports.FiltersApiFp)(this.configuration).v1FiltersFacetNameValuesPost(xStoreid, xStoresecret, facetName, dataTypesFacetValuesSearchRequest, options).then((request) => request(this.axios, this.basePath));
|
|
1320
|
+
}
|
|
1321
|
+
/**
|
|
1322
|
+
* Get filter values and counts for configured facets. Use this to build faceted navigation UIs. Supports disjunctive faceting for OR-based filter combinations.
|
|
1323
|
+
* @summary Get Filters
|
|
1324
|
+
* @param {string} xStoreid Store ID (from dashboard)
|
|
1325
|
+
* @param {string} xStoresecret Store read secret (from dashboard)
|
|
1326
|
+
* @param {DataTypesFiltersRequest} [dataTypesFiltersRequest] Filter options
|
|
1327
|
+
* @param {*} [options] Override http request option.
|
|
1328
|
+
* @throws {RequiredError}
|
|
1329
|
+
*/
|
|
1330
|
+
v1FiltersPost(xStoreid, xStoresecret, dataTypesFiltersRequest, options) {
|
|
1331
|
+
return (0, exports.FiltersApiFp)(this.configuration).v1FiltersPost(xStoreid, xStoresecret, dataTypesFiltersRequest, options).then((request) => request(this.axios, this.basePath));
|
|
1332
|
+
}
|
|
1333
|
+
/**
|
|
1334
|
+
* Get available filter field metadata including types, sortability, and configured ranges. Useful for dynamically building filter UIs.
|
|
1335
|
+
* @summary Get Filters Schema
|
|
1336
|
+
* @param {string} xStoreid Store ID (from dashboard)
|
|
1337
|
+
* @param {string} xStoresecret Store read secret (from dashboard)
|
|
1338
|
+
* @param {*} [options] Override http request option.
|
|
1339
|
+
* @throws {RequiredError}
|
|
1340
|
+
*/
|
|
1341
|
+
v1FiltersSchemaGet(xStoreid, xStoresecret, options) {
|
|
1342
|
+
return (0, exports.FiltersApiFp)(this.configuration).v1FiltersSchemaGet(xStoreid, xStoresecret, options).then((request) => request(this.axios, this.basePath));
|
|
1343
|
+
}
|
|
1344
|
+
}
|
|
1345
|
+
exports.FiltersApi = FiltersApi;
|
|
1045
1346
|
/**
|
|
1046
1347
|
* QuerySuggestionsApi - axios parameter creator
|
|
1047
1348
|
*/
|
|
1048
1349
|
const QuerySuggestionsApiAxiosParamCreator = function (configuration) {
|
|
1049
1350
|
return {
|
|
1050
1351
|
/**
|
|
1051
|
-
*
|
|
1052
|
-
* @summary Get
|
|
1053
|
-
* @param {string} xStoreid Store ID
|
|
1054
|
-
* @param {string} xStoresecret Store
|
|
1352
|
+
* Returns limits, supported time ranges, and default values for the query suggestions API. **Auth:** `x-storeid` and `x-storesecret`.
|
|
1353
|
+
* @summary Get suggestions configuration
|
|
1354
|
+
* @param {string} xStoreid Store ID (from dashboard)
|
|
1355
|
+
* @param {string} xStoresecret Store read secret
|
|
1055
1356
|
* @param {*} [options] Override http request option.
|
|
1056
1357
|
* @throws {RequiredError}
|
|
1057
1358
|
*/
|
|
@@ -1086,34 +1387,34 @@ const QuerySuggestionsApiAxiosParamCreator = function (configuration) {
|
|
|
1086
1387
|
};
|
|
1087
1388
|
},
|
|
1088
1389
|
/**
|
|
1089
|
-
*
|
|
1090
|
-
* @summary Get
|
|
1091
|
-
* @param {string} xStoreid Store ID
|
|
1092
|
-
* @param {string} xStoresecret Store
|
|
1093
|
-
* @param {string} [xUserId] User ID for personalization
|
|
1094
|
-
* @param {string} [xAnonId] Anonymous ID for personalization
|
|
1390
|
+
* Autocomplete suggestions for search, ranked by popularity. **Auth:** `x-storeid` and `x-storesecret` (from dashboard). Optional: `x-user-id`, `x-anon-id`, `x-session-id` for personalization. Supports partial query, filters (analytics_tags), time range (7d/30d/90d), categories, facets, and dropdown recommendations. Use `query` or `q` for the partial search string.
|
|
1391
|
+
* @summary Get query suggestions (GET)
|
|
1392
|
+
* @param {string} xStoreid Store ID (from dashboard)
|
|
1393
|
+
* @param {string} xStoresecret Store read secret
|
|
1394
|
+
* @param {string} [xUserId] User ID for personalization
|
|
1395
|
+
* @param {string} [xAnonId] Anonymous user ID for personalization
|
|
1095
1396
|
* @param {string} [xSessionId] Session ID for personalization
|
|
1096
|
-
* @param {string} [query] Partial query
|
|
1097
|
-
* @param {string} [q] Alias for
|
|
1098
|
-
* @param {number} [hitsPerPage]
|
|
1099
|
-
* @param {number} [page] Page
|
|
1100
|
-
* @param {string} [analyticsTags] Comma-separated
|
|
1101
|
-
* @param {V1SuggestionsQueriesGetTagsMatchModeEnum} [tagsMatchMode]
|
|
1102
|
-
* @param {boolean} [includeCategories] Include category
|
|
1103
|
-
* @param {boolean} [includeFacets] Include
|
|
1104
|
-
* @param {boolean} [includeDropdownRecommendations] Include
|
|
1105
|
-
* @param {boolean} [includeDropdownProductList] Include product list in dropdown
|
|
1106
|
-
* @param {boolean} [includeFilteredTabs] Include filtered tabs
|
|
1107
|
-
* @param {boolean} [includeEmptyQueryRecommendations]
|
|
1108
|
-
* @param {number} [maxCategories]
|
|
1109
|
-
* @param {number} [maxFacets]
|
|
1110
|
-
* @param {number} [minPopularity]
|
|
1111
|
-
* @param {V1SuggestionsQueriesGetTimeRangeEnum} [timeRange]
|
|
1112
|
-
* @param {boolean} [disableTypoTolerance] Disable fuzzy
|
|
1113
|
-
* @param {string} [filteredTabs] URL-encoded JSON array of
|
|
1114
|
-
* @param {string} [userId] User ID
|
|
1115
|
-
* @param {string} [anonId] Anonymous ID
|
|
1116
|
-
* @param {string} [sessionId] Session ID
|
|
1397
|
+
* @param {string} [query] Partial query (use \'query\' or \'q\')
|
|
1398
|
+
* @param {string} [q] Alias for query
|
|
1399
|
+
* @param {number} [hitsPerPage] Suggestions to return
|
|
1400
|
+
* @param {number} [page] Page for pagination
|
|
1401
|
+
* @param {string} [analyticsTags] Comma-separated tags to filter
|
|
1402
|
+
* @param {V1SuggestionsQueriesGetTagsMatchModeEnum} [tagsMatchMode] Match mode for tags
|
|
1403
|
+
* @param {boolean} [includeCategories] Include category in suggestions
|
|
1404
|
+
* @param {boolean} [includeFacets] Include facet info
|
|
1405
|
+
* @param {boolean} [includeDropdownRecommendations] Include dropdown recommendations
|
|
1406
|
+
* @param {boolean} [includeDropdownProductList] Include product list in dropdown
|
|
1407
|
+
* @param {boolean} [includeFilteredTabs] Include filtered tabs
|
|
1408
|
+
* @param {boolean} [includeEmptyQueryRecommendations] Popular suggestions when query empty
|
|
1409
|
+
* @param {number} [maxCategories] Max categories per suggestion
|
|
1410
|
+
* @param {number} [maxFacets] Max facets per suggestion
|
|
1411
|
+
* @param {number} [minPopularity] Min popularity
|
|
1412
|
+
* @param {V1SuggestionsQueriesGetTimeRangeEnum} [timeRange] Data time range
|
|
1413
|
+
* @param {boolean} [disableTypoTolerance] Disable fuzzy matching
|
|
1414
|
+
* @param {string} [filteredTabs] URL-encoded JSON array of tab configs
|
|
1415
|
+
* @param {string} [userId] User ID (fallback if header not set)
|
|
1416
|
+
* @param {string} [anonId] Anonymous ID (fallback)
|
|
1417
|
+
* @param {string} [sessionId] Session ID (fallback)
|
|
1117
1418
|
* @param {*} [options] Override http request option.
|
|
1118
1419
|
* @throws {RequiredError}
|
|
1119
1420
|
*/
|
|
@@ -1220,14 +1521,14 @@ const QuerySuggestionsApiAxiosParamCreator = function (configuration) {
|
|
|
1220
1521
|
};
|
|
1221
1522
|
},
|
|
1222
1523
|
/**
|
|
1223
|
-
* Same as GET
|
|
1224
|
-
* @summary
|
|
1225
|
-
* @param {string} xStoreid Store ID
|
|
1226
|
-
* @param {string} xStoresecret Store
|
|
1227
|
-
* @param {string} [xUserId] User ID for personalization
|
|
1228
|
-
* @param {string} [xAnonId] Anonymous ID for personalization
|
|
1524
|
+
* Same as GET; use POST to send a JSON body (e.g. complex filtered_tabs). **Auth:** `x-storeid` and `x-storesecret`. Optional personalization headers: `x-user-id`, `x-anon-id`, `x-session-id`. Request body can include query, hitsPerPage, analytics_tags, include_categories, include_facets, filtered_tabs, etc.
|
|
1525
|
+
* @summary Get query suggestions (POST)
|
|
1526
|
+
* @param {string} xStoreid Store ID (from dashboard)
|
|
1527
|
+
* @param {string} xStoresecret Store read secret
|
|
1528
|
+
* @param {string} [xUserId] User ID for personalization
|
|
1529
|
+
* @param {string} [xAnonId] Anonymous user ID for personalization
|
|
1229
1530
|
* @param {string} [xSessionId] Session ID for personalization
|
|
1230
|
-
* @param {QuerySuggestionsServiceQuerySuggestionsRequest} [querySuggestionsServiceQuerySuggestionsRequest]
|
|
1531
|
+
* @param {QuerySuggestionsServiceQuerySuggestionsRequest} [querySuggestionsServiceQuerySuggestionsRequest] Request (query, hitsPerPage, analytics_tags, filtered_tabs, etc.)
|
|
1231
1532
|
* @param {*} [options] Override http request option.
|
|
1232
1533
|
* @throws {RequiredError}
|
|
1233
1534
|
*/
|
|
@@ -1282,10 +1583,10 @@ const QuerySuggestionsApiFp = function (configuration) {
|
|
|
1282
1583
|
const localVarAxiosParamCreator = (0, exports.QuerySuggestionsApiAxiosParamCreator)(configuration);
|
|
1283
1584
|
return {
|
|
1284
1585
|
/**
|
|
1285
|
-
*
|
|
1286
|
-
* @summary Get
|
|
1287
|
-
* @param {string} xStoreid Store ID
|
|
1288
|
-
* @param {string} xStoresecret Store
|
|
1586
|
+
* Returns limits, supported time ranges, and default values for the query suggestions API. **Auth:** `x-storeid` and `x-storesecret`.
|
|
1587
|
+
* @summary Get suggestions configuration
|
|
1588
|
+
* @param {string} xStoreid Store ID (from dashboard)
|
|
1589
|
+
* @param {string} xStoresecret Store read secret
|
|
1289
1590
|
* @param {*} [options] Override http request option.
|
|
1290
1591
|
* @throws {RequiredError}
|
|
1291
1592
|
*/
|
|
@@ -1296,34 +1597,34 @@ const QuerySuggestionsApiFp = function (configuration) {
|
|
|
1296
1597
|
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
1297
1598
|
},
|
|
1298
1599
|
/**
|
|
1299
|
-
*
|
|
1300
|
-
* @summary Get
|
|
1301
|
-
* @param {string} xStoreid Store ID
|
|
1302
|
-
* @param {string} xStoresecret Store
|
|
1303
|
-
* @param {string} [xUserId] User ID for personalization
|
|
1304
|
-
* @param {string} [xAnonId] Anonymous ID for personalization
|
|
1600
|
+
* Autocomplete suggestions for search, ranked by popularity. **Auth:** `x-storeid` and `x-storesecret` (from dashboard). Optional: `x-user-id`, `x-anon-id`, `x-session-id` for personalization. Supports partial query, filters (analytics_tags), time range (7d/30d/90d), categories, facets, and dropdown recommendations. Use `query` or `q` for the partial search string.
|
|
1601
|
+
* @summary Get query suggestions (GET)
|
|
1602
|
+
* @param {string} xStoreid Store ID (from dashboard)
|
|
1603
|
+
* @param {string} xStoresecret Store read secret
|
|
1604
|
+
* @param {string} [xUserId] User ID for personalization
|
|
1605
|
+
* @param {string} [xAnonId] Anonymous user ID for personalization
|
|
1305
1606
|
* @param {string} [xSessionId] Session ID for personalization
|
|
1306
|
-
* @param {string} [query] Partial query
|
|
1307
|
-
* @param {string} [q] Alias for
|
|
1308
|
-
* @param {number} [hitsPerPage]
|
|
1309
|
-
* @param {number} [page] Page
|
|
1310
|
-
* @param {string} [analyticsTags] Comma-separated
|
|
1311
|
-
* @param {V1SuggestionsQueriesGetTagsMatchModeEnum} [tagsMatchMode]
|
|
1312
|
-
* @param {boolean} [includeCategories] Include category
|
|
1313
|
-
* @param {boolean} [includeFacets] Include
|
|
1314
|
-
* @param {boolean} [includeDropdownRecommendations] Include
|
|
1315
|
-
* @param {boolean} [includeDropdownProductList] Include product list in dropdown
|
|
1316
|
-
* @param {boolean} [includeFilteredTabs] Include filtered tabs
|
|
1317
|
-
* @param {boolean} [includeEmptyQueryRecommendations]
|
|
1318
|
-
* @param {number} [maxCategories]
|
|
1319
|
-
* @param {number} [maxFacets]
|
|
1320
|
-
* @param {number} [minPopularity]
|
|
1321
|
-
* @param {V1SuggestionsQueriesGetTimeRangeEnum} [timeRange]
|
|
1322
|
-
* @param {boolean} [disableTypoTolerance] Disable fuzzy
|
|
1323
|
-
* @param {string} [filteredTabs] URL-encoded JSON array of
|
|
1324
|
-
* @param {string} [userId] User ID
|
|
1325
|
-
* @param {string} [anonId] Anonymous ID
|
|
1326
|
-
* @param {string} [sessionId] Session ID
|
|
1607
|
+
* @param {string} [query] Partial query (use \'query\' or \'q\')
|
|
1608
|
+
* @param {string} [q] Alias for query
|
|
1609
|
+
* @param {number} [hitsPerPage] Suggestions to return
|
|
1610
|
+
* @param {number} [page] Page for pagination
|
|
1611
|
+
* @param {string} [analyticsTags] Comma-separated tags to filter
|
|
1612
|
+
* @param {V1SuggestionsQueriesGetTagsMatchModeEnum} [tagsMatchMode] Match mode for tags
|
|
1613
|
+
* @param {boolean} [includeCategories] Include category in suggestions
|
|
1614
|
+
* @param {boolean} [includeFacets] Include facet info
|
|
1615
|
+
* @param {boolean} [includeDropdownRecommendations] Include dropdown recommendations
|
|
1616
|
+
* @param {boolean} [includeDropdownProductList] Include product list in dropdown
|
|
1617
|
+
* @param {boolean} [includeFilteredTabs] Include filtered tabs
|
|
1618
|
+
* @param {boolean} [includeEmptyQueryRecommendations] Popular suggestions when query empty
|
|
1619
|
+
* @param {number} [maxCategories] Max categories per suggestion
|
|
1620
|
+
* @param {number} [maxFacets] Max facets per suggestion
|
|
1621
|
+
* @param {number} [minPopularity] Min popularity
|
|
1622
|
+
* @param {V1SuggestionsQueriesGetTimeRangeEnum} [timeRange] Data time range
|
|
1623
|
+
* @param {boolean} [disableTypoTolerance] Disable fuzzy matching
|
|
1624
|
+
* @param {string} [filteredTabs] URL-encoded JSON array of tab configs
|
|
1625
|
+
* @param {string} [userId] User ID (fallback if header not set)
|
|
1626
|
+
* @param {string} [anonId] Anonymous ID (fallback)
|
|
1627
|
+
* @param {string} [sessionId] Session ID (fallback)
|
|
1327
1628
|
* @param {*} [options] Override http request option.
|
|
1328
1629
|
* @throws {RequiredError}
|
|
1329
1630
|
*/
|
|
@@ -1334,14 +1635,14 @@ const QuerySuggestionsApiFp = function (configuration) {
|
|
|
1334
1635
|
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
1335
1636
|
},
|
|
1336
1637
|
/**
|
|
1337
|
-
* Same as GET
|
|
1338
|
-
* @summary
|
|
1339
|
-
* @param {string} xStoreid Store ID
|
|
1340
|
-
* @param {string} xStoresecret Store
|
|
1341
|
-
* @param {string} [xUserId] User ID for personalization
|
|
1342
|
-
* @param {string} [xAnonId] Anonymous ID for personalization
|
|
1638
|
+
* Same as GET; use POST to send a JSON body (e.g. complex filtered_tabs). **Auth:** `x-storeid` and `x-storesecret`. Optional personalization headers: `x-user-id`, `x-anon-id`, `x-session-id`. Request body can include query, hitsPerPage, analytics_tags, include_categories, include_facets, filtered_tabs, etc.
|
|
1639
|
+
* @summary Get query suggestions (POST)
|
|
1640
|
+
* @param {string} xStoreid Store ID (from dashboard)
|
|
1641
|
+
* @param {string} xStoresecret Store read secret
|
|
1642
|
+
* @param {string} [xUserId] User ID for personalization
|
|
1643
|
+
* @param {string} [xAnonId] Anonymous user ID for personalization
|
|
1343
1644
|
* @param {string} [xSessionId] Session ID for personalization
|
|
1344
|
-
* @param {QuerySuggestionsServiceQuerySuggestionsRequest} [querySuggestionsServiceQuerySuggestionsRequest]
|
|
1645
|
+
* @param {QuerySuggestionsServiceQuerySuggestionsRequest} [querySuggestionsServiceQuerySuggestionsRequest] Request (query, hitsPerPage, analytics_tags, filtered_tabs, etc.)
|
|
1345
1646
|
* @param {*} [options] Override http request option.
|
|
1346
1647
|
* @throws {RequiredError}
|
|
1347
1648
|
*/
|
|
@@ -1361,10 +1662,10 @@ const QuerySuggestionsApiFactory = function (configuration, basePath, axios) {
|
|
|
1361
1662
|
const localVarFp = (0, exports.QuerySuggestionsApiFp)(configuration);
|
|
1362
1663
|
return {
|
|
1363
1664
|
/**
|
|
1364
|
-
*
|
|
1365
|
-
* @summary Get
|
|
1366
|
-
* @param {string} xStoreid Store ID
|
|
1367
|
-
* @param {string} xStoresecret Store
|
|
1665
|
+
* Returns limits, supported time ranges, and default values for the query suggestions API. **Auth:** `x-storeid` and `x-storesecret`.
|
|
1666
|
+
* @summary Get suggestions configuration
|
|
1667
|
+
* @param {string} xStoreid Store ID (from dashboard)
|
|
1668
|
+
* @param {string} xStoresecret Store read secret
|
|
1368
1669
|
* @param {*} [options] Override http request option.
|
|
1369
1670
|
* @throws {RequiredError}
|
|
1370
1671
|
*/
|
|
@@ -1372,34 +1673,34 @@ const QuerySuggestionsApiFactory = function (configuration, basePath, axios) {
|
|
|
1372
1673
|
return localVarFp.v1SuggestionsConfigGet(xStoreid, xStoresecret, options).then((request) => request(axios, basePath));
|
|
1373
1674
|
},
|
|
1374
1675
|
/**
|
|
1375
|
-
*
|
|
1376
|
-
* @summary Get
|
|
1377
|
-
* @param {string} xStoreid Store ID
|
|
1378
|
-
* @param {string} xStoresecret Store
|
|
1379
|
-
* @param {string} [xUserId] User ID for personalization
|
|
1380
|
-
* @param {string} [xAnonId] Anonymous ID for personalization
|
|
1676
|
+
* Autocomplete suggestions for search, ranked by popularity. **Auth:** `x-storeid` and `x-storesecret` (from dashboard). Optional: `x-user-id`, `x-anon-id`, `x-session-id` for personalization. Supports partial query, filters (analytics_tags), time range (7d/30d/90d), categories, facets, and dropdown recommendations. Use `query` or `q` for the partial search string.
|
|
1677
|
+
* @summary Get query suggestions (GET)
|
|
1678
|
+
* @param {string} xStoreid Store ID (from dashboard)
|
|
1679
|
+
* @param {string} xStoresecret Store read secret
|
|
1680
|
+
* @param {string} [xUserId] User ID for personalization
|
|
1681
|
+
* @param {string} [xAnonId] Anonymous user ID for personalization
|
|
1381
1682
|
* @param {string} [xSessionId] Session ID for personalization
|
|
1382
|
-
* @param {string} [query] Partial query
|
|
1383
|
-
* @param {string} [q] Alias for
|
|
1384
|
-
* @param {number} [hitsPerPage]
|
|
1385
|
-
* @param {number} [page] Page
|
|
1386
|
-
* @param {string} [analyticsTags] Comma-separated
|
|
1387
|
-
* @param {V1SuggestionsQueriesGetTagsMatchModeEnum} [tagsMatchMode]
|
|
1388
|
-
* @param {boolean} [includeCategories] Include category
|
|
1389
|
-
* @param {boolean} [includeFacets] Include
|
|
1390
|
-
* @param {boolean} [includeDropdownRecommendations] Include
|
|
1391
|
-
* @param {boolean} [includeDropdownProductList] Include product list in dropdown
|
|
1392
|
-
* @param {boolean} [includeFilteredTabs] Include filtered tabs
|
|
1393
|
-
* @param {boolean} [includeEmptyQueryRecommendations]
|
|
1394
|
-
* @param {number} [maxCategories]
|
|
1395
|
-
* @param {number} [maxFacets]
|
|
1396
|
-
* @param {number} [minPopularity]
|
|
1397
|
-
* @param {V1SuggestionsQueriesGetTimeRangeEnum} [timeRange]
|
|
1398
|
-
* @param {boolean} [disableTypoTolerance] Disable fuzzy
|
|
1399
|
-
* @param {string} [filteredTabs] URL-encoded JSON array of
|
|
1400
|
-
* @param {string} [userId] User ID
|
|
1401
|
-
* @param {string} [anonId] Anonymous ID
|
|
1402
|
-
* @param {string} [sessionId] Session ID
|
|
1683
|
+
* @param {string} [query] Partial query (use \'query\' or \'q\')
|
|
1684
|
+
* @param {string} [q] Alias for query
|
|
1685
|
+
* @param {number} [hitsPerPage] Suggestions to return
|
|
1686
|
+
* @param {number} [page] Page for pagination
|
|
1687
|
+
* @param {string} [analyticsTags] Comma-separated tags to filter
|
|
1688
|
+
* @param {V1SuggestionsQueriesGetTagsMatchModeEnum} [tagsMatchMode] Match mode for tags
|
|
1689
|
+
* @param {boolean} [includeCategories] Include category in suggestions
|
|
1690
|
+
* @param {boolean} [includeFacets] Include facet info
|
|
1691
|
+
* @param {boolean} [includeDropdownRecommendations] Include dropdown recommendations
|
|
1692
|
+
* @param {boolean} [includeDropdownProductList] Include product list in dropdown
|
|
1693
|
+
* @param {boolean} [includeFilteredTabs] Include filtered tabs
|
|
1694
|
+
* @param {boolean} [includeEmptyQueryRecommendations] Popular suggestions when query empty
|
|
1695
|
+
* @param {number} [maxCategories] Max categories per suggestion
|
|
1696
|
+
* @param {number} [maxFacets] Max facets per suggestion
|
|
1697
|
+
* @param {number} [minPopularity] Min popularity
|
|
1698
|
+
* @param {V1SuggestionsQueriesGetTimeRangeEnum} [timeRange] Data time range
|
|
1699
|
+
* @param {boolean} [disableTypoTolerance] Disable fuzzy matching
|
|
1700
|
+
* @param {string} [filteredTabs] URL-encoded JSON array of tab configs
|
|
1701
|
+
* @param {string} [userId] User ID (fallback if header not set)
|
|
1702
|
+
* @param {string} [anonId] Anonymous ID (fallback)
|
|
1703
|
+
* @param {string} [sessionId] Session ID (fallback)
|
|
1403
1704
|
* @param {*} [options] Override http request option.
|
|
1404
1705
|
* @throws {RequiredError}
|
|
1405
1706
|
*/
|
|
@@ -1407,14 +1708,14 @@ const QuerySuggestionsApiFactory = function (configuration, basePath, axios) {
|
|
|
1407
1708
|
return localVarFp.v1SuggestionsQueriesGet(xStoreid, xStoresecret, xUserId, xAnonId, xSessionId, query, q, hitsPerPage, page, analyticsTags, tagsMatchMode, includeCategories, includeFacets, includeDropdownRecommendations, includeDropdownProductList, includeFilteredTabs, includeEmptyQueryRecommendations, maxCategories, maxFacets, minPopularity, timeRange, disableTypoTolerance, filteredTabs, userId, anonId, sessionId, options).then((request) => request(axios, basePath));
|
|
1408
1709
|
},
|
|
1409
1710
|
/**
|
|
1410
|
-
* Same as GET
|
|
1411
|
-
* @summary
|
|
1412
|
-
* @param {string} xStoreid Store ID
|
|
1413
|
-
* @param {string} xStoresecret Store
|
|
1414
|
-
* @param {string} [xUserId] User ID for personalization
|
|
1415
|
-
* @param {string} [xAnonId] Anonymous ID for personalization
|
|
1711
|
+
* Same as GET; use POST to send a JSON body (e.g. complex filtered_tabs). **Auth:** `x-storeid` and `x-storesecret`. Optional personalization headers: `x-user-id`, `x-anon-id`, `x-session-id`. Request body can include query, hitsPerPage, analytics_tags, include_categories, include_facets, filtered_tabs, etc.
|
|
1712
|
+
* @summary Get query suggestions (POST)
|
|
1713
|
+
* @param {string} xStoreid Store ID (from dashboard)
|
|
1714
|
+
* @param {string} xStoresecret Store read secret
|
|
1715
|
+
* @param {string} [xUserId] User ID for personalization
|
|
1716
|
+
* @param {string} [xAnonId] Anonymous user ID for personalization
|
|
1416
1717
|
* @param {string} [xSessionId] Session ID for personalization
|
|
1417
|
-
* @param {QuerySuggestionsServiceQuerySuggestionsRequest} [querySuggestionsServiceQuerySuggestionsRequest]
|
|
1718
|
+
* @param {QuerySuggestionsServiceQuerySuggestionsRequest} [querySuggestionsServiceQuerySuggestionsRequest] Request (query, hitsPerPage, analytics_tags, filtered_tabs, etc.)
|
|
1418
1719
|
* @param {*} [options] Override http request option.
|
|
1419
1720
|
* @throws {RequiredError}
|
|
1420
1721
|
*/
|
|
@@ -1429,10 +1730,10 @@ exports.QuerySuggestionsApiFactory = QuerySuggestionsApiFactory;
|
|
|
1429
1730
|
*/
|
|
1430
1731
|
class QuerySuggestionsApi extends base_1.BaseAPI {
|
|
1431
1732
|
/**
|
|
1432
|
-
*
|
|
1433
|
-
* @summary Get
|
|
1434
|
-
* @param {string} xStoreid Store ID
|
|
1435
|
-
* @param {string} xStoresecret Store
|
|
1733
|
+
* Returns limits, supported time ranges, and default values for the query suggestions API. **Auth:** `x-storeid` and `x-storesecret`.
|
|
1734
|
+
* @summary Get suggestions configuration
|
|
1735
|
+
* @param {string} xStoreid Store ID (from dashboard)
|
|
1736
|
+
* @param {string} xStoresecret Store read secret
|
|
1436
1737
|
* @param {*} [options] Override http request option.
|
|
1437
1738
|
* @throws {RequiredError}
|
|
1438
1739
|
*/
|
|
@@ -1440,34 +1741,34 @@ class QuerySuggestionsApi extends base_1.BaseAPI {
|
|
|
1440
1741
|
return (0, exports.QuerySuggestionsApiFp)(this.configuration).v1SuggestionsConfigGet(xStoreid, xStoresecret, options).then((request) => request(this.axios, this.basePath));
|
|
1441
1742
|
}
|
|
1442
1743
|
/**
|
|
1443
|
-
*
|
|
1444
|
-
* @summary Get
|
|
1445
|
-
* @param {string} xStoreid Store ID
|
|
1446
|
-
* @param {string} xStoresecret Store
|
|
1447
|
-
* @param {string} [xUserId] User ID for personalization
|
|
1448
|
-
* @param {string} [xAnonId] Anonymous ID for personalization
|
|
1744
|
+
* Autocomplete suggestions for search, ranked by popularity. **Auth:** `x-storeid` and `x-storesecret` (from dashboard). Optional: `x-user-id`, `x-anon-id`, `x-session-id` for personalization. Supports partial query, filters (analytics_tags), time range (7d/30d/90d), categories, facets, and dropdown recommendations. Use `query` or `q` for the partial search string.
|
|
1745
|
+
* @summary Get query suggestions (GET)
|
|
1746
|
+
* @param {string} xStoreid Store ID (from dashboard)
|
|
1747
|
+
* @param {string} xStoresecret Store read secret
|
|
1748
|
+
* @param {string} [xUserId] User ID for personalization
|
|
1749
|
+
* @param {string} [xAnonId] Anonymous user ID for personalization
|
|
1449
1750
|
* @param {string} [xSessionId] Session ID for personalization
|
|
1450
|
-
* @param {string} [query] Partial query
|
|
1451
|
-
* @param {string} [q] Alias for
|
|
1452
|
-
* @param {number} [hitsPerPage]
|
|
1453
|
-
* @param {number} [page] Page
|
|
1454
|
-
* @param {string} [analyticsTags] Comma-separated
|
|
1455
|
-
* @param {V1SuggestionsQueriesGetTagsMatchModeEnum} [tagsMatchMode]
|
|
1456
|
-
* @param {boolean} [includeCategories] Include category
|
|
1457
|
-
* @param {boolean} [includeFacets] Include
|
|
1458
|
-
* @param {boolean} [includeDropdownRecommendations] Include
|
|
1459
|
-
* @param {boolean} [includeDropdownProductList] Include product list in dropdown
|
|
1460
|
-
* @param {boolean} [includeFilteredTabs] Include filtered tabs
|
|
1461
|
-
* @param {boolean} [includeEmptyQueryRecommendations]
|
|
1462
|
-
* @param {number} [maxCategories]
|
|
1463
|
-
* @param {number} [maxFacets]
|
|
1464
|
-
* @param {number} [minPopularity]
|
|
1465
|
-
* @param {V1SuggestionsQueriesGetTimeRangeEnum} [timeRange]
|
|
1466
|
-
* @param {boolean} [disableTypoTolerance] Disable fuzzy
|
|
1467
|
-
* @param {string} [filteredTabs] URL-encoded JSON array of
|
|
1468
|
-
* @param {string} [userId] User ID
|
|
1469
|
-
* @param {string} [anonId] Anonymous ID
|
|
1470
|
-
* @param {string} [sessionId] Session ID
|
|
1751
|
+
* @param {string} [query] Partial query (use \'query\' or \'q\')
|
|
1752
|
+
* @param {string} [q] Alias for query
|
|
1753
|
+
* @param {number} [hitsPerPage] Suggestions to return
|
|
1754
|
+
* @param {number} [page] Page for pagination
|
|
1755
|
+
* @param {string} [analyticsTags] Comma-separated tags to filter
|
|
1756
|
+
* @param {V1SuggestionsQueriesGetTagsMatchModeEnum} [tagsMatchMode] Match mode for tags
|
|
1757
|
+
* @param {boolean} [includeCategories] Include category in suggestions
|
|
1758
|
+
* @param {boolean} [includeFacets] Include facet info
|
|
1759
|
+
* @param {boolean} [includeDropdownRecommendations] Include dropdown recommendations
|
|
1760
|
+
* @param {boolean} [includeDropdownProductList] Include product list in dropdown
|
|
1761
|
+
* @param {boolean} [includeFilteredTabs] Include filtered tabs
|
|
1762
|
+
* @param {boolean} [includeEmptyQueryRecommendations] Popular suggestions when query empty
|
|
1763
|
+
* @param {number} [maxCategories] Max categories per suggestion
|
|
1764
|
+
* @param {number} [maxFacets] Max facets per suggestion
|
|
1765
|
+
* @param {number} [minPopularity] Min popularity
|
|
1766
|
+
* @param {V1SuggestionsQueriesGetTimeRangeEnum} [timeRange] Data time range
|
|
1767
|
+
* @param {boolean} [disableTypoTolerance] Disable fuzzy matching
|
|
1768
|
+
* @param {string} [filteredTabs] URL-encoded JSON array of tab configs
|
|
1769
|
+
* @param {string} [userId] User ID (fallback if header not set)
|
|
1770
|
+
* @param {string} [anonId] Anonymous ID (fallback)
|
|
1771
|
+
* @param {string} [sessionId] Session ID (fallback)
|
|
1471
1772
|
* @param {*} [options] Override http request option.
|
|
1472
1773
|
* @throws {RequiredError}
|
|
1473
1774
|
*/
|
|
@@ -1475,14 +1776,14 @@ class QuerySuggestionsApi extends base_1.BaseAPI {
|
|
|
1475
1776
|
return (0, exports.QuerySuggestionsApiFp)(this.configuration).v1SuggestionsQueriesGet(xStoreid, xStoresecret, xUserId, xAnonId, xSessionId, query, q, hitsPerPage, page, analyticsTags, tagsMatchMode, includeCategories, includeFacets, includeDropdownRecommendations, includeDropdownProductList, includeFilteredTabs, includeEmptyQueryRecommendations, maxCategories, maxFacets, minPopularity, timeRange, disableTypoTolerance, filteredTabs, userId, anonId, sessionId, options).then((request) => request(this.axios, this.basePath));
|
|
1476
1777
|
}
|
|
1477
1778
|
/**
|
|
1478
|
-
* Same as GET
|
|
1479
|
-
* @summary
|
|
1480
|
-
* @param {string} xStoreid Store ID
|
|
1481
|
-
* @param {string} xStoresecret Store
|
|
1482
|
-
* @param {string} [xUserId] User ID for personalization
|
|
1483
|
-
* @param {string} [xAnonId] Anonymous ID for personalization
|
|
1779
|
+
* Same as GET; use POST to send a JSON body (e.g. complex filtered_tabs). **Auth:** `x-storeid` and `x-storesecret`. Optional personalization headers: `x-user-id`, `x-anon-id`, `x-session-id`. Request body can include query, hitsPerPage, analytics_tags, include_categories, include_facets, filtered_tabs, etc.
|
|
1780
|
+
* @summary Get query suggestions (POST)
|
|
1781
|
+
* @param {string} xStoreid Store ID (from dashboard)
|
|
1782
|
+
* @param {string} xStoresecret Store read secret
|
|
1783
|
+
* @param {string} [xUserId] User ID for personalization
|
|
1784
|
+
* @param {string} [xAnonId] Anonymous user ID for personalization
|
|
1484
1785
|
* @param {string} [xSessionId] Session ID for personalization
|
|
1485
|
-
* @param {QuerySuggestionsServiceQuerySuggestionsRequest} [querySuggestionsServiceQuerySuggestionsRequest]
|
|
1786
|
+
* @param {QuerySuggestionsServiceQuerySuggestionsRequest} [querySuggestionsServiceQuerySuggestionsRequest] Request (query, hitsPerPage, analytics_tags, filtered_tabs, etc.)
|
|
1486
1787
|
* @param {*} [options] Override http request option.
|
|
1487
1788
|
* @throws {RequiredError}
|
|
1488
1789
|
*/
|
|
@@ -1506,12 +1807,12 @@ exports.V1SuggestionsQueriesGetTimeRangeEnum = {
|
|
|
1506
1807
|
const SDKDocumentsApiAxiosParamCreator = function (configuration) {
|
|
1507
1808
|
return {
|
|
1508
1809
|
/**
|
|
1509
|
-
*
|
|
1510
|
-
* @summary Bulk index documents
|
|
1511
|
-
* @param {string} xStoreid Store ID
|
|
1512
|
-
* @param {string} xStoreWriteSecret Store
|
|
1513
|
-
* @param {string} xStoreID
|
|
1514
|
-
* @param {DataTypesBulkDocumentRequest} dataTypesBulkDocumentRequest
|
|
1810
|
+
* Run multiple document operations in one request (insert, update, upsert, delete). **Auth:** `x-storeid` and `x-store-write-secret`. Path `xStoreID` must match the `x-storeid` header. Each item can specify its own action.
|
|
1811
|
+
* @summary Bulk index documents
|
|
1812
|
+
* @param {string} xStoreid Store ID (from dashboard)
|
|
1813
|
+
* @param {string} xStoreWriteSecret Store write secret
|
|
1814
|
+
* @param {string} xStoreID Store ID (must match x-storeid header)
|
|
1815
|
+
* @param {DataTypesBulkDocumentRequest} dataTypesBulkDocumentRequest List of operations
|
|
1515
1816
|
* @param {*} [options] Override http request option.
|
|
1516
1817
|
* @throws {RequiredError}
|
|
1517
1818
|
*/
|
|
@@ -1535,6 +1836,8 @@ const SDKDocumentsApiAxiosParamCreator = function (configuration) {
|
|
|
1535
1836
|
const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options };
|
|
1536
1837
|
const localVarHeaderParameter = {};
|
|
1537
1838
|
const localVarQueryParameter = {};
|
|
1839
|
+
// authentication ApiKeyAuth required
|
|
1840
|
+
await (0, common_1.setApiKeyToObject)(localVarHeaderParameter, "x-storesecret", configuration);
|
|
1538
1841
|
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
1539
1842
|
localVarHeaderParameter['Accept'] = 'application/json';
|
|
1540
1843
|
if (xStoreid != null) {
|
|
@@ -1553,11 +1856,11 @@ const SDKDocumentsApiAxiosParamCreator = function (configuration) {
|
|
|
1553
1856
|
};
|
|
1554
1857
|
},
|
|
1555
1858
|
/**
|
|
1556
|
-
*
|
|
1557
|
-
* @summary Delete a document
|
|
1558
|
-
* @param {string} xStoreid Store ID
|
|
1559
|
-
* @param {string} xStoreWriteSecret Store
|
|
1560
|
-
* @param {string} xStoreID
|
|
1859
|
+
* Remove a document from the store\'s search index by ID. **Auth:** `x-storeid` and `x-store-write-secret`. Path `xStoreID` must match the `x-storeid` header.
|
|
1860
|
+
* @summary Delete a document
|
|
1861
|
+
* @param {string} xStoreid Store ID (from dashboard)
|
|
1862
|
+
* @param {string} xStoreWriteSecret Store write secret
|
|
1863
|
+
* @param {string} xStoreID Store ID (must match x-storeid header)
|
|
1561
1864
|
* @param {string} documentID Document ID to delete
|
|
1562
1865
|
* @param {*} [options] Override http request option.
|
|
1563
1866
|
* @throws {RequiredError}
|
|
@@ -1583,6 +1886,8 @@ const SDKDocumentsApiAxiosParamCreator = function (configuration) {
|
|
|
1583
1886
|
const localVarRequestOptions = { method: 'DELETE', ...baseOptions, ...options };
|
|
1584
1887
|
const localVarHeaderParameter = {};
|
|
1585
1888
|
const localVarQueryParameter = {};
|
|
1889
|
+
// authentication ApiKeyAuth required
|
|
1890
|
+
await (0, common_1.setApiKeyToObject)(localVarHeaderParameter, "x-storesecret", configuration);
|
|
1586
1891
|
localVarHeaderParameter['Accept'] = 'application/json';
|
|
1587
1892
|
if (xStoreid != null) {
|
|
1588
1893
|
localVarHeaderParameter['x-storeid'] = String(xStoreid);
|
|
@@ -1599,12 +1904,60 @@ const SDKDocumentsApiAxiosParamCreator = function (configuration) {
|
|
|
1599
1904
|
};
|
|
1600
1905
|
},
|
|
1601
1906
|
/**
|
|
1602
|
-
*
|
|
1603
|
-
* @summary
|
|
1604
|
-
* @param {string} xStoreid Store ID
|
|
1605
|
-
* @param {string}
|
|
1606
|
-
* @param {string} xStoreID
|
|
1607
|
-
* @param {
|
|
1907
|
+
* Retrieve a single document from the store\'s search index by ID. **Auth:** `x-storeid` and `x-storesecret` (read secret). Path `xStoreID` must match the `x-storeid` header. Used by product pages and PDP.
|
|
1908
|
+
* @summary Get a document by ID
|
|
1909
|
+
* @param {string} xStoreid Store ID (from dashboard)
|
|
1910
|
+
* @param {string} xStoresecret Store read secret
|
|
1911
|
+
* @param {string} xStoreID Store ID (must match x-storeid header)
|
|
1912
|
+
* @param {string} documentID Document ID to retrieve
|
|
1913
|
+
* @param {*} [options] Override http request option.
|
|
1914
|
+
* @throws {RequiredError}
|
|
1915
|
+
*/
|
|
1916
|
+
apiV1StoresXStoreIDDocumentsDocumentIDGet: async (xStoreid, xStoresecret, xStoreID, documentID, options = {}) => {
|
|
1917
|
+
// verify required parameter 'xStoreid' is not null or undefined
|
|
1918
|
+
(0, common_1.assertParamExists)('apiV1StoresXStoreIDDocumentsDocumentIDGet', 'xStoreid', xStoreid);
|
|
1919
|
+
// verify required parameter 'xStoresecret' is not null or undefined
|
|
1920
|
+
(0, common_1.assertParamExists)('apiV1StoresXStoreIDDocumentsDocumentIDGet', 'xStoresecret', xStoresecret);
|
|
1921
|
+
// verify required parameter 'xStoreID' is not null or undefined
|
|
1922
|
+
(0, common_1.assertParamExists)('apiV1StoresXStoreIDDocumentsDocumentIDGet', 'xStoreID', xStoreID);
|
|
1923
|
+
// verify required parameter 'documentID' is not null or undefined
|
|
1924
|
+
(0, common_1.assertParamExists)('apiV1StoresXStoreIDDocumentsDocumentIDGet', 'documentID', documentID);
|
|
1925
|
+
const localVarPath = `/api/v1/stores/{xStoreID}/documents/{documentID}`
|
|
1926
|
+
.replace(`{${"xStoreID"}}`, encodeURIComponent(String(xStoreID)))
|
|
1927
|
+
.replace(`{${"documentID"}}`, encodeURIComponent(String(documentID)));
|
|
1928
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
1929
|
+
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
1930
|
+
let baseOptions;
|
|
1931
|
+
if (configuration) {
|
|
1932
|
+
baseOptions = configuration.baseOptions;
|
|
1933
|
+
}
|
|
1934
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options };
|
|
1935
|
+
const localVarHeaderParameter = {};
|
|
1936
|
+
const localVarQueryParameter = {};
|
|
1937
|
+
// authentication ApiKeyAuth required
|
|
1938
|
+
await (0, common_1.setApiKeyToObject)(localVarHeaderParameter, "x-storesecret", configuration);
|
|
1939
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
1940
|
+
if (xStoreid != null) {
|
|
1941
|
+
localVarHeaderParameter['x-storeid'] = String(xStoreid);
|
|
1942
|
+
}
|
|
1943
|
+
if (xStoresecret != null) {
|
|
1944
|
+
localVarHeaderParameter['x-storesecret'] = String(xStoresecret);
|
|
1945
|
+
}
|
|
1946
|
+
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
1947
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
1948
|
+
localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
|
|
1949
|
+
return {
|
|
1950
|
+
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
1951
|
+
options: localVarRequestOptions,
|
|
1952
|
+
};
|
|
1953
|
+
},
|
|
1954
|
+
/**
|
|
1955
|
+
* Add or update one document in the store\'s search index. **Auth:** `x-storeid` and `x-store-write-secret`. Path `xStoreID` must match the `x-storeid` header. If you omit document ID, one is generated; existing documents with the same ID are updated.
|
|
1956
|
+
* @summary Index a single document
|
|
1957
|
+
* @param {string} xStoreid Store ID (from dashboard)
|
|
1958
|
+
* @param {string} xStoreWriteSecret Store write secret
|
|
1959
|
+
* @param {string} xStoreID Store ID (must match x-storeid header)
|
|
1960
|
+
* @param {DataTypesDocumentRequest} dataTypesDocumentRequest Document fields to index
|
|
1608
1961
|
* @param {*} [options] Override http request option.
|
|
1609
1962
|
* @throws {RequiredError}
|
|
1610
1963
|
*/
|
|
@@ -1628,6 +1981,8 @@ const SDKDocumentsApiAxiosParamCreator = function (configuration) {
|
|
|
1628
1981
|
const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options };
|
|
1629
1982
|
const localVarHeaderParameter = {};
|
|
1630
1983
|
const localVarQueryParameter = {};
|
|
1984
|
+
// authentication ApiKeyAuth required
|
|
1985
|
+
await (0, common_1.setApiKeyToObject)(localVarHeaderParameter, "x-storesecret", configuration);
|
|
1631
1986
|
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
1632
1987
|
localVarHeaderParameter['Accept'] = 'application/json';
|
|
1633
1988
|
if (xStoreid != null) {
|
|
@@ -1655,12 +2010,12 @@ const SDKDocumentsApiFp = function (configuration) {
|
|
|
1655
2010
|
const localVarAxiosParamCreator = (0, exports.SDKDocumentsApiAxiosParamCreator)(configuration);
|
|
1656
2011
|
return {
|
|
1657
2012
|
/**
|
|
1658
|
-
*
|
|
1659
|
-
* @summary Bulk index documents
|
|
1660
|
-
* @param {string} xStoreid Store ID
|
|
1661
|
-
* @param {string} xStoreWriteSecret Store
|
|
1662
|
-
* @param {string} xStoreID
|
|
1663
|
-
* @param {DataTypesBulkDocumentRequest} dataTypesBulkDocumentRequest
|
|
2013
|
+
* Run multiple document operations in one request (insert, update, upsert, delete). **Auth:** `x-storeid` and `x-store-write-secret`. Path `xStoreID` must match the `x-storeid` header. Each item can specify its own action.
|
|
2014
|
+
* @summary Bulk index documents
|
|
2015
|
+
* @param {string} xStoreid Store ID (from dashboard)
|
|
2016
|
+
* @param {string} xStoreWriteSecret Store write secret
|
|
2017
|
+
* @param {string} xStoreID Store ID (must match x-storeid header)
|
|
2018
|
+
* @param {DataTypesBulkDocumentRequest} dataTypesBulkDocumentRequest List of operations
|
|
1664
2019
|
* @param {*} [options] Override http request option.
|
|
1665
2020
|
* @throws {RequiredError}
|
|
1666
2021
|
*/
|
|
@@ -1671,11 +2026,11 @@ const SDKDocumentsApiFp = function (configuration) {
|
|
|
1671
2026
|
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
1672
2027
|
},
|
|
1673
2028
|
/**
|
|
1674
|
-
*
|
|
1675
|
-
* @summary Delete a document
|
|
1676
|
-
* @param {string} xStoreid Store ID
|
|
1677
|
-
* @param {string} xStoreWriteSecret Store
|
|
1678
|
-
* @param {string} xStoreID
|
|
2029
|
+
* Remove a document from the store\'s search index by ID. **Auth:** `x-storeid` and `x-store-write-secret`. Path `xStoreID` must match the `x-storeid` header.
|
|
2030
|
+
* @summary Delete a document
|
|
2031
|
+
* @param {string} xStoreid Store ID (from dashboard)
|
|
2032
|
+
* @param {string} xStoreWriteSecret Store write secret
|
|
2033
|
+
* @param {string} xStoreID Store ID (must match x-storeid header)
|
|
1679
2034
|
* @param {string} documentID Document ID to delete
|
|
1680
2035
|
* @param {*} [options] Override http request option.
|
|
1681
2036
|
* @throws {RequiredError}
|
|
@@ -1687,12 +2042,28 @@ const SDKDocumentsApiFp = function (configuration) {
|
|
|
1687
2042
|
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
1688
2043
|
},
|
|
1689
2044
|
/**
|
|
1690
|
-
*
|
|
1691
|
-
* @summary
|
|
1692
|
-
* @param {string} xStoreid Store ID
|
|
1693
|
-
* @param {string}
|
|
1694
|
-
* @param {string} xStoreID
|
|
1695
|
-
* @param {
|
|
2045
|
+
* Retrieve a single document from the store\'s search index by ID. **Auth:** `x-storeid` and `x-storesecret` (read secret). Path `xStoreID` must match the `x-storeid` header. Used by product pages and PDP.
|
|
2046
|
+
* @summary Get a document by ID
|
|
2047
|
+
* @param {string} xStoreid Store ID (from dashboard)
|
|
2048
|
+
* @param {string} xStoresecret Store read secret
|
|
2049
|
+
* @param {string} xStoreID Store ID (must match x-storeid header)
|
|
2050
|
+
* @param {string} documentID Document ID to retrieve
|
|
2051
|
+
* @param {*} [options] Override http request option.
|
|
2052
|
+
* @throws {RequiredError}
|
|
2053
|
+
*/
|
|
2054
|
+
async apiV1StoresXStoreIDDocumentsDocumentIDGet(xStoreid, xStoresecret, xStoreID, documentID, options) {
|
|
2055
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.apiV1StoresXStoreIDDocumentsDocumentIDGet(xStoreid, xStoresecret, xStoreID, documentID, options);
|
|
2056
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
2057
|
+
const localVarOperationServerBasePath = base_1.operationServerMap['SDKDocumentsApi.apiV1StoresXStoreIDDocumentsDocumentIDGet']?.[localVarOperationServerIndex]?.url;
|
|
2058
|
+
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
2059
|
+
},
|
|
2060
|
+
/**
|
|
2061
|
+
* Add or update one document in the store\'s search index. **Auth:** `x-storeid` and `x-store-write-secret`. Path `xStoreID` must match the `x-storeid` header. If you omit document ID, one is generated; existing documents with the same ID are updated.
|
|
2062
|
+
* @summary Index a single document
|
|
2063
|
+
* @param {string} xStoreid Store ID (from dashboard)
|
|
2064
|
+
* @param {string} xStoreWriteSecret Store write secret
|
|
2065
|
+
* @param {string} xStoreID Store ID (must match x-storeid header)
|
|
2066
|
+
* @param {DataTypesDocumentRequest} dataTypesDocumentRequest Document fields to index
|
|
1696
2067
|
* @param {*} [options] Override http request option.
|
|
1697
2068
|
* @throws {RequiredError}
|
|
1698
2069
|
*/
|
|
@@ -1712,12 +2083,12 @@ const SDKDocumentsApiFactory = function (configuration, basePath, axios) {
|
|
|
1712
2083
|
const localVarFp = (0, exports.SDKDocumentsApiFp)(configuration);
|
|
1713
2084
|
return {
|
|
1714
2085
|
/**
|
|
1715
|
-
*
|
|
1716
|
-
* @summary Bulk index documents
|
|
1717
|
-
* @param {string} xStoreid Store ID
|
|
1718
|
-
* @param {string} xStoreWriteSecret Store
|
|
1719
|
-
* @param {string} xStoreID
|
|
1720
|
-
* @param {DataTypesBulkDocumentRequest} dataTypesBulkDocumentRequest
|
|
2086
|
+
* Run multiple document operations in one request (insert, update, upsert, delete). **Auth:** `x-storeid` and `x-store-write-secret`. Path `xStoreID` must match the `x-storeid` header. Each item can specify its own action.
|
|
2087
|
+
* @summary Bulk index documents
|
|
2088
|
+
* @param {string} xStoreid Store ID (from dashboard)
|
|
2089
|
+
* @param {string} xStoreWriteSecret Store write secret
|
|
2090
|
+
* @param {string} xStoreID Store ID (must match x-storeid header)
|
|
2091
|
+
* @param {DataTypesBulkDocumentRequest} dataTypesBulkDocumentRequest List of operations
|
|
1721
2092
|
* @param {*} [options] Override http request option.
|
|
1722
2093
|
* @throws {RequiredError}
|
|
1723
2094
|
*/
|
|
@@ -1725,11 +2096,11 @@ const SDKDocumentsApiFactory = function (configuration, basePath, axios) {
|
|
|
1725
2096
|
return localVarFp.apiV1StoresXStoreIDDocumentsBulkPost(xStoreid, xStoreWriteSecret, xStoreID, dataTypesBulkDocumentRequest, options).then((request) => request(axios, basePath));
|
|
1726
2097
|
},
|
|
1727
2098
|
/**
|
|
1728
|
-
*
|
|
1729
|
-
* @summary Delete a document
|
|
1730
|
-
* @param {string} xStoreid Store ID
|
|
1731
|
-
* @param {string} xStoreWriteSecret Store
|
|
1732
|
-
* @param {string} xStoreID
|
|
2099
|
+
* Remove a document from the store\'s search index by ID. **Auth:** `x-storeid` and `x-store-write-secret`. Path `xStoreID` must match the `x-storeid` header.
|
|
2100
|
+
* @summary Delete a document
|
|
2101
|
+
* @param {string} xStoreid Store ID (from dashboard)
|
|
2102
|
+
* @param {string} xStoreWriteSecret Store write secret
|
|
2103
|
+
* @param {string} xStoreID Store ID (must match x-storeid header)
|
|
1733
2104
|
* @param {string} documentID Document ID to delete
|
|
1734
2105
|
* @param {*} [options] Override http request option.
|
|
1735
2106
|
* @throws {RequiredError}
|
|
@@ -1738,12 +2109,25 @@ const SDKDocumentsApiFactory = function (configuration, basePath, axios) {
|
|
|
1738
2109
|
return localVarFp.apiV1StoresXStoreIDDocumentsDocumentIDDelete(xStoreid, xStoreWriteSecret, xStoreID, documentID, options).then((request) => request(axios, basePath));
|
|
1739
2110
|
},
|
|
1740
2111
|
/**
|
|
1741
|
-
*
|
|
1742
|
-
* @summary
|
|
1743
|
-
* @param {string} xStoreid Store ID
|
|
1744
|
-
* @param {string}
|
|
1745
|
-
* @param {string} xStoreID
|
|
1746
|
-
* @param {
|
|
2112
|
+
* Retrieve a single document from the store\'s search index by ID. **Auth:** `x-storeid` and `x-storesecret` (read secret). Path `xStoreID` must match the `x-storeid` header. Used by product pages and PDP.
|
|
2113
|
+
* @summary Get a document by ID
|
|
2114
|
+
* @param {string} xStoreid Store ID (from dashboard)
|
|
2115
|
+
* @param {string} xStoresecret Store read secret
|
|
2116
|
+
* @param {string} xStoreID Store ID (must match x-storeid header)
|
|
2117
|
+
* @param {string} documentID Document ID to retrieve
|
|
2118
|
+
* @param {*} [options] Override http request option.
|
|
2119
|
+
* @throws {RequiredError}
|
|
2120
|
+
*/
|
|
2121
|
+
apiV1StoresXStoreIDDocumentsDocumentIDGet(xStoreid, xStoresecret, xStoreID, documentID, options) {
|
|
2122
|
+
return localVarFp.apiV1StoresXStoreIDDocumentsDocumentIDGet(xStoreid, xStoresecret, xStoreID, documentID, options).then((request) => request(axios, basePath));
|
|
2123
|
+
},
|
|
2124
|
+
/**
|
|
2125
|
+
* Add or update one document in the store\'s search index. **Auth:** `x-storeid` and `x-store-write-secret`. Path `xStoreID` must match the `x-storeid` header. If you omit document ID, one is generated; existing documents with the same ID are updated.
|
|
2126
|
+
* @summary Index a single document
|
|
2127
|
+
* @param {string} xStoreid Store ID (from dashboard)
|
|
2128
|
+
* @param {string} xStoreWriteSecret Store write secret
|
|
2129
|
+
* @param {string} xStoreID Store ID (must match x-storeid header)
|
|
2130
|
+
* @param {DataTypesDocumentRequest} dataTypesDocumentRequest Document fields to index
|
|
1747
2131
|
* @param {*} [options] Override http request option.
|
|
1748
2132
|
* @throws {RequiredError}
|
|
1749
2133
|
*/
|
|
@@ -1758,12 +2142,12 @@ exports.SDKDocumentsApiFactory = SDKDocumentsApiFactory;
|
|
|
1758
2142
|
*/
|
|
1759
2143
|
class SDKDocumentsApi extends base_1.BaseAPI {
|
|
1760
2144
|
/**
|
|
1761
|
-
*
|
|
1762
|
-
* @summary Bulk index documents
|
|
1763
|
-
* @param {string} xStoreid Store ID
|
|
1764
|
-
* @param {string} xStoreWriteSecret Store
|
|
1765
|
-
* @param {string} xStoreID
|
|
1766
|
-
* @param {DataTypesBulkDocumentRequest} dataTypesBulkDocumentRequest
|
|
2145
|
+
* Run multiple document operations in one request (insert, update, upsert, delete). **Auth:** `x-storeid` and `x-store-write-secret`. Path `xStoreID` must match the `x-storeid` header. Each item can specify its own action.
|
|
2146
|
+
* @summary Bulk index documents
|
|
2147
|
+
* @param {string} xStoreid Store ID (from dashboard)
|
|
2148
|
+
* @param {string} xStoreWriteSecret Store write secret
|
|
2149
|
+
* @param {string} xStoreID Store ID (must match x-storeid header)
|
|
2150
|
+
* @param {DataTypesBulkDocumentRequest} dataTypesBulkDocumentRequest List of operations
|
|
1767
2151
|
* @param {*} [options] Override http request option.
|
|
1768
2152
|
* @throws {RequiredError}
|
|
1769
2153
|
*/
|
|
@@ -1771,11 +2155,11 @@ class SDKDocumentsApi extends base_1.BaseAPI {
|
|
|
1771
2155
|
return (0, exports.SDKDocumentsApiFp)(this.configuration).apiV1StoresXStoreIDDocumentsBulkPost(xStoreid, xStoreWriteSecret, xStoreID, dataTypesBulkDocumentRequest, options).then((request) => request(this.axios, this.basePath));
|
|
1772
2156
|
}
|
|
1773
2157
|
/**
|
|
1774
|
-
*
|
|
1775
|
-
* @summary Delete a document
|
|
1776
|
-
* @param {string} xStoreid Store ID
|
|
1777
|
-
* @param {string} xStoreWriteSecret Store
|
|
1778
|
-
* @param {string} xStoreID
|
|
2158
|
+
* Remove a document from the store\'s search index by ID. **Auth:** `x-storeid` and `x-store-write-secret`. Path `xStoreID` must match the `x-storeid` header.
|
|
2159
|
+
* @summary Delete a document
|
|
2160
|
+
* @param {string} xStoreid Store ID (from dashboard)
|
|
2161
|
+
* @param {string} xStoreWriteSecret Store write secret
|
|
2162
|
+
* @param {string} xStoreID Store ID (must match x-storeid header)
|
|
1779
2163
|
* @param {string} documentID Document ID to delete
|
|
1780
2164
|
* @param {*} [options] Override http request option.
|
|
1781
2165
|
* @throws {RequiredError}
|
|
@@ -1784,12 +2168,25 @@ class SDKDocumentsApi extends base_1.BaseAPI {
|
|
|
1784
2168
|
return (0, exports.SDKDocumentsApiFp)(this.configuration).apiV1StoresXStoreIDDocumentsDocumentIDDelete(xStoreid, xStoreWriteSecret, xStoreID, documentID, options).then((request) => request(this.axios, this.basePath));
|
|
1785
2169
|
}
|
|
1786
2170
|
/**
|
|
1787
|
-
*
|
|
1788
|
-
* @summary
|
|
1789
|
-
* @param {string} xStoreid Store ID
|
|
1790
|
-
* @param {string}
|
|
1791
|
-
* @param {string} xStoreID
|
|
1792
|
-
* @param {
|
|
2171
|
+
* Retrieve a single document from the store\'s search index by ID. **Auth:** `x-storeid` and `x-storesecret` (read secret). Path `xStoreID` must match the `x-storeid` header. Used by product pages and PDP.
|
|
2172
|
+
* @summary Get a document by ID
|
|
2173
|
+
* @param {string} xStoreid Store ID (from dashboard)
|
|
2174
|
+
* @param {string} xStoresecret Store read secret
|
|
2175
|
+
* @param {string} xStoreID Store ID (must match x-storeid header)
|
|
2176
|
+
* @param {string} documentID Document ID to retrieve
|
|
2177
|
+
* @param {*} [options] Override http request option.
|
|
2178
|
+
* @throws {RequiredError}
|
|
2179
|
+
*/
|
|
2180
|
+
apiV1StoresXStoreIDDocumentsDocumentIDGet(xStoreid, xStoresecret, xStoreID, documentID, options) {
|
|
2181
|
+
return (0, exports.SDKDocumentsApiFp)(this.configuration).apiV1StoresXStoreIDDocumentsDocumentIDGet(xStoreid, xStoresecret, xStoreID, documentID, options).then((request) => request(this.axios, this.basePath));
|
|
2182
|
+
}
|
|
2183
|
+
/**
|
|
2184
|
+
* Add or update one document in the store\'s search index. **Auth:** `x-storeid` and `x-store-write-secret`. Path `xStoreID` must match the `x-storeid` header. If you omit document ID, one is generated; existing documents with the same ID are updated.
|
|
2185
|
+
* @summary Index a single document
|
|
2186
|
+
* @param {string} xStoreid Store ID (from dashboard)
|
|
2187
|
+
* @param {string} xStoreWriteSecret Store write secret
|
|
2188
|
+
* @param {string} xStoreID Store ID (must match x-storeid header)
|
|
2189
|
+
* @param {DataTypesDocumentRequest} dataTypesDocumentRequest Document fields to index
|
|
1793
2190
|
* @param {*} [options] Override http request option.
|
|
1794
2191
|
* @throws {RequiredError}
|
|
1795
2192
|
*/
|
|
@@ -1798,17 +2195,139 @@ class SDKDocumentsApi extends base_1.BaseAPI {
|
|
|
1798
2195
|
}
|
|
1799
2196
|
}
|
|
1800
2197
|
exports.SDKDocumentsApi = SDKDocumentsApi;
|
|
2198
|
+
/**
|
|
2199
|
+
* SDKExperimentsApi - axios parameter creator
|
|
2200
|
+
*/
|
|
2201
|
+
const SDKExperimentsApiAxiosParamCreator = function (configuration) {
|
|
2202
|
+
return {
|
|
2203
|
+
/**
|
|
2204
|
+
* Returns variant assignments for all running experiments for the requesting user. Uses hash-based consistent assignment.
|
|
2205
|
+
* @summary Get experiment assignments for a user
|
|
2206
|
+
* @param {string} xStoreid Store ID
|
|
2207
|
+
* @param {string} xStoresecret Store read secret
|
|
2208
|
+
* @param {string} [xUserId] User ID (provide either x-user-id or x-anon-id)
|
|
2209
|
+
* @param {string} [xAnonId] Anonymous ID (provide either x-user-id or x-anon-id)
|
|
2210
|
+
* @param {*} [options] Override http request option.
|
|
2211
|
+
* @throws {RequiredError}
|
|
2212
|
+
*/
|
|
2213
|
+
v1ExperimentsAssignmentGet: async (xStoreid, xStoresecret, xUserId, xAnonId, options = {}) => {
|
|
2214
|
+
// verify required parameter 'xStoreid' is not null or undefined
|
|
2215
|
+
(0, common_1.assertParamExists)('v1ExperimentsAssignmentGet', 'xStoreid', xStoreid);
|
|
2216
|
+
// verify required parameter 'xStoresecret' is not null or undefined
|
|
2217
|
+
(0, common_1.assertParamExists)('v1ExperimentsAssignmentGet', 'xStoresecret', xStoresecret);
|
|
2218
|
+
const localVarPath = `/v1/experiments/assignment`;
|
|
2219
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
2220
|
+
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
2221
|
+
let baseOptions;
|
|
2222
|
+
if (configuration) {
|
|
2223
|
+
baseOptions = configuration.baseOptions;
|
|
2224
|
+
}
|
|
2225
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options };
|
|
2226
|
+
const localVarHeaderParameter = {};
|
|
2227
|
+
const localVarQueryParameter = {};
|
|
2228
|
+
// authentication ApiKeyAuth required
|
|
2229
|
+
await (0, common_1.setApiKeyToObject)(localVarHeaderParameter, "x-storesecret", configuration);
|
|
2230
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
2231
|
+
if (xStoreid != null) {
|
|
2232
|
+
localVarHeaderParameter['x-storeid'] = String(xStoreid);
|
|
2233
|
+
}
|
|
2234
|
+
if (xStoresecret != null) {
|
|
2235
|
+
localVarHeaderParameter['x-storesecret'] = String(xStoresecret);
|
|
2236
|
+
}
|
|
2237
|
+
if (xUserId != null) {
|
|
2238
|
+
localVarHeaderParameter['x-user-id'] = String(xUserId);
|
|
2239
|
+
}
|
|
2240
|
+
if (xAnonId != null) {
|
|
2241
|
+
localVarHeaderParameter['x-anon-id'] = String(xAnonId);
|
|
2242
|
+
}
|
|
2243
|
+
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
2244
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
2245
|
+
localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
|
|
2246
|
+
return {
|
|
2247
|
+
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
2248
|
+
options: localVarRequestOptions,
|
|
2249
|
+
};
|
|
2250
|
+
},
|
|
2251
|
+
};
|
|
2252
|
+
};
|
|
2253
|
+
exports.SDKExperimentsApiAxiosParamCreator = SDKExperimentsApiAxiosParamCreator;
|
|
2254
|
+
/**
|
|
2255
|
+
* SDKExperimentsApi - functional programming interface
|
|
2256
|
+
*/
|
|
2257
|
+
const SDKExperimentsApiFp = function (configuration) {
|
|
2258
|
+
const localVarAxiosParamCreator = (0, exports.SDKExperimentsApiAxiosParamCreator)(configuration);
|
|
2259
|
+
return {
|
|
2260
|
+
/**
|
|
2261
|
+
* Returns variant assignments for all running experiments for the requesting user. Uses hash-based consistent assignment.
|
|
2262
|
+
* @summary Get experiment assignments for a user
|
|
2263
|
+
* @param {string} xStoreid Store ID
|
|
2264
|
+
* @param {string} xStoresecret Store read secret
|
|
2265
|
+
* @param {string} [xUserId] User ID (provide either x-user-id or x-anon-id)
|
|
2266
|
+
* @param {string} [xAnonId] Anonymous ID (provide either x-user-id or x-anon-id)
|
|
2267
|
+
* @param {*} [options] Override http request option.
|
|
2268
|
+
* @throws {RequiredError}
|
|
2269
|
+
*/
|
|
2270
|
+
async v1ExperimentsAssignmentGet(xStoreid, xStoresecret, xUserId, xAnonId, options) {
|
|
2271
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.v1ExperimentsAssignmentGet(xStoreid, xStoresecret, xUserId, xAnonId, options);
|
|
2272
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
2273
|
+
const localVarOperationServerBasePath = base_1.operationServerMap['SDKExperimentsApi.v1ExperimentsAssignmentGet']?.[localVarOperationServerIndex]?.url;
|
|
2274
|
+
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
2275
|
+
},
|
|
2276
|
+
};
|
|
2277
|
+
};
|
|
2278
|
+
exports.SDKExperimentsApiFp = SDKExperimentsApiFp;
|
|
2279
|
+
/**
|
|
2280
|
+
* SDKExperimentsApi - factory interface
|
|
2281
|
+
*/
|
|
2282
|
+
const SDKExperimentsApiFactory = function (configuration, basePath, axios) {
|
|
2283
|
+
const localVarFp = (0, exports.SDKExperimentsApiFp)(configuration);
|
|
2284
|
+
return {
|
|
2285
|
+
/**
|
|
2286
|
+
* Returns variant assignments for all running experiments for the requesting user. Uses hash-based consistent assignment.
|
|
2287
|
+
* @summary Get experiment assignments for a user
|
|
2288
|
+
* @param {string} xStoreid Store ID
|
|
2289
|
+
* @param {string} xStoresecret Store read secret
|
|
2290
|
+
* @param {string} [xUserId] User ID (provide either x-user-id or x-anon-id)
|
|
2291
|
+
* @param {string} [xAnonId] Anonymous ID (provide either x-user-id or x-anon-id)
|
|
2292
|
+
* @param {*} [options] Override http request option.
|
|
2293
|
+
* @throws {RequiredError}
|
|
2294
|
+
*/
|
|
2295
|
+
v1ExperimentsAssignmentGet(xStoreid, xStoresecret, xUserId, xAnonId, options) {
|
|
2296
|
+
return localVarFp.v1ExperimentsAssignmentGet(xStoreid, xStoresecret, xUserId, xAnonId, options).then((request) => request(axios, basePath));
|
|
2297
|
+
},
|
|
2298
|
+
};
|
|
2299
|
+
};
|
|
2300
|
+
exports.SDKExperimentsApiFactory = SDKExperimentsApiFactory;
|
|
2301
|
+
/**
|
|
2302
|
+
* SDKExperimentsApi - object-oriented interface
|
|
2303
|
+
*/
|
|
2304
|
+
class SDKExperimentsApi extends base_1.BaseAPI {
|
|
2305
|
+
/**
|
|
2306
|
+
* Returns variant assignments for all running experiments for the requesting user. Uses hash-based consistent assignment.
|
|
2307
|
+
* @summary Get experiment assignments for a user
|
|
2308
|
+
* @param {string} xStoreid Store ID
|
|
2309
|
+
* @param {string} xStoresecret Store read secret
|
|
2310
|
+
* @param {string} [xUserId] User ID (provide either x-user-id or x-anon-id)
|
|
2311
|
+
* @param {string} [xAnonId] Anonymous ID (provide either x-user-id or x-anon-id)
|
|
2312
|
+
* @param {*} [options] Override http request option.
|
|
2313
|
+
* @throws {RequiredError}
|
|
2314
|
+
*/
|
|
2315
|
+
v1ExperimentsAssignmentGet(xStoreid, xStoresecret, xUserId, xAnonId, options) {
|
|
2316
|
+
return (0, exports.SDKExperimentsApiFp)(this.configuration).v1ExperimentsAssignmentGet(xStoreid, xStoresecret, xUserId, xAnonId, options).then((request) => request(this.axios, this.basePath));
|
|
2317
|
+
}
|
|
2318
|
+
}
|
|
2319
|
+
exports.SDKExperimentsApi = SDKExperimentsApi;
|
|
1801
2320
|
/**
|
|
1802
2321
|
* SDKQuerySuggestionsConfigApi - axios parameter creator
|
|
1803
2322
|
*/
|
|
1804
2323
|
const SDKQuerySuggestionsConfigApiAxiosParamCreator = function (configuration) {
|
|
1805
2324
|
return {
|
|
1806
2325
|
/**
|
|
1807
|
-
*
|
|
1808
|
-
* @summary Get
|
|
1809
|
-
* @param {string} xStoreid Store ID
|
|
1810
|
-
* @param {string} xStoresecret Store
|
|
1811
|
-
* @param {string} xStoreID
|
|
2326
|
+
* Returns autocomplete/suggestions configuration for the store. **Auth:** `x-storeid` and `x-storesecret`. Path `xStoreID` must match the `x-storeid` header.
|
|
2327
|
+
* @summary Get query suggestions configuration
|
|
2328
|
+
* @param {string} xStoreid Store ID (from dashboard)
|
|
2329
|
+
* @param {string} xStoresecret Store read secret
|
|
2330
|
+
* @param {string} xStoreID Store ID (must match x-storeid header)
|
|
1812
2331
|
* @param {*} [options] Override http request option.
|
|
1813
2332
|
* @throws {RequiredError}
|
|
1814
2333
|
*/
|
|
@@ -1830,6 +2349,8 @@ const SDKQuerySuggestionsConfigApiAxiosParamCreator = function (configuration) {
|
|
|
1830
2349
|
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options };
|
|
1831
2350
|
const localVarHeaderParameter = {};
|
|
1832
2351
|
const localVarQueryParameter = {};
|
|
2352
|
+
// authentication ApiKeyAuth required
|
|
2353
|
+
await (0, common_1.setApiKeyToObject)(localVarHeaderParameter, "x-storesecret", configuration);
|
|
1833
2354
|
localVarHeaderParameter['Accept'] = 'application/json';
|
|
1834
2355
|
if (xStoreid != null) {
|
|
1835
2356
|
localVarHeaderParameter['x-storeid'] = String(xStoreid);
|
|
@@ -1846,12 +2367,12 @@ const SDKQuerySuggestionsConfigApiAxiosParamCreator = function (configuration) {
|
|
|
1846
2367
|
};
|
|
1847
2368
|
},
|
|
1848
2369
|
/**
|
|
1849
|
-
*
|
|
1850
|
-
* @summary Update
|
|
1851
|
-
* @param {string} xStoreid Store ID
|
|
1852
|
-
* @param {string} xStoreWriteSecret Store
|
|
1853
|
-
* @param {string} xStoreID
|
|
1854
|
-
* @param {QuerySuggestionsServiceUpdateSuggestionConfigRequest} querySuggestionsServiceUpdateSuggestionConfigRequest
|
|
2370
|
+
* Update autocomplete/suggestions settings for the store. Partial updates supported. **Auth:** `x-storeid` and `x-store-write-secret`. Path `xStoreID` must match the `x-storeid` header.
|
|
2371
|
+
* @summary Update query suggestions configuration
|
|
2372
|
+
* @param {string} xStoreid Store ID (from dashboard)
|
|
2373
|
+
* @param {string} xStoreWriteSecret Store write secret
|
|
2374
|
+
* @param {string} xStoreID Store ID (must match x-storeid header)
|
|
2375
|
+
* @param {QuerySuggestionsServiceUpdateSuggestionConfigRequest} querySuggestionsServiceUpdateSuggestionConfigRequest Fields to update (partial)
|
|
1855
2376
|
* @param {*} [options] Override http request option.
|
|
1856
2377
|
* @throws {RequiredError}
|
|
1857
2378
|
*/
|
|
@@ -1875,6 +2396,8 @@ const SDKQuerySuggestionsConfigApiAxiosParamCreator = function (configuration) {
|
|
|
1875
2396
|
const localVarRequestOptions = { method: 'PUT', ...baseOptions, ...options };
|
|
1876
2397
|
const localVarHeaderParameter = {};
|
|
1877
2398
|
const localVarQueryParameter = {};
|
|
2399
|
+
// authentication ApiKeyAuth required
|
|
2400
|
+
await (0, common_1.setApiKeyToObject)(localVarHeaderParameter, "x-storesecret", configuration);
|
|
1878
2401
|
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
1879
2402
|
localVarHeaderParameter['Accept'] = 'application/json';
|
|
1880
2403
|
if (xStoreid != null) {
|
|
@@ -1902,11 +2425,11 @@ const SDKQuerySuggestionsConfigApiFp = function (configuration) {
|
|
|
1902
2425
|
const localVarAxiosParamCreator = (0, exports.SDKQuerySuggestionsConfigApiAxiosParamCreator)(configuration);
|
|
1903
2426
|
return {
|
|
1904
2427
|
/**
|
|
1905
|
-
*
|
|
1906
|
-
* @summary Get
|
|
1907
|
-
* @param {string} xStoreid Store ID
|
|
1908
|
-
* @param {string} xStoresecret Store
|
|
1909
|
-
* @param {string} xStoreID
|
|
2428
|
+
* Returns autocomplete/suggestions configuration for the store. **Auth:** `x-storeid` and `x-storesecret`. Path `xStoreID` must match the `x-storeid` header.
|
|
2429
|
+
* @summary Get query suggestions configuration
|
|
2430
|
+
* @param {string} xStoreid Store ID (from dashboard)
|
|
2431
|
+
* @param {string} xStoresecret Store read secret
|
|
2432
|
+
* @param {string} xStoreID Store ID (must match x-storeid header)
|
|
1910
2433
|
* @param {*} [options] Override http request option.
|
|
1911
2434
|
* @throws {RequiredError}
|
|
1912
2435
|
*/
|
|
@@ -1917,12 +2440,12 @@ const SDKQuerySuggestionsConfigApiFp = function (configuration) {
|
|
|
1917
2440
|
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
1918
2441
|
},
|
|
1919
2442
|
/**
|
|
1920
|
-
*
|
|
1921
|
-
* @summary Update
|
|
1922
|
-
* @param {string} xStoreid Store ID
|
|
1923
|
-
* @param {string} xStoreWriteSecret Store
|
|
1924
|
-
* @param {string} xStoreID
|
|
1925
|
-
* @param {QuerySuggestionsServiceUpdateSuggestionConfigRequest} querySuggestionsServiceUpdateSuggestionConfigRequest
|
|
2443
|
+
* Update autocomplete/suggestions settings for the store. Partial updates supported. **Auth:** `x-storeid` and `x-store-write-secret`. Path `xStoreID` must match the `x-storeid` header.
|
|
2444
|
+
* @summary Update query suggestions configuration
|
|
2445
|
+
* @param {string} xStoreid Store ID (from dashboard)
|
|
2446
|
+
* @param {string} xStoreWriteSecret Store write secret
|
|
2447
|
+
* @param {string} xStoreID Store ID (must match x-storeid header)
|
|
2448
|
+
* @param {QuerySuggestionsServiceUpdateSuggestionConfigRequest} querySuggestionsServiceUpdateSuggestionConfigRequest Fields to update (partial)
|
|
1926
2449
|
* @param {*} [options] Override http request option.
|
|
1927
2450
|
* @throws {RequiredError}
|
|
1928
2451
|
*/
|
|
@@ -1942,11 +2465,11 @@ const SDKQuerySuggestionsConfigApiFactory = function (configuration, basePath, a
|
|
|
1942
2465
|
const localVarFp = (0, exports.SDKQuerySuggestionsConfigApiFp)(configuration);
|
|
1943
2466
|
return {
|
|
1944
2467
|
/**
|
|
1945
|
-
*
|
|
1946
|
-
* @summary Get
|
|
1947
|
-
* @param {string} xStoreid Store ID
|
|
1948
|
-
* @param {string} xStoresecret Store
|
|
1949
|
-
* @param {string} xStoreID
|
|
2468
|
+
* Returns autocomplete/suggestions configuration for the store. **Auth:** `x-storeid` and `x-storesecret`. Path `xStoreID` must match the `x-storeid` header.
|
|
2469
|
+
* @summary Get query suggestions configuration
|
|
2470
|
+
* @param {string} xStoreid Store ID (from dashboard)
|
|
2471
|
+
* @param {string} xStoresecret Store read secret
|
|
2472
|
+
* @param {string} xStoreID Store ID (must match x-storeid header)
|
|
1950
2473
|
* @param {*} [options] Override http request option.
|
|
1951
2474
|
* @throws {RequiredError}
|
|
1952
2475
|
*/
|
|
@@ -1954,12 +2477,12 @@ const SDKQuerySuggestionsConfigApiFactory = function (configuration, basePath, a
|
|
|
1954
2477
|
return localVarFp.apiV1StoresXStoreIDQuerySuggestionsConfigGet(xStoreid, xStoresecret, xStoreID, options).then((request) => request(axios, basePath));
|
|
1955
2478
|
},
|
|
1956
2479
|
/**
|
|
1957
|
-
*
|
|
1958
|
-
* @summary Update
|
|
1959
|
-
* @param {string} xStoreid Store ID
|
|
1960
|
-
* @param {string} xStoreWriteSecret Store
|
|
1961
|
-
* @param {string} xStoreID
|
|
1962
|
-
* @param {QuerySuggestionsServiceUpdateSuggestionConfigRequest} querySuggestionsServiceUpdateSuggestionConfigRequest
|
|
2480
|
+
* Update autocomplete/suggestions settings for the store. Partial updates supported. **Auth:** `x-storeid` and `x-store-write-secret`. Path `xStoreID` must match the `x-storeid` header.
|
|
2481
|
+
* @summary Update query suggestions configuration
|
|
2482
|
+
* @param {string} xStoreid Store ID (from dashboard)
|
|
2483
|
+
* @param {string} xStoreWriteSecret Store write secret
|
|
2484
|
+
* @param {string} xStoreID Store ID (must match x-storeid header)
|
|
2485
|
+
* @param {QuerySuggestionsServiceUpdateSuggestionConfigRequest} querySuggestionsServiceUpdateSuggestionConfigRequest Fields to update (partial)
|
|
1963
2486
|
* @param {*} [options] Override http request option.
|
|
1964
2487
|
* @throws {RequiredError}
|
|
1965
2488
|
*/
|
|
@@ -1974,11 +2497,11 @@ exports.SDKQuerySuggestionsConfigApiFactory = SDKQuerySuggestionsConfigApiFactor
|
|
|
1974
2497
|
*/
|
|
1975
2498
|
class SDKQuerySuggestionsConfigApi extends base_1.BaseAPI {
|
|
1976
2499
|
/**
|
|
1977
|
-
*
|
|
1978
|
-
* @summary Get
|
|
1979
|
-
* @param {string} xStoreid Store ID
|
|
1980
|
-
* @param {string} xStoresecret Store
|
|
1981
|
-
* @param {string} xStoreID
|
|
2500
|
+
* Returns autocomplete/suggestions configuration for the store. **Auth:** `x-storeid` and `x-storesecret`. Path `xStoreID` must match the `x-storeid` header.
|
|
2501
|
+
* @summary Get query suggestions configuration
|
|
2502
|
+
* @param {string} xStoreid Store ID (from dashboard)
|
|
2503
|
+
* @param {string} xStoresecret Store read secret
|
|
2504
|
+
* @param {string} xStoreID Store ID (must match x-storeid header)
|
|
1982
2505
|
* @param {*} [options] Override http request option.
|
|
1983
2506
|
* @throws {RequiredError}
|
|
1984
2507
|
*/
|
|
@@ -1986,12 +2509,12 @@ class SDKQuerySuggestionsConfigApi extends base_1.BaseAPI {
|
|
|
1986
2509
|
return (0, exports.SDKQuerySuggestionsConfigApiFp)(this.configuration).apiV1StoresXStoreIDQuerySuggestionsConfigGet(xStoreid, xStoresecret, xStoreID, options).then((request) => request(this.axios, this.basePath));
|
|
1987
2510
|
}
|
|
1988
2511
|
/**
|
|
1989
|
-
*
|
|
1990
|
-
* @summary Update
|
|
1991
|
-
* @param {string} xStoreid Store ID
|
|
1992
|
-
* @param {string} xStoreWriteSecret Store
|
|
1993
|
-
* @param {string} xStoreID
|
|
1994
|
-
* @param {QuerySuggestionsServiceUpdateSuggestionConfigRequest} querySuggestionsServiceUpdateSuggestionConfigRequest
|
|
2512
|
+
* Update autocomplete/suggestions settings for the store. Partial updates supported. **Auth:** `x-storeid` and `x-store-write-secret`. Path `xStoreID` must match the `x-storeid` header.
|
|
2513
|
+
* @summary Update query suggestions configuration
|
|
2514
|
+
* @param {string} xStoreid Store ID (from dashboard)
|
|
2515
|
+
* @param {string} xStoreWriteSecret Store write secret
|
|
2516
|
+
* @param {string} xStoreID Store ID (must match x-storeid header)
|
|
2517
|
+
* @param {QuerySuggestionsServiceUpdateSuggestionConfigRequest} querySuggestionsServiceUpdateSuggestionConfigRequest Fields to update (partial)
|
|
1995
2518
|
* @param {*} [options] Override http request option.
|
|
1996
2519
|
* @throws {RequiredError}
|
|
1997
2520
|
*/
|
|
@@ -2006,11 +2529,11 @@ exports.SDKQuerySuggestionsConfigApi = SDKQuerySuggestionsConfigApi;
|
|
|
2006
2529
|
const SDKSchemaApiAxiosParamCreator = function (configuration) {
|
|
2007
2530
|
return {
|
|
2008
2531
|
/**
|
|
2009
|
-
*
|
|
2010
|
-
* @summary Clear
|
|
2011
|
-
* @param {string} xStoreid Store ID
|
|
2012
|
-
* @param {string} xStoreWriteSecret Store
|
|
2013
|
-
* @param {string} xStoreID
|
|
2532
|
+
* Removes all documents from the store\'s search index; schema is preserved. **Auth:** `x-storeid` and `x-store-write-secret`. Path `xStoreID` must match the `x-storeid` header.
|
|
2533
|
+
* @summary Clear all documents
|
|
2534
|
+
* @param {string} xStoreid Store ID (from dashboard)
|
|
2535
|
+
* @param {string} xStoreWriteSecret Store write secret
|
|
2536
|
+
* @param {string} xStoreID Store ID (must match x-storeid header)
|
|
2014
2537
|
* @param {*} [options] Override http request option.
|
|
2015
2538
|
* @throws {RequiredError}
|
|
2016
2539
|
*/
|
|
@@ -2032,6 +2555,8 @@ const SDKSchemaApiAxiosParamCreator = function (configuration) {
|
|
|
2032
2555
|
const localVarRequestOptions = { method: 'DELETE', ...baseOptions, ...options };
|
|
2033
2556
|
const localVarHeaderParameter = {};
|
|
2034
2557
|
const localVarQueryParameter = {};
|
|
2558
|
+
// authentication ApiKeyAuth required
|
|
2559
|
+
await (0, common_1.setApiKeyToObject)(localVarHeaderParameter, "x-storesecret", configuration);
|
|
2035
2560
|
localVarHeaderParameter['Accept'] = 'application/json';
|
|
2036
2561
|
if (xStoreid != null) {
|
|
2037
2562
|
localVarHeaderParameter['x-storeid'] = String(xStoreid);
|
|
@@ -2048,11 +2573,11 @@ const SDKSchemaApiAxiosParamCreator = function (configuration) {
|
|
|
2048
2573
|
};
|
|
2049
2574
|
},
|
|
2050
2575
|
/**
|
|
2051
|
-
*
|
|
2052
|
-
* @summary Get
|
|
2053
|
-
* @param {string} xStoreid Store ID
|
|
2054
|
-
* @param {string} xStoresecret Store
|
|
2055
|
-
* @param {string} xStoreID
|
|
2576
|
+
* Returns the current search index schema (fields and options) for the store. **Auth:** `x-storeid` and `x-storesecret`. Path `xStoreID` must match the `x-storeid` header.
|
|
2577
|
+
* @summary Get index schema
|
|
2578
|
+
* @param {string} xStoreid Store ID (from dashboard)
|
|
2579
|
+
* @param {string} xStoresecret Store read secret
|
|
2580
|
+
* @param {string} xStoreID Store ID (must match x-storeid header)
|
|
2056
2581
|
* @param {*} [options] Override http request option.
|
|
2057
2582
|
* @throws {RequiredError}
|
|
2058
2583
|
*/
|
|
@@ -2074,6 +2599,8 @@ const SDKSchemaApiAxiosParamCreator = function (configuration) {
|
|
|
2074
2599
|
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options };
|
|
2075
2600
|
const localVarHeaderParameter = {};
|
|
2076
2601
|
const localVarQueryParameter = {};
|
|
2602
|
+
// authentication ApiKeyAuth required
|
|
2603
|
+
await (0, common_1.setApiKeyToObject)(localVarHeaderParameter, "x-storesecret", configuration);
|
|
2077
2604
|
localVarHeaderParameter['Accept'] = 'application/json';
|
|
2078
2605
|
if (xStoreid != null) {
|
|
2079
2606
|
localVarHeaderParameter['x-storeid'] = String(xStoreid);
|
|
@@ -2090,12 +2617,12 @@ const SDKSchemaApiAxiosParamCreator = function (configuration) {
|
|
|
2090
2617
|
};
|
|
2091
2618
|
},
|
|
2092
2619
|
/**
|
|
2093
|
-
*
|
|
2094
|
-
* @summary Create or
|
|
2095
|
-
* @param {string} xStoreid Store ID
|
|
2096
|
-
* @param {string} xStoreWriteSecret Store
|
|
2097
|
-
* @param {string} xStoreID
|
|
2098
|
-
* @param {DataTypesCollectionSchemaRequest} dataTypesCollectionSchemaRequest Schema
|
|
2620
|
+
* Define or update the search index schema (field names, types, searchable/facet options). Mode: `additive` (add fields, keep data) or `replace` (recreate index). **Auth:** `x-storeid` and `x-store-write-secret`. Path `xStoreID` must match the `x-storeid` header.
|
|
2621
|
+
* @summary Create or update index schema
|
|
2622
|
+
* @param {string} xStoreid Store ID (from dashboard)
|
|
2623
|
+
* @param {string} xStoreWriteSecret Store write secret
|
|
2624
|
+
* @param {string} xStoreID Store ID (must match x-storeid header)
|
|
2625
|
+
* @param {DataTypesCollectionSchemaRequest} dataTypesCollectionSchemaRequest Schema definition and mode
|
|
2099
2626
|
* @param {*} [options] Override http request option.
|
|
2100
2627
|
* @throws {RequiredError}
|
|
2101
2628
|
*/
|
|
@@ -2119,6 +2646,8 @@ const SDKSchemaApiAxiosParamCreator = function (configuration) {
|
|
|
2119
2646
|
const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options };
|
|
2120
2647
|
const localVarHeaderParameter = {};
|
|
2121
2648
|
const localVarQueryParameter = {};
|
|
2649
|
+
// authentication ApiKeyAuth required
|
|
2650
|
+
await (0, common_1.setApiKeyToObject)(localVarHeaderParameter, "x-storesecret", configuration);
|
|
2122
2651
|
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
2123
2652
|
localVarHeaderParameter['Accept'] = 'application/json';
|
|
2124
2653
|
if (xStoreid != null) {
|
|
@@ -2146,11 +2675,11 @@ const SDKSchemaApiFp = function (configuration) {
|
|
|
2146
2675
|
const localVarAxiosParamCreator = (0, exports.SDKSchemaApiAxiosParamCreator)(configuration);
|
|
2147
2676
|
return {
|
|
2148
2677
|
/**
|
|
2149
|
-
*
|
|
2150
|
-
* @summary Clear
|
|
2151
|
-
* @param {string} xStoreid Store ID
|
|
2152
|
-
* @param {string} xStoreWriteSecret Store
|
|
2153
|
-
* @param {string} xStoreID
|
|
2678
|
+
* Removes all documents from the store\'s search index; schema is preserved. **Auth:** `x-storeid` and `x-store-write-secret`. Path `xStoreID` must match the `x-storeid` header.
|
|
2679
|
+
* @summary Clear all documents
|
|
2680
|
+
* @param {string} xStoreid Store ID (from dashboard)
|
|
2681
|
+
* @param {string} xStoreWriteSecret Store write secret
|
|
2682
|
+
* @param {string} xStoreID Store ID (must match x-storeid header)
|
|
2154
2683
|
* @param {*} [options] Override http request option.
|
|
2155
2684
|
* @throws {RequiredError}
|
|
2156
2685
|
*/
|
|
@@ -2161,11 +2690,11 @@ const SDKSchemaApiFp = function (configuration) {
|
|
|
2161
2690
|
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
2162
2691
|
},
|
|
2163
2692
|
/**
|
|
2164
|
-
*
|
|
2165
|
-
* @summary Get
|
|
2166
|
-
* @param {string} xStoreid Store ID
|
|
2167
|
-
* @param {string} xStoresecret Store
|
|
2168
|
-
* @param {string} xStoreID
|
|
2693
|
+
* Returns the current search index schema (fields and options) for the store. **Auth:** `x-storeid` and `x-storesecret`. Path `xStoreID` must match the `x-storeid` header.
|
|
2694
|
+
* @summary Get index schema
|
|
2695
|
+
* @param {string} xStoreid Store ID (from dashboard)
|
|
2696
|
+
* @param {string} xStoresecret Store read secret
|
|
2697
|
+
* @param {string} xStoreID Store ID (must match x-storeid header)
|
|
2169
2698
|
* @param {*} [options] Override http request option.
|
|
2170
2699
|
* @throws {RequiredError}
|
|
2171
2700
|
*/
|
|
@@ -2176,12 +2705,12 @@ const SDKSchemaApiFp = function (configuration) {
|
|
|
2176
2705
|
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
2177
2706
|
},
|
|
2178
2707
|
/**
|
|
2179
|
-
*
|
|
2180
|
-
* @summary Create or
|
|
2181
|
-
* @param {string} xStoreid Store ID
|
|
2182
|
-
* @param {string} xStoreWriteSecret Store
|
|
2183
|
-
* @param {string} xStoreID
|
|
2184
|
-
* @param {DataTypesCollectionSchemaRequest} dataTypesCollectionSchemaRequest Schema
|
|
2708
|
+
* Define or update the search index schema (field names, types, searchable/facet options). Mode: `additive` (add fields, keep data) or `replace` (recreate index). **Auth:** `x-storeid` and `x-store-write-secret`. Path `xStoreID` must match the `x-storeid` header.
|
|
2709
|
+
* @summary Create or update index schema
|
|
2710
|
+
* @param {string} xStoreid Store ID (from dashboard)
|
|
2711
|
+
* @param {string} xStoreWriteSecret Store write secret
|
|
2712
|
+
* @param {string} xStoreID Store ID (must match x-storeid header)
|
|
2713
|
+
* @param {DataTypesCollectionSchemaRequest} dataTypesCollectionSchemaRequest Schema definition and mode
|
|
2185
2714
|
* @param {*} [options] Override http request option.
|
|
2186
2715
|
* @throws {RequiredError}
|
|
2187
2716
|
*/
|
|
@@ -2201,11 +2730,11 @@ const SDKSchemaApiFactory = function (configuration, basePath, axios) {
|
|
|
2201
2730
|
const localVarFp = (0, exports.SDKSchemaApiFp)(configuration);
|
|
2202
2731
|
return {
|
|
2203
2732
|
/**
|
|
2204
|
-
*
|
|
2205
|
-
* @summary Clear
|
|
2206
|
-
* @param {string} xStoreid Store ID
|
|
2207
|
-
* @param {string} xStoreWriteSecret Store
|
|
2208
|
-
* @param {string} xStoreID
|
|
2733
|
+
* Removes all documents from the store\'s search index; schema is preserved. **Auth:** `x-storeid` and `x-store-write-secret`. Path `xStoreID` must match the `x-storeid` header.
|
|
2734
|
+
* @summary Clear all documents
|
|
2735
|
+
* @param {string} xStoreid Store ID (from dashboard)
|
|
2736
|
+
* @param {string} xStoreWriteSecret Store write secret
|
|
2737
|
+
* @param {string} xStoreID Store ID (must match x-storeid header)
|
|
2209
2738
|
* @param {*} [options] Override http request option.
|
|
2210
2739
|
* @throws {RequiredError}
|
|
2211
2740
|
*/
|
|
@@ -2213,11 +2742,11 @@ const SDKSchemaApiFactory = function (configuration, basePath, axios) {
|
|
|
2213
2742
|
return localVarFp.apiV1StoresXStoreIDDocumentsDelete(xStoreid, xStoreWriteSecret, xStoreID, options).then((request) => request(axios, basePath));
|
|
2214
2743
|
},
|
|
2215
2744
|
/**
|
|
2216
|
-
*
|
|
2217
|
-
* @summary Get
|
|
2218
|
-
* @param {string} xStoreid Store ID
|
|
2219
|
-
* @param {string} xStoresecret Store
|
|
2220
|
-
* @param {string} xStoreID
|
|
2745
|
+
* Returns the current search index schema (fields and options) for the store. **Auth:** `x-storeid` and `x-storesecret`. Path `xStoreID` must match the `x-storeid` header.
|
|
2746
|
+
* @summary Get index schema
|
|
2747
|
+
* @param {string} xStoreid Store ID (from dashboard)
|
|
2748
|
+
* @param {string} xStoresecret Store read secret
|
|
2749
|
+
* @param {string} xStoreID Store ID (must match x-storeid header)
|
|
2221
2750
|
* @param {*} [options] Override http request option.
|
|
2222
2751
|
* @throws {RequiredError}
|
|
2223
2752
|
*/
|
|
@@ -2225,12 +2754,12 @@ const SDKSchemaApiFactory = function (configuration, basePath, axios) {
|
|
|
2225
2754
|
return localVarFp.apiV1StoresXStoreIDSchemaGet(xStoreid, xStoresecret, xStoreID, options).then((request) => request(axios, basePath));
|
|
2226
2755
|
},
|
|
2227
2756
|
/**
|
|
2228
|
-
*
|
|
2229
|
-
* @summary Create or
|
|
2230
|
-
* @param {string} xStoreid Store ID
|
|
2231
|
-
* @param {string} xStoreWriteSecret Store
|
|
2232
|
-
* @param {string} xStoreID
|
|
2233
|
-
* @param {DataTypesCollectionSchemaRequest} dataTypesCollectionSchemaRequest Schema
|
|
2757
|
+
* Define or update the search index schema (field names, types, searchable/facet options). Mode: `additive` (add fields, keep data) or `replace` (recreate index). **Auth:** `x-storeid` and `x-store-write-secret`. Path `xStoreID` must match the `x-storeid` header.
|
|
2758
|
+
* @summary Create or update index schema
|
|
2759
|
+
* @param {string} xStoreid Store ID (from dashboard)
|
|
2760
|
+
* @param {string} xStoreWriteSecret Store write secret
|
|
2761
|
+
* @param {string} xStoreID Store ID (must match x-storeid header)
|
|
2762
|
+
* @param {DataTypesCollectionSchemaRequest} dataTypesCollectionSchemaRequest Schema definition and mode
|
|
2234
2763
|
* @param {*} [options] Override http request option.
|
|
2235
2764
|
* @throws {RequiredError}
|
|
2236
2765
|
*/
|
|
@@ -2245,11 +2774,11 @@ exports.SDKSchemaApiFactory = SDKSchemaApiFactory;
|
|
|
2245
2774
|
*/
|
|
2246
2775
|
class SDKSchemaApi extends base_1.BaseAPI {
|
|
2247
2776
|
/**
|
|
2248
|
-
*
|
|
2249
|
-
* @summary Clear
|
|
2250
|
-
* @param {string} xStoreid Store ID
|
|
2251
|
-
* @param {string} xStoreWriteSecret Store
|
|
2252
|
-
* @param {string} xStoreID
|
|
2777
|
+
* Removes all documents from the store\'s search index; schema is preserved. **Auth:** `x-storeid` and `x-store-write-secret`. Path `xStoreID` must match the `x-storeid` header.
|
|
2778
|
+
* @summary Clear all documents
|
|
2779
|
+
* @param {string} xStoreid Store ID (from dashboard)
|
|
2780
|
+
* @param {string} xStoreWriteSecret Store write secret
|
|
2781
|
+
* @param {string} xStoreID Store ID (must match x-storeid header)
|
|
2253
2782
|
* @param {*} [options] Override http request option.
|
|
2254
2783
|
* @throws {RequiredError}
|
|
2255
2784
|
*/
|
|
@@ -2257,11 +2786,11 @@ class SDKSchemaApi extends base_1.BaseAPI {
|
|
|
2257
2786
|
return (0, exports.SDKSchemaApiFp)(this.configuration).apiV1StoresXStoreIDDocumentsDelete(xStoreid, xStoreWriteSecret, xStoreID, options).then((request) => request(this.axios, this.basePath));
|
|
2258
2787
|
}
|
|
2259
2788
|
/**
|
|
2260
|
-
*
|
|
2261
|
-
* @summary Get
|
|
2262
|
-
* @param {string} xStoreid Store ID
|
|
2263
|
-
* @param {string} xStoresecret Store
|
|
2264
|
-
* @param {string} xStoreID
|
|
2789
|
+
* Returns the current search index schema (fields and options) for the store. **Auth:** `x-storeid` and `x-storesecret`. Path `xStoreID` must match the `x-storeid` header.
|
|
2790
|
+
* @summary Get index schema
|
|
2791
|
+
* @param {string} xStoreid Store ID (from dashboard)
|
|
2792
|
+
* @param {string} xStoresecret Store read secret
|
|
2793
|
+
* @param {string} xStoreID Store ID (must match x-storeid header)
|
|
2265
2794
|
* @param {*} [options] Override http request option.
|
|
2266
2795
|
* @throws {RequiredError}
|
|
2267
2796
|
*/
|
|
@@ -2269,12 +2798,12 @@ class SDKSchemaApi extends base_1.BaseAPI {
|
|
|
2269
2798
|
return (0, exports.SDKSchemaApiFp)(this.configuration).apiV1StoresXStoreIDSchemaGet(xStoreid, xStoresecret, xStoreID, options).then((request) => request(this.axios, this.basePath));
|
|
2270
2799
|
}
|
|
2271
2800
|
/**
|
|
2272
|
-
*
|
|
2273
|
-
* @summary Create or
|
|
2274
|
-
* @param {string} xStoreid Store ID
|
|
2275
|
-
* @param {string} xStoreWriteSecret Store
|
|
2276
|
-
* @param {string} xStoreID
|
|
2277
|
-
* @param {DataTypesCollectionSchemaRequest} dataTypesCollectionSchemaRequest Schema
|
|
2801
|
+
* Define or update the search index schema (field names, types, searchable/facet options). Mode: `additive` (add fields, keep data) or `replace` (recreate index). **Auth:** `x-storeid` and `x-store-write-secret`. Path `xStoreID` must match the `x-storeid` header.
|
|
2802
|
+
* @summary Create or update index schema
|
|
2803
|
+
* @param {string} xStoreid Store ID (from dashboard)
|
|
2804
|
+
* @param {string} xStoreWriteSecret Store write secret
|
|
2805
|
+
* @param {string} xStoreID Store ID (must match x-storeid header)
|
|
2806
|
+
* @param {DataTypesCollectionSchemaRequest} dataTypesCollectionSchemaRequest Schema definition and mode
|
|
2278
2807
|
* @param {*} [options] Override http request option.
|
|
2279
2808
|
* @throws {RequiredError}
|
|
2280
2809
|
*/
|
|
@@ -2289,11 +2818,11 @@ exports.SDKSchemaApi = SDKSchemaApi;
|
|
|
2289
2818
|
const SDKStoreConfigApiAxiosParamCreator = function (configuration) {
|
|
2290
2819
|
return {
|
|
2291
2820
|
/**
|
|
2292
|
-
*
|
|
2293
|
-
* @summary Get
|
|
2294
|
-
* @param {string} xStoreid Store ID
|
|
2295
|
-
* @param {string} xStoresecret Store
|
|
2296
|
-
* @param {string} xStoreID
|
|
2821
|
+
* Returns search and query-suggestions configuration for the store. **Auth:** `x-storeid` and `x-storesecret`. Path `xStoreID` must match the `x-storeid` header.
|
|
2822
|
+
* @summary Get store configuration
|
|
2823
|
+
* @param {string} xStoreid Store ID (from dashboard)
|
|
2824
|
+
* @param {string} xStoresecret Store read secret
|
|
2825
|
+
* @param {string} xStoreID Store ID (must match x-storeid header)
|
|
2297
2826
|
* @param {*} [options] Override http request option.
|
|
2298
2827
|
* @throws {RequiredError}
|
|
2299
2828
|
*/
|
|
@@ -2315,6 +2844,8 @@ const SDKStoreConfigApiAxiosParamCreator = function (configuration) {
|
|
|
2315
2844
|
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options };
|
|
2316
2845
|
const localVarHeaderParameter = {};
|
|
2317
2846
|
const localVarQueryParameter = {};
|
|
2847
|
+
// authentication ApiKeyAuth required
|
|
2848
|
+
await (0, common_1.setApiKeyToObject)(localVarHeaderParameter, "x-storesecret", configuration);
|
|
2318
2849
|
localVarHeaderParameter['Accept'] = 'application/json';
|
|
2319
2850
|
if (xStoreid != null) {
|
|
2320
2851
|
localVarHeaderParameter['x-storeid'] = String(xStoreid);
|
|
@@ -2331,12 +2862,12 @@ const SDKStoreConfigApiAxiosParamCreator = function (configuration) {
|
|
|
2331
2862
|
};
|
|
2332
2863
|
},
|
|
2333
2864
|
/**
|
|
2334
|
-
*
|
|
2335
|
-
* @summary Update
|
|
2336
|
-
* @param {string} xStoreid Store ID
|
|
2337
|
-
* @param {string} xStoreWriteSecret Store
|
|
2338
|
-
* @param {string} xStoreID
|
|
2339
|
-
* @param {DataTypesIndexConfig} dataTypesIndexConfig
|
|
2865
|
+
* Update search and store settings. Partial updates supported. **Auth:** `x-storeid` and `x-store-write-secret`. Path `xStoreID` must match the `x-storeid` header.
|
|
2866
|
+
* @summary Update store configuration
|
|
2867
|
+
* @param {string} xStoreid Store ID (from dashboard)
|
|
2868
|
+
* @param {string} xStoreWriteSecret Store write secret
|
|
2869
|
+
* @param {string} xStoreID Store ID (must match x-storeid header)
|
|
2870
|
+
* @param {DataTypesIndexConfig} dataTypesIndexConfig Fields to update (partial)
|
|
2340
2871
|
* @param {*} [options] Override http request option.
|
|
2341
2872
|
* @throws {RequiredError}
|
|
2342
2873
|
*/
|
|
@@ -2360,6 +2891,8 @@ const SDKStoreConfigApiAxiosParamCreator = function (configuration) {
|
|
|
2360
2891
|
const localVarRequestOptions = { method: 'PUT', ...baseOptions, ...options };
|
|
2361
2892
|
const localVarHeaderParameter = {};
|
|
2362
2893
|
const localVarQueryParameter = {};
|
|
2894
|
+
// authentication ApiKeyAuth required
|
|
2895
|
+
await (0, common_1.setApiKeyToObject)(localVarHeaderParameter, "x-storesecret", configuration);
|
|
2363
2896
|
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
2364
2897
|
localVarHeaderParameter['Accept'] = 'application/json';
|
|
2365
2898
|
if (xStoreid != null) {
|
|
@@ -2378,11 +2911,11 @@ const SDKStoreConfigApiAxiosParamCreator = function (configuration) {
|
|
|
2378
2911
|
};
|
|
2379
2912
|
},
|
|
2380
2913
|
/**
|
|
2381
|
-
*
|
|
2382
|
-
* @summary Get
|
|
2383
|
-
* @param {string} xStoreid Store ID
|
|
2384
|
-
* @param {string} xStoresecret Store
|
|
2385
|
-
* @param {string} xStoreID
|
|
2914
|
+
* Returns metadata for all configurable store fields (types, defaults, validation). **Auth:** `x-storeid` and `x-storesecret`. Path `xStoreID` must match the `x-storeid` header.
|
|
2915
|
+
* @summary Get store config schema
|
|
2916
|
+
* @param {string} xStoreid Store ID (from dashboard)
|
|
2917
|
+
* @param {string} xStoresecret Store read secret
|
|
2918
|
+
* @param {string} xStoreID Store ID (must match x-storeid header)
|
|
2386
2919
|
* @param {*} [options] Override http request option.
|
|
2387
2920
|
* @throws {RequiredError}
|
|
2388
2921
|
*/
|
|
@@ -2404,6 +2937,8 @@ const SDKStoreConfigApiAxiosParamCreator = function (configuration) {
|
|
|
2404
2937
|
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options };
|
|
2405
2938
|
const localVarHeaderParameter = {};
|
|
2406
2939
|
const localVarQueryParameter = {};
|
|
2940
|
+
// authentication ApiKeyAuth required
|
|
2941
|
+
await (0, common_1.setApiKeyToObject)(localVarHeaderParameter, "x-storesecret", configuration);
|
|
2407
2942
|
localVarHeaderParameter['Accept'] = 'application/json';
|
|
2408
2943
|
if (xStoreid != null) {
|
|
2409
2944
|
localVarHeaderParameter['x-storeid'] = String(xStoreid);
|
|
@@ -2429,11 +2964,11 @@ const SDKStoreConfigApiFp = function (configuration) {
|
|
|
2429
2964
|
const localVarAxiosParamCreator = (0, exports.SDKStoreConfigApiAxiosParamCreator)(configuration);
|
|
2430
2965
|
return {
|
|
2431
2966
|
/**
|
|
2432
|
-
*
|
|
2433
|
-
* @summary Get
|
|
2434
|
-
* @param {string} xStoreid Store ID
|
|
2435
|
-
* @param {string} xStoresecret Store
|
|
2436
|
-
* @param {string} xStoreID
|
|
2967
|
+
* Returns search and query-suggestions configuration for the store. **Auth:** `x-storeid` and `x-storesecret`. Path `xStoreID` must match the `x-storeid` header.
|
|
2968
|
+
* @summary Get store configuration
|
|
2969
|
+
* @param {string} xStoreid Store ID (from dashboard)
|
|
2970
|
+
* @param {string} xStoresecret Store read secret
|
|
2971
|
+
* @param {string} xStoreID Store ID (must match x-storeid header)
|
|
2437
2972
|
* @param {*} [options] Override http request option.
|
|
2438
2973
|
* @throws {RequiredError}
|
|
2439
2974
|
*/
|
|
@@ -2444,12 +2979,12 @@ const SDKStoreConfigApiFp = function (configuration) {
|
|
|
2444
2979
|
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
2445
2980
|
},
|
|
2446
2981
|
/**
|
|
2447
|
-
*
|
|
2448
|
-
* @summary Update
|
|
2449
|
-
* @param {string} xStoreid Store ID
|
|
2450
|
-
* @param {string} xStoreWriteSecret Store
|
|
2451
|
-
* @param {string} xStoreID
|
|
2452
|
-
* @param {DataTypesIndexConfig} dataTypesIndexConfig
|
|
2982
|
+
* Update search and store settings. Partial updates supported. **Auth:** `x-storeid` and `x-store-write-secret`. Path `xStoreID` must match the `x-storeid` header.
|
|
2983
|
+
* @summary Update store configuration
|
|
2984
|
+
* @param {string} xStoreid Store ID (from dashboard)
|
|
2985
|
+
* @param {string} xStoreWriteSecret Store write secret
|
|
2986
|
+
* @param {string} xStoreID Store ID (must match x-storeid header)
|
|
2987
|
+
* @param {DataTypesIndexConfig} dataTypesIndexConfig Fields to update (partial)
|
|
2453
2988
|
* @param {*} [options] Override http request option.
|
|
2454
2989
|
* @throws {RequiredError}
|
|
2455
2990
|
*/
|
|
@@ -2460,11 +2995,11 @@ const SDKStoreConfigApiFp = function (configuration) {
|
|
|
2460
2995
|
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
2461
2996
|
},
|
|
2462
2997
|
/**
|
|
2463
|
-
*
|
|
2464
|
-
* @summary Get
|
|
2465
|
-
* @param {string} xStoreid Store ID
|
|
2466
|
-
* @param {string} xStoresecret Store
|
|
2467
|
-
* @param {string} xStoreID
|
|
2998
|
+
* Returns metadata for all configurable store fields (types, defaults, validation). **Auth:** `x-storeid` and `x-storesecret`. Path `xStoreID` must match the `x-storeid` header.
|
|
2999
|
+
* @summary Get store config schema
|
|
3000
|
+
* @param {string} xStoreid Store ID (from dashboard)
|
|
3001
|
+
* @param {string} xStoresecret Store read secret
|
|
3002
|
+
* @param {string} xStoreID Store ID (must match x-storeid header)
|
|
2468
3003
|
* @param {*} [options] Override http request option.
|
|
2469
3004
|
* @throws {RequiredError}
|
|
2470
3005
|
*/
|
|
@@ -2484,11 +3019,11 @@ const SDKStoreConfigApiFactory = function (configuration, basePath, axios) {
|
|
|
2484
3019
|
const localVarFp = (0, exports.SDKStoreConfigApiFp)(configuration);
|
|
2485
3020
|
return {
|
|
2486
3021
|
/**
|
|
2487
|
-
*
|
|
2488
|
-
* @summary Get
|
|
2489
|
-
* @param {string} xStoreid Store ID
|
|
2490
|
-
* @param {string} xStoresecret Store
|
|
2491
|
-
* @param {string} xStoreID
|
|
3022
|
+
* Returns search and query-suggestions configuration for the store. **Auth:** `x-storeid` and `x-storesecret`. Path `xStoreID` must match the `x-storeid` header.
|
|
3023
|
+
* @summary Get store configuration
|
|
3024
|
+
* @param {string} xStoreid Store ID (from dashboard)
|
|
3025
|
+
* @param {string} xStoresecret Store read secret
|
|
3026
|
+
* @param {string} xStoreID Store ID (must match x-storeid header)
|
|
2492
3027
|
* @param {*} [options] Override http request option.
|
|
2493
3028
|
* @throws {RequiredError}
|
|
2494
3029
|
*/
|
|
@@ -2496,12 +3031,12 @@ const SDKStoreConfigApiFactory = function (configuration, basePath, axios) {
|
|
|
2496
3031
|
return localVarFp.apiV1StoresXStoreIDConfigGet(xStoreid, xStoresecret, xStoreID, options).then((request) => request(axios, basePath));
|
|
2497
3032
|
},
|
|
2498
3033
|
/**
|
|
2499
|
-
*
|
|
2500
|
-
* @summary Update
|
|
2501
|
-
* @param {string} xStoreid Store ID
|
|
2502
|
-
* @param {string} xStoreWriteSecret Store
|
|
2503
|
-
* @param {string} xStoreID
|
|
2504
|
-
* @param {DataTypesIndexConfig} dataTypesIndexConfig
|
|
3034
|
+
* Update search and store settings. Partial updates supported. **Auth:** `x-storeid` and `x-store-write-secret`. Path `xStoreID` must match the `x-storeid` header.
|
|
3035
|
+
* @summary Update store configuration
|
|
3036
|
+
* @param {string} xStoreid Store ID (from dashboard)
|
|
3037
|
+
* @param {string} xStoreWriteSecret Store write secret
|
|
3038
|
+
* @param {string} xStoreID Store ID (must match x-storeid header)
|
|
3039
|
+
* @param {DataTypesIndexConfig} dataTypesIndexConfig Fields to update (partial)
|
|
2505
3040
|
* @param {*} [options] Override http request option.
|
|
2506
3041
|
* @throws {RequiredError}
|
|
2507
3042
|
*/
|
|
@@ -2509,11 +3044,11 @@ const SDKStoreConfigApiFactory = function (configuration, basePath, axios) {
|
|
|
2509
3044
|
return localVarFp.apiV1StoresXStoreIDConfigPut(xStoreid, xStoreWriteSecret, xStoreID, dataTypesIndexConfig, options).then((request) => request(axios, basePath));
|
|
2510
3045
|
},
|
|
2511
3046
|
/**
|
|
2512
|
-
*
|
|
2513
|
-
* @summary Get
|
|
2514
|
-
* @param {string} xStoreid Store ID
|
|
2515
|
-
* @param {string} xStoresecret Store
|
|
2516
|
-
* @param {string} xStoreID
|
|
3047
|
+
* Returns metadata for all configurable store fields (types, defaults, validation). **Auth:** `x-storeid` and `x-storesecret`. Path `xStoreID` must match the `x-storeid` header.
|
|
3048
|
+
* @summary Get store config schema
|
|
3049
|
+
* @param {string} xStoreid Store ID (from dashboard)
|
|
3050
|
+
* @param {string} xStoresecret Store read secret
|
|
3051
|
+
* @param {string} xStoreID Store ID (must match x-storeid header)
|
|
2517
3052
|
* @param {*} [options] Override http request option.
|
|
2518
3053
|
* @throws {RequiredError}
|
|
2519
3054
|
*/
|
|
@@ -2528,11 +3063,11 @@ exports.SDKStoreConfigApiFactory = SDKStoreConfigApiFactory;
|
|
|
2528
3063
|
*/
|
|
2529
3064
|
class SDKStoreConfigApi extends base_1.BaseAPI {
|
|
2530
3065
|
/**
|
|
2531
|
-
*
|
|
2532
|
-
* @summary Get
|
|
2533
|
-
* @param {string} xStoreid Store ID
|
|
2534
|
-
* @param {string} xStoresecret Store
|
|
2535
|
-
* @param {string} xStoreID
|
|
3066
|
+
* Returns search and query-suggestions configuration for the store. **Auth:** `x-storeid` and `x-storesecret`. Path `xStoreID` must match the `x-storeid` header.
|
|
3067
|
+
* @summary Get store configuration
|
|
3068
|
+
* @param {string} xStoreid Store ID (from dashboard)
|
|
3069
|
+
* @param {string} xStoresecret Store read secret
|
|
3070
|
+
* @param {string} xStoreID Store ID (must match x-storeid header)
|
|
2536
3071
|
* @param {*} [options] Override http request option.
|
|
2537
3072
|
* @throws {RequiredError}
|
|
2538
3073
|
*/
|
|
@@ -2540,12 +3075,12 @@ class SDKStoreConfigApi extends base_1.BaseAPI {
|
|
|
2540
3075
|
return (0, exports.SDKStoreConfigApiFp)(this.configuration).apiV1StoresXStoreIDConfigGet(xStoreid, xStoresecret, xStoreID, options).then((request) => request(this.axios, this.basePath));
|
|
2541
3076
|
}
|
|
2542
3077
|
/**
|
|
2543
|
-
*
|
|
2544
|
-
* @summary Update
|
|
2545
|
-
* @param {string} xStoreid Store ID
|
|
2546
|
-
* @param {string} xStoreWriteSecret Store
|
|
2547
|
-
* @param {string} xStoreID
|
|
2548
|
-
* @param {DataTypesIndexConfig} dataTypesIndexConfig
|
|
3078
|
+
* Update search and store settings. Partial updates supported. **Auth:** `x-storeid` and `x-store-write-secret`. Path `xStoreID` must match the `x-storeid` header.
|
|
3079
|
+
* @summary Update store configuration
|
|
3080
|
+
* @param {string} xStoreid Store ID (from dashboard)
|
|
3081
|
+
* @param {string} xStoreWriteSecret Store write secret
|
|
3082
|
+
* @param {string} xStoreID Store ID (must match x-storeid header)
|
|
3083
|
+
* @param {DataTypesIndexConfig} dataTypesIndexConfig Fields to update (partial)
|
|
2549
3084
|
* @param {*} [options] Override http request option.
|
|
2550
3085
|
* @throws {RequiredError}
|
|
2551
3086
|
*/
|
|
@@ -2553,11 +3088,11 @@ class SDKStoreConfigApi extends base_1.BaseAPI {
|
|
|
2553
3088
|
return (0, exports.SDKStoreConfigApiFp)(this.configuration).apiV1StoresXStoreIDConfigPut(xStoreid, xStoreWriteSecret, xStoreID, dataTypesIndexConfig, options).then((request) => request(this.axios, this.basePath));
|
|
2554
3089
|
}
|
|
2555
3090
|
/**
|
|
2556
|
-
*
|
|
2557
|
-
* @summary Get
|
|
2558
|
-
* @param {string} xStoreid Store ID
|
|
2559
|
-
* @param {string} xStoresecret Store
|
|
2560
|
-
* @param {string} xStoreID
|
|
3091
|
+
* Returns metadata for all configurable store fields (types, defaults, validation). **Auth:** `x-storeid` and `x-storesecret`. Path `xStoreID` must match the `x-storeid` header.
|
|
3092
|
+
* @summary Get store config schema
|
|
3093
|
+
* @param {string} xStoreid Store ID (from dashboard)
|
|
3094
|
+
* @param {string} xStoresecret Store read secret
|
|
3095
|
+
* @param {string} xStoreID Store ID (must match x-storeid header)
|
|
2561
3096
|
* @param {*} [options] Override http request option.
|
|
2562
3097
|
* @throws {RequiredError}
|
|
2563
3098
|
*/
|
|
@@ -2679,11 +3214,11 @@ exports.SDKStoreCreationApi = SDKStoreCreationApi;
|
|
|
2679
3214
|
const SDKStoreInfoApiAxiosParamCreator = function (configuration) {
|
|
2680
3215
|
return {
|
|
2681
3216
|
/**
|
|
2682
|
-
*
|
|
2683
|
-
* @summary Get
|
|
2684
|
-
* @param {string} xStoreid Store ID
|
|
2685
|
-
* @param {string} xStoresecret Store
|
|
2686
|
-
* @param {string} xStoreID
|
|
3217
|
+
* Returns basic store details (name, location, status). **Auth:** `x-storeid` and `x-storesecret`. Path `xStoreID` must match the `x-storeid` header.
|
|
3218
|
+
* @summary Get store info
|
|
3219
|
+
* @param {string} xStoreid Store ID (from dashboard)
|
|
3220
|
+
* @param {string} xStoresecret Store read secret
|
|
3221
|
+
* @param {string} xStoreID Store ID (must match x-storeid header)
|
|
2687
3222
|
* @param {*} [options] Override http request option.
|
|
2688
3223
|
* @throws {RequiredError}
|
|
2689
3224
|
*/
|
|
@@ -2705,6 +3240,8 @@ const SDKStoreInfoApiAxiosParamCreator = function (configuration) {
|
|
|
2705
3240
|
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options };
|
|
2706
3241
|
const localVarHeaderParameter = {};
|
|
2707
3242
|
const localVarQueryParameter = {};
|
|
3243
|
+
// authentication ApiKeyAuth required
|
|
3244
|
+
await (0, common_1.setApiKeyToObject)(localVarHeaderParameter, "x-storesecret", configuration);
|
|
2708
3245
|
localVarHeaderParameter['Accept'] = 'application/json';
|
|
2709
3246
|
if (xStoreid != null) {
|
|
2710
3247
|
localVarHeaderParameter['x-storeid'] = String(xStoreid);
|
|
@@ -2730,11 +3267,11 @@ const SDKStoreInfoApiFp = function (configuration) {
|
|
|
2730
3267
|
const localVarAxiosParamCreator = (0, exports.SDKStoreInfoApiAxiosParamCreator)(configuration);
|
|
2731
3268
|
return {
|
|
2732
3269
|
/**
|
|
2733
|
-
*
|
|
2734
|
-
* @summary Get
|
|
2735
|
-
* @param {string} xStoreid Store ID
|
|
2736
|
-
* @param {string} xStoresecret Store
|
|
2737
|
-
* @param {string} xStoreID
|
|
3270
|
+
* Returns basic store details (name, location, status). **Auth:** `x-storeid` and `x-storesecret`. Path `xStoreID` must match the `x-storeid` header.
|
|
3271
|
+
* @summary Get store info
|
|
3272
|
+
* @param {string} xStoreid Store ID (from dashboard)
|
|
3273
|
+
* @param {string} xStoresecret Store read secret
|
|
3274
|
+
* @param {string} xStoreID Store ID (must match x-storeid header)
|
|
2738
3275
|
* @param {*} [options] Override http request option.
|
|
2739
3276
|
* @throws {RequiredError}
|
|
2740
3277
|
*/
|
|
@@ -2754,11 +3291,11 @@ const SDKStoreInfoApiFactory = function (configuration, basePath, axios) {
|
|
|
2754
3291
|
const localVarFp = (0, exports.SDKStoreInfoApiFp)(configuration);
|
|
2755
3292
|
return {
|
|
2756
3293
|
/**
|
|
2757
|
-
*
|
|
2758
|
-
* @summary Get
|
|
2759
|
-
* @param {string} xStoreid Store ID
|
|
2760
|
-
* @param {string} xStoresecret Store
|
|
2761
|
-
* @param {string} xStoreID
|
|
3294
|
+
* Returns basic store details (name, location, status). **Auth:** `x-storeid` and `x-storesecret`. Path `xStoreID` must match the `x-storeid` header.
|
|
3295
|
+
* @summary Get store info
|
|
3296
|
+
* @param {string} xStoreid Store ID (from dashboard)
|
|
3297
|
+
* @param {string} xStoresecret Store read secret
|
|
3298
|
+
* @param {string} xStoreID Store ID (must match x-storeid header)
|
|
2762
3299
|
* @param {*} [options] Override http request option.
|
|
2763
3300
|
* @throws {RequiredError}
|
|
2764
3301
|
*/
|
|
@@ -2773,11 +3310,11 @@ exports.SDKStoreInfoApiFactory = SDKStoreInfoApiFactory;
|
|
|
2773
3310
|
*/
|
|
2774
3311
|
class SDKStoreInfoApi extends base_1.BaseAPI {
|
|
2775
3312
|
/**
|
|
2776
|
-
*
|
|
2777
|
-
* @summary Get
|
|
2778
|
-
* @param {string} xStoreid Store ID
|
|
2779
|
-
* @param {string} xStoresecret Store
|
|
2780
|
-
* @param {string} xStoreID
|
|
3313
|
+
* Returns basic store details (name, location, status). **Auth:** `x-storeid` and `x-storesecret`. Path `xStoreID` must match the `x-storeid` header.
|
|
3314
|
+
* @summary Get store info
|
|
3315
|
+
* @param {string} xStoreid Store ID (from dashboard)
|
|
3316
|
+
* @param {string} xStoresecret Store read secret
|
|
3317
|
+
* @param {string} xStoreID Store ID (must match x-storeid header)
|
|
2781
3318
|
* @param {*} [options] Override http request option.
|
|
2782
3319
|
* @throws {RequiredError}
|
|
2783
3320
|
*/
|
|
@@ -2792,13 +3329,13 @@ exports.SDKStoreInfoApi = SDKStoreInfoApi;
|
|
|
2792
3329
|
const SearchApiAxiosParamCreator = function (configuration) {
|
|
2793
3330
|
return {
|
|
2794
3331
|
/**
|
|
2795
|
-
*
|
|
2796
|
-
* @summary
|
|
2797
|
-
* @param {string} xStoreid Store ID
|
|
2798
|
-
* @param {string} xStoresecret Store
|
|
3332
|
+
* 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.
|
|
3333
|
+
* @summary Search (GET)
|
|
3334
|
+
* @param {string} xStoreid Store ID (from dashboard)
|
|
3335
|
+
* @param {string} xStoresecret Store read secret (from dashboard)
|
|
2799
3336
|
* @param {string} q Search query
|
|
2800
3337
|
* @param {string} [xUserId] User ID for personalization
|
|
2801
|
-
* @param {string} [xAnonId] Anonymous ID for personalization
|
|
3338
|
+
* @param {string} [xAnonId] Anonymous user ID for personalization
|
|
2802
3339
|
* @param {string} [xSessionId] Session ID for personalization
|
|
2803
3340
|
* @param {number} [page] Page number (default: 1)
|
|
2804
3341
|
* @param {number} [perPage] Items per page (default: 10)
|
|
@@ -2996,13 +3533,13 @@ const SearchApiAxiosParamCreator = function (configuration) {
|
|
|
2996
3533
|
};
|
|
2997
3534
|
},
|
|
2998
3535
|
/**
|
|
2999
|
-
*
|
|
3000
|
-
* @summary
|
|
3001
|
-
* @param {string} xStoreid Store ID
|
|
3002
|
-
* @param {string} xStoresecret Store
|
|
3003
|
-
* @param {DataTypesPublicSearchRequest} dataTypesPublicSearchRequest Search
|
|
3004
|
-
* @param {string} [xUserId] User ID for personalization
|
|
3005
|
-
* @param {string} [xAnonId] Anonymous ID for personalization
|
|
3536
|
+
* Run a full-text search for your store. **Authentication:** Send `x-storeid` and `x-storesecret` (from Seekora dashboard). Optional: `x-user-id`, `x-anon-id`, `x-session-id` for personalization. Supports pagination, filters, facets, sorting, snippets, and autocomplete suggestions. Use `widget_mode: true` for lightweight widget results.
|
|
3537
|
+
* @summary Search (POST)
|
|
3538
|
+
* @param {string} xStoreid Store ID (from dashboard)
|
|
3539
|
+
* @param {string} xStoresecret Store read secret (from dashboard)
|
|
3540
|
+
* @param {DataTypesPublicSearchRequest} dataTypesPublicSearchRequest Search query, filters, pagination, and options
|
|
3541
|
+
* @param {string} [xUserId] User ID for personalization
|
|
3542
|
+
* @param {string} [xAnonId] Anonymous user ID for personalization
|
|
3006
3543
|
* @param {string} [xSessionId] Session ID for personalization
|
|
3007
3544
|
* @param {*} [options] Override http request option.
|
|
3008
3545
|
* @throws {RequiredError}
|
|
@@ -3060,13 +3597,13 @@ const SearchApiFp = function (configuration) {
|
|
|
3060
3597
|
const localVarAxiosParamCreator = (0, exports.SearchApiAxiosParamCreator)(configuration);
|
|
3061
3598
|
return {
|
|
3062
3599
|
/**
|
|
3063
|
-
*
|
|
3064
|
-
* @summary
|
|
3065
|
-
* @param {string} xStoreid Store ID
|
|
3066
|
-
* @param {string} xStoresecret Store
|
|
3600
|
+
* 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.
|
|
3601
|
+
* @summary Search (GET)
|
|
3602
|
+
* @param {string} xStoreid Store ID (from dashboard)
|
|
3603
|
+
* @param {string} xStoresecret Store read secret (from dashboard)
|
|
3067
3604
|
* @param {string} q Search query
|
|
3068
3605
|
* @param {string} [xUserId] User ID for personalization
|
|
3069
|
-
* @param {string} [xAnonId] Anonymous ID for personalization
|
|
3606
|
+
* @param {string} [xAnonId] Anonymous user ID for personalization
|
|
3070
3607
|
* @param {string} [xSessionId] Session ID for personalization
|
|
3071
3608
|
* @param {number} [page] Page number (default: 1)
|
|
3072
3609
|
* @param {number} [perPage] Items per page (default: 10)
|
|
@@ -3115,13 +3652,13 @@ const SearchApiFp = function (configuration) {
|
|
|
3115
3652
|
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
3116
3653
|
},
|
|
3117
3654
|
/**
|
|
3118
|
-
*
|
|
3119
|
-
* @summary
|
|
3120
|
-
* @param {string} xStoreid Store ID
|
|
3121
|
-
* @param {string} xStoresecret Store
|
|
3122
|
-
* @param {DataTypesPublicSearchRequest} dataTypesPublicSearchRequest Search
|
|
3123
|
-
* @param {string} [xUserId] User ID for personalization
|
|
3124
|
-
* @param {string} [xAnonId] Anonymous ID for personalization
|
|
3655
|
+
* Run a full-text search for your store. **Authentication:** Send `x-storeid` and `x-storesecret` (from Seekora dashboard). Optional: `x-user-id`, `x-anon-id`, `x-session-id` for personalization. Supports pagination, filters, facets, sorting, snippets, and autocomplete suggestions. Use `widget_mode: true` for lightweight widget results.
|
|
3656
|
+
* @summary Search (POST)
|
|
3657
|
+
* @param {string} xStoreid Store ID (from dashboard)
|
|
3658
|
+
* @param {string} xStoresecret Store read secret (from dashboard)
|
|
3659
|
+
* @param {DataTypesPublicSearchRequest} dataTypesPublicSearchRequest Search query, filters, pagination, and options
|
|
3660
|
+
* @param {string} [xUserId] User ID for personalization
|
|
3661
|
+
* @param {string} [xAnonId] Anonymous user ID for personalization
|
|
3125
3662
|
* @param {string} [xSessionId] Session ID for personalization
|
|
3126
3663
|
* @param {*} [options] Override http request option.
|
|
3127
3664
|
* @throws {RequiredError}
|
|
@@ -3142,13 +3679,13 @@ const SearchApiFactory = function (configuration, basePath, axios) {
|
|
|
3142
3679
|
const localVarFp = (0, exports.SearchApiFp)(configuration);
|
|
3143
3680
|
return {
|
|
3144
3681
|
/**
|
|
3145
|
-
*
|
|
3146
|
-
* @summary
|
|
3147
|
-
* @param {string} xStoreid Store ID
|
|
3148
|
-
* @param {string} xStoresecret Store
|
|
3682
|
+
* 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.
|
|
3683
|
+
* @summary Search (GET)
|
|
3684
|
+
* @param {string} xStoreid Store ID (from dashboard)
|
|
3685
|
+
* @param {string} xStoresecret Store read secret (from dashboard)
|
|
3149
3686
|
* @param {string} q Search query
|
|
3150
3687
|
* @param {string} [xUserId] User ID for personalization
|
|
3151
|
-
* @param {string} [xAnonId] Anonymous ID for personalization
|
|
3688
|
+
* @param {string} [xAnonId] Anonymous user ID for personalization
|
|
3152
3689
|
* @param {string} [xSessionId] Session ID for personalization
|
|
3153
3690
|
* @param {number} [page] Page number (default: 1)
|
|
3154
3691
|
* @param {number} [perPage] Items per page (default: 10)
|
|
@@ -3194,13 +3731,13 @@ const SearchApiFactory = function (configuration, basePath, axios) {
|
|
|
3194
3731
|
return localVarFp.v1SearchGet(xStoreid, xStoresecret, q, xUserId, xAnonId, xSessionId, page, perPage, sortBy, filterBy, facetBy, maxFacetValues, widgetMode, includeSuggestions, suggestionsLimit, analyticsTags, stopwordSets, synonymSets, searchFields, returnFields, omitFields, snippetFields, fullSnippetFields, fieldWeights, groupField, groupSize, snippetPrefix, snippetSuffix, snippetTokenLimit, snippetMinLen, includeSnippets, prefixMode, infixMode, typoMax, typoMinLen1, typoMinLen2, searchTimeoutMs, requireAllTerms, exactMatchBoost, cacheResults, applyRules, presetName, facetSearchText, options).then((request) => request(axios, basePath));
|
|
3195
3732
|
},
|
|
3196
3733
|
/**
|
|
3197
|
-
*
|
|
3198
|
-
* @summary
|
|
3199
|
-
* @param {string} xStoreid Store ID
|
|
3200
|
-
* @param {string} xStoresecret Store
|
|
3201
|
-
* @param {DataTypesPublicSearchRequest} dataTypesPublicSearchRequest Search
|
|
3202
|
-
* @param {string} [xUserId] User ID for personalization
|
|
3203
|
-
* @param {string} [xAnonId] Anonymous ID for personalization
|
|
3734
|
+
* Run a full-text search for your store. **Authentication:** Send `x-storeid` and `x-storesecret` (from Seekora dashboard). Optional: `x-user-id`, `x-anon-id`, `x-session-id` for personalization. Supports pagination, filters, facets, sorting, snippets, and autocomplete suggestions. Use `widget_mode: true` for lightweight widget results.
|
|
3735
|
+
* @summary Search (POST)
|
|
3736
|
+
* @param {string} xStoreid Store ID (from dashboard)
|
|
3737
|
+
* @param {string} xStoresecret Store read secret (from dashboard)
|
|
3738
|
+
* @param {DataTypesPublicSearchRequest} dataTypesPublicSearchRequest Search query, filters, pagination, and options
|
|
3739
|
+
* @param {string} [xUserId] User ID for personalization
|
|
3740
|
+
* @param {string} [xAnonId] Anonymous user ID for personalization
|
|
3204
3741
|
* @param {string} [xSessionId] Session ID for personalization
|
|
3205
3742
|
* @param {*} [options] Override http request option.
|
|
3206
3743
|
* @throws {RequiredError}
|
|
@@ -3216,13 +3753,13 @@ exports.SearchApiFactory = SearchApiFactory;
|
|
|
3216
3753
|
*/
|
|
3217
3754
|
class SearchApi extends base_1.BaseAPI {
|
|
3218
3755
|
/**
|
|
3219
|
-
*
|
|
3220
|
-
* @summary
|
|
3221
|
-
* @param {string} xStoreid Store ID
|
|
3222
|
-
* @param {string} xStoresecret Store
|
|
3756
|
+
* 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.
|
|
3757
|
+
* @summary Search (GET)
|
|
3758
|
+
* @param {string} xStoreid Store ID (from dashboard)
|
|
3759
|
+
* @param {string} xStoresecret Store read secret (from dashboard)
|
|
3223
3760
|
* @param {string} q Search query
|
|
3224
3761
|
* @param {string} [xUserId] User ID for personalization
|
|
3225
|
-
* @param {string} [xAnonId] Anonymous ID for personalization
|
|
3762
|
+
* @param {string} [xAnonId] Anonymous user ID for personalization
|
|
3226
3763
|
* @param {string} [xSessionId] Session ID for personalization
|
|
3227
3764
|
* @param {number} [page] Page number (default: 1)
|
|
3228
3765
|
* @param {number} [perPage] Items per page (default: 10)
|
|
@@ -3268,13 +3805,13 @@ class SearchApi extends base_1.BaseAPI {
|
|
|
3268
3805
|
return (0, exports.SearchApiFp)(this.configuration).v1SearchGet(xStoreid, xStoresecret, q, xUserId, xAnonId, xSessionId, page, perPage, sortBy, filterBy, facetBy, maxFacetValues, widgetMode, includeSuggestions, suggestionsLimit, analyticsTags, stopwordSets, synonymSets, searchFields, returnFields, omitFields, snippetFields, fullSnippetFields, fieldWeights, groupField, groupSize, snippetPrefix, snippetSuffix, snippetTokenLimit, snippetMinLen, includeSnippets, prefixMode, infixMode, typoMax, typoMinLen1, typoMinLen2, searchTimeoutMs, requireAllTerms, exactMatchBoost, cacheResults, applyRules, presetName, facetSearchText, options).then((request) => request(this.axios, this.basePath));
|
|
3269
3806
|
}
|
|
3270
3807
|
/**
|
|
3271
|
-
*
|
|
3272
|
-
* @summary
|
|
3273
|
-
* @param {string} xStoreid Store ID
|
|
3274
|
-
* @param {string} xStoresecret Store
|
|
3275
|
-
* @param {DataTypesPublicSearchRequest} dataTypesPublicSearchRequest Search
|
|
3276
|
-
* @param {string} [xUserId] User ID for personalization
|
|
3277
|
-
* @param {string} [xAnonId] Anonymous ID for personalization
|
|
3808
|
+
* Run a full-text search for your store. **Authentication:** Send `x-storeid` and `x-storesecret` (from Seekora dashboard). Optional: `x-user-id`, `x-anon-id`, `x-session-id` for personalization. Supports pagination, filters, facets, sorting, snippets, and autocomplete suggestions. Use `widget_mode: true` for lightweight widget results.
|
|
3809
|
+
* @summary Search (POST)
|
|
3810
|
+
* @param {string} xStoreid Store ID (from dashboard)
|
|
3811
|
+
* @param {string} xStoresecret Store read secret (from dashboard)
|
|
3812
|
+
* @param {DataTypesPublicSearchRequest} dataTypesPublicSearchRequest Search query, filters, pagination, and options
|
|
3813
|
+
* @param {string} [xUserId] User ID for personalization
|
|
3814
|
+
* @param {string} [xAnonId] Anonymous user ID for personalization
|
|
3278
3815
|
* @param {string} [xSessionId] Session ID for personalization
|
|
3279
3816
|
* @param {*} [options] Override http request option.
|
|
3280
3817
|
* @throws {RequiredError}
|