@epcc-sdk/sdks-shopper 0.0.32 → 0.0.34

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -1,4 +1,4 @@
1
- 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';
1
+ 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, CartCollectionResponse, GetCartsError, CreateACartData, CartEntityResponse, CreateACartError, DeleteACartData, ResponseErrorResponse, GetACartData, UpdateACartData, UpdateACartError, DeleteAllCartItemsData, GetCartItemsData, CartItemsResponse, ManageCartsData, CartsResponse, BulkUpdateItemsInCartData, DeleteACartItemData, UpdateACartItemData, DeleteAccountCartAssociationData, CreateAccountCartAssociationData, CreateAccountCartAssociationResponse, DeleteCustomerCartAssociationData, CreateCustomerCartAssociationData, CreateCustomerCartAssociationResponse, DeleteAPromotionViaPromotionCodeData, AddTaxItemToCartData, CartItemTaxesEntityResponse, BulkDeleteTaxItemsFromCartData, BulkAddTaxItemsToCartData, CartsBulkTaxes, DeleteATaxItemData, UpdateATaxItemData, BulkDeleteCustomDiscountsFromCartData, BulkAddCustomDiscountsToCartData, CartsBulkCustomDiscountsResponse, CartsBulkCustomDiscountsCollectionResponse, DeleteCustomDiscountFromCartData, UpdateCustomDiscountForCartData, CartsCustomDiscountsEntityResponse, AddCustomDiscountToCartItemData, CartsCustomDiscountsCollectionResponse, DeleteCustomDiscountFromCartItemData, UpdateCustomDiscountForCartItemData, GetShippingGroupsData, ShippingGroupResponse, CreateShippingGroupData, DeleteCartShippingGroupData, GetShippingGroupByIdData, UpdateShippingGroupData, CreateCartPaymentIntentData, CartResponse, UpdateCartPaymentIntentData, CheckoutApiData, OrderEntityResponse, GetCustomerOrdersData, OrderCollectionResponse, GetAnOrderData, UpdateAnOrderData, GetOrderItemsData, OrderItemCollectionResponse, AnonymizeOrdersData, OrdersListResponse, ConfirmOrderData, OrderResponse, PaymentSetupData, TransactionEntityResponse, ConfirmPaymentData, CaptureATransactionData, RefundATransactionData, GetOrderTransactionsData, TransactionListResponse, GetATransactionData, ResponseData, TransactionResponse, CancelATransactionData, GetOrderShippingGroupsData, CreateOrderShippingGroupData, GetShippingGroupsByIdData, PutShippingGroupByIdData, ListOfferingsData, Offering, OfferingIncludes, Links2, SubscriptionsErrorResponse, GetOfferingData, ListOfferingPricingOptionsData, OfferingPricingOption, ListOfferingFeaturesData, OfferingFeature, ListOfferingPlansData, OfferingPlan, ListOfferingPlanPricingOptionsData, RelationshipData, ListSubscriptionsData, Subscription, SubscriptionIncludes, GetSubscriptionData, ListSubscriptionPlansData, ListSubscriptionPricingOptionsData, 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, ResponseError, GetACurrencyData, GetAllFilesData, File, ResultsMeta, ResultsLinks, FilesErrorResponse, GetAFileData } from './types.gen.cjs';
2
2
  import * as _hey_api_client_fetch from '@hey-api/client-fetch';
3
3
  import { Options } from '@hey-api/client-fetch';
4
4
 
@@ -1088,11 +1088,7 @@ declare const getProductsForNode: <ThrowOnError extends boolean = false>(options
1088
1088
  * :::
1089
1089
  *
1090
1090
  */
1091
- declare const getCarts: <ThrowOnError extends boolean = false>(options?: Options<GetCartsData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<ResponseData & {
1092
- data?: Array<CartResponse>;
1093
- links?: ResponsePageLinks;
1094
- meta?: ResponseMetaCarts;
1095
- }, ResponseError, ThrowOnError>;
1091
+ declare const getCarts: <ThrowOnError extends boolean = false>(options?: Options<GetCartsData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<CartCollectionResponse, GetCartsError, ThrowOnError>;
1096
1092
  /**
1097
1093
  * Create a Cart
1098
1094
  *
@@ -1102,7 +1098,9 @@ declare const getCarts: <ThrowOnError extends boolean = false>(options?: Options
1102
1098
  *
1103
1099
  * After the shopper checks out the cart, the cart remains available to the shopper. The cart is persistent and stays with the shopper after it is used.
1104
1100
  *
1105
- * You can also create a cart to specify custom discounts. You can enable custom discounts when the `discount_settings.custom_discounts_enabled` field is set to `true`. Default is set from cart discount settings for the store. See [Update Cart Settings](/docs/api/settings/put-v-2-settings-cart).
1101
+ * You can create a cart to specify custom discounts. You can enable custom discounts when the `discount_settings.custom_discounts_enabled` field is set to `true`. Default is set from cart discount settings for the store. See [Update Cart Settings](/docs/api/settings/put-v-2-settings-cart).
1102
+ *
1103
+ * You can also create a cart when inventory checks are not performed until checkout by setting the `inventory_settings.defer_inventory_checks` field to `true`. Again the default is set from cart discount settings for the store. See [Update Cart Settings](/docs/api/settings/put-v-2-settings-cart).
1106
1104
  *
1107
1105
  * ### Preview Cart
1108
1106
  *
@@ -1154,9 +1152,7 @@ declare const getCarts: <ThrowOnError extends boolean = false>(options?: Options
1154
1152
  * - In the case of preview carts (those with `snapshot_date`), an error is returned for invalid actions, such as removing the preview date, setting a preview date in the past, or attempting to checkout a cart with a `snapshot_date`.
1155
1153
  *
1156
1154
  */
1157
- declare const createACart: <ThrowOnError extends boolean = false>(options?: Options<CreateACartData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<ResponseData & {
1158
- data?: CartResponse;
1159
- }, ResponseError, ThrowOnError>;
1155
+ declare const createACart: <ThrowOnError extends boolean = false>(options?: Options<CreateACartData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<CartEntityResponse, CreateACartError, ThrowOnError>;
1160
1156
  /**
1161
1157
  * Delete a Cart
1162
1158
  * You can delete a cart, including the items, name, description, and remove all associations.
@@ -1178,7 +1174,7 @@ declare const createACart: <ThrowOnError extends boolean = false>(options?: Opti
1178
1174
  * ````
1179
1175
  *
1180
1176
  */
1181
- declare const deleteACart: <ThrowOnError extends boolean = false>(options: Options<DeleteACartData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<void, ResponseError, ThrowOnError>;
1177
+ declare const deleteACart: <ThrowOnError extends boolean = false>(options: Options<DeleteACartData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<void, ResponseErrorResponse, ThrowOnError>;
1182
1178
  /**
1183
1179
  * Get a Cart
1184
1180
  * Use this endpoint to retrieve a specific cart. If a cart ID does not exist, a new cart will be automatically created. If the cart is associated with shipping groups, calling this endpoint displays the associated shipping group IDs in the `relationships` section.
@@ -1194,7 +1190,7 @@ declare const deleteACart: <ThrowOnError extends boolean = false>(options: Optio
1194
1190
  *
1195
1191
  * :::caution
1196
1192
  *
1197
- * An empty cart is returned for any carts that don’t currently exist. For more information about the cart items object, see [Get Cart Items](/docs/api/carts/get-cart-items).
1193
+ * An empty cart is returned for any carts that don't currently exist. For more information about the cart items object, see [Get Cart Items](/docs/api/carts/get-cart-items).
1198
1194
  *
1199
1195
  * :::
1200
1196
  *
@@ -1206,28 +1202,29 @@ declare const deleteACart: <ThrowOnError extends boolean = false>(options: Optio
1206
1202
  * | `include` | Optional | `string` | Comma-delimited string of entities that can be included. The information included are `items`,`tax_items`, `custom_discounts`, or `promotions`. |
1207
1203
  *
1208
1204
  */
1209
- declare const getCart: <ThrowOnError extends boolean = false>(options: Options<GetCartData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<ResponseData & {
1210
- data?: CartResponse;
1211
- } & {
1212
- data?: CartResponse;
1213
- included?: CartInclude;
1214
- }, ResponseError, ThrowOnError>;
1205
+ declare const getACart: <ThrowOnError extends boolean = false>(options: Options<GetACartData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<CartEntityResponse, {
1206
+ errors?: Array<{
1207
+ detail?: string;
1208
+ status?: number;
1209
+ title?: string;
1210
+ }>;
1211
+ }, ThrowOnError>;
1215
1212
  /**
1216
1213
  * Update a Cart
1217
1214
  * Updates cart properties for the specified cartID.
1218
1215
  *
1219
- * You can also update a cart to specify custom discounts. You can enable custom discounts when the `discount_settings.custom_discounts_enabled` field is set to `true`. Default is set from cart discount settings for the store. See [Cart Settings](/docs/api/settings/put-v-2-settings-cart).
1216
+ * You can update a cart to specify custom discounts. You can enable custom discounts when the `discount_settings.custom_discounts_enabled` field is set to `true`. Default is set from cart discount settings for the store. See [Cart Settings](/docs/api/settings/put-v-2-settings-cart).
1217
+ *
1218
+ * You can also create a cart when inventory checks are not performed until checkout by setting the `inventory_settings.defer_inventory_checks` field to `true`. Again the default is set from cart discount settings for the store. See [Update Cart Settings](/docs/api/settings/put-v-2-settings-cart).
1220
1219
  *
1221
1220
  */
1222
- declare const updateACart: <ThrowOnError extends boolean = false>(options: Options<UpdateACartData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<ResponseData & {
1223
- data?: CartResponse;
1224
- }, ResponseError, ThrowOnError>;
1221
+ declare const updateACart: <ThrowOnError extends boolean = false>(options: Options<UpdateACartData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<CartEntityResponse, UpdateACartError, ThrowOnError>;
1225
1222
  /**
1226
1223
  * Delete all Cart Items
1227
1224
  * A shopper can clean up their cart, deleting custom items, promotions, and so on, while the empty cart remains available. The cart id, name, description, and any account or customer associations persist. The shopper can continue to add items to the cart.
1228
1225
  *
1229
1226
  */
1230
- declare const deleteAllCartItems: <ThrowOnError extends boolean = false>(options: Options<DeleteAllCartItemsData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<void, ResponseError, ThrowOnError>;
1227
+ declare const deleteAllCartItems: <ThrowOnError extends boolean = false>(options: Options<DeleteAllCartItemsData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<void, ResponseErrorResponse, ThrowOnError>;
1231
1228
  /**
1232
1229
  * Get Cart Items
1233
1230
  *
@@ -1411,7 +1408,7 @@ declare const deleteAllCartItems: <ThrowOnError extends boolean = false>(options
1411
1408
  * ```
1412
1409
  *
1413
1410
  */
1414
- declare const getCartItems: <ThrowOnError extends boolean = false>(options: Options<GetCartItemsData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<CartsResponse, ResponseError, ThrowOnError>;
1411
+ declare const getCartItems: <ThrowOnError extends boolean = false>(options: Options<GetCartItemsData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<CartItemsResponse, unknown, ThrowOnError>;
1415
1412
  /**
1416
1413
  * Add Items to Cart
1417
1414
  *
@@ -1614,7 +1611,7 @@ declare const getCartItems: <ThrowOnError extends boolean = false>(options: Opti
1614
1611
  *
1615
1612
  * ### Add Subscription to Cart
1616
1613
  *
1617
- * To add a subscription to your cart, you need to provide the ID of the subscription offering and the ID of the plan within that offering that you want to subscribe to.
1614
+ * To add a subscription to your cart, you need to provide the ID of the subscription offering, and the ID of the pricing option and plan within that offering that you want to subscribe to.
1618
1615
  *
1619
1616
  * ```json
1620
1617
  * {
@@ -1624,7 +1621,8 @@ declare const getCartItems: <ThrowOnError extends boolean = false>(options: Opti
1624
1621
  * "type": "subscription_item",
1625
1622
  * "quantity": 1,
1626
1623
  * "subscription_configuration": {
1627
- * "plan": "40010dde-2f38-489b-8b3f-14a13cbfb431"
1624
+ * "plan": "dfa31307-748c-4369-8571-709f924a0807",
1625
+ * "pricing_option": "40010dde-2f38-489b-8b3f-14a13cbfb431"
1628
1626
  * }
1629
1627
  * }
1630
1628
  * }
@@ -1654,7 +1652,7 @@ declare const getCartItems: <ThrowOnError extends boolean = false>(options: Opti
1654
1652
  *
1655
1653
  * ### Re-order
1656
1654
  *
1657
- * From a shopper’s order history, they can add the items from a previous order into their carts. Shoppers can add items regardless of past order status, such as incomplete or not paid. For more information, see [Orders](/docs/api/carts/orders).
1655
+ * From a shopper's order history, they can add the items from a previous order into their carts. Shoppers can add items regardless of past order status, such as incomplete or not paid. For more information, see [Orders](/docs/api/carts/orders).
1658
1656
  *
1659
1657
  * :::note
1660
1658
  * - Any requests to add an item to cart return a collection of [cart items](/docs/api/carts/cart-items).
@@ -1783,11 +1781,11 @@ declare const getCartItems: <ThrowOnError extends boolean = false>(options: Opti
1783
1781
  * "updated_at": "2023-05-02T16:28:18Z"
1784
1782
  * }
1785
1783
  * }
1786
- * }
1784
+ * ]
1787
1785
  * ```
1788
1786
  *
1789
1787
  */
1790
- declare const manageCarts: <ThrowOnError extends boolean = false>(options: Options<ManageCartsData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<CartsResponse, ResponseError, ThrowOnError>;
1788
+ declare const manageCarts: <ThrowOnError extends boolean = false>(options: Options<ManageCartsData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<CartsResponse, ResponseErrorResponse, ThrowOnError>;
1791
1789
  /**
1792
1790
  * Bulk Update Items in Cart
1793
1791
  * The bulk update feature allows shoppers to update an array of items to their cart in one action, rather than updating each item one at a time. Shoppers can update quantity and shipping group details in bulk requests. This minimizes the time for shoppers while updating items to their cart. Shoppers can even update multiple items with the same or different shipping groups to their cart.
@@ -1795,42 +1793,42 @@ declare const manageCarts: <ThrowOnError extends boolean = false>(options: Optio
1795
1793
  * When you update multiple items that qualify for free gifts in the cart, the corresponding free gifts for all eligible products are also automatically updated in the cart.
1796
1794
  *
1797
1795
  */
1798
- declare const bulkUpdateItemsInCart: <ThrowOnError extends boolean = false>(options: Options<BulkUpdateItemsInCartData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<unknown, ResponseError, ThrowOnError>;
1796
+ declare const bulkUpdateItemsInCart: <ThrowOnError extends boolean = false>(options: Options<BulkUpdateItemsInCartData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<unknown, ResponseErrorResponse, ThrowOnError>;
1799
1797
  /**
1800
1798
  * Delete a Cart Item
1801
1799
  * Use this endpoint to delete a cart item.
1802
1800
  */
1803
- declare const deleteACartItem: <ThrowOnError extends boolean = false>(options: Options<DeleteACartItemData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<void, ResponseError, ThrowOnError>;
1801
+ declare const deleteACartItem: <ThrowOnError extends boolean = false>(options: Options<DeleteACartItemData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<CartsResponse, unknown, ThrowOnError>;
1804
1802
  /**
1805
1803
  * Update a Cart Item
1806
1804
  * You can easily update a cart item. A successful update returns the cart items.
1807
1805
  */
1808
- declare const updateACartItem: <ThrowOnError extends boolean = false>(options: Options<UpdateACartItemData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<CartsResponse, ResponseError, ThrowOnError>;
1806
+ declare const updateACartItem: <ThrowOnError extends boolean = false>(options: Options<UpdateACartItemData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<CartsResponse, ResponseErrorResponse, ThrowOnError>;
1809
1807
  /**
1810
1808
  * Delete Account Cart Association
1811
1809
  * You can delete an association between an account and a cart.
1812
1810
  */
1813
- declare const deleteAccountCartAssociation: <ThrowOnError extends boolean = false>(options: Options<DeleteAccountCartAssociationData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<void, ResponseError, ThrowOnError>;
1811
+ declare const deleteAccountCartAssociation: <ThrowOnError extends boolean = false>(options: Options<DeleteAccountCartAssociationData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<void, ResponseErrorResponse, ThrowOnError>;
1814
1812
  /**
1815
1813
  * Create an Account Cart Association
1816
1814
  * You can create associations between an account and one or more carts. After cart associations exist for an account, the account can access those carts across any device.
1817
1815
  */
1818
- declare const createAccountCartAssociation: <ThrowOnError extends boolean = false>(options: Options<CreateAccountCartAssociationData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<CreateAccountCartAssociationResponse, ResponseError, ThrowOnError>;
1816
+ declare const createAccountCartAssociation: <ThrowOnError extends boolean = false>(options: Options<CreateAccountCartAssociationData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<CreateAccountCartAssociationResponse, ResponseErrorResponse, ThrowOnError>;
1819
1817
  /**
1820
1818
  * Delete Customer Cart Association
1821
1819
  * You can delete an association between a customer and a cart.
1822
1820
  */
1823
- declare const deleteCustomerCartAssociation: <ThrowOnError extends boolean = false>(options: Options<DeleteCustomerCartAssociationData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<void, ResponseError, ThrowOnError>;
1821
+ declare const deleteCustomerCartAssociation: <ThrowOnError extends boolean = false>(options: Options<DeleteCustomerCartAssociationData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<void, ResponseErrorResponse, ThrowOnError>;
1824
1822
  /**
1825
1823
  * Create a Customer Cart Association
1826
1824
  * You can create associations between a customer and one or more carts. After cart associations exist for a customer, the customer can access those carts across any device.
1827
1825
  */
1828
- declare const createCustomerCartAssociation: <ThrowOnError extends boolean = false>(options: Options<CreateCustomerCartAssociationData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<CartsRelationshipsCustomersData, ResponseError, ThrowOnError>;
1826
+ declare const createCustomerCartAssociation: <ThrowOnError extends boolean = false>(options: Options<CreateCustomerCartAssociationData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<CreateCustomerCartAssociationResponse, ResponseErrorResponse, ThrowOnError>;
1829
1827
  /**
1830
1828
  * Delete a Promotion via Promotion Code
1831
1829
  * You can remove promotion code from a cart if it was applied manually. This endpoint does not work if the promotion is applied automatically.
1832
1830
  */
1833
- declare const deleteAPromotionViaPromotionCode: <ThrowOnError extends boolean = false>(options: Options<DeleteAPromotionViaPromotionCodeData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<void, ResponseError, ThrowOnError>;
1831
+ declare const deleteAPromotionViaPromotionCode: <ThrowOnError extends boolean = false>(options: Options<DeleteAPromotionViaPromotionCodeData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<void, unknown, ThrowOnError>;
1834
1832
  /**
1835
1833
  * Add Tax Item to Cart
1836
1834
  *
@@ -1843,14 +1841,12 @@ declare const deleteAPromotionViaPromotionCode: <ThrowOnError extends boolean =
1843
1841
  * :::
1844
1842
  *
1845
1843
  */
1846
- declare const addTaxItemToCart: <ThrowOnError extends boolean = false>(options: Options<AddTaxItemToCartData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<ResponseData & {
1847
- data?: CartsItemsTaxesObject;
1848
- }, ResponseError, ThrowOnError>;
1844
+ declare const addTaxItemToCart: <ThrowOnError extends boolean = false>(options: Options<AddTaxItemToCartData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<CartItemTaxesEntityResponse, ResponseErrorResponse, ThrowOnError>;
1849
1845
  /**
1850
1846
  * Bulk Delete Tax Items from Cart
1851
1847
  * Use this endpoint to bulk delete tax items from cart.
1852
1848
  */
1853
- declare const bulkDeleteTaxItemsFromCart: <ThrowOnError extends boolean = false>(options: Options<BulkDeleteTaxItemsFromCartData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<void, ResponseError, ThrowOnError>;
1849
+ declare const bulkDeleteTaxItemsFromCart: <ThrowOnError extends boolean = false>(options: Options<BulkDeleteTaxItemsFromCartData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<void, unknown, ThrowOnError>;
1854
1850
  /**
1855
1851
  * Bulk Add Tax Items to Cart
1856
1852
  * :::note
@@ -1916,24 +1912,22 @@ declare const bulkDeleteTaxItemsFromCart: <ThrowOnError extends boolean = false>
1916
1912
  * ```
1917
1913
  *
1918
1914
  */
1919
- declare const bulkAddTaxItemsToCart: <ThrowOnError extends boolean = false>(options: Options<BulkAddTaxItemsToCartData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<CartsBulkTaxes, ResponseError, ThrowOnError>;
1915
+ declare const bulkAddTaxItemsToCart: <ThrowOnError extends boolean = false>(options: Options<BulkAddTaxItemsToCartData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<CartsBulkTaxes, ResponseErrorResponse, ThrowOnError>;
1920
1916
  /**
1921
1917
  * Delete a Tax Item
1922
1918
  * Use this endpoint to delete a tax item.
1923
1919
  */
1924
- declare const deleteATaxItem: <ThrowOnError extends boolean = false>(options: Options<DeleteATaxItemData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<void, ResponseError, ThrowOnError>;
1920
+ declare const deleteATaxItem: <ThrowOnError extends boolean = false>(options: Options<DeleteATaxItemData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<void, unknown, ThrowOnError>;
1925
1921
  /**
1926
1922
  * Update a Tax Item
1927
- * Use this endpoint to update a tax item.
1923
+ * Use this endpoint to update a tax item. To change tax value from `rate` to `amount`, set `rate` to `null`, then set `amount` value and vice versa.
1928
1924
  */
1929
- declare const updateATaxItem: <ThrowOnError extends boolean = false>(options: Options<UpdateATaxItemData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<ResponseData & {
1930
- data?: CartsItemsTaxesObject;
1931
- }, ResponseError, ThrowOnError>;
1925
+ declare const updateATaxItem: <ThrowOnError extends boolean = false>(options: Options<UpdateATaxItemData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<CartItemTaxesEntityResponse, unknown, ThrowOnError>;
1932
1926
  /**
1933
1927
  * Bulk Delete Custom Discounts From Cart
1934
1928
  * Use this endpoint to bulk delete custom discounts from cart.
1935
1929
  */
1936
- declare const bulkDeleteCustomDiscountsFromCart: <ThrowOnError extends boolean = false>(options: Options<BulkDeleteCustomDiscountsFromCartData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<void, ResponseError, ThrowOnError>;
1930
+ declare const bulkDeleteCustomDiscountsFromCart: <ThrowOnError extends boolean = false>(options: Options<BulkDeleteCustomDiscountsFromCartData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<void, unknown, ThrowOnError>;
1937
1931
  /**
1938
1932
  * Bulk Add Custom Discounts to Cart
1939
1933
  * The default value for custom discounts on both the cart and cart items is set to 5 if this parameter is not configured in the store. To verify the custom discount limit value, call [Get all settings](/docs/api/settings/get-v-2-settings) endpoint.
@@ -1941,38 +1935,63 @@ declare const bulkDeleteCustomDiscountsFromCart: <ThrowOnError extends boolean =
1941
1935
  * To increase the custom discount value, contact [Elastic Path Support team](https://support.elasticpath.com/hc/en-us).
1942
1936
  *
1943
1937
  */
1944
- declare const bulkAddCustomDiscountsToCart: <ThrowOnError extends boolean = false>(options: Options<BulkAddCustomDiscountsToCartData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<CartsBulkCustomDiscountsResponse, ResponseError, ThrowOnError>;
1938
+ declare const bulkAddCustomDiscountsToCart: <ThrowOnError extends boolean = false>(options: Options<BulkAddCustomDiscountsToCartData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<CartsBulkCustomDiscountsResponse | CartsBulkCustomDiscountsCollectionResponse, ResponseErrorResponse, ThrowOnError>;
1945
1939
  /**
1946
1940
  * Delete Custom Discount From Cart
1947
1941
  * Use this endpoint to delete custom discount from cart.
1948
1942
  */
1949
- declare const deleteCustomDiscountFromCart: <ThrowOnError extends boolean = false>(options: Options<DeleteCustomDiscountFromCartData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<void, ResponseError, ThrowOnError>;
1943
+ declare const deleteCustomDiscountFromCart: <ThrowOnError extends boolean = false>(options: Options<DeleteCustomDiscountFromCartData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<void, unknown, ThrowOnError>;
1950
1944
  /**
1951
1945
  * Update Custom Discount For Cart
1952
1946
  * Use this endpoint to update a custom discount in your cart.
1953
1947
  */
1954
- declare const updateCustomDiscountForCart: <ThrowOnError extends boolean = false>(options: Options<UpdateCustomDiscountForCartData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<ResponseData & {
1955
- data?: CartsCustomDiscountsResponse;
1956
- }, ResponseError, ThrowOnError>;
1948
+ declare const updateCustomDiscountForCart: <ThrowOnError extends boolean = false>(options: Options<UpdateCustomDiscountForCartData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<CartsCustomDiscountsEntityResponse, unknown, ThrowOnError>;
1957
1949
  /**
1958
1950
  * Add Custom Discount To Cart Item
1959
1951
  * Use this endpoint to add a custom discount to cart item.
1960
1952
  */
1961
- declare const addCustomDiscountToCartItem: <ThrowOnError extends boolean = false>(options: Options<AddCustomDiscountToCartItemData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<ResponseData & {
1962
- data?: CartsCustomDiscountsResponse;
1963
- }, ResponseError, ThrowOnError>;
1953
+ declare const addCustomDiscountToCartItem: <ThrowOnError extends boolean = false>(options: Options<AddCustomDiscountToCartItemData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<CartsCustomDiscountsEntityResponse | CartsCustomDiscountsCollectionResponse, ResponseErrorResponse, ThrowOnError>;
1964
1954
  /**
1965
1955
  * Delete Custom Discount From Cart Item
1966
1956
  * Use this endpoint to delete custom discount from cart item.
1967
1957
  */
1968
- declare const deleteCustomDiscountFromCartItem: <ThrowOnError extends boolean = false>(options: Options<DeleteCustomDiscountFromCartItemData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<void, ResponseError, ThrowOnError>;
1958
+ declare const deleteCustomDiscountFromCartItem: <ThrowOnError extends boolean = false>(options: Options<DeleteCustomDiscountFromCartItemData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<void, unknown, ThrowOnError>;
1969
1959
  /**
1970
1960
  * Update Custom Discount For Cart Item
1971
1961
  * Use this endpoint to update a custom discount in your cart item.
1972
1962
  */
1973
- declare const updateCustomDiscountForCartItem: <ThrowOnError extends boolean = false>(options: Options<UpdateCustomDiscountForCartItemData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<ResponseData & {
1974
- data?: CartsCustomDiscountsResponse;
1975
- }, ResponseError, ThrowOnError>;
1963
+ declare const updateCustomDiscountForCartItem: <ThrowOnError extends boolean = false>(options: Options<UpdateCustomDiscountForCartItemData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<CartsCustomDiscountsEntityResponse, unknown, ThrowOnError>;
1964
+ /**
1965
+ * Retrieve all shipping groups for a cart
1966
+ * Retrieve all shipping groups for a cart
1967
+ */
1968
+ declare const getShippingGroups: <ThrowOnError extends boolean = false>(options: Options<GetShippingGroupsData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<{
1969
+ data?: Array<ShippingGroupResponse>;
1970
+ }, ResponseErrorResponse, ThrowOnError>;
1971
+ /**
1972
+ * Create a new shipping group for a cart
1973
+ * Create a new shipping group for a cart
1974
+ */
1975
+ declare const createShippingGroup: <ThrowOnError extends boolean = false>(options: Options<CreateShippingGroupData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<ShippingGroupResponse, ResponseErrorResponse, ThrowOnError>;
1976
+ /**
1977
+ * Delete Cart Shipping Group
1978
+ * Deletes a shipping group from a cart. You cannot delete a shipping group that is attached to cart items.
1979
+ * You must first remove the shipping group from all cart items before deleting the shipping group.
1980
+ *
1981
+ */
1982
+ declare const deleteCartShippingGroup: <ThrowOnError extends boolean = false>(options: Options<DeleteCartShippingGroupData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<void, ResponseErrorResponse, ThrowOnError>;
1983
+ /**
1984
+ * Retrieve a specific shipping group for a cart
1985
+ * Retrieve a specific shipping group for a cart
1986
+ */
1987
+ declare const getShippingGroupById: <ThrowOnError extends boolean = false>(options: Options<GetShippingGroupByIdData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<{
1988
+ data?: ShippingGroupResponse;
1989
+ }, ResponseErrorResponse, ThrowOnError>;
1990
+ /**
1991
+ * Update a shipping group for a cart
1992
+ * Update a specific shipping group for a cart
1993
+ */
1994
+ declare const updateShippingGroup: <ThrowOnError extends boolean = false>(options: Options<UpdateShippingGroupData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<ShippingGroupResponse, ResponseErrorResponse, ThrowOnError>;
1976
1995
  /**
1977
1996
  * Create Stripe Payment Intent for a Cart
1978
1997
  * The Cart Payment Intent feature enables the creation of a Stripe Payment Intent specifically tied to a shopping cart and its subsequent order. This allows Payment Intent users to track payment details from the cart stage and seamlessly maintain consistency in payment information throughout the order stage. Using these features, you can create Payment Intents for their carts, update Payment Intents with final cart details, and synchronize Payment Intents from Stripe to Commerce.
@@ -2001,7 +2020,12 @@ declare const updateCustomDiscountForCartItem: <ThrowOnError extends boolean = f
2001
2020
  * - To pay the entire amount at once, use the [Update Cart Payment Intent](/docs/carts-orders/update-cart-payment-intent) endpoint to update the Stripe Payment Intent with the final cart details when preparing to take the payment. Doing so, ensures that the Payment Intent accurately reflects the current cart details when processing payments on the front end. We do not recommend calling the [Update Cart Payment Intent](/docs/carts-orders/update-cart-payment-intent) for each individual change in the cart, as this can lead to more requests and may slow down the front-end performance.
2002
2021
  *
2003
2022
  */
2004
- declare const createCartPaymentIntent: <ThrowOnError extends boolean = false>(options: Options<CreateCartPaymentIntentData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<CartResponse, ResponseError, ThrowOnError>;
2023
+ declare const createCartPaymentIntent: <ThrowOnError extends boolean = false>(options: Options<CreateCartPaymentIntentData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<CartResponse, unknown, ThrowOnError>;
2024
+ /**
2025
+ * Update a Payment Intent on a Cart
2026
+ * Updates the payment information for a specific payment intent on a cart.
2027
+ */
2028
+ declare const updateCartPaymentIntent: <ThrowOnError extends boolean = false>(options: Options<UpdateCartPaymentIntentData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<CartResponse, unknown, ThrowOnError>;
2005
2029
  /**
2006
2030
  * Checkout API
2007
2031
  * When a Cart is ready for checkout, you can convert the cart to an order. The cart remains and can be modified and checked out again if required.
@@ -2058,9 +2082,7 @@ declare const createCartPaymentIntent: <ThrowOnError extends boolean = false>(op
2058
2082
  * ```
2059
2083
  *
2060
2084
  */
2061
- declare const checkoutApi: <ThrowOnError extends boolean = false>(options: Options<CheckoutApiData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<ResponseData & {
2062
- data?: OrderResponse;
2063
- }, ResponseError, ThrowOnError>;
2085
+ declare const checkoutApi: <ThrowOnError extends boolean = false>(options: Options<CheckoutApiData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<OrderEntityResponse, ResponseErrorResponse, ThrowOnError>;
2064
2086
  /**
2065
2087
  * Get all Orders
2066
2088
  * This endpoint returns all orders with custom flow fields. The pagination offset is set to fetch a maximum of 10,000 orders. If the store has 10,000 orders and you fetch the orders without using filters, an error is returned. Use a filter to view orders when the order is beyond the 10,000 mark.
@@ -2102,24 +2124,12 @@ declare const checkoutApi: <ThrowOnError extends boolean = false>(options: Optio
2102
2124
  * | `order_number` | `string` | `eq` / `like` | `like(order_number, 123*)` |
2103
2125
  *
2104
2126
  */
2105
- declare const getCustomerOrders: <ThrowOnError extends boolean = false>(options?: Options<GetCustomerOrdersData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<ResponseData & {
2106
- data?: Array<OrderResponse>;
2107
- links?: ResponsePageLinks;
2108
- meta?: ResponseMetaOrders;
2109
- included?: {
2110
- items?: Array<OrderItemResponse>;
2111
- };
2112
- }, ResponseError, ThrowOnError>;
2127
+ declare const getCustomerOrders: <ThrowOnError extends boolean = false>(options?: Options<GetCustomerOrdersData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<OrderCollectionResponse, unknown, ThrowOnError>;
2113
2128
  /**
2114
2129
  * Get an Order
2115
2130
  * Use this endpoint to retrieve a specific order.
2116
2131
  */
2117
- declare const getAnOrder: <ThrowOnError extends boolean = false>(options: Options<GetAnOrderData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<ResponseData & {
2118
- data?: OrderResponse;
2119
- included?: {
2120
- items?: Array<OrderItemResponse>;
2121
- };
2122
- }, ResponseError, ThrowOnError>;
2132
+ declare const getAnOrder: <ThrowOnError extends boolean = false>(options: Options<GetAnOrderData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<OrderEntityResponse, ResponseErrorResponse, ThrowOnError>;
2123
2133
  /**
2124
2134
  * Update an Order
2125
2135
  * You can only update custom data, `shipping`, `shipping_address`, and status of orders. All other settings in the order object are immutable.
@@ -2139,22 +2149,18 @@ declare const getAnOrder: <ThrowOnError extends boolean = false>(options: Option
2139
2149
  * :::note
2140
2150
  *
2141
2151
  * - This request is only accessible to client credentials token users with Seller Admin role.
2142
- * - Non client credentials token users cannot access this endpoint. See [Permissions](/docs/authentication/Tokens/permissions).
2152
+ * - Non client credentials token users cannot access this endpoint. See [Permissions](/docs/authentication/tokens/permissions).
2143
2153
  * - The `order_number` will appear as the invoice number in Authorize.net transactions.
2144
2154
  *
2145
2155
  * :::
2146
2156
  *
2147
2157
  */
2148
- declare const updateAnOrder: <ThrowOnError extends boolean = false>(options: Options<UpdateAnOrderData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<ResponseData & {
2149
- data?: OrderResponse;
2150
- }, ResponseError, ThrowOnError>;
2158
+ declare const updateAnOrder: <ThrowOnError extends boolean = false>(options: Options<UpdateAnOrderData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<OrderEntityResponse, ResponseErrorResponse, ThrowOnError>;
2151
2159
  /**
2152
2160
  * Get Order Items
2153
2161
  * Use this endpoint to retrieve order items.
2154
2162
  */
2155
- declare const getOrderItems: <ThrowOnError extends boolean = false>(options: Options<GetOrderItemsData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<ResponseData & {
2156
- data?: Array<OrderItemResponse>;
2157
- }, ResponseError, ThrowOnError>;
2163
+ declare const getOrderItems: <ThrowOnError extends boolean = false>(options: Options<GetOrderItemsData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<OrderItemCollectionResponse, unknown, ThrowOnError>;
2158
2164
  /**
2159
2165
  * Anonymize Orders
2160
2166
  * You can anonymize an order when it is fulfilled, canceled, or fully refunded.
@@ -2162,12 +2168,16 @@ declare const getOrderItems: <ThrowOnError extends boolean = false>(options: Opt
2162
2168
  * When anonymization is successful, Personal Identifiable Information such as customer details, `shipping_address`, and `billing_address` are replaced with *.
2163
2169
  *
2164
2170
  */
2165
- declare const anonymizeOrders: <ThrowOnError extends boolean = false>(options?: Options<AnonymizeOrdersData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<ResponseData & {
2166
- data?: OrderResponse;
2167
- }, ResponseError, ThrowOnError>;
2171
+ declare const anonymizeOrders: <ThrowOnError extends boolean = false>(options?: Options<AnonymizeOrdersData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<OrdersListResponse, ResponseErrorResponse, ThrowOnError>;
2168
2172
  /**
2169
- * Payment Setup
2170
- * Depending on the payment gateway, you may have access to different transaction types such as capturing funds immediately or authorizing them for later. For more information, see [Transactions](/docs/api/carts/transactions).
2173
+ * Confirm Order
2174
+ * Use this endpoint to confirm an order. Confirming an order finalizes it and makes it ready for processing.
2175
+ *
2176
+ */
2177
+ declare const confirmOrder: <ThrowOnError extends boolean = false>(options: Options<ConfirmOrderData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<OrderResponse, ResponseErrorResponse, ThrowOnError>;
2178
+ /**
2179
+ * Payments
2180
+ * Depending on the payment gateway, you may have access to different transaction types such as capturing funds immediately or authorizing them for later. For more information, see [Payments](/docs/api/carts/payments).
2171
2181
  *
2172
2182
  * The following types of payment methods are available depending on the payment gateway:
2173
2183
  *
@@ -2189,9 +2199,7 @@ declare const anonymizeOrders: <ThrowOnError extends boolean = false>(options?:
2189
2199
  * :::
2190
2200
  *
2191
2201
  */
2192
- declare const paymentSetup: <ThrowOnError extends boolean = false>(options: Options<PaymentSetupData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<ResponseData & {
2193
- data?: TransactionResponse;
2194
- }, ResponseError, ThrowOnError>;
2202
+ declare const paymentSetup: <ThrowOnError extends boolean = false>(options: Options<PaymentSetupData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<TransactionEntityResponse, ResponseErrorResponse, ThrowOnError>;
2195
2203
  /**
2196
2204
  * Confirm Payment
2197
2205
  * Confirm Payment serves as a mechanism to synchronize transaction information from the third-party payment provider back to our system. This ensures that Composable Commerce accurately reflects the values from the payment provider.
@@ -2201,16 +2209,12 @@ declare const paymentSetup: <ThrowOnError extends boolean = false>(options: Opti
2201
2209
  * For Stripe Payments requiring 3D Secure validation, the transaction response will include the `client_parameters` object, which provides credentials to support validation of these payment requests on the payment provider's side. We recommend using the Stripe's client libraries to manage these 3D Secure validations. Once the validation succeeds, proceed with a confirmation request to sync the validated transaction into Composable Commerce and continue with the payment process.
2202
2210
  *
2203
2211
  */
2204
- declare const confirmPayment: <ThrowOnError extends boolean = false>(options: Options<ConfirmPaymentData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<ResponseData & {
2205
- data?: TransactionResponse;
2206
- }, ResponseError, ThrowOnError>;
2212
+ declare const confirmPayment: <ThrowOnError extends boolean = false>(options: Options<ConfirmPaymentData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<TransactionEntityResponse, ResponseErrorResponse, ThrowOnError>;
2207
2213
  /**
2208
2214
  * Capture a Transaction
2209
2215
  * Use this endpoint to capture a previously authorized payment. In this step, you can also pass in a custom reference, such as the payment reference from your chosen gateway.
2210
2216
  */
2211
- declare const captureATransaction: <ThrowOnError extends boolean = false>(options: Options<CaptureATransactionData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<ResponseData & {
2212
- data?: TransactionResponse;
2213
- }, ResponseError, ThrowOnError>;
2217
+ declare const captureATransaction: <ThrowOnError extends boolean = false>(options: Options<CaptureATransactionData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<TransactionEntityResponse, ResponseErrorResponse, ThrowOnError>;
2214
2218
  /**
2215
2219
  * Refund a Transaction
2216
2220
  * There are two ways to refund; through your payment gateway and mark it refunded in Commerce Manager, or directly through Commerce Manager or API.
@@ -2225,23 +2229,19 @@ declare const captureATransaction: <ThrowOnError extends boolean = false>(option
2225
2229
  * :::
2226
2230
  *
2227
2231
  */
2228
- declare const refundATransaction: <ThrowOnError extends boolean = false>(options: Options<RefundATransactionData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<ResponseData & {
2229
- data?: TransactionResponse;
2230
- }, ResponseError, ThrowOnError>;
2232
+ declare const refundATransaction: <ThrowOnError extends boolean = false>(options: Options<RefundATransactionData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<TransactionEntityResponse, ResponseErrorResponse, ThrowOnError>;
2231
2233
  /**
2232
2234
  * Get Order Transactions
2233
2235
  * Get order transactions
2234
2236
  */
2235
- declare const getOrderTransactions: <ThrowOnError extends boolean = false>(options: Options<GetOrderTransactionsData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<ResponseData & {
2236
- data?: Array<TransactionResponse>;
2237
- }, ResponseError, ThrowOnError>;
2237
+ declare const getOrderTransactions: <ThrowOnError extends boolean = false>(options: Options<GetOrderTransactionsData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<TransactionListResponse, ResponseErrorResponse, ThrowOnError>;
2238
2238
  /**
2239
2239
  * Get a Transaction
2240
2240
  * Retrieves a transaction
2241
2241
  */
2242
2242
  declare const getATransaction: <ThrowOnError extends boolean = false>(options: Options<GetATransactionData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<ResponseData & {
2243
2243
  data?: TransactionResponse;
2244
- }, ResponseError, ThrowOnError>;
2244
+ }, unknown, ThrowOnError>;
2245
2245
  /**
2246
2246
  * Cancel a Transaction
2247
2247
  * Use this endpoint to cancel or void a pending or authorized transaction. The transaction can be canceled or voided when it is in `pending` and `completed` statuses.
@@ -2253,21 +2253,33 @@ declare const getATransaction: <ThrowOnError extends boolean = false>(options: O
2253
2253
  * :::
2254
2254
  *
2255
2255
  */
2256
- declare const cancelATransaction: <ThrowOnError extends boolean = false>(options: Options<CancelATransactionData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<ResponseData & {
2257
- data?: TransactionResponse;
2258
- }, ResponseError, ThrowOnError>;
2256
+ declare const cancelATransaction: <ThrowOnError extends boolean = false>(options: Options<CancelATransactionData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<TransactionEntityResponse, ResponseErrorResponse, ThrowOnError>;
2259
2257
  /**
2260
- * Get product
2258
+ * Retrieve all shipping groups for an order
2259
+ * Retrieve all shipping groups for an order
2261
2260
  */
2262
- declare const getSubscriptionProduct: <ThrowOnError extends boolean = false>(options: Options<GetSubscriptionProductData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<{
2263
- data?: Product2;
2264
- }, SubscriptionsErrorResponse, ThrowOnError>;
2261
+ declare const getOrderShippingGroups: <ThrowOnError extends boolean = false>(options: Options<GetOrderShippingGroupsData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<{
2262
+ data?: Array<ShippingGroupResponse>;
2263
+ }, ResponseErrorResponse, ThrowOnError>;
2265
2264
  /**
2266
- * Get plan
2265
+ * Create a shipping group for an order
2266
+ * Create a new shipping group for an order
2267
2267
  */
2268
- declare const getPlan: <ThrowOnError extends boolean = false>(options: Options<GetPlanData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<{
2269
- data?: Plan;
2270
- }, SubscriptionsErrorResponse, ThrowOnError>;
2268
+ declare const createOrderShippingGroup: <ThrowOnError extends boolean = false>(options: Options<CreateOrderShippingGroupData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<{
2269
+ data?: ShippingGroupResponse;
2270
+ }, ResponseErrorResponse, ThrowOnError>;
2271
+ /**
2272
+ * Retrieve a specific shipping group for an order
2273
+ * Retrieve a specific shipping group for an order
2274
+ */
2275
+ declare const getShippingGroupsById: <ThrowOnError extends boolean = false>(options: Options<GetShippingGroupsByIdData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<{
2276
+ data?: ShippingGroupResponse;
2277
+ }, ResponseErrorResponse, ThrowOnError>;
2278
+ /**
2279
+ * Update a shipping group for an order
2280
+ * Update a shipping group for an order
2281
+ */
2282
+ declare const putShippingGroupById: <ThrowOnError extends boolean = false>(options: Options<PutShippingGroupByIdData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<ShippingGroupResponse, ResponseErrorResponse, ThrowOnError>;
2271
2283
  /**
2272
2284
  * List offerings
2273
2285
  * Retrieves a list of all subscription offerings.
@@ -2280,8 +2292,8 @@ declare const getPlan: <ThrowOnError extends boolean = false>(options: Options<G
2280
2292
  *
2281
2293
  * | Operator | Attribute | Description |
2282
2294
  * | --- | --- | --- |
2283
- * | `eq` | `external_ref`, `products.external_ref`, `proration_policy_id` | Equals. Checks if the values of two operands are equal. If they are, the condition is true. |
2284
- * | `in` | `products.external_ref` | In. Checks if the values are included in the specified string. If they are, the condition is true. |
2295
+ * | `eq` | `external_ref`, `plans.external_ref`, `proration_policy_id` | Equals. Checks if the values of two operands are equal. If they are, the condition is true. |
2296
+ * | `in` | `plans.external_ref` | In. Checks if the values are included in the specified string. If they are, the condition is true. |
2285
2297
  *
2286
2298
  */
2287
2299
  declare const listOfferings: <ThrowOnError extends boolean = false>(options?: Options<ListOfferingsData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<{
@@ -2297,10 +2309,10 @@ declare const getOffering: <ThrowOnError extends boolean = false>(options: Optio
2297
2309
  included?: OfferingIncludes;
2298
2310
  }, SubscriptionsErrorResponse, ThrowOnError>;
2299
2311
  /**
2300
- * List an offering's plans
2312
+ * List an offering's pricing options
2301
2313
  */
2302
- declare const listOfferingPlans: <ThrowOnError extends boolean = false>(options: Options<ListOfferingPlansData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<{
2303
- data?: Array<OfferingPlan>;
2314
+ declare const listOfferingPricingOptions: <ThrowOnError extends boolean = false>(options: Options<ListOfferingPricingOptionsData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<{
2315
+ data?: Array<OfferingPricingOption>;
2304
2316
  links?: Links2;
2305
2317
  }, SubscriptionsErrorResponse, ThrowOnError>;
2306
2318
  /**
@@ -2311,12 +2323,18 @@ declare const listOfferingFeatures: <ThrowOnError extends boolean = false>(optio
2311
2323
  links?: Links2;
2312
2324
  }, SubscriptionsErrorResponse, ThrowOnError>;
2313
2325
  /**
2314
- * List an offering's products
2326
+ * List an offering's plans
2315
2327
  */
2316
- declare const listOfferingProducts: <ThrowOnError extends boolean = false>(options: Options<ListOfferingProductsData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<{
2317
- data?: Array<OfferingProduct>;
2328
+ declare const listOfferingPlans: <ThrowOnError extends boolean = false>(options: Options<ListOfferingPlansData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<{
2329
+ data?: Array<OfferingPlan>;
2318
2330
  links?: Links2;
2319
2331
  }, SubscriptionsErrorResponse, ThrowOnError>;
2332
+ /**
2333
+ * List the pricing options available to a plan in an offering
2334
+ */
2335
+ declare const listOfferingPlanPricingOptions: <ThrowOnError extends boolean = false>(options: Options<ListOfferingPlanPricingOptionsData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<{
2336
+ data?: Array<RelationshipData>;
2337
+ }, SubscriptionsErrorResponse, ThrowOnError>;
2320
2338
  /**
2321
2339
  * List subscriptions
2322
2340
  * Retrieves a list of all subscriptions.
@@ -2337,9 +2355,9 @@ declare const listOfferingProducts: <ThrowOnError extends boolean = false>(optio
2337
2355
  *
2338
2356
  * | Resource | Required | Description |
2339
2357
  * | --- | --- | --- |
2340
- * | `plans, products` | Optional | Retrieves all plans and products associated with a subscription. |
2341
- * | `products` | Optional | Retrieves all products associated with a subscription. |
2358
+ * | `pricing_options, plans` | Optional | Retrieves all pricing options and plans associated with a subscription. |
2342
2359
  * | `plans` | Optional | Retrieves all plans associated with a subscription. |
2360
+ * | `pricing_options` | Optional | Retrieves all pricing options associated with a subscription. |
2343
2361
  *
2344
2362
  * See [Characteristics of Include Parameter](/guides/Getting-Started/includes#characteristics-of-include-parameter).
2345
2363
  *
@@ -2356,20 +2374,20 @@ declare const getSubscription: <ThrowOnError extends boolean = false>(options: O
2356
2374
  data?: Subscription;
2357
2375
  included?: SubscriptionIncludes;
2358
2376
  }, SubscriptionsErrorResponse, ThrowOnError>;
2359
- /**
2360
- * List subscription products
2361
- * Retrieves a list of products associated with the specified subscription.
2362
- */
2363
- declare const listSubscriptionProducts: <ThrowOnError extends boolean = false>(options: Options<ListSubscriptionProductsData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<{
2364
- data?: Array<OfferingProduct>;
2365
- }, SubscriptionsErrorResponse, ThrowOnError>;
2366
2377
  /**
2367
2378
  * List subscription plans
2368
- * Retrieves a list of plans associated with the specified subscription. Using this endpoint you can see the plans that are currently active in a subscription. If `active_plan` is `true`, a plan is active in a subscription. If `active_plan` is null, the plan is not active.
2379
+ * Retrieves a list of plans associated with the specified subscription. Using this endpoint you can see the plan that is currently active in a subscription. If `active_plan` is `true`, a plan is active in a subscription. If `active_plan` is null, the pricing option is not active.
2369
2380
  */
2370
2381
  declare const listSubscriptionPlans: <ThrowOnError extends boolean = false>(options: Options<ListSubscriptionPlansData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<{
2371
2382
  data?: Array<OfferingPlan>;
2372
2383
  }, SubscriptionsErrorResponse, ThrowOnError>;
2384
+ /**
2385
+ * List subscription pricing options
2386
+ * Retrieves a list of pricing options associated with the specified subscription. Using this endpoint you can see the pricing options that are currently active in a subscription. If `active_pricing_option` is `true`, a pricing option is active in a subscription. If `active_pricing_option` is null, the pricing option is not active.
2387
+ */
2388
+ declare const listSubscriptionPricingOptions: <ThrowOnError extends boolean = false>(options: Options<ListSubscriptionPricingOptionsData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<{
2389
+ data?: Array<OfferingPricingOption>;
2390
+ }, SubscriptionsErrorResponse, ThrowOnError>;
2373
2391
  /**
2374
2392
  * List subscription states
2375
2393
  */
@@ -2736,4 +2754,4 @@ declare const getAFile: <ThrowOnError extends boolean = false>(options: Options<
2736
2754
  data?: File;
2737
2755
  }, FilesErrorResponse, ThrowOnError>;
2738
2756
 
2739
- 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 };
2757
+ export { addCustomDiscountToCartItem, addTaxItemToCart, anonymizeOrders, bulkAddCustomDiscountsToCart, bulkAddTaxItemsToCart, bulkDeleteCustomDiscountsFromCart, bulkDeleteTaxItemsFromCart, bulkUpdateItemsInCart, cancelATransaction, captureATransaction, checkoutApi, client, configureByContextProduct, confirmOrder, confirmPayment, createACart, createAccountCartAssociation, createAnAccessToken, createCartPaymentIntent, createCatalog, createCustomerCartAssociation, createOneTimePasswordTokenRequest, createOrderShippingGroup, createRule, createShippingGroup, deleteACart, deleteACartItem, deleteAPromotionViaPromotionCode, deleteATaxItem, deleteAccountCartAssociation, deleteAllCartItems, deleteCartShippingGroup, deleteCatalogById, deleteCustomDiscountFromCart, deleteCustomDiscountFromCartItem, deleteCustomerCartAssociation, deleteReleaseById, deleteReleases, deleteRuleById, deleteV2AccountAddress, getACart, 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, getCartItems, getCarts, getCatalogById, getCatalogs, getChildNodes, getChildProducts, getComponentProductIds, getCustomerOrders, getFeature, getHierarchy, getHierarchyChildNodes, getHierarchyNodes, getInvoice, getNode, getOffering, getOrderItems, getOrderShippingGroups, getOrderTransactions, getProduct, getProductsForHierarchy, getProductsForNode, getReleaseById, getReleases, getRuleById, getRules, getShippingGroupById, getShippingGroups, getShippingGroupsById, getStock, getSubscription, getSubscriptionInvoice, getSubscriptionInvoicePayment, getSubscriptionState, getV2AccountAddress, getV2AccountAddresses, getV2AccountMembers, getV2AccountMembersAccountMemberId, getV2Accounts, getV2AccountsAccountId, getV2AccountsAccountIdAccountMemberships, listInvoices, listLocations, listOfferingFeatures, listOfferingPlanPricingOptions, listOfferingPlans, listOfferingPricingOptions, listOfferings, listSubscriptionInvoicePayments, listSubscriptionInvoices, listSubscriptionPlans, listSubscriptionPricingOptions, listSubscriptionStates, listSubscriptions, manageCarts, paymentSetup, postV2AccountAddress, postV2AccountMembersTokens, postV2Accounts, publishRelease, putShippingGroupById, putV2AccountAddress, putV2AccountsAccountId, refundATransaction, updateACart, updateACartItem, updateATaxItem, updateAnOrder, updateCartPaymentIntent, updateCatalog, updateCustomDiscountForCart, updateCustomDiscountForCartItem, updatePasswordProfileInfo, updateRule, updateShippingGroup };