@basedone/core 0.2.2 → 0.2.3
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/{chunk-Z5OW2FDP.mjs → chunk-SKX4VGEN.mjs} +459 -1
- package/dist/ecommerce.d.mts +1014 -7
- package/dist/ecommerce.d.ts +1014 -7
- package/dist/ecommerce.js +459 -1
- package/dist/ecommerce.mjs +1 -1
- package/dist/index.d.mts +12 -3
- package/dist/index.d.ts +12 -3
- package/dist/index.js +466 -1
- package/dist/index.mjs +8 -2
- package/lib/ecommerce/client/base.ts +7 -1
- package/lib/ecommerce/client/customer.ts +58 -0
- package/lib/ecommerce/client/merchant.ts +783 -0
- package/lib/ecommerce/types/entities.ts +94 -0
- package/lib/ecommerce/types/enums.ts +5 -1
- package/lib/ecommerce/types/requests.ts +98 -0
- package/lib/ecommerce/types/responses.ts +148 -0
- package/lib/utils/formatter.ts +1 -1
- package/lib/utils/time.ts +24 -0
- package/package.json +3 -2
package/dist/ecommerce.js
CHANGED
|
@@ -140,11 +140,13 @@ var BaseEcommerceClient = class {
|
|
|
140
140
|
maxRetries: config.maxRetries || 3,
|
|
141
141
|
retryBaseDelay: config.retryBaseDelay || 1e3,
|
|
142
142
|
headers: config.headers,
|
|
143
|
-
enableRetry: config.enableRetry !== false
|
|
143
|
+
enableRetry: config.enableRetry !== false,
|
|
144
|
+
withCredentials: config.withCredentials || false
|
|
144
145
|
};
|
|
145
146
|
this.axiosInstance = axios__default.default.create({
|
|
146
147
|
baseURL: this.config.baseURL,
|
|
147
148
|
timeout: this.config.timeout,
|
|
149
|
+
withCredentials: this.config.withCredentials,
|
|
148
150
|
headers: {
|
|
149
151
|
"Content-Type": "application/json",
|
|
150
152
|
...this.config.headers
|
|
@@ -688,6 +690,34 @@ var CustomerEcommerceClient = class extends BaseEcommerceClient {
|
|
|
688
690
|
return this.post("/api/marketplace/tax/calculate", request);
|
|
689
691
|
}
|
|
690
692
|
// ============================================================================
|
|
693
|
+
// Shipping Calculation API
|
|
694
|
+
// ============================================================================
|
|
695
|
+
/**
|
|
696
|
+
* Calculate shipping options for cart items
|
|
697
|
+
*
|
|
698
|
+
* @param request - Cart items, merchant, and destination
|
|
699
|
+
* @returns Available shipping options with costs
|
|
700
|
+
*
|
|
701
|
+
* @example
|
|
702
|
+
* ```typescript
|
|
703
|
+
* const result = await client.calculateShippingOptions({
|
|
704
|
+
* merchantId: "merchant_123",
|
|
705
|
+
* cartItems: [
|
|
706
|
+
* { productId: "prod_123", quantity: 2 }
|
|
707
|
+
* ],
|
|
708
|
+
* destinationCountry: "US",
|
|
709
|
+
* orderSubtotal: 99.99
|
|
710
|
+
* });
|
|
711
|
+
*
|
|
712
|
+
* result.shippingOptions.forEach(opt => {
|
|
713
|
+
* console.log(opt.name, opt.cost, opt.estimatedDelivery);
|
|
714
|
+
* });
|
|
715
|
+
* ```
|
|
716
|
+
*/
|
|
717
|
+
async calculateShippingOptions(request) {
|
|
718
|
+
return this.post("/api/marketplace/shipping/calculate", request);
|
|
719
|
+
}
|
|
720
|
+
// ============================================================================
|
|
691
721
|
// Banners API
|
|
692
722
|
// ============================================================================
|
|
693
723
|
/**
|
|
@@ -945,6 +975,29 @@ var CustomerEcommerceClient = class extends BaseEcommerceClient {
|
|
|
945
975
|
const queryString = params ? buildQueryString(params) : "";
|
|
946
976
|
return this.get(`/api/marketplace/following${queryString}`);
|
|
947
977
|
}
|
|
978
|
+
// ============================================================================
|
|
979
|
+
// Payment Methods
|
|
980
|
+
// ============================================================================
|
|
981
|
+
/**
|
|
982
|
+
* Get available payment methods
|
|
983
|
+
*
|
|
984
|
+
* Returns the list of enabled payment methods that can be used during checkout.
|
|
985
|
+
*
|
|
986
|
+
* @returns List of available payment methods with display info
|
|
987
|
+
*
|
|
988
|
+
* @example
|
|
989
|
+
* ```typescript
|
|
990
|
+
* const result = await client.getPaymentMethods();
|
|
991
|
+
* if (result.paymentsEnabled) {
|
|
992
|
+
* result.methods.forEach(method => {
|
|
993
|
+
* console.log(`${method.name}: ${method.description}`);
|
|
994
|
+
* });
|
|
995
|
+
* }
|
|
996
|
+
* ```
|
|
997
|
+
*/
|
|
998
|
+
async getPaymentMethods() {
|
|
999
|
+
return this.get("/api/marketplace/payments/methods");
|
|
1000
|
+
}
|
|
948
1001
|
};
|
|
949
1002
|
|
|
950
1003
|
// lib/ecommerce/client/merchant.ts
|
|
@@ -1479,6 +1532,192 @@ var MerchantEcommerceClient = class extends BaseEcommerceClient {
|
|
|
1479
1532
|
return this.patch(`/api/marketplace/merchant/shipping/shipments/${shipmentId}`, request);
|
|
1480
1533
|
}
|
|
1481
1534
|
// ============================================================================
|
|
1535
|
+
// Shipping Settings (Zones & Rates)
|
|
1536
|
+
// ============================================================================
|
|
1537
|
+
/**
|
|
1538
|
+
* Get merchant shipping settings
|
|
1539
|
+
*
|
|
1540
|
+
* @returns Shipping settings
|
|
1541
|
+
*
|
|
1542
|
+
* @example
|
|
1543
|
+
* ```typescript
|
|
1544
|
+
* const { settings } = await client.getShippingSettings();
|
|
1545
|
+
* console.log("Handling fee:", settings.defaultHandlingFee);
|
|
1546
|
+
* ```
|
|
1547
|
+
*/
|
|
1548
|
+
async getShippingSettings() {
|
|
1549
|
+
return this.get("/api/marketplace/merchant/shipping/settings");
|
|
1550
|
+
}
|
|
1551
|
+
/**
|
|
1552
|
+
* Update merchant shipping settings
|
|
1553
|
+
*
|
|
1554
|
+
* @param request - Settings to update
|
|
1555
|
+
* @returns Updated settings
|
|
1556
|
+
*
|
|
1557
|
+
* @example
|
|
1558
|
+
* ```typescript
|
|
1559
|
+
* await client.updateShippingSettings({
|
|
1560
|
+
* defaultHandlingFee: 2.50,
|
|
1561
|
+
* freeShippingEnabled: true,
|
|
1562
|
+
* freeShippingThreshold: 100
|
|
1563
|
+
* });
|
|
1564
|
+
* ```
|
|
1565
|
+
*/
|
|
1566
|
+
async updateShippingSettings(request) {
|
|
1567
|
+
return this.post("/api/marketplace/merchant/shipping/settings", request);
|
|
1568
|
+
}
|
|
1569
|
+
/**
|
|
1570
|
+
* List all shipping zones
|
|
1571
|
+
*
|
|
1572
|
+
* @returns List of shipping zones with rate counts
|
|
1573
|
+
*
|
|
1574
|
+
* @example
|
|
1575
|
+
* ```typescript
|
|
1576
|
+
* const { zones } = await client.listShippingZones();
|
|
1577
|
+
* zones.forEach(z => console.log(z.name, z.countries.length, "countries"));
|
|
1578
|
+
* ```
|
|
1579
|
+
*/
|
|
1580
|
+
async listShippingZones() {
|
|
1581
|
+
return this.get("/api/marketplace/merchant/shipping/zones");
|
|
1582
|
+
}
|
|
1583
|
+
/**
|
|
1584
|
+
* Get a shipping zone by ID
|
|
1585
|
+
*
|
|
1586
|
+
* @param zoneId - Zone ID
|
|
1587
|
+
* @returns Zone with rates
|
|
1588
|
+
*
|
|
1589
|
+
* @example
|
|
1590
|
+
* ```typescript
|
|
1591
|
+
* const { zone } = await client.getShippingZone("zone_123");
|
|
1592
|
+
* console.log(zone.name, zone.rates?.length, "rates");
|
|
1593
|
+
* ```
|
|
1594
|
+
*/
|
|
1595
|
+
async getShippingZone(zoneId) {
|
|
1596
|
+
return this.get(`/api/marketplace/merchant/shipping/zones/${zoneId}`);
|
|
1597
|
+
}
|
|
1598
|
+
/**
|
|
1599
|
+
* Create a shipping zone
|
|
1600
|
+
*
|
|
1601
|
+
* @param request - Zone data
|
|
1602
|
+
* @returns Created zone
|
|
1603
|
+
*
|
|
1604
|
+
* @example
|
|
1605
|
+
* ```typescript
|
|
1606
|
+
* const { zone } = await client.createShippingZone({
|
|
1607
|
+
* name: "Southeast Asia",
|
|
1608
|
+
* countries: ["SG", "MY", "TH", "ID", "PH", "VN"],
|
|
1609
|
+
* isDefault: false,
|
|
1610
|
+
* priority: 10
|
|
1611
|
+
* });
|
|
1612
|
+
* ```
|
|
1613
|
+
*/
|
|
1614
|
+
async createShippingZone(request) {
|
|
1615
|
+
return this.post("/api/marketplace/merchant/shipping/zones", request);
|
|
1616
|
+
}
|
|
1617
|
+
/**
|
|
1618
|
+
* Update a shipping zone
|
|
1619
|
+
*
|
|
1620
|
+
* @param zoneId - Zone ID
|
|
1621
|
+
* @param request - Updated zone data
|
|
1622
|
+
* @returns Updated zone
|
|
1623
|
+
*
|
|
1624
|
+
* @example
|
|
1625
|
+
* ```typescript
|
|
1626
|
+
* await client.updateShippingZone("zone_123", {
|
|
1627
|
+
* countries: ["SG", "MY", "TH", "ID", "PH", "VN", "BN"]
|
|
1628
|
+
* });
|
|
1629
|
+
* ```
|
|
1630
|
+
*/
|
|
1631
|
+
async updateShippingZone(zoneId, request) {
|
|
1632
|
+
return this.put(`/api/marketplace/merchant/shipping/zones/${zoneId}`, request);
|
|
1633
|
+
}
|
|
1634
|
+
/**
|
|
1635
|
+
* Delete a shipping zone
|
|
1636
|
+
*
|
|
1637
|
+
* @param zoneId - Zone ID
|
|
1638
|
+
* @returns Success response
|
|
1639
|
+
*
|
|
1640
|
+
* @example
|
|
1641
|
+
* ```typescript
|
|
1642
|
+
* await client.deleteShippingZone("zone_123");
|
|
1643
|
+
* ```
|
|
1644
|
+
*/
|
|
1645
|
+
async deleteShippingZone(zoneId) {
|
|
1646
|
+
return this.delete(`/api/marketplace/merchant/shipping/zones/${zoneId}`);
|
|
1647
|
+
}
|
|
1648
|
+
/**
|
|
1649
|
+
* List shipping rates
|
|
1650
|
+
*
|
|
1651
|
+
* @param zoneId - Optional zone ID to filter by
|
|
1652
|
+
* @returns List of shipping rates
|
|
1653
|
+
*
|
|
1654
|
+
* @example
|
|
1655
|
+
* ```typescript
|
|
1656
|
+
* // All rates
|
|
1657
|
+
* const { rates } = await client.listShippingRates();
|
|
1658
|
+
*
|
|
1659
|
+
* // Rates for a specific zone
|
|
1660
|
+
* const { rates: zoneRates } = await client.listShippingRates("zone_123");
|
|
1661
|
+
* ```
|
|
1662
|
+
*/
|
|
1663
|
+
async listShippingRates(zoneId) {
|
|
1664
|
+
const query = zoneId ? `?zoneId=${zoneId}` : "";
|
|
1665
|
+
return this.get(`/api/marketplace/merchant/shipping/rates${query}`);
|
|
1666
|
+
}
|
|
1667
|
+
/**
|
|
1668
|
+
* Create a shipping rate
|
|
1669
|
+
*
|
|
1670
|
+
* @param request - Rate data
|
|
1671
|
+
* @returns Created rate
|
|
1672
|
+
*
|
|
1673
|
+
* @example
|
|
1674
|
+
* ```typescript
|
|
1675
|
+
* const { rate } = await client.createShippingRate({
|
|
1676
|
+
* zoneId: "zone_123",
|
|
1677
|
+
* name: "Standard Shipping",
|
|
1678
|
+
* baseRate: 5.00,
|
|
1679
|
+
* perKgRate: 1.50,
|
|
1680
|
+
* minDeliveryDays: 7,
|
|
1681
|
+
* maxDeliveryDays: 14
|
|
1682
|
+
* });
|
|
1683
|
+
* ```
|
|
1684
|
+
*/
|
|
1685
|
+
async createShippingRate(request) {
|
|
1686
|
+
return this.post("/api/marketplace/merchant/shipping/rates", request);
|
|
1687
|
+
}
|
|
1688
|
+
/**
|
|
1689
|
+
* Update a shipping rate
|
|
1690
|
+
*
|
|
1691
|
+
* @param rateId - Rate ID
|
|
1692
|
+
* @param request - Updated rate data
|
|
1693
|
+
* @returns Updated rate
|
|
1694
|
+
*
|
|
1695
|
+
* @example
|
|
1696
|
+
* ```typescript
|
|
1697
|
+
* await client.updateShippingRate("rate_123", {
|
|
1698
|
+
* baseRate: 6.00,
|
|
1699
|
+
* freeAboveAmount: 75
|
|
1700
|
+
* });
|
|
1701
|
+
* ```
|
|
1702
|
+
*/
|
|
1703
|
+
async updateShippingRate(rateId, request) {
|
|
1704
|
+
return this.put(`/api/marketplace/merchant/shipping/rates/${rateId}`, request);
|
|
1705
|
+
}
|
|
1706
|
+
/**
|
|
1707
|
+
* Delete a shipping rate
|
|
1708
|
+
*
|
|
1709
|
+
* @param rateId - Rate ID
|
|
1710
|
+
* @returns Success response
|
|
1711
|
+
*
|
|
1712
|
+
* @example
|
|
1713
|
+
* ```typescript
|
|
1714
|
+
* await client.deleteShippingRate("rate_123");
|
|
1715
|
+
* ```
|
|
1716
|
+
*/
|
|
1717
|
+
async deleteShippingRate(rateId) {
|
|
1718
|
+
return this.delete(`/api/marketplace/merchant/shipping/rates/${rateId}`);
|
|
1719
|
+
}
|
|
1720
|
+
// ============================================================================
|
|
1482
1721
|
// Returns & Refunds
|
|
1483
1722
|
// ============================================================================
|
|
1484
1723
|
/**
|
|
@@ -2076,6 +2315,223 @@ var MerchantEcommerceClient = class extends BaseEcommerceClient {
|
|
|
2076
2315
|
async exportTaxReport(reportId) {
|
|
2077
2316
|
return this.get(`/api/marketplace/merchant/tax-reports/${reportId}/export`);
|
|
2078
2317
|
}
|
|
2318
|
+
// ============================================
|
|
2319
|
+
// DROPSHIPPING APIs
|
|
2320
|
+
// ============================================
|
|
2321
|
+
/**
|
|
2322
|
+
* List connected dropship suppliers
|
|
2323
|
+
*
|
|
2324
|
+
* @returns Connected and available suppliers
|
|
2325
|
+
*
|
|
2326
|
+
* @example
|
|
2327
|
+
* ```typescript
|
|
2328
|
+
* const { connected, available } = await client.listDropshipSuppliers();
|
|
2329
|
+
* ```
|
|
2330
|
+
*/
|
|
2331
|
+
async listDropshipSuppliers() {
|
|
2332
|
+
return this.get("/api/marketplace/merchant/dropship/suppliers");
|
|
2333
|
+
}
|
|
2334
|
+
/**
|
|
2335
|
+
* Connect a new dropship supplier
|
|
2336
|
+
*
|
|
2337
|
+
* @param request - Supplier credentials
|
|
2338
|
+
* @returns Connected supplier
|
|
2339
|
+
*
|
|
2340
|
+
* @example
|
|
2341
|
+
* ```typescript
|
|
2342
|
+
* const supplier = await client.connectDropshipSupplier({
|
|
2343
|
+
* code: "CJ_DROPSHIPPING",
|
|
2344
|
+
* apiKey: "your-api-key"
|
|
2345
|
+
* });
|
|
2346
|
+
* ```
|
|
2347
|
+
*/
|
|
2348
|
+
async connectDropshipSupplier(request) {
|
|
2349
|
+
return this.post("/api/marketplace/merchant/dropship/suppliers", request);
|
|
2350
|
+
}
|
|
2351
|
+
/**
|
|
2352
|
+
* Update dropship supplier settings
|
|
2353
|
+
*
|
|
2354
|
+
* @param supplierId - Supplier ID
|
|
2355
|
+
* @param request - Settings to update
|
|
2356
|
+
* @returns Updated supplier
|
|
2357
|
+
*/
|
|
2358
|
+
async updateDropshipSupplier(supplierId, request) {
|
|
2359
|
+
return this.put(`/api/marketplace/merchant/dropship/suppliers/${supplierId}`, request);
|
|
2360
|
+
}
|
|
2361
|
+
/**
|
|
2362
|
+
* Disconnect a dropship supplier
|
|
2363
|
+
*
|
|
2364
|
+
* @param supplierId - Supplier ID
|
|
2365
|
+
*/
|
|
2366
|
+
async disconnectDropshipSupplier(supplierId) {
|
|
2367
|
+
return this.delete(`/api/marketplace/merchant/dropship/suppliers/${supplierId}`);
|
|
2368
|
+
}
|
|
2369
|
+
/**
|
|
2370
|
+
* Search products from connected suppliers
|
|
2371
|
+
*
|
|
2372
|
+
* @param request - Search parameters
|
|
2373
|
+
* @returns Search results with pagination
|
|
2374
|
+
*
|
|
2375
|
+
* @example
|
|
2376
|
+
* ```typescript
|
|
2377
|
+
* const results = await client.searchDropshipProducts({
|
|
2378
|
+
* supplierId: "supplier_123",
|
|
2379
|
+
* query: "wireless headphones",
|
|
2380
|
+
* limit: 20
|
|
2381
|
+
* });
|
|
2382
|
+
* ```
|
|
2383
|
+
*/
|
|
2384
|
+
async searchDropshipProducts(request) {
|
|
2385
|
+
return this.post("/api/marketplace/merchant/dropship/search", request);
|
|
2386
|
+
}
|
|
2387
|
+
/**
|
|
2388
|
+
* Get dropship supplier categories
|
|
2389
|
+
*
|
|
2390
|
+
* @param supplierId - Supplier ID
|
|
2391
|
+
* @returns Category list
|
|
2392
|
+
*/
|
|
2393
|
+
async getDropshipCategories(supplierId) {
|
|
2394
|
+
return this.get(`/api/marketplace/merchant/dropship/categories?supplierId=${supplierId}`);
|
|
2395
|
+
}
|
|
2396
|
+
/**
|
|
2397
|
+
* Get detailed product info from supplier
|
|
2398
|
+
*
|
|
2399
|
+
* @param supplierId - Supplier ID
|
|
2400
|
+
* @param externalProductId - Supplier's product ID
|
|
2401
|
+
* @returns Product details with suggested pricing
|
|
2402
|
+
*/
|
|
2403
|
+
async getDropshipProductDetails(supplierId, externalProductId) {
|
|
2404
|
+
return this.get(
|
|
2405
|
+
`/api/marketplace/merchant/dropship/products/${encodeURIComponent(externalProductId)}?supplierId=${supplierId}`
|
|
2406
|
+
);
|
|
2407
|
+
}
|
|
2408
|
+
/**
|
|
2409
|
+
* Import a product from supplier to your store
|
|
2410
|
+
*
|
|
2411
|
+
* @param request - Import parameters
|
|
2412
|
+
* @returns Created product IDs
|
|
2413
|
+
*
|
|
2414
|
+
* @example
|
|
2415
|
+
* ```typescript
|
|
2416
|
+
* const result = await client.importDropshipProduct({
|
|
2417
|
+
* supplierId: "supplier_123",
|
|
2418
|
+
* externalProductId: "ext_product_456",
|
|
2419
|
+
* priceUSDC: 29.99,
|
|
2420
|
+
* title: "Custom Title"
|
|
2421
|
+
* });
|
|
2422
|
+
* ```
|
|
2423
|
+
*/
|
|
2424
|
+
async importDropshipProduct(request) {
|
|
2425
|
+
return this.post("/api/marketplace/merchant/dropship/import", request);
|
|
2426
|
+
}
|
|
2427
|
+
/**
|
|
2428
|
+
* Bulk import products from supplier
|
|
2429
|
+
*
|
|
2430
|
+
* @param request - Bulk import parameters
|
|
2431
|
+
* @returns Import results
|
|
2432
|
+
*/
|
|
2433
|
+
async bulkImportDropshipProducts(request) {
|
|
2434
|
+
return this.post("/api/marketplace/merchant/dropship/import", request);
|
|
2435
|
+
}
|
|
2436
|
+
/**
|
|
2437
|
+
* List imported dropship products
|
|
2438
|
+
*
|
|
2439
|
+
* @param params - Filter parameters
|
|
2440
|
+
* @returns Imported products list
|
|
2441
|
+
*/
|
|
2442
|
+
async listDropshipProducts(params) {
|
|
2443
|
+
const query = params ? `?${buildQueryString(params)}` : "";
|
|
2444
|
+
return this.get(`/api/marketplace/merchant/dropship/import${query}`);
|
|
2445
|
+
}
|
|
2446
|
+
/**
|
|
2447
|
+
* List dropship order links
|
|
2448
|
+
*
|
|
2449
|
+
* @param params - Filter parameters
|
|
2450
|
+
* @returns Order links with status summary
|
|
2451
|
+
*/
|
|
2452
|
+
async listDropshipOrders(params) {
|
|
2453
|
+
let query = "";
|
|
2454
|
+
if (params) {
|
|
2455
|
+
const queryParams = {};
|
|
2456
|
+
if (params.status) {
|
|
2457
|
+
queryParams.status = Array.isArray(params.status) ? params.status.join(",") : params.status;
|
|
2458
|
+
}
|
|
2459
|
+
if (params.limit) queryParams.limit = params.limit.toString();
|
|
2460
|
+
if (params.offset) queryParams.offset = params.offset.toString();
|
|
2461
|
+
query = `?${buildQueryString(queryParams)}`;
|
|
2462
|
+
}
|
|
2463
|
+
return this.get(`/api/marketplace/merchant/dropship/orders${query}`);
|
|
2464
|
+
}
|
|
2465
|
+
/**
|
|
2466
|
+
* Forward orders to supplier
|
|
2467
|
+
*
|
|
2468
|
+
* @param orderItemIds - Order item IDs to forward
|
|
2469
|
+
* @returns Forward results
|
|
2470
|
+
*/
|
|
2471
|
+
async forwardDropshipOrders(orderItemIds) {
|
|
2472
|
+
return this.post("/api/marketplace/merchant/dropship/orders", {
|
|
2473
|
+
action: "forward",
|
|
2474
|
+
orderItemIds
|
|
2475
|
+
});
|
|
2476
|
+
}
|
|
2477
|
+
/**
|
|
2478
|
+
* Sync tracking for all pending dropship orders
|
|
2479
|
+
*
|
|
2480
|
+
* @returns Sync results
|
|
2481
|
+
*/
|
|
2482
|
+
async syncDropshipTracking() {
|
|
2483
|
+
return this.post("/api/marketplace/merchant/dropship/orders", {
|
|
2484
|
+
action: "sync"
|
|
2485
|
+
});
|
|
2486
|
+
}
|
|
2487
|
+
/**
|
|
2488
|
+
* Get order forwarding details for manual forwarding
|
|
2489
|
+
*
|
|
2490
|
+
* @param orderItemId - Order item ID
|
|
2491
|
+
* @returns Forwarding details
|
|
2492
|
+
*/
|
|
2493
|
+
async getDropshipOrderDetails(orderItemId) {
|
|
2494
|
+
return this.get(`/api/marketplace/merchant/dropship/orders/${orderItemId}/forward`);
|
|
2495
|
+
}
|
|
2496
|
+
/**
|
|
2497
|
+
* Forward a single order item to supplier
|
|
2498
|
+
*
|
|
2499
|
+
* @param orderItemId - Order item ID
|
|
2500
|
+
* @returns Forward result
|
|
2501
|
+
*/
|
|
2502
|
+
async forwardDropshipOrder(orderItemId) {
|
|
2503
|
+
return this.post(`/api/marketplace/merchant/dropship/orders/${orderItemId}/forward`, {});
|
|
2504
|
+
}
|
|
2505
|
+
/**
|
|
2506
|
+
* Get dropship settings
|
|
2507
|
+
*
|
|
2508
|
+
* @returns Merchant dropship settings
|
|
2509
|
+
*/
|
|
2510
|
+
async getDropshipSettings() {
|
|
2511
|
+
return this.get("/api/marketplace/merchant/dropship/settings");
|
|
2512
|
+
}
|
|
2513
|
+
/**
|
|
2514
|
+
* Update dropship settings
|
|
2515
|
+
*
|
|
2516
|
+
* @param request - Settings to update
|
|
2517
|
+
* @returns Updated settings
|
|
2518
|
+
*/
|
|
2519
|
+
async updateDropshipSettings(request) {
|
|
2520
|
+
return this.put("/api/marketplace/merchant/dropship/settings", request);
|
|
2521
|
+
}
|
|
2522
|
+
/**
|
|
2523
|
+
* Sync dropship products and/or orders
|
|
2524
|
+
*
|
|
2525
|
+
* @param type - Sync type (products, orders, all, single)
|
|
2526
|
+
* @param dropshipProductId - For single product sync
|
|
2527
|
+
* @returns Sync results
|
|
2528
|
+
*/
|
|
2529
|
+
async syncDropship(type, dropshipProductId) {
|
|
2530
|
+
return this.post("/api/marketplace/merchant/dropship/sync", {
|
|
2531
|
+
type,
|
|
2532
|
+
dropshipProductId
|
|
2533
|
+
});
|
|
2534
|
+
}
|
|
2079
2535
|
};
|
|
2080
2536
|
|
|
2081
2537
|
// lib/ecommerce/types/enums.ts
|
|
@@ -2093,6 +2549,8 @@ var OrderStatus = /* @__PURE__ */ ((OrderStatus2) => {
|
|
|
2093
2549
|
})(OrderStatus || {});
|
|
2094
2550
|
var PaymentMethod = /* @__PURE__ */ ((PaymentMethod2) => {
|
|
2095
2551
|
PaymentMethod2["USDC_ESCROW"] = "USDC_ESCROW";
|
|
2552
|
+
PaymentMethod2["BASEDPAY"] = "BASEDPAY";
|
|
2553
|
+
PaymentMethod2["STRIPE"] = "STRIPE";
|
|
2096
2554
|
PaymentMethod2["POINTS"] = "POINTS";
|
|
2097
2555
|
return PaymentMethod2;
|
|
2098
2556
|
})(PaymentMethod || {});
|
package/dist/ecommerce.mjs
CHANGED
|
@@ -1,2 +1,2 @@
|
|
|
1
|
-
export { BannerType, BaseEcommerceClient, CustomerEcommerceClient, DiscountMethod, DiscountScope, DiscountType, EcommerceApiError, InventoryAuditAction, MerchantEcommerceClient, MerchantStatus, OrderStatus, PaymentMethod, PaymentStatus, ProductSortBy, ReturnStatus, ReviewSortBy, ReviewStatus, ShipmentStatus, SortOrder, TaxBehavior, TaxReportPeriodType, TaxReportStatus, TaxType, buildQueryString, calculateDiscountAmount, calculateFinalPrice, formatPrice, getBackoffDelay, isRetryableError, isValidAddress, isValidEmail, parseError, retryWithBackoff, sleep, truncateAddress } from './chunk-
|
|
1
|
+
export { BannerType, BaseEcommerceClient, CustomerEcommerceClient, DiscountMethod, DiscountScope, DiscountType, EcommerceApiError, InventoryAuditAction, MerchantEcommerceClient, MerchantStatus, OrderStatus, PaymentMethod, PaymentStatus, ProductSortBy, ReturnStatus, ReviewSortBy, ReviewStatus, ShipmentStatus, SortOrder, TaxBehavior, TaxReportPeriodType, TaxReportStatus, TaxType, buildQueryString, calculateDiscountAmount, calculateFinalPrice, formatPrice, getBackoffDelay, isRetryableError, isValidAddress, isValidEmail, parseError, retryWithBackoff, sleep, truncateAddress } from './chunk-SKX4VGEN.mjs';
|
|
2
2
|
import './chunk-4UEJOM6W.mjs';
|
package/dist/index.d.mts
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
import { SpotToken, MarginTables, PerpsAssetCtx, SpotMeta, ExchangeClient, SuccessResponse, InfoClient } from '@nktkas/hyperliquid';
|
|
2
2
|
import { Hex } from '@nktkas/hyperliquid/types';
|
|
3
3
|
export { A as AllPerpsMeta, d as AssetIdUtils, B as BaseInstrument, I as InstrumentClient, M as MarketInstrument, c as PerpsInstrument, P as PerpsMeta, a as PerpsMetaAndAssetCtxs, b as PerpsUniverse, S as SpotInstrument, g as getAllPerpsMeta } from './client-CgmiTuEX.mjs';
|
|
4
|
-
export { ActiveFlashSalesResponse, AnalyticsOverview, ApiResponse, AppliedDiscount, Banner, BannerResponse, BannerType, BaseEcommerceClient, BaseEntity, CalculateCartDiscountsRequest, CalculateCartDiscountsResponse, CalculateTaxRequest, CalculateTaxResponse, CartItem, ConfirmEscrowDepositResponse, Coupon, CouponResponse, CouponUsage, CreateBannerRequest, CreateCouponRequest, CreateFlashSaleRequest, CreateOrderEventRequest, CreateOrderEventResponse, CreateOrderRequest, CreateOrderResponse, CreateProductRequest, CreateProductVariantRequest, CreateReviewRequest, CreateShippingMethodRequest, CreateTaxNexusRequest, CreateTaxRuleRequest, CustomerEcommerceClient, CustomerMessagesResponse, CustomerSummary, DiscountMethod, DiscountScope, DiscountType, EcommerceApiError, EcommerceClientConfig, FlashSale, FlashSaleItem, FlashSaleItemInput, FollowActionResponse, FollowStatusResponse, FollowedMerchantSummary, GenerateTaxReportRequest, GetAnalyticsParams, GetAnalyticsResponse, GetCouponResponse, GetOrderResponse, GetProductMetricsResponse, GetProductResponse, GetTaxReportResponse, InventoryAuditAction, InventoryAuditEntry, ListActiveBannersParams, ListActiveFlashSalesParams, ListBannersResponse, ListCouponsResponse, ListCustomersParams, ListCustomersResponse, ListFollowingParams, ListFollowingResponse, ListInventoryAuditResponse, ListMediaAssetsResponse, ListMerchantProductsParams, ListMessagesResponse, ListOrdersParams, ListOrdersResponse, ListProductVariantsResponse, ListProductsParams, ListProductsResponse, ListReturnsResponse, ListReviewsParams, ListReviewsResponse, ListShipmentsResponse, ListShippingAddressesResponse, ListShippingMethodsResponse, ListTaxNexusResponse, ListTaxReportsParams, ListTaxReportsResponse, ListTaxRulesResponse, MediaAsset, MediaAssetResponse, Merchant, MerchantEcommerceClient, MerchantProductsResponse, MerchantProfileRequest, MerchantProfileResponse, MerchantStatus, Message, MessageResponse, MessageStatsResponse, Order, OrderEvent, OrderItem, OrderReceiptResponse, OrderStatus, OrdersByStatus, PaginatedResponse, PaginationParams, Payment, PaymentMethod, PaymentStatus, Product, ProductDimensions, ProductDiscountsResponse, ProductMetrics, ProductResponse, ProductReview, ProductSortBy, ProductVariant, ProductVariantResponse, PublicMerchantProfile, PublicMerchantProfileResponse, RecentOrderSummary, RespondToReviewRequest, Return, ReturnItem, ReturnResponse, ReturnStatus, RevenueByDay, ReviewResponse, ReviewSortBy, ReviewStatus, SendMessageRequest, Settlement, Shipment, ShipmentResponse, ShipmentStatus, ShippingAddress, ShippingAddressRequest, ShippingAddressResponse, ShippingMethod, ShippingMethodResponse, SortOrder, SuccessResponse, TaxBehavior, TaxBreakdownItem, TaxNexus, TaxNexusResponse, TaxReport, TaxReportDetails, TaxReportPeriodType, TaxReportResponse, TaxReportStatus, TaxRule, TaxRuleResponse, TaxSettings, TaxSettingsResponse, TaxType, TopProduct, TrackBannerRequest, UpdateBannerRequest, UpdateCouponRequest, UpdateFlashSaleRequest, UpdateOrderResponse, UpdateOrderStatusRequest, UpdateProductRequest, UpdateProductVariantRequest, UpdateShipmentRequest, UpdateShippingMethodRequest, UpdateTaxNexusRequest, UpdateTaxReportStatusRequest, UpdateTaxRuleRequest, UpdateTaxSettingsRequest, UserShippingAddress, ValidateDiscountRequest, ValidateDiscountResponse, buildQueryString, calculateDiscountAmount, calculateFinalPrice, formatPrice, getBackoffDelay, isRetryableError, isValidAddress, isValidEmail, parseError, retryWithBackoff, sleep, truncateAddress } from './ecommerce.mjs';
|
|
4
|
+
export { ActiveFlashSalesResponse, AnalyticsOverview, ApiResponse, AppliedDiscount, Banner, BannerResponse, BannerType, BaseEcommerceClient, BaseEntity, CalculateCartDiscountsRequest, CalculateCartDiscountsResponse, CalculateShippingRequest, CalculateShippingResponse, CalculateTaxRequest, CalculateTaxResponse, CartItem, ConfirmEscrowDepositResponse, Coupon, CouponResponse, CouponUsage, CreateBannerRequest, CreateCouponRequest, CreateFlashSaleRequest, CreateOrderEventRequest, CreateOrderEventResponse, CreateOrderRequest, CreateOrderResponse, CreateProductRequest, CreateProductVariantRequest, CreateReviewRequest, CreateShippingMethodRequest, CreateShippingRateRequest, CreateShippingZoneRequest, CreateTaxNexusRequest, CreateTaxRuleRequest, CustomerEcommerceClient, CustomerMessagesResponse, CustomerSummary, DiscountMethod, DiscountScope, DiscountType, EcommerceApiError, EcommerceClientConfig, FlashSale, FlashSaleItem, FlashSaleItemInput, FollowActionResponse, FollowStatusResponse, FollowedMerchantSummary, GenerateTaxReportRequest, GetAnalyticsParams, GetAnalyticsResponse, GetCouponResponse, GetOrderResponse, GetPaymentMethodsResponse, GetProductMetricsResponse, GetProductResponse, GetTaxReportResponse, InventoryAuditAction, InventoryAuditEntry, ListActiveBannersParams, ListActiveFlashSalesParams, ListBannersResponse, ListCouponsResponse, ListCustomersParams, ListCustomersResponse, ListFollowingParams, ListFollowingResponse, ListInventoryAuditResponse, ListMediaAssetsResponse, ListMerchantProductsParams, ListMessagesResponse, ListOrdersParams, ListOrdersResponse, ListProductVariantsResponse, ListProductsParams, ListProductsResponse, ListReturnsResponse, ListReviewsParams, ListReviewsResponse, ListShipmentsResponse, ListShippingAddressesResponse, ListShippingMethodsResponse, ListShippingRatesResponse, ListShippingZonesResponse, ListTaxNexusResponse, ListTaxReportsParams, ListTaxReportsResponse, ListTaxRulesResponse, MediaAsset, MediaAssetResponse, Merchant, MerchantEcommerceClient, MerchantProductsResponse, MerchantProfileRequest, MerchantProfileResponse, MerchantShippingSettings, MerchantStatus, Message, MessageResponse, MessageStatsResponse, Order, OrderEvent, OrderItem, OrderReceiptResponse, OrderStatus, OrdersByStatus, PaginatedResponse, PaginationParams, Payment, PaymentMethod, PaymentMethodInfo, PaymentStatus, ProcessPaymentRequest, ProcessPaymentResponse, Product, ProductDimensions, ProductDiscountsResponse, ProductMetrics, ProductResponse, ProductReview, ProductSortBy, ProductVariant, ProductVariantResponse, PublicMerchantProfile, PublicMerchantProfileResponse, RecentOrderSummary, RespondToReviewRequest, Return, ReturnItem, ReturnResponse, ReturnStatus, RevenueByDay, ReviewResponse, ReviewSortBy, ReviewStatus, SendMessageRequest, Settlement, Shipment, ShipmentResponse, ShipmentStatus, ShippingAddress, ShippingAddressRequest, ShippingAddressResponse, ShippingMethod, ShippingMethodResponse, ShippingOption, ShippingRate, ShippingRateResponse, ShippingSettingsResponse, ShippingZone, ShippingZoneResponse, SortOrder, SuccessResponse, TaxBehavior, TaxBreakdownItem, TaxNexus, TaxNexusResponse, TaxReport, TaxReportDetails, TaxReportPeriodType, TaxReportResponse, TaxReportStatus, TaxRule, TaxRuleResponse, TaxSettings, TaxSettingsResponse, TaxType, TopProduct, TrackBannerRequest, UpdateBannerRequest, UpdateCouponRequest, UpdateFlashSaleRequest, UpdateOrderResponse, UpdateOrderStatusRequest, UpdateProductRequest, UpdateProductVariantRequest, UpdateShipmentRequest, UpdateShippingMethodRequest, UpdateShippingRateRequest, UpdateShippingSettingsRequest, UpdateShippingZoneRequest, UpdateTaxNexusRequest, UpdateTaxReportStatusRequest, UpdateTaxRuleRequest, UpdateTaxSettingsRequest, UserShippingAddress, ValidateDiscountRequest, ValidateDiscountResponse, buildQueryString, calculateDiscountAmount, calculateFinalPrice, formatPrice, getBackoffDelay, isRetryableError, isValidAddress, isValidEmail, parseError, retryWithBackoff, sleep, truncateAddress } from './ecommerce.mjs';
|
|
5
5
|
import 'axios';
|
|
6
6
|
|
|
7
7
|
declare function encodeSlug(slug: string): bigint;
|
|
@@ -527,7 +527,7 @@ declare const formatPriceForDisplay: ({ px, szDecimals, isSpot, }: {
|
|
|
527
527
|
* @returns Formatted size as number (rounded down to szDecimals if exceeds)
|
|
528
528
|
*/
|
|
529
529
|
declare const formatSizeForOrder: ({ sz, szDecimals, }: {
|
|
530
|
-
sz: number;
|
|
530
|
+
sz: number | string;
|
|
531
531
|
szDecimals: number;
|
|
532
532
|
}) => number;
|
|
533
533
|
/**
|
|
@@ -597,6 +597,15 @@ interface WeekInfo {
|
|
|
597
597
|
* @returns WeekInfo with weekNumber, startDate, and endDate
|
|
598
598
|
*/
|
|
599
599
|
declare function getLatestCompletedWeek(currentTimestamp?: number, offset?: number, weekStartsOn?: DayOfWeek): WeekInfo;
|
|
600
|
+
/**
|
|
601
|
+
* Gets week information from a week number.
|
|
602
|
+
* This is the inverse of getLatestCompletedWeek - it converts a week number to start/end dates.
|
|
603
|
+
*
|
|
604
|
+
* @param weekNumber - The week number (1-based, where week 1 starts at WEEK1_START_DATE)
|
|
605
|
+
* @param weekStartsOn - Day of week the week should start on. Defaults to Thursday.
|
|
606
|
+
* @returns WeekInfo with weekNumber, startDate, and endDate
|
|
607
|
+
*/
|
|
608
|
+
declare function getWeekInfoFromNumber(weekNumber: number, weekStartsOn?: DayOfWeek): WeekInfo;
|
|
600
609
|
|
|
601
610
|
declare function isHip3Symbol(symbol: string | undefined): boolean;
|
|
602
611
|
declare function getHip3Dex(symbol: string): string | null;
|
|
@@ -643,4 +652,4 @@ declare function isStableQuoteToken(coin: string): boolean;
|
|
|
643
652
|
declare function getDisplayMarketSymbol(coin: string | undefined, showCollateralTokenSymbol?: boolean, collateralTokenSymbol?: string): string | undefined;
|
|
644
653
|
declare function getDexFromCollateralTokenSymbol(collateralTokenSymbol: string): string | undefined;
|
|
645
654
|
|
|
646
|
-
export { type AirdropAllocationData, CloidClientCode, type CloidClientCodeId, CloidClientCodeNameById, type CloidData, DayOfWeek, type DexInfo, type ExtendedPerpsMeta, type MarketInfo, MetadataClient, PUP_TOKEN_ADDRESS, PUP_TOKEN_THRESHOLDS, type PerpDex, type PupEligibilityResult, ROOT_DEX, TARGET_APPROVED_MAX_BUILDER_FEE, TARGET_APPROVED_MAX_BUILDER_FEE_PERCENT, TESTNET_USDC_SPOT_TOKEN, type TokenInfo, USDC_SPOT_TOKEN, type UpheavalApiResponse, type UpheavalPosition, type UpheavalSnapshot, UserDexAbstractionTypes, type V3LPTokenInfo, type WeekInfo, WidgetType, WidgetTypeById, type WidgetTypeId, XP_BOOST_PERCENTAGES, buildCloid, calculateBoostPercentage, calculateTotalPupAmount, decodeSlug, enableHip3DexAbstractionWithAgent, encodeSlug, floorUtcDay, floorUtcHour, floorUtcMinutes, floorUtcWeek, formatPriceAndSize, formatPriceForDisplay, formatPriceForOrder, formatSizeForDisplay, formatSizeForOrder, getApprovalAmount, getClientCodeNameById, getCloid, getDexFromCollateralTokenSymbol, getDisplayMarketSymbol, getHip3Dex, getHip3DexAbstraction, getLatestCompletedWeek, getNextTierInfo, getPriceDecimals, getStaticCollateralTokenByDex, getStaticCollateralTokenSymbol, getWidgetTypeById, isBasedCloid, isClientCode, isHip3Symbol, isMiniAppCloid, isMiniAppTriggeredCloid, isSpotSymbol, isStableQuoteToken, isTenantCloid, isTrackingIdCloid, isWidgetType, makeUtcRounder, normaliseSlug, normaliseTrackingId, normalizeAirdropAmount, parseCloid, setHip3DexAbstraction, stableQuoteTokens };
|
|
655
|
+
export { type AirdropAllocationData, CloidClientCode, type CloidClientCodeId, CloidClientCodeNameById, type CloidData, DayOfWeek, type DexInfo, type ExtendedPerpsMeta, type MarketInfo, MetadataClient, PUP_TOKEN_ADDRESS, PUP_TOKEN_THRESHOLDS, type PerpDex, type PupEligibilityResult, ROOT_DEX, TARGET_APPROVED_MAX_BUILDER_FEE, TARGET_APPROVED_MAX_BUILDER_FEE_PERCENT, TESTNET_USDC_SPOT_TOKEN, type TokenInfo, USDC_SPOT_TOKEN, type UpheavalApiResponse, type UpheavalPosition, type UpheavalSnapshot, UserDexAbstractionTypes, type V3LPTokenInfo, type WeekInfo, WidgetType, WidgetTypeById, type WidgetTypeId, XP_BOOST_PERCENTAGES, buildCloid, calculateBoostPercentage, calculateTotalPupAmount, decodeSlug, enableHip3DexAbstractionWithAgent, encodeSlug, floorUtcDay, floorUtcHour, floorUtcMinutes, floorUtcWeek, formatPriceAndSize, formatPriceForDisplay, formatPriceForOrder, formatSizeForDisplay, formatSizeForOrder, getApprovalAmount, getClientCodeNameById, getCloid, getDexFromCollateralTokenSymbol, getDisplayMarketSymbol, getHip3Dex, getHip3DexAbstraction, getLatestCompletedWeek, getNextTierInfo, getPriceDecimals, getStaticCollateralTokenByDex, getStaticCollateralTokenSymbol, getWeekInfoFromNumber, getWidgetTypeById, isBasedCloid, isClientCode, isHip3Symbol, isMiniAppCloid, isMiniAppTriggeredCloid, isSpotSymbol, isStableQuoteToken, isTenantCloid, isTrackingIdCloid, isWidgetType, makeUtcRounder, normaliseSlug, normaliseTrackingId, normalizeAirdropAmount, parseCloid, setHip3DexAbstraction, stableQuoteTokens };
|
package/dist/index.d.ts
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
import { SpotToken, MarginTables, PerpsAssetCtx, SpotMeta, ExchangeClient, SuccessResponse, InfoClient } from '@nktkas/hyperliquid';
|
|
2
2
|
import { Hex } from '@nktkas/hyperliquid/types';
|
|
3
3
|
export { A as AllPerpsMeta, d as AssetIdUtils, B as BaseInstrument, I as InstrumentClient, M as MarketInstrument, c as PerpsInstrument, P as PerpsMeta, a as PerpsMetaAndAssetCtxs, b as PerpsUniverse, S as SpotInstrument, g as getAllPerpsMeta } from './client-CgmiTuEX.js';
|
|
4
|
-
export { ActiveFlashSalesResponse, AnalyticsOverview, ApiResponse, AppliedDiscount, Banner, BannerResponse, BannerType, BaseEcommerceClient, BaseEntity, CalculateCartDiscountsRequest, CalculateCartDiscountsResponse, CalculateTaxRequest, CalculateTaxResponse, CartItem, ConfirmEscrowDepositResponse, Coupon, CouponResponse, CouponUsage, CreateBannerRequest, CreateCouponRequest, CreateFlashSaleRequest, CreateOrderEventRequest, CreateOrderEventResponse, CreateOrderRequest, CreateOrderResponse, CreateProductRequest, CreateProductVariantRequest, CreateReviewRequest, CreateShippingMethodRequest, CreateTaxNexusRequest, CreateTaxRuleRequest, CustomerEcommerceClient, CustomerMessagesResponse, CustomerSummary, DiscountMethod, DiscountScope, DiscountType, EcommerceApiError, EcommerceClientConfig, FlashSale, FlashSaleItem, FlashSaleItemInput, FollowActionResponse, FollowStatusResponse, FollowedMerchantSummary, GenerateTaxReportRequest, GetAnalyticsParams, GetAnalyticsResponse, GetCouponResponse, GetOrderResponse, GetProductMetricsResponse, GetProductResponse, GetTaxReportResponse, InventoryAuditAction, InventoryAuditEntry, ListActiveBannersParams, ListActiveFlashSalesParams, ListBannersResponse, ListCouponsResponse, ListCustomersParams, ListCustomersResponse, ListFollowingParams, ListFollowingResponse, ListInventoryAuditResponse, ListMediaAssetsResponse, ListMerchantProductsParams, ListMessagesResponse, ListOrdersParams, ListOrdersResponse, ListProductVariantsResponse, ListProductsParams, ListProductsResponse, ListReturnsResponse, ListReviewsParams, ListReviewsResponse, ListShipmentsResponse, ListShippingAddressesResponse, ListShippingMethodsResponse, ListTaxNexusResponse, ListTaxReportsParams, ListTaxReportsResponse, ListTaxRulesResponse, MediaAsset, MediaAssetResponse, Merchant, MerchantEcommerceClient, MerchantProductsResponse, MerchantProfileRequest, MerchantProfileResponse, MerchantStatus, Message, MessageResponse, MessageStatsResponse, Order, OrderEvent, OrderItem, OrderReceiptResponse, OrderStatus, OrdersByStatus, PaginatedResponse, PaginationParams, Payment, PaymentMethod, PaymentStatus, Product, ProductDimensions, ProductDiscountsResponse, ProductMetrics, ProductResponse, ProductReview, ProductSortBy, ProductVariant, ProductVariantResponse, PublicMerchantProfile, PublicMerchantProfileResponse, RecentOrderSummary, RespondToReviewRequest, Return, ReturnItem, ReturnResponse, ReturnStatus, RevenueByDay, ReviewResponse, ReviewSortBy, ReviewStatus, SendMessageRequest, Settlement, Shipment, ShipmentResponse, ShipmentStatus, ShippingAddress, ShippingAddressRequest, ShippingAddressResponse, ShippingMethod, ShippingMethodResponse, SortOrder, SuccessResponse, TaxBehavior, TaxBreakdownItem, TaxNexus, TaxNexusResponse, TaxReport, TaxReportDetails, TaxReportPeriodType, TaxReportResponse, TaxReportStatus, TaxRule, TaxRuleResponse, TaxSettings, TaxSettingsResponse, TaxType, TopProduct, TrackBannerRequest, UpdateBannerRequest, UpdateCouponRequest, UpdateFlashSaleRequest, UpdateOrderResponse, UpdateOrderStatusRequest, UpdateProductRequest, UpdateProductVariantRequest, UpdateShipmentRequest, UpdateShippingMethodRequest, UpdateTaxNexusRequest, UpdateTaxReportStatusRequest, UpdateTaxRuleRequest, UpdateTaxSettingsRequest, UserShippingAddress, ValidateDiscountRequest, ValidateDiscountResponse, buildQueryString, calculateDiscountAmount, calculateFinalPrice, formatPrice, getBackoffDelay, isRetryableError, isValidAddress, isValidEmail, parseError, retryWithBackoff, sleep, truncateAddress } from './ecommerce.js';
|
|
4
|
+
export { ActiveFlashSalesResponse, AnalyticsOverview, ApiResponse, AppliedDiscount, Banner, BannerResponse, BannerType, BaseEcommerceClient, BaseEntity, CalculateCartDiscountsRequest, CalculateCartDiscountsResponse, CalculateShippingRequest, CalculateShippingResponse, CalculateTaxRequest, CalculateTaxResponse, CartItem, ConfirmEscrowDepositResponse, Coupon, CouponResponse, CouponUsage, CreateBannerRequest, CreateCouponRequest, CreateFlashSaleRequest, CreateOrderEventRequest, CreateOrderEventResponse, CreateOrderRequest, CreateOrderResponse, CreateProductRequest, CreateProductVariantRequest, CreateReviewRequest, CreateShippingMethodRequest, CreateShippingRateRequest, CreateShippingZoneRequest, CreateTaxNexusRequest, CreateTaxRuleRequest, CustomerEcommerceClient, CustomerMessagesResponse, CustomerSummary, DiscountMethod, DiscountScope, DiscountType, EcommerceApiError, EcommerceClientConfig, FlashSale, FlashSaleItem, FlashSaleItemInput, FollowActionResponse, FollowStatusResponse, FollowedMerchantSummary, GenerateTaxReportRequest, GetAnalyticsParams, GetAnalyticsResponse, GetCouponResponse, GetOrderResponse, GetPaymentMethodsResponse, GetProductMetricsResponse, GetProductResponse, GetTaxReportResponse, InventoryAuditAction, InventoryAuditEntry, ListActiveBannersParams, ListActiveFlashSalesParams, ListBannersResponse, ListCouponsResponse, ListCustomersParams, ListCustomersResponse, ListFollowingParams, ListFollowingResponse, ListInventoryAuditResponse, ListMediaAssetsResponse, ListMerchantProductsParams, ListMessagesResponse, ListOrdersParams, ListOrdersResponse, ListProductVariantsResponse, ListProductsParams, ListProductsResponse, ListReturnsResponse, ListReviewsParams, ListReviewsResponse, ListShipmentsResponse, ListShippingAddressesResponse, ListShippingMethodsResponse, ListShippingRatesResponse, ListShippingZonesResponse, ListTaxNexusResponse, ListTaxReportsParams, ListTaxReportsResponse, ListTaxRulesResponse, MediaAsset, MediaAssetResponse, Merchant, MerchantEcommerceClient, MerchantProductsResponse, MerchantProfileRequest, MerchantProfileResponse, MerchantShippingSettings, MerchantStatus, Message, MessageResponse, MessageStatsResponse, Order, OrderEvent, OrderItem, OrderReceiptResponse, OrderStatus, OrdersByStatus, PaginatedResponse, PaginationParams, Payment, PaymentMethod, PaymentMethodInfo, PaymentStatus, ProcessPaymentRequest, ProcessPaymentResponse, Product, ProductDimensions, ProductDiscountsResponse, ProductMetrics, ProductResponse, ProductReview, ProductSortBy, ProductVariant, ProductVariantResponse, PublicMerchantProfile, PublicMerchantProfileResponse, RecentOrderSummary, RespondToReviewRequest, Return, ReturnItem, ReturnResponse, ReturnStatus, RevenueByDay, ReviewResponse, ReviewSortBy, ReviewStatus, SendMessageRequest, Settlement, Shipment, ShipmentResponse, ShipmentStatus, ShippingAddress, ShippingAddressRequest, ShippingAddressResponse, ShippingMethod, ShippingMethodResponse, ShippingOption, ShippingRate, ShippingRateResponse, ShippingSettingsResponse, ShippingZone, ShippingZoneResponse, SortOrder, SuccessResponse, TaxBehavior, TaxBreakdownItem, TaxNexus, TaxNexusResponse, TaxReport, TaxReportDetails, TaxReportPeriodType, TaxReportResponse, TaxReportStatus, TaxRule, TaxRuleResponse, TaxSettings, TaxSettingsResponse, TaxType, TopProduct, TrackBannerRequest, UpdateBannerRequest, UpdateCouponRequest, UpdateFlashSaleRequest, UpdateOrderResponse, UpdateOrderStatusRequest, UpdateProductRequest, UpdateProductVariantRequest, UpdateShipmentRequest, UpdateShippingMethodRequest, UpdateShippingRateRequest, UpdateShippingSettingsRequest, UpdateShippingZoneRequest, UpdateTaxNexusRequest, UpdateTaxReportStatusRequest, UpdateTaxRuleRequest, UpdateTaxSettingsRequest, UserShippingAddress, ValidateDiscountRequest, ValidateDiscountResponse, buildQueryString, calculateDiscountAmount, calculateFinalPrice, formatPrice, getBackoffDelay, isRetryableError, isValidAddress, isValidEmail, parseError, retryWithBackoff, sleep, truncateAddress } from './ecommerce.js';
|
|
5
5
|
import 'axios';
|
|
6
6
|
|
|
7
7
|
declare function encodeSlug(slug: string): bigint;
|
|
@@ -527,7 +527,7 @@ declare const formatPriceForDisplay: ({ px, szDecimals, isSpot, }: {
|
|
|
527
527
|
* @returns Formatted size as number (rounded down to szDecimals if exceeds)
|
|
528
528
|
*/
|
|
529
529
|
declare const formatSizeForOrder: ({ sz, szDecimals, }: {
|
|
530
|
-
sz: number;
|
|
530
|
+
sz: number | string;
|
|
531
531
|
szDecimals: number;
|
|
532
532
|
}) => number;
|
|
533
533
|
/**
|
|
@@ -597,6 +597,15 @@ interface WeekInfo {
|
|
|
597
597
|
* @returns WeekInfo with weekNumber, startDate, and endDate
|
|
598
598
|
*/
|
|
599
599
|
declare function getLatestCompletedWeek(currentTimestamp?: number, offset?: number, weekStartsOn?: DayOfWeek): WeekInfo;
|
|
600
|
+
/**
|
|
601
|
+
* Gets week information from a week number.
|
|
602
|
+
* This is the inverse of getLatestCompletedWeek - it converts a week number to start/end dates.
|
|
603
|
+
*
|
|
604
|
+
* @param weekNumber - The week number (1-based, where week 1 starts at WEEK1_START_DATE)
|
|
605
|
+
* @param weekStartsOn - Day of week the week should start on. Defaults to Thursday.
|
|
606
|
+
* @returns WeekInfo with weekNumber, startDate, and endDate
|
|
607
|
+
*/
|
|
608
|
+
declare function getWeekInfoFromNumber(weekNumber: number, weekStartsOn?: DayOfWeek): WeekInfo;
|
|
600
609
|
|
|
601
610
|
declare function isHip3Symbol(symbol: string | undefined): boolean;
|
|
602
611
|
declare function getHip3Dex(symbol: string): string | null;
|
|
@@ -643,4 +652,4 @@ declare function isStableQuoteToken(coin: string): boolean;
|
|
|
643
652
|
declare function getDisplayMarketSymbol(coin: string | undefined, showCollateralTokenSymbol?: boolean, collateralTokenSymbol?: string): string | undefined;
|
|
644
653
|
declare function getDexFromCollateralTokenSymbol(collateralTokenSymbol: string): string | undefined;
|
|
645
654
|
|
|
646
|
-
export { type AirdropAllocationData, CloidClientCode, type CloidClientCodeId, CloidClientCodeNameById, type CloidData, DayOfWeek, type DexInfo, type ExtendedPerpsMeta, type MarketInfo, MetadataClient, PUP_TOKEN_ADDRESS, PUP_TOKEN_THRESHOLDS, type PerpDex, type PupEligibilityResult, ROOT_DEX, TARGET_APPROVED_MAX_BUILDER_FEE, TARGET_APPROVED_MAX_BUILDER_FEE_PERCENT, TESTNET_USDC_SPOT_TOKEN, type TokenInfo, USDC_SPOT_TOKEN, type UpheavalApiResponse, type UpheavalPosition, type UpheavalSnapshot, UserDexAbstractionTypes, type V3LPTokenInfo, type WeekInfo, WidgetType, WidgetTypeById, type WidgetTypeId, XP_BOOST_PERCENTAGES, buildCloid, calculateBoostPercentage, calculateTotalPupAmount, decodeSlug, enableHip3DexAbstractionWithAgent, encodeSlug, floorUtcDay, floorUtcHour, floorUtcMinutes, floorUtcWeek, formatPriceAndSize, formatPriceForDisplay, formatPriceForOrder, formatSizeForDisplay, formatSizeForOrder, getApprovalAmount, getClientCodeNameById, getCloid, getDexFromCollateralTokenSymbol, getDisplayMarketSymbol, getHip3Dex, getHip3DexAbstraction, getLatestCompletedWeek, getNextTierInfo, getPriceDecimals, getStaticCollateralTokenByDex, getStaticCollateralTokenSymbol, getWidgetTypeById, isBasedCloid, isClientCode, isHip3Symbol, isMiniAppCloid, isMiniAppTriggeredCloid, isSpotSymbol, isStableQuoteToken, isTenantCloid, isTrackingIdCloid, isWidgetType, makeUtcRounder, normaliseSlug, normaliseTrackingId, normalizeAirdropAmount, parseCloid, setHip3DexAbstraction, stableQuoteTokens };
|
|
655
|
+
export { type AirdropAllocationData, CloidClientCode, type CloidClientCodeId, CloidClientCodeNameById, type CloidData, DayOfWeek, type DexInfo, type ExtendedPerpsMeta, type MarketInfo, MetadataClient, PUP_TOKEN_ADDRESS, PUP_TOKEN_THRESHOLDS, type PerpDex, type PupEligibilityResult, ROOT_DEX, TARGET_APPROVED_MAX_BUILDER_FEE, TARGET_APPROVED_MAX_BUILDER_FEE_PERCENT, TESTNET_USDC_SPOT_TOKEN, type TokenInfo, USDC_SPOT_TOKEN, type UpheavalApiResponse, type UpheavalPosition, type UpheavalSnapshot, UserDexAbstractionTypes, type V3LPTokenInfo, type WeekInfo, WidgetType, WidgetTypeById, type WidgetTypeId, XP_BOOST_PERCENTAGES, buildCloid, calculateBoostPercentage, calculateTotalPupAmount, decodeSlug, enableHip3DexAbstractionWithAgent, encodeSlug, floorUtcDay, floorUtcHour, floorUtcMinutes, floorUtcWeek, formatPriceAndSize, formatPriceForDisplay, formatPriceForOrder, formatSizeForDisplay, formatSizeForOrder, getApprovalAmount, getClientCodeNameById, getCloid, getDexFromCollateralTokenSymbol, getDisplayMarketSymbol, getHip3Dex, getHip3DexAbstraction, getLatestCompletedWeek, getNextTierInfo, getPriceDecimals, getStaticCollateralTokenByDex, getStaticCollateralTokenSymbol, getWeekInfoFromNumber, getWidgetTypeById, isBasedCloid, isClientCode, isHip3Symbol, isMiniAppCloid, isMiniAppTriggeredCloid, isSpotSymbol, isStableQuoteToken, isTenantCloid, isTrackingIdCloid, isWidgetType, makeUtcRounder, normaliseSlug, normaliseTrackingId, normalizeAirdropAmount, parseCloid, setHip3DexAbstraction, stableQuoteTokens };
|