oneentry 1.0.127 → 1.0.128
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/admins/adminsApi.d.ts +20 -20
- package/dist/admins/adminsApi.js +20 -20
- package/dist/admins/adminsInterfaces.d.ts +43 -43
- package/dist/attribute-sets/attributeSetsApi.d.ts +16 -16
- package/dist/attribute-sets/attributeSetsApi.js +16 -16
- package/dist/attribute-sets/attributeSetsInterfaces.d.ts +87 -85
- package/dist/auth-provider/authProviderApi.d.ts +126 -126
- package/dist/auth-provider/authProviderApi.js +126 -126
- package/dist/auth-provider/authProvidersInterfaces.d.ts +201 -201
- package/dist/base/asyncModules.d.ts +17 -17
- package/dist/base/asyncModules.js +26 -21
- package/dist/base/result.d.ts +5 -5
- package/dist/base/result.js +5 -9
- package/dist/base/stateModule.d.ts +1 -1
- package/dist/base/stateModule.js +1 -1
- package/dist/base/syncModules.d.ts +35 -35
- package/dist/base/syncModules.js +92 -45
- package/dist/base/utils.d.ts +13 -13
- package/dist/blocks/blocksApi.d.ts +24 -24
- package/dist/blocks/blocksApi.js +24 -24
- package/dist/blocks/blocksInterfaces.d.ts +85 -85
- package/dist/events/eventsApi.d.ts +11 -11
- package/dist/events/eventsApi.js +11 -11
- package/dist/events/eventsInterfaces.d.ts +23 -23
- package/dist/file-uploading/fileUploadingApi.d.ts +38 -38
- package/dist/file-uploading/fileUploadingApi.js +38 -38
- package/dist/file-uploading/fileUploadingInterfaces.d.ts +44 -44
- package/dist/forms/formsApi.d.ts +7 -7
- package/dist/forms/formsApi.js +7 -7
- package/dist/forms/formsInterfaces.d.ts +43 -31
- package/dist/forms-data/formsDataApi.d.ts +37 -37
- package/dist/forms-data/formsDataApi.js +37 -38
- package/dist/forms-data/formsDataInterfaces.d.ts +219 -219
- package/dist/general-types/generalTypesApi.d.ts +1 -1
- package/dist/general-types/generalTypesApi.js +1 -1
- package/dist/general-types/generalTypesInterfaces.d.ts +2 -2
- package/dist/index.d.ts +10 -10
- package/dist/index.js +10 -10
- package/dist/integration-collections/integrationCollectionsApi.d.ts +76 -80
- package/dist/integration-collections/integrationCollectionsApi.js +76 -80
- package/dist/integration-collections/integrationCollectionsInterfaces.d.ts +145 -149
- package/dist/locales/localesInterfaces.d.ts +8 -8
- package/dist/menus/menusApi.d.ts +3 -3
- package/dist/menus/menusApi.js +3 -3
- package/dist/menus/menusInterfaces.d.ts +39 -39
- package/dist/orders/ordersApi.d.ts +56 -56
- package/dist/orders/ordersApi.js +56 -56
- package/dist/orders/ordersInterfaces.d.ts +204 -198
- package/dist/pages/pagesApi.d.ts +60 -60
- package/dist/pages/pagesApi.js +60 -60
- package/dist/pages/pagesInterfaces.d.ts +133 -141
- package/dist/payments/paymentsApi.d.ts +15 -15
- package/dist/payments/paymentsApi.js +15 -15
- package/dist/payments/paymentsInterfaces.d.ts +55 -55
- package/dist/product-statuses/productStatusesApi.d.ts +7 -7
- package/dist/product-statuses/productStatusesApi.js +7 -7
- package/dist/product-statuses/productStatusesInterfaces.d.ts +21 -21
- package/dist/products/productsApi.d.ts +240 -240
- package/dist/products/productsApi.js +240 -240
- package/dist/products/productsInterfaces.d.ts +311 -311
- package/dist/system/systemApi.d.ts +10 -10
- package/dist/system/systemApi.js +10 -10
- package/dist/templates/templatesApi.d.ts +8 -8
- package/dist/templates/templatesApi.js +8 -8
- package/dist/templates/templatesInterfaces.d.ts +22 -22
- package/dist/templates-preview/templatesPreviewApi.d.ts +5 -5
- package/dist/templates-preview/templatesPreviewApi.js +5 -5
- package/dist/templates-preview/templatesPreviewInterfaces.d.ts +54 -54
- package/dist/users/usersApi.d.ts +29 -29
- package/dist/users/usersApi.js +29 -29
- package/dist/users/usersInterfaces.d.ts +77 -77
- package/package.json +1 -1
|
@@ -1,14 +1,14 @@
|
|
|
1
1
|
import type { IError, ILocalizeInfo } from '../base/utils';
|
|
2
2
|
/**
|
|
3
3
|
* @interface ICollectionsApi
|
|
4
|
-
* @property {Function} getICollections
|
|
5
|
-
* @property {Function} getICollectionById
|
|
6
|
-
* @property {Function} getICollectionRowsById
|
|
7
|
-
* @property {Function} validateICollectionMarker
|
|
8
|
-
* @property {Function} getICollectionRowsByMarker
|
|
9
|
-
* @property {Function} getICollectionRowByMarkerAndId
|
|
10
|
-
* @property {Function} createICollectionRow
|
|
11
|
-
* @property {Function} updateICollectionRow
|
|
4
|
+
* @property {Function} getICollections - Get all collections.
|
|
5
|
+
* @property {Function} getICollectionById - Get a single collection object.
|
|
6
|
+
* @property {Function} getICollectionRowsById - Get all records belonging to the collection by collection id.
|
|
7
|
+
* @property {Function} validateICollectionMarker - Check for the existence of a text identifier (marker).
|
|
8
|
+
* @property {Function} getICollectionRowsByMarker - Getting all records (row) from the collection.
|
|
9
|
+
* @property {Function} getICollectionRowByMarkerAndId - Getting one record (rows) from the collection.
|
|
10
|
+
* @property {Function} createICollectionRow - Create a record (row) in the collection.
|
|
11
|
+
* @property {Function} updateICollectionRow - Edit a record (row) in the collection.
|
|
12
12
|
* @property {Function} deleteICollectionRowByMarkerAndId - Deletion of collection record object (row).
|
|
13
13
|
* @description This interface defines methods for managing collections and their records in the system.
|
|
14
14
|
*/
|
|
@@ -16,19 +16,19 @@ interface ICollectionsApi {
|
|
|
16
16
|
/**
|
|
17
17
|
* Get all collections.
|
|
18
18
|
* @handleName getICollections
|
|
19
|
-
* @param
|
|
20
|
-
* @param
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
* @param
|
|
28
|
-
* @param
|
|
29
|
-
* @param
|
|
30
|
-
* @param
|
|
31
|
-
* @returns {ICollectionEntity[]}
|
|
19
|
+
* @param {string} [langCode] - Language code. Default: "en_US".
|
|
20
|
+
* @param {any} [userQuery] - Query parameters. Example:
|
|
21
|
+
{
|
|
22
|
+
"limit": 30,
|
|
23
|
+
"offset": 0,
|
|
24
|
+
"entityType": "orders",
|
|
25
|
+
"entityId": 1
|
|
26
|
+
}
|
|
27
|
+
* @param {number} [userQuery.limit] - Parameter for pagination. Default: 0.
|
|
28
|
+
* @param {number} [userQuery.offset] - Parameter for pagination. Default: 30.
|
|
29
|
+
* @param {string} [userQuery.entityType] - Entity type. Example: "orders".
|
|
30
|
+
* @param {number} [userQuery.entityId] - Entity identifier. Example: 1.
|
|
31
|
+
* @returns {ICollectionEntity[]} Returns an array of ICollection objects or an error object if there was an issue.
|
|
32
32
|
* @throws {IError} - If there is an error during the fetch operation, it will return an error object.
|
|
33
33
|
* @description This method gets all collections.
|
|
34
34
|
*/
|
|
@@ -41,9 +41,9 @@ interface ICollectionsApi {
|
|
|
41
41
|
/**
|
|
42
42
|
* Get a single collection object by id.
|
|
43
43
|
* @handleName getICollectionById
|
|
44
|
-
* @param
|
|
45
|
-
* @param
|
|
46
|
-
* @returns {ICollectionEntity}
|
|
44
|
+
* @param {number} id - Collection id. Example: 1.
|
|
45
|
+
* @param {string} [langCode] - Language code. Default: "en_US".
|
|
46
|
+
* @returns {ICollectionEntity} Returns an ICollection object or an error object if there was an issue.
|
|
47
47
|
* @throws {IError} - If there is an error during the fetch operation, it will return an error object.
|
|
48
48
|
* @description This method gets a single collection object by id.
|
|
49
49
|
*/
|
|
@@ -51,20 +51,20 @@ interface ICollectionsApi {
|
|
|
51
51
|
/**
|
|
52
52
|
* Get all records belonging to the collection by collection id.
|
|
53
53
|
* @handleName getICollectionRowsById
|
|
54
|
-
* @param
|
|
55
|
-
* @param
|
|
56
|
-
* @param
|
|
57
|
-
|
|
58
|
-
|
|
59
|
-
|
|
60
|
-
|
|
61
|
-
|
|
62
|
-
|
|
63
|
-
* @param
|
|
64
|
-
* @param
|
|
65
|
-
* @param
|
|
66
|
-
* @param
|
|
67
|
-
* @returns {ICollectionRowsResponce}
|
|
54
|
+
* @param {number} id - Collection id.
|
|
55
|
+
* @param {string} [langCode] - Language code. Default: "en_US".
|
|
56
|
+
* @param {any} [userQuery] - Optional set query parameters. Example:
|
|
57
|
+
{
|
|
58
|
+
"limit": 30,
|
|
59
|
+
"offset": 0,
|
|
60
|
+
"entityType": "orders",
|
|
61
|
+
"entityId": 1
|
|
62
|
+
}
|
|
63
|
+
* @param {number} [userQuery.limit] - Optional parameter for pagination. Default: 30.
|
|
64
|
+
* @param {number} [userQuery.offset] - Optional parameter for pagination. Default: 0.
|
|
65
|
+
* @param {number} [userQuery.entityType] - Entity type. Example: "orders".
|
|
66
|
+
* @param {number} [userQuery.entityId] - Entity identifier. Example: 1.
|
|
67
|
+
* @returns {ICollectionRowsResponce} Returns object ItemsWithTotal, where items is an array of requested objects.
|
|
68
68
|
* @throws {IError} - If there is an error during the fetch operation, it will return an error object.
|
|
69
69
|
* @description This method gets all records belonging to the collection by collection id.
|
|
70
70
|
*/
|
|
@@ -72,11 +72,11 @@ interface ICollectionsApi {
|
|
|
72
72
|
/**
|
|
73
73
|
* Check for the existence of a text identifier (marker).
|
|
74
74
|
* @handleName validateICollectionMarker
|
|
75
|
-
* @param
|
|
76
|
-
* @returns {ICollectionIsValid}
|
|
77
|
-
|
|
78
|
-
|
|
79
|
-
|
|
75
|
+
* @param {string} marker - Collection marker. Example: "collection1".
|
|
76
|
+
* @returns {ICollectionIsValid} Returns an object with a boolean property `valid` indicating whether the marker is valid or not. Example:
|
|
77
|
+
{
|
|
78
|
+
"valid": true
|
|
79
|
+
}
|
|
80
80
|
* @throws {IError} - If there is an error during the fetch operation, it will return an error object.
|
|
81
81
|
* @description This method checks for the existence of a text identifier (marker).
|
|
82
82
|
*/
|
|
@@ -84,9 +84,9 @@ interface ICollectionsApi {
|
|
|
84
84
|
/**
|
|
85
85
|
* Getting all records from the collection.
|
|
86
86
|
* @handleName getICollectionRowsByMarker
|
|
87
|
-
* @param
|
|
88
|
-
* @param
|
|
89
|
-
* @returns {ICollectionRowsResponce}
|
|
87
|
+
* @param {string} marker - Collection text identifier. Example: "collection1".
|
|
88
|
+
* @param {string} [langCode] - Language code. Default: "en_US".
|
|
89
|
+
* @returns {ICollectionRowsResponce} Returns collection row entity object.
|
|
90
90
|
* @throws {IError} - If there is an error during the fetch operation, it will return an error object.
|
|
91
91
|
* @description This method gets all records from the collection.
|
|
92
92
|
*/
|
|
@@ -94,10 +94,10 @@ interface ICollectionsApi {
|
|
|
94
94
|
/**
|
|
95
95
|
* Getting one record from the collection.
|
|
96
96
|
* @handleName getICollectionRowByMarkerAndId
|
|
97
|
-
* @param
|
|
98
|
-
* @param
|
|
99
|
-
* @param
|
|
100
|
-
* @returns {ICollectionRow}
|
|
97
|
+
* @param {string} marker - Collection text identifier. Example: "collection1".
|
|
98
|
+
* @param {number} id - Collection record identifier. Example: 1.
|
|
99
|
+
* @param {string} [langCode] - Language code. Default: "en_US".
|
|
100
|
+
* @returns {ICollectionRow} Returns collection row entity object.
|
|
101
101
|
* @throws {IError} - If there is an error during the fetch operation, it will return an error object.
|
|
102
102
|
* @description This method gets one record from the collection.
|
|
103
103
|
*/
|
|
@@ -105,22 +105,20 @@ interface ICollectionsApi {
|
|
|
105
105
|
/**
|
|
106
106
|
* Create a record in the collection.
|
|
107
107
|
* @handleName createICollectionRow
|
|
108
|
-
* @param
|
|
109
|
-
* @param
|
|
110
|
-
|
|
111
|
-
|
|
112
|
-
|
|
113
|
-
|
|
114
|
-
|
|
115
|
-
|
|
116
|
-
|
|
117
|
-
|
|
118
|
-
|
|
119
|
-
|
|
120
|
-
|
|
121
|
-
|
|
122
|
-
* @param {string} [langCode] - Language code. Default: "en_US".
|
|
123
|
-
* @returns {any} Returns object of type ICollectionRow.
|
|
108
|
+
* @param {string} marker - Collection text identifier. Example: "collection1".
|
|
109
|
+
* @param {ICollectionFormObject} body - Object for creating a record. Example:
|
|
110
|
+
{
|
|
111
|
+
"formIdentifier": "collection-form",
|
|
112
|
+
"formData": [
|
|
113
|
+
{
|
|
114
|
+
"marker": "collection_marker",
|
|
115
|
+
"type": "string",
|
|
116
|
+
"value": "Collection marker"
|
|
117
|
+
}
|
|
118
|
+
]
|
|
119
|
+
}
|
|
120
|
+
* @param {string} [langCode] - Language code. Default: "en_US".
|
|
121
|
+
* @returns {any} Returns object of type ICollectionRow.
|
|
124
122
|
* @throws {IError} - If there is an error during the fetch operation, it will return an error object.
|
|
125
123
|
* @description This method creates a record in the collection.
|
|
126
124
|
*/
|
|
@@ -128,23 +126,21 @@ interface ICollectionsApi {
|
|
|
128
126
|
/**
|
|
129
127
|
* Edit a record in the collection.
|
|
130
128
|
* @handleName updateICollectionRow
|
|
131
|
-
* @param
|
|
132
|
-
* @param
|
|
133
|
-
* @param
|
|
134
|
-
|
|
135
|
-
|
|
136
|
-
|
|
137
|
-
|
|
138
|
-
|
|
139
|
-
|
|
140
|
-
|
|
141
|
-
|
|
142
|
-
|
|
143
|
-
|
|
144
|
-
|
|
145
|
-
|
|
146
|
-
* @param {string} [langCode] - Language code. Default: "en_US".
|
|
147
|
-
* @returns {ICollectionRow} Returns object of type ICollectionRow.
|
|
129
|
+
* @param {string} marker - Text identifier of the collection. Example: "collection1".
|
|
130
|
+
* @param {number} id - Row id. Example: 12.
|
|
131
|
+
* @param {ICollectionFormObject} body - Object for updating a record in the collection. Example:
|
|
132
|
+
{
|
|
133
|
+
"formIdentifier": "collection-form",
|
|
134
|
+
"formData": [
|
|
135
|
+
{
|
|
136
|
+
"marker": "collection_marker",
|
|
137
|
+
"type": "string",
|
|
138
|
+
"value": "Collection marker"
|
|
139
|
+
}
|
|
140
|
+
]
|
|
141
|
+
}
|
|
142
|
+
* @param {string} [langCode] - Language code. Default: "en_US".
|
|
143
|
+
* @returns {ICollectionRow} Returns object of type ICollectionRow.
|
|
148
144
|
* @throws {IError} - If there is an error during the fetch operation, it will return an error object.
|
|
149
145
|
* @description This method edits a record in the collection.
|
|
150
146
|
*/
|
|
@@ -152,9 +148,9 @@ interface ICollectionsApi {
|
|
|
152
148
|
/**
|
|
153
149
|
* Deletion of collection record object
|
|
154
150
|
* @handleName deleteICollectionRowByMarkerAndId
|
|
155
|
-
* @param
|
|
156
|
-
* @param
|
|
157
|
-
* @returns {boolean}
|
|
151
|
+
* @param {string} marker - text identifier of the collection Example: "collection1".
|
|
152
|
+
* @param {number} id - record identifier in the collection Example: 12.
|
|
153
|
+
* @returns {boolean} Returns true (in case of successful deletion) or false (in case of unsuccessful deletion) (permission "collections.row.delete" required for access)
|
|
158
154
|
* @throws {IError} - If there is an error during the fetch operation, it will return an error object.
|
|
159
155
|
* @description This method deletes a collection record object.
|
|
160
156
|
*/
|
|
@@ -163,14 +159,14 @@ interface ICollectionsApi {
|
|
|
163
159
|
/**
|
|
164
160
|
* Collection object
|
|
165
161
|
* @interface ICollectionEntity
|
|
166
|
-
* @property {number}
|
|
167
|
-
* @property {string | null} identifier
|
|
168
|
-
* @property {number | null} formId
|
|
169
|
-
* @property {ILocalizeInfo} localizeInfos
|
|
170
|
-
|
|
171
|
-
|
|
172
|
-
|
|
173
|
-
* @property {string | null} attributeSetId
|
|
162
|
+
* @property {number} id - Object identifier. Example: 1.
|
|
163
|
+
* @property {string | null} identifier - Text identifier for record field. Example: "collection1".
|
|
164
|
+
* @property {number | null} formId - Identifier for the form used by the order storage. Example: 1234.
|
|
165
|
+
* @property {ILocalizeInfo} localizeInfos - Localized information about the collection. Example:
|
|
166
|
+
{
|
|
167
|
+
"title": "Admins text"
|
|
168
|
+
}
|
|
169
|
+
* @property {string | null} attributeSetId - Identifier of the set of attributes used by the form attached to the collection. Example: "attributeSet1" or null if not applicable.
|
|
174
170
|
* @property {string | null} selectedAttributeMarkers - Text identifiers of form object attributes for display in the data table. Example: "collection_marker".
|
|
175
171
|
* @description Represents a collection object with various properties, including identifiers, form information, and localized data.
|
|
176
172
|
*/
|
|
@@ -186,13 +182,13 @@ interface ICollectionEntity {
|
|
|
186
182
|
* Collection response object
|
|
187
183
|
* @interface ICollectionResponce
|
|
188
184
|
* @property {ICollectionEntity[]} items - Array of collection objects. Example:
|
|
189
|
-
|
|
190
|
-
|
|
191
|
-
|
|
192
|
-
|
|
193
|
-
|
|
194
|
-
|
|
195
|
-
* @property {number}
|
|
185
|
+
[
|
|
186
|
+
{
|
|
187
|
+
"id": 1,
|
|
188
|
+
"identifier": "collection1"
|
|
189
|
+
}
|
|
190
|
+
]
|
|
191
|
+
* @property {number} total - Total number of found records. Example: 10.
|
|
196
192
|
* @description Represents a response from the collections API containing a total count and an array of collection objects.
|
|
197
193
|
*/
|
|
198
194
|
interface ICollectionResponce {
|
|
@@ -203,8 +199,8 @@ interface ICollectionResponce {
|
|
|
203
199
|
* Collection form data object
|
|
204
200
|
* @interface ICollectionFormData
|
|
205
201
|
* @property {string} marker - Text identifier (marker) of the form field. Example: "collection_marker".
|
|
206
|
-
* @property {string} type
|
|
207
|
-
* @property {string} value
|
|
202
|
+
* @property {string} type - Type of the form field, such as "text", "number", "date", "etc". Example: "number".
|
|
203
|
+
* @property {string} value - Value of the form field, which can be a "string", "number", "date", "etc". Example: "Collection marker".
|
|
208
204
|
* @description Represents a form data object within a collection, containing a marker, type, and value.
|
|
209
205
|
*/
|
|
210
206
|
interface ICollectionFormData {
|
|
@@ -215,18 +211,18 @@ interface ICollectionFormData {
|
|
|
215
211
|
/**
|
|
216
212
|
* Collection form object
|
|
217
213
|
* @interface ICollectionFormObject
|
|
218
|
-
* @property {string}
|
|
219
|
-
* @property {Record<string, ICollectionFormData>} formData
|
|
220
|
-
|
|
221
|
-
|
|
222
|
-
|
|
223
|
-
|
|
224
|
-
|
|
225
|
-
|
|
226
|
-
|
|
227
|
-
* @property {string}
|
|
228
|
-
* @property {string}
|
|
229
|
-
* @property {string}
|
|
214
|
+
* @property {string} formIdentifier - Text identifier (marker) of the form. Example: "collection-form".
|
|
215
|
+
* @property {Record<string, ICollectionFormData>} formData - An object where keys are form field markers and values are arrays of ICollectionFormData objects. Example:
|
|
216
|
+
[
|
|
217
|
+
{
|
|
218
|
+
"marker": "name_1",
|
|
219
|
+
"type": "string",
|
|
220
|
+
"value": "Value"
|
|
221
|
+
}
|
|
222
|
+
]
|
|
223
|
+
* @property {string} formData[index].marker - Text identifier (marker) of the form field. Example: "name_1".
|
|
224
|
+
* @property {string} formData[index].type - Type of the form field. Example: "string".
|
|
225
|
+
* @property {string} formData[index].value - Value of the form field. Example: "Value".
|
|
230
226
|
* @description Represents a collection form object that contains a form identifier and associated form data. This interface defines the structure of a collection form object, which includes a form identifier and a set of form data organized by markers.
|
|
231
227
|
*/
|
|
232
228
|
interface ICollectionFormObject {
|
|
@@ -238,22 +234,22 @@ interface ICollectionFormObject {
|
|
|
238
234
|
/**
|
|
239
235
|
* Collection row object
|
|
240
236
|
* @interface ICollectionRow
|
|
241
|
-
* @property {number}
|
|
242
|
-
* @property {string}
|
|
243
|
-
* @property {string}
|
|
244
|
-
* @property {number | null}
|
|
245
|
-
* @property {ICollectionFormData[]} formData
|
|
246
|
-
|
|
247
|
-
|
|
248
|
-
|
|
249
|
-
|
|
250
|
-
|
|
251
|
-
|
|
252
|
-
|
|
253
|
-
* @property {string | null}
|
|
254
|
-
* @property {number | null}
|
|
255
|
-
* @property {string | null}
|
|
256
|
-
* @property {string}
|
|
237
|
+
* @property {number} id - Object identifier. Example: 1.
|
|
238
|
+
* @property {string} createdDate - Date of creation of the record. Example: "2023-01-01T00:00:00Z".
|
|
239
|
+
* @property {string} updatedDate - Date of last update of the record. Example: "2023-01-02T00:00:00Z".
|
|
240
|
+
* @property {number | null} [collectionId] - collectionId associated with the collection row. Example: "product", "order", "etc".
|
|
241
|
+
* @property {ICollectionFormData[]} formData - Array of form data objects associated with the collection row. Example:
|
|
242
|
+
[
|
|
243
|
+
{
|
|
244
|
+
"marker": "name_1",
|
|
245
|
+
"type": "string",
|
|
246
|
+
"value": "Value"
|
|
247
|
+
}
|
|
248
|
+
]
|
|
249
|
+
* @property {string | null} entityType - Type of the entity associated with the collection row. Example: "product", "order", "etc".
|
|
250
|
+
* @property {number | null} entityId - Identifier of the entity associated with the collection row. Example: 12345.
|
|
251
|
+
* @property {string | null} [attributeSetIdentifier] - Identifier of the attribute set used by the form attached to the collection row, or null if not applicable. Example: "attributeSet1" or null.
|
|
252
|
+
* @property {string} total - Total count. Example: "1".
|
|
257
253
|
* @description Represents a row in a collection, containing various properties such as identifiers, dates, form data, and an optional total value.
|
|
258
254
|
*/
|
|
259
255
|
interface ICollectionRow {
|
|
@@ -271,24 +267,24 @@ interface ICollectionRow {
|
|
|
271
267
|
* Collection rows response object
|
|
272
268
|
* @interface ICollectionRowsResponce
|
|
273
269
|
* @property {ICollectionRow[]} items - Array of collection row objects. Example:
|
|
274
|
-
|
|
275
|
-
|
|
276
|
-
|
|
277
|
-
|
|
278
|
-
|
|
279
|
-
|
|
280
|
-
|
|
281
|
-
|
|
282
|
-
|
|
283
|
-
|
|
284
|
-
|
|
285
|
-
|
|
286
|
-
|
|
287
|
-
|
|
288
|
-
|
|
289
|
-
|
|
290
|
-
|
|
291
|
-
* @property {number}
|
|
270
|
+
[
|
|
271
|
+
{
|
|
272
|
+
"id": 1,
|
|
273
|
+
"createdDate": "2025-06-06T19:08:54.616Z",
|
|
274
|
+
"updatedDate": "2025-06-06T19:08:54.616Z",
|
|
275
|
+
"entityId": null,
|
|
276
|
+
"entityType": null,
|
|
277
|
+
"formData": [
|
|
278
|
+
{
|
|
279
|
+
"marker": "name_1",
|
|
280
|
+
"type": "string",
|
|
281
|
+
"value": "Value"
|
|
282
|
+
}
|
|
283
|
+
],
|
|
284
|
+
"attributeSetIdentifier": null
|
|
285
|
+
}
|
|
286
|
+
]
|
|
287
|
+
* @property {number} total - Total number of found records. Example: 10.
|
|
292
288
|
* @description Represents a response from the collections API containing a total count and an array of collection row objects.
|
|
293
289
|
*/
|
|
294
290
|
interface ICollectionRowsResponce {
|
|
@@ -18,14 +18,14 @@ interface ILocales {
|
|
|
18
18
|
/**
|
|
19
19
|
* The `ILocalEntity` interface defines the structure of a locales entity, including its identifiers, name, and other properties.
|
|
20
20
|
* @interface ILocalEntity
|
|
21
|
-
* @property {number}
|
|
22
|
-
* @property {string}
|
|
23
|
-
* @property {string}
|
|
24
|
-
* @property {string}
|
|
25
|
-
* @property {string}
|
|
26
|
-
* @property {boolean}
|
|
27
|
-
* @property {string | null} image
|
|
28
|
-
* @property {number}
|
|
21
|
+
* @property {number} id - The unique identifier of the locales. Example: 1.
|
|
22
|
+
* @property {string} shortCode - The shortCode of locales. Example: "en".
|
|
23
|
+
* @property {string} code - The full language code. Example: "en_US".
|
|
24
|
+
* @property {string} name - The language name. Example: "English".
|
|
25
|
+
* @property {string} nativeName - The native language name. Example: "English".
|
|
26
|
+
* @property {boolean} isActive - Active language flag. Example: true.
|
|
27
|
+
* @property {string | null} image - The language image. Example: "https://example.com/images/en.png".
|
|
28
|
+
* @property {number} position - The language position. Example: 1.
|
|
29
29
|
* @description This interface defines the structure of a locales entity, including its identifiers, name, and other properties.
|
|
30
30
|
*/
|
|
31
31
|
interface ILocalEntity {
|
package/dist/menus/menusApi.d.ts
CHANGED
|
@@ -19,9 +19,9 @@ export default class MenusApi extends AsyncModules implements IMenus {
|
|
|
19
19
|
/**
|
|
20
20
|
* Get pages includes in menu by marker.
|
|
21
21
|
* @handleName getMenusByMarker
|
|
22
|
-
* @param
|
|
23
|
-
* @param
|
|
24
|
-
* @returns {IMenusEntity}
|
|
22
|
+
* @param {string} marker - Menu marker. Example: "main_menu".
|
|
23
|
+
* @param {string} [langCode] - Language code. Default: "en_US".
|
|
24
|
+
* @returns {IMenusEntity} Returns a single menu object as a ContentMenu object with included pages.
|
|
25
25
|
* @throws {IError} - If there is an error during the fetch operation, it will return an error object.
|
|
26
26
|
* @description Get pages includes in menu by marker.
|
|
27
27
|
*/
|
package/dist/menus/menusApi.js
CHANGED
|
@@ -22,9 +22,9 @@ class MenusApi extends asyncModules_1.default {
|
|
|
22
22
|
/**
|
|
23
23
|
* Get pages includes in menu by marker.
|
|
24
24
|
* @handleName getMenusByMarker
|
|
25
|
-
* @param
|
|
26
|
-
* @param
|
|
27
|
-
* @returns {IMenusEntity}
|
|
25
|
+
* @param {string} marker - Menu marker. Example: "main_menu".
|
|
26
|
+
* @param {string} [langCode] - Language code. Default: "en_US".
|
|
27
|
+
* @returns {IMenusEntity} Returns a single menu object as a ContentMenu object with included pages.
|
|
28
28
|
* @throws {IError} - If there is an error during the fetch operation, it will return an error object.
|
|
29
29
|
* @description Get pages includes in menu by marker.
|
|
30
30
|
*/
|
|
@@ -8,9 +8,9 @@ interface IMenus {
|
|
|
8
8
|
/**
|
|
9
9
|
* Get pages includes in menu by marker.
|
|
10
10
|
* @handleName getMenusByMarker
|
|
11
|
-
* @param
|
|
12
|
-
* @param
|
|
13
|
-
* @returns {IMenusEntity}
|
|
11
|
+
* @param {string} marker - Menu marker. Example: "main_menu".
|
|
12
|
+
* @param {string} [langCode] - Language code. Default: "en_US".
|
|
13
|
+
* @returns {IMenusEntity} Returns a single menu object as a ContentMenu object with included pages.
|
|
14
14
|
* @throws {IError} - If there is an error during the fetch operation, it will return an error object.
|
|
15
15
|
* @description This method gets pages includes in menu by marker.
|
|
16
16
|
*/
|
|
@@ -18,30 +18,30 @@ interface IMenus {
|
|
|
18
18
|
}
|
|
19
19
|
/**
|
|
20
20
|
* @interface IMenusPages
|
|
21
|
-
* @property {IMenusPages[]}
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
* @property {number}
|
|
33
|
-
* @property {string}
|
|
34
|
-
* @property {ILocalizeInfo}
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
|
|
21
|
+
* @property {IMenusPages[]} children - Contains array with child page objects. Example:
|
|
22
|
+
[
|
|
23
|
+
{
|
|
24
|
+
"id": null,
|
|
25
|
+
"pageUrl": null,
|
|
26
|
+
"localizeInfos": {},
|
|
27
|
+
"attributeValues": {},
|
|
28
|
+
"parentId": null,
|
|
29
|
+
"position": 1
|
|
30
|
+
}
|
|
31
|
+
]
|
|
32
|
+
* @property {number} id - The unique identifier of the menu. Example: 1.
|
|
33
|
+
* @property {string} pageUrl - The page url string. Example: "about".
|
|
34
|
+
* @property {ILocalizeInfo} localizeInfos - The menu data, taking into account localization. Example:
|
|
35
|
+
{
|
|
36
|
+
"title": "menu"
|
|
37
|
+
}
|
|
38
38
|
* @property {IAttributeValues} attributeValues - Attributes sets. Example:
|
|
39
|
-
|
|
40
|
-
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
* @property {number}
|
|
44
|
-
* @property {number | null}
|
|
39
|
+
{
|
|
40
|
+
"color": "red",
|
|
41
|
+
"size": "large"
|
|
42
|
+
}
|
|
43
|
+
* @property {number} position - The menu position. Example: 1.
|
|
44
|
+
* @property {number | null} parentId - The menu parent id. Example: null.
|
|
45
45
|
* @description This interface defines the structure of a menu page entity, including its identifiers, localization information, attributes, and hierarchical relationships.
|
|
46
46
|
*/
|
|
47
47
|
interface IMenusPages {
|
|
@@ -55,20 +55,20 @@ interface IMenusPages {
|
|
|
55
55
|
}
|
|
56
56
|
/**
|
|
57
57
|
* @interface IMenusEntity
|
|
58
|
-
* @property {number}
|
|
59
|
-
* @property {string}
|
|
58
|
+
* @property {number} id - The unique identifier of the menu. Example: 1.
|
|
59
|
+
* @property {string} identifier - The menu identifier. Example: "main_menu".
|
|
60
60
|
* @property {ILocalizeInfo} localizeInfos - Contains localization information. Example: {"title": "menu"}.
|
|
61
|
-
* @property {IMenusPages[]} pages
|
|
62
|
-
|
|
63
|
-
|
|
64
|
-
|
|
65
|
-
|
|
66
|
-
|
|
67
|
-
|
|
68
|
-
|
|
69
|
-
|
|
70
|
-
|
|
71
|
-
|
|
61
|
+
* @property {IMenusPages[]} pages - Array of menu pages. Example:
|
|
62
|
+
[
|
|
63
|
+
{
|
|
64
|
+
"id": null,
|
|
65
|
+
"pageUrl": null,
|
|
66
|
+
"localizeInfos": {},
|
|
67
|
+
"attributeValues": {},
|
|
68
|
+
"parentId": null,
|
|
69
|
+
"position": 1
|
|
70
|
+
}
|
|
71
|
+
]
|
|
72
72
|
* @description This interface defines the structure of a menu entity, including its identifiers, localization information, and associated pages.
|
|
73
73
|
*/
|
|
74
74
|
interface IMenusEntity {
|