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

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

@@ -1,8 +1,10 @@
 import { UseQueryResult } from '@tanstack/react-query';
 import { ApiClients, ApiQueryOptions, Argument, DataType, NullableParameters } from '../types';
-declare type Client = ApiClients['shopperLogin'];
+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/ShopperLogin/queryKeyHelpers.d.ts

@@ -1,10 +1,10 @@
 import type { ShopperLogin } from 'commerce-sdk-isomorphic';
 import { Argument, ExcludeTail } from '../types';
-declare type Client = ShopperLogin<{
+type Client = ShopperLogin<{
     shortCode: string;
 }>;
-declare type Params<T extends keyof QueryKeys> = Partial<Argument<Client[T]>['parameters']>;
-export declare type QueryKeys = {
+type Params<T extends keyof QueryKeys> = Partial<Argument<Client[T]>['parameters']>;
+export type QueryKeys = {
     retrieveCredQualityUserInfo: [
         '/commerce-sdk-react',
         '/organizations/',
@@ -34,7 +34,7 @@ export declare type QueryKeys = {
         Params<'getJwksUri'>
     ];
 };
-declare type QueryKeyHelper<T extends keyof QueryKeys> = {
+type QueryKeyHelper<T extends keyof QueryKeys> = {
     /**
      * Reduces the given parameters (which may have additional, unknown properties) to an object
      * containing *only* the properties required for an endpoint.

package/hooks/ShopperOrders/cache.d.ts

@@ -1,5 +1,5 @@
 import { ApiClients, CacheUpdateMatrix } from '../types';
-declare type Client = ApiClients['shopperOrders'];
+type Client = ApiClients['shopperOrders'];
 export declare const cacheUpdateMatrix: CacheUpdateMatrix<Client>;
 export {};
 //# sourceMappingURL=cache.d.ts.map

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. */
+type Client = ApiClients['shopperOrders'];
+/**
+ * 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. */
-export declare type ShopperOrdersMutation = (typeof ShopperOrdersMutations)[keyof typeof ShopperOrdersMutations];
+/**
+ * Mutation for Shopper Orders.
+ * @group ShopperOrders
+ * @category Mutation
+ */
+export 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

package/hooks/ShopperOrders/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 Orders. */
+/**
+ * Mutations available for Shopper Orders
+ * @group ShopperOrders
+ * @category Mutation
+ * @enum
+ */
 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.
    */
   CreateOrder: 'createOrder',
   /**
@@ -33,35 +35,31 @@ const ShopperOrdersMutations = {
   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.
   */
   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.
    */
   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.
+   */
   UpdatePaymentInstrumentForOrder: 'updatePaymentInstrumentForOrder'
 };
 
-/** Mutation for Shopper Orders. */
+/**
+ * Mutation for Shopper Orders.
+ * @group ShopperOrders
+ * @category Mutation
+ */
 exports.ShopperOrdersMutations = ShopperOrdersMutations;
+/**
+ * Mutation hook for Shopper Orders.
+ * @group ShopperOrders
+ * @category Mutation
+ */
 function useShopperOrdersMutation(mutation) {
   const getCacheUpdates = _cache.cacheUpdateMatrix[mutation];
   // TODO: Remove this check when all mutations are implemented.

package/hooks/ShopperOrders/query.d.ts

@@ -1,8 +1,10 @@
 import { UseQueryResult } from '@tanstack/react-query';
 import { ApiClients, ApiQueryOptions, Argument, DataType, NullableParameters } from '../types';
-declare type Client = ApiClients['shopperOrders'];
+type Client = ApiClients['shopperOrders'];
 /**
  * Gets information for an order.
+ * @group ShopperOrders
+ * @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 Orders `getOrder` endpoint.
@@ -13,6 +15,8 @@ declare type Client = ApiClients['shopperOrders'];
 export declare const useOrder: (apiOptions: NullableParameters<Argument<Client['getOrder']>>, queryOptions?: ApiQueryOptions<Client['getOrder']>) => UseQueryResult<DataType<Client['getOrder']>>;
 /**
  * Gets the applicable payment methods for an existing order considering the open payment amount only.
+ * @group ShopperOrders
+ * @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 Orders `getPaymentMethodsForOrder` endpoint.
@@ -25,6 +29,8 @@ export declare const usePaymentMethodsForOrder: (apiOptions: NullableParameters<
  * This method gives you the external taxation data of the order transferred from the basket during
 order creation. This endpoint can be called only if external taxation was used. See POST /baskets
 for more information.
+ * @group ShopperOrders
+ * @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 Orders `getTaxesFromOrder` endpoint.

package/hooks/ShopperOrders/query.js

@@ -20,6 +20,8 @@ function _asyncToGenerator(fn) { return function () { var self = this, args = ar
                                                                                                                                                                                                                                                                                                                                                                                                        */
 /**
  * Gets information for an order.
+ * @group ShopperOrders
+ * @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 Orders `getOrder` endpoint.
@@ -58,6 +60,8 @@ const useOrder = (apiOptions, queryOptions = {}) => {
 };
 /**
  * Gets the applicable payment methods for an existing order considering the open payment amount only.
+ * @group ShopperOrders
+ * @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 Orders `getPaymentMethodsForOrder` endpoint.
@@ -98,7 +102,9 @@ const usePaymentMethodsForOrder = (apiOptions, queryOptions = {}) => {
 /**
  * This method gives you the external taxation data of the order transferred from the basket during 
 order creation. This endpoint can be called only if external taxation was used. See POST /baskets 
-for more information.         
+for more information.     
+ * @group ShopperOrders
+ * @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 Orders `getTaxesFromOrder` endpoint.

package/hooks/ShopperOrders/queryKeyHelpers.d.ts

@@ -1,10 +1,10 @@
 import type { ShopperOrders } from 'commerce-sdk-isomorphic';
 import { Argument, ExcludeTail } from '../types';
-declare type Client = ShopperOrders<{
+type Client = ShopperOrders<{
     shortCode: string;
 }>;
-declare type Params<T extends keyof QueryKeys> = Partial<Argument<Client[T]>['parameters']>;
-export declare type QueryKeys = {
+type Params<T extends keyof QueryKeys> = Partial<Argument<Client[T]>['parameters']>;
+export type QueryKeys = {
     getOrder: [
         '/commerce-sdk-react',
         '/organizations/',
@@ -32,7 +32,7 @@ export declare type QueryKeys = {
         Params<'getTaxesFromOrder'>
     ];
 };
-declare type QueryKeyHelper<T extends keyof QueryKeys> = {
+type QueryKeyHelper<T extends keyof QueryKeys> = {
     /**
      * Reduces the given parameters (which may have additional, unknown properties) to an object
      * containing *only* the properties required for an endpoint.

package/hooks/ShopperProducts/query.d.ts

@@ -1,8 +1,10 @@
 import { UseQueryResult } from '@tanstack/react-query';
 import { ApiClients, ApiQueryOptions, Argument, DataType, NullableParameters } from '../types';
-declare type Client = ApiClients['shopperProducts'];
+type Client = ApiClients['shopperProducts'];
 /**
  * Allows access to multiple products by a single request. Only products that are online and assigned to a site catalog are returned. The maximum number of productIDs that can be requested are 24. Along with product details, the availability, product options, images, price, promotions, and variations for the valid products will be included, as appropriate.
+ * @group ShopperProducts
+ * @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 Products `getProducts` endpoint.
@@ -13,6 +15,8 @@ declare type Client = ApiClients['shopperProducts'];
 export declare const useProducts: (apiOptions: NullableParameters<Argument<Client['getProducts']>>, queryOptions?: ApiQueryOptions<Client['getProducts']>) => UseQueryResult<DataType<Client['getProducts']>>;
 /**
  * Allows access to product details for a single product ID. Only products that are online and assigned to a site catalog are returned. Along with product details, the availability, images, price, bundled_products, set_products, recommedations, product options, variations, and promotions for the products will be included, as appropriate.
+ * @group ShopperProducts
+ * @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 Products `getProduct` endpoint.
@@ -23,6 +27,8 @@ export declare const useProducts: (apiOptions: NullableParameters<Argument<Clien
 export declare const useProduct: (apiOptions: NullableParameters<Argument<Client['getProduct']>>, queryOptions?: ApiQueryOptions<Client['getProduct']>) => UseQueryResult<DataType<Client['getProduct']>>;
 /**
  * When you use the URL template, the server returns multiple categories (a result object of category documents). You can use this template as a convenient way of obtaining multiple categories in a single request, instead of issuing separate requests for each category. You can specify up to 50 multiple IDs. You must enclose the list of IDs in parentheses. If a category identifier contains parenthesis or the separator sign, you must URL encode the character. The server only returns online categories.
+ * @group ShopperProducts
+ * @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 Products `getCategories` endpoint.
@@ -35,6 +41,8 @@ export declare const useCategories: (apiOptions: NullableParameters<Argument<Cli
  * When you use the URL template below, the server returns a category identified by its ID; by default, the server
 also returns the first level of subcategories, but you can specify another level by setting the levels
 parameter. The server only returns online categories.
+ * @group ShopperProducts
+ * @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 Products `getCategory` endpoint.

package/hooks/ShopperProducts/query.js

@@ -20,6 +20,8 @@ function _asyncToGenerator(fn) { return function () { var self = this, args = ar
                                                                                                                                                                                                                                                                                                                                                                                                        */
 /**
  * Allows access to multiple products by a single request. Only products that are online and assigned to a site catalog are returned. The maximum number of productIDs that can be requested are 24. Along with product details, the availability, product options, images, price, promotions, and variations for the valid products will be included, as appropriate.
+ * @group ShopperProducts
+ * @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 Products `getProducts` endpoint.
@@ -58,6 +60,8 @@ const useProducts = (apiOptions, queryOptions = {}) => {
 };
 /**
  * Allows access to product details for a single product ID. Only products that are online and assigned to a site catalog are returned. Along with product details, the availability, images, price, bundled_products, set_products, recommedations, product options, variations, and promotions for the products will be included, as appropriate.
+ * @group ShopperProducts
+ * @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 Products `getProduct` endpoint.
@@ -97,6 +101,8 @@ const useProduct = (apiOptions, queryOptions = {}) => {
 };
 /**
  * When you use the URL template, the server returns multiple categories (a result object of category documents). You can use this template as a convenient way of obtaining multiple categories in a single request, instead of issuing separate requests for each category. You can specify up to 50 multiple IDs. You must enclose the list of IDs in parentheses. If a category identifier contains parenthesis or the separator sign, you must URL encode the character. The server only returns online categories.
+ * @group ShopperProducts
+ * @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 Products `getCategories` endpoint.
@@ -138,6 +144,8 @@ const useCategories = (apiOptions, queryOptions = {}) => {
  * When you use the URL template below, the server returns a category identified by its ID; by default, the server
 also returns the first level of subcategories, but you can specify another level by setting the levels
 parameter. The server only returns online categories.
+ * @group ShopperProducts
+ * @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 Products `getCategory` endpoint.

package/hooks/ShopperProducts/queryKeyHelpers.d.ts

@@ -1,10 +1,10 @@
 import type { ShopperProducts } from 'commerce-sdk-isomorphic';
 import { Argument, ExcludeTail } from '../types';
-declare type Client = ShopperProducts<{
+type Client = ShopperProducts<{
     shortCode: string;
 }>;
-declare type Params<T extends keyof QueryKeys> = Partial<Argument<Client[T]>['parameters']>;
-export declare type QueryKeys = {
+type Params<T extends keyof QueryKeys> = Partial<Argument<Client[T]>['parameters']>;
+export type QueryKeys = {
     getProducts: [
         '/commerce-sdk-react',
         '/organizations/',
@@ -36,7 +36,7 @@ export declare type QueryKeys = {
         Params<'getCategory'>
     ];
 };
-declare type QueryKeyHelper<T extends keyof QueryKeys> = {
+type QueryKeyHelper<T extends keyof QueryKeys> = {
     /**
      * Reduces the given parameters (which may have additional, unknown properties) to an object
      * containing *only* the properties required for an endpoint.

package/hooks/ShopperPromotions/query.d.ts

@@ -1,8 +1,10 @@
 import { UseQueryResult } from '@tanstack/react-query';
 import { ApiClients, ApiQueryOptions, Argument, DataType, NullableParameters } from '../types';
-declare type Client = ApiClients['shopperPromotions'];
+type Client = ApiClients['shopperPromotions'];
 /**
  * Returns an array of enabled promotions for a list of specified IDs. In the request URL, you can specify up to 50 IDs. If you specify an ID that contains either parentheses or the separator characters, you must URL encode these characters. Each request returns only enabled promotions as the server does not consider promotion qualifiers or schedules.
+ * @group ShopperPromotions
+ * @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 Promotions `getPromotions` endpoint.
@@ -17,6 +19,8 @@ criteria. In the request URL, you must provide a campaign_id parameter, and you
 range by providing start_date and end_date parameters. Both parameters are required to specify a date range, as
 omitting one causes the server to return a MissingParameterException fault. Each request returns only enabled
 promotions, since the server does not consider promotion qualifiers or schedules.
+ * @group ShopperPromotions
+ * @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 Promotions `getPromotionsForCampaign` endpoint.

package/hooks/ShopperPromotions/query.js

@@ -20,6 +20,8 @@ function _asyncToGenerator(fn) { return function () { var self = this, args = ar
                                                                                                                                                                                                                                                                                                                                                                                                        */
 /**
  * Returns an array of enabled promotions for a list of specified IDs. In the request URL, you can specify up to 50 IDs. If you specify an ID that contains either parentheses or the separator characters, you must URL encode these characters. Each request returns only enabled promotions as the server does not consider promotion qualifiers or schedules.
+ * @group ShopperPromotions
+ * @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 Promotions `getPromotions` endpoint.
@@ -62,6 +64,8 @@ criteria. In the request URL, you must provide a campaign_id parameter, and you
 range by providing start_date and end_date parameters. Both parameters are required to specify a date range, as 
 omitting one causes the server to return a MissingParameterException fault. Each request returns only enabled
 promotions, since the server does not consider promotion qualifiers or schedules.
+ * @group ShopperPromotions
+ * @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 Promotions `getPromotionsForCampaign` endpoint.