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

package/hooks/ShopperCustomers/query.js

@@ -58,8 +58,12 @@ function _asyncToGenerator(fn) { return function () { var self = this, args = ar
 //         requiredParameters
 //     })
 // }
+
 /**
- * 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.
@@ -98,6 +102,8 @@ const useCustomer = (apiOptions, queryOptions = {}) => {
 };
 /**
  * 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.
@@ -137,6 +143,8 @@ const useCustomerAddress = (apiOptions, queryOptions = {}) => {
 };
 /**
  * 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.
@@ -175,7 +183,11 @@ const useCustomerBaskets = (apiOptions, queryOptions = {}) => {
   });
 };
 /**
- * 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.
@@ -215,6 +227,8 @@ const useCustomerOrders = (apiOptions, queryOptions = {}) => {
 };
 /**
  * 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.
@@ -254,6 +268,8 @@ const useCustomerPaymentInstrument = (apiOptions, queryOptions = {}) => {
 };
 /**
  * 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.
@@ -293,6 +309,8 @@ const useCustomerProductLists = (apiOptions, queryOptions = {}) => {
 };
 /**
  * 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.
@@ -332,6 +350,8 @@ const useCustomerProductList = (apiOptions, queryOptions = {}) => {
 };
 /**
  * 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.
@@ -371,6 +391,8 @@ const useCustomerProductListItem = (apiOptions, queryOptions = {}) => {
 };
 /**
  * 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.
@@ -410,6 +432,8 @@ const usePublicProductListsBySearchTerm = (apiOptions, queryOptions = {}) => {
 };
 /**
  * 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.
@@ -449,6 +473,8 @@ const usePublicProductList = (apiOptions, queryOptions = {}) => {
 };
 /**
  * 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.

package/hooks/ShopperExperience/query.d.ts

@@ -2,11 +2,12 @@ import { UseQueryResult } from '@tanstack/react-query';
 import { ApiClients, ApiQueryOptions, Argument, DataType, NullableParameters } from '../types';
 declare type Client = ApiClients['shopperExperience'];
 /**
- * Get Page Designer pages. The results will apply the visibility rules for each page's components, such as personalization or scheduled visibility.
-
-Either `categoryId` or `productId` must be given in addition to `aspectTypeId`. Because only a single page-to-product and page-to-category assignment per aspect type can be authored today, the returned results contains one element at most.
-
-**Important**: Because this resource uses the GET method, you must not pass sensitive data (payment card information, for example) and must not perform any transactional processes within the server-side scripts that are run for the page and components.
+ * Get Page Designer pages.
+ *
+ * The results will apply the visibility rules for each page's components, such as personalization or scheduled visibility. Either `categoryId` or `productId` must be given in addition to `aspectTypeId`. Because only a single page-to-product and page-to-category assignment per aspect type can be authored today, the returned results contains one element at most.
+ * **Important**: Because this resource uses the GET method, you must not pass sensitive data (payment card information, for example) and must not perform any transactional processes within the server-side scripts that are run for the page and components.
+ * @group ShopperExperience
+ * @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 Experience `getPages` endpoint.
@@ -16,9 +17,12 @@ Either `categoryId` or `productId` must be given in addition to `aspectTypeId`.
  */
 export declare const usePages: (apiOptions: NullableParameters<Argument<Client['getPages']>>, queryOptions?: ApiQueryOptions<Client['getPages']>) => UseQueryResult<DataType<Client['getPages']>>;
 /**
- * Get a Page Designer page based on a single page ID. The results will apply the visibility rules for the page's components, such as personalization or scheduled visibility.
-
-**Important**: Because this resource uses the GET method, you must not pass sensitive data (payment card information, for example) and must not perform any transactional processes within the server-side scripts that are run for the page and components.
+ * Get a Page Designer page based on a single page ID.
+ *
+ * The results will apply the visibility rules for the page's components, such as personalization or scheduled visibility.
+ * **Important**: Because this resource uses the GET method, you must not pass sensitive data (payment card information, for example) and must not perform any transactional processes within the server-side scripts that are run for the page and components.
+ * @group ShopperExperience
+ * @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 Experience `getPage` endpoint.

package/hooks/ShopperExperience/query.js

@@ -19,11 +19,12 @@ 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
                                                                                                                                                                                                                                                                                                                                                                                                        */
 /**
- * Get Page Designer pages. The results will apply the visibility rules for each page's components, such as personalization or scheduled visibility.
-
-Either `categoryId` or `productId` must be given in addition to `aspectTypeId`. Because only a single page-to-product and page-to-category assignment per aspect type can be authored today, the returned results contains one element at most.
-
-**Important**: Because this resource uses the GET method, you must not pass sensitive data (payment card information, for example) and must not perform any transactional processes within the server-side scripts that are run for the page and components.
+ * Get Page Designer pages.
+ *
+ * The results will apply the visibility rules for each page's components, such as personalization or scheduled visibility. Either `categoryId` or `productId` must be given in addition to `aspectTypeId`. Because only a single page-to-product and page-to-category assignment per aspect type can be authored today, the returned results contains one element at most.
+ * **Important**: Because this resource uses the GET method, you must not pass sensitive data (payment card information, for example) and must not perform any transactional processes within the server-side scripts that are run for the page and components.
+ * @group ShopperExperience
+ * @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 Experience `getPages` endpoint.
@@ -61,9 +62,12 @@ const usePages = (apiOptions, queryOptions = {}) => {
   });
 };
 /**
- * Get a Page Designer page based on a single page ID. The results will apply the visibility rules for the page's components, such as personalization or scheduled visibility.
-
-**Important**: Because this resource uses the GET method, you must not pass sensitive data (payment card information, for example) and must not perform any transactional processes within the server-side scripts that are run for the page and components.
+ * Get a Page Designer page based on a single page ID.
+ *
+ * The results will apply the visibility rules for the page's components, such as personalization or scheduled visibility.
+ * **Important**: Because this resource uses the GET method, you must not pass sensitive data (payment card information, for example) and must not perform any transactional processes within the server-side scripts that are run for the page and components.
+ * @group ShopperExperience
+ * @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 Experience `getPage` endpoint.

package/hooks/ShopperGiftCertificates/query.d.ts

@@ -3,6 +3,8 @@ import { ApiClients, ApiQueryOptions, Argument, DataType, NullableParameters } f
 declare type Client = ApiClients['shopperGiftCertificates'];
 /**
  * Action to retrieve an existing gift certificate.
+ * @group ShopperGiftCertificates
+ * @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 Gift Certificates `getGiftCertificate` endpoint.

package/hooks/ShopperGiftCertificates/query.js

@@ -25,6 +25,8 @@ function _asyncToGenerator(fn) { return function () { var self = this, args = ar
                                                                                                                                                                                                                                                                                                                                                                                                        */
 /**
  * Action to retrieve an existing gift certificate.
+ * @group ShopperGiftCertificates
+ * @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 Gift Certificates `getGiftCertificate` endpoint.

package/hooks/ShopperLogin/mutation.d.ts

@@ -1,14 +1,16 @@
 import { ApiClients, Argument, DataType } from '../types';
 import { UseMutationResult } from '@tanstack/react-query';
 declare type Client = ApiClients['shopperLogin'];
-/** Mutations available for Shopper Login. */
+/**
+ * Mutations available for Shopper Login
+ * @group ShopperLogin
+ * @category Mutation
+ * @enum
+ */
 export declare const ShopperLoginMutations: {
     /**
      * Allows the customer to authenticate when their identity provider is down.
      * @returns A TanStack Query mutation hook for interacting with the Shopper Login `authorizePasswordlessCustomer` endpoint.
-     * @see {@link https://developer.salesforce.com/docs/commerce/commerce-api/references/shopper-login?meta=authorizePasswordlessCustomer| Salesforce Developer Center} for more information about the API endpoint.
-     * @see {@link https://salesforcecommercecloud.github.io/commerce-sdk-isomorphic/classes/shopperlogin.shopperlogin-1.html#authorizepasswordlesscustomer | `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 AuthorizePasswordlessCustomer: "authorizePasswordlessCustomer";
     /**
@@ -18,30 +20,12 @@ Required header: Authorization header bearer token of the Shopper access token t
 
 Required parameters: `refresh token`, `channel_id`, and `client`.
    * @returns A TanStack Query mutation hook for interacting with the Shopper Login `logoutCustomer` endpoint.
-   * @see {@link https://developer.salesforce.com/docs/commerce/commerce-api/references/shopper-login?meta=logoutCustomer| Salesforce Developer Center} for more information about the API endpoint.
-   * @see {@link https://salesforcecommercecloud.github.io/commerce-sdk-isomorphic/classes/shopperlogin.shopperlogin-1.html#logoutcustomer | `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 LogoutCustomer: "logoutCustomer";
     /**
-   * Get the shopper or guest JWT access token and a refresh token. This is the second step of the OAuth 2.1 authorization code flow.
-
-For a private client, an application is able to get an access token for the shopper through the back channel (a trusted server) by passing in the client credentials and the authorization code retrieved from the `authorize` endpoint.
-
-For a guest user, get the shopper JWT access token and a refresh token. This is where a client appplication is able to get an access token for the guest user through the back channel (a trusted server) by passing in the client credentials.
-
-For a public client using PKCE, an application will pass a PKCE `code_verifier`` that matches the `code_challenge`` that was used to `authorize` the customer along with the authorization code.
-
-When refreshing the access token with a private client ID and client secret, the refresh token is _not_ regenerated. However, when refreshing the access token with a public client ID, the refresh token is _always_ regenerated. The old refresh token is voided with every refresh call, so the refresh token on the client needs to be replaced to always store the new refresh token.
-
-See the Body section for required parameters, including `grant_type` and others, depending on the value of `grant_type`.
-
-**Important**: We strongly recommended using the `channel_id` query parameter because **it will be required in the future**.
-   * @returns A TanStack Query mutation hook for interacting with the Shopper Login `getAccessToken` endpoint.
-   * @see {@link https://developer.salesforce.com/docs/commerce/commerce-api/references/shopper-login?meta=getAccessToken| Salesforce Developer Center} for more information about the API endpoint.
-   * @see {@link https://salesforcecommercecloud.github.io/commerce-sdk-isomorphic/classes/shopperlogin.shopperlogin-1.html#getaccesstoken | `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.
-   */
+     * Get the shopper or guest JWT access token and a refresh token. This is the second step of the OAuth 2.1 authorization code flow.
+     * @returns A TanStack Query mutation hook for interacting with the Shopper Login `getAccessToken` endpoint.
+     */
     readonly GetAccessToken: "getAccessToken";
     /**
    * Get a shopper JWT access token for a registered customer using session bridge.
@@ -50,9 +34,6 @@ For public client id requests the grant_type must be set to `session_bridge`.
 
 For  private client_id and secret the grant_type must be set to `client_credentials` along with a basic authorization header.
    * @returns A TanStack Query mutation hook for interacting with the Shopper Login `getSessionBridgeAccessToken` endpoint.
-   * @see {@link https://developer.salesforce.com/docs/commerce/commerce-api/references/shopper-login?meta=getSessionBridgeAccessToken| Salesforce Developer Center} for more information about the API endpoint.
-   * @see {@link https://salesforcecommercecloud.github.io/commerce-sdk-isomorphic/classes/shopperlogin.shopperlogin-1.html#getsessionbridgeaccesstoken | `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 GetSessionBridgeAccessToken: "getSessionBridgeAccessToken";
     /**
@@ -62,9 +43,6 @@ For external trusted-system requests, a basic authorization header that includes
 
 For internal trusted-system requests, the bearer token must be a C2C JWT.
    * @returns A TanStack Query mutation hook for interacting with the Shopper Login `getTrustedSystemAccessToken` endpoint.
-   * @see {@link https://developer.salesforce.com/docs/commerce/commerce-api/references/shopper-login?meta=getTrustedSystemAccessToken| Salesforce Developer Center} for more information about the API endpoint.
-   * @see {@link https://salesforcecommercecloud.github.io/commerce-sdk-isomorphic/classes/shopperlogin.shopperlogin-1.html#gettrustedsystemaccesstoken | `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 GetTrustedSystemAccessToken: "getTrustedSystemAccessToken";
     /**
@@ -74,46 +52,40 @@ If using a SLAS private client ID, you must also use an `_sfdc_client_auth` head
 
 The value of the `_sfdc_client_auth` header must be a Base64-encoded string. The string is composed of a SLAS private client ID and client secret, separated by a colon (`:`). For example, `privateClientId:privateClientsecret` becomes `cHJpdmF0ZUNsaWVudElkOnByaXZhdGVDbGllbnRzZWNyZXQ=` after Base64 encoding.
    * @returns A TanStack Query mutation hook for interacting with the Shopper Login `getTrustedAgentAccessToken` endpoint.
-   * @see {@link https://developer.salesforce.com/docs/commerce/commerce-api/references/shopper-login?meta=getTrustedAgentAccessToken| Salesforce Developer Center} for more information about the API endpoint.
-   * @see {@link https://salesforcecommercecloud.github.io/commerce-sdk-isomorphic/classes/shopperlogin.shopperlogin-1.html#gettrustedagentaccesstoken | `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 GetTrustedAgentAccessToken: "getTrustedAgentAccessToken";
     /**
      * Creates a new password
      * @returns A TanStack Query mutation hook for interacting with the Shopper Login `resetPassword` endpoint.
-     * @see {@link https://developer.salesforce.com/docs/commerce/commerce-api/references/shopper-login?meta=resetPassword| Salesforce Developer Center} for more information about the API endpoint.
-     * @see {@link https://salesforcecommercecloud.github.io/commerce-sdk-isomorphic/classes/shopperlogin.shopperlogin-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";
     /**
      * Issue a shopper token (JWT).
      * @returns A TanStack Query mutation hook for interacting with the Shopper Login `getPasswordLessAccessToken` endpoint.
-     * @see {@link https://developer.salesforce.com/docs/commerce/commerce-api/references/shopper-login?meta=getPasswordLessAccessToken| Salesforce Developer Center} for more information about the API endpoint.
-     * @see {@link https://salesforcecommercecloud.github.io/commerce-sdk-isomorphic/classes/shopperlogin.shopperlogin-1.html#getpasswordlessaccesstoken | `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 GetPasswordLessAccessToken: "getPasswordLessAccessToken";
     /**
      * Invalidate the refresh token. A basic auth header with Base64-encoded `clientId:secret` is required in the Authorization header, and the refresh token to be revoked is required in the body.
      * @returns A TanStack Query mutation hook for interacting with the Shopper Login `revokeToken` endpoint.
-     * @see {@link https://developer.salesforce.com/docs/commerce/commerce-api/references/shopper-login?meta=revokeToken| Salesforce Developer Center} for more information about the API endpoint.
-     * @see {@link https://salesforcecommercecloud.github.io/commerce-sdk-isomorphic/classes/shopperlogin.shopperlogin-1.html#revoketoken | `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 RevokeToken: "revokeToken";
     /**
      * Returns the token properties. A basic auth header with Base64-encoded `clientId:secret` is required in the Authorization header, as well as an access token or refresh token. Use `token_type_hint` to help identify the token.
      * @returns A TanStack Query mutation hook for interacting with the Shopper Login `introspectToken` endpoint.
-     * @see {@link https://developer.salesforce.com/docs/commerce/commerce-api/references/shopper-login?meta=introspectToken| Salesforce Developer Center} for more information about the API endpoint.
-     * @see {@link https://salesforcecommercecloud.github.io/commerce-sdk-isomorphic/classes/shopperlogin.shopperlogin-1.html#introspecttoken | `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 IntrospectToken: "introspectToken";
 };
-/** Mutation for Shopper Login. */
+/**
+ * Mutation for Shopper Login.
+ * @group ShopperLogin
+ * @category Mutation
+ */
 export declare type ShopperLoginMutation = (typeof ShopperLoginMutations)[keyof typeof ShopperLoginMutations];
+/**
+ * Mutation hook for Shopper Login.
+ * @group ShopperLogin
+ * @category Mutation
+ */
 export declare function useShopperLoginMutation<Mutation extends ShopperLoginMutation>(mutation: Mutation): UseMutationResult<DataType<Client[Mutation]>, unknown, Argument<Client[Mutation]>>;
 export {};
 //# sourceMappingURL=mutation.d.ts.map

package/hooks/ShopperLogin/mutation.js

@@ -17,14 +17,16 @@ 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 Login. */
+/**
+ * Mutations available for Shopper Login
+ * @group ShopperLogin
+ * @category Mutation
+ * @enum
+ */
 const ShopperLoginMutations = {
   /**
    * Allows the customer to authenticate when their identity provider is down.
    * @returns A TanStack Query mutation hook for interacting with the Shopper Login `authorizePasswordlessCustomer` endpoint.
-   * @see {@link https://developer.salesforce.com/docs/commerce/commerce-api/references/shopper-login?meta=authorizePasswordlessCustomer| Salesforce Developer Center} for more information about the API endpoint.
-   * @see {@link https://salesforcecommercecloud.github.io/commerce-sdk-isomorphic/classes/shopperlogin.shopperlogin-1.html#authorizepasswordlesscustomer | `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.
    */
   AuthorizePasswordlessCustomer: 'authorizePasswordlessCustomer',
   /**
@@ -32,33 +34,18 @@ const ShopperLoginMutations = {
   Required header: Authorization header bearer token of the Shopper access token to logout.
   Required parameters: `refresh token`, `channel_id`, and `client`.
   * @returns A TanStack Query mutation hook for interacting with the Shopper Login `logoutCustomer` endpoint.
-  * @see {@link https://developer.salesforce.com/docs/commerce/commerce-api/references/shopper-login?meta=logoutCustomer| Salesforce Developer Center} for more information about the API endpoint.
-  * @see {@link https://salesforcecommercecloud.github.io/commerce-sdk-isomorphic/classes/shopperlogin.shopperlogin-1.html#logoutcustomer | `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.
   */
   LogoutCustomer: 'logoutCustomer',
   /**
-  * Get the shopper or guest JWT access token and a refresh token. This is the second step of the OAuth 2.1 authorization code flow.
-  For a private client, an application is able to get an access token for the shopper through the back channel (a trusted server) by passing in the client credentials and the authorization code retrieved from the `authorize` endpoint.
-  For a guest user, get the shopper JWT access token and a refresh token. This is where a client appplication is able to get an access token for the guest user through the back channel (a trusted server) by passing in the client credentials.
-  For a public client using PKCE, an application will pass a PKCE `code_verifier`` that matches the `code_challenge`` that was used to `authorize` the customer along with the authorization code.
-  When refreshing the access token with a private client ID and client secret, the refresh token is _not_ regenerated. However, when refreshing the access token with a public client ID, the refresh token is _always_ regenerated. The old refresh token is voided with every refresh call, so the refresh token on the client needs to be replaced to always store the new refresh token.
-  See the Body section for required parameters, including `grant_type` and others, depending on the value of `grant_type`.
-  **Important**: We strongly recommended using the `channel_id` query parameter because **it will be required in the future**.
-  * @returns A TanStack Query mutation hook for interacting with the Shopper Login `getAccessToken` endpoint.
-  * @see {@link https://developer.salesforce.com/docs/commerce/commerce-api/references/shopper-login?meta=getAccessToken| Salesforce Developer Center} for more information about the API endpoint.
-  * @see {@link https://salesforcecommercecloud.github.io/commerce-sdk-isomorphic/classes/shopperlogin.shopperlogin-1.html#getaccesstoken | `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.
-  */
+   * Get the shopper or guest JWT access token and a refresh token. This is the second step of the OAuth 2.1 authorization code flow.
+   * @returns A TanStack Query mutation hook for interacting with the Shopper Login `getAccessToken` endpoint.
+   */
   GetAccessToken: 'getAccessToken',
   /**
   * Get a shopper JWT access token for a registered customer using session bridge.
   For public client id requests the grant_type must be set to `session_bridge`.
   For  private client_id and secret the grant_type must be set to `client_credentials` along with a basic authorization header.
   * @returns A TanStack Query mutation hook for interacting with the Shopper Login `getSessionBridgeAccessToken` endpoint.
-  * @see {@link https://developer.salesforce.com/docs/commerce/commerce-api/references/shopper-login?meta=getSessionBridgeAccessToken| Salesforce Developer Center} for more information about the API endpoint.
-  * @see {@link https://salesforcecommercecloud.github.io/commerce-sdk-isomorphic/classes/shopperlogin.shopperlogin-1.html#getsessionbridgeaccesstoken | `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.
   */
   GetSessionBridgeAccessToken: 'getSessionBridgeAccessToken',
   /**
@@ -66,9 +53,6 @@ const ShopperLoginMutations = {
   For external trusted-system requests, a basic authorization header that includes a SLAS client ID and SLAS client secret can be used in place of the bearer token.
   For internal trusted-system requests, the bearer token must be a C2C JWT.
   * @returns A TanStack Query mutation hook for interacting with the Shopper Login `getTrustedSystemAccessToken` endpoint.
-  * @see {@link https://developer.salesforce.com/docs/commerce/commerce-api/references/shopper-login?meta=getTrustedSystemAccessToken| Salesforce Developer Center} for more information about the API endpoint.
-  * @see {@link https://salesforcecommercecloud.github.io/commerce-sdk-isomorphic/classes/shopperlogin.shopperlogin-1.html#gettrustedsystemaccesstoken | `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.
   */
   GetTrustedSystemAccessToken: 'getTrustedSystemAccessToken',
   /**
@@ -76,47 +60,41 @@ const ShopperLoginMutations = {
   If using a SLAS private client ID, you must also use an `_sfdc_client_auth` header. 
   The value of the `_sfdc_client_auth` header must be a Base64-encoded string. The string is composed of a SLAS private client ID and client secret, separated by a colon (`:`). For example, `privateClientId:privateClientsecret` becomes `cHJpdmF0ZUNsaWVudElkOnByaXZhdGVDbGllbnRzZWNyZXQ=` after Base64 encoding.
   * @returns A TanStack Query mutation hook for interacting with the Shopper Login `getTrustedAgentAccessToken` endpoint.
-  * @see {@link https://developer.salesforce.com/docs/commerce/commerce-api/references/shopper-login?meta=getTrustedAgentAccessToken| Salesforce Developer Center} for more information about the API endpoint.
-  * @see {@link https://salesforcecommercecloud.github.io/commerce-sdk-isomorphic/classes/shopperlogin.shopperlogin-1.html#gettrustedagentaccesstoken | `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.
   */
   GetTrustedAgentAccessToken: 'getTrustedAgentAccessToken',
   /**
    * Creates a new password
    * @returns A TanStack Query mutation hook for interacting with the Shopper Login `resetPassword` endpoint.
-   * @see {@link https://developer.salesforce.com/docs/commerce/commerce-api/references/shopper-login?meta=resetPassword| Salesforce Developer Center} for more information about the API endpoint.
-   * @see {@link https://salesforcecommercecloud.github.io/commerce-sdk-isomorphic/classes/shopperlogin.shopperlogin-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',
   /**
    * Issue a shopper token (JWT).
    * @returns A TanStack Query mutation hook for interacting with the Shopper Login `getPasswordLessAccessToken` endpoint.
-   * @see {@link https://developer.salesforce.com/docs/commerce/commerce-api/references/shopper-login?meta=getPasswordLessAccessToken| Salesforce Developer Center} for more information about the API endpoint.
-   * @see {@link https://salesforcecommercecloud.github.io/commerce-sdk-isomorphic/classes/shopperlogin.shopperlogin-1.html#getpasswordlessaccesstoken | `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.
    */
   GetPasswordLessAccessToken: 'getPasswordLessAccessToken',
   /**
    * Invalidate the refresh token. A basic auth header with Base64-encoded `clientId:secret` is required in the Authorization header, and the refresh token to be revoked is required in the body.
    * @returns A TanStack Query mutation hook for interacting with the Shopper Login `revokeToken` endpoint.
-   * @see {@link https://developer.salesforce.com/docs/commerce/commerce-api/references/shopper-login?meta=revokeToken| Salesforce Developer Center} for more information about the API endpoint.
-   * @see {@link https://salesforcecommercecloud.github.io/commerce-sdk-isomorphic/classes/shopperlogin.shopperlogin-1.html#revoketoken | `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.
    */
   RevokeToken: 'revokeToken',
   /**
    * Returns the token properties. A basic auth header with Base64-encoded `clientId:secret` is required in the Authorization header, as well as an access token or refresh token. Use `token_type_hint` to help identify the token.
    * @returns A TanStack Query mutation hook for interacting with the Shopper Login `introspectToken` endpoint.
-   * @see {@link https://developer.salesforce.com/docs/commerce/commerce-api/references/shopper-login?meta=introspectToken| Salesforce Developer Center} for more information about the API endpoint.
-   * @see {@link https://salesforcecommercecloud.github.io/commerce-sdk-isomorphic/classes/shopperlogin.shopperlogin-1.html#introspecttoken | `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.
    */
   IntrospectToken: 'introspectToken'
 };
 
-/** Mutation for Shopper Login. */
+/**
+ * Mutation for Shopper Login.
+ * @group ShopperLogin
+ * @category Mutation
+ */
 exports.ShopperLoginMutations = ShopperLoginMutations;
+/**
+ * Mutation hook for Shopper Login.
+ * @group ShopperLogin
+ * @category Mutation
+ */
 function useShopperLoginMutation(mutation) {
   const getCacheUpdates = _cache.cacheUpdateMatrix[mutation];
   // TODO: Remove this check when all mutations are implemented.

package/hooks/ShopperLogin/query.d.ts

@@ -3,6 +3,8 @@ import { ApiClients, ApiQueryOptions, Argument, DataType, NullableParameters } f
 declare type Client = ApiClients['shopperLogin'];
 /**
  * Get credential quality statistics for a user.
+ * @group ShopperLogin
+ * @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 Login `retrieveCredQualityUserInfo` endpoint.
@@ -13,6 +15,8 @@ declare type Client = ApiClients['shopperLogin'];
 export declare const useCredQualityUserInfo: (apiOptions: NullableParameters<Argument<Client['retrieveCredQualityUserInfo']>>, queryOptions?: ApiQueryOptions<Client['retrieveCredQualityUserInfo']>) => UseQueryResult<DataType<Client['retrieveCredQualityUserInfo']>>;
 /**
  * Returns a JSON listing of claims about the currently authenticated user.
+ * @group ShopperLogin
+ * @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 Login `getUserInfo` endpoint.
@@ -23,6 +27,8 @@ export declare const useCredQualityUserInfo: (apiOptions: NullableParameters<Arg
 export declare const useUserInfo: (apiOptions: NullableParameters<Argument<Client['getUserInfo']>>, queryOptions?: ApiQueryOptions<Client['getUserInfo']>) => UseQueryResult<DataType<Client['getUserInfo']>>;
 /**
  * Returns a JSON listing of the OpenID/OAuth endpoints, supported scopes and claims, public keys used to sign the tokens, and other details.
+ * @group ShopperLogin
+ * @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 Login `getWellknownOpenidConfiguration` endpoint.
@@ -33,6 +39,8 @@ export declare const useUserInfo: (apiOptions: NullableParameters<Argument<Clien
 export declare const useWellknownOpenidConfiguration: (apiOptions: NullableParameters<Argument<Client['getWellknownOpenidConfiguration']>>, queryOptions?: ApiQueryOptions<Client['getWellknownOpenidConfiguration']>) => UseQueryResult<DataType<Client['getWellknownOpenidConfiguration']>>;
 /**
  * Returns a JSON Web Key Set (JWKS) containing the current, past, and future public keys. The key set enables clients to validate the Shopper JSON Web Token (JWT) issued by SLAS.
+ * @group ShopperLogin
+ * @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 Login `getJwksUri` endpoint.

package/hooks/ShopperLogin/query.js

@@ -20,6 +20,8 @@ function _asyncToGenerator(fn) { return function () { var self = this, args = ar
                                                                                                                                                                                                                                                                                                                                                                                                        */
 /**
  * Get credential quality statistics for a user.
+ * @group ShopperLogin
+ * @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 Login `retrieveCredQualityUserInfo` endpoint.
@@ -58,6 +60,8 @@ const useCredQualityUserInfo = (apiOptions, queryOptions = {}) => {
 };
 /**
  * Returns a JSON listing of claims about the currently authenticated user.
+ * @group ShopperLogin
+ * @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 Login `getUserInfo` endpoint.
@@ -97,6 +101,8 @@ const useUserInfo = (apiOptions, queryOptions = {}) => {
 };
 /**
  * Returns a JSON listing of the OpenID/OAuth endpoints, supported scopes and claims, public keys used to sign the tokens, and other details.
+ * @group ShopperLogin
+ * @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 Login `getWellknownOpenidConfiguration` endpoint.
@@ -136,6 +142,8 @@ const useWellknownOpenidConfiguration = (apiOptions, queryOptions = {}) => {
 };
 /**
  * Returns a JSON Web Key Set (JWKS) containing the current, past, and future public keys. The key set enables clients to validate the Shopper JSON Web Token (JWT) issued by SLAS.
+ * @group ShopperLogin
+ * @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 Login `getJwksUri` endpoint.

package/hooks/ShopperOrders/mutation.d.ts

@@ -1,14 +1,16 @@
 import { ApiClients, Argument, DataType } from '../types';
 import { UseMutationResult } from '@tanstack/react-query';
 declare type Client = ApiClients['shopperOrders'];
-/** Mutations available for Shopper Orders. */
+/**
+ * Mutations available for Shopper Orders
+ * @group ShopperOrders
+ * @category Mutation
+ * @enum
+ */
 export declare const ShopperOrdersMutations: {
     /**
      * Submits an order based on a prepared basket. The only considered value from the request body is basketId.
      * @returns A TanStack Query mutation hook for interacting with the Shopper Orders `createOrder` endpoint.
-     * @see {@link https://developer.salesforce.com/docs/commerce/commerce-api/references/shopper-orders?meta=createOrder| Salesforce Developer Center} for more information about the API endpoint.
-     * @see {@link https://salesforcecommercecloud.github.io/commerce-sdk-isomorphic/classes/shopperorders.shopperorders-1.html#createorder | `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 CreateOrder: "createOrder";
     /**
@@ -19,36 +21,30 @@ Details:
 The payment instrument is added with the provided details. The payment method must be applicable for the order see GET
 /baskets/\{basketId\}/payment-methods, if the payment method is 'CREDIT_CARD' a paymentCard must be specified in the request.
    * @returns A TanStack Query mutation hook for interacting with the Shopper Orders `createPaymentInstrumentForOrder` endpoint.
-   * @see {@link https://developer.salesforce.com/docs/commerce/commerce-api/references/shopper-orders?meta=createPaymentInstrumentForOrder| Salesforce Developer Center} for more information about the API endpoint.
-   * @see {@link https://salesforcecommercecloud.github.io/commerce-sdk-isomorphic/classes/shopperorders.shopperorders-1.html#createpaymentinstrumentfororder | `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 CreatePaymentInstrumentForOrder: "createPaymentInstrumentForOrder";
     /**
      * Removes a payment instrument of an order.
      * @returns A TanStack Query mutation hook for interacting with the Shopper Orders `removePaymentInstrumentFromOrder` endpoint.
-     * @see {@link https://developer.salesforce.com/docs/commerce/commerce-api/references/shopper-orders?meta=removePaymentInstrumentFromOrder| Salesforce Developer Center} for more information about the API endpoint.
-     * @see {@link https://salesforcecommercecloud.github.io/commerce-sdk-isomorphic/classes/shopperorders.shopperorders-1.html#removepaymentinstrumentfromorder | `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 RemovePaymentInstrumentFromOrder: "removePaymentInstrumentFromOrder";
     /**
-   * Updates a payment instrument of an order.
-
-Details:
-
-The payment instrument is updated with the provided details. The payment method must be applicable for the
-order see GET /baskets/\{basketId\}/payment-methods, if the payment method is 'CREDIT_CARD' a
-paymentCard must be specified in the request.
-   * @returns A TanStack Query mutation hook for interacting with the Shopper Orders `updatePaymentInstrumentForOrder` endpoint.
-   * @see {@link https://developer.salesforce.com/docs/commerce/commerce-api/references/shopper-orders?meta=updatePaymentInstrumentForOrder| Salesforce Developer Center} for more information about the API endpoint.
-   * @see {@link https://salesforcecommercecloud.github.io/commerce-sdk-isomorphic/classes/shopperorders.shopperorders-1.html#updatepaymentinstrumentfororder | `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 a payment instrument of an order.
+     * @returns A TanStack Query mutation hook for interacting with the Shopper Orders `updatePaymentInstrumentForOrder` endpoint.
+     */
     readonly UpdatePaymentInstrumentForOrder: "updatePaymentInstrumentForOrder";
 };
-/** Mutation for Shopper Orders. */
+/**
+ * Mutation for Shopper Orders.
+ * @group ShopperOrders
+ * @category Mutation
+ */
 export declare type ShopperOrdersMutation = (typeof ShopperOrdersMutations)[keyof typeof ShopperOrdersMutations];
+/**
+ * Mutation hook for Shopper Orders.
+ * @group ShopperOrders
+ * @category Mutation
+ */
 export declare function useShopperOrdersMutation<Mutation extends ShopperOrdersMutation>(mutation: Mutation): UseMutationResult<DataType<Client[Mutation]>, unknown, Argument<Client[Mutation]>>;
 export {};
 //# sourceMappingURL=mutation.d.ts.map