@medusajs/js-sdk 2.0.0-preview-20241022100028 → 2.0.0

package/dist/esm/admin/currency.d.ts

@@ -10,7 +10,86 @@ export declare class Currency {
      * @ignore
      */
     constructor(client: Client);
+    /**
+     * This method retrieves a paginated list of currencies. It sends a request to the
+     * [List Currencies](https://docs.medusajs.com/v2/api/admin#currencies_getcurrencies)
+     * API route.
+     *
+     * @param query - Filters and pagination configurations.
+     * @param headers - Headers to pass in the request.
+     * @returns The paginated list of currencies.
+     *
+     * @example
+     * To retrieve the list of currencies:
+     *
+     * ```ts
+     * sdk.admin.currency.list()
+     * .then(({ currencies, count, limit, offset }) => {
+     *   console.log(currencies)
+     * })
+     * ```
+     *
+     * 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.currency.list({
+     *   limit: 10,
+     *   offset: 10
+     * })
+     * .then(({ currencies, count, limit, offset }) => {
+     *   console.log(currencies)
+     * })
+     * ```
+     *
+     * Using the `fields` query parameter, you can specify the fields and relations to retrieve
+     * in each currency:
+     *
+     * ```ts
+     * sdk.admin.currency.list({
+     *   fields: "code,symbol"
+     * })
+     * .then(({ currencies, count, limit, offset }) => {
+     *   console.log(currencies)
+     * })
+     * ```
+     *
+     * Learn more about the `fields` property in the [API reference](https://docs.medusajs.com/v2/api/store#select-fields-and-relations).
+     */
     list(query?: HttpTypes.AdminCurrencyListParams, headers?: ClientHeaders): Promise<HttpTypes.AdminCurrencyListResponse>;
-    retrieve(id: string, query?: HttpTypes.AdminCurrencyParams, headers?: ClientHeaders): Promise<HttpTypes.AdminCurrencyResponse>;
+    /**
+     * This method retrieves a currency by its code. It sends a request to the
+     * [Get Currency](https://docs.medusajs.com/v2/api/admin#currencies_getcurrenciescode) API route.
+     *
+     * @param code - The currency's code.
+     * @param query - Configure the fields to retrieve in the currency.
+     * @param headers - Headers to pass in the request
+     * @returns The currency's details.
+     *
+     * @example
+     * To retrieve a currency by its code:
+     *
+     * ```ts
+     * sdk.admin.currency.retrieve("usd")
+     * .then(({ currency }) => {
+     *   console.log(currency)
+     * })
+     * ```
+     *
+     * To specify the fields and relations to retrieve:
+     *
+     * ```ts
+     * sdk.admin.currency.retrieve("usd", {
+     *   fields: "code,symbol"
+     * })
+     * .then(({ currency }) => {
+     *   console.log(currency)
+     * })
+     * ```
+     *
+     * Learn more about the `fields` property in the [API reference](https://docs.medusajs.com/v2/api/store#select-fields-and-relations).
+     */
+    retrieve(code: string, query?: HttpTypes.AdminCurrencyParams, headers?: ClientHeaders): Promise<HttpTypes.AdminCurrencyResponse>;
 }
 //# sourceMappingURL=currency.d.ts.map

package/dist/esm/admin/currency.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"currency.d.ts","sourceRoot":"","sources":["../../../src/admin/currency.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,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;CAU1B"}
+{"version":3,"file":"currency.d.ts","sourceRoot":"","sources":["../../../src/admin/currency.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,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;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA+BG;IACG,QAAQ,CACZ,IAAI,EAAE,MAAM,EACZ,KAAK,CAAC,EAAE,SAAS,CAAC,mBAAmB,EACrC,OAAO,CAAC,EAAE,aAAa;CAU1B"}

package/dist/esm/admin/currency.js

@@ -14,6 +14,53 @@ export class Currency {
     constructor(client) {
         this.client = client;
     }
+    /**
+     * This method retrieves a paginated list of currencies. It sends a request to the
+     * [List Currencies](https://docs.medusajs.com/v2/api/admin#currencies_getcurrencies)
+     * API route.
+     *
+     * @param query - Filters and pagination configurations.
+     * @param headers - Headers to pass in the request.
+     * @returns The paginated list of currencies.
+     *
+     * @example
+     * To retrieve the list of currencies:
+     *
+     * ```ts
+     * sdk.admin.currency.list()
+     * .then(({ currencies, count, limit, offset }) => {
+     *   console.log(currencies)
+     * })
+     * ```
+     *
+     * 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.currency.list({
+     *   limit: 10,
+     *   offset: 10
+     * })
+     * .then(({ currencies, count, limit, offset }) => {
+     *   console.log(currencies)
+     * })
+     * ```
+     *
+     * Using the `fields` query parameter, you can specify the fields and relations to retrieve
+     * in each currency:
+     *
+     * ```ts
+     * sdk.admin.currency.list({
+     *   fields: "code,symbol"
+     * })
+     * .then(({ currencies, count, limit, offset }) => {
+     *   console.log(currencies)
+     * })
+     * ```
+     *
+     * 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 this.client.fetch(`/admin/currencies`, {
@@ -22,9 +69,41 @@ export class Currency {
             });
         });
     }
-    retrieve(id, query, headers) {
+    /**
+     * This method retrieves a currency by its code. It sends a request to the
+     * [Get Currency](https://docs.medusajs.com/v2/api/admin#currencies_getcurrenciescode) API route.
+     *
+     * @param code - The currency's code.
+     * @param query - Configure the fields to retrieve in the currency.
+     * @param headers - Headers to pass in the request
+     * @returns The currency's details.
+     *
+     * @example
+     * To retrieve a currency by its code:
+     *
+     * ```ts
+     * sdk.admin.currency.retrieve("usd")
+     * .then(({ currency }) => {
+     *   console.log(currency)
+     * })
+     * ```
+     *
+     * To specify the fields and relations to retrieve:
+     *
+     * ```ts
+     * sdk.admin.currency.retrieve("usd", {
+     *   fields: "code,symbol"
+     * })
+     * .then(({ currency }) => {
+     *   console.log(currency)
+     * })
+     * ```
+     *
+     * Learn more about the `fields` property in the [API reference](https://docs.medusajs.com/v2/api/store#select-fields-and-relations).
+     */
+    retrieve(code, query, headers) {
         return __awaiter(this, void 0, void 0, function* () {
-            return this.client.fetch(`/admin/currencies/${id}`, {
+            return this.client.fetch(`/admin/currencies/${code}`, {
                 headers,
                 query,
             });

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

@@ -1 +1 @@
-{"version":3,"file":"currency.js","sourceRoot":"","sources":["../../../src/admin/currency.ts"],"names":[],"mappings":";;;;;;;;;AAIA,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,IAAI,CAAC,MAAM,CAAC,KAAK,CACtB,mBAAmB,EACnB;gBACE,OAAO;gBACP,KAAK;aACN,CACF,CAAA;QACH,CAAC;KAAA;IAEK,QAAQ,CACZ,EAAU,EACV,KAAqC,EACrC,OAAuB;;YAEvB,OAAO,IAAI,CAAC,MAAM,CAAC,KAAK,CACtB,qBAAqB,EAAE,EAAE,EACzB;gBACE,OAAO;gBACP,KAAK;aACN,CACF,CAAA;QACH,CAAC;KAAA;CACF"}
+{"version":3,"file":"currency.js","sourceRoot":"","sources":["../../../src/admin/currency.ts"],"names":[],"mappings":";;;;;;;;;AAIA,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,IAAI,CAAC,MAAM,CAAC,KAAK,CACtB,mBAAmB,EACnB;gBACE,OAAO;gBACP,KAAK;aACN,CACF,CAAA;QACH,CAAC;KAAA;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA+BG;IACG,QAAQ,CACZ,IAAY,EACZ,KAAqC,EACrC,OAAuB;;YAEvB,OAAO,IAAI,CAAC,MAAM,CAAC,KAAK,CACtB,qBAAqB,IAAI,EAAE,EAC3B;gBACE,OAAO;gBACP,KAAK;aACN,CACF,CAAA;QACH,CAAC;KAAA;CACF"}

package/dist/esm/admin/customer-group.d.ts

@@ -10,11 +10,161 @@ export declare class CustomerGroup {
      * @ignore
      */
     constructor(client: Client);
+    /**
+     * This method retrieves a customer group by its ID. It sends a request to the
+     * [Get Customer Group](https://docs.medusajs.com/v2/api/admin#customer-groups_getcustomergroupsid) API route.
+     *
+     * @param id - The customer group's ID.
+     * @param query - Configure the fields to retrieve in the customer group.
+     * @param headers - Headers to pass in the request
+     * @returns The group's details.
+     *
+     * @example
+     * To retrieve a customer group by its ID:
+     *
+     * ```ts
+     * sdk.admin.customerGroup.retrieve("cusgroup_123")
+     * .then(({ customer_group }) => {
+     *   console.log(customer_group)
+     * })
+     * ```
+     *
+     * To specify the fields and relations to retrieve:
+     *
+     * ```ts
+     * sdk.admin.customerGroup.retrieve("cusgroup_123", {
+     *   fields: "id,*customer"
+     * })
+     * .then(({ customer_group }) => {
+     *   console.log(customer_group)
+     * })
+     * ```
+     *
+     * Learn more about the `fields` property in the [API reference](https://docs.medusajs.com/v2/api/store#select-fields-and-relations).
+     */
     retrieve(id: string, query?: HttpTypes.AdminGetCustomerGroupParams, headers?: ClientHeaders): Promise<HttpTypes.AdminCustomerGroupResponse>;
+    /**
+     * This method retrieves a paginated list of customer groups. It sends a request to the
+     * [List Customer Groups](https://docs.medusajs.com/v2/api/admin#customer-groups_getcustomergroups)
+     * API route.
+     *
+     * @param query - Filters and pagination configurations.
+     * @param headers - Headers to pass in the request.
+     * @returns The paginated list of customer groups.
+     *
+     * @example
+     * To retrieve the list of customer groups:
+     *
+     * ```ts
+     * sdk.admin.customerGroup.list()
+     * .then(({ customer_groups, count, limit, offset }) => {
+     *   console.log(customer_groups)
+     * })
+     * ```
+     *
+     * 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.customerGroup.list({
+     *   limit: 10,
+     *   offset: 10
+     * })
+     * .then(({ customer_groups, count, limit, offset }) => {
+     *   console.log(customer_groups)
+     * })
+     * ```
+     *
+     * Using the `fields` query parameter, you can specify the fields and relations to retrieve
+     * in each customer group:
+     *
+     * ```ts
+     * sdk.admin.customerGroup.list({
+     *   fields: "id,*customer"
+     * })
+     * .then(({ customer_groups, count, limit, offset }) => {
+     *   console.log(customer_groups)
+     * })
+     * ```
+     *
+     * Learn more about the `fields` property in the [API reference](https://docs.medusajs.com/v2/api/store#select-fields-and-relations).
+     */
     list(query?: HttpTypes.AdminGetCustomerGroupsParams, headers?: ClientHeaders): Promise<HttpTypes.AdminCustomerGroupListResponse>;
-    create(body: HttpTypes.AdminCreateCustomerGroup, query?: HttpTypes.AdminGetCustomerGroupsParams, headers?: ClientHeaders): Promise<HttpTypes.AdminCustomerGroupResponse>;
-    update(id: string, body: HttpTypes.AdminUpdateCustomerGroup, query?: HttpTypes.AdminGetCustomerGroupsParams, headers?: ClientHeaders): Promise<HttpTypes.AdminCustomerGroupResponse>;
+    /**
+     * This method creates a customer group. It sends a request to the
+     * [Create Customer Group](https://docs.medusajs.com/v2/api/admin#customer-groups_postcustomergroups)
+     * API route.
+     *
+     * @param body - The customer group's details.
+     * @param query - Configure the fields to retrieve in the customer group.
+     * @param headers - Headers to pass in the request.
+     * @returns The customer group's details.
+     *
+     * @example
+     * sdk.admin.customerGroup.create({
+     *   name: "VIP"
+     * })
+     * .then(({ customer_group }) => {
+     *   console.log(customer_group)
+     * })
+     */
+    create(body: HttpTypes.AdminCreateCustomerGroup, query?: HttpTypes.AdminGetCustomerGroupParams, headers?: ClientHeaders): Promise<HttpTypes.AdminCustomerGroupResponse>;
+    /**
+     * This method updates a customer group's details. It sends a request to the
+     * [Update Customer](https://docs.medusajs.com/v2/api/admin#customer-groups_postcustomergroupsid)
+     * API route.
+     *
+     * @param id - The customer group's ID.
+     * @param body - The details to update in the group.
+     * @param query - Configure the fields to retrieve in the customer group.
+     * @param headers - Headers to pass in the request.
+     * @returns The customer group's details.
+     *
+     * @example
+     * sdk.admin.customerGroup.update("cusgroup_123", {
+     *   name: "VIP"
+     * })
+     * .then(({ customer_group }) => {
+     *   console.log(customer_group)
+     * })
+     */
+    update(id: string, body: HttpTypes.AdminUpdateCustomerGroup, query?: HttpTypes.AdminGetCustomerGroupParams, headers?: ClientHeaders): Promise<HttpTypes.AdminCustomerGroupResponse>;
+    /**
+     * This method deletes a customer group. This method sends a request to the
+     * [Delete Customer Group](https://docs.medusajs.com/v2/api/admin#customer-groups_deletecustomergroupsid)
+     * API route.
+     *
+     * @param id - The customer group's ID.
+     * @param headers - Headers to pass in the request
+     * @returns The deletion's details.
+     *
+     * @example
+     * sdk.admin.customerGroup.delete("cusgroup_123")
+     * .then(({ deleted }) => {
+     *   console.log(deleted)
+     * })
+     */
     delete(id: string, headers?: ClientHeaders): Promise<HttpTypes.AdminCustomerGroupDeleteResponse>;
+    /**
+     * This method manages customers of a group to add or remove them from the group.
+     * It sends a request to the [Manage Customers](https://docs.medusajs.com/v2/api/admin#customer-groups_postcustomergroupsidcustomers)
+     * API route.
+     *
+     * @param id - The group's ID.
+     * @param body - The customers to add or remove from the group.
+     * @param headers - Headers to pass in the request
+     * @returns The customer group's details.
+     *
+     * @example
+     * sdk.admin.customerGroup.batchCustomers("cusgroup_123", {
+     *   add: ["cus_123"],
+     *   remove: ["cus_321"]
+     * })
+     * .then(({ customer_group }) => {
+     *   console.log(customer_group)
+     * })
+     */
     batchCustomers(id: string, body: HttpTypes.AdminBatchLink, headers?: ClientHeaders): Promise<HttpTypes.AdminCustomerGroupResponse>;
 }
 //# sourceMappingURL=customer-group.d.ts.map

package/dist/esm/admin/customer-group.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"customer-group.d.ts","sourceRoot":"","sources":["../../../src/admin/customer-group.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,aAAa;IACxB;;OAEG;IACH,OAAO,CAAC,MAAM,CAAQ;IACtB;;OAEG;gBACS,MAAM,EAAE,MAAM;IAIpB,QAAQ,CACZ,EAAE,EAAE,MAAM,EACV,KAAK,CAAC,EAAE,SAAS,CAAC,2BAA2B,EAC7C,OAAO,CAAC,EAAE,aAAa;IAYnB,IAAI,CACR,KAAK,CAAC,EAAE,SAAS,CAAC,4BAA4B,EAC9C,OAAO,CAAC,EAAE,aAAa;IAYnB,MAAM,CACV,IAAI,EAAE,SAAS,CAAC,wBAAwB,EACxC,KAAK,CAAC,EAAE,SAAS,CAAC,4BAA4B,EAC9C,OAAO,CAAC,EAAE,aAAa;IAanB,MAAM,CACV,EAAE,EAAE,MAAM,EACV,IAAI,EAAE,SAAS,CAAC,wBAAwB,EACxC,KAAK,CAAC,EAAE,SAAS,CAAC,4BAA4B,EAC9C,OAAO,CAAC,EAAE,aAAa;IAanB,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,aAAa;IAU1C,cAAc,CAClB,EAAE,EAAE,MAAM,EACV,IAAI,EAAE,SAAS,CAAC,cAAc,EAC9B,OAAO,CAAC,EAAE,aAAa;CAW1B"}
+{"version":3,"file":"customer-group.d.ts","sourceRoot":"","sources":["../../../src/admin/customer-group.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,aAAa;IACxB;;OAEG;IACH,OAAO,CAAC,MAAM,CAAQ;IACtB;;OAEG;gBACS,MAAM,EAAE,MAAM;IAI1B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA+BG;IACG,QAAQ,CACZ,EAAE,EAAE,MAAM,EACV,KAAK,CAAC,EAAE,SAAS,CAAC,2BAA2B,EAC7C,OAAO,CAAC,EAAE,aAAa;IAYzB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA8CG;IACG,IAAI,CACR,KAAK,CAAC,EAAE,SAAS,CAAC,4BAA4B,EAC9C,OAAO,CAAC,EAAE,aAAa;IAYzB;;;;;;;;;;;;;;;;;OAiBG;IACG,MAAM,CACV,IAAI,EAAE,SAAS,CAAC,wBAAwB,EACxC,KAAK,CAAC,EAAE,SAAS,CAAC,2BAA2B,EAC7C,OAAO,CAAC,EAAE,aAAa;IAazB;;;;;;;;;;;;;;;;;;OAkBG;IACG,MAAM,CACV,EAAE,EAAE,MAAM,EACV,IAAI,EAAE,SAAS,CAAC,wBAAwB,EACxC,KAAK,CAAC,EAAE,SAAS,CAAC,2BAA2B,EAC7C,OAAO,CAAC,EAAE,aAAa;IAazB;;;;;;;;;;;;;;OAcG;IACG,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,aAAa;IAUhD;;;;;;;;;;;;;;;;;;OAkBG;IACG,cAAc,CAClB,EAAE,EAAE,MAAM,EACV,IAAI,EAAE,SAAS,CAAC,cAAc,EAC9B,OAAO,CAAC,EAAE,aAAa;CAW1B"}

package/dist/esm/admin/customer-group.js

@@ -14,6 +14,38 @@ export class CustomerGroup {
     constructor(client) {
         this.client = client;
     }
+    /**
+     * This method retrieves a customer group by its ID. It sends a request to the
+     * [Get Customer Group](https://docs.medusajs.com/v2/api/admin#customer-groups_getcustomergroupsid) API route.
+     *
+     * @param id - The customer group's ID.
+     * @param query - Configure the fields to retrieve in the customer group.
+     * @param headers - Headers to pass in the request
+     * @returns The group's details.
+     *
+     * @example
+     * To retrieve a customer group by its ID:
+     *
+     * ```ts
+     * sdk.admin.customerGroup.retrieve("cusgroup_123")
+     * .then(({ customer_group }) => {
+     *   console.log(customer_group)
+     * })
+     * ```
+     *
+     * To specify the fields and relations to retrieve:
+     *
+     * ```ts
+     * sdk.admin.customerGroup.retrieve("cusgroup_123", {
+     *   fields: "id,*customer"
+     * })
+     * .then(({ customer_group }) => {
+     *   console.log(customer_group)
+     * })
+     * ```
+     *
+     * 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/customer-groups/${id}`, {
@@ -23,6 +55,53 @@ export class CustomerGroup {
             });
         });
     }
+    /**
+     * This method retrieves a paginated list of customer groups. It sends a request to the
+     * [List Customer Groups](https://docs.medusajs.com/v2/api/admin#customer-groups_getcustomergroups)
+     * API route.
+     *
+     * @param query - Filters and pagination configurations.
+     * @param headers - Headers to pass in the request.
+     * @returns The paginated list of customer groups.
+     *
+     * @example
+     * To retrieve the list of customer groups:
+     *
+     * ```ts
+     * sdk.admin.customerGroup.list()
+     * .then(({ customer_groups, count, limit, offset }) => {
+     *   console.log(customer_groups)
+     * })
+     * ```
+     *
+     * 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.customerGroup.list({
+     *   limit: 10,
+     *   offset: 10
+     * })
+     * .then(({ customer_groups, count, limit, offset }) => {
+     *   console.log(customer_groups)
+     * })
+     * ```
+     *
+     * Using the `fields` query parameter, you can specify the fields and relations to retrieve
+     * in each customer group:
+     *
+     * ```ts
+     * sdk.admin.customerGroup.list({
+     *   fields: "id,*customer"
+     * })
+     * .then(({ customer_groups, count, limit, offset }) => {
+     *   console.log(customer_groups)
+     * })
+     * ```
+     *
+     * 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/customer-groups`, {
@@ -32,6 +111,24 @@ export class CustomerGroup {
             });
         });
     }
+    /**
+     * This method creates a customer group. It sends a request to the
+     * [Create Customer Group](https://docs.medusajs.com/v2/api/admin#customer-groups_postcustomergroups)
+     * API route.
+     *
+     * @param body - The customer group's details.
+     * @param query - Configure the fields to retrieve in the customer group.
+     * @param headers - Headers to pass in the request.
+     * @returns The customer group's details.
+     *
+     * @example
+     * sdk.admin.customerGroup.create({
+     *   name: "VIP"
+     * })
+     * .then(({ customer_group }) => {
+     *   console.log(customer_group)
+     * })
+     */
     create(body, query, headers) {
         return __awaiter(this, void 0, void 0, function* () {
             return yield this.client.fetch(`/admin/customer-groups`, {
@@ -42,6 +139,25 @@ export class CustomerGroup {
             });
         });
     }
+    /**
+     * This method updates a customer group's details. It sends a request to the
+     * [Update Customer](https://docs.medusajs.com/v2/api/admin#customer-groups_postcustomergroupsid)
+     * API route.
+     *
+     * @param id - The customer group's ID.
+     * @param body - The details to update in the group.
+     * @param query - Configure the fields to retrieve in the customer group.
+     * @param headers - Headers to pass in the request.
+     * @returns The customer group's details.
+     *
+     * @example
+     * sdk.admin.customerGroup.update("cusgroup_123", {
+     *   name: "VIP"
+     * })
+     * .then(({ customer_group }) => {
+     *   console.log(customer_group)
+     * })
+     */
     update(id, body, query, headers) {
         return __awaiter(this, void 0, void 0, function* () {
             return yield this.client.fetch(`/admin/customer-groups/${id}`, {
@@ -52,6 +168,21 @@ export class CustomerGroup {
             });
         });
     }
+    /**
+     * This method deletes a customer group. This method sends a request to the
+     * [Delete Customer Group](https://docs.medusajs.com/v2/api/admin#customer-groups_deletecustomergroupsid)
+     * API route.
+     *
+     * @param id - The customer group's ID.
+     * @param headers - Headers to pass in the request
+     * @returns The deletion's details.
+     *
+     * @example
+     * sdk.admin.customerGroup.delete("cusgroup_123")
+     * .then(({ deleted }) => {
+     *   console.log(deleted)
+     * })
+     */
     delete(id, headers) {
         return __awaiter(this, void 0, void 0, function* () {
             return yield this.client.fetch(`/admin/customer-groups/${id}`, {
@@ -60,6 +191,25 @@ export class CustomerGroup {
             });
         });
     }
+    /**
+     * This method manages customers of a group to add or remove them from the group.
+     * It sends a request to the [Manage Customers](https://docs.medusajs.com/v2/api/admin#customer-groups_postcustomergroupsidcustomers)
+     * API route.
+     *
+     * @param id - The group's ID.
+     * @param body - The customers to add or remove from the group.
+     * @param headers - Headers to pass in the request
+     * @returns The customer group's details.
+     *
+     * @example
+     * sdk.admin.customerGroup.batchCustomers("cusgroup_123", {
+     *   add: ["cus_123"],
+     *   remove: ["cus_321"]
+     * })
+     * .then(({ customer_group }) => {
+     *   console.log(customer_group)
+     * })
+     */
     batchCustomers(id, body, headers) {
         return __awaiter(this, void 0, void 0, function* () {
             return yield this.client.fetch(`/admin/customer-groups/${id}/customers`, {

package/dist/esm/admin/customer-group.js.map

@@ -1 +1 @@
-{"version":3,"file":"customer-group.js","sourceRoot":"","sources":["../../../src/admin/customer-group.ts"],"names":[],"mappings":";;;;;;;;;AAIA,MAAM,OAAO,aAAa;IAKxB;;OAEG;IACH,YAAY,MAAc;QACxB,IAAI,CAAC,MAAM,GAAG,MAAM,CAAA;IACtB,CAAC;IAEK,QAAQ,CACZ,EAAU,EACV,KAA6C,EAC7C,OAAuB;;YAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,0BAA0B,EAAE,EAAE,EAC9B;gBACE,MAAM,EAAE,KAAK;gBACb,KAAK;gBACL,OAAO;aACR,CACF,CAAA;QACH,CAAC;KAAA;IAEK,IAAI,CACR,KAA8C,EAC9C,OAAuB;;YAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,wBAAwB,EACxB;gBACE,MAAM,EAAE,KAAK;gBACb,OAAO;gBACP,KAAK;aACN,CACF,CAAA;QACH,CAAC;KAAA;IAEK,MAAM,CACV,IAAwC,EACxC,KAA8C,EAC9C,OAAuB;;YAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,wBAAwB,EACxB;gBACE,MAAM,EAAE,MAAM;gBACd,OAAO;gBACP,IAAI;gBACJ,KAAK;aACN,CACF,CAAA;QACH,CAAC;KAAA;IAEK,MAAM,CACV,EAAU,EACV,IAAwC,EACxC,KAA8C,EAC9C,OAAuB;;YAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,0BAA0B,EAAE,EAAE,EAC9B;gBACE,MAAM,EAAE,MAAM;gBACd,OAAO;gBACP,IAAI;gBACJ,KAAK;aACN,CACF,CAAA;QACH,CAAC;KAAA;IAEK,MAAM,CAAC,EAAU,EAAE,OAAuB;;YAC9C,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,0BAA0B,EAAE,EAAE,EAC9B;gBACE,MAAM,EAAE,QAAQ;gBAChB,OAAO;aACR,CACF,CAAA;QACH,CAAC;KAAA;IAEK,cAAc,CAClB,EAAU,EACV,IAA8B,EAC9B,OAAuB;;YAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,0BAA0B,EAAE,YAAY,EACxC;gBACE,MAAM,EAAE,MAAM;gBACd,OAAO;gBACP,IAAI;aACL,CACF,CAAA;QACH,CAAC;KAAA;CACF"}
+{"version":3,"file":"customer-group.js","sourceRoot":"","sources":["../../../src/admin/customer-group.ts"],"names":[],"mappings":";;;;;;;;;AAIA,MAAM,OAAO,aAAa;IAKxB;;OAEG;IACH,YAAY,MAAc;QACxB,IAAI,CAAC,MAAM,GAAG,MAAM,CAAA;IACtB,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA+BG;IACG,QAAQ,CACZ,EAAU,EACV,KAA6C,EAC7C,OAAuB;;YAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,0BAA0B,EAAE,EAAE,EAC9B;gBACE,MAAM,EAAE,KAAK;gBACb,KAAK;gBACL,OAAO;aACR,CACF,CAAA;QACH,CAAC;KAAA;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA8CG;IACG,IAAI,CACR,KAA8C,EAC9C,OAAuB;;YAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,wBAAwB,EACxB;gBACE,MAAM,EAAE,KAAK;gBACb,OAAO;gBACP,KAAK;aACN,CACF,CAAA;QACH,CAAC;KAAA;IAED;;;;;;;;;;;;;;;;;OAiBG;IACG,MAAM,CACV,IAAwC,EACxC,KAA6C,EAC7C,OAAuB;;YAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,wBAAwB,EACxB;gBACE,MAAM,EAAE,MAAM;gBACd,OAAO;gBACP,IAAI;gBACJ,KAAK;aACN,CACF,CAAA;QACH,CAAC;KAAA;IAED;;;;;;;;;;;;;;;;;;OAkBG;IACG,MAAM,CACV,EAAU,EACV,IAAwC,EACxC,KAA6C,EAC7C,OAAuB;;YAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,0BAA0B,EAAE,EAAE,EAC9B;gBACE,MAAM,EAAE,MAAM;gBACd,OAAO;gBACP,IAAI;gBACJ,KAAK;aACN,CACF,CAAA;QACH,CAAC;KAAA;IAED;;;;;;;;;;;;;;OAcG;IACG,MAAM,CAAC,EAAU,EAAE,OAAuB;;YAC9C,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,0BAA0B,EAAE,EAAE,EAC9B;gBACE,MAAM,EAAE,QAAQ;gBAChB,OAAO;aACR,CACF,CAAA;QACH,CAAC;KAAA;IAED;;;;;;;;;;;;;;;;;;OAkBG;IACG,cAAc,CAClB,EAAU,EACV,IAA8B,EAC9B,OAAuB;;YAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,0BAA0B,EAAE,YAAY,EACxC;gBACE,MAAM,EAAE,MAAM;gBACd,OAAO;gBACP,IAAI;aACL,CACF,CAAA;QACH,CAAC;KAAA;CACF"}