oneentry 1.0.102 → 1.0.104

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.
Files changed (82) hide show
  1. package/README.md +798 -426
  2. package/configure.js +24 -33
  3. package/dist/admins/adminsApi.d.ts +11 -7
  4. package/dist/admins/adminsApi.js +17 -5
  5. package/dist/admins/adminsInterfaces.d.ts +33 -19
  6. package/dist/attribute-sets/attributeSetsApi.d.ts +35 -10
  7. package/dist/attribute-sets/attributeSetsApi.js +49 -7
  8. package/dist/attribute-sets/attributeSetsInterfaces.d.ts +42 -11
  9. package/dist/auth-provider/authProviderApi.d.ts +17 -5
  10. package/dist/auth-provider/authProviderApi.js +31 -14
  11. package/dist/auth-provider/authProvidersInterfaces.d.ts +23 -2
  12. package/dist/base/asyncModules.d.ts +2 -2
  13. package/dist/base/asyncModules.js +26 -17
  14. package/dist/base/result.js +26 -12
  15. package/dist/base/stateModule.d.ts +1 -1
  16. package/dist/base/stateModule.js +20 -11
  17. package/dist/base/syncModules.d.ts +4 -4
  18. package/dist/base/syncModules.js +16 -12
  19. package/dist/base/utils.d.ts +2 -2
  20. package/dist/blocks/blocksApi.d.ts +8 -5
  21. package/dist/blocks/blocksApi.js +30 -8
  22. package/dist/blocks/blocksInterfaces.d.ts +38 -5
  23. package/dist/events/eventsApi.d.ts +7 -7
  24. package/dist/events/eventsApi.js +14 -9
  25. package/dist/events/eventsInterfaces.d.ts +5 -2
  26. package/dist/{file-uploding → file-uploading}/fileUploadingApi.d.ts +3 -3
  27. package/dist/{file-uploding → file-uploading}/fileUploadingApi.js +9 -5
  28. package/dist/{file-uploding → file-uploading}/fileUploadingInterfaces.d.ts +8 -5
  29. package/dist/forms/formsApi.d.ts +4 -4
  30. package/dist/forms/formsApi.js +4 -1
  31. package/dist/forms/formsInterfaces.d.ts +2 -3
  32. package/dist/formsData/formsDataApi.d.ts +5 -5
  33. package/dist/formsData/formsDataApi.js +10 -4
  34. package/dist/formsData/formsDataInterfaces.d.ts +2 -2
  35. package/dist/general-types/{typesApi.d.ts → generalTypesApi.d.ts} +4 -4
  36. package/dist/general-types/{typesApi.js → generalTypesApi.js} +4 -1
  37. package/dist/general-types/generalTypesInterfaces.d.ts +2 -2
  38. package/dist/index.d.ts +33 -21
  39. package/dist/index.js +37 -26
  40. package/dist/integration-collections/integrationCollectionsApi.d.ts +128 -0
  41. package/dist/integration-collections/integrationCollectionsApi.js +161 -0
  42. package/dist/integration-collections/integrationCollectionsInterfaces.d.ts +57 -0
  43. package/dist/integration-collections/integrationCollectionsInterfaces.js +2 -0
  44. package/dist/locales/localesApi.d.ts +4 -4
  45. package/dist/locales/localesApi.js +4 -1
  46. package/dist/locales/localesInterfaces.d.ts +2 -2
  47. package/dist/menus/menusApi.d.ts +4 -4
  48. package/dist/menus/menusApi.js +4 -1
  49. package/dist/menus/menusInterfaces.d.ts +6 -4
  50. package/dist/menus/menusInterfaces.js +1 -0
  51. package/dist/orders/ordersApi.d.ts +8 -8
  52. package/dist/orders/ordersApi.js +15 -7
  53. package/dist/orders/ordersInterfaces.d.ts +13 -3
  54. package/dist/pages/pagesApi.d.ts +4 -10
  55. package/dist/pages/pagesApi.js +14 -10
  56. package/dist/pages/pagesInterfaces.d.ts +13 -22
  57. package/dist/payments/paymentsApi.d.ts +6 -6
  58. package/dist/payments/paymentsApi.js +14 -6
  59. package/dist/payments/paymentsInterfaces.d.ts +20 -5
  60. package/dist/product-statuses/productStatusesApi.d.ts +3 -3
  61. package/dist/product-statuses/productStatusesApi.js +4 -1
  62. package/dist/product-statuses/productStatusesInterfaces.d.ts +2 -5
  63. package/dist/products/productsApi.d.ts +38 -54
  64. package/dist/products/productsApi.js +63 -61
  65. package/dist/products/productsInterfaces.d.ts +50 -38
  66. package/dist/system/systemApi.d.ts +3 -3
  67. package/dist/system/systemApi.js +5 -1
  68. package/dist/system/systemInterfaces.d.ts +1 -1
  69. package/dist/templates/templatesApi.d.ts +6 -3
  70. package/dist/templates/templatesApi.js +10 -2
  71. package/dist/templates/templatesInterfaces.d.ts +2 -2
  72. package/dist/templates-preview/templatesPreviewApi.d.ts +5 -4
  73. package/dist/templates-preview/templatesPreviewApi.js +5 -1
  74. package/dist/templates-preview/templatesPreviewInterfaces.d.ts +21 -10
  75. package/dist/users/usersApi.d.ts +15 -4
  76. package/dist/users/usersApi.js +29 -2
  77. package/dist/users/usersInterfaces.d.ts +10 -4
  78. package/dist/web-socket/wsApi.d.ts +4 -4
  79. package/dist/web-socket/wsApi.js +15 -14
  80. package/dist/web-socket/wsInterfaces.d.ts +2 -2
  81. package/package.json +45 -9
  82. /package/dist/{file-uploding → file-uploading}/fileUploadingInterfaces.js +0 -0
package/README.md CHANGED
@@ -10,7 +10,7 @@ Visit the official AsyncModules website at [https://oneentry.cloud](https://onee
10
10
 
11
11
  To get started with AsyncModules, sign up for an account at [https://account.oneentry.cloud/authentication/register](https://account.oneentry.cloud/authentication/register).
12
12
 
13
- # Installation
13
+ ## Installation
14
14
 
15
15
  To install the AsyncModules Headless CMS SDK in your project, run the following command:
16
16
 
@@ -21,30 +21,32 @@ npm install oneentry
21
21
  ## Get Started
22
22
 
23
23
  To use the AsyncModules Headless CMS SDK in your project, import the defineOneEntry function:
24
+
24
25
  ```js
25
26
  import { defineOneEntry } from 'oneentry'
26
27
 
27
28
  const {
28
- Admins,
29
- AttributesSets,
30
- AuthProvider,
31
- Blocks,
32
- Events,
33
- Forms,
34
- FormData,
35
- FileUploading,
36
- GeneralTypes,
37
- Locales,
38
- Menus,
39
- Orders,
40
- Pages,
41
- Products,
42
- ProductStatuses,
43
- System,
44
- Templates,
45
- TemplatePreviews,
46
- Users,
47
- WS
29
+ Admins,
30
+ AttributesSets,
31
+ AuthProvider,
32
+ Blocks,
33
+ Events,
34
+ Forms,
35
+ FormData,
36
+ FileUploading,
37
+ GeneralTypes,
38
+ IntegrationCollections,
39
+ Locales,
40
+ Menus,
41
+ Orders,
42
+ Pages,
43
+ Products,
44
+ ProductStatuses,
45
+ System,
46
+ Templates,
47
+ TemplatePreviews,
48
+ Users,
49
+ WS
48
50
  } = defineOneEntry('your-url');
49
51
  ```
50
52
 
@@ -53,9 +55,11 @@ Or
53
55
  ```js
54
56
  const api = defineOneEntry('your-url');
55
57
  ```
58
+
56
59
  ---
57
60
 
58
61
  ### Config
62
+
59
63
  The second parameter of the constructor takes the 'config'. It contains the following values:
60
64
 
61
65
  - 'token' - Set the token key if your project secure "Security API Token". If you are using certificate protection, do not pass this variable. You can read more about the security of your project [here](https://oneentry.cloud/instructions).
@@ -75,36 +79,39 @@ The 'auth' contains the following settings:
75
79
  - 'customAuth' - If you want to configure authorization and work with tokens yourself, set this flag to true. If you want to use the sdk settings, set it to false or do not transfer it at all.
76
80
 
77
81
  An example of a configuration with token protection and automatic authentication that stores state between sessions
82
+
78
83
  ```js
79
84
  const tokenFunction = (token) => {
80
- localStorage.setItem('refreshToken', token)
85
+ localStorage.setItem('refreshToken', token)
81
86
  }
82
87
 
83
88
  const api = defineOneEntry('https://my-project.oneentry.cloud', {
84
- token:'my-token',
85
- langCode:'en_US',
86
- auth: {
87
- refreshToken: localStorage.getItem('refreshToken'),
88
- saveFunction: tokenFunction
89
- }
89
+ token:'my-token',
90
+ langCode:'en_US',
91
+ auth: {
92
+ refreshToken: localStorage.getItem('refreshToken'),
93
+ saveFunction: tokenFunction
94
+ }
90
95
  })
91
96
  ```
92
97
 
93
98
  An example of a configuration that is protected with a certificate allows you to configure the authorization system yourself and saves data on requests.
99
+
94
100
  ```js
95
101
  const api = defineOneEntry('https://my-project.oneentry.cloud', {
96
- langCode:'en_US',
97
- traficLimit: true,
98
- auth: {
99
- customAuth: true,
100
- refreshToken: localStorage.getItem('refreshToken')
101
- }
102
+ langCode:'en_US',
103
+ traficLimit: true,
104
+ auth: {
105
+ customAuth: true,
106
+ refreshToken: localStorage.getItem('refreshToken')
107
+ }
102
108
  })
103
109
  ```
104
110
 
105
111
  If you have chosen to configure tokens yourself, you can pass the token to the method as follows.
106
112
  The intermediate method allows you to pass an access token to the request. Then call the required method.
107
113
  This method (setAccessToken) should not be called if the method does not require user authorization.
114
+
108
115
  ```js
109
116
  const user = api.Users.setAccessToken('my.access.token').getUser()
110
117
  ```
@@ -112,6 +119,7 @@ const user = api.Users.setAccessToken('my.access.token').getUser()
112
119
  >If you chose token protection to ensure connection security, just pass your token to the function as an optional parameter.
113
120
 
114
121
  You can get a token as follows
122
+
115
123
  1) Log in to your personal account
116
124
  2) Go to the "Projects" tab and select a project
117
125
  3) Go to the "Access" tab
@@ -122,8 +130,7 @@ You can get a token as follows
122
130
  You can also connect a tls certificate to protect your project. In this case, do not pass the "token" at all. When using the certificate, set up a proxy in your project. Pass an empty string as an url parameter.
123
131
  [Learn more about security](https://oneentry.cloud/instructions)
124
132
 
125
-
126
- ```js
133
+ ```js
127
134
  const saveTokenFromLocalStorage = (token) => {
128
135
  localStorage.setItem('refreshToken', token)
129
136
  }
@@ -151,7 +158,7 @@ In this case, you need to handle the error using "try {} catch(e) {}".
151
158
  Also, you can pass custom functions that will be called inside the sdk with the appropriate error code.
152
159
  These functions receive an error object as an argument. You can process it yourself.
153
160
 
154
- ```js
161
+ ```js
155
162
  const api = defineOneEntry('your-url', {
156
163
  token: 'my-token',
157
164
  langCode:'my-langCode',
@@ -166,8 +173,8 @@ const api = defineOneEntry('your-url', {
166
173
  })
167
174
  ```
168
175
 
169
-
170
176
  Now you can use the following links to jump to specific entries:
177
+
171
178
  - [Admins](#admins)
172
179
  - [AttributesSets](#attributessets)
173
180
  - [AuthProvider](#authprovider)
@@ -177,6 +184,7 @@ Now you can use the following links to jump to specific entries:
177
184
  - [FormData](#formdata)
178
185
  - [FileUploading](#fileuploading)
179
186
  - [GeneralTypes](#generaltypes)
187
+ - [IntegrationCollections](#integrationcollections)
180
188
  - [Locales](#locales)
181
189
  - [Menus](#menus)
182
190
  - [Orders](#orders)
@@ -190,24 +198,57 @@ Now you can use the following links to jump to specific entries:
190
198
  - [Users](#users)
191
199
  - [WS](#ws)
192
200
 
193
-
194
201
  ## <h2 id="admins"> Admins </h2>
195
202
 
196
-
197
203
  ```js
198
204
  const { Admins } = defineOneEntry('your-url');
199
205
  ```
200
206
 
201
- ### Admins.getAdminsInfo(langCode, offset, limit)
207
+ > Method accept the body as a parameter for filtering. If you don't want to set up sorting, pass an empty array or don't pass anything.
202
208
 
209
+ Parameters:
203
210
 
204
211
  ```js
205
- const value = await Admins.getAdminsInfo('en_US', 0, 30)
212
+ const body = [
213
+ {
214
+ "attributeMarker": "num",
215
+ "conditionMarker": "mth",
216
+ "conditionValue": 1
217
+ },
218
+ {
219
+ "attributeMarker": "num",
220
+ "conditionMarker": "lth",
221
+ "conditionValue": 3
222
+ }
223
+ ]
206
224
  ```
207
225
 
226
+ ><details>
227
+ ><summary>Schema: {body}</summary>
228
+ >
229
+ >**attributeMarker:** string <br>
230
+ >*text identifier attribute* <br>
231
+ >example: price <br>
232
+ >
233
+ >**conditionMarker:** string <br>
234
+ >*text identifier condition, possible values: 'in' - contains, 'nin' - does not contain, 'eq' - equal, 'neq' - not equal, 'mth' - more than, 'lth' - less than, 'exs' - exists, 'nexs' - does not exist, 'pat' - pattern, for example **-**, where '*' any character, 'same' - same value as the selected attribute* <br>
235
+ >example: in <br>
236
+ >Enum: <br>
237
+ >[ in, nin, eq, neq, mth, lth, exs, nexs, pat, same ] <br>
238
+ >
239
+ >**conditionValue:** number <br>
240
+ >*condition value* <br>
241
+ >example: 1 <br>
242
+ >
243
+ ></details>
208
244
 
209
- > This method retrieves all user objects of type admin from the API. It returns a Promise that resolves to an array of AdminEntity objects.
245
+ ### Admins.getAdminsInfo(body, langCode, offset, limit)
210
246
 
247
+ ```js
248
+ const value = await Admins.getAdminsInfo([], 'en_US', 30, 0 )
249
+ ```
250
+
251
+ > This method retrieves user objects of type admin from the API. It returns a Promise that resolves to an array of AdminEntity objects.
211
252
 
212
253
  Example return:
213
254
 
@@ -229,24 +270,23 @@ Example return:
229
270
  ]
230
271
  ```
231
272
 
232
-
233
273
  ><details>
234
- ><summary >Schema</summary>
274
+ ><summary>Schema</summary>
235
275
  >
236
- >**id:** number <br>
276
+ >**id:** number <br>
237
277
  >*object identifier*<br>
238
278
  >example: 1764 <br>
239
279
  >
240
- >**identifier:** string <br>
280
+ >**identifier:** string <br>
241
281
  >*textual identifier for the record field* <br>
242
282
  >example: admin1 <br>
243
283
  >default: admin1 <br>
244
284
  >
245
- >**attributeSetId:** number <br>
285
+ >**attributeSetId:** number <br>
246
286
  >*Attribute set identifier* <br>
247
287
  >example: 7<br>
248
288
  >
249
- >**isSync** boolean <br>
289
+ >**isSync** boolean <br>
250
290
  >*Page indexing flag (true or false)* <br>
251
291
  >example: false <br>
252
292
  >
@@ -260,12 +300,8 @@ Example return:
260
300
  >
261
301
  ></details>
262
302
 
263
-
264
-
265
303
  ---
266
304
 
267
-
268
-
269
305
  ## <h2 id="attributessets"> AttributesSets </h2>
270
306
 
271
307
  ```js
@@ -280,10 +316,8 @@ const value = await AttributesSets.getAttributesByMarker('my-marker', 'en_US')
280
316
 
281
317
  > This method return all attributes with data from the attribute sets.
282
318
 
283
-
284
319
  Example return:
285
320
 
286
-
287
321
  ```json
288
322
  [
289
323
  {
@@ -325,7 +359,6 @@ Example return:
325
359
  ]
326
360
  ```
327
361
 
328
-
329
362
  ><details>
330
363
  ><summary>Schema</summary>
331
364
  >
@@ -333,7 +366,7 @@ Example return:
333
366
  >*attribute type* <br>
334
367
  >example: list <br>
335
368
  >
336
- >**marker:** string <br>
369
+ >**marker:** string <br>
337
370
  >*textual identifier of the attribute (marker)* <br>
338
371
  >Enum:
339
372
  >[ string, text, textWithHeader, integer, real, float, dateTime, date, time, file, image, groupOfImages, radioButton, list, button ] <br>
@@ -343,21 +376,20 @@ Example return:
343
376
  >*position number for sorting* <br>
344
377
  >example: 192 <br>
345
378
  >
346
- >**validators:** Record<string, any> <br>
379
+ >**validators:** Record<string, any> <br>
347
380
  >*set of validators for validation* <br>
348
381
  >example: OrderedMap { "requiredValidator": OrderedMap { "strict": true }, "defaultValueValidator": OrderedMap { "fieldDefaultValue": 11 } } <br>
349
382
  >
350
- >**localizeInfos:** Record<string, any> <br>
383
+ >**localizeInfos:** Record<string, any> <br>
351
384
  >*localization data for the set (name)* <br>
352
385
  >example: OrderedMap { "title": "My attribute" } <br>
353
386
  >
354
- >**listTitles** Record<string, any> <br>
387
+ >**listTitles** Record<string, any> <br>
355
388
  >*array of values (with extended data) for list and radioButton attributes* <br>
356
389
  >example: List [ OrderedMap { "title": "red", "value": 1, "position": 1, "extendedValue": null, "extendedValueType": null }, OrderedMap { "title": "yellow", "value": 2, "position": 2, "extendedValue": null, "extendedValueType": null } ] <br>
357
390
  >
358
391
  ></details>
359
392
 
360
-
361
393
  ### AttributesSets.getSingleAttributeByMarkerSet(attributeMarker, setMarker, langCode)
362
394
 
363
395
  ```js
@@ -366,7 +398,6 @@ const value = await AttributesSets.getSingleAttributeByMarkerSet('list1', 'list1
366
398
 
367
399
  > This method return a single attribute with data from the attribute sets.
368
400
 
369
-
370
401
  Example return:
371
402
 
372
403
  ```json
@@ -415,7 +446,7 @@ Example return:
415
446
  >*attribute type* <br>
416
447
  >example: list <br>
417
448
  >
418
- >**marker:** string <br>
449
+ >**marker:** string <br>
419
450
  >*textual identifier of the attribute (marker)* <br>
420
451
  >example: list1 <br>
421
452
  >
@@ -423,15 +454,15 @@ Example return:
423
454
  >*position number for sorting* <br>
424
455
  >example: 192 <br>
425
456
  >
426
- >**validators:** Record<string, any> <br>
457
+ >**validators:** Record<string, any> <br>
427
458
  >*set of validators for validation* <br>
428
459
  >example: OrderedMap { "requiredValidator": OrderedMap { "strict": true }, "defaultValueValidator": OrderedMap { "fieldDefaultValue": 11 } } <br>
429
460
  >
430
- >**localizeInfos:** Record<string, any> <br>
461
+ >**localizeInfos:** Record<string, any> <br>
431
462
  >*localization data for the set (name)* <br>
432
463
  >example: OrderedMap { "title": "My attribute" } <br>
433
464
  >
434
- >**listTitles** Record<string, any> <br>
465
+ >**listTitles** Record<string, any> <br>
435
466
  >*array of values (with extended data) for list and radioButton attributes* <br>
436
467
  >example: List [ OrderedMap { "title": "red", "value": 1, "position": 1, "extendedValue": null, "extendedValueType": null }, OrderedMap { "title": "yellow", "value": 2, "position": 2, "extendedValue": null, "extendedValueType": null } ] <br>
437
468
  >
@@ -439,7 +470,6 @@ Example return:
439
470
 
440
471
  ---
441
472
 
442
-
443
473
  ## <h2 id="authprovider"> User Auth Provider </h2>
444
474
 
445
475
  ```js
@@ -448,33 +478,32 @@ const { AuthProvider } = defineOneEntry('your-url');
448
478
 
449
479
  ### AuthProvider.signUp(marker, data, langCode)
450
480
 
451
-
452
481
  ```js
453
482
 
454
483
  const data = {
455
- "formIdentifier": "reg",
456
- "authData": [
457
- {
458
- "marker": "login",
459
- "value": "test"
460
- },
461
- {
462
- "marker": "password",
463
- "value": "12345"
464
- }
465
- ],
466
- "formData": [
467
- {
468
- "marker": "last_name",
469
- "type": "string",
470
- "value": "Username"
471
- }
472
- ],
473
- "notificationData": {
474
- "email": "test@test.com",
475
- "phonePush": [],
476
- "phoneSMS": "+99999999999"
484
+ "formIdentifier": "reg",
485
+ "authData": [
486
+ {
487
+ "marker": "login",
488
+ "value": "test"
489
+ },
490
+ {
491
+ "marker": "password",
492
+ "value": "12345"
477
493
  }
494
+ ],
495
+ "formData": [
496
+ {
497
+ "marker": "last_name",
498
+ "type": "string",
499
+ "value": "Username"
500
+ }
501
+ ],
502
+ "notificationData": {
503
+ "email": "test@test.com",
504
+ "phonePush": [],
505
+ "phoneSMS": "+99999999999"
506
+ }
478
507
  }
479
508
 
480
509
  const value = await AuthProvider.signUp('email', data)
@@ -483,7 +512,7 @@ const value = await AuthProvider.signUp('email', data)
483
512
  ><details>
484
513
  ><summary>Schema</summary>
485
514
  >
486
- >**formIdentifier:** string <br>
515
+ >**formIdentifier:** string <br>
487
516
  >*textual identifier of the authorization provider's form*
488
517
  >example: reg_form <br>
489
518
  >
@@ -496,7 +525,6 @@ const value = await AuthProvider.signUp('email', data)
496
525
  >
497
526
  >**notificationData:**<br>
498
527
  >*user notification data* <br>
499
-
500
528
  >
501
529
  >**attributeSetId:** number <br>
502
530
  >*identifier for the used attribute set* <br>
@@ -506,11 +534,11 @@ const value = await AuthProvider.signUp('email', data)
506
534
  >*Data submitted by the form* <br>
507
535
  >example: OrderedMap { "en_US": List [ OrderedMap { "marker": "naimenovanie_1", "value": "Name" } ] } <br>
508
536
  >
509
- >**notificationData:** UserNotificationDataType <br>
537
+ >**notificationData:** UserNotificationDataType <br>
510
538
  >*data for notifying the user* <br>
511
539
  >example: OrderedMap { "email": "test@test.zone", "phonePush": "", "phoneSMS": "+79991234567" } <br>
512
540
  >
513
- >**systemCode:** string <br>
541
+ >**systemCode:** string <br>
514
542
  >*system code for performing official actions (password reset, activation)* <br>
515
543
  >example: OrderedMap { "value": "90BDCX", "expiredDate": "2024-05-07T21:02:00.000Z" } <br>
516
544
  >
@@ -518,7 +546,7 @@ const value = await AuthProvider.signUp('email', data)
518
546
  >*the text identifier of the authorization provider's form* <br>
519
547
  >example: reg_form <br>
520
548
  >
521
- >**authData:** FormAuthDataType <br>
549
+ >**authData:** FormAuthDataType <br>
522
550
  >*authorization data taken from the form linked to the authorization provider* <br>
523
551
  >example: List [ OrderedMap { "marker": "login", "value": "test" }, OrderedMap { "marker": "password", "value": "12345" } ] <br>
524
552
  >
@@ -527,8 +555,6 @@ const value = await AuthProvider.signUp('email', data)
527
555
  >example: 1 <br>
528
556
  >
529
557
  ></details>
530
-
531
-
532
558
  > This method will register a new user. Returns the registered user's object.
533
559
 
534
560
  Example return:
@@ -566,7 +592,7 @@ Example return:
566
592
  ><details>
567
593
  ><summary>Schema</summary>
568
594
  >
569
- >**id:** number <br>
595
+ >**id:** number <br>
570
596
  >*object identifier*
571
597
  >example: 1764 <br>
572
598
  >
@@ -577,7 +603,7 @@ Example return:
577
603
  >*object version number* <br>
578
604
  >example: 10 <br>
579
605
  >
580
- >**identifier:** string <br>
606
+ >**identifier:** string <br>
581
607
  >*textual identifier for the field record* <br>
582
608
  >example: catalog <br>
583
609
  >default: marker <br>
@@ -590,11 +616,11 @@ Example return:
590
616
  >*Data submitted by the form* <br>
591
617
  >example: OrderedMap { "en_US": List [ OrderedMap { "marker": "naimenovanie_1", "value": "Name" } ] } <br>
592
618
  >
593
- >**notificationData:** UserNotificationDataType <br>
619
+ >**notificationData:** UserNotificationDataType <br>
594
620
  >*data for notifying the user* <br>
595
621
  >example: OrderedMap { "email": "test@test.zone", "phonePush": "", "phoneSMS": "+79991234567" } <br>
596
622
  >
597
- >**systemCode:** string <br>
623
+ >**systemCode:** string <br>
598
624
  >*system code for performing official actions (password reset, activation)* <br>
599
625
  >example: OrderedMap { "value": "90BDCX", "expiredDate": "2024-05-07T21:02:00.000Z" } <br>
600
626
  >
@@ -602,7 +628,7 @@ Example return:
602
628
  >*the text identifier of the authorization provider's form* <br>
603
629
  >example: reg_form <br>
604
630
  >
605
- >**authData:** FormAuthDataType <br>
631
+ >**authData:** FormAuthDataType <br>
606
632
  >*authorization data taken from the form linked to the authorization provider* <br>
607
633
  >example: List [ OrderedMap { "marker": "login", "value": "test" }, OrderedMap { "marker": "password", "value": "12345" } ] <br>
608
634
  >
@@ -612,17 +638,14 @@ Example return:
612
638
  >
613
639
  ></details>
614
640
 
615
-
616
641
  ### AuthProvider.generateCode(marker, userIdentifier, eventIdentifier)
617
642
 
618
-
619
643
  ```js
620
644
  const value = await AuthProvider.generateCode('email', 'test@trer.com', 'auth')
621
645
  ```
622
646
 
623
647
  > This method receives a code to activate the user. Code is returned through the corresponding user notification method
624
648
 
625
-
626
649
  ### AuthProvider.checkCode(marker, userIdentifier, code)
627
650
 
628
651
  ```js
@@ -637,7 +660,6 @@ Example return:
637
660
  true
638
661
  ```
639
662
 
640
-
641
663
  ### AuthProvider.activateUser(marker, userIdentifier, code)
642
664
 
643
665
  ```js
@@ -674,12 +696,11 @@ const value = await AuthProvider.auth('email', data)
674
696
  ><details>
675
697
  ><summary>Schema</summary>
676
698
  >
677
- >**authData:** string <br>
699
+ >**authData:** string <br>
678
700
  >*Authorization data taken from the form attached to the authorization provider*
679
701
  >example: List [ OrderedMap { "marker": "login", "value": "test" }, OrderedMap { "marker": "password", "value": "12345" } ] <br>
680
702
  >
681
703
  ></details>
682
-
683
704
  > This method performs user authorization. Returns an object with a set of tokens.
684
705
 
685
706
  Example return:
@@ -696,7 +717,7 @@ Example return:
696
717
  ><details>
697
718
  ><summary>Schema</summary>
698
719
  >
699
- >**userIdentifier:** string <br>
720
+ >**userIdentifier:** string <br>
700
721
  >*user identifier*
701
722
  >example: example@oneentry.cloud <br>
702
723
  >
@@ -736,7 +757,7 @@ Example return:
736
757
  ><details>
737
758
  ><summary >Schema</summary>
738
759
  >
739
- >**userIdentifier:** string <br>
760
+ >**userIdentifier:** string <br>
740
761
  >*user identifier*
741
762
  >example: example@oneentry.cloud <br>
742
763
  >
@@ -754,7 +775,6 @@ Example return:
754
775
  >
755
776
  ></details>
756
777
 
757
-
758
778
  ### AuthProvider.logout(marker, token)
759
779
 
760
780
  ```js
@@ -783,7 +803,6 @@ Example return:
783
803
  true
784
804
  ```
785
805
 
786
-
787
806
  ### AuthProvider.getAuthProviders(langCode, offset, limit)
788
807
 
789
808
  ```js
@@ -820,11 +839,11 @@ Example return:
820
839
  ><details>
821
840
  ><summary >Schema</summary>
822
841
  >
823
- >**id:** number <br>
842
+ >**id:** number <br>
824
843
  >*object identifier*
825
844
  >example: 1764 <br>
826
845
  >
827
- >**localizeInfos:** CommonLocalizeInfos <br>
846
+ >**localizeInfos:** CommonLocalizeInfos <br>
828
847
  >*block name with localization* <br>
829
848
  >example: OrderedMap { "en_US": OrderedMap { "title": "My block" } } <br>
830
849
  >
@@ -832,24 +851,24 @@ Example return:
832
851
  >*object version number* <br>
833
852
  >example: 10 <br>
834
853
  >
835
- >**identifier:** string <br>
854
+ >**identifier:** string <br>
836
855
  >*textual identifier for the field record* <br>
837
856
  >example: catalog <br>
838
857
  >default: marker <br>
839
858
  >
840
- >**isActive:** boolean <br>
859
+ >**isActive:** boolean <br>
841
860
  >*Flag of usage* <br>
842
861
  >example: false <br>
843
862
  >
844
- >**isCheckCode:** boolean <br>
863
+ >**isCheckCode:** boolean <br>
845
864
  >*a sign of user activation via a code* <br>
846
865
  >example: false <br>
847
866
  >
848
- >**type:** string <br>
867
+ >**type:** string <br>
849
868
  >*type of providere* <br>
850
869
  >example: email <br>
851
870
  >
852
- >**formIdentifier:** string <br>
871
+ >**formIdentifier:** string <br>
853
872
  >*the marker of the form used by the provider (may be null)* <br>
854
873
  >example: email <br>
855
874
  >
@@ -891,11 +910,11 @@ Example return:
891
910
  ><details>
892
911
  ><summary>Schema</summary>
893
912
  >
894
- >**id:** number <br>
913
+ >**id:** number <br>
895
914
  >*object identifier*
896
915
  >example: 1764 <br>
897
916
  >
898
- >**localizeInfos:** CommonLocalizeInfos <br>
917
+ >**localizeInfos:** CommonLocalizeInfos <br>
899
918
  >*block name with localization* <br>
900
919
  >example: OrderedMap { "en_US": OrderedMap { "title": "My block" } } <br>
901
920
  >
@@ -903,24 +922,24 @@ Example return:
903
922
  >*object version number* <br>
904
923
  >example: 10 <br>
905
924
  >
906
- >**identifier:** string <br>
925
+ >**identifier:** string <br>
907
926
  >*textual identifier for the field record* <br>
908
927
  >example: catalog <br>
909
928
  >default: marker <br>
910
929
  >
911
- >**isActive:** boolean <br>
930
+ >**isActive:** boolean <br>
912
931
  >*Flag of usage* <br>
913
932
  >example: false <br>
914
933
  >
915
- >**isCheckCode:** boolean <br>
934
+ >**isCheckCode:** boolean <br>
916
935
  >*a sign of user activation via a code* <br>
917
936
  >example: false <br>
918
937
  >
919
- >**type:** string <br>
938
+ >**type:** string <br>
920
939
  >*type of providere* <br>
921
940
  >example: email <br>
922
941
  >
923
- >**formIdentifier:** string <br>
942
+ >**formIdentifier:** string <br>
924
943
  >*the marker of the form used by the provider (may be null)* <br>
925
944
  >example: email <br>
926
945
  >
@@ -928,7 +947,6 @@ Example return:
928
947
 
929
948
  ---
930
949
 
931
-
932
950
  ## <h2 id="blocks"> Blocks </h2>
933
951
 
934
952
  ```js
@@ -969,11 +987,11 @@ Example return:
969
987
  ><details>
970
988
  ><summary >Schema</summary>
971
989
  >
972
- >**total:** number <br>
990
+ >**total:** number <br>
973
991
  >*total number of found records* <br>
974
992
  >example: 100 <br>
975
993
  >
976
- >**id:** number <br>
994
+ >**id:** number <br>
977
995
  >*object identifier*
978
996
  >example: 1764 <br>
979
997
  >
@@ -981,11 +999,11 @@ Example return:
981
999
  >*identifier for the used attribute set* <br>
982
1000
  >example: 7 <br>
983
1001
  >
984
- >**localizeInfos:** CommonLocalizeInfos <br>
1002
+ >**localizeInfos:** CommonLocalizeInfos <br>
985
1003
  >*block name with localization* <br>
986
1004
  >example: OrderedMap { "en_US": OrderedMap { "title": "My block" } } <br>
987
1005
  >
988
- >**customSettings:** BlockCustomSettings <br>
1006
+ >**customSettings:** BlockCustomSettings <br>
989
1007
  >*custom settings for different block types* <br>
990
1008
  >example: OrderedMap { "sliderDelay": 0, "sliderDelayType": "", "productQuantity": 4, "productSortType": "By_ID", "productSortOrder": "Descending", "productCountElementsPerRow": 10, "similarProductRules": List [ OrderedMap { "property": "Descending", "includes": "", "keywords": "", "strict": "" } ] } <br>
991
1009
  >
@@ -993,7 +1011,7 @@ Example return:
993
1011
  >*object version number* <br>
994
1012
  >example: 10 <br>
995
1013
  >
996
- >**identifier:** string <br>
1014
+ >**identifier:** string <br>
997
1015
  >*textual identifier for the field record* <br>
998
1016
  >example: catalog <br>
999
1017
  >default: marker <br>
@@ -1002,7 +1020,7 @@ Example return:
1002
1020
  >*position number (for sorting)* <br>
1003
1021
  >example: 192 <br>
1004
1022
  >
1005
- >**attributeValues:** Record<string, string> <br>
1023
+ >**attributeValues:** Record<string, string> <br>
1006
1024
  >*array of attribute values from the index (presented as a pair of custom attribute identifier: attribute value)* <br>
1007
1025
  >example: OrderedMap { "en_US": OrderedMap { "marker": OrderedMap { "value": "", "type": "string" } } } <br>
1008
1026
  >
@@ -1010,7 +1028,7 @@ Example return:
1010
1028
  >*block type* <br>
1011
1029
  >example: forNewsPage <br>
1012
1030
  >
1013
- >**templateIdentifier:** string <br>
1031
+ >**templateIdentifier:** string <br>
1014
1032
  >*template marker used by the block (can be null)* <br>
1015
1033
  >Enum:
1016
1034
  >[ forCatalogProducts, forBasketPage, forErrorPage, forCatalogPages, forProductPreview, forProductPage, forSimilarProductBlock, forStatisticProductBlock, forProductBlock, forForm, forFormField, forNewsPage, forNewsBlock, forNewsPreview, forOneNewsPage, forUsualPage, forTextBlock, forSlider, service ] <br>
@@ -1020,7 +1038,6 @@ Example return:
1020
1038
 
1021
1039
  ---
1022
1040
 
1023
-
1024
1041
  ### Blocks.getBlockByMarker(marker, langCode, offset, limit)
1025
1042
 
1026
1043
  ```js
@@ -1033,109 +1050,85 @@ Example return:
1033
1050
 
1034
1051
  ```json
1035
1052
  {
1036
- "total": 1,
1037
- "items": [
1038
- {
1039
- "id": 5,
1040
- "localizeInfos": {
1041
- "title": "Similar"
1042
- },
1043
- "version": 0,
1044
- "position": 1,
1045
- "identifier": "similar",
1046
- "type": "forSimilarProductBlock",
1047
- "templateIdentifier": "block-template",
1048
- "isVisible": true,
1049
- "attributeValues": {
1050
- "block-text": {
1051
- "type": "string",
1052
- "value": "",
1053
- "position": 0,
1054
- "isProductPreview": false
1055
- }
1056
- },
1057
- "countElementsPerRow": "1",
1058
- "quantity": "2",
1059
- "similarProducts": [
1060
- {
1061
- "id": 2,
1062
- "localizeInfos": {
1063
- "title": "Box"
1064
- },
1065
- "statusIdentifier": "sold",
1066
- "statusLocalizeInfos": {
1067
- "title": "Sold"
1068
- },
1069
- "attributeSetIdentifier": "products",
1070
- "position": 2,
1071
- "templateIdentifier": null,
1072
- "shortDescTemplateIdentifier": null,
1073
- "price": 148,
1074
- "additional": {
1075
- "prices": {
1076
- "min": 120,
1077
- "max": 150
1078
- }
1079
- },
1080
- "sku": null,
1081
- "isSync": true,
1082
- "attributeValues": {
1083
- "price": {
1084
- "type": "integer",
1085
- "value": 148,
1086
- "position": 1,
1087
- "isProductPreview": false
1088
- },
1089
- "product-name": {
1090
- "type": "string",
1091
- "value": "Box text",
1092
- "position": 0,
1093
- "isProductPreview": false
1094
- },
1095
- "currency_products": {
1096
- "type": "string",
1097
- "value": "$",
1098
- "position": 2,
1099
- "isProductPreview": false
1100
- }
1101
- },
1102
- "isVisible": true
1053
+ "id": 1764,
1054
+ "localizeInfos": {
1055
+ "en_US": {
1056
+ "title": "My block"
1057
+ }
1058
+ },
1059
+ "customSettings": {
1060
+ "sliderDelay": 0,
1061
+ "sliderDelayType": "",
1062
+ "productConfig": {
1063
+ "quantity": 2,
1064
+ "sortType": "By_ID",
1065
+ "sortOrder": "DESC",
1066
+ "countElementsPerRow": 10
1067
+ },
1068
+ "similarProductRules": [
1069
+ {
1070
+ "property": "Descending",
1071
+ "includes": "",
1072
+ "keywords": "",
1073
+ "strict": ""
1074
+ }
1075
+ ],
1076
+ "condition": {
1077
+ "name": "title"
1078
+ }
1079
+ },
1080
+ "version": 10,
1081
+ "identifier": "catalog",
1082
+ "position": 192,
1083
+ "productPageUrls": [
1084
+ "23-laminat-floorwood-maxima"
1085
+ ],
1086
+ "isVisible": true,
1087
+ "attributeValues": {
1088
+ "en_US": {
1089
+ "marker": {
1090
+ "value": "",
1091
+ "type": "string",
1092
+ "position": 1,
1093
+ "isProductPreview": false,
1094
+ "isIcon": false,
1095
+ "attributeFields": {
1096
+ "marker": {
1097
+ "type": "string",
1098
+ "value": "test"
1099
+ }
1103
1100
  }
1104
- ]
1101
+ }
1105
1102
  }
1106
- ]
1103
+ },
1104
+ "type": "forNewsPage",
1105
+ "templateIdentifier": null,
1106
+ "attributeSetIdentifier": "my-attributes-sets"
1107
1107
  }
1108
1108
  ```
1109
1109
 
1110
1110
  ><details>
1111
1111
  ><summary>Schema</summary>
1112
1112
  >
1113
- >**total:** number <br>
1114
- >*total number of found records* <br>
1115
- >example: 100 <br>
1116
- >
1117
- >**id:** number <br>
1118
- >*object identifier*
1113
+ >**id:** number <br>
1114
+ >*object identifier* <br>
1119
1115
  >example: 1764 <br>
1120
1116
  >
1121
- >**attributeSetId:** number <br>
1122
- >*identifier for the used attribute set* <br>
1123
- >example: 7 <br>
1124
- >
1125
- >**localizeInfos:** CommonLocalizeInfos <br>
1126
- >*block name with localization* <br>
1117
+ >**localizeInfos:** CommonLocalizeInfos <br>
1118
+ >*block name considering localization* <br>
1127
1119
  >example: OrderedMap { "en_US": OrderedMap { "title": "My block" } } <br>
1128
1120
  >
1129
- >**customSettings:** BlockCustomSettings <br>
1130
- >*custom settings for different block types* <br>
1131
- >example: OrderedMap { "sliderDelay": 0, "sliderDelayType": "", "productQuantity": 4, "productSortType": "By_ID", "productSortOrder": "Descending", "productCountElementsPerRow": 10, "similarProductRules": List [ OrderedMap { "property": "Descending", "includes": "", "keywords": "", "strict": "" } ] } <br>
1121
+ >**customSettings:** BlockCustomSettings <br>
1122
+ >*individual settings for different types of blocks* <br>
1123
+ >BlockCustomSettings
1124
+ example: OrderedMap { "sliderDelay": 0, "sliderDelayType": "", "productConfig": OrderedMap { "quantity": 2, "sortType": "By_ID", "sortOrder": "DESC", "countElementsPerRow": 10 }, "similarProductRules": List [ OrderedMap { "property": "Descending", "includes": "", "keywords": "", "strict": "" } ], "condition": OrderedMap { "name": "title" } } <br>
1132
1125
  >
1133
1126
  >**version:** number <br>
1134
- >*object version number* <br>
1127
+ >*version number of the object change* <br>
1135
1128
  >example: 10 <br>
1136
1129
  >
1137
- >**identifier:** string <br>
1138
- >*textual identifier for the field record* <br>
1130
+ >**identifier:** string <br>
1131
+ >*textual identifier for the recording field* <br>
1139
1132
  >example: catalog <br>
1140
1133
  >default: marker <br>
1141
1134
  >
@@ -1143,18 +1136,34 @@ Example return:
1143
1136
  >*position number (for sorting)* <br>
1144
1137
  >example: 192 <br>
1145
1138
  >
1146
- >**attributeValues:** Record<string, string> <br>
1147
- >*array of attribute values from the index (presented as a pair of custom attribute identifier: attribute value)* <br>
1148
- >example: OrderedMap { "en_US": OrderedMap { "marker": OrderedMap { "value": "", "type": "string" } } } <br>
1139
+ >**productPageUrls:** any <br>
1140
+ >*array of unique parts of the URL page (after the last "/") - categories from where products can be taken (optional)* <br>
1141
+ >example: List [ "23-laminat-floorwood-maxima" ] <br>
1142
+ >
1143
+ >**isVisible:** boolean <br>
1144
+ >*visibility (availability) indicator of the block* <br>
1145
+ >example: true <br>
1146
+ >
1147
+ >**attributeValues:** Record<string, string> <br>
1148
+ >*Array of attribute values ​​from the index (type, value, array of additional fields for the attribute)* <br>
1149
+ >example: OrderedMap { "en_US": OrderedMap { "marker": OrderedMap { "value": "", "type": "string", "position": 1, "isProductPreview": false, "isIcon": false, "attributeFields": OrderedMap { "marker": OrderedMap { "type": "string", "value": "test" } } } } } <br>
1149
1150
  >
1150
1151
  >**type:** string <br>
1151
1152
  >*block type* <br>
1152
1153
  >example: forNewsPage <br>
1153
- >
1154
- >**templateIdentifier:** string <br>
1155
- >*template marker used by the block (can be null)* <br>
1156
1154
  >Enum:
1157
- >[ forCatalogProducts, forBasketPage, forErrorPage, forCatalogPages, forProductPreview, forProductPage, forSimilarProductBlock, forStatisticProductBlock, forProductBlock, forForm, forFormField, forNewsPage, forNewsBlock, forNewsPreview, forOneNewsPage, forUsualPage, forTextBlock, forSlider, service ] <br>
1155
+ [ forCatalogProducts, forBasketPage, forErrorPage, forCatalogPages, forProductPreview, forProductPage, forSimilarProductBlock, forStatisticProductBlock, forProductBlock, forForm, forFormField, forNewsPage, forNewsBlock, forNewsPreview, forOneNewsPage, forUsualPage, forTextBlock, forSlider, forOrder, service ] <br>
1156
+ >
1157
+ >**attributeSetId:** number <br>
1158
+ >*identifier for the used attribute set* <br>
1159
+ >example: 7 <br>
1160
+ >
1161
+ >**position:** number <br>
1162
+ >*position number (for sorting)* <br>
1163
+ >example: 192 <br>
1164
+ >
1165
+ >**templateIdentifier:** string <br>
1166
+ >*Template marker used by the block (can be null)* <br>
1158
1167
  >example: null <br>
1159
1168
  >
1160
1169
  ></details>
@@ -1181,7 +1190,6 @@ Example return:
1181
1190
  ]
1182
1191
  ```
1183
1192
 
1184
-
1185
1193
  ---
1186
1194
 
1187
1195
  ## <h2 id="events"> Events </h2>
@@ -1190,7 +1198,7 @@ Example return:
1190
1198
  const { Events } = defineOneEntry('your-url');
1191
1199
  ```
1192
1200
 
1193
- ### Events.getAllSubscriptions(limit, offset)
1201
+ ### Events.getAllSubscriptions(offset, limit)
1194
1202
 
1195
1203
  ```js
1196
1204
  const value = await Events.getAllSubscriptions('test_event', 1, 1)
@@ -1198,7 +1206,8 @@ const value = await Events.getAllSubscriptions('test_event', 1, 1)
1198
1206
 
1199
1207
  > This method return all subscriptions to product.
1200
1208
 
1201
- Example return:
1209
+ Example return:
1210
+
1202
1211
  ```json
1203
1212
  {
1204
1213
  "total": 100,
@@ -1225,7 +1234,6 @@ Example return:
1225
1234
  >
1226
1235
  ></details>
1227
1236
 
1228
-
1229
1237
  ### Events.subscribeByMarker(marker, userId, productId)
1230
1238
 
1231
1239
  ```js
@@ -1234,7 +1242,6 @@ const value = await Events.subscribeByMarker('test_event', 1, 1)
1234
1242
 
1235
1243
  > This method unsubscribes to the product event. Returns nothing if the unsubscription was successful.
1236
1244
 
1237
-
1238
1245
  ### Events.unsubscribeByMarker(marker, userId, productId)
1239
1246
 
1240
1247
  ```js
@@ -1245,7 +1252,6 @@ const value = await Events.subscribeByMarker('test_event', 1, 1)
1245
1252
 
1246
1253
  ---
1247
1254
 
1248
-
1249
1255
  ## <h2 id="fileuploading"> FileUploading </h2>
1250
1256
 
1251
1257
  ```js
@@ -1329,11 +1335,8 @@ Example return:
1329
1335
 
1330
1336
  ---
1331
1337
 
1332
-
1333
-
1334
1338
  ## <h2 id="forms"> Forms </h2>
1335
1339
 
1336
-
1337
1340
  ```js
1338
1341
  const { Forms } = defineOneEntry('your-url');
1339
1342
  ```
@@ -1403,31 +1406,31 @@ Example return:
1403
1406
  ><details>
1404
1407
  ><summary >Schema</summary>
1405
1408
  >
1406
- >**id:** number <br>
1409
+ >**id:** number <br>
1407
1410
  >*object identifier* <br>
1408
1411
  >example: 1764 <br>
1409
1412
  >
1410
- >**attributeSetId:** number <br>
1413
+ >**attributeSetId:** number <br>
1411
1414
  >*identifier of the attribute set used* <br>
1412
1415
  >
1413
- >**processingType:** string <br>
1416
+ >**processingType:** string <br>
1414
1417
  >*form processing type* <br>
1415
1418
  >example: email <br>
1416
1419
  >
1417
- >**localizeInfos:** FormLocalizeInfos <br>
1420
+ >**localizeInfos:** FormLocalizeInfos <br>
1418
1421
  >*form name with localization* <br>
1419
1422
  >Enum:
1420
1423
  >[ db, email, script ]
1421
1424
  >example: OrderedMap { "en_US": OrderedMap { "title": "My Form", "titleForSite": "", "successMessage": "", "unsuccessMessage": "", "urlAddress": "", "database": "0", "script": "0" } } <br>
1422
1425
  >
1423
- >**processingData:** ProcessingData <br>
1426
+ >**processingData:** ProcessingData <br>
1424
1427
  >*form data* <br>
1425
1428
  >
1426
1429
  >**version:** number <br>
1427
1430
  >*object version number* <br>
1428
1431
  >example: 10 <br>
1429
1432
  >
1430
- >**identifier:** string <br>
1433
+ >**identifier:** string <br>
1431
1434
  >*textual identifier for the record field* <br>
1432
1435
  >example: catalog <br>
1433
1436
  >default: marker <br>
@@ -1440,13 +1443,12 @@ Example return:
1440
1443
  >*Form type* <br>
1441
1444
  >example: 'data' <br>
1442
1445
  >
1443
- >**attributes:** <br>
1446
+ >**attributes:** <br>
1444
1447
  >*array of attribute values from the used attribute set for displaying the form (taking into account the specified language)* <br>
1445
1448
  >example: List [ OrderedMap { "type": "list", "marker": "l1", "position": 2, "listTitles": List [ OrderedMap { "title": "red", "value": 1, "position": 1, "extendedValue": null, "extendedValueType": null }, OrderedMap { "title": "yellow", "value": 2, "position": 2, "extendedValue": null, "extendedValueType": null } ], "validators": OrderedMap {}, "localizeInfos": OrderedMap { "title": "l1" } } ] <br>
1446
1449
  >
1447
1450
  ></details>
1448
1451
 
1449
-
1450
1452
  ### Forms.getFormByMarker(marker, langCode)
1451
1453
 
1452
1454
  ```js
@@ -1510,31 +1512,31 @@ Example return:
1510
1512
  ><details>
1511
1513
  ><summary >Schema</summary>
1512
1514
  >
1513
- >**id:** number <br>
1515
+ >**id:** number <br>
1514
1516
  >*object identifier* <br>
1515
1517
  >example: 1764 <br>
1516
1518
  >
1517
- >**attributeSetId:** number <br>
1519
+ >**attributeSetId:** number <br>
1518
1520
  >*identifier of the attribute set used* <br>
1519
1521
  >
1520
- >**processingType:** string <br>
1522
+ >**processingType:** string <br>
1521
1523
  >*form processing type* <br>
1522
1524
  >example: email <br>
1523
1525
  >
1524
- >**localizeInfos:** FormLocalizeInfos <br>
1526
+ >**localizeInfos:** FormLocalizeInfos <br>
1525
1527
  >*form name with localization* <br>
1526
1528
  >Enum:
1527
1529
  >[ db, email, script ]
1528
1530
  >example: OrderedMap { "en_US": OrderedMap { "title": "My Form", "titleForSite": "", "successMessage": "", "unsuccessMessage": "", "urlAddress": "", "database": "0", "script": "0" } } <br>
1529
1531
  >
1530
- >**processingData:** ProcessingData <br>
1532
+ >**processingData:** ProcessingData <br>
1531
1533
  >*form data* <br>
1532
1534
  >
1533
1535
  >**version:** number <br>
1534
1536
  >*object version number* <br>
1535
1537
  >example: 10 <br>
1536
1538
  >
1537
- >**identifier:** string <br>
1539
+ >**identifier:** string <br>
1538
1540
  >*textual identifier for the record field* <br>
1539
1541
  >example: catalog <br>
1540
1542
  >default: marker <br>
@@ -1547,7 +1549,7 @@ Example return:
1547
1549
  >*Form type* <br>
1548
1550
  >example: 'data' <br>
1549
1551
  >
1550
- >**attributes:** <br>
1552
+ >**attributes:** <br>
1551
1553
  >*array of attribute values from the used attribute set for displaying the form (taking into account the specified language)* <br>
1552
1554
  >example: List [ OrderedMap { "type": "list", "marker": "l1", "position": 2, "listTitles": List [ OrderedMap { "title": "red", "value": 1, "position": 1, "extendedValue": null, "extendedValueType": null }, OrderedMap { "title": "yellow", "value": 2, "position": 2, "extendedValue": null, "extendedValueType": null } ], "validators": OrderedMap {}, "localizeInfos": OrderedMap { "title": "l1" } } ] <br>
1553
1555
  >
@@ -1555,7 +1557,6 @@ Example return:
1555
1557
 
1556
1558
  ---
1557
1559
 
1558
-
1559
1560
  ## <h2 id="formdata"> FormData </h2>
1560
1561
 
1561
1562
  ```js
@@ -1567,6 +1568,7 @@ The following are examples of form data objects for different data types.
1567
1568
 
1568
1569
  ---
1569
1570
  Example with a simple type attribute "string", "number", "float"
1571
+
1570
1572
  ```json
1571
1573
  {
1572
1574
  "marker": "last_name",
@@ -1577,6 +1579,7 @@ Example with a simple type attribute "string", "number", "float"
1577
1579
 
1578
1580
  ---
1579
1581
  Example with a simple type attribute "date", "dateTime", "time"
1582
+
1580
1583
  ```json
1581
1584
  {
1582
1585
  "marker": "birthday",
@@ -1591,6 +1594,7 @@ Example with a simple type attribute "date", "dateTime", "time"
1591
1594
 
1592
1595
  ---
1593
1596
  Example with a simple type attribute "text"
1597
+
1594
1598
  ```json
1595
1599
  {
1596
1600
  "marker": "about",
@@ -1608,6 +1612,7 @@ Example with a simple type attribute "text"
1608
1612
 
1609
1613
  ---
1610
1614
  Example with a simple type attribute "text"
1615
+
1611
1616
  ```json
1612
1617
  {
1613
1618
  "marker": "about",
@@ -1625,6 +1630,7 @@ Example with a simple type attribute "text"
1625
1630
 
1626
1631
  ---
1627
1632
  Example with a simple type attribute "textWithHeader"
1633
+
1628
1634
  ```json
1629
1635
  {
1630
1636
  "marker": "about",
@@ -1643,6 +1649,7 @@ Example with a simple type attribute "textWithHeader"
1643
1649
 
1644
1650
  ---
1645
1651
  Example with a simple type attribute "image" or "groupOfImages"
1652
+
1646
1653
  ```json
1647
1654
  {
1648
1655
  "marker": "avatar",
@@ -1663,6 +1670,7 @@ Example with a simple type attribute "image" or "groupOfImages"
1663
1670
 
1664
1671
  ---
1665
1672
  Example with a simple type attribute "files"
1673
+
1666
1674
  ```json
1667
1675
  {
1668
1676
  "marker": "picture",
@@ -1679,6 +1687,7 @@ Example with a simple type attribute "files"
1679
1687
 
1680
1688
  ---
1681
1689
  Example with a simple type attribute "radioButton" or "list"
1690
+
1682
1691
  ```json
1683
1692
  {
1684
1693
  "marker": "selector",
@@ -1696,8 +1705,6 @@ Example with a simple type attribute "radioButton" or "list"
1696
1705
  }
1697
1706
  ```
1698
1707
 
1699
-
1700
-
1701
1708
  ### FormData.postFormsData(data, langCode)
1702
1709
 
1703
1710
  ```js
@@ -1716,225 +1723,604 @@ const value = await FormData.postFormsData(body)
1716
1723
  ><details>
1717
1724
  ><summary >Schema</summary>
1718
1725
  >
1719
- >**id:** number <br>
1726
+ >**id:** number <br>
1720
1727
  >*object identifier* <br>
1721
1728
  >example: 1764 <br>
1722
1729
  >
1723
- >**formIdentifier:** string <br>
1730
+ >**formIdentifier:** string <br>
1724
1731
  >*text identifier of form object (marker)* <br>
1725
1732
  >example: my-form <br>
1726
- >
1727
- >**time:** Date <br>
1733
+ >
1734
+ >**time:** Date <br>
1728
1735
  >*form change date and time* <br>
1729
1736
  >example: 2023-02-12 10:56<br>
1730
- >
1737
+ >
1731
1738
  >**formData:** <br>
1732
1739
  >*Data submitted by the form* <br>
1733
1740
  >example: OrderedMap { "en_US": List [ OrderedMap { "marker": "naimenovanie_1", "type": "string", "value": "Name" } ] }<br>
1734
1741
  ></details>
1742
+ > This method retrieves all form data objects from the API. It returns a Promise that resolves to an array of objects of type CreateFormData. The method will add the default language to the request body. If you want to change the language, just pass it with the second argument
1743
+
1744
+ Example return:
1745
+
1746
+ ```json
1747
+ {
1748
+ "id": 1764,
1749
+ "formIdentifier": "my-form",
1750
+ "time": "2023-02-12 10:56",
1751
+ "formData": {
1752
+ "marker": "name_1",
1753
+ "value": "Name",
1754
+ "type": "string"
1755
+ }
1756
+ }
1757
+ ```
1758
+
1759
+ ><details>
1760
+ ><summary >Schema</summary>
1761
+ >
1762
+ >**id:** number <br>
1763
+ >*object identifier* <br>
1764
+ >example: 1764 <br>
1765
+ >
1766
+ >**formIdentifier:** string <br>
1767
+ >*Text identifier of the form object (marker)* <br>
1768
+ >example: my-form <br>
1769
+ >
1770
+ >**time:** Date <br>
1771
+ >*Date and time of form modification* <br>
1772
+ >example: 2023-02-12 10:56 <br>
1773
+ >
1774
+ >**formData:** FormDataLangType <br>
1775
+ >*Data submitted by the form* <br>
1776
+ >example: OrderedMap { "en_US": List [ OrderedMap { "marker": "naimenovanie_1", "value": "Name" } ] } <br>
1777
+ >
1778
+ ></details>
1779
+
1780
+ ### FormData.getFormsData(langCode, offset, limit)
1781
+
1782
+ ```js
1783
+ const value = await FormData.getFormsData('en_US', 0, 30)
1784
+ ```
1785
+
1786
+ > This method creates form data objects by sending a request to the API. It accepts an array of objects of type IFormsPost as the request body to provide the necessary form data. It returns a Promise that resolves to the created CreateFormDataDto objects.
1787
+
1788
+ Example return:
1789
+
1790
+ ```json
1791
+ {
1792
+ "total": 1,
1793
+ "items": [
1794
+ {
1795
+ "id": 1764,
1796
+ "formIdentifier": "my-form",
1797
+ "time": "2023-02-12 10:56",
1798
+ "formData": {
1799
+ "marker": "name_1",
1800
+ "value": "Name",
1801
+ "type": "string"
1802
+ },
1803
+ "attributeSetIdentifier": "test-form"
1804
+ }
1805
+ ]
1806
+ }
1807
+ ```
1808
+
1809
+ ><details>
1810
+ ><summary >Schema</summary>
1811
+ >
1812
+ >**total:** number <br>
1813
+ >*total number of found records* <br>
1814
+ >example: 100 <br>
1815
+ >
1816
+ >**id:** number <br>
1817
+ >*object identifier* <br>
1818
+ >example: 1764 <br>
1819
+ >
1820
+ >**formIdentifier:** string <br>
1821
+ >*Text identifier of the form object (marker)* <br>
1822
+ >example: my-form <br>
1823
+ >
1824
+ >**time:** Date <br>
1825
+ >*Date and time of form modification* <br>
1826
+ >example: 2023-02-12 10:56 <br>
1827
+ >
1828
+ >**formData:** FormDataLangType <br>
1829
+ >*Data submitted by the form* <br>
1830
+ >example: OrderedMap { "en_US": List [ OrderedMap { "marker": "naimenovanie_1", "value": "Name" } ] } <br>
1831
+ >
1832
+ >**attributeSetIdentifier:** string <br>
1833
+ >*text identifier (marker) of the used attribute set* <br>
1834
+ >example: test-form <br>
1835
+ >
1836
+ ></details>
1837
+
1838
+ ### FormData.getFormsDataByMarker(marker, langCode, offset, limit)
1839
+
1840
+ ```js
1841
+ const value = await FormData.getFormsDataByMarker('my-marker', 'en_US', 0, 30)
1842
+ ```
1843
+
1844
+ > This method retrieves a specific form data object by its marker from the API. It accepts a marker parameter as the marker of the form data. It returns a Promise that resolves to an array of objects of type FormDataEntity.
1845
+
1846
+ Example return:
1847
+
1848
+ ```json
1849
+ {
1850
+ "total": 1,
1851
+ "items": [
1852
+ {
1853
+ "id": 1764,
1854
+ "formIdentifier": "my-form",
1855
+ "time": "2023-02-12 10:56",
1856
+ "formData": {
1857
+ "marker": "name_1",
1858
+ "value": "Name",
1859
+ "type": "string"
1860
+ },
1861
+ "attributeSetIdentifier": "test-form"
1862
+ }
1863
+ ]
1864
+ }
1865
+ ```
1866
+
1867
+ ><details>
1868
+ ><summary>Schema</summary>
1869
+ >
1870
+ >
1871
+ >**total:** number <br>
1872
+ >*total number of found records* <br>
1873
+ >example: 100 <br>
1874
+ >
1875
+ >**id:** number <br>
1876
+ >*object identifier* <br>
1877
+ >example: 1764 <br>
1878
+ >
1879
+ >**formIdentifier:** string <br>
1880
+ >*Text identifier of the form object (marker)* <br>
1881
+ >example: my-form <br>
1882
+ >
1883
+ >**time:** Date <br>
1884
+ >*Date and time of form modification* <br>
1885
+ >example: 2023-02-12 10:56 <br>
1886
+ >
1887
+ >**formData:** FormDataLangType <br>
1888
+ >*Data submitted by the form* <br>
1889
+ >example: OrderedMap { "en_US": List [ OrderedMap { "marker": "naimenovanie_1", "value": "Name" } ] } <br>
1890
+ >
1891
+ >**attributeSetIdentifier:** string <br>
1892
+ >*text identifier (marker) of the used attribute set* <br>
1893
+ >example: test-form <br>
1894
+ >
1895
+ ></details>
1896
+
1897
+ ---
1898
+
1899
+ ## <h2 id="generaltypes"> GeneralTypes </h2>
1900
+
1901
+ ```js
1902
+ const { GeneralTypes } = defineOneEntry('your-url');
1903
+ ```
1904
+
1905
+ ### GeneralTypes.getAllTypes()
1906
+
1907
+ ```js
1908
+ const value = await GeneralTypes.getAllTypes()
1909
+ ```
1910
+
1911
+ > This method retrieves all objects of type GeneralTypeEntity from the API. It returns a Promise that resolves to an array of GeneralTypeEntity objects.
1912
+
1913
+ Example return:
1914
+
1915
+ ```json
1916
+ [
1917
+ {
1918
+ "id": 1,
1919
+ "type": "forNewsPage"
1920
+ }
1921
+ ]
1922
+ ```
1923
+
1924
+ ><details>
1925
+ ><summary>Schema</summary>
1926
+ >
1927
+ >**id:** number <br>
1928
+ >*object identifier* <br>
1929
+ >example: 1764 <br>
1930
+ >
1931
+ >**type:** string <br>
1932
+ >*type value* <br>
1933
+ >example: forNewsPage <br>
1934
+ >Enum:
1935
+ >[ forCatalogProducts, forBasketPage, forErrorPage, forCatalogPages, forProductPreview, forProductPage, forSimilarProductBlock, forStatisticProductBlock, forProductBlock, forForm, forFormField, forNewsPage, forNewsBlock, forNewsPreview, forOneNewsPage, forUsualPage, forTextBlock, forSlider, service ] <br>
1936
+ >
1937
+ ></details>
1938
+
1939
+ ---
1940
+
1941
+ ## <h2 id="integrationcollections">IntegrationCollections</h2>
1942
+
1943
+ ```js
1944
+ const { IntegrationCollections } = defineOneEntry('your-url');
1945
+ ```
1946
+
1947
+ ### IntegrationCollections.getICollections()
1948
+
1949
+ ```js
1950
+ const result = await IntegrationCollections.getICollections();
1951
+ ```
1952
+
1953
+ > Get all collections.
1954
+
1955
+ Example return:
1956
+
1957
+ ```json
1958
+ [
1959
+ {
1960
+ "id": 1764,
1961
+ "localizeInfos": {
1962
+ "en_US": {
1963
+ "title": "Collection 1"
1964
+ }
1965
+ },
1966
+ "identifier": "collection",
1967
+ "formId": 1,
1968
+ "attributeSetId": "1",
1969
+ "selectedAttributeMarkers": "marker1, marker2"
1970
+ }
1971
+ ]
1972
+ ```
1973
+
1974
+ ><details>
1975
+ ><summary>Schema</summary>
1976
+ >
1977
+ >**id:** number <br>
1978
+ >*object identifier* <br>
1979
+ >example: 1764 <br>
1980
+ >
1981
+ >**localizeInfos:** CommonLocalizeInfos <br>
1982
+ >*Name considering localization* <br>
1983
+ >example: OrderedMap { "en_US": OrderedMap { "title": "Collection 1" } } <br>
1984
+ >
1985
+ >**identifier:** string <br>
1986
+ >*Text identifier for record field* <br>
1987
+ >example: 1 <br>
1988
+ >default: marker <br>
1989
+ >
1990
+ >**formId:** number <br>
1991
+ >*Identifier for the form used by the order storage* <br>
1992
+ >default: <br>
1993
+ >
1994
+ >**attributeSetId:** string <br>
1995
+ >*Identifier of the set of attributes used by the form attached to the collection* <br>
1996
+ >example: 1 <br>
1997
+ >default: <br>
1998
+ >
1999
+ >**selectedAttributeMarkers:** string <br>
2000
+ >*Text identifiers of form object attributes for display in the data table* <br>
2001
+ >example: marker1, marker2 <br>
2002
+ >default: <br>
2003
+ >
2004
+ ></details>
1735
2005
 
1736
- > This method retrieves all form data objects from the API. It returns a Promise that resolves to an array of objects of type CreateFormData. The method will add the default language to the request body. If you want to change the language, just pass it with the second argument
2006
+ ### IntegrationCollections.getICollectionById(id, langCode)
1737
2007
 
2008
+ ```js
2009
+ const result = await IntegrationCollections.getICollectionById(1);
2010
+ ```
1738
2011
 
2012
+ > Get collection by id.
1739
2013
 
1740
2014
  Example return:
1741
2015
 
1742
2016
  ```json
1743
2017
  {
1744
2018
  "id": 1764,
1745
- "formIdentifier": "my-form",
1746
- "time": "2023-02-12 10:56",
1747
- "formData": {
1748
- "marker": "name_1",
1749
- "value": "Name",
1750
- "type": "string"
1751
- }
2019
+ "localizeInfos": {
2020
+ "en_US": {
2021
+ "title": "Collection 1"
2022
+ }
2023
+ },
2024
+ "identifier": "collection",
2025
+ "formId": 1,
2026
+ "attributeSetId": "1",
2027
+ "selectedAttributeMarkers": "marker1, marker2"
1752
2028
  }
1753
2029
  ```
1754
2030
 
1755
2031
  ><details>
1756
- ><summary >Schema</summary>
2032
+ ><summary>Schema</summary>
1757
2033
  >
1758
- >**id:** number <br>
2034
+ >**id:** number <br>
1759
2035
  >*object identifier* <br>
1760
2036
  >example: 1764 <br>
1761
2037
  >
1762
- >**formIdentifier:** string <br>
1763
- >*Text identifier of the form object (marker)* <br>
1764
- >example: my-form <br>
2038
+ >**localizeInfos:** CommonLocalizeInfos <br>
2039
+ >*Name considering localization* <br>
2040
+ >example: OrderedMap { "en_US": OrderedMap { "title": "Collection 1" } } <br>
1765
2041
  >
1766
- >**time:** Date <br>
1767
- >*Date and time of form modification* <br>
1768
- >example: 2023-02-12 10:56 <br>
2042
+ >**identifier:** string <br>
2043
+ >*Text identifier for record field* <br>
2044
+ >example: collection <br>
2045
+ >default: marker <br>
1769
2046
  >
1770
- >**formData:** FormDataLangType <br>
1771
- >*Data submitted by the form* <br>
1772
- >example: OrderedMap { "en_US": List [ OrderedMap { "marker": "naimenovanie_1", "value": "Name" } ] } <br>
2047
+ >**formId:** number <br>
2048
+ >*Identifier for the form used by the order storage* <br>
2049
+ >example: 1 <br>
2050
+ >default: <br>
2051
+ >
2052
+ >**attributeSetId:** string <br>
2053
+ >*Identifier of the set of attributes used by the form attached to the collection* <br>
2054
+ >example: 1 <br>
2055
+ >default: <br>
2056
+ >
2057
+ >**selectedAttributeMarkers:** string <br>
2058
+ >*Text identifiers of form object attributes for display in the data table* <br>
2059
+ >example: marker1, marker2 <br>
1773
2060
  >
1774
2061
  ></details>
1775
2062
 
1776
- ### FormData.getFormsData(langCode, offset, limit)
2063
+ ### IntegrationCollections.getICollectionRowsById(id, langCode, userQuery)
1777
2064
 
1778
2065
  ```js
1779
- const value = await FormData.getFormsData('en_US', 0, 30)
2066
+ const result = await IntegrationCollections.getICollectionRowsById(1);
1780
2067
  ```
1781
2068
 
1782
- > This method creates form data objects by sending a request to the API. It accepts an array of objects of type IFormsPost as the request body to provide the necessary form data. It returns a Promise that resolves to the created CreateFormDataDto objects.
2069
+ > Get all records belonging to the collection by collection id.
1783
2070
 
1784
2071
  Example return:
1785
2072
 
1786
2073
  ```json
1787
2074
  {
1788
- "total": 1,
2075
+ "total": 100,
1789
2076
  "items": [
1790
2077
  {
1791
2078
  "id": 1764,
1792
- "formIdentifier": "my-form",
1793
- "time": "2023-02-12 10:56",
1794
- "formData": {
1795
- "marker": "name_1",
1796
- "value": "Name",
1797
- "type": "string"
2079
+ "localizeInfos": {
2080
+ "en_US": {
2081
+ "title": "Collection 1"
2082
+ }
1798
2083
  },
1799
- "attributeSetIdentifier": "test-form"
2084
+ "identifier": "collection",
2085
+ "formId": 1,
2086
+ "attributeSetId": "1",
2087
+ "selectedAttributeMarkers": "marker1, marker2"
1800
2088
  }
1801
2089
  ]
1802
2090
  }
1803
2091
  ```
1804
2092
 
1805
2093
  ><details>
1806
- ><summary >Schema</summary>
2094
+ ><summary>Schema</summary>
1807
2095
  >
1808
- >**total:** number <br>
1809
- >*total number of found records* <br>
2096
+ >**total:** number <br>
2097
+ >*Total number of found records* <br>
1810
2098
  >example: 100 <br>
1811
2099
  >
1812
- >**id:** number <br>
1813
- >*object identifier* <br>
2100
+ >**items:** ICollection <br>
2101
+ >*CollectionDto* <br>
2102
+ >
2103
+ >**id:** number <br>
2104
+ >*Object identifier* <br>
1814
2105
  >example: 1764 <br>
1815
2106
  >
1816
- >**formIdentifier:** string <br>
1817
- >*Text identifier of the form object (marker)* <br>
1818
- >example: my-form <br>
2107
+ >**localizeInfos:** CommonLocalizeInfos <br>
2108
+ >*Name considering localization* <br>
2109
+ >example: OrderedMap { "en_US": OrderedMap { "title": "Collection 1" } } <br>
1819
2110
  >
1820
- >**time:** Date <br>
1821
- >*Date and time of form modification* <br>
1822
- >example: 2023-02-12 10:56 <br>
2111
+ >**identifier:** string <br>
2112
+ >*Text identifier for record field* <br>
2113
+ >example: collection <br>
2114
+ >default: marker <br>
1823
2115
  >
1824
- >**formData:** FormDataLangType <br>
1825
- >*Data submitted by the form* <br>
1826
- >example: OrderedMap { "en_US": List [ OrderedMap { "marker": "naimenovanie_1", "value": "Name" } ] } <br>
2116
+ >**formId:** number <br>
2117
+ >*Identifier for the form used by the order storage* <br>
2118
+ >example: 1 <br>
2119
+ >default: <br>
1827
2120
  >
1828
- >**attributeSetIdentifier:** string <br>
1829
- >*text identifier (marker) of the used attribute set* <br>
1830
- >example: test-form <br>
2121
+ >**attributeSetId:** string <br>
2122
+ >*Identifier of the set of attributes used by the form attached to the collection* <br>
2123
+ >example: 1 <br>
2124
+ >default: <br>
2125
+ >
2126
+ >**selectedAttributeMarkers:** string <br>
2127
+ >*Text identifiers of form object attributes for display in the data table* <br>
2128
+ >example: marker1, marker2 <br>
1831
2129
  >
1832
2130
  ></details>
1833
2131
 
1834
-
1835
- ### FormData.getFormsDataByMarker(marker, langCode, offset, limit)
2132
+ ### IntegrationCollections.validateICollectionMarker(marker)
1836
2133
 
1837
2134
  ```js
1838
- const value = await FormData.getFormsDataByMarker('my-marker', 'en_US', 0, 30)
2135
+ const result = await IntegrationCollections.validateICollectionMarker('test_collection');
1839
2136
  ```
1840
2137
 
1841
- > This method retrieves a specific form data object by its marker from the API. It accepts a marker parameter as the marker of the form data. It returns a Promise that resolves to an array of objects of type FormDataEntity.
2138
+ > Check for the existence of a text identifier (marker)
1842
2139
 
1843
2140
  Example return:
1844
2141
 
1845
2142
  ```json
1846
2143
  {
1847
- "total": 1,
1848
- "items": [
1849
- {
1850
- "id": 1764,
1851
- "formIdentifier": "my-form",
1852
- "time": "2023-02-12 10:56",
1853
- "formData": {
1854
- "marker": "name_1",
1855
- "value": "Name",
1856
- "type": "string"
1857
- },
1858
- "attributeSetIdentifier": "test-form"
1859
- }
1860
- ]
2144
+ "valid": true
1861
2145
  }
1862
2146
  ```
1863
2147
 
1864
2148
  ><details>
1865
2149
  ><summary>Schema</summary>
1866
2150
  >
2151
+ >**valid:** boolean <br>
2152
+ >*Valid marker* <br>
2153
+ >example: <br>
1867
2154
  >
1868
- >**total:** number <br>
1869
- >*total number of found records* <br>
1870
- >example: 100 <br>
2155
+ ></details>
2156
+
2157
+ ### IntegrationCollections.getICollectionRowByMarkerAndId(marker, id, langCode)
2158
+
2159
+ ```js
2160
+ const result = await IntegrationCollections.getICollectionRowByMarkerAndId('test_collection', 1);
2161
+ ```
2162
+
2163
+ > Getting one record from the collection.
2164
+
2165
+ Example return:
2166
+
2167
+ ```json
2168
+ {
2169
+ "id": 1764,
2170
+ "createdDate": "2025-01-26T17:17:23.013Z",
2171
+ "updatedDate": "2025-01-26T17:17:23.013Z",
2172
+ "collectionId": 1,
2173
+ "langCode": "en_US",
2174
+ "formData": {
2175
+ "en_US": [
2176
+ {
2177
+ "marker": "naimenovanie_1",
2178
+ "type": "string",
2179
+ "value": "Title"
2180
+ }
2181
+ ]
2182
+ }
2183
+ }
2184
+ ```
2185
+
2186
+ ><details>
2187
+ ><summary>Schema</summary>
1871
2188
  >
1872
- >**id:** number <br>
1873
- >*object identifier* <br>
2189
+ >**id:** number <br>
2190
+ >*Object identifier* <br>
1874
2191
  >example: 1764 <br>
1875
2192
  >
1876
- >**formIdentifier:** string <br>
1877
- >*Text identifier of the form object (marker)* <br>
1878
- >example: my-form <br>
2193
+ >**createdDate:** string($date-time) <br>
2194
+ >*Date of record creation in the collection* <br>
1879
2195
  >
1880
- >**time:** Date <br>
1881
- >*Date and time of form modification* <br>
1882
- >example: 2023-02-12 10:56 <br>
2196
+ >**updatedDate:** string($date-time) <br>
2197
+ >*Date of object modification* <br>
1883
2198
  >
1884
- >**formData:** FormDataLangType <br>
1885
- >*Data submitted by the form* <br>
1886
- >example: OrderedMap { "en_US": List [ OrderedMap { "marker": "naimenovanie_1", "value": "Name" } ] } <br>
2199
+ >**collectionId:** number <br>
2200
+ >*Object identifier of the collection* <br>
2201
+ >example: 1 <br>
1887
2202
  >
1888
- >**attributeSetIdentifier:** string <br>
1889
- >*text identifier (marker) of the used attribute set* <br>
1890
- >example: test-form <br>
2203
+ >**langCode:** string <br>
2204
+ >*Language code in which the record in the collection was created* <br>
2205
+ >example: en_US <br>
2206
+ >
2207
+ >**formData:** FormDataLangType <br>
2208
+ >*Data submitted by the form attached to the collection* <br>
2209
+ >example: OrderedMap { "en_US": List [ OrderedMap { "marker": "naimenovanie_1", "type": "string", "value": "Title" } ] } <br>
1891
2210
  >
1892
2211
  ></details>
1893
2212
 
1894
- ---
2213
+ ### IntegrationCollections.createICollectionRow(marker, body, langCode)
1895
2214
 
2215
+ ```js
2216
+ const body = {
2217
+ "formIdentifier": "collection-form",
2218
+ "formData": {
2219
+ "en_US": [
2220
+ {
2221
+ "marker": "naimenovanie_1",
2222
+ "type": "string",
2223
+ "value": "Наименование"
2224
+ }
2225
+ ]
2226
+ }
2227
+ }
2228
+ const result = await IntegrationCollections.createICollectionRow('test_collection', body);
2229
+ ```
1896
2230
 
1897
- ## <h2 id="generaltypes"> GeneralTypes </h2>
2231
+ > Create a record in the collection
1898
2232
 
1899
- ```js
1900
- const { GeneralTypes } = defineOneEntry('your-url');
2233
+ Example return:
2234
+
2235
+ ```json
2236
+ {
2237
+ "formIdentifier": "collection_form",
2238
+ "formData": {
2239
+ "en_US": [
2240
+ {
2241
+ "marker": "naimenovanie_1",
2242
+ "type": "string",
2243
+ "value": "Name"
2244
+ }
2245
+ ]
2246
+ }
2247
+ }
1901
2248
  ```
1902
2249
 
1903
- ### GeneralTypes.getAllTypes()
2250
+ ><details>
2251
+ ><summary>Schema</summary>
2252
+ >
2253
+ >**formIdentifier:** string <br>
2254
+ >*Text identifier of the form object attached to the order storage* <br>
2255
+ >example: collection_form <br>
2256
+ >
2257
+ >**formData:** FormDataLangType <br>
2258
+ >*Data submitted by the form attached to the collection* <br>
2259
+ >example: OrderedMap { "en_US": List [ OrderedMap { "marker": "naimenovanie_1", "type": "string", "value": "Name" } ] } <br>
2260
+ >
2261
+ ></details>
2262
+
2263
+ ### IntegrationCollections.updateICollectionRow(marker, body, langCode)
1904
2264
 
1905
2265
  ```js
1906
- const value = await GeneralTypes.getAllTypes()
2266
+ const body = {
2267
+ "formIdentifier": "collection-form",
2268
+ "formData": {
2269
+ "en_US": [
2270
+ {
2271
+ "marker": "naimenovanie_1",
2272
+ "type": "string",
2273
+ "value": "Наименование"
2274
+ }
2275
+ ]
2276
+ }
2277
+ }
2278
+ const result = await IntegrationCollections.updateICollectionRow('test_collection', body);
1907
2279
  ```
1908
2280
 
1909
- > This method retrieves all objects of type GeneralTypeEntity from the API. It returns a Promise that resolves to an array of GeneralTypeEntity objects.
2281
+ > Edit a record in the collection
1910
2282
 
1911
2283
  Example return:
1912
2284
 
1913
2285
  ```json
1914
- [
1915
- {
1916
- "id": 1,
1917
- "type": "forNewsPage"
2286
+ {
2287
+ "formIdentifier": "collection_form",
2288
+ "formData": {
2289
+ "en_US": [
2290
+ {
2291
+ "marker": "naimenovanie_1",
2292
+ "type": "string",
2293
+ "value": "Name"
2294
+ }
2295
+ ]
1918
2296
  }
1919
- ]
2297
+ }
1920
2298
  ```
2299
+
1921
2300
  ><details>
1922
2301
  ><summary>Schema</summary>
1923
2302
  >
1924
- >**id:** number <br>
1925
- >*object identifier* <br>
1926
- >example: 1764 <br>
2303
+ >**formIdentifier:** string <br>
2304
+ >*Text identifier of the form object attached to the order storage* <br>
2305
+ >example: collection_form <br>
1927
2306
  >
1928
- >**type:** string <br>
1929
- >*type value* <br>
1930
- >example: forNewsPage <br>
1931
- >Enum:
1932
- >[ forCatalogProducts, forBasketPage, forErrorPage, forCatalogPages, forProductPreview, forProductPage, forSimilarProductBlock, forStatisticProductBlock, forProductBlock, forForm, forFormField, forNewsPage, forNewsBlock, forNewsPreview, forOneNewsPage, forUsualPage, forTextBlock, forSlider, service ] <br>
2307
+ >**formData:** FormDataLangType <br>
2308
+ >*Data submitted by the form attached to the collection* <br>
2309
+ >example: OrderedMap { "en_US": List [ OrderedMap { "marker": "naimenovanie_1", "type": "string", "value": "Name" } ] } <br>
1933
2310
  >
1934
2311
  ></details>
1935
2312
 
1936
- ---
2313
+ ### IntegrationCollections.deleteCollectionRowByMarker(id, marker)
2314
+
2315
+ ```js
2316
+ const result = await IntegrationCollections.deleteCollectionRowByMarker(1, 'test_collection');
2317
+ ```
1937
2318
 
2319
+ > Deletion of collection record object
2320
+
2321
+ > Returns true (in case of successful deletion) or false (in case of unsuccessful deletion) (permission "collections.row.delete" required for access)
2322
+
2323
+ ---
1938
2324
 
1939
2325
  ## <h2 id="locales"> Locales </h2>
1940
2326
 
@@ -1970,15 +2356,15 @@ Example return:
1970
2356
  ><details>
1971
2357
  ><summary >Schema</summary>
1972
2358
  >
1973
- >**id:** number <br>
2359
+ >**id:** number <br>
1974
2360
  >*object identifier* <br>
1975
2361
  >example: 1764 <br>
1976
2362
  >
1977
- >**shortCode:** string <br>
2363
+ >**shortCode:** string <br>
1978
2364
  >*language code (short)* <br>
1979
2365
  >example: en <br>
1980
2366
  >
1981
- >**code:** string <br>
2367
+ >**code:** string <br>
1982
2368
  >*language code with country code* <br>
1983
2369
  >example: en_US <br>
1984
2370
  >
@@ -1986,19 +2372,19 @@ Example return:
1986
2372
  >*Language name (in English)* <br>
1987
2373
  >example: Bengali <br>
1988
2374
  >
1989
- >**nativeName** string <br>
2375
+ >**nativeName** string <br>
1990
2376
  >*Language name (in native language)* <br>
1991
2377
  >example: বাংলা <br>
1992
2378
  >
1993
- >**isActive:** boolean <br>
2379
+ >**isActive:** boolean <br>
1994
2380
  >*Flag of usage* <br>
1995
2381
  >example: false <br>
1996
2382
  >
1997
- >**image:** string <br>
2383
+ >**image:** string <br>
1998
2384
  >*Graphic image of the language (under development)* <br>
1999
2385
  >example: 🇦🇨 <br>
2000
2386
  >
2001
- >**position:** {
2387
+ >**position:** {
2002
2388
  >description:position number
2003
2389
  >} <br>
2004
2390
  >
@@ -2006,11 +2392,8 @@ Example return:
2006
2392
 
2007
2393
  ---
2008
2394
 
2009
-
2010
-
2011
2395
  ## <h2 id="menus"> Menus </h2>
2012
2396
 
2013
-
2014
2397
  ```js
2015
2398
  const { Menus } = defineOneEntry('your-url')
2016
2399
  ```
@@ -2071,8 +2454,6 @@ Example return:
2071
2454
 
2072
2455
  ---
2073
2456
 
2074
-
2075
-
2076
2457
  ## <h2 id="orders"> Orders </h2>
2077
2458
 
2078
2459
  ```js
@@ -2088,6 +2469,7 @@ const value = await Orders.getOrderByMarker('my-order')
2088
2469
  > This method retrieves one order storage object by marker.
2089
2470
 
2090
2471
  Example return:
2472
+
2091
2473
  ```json
2092
2474
  {
2093
2475
  "id": 2,
@@ -2461,7 +2843,7 @@ Example return:
2461
2843
  ></details>
2462
2844
 
2463
2845
 
2464
- ### Orders.getAllOrdersStorage(langCode, limit, offset)
2846
+ ### Orders.getAllOrdersStorage(langCode, offset, limit)
2465
2847
 
2466
2848
  ```js
2467
2849
  const value = await Orders.getAllOrdersStorage()
@@ -2519,7 +2901,7 @@ Example return:
2519
2901
  ></details>
2520
2902
 
2521
2903
 
2522
- ### Orders.getAllOrdersByMarker(marker, langCode, limit, offset)
2904
+ ### Orders.getAllOrdersByMarker(marker, langCode, offset, limit)
2523
2905
 
2524
2906
  ```js
2525
2907
  const value = await Orders.getAllOrdersByMarker('my-order')
@@ -2632,7 +3014,6 @@ Example return:
2632
3014
 
2633
3015
  ## <h2 id="pages"> Pages </h2>
2634
3016
 
2635
-
2636
3017
  ```js
2637
3018
  const { Pages } = defineOneEntry('your-url');
2638
3019
  ```
@@ -3453,7 +3834,7 @@ Example return:
3453
3834
  const { Payments } = defineOneEntry('your-url');
3454
3835
  ```
3455
3836
 
3456
- ### Payments.getSessions(limit, offset)
3837
+ ### Payments.getSessions(offset, limit)
3457
3838
 
3458
3839
  ```js
3459
3840
  const value = await Payments.getSessions()
@@ -3883,7 +4264,6 @@ const value = await Payments.webhookStripe()
3883
4264
 
3884
4265
  ## <h2 id="products"> Products </h2>
3885
4266
 
3886
-
3887
4267
  ```js
3888
4268
  const { Products } = defineOneEntry('your-url');
3889
4269
  ```
@@ -3894,10 +4274,10 @@ Parameters:
3894
4274
 
3895
4275
  ```js
3896
4276
  const userQuery = {
3897
- offset: 0,
3898
- limit: 30,
3899
- sortOrder: 'DESC',
3900
- sortKey: 'id'
4277
+ offset: 0,
4278
+ limit: 30,
4279
+ sortOrder: 'DESC',
4280
+ sortKey: 'id'
3901
4281
  }
3902
4282
  ```
3903
4283
 
@@ -3923,22 +4303,14 @@ const userQuery = {
3923
4303
  ></details>
3924
4304
 
3925
4305
  "conditionMarker" by which values are filtered (not set by default), possible values:
3926
- > 'in' - Contains,
3927
- >
3928
- > 'nin' - Does not contain,
3929
- >
3930
- > 'eq' - Equal,
3931
- >
3932
- > 'neq' - Not equal,
3933
- >
3934
- > 'mth' - Greater than,
3935
- >
3936
- > 'lth' - Less than,
3937
- >
3938
- > 'exs' - Exists,
3939
- >
3940
- > 'nexs' - Does not exist
3941
-
4306
+ > 'in' - Contains,<br>
4307
+ > 'nin' - Does not contain,<br>
4308
+ > 'eq' - Equal,<br>
4309
+ > 'neq' - Not equal,<br>
4310
+ > 'mth' - Greater than,<br>
4311
+ > 'lth' - Less than,<br>
4312
+ > 'exs' - Exists,<br>
4313
+ > 'nexs' - Does not exist<br>
3942
4314
 
3943
4315
  ### Products.getProducts(body, langCode, userQuery)
3944
4316
 
@@ -4519,27 +4891,27 @@ Example return:
4519
4891
 
4520
4892
  ```js
4521
4893
  const body = [
4522
- {
4523
- "attributeMarker": "price",
4524
- "conditionMarker": "mth",
4525
- "statusMarker": "waiting",
4526
- "conditionValue": 1,
4527
- "pageUrls": [
4528
- "23-laminat-floorwood-maxima"
4529
- ],
4530
- "isNested": false,
4531
- "title": ""
4532
- },
4533
- {
4534
- "attributeMarker": "price",
4535
- "conditionMarker": "lth",
4536
- "conditionValue": 3,
4537
- "pageUrls": [
4538
- "23-laminat-floorwood-maxima"
4539
- ],
4540
- "isNested": false,
4541
- "title": ""
4542
- }
4894
+ {
4895
+ "attributeMarker": "price",
4896
+ "conditionMarker": "mth",
4897
+ "statusMarker": "waiting",
4898
+ "conditionValue": 1,
4899
+ "pageUrls": [
4900
+ "23-laminat-floorwood-maxima"
4901
+ ],
4902
+ "isNested": false,
4903
+ "title": ""
4904
+ },
4905
+ {
4906
+ "attributeMarker": "price",
4907
+ "conditionMarker": "lth",
4908
+ "conditionValue": 3,
4909
+ "pageUrls": [
4910
+ "23-laminat-floorwood-maxima"
4911
+ ],
4912
+ "isNested": false,
4913
+ "title": ""
4914
+ }
4543
4915
  ]
4544
4916
 
4545
4917
  const value = await Products.getProductsByPageUrl('catalog', body)
@@ -4652,7 +5024,7 @@ Example return:
4652
5024
  >
4653
5025
  >**statusLocalizeInfos:** CommonLocalizeInfos <br>
4654
5026
  >*json description of the item status object, taking into account the language* <br>
4655
- >example: { "title": "Product" <br>
5027
+ >example: { "title": "Product" } <br>
4656
5028
  >
4657
5029
  >**localizeInfos:** Record<string, any> <br>
4658
5030
  >*json description of the main page data object taking into account the language "en_US" (for example)* <br>
@@ -4715,10 +5087,10 @@ Example return:
4715
5087
  ### Products.getRelatedProductsById(id, langCode, userQuery)
4716
5088
 
4717
5089
  ```js
4718
- const value = await Products.getRelatedProductsById(1, 'en_US', {limit:20, offset:1})
5090
+ const value = await Products.getRelatedProductsById(1, 'en_US', {offset: 1, limit: 20})
4719
5091
  ```
4720
5092
 
4721
- > This method retrieves all related product page objects for a specific product based on its identifier (id) from the API. It accepts an optional userQuery parameter for additional query parameters such as limit, offset, sortOrder, and sortKey. It returns a Promise that resolves to an array of ContentIndexedProductDto objects.
5093
+ > This method retrieves all related product page objects for a specific product based on its identifier (id) from the API. It accepts an optional userQuery parameter for additional query parameters such as offset, limit, sortOrder, and sortKey. It returns a Promise that resolves to an array of ContentIndexedProductDto objects.
4722
5094
 
4723
5095
  Example return:
4724
5096
 
@@ -6194,7 +6566,7 @@ true
6194
6566
  ```
6195
6567
 
6196
6568
 
6197
- ## <h2 id="admins"> WebSocket </h2>
6569
+ ## <h2 id="ws"> WebSocket </h2>
6198
6570
 
6199
6571
  You can subscribe to events via the WebSocket to receive notifications
6200
6572