@seekora-ai/search-sdk 0.2.15 → 0.2.16
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 +1 -4
- package/dist/client.js +13 -16
- package/dist/generated/api.d.ts +1689 -11710
- package/dist/generated/api.js +1292 -2048
- package/package.json +1 -1
package/dist/generated/api.js
CHANGED
|
@@ -16,205 +16,13 @@ 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.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;
|
|
19
|
+
exports.StoreManagementApi = exports.StoreManagementApiFactory = exports.StoreManagementApiFp = exports.StoreManagementApiAxiosParamCreator = exports.SearchApi = exports.SearchApiFactory = exports.SearchApiFp = exports.SearchApiAxiosParamCreator = exports.SDKExperimentsApi = exports.SDKExperimentsApiFactory = exports.SDKExperimentsApiFp = exports.SDKExperimentsApiAxiosParamCreator = exports.V1SuggestionsQueriesGetTimeRangeEnum = exports.V1SuggestionsQueriesGetTagsMatchModeEnum = exports.QuerySuggestionsApi = exports.QuerySuggestionsApiFactory = exports.QuerySuggestionsApiFp = exports.QuerySuggestionsApiAxiosParamCreator = exports.FiltersApi = exports.FiltersApiFactory = exports.FiltersApiFp = exports.FiltersApiAxiosParamCreator = exports.AnalyticsEventsApi = exports.AnalyticsEventsApiFactory = exports.AnalyticsEventsApiFp = exports.AnalyticsEventsApiAxiosParamCreator = exports.QuerySuggestionsServiceRuleType = exports.QuerySuggestionsServiceBannedMatchType = void 0;
|
|
21
20
|
const axios_1 = __importDefault(require("axios"));
|
|
22
21
|
// Some imports not used depending on template conditions
|
|
23
22
|
// @ts-ignore
|
|
24
23
|
const common_1 = require("./common");
|
|
25
24
|
// @ts-ignore
|
|
26
25
|
const base_1 = require("./base");
|
|
27
|
-
exports.AnalyticsRuleType = {
|
|
28
|
-
RuleTypeFreshness: 'freshness',
|
|
29
|
-
RuleTypeVolume: 'volume',
|
|
30
|
-
RuleTypeSchema: 'schema',
|
|
31
|
-
RuleTypeAnomaly: 'anomaly',
|
|
32
|
-
RuleTypeCardinality: 'cardinality',
|
|
33
|
-
RuleTypeCompleteness: 'completeness',
|
|
34
|
-
RuleTypeCustom: 'custom'
|
|
35
|
-
};
|
|
36
|
-
exports.AnalyticsThresholdType = {
|
|
37
|
-
ThresholdMin: 'min',
|
|
38
|
-
ThresholdMax: 'max',
|
|
39
|
-
ThresholdRange: 'range',
|
|
40
|
-
ThresholdStdDev: 'stddev'
|
|
41
|
-
};
|
|
42
|
-
exports.ConnectorsCreateConnectorRequestConnectorTypeEnum = {
|
|
43
|
-
Import: 'import',
|
|
44
|
-
Export: 'export'
|
|
45
|
-
};
|
|
46
|
-
exports.DataTypesAcceptInvitationWithOAuthRequestTypeEnum = {
|
|
47
|
-
Google: 'google',
|
|
48
|
-
Github: 'github'
|
|
49
|
-
};
|
|
50
|
-
exports.DataTypesBillingAlertRequestAlertTypeEnum = {
|
|
51
|
-
LowBalance: 'low_balance',
|
|
52
|
-
DaysRemaining: 'days_remaining'
|
|
53
|
-
};
|
|
54
|
-
exports.DataTypesBillingAlertRequestThresholdUnitEnum = {
|
|
55
|
-
Credits: 'credits',
|
|
56
|
-
Days: 'days',
|
|
57
|
-
Percentage: 'percentage'
|
|
58
|
-
};
|
|
59
|
-
exports.DataTypesCreateCustomWordListRequestTypeEnum = {
|
|
60
|
-
Stopwords: 'stopwords',
|
|
61
|
-
Synonyms: 'synonyms'
|
|
62
|
-
};
|
|
63
|
-
exports.DataTypesCreatePaymentOrderRequestPaymentTypeEnum = {
|
|
64
|
-
Generic: 'generic',
|
|
65
|
-
Subscription: 'subscription',
|
|
66
|
-
CreditTopup: 'credit_topup'
|
|
67
|
-
};
|
|
68
|
-
exports.DataTypesCreatePluralDeclensionRequestTypeEnum = {
|
|
69
|
-
Custom: 'custom',
|
|
70
|
-
Default: 'default'
|
|
71
|
-
};
|
|
72
|
-
exports.DataTypesCreateRefundRequestDtoRefundTypeEnum = {
|
|
73
|
-
Full: 'full',
|
|
74
|
-
Partial: 'partial',
|
|
75
|
-
CreditOnly: 'credit_only'
|
|
76
|
-
};
|
|
77
|
-
exports.DataTypesCreateTaskRequestFrequencyEnum = {
|
|
78
|
-
Once: 'once',
|
|
79
|
-
Hourly: 'hourly',
|
|
80
|
-
Daily: 'daily',
|
|
81
|
-
Weekly: 'weekly'
|
|
82
|
-
};
|
|
83
|
-
exports.DataTypesCreateTaskRequestIndexingStrategyEnum = {
|
|
84
|
-
Replace: 'replace',
|
|
85
|
-
Upsert: 'upsert',
|
|
86
|
-
InsertOnly: 'insert_only',
|
|
87
|
-
UpdateOnly: 'update_only'
|
|
88
|
-
};
|
|
89
|
-
exports.DataTypesCreateTaskRequestTypeEnum = {
|
|
90
|
-
UrlCsv: 'url_csv',
|
|
91
|
-
Webhook: 'webhook',
|
|
92
|
-
Manual: 'manual',
|
|
93
|
-
PluginConnector: 'plugin_connector'
|
|
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
|
-
};
|
|
111
|
-
exports.DataTypesGrantStoreAccessRequestAccessLevelEnum = {
|
|
112
|
-
Read: 'read',
|
|
113
|
-
Write: 'write',
|
|
114
|
-
Admin: 'admin'
|
|
115
|
-
};
|
|
116
|
-
exports.DataTypesNotificationChannel = {
|
|
117
|
-
ChannelEmail: 'email',
|
|
118
|
-
ChannelSMS: 'sms',
|
|
119
|
-
ChannelPush: 'push',
|
|
120
|
-
ChannelWebSocket: 'websocket',
|
|
121
|
-
ChannelWhatsApp: 'whatsapp'
|
|
122
|
-
};
|
|
123
|
-
exports.DataTypesNotificationPriority = {
|
|
124
|
-
PriorityLow: 'low',
|
|
125
|
-
PriorityNormal: 'normal',
|
|
126
|
-
PriorityHigh: 'high',
|
|
127
|
-
PriorityCritical: 'critical'
|
|
128
|
-
};
|
|
129
|
-
exports.DataTypesNotificationStatus = {
|
|
130
|
-
StatusPending: 'pending',
|
|
131
|
-
StatusProcessing: 'processing',
|
|
132
|
-
StatusSent: 'sent',
|
|
133
|
-
StatusDelivered: 'delivered',
|
|
134
|
-
StatusFailed: 'failed',
|
|
135
|
-
StatusRead: 'read',
|
|
136
|
-
StatusScheduled: 'scheduled',
|
|
137
|
-
StatusCancelled: 'cancelled'
|
|
138
|
-
};
|
|
139
|
-
exports.DataTypesNotificationType = {
|
|
140
|
-
TypeSystem: 'system',
|
|
141
|
-
TypeAlert: 'alert',
|
|
142
|
-
TypeInfo: 'info',
|
|
143
|
-
TypeWarning: 'warning',
|
|
144
|
-
TypeError: 'error',
|
|
145
|
-
TypeSuccess: 'success',
|
|
146
|
-
TypeMarketing: 'marketing',
|
|
147
|
-
TypeTransactional: 'transactional',
|
|
148
|
-
TypeSecurity: 'security',
|
|
149
|
-
TypeBilling: 'billing',
|
|
150
|
-
TypeOrder: 'order',
|
|
151
|
-
TypeProduct: 'product',
|
|
152
|
-
TypeCustom: 'custom'
|
|
153
|
-
};
|
|
154
|
-
exports.DataTypesProcessRefundRequestDtoRefundTypeEnum = {
|
|
155
|
-
Full: 'full',
|
|
156
|
-
Partial: 'partial',
|
|
157
|
-
RemainingCredits: 'remaining_credits'
|
|
158
|
-
};
|
|
159
|
-
exports.DataTypesRefundApprovalDtoActionEnum = {
|
|
160
|
-
Approve: 'approve',
|
|
161
|
-
Reject: 'reject'
|
|
162
|
-
};
|
|
163
|
-
exports.DataTypesRefundCalculationRequestDtoRefundTypeEnum = {
|
|
164
|
-
Full: 'full',
|
|
165
|
-
Partial: 'partial',
|
|
166
|
-
RemainingCredits: 'remaining_credits'
|
|
167
|
-
};
|
|
168
|
-
exports.DataTypesStoreAccessRequestAccessLevelEnum = {
|
|
169
|
-
Read: 'read',
|
|
170
|
-
Write: 'write',
|
|
171
|
-
Admin: 'admin'
|
|
172
|
-
};
|
|
173
|
-
exports.DataTypesStoreLevelMenuRightAccessLevelEnum = {
|
|
174
|
-
Read: 'read',
|
|
175
|
-
Write: 'write',
|
|
176
|
-
Admin: 'admin'
|
|
177
|
-
};
|
|
178
|
-
exports.DataTypesUpdateMemberRoleRequestMemberRoleEnum = {
|
|
179
|
-
Owner: 'owner',
|
|
180
|
-
Admin: 'admin',
|
|
181
|
-
Member: 'member'
|
|
182
|
-
};
|
|
183
|
-
exports.DataTypesUpdatePluralDeclensionRequestTypeEnum = {
|
|
184
|
-
Custom: 'custom',
|
|
185
|
-
Default: 'default'
|
|
186
|
-
};
|
|
187
|
-
exports.DataTypesUpdateStoreAccessRequestAccessLevelEnum = {
|
|
188
|
-
Read: 'read',
|
|
189
|
-
Write: 'write',
|
|
190
|
-
Admin: 'admin'
|
|
191
|
-
};
|
|
192
|
-
exports.DataTypesUpdateWordStatusRequestWordTypeEnum = {
|
|
193
|
-
Default: 'default',
|
|
194
|
-
StoreLanguage: 'store_language',
|
|
195
|
-
Custom: 'custom'
|
|
196
|
-
};
|
|
197
|
-
exports.MenuRoutesAddMenuRequestMenuLevelEnum = {
|
|
198
|
-
Org: 'org',
|
|
199
|
-
Store: 'store'
|
|
200
|
-
};
|
|
201
|
-
exports.MenuRoutesAddMenuRequestMenuLocationEnum = {
|
|
202
|
-
Navbar: 'navbar',
|
|
203
|
-
ProfileDropdown: 'profile_dropdown'
|
|
204
|
-
};
|
|
205
|
-
exports.MenuRoutesAddMenuRequestModuleTypeEnum = {
|
|
206
|
-
Admin: 'Admin',
|
|
207
|
-
Search: 'Search',
|
|
208
|
-
Billing: 'Billing'
|
|
209
|
-
};
|
|
210
|
-
exports.ModelsCreateCustomEventFieldRequestFieldTypeEnum = {
|
|
211
|
-
String: 'string',
|
|
212
|
-
Number: 'number',
|
|
213
|
-
Boolean: 'boolean',
|
|
214
|
-
Datetime: 'datetime',
|
|
215
|
-
Array: 'array',
|
|
216
|
-
Object: 'object'
|
|
217
|
-
};
|
|
218
26
|
exports.QuerySuggestionsServiceBannedMatchType = {
|
|
219
27
|
BannedMatchIs: 'is',
|
|
220
28
|
BannedMatchContains: 'contains',
|
|
@@ -222,416 +30,12 @@ exports.QuerySuggestionsServiceBannedMatchType = {
|
|
|
222
30
|
BannedMatchEndsWith: 'endsWith',
|
|
223
31
|
BannedMatchCustom: 'custom'
|
|
224
32
|
};
|
|
225
|
-
exports.QuerySuggestionsServiceBulkOperation = {
|
|
226
|
-
BulkEnable: 'enable',
|
|
227
|
-
BulkDisable: 'disable',
|
|
228
|
-
BulkDelete: 'delete',
|
|
229
|
-
BulkUpdatePriority: 'update_priority'
|
|
230
|
-
};
|
|
231
|
-
exports.QuerySuggestionsServiceQuerySuggestionSource = {
|
|
232
|
-
SourceAutoGenerated: 'auto_generated',
|
|
233
|
-
SourceManual: 'manual',
|
|
234
|
-
SourceImported: 'imported'
|
|
235
|
-
};
|
|
236
|
-
exports.QuerySuggestionsServiceQuerySuggestionStatus = {
|
|
237
|
-
StatusEnabled: 'enabled',
|
|
238
|
-
StatusDisabled: 'disabled'
|
|
239
|
-
};
|
|
240
33
|
exports.QuerySuggestionsServiceRuleType = {
|
|
241
34
|
RuleTypePromote: 'promote',
|
|
242
35
|
RuleTypeHide: 'hide',
|
|
243
36
|
RuleTypeRedirect: 'redirect',
|
|
244
37
|
RuleTypeBanner: 'banner'
|
|
245
38
|
};
|
|
246
|
-
exports.RefundRefundPreviewRequestDtoRefundTypeEnum = {
|
|
247
|
-
Full: 'full',
|
|
248
|
-
Partial: 'partial',
|
|
249
|
-
RemainingCredits: 'remaining_credits'
|
|
250
|
-
};
|
|
251
|
-
/**
|
|
252
|
-
* ActivityLogsApi - axios parameter creator
|
|
253
|
-
*/
|
|
254
|
-
const ActivityLogsApiAxiosParamCreator = function (configuration) {
|
|
255
|
-
return {
|
|
256
|
-
/**
|
|
257
|
-
* Retrieve user activity logs from ClickHouse fact_events table with full filtering, search, and pagination.
|
|
258
|
-
* @summary Get Activity Logs
|
|
259
|
-
* @param {string} [startDate] Start date (ISO 8601 format)
|
|
260
|
-
* @param {string} [endDate] End date (ISO 8601 format)
|
|
261
|
-
* @param {string} [search] Search text (matches description, username, email, resource_type, resource_id)
|
|
262
|
-
* @param {AnalyticsActivityLogsGetActionEnum} [action] Action filter
|
|
263
|
-
* @param {string} [entity] Entity type filter
|
|
264
|
-
* @param {number} [page] Page number (default: 1)
|
|
265
|
-
* @param {number} [perPage] Results per page (default: 50, max: 1000)
|
|
266
|
-
* @param {*} [options] Override http request option.
|
|
267
|
-
* @throws {RequiredError}
|
|
268
|
-
*/
|
|
269
|
-
analyticsActivityLogsGet: async (startDate, endDate, search, action, entity, page, perPage, options = {}) => {
|
|
270
|
-
const localVarPath = `/analytics/activity-logs`;
|
|
271
|
-
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
272
|
-
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
273
|
-
let baseOptions;
|
|
274
|
-
if (configuration) {
|
|
275
|
-
baseOptions = configuration.baseOptions;
|
|
276
|
-
}
|
|
277
|
-
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options };
|
|
278
|
-
const localVarHeaderParameter = {};
|
|
279
|
-
const localVarQueryParameter = {};
|
|
280
|
-
// authentication BearerAuth required
|
|
281
|
-
await (0, common_1.setApiKeyToObject)(localVarHeaderParameter, "Authorization", configuration);
|
|
282
|
-
if (startDate !== undefined) {
|
|
283
|
-
localVarQueryParameter['start_date'] = startDate;
|
|
284
|
-
}
|
|
285
|
-
if (endDate !== undefined) {
|
|
286
|
-
localVarQueryParameter['end_date'] = endDate;
|
|
287
|
-
}
|
|
288
|
-
if (search !== undefined) {
|
|
289
|
-
localVarQueryParameter['search'] = search;
|
|
290
|
-
}
|
|
291
|
-
if (action !== undefined) {
|
|
292
|
-
localVarQueryParameter['action'] = action;
|
|
293
|
-
}
|
|
294
|
-
if (entity !== undefined) {
|
|
295
|
-
localVarQueryParameter['entity'] = entity;
|
|
296
|
-
}
|
|
297
|
-
if (page !== undefined) {
|
|
298
|
-
localVarQueryParameter['page'] = page;
|
|
299
|
-
}
|
|
300
|
-
if (perPage !== undefined) {
|
|
301
|
-
localVarQueryParameter['per_page'] = perPage;
|
|
302
|
-
}
|
|
303
|
-
localVarHeaderParameter['Accept'] = 'application/json';
|
|
304
|
-
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
305
|
-
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
306
|
-
localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
|
|
307
|
-
return {
|
|
308
|
-
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
309
|
-
options: localVarRequestOptions,
|
|
310
|
-
};
|
|
311
|
-
},
|
|
312
|
-
};
|
|
313
|
-
};
|
|
314
|
-
exports.ActivityLogsApiAxiosParamCreator = ActivityLogsApiAxiosParamCreator;
|
|
315
|
-
/**
|
|
316
|
-
* ActivityLogsApi - functional programming interface
|
|
317
|
-
*/
|
|
318
|
-
const ActivityLogsApiFp = function (configuration) {
|
|
319
|
-
const localVarAxiosParamCreator = (0, exports.ActivityLogsApiAxiosParamCreator)(configuration);
|
|
320
|
-
return {
|
|
321
|
-
/**
|
|
322
|
-
* Retrieve user activity logs from ClickHouse fact_events table with full filtering, search, and pagination.
|
|
323
|
-
* @summary Get Activity Logs
|
|
324
|
-
* @param {string} [startDate] Start date (ISO 8601 format)
|
|
325
|
-
* @param {string} [endDate] End date (ISO 8601 format)
|
|
326
|
-
* @param {string} [search] Search text (matches description, username, email, resource_type, resource_id)
|
|
327
|
-
* @param {AnalyticsActivityLogsGetActionEnum} [action] Action filter
|
|
328
|
-
* @param {string} [entity] Entity type filter
|
|
329
|
-
* @param {number} [page] Page number (default: 1)
|
|
330
|
-
* @param {number} [perPage] Results per page (default: 50, max: 1000)
|
|
331
|
-
* @param {*} [options] Override http request option.
|
|
332
|
-
* @throws {RequiredError}
|
|
333
|
-
*/
|
|
334
|
-
async analyticsActivityLogsGet(startDate, endDate, search, action, entity, page, perPage, options) {
|
|
335
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.analyticsActivityLogsGet(startDate, endDate, search, action, entity, page, perPage, options);
|
|
336
|
-
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
337
|
-
const localVarOperationServerBasePath = base_1.operationServerMap['ActivityLogsApi.analyticsActivityLogsGet']?.[localVarOperationServerIndex]?.url;
|
|
338
|
-
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
339
|
-
},
|
|
340
|
-
};
|
|
341
|
-
};
|
|
342
|
-
exports.ActivityLogsApiFp = ActivityLogsApiFp;
|
|
343
|
-
/**
|
|
344
|
-
* ActivityLogsApi - factory interface
|
|
345
|
-
*/
|
|
346
|
-
const ActivityLogsApiFactory = function (configuration, basePath, axios) {
|
|
347
|
-
const localVarFp = (0, exports.ActivityLogsApiFp)(configuration);
|
|
348
|
-
return {
|
|
349
|
-
/**
|
|
350
|
-
* Retrieve user activity logs from ClickHouse fact_events table with full filtering, search, and pagination.
|
|
351
|
-
* @summary Get Activity Logs
|
|
352
|
-
* @param {string} [startDate] Start date (ISO 8601 format)
|
|
353
|
-
* @param {string} [endDate] End date (ISO 8601 format)
|
|
354
|
-
* @param {string} [search] Search text (matches description, username, email, resource_type, resource_id)
|
|
355
|
-
* @param {AnalyticsActivityLogsGetActionEnum} [action] Action filter
|
|
356
|
-
* @param {string} [entity] Entity type filter
|
|
357
|
-
* @param {number} [page] Page number (default: 1)
|
|
358
|
-
* @param {number} [perPage] Results per page (default: 50, max: 1000)
|
|
359
|
-
* @param {*} [options] Override http request option.
|
|
360
|
-
* @throws {RequiredError}
|
|
361
|
-
*/
|
|
362
|
-
analyticsActivityLogsGet(startDate, endDate, search, action, entity, page, perPage, options) {
|
|
363
|
-
return localVarFp.analyticsActivityLogsGet(startDate, endDate, search, action, entity, page, perPage, options).then((request) => request(axios, basePath));
|
|
364
|
-
},
|
|
365
|
-
};
|
|
366
|
-
};
|
|
367
|
-
exports.ActivityLogsApiFactory = ActivityLogsApiFactory;
|
|
368
|
-
/**
|
|
369
|
-
* ActivityLogsApi - object-oriented interface
|
|
370
|
-
*/
|
|
371
|
-
class ActivityLogsApi extends base_1.BaseAPI {
|
|
372
|
-
/**
|
|
373
|
-
* Retrieve user activity logs from ClickHouse fact_events table with full filtering, search, and pagination.
|
|
374
|
-
* @summary Get Activity Logs
|
|
375
|
-
* @param {string} [startDate] Start date (ISO 8601 format)
|
|
376
|
-
* @param {string} [endDate] End date (ISO 8601 format)
|
|
377
|
-
* @param {string} [search] Search text (matches description, username, email, resource_type, resource_id)
|
|
378
|
-
* @param {AnalyticsActivityLogsGetActionEnum} [action] Action filter
|
|
379
|
-
* @param {string} [entity] Entity type filter
|
|
380
|
-
* @param {number} [page] Page number (default: 1)
|
|
381
|
-
* @param {number} [perPage] Results per page (default: 50, max: 1000)
|
|
382
|
-
* @param {*} [options] Override http request option.
|
|
383
|
-
* @throws {RequiredError}
|
|
384
|
-
*/
|
|
385
|
-
analyticsActivityLogsGet(startDate, endDate, search, action, entity, page, perPage, options) {
|
|
386
|
-
return (0, exports.ActivityLogsApiFp)(this.configuration).analyticsActivityLogsGet(startDate, endDate, search, action, entity, page, perPage, options).then((request) => request(this.axios, this.basePath));
|
|
387
|
-
}
|
|
388
|
-
}
|
|
389
|
-
exports.ActivityLogsApi = ActivityLogsApi;
|
|
390
|
-
exports.AnalyticsActivityLogsGetActionEnum = {
|
|
391
|
-
Create: 'create',
|
|
392
|
-
Update: 'update',
|
|
393
|
-
Delete: 'delete',
|
|
394
|
-
Upload: 'upload'
|
|
395
|
-
};
|
|
396
|
-
/**
|
|
397
|
-
* AnalyticsApi - axios parameter creator
|
|
398
|
-
*/
|
|
399
|
-
const AnalyticsApiAxiosParamCreator = function (configuration) {
|
|
400
|
-
return {
|
|
401
|
-
/**
|
|
402
|
-
* Retrieve API usage logs from ClickHouse fact_events table with filtering and pagination
|
|
403
|
-
* @summary Get API Usage Logs
|
|
404
|
-
* @param {string} [startDate] Start date (ISO 8601 format)
|
|
405
|
-
* @param {string} [endDate] End date (ISO 8601 format)
|
|
406
|
-
* @param {string} [method] HTTP method filter
|
|
407
|
-
* @param {string} [path] Path filter (partial match)
|
|
408
|
-
* @param {string} [storeId] Store ID filter
|
|
409
|
-
* @param {number} [page] Page number (default: 1)
|
|
410
|
-
* @param {number} [perPage] Results per page (default: 100, max: 1000)
|
|
411
|
-
* @param {*} [options] Override http request option.
|
|
412
|
-
* @throws {RequiredError}
|
|
413
|
-
*/
|
|
414
|
-
analyticsApiUsageGet: async (startDate, endDate, method, path, storeId, page, perPage, options = {}) => {
|
|
415
|
-
const localVarPath = `/analytics/api-usage`;
|
|
416
|
-
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
417
|
-
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
418
|
-
let baseOptions;
|
|
419
|
-
if (configuration) {
|
|
420
|
-
baseOptions = configuration.baseOptions;
|
|
421
|
-
}
|
|
422
|
-
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options };
|
|
423
|
-
const localVarHeaderParameter = {};
|
|
424
|
-
const localVarQueryParameter = {};
|
|
425
|
-
// authentication BearerAuth required
|
|
426
|
-
await (0, common_1.setApiKeyToObject)(localVarHeaderParameter, "Authorization", configuration);
|
|
427
|
-
if (startDate !== undefined) {
|
|
428
|
-
localVarQueryParameter['start_date'] = startDate;
|
|
429
|
-
}
|
|
430
|
-
if (endDate !== undefined) {
|
|
431
|
-
localVarQueryParameter['end_date'] = endDate;
|
|
432
|
-
}
|
|
433
|
-
if (method !== undefined) {
|
|
434
|
-
localVarQueryParameter['method'] = method;
|
|
435
|
-
}
|
|
436
|
-
if (path !== undefined) {
|
|
437
|
-
localVarQueryParameter['path'] = path;
|
|
438
|
-
}
|
|
439
|
-
if (storeId !== undefined) {
|
|
440
|
-
localVarQueryParameter['store_id'] = storeId;
|
|
441
|
-
}
|
|
442
|
-
if (page !== undefined) {
|
|
443
|
-
localVarQueryParameter['page'] = page;
|
|
444
|
-
}
|
|
445
|
-
if (perPage !== undefined) {
|
|
446
|
-
localVarQueryParameter['per_page'] = perPage;
|
|
447
|
-
}
|
|
448
|
-
localVarHeaderParameter['Accept'] = 'application/json';
|
|
449
|
-
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
450
|
-
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
451
|
-
localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
|
|
452
|
-
return {
|
|
453
|
-
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
454
|
-
options: localVarRequestOptions,
|
|
455
|
-
};
|
|
456
|
-
},
|
|
457
|
-
/**
|
|
458
|
-
* Retrieve API usage logs for a specific store from ClickHouse
|
|
459
|
-
* @summary Get Store API Usage Logs
|
|
460
|
-
* @param {string} storeId Store ID
|
|
461
|
-
* @param {string} [startDate] Start date (ISO 8601 format)
|
|
462
|
-
* @param {string} [endDate] End date (ISO 8601 format)
|
|
463
|
-
* @param {string} [method] HTTP method filter
|
|
464
|
-
* @param {number} [page] Page number (default: 1)
|
|
465
|
-
* @param {number} [perPage] Results per page (default: 100, max: 1000)
|
|
466
|
-
* @param {*} [options] Override http request option.
|
|
467
|
-
* @throws {RequiredError}
|
|
468
|
-
*/
|
|
469
|
-
analyticsApiUsageStoreStoreIdGet: async (storeId, startDate, endDate, method, page, perPage, options = {}) => {
|
|
470
|
-
// verify required parameter 'storeId' is not null or undefined
|
|
471
|
-
(0, common_1.assertParamExists)('analyticsApiUsageStoreStoreIdGet', 'storeId', storeId);
|
|
472
|
-
const localVarPath = `/analytics/api-usage/store/{storeId}`
|
|
473
|
-
.replace(`{${"storeId"}}`, encodeURIComponent(String(storeId)));
|
|
474
|
-
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
475
|
-
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
476
|
-
let baseOptions;
|
|
477
|
-
if (configuration) {
|
|
478
|
-
baseOptions = configuration.baseOptions;
|
|
479
|
-
}
|
|
480
|
-
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options };
|
|
481
|
-
const localVarHeaderParameter = {};
|
|
482
|
-
const localVarQueryParameter = {};
|
|
483
|
-
// authentication BearerAuth required
|
|
484
|
-
await (0, common_1.setApiKeyToObject)(localVarHeaderParameter, "Authorization", configuration);
|
|
485
|
-
if (startDate !== undefined) {
|
|
486
|
-
localVarQueryParameter['start_date'] = startDate;
|
|
487
|
-
}
|
|
488
|
-
if (endDate !== undefined) {
|
|
489
|
-
localVarQueryParameter['end_date'] = endDate;
|
|
490
|
-
}
|
|
491
|
-
if (method !== undefined) {
|
|
492
|
-
localVarQueryParameter['method'] = method;
|
|
493
|
-
}
|
|
494
|
-
if (page !== undefined) {
|
|
495
|
-
localVarQueryParameter['page'] = page;
|
|
496
|
-
}
|
|
497
|
-
if (perPage !== undefined) {
|
|
498
|
-
localVarQueryParameter['per_page'] = perPage;
|
|
499
|
-
}
|
|
500
|
-
localVarHeaderParameter['Accept'] = 'application/json';
|
|
501
|
-
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
502
|
-
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
503
|
-
localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
|
|
504
|
-
return {
|
|
505
|
-
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
506
|
-
options: localVarRequestOptions,
|
|
507
|
-
};
|
|
508
|
-
},
|
|
509
|
-
};
|
|
510
|
-
};
|
|
511
|
-
exports.AnalyticsApiAxiosParamCreator = AnalyticsApiAxiosParamCreator;
|
|
512
|
-
/**
|
|
513
|
-
* AnalyticsApi - functional programming interface
|
|
514
|
-
*/
|
|
515
|
-
const AnalyticsApiFp = function (configuration) {
|
|
516
|
-
const localVarAxiosParamCreator = (0, exports.AnalyticsApiAxiosParamCreator)(configuration);
|
|
517
|
-
return {
|
|
518
|
-
/**
|
|
519
|
-
* Retrieve API usage logs from ClickHouse fact_events table with filtering and pagination
|
|
520
|
-
* @summary Get API Usage Logs
|
|
521
|
-
* @param {string} [startDate] Start date (ISO 8601 format)
|
|
522
|
-
* @param {string} [endDate] End date (ISO 8601 format)
|
|
523
|
-
* @param {string} [method] HTTP method filter
|
|
524
|
-
* @param {string} [path] Path filter (partial match)
|
|
525
|
-
* @param {string} [storeId] Store ID filter
|
|
526
|
-
* @param {number} [page] Page number (default: 1)
|
|
527
|
-
* @param {number} [perPage] Results per page (default: 100, max: 1000)
|
|
528
|
-
* @param {*} [options] Override http request option.
|
|
529
|
-
* @throws {RequiredError}
|
|
530
|
-
*/
|
|
531
|
-
async analyticsApiUsageGet(startDate, endDate, method, path, storeId, page, perPage, options) {
|
|
532
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.analyticsApiUsageGet(startDate, endDate, method, path, storeId, page, perPage, options);
|
|
533
|
-
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
534
|
-
const localVarOperationServerBasePath = base_1.operationServerMap['AnalyticsApi.analyticsApiUsageGet']?.[localVarOperationServerIndex]?.url;
|
|
535
|
-
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
536
|
-
},
|
|
537
|
-
/**
|
|
538
|
-
* Retrieve API usage logs for a specific store from ClickHouse
|
|
539
|
-
* @summary Get Store API Usage Logs
|
|
540
|
-
* @param {string} storeId Store ID
|
|
541
|
-
* @param {string} [startDate] Start date (ISO 8601 format)
|
|
542
|
-
* @param {string} [endDate] End date (ISO 8601 format)
|
|
543
|
-
* @param {string} [method] HTTP method filter
|
|
544
|
-
* @param {number} [page] Page number (default: 1)
|
|
545
|
-
* @param {number} [perPage] Results per page (default: 100, max: 1000)
|
|
546
|
-
* @param {*} [options] Override http request option.
|
|
547
|
-
* @throws {RequiredError}
|
|
548
|
-
*/
|
|
549
|
-
async analyticsApiUsageStoreStoreIdGet(storeId, startDate, endDate, method, page, perPage, options) {
|
|
550
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.analyticsApiUsageStoreStoreIdGet(storeId, startDate, endDate, method, page, perPage, options);
|
|
551
|
-
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
552
|
-
const localVarOperationServerBasePath = base_1.operationServerMap['AnalyticsApi.analyticsApiUsageStoreStoreIdGet']?.[localVarOperationServerIndex]?.url;
|
|
553
|
-
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
554
|
-
},
|
|
555
|
-
};
|
|
556
|
-
};
|
|
557
|
-
exports.AnalyticsApiFp = AnalyticsApiFp;
|
|
558
|
-
/**
|
|
559
|
-
* AnalyticsApi - factory interface
|
|
560
|
-
*/
|
|
561
|
-
const AnalyticsApiFactory = function (configuration, basePath, axios) {
|
|
562
|
-
const localVarFp = (0, exports.AnalyticsApiFp)(configuration);
|
|
563
|
-
return {
|
|
564
|
-
/**
|
|
565
|
-
* Retrieve API usage logs from ClickHouse fact_events table with filtering and pagination
|
|
566
|
-
* @summary Get API Usage Logs
|
|
567
|
-
* @param {string} [startDate] Start date (ISO 8601 format)
|
|
568
|
-
* @param {string} [endDate] End date (ISO 8601 format)
|
|
569
|
-
* @param {string} [method] HTTP method filter
|
|
570
|
-
* @param {string} [path] Path filter (partial match)
|
|
571
|
-
* @param {string} [storeId] Store ID filter
|
|
572
|
-
* @param {number} [page] Page number (default: 1)
|
|
573
|
-
* @param {number} [perPage] Results per page (default: 100, max: 1000)
|
|
574
|
-
* @param {*} [options] Override http request option.
|
|
575
|
-
* @throws {RequiredError}
|
|
576
|
-
*/
|
|
577
|
-
analyticsApiUsageGet(startDate, endDate, method, path, storeId, page, perPage, options) {
|
|
578
|
-
return localVarFp.analyticsApiUsageGet(startDate, endDate, method, path, storeId, page, perPage, options).then((request) => request(axios, basePath));
|
|
579
|
-
},
|
|
580
|
-
/**
|
|
581
|
-
* Retrieve API usage logs for a specific store from ClickHouse
|
|
582
|
-
* @summary Get Store API Usage Logs
|
|
583
|
-
* @param {string} storeId Store ID
|
|
584
|
-
* @param {string} [startDate] Start date (ISO 8601 format)
|
|
585
|
-
* @param {string} [endDate] End date (ISO 8601 format)
|
|
586
|
-
* @param {string} [method] HTTP method filter
|
|
587
|
-
* @param {number} [page] Page number (default: 1)
|
|
588
|
-
* @param {number} [perPage] Results per page (default: 100, max: 1000)
|
|
589
|
-
* @param {*} [options] Override http request option.
|
|
590
|
-
* @throws {RequiredError}
|
|
591
|
-
*/
|
|
592
|
-
analyticsApiUsageStoreStoreIdGet(storeId, startDate, endDate, method, page, perPage, options) {
|
|
593
|
-
return localVarFp.analyticsApiUsageStoreStoreIdGet(storeId, startDate, endDate, method, page, perPage, options).then((request) => request(axios, basePath));
|
|
594
|
-
},
|
|
595
|
-
};
|
|
596
|
-
};
|
|
597
|
-
exports.AnalyticsApiFactory = AnalyticsApiFactory;
|
|
598
|
-
/**
|
|
599
|
-
* AnalyticsApi - object-oriented interface
|
|
600
|
-
*/
|
|
601
|
-
class AnalyticsApi extends base_1.BaseAPI {
|
|
602
|
-
/**
|
|
603
|
-
* Retrieve API usage logs from ClickHouse fact_events table with filtering and pagination
|
|
604
|
-
* @summary Get API Usage Logs
|
|
605
|
-
* @param {string} [startDate] Start date (ISO 8601 format)
|
|
606
|
-
* @param {string} [endDate] End date (ISO 8601 format)
|
|
607
|
-
* @param {string} [method] HTTP method filter
|
|
608
|
-
* @param {string} [path] Path filter (partial match)
|
|
609
|
-
* @param {string} [storeId] Store ID filter
|
|
610
|
-
* @param {number} [page] Page number (default: 1)
|
|
611
|
-
* @param {number} [perPage] Results per page (default: 100, max: 1000)
|
|
612
|
-
* @param {*} [options] Override http request option.
|
|
613
|
-
* @throws {RequiredError}
|
|
614
|
-
*/
|
|
615
|
-
analyticsApiUsageGet(startDate, endDate, method, path, storeId, page, perPage, options) {
|
|
616
|
-
return (0, exports.AnalyticsApiFp)(this.configuration).analyticsApiUsageGet(startDate, endDate, method, path, storeId, page, perPage, options).then((request) => request(this.axios, this.basePath));
|
|
617
|
-
}
|
|
618
|
-
/**
|
|
619
|
-
* Retrieve API usage logs for a specific store from ClickHouse
|
|
620
|
-
* @summary Get Store API Usage Logs
|
|
621
|
-
* @param {string} storeId Store ID
|
|
622
|
-
* @param {string} [startDate] Start date (ISO 8601 format)
|
|
623
|
-
* @param {string} [endDate] End date (ISO 8601 format)
|
|
624
|
-
* @param {string} [method] HTTP method filter
|
|
625
|
-
* @param {number} [page] Page number (default: 1)
|
|
626
|
-
* @param {number} [perPage] Results per page (default: 100, max: 1000)
|
|
627
|
-
* @param {*} [options] Override http request option.
|
|
628
|
-
* @throws {RequiredError}
|
|
629
|
-
*/
|
|
630
|
-
analyticsApiUsageStoreStoreIdGet(storeId, startDate, endDate, method, page, perPage, options) {
|
|
631
|
-
return (0, exports.AnalyticsApiFp)(this.configuration).analyticsApiUsageStoreStoreIdGet(storeId, startDate, endDate, method, page, perPage, options).then((request) => request(this.axios, this.basePath));
|
|
632
|
-
}
|
|
633
|
-
}
|
|
634
|
-
exports.AnalyticsApi = AnalyticsApi;
|
|
635
39
|
/**
|
|
636
40
|
* AnalyticsEventsApi - axios parameter creator
|
|
637
41
|
*/
|
|
@@ -1802,129 +1206,26 @@ exports.V1SuggestionsQueriesGetTimeRangeEnum = {
|
|
|
1802
1206
|
_90d: '90d'
|
|
1803
1207
|
};
|
|
1804
1208
|
/**
|
|
1805
|
-
*
|
|
1209
|
+
* SDKExperimentsApi - axios parameter creator
|
|
1806
1210
|
*/
|
|
1807
|
-
const
|
|
1211
|
+
const SDKExperimentsApiAxiosParamCreator = function (configuration) {
|
|
1808
1212
|
return {
|
|
1809
1213
|
/**
|
|
1810
|
-
*
|
|
1811
|
-
* @summary
|
|
1812
|
-
* @param {string} xStoreid Store ID
|
|
1813
|
-
* @param {string}
|
|
1814
|
-
* @param {string}
|
|
1815
|
-
* @param {
|
|
1214
|
+
* Returns variant assignments for all running experiments for the requesting user. Uses hash-based consistent assignment.
|
|
1215
|
+
* @summary Get experiment assignments for a user
|
|
1216
|
+
* @param {string} xStoreid Store ID
|
|
1217
|
+
* @param {string} xStoresecret Store read secret
|
|
1218
|
+
* @param {string} [xUserId] User ID (provide either x-user-id or x-anon-id)
|
|
1219
|
+
* @param {string} [xAnonId] Anonymous ID (provide either x-user-id or x-anon-id)
|
|
1816
1220
|
* @param {*} [options] Override http request option.
|
|
1817
1221
|
* @throws {RequiredError}
|
|
1818
1222
|
*/
|
|
1819
|
-
|
|
1223
|
+
v1ExperimentsAssignmentGet: async (xStoreid, xStoresecret, xUserId, xAnonId, options = {}) => {
|
|
1820
1224
|
// verify required parameter 'xStoreid' is not null or undefined
|
|
1821
|
-
(0, common_1.assertParamExists)('
|
|
1822
|
-
// verify required parameter 'xStoreWriteSecret' is not null or undefined
|
|
1823
|
-
(0, common_1.assertParamExists)('apiV1StoresXStoreIDDocumentsBulkPost', 'xStoreWriteSecret', xStoreWriteSecret);
|
|
1824
|
-
// verify required parameter 'xStoreID' is not null or undefined
|
|
1825
|
-
(0, common_1.assertParamExists)('apiV1StoresXStoreIDDocumentsBulkPost', 'xStoreID', xStoreID);
|
|
1826
|
-
// verify required parameter 'dataTypesBulkDocumentRequest' is not null or undefined
|
|
1827
|
-
(0, common_1.assertParamExists)('apiV1StoresXStoreIDDocumentsBulkPost', 'dataTypesBulkDocumentRequest', dataTypesBulkDocumentRequest);
|
|
1828
|
-
const localVarPath = `/api/v1/stores/{xStoreID}/documents/bulk`
|
|
1829
|
-
.replace(`{${"xStoreID"}}`, encodeURIComponent(String(xStoreID)));
|
|
1830
|
-
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
1831
|
-
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
1832
|
-
let baseOptions;
|
|
1833
|
-
if (configuration) {
|
|
1834
|
-
baseOptions = configuration.baseOptions;
|
|
1835
|
-
}
|
|
1836
|
-
const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options };
|
|
1837
|
-
const localVarHeaderParameter = {};
|
|
1838
|
-
const localVarQueryParameter = {};
|
|
1839
|
-
// authentication ApiKeyAuth required
|
|
1840
|
-
await (0, common_1.setApiKeyToObject)(localVarHeaderParameter, "x-storesecret", configuration);
|
|
1841
|
-
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
1842
|
-
localVarHeaderParameter['Accept'] = 'application/json';
|
|
1843
|
-
if (xStoreid != null) {
|
|
1844
|
-
localVarHeaderParameter['x-storeid'] = String(xStoreid);
|
|
1845
|
-
}
|
|
1846
|
-
if (xStoreWriteSecret != null) {
|
|
1847
|
-
localVarHeaderParameter['x-store-write-secret'] = String(xStoreWriteSecret);
|
|
1848
|
-
}
|
|
1849
|
-
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
1850
|
-
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
1851
|
-
localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
|
|
1852
|
-
localVarRequestOptions.data = (0, common_1.serializeDataIfNeeded)(dataTypesBulkDocumentRequest, localVarRequestOptions, configuration);
|
|
1853
|
-
return {
|
|
1854
|
-
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
1855
|
-
options: localVarRequestOptions,
|
|
1856
|
-
};
|
|
1857
|
-
},
|
|
1858
|
-
/**
|
|
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)
|
|
1864
|
-
* @param {string} documentID Document ID to delete
|
|
1865
|
-
* @param {*} [options] Override http request option.
|
|
1866
|
-
* @throws {RequiredError}
|
|
1867
|
-
*/
|
|
1868
|
-
apiV1StoresXStoreIDDocumentsDocumentIDDelete: async (xStoreid, xStoreWriteSecret, xStoreID, documentID, options = {}) => {
|
|
1869
|
-
// verify required parameter 'xStoreid' is not null or undefined
|
|
1870
|
-
(0, common_1.assertParamExists)('apiV1StoresXStoreIDDocumentsDocumentIDDelete', 'xStoreid', xStoreid);
|
|
1871
|
-
// verify required parameter 'xStoreWriteSecret' is not null or undefined
|
|
1872
|
-
(0, common_1.assertParamExists)('apiV1StoresXStoreIDDocumentsDocumentIDDelete', 'xStoreWriteSecret', xStoreWriteSecret);
|
|
1873
|
-
// verify required parameter 'xStoreID' is not null or undefined
|
|
1874
|
-
(0, common_1.assertParamExists)('apiV1StoresXStoreIDDocumentsDocumentIDDelete', 'xStoreID', xStoreID);
|
|
1875
|
-
// verify required parameter 'documentID' is not null or undefined
|
|
1876
|
-
(0, common_1.assertParamExists)('apiV1StoresXStoreIDDocumentsDocumentIDDelete', 'documentID', documentID);
|
|
1877
|
-
const localVarPath = `/api/v1/stores/{xStoreID}/documents/{documentID}`
|
|
1878
|
-
.replace(`{${"xStoreID"}}`, encodeURIComponent(String(xStoreID)))
|
|
1879
|
-
.replace(`{${"documentID"}}`, encodeURIComponent(String(documentID)));
|
|
1880
|
-
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
1881
|
-
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
1882
|
-
let baseOptions;
|
|
1883
|
-
if (configuration) {
|
|
1884
|
-
baseOptions = configuration.baseOptions;
|
|
1885
|
-
}
|
|
1886
|
-
const localVarRequestOptions = { method: 'DELETE', ...baseOptions, ...options };
|
|
1887
|
-
const localVarHeaderParameter = {};
|
|
1888
|
-
const localVarQueryParameter = {};
|
|
1889
|
-
// authentication ApiKeyAuth required
|
|
1890
|
-
await (0, common_1.setApiKeyToObject)(localVarHeaderParameter, "x-storesecret", configuration);
|
|
1891
|
-
localVarHeaderParameter['Accept'] = 'application/json';
|
|
1892
|
-
if (xStoreid != null) {
|
|
1893
|
-
localVarHeaderParameter['x-storeid'] = String(xStoreid);
|
|
1894
|
-
}
|
|
1895
|
-
if (xStoreWriteSecret != null) {
|
|
1896
|
-
localVarHeaderParameter['x-store-write-secret'] = String(xStoreWriteSecret);
|
|
1897
|
-
}
|
|
1898
|
-
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
1899
|
-
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
1900
|
-
localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
|
|
1901
|
-
return {
|
|
1902
|
-
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
1903
|
-
options: localVarRequestOptions,
|
|
1904
|
-
};
|
|
1905
|
-
},
|
|
1906
|
-
/**
|
|
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);
|
|
1225
|
+
(0, common_1.assertParamExists)('v1ExperimentsAssignmentGet', 'xStoreid', xStoreid);
|
|
1919
1226
|
// verify required parameter 'xStoresecret' is not null or undefined
|
|
1920
|
-
(0, common_1.assertParamExists)('
|
|
1921
|
-
|
|
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)));
|
|
1227
|
+
(0, common_1.assertParamExists)('v1ExperimentsAssignmentGet', 'xStoresecret', xStoresecret);
|
|
1228
|
+
const localVarPath = `/v1/experiments/assignment`;
|
|
1928
1229
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
1929
1230
|
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
1930
1231
|
let baseOptions;
|
|
@@ -1943,58 +1244,15 @@ const SDKDocumentsApiAxiosParamCreator = function (configuration) {
|
|
|
1943
1244
|
if (xStoresecret != null) {
|
|
1944
1245
|
localVarHeaderParameter['x-storesecret'] = String(xStoresecret);
|
|
1945
1246
|
}
|
|
1946
|
-
(
|
|
1947
|
-
|
|
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
|
|
1961
|
-
* @param {*} [options] Override http request option.
|
|
1962
|
-
* @throws {RequiredError}
|
|
1963
|
-
*/
|
|
1964
|
-
apiV1StoresXStoreIDDocumentsPost: async (xStoreid, xStoreWriteSecret, xStoreID, dataTypesDocumentRequest, options = {}) => {
|
|
1965
|
-
// verify required parameter 'xStoreid' is not null or undefined
|
|
1966
|
-
(0, common_1.assertParamExists)('apiV1StoresXStoreIDDocumentsPost', 'xStoreid', xStoreid);
|
|
1967
|
-
// verify required parameter 'xStoreWriteSecret' is not null or undefined
|
|
1968
|
-
(0, common_1.assertParamExists)('apiV1StoresXStoreIDDocumentsPost', 'xStoreWriteSecret', xStoreWriteSecret);
|
|
1969
|
-
// verify required parameter 'xStoreID' is not null or undefined
|
|
1970
|
-
(0, common_1.assertParamExists)('apiV1StoresXStoreIDDocumentsPost', 'xStoreID', xStoreID);
|
|
1971
|
-
// verify required parameter 'dataTypesDocumentRequest' is not null or undefined
|
|
1972
|
-
(0, common_1.assertParamExists)('apiV1StoresXStoreIDDocumentsPost', 'dataTypesDocumentRequest', dataTypesDocumentRequest);
|
|
1973
|
-
const localVarPath = `/api/v1/stores/{xStoreID}/documents`
|
|
1974
|
-
.replace(`{${"xStoreID"}}`, encodeURIComponent(String(xStoreID)));
|
|
1975
|
-
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
1976
|
-
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
1977
|
-
let baseOptions;
|
|
1978
|
-
if (configuration) {
|
|
1979
|
-
baseOptions = configuration.baseOptions;
|
|
1980
|
-
}
|
|
1981
|
-
const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options };
|
|
1982
|
-
const localVarHeaderParameter = {};
|
|
1983
|
-
const localVarQueryParameter = {};
|
|
1984
|
-
// authentication ApiKeyAuth required
|
|
1985
|
-
await (0, common_1.setApiKeyToObject)(localVarHeaderParameter, "x-storesecret", configuration);
|
|
1986
|
-
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
1987
|
-
localVarHeaderParameter['Accept'] = 'application/json';
|
|
1988
|
-
if (xStoreid != null) {
|
|
1989
|
-
localVarHeaderParameter['x-storeid'] = String(xStoreid);
|
|
1247
|
+
if (xUserId != null) {
|
|
1248
|
+
localVarHeaderParameter['x-user-id'] = String(xUserId);
|
|
1990
1249
|
}
|
|
1991
|
-
if (
|
|
1992
|
-
localVarHeaderParameter['x-
|
|
1250
|
+
if (xAnonId != null) {
|
|
1251
|
+
localVarHeaderParameter['x-anon-id'] = String(xAnonId);
|
|
1993
1252
|
}
|
|
1994
1253
|
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
1995
1254
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
1996
1255
|
localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
|
|
1997
|
-
localVarRequestOptions.data = (0, common_1.serializeDataIfNeeded)(dataTypesDocumentRequest, localVarRequestOptions, configuration);
|
|
1998
1256
|
return {
|
|
1999
1257
|
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
2000
1258
|
options: localVarRequestOptions,
|
|
@@ -2002,298 +1260,50 @@ const SDKDocumentsApiAxiosParamCreator = function (configuration) {
|
|
|
2002
1260
|
},
|
|
2003
1261
|
};
|
|
2004
1262
|
};
|
|
2005
|
-
exports.
|
|
1263
|
+
exports.SDKExperimentsApiAxiosParamCreator = SDKExperimentsApiAxiosParamCreator;
|
|
2006
1264
|
/**
|
|
2007
|
-
*
|
|
1265
|
+
* SDKExperimentsApi - functional programming interface
|
|
2008
1266
|
*/
|
|
2009
|
-
const
|
|
2010
|
-
const localVarAxiosParamCreator = (0, exports.
|
|
1267
|
+
const SDKExperimentsApiFp = function (configuration) {
|
|
1268
|
+
const localVarAxiosParamCreator = (0, exports.SDKExperimentsApiAxiosParamCreator)(configuration);
|
|
2011
1269
|
return {
|
|
2012
1270
|
/**
|
|
2013
|
-
*
|
|
2014
|
-
* @summary
|
|
2015
|
-
* @param {string} xStoreid Store ID
|
|
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
|
|
2019
|
-
* @param {*} [options] Override http request option.
|
|
2020
|
-
* @throws {RequiredError}
|
|
2021
|
-
*/
|
|
2022
|
-
async apiV1StoresXStoreIDDocumentsBulkPost(xStoreid, xStoreWriteSecret, xStoreID, dataTypesBulkDocumentRequest, options) {
|
|
2023
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.apiV1StoresXStoreIDDocumentsBulkPost(xStoreid, xStoreWriteSecret, xStoreID, dataTypesBulkDocumentRequest, options);
|
|
2024
|
-
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
2025
|
-
const localVarOperationServerBasePath = base_1.operationServerMap['SDKDocumentsApi.apiV1StoresXStoreIDDocumentsBulkPost']?.[localVarOperationServerIndex]?.url;
|
|
2026
|
-
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
2027
|
-
},
|
|
2028
|
-
/**
|
|
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)
|
|
2034
|
-
* @param {string} documentID Document ID to delete
|
|
2035
|
-
* @param {*} [options] Override http request option.
|
|
2036
|
-
* @throws {RequiredError}
|
|
2037
|
-
*/
|
|
2038
|
-
async apiV1StoresXStoreIDDocumentsDocumentIDDelete(xStoreid, xStoreWriteSecret, xStoreID, documentID, options) {
|
|
2039
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.apiV1StoresXStoreIDDocumentsDocumentIDDelete(xStoreid, xStoreWriteSecret, xStoreID, documentID, options);
|
|
2040
|
-
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
2041
|
-
const localVarOperationServerBasePath = base_1.operationServerMap['SDKDocumentsApi.apiV1StoresXStoreIDDocumentsDocumentIDDelete']?.[localVarOperationServerIndex]?.url;
|
|
2042
|
-
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
2043
|
-
},
|
|
2044
|
-
/**
|
|
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)
|
|
1271
|
+
* Returns variant assignments for all running experiments for the requesting user. Uses hash-based consistent assignment.
|
|
1272
|
+
* @summary Get experiment assignments for a user
|
|
1273
|
+
* @param {string} xStoreid Store ID
|
|
2048
1274
|
* @param {string} xStoresecret Store read secret
|
|
2049
|
-
* @param {string}
|
|
2050
|
-
* @param {string}
|
|
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
|
|
1275
|
+
* @param {string} [xUserId] User ID (provide either x-user-id or x-anon-id)
|
|
1276
|
+
* @param {string} [xAnonId] Anonymous ID (provide either x-user-id or x-anon-id)
|
|
2067
1277
|
* @param {*} [options] Override http request option.
|
|
2068
1278
|
* @throws {RequiredError}
|
|
2069
1279
|
*/
|
|
2070
|
-
async
|
|
2071
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.
|
|
1280
|
+
async v1ExperimentsAssignmentGet(xStoreid, xStoresecret, xUserId, xAnonId, options) {
|
|
1281
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.v1ExperimentsAssignmentGet(xStoreid, xStoresecret, xUserId, xAnonId, options);
|
|
2072
1282
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
2073
|
-
const localVarOperationServerBasePath = base_1.operationServerMap['
|
|
1283
|
+
const localVarOperationServerBasePath = base_1.operationServerMap['SDKExperimentsApi.v1ExperimentsAssignmentGet']?.[localVarOperationServerIndex]?.url;
|
|
2074
1284
|
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
2075
1285
|
},
|
|
2076
1286
|
};
|
|
2077
1287
|
};
|
|
2078
|
-
exports.
|
|
1288
|
+
exports.SDKExperimentsApiFp = SDKExperimentsApiFp;
|
|
2079
1289
|
/**
|
|
2080
|
-
*
|
|
1290
|
+
* SDKExperimentsApi - factory interface
|
|
2081
1291
|
*/
|
|
2082
|
-
const
|
|
2083
|
-
const localVarFp = (0, exports.
|
|
1292
|
+
const SDKExperimentsApiFactory = function (configuration, basePath, axios) {
|
|
1293
|
+
const localVarFp = (0, exports.SDKExperimentsApiFp)(configuration);
|
|
2084
1294
|
return {
|
|
2085
1295
|
/**
|
|
2086
|
-
*
|
|
2087
|
-
* @summary
|
|
2088
|
-
* @param {string} xStoreid Store ID
|
|
2089
|
-
* @param {string}
|
|
2090
|
-
* @param {string}
|
|
2091
|
-
* @param {
|
|
1296
|
+
* Returns variant assignments for all running experiments for the requesting user. Uses hash-based consistent assignment.
|
|
1297
|
+
* @summary Get experiment assignments for a user
|
|
1298
|
+
* @param {string} xStoreid Store ID
|
|
1299
|
+
* @param {string} xStoresecret Store read secret
|
|
1300
|
+
* @param {string} [xUserId] User ID (provide either x-user-id or x-anon-id)
|
|
1301
|
+
* @param {string} [xAnonId] Anonymous ID (provide either x-user-id or x-anon-id)
|
|
2092
1302
|
* @param {*} [options] Override http request option.
|
|
2093
1303
|
* @throws {RequiredError}
|
|
2094
1304
|
*/
|
|
2095
|
-
|
|
2096
|
-
return localVarFp.
|
|
2097
|
-
},
|
|
2098
|
-
/**
|
|
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)
|
|
2104
|
-
* @param {string} documentID Document ID to delete
|
|
2105
|
-
* @param {*} [options] Override http request option.
|
|
2106
|
-
* @throws {RequiredError}
|
|
2107
|
-
*/
|
|
2108
|
-
apiV1StoresXStoreIDDocumentsDocumentIDDelete(xStoreid, xStoreWriteSecret, xStoreID, documentID, options) {
|
|
2109
|
-
return localVarFp.apiV1StoresXStoreIDDocumentsDocumentIDDelete(xStoreid, xStoreWriteSecret, xStoreID, documentID, options).then((request) => request(axios, basePath));
|
|
2110
|
-
},
|
|
2111
|
-
/**
|
|
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
|
|
2131
|
-
* @param {*} [options] Override http request option.
|
|
2132
|
-
* @throws {RequiredError}
|
|
2133
|
-
*/
|
|
2134
|
-
apiV1StoresXStoreIDDocumentsPost(xStoreid, xStoreWriteSecret, xStoreID, dataTypesDocumentRequest, options) {
|
|
2135
|
-
return localVarFp.apiV1StoresXStoreIDDocumentsPost(xStoreid, xStoreWriteSecret, xStoreID, dataTypesDocumentRequest, options).then((request) => request(axios, basePath));
|
|
2136
|
-
},
|
|
2137
|
-
};
|
|
2138
|
-
};
|
|
2139
|
-
exports.SDKDocumentsApiFactory = SDKDocumentsApiFactory;
|
|
2140
|
-
/**
|
|
2141
|
-
* SDKDocumentsApi - object-oriented interface
|
|
2142
|
-
*/
|
|
2143
|
-
class SDKDocumentsApi extends base_1.BaseAPI {
|
|
2144
|
-
/**
|
|
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
|
|
2151
|
-
* @param {*} [options] Override http request option.
|
|
2152
|
-
* @throws {RequiredError}
|
|
2153
|
-
*/
|
|
2154
|
-
apiV1StoresXStoreIDDocumentsBulkPost(xStoreid, xStoreWriteSecret, xStoreID, dataTypesBulkDocumentRequest, options) {
|
|
2155
|
-
return (0, exports.SDKDocumentsApiFp)(this.configuration).apiV1StoresXStoreIDDocumentsBulkPost(xStoreid, xStoreWriteSecret, xStoreID, dataTypesBulkDocumentRequest, options).then((request) => request(this.axios, this.basePath));
|
|
2156
|
-
}
|
|
2157
|
-
/**
|
|
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)
|
|
2163
|
-
* @param {string} documentID Document ID to delete
|
|
2164
|
-
* @param {*} [options] Override http request option.
|
|
2165
|
-
* @throws {RequiredError}
|
|
2166
|
-
*/
|
|
2167
|
-
apiV1StoresXStoreIDDocumentsDocumentIDDelete(xStoreid, xStoreWriteSecret, xStoreID, documentID, options) {
|
|
2168
|
-
return (0, exports.SDKDocumentsApiFp)(this.configuration).apiV1StoresXStoreIDDocumentsDocumentIDDelete(xStoreid, xStoreWriteSecret, xStoreID, documentID, options).then((request) => request(this.axios, this.basePath));
|
|
2169
|
-
}
|
|
2170
|
-
/**
|
|
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
|
|
2190
|
-
* @param {*} [options] Override http request option.
|
|
2191
|
-
* @throws {RequiredError}
|
|
2192
|
-
*/
|
|
2193
|
-
apiV1StoresXStoreIDDocumentsPost(xStoreid, xStoreWriteSecret, xStoreID, dataTypesDocumentRequest, options) {
|
|
2194
|
-
return (0, exports.SDKDocumentsApiFp)(this.configuration).apiV1StoresXStoreIDDocumentsPost(xStoreid, xStoreWriteSecret, xStoreID, dataTypesDocumentRequest, options).then((request) => request(this.axios, this.basePath));
|
|
2195
|
-
}
|
|
2196
|
-
}
|
|
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));
|
|
1305
|
+
v1ExperimentsAssignmentGet(xStoreid, xStoresecret, xUserId, xAnonId, options) {
|
|
1306
|
+
return localVarFp.v1ExperimentsAssignmentGet(xStoreid, xStoresecret, xUserId, xAnonId, options).then((request) => request(axios, basePath));
|
|
2297
1307
|
},
|
|
2298
1308
|
};
|
|
2299
1309
|
};
|
|
@@ -2318,28 +1328,67 @@ class SDKExperimentsApi extends base_1.BaseAPI {
|
|
|
2318
1328
|
}
|
|
2319
1329
|
exports.SDKExperimentsApi = SDKExperimentsApi;
|
|
2320
1330
|
/**
|
|
2321
|
-
*
|
|
1331
|
+
* SearchApi - axios parameter creator
|
|
2322
1332
|
*/
|
|
2323
|
-
const
|
|
1333
|
+
const SearchApiAxiosParamCreator = function (configuration) {
|
|
2324
1334
|
return {
|
|
2325
1335
|
/**
|
|
2326
|
-
*
|
|
2327
|
-
* @summary
|
|
1336
|
+
* 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.
|
|
1337
|
+
* @summary Search (GET)
|
|
2328
1338
|
* @param {string} xStoreid Store ID (from dashboard)
|
|
2329
|
-
* @param {string} xStoresecret Store read secret
|
|
2330
|
-
* @param {string}
|
|
1339
|
+
* @param {string} xStoresecret Store read secret (from dashboard)
|
|
1340
|
+
* @param {string} q Search query
|
|
1341
|
+
* @param {string} [xUserId] User ID for personalization
|
|
1342
|
+
* @param {string} [xAnonId] Anonymous user ID for personalization
|
|
1343
|
+
* @param {string} [xSessionId] Session ID for personalization
|
|
1344
|
+
* @param {number} [page] Page number (default: 1)
|
|
1345
|
+
* @param {number} [perPage] Items per page (default: 10)
|
|
1346
|
+
* @param {string} [sortBy] Sort option (e.g., price:asc, created_at:desc)
|
|
1347
|
+
* @param {string} [filterBy] Filter string (e.g., category:shirts)
|
|
1348
|
+
* @param {string} [facetBy] Facet fields (comma-separated)
|
|
1349
|
+
* @param {number} [maxFacetValues] Maximum facet values to return
|
|
1350
|
+
* @param {boolean} [widgetMode] Return widget-formatted results
|
|
1351
|
+
* @param {boolean} [includeSuggestions] Include autocomplete suggestions
|
|
1352
|
+
* @param {number} [suggestionsLimit] Number of suggestions to return
|
|
1353
|
+
* @param {string} [analyticsTags] Analytics tags (comma-separated)
|
|
1354
|
+
* @param {string} [stopwordSets] Stopword set IDs (comma-separated)
|
|
1355
|
+
* @param {string} [synonymSets] Synonym set IDs (comma-separated)
|
|
1356
|
+
* @param {string} [searchFields] Fields to search in (comma-separated)
|
|
1357
|
+
* @param {string} [returnFields] Fields to return (comma-separated)
|
|
1358
|
+
* @param {string} [omitFields] Fields to omit (comma-separated)
|
|
1359
|
+
* @param {string} [snippetFields] Fields to generate snippets for (comma-separated)
|
|
1360
|
+
* @param {string} [fullSnippetFields] Fields to include full snippet (comma-separated)
|
|
1361
|
+
* @param {string} [fieldWeights] Field weights as comma-separated integers (e.g., 3,2,1)
|
|
1362
|
+
* @param {string} [groupField] Field to group results by
|
|
1363
|
+
* @param {number} [groupSize] Number of results per group
|
|
1364
|
+
* @param {string} [snippetPrefix] Prefix for highlighted snippets
|
|
1365
|
+
* @param {string} [snippetSuffix] Suffix for highlighted snippets
|
|
1366
|
+
* @param {number} [snippetTokenLimit] Maximum tokens in snippet
|
|
1367
|
+
* @param {number} [snippetMinLen] Minimum snippet length
|
|
1368
|
+
* @param {boolean} [includeSnippets] Include snippets in results
|
|
1369
|
+
* @param {string} [prefixMode] Prefix matching mode (e.g., always, fallback, off)
|
|
1370
|
+
* @param {string} [infixMode] Infix matching mode (e.g., always, fallback, off)
|
|
1371
|
+
* @param {number} [typoMax] Maximum typo tolerance
|
|
1372
|
+
* @param {number} [typoMinLen1] Min word length for 1 typo
|
|
1373
|
+
* @param {number} [typoMinLen2] Min word length for 2 typos
|
|
1374
|
+
* @param {number} [searchTimeoutMs] Search timeout in milliseconds
|
|
1375
|
+
* @param {boolean} [requireAllTerms] Require all search terms to match
|
|
1376
|
+
* @param {boolean} [exactMatchBoost] Boost exact matches
|
|
1377
|
+
* @param {boolean} [cacheResults] Cache search results
|
|
1378
|
+
* @param {boolean} [applyRules] Apply search rules
|
|
1379
|
+
* @param {string} [presetName] Search preset name to use
|
|
1380
|
+
* @param {string} [facetSearchText] Text to filter facet values
|
|
2331
1381
|
* @param {*} [options] Override http request option.
|
|
2332
1382
|
* @throws {RequiredError}
|
|
2333
1383
|
*/
|
|
2334
|
-
|
|
1384
|
+
v1SearchGet: async (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 = {}) => {
|
|
2335
1385
|
// verify required parameter 'xStoreid' is not null or undefined
|
|
2336
|
-
(0, common_1.assertParamExists)('
|
|
1386
|
+
(0, common_1.assertParamExists)('v1SearchGet', 'xStoreid', xStoreid);
|
|
2337
1387
|
// verify required parameter 'xStoresecret' is not null or undefined
|
|
2338
|
-
(0, common_1.assertParamExists)('
|
|
2339
|
-
// verify required parameter '
|
|
2340
|
-
(0, common_1.assertParamExists)('
|
|
2341
|
-
const localVarPath = `/
|
|
2342
|
-
.replace(`{${"xStoreID"}}`, encodeURIComponent(String(xStoreID)));
|
|
1388
|
+
(0, common_1.assertParamExists)('v1SearchGet', 'xStoresecret', xStoresecret);
|
|
1389
|
+
// verify required parameter 'q' is not null or undefined
|
|
1390
|
+
(0, common_1.assertParamExists)('v1SearchGet', 'q', q);
|
|
1391
|
+
const localVarPath = `/v1/search`;
|
|
2343
1392
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
2344
1393
|
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
2345
1394
|
let baseOptions;
|
|
@@ -2349,17 +1398,138 @@ const SDKQuerySuggestionsConfigApiAxiosParamCreator = function (configuration) {
|
|
|
2349
1398
|
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options };
|
|
2350
1399
|
const localVarHeaderParameter = {};
|
|
2351
1400
|
const localVarQueryParameter = {};
|
|
2352
|
-
|
|
2353
|
-
|
|
2354
|
-
localVarHeaderParameter['Accept'] = 'application/json';
|
|
2355
|
-
if (xStoreid != null) {
|
|
2356
|
-
localVarHeaderParameter['x-storeid'] = String(xStoreid);
|
|
1401
|
+
if (q !== undefined) {
|
|
1402
|
+
localVarQueryParameter['q'] = q;
|
|
2357
1403
|
}
|
|
2358
|
-
if (
|
|
2359
|
-
|
|
1404
|
+
if (page !== undefined) {
|
|
1405
|
+
localVarQueryParameter['page'] = page;
|
|
2360
1406
|
}
|
|
2361
|
-
(
|
|
2362
|
-
|
|
1407
|
+
if (perPage !== undefined) {
|
|
1408
|
+
localVarQueryParameter['per_page'] = perPage;
|
|
1409
|
+
}
|
|
1410
|
+
if (sortBy !== undefined) {
|
|
1411
|
+
localVarQueryParameter['sort_by'] = sortBy;
|
|
1412
|
+
}
|
|
1413
|
+
if (filterBy !== undefined) {
|
|
1414
|
+
localVarQueryParameter['filter_by'] = filterBy;
|
|
1415
|
+
}
|
|
1416
|
+
if (facetBy !== undefined) {
|
|
1417
|
+
localVarQueryParameter['facet_by'] = facetBy;
|
|
1418
|
+
}
|
|
1419
|
+
if (maxFacetValues !== undefined) {
|
|
1420
|
+
localVarQueryParameter['max_facet_values'] = maxFacetValues;
|
|
1421
|
+
}
|
|
1422
|
+
if (widgetMode !== undefined) {
|
|
1423
|
+
localVarQueryParameter['widget_mode'] = widgetMode;
|
|
1424
|
+
}
|
|
1425
|
+
if (includeSuggestions !== undefined) {
|
|
1426
|
+
localVarQueryParameter['include_suggestions'] = includeSuggestions;
|
|
1427
|
+
}
|
|
1428
|
+
if (suggestionsLimit !== undefined) {
|
|
1429
|
+
localVarQueryParameter['suggestions_limit'] = suggestionsLimit;
|
|
1430
|
+
}
|
|
1431
|
+
if (analyticsTags !== undefined) {
|
|
1432
|
+
localVarQueryParameter['analytics_tags'] = analyticsTags;
|
|
1433
|
+
}
|
|
1434
|
+
if (stopwordSets !== undefined) {
|
|
1435
|
+
localVarQueryParameter['stopword_sets'] = stopwordSets;
|
|
1436
|
+
}
|
|
1437
|
+
if (synonymSets !== undefined) {
|
|
1438
|
+
localVarQueryParameter['synonym_sets'] = synonymSets;
|
|
1439
|
+
}
|
|
1440
|
+
if (searchFields !== undefined) {
|
|
1441
|
+
localVarQueryParameter['search_fields'] = searchFields;
|
|
1442
|
+
}
|
|
1443
|
+
if (returnFields !== undefined) {
|
|
1444
|
+
localVarQueryParameter['return_fields'] = returnFields;
|
|
1445
|
+
}
|
|
1446
|
+
if (omitFields !== undefined) {
|
|
1447
|
+
localVarQueryParameter['omit_fields'] = omitFields;
|
|
1448
|
+
}
|
|
1449
|
+
if (snippetFields !== undefined) {
|
|
1450
|
+
localVarQueryParameter['snippet_fields'] = snippetFields;
|
|
1451
|
+
}
|
|
1452
|
+
if (fullSnippetFields !== undefined) {
|
|
1453
|
+
localVarQueryParameter['full_snippet_fields'] = fullSnippetFields;
|
|
1454
|
+
}
|
|
1455
|
+
if (fieldWeights !== undefined) {
|
|
1456
|
+
localVarQueryParameter['field_weights'] = fieldWeights;
|
|
1457
|
+
}
|
|
1458
|
+
if (groupField !== undefined) {
|
|
1459
|
+
localVarQueryParameter['group_field'] = groupField;
|
|
1460
|
+
}
|
|
1461
|
+
if (groupSize !== undefined) {
|
|
1462
|
+
localVarQueryParameter['group_size'] = groupSize;
|
|
1463
|
+
}
|
|
1464
|
+
if (snippetPrefix !== undefined) {
|
|
1465
|
+
localVarQueryParameter['snippet_prefix'] = snippetPrefix;
|
|
1466
|
+
}
|
|
1467
|
+
if (snippetSuffix !== undefined) {
|
|
1468
|
+
localVarQueryParameter['snippet_suffix'] = snippetSuffix;
|
|
1469
|
+
}
|
|
1470
|
+
if (snippetTokenLimit !== undefined) {
|
|
1471
|
+
localVarQueryParameter['snippet_token_limit'] = snippetTokenLimit;
|
|
1472
|
+
}
|
|
1473
|
+
if (snippetMinLen !== undefined) {
|
|
1474
|
+
localVarQueryParameter['snippet_min_len'] = snippetMinLen;
|
|
1475
|
+
}
|
|
1476
|
+
if (includeSnippets !== undefined) {
|
|
1477
|
+
localVarQueryParameter['include_snippets'] = includeSnippets;
|
|
1478
|
+
}
|
|
1479
|
+
if (prefixMode !== undefined) {
|
|
1480
|
+
localVarQueryParameter['prefix_mode'] = prefixMode;
|
|
1481
|
+
}
|
|
1482
|
+
if (infixMode !== undefined) {
|
|
1483
|
+
localVarQueryParameter['infix_mode'] = infixMode;
|
|
1484
|
+
}
|
|
1485
|
+
if (typoMax !== undefined) {
|
|
1486
|
+
localVarQueryParameter['typo_max'] = typoMax;
|
|
1487
|
+
}
|
|
1488
|
+
if (typoMinLen1 !== undefined) {
|
|
1489
|
+
localVarQueryParameter['typo_min_len_1'] = typoMinLen1;
|
|
1490
|
+
}
|
|
1491
|
+
if (typoMinLen2 !== undefined) {
|
|
1492
|
+
localVarQueryParameter['typo_min_len_2'] = typoMinLen2;
|
|
1493
|
+
}
|
|
1494
|
+
if (searchTimeoutMs !== undefined) {
|
|
1495
|
+
localVarQueryParameter['search_timeout_ms'] = searchTimeoutMs;
|
|
1496
|
+
}
|
|
1497
|
+
if (requireAllTerms !== undefined) {
|
|
1498
|
+
localVarQueryParameter['require_all_terms'] = requireAllTerms;
|
|
1499
|
+
}
|
|
1500
|
+
if (exactMatchBoost !== undefined) {
|
|
1501
|
+
localVarQueryParameter['exact_match_boost'] = exactMatchBoost;
|
|
1502
|
+
}
|
|
1503
|
+
if (cacheResults !== undefined) {
|
|
1504
|
+
localVarQueryParameter['cache_results'] = cacheResults;
|
|
1505
|
+
}
|
|
1506
|
+
if (applyRules !== undefined) {
|
|
1507
|
+
localVarQueryParameter['apply_rules'] = applyRules;
|
|
1508
|
+
}
|
|
1509
|
+
if (presetName !== undefined) {
|
|
1510
|
+
localVarQueryParameter['preset_name'] = presetName;
|
|
1511
|
+
}
|
|
1512
|
+
if (facetSearchText !== undefined) {
|
|
1513
|
+
localVarQueryParameter['facet_search_text'] = facetSearchText;
|
|
1514
|
+
}
|
|
1515
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
1516
|
+
if (xStoreid != null) {
|
|
1517
|
+
localVarHeaderParameter['x-storeid'] = String(xStoreid);
|
|
1518
|
+
}
|
|
1519
|
+
if (xStoresecret != null) {
|
|
1520
|
+
localVarHeaderParameter['x-storesecret'] = String(xStoresecret);
|
|
1521
|
+
}
|
|
1522
|
+
if (xUserId != null) {
|
|
1523
|
+
localVarHeaderParameter['x-user-id'] = String(xUserId);
|
|
1524
|
+
}
|
|
1525
|
+
if (xAnonId != null) {
|
|
1526
|
+
localVarHeaderParameter['x-anon-id'] = String(xAnonId);
|
|
1527
|
+
}
|
|
1528
|
+
if (xSessionId != null) {
|
|
1529
|
+
localVarHeaderParameter['x-session-id'] = String(xSessionId);
|
|
1530
|
+
}
|
|
1531
|
+
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
1532
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
2363
1533
|
localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
|
|
2364
1534
|
return {
|
|
2365
1535
|
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
@@ -2367,49 +1537,55 @@ const SDKQuerySuggestionsConfigApiAxiosParamCreator = function (configuration) {
|
|
|
2367
1537
|
};
|
|
2368
1538
|
},
|
|
2369
1539
|
/**
|
|
2370
|
-
*
|
|
2371
|
-
* @summary
|
|
1540
|
+
* 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.
|
|
1541
|
+
* @summary Search (POST)
|
|
2372
1542
|
* @param {string} xStoreid Store ID (from dashboard)
|
|
2373
|
-
* @param {string}
|
|
2374
|
-
* @param {
|
|
2375
|
-
* @param {
|
|
1543
|
+
* @param {string} xStoresecret Store read secret (from dashboard)
|
|
1544
|
+
* @param {DataTypesSearchRequest} dataTypesSearchRequest Search query, filters, pagination, and options
|
|
1545
|
+
* @param {string} [xUserId] User ID for personalization
|
|
1546
|
+
* @param {string} [xAnonId] Anonymous user ID for personalization
|
|
1547
|
+
* @param {string} [xSessionId] Session ID for personalization
|
|
2376
1548
|
* @param {*} [options] Override http request option.
|
|
2377
1549
|
* @throws {RequiredError}
|
|
2378
1550
|
*/
|
|
2379
|
-
|
|
1551
|
+
v1SearchPost: async (xStoreid, xStoresecret, dataTypesSearchRequest, xUserId, xAnonId, xSessionId, options = {}) => {
|
|
2380
1552
|
// verify required parameter 'xStoreid' is not null or undefined
|
|
2381
|
-
(0, common_1.assertParamExists)('
|
|
2382
|
-
// verify required parameter '
|
|
2383
|
-
(0, common_1.assertParamExists)('
|
|
2384
|
-
// verify required parameter '
|
|
2385
|
-
(0, common_1.assertParamExists)('
|
|
2386
|
-
|
|
2387
|
-
(0, common_1.assertParamExists)('apiV1StoresXStoreIDQuerySuggestionsConfigPut', 'querySuggestionsServiceUpdateSuggestionConfigRequest', querySuggestionsServiceUpdateSuggestionConfigRequest);
|
|
2388
|
-
const localVarPath = `/api/v1/stores/{xStoreID}/query-suggestions/config`
|
|
2389
|
-
.replace(`{${"xStoreID"}}`, encodeURIComponent(String(xStoreID)));
|
|
1553
|
+
(0, common_1.assertParamExists)('v1SearchPost', 'xStoreid', xStoreid);
|
|
1554
|
+
// verify required parameter 'xStoresecret' is not null or undefined
|
|
1555
|
+
(0, common_1.assertParamExists)('v1SearchPost', 'xStoresecret', xStoresecret);
|
|
1556
|
+
// verify required parameter 'dataTypesSearchRequest' is not null or undefined
|
|
1557
|
+
(0, common_1.assertParamExists)('v1SearchPost', 'dataTypesSearchRequest', dataTypesSearchRequest);
|
|
1558
|
+
const localVarPath = `/v1/search`;
|
|
2390
1559
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
2391
1560
|
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
2392
1561
|
let baseOptions;
|
|
2393
1562
|
if (configuration) {
|
|
2394
1563
|
baseOptions = configuration.baseOptions;
|
|
2395
1564
|
}
|
|
2396
|
-
const localVarRequestOptions = { method: '
|
|
1565
|
+
const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options };
|
|
2397
1566
|
const localVarHeaderParameter = {};
|
|
2398
1567
|
const localVarQueryParameter = {};
|
|
2399
|
-
// authentication ApiKeyAuth required
|
|
2400
|
-
await (0, common_1.setApiKeyToObject)(localVarHeaderParameter, "x-storesecret", configuration);
|
|
2401
1568
|
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
2402
1569
|
localVarHeaderParameter['Accept'] = 'application/json';
|
|
2403
1570
|
if (xStoreid != null) {
|
|
2404
1571
|
localVarHeaderParameter['x-storeid'] = String(xStoreid);
|
|
2405
1572
|
}
|
|
2406
|
-
if (
|
|
2407
|
-
localVarHeaderParameter['x-
|
|
1573
|
+
if (xStoresecret != null) {
|
|
1574
|
+
localVarHeaderParameter['x-storesecret'] = String(xStoresecret);
|
|
1575
|
+
}
|
|
1576
|
+
if (xUserId != null) {
|
|
1577
|
+
localVarHeaderParameter['x-user-id'] = String(xUserId);
|
|
1578
|
+
}
|
|
1579
|
+
if (xAnonId != null) {
|
|
1580
|
+
localVarHeaderParameter['x-anon-id'] = String(xAnonId);
|
|
1581
|
+
}
|
|
1582
|
+
if (xSessionId != null) {
|
|
1583
|
+
localVarHeaderParameter['x-session-id'] = String(xSessionId);
|
|
2408
1584
|
}
|
|
2409
1585
|
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
2410
1586
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
2411
1587
|
localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
|
|
2412
|
-
localVarRequestOptions.data = (0, common_1.serializeDataIfNeeded)(
|
|
1588
|
+
localVarRequestOptions.data = (0, common_1.serializeDataIfNeeded)(dataTypesSearchRequest, localVarRequestOptions, configuration);
|
|
2413
1589
|
return {
|
|
2414
1590
|
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
2415
1591
|
options: localVarRequestOptions,
|
|
@@ -2417,178 +1593,299 @@ const SDKQuerySuggestionsConfigApiAxiosParamCreator = function (configuration) {
|
|
|
2417
1593
|
},
|
|
2418
1594
|
};
|
|
2419
1595
|
};
|
|
2420
|
-
exports.
|
|
1596
|
+
exports.SearchApiAxiosParamCreator = SearchApiAxiosParamCreator;
|
|
2421
1597
|
/**
|
|
2422
|
-
*
|
|
1598
|
+
* SearchApi - functional programming interface
|
|
2423
1599
|
*/
|
|
2424
|
-
const
|
|
2425
|
-
const localVarAxiosParamCreator = (0, exports.
|
|
1600
|
+
const SearchApiFp = function (configuration) {
|
|
1601
|
+
const localVarAxiosParamCreator = (0, exports.SearchApiAxiosParamCreator)(configuration);
|
|
2426
1602
|
return {
|
|
2427
1603
|
/**
|
|
2428
|
-
*
|
|
2429
|
-
* @summary
|
|
1604
|
+
* 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.
|
|
1605
|
+
* @summary Search (GET)
|
|
2430
1606
|
* @param {string} xStoreid Store ID (from dashboard)
|
|
2431
|
-
* @param {string} xStoresecret Store read secret
|
|
2432
|
-
* @param {string}
|
|
1607
|
+
* @param {string} xStoresecret Store read secret (from dashboard)
|
|
1608
|
+
* @param {string} q Search query
|
|
1609
|
+
* @param {string} [xUserId] User ID for personalization
|
|
1610
|
+
* @param {string} [xAnonId] Anonymous user ID for personalization
|
|
1611
|
+
* @param {string} [xSessionId] Session ID for personalization
|
|
1612
|
+
* @param {number} [page] Page number (default: 1)
|
|
1613
|
+
* @param {number} [perPage] Items per page (default: 10)
|
|
1614
|
+
* @param {string} [sortBy] Sort option (e.g., price:asc, created_at:desc)
|
|
1615
|
+
* @param {string} [filterBy] Filter string (e.g., category:shirts)
|
|
1616
|
+
* @param {string} [facetBy] Facet fields (comma-separated)
|
|
1617
|
+
* @param {number} [maxFacetValues] Maximum facet values to return
|
|
1618
|
+
* @param {boolean} [widgetMode] Return widget-formatted results
|
|
1619
|
+
* @param {boolean} [includeSuggestions] Include autocomplete suggestions
|
|
1620
|
+
* @param {number} [suggestionsLimit] Number of suggestions to return
|
|
1621
|
+
* @param {string} [analyticsTags] Analytics tags (comma-separated)
|
|
1622
|
+
* @param {string} [stopwordSets] Stopword set IDs (comma-separated)
|
|
1623
|
+
* @param {string} [synonymSets] Synonym set IDs (comma-separated)
|
|
1624
|
+
* @param {string} [searchFields] Fields to search in (comma-separated)
|
|
1625
|
+
* @param {string} [returnFields] Fields to return (comma-separated)
|
|
1626
|
+
* @param {string} [omitFields] Fields to omit (comma-separated)
|
|
1627
|
+
* @param {string} [snippetFields] Fields to generate snippets for (comma-separated)
|
|
1628
|
+
* @param {string} [fullSnippetFields] Fields to include full snippet (comma-separated)
|
|
1629
|
+
* @param {string} [fieldWeights] Field weights as comma-separated integers (e.g., 3,2,1)
|
|
1630
|
+
* @param {string} [groupField] Field to group results by
|
|
1631
|
+
* @param {number} [groupSize] Number of results per group
|
|
1632
|
+
* @param {string} [snippetPrefix] Prefix for highlighted snippets
|
|
1633
|
+
* @param {string} [snippetSuffix] Suffix for highlighted snippets
|
|
1634
|
+
* @param {number} [snippetTokenLimit] Maximum tokens in snippet
|
|
1635
|
+
* @param {number} [snippetMinLen] Minimum snippet length
|
|
1636
|
+
* @param {boolean} [includeSnippets] Include snippets in results
|
|
1637
|
+
* @param {string} [prefixMode] Prefix matching mode (e.g., always, fallback, off)
|
|
1638
|
+
* @param {string} [infixMode] Infix matching mode (e.g., always, fallback, off)
|
|
1639
|
+
* @param {number} [typoMax] Maximum typo tolerance
|
|
1640
|
+
* @param {number} [typoMinLen1] Min word length for 1 typo
|
|
1641
|
+
* @param {number} [typoMinLen2] Min word length for 2 typos
|
|
1642
|
+
* @param {number} [searchTimeoutMs] Search timeout in milliseconds
|
|
1643
|
+
* @param {boolean} [requireAllTerms] Require all search terms to match
|
|
1644
|
+
* @param {boolean} [exactMatchBoost] Boost exact matches
|
|
1645
|
+
* @param {boolean} [cacheResults] Cache search results
|
|
1646
|
+
* @param {boolean} [applyRules] Apply search rules
|
|
1647
|
+
* @param {string} [presetName] Search preset name to use
|
|
1648
|
+
* @param {string} [facetSearchText] Text to filter facet values
|
|
2433
1649
|
* @param {*} [options] Override http request option.
|
|
2434
1650
|
* @throws {RequiredError}
|
|
2435
1651
|
*/
|
|
2436
|
-
async
|
|
2437
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.
|
|
1652
|
+
async 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) {
|
|
1653
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.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);
|
|
2438
1654
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
2439
|
-
const localVarOperationServerBasePath = base_1.operationServerMap['
|
|
1655
|
+
const localVarOperationServerBasePath = base_1.operationServerMap['SearchApi.v1SearchGet']?.[localVarOperationServerIndex]?.url;
|
|
2440
1656
|
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
2441
1657
|
},
|
|
2442
1658
|
/**
|
|
2443
|
-
*
|
|
2444
|
-
* @summary
|
|
1659
|
+
* 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.
|
|
1660
|
+
* @summary Search (POST)
|
|
2445
1661
|
* @param {string} xStoreid Store ID (from dashboard)
|
|
2446
|
-
* @param {string}
|
|
2447
|
-
* @param {
|
|
2448
|
-
* @param {
|
|
1662
|
+
* @param {string} xStoresecret Store read secret (from dashboard)
|
|
1663
|
+
* @param {DataTypesSearchRequest} dataTypesSearchRequest Search query, filters, pagination, and options
|
|
1664
|
+
* @param {string} [xUserId] User ID for personalization
|
|
1665
|
+
* @param {string} [xAnonId] Anonymous user ID for personalization
|
|
1666
|
+
* @param {string} [xSessionId] Session ID for personalization
|
|
2449
1667
|
* @param {*} [options] Override http request option.
|
|
2450
1668
|
* @throws {RequiredError}
|
|
2451
1669
|
*/
|
|
2452
|
-
async
|
|
2453
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.
|
|
1670
|
+
async v1SearchPost(xStoreid, xStoresecret, dataTypesSearchRequest, xUserId, xAnonId, xSessionId, options) {
|
|
1671
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.v1SearchPost(xStoreid, xStoresecret, dataTypesSearchRequest, xUserId, xAnonId, xSessionId, options);
|
|
2454
1672
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
2455
|
-
const localVarOperationServerBasePath = base_1.operationServerMap['
|
|
1673
|
+
const localVarOperationServerBasePath = base_1.operationServerMap['SearchApi.v1SearchPost']?.[localVarOperationServerIndex]?.url;
|
|
2456
1674
|
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
2457
1675
|
},
|
|
2458
1676
|
};
|
|
2459
1677
|
};
|
|
2460
|
-
exports.
|
|
1678
|
+
exports.SearchApiFp = SearchApiFp;
|
|
2461
1679
|
/**
|
|
2462
|
-
*
|
|
1680
|
+
* SearchApi - factory interface
|
|
2463
1681
|
*/
|
|
2464
|
-
const
|
|
2465
|
-
const localVarFp = (0, exports.
|
|
1682
|
+
const SearchApiFactory = function (configuration, basePath, axios) {
|
|
1683
|
+
const localVarFp = (0, exports.SearchApiFp)(configuration);
|
|
2466
1684
|
return {
|
|
2467
1685
|
/**
|
|
2468
|
-
*
|
|
2469
|
-
* @summary
|
|
1686
|
+
* 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.
|
|
1687
|
+
* @summary Search (GET)
|
|
2470
1688
|
* @param {string} xStoreid Store ID (from dashboard)
|
|
2471
|
-
* @param {string} xStoresecret Store read secret
|
|
2472
|
-
* @param {string}
|
|
2473
|
-
* @param {
|
|
2474
|
-
* @
|
|
2475
|
-
|
|
2476
|
-
|
|
2477
|
-
|
|
2478
|
-
|
|
1689
|
+
* @param {string} xStoresecret Store read secret (from dashboard)
|
|
1690
|
+
* @param {string} q Search query
|
|
1691
|
+
* @param {string} [xUserId] User ID for personalization
|
|
1692
|
+
* @param {string} [xAnonId] Anonymous user ID for personalization
|
|
1693
|
+
* @param {string} [xSessionId] Session ID for personalization
|
|
1694
|
+
* @param {number} [page] Page number (default: 1)
|
|
1695
|
+
* @param {number} [perPage] Items per page (default: 10)
|
|
1696
|
+
* @param {string} [sortBy] Sort option (e.g., price:asc, created_at:desc)
|
|
1697
|
+
* @param {string} [filterBy] Filter string (e.g., category:shirts)
|
|
1698
|
+
* @param {string} [facetBy] Facet fields (comma-separated)
|
|
1699
|
+
* @param {number} [maxFacetValues] Maximum facet values to return
|
|
1700
|
+
* @param {boolean} [widgetMode] Return widget-formatted results
|
|
1701
|
+
* @param {boolean} [includeSuggestions] Include autocomplete suggestions
|
|
1702
|
+
* @param {number} [suggestionsLimit] Number of suggestions to return
|
|
1703
|
+
* @param {string} [analyticsTags] Analytics tags (comma-separated)
|
|
1704
|
+
* @param {string} [stopwordSets] Stopword set IDs (comma-separated)
|
|
1705
|
+
* @param {string} [synonymSets] Synonym set IDs (comma-separated)
|
|
1706
|
+
* @param {string} [searchFields] Fields to search in (comma-separated)
|
|
1707
|
+
* @param {string} [returnFields] Fields to return (comma-separated)
|
|
1708
|
+
* @param {string} [omitFields] Fields to omit (comma-separated)
|
|
1709
|
+
* @param {string} [snippetFields] Fields to generate snippets for (comma-separated)
|
|
1710
|
+
* @param {string} [fullSnippetFields] Fields to include full snippet (comma-separated)
|
|
1711
|
+
* @param {string} [fieldWeights] Field weights as comma-separated integers (e.g., 3,2,1)
|
|
1712
|
+
* @param {string} [groupField] Field to group results by
|
|
1713
|
+
* @param {number} [groupSize] Number of results per group
|
|
1714
|
+
* @param {string} [snippetPrefix] Prefix for highlighted snippets
|
|
1715
|
+
* @param {string} [snippetSuffix] Suffix for highlighted snippets
|
|
1716
|
+
* @param {number} [snippetTokenLimit] Maximum tokens in snippet
|
|
1717
|
+
* @param {number} [snippetMinLen] Minimum snippet length
|
|
1718
|
+
* @param {boolean} [includeSnippets] Include snippets in results
|
|
1719
|
+
* @param {string} [prefixMode] Prefix matching mode (e.g., always, fallback, off)
|
|
1720
|
+
* @param {string} [infixMode] Infix matching mode (e.g., always, fallback, off)
|
|
1721
|
+
* @param {number} [typoMax] Maximum typo tolerance
|
|
1722
|
+
* @param {number} [typoMinLen1] Min word length for 1 typo
|
|
1723
|
+
* @param {number} [typoMinLen2] Min word length for 2 typos
|
|
1724
|
+
* @param {number} [searchTimeoutMs] Search timeout in milliseconds
|
|
1725
|
+
* @param {boolean} [requireAllTerms] Require all search terms to match
|
|
1726
|
+
* @param {boolean} [exactMatchBoost] Boost exact matches
|
|
1727
|
+
* @param {boolean} [cacheResults] Cache search results
|
|
1728
|
+
* @param {boolean} [applyRules] Apply search rules
|
|
1729
|
+
* @param {string} [presetName] Search preset name to use
|
|
1730
|
+
* @param {string} [facetSearchText] Text to filter facet values
|
|
1731
|
+
* @param {*} [options] Override http request option.
|
|
1732
|
+
* @throws {RequiredError}
|
|
1733
|
+
*/
|
|
1734
|
+
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) {
|
|
1735
|
+
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));
|
|
1736
|
+
},
|
|
2479
1737
|
/**
|
|
2480
|
-
*
|
|
2481
|
-
* @summary
|
|
1738
|
+
* 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.
|
|
1739
|
+
* @summary Search (POST)
|
|
2482
1740
|
* @param {string} xStoreid Store ID (from dashboard)
|
|
2483
|
-
* @param {string}
|
|
2484
|
-
* @param {
|
|
2485
|
-
* @param {
|
|
1741
|
+
* @param {string} xStoresecret Store read secret (from dashboard)
|
|
1742
|
+
* @param {DataTypesSearchRequest} dataTypesSearchRequest Search query, filters, pagination, and options
|
|
1743
|
+
* @param {string} [xUserId] User ID for personalization
|
|
1744
|
+
* @param {string} [xAnonId] Anonymous user ID for personalization
|
|
1745
|
+
* @param {string} [xSessionId] Session ID for personalization
|
|
2486
1746
|
* @param {*} [options] Override http request option.
|
|
2487
1747
|
* @throws {RequiredError}
|
|
2488
1748
|
*/
|
|
2489
|
-
|
|
2490
|
-
return localVarFp.
|
|
1749
|
+
v1SearchPost(xStoreid, xStoresecret, dataTypesSearchRequest, xUserId, xAnonId, xSessionId, options) {
|
|
1750
|
+
return localVarFp.v1SearchPost(xStoreid, xStoresecret, dataTypesSearchRequest, xUserId, xAnonId, xSessionId, options).then((request) => request(axios, basePath));
|
|
2491
1751
|
},
|
|
2492
1752
|
};
|
|
2493
1753
|
};
|
|
2494
|
-
exports.
|
|
1754
|
+
exports.SearchApiFactory = SearchApiFactory;
|
|
2495
1755
|
/**
|
|
2496
|
-
*
|
|
1756
|
+
* SearchApi - object-oriented interface
|
|
2497
1757
|
*/
|
|
2498
|
-
class
|
|
1758
|
+
class SearchApi extends base_1.BaseAPI {
|
|
2499
1759
|
/**
|
|
2500
|
-
*
|
|
2501
|
-
* @summary
|
|
1760
|
+
* 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.
|
|
1761
|
+
* @summary Search (GET)
|
|
2502
1762
|
* @param {string} xStoreid Store ID (from dashboard)
|
|
2503
|
-
* @param {string} xStoresecret Store read secret
|
|
2504
|
-
* @param {string}
|
|
1763
|
+
* @param {string} xStoresecret Store read secret (from dashboard)
|
|
1764
|
+
* @param {string} q Search query
|
|
1765
|
+
* @param {string} [xUserId] User ID for personalization
|
|
1766
|
+
* @param {string} [xAnonId] Anonymous user ID for personalization
|
|
1767
|
+
* @param {string} [xSessionId] Session ID for personalization
|
|
1768
|
+
* @param {number} [page] Page number (default: 1)
|
|
1769
|
+
* @param {number} [perPage] Items per page (default: 10)
|
|
1770
|
+
* @param {string} [sortBy] Sort option (e.g., price:asc, created_at:desc)
|
|
1771
|
+
* @param {string} [filterBy] Filter string (e.g., category:shirts)
|
|
1772
|
+
* @param {string} [facetBy] Facet fields (comma-separated)
|
|
1773
|
+
* @param {number} [maxFacetValues] Maximum facet values to return
|
|
1774
|
+
* @param {boolean} [widgetMode] Return widget-formatted results
|
|
1775
|
+
* @param {boolean} [includeSuggestions] Include autocomplete suggestions
|
|
1776
|
+
* @param {number} [suggestionsLimit] Number of suggestions to return
|
|
1777
|
+
* @param {string} [analyticsTags] Analytics tags (comma-separated)
|
|
1778
|
+
* @param {string} [stopwordSets] Stopword set IDs (comma-separated)
|
|
1779
|
+
* @param {string} [synonymSets] Synonym set IDs (comma-separated)
|
|
1780
|
+
* @param {string} [searchFields] Fields to search in (comma-separated)
|
|
1781
|
+
* @param {string} [returnFields] Fields to return (comma-separated)
|
|
1782
|
+
* @param {string} [omitFields] Fields to omit (comma-separated)
|
|
1783
|
+
* @param {string} [snippetFields] Fields to generate snippets for (comma-separated)
|
|
1784
|
+
* @param {string} [fullSnippetFields] Fields to include full snippet (comma-separated)
|
|
1785
|
+
* @param {string} [fieldWeights] Field weights as comma-separated integers (e.g., 3,2,1)
|
|
1786
|
+
* @param {string} [groupField] Field to group results by
|
|
1787
|
+
* @param {number} [groupSize] Number of results per group
|
|
1788
|
+
* @param {string} [snippetPrefix] Prefix for highlighted snippets
|
|
1789
|
+
* @param {string} [snippetSuffix] Suffix for highlighted snippets
|
|
1790
|
+
* @param {number} [snippetTokenLimit] Maximum tokens in snippet
|
|
1791
|
+
* @param {number} [snippetMinLen] Minimum snippet length
|
|
1792
|
+
* @param {boolean} [includeSnippets] Include snippets in results
|
|
1793
|
+
* @param {string} [prefixMode] Prefix matching mode (e.g., always, fallback, off)
|
|
1794
|
+
* @param {string} [infixMode] Infix matching mode (e.g., always, fallback, off)
|
|
1795
|
+
* @param {number} [typoMax] Maximum typo tolerance
|
|
1796
|
+
* @param {number} [typoMinLen1] Min word length for 1 typo
|
|
1797
|
+
* @param {number} [typoMinLen2] Min word length for 2 typos
|
|
1798
|
+
* @param {number} [searchTimeoutMs] Search timeout in milliseconds
|
|
1799
|
+
* @param {boolean} [requireAllTerms] Require all search terms to match
|
|
1800
|
+
* @param {boolean} [exactMatchBoost] Boost exact matches
|
|
1801
|
+
* @param {boolean} [cacheResults] Cache search results
|
|
1802
|
+
* @param {boolean} [applyRules] Apply search rules
|
|
1803
|
+
* @param {string} [presetName] Search preset name to use
|
|
1804
|
+
* @param {string} [facetSearchText] Text to filter facet values
|
|
2505
1805
|
* @param {*} [options] Override http request option.
|
|
2506
1806
|
* @throws {RequiredError}
|
|
2507
1807
|
*/
|
|
2508
|
-
|
|
2509
|
-
return (0, exports.
|
|
1808
|
+
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) {
|
|
1809
|
+
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));
|
|
2510
1810
|
}
|
|
2511
1811
|
/**
|
|
2512
|
-
*
|
|
2513
|
-
* @summary
|
|
1812
|
+
* 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.
|
|
1813
|
+
* @summary Search (POST)
|
|
2514
1814
|
* @param {string} xStoreid Store ID (from dashboard)
|
|
2515
|
-
* @param {string}
|
|
2516
|
-
* @param {
|
|
2517
|
-
* @param {
|
|
1815
|
+
* @param {string} xStoresecret Store read secret (from dashboard)
|
|
1816
|
+
* @param {DataTypesSearchRequest} dataTypesSearchRequest Search query, filters, pagination, and options
|
|
1817
|
+
* @param {string} [xUserId] User ID for personalization
|
|
1818
|
+
* @param {string} [xAnonId] Anonymous user ID for personalization
|
|
1819
|
+
* @param {string} [xSessionId] Session ID for personalization
|
|
2518
1820
|
* @param {*} [options] Override http request option.
|
|
2519
1821
|
* @throws {RequiredError}
|
|
2520
1822
|
*/
|
|
2521
|
-
|
|
2522
|
-
return (0, exports.
|
|
1823
|
+
v1SearchPost(xStoreid, xStoresecret, dataTypesSearchRequest, xUserId, xAnonId, xSessionId, options) {
|
|
1824
|
+
return (0, exports.SearchApiFp)(this.configuration).v1SearchPost(xStoreid, xStoresecret, dataTypesSearchRequest, xUserId, xAnonId, xSessionId, options).then((request) => request(this.axios, this.basePath));
|
|
2523
1825
|
}
|
|
2524
1826
|
}
|
|
2525
|
-
exports.
|
|
1827
|
+
exports.SearchApi = SearchApi;
|
|
2526
1828
|
/**
|
|
2527
|
-
*
|
|
1829
|
+
* StoreManagementApi - axios parameter creator
|
|
2528
1830
|
*/
|
|
2529
|
-
const
|
|
1831
|
+
const StoreManagementApiAxiosParamCreator = function (configuration) {
|
|
2530
1832
|
return {
|
|
2531
1833
|
/**
|
|
2532
|
-
*
|
|
2533
|
-
* @summary
|
|
2534
|
-
* @param {string}
|
|
2535
|
-
* @param {
|
|
2536
|
-
* @param {string} xStoreID Store ID (must match x-storeid header)
|
|
1834
|
+
* Creates a new store with minimal information. Returns store credentials (xStoreID, xStoreSecret, xStoreWriteSecret) immediately. This is a public API for SDK integration. Requires JWT authentication.
|
|
1835
|
+
* @summary Create Store (Public SDK API)
|
|
1836
|
+
* @param {string} authorization Bearer JWT Token
|
|
1837
|
+
* @param {DataTypesCreateStoreRequest} dataTypesCreateStoreRequest Store creation request
|
|
2537
1838
|
* @param {*} [options] Override http request option.
|
|
2538
1839
|
* @throws {RequiredError}
|
|
2539
1840
|
*/
|
|
2540
|
-
|
|
2541
|
-
// verify required parameter '
|
|
2542
|
-
(0, common_1.assertParamExists)('
|
|
2543
|
-
// verify required parameter '
|
|
2544
|
-
(0, common_1.assertParamExists)('
|
|
2545
|
-
|
|
2546
|
-
(0, common_1.assertParamExists)('apiV1StoresXStoreIDDocumentsDelete', 'xStoreID', xStoreID);
|
|
2547
|
-
const localVarPath = `/api/v1/stores/{xStoreID}/documents`
|
|
2548
|
-
.replace(`{${"xStoreID"}}`, encodeURIComponent(String(xStoreID)));
|
|
1841
|
+
apiV1StoresPost: async (authorization, dataTypesCreateStoreRequest, options = {}) => {
|
|
1842
|
+
// verify required parameter 'authorization' is not null or undefined
|
|
1843
|
+
(0, common_1.assertParamExists)('apiV1StoresPost', 'authorization', authorization);
|
|
1844
|
+
// verify required parameter 'dataTypesCreateStoreRequest' is not null or undefined
|
|
1845
|
+
(0, common_1.assertParamExists)('apiV1StoresPost', 'dataTypesCreateStoreRequest', dataTypesCreateStoreRequest);
|
|
1846
|
+
const localVarPath = `/api/v1/stores`;
|
|
2549
1847
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
2550
1848
|
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
2551
1849
|
let baseOptions;
|
|
2552
1850
|
if (configuration) {
|
|
2553
1851
|
baseOptions = configuration.baseOptions;
|
|
2554
1852
|
}
|
|
2555
|
-
const localVarRequestOptions = { method: '
|
|
1853
|
+
const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options };
|
|
2556
1854
|
const localVarHeaderParameter = {};
|
|
2557
1855
|
const localVarQueryParameter = {};
|
|
2558
|
-
// authentication
|
|
2559
|
-
await (0, common_1.setApiKeyToObject)(localVarHeaderParameter, "
|
|
1856
|
+
// authentication BearerAuth required
|
|
1857
|
+
await (0, common_1.setApiKeyToObject)(localVarHeaderParameter, "Authorization", configuration);
|
|
1858
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
2560
1859
|
localVarHeaderParameter['Accept'] = 'application/json';
|
|
2561
|
-
if (
|
|
2562
|
-
localVarHeaderParameter['
|
|
2563
|
-
}
|
|
2564
|
-
if (xStoreWriteSecret != null) {
|
|
2565
|
-
localVarHeaderParameter['x-store-write-secret'] = String(xStoreWriteSecret);
|
|
1860
|
+
if (authorization != null) {
|
|
1861
|
+
localVarHeaderParameter['Authorization'] = String(authorization);
|
|
2566
1862
|
}
|
|
2567
1863
|
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
2568
1864
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
2569
1865
|
localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
|
|
1866
|
+
localVarRequestOptions.data = (0, common_1.serializeDataIfNeeded)(dataTypesCreateStoreRequest, localVarRequestOptions, configuration);
|
|
2570
1867
|
return {
|
|
2571
1868
|
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
2572
1869
|
options: localVarRequestOptions,
|
|
2573
1870
|
};
|
|
2574
1871
|
},
|
|
2575
1872
|
/**
|
|
2576
|
-
* Returns
|
|
2577
|
-
* @summary Get
|
|
1873
|
+
* Returns search and query-suggestions configuration for the store. **Auth:** `x-storeid` and `x-storesecret`. Path `xStoreID` must match the `x-storeid` header.
|
|
1874
|
+
* @summary Get store configuration
|
|
2578
1875
|
* @param {string} xStoreid Store ID (from dashboard)
|
|
2579
1876
|
* @param {string} xStoresecret Store read secret
|
|
2580
1877
|
* @param {string} xStoreID Store ID (must match x-storeid header)
|
|
2581
1878
|
* @param {*} [options] Override http request option.
|
|
2582
1879
|
* @throws {RequiredError}
|
|
2583
1880
|
*/
|
|
2584
|
-
|
|
1881
|
+
apiV1StoresXStoreIDConfigGet: async (xStoreid, xStoresecret, xStoreID, options = {}) => {
|
|
2585
1882
|
// verify required parameter 'xStoreid' is not null or undefined
|
|
2586
|
-
(0, common_1.assertParamExists)('
|
|
1883
|
+
(0, common_1.assertParamExists)('apiV1StoresXStoreIDConfigGet', 'xStoreid', xStoreid);
|
|
2587
1884
|
// verify required parameter 'xStoresecret' is not null or undefined
|
|
2588
|
-
(0, common_1.assertParamExists)('
|
|
1885
|
+
(0, common_1.assertParamExists)('apiV1StoresXStoreIDConfigGet', 'xStoresecret', xStoresecret);
|
|
2589
1886
|
// verify required parameter 'xStoreID' is not null or undefined
|
|
2590
|
-
(0, common_1.assertParamExists)('
|
|
2591
|
-
const localVarPath = `/api/v1/stores/{xStoreID}/
|
|
1887
|
+
(0, common_1.assertParamExists)('apiV1StoresXStoreIDConfigGet', 'xStoreID', xStoreID);
|
|
1888
|
+
const localVarPath = `/api/v1/stores/{xStoreID}/config`
|
|
2592
1889
|
.replace(`{${"xStoreID"}}`, encodeURIComponent(String(xStoreID)));
|
|
2593
1890
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
2594
1891
|
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
@@ -2617,25 +1914,25 @@ const SDKSchemaApiAxiosParamCreator = function (configuration) {
|
|
|
2617
1914
|
};
|
|
2618
1915
|
},
|
|
2619
1916
|
/**
|
|
2620
|
-
*
|
|
2621
|
-
* @summary
|
|
1917
|
+
* Update search and store settings. Partial updates supported. **Auth:** `x-storeid` and `x-store-write-secret`. Path `xStoreID` must match the `x-storeid` header.
|
|
1918
|
+
* @summary Update store configuration
|
|
2622
1919
|
* @param {string} xStoreid Store ID (from dashboard)
|
|
2623
1920
|
* @param {string} xStoreWriteSecret Store write secret
|
|
2624
1921
|
* @param {string} xStoreID Store ID (must match x-storeid header)
|
|
2625
|
-
* @param {
|
|
1922
|
+
* @param {DataTypesIndexConfig} dataTypesIndexConfig Fields to update (partial)
|
|
2626
1923
|
* @param {*} [options] Override http request option.
|
|
2627
1924
|
* @throws {RequiredError}
|
|
2628
1925
|
*/
|
|
2629
|
-
|
|
1926
|
+
apiV1StoresXStoreIDConfigPut: async (xStoreid, xStoreWriteSecret, xStoreID, dataTypesIndexConfig, options = {}) => {
|
|
2630
1927
|
// verify required parameter 'xStoreid' is not null or undefined
|
|
2631
|
-
(0, common_1.assertParamExists)('
|
|
1928
|
+
(0, common_1.assertParamExists)('apiV1StoresXStoreIDConfigPut', 'xStoreid', xStoreid);
|
|
2632
1929
|
// verify required parameter 'xStoreWriteSecret' is not null or undefined
|
|
2633
|
-
(0, common_1.assertParamExists)('
|
|
1930
|
+
(0, common_1.assertParamExists)('apiV1StoresXStoreIDConfigPut', 'xStoreWriteSecret', xStoreWriteSecret);
|
|
2634
1931
|
// verify required parameter 'xStoreID' is not null or undefined
|
|
2635
|
-
(0, common_1.assertParamExists)('
|
|
2636
|
-
// verify required parameter '
|
|
2637
|
-
(0, common_1.assertParamExists)('
|
|
2638
|
-
const localVarPath = `/api/v1/stores/{xStoreID}/
|
|
1932
|
+
(0, common_1.assertParamExists)('apiV1StoresXStoreIDConfigPut', 'xStoreID', xStoreID);
|
|
1933
|
+
// verify required parameter 'dataTypesIndexConfig' is not null or undefined
|
|
1934
|
+
(0, common_1.assertParamExists)('apiV1StoresXStoreIDConfigPut', 'dataTypesIndexConfig', dataTypesIndexConfig);
|
|
1935
|
+
const localVarPath = `/api/v1/stores/{xStoreID}/config`
|
|
2639
1936
|
.replace(`{${"xStoreID"}}`, encodeURIComponent(String(xStoreID)));
|
|
2640
1937
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
2641
1938
|
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
@@ -2643,7 +1940,7 @@ const SDKSchemaApiAxiosParamCreator = function (configuration) {
|
|
|
2643
1940
|
if (configuration) {
|
|
2644
1941
|
baseOptions = configuration.baseOptions;
|
|
2645
1942
|
}
|
|
2646
|
-
const localVarRequestOptions = { method: '
|
|
1943
|
+
const localVarRequestOptions = { method: 'PUT', ...baseOptions, ...options };
|
|
2647
1944
|
const localVarHeaderParameter = {};
|
|
2648
1945
|
const localVarQueryParameter = {};
|
|
2649
1946
|
// authentication ApiKeyAuth required
|
|
@@ -2659,76 +1956,105 @@ const SDKSchemaApiAxiosParamCreator = function (configuration) {
|
|
|
2659
1956
|
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
2660
1957
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
2661
1958
|
localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
|
|
2662
|
-
localVarRequestOptions.data = (0, common_1.serializeDataIfNeeded)(
|
|
1959
|
+
localVarRequestOptions.data = (0, common_1.serializeDataIfNeeded)(dataTypesIndexConfig, localVarRequestOptions, configuration);
|
|
2663
1960
|
return {
|
|
2664
1961
|
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
2665
1962
|
options: localVarRequestOptions,
|
|
2666
1963
|
};
|
|
2667
1964
|
},
|
|
2668
|
-
};
|
|
2669
|
-
};
|
|
2670
|
-
exports.SDKSchemaApiAxiosParamCreator = SDKSchemaApiAxiosParamCreator;
|
|
2671
|
-
/**
|
|
2672
|
-
* SDKSchemaApi - functional programming interface
|
|
2673
|
-
*/
|
|
2674
|
-
const SDKSchemaApiFp = function (configuration) {
|
|
2675
|
-
const localVarAxiosParamCreator = (0, exports.SDKSchemaApiAxiosParamCreator)(configuration);
|
|
2676
|
-
return {
|
|
2677
1965
|
/**
|
|
2678
|
-
*
|
|
2679
|
-
* @summary
|
|
1966
|
+
* Returns metadata for all configurable store fields (types, defaults, validation). **Auth:** `x-storeid` and `x-storesecret`. Path `xStoreID` must match the `x-storeid` header.
|
|
1967
|
+
* @summary Get store config schema
|
|
2680
1968
|
* @param {string} xStoreid Store ID (from dashboard)
|
|
2681
|
-
* @param {string}
|
|
1969
|
+
* @param {string} xStoresecret Store read secret
|
|
2682
1970
|
* @param {string} xStoreID Store ID (must match x-storeid header)
|
|
2683
1971
|
* @param {*} [options] Override http request option.
|
|
2684
1972
|
* @throws {RequiredError}
|
|
2685
1973
|
*/
|
|
2686
|
-
async
|
|
2687
|
-
|
|
2688
|
-
|
|
2689
|
-
|
|
2690
|
-
|
|
1974
|
+
apiV1StoresXStoreIDConfigSchemaGet: async (xStoreid, xStoresecret, xStoreID, options = {}) => {
|
|
1975
|
+
// verify required parameter 'xStoreid' is not null or undefined
|
|
1976
|
+
(0, common_1.assertParamExists)('apiV1StoresXStoreIDConfigSchemaGet', 'xStoreid', xStoreid);
|
|
1977
|
+
// verify required parameter 'xStoresecret' is not null or undefined
|
|
1978
|
+
(0, common_1.assertParamExists)('apiV1StoresXStoreIDConfigSchemaGet', 'xStoresecret', xStoresecret);
|
|
1979
|
+
// verify required parameter 'xStoreID' is not null or undefined
|
|
1980
|
+
(0, common_1.assertParamExists)('apiV1StoresXStoreIDConfigSchemaGet', 'xStoreID', xStoreID);
|
|
1981
|
+
const localVarPath = `/api/v1/stores/{xStoreID}/config-schema`
|
|
1982
|
+
.replace(`{${"xStoreID"}}`, encodeURIComponent(String(xStoreID)));
|
|
1983
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
1984
|
+
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
1985
|
+
let baseOptions;
|
|
1986
|
+
if (configuration) {
|
|
1987
|
+
baseOptions = configuration.baseOptions;
|
|
1988
|
+
}
|
|
1989
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options };
|
|
1990
|
+
const localVarHeaderParameter = {};
|
|
1991
|
+
const localVarQueryParameter = {};
|
|
1992
|
+
// authentication ApiKeyAuth required
|
|
1993
|
+
await (0, common_1.setApiKeyToObject)(localVarHeaderParameter, "x-storesecret", configuration);
|
|
1994
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
1995
|
+
if (xStoreid != null) {
|
|
1996
|
+
localVarHeaderParameter['x-storeid'] = String(xStoreid);
|
|
1997
|
+
}
|
|
1998
|
+
if (xStoresecret != null) {
|
|
1999
|
+
localVarHeaderParameter['x-storesecret'] = String(xStoresecret);
|
|
2000
|
+
}
|
|
2001
|
+
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
2002
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
2003
|
+
localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
|
|
2004
|
+
return {
|
|
2005
|
+
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
2006
|
+
options: localVarRequestOptions,
|
|
2007
|
+
};
|
|
2691
2008
|
},
|
|
2692
2009
|
/**
|
|
2693
|
-
*
|
|
2694
|
-
* @summary
|
|
2010
|
+
* 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.
|
|
2011
|
+
* @summary Bulk index documents
|
|
2695
2012
|
* @param {string} xStoreid Store ID (from dashboard)
|
|
2696
|
-
* @param {string}
|
|
2013
|
+
* @param {string} xStoreWriteSecret Store write secret
|
|
2697
2014
|
* @param {string} xStoreID Store ID (must match x-storeid header)
|
|
2015
|
+
* @param {DataTypesBulkDocumentRequest} dataTypesBulkDocumentRequest List of operations
|
|
2698
2016
|
* @param {*} [options] Override http request option.
|
|
2699
2017
|
* @throws {RequiredError}
|
|
2700
2018
|
*/
|
|
2701
|
-
async
|
|
2702
|
-
|
|
2703
|
-
|
|
2704
|
-
|
|
2705
|
-
|
|
2706
|
-
|
|
2707
|
-
|
|
2708
|
-
|
|
2709
|
-
|
|
2710
|
-
|
|
2711
|
-
|
|
2712
|
-
|
|
2713
|
-
|
|
2714
|
-
|
|
2715
|
-
|
|
2716
|
-
|
|
2717
|
-
|
|
2718
|
-
const
|
|
2719
|
-
const
|
|
2720
|
-
const
|
|
2721
|
-
|
|
2019
|
+
apiV1StoresXStoreIDDocumentsBulkPost: async (xStoreid, xStoreWriteSecret, xStoreID, dataTypesBulkDocumentRequest, options = {}) => {
|
|
2020
|
+
// verify required parameter 'xStoreid' is not null or undefined
|
|
2021
|
+
(0, common_1.assertParamExists)('apiV1StoresXStoreIDDocumentsBulkPost', 'xStoreid', xStoreid);
|
|
2022
|
+
// verify required parameter 'xStoreWriteSecret' is not null or undefined
|
|
2023
|
+
(0, common_1.assertParamExists)('apiV1StoresXStoreIDDocumentsBulkPost', 'xStoreWriteSecret', xStoreWriteSecret);
|
|
2024
|
+
// verify required parameter 'xStoreID' is not null or undefined
|
|
2025
|
+
(0, common_1.assertParamExists)('apiV1StoresXStoreIDDocumentsBulkPost', 'xStoreID', xStoreID);
|
|
2026
|
+
// verify required parameter 'dataTypesBulkDocumentRequest' is not null or undefined
|
|
2027
|
+
(0, common_1.assertParamExists)('apiV1StoresXStoreIDDocumentsBulkPost', 'dataTypesBulkDocumentRequest', dataTypesBulkDocumentRequest);
|
|
2028
|
+
const localVarPath = `/api/v1/stores/{xStoreID}/documents/bulk`
|
|
2029
|
+
.replace(`{${"xStoreID"}}`, encodeURIComponent(String(xStoreID)));
|
|
2030
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
2031
|
+
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
2032
|
+
let baseOptions;
|
|
2033
|
+
if (configuration) {
|
|
2034
|
+
baseOptions = configuration.baseOptions;
|
|
2035
|
+
}
|
|
2036
|
+
const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options };
|
|
2037
|
+
const localVarHeaderParameter = {};
|
|
2038
|
+
const localVarQueryParameter = {};
|
|
2039
|
+
// authentication ApiKeyAuth required
|
|
2040
|
+
await (0, common_1.setApiKeyToObject)(localVarHeaderParameter, "x-storesecret", configuration);
|
|
2041
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
2042
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
2043
|
+
if (xStoreid != null) {
|
|
2044
|
+
localVarHeaderParameter['x-storeid'] = String(xStoreid);
|
|
2045
|
+
}
|
|
2046
|
+
if (xStoreWriteSecret != null) {
|
|
2047
|
+
localVarHeaderParameter['x-store-write-secret'] = String(xStoreWriteSecret);
|
|
2048
|
+
}
|
|
2049
|
+
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
2050
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
2051
|
+
localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
|
|
2052
|
+
localVarRequestOptions.data = (0, common_1.serializeDataIfNeeded)(dataTypesBulkDocumentRequest, localVarRequestOptions, configuration);
|
|
2053
|
+
return {
|
|
2054
|
+
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
2055
|
+
options: localVarRequestOptions,
|
|
2056
|
+
};
|
|
2722
2057
|
},
|
|
2723
|
-
};
|
|
2724
|
-
};
|
|
2725
|
-
exports.SDKSchemaApiFp = SDKSchemaApiFp;
|
|
2726
|
-
/**
|
|
2727
|
-
* SDKSchemaApi - factory interface
|
|
2728
|
-
*/
|
|
2729
|
-
const SDKSchemaApiFactory = function (configuration, basePath, axios) {
|
|
2730
|
-
const localVarFp = (0, exports.SDKSchemaApiFp)(configuration);
|
|
2731
|
-
return {
|
|
2732
2058
|
/**
|
|
2733
2059
|
* 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
2060
|
* @summary Clear all documents
|
|
@@ -2738,103 +2064,111 @@ const SDKSchemaApiFactory = function (configuration, basePath, axios) {
|
|
|
2738
2064
|
* @param {*} [options] Override http request option.
|
|
2739
2065
|
* @throws {RequiredError}
|
|
2740
2066
|
*/
|
|
2741
|
-
apiV1StoresXStoreIDDocumentsDelete(xStoreid, xStoreWriteSecret, xStoreID, options) {
|
|
2742
|
-
|
|
2743
|
-
|
|
2744
|
-
|
|
2745
|
-
|
|
2746
|
-
|
|
2747
|
-
|
|
2748
|
-
|
|
2749
|
-
|
|
2750
|
-
|
|
2751
|
-
|
|
2752
|
-
|
|
2753
|
-
|
|
2754
|
-
|
|
2067
|
+
apiV1StoresXStoreIDDocumentsDelete: async (xStoreid, xStoreWriteSecret, xStoreID, options = {}) => {
|
|
2068
|
+
// verify required parameter 'xStoreid' is not null or undefined
|
|
2069
|
+
(0, common_1.assertParamExists)('apiV1StoresXStoreIDDocumentsDelete', 'xStoreid', xStoreid);
|
|
2070
|
+
// verify required parameter 'xStoreWriteSecret' is not null or undefined
|
|
2071
|
+
(0, common_1.assertParamExists)('apiV1StoresXStoreIDDocumentsDelete', 'xStoreWriteSecret', xStoreWriteSecret);
|
|
2072
|
+
// verify required parameter 'xStoreID' is not null or undefined
|
|
2073
|
+
(0, common_1.assertParamExists)('apiV1StoresXStoreIDDocumentsDelete', 'xStoreID', xStoreID);
|
|
2074
|
+
const localVarPath = `/api/v1/stores/{xStoreID}/documents`
|
|
2075
|
+
.replace(`{${"xStoreID"}}`, encodeURIComponent(String(xStoreID)));
|
|
2076
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
2077
|
+
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
2078
|
+
let baseOptions;
|
|
2079
|
+
if (configuration) {
|
|
2080
|
+
baseOptions = configuration.baseOptions;
|
|
2081
|
+
}
|
|
2082
|
+
const localVarRequestOptions = { method: 'DELETE', ...baseOptions, ...options };
|
|
2083
|
+
const localVarHeaderParameter = {};
|
|
2084
|
+
const localVarQueryParameter = {};
|
|
2085
|
+
// authentication ApiKeyAuth required
|
|
2086
|
+
await (0, common_1.setApiKeyToObject)(localVarHeaderParameter, "x-storesecret", configuration);
|
|
2087
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
2088
|
+
if (xStoreid != null) {
|
|
2089
|
+
localVarHeaderParameter['x-storeid'] = String(xStoreid);
|
|
2090
|
+
}
|
|
2091
|
+
if (xStoreWriteSecret != null) {
|
|
2092
|
+
localVarHeaderParameter['x-store-write-secret'] = String(xStoreWriteSecret);
|
|
2093
|
+
}
|
|
2094
|
+
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
2095
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
2096
|
+
localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
|
|
2097
|
+
return {
|
|
2098
|
+
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
2099
|
+
options: localVarRequestOptions,
|
|
2100
|
+
};
|
|
2755
2101
|
},
|
|
2756
2102
|
/**
|
|
2757
|
-
*
|
|
2758
|
-
* @summary
|
|
2103
|
+
* 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.
|
|
2104
|
+
* @summary Delete a document
|
|
2759
2105
|
* @param {string} xStoreid Store ID (from dashboard)
|
|
2760
2106
|
* @param {string} xStoreWriteSecret Store write secret
|
|
2761
2107
|
* @param {string} xStoreID Store ID (must match x-storeid header)
|
|
2762
|
-
* @param {
|
|
2108
|
+
* @param {string} documentID Document ID to delete
|
|
2763
2109
|
* @param {*} [options] Override http request option.
|
|
2764
2110
|
* @throws {RequiredError}
|
|
2765
2111
|
*/
|
|
2766
|
-
|
|
2767
|
-
|
|
2112
|
+
apiV1StoresXStoreIDDocumentsDocumentIDDelete: async (xStoreid, xStoreWriteSecret, xStoreID, documentID, options = {}) => {
|
|
2113
|
+
// verify required parameter 'xStoreid' is not null or undefined
|
|
2114
|
+
(0, common_1.assertParamExists)('apiV1StoresXStoreIDDocumentsDocumentIDDelete', 'xStoreid', xStoreid);
|
|
2115
|
+
// verify required parameter 'xStoreWriteSecret' is not null or undefined
|
|
2116
|
+
(0, common_1.assertParamExists)('apiV1StoresXStoreIDDocumentsDocumentIDDelete', 'xStoreWriteSecret', xStoreWriteSecret);
|
|
2117
|
+
// verify required parameter 'xStoreID' is not null or undefined
|
|
2118
|
+
(0, common_1.assertParamExists)('apiV1StoresXStoreIDDocumentsDocumentIDDelete', 'xStoreID', xStoreID);
|
|
2119
|
+
// verify required parameter 'documentID' is not null or undefined
|
|
2120
|
+
(0, common_1.assertParamExists)('apiV1StoresXStoreIDDocumentsDocumentIDDelete', 'documentID', documentID);
|
|
2121
|
+
const localVarPath = `/api/v1/stores/{xStoreID}/documents/{documentID}`
|
|
2122
|
+
.replace(`{${"xStoreID"}}`, encodeURIComponent(String(xStoreID)))
|
|
2123
|
+
.replace(`{${"documentID"}}`, encodeURIComponent(String(documentID)));
|
|
2124
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
2125
|
+
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
2126
|
+
let baseOptions;
|
|
2127
|
+
if (configuration) {
|
|
2128
|
+
baseOptions = configuration.baseOptions;
|
|
2129
|
+
}
|
|
2130
|
+
const localVarRequestOptions = { method: 'DELETE', ...baseOptions, ...options };
|
|
2131
|
+
const localVarHeaderParameter = {};
|
|
2132
|
+
const localVarQueryParameter = {};
|
|
2133
|
+
// authentication ApiKeyAuth required
|
|
2134
|
+
await (0, common_1.setApiKeyToObject)(localVarHeaderParameter, "x-storesecret", configuration);
|
|
2135
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
2136
|
+
if (xStoreid != null) {
|
|
2137
|
+
localVarHeaderParameter['x-storeid'] = String(xStoreid);
|
|
2138
|
+
}
|
|
2139
|
+
if (xStoreWriteSecret != null) {
|
|
2140
|
+
localVarHeaderParameter['x-store-write-secret'] = String(xStoreWriteSecret);
|
|
2141
|
+
}
|
|
2142
|
+
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
2143
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
2144
|
+
localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
|
|
2145
|
+
return {
|
|
2146
|
+
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
2147
|
+
options: localVarRequestOptions,
|
|
2148
|
+
};
|
|
2768
2149
|
},
|
|
2769
|
-
};
|
|
2770
|
-
};
|
|
2771
|
-
exports.SDKSchemaApiFactory = SDKSchemaApiFactory;
|
|
2772
|
-
/**
|
|
2773
|
-
* SDKSchemaApi - object-oriented interface
|
|
2774
|
-
*/
|
|
2775
|
-
class SDKSchemaApi extends base_1.BaseAPI {
|
|
2776
|
-
/**
|
|
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)
|
|
2782
|
-
* @param {*} [options] Override http request option.
|
|
2783
|
-
* @throws {RequiredError}
|
|
2784
|
-
*/
|
|
2785
|
-
apiV1StoresXStoreIDDocumentsDelete(xStoreid, xStoreWriteSecret, xStoreID, options) {
|
|
2786
|
-
return (0, exports.SDKSchemaApiFp)(this.configuration).apiV1StoresXStoreIDDocumentsDelete(xStoreid, xStoreWriteSecret, xStoreID, options).then((request) => request(this.axios, this.basePath));
|
|
2787
|
-
}
|
|
2788
|
-
/**
|
|
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)
|
|
2794
|
-
* @param {*} [options] Override http request option.
|
|
2795
|
-
* @throws {RequiredError}
|
|
2796
|
-
*/
|
|
2797
|
-
apiV1StoresXStoreIDSchemaGet(xStoreid, xStoresecret, xStoreID, options) {
|
|
2798
|
-
return (0, exports.SDKSchemaApiFp)(this.configuration).apiV1StoresXStoreIDSchemaGet(xStoreid, xStoresecret, xStoreID, options).then((request) => request(this.axios, this.basePath));
|
|
2799
|
-
}
|
|
2800
|
-
/**
|
|
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
|
|
2807
|
-
* @param {*} [options] Override http request option.
|
|
2808
|
-
* @throws {RequiredError}
|
|
2809
|
-
*/
|
|
2810
|
-
apiV1StoresXStoreIDSchemaPost(xStoreid, xStoreWriteSecret, xStoreID, dataTypesCollectionSchemaRequest, options) {
|
|
2811
|
-
return (0, exports.SDKSchemaApiFp)(this.configuration).apiV1StoresXStoreIDSchemaPost(xStoreid, xStoreWriteSecret, xStoreID, dataTypesCollectionSchemaRequest, options).then((request) => request(this.axios, this.basePath));
|
|
2812
|
-
}
|
|
2813
|
-
}
|
|
2814
|
-
exports.SDKSchemaApi = SDKSchemaApi;
|
|
2815
|
-
/**
|
|
2816
|
-
* SDKStoreConfigApi - axios parameter creator
|
|
2817
|
-
*/
|
|
2818
|
-
const SDKStoreConfigApiAxiosParamCreator = function (configuration) {
|
|
2819
|
-
return {
|
|
2820
2150
|
/**
|
|
2821
|
-
*
|
|
2822
|
-
* @summary Get
|
|
2151
|
+
* 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.
|
|
2152
|
+
* @summary Get a document by ID
|
|
2823
2153
|
* @param {string} xStoreid Store ID (from dashboard)
|
|
2824
2154
|
* @param {string} xStoresecret Store read secret
|
|
2825
2155
|
* @param {string} xStoreID Store ID (must match x-storeid header)
|
|
2156
|
+
* @param {string} documentID Document ID to retrieve
|
|
2826
2157
|
* @param {*} [options] Override http request option.
|
|
2827
2158
|
* @throws {RequiredError}
|
|
2828
2159
|
*/
|
|
2829
|
-
|
|
2160
|
+
apiV1StoresXStoreIDDocumentsDocumentIDGet: async (xStoreid, xStoresecret, xStoreID, documentID, options = {}) => {
|
|
2830
2161
|
// verify required parameter 'xStoreid' is not null or undefined
|
|
2831
|
-
(0, common_1.assertParamExists)('
|
|
2162
|
+
(0, common_1.assertParamExists)('apiV1StoresXStoreIDDocumentsDocumentIDGet', 'xStoreid', xStoreid);
|
|
2832
2163
|
// verify required parameter 'xStoresecret' is not null or undefined
|
|
2833
|
-
(0, common_1.assertParamExists)('
|
|
2164
|
+
(0, common_1.assertParamExists)('apiV1StoresXStoreIDDocumentsDocumentIDGet', 'xStoresecret', xStoresecret);
|
|
2834
2165
|
// verify required parameter 'xStoreID' is not null or undefined
|
|
2835
|
-
(0, common_1.assertParamExists)('
|
|
2836
|
-
|
|
2837
|
-
|
|
2166
|
+
(0, common_1.assertParamExists)('apiV1StoresXStoreIDDocumentsDocumentIDGet', 'xStoreID', xStoreID);
|
|
2167
|
+
// verify required parameter 'documentID' is not null or undefined
|
|
2168
|
+
(0, common_1.assertParamExists)('apiV1StoresXStoreIDDocumentsDocumentIDGet', 'documentID', documentID);
|
|
2169
|
+
const localVarPath = `/api/v1/stores/{xStoreID}/documents/{documentID}`
|
|
2170
|
+
.replace(`{${"xStoreID"}}`, encodeURIComponent(String(xStoreID)))
|
|
2171
|
+
.replace(`{${"documentID"}}`, encodeURIComponent(String(documentID)));
|
|
2838
2172
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
2839
2173
|
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
2840
2174
|
let baseOptions;
|
|
@@ -2862,25 +2196,25 @@ const SDKStoreConfigApiAxiosParamCreator = function (configuration) {
|
|
|
2862
2196
|
};
|
|
2863
2197
|
},
|
|
2864
2198
|
/**
|
|
2865
|
-
*
|
|
2866
|
-
* @summary
|
|
2199
|
+
* 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.
|
|
2200
|
+
* @summary Index a single document
|
|
2867
2201
|
* @param {string} xStoreid Store ID (from dashboard)
|
|
2868
2202
|
* @param {string} xStoreWriteSecret Store write secret
|
|
2869
2203
|
* @param {string} xStoreID Store ID (must match x-storeid header)
|
|
2870
|
-
* @param {
|
|
2204
|
+
* @param {DataTypesDocumentRequest} dataTypesDocumentRequest Document fields to index
|
|
2871
2205
|
* @param {*} [options] Override http request option.
|
|
2872
2206
|
* @throws {RequiredError}
|
|
2873
2207
|
*/
|
|
2874
|
-
|
|
2208
|
+
apiV1StoresXStoreIDDocumentsPost: async (xStoreid, xStoreWriteSecret, xStoreID, dataTypesDocumentRequest, options = {}) => {
|
|
2875
2209
|
// verify required parameter 'xStoreid' is not null or undefined
|
|
2876
|
-
(0, common_1.assertParamExists)('
|
|
2210
|
+
(0, common_1.assertParamExists)('apiV1StoresXStoreIDDocumentsPost', 'xStoreid', xStoreid);
|
|
2877
2211
|
// verify required parameter 'xStoreWriteSecret' is not null or undefined
|
|
2878
|
-
(0, common_1.assertParamExists)('
|
|
2212
|
+
(0, common_1.assertParamExists)('apiV1StoresXStoreIDDocumentsPost', 'xStoreWriteSecret', xStoreWriteSecret);
|
|
2879
2213
|
// verify required parameter 'xStoreID' is not null or undefined
|
|
2880
|
-
(0, common_1.assertParamExists)('
|
|
2881
|
-
// verify required parameter '
|
|
2882
|
-
(0, common_1.assertParamExists)('
|
|
2883
|
-
const localVarPath = `/api/v1/stores/{xStoreID}/
|
|
2214
|
+
(0, common_1.assertParamExists)('apiV1StoresXStoreIDDocumentsPost', 'xStoreID', xStoreID);
|
|
2215
|
+
// verify required parameter 'dataTypesDocumentRequest' is not null or undefined
|
|
2216
|
+
(0, common_1.assertParamExists)('apiV1StoresXStoreIDDocumentsPost', 'dataTypesDocumentRequest', dataTypesDocumentRequest);
|
|
2217
|
+
const localVarPath = `/api/v1/stores/{xStoreID}/documents`
|
|
2884
2218
|
.replace(`{${"xStoreID"}}`, encodeURIComponent(String(xStoreID)));
|
|
2885
2219
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
2886
2220
|
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
@@ -2888,7 +2222,7 @@ const SDKStoreConfigApiAxiosParamCreator = function (configuration) {
|
|
|
2888
2222
|
if (configuration) {
|
|
2889
2223
|
baseOptions = configuration.baseOptions;
|
|
2890
2224
|
}
|
|
2891
|
-
const localVarRequestOptions = { method: '
|
|
2225
|
+
const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options };
|
|
2892
2226
|
const localVarHeaderParameter = {};
|
|
2893
2227
|
const localVarQueryParameter = {};
|
|
2894
2228
|
// authentication ApiKeyAuth required
|
|
@@ -2904,29 +2238,29 @@ const SDKStoreConfigApiAxiosParamCreator = function (configuration) {
|
|
|
2904
2238
|
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
2905
2239
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
2906
2240
|
localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
|
|
2907
|
-
localVarRequestOptions.data = (0, common_1.serializeDataIfNeeded)(
|
|
2241
|
+
localVarRequestOptions.data = (0, common_1.serializeDataIfNeeded)(dataTypesDocumentRequest, localVarRequestOptions, configuration);
|
|
2908
2242
|
return {
|
|
2909
2243
|
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
2910
2244
|
options: localVarRequestOptions,
|
|
2911
2245
|
};
|
|
2912
2246
|
},
|
|
2913
2247
|
/**
|
|
2914
|
-
* Returns
|
|
2915
|
-
* @summary Get store
|
|
2248
|
+
* Returns basic store details (name, location, status). **Auth:** `x-storeid` and `x-storesecret`. Path `xStoreID` must match the `x-storeid` header.
|
|
2249
|
+
* @summary Get store info
|
|
2916
2250
|
* @param {string} xStoreid Store ID (from dashboard)
|
|
2917
2251
|
* @param {string} xStoresecret Store read secret
|
|
2918
2252
|
* @param {string} xStoreID Store ID (must match x-storeid header)
|
|
2919
2253
|
* @param {*} [options] Override http request option.
|
|
2920
2254
|
* @throws {RequiredError}
|
|
2921
2255
|
*/
|
|
2922
|
-
|
|
2256
|
+
apiV1StoresXStoreIDGet: async (xStoreid, xStoresecret, xStoreID, options = {}) => {
|
|
2923
2257
|
// verify required parameter 'xStoreid' is not null or undefined
|
|
2924
|
-
(0, common_1.assertParamExists)('
|
|
2258
|
+
(0, common_1.assertParamExists)('apiV1StoresXStoreIDGet', 'xStoreid', xStoreid);
|
|
2925
2259
|
// verify required parameter 'xStoresecret' is not null or undefined
|
|
2926
|
-
(0, common_1.assertParamExists)('
|
|
2260
|
+
(0, common_1.assertParamExists)('apiV1StoresXStoreIDGet', 'xStoresecret', xStoresecret);
|
|
2927
2261
|
// verify required parameter 'xStoreID' is not null or undefined
|
|
2928
|
-
(0, common_1.assertParamExists)('
|
|
2929
|
-
const localVarPath = `/api/v1/stores/{xStoreID}
|
|
2262
|
+
(0, common_1.assertParamExists)('apiV1StoresXStoreIDGet', 'xStoreID', xStoreID);
|
|
2263
|
+
const localVarPath = `/api/v1/stores/{xStoreID}`
|
|
2930
2264
|
.replace(`{${"xStoreID"}}`, encodeURIComponent(String(xStoreID)));
|
|
2931
2265
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
2932
2266
|
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
@@ -2954,282 +2288,116 @@ const SDKStoreConfigApiAxiosParamCreator = function (configuration) {
|
|
|
2954
2288
|
options: localVarRequestOptions,
|
|
2955
2289
|
};
|
|
2956
2290
|
},
|
|
2957
|
-
};
|
|
2958
|
-
};
|
|
2959
|
-
exports.SDKStoreConfigApiAxiosParamCreator = SDKStoreConfigApiAxiosParamCreator;
|
|
2960
|
-
/**
|
|
2961
|
-
* SDKStoreConfigApi - functional programming interface
|
|
2962
|
-
*/
|
|
2963
|
-
const SDKStoreConfigApiFp = function (configuration) {
|
|
2964
|
-
const localVarAxiosParamCreator = (0, exports.SDKStoreConfigApiAxiosParamCreator)(configuration);
|
|
2965
|
-
return {
|
|
2966
|
-
/**
|
|
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)
|
|
2972
|
-
* @param {*} [options] Override http request option.
|
|
2973
|
-
* @throws {RequiredError}
|
|
2974
|
-
*/
|
|
2975
|
-
async apiV1StoresXStoreIDConfigGet(xStoreid, xStoresecret, xStoreID, options) {
|
|
2976
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.apiV1StoresXStoreIDConfigGet(xStoreid, xStoresecret, xStoreID, options);
|
|
2977
|
-
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
2978
|
-
const localVarOperationServerBasePath = base_1.operationServerMap['SDKStoreConfigApi.apiV1StoresXStoreIDConfigGet']?.[localVarOperationServerIndex]?.url;
|
|
2979
|
-
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
2980
|
-
},
|
|
2981
|
-
/**
|
|
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)
|
|
2988
|
-
* @param {*} [options] Override http request option.
|
|
2989
|
-
* @throws {RequiredError}
|
|
2990
|
-
*/
|
|
2991
|
-
async apiV1StoresXStoreIDConfigPut(xStoreid, xStoreWriteSecret, xStoreID, dataTypesIndexConfig, options) {
|
|
2992
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.apiV1StoresXStoreIDConfigPut(xStoreid, xStoreWriteSecret, xStoreID, dataTypesIndexConfig, options);
|
|
2993
|
-
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
2994
|
-
const localVarOperationServerBasePath = base_1.operationServerMap['SDKStoreConfigApi.apiV1StoresXStoreIDConfigPut']?.[localVarOperationServerIndex]?.url;
|
|
2995
|
-
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
2996
|
-
},
|
|
2997
|
-
/**
|
|
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)
|
|
3003
|
-
* @param {*} [options] Override http request option.
|
|
3004
|
-
* @throws {RequiredError}
|
|
3005
|
-
*/
|
|
3006
|
-
async apiV1StoresXStoreIDConfigSchemaGet(xStoreid, xStoresecret, xStoreID, options) {
|
|
3007
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.apiV1StoresXStoreIDConfigSchemaGet(xStoreid, xStoresecret, xStoreID, options);
|
|
3008
|
-
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
3009
|
-
const localVarOperationServerBasePath = base_1.operationServerMap['SDKStoreConfigApi.apiV1StoresXStoreIDConfigSchemaGet']?.[localVarOperationServerIndex]?.url;
|
|
3010
|
-
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
3011
|
-
},
|
|
3012
|
-
};
|
|
3013
|
-
};
|
|
3014
|
-
exports.SDKStoreConfigApiFp = SDKStoreConfigApiFp;
|
|
3015
|
-
/**
|
|
3016
|
-
* SDKStoreConfigApi - factory interface
|
|
3017
|
-
*/
|
|
3018
|
-
const SDKStoreConfigApiFactory = function (configuration, basePath, axios) {
|
|
3019
|
-
const localVarFp = (0, exports.SDKStoreConfigApiFp)(configuration);
|
|
3020
|
-
return {
|
|
3021
2291
|
/**
|
|
3022
|
-
* Returns
|
|
3023
|
-
* @summary Get
|
|
2292
|
+
* Returns autocomplete/suggestions configuration for the store. **Auth:** `x-storeid` and `x-storesecret`. Path `xStoreID` must match the `x-storeid` header.
|
|
2293
|
+
* @summary Get query suggestions configuration
|
|
3024
2294
|
* @param {string} xStoreid Store ID (from dashboard)
|
|
3025
2295
|
* @param {string} xStoresecret Store read secret
|
|
3026
2296
|
* @param {string} xStoreID Store ID (must match x-storeid header)
|
|
3027
2297
|
* @param {*} [options] Override http request option.
|
|
3028
2298
|
* @throws {RequiredError}
|
|
3029
2299
|
*/
|
|
3030
|
-
|
|
3031
|
-
|
|
2300
|
+
apiV1StoresXStoreIDQuerySuggestionsConfigGet: async (xStoreid, xStoresecret, xStoreID, options = {}) => {
|
|
2301
|
+
// verify required parameter 'xStoreid' is not null or undefined
|
|
2302
|
+
(0, common_1.assertParamExists)('apiV1StoresXStoreIDQuerySuggestionsConfigGet', 'xStoreid', xStoreid);
|
|
2303
|
+
// verify required parameter 'xStoresecret' is not null or undefined
|
|
2304
|
+
(0, common_1.assertParamExists)('apiV1StoresXStoreIDQuerySuggestionsConfigGet', 'xStoresecret', xStoresecret);
|
|
2305
|
+
// verify required parameter 'xStoreID' is not null or undefined
|
|
2306
|
+
(0, common_1.assertParamExists)('apiV1StoresXStoreIDQuerySuggestionsConfigGet', 'xStoreID', xStoreID);
|
|
2307
|
+
const localVarPath = `/api/v1/stores/{xStoreID}/query-suggestions/config`
|
|
2308
|
+
.replace(`{${"xStoreID"}}`, encodeURIComponent(String(xStoreID)));
|
|
2309
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
2310
|
+
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
2311
|
+
let baseOptions;
|
|
2312
|
+
if (configuration) {
|
|
2313
|
+
baseOptions = configuration.baseOptions;
|
|
2314
|
+
}
|
|
2315
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options };
|
|
2316
|
+
const localVarHeaderParameter = {};
|
|
2317
|
+
const localVarQueryParameter = {};
|
|
2318
|
+
// authentication ApiKeyAuth required
|
|
2319
|
+
await (0, common_1.setApiKeyToObject)(localVarHeaderParameter, "x-storesecret", configuration);
|
|
2320
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
2321
|
+
if (xStoreid != null) {
|
|
2322
|
+
localVarHeaderParameter['x-storeid'] = String(xStoreid);
|
|
2323
|
+
}
|
|
2324
|
+
if (xStoresecret != null) {
|
|
2325
|
+
localVarHeaderParameter['x-storesecret'] = String(xStoresecret);
|
|
2326
|
+
}
|
|
2327
|
+
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
2328
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
2329
|
+
localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
|
|
2330
|
+
return {
|
|
2331
|
+
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
2332
|
+
options: localVarRequestOptions,
|
|
2333
|
+
};
|
|
3032
2334
|
},
|
|
3033
2335
|
/**
|
|
3034
|
-
* Update
|
|
3035
|
-
* @summary Update
|
|
2336
|
+
* 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.
|
|
2337
|
+
* @summary Update query suggestions configuration
|
|
3036
2338
|
* @param {string} xStoreid Store ID (from dashboard)
|
|
3037
2339
|
* @param {string} xStoreWriteSecret Store write secret
|
|
3038
2340
|
* @param {string} xStoreID Store ID (must match x-storeid header)
|
|
3039
|
-
* @param {
|
|
3040
|
-
* @param {*} [options] Override http request option.
|
|
3041
|
-
* @throws {RequiredError}
|
|
3042
|
-
*/
|
|
3043
|
-
apiV1StoresXStoreIDConfigPut(xStoreid, xStoreWriteSecret, xStoreID, dataTypesIndexConfig, options) {
|
|
3044
|
-
return localVarFp.apiV1StoresXStoreIDConfigPut(xStoreid, xStoreWriteSecret, xStoreID, dataTypesIndexConfig, options).then((request) => request(axios, basePath));
|
|
3045
|
-
},
|
|
3046
|
-
/**
|
|
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)
|
|
3052
|
-
* @param {*} [options] Override http request option.
|
|
3053
|
-
* @throws {RequiredError}
|
|
3054
|
-
*/
|
|
3055
|
-
apiV1StoresXStoreIDConfigSchemaGet(xStoreid, xStoresecret, xStoreID, options) {
|
|
3056
|
-
return localVarFp.apiV1StoresXStoreIDConfigSchemaGet(xStoreid, xStoresecret, xStoreID, options).then((request) => request(axios, basePath));
|
|
3057
|
-
},
|
|
3058
|
-
};
|
|
3059
|
-
};
|
|
3060
|
-
exports.SDKStoreConfigApiFactory = SDKStoreConfigApiFactory;
|
|
3061
|
-
/**
|
|
3062
|
-
* SDKStoreConfigApi - object-oriented interface
|
|
3063
|
-
*/
|
|
3064
|
-
class SDKStoreConfigApi extends base_1.BaseAPI {
|
|
3065
|
-
/**
|
|
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)
|
|
3071
|
-
* @param {*} [options] Override http request option.
|
|
3072
|
-
* @throws {RequiredError}
|
|
3073
|
-
*/
|
|
3074
|
-
apiV1StoresXStoreIDConfigGet(xStoreid, xStoresecret, xStoreID, options) {
|
|
3075
|
-
return (0, exports.SDKStoreConfigApiFp)(this.configuration).apiV1StoresXStoreIDConfigGet(xStoreid, xStoresecret, xStoreID, options).then((request) => request(this.axios, this.basePath));
|
|
3076
|
-
}
|
|
3077
|
-
/**
|
|
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)
|
|
3084
|
-
* @param {*} [options] Override http request option.
|
|
3085
|
-
* @throws {RequiredError}
|
|
3086
|
-
*/
|
|
3087
|
-
apiV1StoresXStoreIDConfigPut(xStoreid, xStoreWriteSecret, xStoreID, dataTypesIndexConfig, options) {
|
|
3088
|
-
return (0, exports.SDKStoreConfigApiFp)(this.configuration).apiV1StoresXStoreIDConfigPut(xStoreid, xStoreWriteSecret, xStoreID, dataTypesIndexConfig, options).then((request) => request(this.axios, this.basePath));
|
|
3089
|
-
}
|
|
3090
|
-
/**
|
|
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)
|
|
3096
|
-
* @param {*} [options] Override http request option.
|
|
3097
|
-
* @throws {RequiredError}
|
|
3098
|
-
*/
|
|
3099
|
-
apiV1StoresXStoreIDConfigSchemaGet(xStoreid, xStoresecret, xStoreID, options) {
|
|
3100
|
-
return (0, exports.SDKStoreConfigApiFp)(this.configuration).apiV1StoresXStoreIDConfigSchemaGet(xStoreid, xStoresecret, xStoreID, options).then((request) => request(this.axios, this.basePath));
|
|
3101
|
-
}
|
|
3102
|
-
}
|
|
3103
|
-
exports.SDKStoreConfigApi = SDKStoreConfigApi;
|
|
3104
|
-
/**
|
|
3105
|
-
* SDKStoreCreationApi - axios parameter creator
|
|
3106
|
-
*/
|
|
3107
|
-
const SDKStoreCreationApiAxiosParamCreator = function (configuration) {
|
|
3108
|
-
return {
|
|
3109
|
-
/**
|
|
3110
|
-
* Creates a new store with minimal information. Returns store credentials (xStoreID, xStoreSecret, xStoreWriteSecret) immediately. This is a public API for SDK integration. Requires JWT authentication.
|
|
3111
|
-
* @summary Create Store (Public SDK API)
|
|
3112
|
-
* @param {string} authorization Bearer JWT Token
|
|
3113
|
-
* @param {DataTypesPublicCreateStoreRequest} dataTypesPublicCreateStoreRequest Store creation request
|
|
2341
|
+
* @param {QuerySuggestionsServiceUpdateSuggestionConfigRequest} querySuggestionsServiceUpdateSuggestionConfigRequest Fields to update (partial)
|
|
3114
2342
|
* @param {*} [options] Override http request option.
|
|
3115
2343
|
* @throws {RequiredError}
|
|
3116
2344
|
*/
|
|
3117
|
-
|
|
3118
|
-
// verify required parameter '
|
|
3119
|
-
(0, common_1.assertParamExists)('
|
|
3120
|
-
// verify required parameter '
|
|
3121
|
-
(0, common_1.assertParamExists)('
|
|
3122
|
-
|
|
2345
|
+
apiV1StoresXStoreIDQuerySuggestionsConfigPut: async (xStoreid, xStoreWriteSecret, xStoreID, querySuggestionsServiceUpdateSuggestionConfigRequest, options = {}) => {
|
|
2346
|
+
// verify required parameter 'xStoreid' is not null or undefined
|
|
2347
|
+
(0, common_1.assertParamExists)('apiV1StoresXStoreIDQuerySuggestionsConfigPut', 'xStoreid', xStoreid);
|
|
2348
|
+
// verify required parameter 'xStoreWriteSecret' is not null or undefined
|
|
2349
|
+
(0, common_1.assertParamExists)('apiV1StoresXStoreIDQuerySuggestionsConfigPut', 'xStoreWriteSecret', xStoreWriteSecret);
|
|
2350
|
+
// verify required parameter 'xStoreID' is not null or undefined
|
|
2351
|
+
(0, common_1.assertParamExists)('apiV1StoresXStoreIDQuerySuggestionsConfigPut', 'xStoreID', xStoreID);
|
|
2352
|
+
// verify required parameter 'querySuggestionsServiceUpdateSuggestionConfigRequest' is not null or undefined
|
|
2353
|
+
(0, common_1.assertParamExists)('apiV1StoresXStoreIDQuerySuggestionsConfigPut', 'querySuggestionsServiceUpdateSuggestionConfigRequest', querySuggestionsServiceUpdateSuggestionConfigRequest);
|
|
2354
|
+
const localVarPath = `/api/v1/stores/{xStoreID}/query-suggestions/config`
|
|
2355
|
+
.replace(`{${"xStoreID"}}`, encodeURIComponent(String(xStoreID)));
|
|
3123
2356
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
3124
2357
|
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
3125
2358
|
let baseOptions;
|
|
3126
2359
|
if (configuration) {
|
|
3127
2360
|
baseOptions = configuration.baseOptions;
|
|
3128
2361
|
}
|
|
3129
|
-
const localVarRequestOptions = { method: '
|
|
2362
|
+
const localVarRequestOptions = { method: 'PUT', ...baseOptions, ...options };
|
|
3130
2363
|
const localVarHeaderParameter = {};
|
|
3131
2364
|
const localVarQueryParameter = {};
|
|
3132
|
-
// authentication
|
|
3133
|
-
await (0, common_1.setApiKeyToObject)(localVarHeaderParameter, "
|
|
2365
|
+
// authentication ApiKeyAuth required
|
|
2366
|
+
await (0, common_1.setApiKeyToObject)(localVarHeaderParameter, "x-storesecret", configuration);
|
|
3134
2367
|
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
3135
2368
|
localVarHeaderParameter['Accept'] = 'application/json';
|
|
3136
|
-
if (
|
|
3137
|
-
localVarHeaderParameter['
|
|
2369
|
+
if (xStoreid != null) {
|
|
2370
|
+
localVarHeaderParameter['x-storeid'] = String(xStoreid);
|
|
2371
|
+
}
|
|
2372
|
+
if (xStoreWriteSecret != null) {
|
|
2373
|
+
localVarHeaderParameter['x-store-write-secret'] = String(xStoreWriteSecret);
|
|
3138
2374
|
}
|
|
3139
2375
|
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
3140
2376
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
3141
2377
|
localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
|
|
3142
|
-
localVarRequestOptions.data = (0, common_1.serializeDataIfNeeded)(
|
|
2378
|
+
localVarRequestOptions.data = (0, common_1.serializeDataIfNeeded)(querySuggestionsServiceUpdateSuggestionConfigRequest, localVarRequestOptions, configuration);
|
|
3143
2379
|
return {
|
|
3144
2380
|
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
3145
2381
|
options: localVarRequestOptions,
|
|
3146
2382
|
};
|
|
3147
2383
|
},
|
|
3148
|
-
};
|
|
3149
|
-
};
|
|
3150
|
-
exports.SDKStoreCreationApiAxiosParamCreator = SDKStoreCreationApiAxiosParamCreator;
|
|
3151
|
-
/**
|
|
3152
|
-
* SDKStoreCreationApi - functional programming interface
|
|
3153
|
-
*/
|
|
3154
|
-
const SDKStoreCreationApiFp = function (configuration) {
|
|
3155
|
-
const localVarAxiosParamCreator = (0, exports.SDKStoreCreationApiAxiosParamCreator)(configuration);
|
|
3156
|
-
return {
|
|
3157
|
-
/**
|
|
3158
|
-
* Creates a new store with minimal information. Returns store credentials (xStoreID, xStoreSecret, xStoreWriteSecret) immediately. This is a public API for SDK integration. Requires JWT authentication.
|
|
3159
|
-
* @summary Create Store (Public SDK API)
|
|
3160
|
-
* @param {string} authorization Bearer JWT Token
|
|
3161
|
-
* @param {DataTypesPublicCreateStoreRequest} dataTypesPublicCreateStoreRequest Store creation request
|
|
3162
|
-
* @param {*} [options] Override http request option.
|
|
3163
|
-
* @throws {RequiredError}
|
|
3164
|
-
*/
|
|
3165
|
-
async apiV1StoresPost(authorization, dataTypesPublicCreateStoreRequest, options) {
|
|
3166
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.apiV1StoresPost(authorization, dataTypesPublicCreateStoreRequest, options);
|
|
3167
|
-
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
3168
|
-
const localVarOperationServerBasePath = base_1.operationServerMap['SDKStoreCreationApi.apiV1StoresPost']?.[localVarOperationServerIndex]?.url;
|
|
3169
|
-
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
3170
|
-
},
|
|
3171
|
-
};
|
|
3172
|
-
};
|
|
3173
|
-
exports.SDKStoreCreationApiFp = SDKStoreCreationApiFp;
|
|
3174
|
-
/**
|
|
3175
|
-
* SDKStoreCreationApi - factory interface
|
|
3176
|
-
*/
|
|
3177
|
-
const SDKStoreCreationApiFactory = function (configuration, basePath, axios) {
|
|
3178
|
-
const localVarFp = (0, exports.SDKStoreCreationApiFp)(configuration);
|
|
3179
|
-
return {
|
|
3180
|
-
/**
|
|
3181
|
-
* Creates a new store with minimal information. Returns store credentials (xStoreID, xStoreSecret, xStoreWriteSecret) immediately. This is a public API for SDK integration. Requires JWT authentication.
|
|
3182
|
-
* @summary Create Store (Public SDK API)
|
|
3183
|
-
* @param {string} authorization Bearer JWT Token
|
|
3184
|
-
* @param {DataTypesPublicCreateStoreRequest} dataTypesPublicCreateStoreRequest Store creation request
|
|
3185
|
-
* @param {*} [options] Override http request option.
|
|
3186
|
-
* @throws {RequiredError}
|
|
3187
|
-
*/
|
|
3188
|
-
apiV1StoresPost(authorization, dataTypesPublicCreateStoreRequest, options) {
|
|
3189
|
-
return localVarFp.apiV1StoresPost(authorization, dataTypesPublicCreateStoreRequest, options).then((request) => request(axios, basePath));
|
|
3190
|
-
},
|
|
3191
|
-
};
|
|
3192
|
-
};
|
|
3193
|
-
exports.SDKStoreCreationApiFactory = SDKStoreCreationApiFactory;
|
|
3194
|
-
/**
|
|
3195
|
-
* SDKStoreCreationApi - object-oriented interface
|
|
3196
|
-
*/
|
|
3197
|
-
class SDKStoreCreationApi extends base_1.BaseAPI {
|
|
3198
|
-
/**
|
|
3199
|
-
* Creates a new store with minimal information. Returns store credentials (xStoreID, xStoreSecret, xStoreWriteSecret) immediately. This is a public API for SDK integration. Requires JWT authentication.
|
|
3200
|
-
* @summary Create Store (Public SDK API)
|
|
3201
|
-
* @param {string} authorization Bearer JWT Token
|
|
3202
|
-
* @param {DataTypesPublicCreateStoreRequest} dataTypesPublicCreateStoreRequest Store creation request
|
|
3203
|
-
* @param {*} [options] Override http request option.
|
|
3204
|
-
* @throws {RequiredError}
|
|
3205
|
-
*/
|
|
3206
|
-
apiV1StoresPost(authorization, dataTypesPublicCreateStoreRequest, options) {
|
|
3207
|
-
return (0, exports.SDKStoreCreationApiFp)(this.configuration).apiV1StoresPost(authorization, dataTypesPublicCreateStoreRequest, options).then((request) => request(this.axios, this.basePath));
|
|
3208
|
-
}
|
|
3209
|
-
}
|
|
3210
|
-
exports.SDKStoreCreationApi = SDKStoreCreationApi;
|
|
3211
|
-
/**
|
|
3212
|
-
* SDKStoreInfoApi - axios parameter creator
|
|
3213
|
-
*/
|
|
3214
|
-
const SDKStoreInfoApiAxiosParamCreator = function (configuration) {
|
|
3215
|
-
return {
|
|
3216
2384
|
/**
|
|
3217
|
-
* Returns
|
|
3218
|
-
* @summary Get
|
|
2385
|
+
* 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.
|
|
2386
|
+
* @summary Get index schema
|
|
3219
2387
|
* @param {string} xStoreid Store ID (from dashboard)
|
|
3220
2388
|
* @param {string} xStoresecret Store read secret
|
|
3221
2389
|
* @param {string} xStoreID Store ID (must match x-storeid header)
|
|
3222
2390
|
* @param {*} [options] Override http request option.
|
|
3223
2391
|
* @throws {RequiredError}
|
|
3224
2392
|
*/
|
|
3225
|
-
|
|
2393
|
+
apiV1StoresXStoreIDSchemaGet: async (xStoreid, xStoresecret, xStoreID, options = {}) => {
|
|
3226
2394
|
// verify required parameter 'xStoreid' is not null or undefined
|
|
3227
|
-
(0, common_1.assertParamExists)('
|
|
2395
|
+
(0, common_1.assertParamExists)('apiV1StoresXStoreIDSchemaGet', 'xStoreid', xStoreid);
|
|
3228
2396
|
// verify required parameter 'xStoresecret' is not null or undefined
|
|
3229
|
-
(0, common_1.assertParamExists)('
|
|
2397
|
+
(0, common_1.assertParamExists)('apiV1StoresXStoreIDSchemaGet', 'xStoresecret', xStoresecret);
|
|
3230
2398
|
// verify required parameter 'xStoreID' is not null or undefined
|
|
3231
|
-
(0, common_1.assertParamExists)('
|
|
3232
|
-
const localVarPath = `/api/v1/stores/{xStoreID}`
|
|
2399
|
+
(0, common_1.assertParamExists)('apiV1StoresXStoreIDSchemaGet', 'xStoreID', xStoreID);
|
|
2400
|
+
const localVarPath = `/api/v1/stores/{xStoreID}/schema`
|
|
3233
2401
|
.replace(`{${"xStoreID"}}`, encodeURIComponent(String(xStoreID)));
|
|
3234
2402
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
3235
2403
|
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
@@ -3257,567 +2425,643 @@ const SDKStoreInfoApiAxiosParamCreator = function (configuration) {
|
|
|
3257
2425
|
options: localVarRequestOptions,
|
|
3258
2426
|
};
|
|
3259
2427
|
},
|
|
3260
|
-
};
|
|
3261
|
-
};
|
|
3262
|
-
exports.SDKStoreInfoApiAxiosParamCreator = SDKStoreInfoApiAxiosParamCreator;
|
|
3263
|
-
/**
|
|
3264
|
-
* SDKStoreInfoApi - functional programming interface
|
|
3265
|
-
*/
|
|
3266
|
-
const SDKStoreInfoApiFp = function (configuration) {
|
|
3267
|
-
const localVarAxiosParamCreator = (0, exports.SDKStoreInfoApiAxiosParamCreator)(configuration);
|
|
3268
|
-
return {
|
|
3269
2428
|
/**
|
|
3270
|
-
*
|
|
3271
|
-
* @summary
|
|
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)
|
|
3275
|
-
* @param {*} [options] Override http request option.
|
|
3276
|
-
* @throws {RequiredError}
|
|
3277
|
-
*/
|
|
3278
|
-
async apiV1StoresXStoreIDGet(xStoreid, xStoresecret, xStoreID, options) {
|
|
3279
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.apiV1StoresXStoreIDGet(xStoreid, xStoresecret, xStoreID, options);
|
|
3280
|
-
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
3281
|
-
const localVarOperationServerBasePath = base_1.operationServerMap['SDKStoreInfoApi.apiV1StoresXStoreIDGet']?.[localVarOperationServerIndex]?.url;
|
|
3282
|
-
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
3283
|
-
},
|
|
3284
|
-
};
|
|
3285
|
-
};
|
|
3286
|
-
exports.SDKStoreInfoApiFp = SDKStoreInfoApiFp;
|
|
3287
|
-
/**
|
|
3288
|
-
* SDKStoreInfoApi - factory interface
|
|
3289
|
-
*/
|
|
3290
|
-
const SDKStoreInfoApiFactory = function (configuration, basePath, axios) {
|
|
3291
|
-
const localVarFp = (0, exports.SDKStoreInfoApiFp)(configuration);
|
|
3292
|
-
return {
|
|
3293
|
-
/**
|
|
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
|
|
2429
|
+
* 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.
|
|
2430
|
+
* @summary Create or update index schema
|
|
3296
2431
|
* @param {string} xStoreid Store ID (from dashboard)
|
|
3297
|
-
* @param {string}
|
|
2432
|
+
* @param {string} xStoreWriteSecret Store write secret
|
|
3298
2433
|
* @param {string} xStoreID Store ID (must match x-storeid header)
|
|
2434
|
+
* @param {DataTypesCollectionSchemaRequest} dataTypesCollectionSchemaRequest Schema definition and mode
|
|
3299
2435
|
* @param {*} [options] Override http request option.
|
|
3300
2436
|
* @throws {RequiredError}
|
|
3301
2437
|
*/
|
|
3302
|
-
|
|
3303
|
-
return localVarFp.apiV1StoresXStoreIDGet(xStoreid, xStoresecret, xStoreID, options).then((request) => request(axios, basePath));
|
|
3304
|
-
},
|
|
3305
|
-
};
|
|
3306
|
-
};
|
|
3307
|
-
exports.SDKStoreInfoApiFactory = SDKStoreInfoApiFactory;
|
|
3308
|
-
/**
|
|
3309
|
-
* SDKStoreInfoApi - object-oriented interface
|
|
3310
|
-
*/
|
|
3311
|
-
class SDKStoreInfoApi extends base_1.BaseAPI {
|
|
3312
|
-
/**
|
|
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)
|
|
3318
|
-
* @param {*} [options] Override http request option.
|
|
3319
|
-
* @throws {RequiredError}
|
|
3320
|
-
*/
|
|
3321
|
-
apiV1StoresXStoreIDGet(xStoreid, xStoresecret, xStoreID, options) {
|
|
3322
|
-
return (0, exports.SDKStoreInfoApiFp)(this.configuration).apiV1StoresXStoreIDGet(xStoreid, xStoresecret, xStoreID, options).then((request) => request(this.axios, this.basePath));
|
|
3323
|
-
}
|
|
3324
|
-
}
|
|
3325
|
-
exports.SDKStoreInfoApi = SDKStoreInfoApi;
|
|
3326
|
-
/**
|
|
3327
|
-
* SearchApi - axios parameter creator
|
|
3328
|
-
*/
|
|
3329
|
-
const SearchApiAxiosParamCreator = function (configuration) {
|
|
3330
|
-
return {
|
|
3331
|
-
/**
|
|
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)
|
|
3336
|
-
* @param {string} q Search query
|
|
3337
|
-
* @param {string} [xUserId] User ID for personalization
|
|
3338
|
-
* @param {string} [xAnonId] Anonymous user ID for personalization
|
|
3339
|
-
* @param {string} [xSessionId] Session ID for personalization
|
|
3340
|
-
* @param {number} [page] Page number (default: 1)
|
|
3341
|
-
* @param {number} [perPage] Items per page (default: 10)
|
|
3342
|
-
* @param {string} [sortBy] Sort option (e.g., price:asc, created_at:desc)
|
|
3343
|
-
* @param {string} [filterBy] Filter string (e.g., category:shirts)
|
|
3344
|
-
* @param {string} [facetBy] Facet fields (comma-separated)
|
|
3345
|
-
* @param {number} [maxFacetValues] Maximum facet values to return
|
|
3346
|
-
* @param {boolean} [widgetMode] Return widget-formatted results
|
|
3347
|
-
* @param {boolean} [includeSuggestions] Include autocomplete suggestions
|
|
3348
|
-
* @param {number} [suggestionsLimit] Number of suggestions to return
|
|
3349
|
-
* @param {string} [analyticsTags] Analytics tags (comma-separated)
|
|
3350
|
-
* @param {string} [stopwordSets] Stopword set IDs (comma-separated)
|
|
3351
|
-
* @param {string} [synonymSets] Synonym set IDs (comma-separated)
|
|
3352
|
-
* @param {string} [searchFields] Fields to search in (comma-separated)
|
|
3353
|
-
* @param {string} [returnFields] Fields to return (comma-separated)
|
|
3354
|
-
* @param {string} [omitFields] Fields to omit (comma-separated)
|
|
3355
|
-
* @param {string} [snippetFields] Fields to generate snippets for (comma-separated)
|
|
3356
|
-
* @param {string} [fullSnippetFields] Fields to include full snippet (comma-separated)
|
|
3357
|
-
* @param {string} [fieldWeights] Field weights as comma-separated integers (e.g., 3,2,1)
|
|
3358
|
-
* @param {string} [groupField] Field to group results by
|
|
3359
|
-
* @param {number} [groupSize] Number of results per group
|
|
3360
|
-
* @param {string} [snippetPrefix] Prefix for highlighted snippets
|
|
3361
|
-
* @param {string} [snippetSuffix] Suffix for highlighted snippets
|
|
3362
|
-
* @param {number} [snippetTokenLimit] Maximum tokens in snippet
|
|
3363
|
-
* @param {number} [snippetMinLen] Minimum snippet length
|
|
3364
|
-
* @param {boolean} [includeSnippets] Include snippets in results
|
|
3365
|
-
* @param {string} [prefixMode] Prefix matching mode (e.g., always, fallback, off)
|
|
3366
|
-
* @param {string} [infixMode] Infix matching mode (e.g., always, fallback, off)
|
|
3367
|
-
* @param {number} [typoMax] Maximum typo tolerance
|
|
3368
|
-
* @param {number} [typoMinLen1] Min word length for 1 typo
|
|
3369
|
-
* @param {number} [typoMinLen2] Min word length for 2 typos
|
|
3370
|
-
* @param {number} [searchTimeoutMs] Search timeout in milliseconds
|
|
3371
|
-
* @param {boolean} [requireAllTerms] Require all search terms to match
|
|
3372
|
-
* @param {boolean} [exactMatchBoost] Boost exact matches
|
|
3373
|
-
* @param {boolean} [cacheResults] Cache search results
|
|
3374
|
-
* @param {boolean} [applyRules] Apply search rules
|
|
3375
|
-
* @param {string} [presetName] Search preset name to use
|
|
3376
|
-
* @param {string} [facetSearchText] Text to filter facet values
|
|
3377
|
-
* @param {*} [options] Override http request option.
|
|
3378
|
-
* @throws {RequiredError}
|
|
3379
|
-
*/
|
|
3380
|
-
v1SearchGet: async (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 = {}) => {
|
|
2438
|
+
apiV1StoresXStoreIDSchemaPost: async (xStoreid, xStoreWriteSecret, xStoreID, dataTypesCollectionSchemaRequest, options = {}) => {
|
|
3381
2439
|
// verify required parameter 'xStoreid' is not null or undefined
|
|
3382
|
-
(0, common_1.assertParamExists)('
|
|
3383
|
-
// verify required parameter '
|
|
3384
|
-
(0, common_1.assertParamExists)('
|
|
3385
|
-
// verify required parameter '
|
|
3386
|
-
(0, common_1.assertParamExists)('
|
|
3387
|
-
|
|
2440
|
+
(0, common_1.assertParamExists)('apiV1StoresXStoreIDSchemaPost', 'xStoreid', xStoreid);
|
|
2441
|
+
// verify required parameter 'xStoreWriteSecret' is not null or undefined
|
|
2442
|
+
(0, common_1.assertParamExists)('apiV1StoresXStoreIDSchemaPost', 'xStoreWriteSecret', xStoreWriteSecret);
|
|
2443
|
+
// verify required parameter 'xStoreID' is not null or undefined
|
|
2444
|
+
(0, common_1.assertParamExists)('apiV1StoresXStoreIDSchemaPost', 'xStoreID', xStoreID);
|
|
2445
|
+
// verify required parameter 'dataTypesCollectionSchemaRequest' is not null or undefined
|
|
2446
|
+
(0, common_1.assertParamExists)('apiV1StoresXStoreIDSchemaPost', 'dataTypesCollectionSchemaRequest', dataTypesCollectionSchemaRequest);
|
|
2447
|
+
const localVarPath = `/api/v1/stores/{xStoreID}/schema`
|
|
2448
|
+
.replace(`{${"xStoreID"}}`, encodeURIComponent(String(xStoreID)));
|
|
3388
2449
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
3389
2450
|
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
3390
2451
|
let baseOptions;
|
|
3391
2452
|
if (configuration) {
|
|
3392
2453
|
baseOptions = configuration.baseOptions;
|
|
3393
2454
|
}
|
|
3394
|
-
const localVarRequestOptions = { method: '
|
|
2455
|
+
const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options };
|
|
3395
2456
|
const localVarHeaderParameter = {};
|
|
3396
2457
|
const localVarQueryParameter = {};
|
|
3397
|
-
|
|
3398
|
-
|
|
3399
|
-
|
|
3400
|
-
if (page !== undefined) {
|
|
3401
|
-
localVarQueryParameter['page'] = page;
|
|
3402
|
-
}
|
|
3403
|
-
if (perPage !== undefined) {
|
|
3404
|
-
localVarQueryParameter['per_page'] = perPage;
|
|
3405
|
-
}
|
|
3406
|
-
if (sortBy !== undefined) {
|
|
3407
|
-
localVarQueryParameter['sort_by'] = sortBy;
|
|
3408
|
-
}
|
|
3409
|
-
if (filterBy !== undefined) {
|
|
3410
|
-
localVarQueryParameter['filter_by'] = filterBy;
|
|
3411
|
-
}
|
|
3412
|
-
if (facetBy !== undefined) {
|
|
3413
|
-
localVarQueryParameter['facet_by'] = facetBy;
|
|
3414
|
-
}
|
|
3415
|
-
if (maxFacetValues !== undefined) {
|
|
3416
|
-
localVarQueryParameter['max_facet_values'] = maxFacetValues;
|
|
3417
|
-
}
|
|
3418
|
-
if (widgetMode !== undefined) {
|
|
3419
|
-
localVarQueryParameter['widget_mode'] = widgetMode;
|
|
3420
|
-
}
|
|
3421
|
-
if (includeSuggestions !== undefined) {
|
|
3422
|
-
localVarQueryParameter['include_suggestions'] = includeSuggestions;
|
|
3423
|
-
}
|
|
3424
|
-
if (suggestionsLimit !== undefined) {
|
|
3425
|
-
localVarQueryParameter['suggestions_limit'] = suggestionsLimit;
|
|
3426
|
-
}
|
|
3427
|
-
if (analyticsTags !== undefined) {
|
|
3428
|
-
localVarQueryParameter['analytics_tags'] = analyticsTags;
|
|
3429
|
-
}
|
|
3430
|
-
if (stopwordSets !== undefined) {
|
|
3431
|
-
localVarQueryParameter['stopword_sets'] = stopwordSets;
|
|
3432
|
-
}
|
|
3433
|
-
if (synonymSets !== undefined) {
|
|
3434
|
-
localVarQueryParameter['synonym_sets'] = synonymSets;
|
|
3435
|
-
}
|
|
3436
|
-
if (searchFields !== undefined) {
|
|
3437
|
-
localVarQueryParameter['search_fields'] = searchFields;
|
|
3438
|
-
}
|
|
3439
|
-
if (returnFields !== undefined) {
|
|
3440
|
-
localVarQueryParameter['return_fields'] = returnFields;
|
|
3441
|
-
}
|
|
3442
|
-
if (omitFields !== undefined) {
|
|
3443
|
-
localVarQueryParameter['omit_fields'] = omitFields;
|
|
3444
|
-
}
|
|
3445
|
-
if (snippetFields !== undefined) {
|
|
3446
|
-
localVarQueryParameter['snippet_fields'] = snippetFields;
|
|
3447
|
-
}
|
|
3448
|
-
if (fullSnippetFields !== undefined) {
|
|
3449
|
-
localVarQueryParameter['full_snippet_fields'] = fullSnippetFields;
|
|
3450
|
-
}
|
|
3451
|
-
if (fieldWeights !== undefined) {
|
|
3452
|
-
localVarQueryParameter['field_weights'] = fieldWeights;
|
|
3453
|
-
}
|
|
3454
|
-
if (groupField !== undefined) {
|
|
3455
|
-
localVarQueryParameter['group_field'] = groupField;
|
|
3456
|
-
}
|
|
3457
|
-
if (groupSize !== undefined) {
|
|
3458
|
-
localVarQueryParameter['group_size'] = groupSize;
|
|
3459
|
-
}
|
|
3460
|
-
if (snippetPrefix !== undefined) {
|
|
3461
|
-
localVarQueryParameter['snippet_prefix'] = snippetPrefix;
|
|
3462
|
-
}
|
|
3463
|
-
if (snippetSuffix !== undefined) {
|
|
3464
|
-
localVarQueryParameter['snippet_suffix'] = snippetSuffix;
|
|
3465
|
-
}
|
|
3466
|
-
if (snippetTokenLimit !== undefined) {
|
|
3467
|
-
localVarQueryParameter['snippet_token_limit'] = snippetTokenLimit;
|
|
3468
|
-
}
|
|
3469
|
-
if (snippetMinLen !== undefined) {
|
|
3470
|
-
localVarQueryParameter['snippet_min_len'] = snippetMinLen;
|
|
3471
|
-
}
|
|
3472
|
-
if (includeSnippets !== undefined) {
|
|
3473
|
-
localVarQueryParameter['include_snippets'] = includeSnippets;
|
|
3474
|
-
}
|
|
3475
|
-
if (prefixMode !== undefined) {
|
|
3476
|
-
localVarQueryParameter['prefix_mode'] = prefixMode;
|
|
3477
|
-
}
|
|
3478
|
-
if (infixMode !== undefined) {
|
|
3479
|
-
localVarQueryParameter['infix_mode'] = infixMode;
|
|
3480
|
-
}
|
|
3481
|
-
if (typoMax !== undefined) {
|
|
3482
|
-
localVarQueryParameter['typo_max'] = typoMax;
|
|
3483
|
-
}
|
|
3484
|
-
if (typoMinLen1 !== undefined) {
|
|
3485
|
-
localVarQueryParameter['typo_min_len_1'] = typoMinLen1;
|
|
3486
|
-
}
|
|
3487
|
-
if (typoMinLen2 !== undefined) {
|
|
3488
|
-
localVarQueryParameter['typo_min_len_2'] = typoMinLen2;
|
|
3489
|
-
}
|
|
3490
|
-
if (searchTimeoutMs !== undefined) {
|
|
3491
|
-
localVarQueryParameter['search_timeout_ms'] = searchTimeoutMs;
|
|
3492
|
-
}
|
|
3493
|
-
if (requireAllTerms !== undefined) {
|
|
3494
|
-
localVarQueryParameter['require_all_terms'] = requireAllTerms;
|
|
3495
|
-
}
|
|
3496
|
-
if (exactMatchBoost !== undefined) {
|
|
3497
|
-
localVarQueryParameter['exact_match_boost'] = exactMatchBoost;
|
|
3498
|
-
}
|
|
3499
|
-
if (cacheResults !== undefined) {
|
|
3500
|
-
localVarQueryParameter['cache_results'] = cacheResults;
|
|
3501
|
-
}
|
|
3502
|
-
if (applyRules !== undefined) {
|
|
3503
|
-
localVarQueryParameter['apply_rules'] = applyRules;
|
|
3504
|
-
}
|
|
3505
|
-
if (presetName !== undefined) {
|
|
3506
|
-
localVarQueryParameter['preset_name'] = presetName;
|
|
3507
|
-
}
|
|
3508
|
-
if (facetSearchText !== undefined) {
|
|
3509
|
-
localVarQueryParameter['facet_search_text'] = facetSearchText;
|
|
3510
|
-
}
|
|
2458
|
+
// authentication ApiKeyAuth required
|
|
2459
|
+
await (0, common_1.setApiKeyToObject)(localVarHeaderParameter, "x-storesecret", configuration);
|
|
2460
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
3511
2461
|
localVarHeaderParameter['Accept'] = 'application/json';
|
|
3512
2462
|
if (xStoreid != null) {
|
|
3513
2463
|
localVarHeaderParameter['x-storeid'] = String(xStoreid);
|
|
3514
2464
|
}
|
|
3515
|
-
if (
|
|
3516
|
-
localVarHeaderParameter['x-
|
|
3517
|
-
}
|
|
3518
|
-
if (xUserId != null) {
|
|
3519
|
-
localVarHeaderParameter['x-user-id'] = String(xUserId);
|
|
3520
|
-
}
|
|
3521
|
-
if (xAnonId != null) {
|
|
3522
|
-
localVarHeaderParameter['x-anon-id'] = String(xAnonId);
|
|
3523
|
-
}
|
|
3524
|
-
if (xSessionId != null) {
|
|
3525
|
-
localVarHeaderParameter['x-session-id'] = String(xSessionId);
|
|
2465
|
+
if (xStoreWriteSecret != null) {
|
|
2466
|
+
localVarHeaderParameter['x-store-write-secret'] = String(xStoreWriteSecret);
|
|
3526
2467
|
}
|
|
3527
2468
|
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
3528
2469
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
3529
2470
|
localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
|
|
2471
|
+
localVarRequestOptions.data = (0, common_1.serializeDataIfNeeded)(dataTypesCollectionSchemaRequest, localVarRequestOptions, configuration);
|
|
3530
2472
|
return {
|
|
3531
2473
|
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
3532
2474
|
options: localVarRequestOptions,
|
|
3533
2475
|
};
|
|
3534
2476
|
},
|
|
2477
|
+
};
|
|
2478
|
+
};
|
|
2479
|
+
exports.StoreManagementApiAxiosParamCreator = StoreManagementApiAxiosParamCreator;
|
|
2480
|
+
/**
|
|
2481
|
+
* StoreManagementApi - functional programming interface
|
|
2482
|
+
*/
|
|
2483
|
+
const StoreManagementApiFp = function (configuration) {
|
|
2484
|
+
const localVarAxiosParamCreator = (0, exports.StoreManagementApiAxiosParamCreator)(configuration);
|
|
2485
|
+
return {
|
|
3535
2486
|
/**
|
|
3536
|
-
*
|
|
3537
|
-
* @summary
|
|
3538
|
-
* @param {string}
|
|
3539
|
-
* @param {
|
|
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
|
|
3543
|
-
* @param {string} [xSessionId] Session ID for personalization
|
|
2487
|
+
* Creates a new store with minimal information. Returns store credentials (xStoreID, xStoreSecret, xStoreWriteSecret) immediately. This is a public API for SDK integration. Requires JWT authentication.
|
|
2488
|
+
* @summary Create Store (Public SDK API)
|
|
2489
|
+
* @param {string} authorization Bearer JWT Token
|
|
2490
|
+
* @param {DataTypesCreateStoreRequest} dataTypesCreateStoreRequest Store creation request
|
|
3544
2491
|
* @param {*} [options] Override http request option.
|
|
3545
2492
|
* @throws {RequiredError}
|
|
3546
2493
|
*/
|
|
3547
|
-
|
|
3548
|
-
|
|
3549
|
-
|
|
3550
|
-
|
|
3551
|
-
(0, common_1.
|
|
3552
|
-
// verify required parameter 'dataTypesPublicSearchRequest' is not null or undefined
|
|
3553
|
-
(0, common_1.assertParamExists)('v1SearchPost', 'dataTypesPublicSearchRequest', dataTypesPublicSearchRequest);
|
|
3554
|
-
const localVarPath = `/v1/search`;
|
|
3555
|
-
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
3556
|
-
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
3557
|
-
let baseOptions;
|
|
3558
|
-
if (configuration) {
|
|
3559
|
-
baseOptions = configuration.baseOptions;
|
|
3560
|
-
}
|
|
3561
|
-
const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options };
|
|
3562
|
-
const localVarHeaderParameter = {};
|
|
3563
|
-
const localVarQueryParameter = {};
|
|
3564
|
-
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
3565
|
-
localVarHeaderParameter['Accept'] = 'application/json';
|
|
3566
|
-
if (xStoreid != null) {
|
|
3567
|
-
localVarHeaderParameter['x-storeid'] = String(xStoreid);
|
|
3568
|
-
}
|
|
3569
|
-
if (xStoresecret != null) {
|
|
3570
|
-
localVarHeaderParameter['x-storesecret'] = String(xStoresecret);
|
|
3571
|
-
}
|
|
3572
|
-
if (xUserId != null) {
|
|
3573
|
-
localVarHeaderParameter['x-user-id'] = String(xUserId);
|
|
3574
|
-
}
|
|
3575
|
-
if (xAnonId != null) {
|
|
3576
|
-
localVarHeaderParameter['x-anon-id'] = String(xAnonId);
|
|
3577
|
-
}
|
|
3578
|
-
if (xSessionId != null) {
|
|
3579
|
-
localVarHeaderParameter['x-session-id'] = String(xSessionId);
|
|
3580
|
-
}
|
|
3581
|
-
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
3582
|
-
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
3583
|
-
localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
|
|
3584
|
-
localVarRequestOptions.data = (0, common_1.serializeDataIfNeeded)(dataTypesPublicSearchRequest, localVarRequestOptions, configuration);
|
|
3585
|
-
return {
|
|
3586
|
-
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
3587
|
-
options: localVarRequestOptions,
|
|
3588
|
-
};
|
|
2494
|
+
async apiV1StoresPost(authorization, dataTypesCreateStoreRequest, options) {
|
|
2495
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.apiV1StoresPost(authorization, dataTypesCreateStoreRequest, options);
|
|
2496
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
2497
|
+
const localVarOperationServerBasePath = base_1.operationServerMap['StoreManagementApi.apiV1StoresPost']?.[localVarOperationServerIndex]?.url;
|
|
2498
|
+
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
3589
2499
|
},
|
|
3590
|
-
};
|
|
3591
|
-
};
|
|
3592
|
-
exports.SearchApiAxiosParamCreator = SearchApiAxiosParamCreator;
|
|
3593
|
-
/**
|
|
3594
|
-
* SearchApi - functional programming interface
|
|
3595
|
-
*/
|
|
3596
|
-
const SearchApiFp = function (configuration) {
|
|
3597
|
-
const localVarAxiosParamCreator = (0, exports.SearchApiAxiosParamCreator)(configuration);
|
|
3598
|
-
return {
|
|
3599
2500
|
/**
|
|
3600
|
-
*
|
|
3601
|
-
* @summary
|
|
2501
|
+
* Returns search and query-suggestions configuration for the store. **Auth:** `x-storeid` and `x-storesecret`. Path `xStoreID` must match the `x-storeid` header.
|
|
2502
|
+
* @summary Get store configuration
|
|
3602
2503
|
* @param {string} xStoreid Store ID (from dashboard)
|
|
3603
|
-
* @param {string} xStoresecret Store read secret
|
|
3604
|
-
* @param {string}
|
|
3605
|
-
* @param {string} [xUserId] User ID for personalization
|
|
3606
|
-
* @param {string} [xAnonId] Anonymous user ID for personalization
|
|
3607
|
-
* @param {string} [xSessionId] Session ID for personalization
|
|
3608
|
-
* @param {number} [page] Page number (default: 1)
|
|
3609
|
-
* @param {number} [perPage] Items per page (default: 10)
|
|
3610
|
-
* @param {string} [sortBy] Sort option (e.g., price:asc, created_at:desc)
|
|
3611
|
-
* @param {string} [filterBy] Filter string (e.g., category:shirts)
|
|
3612
|
-
* @param {string} [facetBy] Facet fields (comma-separated)
|
|
3613
|
-
* @param {number} [maxFacetValues] Maximum facet values to return
|
|
3614
|
-
* @param {boolean} [widgetMode] Return widget-formatted results
|
|
3615
|
-
* @param {boolean} [includeSuggestions] Include autocomplete suggestions
|
|
3616
|
-
* @param {number} [suggestionsLimit] Number of suggestions to return
|
|
3617
|
-
* @param {string} [analyticsTags] Analytics tags (comma-separated)
|
|
3618
|
-
* @param {string} [stopwordSets] Stopword set IDs (comma-separated)
|
|
3619
|
-
* @param {string} [synonymSets] Synonym set IDs (comma-separated)
|
|
3620
|
-
* @param {string} [searchFields] Fields to search in (comma-separated)
|
|
3621
|
-
* @param {string} [returnFields] Fields to return (comma-separated)
|
|
3622
|
-
* @param {string} [omitFields] Fields to omit (comma-separated)
|
|
3623
|
-
* @param {string} [snippetFields] Fields to generate snippets for (comma-separated)
|
|
3624
|
-
* @param {string} [fullSnippetFields] Fields to include full snippet (comma-separated)
|
|
3625
|
-
* @param {string} [fieldWeights] Field weights as comma-separated integers (e.g., 3,2,1)
|
|
3626
|
-
* @param {string} [groupField] Field to group results by
|
|
3627
|
-
* @param {number} [groupSize] Number of results per group
|
|
3628
|
-
* @param {string} [snippetPrefix] Prefix for highlighted snippets
|
|
3629
|
-
* @param {string} [snippetSuffix] Suffix for highlighted snippets
|
|
3630
|
-
* @param {number} [snippetTokenLimit] Maximum tokens in snippet
|
|
3631
|
-
* @param {number} [snippetMinLen] Minimum snippet length
|
|
3632
|
-
* @param {boolean} [includeSnippets] Include snippets in results
|
|
3633
|
-
* @param {string} [prefixMode] Prefix matching mode (e.g., always, fallback, off)
|
|
3634
|
-
* @param {string} [infixMode] Infix matching mode (e.g., always, fallback, off)
|
|
3635
|
-
* @param {number} [typoMax] Maximum typo tolerance
|
|
3636
|
-
* @param {number} [typoMinLen1] Min word length for 1 typo
|
|
3637
|
-
* @param {number} [typoMinLen2] Min word length for 2 typos
|
|
3638
|
-
* @param {number} [searchTimeoutMs] Search timeout in milliseconds
|
|
3639
|
-
* @param {boolean} [requireAllTerms] Require all search terms to match
|
|
3640
|
-
* @param {boolean} [exactMatchBoost] Boost exact matches
|
|
3641
|
-
* @param {boolean} [cacheResults] Cache search results
|
|
3642
|
-
* @param {boolean} [applyRules] Apply search rules
|
|
3643
|
-
* @param {string} [presetName] Search preset name to use
|
|
3644
|
-
* @param {string} [facetSearchText] Text to filter facet values
|
|
2504
|
+
* @param {string} xStoresecret Store read secret
|
|
2505
|
+
* @param {string} xStoreID Store ID (must match x-storeid header)
|
|
3645
2506
|
* @param {*} [options] Override http request option.
|
|
3646
2507
|
* @throws {RequiredError}
|
|
3647
2508
|
*/
|
|
3648
|
-
async
|
|
3649
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.
|
|
2509
|
+
async apiV1StoresXStoreIDConfigGet(xStoreid, xStoresecret, xStoreID, options) {
|
|
2510
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.apiV1StoresXStoreIDConfigGet(xStoreid, xStoresecret, xStoreID, options);
|
|
3650
2511
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
3651
|
-
const localVarOperationServerBasePath = base_1.operationServerMap['
|
|
2512
|
+
const localVarOperationServerBasePath = base_1.operationServerMap['StoreManagementApi.apiV1StoresXStoreIDConfigGet']?.[localVarOperationServerIndex]?.url;
|
|
3652
2513
|
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
3653
2514
|
},
|
|
3654
2515
|
/**
|
|
3655
|
-
*
|
|
3656
|
-
* @summary
|
|
2516
|
+
* Update search and store settings. Partial updates supported. **Auth:** `x-storeid` and `x-store-write-secret`. Path `xStoreID` must match the `x-storeid` header.
|
|
2517
|
+
* @summary Update store configuration
|
|
3657
2518
|
* @param {string} xStoreid Store ID (from dashboard)
|
|
3658
|
-
* @param {string}
|
|
3659
|
-
* @param {
|
|
3660
|
-
* @param {
|
|
3661
|
-
* @param {string} [xAnonId] Anonymous user ID for personalization
|
|
3662
|
-
* @param {string} [xSessionId] Session ID for personalization
|
|
2519
|
+
* @param {string} xStoreWriteSecret Store write secret
|
|
2520
|
+
* @param {string} xStoreID Store ID (must match x-storeid header)
|
|
2521
|
+
* @param {DataTypesIndexConfig} dataTypesIndexConfig Fields to update (partial)
|
|
3663
2522
|
* @param {*} [options] Override http request option.
|
|
3664
2523
|
* @throws {RequiredError}
|
|
3665
2524
|
*/
|
|
3666
|
-
async
|
|
3667
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.
|
|
2525
|
+
async apiV1StoresXStoreIDConfigPut(xStoreid, xStoreWriteSecret, xStoreID, dataTypesIndexConfig, options) {
|
|
2526
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.apiV1StoresXStoreIDConfigPut(xStoreid, xStoreWriteSecret, xStoreID, dataTypesIndexConfig, options);
|
|
3668
2527
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
3669
|
-
const localVarOperationServerBasePath = base_1.operationServerMap['
|
|
2528
|
+
const localVarOperationServerBasePath = base_1.operationServerMap['StoreManagementApi.apiV1StoresXStoreIDConfigPut']?.[localVarOperationServerIndex]?.url;
|
|
3670
2529
|
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
3671
2530
|
},
|
|
3672
|
-
};
|
|
3673
|
-
};
|
|
3674
|
-
exports.SearchApiFp = SearchApiFp;
|
|
3675
|
-
/**
|
|
3676
|
-
* SearchApi - factory interface
|
|
3677
|
-
*/
|
|
3678
|
-
const SearchApiFactory = function (configuration, basePath, axios) {
|
|
3679
|
-
const localVarFp = (0, exports.SearchApiFp)(configuration);
|
|
3680
|
-
return {
|
|
3681
2531
|
/**
|
|
3682
|
-
*
|
|
3683
|
-
* @summary
|
|
2532
|
+
* Returns metadata for all configurable store fields (types, defaults, validation). **Auth:** `x-storeid` and `x-storesecret`. Path `xStoreID` must match the `x-storeid` header.
|
|
2533
|
+
* @summary Get store config schema
|
|
3684
2534
|
* @param {string} xStoreid Store ID (from dashboard)
|
|
3685
|
-
* @param {string} xStoresecret Store read secret
|
|
3686
|
-
* @param {string}
|
|
3687
|
-
* @param {string} [xUserId] User ID for personalization
|
|
3688
|
-
* @param {string} [xAnonId] Anonymous user ID for personalization
|
|
3689
|
-
* @param {string} [xSessionId] Session ID for personalization
|
|
3690
|
-
* @param {number} [page] Page number (default: 1)
|
|
3691
|
-
* @param {number} [perPage] Items per page (default: 10)
|
|
3692
|
-
* @param {string} [sortBy] Sort option (e.g., price:asc, created_at:desc)
|
|
3693
|
-
* @param {string} [filterBy] Filter string (e.g., category:shirts)
|
|
3694
|
-
* @param {string} [facetBy] Facet fields (comma-separated)
|
|
3695
|
-
* @param {number} [maxFacetValues] Maximum facet values to return
|
|
3696
|
-
* @param {boolean} [widgetMode] Return widget-formatted results
|
|
3697
|
-
* @param {boolean} [includeSuggestions] Include autocomplete suggestions
|
|
3698
|
-
* @param {number} [suggestionsLimit] Number of suggestions to return
|
|
3699
|
-
* @param {string} [analyticsTags] Analytics tags (comma-separated)
|
|
3700
|
-
* @param {string} [stopwordSets] Stopword set IDs (comma-separated)
|
|
3701
|
-
* @param {string} [synonymSets] Synonym set IDs (comma-separated)
|
|
3702
|
-
* @param {string} [searchFields] Fields to search in (comma-separated)
|
|
3703
|
-
* @param {string} [returnFields] Fields to return (comma-separated)
|
|
3704
|
-
* @param {string} [omitFields] Fields to omit (comma-separated)
|
|
3705
|
-
* @param {string} [snippetFields] Fields to generate snippets for (comma-separated)
|
|
3706
|
-
* @param {string} [fullSnippetFields] Fields to include full snippet (comma-separated)
|
|
3707
|
-
* @param {string} [fieldWeights] Field weights as comma-separated integers (e.g., 3,2,1)
|
|
3708
|
-
* @param {string} [groupField] Field to group results by
|
|
3709
|
-
* @param {number} [groupSize] Number of results per group
|
|
3710
|
-
* @param {string} [snippetPrefix] Prefix for highlighted snippets
|
|
3711
|
-
* @param {string} [snippetSuffix] Suffix for highlighted snippets
|
|
3712
|
-
* @param {number} [snippetTokenLimit] Maximum tokens in snippet
|
|
3713
|
-
* @param {number} [snippetMinLen] Minimum snippet length
|
|
3714
|
-
* @param {boolean} [includeSnippets] Include snippets in results
|
|
3715
|
-
* @param {string} [prefixMode] Prefix matching mode (e.g., always, fallback, off)
|
|
3716
|
-
* @param {string} [infixMode] Infix matching mode (e.g., always, fallback, off)
|
|
3717
|
-
* @param {number} [typoMax] Maximum typo tolerance
|
|
3718
|
-
* @param {number} [typoMinLen1] Min word length for 1 typo
|
|
3719
|
-
* @param {number} [typoMinLen2] Min word length for 2 typos
|
|
3720
|
-
* @param {number} [searchTimeoutMs] Search timeout in milliseconds
|
|
3721
|
-
* @param {boolean} [requireAllTerms] Require all search terms to match
|
|
3722
|
-
* @param {boolean} [exactMatchBoost] Boost exact matches
|
|
3723
|
-
* @param {boolean} [cacheResults] Cache search results
|
|
3724
|
-
* @param {boolean} [applyRules] Apply search rules
|
|
3725
|
-
* @param {string} [presetName] Search preset name to use
|
|
3726
|
-
* @param {string} [facetSearchText] Text to filter facet values
|
|
2535
|
+
* @param {string} xStoresecret Store read secret
|
|
2536
|
+
* @param {string} xStoreID Store ID (must match x-storeid header)
|
|
3727
2537
|
* @param {*} [options] Override http request option.
|
|
3728
2538
|
* @throws {RequiredError}
|
|
3729
2539
|
*/
|
|
3730
|
-
|
|
3731
|
-
|
|
2540
|
+
async apiV1StoresXStoreIDConfigSchemaGet(xStoreid, xStoresecret, xStoreID, options) {
|
|
2541
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.apiV1StoresXStoreIDConfigSchemaGet(xStoreid, xStoresecret, xStoreID, options);
|
|
2542
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
2543
|
+
const localVarOperationServerBasePath = base_1.operationServerMap['StoreManagementApi.apiV1StoresXStoreIDConfigSchemaGet']?.[localVarOperationServerIndex]?.url;
|
|
2544
|
+
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
3732
2545
|
},
|
|
3733
2546
|
/**
|
|
3734
|
-
* Run
|
|
3735
|
-
* @summary
|
|
2547
|
+
* 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.
|
|
2548
|
+
* @summary Bulk index documents
|
|
3736
2549
|
* @param {string} xStoreid Store ID (from dashboard)
|
|
3737
|
-
* @param {string}
|
|
3738
|
-
* @param {
|
|
3739
|
-
* @param {
|
|
3740
|
-
* @param {string} [xAnonId] Anonymous user ID for personalization
|
|
3741
|
-
* @param {string} [xSessionId] Session ID for personalization
|
|
2550
|
+
* @param {string} xStoreWriteSecret Store write secret
|
|
2551
|
+
* @param {string} xStoreID Store ID (must match x-storeid header)
|
|
2552
|
+
* @param {DataTypesBulkDocumentRequest} dataTypesBulkDocumentRequest List of operations
|
|
3742
2553
|
* @param {*} [options] Override http request option.
|
|
3743
2554
|
* @throws {RequiredError}
|
|
3744
2555
|
*/
|
|
3745
|
-
|
|
3746
|
-
|
|
2556
|
+
async apiV1StoresXStoreIDDocumentsBulkPost(xStoreid, xStoreWriteSecret, xStoreID, dataTypesBulkDocumentRequest, options) {
|
|
2557
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.apiV1StoresXStoreIDDocumentsBulkPost(xStoreid, xStoreWriteSecret, xStoreID, dataTypesBulkDocumentRequest, options);
|
|
2558
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
2559
|
+
const localVarOperationServerBasePath = base_1.operationServerMap['StoreManagementApi.apiV1StoresXStoreIDDocumentsBulkPost']?.[localVarOperationServerIndex]?.url;
|
|
2560
|
+
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
3747
2561
|
},
|
|
3748
|
-
|
|
3749
|
-
|
|
3750
|
-
|
|
3751
|
-
|
|
3752
|
-
|
|
3753
|
-
|
|
3754
|
-
|
|
3755
|
-
|
|
3756
|
-
|
|
3757
|
-
|
|
3758
|
-
|
|
3759
|
-
|
|
3760
|
-
|
|
3761
|
-
|
|
3762
|
-
|
|
3763
|
-
|
|
3764
|
-
|
|
3765
|
-
|
|
3766
|
-
|
|
3767
|
-
|
|
3768
|
-
|
|
3769
|
-
|
|
3770
|
-
|
|
3771
|
-
|
|
3772
|
-
|
|
3773
|
-
|
|
3774
|
-
|
|
3775
|
-
|
|
3776
|
-
|
|
3777
|
-
|
|
3778
|
-
|
|
3779
|
-
|
|
3780
|
-
|
|
3781
|
-
|
|
3782
|
-
|
|
3783
|
-
|
|
3784
|
-
|
|
3785
|
-
|
|
3786
|
-
|
|
3787
|
-
|
|
3788
|
-
|
|
3789
|
-
|
|
3790
|
-
|
|
3791
|
-
|
|
3792
|
-
|
|
3793
|
-
|
|
3794
|
-
|
|
3795
|
-
|
|
3796
|
-
|
|
3797
|
-
|
|
3798
|
-
|
|
3799
|
-
|
|
3800
|
-
|
|
3801
|
-
|
|
3802
|
-
|
|
3803
|
-
|
|
3804
|
-
|
|
3805
|
-
|
|
2562
|
+
/**
|
|
2563
|
+
* 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.
|
|
2564
|
+
* @summary Clear all documents
|
|
2565
|
+
* @param {string} xStoreid Store ID (from dashboard)
|
|
2566
|
+
* @param {string} xStoreWriteSecret Store write secret
|
|
2567
|
+
* @param {string} xStoreID Store ID (must match x-storeid header)
|
|
2568
|
+
* @param {*} [options] Override http request option.
|
|
2569
|
+
* @throws {RequiredError}
|
|
2570
|
+
*/
|
|
2571
|
+
async apiV1StoresXStoreIDDocumentsDelete(xStoreid, xStoreWriteSecret, xStoreID, options) {
|
|
2572
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.apiV1StoresXStoreIDDocumentsDelete(xStoreid, xStoreWriteSecret, xStoreID, options);
|
|
2573
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
2574
|
+
const localVarOperationServerBasePath = base_1.operationServerMap['StoreManagementApi.apiV1StoresXStoreIDDocumentsDelete']?.[localVarOperationServerIndex]?.url;
|
|
2575
|
+
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
2576
|
+
},
|
|
2577
|
+
/**
|
|
2578
|
+
* 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.
|
|
2579
|
+
* @summary Delete a document
|
|
2580
|
+
* @param {string} xStoreid Store ID (from dashboard)
|
|
2581
|
+
* @param {string} xStoreWriteSecret Store write secret
|
|
2582
|
+
* @param {string} xStoreID Store ID (must match x-storeid header)
|
|
2583
|
+
* @param {string} documentID Document ID to delete
|
|
2584
|
+
* @param {*} [options] Override http request option.
|
|
2585
|
+
* @throws {RequiredError}
|
|
2586
|
+
*/
|
|
2587
|
+
async apiV1StoresXStoreIDDocumentsDocumentIDDelete(xStoreid, xStoreWriteSecret, xStoreID, documentID, options) {
|
|
2588
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.apiV1StoresXStoreIDDocumentsDocumentIDDelete(xStoreid, xStoreWriteSecret, xStoreID, documentID, options);
|
|
2589
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
2590
|
+
const localVarOperationServerBasePath = base_1.operationServerMap['StoreManagementApi.apiV1StoresXStoreIDDocumentsDocumentIDDelete']?.[localVarOperationServerIndex]?.url;
|
|
2591
|
+
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
2592
|
+
},
|
|
2593
|
+
/**
|
|
2594
|
+
* 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.
|
|
2595
|
+
* @summary Get a document by ID
|
|
2596
|
+
* @param {string} xStoreid Store ID (from dashboard)
|
|
2597
|
+
* @param {string} xStoresecret Store read secret
|
|
2598
|
+
* @param {string} xStoreID Store ID (must match x-storeid header)
|
|
2599
|
+
* @param {string} documentID Document ID to retrieve
|
|
2600
|
+
* @param {*} [options] Override http request option.
|
|
2601
|
+
* @throws {RequiredError}
|
|
2602
|
+
*/
|
|
2603
|
+
async apiV1StoresXStoreIDDocumentsDocumentIDGet(xStoreid, xStoresecret, xStoreID, documentID, options) {
|
|
2604
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.apiV1StoresXStoreIDDocumentsDocumentIDGet(xStoreid, xStoresecret, xStoreID, documentID, options);
|
|
2605
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
2606
|
+
const localVarOperationServerBasePath = base_1.operationServerMap['StoreManagementApi.apiV1StoresXStoreIDDocumentsDocumentIDGet']?.[localVarOperationServerIndex]?.url;
|
|
2607
|
+
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
2608
|
+
},
|
|
2609
|
+
/**
|
|
2610
|
+
* 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.
|
|
2611
|
+
* @summary Index a single document
|
|
2612
|
+
* @param {string} xStoreid Store ID (from dashboard)
|
|
2613
|
+
* @param {string} xStoreWriteSecret Store write secret
|
|
2614
|
+
* @param {string} xStoreID Store ID (must match x-storeid header)
|
|
2615
|
+
* @param {DataTypesDocumentRequest} dataTypesDocumentRequest Document fields to index
|
|
2616
|
+
* @param {*} [options] Override http request option.
|
|
2617
|
+
* @throws {RequiredError}
|
|
2618
|
+
*/
|
|
2619
|
+
async apiV1StoresXStoreIDDocumentsPost(xStoreid, xStoreWriteSecret, xStoreID, dataTypesDocumentRequest, options) {
|
|
2620
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.apiV1StoresXStoreIDDocumentsPost(xStoreid, xStoreWriteSecret, xStoreID, dataTypesDocumentRequest, options);
|
|
2621
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
2622
|
+
const localVarOperationServerBasePath = base_1.operationServerMap['StoreManagementApi.apiV1StoresXStoreIDDocumentsPost']?.[localVarOperationServerIndex]?.url;
|
|
2623
|
+
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
2624
|
+
},
|
|
2625
|
+
/**
|
|
2626
|
+
* Returns basic store details (name, location, status). **Auth:** `x-storeid` and `x-storesecret`. Path `xStoreID` must match the `x-storeid` header.
|
|
2627
|
+
* @summary Get store info
|
|
2628
|
+
* @param {string} xStoreid Store ID (from dashboard)
|
|
2629
|
+
* @param {string} xStoresecret Store read secret
|
|
2630
|
+
* @param {string} xStoreID Store ID (must match x-storeid header)
|
|
2631
|
+
* @param {*} [options] Override http request option.
|
|
2632
|
+
* @throws {RequiredError}
|
|
2633
|
+
*/
|
|
2634
|
+
async apiV1StoresXStoreIDGet(xStoreid, xStoresecret, xStoreID, options) {
|
|
2635
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.apiV1StoresXStoreIDGet(xStoreid, xStoresecret, xStoreID, options);
|
|
2636
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
2637
|
+
const localVarOperationServerBasePath = base_1.operationServerMap['StoreManagementApi.apiV1StoresXStoreIDGet']?.[localVarOperationServerIndex]?.url;
|
|
2638
|
+
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
2639
|
+
},
|
|
2640
|
+
/**
|
|
2641
|
+
* Returns autocomplete/suggestions configuration for the store. **Auth:** `x-storeid` and `x-storesecret`. Path `xStoreID` must match the `x-storeid` header.
|
|
2642
|
+
* @summary Get query suggestions configuration
|
|
2643
|
+
* @param {string} xStoreid Store ID (from dashboard)
|
|
2644
|
+
* @param {string} xStoresecret Store read secret
|
|
2645
|
+
* @param {string} xStoreID Store ID (must match x-storeid header)
|
|
2646
|
+
* @param {*} [options] Override http request option.
|
|
2647
|
+
* @throws {RequiredError}
|
|
2648
|
+
*/
|
|
2649
|
+
async apiV1StoresXStoreIDQuerySuggestionsConfigGet(xStoreid, xStoresecret, xStoreID, options) {
|
|
2650
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.apiV1StoresXStoreIDQuerySuggestionsConfigGet(xStoreid, xStoresecret, xStoreID, options);
|
|
2651
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
2652
|
+
const localVarOperationServerBasePath = base_1.operationServerMap['StoreManagementApi.apiV1StoresXStoreIDQuerySuggestionsConfigGet']?.[localVarOperationServerIndex]?.url;
|
|
2653
|
+
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
2654
|
+
},
|
|
2655
|
+
/**
|
|
2656
|
+
* 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.
|
|
2657
|
+
* @summary Update query suggestions configuration
|
|
2658
|
+
* @param {string} xStoreid Store ID (from dashboard)
|
|
2659
|
+
* @param {string} xStoreWriteSecret Store write secret
|
|
2660
|
+
* @param {string} xStoreID Store ID (must match x-storeid header)
|
|
2661
|
+
* @param {QuerySuggestionsServiceUpdateSuggestionConfigRequest} querySuggestionsServiceUpdateSuggestionConfigRequest Fields to update (partial)
|
|
2662
|
+
* @param {*} [options] Override http request option.
|
|
2663
|
+
* @throws {RequiredError}
|
|
2664
|
+
*/
|
|
2665
|
+
async apiV1StoresXStoreIDQuerySuggestionsConfigPut(xStoreid, xStoreWriteSecret, xStoreID, querySuggestionsServiceUpdateSuggestionConfigRequest, options) {
|
|
2666
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.apiV1StoresXStoreIDQuerySuggestionsConfigPut(xStoreid, xStoreWriteSecret, xStoreID, querySuggestionsServiceUpdateSuggestionConfigRequest, options);
|
|
2667
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
2668
|
+
const localVarOperationServerBasePath = base_1.operationServerMap['StoreManagementApi.apiV1StoresXStoreIDQuerySuggestionsConfigPut']?.[localVarOperationServerIndex]?.url;
|
|
2669
|
+
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
2670
|
+
},
|
|
2671
|
+
/**
|
|
2672
|
+
* 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.
|
|
2673
|
+
* @summary Get index schema
|
|
2674
|
+
* @param {string} xStoreid Store ID (from dashboard)
|
|
2675
|
+
* @param {string} xStoresecret Store read secret
|
|
2676
|
+
* @param {string} xStoreID Store ID (must match x-storeid header)
|
|
2677
|
+
* @param {*} [options] Override http request option.
|
|
2678
|
+
* @throws {RequiredError}
|
|
2679
|
+
*/
|
|
2680
|
+
async apiV1StoresXStoreIDSchemaGet(xStoreid, xStoresecret, xStoreID, options) {
|
|
2681
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.apiV1StoresXStoreIDSchemaGet(xStoreid, xStoresecret, xStoreID, options);
|
|
2682
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
2683
|
+
const localVarOperationServerBasePath = base_1.operationServerMap['StoreManagementApi.apiV1StoresXStoreIDSchemaGet']?.[localVarOperationServerIndex]?.url;
|
|
2684
|
+
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
2685
|
+
},
|
|
2686
|
+
/**
|
|
2687
|
+
* 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.
|
|
2688
|
+
* @summary Create or update index schema
|
|
2689
|
+
* @param {string} xStoreid Store ID (from dashboard)
|
|
2690
|
+
* @param {string} xStoreWriteSecret Store write secret
|
|
2691
|
+
* @param {string} xStoreID Store ID (must match x-storeid header)
|
|
2692
|
+
* @param {DataTypesCollectionSchemaRequest} dataTypesCollectionSchemaRequest Schema definition and mode
|
|
2693
|
+
* @param {*} [options] Override http request option.
|
|
2694
|
+
* @throws {RequiredError}
|
|
2695
|
+
*/
|
|
2696
|
+
async apiV1StoresXStoreIDSchemaPost(xStoreid, xStoreWriteSecret, xStoreID, dataTypesCollectionSchemaRequest, options) {
|
|
2697
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.apiV1StoresXStoreIDSchemaPost(xStoreid, xStoreWriteSecret, xStoreID, dataTypesCollectionSchemaRequest, options);
|
|
2698
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
2699
|
+
const localVarOperationServerBasePath = base_1.operationServerMap['StoreManagementApi.apiV1StoresXStoreIDSchemaPost']?.[localVarOperationServerIndex]?.url;
|
|
2700
|
+
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
2701
|
+
},
|
|
2702
|
+
};
|
|
2703
|
+
};
|
|
2704
|
+
exports.StoreManagementApiFp = StoreManagementApiFp;
|
|
2705
|
+
/**
|
|
2706
|
+
* StoreManagementApi - factory interface
|
|
2707
|
+
*/
|
|
2708
|
+
const StoreManagementApiFactory = function (configuration, basePath, axios) {
|
|
2709
|
+
const localVarFp = (0, exports.StoreManagementApiFp)(configuration);
|
|
2710
|
+
return {
|
|
2711
|
+
/**
|
|
2712
|
+
* Creates a new store with minimal information. Returns store credentials (xStoreID, xStoreSecret, xStoreWriteSecret) immediately. This is a public API for SDK integration. Requires JWT authentication.
|
|
2713
|
+
* @summary Create Store (Public SDK API)
|
|
2714
|
+
* @param {string} authorization Bearer JWT Token
|
|
2715
|
+
* @param {DataTypesCreateStoreRequest} dataTypesCreateStoreRequest Store creation request
|
|
2716
|
+
* @param {*} [options] Override http request option.
|
|
2717
|
+
* @throws {RequiredError}
|
|
2718
|
+
*/
|
|
2719
|
+
apiV1StoresPost(authorization, dataTypesCreateStoreRequest, options) {
|
|
2720
|
+
return localVarFp.apiV1StoresPost(authorization, dataTypesCreateStoreRequest, options).then((request) => request(axios, basePath));
|
|
2721
|
+
},
|
|
2722
|
+
/**
|
|
2723
|
+
* Returns search and query-suggestions configuration for the store. **Auth:** `x-storeid` and `x-storesecret`. Path `xStoreID` must match the `x-storeid` header.
|
|
2724
|
+
* @summary Get store configuration
|
|
2725
|
+
* @param {string} xStoreid Store ID (from dashboard)
|
|
2726
|
+
* @param {string} xStoresecret Store read secret
|
|
2727
|
+
* @param {string} xStoreID Store ID (must match x-storeid header)
|
|
2728
|
+
* @param {*} [options] Override http request option.
|
|
2729
|
+
* @throws {RequiredError}
|
|
2730
|
+
*/
|
|
2731
|
+
apiV1StoresXStoreIDConfigGet(xStoreid, xStoresecret, xStoreID, options) {
|
|
2732
|
+
return localVarFp.apiV1StoresXStoreIDConfigGet(xStoreid, xStoresecret, xStoreID, options).then((request) => request(axios, basePath));
|
|
2733
|
+
},
|
|
2734
|
+
/**
|
|
2735
|
+
* Update search and store settings. Partial updates supported. **Auth:** `x-storeid` and `x-store-write-secret`. Path `xStoreID` must match the `x-storeid` header.
|
|
2736
|
+
* @summary Update store configuration
|
|
2737
|
+
* @param {string} xStoreid Store ID (from dashboard)
|
|
2738
|
+
* @param {string} xStoreWriteSecret Store write secret
|
|
2739
|
+
* @param {string} xStoreID Store ID (must match x-storeid header)
|
|
2740
|
+
* @param {DataTypesIndexConfig} dataTypesIndexConfig Fields to update (partial)
|
|
2741
|
+
* @param {*} [options] Override http request option.
|
|
2742
|
+
* @throws {RequiredError}
|
|
2743
|
+
*/
|
|
2744
|
+
apiV1StoresXStoreIDConfigPut(xStoreid, xStoreWriteSecret, xStoreID, dataTypesIndexConfig, options) {
|
|
2745
|
+
return localVarFp.apiV1StoresXStoreIDConfigPut(xStoreid, xStoreWriteSecret, xStoreID, dataTypesIndexConfig, options).then((request) => request(axios, basePath));
|
|
2746
|
+
},
|
|
2747
|
+
/**
|
|
2748
|
+
* Returns metadata for all configurable store fields (types, defaults, validation). **Auth:** `x-storeid` and `x-storesecret`. Path `xStoreID` must match the `x-storeid` header.
|
|
2749
|
+
* @summary Get store config schema
|
|
2750
|
+
* @param {string} xStoreid Store ID (from dashboard)
|
|
2751
|
+
* @param {string} xStoresecret Store read secret
|
|
2752
|
+
* @param {string} xStoreID Store ID (must match x-storeid header)
|
|
2753
|
+
* @param {*} [options] Override http request option.
|
|
2754
|
+
* @throws {RequiredError}
|
|
2755
|
+
*/
|
|
2756
|
+
apiV1StoresXStoreIDConfigSchemaGet(xStoreid, xStoresecret, xStoreID, options) {
|
|
2757
|
+
return localVarFp.apiV1StoresXStoreIDConfigSchemaGet(xStoreid, xStoresecret, xStoreID, options).then((request) => request(axios, basePath));
|
|
2758
|
+
},
|
|
2759
|
+
/**
|
|
2760
|
+
* 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.
|
|
2761
|
+
* @summary Bulk index documents
|
|
2762
|
+
* @param {string} xStoreid Store ID (from dashboard)
|
|
2763
|
+
* @param {string} xStoreWriteSecret Store write secret
|
|
2764
|
+
* @param {string} xStoreID Store ID (must match x-storeid header)
|
|
2765
|
+
* @param {DataTypesBulkDocumentRequest} dataTypesBulkDocumentRequest List of operations
|
|
2766
|
+
* @param {*} [options] Override http request option.
|
|
2767
|
+
* @throws {RequiredError}
|
|
2768
|
+
*/
|
|
2769
|
+
apiV1StoresXStoreIDDocumentsBulkPost(xStoreid, xStoreWriteSecret, xStoreID, dataTypesBulkDocumentRequest, options) {
|
|
2770
|
+
return localVarFp.apiV1StoresXStoreIDDocumentsBulkPost(xStoreid, xStoreWriteSecret, xStoreID, dataTypesBulkDocumentRequest, options).then((request) => request(axios, basePath));
|
|
2771
|
+
},
|
|
2772
|
+
/**
|
|
2773
|
+
* 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.
|
|
2774
|
+
* @summary Clear all documents
|
|
2775
|
+
* @param {string} xStoreid Store ID (from dashboard)
|
|
2776
|
+
* @param {string} xStoreWriteSecret Store write secret
|
|
2777
|
+
* @param {string} xStoreID Store ID (must match x-storeid header)
|
|
2778
|
+
* @param {*} [options] Override http request option.
|
|
2779
|
+
* @throws {RequiredError}
|
|
2780
|
+
*/
|
|
2781
|
+
apiV1StoresXStoreIDDocumentsDelete(xStoreid, xStoreWriteSecret, xStoreID, options) {
|
|
2782
|
+
return localVarFp.apiV1StoresXStoreIDDocumentsDelete(xStoreid, xStoreWriteSecret, xStoreID, options).then((request) => request(axios, basePath));
|
|
2783
|
+
},
|
|
2784
|
+
/**
|
|
2785
|
+
* 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.
|
|
2786
|
+
* @summary Delete a document
|
|
2787
|
+
* @param {string} xStoreid Store ID (from dashboard)
|
|
2788
|
+
* @param {string} xStoreWriteSecret Store write secret
|
|
2789
|
+
* @param {string} xStoreID Store ID (must match x-storeid header)
|
|
2790
|
+
* @param {string} documentID Document ID to delete
|
|
2791
|
+
* @param {*} [options] Override http request option.
|
|
2792
|
+
* @throws {RequiredError}
|
|
2793
|
+
*/
|
|
2794
|
+
apiV1StoresXStoreIDDocumentsDocumentIDDelete(xStoreid, xStoreWriteSecret, xStoreID, documentID, options) {
|
|
2795
|
+
return localVarFp.apiV1StoresXStoreIDDocumentsDocumentIDDelete(xStoreid, xStoreWriteSecret, xStoreID, documentID, options).then((request) => request(axios, basePath));
|
|
2796
|
+
},
|
|
2797
|
+
/**
|
|
2798
|
+
* 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.
|
|
2799
|
+
* @summary Get a document by ID
|
|
2800
|
+
* @param {string} xStoreid Store ID (from dashboard)
|
|
2801
|
+
* @param {string} xStoresecret Store read secret
|
|
2802
|
+
* @param {string} xStoreID Store ID (must match x-storeid header)
|
|
2803
|
+
* @param {string} documentID Document ID to retrieve
|
|
2804
|
+
* @param {*} [options] Override http request option.
|
|
2805
|
+
* @throws {RequiredError}
|
|
2806
|
+
*/
|
|
2807
|
+
apiV1StoresXStoreIDDocumentsDocumentIDGet(xStoreid, xStoresecret, xStoreID, documentID, options) {
|
|
2808
|
+
return localVarFp.apiV1StoresXStoreIDDocumentsDocumentIDGet(xStoreid, xStoresecret, xStoreID, documentID, options).then((request) => request(axios, basePath));
|
|
2809
|
+
},
|
|
2810
|
+
/**
|
|
2811
|
+
* 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.
|
|
2812
|
+
* @summary Index a single document
|
|
2813
|
+
* @param {string} xStoreid Store ID (from dashboard)
|
|
2814
|
+
* @param {string} xStoreWriteSecret Store write secret
|
|
2815
|
+
* @param {string} xStoreID Store ID (must match x-storeid header)
|
|
2816
|
+
* @param {DataTypesDocumentRequest} dataTypesDocumentRequest Document fields to index
|
|
2817
|
+
* @param {*} [options] Override http request option.
|
|
2818
|
+
* @throws {RequiredError}
|
|
2819
|
+
*/
|
|
2820
|
+
apiV1StoresXStoreIDDocumentsPost(xStoreid, xStoreWriteSecret, xStoreID, dataTypesDocumentRequest, options) {
|
|
2821
|
+
return localVarFp.apiV1StoresXStoreIDDocumentsPost(xStoreid, xStoreWriteSecret, xStoreID, dataTypesDocumentRequest, options).then((request) => request(axios, basePath));
|
|
2822
|
+
},
|
|
2823
|
+
/**
|
|
2824
|
+
* Returns basic store details (name, location, status). **Auth:** `x-storeid` and `x-storesecret`. Path `xStoreID` must match the `x-storeid` header.
|
|
2825
|
+
* @summary Get store info
|
|
2826
|
+
* @param {string} xStoreid Store ID (from dashboard)
|
|
2827
|
+
* @param {string} xStoresecret Store read secret
|
|
2828
|
+
* @param {string} xStoreID Store ID (must match x-storeid header)
|
|
2829
|
+
* @param {*} [options] Override http request option.
|
|
2830
|
+
* @throws {RequiredError}
|
|
2831
|
+
*/
|
|
2832
|
+
apiV1StoresXStoreIDGet(xStoreid, xStoresecret, xStoreID, options) {
|
|
2833
|
+
return localVarFp.apiV1StoresXStoreIDGet(xStoreid, xStoresecret, xStoreID, options).then((request) => request(axios, basePath));
|
|
2834
|
+
},
|
|
2835
|
+
/**
|
|
2836
|
+
* Returns autocomplete/suggestions configuration for the store. **Auth:** `x-storeid` and `x-storesecret`. Path `xStoreID` must match the `x-storeid` header.
|
|
2837
|
+
* @summary Get query suggestions configuration
|
|
2838
|
+
* @param {string} xStoreid Store ID (from dashboard)
|
|
2839
|
+
* @param {string} xStoresecret Store read secret
|
|
2840
|
+
* @param {string} xStoreID Store ID (must match x-storeid header)
|
|
2841
|
+
* @param {*} [options] Override http request option.
|
|
2842
|
+
* @throws {RequiredError}
|
|
2843
|
+
*/
|
|
2844
|
+
apiV1StoresXStoreIDQuerySuggestionsConfigGet(xStoreid, xStoresecret, xStoreID, options) {
|
|
2845
|
+
return localVarFp.apiV1StoresXStoreIDQuerySuggestionsConfigGet(xStoreid, xStoresecret, xStoreID, options).then((request) => request(axios, basePath));
|
|
2846
|
+
},
|
|
2847
|
+
/**
|
|
2848
|
+
* 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.
|
|
2849
|
+
* @summary Update query suggestions configuration
|
|
2850
|
+
* @param {string} xStoreid Store ID (from dashboard)
|
|
2851
|
+
* @param {string} xStoreWriteSecret Store write secret
|
|
2852
|
+
* @param {string} xStoreID Store ID (must match x-storeid header)
|
|
2853
|
+
* @param {QuerySuggestionsServiceUpdateSuggestionConfigRequest} querySuggestionsServiceUpdateSuggestionConfigRequest Fields to update (partial)
|
|
2854
|
+
* @param {*} [options] Override http request option.
|
|
2855
|
+
* @throws {RequiredError}
|
|
2856
|
+
*/
|
|
2857
|
+
apiV1StoresXStoreIDQuerySuggestionsConfigPut(xStoreid, xStoreWriteSecret, xStoreID, querySuggestionsServiceUpdateSuggestionConfigRequest, options) {
|
|
2858
|
+
return localVarFp.apiV1StoresXStoreIDQuerySuggestionsConfigPut(xStoreid, xStoreWriteSecret, xStoreID, querySuggestionsServiceUpdateSuggestionConfigRequest, options).then((request) => request(axios, basePath));
|
|
2859
|
+
},
|
|
2860
|
+
/**
|
|
2861
|
+
* 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.
|
|
2862
|
+
* @summary Get index schema
|
|
2863
|
+
* @param {string} xStoreid Store ID (from dashboard)
|
|
2864
|
+
* @param {string} xStoresecret Store read secret
|
|
2865
|
+
* @param {string} xStoreID Store ID (must match x-storeid header)
|
|
2866
|
+
* @param {*} [options] Override http request option.
|
|
2867
|
+
* @throws {RequiredError}
|
|
2868
|
+
*/
|
|
2869
|
+
apiV1StoresXStoreIDSchemaGet(xStoreid, xStoresecret, xStoreID, options) {
|
|
2870
|
+
return localVarFp.apiV1StoresXStoreIDSchemaGet(xStoreid, xStoresecret, xStoreID, options).then((request) => request(axios, basePath));
|
|
2871
|
+
},
|
|
2872
|
+
/**
|
|
2873
|
+
* 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.
|
|
2874
|
+
* @summary Create or update index schema
|
|
2875
|
+
* @param {string} xStoreid Store ID (from dashboard)
|
|
2876
|
+
* @param {string} xStoreWriteSecret Store write secret
|
|
2877
|
+
* @param {string} xStoreID Store ID (must match x-storeid header)
|
|
2878
|
+
* @param {DataTypesCollectionSchemaRequest} dataTypesCollectionSchemaRequest Schema definition and mode
|
|
2879
|
+
* @param {*} [options] Override http request option.
|
|
2880
|
+
* @throws {RequiredError}
|
|
2881
|
+
*/
|
|
2882
|
+
apiV1StoresXStoreIDSchemaPost(xStoreid, xStoreWriteSecret, xStoreID, dataTypesCollectionSchemaRequest, options) {
|
|
2883
|
+
return localVarFp.apiV1StoresXStoreIDSchemaPost(xStoreid, xStoreWriteSecret, xStoreID, dataTypesCollectionSchemaRequest, options).then((request) => request(axios, basePath));
|
|
2884
|
+
},
|
|
2885
|
+
};
|
|
2886
|
+
};
|
|
2887
|
+
exports.StoreManagementApiFactory = StoreManagementApiFactory;
|
|
2888
|
+
/**
|
|
2889
|
+
* StoreManagementApi - object-oriented interface
|
|
2890
|
+
*/
|
|
2891
|
+
class StoreManagementApi extends base_1.BaseAPI {
|
|
2892
|
+
/**
|
|
2893
|
+
* Creates a new store with minimal information. Returns store credentials (xStoreID, xStoreSecret, xStoreWriteSecret) immediately. This is a public API for SDK integration. Requires JWT authentication.
|
|
2894
|
+
* @summary Create Store (Public SDK API)
|
|
2895
|
+
* @param {string} authorization Bearer JWT Token
|
|
2896
|
+
* @param {DataTypesCreateStoreRequest} dataTypesCreateStoreRequest Store creation request
|
|
2897
|
+
* @param {*} [options] Override http request option.
|
|
2898
|
+
* @throws {RequiredError}
|
|
2899
|
+
*/
|
|
2900
|
+
apiV1StoresPost(authorization, dataTypesCreateStoreRequest, options) {
|
|
2901
|
+
return (0, exports.StoreManagementApiFp)(this.configuration).apiV1StoresPost(authorization, dataTypesCreateStoreRequest, options).then((request) => request(this.axios, this.basePath));
|
|
3806
2902
|
}
|
|
3807
2903
|
/**
|
|
3808
|
-
*
|
|
3809
|
-
* @summary
|
|
2904
|
+
* Returns search and query-suggestions configuration for the store. **Auth:** `x-storeid` and `x-storesecret`. Path `xStoreID` must match the `x-storeid` header.
|
|
2905
|
+
* @summary Get store configuration
|
|
3810
2906
|
* @param {string} xStoreid Store ID (from dashboard)
|
|
3811
|
-
* @param {string} xStoresecret Store read secret
|
|
3812
|
-
* @param {
|
|
3813
|
-
* @param {string} [xUserId] User ID for personalization
|
|
3814
|
-
* @param {string} [xAnonId] Anonymous user ID for personalization
|
|
3815
|
-
* @param {string} [xSessionId] Session ID for personalization
|
|
2907
|
+
* @param {string} xStoresecret Store read secret
|
|
2908
|
+
* @param {string} xStoreID Store ID (must match x-storeid header)
|
|
3816
2909
|
* @param {*} [options] Override http request option.
|
|
3817
2910
|
* @throws {RequiredError}
|
|
3818
2911
|
*/
|
|
3819
|
-
|
|
3820
|
-
return (0, exports.
|
|
2912
|
+
apiV1StoresXStoreIDConfigGet(xStoreid, xStoresecret, xStoreID, options) {
|
|
2913
|
+
return (0, exports.StoreManagementApiFp)(this.configuration).apiV1StoresXStoreIDConfigGet(xStoreid, xStoresecret, xStoreID, options).then((request) => request(this.axios, this.basePath));
|
|
2914
|
+
}
|
|
2915
|
+
/**
|
|
2916
|
+
* Update search and store settings. Partial updates supported. **Auth:** `x-storeid` and `x-store-write-secret`. Path `xStoreID` must match the `x-storeid` header.
|
|
2917
|
+
* @summary Update store configuration
|
|
2918
|
+
* @param {string} xStoreid Store ID (from dashboard)
|
|
2919
|
+
* @param {string} xStoreWriteSecret Store write secret
|
|
2920
|
+
* @param {string} xStoreID Store ID (must match x-storeid header)
|
|
2921
|
+
* @param {DataTypesIndexConfig} dataTypesIndexConfig Fields to update (partial)
|
|
2922
|
+
* @param {*} [options] Override http request option.
|
|
2923
|
+
* @throws {RequiredError}
|
|
2924
|
+
*/
|
|
2925
|
+
apiV1StoresXStoreIDConfigPut(xStoreid, xStoreWriteSecret, xStoreID, dataTypesIndexConfig, options) {
|
|
2926
|
+
return (0, exports.StoreManagementApiFp)(this.configuration).apiV1StoresXStoreIDConfigPut(xStoreid, xStoreWriteSecret, xStoreID, dataTypesIndexConfig, options).then((request) => request(this.axios, this.basePath));
|
|
2927
|
+
}
|
|
2928
|
+
/**
|
|
2929
|
+
* Returns metadata for all configurable store fields (types, defaults, validation). **Auth:** `x-storeid` and `x-storesecret`. Path `xStoreID` must match the `x-storeid` header.
|
|
2930
|
+
* @summary Get store config schema
|
|
2931
|
+
* @param {string} xStoreid Store ID (from dashboard)
|
|
2932
|
+
* @param {string} xStoresecret Store read secret
|
|
2933
|
+
* @param {string} xStoreID Store ID (must match x-storeid header)
|
|
2934
|
+
* @param {*} [options] Override http request option.
|
|
2935
|
+
* @throws {RequiredError}
|
|
2936
|
+
*/
|
|
2937
|
+
apiV1StoresXStoreIDConfigSchemaGet(xStoreid, xStoresecret, xStoreID, options) {
|
|
2938
|
+
return (0, exports.StoreManagementApiFp)(this.configuration).apiV1StoresXStoreIDConfigSchemaGet(xStoreid, xStoresecret, xStoreID, options).then((request) => request(this.axios, this.basePath));
|
|
2939
|
+
}
|
|
2940
|
+
/**
|
|
2941
|
+
* 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.
|
|
2942
|
+
* @summary Bulk index documents
|
|
2943
|
+
* @param {string} xStoreid Store ID (from dashboard)
|
|
2944
|
+
* @param {string} xStoreWriteSecret Store write secret
|
|
2945
|
+
* @param {string} xStoreID Store ID (must match x-storeid header)
|
|
2946
|
+
* @param {DataTypesBulkDocumentRequest} dataTypesBulkDocumentRequest List of operations
|
|
2947
|
+
* @param {*} [options] Override http request option.
|
|
2948
|
+
* @throws {RequiredError}
|
|
2949
|
+
*/
|
|
2950
|
+
apiV1StoresXStoreIDDocumentsBulkPost(xStoreid, xStoreWriteSecret, xStoreID, dataTypesBulkDocumentRequest, options) {
|
|
2951
|
+
return (0, exports.StoreManagementApiFp)(this.configuration).apiV1StoresXStoreIDDocumentsBulkPost(xStoreid, xStoreWriteSecret, xStoreID, dataTypesBulkDocumentRequest, options).then((request) => request(this.axios, this.basePath));
|
|
2952
|
+
}
|
|
2953
|
+
/**
|
|
2954
|
+
* 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.
|
|
2955
|
+
* @summary Clear all documents
|
|
2956
|
+
* @param {string} xStoreid Store ID (from dashboard)
|
|
2957
|
+
* @param {string} xStoreWriteSecret Store write secret
|
|
2958
|
+
* @param {string} xStoreID Store ID (must match x-storeid header)
|
|
2959
|
+
* @param {*} [options] Override http request option.
|
|
2960
|
+
* @throws {RequiredError}
|
|
2961
|
+
*/
|
|
2962
|
+
apiV1StoresXStoreIDDocumentsDelete(xStoreid, xStoreWriteSecret, xStoreID, options) {
|
|
2963
|
+
return (0, exports.StoreManagementApiFp)(this.configuration).apiV1StoresXStoreIDDocumentsDelete(xStoreid, xStoreWriteSecret, xStoreID, options).then((request) => request(this.axios, this.basePath));
|
|
2964
|
+
}
|
|
2965
|
+
/**
|
|
2966
|
+
* 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.
|
|
2967
|
+
* @summary Delete a document
|
|
2968
|
+
* @param {string} xStoreid Store ID (from dashboard)
|
|
2969
|
+
* @param {string} xStoreWriteSecret Store write secret
|
|
2970
|
+
* @param {string} xStoreID Store ID (must match x-storeid header)
|
|
2971
|
+
* @param {string} documentID Document ID to delete
|
|
2972
|
+
* @param {*} [options] Override http request option.
|
|
2973
|
+
* @throws {RequiredError}
|
|
2974
|
+
*/
|
|
2975
|
+
apiV1StoresXStoreIDDocumentsDocumentIDDelete(xStoreid, xStoreWriteSecret, xStoreID, documentID, options) {
|
|
2976
|
+
return (0, exports.StoreManagementApiFp)(this.configuration).apiV1StoresXStoreIDDocumentsDocumentIDDelete(xStoreid, xStoreWriteSecret, xStoreID, documentID, options).then((request) => request(this.axios, this.basePath));
|
|
2977
|
+
}
|
|
2978
|
+
/**
|
|
2979
|
+
* 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.
|
|
2980
|
+
* @summary Get a document by ID
|
|
2981
|
+
* @param {string} xStoreid Store ID (from dashboard)
|
|
2982
|
+
* @param {string} xStoresecret Store read secret
|
|
2983
|
+
* @param {string} xStoreID Store ID (must match x-storeid header)
|
|
2984
|
+
* @param {string} documentID Document ID to retrieve
|
|
2985
|
+
* @param {*} [options] Override http request option.
|
|
2986
|
+
* @throws {RequiredError}
|
|
2987
|
+
*/
|
|
2988
|
+
apiV1StoresXStoreIDDocumentsDocumentIDGet(xStoreid, xStoresecret, xStoreID, documentID, options) {
|
|
2989
|
+
return (0, exports.StoreManagementApiFp)(this.configuration).apiV1StoresXStoreIDDocumentsDocumentIDGet(xStoreid, xStoresecret, xStoreID, documentID, options).then((request) => request(this.axios, this.basePath));
|
|
2990
|
+
}
|
|
2991
|
+
/**
|
|
2992
|
+
* 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.
|
|
2993
|
+
* @summary Index a single document
|
|
2994
|
+
* @param {string} xStoreid Store ID (from dashboard)
|
|
2995
|
+
* @param {string} xStoreWriteSecret Store write secret
|
|
2996
|
+
* @param {string} xStoreID Store ID (must match x-storeid header)
|
|
2997
|
+
* @param {DataTypesDocumentRequest} dataTypesDocumentRequest Document fields to index
|
|
2998
|
+
* @param {*} [options] Override http request option.
|
|
2999
|
+
* @throws {RequiredError}
|
|
3000
|
+
*/
|
|
3001
|
+
apiV1StoresXStoreIDDocumentsPost(xStoreid, xStoreWriteSecret, xStoreID, dataTypesDocumentRequest, options) {
|
|
3002
|
+
return (0, exports.StoreManagementApiFp)(this.configuration).apiV1StoresXStoreIDDocumentsPost(xStoreid, xStoreWriteSecret, xStoreID, dataTypesDocumentRequest, options).then((request) => request(this.axios, this.basePath));
|
|
3003
|
+
}
|
|
3004
|
+
/**
|
|
3005
|
+
* Returns basic store details (name, location, status). **Auth:** `x-storeid` and `x-storesecret`. Path `xStoreID` must match the `x-storeid` header.
|
|
3006
|
+
* @summary Get store info
|
|
3007
|
+
* @param {string} xStoreid Store ID (from dashboard)
|
|
3008
|
+
* @param {string} xStoresecret Store read secret
|
|
3009
|
+
* @param {string} xStoreID Store ID (must match x-storeid header)
|
|
3010
|
+
* @param {*} [options] Override http request option.
|
|
3011
|
+
* @throws {RequiredError}
|
|
3012
|
+
*/
|
|
3013
|
+
apiV1StoresXStoreIDGet(xStoreid, xStoresecret, xStoreID, options) {
|
|
3014
|
+
return (0, exports.StoreManagementApiFp)(this.configuration).apiV1StoresXStoreIDGet(xStoreid, xStoresecret, xStoreID, options).then((request) => request(this.axios, this.basePath));
|
|
3015
|
+
}
|
|
3016
|
+
/**
|
|
3017
|
+
* Returns autocomplete/suggestions configuration for the store. **Auth:** `x-storeid` and `x-storesecret`. Path `xStoreID` must match the `x-storeid` header.
|
|
3018
|
+
* @summary Get query suggestions configuration
|
|
3019
|
+
* @param {string} xStoreid Store ID (from dashboard)
|
|
3020
|
+
* @param {string} xStoresecret Store read secret
|
|
3021
|
+
* @param {string} xStoreID Store ID (must match x-storeid header)
|
|
3022
|
+
* @param {*} [options] Override http request option.
|
|
3023
|
+
* @throws {RequiredError}
|
|
3024
|
+
*/
|
|
3025
|
+
apiV1StoresXStoreIDQuerySuggestionsConfigGet(xStoreid, xStoresecret, xStoreID, options) {
|
|
3026
|
+
return (0, exports.StoreManagementApiFp)(this.configuration).apiV1StoresXStoreIDQuerySuggestionsConfigGet(xStoreid, xStoresecret, xStoreID, options).then((request) => request(this.axios, this.basePath));
|
|
3027
|
+
}
|
|
3028
|
+
/**
|
|
3029
|
+
* 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.
|
|
3030
|
+
* @summary Update query suggestions configuration
|
|
3031
|
+
* @param {string} xStoreid Store ID (from dashboard)
|
|
3032
|
+
* @param {string} xStoreWriteSecret Store write secret
|
|
3033
|
+
* @param {string} xStoreID Store ID (must match x-storeid header)
|
|
3034
|
+
* @param {QuerySuggestionsServiceUpdateSuggestionConfigRequest} querySuggestionsServiceUpdateSuggestionConfigRequest Fields to update (partial)
|
|
3035
|
+
* @param {*} [options] Override http request option.
|
|
3036
|
+
* @throws {RequiredError}
|
|
3037
|
+
*/
|
|
3038
|
+
apiV1StoresXStoreIDQuerySuggestionsConfigPut(xStoreid, xStoreWriteSecret, xStoreID, querySuggestionsServiceUpdateSuggestionConfigRequest, options) {
|
|
3039
|
+
return (0, exports.StoreManagementApiFp)(this.configuration).apiV1StoresXStoreIDQuerySuggestionsConfigPut(xStoreid, xStoreWriteSecret, xStoreID, querySuggestionsServiceUpdateSuggestionConfigRequest, options).then((request) => request(this.axios, this.basePath));
|
|
3040
|
+
}
|
|
3041
|
+
/**
|
|
3042
|
+
* 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.
|
|
3043
|
+
* @summary Get index schema
|
|
3044
|
+
* @param {string} xStoreid Store ID (from dashboard)
|
|
3045
|
+
* @param {string} xStoresecret Store read secret
|
|
3046
|
+
* @param {string} xStoreID Store ID (must match x-storeid header)
|
|
3047
|
+
* @param {*} [options] Override http request option.
|
|
3048
|
+
* @throws {RequiredError}
|
|
3049
|
+
*/
|
|
3050
|
+
apiV1StoresXStoreIDSchemaGet(xStoreid, xStoresecret, xStoreID, options) {
|
|
3051
|
+
return (0, exports.StoreManagementApiFp)(this.configuration).apiV1StoresXStoreIDSchemaGet(xStoreid, xStoresecret, xStoreID, options).then((request) => request(this.axios, this.basePath));
|
|
3052
|
+
}
|
|
3053
|
+
/**
|
|
3054
|
+
* 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.
|
|
3055
|
+
* @summary Create or update index schema
|
|
3056
|
+
* @param {string} xStoreid Store ID (from dashboard)
|
|
3057
|
+
* @param {string} xStoreWriteSecret Store write secret
|
|
3058
|
+
* @param {string} xStoreID Store ID (must match x-storeid header)
|
|
3059
|
+
* @param {DataTypesCollectionSchemaRequest} dataTypesCollectionSchemaRequest Schema definition and mode
|
|
3060
|
+
* @param {*} [options] Override http request option.
|
|
3061
|
+
* @throws {RequiredError}
|
|
3062
|
+
*/
|
|
3063
|
+
apiV1StoresXStoreIDSchemaPost(xStoreid, xStoreWriteSecret, xStoreID, dataTypesCollectionSchemaRequest, options) {
|
|
3064
|
+
return (0, exports.StoreManagementApiFp)(this.configuration).apiV1StoresXStoreIDSchemaPost(xStoreid, xStoreWriteSecret, xStoreID, dataTypesCollectionSchemaRequest, options).then((request) => request(this.axios, this.basePath));
|
|
3821
3065
|
}
|
|
3822
3066
|
}
|
|
3823
|
-
exports.
|
|
3067
|
+
exports.StoreManagementApi = StoreManagementApi;
|