@djust-b2b/djust-front-sdk 2.1.0 → 2.1.1
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/lib/index.d.ts +21 -15
- package/lib/interfaces/models/attribute.d.ts +12 -2
- package/lib/interfaces/models/custom-field.d.ts +4 -0
- package/lib/interfaces/models/customer-account.d.ts +1 -0
- package/lib/interfaces/models/offer.d.ts +9 -0
- package/lib/interfaces/models/payment.d.ts +1 -0
- package/lib/services/attributes/definitions.d.ts +27 -0
- package/lib/services/attributes/definitions.js +2 -0
- package/lib/services/attributes/index.d.ts +32 -0
- package/lib/services/attributes/index.js +49 -0
- package/lib/services/auth/definitions.d.ts +39 -0
- package/lib/services/auth/definitions.requests.d.ts +4 -0
- package/lib/services/auth/index.d.ts +58 -3
- package/lib/services/auth/index.js +72 -2
- package/lib/services/cart/index.js +1 -0
- package/lib/services/custom-field/definitions.d.ts +6 -0
- package/lib/services/custom-field/index.d.ts +38 -1
- package/lib/services/custom-field/index.js +48 -2
- package/lib/services/customer-account/definitions.d.ts +15 -2
- package/lib/services/customer-account/index.d.ts +47 -5
- package/lib/services/customer-account/index.js +68 -5
- package/lib/services/customer-user/definitions.d.ts +2 -0
- package/lib/services/customer-user/index.d.ts +1 -1
- package/lib/services/customer-user/index.js +4 -1
- package/lib/services/incident/definitions.d.ts +14 -0
- package/lib/services/incident/index.d.ts +40 -1
- package/lib/services/incident/index.js +56 -0
- package/lib/services/logistic-order/definitions.d.ts +15 -4
- package/lib/services/logistic-order/index.d.ts +19 -10
- package/lib/services/logistic-order/index.js +40 -17
- package/lib/services/navigation-category/definitions.d.ts +7 -0
- package/lib/services/navigation-category/index.d.ts +33 -1
- package/lib/services/navigation-category/index.js +40 -0
- package/lib/services/offer-inventories/index.js +3 -3
- package/lib/services/offer-prices/definitions.d.ts +23 -0
- package/lib/services/offer-prices/definitions.js +2 -0
- package/lib/services/offer-prices/index.d.ts +35 -0
- package/lib/services/offer-prices/index.js +52 -0
- package/lib/services/product/definitions.d.ts +5 -0
- package/lib/services/product/index.d.ts +6 -29
- package/lib/services/product/index.js +8 -42
- package/lib/services/product-variant/definitions.d.ts +27 -0
- package/lib/services/product-variant/index.d.ts +30 -1
- package/lib/services/product-variant/index.js +40 -0
- package/package.json +1 -1
|
@@ -19,6 +19,11 @@ import { AddLogisticOrderReviewParameters, AddLogisticOrderReviewResponse, Appro
|
|
|
19
19
|
* | `page` | `integer` | ❌ | The page number you want to retrieve. |
|
|
20
20
|
* | `size` | `integer` | ❌ | The size of the page you want to retrieve. |
|
|
21
21
|
* | `sort` | `string` | ❌ | The order how you want to retrieve the custom fields. |
|
|
22
|
+
* | `suppliersIds` | `string[]` | ❌ | The list of supplier IDs for which you want to retrieve the logistic orders. |
|
|
23
|
+
* | `creationDateFrom`| `string` | ❌ | The creation date from which you want to retrieve the logistic orders. |
|
|
24
|
+
* | `creationDateTo` | `string` | ❌ | The creation date to which you want to retrieve the logistic orders. |
|
|
25
|
+
* | `updateDateFrom` | `string` | ❌ | The update date from which you want to retrieve the logistic orders. |
|
|
26
|
+
* | `updateDateTo` | `string` | ❌ | The update date to which you want to retrieve the logistic orders. |
|
|
22
27
|
*
|
|
23
28
|
* 📤 **Returns**:
|
|
24
29
|
* A `Promise` resolving to a single `GetLogisticOrdersResponse` object representing the page of logistic orders.
|
|
@@ -33,7 +38,7 @@ import { AddLogisticOrderReviewParameters, AddLogisticOrderReviewResponse, Appro
|
|
|
33
38
|
* @throws {Error} If `locale` is missing.
|
|
34
39
|
* @returns {Promise<GetLogisticOrdersResponse>} A promise resolving to the response containing page object.
|
|
35
40
|
*/
|
|
36
|
-
export declare function getLogisticOrders({ approvalIds, locale, logisticStatus, incident, paymentOptions, connectedUserOnly, nbPreviewLines, page, size, sort, }: GetLogisticOrdersParameters): Promise<GetLogisticOrdersResponse>;
|
|
41
|
+
export declare function getLogisticOrders({ approvalIds, locale, logisticStatus, incident, paymentOptions, connectedUserOnly, nbPreviewLines, page, size, sort, suppliersIds, creationDateFrom, creationDateTo, updateDateFrom, updateDateTo, }: GetLogisticOrdersParameters): Promise<GetLogisticOrdersResponse>;
|
|
37
42
|
/**
|
|
38
43
|
* 🚚 Get paginated and filtered Order logistics.
|
|
39
44
|
*
|
|
@@ -126,6 +131,7 @@ export declare function logisticOrdersPaginatedList({ page, size, sort, nbPrevie
|
|
|
126
131
|
* | `page` | `integer` | ❌ | The page number you want to retrieve. |
|
|
127
132
|
* | `size` | `integer` | ❌ | The size of the page you want to retrieve. |
|
|
128
133
|
* | `sort` | `string` | ❌ | The order how you want to retrieve the custom fields. |
|
|
134
|
+
* | `idType` | `IdType` | ❌ | The type of the ID you want to retrieve. |
|
|
129
135
|
*
|
|
130
136
|
* 📤 **Returns**:
|
|
131
137
|
* A `Promise` resolving to a single `GetLogisticOrderCustomFieldsResponse` object representing the page of custom fields.
|
|
@@ -143,7 +149,7 @@ export declare function logisticOrdersPaginatedList({ page, size, sort, nbPrevie
|
|
|
143
149
|
* @throws {Error} If `customFieldIds` is missing.
|
|
144
150
|
* @returns {Promise<GetLogisticOrderCustomFieldsResponse>} A promise resolving to the response containing the page object.
|
|
145
151
|
*/
|
|
146
|
-
export declare function getLogisticOrderCustomFields({ customFieldIds, page, size, sort, }: GetLogisticOrderCustomFieldsParameters): Promise<GetLogisticOrderCustomFieldsResponse>;
|
|
152
|
+
export declare function getLogisticOrderCustomFields({ customFieldIds, page, size, sort, idType, }: GetLogisticOrderCustomFieldsParameters): Promise<GetLogisticOrderCustomFieldsResponse>;
|
|
147
153
|
/**
|
|
148
154
|
* 🚚 Get logistic order lines' custom fields.
|
|
149
155
|
*
|
|
@@ -159,7 +165,7 @@ export declare function getLogisticOrderCustomFields({ customFieldIds, page, siz
|
|
|
159
165
|
* | `page` | `integer` | ❌ | The page number you want to retrieve. |
|
|
160
166
|
* | `size` | `integer` | ❌ | The size of the page you want to retrieve. |
|
|
161
167
|
* | `sort` | `string` | ❌ | The order how you want to retrieve the custom fields. |
|
|
162
|
-
*
|
|
168
|
+
* | `idType` | `IdType` | ❌ | The type of the ID you want to retrieve. |
|
|
163
169
|
* 📤 **Returns**:
|
|
164
170
|
* A `Promise` resolving to a single `GetLogisticOrderLineCustomFieldsResponse` object representing the page of custom fields.
|
|
165
171
|
*
|
|
@@ -176,7 +182,7 @@ export declare function getLogisticOrderCustomFields({ customFieldIds, page, siz
|
|
|
176
182
|
* @throws {Error} If `customFieldIds` is missing.
|
|
177
183
|
* @returns {Promise<GetLogisticOrderLineCustomFieldsResponse>} A promise resolving to the response containing the page object.
|
|
178
184
|
*/
|
|
179
|
-
export declare function getLogisticOrderLineCustomFields({ customFieldIds, page, size, sort, }: GetLogisticOrderLineCustomFieldsParameters): Promise<GetLogisticOrderLineCustomFieldsResponse>;
|
|
185
|
+
export declare function getLogisticOrderLineCustomFields({ customFieldIds, page, size, sort, idType, }: GetLogisticOrderLineCustomFieldsParameters): Promise<GetLogisticOrderLineCustomFieldsResponse>;
|
|
180
186
|
/**
|
|
181
187
|
* 🚚 Gets a specific logistic order.
|
|
182
188
|
*
|
|
@@ -909,7 +915,7 @@ export declare function createLogisticOrderThreadV2({ logisticOrderId, idType, m
|
|
|
909
915
|
* @throws {Error} If `logisticOrderId` is missing.
|
|
910
916
|
* @returns {Promise<GetLogisticOrderThreadsResponse>} A promise resolving when the thread is created.
|
|
911
917
|
*/
|
|
912
|
-
export declare function getLogisticOrderThreads({ logisticOrderId, pageable, }: GetLogisticOrderThreadsParams): Promise<GetLogisticOrderThreadsResponse>;
|
|
918
|
+
export declare function getLogisticOrderThreads({ logisticOrderId, pageable, idType, }: GetLogisticOrderThreadsParams): Promise<GetLogisticOrderThreadsResponse>;
|
|
913
919
|
/**
|
|
914
920
|
* 🚚 Get a logistic order thread.
|
|
915
921
|
*
|
|
@@ -939,7 +945,7 @@ export declare function getLogisticOrderThreads({ logisticOrderId, pageable, }:
|
|
|
939
945
|
* @throws {Error} If `logisticOrderId` or `threadId` is missing.
|
|
940
946
|
* @returns {Promise<GetLogisticOrderThreadResponse>} A promise resolving when the thread is found.
|
|
941
947
|
*/
|
|
942
|
-
export declare function getLogisticOrderThread({ logisticOrderId, threadId, }: GetLogisticOrderThreadParams): Promise<GetLogisticOrderThreadResponse>;
|
|
948
|
+
export declare function getLogisticOrderThread({ logisticOrderId, threadId, idType, }: GetLogisticOrderThreadParams): Promise<GetLogisticOrderThreadResponse>;
|
|
943
949
|
/**
|
|
944
950
|
* 🚚 Create messages for a specific logistic order thread.
|
|
945
951
|
* This function retrieves a specific logistic order thread, identified by
|
|
@@ -975,7 +981,7 @@ export declare function getLogisticOrderThread({ logisticOrderId, threadId, }: G
|
|
|
975
981
|
* @throws {Error} If `logisticOrderId` or `threadId` is missing.
|
|
976
982
|
* @returns {Promise<CreateLogisticOrderThreadMessagesResponse>} A promise resolving when the thread is found.
|
|
977
983
|
*/
|
|
978
|
-
export declare function createOrderLogisticThreadMessages({ logisticOrderId, threadId, body, customField, }: CreateLogisticOrderThreadMessagesParams): Promise<CreateLogisticOrderThreadMessagesResponse>;
|
|
984
|
+
export declare function createOrderLogisticThreadMessages({ logisticOrderId, threadId, body, customField, idType, }: CreateLogisticOrderThreadMessagesParams): Promise<CreateLogisticOrderThreadMessagesResponse>;
|
|
979
985
|
/**
|
|
980
986
|
* 🚚 Update messages for a specific logistic order thread.
|
|
981
987
|
*
|
|
@@ -1031,6 +1037,7 @@ export declare function updateOrderLogisticThreadMessage({ logisticOrderId, thre
|
|
|
1031
1037
|
* | `message` | `string` | ❌ | A message to add comments on the thread. |
|
|
1032
1038
|
* | `name` | `string` | ❌ | The name of the thread |
|
|
1033
1039
|
* | `reasonCode` | `string` | ✅ | The code indentifying the type of thread. |
|
|
1040
|
+
* | `idType` | `IdType` | ❌ | The type of the id. |
|
|
1034
1041
|
*
|
|
1035
1042
|
* 📤 **Returns**:
|
|
1036
1043
|
* A `Promise` resolving to a `CreateLogisticOrderIncidentThreadsResponse` object when the thread is created.
|
|
@@ -1061,7 +1068,7 @@ export declare function updateOrderLogisticThreadMessage({ logisticOrderId, thre
|
|
|
1061
1068
|
* @throws {Error} If `logisticOrderId`, `incidentId`, `reasonCode` is missing.
|
|
1062
1069
|
* @returns {Promise<CreateLogisticOrderIncidentThreadsResponse>} A promise resolving when the thread is created.
|
|
1063
1070
|
*/
|
|
1064
|
-
export declare function createLogisticOrderIncidentThreads({ logisticOrderId, incidentId, customField, message, name, reasonCode, }: CreateLogisticOrderIncidentThreadsParams): Promise<CreateLogisticOrderIncidentThreadsResponse>;
|
|
1071
|
+
export declare function createLogisticOrderIncidentThreads({ logisticOrderId, incidentId, customField, message, name, reasonCode, idType, }: CreateLogisticOrderIncidentThreadsParams): Promise<CreateLogisticOrderIncidentThreadsResponse>;
|
|
1065
1072
|
/**
|
|
1066
1073
|
* 🚚 Gets a specific thread of specific incident of a specific logistic order.
|
|
1067
1074
|
*
|
|
@@ -1076,6 +1083,7 @@ export declare function createLogisticOrderIncidentThreads({ logisticOrderId, in
|
|
|
1076
1083
|
* | `logisticOrderId` | `string` | ✅ | The ID of the logistic order of which you want to retrieve the review. |
|
|
1077
1084
|
* | `incidentId` | `string` | ✅ | The ID of the incident of which you want to retrieve the review. |
|
|
1078
1085
|
* | `threadId` | `string` | ✅ | The ID of the thread of which you want to retrieve the review. |
|
|
1086
|
+
* | `idType` | `IdType` | ❌ | The type of the id. |
|
|
1079
1087
|
*
|
|
1080
1088
|
* 📤 **Returns**:
|
|
1081
1089
|
* A `Promise` resolving to a single `GetLogisticOrderIncidentThreadResponse` object representing the review of the thread.
|
|
@@ -1093,7 +1101,7 @@ export declare function createLogisticOrderIncidentThreads({ logisticOrderId, in
|
|
|
1093
1101
|
* @throws {Error} If `logisticOrderId`, or `incidentId`, or `threadId` is missing.
|
|
1094
1102
|
* @returns {Promise<GetLogisticOrderIncidentThreadResponse>} A promise resolving to a response containing the review of the thread.
|
|
1095
1103
|
*/
|
|
1096
|
-
export declare function getLogisticOrderIncidentThread({ logisticOrderId, incidentId, threadId, }: GetLogisticOrderIncidentThreadParams): Promise<GetLogisticOrderIncidentThreadResponse>;
|
|
1104
|
+
export declare function getLogisticOrderIncidentThread({ logisticOrderId, incidentId, threadId, idType, }: GetLogisticOrderIncidentThreadParams): Promise<GetLogisticOrderIncidentThreadResponse>;
|
|
1097
1105
|
/**
|
|
1098
1106
|
* 🚚 Creates messages for a specific incident thread of a specific logistic order.
|
|
1099
1107
|
*
|
|
@@ -1109,6 +1117,7 @@ export declare function getLogisticOrderIncidentThread({ logisticOrderId, incide
|
|
|
1109
1117
|
* | `threadId` | `string` | ✅ | The ID of the thread of which you want to retrieve the review. |
|
|
1110
1118
|
* | `body` | `string` | ❌ | The body of the message to be added to the thread. |
|
|
1111
1119
|
* | `customField` | `logisticOrderIncidentThreadsCustomFieldValueRequest[]` | ❌ | The custom fields to add to the created incident threads messages |
|
|
1120
|
+
* | `idType` | `IdType` | ❌ | The type of the id. |
|
|
1112
1121
|
*
|
|
1113
1122
|
* 📤 **Returns**:
|
|
1114
1123
|
* A `Promise` resolving to a `CreateLogisticOrderIncidentThreadMessagesResponse` object when the message is created.
|
|
@@ -1136,7 +1145,7 @@ export declare function getLogisticOrderIncidentThread({ logisticOrderId, incide
|
|
|
1136
1145
|
* @throws {Error} If `logisticOrderId`, or `incidentId`, or `threadId` is missing.
|
|
1137
1146
|
* @returns {Promise<CreateLogisticOrderIncidentThreadsResponse>} A promise resolving when the message is created for the logistic order incident thread.
|
|
1138
1147
|
*/
|
|
1139
|
-
export declare function createLogisticOrderIncidentThreadMessages({ logisticOrderId, incidentId, threadId, body, customField, }: CreateLogisticOrderIncidentThreadMessagesParams): Promise<CreateLogisticOrderIncidentThreadMessagesResponse>;
|
|
1148
|
+
export declare function createLogisticOrderIncidentThreadMessages({ logisticOrderId, incidentId, threadId, body, customField, idType, }: CreateLogisticOrderIncidentThreadMessagesParams): Promise<CreateLogisticOrderIncidentThreadMessagesResponse>;
|
|
1140
1149
|
/**
|
|
1141
1150
|
* 🚚 Updadate a message for a specific incident thread of a specific logistic order.
|
|
1142
1151
|
*
|
|
@@ -61,6 +61,11 @@ const fetch_instance_1 = require("../../settings/fetch-instance");
|
|
|
61
61
|
* | `page` | `integer` | ❌ | The page number you want to retrieve. |
|
|
62
62
|
* | `size` | `integer` | ❌ | The size of the page you want to retrieve. |
|
|
63
63
|
* | `sort` | `string` | ❌ | The order how you want to retrieve the custom fields. |
|
|
64
|
+
* | `suppliersIds` | `string[]` | ❌ | The list of supplier IDs for which you want to retrieve the logistic orders. |
|
|
65
|
+
* | `creationDateFrom`| `string` | ❌ | The creation date from which you want to retrieve the logistic orders. |
|
|
66
|
+
* | `creationDateTo` | `string` | ❌ | The creation date to which you want to retrieve the logistic orders. |
|
|
67
|
+
* | `updateDateFrom` | `string` | ❌ | The update date from which you want to retrieve the logistic orders. |
|
|
68
|
+
* | `updateDateTo` | `string` | ❌ | The update date to which you want to retrieve the logistic orders. |
|
|
64
69
|
*
|
|
65
70
|
* 📤 **Returns**:
|
|
66
71
|
* A `Promise` resolving to a single `GetLogisticOrdersResponse` object representing the page of logistic orders.
|
|
@@ -75,7 +80,7 @@ const fetch_instance_1 = require("../../settings/fetch-instance");
|
|
|
75
80
|
* @throws {Error} If `locale` is missing.
|
|
76
81
|
* @returns {Promise<GetLogisticOrdersResponse>} A promise resolving to the response containing page object.
|
|
77
82
|
*/
|
|
78
|
-
async function getLogisticOrders({ approvalIds, locale, logisticStatus, incident, paymentOptions, connectedUserOnly, nbPreviewLines, page, size, sort, }) {
|
|
83
|
+
async function getLogisticOrders({ approvalIds, locale, logisticStatus, incident, paymentOptions, connectedUserOnly, nbPreviewLines, page, size, sort, suppliersIds, creationDateFrom, creationDateTo, updateDateFrom, updateDateTo, }) {
|
|
79
84
|
(0, parameters_validation_1.required)({ locale });
|
|
80
85
|
const { data } = await (0, fetch_instance_1.enhancedFetch)({
|
|
81
86
|
method: "GET",
|
|
@@ -91,6 +96,11 @@ async function getLogisticOrders({ approvalIds, locale, logisticStatus, incident
|
|
|
91
96
|
page,
|
|
92
97
|
size,
|
|
93
98
|
sort,
|
|
99
|
+
suppliersIds,
|
|
100
|
+
creationDateFrom,
|
|
101
|
+
creationDateTo,
|
|
102
|
+
updateDateFrom,
|
|
103
|
+
updateDateTo,
|
|
94
104
|
},
|
|
95
105
|
});
|
|
96
106
|
return data;
|
|
@@ -217,6 +227,7 @@ async function logisticOrdersPaginatedList({ page, size, sort, nbPreviewLines, a
|
|
|
217
227
|
* | `page` | `integer` | ❌ | The page number you want to retrieve. |
|
|
218
228
|
* | `size` | `integer` | ❌ | The size of the page you want to retrieve. |
|
|
219
229
|
* | `sort` | `string` | ❌ | The order how you want to retrieve the custom fields. |
|
|
230
|
+
* | `idType` | `IdType` | ❌ | The type of the ID you want to retrieve. |
|
|
220
231
|
*
|
|
221
232
|
* 📤 **Returns**:
|
|
222
233
|
* A `Promise` resolving to a single `GetLogisticOrderCustomFieldsResponse` object representing the page of custom fields.
|
|
@@ -234,7 +245,7 @@ async function logisticOrdersPaginatedList({ page, size, sort, nbPreviewLines, a
|
|
|
234
245
|
* @throws {Error} If `customFieldIds` is missing.
|
|
235
246
|
* @returns {Promise<GetLogisticOrderCustomFieldsResponse>} A promise resolving to the response containing the page object.
|
|
236
247
|
*/
|
|
237
|
-
async function getLogisticOrderCustomFields({ customFieldIds, page, size, sort, }) {
|
|
248
|
+
async function getLogisticOrderCustomFields({ customFieldIds, page, size, sort, idType, }) {
|
|
238
249
|
const { data } = await (0, fetch_instance_1.enhancedFetch)({
|
|
239
250
|
method: "GET",
|
|
240
251
|
path: `/v1/shop/logistic-orders/custom-fields`,
|
|
@@ -243,6 +254,7 @@ async function getLogisticOrderCustomFields({ customFieldIds, page, size, sort,
|
|
|
243
254
|
page,
|
|
244
255
|
size,
|
|
245
256
|
sort,
|
|
257
|
+
idType,
|
|
246
258
|
},
|
|
247
259
|
});
|
|
248
260
|
return data;
|
|
@@ -262,7 +274,7 @@ async function getLogisticOrderCustomFields({ customFieldIds, page, size, sort,
|
|
|
262
274
|
* | `page` | `integer` | ❌ | The page number you want to retrieve. |
|
|
263
275
|
* | `size` | `integer` | ❌ | The size of the page you want to retrieve. |
|
|
264
276
|
* | `sort` | `string` | ❌ | The order how you want to retrieve the custom fields. |
|
|
265
|
-
*
|
|
277
|
+
* | `idType` | `IdType` | ❌ | The type of the ID you want to retrieve. |
|
|
266
278
|
* 📤 **Returns**:
|
|
267
279
|
* A `Promise` resolving to a single `GetLogisticOrderLineCustomFieldsResponse` object representing the page of custom fields.
|
|
268
280
|
*
|
|
@@ -279,7 +291,7 @@ async function getLogisticOrderCustomFields({ customFieldIds, page, size, sort,
|
|
|
279
291
|
* @throws {Error} If `customFieldIds` is missing.
|
|
280
292
|
* @returns {Promise<GetLogisticOrderLineCustomFieldsResponse>} A promise resolving to the response containing the page object.
|
|
281
293
|
*/
|
|
282
|
-
async function getLogisticOrderLineCustomFields({ customFieldIds, page, size, sort, }) {
|
|
294
|
+
async function getLogisticOrderLineCustomFields({ customFieldIds, page, size, sort, idType, }) {
|
|
283
295
|
const { data } = await (0, fetch_instance_1.enhancedFetch)({
|
|
284
296
|
method: "GET",
|
|
285
297
|
path: `/v1/shop/logistic-orders/lines/custom-fields`,
|
|
@@ -288,6 +300,7 @@ async function getLogisticOrderLineCustomFields({ customFieldIds, page, size, so
|
|
|
288
300
|
page,
|
|
289
301
|
size,
|
|
290
302
|
sort,
|
|
303
|
+
idType,
|
|
291
304
|
},
|
|
292
305
|
});
|
|
293
306
|
return data;
|
|
@@ -881,7 +894,7 @@ async function getLogisticOrderLines({ orderId, page, size, sort, locale, }) {
|
|
|
881
894
|
async function updateOnHoldLogisticOrderLines({ orderId, lines, }) {
|
|
882
895
|
(0, parameters_validation_1.required)({ orderId, lines });
|
|
883
896
|
const { data } = await (0, fetch_instance_1.enhancedFetch)({
|
|
884
|
-
method: "
|
|
897
|
+
method: "PUT",
|
|
885
898
|
path: `/v1/shop/logistic-orders/${orderId}/lines`,
|
|
886
899
|
body: JSON.stringify(lines),
|
|
887
900
|
});
|
|
@@ -963,7 +976,7 @@ async function updateLogisticOrderLineCustomFields({ orderId, lineId, locale, cu
|
|
|
963
976
|
async function updateOnHoldLogisticOrderLine({ orderId, orderLineId, quantity, }) {
|
|
964
977
|
(0, parameters_validation_1.required)({ orderId, orderLineId, quantity });
|
|
965
978
|
await (0, fetch_instance_1.enhancedFetch)({
|
|
966
|
-
method: "
|
|
979
|
+
method: "PUT",
|
|
967
980
|
path: `/v1/shop/logistic-orders/${orderId}/lines/${orderLineId}`,
|
|
968
981
|
body: JSON.stringify(quantity),
|
|
969
982
|
});
|
|
@@ -1107,7 +1120,7 @@ async function updateLogisticOrderShippingType({ orderId, shippingType, }) {
|
|
|
1107
1120
|
(0, parameters_validation_1.required)({ orderId, shippingType });
|
|
1108
1121
|
(0, fetch_instance_1.enhancedFetch)({
|
|
1109
1122
|
method: "PUT",
|
|
1110
|
-
path: `/v1/shop/logistic-orders/${orderId}/shipping-
|
|
1123
|
+
path: `/v1/shop/logistic-orders/${orderId}/shipping-type`,
|
|
1111
1124
|
body: JSON.stringify({ shippingType }),
|
|
1112
1125
|
});
|
|
1113
1126
|
}
|
|
@@ -1193,7 +1206,7 @@ async function createLogisticOrderThreadV2({ logisticOrderId, idType, message, r
|
|
|
1193
1206
|
const { data } = await (0, fetch_instance_1.enhancedFetch)({
|
|
1194
1207
|
method: "POST",
|
|
1195
1208
|
path: `/v2/shop/logistic-orders/${logisticOrderId}/threads`,
|
|
1196
|
-
body: JSON.stringify({ name, message, reasonCode }),
|
|
1209
|
+
body: JSON.stringify({ name, message, reasonCode, idType }),
|
|
1197
1210
|
});
|
|
1198
1211
|
return data;
|
|
1199
1212
|
}
|
|
@@ -1225,7 +1238,7 @@ async function createLogisticOrderThreadV2({ logisticOrderId, idType, message, r
|
|
|
1225
1238
|
* @throws {Error} If `logisticOrderId` is missing.
|
|
1226
1239
|
* @returns {Promise<GetLogisticOrderThreadsResponse>} A promise resolving when the thread is created.
|
|
1227
1240
|
*/
|
|
1228
|
-
async function getLogisticOrderThreads({ logisticOrderId, pageable, }) {
|
|
1241
|
+
async function getLogisticOrderThreads({ logisticOrderId, pageable, idType, }) {
|
|
1229
1242
|
(0, parameters_validation_1.required)({ logisticOrderId });
|
|
1230
1243
|
const { data } = await (0, fetch_instance_1.enhancedFetch)({
|
|
1231
1244
|
method: "GET",
|
|
@@ -1233,6 +1246,7 @@ async function getLogisticOrderThreads({ logisticOrderId, pageable, }) {
|
|
|
1233
1246
|
params: {
|
|
1234
1247
|
page: pageable === null || pageable === void 0 ? void 0 : pageable.page,
|
|
1235
1248
|
size: pageable === null || pageable === void 0 ? void 0 : pageable.size,
|
|
1249
|
+
idType,
|
|
1236
1250
|
},
|
|
1237
1251
|
});
|
|
1238
1252
|
return data;
|
|
@@ -1266,11 +1280,14 @@ async function getLogisticOrderThreads({ logisticOrderId, pageable, }) {
|
|
|
1266
1280
|
* @throws {Error} If `logisticOrderId` or `threadId` is missing.
|
|
1267
1281
|
* @returns {Promise<GetLogisticOrderThreadResponse>} A promise resolving when the thread is found.
|
|
1268
1282
|
*/
|
|
1269
|
-
async function getLogisticOrderThread({ logisticOrderId, threadId, }) {
|
|
1283
|
+
async function getLogisticOrderThread({ logisticOrderId, threadId, idType, }) {
|
|
1270
1284
|
(0, parameters_validation_1.required)({ logisticOrderId });
|
|
1271
1285
|
const { data } = await (0, fetch_instance_1.enhancedFetch)({
|
|
1272
1286
|
method: "GET",
|
|
1273
1287
|
path: `/v2/shop/logistic-orders/${logisticOrderId}/threads/${threadId}`,
|
|
1288
|
+
params: {
|
|
1289
|
+
idType,
|
|
1290
|
+
},
|
|
1274
1291
|
});
|
|
1275
1292
|
return data;
|
|
1276
1293
|
}
|
|
@@ -1309,12 +1326,12 @@ async function getLogisticOrderThread({ logisticOrderId, threadId, }) {
|
|
|
1309
1326
|
* @throws {Error} If `logisticOrderId` or `threadId` is missing.
|
|
1310
1327
|
* @returns {Promise<CreateLogisticOrderThreadMessagesResponse>} A promise resolving when the thread is found.
|
|
1311
1328
|
*/
|
|
1312
|
-
async function createOrderLogisticThreadMessages({ logisticOrderId, threadId, body, customField, }) {
|
|
1329
|
+
async function createOrderLogisticThreadMessages({ logisticOrderId, threadId, body, customField, idType, }) {
|
|
1313
1330
|
(0, parameters_validation_1.required)({ logisticOrderId, threadId });
|
|
1314
1331
|
const { data } = await (0, fetch_instance_1.enhancedFetch)({
|
|
1315
1332
|
method: "POST",
|
|
1316
1333
|
path: `/v2/shop/logistic-orders/${logisticOrderId}/threads/${threadId}/messages`,
|
|
1317
|
-
body: JSON.stringify({ body, customField }),
|
|
1334
|
+
body: JSON.stringify({ body, customField, idType }),
|
|
1318
1335
|
});
|
|
1319
1336
|
return data;
|
|
1320
1337
|
}
|
|
@@ -1380,6 +1397,7 @@ async function updateOrderLogisticThreadMessage({ logisticOrderId, threadId, mes
|
|
|
1380
1397
|
* | `message` | `string` | ❌ | A message to add comments on the thread. |
|
|
1381
1398
|
* | `name` | `string` | ❌ | The name of the thread |
|
|
1382
1399
|
* | `reasonCode` | `string` | ✅ | The code indentifying the type of thread. |
|
|
1400
|
+
* | `idType` | `IdType` | ❌ | The type of the id. |
|
|
1383
1401
|
*
|
|
1384
1402
|
* 📤 **Returns**:
|
|
1385
1403
|
* A `Promise` resolving to a `CreateLogisticOrderIncidentThreadsResponse` object when the thread is created.
|
|
@@ -1410,12 +1428,12 @@ async function updateOrderLogisticThreadMessage({ logisticOrderId, threadId, mes
|
|
|
1410
1428
|
* @throws {Error} If `logisticOrderId`, `incidentId`, `reasonCode` is missing.
|
|
1411
1429
|
* @returns {Promise<CreateLogisticOrderIncidentThreadsResponse>} A promise resolving when the thread is created.
|
|
1412
1430
|
*/
|
|
1413
|
-
async function createLogisticOrderIncidentThreads({ logisticOrderId, incidentId, customField, message, name, reasonCode, }) {
|
|
1431
|
+
async function createLogisticOrderIncidentThreads({ logisticOrderId, incidentId, customField, message, name, reasonCode, idType, }) {
|
|
1414
1432
|
(0, parameters_validation_1.required)({ logisticOrderId, incidentId, reasonCode });
|
|
1415
1433
|
const { data } = await (0, fetch_instance_1.enhancedFetch)({
|
|
1416
1434
|
method: "POST",
|
|
1417
1435
|
path: `/v2/shop/logistic-orders/${logisticOrderId}/incidents/${incidentId}/threads`,
|
|
1418
|
-
body: JSON.stringify({ customField, message, name, reasonCode }),
|
|
1436
|
+
body: JSON.stringify({ customField, message, name, reasonCode, idType }),
|
|
1419
1437
|
});
|
|
1420
1438
|
return data;
|
|
1421
1439
|
}
|
|
@@ -1433,6 +1451,7 @@ async function createLogisticOrderIncidentThreads({ logisticOrderId, incidentId,
|
|
|
1433
1451
|
* | `logisticOrderId` | `string` | ✅ | The ID of the logistic order of which you want to retrieve the review. |
|
|
1434
1452
|
* | `incidentId` | `string` | ✅ | The ID of the incident of which you want to retrieve the review. |
|
|
1435
1453
|
* | `threadId` | `string` | ✅ | The ID of the thread of which you want to retrieve the review. |
|
|
1454
|
+
* | `idType` | `IdType` | ❌ | The type of the id. |
|
|
1436
1455
|
*
|
|
1437
1456
|
* 📤 **Returns**:
|
|
1438
1457
|
* A `Promise` resolving to a single `GetLogisticOrderIncidentThreadResponse` object representing the review of the thread.
|
|
@@ -1450,11 +1469,14 @@ async function createLogisticOrderIncidentThreads({ logisticOrderId, incidentId,
|
|
|
1450
1469
|
* @throws {Error} If `logisticOrderId`, or `incidentId`, or `threadId` is missing.
|
|
1451
1470
|
* @returns {Promise<GetLogisticOrderIncidentThreadResponse>} A promise resolving to a response containing the review of the thread.
|
|
1452
1471
|
*/
|
|
1453
|
-
async function getLogisticOrderIncidentThread({ logisticOrderId, incidentId, threadId, }) {
|
|
1472
|
+
async function getLogisticOrderIncidentThread({ logisticOrderId, incidentId, threadId, idType, }) {
|
|
1454
1473
|
(0, parameters_validation_1.required)({ logisticOrderId, incidentId, threadId });
|
|
1455
1474
|
const { data } = await (0, fetch_instance_1.enhancedFetch)({
|
|
1456
1475
|
method: "GET",
|
|
1457
1476
|
path: `/v2/shop/logistic-orders/${logisticOrderId}/incidents/${incidentId}/threads/${threadId}`,
|
|
1477
|
+
params: {
|
|
1478
|
+
idType,
|
|
1479
|
+
},
|
|
1458
1480
|
});
|
|
1459
1481
|
return data;
|
|
1460
1482
|
}
|
|
@@ -1473,6 +1495,7 @@ async function getLogisticOrderIncidentThread({ logisticOrderId, incidentId, thr
|
|
|
1473
1495
|
* | `threadId` | `string` | ✅ | The ID of the thread of which you want to retrieve the review. |
|
|
1474
1496
|
* | `body` | `string` | ❌ | The body of the message to be added to the thread. |
|
|
1475
1497
|
* | `customField` | `logisticOrderIncidentThreadsCustomFieldValueRequest[]` | ❌ | The custom fields to add to the created incident threads messages |
|
|
1498
|
+
* | `idType` | `IdType` | ❌ | The type of the id. |
|
|
1476
1499
|
*
|
|
1477
1500
|
* 📤 **Returns**:
|
|
1478
1501
|
* A `Promise` resolving to a `CreateLogisticOrderIncidentThreadMessagesResponse` object when the message is created.
|
|
@@ -1500,12 +1523,12 @@ async function getLogisticOrderIncidentThread({ logisticOrderId, incidentId, thr
|
|
|
1500
1523
|
* @throws {Error} If `logisticOrderId`, or `incidentId`, or `threadId` is missing.
|
|
1501
1524
|
* @returns {Promise<CreateLogisticOrderIncidentThreadsResponse>} A promise resolving when the message is created for the logistic order incident thread.
|
|
1502
1525
|
*/
|
|
1503
|
-
async function createLogisticOrderIncidentThreadMessages({ logisticOrderId, incidentId, threadId, body, customField, }) {
|
|
1526
|
+
async function createLogisticOrderIncidentThreadMessages({ logisticOrderId, incidentId, threadId, body, customField, idType, }) {
|
|
1504
1527
|
(0, parameters_validation_1.required)({ logisticOrderId, incidentId, threadId });
|
|
1505
1528
|
const { data } = await (0, fetch_instance_1.enhancedFetch)({
|
|
1506
1529
|
method: "POST",
|
|
1507
1530
|
path: `/v2/shop/logistic-orders/${logisticOrderId}/incidents/${incidentId}/threads/${threadId}/messages`,
|
|
1508
|
-
body: JSON.stringify({ customField, body }),
|
|
1531
|
+
body: JSON.stringify({ customField, body, idType }),
|
|
1509
1532
|
});
|
|
1510
1533
|
return data;
|
|
1511
1534
|
}
|
|
@@ -21,3 +21,10 @@ export interface GetNavigationCategoryResponse extends NavigationCategoryDto {
|
|
|
21
21
|
}
|
|
22
22
|
export interface GetNavigationCategoryBreadcrumbsResponse extends BreadcrumbDto {
|
|
23
23
|
}
|
|
24
|
+
export interface GetNavigationCategoryByOptionsParameters {
|
|
25
|
+
active?: boolean;
|
|
26
|
+
breadcrumb?: boolean;
|
|
27
|
+
idType?: string;
|
|
28
|
+
categoryId?: string;
|
|
29
|
+
locale?: string;
|
|
30
|
+
}
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import { GetNavigationCategoriesParameters, GetNavigationCategoriesResponse, GetNavigationCategoryBreadcrumbsParameters, GetNavigationCategoryBreadcrumbsResponse, GetNavigationCategoryParameters, GetNavigationCategoryResponse } from "./definitions";
|
|
1
|
+
import { GetNavigationCategoriesParameters, GetNavigationCategoriesResponse, GetNavigationCategoryBreadcrumbsParameters, GetNavigationCategoryBreadcrumbsResponse, GetNavigationCategoryParameters, GetNavigationCategoryResponse, GetNavigationCategoryByOptionsParameters } from "./definitions";
|
|
2
2
|
/**
|
|
3
3
|
* 📄 Gets all navigation categories.
|
|
4
4
|
*
|
|
@@ -79,3 +79,35 @@ export declare function getNavigationCategory({ locale, idType, navigationCatego
|
|
|
79
79
|
* ```
|
|
80
80
|
*/
|
|
81
81
|
export declare function getNavigationCategoryBreadcrumbs({ locale, idType, navigationCategoryId, }: GetNavigationCategoryBreadcrumbsParameters): Promise<GetNavigationCategoryBreadcrumbsResponse>;
|
|
82
|
+
/**
|
|
83
|
+
* 📄 Gets navigation categories by query parameters.
|
|
84
|
+
*
|
|
85
|
+
* @deprecated This endpoint should be avoided for new implementations. Use more specific endpoints instead.
|
|
86
|
+
*
|
|
87
|
+
* Retrieves navigation categories based on various filter options.
|
|
88
|
+
*
|
|
89
|
+
* 🛠 **Endpoint**: `GET /v1/shop/navigation-category`
|
|
90
|
+
*
|
|
91
|
+
* | Parameter | Type | Required | Description |
|
|
92
|
+
* |-----------------------|-------------------------------|------------|---------------------------------------------------------------|
|
|
93
|
+
* | `active` | `boolean` | | Filter categories by active status. |
|
|
94
|
+
* | `breadcrumb` | `boolean` | | Include breadcrumb information in the response. |
|
|
95
|
+
* | `idType` | `string` | | Type of ID used (DJUST_ID, EXTERNAL_ID). |
|
|
96
|
+
* | `categoryId` | `string` | | Filter by specific category ID. |
|
|
97
|
+
* | `locale` | `string` | | Locale for the returned category information. |
|
|
98
|
+
*
|
|
99
|
+
* 📤 **Returns**:
|
|
100
|
+
* A `Promise<Array<NavigationCategoryDto>>` containing the navigation categories that match the criteria.
|
|
101
|
+
*
|
|
102
|
+
* 🛠 **Example usage**:
|
|
103
|
+
* ```ts
|
|
104
|
+
* const categories = await getNavigationCategoryByOptions({
|
|
105
|
+
* active: true,
|
|
106
|
+
* locale: 'en-US',
|
|
107
|
+
* idType: 'DJUST_ID',
|
|
108
|
+
* });
|
|
109
|
+
*
|
|
110
|
+
* console.log(categories);
|
|
111
|
+
* ```
|
|
112
|
+
*/
|
|
113
|
+
export declare function getNavigationCategoryByOptions(params?: GetNavigationCategoryByOptionsParameters): Promise<GetNavigationCategoriesResponse>;
|
|
@@ -3,6 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
|
|
|
3
3
|
exports.getNavigationCategories = getNavigationCategories;
|
|
4
4
|
exports.getNavigationCategory = getNavigationCategory;
|
|
5
5
|
exports.getNavigationCategoryBreadcrumbs = getNavigationCategoryBreadcrumbs;
|
|
6
|
+
exports.getNavigationCategoryByOptions = getNavigationCategoryByOptions;
|
|
6
7
|
const parameters_validation_1 = require("../../helpers/parameters-validation");
|
|
7
8
|
const fetch_instance_1 = require("../../settings/fetch-instance");
|
|
8
9
|
/**
|
|
@@ -117,3 +118,42 @@ async function getNavigationCategoryBreadcrumbs({ locale, idType, navigationCate
|
|
|
117
118
|
});
|
|
118
119
|
return data;
|
|
119
120
|
}
|
|
121
|
+
/**
|
|
122
|
+
* 📄 Gets navigation categories by query parameters.
|
|
123
|
+
*
|
|
124
|
+
* @deprecated This endpoint should be avoided for new implementations. Use more specific endpoints instead.
|
|
125
|
+
*
|
|
126
|
+
* Retrieves navigation categories based on various filter options.
|
|
127
|
+
*
|
|
128
|
+
* 🛠 **Endpoint**: `GET /v1/shop/navigation-category`
|
|
129
|
+
*
|
|
130
|
+
* | Parameter | Type | Required | Description |
|
|
131
|
+
* |-----------------------|-------------------------------|------------|---------------------------------------------------------------|
|
|
132
|
+
* | `active` | `boolean` | | Filter categories by active status. |
|
|
133
|
+
* | `breadcrumb` | `boolean` | | Include breadcrumb information in the response. |
|
|
134
|
+
* | `idType` | `string` | | Type of ID used (DJUST_ID, EXTERNAL_ID). |
|
|
135
|
+
* | `categoryId` | `string` | | Filter by specific category ID. |
|
|
136
|
+
* | `locale` | `string` | | Locale for the returned category information. |
|
|
137
|
+
*
|
|
138
|
+
* 📤 **Returns**:
|
|
139
|
+
* A `Promise<Array<NavigationCategoryDto>>` containing the navigation categories that match the criteria.
|
|
140
|
+
*
|
|
141
|
+
* 🛠 **Example usage**:
|
|
142
|
+
* ```ts
|
|
143
|
+
* const categories = await getNavigationCategoryByOptions({
|
|
144
|
+
* active: true,
|
|
145
|
+
* locale: 'en-US',
|
|
146
|
+
* idType: 'DJUST_ID',
|
|
147
|
+
* });
|
|
148
|
+
*
|
|
149
|
+
* console.log(categories);
|
|
150
|
+
* ```
|
|
151
|
+
*/
|
|
152
|
+
async function getNavigationCategoryByOptions(params = {}) {
|
|
153
|
+
const { data } = await (0, fetch_instance_1.enhancedFetch)({
|
|
154
|
+
method: "GET",
|
|
155
|
+
path: `/v1/shop/navigation-category`,
|
|
156
|
+
params,
|
|
157
|
+
});
|
|
158
|
+
return data;
|
|
159
|
+
}
|
|
@@ -54,7 +54,7 @@ async function getPaginatedOfferInventories({ page, size, sort, productStatus, o
|
|
|
54
54
|
(0, parameters_validation_1.required)({ currency });
|
|
55
55
|
const { data } = await (0, fetch_instance_1.enhancedFetch)({
|
|
56
56
|
method: "GET",
|
|
57
|
-
path: `/v1/offer-inventories`,
|
|
57
|
+
path: `/v1/shop/offer-inventories`,
|
|
58
58
|
params: {
|
|
59
59
|
page,
|
|
60
60
|
size,
|
|
@@ -110,7 +110,7 @@ async function getPaginatedOfferInventoriesV2({ page, size, sort, variantExterna
|
|
|
110
110
|
(0, parameters_validation_1.required)({ variantExternalId });
|
|
111
111
|
const { data } = await (0, fetch_instance_1.enhancedFetch)({
|
|
112
112
|
method: "GET",
|
|
113
|
-
path: `/v2/offer-inventories`,
|
|
113
|
+
path: `/v2/shop/offer-inventories`,
|
|
114
114
|
params: {
|
|
115
115
|
variantExternalId,
|
|
116
116
|
page,
|
|
@@ -161,7 +161,7 @@ async function getOfferInventoryCustomFields({ externalId, page, size, sort, loc
|
|
|
161
161
|
(0, parameters_validation_1.required)({ externalId });
|
|
162
162
|
const { data } = await (0, fetch_instance_1.enhancedFetch)({
|
|
163
163
|
method: "GET",
|
|
164
|
-
path: `/v1/offer-inventories/${externalId}/custom-fields`,
|
|
164
|
+
path: `/v1/shop/offer-inventories/${externalId}/custom-fields`,
|
|
165
165
|
params: {
|
|
166
166
|
externalId,
|
|
167
167
|
page,
|
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
import { Order, PageableObject } from "../../interfaces/models/common";
|
|
2
|
+
import { OfferPrice } from "../../interfaces/models/offer";
|
|
3
|
+
/**
|
|
4
|
+
* Requests parameters type definitions
|
|
5
|
+
*/
|
|
6
|
+
export interface GetPaginatedOfferPricesParameters {
|
|
7
|
+
page?: number;
|
|
8
|
+
size?: number;
|
|
9
|
+
sort?: string;
|
|
10
|
+
offerInventoryExternalId?: string;
|
|
11
|
+
}
|
|
12
|
+
export interface GetOfferPricesResponse {
|
|
13
|
+
content: OfferPrice[];
|
|
14
|
+
empty: boolean;
|
|
15
|
+
first: boolean;
|
|
16
|
+
last: boolean;
|
|
17
|
+
number: number;
|
|
18
|
+
numberOfElements: number;
|
|
19
|
+
pageable: PageableObject;
|
|
20
|
+
size: number;
|
|
21
|
+
sort: Order[];
|
|
22
|
+
totalElements: number;
|
|
23
|
+
}
|
|
@@ -0,0 +1,35 @@
|
|
|
1
|
+
import { GetPaginatedOfferPricesParameters, GetOfferPricesResponse } from "./definitions";
|
|
2
|
+
/**
|
|
3
|
+
* 📄 Gets paginated offer prices.
|
|
4
|
+
*
|
|
5
|
+
* This function retrieves paginated offer prices with filtering by offer inventory external ID.
|
|
6
|
+
* The `offerInventoryExternalId` parameter is mandatory and validated before the request is executed.
|
|
7
|
+
*
|
|
8
|
+
* 🛠 **Endpoint**: `GET /v1/shop/offer-prices` [OFFER-PRICE-550]
|
|
9
|
+
*
|
|
10
|
+
* | Parameter | Type | Required | Description |
|
|
11
|
+
* |---------------------|----------|----------|------------------------------------------------|
|
|
12
|
+
* | `page` | `number` | ❌ | The page number to fetch (0-based index). |
|
|
13
|
+
* | `size` | `number` | ❌ | The number of items per page. |
|
|
14
|
+
* | `sort` | `string` | ❌ | The sort to apply to the results. |
|
|
15
|
+
* | `offerInventoryExternalId`| `string` | ✅ | The external ID of the offer inventory. |
|
|
16
|
+
*
|
|
17
|
+
* 📤 **Returns**:
|
|
18
|
+
* A `Promise` resolving to a `GetOfferPricesResponse` containing the paginated offer prices.
|
|
19
|
+
*
|
|
20
|
+
* 🛠 **Example usage**:
|
|
21
|
+
* ```typescript
|
|
22
|
+
* const prices = await getPaginatedOfferPrices({
|
|
23
|
+
* offerInventoryExternalId: "offer123",
|
|
24
|
+
* page: 0,
|
|
25
|
+
* size: 20,
|
|
26
|
+
* sort: "createdAt,desc",
|
|
27
|
+
* });
|
|
28
|
+
* console.log(prices);
|
|
29
|
+
* ```
|
|
30
|
+
*
|
|
31
|
+
* @param {GetPaginatedOfferPricesParameters} params - The parameters for the request
|
|
32
|
+
* @throws {Error} If `offerInventoryExternalId` is missing
|
|
33
|
+
* @returns {Promise<GetOfferPricesResponse>} A promise resolving to the response containing the paginated offer prices
|
|
34
|
+
*/
|
|
35
|
+
export declare function getPaginatedOfferPrices({ page, size, sort, offerInventoryExternalId, }: GetPaginatedOfferPricesParameters): Promise<GetOfferPricesResponse>;
|
|
@@ -0,0 +1,52 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.getPaginatedOfferPrices = getPaginatedOfferPrices;
|
|
4
|
+
const parameters_validation_1 = require("../../helpers/parameters-validation");
|
|
5
|
+
const fetch_instance_1 = require("../../settings/fetch-instance");
|
|
6
|
+
/**
|
|
7
|
+
* 📄 Gets paginated offer prices.
|
|
8
|
+
*
|
|
9
|
+
* This function retrieves paginated offer prices with filtering by offer inventory external ID.
|
|
10
|
+
* The `offerInventoryExternalId` parameter is mandatory and validated before the request is executed.
|
|
11
|
+
*
|
|
12
|
+
* 🛠 **Endpoint**: `GET /v1/shop/offer-prices` [OFFER-PRICE-550]
|
|
13
|
+
*
|
|
14
|
+
* | Parameter | Type | Required | Description |
|
|
15
|
+
* |---------------------|----------|----------|------------------------------------------------|
|
|
16
|
+
* | `page` | `number` | ❌ | The page number to fetch (0-based index). |
|
|
17
|
+
* | `size` | `number` | ❌ | The number of items per page. |
|
|
18
|
+
* | `sort` | `string` | ❌ | The sort to apply to the results. |
|
|
19
|
+
* | `offerInventoryExternalId`| `string` | ✅ | The external ID of the offer inventory. |
|
|
20
|
+
*
|
|
21
|
+
* 📤 **Returns**:
|
|
22
|
+
* A `Promise` resolving to a `GetOfferPricesResponse` containing the paginated offer prices.
|
|
23
|
+
*
|
|
24
|
+
* 🛠 **Example usage**:
|
|
25
|
+
* ```typescript
|
|
26
|
+
* const prices = await getPaginatedOfferPrices({
|
|
27
|
+
* offerInventoryExternalId: "offer123",
|
|
28
|
+
* page: 0,
|
|
29
|
+
* size: 20,
|
|
30
|
+
* sort: "createdAt,desc",
|
|
31
|
+
* });
|
|
32
|
+
* console.log(prices);
|
|
33
|
+
* ```
|
|
34
|
+
*
|
|
35
|
+
* @param {GetPaginatedOfferPricesParameters} params - The parameters for the request
|
|
36
|
+
* @throws {Error} If `offerInventoryExternalId` is missing
|
|
37
|
+
* @returns {Promise<GetOfferPricesResponse>} A promise resolving to the response containing the paginated offer prices
|
|
38
|
+
*/
|
|
39
|
+
async function getPaginatedOfferPrices({ page, size, sort, offerInventoryExternalId, }) {
|
|
40
|
+
(0, parameters_validation_1.required)({ offerInventoryExternalId });
|
|
41
|
+
const { data } = await (0, fetch_instance_1.enhancedFetch)({
|
|
42
|
+
method: "GET",
|
|
43
|
+
path: `/v1/shop/offer-prices`,
|
|
44
|
+
params: {
|
|
45
|
+
offerInventoryExternalId,
|
|
46
|
+
page,
|
|
47
|
+
size,
|
|
48
|
+
sort,
|
|
49
|
+
},
|
|
50
|
+
});
|
|
51
|
+
return data;
|
|
52
|
+
}
|
|
@@ -36,6 +36,9 @@ export interface GetProductsListParameters {
|
|
|
36
36
|
customFields?: string[];
|
|
37
37
|
offerUpdatedTime?: string;
|
|
38
38
|
productUpdatedTime?: string;
|
|
39
|
+
withFacets?: string;
|
|
40
|
+
priceMin?: number;
|
|
41
|
+
priceMax?: number;
|
|
39
42
|
};
|
|
40
43
|
pageable?: PageableParameters;
|
|
41
44
|
}
|
|
@@ -57,6 +60,7 @@ export interface GetProductOffersParameters {
|
|
|
57
60
|
productIdType: string;
|
|
58
61
|
locale?: string;
|
|
59
62
|
currency?: string;
|
|
63
|
+
withoutPrice?: boolean;
|
|
60
64
|
}
|
|
61
65
|
export interface GetProductVariantsListParameters {
|
|
62
66
|
productSku: string;
|
|
@@ -83,6 +87,7 @@ export interface GetProductVariantOffersParameters {
|
|
|
83
87
|
productIdentifier: string;
|
|
84
88
|
productIdType: string;
|
|
85
89
|
currency?: string;
|
|
90
|
+
withoutPrice?: boolean;
|
|
86
91
|
}
|
|
87
92
|
export interface GetRelatedProductsParameters {
|
|
88
93
|
productIdentifier: string;
|