@klappay/types 3.4.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.ts CHANGED
@@ -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 predetermined release transaction (destination and amount are fixed at escrow creation, never client-supplied here) with the private key behind this charge's `escrowReleaserAddress` \u2014 never anything Klappay can produce itself. Independently verified on-chain before anything moves; a mismatched, malformed, or missing signature is rejected, never trusted at face value."
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
 
@@ -867,9 +867,10 @@ var ChargeWebhookEventTypeSchema = import_zod14.z.enum([
867
867
  "charge.underpaid",
868
868
  "charge.settled",
869
869
  "charge.settlement_failed",
870
- "charge.overpaid"
870
+ "charge.overpaid",
871
+ "charge.escrow_released"
871
872
  ]).describe(
872
- '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`.'
873
874
  );
874
875
  var WebhookDeliveryEventTypeSchema = import_zod14.z.enum(["webhook.delivery_failed", "webhook.delivery_recovered", "webhook.endpoint_unhealthy"]).describe(
875
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`)."