@epcc-sdk/sdks-shopper 0.0.30 → 0.0.32

package/dist/client/sdk.gen.d.cts

@@ -1,4 +1,4 @@
-import { GetByContextReleaseData, ReleaseData, ErrorResponse, GetByContextAllHierarchiesData, HierarchyListData, GetByContextHierarchyData, HierarchyData, GetByContextHierarchyNodesData, NodeListData, GetByContextHierarchyChildNodesData, GetByContextAllNodesData, GetByContextNodeData, NodeData, GetByContextChildNodesData, GetByContextAllProductsData, ProductListData, GetByContextProductData, ProductData, GetByContextComponentProductIdsData, ProductReferenceListData, GetByContextChildProductsData, GetByContextProductsForHierarchyData, GetByContextProductsForNodeData, ConfigureByContextProductData, GetCatalogsData, CatalogListData, CreateCatalogData, CatalogData, DeleteCatalogByIdData, GetCatalogByIdData, UpdateCatalogData, DeleteReleasesData, GetReleasesData, ReleaseListData, PublishReleaseData, DeleteReleaseByIdData, GetReleaseByIdData, GetRulesData, RuleListData, CreateRuleData, RuleData, DeleteRuleByIdData, GetRuleByIdData, UpdateRuleData, GetAllHierarchiesData, GetHierarchyData, GetHierarchyNodesData, GetHierarchyChildNodesData, GetAllNodesData, GetNodeData, GetChildNodesData, GetAllProductsData, GetProductData, GetComponentProductIdsData, GetChildProductsData, GetProductsForHierarchyData, GetProductsForNodeData, GetCartsData, ResponseData, CartResponse, ResponsePageLinks, ResponseMetaCarts, ResponseError, CreateACartData, DeleteACartData, GetCartData, CartInclude, UpdateACartData, DeleteAllCartItemsData, GetCartItemsData, CartsResponse, ManageCartsData, BulkUpdateItemsInCartData, DeleteACartItemData, UpdateACartItemData, DeleteAccountCartAssociationData, CreateAccountCartAssociationData, CreateAccountCartAssociationResponse, DeleteCustomerCartAssociationData, CreateCustomerCartAssociationData, CartsRelationshipsCustomersData, DeleteAPromotionViaPromotionCodeData, AddTaxItemToCartData, CartsItemsTaxesObject, BulkDeleteTaxItemsFromCartData, BulkAddTaxItemsToCartData, CartsBulkTaxes, DeleteATaxItemData, UpdateATaxItemData, BulkDeleteCustomDiscountsFromCartData, BulkAddCustomDiscountsToCartData, CartsBulkCustomDiscountsResponse, DeleteCustomDiscountFromCartData, UpdateCustomDiscountForCartData, CartsCustomDiscountsResponse, AddCustomDiscountToCartItemData, DeleteCustomDiscountFromCartItemData, UpdateCustomDiscountForCartItemData, CreateCartPaymentIntentData, CheckoutApiData, OrderResponse, GetCustomerOrdersData, ResponseMetaOrders, OrderItemResponse, GetAnOrderData, UpdateAnOrderData, GetOrderItemsData, AnonymizeOrdersData, PaymentSetupData, TransactionResponse, ConfirmPaymentData, CaptureATransactionData, RefundATransactionData, GetOrderTransactionsData, GetATransactionData, CancelATransactionData, GetSubscriptionProductData, Product2, SubscriptionsErrorResponse, GetPlanData, Plan, ListOfferingsData, Offering, OfferingIncludes, Links2, GetOfferingData, ListOfferingPlansData, OfferingPlan, ListOfferingFeaturesData, OfferingFeature, ListOfferingProductsData, OfferingProduct, ListSubscriptionsData, Subscription, SubscriptionIncludes, GetSubscriptionData, ListSubscriptionProductsData, ListSubscriptionPlansData, ListSubscriptionStatesData, SubscriptionState, GetSubscriptionStateData, ListSubscriptionInvoicesData, SubscriptionInvoice, ListSubscriptionInvoicePaymentsData, SubscriptionInvoicePayment, GetSubscriptionInvoicePaymentData, GetSubscriptionInvoiceData, ListInvoicesData, GetInvoiceData, GetFeatureData, Feature, GetStockData, StockResponse, InventoriesErrorResponse, ListLocationsData, Location, CreateAnAccessTokenData, AccessTokenResponse, ErrorResponse2, GetV2AccountAddressesData, AccountAddressResponse, AccountAddressesErrorResponse, PostV2AccountAddressData, DeleteV2AccountAddressData, GetV2AccountAddressData, PutV2AccountAddressData, GetV2AccountsData, AccountResponse, MetaList, AccountManagementErrorResponse, PostV2AccountsData, GetV2AccountsAccountIdData, PutV2AccountsAccountIdData, PutV2AccountsAccountIdError, GetV2AccountMembersData, AccountMemberResponse, GetV2AccountMembersAccountMemberIdData, GetV2AccountsAccountIdAccountMembershipsData, AccountMembershipResponse, PostV2AccountMembersTokensData, AccountManagementAuthenticationTokenResponse, MetaAccountMemberId, CreateOneTimePasswordTokenRequestData, UpdatePasswordProfileInfoData, PasswordProfileInfoResponse, GetAllCurrenciesData, ResponseCurrency, GetACurrencyData, GetAllFilesData, File, ResultsMeta, ResultsLinks, FilesErrorResponse, GetAFileData } from './types.gen.cjs';
+import { GetByContextReleaseData, ReleaseData, ErrorResponse, GetByContextAllHierarchiesData, HierarchyListData, GetByContextHierarchyData, HierarchyData, GetByContextHierarchyNodesData, NodeListData, GetByContextHierarchyChildNodesData, GetByContextAllNodesData, GetByContextNodeData, NodeData, GetByContextChildNodesData, GetByContextAllProductsData, ProductListData, GetByContextProductData, ProductData, GetByContextAllRelatedProductsData, GetByContextComponentProductIdsData, ProductReferenceListData, GetByContextChildProductsData, GetByContextProductsForHierarchyData, GetByContextProductsForNodeData, ConfigureByContextProductData, GetCatalogsData, CatalogListData, CreateCatalogData, CatalogData, DeleteCatalogByIdData, GetCatalogByIdData, UpdateCatalogData, DeleteReleasesData, GetReleasesData, ReleaseListData, PublishReleaseData, DeleteReleaseByIdData, GetReleaseByIdData, GetRulesData, RuleListData, CreateRuleData, RuleData, DeleteRuleByIdData, GetRuleByIdData, UpdateRuleData, GetAllHierarchiesData, GetHierarchyData, GetHierarchyNodesData, GetHierarchyChildNodesData, GetAllNodesData, GetNodeData, GetChildNodesData, GetAllProductsData, GetProductData, GetAllRelatedProductsData, GetComponentProductIdsData, GetChildProductsData, GetProductsForHierarchyData, GetProductsForNodeData, GetCartsData, ResponseData, CartResponse, ResponsePageLinks, ResponseMetaCarts, ResponseError, CreateACartData, DeleteACartData, GetCartData, CartInclude, UpdateACartData, DeleteAllCartItemsData, GetCartItemsData, CartsResponse, ManageCartsData, BulkUpdateItemsInCartData, DeleteACartItemData, UpdateACartItemData, DeleteAccountCartAssociationData, CreateAccountCartAssociationData, CreateAccountCartAssociationResponse, DeleteCustomerCartAssociationData, CreateCustomerCartAssociationData, CartsRelationshipsCustomersData, DeleteAPromotionViaPromotionCodeData, AddTaxItemToCartData, CartsItemsTaxesObject, BulkDeleteTaxItemsFromCartData, BulkAddTaxItemsToCartData, CartsBulkTaxes, DeleteATaxItemData, UpdateATaxItemData, BulkDeleteCustomDiscountsFromCartData, BulkAddCustomDiscountsToCartData, CartsBulkCustomDiscountsResponse, DeleteCustomDiscountFromCartData, UpdateCustomDiscountForCartData, CartsCustomDiscountsResponse, AddCustomDiscountToCartItemData, DeleteCustomDiscountFromCartItemData, UpdateCustomDiscountForCartItemData, CreateCartPaymentIntentData, CheckoutApiData, OrderResponse, GetCustomerOrdersData, ResponseMetaOrders, OrderItemResponse, GetAnOrderData, UpdateAnOrderData, GetOrderItemsData, AnonymizeOrdersData, PaymentSetupData, TransactionResponse, ConfirmPaymentData, CaptureATransactionData, RefundATransactionData, GetOrderTransactionsData, GetATransactionData, CancelATransactionData, GetSubscriptionProductData, Product2, SubscriptionsErrorResponse, GetPlanData, Plan, ListOfferingsData, Offering, OfferingIncludes, Links2, GetOfferingData, ListOfferingPlansData, OfferingPlan, ListOfferingFeaturesData, OfferingFeature, ListOfferingProductsData, OfferingProduct, ListSubscriptionsData, Subscription, SubscriptionIncludes, GetSubscriptionData, ListSubscriptionProductsData, ListSubscriptionPlansData, ListSubscriptionStatesData, SubscriptionState, GetSubscriptionStateData, ListSubscriptionInvoicesData, SubscriptionInvoice, ListSubscriptionInvoicePaymentsData, SubscriptionInvoicePayment, GetSubscriptionInvoicePaymentData, GetSubscriptionInvoiceData, ListInvoicesData, GetInvoiceData, GetFeatureData, Feature, GetStockData, StockResponse, InventoriesErrorResponse, ListLocationsData, Location, CreateAnAccessTokenData, AccessTokenResponse, ErrorResponse2, GetV2AccountAddressesData, AccountAddressResponse, AccountAddressesErrorResponse, PostV2AccountAddressData, DeleteV2AccountAddressData, GetV2AccountAddressData, PutV2AccountAddressData, GetV2AccountsData, AccountResponse, MetaList, AccountManagementErrorResponse, PostV2AccountsData, GetV2AccountsAccountIdData, PutV2AccountsAccountIdData, PutV2AccountsAccountIdError, GetV2AccountMembersData, AccountMemberResponse, GetV2AccountMembersAccountMemberIdData, GetV2AccountsAccountIdAccountMembershipsData, AccountMembershipResponse, PostV2AccountMembersTokensData, AccountManagementAuthenticationTokenResponse, MetaAccountMemberId, CreateOneTimePasswordTokenRequestData, UpdatePasswordProfileInfoData, PasswordProfileInfoResponse, GetAllCurrenciesData, ResponseCurrency, GetACurrencyData, GetAllFilesData, File, ResultsMeta, ResultsLinks, FilesErrorResponse, GetAFileData } from './types.gen.cjs';
 import * as _hey_api_client_fetch from '@hey-api/client-fetch';
 import { Options } from '@hey-api/client-fetch';
 
@@ -25,13 +25,15 @@ declare const getByContextRelease: <ThrowOnError extends boolean = false>(option
  *
  * ### Building breadcrumbs in a storefront
  *
- * In a catalog, you can use a filter to return a list of nodes in a hierarchy structure that a product belongs to. You can use this to build breadcrumbs in your storefront. An example is shown below.
+ * In a catalog, you can use the nodes directly attached to a product to build breadcrumbs in your storefront. This eliminates the need for additional queries to fetch hierarchy or parent node details. Each node contains all the necessary information in `breadcrumbs` metadata, such as its own details and the details of its parent hierarchy/node(s), to construct the complete breadcrumb path without requiring additional queries.
+ *
+ * An example is shown below:
  *
  * `filter=in(id,c83bfe55-0d87-4302-a86d-ab19e7e323f1,6003d7ef-84f3-49bb-a8bd-4cbfa203dcbb)`
  *
- * - Specify the node Ids in the filter expression.
- * - You can have as many node Ids as you want.
- * - It does not matter what order you specify the node Ids. The nodes are returned in the order they were last updated.
+ * - Specify the node IDs directly attached to the product in the filter expression.
+ * - You can include as many node IDs as required.
+ * - It does not matter what order you specify the node IDs. The nodes are returned in the order they were last updated.
  *
  */
 declare const getByContextAllHierarchies: <ThrowOnError extends boolean = false>(options?: Options<GetByContextAllHierarchiesData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<HierarchyListData, ErrorResponse, ThrowOnError>;
@@ -49,7 +51,7 @@ declare const getByContextHierarchy: <ThrowOnError extends boolean = false>(opti
  *
  * If you have multiple catalog rules defined, the rule that best matches the shoppers context is used to determine which catalog is retrieved. For information about how rules are matched, see [Resolving Catalog Rules](/docs/api/pxm/catalog/rules#resolving-catalog-rules).
  *
- * In the `bread_crumb` metadata, you can identify the parent nodes that a node is associated with. This is useful if you want to improve how your shoppers search your store, for example. See [Product and Node Associations in Breadcrumb Metadata](/guides/How-To/Catalogs/breadcrumbs).
+ * In the `breadcrumbs` metadata, you can identify the parent nodes that a node is associated with. This is useful if you want to improve how your shoppers search your store, for example. See [Product and Node Associations in Breadcrumb Metadata](/guides/How-To/Catalogs/breadcrumbs).
  *
  * ### Filtering
  *
@@ -62,13 +64,15 @@ declare const getByContextHierarchy: <ThrowOnError extends boolean = false>(opti
  *
  * ### Building breadcrumbs in a storefront
  *
- * In a catalog, you can use a filter to return a list of nodes in a hierarchy structure that a product belongs to. You can use this to build breadcrumbs in your storefront. An example is shown below.
+ * In a catalog, you can use the nodes directly attached to a product to build breadcrumbs in your storefront. This eliminates the need for additional queries to fetch hierarchy or parent node details. Each node contains all the necessary information in `breadcrumbs` metadata, such as its own details and the details of its parent hierarchy/node(s), to construct the complete breadcrumb path without requiring additional queries.
+ *
+ * An example is shown below:
  *
  * `filter=in(id,c83bfe55-0d87-4302-a86d-ab19e7e323f1,6003d7ef-84f3-49bb-a8bd-4cbfa203dcbb)`
  *
- * - Specify the node Ids in the filter expression.
- * - You can have as many node Ids as you want.
- * - It does not matter what order you specify the node Ids. The nodes are returned in the order they were last updated.
+ * - Specify the node IDs directly attached to the product in the filter expression.
+ * - You can include as many node IDs as required.
+ * - It does not matter what order you specify the node IDs. The nodes are returned in the order they were last updated.
  *
  */
 declare const getByContextHierarchyNodes: <ThrowOnError extends boolean = false>(options: Options<GetByContextHierarchyNodesData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<NodeListData, ErrorResponse, ThrowOnError>;
@@ -80,7 +84,7 @@ declare const getByContextHierarchyNodes: <ThrowOnError extends boolean = false>
  *
  * If you have multiple catalog rules defined, the rule that best matches the shopperʼs context is used to determine which catalog is retrieved. For information about how rules are matched, see [Resolving Catalog Rules](/docs/api/pxm/catalog/rules#resolving-catalog-rules).
  *
- * In the `bread_crumb` metadata, you can identify the parent nodes that a node is associated with. This is useful if you want to improve how your shoppers search your store, for example. See [Product and Node Associations in Breadcrumb Metadata](/guides/How-To/Catalogs/breadcrumbs).
+ * In the `breadcrumbs` metadata, you can identify the parent nodes that a node is associated with. This is useful if you want to improve how your shoppers search your store, for example. See [Product and Node Associations in Breadcrumb Metadata](/guides/How-To/Catalogs/breadcrumbs).
  *
  * ### Filtering
  *
@@ -95,13 +99,15 @@ declare const getByContextHierarchyNodes: <ThrowOnError extends boolean = false>
  *
  * ### Building breadcrumbs in a storefront
  *
- * In a catalog, you can use a filter to return a list of nodes in a hierarchy structure that a product belongs to. You can use this to build breadcrumbs in your storefront. An example is shown below.
+ * In a catalog, you can use the nodes directly attached to a product to build breadcrumbs in your storefront. This eliminates the need for additional queries to fetch hierarchy or parent node details. Each node contains all the necessary information in `breadcrumbs` metadata, such as its own details and the details of its parent hierarchy/node(s), to construct the complete breadcrumb path without requiring additional queries.
+ *
+ * An example is shown below:
  *
  * `filter=in(id,c83bfe55-0d87-4302-a86d-ab19e7e323f1,6003d7ef-84f3-49bb-a8bd-4cbfa203dcbb)`
  *
- * - Specify the node Ids in the filter expression.
- * - You can have as many node Ids as you want.
- * - It does not matter what order you specify the node Ids. The nodes are returned in the order they were last updated.
+ * - Specify the node IDs directly attached to the product in the filter expression.
+ * - You can include as many node IDs as required.
+ * - It does not matter what order you specify the node IDs. The nodes are returned in the order they were last updated.
  *
  */
 declare const getByContextHierarchyChildNodes: <ThrowOnError extends boolean = false>(options: Options<GetByContextHierarchyChildNodesData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<NodeListData, ErrorResponse, ThrowOnError>;
@@ -111,7 +117,7 @@ declare const getByContextHierarchyChildNodes: <ThrowOnError extends boolean = f
  *
  * If you have multiple catalog rules defined, the rule that best matches the shoppers context is used to determine which catalog is retrieved. For information about how rules are matched, see [Resolving Catalog Rules](/docs/api/pxm/catalog/rules#resolving-catalog-rules).
  *
- * You can see the parent nodes a node is associated with in the `bread_crumb` metadata for each node. This is useful if you want to improve how your shoppers search your store, for example. See [Product and Node Associations in Breadcrumb Metadata](/guides/How-To/Catalogs/breadcrumbs).
+ * You can see the parent nodes a node is associated with in the `breadcrumbs` metadata for each node. This is useful if you want to improve how your shoppers search your store, for example. See [Product and Node Associations in Breadcrumb Metadata](/guides/How-To/Catalogs/breadcrumbs).
  *
  * In a catalog, you can use a filter to return a list of nodes in a hierarchy structure that a product belongs to. You can use this to build breadcrumbs in your storefront. For more information, see [Building breadcrumbs in a storefront](#building-breadcrumbs-in-a-storefront).
  *
@@ -132,13 +138,15 @@ declare const getByContextHierarchyChildNodes: <ThrowOnError extends boolean = f
  *
  * ### Building breadcrumbs in a storefront
  *
- * In a catalog, you can use a filter to return a list of nodes in a hierarchy structure that a product belongs to. You can use this to build breadcrumbs in your storefront. An example is shown below.
+ * In a catalog, you can use the nodes directly attached to a product to build breadcrumbs in your storefront. This eliminates the need for additional queries to fetch hierarchy or parent node details. Each node contains all the necessary information in `breadcrumbs` metadata, such as its own details and the details of its parent hierarchy/node(s), to construct the complete breadcrumb path without requiring additional queries.
+ *
+ * An example is shown below:
  *
  * `filter=in(id,c83bfe55-0d87-4302-a86d-ab19e7e323f1,6003d7ef-84f3-49bb-a8bd-4cbfa203dcbb)`
  *
- * - Specify the node Ids in the filter expression.
- * - You can have as many node Ids as you want.
- * - It does not matter what order you specify the node Ids. The nodes are returned in the order they were last updated.
+ * - Specify the node IDs directly attached to the product in the filter expression.
+ * - You can include as many node IDs as required.
+ * - It does not matter what order you specify the node IDs. The nodes are returned in the order they were last updated.
  *
  */
 declare const getByContextAllNodes: <ThrowOnError extends boolean = false>(options?: Options<GetByContextAllNodesData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<NodeListData, ErrorResponse, ThrowOnError>;
@@ -148,7 +156,7 @@ declare const getByContextAllNodes: <ThrowOnError extends boolean = false>(optio
  *
  * If you have multiple catalog rules defined, the rule that best matches the shoppers context is used to determine which catalog is retrieved. For information about how rules are matched, see [Resolving Catalog Rules](/docs/api/pxm/catalog/rules#resolving-catalog-rules).
  *
- * You can see the parent nodes a node is associated with in the `bread_crumb` metadata for each node. This is useful if you want to improve how your shoppers search your store, for example. See [Product and Node Associations in Breadcrumb Metadata](/guides/How-To/Catalogs/breadcrumbs).
+ * You can see the parent nodes a node is associated with in the `breadcrumbs` metadata for each node. This is useful if you want to improve how your shoppers search your store, for example. See [Product and Node Associations in Breadcrumb Metadata](/guides/How-To/Catalogs/breadcrumbs).
  *
  * The response lists the products associated with a node. If products are [curated](/guides/How-To/Products/curating-products), they are displayed in `curated_products`. Product curation allows you to promote specific products within each of your nodes, enabling you to create unique product collections in your storefront.
  *
@@ -166,7 +174,7 @@ declare const getByContextNode: <ThrowOnError extends boolean = false>(options:
  *
  * If you have multiple catalog rules defined, the rule that best matches the shoppers context is used to determine which catalog is retrieved. For information about how rules are matched, see [Resolving Catalog Rules](/docs/api/pxm/catalog/rules#resolving-catalog-rules).
  *
- * You can see which parent nodes a node is associated with in the `bread_crumb` metadata for each node. This is useful if you want to improve how your shoppers search your store, for example. See [Product and Node Associations in Breadcrumb Metadata](/guides/How-To/Catalogs/breadcrumbs).
+ * You can see which parent nodes a node is associated with in the `breadcrumbs` metadata for each node. This is useful if you want to improve how your shoppers search your store, for example. See [Product and Node Associations in Breadcrumb Metadata](/guides/How-To/Catalogs/breadcrumbs).
  *
  * The response lists the products associated with the nodes. If products are [curated](/guides/How-To/Products/curating-products), they are displayed in `curated_products`. Product curation allows you to promote specific products within each of your hierarchies, enabling you to create unique product collections in your storefront.
  *
@@ -188,13 +196,15 @@ declare const getByContextNode: <ThrowOnError extends boolean = false>(options:
  *
  * ### Building breadcrumbs in a storefront
  *
- * In a catalog, you can use a filter to return a list of nodes in a hierarchy structure that a product belongs to. You can use this to build breadcrumbs in your storefront. An example is shown below.
+ * In a catalog, you can use the nodes directly attached to a product to build breadcrumbs in your storefront. This eliminates the need for additional queries to fetch hierarchy or parent node details. Each node contains all the necessary information in `breadcrumbs` metadata, such as its own details and the details of its parent hierarchy/node(s), to construct the complete breadcrumb path without requiring additional queries.
+ *
+ * An example is shown below:
  *
  * `filter=in(id,c83bfe55-0d87-4302-a86d-ab19e7e323f1,6003d7ef-84f3-49bb-a8bd-4cbfa203dcbb)`
  *
- * - Specify the node Ids in the filter expression.
- * - You can have as many node Ids as you want.
- * - It does not matter what order you specify the node Ids. The nodes are returned in the order they were last updated.
+ * - Specify the node IDs directly attached to the product in the filter expression.
+ * - You can include as many node IDs as required.
+ * - It does not matter what order you specify the node IDs. The nodes are returned in the order they were last updated.
  *
  */
 declare const getByContextChildNodes: <ThrowOnError extends boolean = false>(options: Options<GetByContextChildNodesData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<NodeListData, ErrorResponse, ThrowOnError>;
@@ -210,7 +220,6 @@ declare const getByContextChildNodes: <ThrowOnError extends boolean = false>(opt
  *
  * You can see the parent nodes a product is associated within the `bread_crumbs` and `bread_crumb_nodes` metadata for each product. For example, this is useful if you want to improve how your shoppers search your store. See [Product and Node Associations in Breadcrumb Metadata](/guides/How-To/Catalogs/breadcrumbs).
  *
- *
  * ### Including Resources
  *
  * Using the `include` parameter, you can retrieve top-level resources, such as, files or main image, bundle component products and product attributes, such as SKU or slug.
@@ -234,13 +243,15 @@ declare const getByContextChildNodes: <ThrowOnError extends boolean = false>(opt
  *
  * ### Building breadcrumbs in a storefront
  *
- * In a catalog, you can use a filter to return a list of nodes in a hierarchy structure that a product belongs to. You can use this to build breadcrumbs in your storefront. An example is shown below.
+ * In a catalog, you can use the nodes directly attached to a product to build breadcrumbs in your storefront. This eliminates the need for additional queries to fetch hierarchy or parent node details. Each node contains all the necessary information in `breadcrumbs` metadata, such as its own details and the details of its parent hierarchy/node(s), to construct the complete breadcrumb path without requiring additional queries.
+ *
+ * An example is shown below:
  *
  * `filter=in(id,c83bfe55-0d87-4302-a86d-ab19e7e323f1,6003d7ef-84f3-49bb-a8bd-4cbfa203dcbb)`
  *
- * - Specify the node Ids in the filter expression.
- * - You can have as many node Ids as you want.
- * - It does not matter what order you specify the node Ids. The nodes are returned in the order they were last updated.
+ * - Specify the node IDs directly attached to the product in the filter expression.
+ * - You can include as many node IDs as required.
+ * - It does not matter what order you specify the node IDs. The nodes are returned in the order they were last updated.
  *
  */
 declare const getByContextAllProducts: <ThrowOnError extends boolean = false>(options?: Options<GetByContextAllProductsData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<ProductListData, ErrorResponse, ThrowOnError>;
@@ -264,6 +275,12 @@ declare const getByContextAllProducts: <ThrowOnError extends boolean = false>(op
  *
  */
 declare const getByContextProduct: <ThrowOnError extends boolean = false>(options: Options<GetByContextProductData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<ProductData, ErrorResponse, ThrowOnError>;
+/**
+ * Get all Related Products of a Product
+ * Returns related products of the provided product ID from a catalog.
+ *
+ */
+declare const getByContextAllRelatedProducts: <ThrowOnError extends boolean = false>(options: Options<GetByContextAllRelatedProductsData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<ProductListData, ErrorResponse, ThrowOnError>;
 /**
  * Get a Bundle's Component Products
  * With Product Experience Manager, you can [create](/docs/api/pxm/products/create-product) and manage bundles. A bundle is a purchasable product, comprising of one or more products that you want to sell together.
@@ -293,13 +310,15 @@ declare const getByContextComponentProductIds: <ThrowOnError extends boolean = f
  *
  * ### Building breadcrumbs in a storefront
  *
- * In a catalog, you can use a filter to return a list of nodes in a hierarchy structure that a product belongs to. You can use this to build breadcrumbs in your storefront. An example is shown below.
+ * In a catalog, you can use the nodes directly attached to a product to build breadcrumbs in your storefront. This eliminates the need for additional queries to fetch hierarchy or parent node details. Each node contains all the necessary information in `breadcrumbs` metadata, such as its own details and the details of its parent hierarchy/node(s), to construct the complete breadcrumb path without requiring additional queries.
+ *
+ * An example is shown below:
  *
  * `filter=in(id,c83bfe55-0d87-4302-a86d-ab19e7e323f1,6003d7ef-84f3-49bb-a8bd-4cbfa203dcbb)`
  *
- * - Specify the node Ids in the filter expression.
- * - You can have as many node Ids as you want.
- * - It does not matter what order you specify the node Ids. The nodes are returned in the order they were last updated.
+ * - Specify the node IDs directly attached to the product in the filter expression.
+ * - You can include as many node IDs as required.
+ * - It does not matter what order you specify the node IDs. The nodes are returned in the order they were last updated.
  *
  * ### Including Resources
  *
@@ -334,13 +353,15 @@ declare const getByContextChildProducts: <ThrowOnError extends boolean = false>(
  *
  * ### Building breadcrumbs in a storefront
  *
- * In a catalog, you can use a filter to return a list of nodes in a hierarchy structure that a product belongs to. You can use this to build breadcrumbs in your storefront. An example is shown below.
+ * In a catalog, you can use the nodes directly attached to a product to build breadcrumbs in your storefront. This eliminates the need for additional queries to fetch hierarchy or parent node details. Each node contains all the necessary information in `breadcrumbs` metadata, such as its own details and the details of its parent hierarchy/node(s), to construct the complete breadcrumb path without requiring additional queries.
+ *
+ * An example is shown below:
  *
  * `filter=in(id,c83bfe55-0d87-4302-a86d-ab19e7e323f1,6003d7ef-84f3-49bb-a8bd-4cbfa203dcbb)`
  *
- * - Specify the node Ids in the filter expression.
- * - You can have as many node Ids as you want.
- * - It does not matter what order you specify the node Ids. The nodes are returned in the order they were last updated.
+ * - Specify the node IDs directly attached to the product in the filter expression.
+ * - You can include as many node IDs as required.
+ * - It does not matter what order you specify the node IDs. The nodes are returned in the order they were last updated.
  *
  * ### Including Resources
  *
@@ -352,7 +373,6 @@ declare const getByContextChildProducts: <ThrowOnError extends boolean = false>(
  * | `main_image`         | Optional | The main images associated with a product. |
  * `files`              | Optional | Any files associated with a product. |
  *
- *
  * See [**Including Resources**](/guides/Getting-Started/includes).
  *
  */
@@ -376,13 +396,15 @@ declare const getByContextProductsForHierarchy: <ThrowOnError extends boolean =
  *
  * ### Building breadcrumbs in a storefront
  *
- * In a catalog, you can use a filter to return a list of nodes in a hierarchy structure that a product belongs to. You can use this to build breadcrumbs in your storefront. An example is shown below.
+ * In a catalog, you can use the nodes directly attached to a product to build breadcrumbs in your storefront. This eliminates the need for additional queries to fetch hierarchy or parent node details. Each node contains all the necessary information in `breadcrumbs` metadata, such as its own details and the details of its parent hierarchy/node(s), to construct the complete breadcrumb path without requiring additional queries.
+ *
+ * An example is shown below:
  *
  * `filter=in(id,c83bfe55-0d87-4302-a86d-ab19e7e323f1,6003d7ef-84f3-49bb-a8bd-4cbfa203dcbb)`
  *
- * - Specify the node Ids in the filter expression.
- * - You can have as many node Ids as you want.
- * - It does not matter what order you specify the node Ids. The nodes are returned in the order they were last updated.
+ * - Specify the node IDs directly attached to the product in the filter expression.
+ * - You can include as many node IDs as required.
+ * - It does not matter what order you specify the node IDs. The nodes are returned in the order they were last updated.
  *
  * ### Including Resources
  *
@@ -429,7 +451,17 @@ declare const configureByContextProduct: <ThrowOnError extends boolean = false>(
  *
  * You can use the `is_full_delta` attribute returned from the `get a release of a catalog` endpoint to determine if you need to refresh the data in your company system before publishing a catalog release and injecting fresh data in a delta link. The `is_full_delta` attribute tells you if this is a full publish of a catalog release. Using a search service as an example, if the `is_full_delta` attribute is `true`, you should remove all data about that catalog from the search service before publishing a catalog release and injecting fresh data from the delta file. See [Publish a catalog](/docs/api/pxm/catalog/publish-release).
  *
- * If the `is_full_publish` attribute returned in the response is `false`, data from the previous catalog release overlaid the existing data in the delta file. The `is_full_publish` attribute is always `true` the first time a catalog is published.
+ * If the `is_full_publish` attribute returned in the response is `false`, data from the previous catalog release overlaid the existing data in the delta file. The `is_full_publish` attribute is always `true` the first time a catalog is published. When determining whether delta data needs to be refreshed, ignore this attribute and always use the `is_full_delta` attribute.
+ *
+ * ### Filtering
+ *
+ * This endpoint supports filtering. For general filtering syntax, see [Filtering](/guides/Getting-Started/filtering). The following operators and attributes are available when filtering on this endpoint.
+ *
+ * | Operator | Description                                                                                     | Supported Attributes                                     | Example |
+ * |:---|:------------------------------------------------------------------------------------------------|:---------------------------------------------------------|:--- |
+ * | `eq` | Checks if the values of two operands are equal. If they are, the condition is true.       | `name`, | `filter=eq(name,some-name)` |
+ * | `in` | Checks if the values are included in the specified list. If they are, the condition is true. | `name`   | `filter=in(name,some-name,some-name2)` |
+ * | `like` | Checks if the operand contains the specified string. Wildcards are supported | `name`          | `filter=like(name,*some-name*)` |
  *
  */
 declare const getCatalogs: <ThrowOnError extends boolean = false>(options?: Options<GetCatalogsData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<CatalogListData, ErrorResponse, ThrowOnError>;
@@ -469,7 +501,7 @@ declare const deleteReleases: <ThrowOnError extends boolean = false>(options: Op
  *
  * You can use the `is_full_delta` attribute returned from the `get a release of a catalog` endpoint to determine if you need to refresh the data in your company system before publishing a catalog release and injecting fresh data in a delta link. The `is_full_delta` attribute tells you if this is a full publish of a catalog release. Using a search service as an example, if the `is_full_delta` attribute is `true`, you should remove all data about that catalog from the search service before publishing a catalog release and injecting fresh data from the delta file.
  *
- * If the `is_full_publish` attribute returned in the response is `false`, data from the previous catalog release overlaid the existing data in the delta file. The `is_full_publish` attribute is always `true` the first time a catalog is published.
+ * If the `is_full_publish` attribute returned in the response is `false`, data from the previous catalog release overlaid the existing data in the delta file. The `is_full_publish` attribute is always `true` the first time a catalog is published. When determining whether delta data needs to be refreshed, ignore this attribute and always use the `is_full_delta` attribute.
  *
  */
 declare const getReleases: <ThrowOnError extends boolean = false>(options: Options<GetReleasesData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<ReleaseListData, ErrorResponse, ThrowOnError>;
@@ -483,7 +515,7 @@ declare const getReleases: <ThrowOnError extends boolean = false>(options: Optio
  *
  * Once a catalog release has completed publishing, the delta relationship links to the delta document.
  *
- * The `delta` links are signed and only valid for 1 hour. Re-reading a catalog release, for example, using [Getting a release of a catalog](/docs/pxm/catalogs/catalog-latest-release/get-a-release-of-a-catalog) returns a fresh a link.
+ * The `delta` links are signed and only valid for 1 hour. Re-reading a catalog release, for example, using [Getting a release of a catalog](/docs/api/pxm/catalog/get-release-by-id) returns a fresh a link.
  *
  * You can use the `is_full_delta` attribute returned from the `get a release of a catalog` endpoint to determine if you need to refresh the data in your company system before injecting fresh data in a `delta` link. The `is_full_delta` attribute tells you if this is a full publish of the catalog. Using a search service as an example, if the `is_full_delta` attribute is `true`, you should remove all data about that catalog from the search service before injecting fresh data from the `delta` file. If the `is_full_delta` attribute is `false`, then data from the previous catalog overlays the existing data in the `delta` file. To publish a catalog and inject fresh data in a `delta` link, set `export_full_delta` to `true`.
  *
@@ -542,7 +574,8 @@ declare const getReleaseById: <ThrowOnError extends boolean = false>(options: Op
  *
  * | Operator | Description | Supported Attributes | Example |
  * |:--- |:--- |:--- |:--- |
- * | `In` | Checks if the values are included in the specified string. If they are, the condition is true. | `id` | `filter=in(id,some-id)` |
+ * | `eq` | Equals. Checks if the values of two operands are equal. If they are, the condition is true. | `id`,`catalog_id`,`account_ids`,`customer_ids`,`channels`,`tags` | `filter=eq(id,some-id)` |
+ * | `in` | Checks if the values are included in the specified string. If they are, the condition is true. | `id`,`account_ids`,`customer_ids`,`channels`,`tags` | `filter=in(account_ids,some-id,another-id)` |
  *
  */
 declare const getRules: <ThrowOnError extends boolean = false>(options?: Options<GetRulesData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<RuleListData, ErrorResponse, ThrowOnError>;
@@ -596,13 +629,15 @@ declare const updateRule: <ThrowOnError extends boolean = false>(options: Option
  *
  * ### Building breadcrumbs in a storefront
  *
- * In a catalog, you can use a filter to return a list of nodes in a hierarchy structure that a product belongs to. You can use this to build breadcrumbs in your storefront. An example is shown below.
+ * In a catalog, you can use the nodes directly attached to a product to build breadcrumbs in your storefront. This eliminates the need for additional queries to fetch hierarchy or parent node details. Each node contains all the necessary information in `breadcrumbs` metadata, such as its own details and the details of its parent hierarchy/node(s), to construct the complete breadcrumb path without requiring additional queries.
+ *
+ * An example is shown below:
  *
  * `filter=in(id,c83bfe55-0d87-4302-a86d-ab19e7e323f1,6003d7ef-84f3-49bb-a8bd-4cbfa203dcbb)`
  *
- * - Specify the node Ids in the filter expression.
- * - You can have as many node Ids as you want.
- * - It does not matter what order you specify the node Ids. The nodes are returned in the order they were last updated.
+ * - Specify the node IDs directly attached to the product in the filter expression.
+ * - You can include as many node IDs as required.
+ * - It does not matter what order you specify the node IDs. The nodes are returned in the order they were last updated.
  *
  */
 declare const getAllHierarchies: <ThrowOnError extends boolean = false>(options: Options<GetAllHierarchiesData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<HierarchyListData, ErrorResponse, ThrowOnError>;
@@ -628,7 +663,7 @@ declare const getHierarchy: <ThrowOnError extends boolean = false>(options: Opti
  *
  * :::
  *
- * In the `bread_crumb` metadata, you can identify the parent nodes that a node is associated with. This is useful if you want to improve how your shoppers search your store, for example. See [Product and Node Associations in Breadcrumb Metadata](/guides/How-To/Catalogs/breadcrumbs).
+ * In the `breadcrumbs` metadata, you can identify the parent nodes that a node is associated with. This is useful if you want to improve how your shoppers search your store, for example. See [Product and Node Associations in Breadcrumb Metadata](/guides/How-To/Catalogs/breadcrumbs).
  *
  * ### Filtering
  *
@@ -641,13 +676,15 @@ declare const getHierarchy: <ThrowOnError extends boolean = false>(options: Opti
  *
  * ### Building breadcrumbs in a storefront
  *
- * In a catalog, you can use a filter to return a list of nodes in a hierarchy structure that a product belongs to. You can use this to build breadcrumbs in your storefront. An example is shown below.
+ * In a catalog, you can use the nodes directly attached to a product to build breadcrumbs in your storefront. This eliminates the need for additional queries to fetch hierarchy or parent node details. Each node contains all the necessary information in `breadcrumbs` metadata, such as its own details and the details of its parent hierarchy/node(s), to construct the complete breadcrumb path without requiring additional queries.
+ *
+ * An example is shown below:
  *
  * `filter=in(id,c83bfe55-0d87-4302-a86d-ab19e7e323f1,6003d7ef-84f3-49bb-a8bd-4cbfa203dcbb)`
  *
- * - Specify the node Ids in the filter expression.
- * - You can have as many node Ids as you want.
- * - It does not matter what order you specify the node Ids. The nodes are returned in the order they were last updated.
+ * - Specify the node IDs directly attached to the product in the filter expression.
+ * - You can include as many node IDs as required.
+ * - It does not matter what order you specify the node IDs. The nodes are returned in the order they were last updated.
  *
  */
 declare const getHierarchyNodes: <ThrowOnError extends boolean = false>(options: Options<GetHierarchyNodesData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<NodeListData, ErrorResponse, ThrowOnError>;
@@ -663,7 +700,7 @@ declare const getHierarchyNodes: <ThrowOnError extends boolean = false>(options:
  *
  * :::
  *
- * In the `bread_crumb` metadata, you can identify the parent nodes that a node is associated with. This is useful if you want to improve how your shoppers search your store, for example. See [Product and Node Associations in Breadcrumb Metadata](/guides/How-To/Catalogs/breadcrumbs).
+ * In the `breadcrumbs` metadata, you can identify the parent nodes that a node is associated with. This is useful if you want to improve how your shoppers search your store, for example. See [Product and Node Associations in Breadcrumb Metadata](/guides/How-To/Catalogs/breadcrumbs).
  *
  * ### Filtering
  *
@@ -676,13 +713,15 @@ declare const getHierarchyNodes: <ThrowOnError extends boolean = false>(options:
  *
  * ### Building breadcrumbs in a storefront
  *
- * In a catalog, you can use a filter to return a list of nodes in a hierarchy structure that a product belongs to. You can use this to build breadcrumbs in your storefront. An example is shown below.
+ * In a catalog, you can use the nodes directly attached to a product to build breadcrumbs in your storefront. This eliminates the need for additional queries to fetch hierarchy or parent node details. Each node contains all the necessary information in `breadcrumbs` metadata, such as its own details and the details of its parent hierarchy/node(s), to construct the complete breadcrumb path without requiring additional queries.
+ *
+ * An example is shown below:
  *
  * `filter=in(id,c83bfe55-0d87-4302-a86d-ab19e7e323f1,6003d7ef-84f3-49bb-a8bd-4cbfa203dcbb)`
  *
- * - Specify the node Ids in the filter expression.
- * - You can have as many node Ids as you want.
- * - It does not matter what order you specify the node Ids. The nodes are returned in the order they were last updated.
+ * - Specify the node IDs directly attached to the product in the filter expression.
+ * - You can include as many node IDs as required.
+ * - It does not matter what order you specify the node IDs. The nodes are returned in the order they were last updated.
  *
  */
 declare const getHierarchyChildNodes: <ThrowOnError extends boolean = false>(options: Options<GetHierarchyChildNodesData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<NodeListData, ErrorResponse, ThrowOnError>;
@@ -696,7 +735,7 @@ declare const getHierarchyChildNodes: <ThrowOnError extends boolean = false>(opt
  *
  * :::
  *
- * You can see the parent nodes a node is associated with in the `bread_crumb` metadata for each node. This is useful if you want to improve how your shoppers search your store, for example. See [Product and Node Associations in Breadcrumb Metadata](/guides/How-To/Catalogs/breadcrumbs).
+ * You can see the parent nodes a node is associated with in the `breadcrumbs` metadata for each node. This is useful if you want to improve how your shoppers search your store, for example. See [Product and Node Associations in Breadcrumb Metadata](/guides/How-To/Catalogs/breadcrumbs).
  *
  * In a catalog, you can use a filter to return a list of nodes in a hierarchy structure that a product belongs to. You can use this to build breadcrumbs in your storefront. See [Building breadcrumbs in a storefront](#building-breadcrumbs-in-a-storefront).
  *
@@ -720,13 +759,15 @@ declare const getHierarchyChildNodes: <ThrowOnError extends boolean = false>(opt
  *
  * ### Building breadcrumbs in a storefront
  *
- * In a catalog, you can use a filter to return a list of nodes in a hierarchy structure that a product belongs to. You can use this to build breadcrumbs in your storefront. An example is shown below.
+ * In a catalog, you can use the nodes directly attached to a product to build breadcrumbs in your storefront. This eliminates the need for additional queries to fetch hierarchy or parent node details. Each node contains all the necessary information in `breadcrumbs` metadata, such as its own details and the details of its parent hierarchy/node(s), to construct the complete breadcrumb path without requiring additional queries.
+ *
+ * An example is shown below:
  *
  * `filter=in(id,c83bfe55-0d87-4302-a86d-ab19e7e323f1,6003d7ef-84f3-49bb-a8bd-4cbfa203dcbb)`
  *
- * - Specify the node Ids in the filter expression.
- * - You can have as many node Ids as you want.
- * - It does not matter what order you specify the node Ids. The nodes are returned in the order they were last updated.
+ * - Specify the node IDs directly attached to the product in the filter expression.
+ * - You can include as many node IDs as required.
+ * - It does not matter what order you specify the node IDs. The nodes are returned in the order they were last updated.
  *
  */
 declare const getAllNodes: <ThrowOnError extends boolean = false>(options: Options<GetAllNodesData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<NodeListData, ErrorResponse, ThrowOnError>;
@@ -740,7 +781,7 @@ declare const getAllNodes: <ThrowOnError extends boolean = false>(options: Optio
  *
  * :::
  *
- * You can see the parent nodes a node is associated with in the `bread_crumb` metadata for each node. This is useful if you want to improve how your shoppers search your store, for example. See [Product and Node Associations in Breadcrumb Metadata](/guides/How-To/Catalogs/breadcrumbs).
+ * You can see the parent nodes a node is associated with in the `breadcrumbs` metadata for each node. This is useful if you want to improve how your shoppers search your store, for example. See [Product and Node Associations in Breadcrumb Metadata](/guides/How-To/Catalogs/breadcrumbs).
  *
  * The response lists the products associated with the nodes. If products are [curated](/guides/How-To/Products/curating-products), they are displayed in `curated_products`. Product curation allows you to promote specific products within each of your hierarchies, enabling you to create unique product collections in your storefront.
  *
@@ -762,7 +803,7 @@ declare const getNode: <ThrowOnError extends boolean = false>(options: Options<G
  *
  * :::
  *
- * You can see the parent nodes a node is associated with in the `bread_crumb` metadata for each node. This is useful if you want to improve how your shoppers search your store, for example. See [Product and Node Associations in Breadcrumb Metadata](/guides/How-To/Catalogs/breadcrumbs).
+ * You can see the parent nodes a node is associated with in the `breadcrumbs` metadata for each node. This is useful if you want to improve how your shoppers search your store, for example. See [Product and Node Associations in Breadcrumb Metadata](/guides/How-To/Catalogs/breadcrumbs).
  *
  * In a catalog, you can use a filter to return a list of nodes in a hierarchy structure that a product belongs to. You can use this to build breadcrumbs in your storefront. For more information, see [Building breadcrumbs in a storefront](#building-breadcrumbs-in-a-storefront).
  *
@@ -786,13 +827,15 @@ declare const getNode: <ThrowOnError extends boolean = false>(options: Options<G
  *
  * ### Building breadcrumbs in a storefront
  *
- * In a catalog, you can use a filter to return a list of nodes in a hierarchy structure that a product belongs to. You can use this to build breadcrumbs in your storefront. An example is shown below.
+ * In a catalog, you can use the nodes directly attached to a product to build breadcrumbs in your storefront. This eliminates the need for additional queries to fetch hierarchy or parent node details. Each node contains all the necessary information in `breadcrumbs` metadata, such as its own details and the details of its parent hierarchy/node(s), to construct the complete breadcrumb path without requiring additional queries.
+ *
+ * An example is shown below:
  *
  * `filter=in(id,c83bfe55-0d87-4302-a86d-ab19e7e323f1,6003d7ef-84f3-49bb-a8bd-4cbfa203dcbb)`
  *
- * - Specify the node Ids in the filter expression.
- * - You can have as many node Ids as you want.
- * - It does not matter what order you specify the node Ids. The nodes are returned in the order they were last updated.
+ * - Specify the node IDs directly attached to the product in the filter expression.
+ * - You can include as many node IDs as required.
+ * - It does not matter what order you specify the node IDs. The nodes are returned in the order they were last updated.
  *
  */
 declare const getChildNodes: <ThrowOnError extends boolean = false>(options: Options<GetChildNodesData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<NodeListData, ErrorResponse, ThrowOnError>;
@@ -827,13 +870,15 @@ declare const getChildNodes: <ThrowOnError extends boolean = false>(options: Opt
  *
  * ### Building breadcrumbs in a storefront
  *
- * In a catalog, you can use a filter to return a list of nodes in a hierarchy structure that a product belongs to. You can use this to build breadcrumbs in your storefront. An example is shown below.
+ * In a catalog, you can use the nodes directly attached to a product to build breadcrumbs in your storefront. This eliminates the need for additional queries to fetch hierarchy or parent node details. Each node contains all the necessary information in `breadcrumbs` metadata, such as its own details and the details of its parent hierarchy/node(s), to construct the complete breadcrumb path without requiring additional queries.
+ *
+ * An example is shown below:
  *
  * `filter=in(id,c83bfe55-0d87-4302-a86d-ab19e7e323f1,6003d7ef-84f3-49bb-a8bd-4cbfa203dcbb)`
  *
- * - Specify the node Ids in the filter expression.
- * - You can have as many node Ids as you want.
- * - It does not matter what order you specify the node Ids. The nodes are returned in the order they were last updated.
+ * - Specify the node IDs directly attached to the product in the filter expression.
+ * - You can include as many node IDs as required.
+ * - It does not matter what order you specify the node IDs. The nodes are returned in the order they were last updated.
  *
  */
 declare const getAllProducts: <ThrowOnError extends boolean = false>(options: Options<GetAllProductsData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<ProductListData, ErrorResponse, ThrowOnError>;
@@ -863,6 +908,12 @@ declare const getAllProducts: <ThrowOnError extends boolean = false>(options: Op
  *
  */
 declare const getProduct: <ThrowOnError extends boolean = false>(options: Options<GetProductData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<ProductData, ErrorResponse, ThrowOnError>;
+/**
+ * Get all Related Products of a Product
+ * Returns related products of the provided product ID from a published catalog.
+ *
+ */
+declare const getAllRelatedProducts: <ThrowOnError extends boolean = false>(options: Options<GetAllRelatedProductsData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<ProductListData, ErrorResponse, ThrowOnError>;
 /**
  * Get a Bundle's Component Products
  * With Product Experience Manager, you can [create](/docs/api/pxm/products/create-product) and manage bundles. A bundle is a purchasable product, comprising of one or more products that you want to sell together.
@@ -904,13 +955,15 @@ declare const getComponentProductIds: <ThrowOnError extends boolean = false>(opt
  *
  * ### Building breadcrumbs in a storefront
  *
- * In a catalog, you can use a filter to return a list of nodes in a hierarchy structure that a product belongs to. You can use this to build breadcrumbs in your storefront. An example is shown below.
+ * In a catalog, you can use the nodes directly attached to a product to build breadcrumbs in your storefront. This eliminates the need for additional queries to fetch hierarchy or parent node details. Each node contains all the necessary information in `breadcrumbs` metadata, such as its own details and the details of its parent hierarchy/node(s), to construct the complete breadcrumb path without requiring additional queries.
+ *
+ * An example is shown below:
  *
  * `filter=in(id,c83bfe55-0d87-4302-a86d-ab19e7e323f1,6003d7ef-84f3-49bb-a8bd-4cbfa203dcbb)`
  *
- * - Specify the node Ids in the filter expression.
- * - You can have as many node Ids as you want.
- * - It does not matter what order you specify the node Ids. The nodes are returned in the order they were last updated.
+ * - Specify the node IDs directly attached to the product in the filter expression.
+ * - You can include as many node IDs as required.
+ * - It does not matter what order you specify the node IDs. The nodes are returned in the order they were last updated.
  *
  * ### Including Resources
  *
@@ -947,13 +1000,15 @@ declare const getChildProducts: <ThrowOnError extends boolean = false>(options:
  *
  * ### Building breadcrumbs in a storefront
  *
- * In a catalog, you can use a filter to return a list of nodes in a hierarchy structure that a product belongs to. You can use this to build breadcrumbs in your storefront. An example is shown below.
+ * In a catalog, you can use the nodes directly attached to a product to build breadcrumbs in your storefront. This eliminates the need for additional queries to fetch hierarchy or parent node details. Each node contains all the necessary information in `breadcrumbs` metadata, such as its own details and the details of its parent hierarchy/node(s), to construct the complete breadcrumb path without requiring additional queries.
+ *
+ * An example is shown below:
  *
  * `filter=in(id,c83bfe55-0d87-4302-a86d-ab19e7e323f1,6003d7ef-84f3-49bb-a8bd-4cbfa203dcbb)`
  *
- * - Specify the node Ids in the filter expression.
- * - You can have as many node Ids as you want.
- * - It does not matter what order you specify the node Ids. The nodes are returned in the order they were last updated.
+ * - Specify the node IDs directly attached to the product in the filter expression.
+ * - You can include as many node IDs as required.
+ * - It does not matter what order you specify the node IDs. The nodes are returned in the order they were last updated.
  *
  * ### Including Resources
  *
@@ -996,13 +1051,15 @@ declare const getProductsForHierarchy: <ThrowOnError extends boolean = false>(op
  *
  * ### Building breadcrumbs in a storefront
  *
- * In a catalog, you can use a filter to return a list of nodes in a hierarchy structure that a product belongs to. You can use this to build breadcrumbs in your storefront. An example is shown below.
+ * In a catalog, you can use the nodes directly attached to a product to build breadcrumbs in your storefront. This eliminates the need for additional queries to fetch hierarchy or parent node details. Each node contains all the necessary information in `breadcrumbs` metadata, such as its own details and the details of its parent hierarchy/node(s), to construct the complete breadcrumb path without requiring additional queries.
+ *
+ * An example is shown below:
  *
  * `filter=in(id,c83bfe55-0d87-4302-a86d-ab19e7e323f1,6003d7ef-84f3-49bb-a8bd-4cbfa203dcbb)`
  *
- * - Specify the node Ids in the filter expression.
- * - You can have as many node Ids as you want.
- * - It does not matter what order you specify the node Ids. The nodes are returned in the order they were last updated.
+ * - Specify the node IDs directly attached to the product in the filter expression.
+ * - You can include as many node IDs as required.
+ * - It does not matter what order you specify the node IDs. The nodes are returned in the order they were last updated.
  *
  * ### Including Resources
  *
@@ -2679,4 +2736,4 @@ declare const getAFile: <ThrowOnError extends boolean = false>(options: Options<
     data?: File;
 }, FilesErrorResponse, ThrowOnError>;
 
-export { addCustomDiscountToCartItem, addTaxItemToCart, anonymizeOrders, bulkAddCustomDiscountsToCart, bulkAddTaxItemsToCart, bulkDeleteCustomDiscountsFromCart, bulkDeleteTaxItemsFromCart, bulkUpdateItemsInCart, cancelATransaction, captureATransaction, checkoutApi, client, configureByContextProduct, confirmPayment, createACart, createAccountCartAssociation, createAnAccessToken, createCartPaymentIntent, createCatalog, createCustomerCartAssociation, createOneTimePasswordTokenRequest, createRule, deleteACart, deleteACartItem, deleteAPromotionViaPromotionCode, deleteATaxItem, deleteAccountCartAssociation, deleteAllCartItems, deleteCatalogById, deleteCustomDiscountFromCart, deleteCustomDiscountFromCartItem, deleteCustomerCartAssociation, deleteReleaseById, deleteReleases, deleteRuleById, deleteV2AccountAddress, getACurrency, getAFile, getATransaction, getAllCurrencies, getAllFiles, getAllHierarchies, getAllNodes, getAllProducts, getAnOrder, getByContextAllHierarchies, getByContextAllNodes, getByContextAllProducts, getByContextChildNodes, getByContextChildProducts, getByContextComponentProductIds, getByContextHierarchy, getByContextHierarchyChildNodes, getByContextHierarchyNodes, getByContextNode, getByContextProduct, getByContextProductsForHierarchy, getByContextProductsForNode, getByContextRelease, getCart, getCartItems, getCarts, getCatalogById, getCatalogs, getChildNodes, getChildProducts, getComponentProductIds, getCustomerOrders, getFeature, getHierarchy, getHierarchyChildNodes, getHierarchyNodes, getInvoice, getNode, getOffering, getOrderItems, getOrderTransactions, getPlan, getProduct, getProductsForHierarchy, getProductsForNode, getReleaseById, getReleases, getRuleById, getRules, getStock, getSubscription, getSubscriptionInvoice, getSubscriptionInvoicePayment, getSubscriptionProduct, getSubscriptionState, getV2AccountAddress, getV2AccountAddresses, getV2AccountMembers, getV2AccountMembersAccountMemberId, getV2Accounts, getV2AccountsAccountId, getV2AccountsAccountIdAccountMemberships, listInvoices, listLocations, listOfferingFeatures, listOfferingPlans, listOfferingProducts, listOfferings, listSubscriptionInvoicePayments, listSubscriptionInvoices, listSubscriptionPlans, listSubscriptionProducts, listSubscriptionStates, listSubscriptions, manageCarts, paymentSetup, postV2AccountAddress, postV2AccountMembersTokens, postV2Accounts, publishRelease, putV2AccountAddress, putV2AccountsAccountId, refundATransaction, updateACart, updateACartItem, updateATaxItem, updateAnOrder, updateCatalog, updateCustomDiscountForCart, updateCustomDiscountForCartItem, updatePasswordProfileInfo, updateRule };
+export { addCustomDiscountToCartItem, addTaxItemToCart, anonymizeOrders, bulkAddCustomDiscountsToCart, bulkAddTaxItemsToCart, bulkDeleteCustomDiscountsFromCart, bulkDeleteTaxItemsFromCart, bulkUpdateItemsInCart, cancelATransaction, captureATransaction, checkoutApi, client, configureByContextProduct, confirmPayment, createACart, createAccountCartAssociation, createAnAccessToken, createCartPaymentIntent, createCatalog, createCustomerCartAssociation, createOneTimePasswordTokenRequest, createRule, deleteACart, deleteACartItem, deleteAPromotionViaPromotionCode, deleteATaxItem, deleteAccountCartAssociation, deleteAllCartItems, deleteCatalogById, deleteCustomDiscountFromCart, deleteCustomDiscountFromCartItem, deleteCustomerCartAssociation, deleteReleaseById, deleteReleases, deleteRuleById, deleteV2AccountAddress, getACurrency, getAFile, getATransaction, getAllCurrencies, getAllFiles, getAllHierarchies, getAllNodes, getAllProducts, getAllRelatedProducts, getAnOrder, getByContextAllHierarchies, getByContextAllNodes, getByContextAllProducts, getByContextAllRelatedProducts, getByContextChildNodes, getByContextChildProducts, getByContextComponentProductIds, getByContextHierarchy, getByContextHierarchyChildNodes, getByContextHierarchyNodes, getByContextNode, getByContextProduct, getByContextProductsForHierarchy, getByContextProductsForNode, getByContextRelease, getCart, getCartItems, getCarts, getCatalogById, getCatalogs, getChildNodes, getChildProducts, getComponentProductIds, getCustomerOrders, getFeature, getHierarchy, getHierarchyChildNodes, getHierarchyNodes, getInvoice, getNode, getOffering, getOrderItems, getOrderTransactions, getPlan, getProduct, getProductsForHierarchy, getProductsForNode, getReleaseById, getReleases, getRuleById, getRules, getStock, getSubscription, getSubscriptionInvoice, getSubscriptionInvoicePayment, getSubscriptionProduct, getSubscriptionState, getV2AccountAddress, getV2AccountAddresses, getV2AccountMembers, getV2AccountMembersAccountMemberId, getV2Accounts, getV2AccountsAccountId, getV2AccountsAccountIdAccountMemberships, listInvoices, listLocations, listOfferingFeatures, listOfferingPlans, listOfferingProducts, listOfferings, listSubscriptionInvoicePayments, listSubscriptionInvoices, listSubscriptionPlans, listSubscriptionProducts, listSubscriptionStates, listSubscriptions, manageCarts, paymentSetup, postV2AccountAddress, postV2AccountMembersTokens, postV2Accounts, publishRelease, putV2AccountAddress, putV2AccountsAccountId, refundATransaction, updateACart, updateACartItem, updateATaxItem, updateAnOrder, updateCatalog, updateCustomDiscountForCart, updateCustomDiscountForCartItem, updatePasswordProfileInfo, updateRule };