@salesforce/commerce-sdk-react 1.0.0-preview.0 → 1.0.0-preview.1

package/hooks/ShopperContexts/mutation.js

@@ -17,36 +17,41 @@ function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { de
  * For full license text, see the LICENSE file in the repo root or https://opensource.org/licenses/BSD-3-Clause
  */
 
-/** Mutations available for Shopper Contexts. */
+/**
+ * Mutation for Shopper Contexts.
+ * @group ShopperContexts
+ * @category Mutation
+ * @enum
+ */
 const ShopperContextsMutations = {
   /**
    * Creates the shopper's context based on shopperJWT.
    * @returns A TanStack Query mutation hook for interacting with the Shopper Contexts `createShopperContext` endpoint.
-   * @see {@link https://developer.salesforce.com/docs/commerce/commerce-api/references/shopper-contexts?meta=createShopperContext| Salesforce Developer Center} for more information about the API endpoint.
-   * @see {@link https://salesforcecommercecloud.github.io/commerce-sdk-isomorphic/classes/shoppercontexts.shoppercontexts-1.html#createshoppercontext | `commerce-sdk-isomorphic` documentation} for more information on the parameters and returned data type.
-   * @see {@link https://tanstack.com/query/latest/docs/react/reference/useMutation | TanStack Query `useMutation` reference} for more information about the return value.
    */
   CreateShopperContext: 'createShopperContext',
   /**
    * Gets the shopper's context based on the shopperJWT.
    * @returns A TanStack Query mutation hook for interacting with the Shopper Contexts `deleteShopperContext` endpoint.
-   * @see {@link https://developer.salesforce.com/docs/commerce/commerce-api/references/shopper-contexts?meta=deleteShopperContext| Salesforce Developer Center} for more information about the API endpoint.
-   * @see {@link https://salesforcecommercecloud.github.io/commerce-sdk-isomorphic/classes/shoppercontexts.shoppercontexts-1.html#deleteshoppercontext | `commerce-sdk-isomorphic` documentation} for more information on the parameters and returned data type.
-   * @see {@link https://tanstack.com/query/latest/docs/react/reference/useMutation | TanStack Query `useMutation` reference} for more information about the return value.
    */
   DeleteShopperContext: 'deleteShopperContext',
   /**
    * Updates the shopper's context based on the Shopper JWT. If the shopper context exists, it's updated with the patch body. If a customer qualifier or an `effectiveDateTime` is already present in the existing shopper context, its value is replaced by the corresponding value from the patch body. If a customer qualifers' value is set to `null` it's deleted from existing shopper context. If `effectiveDateTime` value is set to set to an empty string (\"\"), it's deleted from existing shopper context. If `effectiveDateTime` value is set to `null` it's ignored. If an `effectiveDateTime` or customer qualifiiers' value is new, it's added to the existing Shopper context.
    * @returns A TanStack Query mutation hook for interacting with the Shopper Contexts `updateShopperContext` endpoint.
-   * @see {@link https://developer.salesforce.com/docs/commerce/commerce-api/references/shopper-contexts?meta=updateShopperContext| Salesforce Developer Center} for more information about the API endpoint.
-   * @see {@link https://salesforcecommercecloud.github.io/commerce-sdk-isomorphic/classes/shoppercontexts.shoppercontexts-1.html#updateshoppercontext | `commerce-sdk-isomorphic` documentation} for more information on the parameters and returned data type.
-   * @see {@link https://tanstack.com/query/latest/docs/react/reference/useMutation | TanStack Query `useMutation` reference} for more information about the return value.
    */
   UpdateShopperContext: 'updateShopperContext'
 };
 
-/** Mutation for Shopper Contexts. */
+/**
+ * Mutation for Shopper Contexts.
+ * @group ShopperContexts
+ * @category Mutation
+ */
 exports.ShopperContextsMutations = ShopperContextsMutations;
+/**
+ * Mutation hook for Shopper Contexts.
+ * @group ShopperContexts
+ * @category Mutation
+ */
 function useShopperContextsMutation(mutation) {
   const getCacheUpdates = _cache.cacheUpdateMatrix[mutation];
   // TODO: Remove this check when all mutations are implemented.

package/hooks/ShopperContexts/query.d.ts

@@ -2,7 +2,9 @@ import { UseQueryResult } from '@tanstack/react-query';
 import { ApiClients, ApiQueryOptions, Argument, DataType, NullableParameters } from '../types';
 declare type Client = ApiClients['shopperContexts'];
 /**
- * Gets the shopper's context based on the shopperJWT. ******** This API is currently a work in progress, and not available to use yet. ********
+ * Gets the shopper's context based on the shopperJWT.
+ * @group ShopperContexts
+ * @category Query
  * @parameter apiOptions - Options to pass through to `commerce-sdk-isomorphic`, with `null` accepted for unset API parameters.
  * @parameter queryOptions - TanStack Query query options, with `enabled` by default set to check that all required API parameters have been set.
  * @returns A TanStack Query query hook with data from the Shopper Contexts `getShopperContext` endpoint.

package/hooks/ShopperContexts/query.js

@@ -19,7 +19,9 @@ function _asyncToGenerator(fn) { return function () { var self = this, args = ar
                                                                                                                                                                                                                                                                                                                                                                                                        * For full license text, see the LICENSE file in the repo root or https://opensource.org/licenses/BSD-3-Clause
                                                                                                                                                                                                                                                                                                                                                                                                        */
 /**
- * Gets the shopper's context based on the shopperJWT. ******** This API is currently a work in progress, and not available to use yet. ********
+ * Gets the shopper's context based on the shopperJWT.
+ * @group ShopperContexts
+ * @category Query
  * @parameter apiOptions - Options to pass through to `commerce-sdk-isomorphic`, with `null` accepted for unset API parameters.
  * @parameter queryOptions - TanStack Query query options, with `enabled` by default set to check that all required API parameters have been set.
  * @returns A TanStack Query query hook with data from the Shopper Contexts `getShopperContext` endpoint.

package/hooks/ShopperCustomers/mutation.d.ts

@@ -1,163 +1,103 @@
 import { ApiClients, Argument, DataType } from '../types';
 import { UseMutationResult } from '@tanstack/react-query';
 declare type Client = ApiClients['shopperCustomers'];
-/** Mutations available for Shopper Customers. */
+/**
+ * Mutations available for Shopper Customers.
+ * @group ShopperCustomers
+ * @category Mutation
+ * @enum
+ */
 export declare const ShopperCustomersMutations: {
     /**
      * Registers a new customer. The mandatory data are the credentials, profile last name, and email. This requires a JSON Web Token (JWT) which needs to be obtained using the POST /customers/auth API with type \"guest\".
      * @returns A TanStack Query mutation hook for interacting with the Shopper Customers `registerCustomer` endpoint.
-     * @see {@link https://developer.salesforce.com/docs/commerce/commerce-api/references/shopper-customers?meta=registerCustomer| Salesforce Developer Center} for more information about the API endpoint.
-     * @see {@link https://salesforcecommercecloud.github.io/commerce-sdk-isomorphic/classes/shoppercustomers.shoppercustomers-1.html#registercustomer | `commerce-sdk-isomorphic` documentation} for more information on the parameters and returned data type.
-     * @see {@link https://tanstack.com/query/latest/docs/react/reference/useMutation | TanStack Query `useMutation` reference} for more information about the return value.
      */
     readonly RegisterCustomer: "registerCustomer";
     /**
      * Reset customer password, after obtaining a reset token. This is the second step in the reset customer password flow, where a customer password is reset by providing the new credentials along with a reset token. This call should be preceded by a call to the /create-reset-token endpoint.
      * @returns A TanStack Query mutation hook for interacting with the Shopper Customers `resetPassword` endpoint.
-     * @see {@link https://developer.salesforce.com/docs/commerce/commerce-api/references/shopper-customers?meta=resetPassword| Salesforce Developer Center} for more information about the API endpoint.
-     * @see {@link https://salesforcecommercecloud.github.io/commerce-sdk-isomorphic/classes/shoppercustomers.shoppercustomers-1.html#resetpassword | `commerce-sdk-isomorphic` documentation} for more information on the parameters and returned data type.
-     * @see {@link https://tanstack.com/query/latest/docs/react/reference/useMutation | TanStack Query `useMutation` reference} for more information about the return value.
      */
     readonly ResetPassword: "resetPassword";
     /**
      * Get reset password token. This is the first step in the reset customer password flow, where a password reset token is requested for future use to reset a customer password. This call should be followed by a call to the /reset endpoint.
      * @returns A TanStack Query mutation hook for interacting with the Shopper Customers `getResetPasswordToken` endpoint.
-     * @see {@link https://developer.salesforce.com/docs/commerce/commerce-api/references/shopper-customers?meta=getResetPasswordToken| Salesforce Developer Center} for more information about the API endpoint.
-     * @see {@link https://salesforcecommercecloud.github.io/commerce-sdk-isomorphic/classes/shoppercustomers.shoppercustomers-1.html#getresetpasswordtoken | `commerce-sdk-isomorphic` documentation} for more information on the parameters and returned data type.
-     * @see {@link https://tanstack.com/query/latest/docs/react/reference/useMutation | TanStack Query `useMutation` reference} for more information about the return value.
      */
     readonly GetResetPasswordToken: "getResetPasswordToken";
     /**
      * Updates a customer.
      * @returns A TanStack Query mutation hook for interacting with the Shopper Customers `updateCustomer` endpoint.
-     * @see {@link https://developer.salesforce.com/docs/commerce/commerce-api/references/shopper-customers?meta=updateCustomer| Salesforce Developer Center} for more information about the API endpoint.
-     * @see {@link https://salesforcecommercecloud.github.io/commerce-sdk-isomorphic/classes/shoppercustomers.shoppercustomers-1.html#updatecustomer | `commerce-sdk-isomorphic` documentation} for more information on the parameters and returned data type.
-     * @see {@link https://tanstack.com/query/latest/docs/react/reference/useMutation | TanStack Query `useMutation` reference} for more information about the return value.
      */
     readonly UpdateCustomer: "updateCustomer";
     /**
      * Creates a new address with the given name for the given customer.
      * @returns A TanStack Query mutation hook for interacting with the Shopper Customers `createCustomerAddress` endpoint.
-     * @see {@link https://developer.salesforce.com/docs/commerce/commerce-api/references/shopper-customers?meta=createCustomerAddress| Salesforce Developer Center} for more information about the API endpoint.
-     * @see {@link https://salesforcecommercecloud.github.io/commerce-sdk-isomorphic/classes/shoppercustomers.shoppercustomers-1.html#createcustomeraddress | `commerce-sdk-isomorphic` documentation} for more information on the parameters and returned data type.
-     * @see {@link https://tanstack.com/query/latest/docs/react/reference/useMutation | TanStack Query `useMutation` reference} for more information about the return value.
      */
     readonly CreateCustomerAddress: "createCustomerAddress";
     /**
      * Deletes a customer's address by address name.
      * @returns A TanStack Query mutation hook for interacting with the Shopper Customers `removeCustomerAddress` endpoint.
-     * @see {@link https://developer.salesforce.com/docs/commerce/commerce-api/references/shopper-customers?meta=removeCustomerAddress| Salesforce Developer Center} for more information about the API endpoint.
-     * @see {@link https://salesforcecommercecloud.github.io/commerce-sdk-isomorphic/classes/shoppercustomers.shoppercustomers-1.html#removecustomeraddress | `commerce-sdk-isomorphic` documentation} for more information on the parameters and returned data type.
-     * @see {@link https://tanstack.com/query/latest/docs/react/reference/useMutation | TanStack Query `useMutation` reference} for more information about the return value.
      */
     readonly RemoveCustomerAddress: "removeCustomerAddress";
     /**
      * Updates a customer's address by address name.
      * @returns A TanStack Query mutation hook for interacting with the Shopper Customers `updateCustomerAddress` endpoint.
-     * @see {@link https://developer.salesforce.com/docs/commerce/commerce-api/references/shopper-customers?meta=updateCustomerAddress| Salesforce Developer Center} for more information about the API endpoint.
-     * @see {@link https://salesforcecommercecloud.github.io/commerce-sdk-isomorphic/classes/shoppercustomers.shoppercustomers-1.html#updatecustomeraddress | `commerce-sdk-isomorphic` documentation} for more information on the parameters and returned data type.
-     * @see {@link https://tanstack.com/query/latest/docs/react/reference/useMutation | TanStack Query `useMutation` reference} for more information about the return value.
      */
     readonly UpdateCustomerAddress: "updateCustomerAddress";
     /**
      * Updates the customer's password.
      * @returns A TanStack Query mutation hook for interacting with the Shopper Customers `updateCustomerPassword` endpoint.
-     * @see {@link https://developer.salesforce.com/docs/commerce/commerce-api/references/shopper-customers?meta=updateCustomerPassword| Salesforce Developer Center} for more information about the API endpoint.
-     * @see {@link https://salesforcecommercecloud.github.io/commerce-sdk-isomorphic/classes/shoppercustomers.shoppercustomers-1.html#updatecustomerpassword | `commerce-sdk-isomorphic` documentation} for more information on the parameters and returned data type.
-     * @see {@link https://tanstack.com/query/latest/docs/react/reference/useMutation | TanStack Query `useMutation` reference} for more information about the return value.
      */
     readonly UpdateCustomerPassword: "updateCustomerPassword";
     /**
      * Adds a payment instrument to the customer information.
      * @returns A TanStack Query mutation hook for interacting with the Shopper Customers `createCustomerPaymentInstrument` endpoint.
-     * @see {@link https://developer.salesforce.com/docs/commerce/commerce-api/references/shopper-customers?meta=createCustomerPaymentInstrument| Salesforce Developer Center} for more information about the API endpoint.
-     * @see {@link https://salesforcecommercecloud.github.io/commerce-sdk-isomorphic/classes/shoppercustomers.shoppercustomers-1.html#createcustomerpaymentinstrument | `commerce-sdk-isomorphic` documentation} for more information on the parameters and returned data type.
-     * @see {@link https://tanstack.com/query/latest/docs/react/reference/useMutation | TanStack Query `useMutation` reference} for more information about the return value.
      */
     readonly CreateCustomerPaymentInstrument: "createCustomerPaymentInstrument";
     /**
      * Deletes a customer's payment instrument.
      * @returns A TanStack Query mutation hook for interacting with the Shopper Customers `deleteCustomerPaymentInstrument` endpoint.
-     * @see {@link https://developer.salesforce.com/docs/commerce/commerce-api/references/shopper-customers?meta=deleteCustomerPaymentInstrument| Salesforce Developer Center} for more information about the API endpoint.
-     * @see {@link https://salesforcecommercecloud.github.io/commerce-sdk-isomorphic/classes/shoppercustomers.shoppercustomers-1.html#deletecustomerpaymentinstrument | `commerce-sdk-isomorphic` documentation} for more information on the parameters and returned data type.
-     * @see {@link https://tanstack.com/query/latest/docs/react/reference/useMutation | TanStack Query `useMutation` reference} for more information about the return value.
      */
     readonly DeleteCustomerPaymentInstrument: "deleteCustomerPaymentInstrument";
     /**
      * Creates a customer product list.
      * @returns A TanStack Query mutation hook for interacting with the Shopper Customers `createCustomerProductList` endpoint.
-     * @see {@link https://developer.salesforce.com/docs/commerce/commerce-api/references/shopper-customers?meta=createCustomerProductList| Salesforce Developer Center} for more information about the API endpoint.
-     * @see {@link https://salesforcecommercecloud.github.io/commerce-sdk-isomorphic/classes/shoppercustomers.shoppercustomers-1.html#createcustomerproductlist | `commerce-sdk-isomorphic` documentation} for more information on the parameters and returned data type.
-     * @see {@link https://tanstack.com/query/latest/docs/react/reference/useMutation | TanStack Query `useMutation` reference} for more information about the return value.
      */
     readonly CreateCustomerProductList: "createCustomerProductList";
     /**
      * Deletes a customer product list.
      * @returns A TanStack Query mutation hook for interacting with the Shopper Customers `deleteCustomerProductList` endpoint.
-     * @see {@link https://developer.salesforce.com/docs/commerce/commerce-api/references/shopper-customers?meta=deleteCustomerProductList| Salesforce Developer Center} for more information about the API endpoint.
-     * @see {@link https://salesforcecommercecloud.github.io/commerce-sdk-isomorphic/classes/shoppercustomers.shoppercustomers-1.html#deletecustomerproductlist | `commerce-sdk-isomorphic` documentation} for more information on the parameters and returned data type.
-     * @see {@link https://tanstack.com/query/latest/docs/react/reference/useMutation | TanStack Query `useMutation` reference} for more information about the return value.
      */
     readonly DeleteCustomerProductList: "deleteCustomerProductList";
     /**
      * Changes a product list. Changeable properties are the name, description, and if the list is public.
      * @returns A TanStack Query mutation hook for interacting with the Shopper Customers `updateCustomerProductList` endpoint.
-     * @see {@link https://developer.salesforce.com/docs/commerce/commerce-api/references/shopper-customers?meta=updateCustomerProductList| Salesforce Developer Center} for more information about the API endpoint.
-     * @see {@link https://salesforcecommercecloud.github.io/commerce-sdk-isomorphic/classes/shoppercustomers.shoppercustomers-1.html#updatecustomerproductlist | `commerce-sdk-isomorphic` documentation} for more information on the parameters and returned data type.
-     * @see {@link https://tanstack.com/query/latest/docs/react/reference/useMutation | TanStack Query `useMutation` reference} for more information about the return value.
      */
     readonly UpdateCustomerProductList: "updateCustomerProductList";
     /**
-   * Adds an item to the customer's product list. Considered values from the request body are:
-
-type: A valid type, mandatory. This is the type of the item to be added to the customer's product.
-list.
-priority: This is the priority of the item to be added to the customer's product list.
-public: This is the flag whether the item to be added to the customer's product list is public.
-product_id: A valid product ID, used for product item type only. This is the ID (SKU)
-of the product related to the item to be added to the customer's product list. It is mandatory for
-product item type, and it must be a valid product id, otherwise
-ProductListProductIdMissingException or ProductListProductNotFoundException
-will be thrown.
-quantity: Used for product item type only. This is the quantity of the item to be
-added to the customer's product list.
-custom properties in the form c_\<CUSTOM_NAME\>: The custom property must correspond to a custom
-attribute (\<CUSTOM_NAME\>) defined for ProductListItem. The value of this property must be valid for the
-type of custom attribute defined for ProductListItem.
-   * @returns A TanStack Query mutation hook for interacting with the Shopper Customers `createCustomerProductListItem` endpoint.
-   * @see {@link https://developer.salesforce.com/docs/commerce/commerce-api/references/shopper-customers?meta=createCustomerProductListItem| Salesforce Developer Center} for more information about the API endpoint.
-   * @see {@link https://salesforcecommercecloud.github.io/commerce-sdk-isomorphic/classes/shoppercustomers.shoppercustomers-1.html#createcustomerproductlistitem | `commerce-sdk-isomorphic` documentation} for more information on the parameters and returned data type.
-   * @see {@link https://tanstack.com/query/latest/docs/react/reference/useMutation | TanStack Query `useMutation` reference} for more information about the return value.
-   */
+     * @returns A TanStack Query mutation hook for interacting with the Shopper Customers `createCustomerProductListItem` endpoint.
+     */
     readonly CreateCustomerProductListItem: "createCustomerProductListItem";
     /**
      * Removes an item from a customer product list.
      * @returns A TanStack Query mutation hook for interacting with the Shopper Customers `deleteCustomerProductListItem` endpoint.
-     * @see {@link https://developer.salesforce.com/docs/commerce/commerce-api/references/shopper-customers?meta=deleteCustomerProductListItem| Salesforce Developer Center} for more information about the API endpoint.
-     * @see {@link https://salesforcecommercecloud.github.io/commerce-sdk-isomorphic/classes/shoppercustomers.shoppercustomers-1.html#deletecustomerproductlistitem | `commerce-sdk-isomorphic` documentation} for more information on the parameters and returned data type.
-     * @see {@link https://tanstack.com/query/latest/docs/react/reference/useMutation | TanStack Query `useMutation` reference} for more information about the return value.
      */
     readonly DeleteCustomerProductListItem: "deleteCustomerProductListItem";
     /**
-   * Updates an item of a customer's product list.
-Considered values from the request body are:
-
-priority: This is the priority of the customer's product list item.
-public: This is the flag whether the customer's product list item is public.
-quantity: This is the quantity of
-the customer's product list item. Used for product item type only.
-custom properties in the form c_\<CUSTOM_NAME\>: The custom property
-must correspond to a custom attribute (\<CUSTOM_NAME\>) defined for ProductListItem.
-The value of this property must be valid for the type of custom attribute defined for ProductListItem.
-   * @returns A TanStack Query mutation hook for interacting with the Shopper Customers `updateCustomerProductListItem` endpoint.
-   * @see {@link https://developer.salesforce.com/docs/commerce/commerce-api/references/shopper-customers?meta=updateCustomerProductListItem| Salesforce Developer Center} for more information about the API endpoint.
-   * @see {@link https://salesforcecommercecloud.github.io/commerce-sdk-isomorphic/classes/shoppercustomers.shoppercustomers-1.html#updatecustomerproductlistitem | `commerce-sdk-isomorphic` documentation} for more information on the parameters and returned data type.
-   * @see {@link https://tanstack.com/query/latest/docs/react/reference/useMutation | TanStack Query `useMutation` reference} for more information about the return value.
-   */
+     * Updates an item of a customer's product list.
+     */
     readonly UpdateCustomerProductListItem: "updateCustomerProductListItem";
 };
-/** Mutation for Shopper Customers. */
+/**
+ * Mutation for Shopper Customers.
+ * @group ShopperCustomers
+ * @category Mutation
+ */
 export declare type ShopperCustomersMutation = (typeof ShopperCustomersMutations)[keyof typeof ShopperCustomersMutations];
+/**
+ * Mutation hook for Shopper Customers.
+ * @group ShopperCustomers
+ * @category Mutation
+ */
 export declare function useShopperCustomersMutation<Mutation extends ShopperCustomersMutation>(mutation: Mutation): UseMutationResult<DataType<Client[Mutation]>, unknown, Argument<Client[Mutation]>>;
 export {};
 //# sourceMappingURL=mutation.d.ts.map

package/hooks/ShopperCustomers/mutation.js

@@ -17,171 +17,110 @@ function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { de
  * For full license text, see the LICENSE file in the repo root or https://opensource.org/licenses/BSD-3-Clause
  */
 
-/** Mutations available for Shopper Customers. */
+/**
+ * Mutations available for Shopper Customers.
+ * @group ShopperCustomers
+ * @category Mutation
+ * @enum
+ */
 const ShopperCustomersMutations = {
   /**
    * Registers a new customer. The mandatory data are the credentials, profile last name, and email. This requires a JSON Web Token (JWT) which needs to be obtained using the POST /customers/auth API with type \"guest\".
    * @returns A TanStack Query mutation hook for interacting with the Shopper Customers `registerCustomer` endpoint.
-   * @see {@link https://developer.salesforce.com/docs/commerce/commerce-api/references/shopper-customers?meta=registerCustomer| Salesforce Developer Center} for more information about the API endpoint.
-   * @see {@link https://salesforcecommercecloud.github.io/commerce-sdk-isomorphic/classes/shoppercustomers.shoppercustomers-1.html#registercustomer | `commerce-sdk-isomorphic` documentation} for more information on the parameters and returned data type.
-   * @see {@link https://tanstack.com/query/latest/docs/react/reference/useMutation | TanStack Query `useMutation` reference} for more information about the return value.
    */
   RegisterCustomer: 'registerCustomer',
   /**
    * Reset customer password, after obtaining a reset token. This is the second step in the reset customer password flow, where a customer password is reset by providing the new credentials along with a reset token. This call should be preceded by a call to the /create-reset-token endpoint.
    * @returns A TanStack Query mutation hook for interacting with the Shopper Customers `resetPassword` endpoint.
-   * @see {@link https://developer.salesforce.com/docs/commerce/commerce-api/references/shopper-customers?meta=resetPassword| Salesforce Developer Center} for more information about the API endpoint.
-   * @see {@link https://salesforcecommercecloud.github.io/commerce-sdk-isomorphic/classes/shoppercustomers.shoppercustomers-1.html#resetpassword | `commerce-sdk-isomorphic` documentation} for more information on the parameters and returned data type.
-   * @see {@link https://tanstack.com/query/latest/docs/react/reference/useMutation | TanStack Query `useMutation` reference} for more information about the return value.
    */
   ResetPassword: 'resetPassword',
   /**
    * Get reset password token. This is the first step in the reset customer password flow, where a password reset token is requested for future use to reset a customer password. This call should be followed by a call to the /reset endpoint.
    * @returns A TanStack Query mutation hook for interacting with the Shopper Customers `getResetPasswordToken` endpoint.
-   * @see {@link https://developer.salesforce.com/docs/commerce/commerce-api/references/shopper-customers?meta=getResetPasswordToken| Salesforce Developer Center} for more information about the API endpoint.
-   * @see {@link https://salesforcecommercecloud.github.io/commerce-sdk-isomorphic/classes/shoppercustomers.shoppercustomers-1.html#getresetpasswordtoken | `commerce-sdk-isomorphic` documentation} for more information on the parameters and returned data type.
-   * @see {@link https://tanstack.com/query/latest/docs/react/reference/useMutation | TanStack Query `useMutation` reference} for more information about the return value.
    */
   GetResetPasswordToken: 'getResetPasswordToken',
   // TODO: Re-implement (and update description from RAML spec) when the endpoint exits closed beta.
   // /**
   //  * Registers a new external profile for a customer. This endpoint is in closed beta, available to select few customers. Please get in touch with your Account Team if you'd like to participate in the beta program
   //  * @returns A TanStack Query mutation hook for interacting with the Shopper Customers `registerExternalProfile` endpoint.
-  //  * @see {@link https://developer.salesforce.com/docs/commerce/commerce-api/references/shopper-customers?meta=registerExternalProfile| Salesforce Developer Center} for more information about the API endpoint.
-  //  * @see {@link https://salesforcecommercecloud.github.io/commerce-sdk-isomorphic/classes/shoppercustomers.shoppercustomers-1.html#registerexternalprofile | `commerce-sdk-isomorphic` documentation} for more information on the parameters and returned data type.
-  //  * @see {@link https://tanstack.com/query/latest/docs/react/reference/useMutation | TanStack Query `useMutation` reference} for more information about the return value.
   //  */
   // RegisterExternalProfile: 'registerExternalProfile',
   /**
    * Updates a customer.
    * @returns A TanStack Query mutation hook for interacting with the Shopper Customers `updateCustomer` endpoint.
-   * @see {@link https://developer.salesforce.com/docs/commerce/commerce-api/references/shopper-customers?meta=updateCustomer| Salesforce Developer Center} for more information about the API endpoint.
-   * @see {@link https://salesforcecommercecloud.github.io/commerce-sdk-isomorphic/classes/shoppercustomers.shoppercustomers-1.html#updatecustomer | `commerce-sdk-isomorphic` documentation} for more information on the parameters and returned data type.
-   * @see {@link https://tanstack.com/query/latest/docs/react/reference/useMutation | TanStack Query `useMutation` reference} for more information about the return value.
    */
   UpdateCustomer: 'updateCustomer',
   /**
    * Creates a new address with the given name for the given customer.
    * @returns A TanStack Query mutation hook for interacting with the Shopper Customers `createCustomerAddress` endpoint.
-   * @see {@link https://developer.salesforce.com/docs/commerce/commerce-api/references/shopper-customers?meta=createCustomerAddress| Salesforce Developer Center} for more information about the API endpoint.
-   * @see {@link https://salesforcecommercecloud.github.io/commerce-sdk-isomorphic/classes/shoppercustomers.shoppercustomers-1.html#createcustomeraddress | `commerce-sdk-isomorphic` documentation} for more information on the parameters and returned data type.
-   * @see {@link https://tanstack.com/query/latest/docs/react/reference/useMutation | TanStack Query `useMutation` reference} for more information about the return value.
    */
   CreateCustomerAddress: 'createCustomerAddress',
   /**
    * Deletes a customer's address by address name.
    * @returns A TanStack Query mutation hook for interacting with the Shopper Customers `removeCustomerAddress` endpoint.
-   * @see {@link https://developer.salesforce.com/docs/commerce/commerce-api/references/shopper-customers?meta=removeCustomerAddress| Salesforce Developer Center} for more information about the API endpoint.
-   * @see {@link https://salesforcecommercecloud.github.io/commerce-sdk-isomorphic/classes/shoppercustomers.shoppercustomers-1.html#removecustomeraddress | `commerce-sdk-isomorphic` documentation} for more information on the parameters and returned data type.
-   * @see {@link https://tanstack.com/query/latest/docs/react/reference/useMutation | TanStack Query `useMutation` reference} for more information about the return value.
    */
   RemoveCustomerAddress: 'removeCustomerAddress',
   /**
    * Updates a customer's address by address name.
    * @returns A TanStack Query mutation hook for interacting with the Shopper Customers `updateCustomerAddress` endpoint.
-   * @see {@link https://developer.salesforce.com/docs/commerce/commerce-api/references/shopper-customers?meta=updateCustomerAddress| Salesforce Developer Center} for more information about the API endpoint.
-   * @see {@link https://salesforcecommercecloud.github.io/commerce-sdk-isomorphic/classes/shoppercustomers.shoppercustomers-1.html#updatecustomeraddress | `commerce-sdk-isomorphic` documentation} for more information on the parameters and returned data type.
-   * @see {@link https://tanstack.com/query/latest/docs/react/reference/useMutation | TanStack Query `useMutation` reference} for more information about the return value.
    */
   UpdateCustomerAddress: 'updateCustomerAddress',
   /**
    * Updates the customer's password.
    * @returns A TanStack Query mutation hook for interacting with the Shopper Customers `updateCustomerPassword` endpoint.
-   * @see {@link https://developer.salesforce.com/docs/commerce/commerce-api/references/shopper-customers?meta=updateCustomerPassword| Salesforce Developer Center} for more information about the API endpoint.
-   * @see {@link https://salesforcecommercecloud.github.io/commerce-sdk-isomorphic/classes/shoppercustomers.shoppercustomers-1.html#updatecustomerpassword | `commerce-sdk-isomorphic` documentation} for more information on the parameters and returned data type.
-   * @see {@link https://tanstack.com/query/latest/docs/react/reference/useMutation | TanStack Query `useMutation` reference} for more information about the return value.
    */
   UpdateCustomerPassword: 'updateCustomerPassword',
   /**
    * Adds a payment instrument to the customer information.
    * @returns A TanStack Query mutation hook for interacting with the Shopper Customers `createCustomerPaymentInstrument` endpoint.
-   * @see {@link https://developer.salesforce.com/docs/commerce/commerce-api/references/shopper-customers?meta=createCustomerPaymentInstrument| Salesforce Developer Center} for more information about the API endpoint.
-   * @see {@link https://salesforcecommercecloud.github.io/commerce-sdk-isomorphic/classes/shoppercustomers.shoppercustomers-1.html#createcustomerpaymentinstrument | `commerce-sdk-isomorphic` documentation} for more information on the parameters and returned data type.
-   * @see {@link https://tanstack.com/query/latest/docs/react/reference/useMutation | TanStack Query `useMutation` reference} for more information about the return value.
    */
   CreateCustomerPaymentInstrument: 'createCustomerPaymentInstrument',
   /**
    * Deletes a customer's payment instrument.
    * @returns A TanStack Query mutation hook for interacting with the Shopper Customers `deleteCustomerPaymentInstrument` endpoint.
-   * @see {@link https://developer.salesforce.com/docs/commerce/commerce-api/references/shopper-customers?meta=deleteCustomerPaymentInstrument| Salesforce Developer Center} for more information about the API endpoint.
-   * @see {@link https://salesforcecommercecloud.github.io/commerce-sdk-isomorphic/classes/shoppercustomers.shoppercustomers-1.html#deletecustomerpaymentinstrument | `commerce-sdk-isomorphic` documentation} for more information on the parameters and returned data type.
-   * @see {@link https://tanstack.com/query/latest/docs/react/reference/useMutation | TanStack Query `useMutation` reference} for more information about the return value.
    */
   DeleteCustomerPaymentInstrument: 'deleteCustomerPaymentInstrument',
   /**
    * Creates a customer product list.
    * @returns A TanStack Query mutation hook for interacting with the Shopper Customers `createCustomerProductList` endpoint.
-   * @see {@link https://developer.salesforce.com/docs/commerce/commerce-api/references/shopper-customers?meta=createCustomerProductList| Salesforce Developer Center} for more information about the API endpoint.
-   * @see {@link https://salesforcecommercecloud.github.io/commerce-sdk-isomorphic/classes/shoppercustomers.shoppercustomers-1.html#createcustomerproductlist | `commerce-sdk-isomorphic` documentation} for more information on the parameters and returned data type.
-   * @see {@link https://tanstack.com/query/latest/docs/react/reference/useMutation | TanStack Query `useMutation` reference} for more information about the return value.
    */
   CreateCustomerProductList: 'createCustomerProductList',
   /**
    * Deletes a customer product list.
    * @returns A TanStack Query mutation hook for interacting with the Shopper Customers `deleteCustomerProductList` endpoint.
-   * @see {@link https://developer.salesforce.com/docs/commerce/commerce-api/references/shopper-customers?meta=deleteCustomerProductList| Salesforce Developer Center} for more information about the API endpoint.
-   * @see {@link https://salesforcecommercecloud.github.io/commerce-sdk-isomorphic/classes/shoppercustomers.shoppercustomers-1.html#deletecustomerproductlist | `commerce-sdk-isomorphic` documentation} for more information on the parameters and returned data type.
-   * @see {@link https://tanstack.com/query/latest/docs/react/reference/useMutation | TanStack Query `useMutation` reference} for more information about the return value.
    */
   DeleteCustomerProductList: 'deleteCustomerProductList',
   /**
    * Changes a product list. Changeable properties are the name, description, and if the list is public.
    * @returns A TanStack Query mutation hook for interacting with the Shopper Customers `updateCustomerProductList` endpoint.
-   * @see {@link https://developer.salesforce.com/docs/commerce/commerce-api/references/shopper-customers?meta=updateCustomerProductList| Salesforce Developer Center} for more information about the API endpoint.
-   * @see {@link https://salesforcecommercecloud.github.io/commerce-sdk-isomorphic/classes/shoppercustomers.shoppercustomers-1.html#updatecustomerproductlist | `commerce-sdk-isomorphic` documentation} for more information on the parameters and returned data type.
-   * @see {@link https://tanstack.com/query/latest/docs/react/reference/useMutation | TanStack Query `useMutation` reference} for more information about the return value.
    */
   UpdateCustomerProductList: 'updateCustomerProductList',
   /**
-  * Adds an item to the customer's product list. Considered values from the request body are:
-  type: A valid type, mandatory. This is the type of the item to be added to the customer's product.
-  list.
-  priority: This is the priority of the item to be added to the customer's product list.
-  public: This is the flag whether the item to be added to the customer's product list is public.
-  product_id: A valid product ID, used for product item type only. This is the ID (SKU)
-  of the product related to the item to be added to the customer's product list. It is mandatory for
-  product item type, and it must be a valid product id, otherwise
-  ProductListProductIdMissingException or ProductListProductNotFoundException
-  will be thrown.
-  quantity: Used for product item type only. This is the quantity of the item to be
-  added to the customer's product list.
-  custom properties in the form c_\<CUSTOM_NAME\>: The custom property must correspond to a custom
-  attribute (\<CUSTOM_NAME\>) defined for ProductListItem. The value of this property must be valid for the
-  type of custom attribute defined for ProductListItem.
-  * @returns A TanStack Query mutation hook for interacting with the Shopper Customers `createCustomerProductListItem` endpoint.
-  * @see {@link https://developer.salesforce.com/docs/commerce/commerce-api/references/shopper-customers?meta=createCustomerProductListItem| Salesforce Developer Center} for more information about the API endpoint.
-  * @see {@link https://salesforcecommercecloud.github.io/commerce-sdk-isomorphic/classes/shoppercustomers.shoppercustomers-1.html#createcustomerproductlistitem | `commerce-sdk-isomorphic` documentation} for more information on the parameters and returned data type.
-  * @see {@link https://tanstack.com/query/latest/docs/react/reference/useMutation | TanStack Query `useMutation` reference} for more information about the return value.
-  */
+   * @returns A TanStack Query mutation hook for interacting with the Shopper Customers `createCustomerProductListItem` endpoint.
+   */
   CreateCustomerProductListItem: 'createCustomerProductListItem',
   /**
    * Removes an item from a customer product list.
    * @returns A TanStack Query mutation hook for interacting with the Shopper Customers `deleteCustomerProductListItem` endpoint.
-   * @see {@link https://developer.salesforce.com/docs/commerce/commerce-api/references/shopper-customers?meta=deleteCustomerProductListItem| Salesforce Developer Center} for more information about the API endpoint.
-   * @see {@link https://salesforcecommercecloud.github.io/commerce-sdk-isomorphic/classes/shoppercustomers.shoppercustomers-1.html#deletecustomerproductlistitem | `commerce-sdk-isomorphic` documentation} for more information on the parameters and returned data type.
-   * @see {@link https://tanstack.com/query/latest/docs/react/reference/useMutation | TanStack Query `useMutation` reference} for more information about the return value.
    */
   DeleteCustomerProductListItem: 'deleteCustomerProductListItem',
   /**
-  * Updates an item of a customer's product list.
-  Considered values from the request body are:
-  priority: This is the priority of the customer's product list item.
-  public: This is the flag whether the customer's product list item is public.
-  quantity: This is the quantity of
-  the customer's product list item. Used for product item type only. 
-  custom properties in the form c_\<CUSTOM_NAME\>: The custom property
-  must correspond to a custom attribute (\<CUSTOM_NAME\>) defined for ProductListItem.
-  The value of this property must be valid for the type of custom attribute defined for ProductListItem.
-  * @returns A TanStack Query mutation hook for interacting with the Shopper Customers `updateCustomerProductListItem` endpoint.
-  * @see {@link https://developer.salesforce.com/docs/commerce/commerce-api/references/shopper-customers?meta=updateCustomerProductListItem| Salesforce Developer Center} for more information about the API endpoint.
-  * @see {@link https://salesforcecommercecloud.github.io/commerce-sdk-isomorphic/classes/shoppercustomers.shoppercustomers-1.html#updatecustomerproductlistitem | `commerce-sdk-isomorphic` documentation} for more information on the parameters and returned data type.
-  * @see {@link https://tanstack.com/query/latest/docs/react/reference/useMutation | TanStack Query `useMutation` reference} for more information about the return value.
-  */
+   * Updates an item of a customer's product list.
+   */
   UpdateCustomerProductListItem: 'updateCustomerProductListItem'
 };
 
-/** Mutation for Shopper Customers. */
+/**
+ * Mutation for Shopper Customers.
+ * @group ShopperCustomers
+ * @category Mutation
+ */
 exports.ShopperCustomersMutations = ShopperCustomersMutations;
+/**
+ * Mutation hook for Shopper Customers.
+ * @group ShopperCustomers
+ * @category Mutation
+ */
 function useShopperCustomersMutation(mutation) {
   const getCacheUpdates = _cache.cacheUpdateMatrix[mutation];
   // TODO: Remove this check when all mutations are implemented.

package/hooks/ShopperCustomers/query.d.ts

@@ -2,7 +2,10 @@ import { UseQueryResult } from '@tanstack/react-query';
 import { ApiClients, ApiQueryOptions, Argument, DataType, NullableParameters } from '../types';
 declare type Client = ApiClients['shopperCustomers'];
 /**
- * Gets a customer with all existing addresses and payment instruments associated with the requested customer.
+ * Gets a customer's information.
+ *
+ * @group ShopperCustomers
+ * @category Query
  * @parameter apiOptions - Options to pass through to `commerce-sdk-isomorphic`, with `null` accepted for unset API parameters.
  * @parameter queryOptions - TanStack Query query options, with `enabled` by default set to check that all required API parameters have been set.
  * @returns A TanStack Query query hook with data from the Shopper Customers `getCustomer` endpoint.
@@ -13,6 +16,8 @@ declare type Client = ApiClients['shopperCustomers'];
 export declare const useCustomer: (apiOptions: NullableParameters<Argument<Client['getCustomer']>>, queryOptions?: ApiQueryOptions<Client['getCustomer']>) => UseQueryResult<DataType<Client['getCustomer']>>;
 /**
  * Retrieves a customer's address by address name.
+ * @group ShopperCustomers
+ * @category Query
  * @parameter apiOptions - Options to pass through to `commerce-sdk-isomorphic`, with `null` accepted for unset API parameters.
  * @parameter queryOptions - TanStack Query query options, with `enabled` by default set to check that all required API parameters have been set.
  * @returns A TanStack Query query hook with data from the Shopper Customers `getCustomerAddress` endpoint.
@@ -23,6 +28,8 @@ export declare const useCustomer: (apiOptions: NullableParameters<Argument<Clien
 export declare const useCustomerAddress: (apiOptions: NullableParameters<Argument<Client['getCustomerAddress']>>, queryOptions?: ApiQueryOptions<Client['getCustomerAddress']>) => UseQueryResult<DataType<Client['getCustomerAddress']>>;
 /**
  * Gets the baskets of a customer.
+ * @group ShopperCustomers
+ * @category Query
  * @parameter apiOptions - Options to pass through to `commerce-sdk-isomorphic`, with `null` accepted for unset API parameters.
  * @parameter queryOptions - TanStack Query query options, with `enabled` by default set to check that all required API parameters have been set.
  * @returns A TanStack Query query hook with data from the Shopper Customers `getCustomerBaskets` endpoint.
@@ -32,7 +39,11 @@ export declare const useCustomerAddress: (apiOptions: NullableParameters<Argumen
  */
 export declare const useCustomerBaskets: (apiOptions: NullableParameters<Argument<Client['getCustomerBaskets']>>, queryOptions?: ApiQueryOptions<Client['getCustomerBaskets']>) => UseQueryResult<DataType<Client['getCustomerBaskets']>>;
 /**
- * Returns a pageable list of all customer's orders. The default page size is 10.
+ * Returns a pageable list of all customer's orders.
+ *
+ * The default page size is 10.
+ * @group ShopperCustomers
+ * @category Query
  * @parameter apiOptions - Options to pass through to `commerce-sdk-isomorphic`, with `null` accepted for unset API parameters.
  * @parameter queryOptions - TanStack Query query options, with `enabled` by default set to check that all required API parameters have been set.
  * @returns A TanStack Query query hook with data from the Shopper Customers `getCustomerOrders` endpoint.
@@ -43,6 +54,8 @@ export declare const useCustomerBaskets: (apiOptions: NullableParameters<Argumen
 export declare const useCustomerOrders: (apiOptions: NullableParameters<Argument<Client['getCustomerOrders']>>, queryOptions?: ApiQueryOptions<Client['getCustomerOrders']>) => UseQueryResult<DataType<Client['getCustomerOrders']>>;
 /**
  * Retrieves a customer's payment instrument by its ID.
+ * @group ShopperCustomers
+ * @category Query
  * @parameter apiOptions - Options to pass through to `commerce-sdk-isomorphic`, with `null` accepted for unset API parameters.
  * @parameter queryOptions - TanStack Query query options, with `enabled` by default set to check that all required API parameters have been set.
  * @returns A TanStack Query query hook with data from the Shopper Customers `getCustomerPaymentInstrument` endpoint.
@@ -53,6 +66,8 @@ export declare const useCustomerOrders: (apiOptions: NullableParameters<Argument
 export declare const useCustomerPaymentInstrument: (apiOptions: NullableParameters<Argument<Client['getCustomerPaymentInstrument']>>, queryOptions?: ApiQueryOptions<Client['getCustomerPaymentInstrument']>) => UseQueryResult<DataType<Client['getCustomerPaymentInstrument']>>;
 /**
  * Returns all customer product lists.
+ * @group ShopperCustomers
+ * @category Query
  * @parameter apiOptions - Options to pass through to `commerce-sdk-isomorphic`, with `null` accepted for unset API parameters.
  * @parameter queryOptions - TanStack Query query options, with `enabled` by default set to check that all required API parameters have been set.
  * @returns A TanStack Query query hook with data from the Shopper Customers `getCustomerProductLists` endpoint.
@@ -63,6 +78,8 @@ export declare const useCustomerPaymentInstrument: (apiOptions: NullableParamete
 export declare const useCustomerProductLists: (apiOptions: NullableParameters<Argument<Client['getCustomerProductLists']>>, queryOptions?: ApiQueryOptions<Client['getCustomerProductLists']>) => UseQueryResult<DataType<Client['getCustomerProductLists']>>;
 /**
  * Returns a customer product list of the given customer and the items in the list.
+ * @group ShopperCustomers
+ * @category Query
  * @parameter apiOptions - Options to pass through to `commerce-sdk-isomorphic`, with `null` accepted for unset API parameters.
  * @parameter queryOptions - TanStack Query query options, with `enabled` by default set to check that all required API parameters have been set.
  * @returns A TanStack Query query hook with data from the Shopper Customers `getCustomerProductList` endpoint.
@@ -73,6 +90,8 @@ export declare const useCustomerProductLists: (apiOptions: NullableParameters<Ar
 export declare const useCustomerProductList: (apiOptions: NullableParameters<Argument<Client['getCustomerProductList']>>, queryOptions?: ApiQueryOptions<Client['getCustomerProductList']>) => UseQueryResult<DataType<Client['getCustomerProductList']>>;
 /**
  * Returns an item of a customer product list and the actual product details like image, availability and price.
+ * @group ShopperCustomers
+ * @category Query
  * @parameter apiOptions - Options to pass through to `commerce-sdk-isomorphic`, with `null` accepted for unset API parameters.
  * @parameter queryOptions - TanStack Query query options, with `enabled` by default set to check that all required API parameters have been set.
  * @returns A TanStack Query query hook with data from the Shopper Customers `getCustomerProductListItem` endpoint.
@@ -83,6 +102,8 @@ export declare const useCustomerProductList: (apiOptions: NullableParameters<Arg
 export declare const useCustomerProductListItem: (apiOptions: NullableParameters<Argument<Client['getCustomerProductListItem']>>, queryOptions?: ApiQueryOptions<Client['getCustomerProductListItem']>) => UseQueryResult<DataType<Client['getCustomerProductListItem']>>;
 /**
  * Retrieves all public product lists as defined by the given search term (for example, email OR first name and last name).
+ * @group ShopperCustomers
+ * @category Query
  * @parameter apiOptions - Options to pass through to `commerce-sdk-isomorphic`, with `null` accepted for unset API parameters.
  * @parameter queryOptions - TanStack Query query options, with `enabled` by default set to check that all required API parameters have been set.
  * @returns A TanStack Query query hook with data from the Shopper Customers `getPublicProductListsBySearchTerm` endpoint.
@@ -93,6 +114,8 @@ export declare const useCustomerProductListItem: (apiOptions: NullableParameters
 export declare const usePublicProductListsBySearchTerm: (apiOptions: NullableParameters<Argument<Client['getPublicProductListsBySearchTerm']>>, queryOptions?: ApiQueryOptions<Client['getPublicProductListsBySearchTerm']>) => UseQueryResult<DataType<Client['getPublicProductListsBySearchTerm']>>;
 /**
  * Retrieves a public product list by ID and the items under that product list.
+ * @group ShopperCustomers
+ * @category Query
  * @parameter apiOptions - Options to pass through to `commerce-sdk-isomorphic`, with `null` accepted for unset API parameters.
  * @parameter queryOptions - TanStack Query query options, with `enabled` by default set to check that all required API parameters have been set.
  * @returns A TanStack Query query hook with data from the Shopper Customers `getPublicProductList` endpoint.
@@ -103,6 +126,8 @@ export declare const usePublicProductListsBySearchTerm: (apiOptions: NullablePar
 export declare const usePublicProductList: (apiOptions: NullableParameters<Argument<Client['getPublicProductList']>>, queryOptions?: ApiQueryOptions<Client['getPublicProductList']>) => UseQueryResult<DataType<Client['getPublicProductList']>>;
 /**
  * Retrieves an item from a public product list and the actual product details like product, image, availability and price.
+ * @group ShopperCustomers
+ * @category Query
  * @parameter apiOptions - Options to pass through to `commerce-sdk-isomorphic`, with `null` accepted for unset API parameters.
  * @parameter queryOptions - TanStack Query query options, with `enabled` by default set to check that all required API parameters have been set.
  * @returns A TanStack Query query hook with data from the Shopper Customers `getProductListItem` endpoint.