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
|
@@ -3,22 +3,22 @@ import type { ITemplateEntity } from 'templates/templatesInterfaces';
|
|
|
3
3
|
import type { AttributeType, IAttributes, IError, ILocalizeInfo, LangType, Types } from '../base/utils';
|
|
4
4
|
/**
|
|
5
5
|
* @interface IPageApi
|
|
6
|
-
* @property {Function} getRootPages
|
|
7
|
-
* @property {Function} getCatalogPages
|
|
8
|
-
* @property {Function} getPages
|
|
9
|
-
* @property {Function} getPageById
|
|
10
|
-
* @property {Function} getPageByUrl
|
|
6
|
+
* @property {Function} getRootPages - Get all top-level page objects.
|
|
7
|
+
* @property {Function} getCatalogPages - Get all page objects with product information as an array.
|
|
8
|
+
* @property {Function} getPages - Get all page objects with product information as an array.
|
|
9
|
+
* @property {Function} getPageById - Get page object with information about forms, blocks, menus, linked to the page.
|
|
10
|
+
* @property {Function} getPageByUrl - Get page object with information about forms, blocks, menus, linked to the page by URL.
|
|
11
11
|
* @property {Function} getChildPagesByParentUrl - Get child pages object with information as an array.
|
|
12
|
-
* @property {Function} getConfigPageByUrl
|
|
13
|
-
* @property {Function} searchPage
|
|
12
|
+
* @property {Function} getConfigPageByUrl - Get settings for the page.
|
|
13
|
+
* @property {Function} searchPage - Quick search for page objects with limited output.
|
|
14
14
|
* @description This interface defines methods for retrieving and managing pages in the system.
|
|
15
15
|
*/
|
|
16
16
|
interface IPageApi {
|
|
17
17
|
/**
|
|
18
18
|
* Get all top-level page objects.
|
|
19
19
|
* @handleName getRootPages
|
|
20
|
-
* @param
|
|
21
|
-
* @returns {IPagesEntity[]}
|
|
20
|
+
* @param {string} [langCode] - Language code. Default: "en_US".
|
|
21
|
+
* @returns {IPagesEntity[]} Returns all created pages without parents as an array of PageEntity objects or an empty array [] (if there is no data)
|
|
22
22
|
* @throws {IError} - If there is an error during the fetch operation, it will return an error object.
|
|
23
23
|
* @description This method gets all top-level page objects.
|
|
24
24
|
*/
|
|
@@ -26,8 +26,8 @@ interface IPageApi {
|
|
|
26
26
|
/**
|
|
27
27
|
* Get all page objects with product information as an array.
|
|
28
28
|
* @handleName getPages
|
|
29
|
-
* @param
|
|
30
|
-
* @returns {IPagesEntity[]}
|
|
29
|
+
* @param {string} [langCode] - Language code. Default: "en_US".
|
|
30
|
+
* @returns {IPagesEntity[]} Returns all created pages as an array of PageEntity objects or an empty array [] (if there is no data).
|
|
31
31
|
* @throws {IError} - If there is an error during the fetch operation, it will return an error object.
|
|
32
32
|
* @description This method gets all page objects with product information as an array.
|
|
33
33
|
*/
|
|
@@ -35,9 +35,9 @@ interface IPageApi {
|
|
|
35
35
|
/**
|
|
36
36
|
* Get page object with information about forms, blocks, menus, linked to the page.
|
|
37
37
|
* @handleName getPageById
|
|
38
|
-
* @param
|
|
39
|
-
* @param
|
|
40
|
-
* @returns {IPagesEntity}
|
|
38
|
+
* @param {number} id - The unique identifier of the page to be fetched. Example: 123.
|
|
39
|
+
* @param {string} [langCode] - Language code. Default: "en_US".
|
|
40
|
+
* @returns {IPagesEntity} Returns PageEntity object
|
|
41
41
|
* @throws {IError} - If there is an error during the fetch operation, it will return an error object.
|
|
42
42
|
* @description This method gets a page object with information about forms, blocks, menus, linked to the page.
|
|
43
43
|
*/
|
|
@@ -45,9 +45,9 @@ interface IPageApi {
|
|
|
45
45
|
/**
|
|
46
46
|
* Get page object with information about forms, blocks, menus, linked to the page by URL.
|
|
47
47
|
* @handleName getPageByUrl
|
|
48
|
-
* @param
|
|
49
|
-
* @param
|
|
50
|
-
* @returns {IPagesEntity}
|
|
48
|
+
* @param {string} url - Page URL. Example: "about".
|
|
49
|
+
* @param {string} [langCode] - Language code. Default: "en_US".
|
|
50
|
+
* @returns {IPagesEntity} Returns PageEntity object
|
|
51
51
|
* @throws {IError} - If there is an error during the fetch operation, it will return an error object.
|
|
52
52
|
* @description This method gets a page object with information about forms, blocks, menus, linked to the page by URL.
|
|
53
53
|
*/
|
|
@@ -55,9 +55,9 @@ interface IPageApi {
|
|
|
55
55
|
/**
|
|
56
56
|
* Get child pages object with information as an array.
|
|
57
57
|
* @handleName getChildPagesByParentUrl
|
|
58
|
-
* @param
|
|
59
|
-
* @param
|
|
60
|
-
* @returns {IPagesEntity}
|
|
58
|
+
* @param {string} url - The URL of the parent page for which child pages are to be fetched. Example: "about".
|
|
59
|
+
* @param {string} [langCode] - Language code. Default: "en_US".
|
|
60
|
+
* @returns {IPagesEntity} Returns all created pages as an array of PageEntity objects or an empty array [] (if there is no data) for the selected parent
|
|
61
61
|
* @throws {IError} - If there is an error during the fetch operation, it will return an error object.
|
|
62
62
|
* @description This method gets child pages object with information as an array.
|
|
63
63
|
*/
|
|
@@ -65,9 +65,9 @@ interface IPageApi {
|
|
|
65
65
|
/**
|
|
66
66
|
* Get all blocks by page url.
|
|
67
67
|
* @handleName getBlocksByPageUrl
|
|
68
|
-
* @param
|
|
69
|
-
* @param
|
|
70
|
-
* @returns {IPositionBlock[]}
|
|
68
|
+
* @param {string} url - Page URL. Example: "about".
|
|
69
|
+
* @param {string} [langCode] - Language code. Default: "en_US".
|
|
70
|
+
* @returns {IPositionBlock[]} Returns all blocks as an array of PositionBlock objects or an empty array [] (if there is no data) for the selected parent
|
|
71
71
|
* @throws {IError} - If there is an error during the fetch operation, it will return an error object.
|
|
72
72
|
* @description This method gets all blocks by page url.
|
|
73
73
|
*/
|
|
@@ -75,8 +75,8 @@ interface IPageApi {
|
|
|
75
75
|
/**
|
|
76
76
|
* Get settings for the page.
|
|
77
77
|
* @handleName getConfigPageByUrl
|
|
78
|
-
* @param
|
|
79
|
-
* @returns {IPageConfig}
|
|
78
|
+
* @param {string} url - Page URL. Example: "about".
|
|
79
|
+
* @returns {IPageConfig} Returns a ConfigPage object with page display settings
|
|
80
80
|
* @throws {IError} - If there is an error during the fetch operation, it will return an error object.
|
|
81
81
|
* @description This method gets settings for the page.
|
|
82
82
|
*/
|
|
@@ -84,9 +84,9 @@ interface IPageApi {
|
|
|
84
84
|
/**
|
|
85
85
|
* Quick search for page objects with limited output.
|
|
86
86
|
* @handleName searchPage
|
|
87
|
-
* @param
|
|
88
|
-
* @param
|
|
89
|
-
* @returns {IPagesEntity[]}
|
|
87
|
+
* @param {string} name - Text for searching page objects (search is performed on the title field of the localizeInfos object with the language taken into account). Example: "About Us".
|
|
88
|
+
* @param {string} [langCode] - Language code. Default: "en_US".
|
|
89
|
+
* @returns {IPagesEntity[]} Returns all created pages as an array of PageEntity objects or an empty array [] (if there is no data)
|
|
90
90
|
* @throws {IError} - If there is an error during the fetch operation, it will return an error object.
|
|
91
91
|
* @description This method performs a quick search for page objects with limited output.
|
|
92
92
|
*/
|
|
@@ -94,7 +94,7 @@ interface IPageApi {
|
|
|
94
94
|
}
|
|
95
95
|
/**
|
|
96
96
|
* @interface IPageConfig
|
|
97
|
-
* @property {number | null} rowsPerPage
|
|
97
|
+
* @property {number | null} rowsPerPage - Number of lines per page. Example: 1.
|
|
98
98
|
* @property {number | null} productsPerRow - Number of products per page. Example: 1.
|
|
99
99
|
* @description This interface defines the configuration for pagination in pages, including the number of rows and products displayed per page.
|
|
100
100
|
*/
|
|
@@ -104,51 +104,41 @@ interface IPageConfig {
|
|
|
104
104
|
}
|
|
105
105
|
/**
|
|
106
106
|
* @interface IPositionForm
|
|
107
|
-
* @property {number}
|
|
108
|
-
* @property {number}
|
|
109
|
-
* @property {string}
|
|
110
|
-
* @property {number}
|
|
111
|
-
* @property {string}
|
|
107
|
+
* @property {number} id - The identifier of the object. Example: 1764.
|
|
108
|
+
* @property {number} version - The version number of the object. Example: 10.
|
|
109
|
+
* @property {string} identifier - The textual identifier for the record field. Example: "catalog".
|
|
110
|
+
* @property {number} attributeSetId - The identifier of the attribute set being used. Example: 0.
|
|
111
|
+
* @property {string} processingType - Type of form processing. Example: "email".
|
|
112
112
|
* @property {ILocalizeInfo} localizeInfos - The name of the page, taking into account localization. Example:
|
|
113
|
-
* @property {object}
|
|
114
|
-
* @property {number}
|
|
115
|
-
* @property {IAttributes[]} attributes
|
|
116
|
-
|
|
117
|
-
|
|
118
|
-
|
|
119
|
-
|
|
120
|
-
|
|
121
|
-
|
|
122
|
-
|
|
123
|
-
|
|
124
|
-
|
|
125
|
-
|
|
126
|
-
|
|
127
|
-
|
|
128
|
-
|
|
129
|
-
|
|
130
|
-
|
|
131
|
-
|
|
132
|
-
|
|
133
|
-
|
|
134
|
-
|
|
135
|
-
|
|
136
|
-
|
|
137
|
-
|
|
138
|
-
|
|
139
|
-
|
|
140
|
-
|
|
141
|
-
|
|
142
|
-
]
|
|
143
|
-
{
|
|
144
|
-
"title": "My form",
|
|
145
|
-
"titleForSite": "",
|
|
146
|
-
"successMessage": "",
|
|
147
|
-
"unsuccessMessage": "",
|
|
148
|
-
"urlAddress": "",
|
|
149
|
-
"database": "0",
|
|
150
|
-
"script": "0"
|
|
151
|
-
}
|
|
113
|
+
* @property {object} processingData - Form data. Example: {}.
|
|
114
|
+
* @property {number} position - The position of the object. Example: 0.
|
|
115
|
+
* @property {IAttributes[]} attributes - Array of attribute values from the used attribute set for displaying the form (taking into account the specified language). Example:
|
|
116
|
+
[
|
|
117
|
+
{
|
|
118
|
+
"type": "list",
|
|
119
|
+
"marker": "list_marker",
|
|
120
|
+
"position": 2,
|
|
121
|
+
"listTitles": [
|
|
122
|
+
{
|
|
123
|
+
"title": "red",
|
|
124
|
+
"value": 1,
|
|
125
|
+
"position": 1,
|
|
126
|
+
"extendedValue": null,
|
|
127
|
+
"extendedValueType": null
|
|
128
|
+
},
|
|
129
|
+
{
|
|
130
|
+
"title": "yellow",
|
|
131
|
+
"value": 2,
|
|
132
|
+
"position": 2,
|
|
133
|
+
"extendedValue": null,
|
|
134
|
+
"extendedValueType": null
|
|
135
|
+
}
|
|
136
|
+
],
|
|
137
|
+
"validators": {},
|
|
138
|
+
"localizeInfos": {
|
|
139
|
+
"title": "l1"
|
|
140
|
+
}
|
|
141
|
+
]
|
|
152
142
|
* @description This interface defines the structure of a position form entity, including its identifiers, attributes, and processing data.
|
|
153
143
|
*/
|
|
154
144
|
interface IPositionForm {
|
|
@@ -164,30 +154,30 @@ interface IPositionForm {
|
|
|
164
154
|
}
|
|
165
155
|
/**
|
|
166
156
|
* @interface IPositionBlock
|
|
167
|
-
* @property {number}
|
|
157
|
+
* @property {number} id - The identifier of the object. Example: 1.
|
|
168
158
|
* @property {string | null} attributeSetIdentifier - Set of attributes id. Example: "block".
|
|
169
|
-
* @property {ILocalizeInfo} localizeInfos
|
|
170
|
-
* @property {number}
|
|
171
|
-
* @property {number}
|
|
172
|
-
* @property {string}
|
|
173
|
-
* @property {Types}
|
|
159
|
+
* @property {ILocalizeInfo} localizeInfos - The name of the page, taking into account localization. Example:
|
|
160
|
+
* @property {number} version - The version number of the object. Example: 0.
|
|
161
|
+
* @property {number} position - The position of the object. Example: 1.
|
|
162
|
+
* @property {string} identifier - The textual identifier for the record field. Example: "product_block".
|
|
163
|
+
* @property {Types} type - Page type. Example: "product".
|
|
174
164
|
* @property {string | null} templateIdentifier - User id of the linked template. Example: null.
|
|
175
|
-
* @property {boolean}
|
|
176
|
-
* @property {boolean}
|
|
177
|
-
* @property {AttributeType} attributeValues
|
|
178
|
-
|
|
179
|
-
|
|
180
|
-
|
|
181
|
-
|
|
182
|
-
|
|
183
|
-
|
|
184
|
-
|
|
185
|
-
|
|
186
|
-
* @property {number}
|
|
187
|
-
* @property {number}
|
|
188
|
-
|
|
189
|
-
|
|
190
|
-
|
|
165
|
+
* @property {boolean} isVisible - A sign of page visibility. Example: true.
|
|
166
|
+
* @property {boolean} isSync - Indication of page indexing. Example: false.
|
|
167
|
+
* @property {AttributeType} attributeValues - Array of attribute values from the index (represented as a pair of user attribute id: attribute value). Example:
|
|
168
|
+
{
|
|
169
|
+
"block-text": {
|
|
170
|
+
"type": "string",
|
|
171
|
+
"value": "some text",
|
|
172
|
+
"position": 0,
|
|
173
|
+
"additionalFields": []
|
|
174
|
+
}
|
|
175
|
+
}
|
|
176
|
+
* @property {number} [countElementsPerRow] - Number of elements displayed per row in the block, if applicable. Example: 3.
|
|
177
|
+
* @property {number} [quantity] - Quantity pages in block. Example: 1.
|
|
178
|
+
{
|
|
179
|
+
"title": "Product Block"
|
|
180
|
+
}
|
|
191
181
|
* @description This interface defines the structure of a position block entity, including its identifiers, attributes, and visibility.
|
|
192
182
|
*/
|
|
193
183
|
interface IPositionBlock {
|
|
@@ -207,52 +197,52 @@ interface IPositionBlock {
|
|
|
207
197
|
}
|
|
208
198
|
/**
|
|
209
199
|
* @interface IPagesEntity
|
|
210
|
-
* @property {number}
|
|
211
|
-
* @property {number | null} parentId
|
|
212
|
-
* @property {string}
|
|
213
|
-
* @property {number}
|
|
214
|
-
* @property {ILocalizeInfo} localizeInfos
|
|
215
|
-
|
|
216
|
-
|
|
217
|
-
|
|
218
|
-
|
|
219
|
-
|
|
220
|
-
|
|
221
|
-
* @property {boolean}
|
|
222
|
-
* @property {Types}
|
|
223
|
-
* @property {string | null} templateIdentifier
|
|
200
|
+
* @property {number} id - The identifier of the object. Example: 8.
|
|
201
|
+
* @property {number | null} parentId - The id of the parent page, if it contains null, then it is the top-level page. Example: 10.
|
|
202
|
+
* @property {string} pageUrl - Unique page Url. Example: "blog".
|
|
203
|
+
* @property {number} depth - Page nesting depth relative to parentId. Example: 10.
|
|
204
|
+
* @property {ILocalizeInfo} localizeInfos - The name of the page, taking into account localization. Example:
|
|
205
|
+
{
|
|
206
|
+
"title": "Blog",
|
|
207
|
+
"menuTitle": "Blog",
|
|
208
|
+
"htmlContent": "",
|
|
209
|
+
"plainContent": ""
|
|
210
|
+
}
|
|
211
|
+
* @property {boolean} isVisible - A sign of page visibility. Example: true.
|
|
212
|
+
* @property {Types} type - Page type. Example: "common_page".
|
|
213
|
+
* @property {string | null} templateIdentifier - User id of the linked template. Example: "template".
|
|
224
214
|
* @property {string | null} attributeSetIdentifier - Set of attributes id. Example: "page".
|
|
225
|
-
* @property {AttributeType} attributeValues
|
|
226
|
-
|
|
227
|
-
|
|
228
|
-
|
|
229
|
-
|
|
230
|
-
|
|
231
|
-
|
|
232
|
-
|
|
233
|
-
|
|
234
|
-
* @property {boolean}
|
|
235
|
-
* @property {any}
|
|
236
|
-
* @property {number}
|
|
237
|
-
* @property {any}
|
|
238
|
-
|
|
239
|
-
|
|
240
|
-
|
|
241
|
-
|
|
242
|
-
* @property {number}
|
|
243
|
-
* @property {number}
|
|
244
|
-
* @property {any}
|
|
245
|
-
|
|
246
|
-
|
|
247
|
-
|
|
248
|
-
|
|
249
|
-
|
|
250
|
-
|
|
251
|
-
|
|
252
|
-
|
|
253
|
-
|
|
254
|
-
|
|
255
|
-
|
|
215
|
+
* @property {AttributeType} attributeValues - Array of attribute values from the index (represented as a pair of user attribute id: attribute value). Example:
|
|
216
|
+
{
|
|
217
|
+
"text": {
|
|
218
|
+
"type": "string",
|
|
219
|
+
"value": "some text",
|
|
220
|
+
"position": 0,
|
|
221
|
+
"additionalFields": []
|
|
222
|
+
}
|
|
223
|
+
}
|
|
224
|
+
* @property {boolean} isSync - Indication of page indexing. Example: true.
|
|
225
|
+
* @property {any} [template] - Template object. Example:
|
|
226
|
+
* @property {number} [position] - Item number (for sorting). Example: 2.
|
|
227
|
+
* @property {any} [config] - Output settings for catalog pages. Example:
|
|
228
|
+
{
|
|
229
|
+
"rowsPerPage": 1,
|
|
230
|
+
"productsPerRow": 1
|
|
231
|
+
}
|
|
232
|
+
* @property {number} [products] - The number of products linked to the page. Example: 0.
|
|
233
|
+
* @property {number} [childrenCount] - Children count. Example: 1.
|
|
234
|
+
* @property {any} [blocks] - blocks. Example:
|
|
235
|
+
{
|
|
236
|
+
"id": 4,
|
|
237
|
+
"attributeSetIdentifier": null,
|
|
238
|
+
"title": "Template",
|
|
239
|
+
"generalTypeId": 4,
|
|
240
|
+
"identifier": "template",
|
|
241
|
+
"version": 0,
|
|
242
|
+
"generalTypeName": "catalog_page",
|
|
243
|
+
"attributeValues": {},
|
|
244
|
+
"position": 1
|
|
245
|
+
}
|
|
256
246
|
* @description This interface defines the structure of a page entity, including its identifiers, attributes, and hierarchical relationships.
|
|
257
247
|
*/
|
|
258
248
|
interface IPagesEntity {
|
|
@@ -274,6 +264,8 @@ interface IPagesEntity {
|
|
|
274
264
|
position?: number;
|
|
275
265
|
config?: Record<string, number>;
|
|
276
266
|
products?: number;
|
|
277
|
-
childrenCount?: number;
|
|
267
|
+
childrenCount?: string | number;
|
|
268
|
+
total?: string | number;
|
|
269
|
+
categoryPath?: string;
|
|
278
270
|
}
|
|
279
271
|
export type { IPageApi, IPageConfig, IPagesEntity, IPositionBlock, IPositionForm, };
|
|
@@ -19,9 +19,9 @@ export default class PaymentsApi extends AsyncModules implements IPaymentsApi {
|
|
|
19
19
|
/**
|
|
20
20
|
* Get list of payment sessions. This method requires user authorization.
|
|
21
21
|
* @handleName getSessions
|
|
22
|
-
* @param
|
|
23
|
-
* @param
|
|
24
|
-
* @returns {ISessionsEntity}
|
|
22
|
+
* @param {number} [offset] - Optional parameter for pagination. Default: 0.
|
|
23
|
+
* @param {number} [limit] - Optional parameter for pagination. Default: 30.
|
|
24
|
+
* @returns {ISessionsEntity} Returns an array of SessionEntity objects.
|
|
25
25
|
* @throws {IError} If there is an error during the fetch operation, it will return an error object.
|
|
26
26
|
* @description Get list of payment sessions. This method requires user authorization. For more information about configuring the authorization module, see the documentation in the configuration settings section of the SDK.
|
|
27
27
|
*/
|
|
@@ -29,8 +29,8 @@ export default class PaymentsApi extends AsyncModules implements IPaymentsApi {
|
|
|
29
29
|
/**
|
|
30
30
|
* Get a single payment session object by its identifier. This method requires user authorization.
|
|
31
31
|
* @handleName getSessionById
|
|
32
|
-
* @param
|
|
33
|
-
* @returns {ISessionEntity}
|
|
32
|
+
* @param {number} id - Identifier of the retrieved payment session object. Example: 12345.
|
|
33
|
+
* @returns {ISessionEntity} Returns a single payment session object.
|
|
34
34
|
* @throws {IError} - If there is an error during the fetch operation, it will return an error object.
|
|
35
35
|
* @description Get a single payment session object by its identifier. This method requires user authorization. For more information about configuring the authorization module, see the documentation in the configuration settings section of the SDK.
|
|
36
36
|
*/
|
|
@@ -38,8 +38,8 @@ export default class PaymentsApi extends AsyncModules implements IPaymentsApi {
|
|
|
38
38
|
/**
|
|
39
39
|
* Get one payment session object by order identifier
|
|
40
40
|
* @handleName getSessionByOrderId
|
|
41
|
-
* @param
|
|
42
|
-
* @returns {IAccountsEntity}
|
|
41
|
+
* @param {number} id - Order identifier. Example: 12345.
|
|
42
|
+
* @returns {IAccountsEntity} Returns a single payment account object.
|
|
43
43
|
* @throws {IError} If there is an error during the fetch operation, it will return an error object.
|
|
44
44
|
* @description Get one payment session object by order identifier. This method requires user authorization.
|
|
45
45
|
*/
|
|
@@ -47,10 +47,10 @@ export default class PaymentsApi extends AsyncModules implements IPaymentsApi {
|
|
|
47
47
|
/**
|
|
48
48
|
* Creation of payment session. This method requires user authorization.
|
|
49
49
|
* @handleName createSession
|
|
50
|
-
* @param
|
|
51
|
-
* @param
|
|
52
|
-
* @param
|
|
53
|
-
* @returns {ICreateSessionEntity}
|
|
50
|
+
* @param {number} orderId - Order identifier. Example: 12345.
|
|
51
|
+
* @param {'session' | 'intent'} type - Session type. Possible values: "session" or "intent". Example: 'session'.
|
|
52
|
+
* @param {boolean} [automaticTaxEnabled] - Automatic calculation of the tax rate. Default: false.
|
|
53
|
+
* @returns {ICreateSessionEntity} Returns a single payment session object.
|
|
54
54
|
* @throws {IError} If there is an error during the fetch operation, it will return an error object.
|
|
55
55
|
* @description Creation of payment session. This method requires user authorization. For more information about configuring the authorization module, see the documentation in the configuration settings section of the SDK.
|
|
56
56
|
*/
|
|
@@ -66,8 +66,8 @@ export default class PaymentsApi extends AsyncModules implements IPaymentsApi {
|
|
|
66
66
|
/**
|
|
67
67
|
* Get a single payment account object by its identifier. This method requires user authorization.
|
|
68
68
|
* @handleName getAccountById
|
|
69
|
-
* @param
|
|
70
|
-
* @returns {IAccountsEntity}
|
|
69
|
+
* @param {number} id - Identifier of the retrieved payment account object. Example: 12345.
|
|
70
|
+
* @returns {IAccountsEntity} Returns a single payment account object.
|
|
71
71
|
* @throws {IError} - If there is an error during the fetch operation, it will return an error object.
|
|
72
72
|
* @description Get a single payment account object by its identifier. This method requires user authorization. For more information about configuring the authorization module, see the documentation in the configuration settings section of the SDK.
|
|
73
73
|
*/
|
|
@@ -75,8 +75,8 @@ export default class PaymentsApi extends AsyncModules implements IPaymentsApi {
|
|
|
75
75
|
/**
|
|
76
76
|
* Webhook for payment account.
|
|
77
77
|
* @handleName webhookByMarker
|
|
78
|
-
* @param
|
|
79
|
-
* @returns {boolean}
|
|
78
|
+
* @param {string} marker - marker. Example: "stripe".
|
|
79
|
+
* @returns {boolean} Returns true if the webhook was processed successfully.
|
|
80
80
|
* @throws {IError} - If there is an error during the fetch operation, it will return an error object.
|
|
81
81
|
* @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.
|
|
82
82
|
*/
|
|
@@ -22,9 +22,9 @@ class PaymentsApi extends asyncModules_1.default {
|
|
|
22
22
|
/**
|
|
23
23
|
* Get list of payment sessions. This method requires user authorization.
|
|
24
24
|
* @handleName getSessions
|
|
25
|
-
* @param
|
|
26
|
-
* @param
|
|
27
|
-
* @returns {ISessionsEntity}
|
|
25
|
+
* @param {number} [offset] - Optional parameter for pagination. Default: 0.
|
|
26
|
+
* @param {number} [limit] - Optional parameter for pagination. Default: 30.
|
|
27
|
+
* @returns {ISessionsEntity} Returns an array of SessionEntity objects.
|
|
28
28
|
* @throws {IError} If there is an error during the fetch operation, it will return an error object.
|
|
29
29
|
* @description Get list of payment sessions. This method requires user authorization. For more information about configuring the authorization module, see the documentation in the configuration settings section of the SDK.
|
|
30
30
|
*/
|
|
@@ -39,8 +39,8 @@ class PaymentsApi extends asyncModules_1.default {
|
|
|
39
39
|
/**
|
|
40
40
|
* Get a single payment session object by its identifier. This method requires user authorization.
|
|
41
41
|
* @handleName getSessionById
|
|
42
|
-
* @param
|
|
43
|
-
* @returns {ISessionEntity}
|
|
42
|
+
* @param {number} id - Identifier of the retrieved payment session object. Example: 12345.
|
|
43
|
+
* @returns {ISessionEntity} Returns a single payment session object.
|
|
44
44
|
* @throws {IError} - If there is an error during the fetch operation, it will return an error object.
|
|
45
45
|
* @description Get a single payment session object by its identifier. This method requires user authorization. For more information about configuring the authorization module, see the documentation in the configuration settings section of the SDK.
|
|
46
46
|
*/
|
|
@@ -51,8 +51,8 @@ class PaymentsApi extends asyncModules_1.default {
|
|
|
51
51
|
/**
|
|
52
52
|
* Get one payment session object by order identifier
|
|
53
53
|
* @handleName getSessionByOrderId
|
|
54
|
-
* @param
|
|
55
|
-
* @returns {IAccountsEntity}
|
|
54
|
+
* @param {number} id - Order identifier. Example: 12345.
|
|
55
|
+
* @returns {IAccountsEntity} Returns a single payment account object.
|
|
56
56
|
* @throws {IError} If there is an error during the fetch operation, it will return an error object.
|
|
57
57
|
* @description Get one payment session object by order identifier. This method requires user authorization.
|
|
58
58
|
*/
|
|
@@ -63,10 +63,10 @@ class PaymentsApi extends asyncModules_1.default {
|
|
|
63
63
|
/**
|
|
64
64
|
* Creation of payment session. This method requires user authorization.
|
|
65
65
|
* @handleName createSession
|
|
66
|
-
* @param
|
|
67
|
-
* @param
|
|
68
|
-
* @param
|
|
69
|
-
* @returns {ICreateSessionEntity}
|
|
66
|
+
* @param {number} orderId - Order identifier. Example: 12345.
|
|
67
|
+
* @param {'session' | 'intent'} type - Session type. Possible values: "session" or "intent". Example: 'session'.
|
|
68
|
+
* @param {boolean} [automaticTaxEnabled] - Automatic calculation of the tax rate. Default: false.
|
|
69
|
+
* @returns {ICreateSessionEntity} Returns a single payment session object.
|
|
70
70
|
* @throws {IError} If there is an error during the fetch operation, it will return an error object.
|
|
71
71
|
* @description Creation of payment session. This method requires user authorization. For more information about configuring the authorization module, see the documentation in the configuration settings section of the SDK.
|
|
72
72
|
*/
|
|
@@ -92,8 +92,8 @@ class PaymentsApi extends asyncModules_1.default {
|
|
|
92
92
|
/**
|
|
93
93
|
* Get a single payment account object by its identifier. This method requires user authorization.
|
|
94
94
|
* @handleName getAccountById
|
|
95
|
-
* @param
|
|
96
|
-
* @returns {IAccountsEntity}
|
|
95
|
+
* @param {number} id - Identifier of the retrieved payment account object. Example: 12345.
|
|
96
|
+
* @returns {IAccountsEntity} Returns a single payment account object.
|
|
97
97
|
* @throws {IError} - If there is an error during the fetch operation, it will return an error object.
|
|
98
98
|
* @description Get a single payment account object by its identifier. This method requires user authorization. For more information about configuring the authorization module, see the documentation in the configuration settings section of the SDK.
|
|
99
99
|
*/
|
|
@@ -104,8 +104,8 @@ class PaymentsApi extends asyncModules_1.default {
|
|
|
104
104
|
/**
|
|
105
105
|
* Webhook for payment account.
|
|
106
106
|
* @handleName webhookByMarker
|
|
107
|
-
* @param
|
|
108
|
-
* @returns {boolean}
|
|
107
|
+
* @param {string} marker - marker. Example: "stripe".
|
|
108
|
+
* @returns {boolean} Returns true if the webhook was processed successfully.
|
|
109
109
|
* @throws {IError} - If there is an error during the fetch operation, it will return an error object.
|
|
110
110
|
* @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.
|
|
111
111
|
*/
|