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

package/dist/esm/admin/exchange.js

@@ -14,6 +14,53 @@ export class Exchange {
     constructor(client) {
         this.client = client;
     }
+    /**
+     * This method retrieves a paginated list of exchanges. It sends a request to the
+     * [List Exchanges](https://docs.medusajs.com/v2/api/admin#exchanges_getexchanges)
+     * API route.
+     *
+     * @param query - Filters and pagination configurations.
+     * @param headers - Headers to pass in the request.
+     * @returns The paginated list of exchanges.
+     *
+     * @example
+     * To retrieve the list of exchanges:
+     *
+     * ```ts
+     * sdk.admin.exchange.list()
+     * .then(({ exchanges, count, limit, offset }) => {
+     *   console.log(exchanges)
+     * })
+     * ```
+     *
+     * To configure the pagination, pass the `limit` and `offset` query parameters.
+     *
+     * For example, to retrieve only 10 items and skip 10 items:
+     *
+     * ```ts
+     * sdk.admin.exchange.list({
+     *   limit: 10,
+     *   offset: 10
+     * })
+     * .then(({ exchanges, count, limit, offset }) => {
+     *   console.log(exchanges)
+     * })
+     * ```
+     *
+     * Using the `fields` query parameter, you can specify the fields and relations to retrieve
+     * in each exchange:
+     *
+     * ```ts
+     * sdk.admin.exchange.list({
+     *   fields: "id,*order"
+     * })
+     * .then(({ exchanges, count, limit, offset }) => {
+     *   console.log(exchanges)
+     * })
+     * ```
+     *
+     * Learn more about the `fields` property in the [API reference](https://docs.medusajs.com/v2/api/store#select-fields-and-relations).
+     */
     list(query, headers) {
         return __awaiter(this, void 0, void 0, function* () {
             return yield this.client.fetch(`/admin/exchanges`, {
@@ -22,6 +69,39 @@ export class Exchange {
             });
         });
     }
+    /**
+     * This method retrieves an exchange by its ID. It sends a request to the
+     * [Get Exchange](https://docs.medusajs.com/v2/api/admin#exchanges_getexchangesid)
+     * API route.
+     *
+     * @param id - The exchange's ID.
+     * @param query - Configure the fields to retrieve in the exchange.
+     * @param headers - Headers to pass in the request.
+     * @returns The exchange's details.
+     *
+     * @example
+     * To retrieve an exchange by its ID:
+     *
+     * ```ts
+     * sdk.admin.exchange.retrieve("exchange_123")
+     * .then(({ exchange }) => {
+     *   console.log(exchange)
+     * })
+     * ```
+     *
+     * To specify the fields and relations to retrieve:
+     *
+     * ```ts
+     * sdk.admin.exchange.retrieve("exchange_123", {
+     *   fields: "id,*order"
+     * })
+     * .then(({ exchange }) => {
+     *   console.log(exchange)
+     * })
+     * ```
+     *
+     * Learn more about the `fields` property in the [API reference](https://docs.medusajs.com/v2/api/store#select-fields-and-relations).
+     */
     retrieve(id, query, headers) {
         return __awaiter(this, void 0, void 0, function* () {
             return yield this.client.fetch(`/admin/exchanges/${id}`, {
@@ -30,6 +110,23 @@ export class Exchange {
             });
         });
     }
+    /**
+     * This method creates an admin exchange. It sends a request to the
+     * [Create Exchange](https://docs.medusajs.com/v2/api/admin#exchanges_postexchanges) API route.
+     *
+     * @param body - The exchange's details.
+     * @param query - Configure the fields to retrieve in the exchange.
+     * @param headers - Headers to pass in the request.
+     * @returns The exchange's details.
+     *
+     * @example
+     * sdk.admin.exchange.create({
+     *   order_id: "order_123"
+     * })
+     * .then(({ exchange }) => {
+     *   console.log(exchange)
+     * })
+     */
     create(body, query, headers) {
         return __awaiter(this, void 0, void 0, function* () {
             return yield this.client.fetch(`/admin/exchanges`, {
@@ -40,6 +137,21 @@ export class Exchange {
             });
         });
     }
+    /**
+     * This method cancels an exchange. It sends a request to the
+     * [Cancel Exchange](https://docs.medusajs.com/v2/api/admin#exchanges_postexchangesidcancel) API route.
+     *
+     * @param id - The exchange's ID.
+     * @param query - Configure the fields to retrieve in the exchange.
+     * @param headers - Headers to pass in the request.
+     * @returns The exchange's details.
+     *
+     * @example
+     * sdk.admin.exchange.cancel("exchange_123")
+     * .then(({ exchange }) => {
+     *   console.log(exchange)
+     * })
+     */
     cancel(id, query, headers) {
         return __awaiter(this, void 0, void 0, function* () {
             return yield this.client.fetch(`/admin/exchanges/${id}/cancel`, {
@@ -49,6 +161,30 @@ export class Exchange {
             });
         });
     }
+    /**
+     * This method adds inbound (or return) items to an exchange. These inbound items will
+     * have the action `RETURN_ITEM`.
+     *
+     * This method sends a request to the [Add Inbound Items](https://docs.medusajs.com/v2/api/admin#exchanges_postexchangesidinbounditems)
+     * API route.
+     *
+     * @param id - The exchange's ID.
+     * @param body - The items to add.
+     * @param query - Configure the fields to retrieve in the return.
+     * @param headers - Headers to pass in the request.
+     * @returns The details of the return associated with the exchange, with a preview of the order when the exchange is applied.
+     *
+     * @example
+     * sdk.admin.exchange.addInboundItems("exchange_123", {
+     *   items: [{
+     *     id: "orli_123",
+     *     quantity: 1
+     *   }]
+     * })
+     * .then(({ return: returnData }) => {
+     *   console.log(returnData)
+     * })
+     */
     addInboundItems(id, body, query, headers) {
         return __awaiter(this, void 0, void 0, function* () {
             return yield this.client.fetch(`/admin/exchanges/${id}/inbound/items`, {
@@ -59,6 +195,35 @@ export class Exchange {
             });
         });
     }
+    /**
+     * This method updates an inbound (or return) item from an exchange using the ID of
+     * the item's `RETURN_ITEM` action.
+     *
+     * Every item has an `actions` property, whose value is an array of actions. You can
+     * check the action's name using its `action` property, and use the value of the `id` property.
+     *
+     * This method sends a request to the [Update Inbound Item](https://docs.medusajs.com/v2/api/admin#exchanges_postexchangesidinbounditemsaction_id)
+     * API route.
+     *
+     * @param id - The exchange's ID.
+     * @param actionId - The id of the return item's `RETURN_ITEM` action.
+     * @param body - The details to update.
+     * @param query - Configure the fields to retrieve in the return.
+     * @param headers - Headers to pass in the request.
+     * @returns The details of the return associated with the exchange, with a preview of the order when the exchange is applied.
+     *
+     * @example
+     * sdk.admin.exchange.updateInboundItem(
+     *   "exchange_123",
+     *   "ordchact_123",
+     *   {
+     *     quantity: 1
+     *   }
+     * )
+     * .then(({ return: returnData }) => {
+     *   console.log(returnData)
+     * })
+     */
     updateInboundItem(id, actionId, body, query, headers) {
         return __awaiter(this, void 0, void 0, function* () {
             return yield this.client.fetch(`/admin/exchanges/${id}/inbound/items/${actionId}`, {
@@ -69,6 +234,31 @@ export class Exchange {
             });
         });
     }
+    /**
+     * This method removes an inbound (or return) item from an exchange using the ID of the
+     * item's `RETURN_ITEM` action.
+     *
+     * Every item has an `actions` property, whose value is an array of actions.
+     * You can check the action's name using its `action` property, and use the value of the `id` property.
+     *
+     * This method sends a request to the [Remove Inbound Item](https://docs.medusajs.com/v2/api/admin#exchanges_deleteexchangesidinbounditemsaction_id)
+     * API route.
+     *
+     * @param id - The exchange's ID.
+     * @param actionId - The id of the return item's `RETURN_ITEM` action.
+     * @param query - Configure the fields to retrieve in the return.
+     * @param headers - Headers to pass in the request.
+     * @returns The details of the return associated with the exchange, with a preview of the order when the exchange is applied.
+     *
+     * @example
+     * sdk.admin.exchange.removeInboundItem(
+     *   "exchange_123",
+     *   "ordchact_123",
+     * )
+     * .then(({ return: returnData }) => {
+     *   console.log(returnData)
+     * })
+     */
     removeInboundItem(id, actionId, query, headers) {
         return __awaiter(this, void 0, void 0, function* () {
             return yield this.client.fetch(`/admin/exchanges/${id}/inbound/items/${actionId}`, {
@@ -78,6 +268,30 @@ export class Exchange {
             });
         });
     }
+    /**
+     * This method adds an inbound (or return) shipping method to an exchange.
+     * The inbound shipping method will have a `SHIPPING_ADD` action.
+     *
+     * This method sends a request to the [Add Inbound Shipping](https://docs.medusajs.com/v2/api/admin#exchanges_postexchangesidinboundshippingmethod)
+     * API route.
+     *
+     * This method sends a request to the [Add Inbound Shipping](https://docs.medusajs.com/v2/api/admin#exchanges_postexchangesidinboundshippingmethod)
+     * API route.
+     *
+     * @param id - The exchange's ID.
+     * @param body - The shipping method's details.
+     * @param query - Configure the fields to retrieve in the return.
+     * @param headers - Headers to pass in the request.
+     * @returns The details of the return associated with the exchange, with a preview of the order when the exchange is applied.
+     *
+     * @example
+     * sdk.admin.exchange.addInboundShipping("exchange_123", {
+     *   shipping_option_id: "so_123"
+     * })
+     * .then(({ return: returnData }) => {
+     *   console.log(returnData)
+     * })
+     */
     addInboundShipping(id, body, query, headers) {
         return __awaiter(this, void 0, void 0, function* () {
             return yield this.client.fetch(`/admin/exchanges/${id}/inbound/shipping-method`, {
@@ -88,6 +302,35 @@ export class Exchange {
             });
         });
     }
+    /**
+     * This method updates the shipping method for returning items in the exchange using the ID
+     * of the method's `SHIPPING_ADD` action.
+     *
+     * Every shipping method has an `actions` property, whose value is an array of actions.
+     * You can check the action's name using its `action` property, and use the value of the `id` property.
+     *
+     * This method sends a request to the [Update Inbound Shipping](https://docs.medusajs.com/v2/api/admin#exchanges_postexchangesidinboundshippingmethodaction_id)
+     * API route.
+     *
+     * @param id - The exchange's ID.
+     * @param actionId - The id of the shipping method's `SHIPPING_ADD` action.
+     * @param body - The details to update.
+     * @param query - Configure the fields to retrieve in the return.
+     * @param headers - Headers to pass in the request.
+     * @returns The details of the return associated with the exchange, with a preview of the order when the exchange is applied.
+     *
+     * @example
+     * sdk.admin.exchange.updateInboundShipping(
+     *   "exchange_123",
+     *   "ordchact_123",
+     *    {
+     *     custom_amount: 10
+     *   }
+     * )
+     * .then(({ return: returnData }) => {
+     *   console.log(returnData)
+     * })
+     */
     updateInboundShipping(id, actionId, body, query, headers) {
         return __awaiter(this, void 0, void 0, function* () {
             return yield this.client.fetch(`/admin/exchanges/${id}/inbound/shipping-method/${actionId}`, {
@@ -98,6 +341,31 @@ export class Exchange {
             });
         });
     }
+    /**
+     * This method removes the shipping method for returning items in the exchange using the ID
+     * of the method's `SHIPPING_ADD` action.
+     *
+     * Every shipping method has an `actions` property, whose value is an array of actions.
+     * You can check the action's name using its `action` property, and use the value of the `id` property.
+     *
+     * This method sends a request to the [Remove Inbound Shipping](https://docs.medusajs.com/v2/api/admin#exchanges_deleteexchangesidinboundshippingmethodaction_id)
+     * API route.
+     *
+     * @param id - The exchange's ID.
+     * @param actionId - The id of the shipping method's `SHIPPING_ADD` action.
+     * @param query - Configure the fields to retrieve in the return.
+     * @param headers - Headers to pass in the request.
+     * @returns The details of the return associated with the exchange, with a preview of the order when the exchange is applied.
+     *
+     * @example
+     * sdk.admin.exchange.deleteInboundShipping(
+     *   "exchange_123",
+     *   "ordchact_123",
+     * )
+     * .then(({ return: returnData }) => {
+     *   console.log(returnData)
+     * })
+     */
     deleteInboundShipping(id, actionId, query, headers) {
         return __awaiter(this, void 0, void 0, function* () {
             return yield this.client.fetch(`/admin/exchanges/${id}/inbound/shipping-method/${actionId}`, {
@@ -107,6 +375,30 @@ export class Exchange {
             });
         });
     }
+    /**
+     * This method adds outbound (or new) items to an exchange.
+     * These outbound items will have the action `ITEM_ADD`.
+     *
+     * This method sends a request to the [Add Outbound Items](https://docs.medusajs.com/v2/api/admin#exchanges_postexchangesidoutbounditems)
+     * API route.
+     *
+     * @param id - The exchange's ID.
+     * @param body - The items to add.
+     * @param query - Configure the fields to retrieve in the exchange.
+     * @param headers - Headers to pass in the request
+     * @returns The exchange's details with a preview of the order when the exchange is applied.
+     *
+     * @example
+     * sdk.admin.exchange.addOutboundItems("exchange_123", {
+     *   items: [{
+     *     id: "variant_123",
+     *     quantity: 1
+     *   }]
+     * })
+     * .then(({ exchange }) => {
+     *   console.log(exchange)
+     * })
+     */
     addOutboundItems(id, body, query, headers) {
         return __awaiter(this, void 0, void 0, function* () {
             return yield this.client.fetch(`/admin/exchanges/${id}/outbound/items`, {
@@ -117,6 +409,35 @@ export class Exchange {
             });
         });
     }
+    /**
+     * This method updates an outbound (or new) item from an exchange using the ID
+     * of the item's `ITEM_ADD` action.
+     *
+     * Every item has an `actions` property, whose value is an array of actions.
+     * You can check the action's name using its `action` property, and use the value of the `id` property.
+     *
+     * This method sends a request to the [Update Inbound Item](https://docs.medusajs.com/v2/api/admin#exchanges_postexchangesidoutbounditemsaction_id)
+     * API route.
+     *
+     * @param id - The exchange's ID.
+     * @param actionId - The id of the new exchange item's `ITEM_ADD` action.
+     * @param body - The item's details to update.
+     * @param query - Configure the fields to retrieve in the exchange.
+     * @param headers - Headers to pass in the request
+     * @returns The exchange's details with a preview of the order when the exchange is applied.
+     *
+     * @example
+     * sdk.admin.exchange.updateOutboundItem(
+     *   "exchange_123",
+     *   "ordchact_123",
+     *   {
+     *     quantity: 1
+     *   }
+     * )
+     * .then(({ exchange }) => {
+     *   console.log(exchange)
+     * })
+     */
     updateOutboundItem(id, actionId, body, query, headers) {
         return __awaiter(this, void 0, void 0, function* () {
             return yield this.client.fetch(`/admin/exchanges/${id}/outbound/items/${actionId}`, {
@@ -127,6 +448,31 @@ export class Exchange {
             });
         });
     }
+    /**
+     * This method removes an outbound (or new) item from an exchange using the ID
+     * of the item's `ITEM_ADD` action.
+     *
+     * Every item has an `actions` property, whose value is an array of actions.
+     * You can check the action's name using its `action` property, and use the value of the `id` property.
+     *
+     * This method sends a request to the [Update Outbound Item](https://docs.medusajs.com/v2/api/admin#exchanges_deleteexchangesidoutbounditemsaction_id)
+     * API route.
+     *
+     * @param id - The exchange's ID.
+     * @param actionId - The id of the new exchange item's `ITEM_ADD` action.
+     * @param query - Configure the fields to retrieve in the exchange.
+     * @param headers - Headers to pass in the request
+     * @returns The exchange's details with a preview of the order when the exchange is applied.
+     *
+     * @example
+     * sdk.admin.exchange.removeOutboundItem(
+     *   "exchange_123",
+     *   "ordchact_123",
+     * )
+     * .then(({ exchange }) => {
+     *   console.log(exchange)
+     * })
+     */
     removeOutboundItem(id, actionId, query, headers) {
         return __awaiter(this, void 0, void 0, function* () {
             return yield this.client.fetch(`/admin/exchanges/${id}/outbound/items/${actionId}`, {
@@ -136,6 +482,27 @@ export class Exchange {
             });
         });
     }
+    /**
+     * This method adds an outbound shipping method to an exchange. The outbound shipping method
+     * will have a `SHIPPING_ADD` action.
+     *
+     * This method sends a request to the [Add Outbound Shipping](https://docs.medusajs.com/v2/api/admin#exchanges_postexchangesidoutboundshippingmethod)
+     * API route.
+     *
+     * @param id - The exchange's ID.
+     * @param body - The shipping method's details.
+     * @param query - Configure the fields to retrieve in the exchange.
+     * @param headers - Headers to pass in the request
+     * @returns The exchange's details with a preview of the order when the exchange is applied.
+     *
+     * @example
+     * sdk.admin.exchange.addOutboundShipping("exchange_123", {
+     *   shipping_option_id: "so_123"
+     * })
+     * .then(({ exchange }) => {
+     *   console.log(exchange)
+     * })
+     */
     addOutboundShipping(id, body, query, headers) {
         return __awaiter(this, void 0, void 0, function* () {
             return yield this.client.fetch(`/admin/exchanges/${id}/outbound/shipping-method`, {
@@ -146,6 +513,35 @@ export class Exchange {
             });
         });
     }
+    /**
+     * This method updates the shipping method for delivering outbound items in the exchange using
+     * the ID of the method's `SHIPPING_ADD` action.
+     *
+     * Every shipping method has an `actions` property, whose value is an array of actions.
+     * You can check the action's name using its `action` property, and use the value of the `id` property.
+     *
+     * This method sends a request to the [Update Outbound Shipping](https://docs.medusajs.com/v2/api/admin#exchanges_postexchangesidoutboundshippingmethodaction_id)
+     * API route.
+     *
+     * @param id - The exchange's ID.
+     * @param actionId - The id of the shipping method's `SHIPPING_ADD` action.
+     * @param body - The details to update.
+     * @param query - Configure the fields to retrieve in the exchange.
+     * @param headers - Headers to pass in the request
+     * @returns The exchange's details with a preview of the order when the exchange is applied.
+     *
+     * @example
+     * sdk.admin.exchange.updateOutboundShipping(
+     *   "exchange_123",
+     *   "ordchact_123",
+     *   {
+     *     custom_amount: 10
+     *   }
+     * )
+     * .then(({ exchange }) => {
+     *   console.log(exchange)
+     * })
+     */
     updateOutboundShipping(id, actionId, body, query, headers) {
         return __awaiter(this, void 0, void 0, function* () {
             return yield this.client.fetch(`/admin/exchanges/${id}/outbound/shipping-method/${actionId}`, {
@@ -156,6 +552,31 @@ export class Exchange {
             });
         });
     }
+    /**
+     * This method removes the shipping method for delivering outbound items in the exchange using
+     * the ID of the method's `SHIPPING_ADD` action.
+     *
+     * Every shipping method has an `actions` property, whose value is an array of actions.
+     * You can check the action's name using its `action` property, and use the value of the `id` property.
+     *
+     * This method sends a request to the [Remove Outbound Shipping](https://docs.medusajs.com/v2/api/admin#exchanges_deleteexchangesidoutboundshippingmethodaction_id)
+     * API route.
+     *
+     * @param id - The exchange's ID.
+     * @param actionId - The id of the shipping method's `SHIPPING_ADD` action.
+     * @param query - Configure the fields to retrieve in the exchange.
+     * @param headers - Headers to pass in the request
+     * @returns The exchange's details with a preview of the order when the exchange is applied.
+     *
+     * @example
+     * sdk.admin.exchange.deleteOutboundShipping(
+     *   "exchange_123",
+     *   "ordchact_123",
+     * )
+     * .then(({ exchange }) => {
+     *   console.log(exchange)
+     * })
+     */
     deleteOutboundShipping(id, actionId, query, headers) {
         return __awaiter(this, void 0, void 0, function* () {
             return yield this.client.fetch(`/admin/exchanges/${id}/outbound/shipping-method/${actionId}`, {
@@ -165,6 +586,24 @@ export class Exchange {
             });
         });
     }
+    /**
+     * This method confirms an exchange request, applying its changes on the associated order.
+     *
+     * This method sends a request to the [Confirm Exchange](https://docs.medusajs.com/v2/api/admin#exchanges_postexchangesidrequest)
+     * API route.
+     *
+     * @param id - The exchange's ID.
+     * @param body - The confirmation's details.
+     * @param query - Configure the fields to retrieve in the exchange.
+     * @param headers - Headers to pass in the request
+     * @returns The exchange and associated return's details with a preview of the order when the exchange is applied.
+     *
+     * @example
+     * sdk.admin.exchange.request("exchange_123", {})
+     * .then(({ exchange }) => {
+     *   console.log(exchange)
+     * })
+     */
     request(id, body, query, headers) {
         return __awaiter(this, void 0, void 0, function* () {
             return yield this.client.fetch(`/admin/exchanges/${id}/request`, {
@@ -175,6 +614,22 @@ export class Exchange {
             });
         });
     }
+    /**
+     * This method cancels an exchange request. It sends a request to the
+     * [Cancel Exchange Request](https://docs.medusajs.com/v2/api/admin#exchanges_deleteexchangesidrequest)
+     * API route.
+     *
+     * @param id - The exchange's ID.
+     * @param query - Configure the fields to retrieve in the exchange.
+     * @param headers - Headers to pass in the request
+     * @returns The cancelation's details.
+     *
+     * @example
+     * sdk.admin.exchange.cancel("exchange_123")
+     * .then(({ deleted }) => {
+     *   console.log(deleted)
+     * })
+     */
     cancelRequest(id, query, headers) {
         return __awaiter(this, void 0, void 0, function* () {
             return yield this.client.fetch(`/admin/exchanges/${id}/request`, {

package/dist/esm/admin/exchange.js.map

@@ -1 +1 @@
-{"version":3,"file":"exchange.js","sourceRoot":"","sources":["../../../src/admin/exchange.ts"],"names":[],"mappings":";;;;;;;;;AAKA,MAAM,OAAO,QAAQ;IAKnB;;OAEG;IACH,YAAY,MAAc;QACxB,IAAI,CAAC,MAAM,GAAG,MAAM,CAAA;IACtB,CAAC;IAEK,IAAI,CACR,KAAyC,EACzC,OAAuB;;YAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,kBAAkB,EAClB;gBACE,KAAK;gBACL,OAAO;aACR,CACF,CAAA;QACH,CAAC;KAAA;IAEK,QAAQ,CACZ,EAAU,EACV,KAAqC,EACrC,OAAuB;;YAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,oBAAoB,EAAE,EAAE,EACxB;gBACE,KAAK;gBACL,OAAO;aACR,CACF,CAAA;QACH,CAAC;KAAA;IAEK,MAAM,CACV,IAAmC,EACnC,KAA8B,EAC9B,OAAuB;;YAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,kBAAkB,EAClB;gBACE,MAAM,EAAE,MAAM;gBACd,OAAO;gBACP,IAAI;gBACJ,KAAK;aACN,CACF,CAAA;QACH,CAAC;KAAA;IAEK,MAAM,CACV,EAAU,EACV,KAA8B,EAC9B,OAAuB;;YAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,oBAAoB,EAAE,SAAS,EAC/B;gBACE,MAAM,EAAE,MAAM;gBACd,OAAO;gBACP,KAAK;aACN,CACF,CAAA;QACH,CAAC;KAAA;IAEK,eAAe,CACnB,EAAU,EACV,IAA4C,EAC5C,KAA8B,EAC9B,OAAuB;;YAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,oBAAoB,EAAE,gBAAgB,EACtC;gBACE,MAAM,EAAE,MAAM;gBACd,OAAO;gBACP,IAAI;gBACJ,KAAK;aACN,CACF,CAAA;QACH,CAAC;KAAA;IAEK,iBAAiB,CACrB,EAAU,EACV,QAAgB,EAChB,IAA8C,EAC9C,KAA8B,EAC9B,OAAuB;;YAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,oBAAoB,EAAE,kBAAkB,QAAQ,EAAE,EAClD;gBACE,MAAM,EAAE,MAAM;gBACd,OAAO;gBACP,IAAI;gBACJ,KAAK;aACN,CACF,CAAA;QACH,CAAC;KAAA;IAEK,iBAAiB,CACrB,EAAU,EACV,QAAgB,EAChB,KAA8B,EAC9B,OAAuB;;YAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,oBAAoB,EAAE,kBAAkB,QAAQ,EAAE,EAClD;gBACE,MAAM,EAAE,QAAQ;gBAChB,OAAO;gBACP,KAAK;aACN,CACF,CAAA;QACH,CAAC;KAAA;IAEK,kBAAkB,CACtB,EAAU,EACV,IAA+C,EAC/C,KAA8B,EAC9B,OAAuB;;YAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,oBAAoB,EAAE,0BAA0B,EAChD;gBACE,MAAM,EAAE,MAAM;gBACd,OAAO;gBACP,IAAI;gBACJ,KAAK;aACN,CACF,CAAA;QACH,CAAC;KAAA;IAEK,qBAAqB,CACzB,EAAU,EACV,QAAgB,EAChB,IAAkD,EAClD,KAA8B,EAC9B,OAAuB;;YAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,oBAAoB,EAAE,4BAA4B,QAAQ,EAAE,EAC5D;gBACE,MAAM,EAAE,MAAM;gBACd,OAAO;gBACP,IAAI;gBACJ,KAAK;aACN,CACF,CAAA;QACH,CAAC;KAAA;IAEK,qBAAqB,CACzB,EAAU,EACV,QAAgB,EAChB,KAA8B,EAC9B,OAAuB;;YAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,oBAAoB,EAAE,4BAA4B,QAAQ,EAAE,EAC5D;gBACE,MAAM,EAAE,QAAQ;gBAChB,OAAO;gBACP,KAAK;aACN,CACF,CAAA;QACH,CAAC;KAAA;IAEK,gBAAgB,CACpB,EAAU,EACV,IAA6C,EAC7C,KAA8B,EAC9B,OAAuB;;YAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,oBAAoB,EAAE,iBAAiB,EACvC;gBACE,MAAM,EAAE,MAAM;gBACd,OAAO;gBACP,IAAI;gBACJ,KAAK;aACN,CACF,CAAA;QACH,CAAC;KAAA;IAEK,kBAAkB,CACtB,EAAU,EACV,QAAgB,EAChB,IAA+C,EAC/C,KAA8B,EAC9B,OAAuB;;YAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,oBAAoB,EAAE,mBAAmB,QAAQ,EAAE,EACnD;gBACE,MAAM,EAAE,MAAM;gBACd,OAAO;gBACP,IAAI;gBACJ,KAAK;aACN,CACF,CAAA;QACH,CAAC;KAAA;IAEK,kBAAkB,CACtB,EAAU,EACV,QAAgB,EAChB,KAA8B,EAC9B,OAAuB;;YAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,oBAAoB,EAAE,mBAAmB,QAAQ,EAAE,EACnD;gBACE,MAAM,EAAE,QAAQ;gBAChB,OAAO;gBACP,KAAK;aACN,CACF,CAAA;QACH,CAAC;KAAA;IAEK,mBAAmB,CACvB,EAAU,EACV,IAAgD,EAChD,KAA8B,EAC9B,OAAuB;;YAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,oBAAoB,EAAE,2BAA2B,EACjD;gBACE,MAAM,EAAE,MAAM;gBACd,OAAO;gBACP,IAAI;gBACJ,KAAK;aACN,CACF,CAAA;QACH,CAAC;KAAA;IAEK,sBAAsB,CAC1B,EAAU,EACV,QAAgB,EAChB,IAAmD,EACnD,KAA8B,EAC9B,OAAuB;;YAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,oBAAoB,EAAE,6BAA6B,QAAQ,EAAE,EAC7D;gBACE,MAAM,EAAE,MAAM;gBACd,OAAO;gBACP,IAAI;gBACJ,KAAK;aACN,CACF,CAAA;QACH,CAAC;KAAA;IAEK,sBAAsB,CAC1B,EAAU,EACV,QAAgB,EAChB,KAA8B,EAC9B,OAAuB;;YAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,oBAAoB,EAAE,6BAA6B,QAAQ,EAAE,EAC7D;gBACE,MAAM,EAAE,QAAQ;gBAChB,OAAO;gBACP,KAAK;aACN,CACF,CAAA;QACH,CAAC;KAAA;IAEK,OAAO,CACX,EAAU,EACV,IAAoC,EACpC,KAA8B,EAC9B,OAAuB;;YAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,oBAAoB,EAAE,UAAU,EAChC;gBACE,MAAM,EAAE,MAAM;gBACd,OAAO;gBACP,IAAI;gBACJ,KAAK;aACN,CACF,CAAA;QACH,CAAC;KAAA;IAEK,aAAa,CACjB,EAAU,EACV,KAA8B,EAC9B,OAAuB;;YAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,oBAAoB,EAAE,UAAU,EAChC;gBACE,MAAM,EAAE,QAAQ;gBAChB,OAAO;gBACP,KAAK;aACN,CACF,CAAA;QACH,CAAC;KAAA;CACF"}
+{"version":3,"file":"exchange.js","sourceRoot":"","sources":["../../../src/admin/exchange.ts"],"names":[],"mappings":";;;;;;;;;AAKA,MAAM,OAAO,QAAQ;IAKnB;;OAEG;IACH,YAAY,MAAc;QACxB,IAAI,CAAC,MAAM,GAAG,MAAM,CAAA;IACtB,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA8CG;IACG,IAAI,CACR,KAAyC,EACzC,OAAuB;;YAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,kBAAkB,EAClB;gBACE,KAAK;gBACL,OAAO;aACR,CACF,CAAA;QACH,CAAC;KAAA;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAgCG;IACG,QAAQ,CACZ,EAAU,EACV,KAAoB,EACpB,OAAuB;;YAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,oBAAoB,EAAE,EAAE,EACxB;gBACE,KAAK;gBACL,OAAO;aACR,CACF,CAAA;QACH,CAAC;KAAA;IAED;;;;;;;;;;;;;;;;OAgBG;IACG,MAAM,CACV,IAAmC,EACnC,KAA8B,EAC9B,OAAuB;;YAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,kBAAkB,EAClB;gBACE,MAAM,EAAE,MAAM;gBACd,OAAO;gBACP,IAAI;gBACJ,KAAK;aACN,CACF,CAAA;QACH,CAAC;KAAA;IAED;;;;;;;;;;;;;;OAcG;IACG,MAAM,CACV,EAAU,EACV,KAA8B,EAC9B,OAAuB;;YAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,oBAAoB,EAAE,SAAS,EAC/B;gBACE,MAAM,EAAE,MAAM;gBACd,OAAO;gBACP,KAAK;aACN,CACF,CAAA;QACH,CAAC;KAAA;IAED;;;;;;;;;;;;;;;;;;;;;;;OAuBG;IACG,eAAe,CACnB,EAAU,EACV,IAA4C,EAC5C,KAA8B,EAC9B,OAAuB;;YAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,oBAAoB,EAAE,gBAAgB,EACtC;gBACE,MAAM,EAAE,MAAM;gBACd,OAAO;gBACP,IAAI;gBACJ,KAAK;aACN,CACF,CAAA;QACH,CAAC;KAAA;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA4BG;IACG,iBAAiB,CACrB,EAAU,EACV,QAAgB,EAChB,IAA8C,EAC9C,KAA8B,EAC9B,OAAuB;;YAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,oBAAoB,EAAE,kBAAkB,QAAQ,EAAE,EAClD;gBACE,MAAM,EAAE,MAAM;gBACd,OAAO;gBACP,IAAI;gBACJ,KAAK;aACN,CACF,CAAA;QACH,CAAC;KAAA;IAED;;;;;;;;;;;;;;;;;;;;;;;;OAwBG;IACG,iBAAiB,CACrB,EAAU,EACV,QAAgB,EAChB,KAA8B,EAC9B,OAAuB;;YAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,oBAAoB,EAAE,kBAAkB,QAAQ,EAAE,EAClD;gBACE,MAAM,EAAE,QAAQ;gBAChB,OAAO;gBACP,KAAK;aACN,CACF,CAAA;QACH,CAAC;KAAA;IAED;;;;;;;;;;;;;;;;;;;;;;;OAuBG;IACG,kBAAkB,CACtB,EAAU,EACV,IAA+C,EAC/C,KAA8B,EAC9B,OAAuB;;YAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,oBAAoB,EAAE,0BAA0B,EAChD;gBACE,MAAM,EAAE,MAAM;gBACd,OAAO;gBACP,IAAI;gBACJ,KAAK;aACN,CACF,CAAA;QACH,CAAC;KAAA;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA4BG;IACG,qBAAqB,CACzB,EAAU,EACV,QAAgB,EAChB,IAAkD,EAClD,KAA8B,EAC9B,OAAuB;;YAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,oBAAoB,EAAE,4BAA4B,QAAQ,EAAE,EAC5D;gBACE,MAAM,EAAE,MAAM;gBACd,OAAO;gBACP,IAAI;gBACJ,KAAK;aACN,CACF,CAAA;QACH,CAAC;KAAA;IAED;;;;;;;;;;;;;;;;;;;;;;;;OAwBG;IACG,qBAAqB,CACzB,EAAU,EACV,QAAgB,EAChB,KAA8B,EAC9B,OAAuB;;YAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,oBAAoB,EAAE,4BAA4B,QAAQ,EAAE,EAC5D;gBACE,MAAM,EAAE,QAAQ;gBAChB,OAAO;gBACP,KAAK;aACN,CACF,CAAA;QACH,CAAC;KAAA;IAED;;;;;;;;;;;;;;;;;;;;;;;OAuBG;IACG,gBAAgB,CACpB,EAAU,EACV,IAA6C,EAC7C,KAA8B,EAC9B,OAAuB;;YAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,oBAAoB,EAAE,iBAAiB,EACvC;gBACE,MAAM,EAAE,MAAM;gBACd,OAAO;gBACP,IAAI;gBACJ,KAAK;aACN,CACF,CAAA;QACH,CAAC;KAAA;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA4BG;IACG,kBAAkB,CACtB,EAAU,EACV,QAAgB,EAChB,IAA+C,EAC/C,KAA8B,EAC9B,OAAuB;;YAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,oBAAoB,EAAE,mBAAmB,QAAQ,EAAE,EACnD;gBACE,MAAM,EAAE,MAAM;gBACd,OAAO;gBACP,IAAI;gBACJ,KAAK;aACN,CACF,CAAA;QACH,CAAC;KAAA;IAED;;;;;;;;;;;;;;;;;;;;;;;;OAwBG;IACG,kBAAkB,CACtB,EAAU,EACV,QAAgB,EAChB,KAA8B,EAC9B,OAAuB;;YAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,oBAAoB,EAAE,mBAAmB,QAAQ,EAAE,EACnD;gBACE,MAAM,EAAE,QAAQ;gBAChB,OAAO;gBACP,KAAK;aACN,CACF,CAAA;QACH,CAAC;KAAA;IAED;;;;;;;;;;;;;;;;;;;;OAoBG;IACG,mBAAmB,CACvB,EAAU,EACV,IAAgD,EAChD,KAA8B,EAC9B,OAAuB;;YAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,oBAAoB,EAAE,2BAA2B,EACjD;gBACE,MAAM,EAAE,MAAM;gBACd,OAAO;gBACP,IAAI;gBACJ,KAAK;aACN,CACF,CAAA;QACH,CAAC;KAAA;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA4BG;IACG,sBAAsB,CAC1B,EAAU,EACV,QAAgB,EAChB,IAAmD,EACnD,KAA8B,EAC9B,OAAuB;;YAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,oBAAoB,EAAE,6BAA6B,QAAQ,EAAE,EAC7D;gBACE,MAAM,EAAE,MAAM;gBACd,OAAO;gBACP,IAAI;gBACJ,KAAK;aACN,CACF,CAAA;QACH,CAAC;KAAA;IAED;;;;;;;;;;;;;;;;;;;;;;;;OAwBG;IACG,sBAAsB,CAC1B,EAAU,EACV,QAAgB,EAChB,KAA8B,EAC9B,OAAuB;;YAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,oBAAoB,EAAE,6BAA6B,QAAQ,EAAE,EAC7D;gBACE,MAAM,EAAE,QAAQ;gBAChB,OAAO;gBACP,KAAK;aACN,CACF,CAAA;QACH,CAAC;KAAA;IAED;;;;;;;;;;;;;;;;;OAiBG;IACG,OAAO,CACX,EAAU,EACV,IAAoC,EACpC,KAA8B,EAC9B,OAAuB;;YAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,oBAAoB,EAAE,UAAU,EAChC;gBACE,MAAM,EAAE,MAAM;gBACd,OAAO;gBACP,IAAI;gBACJ,KAAK;aACN,CACF,CAAA;QACH,CAAC;KAAA;IAED;;;;;;;;;;;;;;;OAeG;IACG,aAAa,CACjB,EAAU,EACV,KAA8B,EAC9B,OAAuB;;YAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,oBAAoB,EAAE,UAAU,EAChC;gBACE,MAAM,EAAE,QAAQ;gBAChB,OAAO;gBACP,KAAK;aACN,CACF,CAAA;QACH,CAAC;KAAA;CACF"}

package/dist/esm/admin/fulfillment-provider.d.ts

@@ -10,6 +10,53 @@ export declare class FulfillmentProvider {
      * @ignore
      */
     constructor(client: Client);
+    /**
+     * This method retrieves a paginated list of fulfillment providers. It sends a request to the
+     * [List Fulfillment Providers](https://docs.medusajs.com/v2/api/admin#fulfillment-providers_getfulfillmentproviders)
+     * API route.
+     *
+     * @param query - Filters and pagination configurations.
+     * @param headers - Headers to pass in the request.
+     * @returns The paginated list of providers.
+     *
+     * @example
+     * To retrieve the list of fulfillment providers:
+     *
+     * ```ts
+     * sdk.admin.fulfillmentProvider.list()
+     * .then(({ fulfillment_providers, count, limit, offset }) => {
+     *   console.log(fulfillment_providers)
+     * })
+     * ```
+     *
+     * To configure the pagination, pass the `limit` and `offset` query parameters.
+     *
+     * For example, to retrieve only 10 items and skip 10 items:
+     *
+     * ```ts
+     * sdk.admin.fulfillmentProvider.list({
+     *   limit: 10,
+     *   offset: 10
+     * })
+     * .then(({ fulfillment_providers, count, limit, offset }) => {
+     *   console.log(fulfillment_providers)
+     * })
+     * ```
+     *
+     * Using the `fields` query parameter, you can specify the fields and relations to retrieve
+     * in each fulfillment provider:
+     *
+     * ```ts
+     * sdk.admin.fulfillmentProvider.list({
+     *   fields: "id"
+     * })
+     * .then(({ fulfillment_providers, count, limit, offset }) => {
+     *   console.log(fulfillment_providers)
+     * })
+     * ```
+     *
+     * Learn more about the `fields` property in the [API reference](https://docs.medusajs.com/v2/api/store#select-fields-and-relations).
+     */
     list(query?: HttpTypes.AdminFulfillmentProviderListParams, headers?: ClientHeaders): Promise<HttpTypes.AdminFulfillmentProviderListResponse>;
 }
 //# sourceMappingURL=fulfillment-provider.d.ts.map

package/dist/esm/admin/fulfillment-provider.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"fulfillment-provider.d.ts","sourceRoot":"","sources":["../../../src/admin/fulfillment-provider.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAA;AAC3C,OAAO,EAAE,MAAM,EAAE,MAAM,WAAW,CAAA;AAClC,OAAO,EAAE,aAAa,EAAE,MAAM,UAAU,CAAA;AAExC,qBAAa,mBAAmB;IAC9B;;OAEG;IACH,OAAO,CAAC,MAAM,CAAQ;IACtB;;OAEG;gBACS,MAAM,EAAE,MAAM;IAIpB,IAAI,CACR,KAAK,CAAC,EAAE,SAAS,CAAC,kCAAkC,EACpD,OAAO,CAAC,EAAE,aAAa;CAW1B"}
+{"version":3,"file":"fulfillment-provider.d.ts","sourceRoot":"","sources":["../../../src/admin/fulfillment-provider.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAA;AAC3C,OAAO,EAAE,MAAM,EAAE,MAAM,WAAW,CAAA;AAClC,OAAO,EAAE,aAAa,EAAE,MAAM,UAAU,CAAA;AAExC,qBAAa,mBAAmB;IAC9B;;OAEG;IACH,OAAO,CAAC,MAAM,CAAQ;IACtB;;OAEG;gBACS,MAAM,EAAE,MAAM;IAI1B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA8CG;IACG,IAAI,CACR,KAAK,CAAC,EAAE,SAAS,CAAC,kCAAkC,EACpD,OAAO,CAAC,EAAE,aAAa;CAW1B"}