@epcc-sdk/sdks-shopper 0.0.42 → 0.1.0
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/README.md +105 -73
- package/dist/client/@tanstack/react-query.gen.cjs +36 -2
- package/dist/client/@tanstack/react-query.gen.cjs.map +1 -1
- package/dist/client/@tanstack/react-query.gen.d.cts +24 -2
- package/dist/client/@tanstack/react-query.gen.d.ts +24 -2
- package/dist/client/@tanstack/react-query.gen.mjs +33 -1
- package/dist/client/@tanstack/react-query.gen.mjs.map +1 -1
- package/dist/client/index.d.cts +2 -2
- package/dist/client/index.d.ts +2 -2
- package/dist/client/sdk.gen.cjs +20 -2
- package/dist/client/sdk.gen.cjs.map +1 -1
- package/dist/client/sdk.gen.d.cts +11 -4
- package/dist/client/sdk.gen.d.ts +11 -4
- package/dist/client/sdk.gen.mjs +18 -1
- package/dist/client/sdk.gen.mjs.map +1 -1
- package/dist/client/transformers.gen.cjs +22 -2
- package/dist/client/transformers.gen.cjs.map +1 -1
- package/dist/client/transformers.gen.d.cts +3 -2
- package/dist/client/transformers.gen.d.ts +3 -2
- package/dist/client/transformers.gen.mjs +20 -1
- package/dist/client/transformers.gen.mjs.map +1 -1
- package/dist/client/types.gen.cjs.map +1 -1
- package/dist/client/types.gen.d.cts +320 -53
- package/dist/client/types.gen.d.ts +320 -53
- package/dist/index.d.cts +2 -2
- package/dist/index.d.ts +2 -2
- package/dist/react-query.d.cts +1 -1
- package/dist/react-query.d.ts +1 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -339,7 +339,7 @@ const result: GetByContextReleaseResponse = await getByContextRelease(params);
|
|
|
339
339
|
|
|
340
340
|
**Summary:** Get all Hierarchies
|
|
341
341
|
|
|
342
|
-
**Description:**
|
|
342
|
+
**Description:** GET operation
|
|
343
343
|
|
|
344
344
|
**TypeScript Example:**
|
|
345
345
|
|
|
@@ -369,7 +369,7 @@ const result: GetByContextAllHierarchiesResponse = await getByContextAllHierarch
|
|
|
369
369
|
|
|
370
370
|
**Summary:** Get a Hierarchy
|
|
371
371
|
|
|
372
|
-
**Description:**
|
|
372
|
+
**Description:** GET operation
|
|
373
373
|
|
|
374
374
|
**TypeScript Example:**
|
|
375
375
|
|
|
@@ -397,7 +397,7 @@ const result: GetByContextHierarchyResponse = await getByContextHierarchy(params
|
|
|
397
397
|
|
|
398
398
|
**Summary:** Get a Hierarchy's Nodes
|
|
399
399
|
|
|
400
|
-
**Description:**
|
|
400
|
+
**Description:** GET operation
|
|
401
401
|
|
|
402
402
|
**TypeScript Example:**
|
|
403
403
|
|
|
@@ -430,7 +430,7 @@ const result: GetByContextHierarchyNodesResponse = await getByContextHierarchyNo
|
|
|
430
430
|
|
|
431
431
|
**Summary:** Get a Hierarchy's Children
|
|
432
432
|
|
|
433
|
-
**Description:**
|
|
433
|
+
**Description:** GET operation
|
|
434
434
|
|
|
435
435
|
**TypeScript Example:**
|
|
436
436
|
|
|
@@ -463,7 +463,7 @@ const result: GetByContextHierarchyChildNodesResponse = await getByContextHierar
|
|
|
463
463
|
|
|
464
464
|
**Summary:** Get all Nodes
|
|
465
465
|
|
|
466
|
-
**Description:**
|
|
466
|
+
**Description:** GET operation
|
|
467
467
|
|
|
468
468
|
**TypeScript Example:**
|
|
469
469
|
|
|
@@ -493,7 +493,7 @@ const result: GetByContextAllNodesResponse = await getByContextAllNodes(params);
|
|
|
493
493
|
|
|
494
494
|
**Summary:** Get a Node
|
|
495
495
|
|
|
496
|
-
**Description:**
|
|
496
|
+
**Description:** GET operation
|
|
497
497
|
|
|
498
498
|
**TypeScript Example:**
|
|
499
499
|
|
|
@@ -521,7 +521,7 @@ const result: GetByContextNodeResponse = await getByContextNode(params);
|
|
|
521
521
|
|
|
522
522
|
**Summary:** Get a Node's Children
|
|
523
523
|
|
|
524
|
-
**Description:**
|
|
524
|
+
**Description:** GET operation
|
|
525
525
|
|
|
526
526
|
**TypeScript Example:**
|
|
527
527
|
|
|
@@ -554,7 +554,7 @@ const result: GetByContextChildNodesResponse = await getByContextChildNodes(para
|
|
|
554
554
|
|
|
555
555
|
**Summary:** Get all Products
|
|
556
556
|
|
|
557
|
-
**Description:**
|
|
557
|
+
**Description:** GET operation
|
|
558
558
|
|
|
559
559
|
**TypeScript Example:**
|
|
560
560
|
|
|
@@ -584,7 +584,7 @@ const result: GetByContextAllProductsResponse = await getByContextAllProducts(pa
|
|
|
584
584
|
|
|
585
585
|
**Summary:** Get a Product
|
|
586
586
|
|
|
587
|
-
**Description:**
|
|
587
|
+
**Description:** GET operation
|
|
588
588
|
|
|
589
589
|
**TypeScript Example:**
|
|
590
590
|
|
|
@@ -650,7 +650,7 @@ const result: GetByContextAllRelatedProductsResponse = await getByContextAllRela
|
|
|
650
650
|
|
|
651
651
|
**Summary:** Get a Bundle's Component Products
|
|
652
652
|
|
|
653
|
-
**Description:**
|
|
653
|
+
**Description:** GET operation
|
|
654
654
|
|
|
655
655
|
**TypeScript Example:**
|
|
656
656
|
|
|
@@ -682,7 +682,7 @@ const result: GetByContextComponentProductIdsResponse = await getByContextCompon
|
|
|
682
682
|
|
|
683
683
|
**Summary:** Get a Parent Product's Child Products
|
|
684
684
|
|
|
685
|
-
**Description:**
|
|
685
|
+
**Description:** GET operation
|
|
686
686
|
|
|
687
687
|
**TypeScript Example:**
|
|
688
688
|
|
|
@@ -715,7 +715,7 @@ const result: GetByContextChildProductsResponse = await getByContextChildProduct
|
|
|
715
715
|
|
|
716
716
|
**Summary:** Get a Hierarchy's Products
|
|
717
717
|
|
|
718
|
-
**Description:**
|
|
718
|
+
**Description:** GET operation
|
|
719
719
|
|
|
720
720
|
**TypeScript Example:**
|
|
721
721
|
|
|
@@ -748,7 +748,7 @@ const result: GetByContextProductsForHierarchyResponse = await getByContextProdu
|
|
|
748
748
|
|
|
749
749
|
**Summary:** Get a Node's Products
|
|
750
750
|
|
|
751
|
-
**Description:**
|
|
751
|
+
**Description:** GET operation
|
|
752
752
|
|
|
753
753
|
**TypeScript Example:**
|
|
754
754
|
|
|
@@ -781,7 +781,7 @@ const result: GetByContextProductsForNodeResponse = await getByContextProductsFo
|
|
|
781
781
|
|
|
782
782
|
**Summary:** Configure a Shopper Bundle
|
|
783
783
|
|
|
784
|
-
**Description:**
|
|
784
|
+
**Description:** POST operation
|
|
785
785
|
|
|
786
786
|
**TypeScript Example:**
|
|
787
787
|
|
|
@@ -817,7 +817,7 @@ const result: ConfigureByContextProductResponse = await configureByContextProduc
|
|
|
817
817
|
|
|
818
818
|
**Summary:** Gets all authorized catalogs
|
|
819
819
|
|
|
820
|
-
**Description:**
|
|
820
|
+
**Description:** GET operation
|
|
821
821
|
|
|
822
822
|
**TypeScript Example:**
|
|
823
823
|
|
|
@@ -843,7 +843,7 @@ const result: GetCatalogsResponse = await getCatalogs(params);
|
|
|
843
843
|
|
|
844
844
|
**Summary:** Creates a new catalog
|
|
845
845
|
|
|
846
|
-
**Description:**
|
|
846
|
+
**Description:** POST operation
|
|
847
847
|
|
|
848
848
|
**TypeScript Example:**
|
|
849
849
|
|
|
@@ -873,7 +873,7 @@ const result: CreateCatalogResponse = await createCatalog(params);
|
|
|
873
873
|
|
|
874
874
|
**Summary:** Deletes a catalog
|
|
875
875
|
|
|
876
|
-
**Description:**
|
|
876
|
+
**Description:** DELETE operation
|
|
877
877
|
|
|
878
878
|
**TypeScript Example:**
|
|
879
879
|
|
|
@@ -921,7 +921,7 @@ const result: GetCatalogByIdResponse = await getCatalogById(params);
|
|
|
921
921
|
|
|
922
922
|
**Summary:** Updates a catalog
|
|
923
923
|
|
|
924
|
-
**Description:**
|
|
924
|
+
**Description:** PUT operation
|
|
925
925
|
|
|
926
926
|
**TypeScript Example:**
|
|
927
927
|
|
|
@@ -978,7 +978,7 @@ const result: DeleteReleasesResponse = await deleteReleases(params);
|
|
|
978
978
|
|
|
979
979
|
**Summary:** Gets all authorized catalog releases
|
|
980
980
|
|
|
981
|
-
**Description:**
|
|
981
|
+
**Description:** GET operation
|
|
982
982
|
|
|
983
983
|
**TypeScript Example:**
|
|
984
984
|
|
|
@@ -1005,7 +1005,7 @@ const result: GetReleasesResponse = await getReleases(params);
|
|
|
1005
1005
|
|
|
1006
1006
|
**Summary:** Publishes a catalog
|
|
1007
1007
|
|
|
1008
|
-
**Description:**
|
|
1008
|
+
**Description:** POST operation
|
|
1009
1009
|
|
|
1010
1010
|
**TypeScript Example:**
|
|
1011
1011
|
|
|
@@ -1087,7 +1087,7 @@ const result: GetReleaseByIdResponse = await getReleaseById(params);
|
|
|
1087
1087
|
|
|
1088
1088
|
**Summary:** Gets all authorized catalog rules
|
|
1089
1089
|
|
|
1090
|
-
**Description:**
|
|
1090
|
+
**Description:** GET operation
|
|
1091
1091
|
|
|
1092
1092
|
**TypeScript Example:**
|
|
1093
1093
|
|
|
@@ -1113,7 +1113,7 @@ const result: GetRulesResponse = await getRules(params);
|
|
|
1113
1113
|
|
|
1114
1114
|
**Summary:** Creates a new catalog rule
|
|
1115
1115
|
|
|
1116
|
-
**Description:**
|
|
1116
|
+
**Description:** POST operation
|
|
1117
1117
|
|
|
1118
1118
|
**TypeScript Example:**
|
|
1119
1119
|
|
|
@@ -1191,7 +1191,7 @@ const result: GetRuleByIdResponse = await getRuleById(params);
|
|
|
1191
1191
|
|
|
1192
1192
|
**Summary:** Updates a catalog rule
|
|
1193
1193
|
|
|
1194
|
-
**Description:**
|
|
1194
|
+
**Description:** PUT operation
|
|
1195
1195
|
|
|
1196
1196
|
**TypeScript Example:**
|
|
1197
1197
|
|
|
@@ -1218,13 +1218,44 @@ const result: UpdateRuleResponse = await updateRule(params);
|
|
|
1218
1218
|
|
|
1219
1219
|
---
|
|
1220
1220
|
|
|
1221
|
+
### **`validateCatalogRules`**
|
|
1222
|
+
|
|
1223
|
+
**Endpoint:** `POST /catalogs/rules/validate`
|
|
1224
|
+
|
|
1225
|
+
**Summary:** Validate catalog rules for a given context
|
|
1226
|
+
|
|
1227
|
+
**Description:** Validates catalog rules for a given context and returns a list of matching catalog rules.
|
|
1228
|
+
|
|
1229
|
+
|
|
1230
|
+
**TypeScript Example:**
|
|
1231
|
+
|
|
1232
|
+
```typescript
|
|
1233
|
+
import { validateCatalogRules, type ValidateCatalogRulesData, type ValidateCatalogRulesResponse } from "@epcc-sdk/sdks-shopper";
|
|
1234
|
+
|
|
1235
|
+
const params: ValidateCatalogRulesData = {
|
|
1236
|
+
query: {
|
|
1237
|
+
"page[limit]": 10, // OPTIONAL
|
|
1238
|
+
"page[offset]": 0, // OPTIONAL
|
|
1239
|
+
},
|
|
1240
|
+
body: {
|
|
1241
|
+
data: {
|
|
1242
|
+
type: "resource"
|
|
1243
|
+
}
|
|
1244
|
+
},
|
|
1245
|
+
};
|
|
1246
|
+
|
|
1247
|
+
const result: ValidateCatalogRulesResponse = await validateCatalogRules(params);
|
|
1248
|
+
```
|
|
1249
|
+
|
|
1250
|
+
---
|
|
1251
|
+
|
|
1221
1252
|
### **`getAllHierarchies`**
|
|
1222
1253
|
|
|
1223
1254
|
**Endpoint:** `GET /catalogs/{catalog_id}/releases/{release_id}/hierarchies`
|
|
1224
1255
|
|
|
1225
1256
|
**Summary:** Get all Hierarchies
|
|
1226
1257
|
|
|
1227
|
-
**Description:**
|
|
1258
|
+
**Description:** GET operation
|
|
1228
1259
|
|
|
1229
1260
|
**TypeScript Example:**
|
|
1230
1261
|
|
|
@@ -1257,7 +1288,7 @@ const result: GetAllHierarchiesResponse = await getAllHierarchies(params);
|
|
|
1257
1288
|
|
|
1258
1289
|
**Summary:** Get a Hierarchy
|
|
1259
1290
|
|
|
1260
|
-
**Description:**
|
|
1291
|
+
**Description:** GET operation
|
|
1261
1292
|
|
|
1262
1293
|
**TypeScript Example:**
|
|
1263
1294
|
|
|
@@ -1286,7 +1317,7 @@ const result: GetHierarchyResponse = await getHierarchy(params);
|
|
|
1286
1317
|
|
|
1287
1318
|
**Summary:** Get a Hierarchy's Nodes
|
|
1288
1319
|
|
|
1289
|
-
**Description:**
|
|
1320
|
+
**Description:** GET operation
|
|
1290
1321
|
|
|
1291
1322
|
**TypeScript Example:**
|
|
1292
1323
|
|
|
@@ -1320,7 +1351,7 @@ const result: GetHierarchyNodesResponse = await getHierarchyNodes(params);
|
|
|
1320
1351
|
|
|
1321
1352
|
**Summary:** Get a Hierarchy's Children
|
|
1322
1353
|
|
|
1323
|
-
**Description:**
|
|
1354
|
+
**Description:** GET operation
|
|
1324
1355
|
|
|
1325
1356
|
**TypeScript Example:**
|
|
1326
1357
|
|
|
@@ -1354,7 +1385,7 @@ const result: GetHierarchyChildNodesResponse = await getHierarchyChildNodes(para
|
|
|
1354
1385
|
|
|
1355
1386
|
**Summary:** Get all Nodes
|
|
1356
1387
|
|
|
1357
|
-
**Description:**
|
|
1388
|
+
**Description:** GET operation
|
|
1358
1389
|
|
|
1359
1390
|
**TypeScript Example:**
|
|
1360
1391
|
|
|
@@ -1387,7 +1418,7 @@ const result: GetAllNodesResponse = await getAllNodes(params);
|
|
|
1387
1418
|
|
|
1388
1419
|
**Summary:** Get a Node
|
|
1389
1420
|
|
|
1390
|
-
**Description:**
|
|
1421
|
+
**Description:** GET operation
|
|
1391
1422
|
|
|
1392
1423
|
**TypeScript Example:**
|
|
1393
1424
|
|
|
@@ -1416,7 +1447,7 @@ const result: GetNodeResponse = await getNode(params);
|
|
|
1416
1447
|
|
|
1417
1448
|
**Summary:** Get a Node's Children
|
|
1418
1449
|
|
|
1419
|
-
**Description:**
|
|
1450
|
+
**Description:** GET operation
|
|
1420
1451
|
|
|
1421
1452
|
**TypeScript Example:**
|
|
1422
1453
|
|
|
@@ -1450,7 +1481,7 @@ const result: GetChildNodesResponse = await getChildNodes(params);
|
|
|
1450
1481
|
|
|
1451
1482
|
**Summary:** Get all Products
|
|
1452
1483
|
|
|
1453
|
-
**Description:**
|
|
1484
|
+
**Description:** GET operation
|
|
1454
1485
|
|
|
1455
1486
|
**TypeScript Example:**
|
|
1456
1487
|
|
|
@@ -1484,7 +1515,7 @@ const result: GetAllProductsResponse = await getAllProducts(params);
|
|
|
1484
1515
|
|
|
1485
1516
|
**Summary:** Get a Product
|
|
1486
1517
|
|
|
1487
|
-
**Description:**
|
|
1518
|
+
**Description:** GET operation
|
|
1488
1519
|
|
|
1489
1520
|
**TypeScript Example:**
|
|
1490
1521
|
|
|
@@ -1554,7 +1585,7 @@ const result: GetAllRelatedProductsResponse = await getAllRelatedProducts(params
|
|
|
1554
1585
|
|
|
1555
1586
|
**Summary:** Get a Bundle's Component Products
|
|
1556
1587
|
|
|
1557
|
-
**Description:**
|
|
1588
|
+
**Description:** GET operation
|
|
1558
1589
|
|
|
1559
1590
|
**TypeScript Example:**
|
|
1560
1591
|
|
|
@@ -1574,6 +1605,7 @@ const params: GetComponentProductIdsData = {
|
|
|
1574
1605
|
},
|
|
1575
1606
|
headers: {
|
|
1576
1607
|
"EP-Pricebook-IDs-For-Price-Segmentation-Preview": "header-value", // OPTIONAL
|
|
1608
|
+
"EP-Pricebook-IDs-Of-Available-Prices-To-Show": "header-value", // OPTIONAL
|
|
1577
1609
|
},
|
|
1578
1610
|
};
|
|
1579
1611
|
|
|
@@ -1588,7 +1620,7 @@ const result: GetComponentProductIdsResponse = await getComponentProductIds(para
|
|
|
1588
1620
|
|
|
1589
1621
|
**Summary:** Get a Parent Product's Child Products
|
|
1590
1622
|
|
|
1591
|
-
**Description:**
|
|
1623
|
+
**Description:** GET operation
|
|
1592
1624
|
|
|
1593
1625
|
**TypeScript Example:**
|
|
1594
1626
|
|
|
@@ -1608,7 +1640,7 @@ const params: GetChildProductsData = {
|
|
|
1608
1640
|
},
|
|
1609
1641
|
headers: {
|
|
1610
1642
|
"EP-Pricebook-IDs-For-Price-Segmentation-Preview": "header-value", // OPTIONAL
|
|
1611
|
-
"
|
|
1643
|
+
"EP-Pricebook-IDs-Of-Available-Prices-To-Show": "header-value", // OPTIONAL
|
|
1612
1644
|
},
|
|
1613
1645
|
};
|
|
1614
1646
|
|
|
@@ -1623,7 +1655,7 @@ const result: GetChildProductsResponse = await getChildProducts(params);
|
|
|
1623
1655
|
|
|
1624
1656
|
**Summary:** Get a Hierarchy's Products
|
|
1625
1657
|
|
|
1626
|
-
**Description:**
|
|
1658
|
+
**Description:** GET operation
|
|
1627
1659
|
|
|
1628
1660
|
**TypeScript Example:**
|
|
1629
1661
|
|
|
@@ -1658,7 +1690,7 @@ const result: GetProductsForHierarchyResponse = await getProductsForHierarchy(pa
|
|
|
1658
1690
|
|
|
1659
1691
|
**Summary:** Get a Node's Products
|
|
1660
1692
|
|
|
1661
|
-
**Description:**
|
|
1693
|
+
**Description:** GET operation
|
|
1662
1694
|
|
|
1663
1695
|
**TypeScript Example:**
|
|
1664
1696
|
|
|
@@ -1693,7 +1725,7 @@ const result: GetProductsForNodeResponse = await getProductsForNode(params);
|
|
|
1693
1725
|
|
|
1694
1726
|
**Summary:** Get Shopper Carts
|
|
1695
1727
|
|
|
1696
|
-
**Description:**
|
|
1728
|
+
**Description:** GET operation
|
|
1697
1729
|
|
|
1698
1730
|
**TypeScript Example:**
|
|
1699
1731
|
|
|
@@ -1717,7 +1749,7 @@ const result: GetCartsResponse = await getCarts(params);
|
|
|
1717
1749
|
|
|
1718
1750
|
**Summary:** Create a Cart
|
|
1719
1751
|
|
|
1720
|
-
**Description:**
|
|
1752
|
+
**Description:** POST operation
|
|
1721
1753
|
|
|
1722
1754
|
**TypeScript Example:**
|
|
1723
1755
|
|
|
@@ -1748,7 +1780,7 @@ const result: CreateACartResponse = await createACart(params);
|
|
|
1748
1780
|
|
|
1749
1781
|
**Summary:** Delete a Cart
|
|
1750
1782
|
|
|
1751
|
-
**Description:**
|
|
1783
|
+
**Description:** DELETE operation
|
|
1752
1784
|
|
|
1753
1785
|
**TypeScript Example:**
|
|
1754
1786
|
|
|
@@ -1772,7 +1804,7 @@ const result: DeleteACartResponse = await deleteACart(params);
|
|
|
1772
1804
|
|
|
1773
1805
|
**Summary:** Get a Cart
|
|
1774
1806
|
|
|
1775
|
-
**Description:**
|
|
1807
|
+
**Description:** GET operation
|
|
1776
1808
|
|
|
1777
1809
|
**TypeScript Example:**
|
|
1778
1810
|
|
|
@@ -1799,7 +1831,7 @@ const result: GetACartResponse = await getACart(params);
|
|
|
1799
1831
|
|
|
1800
1832
|
**Summary:** Update a Cart
|
|
1801
1833
|
|
|
1802
|
-
**Description:**
|
|
1834
|
+
**Description:** PUT operation
|
|
1803
1835
|
|
|
1804
1836
|
**TypeScript Example:**
|
|
1805
1837
|
|
|
@@ -1830,7 +1862,7 @@ const result: UpdateACartResponse = await updateACart(params);
|
|
|
1830
1862
|
|
|
1831
1863
|
**Summary:** Delete all Cart Items
|
|
1832
1864
|
|
|
1833
|
-
**Description:**
|
|
1865
|
+
**Description:** DELETE operation
|
|
1834
1866
|
|
|
1835
1867
|
**TypeScript Example:**
|
|
1836
1868
|
|
|
@@ -1854,7 +1886,7 @@ const result: DeleteAllCartItemsResponse = await deleteAllCartItems(params);
|
|
|
1854
1886
|
|
|
1855
1887
|
**Summary:** Get Cart Items
|
|
1856
1888
|
|
|
1857
|
-
**Description:**
|
|
1889
|
+
**Description:** GET operation
|
|
1858
1890
|
|
|
1859
1891
|
**TypeScript Example:**
|
|
1860
1892
|
|
|
@@ -1878,7 +1910,7 @@ const result: GetCartItemsResponse = await getCartItems(params);
|
|
|
1878
1910
|
|
|
1879
1911
|
**Summary:** Add Items to Cart
|
|
1880
1912
|
|
|
1881
|
-
**Description:**
|
|
1913
|
+
**Description:** POST operation
|
|
1882
1914
|
|
|
1883
1915
|
**TypeScript Example:**
|
|
1884
1916
|
|
|
@@ -1909,7 +1941,7 @@ const result: ManageCartsResponse = await manageCarts(params);
|
|
|
1909
1941
|
|
|
1910
1942
|
**Summary:** Bulk Update Items in Cart
|
|
1911
1943
|
|
|
1912
|
-
**Description:**
|
|
1944
|
+
**Description:** PUT operation
|
|
1913
1945
|
|
|
1914
1946
|
**TypeScript Example:**
|
|
1915
1947
|
|
|
@@ -2023,7 +2055,7 @@ const result: DeleteAccountCartAssociationResponse = await deleteAccountCartAsso
|
|
|
2023
2055
|
|
|
2024
2056
|
**Summary:** Create an Account Cart Association
|
|
2025
2057
|
|
|
2026
|
-
**Description:**
|
|
2058
|
+
**Description:** POST operation
|
|
2027
2059
|
|
|
2028
2060
|
**TypeScript Example:**
|
|
2029
2061
|
|
|
@@ -2081,7 +2113,7 @@ const result: DeleteCustomerCartAssociationResponse = await deleteCustomerCartAs
|
|
|
2081
2113
|
|
|
2082
2114
|
**Summary:** Create a Customer Cart Association
|
|
2083
2115
|
|
|
2084
|
-
**Description:**
|
|
2116
|
+
**Description:** POST operation
|
|
2085
2117
|
|
|
2086
2118
|
**TypeScript Example:**
|
|
2087
2119
|
|
|
@@ -2207,7 +2239,7 @@ const result: BulkDeleteTaxItemsFromCartResponse = await bulkDeleteTaxItemsFromC
|
|
|
2207
2239
|
|
|
2208
2240
|
**Summary:** Bulk Add Tax Items to Cart
|
|
2209
2241
|
|
|
2210
|
-
**Description:**
|
|
2242
|
+
**Description:** POST operation
|
|
2211
2243
|
|
|
2212
2244
|
**TypeScript Example:**
|
|
2213
2245
|
|
|
@@ -2325,7 +2357,7 @@ const result: BulkDeleteCustomDiscountsFromCartResponse = await bulkDeleteCustom
|
|
|
2325
2357
|
|
|
2326
2358
|
**Summary:** Bulk Add Custom Discounts to Cart
|
|
2327
2359
|
|
|
2328
|
-
**Description:**
|
|
2360
|
+
**Description:** POST operation
|
|
2329
2361
|
|
|
2330
2362
|
**TypeScript Example:**
|
|
2331
2363
|
|
|
@@ -2566,7 +2598,7 @@ const result: CreateShippingGroupResponse = await createShippingGroup(params);
|
|
|
2566
2598
|
|
|
2567
2599
|
**Summary:** Delete Cart Shipping Group
|
|
2568
2600
|
|
|
2569
|
-
**Description:**
|
|
2601
|
+
**Description:** DELETE operation
|
|
2570
2602
|
|
|
2571
2603
|
**TypeScript Example:**
|
|
2572
2604
|
|
|
@@ -2650,7 +2682,7 @@ const result: UpdateShippingGroupResponse = await updateShippingGroup(params);
|
|
|
2650
2682
|
|
|
2651
2683
|
**Summary:** Create Stripe Payment Intent for a Cart
|
|
2652
2684
|
|
|
2653
|
-
**Description:**
|
|
2685
|
+
**Description:** POST operation
|
|
2654
2686
|
|
|
2655
2687
|
**TypeScript Example:**
|
|
2656
2688
|
|
|
@@ -2713,7 +2745,7 @@ const result: UpdateCartPaymentIntentResponse = await updateCartPaymentIntent(pa
|
|
|
2713
2745
|
|
|
2714
2746
|
**Summary:** Checkout API
|
|
2715
2747
|
|
|
2716
|
-
**Description:**
|
|
2748
|
+
**Description:** POST operation
|
|
2717
2749
|
|
|
2718
2750
|
**TypeScript Example:**
|
|
2719
2751
|
|
|
@@ -2742,7 +2774,7 @@ const result: CheckoutApiResponse = await checkoutApi(params);
|
|
|
2742
2774
|
|
|
2743
2775
|
**Summary:** Get all Orders
|
|
2744
2776
|
|
|
2745
|
-
**Description:**
|
|
2777
|
+
**Description:** GET operation
|
|
2746
2778
|
|
|
2747
2779
|
**TypeScript Example:**
|
|
2748
2780
|
|
|
@@ -2798,7 +2830,7 @@ const result: GetAnOrderResponse = await getAnOrder(params);
|
|
|
2798
2830
|
|
|
2799
2831
|
**Summary:** Update an Order
|
|
2800
2832
|
|
|
2801
|
-
**Description:**
|
|
2833
|
+
**Description:** PUT operation
|
|
2802
2834
|
|
|
2803
2835
|
**TypeScript Example:**
|
|
2804
2836
|
|
|
@@ -2855,7 +2887,7 @@ const result: GetOrderItemsResponse = await getOrderItems(params);
|
|
|
2855
2887
|
|
|
2856
2888
|
**Summary:** Anonymize Orders
|
|
2857
2889
|
|
|
2858
|
-
**Description:**
|
|
2890
|
+
**Description:** POST operation
|
|
2859
2891
|
|
|
2860
2892
|
**TypeScript Example:**
|
|
2861
2893
|
|
|
@@ -2911,7 +2943,7 @@ const result: ConfirmOrderResponse = await confirmOrder(params);
|
|
|
2911
2943
|
|
|
2912
2944
|
**Summary:** Payments
|
|
2913
2945
|
|
|
2914
|
-
**Description:**
|
|
2946
|
+
**Description:** POST operation
|
|
2915
2947
|
|
|
2916
2948
|
**TypeScript Example:**
|
|
2917
2949
|
|
|
@@ -2941,7 +2973,7 @@ const result: PaymentSetupResponse = await paymentSetup(params);
|
|
|
2941
2973
|
|
|
2942
2974
|
**Summary:** Confirm Payment
|
|
2943
2975
|
|
|
2944
|
-
**Description:**
|
|
2976
|
+
**Description:** POST operation
|
|
2945
2977
|
|
|
2946
2978
|
**TypeScript Example:**
|
|
2947
2979
|
|
|
@@ -2972,7 +3004,7 @@ const result: ConfirmPaymentResponse = await confirmPayment(params);
|
|
|
2972
3004
|
|
|
2973
3005
|
**Summary:** Capture a Transaction
|
|
2974
3006
|
|
|
2975
|
-
**Description:**
|
|
3007
|
+
**Description:** POST operation
|
|
2976
3008
|
|
|
2977
3009
|
**TypeScript Example:**
|
|
2978
3010
|
|
|
@@ -3002,7 +3034,7 @@ const result: CaptureATransactionResponse = await captureATransaction(params);
|
|
|
3002
3034
|
|
|
3003
3035
|
**Summary:** Refund a Transaction
|
|
3004
3036
|
|
|
3005
|
-
**Description:**
|
|
3037
|
+
**Description:** POST operation
|
|
3006
3038
|
|
|
3007
3039
|
**TypeScript Example:**
|
|
3008
3040
|
|
|
@@ -3081,7 +3113,7 @@ const result: GetATransactionResponse = await getATransaction(params);
|
|
|
3081
3113
|
|
|
3082
3114
|
**Summary:** Cancel a Transaction
|
|
3083
3115
|
|
|
3084
|
-
**Description:**
|
|
3116
|
+
**Description:** POST operation
|
|
3085
3117
|
|
|
3086
3118
|
**TypeScript Example:**
|
|
3087
3119
|
|
|
@@ -3223,7 +3255,7 @@ const result: PutShippingGroupByIdResponse = await putShippingGroupById(params);
|
|
|
3223
3255
|
|
|
3224
3256
|
**Summary:** List offerings
|
|
3225
3257
|
|
|
3226
|
-
**Description:**
|
|
3258
|
+
**Description:** GET operation
|
|
3227
3259
|
|
|
3228
3260
|
**TypeScript Example:**
|
|
3229
3261
|
|
|
@@ -3385,7 +3417,7 @@ const result: ListOfferingPlanPricingOptionsResponse = await listOfferingPlanPri
|
|
|
3385
3417
|
|
|
3386
3418
|
**Summary:** List subscriptions
|
|
3387
3419
|
|
|
3388
|
-
**Description:**
|
|
3420
|
+
**Description:** GET operation
|
|
3389
3421
|
|
|
3390
3422
|
**TypeScript Example:**
|
|
3391
3423
|
|
|
@@ -3438,7 +3470,7 @@ const result: GetSubscriptionResponse = await getSubscription(params);
|
|
|
3438
3470
|
|
|
3439
3471
|
**Summary:** List subscription plans
|
|
3440
3472
|
|
|
3441
|
-
**Description:**
|
|
3473
|
+
**Description:** GET operation
|
|
3442
3474
|
|
|
3443
3475
|
**TypeScript Example:**
|
|
3444
3476
|
|
|
@@ -3462,7 +3494,7 @@ const result: ListSubscriptionPlansResponse = await listSubscriptionPlans(params
|
|
|
3462
3494
|
|
|
3463
3495
|
**Summary:** List subscription pricing options
|
|
3464
3496
|
|
|
3465
|
-
**Description:**
|
|
3497
|
+
**Description:** GET operation
|
|
3466
3498
|
|
|
3467
3499
|
**TypeScript Example:**
|
|
3468
3500
|
|
|
@@ -3510,7 +3542,7 @@ const result: ListSubscriptionStatesResponse = await listSubscriptionStates(para
|
|
|
3510
3542
|
|
|
3511
3543
|
**Summary:** Create a subscription state
|
|
3512
3544
|
|
|
3513
|
-
**Description:**
|
|
3545
|
+
**Description:** POST operation
|
|
3514
3546
|
|
|
3515
3547
|
**TypeScript Example:**
|
|
3516
3548
|
|
|
@@ -3676,7 +3708,7 @@ const result: GetSubscriptionInvoiceResponse = await getSubscriptionInvoice(para
|
|
|
3676
3708
|
|
|
3677
3709
|
**Summary:** List invoices
|
|
3678
3710
|
|
|
3679
|
-
**Description:**
|
|
3711
|
+
**Description:** GET operation
|
|
3680
3712
|
|
|
3681
3713
|
**TypeScript Example:**
|
|
3682
3714
|
|
|
@@ -3800,7 +3832,7 @@ const result: ListLocationsResponse = await listLocations(params);
|
|
|
3800
3832
|
|
|
3801
3833
|
**Summary:** Create an Access Token
|
|
3802
3834
|
|
|
3803
|
-
**Description:**
|
|
3835
|
+
**Description:** POST operation
|
|
3804
3836
|
|
|
3805
3837
|
**TypeScript Example:**
|
|
3806
3838
|
|
|
@@ -3963,7 +3995,7 @@ const result: PutV2AccountAddressResponse = await putV2AccountAddress(params);
|
|
|
3963
3995
|
|
|
3964
3996
|
**Summary:** Get All Accounts
|
|
3965
3997
|
|
|
3966
|
-
**Description:**
|
|
3998
|
+
**Description:** GET operation
|
|
3967
3999
|
|
|
3968
4000
|
**TypeScript Example:**
|
|
3969
4001
|
|
|
@@ -4068,7 +4100,7 @@ const result: PutV2AccountsAccountIdResponse = await putV2AccountsAccountId(para
|
|
|
4068
4100
|
|
|
4069
4101
|
**Summary:** Get all Account Members
|
|
4070
4102
|
|
|
4071
|
-
**Description:**
|
|
4103
|
+
**Description:** GET operation
|
|
4072
4104
|
|
|
4073
4105
|
**TypeScript Example:**
|
|
4074
4106
|
|
|
@@ -4118,7 +4150,7 @@ const result: GetV2AccountMembersAccountMemberIdResponse = await getV2AccountMem
|
|
|
4118
4150
|
|
|
4119
4151
|
**Summary:** Get all Account Memberships
|
|
4120
4152
|
|
|
4121
|
-
**Description:**
|
|
4153
|
+
**Description:** GET operation
|
|
4122
4154
|
|
|
4123
4155
|
**TypeScript Example:**
|
|
4124
4156
|
|
|
@@ -4147,7 +4179,7 @@ const result: GetV2AccountsAccountIdAccountMembershipsResponse = await getV2Acco
|
|
|
4147
4179
|
|
|
4148
4180
|
**Summary:** Generate an Account Management Authentication Token
|
|
4149
4181
|
|
|
4150
|
-
**Description:**
|
|
4182
|
+
**Description:** POST operation
|
|
4151
4183
|
|
|
4152
4184
|
**TypeScript Example:**
|
|
4153
4185
|
|
|
@@ -4301,7 +4333,7 @@ const result: GetACurrencyResponse = await getACurrency(params);
|
|
|
4301
4333
|
|
|
4302
4334
|
**Summary:** Get all Files
|
|
4303
4335
|
|
|
4304
|
-
**Description:**
|
|
4336
|
+
**Description:** GET operation
|
|
4305
4337
|
|
|
4306
4338
|
**TypeScript Example:**
|
|
4307
4339
|
|