oneentry 1.0.106 → 1.0.109
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 +6479 -3951
- package/dist/attribute-sets/attributeSetsApi.d.ts +11 -14
- package/dist/attribute-sets/attributeSetsApi.js +14 -17
- package/dist/attribute-sets/attributeSetsInterfaces.d.ts +2 -2
- 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 +11 -7
- 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 +18 -20
- package/dist/integration-collections/integrationCollectionsApi.js +15 -19
- package/dist/integration-collections/integrationCollectionsInterfaces.d.ts +45 -8
- 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/orders/ordersInterfaces.d.ts +2 -2
- 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/products/productsInterfaces.d.ts +1 -1
- 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
- package/readme.js +103 -0
package/dist/orders/ordersApi.js
CHANGED
|
@@ -13,6 +13,56 @@ class OrdersApi extends asyncModules_1.default {
|
|
|
13
13
|
super(state);
|
|
14
14
|
this._url = state.url + '/api/content/orders-storage';
|
|
15
15
|
}
|
|
16
|
+
/**
|
|
17
|
+
* Getting all the order storage objects
|
|
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
|
+
*
|
|
20
|
+
* @param {number} [langCode] - Optional language field
|
|
21
|
+
* @param {number} [offset] - Optional parameter for pagination, default is 0
|
|
22
|
+
* @param {number} [limit] - Optional parameter for pagination, default is 30
|
|
23
|
+
*/
|
|
24
|
+
async getAllOrdersStorage(langCode = this.state.lang, offset = 0, limit = 30) {
|
|
25
|
+
const result = await this._fetchGet(`?langCode=${langCode}&limit=${limit}&offset=${offset}`);
|
|
26
|
+
return this._normalizeData(result);
|
|
27
|
+
}
|
|
28
|
+
/**
|
|
29
|
+
* Getting all orders from the orders storage object created by the user
|
|
30
|
+
*
|
|
31
|
+
* @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.
|
|
32
|
+
* @param {string} [marker] - Textual identifier of the order storage object
|
|
33
|
+
* @param {string} [langCode] - Optional language field
|
|
34
|
+
* @param {number} [offset] - Offset parameter. Default 0
|
|
35
|
+
* @param {number} [limit] - Limit parameter. Default 30
|
|
36
|
+
*/
|
|
37
|
+
async getAllOrdersByMarker(marker, langCode = this.state.lang, offset = 0, limit = 30) {
|
|
38
|
+
const result = await this._fetchGet(`/marker/${marker}/orders?langCode=${langCode}&limit=${limit}&offset=${offset}`);
|
|
39
|
+
return this._normalizeData(result);
|
|
40
|
+
}
|
|
41
|
+
/**
|
|
42
|
+
* Retrieve one order storage object by marker.
|
|
43
|
+
*
|
|
44
|
+
* @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.
|
|
45
|
+
* @param {string} [marker] - Marker of the order object
|
|
46
|
+
* @param {string} [langCode] - Language code
|
|
47
|
+
*
|
|
48
|
+
* @returns Return object of order information.
|
|
49
|
+
*/
|
|
50
|
+
async getOrderByMarker(marker, langCode = this.state.lang) {
|
|
51
|
+
const result = await this._fetchGet(`/marker/${marker}?langCode=${langCode}`);
|
|
52
|
+
return this._normalizeData(result);
|
|
53
|
+
}
|
|
54
|
+
/**
|
|
55
|
+
* Getting a single order from the order storage object created by the user
|
|
56
|
+
*
|
|
57
|
+
* @param {string} [marker] - The text identifier of the order storage object
|
|
58
|
+
* @param {number} [id] - ID of the order object
|
|
59
|
+
* @param {string} [langCode] - Optional language field
|
|
60
|
+
*
|
|
61
|
+
*/
|
|
62
|
+
async getOrderByMarkerAndId(marker, id, langCode = this.state.lang) {
|
|
63
|
+
const result = await this._fetchGet(`/marker/${marker}/orders/${id}?langCode=${langCode}`);
|
|
64
|
+
return this._normalizeData(result);
|
|
65
|
+
}
|
|
16
66
|
/**
|
|
17
67
|
* Creation of an order in the order storage.
|
|
18
68
|
*
|
|
@@ -50,27 +100,14 @@ class OrdersApi extends asyncModules_1.default {
|
|
|
50
100
|
const result = await this._fetchPost(`/marker/${marker}/orders`, data);
|
|
51
101
|
return this._normalizeData(result);
|
|
52
102
|
}
|
|
53
|
-
/**
|
|
54
|
-
* Getting all orders from the orders storage object created by the user
|
|
55
|
-
*
|
|
56
|
-
* @description This method requires user authorization. For more information about configuring the authorization module, see the documentation in the configuration settings section of the SDK.
|
|
57
|
-
* @param {number} marker - Textual identifier of the order storage object
|
|
58
|
-
* @param {string} [langCode] Optional language field
|
|
59
|
-
* @param {number} [offset] Offset parameter. Default 0
|
|
60
|
-
* @param {number} [limit] Limit parameter. Default 30
|
|
61
|
-
*/
|
|
62
|
-
async getAllOrdersByMarker(marker, langCode = this.state.lang, offset = 0, limit = 30) {
|
|
63
|
-
const result = await this._fetchGet(`/marker/${marker}/orders?langCode=${langCode}&limit=${limit}&offset=${offset}`);
|
|
64
|
-
return this._normalizeData(result);
|
|
65
|
-
}
|
|
66
103
|
/**
|
|
67
104
|
* Changing an order in the orders storage
|
|
68
105
|
*
|
|
69
106
|
* @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.
|
|
70
|
-
* @param marker - The text identifier of the order storage object
|
|
71
|
-
* @param id - ID of the order object
|
|
72
|
-
* @param
|
|
73
|
-
* @param langCode Optional language field
|
|
107
|
+
* @param {string} [marker] - The text identifier of the order storage object
|
|
108
|
+
* @param {number} [id] - ID of the order object
|
|
109
|
+
* @param {IOrderData} [body] - Object for updating an order
|
|
110
|
+
* @param {string} [langCode] - Optional language field
|
|
74
111
|
*
|
|
75
112
|
* @example
|
|
76
113
|
* const body = {
|
|
@@ -90,50 +127,13 @@ class OrdersApi extends asyncModules_1.default {
|
|
|
90
127
|
* "currency": "USD"
|
|
91
128
|
* }
|
|
92
129
|
*/
|
|
93
|
-
async updateOrderByMarkerAndId(marker, id,
|
|
130
|
+
async updateOrderByMarkerAndId(marker, id, body, langCode = this.state.lang) {
|
|
94
131
|
const formData = {};
|
|
95
|
-
formData[langCode] = Array.isArray(
|
|
96
|
-
?
|
|
97
|
-
: [
|
|
98
|
-
|
|
99
|
-
const result = await this._fetchPut(`/marker/${marker}/orders/${id}?langCode=${langCode}`,
|
|
100
|
-
return this._normalizeData(result);
|
|
101
|
-
}
|
|
102
|
-
/**
|
|
103
|
-
* Getting a single order from the order storage object created by the user
|
|
104
|
-
*
|
|
105
|
-
* @param marker - The text identifier of the order storage object
|
|
106
|
-
* @param id - ID of the order object
|
|
107
|
-
* @param langCode Optional language field
|
|
108
|
-
*
|
|
109
|
-
*/
|
|
110
|
-
async getOrderByMarkerAndId(marker, id, langCode = this.state.lang) {
|
|
111
|
-
const result = await this._fetchGet(`/marker/${marker}/orders/${id}?langCode=${langCode}`);
|
|
112
|
-
return this._normalizeData(result);
|
|
113
|
-
}
|
|
114
|
-
/**
|
|
115
|
-
* Getting all the order storage objects
|
|
116
|
-
* @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.
|
|
117
|
-
*
|
|
118
|
-
* @param {number} [langCode] Optional language field
|
|
119
|
-
* @param {number} [offset] - Optional parameter for pagination, default is 30
|
|
120
|
-
* @param {number} [limit] - Optional parameter for pagination, default is 0
|
|
121
|
-
*/
|
|
122
|
-
async getAllOrdersStorage(langCode = this.state.lang, offset = 0, limit = 30) {
|
|
123
|
-
const result = await this._fetchGet(`?langCode=${langCode}&limit=${limit}&offset=${offset}`);
|
|
124
|
-
return this._normalizeData(result);
|
|
125
|
-
}
|
|
126
|
-
/**
|
|
127
|
-
* Retrieve one order storage object by marker.
|
|
128
|
-
*
|
|
129
|
-
* @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.
|
|
130
|
-
* @param {string} marker - Marker of the order object
|
|
131
|
-
* @param {string} [langCode] - Language code
|
|
132
|
-
*
|
|
133
|
-
* @returns Return object of order information.
|
|
134
|
-
*/
|
|
135
|
-
async getOrderByMarker(marker, langCode = this.state.lang) {
|
|
136
|
-
const result = await this._fetchGet(`/marker/${marker}?langCode=${langCode}`);
|
|
132
|
+
formData[langCode] = Array.isArray(body.formData)
|
|
133
|
+
? body.formData
|
|
134
|
+
: [body.formData];
|
|
135
|
+
body.formData = formData;
|
|
136
|
+
const result = await this._fetchPut(`/marker/${marker}/orders/${id}?langCode=${langCode}`, body);
|
|
137
137
|
return this._normalizeData(result);
|
|
138
138
|
}
|
|
139
139
|
}
|
|
@@ -13,11 +13,11 @@ import type { IError } from '../base/utils';
|
|
|
13
13
|
*/
|
|
14
14
|
interface IOrdersApi {
|
|
15
15
|
createOrder(marker: string, data: IOrderData): Promise<IBaseOrdersEntity | IError>;
|
|
16
|
-
getAllOrdersByMarker(marker: string, langCode?: string,
|
|
16
|
+
getAllOrdersByMarker(marker: string, langCode?: string, offset?: number, limit?: number): Promise<IOrdersByMarkerEntity | IError>;
|
|
17
17
|
getOrderByMarker(marker: string, langCode?: string): Promise<IOrdersEntity | IError>;
|
|
18
18
|
updateOrderByMarkerAndId(marker: string, id: number, data: IOrderData, langCode?: string): Promise<IBaseOrdersEntity | IError>;
|
|
19
19
|
getOrderByMarkerAndId(marker: string, id: number, langCode?: string): Promise<IOrderByMarkerEntity | IError>;
|
|
20
|
-
getAllOrdersStorage(langCode?: string,
|
|
20
|
+
getAllOrdersStorage(langCode?: string, offset?: number, limit?: number): Promise<Array<IOrdersEntity> | IError>;
|
|
21
21
|
}
|
|
22
22
|
/**
|
|
23
23
|
* Represents a form data.
|
package/dist/pages/pagesApi.d.ts
CHANGED
|
@@ -12,7 +12,7 @@ export default class PageApi extends AsyncModules implements IPageApi {
|
|
|
12
12
|
/**
|
|
13
13
|
* Get all top-level page objects.
|
|
14
14
|
*
|
|
15
|
-
* @param {string} [langCode]
|
|
15
|
+
* @param {string} [langCode] - lang code
|
|
16
16
|
*
|
|
17
17
|
* @returns Returns all created pages without parents as an array of PageEntity objects or an empty array [] (if there is no data)
|
|
18
18
|
*/
|
|
@@ -20,7 +20,7 @@ export default class PageApi extends AsyncModules implements IPageApi {
|
|
|
20
20
|
/**
|
|
21
21
|
* Get all page objects with product information as an array.
|
|
22
22
|
*
|
|
23
|
-
* @param {string} [langCode]
|
|
23
|
+
* @param {string} [langCode] - lang code
|
|
24
24
|
*
|
|
25
25
|
* @returns Returns all created pages as an array of PageEntity objects or an empty array [] (if there is no data)
|
|
26
26
|
*/
|
|
@@ -28,8 +28,8 @@ export default class PageApi extends AsyncModules implements IPageApi {
|
|
|
28
28
|
/**
|
|
29
29
|
* Get page object with information about forms, blocks, menus, linked to the page.
|
|
30
30
|
*
|
|
31
|
-
* @param {string} [langCode] Required parameter lang code
|
|
32
31
|
* @param {number} [id] - Page object identifier
|
|
32
|
+
* @param {string} [langCode] - lang code
|
|
33
33
|
*
|
|
34
34
|
* @returns Returns PageEntity object
|
|
35
35
|
*/
|
|
@@ -37,8 +37,8 @@ export default class PageApi extends AsyncModules implements IPageApi {
|
|
|
37
37
|
/**
|
|
38
38
|
* Get page object with information about forms, blocks, menus, linked to the page by URL.
|
|
39
39
|
*
|
|
40
|
-
* @param {string} [langCode] Required parameter lang code
|
|
41
40
|
* @param {string} [url] - Page URL
|
|
41
|
+
* @param {string} [langCode] - lang code
|
|
42
42
|
*
|
|
43
43
|
* @returns Returns PageEntity object
|
|
44
44
|
*/
|
|
@@ -46,30 +46,30 @@ export default class PageApi extends AsyncModules implements IPageApi {
|
|
|
46
46
|
/**
|
|
47
47
|
* Get child pages object with information as an array.
|
|
48
48
|
*
|
|
49
|
-
* @param {string} [
|
|
50
|
-
* @param {string} [
|
|
49
|
+
* @param {string} [url] - Parent page URL
|
|
50
|
+
* @param {string} [langCode] - Required parameter lang code
|
|
51
51
|
*
|
|
52
52
|
* @returns Returns all created pages as an array of PageEntity objects or an empty array [] (if there is no data) for the selected parent
|
|
53
53
|
*/
|
|
54
54
|
getChildPagesByParentUrl(url: string, langCode?: string): Promise<Array<IPagesEntity> | IError>;
|
|
55
55
|
/**
|
|
56
|
-
* Get all
|
|
56
|
+
* Get all blocks by page url.
|
|
57
57
|
*
|
|
58
|
-
* @param {string} [langCode] Required parameter lang code
|
|
59
58
|
* @param {string} [url] - Page URL
|
|
59
|
+
* @param {string} [langCode] - lang code
|
|
60
60
|
*
|
|
61
|
-
* @returns Returns all
|
|
61
|
+
* @returns Returns all blocks as an array of PositionBlock objects or an empty array [] (if there is no data) for the selected parent
|
|
62
62
|
*/
|
|
63
|
-
|
|
63
|
+
getBlocksByPageUrl(url: string, langCode?: string): Promise<Array<IPositionBlock> | IError>;
|
|
64
64
|
/**
|
|
65
|
-
* Get all
|
|
65
|
+
* Get all forms by page url.
|
|
66
66
|
*
|
|
67
|
-
* @param {string} [langCode] Required parameter lang code
|
|
68
67
|
* @param {string} [url] - Page URL
|
|
68
|
+
* @param {string} [langCode] - lang code
|
|
69
69
|
*
|
|
70
|
-
* @returns Returns all
|
|
70
|
+
* @returns Returns all forms as an array of PositionForm objects or an empty array [] (if there is no data) for the selected parent
|
|
71
71
|
*/
|
|
72
|
-
|
|
72
|
+
getFormsByPageUrl(url: string, langCode?: string): Promise<Array<IPositionForm> | IError>;
|
|
73
73
|
/**
|
|
74
74
|
* Get settings for the page.
|
|
75
75
|
*
|
|
@@ -82,7 +82,7 @@ export default class PageApi extends AsyncModules implements IPageApi {
|
|
|
82
82
|
* Quick search for page objects with limited output.
|
|
83
83
|
*
|
|
84
84
|
* @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)
|
|
85
|
-
* @param {string} [langCode]
|
|
85
|
+
* @param {string} [langCode] - lang code
|
|
86
86
|
*
|
|
87
87
|
* @returns Returns all created pages as an array of PageEntity objects or an empty array [] (if there is no data)
|
|
88
88
|
*/
|
package/dist/pages/pagesApi.js
CHANGED
|
@@ -16,7 +16,7 @@ class PageApi extends asyncModules_1.default {
|
|
|
16
16
|
/**
|
|
17
17
|
* Get all top-level page objects.
|
|
18
18
|
*
|
|
19
|
-
* @param {string} [langCode]
|
|
19
|
+
* @param {string} [langCode] - lang code
|
|
20
20
|
*
|
|
21
21
|
* @returns Returns all created pages without parents as an array of PageEntity objects or an empty array [] (if there is no data)
|
|
22
22
|
*/
|
|
@@ -27,7 +27,7 @@ class PageApi extends asyncModules_1.default {
|
|
|
27
27
|
/**
|
|
28
28
|
* Get all page objects with product information as an array.
|
|
29
29
|
*
|
|
30
|
-
* @param {string} [langCode]
|
|
30
|
+
* @param {string} [langCode] - lang code
|
|
31
31
|
*
|
|
32
32
|
* @returns Returns all created pages as an array of PageEntity objects or an empty array [] (if there is no data)
|
|
33
33
|
*/
|
|
@@ -38,8 +38,8 @@ class PageApi extends asyncModules_1.default {
|
|
|
38
38
|
/**
|
|
39
39
|
* Get page object with information about forms, blocks, menus, linked to the page.
|
|
40
40
|
*
|
|
41
|
-
* @param {string} [langCode] Required parameter lang code
|
|
42
41
|
* @param {number} [id] - Page object identifier
|
|
42
|
+
* @param {string} [langCode] - lang code
|
|
43
43
|
*
|
|
44
44
|
* @returns Returns PageEntity object
|
|
45
45
|
*/
|
|
@@ -50,8 +50,8 @@ class PageApi extends asyncModules_1.default {
|
|
|
50
50
|
/**
|
|
51
51
|
* Get page object with information about forms, blocks, menus, linked to the page by URL.
|
|
52
52
|
*
|
|
53
|
-
* @param {string} [langCode] Required parameter lang code
|
|
54
53
|
* @param {string} [url] - Page URL
|
|
54
|
+
* @param {string} [langCode] - lang code
|
|
55
55
|
*
|
|
56
56
|
* @returns Returns PageEntity object
|
|
57
57
|
*/
|
|
@@ -62,8 +62,8 @@ class PageApi extends asyncModules_1.default {
|
|
|
62
62
|
/**
|
|
63
63
|
* Get child pages object with information as an array.
|
|
64
64
|
*
|
|
65
|
-
* @param {string} [
|
|
66
|
-
* @param {string} [
|
|
65
|
+
* @param {string} [url] - Parent page URL
|
|
66
|
+
* @param {string} [langCode] - Required parameter lang code
|
|
67
67
|
*
|
|
68
68
|
* @returns Returns all created pages as an array of PageEntity objects or an empty array [] (if there is no data) for the selected parent
|
|
69
69
|
*/
|
|
@@ -71,23 +71,11 @@ class PageApi extends asyncModules_1.default {
|
|
|
71
71
|
const result = await this._fetchGet(`/${url}/children?langCode=${langCode}`);
|
|
72
72
|
return this._normalizeData(result, langCode);
|
|
73
73
|
}
|
|
74
|
-
/**
|
|
75
|
-
* Get all forms by page url.
|
|
76
|
-
*
|
|
77
|
-
* @param {string} [langCode] Required parameter lang code
|
|
78
|
-
* @param {string} [url] - Page URL
|
|
79
|
-
*
|
|
80
|
-
* @returns Returns all forms as an array of PositionForm objects or an empty array [] (if there is no data) for the selected parent
|
|
81
|
-
*/
|
|
82
|
-
async getFormsByPageUrl(url, langCode = this.state.lang) {
|
|
83
|
-
const result = await this._fetchGet(`/${url}/forms?langCode=${langCode}`);
|
|
84
|
-
return this._normalizeData(result, langCode);
|
|
85
|
-
}
|
|
86
74
|
/**
|
|
87
75
|
* Get all blocks by page url.
|
|
88
76
|
*
|
|
89
|
-
* @param {string} [langCode] Required parameter lang code
|
|
90
77
|
* @param {string} [url] - Page URL
|
|
78
|
+
* @param {string} [langCode] - lang code
|
|
91
79
|
*
|
|
92
80
|
* @returns Returns all blocks as an array of PositionBlock objects or an empty array [] (if there is no data) for the selected parent
|
|
93
81
|
*/
|
|
@@ -151,6 +139,18 @@ class PageApi extends asyncModules_1.default {
|
|
|
151
139
|
}
|
|
152
140
|
return this._normalizeData(normalizeResponse);
|
|
153
141
|
}
|
|
142
|
+
/**
|
|
143
|
+
* Get all forms by page url.
|
|
144
|
+
*
|
|
145
|
+
* @param {string} [url] - Page URL
|
|
146
|
+
* @param {string} [langCode] - lang code
|
|
147
|
+
*
|
|
148
|
+
* @returns Returns all forms as an array of PositionForm objects or an empty array [] (if there is no data) for the selected parent
|
|
149
|
+
*/
|
|
150
|
+
async getFormsByPageUrl(url, langCode = this.state.lang) {
|
|
151
|
+
const result = await this._fetchGet(`/${url}/forms?langCode=${langCode}`);
|
|
152
|
+
return this._normalizeData(result, langCode);
|
|
153
|
+
}
|
|
154
154
|
/**
|
|
155
155
|
* Get settings for the page.
|
|
156
156
|
*
|
|
@@ -166,7 +166,7 @@ class PageApi extends asyncModules_1.default {
|
|
|
166
166
|
* Quick search for page objects with limited output.
|
|
167
167
|
*
|
|
168
168
|
* @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)
|
|
169
|
-
* @param {string} [langCode]
|
|
169
|
+
* @param {string} [langCode] - lang code
|
|
170
170
|
*
|
|
171
171
|
* @returns Returns all created pages as an array of PageEntity objects or an empty array [] (if there is no data)
|
|
172
172
|
*/
|
|
@@ -13,8 +13,8 @@ export default class PaymentsApi extends AsyncModules implements IPaymentsApi {
|
|
|
13
13
|
* Get list of payment sessions.
|
|
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
|
-
* @param {number} [offset] - Optional parameter for pagination, default is
|
|
17
|
-
* @param {number} [limit] - Optional parameter for pagination, default is
|
|
16
|
+
* @param {number} [offset] - Optional parameter for pagination, default is 0
|
|
17
|
+
* @param {number} [limit] - Optional parameter for pagination, default is 30
|
|
18
18
|
*
|
|
19
19
|
* @returns Returns an array of SessionEntity objects.
|
|
20
20
|
*/
|
|
@@ -32,9 +32,9 @@ export default class PaymentsApi extends AsyncModules implements IPaymentsApi {
|
|
|
32
32
|
* Creation of payment session.
|
|
33
33
|
* @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.
|
|
34
34
|
*
|
|
35
|
-
* @param {number} orderId - Order identifier
|
|
36
|
-
* @param {'session' | 'intent'} type - Session type
|
|
37
|
-
* @param {boolean} automaticTaxEnabled - Automatic calculation of the tax rate
|
|
35
|
+
* @param {number} [orderId] - Order identifier
|
|
36
|
+
* @param {'session' | 'intent'} [type] - Session type
|
|
37
|
+
* @param {boolean} [automaticTaxEnabled] - Automatic calculation of the tax rate
|
|
38
38
|
*
|
|
39
39
|
* @returns Returns a single payment session object.
|
|
40
40
|
*/
|
|
@@ -16,8 +16,8 @@ class PaymentsApi extends asyncModules_1.default {
|
|
|
16
16
|
* Get list of payment sessions.
|
|
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
|
-
* @param {number} [offset] - Optional parameter for pagination, default is
|
|
20
|
-
* @param {number} [limit] - Optional parameter for pagination, default is
|
|
19
|
+
* @param {number} [offset] - Optional parameter for pagination, default is 0
|
|
20
|
+
* @param {number} [limit] - Optional parameter for pagination, default is 30
|
|
21
21
|
*
|
|
22
22
|
* @returns Returns an array of SessionEntity objects.
|
|
23
23
|
*/
|
|
@@ -45,9 +45,9 @@ class PaymentsApi extends asyncModules_1.default {
|
|
|
45
45
|
* Creation of payment session.
|
|
46
46
|
* @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.
|
|
47
47
|
*
|
|
48
|
-
* @param {number} orderId - Order identifier
|
|
49
|
-
* @param {'session' | 'intent'} type - Session type
|
|
50
|
-
* @param {boolean} automaticTaxEnabled - Automatic calculation of the tax rate
|
|
48
|
+
* @param {number} [orderId] - Order identifier
|
|
49
|
+
* @param {'session' | 'intent'} [type] - Session type
|
|
50
|
+
* @param {boolean} [automaticTaxEnabled] - Automatic calculation of the tax rate
|
|
51
51
|
*
|
|
52
52
|
* @returns Returns a single payment session object.
|
|
53
53
|
*/
|
|
@@ -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
|
/**
|