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

package/hooks/ShopperContexts/queryKeyHelpers.d.ts

@@ -0,0 +1,30 @@
+import type { ShopperContexts } from 'commerce-sdk-isomorphic';
+import { Argument, ExcludeTail } from '../types';
+declare type Client = ShopperContexts<{
+    shortCode: string;
+}>;
+declare type Params<T extends keyof QueryKeys> = Partial<Argument<Client[T]>['parameters']>;
+export declare type QueryKeys = {
+    getShopperContext: [
+        '/commerce-sdk-react',
+        '/organizations/',
+        string | undefined,
+        '/shopper-context/',
+        string | undefined,
+        Params<'getShopperContext'>
+    ];
+};
+declare 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.
+     */
+    parameters: (params: Params<T>) => Params<T>;
+    /** Generates the path component of the query key for an endpoint. */
+    path: (params: Params<T>) => ExcludeTail<QueryKeys[T]>;
+    /** Generates the full query key for an endpoint. */
+    queryKey: (params: Params<T>) => QueryKeys[T];
+};
+export declare const getShopperContext: QueryKeyHelper<'getShopperContext'>;
+export {};
+//# sourceMappingURL=queryKeyHelpers.d.ts.map

package/hooks/ShopperContexts/queryKeyHelpers.js

@@ -0,0 +1,25 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.getShopperContext = void 0;
+var _utils = require("../utils");
+/*
+ * Copyright (c) 2023, Salesforce, Inc.
+ * All rights reserved.
+ * SPDX-License-Identifier: BSD-3-Clause
+ * For full license text, see the LICENSE file in the repo root or https://opensource.org/licenses/BSD-3-Clause
+ */
+
+// We must use a client with no parameters in order to have required/optional match the API spec
+
+// This is defined here, rather than `types.ts`, because it relies on `Client` and `QueryKeys`,
+// and making those generic would add too much complexity.
+
+const getShopperContext = {
+  parameters: params => (0, _utils.pick)(params, ['organizationId', 'usid']),
+  path: params => ['/commerce-sdk-react', '/organizations/', params.organizationId, '/shopper-context/', params.usid],
+  queryKey: params => [...getShopperContext.path(params), getShopperContext.parameters(params)]
+};
+exports.getShopperContext = getShopperContext;

package/hooks/ShopperCustomers/cache.d.ts

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

package/hooks/ShopperCustomers/cache.js

@@ -0,0 +1,387 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.cacheUpdateMatrix = void 0;
+var _queryKeyHelpers = require("./queryKeyHelpers");
+var _utils = require("../utils");
+function ownKeys(object, enumerableOnly) { var keys = Object.keys(object); if (Object.getOwnPropertySymbols) { var symbols = Object.getOwnPropertySymbols(object); enumerableOnly && (symbols = symbols.filter(function (sym) { return Object.getOwnPropertyDescriptor(object, sym).enumerable; })), keys.push.apply(keys, symbols); } return keys; }
+function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { var source = null != arguments[i] ? arguments[i] : {}; i % 2 ? ownKeys(Object(source), !0).forEach(function (key) { _defineProperty(target, key, source[key]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(target, Object.getOwnPropertyDescriptors(source)) : ownKeys(Object(source)).forEach(function (key) { Object.defineProperty(target, key, Object.getOwnPropertyDescriptor(source, key)); }); } return target; }
+function _defineProperty(obj, key, value) { key = _toPropertyKey(key); if (key in obj) { Object.defineProperty(obj, key, { value: value, enumerable: true, configurable: true, writable: true }); } else { obj[key] = value; } return obj; }
+function _toPropertyKey(arg) { var key = _toPrimitive(arg, "string"); return typeof key === "symbol" ? key : String(key); }
+function _toPrimitive(input, hint) { if (typeof input !== "object" || input === null) return input; var prim = input[Symbol.toPrimitive]; if (prim !== undefined) { var res = prim.call(input, hint || "default"); if (typeof res !== "object") return res; throw new TypeError("@@toPrimitive must return a primitive value."); } return (hint === "string" ? String : Number)(input); } /*
+                                                                                                                                                                                                                                                                                                                                                                                           * Copyright (c) 2023, Salesforce, Inc.
+                                                                                                                                                                                                                                                                                                                                                                                           * All rights reserved.
+                                                                                                                                                                                                                                                                                                                                                                                           * SPDX-License-Identifier: BSD-3-Clause
+                                                                                                                                                                                                                                                                                                                                                                                           * For full license text, see the LICENSE file in the repo root or https://opensource.org/licenses/BSD-3-Clause
+                                                                                                                                                                                                                                                                                                                                                                                           */
+const noop = () => ({});
+
+// ReactQuery type def for the updater function uses type `unknown` for the first param,
+// this makes it hard to define the `createUpdateFunction` below, so we created this type.
+// This is a slight variation of above, but we know the data is not null.
+/**
+ * Create an update handler for the cache matrix. This updater will implicitly clone and assert
+ * that the data being passed to is is not undefined.
+ *
+ * @param update
+ * @returns
+ */
+const createUpdateFunction = update => data => data ? update((0, _utils.clone)(data)) : undefined;
+const cacheUpdateMatrix = {
+  createCustomerAddress(customerId, {
+    parameters
+  }, response) {
+    // getCustomerAddress uses `addressName` rather than `addressId`
+    const newParams = _objectSpread(_objectSpread({}, parameters), {}, {
+      addressName: response.addressId
+    });
+    return {
+      update: [{
+        queryKey: _queryKeyHelpers.getCustomerAddress.queryKey(newParams)
+      }, {
+        queryKey: _queryKeyHelpers.getCustomer.queryKey(newParams),
+        updater: createUpdateFunction(customer => {
+          // Push new address onto the end of addresses list.
+          customer.addresses = [...(customer.addresses ?? []), response];
+          return customer;
+        })
+      }]
+    };
+  },
+  createCustomerPaymentInstrument(customerId, {
+    parameters
+  }, response) {
+    const newParams = _objectSpread(_objectSpread({}, parameters), {}, {
+      paymentInstrumentId: response.paymentInstrumentId
+    });
+    return {
+      update: [{
+        queryKey: _queryKeyHelpers.getCustomerPaymentInstrument.queryKey(newParams)
+      }, {
+        queryKey: _queryKeyHelpers.getCustomer.queryKey(newParams),
+        updater: createUpdateFunction(customer => {
+          customer.paymentInstruments = [...(customer.paymentInstruments ?? []), response];
+          return customer;
+        })
+      }]
+    };
+  },
+  createCustomerProductList(customerId, {
+    parameters
+  }, response) {
+    // We always invalidate, because even without an ID we assume that something has changed
+    const listId = response.id;
+    return {
+      update: [{
+        queryKey: _queryKeyHelpers.getCustomerProductLists.queryKey(parameters),
+        updater: createUpdateFunction(result => {
+          // Add new list to front of the lists.
+          result.data.unshift(response);
+          result.limit++;
+          result.total++;
+          return result;
+        })
+      }, {
+        queryKey: _queryKeyHelpers.getCustomerProductList.queryKey(_objectSpread(_objectSpread({}, parameters), {}, {
+          listId
+        }))
+      }]
+    };
+  },
+  createCustomerProductListItem(customerId, {
+    parameters
+  }, response) {
+    // We always invalidate, because even without an ID we assume that something has changed
+    // QUESTION: Why would we get a response that doesn't have an ID?
+    const itemId = response.id;
+    return {
+      update: [{
+        queryKey: _queryKeyHelpers.getCustomerProductListItem.queryKey(_objectSpread(_objectSpread({}, parameters), {}, {
+          itemId
+        }))
+      }, {
+        queryKey: _queryKeyHelpers.getCustomerProductList.queryKey(parameters),
+        updater: createUpdateFunction(list => {
+          return _objectSpread(_objectSpread({}, list), {}, {
+            customerProductListItems: [...((list === null || list === void 0 ? void 0 : list.customerProductListItems) || []), response]
+          });
+        })
+      }, {
+        queryKey: _queryKeyHelpers.getCustomerProductLists.queryKey(parameters),
+        updater: createUpdateFunction(result => {
+          // Find the list that we want to add the item to.
+          const list = result.data.find(({
+            id
+          }) => id === parameters.listId);
+          if (!list) {
+            return;
+          }
+          list.customerProductListItems = [...(list.customerProductListItems ?? []), response];
+          return result;
+        })
+      }]
+    };
+  },
+  deleteCustomerPaymentInstrument(customerId, {
+    parameters
+  }) {
+    return {
+      update: [{
+        queryKey: _queryKeyHelpers.getCustomer.queryKey(parameters),
+        updater: createUpdateFunction(customer => {
+          var _customer$paymentInst, _customer$paymentInst2;
+          const paymentInstrumentIndex = (_customer$paymentInst = customer.paymentInstruments) === null || _customer$paymentInst === void 0 ? void 0 : _customer$paymentInst.findIndex(({
+            paymentInstrumentId
+          }) => paymentInstrumentId === parameters.paymentInstrumentId);
+
+          // Return undefined (no changes) if no payment instrument was found.
+          if (paymentInstrumentIndex === undefined || paymentInstrumentIndex < 0) {
+            return;
+          }
+
+          // Remove the found payment instrument.
+          (_customer$paymentInst2 = customer.paymentInstruments) === null || _customer$paymentInst2 === void 0 ? void 0 : _customer$paymentInst2.splice(paymentInstrumentIndex, 1);
+          return customer;
+        })
+      }],
+      remove: [{
+        queryKey: _queryKeyHelpers.getCustomerPaymentInstrument.queryKey(parameters)
+      }]
+    };
+  },
+  deleteCustomerProductList(customerId, {
+    parameters
+  }) {
+    return {
+      update: [{
+        queryKey: _queryKeyHelpers.getCustomerProductLists.queryKey(parameters),
+        updater: createUpdateFunction(result => {
+          const listIndex = result.data.findIndex(({
+            id
+          }) => id === parameters.listId);
+
+          // Return undefined if no list is found
+          if (listIndex < 0) {
+            return;
+          }
+
+          // Remove the list from the result object
+          result.data.splice(listIndex, 1);
+          result.limit--;
+          result.total--;
+          return result;
+        })
+      }],
+      remove: [{
+        queryKey: _queryKeyHelpers.getCustomerProductList.path(parameters)
+      }]
+    };
+  },
+  deleteCustomerProductListItem(customerId, {
+    parameters
+  }) {
+    return {
+      update: [{
+        queryKey: _queryKeyHelpers.getCustomerProductList.queryKey(parameters),
+        updater: createUpdateFunction(list => {
+          var _list$customerProduct, _list$customerProduct2;
+          const itemIndex = (_list$customerProduct = list.customerProductListItems) === null || _list$customerProduct === void 0 ? void 0 : _list$customerProduct.findIndex(({
+            id
+          }) => id === parameters.itemId);
+
+          // Return undefined if there is no item found.
+          if (itemIndex === undefined || itemIndex < 0) {
+            return;
+          }
+
+          // Remove the list item
+          (_list$customerProduct2 = list.customerProductListItems) === null || _list$customerProduct2 === void 0 ? void 0 : _list$customerProduct2.splice(itemIndex, 1);
+          return list;
+        })
+      }, {
+        queryKey: _queryKeyHelpers.getCustomerProductLists.queryKey(parameters),
+        updater: createUpdateFunction(result => {
+          var _list$customerProduct3, _list$customerProduct4;
+          const list = result.data.find(({
+            id
+          }) => id === parameters.listId);
+          const itemIndex = list === null || list === void 0 ? void 0 : (_list$customerProduct3 = list.customerProductListItems) === null || _list$customerProduct3 === void 0 ? void 0 : _list$customerProduct3.findIndex(({
+            id
+          }) => id === parameters.itemId);
+
+          // Return undefined if no item was found in the provided list.
+          if (itemIndex === undefined || itemIndex < 0) {
+            return;
+          }
+
+          // Remove the item from the list.
+          list === null || list === void 0 ? void 0 : (_list$customerProduct4 = list.customerProductListItems) === null || _list$customerProduct4 === void 0 ? void 0 : _list$customerProduct4.splice(itemIndex, 1);
+          return result;
+        })
+      }],
+      remove: [{
+        queryKey: _queryKeyHelpers.getCustomerProductListItem.queryKey(parameters)
+      }]
+    };
+  },
+  getResetPasswordToken: noop,
+  // TODO: Should this update the `getCustomer` cache?
+  registerCustomer: noop,
+  // TODO: Implement when the endpoint exits closed beta.
+  // registerExternalProfile: TODO('registerExternalProfile'),
+  removeCustomerAddress(customerId, {
+    parameters
+  }) {
+    return {
+      update: [{
+        queryKey: _queryKeyHelpers.getCustomer.queryKey(parameters),
+        updater: createUpdateFunction(customer => {
+          var _customer$addresses, _customer$addresses2;
+          const addressIndex = (_customer$addresses = customer.addresses) === null || _customer$addresses === void 0 ? void 0 : _customer$addresses.findIndex(({
+            addressId
+          }) => addressId === parameters.addressName);
+
+          // Return undefined if the address is not found...
+          if (addressIndex === undefined || addressIndex < 0) {
+            return;
+          }
+
+          // Remove the found address.
+          (_customer$addresses2 = customer.addresses) === null || _customer$addresses2 === void 0 ? void 0 : _customer$addresses2.splice(addressIndex, 1);
+          return customer;
+        })
+      }],
+      remove: [{
+        queryKey: _queryKeyHelpers.getCustomerAddress.queryKey(parameters)
+      }]
+    };
+  },
+  resetPassword: noop,
+  updateCustomer(customerId, {
+    parameters
+  }) {
+    // When we update a customer, we don't know what data has changed, so we must invalidate all
+    // derivative endpoints. They conveniently all start with the same path as `getCustomer`,
+    // but we do NOT want to invalidate `getCustomer` itself, we want to _update_ it. (Ideally,
+    // we could invalidate *then* update, but React Query can't handle that.) To do so, we
+    // examine the path of each cached query. If it starts with the `getCustomer` path, we
+    // invalidate, UNLESS the first item afer the path is an object, because that means that it
+    // is the `getCustomer` query itself.
+    const path = _queryKeyHelpers.getCustomer.path(parameters);
+    const isNotGetCustomer = ({
+      queryKey
+    }) => typeof queryKey[path.length] !== 'object';
+    const predicate = (0, _utils.and)((0, _utils.pathStartsWith)(path), isNotGetCustomer);
+    return {
+      update: [{
+        queryKey: _queryKeyHelpers.getCustomer.queryKey(parameters)
+      }],
+      invalidate: [{
+        predicate
+      }]
+    };
+  },
+  updateCustomerAddress(customerId, {
+    parameters
+  }, response) {
+    return {
+      update: [{
+        queryKey: _queryKeyHelpers.getCustomerAddress.queryKey(parameters)
+      }, {
+        queryKey: _queryKeyHelpers.getCustomer.queryKey(parameters),
+        updater: createUpdateFunction(customer => {
+          if (!customer.addresses) return;
+          const addressIndex = customer.addresses.findIndex(({
+            addressId
+          }) => addressId === response.addressId);
+
+          // Return undefined if no address is found...
+          if (addressIndex === undefined || addressIndex < 0) {
+            return;
+          }
+
+          // Update the found address.
+          customer.addresses[addressIndex] = response;
+          return customer;
+        })
+      }]
+    };
+  },
+  updateCustomerPassword: noop,
+  updateCustomerProductList(customerId, {
+    parameters
+  }, response) {
+    return {
+      update: [{
+        queryKey: _queryKeyHelpers.getCustomerProductList.queryKey(parameters)
+      }, {
+        queryKey: _queryKeyHelpers.getCustomerProductLists.queryKey(parameters),
+        updater: createUpdateFunction(result => {
+          const listIndex = result.data.findIndex(({
+            id
+          }) => id === response.id);
+
+          // Return undefined if we didn't find the product list we were looking for.
+          if (listIndex < 0) {
+            return;
+          }
+
+          // Update the product list.
+          result.data[listIndex] = response;
+          return result;
+        })
+      }]
+    };
+  },
+  updateCustomerProductListItem(customerId, {
+    parameters
+  }, response) {
+    return {
+      update: [{
+        queryKey: _queryKeyHelpers.getCustomerProductListItem.queryKey(parameters)
+      }, {
+        queryKey: _queryKeyHelpers.getCustomerProductList.queryKey(parameters),
+        updater: createUpdateFunction(list => {
+          var _list$customerProduct5;
+          if (!list.customerProductListItems) return;
+          // Find the index of the item we want to update.
+          const itemIndex = (_list$customerProduct5 = list.customerProductListItems) === null || _list$customerProduct5 === void 0 ? void 0 : _list$customerProduct5.findIndex(({
+            id
+          }) => id === parameters.itemId);
+
+          // Return undefined when item isn't found.
+          if (itemIndex === undefined || itemIndex < 0) {
+            return;
+          }
+          list.customerProductListItems[itemIndex] = response;
+          return list;
+        })
+      }, {
+        queryKey: _queryKeyHelpers.getCustomerProductLists.queryKey(parameters),
+        updater: createUpdateFunction(result => {
+          // Find the list with the current list id.
+          const listIndex = result.data.findIndex(({
+            id
+          }) => id === parameters.listId);
+          // Find the index of the item in the list.
+          const items = result.data[listIndex].customerProductListItems;
+          if (!items) return;
+          const itemIndex = items.findIndex(({
+            id
+          }) => id === parameters.itemId);
+
+          // Return undefined if item isn't found...
+          if (itemIndex === undefined || itemIndex < 0) return;
+
+          // Update the item in the found list.
+          // NOTE: We know that there is an item to update given the item index is > -1
+          items[itemIndex] = response;
+          return result;
+        })
+      }]
+    };
+  }
+};
+exports.cacheUpdateMatrix = cacheUpdateMatrix;

package/hooks/ShopperCustomers/index.d.ts

@@ -0,0 +1,3 @@
+export * from './mutation';
+export * from './query';
+//# sourceMappingURL=index.d.ts.map

package/hooks/ShopperCustomers/index.js

@@ -0,0 +1,27 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+var _mutation = require("./mutation");
+Object.keys(_mutation).forEach(function (key) {
+  if (key === "default" || key === "__esModule") return;
+  if (key in exports && exports[key] === _mutation[key]) return;
+  Object.defineProperty(exports, key, {
+    enumerable: true,
+    get: function () {
+      return _mutation[key];
+    }
+  });
+});
+var _query = require("./query");
+Object.keys(_query).forEach(function (key) {
+  if (key === "default" || key === "__esModule") return;
+  if (key in exports && exports[key] === _query[key]) return;
+  Object.defineProperty(exports, key, {
+    enumerable: true,
+    get: function () {
+      return _query[key];
+    }
+  });
+});

package/hooks/ShopperCustomers/mutation.d.ts

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