@medusajs/js-sdk 0.0.2-snapshot-20241022120003 → 0.0.2-snapshot-20241022140307

Sign up to get free protection for your applications and to get access to all the features.
Files changed (65) hide show
  1. package/dist/admin/api-key.d.ts +144 -1
  2. package/dist/admin/api-key.d.ts.map +1 -1
  3. package/dist/admin/api-key.js +143 -0
  4. package/dist/admin/api-key.js.map +1 -1
  5. package/dist/admin/campaign.d.ts +135 -0
  6. package/dist/admin/campaign.d.ts.map +1 -1
  7. package/dist/admin/campaign.js +135 -0
  8. package/dist/admin/campaign.js.map +1 -1
  9. package/dist/admin/claim.d.ts +542 -19
  10. package/dist/admin/claim.d.ts.map +1 -1
  11. package/dist/admin/claim.js +523 -0
  12. package/dist/admin/claim.js.map +1 -1
  13. package/dist/admin/currency.d.ts +80 -1
  14. package/dist/admin/currency.d.ts.map +1 -1
  15. package/dist/admin/currency.js +81 -2
  16. package/dist/admin/currency.js.map +1 -1
  17. package/dist/admin/customer-group.d.ts +152 -2
  18. package/dist/admin/customer-group.d.ts.map +1 -1
  19. package/dist/admin/customer-group.js +150 -0
  20. package/dist/admin/customer-group.js.map +1 -1
  21. package/dist/admin/customer.d.ts +135 -13
  22. package/dist/admin/customer.d.ts.map +1 -1
  23. package/dist/admin/customer.js +130 -0
  24. package/dist/admin/customer.js.map +1 -1
  25. package/dist/admin/exchange.d.ts +471 -16
  26. package/dist/admin/exchange.d.ts.map +1 -1
  27. package/dist/admin/exchange.js +455 -0
  28. package/dist/admin/exchange.js.map +1 -1
  29. package/dist/admin/fulfillment-provider.d.ts +47 -0
  30. package/dist/admin/fulfillment-provider.d.ts.map +1 -1
  31. package/dist/admin/fulfillment-provider.js +47 -0
  32. package/dist/admin/fulfillment-provider.js.map +1 -1
  33. package/dist/esm/admin/api-key.d.ts +144 -1
  34. package/dist/esm/admin/api-key.d.ts.map +1 -1
  35. package/dist/esm/admin/api-key.js +143 -0
  36. package/dist/esm/admin/api-key.js.map +1 -1
  37. package/dist/esm/admin/campaign.d.ts +135 -0
  38. package/dist/esm/admin/campaign.d.ts.map +1 -1
  39. package/dist/esm/admin/campaign.js +135 -0
  40. package/dist/esm/admin/campaign.js.map +1 -1
  41. package/dist/esm/admin/claim.d.ts +542 -19
  42. package/dist/esm/admin/claim.d.ts.map +1 -1
  43. package/dist/esm/admin/claim.js +523 -0
  44. package/dist/esm/admin/claim.js.map +1 -1
  45. package/dist/esm/admin/currency.d.ts +80 -1
  46. package/dist/esm/admin/currency.d.ts.map +1 -1
  47. package/dist/esm/admin/currency.js +81 -2
  48. package/dist/esm/admin/currency.js.map +1 -1
  49. package/dist/esm/admin/customer-group.d.ts +152 -2
  50. package/dist/esm/admin/customer-group.d.ts.map +1 -1
  51. package/dist/esm/admin/customer-group.js +150 -0
  52. package/dist/esm/admin/customer-group.js.map +1 -1
  53. package/dist/esm/admin/customer.d.ts +135 -13
  54. package/dist/esm/admin/customer.d.ts.map +1 -1
  55. package/dist/esm/admin/customer.js +130 -0
  56. package/dist/esm/admin/customer.js.map +1 -1
  57. package/dist/esm/admin/exchange.d.ts +471 -16
  58. package/dist/esm/admin/exchange.d.ts.map +1 -1
  59. package/dist/esm/admin/exchange.js +455 -0
  60. package/dist/esm/admin/exchange.js.map +1 -1
  61. package/dist/esm/admin/fulfillment-provider.d.ts +47 -0
  62. package/dist/esm/admin/fulfillment-provider.d.ts.map +1 -1
  63. package/dist/esm/admin/fulfillment-provider.js +47 -0
  64. package/dist/esm/admin/fulfillment-provider.js.map +1 -1
  65. package/package.json +2 -2
@@ -1,4 +1,4 @@
1
- import { HttpTypes } from "@medusajs/types";
1
+ import { HttpTypes, SelectParams } from "@medusajs/types";
2
2
  import { Client } from "../client";
3
3
  import { ClientHeaders } from "../types";
4
4
  export declare class Exchange {
@@ -10,23 +10,478 @@ export declare class Exchange {
10
10
  * @ignore
11
11
  */
12
12
  constructor(client: Client);
13
+ /**
14
+ * This method retrieves a paginated list of exchanges. It sends a request to the
15
+ * [List Exchanges](https://docs.medusajs.com/v2/api/admin#exchanges_getexchanges)
16
+ * API route.
17
+ *
18
+ * @param query - Filters and pagination configurations.
19
+ * @param headers - Headers to pass in the request.
20
+ * @returns The paginated list of exchanges.
21
+ *
22
+ * @example
23
+ * To retrieve the list of exchanges:
24
+ *
25
+ * ```ts
26
+ * sdk.admin.exchange.list()
27
+ * .then(({ exchanges, count, limit, offset }) => {
28
+ * console.log(exchanges)
29
+ * })
30
+ * ```
31
+ *
32
+ * To configure the pagination, pass the `limit` and `offset` query parameters.
33
+ *
34
+ * For example, to retrieve only 10 items and skip 10 items:
35
+ *
36
+ * ```ts
37
+ * sdk.admin.exchange.list({
38
+ * limit: 10,
39
+ * offset: 10
40
+ * })
41
+ * .then(({ exchanges, count, limit, offset }) => {
42
+ * console.log(exchanges)
43
+ * })
44
+ * ```
45
+ *
46
+ * Using the `fields` query parameter, you can specify the fields and relations to retrieve
47
+ * in each exchange:
48
+ *
49
+ * ```ts
50
+ * sdk.admin.exchange.list({
51
+ * fields: "id,*order"
52
+ * })
53
+ * .then(({ exchanges, count, limit, offset }) => {
54
+ * console.log(exchanges)
55
+ * })
56
+ * ```
57
+ *
58
+ * Learn more about the `fields` property in the [API reference](https://docs.medusajs.com/v2/api/store#select-fields-and-relations).
59
+ */
13
60
  list(query?: HttpTypes.AdminExchangeListParams, headers?: ClientHeaders): Promise<HttpTypes.AdminExchangeListResponse>;
14
- retrieve(id: string, query?: HttpTypes.AdminExchangeParams, headers?: ClientHeaders): Promise<HttpTypes.AdminExchangeResponse>;
61
+ /**
62
+ * This method retrieves an exchange by its ID. It sends a request to the
63
+ * [Get Exchange](https://docs.medusajs.com/v2/api/admin#exchanges_getexchangesid)
64
+ * API route.
65
+ *
66
+ * @param id - The exchange's ID.
67
+ * @param query - Configure the fields to retrieve in the exchange.
68
+ * @param headers - Headers to pass in the request.
69
+ * @returns The exchange's details.
70
+ *
71
+ * @example
72
+ * To retrieve an exchange by its ID:
73
+ *
74
+ * ```ts
75
+ * sdk.admin.exchange.retrieve("exchange_123")
76
+ * .then(({ exchange }) => {
77
+ * console.log(exchange)
78
+ * })
79
+ * ```
80
+ *
81
+ * To specify the fields and relations to retrieve:
82
+ *
83
+ * ```ts
84
+ * sdk.admin.exchange.retrieve("exchange_123", {
85
+ * fields: "id,*order"
86
+ * })
87
+ * .then(({ exchange }) => {
88
+ * console.log(exchange)
89
+ * })
90
+ * ```
91
+ *
92
+ * Learn more about the `fields` property in the [API reference](https://docs.medusajs.com/v2/api/store#select-fields-and-relations).
93
+ */
94
+ retrieve(id: string, query?: SelectParams, headers?: ClientHeaders): Promise<HttpTypes.AdminExchangeResponse>;
95
+ /**
96
+ * This method creates an admin exchange. It sends a request to the
97
+ * [Create Exchange](https://docs.medusajs.com/v2/api/admin#exchanges_postexchanges) API route.
98
+ *
99
+ * @param body - The exchange's details.
100
+ * @param query - Configure the fields to retrieve in the exchange.
101
+ * @param headers - Headers to pass in the request.
102
+ * @returns The exchange's details.
103
+ *
104
+ * @example
105
+ * sdk.admin.exchange.create({
106
+ * order_id: "order_123"
107
+ * })
108
+ * .then(({ exchange }) => {
109
+ * console.log(exchange)
110
+ * })
111
+ */
15
112
  create(body: HttpTypes.AdminCreateExchange, query?: HttpTypes.SelectParams, headers?: ClientHeaders): Promise<HttpTypes.AdminExchangeResponse>;
113
+ /**
114
+ * This method cancels an exchange. It sends a request to the
115
+ * [Cancel Exchange](https://docs.medusajs.com/v2/api/admin#exchanges_postexchangesidcancel) API route.
116
+ *
117
+ * @param id - The exchange's ID.
118
+ * @param query - Configure the fields to retrieve in the exchange.
119
+ * @param headers - Headers to pass in the request.
120
+ * @returns The exchange's details.
121
+ *
122
+ * @example
123
+ * sdk.admin.exchange.cancel("exchange_123")
124
+ * .then(({ exchange }) => {
125
+ * console.log(exchange)
126
+ * })
127
+ */
16
128
  cancel(id: string, query?: HttpTypes.SelectParams, headers?: ClientHeaders): Promise<HttpTypes.AdminExchangeResponse>;
17
- addInboundItems(id: string, body: HttpTypes.AdminAddExchangeInboundItems, query?: HttpTypes.SelectParams, headers?: ClientHeaders): Promise<HttpTypes.AdminExchangeResponse>;
18
- updateInboundItem(id: string, actionId: string, body: HttpTypes.AdminUpdateExchangeInboundItem, query?: HttpTypes.SelectParams, headers?: ClientHeaders): Promise<HttpTypes.AdminExchangeResponse>;
19
- removeInboundItem(id: string, actionId: string, query?: HttpTypes.SelectParams, headers?: ClientHeaders): Promise<HttpTypes.AdminExchangeResponse>;
20
- addInboundShipping(id: string, body: HttpTypes.AdminExchangeAddInboundShipping, query?: HttpTypes.SelectParams, headers?: ClientHeaders): Promise<HttpTypes.AdminExchangeResponse>;
21
- updateInboundShipping(id: string, actionId: string, body: HttpTypes.AdminExchangeUpdateInboundShipping, query?: HttpTypes.SelectParams, headers?: ClientHeaders): Promise<HttpTypes.AdminExchangeResponse>;
22
- deleteInboundShipping(id: string, actionId: string, query?: HttpTypes.SelectParams, headers?: ClientHeaders): Promise<HttpTypes.AdminExchangeResponse>;
23
- addOutboundItems(id: string, body: HttpTypes.AdminAddExchangeOutboundItems, query?: HttpTypes.SelectParams, headers?: ClientHeaders): Promise<HttpTypes.AdminExchangeResponse>;
24
- updateOutboundItem(id: string, actionId: string, body: HttpTypes.AdminUpdateExchangeOutboundItem, query?: HttpTypes.SelectParams, headers?: ClientHeaders): Promise<HttpTypes.AdminExchangeResponse>;
25
- removeOutboundItem(id: string, actionId: string, query?: HttpTypes.SelectParams, headers?: ClientHeaders): Promise<HttpTypes.AdminExchangeResponse>;
26
- addOutboundShipping(id: string, body: HttpTypes.AdminExchangeAddOutboundShipping, query?: HttpTypes.SelectParams, headers?: ClientHeaders): Promise<HttpTypes.AdminExchangeResponse>;
27
- updateOutboundShipping(id: string, actionId: string, body: HttpTypes.AdminExchangeUpdateOutboundShipping, query?: HttpTypes.SelectParams, headers?: ClientHeaders): Promise<HttpTypes.AdminExchangeResponse>;
28
- deleteOutboundShipping(id: string, actionId: string, query?: HttpTypes.SelectParams, headers?: ClientHeaders): Promise<HttpTypes.AdminExchangeResponse>;
29
- request(id: string, body: HttpTypes.AdminRequestExchange, query?: HttpTypes.SelectParams, headers?: ClientHeaders): Promise<HttpTypes.AdminExchangeResponse>;
30
- cancelRequest(id: string, query?: HttpTypes.SelectParams, headers?: ClientHeaders): Promise<HttpTypes.AdminExchangeResponse>;
129
+ /**
130
+ * This method adds inbound (or return) items to an exchange. These inbound items will
131
+ * have the action `RETURN_ITEM`.
132
+ *
133
+ * This method sends a request to the [Add Inbound Items](https://docs.medusajs.com/v2/api/admin#exchanges_postexchangesidinbounditems)
134
+ * API route.
135
+ *
136
+ * @param id - The exchange's ID.
137
+ * @param body - The items to add.
138
+ * @param query - Configure the fields to retrieve in the return.
139
+ * @param headers - Headers to pass in the request.
140
+ * @returns The details of the return associated with the exchange, with a preview of the order when the exchange is applied.
141
+ *
142
+ * @example
143
+ * sdk.admin.exchange.addInboundItems("exchange_123", {
144
+ * items: [{
145
+ * id: "orli_123",
146
+ * quantity: 1
147
+ * }]
148
+ * })
149
+ * .then(({ return: returnData }) => {
150
+ * console.log(returnData)
151
+ * })
152
+ */
153
+ addInboundItems(id: string, body: HttpTypes.AdminAddExchangeInboundItems, query?: HttpTypes.SelectParams, headers?: ClientHeaders): Promise<HttpTypes.AdminExchangeReturnResponse>;
154
+ /**
155
+ * This method updates an inbound (or return) item from an exchange using the ID of
156
+ * the item's `RETURN_ITEM` action.
157
+ *
158
+ * Every item has an `actions` property, whose value is an array of actions. You can
159
+ * check the action's name using its `action` property, and use the value of the `id` property.
160
+ *
161
+ * This method sends a request to the [Update Inbound Item](https://docs.medusajs.com/v2/api/admin#exchanges_postexchangesidinbounditemsaction_id)
162
+ * API route.
163
+ *
164
+ * @param id - The exchange's ID.
165
+ * @param actionId - The id of the return item's `RETURN_ITEM` action.
166
+ * @param body - The details to update.
167
+ * @param query - Configure the fields to retrieve in the return.
168
+ * @param headers - Headers to pass in the request.
169
+ * @returns The details of the return associated with the exchange, with a preview of the order when the exchange is applied.
170
+ *
171
+ * @example
172
+ * sdk.admin.exchange.updateInboundItem(
173
+ * "exchange_123",
174
+ * "ordchact_123",
175
+ * {
176
+ * quantity: 1
177
+ * }
178
+ * )
179
+ * .then(({ return: returnData }) => {
180
+ * console.log(returnData)
181
+ * })
182
+ */
183
+ updateInboundItem(id: string, actionId: string, body: HttpTypes.AdminUpdateExchangeInboundItem, query?: HttpTypes.SelectParams, headers?: ClientHeaders): Promise<HttpTypes.AdminExchangeReturnResponse>;
184
+ /**
185
+ * This method removes an inbound (or return) item from an exchange using the ID of the
186
+ * item's `RETURN_ITEM` action.
187
+ *
188
+ * Every item has an `actions` property, whose value is an array of actions.
189
+ * You can check the action's name using its `action` property, and use the value of the `id` property.
190
+ *
191
+ * This method sends a request to the [Remove Inbound Item](https://docs.medusajs.com/v2/api/admin#exchanges_deleteexchangesidinbounditemsaction_id)
192
+ * API route.
193
+ *
194
+ * @param id - The exchange's ID.
195
+ * @param actionId - The id of the return item's `RETURN_ITEM` action.
196
+ * @param query - Configure the fields to retrieve in the return.
197
+ * @param headers - Headers to pass in the request.
198
+ * @returns The details of the return associated with the exchange, with a preview of the order when the exchange is applied.
199
+ *
200
+ * @example
201
+ * sdk.admin.exchange.removeInboundItem(
202
+ * "exchange_123",
203
+ * "ordchact_123",
204
+ * )
205
+ * .then(({ return: returnData }) => {
206
+ * console.log(returnData)
207
+ * })
208
+ */
209
+ removeInboundItem(id: string, actionId: string, query?: HttpTypes.SelectParams, headers?: ClientHeaders): Promise<HttpTypes.AdminExchangeReturnResponse>;
210
+ /**
211
+ * This method adds an inbound (or return) shipping method to an exchange.
212
+ * The inbound shipping method will have a `SHIPPING_ADD` action.
213
+ *
214
+ * This method sends a request to the [Add Inbound Shipping](https://docs.medusajs.com/v2/api/admin#exchanges_postexchangesidinboundshippingmethod)
215
+ * API route.
216
+ *
217
+ * This method sends a request to the [Add Inbound Shipping](https://docs.medusajs.com/v2/api/admin#exchanges_postexchangesidinboundshippingmethod)
218
+ * API route.
219
+ *
220
+ * @param id - The exchange's ID.
221
+ * @param body - The shipping method's details.
222
+ * @param query - Configure the fields to retrieve in the return.
223
+ * @param headers - Headers to pass in the request.
224
+ * @returns The details of the return associated with the exchange, with a preview of the order when the exchange is applied.
225
+ *
226
+ * @example
227
+ * sdk.admin.exchange.addInboundShipping("exchange_123", {
228
+ * shipping_option_id: "so_123"
229
+ * })
230
+ * .then(({ return: returnData }) => {
231
+ * console.log(returnData)
232
+ * })
233
+ */
234
+ addInboundShipping(id: string, body: HttpTypes.AdminExchangeAddInboundShipping, query?: HttpTypes.SelectParams, headers?: ClientHeaders): Promise<HttpTypes.AdminExchangeReturnResponse>;
235
+ /**
236
+ * This method updates the shipping method for returning items in the exchange using the ID
237
+ * of the method's `SHIPPING_ADD` action.
238
+ *
239
+ * Every shipping method has an `actions` property, whose value is an array of actions.
240
+ * You can check the action's name using its `action` property, and use the value of the `id` property.
241
+ *
242
+ * This method sends a request to the [Update Inbound Shipping](https://docs.medusajs.com/v2/api/admin#exchanges_postexchangesidinboundshippingmethodaction_id)
243
+ * API route.
244
+ *
245
+ * @param id - The exchange's ID.
246
+ * @param actionId - The id of the shipping method's `SHIPPING_ADD` action.
247
+ * @param body - The details to update.
248
+ * @param query - Configure the fields to retrieve in the return.
249
+ * @param headers - Headers to pass in the request.
250
+ * @returns The details of the return associated with the exchange, with a preview of the order when the exchange is applied.
251
+ *
252
+ * @example
253
+ * sdk.admin.exchange.updateInboundShipping(
254
+ * "exchange_123",
255
+ * "ordchact_123",
256
+ * {
257
+ * custom_amount: 10
258
+ * }
259
+ * )
260
+ * .then(({ return: returnData }) => {
261
+ * console.log(returnData)
262
+ * })
263
+ */
264
+ updateInboundShipping(id: string, actionId: string, body: HttpTypes.AdminExchangeUpdateInboundShipping, query?: HttpTypes.SelectParams, headers?: ClientHeaders): Promise<HttpTypes.AdminExchangeReturnResponse>;
265
+ /**
266
+ * This method removes the shipping method for returning items in the exchange using the ID
267
+ * of the method's `SHIPPING_ADD` action.
268
+ *
269
+ * Every shipping method has an `actions` property, whose value is an array of actions.
270
+ * You can check the action's name using its `action` property, and use the value of the `id` property.
271
+ *
272
+ * This method sends a request to the [Remove Inbound Shipping](https://docs.medusajs.com/v2/api/admin#exchanges_deleteexchangesidinboundshippingmethodaction_id)
273
+ * API route.
274
+ *
275
+ * @param id - The exchange's ID.
276
+ * @param actionId - The id of the shipping method's `SHIPPING_ADD` action.
277
+ * @param query - Configure the fields to retrieve in the return.
278
+ * @param headers - Headers to pass in the request.
279
+ * @returns The details of the return associated with the exchange, with a preview of the order when the exchange is applied.
280
+ *
281
+ * @example
282
+ * sdk.admin.exchange.deleteInboundShipping(
283
+ * "exchange_123",
284
+ * "ordchact_123",
285
+ * )
286
+ * .then(({ return: returnData }) => {
287
+ * console.log(returnData)
288
+ * })
289
+ */
290
+ deleteInboundShipping(id: string, actionId: string, query?: HttpTypes.SelectParams, headers?: ClientHeaders): Promise<HttpTypes.AdminExchangeReturnResponse>;
291
+ /**
292
+ * This method adds outbound (or new) items to an exchange.
293
+ * These outbound items will have the action `ITEM_ADD`.
294
+ *
295
+ * This method sends a request to the [Add Outbound Items](https://docs.medusajs.com/v2/api/admin#exchanges_postexchangesidoutbounditems)
296
+ * API route.
297
+ *
298
+ * @param id - The exchange's ID.
299
+ * @param body - The items to add.
300
+ * @param query - Configure the fields to retrieve in the exchange.
301
+ * @param headers - Headers to pass in the request
302
+ * @returns The exchange's details with a preview of the order when the exchange is applied.
303
+ *
304
+ * @example
305
+ * sdk.admin.exchange.addOutboundItems("exchange_123", {
306
+ * items: [{
307
+ * id: "variant_123",
308
+ * quantity: 1
309
+ * }]
310
+ * })
311
+ * .then(({ exchange }) => {
312
+ * console.log(exchange)
313
+ * })
314
+ */
315
+ addOutboundItems(id: string, body: HttpTypes.AdminAddExchangeOutboundItems, query?: HttpTypes.SelectParams, headers?: ClientHeaders): Promise<HttpTypes.AdminExchangePreviewResponse>;
316
+ /**
317
+ * This method updates an outbound (or new) item from an exchange using the ID
318
+ * of the item's `ITEM_ADD` action.
319
+ *
320
+ * Every item has an `actions` property, whose value is an array of actions.
321
+ * You can check the action's name using its `action` property, and use the value of the `id` property.
322
+ *
323
+ * This method sends a request to the [Update Inbound Item](https://docs.medusajs.com/v2/api/admin#exchanges_postexchangesidoutbounditemsaction_id)
324
+ * API route.
325
+ *
326
+ * @param id - The exchange's ID.
327
+ * @param actionId - The id of the new exchange item's `ITEM_ADD` action.
328
+ * @param body - The item's details to update.
329
+ * @param query - Configure the fields to retrieve in the exchange.
330
+ * @param headers - Headers to pass in the request
331
+ * @returns The exchange's details with a preview of the order when the exchange is applied.
332
+ *
333
+ * @example
334
+ * sdk.admin.exchange.updateOutboundItem(
335
+ * "exchange_123",
336
+ * "ordchact_123",
337
+ * {
338
+ * quantity: 1
339
+ * }
340
+ * )
341
+ * .then(({ exchange }) => {
342
+ * console.log(exchange)
343
+ * })
344
+ */
345
+ updateOutboundItem(id: string, actionId: string, body: HttpTypes.AdminUpdateExchangeOutboundItem, query?: HttpTypes.SelectParams, headers?: ClientHeaders): Promise<HttpTypes.AdminExchangePreviewResponse>;
346
+ /**
347
+ * This method removes an outbound (or new) item from an exchange using the ID
348
+ * of the item's `ITEM_ADD` action.
349
+ *
350
+ * Every item has an `actions` property, whose value is an array of actions.
351
+ * You can check the action's name using its `action` property, and use the value of the `id` property.
352
+ *
353
+ * This method sends a request to the [Update Outbound Item](https://docs.medusajs.com/v2/api/admin#exchanges_deleteexchangesidoutbounditemsaction_id)
354
+ * API route.
355
+ *
356
+ * @param id - The exchange's ID.
357
+ * @param actionId - The id of the new exchange item's `ITEM_ADD` action.
358
+ * @param query - Configure the fields to retrieve in the exchange.
359
+ * @param headers - Headers to pass in the request
360
+ * @returns The exchange's details with a preview of the order when the exchange is applied.
361
+ *
362
+ * @example
363
+ * sdk.admin.exchange.removeOutboundItem(
364
+ * "exchange_123",
365
+ * "ordchact_123",
366
+ * )
367
+ * .then(({ exchange }) => {
368
+ * console.log(exchange)
369
+ * })
370
+ */
371
+ removeOutboundItem(id: string, actionId: string, query?: HttpTypes.SelectParams, headers?: ClientHeaders): Promise<HttpTypes.AdminExchangePreviewResponse>;
372
+ /**
373
+ * This method adds an outbound shipping method to an exchange. The outbound shipping method
374
+ * will have a `SHIPPING_ADD` action.
375
+ *
376
+ * This method sends a request to the [Add Outbound Shipping](https://docs.medusajs.com/v2/api/admin#exchanges_postexchangesidoutboundshippingmethod)
377
+ * API route.
378
+ *
379
+ * @param id - The exchange's ID.
380
+ * @param body - The shipping method's details.
381
+ * @param query - Configure the fields to retrieve in the exchange.
382
+ * @param headers - Headers to pass in the request
383
+ * @returns The exchange's details with a preview of the order when the exchange is applied.
384
+ *
385
+ * @example
386
+ * sdk.admin.exchange.addOutboundShipping("exchange_123", {
387
+ * shipping_option_id: "so_123"
388
+ * })
389
+ * .then(({ exchange }) => {
390
+ * console.log(exchange)
391
+ * })
392
+ */
393
+ addOutboundShipping(id: string, body: HttpTypes.AdminExchangeAddOutboundShipping, query?: HttpTypes.SelectParams, headers?: ClientHeaders): Promise<HttpTypes.AdminExchangePreviewResponse>;
394
+ /**
395
+ * This method updates the shipping method for delivering outbound items in the exchange using
396
+ * the ID of the method's `SHIPPING_ADD` action.
397
+ *
398
+ * Every shipping method has an `actions` property, whose value is an array of actions.
399
+ * You can check the action's name using its `action` property, and use the value of the `id` property.
400
+ *
401
+ * This method sends a request to the [Update Outbound Shipping](https://docs.medusajs.com/v2/api/admin#exchanges_postexchangesidoutboundshippingmethodaction_id)
402
+ * API route.
403
+ *
404
+ * @param id - The exchange's ID.
405
+ * @param actionId - The id of the shipping method's `SHIPPING_ADD` action.
406
+ * @param body - The details to update.
407
+ * @param query - Configure the fields to retrieve in the exchange.
408
+ * @param headers - Headers to pass in the request
409
+ * @returns The exchange's details with a preview of the order when the exchange is applied.
410
+ *
411
+ * @example
412
+ * sdk.admin.exchange.updateOutboundShipping(
413
+ * "exchange_123",
414
+ * "ordchact_123",
415
+ * {
416
+ * custom_amount: 10
417
+ * }
418
+ * )
419
+ * .then(({ exchange }) => {
420
+ * console.log(exchange)
421
+ * })
422
+ */
423
+ updateOutboundShipping(id: string, actionId: string, body: HttpTypes.AdminExchangeUpdateOutboundShipping, query?: HttpTypes.SelectParams, headers?: ClientHeaders): Promise<HttpTypes.AdminExchangePreviewResponse>;
424
+ /**
425
+ * This method removes the shipping method for delivering outbound items in the exchange using
426
+ * the ID of the method's `SHIPPING_ADD` action.
427
+ *
428
+ * Every shipping method has an `actions` property, whose value is an array of actions.
429
+ * You can check the action's name using its `action` property, and use the value of the `id` property.
430
+ *
431
+ * This method sends a request to the [Remove Outbound Shipping](https://docs.medusajs.com/v2/api/admin#exchanges_deleteexchangesidoutboundshippingmethodaction_id)
432
+ * API route.
433
+ *
434
+ * @param id - The exchange's ID.
435
+ * @param actionId - The id of the shipping method's `SHIPPING_ADD` action.
436
+ * @param query - Configure the fields to retrieve in the exchange.
437
+ * @param headers - Headers to pass in the request
438
+ * @returns The exchange's details with a preview of the order when the exchange is applied.
439
+ *
440
+ * @example
441
+ * sdk.admin.exchange.deleteOutboundShipping(
442
+ * "exchange_123",
443
+ * "ordchact_123",
444
+ * )
445
+ * .then(({ exchange }) => {
446
+ * console.log(exchange)
447
+ * })
448
+ */
449
+ deleteOutboundShipping(id: string, actionId: string, query?: HttpTypes.SelectParams, headers?: ClientHeaders): Promise<HttpTypes.AdminExchangePreviewResponse>;
450
+ /**
451
+ * This method confirms an exchange request, applying its changes on the associated order.
452
+ *
453
+ * This method sends a request to the [Confirm Exchange](https://docs.medusajs.com/v2/api/admin#exchanges_postexchangesidrequest)
454
+ * API route.
455
+ *
456
+ * @param id - The exchange's ID.
457
+ * @param body - The confirmation's details.
458
+ * @param query - Configure the fields to retrieve in the exchange.
459
+ * @param headers - Headers to pass in the request
460
+ * @returns The exchange and associated return's details with a preview of the order when the exchange is applied.
461
+ *
462
+ * @example
463
+ * sdk.admin.exchange.request("exchange_123", {})
464
+ * .then(({ exchange }) => {
465
+ * console.log(exchange)
466
+ * })
467
+ */
468
+ request(id: string, body: HttpTypes.AdminRequestExchange, query?: HttpTypes.SelectParams, headers?: ClientHeaders): Promise<HttpTypes.AdminExchangeRequestResponse>;
469
+ /**
470
+ * This method cancels an exchange request. It sends a request to the
471
+ * [Cancel Exchange Request](https://docs.medusajs.com/v2/api/admin#exchanges_deleteexchangesidrequest)
472
+ * API route.
473
+ *
474
+ * @param id - The exchange's ID.
475
+ * @param query - Configure the fields to retrieve in the exchange.
476
+ * @param headers - Headers to pass in the request
477
+ * @returns The cancelation's details.
478
+ *
479
+ * @example
480
+ * sdk.admin.exchange.cancel("exchange_123")
481
+ * .then(({ deleted }) => {
482
+ * console.log(deleted)
483
+ * })
484
+ */
485
+ cancelRequest(id: string, query?: HttpTypes.SelectParams, headers?: ClientHeaders): Promise<HttpTypes.AdminExchangeDeleteResponse>;
31
486
  }
32
487
  //# sourceMappingURL=exchange.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"exchange.d.ts","sourceRoot":"","sources":["../../src/admin/exchange.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,QAAQ;IACnB;;OAEG;IACH,OAAO,CAAC,MAAM,CAAQ;IACtB;;OAEG;gBACS,MAAM,EAAE,MAAM;IAIpB,IAAI,CACR,KAAK,CAAC,EAAE,SAAS,CAAC,uBAAuB,EACzC,OAAO,CAAC,EAAE,aAAa;IAWnB,QAAQ,CACZ,EAAE,EAAE,MAAM,EACV,KAAK,CAAC,EAAE,SAAS,CAAC,mBAAmB,EACrC,OAAO,CAAC,EAAE,aAAa;IAWnB,MAAM,CACV,IAAI,EAAE,SAAS,CAAC,mBAAmB,EACnC,KAAK,CAAC,EAAE,SAAS,CAAC,YAAY,EAC9B,OAAO,CAAC,EAAE,aAAa;IAanB,MAAM,CACV,EAAE,EAAE,MAAM,EACV,KAAK,CAAC,EAAE,SAAS,CAAC,YAAY,EAC9B,OAAO,CAAC,EAAE,aAAa;IAYnB,eAAe,CACnB,EAAE,EAAE,MAAM,EACV,IAAI,EAAE,SAAS,CAAC,4BAA4B,EAC5C,KAAK,CAAC,EAAE,SAAS,CAAC,YAAY,EAC9B,OAAO,CAAC,EAAE,aAAa;IAanB,iBAAiB,CACrB,EAAE,EAAE,MAAM,EACV,QAAQ,EAAE,MAAM,EAChB,IAAI,EAAE,SAAS,CAAC,8BAA8B,EAC9C,KAAK,CAAC,EAAE,SAAS,CAAC,YAAY,EAC9B,OAAO,CAAC,EAAE,aAAa;IAanB,iBAAiB,CACrB,EAAE,EAAE,MAAM,EACV,QAAQ,EAAE,MAAM,EAChB,KAAK,CAAC,EAAE,SAAS,CAAC,YAAY,EAC9B,OAAO,CAAC,EAAE,aAAa;IAYnB,kBAAkB,CACtB,EAAE,EAAE,MAAM,EACV,IAAI,EAAE,SAAS,CAAC,+BAA+B,EAC/C,KAAK,CAAC,EAAE,SAAS,CAAC,YAAY,EAC9B,OAAO,CAAC,EAAE,aAAa;IAanB,qBAAqB,CACzB,EAAE,EAAE,MAAM,EACV,QAAQ,EAAE,MAAM,EAChB,IAAI,EAAE,SAAS,CAAC,kCAAkC,EAClD,KAAK,CAAC,EAAE,SAAS,CAAC,YAAY,EAC9B,OAAO,CAAC,EAAE,aAAa;IAanB,qBAAqB,CACzB,EAAE,EAAE,MAAM,EACV,QAAQ,EAAE,MAAM,EAChB,KAAK,CAAC,EAAE,SAAS,CAAC,YAAY,EAC9B,OAAO,CAAC,EAAE,aAAa;IAYnB,gBAAgB,CACpB,EAAE,EAAE,MAAM,EACV,IAAI,EAAE,SAAS,CAAC,6BAA6B,EAC7C,KAAK,CAAC,EAAE,SAAS,CAAC,YAAY,EAC9B,OAAO,CAAC,EAAE,aAAa;IAanB,kBAAkB,CACtB,EAAE,EAAE,MAAM,EACV,QAAQ,EAAE,MAAM,EAChB,IAAI,EAAE,SAAS,CAAC,+BAA+B,EAC/C,KAAK,CAAC,EAAE,SAAS,CAAC,YAAY,EAC9B,OAAO,CAAC,EAAE,aAAa;IAanB,kBAAkB,CACtB,EAAE,EAAE,MAAM,EACV,QAAQ,EAAE,MAAM,EAChB,KAAK,CAAC,EAAE,SAAS,CAAC,YAAY,EAC9B,OAAO,CAAC,EAAE,aAAa;IAYnB,mBAAmB,CACvB,EAAE,EAAE,MAAM,EACV,IAAI,EAAE,SAAS,CAAC,gCAAgC,EAChD,KAAK,CAAC,EAAE,SAAS,CAAC,YAAY,EAC9B,OAAO,CAAC,EAAE,aAAa;IAanB,sBAAsB,CAC1B,EAAE,EAAE,MAAM,EACV,QAAQ,EAAE,MAAM,EAChB,IAAI,EAAE,SAAS,CAAC,mCAAmC,EACnD,KAAK,CAAC,EAAE,SAAS,CAAC,YAAY,EAC9B,OAAO,CAAC,EAAE,aAAa;IAanB,sBAAsB,CAC1B,EAAE,EAAE,MAAM,EACV,QAAQ,EAAE,MAAM,EAChB,KAAK,CAAC,EAAE,SAAS,CAAC,YAAY,EAC9B,OAAO,CAAC,EAAE,aAAa;IAYnB,OAAO,CACX,EAAE,EAAE,MAAM,EACV,IAAI,EAAE,SAAS,CAAC,oBAAoB,EACpC,KAAK,CAAC,EAAE,SAAS,CAAC,YAAY,EAC9B,OAAO,CAAC,EAAE,aAAa;IAanB,aAAa,CACjB,EAAE,EAAE,MAAM,EACV,KAAK,CAAC,EAAE,SAAS,CAAC,YAAY,EAC9B,OAAO,CAAC,EAAE,aAAa;CAW1B"}
1
+ {"version":3,"file":"exchange.d.ts","sourceRoot":"","sources":["../../src/admin/exchange.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,YAAY,EAAE,MAAM,iBAAiB,CAAA;AAEzD,OAAO,EAAE,MAAM,EAAE,MAAM,WAAW,CAAA;AAClC,OAAO,EAAE,aAAa,EAAE,MAAM,UAAU,CAAA;AAExC,qBAAa,QAAQ;IACnB;;OAEG;IACH,OAAO,CAAC,MAAM,CAAQ;IACtB;;OAEG;gBACS,MAAM,EAAE,MAAM;IAI1B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA8CG;IACG,IAAI,CACR,KAAK,CAAC,EAAE,SAAS,CAAC,uBAAuB,EACzC,OAAO,CAAC,EAAE,aAAa;IAWzB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAgCG;IACG,QAAQ,CACZ,EAAE,EAAE,MAAM,EACV,KAAK,CAAC,EAAE,YAAY,EACpB,OAAO,CAAC,EAAE,aAAa;IAWzB;;;;;;;;;;;;;;;;OAgBG;IACG,MAAM,CACV,IAAI,EAAE,SAAS,CAAC,mBAAmB,EACnC,KAAK,CAAC,EAAE,SAAS,CAAC,YAAY,EAC9B,OAAO,CAAC,EAAE,aAAa;IAazB;;;;;;;;;;;;;;OAcG;IACG,MAAM,CACV,EAAE,EAAE,MAAM,EACV,KAAK,CAAC,EAAE,SAAS,CAAC,YAAY,EAC9B,OAAO,CAAC,EAAE,aAAa;IAYzB;;;;;;;;;;;;;;;;;;;;;;;OAuBG;IACG,eAAe,CACnB,EAAE,EAAE,MAAM,EACV,IAAI,EAAE,SAAS,CAAC,4BAA4B,EAC5C,KAAK,CAAC,EAAE,SAAS,CAAC,YAAY,EAC9B,OAAO,CAAC,EAAE,aAAa;IAazB;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA4BG;IACG,iBAAiB,CACrB,EAAE,EAAE,MAAM,EACV,QAAQ,EAAE,MAAM,EAChB,IAAI,EAAE,SAAS,CAAC,8BAA8B,EAC9C,KAAK,CAAC,EAAE,SAAS,CAAC,YAAY,EAC9B,OAAO,CAAC,EAAE,aAAa;IAazB;;;;;;;;;;;;;;;;;;;;;;;;OAwBG;IACG,iBAAiB,CACrB,EAAE,EAAE,MAAM,EACV,QAAQ,EAAE,MAAM,EAChB,KAAK,CAAC,EAAE,SAAS,CAAC,YAAY,EAC9B,OAAO,CAAC,EAAE,aAAa;IAYzB;;;;;;;;;;;;;;;;;;;;;;;OAuBG;IACG,kBAAkB,CACtB,EAAE,EAAE,MAAM,EACV,IAAI,EAAE,SAAS,CAAC,+BAA+B,EAC/C,KAAK,CAAC,EAAE,SAAS,CAAC,YAAY,EAC9B,OAAO,CAAC,EAAE,aAAa;IAazB;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA4BG;IACG,qBAAqB,CACzB,EAAE,EAAE,MAAM,EACV,QAAQ,EAAE,MAAM,EAChB,IAAI,EAAE,SAAS,CAAC,kCAAkC,EAClD,KAAK,CAAC,EAAE,SAAS,CAAC,YAAY,EAC9B,OAAO,CAAC,EAAE,aAAa;IAazB;;;;;;;;;;;;;;;;;;;;;;;;OAwBG;IACG,qBAAqB,CACzB,EAAE,EAAE,MAAM,EACV,QAAQ,EAAE,MAAM,EAChB,KAAK,CAAC,EAAE,SAAS,CAAC,YAAY,EAC9B,OAAO,CAAC,EAAE,aAAa;IAYzB;;;;;;;;;;;;;;;;;;;;;;;OAuBG;IACG,gBAAgB,CACpB,EAAE,EAAE,MAAM,EACV,IAAI,EAAE,SAAS,CAAC,6BAA6B,EAC7C,KAAK,CAAC,EAAE,SAAS,CAAC,YAAY,EAC9B,OAAO,CAAC,EAAE,aAAa;IAazB;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA4BG;IACG,kBAAkB,CACtB,EAAE,EAAE,MAAM,EACV,QAAQ,EAAE,MAAM,EAChB,IAAI,EAAE,SAAS,CAAC,+BAA+B,EAC/C,KAAK,CAAC,EAAE,SAAS,CAAC,YAAY,EAC9B,OAAO,CAAC,EAAE,aAAa;IAazB;;;;;;;;;;;;;;;;;;;;;;;;OAwBG;IACG,kBAAkB,CACtB,EAAE,EAAE,MAAM,EACV,QAAQ,EAAE,MAAM,EAChB,KAAK,CAAC,EAAE,SAAS,CAAC,YAAY,EAC9B,OAAO,CAAC,EAAE,aAAa;IAYzB;;;;;;;;;;;;;;;;;;;;OAoBG;IACG,mBAAmB,CACvB,EAAE,EAAE,MAAM,EACV,IAAI,EAAE,SAAS,CAAC,gCAAgC,EAChD,KAAK,CAAC,EAAE,SAAS,CAAC,YAAY,EAC9B,OAAO,CAAC,EAAE,aAAa;IAazB;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA4BG;IACG,sBAAsB,CAC1B,EAAE,EAAE,MAAM,EACV,QAAQ,EAAE,MAAM,EAChB,IAAI,EAAE,SAAS,CAAC,mCAAmC,EACnD,KAAK,CAAC,EAAE,SAAS,CAAC,YAAY,EAC9B,OAAO,CAAC,EAAE,aAAa;IAazB;;;;;;;;;;;;;;;;;;;;;;;;OAwBG;IACG,sBAAsB,CAC1B,EAAE,EAAE,MAAM,EACV,QAAQ,EAAE,MAAM,EAChB,KAAK,CAAC,EAAE,SAAS,CAAC,YAAY,EAC9B,OAAO,CAAC,EAAE,aAAa;IAYzB;;;;;;;;;;;;;;;;;OAiBG;IACG,OAAO,CACX,EAAE,EAAE,MAAM,EACV,IAAI,EAAE,SAAS,CAAC,oBAAoB,EACpC,KAAK,CAAC,EAAE,SAAS,CAAC,YAAY,EAC9B,OAAO,CAAC,EAAE,aAAa;IAazB;;;;;;;;;;;;;;;OAeG;IACG,aAAa,CACjB,EAAE,EAAE,MAAM,EACV,KAAK,CAAC,EAAE,SAAS,CAAC,YAAY,EAC9B,OAAO,CAAC,EAAE,aAAa;CAW1B"}