oneentry 1.0.127 → 1.0.130

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 (73) hide show
  1. package/README.md +3 -0
  2. package/dist/admins/adminsApi.d.ts +20 -20
  3. package/dist/admins/adminsApi.js +20 -20
  4. package/dist/admins/adminsInterfaces.d.ts +43 -43
  5. package/dist/attribute-sets/attributeSetsApi.d.ts +16 -16
  6. package/dist/attribute-sets/attributeSetsApi.js +16 -16
  7. package/dist/attribute-sets/attributeSetsInterfaces.d.ts +87 -85
  8. package/dist/auth-provider/authProviderApi.d.ts +127 -127
  9. package/dist/auth-provider/authProviderApi.js +127 -127
  10. package/dist/auth-provider/authProvidersInterfaces.d.ts +208 -202
  11. package/dist/base/asyncModules.d.ts +17 -17
  12. package/dist/base/asyncModules.js +39 -27
  13. package/dist/base/result.d.ts +11 -11
  14. package/dist/base/result.js +12 -16
  15. package/dist/base/stateModule.d.ts +6 -5
  16. package/dist/base/stateModule.js +15 -14
  17. package/dist/base/syncModules.d.ts +42 -37
  18. package/dist/base/syncModules.js +103 -49
  19. package/dist/base/utils.d.ts +45 -22
  20. package/dist/blocks/blocksApi.d.ts +24 -24
  21. package/dist/blocks/blocksApi.js +24 -24
  22. package/dist/blocks/blocksInterfaces.d.ts +85 -85
  23. package/dist/events/eventsApi.d.ts +11 -11
  24. package/dist/events/eventsApi.js +11 -11
  25. package/dist/events/eventsInterfaces.d.ts +23 -23
  26. package/dist/file-uploading/fileUploadingApi.d.ts +38 -38
  27. package/dist/file-uploading/fileUploadingApi.js +38 -38
  28. package/dist/file-uploading/fileUploadingInterfaces.d.ts +44 -44
  29. package/dist/forms/formsApi.d.ts +7 -7
  30. package/dist/forms/formsApi.js +7 -7
  31. package/dist/forms/formsInterfaces.d.ts +43 -31
  32. package/dist/forms-data/formsDataApi.d.ts +49 -37
  33. package/dist/forms-data/formsDataApi.js +49 -38
  34. package/dist/forms-data/formsDataInterfaces.d.ts +241 -219
  35. package/dist/general-types/generalTypesApi.d.ts +1 -1
  36. package/dist/general-types/generalTypesApi.js +1 -1
  37. package/dist/general-types/generalTypesInterfaces.d.ts +3 -3
  38. package/dist/index.d.ts +11 -10
  39. package/dist/index.js +11 -10
  40. package/dist/integration-collections/integrationCollectionsApi.d.ts +76 -80
  41. package/dist/integration-collections/integrationCollectionsApi.js +76 -80
  42. package/dist/integration-collections/integrationCollectionsInterfaces.d.ts +145 -149
  43. package/dist/locales/localesInterfaces.d.ts +8 -8
  44. package/dist/menus/menusApi.d.ts +3 -3
  45. package/dist/menus/menusApi.js +3 -3
  46. package/dist/menus/menusInterfaces.d.ts +39 -39
  47. package/dist/orders/ordersApi.d.ts +56 -56
  48. package/dist/orders/ordersApi.js +56 -56
  49. package/dist/orders/ordersInterfaces.d.ts +204 -198
  50. package/dist/pages/pagesApi.d.ts +60 -60
  51. package/dist/pages/pagesApi.js +60 -60
  52. package/dist/pages/pagesInterfaces.d.ts +133 -141
  53. package/dist/payments/paymentsApi.d.ts +15 -15
  54. package/dist/payments/paymentsApi.js +15 -15
  55. package/dist/payments/paymentsInterfaces.d.ts +58 -57
  56. package/dist/product-statuses/productStatusesApi.d.ts +7 -7
  57. package/dist/product-statuses/productStatusesApi.js +7 -7
  58. package/dist/product-statuses/productStatusesInterfaces.d.ts +21 -21
  59. package/dist/products/productsApi.d.ts +240 -240
  60. package/dist/products/productsApi.js +240 -240
  61. package/dist/products/productsInterfaces.d.ts +311 -311
  62. package/dist/system/systemApi.d.ts +10 -10
  63. package/dist/system/systemApi.js +10 -10
  64. package/dist/templates/templatesApi.d.ts +8 -8
  65. package/dist/templates/templatesApi.js +8 -8
  66. package/dist/templates/templatesInterfaces.d.ts +22 -22
  67. package/dist/templates-preview/templatesPreviewApi.d.ts +5 -5
  68. package/dist/templates-preview/templatesPreviewApi.js +5 -5
  69. package/dist/templates-preview/templatesPreviewInterfaces.d.ts +54 -54
  70. package/dist/users/usersApi.d.ts +29 -29
  71. package/dist/users/usersApi.js +29 -29
  72. package/dist/users/usersInterfaces.d.ts +77 -77
  73. package/package.json +9 -8
@@ -3,8 +3,8 @@ import type { IUploadingQuery } from '../file-uploading/fileUploadingInterfaces'
3
3
  /**
4
4
  * Interface for retrieving and posting form data in the system.
5
5
  * @interface IFormsData
6
- * @property {Function} getFormsData - Get all forms data.
7
- * @property {Function} postFormsData - Find all product page objects with pagination and multiple filtering.
6
+ * @property {Function} getFormsData - Get all forms data.
7
+ * @property {Function} postFormsData - Find all product page objects with pagination and multiple filtering.
8
8
  * @property {Function} getFormsDataByMarker - Get one object of form data by marker.
9
9
  * @description This interface defines methods for retrieving and posting form data in the system.
10
10
  */
@@ -12,10 +12,10 @@ interface IFormsData {
12
12
  /**
13
13
  * Retrieves all forms data.
14
14
  * @handleName getFormsData
15
- * @param {string} langCode - The language code for localization. Default: "en_US".
16
- * @param {number} [offset] - Optional offset for pagination. Default: 0.
17
- * @param {number} [limit] - Optional limit for pagination. Default: 30.
18
- * @returns {IFormsDataEntity} A promise that resolves to a collection of form data entities or an error.
15
+ * @param {string} langCode - The language code for localization. Default: "en_US".
16
+ * @param {number} [offset] - Optional offset for pagination. Default: 0.
17
+ * @param {number} [limit] - Optional limit for pagination. Default: 30.
18
+ * @returns {IFormsDataEntity} A promise that resolves to a collection of form data entities or an error.
19
19
  * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
20
20
  * @description This method retrieves all forms data.
21
21
  */
@@ -23,31 +23,35 @@ interface IFormsData {
23
23
  /**
24
24
  * Creating an object of data save information by form
25
25
  * @handleName postFormsData
26
- * @param {IBodyPostFormData} body - Request body. Example:
27
- {
28
- "formIdentifier": "form",
29
- "formData": [
30
- {
31
- "marker": "name",
32
- "type": "string",
33
- "value": "Jack"
34
- }
35
- ]
36
- }
37
- * @param {string} body.formIdentifier - The identifier for the form. Example: "form".
38
- * @param {FormDataType[]} body.formData - Example:
39
- [
40
- {
41
- "marker": "name",
42
- "type": "string",
43
- "value": "Jack"
44
- }
45
- ]
46
- * @param {string} body.formData.marker - The marker identifying the form field. Example: "name".
47
- * @param {string} body.formData.type - The type of the form field. Example: "string".
48
- * @param {string} body.formData.value - The value of the form field. Example: "Jack".
49
- * @param {string} [langCode] - Language code. Default: "en_US".
50
- * @returns {IPostFormResponse} Returns an object containing the created form data entry and message.
26
+ * @param {IBodyPostFormData} body - Request body. Example:
27
+ {
28
+ "formIdentifier": "test-form",
29
+ "formModuleConfigId": 2,
30
+ "moduleEntityIdentifier": "blog",
31
+ "replayTo": null,
32
+ "status": "sent",
33
+ "formData": [
34
+ {
35
+ "marker": "name",
36
+ "type": "string",
37
+ "value": "Test"
38
+ }
39
+ ]
40
+ }
41
+ * @param {string} body.formIdentifier - The identifier for the form. Example: "form".
42
+ * @param {FormDataType[]} body.formData - Form data. Example:
43
+ [
44
+ {
45
+ "marker": "name",
46
+ "type": "string",
47
+ "value": "Jack"
48
+ }
49
+ ]
50
+ * @param {string} body.formData.marker - The marker identifying the form field. Example: "name".
51
+ * @param {string} body.formData.type - The type of the form field. Example: "string".
52
+ * @param {string} body.formData.value - The value of the form field. Example: "Jack".
53
+ * @param {string} [langCode] - Language code. Default: "en_US".
54
+ * @returns {IPostFormResponse} Returns an object containing the created form data entry and message.
51
55
  * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
52
56
  * @description This method requires user authorization. For more information about configuring the authorization module, see the documentation in the configuration settings section of the SDK.
53
57
  */
@@ -55,21 +59,21 @@ interface IFormsData {
55
59
  /**
56
60
  * Retrieves form data by its marker.
57
61
  * @handleName getFormsDataByMarker
58
- * @param {string} marker - The marker identifying the form data. Example: "contact_form_data".
59
- * @param {number} formModuleConfigId - The form module configuration ID. Example: 4.
60
- * @param {object} [body] - Request body. Default: {}. Example:
61
- {
62
- "entityIdentifier": "test",
63
- "userIdentifier": "",
64
- "status": "",
65
- "dateFrom": "2025-08-11",
66
- "dateTo": ""
67
- }
68
- * @param {any} [isNested] - Flag for getting hierarchical data. Example: 1.
69
- * @param {string} [langCode] - The language code for localization. Default: "en_US".
70
- * @param {number} [offset] - Optional offset for pagination. Default: 0.
71
- * @param {number} [limit] - Optional limit for pagination. Default: 30.
72
- * @returns {IFormsByMarkerDataEntity} A promise that resolves to a form data entity or an error.
62
+ * @param {string} marker - The marker identifying the form data. Example: "contact_form_data".
63
+ * @param {number} formModuleConfigId - The form module configuration ID. Example: 4.
64
+ * @param {object} [body] - Request body. Default: {}. Example:
65
+ {
66
+ "entityIdentifier": "test",
67
+ "userIdentifier": "",
68
+ "status": "",
69
+ "dateFrom": "2025-08-11",
70
+ "dateTo": ""
71
+ }
72
+ * @param {any} [isNested] - Flag for getting hierarchical data. Example: 1.
73
+ * @param {string} [langCode] - The language code for localization. Default: "en_US".
74
+ * @param {number} [offset] - Optional offset for pagination. Default: 0.
75
+ * @param {number} [limit] - Optional limit for pagination. Default: 30.
76
+ * @returns {IFormsByMarkerDataEntity} A promise that resolves to a form data entity or an error.
73
77
  * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
74
78
  * @description This method retrieves form data by its marker.
75
79
  */
@@ -78,19 +82,19 @@ interface IFormsData {
78
82
  /**
79
83
  * Represents the structure of a form data entity.
80
84
  * @interface IFormDataEntity
81
- * @property {number} id - The unique identifier of the form page. Example: 12345.
82
- * @property {string} formIdentifier - The identifier of the page. Example: "contact_form".
83
- * @property {Date | string} time - The identifier of the form. Example: "2023-10-01T12:00:00Z".
84
- * @property {FormDataType[]} formData - Form data. Example:
85
- [
86
- {
87
- "marker": "name",
88
- "type": "string",
89
- "value": "Test"
90
- }
91
- ]
92
- * @property {string | null} [attributeSetIdentifier] - Text identifier (marker) of the used attribute set. Example: "product_attributes".
93
- * @property {string | null} [actionMessage] - Action message for the form data. Example: "Form submitted successfully".
85
+ * @property {number} id - The unique identifier of the form page. Example: 12345.
86
+ * @property {string} formIdentifier - The identifier of the page. Example: "contact_form".
87
+ * @property {Date | string} time - The identifier of the form. Example: "2023-10-01T12:00:00Z".
88
+ * @property {FormDataType[]} formData - Form data. Example:
89
+ [
90
+ {
91
+ "marker": "name",
92
+ "type": "string",
93
+ "value": "Test"
94
+ }
95
+ ]
96
+ * @property {string | null} [attributeSetIdentifier] - Text identifier (marker) of the used attribute set. Example: "product_attributes".
97
+ * @property {string | null} [actionMessage] - Action message for the form data. Example: "Form submitted successfully".
94
98
  * @description This interface defines the structure of a form data entity, including its identifiers, form data, and optional attributes.
95
99
  */
96
100
  interface IFormDataEntity {
@@ -105,18 +109,18 @@ interface IFormDataEntity {
105
109
  * Represents a collection of form data entities.
106
110
  * @interface IFormsDataEntity
107
111
  * @property {IFormDataEntity[]} items - Array of form data objects. Example:
108
- [
109
- {
110
- "id": 1,
111
- "formIdentifier": "form",
112
- "time": "2025-06-06T19:07:45.993Z",
113
- "formData": {},
114
- "attributeSetIdentifier": "form",
115
- "actionMessage": "Action message string"
116
- }
117
- ]
112
+ [
113
+ {
114
+ "id": 1,
115
+ "formIdentifier": "form",
116
+ "time": "2025-06-06T19:07:45.993Z",
117
+ "formData": {},
118
+ "attributeSetIdentifier": "form",
119
+ "actionMessage": "Action message string"
120
+ }
121
+ ]
118
122
  * @description This interface defines the structure of a collection of form data entities, including a total count and an array of items.
119
- * @property {number} total - Total number of found records. Example: 100.
123
+ * @property {number} total - Total number of found records. Example: 100.
120
124
  */
121
125
  interface IFormsDataEntity {
122
126
  items: IFormDataEntity[];
@@ -125,26 +129,26 @@ interface IFormsDataEntity {
125
129
  /**
126
130
  * Represents the structure of a form data entity.
127
131
  * @interface IFormByMarkerDataEntity
128
- * @property {number} id - The unique identifier of the form page. Example: 12345.
129
- * @property {null | number} parentId - The unique identifier of the parent form page. Example: 123.
130
- * @property {string} formIdentifier - The identifier of the page. Example: "contact_form".
131
- * @property {number} depth - Example: 1.
132
- * @property {string | null} [ip] - Ip. Example: '127.0.0.1'.
133
- * @property {string | null} [status] - Status. Example: 'approved'.
134
- * @property {string | null} [userIdentifier] - Text identifier (marker) of the user. Example: "admin".
135
- * @property {FormDataType[]} formData - Form data. Example:
136
- [
137
- {
138
- "marker": "name",
139
- "type": "string",
140
- "value": "Test"
141
- }
142
- ]
143
- * @property {string | null} [attributeSetIdentifier] - Text identifier (marker) of the used attribute set. Example: "product_attributes".
144
- * @property {Date | string} time - The identifier of the form. Example: "2023-10-01T12:00:00Z".
145
- * @property {string} [entityIdentifier] - Text identifier (marker) of the entity. Example: "test".
146
- * @property {boolean} [isUserAdmin] - Is user admin. Example: true.
147
- * @property {number} [formModuleConfigId] - Form module config Id. Example: 2.
132
+ * @property {number} id - The unique identifier of the form page. Example: 12345.
133
+ * @property {null | number} parentId - The unique identifier of the parent form page. Example: 123.
134
+ * @property {string} formIdentifier - The identifier of the page. Example: "contact_form".
135
+ * @property {number} depth - Example: 1.
136
+ * @property {string | null} [ip] - Ip. Example: '127.0.0.1'.
137
+ * @property {string | null} [status] - Status. Example: 'approved'.
138
+ * @property {string | null} [userIdentifier] - Text identifier (marker) of the user. Example: "admin".
139
+ * @property {FormDataType[]} formData - Form data. Example:
140
+ [
141
+ {
142
+ "marker": "name",
143
+ "type": "string",
144
+ "value": "Test"
145
+ }
146
+ ]
147
+ * @property {string | null} [attributeSetIdentifier] - Text identifier (marker) of the used attribute set. Example: "product_attributes".
148
+ * @property {Date | string} time - The identifier of the form. Example: "2023-10-01T12:00:00Z".
149
+ * @property {string} [entityIdentifier] - Text identifier (marker) of the entity. Example: "test".
150
+ * @property {boolean} [isUserAdmin] - Is user admin. Example: true.
151
+ * @property {number} [formModuleConfigId] - Form module config Id. Example: 2.
148
152
  * @description This interface defines the structure of a form data entity, including its identifiers, form data, and optional attributes.
149
153
  */
150
154
  interface IFormByMarkerDataEntity {
@@ -166,30 +170,30 @@ interface IFormByMarkerDataEntity {
166
170
  * Represents a collection of form data entities.
167
171
  * @interface IFormsByMarkerDataEntity
168
172
  * @property {IFormByMarkerDataEntity[]} items - Array of form data objects. Example:
169
- [
170
- {
171
- "id": 42,
172
- "parentId": null,
173
- "formIdentifier": "test-form",
174
- "depth": 0,
175
- "ip": null,
176
- "status": null,
177
- "userIdentifier": null,
178
- "formData": [
179
- {
180
- "marker": "name",
181
- "type": "string",
182
- "value": "Test"
183
- }
184
- ],
185
- "attributeSetIdentifier": "form",
186
- "time": "2025-03-03T15:51:17.458Z",
187
- "entityIdentifier": "blog",
188
- "isUserAdmin": false,
189
- "formModuleConfigId": 2
190
- }
191
- ]
192
- * @property {number} total - Total number of found records. Example: 100.
173
+ [
174
+ {
175
+ "id": 42,
176
+ "parentId": null,
177
+ "formIdentifier": "test-form",
178
+ "depth": 0,
179
+ "ip": null,
180
+ "status": null,
181
+ "userIdentifier": null,
182
+ "formData": [
183
+ {
184
+ "marker": "name",
185
+ "type": "string",
186
+ "value": "Test"
187
+ }
188
+ ],
189
+ "attributeSetIdentifier": "form",
190
+ "time": "2025-03-03T15:51:17.458Z",
191
+ "entityIdentifier": "blog",
192
+ "isUserAdmin": false,
193
+ "formModuleConfigId": 2
194
+ }
195
+ ]
196
+ * @property {number} total - Total number of found records. Example: 100.
193
197
  * @description This interface defines the structure of a collection of form data entities, including a total count and an array of items.
194
198
  */
195
199
  interface IFormsByMarkerDataEntity {
@@ -199,24 +203,41 @@ interface IFormsByMarkerDataEntity {
199
203
  /**
200
204
  * Represents the structure of the response after posting form data.
201
205
  * @interface IPostFormResponse
202
- * @property {string} actionMessage - Action message for the form data. Example: "Form submitted successfully".
203
- * @property {object} formData - Form data. Example:
204
- * @property {number} formData.id - The unique identifier of the form page. Example: 12345.
205
- * @property {string} formData.formIdentifier - The identifier of the form. Example: "contact_form".
206
- * @property {string} formData.time - The time of the form submit. Example: "2023-10-01T12:00:00Z".
207
- * @property {string} formData.entityIdentifier - The entity identifier. Example: "blog".
208
- * @property {boolean} formData.isUserAdmin - Is user admin. Example: false.
209
- * @property {number} formData.formModuleId - The form module identifier. Example: 2.
210
- * @property {any} formData.parentId - The parent identifier. Example: null.
211
- * @property {any} formData.userIdentifier - The user identifier. Example: null.
212
- * @property {FormDataType[]} formData.formData - Form fields data. Example:
213
- [
214
- {
215
- "marker": "name",
216
- "type": "string",
217
- "value": "Jack"
218
- }
219
- ]
206
+ * @property {string} actionMessage - Action message for the form data. Example: "Form submitted successfully".
207
+ * @property {object} formData - Form data. Example:
208
+ {
209
+ "id": 42,
210
+ "formIdentifier": "contact_form",
211
+ "time": "2023-10-01T12:00:00Z",
212
+ "entityIdentifier": "blog",
213
+ "isUserAdmin": false,
214
+ "formModuleId": 2,
215
+ "parentId": null,
216
+ "userIdentifier": null,
217
+ "formData": [
218
+ {
219
+ "marker": "name",
220
+ "type": "string",
221
+ "value": "Jack"
222
+ }
223
+ ]
224
+ }
225
+ * @property {number} formData.id - The unique identifier of the form page. Example: 12345.
226
+ * @property {string} formData.formIdentifier - The identifier of the form. Example: "contact_form".
227
+ * @property {string} formData.time - The time of the form submit. Example: "2023-10-01T12:00:00Z".
228
+ * @property {string} formData.entityIdentifier - The entity identifier. Example: "blog".
229
+ * @property {boolean} formData.isUserAdmin - Is user admin. Example: false.
230
+ * @property {number} formData.formModuleId - The form module identifier. Example: 2.
231
+ * @property {any} formData.parentId - The parent identifier. Example: null.
232
+ * @property {any} formData.userIdentifier - The user identifier. Example: null.
233
+ * @property {FormDataType[]} formData.formData - Form fields data. Example:
234
+ [
235
+ {
236
+ "marker": "name",
237
+ "type": "string",
238
+ "value": "Jack"
239
+ }
240
+ ]
220
241
  */
221
242
  interface IPostFormResponse {
222
243
  actionMessage: string;
@@ -225,6 +246,7 @@ interface IPostFormResponse {
225
246
  formIdentifier: string;
226
247
  time: string;
227
248
  entityIdentifier: string;
249
+ fingerprint: string;
228
250
  isUserAdmin: boolean;
229
251
  formModuleId: number;
230
252
  userIdentifier: any;
@@ -239,28 +261,28 @@ type FormDataType = IBodyTypeStringNumberFloat | IBodyTypeTimeDate | IBodyTypeTe
239
261
  /**
240
262
  * Represents the structure of the body for posting form data.
241
263
  * @interface IBodyPostFormData
242
- * @property {string} formIdentifier - Text identifier (marker) of the form. Example: "form".
243
- * @property {number} formModuleConfigId - The unique identifier of the form module configuration. Example: 2.
244
- * @property {string} moduleEntityIdentifier - Text identifier (marker) of the module entity. Example: "blog".
245
- * @property {string | null} replayTo - Email to reply to. Example: "some@email.com".
246
- * @property {string} status - Status of the form. Example: "sent".
247
- * @property {FormDataType[]} formData - Array of form data objects. Example:
248
- [
249
- {
250
- "marker": "name",
251
- "type": "string",
252
- "value": "Jack"
253
- }
254
- ]
255
- * @property {string} formData[index].marker - The marker identifying the form field. Example: "name".
256
- * @property {string} formData[index].type - The type of the form field. Example: "string".
257
- * @property {string} formData[index].value - The value of the form field. Example: "name".
258
- * @property {IUploadingQuery} [fileQuery] - Optional file query for uploading files. Example:
259
- {
260
- "type": "page",
261
- "entity": "editor",
262
- "id": 3787
263
- }
264
+ * @property {string} formIdentifier - Text identifier (marker) of the form. Example: "form".
265
+ * @property {number} formModuleConfigId - The unique identifier of the form module configuration. Example: 2.
266
+ * @property {string} moduleEntityIdentifier - Text identifier (marker) of the module entity. Example: "blog".
267
+ * @property {string | null} replayTo - Email to reply to. Example: "some@email.com".
268
+ * @property {string} status - Status of the form. Example: "sent".
269
+ * @property {FormDataType[]} formData - Array of form data objects. Example:
270
+ [
271
+ {
272
+ "marker": "name",
273
+ "type": "string",
274
+ "value": "Jack"
275
+ }
276
+ ]
277
+ * @property {string} formData[index].marker - The marker identifying the form field. Example: "name".
278
+ * @property {string} formData[index].type - The type of the form field. Example: "string".
279
+ * @property {string} formData[index].value - The value of the form field. Example: "name".
280
+ * @property {IUploadingQuery} [fileQuery] - Optional file query for uploading files. Example:
281
+ {
282
+ "type": "page",
283
+ "entity": "editor",
284
+ "id": 3787
285
+ }
264
286
  * @description This interface defines the structure of a form post object, including its identifiers, time, form data, and optional file query.
265
287
  */
266
288
  interface IBodyPostFormData {
@@ -276,8 +298,8 @@ interface IBodyPostFormData {
276
298
  * Represents a form data entity with a simple value.
277
299
  * @interface IBodyTypeStringNumberFloat
278
300
  * @property {string} marker - marker name. Example: "some_marker".
279
- * @property {string} type - Type value. "string" | "number" | "float". Example: "string".
280
- * @property {string} value - Value of the form data entity, which can be a "string", "number", or "float". Example: "string".
301
+ * @property {string} type - Type value. "string" | "number" | "float". Example: "string".
302
+ * @property {string} value - Value of the form data entity, which can be a "string", "number", or "float". Example: "string".
281
303
  * @description Represents a form data entity with a marker, type, and value.
282
304
  */
283
305
  interface IBodyTypeStringNumberFloat {
@@ -289,13 +311,13 @@ interface IBodyTypeStringNumberFloat {
289
311
  * Represents a date/time form data entity.
290
312
  * @interface IBodyTypeTimeDate
291
313
  * @property {string} marker - marker name. Example: "ome_marker".
292
- * @property {string} type - Type value. 'date' | 'dateTime' | 'time' Example: "date".
293
- * @property {object} value - Date object. Contains fullDate, formattedValue, formatString. Example:
294
- {
295
- "fullDate": "2024-05-07T21:02:00.000Z",
296
- "formattedValue": "08-05-2024 00:02",
297
- "formatString": "DD-MM-YYYY HH:mm"
298
- }
314
+ * @property {string} type - Type value. 'date' | 'dateTime' | 'time' Example: "date".
315
+ * @property {object} value - Date object. Contains fullDate, formattedValue, formatString. Example:
316
+ {
317
+ "fullDate": "2024-05-07T21:02:00.000Z",
318
+ "formattedValue": "08-05-2024 00:02",
319
+ "formatString": "DD-MM-YYYY HH:mm"
320
+ }
299
321
  * @description Represents a date, dateTime, or time value in a structured format.
300
322
  */
301
323
  interface IBodyTypeTimeDate {
@@ -311,16 +333,16 @@ interface IBodyTypeTimeDate {
311
333
  * Represents a text form data entity.
312
334
  * @interface IBodyTypeText
313
335
  * @property {string} marker - marker name. Example: "some_marker".
314
- * @property {string} type - Type value. Example: "text".
315
- * @property {object} value - Text Object. Contains html as string, plain text and params. Example:
316
- {
317
- "htmlValue": "<p>Hello world</p>",
318
- "plainValue": "",
319
- "params": {
320
- "isEditorDisabled": false,
321
- "isImageCompressed": true
322
- }
323
- }
336
+ * @property {string} type - Type value. Example: "text".
337
+ * @property {object} value - Text Object. Contains html as string, plain text and params. Example:
338
+ {
339
+ "htmlValue": "<p>Hello world</p>",
340
+ "plainValue": "",
341
+ "params": {
342
+ "isEditorDisabled": false,
343
+ "isImageCompressed": true
344
+ }
345
+ }
324
346
  * @description Represents a text value with HTML and plain text representations, along with parameters for editor and image compression settings.
325
347
  */
326
348
  interface IBodyTypeText {
@@ -339,17 +361,17 @@ interface IBodyTypeText {
339
361
  * Represents a text with header form data entity.
340
362
  * @interface IBodyTypeTextWithHeader
341
363
  * @property {string} marker - marker name. Example: "about".
342
- * @property {string} type - Type value. Example: "textWithHeader".
343
- * @property {object} value - Text Object. Contains html as string, header and params. Example:
344
- {
345
- "header": "Headline",
346
- "htmlValue": "<p>Hello World</p>",
347
- "plainValue": "",
348
- "params": {
349
- "isEditorDisabled": false,
350
- "isImageCompressed": true
351
- }
352
- }
364
+ * @property {string} type - Type value. Example: "textWithHeader".
365
+ * @property {object} value - Text Object. Contains html as string, header and params. Example:
366
+ {
367
+ "header": "Headline",
368
+ "htmlValue": "<p>Hello World</p>",
369
+ "plainValue": "",
370
+ "params": {
371
+ "isEditorDisabled": false,
372
+ "isImageCompressed": true
373
+ }
374
+ }
353
375
  * @description Represents a text value with a header, HTML and plain text representations, along with parameters for editor and image compression settings.
354
376
  */
355
377
  interface IBodyTypeTextWithHeader {
@@ -368,20 +390,20 @@ interface IBodyTypeTextWithHeader {
368
390
  /**
369
391
  * Represents an image or group of images form data entity.
370
392
  * @interface IBodyTypeImageGroupOfImages
371
- * @property {string} marker - marker name. Example: "avatar".
372
- * @property {'image' | 'groupOfImage'} type - Type value. Example: "image".
373
- * @property {object} value - Image Object. Contains image information. Example:
374
- [
375
- {
376
- "filename": "files/project/page/10/image/Screenshot-from-2024-05-02-15-23-14.png",
377
- "downloadLink": "http://my-site.com/cloud-static/files/project/page/10/image/Screenshot-from-2024-05-02-15-23-14.png",
378
- "size": 392585,
379
- "previewLink": "",
380
- "params": {
381
- "isImageCompressed": true
382
- }
383
- }
384
- ]
393
+ * @property {string} marker - marker name. Example: "avatar".
394
+ * @property {'image' | 'groupOfImage'} type - Type value. Example: "image".
395
+ * @property {object} value - Image Object. Contains image information. Example:
396
+ [
397
+ {
398
+ "filename": "files/project/page/10/image/Screenshot-from-2024-05-02-15-23-14.png",
399
+ "downloadLink": "http://my-site.com/cloud-static/files/project/page/10/image/Screenshot-from-2024-05-02-15-23-14.png",
400
+ "size": 392585,
401
+ "previewLink": "",
402
+ "params": {
403
+ "isImageCompressed": true
404
+ }
405
+ }
406
+ ]
385
407
  * @description Represents an image or a group of images with their details, including filename, download link, size, preview link, and parameters for image compression.
386
408
  */
387
409
  interface IBodyTypeImageGroupOfImages {
@@ -409,15 +431,15 @@ interface IBodyTypeImageGroupOfImages {
409
431
  * Represents a file form data entity.
410
432
  * @interface IBodyTypeFile
411
433
  * @property {string} marker - marker name. Example: "picture".
412
- * @property {'file'} type - Type value. Example: "file".
413
- * @property {object} value - File Object. Contains file information. Example:
414
- [
415
- {
416
- "filename": "files/project/page/10/image/Screenshot-from-2024-05-02-15-23-14.png",
417
- "downloadLink": "http://my-site.com/cloud-static/files/project/page/10/image/Screenshot-from-2024-05-02-15-23-14.png",
418
- "size": 392585
419
- }
420
- ]
434
+ * @property {'file'} type - Type value. Example: "file".
435
+ * @property {object} value - File Object. Contains file information. Example:
436
+ [
437
+ {
438
+ "filename": "files/project/page/10/image/Screenshot-from-2024-05-02-15-23-14.png",
439
+ "downloadLink": "http://my-site.com/cloud-static/files/project/page/10/image/Screenshot-from-2024-05-02-15-23-14.png",
440
+ "size": 392585
441
+ }
442
+ ]
421
443
  * @description Represents a file with its details, including filename, download link, and size.
422
444
  */
423
445
  interface IBodyTypeFile {
@@ -433,18 +455,18 @@ interface IBodyTypeFile {
433
455
  * Represents a radio button or list selection form data entity.
434
456
  * @interface IBodyTypeRadioButtonList
435
457
  * @property {string} marker - marker name. Example: "selector".
436
- * @property {string} type - Type value. Example: 'list'.
437
- * @property {Array} value - Array of list or radioButton bojects. Example:
438
- [
439
- {
440
- "title": "red",
441
- "value": "1",
442
- "extended": {
443
- "value": "red",
444
- "type": "string"
445
- }
446
- }
447
- ]
458
+ * @property {string} type - Type value. Example: 'list'.
459
+ * @property {Array} value - Array of list or radioButton bojects. Example:
460
+ [
461
+ {
462
+ "title": "red",
463
+ "value": "1",
464
+ "extended": {
465
+ "value": "red",
466
+ "type": "string"
467
+ }
468
+ }
469
+ ]
448
470
  * @description Represents a list or radio button selection with multiple options, each containing a title, value, and extended information.
449
471
  */
450
472
  interface IBodyTypeRadioButtonList {
@@ -14,7 +14,7 @@ export default class GeneralTypesApi extends AsyncModules implements IGeneralTyp
14
14
  protected state: StateModule;
15
15
  protected _url: string;
16
16
  /**
17
- *
17
+ * Constructor for the GeneralTypesApi class.
18
18
  */
19
19
  constructor(state: StateModule);
20
20
  /**
@@ -14,7 +14,7 @@ const asyncModules_1 = __importDefault(require("../base/asyncModules"));
14
14
  */
15
15
  class GeneralTypesApi extends asyncModules_1.default {
16
16
  /**
17
- *
17
+ * Constructor for the GeneralTypesApi class.
18
18
  */
19
19
  constructor(state) {
20
20
  super(state);
@@ -1,5 +1,5 @@
1
- import type { BlockType } from 'blocks/blocksInterfaces';
2
1
  import type { IError } from '../base/utils';
2
+ import type { BlockType } from '../blocks/blocksInterfaces';
3
3
  /**
4
4
  * Interface for retrieving all general types in the system.
5
5
  * @interface IGeneralTypes
@@ -19,9 +19,9 @@ interface IGeneralTypes {
19
19
  /**
20
20
  * Represents a general type entity.
21
21
  * @interface IGeneralTypesEntity
22
+ * @property {number} id - Type id. Example: 1.
23
+ * @property {Types} type - Types enum. Example: "product", "category", "etc".
22
24
  * @description Represents a general type entity with an identifier and a type.
23
- * @property {number} id - Type id. Example: 1.
24
- * @property {Types} type - Types enum. Example: "product", "category", "etc".
25
25
  */
26
26
  interface IGeneralTypesEntity {
27
27
  id: number;