oneentry 1.0.173 → 1.0.175
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/changelog.md +35 -0
- package/dist/admins/adminsApi.d.ts +7 -7
- package/dist/admins/adminsApi.js +7 -7
- package/dist/admins/adminsInterfaces.d.ts +22 -22
- package/dist/attribute-sets/attributeSetsApi.d.ts +8 -8
- package/dist/attribute-sets/attributeSetsApi.js +8 -8
- package/dist/attribute-sets/attributeSetsInterfaces.d.ts +31 -31
- package/dist/auth-provider/authProviderApi.d.ts +30 -30
- package/dist/auth-provider/authProviderApi.js +30 -30
- package/dist/auth-provider/authProviderSchemas.d.ts +1 -1
- package/dist/auth-provider/authProvidersInterfaces.d.ts +54 -53
- package/dist/base/asyncModules.d.ts +6 -6
- package/dist/base/asyncModules.js +6 -6
- package/dist/base/syncModules.d.ts +1 -1
- package/dist/base/syncModules.js +1 -1
- package/dist/base/utils.d.ts +3 -3
- package/dist/base/validation.d.ts +1 -1
- package/dist/base/validation.js +1 -1
- package/dist/blocks/blocksApi.d.ts +35 -35
- package/dist/blocks/blocksApi.js +35 -35
- package/dist/blocks/blocksInterfaces.d.ts +55 -55
- package/dist/discounts/discountsApi.d.ts +14 -14
- package/dist/discounts/discountsApi.js +14 -14
- package/dist/discounts/discountsInterfaces.d.ts +52 -52
- package/dist/events/eventsApi.d.ts +13 -13
- package/dist/events/eventsApi.js +13 -13
- package/dist/events/eventsInterfaces.d.ts +18 -18
- package/dist/file-uploading/fileUploadingApi.d.ts +14 -14
- package/dist/file-uploading/fileUploadingApi.js +14 -14
- package/dist/file-uploading/fileUploadingInterfaces.d.ts +25 -25
- package/dist/filters/filtersApi.d.ts +1 -1
- package/dist/filters/filtersApi.js +1 -1
- package/dist/filters/filtersInterfaces.d.ts +7 -7
- package/dist/forms/formsApi.d.ts +3 -3
- package/dist/forms/formsApi.js +3 -3
- package/dist/forms/formsInterfaces.d.ts +42 -42
- package/dist/forms-data/formsDataApi.d.ts +14 -14
- package/dist/forms-data/formsDataApi.js +14 -14
- package/dist/forms-data/formsDataInterfaces.d.ts +67 -68
- package/dist/general-types/generalTypesInterfaces.d.ts +2 -2
- package/dist/integration-collections/integrationCollectionsApi.d.ts +20 -20
- package/dist/integration-collections/integrationCollectionsApi.js +20 -20
- package/dist/integration-collections/integrationCollectionsInterfaces.d.ts +44 -44
- package/dist/locales/localesInterfaces.d.ts +8 -8
- package/dist/menus/menusApi.d.ts +1 -1
- package/dist/menus/menusApi.js +1 -1
- package/dist/menus/menusInterfaces.d.ts +12 -12
- package/dist/orders/ordersApi.d.ts +26 -26
- package/dist/orders/ordersApi.js +26 -26
- package/dist/orders/ordersInterfaces.d.ts +99 -99
- package/dist/pages/pagesApi.d.ts +6 -6
- package/dist/pages/pagesApi.js +6 -6
- package/dist/pages/pagesInterfaces.d.ts +46 -46
- package/dist/payments/paymentsApi.d.ts +8 -8
- package/dist/payments/paymentsApi.js +8 -8
- package/dist/payments/paymentsInterfaces.d.ts +31 -31
- package/dist/product-statuses/productStatusesApi.d.ts +2 -2
- package/dist/product-statuses/productStatusesApi.js +2 -2
- package/dist/product-statuses/productStatusesInterfaces.d.ts +8 -8
- package/dist/products/productsApi.d.ts +37 -37
- package/dist/products/productsApi.js +36 -36
- package/dist/products/productsInterfaces.d.ts +96 -96
- package/dist/search/searchApi.d.ts +3 -3
- package/dist/search/searchApi.js +3 -3
- package/dist/search/searchInterfaces.d.ts +4 -4
- package/dist/sitemap/sitemapApi.d.ts +1 -1
- package/dist/sitemap/sitemapApi.js +1 -1
- package/dist/sitemap/sitemapInterfaces.d.ts +2 -2
- package/dist/subscriptions/subscriptionsApi.d.ts +3 -3
- package/dist/subscriptions/subscriptionsApi.js +3 -3
- package/dist/subscriptions/subscriptionsInterfaces.d.ts +11 -11
- package/dist/templates/templatesApi.d.ts +2 -2
- package/dist/templates/templatesApi.js +2 -2
- package/dist/templates/templatesInterfaces.d.ts +10 -10
- package/dist/templates-preview/templatesPreviewApi.d.ts +1 -1
- package/dist/templates-preview/templatesPreviewApi.js +1 -1
- package/dist/templates-preview/templatesPreviewInterfaces.d.ts +17 -17
- package/dist/user-activity/userActivityApi.d.ts +1 -1
- package/dist/user-activity/userActivityApi.js +1 -1
- package/dist/user-activity/userActivityInterfaces.d.ts +4 -4
- package/dist/user-groups/userGroupsApi.d.ts +1 -1
- package/dist/user-groups/userGroupsApi.js +1 -1
- package/dist/user-groups/userGroupsInterfaces.d.ts +5 -5
- package/dist/users/usersApi.d.ts +9 -9
- package/dist/users/usersApi.js +9 -9
- package/dist/users/usersInterfaces.d.ts +40 -39
- package/dist/users/usersSchemas.d.ts +1 -1
- package/esm/admins/adminsApi.d.ts +7 -7
- package/esm/admins/adminsApi.js +7 -7
- package/esm/admins/adminsInterfaces.d.ts +22 -22
- package/esm/attribute-sets/attributeSetsApi.d.ts +8 -8
- package/esm/attribute-sets/attributeSetsApi.js +8 -8
- package/esm/attribute-sets/attributeSetsInterfaces.d.ts +31 -31
- package/esm/auth-provider/authProviderApi.d.ts +30 -30
- package/esm/auth-provider/authProviderApi.js +30 -30
- package/esm/auth-provider/authProviderSchemas.d.ts +1 -1
- package/esm/auth-provider/authProvidersInterfaces.d.ts +54 -53
- package/esm/base/asyncModules.d.ts +6 -6
- package/esm/base/asyncModules.js +6 -6
- package/esm/base/syncModules.d.ts +1 -1
- package/esm/base/syncModules.js +1 -1
- package/esm/base/utils.d.ts +3 -3
- package/esm/base/validation.d.ts +1 -1
- package/esm/base/validation.js +1 -1
- package/esm/blocks/blocksApi.d.ts +35 -35
- package/esm/blocks/blocksApi.js +35 -35
- package/esm/blocks/blocksInterfaces.d.ts +55 -55
- package/esm/discounts/discountsApi.d.ts +14 -14
- package/esm/discounts/discountsApi.js +14 -14
- package/esm/discounts/discountsInterfaces.d.ts +52 -52
- package/esm/events/eventsApi.d.ts +13 -13
- package/esm/events/eventsApi.js +13 -13
- package/esm/events/eventsInterfaces.d.ts +18 -18
- package/esm/file-uploading/fileUploadingApi.d.ts +14 -14
- package/esm/file-uploading/fileUploadingApi.js +14 -14
- package/esm/file-uploading/fileUploadingInterfaces.d.ts +25 -25
- package/esm/filters/filtersApi.d.ts +1 -1
- package/esm/filters/filtersApi.js +1 -1
- package/esm/filters/filtersInterfaces.d.ts +7 -7
- package/esm/forms/formsApi.d.ts +3 -3
- package/esm/forms/formsApi.js +3 -3
- package/esm/forms/formsInterfaces.d.ts +42 -42
- package/esm/forms-data/formsDataApi.d.ts +14 -14
- package/esm/forms-data/formsDataApi.js +14 -14
- package/esm/forms-data/formsDataInterfaces.d.ts +67 -68
- package/esm/general-types/generalTypesInterfaces.d.ts +2 -2
- package/esm/integration-collections/integrationCollectionsApi.d.ts +20 -20
- package/esm/integration-collections/integrationCollectionsApi.js +20 -20
- package/esm/integration-collections/integrationCollectionsInterfaces.d.ts +44 -44
- package/esm/locales/localesInterfaces.d.ts +8 -8
- package/esm/menus/menusApi.d.ts +1 -1
- package/esm/menus/menusApi.js +1 -1
- package/esm/menus/menusInterfaces.d.ts +12 -12
- package/esm/orders/ordersApi.d.ts +26 -26
- package/esm/orders/ordersApi.js +26 -26
- package/esm/orders/ordersInterfaces.d.ts +99 -99
- package/esm/pages/pagesApi.d.ts +6 -6
- package/esm/pages/pagesApi.js +6 -6
- package/esm/pages/pagesInterfaces.d.ts +46 -46
- package/esm/payments/paymentsApi.d.ts +8 -8
- package/esm/payments/paymentsApi.js +8 -8
- package/esm/payments/paymentsInterfaces.d.ts +31 -31
- package/esm/product-statuses/productStatusesApi.d.ts +2 -2
- package/esm/product-statuses/productStatusesApi.js +2 -2
- package/esm/product-statuses/productStatusesInterfaces.d.ts +8 -8
- package/esm/products/productsApi.d.ts +37 -37
- package/esm/products/productsApi.js +36 -36
- package/esm/products/productsInterfaces.d.ts +96 -96
- package/esm/search/searchApi.d.ts +3 -3
- package/esm/search/searchApi.js +3 -3
- package/esm/search/searchInterfaces.d.ts +4 -4
- package/esm/sitemap/sitemapApi.d.ts +1 -1
- package/esm/sitemap/sitemapApi.js +1 -1
- package/esm/sitemap/sitemapInterfaces.d.ts +2 -2
- package/esm/subscriptions/subscriptionsApi.d.ts +3 -3
- package/esm/subscriptions/subscriptionsApi.js +3 -3
- package/esm/subscriptions/subscriptionsInterfaces.d.ts +11 -11
- package/esm/templates/templatesApi.d.ts +2 -2
- package/esm/templates/templatesApi.js +2 -2
- package/esm/templates/templatesInterfaces.d.ts +10 -10
- package/esm/templates-preview/templatesPreviewApi.d.ts +1 -1
- package/esm/templates-preview/templatesPreviewApi.js +1 -1
- package/esm/templates-preview/templatesPreviewInterfaces.d.ts +17 -17
- package/esm/user-activity/userActivityApi.d.ts +1 -1
- package/esm/user-activity/userActivityApi.js +1 -1
- package/esm/user-activity/userActivityInterfaces.d.ts +4 -4
- package/esm/user-groups/userGroupsApi.d.ts +1 -1
- package/esm/user-groups/userGroupsApi.js +1 -1
- package/esm/user-groups/userGroupsInterfaces.d.ts +5 -5
- package/esm/users/usersApi.d.ts +9 -9
- package/esm/users/usersApi.js +9 -9
- package/esm/users/usersInterfaces.d.ts +40 -39
- package/esm/users/usersSchemas.d.ts +1 -1
- package/package.json +2 -2
|
@@ -1,4 +1,5 @@
|
|
|
1
1
|
import type { IError, ILocalizeInfo, IRating } from '../base/utils.js';
|
|
2
|
+
import type { FormDataType } from '../forms-data/formsDataInterfaces.js';
|
|
2
3
|
/**
|
|
3
4
|
* @interface IAuthProvider
|
|
4
5
|
* @description This interface defines methods for user authentication and registration through various auth providers.
|
|
@@ -133,8 +134,8 @@ interface IAuthProvider {
|
|
|
133
134
|
* Retrieves all authentication providers.
|
|
134
135
|
* @handleName getAuthProviders
|
|
135
136
|
* @param {string} [langCode] - Optional language code for localization. Default: "en_US".
|
|
136
|
-
* @param {number} [offset] -
|
|
137
|
-
* @param {number} [limit] -
|
|
137
|
+
* @param {number} [offset] - Number of records to skip. Default: 0.
|
|
138
|
+
* @param {number} [limit] - Maximum number of records to return. Default: 30.
|
|
138
139
|
* @returns {IAuthProvidersEntity[]} A promise that resolves to an array of auth provider entities or an error.
|
|
139
140
|
* @throws {IError} - If there is an error during the fetch operation, it will return an error object.
|
|
140
141
|
* @description This method retrieves all authentication providers.
|
|
@@ -162,8 +163,8 @@ interface IAuthProvider {
|
|
|
162
163
|
/**
|
|
163
164
|
* User registration (authorization) via OAUTH.
|
|
164
165
|
* @handleName oauthSignUp
|
|
165
|
-
* @param {string} marker -
|
|
166
|
-
* @param {IOauthData} body -
|
|
166
|
+
* @param {string} marker - Marker of the auth provider. Example: "email".
|
|
167
|
+
* @param {IOauthData} body - OAuth data for registration.
|
|
167
168
|
* @example
|
|
168
169
|
{
|
|
169
170
|
"client_id": "34346983-luuct343473qdkqidjopdfp3eb3k4thp.apps.googleusercontent.com",
|
|
@@ -182,8 +183,8 @@ interface IAuthProvider {
|
|
|
182
183
|
/**
|
|
183
184
|
* Interface representing the structure of authentication form data.
|
|
184
185
|
* @interface IAuthFormData
|
|
185
|
-
* @property {string} marker -
|
|
186
|
-
* @property {string} type -
|
|
186
|
+
* @property {string} marker - Marker of the form field. Example: "email".
|
|
187
|
+
* @property {string} type - Type of the form field, for example `"string"` or `"email"`. Example: "string".
|
|
187
188
|
* @property {string} value - The value entered in the form field. Example: "example@oneentry.cloud".
|
|
188
189
|
* @description This interface defines the structure of authentication form data used in user registration and authentication processes.
|
|
189
190
|
*/
|
|
@@ -195,23 +196,23 @@ interface IAuthFormData {
|
|
|
195
196
|
/**
|
|
196
197
|
* Interface representing the data required for user registration.
|
|
197
198
|
* @interface ISignUpData
|
|
198
|
-
* @property {string} formIdentifier -
|
|
199
|
+
* @property {string} formIdentifier - Marker of the registration form. Example: "reg".
|
|
199
200
|
* @property {string} [langCode] - Language code. Default: "en_US".
|
|
200
|
-
* @property {Array} authData -
|
|
201
|
-
* @property {
|
|
202
|
-
* @property {INotificationData} notificationData -
|
|
201
|
+
* @property {Array} authData - Authentication fields, each with a `marker` and a `value`.
|
|
202
|
+
* @property {FormDataType | FormDataType[]} formData - Registration form fields. Field values: {@link FormDataType} — a value shaped by the field type (a string, a date object, a text object, a list, a file descriptor), not only a string. A file goes in as the descriptor `FileUploading.upload` returns: these methods do not upload a `File`/`Blob` themselves.
|
|
203
|
+
* @property {INotificationData} notificationData - Notification contacts: `email`, `phonePush` and `phoneSMS`.
|
|
203
204
|
* @description User registration (❗️For a provider with user activation, the activation code is sent through the corresponding user notification method).
|
|
204
205
|
*/
|
|
205
206
|
interface ISignUpData {
|
|
206
207
|
formIdentifier: string;
|
|
207
208
|
langCode?: string;
|
|
208
209
|
authData: IAuthData[];
|
|
209
|
-
formData:
|
|
210
|
+
formData: FormDataType | FormDataType[];
|
|
210
211
|
notificationData: INotificationData;
|
|
211
212
|
}
|
|
212
213
|
/**
|
|
213
214
|
* @interface INotificationData
|
|
214
|
-
* @property {string} email - User
|
|
215
|
+
* @property {string} email - User email used for notifications. Example: "example@oneentry.cloud".
|
|
215
216
|
* @property {string[]} phonePush - Phone numbers used for push notifications. Example: ["+19999999999"].
|
|
216
217
|
* @property {string} [phoneSMS] - Phone number used for SMS notifications. Example: "+19999999999".
|
|
217
218
|
* @description Notification channels configured for a user.
|
|
@@ -227,7 +228,7 @@ interface INotificationData {
|
|
|
227
228
|
* @property {string} client_id - The client ID for the OAuth application. Example: "34346983-luuct343473qdkqidjopdfp3eb3k4thp.apps.googleusercontent.com".
|
|
228
229
|
* @property {string} client_secret - The client secret for the OAuth application. Example: "43434343434".
|
|
229
230
|
* @property {string} code - The authorization code received from the OAuth provider. Example: "4/0AVMBsJgwewewewewewei4D7T6E_fbswxnL3g".
|
|
230
|
-
* @property {string} grant_type -
|
|
231
|
+
* @property {string} grant_type - OAuth grant type. Example: "authorization_code".
|
|
231
232
|
* @property {string} redirect_uri - The redirect URI for the OAuth application. Example: "http://localhost:3000".
|
|
232
233
|
* @description User registration (❗️For a provider with user activation, the activation code is sent through the corresponding user notification method).
|
|
233
234
|
*/
|
|
@@ -241,12 +242,12 @@ interface IOauthData {
|
|
|
241
242
|
/**
|
|
242
243
|
* Interface representing a sign-up entity.
|
|
243
244
|
* @interface ISignUpEntity
|
|
244
|
-
* @property {number} id -
|
|
245
|
-
* @property {string} updatedDate -
|
|
246
|
-
* @property {number} version -
|
|
247
|
-
* @property {string} identifier -
|
|
248
|
-
* @property {boolean} isActive -
|
|
249
|
-
* @property {IAuthFormData[]} formData - Form
|
|
245
|
+
* @property {number} id - ID of the user created by sign-up. Example: 12345.
|
|
246
|
+
* @property {string} updatedDate - Date the user was last updated. Example: "2023-10-01T12:00:00Z".
|
|
247
|
+
* @property {number} version - Version number of the user; changes with each update. Example: 1.
|
|
248
|
+
* @property {string} identifier - Marker of the user created by sign-up. Example: "signup_12345".
|
|
249
|
+
* @property {boolean} isActive - Whether the user account is active. Example: true.
|
|
250
|
+
* @property {IAuthFormData[]} formData - Form fields.
|
|
250
251
|
* @example
|
|
251
252
|
[
|
|
252
253
|
{
|
|
@@ -254,22 +255,22 @@ interface IOauthData {
|
|
|
254
255
|
"value": "John"
|
|
255
256
|
}
|
|
256
257
|
]
|
|
257
|
-
* @property {INotificationData} notificationData -
|
|
258
|
+
* @property {INotificationData} notificationData - Notification contacts: `email`, `phonePush` and `phoneSMS`.
|
|
258
259
|
* @example
|
|
259
260
|
{
|
|
260
261
|
"email": "example@oneentry.cloud",
|
|
261
262
|
"phonePush": ["+99999999999"],
|
|
262
263
|
"phoneSMS": "+99999999999"
|
|
263
264
|
}
|
|
264
|
-
* @property {string} [locale] -
|
|
265
|
-
* @property {string} [createdDate] -
|
|
265
|
+
* @property {string} [locale] - Locale of the user created by sign-up. Example: "en_US".
|
|
266
|
+
* @property {string} [createdDate] - Creation date of the user record. Example: "2023-10-01T12:00:00Z".
|
|
266
267
|
* @property {unknown} [importId] - Import identifier. Example: null.
|
|
267
|
-
* @property {string | null} [deletedAt] - Deletion date or null
|
|
268
|
-
* @property {boolean} [isDeleted] - Whether the
|
|
269
|
-
* @property {Record<string, unknown>} [state] -
|
|
270
|
-
* @property {IRating} [rating] - Rating data.
|
|
271
|
-
* @property {number | null} [attributeSetId] -
|
|
272
|
-
* @property {Record<string, unknown>} [attributesSets] - Attribute sets attached to the user, keyed by marker; empty object when none. Example: {}.
|
|
268
|
+
* @property {string | null} [deletedAt] - Deletion date, or `null`. Example: null.
|
|
269
|
+
* @property {boolean} [isDeleted] - Whether the user account is deleted. Example: false.
|
|
270
|
+
* @property {Record<string, unknown>} [state] - Custom key-value data stored with the user. Example: {}.
|
|
271
|
+
* @property {IRating} [rating] - Rating data: average value, likes and dislikes, and the calculation method.
|
|
272
|
+
* @property {number | null} [attributeSetId] - ID of the attribute set attached to the user, or `null` when none is attached. Example: null.
|
|
273
|
+
* @property {Record<string, unknown>} [attributesSets] - Attribute sets attached to the user, keyed by marker; an empty object when there are none. Example: {}.
|
|
273
274
|
* @description This interface defines the structure of a sign-up entity.
|
|
274
275
|
*/
|
|
275
276
|
interface ISignUpEntity {
|
|
@@ -304,8 +305,8 @@ interface ICodeEntity {
|
|
|
304
305
|
/**
|
|
305
306
|
* Interface representing an authentication entity.
|
|
306
307
|
* @interface IAuthEntity
|
|
307
|
-
* @property {string} userIdentifier -
|
|
308
|
-
* @property {string} authProviderIdentifier -
|
|
308
|
+
* @property {string} userIdentifier - User identifier (login), for example the email address. Example: "user12345".
|
|
309
|
+
* @property {string} authProviderIdentifier - Marker of the authentication provider. Example: "email".
|
|
309
310
|
* @property {string} accessToken - The access token for the user session. Example: "abcdef123456".
|
|
310
311
|
* @property {string} refreshToken - The refresh token for renewing the access token. Example: "ghijkl789012".
|
|
311
312
|
* @description This interface defines the structure of an authentication entity.
|
|
@@ -319,24 +320,24 @@ interface IAuthEntity {
|
|
|
319
320
|
/**
|
|
320
321
|
* Interface representing an authentication provider entity.
|
|
321
322
|
* @interface IAuthProvidersEntity
|
|
322
|
-
* @property {number} id -
|
|
323
|
-
* @property {ILocalizeInfo} localizeInfos - Localized
|
|
323
|
+
* @property {number} id - ID of the auth provider. Example: 194.
|
|
324
|
+
* @property {ILocalizeInfo} localizeInfos - Localized data of the auth provider.
|
|
324
325
|
* @example
|
|
325
326
|
{
|
|
326
327
|
"key": "value"
|
|
327
328
|
}
|
|
328
|
-
* @property {IAuthProvidersEntityConfig} config -
|
|
329
|
+
* @property {IAuthProvidersEntityConfig} config - Provider configuration as key-value pairs.
|
|
329
330
|
* @example
|
|
330
331
|
{
|
|
331
332
|
"key": "value"
|
|
332
333
|
}
|
|
333
|
-
* @property {number} version -
|
|
334
|
-
* @property {string} identifier -
|
|
335
|
-
* @property {string} type -
|
|
336
|
-
* @property {string | null} formIdentifier -
|
|
337
|
-
* @property {string} userGroupIdentifier -
|
|
338
|
-
* @property {boolean} isActive -
|
|
339
|
-
* @property {boolean} isCheckCode -
|
|
334
|
+
* @property {number} version - Version number of the auth provider; changes with each update. Example: 1.
|
|
335
|
+
* @property {string} identifier - Marker of the auth provider. Example: "email".
|
|
336
|
+
* @property {string} type - Type of the auth provider, for example `"email"`. Example: "email".
|
|
337
|
+
* @property {string | null} formIdentifier - Marker of the form linked to the auth provider, or `null` if there is none. Example: "reg_form".
|
|
338
|
+
* @property {string} userGroupIdentifier - Identifier of the user group linked to the auth provider. Example: "guest".
|
|
339
|
+
* @property {boolean} isActive - Whether the auth provider is active. Example: true.
|
|
340
|
+
* @property {boolean} isCheckCode - Whether the auth provider requires a verification code. Example: false.
|
|
340
341
|
* @description This interface defines the structure of an authentication provider entity.
|
|
341
342
|
*/
|
|
342
343
|
interface IAuthProvidersEntity {
|
|
@@ -355,12 +356,12 @@ interface IAuthProvidersEntity {
|
|
|
355
356
|
* Interface representing an authentication provider config.
|
|
356
357
|
* @interface IAuthProvidersEntityConfig
|
|
357
358
|
* @property {string} accessTokenTtlSec - Access token time to live in seconds. Example: "3600".
|
|
358
|
-
* @property {string} refreshTokenTtlMc -
|
|
359
|
-
* @property {string} deleteNoneActiveUsersAfterDays -
|
|
360
|
-
* @property {string} systemCodeTlsSec -
|
|
361
|
-
* @property {string} systemCodeLength -
|
|
359
|
+
* @property {string} refreshTokenTtlMc - Lifetime of the refresh token, in milliseconds. Example: "86400000".
|
|
360
|
+
* @property {string} deleteNoneActiveUsersAfterDays - Number of days after which inactive users are deleted. Example: "30".
|
|
361
|
+
* @property {string} systemCodeTlsSec - Lifetime of the one-time code, in seconds. Example: "86400".
|
|
362
|
+
* @property {string} systemCodeLength - Length of the one-time code. Example: "6".
|
|
362
363
|
* @property {string | null} oauthAuthUrl - OAuth authorization URL. Example: null.
|
|
363
|
-
* @property {string | null} systemCodeOnlyNumbers -
|
|
364
|
+
* @property {string | null} systemCodeOnlyNumbers - Whether the one-time code uses digits only; `null` when not set. Example: null.
|
|
364
365
|
*/
|
|
365
366
|
interface IAuthProvidersEntityConfig {
|
|
366
367
|
accessTokenTtlSec: string;
|
|
@@ -374,7 +375,7 @@ interface IAuthProvidersEntityConfig {
|
|
|
374
375
|
/**
|
|
375
376
|
* Authentication data object.
|
|
376
377
|
* @interface IAuthData
|
|
377
|
-
* @property {string} marker -
|
|
378
|
+
* @property {string} marker - Marker of the auth form field. Example: "login".
|
|
378
379
|
* @property {string} value - The value of the auth field. Example: "user@example.com".
|
|
379
380
|
*/
|
|
380
381
|
interface IAuthData {
|
|
@@ -384,7 +385,7 @@ interface IAuthData {
|
|
|
384
385
|
/**
|
|
385
386
|
* Interface representing the body used in authentication requests.
|
|
386
387
|
* @interface IAuthPostBody
|
|
387
|
-
* @property {IAuthData[]} authData -
|
|
388
|
+
* @property {IAuthData[]} authData - Authentication fields, each with a `marker` and a `value`.
|
|
388
389
|
* @example
|
|
389
390
|
[
|
|
390
391
|
{
|
|
@@ -400,16 +401,16 @@ interface IAuthPostBody {
|
|
|
400
401
|
/**
|
|
401
402
|
* Interface representing the active session data.
|
|
402
403
|
* @interface IActiveSession
|
|
403
|
-
* @property {object} deviceInfo -
|
|
404
|
+
* @property {object} deviceInfo - Device used in the active session.
|
|
404
405
|
* @example
|
|
405
406
|
{
|
|
406
407
|
"os": "Win32",
|
|
407
408
|
"browser": "Node.js/22",
|
|
408
409
|
"location": "en-US"
|
|
409
410
|
}
|
|
410
|
-
* @property {string} deviceInfo.os -
|
|
411
|
-
* @property {string} deviceInfo.browser -
|
|
412
|
-
* @property {string} deviceInfo.location -
|
|
411
|
+
* @property {string} deviceInfo.os - Operating system of the active session. Example: "Win32".
|
|
412
|
+
* @property {string} deviceInfo.browser - Browser of the active session. Example: "Node.js/22".
|
|
413
|
+
* @property {string} deviceInfo.location - Location of the active session. Example: "en-US".
|
|
413
414
|
* @description This interface defines the structure of the body used in authentication requests, containing an array of authentication data.
|
|
414
415
|
*/
|
|
415
416
|
interface IActiveSession {
|
|
@@ -417,8 +418,8 @@ interface IActiveSession {
|
|
|
417
418
|
}
|
|
418
419
|
/**
|
|
419
420
|
* @interface IDeviceInfo
|
|
420
|
-
* @property {string} os -
|
|
421
|
-
* @property {string} browser -
|
|
421
|
+
* @property {string} os - Operating system of the active session. Example: "Win32".
|
|
422
|
+
* @property {string} browser - Browser of the active session. Example: "Node.js/22".
|
|
422
423
|
* @property {string} location - The locale of the active session. Example: "en-US".
|
|
423
424
|
* @description Information about the device tied to an active authentication session.
|
|
424
425
|
*/
|
|
@@ -82,7 +82,7 @@ export default abstract class AsyncModules extends SyncModules {
|
|
|
82
82
|
*
|
|
83
83
|
* With `isShell` disabled browserResponse throws, and the error is thrown on
|
|
84
84
|
* from here too: returning it would break the `@throws` contract every caller
|
|
85
|
-
* documents, and a `try/catch` around the call would never fire
|
|
85
|
+
* documents, and a `try/catch` around the call would never fire.
|
|
86
86
|
* @param {() => Promise<unknown>} request - Thunk performing the fetch call.
|
|
87
87
|
* @returns {Promise<boolean | IError>} `true` on success, IError on failure when isShell=true.
|
|
88
88
|
* @throws {IError} When isShell=false and the request fails.
|
|
@@ -115,7 +115,7 @@ export default abstract class AsyncModules extends SyncModules {
|
|
|
115
115
|
* so both the success and the error branches handle empty bodies the same way.
|
|
116
116
|
*
|
|
117
117
|
* A body that is present but is not JSON — a gateway's HTML page in front of a
|
|
118
|
-
* 502, the platform's own admin page
|
|
118
|
+
* 502, the platform's own admin page — used to collapse into `{}`,
|
|
119
119
|
* which carries no `statusCode` and therefore does not read as an error at all:
|
|
120
120
|
* a failed request came back looking like an empty success. It is described
|
|
121
121
|
* instead, keeping the status the server actually sent.
|
|
@@ -135,8 +135,8 @@ export default abstract class AsyncModules extends SyncModules {
|
|
|
135
135
|
* Describes a response whose body is not the JSON the API is supposed to send.
|
|
136
136
|
*
|
|
137
137
|
* The platform has been seen answering `200 OK` with `content-type: text/html`
|
|
138
|
-
* and the admin page as the body — every content endpoint at once, for minutes
|
|
139
|
-
*
|
|
138
|
+
* and the admin page as the body — every content endpoint at once, for minutes.
|
|
139
|
+
* A successful status carrying someone else's body is indistinguishable
|
|
140
140
|
* from a real answer by status alone, and the only symptom used to be
|
|
141
141
|
* `SyntaxError: Unexpected token '<'` from the JSON parser: a message about the
|
|
142
142
|
* SDK's own parsing rather than about what the platform did. Callers read that as
|
|
@@ -157,9 +157,9 @@ export default abstract class AsyncModules extends SyncModules {
|
|
|
157
157
|
* With `isShell` on, a failure is returned rather than thrown — and a dropped
|
|
158
158
|
* connection throws a `TypeError`, whose `message` and `stack` are not
|
|
159
159
|
* enumerable. Returned as it was, it serializes to `{}` and reads exactly
|
|
160
|
-
* like an empty answer:
|
|
160
|
+
* like an empty answer: such a value has entered a site's
|
|
161
161
|
* page cache and was served for minutes after the link came back, and
|
|
162
|
-
* `next build` baked a site of 404s while reporting success
|
|
162
|
+
* `next build` baked a site of 404s while reporting success.
|
|
163
163
|
*
|
|
164
164
|
* An object that already carries a `statusCode` is the platform's own error
|
|
165
165
|
* and is passed through untouched. Everything else becomes
|
package/esm/base/asyncModules.js
CHANGED
|
@@ -133,7 +133,7 @@ export default class AsyncModules extends SyncModules {
|
|
|
133
133
|
*
|
|
134
134
|
* With `isShell` disabled browserResponse throws, and the error is thrown on
|
|
135
135
|
* from here too: returning it would break the `@throws` contract every caller
|
|
136
|
-
* documents, and a `try/catch` around the call would never fire
|
|
136
|
+
* documents, and a `try/catch` around the call would never fire.
|
|
137
137
|
* @param {() => Promise<unknown>} request - Thunk performing the fetch call.
|
|
138
138
|
* @returns {Promise<boolean | IError>} `true` on success, IError on failure when isShell=true.
|
|
139
139
|
* @throws {IError} When isShell=false and the request fails.
|
|
@@ -296,7 +296,7 @@ export default class AsyncModules extends SyncModules {
|
|
|
296
296
|
* so both the success and the error branches handle empty bodies the same way.
|
|
297
297
|
*
|
|
298
298
|
* A body that is present but is not JSON — a gateway's HTML page in front of a
|
|
299
|
-
* 502, the platform's own admin page
|
|
299
|
+
* 502, the platform's own admin page — used to collapse into `{}`,
|
|
300
300
|
* which carries no `statusCode` and therefore does not read as an error at all:
|
|
301
301
|
* a failed request came back looking like an empty success. It is described
|
|
302
302
|
* instead, keeping the status the server actually sent.
|
|
@@ -420,8 +420,8 @@ export default class AsyncModules extends SyncModules {
|
|
|
420
420
|
* Describes a response whose body is not the JSON the API is supposed to send.
|
|
421
421
|
*
|
|
422
422
|
* The platform has been seen answering `200 OK` with `content-type: text/html`
|
|
423
|
-
* and the admin page as the body — every content endpoint at once, for minutes
|
|
424
|
-
*
|
|
423
|
+
* and the admin page as the body — every content endpoint at once, for minutes.
|
|
424
|
+
* A successful status carrying someone else's body is indistinguishable
|
|
425
425
|
* from a real answer by status alone, and the only symptom used to be
|
|
426
426
|
* `SyntaxError: Unexpected token '<'` from the JSON parser: a message about the
|
|
427
427
|
* SDK's own parsing rather than about what the platform did. Callers read that as
|
|
@@ -456,9 +456,9 @@ export default class AsyncModules extends SyncModules {
|
|
|
456
456
|
* With `isShell` on, a failure is returned rather than thrown — and a dropped
|
|
457
457
|
* connection throws a `TypeError`, whose `message` and `stack` are not
|
|
458
458
|
* enumerable. Returned as it was, it serializes to `{}` and reads exactly
|
|
459
|
-
* like an empty answer:
|
|
459
|
+
* like an empty answer: such a value has entered a site's
|
|
460
460
|
* page cache and was served for minutes after the link came back, and
|
|
461
|
-
* `next build` baked a site of 404s while reporting success
|
|
461
|
+
* `next build` baked a site of 404s while reporting success.
|
|
462
462
|
*
|
|
463
463
|
* An object that already carries a `statusCode` is the platform's own error
|
|
464
464
|
* and is passed through untouched. Everything else becomes
|
|
@@ -88,7 +88,7 @@ export default abstract class SyncModules {
|
|
|
88
88
|
* calls, a shared default. Normalizing in place sends the already-wrapped
|
|
89
89
|
* value the second time, it is wrapped again, and the platform answers
|
|
90
90
|
* `400 "formData.en_US[0].marker" is required` about a field the caller
|
|
91
|
-
* never sent
|
|
91
|
+
* never sent.
|
|
92
92
|
* @param {any} body - The body to normalize. Left unchanged.
|
|
93
93
|
* @param {string} [langCode] - The language code for normalization.
|
|
94
94
|
* @returns {any} A normalized copy of the body.
|
package/esm/base/syncModules.js
CHANGED
|
@@ -225,7 +225,7 @@ export default class SyncModules {
|
|
|
225
225
|
* calls, a shared default. Normalizing in place sends the already-wrapped
|
|
226
226
|
* value the second time, it is wrapped again, and the platform answers
|
|
227
227
|
* `400 "formData.en_US[0].marker" is required` about a field the caller
|
|
228
|
-
* never sent
|
|
228
|
+
* never sent.
|
|
229
229
|
* @param {any} body - The body to normalize. Left unchanged.
|
|
230
230
|
* @param {string} [langCode] - The language code for normalization.
|
|
231
231
|
* @returns {any} A normalized copy of the body.
|
package/esm/base/utils.d.ts
CHANGED
|
@@ -431,7 +431,7 @@ interface IHttpHeaders {
|
|
|
431
431
|
* @interface IHttpOptions
|
|
432
432
|
* @property {string} method - HTTP method
|
|
433
433
|
* @property {IHttpHeaders} headers - HTTP headers
|
|
434
|
-
* @property {string | FormData | Blob} [body] - Request body
|
|
434
|
+
* @property {string | FormData | Blob} [body] - Request body.
|
|
435
435
|
* @description Interface for HTTP request options
|
|
436
436
|
*/
|
|
437
437
|
interface IHttpOptions {
|
|
@@ -443,8 +443,8 @@ interface IHttpOptions {
|
|
|
443
443
|
* Response of a semantic (vector) search: the module's own list container plus `indexReady`.
|
|
444
444
|
* @typedef {object} IVectorSearchResponse
|
|
445
445
|
* @template T
|
|
446
|
-
* @property {boolean} indexReady - `false` when no vectors are built yet for this entity and language: the query was not embedded,
|
|
447
|
-
* @description Every `…/vector/search` endpoint answers with `indexReady` next to its list
|
|
446
|
+
* @property {boolean} indexReady - `false` when no vectors are built yet for this entity and language: the query was not embedded, so empty `items` do not mean that nothing matched. `true` means the result comes from a real search.
|
|
447
|
+
* @description Every `…/vector/search` endpoint answers with `indexReady` next to its list.
|
|
448
448
|
*/
|
|
449
449
|
type IVectorSearchResponse<T> = T & {
|
|
450
450
|
indexReady: boolean;
|
package/esm/base/validation.d.ts
CHANGED
|
@@ -74,7 +74,7 @@ export declare const UserEntitySchema: z.ZodObject<{
|
|
|
74
74
|
authProviderIdentifier: z.ZodString;
|
|
75
75
|
formData: z.ZodUnion<readonly [z.ZodArray<z.ZodAny>, z.ZodRecord<z.ZodString, z.ZodAny>]>;
|
|
76
76
|
formIdentifier: z.ZodString;
|
|
77
|
-
total: z.ZodString
|
|
77
|
+
total: z.ZodOptional<z.ZodString>;
|
|
78
78
|
groups: z.ZodArray<z.ZodUnion<readonly [z.ZodString, z.ZodNumber]>>;
|
|
79
79
|
state: z.ZodRecord<z.ZodString, z.ZodAny>;
|
|
80
80
|
moduleFormConfigs: z.ZodOptional<z.ZodArray<z.ZodAny>>;
|
package/esm/base/validation.js
CHANGED
|
@@ -137,7 +137,7 @@ export const UserEntitySchema = z.object({
|
|
|
137
137
|
authProviderIdentifier: z.string(),
|
|
138
138
|
formData: z.union([z.array(z.any()), z.record(z.string(), z.any())]),
|
|
139
139
|
formIdentifier: z.string(),
|
|
140
|
-
total: z.string(),
|
|
140
|
+
total: z.string().optional(),
|
|
141
141
|
groups: z.array(z.union([z.string(), z.number()])),
|
|
142
142
|
state: z.record(z.string(), z.any()),
|
|
143
143
|
moduleFormConfigs: z.array(z.any()).optional(),
|
|
@@ -23,8 +23,8 @@ export default class BlocksApi extends AsyncModules implements IBlocks {
|
|
|
23
23
|
* @handleName getBlocks
|
|
24
24
|
* @param {BlockType} [type] - Optional block type to filter by. Available values: "product" | "error_page" | "catalog_page" | "product_preview" | "similar_products_block" | "product_block" | "frequently_ordered_block" | "trending_block" | "recently_viewed_block" | "repeat_purchase_block" | "slider_block" | "personal_recommendations_block" | "cart_complement_block" | "cart_similar_block" | "wishlist_similar_block" | "form" | "common_page" | "common_block" | "order" | "service" | "external_page" | "discount" (see BlockType). When omitted, blocks of all types are returned. Example: 'product'.
|
|
25
25
|
* @param {string} [langCode] - Language code. Default: "en_US".
|
|
26
|
-
* @param {number} [offset] -
|
|
27
|
-
* @param {number} [limit] -
|
|
26
|
+
* @param {number} [offset] - Number of records to skip. Default: 0.
|
|
27
|
+
* @param {number} [limit] - Maximum number of records to return. Default: 30.
|
|
28
28
|
* @returns {Promise<IBlocksResponse | IError>} Returns BlocksEntity object.
|
|
29
29
|
* @throws {IError} When isShell=false and an error occurs during the fetch
|
|
30
30
|
* @see {@link https://js-sdk.oneentry.cloud/docs/blocks/getBlocks getBlocks} documentation.
|
|
@@ -33,10 +33,10 @@ export default class BlocksApi extends AsyncModules implements IBlocks {
|
|
|
33
33
|
/**
|
|
34
34
|
* Get block by marker.
|
|
35
35
|
* @handleName getBlockByMarker
|
|
36
|
-
* @param {string} marker - Marker of
|
|
36
|
+
* @param {string} marker - Marker of the block. Example: "product_block".
|
|
37
37
|
* @param {string} [langCode] - Language code. Default: "en_US".
|
|
38
|
-
* @param {number} [offset] -
|
|
39
|
-
* @param {number} [limit] -
|
|
38
|
+
* @param {number} [offset] - Number of records to skip. Default: 0.
|
|
39
|
+
* @param {number} [limit] - Maximum number of records to return. Default: 30.
|
|
40
40
|
* @returns {Promise<IBlockEntity | IError>} - Returns a BlockEntity object.
|
|
41
41
|
* @throws {IError} When isShell=false and an error occurs during the fetch
|
|
42
42
|
* @description This method retrieves a block by its marker and includes additional information such as similar products or products associated with the block.
|
|
@@ -64,9 +64,9 @@ export default class BlocksApi extends AsyncModules implements IBlocks {
|
|
|
64
64
|
* @handleName getSimilarProducts
|
|
65
65
|
* @param {string} marker - Block identifier. Example: "similar_products_block".
|
|
66
66
|
* @param {string} [langCode] - Language code. Default: "en_US".
|
|
67
|
-
* @param {number} [offset] -
|
|
68
|
-
* @param {number} [limit] -
|
|
69
|
-
* @param {string} [signPrice] -
|
|
67
|
+
* @param {number} [offset] - Number of records to skip. Default: 0.
|
|
68
|
+
* @param {number} [limit] - Maximum number of records to return. Default: 30.
|
|
69
|
+
* @param {string} [signPrice] - Marker of the order storage to fix prices for. When set, each product comes with a `signedPrice` that holds the price for a limited time.
|
|
70
70
|
* @see {@link https://js-sdk.oneentry.cloud/docs/blocks/#Fixing-the-price-signPrice Fixing the price} documentation.
|
|
71
71
|
* @param {number} [productId] - Optional product id to find similar products for.
|
|
72
72
|
* @returns {Promise<IProductsResponse | IError>} Returns the total count and an array of product items in object by specified block marker.
|
|
@@ -79,9 +79,9 @@ export default class BlocksApi extends AsyncModules implements IBlocks {
|
|
|
79
79
|
* @handleName getProductsByBlockMarker
|
|
80
80
|
* @param {string} marker - Block identifier. Example: "product_block".
|
|
81
81
|
* @param {string} [langCode] - Language code. Default: "en_US".
|
|
82
|
-
* @param {number} [offset] -
|
|
83
|
-
* @param {number} [limit] -
|
|
84
|
-
* @param {string} [signPrice] -
|
|
82
|
+
* @param {number} [offset] - Number of records to skip. Default: 0.
|
|
83
|
+
* @param {number} [limit] - Maximum number of records to return. Default: 30.
|
|
84
|
+
* @param {string} [signPrice] - Marker of the order storage to fix prices for. When set, each product comes with a `signedPrice` that holds the price for a limited time.
|
|
85
85
|
* @see {@link https://js-sdk.oneentry.cloud/docs/blocks/#Fixing-the-price-signPrice Fixing the price} documentation.
|
|
86
86
|
* @returns {Promise<IProductsEntity[] | IError>} Return array of BlocksEntity object.
|
|
87
87
|
* @throws {IError} When isShell=false and an error occurs during the fetch
|
|
@@ -91,10 +91,10 @@ export default class BlocksApi extends AsyncModules implements IBlocks {
|
|
|
91
91
|
/**
|
|
92
92
|
* Get frequently ordered products by block marker and product id.
|
|
93
93
|
* @handleName getFrequentlyOrderedProducts
|
|
94
|
-
* @param {number} productId - Product
|
|
95
|
-
* @param {string} marker -
|
|
94
|
+
* @param {number} productId - Product ID. Example: 1.
|
|
95
|
+
* @param {string} marker - Marker of the block. Example: "frequently_ordered_block".
|
|
96
96
|
* @param {string} [langCode] - Language code. Default: "en_US".
|
|
97
|
-
* @param {string} [signPrice] -
|
|
97
|
+
* @param {string} [signPrice] - Marker of the order storage to fix prices for. When set, each product comes with a `signedPrice` that holds the price for a limited time.
|
|
98
98
|
* @see {@link https://js-sdk.oneentry.cloud/docs/blocks/#Fixing-the-price-signPrice Fixing the price} documentation.
|
|
99
99
|
* @param {number} [limit] - Maximum number of products to return. When omitted, the block's own quantity setting applies. Example: 10.
|
|
100
100
|
* @returns {Promise<IProductsResponse | IError>} Returns a products response with items and total.
|
|
@@ -115,9 +115,9 @@ export default class BlocksApi extends AsyncModules implements IBlocks {
|
|
|
115
115
|
/**
|
|
116
116
|
* Get "complete your cart" products by the cart from context (auth user or guest).
|
|
117
117
|
* @handleName getCartComplement
|
|
118
|
-
* @param {string} marker -
|
|
118
|
+
* @param {string} marker - Marker of the block. Example: "cart_complement_block".
|
|
119
119
|
* @param {string} [langCode] - Language code. Default: "en_US".
|
|
120
|
-
* @param {string} [signPrice] -
|
|
120
|
+
* @param {string} [signPrice] - Marker of the order storage to fix prices for. When set, each product comes with a `signedPrice` that holds the price for a limited time.
|
|
121
121
|
* @see {@link https://js-sdk.oneentry.cloud/docs/blocks/#Fixing-the-price-signPrice Fixing the price} documentation.
|
|
122
122
|
* @param {number} [limit] - Maximum number of products to return. When omitted, the block's own quantity setting applies. Example: 10.
|
|
123
123
|
* @returns {Promise<IProductsResponse | IError>} Returns an object with an array of products, total count and totalFound.
|
|
@@ -128,8 +128,8 @@ export default class BlocksApi extends AsyncModules implements IBlocks {
|
|
|
128
128
|
/**
|
|
129
129
|
* Get "complete your cart" products by an explicit list of productIds (POST body).
|
|
130
130
|
* @handleName getCartComplementByProductIds
|
|
131
|
-
* @param {string} marker -
|
|
132
|
-
* @param {IBlockProductsLookup} body - Lookup
|
|
131
|
+
* @param {string} marker - Marker of the block. Example: "cart_complement_block".
|
|
132
|
+
* @param {IBlockProductsLookup} body - Lookup parameters.
|
|
133
133
|
* @example
|
|
134
134
|
{
|
|
135
135
|
"productIds": [1, 2],
|
|
@@ -143,9 +143,9 @@ export default class BlocksApi extends AsyncModules implements IBlocks {
|
|
|
143
143
|
/**
|
|
144
144
|
* Get "similar to cart" products by the cart from context (auth user or guest).
|
|
145
145
|
* @handleName getCartSimilar
|
|
146
|
-
* @param {string} marker -
|
|
146
|
+
* @param {string} marker - Marker of the block. Example: "cart_similar_block".
|
|
147
147
|
* @param {string} [langCode] - Language code. Default: "en_US".
|
|
148
|
-
* @param {string} [signPrice] -
|
|
148
|
+
* @param {string} [signPrice] - Marker of the order storage to fix prices for. When set, each product comes with a `signedPrice` that holds the price for a limited time.
|
|
149
149
|
* @see {@link https://js-sdk.oneentry.cloud/docs/blocks/#Fixing-the-price-signPrice Fixing the price} documentation.
|
|
150
150
|
* @param {number} [limit] - Maximum number of products to return. When omitted, the block's own quantity setting applies. Example: 10.
|
|
151
151
|
* @returns {Promise<IProductsResponse | IError>} Returns an object with an array of products, total count and totalFound.
|
|
@@ -156,8 +156,8 @@ export default class BlocksApi extends AsyncModules implements IBlocks {
|
|
|
156
156
|
/**
|
|
157
157
|
* Get "similar to cart" products by an explicit list of productIds (POST body).
|
|
158
158
|
* @handleName getCartSimilarByProductIds
|
|
159
|
-
* @param {string} marker -
|
|
160
|
-
* @param {IBlockProductsLookup} body - Lookup
|
|
159
|
+
* @param {string} marker - Marker of the block. Example: "cart_similar_block".
|
|
160
|
+
* @param {IBlockProductsLookup} body - Lookup parameters.
|
|
161
161
|
* @example
|
|
162
162
|
{
|
|
163
163
|
"productIds": [1, 2],
|
|
@@ -171,9 +171,9 @@ export default class BlocksApi extends AsyncModules implements IBlocks {
|
|
|
171
171
|
/**
|
|
172
172
|
* Get personal recommendations for the user.
|
|
173
173
|
* @handleName getPersonalRecommendations
|
|
174
|
-
* @param {string} marker -
|
|
174
|
+
* @param {string} marker - Marker of the block. Example: "personal_recommendations_block".
|
|
175
175
|
* @param {string} [langCode] - Language code. Default: "en_US".
|
|
176
|
-
* @param {string} [signPrice] -
|
|
176
|
+
* @param {string} [signPrice] - Marker of the order storage to fix prices for. When set, each product comes with a `signedPrice` that holds the price for a limited time.
|
|
177
177
|
* @see {@link https://js-sdk.oneentry.cloud/docs/blocks/#Fixing-the-price-signPrice Fixing the price} documentation.
|
|
178
178
|
* @param {number} [limit] - Maximum number of products to return. When omitted, the block's own quantity setting applies. Example: 10.
|
|
179
179
|
* @returns {Promise<IProductsResponse | IError>} Returns an object with an array of products, total count and totalFound.
|
|
@@ -184,9 +184,9 @@ export default class BlocksApi extends AsyncModules implements IBlocks {
|
|
|
184
184
|
/**
|
|
185
185
|
* Get recently viewed products.
|
|
186
186
|
* @handleName getRecentlyViewed
|
|
187
|
-
* @param {string} marker -
|
|
187
|
+
* @param {string} marker - Marker of the block. Example: "recently_viewed_block".
|
|
188
188
|
* @param {string} [langCode] - Language code. Default: "en_US".
|
|
189
|
-
* @param {string} [signPrice] -
|
|
189
|
+
* @param {string} [signPrice] - Marker of the order storage to fix prices for. When set, each product comes with a `signedPrice` that holds the price for a limited time.
|
|
190
190
|
* @see {@link https://js-sdk.oneentry.cloud/docs/blocks/#Fixing-the-price-signPrice Fixing the price} documentation.
|
|
191
191
|
* @param {number} [limit] - Maximum number of products to return. When omitted, the block's own quantity setting applies. Example: 10.
|
|
192
192
|
* @returns {Promise<IProductsResponse | IError>} Returns an object with an array of products, total count and totalFound.
|
|
@@ -197,9 +197,9 @@ export default class BlocksApi extends AsyncModules implements IBlocks {
|
|
|
197
197
|
/**
|
|
198
198
|
* Get products for repeat purchase.
|
|
199
199
|
* @handleName getRepeatPurchase
|
|
200
|
-
* @param {string} marker -
|
|
200
|
+
* @param {string} marker - Marker of the block. Example: "repeat_purchase_block".
|
|
201
201
|
* @param {string} [langCode] - Language code. Default: "en_US".
|
|
202
|
-
* @param {string} [signPrice] -
|
|
202
|
+
* @param {string} [signPrice] - Marker of the order storage to fix prices for. When set, each product comes with a `signedPrice` that holds the price for a limited time.
|
|
203
203
|
* @see {@link https://js-sdk.oneentry.cloud/docs/blocks/#Fixing-the-price-signPrice Fixing the price} documentation.
|
|
204
204
|
* @param {number} [limit] - Maximum number of products to return. When omitted, the block's own quantity setting applies. Example: 10.
|
|
205
205
|
* @returns {Promise<IProductsResponse | IError>} Returns an object with an array of products, total count and totalFound.
|
|
@@ -210,7 +210,7 @@ export default class BlocksApi extends AsyncModules implements IBlocks {
|
|
|
210
210
|
/**
|
|
211
211
|
* Get the block's slides tree as a flat pre-order array (slider_block only).
|
|
212
212
|
* @handleName getSlides
|
|
213
|
-
* @param {string} marker -
|
|
213
|
+
* @param {string} marker - Marker of the block. Example: "slider_block".
|
|
214
214
|
* @returns {Promise<IBlockSlidesResponse | IError>} Returns the slides response.
|
|
215
215
|
* @throws {IError} When isShell=false and an error occurs during the fetch
|
|
216
216
|
* @see {@link https://js-sdk.oneentry.cloud/docs/blocks/getSlides getSlides} documentation.
|
|
@@ -219,9 +219,9 @@ export default class BlocksApi extends AsyncModules implements IBlocks {
|
|
|
219
219
|
/**
|
|
220
220
|
* Get trending products of the block.
|
|
221
221
|
* @handleName getTrending
|
|
222
|
-
* @param {string} marker -
|
|
222
|
+
* @param {string} marker - Marker of the block. Example: "trending_block".
|
|
223
223
|
* @param {string} [langCode] - Language code. Default: "en_US".
|
|
224
|
-
* @param {string} [signPrice] -
|
|
224
|
+
* @param {string} [signPrice] - Marker of the order storage to fix prices for. When set, each product comes with a `signedPrice` that holds the price for a limited time.
|
|
225
225
|
* @see {@link https://js-sdk.oneentry.cloud/docs/blocks/#Fixing-the-price-signPrice Fixing the price} documentation.
|
|
226
226
|
* @param {number} [limit] - Maximum number of products to return. When omitted, the block's own quantity setting applies. Example: 10.
|
|
227
227
|
* @returns {Promise<IProductsResponse | IError>} Returns an object with an array of products, total count and totalFound.
|
|
@@ -232,9 +232,9 @@ export default class BlocksApi extends AsyncModules implements IBlocks {
|
|
|
232
232
|
/**
|
|
233
233
|
* Get "similar to wishlist" products by the wishlist from context (auth user or guest).
|
|
234
234
|
* @handleName getWishlistSimilar
|
|
235
|
-
* @param {string} marker -
|
|
235
|
+
* @param {string} marker - Marker of the block. Example: "wishlist_similar_block".
|
|
236
236
|
* @param {string} [langCode] - Language code. Default: "en_US".
|
|
237
|
-
* @param {string} [signPrice] -
|
|
237
|
+
* @param {string} [signPrice] - Marker of the order storage to fix prices for. When set, each product comes with a `signedPrice` that holds the price for a limited time.
|
|
238
238
|
* @see {@link https://js-sdk.oneentry.cloud/docs/blocks/#Fixing-the-price-signPrice Fixing the price} documentation.
|
|
239
239
|
* @param {number} [limit] - Maximum number of products to return. When omitted, the block's own quantity setting applies. Example: 10.
|
|
240
240
|
* @returns {Promise<IProductsResponse | IError>} Returns an object with an array of products, total count and totalFound.
|
|
@@ -245,8 +245,8 @@ export default class BlocksApi extends AsyncModules implements IBlocks {
|
|
|
245
245
|
/**
|
|
246
246
|
* Get "similar to wishlist" products by an explicit list of productIds (POST body).
|
|
247
247
|
* @handleName getWishlistSimilarByProductIds
|
|
248
|
-
* @param {string} marker -
|
|
249
|
-
* @param {IBlockProductsLookup} body - Lookup
|
|
248
|
+
* @param {string} marker - Marker of the block. Example: "wishlist_similar_block".
|
|
249
|
+
* @param {IBlockProductsLookup} body - Lookup parameters.
|
|
250
250
|
* @example
|
|
251
251
|
{
|
|
252
252
|
"productIds": [1, 2],
|