@medusajs/js-sdk 0.0.2-snapshot-20241022123018 → 0.0.2-snapshot-20241022143805

package/dist/esm/admin/fulfillment-provider.js

@@ -14,6 +14,53 @@ export class FulfillmentProvider {
     constructor(client) {
         this.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, headers) {
         return __awaiter(this, void 0, void 0, function* () {
             return yield this.client.fetch(`/admin/fulfillment-providers`, {

package/dist/esm/admin/fulfillment-provider.js.map

@@ -1 +1 @@
-{"version":3,"file":"fulfillment-provider.js","sourceRoot":"","sources":["../../../src/admin/fulfillment-provider.ts"],"names":[],"mappings":";;;;;;;;;AAIA,MAAM,OAAO,mBAAmB;IAK9B;;OAEG;IACH,YAAY,MAAc;QACxB,IAAI,CAAC,MAAM,GAAG,MAAM,CAAA;IACtB,CAAC;IAEK,IAAI,CACR,KAAoD,EACpD,OAAuB;;YAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,8BAA8B,EAC9B;gBACE,MAAM,EAAE,KAAK;gBACb,OAAO;gBACP,KAAK;aACN,CACF,CAAA;QACH,CAAC;KAAA;CACF"}
+{"version":3,"file":"fulfillment-provider.js","sourceRoot":"","sources":["../../../src/admin/fulfillment-provider.ts"],"names":[],"mappings":";;;;;;;;;AAIA,MAAM,OAAO,mBAAmB;IAK9B;;OAEG;IACH,YAAY,MAAc;QACxB,IAAI,CAAC,MAAM,GAAG,MAAM,CAAA;IACtB,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA8CG;IACG,IAAI,CACR,KAAoD,EACpD,OAAuB;;YAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,8BAA8B,EAC9B;gBACE,MAAM,EAAE,KAAK;gBACb,OAAO;gBACP,KAAK;aACN,CACF,CAAA;QACH,CAAC;KAAA;CACF"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@medusajs/js-sdk",
-  "version": "0.0.2-snapshot-20241022123018",
+  "version": "0.0.2-snapshot-20241022143805",
   "description": "SDK for the Medusa API",
   "main": "dist/index.js",
   "module": "dist/esm/index.js",
@@ -35,7 +35,7 @@
     "typescript": "^5.6.2"
   },
   "dependencies": {
-    "@medusajs/types": "1.11.17-snapshot-20241022123018",
+    "@medusajs/types": "1.11.17-snapshot-20241022143805",
     "fetch-event-stream": "^0.1.5",
     "qs": "^6.12.1"
   },