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

package/dist/admin/product-collection.js

@@ -8,6 +8,24 @@ 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)
+     * })
+     */
     async create(body, query, headers) {
         return this.client.fetch(`/admin/collections`, {
             method: "POST",
@@ -16,6 +34,25 @@ class ProductCollection {
             query,
         });
     }
+    /**
+     * 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)
+     * })
+     */
     async update(id, body, query, headers) {
         return this.client.fetch(`/admin/collections/${id}`, {
             method: "POST",
@@ -24,24 +61,136 @@ class ProductCollection {
             query,
         });
     }
+    /**
+     * 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).
+     */
     async list(queryParams, headers) {
         return this.client.fetch(`/admin/collections`, {
             headers,
             query: queryParams,
         });
     }
+    /**
+     * 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).
+     */
     async retrieve(id, query, headers) {
         return this.client.fetch(`/admin/collections/${id}`, {
             query,
             headers,
         });
     }
+    /**
+     * 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)
+     * })
+     */
     async delete(id, headers) {
         return this.client.fetch(`/admin/collections/${id}`, {
             method: "DELETE",
             headers,
         });
     }
+    /**
+     * 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)
+     * })
+     */
     async updateProducts(id, body, headers) {
         return this.client.fetch(`/admin/collections/${id}/products`, {
             method: "POST",

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

@@ -1 +1 @@
-{"version":3,"file":"product-collection.js","sourceRoot":"","sources":["../../src/admin/product-collection.ts"],"names":[],"mappings":";;;AAIA,MAAa,iBAAiB;IAK5B;;OAEG;IACH,YAAY,MAAc;QACxB,IAAI,CAAC,MAAM,GAAG,MAAM,CAAA;IACtB,CAAC;IAED,KAAK,CAAC,MAAM,CACV,IAAqC,EACrC,KAAuC,EACvC,OAAuB;QAEvB,OAAO,IAAI,CAAC,MAAM,CAAC,KAAK,CACtB,oBAAoB,EACpB;YACE,MAAM,EAAE,MAAM;YACd,OAAO;YACP,IAAI;YACJ,KAAK;SACN,CACF,CAAA;IACH,CAAC;IACD,KAAK,CAAC,MAAM,CACV,EAAU,EACV,IAAqC,EACrC,KAAuC,EACvC,OAAuB;QAEvB,OAAO,IAAI,CAAC,MAAM,CAAC,KAAK,CACtB,sBAAsB,EAAE,EAAE,EAC1B;YACE,MAAM,EAAE,MAAM;YACd,OAAO;YACP,IAAI;YACJ,KAAK;SACN,CACF,CAAA;IACH,CAAC;IAED,KAAK,CAAC,IAAI,CACR,WAAiD,EACjD,OAAuB;QAEvB,OAAO,IAAI,CAAC,MAAM,CAAC,KAAK,CACtB,oBAAoB,EACpB;YACE,OAAO;YACP,KAAK,EAAE,WAAW;SACnB,CACF,CAAA;IACH,CAAC;IAED,KAAK,CAAC,QAAQ,CACZ,EAAU,EACV,KAAuC,EACvC,OAAuB;QAEvB,OAAO,IAAI,CAAC,MAAM,CAAC,KAAK,CACtB,sBAAsB,EAAE,EAAE,EAC1B;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,sBAAsB,EAAE,EAAE,EAC1B;YACE,MAAM,EAAE,QAAQ;YAChB,OAAO;SACR,CACF,CAAA;IACH,CAAC;IAED,KAAK,CAAC,cAAc,CAClB,EAAU,EACV,IAA6C,EAC7C,OAAuB;QAEvB,OAAO,IAAI,CAAC,MAAM,CAAC,KAAK,CACtB,sBAAsB,EAAE,WAAW,EACnC;YACE,MAAM,EAAE,MAAM;YACd,OAAO;YACP,IAAI;SACL,CACF,CAAA;IACH,CAAC;CACF;AA/FD,8CA+FC"}
+{"version":3,"file":"product-collection.js","sourceRoot":"","sources":["../../src/admin/product-collection.ts"],"names":[],"mappings":";;;AAIA,MAAa,iBAAiB;IAK5B;;OAEG;IACH,YAAY,MAAc;QACxB,IAAI,CAAC,MAAM,GAAG,MAAM,CAAA;IACtB,CAAC;IAED;;;;;;;;;;;;;;;;;OAiBG;IACH,KAAK,CAAC,MAAM,CACV,IAAqC,EACrC,KAAuC,EACvC,OAAuB;QAEvB,OAAO,IAAI,CAAC,MAAM,CAAC,KAAK,CACtB,oBAAoB,EACpB;YACE,MAAM,EAAE,MAAM;YACd,OAAO;YACP,IAAI;YACJ,KAAK;SACN,CACF,CAAA;IACH,CAAC;IAED;;;;;;;;;;;;;;;;;;OAkBG;IACH,KAAK,CAAC,MAAM,CACV,EAAU,EACV,IAAqC,EACrC,KAAuC,EACvC,OAAuB;QAEvB,OAAO,IAAI,CAAC,MAAM,CAAC,KAAK,CACtB,sBAAsB,EAAE,EAAE,EAC1B;YACE,MAAM,EAAE,MAAM;YACd,OAAO;YACP,IAAI;YACJ,KAAK;SACN,CACF,CAAA;IACH,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA6CG;IACH,KAAK,CAAC,IAAI,CACR,WAAiD,EACjD,OAAuB;QAEvB,OAAO,IAAI,CAAC,MAAM,CAAC,KAAK,CACtB,oBAAoB,EACpB;YACE,OAAO;YACP,KAAK,EAAE,WAAW;SACnB,CACF,CAAA;IACH,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA+BG;IACH,KAAK,CAAC,QAAQ,CACZ,EAAU,EACV,KAAuC,EACvC,OAAuB;QAEvB,OAAO,IAAI,CAAC,MAAM,CAAC,KAAK,CACtB,sBAAsB,EAAE,EAAE,EAC1B;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,sBAAsB,EAAE,EAAE,EAC1B;YACE,MAAM,EAAE,QAAQ;YAChB,OAAO;SACR,CACF,CAAA;IACH,CAAC;IAED;;;;;;;;;;;;;;;;;;OAkBG;IACH,KAAK,CAAC,cAAc,CAClB,EAAU,EACV,IAA6C,EAC7C,OAAuB;QAEvB,OAAO,IAAI,CAAC,MAAM,CAAC,KAAK,CACtB,sBAAsB,EAAE,WAAW,EACnC;YACE,MAAM,EAAE,MAAM;YACd,OAAO;YACP,IAAI;SACL,CACF,CAAA;IACH,CAAC;CACF;AArPD,8CAqPC"}

package/dist/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/auth/index.js

@@ -5,7 +5,7 @@ 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`.
@@ -35,10 +35,10 @@ 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.
@@ -77,7 +77,7 @@ 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`.
@@ -110,7 +110,7 @@ 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.
          *
@@ -131,7 +131,7 @@ 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()
@@ -149,11 +149,11 @@ 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`.
@@ -184,9 +184,9 @@ 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/admin/api-key.d.ts

@@ -12,7 +12,7 @@ export declare class ApiKey {
     constructor(client: Client);
     /**
      * This methods retrieves a paginated list of API keys. It sends a request to the
-     * [List API Keys](https://docs.medusajs.com/v2/api/admin#api-keys_getapikeys) API route.
+     * [List API Keys](https://docs.medusajs.com/api/admin#api-keys_getapikeys) API route.
      *
      * @param queryParams - Filters and pagination configurations.
      * @param headers - Headers to pass in the request.
@@ -54,11 +54,11 @@ export declare class ApiKey {
      * })
      * ```
      *
-     * Learn more about the `fields` property in the [API reference](https://docs.medusajs.com/v2/api/store#select-fields-and-relations).
+     * Learn more about the `fields` property in the [API reference](https://docs.medusajs.com/api/store#select-fields-and-relations).
      */
     list(queryParams?: HttpTypes.AdminGetApiKeysParams, headers?: ClientHeaders): Promise<HttpTypes.AdminApiKeyListResponse>;
     /**
-     * This method creates an API key. It sends a request to the [Create API Key](https://docs.medusajs.com/v2/api/admin#api-keys_postapikeys)
+     * This method creates an API key. It sends a request to the [Create API Key](https://docs.medusajs.com/api/admin#api-keys_postapikeys)
      * API route.
      *
      * @param body - The API key's details.
@@ -78,7 +78,7 @@ export declare class ApiKey {
     create(body: HttpTypes.AdminCreateApiKey, query?: HttpTypes.AdminGetApiKeysParams, headers?: ClientHeaders): Promise<HttpTypes.AdminApiKeyResponse>;
     /**
      * This method revokes an API key. It sends a request to the
-     * [Revoke API Key](https://docs.medusajs.com/v2/api/admin#api-keys_postapikeysidrevoke) API route.
+     * [Revoke API Key](https://docs.medusajs.com/api/admin#api-keys_postapikeysidrevoke) API route.
      *
      * @param id - The API key's ID.
      * @param headers - Headers to pass in the request.
@@ -93,7 +93,7 @@ export declare class ApiKey {
     revoke(id: string, headers?: ClientHeaders): Promise<HttpTypes.AdminApiKeyResponse>;
     /**
      * This method retrieves an API key's details. It sends a request to the
-     * [Get API key](https://docs.medusajs.com/v2/api/admin#api-keys_getapikeysid) API route.
+     * [Get API key](https://docs.medusajs.com/api/admin#api-keys_getapikeysid) API route.
      *
      * @param id - The API key's ID.
      * @param headers - Headers to pass in the request.
@@ -108,7 +108,7 @@ export declare class ApiKey {
     retrieve(id: string, headers?: ClientHeaders): Promise<HttpTypes.AdminApiKeyResponse>;
     /**
      * This method updates an API key's details. It sends a request to the
-     * [Update API Key](https://docs.medusajs.com/v2/api/admin#api-keys_postapikeysid) API route.
+     * [Update API Key](https://docs.medusajs.com/api/admin#api-keys_postapikeysid) API route.
      *
      * @param id - The API key's ID.
      * @param body - The data to update in the API key.
@@ -127,7 +127,7 @@ export declare class ApiKey {
     update(id: string, body: HttpTypes.AdminUpdateApiKey, query?: HttpTypes.AdminGetApiKeysParams, headers?: ClientHeaders): Promise<HttpTypes.AdminApiKeyResponse>;
     /**
      * This method deletes an API key by its ID. It sends a request to the
-     * [Delete API Key](https://docs.medusajs.com/v2/api/admin#api-keys_deleteapikeysid) API route.
+     * [Delete API Key](https://docs.medusajs.com/api/admin#api-keys_deleteapikeysid) API route.
      *
      * @param id - The API key's ID.
      * @param headers - Headers to pass in the request.
@@ -142,7 +142,7 @@ export declare class ApiKey {
     delete(id: string, headers?: ClientHeaders): Promise<HttpTypes.AdminApiKeyDeleteResponse>;
     /**
      * This method manages the sales channels associated with a publishable API key to either add
-     * or remove associations. It sends a request to the [Manage Sales Channels](https://docs.medusajs.com/v2/api/admin#api-keys_postapikeysidsaleschannels)
+     * or remove associations. It sends a request to the [Manage Sales Channels](https://docs.medusajs.com/api/admin#api-keys_postapikeysidsaleschannels)
      * API route.
      *
      * @param id - The API key's ID.

package/dist/esm/admin/api-key.js

@@ -16,7 +16,7 @@ export class ApiKey {
     }
     /**
      * This methods retrieves a paginated list of API keys. It sends a request to the
-     * [List API Keys](https://docs.medusajs.com/v2/api/admin#api-keys_getapikeys) API route.
+     * [List API Keys](https://docs.medusajs.com/api/admin#api-keys_getapikeys) API route.
      *
      * @param queryParams - Filters and pagination configurations.
      * @param headers - Headers to pass in the request.
@@ -58,7 +58,7 @@ export class ApiKey {
      * })
      * ```
      *
-     * Learn more about the `fields` property in the [API reference](https://docs.medusajs.com/v2/api/store#select-fields-and-relations).
+     * 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* () {
@@ -69,7 +69,7 @@ export class ApiKey {
         });
     }
     /**
-     * This method creates an API key. It sends a request to the [Create API Key](https://docs.medusajs.com/v2/api/admin#api-keys_postapikeys)
+     * This method creates an API key. It sends a request to the [Create API Key](https://docs.medusajs.com/api/admin#api-keys_postapikeys)
      * API route.
      *
      * @param body - The API key's details.
@@ -98,7 +98,7 @@ export class ApiKey {
     }
     /**
      * This method revokes an API key. It sends a request to the
-     * [Revoke API Key](https://docs.medusajs.com/v2/api/admin#api-keys_postapikeysidrevoke) API route.
+     * [Revoke API Key](https://docs.medusajs.com/api/admin#api-keys_postapikeysidrevoke) API route.
      *
      * @param id - The API key's ID.
      * @param headers - Headers to pass in the request.
@@ -120,7 +120,7 @@ export class ApiKey {
     }
     /**
      * This method retrieves an API key's details. It sends a request to the
-     * [Get API key](https://docs.medusajs.com/v2/api/admin#api-keys_getapikeysid) API route.
+     * [Get API key](https://docs.medusajs.com/api/admin#api-keys_getapikeysid) API route.
      *
      * @param id - The API key's ID.
      * @param headers - Headers to pass in the request.
@@ -141,7 +141,7 @@ export class ApiKey {
     }
     /**
      * This method updates an API key's details. It sends a request to the
-     * [Update API Key](https://docs.medusajs.com/v2/api/admin#api-keys_postapikeysid) API route.
+     * [Update API Key](https://docs.medusajs.com/api/admin#api-keys_postapikeysid) API route.
      *
      * @param id - The API key's ID.
      * @param body - The data to update in the API key.
@@ -169,7 +169,7 @@ export class ApiKey {
     }
     /**
      * This method deletes an API key by its ID. It sends a request to the
-     * [Delete API Key](https://docs.medusajs.com/v2/api/admin#api-keys_deleteapikeysid) API route.
+     * [Delete API Key](https://docs.medusajs.com/api/admin#api-keys_deleteapikeysid) API route.
      *
      * @param id - The API key's ID.
      * @param headers - Headers to pass in the request.
@@ -191,7 +191,7 @@ export class ApiKey {
     }
     /**
      * This method manages the sales channels associated with a publishable API key to either add
-     * or remove associations. It sends a request to the [Manage Sales Channels](https://docs.medusajs.com/v2/api/admin#api-keys_postapikeysidsaleschannels)
+     * or remove associations. It sends a request to the [Manage Sales Channels](https://docs.medusajs.com/api/admin#api-keys_postapikeysidsaleschannels)
      * API route.
      *
      * @param id - The API key's ID.

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

@@ -12,7 +12,7 @@ export declare class Campaign {
     constructor(client: Client);
     /**
      * This method retrieves a campaign by its ID. It sends a request to the
-     * [Get Campaign](https://docs.medusajs.com/v2/api/admin#campaigns_getcampaignsid) API route.
+     * [Get Campaign](https://docs.medusajs.com/api/admin#campaigns_getcampaignsid) API route.
      *
      * @param id - The campaign's ID.
      * @param query - Configure the fields to retrieve in the campaign.
@@ -40,12 +40,12 @@ export declare class Campaign {
      * })
      * ```
      *
-     * Learn more about the `fields` property in the [API reference](https://docs.medusajs.com/v2/api/store#select-fields-and-relations).
+     * 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.AdminGetCampaignParams, headers?: ClientHeaders): Promise<HttpTypes.AdminCampaignResponse>;
     /**
      * This method retrieves a paginated list of campaigns. It sends a request to the
-     * [List Campaigns](https://docs.medusajs.com/v2/api/admin#campaigns_getcampaigns) API route.
+     * [List Campaigns](https://docs.medusajs.com/api/admin#campaigns_getcampaigns) API route.
      *
      * @param query - Filters and pagination configurations.
      * @param headers - Headers to pass in the request.
@@ -87,12 +87,12 @@ export declare class Campaign {
      * })
      * ```
      *
-     * Learn more about the `fields` property in the [API reference](https://docs.medusajs.com/v2/api/store#select-fields-and-relations).
+     * Learn more about the `fields` property in the [API reference](https://docs.medusajs.com/api/store#select-fields-and-relations).
      */
     list(query?: HttpTypes.AdminGetCampaignsParams, headers?: ClientHeaders): Promise<HttpTypes.AdminCampaignListResponse>;
     /**
      * This method creates a campaign. It sends a request to the
-     * [Create Campaign](https://docs.medusajs.com/v2/api/admin#campaigns_postcampaigns) API route.
+     * [Create Campaign](https://docs.medusajs.com/api/admin#campaigns_postcampaigns) API route.
      *
      * @param payload - The details of the campaign to create.
      * @param headers - Headers to pass in the request
@@ -109,7 +109,7 @@ export declare class Campaign {
     create(payload: HttpTypes.AdminCreateCampaign, headers?: ClientHeaders): Promise<HttpTypes.AdminCampaignResponse>;
     /**
      * This method updates a campaign. It sends a request to the
-     * [Update Campaign](https://docs.medusajs.com/v2/api/admin#campaigns_postcampaignsid) API route.
+     * [Update Campaign](https://docs.medusajs.com/api/admin#campaigns_postcampaignsid) API route.
      *
      * @param id - The campaign's ID.
      * @param payload - The data to update in the campaign.
@@ -127,7 +127,7 @@ export declare class Campaign {
     update(id: string, payload: HttpTypes.AdminUpdateCampaign, headers?: ClientHeaders): Promise<HttpTypes.AdminCampaignResponse>;
     /**
      * This method deletes a campaign by its ID. It sends a request to the
-     * [Delete Campaign](https://docs.medusajs.com/v2/api/admin#campaigns_deletecampaignsid) API route.
+     * [Delete Campaign](https://docs.medusajs.com/api/admin#campaigns_deletecampaignsid) API route.
      *
      * @param id - The campaign's ID.
      * @param headers - Headers to pass in the request
@@ -142,7 +142,7 @@ export declare class Campaign {
     delete(id: string, headers?: ClientHeaders): Promise<HttpTypes.DeleteResponse<"campaign">>;
     /**
      * This method manages the promotions of a campaign to either add or remove the association between them.
-     * It sends a request to the [Manage Promotions](https://docs.medusajs.com/v2/api/admin#campaigns_postcampaignsidpromotions)
+     * It sends a request to the [Manage Promotions](https://docs.medusajs.com/api/admin#campaigns_postcampaignsidpromotions)
      * API route.
      *
      * @param id - The campaign's ID.

package/dist/esm/admin/campaign.js

@@ -16,7 +16,7 @@ export class Campaign {
     }
     /**
      * This method retrieves a campaign by its ID. It sends a request to the
-     * [Get Campaign](https://docs.medusajs.com/v2/api/admin#campaigns_getcampaignsid) API route.
+     * [Get Campaign](https://docs.medusajs.com/api/admin#campaigns_getcampaignsid) API route.
      *
      * @param id - The campaign's ID.
      * @param query - Configure the fields to retrieve in the campaign.
@@ -44,7 +44,7 @@ export class Campaign {
      * })
      * ```
      *
-     * Learn more about the `fields` property in the [API reference](https://docs.medusajs.com/v2/api/store#select-fields-and-relations).
+     * 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* () {
@@ -56,7 +56,7 @@ export class Campaign {
     }
     /**
      * This method retrieves a paginated list of campaigns. It sends a request to the
-     * [List Campaigns](https://docs.medusajs.com/v2/api/admin#campaigns_getcampaigns) API route.
+     * [List Campaigns](https://docs.medusajs.com/api/admin#campaigns_getcampaigns) API route.
      *
      * @param query - Filters and pagination configurations.
      * @param headers - Headers to pass in the request.
@@ -98,7 +98,7 @@ export class Campaign {
      * })
      * ```
      *
-     * Learn more about the `fields` property in the [API reference](https://docs.medusajs.com/v2/api/store#select-fields-and-relations).
+     * 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* () {
@@ -110,7 +110,7 @@ export class Campaign {
     }
     /**
      * This method creates a campaign. It sends a request to the
-     * [Create Campaign](https://docs.medusajs.com/v2/api/admin#campaigns_postcampaigns) API route.
+     * [Create Campaign](https://docs.medusajs.com/api/admin#campaigns_postcampaigns) API route.
      *
      * @param payload - The details of the campaign to create.
      * @param headers - Headers to pass in the request
@@ -135,7 +135,7 @@ export class Campaign {
     }
     /**
      * This method updates a campaign. It sends a request to the
-     * [Update Campaign](https://docs.medusajs.com/v2/api/admin#campaigns_postcampaignsid) API route.
+     * [Update Campaign](https://docs.medusajs.com/api/admin#campaigns_postcampaignsid) API route.
      *
      * @param id - The campaign's ID.
      * @param payload - The data to update in the campaign.
@@ -161,7 +161,7 @@ export class Campaign {
     }
     /**
      * This method deletes a campaign by its ID. It sends a request to the
-     * [Delete Campaign](https://docs.medusajs.com/v2/api/admin#campaigns_deletecampaignsid) API route.
+     * [Delete Campaign](https://docs.medusajs.com/api/admin#campaigns_deletecampaignsid) API route.
      *
      * @param id - The campaign's ID.
      * @param headers - Headers to pass in the request
@@ -183,7 +183,7 @@ export class Campaign {
     }
     /**
      * This method manages the promotions of a campaign to either add or remove the association between them.
-     * It sends a request to the [Manage Promotions](https://docs.medusajs.com/v2/api/admin#campaigns_postcampaignsidpromotions)
+     * It sends a request to the [Manage Promotions](https://docs.medusajs.com/api/admin#campaigns_postcampaignsidpromotions)
      * API route.
      *
      * @param id - The campaign's ID.