@medusajs/js-sdk 2.0.0-preview-20241022094107 → 2.0.0-rc-20241022183311

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

@@ -1,4 +1,4 @@
-import { FindParams, HttpTypes, SelectParams } from "@medusajs/types";
+import { HttpTypes, SelectParams } from "@medusajs/types";
 import { Client } from "../client";
 import { ClientHeaders } from "../types";
 export declare class Customer {
@@ -10,18 +10,140 @@ export declare class Customer {
      * @ignore
      */
     constructor(client: Client);
-    create(body: HttpTypes.AdminCreateCustomer, query?: SelectParams, headers?: ClientHeaders): Promise<{
-        customer: HttpTypes.AdminCustomer;
-    }>;
-    update(id: string, body: HttpTypes.AdminUpdateCustomer, query?: SelectParams, headers?: ClientHeaders): Promise<{
-        customer: HttpTypes.AdminCustomer;
-    }>;
-    list(queryParams?: FindParams & HttpTypes.AdminCustomerFilters, headers?: ClientHeaders): Promise<HttpTypes.PaginatedResponse<{
-        customers: HttpTypes.AdminCustomer[];
-    }>>;
-    retrieve(id: string, query?: SelectParams, headers?: ClientHeaders): Promise<{
-        customer: HttpTypes.AdminCustomer;
-    }>;
+    /**
+     * This method creates a customer. It sends a request to the
+     * [Create Customer](https://docs.medusajs.com/v2/api/admin#customers_postcustomers) API route.
+     *
+     * @param body - The customer's details.
+     * @param query - Configure the fields to retrieve in the customer.
+     * @param headers - Headers to pass in the request.
+     * @returns The customer's details.
+     *
+     * @example
+     * sdk.admin.customer.create({
+     *   email: "customer@gmail.com"
+     * })
+     * .then(({ customer }) => {
+     *   console.log(customer)
+     * })
+     */
+    create(body: HttpTypes.AdminCreateCustomer, query?: SelectParams, headers?: ClientHeaders): Promise<HttpTypes.AdminCustomerResponse>;
+    /**
+     * This method updates a customer's details. It sends a request to the
+     * [Update Customer](https://docs.medusajs.com/v2/api/admin#customers_postcustomersid) API route.
+     *
+     * @param id - The customer's ID.
+     * @param body - The details to update of the customer.
+     * @param query - Configure the fields to retrieve in the customer.
+     * @param headers - Headers to pass in the request.
+     * @returns The customer's details.
+     *
+     * @example
+     * sdk.admin.customer.update("cus_123", {
+     *   first_name: "John"
+     * })
+     * .then(({ customer }) => {
+     *   console.log(customer)
+     * })
+     */
+    update(id: string, body: HttpTypes.AdminUpdateCustomer, query?: SelectParams, headers?: ClientHeaders): Promise<HttpTypes.AdminCustomerResponse>;
+    /**
+     * This method retrieves a paginated list of customers. It sends a request to the
+     * [List Customers](https://docs.medusajs.com/v2/api/admin#customers_getcustomers)
+     * API route.
+     *
+     * @param queryParams - Filters and pagination configurations.
+     * @param headers - Headers to pass in the request.
+     * @returns The paginated list of customers.
+     *
+     * @example
+     * To retrieve the list of customers:
+     *
+     * ```ts
+     * sdk.admin.customer.list()
+     * .then(({ customers, count, limit, offset }) => {
+     *   console.log(customers)
+     * })
+     * ```
+     *
+     * 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.customer.list({
+     *   limit: 10,
+     *   offset: 10
+     * })
+     * .then(({ customers, count, limit, offset }) => {
+     *   console.log(customers)
+     * })
+     * ```
+     *
+     * Using the `fields` query parameter, you can specify the fields and relations to retrieve
+     * in each customer:
+     *
+     * ```ts
+     * sdk.admin.customer.list({
+     *   fields: "id,*groups"
+     * })
+     * .then(({ customers, count, limit, offset }) => {
+     *   console.log(customers)
+     * })
+     * ```
+     *
+     * Learn more about the `fields` property in the [API reference](https://docs.medusajs.com/v2/api/store#select-fields-and-relations).
+     */
+    list(queryParams?: HttpTypes.AdminCustomerFilters, headers?: ClientHeaders): Promise<HttpTypes.AdminCustomerListResponse>;
+    /**
+     * This method retrieves a customer by its ID. It sends a request to the
+     * [Get Customer](https://docs.medusajs.com/v2/api/admin#customers_getcustomersid)
+     * API route.
+     *
+     * @param id - The customer's ID.
+     * @param query - Configure the fields to retrieve in the customer.
+     * @param headers - Headers to pass in the request.
+     * @returns The customer's details.
+     *
+     * @example
+     * To retrieve a customer by its ID:
+     *
+     * ```ts
+     * sdk.admin.customer.retrieve("cus_123")
+     * .then(({ customer }) => {
+     *   console.log(customer)
+     * })
+     * ```
+     *
+     * To specify the fields and relations to retrieve:
+     *
+     * ```ts
+     * sdk.admin.customer.retrieve("cus_123", {
+     *   fields: "id,*groups"
+     * })
+     * .then(({ customer }) => {
+     *   console.log(customer)
+     * })
+     * ```
+     *
+     * 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?: SelectParams, headers?: ClientHeaders): Promise<HttpTypes.AdminCustomerResponse>;
+    /**
+     * This method deletes a customer by its ID. It sends a request to the
+     * [Delete Customer](https://docs.medusajs.com/v2/api/admin#customers_deletecustomersid)
+     * API route.
+     *
+     * @param id - The customer's ID.
+     * @param headers - Headers to pass in the request.
+     * @returns The deletion's details.
+     *
+     * @example
+     * sdk.admin.customer.delete("cus_123")
+     * .then(({ deleted }) => {
+     *   console.log(deleted)
+     * })
+     */
     delete(id: string, headers?: ClientHeaders): Promise<HttpTypes.AdminCustomerDeleteResponse>;
 }
 //# sourceMappingURL=customer.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"customer.d.ts","sourceRoot":"","sources":["../../../src/admin/customer.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,UAAU,EACV,SAAS,EAET,YAAY,EACb,MAAM,iBAAiB,CAAA;AACxB,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,MAAM,CACV,IAAI,EAAE,SAAS,CAAC,mBAAmB,EACnC,KAAK,CAAC,EAAE,YAAY,EACpB,OAAO,CAAC,EAAE,aAAa;kBAGX,SAAS,CAAC,aAAa;;IAS/B,MAAM,CACV,EAAE,EAAE,MAAM,EACV,IAAI,EAAE,SAAS,CAAC,mBAAmB,EACnC,KAAK,CAAC,EAAE,YAAY,EACpB,OAAO,CAAC,EAAE,aAAa;kBAEc,SAAS,CAAC,aAAa;;IAWxD,IAAI,CACR,WAAW,CAAC,EAAE,UAAU,GAAG,SAAS,CAAC,oBAAoB,EACzD,OAAO,CAAC,EAAE,aAAa;mBAGU,SAAS,CAAC,aAAa,EAAE;;IAOtD,QAAQ,CAAC,EAAE,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,YAAY,EAAE,OAAO,CAAC,EAAE,aAAa;kBACjC,SAAS,CAAC,aAAa;;IASxD,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,aAAa;CASjD"}
+{"version":3,"file":"customer.d.ts","sourceRoot":"","sources":["../../../src/admin/customer.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,SAAS,EACT,YAAY,EACb,MAAM,iBAAiB,CAAA;AACxB,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;;;;;;;;;;;;;;;;OAgBG;IACG,MAAM,CACV,IAAI,EAAE,SAAS,CAAC,mBAAmB,EACnC,KAAK,CAAC,EAAE,YAAY,EACpB,OAAO,CAAC,EAAE,aAAa;IAYzB;;;;;;;;;;;;;;;;;OAiBG;IACG,MAAM,CACV,EAAE,EAAE,MAAM,EACV,IAAI,EAAE,SAAS,CAAC,mBAAmB,EACnC,KAAK,CAAC,EAAE,YAAY,EACpB,OAAO,CAAC,EAAE,aAAa;IAazB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA8CG;IACG,IAAI,CACR,WAAW,CAAC,EAAE,SAAS,CAAC,oBAAoB,EAC5C,OAAO,CAAC,EAAE,aAAa;IAUzB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAgCG;IACG,QAAQ,CAAC,EAAE,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,YAAY,EAAE,OAAO,CAAC,EAAE,aAAa;IAUxE;;;;;;;;;;;;;;OAcG;IACG,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,aAAa;CASjD"}

package/dist/esm/admin/customer.js

@@ -14,6 +14,23 @@ export class Customer {
     constructor(client) {
         this.client = client;
     }
+    /**
+     * This method creates a customer. It sends a request to the
+     * [Create Customer](https://docs.medusajs.com/v2/api/admin#customers_postcustomers) API route.
+     *
+     * @param body - The customer's details.
+     * @param query - Configure the fields to retrieve in the customer.
+     * @param headers - Headers to pass in the request.
+     * @returns The customer's details.
+     *
+     * @example
+     * sdk.admin.customer.create({
+     *   email: "customer@gmail.com"
+     * })
+     * .then(({ customer }) => {
+     *   console.log(customer)
+     * })
+     */
     create(body, query, headers) {
         return __awaiter(this, void 0, void 0, function* () {
             return this.client.fetch(`/admin/customers`, {
@@ -24,6 +41,24 @@ export class Customer {
             });
         });
     }
+    /**
+     * This method updates a customer's details. It sends a request to the
+     * [Update Customer](https://docs.medusajs.com/v2/api/admin#customers_postcustomersid) API route.
+     *
+     * @param id - The customer's ID.
+     * @param body - The details to update of the customer.
+     * @param query - Configure the fields to retrieve in the customer.
+     * @param headers - Headers to pass in the request.
+     * @returns The customer's details.
+     *
+     * @example
+     * sdk.admin.customer.update("cus_123", {
+     *   first_name: "John"
+     * })
+     * .then(({ customer }) => {
+     *   console.log(customer)
+     * })
+     */
     update(id, body, query, headers) {
         return __awaiter(this, void 0, void 0, function* () {
             return this.client.fetch(`/admin/customers/${id}`, {
@@ -34,6 +69,53 @@ export class Customer {
             });
         });
     }
+    /**
+     * This method retrieves a paginated list of customers. It sends a request to the
+     * [List Customers](https://docs.medusajs.com/v2/api/admin#customers_getcustomers)
+     * API route.
+     *
+     * @param queryParams - Filters and pagination configurations.
+     * @param headers - Headers to pass in the request.
+     * @returns The paginated list of customers.
+     *
+     * @example
+     * To retrieve the list of customers:
+     *
+     * ```ts
+     * sdk.admin.customer.list()
+     * .then(({ customers, count, limit, offset }) => {
+     *   console.log(customers)
+     * })
+     * ```
+     *
+     * 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.customer.list({
+     *   limit: 10,
+     *   offset: 10
+     * })
+     * .then(({ customers, count, limit, offset }) => {
+     *   console.log(customers)
+     * })
+     * ```
+     *
+     * Using the `fields` query parameter, you can specify the fields and relations to retrieve
+     * in each customer:
+     *
+     * ```ts
+     * sdk.admin.customer.list({
+     *   fields: "id,*groups"
+     * })
+     * .then(({ customers, count, limit, offset }) => {
+     *   console.log(customers)
+     * })
+     * ```
+     *
+     * Learn more about the `fields` property in the [API reference](https://docs.medusajs.com/v2/api/store#select-fields-and-relations).
+     */
     list(queryParams, headers) {
         return __awaiter(this, void 0, void 0, function* () {
             return this.client.fetch(`/admin/customers`, {
@@ -42,6 +124,39 @@ export class Customer {
             });
         });
     }
+    /**
+     * This method retrieves a customer by its ID. It sends a request to the
+     * [Get Customer](https://docs.medusajs.com/v2/api/admin#customers_getcustomersid)
+     * API route.
+     *
+     * @param id - The customer's ID.
+     * @param query - Configure the fields to retrieve in the customer.
+     * @param headers - Headers to pass in the request.
+     * @returns The customer's details.
+     *
+     * @example
+     * To retrieve a customer by its ID:
+     *
+     * ```ts
+     * sdk.admin.customer.retrieve("cus_123")
+     * .then(({ customer }) => {
+     *   console.log(customer)
+     * })
+     * ```
+     *
+     * To specify the fields and relations to retrieve:
+     *
+     * ```ts
+     * sdk.admin.customer.retrieve("cus_123", {
+     *   fields: "id,*groups"
+     * })
+     * .then(({ customer }) => {
+     *   console.log(customer)
+     * })
+     * ```
+     *
+     * 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 this.client.fetch(`/admin/customers/${id}`, {
@@ -50,6 +165,21 @@ export class Customer {
             });
         });
     }
+    /**
+     * This method deletes a customer by its ID. It sends a request to the
+     * [Delete Customer](https://docs.medusajs.com/v2/api/admin#customers_deletecustomersid)
+     * API route.
+     *
+     * @param id - The customer's ID.
+     * @param headers - Headers to pass in the request.
+     * @returns The deletion's details.
+     *
+     * @example
+     * sdk.admin.customer.delete("cus_123")
+     * .then(({ deleted }) => {
+     *   console.log(deleted)
+     * })
+     */
     delete(id, headers) {
         return __awaiter(this, void 0, void 0, function* () {
             return this.client.fetch(`/admin/customers/${id}`, {

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

@@ -1 +1 @@
-{"version":3,"file":"customer.js","sourceRoot":"","sources":["../../../src/admin/customer.ts"],"names":[],"mappings":";;;;;;;;;AASA,MAAM,OAAO,QAAQ;IAKnB;;OAEG;IACH,YAAY,MAAc;QACxB,IAAI,CAAC,MAAM,GAAG,MAAM,CAAA;IACtB,CAAC;IAEK,MAAM,CACV,IAAmC,EACnC,KAAoB,EACpB,OAAuB;;YAEvB,OAAO,IAAI,CAAC,MAAM,CAAC,KAAK,CAErB,kBAAkB,EAAE;gBACrB,MAAM,EAAE,MAAM;gBACd,OAAO;gBACP,IAAI;gBACJ,KAAK;aACN,CAAC,CAAA;QACJ,CAAC;KAAA;IAEK,MAAM,CACV,EAAU,EACV,IAAmC,EACnC,KAAoB,EACpB,OAAuB;;YAEvB,OAAO,IAAI,CAAC,MAAM,CAAC,KAAK,CACtB,oBAAoB,EAAE,EAAE,EACxB;gBACE,MAAM,EAAE,MAAM;gBACd,OAAO;gBACP,IAAI;gBACJ,KAAK;aACN,CACF,CAAA;QACH,CAAC;KAAA;IAEK,IAAI,CACR,WAAyD,EACzD,OAAuB;;YAEvB,OAAO,IAAI,CAAC,MAAM,CAAC,KAAK,CAEtB,kBAAkB,EAAE;gBACpB,OAAO;gBACP,KAAK,EAAE,WAAW;aACnB,CAAC,CAAA;QACJ,CAAC;KAAA;IAEK,QAAQ,CAAC,EAAU,EAAE,KAAoB,EAAE,OAAuB;;YACtE,OAAO,IAAI,CAAC,MAAM,CAAC,KAAK,CACtB,oBAAoB,EAAE,EAAE,EACxB;gBACE,KAAK;gBACL,OAAO;aACR,CACF,CAAA;QACH,CAAC;KAAA;IAEK,MAAM,CAAC,EAAU,EAAE,OAAuB;;YAC9C,OAAO,IAAI,CAAC,MAAM,CAAC,KAAK,CACtB,oBAAoB,EAAE,EAAE,EACxB;gBACE,MAAM,EAAE,QAAQ;gBAChB,OAAO;aACR,CACF,CAAA;QACH,CAAC;KAAA;CACF"}
+{"version":3,"file":"customer.js","sourceRoot":"","sources":["../../../src/admin/customer.ts"],"names":[],"mappings":";;;;;;;;;AAOA,MAAM,OAAO,QAAQ;IAKnB;;OAEG;IACH,YAAY,MAAc;QACxB,IAAI,CAAC,MAAM,GAAG,MAAM,CAAA;IACtB,CAAC;IAED;;;;;;;;;;;;;;;;OAgBG;IACG,MAAM,CACV,IAAmC,EACnC,KAAoB,EACpB,OAAuB;;YAEvB,OAAO,IAAI,CAAC,MAAM,CAAC,KAAK,CAEtB,kBAAkB,EAAE;gBACpB,MAAM,EAAE,MAAM;gBACd,OAAO;gBACP,IAAI;gBACJ,KAAK;aACN,CAAC,CAAA;QACJ,CAAC;KAAA;IAED;;;;;;;;;;;;;;;;;OAiBG;IACG,MAAM,CACV,EAAU,EACV,IAAmC,EACnC,KAAoB,EACpB,OAAuB;;YAEvB,OAAO,IAAI,CAAC,MAAM,CAAC,KAAK,CACtB,oBAAoB,EAAE,EAAE,EACxB;gBACE,MAAM,EAAE,MAAM;gBACd,OAAO;gBACP,IAAI;gBACJ,KAAK;aACN,CACF,CAAA;QACH,CAAC;KAAA;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA8CG;IACG,IAAI,CACR,WAA4C,EAC5C,OAAuB;;YAEvB,OAAO,IAAI,CAAC,MAAM,CAAC,KAAK,CAEtB,kBAAkB,EAAE;gBACpB,OAAO;gBACP,KAAK,EAAE,WAAW;aACnB,CAAC,CAAA;QACJ,CAAC;KAAA;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAgCG;IACG,QAAQ,CAAC,EAAU,EAAE,KAAoB,EAAE,OAAuB;;YACtE,OAAO,IAAI,CAAC,MAAM,CAAC,KAAK,CACtB,oBAAoB,EAAE,EAAE,EACxB;gBACE,KAAK;gBACL,OAAO;aACR,CACF,CAAA;QACH,CAAC;KAAA;IAED;;;;;;;;;;;;;;OAcG;IACG,MAAM,CAAC,EAAU,EAAE,OAAuB;;YAC9C,OAAO,IAAI,CAAC,MAAM,CAAC,KAAK,CACtB,oBAAoB,EAAE,EAAE,EACxB;gBACE,MAAM,EAAE,QAAQ;gBAChB,OAAO;aACR,CACF,CAAA;QACH,CAAC;KAAA;CACF"}