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

package/dist/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/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/admin/customer.js

@@ -8,6 +8,23 @@ 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)
+     * })
+     */
     async create(body, query, headers) {
         return this.client.fetch(`/admin/customers`, {
             method: "POST",
@@ -16,6 +33,24 @@ class Customer {
             query,
         });
     }
+    /**
+     * 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)
+     * })
+     */
     async update(id, body, query, headers) {
         return this.client.fetch(`/admin/customers/${id}`, {
             method: "POST",
@@ -24,18 +59,113 @@ class Customer {
             query,
         });
     }
+    /**
+     * 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).
+     */
     async list(queryParams, headers) {
         return this.client.fetch(`/admin/customers`, {
             headers,
             query: queryParams,
         });
     }
+    /**
+     * 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).
+     */
     async retrieve(id, query, headers) {
         return this.client.fetch(`/admin/customers/${id}`, {
             query,
             headers,
         });
     }
+    /**
+     * 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)
+     * })
+     */
     async delete(id, headers) {
         return this.client.fetch(`/admin/customers/${id}`, {
             method: "DELETE",

package/dist/admin/customer.js.map

@@ -1 +1 @@
-{"version":3,"file":"customer.js","sourceRoot":"","sources":["../../src/admin/customer.ts"],"names":[],"mappings":";;;AASA,MAAa,QAAQ;IAKnB;;OAEG;IACH,YAAY,MAAc;QACxB,IAAI,CAAC,MAAM,GAAG,MAAM,CAAA;IACtB,CAAC;IAED,KAAK,CAAC,MAAM,CACV,IAAmC,EACnC,KAAoB,EACpB,OAAuB;QAEvB,OAAO,IAAI,CAAC,MAAM,CAAC,KAAK,CAErB,kBAAkB,EAAE;YACrB,MAAM,EAAE,MAAM;YACd,OAAO;YACP,IAAI;YACJ,KAAK;SACN,CAAC,CAAA;IACJ,CAAC;IAED,KAAK,CAAC,MAAM,CACV,EAAU,EACV,IAAmC,EACnC,KAAoB,EACpB,OAAuB;QAEvB,OAAO,IAAI,CAAC,MAAM,CAAC,KAAK,CACtB,oBAAoB,EAAE,EAAE,EACxB;YACE,MAAM,EAAE,MAAM;YACd,OAAO;YACP,IAAI;YACJ,KAAK;SACN,CACF,CAAA;IACH,CAAC;IAED,KAAK,CAAC,IAAI,CACR,WAAyD,EACzD,OAAuB;QAEvB,OAAO,IAAI,CAAC,MAAM,CAAC,KAAK,CAEtB,kBAAkB,EAAE;YACpB,OAAO;YACP,KAAK,EAAE,WAAW;SACnB,CAAC,CAAA;IACJ,CAAC;IAED,KAAK,CAAC,QAAQ,CAAC,EAAU,EAAE,KAAoB,EAAE,OAAuB;QACtE,OAAO,IAAI,CAAC,MAAM,CAAC,KAAK,CACtB,oBAAoB,EAAE,EAAE,EACxB;YACE,KAAK;YACL,OAAO;SACR,CACF,CAAA;IACH,CAAC;IAED,KAAK,CAAC,MAAM,CAAC,EAAU,EAAE,OAAuB;QAC9C,OAAO,IAAI,CAAC,MAAM,CAAC,KAAK,CACtB,oBAAoB,EAAE,EAAE,EACxB;YACE,MAAM,EAAE,QAAQ;YAChB,OAAO;SACR,CACF,CAAA;IACH,CAAC;CACF;AA3ED,4BA2EC"}
+{"version":3,"file":"customer.js","sourceRoot":"","sources":["../../src/admin/customer.ts"],"names":[],"mappings":";;;AAOA,MAAa,QAAQ;IAKnB;;OAEG;IACH,YAAY,MAAc;QACxB,IAAI,CAAC,MAAM,GAAG,MAAM,CAAA;IACtB,CAAC;IAED;;;;;;;;;;;;;;;;OAgBG;IACH,KAAK,CAAC,MAAM,CACV,IAAmC,EACnC,KAAoB,EACpB,OAAuB;QAEvB,OAAO,IAAI,CAAC,MAAM,CAAC,KAAK,CAEtB,kBAAkB,EAAE;YACpB,MAAM,EAAE,MAAM;YACd,OAAO;YACP,IAAI;YACJ,KAAK;SACN,CAAC,CAAA;IACJ,CAAC;IAED;;;;;;;;;;;;;;;;;OAiBG;IACH,KAAK,CAAC,MAAM,CACV,EAAU,EACV,IAAmC,EACnC,KAAoB,EACpB,OAAuB;QAEvB,OAAO,IAAI,CAAC,MAAM,CAAC,KAAK,CACtB,oBAAoB,EAAE,EAAE,EACxB;YACE,MAAM,EAAE,MAAM;YACd,OAAO;YACP,IAAI;YACJ,KAAK;SACN,CACF,CAAA;IACH,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA8CG;IACH,KAAK,CAAC,IAAI,CACR,WAA4C,EAC5C,OAAuB;QAEvB,OAAO,IAAI,CAAC,MAAM,CAAC,KAAK,CAEtB,kBAAkB,EAAE;YACpB,OAAO;YACP,KAAK,EAAE,WAAW;SACnB,CAAC,CAAA;IACJ,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAgCG;IACH,KAAK,CAAC,QAAQ,CAAC,EAAU,EAAE,KAAoB,EAAE,OAAuB;QACtE,OAAO,IAAI,CAAC,MAAM,CAAC,KAAK,CACtB,oBAAoB,EAAE,EAAE,EACxB;YACE,KAAK;YACL,OAAO;SACR,CACF,CAAA;IACH,CAAC;IAED;;;;;;;;;;;;;;OAcG;IACH,KAAK,CAAC,MAAM,CAAC,EAAU,EAAE,OAAuB;QAC9C,OAAO,IAAI,CAAC,MAAM,CAAC,KAAK,CACtB,oBAAoB,EAAE,EAAE,EACxB;YACE,MAAM,EAAE,QAAQ;YAChB,OAAO;SACR,CACF,CAAA;IACH,CAAC;CACF;AA7MD,4BA6MC"}