oneentry 1.0.152 → 1.0.154

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (70) hide show
  1. package/changelog.md +49 -0
  2. package/dist/admins/adminsApi.d.ts +2 -1
  3. package/dist/admins/adminsApi.js +2 -1
  4. package/dist/admins/adminsInterfaces.d.ts +1 -1
  5. package/dist/attribute-sets/attributeSetsApi.d.ts +4 -0
  6. package/dist/attribute-sets/attributeSetsApi.js +4 -0
  7. package/dist/auth-provider/authProviderApi.d.ts +14 -1
  8. package/dist/auth-provider/authProviderApi.js +14 -1
  9. package/dist/base/asyncModules.d.ts +21 -2
  10. package/dist/base/asyncModules.js +74 -225
  11. package/dist/base/stateModule.d.ts +4 -13
  12. package/dist/base/stateModule.js +12 -96
  13. package/dist/base/syncModules.d.ts +4 -0
  14. package/dist/base/syncModules.js +5 -1
  15. package/dist/blocks/blocksApi.d.ts +54 -11
  16. package/dist/blocks/blocksApi.js +90 -73
  17. package/dist/blocks/blocksInterfaces.d.ts +18 -9
  18. package/dist/discounts/discountsApi.d.ts +5 -0
  19. package/dist/discounts/discountsApi.js +5 -0
  20. package/dist/events/eventsApi.d.ts +7 -0
  21. package/dist/events/eventsApi.js +11 -28
  22. package/dist/file-uploading/fileUploadingApi.d.ts +4 -1
  23. package/dist/file-uploading/fileUploadingApi.js +4 -1
  24. package/dist/file-uploading/fileUploadingInterfaces.d.ts +1 -1
  25. package/dist/filters/filtersApi.d.ts +1 -0
  26. package/dist/filters/filtersApi.js +1 -0
  27. package/dist/forms/formsApi.d.ts +2 -0
  28. package/dist/forms/formsApi.js +2 -0
  29. package/dist/forms-data/formsDataApi.d.ts +5 -0
  30. package/dist/forms-data/formsDataApi.js +5 -0
  31. package/dist/general-types/generalTypesApi.d.ts +1 -0
  32. package/dist/general-types/generalTypesApi.js +1 -0
  33. package/dist/index.js +12 -0
  34. package/dist/integration-collections/integrationCollectionsApi.d.ts +10 -1
  35. package/dist/integration-collections/integrationCollectionsApi.js +10 -1
  36. package/dist/integration-collections/integrationCollectionsInterfaces.d.ts +1 -1
  37. package/dist/locales/localesApi.d.ts +1 -0
  38. package/dist/locales/localesApi.js +1 -0
  39. package/dist/menus/menusApi.d.ts +1 -0
  40. package/dist/menus/menusApi.js +1 -0
  41. package/dist/orders/ordersApi.d.ts +25 -1
  42. package/dist/orders/ordersApi.js +36 -12
  43. package/dist/orders/ordersInterfaces.d.ts +5 -2
  44. package/dist/pages/pagesApi.d.ts +9 -0
  45. package/dist/pages/pagesApi.js +35 -39
  46. package/dist/pages/pagesInterfaces.d.ts +5 -0
  47. package/dist/payments/paymentsApi.d.ts +6 -0
  48. package/dist/payments/paymentsApi.js +6 -0
  49. package/dist/product-statuses/productStatusesApi.d.ts +3 -0
  50. package/dist/product-statuses/productStatusesApi.js +3 -0
  51. package/dist/products/productsApi.d.ts +39 -64
  52. package/dist/products/productsApi.js +33 -61
  53. package/dist/products/productsInterfaces.d.ts +76 -72
  54. package/dist/sitemap/sitemapApi.d.ts +2 -0
  55. package/dist/sitemap/sitemapApi.js +2 -0
  56. package/dist/subscriptions/subscriptionsApi.d.ts +5 -0
  57. package/dist/subscriptions/subscriptionsApi.js +7 -14
  58. package/dist/system/systemApi.d.ts +3 -0
  59. package/dist/system/systemApi.js +3 -0
  60. package/dist/templates/templatesApi.d.ts +3 -0
  61. package/dist/templates/templatesApi.js +3 -0
  62. package/dist/templates-preview/templatesPreviewApi.d.ts +2 -0
  63. package/dist/templates-preview/templatesPreviewApi.js +2 -0
  64. package/dist/user-activity/userActivityApi.d.ts +1 -0
  65. package/dist/user-activity/userActivityApi.js +1 -0
  66. package/dist/users/usersApi.d.ts +14 -0
  67. package/dist/users/usersApi.js +14 -0
  68. package/dist/web-socket/wsApi.d.ts +1 -1
  69. package/dist/web-socket/wsApi.js +1 -1
  70. package/package.json +4 -1
@@ -44,6 +44,7 @@ class IntegrationCollectionsApi extends asyncModules_1.default {
44
44
  * @param {string} [userQuery.entityType] - Entity type. Example: "orders".
45
45
  * @param {number} [userQuery.entityId] - Entity identifier. Example: 1.
46
46
  * @returns {Promise<ICollectionEntity[] | IError>} Returns an array of ICollection objects or an error object if there was an issue.
47
+ * @see {@link https://js-sdk.oneentry.cloud/docs/integration-collections/getICollections getICollections} documentation.
47
48
  */
48
49
  async getICollections(langCode = this.state.lang, userQuery) {
49
50
  // eslint-disable-next-line @typescript-eslint/no-explicit-any
@@ -60,6 +61,7 @@ class IntegrationCollectionsApi extends asyncModules_1.default {
60
61
  * @param {string} [langCode] - Language code. Default: "en_US".
61
62
  * @returns {Promise<ICollectionEntity | IError>} Returns an ICollection object or an error object if there was an issue.
62
63
  * @throws {IError} When isShell=false and an error occurs during the fetch
64
+ * @see {@link https://js-sdk.oneentry.cloud/docs/integration-collections/getICollectionById getICollectionById} documentation.
63
65
  */
64
66
  async getICollectionById(id, langCode = this.state.lang) {
65
67
  const result = await this._fetchGet(`/${id}?` + this._queryParamsToString({ langCode }));
@@ -82,11 +84,12 @@ class IntegrationCollectionsApi extends asyncModules_1.default {
82
84
  }
83
85
  * @param {number} [userQuery.limit] - Optional parameter for pagination. Default: 0.
84
86
  * @param {number} [userQuery.offset] - Optional parameter for pagination. Default: 30.
85
- * @param {number} [userQuery.entityType] - Entity type. Example: "orders".
87
+ * @param {string} [userQuery.entityType] - Entity type. Example: "orders".
86
88
  * @param {number} [userQuery.entityId] - Entity identifier. Example: 1.
87
89
  * @returns {Promise<ICollectionRowsResponce | IError>} Returns object ItemsWithTotal, where items is an array of requested objects.
88
90
  * @throws {IError} When isShell=false and an error occurs during the fetch
89
91
  * @description Get all records belonging to the collection by collection id.
92
+ * @see {@link https://js-sdk.oneentry.cloud/docs/integration-collections/getICollectionRowsById getICollectionRowsById} documentation.
90
93
  */
91
94
  async getICollectionRowsById(id, langCode = this.state.lang, userQuery) {
92
95
  const result = await this._fetchGet(`/${id}/rows?` +
@@ -110,6 +113,7 @@ class IntegrationCollectionsApi extends asyncModules_1.default {
110
113
  }
111
114
  * @throws {IError} When isShell=false and an error occurs during the fetch
112
115
  * @description Check for the existence of a text identifier (marker).
116
+ * @see {@link https://js-sdk.oneentry.cloud/docs/integration-collections/validateICollectionMarker validateICollectionMarker} documentation.
113
117
  */
114
118
  async validateICollectionMarker(marker) {
115
119
  const result = await this._fetchGet(`/marker-validation/${marker}`);
@@ -124,6 +128,7 @@ class IntegrationCollectionsApi extends asyncModules_1.default {
124
128
  * @param {string} [langCode] - Language code. Default: "en_US".
125
129
  * @returns {Promise<ICollectionRowsResponce | IError>} Returns CollectionRowEntity object.
126
130
  * @throws {IError} When isShell=false and an error occurs during the fetch
131
+ * @see {@link https://js-sdk.oneentry.cloud/docs/integration-collections/getICollectionRowsByMarker getICollectionRowsByMarker} documentation.
127
132
  */
128
133
  async getICollectionRowsByMarker(marker, langCode = this.state.lang) {
129
134
  const result = await this._fetchGet(`/marker/${marker}/rows?langCode=${langCode}`);
@@ -139,6 +144,7 @@ class IntegrationCollectionsApi extends asyncModules_1.default {
139
144
  * @param {string} [langCode] - Language code. Default: "en_US".
140
145
  * @returns {Promise<ICollectionRow | IError>} Returns CollectionRowEntity object.
141
146
  * @throws {IError} When isShell=false and an error occurs during the fetch
147
+ * @see {@link https://js-sdk.oneentry.cloud/docs/integration-collections/getICollectionRowByMarkerAndId getICollectionRowByMarkerAndId} documentation.
142
148
  */
143
149
  async getICollectionRowByMarkerAndId(marker, id, langCode = this.state.lang) {
144
150
  const result = await this._fetchGet(`/marker/${marker}/rows/${id}?langCode=${langCode}`);
@@ -166,6 +172,7 @@ class IntegrationCollectionsApi extends asyncModules_1.default {
166
172
  * @returns {Promise<ICollectionRow | IError>} Returns object of type ICollectionRow.
167
173
  * @throws {IError} When isShell=false and an error occurs during the fetch
168
174
  * @description Create a record in the collection.
175
+ * @see {@link https://js-sdk.oneentry.cloud/docs/integration-collections/createICollectionRow createICollectionRow} documentation.
169
176
  */
170
177
  async createICollectionRow(marker, body, langCode = this.state.lang) {
171
178
  const response = await this._fetchPost(`/marker/${marker}/rows?langCode=${langCode}`, body);
@@ -196,6 +203,7 @@ class IntegrationCollectionsApi extends asyncModules_1.default {
196
203
  * @returns {Promise<ICollectionRow | IError>} Returns object of type ICollectionRow.
197
204
  * @throws {IError} When isShell=false and an error occurs during the fetch
198
205
  * @description Edit a record in the collection.
206
+ * @see {@link https://js-sdk.oneentry.cloud/docs/integration-collections/updateICollectionRow updateICollectionRow} documentation.
199
207
  */
200
208
  async updateICollectionRow(marker, id, body, langCode = this.state.lang) {
201
209
  const response = await this._fetchPut(`/marker/${marker}/rows/${id}?` + `langCode=${langCode}`, body);
@@ -211,6 +219,7 @@ class IntegrationCollectionsApi extends asyncModules_1.default {
211
219
  * @returns {Promise<boolean | IError>} Returns true (in case of successful deletion) or false (in case of unsuccessful deletion) (permission "collections.row.delete" required for access)
212
220
  * @throws {IError} When isShell=false and an error occurs during the fetch
213
221
  * @description Deletion of collection record object
222
+ * @see {@link https://js-sdk.oneentry.cloud/docs/integration-collections/deleteICollectionRowByMarkerAndId deleteICollectionRowByMarkerAndId} documentation.
214
223
  */
215
224
  async deleteICollectionRowByMarkerAndId(marker, id) {
216
225
  const result = await this._fetchDelete(`/marker/${marker}/rows/${id}`);
@@ -50,7 +50,7 @@ interface ICollectionsApi {
50
50
  }
51
51
  * @param {number} [userQuery.limit] - Optional parameter for pagination. Default: 30.
52
52
  * @param {number} [userQuery.offset] - Optional parameter for pagination. Default: 0.
53
- * @param {number} [userQuery.entityType] - Entity type. Example: "orders".
53
+ * @param {string} [userQuery.entityType] - Entity type. Example: "orders".
54
54
  * @param {number} [userQuery.entityId] - Entity identifier. Example: 1.
55
55
  * @returns {ICollectionRowsResponce} Returns object ItemsWithTotal, where items is an array of requested objects.
56
56
  * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
@@ -22,6 +22,7 @@ export default class LocalesApi extends AsyncModules implements ILocales {
22
22
  * @returns {Promise<ILocalEntity[] | IError>} Returns an array of LocaleEntity objects.
23
23
  * @throws {IError} When isShell=false and an error occurs during the fetch
24
24
  * @description Find all active language localization objects.
25
+ * @see {@link https://js-sdk.oneentry.cloud/docs/locales/getLocales getLocales} documentation.
25
26
  */
26
27
  getLocales(): Promise<Array<ILocalEntity> | IError>;
27
28
  }
@@ -26,6 +26,7 @@ class LocalesApi extends asyncModules_1.default {
26
26
  * @returns {Promise<ILocalEntity[] | IError>} Returns an array of LocaleEntity objects.
27
27
  * @throws {IError} When isShell=false and an error occurs during the fetch
28
28
  * @description Find all active language localization objects.
29
+ * @see {@link https://js-sdk.oneentry.cloud/docs/locales/getLocales getLocales} documentation.
29
30
  */
30
31
  async getLocales() {
31
32
  const result = await this._fetchGet('/active/all');
@@ -24,6 +24,7 @@ export default class MenusApi extends AsyncModules implements IMenus {
24
24
  * @returns {Promise<IMenusEntity | IError>} Returns a single menu object as a ContentMenu object with included pages.
25
25
  * @throws {IError} When isShell=false and an error occurs during the fetch
26
26
  * @description Get pages includes in menu by marker.
27
+ * @see {@link https://js-sdk.oneentry.cloud/docs/menus/getMenusByMarker getMenusByMarker} documentation.
27
28
  */
28
29
  getMenusByMarker(marker: string, langCode?: string): Promise<IMenusEntity | IError>;
29
30
  }
@@ -28,6 +28,7 @@ class MenusApi extends asyncModules_1.default {
28
28
  * @returns {Promise<IMenusEntity | IError>} Returns a single menu object as a ContentMenu object with included pages.
29
29
  * @throws {IError} When isShell=false and an error occurs during the fetch
30
30
  * @description Get pages includes in menu by marker.
31
+ * @see {@link https://js-sdk.oneentry.cloud/docs/menus/getMenusByMarker getMenusByMarker} documentation.
31
32
  */
32
33
  async getMenusByMarker(marker, langCode = this.state.lang) {
33
34
  const result = await this._fetchGet(`/marker/${marker}?langCode=${langCode}`);
@@ -28,6 +28,7 @@ export default class OrdersApi extends AsyncModules implements IOrdersApi {
28
28
  * @throws {IError} When isShell=false and an error occurs during the fetch
29
29
  * @description This method requires user authorization.
30
30
  * @see For more information about configuring the {@link https://js-sdk.oneentry.cloud/docs/category/authprovider authorization module}, see the documentation in the {@link https://js-sdk.oneentry.cloud/docs/category/authprovider configuration settings section of the SDK}.
31
+ * @see {@link https://js-sdk.oneentry.cloud/docs/orders/getAllOrdersStorage getAllOrdersStorage} documentation.
31
32
  */
32
33
  getAllOrdersStorage(langCode?: string, offset?: number, limit?: number): Promise<IOrdersEntity[] | IError>;
33
34
  /**
@@ -41,6 +42,7 @@ export default class OrdersApi extends AsyncModules implements IOrdersApi {
41
42
  * @throws {IError} When isShell=false and an error occurs during the fetch
42
43
  * @description This method requires user authorization.
43
44
  * @see For more information about configuring the {@link https://js-sdk.oneentry.cloud/docs/category/authprovider authorization module}, see the documentation in the {@link https://js-sdk.oneentry.cloud/docs/category/authprovider configuration settings section of the SDK}.
45
+ * @see {@link https://js-sdk.oneentry.cloud/docs/orders/getAllOrdersByMarker getAllOrdersByMarker} documentation.
44
46
  */
45
47
  getAllOrdersByMarker(marker: string, langCode?: string, offset?: number, limit?: number): Promise<IOrdersByMarkerEntity | IError>;
46
48
  /**
@@ -52,6 +54,7 @@ export default class OrdersApi extends AsyncModules implements IOrdersApi {
52
54
  * @throws {IError} When isShell=false and an error occurs during the fetch
53
55
  * @description This method requires user authorization.
54
56
  * @see For more information about configuring the {@link https://js-sdk.oneentry.cloud/docs/category/authprovider authorization module}, see the documentation in the {@link https://js-sdk.oneentry.cloud/docs/category/authprovider configuration settings section of the SDK}.
57
+ * @see {@link https://js-sdk.oneentry.cloud/docs/orders/getOrdersStorageByMarker getOrdersStorageByMarker} documentation.
55
58
  */
56
59
  getOrdersStorageByMarker(marker: string, langCode?: string): Promise<IOrdersEntity | IError>;
57
60
  /**
@@ -64,6 +67,7 @@ export default class OrdersApi extends AsyncModules implements IOrdersApi {
64
67
  * @throws {IError} When isShell=false and an error occurs during the fetch
65
68
  * @description This method requires user authorization.
66
69
  * @see For more information about configuring the {@link https://js-sdk.oneentry.cloud/docs/category/authprovider authorization module}, see the documentation in the {@link https://js-sdk.oneentry.cloud/docs/category/authprovider configuration settings section of the SDK}.
70
+ * @see {@link https://js-sdk.oneentry.cloud/docs/orders/getOrderByMarkerAndId getOrderByMarkerAndId} documentation.
67
71
  */
68
72
  getOrderByMarkerAndId(marker: string, id: number, langCode?: string): Promise<IOrderByMarkerEntity | IError>;
69
73
  /**
@@ -73,8 +77,9 @@ export default class OrdersApi extends AsyncModules implements IOrdersApi {
73
77
  * @param {string} [langCode] - Language code. Default: "en_US".
74
78
  * @returns {Promise<IOrderPreviewResponse | IError>} Returns an object with the order preview.
75
79
  * @throws {IError} When isShell=false and an error occurs during the fetch
76
- * @description This method requires user authorization ???.
80
+ * @description This method requires user authorization.
77
81
  * @see For more information about configuring the {@link https://js-sdk.oneentry.cloud/docs/category/authprovider authorization module}, see the documentation in the {@link https://js-sdk.oneentry.cloud/docs/category/authprovider configuration settings section of the SDK}.
82
+ * @see {@link https://js-sdk.oneentry.cloud/docs/orders/previewOrder previewOrder} documentation.
78
83
  */
79
84
  previewOrder(body: ICreateOrderPreview, langCode?: string): Promise<IOrderPreviewResponse | IError>;
80
85
  /**
@@ -103,6 +108,7 @@ export default class OrdersApi extends AsyncModules implements IOrdersApi {
103
108
  * @throws {IError} When isShell=false and an error occurs during the fetch
104
109
  * @description This method requires user authorization.
105
110
  * @see For more information about configuring the {@link https://js-sdk.oneentry.cloud/docs/category/authprovider authorization module}, see the documentation in the {@link https://js-sdk.oneentry.cloud/docs/category/authprovider configuration settings section of the SDK}.
111
+ * @see {@link https://js-sdk.oneentry.cloud/docs/orders/createOrder createOrder} documentation.
106
112
  */
107
113
  createOrder(marker: string, body: IOrderData, langCode?: string): Promise<IBaseOrdersEntity | IError>;
108
114
  /**
@@ -133,6 +139,7 @@ export default class OrdersApi extends AsyncModules implements IOrdersApi {
133
139
  * @throws {IError} When isShell=false and an error occurs during the fetch
134
140
  * @description This method requires user authorization.
135
141
  * @see For more information about configuring the {@link https://js-sdk.oneentry.cloud/docs/category/authprovider authorization module}, see the documentation in the {@link https://js-sdk.oneentry.cloud/docs/category/authprovider configuration settings section of the SDK}.
142
+ * @see {@link https://js-sdk.oneentry.cloud/docs/orders/updateOrderByMarkerAndId updateOrderByMarkerAndId} documentation.
136
143
  */
137
144
  updateOrderByMarkerAndId(marker: string, id: number, body: IOrderData, langCode?: string): Promise<IBaseOrdersEntity | IError>;
138
145
  /**
@@ -145,6 +152,7 @@ export default class OrdersApi extends AsyncModules implements IOrdersApi {
145
152
  * @returns {Promise<IOrderStatus[] | IError>} Returns an object with the orders statuses.
146
153
  * @throws {IError} When isShell=false and an error occurs during the fetch
147
154
  * @see For more information about configuring the {@link https://js-sdk.oneentry.cloud/docs/category/authprovider authorization module}, see the documentation in the {@link https://js-sdk.oneentry.cloud/docs/category/authprovider configuration settings section of the SDK}.
155
+ * @see {@link https://js-sdk.oneentry.cloud/docs/orders/getAllStatusesByStorageMarker getAllStatusesByStorageMarker} documentation.
148
156
  */
149
157
  getAllStatusesByStorageMarker(marker: string, langCode?: string, offset?: number, limit?: number): Promise<IOrderStatus[] | IError>;
150
158
  /**
@@ -153,6 +161,7 @@ export default class OrdersApi extends AsyncModules implements IOrdersApi {
153
161
  * @param {number} id - Order id. Example: 1.
154
162
  * @returns {Promise<IRefundRequest[] | IError>} Returns array of refund requests.
155
163
  * @throws {IError} When isShell=false and an error occurs during the fetch
164
+ * @see {@link https://js-sdk.oneentry.cloud/docs/orders/getRefunds getRefunds} documentation.
156
165
  */
157
166
  getRefunds(id: number): Promise<IRefundRequest[] | IError>;
158
167
  /**
@@ -162,6 +171,7 @@ export default class OrdersApi extends AsyncModules implements IOrdersApi {
162
171
  * @param {ICreateRefundRequest} body - Refund request body.
163
172
  * @returns {Promise<boolean | IError>} Returns true if the refund request was created successfully.
164
173
  * @throws {IError} When isShell=false and an error occurs during the fetch
174
+ * @see {@link https://js-sdk.oneentry.cloud/docs/orders/createRefundRequest createRefundRequest} documentation.
165
175
  */
166
176
  createRefundRequest(id: number, body: ICreateRefundRequest): Promise<boolean | IError>;
167
177
  /**
@@ -170,6 +180,20 @@ export default class OrdersApi extends AsyncModules implements IOrdersApi {
170
180
  * @param {number} id - Order id. Example: 1.
171
181
  * @returns {Promise<boolean | IError>} Returns true if the refund request was cancelled successfully.
172
182
  * @throws {IError} When isShell=false and an error occurs during the fetch
183
+ * @see {@link https://js-sdk.oneentry.cloud/docs/orders/cancelRefundRequest cancelRefundRequest} documentation.
173
184
  */
174
185
  cancelRefundRequest(id: number): Promise<boolean | IError>;
186
+ /**
187
+ * Runs a fetch against the `/orders` base URL instead of the default
188
+ * `/orders-storage`, then restores the original URL.
189
+ *
190
+ * Refund endpoints live under `/api/content/orders`, while this class is based
191
+ * on `/api/content/orders-storage`. The helper swaps `_url` for the duration of
192
+ * the call and restores it in `finally`, so the base URL is restored even if
193
+ * the request throws.
194
+ * @param {() => Promise<T>} fetcher - Thunk performing the fetch call.
195
+ * @returns {Promise<T>} The fetcher result.
196
+ * @template T
197
+ */
198
+ private _withOrdersUrl;
175
199
  }
@@ -32,6 +32,7 @@ class OrdersApi extends asyncModules_1.default {
32
32
  * @throws {IError} When isShell=false and an error occurs during the fetch
33
33
  * @description This method requires user authorization.
34
34
  * @see For more information about configuring the {@link https://js-sdk.oneentry.cloud/docs/category/authprovider authorization module}, see the documentation in the {@link https://js-sdk.oneentry.cloud/docs/category/authprovider configuration settings section of the SDK}.
35
+ * @see {@link https://js-sdk.oneentry.cloud/docs/orders/getAllOrdersStorage getAllOrdersStorage} documentation.
35
36
  */
36
37
  async getAllOrdersStorage(langCode = this.state.lang, offset = 0, limit = 30) {
37
38
  const result = await this._fetchGet(`?langCode=${langCode}&limit=${limit}&offset=${offset}`);
@@ -48,6 +49,7 @@ class OrdersApi extends asyncModules_1.default {
48
49
  * @throws {IError} When isShell=false and an error occurs during the fetch
49
50
  * @description This method requires user authorization.
50
51
  * @see For more information about configuring the {@link https://js-sdk.oneentry.cloud/docs/category/authprovider authorization module}, see the documentation in the {@link https://js-sdk.oneentry.cloud/docs/category/authprovider configuration settings section of the SDK}.
52
+ * @see {@link https://js-sdk.oneentry.cloud/docs/orders/getAllOrdersByMarker getAllOrdersByMarker} documentation.
51
53
  */
52
54
  async getAllOrdersByMarker(marker, langCode = this.state.lang, offset = 0, limit = 30) {
53
55
  const result = await this._fetchGet(`/marker/${marker}/orders?langCode=${langCode}&limit=${limit}&offset=${offset}`);
@@ -64,6 +66,7 @@ class OrdersApi extends asyncModules_1.default {
64
66
  * @throws {IError} When isShell=false and an error occurs during the fetch
65
67
  * @description This method requires user authorization.
66
68
  * @see For more information about configuring the {@link https://js-sdk.oneentry.cloud/docs/category/authprovider authorization module}, see the documentation in the {@link https://js-sdk.oneentry.cloud/docs/category/authprovider configuration settings section of the SDK}.
69
+ * @see {@link https://js-sdk.oneentry.cloud/docs/orders/getOrdersStorageByMarker getOrdersStorageByMarker} documentation.
67
70
  */
68
71
  async getOrdersStorageByMarker(marker, langCode = this.state.lang) {
69
72
  const result = await this._fetchGet(`/marker/${marker}?langCode=${langCode}`);
@@ -79,6 +82,7 @@ class OrdersApi extends asyncModules_1.default {
79
82
  * @throws {IError} When isShell=false and an error occurs during the fetch
80
83
  * @description This method requires user authorization.
81
84
  * @see For more information about configuring the {@link https://js-sdk.oneentry.cloud/docs/category/authprovider authorization module}, see the documentation in the {@link https://js-sdk.oneentry.cloud/docs/category/authprovider configuration settings section of the SDK}.
85
+ * @see {@link https://js-sdk.oneentry.cloud/docs/orders/getOrderByMarkerAndId getOrderByMarkerAndId} documentation.
82
86
  */
83
87
  async getOrderByMarkerAndId(marker, id, langCode = this.state.lang) {
84
88
  const result = await this._fetchGet(`/marker/${marker}/orders/${id}?langCode=${langCode}`);
@@ -93,8 +97,9 @@ class OrdersApi extends asyncModules_1.default {
93
97
  * @param {string} [langCode] - Language code. Default: "en_US".
94
98
  * @returns {Promise<IOrderPreviewResponse | IError>} Returns an object with the order preview.
95
99
  * @throws {IError} When isShell=false and an error occurs during the fetch
96
- * @description This method requires user authorization ???.
100
+ * @description This method requires user authorization.
97
101
  * @see For more information about configuring the {@link https://js-sdk.oneentry.cloud/docs/category/authprovider authorization module}, see the documentation in the {@link https://js-sdk.oneentry.cloud/docs/category/authprovider configuration settings section of the SDK}.
102
+ * @see {@link https://js-sdk.oneentry.cloud/docs/orders/previewOrder previewOrder} documentation.
98
103
  */
99
104
  async previewOrder(body, langCode = this.state.lang) {
100
105
  const result = await this._fetchPost(`/orders/preview?langCode=${langCode}`, body);
@@ -126,6 +131,7 @@ class OrdersApi extends asyncModules_1.default {
126
131
  * @throws {IError} When isShell=false and an error occurs during the fetch
127
132
  * @description This method requires user authorization.
128
133
  * @see For more information about configuring the {@link https://js-sdk.oneentry.cloud/docs/category/authprovider authorization module}, see the documentation in the {@link https://js-sdk.oneentry.cloud/docs/category/authprovider configuration settings section of the SDK}.
134
+ * @see {@link https://js-sdk.oneentry.cloud/docs/orders/createOrder createOrder} documentation.
129
135
  */
130
136
  async createOrder(marker, body, langCode = this.state.lang) {
131
137
  // eslint-disable-next-line @typescript-eslint/no-explicit-any
@@ -167,6 +173,7 @@ class OrdersApi extends asyncModules_1.default {
167
173
  * @throws {IError} When isShell=false and an error occurs during the fetch
168
174
  * @description This method requires user authorization.
169
175
  * @see For more information about configuring the {@link https://js-sdk.oneentry.cloud/docs/category/authprovider authorization module}, see the documentation in the {@link https://js-sdk.oneentry.cloud/docs/category/authprovider configuration settings section of the SDK}.
176
+ * @see {@link https://js-sdk.oneentry.cloud/docs/orders/updateOrderByMarkerAndId updateOrderByMarkerAndId} documentation.
170
177
  */
171
178
  async updateOrderByMarkerAndId(marker, id, body, langCode = this.state.lang) {
172
179
  // eslint-disable-next-line @typescript-eslint/no-explicit-any
@@ -190,6 +197,7 @@ class OrdersApi extends asyncModules_1.default {
190
197
  * @returns {Promise<IOrderStatus[] | IError>} Returns an object with the orders statuses.
191
198
  * @throws {IError} When isShell=false and an error occurs during the fetch
192
199
  * @see For more information about configuring the {@link https://js-sdk.oneentry.cloud/docs/category/authprovider authorization module}, see the documentation in the {@link https://js-sdk.oneentry.cloud/docs/category/authprovider configuration settings section of the SDK}.
200
+ * @see {@link https://js-sdk.oneentry.cloud/docs/orders/getAllStatusesByStorageMarker getAllStatusesByStorageMarker} documentation.
193
201
  */
194
202
  async getAllStatusesByStorageMarker(marker, langCode = this.state.lang, offset = 0, limit = 30) {
195
203
  const query = {
@@ -206,12 +214,10 @@ class OrdersApi extends asyncModules_1.default {
206
214
  * @param {number} id - Order id. Example: 1.
207
215
  * @returns {Promise<IRefundRequest[] | IError>} Returns array of refund requests.
208
216
  * @throws {IError} When isShell=false and an error occurs during the fetch
217
+ * @see {@link https://js-sdk.oneentry.cloud/docs/orders/getRefunds getRefunds} documentation.
209
218
  */
210
219
  async getRefunds(id) {
211
- const savedUrl = this._url;
212
- this._url = this._ordersUrl;
213
- const data = await this._fetchGet(`/${id}/refund`);
214
- this._url = savedUrl;
220
+ const data = await this._withOrdersUrl(() => this._fetchGet(`/${id}/refund`));
215
221
  return this._normalizeData(data);
216
222
  }
217
223
  /**
@@ -221,12 +227,10 @@ class OrdersApi extends asyncModules_1.default {
221
227
  * @param {ICreateRefundRequest} body - Refund request body.
222
228
  * @returns {Promise<boolean | IError>} Returns true if the refund request was created successfully.
223
229
  * @throws {IError} When isShell=false and an error occurs during the fetch
230
+ * @see {@link https://js-sdk.oneentry.cloud/docs/orders/createRefundRequest createRefundRequest} documentation.
224
231
  */
225
232
  async createRefundRequest(id, body) {
226
- const savedUrl = this._url;
227
- this._url = this._ordersUrl;
228
- const data = await this._fetchPost(`/${id}/refund`, body);
229
- this._url = savedUrl;
233
+ const data = await this._withOrdersUrl(() => this._fetchPost(`/${id}/refund`, body));
230
234
  return this._normalizeData(data);
231
235
  }
232
236
  /**
@@ -235,13 +239,33 @@ class OrdersApi extends asyncModules_1.default {
235
239
  * @param {number} id - Order id. Example: 1.
236
240
  * @returns {Promise<boolean | IError>} Returns true if the refund request was cancelled successfully.
237
241
  * @throws {IError} When isShell=false and an error occurs during the fetch
242
+ * @see {@link https://js-sdk.oneentry.cloud/docs/orders/cancelRefundRequest cancelRefundRequest} documentation.
238
243
  */
239
244
  async cancelRefundRequest(id) {
245
+ const data = await this._withOrdersUrl(() => this._fetchDelete(`/${id}/refund`));
246
+ return this._normalizeData(data);
247
+ }
248
+ /**
249
+ * Runs a fetch against the `/orders` base URL instead of the default
250
+ * `/orders-storage`, then restores the original URL.
251
+ *
252
+ * Refund endpoints live under `/api/content/orders`, while this class is based
253
+ * on `/api/content/orders-storage`. The helper swaps `_url` for the duration of
254
+ * the call and restores it in `finally`, so the base URL is restored even if
255
+ * the request throws.
256
+ * @param {() => Promise<T>} fetcher - Thunk performing the fetch call.
257
+ * @returns {Promise<T>} The fetcher result.
258
+ * @template T
259
+ */
260
+ async _withOrdersUrl(fetcher) {
240
261
  const savedUrl = this._url;
241
262
  this._url = this._ordersUrl;
242
- const data = await this._fetchDelete(`/${id}/refund`);
243
- this._url = savedUrl;
244
- return this._normalizeData(data);
263
+ try {
264
+ return await fetcher();
265
+ }
266
+ finally {
267
+ this._url = savedUrl;
268
+ }
245
269
  }
246
270
  }
247
271
  exports.default = OrdersApi;
@@ -266,11 +266,14 @@ interface IOrdersFormData {
266
266
  * @interface IOrderProductData
267
267
  * @property {number} productId - Product identifier. Example: 1.
268
268
  * @property {number} quantity - Quantity of the product. Example: 2.
269
+ * @property {string} [signedPrice] - The signed price of the product is obtained along with the product data when `signPrice` is set. Example: "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...".
270
+ * @see {@link https://js-sdk.oneentry.cloud/docs/orders/#Fixed-product-price-signedPrice Fixed product price} documentation.
269
271
  * @description Represents a product data in an order.
270
272
  */
271
273
  interface IOrderProductData {
272
274
  productId: number;
273
275
  quantity: number;
276
+ signedPrice?: string;
274
277
  }
275
278
  /**
276
279
  * Interface representing product data in an order.
@@ -311,7 +314,7 @@ interface IOrderProductsData {
311
314
  }
312
315
  ]
313
316
  * @property {string} currency - Currency used to pay for the order. Example: "USD".
314
- * @property {number} totalSum - Total order amount. Example: "150".
317
+ * @property {string} totalSum - Total order amount. Example: "150".
315
318
  * @property {string} [createdDate] - Order creation date. Example: "2023-10-01T12:00:00Z".
316
319
  * @property {string} [statusIdentifier] - Text identifier of order status object (if not set, default status will be assigned). Example: "status-1".
317
320
  * @property {string} [couponCode] -
@@ -328,7 +331,7 @@ interface IBaseOrdersEntity {
328
331
  formData: IOrdersFormData[];
329
332
  products: IOrderProductsData[];
330
333
  currency: string;
331
- totalSum: number;
334
+ totalSum: string;
332
335
  createdDate?: string;
333
336
  statusIdentifier?: string;
334
337
  couponCode?: string;
@@ -23,6 +23,7 @@ export default class PagesApi extends AsyncModules implements IPagesApi {
23
23
  * @returns {Promise<IPagesEntity[] | IError>} Returns all created pages without parents as an array of PageEntity objects or an empty array [] (if there is no data)
24
24
  * @throws {IError} When isShell=false and an error occurs during the fetch
25
25
  * @description Get all top-level page objects.
26
+ * @see {@link https://js-sdk.oneentry.cloud/docs/pages/getRootPages getRootPages} documentation.
26
27
  */
27
28
  getRootPages(langCode?: string): Promise<IPagesEntity[] | IError>;
28
29
  /**
@@ -32,6 +33,7 @@ export default class PagesApi extends AsyncModules implements IPagesApi {
32
33
  * @returns {Promise<IPagesEntity[] | IError>} Returns all created pages as an array of PageEntity objects or an empty array [] (if there is no data).
33
34
  * @throws {IError} When isShell=false and an error occurs during the fetch
34
35
  * @description Get all page objects with product information as an array.
36
+ * @see {@link https://js-sdk.oneentry.cloud/docs/pages/getPages getPages} documentation.
35
37
  */
36
38
  getPages(langCode?: string): Promise<IPagesEntity[] | IError>;
37
39
  /**
@@ -42,6 +44,7 @@ export default class PagesApi extends AsyncModules implements IPagesApi {
42
44
  * @returns {Promise<IPagesEntity | IError>} Returns PageEntity object
43
45
  * @throws {IError} When isShell=false and an error occurs during the fetch
44
46
  * @description Get page object with information about forms, blocks, menus, linked to the page.
47
+ * @see {@link https://js-sdk.oneentry.cloud/docs/pages/getPageById getPageById} documentation.
45
48
  */
46
49
  getPageById(id: number, langCode?: string): Promise<IPagesEntity | IError>;
47
50
  /**
@@ -52,6 +55,7 @@ export default class PagesApi extends AsyncModules implements IPagesApi {
52
55
  * @returns {Promise<IPagesEntity | IError>} Returns PageEntity object
53
56
  * @throws {IError} When isShell=false and an error occurs during the fetch
54
57
  * @description Get page object with information about forms, blocks, menus, linked to the page by URL.
58
+ * @see {@link https://js-sdk.oneentry.cloud/docs/pages/getPageByUrl getPageByUrl} documentation.
55
59
  */
56
60
  getPageByUrl(url: string, langCode?: string): Promise<IPagesEntity | IError>;
57
61
  /**
@@ -62,6 +66,7 @@ export default class PagesApi extends AsyncModules implements IPagesApi {
62
66
  * @returns {Promise<IPagesEntity | IError>} Returns all created pages as an array of PageEntity objects or an empty array [] (if there is no data) for the selected parent
63
67
  * @throws {IError} When isShell=false and an error occurs during the fetch
64
68
  * @description Get child pages object with information as an array.
69
+ * @see {@link https://js-sdk.oneentry.cloud/docs/pages/getChildPagesByParentUrl getChildPagesByParentUrl} documentation.
65
70
  */
66
71
  getChildPagesByParentUrl(url: string, langCode?: string): Promise<IPagesEntity[] | IError>;
67
72
  /**
@@ -72,6 +77,7 @@ export default class PagesApi extends AsyncModules implements IPagesApi {
72
77
  * @returns {Promise<IPositionBlock[] | IError>} Returns all blocks as an array of PositionBlock objects or an empty array [] (if there is no data) for the selected parent
73
78
  * @throws {IError} When isShell=false and an error occurs during the fetch
74
79
  * @description Get all blocks by page url.
80
+ * @see {@link https://js-sdk.oneentry.cloud/docs/pages/getBlocksByPageUrl getBlocksByPageUrl} documentation.
75
81
  */
76
82
  getBlocksByPageUrl(url: string, langCode?: string): Promise<IPositionBlock[] | IError>;
77
83
  /**
@@ -81,6 +87,7 @@ export default class PagesApi extends AsyncModules implements IPagesApi {
81
87
  * @returns {Promise<IPageConfig | IError>} Returns a ConfigPage object with page display settings
82
88
  * @throws {IError} When isShell=false and an error occurs during the fetch
83
89
  * @description Get settings for the page.
90
+ * @see {@link https://js-sdk.oneentry.cloud/docs/pages/getConfigPageByUrl getConfigPageByUrl} documentation.
84
91
  */
85
92
  getConfigPageByUrl(url: string): Promise<IPageConfig | IError>;
86
93
  /**
@@ -92,6 +99,7 @@ export default class PagesApi extends AsyncModules implements IPagesApi {
92
99
  * @returns {Promise<IPagesEntity[] | IError>} Returns all created pages as an array of PageEntity objects or an empty array [] (if there is no data)
93
100
  * @throws {IError} When isShell=false and an error occurs during the fetch
94
101
  * @description Quick search for page objects with limited output.
102
+ * @see {@link https://js-sdk.oneentry.cloud/docs/pages/searchPage searchPage} documentation.
95
103
  */
96
104
  searchPage(name: string, url?: string, langCode?: string): Promise<IPagesEntity[] | IError>;
97
105
  /**
@@ -146,6 +154,7 @@ export default class PagesApi extends AsyncModules implements IPagesApi {
146
154
  * @returns {Promise<any | IError>} An array of page objects with template data added
147
155
  * @throws {IError} When isShell=false and an error occurs during the fetch
148
156
  * @description Add template data to page by page templateIdentifier
157
+ * @see {@link https://js-sdk.oneentry.cloud/docs/pages/addTemplateToPage addTemplateToPage} documentation.
149
158
  */
150
159
  protected addTemplateToPage(data: IPagesEntity): Promise<any | IError>;
151
160
  }