@klappay/types 3.3.0 → 3.5.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/dist/index.d.mts +82 -81
- package/dist/index.d.ts +82 -81
- package/dist/index.js +18 -9
- package/dist/index.js.map +1 -1
- package/dist/index.mjs +18 -9
- package/dist/index.mjs.map +1 -1
- package/package.json +1 -1
package/dist/index.d.ts
CHANGED
|
@@ -1564,11 +1564,11 @@ declare const METRICS_QUERY_DEFAULT_ROW_LIMIT = 100;
|
|
|
1564
1564
|
declare const METRICS_QUERY_MAX_GROUP_BY = 3;
|
|
1565
1565
|
declare const METRICS_QUERY_MAX_FILTERS = 20;
|
|
1566
1566
|
declare const METRICS_QUERY_MAX_METRICS = 10;
|
|
1567
|
-
declare const ChargesQueryFieldSchema: z.ZodEnum<["status", "source", "apiKeyId", "currency", "isOverpaid", "externalRef"]>;
|
|
1567
|
+
declare const ChargesQueryFieldSchema: z.ZodEnum<["status", "source", "apiKeyId", "currency", "isOverpaid", "externalRef", "escrowReleaserAddress"]>;
|
|
1568
1568
|
type ChargesQueryField = z.infer<typeof ChargesQueryFieldSchema>;
|
|
1569
|
-
declare const ChargesMetricFieldSchema: z.ZodEnum<["amount", "amountReceived", "feePercent"]>;
|
|
1569
|
+
declare const ChargesMetricFieldSchema: z.ZodEnum<["amount", "amountReceived", "feePercent", "escrowFeePercent"]>;
|
|
1570
1570
|
type ChargesMetricField = z.infer<typeof ChargesMetricFieldSchema>;
|
|
1571
|
-
declare const ChargesDateFieldSchema: z.ZodEnum<["createdAt", "confirmedAt", "lastActivityAt", "expiresAt"]>;
|
|
1571
|
+
declare const ChargesDateFieldSchema: z.ZodEnum<["createdAt", "confirmedAt", "lastActivityAt", "expiresAt", "escrowReleasedAt"]>;
|
|
1572
1572
|
type ChargesDateField = z.infer<typeof ChargesDateFieldSchema>;
|
|
1573
1573
|
declare const TransactionsQueryFieldSchema: z.ZodEnum<["network", "token", "source", "causedTransition"]>;
|
|
1574
1574
|
type TransactionsQueryField = z.infer<typeof TransactionsQueryFieldSchema>;
|
|
@@ -1586,64 +1586,64 @@ declare const MetricsQuerySchema: z.ZodEffects<z.ZodDiscriminatedUnion<"resource
|
|
|
1586
1586
|
resource: z.ZodLiteral<"charges">;
|
|
1587
1587
|
environment: z.ZodEnum<["live", "test"]>;
|
|
1588
1588
|
dateRange: z.ZodObject<{
|
|
1589
|
-
field: z.ZodEnum<["createdAt", "confirmedAt", "lastActivityAt", "expiresAt"]>;
|
|
1589
|
+
field: z.ZodEnum<["createdAt", "confirmedAt", "lastActivityAt", "expiresAt", "escrowReleasedAt"]>;
|
|
1590
1590
|
from: z.ZodString;
|
|
1591
1591
|
to: z.ZodString;
|
|
1592
1592
|
}, "strip", z.ZodTypeAny, {
|
|
1593
|
-
field: "createdAt" | "expiresAt" | "confirmedAt" | "lastActivityAt";
|
|
1593
|
+
field: "createdAt" | "expiresAt" | "confirmedAt" | "lastActivityAt" | "escrowReleasedAt";
|
|
1594
1594
|
from: string;
|
|
1595
1595
|
to: string;
|
|
1596
1596
|
}, {
|
|
1597
|
-
field: "createdAt" | "expiresAt" | "confirmedAt" | "lastActivityAt";
|
|
1597
|
+
field: "createdAt" | "expiresAt" | "confirmedAt" | "lastActivityAt" | "escrowReleasedAt";
|
|
1598
1598
|
from: string;
|
|
1599
1599
|
to: string;
|
|
1600
1600
|
}>;
|
|
1601
1601
|
groupBy: z.ZodDefault<z.ZodArray<z.ZodUnion<[z.ZodObject<{
|
|
1602
1602
|
type: z.ZodLiteral<"field">;
|
|
1603
|
-
field: z.ZodEnum<["status", "source", "apiKeyId", "currency", "isOverpaid", "externalRef"]>;
|
|
1603
|
+
field: z.ZodEnum<["status", "source", "apiKeyId", "currency", "isOverpaid", "externalRef", "escrowReleaserAddress"]>;
|
|
1604
1604
|
}, "strip", z.ZodTypeAny, {
|
|
1605
1605
|
type: "field";
|
|
1606
|
-
field: "status" | "currency" | "externalRef" | "source" | "isOverpaid" | "apiKeyId";
|
|
1606
|
+
field: "status" | "currency" | "externalRef" | "source" | "isOverpaid" | "apiKeyId" | "escrowReleaserAddress";
|
|
1607
1607
|
}, {
|
|
1608
1608
|
type: "field";
|
|
1609
|
-
field: "status" | "currency" | "externalRef" | "source" | "isOverpaid" | "apiKeyId";
|
|
1609
|
+
field: "status" | "currency" | "externalRef" | "source" | "isOverpaid" | "apiKeyId" | "escrowReleaserAddress";
|
|
1610
1610
|
}>, z.ZodObject<{
|
|
1611
1611
|
type: z.ZodLiteral<"date_bucket">;
|
|
1612
|
-
field: z.ZodEnum<["createdAt", "confirmedAt", "lastActivityAt", "expiresAt"]>;
|
|
1612
|
+
field: z.ZodEnum<["createdAt", "confirmedAt", "lastActivityAt", "expiresAt", "escrowReleasedAt"]>;
|
|
1613
1613
|
granularity: z.ZodEnum<["day", "week", "month", "year"]>;
|
|
1614
1614
|
}, "strip", z.ZodTypeAny, {
|
|
1615
1615
|
type: "date_bucket";
|
|
1616
|
-
field: "createdAt" | "expiresAt" | "confirmedAt" | "lastActivityAt";
|
|
1616
|
+
field: "createdAt" | "expiresAt" | "confirmedAt" | "lastActivityAt" | "escrowReleasedAt";
|
|
1617
1617
|
granularity: "day" | "week" | "month" | "year";
|
|
1618
1618
|
}, {
|
|
1619
1619
|
type: "date_bucket";
|
|
1620
|
-
field: "createdAt" | "expiresAt" | "confirmedAt" | "lastActivityAt";
|
|
1620
|
+
field: "createdAt" | "expiresAt" | "confirmedAt" | "lastActivityAt" | "escrowReleasedAt";
|
|
1621
1621
|
granularity: "day" | "week" | "month" | "year";
|
|
1622
1622
|
}>]>, "many">>;
|
|
1623
1623
|
metrics: z.ZodArray<z.ZodObject<{
|
|
1624
1624
|
aggregation: z.ZodEnum<["count", "sum", "avg", "min", "max"]>;
|
|
1625
|
-
field: z.ZodOptional<z.ZodEnum<["amount", "amountReceived", "feePercent"]>>;
|
|
1625
|
+
field: z.ZodOptional<z.ZodEnum<["amount", "amountReceived", "feePercent", "escrowFeePercent"]>>;
|
|
1626
1626
|
alias: z.ZodOptional<z.ZodString>;
|
|
1627
1627
|
}, "strip", z.ZodTypeAny, {
|
|
1628
1628
|
aggregation: "count" | "sum" | "avg" | "min" | "max";
|
|
1629
|
-
field?: "amount" | "amountReceived" | "feePercent" | undefined;
|
|
1629
|
+
field?: "amount" | "amountReceived" | "feePercent" | "escrowFeePercent" | undefined;
|
|
1630
1630
|
alias?: string | undefined;
|
|
1631
1631
|
}, {
|
|
1632
1632
|
aggregation: "count" | "sum" | "avg" | "min" | "max";
|
|
1633
|
-
field?: "amount" | "amountReceived" | "feePercent" | undefined;
|
|
1633
|
+
field?: "amount" | "amountReceived" | "feePercent" | "escrowFeePercent" | undefined;
|
|
1634
1634
|
alias?: string | undefined;
|
|
1635
1635
|
}>, "many">;
|
|
1636
1636
|
filters: z.ZodDefault<z.ZodArray<z.ZodObject<{
|
|
1637
|
-
field: z.ZodEnum<["status", "source", "apiKeyId", "currency", "isOverpaid", "externalRef"]>;
|
|
1637
|
+
field: z.ZodEnum<["status", "source", "apiKeyId", "currency", "isOverpaid", "externalRef", "escrowReleaserAddress"]>;
|
|
1638
1638
|
operator: z.ZodEnum<["eq", "neq", "in", "gt", "gte", "lt", "lte"]>;
|
|
1639
1639
|
value: z.ZodUnion<[z.ZodString, z.ZodNumber, z.ZodBoolean, z.ZodArray<z.ZodUnion<[z.ZodString, z.ZodNumber]>, "many">]>;
|
|
1640
1640
|
}, "strip", z.ZodTypeAny, {
|
|
1641
1641
|
value: string | number | boolean | (string | number)[];
|
|
1642
|
-
field: "status" | "currency" | "externalRef" | "source" | "isOverpaid" | "apiKeyId";
|
|
1642
|
+
field: "status" | "currency" | "externalRef" | "source" | "isOverpaid" | "apiKeyId" | "escrowReleaserAddress";
|
|
1643
1643
|
operator: "eq" | "neq" | "in" | "gt" | "gte" | "lt" | "lte";
|
|
1644
1644
|
}, {
|
|
1645
1645
|
value: string | number | boolean | (string | number)[];
|
|
1646
|
-
field: "status" | "currency" | "externalRef" | "source" | "isOverpaid" | "apiKeyId";
|
|
1646
|
+
field: "status" | "currency" | "externalRef" | "source" | "isOverpaid" | "apiKeyId" | "escrowReleaserAddress";
|
|
1647
1647
|
operator: "eq" | "neq" | "in" | "gt" | "gte" | "lt" | "lte";
|
|
1648
1648
|
}>, "many">>;
|
|
1649
1649
|
orderBy: z.ZodOptional<z.ZodObject<{
|
|
@@ -1662,26 +1662,26 @@ declare const MetricsQuerySchema: z.ZodEffects<z.ZodDiscriminatedUnion<"resource
|
|
|
1662
1662
|
environment: "live" | "test";
|
|
1663
1663
|
resource: "charges";
|
|
1664
1664
|
dateRange: {
|
|
1665
|
-
field: "createdAt" | "expiresAt" | "confirmedAt" | "lastActivityAt";
|
|
1665
|
+
field: "createdAt" | "expiresAt" | "confirmedAt" | "lastActivityAt" | "escrowReleasedAt";
|
|
1666
1666
|
from: string;
|
|
1667
1667
|
to: string;
|
|
1668
1668
|
};
|
|
1669
1669
|
groupBy: ({
|
|
1670
1670
|
type: "field";
|
|
1671
|
-
field: "status" | "currency" | "externalRef" | "source" | "isOverpaid" | "apiKeyId";
|
|
1671
|
+
field: "status" | "currency" | "externalRef" | "source" | "isOverpaid" | "apiKeyId" | "escrowReleaserAddress";
|
|
1672
1672
|
} | {
|
|
1673
1673
|
type: "date_bucket";
|
|
1674
|
-
field: "createdAt" | "expiresAt" | "confirmedAt" | "lastActivityAt";
|
|
1674
|
+
field: "createdAt" | "expiresAt" | "confirmedAt" | "lastActivityAt" | "escrowReleasedAt";
|
|
1675
1675
|
granularity: "day" | "week" | "month" | "year";
|
|
1676
1676
|
})[];
|
|
1677
1677
|
metrics: {
|
|
1678
1678
|
aggregation: "count" | "sum" | "avg" | "min" | "max";
|
|
1679
|
-
field?: "amount" | "amountReceived" | "feePercent" | undefined;
|
|
1679
|
+
field?: "amount" | "amountReceived" | "feePercent" | "escrowFeePercent" | undefined;
|
|
1680
1680
|
alias?: string | undefined;
|
|
1681
1681
|
}[];
|
|
1682
1682
|
filters: {
|
|
1683
1683
|
value: string | number | boolean | (string | number)[];
|
|
1684
|
-
field: "status" | "currency" | "externalRef" | "source" | "isOverpaid" | "apiKeyId";
|
|
1684
|
+
field: "status" | "currency" | "externalRef" | "source" | "isOverpaid" | "apiKeyId" | "escrowReleaserAddress";
|
|
1685
1685
|
operator: "eq" | "neq" | "in" | "gt" | "gte" | "lt" | "lte";
|
|
1686
1686
|
}[];
|
|
1687
1687
|
orderBy?: {
|
|
@@ -1692,27 +1692,27 @@ declare const MetricsQuerySchema: z.ZodEffects<z.ZodDiscriminatedUnion<"resource
|
|
|
1692
1692
|
environment: "live" | "test";
|
|
1693
1693
|
resource: "charges";
|
|
1694
1694
|
dateRange: {
|
|
1695
|
-
field: "createdAt" | "expiresAt" | "confirmedAt" | "lastActivityAt";
|
|
1695
|
+
field: "createdAt" | "expiresAt" | "confirmedAt" | "lastActivityAt" | "escrowReleasedAt";
|
|
1696
1696
|
from: string;
|
|
1697
1697
|
to: string;
|
|
1698
1698
|
};
|
|
1699
1699
|
metrics: {
|
|
1700
1700
|
aggregation: "count" | "sum" | "avg" | "min" | "max";
|
|
1701
|
-
field?: "amount" | "amountReceived" | "feePercent" | undefined;
|
|
1701
|
+
field?: "amount" | "amountReceived" | "feePercent" | "escrowFeePercent" | undefined;
|
|
1702
1702
|
alias?: string | undefined;
|
|
1703
1703
|
}[];
|
|
1704
1704
|
limit?: number | undefined;
|
|
1705
1705
|
groupBy?: ({
|
|
1706
1706
|
type: "field";
|
|
1707
|
-
field: "status" | "currency" | "externalRef" | "source" | "isOverpaid" | "apiKeyId";
|
|
1707
|
+
field: "status" | "currency" | "externalRef" | "source" | "isOverpaid" | "apiKeyId" | "escrowReleaserAddress";
|
|
1708
1708
|
} | {
|
|
1709
1709
|
type: "date_bucket";
|
|
1710
|
-
field: "createdAt" | "expiresAt" | "confirmedAt" | "lastActivityAt";
|
|
1710
|
+
field: "createdAt" | "expiresAt" | "confirmedAt" | "lastActivityAt" | "escrowReleasedAt";
|
|
1711
1711
|
granularity: "day" | "week" | "month" | "year";
|
|
1712
1712
|
})[] | undefined;
|
|
1713
1713
|
filters?: {
|
|
1714
1714
|
value: string | number | boolean | (string | number)[];
|
|
1715
|
-
field: "status" | "currency" | "externalRef" | "source" | "isOverpaid" | "apiKeyId";
|
|
1715
|
+
field: "status" | "currency" | "externalRef" | "source" | "isOverpaid" | "apiKeyId" | "escrowReleaserAddress";
|
|
1716
1716
|
operator: "eq" | "neq" | "in" | "gt" | "gte" | "lt" | "lte";
|
|
1717
1717
|
}[] | undefined;
|
|
1718
1718
|
orderBy?: {
|
|
@@ -1998,26 +1998,26 @@ declare const MetricsQuerySchema: z.ZodEffects<z.ZodDiscriminatedUnion<"resource
|
|
|
1998
1998
|
environment: "live" | "test";
|
|
1999
1999
|
resource: "charges";
|
|
2000
2000
|
dateRange: {
|
|
2001
|
-
field: "createdAt" | "expiresAt" | "confirmedAt" | "lastActivityAt";
|
|
2001
|
+
field: "createdAt" | "expiresAt" | "confirmedAt" | "lastActivityAt" | "escrowReleasedAt";
|
|
2002
2002
|
from: string;
|
|
2003
2003
|
to: string;
|
|
2004
2004
|
};
|
|
2005
2005
|
groupBy: ({
|
|
2006
2006
|
type: "field";
|
|
2007
|
-
field: "status" | "currency" | "externalRef" | "source" | "isOverpaid" | "apiKeyId";
|
|
2007
|
+
field: "status" | "currency" | "externalRef" | "source" | "isOverpaid" | "apiKeyId" | "escrowReleaserAddress";
|
|
2008
2008
|
} | {
|
|
2009
2009
|
type: "date_bucket";
|
|
2010
|
-
field: "createdAt" | "expiresAt" | "confirmedAt" | "lastActivityAt";
|
|
2010
|
+
field: "createdAt" | "expiresAt" | "confirmedAt" | "lastActivityAt" | "escrowReleasedAt";
|
|
2011
2011
|
granularity: "day" | "week" | "month" | "year";
|
|
2012
2012
|
})[];
|
|
2013
2013
|
metrics: {
|
|
2014
2014
|
aggregation: "count" | "sum" | "avg" | "min" | "max";
|
|
2015
|
-
field?: "amount" | "amountReceived" | "feePercent" | undefined;
|
|
2015
|
+
field?: "amount" | "amountReceived" | "feePercent" | "escrowFeePercent" | undefined;
|
|
2016
2016
|
alias?: string | undefined;
|
|
2017
2017
|
}[];
|
|
2018
2018
|
filters: {
|
|
2019
2019
|
value: string | number | boolean | (string | number)[];
|
|
2020
|
-
field: "status" | "currency" | "externalRef" | "source" | "isOverpaid" | "apiKeyId";
|
|
2020
|
+
field: "status" | "currency" | "externalRef" | "source" | "isOverpaid" | "apiKeyId" | "escrowReleaserAddress";
|
|
2021
2021
|
operator: "eq" | "neq" | "in" | "gt" | "gte" | "lt" | "lte";
|
|
2022
2022
|
}[];
|
|
2023
2023
|
orderBy?: {
|
|
@@ -2090,27 +2090,27 @@ declare const MetricsQuerySchema: z.ZodEffects<z.ZodDiscriminatedUnion<"resource
|
|
|
2090
2090
|
environment: "live" | "test";
|
|
2091
2091
|
resource: "charges";
|
|
2092
2092
|
dateRange: {
|
|
2093
|
-
field: "createdAt" | "expiresAt" | "confirmedAt" | "lastActivityAt";
|
|
2093
|
+
field: "createdAt" | "expiresAt" | "confirmedAt" | "lastActivityAt" | "escrowReleasedAt";
|
|
2094
2094
|
from: string;
|
|
2095
2095
|
to: string;
|
|
2096
2096
|
};
|
|
2097
2097
|
metrics: {
|
|
2098
2098
|
aggregation: "count" | "sum" | "avg" | "min" | "max";
|
|
2099
|
-
field?: "amount" | "amountReceived" | "feePercent" | undefined;
|
|
2099
|
+
field?: "amount" | "amountReceived" | "feePercent" | "escrowFeePercent" | undefined;
|
|
2100
2100
|
alias?: string | undefined;
|
|
2101
2101
|
}[];
|
|
2102
2102
|
limit?: number | undefined;
|
|
2103
2103
|
groupBy?: ({
|
|
2104
2104
|
type: "field";
|
|
2105
|
-
field: "status" | "currency" | "externalRef" | "source" | "isOverpaid" | "apiKeyId";
|
|
2105
|
+
field: "status" | "currency" | "externalRef" | "source" | "isOverpaid" | "apiKeyId" | "escrowReleaserAddress";
|
|
2106
2106
|
} | {
|
|
2107
2107
|
type: "date_bucket";
|
|
2108
|
-
field: "createdAt" | "expiresAt" | "confirmedAt" | "lastActivityAt";
|
|
2108
|
+
field: "createdAt" | "expiresAt" | "confirmedAt" | "lastActivityAt" | "escrowReleasedAt";
|
|
2109
2109
|
granularity: "day" | "week" | "month" | "year";
|
|
2110
2110
|
})[] | undefined;
|
|
2111
2111
|
filters?: {
|
|
2112
2112
|
value: string | number | boolean | (string | number)[];
|
|
2113
|
-
field: "status" | "currency" | "externalRef" | "source" | "isOverpaid" | "apiKeyId";
|
|
2113
|
+
field: "status" | "currency" | "externalRef" | "source" | "isOverpaid" | "apiKeyId" | "escrowReleaserAddress";
|
|
2114
2114
|
operator: "eq" | "neq" | "in" | "gt" | "gte" | "lt" | "lte";
|
|
2115
2115
|
}[] | undefined;
|
|
2116
2116
|
orderBy?: {
|
|
@@ -2221,15 +2221,15 @@ declare const MetricsQueryResultSchema: z.ZodObject<{
|
|
|
2221
2221
|
}>;
|
|
2222
2222
|
type MetricsQueryResult = z.infer<typeof MetricsQueryResultSchema>;
|
|
2223
2223
|
|
|
2224
|
-
declare const ChargeWebhookEventTypeSchema: z.ZodEnum<["charge.created", "charge.partially_paid", "charge.confirmed", "charge.expired", "charge.underpaid", "charge.settled", "charge.settlement_failed", "charge.overpaid"]>;
|
|
2224
|
+
declare const ChargeWebhookEventTypeSchema: z.ZodEnum<["charge.created", "charge.partially_paid", "charge.confirmed", "charge.expired", "charge.underpaid", "charge.settled", "charge.settlement_failed", "charge.overpaid", "charge.escrow_released"]>;
|
|
2225
2225
|
declare const WebhookDeliveryEventTypeSchema: z.ZodEnum<["webhook.delivery_failed", "webhook.delivery_recovered", "webhook.endpoint_unhealthy"]>;
|
|
2226
|
-
declare const WebhookEventTypeSchema: z.ZodUnion<[z.ZodEnum<["charge.created", "charge.partially_paid", "charge.confirmed", "charge.expired", "charge.underpaid", "charge.settled", "charge.settlement_failed", "charge.overpaid"]>, z.ZodEnum<["webhook.delivery_failed", "webhook.delivery_recovered", "webhook.endpoint_unhealthy"]>]>;
|
|
2226
|
+
declare const WebhookEventTypeSchema: z.ZodUnion<[z.ZodEnum<["charge.created", "charge.partially_paid", "charge.confirmed", "charge.expired", "charge.underpaid", "charge.settled", "charge.settlement_failed", "charge.overpaid", "charge.escrow_released"]>, z.ZodEnum<["webhook.delivery_failed", "webhook.delivery_recovered", "webhook.endpoint_unhealthy"]>]>;
|
|
2227
2227
|
type WebhookEventType = z.infer<typeof WebhookEventTypeSchema>;
|
|
2228
2228
|
declare const WebhookCategorySchema: z.ZodEnum<["payments", "webhooks"]>;
|
|
2229
2229
|
type WebhookCategory = z.infer<typeof WebhookCategorySchema>;
|
|
2230
|
-
declare const EVENT_CATEGORY_MAP: Record<"charge.created" | "charge.partially_paid" | "charge.confirmed" | "charge.expired" | "charge.underpaid" | "charge.settled" | "charge.settlement_failed" | "charge.overpaid" | "webhook.delivery_failed" | "webhook.delivery_recovered" | "webhook.endpoint_unhealthy", "payments" | "webhooks">;
|
|
2230
|
+
declare const EVENT_CATEGORY_MAP: Record<"charge.created" | "charge.partially_paid" | "charge.confirmed" | "charge.expired" | "charge.underpaid" | "charge.settled" | "charge.settlement_failed" | "charge.overpaid" | "charge.escrow_released" | "webhook.delivery_failed" | "webhook.delivery_recovered" | "webhook.endpoint_unhealthy", "payments" | "webhooks">;
|
|
2231
2231
|
declare const WEBHOOK_EVENT_CATEGORIES: Record<WebhookCategory, readonly WebhookEventType[]>;
|
|
2232
|
-
declare const TriggerableChargeEventSchema: z.ZodEnum<["charge.partially_paid", "charge.confirmed", "charge.expired", "charge.underpaid", "charge.settled", "charge.settlement_failed", "charge.overpaid"]>;
|
|
2232
|
+
declare const TriggerableChargeEventSchema: z.ZodEnum<["charge.partially_paid", "charge.confirmed", "charge.expired", "charge.underpaid", "charge.settled", "charge.settlement_failed", "charge.overpaid", "charge.escrow_released"]>;
|
|
2233
2233
|
type TriggerableChargeEvent = z.infer<typeof TriggerableChargeEventSchema>;
|
|
2234
2234
|
|
|
2235
2235
|
type WebhookHealthEventData = {
|
|
@@ -2246,6 +2246,7 @@ type WebhookEventDataMap = {
|
|
|
2246
2246
|
'charge.settled': Charge;
|
|
2247
2247
|
'charge.settlement_failed': Charge;
|
|
2248
2248
|
'charge.overpaid': Charge;
|
|
2249
|
+
'charge.escrow_released': Charge;
|
|
2249
2250
|
'webhook.delivery_failed': WebhookHealthEventData;
|
|
2250
2251
|
'webhook.delivery_recovered': WebhookHealthEventData;
|
|
2251
2252
|
'webhook.endpoint_unhealthy': WebhookHealthEventData;
|
|
@@ -2262,29 +2263,29 @@ type TypedWebhookPayload = {
|
|
|
2262
2263
|
declare const WEBHOOK_EVENTS_WILDCARD = "*";
|
|
2263
2264
|
declare const CreateWebhookSchema: z.ZodEffects<z.ZodObject<{
|
|
2264
2265
|
url: z.ZodString;
|
|
2265
|
-
events: z.ZodDefault<z.ZodArray<z.ZodUnion<[z.ZodUnion<[z.ZodEnum<["charge.created", "charge.partially_paid", "charge.confirmed", "charge.expired", "charge.underpaid", "charge.settled", "charge.settlement_failed", "charge.overpaid"]>, z.ZodEnum<["webhook.delivery_failed", "webhook.delivery_recovered", "webhook.endpoint_unhealthy"]>]>, z.ZodLiteral<"*">]>, "many">>;
|
|
2266
|
+
events: z.ZodDefault<z.ZodArray<z.ZodUnion<[z.ZodUnion<[z.ZodEnum<["charge.created", "charge.partially_paid", "charge.confirmed", "charge.expired", "charge.underpaid", "charge.settled", "charge.settlement_failed", "charge.overpaid", "charge.escrow_released"]>, z.ZodEnum<["webhook.delivery_failed", "webhook.delivery_recovered", "webhook.endpoint_unhealthy"]>]>, z.ZodLiteral<"*">]>, "many">>;
|
|
2266
2267
|
eventCategories: z.ZodDefault<z.ZodArray<z.ZodEnum<["payments", "webhooks"]>, "many">>;
|
|
2267
|
-
excludeEvents: z.ZodDefault<z.ZodArray<z.ZodUnion<[z.ZodEnum<["charge.created", "charge.partially_paid", "charge.confirmed", "charge.expired", "charge.underpaid", "charge.settled", "charge.settlement_failed", "charge.overpaid"]>, z.ZodEnum<["webhook.delivery_failed", "webhook.delivery_recovered", "webhook.endpoint_unhealthy"]>]>, "many">>;
|
|
2268
|
+
excludeEvents: z.ZodDefault<z.ZodArray<z.ZodUnion<[z.ZodEnum<["charge.created", "charge.partially_paid", "charge.confirmed", "charge.expired", "charge.underpaid", "charge.settled", "charge.settlement_failed", "charge.overpaid", "charge.escrow_released"]>, z.ZodEnum<["webhook.delivery_failed", "webhook.delivery_recovered", "webhook.endpoint_unhealthy"]>]>, "many">>;
|
|
2268
2269
|
}, "strip", z.ZodTypeAny, {
|
|
2269
2270
|
url: string;
|
|
2270
|
-
events: ("charge.created" | "charge.partially_paid" | "charge.confirmed" | "charge.expired" | "charge.underpaid" | "charge.settled" | "charge.settlement_failed" | "charge.overpaid" | "webhook.delivery_failed" | "webhook.delivery_recovered" | "webhook.endpoint_unhealthy" | "*")[];
|
|
2271
|
+
events: ("charge.created" | "charge.partially_paid" | "charge.confirmed" | "charge.expired" | "charge.underpaid" | "charge.settled" | "charge.settlement_failed" | "charge.overpaid" | "charge.escrow_released" | "webhook.delivery_failed" | "webhook.delivery_recovered" | "webhook.endpoint_unhealthy" | "*")[];
|
|
2271
2272
|
eventCategories: ("payments" | "webhooks")[];
|
|
2272
|
-
excludeEvents: ("charge.created" | "charge.partially_paid" | "charge.confirmed" | "charge.expired" | "charge.underpaid" | "charge.settled" | "charge.settlement_failed" | "charge.overpaid" | "webhook.delivery_failed" | "webhook.delivery_recovered" | "webhook.endpoint_unhealthy")[];
|
|
2273
|
+
excludeEvents: ("charge.created" | "charge.partially_paid" | "charge.confirmed" | "charge.expired" | "charge.underpaid" | "charge.settled" | "charge.settlement_failed" | "charge.overpaid" | "charge.escrow_released" | "webhook.delivery_failed" | "webhook.delivery_recovered" | "webhook.endpoint_unhealthy")[];
|
|
2273
2274
|
}, {
|
|
2274
2275
|
url: string;
|
|
2275
|
-
events?: ("charge.created" | "charge.partially_paid" | "charge.confirmed" | "charge.expired" | "charge.underpaid" | "charge.settled" | "charge.settlement_failed" | "charge.overpaid" | "webhook.delivery_failed" | "webhook.delivery_recovered" | "webhook.endpoint_unhealthy" | "*")[] | undefined;
|
|
2276
|
+
events?: ("charge.created" | "charge.partially_paid" | "charge.confirmed" | "charge.expired" | "charge.underpaid" | "charge.settled" | "charge.settlement_failed" | "charge.overpaid" | "charge.escrow_released" | "webhook.delivery_failed" | "webhook.delivery_recovered" | "webhook.endpoint_unhealthy" | "*")[] | undefined;
|
|
2276
2277
|
eventCategories?: ("payments" | "webhooks")[] | undefined;
|
|
2277
|
-
excludeEvents?: ("charge.created" | "charge.partially_paid" | "charge.confirmed" | "charge.expired" | "charge.underpaid" | "charge.settled" | "charge.settlement_failed" | "charge.overpaid" | "webhook.delivery_failed" | "webhook.delivery_recovered" | "webhook.endpoint_unhealthy")[] | undefined;
|
|
2278
|
+
excludeEvents?: ("charge.created" | "charge.partially_paid" | "charge.confirmed" | "charge.expired" | "charge.underpaid" | "charge.settled" | "charge.settlement_failed" | "charge.overpaid" | "charge.escrow_released" | "webhook.delivery_failed" | "webhook.delivery_recovered" | "webhook.endpoint_unhealthy")[] | undefined;
|
|
2278
2279
|
}>, {
|
|
2279
2280
|
url: string;
|
|
2280
|
-
events: ("charge.created" | "charge.partially_paid" | "charge.confirmed" | "charge.expired" | "charge.underpaid" | "charge.settled" | "charge.settlement_failed" | "charge.overpaid" | "webhook.delivery_failed" | "webhook.delivery_recovered" | "webhook.endpoint_unhealthy" | "*")[];
|
|
2281
|
+
events: ("charge.created" | "charge.partially_paid" | "charge.confirmed" | "charge.expired" | "charge.underpaid" | "charge.settled" | "charge.settlement_failed" | "charge.overpaid" | "charge.escrow_released" | "webhook.delivery_failed" | "webhook.delivery_recovered" | "webhook.endpoint_unhealthy" | "*")[];
|
|
2281
2282
|
eventCategories: ("payments" | "webhooks")[];
|
|
2282
|
-
excludeEvents: ("charge.created" | "charge.partially_paid" | "charge.confirmed" | "charge.expired" | "charge.underpaid" | "charge.settled" | "charge.settlement_failed" | "charge.overpaid" | "webhook.delivery_failed" | "webhook.delivery_recovered" | "webhook.endpoint_unhealthy")[];
|
|
2283
|
+
excludeEvents: ("charge.created" | "charge.partially_paid" | "charge.confirmed" | "charge.expired" | "charge.underpaid" | "charge.settled" | "charge.settlement_failed" | "charge.overpaid" | "charge.escrow_released" | "webhook.delivery_failed" | "webhook.delivery_recovered" | "webhook.endpoint_unhealthy")[];
|
|
2283
2284
|
}, {
|
|
2284
2285
|
url: string;
|
|
2285
|
-
events?: ("charge.created" | "charge.partially_paid" | "charge.confirmed" | "charge.expired" | "charge.underpaid" | "charge.settled" | "charge.settlement_failed" | "charge.overpaid" | "webhook.delivery_failed" | "webhook.delivery_recovered" | "webhook.endpoint_unhealthy" | "*")[] | undefined;
|
|
2286
|
+
events?: ("charge.created" | "charge.partially_paid" | "charge.confirmed" | "charge.expired" | "charge.underpaid" | "charge.settled" | "charge.settlement_failed" | "charge.overpaid" | "charge.escrow_released" | "webhook.delivery_failed" | "webhook.delivery_recovered" | "webhook.endpoint_unhealthy" | "*")[] | undefined;
|
|
2286
2287
|
eventCategories?: ("payments" | "webhooks")[] | undefined;
|
|
2287
|
-
excludeEvents?: ("charge.created" | "charge.partially_paid" | "charge.confirmed" | "charge.expired" | "charge.underpaid" | "charge.settled" | "charge.settlement_failed" | "charge.overpaid" | "webhook.delivery_failed" | "webhook.delivery_recovered" | "webhook.endpoint_unhealthy")[] | undefined;
|
|
2288
|
+
excludeEvents?: ("charge.created" | "charge.partially_paid" | "charge.confirmed" | "charge.expired" | "charge.underpaid" | "charge.settled" | "charge.settlement_failed" | "charge.overpaid" | "charge.escrow_released" | "webhook.delivery_failed" | "webhook.delivery_recovered" | "webhook.endpoint_unhealthy")[] | undefined;
|
|
2288
2289
|
}>;
|
|
2289
2290
|
type CreateWebhookInput = z.infer<typeof CreateWebhookSchema>;
|
|
2290
2291
|
type CreateWebhookRequest = z.input<typeof CreateWebhookSchema>;
|
|
@@ -2292,9 +2293,9 @@ declare const WebhookSchema: z.ZodObject<{
|
|
|
2292
2293
|
id: z.ZodString;
|
|
2293
2294
|
environment: z.ZodNullable<z.ZodEnum<["live", "test"]>>;
|
|
2294
2295
|
url: z.ZodString;
|
|
2295
|
-
events: z.ZodArray<z.ZodUnion<[z.ZodEnum<["charge.created", "charge.partially_paid", "charge.confirmed", "charge.expired", "charge.underpaid", "charge.settled", "charge.settlement_failed", "charge.overpaid"]>, z.ZodEnum<["webhook.delivery_failed", "webhook.delivery_recovered", "webhook.endpoint_unhealthy"]>]>, "many">;
|
|
2296
|
+
events: z.ZodArray<z.ZodUnion<[z.ZodEnum<["charge.created", "charge.partially_paid", "charge.confirmed", "charge.expired", "charge.underpaid", "charge.settled", "charge.settlement_failed", "charge.overpaid", "charge.escrow_released"]>, z.ZodEnum<["webhook.delivery_failed", "webhook.delivery_recovered", "webhook.endpoint_unhealthy"]>]>, "many">;
|
|
2296
2297
|
eventCategories: z.ZodArray<z.ZodEnum<["payments", "webhooks"]>, "many">;
|
|
2297
|
-
excludeEvents: z.ZodArray<z.ZodUnion<[z.ZodEnum<["charge.created", "charge.partially_paid", "charge.confirmed", "charge.expired", "charge.underpaid", "charge.settled", "charge.settlement_failed", "charge.overpaid"]>, z.ZodEnum<["webhook.delivery_failed", "webhook.delivery_recovered", "webhook.endpoint_unhealthy"]>]>, "many">;
|
|
2298
|
+
excludeEvents: z.ZodArray<z.ZodUnion<[z.ZodEnum<["charge.created", "charge.partially_paid", "charge.confirmed", "charge.expired", "charge.underpaid", "charge.settled", "charge.settlement_failed", "charge.overpaid", "charge.escrow_released"]>, z.ZodEnum<["webhook.delivery_failed", "webhook.delivery_recovered", "webhook.endpoint_unhealthy"]>]>, "many">;
|
|
2298
2299
|
isWildcard: z.ZodBoolean;
|
|
2299
2300
|
secret: z.ZodString;
|
|
2300
2301
|
createdAt: z.ZodString;
|
|
@@ -2303,9 +2304,9 @@ declare const WebhookSchema: z.ZodObject<{
|
|
|
2303
2304
|
environment: "live" | "test" | null;
|
|
2304
2305
|
createdAt: string;
|
|
2305
2306
|
url: string;
|
|
2306
|
-
events: ("charge.created" | "charge.partially_paid" | "charge.confirmed" | "charge.expired" | "charge.underpaid" | "charge.settled" | "charge.settlement_failed" | "charge.overpaid" | "webhook.delivery_failed" | "webhook.delivery_recovered" | "webhook.endpoint_unhealthy")[];
|
|
2307
|
+
events: ("charge.created" | "charge.partially_paid" | "charge.confirmed" | "charge.expired" | "charge.underpaid" | "charge.settled" | "charge.settlement_failed" | "charge.overpaid" | "charge.escrow_released" | "webhook.delivery_failed" | "webhook.delivery_recovered" | "webhook.endpoint_unhealthy")[];
|
|
2307
2308
|
eventCategories: ("payments" | "webhooks")[];
|
|
2308
|
-
excludeEvents: ("charge.created" | "charge.partially_paid" | "charge.confirmed" | "charge.expired" | "charge.underpaid" | "charge.settled" | "charge.settlement_failed" | "charge.overpaid" | "webhook.delivery_failed" | "webhook.delivery_recovered" | "webhook.endpoint_unhealthy")[];
|
|
2309
|
+
excludeEvents: ("charge.created" | "charge.partially_paid" | "charge.confirmed" | "charge.expired" | "charge.underpaid" | "charge.settled" | "charge.settlement_failed" | "charge.overpaid" | "charge.escrow_released" | "webhook.delivery_failed" | "webhook.delivery_recovered" | "webhook.endpoint_unhealthy")[];
|
|
2309
2310
|
isWildcard: boolean;
|
|
2310
2311
|
secret: string;
|
|
2311
2312
|
}, {
|
|
@@ -2313,9 +2314,9 @@ declare const WebhookSchema: z.ZodObject<{
|
|
|
2313
2314
|
environment: "live" | "test" | null;
|
|
2314
2315
|
createdAt: string;
|
|
2315
2316
|
url: string;
|
|
2316
|
-
events: ("charge.created" | "charge.partially_paid" | "charge.confirmed" | "charge.expired" | "charge.underpaid" | "charge.settled" | "charge.settlement_failed" | "charge.overpaid" | "webhook.delivery_failed" | "webhook.delivery_recovered" | "webhook.endpoint_unhealthy")[];
|
|
2317
|
+
events: ("charge.created" | "charge.partially_paid" | "charge.confirmed" | "charge.expired" | "charge.underpaid" | "charge.settled" | "charge.settlement_failed" | "charge.overpaid" | "charge.escrow_released" | "webhook.delivery_failed" | "webhook.delivery_recovered" | "webhook.endpoint_unhealthy")[];
|
|
2317
2318
|
eventCategories: ("payments" | "webhooks")[];
|
|
2318
|
-
excludeEvents: ("charge.created" | "charge.partially_paid" | "charge.confirmed" | "charge.expired" | "charge.underpaid" | "charge.settled" | "charge.settlement_failed" | "charge.overpaid" | "webhook.delivery_failed" | "webhook.delivery_recovered" | "webhook.endpoint_unhealthy")[];
|
|
2319
|
+
excludeEvents: ("charge.created" | "charge.partially_paid" | "charge.confirmed" | "charge.expired" | "charge.underpaid" | "charge.settled" | "charge.settlement_failed" | "charge.overpaid" | "charge.escrow_released" | "webhook.delivery_failed" | "webhook.delivery_recovered" | "webhook.endpoint_unhealthy")[];
|
|
2319
2320
|
isWildcard: boolean;
|
|
2320
2321
|
secret: string;
|
|
2321
2322
|
}>;
|
|
@@ -2324,9 +2325,9 @@ declare const WebhookListItemSchema: z.ZodObject<Omit<{
|
|
|
2324
2325
|
id: z.ZodString;
|
|
2325
2326
|
environment: z.ZodNullable<z.ZodEnum<["live", "test"]>>;
|
|
2326
2327
|
url: z.ZodString;
|
|
2327
|
-
events: z.ZodArray<z.ZodUnion<[z.ZodEnum<["charge.created", "charge.partially_paid", "charge.confirmed", "charge.expired", "charge.underpaid", "charge.settled", "charge.settlement_failed", "charge.overpaid"]>, z.ZodEnum<["webhook.delivery_failed", "webhook.delivery_recovered", "webhook.endpoint_unhealthy"]>]>, "many">;
|
|
2328
|
+
events: z.ZodArray<z.ZodUnion<[z.ZodEnum<["charge.created", "charge.partially_paid", "charge.confirmed", "charge.expired", "charge.underpaid", "charge.settled", "charge.settlement_failed", "charge.overpaid", "charge.escrow_released"]>, z.ZodEnum<["webhook.delivery_failed", "webhook.delivery_recovered", "webhook.endpoint_unhealthy"]>]>, "many">;
|
|
2328
2329
|
eventCategories: z.ZodArray<z.ZodEnum<["payments", "webhooks"]>, "many">;
|
|
2329
|
-
excludeEvents: z.ZodArray<z.ZodUnion<[z.ZodEnum<["charge.created", "charge.partially_paid", "charge.confirmed", "charge.expired", "charge.underpaid", "charge.settled", "charge.settlement_failed", "charge.overpaid"]>, z.ZodEnum<["webhook.delivery_failed", "webhook.delivery_recovered", "webhook.endpoint_unhealthy"]>]>, "many">;
|
|
2330
|
+
excludeEvents: z.ZodArray<z.ZodUnion<[z.ZodEnum<["charge.created", "charge.partially_paid", "charge.confirmed", "charge.expired", "charge.underpaid", "charge.settled", "charge.settlement_failed", "charge.overpaid", "charge.escrow_released"]>, z.ZodEnum<["webhook.delivery_failed", "webhook.delivery_recovered", "webhook.endpoint_unhealthy"]>]>, "many">;
|
|
2330
2331
|
isWildcard: z.ZodBoolean;
|
|
2331
2332
|
secret: z.ZodString;
|
|
2332
2333
|
createdAt: z.ZodString;
|
|
@@ -2337,9 +2338,9 @@ declare const WebhookListItemSchema: z.ZodObject<Omit<{
|
|
|
2337
2338
|
environment: "live" | "test" | null;
|
|
2338
2339
|
createdAt: string;
|
|
2339
2340
|
url: string;
|
|
2340
|
-
events: ("charge.created" | "charge.partially_paid" | "charge.confirmed" | "charge.expired" | "charge.underpaid" | "charge.settled" | "charge.settlement_failed" | "charge.overpaid" | "webhook.delivery_failed" | "webhook.delivery_recovered" | "webhook.endpoint_unhealthy")[];
|
|
2341
|
+
events: ("charge.created" | "charge.partially_paid" | "charge.confirmed" | "charge.expired" | "charge.underpaid" | "charge.settled" | "charge.settlement_failed" | "charge.overpaid" | "charge.escrow_released" | "webhook.delivery_failed" | "webhook.delivery_recovered" | "webhook.endpoint_unhealthy")[];
|
|
2341
2342
|
eventCategories: ("payments" | "webhooks")[];
|
|
2342
|
-
excludeEvents: ("charge.created" | "charge.partially_paid" | "charge.confirmed" | "charge.expired" | "charge.underpaid" | "charge.settled" | "charge.settlement_failed" | "charge.overpaid" | "webhook.delivery_failed" | "webhook.delivery_recovered" | "webhook.endpoint_unhealthy")[];
|
|
2343
|
+
excludeEvents: ("charge.created" | "charge.partially_paid" | "charge.confirmed" | "charge.expired" | "charge.underpaid" | "charge.settled" | "charge.settlement_failed" | "charge.overpaid" | "charge.escrow_released" | "webhook.delivery_failed" | "webhook.delivery_recovered" | "webhook.endpoint_unhealthy")[];
|
|
2343
2344
|
isWildcard: boolean;
|
|
2344
2345
|
hint: string;
|
|
2345
2346
|
}, {
|
|
@@ -2347,27 +2348,27 @@ declare const WebhookListItemSchema: z.ZodObject<Omit<{
|
|
|
2347
2348
|
environment: "live" | "test" | null;
|
|
2348
2349
|
createdAt: string;
|
|
2349
2350
|
url: string;
|
|
2350
|
-
events: ("charge.created" | "charge.partially_paid" | "charge.confirmed" | "charge.expired" | "charge.underpaid" | "charge.settled" | "charge.settlement_failed" | "charge.overpaid" | "webhook.delivery_failed" | "webhook.delivery_recovered" | "webhook.endpoint_unhealthy")[];
|
|
2351
|
+
events: ("charge.created" | "charge.partially_paid" | "charge.confirmed" | "charge.expired" | "charge.underpaid" | "charge.settled" | "charge.settlement_failed" | "charge.overpaid" | "charge.escrow_released" | "webhook.delivery_failed" | "webhook.delivery_recovered" | "webhook.endpoint_unhealthy")[];
|
|
2351
2352
|
eventCategories: ("payments" | "webhooks")[];
|
|
2352
|
-
excludeEvents: ("charge.created" | "charge.partially_paid" | "charge.confirmed" | "charge.expired" | "charge.underpaid" | "charge.settled" | "charge.settlement_failed" | "charge.overpaid" | "webhook.delivery_failed" | "webhook.delivery_recovered" | "webhook.endpoint_unhealthy")[];
|
|
2353
|
+
excludeEvents: ("charge.created" | "charge.partially_paid" | "charge.confirmed" | "charge.expired" | "charge.underpaid" | "charge.settled" | "charge.settlement_failed" | "charge.overpaid" | "charge.escrow_released" | "webhook.delivery_failed" | "webhook.delivery_recovered" | "webhook.endpoint_unhealthy")[];
|
|
2353
2354
|
isWildcard: boolean;
|
|
2354
2355
|
hint: string;
|
|
2355
2356
|
}>;
|
|
2356
2357
|
type WebhookListItem = z.infer<typeof WebhookListItemSchema>;
|
|
2357
2358
|
declare const WebhookPayloadSchema: z.ZodObject<{
|
|
2358
2359
|
id: z.ZodString;
|
|
2359
|
-
event: z.ZodUnion<[z.ZodEnum<["charge.created", "charge.partially_paid", "charge.confirmed", "charge.expired", "charge.underpaid", "charge.settled", "charge.settlement_failed", "charge.overpaid"]>, z.ZodEnum<["webhook.delivery_failed", "webhook.delivery_recovered", "webhook.endpoint_unhealthy"]>]>;
|
|
2360
|
+
event: z.ZodUnion<[z.ZodEnum<["charge.created", "charge.partially_paid", "charge.confirmed", "charge.expired", "charge.underpaid", "charge.settled", "charge.settlement_failed", "charge.overpaid", "charge.escrow_released"]>, z.ZodEnum<["webhook.delivery_failed", "webhook.delivery_recovered", "webhook.endpoint_unhealthy"]>]>;
|
|
2360
2361
|
createdAt: z.ZodString;
|
|
2361
2362
|
data: z.ZodUnknown;
|
|
2362
2363
|
}, "strip", z.ZodTypeAny, {
|
|
2363
2364
|
id: string;
|
|
2364
2365
|
createdAt: string;
|
|
2365
|
-
event: "charge.created" | "charge.partially_paid" | "charge.confirmed" | "charge.expired" | "charge.underpaid" | "charge.settled" | "charge.settlement_failed" | "charge.overpaid" | "webhook.delivery_failed" | "webhook.delivery_recovered" | "webhook.endpoint_unhealthy";
|
|
2366
|
+
event: "charge.created" | "charge.partially_paid" | "charge.confirmed" | "charge.expired" | "charge.underpaid" | "charge.settled" | "charge.settlement_failed" | "charge.overpaid" | "charge.escrow_released" | "webhook.delivery_failed" | "webhook.delivery_recovered" | "webhook.endpoint_unhealthy";
|
|
2366
2367
|
data?: unknown;
|
|
2367
2368
|
}, {
|
|
2368
2369
|
id: string;
|
|
2369
2370
|
createdAt: string;
|
|
2370
|
-
event: "charge.created" | "charge.partially_paid" | "charge.confirmed" | "charge.expired" | "charge.underpaid" | "charge.settled" | "charge.settlement_failed" | "charge.overpaid" | "webhook.delivery_failed" | "webhook.delivery_recovered" | "webhook.endpoint_unhealthy";
|
|
2371
|
+
event: "charge.created" | "charge.partially_paid" | "charge.confirmed" | "charge.expired" | "charge.underpaid" | "charge.settled" | "charge.settlement_failed" | "charge.overpaid" | "charge.escrow_released" | "webhook.delivery_failed" | "webhook.delivery_recovered" | "webhook.endpoint_unhealthy";
|
|
2371
2372
|
data?: unknown;
|
|
2372
2373
|
}>;
|
|
2373
2374
|
type WebhookPayload = z.infer<typeof WebhookPayloadSchema>;
|
|
@@ -2376,7 +2377,7 @@ type WebhookDeliveryStatus = z.infer<typeof WebhookDeliveryStatusSchema>;
|
|
|
2376
2377
|
declare const WebhookDeliverySchema: z.ZodObject<{
|
|
2377
2378
|
id: z.ZodString;
|
|
2378
2379
|
webhookId: z.ZodString;
|
|
2379
|
-
event: z.ZodUnion<[z.ZodEnum<["charge.created", "charge.partially_paid", "charge.confirmed", "charge.expired", "charge.underpaid", "charge.settled", "charge.settlement_failed", "charge.overpaid"]>, z.ZodEnum<["webhook.delivery_failed", "webhook.delivery_recovered", "webhook.endpoint_unhealthy"]>]>;
|
|
2380
|
+
event: z.ZodUnion<[z.ZodEnum<["charge.created", "charge.partially_paid", "charge.confirmed", "charge.expired", "charge.underpaid", "charge.settled", "charge.settlement_failed", "charge.overpaid", "charge.escrow_released"]>, z.ZodEnum<["webhook.delivery_failed", "webhook.delivery_recovered", "webhook.endpoint_unhealthy"]>]>;
|
|
2380
2381
|
status: z.ZodEnum<["pending", "delivered", "failed"]>;
|
|
2381
2382
|
attempts: z.ZodNumber;
|
|
2382
2383
|
responseCode: z.ZodNullable<z.ZodNumber>;
|
|
@@ -2388,7 +2389,7 @@ declare const WebhookDeliverySchema: z.ZodObject<{
|
|
|
2388
2389
|
id: string;
|
|
2389
2390
|
createdAt: string;
|
|
2390
2391
|
attempts: number;
|
|
2391
|
-
event: "charge.created" | "charge.partially_paid" | "charge.confirmed" | "charge.expired" | "charge.underpaid" | "charge.settled" | "charge.settlement_failed" | "charge.overpaid" | "webhook.delivery_failed" | "webhook.delivery_recovered" | "webhook.endpoint_unhealthy";
|
|
2392
|
+
event: "charge.created" | "charge.partially_paid" | "charge.confirmed" | "charge.expired" | "charge.underpaid" | "charge.settled" | "charge.settlement_failed" | "charge.overpaid" | "charge.escrow_released" | "webhook.delivery_failed" | "webhook.delivery_recovered" | "webhook.endpoint_unhealthy";
|
|
2392
2393
|
webhookId: string;
|
|
2393
2394
|
responseCode: number | null;
|
|
2394
2395
|
nextRetryAt: string | null;
|
|
@@ -2398,7 +2399,7 @@ declare const WebhookDeliverySchema: z.ZodObject<{
|
|
|
2398
2399
|
id: string;
|
|
2399
2400
|
createdAt: string;
|
|
2400
2401
|
attempts: number;
|
|
2401
|
-
event: "charge.created" | "charge.partially_paid" | "charge.confirmed" | "charge.expired" | "charge.underpaid" | "charge.settled" | "charge.settlement_failed" | "charge.overpaid" | "webhook.delivery_failed" | "webhook.delivery_recovered" | "webhook.endpoint_unhealthy";
|
|
2402
|
+
event: "charge.created" | "charge.partially_paid" | "charge.confirmed" | "charge.expired" | "charge.underpaid" | "charge.settled" | "charge.settlement_failed" | "charge.overpaid" | "charge.escrow_released" | "webhook.delivery_failed" | "webhook.delivery_recovered" | "webhook.endpoint_unhealthy";
|
|
2402
2403
|
webhookId: string;
|
|
2403
2404
|
responseCode: number | null;
|
|
2404
2405
|
nextRetryAt: string | null;
|
|
@@ -2421,7 +2422,7 @@ declare const PaginatedWebhookDeliveriesSchema: z.ZodObject<{
|
|
|
2421
2422
|
data: z.ZodArray<z.ZodObject<{
|
|
2422
2423
|
id: z.ZodString;
|
|
2423
2424
|
webhookId: z.ZodString;
|
|
2424
|
-
event: z.ZodUnion<[z.ZodEnum<["charge.created", "charge.partially_paid", "charge.confirmed", "charge.expired", "charge.underpaid", "charge.settled", "charge.settlement_failed", "charge.overpaid"]>, z.ZodEnum<["webhook.delivery_failed", "webhook.delivery_recovered", "webhook.endpoint_unhealthy"]>]>;
|
|
2425
|
+
event: z.ZodUnion<[z.ZodEnum<["charge.created", "charge.partially_paid", "charge.confirmed", "charge.expired", "charge.underpaid", "charge.settled", "charge.settlement_failed", "charge.overpaid", "charge.escrow_released"]>, z.ZodEnum<["webhook.delivery_failed", "webhook.delivery_recovered", "webhook.endpoint_unhealthy"]>]>;
|
|
2425
2426
|
status: z.ZodEnum<["pending", "delivered", "failed"]>;
|
|
2426
2427
|
attempts: z.ZodNumber;
|
|
2427
2428
|
responseCode: z.ZodNullable<z.ZodNumber>;
|
|
@@ -2433,7 +2434,7 @@ declare const PaginatedWebhookDeliveriesSchema: z.ZodObject<{
|
|
|
2433
2434
|
id: string;
|
|
2434
2435
|
createdAt: string;
|
|
2435
2436
|
attempts: number;
|
|
2436
|
-
event: "charge.created" | "charge.partially_paid" | "charge.confirmed" | "charge.expired" | "charge.underpaid" | "charge.settled" | "charge.settlement_failed" | "charge.overpaid" | "webhook.delivery_failed" | "webhook.delivery_recovered" | "webhook.endpoint_unhealthy";
|
|
2437
|
+
event: "charge.created" | "charge.partially_paid" | "charge.confirmed" | "charge.expired" | "charge.underpaid" | "charge.settled" | "charge.settlement_failed" | "charge.overpaid" | "charge.escrow_released" | "webhook.delivery_failed" | "webhook.delivery_recovered" | "webhook.endpoint_unhealthy";
|
|
2437
2438
|
webhookId: string;
|
|
2438
2439
|
responseCode: number | null;
|
|
2439
2440
|
nextRetryAt: string | null;
|
|
@@ -2443,7 +2444,7 @@ declare const PaginatedWebhookDeliveriesSchema: z.ZodObject<{
|
|
|
2443
2444
|
id: string;
|
|
2444
2445
|
createdAt: string;
|
|
2445
2446
|
attempts: number;
|
|
2446
|
-
event: "charge.created" | "charge.partially_paid" | "charge.confirmed" | "charge.expired" | "charge.underpaid" | "charge.settled" | "charge.settlement_failed" | "charge.overpaid" | "webhook.delivery_failed" | "webhook.delivery_recovered" | "webhook.endpoint_unhealthy";
|
|
2447
|
+
event: "charge.created" | "charge.partially_paid" | "charge.confirmed" | "charge.expired" | "charge.underpaid" | "charge.settled" | "charge.settlement_failed" | "charge.overpaid" | "charge.escrow_released" | "webhook.delivery_failed" | "webhook.delivery_recovered" | "webhook.endpoint_unhealthy";
|
|
2447
2448
|
webhookId: string;
|
|
2448
2449
|
responseCode: number | null;
|
|
2449
2450
|
nextRetryAt: string | null;
|
|
@@ -2457,7 +2458,7 @@ declare const PaginatedWebhookDeliveriesSchema: z.ZodObject<{
|
|
|
2457
2458
|
id: string;
|
|
2458
2459
|
createdAt: string;
|
|
2459
2460
|
attempts: number;
|
|
2460
|
-
event: "charge.created" | "charge.partially_paid" | "charge.confirmed" | "charge.expired" | "charge.underpaid" | "charge.settled" | "charge.settlement_failed" | "charge.overpaid" | "webhook.delivery_failed" | "webhook.delivery_recovered" | "webhook.endpoint_unhealthy";
|
|
2461
|
+
event: "charge.created" | "charge.partially_paid" | "charge.confirmed" | "charge.expired" | "charge.underpaid" | "charge.settled" | "charge.settlement_failed" | "charge.overpaid" | "charge.escrow_released" | "webhook.delivery_failed" | "webhook.delivery_recovered" | "webhook.endpoint_unhealthy";
|
|
2461
2462
|
webhookId: string;
|
|
2462
2463
|
responseCode: number | null;
|
|
2463
2464
|
nextRetryAt: string | null;
|
|
@@ -2471,7 +2472,7 @@ declare const PaginatedWebhookDeliveriesSchema: z.ZodObject<{
|
|
|
2471
2472
|
id: string;
|
|
2472
2473
|
createdAt: string;
|
|
2473
2474
|
attempts: number;
|
|
2474
|
-
event: "charge.created" | "charge.partially_paid" | "charge.confirmed" | "charge.expired" | "charge.underpaid" | "charge.settled" | "charge.settlement_failed" | "charge.overpaid" | "webhook.delivery_failed" | "webhook.delivery_recovered" | "webhook.endpoint_unhealthy";
|
|
2475
|
+
event: "charge.created" | "charge.partially_paid" | "charge.confirmed" | "charge.expired" | "charge.underpaid" | "charge.settled" | "charge.settlement_failed" | "charge.overpaid" | "charge.escrow_released" | "webhook.delivery_failed" | "webhook.delivery_recovered" | "webhook.endpoint_unhealthy";
|
|
2475
2476
|
webhookId: string;
|
|
2476
2477
|
responseCode: number | null;
|
|
2477
2478
|
nextRetryAt: string | null;
|
|
@@ -2539,7 +2540,7 @@ declare const TimelineEventSchema: z.ZodObject<{
|
|
|
2539
2540
|
token: z.ZodOptional<z.ZodEnum<["USDC", "USDT"]>>;
|
|
2540
2541
|
network: z.ZodOptional<z.ZodEnum<["base", "optimism", "polygon", "ethereum", "arbitrum", "avalanche", "bnb"]>>;
|
|
2541
2542
|
causedTransition: z.ZodOptional<z.ZodBoolean>;
|
|
2542
|
-
event: z.ZodOptional<z.ZodUnion<[z.ZodEnum<["charge.created", "charge.partially_paid", "charge.confirmed", "charge.expired", "charge.underpaid", "charge.settled", "charge.settlement_failed", "charge.overpaid"]>, z.ZodEnum<["webhook.delivery_failed", "webhook.delivery_recovered", "webhook.endpoint_unhealthy"]>]>>;
|
|
2543
|
+
event: z.ZodOptional<z.ZodUnion<[z.ZodEnum<["charge.created", "charge.partially_paid", "charge.confirmed", "charge.expired", "charge.underpaid", "charge.settled", "charge.settlement_failed", "charge.overpaid", "charge.escrow_released"]>, z.ZodEnum<["webhook.delivery_failed", "webhook.delivery_recovered", "webhook.endpoint_unhealthy"]>]>>;
|
|
2543
2544
|
responseCode: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
|
|
2544
2545
|
attempts: z.ZodOptional<z.ZodNumber>;
|
|
2545
2546
|
}, "strip", z.ZodTypeAny, {
|
|
@@ -2552,7 +2553,7 @@ declare const TimelineEventSchema: z.ZodObject<{
|
|
|
2552
2553
|
txHash?: string | undefined;
|
|
2553
2554
|
causedTransition?: boolean | undefined;
|
|
2554
2555
|
attempts?: number | undefined;
|
|
2555
|
-
event?: "charge.created" | "charge.partially_paid" | "charge.confirmed" | "charge.expired" | "charge.underpaid" | "charge.settled" | "charge.settlement_failed" | "charge.overpaid" | "webhook.delivery_failed" | "webhook.delivery_recovered" | "webhook.endpoint_unhealthy" | undefined;
|
|
2556
|
+
event?: "charge.created" | "charge.partially_paid" | "charge.confirmed" | "charge.expired" | "charge.underpaid" | "charge.settled" | "charge.settlement_failed" | "charge.overpaid" | "charge.escrow_released" | "webhook.delivery_failed" | "webhook.delivery_recovered" | "webhook.endpoint_unhealthy" | undefined;
|
|
2556
2557
|
responseCode?: number | null | undefined;
|
|
2557
2558
|
}, {
|
|
2558
2559
|
type: "charge.created" | "charge.expired" | "transaction.detected" | "split.distributed" | "webhook.dispatched" | "webhook.delivered" | "webhook.failed";
|
|
@@ -2564,7 +2565,7 @@ declare const TimelineEventSchema: z.ZodObject<{
|
|
|
2564
2565
|
txHash?: string | undefined;
|
|
2565
2566
|
causedTransition?: boolean | undefined;
|
|
2566
2567
|
attempts?: number | undefined;
|
|
2567
|
-
event?: "charge.created" | "charge.partially_paid" | "charge.confirmed" | "charge.expired" | "charge.underpaid" | "charge.settled" | "charge.settlement_failed" | "charge.overpaid" | "webhook.delivery_failed" | "webhook.delivery_recovered" | "webhook.endpoint_unhealthy" | undefined;
|
|
2568
|
+
event?: "charge.created" | "charge.partially_paid" | "charge.confirmed" | "charge.expired" | "charge.underpaid" | "charge.settled" | "charge.settlement_failed" | "charge.overpaid" | "charge.escrow_released" | "webhook.delivery_failed" | "webhook.delivery_recovered" | "webhook.endpoint_unhealthy" | undefined;
|
|
2568
2569
|
responseCode?: number | null | undefined;
|
|
2569
2570
|
}>;
|
|
2570
2571
|
type TimelineEvent = z.infer<typeof TimelineEventSchema>;
|
|
@@ -2597,13 +2598,13 @@ declare const HealthSchema: z.ZodObject<{
|
|
|
2597
2598
|
type Health = z.infer<typeof HealthSchema>;
|
|
2598
2599
|
|
|
2599
2600
|
declare const SandboxTriggerSchema: z.ZodObject<{
|
|
2600
|
-
event: z.ZodEnum<["charge.partially_paid", "charge.confirmed", "charge.expired", "charge.underpaid", "charge.settled", "charge.settlement_failed", "charge.overpaid"]>;
|
|
2601
|
+
event: z.ZodEnum<["charge.partially_paid", "charge.confirmed", "charge.expired", "charge.underpaid", "charge.settled", "charge.settlement_failed", "charge.overpaid", "charge.escrow_released"]>;
|
|
2601
2602
|
amount: z.ZodOptional<z.ZodNumber>;
|
|
2602
2603
|
}, "strip", z.ZodTypeAny, {
|
|
2603
|
-
event: "charge.partially_paid" | "charge.confirmed" | "charge.expired" | "charge.underpaid" | "charge.settled" | "charge.settlement_failed" | "charge.overpaid";
|
|
2604
|
+
event: "charge.partially_paid" | "charge.confirmed" | "charge.expired" | "charge.underpaid" | "charge.settled" | "charge.settlement_failed" | "charge.overpaid" | "charge.escrow_released";
|
|
2604
2605
|
amount?: number | undefined;
|
|
2605
2606
|
}, {
|
|
2606
|
-
event: "charge.partially_paid" | "charge.confirmed" | "charge.expired" | "charge.underpaid" | "charge.settled" | "charge.settlement_failed" | "charge.overpaid";
|
|
2607
|
+
event: "charge.partially_paid" | "charge.confirmed" | "charge.expired" | "charge.underpaid" | "charge.settled" | "charge.settlement_failed" | "charge.overpaid" | "charge.escrow_released";
|
|
2607
2608
|
amount?: number | undefined;
|
|
2608
2609
|
}>;
|
|
2609
2610
|
type SandboxTriggerInput = z.infer<typeof SandboxTriggerSchema>;
|
package/dist/index.js
CHANGED
|
@@ -366,7 +366,7 @@ var EscrowConfigSchema = import_zod9.z.object({
|
|
|
366
366
|
});
|
|
367
367
|
var ReleaseEscrowRequestSchema = import_zod9.z.object({
|
|
368
368
|
signature: import_zod9.z.string().regex(/^0x[0-9a-fA-F]+$/, "must be hex-encoded signature bytes").describe(
|
|
369
|
-
"The Safe transaction signature authorizing this release, produced by signing the escrow's
|
|
369
|
+
"The Safe transaction signature authorizing this release, produced by signing a transfer of the escrow's entire current token balance to the charge's already-frozen split address (the same split that would have received the payment on a normal, non-escrow charge) with the private key behind this charge's `escrowReleaserAddress` \u2014 never anything Klappay can produce itself. The destination is fixed by the charge's `splitConfig` (frozen at creation); the amount is read live on-chain at release time, not fixed in advance, so it always matches whatever actually arrived \u2014 reconstruct the exact transaction server-side computes (ERC-20 `transfer(splitAddress, balance)` from the escrow Safe, nonce 0) before signing. Independently verified on-chain before anything moves \u2014 the Safe contract itself rejects a signature that isn't from `escrowReleaserAddress`, never trusted at face value by Klappay."
|
|
370
370
|
)
|
|
371
371
|
});
|
|
372
372
|
|
|
@@ -655,14 +655,22 @@ var orderBySchema = import_zod13.z.object({
|
|
|
655
655
|
var limitSchema = import_zod13.z.number().int().min(1).max(METRICS_QUERY_MAX_ROW_LIMIT).default(METRICS_QUERY_DEFAULT_ROW_LIMIT).describe(
|
|
656
656
|
`Max rows to return, ${1}\u2013${METRICS_QUERY_MAX_ROW_LIMIT}, default ${METRICS_QUERY_DEFAULT_ROW_LIMIT}. If more rows matched, \`meta.truncated\` is \`true\` on the response \u2014 narrow the query instead of just raising this.`
|
|
657
657
|
);
|
|
658
|
-
var ChargesQueryFieldSchema = import_zod13.z.enum([
|
|
659
|
-
"
|
|
658
|
+
var ChargesQueryFieldSchema = import_zod13.z.enum([
|
|
659
|
+
"status",
|
|
660
|
+
"source",
|
|
661
|
+
"apiKeyId",
|
|
662
|
+
"currency",
|
|
663
|
+
"isOverpaid",
|
|
664
|
+
"externalRef",
|
|
665
|
+
"escrowReleaserAddress"
|
|
666
|
+
]).describe(
|
|
667
|
+
"A `Charge` field to filter or group by \u2014 see `ChargeStatusSchema` for `status`'s own possible values (charges.md). `source`/`externalRef` are free-form strings your own integration set at creation, not a fixed enum. `escrowReleaserAddress` is `null` for a normal charge \u2014 filter `escrowReleaserAddress` with operator `neq`/value `null` to isolate escrow-configured charges (see `escrow` in charges.md)."
|
|
660
668
|
);
|
|
661
|
-
var ChargesMetricFieldSchema = import_zod13.z.enum(["amount", "amountReceived", "feePercent"]).describe(
|
|
662
|
-
"A `Charge` numeric field to aggregate. `amount`/`amountReceived` are decimal currency amounts (requested vs. actually received \u2014 see `charges.md`). `feePercent` is the platform fee frozen on the charge at creation, e.g. `1.5` means 1.5%."
|
|
669
|
+
var ChargesMetricFieldSchema = import_zod13.z.enum(["amount", "amountReceived", "feePercent", "escrowFeePercent"]).describe(
|
|
670
|
+
"A `Charge` numeric field to aggregate. `amount`/`amountReceived` are decimal currency amounts (requested vs. actually received \u2014 see `charges.md`). `feePercent` is the platform fee frozen on the charge at creation, e.g. `1.5` means 1.5%. `escrowFeePercent` is the additional escrow-specific fee component, only present on escrow-configured charges \u2014 see `docs/payments.md`."
|
|
663
671
|
);
|
|
664
|
-
var ChargesDateFieldSchema = import_zod13.z.enum(["createdAt", "confirmedAt", "lastActivityAt", "expiresAt"]).describe(
|
|
665
|
-
"A `Charge` timestamp to filter/bucket by. `confirmedAt` is `null` until the charge reaches `confirmed` \u2014 a `dateRange`/`date_bucket` on it implicitly excludes every charge that never confirmed. `expiresAt` is always present (set at creation), useful for e.g. finding charges expiring soon or measuring how close to expiry charges typically resolve."
|
|
672
|
+
var ChargesDateFieldSchema = import_zod13.z.enum(["createdAt", "confirmedAt", "lastActivityAt", "expiresAt", "escrowReleasedAt"]).describe(
|
|
673
|
+
"A `Charge` timestamp to filter/bucket by. `confirmedAt` is `null` until the charge reaches `confirmed` \u2014 a `dateRange`/`date_bucket` on it implicitly excludes every charge that never confirmed. `expiresAt` is always present (set at creation), useful for e.g. finding charges expiring soon or measuring how close to expiry charges typically resolve. `escrowReleasedAt` is `null` until an escrow-configured charge is actually released \u2014 same implicit-exclusion behavior as `confirmedAt`, scoped to escrow charges only."
|
|
666
674
|
);
|
|
667
675
|
var ChargesFilterSchema = import_zod13.z.object({
|
|
668
676
|
field: ChargesQueryFieldSchema,
|
|
@@ -859,9 +867,10 @@ var ChargeWebhookEventTypeSchema = import_zod14.z.enum([
|
|
|
859
867
|
"charge.underpaid",
|
|
860
868
|
"charge.settled",
|
|
861
869
|
"charge.settlement_failed",
|
|
862
|
-
"charge.overpaid"
|
|
870
|
+
"charge.overpaid",
|
|
871
|
+
"charge.escrow_released"
|
|
863
872
|
]).describe(
|
|
864
|
-
'Note the distinction between `charge.confirmed` and `charge.settled`: `confirmed` means the payment was detected on-chain; `settled` means the merchant\'s wallet actually received the funds \u2014 a separate, later step. Subscribe to `confirmed` if you only need "will I get paid," or `settled` if you need "has the money actually arrived." `charge.overpaid` fires alongside `charge.confirmed`/`charge.partially_paid` whenever the cumulative amount received ends up above `amount` (see `Charge.isOverpaid`). Every event in this category carries the full `Charge` object as `data`.'
|
|
873
|
+
'Note the distinction between `charge.confirmed` and `charge.settled`: `confirmed` means the payment was detected on-chain; `settled` means the merchant\'s wallet actually received the funds \u2014 a separate, later step. Subscribe to `confirmed` if you only need "will I get paid," or `settled` if you need "has the money actually arrived." `charge.overpaid` fires alongside `charge.confirmed`/`charge.partially_paid` whenever the cumulative amount received ends up above `amount` (see `Charge.isOverpaid`). `charge.escrow_released` fires once an escrow-configured charge\'s funds have been moved out of its Safe to the split address by `POST /v1/charges/{id}/release` \u2014 a normal `charge.settled` still follows once the split itself finishes distributing. Every event in this category carries the full `Charge` object as `data`.'
|
|
865
874
|
);
|
|
866
875
|
var WebhookDeliveryEventTypeSchema = import_zod14.z.enum(["webhook.delivery_failed", "webhook.delivery_recovered", "webhook.endpoint_unhealthy"]).describe(
|
|
867
876
|
"Meta-events about the health of your own webhook endpoints \u2014 useful for monitoring without polling `GET /v1/webhooks/{id}/deliveries`. `webhook.endpoint_unhealthy` fires once when a webhook's failure rate over the trailing 24h crosses 20%, and `webhook.delivery_recovered` fires once when a delivery to that webhook next succeeds. `data` for every event in this category: `{ webhookId, url, failureRatio? }` (`failureRatio` only present on `webhook.endpoint_unhealthy`)."
|