oneentry 1.0.107 → 1.0.110
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/README.md +2836 -992
- package/dist/attribute-sets/attributeSetsApi.d.ts +9 -12
- package/dist/attribute-sets/attributeSetsApi.js +12 -15
- package/dist/auth-provider/authProviderApi.d.ts +21 -23
- package/dist/auth-provider/authProviderApi.js +28 -30
- package/dist/auth-provider/authProvidersInterfaces.d.ts +1 -1
- package/dist/blocks/blocksApi.d.ts +6 -6
- package/dist/blocks/blocksApi.js +9 -8
- package/dist/events/eventsApi.d.ts +7 -7
- package/dist/events/eventsApi.js +12 -8
- package/dist/file-uploading/fileUploadingApi.d.ts +4 -4
- package/dist/file-uploading/fileUploadingApi.js +4 -4
- package/dist/forms/formsApi.d.ts +1 -1
- package/dist/forms/formsApi.js +1 -1
- package/dist/formsData/formsDataApi.d.ts +16 -12
- package/dist/formsData/formsDataApi.js +21 -17
- package/dist/integration-collections/integrationCollectionsApi.d.ts +6 -6
- package/dist/integration-collections/integrationCollectionsApi.js +6 -6
- package/dist/menus/menusApi.d.ts +1 -1
- package/dist/menus/menusApi.js +1 -1
- package/dist/orders/ordersApi.d.ts +43 -43
- package/dist/orders/ordersApi.js +60 -60
- package/dist/pages/pagesApi.d.ts +15 -15
- package/dist/pages/pagesApi.js +20 -20
- package/dist/payments/paymentsApi.d.ts +5 -5
- package/dist/payments/paymentsApi.js +5 -5
- package/dist/product-statuses/productStatusesApi.d.ts +7 -6
- package/dist/product-statuses/productStatusesApi.js +7 -6
- package/dist/products/productsApi.d.ts +19 -19
- package/dist/products/productsApi.js +18 -18
- package/dist/templates/templatesApi.d.ts +3 -3
- package/dist/templates/templatesApi.js +3 -3
- package/dist/templates-preview/templatesPreviewApi.d.ts +2 -2
- package/dist/templates-preview/templatesPreviewApi.js +2 -2
- package/dist/users/usersApi.d.ts +9 -9
- package/dist/users/usersApi.js +19 -19
- package/package.json +8 -9
|
@@ -11,7 +11,8 @@ export default class ProductStatusesApi extends AsyncModules implements IProduct
|
|
|
11
11
|
constructor(state: StateModule);
|
|
12
12
|
/**
|
|
13
13
|
* Search for all product status objects.
|
|
14
|
-
*
|
|
14
|
+
*
|
|
15
|
+
* @param {string} [langCode] - language code
|
|
15
16
|
*
|
|
16
17
|
* @returns Returns an array of product status objects
|
|
17
18
|
*/
|
|
@@ -19,8 +20,8 @@ export default class ProductStatusesApi extends AsyncModules implements IProduct
|
|
|
19
20
|
/**
|
|
20
21
|
* Search for a product status object by identifier.
|
|
21
22
|
*
|
|
22
|
-
* @param {number} id - Status id
|
|
23
|
-
* @param {string} [langCode] -
|
|
23
|
+
* @param {number} [id] - Status id
|
|
24
|
+
* @param {string} [langCode] - language code
|
|
24
25
|
*
|
|
25
26
|
* @returns Returns a product status object
|
|
26
27
|
*/
|
|
@@ -28,8 +29,8 @@ export default class ProductStatusesApi extends AsyncModules implements IProduct
|
|
|
28
29
|
/**
|
|
29
30
|
* Search for a product status object by its textual identifier (marker).
|
|
30
31
|
*
|
|
31
|
-
* @param {string} marker - Product marker
|
|
32
|
-
* @param {string} [langCode] -
|
|
32
|
+
* @param {string} [marker] - Product marker
|
|
33
|
+
* @param {string} [langCode] - language code
|
|
33
34
|
*
|
|
34
35
|
* @returns Returns a product status object
|
|
35
36
|
*/
|
|
@@ -37,7 +38,7 @@ export default class ProductStatusesApi extends AsyncModules implements IProduct
|
|
|
37
38
|
/**
|
|
38
39
|
* Check the existence of a textual identifier.
|
|
39
40
|
*
|
|
40
|
-
* @param {string} marker - Product marker
|
|
41
|
+
* @param {string} [marker] - Product marker
|
|
41
42
|
*
|
|
42
43
|
* @returns Returns true if the textual identifier (marker) exists or false if it doesn't
|
|
43
44
|
*/
|
|
@@ -14,7 +14,8 @@ class ProductStatusesApi extends asyncModules_1.default {
|
|
|
14
14
|
}
|
|
15
15
|
/**
|
|
16
16
|
* Search for all product status objects.
|
|
17
|
-
*
|
|
17
|
+
*
|
|
18
|
+
* @param {string} [langCode] - language code
|
|
18
19
|
*
|
|
19
20
|
* @returns Returns an array of product status objects
|
|
20
21
|
*/
|
|
@@ -25,8 +26,8 @@ class ProductStatusesApi extends asyncModules_1.default {
|
|
|
25
26
|
/**
|
|
26
27
|
* Search for a product status object by identifier.
|
|
27
28
|
*
|
|
28
|
-
* @param {number} id - Status id
|
|
29
|
-
* @param {string} [langCode] -
|
|
29
|
+
* @param {number} [id] - Status id
|
|
30
|
+
* @param {string} [langCode] - language code
|
|
30
31
|
*
|
|
31
32
|
* @returns Returns a product status object
|
|
32
33
|
*/
|
|
@@ -37,8 +38,8 @@ class ProductStatusesApi extends asyncModules_1.default {
|
|
|
37
38
|
/**
|
|
38
39
|
* Search for a product status object by its textual identifier (marker).
|
|
39
40
|
*
|
|
40
|
-
* @param {string} marker - Product marker
|
|
41
|
-
* @param {string} [langCode] -
|
|
41
|
+
* @param {string} [marker] - Product marker
|
|
42
|
+
* @param {string} [langCode] - language code
|
|
42
43
|
*
|
|
43
44
|
* @returns Returns a product status object
|
|
44
45
|
*/
|
|
@@ -49,7 +50,7 @@ class ProductStatusesApi extends asyncModules_1.default {
|
|
|
49
50
|
/**
|
|
50
51
|
* Check the existence of a textual identifier.
|
|
51
52
|
*
|
|
52
|
-
* @param {string} marker - Product marker
|
|
53
|
+
* @param {string} [marker] - Product marker
|
|
53
54
|
*
|
|
54
55
|
* @returns Returns true if the textual identifier (marker) exists or false if it doesn't
|
|
55
56
|
*/
|
|
@@ -13,12 +13,12 @@ export default class ProductApi extends AsyncModules implements IProductApi {
|
|
|
13
13
|
/**
|
|
14
14
|
* Search for all products with pagination and filter.
|
|
15
15
|
*
|
|
16
|
-
* @param {Array<IFilterParams>} body - Request body. Default [].
|
|
16
|
+
* @param {Array<IFilterParams>} [body] - Request body. Default [].
|
|
17
17
|
* @param {string} [langCode] - Language code parameter. Default "en_US"
|
|
18
18
|
* @param {IProductsQuery} [userQuery] - Optional set query parameters.
|
|
19
19
|
*
|
|
20
|
-
* @param {number} [userQuery.offset] - Optional parameter for pagination, default is
|
|
21
|
-
* @param {number} [userQuery.limit] - Optional parameter for pagination, default is
|
|
20
|
+
* @param {number} [userQuery.offset] - Optional parameter for pagination, default is 0
|
|
21
|
+
* @param {number} [userQuery.limit] - Optional parameter for pagination, default is 30
|
|
22
22
|
* @param {string} [userQuery.sortOrder] - Optional sorting order DESC | ASC
|
|
23
23
|
* @param {string} [userQuery.sortKey] - Optional field to sort by (id, title, date, price, position, status)
|
|
24
24
|
* @param {number} [userQuery.statusId] - Optional parameter - search by status id
|
|
@@ -61,8 +61,8 @@ export default class ProductApi extends AsyncModules implements IProductApi {
|
|
|
61
61
|
* @param {string} [langCode] - Language code parameter. Default "en_US"
|
|
62
62
|
* @param {IProductsQuery} [userQuery] - Optional set query parameters.
|
|
63
63
|
*
|
|
64
|
-
* @param {number} [userQuery.offset] - Optional parameter for pagination, default is
|
|
65
|
-
* @param {number} [userQuery.limit] - Optional parameter for pagination, default is
|
|
64
|
+
* @param {number} [userQuery.offset] - Optional parameter for pagination, default is 0
|
|
65
|
+
* @param {number} [userQuery.limit] - Optional parameter for pagination, default is 30
|
|
66
66
|
* @param {string} [userQuery.statusMarker] - Optional identifier of the product page status
|
|
67
67
|
* @param {string} [userQuery.conditionValue] - Optional value that is being searched
|
|
68
68
|
* @param {string} [userQuery.conditionMarker] - Optional identifier of the filter condition by which values are filtered
|
|
@@ -76,13 +76,13 @@ export default class ProductApi extends AsyncModules implements IProductApi {
|
|
|
76
76
|
/**
|
|
77
77
|
* Search for all products with pagination for the selected category.
|
|
78
78
|
*
|
|
79
|
-
* @param {Array<IFilterParams>} body - Request body.
|
|
80
79
|
* @param {number} id - Page id.
|
|
80
|
+
* @param {Array<IFilterParams>} body - Request body.
|
|
81
81
|
* @param {string} [langCode] - Language code parameter. Default "en_US"
|
|
82
82
|
* @param {IProductsQuery} [userQuery] - Optional set query parameters.
|
|
83
83
|
*
|
|
84
|
-
* @param {number} [userQuery.offset] - Optional parameter for pagination, default is
|
|
85
|
-
* @param {number} [userQuery.limit] - Optional parameter for pagination, default is
|
|
84
|
+
* @param {number} [userQuery.offset] - Optional parameter for pagination, default is 0
|
|
85
|
+
* @param {number} [userQuery.limit] - Optional parameter for pagination, default is 30
|
|
86
86
|
* @param {string} [userQuery.statusMarker] - Optional identifier of the product page status
|
|
87
87
|
* @param {string} [userQuery.conditionValue] - Optional value that is being searched
|
|
88
88
|
* @param {string} [userQuery.conditionMarker] - Optional identifier of the filter condition by which values are filtered
|
|
@@ -121,8 +121,8 @@ export default class ProductApi extends AsyncModules implements IProductApi {
|
|
|
121
121
|
/**
|
|
122
122
|
* Search for information about products and prices for the selected category.
|
|
123
123
|
*
|
|
124
|
-
* @param {string} url - Page url.
|
|
125
|
-
* @param {string} langCode - Language code.
|
|
124
|
+
* @param {string} [url] - Page url.
|
|
125
|
+
* @param {string} [langCode] - Language code.
|
|
126
126
|
* @param {IProductsQuery} [userQuery] - Optional set query parameters.
|
|
127
127
|
*
|
|
128
128
|
* @param {number} [userQuery.offset] - Optional parameter for pagination, default is 30
|
|
@@ -140,8 +140,8 @@ export default class ProductApi extends AsyncModules implements IProductApi {
|
|
|
140
140
|
/**
|
|
141
141
|
* Search for all products with pagination for the selected category.
|
|
142
142
|
*
|
|
143
|
-
* @param {
|
|
144
|
-
* @param {
|
|
143
|
+
* @param {string} [url] - Page url.
|
|
144
|
+
* @param {Array<IFilterParams>} [body] - Request body.
|
|
145
145
|
* @param {string} [langCode] - Language code parameter. Default "en_US"
|
|
146
146
|
* @param {IProductsQuery} [userQuery] - Optional set query parameters.
|
|
147
147
|
*
|
|
@@ -189,8 +189,8 @@ export default class ProductApi extends AsyncModules implements IProductApi {
|
|
|
189
189
|
* @param {string} [langCode] - Language code parameter. Default "en_US"
|
|
190
190
|
* @param {IProductsQuery} [userQuery] - Optional set query parameters.
|
|
191
191
|
*
|
|
192
|
-
* @param {number} [userQuery.offset] - Optional parameter for pagination, default is
|
|
193
|
-
* @param {number} [userQuery.limit] - Optional parameter for pagination, default is
|
|
192
|
+
* @param {number} [userQuery.offset] - Optional parameter for pagination, default is 0
|
|
193
|
+
* @param {number} [userQuery.limit] - Optional parameter for pagination, default is 30
|
|
194
194
|
* @param {string} [userQuery.sortOrder] - Optional sorting order DESC | ASC
|
|
195
195
|
* @param {string} [userQuery.sortKey] - Optional field to sort by (id, title, date, price, position, status)
|
|
196
196
|
*
|
|
@@ -204,19 +204,19 @@ export default class ProductApi extends AsyncModules implements IProductApi {
|
|
|
204
204
|
* @param {string} [langCode] - Language code parameter. Default "en_US"
|
|
205
205
|
* @param {IProductsQuery} [userQuery] - Optional set query parameters.
|
|
206
206
|
*
|
|
207
|
-
* @param {number} [userQuery.offset] - Optional parameter for pagination, default is
|
|
208
|
-
* @param {number} [userQuery.limit] - Optional parameter for pagination, default is
|
|
207
|
+
* @param {number} [userQuery.offset] - Optional parameter for pagination, default is 0
|
|
208
|
+
* @param {number} [userQuery.limit] - Optional parameter for pagination, default is 30
|
|
209
209
|
* @param {string} [userQuery.sortOrder] - Optional sorting order DESC | ASC
|
|
210
210
|
* @param {string} [userQuery.sortKey] - Optional field to sort by (id, title, date, price, position, status)
|
|
211
211
|
*
|
|
212
212
|
* @returns Array with ProductEntity objects
|
|
213
213
|
*/
|
|
214
|
-
getProductsByIds(ids: string, langCode?: string, userQuery?: IProductsQuery): Promise<Array<
|
|
214
|
+
getProductsByIds(ids: string, langCode?: string, userQuery?: IProductsQuery): Promise<Array<IProductEntity> | IError>;
|
|
215
215
|
/**
|
|
216
216
|
* Retrieve one product object.
|
|
217
217
|
*
|
|
218
218
|
* @param {number} [id] - Product id.
|
|
219
|
-
* @param {string} [langCode] Language code parameter. Default "en_US".
|
|
219
|
+
* @param {string} [langCode] - Language code parameter. Default "en_US".
|
|
220
220
|
*
|
|
221
221
|
* @returns ProductEntity object.
|
|
222
222
|
*/
|
|
@@ -224,7 +224,7 @@ export default class ProductApi extends AsyncModules implements IProductApi {
|
|
|
224
224
|
/**
|
|
225
225
|
* Getting a product block object by product id.
|
|
226
226
|
*
|
|
227
|
-
* @param {number} id - Product id
|
|
227
|
+
* @param {number} [id] - Product id
|
|
228
228
|
*/
|
|
229
229
|
getProductBlockById(id: number): Promise<Array<IProductBlock> | IError>;
|
|
230
230
|
/**
|
|
@@ -22,12 +22,12 @@ class ProductApi extends asyncModules_1.default {
|
|
|
22
22
|
/**
|
|
23
23
|
* Search for all products with pagination and filter.
|
|
24
24
|
*
|
|
25
|
-
* @param {Array<IFilterParams>} body - Request body. Default [].
|
|
25
|
+
* @param {Array<IFilterParams>} [body] - Request body. Default [].
|
|
26
26
|
* @param {string} [langCode] - Language code parameter. Default "en_US"
|
|
27
27
|
* @param {IProductsQuery} [userQuery] - Optional set query parameters.
|
|
28
28
|
*
|
|
29
|
-
* @param {number} [userQuery.offset] - Optional parameter for pagination, default is
|
|
30
|
-
* @param {number} [userQuery.limit] - Optional parameter for pagination, default is
|
|
29
|
+
* @param {number} [userQuery.offset] - Optional parameter for pagination, default is 0
|
|
30
|
+
* @param {number} [userQuery.limit] - Optional parameter for pagination, default is 30
|
|
31
31
|
* @param {string} [userQuery.sortOrder] - Optional sorting order DESC | ASC
|
|
32
32
|
* @param {string} [userQuery.sortKey] - Optional field to sort by (id, title, date, price, position, status)
|
|
33
33
|
* @param {number} [userQuery.statusId] - Optional parameter - search by status id
|
|
@@ -78,8 +78,8 @@ class ProductApi extends asyncModules_1.default {
|
|
|
78
78
|
* @param {string} [langCode] - Language code parameter. Default "en_US"
|
|
79
79
|
* @param {IProductsQuery} [userQuery] - Optional set query parameters.
|
|
80
80
|
*
|
|
81
|
-
* @param {number} [userQuery.offset] - Optional parameter for pagination, default is
|
|
82
|
-
* @param {number} [userQuery.limit] - Optional parameter for pagination, default is
|
|
81
|
+
* @param {number} [userQuery.offset] - Optional parameter for pagination, default is 0
|
|
82
|
+
* @param {number} [userQuery.limit] - Optional parameter for pagination, default is 30
|
|
83
83
|
* @param {string} [userQuery.statusMarker] - Optional identifier of the product page status
|
|
84
84
|
* @param {string} [userQuery.conditionValue] - Optional value that is being searched
|
|
85
85
|
* @param {string} [userQuery.conditionMarker] - Optional identifier of the filter condition by which values are filtered
|
|
@@ -97,13 +97,13 @@ class ProductApi extends asyncModules_1.default {
|
|
|
97
97
|
/**
|
|
98
98
|
* Search for all products with pagination for the selected category.
|
|
99
99
|
*
|
|
100
|
-
* @param {Array<IFilterParams>} body - Request body.
|
|
101
100
|
* @param {number} id - Page id.
|
|
101
|
+
* @param {Array<IFilterParams>} body - Request body.
|
|
102
102
|
* @param {string} [langCode] - Language code parameter. Default "en_US"
|
|
103
103
|
* @param {IProductsQuery} [userQuery] - Optional set query parameters.
|
|
104
104
|
*
|
|
105
|
-
* @param {number} [userQuery.offset] - Optional parameter for pagination, default is
|
|
106
|
-
* @param {number} [userQuery.limit] - Optional parameter for pagination, default is
|
|
105
|
+
* @param {number} [userQuery.offset] - Optional parameter for pagination, default is 0
|
|
106
|
+
* @param {number} [userQuery.limit] - Optional parameter for pagination, default is 30
|
|
107
107
|
* @param {string} [userQuery.statusMarker] - Optional identifier of the product page status
|
|
108
108
|
* @param {string} [userQuery.conditionValue] - Optional value that is being searched
|
|
109
109
|
* @param {string} [userQuery.conditionMarker] - Optional identifier of the filter condition by which values are filtered
|
|
@@ -146,8 +146,8 @@ class ProductApi extends asyncModules_1.default {
|
|
|
146
146
|
/**
|
|
147
147
|
* Search for information about products and prices for the selected category.
|
|
148
148
|
*
|
|
149
|
-
* @param {string} url - Page url.
|
|
150
|
-
* @param {string} langCode - Language code.
|
|
149
|
+
* @param {string} [url] - Page url.
|
|
150
|
+
* @param {string} [langCode] - Language code.
|
|
151
151
|
* @param {IProductsQuery} [userQuery] - Optional set query parameters.
|
|
152
152
|
*
|
|
153
153
|
* @param {number} [userQuery.offset] - Optional parameter for pagination, default is 30
|
|
@@ -173,8 +173,8 @@ class ProductApi extends asyncModules_1.default {
|
|
|
173
173
|
/**
|
|
174
174
|
* Search for all products with pagination for the selected category.
|
|
175
175
|
*
|
|
176
|
-
* @param {
|
|
177
|
-
* @param {
|
|
176
|
+
* @param {string} [url] - Page url.
|
|
177
|
+
* @param {Array<IFilterParams>} [body] - Request body.
|
|
178
178
|
* @param {string} [langCode] - Language code parameter. Default "en_US"
|
|
179
179
|
* @param {IProductsQuery} [userQuery] - Optional set query parameters.
|
|
180
180
|
*
|
|
@@ -227,8 +227,8 @@ class ProductApi extends asyncModules_1.default {
|
|
|
227
227
|
* @param {string} [langCode] - Language code parameter. Default "en_US"
|
|
228
228
|
* @param {IProductsQuery} [userQuery] - Optional set query parameters.
|
|
229
229
|
*
|
|
230
|
-
* @param {number} [userQuery.offset] - Optional parameter for pagination, default is
|
|
231
|
-
* @param {number} [userQuery.limit] - Optional parameter for pagination, default is
|
|
230
|
+
* @param {number} [userQuery.offset] - Optional parameter for pagination, default is 0
|
|
231
|
+
* @param {number} [userQuery.limit] - Optional parameter for pagination, default is 30
|
|
232
232
|
* @param {string} [userQuery.sortOrder] - Optional sorting order DESC | ASC
|
|
233
233
|
* @param {string} [userQuery.sortKey] - Optional field to sort by (id, title, date, price, position, status)
|
|
234
234
|
*
|
|
@@ -246,8 +246,8 @@ class ProductApi extends asyncModules_1.default {
|
|
|
246
246
|
* @param {string} [langCode] - Language code parameter. Default "en_US"
|
|
247
247
|
* @param {IProductsQuery} [userQuery] - Optional set query parameters.
|
|
248
248
|
*
|
|
249
|
-
* @param {number} [userQuery.offset] - Optional parameter for pagination, default is
|
|
250
|
-
* @param {number} [userQuery.limit] - Optional parameter for pagination, default is
|
|
249
|
+
* @param {number} [userQuery.offset] - Optional parameter for pagination, default is 0
|
|
250
|
+
* @param {number} [userQuery.limit] - Optional parameter for pagination, default is 30
|
|
251
251
|
* @param {string} [userQuery.sortOrder] - Optional sorting order DESC | ASC
|
|
252
252
|
* @param {string} [userQuery.sortKey] - Optional field to sort by (id, title, date, price, position, status)
|
|
253
253
|
*
|
|
@@ -267,7 +267,7 @@ class ProductApi extends asyncModules_1.default {
|
|
|
267
267
|
* Retrieve one product object.
|
|
268
268
|
*
|
|
269
269
|
* @param {number} [id] - Product id.
|
|
270
|
-
* @param {string} [langCode] Language code parameter. Default "en_US".
|
|
270
|
+
* @param {string} [langCode] - Language code parameter. Default "en_US".
|
|
271
271
|
*
|
|
272
272
|
* @returns ProductEntity object.
|
|
273
273
|
*/
|
|
@@ -278,7 +278,7 @@ class ProductApi extends asyncModules_1.default {
|
|
|
278
278
|
/**
|
|
279
279
|
* Getting a product block object by product id.
|
|
280
280
|
*
|
|
281
|
-
* @param {number} id - Product id
|
|
281
|
+
* @param {number} [id] - Product id
|
|
282
282
|
*/
|
|
283
283
|
async getProductBlockById(id) {
|
|
284
284
|
const response = await this._fetchGet(`/${id}/blocks`);
|
|
@@ -20,7 +20,7 @@ export default class TemplatesPreviewApi extends AsyncModules implements ITempla
|
|
|
20
20
|
/**
|
|
21
21
|
* Get template objects by type.
|
|
22
22
|
*
|
|
23
|
-
* @param {Types} type -
|
|
23
|
+
* @param {Types} [type] - type
|
|
24
24
|
* @param {string} [langCode] - Optional parameter language code
|
|
25
25
|
*
|
|
26
26
|
* @returns Returns a TemplateEntity object
|
|
@@ -29,7 +29,7 @@ export default class TemplatesPreviewApi extends AsyncModules implements ITempla
|
|
|
29
29
|
/**
|
|
30
30
|
* Get one template object by id.
|
|
31
31
|
*
|
|
32
|
-
* @param {number} id - Template id
|
|
32
|
+
* @param {number} [id] - Template id
|
|
33
33
|
* @param {string} [langCode] - Optional parameter language code
|
|
34
34
|
*
|
|
35
35
|
* @returns Returns a TemplateEntity object
|
|
@@ -38,7 +38,7 @@ export default class TemplatesPreviewApi extends AsyncModules implements ITempla
|
|
|
38
38
|
/**
|
|
39
39
|
* Get one template object by id.
|
|
40
40
|
*
|
|
41
|
-
* @param {number} marker - Template marker
|
|
41
|
+
* @param {number} [marker] - Template marker
|
|
42
42
|
* @param {string} [langCode] - Optional parameter language code
|
|
43
43
|
*
|
|
44
44
|
* @returns Returns a TemplateEntity object
|
|
@@ -32,7 +32,7 @@ class TemplatesPreviewApi extends asyncModules_1.default {
|
|
|
32
32
|
/**
|
|
33
33
|
* Get template objects by type.
|
|
34
34
|
*
|
|
35
|
-
* @param {Types} type -
|
|
35
|
+
* @param {Types} [type] - type
|
|
36
36
|
* @param {string} [langCode] - Optional parameter language code
|
|
37
37
|
*
|
|
38
38
|
* @returns Returns a TemplateEntity object
|
|
@@ -44,7 +44,7 @@ class TemplatesPreviewApi extends asyncModules_1.default {
|
|
|
44
44
|
/**
|
|
45
45
|
* Get one template object by id.
|
|
46
46
|
*
|
|
47
|
-
* @param {number} id - Template id
|
|
47
|
+
* @param {number} [id] - Template id
|
|
48
48
|
* @param {string} [langCode] - Optional parameter language code
|
|
49
49
|
*
|
|
50
50
|
* @returns Returns a TemplateEntity object
|
|
@@ -56,7 +56,7 @@ class TemplatesPreviewApi extends asyncModules_1.default {
|
|
|
56
56
|
/**
|
|
57
57
|
* Get one template object by id.
|
|
58
58
|
*
|
|
59
|
-
* @param {number} marker - Template marker
|
|
59
|
+
* @param {number} [marker] - Template marker
|
|
60
60
|
* @param {string} [langCode] - Optional parameter language code
|
|
61
61
|
*
|
|
62
62
|
* @returns Returns a TemplateEntity object
|
|
@@ -20,7 +20,7 @@ export default class TemplatePreviewsApi extends AsyncModules implements ITempla
|
|
|
20
20
|
/**
|
|
21
21
|
* Get one template object by id.
|
|
22
22
|
*
|
|
23
|
-
* @param {number} id - Product marker
|
|
23
|
+
* @param {number} [id] - Product marker
|
|
24
24
|
* @param {string} [langCode] - Optional parameter language code
|
|
25
25
|
*
|
|
26
26
|
* @returns Returns a TemplatePreviewsEntity object
|
|
@@ -29,7 +29,7 @@ export default class TemplatePreviewsApi extends AsyncModules implements ITempla
|
|
|
29
29
|
/**
|
|
30
30
|
* Get one template object by marker.
|
|
31
31
|
*
|
|
32
|
-
* @param {string} marker - Product marker
|
|
32
|
+
* @param {string} [marker] - Product marker
|
|
33
33
|
* @param {string} [langCode] - Optional parameter language code
|
|
34
34
|
*
|
|
35
35
|
* @returns Returns a TemplatePreviewsEntity object
|
|
@@ -26,7 +26,7 @@ class TemplatePreviewsApi extends asyncModules_1.default {
|
|
|
26
26
|
/**
|
|
27
27
|
* Get one template object by id.
|
|
28
28
|
*
|
|
29
|
-
* @param {number} id - Product marker
|
|
29
|
+
* @param {number} [id] - Product marker
|
|
30
30
|
* @param {string} [langCode] - Optional parameter language code
|
|
31
31
|
*
|
|
32
32
|
* @returns Returns a TemplatePreviewsEntity object
|
|
@@ -38,7 +38,7 @@ class TemplatePreviewsApi extends asyncModules_1.default {
|
|
|
38
38
|
/**
|
|
39
39
|
* Get one template object by marker.
|
|
40
40
|
*
|
|
41
|
-
* @param {string} marker - Product marker
|
|
41
|
+
* @param {string} [marker] - Product marker
|
|
42
42
|
* @param {string} [langCode] - Optional parameter language code
|
|
43
43
|
*
|
|
44
44
|
* @returns Returns a TemplatePreviewsEntity object
|
package/dist/users/usersApi.d.ts
CHANGED
|
@@ -14,15 +14,15 @@ export default class UsersApi extends AsyncModules implements IUsers {
|
|
|
14
14
|
*
|
|
15
15
|
* @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.
|
|
16
16
|
*
|
|
17
|
-
* @param {string} [langCode]
|
|
17
|
+
* @param {string} [langCode] - lang code.
|
|
18
18
|
*/
|
|
19
19
|
getUser(langCode?: string): Promise<IUserEntity | IError>;
|
|
20
20
|
/**
|
|
21
21
|
* Updating a single user object.
|
|
22
22
|
* @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.
|
|
23
23
|
*
|
|
24
|
-
* @param {object}
|
|
25
|
-
* @param {string} langCode - Optional language field
|
|
24
|
+
* @param {object} [body] - Request body.
|
|
25
|
+
* @param {string} [langCode] - Optional language field
|
|
26
26
|
*
|
|
27
27
|
* @example
|
|
28
28
|
* {
|
|
@@ -46,22 +46,22 @@ export default class UsersApi extends AsyncModules implements IUsers {
|
|
|
46
46
|
* "state": {}
|
|
47
47
|
* }
|
|
48
48
|
*/
|
|
49
|
-
updateUser(
|
|
49
|
+
updateUser(body: IUserBody, langCode?: string): Promise<boolean | IError>;
|
|
50
50
|
/**
|
|
51
51
|
* Delete a single user object.
|
|
52
52
|
* @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
53
|
*
|
|
54
|
-
* @param {object}
|
|
55
|
-
* @param {string} langCode - Optional language field
|
|
54
|
+
* @param {object} [body] - Request body.
|
|
55
|
+
* @param {string} [langCode] - Optional language field
|
|
56
56
|
*
|
|
57
57
|
*/
|
|
58
|
-
deleteUser(
|
|
58
|
+
deleteUser(body: IUserBody, langCode?: string): Promise<boolean | IError>;
|
|
59
59
|
/**
|
|
60
60
|
* Adds FCM token for sending Push notification.
|
|
61
61
|
*
|
|
62
62
|
* @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.
|
|
63
63
|
*
|
|
64
|
-
* @param {string} token - Cloud messaging token.
|
|
64
|
+
* @param {string} [token] - Cloud messaging token.
|
|
65
65
|
*/
|
|
66
66
|
addFCMToken(token: string): Promise<boolean | IError>;
|
|
67
67
|
/**
|
|
@@ -69,7 +69,7 @@ export default class UsersApi extends AsyncModules implements IUsers {
|
|
|
69
69
|
*
|
|
70
70
|
* @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.
|
|
71
71
|
*
|
|
72
|
-
* @param {string} token - Cloud messaging token.
|
|
72
|
+
* @param {string} [token] - Cloud messaging token.
|
|
73
73
|
*/
|
|
74
74
|
deleteFCMToken(token: string): Promise<boolean | IError>;
|
|
75
75
|
}
|
package/dist/users/usersApi.js
CHANGED
|
@@ -17,7 +17,7 @@ class UsersApi extends asyncModules_1.default {
|
|
|
17
17
|
*
|
|
18
18
|
* @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.
|
|
19
19
|
*
|
|
20
|
-
* @param {string} [langCode]
|
|
20
|
+
* @param {string} [langCode] - lang code.
|
|
21
21
|
*/
|
|
22
22
|
async getUser(langCode = this.state.lang) {
|
|
23
23
|
const result = await this._fetchGet(`/me?langCode=${langCode}`);
|
|
@@ -27,8 +27,8 @@ class UsersApi extends asyncModules_1.default {
|
|
|
27
27
|
* Updating a single user object.
|
|
28
28
|
* @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.
|
|
29
29
|
*
|
|
30
|
-
* @param {object}
|
|
31
|
-
* @param {string} langCode - Optional language field
|
|
30
|
+
* @param {object} [body] - Request body.
|
|
31
|
+
* @param {string} [langCode] - Optional language field
|
|
32
32
|
*
|
|
33
33
|
* @example
|
|
34
34
|
* {
|
|
@@ -52,32 +52,32 @@ class UsersApi extends asyncModules_1.default {
|
|
|
52
52
|
* "state": {}
|
|
53
53
|
* }
|
|
54
54
|
*/
|
|
55
|
-
async updateUser(
|
|
56
|
-
if (!('langCode' in
|
|
57
|
-
|
|
55
|
+
async updateUser(body, langCode = this.state.lang) {
|
|
56
|
+
if (!('langCode' in body))
|
|
57
|
+
body['langCode'] = langCode;
|
|
58
58
|
const result = await this._fetchPut('/me',
|
|
59
59
|
// eslint-disable-next-line no-prototype-builtins
|
|
60
|
-
|
|
61
|
-
? this._normalizePostBody(
|
|
62
|
-
:
|
|
60
|
+
body.hasOwnProperty('formData')
|
|
61
|
+
? this._normalizePostBody(body, langCode)
|
|
62
|
+
: body);
|
|
63
63
|
return result;
|
|
64
64
|
}
|
|
65
65
|
/**
|
|
66
66
|
* Delete a single user object.
|
|
67
67
|
* @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.
|
|
68
68
|
*
|
|
69
|
-
* @param {object}
|
|
70
|
-
* @param {string} langCode - Optional language field
|
|
69
|
+
* @param {object} [body] - Request body.
|
|
70
|
+
* @param {string} [langCode] - Optional language field
|
|
71
71
|
*
|
|
72
72
|
*/
|
|
73
|
-
async deleteUser(
|
|
74
|
-
if (!('langCode' in
|
|
75
|
-
|
|
73
|
+
async deleteUser(body, langCode = this.state.lang) {
|
|
74
|
+
if (!('langCode' in body))
|
|
75
|
+
body['langCode'] = langCode;
|
|
76
76
|
const result = await this._fetchDelete('/me',
|
|
77
77
|
// eslint-disable-next-line no-prototype-builtins
|
|
78
|
-
|
|
79
|
-
? this._normalizePostBody(
|
|
80
|
-
:
|
|
78
|
+
body.hasOwnProperty('formData')
|
|
79
|
+
? this._normalizePostBody(body, langCode)
|
|
80
|
+
: body);
|
|
81
81
|
return result;
|
|
82
82
|
}
|
|
83
83
|
/**
|
|
@@ -85,7 +85,7 @@ class UsersApi extends asyncModules_1.default {
|
|
|
85
85
|
*
|
|
86
86
|
* @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.
|
|
87
87
|
*
|
|
88
|
-
* @param {string} token - Cloud messaging token.
|
|
88
|
+
* @param {string} [token] - Cloud messaging token.
|
|
89
89
|
*/
|
|
90
90
|
async addFCMToken(token) {
|
|
91
91
|
const result = await this._fetchPost(`/me/fcm-token/${token}`);
|
|
@@ -96,7 +96,7 @@ class UsersApi extends asyncModules_1.default {
|
|
|
96
96
|
*
|
|
97
97
|
* @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.
|
|
98
98
|
*
|
|
99
|
-
* @param {string} token - Cloud messaging token.
|
|
99
|
+
* @param {string} [token] - Cloud messaging token.
|
|
100
100
|
*/
|
|
101
101
|
async deleteFCMToken(token) {
|
|
102
102
|
const result = await this._fetchDelete(`/me/fcm-token/${token}`);
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "oneentry",
|
|
3
|
-
"version": "1.0.
|
|
3
|
+
"version": "1.0.110",
|
|
4
4
|
"description": "OneEntry NPM package",
|
|
5
5
|
"main": "dist/index.js",
|
|
6
6
|
"types": "dist/index.d.ts",
|
|
@@ -8,8 +8,8 @@
|
|
|
8
8
|
"/dist"
|
|
9
9
|
],
|
|
10
10
|
"scripts": {
|
|
11
|
-
"productionBuild": "run-s lint testAll build",
|
|
12
|
-
"testAll": "run-s admins attributesets authProvider blocks fileuploading forms formsdata generaltypes locales menus orders pages payments payments productstatuses products templates templatespreview users",
|
|
11
|
+
"productionBuild": "run-s lint testAll build readme",
|
|
12
|
+
"testAll": "run-s admins attributesets authProvider blocks fileuploading forms formsdata generaltypes integrationcollections locales menus orders pages payments payments productstatuses products templates templatespreview users",
|
|
13
13
|
"admins": "npx jest src/admins/admins.spec.ts",
|
|
14
14
|
"attributesets": "npx jest src/attribute-sets/attributesets.spec.ts",
|
|
15
15
|
"authProvider": "npx jest src/auth-provider/authProvider.spec.ts",
|
|
@@ -31,7 +31,7 @@
|
|
|
31
31
|
"users": "npx jest src/users/users.spec.ts",
|
|
32
32
|
"lint": "npx eslint",
|
|
33
33
|
"build": "npx tsc",
|
|
34
|
-
"
|
|
34
|
+
"readme": "node ./src/readme.js"
|
|
35
35
|
},
|
|
36
36
|
"bin": {
|
|
37
37
|
"oneentry": "./configure.js"
|
|
@@ -47,9 +47,9 @@
|
|
|
47
47
|
"@microsoft/tsdoc": "^0.15.1",
|
|
48
48
|
"@types/eslint-config-prettier": "^6.11.3",
|
|
49
49
|
"@types/jest": "^29.5.14",
|
|
50
|
-
"@types/node": "^22.
|
|
51
|
-
"@typescript-eslint/eslint-plugin": "^8.
|
|
52
|
-
"@typescript-eslint/parser": "^8.
|
|
50
|
+
"@types/node": "^22.13.0",
|
|
51
|
+
"@typescript-eslint/eslint-plugin": "^8.22.0",
|
|
52
|
+
"@typescript-eslint/parser": "^8.22.0",
|
|
53
53
|
"eslint": "^8.57.1",
|
|
54
54
|
"eslint-config-prettier": "^10.0.1",
|
|
55
55
|
"eslint-plugin-import": "^2.31.0",
|
|
@@ -60,7 +60,6 @@
|
|
|
60
60
|
"npm-run-all": "^4.1.5",
|
|
61
61
|
"prettier": "^3.4.2",
|
|
62
62
|
"ts-jest": "^29.2.5",
|
|
63
|
-
"tsdoc-markdown": "^1.1.1",
|
|
64
63
|
"typescript": "^5.7.3"
|
|
65
64
|
}
|
|
66
|
-
}
|
|
65
|
+
}
|