@medusajs/js-sdk 1.0.0-rc-20241018141633 → 1.0.0-rc-20241022152047

package/dist/admin/exchange.js

@@ -8,18 +8,115 @@ 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).
+     */
     async list(query, headers) {
         return await this.client.fetch(`/admin/exchanges`, {
             query,
             headers,
         });
     }
+    /**
+     * 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).
+     */
     async retrieve(id, query, headers) {
         return await this.client.fetch(`/admin/exchanges/${id}`, {
             query,
             headers,
         });
     }
+    /**
+     * 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)
+     * })
+     */
     async create(body, query, headers) {
         return await this.client.fetch(`/admin/exchanges`, {
             method: "POST",
@@ -28,6 +125,21 @@ class Exchange {
             query,
         });
     }
+    /**
+     * 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)
+     * })
+     */
     async cancel(id, query, headers) {
         return await this.client.fetch(`/admin/exchanges/${id}/cancel`, {
             method: "POST",
@@ -35,36 +147,30 @@ class Exchange {
             query,
         });
     }
-    async delete(id, query, headers) {
-        return await this.client.fetch(`/admin/exchanges/${id}`, {
-            method: "DELETE",
-            headers,
-            query,
-        });
-    }
-    async addItems(id, body, query, headers) {
-        return await this.client.fetch(`/admin/exchanges/${id}/exchange-items`, {
-            method: "POST",
-            headers,
-            body,
-            query,
-        });
-    }
-    async updateItem(id, actionId, body, query, headers) {
-        return await this.client.fetch(`/admin/exchanges/${id}/exchange-items/${actionId}`, {
-            method: "POST",
-            headers,
-            body,
-            query,
-        });
-    }
-    async removeItem(id, actionId, query, headers) {
-        return await this.client.fetch(`/admin/exchanges/${id}/exchange-items/${actionId}`, {
-            method: "DELETE",
-            headers,
-            query,
-        });
-    }
+    /**
+     * 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)
+     * })
+     */
     async addInboundItems(id, body, query, headers) {
         return await this.client.fetch(`/admin/exchanges/${id}/inbound/items`, {
             method: "POST",
@@ -73,6 +179,35 @@ class Exchange {
             query,
         });
     }
+    /**
+     * 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)
+     * })
+     */
     async updateInboundItem(id, actionId, body, query, headers) {
         return await this.client.fetch(`/admin/exchanges/${id}/inbound/items/${actionId}`, {
             method: "POST",
@@ -81,6 +216,31 @@ class Exchange {
             query,
         });
     }
+    /**
+     * 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)
+     * })
+     */
     async removeInboundItem(id, actionId, query, headers) {
         return await this.client.fetch(`/admin/exchanges/${id}/inbound/items/${actionId}`, {
             method: "DELETE",
@@ -88,6 +248,30 @@ class Exchange {
             query,
         });
     }
+    /**
+     * 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)
+     * })
+     */
     async addInboundShipping(id, body, query, headers) {
         return await this.client.fetch(`/admin/exchanges/${id}/inbound/shipping-method`, {
             method: "POST",
@@ -96,6 +280,35 @@ class Exchange {
             query,
         });
     }
+    /**
+     * 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)
+     * })
+     */
     async updateInboundShipping(id, actionId, body, query, headers) {
         return await this.client.fetch(`/admin/exchanges/${id}/inbound/shipping-method/${actionId}`, {
             method: "POST",
@@ -104,6 +317,31 @@ class Exchange {
             query,
         });
     }
+    /**
+     * 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)
+     * })
+     */
     async deleteInboundShipping(id, actionId, query, headers) {
         return await this.client.fetch(`/admin/exchanges/${id}/inbound/shipping-method/${actionId}`, {
             method: "DELETE",
@@ -111,6 +349,30 @@ class Exchange {
             query,
         });
     }
+    /**
+     * 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)
+     * })
+     */
     async addOutboundItems(id, body, query, headers) {
         return await this.client.fetch(`/admin/exchanges/${id}/outbound/items`, {
             method: "POST",
@@ -119,6 +381,35 @@ class Exchange {
             query,
         });
     }
+    /**
+     * 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)
+     * })
+     */
     async updateOutboundItem(id, actionId, body, query, headers) {
         return await this.client.fetch(`/admin/exchanges/${id}/outbound/items/${actionId}`, {
             method: "POST",
@@ -127,6 +418,31 @@ class Exchange {
             query,
         });
     }
+    /**
+     * 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)
+     * })
+     */
     async removeOutboundItem(id, actionId, query, headers) {
         return await this.client.fetch(`/admin/exchanges/${id}/outbound/items/${actionId}`, {
             method: "DELETE",
@@ -134,6 +450,27 @@ class Exchange {
             query,
         });
     }
+    /**
+     * 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)
+     * })
+     */
     async addOutboundShipping(id, body, query, headers) {
         return await this.client.fetch(`/admin/exchanges/${id}/outbound/shipping-method`, {
             method: "POST",
@@ -142,6 +479,35 @@ class Exchange {
             query,
         });
     }
+    /**
+     * 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)
+     * })
+     */
     async updateOutboundShipping(id, actionId, body, query, headers) {
         return await this.client.fetch(`/admin/exchanges/${id}/outbound/shipping-method/${actionId}`, {
             method: "POST",
@@ -150,6 +516,31 @@ class Exchange {
             query,
         });
     }
+    /**
+     * 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)
+     * })
+     */
     async deleteOutboundShipping(id, actionId, query, headers) {
         return await this.client.fetch(`/admin/exchanges/${id}/outbound/shipping-method/${actionId}`, {
             method: "DELETE",
@@ -157,6 +548,24 @@ class Exchange {
             query,
         });
     }
+    /**
+     * 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)
+     * })
+     */
     async request(id, body, query, headers) {
         return await this.client.fetch(`/admin/exchanges/${id}/request`, {
             method: "POST",
@@ -165,6 +574,22 @@ class Exchange {
             query,
         });
     }
+    /**
+     * 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)
+     * })
+     */
     async cancelRequest(id, query, headers) {
         return await this.client.fetch(`/admin/exchanges/${id}/request`, {
             method: "DELETE",

package/dist/admin/exchange.js.map

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

package/dist/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/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"}