@medusajs/js-sdk 2.0.0 → 2.0.1-preview-20241025150152

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

@@ -10,11 +10,160 @@ export declare class ProductCollection {
      * @ignore
      */
     constructor(client: Client);
+    /**
+     * This method creates a product collection. It sends a request to the
+     * [Create Collection](https://docs.medusajs.com/api/admin#collections_postcollections)
+     * API route.
+     *
+     * @param body - The details of the product collection to create.
+     * @param query - Configure the fields to retrieve in the product collection.
+     * @param headers - Headers to pass in the request
+     * @returns The product collection's details.
+     *
+     * @example
+     * sdk.admin.productCollection.create({
+     *   title: "Summer Collection"
+     * })
+     * .then(({ collection }) => {
+     *   console.log(collection)
+     * })
+     */
     create(body: HttpTypes.AdminCreateCollection, query?: HttpTypes.AdminCollectionParams, headers?: ClientHeaders): Promise<HttpTypes.AdminCollectionResponse>;
+    /**
+     * This method updates a collection. It sends a request to the
+     * [Update Collection](https://docs.medusajs.com/api/admin#collections_postcollectionsid)
+     * API route.
+     *
+     * @param id - The ID of the collection.
+     * @param body - The data to update in the collection.
+     * @param query - Configure the fields to retrieve in the product collection.
+     * @param headers - Headers to pass in the request
+     * @returns The product collection's details.
+     *
+     * @example
+     * sdk.admin.productCollection.update("pcol_123", {
+     *   title: "Summer Collection"
+     * })
+     * .then(({ collection }) => {
+     *   console.log(collection)
+     * })
+     */
     update(id: string, body: HttpTypes.AdminUpdateCollection, query?: HttpTypes.AdminCollectionParams, headers?: ClientHeaders): Promise<HttpTypes.AdminCollectionResponse>;
+    /**
+     * This method retrieves a paginated list of collections. It sends a request to the
+     * [List Collections](https://docs.medusajs.com/api/admin#collections_getcollections) API route.
+     *
+     * @param query - Filters and pagination configurations.
+     * @param headers - Headers to pass in the request.
+     * @returns The paginated list of collections.
+     *
+     * @example
+     * To retrieve the list of collections:
+     *
+     * ```ts
+     * sdk.admin.productCollection.list()
+     * .then(({ collections, count, limit, offset }) => {
+     *   console.log(collections)
+     * })
+     * ```
+     *
+     * 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.productCollection.list({
+     *   limit: 10,
+     *   offset: 10
+     * })
+     * .then(({ collections, count, limit, offset }) => {
+     *   console.log(collections)
+     * })
+     * ```
+     *
+     * Using the `fields` query parameter, you can specify the fields and relations to retrieve
+     * in each collection:
+     *
+     * ```ts
+     * sdk.admin.productCollection.list({
+     *   fields: "id,*products"
+     * })
+     * .then(({ collections, count, limit, offset }) => {
+     *   console.log(collections)
+     * })
+     * ```
+     *
+     * Learn more about the `fields` property in the [API reference](https://docs.medusajs.com/api/store#select-fields-and-relations).
+     */
     list(queryParams?: HttpTypes.AdminCollectionListParams, headers?: ClientHeaders): Promise<HttpTypes.AdminCollectionListResponse>;
+    /**
+     * This method retrieves a collection by its ID. It sends a request to the
+     * [Get Collection](https://docs.medusajs.com/api/admin#collections_getcollectionsid) API route.
+     *
+     * @param id - The collection's ID.
+     * @param query - Configure the fields to retrieve in the collection.
+     * @param headers - Headers to pass in the request
+     * @returns The collection's details.
+     *
+     * @example
+     * To retrieve a collection by its ID:
+     *
+     * ```ts
+     * sdk.admin.productCollection.retrieve("pcol_123")
+     * .then(({ collection }) => {
+     *   console.log(collection)
+     * })
+     * ```
+     *
+     * To specify the fields and relations to retrieve:
+     *
+     * ```ts
+     * sdk.admin.productCollection.retrieve("pcol_123", {
+     *   fields: "id,*products"
+     * })
+     * .then(({ collection }) => {
+     *   console.log(collection)
+     * })
+     * ```
+     *
+     * Learn more about the `fields` property in the [API reference](https://docs.medusajs.com/api/store#select-fields-and-relations).
+     */
     retrieve(id: string, query?: HttpTypes.AdminCollectionParams, headers?: ClientHeaders): Promise<HttpTypes.AdminCollectionResponse>;
+    /**
+     * This method deletes a product collection. It sends a request to the
+     * [Delete Collection](https://docs.medusajs.com/api/admin#collections_deletecollectionsid)
+     * API route.
+     *
+     * @param id - The collection's ID.
+     * @param headers - Headers to pass in the request
+     * @returns The deletion's details.
+     *
+     * @example
+     * sdk.admin.productCollection.delete("pcol_123")
+     * .then(({ deleted }) => {
+     *   console.log(deleted)
+     * })
+     */
     delete(id: string, headers?: ClientHeaders): Promise<HttpTypes.AdminCollectionDeleteResponse>;
+    /**
+     * This method manages the products of a collection to add or remove them. It sends a request
+     * to the [Manage Products](https://docs.medusajs.com/api/admin#collections_postcollectionsidproducts)
+     * API route.
+     *
+     * @param id - The collection's ID.
+     * @param body - The products to add or remove.
+     * @param headers - Headers to pass in the request
+     * @returns The product category's details.
+     *
+     * @example
+     * sdk.admin.productCollection.updateProducts("pcol_123", {
+     *   add: ["prod_123"],
+     *   remove: ["prod_321"]
+     * })
+     * .then(({ collection }) => {
+     *   console.log(collection)
+     * })
+     */
     updateProducts(id: string, body: HttpTypes.AdminUpdateCollectionProducts, headers?: ClientHeaders): Promise<HttpTypes.AdminCollectionResponse>;
 }
 //# sourceMappingURL=product-collection.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"product-collection.d.ts","sourceRoot":"","sources":["../../../src/admin/product-collection.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,iBAAiB;IAC5B;;OAEG;IACH,OAAO,CAAC,MAAM,CAAQ;IACtB;;OAEG;gBACS,MAAM,EAAE,MAAM;IAIpB,MAAM,CACV,IAAI,EAAE,SAAS,CAAC,qBAAqB,EACrC,KAAK,CAAC,EAAE,SAAS,CAAC,qBAAqB,EACvC,OAAO,CAAC,EAAE,aAAa;IAYnB,MAAM,CACV,EAAE,EAAE,MAAM,EACV,IAAI,EAAE,SAAS,CAAC,qBAAqB,EACrC,KAAK,CAAC,EAAE,SAAS,CAAC,qBAAqB,EACvC,OAAO,CAAC,EAAE,aAAa;IAanB,IAAI,CACR,WAAW,CAAC,EAAE,SAAS,CAAC,yBAAyB,EACjD,OAAO,CAAC,EAAE,aAAa;IAWnB,QAAQ,CACZ,EAAE,EAAE,MAAM,EACV,KAAK,CAAC,EAAE,SAAS,CAAC,qBAAqB,EACvC,OAAO,CAAC,EAAE,aAAa;IAWnB,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,aAAa;IAU1C,cAAc,CAClB,EAAE,EAAE,MAAM,EACV,IAAI,EAAE,SAAS,CAAC,6BAA6B,EAC7C,OAAO,CAAC,EAAE,aAAa;CAW1B"}
+{"version":3,"file":"product-collection.d.ts","sourceRoot":"","sources":["../../../src/admin/product-collection.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,iBAAiB;IAC5B;;OAEG;IACH,OAAO,CAAC,MAAM,CAAQ;IACtB;;OAEG;gBACS,MAAM,EAAE,MAAM;IAI1B;;;;;;;;;;;;;;;;;OAiBG;IACG,MAAM,CACV,IAAI,EAAE,SAAS,CAAC,qBAAqB,EACrC,KAAK,CAAC,EAAE,SAAS,CAAC,qBAAqB,EACvC,OAAO,CAAC,EAAE,aAAa;IAazB;;;;;;;;;;;;;;;;;;OAkBG;IACG,MAAM,CACV,EAAE,EAAE,MAAM,EACV,IAAI,EAAE,SAAS,CAAC,qBAAqB,EACrC,KAAK,CAAC,EAAE,SAAS,CAAC,qBAAqB,EACvC,OAAO,CAAC,EAAE,aAAa;IAazB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA6CG;IACG,IAAI,CACR,WAAW,CAAC,EAAE,SAAS,CAAC,yBAAyB,EACjD,OAAO,CAAC,EAAE,aAAa;IAWzB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA+BG;IACG,QAAQ,CACZ,EAAE,EAAE,MAAM,EACV,KAAK,CAAC,EAAE,SAAS,CAAC,qBAAqB,EACvC,OAAO,CAAC,EAAE,aAAa;IAWzB;;;;;;;;;;;;;;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,6BAA6B,EAC7C,OAAO,CAAC,EAAE,aAAa;CAW1B"}

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

@@ -14,6 +14,24 @@ export class ProductCollection {
     constructor(client) {
         this.client = client;
     }
+    /**
+     * This method creates a product collection. It sends a request to the
+     * [Create Collection](https://docs.medusajs.com/api/admin#collections_postcollections)
+     * API route.
+     *
+     * @param body - The details of the product collection to create.
+     * @param query - Configure the fields to retrieve in the product collection.
+     * @param headers - Headers to pass in the request
+     * @returns The product collection's details.
+     *
+     * @example
+     * sdk.admin.productCollection.create({
+     *   title: "Summer Collection"
+     * })
+     * .then(({ collection }) => {
+     *   console.log(collection)
+     * })
+     */
     create(body, query, headers) {
         return __awaiter(this, void 0, void 0, function* () {
             return this.client.fetch(`/admin/collections`, {
@@ -24,6 +42,25 @@ export class ProductCollection {
             });
         });
     }
+    /**
+     * This method updates a collection. It sends a request to the
+     * [Update Collection](https://docs.medusajs.com/api/admin#collections_postcollectionsid)
+     * API route.
+     *
+     * @param id - The ID of the collection.
+     * @param body - The data to update in the collection.
+     * @param query - Configure the fields to retrieve in the product collection.
+     * @param headers - Headers to pass in the request
+     * @returns The product collection's details.
+     *
+     * @example
+     * sdk.admin.productCollection.update("pcol_123", {
+     *   title: "Summer Collection"
+     * })
+     * .then(({ collection }) => {
+     *   console.log(collection)
+     * })
+     */
     update(id, body, query, headers) {
         return __awaiter(this, void 0, void 0, function* () {
             return this.client.fetch(`/admin/collections/${id}`, {
@@ -34,6 +71,52 @@ export class ProductCollection {
             });
         });
     }
+    /**
+     * This method retrieves a paginated list of collections. It sends a request to the
+     * [List Collections](https://docs.medusajs.com/api/admin#collections_getcollections) API route.
+     *
+     * @param query - Filters and pagination configurations.
+     * @param headers - Headers to pass in the request.
+     * @returns The paginated list of collections.
+     *
+     * @example
+     * To retrieve the list of collections:
+     *
+     * ```ts
+     * sdk.admin.productCollection.list()
+     * .then(({ collections, count, limit, offset }) => {
+     *   console.log(collections)
+     * })
+     * ```
+     *
+     * 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.productCollection.list({
+     *   limit: 10,
+     *   offset: 10
+     * })
+     * .then(({ collections, count, limit, offset }) => {
+     *   console.log(collections)
+     * })
+     * ```
+     *
+     * Using the `fields` query parameter, you can specify the fields and relations to retrieve
+     * in each collection:
+     *
+     * ```ts
+     * sdk.admin.productCollection.list({
+     *   fields: "id,*products"
+     * })
+     * .then(({ collections, count, limit, offset }) => {
+     *   console.log(collections)
+     * })
+     * ```
+     *
+     * Learn more about the `fields` property in the [API reference](https://docs.medusajs.com/api/store#select-fields-and-relations).
+     */
     list(queryParams, headers) {
         return __awaiter(this, void 0, void 0, function* () {
             return this.client.fetch(`/admin/collections`, {
@@ -42,6 +125,38 @@ export class ProductCollection {
             });
         });
     }
+    /**
+     * This method retrieves a collection by its ID. It sends a request to the
+     * [Get Collection](https://docs.medusajs.com/api/admin#collections_getcollectionsid) API route.
+     *
+     * @param id - The collection's ID.
+     * @param query - Configure the fields to retrieve in the collection.
+     * @param headers - Headers to pass in the request
+     * @returns The collection's details.
+     *
+     * @example
+     * To retrieve a collection by its ID:
+     *
+     * ```ts
+     * sdk.admin.productCollection.retrieve("pcol_123")
+     * .then(({ collection }) => {
+     *   console.log(collection)
+     * })
+     * ```
+     *
+     * To specify the fields and relations to retrieve:
+     *
+     * ```ts
+     * sdk.admin.productCollection.retrieve("pcol_123", {
+     *   fields: "id,*products"
+     * })
+     * .then(({ collection }) => {
+     *   console.log(collection)
+     * })
+     * ```
+     *
+     * Learn more about the `fields` property in the [API reference](https://docs.medusajs.com/api/store#select-fields-and-relations).
+     */
     retrieve(id, query, headers) {
         return __awaiter(this, void 0, void 0, function* () {
             return this.client.fetch(`/admin/collections/${id}`, {
@@ -50,6 +165,21 @@ export class ProductCollection {
             });
         });
     }
+    /**
+     * This method deletes a product collection. It sends a request to the
+     * [Delete Collection](https://docs.medusajs.com/api/admin#collections_deletecollectionsid)
+     * API route.
+     *
+     * @param id - The collection's ID.
+     * @param headers - Headers to pass in the request
+     * @returns The deletion's details.
+     *
+     * @example
+     * sdk.admin.productCollection.delete("pcol_123")
+     * .then(({ deleted }) => {
+     *   console.log(deleted)
+     * })
+     */
     delete(id, headers) {
         return __awaiter(this, void 0, void 0, function* () {
             return this.client.fetch(`/admin/collections/${id}`, {
@@ -58,6 +188,25 @@ export class ProductCollection {
             });
         });
     }
+    /**
+     * This method manages the products of a collection to add or remove them. It sends a request
+     * to the [Manage Products](https://docs.medusajs.com/api/admin#collections_postcollectionsidproducts)
+     * API route.
+     *
+     * @param id - The collection's ID.
+     * @param body - The products to add or remove.
+     * @param headers - Headers to pass in the request
+     * @returns The product category's details.
+     *
+     * @example
+     * sdk.admin.productCollection.updateProducts("pcol_123", {
+     *   add: ["prod_123"],
+     *   remove: ["prod_321"]
+     * })
+     * .then(({ collection }) => {
+     *   console.log(collection)
+     * })
+     */
     updateProducts(id, body, headers) {
         return __awaiter(this, void 0, void 0, function* () {
             return this.client.fetch(`/admin/collections/${id}/products`, {

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

@@ -1 +1 @@
-{"version":3,"file":"product-collection.js","sourceRoot":"","sources":["../../../src/admin/product-collection.ts"],"names":[],"mappings":";;;;;;;;;AAIA,MAAM,OAAO,iBAAiB;IAK5B;;OAEG;IACH,YAAY,MAAc;QACxB,IAAI,CAAC,MAAM,GAAG,MAAM,CAAA;IACtB,CAAC;IAEK,MAAM,CACV,IAAqC,EACrC,KAAuC,EACvC,OAAuB;;YAEvB,OAAO,IAAI,CAAC,MAAM,CAAC,KAAK,CACtB,oBAAoB,EACpB;gBACE,MAAM,EAAE,MAAM;gBACd,OAAO;gBACP,IAAI;gBACJ,KAAK;aACN,CACF,CAAA;QACH,CAAC;KAAA;IACK,MAAM,CACV,EAAU,EACV,IAAqC,EACrC,KAAuC,EACvC,OAAuB;;YAEvB,OAAO,IAAI,CAAC,MAAM,CAAC,KAAK,CACtB,sBAAsB,EAAE,EAAE,EAC1B;gBACE,MAAM,EAAE,MAAM;gBACd,OAAO;gBACP,IAAI;gBACJ,KAAK;aACN,CACF,CAAA;QACH,CAAC;KAAA;IAEK,IAAI,CACR,WAAiD,EACjD,OAAuB;;YAEvB,OAAO,IAAI,CAAC,MAAM,CAAC,KAAK,CACtB,oBAAoB,EACpB;gBACE,OAAO;gBACP,KAAK,EAAE,WAAW;aACnB,CACF,CAAA;QACH,CAAC;KAAA;IAEK,QAAQ,CACZ,EAAU,EACV,KAAuC,EACvC,OAAuB;;YAEvB,OAAO,IAAI,CAAC,MAAM,CAAC,KAAK,CACtB,sBAAsB,EAAE,EAAE,EAC1B;gBACE,KAAK;gBACL,OAAO;aACR,CACF,CAAA;QACH,CAAC;KAAA;IAEK,MAAM,CAAC,EAAU,EAAE,OAAuB;;YAC9C,OAAO,IAAI,CAAC,MAAM,CAAC,KAAK,CACtB,sBAAsB,EAAE,EAAE,EAC1B;gBACE,MAAM,EAAE,QAAQ;gBAChB,OAAO;aACR,CACF,CAAA;QACH,CAAC;KAAA;IAEK,cAAc,CAClB,EAAU,EACV,IAA6C,EAC7C,OAAuB;;YAEvB,OAAO,IAAI,CAAC,MAAM,CAAC,KAAK,CACtB,sBAAsB,EAAE,WAAW,EACnC;gBACE,MAAM,EAAE,MAAM;gBACd,OAAO;gBACP,IAAI;aACL,CACF,CAAA;QACH,CAAC;KAAA;CACF"}
+{"version":3,"file":"product-collection.js","sourceRoot":"","sources":["../../../src/admin/product-collection.ts"],"names":[],"mappings":";;;;;;;;;AAIA,MAAM,OAAO,iBAAiB;IAK5B;;OAEG;IACH,YAAY,MAAc;QACxB,IAAI,CAAC,MAAM,GAAG,MAAM,CAAA;IACtB,CAAC;IAED;;;;;;;;;;;;;;;;;OAiBG;IACG,MAAM,CACV,IAAqC,EACrC,KAAuC,EACvC,OAAuB;;YAEvB,OAAO,IAAI,CAAC,MAAM,CAAC,KAAK,CACtB,oBAAoB,EACpB;gBACE,MAAM,EAAE,MAAM;gBACd,OAAO;gBACP,IAAI;gBACJ,KAAK;aACN,CACF,CAAA;QACH,CAAC;KAAA;IAED;;;;;;;;;;;;;;;;;;OAkBG;IACG,MAAM,CACV,EAAU,EACV,IAAqC,EACrC,KAAuC,EACvC,OAAuB;;YAEvB,OAAO,IAAI,CAAC,MAAM,CAAC,KAAK,CACtB,sBAAsB,EAAE,EAAE,EAC1B;gBACE,MAAM,EAAE,MAAM;gBACd,OAAO;gBACP,IAAI;gBACJ,KAAK;aACN,CACF,CAAA;QACH,CAAC;KAAA;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA6CG;IACG,IAAI,CACR,WAAiD,EACjD,OAAuB;;YAEvB,OAAO,IAAI,CAAC,MAAM,CAAC,KAAK,CACtB,oBAAoB,EACpB;gBACE,OAAO;gBACP,KAAK,EAAE,WAAW;aACnB,CACF,CAAA;QACH,CAAC;KAAA;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA+BG;IACG,QAAQ,CACZ,EAAU,EACV,KAAuC,EACvC,OAAuB;;YAEvB,OAAO,IAAI,CAAC,MAAM,CAAC,KAAK,CACtB,sBAAsB,EAAE,EAAE,EAC1B;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,sBAAsB,EAAE,EAAE,EAC1B;gBACE,MAAM,EAAE,QAAQ;gBAChB,OAAO;aACR,CACF,CAAA;QACH,CAAC;KAAA;IAED;;;;;;;;;;;;;;;;;;OAkBG;IACG,cAAc,CAClB,EAAU,EACV,IAA6C,EAC7C,OAAuB;;YAEvB,OAAO,IAAI,CAAC,MAAM,CAAC,KAAK,CACtB,sBAAsB,EAAE,WAAW,EACnC;gBACE,MAAM,EAAE,MAAM;gBACd,OAAO;gBACP,IAAI;aACL,CACF,CAAA;QACH,CAAC;KAAA;CACF"}

package/dist/esm/auth/index.d.ts

@@ -7,7 +7,7 @@ export declare class Auth {
     constructor(client: Client, config: Config);
     /**
      * This method is used to retrieve a registration JWT token for a user, customer, or custom actor type. It sends a request to the
-     * [Retrieve Registration Token API route](https://docs.medusajs.com/v2/api/store#auth_postactor_typeauth_provider_register).
+     * [Retrieve Registration Token API route](https://docs.medusajs.com/api/store#auth_postactor_typeauth_provider_register).
      *
      * @param actor - The actor type. For example, `user` for admin user, or `customer` for customer.
      * @param method - The authentication provider to use. For example, `emailpass` or `google`.
@@ -30,10 +30,10 @@ export declare class Auth {
     register: (actor: string, method: string, payload: HttpTypes.AdminSignUpWithEmailPassword) => Promise<string>;
     /**
      * This method retrieves the JWT authenticated token for an admin user, customer, or custom
-     * actor type. It sends a request to the [Authenticate API Route](https://docs.medusajs.com/v2/api/admin#auth_postactor_typeauth_provider).
+     * actor type. It sends a request to the [Authenticate API Route](https://docs.medusajs.com/api/admin#auth_postactor_typeauth_provider).
      *
      * If the `auth.type` of the SDK is set to `session`, this method will also send a request to the
-     * [Set Authentication Session API route](https://docs.medusajs.com/v2/api/admin#auth_postsession).
+     * [Set Authentication Session API route](https://docs.medusajs.com/api/admin#auth_postsession).
      *
      * Subsequent requests using the SDK will automatically have the necessary authentication headers / session
      * set.
@@ -61,7 +61,7 @@ export declare class Auth {
     }>;
     /**
      * This method is used to validate an Oauth callback from a third-party service, such as Google, for an admin user, customer, or custom actor types.
-     * It sends a request to the [Validate Authentication Callback](https://docs.medusajs.com/v2/api/admin#auth_postactor_typeauth_providercallback).
+     * It sends a request to the [Validate Authentication Callback](https://docs.medusajs.com/api/admin#auth_postactor_typeauth_providercallback).
      *
      * @param actor - The actor type. For example, `user` for admin user, or `customer` for customer.
      * @param method - The authentication provider to use. For example, `google`.
@@ -87,7 +87,7 @@ export declare class Auth {
     callback: (actor: string, method: string, query?: Record<string, unknown>) => Promise<string>;
     /**
      * This method refreshes a JWT authentication token, which is useful after validating the Oauth callback
-     * with {@link callback}. It sends a request to the [Refresh Authentication Token API route](https://docs.medusajs.com/v2/api/admin#auth_postadminauthtokenrefresh).
+     * with {@link callback}. It sends a request to the [Refresh Authentication Token API route](https://docs.medusajs.com/api/admin#auth_postadminauthtokenrefresh).
      *
      * @returns The refreshed JWT authentication token.
      *
@@ -100,7 +100,7 @@ export declare class Auth {
     refresh: () => Promise<string>;
     /**
      * This method deletes the authentication session of the currently logged-in user to log them out.
-     * It sends a request to the [Delete Authentication Session API route](https://docs.medusajs.com/v2/api/admin#auth_deletesession).
+     * It sends a request to the [Delete Authentication Session API route](https://docs.medusajs.com/api/admin#auth_deletesession).
      *
      * @example
      * sdk.auth.logout()
@@ -111,11 +111,11 @@ export declare class Auth {
     logout: () => Promise<void>;
     /**
      * This method requests a reset password token for an admin user, customer, or custom actor type.
-     * It sends a request to the [Generate Reset Password Token API route](https://docs.medusajs.com/v2/api/admin#auth_postactor_typeauth_providerresetpassword).
+     * It sends a request to the [Generate Reset Password Token API route](https://docs.medusajs.com/api/admin#auth_postactor_typeauth_providerresetpassword).
      *
      * To reset the password later using the token delivered to the user, use the {@link updateProvider} method.
      *
-     * Related guide: [How to allow customers to reset their passwords in a storefront](https://docs.medusajs.com/v2/resources/storefront-development/customers/reset-password).
+     * Related guide: [How to allow customers to reset their passwords in a storefront](https://docs.medusajs.com/resources/storefront-development/customers/reset-password).
      *
      * @param actor - The actor type. For example, `user` for admin user, or `customer` for customer.
      * @param provider - The authentication provider to use. For example, `emailpass`.
@@ -146,9 +146,9 @@ export declare class Auth {
      * More specifically, use this method when updating the password of an admin user, customer, or
      * custom actor type after requesting to reset their password with {@link resetPassword}.
      *
-     * This method sends a request to [this API route](https://docs.medusajs.com/v2/api/admin#auth_postactor_typeauth_providerupdate).
+     * This method sends a request to [this API route](https://docs.medusajs.com/api/admin#auth_postactor_typeauth_providerupdate).
      *
-     * Related guide: [How to allow customers to reset their passwords in a storefront](https://docs.medusajs.com/v2/resources/storefront-development/customers/reset-password).
+     * Related guide: [How to allow customers to reset their passwords in a storefront](https://docs.medusajs.com/resources/storefront-development/customers/reset-password).
      *
      * @param actor - The actor type. For example, `user` for admin user, or `customer` for customer.
      * @param provider - The authentication provider to use. For example, `emailpass`.

package/dist/esm/auth/index.js

@@ -11,7 +11,7 @@ export class Auth {
     constructor(client, config) {
         /**
          * This method is used to retrieve a registration JWT token for a user, customer, or custom actor type. It sends a request to the
-         * [Retrieve Registration Token API route](https://docs.medusajs.com/v2/api/store#auth_postactor_typeauth_provider_register).
+         * [Retrieve Registration Token API route](https://docs.medusajs.com/api/store#auth_postactor_typeauth_provider_register).
          *
          * @param actor - The actor type. For example, `user` for admin user, or `customer` for customer.
          * @param method - The authentication provider to use. For example, `emailpass` or `google`.
@@ -41,10 +41,10 @@ export class Auth {
         });
         /**
          * This method retrieves the JWT authenticated token for an admin user, customer, or custom
-         * actor type. It sends a request to the [Authenticate API Route](https://docs.medusajs.com/v2/api/admin#auth_postactor_typeauth_provider).
+         * actor type. It sends a request to the [Authenticate API Route](https://docs.medusajs.com/api/admin#auth_postactor_typeauth_provider).
          *
          * If the `auth.type` of the SDK is set to `session`, this method will also send a request to the
-         * [Set Authentication Session API route](https://docs.medusajs.com/v2/api/admin#auth_postsession).
+         * [Set Authentication Session API route](https://docs.medusajs.com/api/admin#auth_postsession).
          *
          * Subsequent requests using the SDK will automatically have the necessary authentication headers / session
          * set.
@@ -83,7 +83,7 @@ export class Auth {
         });
         /**
          * This method is used to validate an Oauth callback from a third-party service, such as Google, for an admin user, customer, or custom actor types.
-         * It sends a request to the [Validate Authentication Callback](https://docs.medusajs.com/v2/api/admin#auth_postactor_typeauth_providercallback).
+         * It sends a request to the [Validate Authentication Callback](https://docs.medusajs.com/api/admin#auth_postactor_typeauth_providercallback).
          *
          * @param actor - The actor type. For example, `user` for admin user, or `customer` for customer.
          * @param method - The authentication provider to use. For example, `google`.
@@ -116,7 +116,7 @@ export class Auth {
         });
         /**
          * This method refreshes a JWT authentication token, which is useful after validating the Oauth callback
-         * with {@link callback}. It sends a request to the [Refresh Authentication Token API route](https://docs.medusajs.com/v2/api/admin#auth_postadminauthtokenrefresh).
+         * with {@link callback}. It sends a request to the [Refresh Authentication Token API route](https://docs.medusajs.com/api/admin#auth_postadminauthtokenrefresh).
          *
          * @returns The refreshed JWT authentication token.
          *
@@ -137,7 +137,7 @@ export class Auth {
         });
         /**
          * This method deletes the authentication session of the currently logged-in user to log them out.
-         * It sends a request to the [Delete Authentication Session API route](https://docs.medusajs.com/v2/api/admin#auth_deletesession).
+         * It sends a request to the [Delete Authentication Session API route](https://docs.medusajs.com/api/admin#auth_deletesession).
          *
          * @example
          * sdk.auth.logout()
@@ -156,11 +156,11 @@ export class Auth {
         });
         /**
          * This method requests a reset password token for an admin user, customer, or custom actor type.
-         * It sends a request to the [Generate Reset Password Token API route](https://docs.medusajs.com/v2/api/admin#auth_postactor_typeauth_providerresetpassword).
+         * It sends a request to the [Generate Reset Password Token API route](https://docs.medusajs.com/api/admin#auth_postactor_typeauth_providerresetpassword).
          *
          * To reset the password later using the token delivered to the user, use the {@link updateProvider} method.
          *
-         * Related guide: [How to allow customers to reset their passwords in a storefront](https://docs.medusajs.com/v2/resources/storefront-development/customers/reset-password).
+         * Related guide: [How to allow customers to reset their passwords in a storefront](https://docs.medusajs.com/resources/storefront-development/customers/reset-password).
          *
          * @param actor - The actor type. For example, `user` for admin user, or `customer` for customer.
          * @param provider - The authentication provider to use. For example, `emailpass`.
@@ -191,9 +191,9 @@ export class Auth {
          * More specifically, use this method when updating the password of an admin user, customer, or
          * custom actor type after requesting to reset their password with {@link resetPassword}.
          *
-         * This method sends a request to [this API route](https://docs.medusajs.com/v2/api/admin#auth_postactor_typeauth_providerupdate).
+         * This method sends a request to [this API route](https://docs.medusajs.com/api/admin#auth_postactor_typeauth_providerupdate).
          *
-         * Related guide: [How to allow customers to reset their passwords in a storefront](https://docs.medusajs.com/v2/resources/storefront-development/customers/reset-password).
+         * Related guide: [How to allow customers to reset their passwords in a storefront](https://docs.medusajs.com/resources/storefront-development/customers/reset-password).
          *
          * @param actor - The actor type. For example, `user` for admin user, or `customer` for customer.
          * @param provider - The authentication provider to use. For example, `emailpass`.