@epcc-sdk/sdks-shopper 0.0.26 → 0.0.27
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.
- package/dist/client/@tanstack/react-query.gen.cjs +2741 -0
- package/dist/client/@tanstack/react-query.gen.cjs.map +1 -0
- package/dist/client/@tanstack/react-query.gen.d.cts +2854 -0
- package/dist/client/@tanstack/react-query.gen.d.ts +798 -794
- package/dist/client/@tanstack/react-query.gen.mjs +2598 -0
- package/dist/client/@tanstack/react-query.gen.mjs.map +1 -0
- package/dist/client/index.cjs +25 -0
- package/dist/client/index.cjs.map +1 -0
- package/dist/client/index.d.cts +3 -0
- package/dist/client/index.d.ts +3 -2
- package/dist/client/index.mjs +3 -0
- package/dist/client/index.mjs.map +1 -0
- package/dist/client/sdk.gen.cjs +1923 -0
- package/dist/client/sdk.gen.cjs.map +1 -0
- package/dist/client/{sdk.gen.js → sdk.gen.d.cts} +330 -1134
- package/dist/client/sdk.gen.d.ts +277 -273
- package/dist/client/sdk.gen.mjs +1778 -0
- package/dist/client/sdk.gen.mjs.map +1 -0
- package/dist/client/transformers.gen.cjs +801 -0
- package/dist/client/transformers.gen.cjs.map +1 -0
- package/dist/client/transformers.gen.d.cts +59 -0
- package/dist/client/transformers.gen.d.ts +59 -56
- package/dist/client/transformers.gen.mjs +723 -0
- package/dist/client/transformers.gen.mjs.map +1 -0
- package/dist/client/types.gen.cjs +17 -0
- package/dist/client/types.gen.cjs.map +1 -0
- package/dist/client/types.gen.d.cts +10550 -0
- package/dist/client/types.gen.d.ts +1129 -1127
- package/dist/client/types.gen.mjs +1 -0
- package/dist/client/types.gen.mjs.map +1 -0
- package/dist/index.cjs +40 -0
- package/dist/index.cjs.map +1 -0
- package/dist/index.d.cts +6 -0
- package/dist/index.d.ts +6 -6
- package/dist/index.mjs +11 -0
- package/dist/index.mjs.map +1 -0
- package/dist/utils/extract-media.cjs +54 -0
- package/dist/utils/extract-media.cjs.map +1 -0
- package/dist/utils/extract-media.d.cts +18 -0
- package/dist/utils/extract-media.d.ts +6 -3
- package/dist/utils/extract-media.mjs +30 -0
- package/dist/utils/extract-media.mjs.map +1 -0
- package/dist/utils/extract-product-image.cjs +35 -0
- package/dist/utils/extract-product-image.cjs.map +1 -0
- package/dist/utils/extract-product-image.d.cts +5 -0
- package/dist/utils/extract-product-image.d.ts +5 -2
- package/dist/utils/extract-product-image.mjs +11 -0
- package/dist/utils/extract-product-image.mjs.map +1 -0
- package/dist/utils/index.cjs +32 -0
- package/dist/utils/index.cjs.map +1 -0
- package/dist/utils/index.d.cts +3 -0
- package/dist/utils/index.d.ts +3 -2
- package/dist/utils/index.mjs +7 -0
- package/dist/utils/index.mjs.map +1 -0
- package/package.json +22 -14
- package/dist/client/@tanstack/react-query.gen.js +0 -2717
- package/dist/client/index.js +0 -3
- package/dist/client/transformers.gen.js +0 -789
- package/dist/client/types.gen.js +0 -2
- package/dist/index.js +0 -6
- package/dist/utils/extract-media.js +0 -54
- package/dist/utils/extract-product-image.js +0 -8
- package/dist/utils/index.js +0 -2
package/dist/client/sdk.gen.d.ts
CHANGED
|
@@ -1,11 +1,13 @@
|
|
|
1
|
-
import {
|
|
2
|
-
import
|
|
3
|
-
|
|
1
|
+
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, GetAllCurrenciesData, ResponseCurrency, GetACurrencyData, GetAllFilesData, File, ResultsMeta, ResultsLinks, FilesErrorResponse, GetAFileData } from './types.gen.js';
|
|
2
|
+
import * as _hey_api_client_fetch from '@hey-api/client-fetch';
|
|
3
|
+
import { Options } from '@hey-api/client-fetch';
|
|
4
|
+
|
|
5
|
+
declare const client: _hey_api_client_fetch.Client<Request, Response, unknown, _hey_api_client_fetch.RequestOptions<boolean, string>>;
|
|
4
6
|
/**
|
|
5
7
|
* Get the catalog release as shoppers
|
|
6
8
|
* Returns a list of all published releases of the specified catalog.
|
|
7
9
|
*/
|
|
8
|
-
|
|
10
|
+
declare const getByContextRelease: <ThrowOnError extends boolean = false>(options?: Options<GetByContextReleaseData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<ReleaseData, ErrorResponse, ThrowOnError>;
|
|
9
11
|
/**
|
|
10
12
|
* Get all Hierarchies
|
|
11
13
|
* Returns all hierarchies from a catalog.
|
|
@@ -32,7 +34,7 @@ export declare const getByContextRelease: <ThrowOnError extends boolean = false>
|
|
|
32
34
|
* - It does not matter what order you specify the node Ids. The nodes are returned in the order they were last updated.
|
|
33
35
|
*
|
|
34
36
|
*/
|
|
35
|
-
|
|
37
|
+
declare const getByContextAllHierarchies: <ThrowOnError extends boolean = false>(options?: Options<GetByContextAllHierarchiesData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<HierarchyListData, ErrorResponse, ThrowOnError>;
|
|
36
38
|
/**
|
|
37
39
|
* Get a Hierarchy
|
|
38
40
|
* Returns a hierarchy from the catalog.
|
|
@@ -40,7 +42,7 @@ export declare const getByContextAllHierarchies: <ThrowOnError extends boolean =
|
|
|
40
42
|
* If you have multiple catalog rules defined, the rule that best matches the shoppers context is used to determine which catalog to retrieve. For information about how catalog rules are matched, see [Resolving Catalog Rules](/docs/api/pxm/catalog/rules).
|
|
41
43
|
*
|
|
42
44
|
*/
|
|
43
|
-
|
|
45
|
+
declare const getByContextHierarchy: <ThrowOnError extends boolean = false>(options: Options<GetByContextHierarchyData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<HierarchyData, ErrorResponse, ThrowOnError>;
|
|
44
46
|
/**
|
|
45
47
|
* Get a Hierarchy's Nodes
|
|
46
48
|
* Returns all the nodes for the specified hierarchy.
|
|
@@ -69,7 +71,7 @@ export declare const getByContextHierarchy: <ThrowOnError extends boolean = fals
|
|
|
69
71
|
* - It does not matter what order you specify the node Ids. The nodes are returned in the order they were last updated.
|
|
70
72
|
*
|
|
71
73
|
*/
|
|
72
|
-
|
|
74
|
+
declare const getByContextHierarchyNodes: <ThrowOnError extends boolean = false>(options: Options<GetByContextHierarchyNodesData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<NodeListData, ErrorResponse, ThrowOnError>;
|
|
73
75
|
/**
|
|
74
76
|
* Get a Hierarchy's Children
|
|
75
77
|
* Returns the parent nodes for the specified hierarchy.
|
|
@@ -102,7 +104,7 @@ export declare const getByContextHierarchyNodes: <ThrowOnError extends boolean =
|
|
|
102
104
|
* - It does not matter what order you specify the node Ids. The nodes are returned in the order they were last updated.
|
|
103
105
|
*
|
|
104
106
|
*/
|
|
105
|
-
|
|
107
|
+
declare const getByContextHierarchyChildNodes: <ThrowOnError extends boolean = false>(options: Options<GetByContextHierarchyChildNodesData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<NodeListData, ErrorResponse, ThrowOnError>;
|
|
106
108
|
/**
|
|
107
109
|
* Get all Nodes
|
|
108
110
|
* Returns all nodes in the catalog.
|
|
@@ -139,7 +141,7 @@ export declare const getByContextHierarchyChildNodes: <ThrowOnError extends bool
|
|
|
139
141
|
* - It does not matter what order you specify the node Ids. The nodes are returned in the order they were last updated.
|
|
140
142
|
*
|
|
141
143
|
*/
|
|
142
|
-
|
|
144
|
+
declare const getByContextAllNodes: <ThrowOnError extends boolean = false>(options?: Options<GetByContextAllNodesData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<NodeListData, ErrorResponse, ThrowOnError>;
|
|
143
145
|
/**
|
|
144
146
|
* Get a Node
|
|
145
147
|
* Returns a node from the catalog.
|
|
@@ -157,7 +159,7 @@ export declare const getByContextAllNodes: <ThrowOnError extends boolean = false
|
|
|
157
159
|
* - If a curated product is removed from a node, the product is also removed from the `curated_products` list.
|
|
158
160
|
*
|
|
159
161
|
*/
|
|
160
|
-
|
|
162
|
+
declare const getByContextNode: <ThrowOnError extends boolean = false>(options: Options<GetByContextNodeData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<NodeData, ErrorResponse, ThrowOnError>;
|
|
161
163
|
/**
|
|
162
164
|
* Get a Node's Children
|
|
163
165
|
* Returns the child nodes for a node in the catalog.
|
|
@@ -195,7 +197,7 @@ export declare const getByContextNode: <ThrowOnError extends boolean = false>(op
|
|
|
195
197
|
* - It does not matter what order you specify the node Ids. The nodes are returned in the order they were last updated.
|
|
196
198
|
*
|
|
197
199
|
*/
|
|
198
|
-
|
|
200
|
+
declare const getByContextChildNodes: <ThrowOnError extends boolean = false>(options: Options<GetByContextChildNodesData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<NodeListData, ErrorResponse, ThrowOnError>;
|
|
199
201
|
/**
|
|
200
202
|
* Get all Products
|
|
201
203
|
* Retrieves the list of products from the catalog. Only the products in a live status are retrieved.
|
|
@@ -241,7 +243,7 @@ export declare const getByContextChildNodes: <ThrowOnError extends boolean = fal
|
|
|
241
243
|
* - It does not matter what order you specify the node Ids. The nodes are returned in the order they were last updated.
|
|
242
244
|
*
|
|
243
245
|
*/
|
|
244
|
-
|
|
246
|
+
declare const getByContextAllProducts: <ThrowOnError extends boolean = false>(options?: Options<GetByContextAllProductsData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<ProductListData, ErrorResponse, ThrowOnError>;
|
|
245
247
|
/**
|
|
246
248
|
* Get a Product
|
|
247
249
|
* Returns the specified product from the catalog. The product must be in the `live` status.
|
|
@@ -261,7 +263,7 @@ export declare const getByContextAllProducts: <ThrowOnError extends boolean = fa
|
|
|
261
263
|
* See [**Including Resources**](/guides/Getting-Started/includes).
|
|
262
264
|
*
|
|
263
265
|
*/
|
|
264
|
-
|
|
266
|
+
declare const getByContextProduct: <ThrowOnError extends boolean = false>(options: Options<GetByContextProductData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<ProductData, ErrorResponse, ThrowOnError>;
|
|
265
267
|
/**
|
|
266
268
|
* Get a Bundle's Component Products
|
|
267
269
|
* 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.
|
|
@@ -271,7 +273,7 @@ export declare const getByContextProduct: <ThrowOnError extends boolean = false>
|
|
|
271
273
|
* This endpoint returns a list of component product IDs for the specified bundle.
|
|
272
274
|
*
|
|
273
275
|
*/
|
|
274
|
-
|
|
276
|
+
declare const getByContextComponentProductIds: <ThrowOnError extends boolean = false>(options: Options<GetByContextComponentProductIdsData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<ProductReferenceListData, ErrorResponse, ThrowOnError>;
|
|
275
277
|
/**
|
|
276
278
|
* Get a Parent Product's Child Products
|
|
277
279
|
* For a specified product and catalog release, retrieves a list of child products from a parent product. Any product other than a base product results in a `422 Unprocessable Entity` response. Only the products in a `live` status are retrieved.
|
|
@@ -312,7 +314,7 @@ export declare const getByContextComponentProductIds: <ThrowOnError extends bool
|
|
|
312
314
|
* See [**Including Resources**](/guides/Getting-Started/includes).
|
|
313
315
|
*
|
|
314
316
|
*/
|
|
315
|
-
|
|
317
|
+
declare const getByContextChildProducts: <ThrowOnError extends boolean = false>(options: Options<GetByContextChildProductsData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<ProductListData, ErrorResponse, ThrowOnError>;
|
|
316
318
|
/**
|
|
317
319
|
* Get a Hierarchy's Products
|
|
318
320
|
* Returns the products associated with the specified hierarchy in the catalog. The products must be in the live status.
|
|
@@ -354,7 +356,7 @@ export declare const getByContextChildProducts: <ThrowOnError extends boolean =
|
|
|
354
356
|
* See [**Including Resources**](/guides/Getting-Started/includes).
|
|
355
357
|
*
|
|
356
358
|
*/
|
|
357
|
-
|
|
359
|
+
declare const getByContextProductsForHierarchy: <ThrowOnError extends boolean = false>(options: Options<GetByContextProductsForHierarchyData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<ProductListData, ErrorResponse, ThrowOnError>;
|
|
358
360
|
/**
|
|
359
361
|
* Get a Node's Products
|
|
360
362
|
* Returns the products associated with the specified hierarchy node in the catalog. The products must be in the `live` status. If the products have been curated then the products are returned in the order specified in the `curated_products` attribute. A product that is curated has the `"curated_product": true` attribute displayed.
|
|
@@ -395,7 +397,7 @@ export declare const getByContextProductsForHierarchy: <ThrowOnError extends boo
|
|
|
395
397
|
* See [**Including Resources**](/guides/Getting-Started/includes).
|
|
396
398
|
*
|
|
397
399
|
*/
|
|
398
|
-
|
|
400
|
+
declare const getByContextProductsForNode: <ThrowOnError extends boolean = false>(options: Options<GetByContextProductsForNodeData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<ProductListData, ErrorResponse, ThrowOnError>;
|
|
399
401
|
/**
|
|
400
402
|
* Configure a Shopper Bundle
|
|
401
403
|
* Once you have configured your product bundles, you can display them in your storefront in your published catalog. Depending on how you have configured the minimum and maximum values for the product options in your components, you can allow your shoppers to choose which products they want to select. For example, you can enable a shopper to select 1 or more product options from a list of 10, giving your shoppers greater flexibility when selecting products in your store front.
|
|
@@ -420,7 +422,7 @@ export declare const getByContextProductsForNode: <ThrowOnError extends boolean
|
|
|
420
422
|
* See [**Including Resources**](/guides/Getting-Started/includes).
|
|
421
423
|
*
|
|
422
424
|
*/
|
|
423
|
-
|
|
425
|
+
declare const configureByContextProduct: <ThrowOnError extends boolean = false>(options: Options<ConfigureByContextProductData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<ProductData, ErrorResponse, ThrowOnError>;
|
|
424
426
|
/**
|
|
425
427
|
* Gets all authorized catalogs
|
|
426
428
|
* Retrieves a list of all the catalogs that you are authorized to view. Currently, published catalogs are limited to the current release and two releases prior to the current release. You can see the differences between the last 2 consecutive catalog releases using the delta link returned in the response of a [publish a catalog](/docs/api/pxm/catalog/publish-release) endpoint.
|
|
@@ -430,7 +432,7 @@ export declare const configureByContextProduct: <ThrowOnError extends boolean =
|
|
|
430
432
|
* 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.
|
|
431
433
|
*
|
|
432
434
|
*/
|
|
433
|
-
|
|
435
|
+
declare const getCatalogs: <ThrowOnError extends boolean = false>(options?: Options<GetCatalogsData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<CatalogListData, ErrorResponse, ThrowOnError>;
|
|
434
436
|
/**
|
|
435
437
|
* Creates a new catalog
|
|
436
438
|
* Before you create a catalog, you must define the following resources:
|
|
@@ -440,27 +442,27 @@ export declare const getCatalogs: <ThrowOnError extends boolean = false>(options
|
|
|
440
442
|
* - Price Books - prices for the products associated with the hierarchies. You can create multiple price books for different scenarios, such as seasonal sales, business versus retail customer pricing, and reward programs. When creating a catalog, you can specify up to five price books. You must configure a priority for your price books. Product prices are displayed in the catalog according to the priority of the price books. Priority is a number and the price book with the highest number has the highest priority.
|
|
441
443
|
*
|
|
442
444
|
*/
|
|
443
|
-
|
|
445
|
+
declare const createCatalog: <ThrowOnError extends boolean = false>(options: Options<CreateCatalogData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<CatalogData, ErrorResponse, ThrowOnError>;
|
|
444
446
|
/**
|
|
445
447
|
* Deletes a catalog
|
|
446
448
|
* Deletes an unpublished catalog. Use [**Delete a Release**](/docs/api/pxm/catalog/delete-release-by-id) and [**Delete All Releases**](/docs/api/pxm/catalog/delete-releases) to delete releases of a catalog. If the catalog is associated with any catalog rules, you must first update the catalog rules to remove the catalog.
|
|
447
449
|
*/
|
|
448
|
-
|
|
450
|
+
declare const deleteCatalogById: <ThrowOnError extends boolean = false>(options: Options<DeleteCatalogByIdData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<void, ErrorResponse, ThrowOnError>;
|
|
449
451
|
/**
|
|
450
452
|
* Get a catalog by ID
|
|
451
453
|
* Retrieves the specified catalog.
|
|
452
454
|
*/
|
|
453
|
-
|
|
455
|
+
declare const getCatalogById: <ThrowOnError extends boolean = false>(options: Options<GetCatalogByIdData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<CatalogData, ErrorResponse, ThrowOnError>;
|
|
454
456
|
/**
|
|
455
457
|
* Updates a catalog
|
|
456
458
|
* Specify whichever attributes you want to change. The values of the other attributes remain the same. If the attributes section is empty, the catalog is not updated.
|
|
457
459
|
*/
|
|
458
|
-
|
|
460
|
+
declare const updateCatalog: <ThrowOnError extends boolean = false>(options: Options<UpdateCatalogData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<CatalogData, ErrorResponse, ThrowOnError>;
|
|
459
461
|
/**
|
|
460
462
|
* Deletes all releases
|
|
461
463
|
* Deletes all releases of the specified published catalog.
|
|
462
464
|
*/
|
|
463
|
-
|
|
465
|
+
declare const deleteReleases: <ThrowOnError extends boolean = false>(options: Options<DeleteReleasesData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<void, ErrorResponse, ThrowOnError>;
|
|
464
466
|
/**
|
|
465
467
|
* Gets all authorized catalog releases
|
|
466
468
|
* Returns a list of all published releases of the specified catalog. Currently, published catalogs are limited to the current release and two releases prior to the current release. You can see the differences between the last 2 consecutive catalog releases using the `delta` link returned in the response of a `publish a catalog` endpoint.
|
|
@@ -470,7 +472,7 @@ export declare const deleteReleases: <ThrowOnError extends boolean = false>(opti
|
|
|
470
472
|
* 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.
|
|
471
473
|
*
|
|
472
474
|
*/
|
|
473
|
-
|
|
475
|
+
declare const getReleases: <ThrowOnError extends boolean = false>(options: Options<GetReleasesData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<ReleaseListData, ErrorResponse, ThrowOnError>;
|
|
474
476
|
/**
|
|
475
477
|
* Publishes a catalog
|
|
476
478
|
* Publishes a catalog. You must publish a catalog before you can retrieve that catalog in an organization or store. The hierarchies, live products, and prices associated with a published catalog are in read-only mode. If you make a change to these resources, for example, a change to your price book or hierarchies, you need to republish the catalog.
|
|
@@ -519,17 +521,17 @@ export declare const getReleases: <ThrowOnError extends boolean = false>(options
|
|
|
519
521
|
* 4. Select the **Include Organization Resources in Catalog Publishes** checkbox.
|
|
520
522
|
*
|
|
521
523
|
*/
|
|
522
|
-
|
|
524
|
+
declare const publishRelease: <ThrowOnError extends boolean = false>(options: Options<PublishReleaseData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<ReleaseData, ErrorResponse, ThrowOnError>;
|
|
523
525
|
/**
|
|
524
526
|
* Deletes a release
|
|
525
527
|
* Deletes the specified published catalog release.
|
|
526
528
|
*/
|
|
527
|
-
|
|
529
|
+
declare const deleteReleaseById: <ThrowOnError extends boolean = false>(options: Options<DeleteReleaseByIdData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<void, ErrorResponse, ThrowOnError>;
|
|
528
530
|
/**
|
|
529
531
|
* Get a catalog release by ID
|
|
530
532
|
* Retrieves the specified catalog release.
|
|
531
533
|
*/
|
|
532
|
-
|
|
534
|
+
declare const getReleaseById: <ThrowOnError extends boolean = false>(options: Options<GetReleaseByIdData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<ReleaseData, ErrorResponse, ThrowOnError>;
|
|
533
535
|
/**
|
|
534
536
|
* Gets all authorized catalog rules
|
|
535
537
|
* Retrieves all authorized catalog rules.
|
|
@@ -543,7 +545,7 @@ export declare const getReleaseById: <ThrowOnError extends boolean = false>(opti
|
|
|
543
545
|
* | `In` | Checks if the values are included in the specified string. If they are, the condition is true. | `id` | `filter=in(id,some-id)` |
|
|
544
546
|
*
|
|
545
547
|
*/
|
|
546
|
-
|
|
548
|
+
declare const getRules: <ThrowOnError extends boolean = false>(options?: Options<GetRulesData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<RuleListData, ErrorResponse, ThrowOnError>;
|
|
547
549
|
/**
|
|
548
550
|
* Creates a new catalog rule
|
|
549
551
|
* If you have multiple catalogs, create catalog rule resources. With catalog rules, you can display different catalogs to different shoppers. For example, you can display a preferred pricing catalog to a few special customers. Or you can display one catalog to shoppers using your website and a different catalog to shoppers using your mobile app. Finally, you can define custom criteria by creating tags.
|
|
@@ -559,20 +561,20 @@ export declare const getRules: <ThrowOnError extends boolean = false>(options?:
|
|
|
559
561
|
* For ideas about the kinds of business scenarios you can achieve with catalog rules, see [Catalog Rules](/docs/api/pxm/catalog/rules). To understand how catalogs are matched to shoppers by using rules, see [Resolving Catalog Rules](/docs/api/pxm/catalog/rules#resolving-catalog-rules).
|
|
560
562
|
*
|
|
561
563
|
*/
|
|
562
|
-
|
|
564
|
+
declare const createRule: <ThrowOnError extends boolean = false>(options: Options<CreateRuleData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<RuleData, ErrorResponse, ThrowOnError>;
|
|
563
565
|
/**
|
|
564
566
|
* Deletes a catalog rule
|
|
565
567
|
*/
|
|
566
|
-
|
|
568
|
+
declare const deleteRuleById: <ThrowOnError extends boolean = false>(options: Options<DeleteRuleByIdData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<void, ErrorResponse, ThrowOnError>;
|
|
567
569
|
/**
|
|
568
570
|
* Get a catalog rule by ID
|
|
569
571
|
*/
|
|
570
|
-
|
|
572
|
+
declare const getRuleById: <ThrowOnError extends boolean = false>(options: Options<GetRuleByIdData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<RuleData, ErrorResponse, ThrowOnError>;
|
|
571
573
|
/**
|
|
572
574
|
* Updates a catalog rule
|
|
573
575
|
* Specify whichever attributes you want to change. The values of the other attributes remain the same. If the attributes section is empty, the catalog rule is not updated.
|
|
574
576
|
*/
|
|
575
|
-
|
|
577
|
+
declare const updateRule: <ThrowOnError extends boolean = false>(options: Options<UpdateRuleData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<RuleData, ErrorResponse, ThrowOnError>;
|
|
576
578
|
/**
|
|
577
579
|
* Get all Hierarchies
|
|
578
580
|
* Returns the hierarchies from a published catalog.
|
|
@@ -603,7 +605,7 @@ export declare const updateRule: <ThrowOnError extends boolean = false>(options:
|
|
|
603
605
|
* - It does not matter what order you specify the node Ids. The nodes are returned in the order they were last updated.
|
|
604
606
|
*
|
|
605
607
|
*/
|
|
606
|
-
|
|
608
|
+
declare const getAllHierarchies: <ThrowOnError extends boolean = false>(options: Options<GetAllHierarchiesData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<HierarchyListData, ErrorResponse, ThrowOnError>;
|
|
607
609
|
/**
|
|
608
610
|
* Get a Hierarchy
|
|
609
611
|
* Returns the specified hierarchy from a published catalog.
|
|
@@ -615,7 +617,7 @@ export declare const getAllHierarchies: <ThrowOnError extends boolean = false>(o
|
|
|
615
617
|
* :::
|
|
616
618
|
*
|
|
617
619
|
*/
|
|
618
|
-
|
|
620
|
+
declare const getHierarchy: <ThrowOnError extends boolean = false>(options: Options<GetHierarchyData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<HierarchyData, ErrorResponse, ThrowOnError>;
|
|
619
621
|
/**
|
|
620
622
|
* Get a Hierarchy's Nodes
|
|
621
623
|
* Returns all nodes for the specified hierarchy from a published catalog.
|
|
@@ -648,7 +650,7 @@ export declare const getHierarchy: <ThrowOnError extends boolean = false>(option
|
|
|
648
650
|
* - It does not matter what order you specify the node Ids. The nodes are returned in the order they were last updated.
|
|
649
651
|
*
|
|
650
652
|
*/
|
|
651
|
-
|
|
653
|
+
declare const getHierarchyNodes: <ThrowOnError extends boolean = false>(options: Options<GetHierarchyNodesData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<NodeListData, ErrorResponse, ThrowOnError>;
|
|
652
654
|
/**
|
|
653
655
|
* Get a Hierarchy's Children
|
|
654
656
|
* Returns the parent nodes for the specified hierarchy from a published catalog.
|
|
@@ -683,7 +685,7 @@ export declare const getHierarchyNodes: <ThrowOnError extends boolean = false>(o
|
|
|
683
685
|
* - It does not matter what order you specify the node Ids. The nodes are returned in the order they were last updated.
|
|
684
686
|
*
|
|
685
687
|
*/
|
|
686
|
-
|
|
688
|
+
declare const getHierarchyChildNodes: <ThrowOnError extends boolean = false>(options: Options<GetHierarchyChildNodesData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<NodeListData, ErrorResponse, ThrowOnError>;
|
|
687
689
|
/**
|
|
688
690
|
* Get all Nodes
|
|
689
691
|
* Returns the child nodes from a published catalog.
|
|
@@ -727,7 +729,7 @@ export declare const getHierarchyChildNodes: <ThrowOnError extends boolean = fal
|
|
|
727
729
|
* - It does not matter what order you specify the node Ids. The nodes are returned in the order they were last updated.
|
|
728
730
|
*
|
|
729
731
|
*/
|
|
730
|
-
|
|
732
|
+
declare const getAllNodes: <ThrowOnError extends boolean = false>(options: Options<GetAllNodesData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<NodeListData, ErrorResponse, ThrowOnError>;
|
|
731
733
|
/**
|
|
732
734
|
* Get a Node
|
|
733
735
|
* Returns a node from a published catalog.
|
|
@@ -749,7 +751,7 @@ export declare const getAllNodes: <ThrowOnError extends boolean = false>(options
|
|
|
749
751
|
* - A product that is curated has the `"curated_product": true` attribute displayed.
|
|
750
752
|
*
|
|
751
753
|
*/
|
|
752
|
-
|
|
754
|
+
declare const getNode: <ThrowOnError extends boolean = false>(options: Options<GetNodeData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<NodeData, ErrorResponse, ThrowOnError>;
|
|
753
755
|
/**
|
|
754
756
|
* Get a Node's Children
|
|
755
757
|
* Returns the child nodes for a node from a published catalog.
|
|
@@ -793,7 +795,7 @@ export declare const getNode: <ThrowOnError extends boolean = false>(options: Op
|
|
|
793
795
|
* - It does not matter what order you specify the node Ids. The nodes are returned in the order they were last updated.
|
|
794
796
|
*
|
|
795
797
|
*/
|
|
796
|
-
|
|
798
|
+
declare const getChildNodes: <ThrowOnError extends boolean = false>(options: Options<GetChildNodesData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<NodeListData, ErrorResponse, ThrowOnError>;
|
|
797
799
|
/**
|
|
798
800
|
* Get all Products
|
|
799
801
|
* Returns the products from a published catalog. Only the products in a `live` status are retrieved. Currently, published catalogs are limited to the current release and two releases prior to the current release.
|
|
@@ -834,7 +836,7 @@ export declare const getChildNodes: <ThrowOnError extends boolean = false>(optio
|
|
|
834
836
|
* - It does not matter what order you specify the node Ids. The nodes are returned in the order they were last updated.
|
|
835
837
|
*
|
|
836
838
|
*/
|
|
837
|
-
|
|
839
|
+
declare const getAllProducts: <ThrowOnError extends boolean = false>(options: Options<GetAllProductsData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<ProductListData, ErrorResponse, ThrowOnError>;
|
|
838
840
|
/**
|
|
839
841
|
* Get a Product
|
|
840
842
|
* Returns a product from a published catalog. The product must be in `live` status. Currently, published catalogs are limited to the current release and two releases prior to the current release.
|
|
@@ -860,7 +862,7 @@ export declare const getAllProducts: <ThrowOnError extends boolean = false>(opti
|
|
|
860
862
|
* See [**Including Resources**](/guides/Getting-Started/includes).
|
|
861
863
|
*
|
|
862
864
|
*/
|
|
863
|
-
|
|
865
|
+
declare const getProduct: <ThrowOnError extends boolean = false>(options: Options<GetProductData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<ProductData, ErrorResponse, ThrowOnError>;
|
|
864
866
|
/**
|
|
865
867
|
* Get a Bundle's Component Products
|
|
866
868
|
* 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.
|
|
@@ -882,7 +884,7 @@ export declare const getProduct: <ThrowOnError extends boolean = false>(options:
|
|
|
882
884
|
* See [**Including Resources**](/guides/Getting-Started/includes).
|
|
883
885
|
*
|
|
884
886
|
*/
|
|
885
|
-
|
|
887
|
+
declare const getComponentProductIds: <ThrowOnError extends boolean = false>(options: Options<GetComponentProductIdsData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<ProductReferenceListData, ErrorResponse, ThrowOnError>;
|
|
886
888
|
/**
|
|
887
889
|
* Get a Parent Product's Child Products
|
|
888
890
|
* For a specified product and catalog release, retrieves a list of child products from a parent product. Any product other than a base product results in a `422 Unprocessable Entity` response. Only the products in a `live` status are retrieved.
|
|
@@ -923,7 +925,7 @@ export declare const getComponentProductIds: <ThrowOnError extends boolean = fal
|
|
|
923
925
|
* See [**Including Resources**](/guides/Getting-Started/includes).
|
|
924
926
|
*
|
|
925
927
|
*/
|
|
926
|
-
|
|
928
|
+
declare const getChildProducts: <ThrowOnError extends boolean = false>(options: Options<GetChildProductsData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<ProductListData, ErrorResponse, ThrowOnError>;
|
|
927
929
|
/**
|
|
928
930
|
* Get a Hierarchy's Products
|
|
929
931
|
* Returns the products associated with the specified hierarchy in the catalog. The products must be in the `live` status.
|
|
@@ -966,7 +968,7 @@ export declare const getChildProducts: <ThrowOnError extends boolean = false>(op
|
|
|
966
968
|
* See [**Including Resources**](/guides/Getting-Started/includes).
|
|
967
969
|
*
|
|
968
970
|
*/
|
|
969
|
-
|
|
971
|
+
declare const getProductsForHierarchy: <ThrowOnError extends boolean = false>(options: Options<GetProductsForHierarchyData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<ProductListData, ErrorResponse, ThrowOnError>;
|
|
970
972
|
/**
|
|
971
973
|
* Get a Node's Products
|
|
972
974
|
* Returns the products associated with the specified hierarchy node in the catalog. The products must be in the `live` status. If the products have been curated, then the products are returned in the order specified in the `curated_products` attribute. A product that is curated has the `"curated_product": true` attribute displayed.
|
|
@@ -1015,7 +1017,7 @@ export declare const getProductsForHierarchy: <ThrowOnError extends boolean = fa
|
|
|
1015
1017
|
* See [**Including Resources**](/guides/Getting-Started/includes).
|
|
1016
1018
|
*
|
|
1017
1019
|
*/
|
|
1018
|
-
|
|
1020
|
+
declare const getProductsForNode: <ThrowOnError extends boolean = false>(options: Options<GetProductsForNodeData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<ProductListData, ErrorResponse, ThrowOnError>;
|
|
1019
1021
|
/**
|
|
1020
1022
|
* Get Shopper Carts
|
|
1021
1023
|
* You can retrieve the carts that are associated with an [account](/docs/api/carts/account-cart-associations) or a [customer](/docs/api/carts/customer-cart-associations).
|
|
@@ -1029,11 +1031,11 @@ export declare const getProductsForNode: <ThrowOnError extends boolean = false>(
|
|
|
1029
1031
|
* :::
|
|
1030
1032
|
*
|
|
1031
1033
|
*/
|
|
1032
|
-
|
|
1033
|
-
data?: Array<
|
|
1034
|
-
links?:
|
|
1035
|
-
meta?:
|
|
1036
|
-
},
|
|
1034
|
+
declare const getCarts: <ThrowOnError extends boolean = false>(options?: Options<GetCartsData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<ResponseData & {
|
|
1035
|
+
data?: Array<CartResponse>;
|
|
1036
|
+
links?: ResponsePageLinks;
|
|
1037
|
+
meta?: ResponseMetaCarts;
|
|
1038
|
+
}, ResponseError, ThrowOnError>;
|
|
1037
1039
|
/**
|
|
1038
1040
|
* Create a Cart
|
|
1039
1041
|
*
|
|
@@ -1095,9 +1097,9 @@ export declare const getCarts: <ThrowOnError extends boolean = false>(options?:
|
|
|
1095
1097
|
* - 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`.
|
|
1096
1098
|
*
|
|
1097
1099
|
*/
|
|
1098
|
-
|
|
1099
|
-
data?:
|
|
1100
|
-
},
|
|
1100
|
+
declare const createACart: <ThrowOnError extends boolean = false>(options?: Options<CreateACartData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<ResponseData & {
|
|
1101
|
+
data?: CartResponse;
|
|
1102
|
+
}, ResponseError, ThrowOnError>;
|
|
1101
1103
|
/**
|
|
1102
1104
|
* Delete a Cart
|
|
1103
1105
|
* You can delete a cart, including the items, name, description, and remove all associations.
|
|
@@ -1119,7 +1121,7 @@ export declare const createACart: <ThrowOnError extends boolean = false>(options
|
|
|
1119
1121
|
* ````
|
|
1120
1122
|
*
|
|
1121
1123
|
*/
|
|
1122
|
-
|
|
1124
|
+
declare const deleteACart: <ThrowOnError extends boolean = false>(options: Options<DeleteACartData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<void, ResponseError, ThrowOnError>;
|
|
1123
1125
|
/**
|
|
1124
1126
|
* Get a Cart
|
|
1125
1127
|
* 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.
|
|
@@ -1147,12 +1149,12 @@ export declare const deleteACart: <ThrowOnError extends boolean = false>(options
|
|
|
1147
1149
|
* | `include` | Optional | `string` | Comma-delimited string of entities that can be included. The information included are `items`,`tax_items`, `custom_discounts`, or `promotions`. |
|
|
1148
1150
|
*
|
|
1149
1151
|
*/
|
|
1150
|
-
|
|
1151
|
-
data?:
|
|
1152
|
+
declare const getCart: <ThrowOnError extends boolean = false>(options: Options<GetCartData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<ResponseData & {
|
|
1153
|
+
data?: CartResponse;
|
|
1152
1154
|
} & {
|
|
1153
|
-
data?:
|
|
1154
|
-
included?:
|
|
1155
|
-
},
|
|
1155
|
+
data?: CartResponse;
|
|
1156
|
+
included?: CartInclude;
|
|
1157
|
+
}, ResponseError, ThrowOnError>;
|
|
1156
1158
|
/**
|
|
1157
1159
|
* Update a Cart
|
|
1158
1160
|
* Updates cart properties for the specified cartID.
|
|
@@ -1160,15 +1162,15 @@ export declare const getCart: <ThrowOnError extends boolean = false>(options: Op
|
|
|
1160
1162
|
* 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).
|
|
1161
1163
|
*
|
|
1162
1164
|
*/
|
|
1163
|
-
|
|
1164
|
-
data?:
|
|
1165
|
-
},
|
|
1165
|
+
declare const updateACart: <ThrowOnError extends boolean = false>(options: Options<UpdateACartData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<ResponseData & {
|
|
1166
|
+
data?: CartResponse;
|
|
1167
|
+
}, ResponseError, ThrowOnError>;
|
|
1166
1168
|
/**
|
|
1167
1169
|
* Delete all Cart Items
|
|
1168
1170
|
* 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.
|
|
1169
1171
|
*
|
|
1170
1172
|
*/
|
|
1171
|
-
|
|
1173
|
+
declare const deleteAllCartItems: <ThrowOnError extends boolean = false>(options: Options<DeleteAllCartItemsData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<void, ResponseError, ThrowOnError>;
|
|
1172
1174
|
/**
|
|
1173
1175
|
* Get Cart Items
|
|
1174
1176
|
*
|
|
@@ -1352,7 +1354,7 @@ export declare const deleteAllCartItems: <ThrowOnError extends boolean = false>(
|
|
|
1352
1354
|
* ```
|
|
1353
1355
|
*
|
|
1354
1356
|
*/
|
|
1355
|
-
|
|
1357
|
+
declare const getCartItems: <ThrowOnError extends boolean = false>(options: Options<GetCartItemsData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<CartsResponse, ResponseError, ThrowOnError>;
|
|
1356
1358
|
/**
|
|
1357
1359
|
* Add Items to Cart
|
|
1358
1360
|
*
|
|
@@ -1728,7 +1730,7 @@ export declare const getCartItems: <ThrowOnError extends boolean = false>(option
|
|
|
1728
1730
|
* ```
|
|
1729
1731
|
*
|
|
1730
1732
|
*/
|
|
1731
|
-
|
|
1733
|
+
declare const manageCarts: <ThrowOnError extends boolean = false>(options: Options<ManageCartsData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<CartsResponse, ResponseError, ThrowOnError>;
|
|
1732
1734
|
/**
|
|
1733
1735
|
* Bulk Update Items in Cart
|
|
1734
1736
|
* 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.
|
|
@@ -1736,42 +1738,42 @@ export declare const manageCarts: <ThrowOnError extends boolean = false>(options
|
|
|
1736
1738
|
* 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.
|
|
1737
1739
|
*
|
|
1738
1740
|
*/
|
|
1739
|
-
|
|
1741
|
+
declare const bulkUpdateItemsInCart: <ThrowOnError extends boolean = false>(options: Options<BulkUpdateItemsInCartData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<unknown, ResponseError, ThrowOnError>;
|
|
1740
1742
|
/**
|
|
1741
1743
|
* Delete a Cart Item
|
|
1742
1744
|
* Use this endpoint to delete a cart item.
|
|
1743
1745
|
*/
|
|
1744
|
-
|
|
1746
|
+
declare const deleteACartItem: <ThrowOnError extends boolean = false>(options: Options<DeleteACartItemData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<void, ResponseError, ThrowOnError>;
|
|
1745
1747
|
/**
|
|
1746
1748
|
* Update a Cart Item
|
|
1747
1749
|
* You can easily update a cart item. A successful update returns the cart items.
|
|
1748
1750
|
*/
|
|
1749
|
-
|
|
1751
|
+
declare const updateACartItem: <ThrowOnError extends boolean = false>(options: Options<UpdateACartItemData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<CartsResponse, ResponseError, ThrowOnError>;
|
|
1750
1752
|
/**
|
|
1751
1753
|
* Delete Account Cart Association
|
|
1752
1754
|
* You can delete an association between an account and a cart.
|
|
1753
1755
|
*/
|
|
1754
|
-
|
|
1756
|
+
declare const deleteAccountCartAssociation: <ThrowOnError extends boolean = false>(options: Options<DeleteAccountCartAssociationData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<void, ResponseError, ThrowOnError>;
|
|
1755
1757
|
/**
|
|
1756
1758
|
* Create an Account Cart Association
|
|
1757
1759
|
* 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.
|
|
1758
1760
|
*/
|
|
1759
|
-
|
|
1761
|
+
declare const createAccountCartAssociation: <ThrowOnError extends boolean = false>(options: Options<CreateAccountCartAssociationData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<CreateAccountCartAssociationResponse, ResponseError, ThrowOnError>;
|
|
1760
1762
|
/**
|
|
1761
1763
|
* Delete Customer Cart Association
|
|
1762
1764
|
* You can delete an association between a customer and a cart.
|
|
1763
1765
|
*/
|
|
1764
|
-
|
|
1766
|
+
declare const deleteCustomerCartAssociation: <ThrowOnError extends boolean = false>(options: Options<DeleteCustomerCartAssociationData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<void, ResponseError, ThrowOnError>;
|
|
1765
1767
|
/**
|
|
1766
1768
|
* Create a Customer Cart Association
|
|
1767
1769
|
* 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.
|
|
1768
1770
|
*/
|
|
1769
|
-
|
|
1771
|
+
declare const createCustomerCartAssociation: <ThrowOnError extends boolean = false>(options: Options<CreateCustomerCartAssociationData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<CartsRelationshipsCustomersData, ResponseError, ThrowOnError>;
|
|
1770
1772
|
/**
|
|
1771
1773
|
* Delete a Promotion via Promotion Code
|
|
1772
1774
|
* You can remove promotion code from a cart if it was applied manually. This endpoint does not work if the promotion is applied automatically.
|
|
1773
1775
|
*/
|
|
1774
|
-
|
|
1776
|
+
declare const deleteAPromotionViaPromotionCode: <ThrowOnError extends boolean = false>(options: Options<DeleteAPromotionViaPromotionCodeData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<void, ResponseError, ThrowOnError>;
|
|
1775
1777
|
/**
|
|
1776
1778
|
* Add Tax Item to Cart
|
|
1777
1779
|
*
|
|
@@ -1784,14 +1786,14 @@ export declare const deleteAPromotionViaPromotionCode: <ThrowOnError extends boo
|
|
|
1784
1786
|
* :::
|
|
1785
1787
|
*
|
|
1786
1788
|
*/
|
|
1787
|
-
|
|
1788
|
-
data?:
|
|
1789
|
-
},
|
|
1789
|
+
declare const addTaxItemToCart: <ThrowOnError extends boolean = false>(options: Options<AddTaxItemToCartData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<ResponseData & {
|
|
1790
|
+
data?: CartsItemsTaxesObject;
|
|
1791
|
+
}, ResponseError, ThrowOnError>;
|
|
1790
1792
|
/**
|
|
1791
1793
|
* Bulk Delete Tax Items from Cart
|
|
1792
1794
|
* Use this endpoint to bulk delete tax items from cart.
|
|
1793
1795
|
*/
|
|
1794
|
-
|
|
1796
|
+
declare const bulkDeleteTaxItemsFromCart: <ThrowOnError extends boolean = false>(options: Options<BulkDeleteTaxItemsFromCartData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<void, ResponseError, ThrowOnError>;
|
|
1795
1797
|
/**
|
|
1796
1798
|
* Bulk Add Tax Items to Cart
|
|
1797
1799
|
* :::note
|
|
@@ -1857,24 +1859,24 @@ export declare const bulkDeleteTaxItemsFromCart: <ThrowOnError extends boolean =
|
|
|
1857
1859
|
* ```
|
|
1858
1860
|
*
|
|
1859
1861
|
*/
|
|
1860
|
-
|
|
1862
|
+
declare const bulkAddTaxItemsToCart: <ThrowOnError extends boolean = false>(options: Options<BulkAddTaxItemsToCartData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<CartsBulkTaxes, ResponseError, ThrowOnError>;
|
|
1861
1863
|
/**
|
|
1862
1864
|
* Delete a Tax Item
|
|
1863
1865
|
* Use this endpoint to delete a tax item.
|
|
1864
1866
|
*/
|
|
1865
|
-
|
|
1867
|
+
declare const deleteATaxItem: <ThrowOnError extends boolean = false>(options: Options<DeleteATaxItemData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<void, ResponseError, ThrowOnError>;
|
|
1866
1868
|
/**
|
|
1867
1869
|
* Update a Tax Item
|
|
1868
1870
|
* Use this endpoint to update a tax item.
|
|
1869
1871
|
*/
|
|
1870
|
-
|
|
1871
|
-
data?:
|
|
1872
|
-
},
|
|
1872
|
+
declare const updateATaxItem: <ThrowOnError extends boolean = false>(options: Options<UpdateATaxItemData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<ResponseData & {
|
|
1873
|
+
data?: CartsItemsTaxesObject;
|
|
1874
|
+
}, ResponseError, ThrowOnError>;
|
|
1873
1875
|
/**
|
|
1874
1876
|
* Bulk Delete Custom Discounts From Cart
|
|
1875
1877
|
* Use this endpoint to bulk delete custom discounts from cart.
|
|
1876
1878
|
*/
|
|
1877
|
-
|
|
1879
|
+
declare const bulkDeleteCustomDiscountsFromCart: <ThrowOnError extends boolean = false>(options: Options<BulkDeleteCustomDiscountsFromCartData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<void, ResponseError, ThrowOnError>;
|
|
1878
1880
|
/**
|
|
1879
1881
|
* Bulk Add Custom Discounts to Cart
|
|
1880
1882
|
* 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.
|
|
@@ -1882,38 +1884,38 @@ export declare const bulkDeleteCustomDiscountsFromCart: <ThrowOnError extends bo
|
|
|
1882
1884
|
* To increase the custom discount value, contact [Elastic Path Support team](https://support.elasticpath.com/hc/en-us).
|
|
1883
1885
|
*
|
|
1884
1886
|
*/
|
|
1885
|
-
|
|
1887
|
+
declare const bulkAddCustomDiscountsToCart: <ThrowOnError extends boolean = false>(options: Options<BulkAddCustomDiscountsToCartData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<CartsBulkCustomDiscountsResponse, ResponseError, ThrowOnError>;
|
|
1886
1888
|
/**
|
|
1887
1889
|
* Delete Custom Discount From Cart
|
|
1888
1890
|
* Use this endpoint to delete custom discount from cart.
|
|
1889
1891
|
*/
|
|
1890
|
-
|
|
1892
|
+
declare const deleteCustomDiscountFromCart: <ThrowOnError extends boolean = false>(options: Options<DeleteCustomDiscountFromCartData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<void, ResponseError, ThrowOnError>;
|
|
1891
1893
|
/**
|
|
1892
1894
|
* Update Custom Discount For Cart
|
|
1893
1895
|
* Use this endpoint to update a custom discount in your cart.
|
|
1894
1896
|
*/
|
|
1895
|
-
|
|
1896
|
-
data?:
|
|
1897
|
-
},
|
|
1897
|
+
declare const updateCustomDiscountForCart: <ThrowOnError extends boolean = false>(options: Options<UpdateCustomDiscountForCartData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<ResponseData & {
|
|
1898
|
+
data?: CartsCustomDiscountsResponse;
|
|
1899
|
+
}, ResponseError, ThrowOnError>;
|
|
1898
1900
|
/**
|
|
1899
1901
|
* Add Custom Discount To Cart Item
|
|
1900
1902
|
* Use this endpoint to add a custom discount to cart item.
|
|
1901
1903
|
*/
|
|
1902
|
-
|
|
1903
|
-
data?:
|
|
1904
|
-
},
|
|
1904
|
+
declare const addCustomDiscountToCartItem: <ThrowOnError extends boolean = false>(options: Options<AddCustomDiscountToCartItemData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<ResponseData & {
|
|
1905
|
+
data?: CartsCustomDiscountsResponse;
|
|
1906
|
+
}, ResponseError, ThrowOnError>;
|
|
1905
1907
|
/**
|
|
1906
1908
|
* Delete Custom Discount From Cart Item
|
|
1907
1909
|
* Use this endpoint to delete custom discount from cart item.
|
|
1908
1910
|
*/
|
|
1909
|
-
|
|
1911
|
+
declare const deleteCustomDiscountFromCartItem: <ThrowOnError extends boolean = false>(options: Options<DeleteCustomDiscountFromCartItemData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<void, ResponseError, ThrowOnError>;
|
|
1910
1912
|
/**
|
|
1911
1913
|
* Update Custom Discount For Cart Item
|
|
1912
1914
|
* Use this endpoint to update a custom discount in your cart item.
|
|
1913
1915
|
*/
|
|
1914
|
-
|
|
1915
|
-
data?:
|
|
1916
|
-
},
|
|
1916
|
+
declare const updateCustomDiscountForCartItem: <ThrowOnError extends boolean = false>(options: Options<UpdateCustomDiscountForCartItemData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<ResponseData & {
|
|
1917
|
+
data?: CartsCustomDiscountsResponse;
|
|
1918
|
+
}, ResponseError, ThrowOnError>;
|
|
1917
1919
|
/**
|
|
1918
1920
|
* Create Stripe Payment Intent for a Cart
|
|
1919
1921
|
* 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.
|
|
@@ -1942,7 +1944,7 @@ export declare const updateCustomDiscountForCartItem: <ThrowOnError extends bool
|
|
|
1942
1944
|
* - 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.
|
|
1943
1945
|
*
|
|
1944
1946
|
*/
|
|
1945
|
-
|
|
1947
|
+
declare const createCartPaymentIntent: <ThrowOnError extends boolean = false>(options: Options<CreateCartPaymentIntentData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<CartResponse, ResponseError, ThrowOnError>;
|
|
1946
1948
|
/**
|
|
1947
1949
|
* Checkout API
|
|
1948
1950
|
* 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.
|
|
@@ -1999,9 +2001,9 @@ export declare const createCartPaymentIntent: <ThrowOnError extends boolean = fa
|
|
|
1999
2001
|
* ```
|
|
2000
2002
|
*
|
|
2001
2003
|
*/
|
|
2002
|
-
|
|
2003
|
-
data?:
|
|
2004
|
-
},
|
|
2004
|
+
declare const checkoutApi: <ThrowOnError extends boolean = false>(options: Options<CheckoutApiData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<ResponseData & {
|
|
2005
|
+
data?: OrderResponse;
|
|
2006
|
+
}, ResponseError, ThrowOnError>;
|
|
2005
2007
|
/**
|
|
2006
2008
|
* Get all Orders
|
|
2007
2009
|
* 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.
|
|
@@ -2043,24 +2045,24 @@ export declare const checkoutApi: <ThrowOnError extends boolean = false>(options
|
|
|
2043
2045
|
* | `order_number` | `string` | `eq` / `like` | `like(order_number, 123*)` |
|
|
2044
2046
|
*
|
|
2045
2047
|
*/
|
|
2046
|
-
|
|
2047
|
-
data?: Array<
|
|
2048
|
-
links?:
|
|
2049
|
-
meta?:
|
|
2048
|
+
declare const getCustomerOrders: <ThrowOnError extends boolean = false>(options?: Options<GetCustomerOrdersData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<ResponseData & {
|
|
2049
|
+
data?: Array<OrderResponse>;
|
|
2050
|
+
links?: ResponsePageLinks;
|
|
2051
|
+
meta?: ResponseMetaOrders;
|
|
2050
2052
|
included?: {
|
|
2051
|
-
items?: Array<
|
|
2053
|
+
items?: Array<OrderItemResponse>;
|
|
2052
2054
|
};
|
|
2053
|
-
},
|
|
2055
|
+
}, ResponseError, ThrowOnError>;
|
|
2054
2056
|
/**
|
|
2055
2057
|
* Get an Order
|
|
2056
2058
|
* Use this endpoint to retrieve a specific order.
|
|
2057
2059
|
*/
|
|
2058
|
-
|
|
2059
|
-
data?:
|
|
2060
|
+
declare const getAnOrder: <ThrowOnError extends boolean = false>(options: Options<GetAnOrderData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<ResponseData & {
|
|
2061
|
+
data?: OrderResponse;
|
|
2060
2062
|
included?: {
|
|
2061
|
-
items?: Array<
|
|
2063
|
+
items?: Array<OrderItemResponse>;
|
|
2062
2064
|
};
|
|
2063
|
-
},
|
|
2065
|
+
}, ResponseError, ThrowOnError>;
|
|
2064
2066
|
/**
|
|
2065
2067
|
* Update an Order
|
|
2066
2068
|
* You can only update custom data, `shipping`, `shipping_address`, and status of orders. All other settings in the order object are immutable.
|
|
@@ -2086,16 +2088,16 @@ export declare const getAnOrder: <ThrowOnError extends boolean = false>(options:
|
|
|
2086
2088
|
* :::
|
|
2087
2089
|
*
|
|
2088
2090
|
*/
|
|
2089
|
-
|
|
2090
|
-
data?:
|
|
2091
|
-
},
|
|
2091
|
+
declare const updateAnOrder: <ThrowOnError extends boolean = false>(options: Options<UpdateAnOrderData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<ResponseData & {
|
|
2092
|
+
data?: OrderResponse;
|
|
2093
|
+
}, ResponseError, ThrowOnError>;
|
|
2092
2094
|
/**
|
|
2093
2095
|
* Get Order Items
|
|
2094
2096
|
* Use this endpoint to retrieve order items.
|
|
2095
2097
|
*/
|
|
2096
|
-
|
|
2097
|
-
data?: Array<
|
|
2098
|
-
},
|
|
2098
|
+
declare const getOrderItems: <ThrowOnError extends boolean = false>(options: Options<GetOrderItemsData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<ResponseData & {
|
|
2099
|
+
data?: Array<OrderItemResponse>;
|
|
2100
|
+
}, ResponseError, ThrowOnError>;
|
|
2099
2101
|
/**
|
|
2100
2102
|
* Anonymize Orders
|
|
2101
2103
|
* You can anonymize an order when it is fulfilled, canceled, or fully refunded.
|
|
@@ -2103,9 +2105,9 @@ export declare const getOrderItems: <ThrowOnError extends boolean = false>(optio
|
|
|
2103
2105
|
* When anonymization is successful, Personal Identifiable Information such as customer details, `shipping_address`, and `billing_address` are replaced with *.
|
|
2104
2106
|
*
|
|
2105
2107
|
*/
|
|
2106
|
-
|
|
2107
|
-
data?:
|
|
2108
|
-
},
|
|
2108
|
+
declare const anonymizeOrders: <ThrowOnError extends boolean = false>(options?: Options<AnonymizeOrdersData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<ResponseData & {
|
|
2109
|
+
data?: OrderResponse;
|
|
2110
|
+
}, ResponseError, ThrowOnError>;
|
|
2109
2111
|
/**
|
|
2110
2112
|
* Payment Setup
|
|
2111
2113
|
* 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).
|
|
@@ -2130,9 +2132,9 @@ export declare const anonymizeOrders: <ThrowOnError extends boolean = false>(opt
|
|
|
2130
2132
|
* :::
|
|
2131
2133
|
*
|
|
2132
2134
|
*/
|
|
2133
|
-
|
|
2134
|
-
data?:
|
|
2135
|
-
},
|
|
2135
|
+
declare const paymentSetup: <ThrowOnError extends boolean = false>(options: Options<PaymentSetupData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<ResponseData & {
|
|
2136
|
+
data?: TransactionResponse;
|
|
2137
|
+
}, ResponseError, ThrowOnError>;
|
|
2136
2138
|
/**
|
|
2137
2139
|
* Confirm Payment
|
|
2138
2140
|
* 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.
|
|
@@ -2142,16 +2144,16 @@ export declare const paymentSetup: <ThrowOnError extends boolean = false>(option
|
|
|
2142
2144
|
* 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.
|
|
2143
2145
|
*
|
|
2144
2146
|
*/
|
|
2145
|
-
|
|
2146
|
-
data?:
|
|
2147
|
-
},
|
|
2147
|
+
declare const confirmPayment: <ThrowOnError extends boolean = false>(options: Options<ConfirmPaymentData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<ResponseData & {
|
|
2148
|
+
data?: TransactionResponse;
|
|
2149
|
+
}, ResponseError, ThrowOnError>;
|
|
2148
2150
|
/**
|
|
2149
2151
|
* Capture a Transaction
|
|
2150
2152
|
* 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.
|
|
2151
2153
|
*/
|
|
2152
|
-
|
|
2153
|
-
data?:
|
|
2154
|
-
},
|
|
2154
|
+
declare const captureATransaction: <ThrowOnError extends boolean = false>(options: Options<CaptureATransactionData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<ResponseData & {
|
|
2155
|
+
data?: TransactionResponse;
|
|
2156
|
+
}, ResponseError, ThrowOnError>;
|
|
2155
2157
|
/**
|
|
2156
2158
|
* Refund a Transaction
|
|
2157
2159
|
* There are two ways to refund; through your payment gateway and mark it refunded in Commerce Manager, or directly through Commerce Manager or API.
|
|
@@ -2166,23 +2168,23 @@ export declare const captureATransaction: <ThrowOnError extends boolean = false>
|
|
|
2166
2168
|
* :::
|
|
2167
2169
|
*
|
|
2168
2170
|
*/
|
|
2169
|
-
|
|
2170
|
-
data?:
|
|
2171
|
-
},
|
|
2171
|
+
declare const refundATransaction: <ThrowOnError extends boolean = false>(options: Options<RefundATransactionData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<ResponseData & {
|
|
2172
|
+
data?: TransactionResponse;
|
|
2173
|
+
}, ResponseError, ThrowOnError>;
|
|
2172
2174
|
/**
|
|
2173
2175
|
* Get Order Transactions
|
|
2174
2176
|
* Get order transactions
|
|
2175
2177
|
*/
|
|
2176
|
-
|
|
2177
|
-
data?: Array<
|
|
2178
|
-
},
|
|
2178
|
+
declare const getOrderTransactions: <ThrowOnError extends boolean = false>(options: Options<GetOrderTransactionsData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<ResponseData & {
|
|
2179
|
+
data?: Array<TransactionResponse>;
|
|
2180
|
+
}, ResponseError, ThrowOnError>;
|
|
2179
2181
|
/**
|
|
2180
2182
|
* Get a Transaction
|
|
2181
2183
|
* Retrieves a transaction
|
|
2182
2184
|
*/
|
|
2183
|
-
|
|
2184
|
-
data?:
|
|
2185
|
-
},
|
|
2185
|
+
declare const getATransaction: <ThrowOnError extends boolean = false>(options: Options<GetATransactionData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<ResponseData & {
|
|
2186
|
+
data?: TransactionResponse;
|
|
2187
|
+
}, ResponseError, ThrowOnError>;
|
|
2186
2188
|
/**
|
|
2187
2189
|
* Cancel a Transaction
|
|
2188
2190
|
* 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.
|
|
@@ -2194,21 +2196,21 @@ export declare const getATransaction: <ThrowOnError extends boolean = false>(opt
|
|
|
2194
2196
|
* :::
|
|
2195
2197
|
*
|
|
2196
2198
|
*/
|
|
2197
|
-
|
|
2198
|
-
data?:
|
|
2199
|
-
},
|
|
2199
|
+
declare const cancelATransaction: <ThrowOnError extends boolean = false>(options: Options<CancelATransactionData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<ResponseData & {
|
|
2200
|
+
data?: TransactionResponse;
|
|
2201
|
+
}, ResponseError, ThrowOnError>;
|
|
2200
2202
|
/**
|
|
2201
2203
|
* Get product
|
|
2202
2204
|
*/
|
|
2203
|
-
|
|
2204
|
-
data?:
|
|
2205
|
-
},
|
|
2205
|
+
declare const getSubscriptionProduct: <ThrowOnError extends boolean = false>(options: Options<GetSubscriptionProductData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<{
|
|
2206
|
+
data?: Product2;
|
|
2207
|
+
}, SubscriptionsErrorResponse, ThrowOnError>;
|
|
2206
2208
|
/**
|
|
2207
2209
|
* Get plan
|
|
2208
2210
|
*/
|
|
2209
|
-
|
|
2210
|
-
data?:
|
|
2211
|
-
},
|
|
2211
|
+
declare const getPlan: <ThrowOnError extends boolean = false>(options: Options<GetPlanData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<{
|
|
2212
|
+
data?: Plan;
|
|
2213
|
+
}, SubscriptionsErrorResponse, ThrowOnError>;
|
|
2212
2214
|
/**
|
|
2213
2215
|
* List offerings
|
|
2214
2216
|
* Retrieves a list of all subscription offerings.
|
|
@@ -2225,39 +2227,39 @@ export declare const getPlan: <ThrowOnError extends boolean = false>(options: Op
|
|
|
2225
2227
|
* | `in` | `products.external_ref` | In. Checks if the values are included in the specified string. If they are, the condition is true. |
|
|
2226
2228
|
*
|
|
2227
2229
|
*/
|
|
2228
|
-
|
|
2229
|
-
data?: Array<
|
|
2230
|
-
included?:
|
|
2231
|
-
links?:
|
|
2232
|
-
},
|
|
2230
|
+
declare const listOfferings: <ThrowOnError extends boolean = false>(options?: Options<ListOfferingsData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<{
|
|
2231
|
+
data?: Array<Offering>;
|
|
2232
|
+
included?: OfferingIncludes;
|
|
2233
|
+
links?: Links2;
|
|
2234
|
+
}, SubscriptionsErrorResponse, ThrowOnError>;
|
|
2233
2235
|
/**
|
|
2234
2236
|
* Get offering
|
|
2235
2237
|
*/
|
|
2236
|
-
|
|
2237
|
-
data?:
|
|
2238
|
-
included?:
|
|
2239
|
-
},
|
|
2238
|
+
declare const getOffering: <ThrowOnError extends boolean = false>(options: Options<GetOfferingData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<{
|
|
2239
|
+
data?: Offering;
|
|
2240
|
+
included?: OfferingIncludes;
|
|
2241
|
+
}, SubscriptionsErrorResponse, ThrowOnError>;
|
|
2240
2242
|
/**
|
|
2241
2243
|
* List an offering's plans
|
|
2242
2244
|
*/
|
|
2243
|
-
|
|
2244
|
-
data?: Array<
|
|
2245
|
-
links?:
|
|
2246
|
-
},
|
|
2245
|
+
declare const listOfferingPlans: <ThrowOnError extends boolean = false>(options: Options<ListOfferingPlansData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<{
|
|
2246
|
+
data?: Array<OfferingPlan>;
|
|
2247
|
+
links?: Links2;
|
|
2248
|
+
}, SubscriptionsErrorResponse, ThrowOnError>;
|
|
2247
2249
|
/**
|
|
2248
2250
|
* List an offering's features
|
|
2249
2251
|
*/
|
|
2250
|
-
|
|
2251
|
-
data?: Array<
|
|
2252
|
-
links?:
|
|
2253
|
-
},
|
|
2252
|
+
declare const listOfferingFeatures: <ThrowOnError extends boolean = false>(options: Options<ListOfferingFeaturesData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<{
|
|
2253
|
+
data?: Array<OfferingFeature>;
|
|
2254
|
+
links?: Links2;
|
|
2255
|
+
}, SubscriptionsErrorResponse, ThrowOnError>;
|
|
2254
2256
|
/**
|
|
2255
2257
|
* List an offering's products
|
|
2256
2258
|
*/
|
|
2257
|
-
|
|
2258
|
-
data?: Array<
|
|
2259
|
-
links?:
|
|
2260
|
-
},
|
|
2259
|
+
declare const listOfferingProducts: <ThrowOnError extends boolean = false>(options: Options<ListOfferingProductsData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<{
|
|
2260
|
+
data?: Array<OfferingProduct>;
|
|
2261
|
+
links?: Links2;
|
|
2262
|
+
}, SubscriptionsErrorResponse, ThrowOnError>;
|
|
2261
2263
|
/**
|
|
2262
2264
|
* List subscriptions
|
|
2263
2265
|
* Retrieves a list of all subscriptions.
|
|
@@ -2285,74 +2287,74 @@ export declare const listOfferingProducts: <ThrowOnError extends boolean = false
|
|
|
2285
2287
|
* See [Characteristics of Include Parameter](/guides/Getting-Started/includes#characteristics-of-include-parameter).
|
|
2286
2288
|
*
|
|
2287
2289
|
*/
|
|
2288
|
-
|
|
2289
|
-
data?: Array<
|
|
2290
|
-
included?:
|
|
2291
|
-
links?:
|
|
2292
|
-
},
|
|
2290
|
+
declare const listSubscriptions: <ThrowOnError extends boolean = false>(options?: Options<ListSubscriptionsData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<{
|
|
2291
|
+
data?: Array<Subscription>;
|
|
2292
|
+
included?: SubscriptionIncludes;
|
|
2293
|
+
links?: Links2;
|
|
2294
|
+
}, SubscriptionsErrorResponse, ThrowOnError>;
|
|
2293
2295
|
/**
|
|
2294
2296
|
* Get subscription
|
|
2295
2297
|
*/
|
|
2296
|
-
|
|
2297
|
-
data?:
|
|
2298
|
-
included?:
|
|
2299
|
-
},
|
|
2298
|
+
declare const getSubscription: <ThrowOnError extends boolean = false>(options: Options<GetSubscriptionData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<{
|
|
2299
|
+
data?: Subscription;
|
|
2300
|
+
included?: SubscriptionIncludes;
|
|
2301
|
+
}, SubscriptionsErrorResponse, ThrowOnError>;
|
|
2300
2302
|
/**
|
|
2301
2303
|
* List subscription products
|
|
2302
2304
|
* Retrieves a list of products associated with the specified subscription.
|
|
2303
2305
|
*/
|
|
2304
|
-
|
|
2305
|
-
data?: Array<
|
|
2306
|
-
},
|
|
2306
|
+
declare const listSubscriptionProducts: <ThrowOnError extends boolean = false>(options: Options<ListSubscriptionProductsData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<{
|
|
2307
|
+
data?: Array<OfferingProduct>;
|
|
2308
|
+
}, SubscriptionsErrorResponse, ThrowOnError>;
|
|
2307
2309
|
/**
|
|
2308
2310
|
* List subscription plans
|
|
2309
2311
|
* 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.
|
|
2310
2312
|
*/
|
|
2311
|
-
|
|
2312
|
-
data?: Array<
|
|
2313
|
-
},
|
|
2313
|
+
declare const listSubscriptionPlans: <ThrowOnError extends boolean = false>(options: Options<ListSubscriptionPlansData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<{
|
|
2314
|
+
data?: Array<OfferingPlan>;
|
|
2315
|
+
}, SubscriptionsErrorResponse, ThrowOnError>;
|
|
2314
2316
|
/**
|
|
2315
2317
|
* List subscription states
|
|
2316
2318
|
*/
|
|
2317
|
-
|
|
2318
|
-
data?: Array<
|
|
2319
|
-
},
|
|
2319
|
+
declare const listSubscriptionStates: <ThrowOnError extends boolean = false>(options: Options<ListSubscriptionStatesData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<{
|
|
2320
|
+
data?: Array<SubscriptionState>;
|
|
2321
|
+
}, SubscriptionsErrorResponse, ThrowOnError>;
|
|
2320
2322
|
/**
|
|
2321
2323
|
* Get subscription state
|
|
2322
2324
|
*/
|
|
2323
|
-
|
|
2324
|
-
data?:
|
|
2325
|
-
},
|
|
2325
|
+
declare const getSubscriptionState: <ThrowOnError extends boolean = false>(options: Options<GetSubscriptionStateData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<{
|
|
2326
|
+
data?: SubscriptionState;
|
|
2327
|
+
}, SubscriptionsErrorResponse, ThrowOnError>;
|
|
2326
2328
|
/**
|
|
2327
2329
|
* List subscription invoices
|
|
2328
2330
|
* Lists all invoices for a given subscription.
|
|
2329
2331
|
*/
|
|
2330
|
-
|
|
2331
|
-
data?: Array<
|
|
2332
|
-
links?:
|
|
2333
|
-
},
|
|
2332
|
+
declare const listSubscriptionInvoices: <ThrowOnError extends boolean = false>(options: Options<ListSubscriptionInvoicesData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<{
|
|
2333
|
+
data?: Array<SubscriptionInvoice>;
|
|
2334
|
+
links?: Links2;
|
|
2335
|
+
}, SubscriptionsErrorResponse, ThrowOnError>;
|
|
2334
2336
|
/**
|
|
2335
2337
|
* List subscription invoice payments
|
|
2336
2338
|
* Lists all invoice payments for a given invoice.
|
|
2337
2339
|
*/
|
|
2338
|
-
|
|
2339
|
-
data?: Array<
|
|
2340
|
-
links?:
|
|
2340
|
+
declare const listSubscriptionInvoicePayments: <ThrowOnError extends boolean = false>(options: Options<ListSubscriptionInvoicePaymentsData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<{
|
|
2341
|
+
data?: Array<SubscriptionInvoicePayment>;
|
|
2342
|
+
links?: Links2;
|
|
2341
2343
|
}, unknown, ThrowOnError>;
|
|
2342
2344
|
/**
|
|
2343
2345
|
* Get subscription invoice payment
|
|
2344
2346
|
* Gets a specific payment for a given invoice.
|
|
2345
2347
|
*/
|
|
2346
|
-
|
|
2347
|
-
data?:
|
|
2348
|
-
},
|
|
2348
|
+
declare const getSubscriptionInvoicePayment: <ThrowOnError extends boolean = false>(options: Options<GetSubscriptionInvoicePaymentData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<{
|
|
2349
|
+
data?: SubscriptionInvoicePayment;
|
|
2350
|
+
}, SubscriptionsErrorResponse, ThrowOnError>;
|
|
2349
2351
|
/**
|
|
2350
2352
|
* Get subscription invoice
|
|
2351
2353
|
* Gets a specific invoice for a given subscription.
|
|
2352
2354
|
*/
|
|
2353
|
-
|
|
2354
|
-
data?:
|
|
2355
|
-
},
|
|
2355
|
+
declare const getSubscriptionInvoice: <ThrowOnError extends boolean = false>(options: Options<GetSubscriptionInvoiceData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<{
|
|
2356
|
+
data?: SubscriptionInvoice;
|
|
2357
|
+
}, SubscriptionsErrorResponse, ThrowOnError>;
|
|
2356
2358
|
/**
|
|
2357
2359
|
* List invoices
|
|
2358
2360
|
* Retrieves a list of all invoices.
|
|
@@ -2368,37 +2370,37 @@ export declare const getSubscriptionInvoice: <ThrowOnError extends boolean = fal
|
|
|
2368
2370
|
* | `eq` | `subscriber_id`, `subscription_id`, `outstanding`, `tax_required` | Equals. Checks if the values of two operands are equal. If they are, the condition is true. |
|
|
2369
2371
|
*
|
|
2370
2372
|
*/
|
|
2371
|
-
|
|
2372
|
-
data?: Array<
|
|
2373
|
-
links?:
|
|
2374
|
-
},
|
|
2373
|
+
declare const listInvoices: <ThrowOnError extends boolean = false>(options?: Options<ListInvoicesData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<{
|
|
2374
|
+
data?: Array<SubscriptionInvoice>;
|
|
2375
|
+
links?: Links2;
|
|
2376
|
+
}, SubscriptionsErrorResponse, ThrowOnError>;
|
|
2375
2377
|
/**
|
|
2376
2378
|
* Get invoice
|
|
2377
2379
|
*/
|
|
2378
|
-
|
|
2379
|
-
data?:
|
|
2380
|
-
},
|
|
2380
|
+
declare const getInvoice: <ThrowOnError extends boolean = false>(options: Options<GetInvoiceData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<{
|
|
2381
|
+
data?: SubscriptionInvoice;
|
|
2382
|
+
}, SubscriptionsErrorResponse, ThrowOnError>;
|
|
2381
2383
|
/**
|
|
2382
2384
|
* Get feature
|
|
2383
2385
|
*/
|
|
2384
|
-
|
|
2385
|
-
data?:
|
|
2386
|
-
},
|
|
2386
|
+
declare const getFeature: <ThrowOnError extends boolean = false>(options: Options<GetFeatureData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<{
|
|
2387
|
+
data?: Feature;
|
|
2388
|
+
}, SubscriptionsErrorResponse, ThrowOnError>;
|
|
2387
2389
|
/**
|
|
2388
2390
|
* Get Stock for Product
|
|
2389
2391
|
* Gets the stock for the product matching the specified unique identifier.
|
|
2390
2392
|
*/
|
|
2391
|
-
|
|
2392
|
-
data:
|
|
2393
|
-
},
|
|
2393
|
+
declare const getStock: <ThrowOnError extends boolean = false>(options: Options<GetStockData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<{
|
|
2394
|
+
data: StockResponse;
|
|
2395
|
+
}, InventoriesErrorResponse, ThrowOnError>;
|
|
2394
2396
|
/**
|
|
2395
2397
|
* List Locations
|
|
2396
2398
|
* Lists all Inventory Locations
|
|
2397
2399
|
*/
|
|
2398
|
-
|
|
2399
|
-
data?: Array<
|
|
2400
|
-
links?:
|
|
2401
|
-
},
|
|
2400
|
+
declare const listLocations: <ThrowOnError extends boolean = false>(options?: Options<ListLocationsData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<{
|
|
2401
|
+
data?: Array<Location>;
|
|
2402
|
+
links?: Links2;
|
|
2403
|
+
}, InventoriesErrorResponse, ThrowOnError>;
|
|
2402
2404
|
/**
|
|
2403
2405
|
* Create an Access Token
|
|
2404
2406
|
*
|
|
@@ -2422,40 +2424,40 @@ export declare const listLocations: <ThrowOnError extends boolean = false>(optio
|
|
|
2422
2424
|
* :::
|
|
2423
2425
|
*
|
|
2424
2426
|
*/
|
|
2425
|
-
|
|
2427
|
+
declare const createAnAccessToken: <ThrowOnError extends boolean = false>(options?: Options<CreateAnAccessTokenData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<AccessTokenResponse, ErrorResponse2, ThrowOnError>;
|
|
2426
2428
|
/**
|
|
2427
2429
|
* Get Account Addresses
|
|
2428
2430
|
* Get Account Addresses
|
|
2429
2431
|
*/
|
|
2430
|
-
|
|
2431
|
-
data?: Array<
|
|
2432
|
-
},
|
|
2432
|
+
declare const getV2AccountAddresses: <ThrowOnError extends boolean = false>(options: Options<GetV2AccountAddressesData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<{
|
|
2433
|
+
data?: Array<AccountAddressResponse>;
|
|
2434
|
+
}, AccountAddressesErrorResponse, ThrowOnError>;
|
|
2433
2435
|
/**
|
|
2434
2436
|
* Create an Account Address
|
|
2435
2437
|
* Create an Account Address
|
|
2436
2438
|
*/
|
|
2437
|
-
|
|
2438
|
-
data?:
|
|
2439
|
-
},
|
|
2439
|
+
declare const postV2AccountAddress: <ThrowOnError extends boolean = false>(options: Options<PostV2AccountAddressData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<{
|
|
2440
|
+
data?: AccountAddressResponse;
|
|
2441
|
+
}, AccountAddressesErrorResponse, ThrowOnError>;
|
|
2440
2442
|
/**
|
|
2441
2443
|
* Delete an Account Address
|
|
2442
2444
|
* Delete a specific account within a store
|
|
2443
2445
|
*/
|
|
2444
|
-
|
|
2446
|
+
declare const deleteV2AccountAddress: <ThrowOnError extends boolean = false>(options: Options<DeleteV2AccountAddressData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<void, AccountAddressesErrorResponse, ThrowOnError>;
|
|
2445
2447
|
/**
|
|
2446
2448
|
* Get an Account Address
|
|
2447
2449
|
* Get an Account Addresses
|
|
2448
2450
|
*/
|
|
2449
|
-
|
|
2450
|
-
data?:
|
|
2451
|
-
},
|
|
2451
|
+
declare const getV2AccountAddress: <ThrowOnError extends boolean = false>(options: Options<GetV2AccountAddressData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<{
|
|
2452
|
+
data?: AccountAddressResponse;
|
|
2453
|
+
}, AccountAddressesErrorResponse, ThrowOnError>;
|
|
2452
2454
|
/**
|
|
2453
2455
|
* Update an Account Address
|
|
2454
2456
|
* Update an Account Address
|
|
2455
2457
|
*/
|
|
2456
|
-
|
|
2457
|
-
data?:
|
|
2458
|
-
},
|
|
2458
|
+
declare const putV2AccountAddress: <ThrowOnError extends boolean = false>(options: Options<PutV2AccountAddressData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<{
|
|
2459
|
+
data?: AccountAddressResponse;
|
|
2460
|
+
}, AccountAddressesErrorResponse, ThrowOnError>;
|
|
2459
2461
|
/**
|
|
2460
2462
|
* Get All Accounts
|
|
2461
2463
|
* Use this endpoint to Get all accounts.
|
|
@@ -2476,9 +2478,9 @@ export declare const putV2AccountAddress: <ThrowOnError extends boolean = false>
|
|
|
2476
2478
|
* | `created_at` | `string` | <ul><li>`eq`</li><li>`ge`</li><li>`gt`</li><li>`le`</li><li>`lt`</li></ul> | `gt(created_at,"2021-06-02T18:44:07.617Z")` |
|
|
2477
2479
|
* | `updated_at` | `string` | <ul><li>`eq`</li><li>`ge`</li><li>`gt`</li><li>`le`</li><li>`lt`</li></ul> | `ge(updated_at,"2021-06-07T18:24:48.149Z")` |
|
|
2478
2480
|
*/
|
|
2479
|
-
|
|
2480
|
-
data?: Array<
|
|
2481
|
-
meta?:
|
|
2481
|
+
declare const getV2Accounts: <ThrowOnError extends boolean = false>(options?: Options<GetV2AccountsData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<{
|
|
2482
|
+
data?: Array<AccountResponse>;
|
|
2483
|
+
meta?: MetaList;
|
|
2482
2484
|
links?: {
|
|
2483
2485
|
current?: string;
|
|
2484
2486
|
first?: string;
|
|
@@ -2486,26 +2488,26 @@ export declare const getV2Accounts: <ThrowOnError extends boolean = false>(optio
|
|
|
2486
2488
|
next?: string;
|
|
2487
2489
|
prev?: string;
|
|
2488
2490
|
};
|
|
2489
|
-
},
|
|
2491
|
+
}, AccountManagementErrorResponse, ThrowOnError>;
|
|
2490
2492
|
/**
|
|
2491
2493
|
* Create an Account
|
|
2492
2494
|
* With the account creation endpoint, you have the ability to create accounts which can optionally have another account as a parent.
|
|
2493
2495
|
*/
|
|
2494
|
-
|
|
2495
|
-
data?:
|
|
2496
|
-
},
|
|
2496
|
+
declare const postV2Accounts: <ThrowOnError extends boolean = false>(options?: Options<PostV2AccountsData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<{
|
|
2497
|
+
data?: AccountResponse;
|
|
2498
|
+
}, AccountManagementErrorResponse, ThrowOnError>;
|
|
2497
2499
|
/**
|
|
2498
2500
|
* Get an Account
|
|
2499
2501
|
* View a specific account contained within your store
|
|
2500
2502
|
*/
|
|
2501
|
-
|
|
2502
|
-
data?:
|
|
2503
|
-
},
|
|
2503
|
+
declare const getV2AccountsAccountId: <ThrowOnError extends boolean = false>(options: Options<GetV2AccountsAccountIdData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<{
|
|
2504
|
+
data?: AccountResponse;
|
|
2505
|
+
}, AccountManagementErrorResponse, ThrowOnError>;
|
|
2504
2506
|
/**
|
|
2505
2507
|
* Update an Account
|
|
2506
2508
|
* Update the information contained on an account.
|
|
2507
2509
|
*/
|
|
2508
|
-
|
|
2510
|
+
declare const putV2AccountsAccountId: <ThrowOnError extends boolean = false>(options: Options<PutV2AccountsAccountIdData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<{
|
|
2509
2511
|
data?: {
|
|
2510
2512
|
id?: string;
|
|
2511
2513
|
type?: string;
|
|
@@ -2538,9 +2540,9 @@ export declare const putV2AccountsAccountId: <ThrowOnError extends boolean = fal
|
|
|
2538
2540
|
* | `name` | `string` | `eq` / `like` | `like(name,*swan*)` |
|
|
2539
2541
|
*
|
|
2540
2542
|
*/
|
|
2541
|
-
|
|
2542
|
-
data?: Array<
|
|
2543
|
-
meta?:
|
|
2543
|
+
declare const getV2AccountMembers: <ThrowOnError extends boolean = false>(options?: Options<GetV2AccountMembersData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<{
|
|
2544
|
+
data?: Array<AccountMemberResponse>;
|
|
2545
|
+
meta?: MetaList;
|
|
2544
2546
|
links?: {
|
|
2545
2547
|
current?: string;
|
|
2546
2548
|
first?: string;
|
|
@@ -2548,14 +2550,14 @@ export declare const getV2AccountMembers: <ThrowOnError extends boolean = false>
|
|
|
2548
2550
|
next?: string;
|
|
2549
2551
|
prev?: string;
|
|
2550
2552
|
};
|
|
2551
|
-
},
|
|
2553
|
+
}, AccountManagementErrorResponse, ThrowOnError>;
|
|
2552
2554
|
/**
|
|
2553
2555
|
* Get an Account Member
|
|
2554
2556
|
* Get an account member from your store
|
|
2555
2557
|
*/
|
|
2556
|
-
|
|
2557
|
-
data?:
|
|
2558
|
-
},
|
|
2558
|
+
declare const getV2AccountMembersAccountMemberId: <ThrowOnError extends boolean = false>(options: Options<GetV2AccountMembersAccountMemberIdData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<{
|
|
2559
|
+
data?: AccountMemberResponse;
|
|
2560
|
+
}, AccountManagementErrorResponse, ThrowOnError>;
|
|
2559
2561
|
/**
|
|
2560
2562
|
* Get all Account Memberships
|
|
2561
2563
|
* You can also use `include=account_member` to retrieve details about the account members associated with the account memberships. With this option, you can get more information about the account members such as name and email in a single request. For more information see [including resources](/guides/Getting-Started/includes).
|
|
@@ -2573,9 +2575,9 @@ export declare const getV2AccountMembersAccountMemberId: <ThrowOnError extends b
|
|
|
2573
2575
|
* | :--- | :--- | :--- | :--- |
|
|
2574
2576
|
* | `account_member_id` | `string` | `eq` / `like` | `eq(account_member_id,00000000-0000-1000-8000-0000000)` |
|
|
2575
2577
|
*/
|
|
2576
|
-
|
|
2577
|
-
data?: Array<
|
|
2578
|
-
meta?:
|
|
2578
|
+
declare const getV2AccountsAccountIdAccountMemberships: <ThrowOnError extends boolean = false>(options: Options<GetV2AccountsAccountIdAccountMembershipsData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<{
|
|
2579
|
+
data?: Array<AccountMembershipResponse>;
|
|
2580
|
+
meta?: MetaList;
|
|
2579
2581
|
links?: {
|
|
2580
2582
|
current?: string;
|
|
2581
2583
|
first?: string;
|
|
@@ -2583,7 +2585,7 @@ export declare const getV2AccountsAccountIdAccountMemberships: <ThrowOnError ext
|
|
|
2583
2585
|
next?: string;
|
|
2584
2586
|
prev?: string;
|
|
2585
2587
|
};
|
|
2586
|
-
},
|
|
2588
|
+
}, AccountManagementErrorResponse, ThrowOnError>;
|
|
2587
2589
|
/**
|
|
2588
2590
|
* Generate an Account Management Authentication Token
|
|
2589
2591
|
* Commerce provides authentication tokens for anyone using the Account Management APIs, including accounts and account members.
|
|
@@ -2601,10 +2603,10 @@ export declare const getV2AccountsAccountIdAccountMemberships: <ThrowOnError ext
|
|
|
2601
2603
|
* - Switch account token
|
|
2602
2604
|
*
|
|
2603
2605
|
*/
|
|
2604
|
-
|
|
2605
|
-
data?: Array<
|
|
2606
|
-
meta?:
|
|
2607
|
-
account_member_id?:
|
|
2606
|
+
declare const postV2AccountMembersTokens: <ThrowOnError extends boolean = false>(options?: Options<PostV2AccountMembersTokensData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<{
|
|
2607
|
+
data?: Array<AccountManagementAuthenticationTokenResponse>;
|
|
2608
|
+
meta?: MetaList & {
|
|
2609
|
+
account_member_id?: MetaAccountMemberId;
|
|
2608
2610
|
};
|
|
2609
2611
|
links?: {
|
|
2610
2612
|
current?: string;
|
|
@@ -2613,7 +2615,7 @@ export declare const postV2AccountMembersTokens: <ThrowOnError extends boolean =
|
|
|
2613
2615
|
next?: string;
|
|
2614
2616
|
prev?: string;
|
|
2615
2617
|
};
|
|
2616
|
-
},
|
|
2618
|
+
}, AccountManagementErrorResponse, ThrowOnError>;
|
|
2617
2619
|
/**
|
|
2618
2620
|
* Get all Currencies
|
|
2619
2621
|
* :::caution
|
|
@@ -2623,9 +2625,9 @@ export declare const postV2AccountMembersTokens: <ThrowOnError extends boolean =
|
|
|
2623
2625
|
* :::
|
|
2624
2626
|
*
|
|
2625
2627
|
*/
|
|
2626
|
-
|
|
2627
|
-
data?: Array<
|
|
2628
|
-
},
|
|
2628
|
+
declare const getAllCurrencies: <ThrowOnError extends boolean = false>(options?: Options<GetAllCurrenciesData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<ResponseData & {
|
|
2629
|
+
data?: Array<ResponseCurrency>;
|
|
2630
|
+
}, ResponseError, ThrowOnError>;
|
|
2629
2631
|
/**
|
|
2630
2632
|
* Get a Currency
|
|
2631
2633
|
* :::caution
|
|
@@ -2635,9 +2637,9 @@ export declare const getAllCurrencies: <ThrowOnError extends boolean = false>(op
|
|
|
2635
2637
|
* :::
|
|
2636
2638
|
*
|
|
2637
2639
|
*/
|
|
2638
|
-
|
|
2639
|
-
data?: Array<
|
|
2640
|
-
},
|
|
2640
|
+
declare const getACurrency: <ThrowOnError extends boolean = false>(options: Options<GetACurrencyData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<ResponseData & {
|
|
2641
|
+
data?: Array<ResponseCurrency>;
|
|
2642
|
+
}, ResponseError, ThrowOnError>;
|
|
2641
2643
|
/**
|
|
2642
2644
|
* Get all Files
|
|
2643
2645
|
* Retrieves all files.
|
|
@@ -2656,15 +2658,17 @@ export declare const getACurrency: <ThrowOnError extends boolean = false>(option
|
|
|
2656
2658
|
* | `file_size` | `integer` | `gt` / `ge` / `lt` / `le` | `le(file_size,20953)` |
|
|
2657
2659
|
*
|
|
2658
2660
|
*/
|
|
2659
|
-
|
|
2660
|
-
data?: Array<
|
|
2661
|
-
meta?:
|
|
2662
|
-
links?:
|
|
2663
|
-
},
|
|
2661
|
+
declare const getAllFiles: <ThrowOnError extends boolean = false>(options?: Options<GetAllFilesData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<{
|
|
2662
|
+
data?: Array<File>;
|
|
2663
|
+
meta?: ResultsMeta;
|
|
2664
|
+
links?: ResultsLinks;
|
|
2665
|
+
}, FilesErrorResponse, ThrowOnError>;
|
|
2664
2666
|
/**
|
|
2665
2667
|
* Get a File
|
|
2666
2668
|
* Get a File
|
|
2667
2669
|
*/
|
|
2668
|
-
|
|
2669
|
-
data?:
|
|
2670
|
-
},
|
|
2670
|
+
declare const getAFile: <ThrowOnError extends boolean = false>(options: Options<GetAFileData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<{
|
|
2671
|
+
data?: File;
|
|
2672
|
+
}, FilesErrorResponse, ThrowOnError>;
|
|
2673
|
+
|
|
2674
|
+
export { addCustomDiscountToCartItem, addTaxItemToCart, anonymizeOrders, bulkAddCustomDiscountsToCart, bulkAddTaxItemsToCart, bulkDeleteCustomDiscountsFromCart, bulkDeleteTaxItemsFromCart, bulkUpdateItemsInCart, cancelATransaction, captureATransaction, checkoutApi, client, configureByContextProduct, confirmPayment, createACart, createAccountCartAssociation, createAnAccessToken, createCartPaymentIntent, createCatalog, createCustomerCartAssociation, 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, updateRule };
|