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

package/hooks/ShopperCustomers/query.js

@@ -0,0 +1,489 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.usePublicProductListsBySearchTerm = exports.usePublicProductList = exports.useProductListItem = exports.useCustomerProductLists = exports.useCustomerProductListItem = exports.useCustomerProductList = exports.useCustomerPaymentInstrument = exports.useCustomerOrders = exports.useCustomerBaskets = exports.useCustomerAddress = exports.useCustomer = void 0;
+var _useCommerceApi = _interopRequireDefault(require("../useCommerceApi"));
+var _useQuery = require("../useQuery");
+var _utils = require("../utils");
+var queryKeyHelpers = _interopRequireWildcard(require("./queryKeyHelpers"));
+function _getRequireWildcardCache(nodeInterop) { if (typeof WeakMap !== "function") return null; var cacheBabelInterop = new WeakMap(); var cacheNodeInterop = new WeakMap(); return (_getRequireWildcardCache = function (nodeInterop) { return nodeInterop ? cacheNodeInterop : cacheBabelInterop; })(nodeInterop); }
+function _interopRequireWildcard(obj, nodeInterop) { if (!nodeInterop && obj && obj.__esModule) { return obj; } if (obj === null || typeof obj !== "object" && typeof obj !== "function") { return { default: obj }; } var cache = _getRequireWildcardCache(nodeInterop); if (cache && cache.has(obj)) { return cache.get(obj); } var newObj = {}; var hasPropertyDescriptor = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var key in obj) { if (key !== "default" && Object.prototype.hasOwnProperty.call(obj, key)) { var desc = hasPropertyDescriptor ? Object.getOwnPropertyDescriptor(obj, key) : null; if (desc && (desc.get || desc.set)) { Object.defineProperty(newObj, key, desc); } else { newObj[key] = obj[key]; } } } newObj.default = obj; if (cache) { cache.set(obj, newObj); } return newObj; }
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+function asyncGeneratorStep(gen, resolve, reject, _next, _throw, key, arg) { try { var info = gen[key](arg); var value = info.value; } catch (error) { reject(error); return; } if (info.done) { resolve(value); } else { Promise.resolve(value).then(_next, _throw); } }
+function _asyncToGenerator(fn) { return function () { var self = this, args = arguments; return new Promise(function (resolve, reject) { var gen = fn.apply(self, args); function _next(value) { asyncGeneratorStep(gen, resolve, reject, _next, _throw, "next", value); } function _throw(err) { asyncGeneratorStep(gen, resolve, reject, _next, _throw, "throw", err); } _next(undefined); }); }; } /*
+                                                                                                                                                                                                                                                                                                                                                                                                       * 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
+                                                                                                                                                                                                                                                                                                                                                                                                       */
+// TODO: Re-implement (and update description from RAML spec) when the endpoint exits closed beta.
+// /**
+//  * Gets the new external profile for a customer.This endpoint is in closed beta, available to select few customers. Please get in touch with your Account Team if you'd like to participate in the beta program
+//  * @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 `getExternalProfile` endpoint.
+//  * @see {@link https://developer.salesforce.com/docs/commerce/commerce-api/references/shopper-customers?meta=getExternalProfile| Salesforce Developer Center} for more information about the API endpoint.
+//  * @see {@link https://salesforcecommercecloud.github.io/commerce-sdk-isomorphic/classes/shoppercustomers.shoppercustomers-1.html#getexternalprofile | `commerce-sdk-isomorphic` documentation} for more information on the parameters and returned data type.
+//  * @see {@link https://tanstack.com/query/latest/docs/react/reference/useQuery | TanStack Query `useQuery` reference} for more information about the return value.
+//  */
+// export const useExternalProfile = (
+//     apiOptions: NullableParameters<Argument<Client['getExternalProfile']>>,
+//     queryOptions: ApiQueryOptions<Client['getExternalProfile']> = {}
+// ): UseQueryResult<DataType<Client['getExternalProfile']>> => {
+//     type Options = Argument<Client['getExternalProfile']>
+//     type Data = DataType<Client['getExternalProfile']>
+//     const {shopperCustomers: client} = useCommerceApi()
+//     const methodName = 'getExternalProfile'
+//     const requiredParameters = [
+//         'organizationId',
+//         'externalId',
+//         'authenticationProviderId',
+//         'siteId'
+//     ] as const
+
+//     // Parameters can be set in `apiOptions` or `client.clientConfig`;
+//     // we must merge them in order to generate the correct query key.
+//     const netOptions = omitNullableParameters(mergeOptions(client, apiOptions))
+//     const queryKey = queryKeyHelpers[methodName].queryKey(netOptions.parameters)
+//     // We don't use `netOptions` here because we manipulate the options in `useQuery`.
+//     const method = async (options: Options) => await client[methodName](options)
+
+//     // For some reason, if we don't explicitly set these generic parameters, the inferred type for
+//     // `Data` sometimes, but not always, includes `Response`, which is incorrect. I don't know why.
+//     return useQuery<Client, Options, Data>(netOptions, queryOptions, {
+//         method,
+//         queryKey,
+//         requiredParameters
+//     })
+// }
+/**
+ * Gets a customer with all existing addresses and payment instruments associated with the requested customer.
+ * @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.
+ * @see {@link https://developer.salesforce.com/docs/commerce/commerce-api/references/shopper-customers?meta=getCustomer| Salesforce Developer Center} for more information about the API endpoint.
+ * @see {@link https://salesforcecommercecloud.github.io/commerce-sdk-isomorphic/classes/shoppercustomers.shoppercustomers-1.html#getcustomer | `commerce-sdk-isomorphic` documentation} for more information on the parameters and returned data type.
+ * @see {@link https://tanstack.com/query/latest/docs/react/reference/useQuery | TanStack Query `useQuery` reference} for more information about the return value.
+ */
+const useCustomer = (apiOptions, queryOptions = {}) => {
+  const {
+    shopperCustomers: client
+  } = (0, _useCommerceApi.default)();
+  const methodName = 'getCustomer';
+  const requiredParameters = ['organizationId', 'customerId', 'siteId'];
+
+  // Parameters can be set in `apiOptions` or `client.clientConfig`;
+  // we must merge them in order to generate the correct query key.
+  const netOptions = (0, _utils.omitNullableParameters)((0, _utils.mergeOptions)(client, apiOptions));
+  const queryKey = queryKeyHelpers[methodName].queryKey(netOptions.parameters);
+  // We don't use `netOptions` here because we manipulate the options in `useQuery`.
+  const method = /*#__PURE__*/function () {
+    var _ref = _asyncToGenerator(function* (options) {
+      return yield client[methodName](options);
+    });
+    return function method(_x) {
+      return _ref.apply(this, arguments);
+    };
+  }();
+
+  // For some reason, if we don't explicitly set these generic parameters, the inferred type for
+  // `Data` sometimes, but not always, includes `Response`, which is incorrect. I don't know why.
+  return (0, _useQuery.useQuery)(netOptions, queryOptions, {
+    method,
+    queryKey,
+    requiredParameters
+  });
+};
+/**
+ * Retrieves a customer's address by address name.
+ * @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.
+ * @see {@link https://developer.salesforce.com/docs/commerce/commerce-api/references/shopper-customers?meta=getCustomerAddress| Salesforce Developer Center} for more information about the API endpoint.
+ * @see {@link https://salesforcecommercecloud.github.io/commerce-sdk-isomorphic/classes/shoppercustomers.shoppercustomers-1.html#getcustomeraddress | `commerce-sdk-isomorphic` documentation} for more information on the parameters and returned data type.
+ * @see {@link https://tanstack.com/query/latest/docs/react/reference/useQuery | TanStack Query `useQuery` reference} for more information about the return value.
+ */
+exports.useCustomer = useCustomer;
+const useCustomerAddress = (apiOptions, queryOptions = {}) => {
+  const {
+    shopperCustomers: client
+  } = (0, _useCommerceApi.default)();
+  const methodName = 'getCustomerAddress';
+  const requiredParameters = ['organizationId', 'customerId', 'addressName', 'siteId'];
+
+  // Parameters can be set in `apiOptions` or `client.clientConfig`;
+  // we must merge them in order to generate the correct query key.
+  const netOptions = (0, _utils.omitNullableParameters)((0, _utils.mergeOptions)(client, apiOptions));
+  const queryKey = queryKeyHelpers[methodName].queryKey(netOptions.parameters);
+  // We don't use `netOptions` here because we manipulate the options in `useQuery`.
+  const method = /*#__PURE__*/function () {
+    var _ref2 = _asyncToGenerator(function* (options) {
+      return yield client[methodName](options);
+    });
+    return function method(_x2) {
+      return _ref2.apply(this, arguments);
+    };
+  }();
+
+  // For some reason, if we don't explicitly set these generic parameters, the inferred type for
+  // `Data` sometimes, but not always, includes `Response`, which is incorrect. I don't know why.
+  return (0, _useQuery.useQuery)(netOptions, queryOptions, {
+    method,
+    queryKey,
+    requiredParameters
+  });
+};
+/**
+ * Gets the baskets of a customer.
+ * @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.
+ * @see {@link https://developer.salesforce.com/docs/commerce/commerce-api/references/shopper-customers?meta=getCustomerBaskets| Salesforce Developer Center} for more information about the API endpoint.
+ * @see {@link https://salesforcecommercecloud.github.io/commerce-sdk-isomorphic/classes/shoppercustomers.shoppercustomers-1.html#getcustomerbaskets | `commerce-sdk-isomorphic` documentation} for more information on the parameters and returned data type.
+ * @see {@link https://tanstack.com/query/latest/docs/react/reference/useQuery | TanStack Query `useQuery` reference} for more information about the return value.
+ */
+exports.useCustomerAddress = useCustomerAddress;
+const useCustomerBaskets = (apiOptions, queryOptions = {}) => {
+  const {
+    shopperCustomers: client
+  } = (0, _useCommerceApi.default)();
+  const methodName = 'getCustomerBaskets';
+  const requiredParameters = ['organizationId', 'customerId', 'siteId'];
+
+  // Parameters can be set in `apiOptions` or `client.clientConfig`;
+  // we must merge them in order to generate the correct query key.
+  const netOptions = (0, _utils.omitNullableParameters)((0, _utils.mergeOptions)(client, apiOptions));
+  const queryKey = queryKeyHelpers[methodName].queryKey(netOptions.parameters);
+  // We don't use `netOptions` here because we manipulate the options in `useQuery`.
+  const method = /*#__PURE__*/function () {
+    var _ref3 = _asyncToGenerator(function* (options) {
+      return yield client[methodName](options);
+    });
+    return function method(_x3) {
+      return _ref3.apply(this, arguments);
+    };
+  }();
+
+  // For some reason, if we don't explicitly set these generic parameters, the inferred type for
+  // `Data` sometimes, but not always, includes `Response`, which is incorrect. I don't know why.
+  return (0, _useQuery.useQuery)(netOptions, queryOptions, {
+    method,
+    queryKey,
+    requiredParameters
+  });
+};
+/**
+ * Returns a pageable list of all customer's orders. The default page size is 10.
+ * @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.
+ * @see {@link https://developer.salesforce.com/docs/commerce/commerce-api/references/shopper-customers?meta=getCustomerOrders| Salesforce Developer Center} for more information about the API endpoint.
+ * @see {@link https://salesforcecommercecloud.github.io/commerce-sdk-isomorphic/classes/shoppercustomers.shoppercustomers-1.html#getcustomerorders | `commerce-sdk-isomorphic` documentation} for more information on the parameters and returned data type.
+ * @see {@link https://tanstack.com/query/latest/docs/react/reference/useQuery | TanStack Query `useQuery` reference} for more information about the return value.
+ */
+exports.useCustomerBaskets = useCustomerBaskets;
+const useCustomerOrders = (apiOptions, queryOptions = {}) => {
+  const {
+    shopperCustomers: client
+  } = (0, _useCommerceApi.default)();
+  const methodName = 'getCustomerOrders';
+  const requiredParameters = ['organizationId', 'customerId', 'siteId'];
+
+  // Parameters can be set in `apiOptions` or `client.clientConfig`;
+  // we must merge them in order to generate the correct query key.
+  const netOptions = (0, _utils.omitNullableParameters)((0, _utils.mergeOptions)(client, apiOptions));
+  const queryKey = queryKeyHelpers[methodName].queryKey(netOptions.parameters);
+  // We don't use `netOptions` here because we manipulate the options in `useQuery`.
+  const method = /*#__PURE__*/function () {
+    var _ref4 = _asyncToGenerator(function* (options) {
+      return yield client[methodName](options);
+    });
+    return function method(_x4) {
+      return _ref4.apply(this, arguments);
+    };
+  }();
+
+  // For some reason, if we don't explicitly set these generic parameters, the inferred type for
+  // `Data` sometimes, but not always, includes `Response`, which is incorrect. I don't know why.
+  return (0, _useQuery.useQuery)(netOptions, queryOptions, {
+    method,
+    queryKey,
+    requiredParameters
+  });
+};
+/**
+ * Retrieves a customer's payment instrument by its ID.
+ * @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.
+ * @see {@link https://developer.salesforce.com/docs/commerce/commerce-api/references/shopper-customers?meta=getCustomerPaymentInstrument| Salesforce Developer Center} for more information about the API endpoint.
+ * @see {@link https://salesforcecommercecloud.github.io/commerce-sdk-isomorphic/classes/shoppercustomers.shoppercustomers-1.html#getcustomerpaymentinstrument | `commerce-sdk-isomorphic` documentation} for more information on the parameters and returned data type.
+ * @see {@link https://tanstack.com/query/latest/docs/react/reference/useQuery | TanStack Query `useQuery` reference} for more information about the return value.
+ */
+exports.useCustomerOrders = useCustomerOrders;
+const useCustomerPaymentInstrument = (apiOptions, queryOptions = {}) => {
+  const {
+    shopperCustomers: client
+  } = (0, _useCommerceApi.default)();
+  const methodName = 'getCustomerPaymentInstrument';
+  const requiredParameters = ['organizationId', 'customerId', 'paymentInstrumentId', 'siteId'];
+
+  // Parameters can be set in `apiOptions` or `client.clientConfig`;
+  // we must merge them in order to generate the correct query key.
+  const netOptions = (0, _utils.omitNullableParameters)((0, _utils.mergeOptions)(client, apiOptions));
+  const queryKey = queryKeyHelpers[methodName].queryKey(netOptions.parameters);
+  // We don't use `netOptions` here because we manipulate the options in `useQuery`.
+  const method = /*#__PURE__*/function () {
+    var _ref5 = _asyncToGenerator(function* (options) {
+      return yield client[methodName](options);
+    });
+    return function method(_x5) {
+      return _ref5.apply(this, arguments);
+    };
+  }();
+
+  // For some reason, if we don't explicitly set these generic parameters, the inferred type for
+  // `Data` sometimes, but not always, includes `Response`, which is incorrect. I don't know why.
+  return (0, _useQuery.useQuery)(netOptions, queryOptions, {
+    method,
+    queryKey,
+    requiredParameters
+  });
+};
+/**
+ * Returns all customer product lists.
+ * @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.
+ * @see {@link https://developer.salesforce.com/docs/commerce/commerce-api/references/shopper-customers?meta=getCustomerProductLists| Salesforce Developer Center} for more information about the API endpoint.
+ * @see {@link https://salesforcecommercecloud.github.io/commerce-sdk-isomorphic/classes/shoppercustomers.shoppercustomers-1.html#getcustomerproductlists | `commerce-sdk-isomorphic` documentation} for more information on the parameters and returned data type.
+ * @see {@link https://tanstack.com/query/latest/docs/react/reference/useQuery | TanStack Query `useQuery` reference} for more information about the return value.
+ */
+exports.useCustomerPaymentInstrument = useCustomerPaymentInstrument;
+const useCustomerProductLists = (apiOptions, queryOptions = {}) => {
+  const {
+    shopperCustomers: client
+  } = (0, _useCommerceApi.default)();
+  const methodName = 'getCustomerProductLists';
+  const requiredParameters = ['organizationId', 'customerId', 'siteId'];
+
+  // Parameters can be set in `apiOptions` or `client.clientConfig`;
+  // we must merge them in order to generate the correct query key.
+  const netOptions = (0, _utils.omitNullableParameters)((0, _utils.mergeOptions)(client, apiOptions));
+  const queryKey = queryKeyHelpers[methodName].queryKey(netOptions.parameters);
+  // We don't use `netOptions` here because we manipulate the options in `useQuery`.
+  const method = /*#__PURE__*/function () {
+    var _ref6 = _asyncToGenerator(function* (options) {
+      return yield client[methodName](options);
+    });
+    return function method(_x6) {
+      return _ref6.apply(this, arguments);
+    };
+  }();
+
+  // For some reason, if we don't explicitly set these generic parameters, the inferred type for
+  // `Data` sometimes, but not always, includes `Response`, which is incorrect. I don't know why.
+  return (0, _useQuery.useQuery)(netOptions, queryOptions, {
+    method,
+    queryKey,
+    requiredParameters
+  });
+};
+/**
+ * Returns a customer product list of the given customer and the items in the list.
+ * @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.
+ * @see {@link https://developer.salesforce.com/docs/commerce/commerce-api/references/shopper-customers?meta=getCustomerProductList| Salesforce Developer Center} for more information about the API endpoint.
+ * @see {@link https://salesforcecommercecloud.github.io/commerce-sdk-isomorphic/classes/shoppercustomers.shoppercustomers-1.html#getcustomerproductlist | `commerce-sdk-isomorphic` documentation} for more information on the parameters and returned data type.
+ * @see {@link https://tanstack.com/query/latest/docs/react/reference/useQuery | TanStack Query `useQuery` reference} for more information about the return value.
+ */
+exports.useCustomerProductLists = useCustomerProductLists;
+const useCustomerProductList = (apiOptions, queryOptions = {}) => {
+  const {
+    shopperCustomers: client
+  } = (0, _useCommerceApi.default)();
+  const methodName = 'getCustomerProductList';
+  const requiredParameters = ['organizationId', 'customerId', 'listId', 'siteId'];
+
+  // Parameters can be set in `apiOptions` or `client.clientConfig`;
+  // we must merge them in order to generate the correct query key.
+  const netOptions = (0, _utils.omitNullableParameters)((0, _utils.mergeOptions)(client, apiOptions));
+  const queryKey = queryKeyHelpers[methodName].queryKey(netOptions.parameters);
+  // We don't use `netOptions` here because we manipulate the options in `useQuery`.
+  const method = /*#__PURE__*/function () {
+    var _ref7 = _asyncToGenerator(function* (options) {
+      return yield client[methodName](options);
+    });
+    return function method(_x7) {
+      return _ref7.apply(this, arguments);
+    };
+  }();
+
+  // For some reason, if we don't explicitly set these generic parameters, the inferred type for
+  // `Data` sometimes, but not always, includes `Response`, which is incorrect. I don't know why.
+  return (0, _useQuery.useQuery)(netOptions, queryOptions, {
+    method,
+    queryKey,
+    requiredParameters
+  });
+};
+/**
+ * Returns an item of a customer product list and the actual product details like image, availability and price.
+ * @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.
+ * @see {@link https://developer.salesforce.com/docs/commerce/commerce-api/references/shopper-customers?meta=getCustomerProductListItem| Salesforce Developer Center} for more information about the API endpoint.
+ * @see {@link https://salesforcecommercecloud.github.io/commerce-sdk-isomorphic/classes/shoppercustomers.shoppercustomers-1.html#getcustomerproductlistitem | `commerce-sdk-isomorphic` documentation} for more information on the parameters and returned data type.
+ * @see {@link https://tanstack.com/query/latest/docs/react/reference/useQuery | TanStack Query `useQuery` reference} for more information about the return value.
+ */
+exports.useCustomerProductList = useCustomerProductList;
+const useCustomerProductListItem = (apiOptions, queryOptions = {}) => {
+  const {
+    shopperCustomers: client
+  } = (0, _useCommerceApi.default)();
+  const methodName = 'getCustomerProductListItem';
+  const requiredParameters = ['organizationId', 'customerId', 'listId', 'itemId', 'siteId'];
+
+  // Parameters can be set in `apiOptions` or `client.clientConfig`;
+  // we must merge them in order to generate the correct query key.
+  const netOptions = (0, _utils.omitNullableParameters)((0, _utils.mergeOptions)(client, apiOptions));
+  const queryKey = queryKeyHelpers[methodName].queryKey(netOptions.parameters);
+  // We don't use `netOptions` here because we manipulate the options in `useQuery`.
+  const method = /*#__PURE__*/function () {
+    var _ref8 = _asyncToGenerator(function* (options) {
+      return yield client[methodName](options);
+    });
+    return function method(_x8) {
+      return _ref8.apply(this, arguments);
+    };
+  }();
+
+  // For some reason, if we don't explicitly set these generic parameters, the inferred type for
+  // `Data` sometimes, but not always, includes `Response`, which is incorrect. I don't know why.
+  return (0, _useQuery.useQuery)(netOptions, queryOptions, {
+    method,
+    queryKey,
+    requiredParameters
+  });
+};
+/**
+ * Retrieves all public product lists as defined by the given search term (for example, email OR first name and last name).
+ * @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.
+ * @see {@link https://developer.salesforce.com/docs/commerce/commerce-api/references/shopper-customers?meta=getPublicProductListsBySearchTerm| Salesforce Developer Center} for more information about the API endpoint.
+ * @see {@link https://salesforcecommercecloud.github.io/commerce-sdk-isomorphic/classes/shoppercustomers.shoppercustomers-1.html#getpublicproductlistsbysearchterm | `commerce-sdk-isomorphic` documentation} for more information on the parameters and returned data type.
+ * @see {@link https://tanstack.com/query/latest/docs/react/reference/useQuery | TanStack Query `useQuery` reference} for more information about the return value.
+ */
+exports.useCustomerProductListItem = useCustomerProductListItem;
+const usePublicProductListsBySearchTerm = (apiOptions, queryOptions = {}) => {
+  const {
+    shopperCustomers: client
+  } = (0, _useCommerceApi.default)();
+  const methodName = 'getPublicProductListsBySearchTerm';
+  const requiredParameters = ['organizationId', 'siteId'];
+
+  // Parameters can be set in `apiOptions` or `client.clientConfig`;
+  // we must merge them in order to generate the correct query key.
+  const netOptions = (0, _utils.omitNullableParameters)((0, _utils.mergeOptions)(client, apiOptions));
+  const queryKey = queryKeyHelpers[methodName].queryKey(netOptions.parameters);
+  // We don't use `netOptions` here because we manipulate the options in `useQuery`.
+  const method = /*#__PURE__*/function () {
+    var _ref9 = _asyncToGenerator(function* (options) {
+      return yield client[methodName](options);
+    });
+    return function method(_x9) {
+      return _ref9.apply(this, arguments);
+    };
+  }();
+
+  // For some reason, if we don't explicitly set these generic parameters, the inferred type for
+  // `Data` sometimes, but not always, includes `Response`, which is incorrect. I don't know why.
+  return (0, _useQuery.useQuery)(netOptions, queryOptions, {
+    method,
+    queryKey,
+    requiredParameters
+  });
+};
+/**
+ * Retrieves a public product list by ID and the items under that product list.
+ * @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.
+ * @see {@link https://developer.salesforce.com/docs/commerce/commerce-api/references/shopper-customers?meta=getPublicProductList| Salesforce Developer Center} for more information about the API endpoint.
+ * @see {@link https://salesforcecommercecloud.github.io/commerce-sdk-isomorphic/classes/shoppercustomers.shoppercustomers-1.html#getpublicproductlist | `commerce-sdk-isomorphic` documentation} for more information on the parameters and returned data type.
+ * @see {@link https://tanstack.com/query/latest/docs/react/reference/useQuery | TanStack Query `useQuery` reference} for more information about the return value.
+ */
+exports.usePublicProductListsBySearchTerm = usePublicProductListsBySearchTerm;
+const usePublicProductList = (apiOptions, queryOptions = {}) => {
+  const {
+    shopperCustomers: client
+  } = (0, _useCommerceApi.default)();
+  const methodName = 'getPublicProductList';
+  const requiredParameters = ['organizationId', 'listId', 'siteId'];
+
+  // Parameters can be set in `apiOptions` or `client.clientConfig`;
+  // we must merge them in order to generate the correct query key.
+  const netOptions = (0, _utils.omitNullableParameters)((0, _utils.mergeOptions)(client, apiOptions));
+  const queryKey = queryKeyHelpers[methodName].queryKey(netOptions.parameters);
+  // We don't use `netOptions` here because we manipulate the options in `useQuery`.
+  const method = /*#__PURE__*/function () {
+    var _ref10 = _asyncToGenerator(function* (options) {
+      return yield client[methodName](options);
+    });
+    return function method(_x10) {
+      return _ref10.apply(this, arguments);
+    };
+  }();
+
+  // For some reason, if we don't explicitly set these generic parameters, the inferred type for
+  // `Data` sometimes, but not always, includes `Response`, which is incorrect. I don't know why.
+  return (0, _useQuery.useQuery)(netOptions, queryOptions, {
+    method,
+    queryKey,
+    requiredParameters
+  });
+};
+/**
+ * Retrieves an item from a public product list and the actual product details like product, image, availability and price.
+ * @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.
+ * @see {@link https://developer.salesforce.com/docs/commerce/commerce-api/references/shopper-customers?meta=getProductListItem| Salesforce Developer Center} for more information about the API endpoint.
+ * @see {@link https://salesforcecommercecloud.github.io/commerce-sdk-isomorphic/classes/shoppercustomers.shoppercustomers-1.html#getproductlistitem | `commerce-sdk-isomorphic` documentation} for more information on the parameters and returned data type.
+ * @see {@link https://tanstack.com/query/latest/docs/react/reference/useQuery | TanStack Query `useQuery` reference} for more information about the return value.
+ */
+exports.usePublicProductList = usePublicProductList;
+const useProductListItem = (apiOptions, queryOptions = {}) => {
+  const {
+    shopperCustomers: client
+  } = (0, _useCommerceApi.default)();
+  const methodName = 'getProductListItem';
+  const requiredParameters = ['organizationId', 'listId', 'itemId', 'siteId'];
+
+  // Parameters can be set in `apiOptions` or `client.clientConfig`;
+  // we must merge them in order to generate the correct query key.
+  const netOptions = (0, _utils.omitNullableParameters)((0, _utils.mergeOptions)(client, apiOptions));
+  const queryKey = queryKeyHelpers[methodName].queryKey(netOptions.parameters);
+  // We don't use `netOptions` here because we manipulate the options in `useQuery`.
+  const method = /*#__PURE__*/function () {
+    var _ref11 = _asyncToGenerator(function* (options) {
+      return yield client[methodName](options);
+    });
+    return function method(_x11) {
+      return _ref11.apply(this, arguments);
+    };
+  }();
+
+  // For some reason, if we don't explicitly set these generic parameters, the inferred type for
+  // `Data` sometimes, but not always, includes `Response`, which is incorrect. I don't know why.
+  return (0, _useQuery.useQuery)(netOptions, queryOptions, {
+    method,
+    queryKey,
+    requiredParameters
+  });
+};
+exports.useProductListItem = useProductListItem;

package/hooks/ShopperCustomers/queryKeyHelpers.d.ts

@@ -0,0 +1,142 @@
+import type { ShopperCustomers } from 'commerce-sdk-isomorphic';
+import { Argument, ExcludeTail } from '../types';
+declare type Client = ShopperCustomers<{
+    shortCode: string;
+}>;
+declare type Params<T extends keyof QueryKeys> = Partial<Argument<Client[T]>['parameters']>;
+export declare type QueryKeys = {
+    getExternalProfile: [
+        '/commerce-sdk-react',
+        '/organizations/',
+        string | undefined,
+        '/customers/external-profile',
+        Params<'getExternalProfile'>
+    ];
+    getCustomer: [
+        '/commerce-sdk-react',
+        '/organizations/',
+        string | undefined,
+        '/customers/',
+        string | undefined,
+        Params<'getCustomer'>
+    ];
+    getCustomerAddress: [
+        '/commerce-sdk-react',
+        '/organizations/',
+        string | undefined,
+        '/customers/',
+        string | undefined,
+        '/addresses/',
+        string | undefined,
+        Params<'getCustomerAddress'>
+    ];
+    getCustomerBaskets: [
+        '/commerce-sdk-react',
+        '/organizations/',
+        string | undefined,
+        '/customers/',
+        string | undefined,
+        '/baskets',
+        Params<'getCustomerBaskets'>
+    ];
+    getCustomerOrders: [
+        '/commerce-sdk-react',
+        '/organizations/',
+        string | undefined,
+        '/customers/',
+        string | undefined,
+        '/orders',
+        Params<'getCustomerOrders'>
+    ];
+    getCustomerPaymentInstrument: [
+        '/commerce-sdk-react',
+        '/organizations/',
+        string | undefined,
+        '/customers/',
+        string | undefined,
+        '/payment-instruments/',
+        string | undefined,
+        Params<'getCustomerPaymentInstrument'>
+    ];
+    getCustomerProductLists: [
+        '/commerce-sdk-react',
+        '/organizations/',
+        string | undefined,
+        '/customers/',
+        string | undefined,
+        '/product-lists',
+        Params<'getCustomerProductLists'>
+    ];
+    getCustomerProductList: [
+        '/commerce-sdk-react',
+        '/organizations/',
+        string | undefined,
+        '/customers/',
+        string | undefined,
+        '/product-lists/',
+        string | undefined,
+        Params<'getCustomerProductList'>
+    ];
+    getCustomerProductListItem: [
+        '/commerce-sdk-react',
+        '/organizations/',
+        string | undefined,
+        '/customers/',
+        string | undefined,
+        '/product-lists/',
+        string | undefined,
+        '/items/',
+        string | undefined,
+        Params<'getCustomerProductListItem'>
+    ];
+    getPublicProductListsBySearchTerm: [
+        '/commerce-sdk-react',
+        '/organizations/',
+        string | undefined,
+        '/product-lists',
+        Params<'getPublicProductListsBySearchTerm'>
+    ];
+    getPublicProductList: [
+        '/commerce-sdk-react',
+        '/organizations/',
+        string | undefined,
+        '/product-lists/',
+        string | undefined,
+        Params<'getPublicProductList'>
+    ];
+    getProductListItem: [
+        '/commerce-sdk-react',
+        '/organizations/',
+        string | undefined,
+        '/product-lists/',
+        string | undefined,
+        '/items/',
+        string | undefined,
+        Params<'getProductListItem'>
+    ];
+};
+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 getExternalProfile: QueryKeyHelper<'getExternalProfile'>;
+export declare const getCustomer: QueryKeyHelper<'getCustomer'>;
+export declare const getCustomerAddress: QueryKeyHelper<'getCustomerAddress'>;
+export declare const getCustomerBaskets: QueryKeyHelper<'getCustomerBaskets'>;
+export declare const getCustomerOrders: QueryKeyHelper<'getCustomerOrders'>;
+export declare const getCustomerPaymentInstrument: QueryKeyHelper<'getCustomerPaymentInstrument'>;
+export declare const getCustomerProductLists: QueryKeyHelper<'getCustomerProductLists'>;
+export declare const getCustomerProductList: QueryKeyHelper<'getCustomerProductList'>;
+export declare const getCustomerProductListItem: QueryKeyHelper<'getCustomerProductListItem'>;
+export declare const getPublicProductListsBySearchTerm: QueryKeyHelper<'getPublicProductListsBySearchTerm'>;
+export declare const getPublicProductList: QueryKeyHelper<'getPublicProductList'>;
+export declare const getProductListItem: QueryKeyHelper<'getProductListItem'>;
+export {};
+//# sourceMappingURL=queryKeyHelpers.d.ts.map