@quicknode/sdk 3.8.1 → 3.9.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/index.d.ts CHANGED
@@ -48,6 +48,82 @@ export interface ActivateWebhookParams {
48
48
  startFrom: WebhookStartFrom
49
49
  }
50
50
 
51
+ /** Actor attached to an activity entry, including deleted users. */
52
+ export interface ActivityLogActor {
53
+ /** User or API-key UUID; absent for Quicknode and deleted users. */
54
+ id?: string
55
+ /** Actor kind: `user`, `api_key`, `quicknode`, or `deleted_user`. */
56
+ actorType: string
57
+ /** Actor name, when available. */
58
+ name?: string
59
+ /** Actor email, when available. */
60
+ email?: string
61
+ }
62
+
63
+ /** An account change and the actor who made it. */
64
+ export interface ActivityLogEntry {
65
+ /** Activity entry UUID. */
66
+ id: string
67
+ /** ISO 8601 timestamp of the change. */
68
+ occurredAt: string
69
+ /** Action performed, such as `created`. */
70
+ action: string
71
+ /** Human-readable description, when available. */
72
+ description?: string
73
+ /** Resource affected by the change. */
74
+ target: ActivityLogTarget
75
+ /** Actor responsible for the change. */
76
+ actor: ActivityLogActor
77
+ }
78
+
79
+ /** An actor available for activity-log filtering. */
80
+ export interface ActivityLogFilterActor {
81
+ /** User or API-key UUID to pass as `actor`. */
82
+ id: string
83
+ /** Actor name, when available. */
84
+ name?: string
85
+ /** Actor kind, such as `user` or `api_key`. */
86
+ actorType: string
87
+ }
88
+
89
+ /** Values accepted by the activity-log filters. */
90
+ export interface ActivityLogFiltersData {
91
+ /** Users and API keys available for filtering. */
92
+ actors: Array<ActivityLogFilterActor>
93
+ /** Target types available for filtering. */
94
+ types: Array<ActivityLogFilterType>
95
+ }
96
+
97
+ /** A target type available for activity-log filtering. */
98
+ export interface ActivityLogFilterType {
99
+ /** Value to pass as `target_type`. */
100
+ value: string
101
+ /** Human-readable target type. */
102
+ label: string
103
+ }
104
+
105
+ /** Offset pagination for activity logs. */
106
+ export interface ActivityLogPagination {
107
+ /** Total entries matching the filters. */
108
+ total: number
109
+ /** Page size used for this response. */
110
+ limit: number
111
+ /** Number of entries skipped. */
112
+ offset: number
113
+ }
114
+
115
+ /** Resource affected by an activity entry. */
116
+ export interface ActivityLogTarget {
117
+ /** Resource identifier; endpoint targets use numeric IDs as strings. */
118
+ id: string
119
+ /** Resource kind, when available. */
120
+ kind?: string
121
+ /** Resource label. */
122
+ label: string
123
+ /** Resource name, when available. */
124
+ name?: string
125
+ }
126
+
51
127
  /** Parameters for `add_list_item`. */
52
128
  export interface AddListItemParams {
53
129
  /** Item to append to the list. */
@@ -147,6 +223,8 @@ export interface BulkOperationResult {
147
223
  id: string
148
224
  /** Whether the operation succeeded for this endpoint. */
149
225
  success: boolean
226
+ /** Per-endpoint failure reason; absent on successful rows. */
227
+ error?: string
150
228
  }
151
229
 
152
230
  /** Summary data for a `bulk_remove_tag` response. */
@@ -274,6 +352,26 @@ export interface ChainUsage {
274
352
  name: string
275
353
  /** Credits consumed on the chain. */
276
354
  creditsUsed: number
355
+ /** RPC credits consumed. */
356
+ rpcCredits?: number
357
+ /** Data credits consumed. */
358
+ dataCredits?: number
359
+ /** Response bytes transferred. */
360
+ bytes?: number
361
+ }
362
+
363
+ /** Client certificate metadata. */
364
+ export interface ClientCertificate {
365
+ fingerprint: string
366
+ subject: string
367
+ issuer: string
368
+ expiresAt: string
369
+ }
370
+
371
+ /** Current client-certificate authentication state. */
372
+ export interface ClientCertsData {
373
+ enabled: boolean
374
+ certs: Array<ClientCertificate>
277
375
  }
278
376
 
279
377
  /** Metadata describing a single column in a query result set. */
@@ -292,17 +390,57 @@ export interface ColumnSchema {
292
390
  columnType: string
293
391
  }
294
392
 
393
+ /** Blocked IP address or CIDR range. Does not enable IP security. */
394
+ export interface CreateBlockedIpRequest {
395
+ ip: string
396
+ }
397
+
398
+ /** Created blocked IP record. */
399
+ export interface CreateBlockedIpResponse {
400
+ data: EndpointIp
401
+ error?: string
402
+ }
403
+
404
+ /** PEM certificate to add. */
405
+ export interface CreateClientCertRequest {
406
+ certificate: string
407
+ }
408
+
409
+ /** Full certificate state after the operation. */
410
+ export interface CreateClientCertResponse {
411
+ data: ClientCertsData
412
+ error?: string
413
+ }
414
+
415
+ /** Created security record. */
416
+ export interface CreatedDomainMask {
417
+ id: string
418
+ domainMask: string
419
+ }
420
+
295
421
  /** Parameters for `create_domain_mask`. */
296
422
  export interface CreateDomainMaskRequest {
297
- /** Custom domain that will mask the endpoint's Quicknode URL. */
423
+ /** Custom domain that will mask the endpoint's Quicknode URL; required by the API. */
298
424
  domainMask?: string
299
425
  }
300
426
 
427
+ /** Created security record and API error. */
428
+ export interface CreateDomainMaskResponse {
429
+ data: CreatedDomainMask
430
+ error?: string
431
+ }
432
+
433
+ /** Created security record. */
434
+ export interface CreatedReferrer {
435
+ id: string
436
+ url: string
437
+ }
438
+
301
439
  /** Parameters for `create_endpoint`. */
302
440
  export interface CreateEndpointRequest {
303
- /** Blockchain the endpoint should serve (e.g. `ethereum`). */
441
+ /** Blockchain the endpoint should serve (e.g. `ethereum`); required by the API. */
304
442
  chain?: string
305
- /** Specific network within the chain (e.g. `mainnet`). */
443
+ /** Specific network within the chain (e.g. `mainnet`); required for creation. */
306
444
  network?: string
307
445
  }
308
446
 
@@ -320,6 +458,12 @@ export interface CreateIpRequest {
320
458
  ip: string
321
459
  }
322
460
 
461
+ /** Created security record and API error. */
462
+ export interface CreateIpResponse {
463
+ data: EndpointIp
464
+ error?: string
465
+ }
466
+
323
467
  /** Parameters for `create_jwt`. */
324
468
  export interface CreateJwtRequest {
325
469
  /** Public key used to verify signed JWTs. */
@@ -330,6 +474,12 @@ export interface CreateJwtRequest {
330
474
  name: string
331
475
  }
332
476
 
477
+ /** Created security record and API error. */
478
+ export interface CreateJwtResponse {
479
+ data: EndpointJwt
480
+ error?: string
481
+ }
482
+
333
483
  /** Parameters for `create_list`. */
334
484
  export interface CreateListParams {
335
485
  /** Unique key identifying the list. */
@@ -338,7 +488,7 @@ export interface CreateListParams {
338
488
  items: Array<string>
339
489
  }
340
490
 
341
- /** Parameters for `create_method_rate_limit`. */
491
+ /** Parameters for `create_method_rate_limit`. The API requires a positive rate. */
342
492
  export interface CreateMethodRateLimitRequest {
343
493
  /** Interval over which the rate applies (e.g. `second`). */
344
494
  interval: string
@@ -346,6 +496,8 @@ export interface CreateMethodRateLimitRequest {
346
496
  methods: Array<string>
347
497
  /** Maximum number of calls allowed per interval. */
348
498
  rate: number
499
+ /** Whether the method limit applies per client IP. */
500
+ limitByIp?: boolean
349
501
  }
350
502
 
351
503
  /** Response from `create_method_rate_limit`. */
@@ -376,10 +528,23 @@ export interface CreateReferrerRequest {
376
528
  referrer: string
377
529
  }
378
530
 
531
+ /** Created security record and API error. */
532
+ export interface CreateReferrerResponse {
533
+ data: CreatedReferrer
534
+ error?: string
535
+ }
536
+
379
537
  /** Data wrapper for a created request filter. */
380
538
  export interface CreateRequestFilterData {
381
539
  /** Identifier of the newly created request filter. */
382
540
  id: string
541
+ /** Custom pattern, when returned by the API. */
542
+ pattern?: Record<string, unknown>
543
+ }
544
+
545
+ /** Custom JSON pattern for a request filter. */
546
+ export interface CreateRequestFilterPatternRequest {
547
+ pattern: Record<string, unknown>
383
548
  }
384
549
 
385
550
  /** Parameters for `create_request_filter`. */
@@ -404,12 +569,23 @@ export interface CreateSetParams {
404
569
  value: string
405
570
  }
406
571
 
572
+ /** Tags associated with the endpoint. */
573
+ export interface CreateTagData {
574
+ tags: Array<EndpointTagAssociation>
575
+ }
576
+
407
577
  /** Parameters for `create_tag` (on a specific endpoint). */
408
578
  export interface CreateTagRequest {
409
- /** Label for the new tag. Maximum 25 characters. */
579
+ /** Nonblank label, 3 through 25 characters after trimming. The SDK does not trim it. */
410
580
  label?: string
411
581
  }
412
582
 
583
+ /** Response from create_tag_with_response. */
584
+ export interface CreateTagResponse {
585
+ data: CreateTagData
586
+ error?: string
587
+ }
588
+
413
589
  /** Inner data for `create_team` responses. */
414
590
  export interface CreateTeamData {
415
591
  /** Team identifier. */
@@ -436,6 +612,12 @@ export interface CreateTeamResponse {
436
612
  error?: string
437
613
  }
438
614
 
615
+ /** Created security record and API error. */
616
+ export interface CreateTokenResponse {
617
+ data: EndpointToken
618
+ error?: string
619
+ }
620
+
439
621
  /** Inner data for `delete_account_tag`. */
440
622
  export interface DeleteAccountTagData {
441
623
  /** `true` when the tag was deleted. */
@@ -458,6 +640,12 @@ export interface DeleteBoolResponse {
458
640
  error?: string
459
641
  }
460
642
 
643
+ /** Full certificate state after the operation. */
644
+ export interface DeleteClientCertResponse {
645
+ data: ClientCertsData
646
+ error?: string
647
+ }
648
+
461
649
  /** Inner data for `delete_team` responses. */
462
650
  export interface DeleteTeamData {
463
651
  /** Human-readable confirmation message. */
@@ -472,6 +660,13 @@ export interface DeleteTeamResponse {
472
660
  error?: string
473
661
  }
474
662
 
663
+ /** Effective endpoint rate-limit overrides; null means no override. */
664
+ export interface EffectiveRateLimits {
665
+ rps?: number
666
+ rpd?: number
667
+ rpm?: number
668
+ }
669
+
475
670
  /** Result of `get_enabled_count`. */
476
671
  export interface EnabledCountResponse {
477
672
  /** Total count of currently enabled streams. */
@@ -490,7 +685,7 @@ export interface Endpoint {
490
685
  status: string
491
686
  /** Blockchain the endpoint serves (e.g. `ethereum`). */
492
687
  chain: string
493
- /** Specific network within the chain (e.g. `mainnet`). */
688
+ /** Specific network within the chain (e.g. `mainnet`); required for creation. */
494
689
  network: string
495
690
  /** Whether the endpoint is dedicated. */
496
691
  isDedicated: boolean
@@ -600,8 +795,10 @@ export interface EndpointReferrer {
600
795
  export interface EndpointRequestFilter {
601
796
  /** Filter identifier. */
602
797
  id: string
603
- /** Whitelisted RPC methods. */
604
- method: Array<string>
798
+ /** String methods or structured matchers. */
799
+ method: unknown[]
800
+ /** All top-level pattern keys other than method. */
801
+ params: Record<string, unknown>
605
802
  }
606
803
 
607
804
  /**
@@ -622,6 +819,8 @@ export interface EndpointSecurity {
622
819
  domainMasks?: Array<EndpointDomainMask>
623
820
  /** Whitelisted IP addresses. */
624
821
  ips?: Array<EndpointIp>
822
+ /** Blocked IP addresses or CIDR ranges. */
823
+ blockedIps?: Array<EndpointIp>
625
824
  /** Request (method) filters. */
626
825
  requestFilters?: Array<EndpointRequestFilter>
627
826
  }
@@ -630,6 +829,12 @@ export interface EndpointSecurity {
630
829
  export interface EndpointSecurityOptions {
631
830
  /** Whether token authentication is enforced. */
632
831
  tokens?: boolean
832
+ /** Whether HSTS is enabled. */
833
+ hsts?: boolean
834
+ /** Whether CORS is enabled. */
835
+ cors?: boolean
836
+ /** Whether response logging is enabled. */
837
+ responseLogging?: boolean
633
838
  /** Whether JWT validation is enforced. */
634
839
  jwts?: boolean
635
840
  /** Whether domain masking is enabled. */
@@ -652,6 +857,17 @@ export interface EndpointTag {
652
857
  label: string
653
858
  }
654
859
 
860
+ /** Endpoint tag association; id identifies the association, tag_id identifies the tag. */
861
+ export interface EndpointTagAssociation {
862
+ id: number
863
+ tagId: number
864
+ accountId: number
865
+ endpointId: number
866
+ label: string
867
+ createdAt: string
868
+ updatedAt: string
869
+ }
870
+
655
871
  /** Authentication token configured on an endpoint. */
656
872
  export interface EndpointToken {
657
873
  /** Token identifier. */
@@ -686,6 +902,53 @@ export interface EndpointUsage {
686
902
  methodsBreakdown: Array<MethodUsage>
687
903
  /** Request count during the window. */
688
904
  requests?: number
905
+ /** RPC credits consumed. */
906
+ rpcCredits?: number
907
+ /** Data credits consumed. */
908
+ dataCredits?: number
909
+ /** Response bytes transferred. */
910
+ bytes?: number
911
+ }
912
+
913
+ /** Summary window and grouped results. Totals cover the full window on every page. */
914
+ export interface ErrorsSummaryData {
915
+ /** Returned window start; the server may align it to billing boundaries. */
916
+ from: string
917
+ /** Returned window end; retain the server value without rounding. */
918
+ to: string
919
+ /** Totals for the complete window, independent of page size. */
920
+ totals: ErrorsSummaryTotals
921
+ /** Grouped results, omitted when grouping was not requested. */
922
+ breakdown?: Array<ErrorsSummaryRow>
923
+ /** Cursor for the next page, when present. */
924
+ nextCursor?: string
925
+ }
926
+
927
+ /**
928
+ * One grouped row from `get_errors_summary`. Dimension fields are absent unless
929
+ * selected; `Some(None)` represents an explicitly null dimension.
930
+ */
931
+ export interface ErrorsSummaryRow {
932
+ /** Kind for this group. */
933
+ kind: string
934
+ /** Count for this group. */
935
+ count: number
936
+ /** Group value, preserving omitted versus explicitly null fields. */
937
+ code?: string | undefined | null
938
+ /** Group value, preserving omitted versus explicitly null fields. */
939
+ endpoint?: number | undefined | null
940
+ /** Group value, preserving omitted versus explicitly null fields. */
941
+ network?: string | undefined | null
942
+ /** Group value, preserving omitted versus explicitly null fields. */
943
+ method?: string | undefined | null
944
+ }
945
+
946
+ /** Full-window totals for `get_errors_summary`. Numbers can be fractional. */
947
+ export interface ErrorsSummaryTotals {
948
+ /** Rpc errors across the complete window. */
949
+ rpcErrors: number
950
+ /** Http errors across the complete window. */
951
+ httpErrors: number
689
952
  }
690
953
 
691
954
  /**
@@ -784,6 +1047,14 @@ export interface GetAccountMetricsResponse {
784
1047
  error?: string
785
1048
  }
786
1049
 
1050
+ /** Response from `get_activity_log`. */
1051
+ export interface GetActivityLogResponse {
1052
+ /** The matching activity entry, when present. */
1053
+ data?: ActivityLogEntry
1054
+ /** Error message when the request did not succeed. */
1055
+ error?: string
1056
+ }
1057
+
787
1058
  /** Response from `get_api_credits`. */
788
1059
  export interface GetApiCreditsResponse {
789
1060
  /**
@@ -795,15 +1066,64 @@ export interface GetApiCreditsResponse {
795
1066
  error?: string
796
1067
  }
797
1068
 
1069
+ /** Blocked IP records visible for the current security state. */
1070
+ export interface GetBlockedIpsResponse {
1071
+ data: Array<EndpointIp>
1072
+ error?: string
1073
+ }
1074
+
1075
+ /** Full certificate state after the operation. */
1076
+ export interface GetClientCertsResponse {
1077
+ data: ClientCertsData
1078
+ error?: string
1079
+ }
1080
+
1081
+ /**
1082
+ * Parameters for `get_endpoint_errors_summary`. A first page requires `last`, or both
1083
+ * `from` and `to`; a continuation can contain only `cursor`.
1084
+ */
1085
+ export interface GetEndpointErrorsSummaryRequest {
1086
+ /** Relative window, such as `1h`; use a positive duration in s, m, h, or d. */
1087
+ last?: string
1088
+ /** Window start as an ISO 8601 timestamp with timezone. */
1089
+ from?: string
1090
+ /** Window end as an ISO 8601 timestamp with timezone. */
1091
+ to?: string
1092
+ /** Opaque cursor returned by the same route and original query. */
1093
+ cursor?: string
1094
+ /** Page size from 1 through 1000; the API defaults to 100. */
1095
+ limit?: number
1096
+ /** Grouping dimensions. Allowed values: `code`, `network`, `method`. */
1097
+ groupBy?: Array<string>
1098
+ /** Network names to include. */
1099
+ networks?: Array<string>
1100
+ /** RPC method names to include. */
1101
+ methods?: Array<string>
1102
+ /** RPC error codes represented as strings; requires RPC kind. */
1103
+ codes?: Array<string>
1104
+ /** HTTP status codes represented as strings; requires HTTP kind. */
1105
+ statusCodes?: Array<string>
1106
+ /** Error kind (`rpc` or `http`); method filters/grouping require RPC kind. */
1107
+ kind?: string
1108
+ }
1109
+
1110
+ /** Response from `get_endpoint_errors_summary`. */
1111
+ export interface GetEndpointErrorsSummaryResponse {
1112
+ /** Summary window, totals, and optional grouped results. */
1113
+ data: ErrorsSummaryData
1114
+ /** Error returned by the API, when present. */
1115
+ error?: string
1116
+ }
1117
+
798
1118
  /** Parameters for `get_endpoint_logs`. */
799
1119
  export interface GetEndpointLogsRequest {
800
- /** Start of the query window (timestamp). */
1120
+ /** Start of the query window as an ISO 8601 timestamp. */
801
1121
  from: string
802
- /** End of the query window (timestamp). */
1122
+ /** End of the query window as an ISO 8601 timestamp. */
803
1123
  to: string
804
1124
  /** When true, include full request/response payloads in each entry. */
805
1125
  includeDetails?: boolean
806
- /** Maximum number of log entries returned. */
1126
+ /** Maximum log entries: 1 through 100, default 20. */
807
1127
  limit?: number
808
1128
  /** Cursor returned by a previous page; pass to fetch the next page. */
809
1129
  nextAt?: string
@@ -823,6 +1143,8 @@ export interface GetEndpointMetricsRequest {
823
1143
  period: string
824
1144
  /** Metric name (e.g. `method_calls_over_time`, `response_status_breakdown`). */
825
1145
  metric: string
1146
+ /** Percentile from 1 through 100, required for response-time metrics. */
1147
+ percentile?: number
826
1148
  }
827
1149
 
828
1150
  /** Response from `get_endpoint_metrics`. */
@@ -843,7 +1165,7 @@ export interface GetEndpointSecurityResponse {
843
1165
 
844
1166
  /** Parameters for `get_endpoints`. */
845
1167
  export interface GetEndpointsRequest {
846
- /** Maximum number of endpoints returned. */
1168
+ /** Maximum number of endpoints returned, capped at 100. */
847
1169
  limit?: number
848
1170
  /** Starting index into the result set. */
849
1171
  offset?: number
@@ -863,9 +1185,9 @@ export interface GetEndpointsRequest {
863
1185
  dedicated?: boolean
864
1186
  /** When true, return only flat-rate endpoints. */
865
1187
  isFlatRate?: boolean
866
- /** Filter results by associated tag ids. */
1188
+ /** Filter by tag IDs; cannot be combined with nonempty tag_labels. */
867
1189
  tagIds?: Array<number>
868
- /** Filter results by associated tag labels. */
1190
+ /** Filter by tag labels; cannot be combined with nonempty tag_ids. */
869
1191
  tagLabels?: Array<string>
870
1192
  }
871
1193
 
@@ -900,6 +1222,45 @@ export interface GetEndpointUrlsResponse {
900
1222
  error?: string
901
1223
  }
902
1224
 
1225
+ /**
1226
+ * Parameters for `get_errors_summary`. A first page requires `last`, or both
1227
+ * `from` and `to`; a continuation can contain only `cursor`.
1228
+ */
1229
+ export interface GetErrorsSummaryRequest {
1230
+ /** Relative window, such as `1h`; use a positive duration in s, m, h, or d. */
1231
+ last?: string
1232
+ /** Window start as an ISO 8601 timestamp with timezone. */
1233
+ from?: string
1234
+ /** Window end as an ISO 8601 timestamp with timezone. */
1235
+ to?: string
1236
+ /** Opaque cursor returned by the same route and original query. */
1237
+ cursor?: string
1238
+ /** Page size from 1 through 1000; the API defaults to 100. */
1239
+ limit?: number
1240
+ /** Grouping dimensions. Allowed values: `code`, `endpoint`, `network`, `method`. */
1241
+ groupBy?: Array<string>
1242
+ /** Numeric endpoint IDs to include. */
1243
+ endpoints?: Array<number>
1244
+ /** Network names to include. */
1245
+ networks?: Array<string>
1246
+ /** RPC method names to include. */
1247
+ methods?: Array<string>
1248
+ /** RPC error codes represented as strings; requires RPC kind. */
1249
+ codes?: Array<string>
1250
+ /** HTTP status codes represented as strings; requires HTTP kind. */
1251
+ statusCodes?: Array<string>
1252
+ /** Error kind (`rpc` or `http`); method filters/grouping require RPC kind. */
1253
+ kind?: string
1254
+ }
1255
+
1256
+ /** Response from `get_errors_summary`. */
1257
+ export interface GetErrorsSummaryResponse {
1258
+ /** Summary window, totals, and optional grouped results. */
1259
+ data: ErrorsSummaryData
1260
+ /** Error returned by the API, when present. */
1261
+ error?: string
1262
+ }
1263
+
903
1264
  /** Inner data for `get_list` responses. */
904
1265
  export interface GetListData {
905
1266
  /** Items in the list on the current page. */
@@ -950,6 +1311,12 @@ export interface GetLogDetailsResponse {
950
1311
  data?: LogDetails
951
1312
  }
952
1313
 
1314
+ /** Current method blacklist. */
1315
+ export interface GetMethodBlacklistResponse {
1316
+ data: MethodBlacklistData
1317
+ error?: string
1318
+ }
1319
+
953
1320
  /** Inner data for `get_method_rate_limits`. */
954
1321
  export interface GetMethodRateLimitsData {
955
1322
  /** Rate limiters configured on the endpoint. */
@@ -964,6 +1331,12 @@ export interface GetMethodRateLimitsResponse {
964
1331
  error?: string
965
1332
  }
966
1333
 
1334
+ /** Current method range limits. */
1335
+ export interface GetRangeLimitsResponse {
1336
+ data: RangeLimitsData
1337
+ error?: string
1338
+ }
1339
+
967
1340
  /** Inner data for `get_rate_limits`. */
968
1341
  export interface GetRateLimitsData {
969
1342
  /** One row per enforced bucket. */
@@ -978,6 +1351,12 @@ export interface GetRateLimitsResponse {
978
1351
  error?: string
979
1352
  }
980
1353
 
1354
+ /** Response from `get_request_filters`. */
1355
+ export interface GetRequestFiltersResponse {
1356
+ data: Array<RequestFilter>
1357
+ error?: string
1358
+ }
1359
+
981
1360
  /** Response from `get_security_options`. */
982
1361
  export interface GetSecurityOptionsResponse {
983
1362
  /** Security options on the endpoint. */
@@ -1016,6 +1395,51 @@ export interface GetTeamResponse {
1016
1395
  error?: string
1017
1396
  }
1018
1397
 
1398
+ /**
1399
+ * Parameters for `get_traffic_summary`. A first page requires `last`, or both
1400
+ * `from` and `to`; a continuation can contain only `cursor`.
1401
+ */
1402
+ export interface GetTrafficSummaryRequest {
1403
+ /** Relative window, such as `1h`; use a positive duration in s, m, h, or d. */
1404
+ last?: string
1405
+ /** Window start as an ISO 8601 timestamp with timezone. */
1406
+ from?: string
1407
+ /** Window end as an ISO 8601 timestamp with timezone. */
1408
+ to?: string
1409
+ /** Opaque cursor returned by the same route and original query. */
1410
+ cursor?: string
1411
+ /** Page size from 1 through 1000; the API defaults to 100. */
1412
+ limit?: number
1413
+ /** Grouping dimensions. Allowed values: `method`, `endpoint`. */
1414
+ groupBy?: Array<string>
1415
+ /** Endpoint subdomains to include. */
1416
+ endpointNames?: Array<string>
1417
+ /** Chain names to include. */
1418
+ chains?: Array<string>
1419
+ /** Network names to include. */
1420
+ networks?: Array<string>
1421
+ /** RPC method names to include. */
1422
+ methods?: Array<string>
1423
+ /** Numeric account tag IDs represented as strings. */
1424
+ tagIds?: Array<string>
1425
+ /** Numeric account add-on IDs represented as strings. */
1426
+ addonIds?: Array<string>
1427
+ }
1428
+
1429
+ /** Options for `get_transaction`. */
1430
+ export interface GetTransactionRequest {
1431
+ /** Include retained request/response text. The API defaults to false. */
1432
+ includePayloads?: boolean
1433
+ }
1434
+
1435
+ /** Response from `get_transaction`. */
1436
+ export interface GetTransactionResponse {
1437
+ /** Lookup result, including whether retained details exist. */
1438
+ data: TransactionLookup
1439
+ /** Error message when the request did not succeed. */
1440
+ error?: string
1441
+ }
1442
+
1019
1443
  /** Response from `get_usage_by_chain`. */
1020
1444
  export interface GetUsageByChainResponse {
1021
1445
  /** Per-chain usage payload. */
@@ -1048,9 +1472,34 @@ export interface GetUsageByTagResponse {
1048
1472
  error?: string
1049
1473
  }
1050
1474
 
1475
+ /**
1476
+ * Parameters for `get_usage_credits_summary`. A first page requires `last`, or both
1477
+ * `from` and `to`; a continuation can contain only `cursor`.
1478
+ */
1479
+ export interface GetUsageCreditsSummaryRequest {
1480
+ /** Relative window, such as `1h`; use a positive duration in s, m, h, or d. */
1481
+ last?: string
1482
+ /** Window start as an ISO 8601 timestamp with timezone. */
1483
+ from?: string
1484
+ /** Window end as an ISO 8601 timestamp with timezone. */
1485
+ to?: string
1486
+ /** Opaque cursor returned by the same route and original query. */
1487
+ cursor?: string
1488
+ /** Page size from 1 through 1000; the API defaults to 100. */
1489
+ limit?: number
1490
+ }
1491
+
1492
+ /** Response from `get_usage_credits_summary`. */
1493
+ export interface GetUsageCreditsSummaryResponse {
1494
+ /** Summary window, totals, and optional grouped results. */
1495
+ data: UsageCreditsSummaryData
1496
+ /** Error returned by the API, when present. */
1497
+ error?: string
1498
+ }
1499
+
1051
1500
  /**
1052
1501
  * Parameters for the account usage methods (`get_usage`, `get_usage_by_*`).
1053
- * Both bounds are optional; omit for account-to-date totals.
1502
+ * Both bounds are optional; omit for billing-period totals.
1054
1503
  */
1055
1504
  export interface GetUsageRequest {
1056
1505
  /** Start of the query window (Unix timestamp). */
@@ -1067,6 +1516,95 @@ export interface GetUsageResponse {
1067
1516
  error?: string
1068
1517
  }
1069
1518
 
1519
+ /**
1520
+ * Parameters for `get_usage_rpc_summary`. A first page requires `last`, or both
1521
+ * `from` and `to`; a continuation can contain only `cursor`.
1522
+ */
1523
+ export interface GetUsageRpcSummaryRequest {
1524
+ /** Relative window, such as `1h`; use a positive duration in s, m, h, or d. */
1525
+ last?: string
1526
+ /** Window start as an ISO 8601 timestamp with timezone. */
1527
+ from?: string
1528
+ /** Window end as an ISO 8601 timestamp with timezone. */
1529
+ to?: string
1530
+ /** Opaque cursor returned by the same route and original query. */
1531
+ cursor?: string
1532
+ /** Page size from 1 through 1000; the API defaults to 100. */
1533
+ limit?: number
1534
+ /** Grouping dimensions. Allowed values: `method`, `endpoint`, `chain`, `network`. */
1535
+ groupBy?: Array<string>
1536
+ /** Endpoint subdomains to include. */
1537
+ endpointNames?: Array<string>
1538
+ /** Chain names to include. */
1539
+ chains?: Array<string>
1540
+ /** Network names to include. */
1541
+ networks?: Array<string>
1542
+ /** RPC method names to include. */
1543
+ methods?: Array<string>
1544
+ /** Numeric account tag IDs represented as strings. */
1545
+ tagIds?: Array<string>
1546
+ /** Numeric account add-on IDs represented as strings. */
1547
+ addonIds?: Array<string>
1548
+ }
1549
+
1550
+ /**
1551
+ * Parameters for `get_usage_streams_summary`. A first page requires `last`, or both
1552
+ * `from` and `to`; a continuation can contain only `cursor`.
1553
+ */
1554
+ export interface GetUsageStreamsSummaryRequest {
1555
+ /** Relative window, such as `1h`; use a positive duration in s, m, h, or d. */
1556
+ last?: string
1557
+ /** Window start as an ISO 8601 timestamp with timezone. */
1558
+ from?: string
1559
+ /** Window end as an ISO 8601 timestamp with timezone. */
1560
+ to?: string
1561
+ /** Opaque cursor returned by the same route and original query. */
1562
+ cursor?: string
1563
+ /** Page size from 1 through 1000; the API defaults to 100. */
1564
+ limit?: number
1565
+ /** Grouping dimensions. Allowed values: `stream`. */
1566
+ groupBy?: Array<string>
1567
+ /** Stream identifier to include. */
1568
+ streamId?: string
1569
+ }
1570
+
1571
+ /** Response from `get_usage_streams_summary`. */
1572
+ export interface GetUsageStreamsSummaryResponse {
1573
+ /** Summary window, totals, and optional grouped results. */
1574
+ data: UsageStreamsSummaryData
1575
+ /** Error returned by the API, when present. */
1576
+ error?: string
1577
+ }
1578
+
1579
+ /**
1580
+ * Parameters for `get_usage_webhooks_summary`. A first page requires `last`, or both
1581
+ * `from` and `to`; a continuation can contain only `cursor`.
1582
+ */
1583
+ export interface GetUsageWebhooksSummaryRequest {
1584
+ /** Relative window, such as `1h`; use a positive duration in s, m, h, or d. */
1585
+ last?: string
1586
+ /** Window start as an ISO 8601 timestamp with timezone. */
1587
+ from?: string
1588
+ /** Window end as an ISO 8601 timestamp with timezone. */
1589
+ to?: string
1590
+ /** Opaque cursor returned by the same route and original query. */
1591
+ cursor?: string
1592
+ /** Page size from 1 through 1000; the API defaults to 100. */
1593
+ limit?: number
1594
+ /** Grouping dimensions. Allowed values: `webhook`. */
1595
+ groupBy?: Array<string>
1596
+ /** Webhook identifier to include. */
1597
+ webhookId?: string
1598
+ }
1599
+
1600
+ /** Response from `get_usage_webhooks_summary`. */
1601
+ export interface GetUsageWebhooksSummaryResponse {
1602
+ /** Summary window, totals, and optional grouped results. */
1603
+ data: UsageWebhooksSummaryData
1604
+ /** Error returned by the API, when present. */
1605
+ error?: string
1606
+ }
1607
+
1070
1608
  /** Parameters for `list_webhooks`. */
1071
1609
  export interface GetWebhooksParams {
1072
1610
  /** Maximum number of webhooks returned. */
@@ -1107,7 +1645,7 @@ export interface InviteTeamMemberRequest {
1107
1645
  email: string
1108
1646
  /** Full name (required for new users). */
1109
1647
  fullName?: string
1110
- /** Team role (`admin`, `viewer`, or `billing`); required for new users. */
1648
+ /** Standard role or account custom-role key; required for new users. */
1111
1649
  role?: string
1112
1650
  }
1113
1651
 
@@ -1199,6 +1737,44 @@ export interface KvStoreConfig {
1199
1737
  baseUrl?: string
1200
1738
  }
1201
1739
 
1740
+ /** Response from `list_activity_log_filters`. */
1741
+ export interface ListActivityLogFiltersResponse {
1742
+ /** Available actor and target-type filters. */
1743
+ data: ActivityLogFiltersData
1744
+ /** Error message when the request did not succeed. */
1745
+ error?: string
1746
+ }
1747
+
1748
+ /** Filters and pagination for `list_activity_logs`. */
1749
+ export interface ListActivityLogsRequest {
1750
+ /** Search descriptions, endpoint subdomains, and team names. */
1751
+ q?: string
1752
+ /** User or API-key UUID returned by `list_activity_log_filters`. */
1753
+ actor?: string
1754
+ /** Numeric endpoint ID represented as a string. */
1755
+ endpointId?: string
1756
+ /** Target type, such as `endpoint`, `team`, or `api_key`. */
1757
+ targetType?: string
1758
+ /** ISO 8601 start date or timestamp; a bare date starts at midnight UTC. */
1759
+ from?: string
1760
+ /** ISO 8601 end date or timestamp; a bare date includes that entire UTC day. */
1761
+ to?: string
1762
+ /** Page size from 0 through 100; the API defaults to 20. */
1763
+ limit?: number
1764
+ /** Entries to skip. Pin `to_time` when exporting to avoid shifting pages. */
1765
+ offset?: number
1766
+ }
1767
+
1768
+ /** Response from `list_activity_logs`. */
1769
+ export interface ListActivityLogsResponse {
1770
+ /** Activity entries, newest first. */
1771
+ data: Array<ActivityLogEntry>
1772
+ /** Offset pagination metadata. */
1773
+ pagination: ActivityLogPagination
1774
+ /** Error message when the request did not succeed. */
1775
+ error?: string
1776
+ }
1777
+
1202
1778
  /** Response from `list_chains`. */
1203
1779
  export interface ListChainsResponse {
1204
1780
  /** Supported chains and their networks. */
@@ -1285,6 +1861,38 @@ export interface ListTeamsResponse {
1285
1861
  error?: string
1286
1862
  }
1287
1863
 
1864
+ /** Time window, filters, and cursor for `list_transactions`. */
1865
+ export interface ListTransactionsRequest {
1866
+ /** Positive duration ending now, such as `1h` or `7d`; units are s, m, h, or d. */
1867
+ last?: string
1868
+ /** ISO 8601 start timestamp with timezone; supply with `to_time` instead of `last`. */
1869
+ from?: string
1870
+ /** ISO 8601 end timestamp with timezone. */
1871
+ to?: string
1872
+ /** Network to filter. */
1873
+ network?: string
1874
+ /** RPC method to filter. */
1875
+ method?: string
1876
+ /** Transaction state: `submitted`, `succeeded`, or `failed`. */
1877
+ state?: string
1878
+ /** Transaction hash to filter. */
1879
+ transactionHash?: string
1880
+ /** Opaque continuation cursor; can be supplied without a time window. */
1881
+ cursor?: string
1882
+ /** Numeric endpoint IDs, encoded as repeated `endpoints[]` keys. */
1883
+ endpoints?: Array<number>
1884
+ /** Page size from 1 through 1000; the API defaults to 100. */
1885
+ limit?: number
1886
+ }
1887
+
1888
+ /** Response from `list_transactions`. */
1889
+ export interface ListTransactionsResponse {
1890
+ /** Resolved time window and transaction page. */
1891
+ data: TransactionsData
1892
+ /** Error message when the request did not succeed. */
1893
+ error?: string
1894
+ }
1895
+
1288
1896
  /** Response from `list_webhooks`. */
1289
1897
  export interface ListWebhooksResponse {
1290
1898
  /** Webhooks on the current page. */
@@ -1301,6 +1909,11 @@ export interface LogDetails {
1301
1909
  response?: string
1302
1910
  }
1303
1911
 
1912
+ /** Blocked methods. */
1913
+ export interface MethodBlacklistData {
1914
+ methods: Array<string>
1915
+ }
1916
+
1304
1917
  /** A per-method rate limiter configured on an endpoint. */
1305
1918
  export interface MethodRateLimiter {
1306
1919
  /** Rate limiter identifier. */
@@ -1315,6 +1928,8 @@ export interface MethodRateLimiter {
1315
1928
  status: string
1316
1929
  /** Creation timestamp. */
1317
1930
  created: string
1931
+ /** Whether the method limit applies per client IP. */
1932
+ limitByIp?: boolean
1318
1933
  }
1319
1934
 
1320
1935
  /** Per-method usage row. */
@@ -1329,6 +1944,8 @@ export interface MethodUsage {
1329
1944
  network?: string
1330
1945
  /** Chain the calls targeted. */
1331
1946
  chain?: string
1947
+ /** Response bytes transferred. */
1948
+ bytes?: number
1332
1949
  }
1333
1950
 
1334
1951
  /** Pagination metadata returned alongside a paginated result set. */
@@ -1465,6 +2082,12 @@ export interface QueryStatistics {
1465
2082
  bytesRead: number
1466
2083
  }
1467
2084
 
2085
+ /** Range limits and supported methods for this endpoint chain. */
2086
+ export interface RangeLimitsData {
2087
+ limits: Record<string, number>
2088
+ supportedMethods: Array<string>
2089
+ }
2090
+
1468
2091
  /**
1469
2092
  * A single rate-limit row returned by `get_rate_limits`, identifying the
1470
2093
  * bucket (`rps`/`rpm`/`rpd`), the value enforced, and whether the value comes
@@ -1523,6 +2146,13 @@ export interface RenameTagResponse {
1523
2146
  error?: string
1524
2147
  }
1525
2148
 
2149
+ /** Filter as returned by the request-filter list API. */
2150
+ export interface RequestFilter {
2151
+ id: string
2152
+ pattern: Record<string, unknown>
2153
+ methodWhitelist: boolean
2154
+ }
2155
+
1526
2156
  /** Response from `resend_team_invite`. */
1527
2157
  export interface ResendTeamInviteResponse {
1528
2158
  /** Operation result message. */
@@ -1654,6 +2284,8 @@ export interface SecurityOptionsUpdate {
1654
2284
  requestFilters?: string
1655
2285
  /** Custom IP header toggle. */
1656
2286
  ipCustomHeader?: string
2287
+ /** Response logging toggle. */
2288
+ responseLogging?: string
1657
2289
  }
1658
2290
 
1659
2291
  /** Response from `show_endpoint`. */
@@ -1808,6 +2440,12 @@ export interface TagUsage {
1808
2440
  creditsUsed: number
1809
2441
  /** Request count during the window. */
1810
2442
  requests: number
2443
+ /** RPC credits consumed. */
2444
+ rpcCredits?: number
2445
+ /** Data credits consumed. */
2446
+ dataCredits?: number
2447
+ /** Response bytes transferred. */
2448
+ bytes?: number
1811
2449
  }
1812
2450
 
1813
2451
  /** Full team detail including pending invites. */
@@ -1917,9 +2555,128 @@ export interface ToolingAccessStatus {
1917
2555
  endpointId?: string
1918
2556
  }
1919
2557
 
2558
+ /** Full-window totals for `get_traffic_summary`. Numbers can be fractional. */
2559
+ export interface TrafficSummaryTotals {
2560
+ /** Successful requests across the complete window. */
2561
+ successfulRequests: number
2562
+ /** Bytes across the complete window. */
2563
+ bytes: number
2564
+ /** Request credits across the complete window. */
2565
+ requestCredits: number
2566
+ /** Bytes credits across the complete window. */
2567
+ bytesCredits: number
2568
+ /** Credits across the complete window. */
2569
+ credits: number
2570
+ /** Active methods across the complete window. */
2571
+ activeMethods: number
2572
+ }
2573
+
2574
+ /** One retained submission attempt. */
2575
+ export interface TransactionAttempt {
2576
+ /** Submission timestamp. */
2577
+ submittedAt: string
2578
+ /** Numeric ID of the submitting endpoint. */
2579
+ endpointId: number
2580
+ /** RPC method used. */
2581
+ method: string
2582
+ /** Request UUID. */
2583
+ requestId: string
2584
+ /** Payload text, only when requested and available. */
2585
+ payloads?: TransactionPayloads
2586
+ }
2587
+
2588
+ /** Retained transaction details and ordered submission attempts. */
2589
+ export interface TransactionDetail {
2590
+ /** Network on which the transaction was submitted. */
2591
+ network: string
2592
+ /** Transaction hash. */
2593
+ transactionHash: string
2594
+ /** Timestamp of the first submission. */
2595
+ firstSubmittedAt: string
2596
+ /** Timestamp of the latest submission. */
2597
+ lastSubmittedAt: string
2598
+ /** Current transaction state. */
2599
+ state: string
2600
+ /** Number of attempts, when available. */
2601
+ attemptCount?: number
2602
+ /** Numeric endpoint IDs, when available; individual entries may be null. */
2603
+ endpointIds?: Array<number | undefined | null>
2604
+ /** Submission methods, when available. */
2605
+ methods?: Array<string>
2606
+ /** Whether archive data was used, when available. */
2607
+ archive?: boolean
2608
+ /** Decimal block-height string, when available. */
2609
+ height?: string
2610
+ /** Retained attempts in the order returned by the API. */
2611
+ attempts: Array<TransactionAttempt>
2612
+ }
2613
+
2614
+ /** Result of a retained transaction lookup. */
2615
+ export interface TransactionLookup {
2616
+ /** Whether the transaction has retained details. */
2617
+ exists: boolean
2618
+ /** Details when retained; null or absent when `exists` is false. */
2619
+ data?: TransactionDetail
2620
+ }
2621
+
2622
+ /** Original request and response text for an attempt. */
2623
+ export interface TransactionPayloads {
2624
+ /** Original request text; preserved without parsing or reformatting. */
2625
+ request?: string
2626
+ /** Original response text; may contain non-JSON content. */
2627
+ response?: string
2628
+ }
2629
+
2630
+ /** A page of transactions within the resolved time window. */
2631
+ export interface TransactionsData {
2632
+ /** Resolved start timestamp. */
2633
+ from: string
2634
+ /** Resolved end timestamp. */
2635
+ to: string
2636
+ /** Transactions, newest first. */
2637
+ transactions: Array<TransactionSummary>
2638
+ /** Cursor for the next page; omitted when there are no more rows. */
2639
+ nextCursor?: string
2640
+ }
2641
+
2642
+ /** A retained transaction and its aggregate submission metadata. */
2643
+ export interface TransactionSummary {
2644
+ /** Network on which the transaction was submitted. */
2645
+ network: string
2646
+ /** Transaction hash. */
2647
+ transactionHash: string
2648
+ /** Timestamp of the first submission. */
2649
+ firstSubmittedAt: string
2650
+ /** Timestamp of the latest submission. */
2651
+ lastSubmittedAt: string
2652
+ /** Number of submission attempts. */
2653
+ attemptCount: number
2654
+ /** Numeric IDs of submitting endpoints; null entries remain in place. */
2655
+ endpointIds: Array<number | undefined | null>
2656
+ /** RPC methods used to submit this transaction. */
2657
+ methods: Array<string>
2658
+ /** Whether archive data was used. */
2659
+ archive: boolean
2660
+ /** Decimal block-height string, preserving values above JavaScript safe integers. */
2661
+ height?: string
2662
+ /** Transaction state: `submitted`, `succeeded`, or `failed`. */
2663
+ state: string
2664
+ }
2665
+
2666
+ /** Enable or disable client-certificate authentication. */
2667
+ export interface UpdateClientCertsRequest {
2668
+ enabled: boolean
2669
+ }
2670
+
2671
+ /** Full certificate state after the operation. */
2672
+ export interface UpdateClientCertsResponse {
2673
+ data: ClientCertsData
2674
+ error?: string
2675
+ }
2676
+
1920
2677
  /** Parameters for `update_endpoint`. */
1921
2678
  export interface UpdateEndpointRequest {
1922
- /** New human-readable label. */
2679
+ /** New human-readable label; required by the API. */
1923
2680
  label?: string
1924
2681
  }
1925
2682
 
@@ -1945,7 +2702,18 @@ export interface UpdateListParams {
1945
2702
  removeItems?: Array<string>
1946
2703
  }
1947
2704
 
1948
- /** Parameters for `update_method_rate_limit`. Only provided fields are changed. */
2705
+ /** Replacement blacklist; an empty list clears it. */
2706
+ export interface UpdateMethodBlacklistRequest {
2707
+ methods: Array<string>
2708
+ }
2709
+
2710
+ /** Current method blacklist. */
2711
+ export interface UpdateMethodBlacklistResponse {
2712
+ data: MethodBlacklistData
2713
+ error?: string
2714
+ }
2715
+
2716
+ /** Parameters for `update_method_rate_limit`. Supply at least one field; false counts. Only provided fields are changed. */
1949
2717
  export interface UpdateMethodRateLimitRequest {
1950
2718
  /** New set of RPC methods the limiter applies to. */
1951
2719
  methods?: Array<string>
@@ -1953,6 +2721,8 @@ export interface UpdateMethodRateLimitRequest {
1953
2721
  status?: string
1954
2722
  /** New rate value. */
1955
2723
  rate?: number
2724
+ /** Whether the method limit applies per client IP. */
2725
+ limitByIp?: boolean
1956
2726
  }
1957
2727
 
1958
2728
  /** Response from `update_method_rate_limit`. */
@@ -1963,10 +2733,39 @@ export interface UpdateMethodRateLimitResponse {
1963
2733
  error?: string
1964
2734
  }
1965
2735
 
1966
- /** Parameters for `update_rate_limits`. */
2736
+ /** Replacement positive range limits; an empty object clears them. */
2737
+ export interface UpdateRangeLimitsRequest {
2738
+ limits: Record<string, number>
2739
+ }
2740
+
2741
+ /** Current method range limits. */
2742
+ export interface UpdateRangeLimitsResponse {
2743
+ data: RangeLimitsData
2744
+ error?: string
2745
+ }
2746
+
2747
+ /** Effective rate-limit override payload. */
2748
+ export interface UpdateRateLimitsData {
2749
+ limits: EffectiveRateLimits
2750
+ }
2751
+
2752
+ /** Parameters for `update_rate_limits`. Supply at least one field. */
1967
2753
  export interface UpdateRateLimitsRequest {
1968
- /** Rate limit values to apply. */
1969
- rateLimits: RateLimitSettings
2754
+ /** Rate limit values to apply. Omit to leave the caps unchanged. */
2755
+ rateLimits?: RateLimitSettings
2756
+ /** Apply endpoint limits per client IP. Omit to leave the mode unchanged. */
2757
+ limitByIp?: boolean
2758
+ }
2759
+
2760
+ /** Response from update_rate_limits_with_response. */
2761
+ export interface UpdateRateLimitsResponse {
2762
+ data: UpdateRateLimitsData
2763
+ error?: string
2764
+ }
2765
+
2766
+ /** Custom JSON pattern for a request filter. */
2767
+ export interface UpdateRequestFilterPatternRequest {
2768
+ pattern: Record<string, unknown>
1970
2769
  }
1971
2770
 
1972
2771
  /** Parameters for `update_request_filter`. */
@@ -2062,6 +2861,32 @@ export interface UsageByTagData {
2062
2861
  endTime?: number
2063
2862
  }
2064
2863
 
2864
+ /** Summary window and grouped results. Totals cover the full window on every page. */
2865
+ export interface UsageCreditsSummaryData {
2866
+ /** Returned window start; the server may align it to billing boundaries. */
2867
+ from: string
2868
+ /** Returned window end; retain the server value without rounding. */
2869
+ to: string
2870
+ /** Totals for the complete window, independent of page size. */
2871
+ totals: UsageCreditsSummaryTotals
2872
+ /** Grouped results, omitted when grouping was not requested. */
2873
+ breakdown?: Array<UsageCreditsSummaryRow>
2874
+ /** Cursor for the next page, when present. */
2875
+ nextCursor?: string
2876
+ }
2877
+
2878
+ /** Credits row supported by the response schema. The credits request has no grouping option. */
2879
+ export interface UsageCreditsSummaryRow {
2880
+ /** Credits for this group. */
2881
+ credits: number
2882
+ }
2883
+
2884
+ /** Full-window totals for `get_usage_credits_summary`. Numbers can be fractional. */
2885
+ export interface UsageCreditsSummaryTotals {
2886
+ /** Credits across the complete window. */
2887
+ credits: number
2888
+ }
2889
+
2065
2890
  /** Aggregate account usage for a time window. */
2066
2891
  export interface UsageData {
2067
2892
  /** Credits consumed during the window. */
@@ -2078,6 +2903,94 @@ export interface UsageData {
2078
2903
  endTime: number
2079
2904
  }
2080
2905
 
2906
+ /** Full-window totals for `get_usage_rpc_summary`. Numbers can be fractional. */
2907
+ export interface UsageRpcSummaryTotals {
2908
+ /** Requests across the complete window. */
2909
+ requests: number
2910
+ /** Bytes across the complete window. */
2911
+ bytes: number
2912
+ /** Rpc credits across the complete window. */
2913
+ rpcCredits: number
2914
+ /** Data credits across the complete window. */
2915
+ dataCredits: number
2916
+ /** Credits across the complete window. */
2917
+ credits: number
2918
+ }
2919
+
2920
+ /** Summary window and grouped results. Totals cover the full window on every page. */
2921
+ export interface UsageStreamsSummaryData {
2922
+ /** Returned window start; the server may align it to billing boundaries. */
2923
+ from: string
2924
+ /** Returned window end; retain the server value without rounding. */
2925
+ to: string
2926
+ /** Totals for the complete window, independent of page size. */
2927
+ totals: UsageStreamsSummaryTotals
2928
+ /** Grouped results, omitted when grouping was not requested. */
2929
+ breakdown?: Array<UsageStreamsSummaryRow>
2930
+ /** Cursor for the next page, when present. */
2931
+ nextCursor?: string
2932
+ }
2933
+
2934
+ /**
2935
+ * One grouped row from `get_usage_streams_summary`. Dimension fields are absent unless
2936
+ * selected; `Some(None)` represents an explicitly null dimension.
2937
+ */
2938
+ export interface UsageStreamsSummaryRow {
2939
+ /** Blocks for this group. */
2940
+ blocks: number
2941
+ /** Bytes for this group. */
2942
+ bytes: number
2943
+ /** Block credits for this group. */
2944
+ blockCredits: number
2945
+ /** Group value, preserving omitted versus explicitly null fields. */
2946
+ stream?: string | undefined | null
2947
+ }
2948
+
2949
+ /** Full-window totals for `get_usage_streams_summary`. Numbers can be fractional. */
2950
+ export interface UsageStreamsSummaryTotals {
2951
+ /** Blocks across the complete window. */
2952
+ blocks: number
2953
+ /** Bytes across the complete window. */
2954
+ bytes: number
2955
+ /** Block credits across the complete window. */
2956
+ blockCredits: number
2957
+ }
2958
+
2959
+ /** Summary window and grouped results. Totals cover the full window on every page. */
2960
+ export interface UsageWebhooksSummaryData {
2961
+ /** Returned window start; the server may align it to billing boundaries. */
2962
+ from: string
2963
+ /** Returned window end; retain the server value without rounding. */
2964
+ to: string
2965
+ /** Totals for the complete window, independent of page size. */
2966
+ totals: UsageWebhooksSummaryTotals
2967
+ /** Grouped results, omitted when grouping was not requested. */
2968
+ breakdown?: Array<UsageWebhooksSummaryRow>
2969
+ /** Cursor for the next page, when present. */
2970
+ nextCursor?: string
2971
+ }
2972
+
2973
+ /**
2974
+ * One grouped row from `get_usage_webhooks_summary`. Dimension fields are absent unless
2975
+ * selected; `Some(None)` represents an explicitly null dimension.
2976
+ */
2977
+ export interface UsageWebhooksSummaryRow {
2978
+ /** Deliveries for this group. */
2979
+ deliveries: number
2980
+ /** Credits for this group. */
2981
+ credits: number
2982
+ /** Group value, preserving omitted versus explicitly null fields. */
2983
+ webhook?: string | undefined | null
2984
+ }
2985
+
2986
+ /** Full-window totals for `get_usage_webhooks_summary`. Numbers can be fractional. */
2987
+ export interface UsageWebhooksSummaryTotals {
2988
+ /** Deliveries across the complete window. */
2989
+ deliveries: number
2990
+ /** Credits across the complete window. */
2991
+ credits: number
2992
+ }
2993
+
2081
2994
  /** A webhook's full configuration and current state. */
2082
2995
  export interface Webhook {
2083
2996
  /** Unique webhook identifier. */
@@ -2178,6 +3091,86 @@ export interface XrplWalletFilterTemplate {
2178
3091
  wallets: Array<string>
2179
3092
  }
2180
3093
  export declare class AdminApiClient {
3094
+ /** Get client certs. */
3095
+ getClientCerts(id: string): Promise<GetClientCertsResponse>
3096
+ /** Create client cert. */
3097
+ createClientCert(id: string, params: CreateClientCertRequest): Promise<CreateClientCertResponse>
3098
+ /** Update client certs. */
3099
+ updateClientCerts(id: string, params: UpdateClientCertsRequest): Promise<UpdateClientCertsResponse>
3100
+ /** Delete client cert. */
3101
+ deleteClientCert(id: string, fingerprint: string): Promise<DeleteClientCertResponse>
3102
+ /** Get method blacklist. */
3103
+ getMethodBlacklist(id: string): Promise<GetMethodBlacklistResponse>
3104
+ /** Update method blacklist. */
3105
+ updateMethodBlacklist(id: string, params: UpdateMethodBlacklistRequest): Promise<UpdateMethodBlacklistResponse>
3106
+ /** Get range limits. */
3107
+ getRangeLimits(id: string): Promise<GetRangeLimitsResponse>
3108
+ /** Update range limits. */
3109
+ updateRangeLimits(id: string, params: UpdateRangeLimitsRequest): Promise<UpdateRangeLimitsResponse>
3110
+ /** Get blocked ips. */
3111
+ getBlockedIps(id: string): Promise<GetBlockedIpsResponse>
3112
+ /** Create blocked ip. */
3113
+ createBlockedIp(id: string, params: CreateBlockedIpRequest): Promise<CreateBlockedIpResponse>
3114
+ /** Delete blocked ip. */
3115
+ deleteBlockedIp(id: string, ipId: string): Promise<DeleteBoolResponse>
3116
+ /** List activity logs. */
3117
+ listActivityLogs(params?: ListActivityLogsRequest | undefined | null): Promise<ListActivityLogsResponse>
3118
+ /** List activity log filters. */
3119
+ listActivityLogFilters(): Promise<ListActivityLogFiltersResponse>
3120
+ /** Get activity log. */
3121
+ getActivityLog(id: string): Promise<GetActivityLogResponse>
3122
+ /** List transactions. */
3123
+ listTransactions(params?: ListTransactionsRequest | undefined | null): Promise<ListTransactionsResponse>
3124
+ /** Get transaction. */
3125
+ getTransaction(network: string, hash: string, params?: GetTransactionRequest | undefined | null): Promise<GetTransactionResponse>
3126
+ /** Get usage credits summary. */
3127
+ getUsageCreditsSummary(params?: GetUsageCreditsSummaryRequest | undefined | null): Promise<GetUsageCreditsSummaryResponse>
3128
+ /** Get usage rpc summary. */
3129
+ getUsageRpcSummary(params?: GetUsageRpcSummaryRequest | undefined | null): Promise<GetUsageRpcSummaryResponse>
3130
+ /** Get usage streams summary. */
3131
+ getUsageStreamsSummary(params?: GetUsageStreamsSummaryRequest | undefined | null): Promise<GetUsageStreamsSummaryResponse>
3132
+ /** Get usage webhooks summary. */
3133
+ getUsageWebhooksSummary(params?: GetUsageWebhooksSummaryRequest | undefined | null): Promise<GetUsageWebhooksSummaryResponse>
3134
+ /** Get traffic summary. */
3135
+ getTrafficSummary(params?: GetTrafficSummaryRequest | undefined | null): Promise<GetTrafficSummaryResponse>
3136
+ /** Get errors summary. */
3137
+ getErrorsSummary(params?: GetErrorsSummaryRequest | undefined | null): Promise<GetErrorsSummaryResponse>
3138
+ /** Get endpoint errors summary. */
3139
+ getEndpointErrorsSummary(id: string, params?: GetEndpointErrorsSummaryRequest | undefined | null): Promise<GetEndpointErrorsSummaryResponse>
3140
+ /** Generates a new authentication token for an endpoint. */
3141
+ createTokenWithResponse(id: string): Promise<CreateTokenResponse>
3142
+ /**
3143
+ * Adds a referrer to an endpoint's security settings, specifying which
3144
+ * external URL or domain is permitted to call the endpoint.
3145
+ */
3146
+ createReferrerWithResponse(id: string, params?: CreateReferrerRequest | undefined | null): Promise<CreateReferrerResponse>
3147
+ /** Adds an IP address to an endpoint's security whitelist. */
3148
+ createIpWithResponse(id: string, params?: CreateIpRequest | undefined | null): Promise<CreateIpResponse>
3149
+ /**
3150
+ * Adds a domain mask to an endpoint — a custom domain used to hide the
3151
+ * endpoint's Quicknode URL so requests can be routed through your own
3152
+ * domain.
3153
+ */
3154
+ createDomainMaskWithResponse(id: string, params?: CreateDomainMaskRequest | undefined | null): Promise<CreateDomainMaskResponse>
3155
+ /**
3156
+ * Creates a new JWT for endpoint authentication. Accepts a public key,
3157
+ * key id (`kid`), and token name.
3158
+ */
3159
+ createJwtWithResponse(id: string, params?: CreateJwtRequest | undefined | null): Promise<CreateJwtResponse>
3160
+ /**
3161
+ * Creates a new tag on a specific endpoint from a label. Returns the new
3162
+ * tag with its id, account info, and timestamps.
3163
+ */
3164
+ createTagWithResponse(id: string, params?: CreateTagRequest | undefined | null): Promise<CreateTagResponse>
3165
+ /**
3166
+ * Partial update of the endpoint-level rate-limit overrides. Accepts
3167
+ * `rps` (requests per second), `rpm` (requests per minute), and `rpd`
3168
+ * (requests per day). Only buckets included are modified — omitted
3169
+ * buckets are left unchanged. Values are capped by the account's plan
3170
+ * tier. `limitByIp` applies these caps per client IP and can be sent alone.
3171
+ * Supply `rateLimits` or `limitByIp`; omitted fields stay unchanged.
3172
+ */
3173
+ updateRateLimitsWithResponse(id: string, params: UpdateRateLimitsRequest): Promise<UpdateRateLimitsResponse>
2181
3174
  /**
2182
3175
  * Returns a paginated list of endpoints on the account. Supports searching
2183
3176
  * by subdomain or label, filtering by networks, statuses, labels, and
@@ -2195,10 +3188,7 @@ export declare class AdminApiClient {
2195
3188
  createEndpoint(params?: CreateEndpointRequest | undefined | null): Promise<CreateEndpointResponse>
2196
3189
  /** Returns details for a specific endpoint by ID. */
2197
3190
  showEndpoint(id: string): Promise<ShowEndpointResponse>
2198
- /**
2199
- * Updates editable fields on an endpoint (e.g. its label). Returns a
2200
- * boolean indicating whether the update succeeded.
2201
- */
3191
+ /** Updates the endpoint label, which the API requires. Returns HTTP success. */
2202
3192
  updateEndpoint(id: string, params?: UpdateEndpointRequest | undefined | null): Promise<void>
2203
3193
  /**
2204
3194
  * Archives an endpoint. The API uses `DELETE` but the effect is archival
@@ -2353,7 +3343,8 @@ export declare class AdminApiClient {
2353
3343
  * `rps` (requests per second), `rpm` (requests per minute), and `rpd`
2354
3344
  * (requests per day). Only buckets included are modified — omitted
2355
3345
  * buckets are left unchanged. Values are capped by the account's plan
2356
- * tier.
3346
+ * tier. `limitByIp` applies these caps per client IP and can be sent alone.
3347
+ * Supply `rateLimits` or `limitByIp`; omitted fields stay unchanged.
2357
3348
  */
2358
3349
  updateRateLimits(id: string, params: UpdateRateLimitsRequest): Promise<void>
2359
3350
  /**
@@ -2522,6 +3513,9 @@ export declare class AdminApiClient {
2522
3513
  * object describing which features are enabled.
2523
3514
  */
2524
3515
  getEndpointSecurity(id: string): Promise<GetEndpointSecurityResponse>
3516
+ getRequestFilters(id: string): Promise<GetRequestFiltersResponse>
3517
+ createRequestFilterPattern(id: string, params: CreateRequestFilterPatternRequest): Promise<CreateRequestFilterResponse>
3518
+ updateRequestFilterPattern(id: string, requestFilterId: string, params: UpdateRequestFilterPatternRequest): Promise<void>
2525
3519
  }
2526
3520
 
2527
3521
  export declare class KvStoreApiClient {
@@ -2907,6 +3901,16 @@ export interface CreateWebhookFromTemplateParamsNode {
2907
3901
  */
2908
3902
  export declare function generatePaymentWallet(chain: string): any
2909
3903
 
3904
+ export interface GetTrafficSummaryResponse {
3905
+ data: TrafficSummaryData
3906
+ error?: string
3907
+ }
3908
+
3909
+ export interface GetUsageRpcSummaryResponse {
3910
+ data: UsageRpcSummaryData
3911
+ error?: string
3912
+ }
3913
+
2910
3914
  export interface ListStreamsResponseNode {
2911
3915
  data: Array<StreamNode>
2912
3916
  pageInfo: PageInfo
@@ -2989,6 +3993,25 @@ export interface TableSchemaNode {
2989
3993
  columns: Array<ColumnSchemaNode>
2990
3994
  }
2991
3995
 
3996
+ export interface TrafficSummaryData {
3997
+ from: string
3998
+ to: string
3999
+ totals: TrafficSummaryTotals
4000
+ breakdown?: Array<TrafficSummaryRow>
4001
+ nextCursor?: string
4002
+ }
4003
+
4004
+ export interface TrafficSummaryRow {
4005
+ successfulRequests: number | null
4006
+ bytes: number
4007
+ requestCredits: number
4008
+ bytesCredits: number
4009
+ credits: number
4010
+ activeMethods: number
4011
+ method?: string | undefined | null
4012
+ endpoint?: number | undefined | null
4013
+ }
4014
+
2992
4015
  export interface UpdateStreamParamsNode {
2993
4016
  name?: string
2994
4017
  region?: StreamRegion
@@ -3023,3 +4046,23 @@ export interface UpdateWebhookTemplateParamsNode {
3023
4046
  destinationAttributes?: WebhookDestinationAttributes
3024
4047
  templateArgs: any
3025
4048
  }
4049
+
4050
+ export interface UsageRpcSummaryData {
4051
+ from: string
4052
+ to: string
4053
+ totals: UsageRpcSummaryTotals
4054
+ breakdown?: Array<UsageRpcSummaryRow>
4055
+ nextCursor?: string
4056
+ }
4057
+
4058
+ export interface UsageRpcSummaryRow {
4059
+ requests: number | null
4060
+ bytes: number
4061
+ rpcCredits: number
4062
+ dataCredits: number
4063
+ credits: number
4064
+ method?: string | undefined | null
4065
+ endpoint?: number | undefined | null
4066
+ chain?: string | undefined | null
4067
+ network?: string | undefined | null
4068
+ }