@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
|
@@ -1,30 +1,13 @@
|
|
|
1
|
-
|
|
2
|
-
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p))
|
|
7
|
-
t[p] = s[p];
|
|
8
|
-
}
|
|
9
|
-
return t;
|
|
10
|
-
};
|
|
11
|
-
return __assign.apply(this, arguments);
|
|
12
|
-
};
|
|
13
|
-
import { createClient, createConfig, urlSearchParamsBodySerializer, } from "@hey-api/client-fetch";
|
|
14
|
-
export var client = createClient(createConfig());
|
|
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.cjs';
|
|
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>>;
|
|
15
6
|
/**
|
|
16
7
|
* Get the catalog release as shoppers
|
|
17
8
|
* Returns a list of all published releases of the specified catalog.
|
|
18
9
|
*/
|
|
19
|
-
|
|
20
|
-
var _a;
|
|
21
|
-
return ((_a = options === null || options === void 0 ? void 0 : options.client) !== null && _a !== void 0 ? _a : client).get(__assign(__assign({}, options), { security: [
|
|
22
|
-
{
|
|
23
|
-
scheme: "bearer",
|
|
24
|
-
type: "http",
|
|
25
|
-
},
|
|
26
|
-
], url: "/catalog" }));
|
|
27
|
-
};
|
|
10
|
+
declare const getByContextRelease: <ThrowOnError extends boolean = false>(options?: Options<GetByContextReleaseData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<ReleaseData, ErrorResponse, ThrowOnError>;
|
|
28
11
|
/**
|
|
29
12
|
* Get all Hierarchies
|
|
30
13
|
* Returns all hierarchies from a catalog.
|
|
@@ -51,15 +34,7 @@ export var getByContextRelease = function (options) {
|
|
|
51
34
|
* - It does not matter what order you specify the node Ids. The nodes are returned in the order they were last updated.
|
|
52
35
|
*
|
|
53
36
|
*/
|
|
54
|
-
|
|
55
|
-
var _a;
|
|
56
|
-
return ((_a = options === null || options === void 0 ? void 0 : options.client) !== null && _a !== void 0 ? _a : client).get(__assign(__assign({}, options), { security: [
|
|
57
|
-
{
|
|
58
|
-
scheme: "bearer",
|
|
59
|
-
type: "http",
|
|
60
|
-
},
|
|
61
|
-
], url: "/catalog/hierarchies" }));
|
|
62
|
-
};
|
|
37
|
+
declare const getByContextAllHierarchies: <ThrowOnError extends boolean = false>(options?: Options<GetByContextAllHierarchiesData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<HierarchyListData, ErrorResponse, ThrowOnError>;
|
|
63
38
|
/**
|
|
64
39
|
* Get a Hierarchy
|
|
65
40
|
* Returns a hierarchy from the catalog.
|
|
@@ -67,15 +42,7 @@ export var getByContextAllHierarchies = function (options) {
|
|
|
67
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).
|
|
68
43
|
*
|
|
69
44
|
*/
|
|
70
|
-
|
|
71
|
-
var _a;
|
|
72
|
-
return ((_a = options === null || options === void 0 ? void 0 : options.client) !== null && _a !== void 0 ? _a : client).get(__assign(__assign({}, options), { security: [
|
|
73
|
-
{
|
|
74
|
-
scheme: "bearer",
|
|
75
|
-
type: "http",
|
|
76
|
-
},
|
|
77
|
-
], url: "/catalog/hierarchies/{hierarchy_id}" }));
|
|
78
|
-
};
|
|
45
|
+
declare const getByContextHierarchy: <ThrowOnError extends boolean = false>(options: Options<GetByContextHierarchyData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<HierarchyData, ErrorResponse, ThrowOnError>;
|
|
79
46
|
/**
|
|
80
47
|
* Get a Hierarchy's Nodes
|
|
81
48
|
* Returns all the nodes for the specified hierarchy.
|
|
@@ -104,15 +71,7 @@ export var getByContextHierarchy = function (options) {
|
|
|
104
71
|
* - It does not matter what order you specify the node Ids. The nodes are returned in the order they were last updated.
|
|
105
72
|
*
|
|
106
73
|
*/
|
|
107
|
-
|
|
108
|
-
var _a;
|
|
109
|
-
return ((_a = options === null || options === void 0 ? void 0 : options.client) !== null && _a !== void 0 ? _a : client).get(__assign(__assign({}, options), { security: [
|
|
110
|
-
{
|
|
111
|
-
scheme: "bearer",
|
|
112
|
-
type: "http",
|
|
113
|
-
},
|
|
114
|
-
], url: "/catalog/hierarchies/{hierarchy_id}/nodes" }));
|
|
115
|
-
};
|
|
74
|
+
declare const getByContextHierarchyNodes: <ThrowOnError extends boolean = false>(options: Options<GetByContextHierarchyNodesData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<NodeListData, ErrorResponse, ThrowOnError>;
|
|
116
75
|
/**
|
|
117
76
|
* Get a Hierarchy's Children
|
|
118
77
|
* Returns the parent nodes for the specified hierarchy.
|
|
@@ -145,15 +104,7 @@ export var getByContextHierarchyNodes = function (options) {
|
|
|
145
104
|
* - It does not matter what order you specify the node Ids. The nodes are returned in the order they were last updated.
|
|
146
105
|
*
|
|
147
106
|
*/
|
|
148
|
-
|
|
149
|
-
var _a;
|
|
150
|
-
return ((_a = options === null || options === void 0 ? void 0 : options.client) !== null && _a !== void 0 ? _a : client).get(__assign(__assign({}, options), { security: [
|
|
151
|
-
{
|
|
152
|
-
scheme: "bearer",
|
|
153
|
-
type: "http",
|
|
154
|
-
},
|
|
155
|
-
], url: "/catalog/hierarchies/{hierarchy_id}/children" }));
|
|
156
|
-
};
|
|
107
|
+
declare const getByContextHierarchyChildNodes: <ThrowOnError extends boolean = false>(options: Options<GetByContextHierarchyChildNodesData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<NodeListData, ErrorResponse, ThrowOnError>;
|
|
157
108
|
/**
|
|
158
109
|
* Get all Nodes
|
|
159
110
|
* Returns all nodes in the catalog.
|
|
@@ -190,15 +141,7 @@ export var getByContextHierarchyChildNodes = function (options) {
|
|
|
190
141
|
* - It does not matter what order you specify the node Ids. The nodes are returned in the order they were last updated.
|
|
191
142
|
*
|
|
192
143
|
*/
|
|
193
|
-
|
|
194
|
-
var _a;
|
|
195
|
-
return ((_a = options === null || options === void 0 ? void 0 : options.client) !== null && _a !== void 0 ? _a : client).get(__assign(__assign({}, options), { security: [
|
|
196
|
-
{
|
|
197
|
-
scheme: "bearer",
|
|
198
|
-
type: "http",
|
|
199
|
-
},
|
|
200
|
-
], url: "/catalog/nodes" }));
|
|
201
|
-
};
|
|
144
|
+
declare const getByContextAllNodes: <ThrowOnError extends boolean = false>(options?: Options<GetByContextAllNodesData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<NodeListData, ErrorResponse, ThrowOnError>;
|
|
202
145
|
/**
|
|
203
146
|
* Get a Node
|
|
204
147
|
* Returns a node from the catalog.
|
|
@@ -216,15 +159,7 @@ export var getByContextAllNodes = function (options) {
|
|
|
216
159
|
* - If a curated product is removed from a node, the product is also removed from the `curated_products` list.
|
|
217
160
|
*
|
|
218
161
|
*/
|
|
219
|
-
|
|
220
|
-
var _a;
|
|
221
|
-
return ((_a = options === null || options === void 0 ? void 0 : options.client) !== null && _a !== void 0 ? _a : client).get(__assign(__assign({}, options), { security: [
|
|
222
|
-
{
|
|
223
|
-
scheme: "bearer",
|
|
224
|
-
type: "http",
|
|
225
|
-
},
|
|
226
|
-
], url: "/catalog/nodes/{node_id}" }));
|
|
227
|
-
};
|
|
162
|
+
declare const getByContextNode: <ThrowOnError extends boolean = false>(options: Options<GetByContextNodeData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<NodeData, ErrorResponse, ThrowOnError>;
|
|
228
163
|
/**
|
|
229
164
|
* Get a Node's Children
|
|
230
165
|
* Returns the child nodes for a node in the catalog.
|
|
@@ -262,15 +197,7 @@ export var getByContextNode = function (options) {
|
|
|
262
197
|
* - It does not matter what order you specify the node Ids. The nodes are returned in the order they were last updated.
|
|
263
198
|
*
|
|
264
199
|
*/
|
|
265
|
-
|
|
266
|
-
var _a;
|
|
267
|
-
return ((_a = options === null || options === void 0 ? void 0 : options.client) !== null && _a !== void 0 ? _a : client).get(__assign(__assign({}, options), { security: [
|
|
268
|
-
{
|
|
269
|
-
scheme: "bearer",
|
|
270
|
-
type: "http",
|
|
271
|
-
},
|
|
272
|
-
], url: "/catalog/nodes/{node_id}/relationships/children" }));
|
|
273
|
-
};
|
|
200
|
+
declare const getByContextChildNodes: <ThrowOnError extends boolean = false>(options: Options<GetByContextChildNodesData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<NodeListData, ErrorResponse, ThrowOnError>;
|
|
274
201
|
/**
|
|
275
202
|
* Get all Products
|
|
276
203
|
* Retrieves the list of products from the catalog. Only the products in a live status are retrieved.
|
|
@@ -316,15 +243,7 @@ export var getByContextChildNodes = function (options) {
|
|
|
316
243
|
* - It does not matter what order you specify the node Ids. The nodes are returned in the order they were last updated.
|
|
317
244
|
*
|
|
318
245
|
*/
|
|
319
|
-
|
|
320
|
-
var _a;
|
|
321
|
-
return ((_a = options === null || options === void 0 ? void 0 : options.client) !== null && _a !== void 0 ? _a : client).get(__assign(__assign({}, options), { security: [
|
|
322
|
-
{
|
|
323
|
-
scheme: "bearer",
|
|
324
|
-
type: "http",
|
|
325
|
-
},
|
|
326
|
-
], url: "/catalog/products" }));
|
|
327
|
-
};
|
|
246
|
+
declare const getByContextAllProducts: <ThrowOnError extends boolean = false>(options?: Options<GetByContextAllProductsData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<ProductListData, ErrorResponse, ThrowOnError>;
|
|
328
247
|
/**
|
|
329
248
|
* Get a Product
|
|
330
249
|
* Returns the specified product from the catalog. The product must be in the `live` status.
|
|
@@ -344,15 +263,7 @@ export var getByContextAllProducts = function (options) {
|
|
|
344
263
|
* See [**Including Resources**](/guides/Getting-Started/includes).
|
|
345
264
|
*
|
|
346
265
|
*/
|
|
347
|
-
|
|
348
|
-
var _a;
|
|
349
|
-
return ((_a = options === null || options === void 0 ? void 0 : options.client) !== null && _a !== void 0 ? _a : client).get(__assign(__assign({}, options), { security: [
|
|
350
|
-
{
|
|
351
|
-
scheme: "bearer",
|
|
352
|
-
type: "http",
|
|
353
|
-
},
|
|
354
|
-
], url: "/catalog/products/{product_id}" }));
|
|
355
|
-
};
|
|
266
|
+
declare const getByContextProduct: <ThrowOnError extends boolean = false>(options: Options<GetByContextProductData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<ProductData, ErrorResponse, ThrowOnError>;
|
|
356
267
|
/**
|
|
357
268
|
* Get a Bundle's Component Products
|
|
358
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.
|
|
@@ -362,15 +273,7 @@ export var getByContextProduct = function (options) {
|
|
|
362
273
|
* This endpoint returns a list of component product IDs for the specified bundle.
|
|
363
274
|
*
|
|
364
275
|
*/
|
|
365
|
-
|
|
366
|
-
var _a;
|
|
367
|
-
return ((_a = options === null || options === void 0 ? void 0 : options.client) !== null && _a !== void 0 ? _a : client).get(__assign(__assign({}, options), { security: [
|
|
368
|
-
{
|
|
369
|
-
scheme: "bearer",
|
|
370
|
-
type: "http",
|
|
371
|
-
},
|
|
372
|
-
], url: "/catalog/products/{product_id}/relationships/component_products" }));
|
|
373
|
-
};
|
|
276
|
+
declare const getByContextComponentProductIds: <ThrowOnError extends boolean = false>(options: Options<GetByContextComponentProductIdsData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<ProductReferenceListData, ErrorResponse, ThrowOnError>;
|
|
374
277
|
/**
|
|
375
278
|
* Get a Parent Product's Child Products
|
|
376
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.
|
|
@@ -411,15 +314,7 @@ export var getByContextComponentProductIds = function (options) {
|
|
|
411
314
|
* See [**Including Resources**](/guides/Getting-Started/includes).
|
|
412
315
|
*
|
|
413
316
|
*/
|
|
414
|
-
|
|
415
|
-
var _a;
|
|
416
|
-
return ((_a = options === null || options === void 0 ? void 0 : options.client) !== null && _a !== void 0 ? _a : client).get(__assign(__assign({}, options), { security: [
|
|
417
|
-
{
|
|
418
|
-
scheme: "bearer",
|
|
419
|
-
type: "http",
|
|
420
|
-
},
|
|
421
|
-
], url: "/catalog/products/{product_id}/relationships/children" }));
|
|
422
|
-
};
|
|
317
|
+
declare const getByContextChildProducts: <ThrowOnError extends boolean = false>(options: Options<GetByContextChildProductsData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<ProductListData, ErrorResponse, ThrowOnError>;
|
|
423
318
|
/**
|
|
424
319
|
* Get a Hierarchy's Products
|
|
425
320
|
* Returns the products associated with the specified hierarchy in the catalog. The products must be in the live status.
|
|
@@ -461,15 +356,7 @@ export var getByContextChildProducts = function (options) {
|
|
|
461
356
|
* See [**Including Resources**](/guides/Getting-Started/includes).
|
|
462
357
|
*
|
|
463
358
|
*/
|
|
464
|
-
|
|
465
|
-
var _a;
|
|
466
|
-
return ((_a = options === null || options === void 0 ? void 0 : options.client) !== null && _a !== void 0 ? _a : client).get(__assign(__assign({}, options), { security: [
|
|
467
|
-
{
|
|
468
|
-
scheme: "bearer",
|
|
469
|
-
type: "http",
|
|
470
|
-
},
|
|
471
|
-
], url: "/catalog/hierarchies/{hierarchy_id}/products" }));
|
|
472
|
-
};
|
|
359
|
+
declare const getByContextProductsForHierarchy: <ThrowOnError extends boolean = false>(options: Options<GetByContextProductsForHierarchyData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<ProductListData, ErrorResponse, ThrowOnError>;
|
|
473
360
|
/**
|
|
474
361
|
* Get a Node's Products
|
|
475
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.
|
|
@@ -510,15 +397,7 @@ export var getByContextProductsForHierarchy = function (options) {
|
|
|
510
397
|
* See [**Including Resources**](/guides/Getting-Started/includes).
|
|
511
398
|
*
|
|
512
399
|
*/
|
|
513
|
-
|
|
514
|
-
var _a;
|
|
515
|
-
return ((_a = options === null || options === void 0 ? void 0 : options.client) !== null && _a !== void 0 ? _a : client).get(__assign(__assign({}, options), { security: [
|
|
516
|
-
{
|
|
517
|
-
scheme: "bearer",
|
|
518
|
-
type: "http",
|
|
519
|
-
},
|
|
520
|
-
], url: "/catalog/nodes/{node_id}/relationships/products" }));
|
|
521
|
-
};
|
|
400
|
+
declare const getByContextProductsForNode: <ThrowOnError extends boolean = false>(options: Options<GetByContextProductsForNodeData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<ProductListData, ErrorResponse, ThrowOnError>;
|
|
522
401
|
/**
|
|
523
402
|
* Configure a Shopper Bundle
|
|
524
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.
|
|
@@ -543,15 +422,7 @@ export var getByContextProductsForNode = function (options) {
|
|
|
543
422
|
* See [**Including Resources**](/guides/Getting-Started/includes).
|
|
544
423
|
*
|
|
545
424
|
*/
|
|
546
|
-
|
|
547
|
-
var _a;
|
|
548
|
-
return ((_a = options === null || options === void 0 ? void 0 : options.client) !== null && _a !== void 0 ? _a : client).post(__assign(__assign({}, options), { headers: __assign({ "Content-Type": "application/json" }, options === null || options === void 0 ? void 0 : options.headers), security: [
|
|
549
|
-
{
|
|
550
|
-
scheme: "bearer",
|
|
551
|
-
type: "http",
|
|
552
|
-
},
|
|
553
|
-
], url: "/catalog/products/{product_id}/configure" }));
|
|
554
|
-
};
|
|
425
|
+
declare const configureByContextProduct: <ThrowOnError extends boolean = false>(options: Options<ConfigureByContextProductData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<ProductData, ErrorResponse, ThrowOnError>;
|
|
555
426
|
/**
|
|
556
427
|
* Gets all authorized catalogs
|
|
557
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.
|
|
@@ -561,15 +432,7 @@ export var configureByContextProduct = function (options) {
|
|
|
561
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.
|
|
562
433
|
*
|
|
563
434
|
*/
|
|
564
|
-
|
|
565
|
-
var _a;
|
|
566
|
-
return ((_a = options === null || options === void 0 ? void 0 : options.client) !== null && _a !== void 0 ? _a : client).get(__assign(__assign({}, options), { security: [
|
|
567
|
-
{
|
|
568
|
-
scheme: "bearer",
|
|
569
|
-
type: "http",
|
|
570
|
-
},
|
|
571
|
-
], url: "/catalogs" }));
|
|
572
|
-
};
|
|
435
|
+
declare const getCatalogs: <ThrowOnError extends boolean = false>(options?: Options<GetCatalogsData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<CatalogListData, ErrorResponse, ThrowOnError>;
|
|
573
436
|
/**
|
|
574
437
|
* Creates a new catalog
|
|
575
438
|
* Before you create a catalog, you must define the following resources:
|
|
@@ -579,67 +442,27 @@ export var getCatalogs = function (options) {
|
|
|
579
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.
|
|
580
443
|
*
|
|
581
444
|
*/
|
|
582
|
-
|
|
583
|
-
var _a;
|
|
584
|
-
return ((_a = options === null || options === void 0 ? void 0 : options.client) !== null && _a !== void 0 ? _a : client).post(__assign(__assign({}, options), { headers: __assign({ "Content-Type": "application/json" }, options === null || options === void 0 ? void 0 : options.headers), security: [
|
|
585
|
-
{
|
|
586
|
-
scheme: "bearer",
|
|
587
|
-
type: "http",
|
|
588
|
-
},
|
|
589
|
-
], url: "/catalogs" }));
|
|
590
|
-
};
|
|
445
|
+
declare const createCatalog: <ThrowOnError extends boolean = false>(options: Options<CreateCatalogData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<CatalogData, ErrorResponse, ThrowOnError>;
|
|
591
446
|
/**
|
|
592
447
|
* Deletes a catalog
|
|
593
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.
|
|
594
449
|
*/
|
|
595
|
-
|
|
596
|
-
var _a;
|
|
597
|
-
return ((_a = options === null || options === void 0 ? void 0 : options.client) !== null && _a !== void 0 ? _a : client).delete(__assign(__assign({}, options), { security: [
|
|
598
|
-
{
|
|
599
|
-
scheme: "bearer",
|
|
600
|
-
type: "http",
|
|
601
|
-
},
|
|
602
|
-
], url: "/catalogs/{catalog_id}" }));
|
|
603
|
-
};
|
|
450
|
+
declare const deleteCatalogById: <ThrowOnError extends boolean = false>(options: Options<DeleteCatalogByIdData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<void, ErrorResponse, ThrowOnError>;
|
|
604
451
|
/**
|
|
605
452
|
* Get a catalog by ID
|
|
606
453
|
* Retrieves the specified catalog.
|
|
607
454
|
*/
|
|
608
|
-
|
|
609
|
-
var _a;
|
|
610
|
-
return ((_a = options === null || options === void 0 ? void 0 : options.client) !== null && _a !== void 0 ? _a : client).get(__assign(__assign({}, options), { security: [
|
|
611
|
-
{
|
|
612
|
-
scheme: "bearer",
|
|
613
|
-
type: "http",
|
|
614
|
-
},
|
|
615
|
-
], url: "/catalogs/{catalog_id}" }));
|
|
616
|
-
};
|
|
455
|
+
declare const getCatalogById: <ThrowOnError extends boolean = false>(options: Options<GetCatalogByIdData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<CatalogData, ErrorResponse, ThrowOnError>;
|
|
617
456
|
/**
|
|
618
457
|
* Updates a catalog
|
|
619
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.
|
|
620
459
|
*/
|
|
621
|
-
|
|
622
|
-
var _a;
|
|
623
|
-
return ((_a = options === null || options === void 0 ? void 0 : options.client) !== null && _a !== void 0 ? _a : client).put(__assign(__assign({}, options), { headers: __assign({ "Content-Type": "application/json" }, options === null || options === void 0 ? void 0 : options.headers), security: [
|
|
624
|
-
{
|
|
625
|
-
scheme: "bearer",
|
|
626
|
-
type: "http",
|
|
627
|
-
},
|
|
628
|
-
], url: "/catalogs/{catalog_id}" }));
|
|
629
|
-
};
|
|
460
|
+
declare const updateCatalog: <ThrowOnError extends boolean = false>(options: Options<UpdateCatalogData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<CatalogData, ErrorResponse, ThrowOnError>;
|
|
630
461
|
/**
|
|
631
462
|
* Deletes all releases
|
|
632
463
|
* Deletes all releases of the specified published catalog.
|
|
633
464
|
*/
|
|
634
|
-
|
|
635
|
-
var _a;
|
|
636
|
-
return ((_a = options === null || options === void 0 ? void 0 : options.client) !== null && _a !== void 0 ? _a : client).delete(__assign(__assign({}, options), { security: [
|
|
637
|
-
{
|
|
638
|
-
scheme: "bearer",
|
|
639
|
-
type: "http",
|
|
640
|
-
},
|
|
641
|
-
], url: "/catalogs/{catalog_id}/releases" }));
|
|
642
|
-
};
|
|
465
|
+
declare const deleteReleases: <ThrowOnError extends boolean = false>(options: Options<DeleteReleasesData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<void, ErrorResponse, ThrowOnError>;
|
|
643
466
|
/**
|
|
644
467
|
* Gets all authorized catalog releases
|
|
645
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.
|
|
@@ -649,15 +472,7 @@ export var deleteReleases = function (options) {
|
|
|
649
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.
|
|
650
473
|
*
|
|
651
474
|
*/
|
|
652
|
-
|
|
653
|
-
var _a;
|
|
654
|
-
return ((_a = options === null || options === void 0 ? void 0 : options.client) !== null && _a !== void 0 ? _a : client).get(__assign(__assign({}, options), { security: [
|
|
655
|
-
{
|
|
656
|
-
scheme: "bearer",
|
|
657
|
-
type: "http",
|
|
658
|
-
},
|
|
659
|
-
], url: "/catalogs/{catalog_id}/releases" }));
|
|
660
|
-
};
|
|
475
|
+
declare const getReleases: <ThrowOnError extends boolean = false>(options: Options<GetReleasesData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<ReleaseListData, ErrorResponse, ThrowOnError>;
|
|
661
476
|
/**
|
|
662
477
|
* Publishes a catalog
|
|
663
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.
|
|
@@ -706,41 +521,17 @@ export var getReleases = function (options) {
|
|
|
706
521
|
* 4. Select the **Include Organization Resources in Catalog Publishes** checkbox.
|
|
707
522
|
*
|
|
708
523
|
*/
|
|
709
|
-
|
|
710
|
-
var _a;
|
|
711
|
-
return ((_a = options === null || options === void 0 ? void 0 : options.client) !== null && _a !== void 0 ? _a : client).post(__assign(__assign({}, options), { headers: __assign({ "Content-Type": "application/json" }, options === null || options === void 0 ? void 0 : options.headers), security: [
|
|
712
|
-
{
|
|
713
|
-
scheme: "bearer",
|
|
714
|
-
type: "http",
|
|
715
|
-
},
|
|
716
|
-
], url: "/catalogs/{catalog_id}/releases" }));
|
|
717
|
-
};
|
|
524
|
+
declare const publishRelease: <ThrowOnError extends boolean = false>(options: Options<PublishReleaseData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<ReleaseData, ErrorResponse, ThrowOnError>;
|
|
718
525
|
/**
|
|
719
526
|
* Deletes a release
|
|
720
527
|
* Deletes the specified published catalog release.
|
|
721
528
|
*/
|
|
722
|
-
|
|
723
|
-
var _a;
|
|
724
|
-
return ((_a = options === null || options === void 0 ? void 0 : options.client) !== null && _a !== void 0 ? _a : client).delete(__assign(__assign({}, options), { security: [
|
|
725
|
-
{
|
|
726
|
-
scheme: "bearer",
|
|
727
|
-
type: "http",
|
|
728
|
-
},
|
|
729
|
-
], url: "/catalogs/{catalog_id}/releases/{release_id}" }));
|
|
730
|
-
};
|
|
529
|
+
declare const deleteReleaseById: <ThrowOnError extends boolean = false>(options: Options<DeleteReleaseByIdData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<void, ErrorResponse, ThrowOnError>;
|
|
731
530
|
/**
|
|
732
531
|
* Get a catalog release by ID
|
|
733
532
|
* Retrieves the specified catalog release.
|
|
734
533
|
*/
|
|
735
|
-
|
|
736
|
-
var _a;
|
|
737
|
-
return ((_a = options === null || options === void 0 ? void 0 : options.client) !== null && _a !== void 0 ? _a : client).get(__assign(__assign({}, options), { security: [
|
|
738
|
-
{
|
|
739
|
-
scheme: "bearer",
|
|
740
|
-
type: "http",
|
|
741
|
-
},
|
|
742
|
-
], url: "/catalogs/{catalog_id}/releases/{release_id}" }));
|
|
743
|
-
};
|
|
534
|
+
declare const getReleaseById: <ThrowOnError extends boolean = false>(options: Options<GetReleaseByIdData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<ReleaseData, ErrorResponse, ThrowOnError>;
|
|
744
535
|
/**
|
|
745
536
|
* Gets all authorized catalog rules
|
|
746
537
|
* Retrieves all authorized catalog rules.
|
|
@@ -754,15 +545,7 @@ export var getReleaseById = function (options) {
|
|
|
754
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)` |
|
|
755
546
|
*
|
|
756
547
|
*/
|
|
757
|
-
|
|
758
|
-
var _a;
|
|
759
|
-
return ((_a = options === null || options === void 0 ? void 0 : options.client) !== null && _a !== void 0 ? _a : client).get(__assign(__assign({}, options), { security: [
|
|
760
|
-
{
|
|
761
|
-
scheme: "bearer",
|
|
762
|
-
type: "http",
|
|
763
|
-
},
|
|
764
|
-
], url: "/catalogs/rules" }));
|
|
765
|
-
};
|
|
548
|
+
declare const getRules: <ThrowOnError extends boolean = false>(options?: Options<GetRulesData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<RuleListData, ErrorResponse, ThrowOnError>;
|
|
766
549
|
/**
|
|
767
550
|
* Creates a new catalog rule
|
|
768
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.
|
|
@@ -778,52 +561,20 @@ export var getRules = function (options) {
|
|
|
778
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).
|
|
779
562
|
*
|
|
780
563
|
*/
|
|
781
|
-
|
|
782
|
-
var _a;
|
|
783
|
-
return ((_a = options === null || options === void 0 ? void 0 : options.client) !== null && _a !== void 0 ? _a : client).post(__assign(__assign({}, options), { headers: __assign({ "Content-Type": "application/json" }, options === null || options === void 0 ? void 0 : options.headers), security: [
|
|
784
|
-
{
|
|
785
|
-
scheme: "bearer",
|
|
786
|
-
type: "http",
|
|
787
|
-
},
|
|
788
|
-
], url: "/catalogs/rules" }));
|
|
789
|
-
};
|
|
564
|
+
declare const createRule: <ThrowOnError extends boolean = false>(options: Options<CreateRuleData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<RuleData, ErrorResponse, ThrowOnError>;
|
|
790
565
|
/**
|
|
791
566
|
* Deletes a catalog rule
|
|
792
567
|
*/
|
|
793
|
-
|
|
794
|
-
var _a;
|
|
795
|
-
return ((_a = options === null || options === void 0 ? void 0 : options.client) !== null && _a !== void 0 ? _a : client).delete(__assign(__assign({}, options), { security: [
|
|
796
|
-
{
|
|
797
|
-
scheme: "bearer",
|
|
798
|
-
type: "http",
|
|
799
|
-
},
|
|
800
|
-
], url: "/catalogs/rules/{catalog_rule_id}" }));
|
|
801
|
-
};
|
|
568
|
+
declare const deleteRuleById: <ThrowOnError extends boolean = false>(options: Options<DeleteRuleByIdData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<void, ErrorResponse, ThrowOnError>;
|
|
802
569
|
/**
|
|
803
570
|
* Get a catalog rule by ID
|
|
804
571
|
*/
|
|
805
|
-
|
|
806
|
-
var _a;
|
|
807
|
-
return ((_a = options === null || options === void 0 ? void 0 : options.client) !== null && _a !== void 0 ? _a : client).get(__assign(__assign({}, options), { security: [
|
|
808
|
-
{
|
|
809
|
-
scheme: "bearer",
|
|
810
|
-
type: "http",
|
|
811
|
-
},
|
|
812
|
-
], url: "/catalogs/rules/{catalog_rule_id}" }));
|
|
813
|
-
};
|
|
572
|
+
declare const getRuleById: <ThrowOnError extends boolean = false>(options: Options<GetRuleByIdData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<RuleData, ErrorResponse, ThrowOnError>;
|
|
814
573
|
/**
|
|
815
574
|
* Updates a catalog rule
|
|
816
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.
|
|
817
576
|
*/
|
|
818
|
-
|
|
819
|
-
var _a;
|
|
820
|
-
return ((_a = options === null || options === void 0 ? void 0 : options.client) !== null && _a !== void 0 ? _a : client).put(__assign(__assign({}, options), { headers: __assign({ "Content-Type": "application/json" }, options === null || options === void 0 ? void 0 : options.headers), security: [
|
|
821
|
-
{
|
|
822
|
-
scheme: "bearer",
|
|
823
|
-
type: "http",
|
|
824
|
-
},
|
|
825
|
-
], url: "/catalogs/rules/{catalog_rule_id}" }));
|
|
826
|
-
};
|
|
577
|
+
declare const updateRule: <ThrowOnError extends boolean = false>(options: Options<UpdateRuleData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<RuleData, ErrorResponse, ThrowOnError>;
|
|
827
578
|
/**
|
|
828
579
|
* Get all Hierarchies
|
|
829
580
|
* Returns the hierarchies from a published catalog.
|
|
@@ -854,15 +605,7 @@ export var updateRule = function (options) {
|
|
|
854
605
|
* - It does not matter what order you specify the node Ids. The nodes are returned in the order they were last updated.
|
|
855
606
|
*
|
|
856
607
|
*/
|
|
857
|
-
|
|
858
|
-
var _a;
|
|
859
|
-
return ((_a = options === null || options === void 0 ? void 0 : options.client) !== null && _a !== void 0 ? _a : client).get(__assign(__assign({}, options), { security: [
|
|
860
|
-
{
|
|
861
|
-
scheme: "bearer",
|
|
862
|
-
type: "http",
|
|
863
|
-
},
|
|
864
|
-
], url: "/catalogs/{catalog_id}/releases/{release_id}/hierarchies" }));
|
|
865
|
-
};
|
|
608
|
+
declare const getAllHierarchies: <ThrowOnError extends boolean = false>(options: Options<GetAllHierarchiesData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<HierarchyListData, ErrorResponse, ThrowOnError>;
|
|
866
609
|
/**
|
|
867
610
|
* Get a Hierarchy
|
|
868
611
|
* Returns the specified hierarchy from a published catalog.
|
|
@@ -874,15 +617,7 @@ export var getAllHierarchies = function (options) {
|
|
|
874
617
|
* :::
|
|
875
618
|
*
|
|
876
619
|
*/
|
|
877
|
-
|
|
878
|
-
var _a;
|
|
879
|
-
return ((_a = options === null || options === void 0 ? void 0 : options.client) !== null && _a !== void 0 ? _a : client).get(__assign(__assign({}, options), { security: [
|
|
880
|
-
{
|
|
881
|
-
scheme: "bearer",
|
|
882
|
-
type: "http",
|
|
883
|
-
},
|
|
884
|
-
], url: "/catalogs/{catalog_id}/releases/{release_id}/hierarchies/{hierarchy_id}" }));
|
|
885
|
-
};
|
|
620
|
+
declare const getHierarchy: <ThrowOnError extends boolean = false>(options: Options<GetHierarchyData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<HierarchyData, ErrorResponse, ThrowOnError>;
|
|
886
621
|
/**
|
|
887
622
|
* Get a Hierarchy's Nodes
|
|
888
623
|
* Returns all nodes for the specified hierarchy from a published catalog.
|
|
@@ -915,15 +650,7 @@ export var getHierarchy = function (options) {
|
|
|
915
650
|
* - It does not matter what order you specify the node Ids. The nodes are returned in the order they were last updated.
|
|
916
651
|
*
|
|
917
652
|
*/
|
|
918
|
-
|
|
919
|
-
var _a;
|
|
920
|
-
return ((_a = options === null || options === void 0 ? void 0 : options.client) !== null && _a !== void 0 ? _a : client).get(__assign(__assign({}, options), { security: [
|
|
921
|
-
{
|
|
922
|
-
scheme: "bearer",
|
|
923
|
-
type: "http",
|
|
924
|
-
},
|
|
925
|
-
], url: "/catalogs/{catalog_id}/releases/{release_id}/hierarchies/{hierarchy_id}/nodes" }));
|
|
926
|
-
};
|
|
653
|
+
declare const getHierarchyNodes: <ThrowOnError extends boolean = false>(options: Options<GetHierarchyNodesData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<NodeListData, ErrorResponse, ThrowOnError>;
|
|
927
654
|
/**
|
|
928
655
|
* Get a Hierarchy's Children
|
|
929
656
|
* Returns the parent nodes for the specified hierarchy from a published catalog.
|
|
@@ -958,15 +685,7 @@ export var getHierarchyNodes = function (options) {
|
|
|
958
685
|
* - It does not matter what order you specify the node Ids. The nodes are returned in the order they were last updated.
|
|
959
686
|
*
|
|
960
687
|
*/
|
|
961
|
-
|
|
962
|
-
var _a;
|
|
963
|
-
return ((_a = options === null || options === void 0 ? void 0 : options.client) !== null && _a !== void 0 ? _a : client).get(__assign(__assign({}, options), { security: [
|
|
964
|
-
{
|
|
965
|
-
scheme: "bearer",
|
|
966
|
-
type: "http",
|
|
967
|
-
},
|
|
968
|
-
], url: "/catalogs/{catalog_id}/releases/{release_id}/hierarchies/{hierarchy_id}/children" }));
|
|
969
|
-
};
|
|
688
|
+
declare const getHierarchyChildNodes: <ThrowOnError extends boolean = false>(options: Options<GetHierarchyChildNodesData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<NodeListData, ErrorResponse, ThrowOnError>;
|
|
970
689
|
/**
|
|
971
690
|
* Get all Nodes
|
|
972
691
|
* Returns the child nodes from a published catalog.
|
|
@@ -1010,15 +729,7 @@ export var getHierarchyChildNodes = function (options) {
|
|
|
1010
729
|
* - It does not matter what order you specify the node Ids. The nodes are returned in the order they were last updated.
|
|
1011
730
|
*
|
|
1012
731
|
*/
|
|
1013
|
-
|
|
1014
|
-
var _a;
|
|
1015
|
-
return ((_a = options === null || options === void 0 ? void 0 : options.client) !== null && _a !== void 0 ? _a : client).get(__assign(__assign({}, options), { security: [
|
|
1016
|
-
{
|
|
1017
|
-
scheme: "bearer",
|
|
1018
|
-
type: "http",
|
|
1019
|
-
},
|
|
1020
|
-
], url: "/catalogs/{catalog_id}/releases/{release_id}/nodes" }));
|
|
1021
|
-
};
|
|
732
|
+
declare const getAllNodes: <ThrowOnError extends boolean = false>(options: Options<GetAllNodesData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<NodeListData, ErrorResponse, ThrowOnError>;
|
|
1022
733
|
/**
|
|
1023
734
|
* Get a Node
|
|
1024
735
|
* Returns a node from a published catalog.
|
|
@@ -1040,15 +751,7 @@ export var getAllNodes = function (options) {
|
|
|
1040
751
|
* - A product that is curated has the `"curated_product": true` attribute displayed.
|
|
1041
752
|
*
|
|
1042
753
|
*/
|
|
1043
|
-
|
|
1044
|
-
var _a;
|
|
1045
|
-
return ((_a = options === null || options === void 0 ? void 0 : options.client) !== null && _a !== void 0 ? _a : client).get(__assign(__assign({}, options), { security: [
|
|
1046
|
-
{
|
|
1047
|
-
scheme: "bearer",
|
|
1048
|
-
type: "http",
|
|
1049
|
-
},
|
|
1050
|
-
], url: "/catalogs/{catalog_id}/releases/{release_id}/nodes/{node_id}" }));
|
|
1051
|
-
};
|
|
754
|
+
declare const getNode: <ThrowOnError extends boolean = false>(options: Options<GetNodeData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<NodeData, ErrorResponse, ThrowOnError>;
|
|
1052
755
|
/**
|
|
1053
756
|
* Get a Node's Children
|
|
1054
757
|
* Returns the child nodes for a node from a published catalog.
|
|
@@ -1092,15 +795,7 @@ export var getNode = function (options) {
|
|
|
1092
795
|
* - It does not matter what order you specify the node Ids. The nodes are returned in the order they were last updated.
|
|
1093
796
|
*
|
|
1094
797
|
*/
|
|
1095
|
-
|
|
1096
|
-
var _a;
|
|
1097
|
-
return ((_a = options === null || options === void 0 ? void 0 : options.client) !== null && _a !== void 0 ? _a : client).get(__assign(__assign({}, options), { security: [
|
|
1098
|
-
{
|
|
1099
|
-
scheme: "bearer",
|
|
1100
|
-
type: "http",
|
|
1101
|
-
},
|
|
1102
|
-
], url: "/catalogs/{catalog_id}/releases/{release_id}/nodes/{node_id}/relationships/children" }));
|
|
1103
|
-
};
|
|
798
|
+
declare const getChildNodes: <ThrowOnError extends boolean = false>(options: Options<GetChildNodesData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<NodeListData, ErrorResponse, ThrowOnError>;
|
|
1104
799
|
/**
|
|
1105
800
|
* Get all Products
|
|
1106
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.
|
|
@@ -1141,15 +836,7 @@ export var getChildNodes = function (options) {
|
|
|
1141
836
|
* - It does not matter what order you specify the node Ids. The nodes are returned in the order they were last updated.
|
|
1142
837
|
*
|
|
1143
838
|
*/
|
|
1144
|
-
|
|
1145
|
-
var _a;
|
|
1146
|
-
return ((_a = options === null || options === void 0 ? void 0 : options.client) !== null && _a !== void 0 ? _a : client).get(__assign(__assign({}, options), { security: [
|
|
1147
|
-
{
|
|
1148
|
-
scheme: "bearer",
|
|
1149
|
-
type: "http",
|
|
1150
|
-
},
|
|
1151
|
-
], url: "/catalogs/{catalog_id}/releases/{release_id}/products" }));
|
|
1152
|
-
};
|
|
839
|
+
declare const getAllProducts: <ThrowOnError extends boolean = false>(options: Options<GetAllProductsData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<ProductListData, ErrorResponse, ThrowOnError>;
|
|
1153
840
|
/**
|
|
1154
841
|
* Get a Product
|
|
1155
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.
|
|
@@ -1175,15 +862,7 @@ export var getAllProducts = function (options) {
|
|
|
1175
862
|
* See [**Including Resources**](/guides/Getting-Started/includes).
|
|
1176
863
|
*
|
|
1177
864
|
*/
|
|
1178
|
-
|
|
1179
|
-
var _a;
|
|
1180
|
-
return ((_a = options === null || options === void 0 ? void 0 : options.client) !== null && _a !== void 0 ? _a : client).get(__assign(__assign({}, options), { security: [
|
|
1181
|
-
{
|
|
1182
|
-
scheme: "bearer",
|
|
1183
|
-
type: "http",
|
|
1184
|
-
},
|
|
1185
|
-
], url: "/catalogs/{catalog_id}/releases/{release_id}/products/{product_id}" }));
|
|
1186
|
-
};
|
|
865
|
+
declare const getProduct: <ThrowOnError extends boolean = false>(options: Options<GetProductData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<ProductData, ErrorResponse, ThrowOnError>;
|
|
1187
866
|
/**
|
|
1188
867
|
* Get a Bundle's Component Products
|
|
1189
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.
|
|
@@ -1205,15 +884,7 @@ export var getProduct = function (options) {
|
|
|
1205
884
|
* See [**Including Resources**](/guides/Getting-Started/includes).
|
|
1206
885
|
*
|
|
1207
886
|
*/
|
|
1208
|
-
|
|
1209
|
-
var _a;
|
|
1210
|
-
return ((_a = options === null || options === void 0 ? void 0 : options.client) !== null && _a !== void 0 ? _a : client).get(__assign(__assign({}, options), { security: [
|
|
1211
|
-
{
|
|
1212
|
-
scheme: "bearer",
|
|
1213
|
-
type: "http",
|
|
1214
|
-
},
|
|
1215
|
-
], url: "/catalogs/{catalog_id}/releases/{release_id}/products/{product_id}/relationships/component_products" }));
|
|
1216
|
-
};
|
|
887
|
+
declare const getComponentProductIds: <ThrowOnError extends boolean = false>(options: Options<GetComponentProductIdsData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<ProductReferenceListData, ErrorResponse, ThrowOnError>;
|
|
1217
888
|
/**
|
|
1218
889
|
* Get a Parent Product's Child Products
|
|
1219
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.
|
|
@@ -1254,15 +925,7 @@ export var getComponentProductIds = function (options) {
|
|
|
1254
925
|
* See [**Including Resources**](/guides/Getting-Started/includes).
|
|
1255
926
|
*
|
|
1256
927
|
*/
|
|
1257
|
-
|
|
1258
|
-
var _a;
|
|
1259
|
-
return ((_a = options === null || options === void 0 ? void 0 : options.client) !== null && _a !== void 0 ? _a : client).get(__assign(__assign({}, options), { security: [
|
|
1260
|
-
{
|
|
1261
|
-
scheme: "bearer",
|
|
1262
|
-
type: "http",
|
|
1263
|
-
},
|
|
1264
|
-
], url: "/catalogs/{catalog_id}/releases/{release_id}/products/{product_id}/relationships/children" }));
|
|
1265
|
-
};
|
|
928
|
+
declare const getChildProducts: <ThrowOnError extends boolean = false>(options: Options<GetChildProductsData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<ProductListData, ErrorResponse, ThrowOnError>;
|
|
1266
929
|
/**
|
|
1267
930
|
* Get a Hierarchy's Products
|
|
1268
931
|
* Returns the products associated with the specified hierarchy in the catalog. The products must be in the `live` status.
|
|
@@ -1305,15 +968,7 @@ export var getChildProducts = function (options) {
|
|
|
1305
968
|
* See [**Including Resources**](/guides/Getting-Started/includes).
|
|
1306
969
|
*
|
|
1307
970
|
*/
|
|
1308
|
-
|
|
1309
|
-
var _a;
|
|
1310
|
-
return ((_a = options === null || options === void 0 ? void 0 : options.client) !== null && _a !== void 0 ? _a : client).get(__assign(__assign({}, options), { security: [
|
|
1311
|
-
{
|
|
1312
|
-
scheme: "bearer",
|
|
1313
|
-
type: "http",
|
|
1314
|
-
},
|
|
1315
|
-
], url: "/catalogs/{catalog_id}/releases/{release_id}/hierarchies/{hierarchy_id}/products" }));
|
|
1316
|
-
};
|
|
971
|
+
declare const getProductsForHierarchy: <ThrowOnError extends boolean = false>(options: Options<GetProductsForHierarchyData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<ProductListData, ErrorResponse, ThrowOnError>;
|
|
1317
972
|
/**
|
|
1318
973
|
* Get a Node's Products
|
|
1319
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.
|
|
@@ -1362,15 +1017,7 @@ export var getProductsForHierarchy = function (options) {
|
|
|
1362
1017
|
* See [**Including Resources**](/guides/Getting-Started/includes).
|
|
1363
1018
|
*
|
|
1364
1019
|
*/
|
|
1365
|
-
|
|
1366
|
-
var _a;
|
|
1367
|
-
return ((_a = options === null || options === void 0 ? void 0 : options.client) !== null && _a !== void 0 ? _a : client).get(__assign(__assign({}, options), { security: [
|
|
1368
|
-
{
|
|
1369
|
-
scheme: "bearer",
|
|
1370
|
-
type: "http",
|
|
1371
|
-
},
|
|
1372
|
-
], url: "/catalogs/{catalog_id}/releases/{release_id}/nodes/{node_id}/relationships/products" }));
|
|
1373
|
-
};
|
|
1020
|
+
declare const getProductsForNode: <ThrowOnError extends boolean = false>(options: Options<GetProductsForNodeData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<ProductListData, ErrorResponse, ThrowOnError>;
|
|
1374
1021
|
/**
|
|
1375
1022
|
* Get Shopper Carts
|
|
1376
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).
|
|
@@ -1384,15 +1031,11 @@ export var getProductsForNode = function (options) {
|
|
|
1384
1031
|
* :::
|
|
1385
1032
|
*
|
|
1386
1033
|
*/
|
|
1387
|
-
|
|
1388
|
-
|
|
1389
|
-
|
|
1390
|
-
|
|
1391
|
-
|
|
1392
|
-
type: "http",
|
|
1393
|
-
},
|
|
1394
|
-
], url: "/v2/carts" }));
|
|
1395
|
-
};
|
|
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>;
|
|
1396
1039
|
/**
|
|
1397
1040
|
* Create a Cart
|
|
1398
1041
|
*
|
|
@@ -1454,15 +1097,9 @@ export var getCarts = function (options) {
|
|
|
1454
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`.
|
|
1455
1098
|
*
|
|
1456
1099
|
*/
|
|
1457
|
-
|
|
1458
|
-
|
|
1459
|
-
|
|
1460
|
-
{
|
|
1461
|
-
scheme: "bearer",
|
|
1462
|
-
type: "http",
|
|
1463
|
-
},
|
|
1464
|
-
], url: "/v2/carts" }));
|
|
1465
|
-
};
|
|
1100
|
+
declare const createACart: <ThrowOnError extends boolean = false>(options?: Options<CreateACartData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<ResponseData & {
|
|
1101
|
+
data?: CartResponse;
|
|
1102
|
+
}, ResponseError, ThrowOnError>;
|
|
1466
1103
|
/**
|
|
1467
1104
|
* Delete a Cart
|
|
1468
1105
|
* You can delete a cart, including the items, name, description, and remove all associations.
|
|
@@ -1484,15 +1121,7 @@ export var createACart = function (options) {
|
|
|
1484
1121
|
* ````
|
|
1485
1122
|
*
|
|
1486
1123
|
*/
|
|
1487
|
-
|
|
1488
|
-
var _a;
|
|
1489
|
-
return ((_a = options === null || options === void 0 ? void 0 : options.client) !== null && _a !== void 0 ? _a : client).delete(__assign(__assign({}, options), { security: [
|
|
1490
|
-
{
|
|
1491
|
-
scheme: "bearer",
|
|
1492
|
-
type: "http",
|
|
1493
|
-
},
|
|
1494
|
-
], url: "/v2/carts/{cartID}" }));
|
|
1495
|
-
};
|
|
1124
|
+
declare const deleteACart: <ThrowOnError extends boolean = false>(options: Options<DeleteACartData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<void, ResponseError, ThrowOnError>;
|
|
1496
1125
|
/**
|
|
1497
1126
|
* Get a Cart
|
|
1498
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.
|
|
@@ -1520,15 +1149,12 @@ export var deleteACart = function (options) {
|
|
|
1520
1149
|
* | `include` | Optional | `string` | Comma-delimited string of entities that can be included. The information included are `items`,`tax_items`, `custom_discounts`, or `promotions`. |
|
|
1521
1150
|
*
|
|
1522
1151
|
*/
|
|
1523
|
-
|
|
1524
|
-
|
|
1525
|
-
|
|
1526
|
-
|
|
1527
|
-
|
|
1528
|
-
|
|
1529
|
-
},
|
|
1530
|
-
], url: "/v2/carts/{cartID}" }));
|
|
1531
|
-
};
|
|
1152
|
+
declare const getCart: <ThrowOnError extends boolean = false>(options: Options<GetCartData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<ResponseData & {
|
|
1153
|
+
data?: CartResponse;
|
|
1154
|
+
} & {
|
|
1155
|
+
data?: CartResponse;
|
|
1156
|
+
included?: CartInclude;
|
|
1157
|
+
}, ResponseError, ThrowOnError>;
|
|
1532
1158
|
/**
|
|
1533
1159
|
* Update a Cart
|
|
1534
1160
|
* Updates cart properties for the specified cartID.
|
|
@@ -1536,29 +1162,15 @@ export var getCart = function (options) {
|
|
|
1536
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).
|
|
1537
1163
|
*
|
|
1538
1164
|
*/
|
|
1539
|
-
|
|
1540
|
-
|
|
1541
|
-
|
|
1542
|
-
{
|
|
1543
|
-
scheme: "bearer",
|
|
1544
|
-
type: "http",
|
|
1545
|
-
},
|
|
1546
|
-
], url: "/v2/carts/{cartID}" }));
|
|
1547
|
-
};
|
|
1165
|
+
declare const updateACart: <ThrowOnError extends boolean = false>(options: Options<UpdateACartData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<ResponseData & {
|
|
1166
|
+
data?: CartResponse;
|
|
1167
|
+
}, ResponseError, ThrowOnError>;
|
|
1548
1168
|
/**
|
|
1549
1169
|
* Delete all Cart Items
|
|
1550
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.
|
|
1551
1171
|
*
|
|
1552
1172
|
*/
|
|
1553
|
-
|
|
1554
|
-
var _a;
|
|
1555
|
-
return ((_a = options === null || options === void 0 ? void 0 : options.client) !== null && _a !== void 0 ? _a : client).delete(__assign(__assign({}, options), { security: [
|
|
1556
|
-
{
|
|
1557
|
-
scheme: "bearer",
|
|
1558
|
-
type: "http",
|
|
1559
|
-
},
|
|
1560
|
-
], url: "/v2/carts/{cartID}/items" }));
|
|
1561
|
-
};
|
|
1173
|
+
declare const deleteAllCartItems: <ThrowOnError extends boolean = false>(options: Options<DeleteAllCartItemsData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<void, ResponseError, ThrowOnError>;
|
|
1562
1174
|
/**
|
|
1563
1175
|
* Get Cart Items
|
|
1564
1176
|
*
|
|
@@ -1742,15 +1354,7 @@ export var deleteAllCartItems = function (options) {
|
|
|
1742
1354
|
* ```
|
|
1743
1355
|
*
|
|
1744
1356
|
*/
|
|
1745
|
-
|
|
1746
|
-
var _a;
|
|
1747
|
-
return ((_a = options === null || options === void 0 ? void 0 : options.client) !== null && _a !== void 0 ? _a : client).get(__assign(__assign({}, options), { security: [
|
|
1748
|
-
{
|
|
1749
|
-
scheme: "bearer",
|
|
1750
|
-
type: "http",
|
|
1751
|
-
},
|
|
1752
|
-
], url: "/v2/carts/{cartID}/items" }));
|
|
1753
|
-
};
|
|
1357
|
+
declare const getCartItems: <ThrowOnError extends boolean = false>(options: Options<GetCartItemsData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<CartsResponse, ResponseError, ThrowOnError>;
|
|
1754
1358
|
/**
|
|
1755
1359
|
* Add Items to Cart
|
|
1756
1360
|
*
|
|
@@ -2126,15 +1730,7 @@ export var getCartItems = function (options) {
|
|
|
2126
1730
|
* ```
|
|
2127
1731
|
*
|
|
2128
1732
|
*/
|
|
2129
|
-
|
|
2130
|
-
var _a;
|
|
2131
|
-
return ((_a = options === null || options === void 0 ? void 0 : options.client) !== null && _a !== void 0 ? _a : client).post(__assign(__assign({}, options), { headers: __assign({ "Content-Type": "application/json" }, options === null || options === void 0 ? void 0 : options.headers), security: [
|
|
2132
|
-
{
|
|
2133
|
-
scheme: "bearer",
|
|
2134
|
-
type: "http",
|
|
2135
|
-
},
|
|
2136
|
-
], url: "/v2/carts/{cartID}/items" }));
|
|
2137
|
-
};
|
|
1733
|
+
declare const manageCarts: <ThrowOnError extends boolean = false>(options: Options<ManageCartsData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<CartsResponse, ResponseError, ThrowOnError>;
|
|
2138
1734
|
/**
|
|
2139
1735
|
* Bulk Update Items in Cart
|
|
2140
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.
|
|
@@ -2142,106 +1738,42 @@ export var manageCarts = function (options) {
|
|
|
2142
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.
|
|
2143
1739
|
*
|
|
2144
1740
|
*/
|
|
2145
|
-
|
|
2146
|
-
var _a;
|
|
2147
|
-
return ((_a = options === null || options === void 0 ? void 0 : options.client) !== null && _a !== void 0 ? _a : client).put(__assign(__assign({}, options), { headers: __assign({ "Content-Type": "application/json" }, options === null || options === void 0 ? void 0 : options.headers), security: [
|
|
2148
|
-
{
|
|
2149
|
-
scheme: "bearer",
|
|
2150
|
-
type: "http",
|
|
2151
|
-
},
|
|
2152
|
-
], url: "/v2/carts/{cartID}/items" }));
|
|
2153
|
-
};
|
|
1741
|
+
declare const bulkUpdateItemsInCart: <ThrowOnError extends boolean = false>(options: Options<BulkUpdateItemsInCartData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<unknown, ResponseError, ThrowOnError>;
|
|
2154
1742
|
/**
|
|
2155
1743
|
* Delete a Cart Item
|
|
2156
1744
|
* Use this endpoint to delete a cart item.
|
|
2157
1745
|
*/
|
|
2158
|
-
|
|
2159
|
-
var _a;
|
|
2160
|
-
return ((_a = options === null || options === void 0 ? void 0 : options.client) !== null && _a !== void 0 ? _a : client).delete(__assign(__assign({}, options), { security: [
|
|
2161
|
-
{
|
|
2162
|
-
scheme: "bearer",
|
|
2163
|
-
type: "http",
|
|
2164
|
-
},
|
|
2165
|
-
], url: "/v2/carts/{cartID}/items/{cartitemID}" }));
|
|
2166
|
-
};
|
|
1746
|
+
declare const deleteACartItem: <ThrowOnError extends boolean = false>(options: Options<DeleteACartItemData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<void, ResponseError, ThrowOnError>;
|
|
2167
1747
|
/**
|
|
2168
1748
|
* Update a Cart Item
|
|
2169
1749
|
* You can easily update a cart item. A successful update returns the cart items.
|
|
2170
1750
|
*/
|
|
2171
|
-
|
|
2172
|
-
var _a;
|
|
2173
|
-
return ((_a = options === null || options === void 0 ? void 0 : options.client) !== null && _a !== void 0 ? _a : client).put(__assign(__assign({}, options), { headers: __assign({ "Content-Type": "application/json" }, options === null || options === void 0 ? void 0 : options.headers), security: [
|
|
2174
|
-
{
|
|
2175
|
-
scheme: "bearer",
|
|
2176
|
-
type: "http",
|
|
2177
|
-
},
|
|
2178
|
-
], url: "/v2/carts/{cartID}/items/{cartitemID}" }));
|
|
2179
|
-
};
|
|
1751
|
+
declare const updateACartItem: <ThrowOnError extends boolean = false>(options: Options<UpdateACartItemData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<CartsResponse, ResponseError, ThrowOnError>;
|
|
2180
1752
|
/**
|
|
2181
1753
|
* Delete Account Cart Association
|
|
2182
1754
|
* You can delete an association between an account and a cart.
|
|
2183
1755
|
*/
|
|
2184
|
-
|
|
2185
|
-
var _a;
|
|
2186
|
-
return ((_a = options === null || options === void 0 ? void 0 : options.client) !== null && _a !== void 0 ? _a : client).delete(__assign(__assign({}, options), { headers: __assign({ "Content-Type": "application/json" }, options === null || options === void 0 ? void 0 : options.headers), security: [
|
|
2187
|
-
{
|
|
2188
|
-
scheme: "bearer",
|
|
2189
|
-
type: "http",
|
|
2190
|
-
},
|
|
2191
|
-
], url: "/v2/carts/{cartID}/relationships/accounts" }));
|
|
2192
|
-
};
|
|
1756
|
+
declare const deleteAccountCartAssociation: <ThrowOnError extends boolean = false>(options: Options<DeleteAccountCartAssociationData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<void, ResponseError, ThrowOnError>;
|
|
2193
1757
|
/**
|
|
2194
1758
|
* Create an Account Cart Association
|
|
2195
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.
|
|
2196
1760
|
*/
|
|
2197
|
-
|
|
2198
|
-
var _a;
|
|
2199
|
-
return ((_a = options === null || options === void 0 ? void 0 : options.client) !== null && _a !== void 0 ? _a : client).post(__assign(__assign({}, options), { headers: __assign({ "Content-Type": "application/json" }, options === null || options === void 0 ? void 0 : options.headers), security: [
|
|
2200
|
-
{
|
|
2201
|
-
scheme: "bearer",
|
|
2202
|
-
type: "http",
|
|
2203
|
-
},
|
|
2204
|
-
], url: "/v2/carts/{cartID}/relationships/accounts" }));
|
|
2205
|
-
};
|
|
1761
|
+
declare const createAccountCartAssociation: <ThrowOnError extends boolean = false>(options: Options<CreateAccountCartAssociationData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<CreateAccountCartAssociationResponse, ResponseError, ThrowOnError>;
|
|
2206
1762
|
/**
|
|
2207
1763
|
* Delete Customer Cart Association
|
|
2208
1764
|
* You can delete an association between a customer and a cart.
|
|
2209
1765
|
*/
|
|
2210
|
-
|
|
2211
|
-
var _a;
|
|
2212
|
-
return ((_a = options === null || options === void 0 ? void 0 : options.client) !== null && _a !== void 0 ? _a : client).delete(__assign(__assign({}, options), { headers: __assign({ "Content-Type": "application/json" }, options === null || options === void 0 ? void 0 : options.headers), security: [
|
|
2213
|
-
{
|
|
2214
|
-
scheme: "bearer",
|
|
2215
|
-
type: "http",
|
|
2216
|
-
},
|
|
2217
|
-
], url: "/v2/carts/{cartID}/relationships/customers" }));
|
|
2218
|
-
};
|
|
1766
|
+
declare const deleteCustomerCartAssociation: <ThrowOnError extends boolean = false>(options: Options<DeleteCustomerCartAssociationData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<void, ResponseError, ThrowOnError>;
|
|
2219
1767
|
/**
|
|
2220
1768
|
* Create a Customer Cart Association
|
|
2221
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.
|
|
2222
1770
|
*/
|
|
2223
|
-
|
|
2224
|
-
var _a;
|
|
2225
|
-
return ((_a = options === null || options === void 0 ? void 0 : options.client) !== null && _a !== void 0 ? _a : client).post(__assign(__assign({}, options), { headers: __assign({ "Content-Type": "application/json" }, options === null || options === void 0 ? void 0 : options.headers), security: [
|
|
2226
|
-
{
|
|
2227
|
-
scheme: "bearer",
|
|
2228
|
-
type: "http",
|
|
2229
|
-
},
|
|
2230
|
-
], url: "/v2/carts/{cartID}/relationships/customers" }));
|
|
2231
|
-
};
|
|
1771
|
+
declare const createCustomerCartAssociation: <ThrowOnError extends boolean = false>(options: Options<CreateCustomerCartAssociationData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<CartsRelationshipsCustomersData, ResponseError, ThrowOnError>;
|
|
2232
1772
|
/**
|
|
2233
1773
|
* Delete a Promotion via Promotion Code
|
|
2234
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.
|
|
2235
1775
|
*/
|
|
2236
|
-
|
|
2237
|
-
var _a;
|
|
2238
|
-
return ((_a = options === null || options === void 0 ? void 0 : options.client) !== null && _a !== void 0 ? _a : client).delete(__assign(__assign({}, options), { security: [
|
|
2239
|
-
{
|
|
2240
|
-
scheme: "bearer",
|
|
2241
|
-
type: "http",
|
|
2242
|
-
},
|
|
2243
|
-
], url: "/v2/carts/{cartID}/discounts/{promoCode}" }));
|
|
2244
|
-
};
|
|
1776
|
+
declare const deleteAPromotionViaPromotionCode: <ThrowOnError extends boolean = false>(options: Options<DeleteAPromotionViaPromotionCodeData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<void, ResponseError, ThrowOnError>;
|
|
2245
1777
|
/**
|
|
2246
1778
|
* Add Tax Item to Cart
|
|
2247
1779
|
*
|
|
@@ -2254,28 +1786,14 @@ export var deleteAPromotionViaPromotionCode = function (options) {
|
|
|
2254
1786
|
* :::
|
|
2255
1787
|
*
|
|
2256
1788
|
*/
|
|
2257
|
-
|
|
2258
|
-
|
|
2259
|
-
|
|
2260
|
-
{
|
|
2261
|
-
scheme: "bearer",
|
|
2262
|
-
type: "http",
|
|
2263
|
-
},
|
|
2264
|
-
], url: "/v2/carts/{cartID}/items/{cartitemID}/taxes" }));
|
|
2265
|
-
};
|
|
1789
|
+
declare const addTaxItemToCart: <ThrowOnError extends boolean = false>(options: Options<AddTaxItemToCartData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<ResponseData & {
|
|
1790
|
+
data?: CartsItemsTaxesObject;
|
|
1791
|
+
}, ResponseError, ThrowOnError>;
|
|
2266
1792
|
/**
|
|
2267
1793
|
* Bulk Delete Tax Items from Cart
|
|
2268
1794
|
* Use this endpoint to bulk delete tax items from cart.
|
|
2269
1795
|
*/
|
|
2270
|
-
|
|
2271
|
-
var _a;
|
|
2272
|
-
return ((_a = options === null || options === void 0 ? void 0 : options.client) !== null && _a !== void 0 ? _a : client).delete(__assign(__assign({}, options), { security: [
|
|
2273
|
-
{
|
|
2274
|
-
scheme: "bearer",
|
|
2275
|
-
type: "http",
|
|
2276
|
-
},
|
|
2277
|
-
], url: "/v2/carts/{cartID}/taxes" }));
|
|
2278
|
-
};
|
|
1796
|
+
declare const bulkDeleteTaxItemsFromCart: <ThrowOnError extends boolean = false>(options: Options<BulkDeleteTaxItemsFromCartData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<void, ResponseError, ThrowOnError>;
|
|
2279
1797
|
/**
|
|
2280
1798
|
* Bulk Add Tax Items to Cart
|
|
2281
1799
|
* :::note
|
|
@@ -2341,54 +1859,24 @@ export var bulkDeleteTaxItemsFromCart = function (options) {
|
|
|
2341
1859
|
* ```
|
|
2342
1860
|
*
|
|
2343
1861
|
*/
|
|
2344
|
-
|
|
2345
|
-
var _a;
|
|
2346
|
-
return ((_a = options === null || options === void 0 ? void 0 : options.client) !== null && _a !== void 0 ? _a : client).post(__assign(__assign({}, options), { headers: __assign({ "Content-Type": "application/json" }, options === null || options === void 0 ? void 0 : options.headers), security: [
|
|
2347
|
-
{
|
|
2348
|
-
scheme: "bearer",
|
|
2349
|
-
type: "http",
|
|
2350
|
-
},
|
|
2351
|
-
], url: "/v2/carts/{cartID}/taxes" }));
|
|
2352
|
-
};
|
|
1862
|
+
declare const bulkAddTaxItemsToCart: <ThrowOnError extends boolean = false>(options: Options<BulkAddTaxItemsToCartData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<CartsBulkTaxes, ResponseError, ThrowOnError>;
|
|
2353
1863
|
/**
|
|
2354
1864
|
* Delete a Tax Item
|
|
2355
1865
|
* Use this endpoint to delete a tax item.
|
|
2356
1866
|
*/
|
|
2357
|
-
|
|
2358
|
-
var _a;
|
|
2359
|
-
return ((_a = options === null || options === void 0 ? void 0 : options.client) !== null && _a !== void 0 ? _a : client).delete(__assign(__assign({}, options), { security: [
|
|
2360
|
-
{
|
|
2361
|
-
scheme: "bearer",
|
|
2362
|
-
type: "http",
|
|
2363
|
-
},
|
|
2364
|
-
], url: "/v2/carts/{cartID}/items/{cartitemID}/taxes/{taxitemID}" }));
|
|
2365
|
-
};
|
|
1867
|
+
declare const deleteATaxItem: <ThrowOnError extends boolean = false>(options: Options<DeleteATaxItemData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<void, ResponseError, ThrowOnError>;
|
|
2366
1868
|
/**
|
|
2367
1869
|
* Update a Tax Item
|
|
2368
1870
|
* Use this endpoint to update a tax item.
|
|
2369
1871
|
*/
|
|
2370
|
-
|
|
2371
|
-
|
|
2372
|
-
|
|
2373
|
-
{
|
|
2374
|
-
scheme: "bearer",
|
|
2375
|
-
type: "http",
|
|
2376
|
-
},
|
|
2377
|
-
], url: "/v2/carts/{cartID}/items/{cartitemID}/taxes/{taxitemID}" }));
|
|
2378
|
-
};
|
|
1872
|
+
declare const updateATaxItem: <ThrowOnError extends boolean = false>(options: Options<UpdateATaxItemData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<ResponseData & {
|
|
1873
|
+
data?: CartsItemsTaxesObject;
|
|
1874
|
+
}, ResponseError, ThrowOnError>;
|
|
2379
1875
|
/**
|
|
2380
1876
|
* Bulk Delete Custom Discounts From Cart
|
|
2381
1877
|
* Use this endpoint to bulk delete custom discounts from cart.
|
|
2382
1878
|
*/
|
|
2383
|
-
|
|
2384
|
-
var _a;
|
|
2385
|
-
return ((_a = options === null || options === void 0 ? void 0 : options.client) !== null && _a !== void 0 ? _a : client).delete(__assign(__assign({}, options), { security: [
|
|
2386
|
-
{
|
|
2387
|
-
scheme: "bearer",
|
|
2388
|
-
type: "http",
|
|
2389
|
-
},
|
|
2390
|
-
], url: "/v2/carts/{cartID}/custom-discounts" }));
|
|
2391
|
-
};
|
|
1879
|
+
declare const bulkDeleteCustomDiscountsFromCart: <ThrowOnError extends boolean = false>(options: Options<BulkDeleteCustomDiscountsFromCartData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<void, ResponseError, ThrowOnError>;
|
|
2392
1880
|
/**
|
|
2393
1881
|
* Bulk Add Custom Discounts to Cart
|
|
2394
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.
|
|
@@ -2396,80 +1884,38 @@ export var bulkDeleteCustomDiscountsFromCart = function (options) {
|
|
|
2396
1884
|
* To increase the custom discount value, contact [Elastic Path Support team](https://support.elasticpath.com/hc/en-us).
|
|
2397
1885
|
*
|
|
2398
1886
|
*/
|
|
2399
|
-
|
|
2400
|
-
var _a;
|
|
2401
|
-
return ((_a = options === null || options === void 0 ? void 0 : options.client) !== null && _a !== void 0 ? _a : client).post(__assign(__assign({}, options), { headers: __assign({ "Content-Type": "application/json" }, options === null || options === void 0 ? void 0 : options.headers), security: [
|
|
2402
|
-
{
|
|
2403
|
-
scheme: "bearer",
|
|
2404
|
-
type: "http",
|
|
2405
|
-
},
|
|
2406
|
-
], url: "/v2/carts/{cartID}/custom-discounts" }));
|
|
2407
|
-
};
|
|
1887
|
+
declare const bulkAddCustomDiscountsToCart: <ThrowOnError extends boolean = false>(options: Options<BulkAddCustomDiscountsToCartData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<CartsBulkCustomDiscountsResponse, ResponseError, ThrowOnError>;
|
|
2408
1888
|
/**
|
|
2409
1889
|
* Delete Custom Discount From Cart
|
|
2410
1890
|
* Use this endpoint to delete custom discount from cart.
|
|
2411
1891
|
*/
|
|
2412
|
-
|
|
2413
|
-
var _a;
|
|
2414
|
-
return ((_a = options === null || options === void 0 ? void 0 : options.client) !== null && _a !== void 0 ? _a : client).delete(__assign(__assign({}, options), { security: [
|
|
2415
|
-
{
|
|
2416
|
-
scheme: "bearer",
|
|
2417
|
-
type: "http",
|
|
2418
|
-
},
|
|
2419
|
-
], url: "/v2/carts/{cartID}/custom-discounts/{customdiscountID}" }));
|
|
2420
|
-
};
|
|
1892
|
+
declare const deleteCustomDiscountFromCart: <ThrowOnError extends boolean = false>(options: Options<DeleteCustomDiscountFromCartData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<void, ResponseError, ThrowOnError>;
|
|
2421
1893
|
/**
|
|
2422
1894
|
* Update Custom Discount For Cart
|
|
2423
1895
|
* Use this endpoint to update a custom discount in your cart.
|
|
2424
1896
|
*/
|
|
2425
|
-
|
|
2426
|
-
|
|
2427
|
-
|
|
2428
|
-
{
|
|
2429
|
-
scheme: "bearer",
|
|
2430
|
-
type: "http",
|
|
2431
|
-
},
|
|
2432
|
-
], url: "/v2/carts/{cartID}/custom-discounts/{customdiscountID}" }));
|
|
2433
|
-
};
|
|
1897
|
+
declare const updateCustomDiscountForCart: <ThrowOnError extends boolean = false>(options: Options<UpdateCustomDiscountForCartData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<ResponseData & {
|
|
1898
|
+
data?: CartsCustomDiscountsResponse;
|
|
1899
|
+
}, ResponseError, ThrowOnError>;
|
|
2434
1900
|
/**
|
|
2435
1901
|
* Add Custom Discount To Cart Item
|
|
2436
1902
|
* Use this endpoint to add a custom discount to cart item.
|
|
2437
1903
|
*/
|
|
2438
|
-
|
|
2439
|
-
|
|
2440
|
-
|
|
2441
|
-
{
|
|
2442
|
-
scheme: "bearer",
|
|
2443
|
-
type: "http",
|
|
2444
|
-
},
|
|
2445
|
-
], url: "/v2/carts/{cartID}/items/{cartitemID}/custom-discounts" }));
|
|
2446
|
-
};
|
|
1904
|
+
declare const addCustomDiscountToCartItem: <ThrowOnError extends boolean = false>(options: Options<AddCustomDiscountToCartItemData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<ResponseData & {
|
|
1905
|
+
data?: CartsCustomDiscountsResponse;
|
|
1906
|
+
}, ResponseError, ThrowOnError>;
|
|
2447
1907
|
/**
|
|
2448
1908
|
* Delete Custom Discount From Cart Item
|
|
2449
1909
|
* Use this endpoint to delete custom discount from cart item.
|
|
2450
1910
|
*/
|
|
2451
|
-
|
|
2452
|
-
var _a;
|
|
2453
|
-
return ((_a = options === null || options === void 0 ? void 0 : options.client) !== null && _a !== void 0 ? _a : client).delete(__assign(__assign({}, options), { security: [
|
|
2454
|
-
{
|
|
2455
|
-
scheme: "bearer",
|
|
2456
|
-
type: "http",
|
|
2457
|
-
},
|
|
2458
|
-
], url: "/v2/carts/{cartID}/items/{cartitemID}/custom-discounts/{customdiscountID}" }));
|
|
2459
|
-
};
|
|
1911
|
+
declare const deleteCustomDiscountFromCartItem: <ThrowOnError extends boolean = false>(options: Options<DeleteCustomDiscountFromCartItemData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<void, ResponseError, ThrowOnError>;
|
|
2460
1912
|
/**
|
|
2461
1913
|
* Update Custom Discount For Cart Item
|
|
2462
1914
|
* Use this endpoint to update a custom discount in your cart item.
|
|
2463
1915
|
*/
|
|
2464
|
-
|
|
2465
|
-
|
|
2466
|
-
|
|
2467
|
-
{
|
|
2468
|
-
scheme: "bearer",
|
|
2469
|
-
type: "http",
|
|
2470
|
-
},
|
|
2471
|
-
], url: "/v2/carts/{cartID}/items/{cartitemID}/custom-discounts/{customdiscountID}" }));
|
|
2472
|
-
};
|
|
1916
|
+
declare const updateCustomDiscountForCartItem: <ThrowOnError extends boolean = false>(options: Options<UpdateCustomDiscountForCartItemData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<ResponseData & {
|
|
1917
|
+
data?: CartsCustomDiscountsResponse;
|
|
1918
|
+
}, ResponseError, ThrowOnError>;
|
|
2473
1919
|
/**
|
|
2474
1920
|
* Create Stripe Payment Intent for a Cart
|
|
2475
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.
|
|
@@ -2498,15 +1944,7 @@ export var updateCustomDiscountForCartItem = function (options) {
|
|
|
2498
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.
|
|
2499
1945
|
*
|
|
2500
1946
|
*/
|
|
2501
|
-
|
|
2502
|
-
var _a;
|
|
2503
|
-
return ((_a = options === null || options === void 0 ? void 0 : options.client) !== null && _a !== void 0 ? _a : client).post(__assign(__assign({}, options), { headers: __assign({ "Content-Type": "application/json" }, options === null || options === void 0 ? void 0 : options.headers), security: [
|
|
2504
|
-
{
|
|
2505
|
-
scheme: "bearer",
|
|
2506
|
-
type: "http",
|
|
2507
|
-
},
|
|
2508
|
-
], url: "/v2/carts/{cartID}/payments" }));
|
|
2509
|
-
};
|
|
1947
|
+
declare const createCartPaymentIntent: <ThrowOnError extends boolean = false>(options: Options<CreateCartPaymentIntentData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<CartResponse, ResponseError, ThrowOnError>;
|
|
2510
1948
|
/**
|
|
2511
1949
|
* Checkout API
|
|
2512
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.
|
|
@@ -2563,15 +2001,9 @@ export var createCartPaymentIntent = function (options) {
|
|
|
2563
2001
|
* ```
|
|
2564
2002
|
*
|
|
2565
2003
|
*/
|
|
2566
|
-
|
|
2567
|
-
|
|
2568
|
-
|
|
2569
|
-
{
|
|
2570
|
-
scheme: "bearer",
|
|
2571
|
-
type: "http",
|
|
2572
|
-
},
|
|
2573
|
-
], url: "/v2/carts/{cartID}/checkout" }));
|
|
2574
|
-
};
|
|
2004
|
+
declare const checkoutApi: <ThrowOnError extends boolean = false>(options: Options<CheckoutApiData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<ResponseData & {
|
|
2005
|
+
data?: OrderResponse;
|
|
2006
|
+
}, ResponseError, ThrowOnError>;
|
|
2575
2007
|
/**
|
|
2576
2008
|
* Get all Orders
|
|
2577
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.
|
|
@@ -2613,28 +2045,24 @@ export var checkoutApi = function (options) {
|
|
|
2613
2045
|
* | `order_number` | `string` | `eq` / `like` | `like(order_number, 123*)` |
|
|
2614
2046
|
*
|
|
2615
2047
|
*/
|
|
2616
|
-
|
|
2617
|
-
|
|
2618
|
-
|
|
2619
|
-
|
|
2620
|
-
|
|
2621
|
-
|
|
2622
|
-
|
|
2623
|
-
|
|
2624
|
-
};
|
|
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;
|
|
2052
|
+
included?: {
|
|
2053
|
+
items?: Array<OrderItemResponse>;
|
|
2054
|
+
};
|
|
2055
|
+
}, ResponseError, ThrowOnError>;
|
|
2625
2056
|
/**
|
|
2626
2057
|
* Get an Order
|
|
2627
2058
|
* Use this endpoint to retrieve a specific order.
|
|
2628
2059
|
*/
|
|
2629
|
-
|
|
2630
|
-
|
|
2631
|
-
|
|
2632
|
-
|
|
2633
|
-
|
|
2634
|
-
|
|
2635
|
-
},
|
|
2636
|
-
], url: "/v2/orders/{orderID}" }));
|
|
2637
|
-
};
|
|
2060
|
+
declare const getAnOrder: <ThrowOnError extends boolean = false>(options: Options<GetAnOrderData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<ResponseData & {
|
|
2061
|
+
data?: OrderResponse;
|
|
2062
|
+
included?: {
|
|
2063
|
+
items?: Array<OrderItemResponse>;
|
|
2064
|
+
};
|
|
2065
|
+
}, ResponseError, ThrowOnError>;
|
|
2638
2066
|
/**
|
|
2639
2067
|
* Update an Order
|
|
2640
2068
|
* You can only update custom data, `shipping`, `shipping_address`, and status of orders. All other settings in the order object are immutable.
|
|
@@ -2660,28 +2088,16 @@ export var getAnOrder = function (options) {
|
|
|
2660
2088
|
* :::
|
|
2661
2089
|
*
|
|
2662
2090
|
*/
|
|
2663
|
-
|
|
2664
|
-
|
|
2665
|
-
|
|
2666
|
-
{
|
|
2667
|
-
scheme: "bearer",
|
|
2668
|
-
type: "http",
|
|
2669
|
-
},
|
|
2670
|
-
], url: "/v2/orders/{orderID}" }));
|
|
2671
|
-
};
|
|
2091
|
+
declare const updateAnOrder: <ThrowOnError extends boolean = false>(options: Options<UpdateAnOrderData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<ResponseData & {
|
|
2092
|
+
data?: OrderResponse;
|
|
2093
|
+
}, ResponseError, ThrowOnError>;
|
|
2672
2094
|
/**
|
|
2673
2095
|
* Get Order Items
|
|
2674
2096
|
* Use this endpoint to retrieve order items.
|
|
2675
2097
|
*/
|
|
2676
|
-
|
|
2677
|
-
|
|
2678
|
-
|
|
2679
|
-
{
|
|
2680
|
-
scheme: "bearer",
|
|
2681
|
-
type: "http",
|
|
2682
|
-
},
|
|
2683
|
-
], url: "/v2/orders/{orderID}/items" }));
|
|
2684
|
-
};
|
|
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>;
|
|
2685
2101
|
/**
|
|
2686
2102
|
* Anonymize Orders
|
|
2687
2103
|
* You can anonymize an order when it is fulfilled, canceled, or fully refunded.
|
|
@@ -2689,15 +2105,9 @@ export var getOrderItems = function (options) {
|
|
|
2689
2105
|
* When anonymization is successful, Personal Identifiable Information such as customer details, `shipping_address`, and `billing_address` are replaced with *.
|
|
2690
2106
|
*
|
|
2691
2107
|
*/
|
|
2692
|
-
|
|
2693
|
-
|
|
2694
|
-
|
|
2695
|
-
{
|
|
2696
|
-
scheme: "bearer",
|
|
2697
|
-
type: "http",
|
|
2698
|
-
},
|
|
2699
|
-
], url: "/v2/orders/anonymize" }));
|
|
2700
|
-
};
|
|
2108
|
+
declare const anonymizeOrders: <ThrowOnError extends boolean = false>(options?: Options<AnonymizeOrdersData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<ResponseData & {
|
|
2109
|
+
data?: OrderResponse;
|
|
2110
|
+
}, ResponseError, ThrowOnError>;
|
|
2701
2111
|
/**
|
|
2702
2112
|
* Payment Setup
|
|
2703
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).
|
|
@@ -2722,15 +2132,9 @@ export var anonymizeOrders = function (options) {
|
|
|
2722
2132
|
* :::
|
|
2723
2133
|
*
|
|
2724
2134
|
*/
|
|
2725
|
-
|
|
2726
|
-
|
|
2727
|
-
|
|
2728
|
-
{
|
|
2729
|
-
scheme: "bearer",
|
|
2730
|
-
type: "http",
|
|
2731
|
-
},
|
|
2732
|
-
], url: "/v2/orders/{orderID}/payments" }));
|
|
2733
|
-
};
|
|
2135
|
+
declare const paymentSetup: <ThrowOnError extends boolean = false>(options: Options<PaymentSetupData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<ResponseData & {
|
|
2136
|
+
data?: TransactionResponse;
|
|
2137
|
+
}, ResponseError, ThrowOnError>;
|
|
2734
2138
|
/**
|
|
2735
2139
|
* Confirm Payment
|
|
2736
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.
|
|
@@ -2740,28 +2144,16 @@ export var paymentSetup = function (options) {
|
|
|
2740
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.
|
|
2741
2145
|
*
|
|
2742
2146
|
*/
|
|
2743
|
-
|
|
2744
|
-
|
|
2745
|
-
|
|
2746
|
-
{
|
|
2747
|
-
scheme: "bearer",
|
|
2748
|
-
type: "http",
|
|
2749
|
-
},
|
|
2750
|
-
], url: "/v2/orders/{orderID}/transactions/{transactionID}/confirm" }));
|
|
2751
|
-
};
|
|
2147
|
+
declare const confirmPayment: <ThrowOnError extends boolean = false>(options: Options<ConfirmPaymentData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<ResponseData & {
|
|
2148
|
+
data?: TransactionResponse;
|
|
2149
|
+
}, ResponseError, ThrowOnError>;
|
|
2752
2150
|
/**
|
|
2753
2151
|
* Capture a Transaction
|
|
2754
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.
|
|
2755
2153
|
*/
|
|
2756
|
-
|
|
2757
|
-
|
|
2758
|
-
|
|
2759
|
-
{
|
|
2760
|
-
scheme: "bearer",
|
|
2761
|
-
type: "http",
|
|
2762
|
-
},
|
|
2763
|
-
], url: "/v2/orders/{orderID}/transactions/{transactionID}/capture" }));
|
|
2764
|
-
};
|
|
2154
|
+
declare const captureATransaction: <ThrowOnError extends boolean = false>(options: Options<CaptureATransactionData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<ResponseData & {
|
|
2155
|
+
data?: TransactionResponse;
|
|
2156
|
+
}, ResponseError, ThrowOnError>;
|
|
2765
2157
|
/**
|
|
2766
2158
|
* Refund a Transaction
|
|
2767
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.
|
|
@@ -2776,41 +2168,23 @@ export var captureATransaction = function (options) {
|
|
|
2776
2168
|
* :::
|
|
2777
2169
|
*
|
|
2778
2170
|
*/
|
|
2779
|
-
|
|
2780
|
-
|
|
2781
|
-
|
|
2782
|
-
{
|
|
2783
|
-
scheme: "bearer",
|
|
2784
|
-
type: "http",
|
|
2785
|
-
},
|
|
2786
|
-
], url: "/v2/orders/{orderID}/transactions/{transactionID}/refund" }));
|
|
2787
|
-
};
|
|
2171
|
+
declare const refundATransaction: <ThrowOnError extends boolean = false>(options: Options<RefundATransactionData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<ResponseData & {
|
|
2172
|
+
data?: TransactionResponse;
|
|
2173
|
+
}, ResponseError, ThrowOnError>;
|
|
2788
2174
|
/**
|
|
2789
2175
|
* Get Order Transactions
|
|
2790
2176
|
* Get order transactions
|
|
2791
2177
|
*/
|
|
2792
|
-
|
|
2793
|
-
|
|
2794
|
-
|
|
2795
|
-
{
|
|
2796
|
-
scheme: "bearer",
|
|
2797
|
-
type: "http",
|
|
2798
|
-
},
|
|
2799
|
-
], url: "/v2/orders/{orderID}/transactions" }));
|
|
2800
|
-
};
|
|
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>;
|
|
2801
2181
|
/**
|
|
2802
2182
|
* Get a Transaction
|
|
2803
2183
|
* Retrieves a transaction
|
|
2804
2184
|
*/
|
|
2805
|
-
|
|
2806
|
-
|
|
2807
|
-
|
|
2808
|
-
{
|
|
2809
|
-
scheme: "bearer",
|
|
2810
|
-
type: "http",
|
|
2811
|
-
},
|
|
2812
|
-
], url: "/v2/orders/{orderID}/transactions/{transactionID}" }));
|
|
2813
|
-
};
|
|
2185
|
+
declare const getATransaction: <ThrowOnError extends boolean = false>(options: Options<GetATransactionData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<ResponseData & {
|
|
2186
|
+
data?: TransactionResponse;
|
|
2187
|
+
}, ResponseError, ThrowOnError>;
|
|
2814
2188
|
/**
|
|
2815
2189
|
* Cancel a Transaction
|
|
2816
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.
|
|
@@ -2822,39 +2196,21 @@ export var getATransaction = function (options) {
|
|
|
2822
2196
|
* :::
|
|
2823
2197
|
*
|
|
2824
2198
|
*/
|
|
2825
|
-
|
|
2826
|
-
|
|
2827
|
-
|
|
2828
|
-
{
|
|
2829
|
-
scheme: "bearer",
|
|
2830
|
-
type: "http",
|
|
2831
|
-
},
|
|
2832
|
-
], url: "/v2/orders/{orderID}/transactions/{transactionID}/cancel" }));
|
|
2833
|
-
};
|
|
2199
|
+
declare const cancelATransaction: <ThrowOnError extends boolean = false>(options: Options<CancelATransactionData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<ResponseData & {
|
|
2200
|
+
data?: TransactionResponse;
|
|
2201
|
+
}, ResponseError, ThrowOnError>;
|
|
2834
2202
|
/**
|
|
2835
2203
|
* Get product
|
|
2836
2204
|
*/
|
|
2837
|
-
|
|
2838
|
-
|
|
2839
|
-
|
|
2840
|
-
{
|
|
2841
|
-
scheme: "bearer",
|
|
2842
|
-
type: "http",
|
|
2843
|
-
},
|
|
2844
|
-
], url: "/v2/subscriptions/products/{product_uuid}" }));
|
|
2845
|
-
};
|
|
2205
|
+
declare const getSubscriptionProduct: <ThrowOnError extends boolean = false>(options: Options<GetSubscriptionProductData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<{
|
|
2206
|
+
data?: Product2;
|
|
2207
|
+
}, SubscriptionsErrorResponse, ThrowOnError>;
|
|
2846
2208
|
/**
|
|
2847
2209
|
* Get plan
|
|
2848
2210
|
*/
|
|
2849
|
-
|
|
2850
|
-
|
|
2851
|
-
|
|
2852
|
-
{
|
|
2853
|
-
scheme: "bearer",
|
|
2854
|
-
type: "http",
|
|
2855
|
-
},
|
|
2856
|
-
], url: "/v2/subscriptions/plans/{plan_uuid}" }));
|
|
2857
|
-
};
|
|
2211
|
+
declare const getPlan: <ThrowOnError extends boolean = false>(options: Options<GetPlanData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<{
|
|
2212
|
+
data?: Plan;
|
|
2213
|
+
}, SubscriptionsErrorResponse, ThrowOnError>;
|
|
2858
2214
|
/**
|
|
2859
2215
|
* List offerings
|
|
2860
2216
|
* Retrieves a list of all subscription offerings.
|
|
@@ -2871,63 +2227,39 @@ export var getPlan = function (options) {
|
|
|
2871
2227
|
* | `in` | `products.external_ref` | In. Checks if the values are included in the specified string. If they are, the condition is true. |
|
|
2872
2228
|
*
|
|
2873
2229
|
*/
|
|
2874
|
-
|
|
2875
|
-
|
|
2876
|
-
|
|
2877
|
-
|
|
2878
|
-
|
|
2879
|
-
type: "http",
|
|
2880
|
-
},
|
|
2881
|
-
], url: "/v2/subscriptions/offerings" }));
|
|
2882
|
-
};
|
|
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>;
|
|
2883
2235
|
/**
|
|
2884
2236
|
* Get offering
|
|
2885
2237
|
*/
|
|
2886
|
-
|
|
2887
|
-
|
|
2888
|
-
|
|
2889
|
-
|
|
2890
|
-
scheme: "bearer",
|
|
2891
|
-
type: "http",
|
|
2892
|
-
},
|
|
2893
|
-
], url: "/v2/subscriptions/offerings/{offering_uuid}" }));
|
|
2894
|
-
};
|
|
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>;
|
|
2895
2242
|
/**
|
|
2896
2243
|
* List an offering's plans
|
|
2897
2244
|
*/
|
|
2898
|
-
|
|
2899
|
-
|
|
2900
|
-
|
|
2901
|
-
|
|
2902
|
-
scheme: "bearer",
|
|
2903
|
-
type: "http",
|
|
2904
|
-
},
|
|
2905
|
-
], url: "/v2/subscriptions/offerings/{offering_uuid}/plans" }));
|
|
2906
|
-
};
|
|
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>;
|
|
2907
2249
|
/**
|
|
2908
2250
|
* List an offering's features
|
|
2909
2251
|
*/
|
|
2910
|
-
|
|
2911
|
-
|
|
2912
|
-
|
|
2913
|
-
|
|
2914
|
-
scheme: "bearer",
|
|
2915
|
-
type: "http",
|
|
2916
|
-
},
|
|
2917
|
-
], url: "/v2/subscriptions/offerings/{offering_uuid}/features" }));
|
|
2918
|
-
};
|
|
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>;
|
|
2919
2256
|
/**
|
|
2920
2257
|
* List an offering's products
|
|
2921
2258
|
*/
|
|
2922
|
-
|
|
2923
|
-
|
|
2924
|
-
|
|
2925
|
-
|
|
2926
|
-
scheme: "bearer",
|
|
2927
|
-
type: "http",
|
|
2928
|
-
},
|
|
2929
|
-
], url: "/v2/subscriptions/offerings/{offering_uuid}/products" }));
|
|
2930
|
-
};
|
|
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>;
|
|
2931
2263
|
/**
|
|
2932
2264
|
* List subscriptions
|
|
2933
2265
|
* Retrieves a list of all subscriptions.
|
|
@@ -2955,129 +2287,74 @@ export var listOfferingProducts = function (options) {
|
|
|
2955
2287
|
* See [Characteristics of Include Parameter](/guides/Getting-Started/includes#characteristics-of-include-parameter).
|
|
2956
2288
|
*
|
|
2957
2289
|
*/
|
|
2958
|
-
|
|
2959
|
-
|
|
2960
|
-
|
|
2961
|
-
|
|
2962
|
-
|
|
2963
|
-
type: "http",
|
|
2964
|
-
},
|
|
2965
|
-
], url: "/v2/subscriptions/subscriptions" }));
|
|
2966
|
-
};
|
|
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>;
|
|
2967
2295
|
/**
|
|
2968
2296
|
* Get subscription
|
|
2969
2297
|
*/
|
|
2970
|
-
|
|
2971
|
-
|
|
2972
|
-
|
|
2973
|
-
|
|
2974
|
-
scheme: "bearer",
|
|
2975
|
-
type: "http",
|
|
2976
|
-
},
|
|
2977
|
-
], url: "/v2/subscriptions/subscriptions/{subscription_uuid}" }));
|
|
2978
|
-
};
|
|
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>;
|
|
2979
2302
|
/**
|
|
2980
2303
|
* List subscription products
|
|
2981
2304
|
* Retrieves a list of products associated with the specified subscription.
|
|
2982
2305
|
*/
|
|
2983
|
-
|
|
2984
|
-
|
|
2985
|
-
|
|
2986
|
-
{
|
|
2987
|
-
scheme: "bearer",
|
|
2988
|
-
type: "http",
|
|
2989
|
-
},
|
|
2990
|
-
], url: "/v2/subscriptions/subscriptions/{subscription_uuid}/products" }));
|
|
2991
|
-
};
|
|
2306
|
+
declare const listSubscriptionProducts: <ThrowOnError extends boolean = false>(options: Options<ListSubscriptionProductsData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<{
|
|
2307
|
+
data?: Array<OfferingProduct>;
|
|
2308
|
+
}, SubscriptionsErrorResponse, ThrowOnError>;
|
|
2992
2309
|
/**
|
|
2993
2310
|
* List subscription plans
|
|
2994
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.
|
|
2995
2312
|
*/
|
|
2996
|
-
|
|
2997
|
-
|
|
2998
|
-
|
|
2999
|
-
{
|
|
3000
|
-
scheme: "bearer",
|
|
3001
|
-
type: "http",
|
|
3002
|
-
},
|
|
3003
|
-
], url: "/v2/subscriptions/subscriptions/{subscription_uuid}/plans" }));
|
|
3004
|
-
};
|
|
2313
|
+
declare const listSubscriptionPlans: <ThrowOnError extends boolean = false>(options: Options<ListSubscriptionPlansData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<{
|
|
2314
|
+
data?: Array<OfferingPlan>;
|
|
2315
|
+
}, SubscriptionsErrorResponse, ThrowOnError>;
|
|
3005
2316
|
/**
|
|
3006
2317
|
* List subscription states
|
|
3007
2318
|
*/
|
|
3008
|
-
|
|
3009
|
-
|
|
3010
|
-
|
|
3011
|
-
{
|
|
3012
|
-
scheme: "bearer",
|
|
3013
|
-
type: "http",
|
|
3014
|
-
},
|
|
3015
|
-
], url: "/v2/subscriptions/subscriptions/{subscription_uuid}/states" }));
|
|
3016
|
-
};
|
|
2319
|
+
declare const listSubscriptionStates: <ThrowOnError extends boolean = false>(options: Options<ListSubscriptionStatesData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<{
|
|
2320
|
+
data?: Array<SubscriptionState>;
|
|
2321
|
+
}, SubscriptionsErrorResponse, ThrowOnError>;
|
|
3017
2322
|
/**
|
|
3018
2323
|
* Get subscription state
|
|
3019
2324
|
*/
|
|
3020
|
-
|
|
3021
|
-
|
|
3022
|
-
|
|
3023
|
-
{
|
|
3024
|
-
scheme: "bearer",
|
|
3025
|
-
type: "http",
|
|
3026
|
-
},
|
|
3027
|
-
], url: "/v2/subscriptions/subscriptions/{subscription_uuid}/states/{state_uuid}" }));
|
|
3028
|
-
};
|
|
2325
|
+
declare const getSubscriptionState: <ThrowOnError extends boolean = false>(options: Options<GetSubscriptionStateData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<{
|
|
2326
|
+
data?: SubscriptionState;
|
|
2327
|
+
}, SubscriptionsErrorResponse, ThrowOnError>;
|
|
3029
2328
|
/**
|
|
3030
2329
|
* List subscription invoices
|
|
3031
2330
|
* Lists all invoices for a given subscription.
|
|
3032
2331
|
*/
|
|
3033
|
-
|
|
3034
|
-
|
|
3035
|
-
|
|
3036
|
-
|
|
3037
|
-
scheme: "bearer",
|
|
3038
|
-
type: "http",
|
|
3039
|
-
},
|
|
3040
|
-
], url: "/v2/subscriptions/subscriptions/{subscription_uuid}/invoices" }));
|
|
3041
|
-
};
|
|
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>;
|
|
3042
2336
|
/**
|
|
3043
2337
|
* List subscription invoice payments
|
|
3044
2338
|
* Lists all invoice payments for a given invoice.
|
|
3045
2339
|
*/
|
|
3046
|
-
|
|
3047
|
-
|
|
3048
|
-
|
|
3049
|
-
|
|
3050
|
-
scheme: "bearer",
|
|
3051
|
-
type: "http",
|
|
3052
|
-
},
|
|
3053
|
-
], url: "/v2/subscriptions/subscriptions/{subscription_uuid}/invoices/{invoice_uuid}/payments" }));
|
|
3054
|
-
};
|
|
2340
|
+
declare const listSubscriptionInvoicePayments: <ThrowOnError extends boolean = false>(options: Options<ListSubscriptionInvoicePaymentsData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<{
|
|
2341
|
+
data?: Array<SubscriptionInvoicePayment>;
|
|
2342
|
+
links?: Links2;
|
|
2343
|
+
}, unknown, ThrowOnError>;
|
|
3055
2344
|
/**
|
|
3056
2345
|
* Get subscription invoice payment
|
|
3057
2346
|
* Gets a specific payment for a given invoice.
|
|
3058
2347
|
*/
|
|
3059
|
-
|
|
3060
|
-
|
|
3061
|
-
|
|
3062
|
-
{
|
|
3063
|
-
scheme: "bearer",
|
|
3064
|
-
type: "http",
|
|
3065
|
-
},
|
|
3066
|
-
], url: "/v2/subscriptions/subscriptions/{subscription_uuid}/invoices/{invoice_uuid}/payments/{payment_uuid}" }));
|
|
3067
|
-
};
|
|
2348
|
+
declare const getSubscriptionInvoicePayment: <ThrowOnError extends boolean = false>(options: Options<GetSubscriptionInvoicePaymentData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<{
|
|
2349
|
+
data?: SubscriptionInvoicePayment;
|
|
2350
|
+
}, SubscriptionsErrorResponse, ThrowOnError>;
|
|
3068
2351
|
/**
|
|
3069
2352
|
* Get subscription invoice
|
|
3070
2353
|
* Gets a specific invoice for a given subscription.
|
|
3071
2354
|
*/
|
|
3072
|
-
|
|
3073
|
-
|
|
3074
|
-
|
|
3075
|
-
{
|
|
3076
|
-
scheme: "bearer",
|
|
3077
|
-
type: "http",
|
|
3078
|
-
},
|
|
3079
|
-
], url: "/v2/subscriptions/subscriptions/{subscription_uuid}/invoices/{invoice_uuid}" }));
|
|
3080
|
-
};
|
|
2355
|
+
declare const getSubscriptionInvoice: <ThrowOnError extends boolean = false>(options: Options<GetSubscriptionInvoiceData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<{
|
|
2356
|
+
data?: SubscriptionInvoice;
|
|
2357
|
+
}, SubscriptionsErrorResponse, ThrowOnError>;
|
|
3081
2358
|
/**
|
|
3082
2359
|
* List invoices
|
|
3083
2360
|
* Retrieves a list of all invoices.
|
|
@@ -3093,65 +2370,37 @@ export var getSubscriptionInvoice = function (options) {
|
|
|
3093
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. |
|
|
3094
2371
|
*
|
|
3095
2372
|
*/
|
|
3096
|
-
|
|
3097
|
-
|
|
3098
|
-
|
|
3099
|
-
|
|
3100
|
-
scheme: "bearer",
|
|
3101
|
-
type: "http",
|
|
3102
|
-
},
|
|
3103
|
-
], url: "/v2/subscriptions/invoices" }));
|
|
3104
|
-
};
|
|
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>;
|
|
3105
2377
|
/**
|
|
3106
2378
|
* Get invoice
|
|
3107
2379
|
*/
|
|
3108
|
-
|
|
3109
|
-
|
|
3110
|
-
|
|
3111
|
-
{
|
|
3112
|
-
scheme: "bearer",
|
|
3113
|
-
type: "http",
|
|
3114
|
-
},
|
|
3115
|
-
], url: "/v2/subscriptions/invoices/{invoice_uuid}" }));
|
|
3116
|
-
};
|
|
2380
|
+
declare const getInvoice: <ThrowOnError extends boolean = false>(options: Options<GetInvoiceData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<{
|
|
2381
|
+
data?: SubscriptionInvoice;
|
|
2382
|
+
}, SubscriptionsErrorResponse, ThrowOnError>;
|
|
3117
2383
|
/**
|
|
3118
2384
|
* Get feature
|
|
3119
2385
|
*/
|
|
3120
|
-
|
|
3121
|
-
|
|
3122
|
-
|
|
3123
|
-
{
|
|
3124
|
-
scheme: "bearer",
|
|
3125
|
-
type: "http",
|
|
3126
|
-
},
|
|
3127
|
-
], url: "/v2/subscriptions/features/{feature_uuid}" }));
|
|
3128
|
-
};
|
|
2386
|
+
declare const getFeature: <ThrowOnError extends boolean = false>(options: Options<GetFeatureData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<{
|
|
2387
|
+
data?: Feature;
|
|
2388
|
+
}, SubscriptionsErrorResponse, ThrowOnError>;
|
|
3129
2389
|
/**
|
|
3130
2390
|
* Get Stock for Product
|
|
3131
2391
|
* Gets the stock for the product matching the specified unique identifier.
|
|
3132
2392
|
*/
|
|
3133
|
-
|
|
3134
|
-
|
|
3135
|
-
|
|
3136
|
-
{
|
|
3137
|
-
scheme: "bearer",
|
|
3138
|
-
type: "http",
|
|
3139
|
-
},
|
|
3140
|
-
], url: "/v2/inventories/{product_uuid}" }));
|
|
3141
|
-
};
|
|
2393
|
+
declare const getStock: <ThrowOnError extends boolean = false>(options: Options<GetStockData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<{
|
|
2394
|
+
data: StockResponse;
|
|
2395
|
+
}, InventoriesErrorResponse, ThrowOnError>;
|
|
3142
2396
|
/**
|
|
3143
2397
|
* List Locations
|
|
3144
2398
|
* Lists all Inventory Locations
|
|
3145
2399
|
*/
|
|
3146
|
-
|
|
3147
|
-
|
|
3148
|
-
|
|
3149
|
-
|
|
3150
|
-
scheme: "bearer",
|
|
3151
|
-
type: "http",
|
|
3152
|
-
},
|
|
3153
|
-
], url: "/v2/inventories/locations" }));
|
|
3154
|
-
};
|
|
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>;
|
|
3155
2404
|
/**
|
|
3156
2405
|
* Create an Access Token
|
|
3157
2406
|
*
|
|
@@ -3175,75 +2424,40 @@ export var listLocations = function (options) {
|
|
|
3175
2424
|
* :::
|
|
3176
2425
|
*
|
|
3177
2426
|
*/
|
|
3178
|
-
|
|
3179
|
-
var _a;
|
|
3180
|
-
return ((_a = options === null || options === void 0 ? void 0 : options.client) !== null && _a !== void 0 ? _a : client).post(__assign(__assign(__assign({}, options), urlSearchParamsBodySerializer), { headers: __assign({ "Content-Type": "application/x-www-form-urlencoded" }, options === null || options === void 0 ? void 0 : options.headers), url: "/oauth/access_token" }));
|
|
3181
|
-
};
|
|
2427
|
+
declare const createAnAccessToken: <ThrowOnError extends boolean = false>(options?: Options<CreateAnAccessTokenData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<AccessTokenResponse, ErrorResponse2, ThrowOnError>;
|
|
3182
2428
|
/**
|
|
3183
2429
|
* Get Account Addresses
|
|
3184
2430
|
* Get Account Addresses
|
|
3185
2431
|
*/
|
|
3186
|
-
|
|
3187
|
-
|
|
3188
|
-
|
|
3189
|
-
{
|
|
3190
|
-
scheme: "bearer",
|
|
3191
|
-
type: "http",
|
|
3192
|
-
},
|
|
3193
|
-
], url: "/v2/accounts/{accountID}/addresses" }));
|
|
3194
|
-
};
|
|
2432
|
+
declare const getV2AccountAddresses: <ThrowOnError extends boolean = false>(options: Options<GetV2AccountAddressesData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<{
|
|
2433
|
+
data?: Array<AccountAddressResponse>;
|
|
2434
|
+
}, AccountAddressesErrorResponse, ThrowOnError>;
|
|
3195
2435
|
/**
|
|
3196
2436
|
* Create an Account Address
|
|
3197
2437
|
* Create an Account Address
|
|
3198
2438
|
*/
|
|
3199
|
-
|
|
3200
|
-
|
|
3201
|
-
|
|
3202
|
-
{
|
|
3203
|
-
scheme: "bearer",
|
|
3204
|
-
type: "http",
|
|
3205
|
-
},
|
|
3206
|
-
], url: "/v2/accounts/{accountID}/addresses" }));
|
|
3207
|
-
};
|
|
2439
|
+
declare const postV2AccountAddress: <ThrowOnError extends boolean = false>(options: Options<PostV2AccountAddressData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<{
|
|
2440
|
+
data?: AccountAddressResponse;
|
|
2441
|
+
}, AccountAddressesErrorResponse, ThrowOnError>;
|
|
3208
2442
|
/**
|
|
3209
2443
|
* Delete an Account Address
|
|
3210
2444
|
* Delete a specific account within a store
|
|
3211
2445
|
*/
|
|
3212
|
-
|
|
3213
|
-
var _a;
|
|
3214
|
-
return ((_a = options === null || options === void 0 ? void 0 : options.client) !== null && _a !== void 0 ? _a : client).delete(__assign(__assign({}, options), { security: [
|
|
3215
|
-
{
|
|
3216
|
-
scheme: "bearer",
|
|
3217
|
-
type: "http",
|
|
3218
|
-
},
|
|
3219
|
-
], url: "/v2/accounts/{accountID}/addresses/{addressID}" }));
|
|
3220
|
-
};
|
|
2446
|
+
declare const deleteV2AccountAddress: <ThrowOnError extends boolean = false>(options: Options<DeleteV2AccountAddressData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<void, AccountAddressesErrorResponse, ThrowOnError>;
|
|
3221
2447
|
/**
|
|
3222
2448
|
* Get an Account Address
|
|
3223
2449
|
* Get an Account Addresses
|
|
3224
2450
|
*/
|
|
3225
|
-
|
|
3226
|
-
|
|
3227
|
-
|
|
3228
|
-
{
|
|
3229
|
-
scheme: "bearer",
|
|
3230
|
-
type: "http",
|
|
3231
|
-
},
|
|
3232
|
-
], url: "/v2/accounts/{accountID}/addresses/{addressID}" }));
|
|
3233
|
-
};
|
|
2451
|
+
declare const getV2AccountAddress: <ThrowOnError extends boolean = false>(options: Options<GetV2AccountAddressData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<{
|
|
2452
|
+
data?: AccountAddressResponse;
|
|
2453
|
+
}, AccountAddressesErrorResponse, ThrowOnError>;
|
|
3234
2454
|
/**
|
|
3235
2455
|
* Update an Account Address
|
|
3236
2456
|
* Update an Account Address
|
|
3237
2457
|
*/
|
|
3238
|
-
|
|
3239
|
-
|
|
3240
|
-
|
|
3241
|
-
{
|
|
3242
|
-
scheme: "bearer",
|
|
3243
|
-
type: "http",
|
|
3244
|
-
},
|
|
3245
|
-
], url: "/v2/accounts/{accountID}/addresses/{addressID}" }));
|
|
3246
|
-
};
|
|
2458
|
+
declare const putV2AccountAddress: <ThrowOnError extends boolean = false>(options: Options<PutV2AccountAddressData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<{
|
|
2459
|
+
data?: AccountAddressResponse;
|
|
2460
|
+
}, AccountAddressesErrorResponse, ThrowOnError>;
|
|
3247
2461
|
/**
|
|
3248
2462
|
* Get All Accounts
|
|
3249
2463
|
* Use this endpoint to Get all accounts.
|
|
@@ -3264,54 +2478,54 @@ export var putV2AccountAddress = function (options) {
|
|
|
3264
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")` |
|
|
3265
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")` |
|
|
3266
2480
|
*/
|
|
3267
|
-
|
|
3268
|
-
|
|
3269
|
-
|
|
3270
|
-
|
|
3271
|
-
|
|
3272
|
-
|
|
3273
|
-
|
|
3274
|
-
|
|
3275
|
-
|
|
2481
|
+
declare const getV2Accounts: <ThrowOnError extends boolean = false>(options?: Options<GetV2AccountsData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<{
|
|
2482
|
+
data?: Array<AccountResponse>;
|
|
2483
|
+
meta?: MetaList;
|
|
2484
|
+
links?: {
|
|
2485
|
+
current?: string;
|
|
2486
|
+
first?: string;
|
|
2487
|
+
last?: string;
|
|
2488
|
+
next?: string;
|
|
2489
|
+
prev?: string;
|
|
2490
|
+
};
|
|
2491
|
+
}, AccountManagementErrorResponse, ThrowOnError>;
|
|
3276
2492
|
/**
|
|
3277
2493
|
* Create an Account
|
|
3278
2494
|
* With the account creation endpoint, you have the ability to create accounts which can optionally have another account as a parent.
|
|
3279
2495
|
*/
|
|
3280
|
-
|
|
3281
|
-
|
|
3282
|
-
|
|
3283
|
-
{
|
|
3284
|
-
scheme: "bearer",
|
|
3285
|
-
type: "http",
|
|
3286
|
-
},
|
|
3287
|
-
], url: "/v2/accounts" }));
|
|
3288
|
-
};
|
|
2496
|
+
declare const postV2Accounts: <ThrowOnError extends boolean = false>(options?: Options<PostV2AccountsData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<{
|
|
2497
|
+
data?: AccountResponse;
|
|
2498
|
+
}, AccountManagementErrorResponse, ThrowOnError>;
|
|
3289
2499
|
/**
|
|
3290
2500
|
* Get an Account
|
|
3291
2501
|
* View a specific account contained within your store
|
|
3292
2502
|
*/
|
|
3293
|
-
|
|
3294
|
-
|
|
3295
|
-
|
|
3296
|
-
{
|
|
3297
|
-
scheme: "bearer",
|
|
3298
|
-
type: "http",
|
|
3299
|
-
},
|
|
3300
|
-
], url: "/v2/accounts/{accountID}" }));
|
|
3301
|
-
};
|
|
2503
|
+
declare const getV2AccountsAccountId: <ThrowOnError extends boolean = false>(options: Options<GetV2AccountsAccountIdData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<{
|
|
2504
|
+
data?: AccountResponse;
|
|
2505
|
+
}, AccountManagementErrorResponse, ThrowOnError>;
|
|
3302
2506
|
/**
|
|
3303
2507
|
* Update an Account
|
|
3304
2508
|
* Update the information contained on an account.
|
|
3305
2509
|
*/
|
|
3306
|
-
|
|
3307
|
-
|
|
3308
|
-
|
|
3309
|
-
|
|
3310
|
-
|
|
3311
|
-
|
|
3312
|
-
|
|
3313
|
-
|
|
3314
|
-
|
|
2510
|
+
declare const putV2AccountsAccountId: <ThrowOnError extends boolean = false>(options: Options<PutV2AccountsAccountIdData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<{
|
|
2511
|
+
data?: {
|
|
2512
|
+
id?: string;
|
|
2513
|
+
type?: string;
|
|
2514
|
+
name?: string;
|
|
2515
|
+
legal_name?: string;
|
|
2516
|
+
registration_id?: string;
|
|
2517
|
+
external_ref?: string;
|
|
2518
|
+
meta?: {
|
|
2519
|
+
timestamps?: {
|
|
2520
|
+
created_at?: Date;
|
|
2521
|
+
updated_at?: Date;
|
|
2522
|
+
};
|
|
2523
|
+
};
|
|
2524
|
+
links?: {
|
|
2525
|
+
self?: string;
|
|
2526
|
+
};
|
|
2527
|
+
};
|
|
2528
|
+
}, PutV2AccountsAccountIdError, ThrowOnError>;
|
|
3315
2529
|
/**
|
|
3316
2530
|
* Get all Account Members
|
|
3317
2531
|
* Get all account members contained within your store.
|
|
@@ -3326,28 +2540,24 @@ export var putV2AccountsAccountId = function (options) {
|
|
|
3326
2540
|
* | `name` | `string` | `eq` / `like` | `like(name,*swan*)` |
|
|
3327
2541
|
*
|
|
3328
2542
|
*/
|
|
3329
|
-
|
|
3330
|
-
|
|
3331
|
-
|
|
3332
|
-
|
|
3333
|
-
|
|
3334
|
-
|
|
3335
|
-
|
|
3336
|
-
|
|
3337
|
-
|
|
2543
|
+
declare const getV2AccountMembers: <ThrowOnError extends boolean = false>(options?: Options<GetV2AccountMembersData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<{
|
|
2544
|
+
data?: Array<AccountMemberResponse>;
|
|
2545
|
+
meta?: MetaList;
|
|
2546
|
+
links?: {
|
|
2547
|
+
current?: string;
|
|
2548
|
+
first?: string;
|
|
2549
|
+
last?: string;
|
|
2550
|
+
next?: string;
|
|
2551
|
+
prev?: string;
|
|
2552
|
+
};
|
|
2553
|
+
}, AccountManagementErrorResponse, ThrowOnError>;
|
|
3338
2554
|
/**
|
|
3339
2555
|
* Get an Account Member
|
|
3340
2556
|
* Get an account member from your store
|
|
3341
2557
|
*/
|
|
3342
|
-
|
|
3343
|
-
|
|
3344
|
-
|
|
3345
|
-
{
|
|
3346
|
-
scheme: "bearer",
|
|
3347
|
-
type: "http",
|
|
3348
|
-
},
|
|
3349
|
-
], url: "/v2/account-members/{accountMemberID}" }));
|
|
3350
|
-
};
|
|
2558
|
+
declare const getV2AccountMembersAccountMemberId: <ThrowOnError extends boolean = false>(options: Options<GetV2AccountMembersAccountMemberIdData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<{
|
|
2559
|
+
data?: AccountMemberResponse;
|
|
2560
|
+
}, AccountManagementErrorResponse, ThrowOnError>;
|
|
3351
2561
|
/**
|
|
3352
2562
|
* Get all Account Memberships
|
|
3353
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).
|
|
@@ -3365,15 +2575,17 @@ export var getV2AccountMembersAccountMemberId = function (options) {
|
|
|
3365
2575
|
* | :--- | :--- | :--- | :--- |
|
|
3366
2576
|
* | `account_member_id` | `string` | `eq` / `like` | `eq(account_member_id,00000000-0000-1000-8000-0000000)` |
|
|
3367
2577
|
*/
|
|
3368
|
-
|
|
3369
|
-
|
|
3370
|
-
|
|
3371
|
-
|
|
3372
|
-
|
|
3373
|
-
|
|
3374
|
-
|
|
3375
|
-
|
|
3376
|
-
|
|
2578
|
+
declare const getV2AccountsAccountIdAccountMemberships: <ThrowOnError extends boolean = false>(options: Options<GetV2AccountsAccountIdAccountMembershipsData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<{
|
|
2579
|
+
data?: Array<AccountMembershipResponse>;
|
|
2580
|
+
meta?: MetaList;
|
|
2581
|
+
links?: {
|
|
2582
|
+
current?: string;
|
|
2583
|
+
first?: string;
|
|
2584
|
+
last?: string;
|
|
2585
|
+
next?: string;
|
|
2586
|
+
prev?: string;
|
|
2587
|
+
};
|
|
2588
|
+
}, AccountManagementErrorResponse, ThrowOnError>;
|
|
3377
2589
|
/**
|
|
3378
2590
|
* Generate an Account Management Authentication Token
|
|
3379
2591
|
* Commerce provides authentication tokens for anyone using the Account Management APIs, including accounts and account members.
|
|
@@ -3391,15 +2603,19 @@ export var getV2AccountsAccountIdAccountMemberships = function (options) {
|
|
|
3391
2603
|
* - Switch account token
|
|
3392
2604
|
*
|
|
3393
2605
|
*/
|
|
3394
|
-
|
|
3395
|
-
|
|
3396
|
-
|
|
3397
|
-
|
|
3398
|
-
|
|
3399
|
-
|
|
3400
|
-
|
|
3401
|
-
|
|
3402
|
-
|
|
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;
|
|
2610
|
+
};
|
|
2611
|
+
links?: {
|
|
2612
|
+
current?: string;
|
|
2613
|
+
first?: string;
|
|
2614
|
+
last?: string;
|
|
2615
|
+
next?: string;
|
|
2616
|
+
prev?: string;
|
|
2617
|
+
};
|
|
2618
|
+
}, AccountManagementErrorResponse, ThrowOnError>;
|
|
3403
2619
|
/**
|
|
3404
2620
|
* Get all Currencies
|
|
3405
2621
|
* :::caution
|
|
@@ -3409,15 +2625,9 @@ export var postV2AccountMembersTokens = function (options) {
|
|
|
3409
2625
|
* :::
|
|
3410
2626
|
*
|
|
3411
2627
|
*/
|
|
3412
|
-
|
|
3413
|
-
|
|
3414
|
-
|
|
3415
|
-
{
|
|
3416
|
-
scheme: "bearer",
|
|
3417
|
-
type: "http",
|
|
3418
|
-
},
|
|
3419
|
-
], url: "/v2/currencies" }));
|
|
3420
|
-
};
|
|
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>;
|
|
3421
2631
|
/**
|
|
3422
2632
|
* Get a Currency
|
|
3423
2633
|
* :::caution
|
|
@@ -3427,15 +2637,9 @@ export var getAllCurrencies = function (options) {
|
|
|
3427
2637
|
* :::
|
|
3428
2638
|
*
|
|
3429
2639
|
*/
|
|
3430
|
-
|
|
3431
|
-
|
|
3432
|
-
|
|
3433
|
-
{
|
|
3434
|
-
scheme: "bearer",
|
|
3435
|
-
type: "http",
|
|
3436
|
-
},
|
|
3437
|
-
], url: "/v2/currencies/{currencyID}" }));
|
|
3438
|
-
};
|
|
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>;
|
|
3439
2643
|
/**
|
|
3440
2644
|
* Get all Files
|
|
3441
2645
|
* Retrieves all files.
|
|
@@ -3454,25 +2658,17 @@ export var getACurrency = function (options) {
|
|
|
3454
2658
|
* | `file_size` | `integer` | `gt` / `ge` / `lt` / `le` | `le(file_size,20953)` |
|
|
3455
2659
|
*
|
|
3456
2660
|
*/
|
|
3457
|
-
|
|
3458
|
-
|
|
3459
|
-
|
|
3460
|
-
|
|
3461
|
-
|
|
3462
|
-
type: "http",
|
|
3463
|
-
},
|
|
3464
|
-
], url: "/v2/files" }));
|
|
3465
|
-
};
|
|
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>;
|
|
3466
2666
|
/**
|
|
3467
2667
|
* Get a File
|
|
3468
2668
|
* Get a File
|
|
3469
2669
|
*/
|
|
3470
|
-
|
|
3471
|
-
|
|
3472
|
-
|
|
3473
|
-
|
|
3474
|
-
|
|
3475
|
-
type: "http",
|
|
3476
|
-
},
|
|
3477
|
-
], url: "/v2/files/{fileID}" }));
|
|
3478
|
-
};
|
|
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 };
|