@klappay/types 3.2.0 → 3.4.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 +1 -1
- package/dist/index.d.mts +113 -39
- package/dist/index.d.ts +113 -39
- package/dist/index.js +279 -245
- package/dist/index.js.map +1 -1
- package/dist/index.mjs +277 -245
- package/dist/index.mjs.map +1 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -68,7 +68,7 @@ for feeding an agent or MCP server.
|
|
|
68
68
|
| Doc | Covers |
|
|
69
69
|
|---|---|
|
|
70
70
|
| [Getting started](https://api.klappay.com/types/getting-started) | Install, what's in this package, typing vs. runtime validation |
|
|
71
|
-
| [Charges](https://api.klappay.com/types/charges) | `Charge`, `CreateChargeInput`, `AcceptedPayment`, `Capabilities` (`GET /v1/networks`), listing/pagination, `TimelineEvent`, `CheckChargeRequestSchema` (on-demand check) |
|
|
71
|
+
| [Charges](https://api.klappay.com/types/charges) | `Charge`, `CreateChargeInput`, `AcceptedPayment`, `Capabilities` (`GET /v1/networks`), listing/pagination, `TimelineEvent`, `CheckChargeRequestSchema` (on-demand check), `EscrowConfigSchema`/`ReleaseEscrowRequestSchema` (escrow, not yet usable) |
|
|
72
72
|
| [Webhooks](https://api.klappay.com/types/webhooks) | Every `WebhookEventType`, categories, `Webhook`, `WebhookPayload`, `TypedWebhookPayload` |
|
|
73
73
|
| [Sandbox](https://api.klappay.com/types/sandbox) | `SandboxTriggerInput`, `TriggerableChargeEvent` |
|
|
74
74
|
| [Distributions](https://api.klappay.com/types/distributions) | `PendingDistribution`, `PendingDistributionEvent` — the 0xSplits keeper feed |
|
package/dist/index.d.mts
CHANGED
|
@@ -243,6 +243,13 @@ declare const CreateChargeSchema: z.ZodObject<{
|
|
|
243
243
|
recipientId: string;
|
|
244
244
|
label?: string | undefined;
|
|
245
245
|
}[]>>;
|
|
246
|
+
escrow: z.ZodOptional<z.ZodObject<{
|
|
247
|
+
releaserAddress: z.ZodOptional<z.ZodString>;
|
|
248
|
+
}, "strip", z.ZodTypeAny, {
|
|
249
|
+
releaserAddress?: string | undefined;
|
|
250
|
+
}, {
|
|
251
|
+
releaserAddress?: string | undefined;
|
|
252
|
+
}>>;
|
|
246
253
|
}, "strip", z.ZodTypeAny, {
|
|
247
254
|
amount: number;
|
|
248
255
|
currency: "USD";
|
|
@@ -289,6 +296,9 @@ declare const CreateChargeSchema: z.ZodObject<{
|
|
|
289
296
|
recipientId: string;
|
|
290
297
|
label?: string | undefined;
|
|
291
298
|
}[] | undefined;
|
|
299
|
+
escrow?: {
|
|
300
|
+
releaserAddress?: string | undefined;
|
|
301
|
+
} | undefined;
|
|
292
302
|
}, {
|
|
293
303
|
amount: number;
|
|
294
304
|
acceptedPayments: {
|
|
@@ -335,6 +345,9 @@ declare const CreateChargeSchema: z.ZodObject<{
|
|
|
335
345
|
recipientId: string;
|
|
336
346
|
label?: string | undefined;
|
|
337
347
|
}[] | undefined;
|
|
348
|
+
escrow?: {
|
|
349
|
+
releaserAddress?: string | undefined;
|
|
350
|
+
} | undefined;
|
|
338
351
|
}>;
|
|
339
352
|
type CreateChargeInput = z.infer<typeof CreateChargeSchema>;
|
|
340
353
|
type CreateChargeRequest = z.input<typeof CreateChargeSchema>;
|
|
@@ -487,6 +500,16 @@ declare const ChargeSchema: z.ZodObject<{
|
|
|
487
500
|
confirmedAt: z.ZodNullable<z.ZodString>;
|
|
488
501
|
settledAt: z.ZodNullable<z.ZodString>;
|
|
489
502
|
lastActivityAt: z.ZodString;
|
|
503
|
+
escrow: z.ZodNullable<z.ZodObject<{
|
|
504
|
+
releaserAddress: z.ZodString;
|
|
505
|
+
releasedAt: z.ZodNullable<z.ZodString>;
|
|
506
|
+
}, "strip", z.ZodTypeAny, {
|
|
507
|
+
releaserAddress: string;
|
|
508
|
+
releasedAt: string | null;
|
|
509
|
+
}, {
|
|
510
|
+
releaserAddress: string;
|
|
511
|
+
releasedAt: string | null;
|
|
512
|
+
}>>;
|
|
490
513
|
}, "strip", z.ZodTypeAny, {
|
|
491
514
|
status: "pending" | "partially_paid" | "confirmed" | "expired" | "underpaid";
|
|
492
515
|
address: string;
|
|
@@ -533,6 +556,10 @@ declare const ChargeSchema: z.ZodObject<{
|
|
|
533
556
|
percent: number;
|
|
534
557
|
label?: string | undefined;
|
|
535
558
|
}[];
|
|
559
|
+
escrow: {
|
|
560
|
+
releaserAddress: string;
|
|
561
|
+
releasedAt: string | null;
|
|
562
|
+
} | null;
|
|
536
563
|
id: string;
|
|
537
564
|
amountReceived: number | null;
|
|
538
565
|
isOverpaid: boolean;
|
|
@@ -600,6 +627,10 @@ declare const ChargeSchema: z.ZodObject<{
|
|
|
600
627
|
percent: number;
|
|
601
628
|
label?: string | undefined;
|
|
602
629
|
}[];
|
|
630
|
+
escrow: {
|
|
631
|
+
releaserAddress: string;
|
|
632
|
+
releasedAt: string | null;
|
|
633
|
+
} | null;
|
|
603
634
|
id: string;
|
|
604
635
|
amountReceived: number | null;
|
|
605
636
|
isOverpaid: boolean;
|
|
@@ -804,6 +835,16 @@ declare const PaginatedChargesSchema: z.ZodObject<{
|
|
|
804
835
|
confirmedAt: z.ZodNullable<z.ZodString>;
|
|
805
836
|
settledAt: z.ZodNullable<z.ZodString>;
|
|
806
837
|
lastActivityAt: z.ZodString;
|
|
838
|
+
escrow: z.ZodNullable<z.ZodObject<{
|
|
839
|
+
releaserAddress: z.ZodString;
|
|
840
|
+
releasedAt: z.ZodNullable<z.ZodString>;
|
|
841
|
+
}, "strip", z.ZodTypeAny, {
|
|
842
|
+
releaserAddress: string;
|
|
843
|
+
releasedAt: string | null;
|
|
844
|
+
}, {
|
|
845
|
+
releaserAddress: string;
|
|
846
|
+
releasedAt: string | null;
|
|
847
|
+
}>>;
|
|
807
848
|
}, "strip", z.ZodTypeAny, {
|
|
808
849
|
status: "pending" | "partially_paid" | "confirmed" | "expired" | "underpaid";
|
|
809
850
|
address: string;
|
|
@@ -850,6 +891,10 @@ declare const PaginatedChargesSchema: z.ZodObject<{
|
|
|
850
891
|
percent: number;
|
|
851
892
|
label?: string | undefined;
|
|
852
893
|
}[];
|
|
894
|
+
escrow: {
|
|
895
|
+
releaserAddress: string;
|
|
896
|
+
releasedAt: string | null;
|
|
897
|
+
} | null;
|
|
853
898
|
id: string;
|
|
854
899
|
amountReceived: number | null;
|
|
855
900
|
isOverpaid: boolean;
|
|
@@ -917,6 +962,10 @@ declare const PaginatedChargesSchema: z.ZodObject<{
|
|
|
917
962
|
percent: number;
|
|
918
963
|
label?: string | undefined;
|
|
919
964
|
}[];
|
|
965
|
+
escrow: {
|
|
966
|
+
releaserAddress: string;
|
|
967
|
+
releasedAt: string | null;
|
|
968
|
+
} | null;
|
|
920
969
|
id: string;
|
|
921
970
|
amountReceived: number | null;
|
|
922
971
|
isOverpaid: boolean;
|
|
@@ -988,6 +1037,10 @@ declare const PaginatedChargesSchema: z.ZodObject<{
|
|
|
988
1037
|
percent: number;
|
|
989
1038
|
label?: string | undefined;
|
|
990
1039
|
}[];
|
|
1040
|
+
escrow: {
|
|
1041
|
+
releaserAddress: string;
|
|
1042
|
+
releasedAt: string | null;
|
|
1043
|
+
} | null;
|
|
991
1044
|
id: string;
|
|
992
1045
|
amountReceived: number | null;
|
|
993
1046
|
isOverpaid: boolean;
|
|
@@ -1059,6 +1112,10 @@ declare const PaginatedChargesSchema: z.ZodObject<{
|
|
|
1059
1112
|
percent: number;
|
|
1060
1113
|
label?: string | undefined;
|
|
1061
1114
|
}[];
|
|
1115
|
+
escrow: {
|
|
1116
|
+
releaserAddress: string;
|
|
1117
|
+
releasedAt: string | null;
|
|
1118
|
+
} | null;
|
|
1062
1119
|
id: string;
|
|
1063
1120
|
amountReceived: number | null;
|
|
1064
1121
|
isOverpaid: boolean;
|
|
@@ -1116,6 +1173,23 @@ declare const CheckChargeRequestSchema: z.ZodEffects<z.ZodObject<{
|
|
|
1116
1173
|
}>;
|
|
1117
1174
|
type CheckChargeRequest = z.infer<typeof CheckChargeRequestSchema>;
|
|
1118
1175
|
|
|
1176
|
+
declare const EscrowConfigSchema: z.ZodObject<{
|
|
1177
|
+
releaserAddress: z.ZodOptional<z.ZodString>;
|
|
1178
|
+
}, "strip", z.ZodTypeAny, {
|
|
1179
|
+
releaserAddress?: string | undefined;
|
|
1180
|
+
}, {
|
|
1181
|
+
releaserAddress?: string | undefined;
|
|
1182
|
+
}>;
|
|
1183
|
+
type EscrowConfig = z.infer<typeof EscrowConfigSchema>;
|
|
1184
|
+
declare const ReleaseEscrowRequestSchema: z.ZodObject<{
|
|
1185
|
+
signature: z.ZodString;
|
|
1186
|
+
}, "strip", z.ZodTypeAny, {
|
|
1187
|
+
signature: string;
|
|
1188
|
+
}, {
|
|
1189
|
+
signature: string;
|
|
1190
|
+
}>;
|
|
1191
|
+
type ReleaseEscrowRequest = z.infer<typeof ReleaseEscrowRequestSchema>;
|
|
1192
|
+
|
|
1119
1193
|
declare const CHECKOUT_PRODUCTS_MAX = 20;
|
|
1120
1194
|
declare const CheckoutProductSchema: z.ZodObject<{
|
|
1121
1195
|
name: z.ZodString;
|
|
@@ -1490,11 +1564,11 @@ declare const METRICS_QUERY_DEFAULT_ROW_LIMIT = 100;
|
|
|
1490
1564
|
declare const METRICS_QUERY_MAX_GROUP_BY = 3;
|
|
1491
1565
|
declare const METRICS_QUERY_MAX_FILTERS = 20;
|
|
1492
1566
|
declare const METRICS_QUERY_MAX_METRICS = 10;
|
|
1493
|
-
declare const ChargesQueryFieldSchema: z.ZodEnum<["status", "source", "apiKeyId", "currency", "isOverpaid", "externalRef"]>;
|
|
1567
|
+
declare const ChargesQueryFieldSchema: z.ZodEnum<["status", "source", "apiKeyId", "currency", "isOverpaid", "externalRef", "escrowReleaserAddress"]>;
|
|
1494
1568
|
type ChargesQueryField = z.infer<typeof ChargesQueryFieldSchema>;
|
|
1495
|
-
declare const ChargesMetricFieldSchema: z.ZodEnum<["amount", "amountReceived", "feePercent"]>;
|
|
1569
|
+
declare const ChargesMetricFieldSchema: z.ZodEnum<["amount", "amountReceived", "feePercent", "escrowFeePercent"]>;
|
|
1496
1570
|
type ChargesMetricField = z.infer<typeof ChargesMetricFieldSchema>;
|
|
1497
|
-
declare const ChargesDateFieldSchema: z.ZodEnum<["createdAt", "confirmedAt", "lastActivityAt", "expiresAt"]>;
|
|
1571
|
+
declare const ChargesDateFieldSchema: z.ZodEnum<["createdAt", "confirmedAt", "lastActivityAt", "expiresAt", "escrowReleasedAt"]>;
|
|
1498
1572
|
type ChargesDateField = z.infer<typeof ChargesDateFieldSchema>;
|
|
1499
1573
|
declare const TransactionsQueryFieldSchema: z.ZodEnum<["network", "token", "source", "causedTransition"]>;
|
|
1500
1574
|
type TransactionsQueryField = z.infer<typeof TransactionsQueryFieldSchema>;
|
|
@@ -1512,64 +1586,64 @@ declare const MetricsQuerySchema: z.ZodEffects<z.ZodDiscriminatedUnion<"resource
|
|
|
1512
1586
|
resource: z.ZodLiteral<"charges">;
|
|
1513
1587
|
environment: z.ZodEnum<["live", "test"]>;
|
|
1514
1588
|
dateRange: z.ZodObject<{
|
|
1515
|
-
field: z.ZodEnum<["createdAt", "confirmedAt", "lastActivityAt", "expiresAt"]>;
|
|
1589
|
+
field: z.ZodEnum<["createdAt", "confirmedAt", "lastActivityAt", "expiresAt", "escrowReleasedAt"]>;
|
|
1516
1590
|
from: z.ZodString;
|
|
1517
1591
|
to: z.ZodString;
|
|
1518
1592
|
}, "strip", z.ZodTypeAny, {
|
|
1519
|
-
field: "createdAt" | "expiresAt" | "confirmedAt" | "lastActivityAt";
|
|
1593
|
+
field: "createdAt" | "expiresAt" | "confirmedAt" | "lastActivityAt" | "escrowReleasedAt";
|
|
1520
1594
|
from: string;
|
|
1521
1595
|
to: string;
|
|
1522
1596
|
}, {
|
|
1523
|
-
field: "createdAt" | "expiresAt" | "confirmedAt" | "lastActivityAt";
|
|
1597
|
+
field: "createdAt" | "expiresAt" | "confirmedAt" | "lastActivityAt" | "escrowReleasedAt";
|
|
1524
1598
|
from: string;
|
|
1525
1599
|
to: string;
|
|
1526
1600
|
}>;
|
|
1527
1601
|
groupBy: z.ZodDefault<z.ZodArray<z.ZodUnion<[z.ZodObject<{
|
|
1528
1602
|
type: z.ZodLiteral<"field">;
|
|
1529
|
-
field: z.ZodEnum<["status", "source", "apiKeyId", "currency", "isOverpaid", "externalRef"]>;
|
|
1603
|
+
field: z.ZodEnum<["status", "source", "apiKeyId", "currency", "isOverpaid", "externalRef", "escrowReleaserAddress"]>;
|
|
1530
1604
|
}, "strip", z.ZodTypeAny, {
|
|
1531
1605
|
type: "field";
|
|
1532
|
-
field: "status" | "currency" | "externalRef" | "source" | "isOverpaid" | "apiKeyId";
|
|
1606
|
+
field: "status" | "currency" | "externalRef" | "source" | "isOverpaid" | "apiKeyId" | "escrowReleaserAddress";
|
|
1533
1607
|
}, {
|
|
1534
1608
|
type: "field";
|
|
1535
|
-
field: "status" | "currency" | "externalRef" | "source" | "isOverpaid" | "apiKeyId";
|
|
1609
|
+
field: "status" | "currency" | "externalRef" | "source" | "isOverpaid" | "apiKeyId" | "escrowReleaserAddress";
|
|
1536
1610
|
}>, z.ZodObject<{
|
|
1537
1611
|
type: z.ZodLiteral<"date_bucket">;
|
|
1538
|
-
field: z.ZodEnum<["createdAt", "confirmedAt", "lastActivityAt", "expiresAt"]>;
|
|
1612
|
+
field: z.ZodEnum<["createdAt", "confirmedAt", "lastActivityAt", "expiresAt", "escrowReleasedAt"]>;
|
|
1539
1613
|
granularity: z.ZodEnum<["day", "week", "month", "year"]>;
|
|
1540
1614
|
}, "strip", z.ZodTypeAny, {
|
|
1541
1615
|
type: "date_bucket";
|
|
1542
|
-
field: "createdAt" | "expiresAt" | "confirmedAt" | "lastActivityAt";
|
|
1616
|
+
field: "createdAt" | "expiresAt" | "confirmedAt" | "lastActivityAt" | "escrowReleasedAt";
|
|
1543
1617
|
granularity: "day" | "week" | "month" | "year";
|
|
1544
1618
|
}, {
|
|
1545
1619
|
type: "date_bucket";
|
|
1546
|
-
field: "createdAt" | "expiresAt" | "confirmedAt" | "lastActivityAt";
|
|
1620
|
+
field: "createdAt" | "expiresAt" | "confirmedAt" | "lastActivityAt" | "escrowReleasedAt";
|
|
1547
1621
|
granularity: "day" | "week" | "month" | "year";
|
|
1548
1622
|
}>]>, "many">>;
|
|
1549
1623
|
metrics: z.ZodArray<z.ZodObject<{
|
|
1550
1624
|
aggregation: z.ZodEnum<["count", "sum", "avg", "min", "max"]>;
|
|
1551
|
-
field: z.ZodOptional<z.ZodEnum<["amount", "amountReceived", "feePercent"]>>;
|
|
1625
|
+
field: z.ZodOptional<z.ZodEnum<["amount", "amountReceived", "feePercent", "escrowFeePercent"]>>;
|
|
1552
1626
|
alias: z.ZodOptional<z.ZodString>;
|
|
1553
1627
|
}, "strip", z.ZodTypeAny, {
|
|
1554
1628
|
aggregation: "count" | "sum" | "avg" | "min" | "max";
|
|
1555
|
-
field?: "amount" | "amountReceived" | "feePercent" | undefined;
|
|
1629
|
+
field?: "amount" | "amountReceived" | "feePercent" | "escrowFeePercent" | undefined;
|
|
1556
1630
|
alias?: string | undefined;
|
|
1557
1631
|
}, {
|
|
1558
1632
|
aggregation: "count" | "sum" | "avg" | "min" | "max";
|
|
1559
|
-
field?: "amount" | "amountReceived" | "feePercent" | undefined;
|
|
1633
|
+
field?: "amount" | "amountReceived" | "feePercent" | "escrowFeePercent" | undefined;
|
|
1560
1634
|
alias?: string | undefined;
|
|
1561
1635
|
}>, "many">;
|
|
1562
1636
|
filters: z.ZodDefault<z.ZodArray<z.ZodObject<{
|
|
1563
|
-
field: z.ZodEnum<["status", "source", "apiKeyId", "currency", "isOverpaid", "externalRef"]>;
|
|
1637
|
+
field: z.ZodEnum<["status", "source", "apiKeyId", "currency", "isOverpaid", "externalRef", "escrowReleaserAddress"]>;
|
|
1564
1638
|
operator: z.ZodEnum<["eq", "neq", "in", "gt", "gte", "lt", "lte"]>;
|
|
1565
1639
|
value: z.ZodUnion<[z.ZodString, z.ZodNumber, z.ZodBoolean, z.ZodArray<z.ZodUnion<[z.ZodString, z.ZodNumber]>, "many">]>;
|
|
1566
1640
|
}, "strip", z.ZodTypeAny, {
|
|
1567
1641
|
value: string | number | boolean | (string | number)[];
|
|
1568
|
-
field: "status" | "currency" | "externalRef" | "source" | "isOverpaid" | "apiKeyId";
|
|
1642
|
+
field: "status" | "currency" | "externalRef" | "source" | "isOverpaid" | "apiKeyId" | "escrowReleaserAddress";
|
|
1569
1643
|
operator: "eq" | "neq" | "in" | "gt" | "gte" | "lt" | "lte";
|
|
1570
1644
|
}, {
|
|
1571
1645
|
value: string | number | boolean | (string | number)[];
|
|
1572
|
-
field: "status" | "currency" | "externalRef" | "source" | "isOverpaid" | "apiKeyId";
|
|
1646
|
+
field: "status" | "currency" | "externalRef" | "source" | "isOverpaid" | "apiKeyId" | "escrowReleaserAddress";
|
|
1573
1647
|
operator: "eq" | "neq" | "in" | "gt" | "gte" | "lt" | "lte";
|
|
1574
1648
|
}>, "many">>;
|
|
1575
1649
|
orderBy: z.ZodOptional<z.ZodObject<{
|
|
@@ -1588,26 +1662,26 @@ declare const MetricsQuerySchema: z.ZodEffects<z.ZodDiscriminatedUnion<"resource
|
|
|
1588
1662
|
environment: "live" | "test";
|
|
1589
1663
|
resource: "charges";
|
|
1590
1664
|
dateRange: {
|
|
1591
|
-
field: "createdAt" | "expiresAt" | "confirmedAt" | "lastActivityAt";
|
|
1665
|
+
field: "createdAt" | "expiresAt" | "confirmedAt" | "lastActivityAt" | "escrowReleasedAt";
|
|
1592
1666
|
from: string;
|
|
1593
1667
|
to: string;
|
|
1594
1668
|
};
|
|
1595
1669
|
groupBy: ({
|
|
1596
1670
|
type: "field";
|
|
1597
|
-
field: "status" | "currency" | "externalRef" | "source" | "isOverpaid" | "apiKeyId";
|
|
1671
|
+
field: "status" | "currency" | "externalRef" | "source" | "isOverpaid" | "apiKeyId" | "escrowReleaserAddress";
|
|
1598
1672
|
} | {
|
|
1599
1673
|
type: "date_bucket";
|
|
1600
|
-
field: "createdAt" | "expiresAt" | "confirmedAt" | "lastActivityAt";
|
|
1674
|
+
field: "createdAt" | "expiresAt" | "confirmedAt" | "lastActivityAt" | "escrowReleasedAt";
|
|
1601
1675
|
granularity: "day" | "week" | "month" | "year";
|
|
1602
1676
|
})[];
|
|
1603
1677
|
metrics: {
|
|
1604
1678
|
aggregation: "count" | "sum" | "avg" | "min" | "max";
|
|
1605
|
-
field?: "amount" | "amountReceived" | "feePercent" | undefined;
|
|
1679
|
+
field?: "amount" | "amountReceived" | "feePercent" | "escrowFeePercent" | undefined;
|
|
1606
1680
|
alias?: string | undefined;
|
|
1607
1681
|
}[];
|
|
1608
1682
|
filters: {
|
|
1609
1683
|
value: string | number | boolean | (string | number)[];
|
|
1610
|
-
field: "status" | "currency" | "externalRef" | "source" | "isOverpaid" | "apiKeyId";
|
|
1684
|
+
field: "status" | "currency" | "externalRef" | "source" | "isOverpaid" | "apiKeyId" | "escrowReleaserAddress";
|
|
1611
1685
|
operator: "eq" | "neq" | "in" | "gt" | "gte" | "lt" | "lte";
|
|
1612
1686
|
}[];
|
|
1613
1687
|
orderBy?: {
|
|
@@ -1618,27 +1692,27 @@ declare const MetricsQuerySchema: z.ZodEffects<z.ZodDiscriminatedUnion<"resource
|
|
|
1618
1692
|
environment: "live" | "test";
|
|
1619
1693
|
resource: "charges";
|
|
1620
1694
|
dateRange: {
|
|
1621
|
-
field: "createdAt" | "expiresAt" | "confirmedAt" | "lastActivityAt";
|
|
1695
|
+
field: "createdAt" | "expiresAt" | "confirmedAt" | "lastActivityAt" | "escrowReleasedAt";
|
|
1622
1696
|
from: string;
|
|
1623
1697
|
to: string;
|
|
1624
1698
|
};
|
|
1625
1699
|
metrics: {
|
|
1626
1700
|
aggregation: "count" | "sum" | "avg" | "min" | "max";
|
|
1627
|
-
field?: "amount" | "amountReceived" | "feePercent" | undefined;
|
|
1701
|
+
field?: "amount" | "amountReceived" | "feePercent" | "escrowFeePercent" | undefined;
|
|
1628
1702
|
alias?: string | undefined;
|
|
1629
1703
|
}[];
|
|
1630
1704
|
limit?: number | undefined;
|
|
1631
1705
|
groupBy?: ({
|
|
1632
1706
|
type: "field";
|
|
1633
|
-
field: "status" | "currency" | "externalRef" | "source" | "isOverpaid" | "apiKeyId";
|
|
1707
|
+
field: "status" | "currency" | "externalRef" | "source" | "isOverpaid" | "apiKeyId" | "escrowReleaserAddress";
|
|
1634
1708
|
} | {
|
|
1635
1709
|
type: "date_bucket";
|
|
1636
|
-
field: "createdAt" | "expiresAt" | "confirmedAt" | "lastActivityAt";
|
|
1710
|
+
field: "createdAt" | "expiresAt" | "confirmedAt" | "lastActivityAt" | "escrowReleasedAt";
|
|
1637
1711
|
granularity: "day" | "week" | "month" | "year";
|
|
1638
1712
|
})[] | undefined;
|
|
1639
1713
|
filters?: {
|
|
1640
1714
|
value: string | number | boolean | (string | number)[];
|
|
1641
|
-
field: "status" | "currency" | "externalRef" | "source" | "isOverpaid" | "apiKeyId";
|
|
1715
|
+
field: "status" | "currency" | "externalRef" | "source" | "isOverpaid" | "apiKeyId" | "escrowReleaserAddress";
|
|
1642
1716
|
operator: "eq" | "neq" | "in" | "gt" | "gte" | "lt" | "lte";
|
|
1643
1717
|
}[] | undefined;
|
|
1644
1718
|
orderBy?: {
|
|
@@ -1924,26 +1998,26 @@ declare const MetricsQuerySchema: z.ZodEffects<z.ZodDiscriminatedUnion<"resource
|
|
|
1924
1998
|
environment: "live" | "test";
|
|
1925
1999
|
resource: "charges";
|
|
1926
2000
|
dateRange: {
|
|
1927
|
-
field: "createdAt" | "expiresAt" | "confirmedAt" | "lastActivityAt";
|
|
2001
|
+
field: "createdAt" | "expiresAt" | "confirmedAt" | "lastActivityAt" | "escrowReleasedAt";
|
|
1928
2002
|
from: string;
|
|
1929
2003
|
to: string;
|
|
1930
2004
|
};
|
|
1931
2005
|
groupBy: ({
|
|
1932
2006
|
type: "field";
|
|
1933
|
-
field: "status" | "currency" | "externalRef" | "source" | "isOverpaid" | "apiKeyId";
|
|
2007
|
+
field: "status" | "currency" | "externalRef" | "source" | "isOverpaid" | "apiKeyId" | "escrowReleaserAddress";
|
|
1934
2008
|
} | {
|
|
1935
2009
|
type: "date_bucket";
|
|
1936
|
-
field: "createdAt" | "expiresAt" | "confirmedAt" | "lastActivityAt";
|
|
2010
|
+
field: "createdAt" | "expiresAt" | "confirmedAt" | "lastActivityAt" | "escrowReleasedAt";
|
|
1937
2011
|
granularity: "day" | "week" | "month" | "year";
|
|
1938
2012
|
})[];
|
|
1939
2013
|
metrics: {
|
|
1940
2014
|
aggregation: "count" | "sum" | "avg" | "min" | "max";
|
|
1941
|
-
field?: "amount" | "amountReceived" | "feePercent" | undefined;
|
|
2015
|
+
field?: "amount" | "amountReceived" | "feePercent" | "escrowFeePercent" | undefined;
|
|
1942
2016
|
alias?: string | undefined;
|
|
1943
2017
|
}[];
|
|
1944
2018
|
filters: {
|
|
1945
2019
|
value: string | number | boolean | (string | number)[];
|
|
1946
|
-
field: "status" | "currency" | "externalRef" | "source" | "isOverpaid" | "apiKeyId";
|
|
2020
|
+
field: "status" | "currency" | "externalRef" | "source" | "isOverpaid" | "apiKeyId" | "escrowReleaserAddress";
|
|
1947
2021
|
operator: "eq" | "neq" | "in" | "gt" | "gte" | "lt" | "lte";
|
|
1948
2022
|
}[];
|
|
1949
2023
|
orderBy?: {
|
|
@@ -2016,27 +2090,27 @@ declare const MetricsQuerySchema: z.ZodEffects<z.ZodDiscriminatedUnion<"resource
|
|
|
2016
2090
|
environment: "live" | "test";
|
|
2017
2091
|
resource: "charges";
|
|
2018
2092
|
dateRange: {
|
|
2019
|
-
field: "createdAt" | "expiresAt" | "confirmedAt" | "lastActivityAt";
|
|
2093
|
+
field: "createdAt" | "expiresAt" | "confirmedAt" | "lastActivityAt" | "escrowReleasedAt";
|
|
2020
2094
|
from: string;
|
|
2021
2095
|
to: string;
|
|
2022
2096
|
};
|
|
2023
2097
|
metrics: {
|
|
2024
2098
|
aggregation: "count" | "sum" | "avg" | "min" | "max";
|
|
2025
|
-
field?: "amount" | "amountReceived" | "feePercent" | undefined;
|
|
2099
|
+
field?: "amount" | "amountReceived" | "feePercent" | "escrowFeePercent" | undefined;
|
|
2026
2100
|
alias?: string | undefined;
|
|
2027
2101
|
}[];
|
|
2028
2102
|
limit?: number | undefined;
|
|
2029
2103
|
groupBy?: ({
|
|
2030
2104
|
type: "field";
|
|
2031
|
-
field: "status" | "currency" | "externalRef" | "source" | "isOverpaid" | "apiKeyId";
|
|
2105
|
+
field: "status" | "currency" | "externalRef" | "source" | "isOverpaid" | "apiKeyId" | "escrowReleaserAddress";
|
|
2032
2106
|
} | {
|
|
2033
2107
|
type: "date_bucket";
|
|
2034
|
-
field: "createdAt" | "expiresAt" | "confirmedAt" | "lastActivityAt";
|
|
2108
|
+
field: "createdAt" | "expiresAt" | "confirmedAt" | "lastActivityAt" | "escrowReleasedAt";
|
|
2035
2109
|
granularity: "day" | "week" | "month" | "year";
|
|
2036
2110
|
})[] | undefined;
|
|
2037
2111
|
filters?: {
|
|
2038
2112
|
value: string | number | boolean | (string | number)[];
|
|
2039
|
-
field: "status" | "currency" | "externalRef" | "source" | "isOverpaid" | "apiKeyId";
|
|
2113
|
+
field: "status" | "currency" | "externalRef" | "source" | "isOverpaid" | "apiKeyId" | "escrowReleaserAddress";
|
|
2040
2114
|
operator: "eq" | "neq" | "in" | "gt" | "gte" | "lt" | "lte";
|
|
2041
2115
|
}[] | undefined;
|
|
2042
2116
|
orderBy?: {
|
|
@@ -2653,4 +2727,4 @@ declare const SwapQuoteSchema: z.ZodObject<{
|
|
|
2653
2727
|
}>;
|
|
2654
2728
|
type SwapQuote = z.infer<typeof SwapQuoteSchema>;
|
|
2655
2729
|
|
|
2656
|
-
export { API_KEY_SCOPES, type AcceptedPayment, AcceptedPaymentSchema, type ApiKeyScope, ApiKeyScopeSchema, CHARGE_ACCEPTED_PAYMENTS_MAX, CHARGE_AMOUNT_MAX, CHARGE_EXPIRES_IN_MAX_SECONDS, CHARGE_EXPIRES_IN_MIN_SECONDS, CHARGE_SPLIT_RECIPIENTS_MAX, CHECKOUT_PRODUCTS_MAX, CONFLICTING_SCOPE_PAIRS, type Capabilities, CapabilitiesSchema, type Charge, ChargeSchema, type ChargeStatus, ChargeStatusSchema, ChargeWebhookEventTypeSchema, type ChargesDateField, ChargesDateFieldSchema, type ChargesMetricField, ChargesMetricFieldSchema, type ChargesQueryField, ChargesQueryFieldSchema, type CheckChargeRequest, CheckChargeRequestSchema, type CheckoutProduct, CheckoutProductSchema, type CreateChargeInput, type CreateChargeRequest, CreateChargeSchema, type CreateRecipientInput, type CreateRecipientRequest, CreateRecipientSchema, type CreateSwapQuoteInput, CreateSwapQuoteSchema, type CreateWebhookInput, type CreateWebhookRequest, CreateWebhookSchema, type DistributionsDateField, DistributionsDateFieldSchema, type DistributionsMetricField, DistributionsMetricFieldSchema, type DistributionsQueryField, DistributionsQueryFieldSchema, EVENT_CATEGORY_MAP, type ErrorPayload, ErrorPayloadSchema, type GetChargeQrCodeQuery, type GetChargeQrCodeQueryRequest, GetChargeQrCodeQuerySchema, type Health, HealthSchema, type KlappayCheckoutMetadata, KlappayCheckoutMetadataSchema, type ListChargesInput, type ListChargesRequest, ListChargesSchema, type ListWebhookDeliveriesInput, type ListWebhookDeliveriesRequest, ListWebhookDeliveriesSchema, type ListenPendingDistributionsQuery, ListenPendingDistributionsQuerySchema, MAX_METRICS_QUERY_DATE_RANGE_DAYS, METRICS_QUERY_DEFAULT_ROW_LIMIT, METRICS_QUERY_MAX_FILTERS, METRICS_QUERY_MAX_GROUP_BY, METRICS_QUERY_MAX_METRICS, METRICS_QUERY_MAX_ROW_LIMIT, MetadataWithKlappaySchema, type MetricsAggregation, MetricsAggregationSchema, type MetricsDateGranularity, MetricsDateGranularitySchema, type MetricsFilterOperator, MetricsFilterOperatorSchema, type MetricsQuery, type MetricsQueryRequest, type MetricsQueryResult, type MetricsQueryResultRow, MetricsQueryResultRowSchema, MetricsQueryResultSchema, MetricsQuerySchema, type MetricsResource, MetricsResourceSchema, PAGINATION_LIMIT_DEFAULT, PAGINATION_LIMIT_MAX, PAGINATION_LIMIT_MIN, type PaginatedCharges, PaginatedChargesSchema, type PaginatedPendingDistributions, PaginatedPendingDistributionsSchema, type PaginatedWebhookDeliveries, PaginatedWebhookDeliveriesSchema, type PaginationQuery, type PaginationQueryRequest, PaginationQuerySchema, type PendingDistribution, type PendingDistributionEvent, PendingDistributionEventSchema, PendingDistributionRecipientSchema, PendingDistributionSchema, type Recipient, RecipientSchema, type SandboxTriggerInput, SandboxTriggerSchema, type SetRecipientPayoutInput, SetRecipientPayoutSchema, type SettlementStatus, SettlementStatusSchema, type SplitDistributionStatus, SplitDistributionStatusSchema, type SplitRecipient, type SplitRecipientInput, SplitRecipientInputSchema, SplitRecipientSchema, type SwapQuote, SwapQuoteSchema, type TimelineEvent, TimelineEventSchema, type TimelineEventType, TimelineEventTypeSchema, type TransactionSource, TransactionSourceSchema, type TransactionsDateField, TransactionsDateFieldSchema, type TransactionsMetricField, TransactionsMetricFieldSchema, type TransactionsQueryField, TransactionsQueryFieldSchema, type TriggerableChargeEvent, TriggerableChargeEventSchema, type TypedWebhookPayload, WEBHOOK_EVENTS_WILDCARD, WEBHOOK_EVENT_CATEGORIES, type Webhook, type WebhookCategory, WebhookCategorySchema, type WebhookDelivery, WebhookDeliveryEventTypeSchema, WebhookDeliverySchema, type WebhookDeliveryStatus, WebhookDeliveryStatusSchema, type WebhookEventDataMap, type WebhookEventType, WebhookEventTypeSchema, type WebhookHealthEventData, type WebhookListItem, WebhookListItemSchema, type WebhookPayload, WebhookPayloadSchema, WebhookSchema, findConflictingScopes, paginatedSchema };
|
|
2730
|
+
export { API_KEY_SCOPES, type AcceptedPayment, AcceptedPaymentSchema, type ApiKeyScope, ApiKeyScopeSchema, CHARGE_ACCEPTED_PAYMENTS_MAX, CHARGE_AMOUNT_MAX, CHARGE_EXPIRES_IN_MAX_SECONDS, CHARGE_EXPIRES_IN_MIN_SECONDS, CHARGE_SPLIT_RECIPIENTS_MAX, CHECKOUT_PRODUCTS_MAX, CONFLICTING_SCOPE_PAIRS, type Capabilities, CapabilitiesSchema, type Charge, ChargeSchema, type ChargeStatus, ChargeStatusSchema, ChargeWebhookEventTypeSchema, type ChargesDateField, ChargesDateFieldSchema, type ChargesMetricField, ChargesMetricFieldSchema, type ChargesQueryField, ChargesQueryFieldSchema, type CheckChargeRequest, CheckChargeRequestSchema, type CheckoutProduct, CheckoutProductSchema, type CreateChargeInput, type CreateChargeRequest, CreateChargeSchema, type CreateRecipientInput, type CreateRecipientRequest, CreateRecipientSchema, type CreateSwapQuoteInput, CreateSwapQuoteSchema, type CreateWebhookInput, type CreateWebhookRequest, CreateWebhookSchema, type DistributionsDateField, DistributionsDateFieldSchema, type DistributionsMetricField, DistributionsMetricFieldSchema, type DistributionsQueryField, DistributionsQueryFieldSchema, EVENT_CATEGORY_MAP, type ErrorPayload, ErrorPayloadSchema, type EscrowConfig, EscrowConfigSchema, type GetChargeQrCodeQuery, type GetChargeQrCodeQueryRequest, GetChargeQrCodeQuerySchema, type Health, HealthSchema, type KlappayCheckoutMetadata, KlappayCheckoutMetadataSchema, type ListChargesInput, type ListChargesRequest, ListChargesSchema, type ListWebhookDeliveriesInput, type ListWebhookDeliveriesRequest, ListWebhookDeliveriesSchema, type ListenPendingDistributionsQuery, ListenPendingDistributionsQuerySchema, MAX_METRICS_QUERY_DATE_RANGE_DAYS, METRICS_QUERY_DEFAULT_ROW_LIMIT, METRICS_QUERY_MAX_FILTERS, METRICS_QUERY_MAX_GROUP_BY, METRICS_QUERY_MAX_METRICS, METRICS_QUERY_MAX_ROW_LIMIT, MetadataWithKlappaySchema, type MetricsAggregation, MetricsAggregationSchema, type MetricsDateGranularity, MetricsDateGranularitySchema, type MetricsFilterOperator, MetricsFilterOperatorSchema, type MetricsQuery, type MetricsQueryRequest, type MetricsQueryResult, type MetricsQueryResultRow, MetricsQueryResultRowSchema, MetricsQueryResultSchema, MetricsQuerySchema, type MetricsResource, MetricsResourceSchema, PAGINATION_LIMIT_DEFAULT, PAGINATION_LIMIT_MAX, PAGINATION_LIMIT_MIN, type PaginatedCharges, PaginatedChargesSchema, type PaginatedPendingDistributions, PaginatedPendingDistributionsSchema, type PaginatedWebhookDeliveries, PaginatedWebhookDeliveriesSchema, type PaginationQuery, type PaginationQueryRequest, PaginationQuerySchema, type PendingDistribution, type PendingDistributionEvent, PendingDistributionEventSchema, PendingDistributionRecipientSchema, PendingDistributionSchema, type Recipient, RecipientSchema, type ReleaseEscrowRequest, ReleaseEscrowRequestSchema, type SandboxTriggerInput, SandboxTriggerSchema, type SetRecipientPayoutInput, SetRecipientPayoutSchema, type SettlementStatus, SettlementStatusSchema, type SplitDistributionStatus, SplitDistributionStatusSchema, type SplitRecipient, type SplitRecipientInput, SplitRecipientInputSchema, SplitRecipientSchema, type SwapQuote, SwapQuoteSchema, type TimelineEvent, TimelineEventSchema, type TimelineEventType, TimelineEventTypeSchema, type TransactionSource, TransactionSourceSchema, type TransactionsDateField, TransactionsDateFieldSchema, type TransactionsMetricField, TransactionsMetricFieldSchema, type TransactionsQueryField, TransactionsQueryFieldSchema, type TriggerableChargeEvent, TriggerableChargeEventSchema, type TypedWebhookPayload, WEBHOOK_EVENTS_WILDCARD, WEBHOOK_EVENT_CATEGORIES, type Webhook, type WebhookCategory, WebhookCategorySchema, type WebhookDelivery, WebhookDeliveryEventTypeSchema, WebhookDeliverySchema, type WebhookDeliveryStatus, WebhookDeliveryStatusSchema, type WebhookEventDataMap, type WebhookEventType, WebhookEventTypeSchema, type WebhookHealthEventData, type WebhookListItem, WebhookListItemSchema, type WebhookPayload, WebhookPayloadSchema, WebhookSchema, findConflictingScopes, paginatedSchema };
|