@medusajs/js-sdk 3.0.0-snapshot-20250410112222 → 3.0.0-snapshot-20251104004624

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 (143) hide show
  1. package/dist/admin/claim.d.ts +1 -1
  2. package/dist/admin/claim.js +1 -1
  3. package/dist/admin/draft-order.d.ts +80 -77
  4. package/dist/admin/draft-order.d.ts.map +1 -1
  5. package/dist/admin/draft-order.js +90 -77
  6. package/dist/admin/draft-order.js.map +1 -1
  7. package/dist/admin/fulfillment-provider.d.ts +1 -1
  8. package/dist/admin/index.d.ts +16 -0
  9. package/dist/admin/index.d.ts.map +1 -1
  10. package/dist/admin/index.js +6 -0
  11. package/dist/admin/index.js.map +1 -1
  12. package/dist/admin/inventory-item.d.ts +1 -1
  13. package/dist/admin/inventory-item.d.ts.map +1 -1
  14. package/dist/admin/inventory-item.js.map +1 -1
  15. package/dist/admin/invite.d.ts +3 -8
  16. package/dist/admin/invite.d.ts.map +1 -1
  17. package/dist/admin/invite.js +3 -8
  18. package/dist/admin/invite.js.map +1 -1
  19. package/dist/admin/order-edit.d.ts +2 -0
  20. package/dist/admin/order-edit.d.ts.map +1 -1
  21. package/dist/admin/order-edit.js +2 -0
  22. package/dist/admin/order-edit.js.map +1 -1
  23. package/dist/admin/order.d.ts +76 -0
  24. package/dist/admin/order.d.ts.map +1 -1
  25. package/dist/admin/order.js +92 -0
  26. package/dist/admin/order.js.map +1 -1
  27. package/dist/admin/product.d.ts +72 -0
  28. package/dist/admin/product.d.ts.map +1 -1
  29. package/dist/admin/product.js +147 -1
  30. package/dist/admin/product.js.map +1 -1
  31. package/dist/admin/promotion.d.ts +2 -1
  32. package/dist/admin/promotion.d.ts.map +1 -1
  33. package/dist/admin/promotion.js +6 -2
  34. package/dist/admin/promotion.js.map +1 -1
  35. package/dist/admin/refund-reasons.d.ts +102 -2
  36. package/dist/admin/refund-reasons.d.ts.map +1 -1
  37. package/dist/admin/refund-reasons.js +126 -1
  38. package/dist/admin/refund-reasons.js.map +1 -1
  39. package/dist/admin/shipping-option-type.d.ts +152 -0
  40. package/dist/admin/shipping-option-type.d.ts.map +1 -0
  41. package/dist/admin/shipping-option-type.js +180 -0
  42. package/dist/admin/shipping-option-type.js.map +1 -0
  43. package/dist/admin/tax-provider.d.ts +64 -0
  44. package/dist/admin/tax-provider.d.ts.map +1 -0
  45. package/dist/admin/tax-provider.js +70 -0
  46. package/dist/admin/tax-provider.js.map +1 -0
  47. package/dist/admin/tax-region.d.ts +22 -0
  48. package/dist/admin/tax-region.d.ts.map +1 -1
  49. package/dist/admin/tax-region.js +29 -0
  50. package/dist/admin/tax-region.js.map +1 -1
  51. package/dist/admin/upload.d.ts +19 -2
  52. package/dist/admin/upload.d.ts.map +1 -1
  53. package/dist/admin/upload.js +26 -2
  54. package/dist/admin/upload.js.map +1 -1
  55. package/dist/admin/views.d.ts +54 -0
  56. package/dist/admin/views.d.ts.map +1 -0
  57. package/dist/admin/views.js +96 -0
  58. package/dist/admin/views.js.map +1 -0
  59. package/dist/auth/index.d.ts +4 -3
  60. package/dist/auth/index.d.ts.map +1 -1
  61. package/dist/auth/index.js +3 -1
  62. package/dist/auth/index.js.map +1 -1
  63. package/dist/client.d.ts +1 -0
  64. package/dist/client.d.ts.map +1 -1
  65. package/dist/client.js +4 -1
  66. package/dist/client.js.map +1 -1
  67. package/dist/esm/admin/claim.d.ts +1 -1
  68. package/dist/esm/admin/claim.js +1 -1
  69. package/dist/esm/admin/draft-order.d.ts +80 -77
  70. package/dist/esm/admin/draft-order.d.ts.map +1 -1
  71. package/dist/esm/admin/draft-order.js +94 -77
  72. package/dist/esm/admin/draft-order.js.map +1 -1
  73. package/dist/esm/admin/fulfillment-provider.d.ts +1 -1
  74. package/dist/esm/admin/index.d.ts +16 -0
  75. package/dist/esm/admin/index.d.ts.map +1 -1
  76. package/dist/esm/admin/index.js +6 -0
  77. package/dist/esm/admin/index.js.map +1 -1
  78. package/dist/esm/admin/inventory-item.d.ts +1 -1
  79. package/dist/esm/admin/inventory-item.d.ts.map +1 -1
  80. package/dist/esm/admin/inventory-item.js.map +1 -1
  81. package/dist/esm/admin/invite.d.ts +3 -8
  82. package/dist/esm/admin/invite.d.ts.map +1 -1
  83. package/dist/esm/admin/invite.js +3 -8
  84. package/dist/esm/admin/invite.js.map +1 -1
  85. package/dist/esm/admin/order-edit.d.ts +2 -0
  86. package/dist/esm/admin/order-edit.d.ts.map +1 -1
  87. package/dist/esm/admin/order-edit.js +2 -0
  88. package/dist/esm/admin/order-edit.js.map +1 -1
  89. package/dist/esm/admin/order.d.ts +76 -0
  90. package/dist/esm/admin/order.d.ts.map +1 -1
  91. package/dist/esm/admin/order.js +98 -0
  92. package/dist/esm/admin/order.js.map +1 -1
  93. package/dist/esm/admin/product.d.ts +72 -0
  94. package/dist/esm/admin/product.d.ts.map +1 -1
  95. package/dist/esm/admin/product.js +149 -1
  96. package/dist/esm/admin/product.js.map +1 -1
  97. package/dist/esm/admin/promotion.d.ts +2 -1
  98. package/dist/esm/admin/promotion.d.ts.map +1 -1
  99. package/dist/esm/admin/promotion.js +6 -2
  100. package/dist/esm/admin/promotion.js.map +1 -1
  101. package/dist/esm/admin/refund-reasons.d.ts +102 -2
  102. package/dist/esm/admin/refund-reasons.d.ts.map +1 -1
  103. package/dist/esm/admin/refund-reasons.js +134 -1
  104. package/dist/esm/admin/refund-reasons.js.map +1 -1
  105. package/dist/esm/admin/shipping-option-type.d.ts +152 -0
  106. package/dist/esm/admin/shipping-option-type.d.ts.map +1 -0
  107. package/dist/esm/admin/shipping-option-type.js +195 -0
  108. package/dist/esm/admin/shipping-option-type.js.map +1 -0
  109. package/dist/esm/admin/tax-provider.d.ts +64 -0
  110. package/dist/esm/admin/tax-provider.d.ts.map +1 -0
  111. package/dist/esm/admin/tax-provider.js +77 -0
  112. package/dist/esm/admin/tax-provider.js.map +1 -0
  113. package/dist/esm/admin/tax-region.d.ts +22 -0
  114. package/dist/esm/admin/tax-region.d.ts.map +1 -1
  115. package/dist/esm/admin/tax-region.js +31 -0
  116. package/dist/esm/admin/tax-region.js.map +1 -1
  117. package/dist/esm/admin/upload.d.ts +19 -2
  118. package/dist/esm/admin/upload.d.ts.map +1 -1
  119. package/dist/esm/admin/upload.js +28 -2
  120. package/dist/esm/admin/upload.js.map +1 -1
  121. package/dist/esm/admin/views.d.ts +54 -0
  122. package/dist/esm/admin/views.d.ts.map +1 -0
  123. package/dist/esm/admin/views.js +117 -0
  124. package/dist/esm/admin/views.js.map +1 -0
  125. package/dist/esm/auth/index.d.ts +4 -3
  126. package/dist/esm/auth/index.d.ts.map +1 -1
  127. package/dist/esm/auth/index.js +3 -1
  128. package/dist/esm/auth/index.js.map +1 -1
  129. package/dist/esm/client.d.ts +1 -0
  130. package/dist/esm/client.d.ts.map +1 -1
  131. package/dist/esm/client.js +6 -1
  132. package/dist/esm/client.js.map +1 -1
  133. package/dist/esm/store/index.d.ts +19 -2
  134. package/dist/esm/store/index.d.ts.map +1 -1
  135. package/dist/esm/store/index.js +19 -1
  136. package/dist/esm/store/index.js.map +1 -1
  137. package/dist/esm/types.d.ts.map +1 -1
  138. package/dist/store/index.d.ts +19 -2
  139. package/dist/store/index.d.ts.map +1 -1
  140. package/dist/store/index.js +19 -1
  141. package/dist/store/index.js.map +1 -1
  142. package/dist/types.d.ts.map +1 -1
  143. package/package.json +5 -9
@@ -98,11 +98,9 @@ export declare class DraftOrder {
98
98
  * @param body - The data to create the draft order.
99
99
  * @param query - Configure the fields to retrieve in the draft order.
100
100
  * @param headers - Headers to pass in the request.
101
+ * @returns The draft order's details.
101
102
  *
102
103
  * @example
103
- * To create a draft order:
104
- *
105
- * ```ts
106
104
  * sdk.admin.draftOrder.create({
107
105
  * email: "test@test.com",
108
106
  * items: [
@@ -117,9 +115,22 @@ export declare class DraftOrder {
117
115
  * .then(({ draft_order }) => {
118
116
  * console.log(draft_order)
119
117
  * })
120
- * ```
121
118
  */
122
119
  create(body: HttpTypes.AdminCreateDraftOrder, query?: HttpTypes.AdminDraftOrderParams, headers?: ClientHeaders): Promise<HttpTypes.AdminDraftOrderResponse>;
120
+ /**
121
+ * This method deletes a draft order. It sends a request to the
122
+ * [Delete Draft Order](https://docs.medusajs.com/api/admin#draft-orders_deleteordereditsid) API route.
123
+ *
124
+ * @param id - The draft order's ID.
125
+ * @param headers - Headers to pass in the request.
126
+ *
127
+ * @example
128
+ * sdk.admin.draftOrder.delete("order_123")
129
+ * .then(({ id, object, deleted }) => {
130
+ * console.log(id, object, deleted)
131
+ * })
132
+ */
133
+ delete(id: string, headers?: ClientHeaders): Promise<HttpTypes.DeleteResponse<"draft-order">>;
123
134
  /**
124
135
  * This method updates a draft order. It sends a request to the
125
136
  * [Update Draft Order](https://docs.medusajs.com/api/admin#draft-orders_postdraftordersid) API route.
@@ -128,32 +139,27 @@ export declare class DraftOrder {
128
139
  * @param body - The data to update the draft order.
129
140
  * @param query - Configure the fields to retrieve in the draft order.
130
141
  * @param headers - Headers to pass in the request.
142
+ * @returns The draft order's details.
131
143
  *
132
144
  * @example
133
- * To update a draft order:
134
- *
135
- * ```ts
136
145
  * sdk.admin.draftOrder.update("order_123", {
137
146
  * email: "test@test.com",
138
147
  * })
139
148
  * .then(({ draft_order }) => {
140
149
  * console.log(draft_order)
141
150
  * })
142
- * ```
143
151
  */
144
152
  update(id: string, body: HttpTypes.AdminUpdateDraftOrder, query?: HttpTypes.AdminDraftOrderParams, headers?: ClientHeaders): Promise<HttpTypes.AdminDraftOrderResponse>;
145
153
  /**
146
154
  * This method converts a draft order to an order. It sends a request to the
147
- * [Convert Draft Order to Order](https://docs.medusajs.com/api/admin#draft-orders_postdraftordersidconvert-to-order) API route.
155
+ * [Convert Draft Order to Order](https://docs.medusajs.com/api/admin#draft-orders_postdraftordersidconverttoorder) API route.
148
156
  *
149
157
  * @param id - The draft order's ID.
150
158
  * @param query - Configure the fields to retrieve in the order.
151
159
  * @param headers - Headers to pass in the request.
160
+ * @returns The order's details.
152
161
  *
153
162
  * @example
154
- * To convert a draft order to an order:
155
- *
156
- * ```ts
157
163
  * sdk.admin.draftOrder.convertToOrder("order_123")
158
164
  * .then(({ order }) => {
159
165
  * console.log(order)
@@ -162,16 +168,14 @@ export declare class DraftOrder {
162
168
  convertToOrder(id: string, query?: HttpTypes.AdminDraftOrderParams, headers?: ClientHeaders): Promise<HttpTypes.AdminOrderResponse>;
163
169
  /**
164
170
  * This method adds items to a draft order. It sends a request to the
165
- * [Add Draft Order Items](https://docs.medusajs.com/api/admin#draft-orders_postordereditsiditems) API route.
171
+ * [Add Draft Order Items](https://docs.medusajs.com/api/admin#draft-orders_postdraftordersidedititems) API route.
166
172
  *
167
173
  * @param id - The draft order's ID.
168
174
  * @param body - The data to add the items to the draft order.
169
175
  * @param headers - Headers to pass in the request.
176
+ * @returns The draft order preview's details.
170
177
  *
171
178
  * @example
172
- * To add items to a draft order:
173
- *
174
- * ```ts
175
179
  * sdk.admin.draftOrder.addItems("order_123", {
176
180
  * items: [
177
181
  * {
@@ -183,244 +187,243 @@ export declare class DraftOrder {
183
187
  * .then(({ draft_order_preview }) => {
184
188
  * console.log(draft_order_preview)
185
189
  * })
186
- * ```
187
190
  */
188
191
  addItems(id: string, body: HttpTypes.AdminAddDraftOrderItems, headers?: ClientHeaders): Promise<HttpTypes.AdminDraftOrderPreviewResponse>;
189
192
  /**
190
193
  * This method updates an item that is part of an action in a draft order. It sends a request to the
191
- * [Update Draft Order Item](https://docs.medusajs.com/api/admin#draft-orders_postordereditsiditemsaction_id) API route.
194
+ * [Update Draft Order Item](https://docs.medusajs.com/api/admin#draft-orders_postdraftordersidedititemsaction_id) API route.
192
195
  *
193
196
  * @param id - The draft order's ID.
194
197
  * @param actionId - The action ID.
195
198
  * @param body - The data to update the item.
196
199
  * @param headers - Headers to pass in the request.
200
+ * @returns The draft order preview's details.
197
201
  *
198
202
  * @example
199
- * To update an item that is part of an action in a draft order:
200
- *
201
- * ```ts
202
203
  * sdk.admin.draftOrder.updateActionItem("order_123", "action_123", {
203
204
  * quantity: 2,
204
205
  * })
205
206
  * .then(({ draft_order_preview }) => {
206
207
  * console.log(draft_order_preview)
207
208
  * })
208
- * ```
209
209
  */
210
210
  updateActionItem(id: string, actionId: string, body: HttpTypes.AdminUpdateDraftOrderItem, headers?: ClientHeaders): Promise<HttpTypes.AdminDraftOrderPreviewResponse>;
211
211
  /**
212
212
  * This method removes an item that is part of an action in a draft order. It sends a request to the
213
- * [Remove Draft Order Item](https://docs.medusajs.com/api/admin#draft-orders_deleteordereditsiditemsaction_id) API route.
213
+ * [Remove Draft Order Item](https://docs.medusajs.com/api/admin#draft-orders_deletedraftordersidedititemsaction_id) API route.
214
214
  *
215
215
  * @param id - The draft order's ID.
216
216
  * @param actionId - The action ID.
217
217
  * @param headers - Headers to pass in the request.
218
+ * @returns The draft order preview's details.
218
219
  *
219
220
  * @example
220
- * To remove an item that is part of an action in a draft order:
221
- *
222
- * ```ts
223
221
  * sdk.admin.draftOrder.removeActionItem("order_123", "action_123")
224
222
  * .then(({ draft_order_preview }) => {
225
223
  * console.log(draft_order_preview)
226
224
  * })
227
- * ```
228
225
  */
229
226
  removeActionItem(id: string, actionId: string, headers?: ClientHeaders): Promise<HttpTypes.AdminDraftOrderPreviewResponse>;
230
227
  /**
231
228
  * This method updates an item in a draft order. It sends a request to the
232
- * [Update Draft Order Item](https://docs.medusajs.com/api/admin#draft-orders_postordereditsiditemsitem_id) API route.
229
+ * [Update Draft Order Item](https://docs.medusajs.com/api/admin#draft-orders_postdraftordersidedititemsitemitem_id) API route.
233
230
  *
234
231
  * @param id - The draft order's ID.
235
232
  * @param itemId - The item ID.
236
233
  * @param body - The data to update the item.
237
234
  * @param headers - Headers to pass in the request.
235
+ * @returns The draft order preview's details.
238
236
  *
239
237
  * @example
240
- * To update an item in a draft order:
241
- *
242
- * ```ts
243
238
  * sdk.admin.draftOrder.updateItem("order_123", "item_123", {
244
239
  * quantity: 2,
245
240
  * })
246
241
  * .then(({ draft_order_preview }) => {
247
242
  * console.log(draft_order_preview)
248
243
  * })
249
- * ```
250
244
  */
251
245
  updateItem(id: string, itemId: string, body: HttpTypes.AdminUpdateDraftOrderItem, headers?: ClientHeaders): Promise<HttpTypes.AdminDraftOrderPreviewResponse>;
252
246
  /**
253
247
  * This method adds promotions to a draft order. It sends a request to the
254
- * [Add Draft Order Promotions](https://docs.medusajs.com/api/admin#draft-orders_postordereditsidpromotions) API route.
248
+ * [Add Draft Order Promotions](https://docs.medusajs.com/api/admin#draft-orders_postdraftordersideditpromotions) API route.
255
249
  *
256
250
  * @param id - The draft order's ID.
257
251
  * @param body - The data to add the promotions to the draft order.
258
252
  * @param headers - Headers to pass in the request.
253
+ * @returns The draft order preview's details.
259
254
  *
260
255
  * @example
261
- * To add promotions to a draft order:
262
- *
263
- * ```ts
264
256
  * sdk.admin.draftOrder.addPromotions("order_123", {
265
257
  * promo_codes: ["PROMO_CODE_1", "PROMO_CODE_2"],
266
258
  * })
267
259
  * .then(({ draft_order_preview }) => {
268
260
  * console.log(draft_order_preview)
269
261
  * })
270
- * ```
271
262
  */
272
263
  addPromotions(id: string, body: HttpTypes.AdminAddDraftOrderPromotions, headers?: ClientHeaders): Promise<HttpTypes.AdminDraftOrderPreviewResponse>;
273
264
  /**
274
265
  * This method removes promotions from a draft order. It sends a request to the
275
- * [Remove Draft Order Promotions](https://docs.medusajs.com/api/admin#draft-orders_deleteordereditsidpromotions) API route.
266
+ * [Remove Draft Order Promotions](https://docs.medusajs.com/api/admin#draft-orders_deletedraftordersideditpromotions) API route.
276
267
  *
277
268
  * @param id - The draft order's ID.
278
269
  * @param body - The data to remove the promotions from the draft order.
279
270
  * @param headers - Headers to pass in the request.
271
+ * @returns The draft order preview's details.
280
272
  *
281
273
  * @example
282
- * To remove promotions from a draft order:
283
- *
284
- * ```ts
285
274
  * sdk.admin.draftOrder.removePromotions("order_123", {
286
275
  * promo_codes: ["PROMO_CODE_1", "PROMO_CODE_2"],
287
276
  * })
288
- * ```
289
277
  */
290
278
  removePromotions(id: string, body: HttpTypes.AdminRemoveDraftOrderPromotions, headers?: ClientHeaders): Promise<HttpTypes.AdminDraftOrderPreviewResponse>;
291
279
  /**
292
280
  * This method adds a shipping method to a draft order. It sends a request to the
293
- * [Add Draft Order Shipping Method](https://docs.medusajs.com/api/admin#draft-orders_postordereditsidshipping-methods) API route.
281
+ * [Add Draft Order Shipping Method](https://docs.medusajs.com/api/admin#draft-orders_postdraftordersideditshippingmethods) API route.
294
282
  *
295
283
  * @param id - The draft order's ID.
296
284
  * @param body - The data to add the shipping method to the draft order.
297
285
  * @param headers - Headers to pass in the request.
286
+ * @returns The draft order preview's details.
298
287
  *
299
288
  * @example
300
- * To add a shipping method to a draft order:
301
- *
302
- * ```ts
303
289
  * sdk.admin.draftOrder.addShippingMethod("order_123", {
304
290
  * shipping_option_id: "shipping_option_123",
305
291
  * })
306
292
  * .then(({ draft_order_preview }) => {
307
293
  * console.log(draft_order_preview)
308
294
  * })
309
- * ```
310
295
  */
311
296
  addShippingMethod(id: string, body: HttpTypes.AdminAddDraftOrderShippingMethod, headers?: ClientHeaders): Promise<HttpTypes.AdminDraftOrderPreviewResponse>;
312
297
  /**
313
298
  * This method updates a shipping method in a draft order. It sends a request to the
314
- * [Update Draft Order Shipping Method](https://docs.medusajs.com/api/admin#draft-orders_postordereditsidshipping-methodsaction_id) API route.
299
+ * [Update Draft Order Shipping Method](https://docs.medusajs.com/api/admin#draft-orders_postdraftordersideditshippingmethodsaction_id) API route.
315
300
  *
316
301
  * @param id - The draft order's ID.
317
302
  * @param actionId - The action ID.
318
303
  * @param body - The data to update the shipping method.
319
304
  * @param headers - Headers to pass in the request.
305
+ * @returns The draft order preview's details.
320
306
  *
321
307
  * @example
322
- * To update a shipping method in a draft order:
323
- *
324
- * ```ts
325
308
  * sdk.admin.draftOrder.updateShippingMethod("order_123", "action_123", {
326
309
  * shipping_option_id: "shipping_option_123",
327
310
  * })
328
311
  * .then(({ draft_order_preview }) => {
329
312
  * console.log(draft_order_preview)
330
313
  * })
331
- * ```
332
314
  */
333
315
  updateActionShippingMethod(id: string, actionId: string, body: HttpTypes.AdminUpdateDraftOrderActionShippingMethod, headers?: ClientHeaders): Promise<HttpTypes.AdminDraftOrderPreviewResponse>;
334
316
  /**
335
317
  * This method removes a shipping method from a draft order. It sends a request to the
336
- * [Remove Draft Order Shipping Method](https://docs.medusajs.com/api/admin#draft-orders_deleteordereditsidshipping-methodsaction_id) API route.
318
+ * [Remove Draft Order Shipping Method](https://docs.medusajs.com/api/admin#draft-orders_deletedraftordersideditshippingmethodsaction_id) API route.
337
319
  *
338
320
  * @param id - The draft order's ID.
339
321
  * @param actionId - The action ID.
340
322
  * @param headers - Headers to pass in the request.
323
+ * @returns The draft order preview's details.
341
324
  *
342
325
  * @example
343
- * To remove a shipping method from a draft order:
344
- *
345
- * ```ts
346
326
  * sdk.admin.draftOrder.removeShippingMethod("order_123", "action_123")
347
327
  * .then(({ draft_order_preview }) => {
348
328
  * console.log(draft_order_preview)
349
329
  * })
350
- * ```
351
330
  */
352
331
  removeActionShippingMethod(id: string, actionId: string, headers?: ClientHeaders): Promise<HttpTypes.AdminDraftOrderPreviewResponse>;
332
+ /**
333
+ * This method removes a shipping method from an edited draft order. It sends a request to the
334
+ * [Remove Draft Order Shipping Method](https://docs.medusajs.com/api/admin#draft-orders_deletedraftordersideditshippingmethodsmethodmethod_id) API route.
335
+ *
336
+ * @param id - The draft order's ID.
337
+ * @param shippingMethodId - The shipping method's ID.
338
+ * @param headers - Headers to pass in the request.
339
+ * @returns The draft order preview's details.
340
+ *
341
+ * @example
342
+ * sdk.admin.draftOrder.removeShippingMethod(
343
+ * "order_123",
344
+ * "shipping_method_123"
345
+ * )
346
+ * .then(({ draft_order_preview }) => {
347
+ * console.log(draft_order_preview)
348
+ * })
349
+ */
350
+ removeShippingMethod(id: string, shippingMethodId: string, headers?: ClientHeaders): Promise<HttpTypes.AdminDraftOrderPreviewResponse>;
351
+ /**
352
+ * This method updates a shipping method in a draft order. It sends a request to the
353
+ * [Update Draft Order Shipping Method](https://docs.medusajs.com/api/admin#draft-orders_postdraftordersideditshippingmethodsmethodmethod_id) API route.
354
+ *
355
+ * @param id - The draft order's ID.
356
+ * @param methodId - The shipping method's ID.
357
+ * @param body - The data to update the shipping method.
358
+ * @param headers - Headers to pass in the request.
359
+ * @returns The draft order preview's details.
360
+ *
361
+ * @example
362
+ * sdk.admin.draftOrder.updateShippingMethod("order_123", "sm_123", {
363
+ * shipping_option_id: "so_123",
364
+ * })
365
+ * .then(({ draft_order_preview }) => {
366
+ * console.log(draft_order_preview)
367
+ * })
368
+ */
353
369
  updateShippingMethod(id: string, methodId: string, body: HttpTypes.AdminUpdateDraftOrderShippingMethod, headers?: ClientHeaders): Promise<HttpTypes.AdminDraftOrderPreviewResponse>;
354
370
  /**
355
371
  * This method begins an edit to a draft order. It sends a request to the
356
- * [Begin Draft Order Edit](https://docs.medusajs.com/api/admin#draft-orders_postordereditsid) API route.
372
+ * [Begin Draft Order Edit](https://docs.medusajs.com/api/admin#draft-orders_postdraftordersidedit) API route.
357
373
  *
358
374
  * @param id - The draft order's ID.
359
375
  * @param headers - Headers to pass in the request.
360
376
  *
361
377
  * @example
362
- * To begin an edit to a draft order:
363
- *
364
- * ```ts
365
378
  * sdk.admin.draftOrder.beginEdit("order_123")
366
379
  * .then(({ draft_order_preview }) => {
367
380
  * console.log(draft_order_preview)
368
381
  * })
369
- * ```
370
382
  */
371
383
  beginEdit(id: string, headers?: ClientHeaders): Promise<HttpTypes.AdminDraftOrderPreviewResponse>;
372
384
  /**
373
385
  * This method cancels an edit to a draft order. It sends a request to the
374
- * [Cancel Draft Order Edit](https://docs.medusajs.com/api/admin#draft-orders_deleteordereditsid) API route.
386
+ * [Cancel Draft Order Edit](https://docs.medusajs.com/api/admin#draft-orders_deletedraftordersidedit) API route.
375
387
  *
376
388
  * @param id - The draft order's ID.
377
389
  * @param headers - Headers to pass in the request.
390
+ * @returns The cancelation's details.
378
391
  *
379
392
  * @example
380
- * To cancel an edit to a draft order:
381
- *
382
- * ```ts
383
393
  * sdk.admin.draftOrder.cancelEdit("order_123")
384
394
  * .then(({ id, object, deleted }) => {
385
395
  * console.log(id, object, deleted)
386
396
  * })
387
- * ```
388
397
  */
389
398
  cancelEdit(id: string, headers?: ClientHeaders): Promise<HttpTypes.DeleteResponse<"draft-order-edit">>;
390
399
  /**
391
400
  * This method requests an edit to a draft order. It sends a request to the
392
- * [Request Draft Order Edit](https://docs.medusajs.com/api/admin#draft-orders_postordereditsidrequest) API route.
401
+ * [Request Draft Order Edit](https://docs.medusajs.com/api/admin#draft-orders_postdraftordersideditrequest) API route.
393
402
  *
394
403
  * @param id - The draft order's ID.
395
404
  * @param headers - Headers to pass in the request.
405
+ * @returns The draft order preview's details.
396
406
  *
397
407
  * @example
398
- * To request an edit to a draft order:
399
- *
400
- * ```ts
401
408
  * sdk.admin.draftOrder.requestEdit("order_123")
402
409
  * .then(({ draft_order_preview }) => {
403
410
  * console.log(draft_order_preview)
404
411
  * })
405
- * ```
406
412
  */
407
413
  requestEdit(id: string, headers?: ClientHeaders): Promise<HttpTypes.AdminDraftOrderPreviewResponse>;
408
414
  /**
409
415
  * This method confirms an edit to a draft order. It sends a request to the
410
- * [Confirm Draft Order Edit](https://docs.medusajs.com/api/admin#draft-orders_postordereditsidconfirm) API route.
416
+ * [Confirm Draft Order Edit](https://docs.medusajs.com/api/admin#draft-orders_postdraftordersideditconfirm) API route.
411
417
  *
412
418
  * @param id - The draft order's ID.
413
419
  * @param headers - Headers to pass in the request.
420
+ * @returns The draft order preview's details.
414
421
  *
415
422
  * @example
416
- * To confirm an edit to a draft order:
417
- *
418
- * ```ts
419
423
  * sdk.admin.draftOrder.confirmEdit("order_123")
420
424
  * .then(({ draft_order_preview }) => {
421
425
  * console.log(draft_order_preview)
422
426
  * })
423
- * ```
424
427
  */
425
428
  confirmEdit(id: string, headers?: ClientHeaders): Promise<HttpTypes.AdminDraftOrderPreviewResponse>;
426
429
  }
@@ -1 +1 @@
1
- {"version":3,"file":"draft-order.d.ts","sourceRoot":"","sources":["../../../src/admin/draft-order.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAA;AAE3C,OAAO,EAAE,MAAM,EAAE,MAAM,WAAW,CAAA;AAClC,OAAO,EAAE,aAAa,EAAE,MAAM,UAAU,CAAA;AAExC,qBAAa,UAAU;IACrB;;OAEG;IACH,OAAO,CAAC,MAAM,CAAQ;IACtB;;OAEG;gBACS,MAAM,EAAE,MAAM;IAI1B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAgCG;IACG,QAAQ,CACZ,EAAE,EAAE,MAAM,EACV,KAAK,CAAC,EAAE,SAAS,CAAC,qBAAqB,EACvC,OAAO,CAAC,EAAE,aAAa;IAWzB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA6CG;IACG,IAAI,CACR,WAAW,CAAC,EAAE,SAAS,CAAC,yBAAyB,EACjD,OAAO,CAAC,EAAE,aAAa;IAWzB;;;;;;;;;;;;;;;;;;;;;;;;;;;OA2BG;IACG,MAAM,CACV,IAAI,EAAE,SAAS,CAAC,qBAAqB,EACrC,KAAK,CAAC,EAAE,SAAS,CAAC,qBAAqB,EACvC,OAAO,CAAC,EAAE,aAAa;IAazB;;;;;;;;;;;;;;;;;;;;OAoBG;IACG,MAAM,CACV,EAAE,EAAE,MAAM,EACV,IAAI,EAAE,SAAS,CAAC,qBAAqB,EACrC,KAAK,CAAC,EAAE,SAAS,CAAC,qBAAqB,EACvC,OAAO,CAAC,EAAE,aAAa;IAazB;;;;;;;;;;;;;;;;OAgBG;IACG,cAAc,CAClB,EAAE,EAAE,MAAM,EACV,KAAK,CAAC,EAAE,SAAS,CAAC,qBAAqB,EACvC,OAAO,CAAC,EAAE,aAAa;IAYzB;;;;;;;;;;;;;;;;;;;;;;;;OAwBG;IACG,QAAQ,CACZ,EAAE,EAAE,MAAM,EACV,IAAI,EAAE,SAAS,CAAC,uBAAuB,EACvC,OAAO,CAAC,EAAE,aAAa;IAYzB;;;;;;;;;;;;;;;;;;;;OAoBG;IACG,gBAAgB,CACpB,EAAE,EAAE,MAAM,EACV,QAAQ,EAAE,MAAM,EAChB,IAAI,EAAE,SAAS,CAAC,yBAAyB,EACzC,OAAO,CAAC,EAAE,aAAa;IAYzB;;;;;;;;;;;;;;;;;OAiBG;IACG,gBAAgB,CACpB,EAAE,EAAE,MAAM,EACV,QAAQ,EAAE,MAAM,EAChB,OAAO,CAAC,EAAE,aAAa;IAWzB;;;;;;;;;;;;;;;;;;;;OAoBG;IACG,UAAU,CACd,EAAE,EAAE,MAAM,EACV,MAAM,EAAE,MAAM,EACd,IAAI,EAAE,SAAS,CAAC,yBAAyB,EACzC,OAAO,CAAC,EAAE,aAAa;IAYzB;;;;;;;;;;;;;;;;;;;OAmBG;IACG,aAAa,CACjB,EAAE,EAAE,MAAM,EACV,IAAI,EAAE,SAAS,CAAC,4BAA4B,EAC5C,OAAO,CAAC,EAAE,aAAa;IAYzB;;;;;;;;;;;;;;;;OAgBG;IACG,gBAAgB,CACpB,EAAE,EAAE,MAAM,EACV,IAAI,EAAE,SAAS,CAAC,+BAA+B,EAC/C,OAAO,CAAC,EAAE,aAAa;IAYzB;;;;;;;;;;;;;;;;;;;OAmBG;IACG,iBAAiB,CACrB,EAAE,EAAE,MAAM,EACV,IAAI,EAAE,SAAS,CAAC,gCAAgC,EAChD,OAAO,CAAC,EAAE,aAAa;IAYzB;;;;;;;;;;;;;;;;;;;;OAoBG;IACG,0BAA0B,CAC9B,EAAE,EAAE,MAAM,EACV,QAAQ,EAAE,MAAM,EAChB,IAAI,EAAE,SAAS,CAAC,yCAAyC,EACzD,OAAO,CAAC,EAAE,aAAa;IAYzB;;;;;;;;;;;;;;;;;OAiBG;IACG,0BAA0B,CAC9B,EAAE,EAAE,MAAM,EACV,QAAQ,EAAE,MAAM,EAChB,OAAO,CAAC,EAAE,aAAa;IAWnB,oBAAoB,CACxB,EAAE,EAAE,MAAM,EACV,QAAQ,EAAE,MAAM,EAChB,IAAI,EAAE,SAAS,CAAC,mCAAmC,EACnD,OAAO,CAAC,EAAE,aAAa;IAWzB;;;;;;;;;;;;;;;;OAgBG;IACG,SAAS,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,aAAa;IAUnD;;;;;;;;;;;;;;;;OAgBG;IACG,UAAU,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,aAAa;IASpD;;;;;;;;;;;;;;;;OAgBG;IACG,WAAW,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,aAAa;IAUrD;;;;;;;;;;;;;;;;OAgBG;IACG,WAAW,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,aAAa;CAStD"}
1
+ {"version":3,"file":"draft-order.d.ts","sourceRoot":"","sources":["../../../src/admin/draft-order.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAA;AAE3C,OAAO,EAAE,MAAM,EAAE,MAAM,WAAW,CAAA;AAClC,OAAO,EAAE,aAAa,EAAE,MAAM,UAAU,CAAA;AAExC,qBAAa,UAAU;IACrB;;OAEG;IACH,OAAO,CAAC,MAAM,CAAQ;IACtB;;OAEG;gBACS,MAAM,EAAE,MAAM;IAI1B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAgCG;IACG,QAAQ,CACZ,EAAE,EAAE,MAAM,EACV,KAAK,CAAC,EAAE,SAAS,CAAC,qBAAqB,EACvC,OAAO,CAAC,EAAE,aAAa;IAWzB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA6CG;IACG,IAAI,CACR,WAAW,CAAC,EAAE,SAAS,CAAC,yBAAyB,EACjD,OAAO,CAAC,EAAE,aAAa;IAWzB;;;;;;;;;;;;;;;;;;;;;;;;OAwBG;IACG,MAAM,CACV,IAAI,EAAE,SAAS,CAAC,qBAAqB,EACrC,KAAK,CAAC,EAAE,SAAS,CAAC,qBAAqB,EACvC,OAAO,CAAC,EAAE,aAAa;IAazB;;;;;;;;;;;;OAYG;IACG,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,aAAa;IAUhD;;;;;;;;;;;;;;;;;OAiBG;IACG,MAAM,CACV,EAAE,EAAE,MAAM,EACV,IAAI,EAAE,SAAS,CAAC,qBAAqB,EACrC,KAAK,CAAC,EAAE,SAAS,CAAC,qBAAqB,EACvC,OAAO,CAAC,EAAE,aAAa;IAazB;;;;;;;;;;;;;;OAcG;IACG,cAAc,CAClB,EAAE,EAAE,MAAM,EACV,KAAK,CAAC,EAAE,SAAS,CAAC,qBAAqB,EACvC,OAAO,CAAC,EAAE,aAAa;IAYzB;;;;;;;;;;;;;;;;;;;;;OAqBG;IACG,QAAQ,CACZ,EAAE,EAAE,MAAM,EACV,IAAI,EAAE,SAAS,CAAC,uBAAuB,EACvC,OAAO,CAAC,EAAE,aAAa;IAYzB;;;;;;;;;;;;;;;;;OAiBG;IACG,gBAAgB,CACpB,EAAE,EAAE,MAAM,EACV,QAAQ,EAAE,MAAM,EAChB,IAAI,EAAE,SAAS,CAAC,yBAAyB,EACzC,OAAO,CAAC,EAAE,aAAa;IAYzB;;;;;;;;;;;;;;OAcG;IACG,gBAAgB,CACpB,EAAE,EAAE,MAAM,EACV,QAAQ,EAAE,MAAM,EAChB,OAAO,CAAC,EAAE,aAAa;IAWzB;;;;;;;;;;;;;;;;;OAiBG;IACG,UAAU,CACd,EAAE,EAAE,MAAM,EACV,MAAM,EAAE,MAAM,EACd,IAAI,EAAE,SAAS,CAAC,yBAAyB,EACzC,OAAO,CAAC,EAAE,aAAa;IAYzB;;;;;;;;;;;;;;;;OAgBG;IACG,aAAa,CACjB,EAAE,EAAE,MAAM,EACV,IAAI,EAAE,SAAS,CAAC,4BAA4B,EAC5C,OAAO,CAAC,EAAE,aAAa;IAYzB;;;;;;;;;;;;;OAaG;IACG,gBAAgB,CACpB,EAAE,EAAE,MAAM,EACV,IAAI,EAAE,SAAS,CAAC,+BAA+B,EAC/C,OAAO,CAAC,EAAE,aAAa;IAYzB;;;;;;;;;;;;;;;;OAgBG;IACG,iBAAiB,CACrB,EAAE,EAAE,MAAM,EACV,IAAI,EAAE,SAAS,CAAC,gCAAgC,EAChD,OAAO,CAAC,EAAE,aAAa;IAYzB;;;;;;;;;;;;;;;;;OAiBG;IACG,0BAA0B,CAC9B,EAAE,EAAE,MAAM,EACV,QAAQ,EAAE,MAAM,EAChB,IAAI,EAAE,SAAS,CAAC,yCAAyC,EACzD,OAAO,CAAC,EAAE,aAAa;IAYzB;;;;;;;;;;;;;;OAcG;IACG,0BAA0B,CAC9B,EAAE,EAAE,MAAM,EACV,QAAQ,EAAE,MAAM,EAChB,OAAO,CAAC,EAAE,aAAa;IAWzB;;;;;;;;;;;;;;;;;OAiBG;IACG,oBAAoB,CACxB,EAAE,EAAE,MAAM,EACV,gBAAgB,EAAE,MAAM,EACxB,OAAO,CAAC,EAAE,aAAa;IAWzB;;;;;;;;;;;;;;;;;OAiBG;IACG,oBAAoB,CACxB,EAAE,EAAE,MAAM,EACV,QAAQ,EAAE,MAAM,EAChB,IAAI,EAAE,SAAS,CAAC,mCAAmC,EACnD,OAAO,CAAC,EAAE,aAAa;IAWzB;;;;;;;;;;;;OAYG;IACG,SAAS,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,aAAa;IAUnD;;;;;;;;;;;;;OAaG;IACG,UAAU,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,aAAa;IASpD;;;;;;;;;;;;;OAaG;IACG,WAAW,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,aAAa;IAUrD;;;;;;;;;;;;;OAaG;IACG,WAAW,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,aAAa;CAStD"}