@medusajs/js-sdk 2.0.5-preview-20241119150151 → 2.0.5-preview-20241119210153

package/dist/esm/admin/product-variant.d.ts

@@ -10,6 +10,53 @@ export declare class ProductVariant {
      * @ignore
      */
     constructor(client: Client);
-    list(queryParams?: HttpTypes.AdminProductVariantParams, headers?: ClientHeaders): Promise<HttpTypes.AdminProductVariantListResponse>;
+    /**
+     * This method retrieves a paginated list of product variants. It sends a request to the
+     * [List Product Variants](https://docs.medusajs.com/api/admin#product-variants_getproductvariants)
+     * API route.
+     *
+     * @param query - Filters and pagination configurations.
+     * @param headers - Headers to pass in the request.
+     * @returns The paginated list of product variants.
+     *
+     * @example
+     * To retrieve the list of product variants:
+     *
+     * ```ts
+     * sdk.admin.productVariant.list()
+     * .then(({ variants, count, limit, offset }) => {
+     *   console.log(variants)
+     * })
+     * ```
+     *
+     * 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.productVariant.list({
+     *   limit: 10,
+     *   offset: 10
+     * })
+     * .then(({ variants, count, limit, offset }) => {
+     *   console.log(variants)
+     * })
+     * ```
+     *
+     * Using the `fields` query parameter, you can specify the fields and relations to retrieve
+     * in each campaign:
+     *
+     * ```ts
+     * sdk.admin.productVariant.list({
+     *   fields: "id,products"
+     * })
+     * .then(({ variants, count, limit, offset }) => {
+     *   console.log(variants)
+     * })
+     * ```
+     *
+     * Learn more about the `fields` property in the [API reference](https://docs.medusajs.com/api/store#select-fields-and-relations).
+     */
+    list(query?: HttpTypes.AdminProductVariantParams, headers?: ClientHeaders): Promise<HttpTypes.AdminProductVariantListResponse>;
 }
 //# sourceMappingURL=product-variant.d.ts.map

package/dist/esm/admin/product-variant.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"product-variant.d.ts","sourceRoot":"","sources":["../../../src/admin/product-variant.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,cAAc;IACzB;;OAEG;IACH,OAAO,CAAC,MAAM,CAAQ;IACtB;;OAEG;gBACS,MAAM,EAAE,MAAM;IAIpB,IAAI,CACR,WAAW,CAAC,EAAE,SAAS,CAAC,yBAAyB,EACjD,OAAO,CAAC,EAAE,aAAa;CAU1B"}
+{"version":3,"file":"product-variant.d.ts","sourceRoot":"","sources":["../../../src/admin/product-variant.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,cAAc;IACzB;;OAEG;IACH,OAAO,CAAC,MAAM,CAAQ;IACtB;;OAEG;gBACS,MAAM,EAAE,MAAM;IAI1B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA8CG;IACG,IAAI,CACR,KAAK,CAAC,EAAE,SAAS,CAAC,yBAAyB,EAC3C,OAAO,CAAC,EAAE,aAAa;CAU1B"}

package/dist/esm/admin/product-variant.js

@@ -14,11 +14,58 @@ export class ProductVariant {
     constructor(client) {
         this.client = client;
     }
-    list(queryParams, headers) {
+    /**
+     * This method retrieves a paginated list of product variants. It sends a request to the
+     * [List Product Variants](https://docs.medusajs.com/api/admin#product-variants_getproductvariants)
+     * API route.
+     *
+     * @param query - Filters and pagination configurations.
+     * @param headers - Headers to pass in the request.
+     * @returns The paginated list of product variants.
+     *
+     * @example
+     * To retrieve the list of product variants:
+     *
+     * ```ts
+     * sdk.admin.productVariant.list()
+     * .then(({ variants, count, limit, offset }) => {
+     *   console.log(variants)
+     * })
+     * ```
+     *
+     * 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.productVariant.list({
+     *   limit: 10,
+     *   offset: 10
+     * })
+     * .then(({ variants, count, limit, offset }) => {
+     *   console.log(variants)
+     * })
+     * ```
+     *
+     * Using the `fields` query parameter, you can specify the fields and relations to retrieve
+     * in each campaign:
+     *
+     * ```ts
+     * sdk.admin.productVariant.list({
+     *   fields: "id,products"
+     * })
+     * .then(({ variants, count, limit, offset }) => {
+     *   console.log(variants)
+     * })
+     * ```
+     *
+     * Learn more about the `fields` property in the [API reference](https://docs.medusajs.com/api/store#select-fields-and-relations).
+     */
+    list(query, headers) {
         return __awaiter(this, void 0, void 0, function* () {
             return yield this.client.fetch(`/admin/product-variants`, {
                 headers,
-                query: queryParams,
+                query,
             });
         });
     }

package/dist/esm/admin/product-variant.js.map

@@ -1 +1 @@
-{"version":3,"file":"product-variant.js","sourceRoot":"","sources":["../../../src/admin/product-variant.ts"],"names":[],"mappings":";;;;;;;;;AAIA,MAAM,OAAO,cAAc;IAKzB;;OAEG;IACH,YAAY,MAAc;QACxB,IAAI,CAAC,MAAM,GAAG,MAAM,CAAA;IACtB,CAAC;IAEK,IAAI,CACR,WAAiD,EACjD,OAAuB;;YAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,yBAAyB,EACzB;gBACE,OAAO;gBACP,KAAK,EAAE,WAAW;aACnB,CACF,CAAA;QACH,CAAC;KAAA;CACF"}
+{"version":3,"file":"product-variant.js","sourceRoot":"","sources":["../../../src/admin/product-variant.ts"],"names":[],"mappings":";;;;;;;;;AAIA,MAAM,OAAO,cAAc;IAKzB;;OAEG;IACH,YAAY,MAAc;QACxB,IAAI,CAAC,MAAM,GAAG,MAAM,CAAA;IACtB,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA8CG;IACG,IAAI,CACR,KAA2C,EAC3C,OAAuB;;YAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,yBAAyB,EACzB;gBACE,OAAO;gBACP,KAAK;aACN,CACF,CAAA;QACH,CAAC;KAAA;CACF"}