@quicknode/sdk 3.1.0-alpha.15 → 3.1.0-alpha.26

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
@@ -1,109 +1,84 @@
1
- /* tslint:disable */
2
- /* eslint-disable */
3
-
4
1
  /* auto-generated by NAPI-RS */
5
-
6
- /** A single line item on an invoice. */
7
- export interface InvoiceLine {
8
- /** Human-readable description of the line item. */
9
- description: string
10
- /** Line item amount in the smallest currency unit. */
11
- amount: number
12
- }
13
- /** An invoice issued to the account. */
14
- export interface Invoice {
15
- /** Unique invoice identifier. */
16
- id: string
17
- /** Payment status (e.g. `paid`, `open`). */
18
- status: string
19
- /** Reason the invoice was generated (e.g. `subscription_cycle`). */
20
- billingReason: string
21
- /** Line items contributing to the invoice total. */
22
- lines: Array<InvoiceLine>
23
- /** Amount due in the smallest currency unit. */
24
- amountDue: number
25
- /** Amount already paid in the smallest currency unit. */
26
- amountPaid: number
27
- /** Start of the billing period (Unix timestamp). */
28
- periodStart: number
29
- /** End of the billing period (Unix timestamp). */
30
- periodEnd: number
31
- /** Timestamp when the invoice was created (Unix timestamp). */
32
- created: number
33
- /** Subtotal before taxes and adjustments. */
34
- subtotal: number
35
- }
36
- /** Response from `list_invoices`. */
37
- export interface ListInvoicesResponse {
38
- /** Invoice data payload. */
39
- data?: ListInvoicesData
40
- /** Error message when the request did not succeed. */
41
- error?: string
2
+ /* eslint-disable */
3
+ /** An account-level tag, shared across endpoints. */
4
+ export interface AccountTag {
5
+ /** Tag identifier. */
6
+ id: number
7
+ /** Tag label. */
8
+ label: string
9
+ /** Number of endpoints the tag is applied to. */
10
+ usageCount: number
42
11
  }
43
- /** Invoice list wrapper. */
44
- export interface ListInvoicesData {
45
- /** Invoices on the account. */
46
- invoices: Array<Invoice>
12
+
13
+ /** Parameters for `activate_webhook`. */
14
+ export interface ActivateWebhookParams {
15
+ /** Position to begin (or resume) delivery from. */
16
+ startFrom: WebhookStartFrom
47
17
  }
48
- /** A payment recorded on the account. */
49
- export interface Payment {
50
- /** Payment amount as a string in the account's currency. */
51
- amount: string
52
- /** Last four digits of the card used for the payment. */
53
- cardLast4?: string
54
- /** Timestamp when the payment was recorded. */
55
- createdAt: string
56
- /** Currency code (e.g. `usd`). */
57
- currency: string
58
- /** Payment status. */
59
- status: string
60
- /** Portion of the payment attributed to marketplace spending. */
61
- marketplaceAmount?: string
18
+
19
+ /** Parameters for `add_list_item`. */
20
+ export interface AddListItemParams {
21
+ /** Item to append to the list. */
22
+ item: string
62
23
  }
63
- /** Response from `list_payments`. */
64
- export interface ListPaymentsResponse {
65
- /** Payment data payload. */
66
- data?: ListPaymentsData
67
- /** Error message when the request did not succeed. */
68
- error?: string
24
+
25
+ /**
26
+ * Links a stream's filter to an address book so JSON paths resolve against its
27
+ * managed address set.
28
+ */
29
+ export interface AddressBookConfig {
30
+ /** Identifier of the address book to use. */
31
+ addressBookId: string
32
+ /** Optional JSON path that resolves to an object whose fields are matched against the book. */
33
+ objectsFilterPath?: string
34
+ /** JSON paths whose resolved values are matched against the book's addresses. */
35
+ elementsFilterPaths: Array<string>
69
36
  }
70
- /** Payment list wrapper. */
71
- export interface ListPaymentsData {
72
- /** Payments on the account. */
73
- payments: Array<Payment>
37
+
38
+ export interface AdminConfig {
39
+ baseUrl?: string
74
40
  }
75
- /** Parameters for `bulk_update_endpoint_status`. */
76
- export interface BulkUpdateEndpointStatusRequest {
77
- /** Endpoint ids to update. */
78
- ids: Array<string>
79
- /** Target status (`active` or `paused`). */
80
- status: string
41
+
42
+ /** Configuration for delivering stream batches to Azure Blob Storage. */
43
+ export interface AzureAttributes {
44
+ /** Azure storage account name. */
45
+ storageAccount: string
46
+ /** SAS token used to authorize writes. */
47
+ sasToken: string
48
+ /** Container that receives written blobs. */
49
+ container: string
50
+ /** Compression applied to written blobs (e.g. `none`, `gzip`). */
51
+ compression: string
52
+ /** File format/extension for written blobs (e.g. `.json`). */
53
+ fileType: string
54
+ /** Maximum number of retry attempts for a failed write. */
55
+ maxRetry: number
56
+ /** Seconds to wait between retry attempts. */
57
+ retryIntervalSec: number
58
+ /** Optional name prefix prepended to each written blob. */
59
+ blobPrefix?: string
81
60
  }
82
- /** Per-endpoint result within a bulk response. */
83
- export interface BulkOperationResult {
84
- /** Endpoint id the result refers to. */
85
- id: string
86
- /** Whether the operation succeeded for this endpoint. */
87
- success: boolean
61
+
62
+ /** Template arguments for a Bitcoin wallet filter. */
63
+ export interface BitcoinWalletFilterTemplate {
64
+ /** Bitcoin wallet addresses to match against. */
65
+ wallets: Array<string>
88
66
  }
89
- /** Summary data for a `bulk_update_endpoint_status` response. */
90
- export interface BulkUpdateEndpointStatusData {
67
+
68
+ /** Summary data for a `bulk_add_tag` response. */
69
+ export interface BulkAddTagData {
91
70
  /** Total number of endpoints processed. */
92
71
  total: number
93
- /** Number successfully updated. */
72
+ /** Number successfully tagged. */
94
73
  updatedCount: number
95
74
  /** Number that failed. */
96
75
  failedCount: number
97
76
  /** Per-endpoint outcomes. */
98
77
  results: Array<BulkOperationResult>
78
+ /** The tag that was applied. */
79
+ tag: BulkTag
99
80
  }
100
- /** Response from `bulk_update_endpoint_status`. */
101
- export interface BulkUpdateEndpointStatusResponse {
102
- /** Bulk update summary. */
103
- data?: BulkUpdateEndpointStatusData
104
- /** Error message when the request did not succeed. */
105
- error?: string
106
- }
81
+
107
82
  /** Parameters for `bulk_add_tag`. */
108
83
  export interface BulkAddTagRequest {
109
84
  /** Endpoint ids to tag. */
@@ -111,33 +86,35 @@ export interface BulkAddTagRequest {
111
86
  /** Label of the tag to apply (created if it doesn't exist). Maximum 25 characters. */
112
87
  label: string
113
88
  }
114
- /** Tag reference returned on bulk tag operations. */
115
- export interface BulkTag {
116
- /** Tag identifier. */
117
- tagId: number
118
- /** Tag label. */
119
- label: string
89
+
90
+ /** Response from `bulk_add_tag`. */
91
+ export interface BulkAddTagResponse {
92
+ /** Bulk add-tag summary. */
93
+ data?: BulkAddTagData
94
+ /** Error message when the request did not succeed. */
95
+ error?: string
120
96
  }
121
- /** Summary data for a `bulk_add_tag` response. */
122
- export interface BulkAddTagData {
97
+
98
+ /** Per-endpoint result within a bulk response. */
99
+ export interface BulkOperationResult {
100
+ /** Endpoint id the result refers to. */
101
+ id: string
102
+ /** Whether the operation succeeded for this endpoint. */
103
+ success: boolean
104
+ }
105
+
106
+ /** Summary data for a `bulk_remove_tag` response. */
107
+ export interface BulkRemoveTagData {
123
108
  /** Total number of endpoints processed. */
124
109
  total: number
125
- /** Number successfully tagged. */
110
+ /** Number successfully updated. */
126
111
  updatedCount: number
127
112
  /** Number that failed. */
128
113
  failedCount: number
129
114
  /** Per-endpoint outcomes. */
130
115
  results: Array<BulkOperationResult>
131
- /** The tag that was applied. */
132
- tag: BulkTag
133
- }
134
- /** Response from `bulk_add_tag`. */
135
- export interface BulkAddTagResponse {
136
- /** Bulk add-tag summary. */
137
- data?: BulkAddTagData
138
- /** Error message when the request did not succeed. */
139
- error?: string
140
116
  }
117
+
141
118
  /** Parameters for `bulk_remove_tag`. */
142
119
  export interface BulkRemoveTagRequest {
143
120
  /** Endpoint ids to untag. */
@@ -145,8 +122,33 @@ export interface BulkRemoveTagRequest {
145
122
  /** Tag to remove. */
146
123
  tagId: number
147
124
  }
148
- /** Summary data for a `bulk_remove_tag` response. */
149
- export interface BulkRemoveTagData {
125
+
126
+ /** Response from `bulk_remove_tag`. */
127
+ export interface BulkRemoveTagResponse {
128
+ /** Bulk remove-tag summary. */
129
+ data?: BulkRemoveTagData
130
+ /** Error message when the request did not succeed. */
131
+ error?: string
132
+ }
133
+
134
+ /** Parameters for `bulk_sets`. Either or both fields may be supplied. */
135
+ export interface BulkSetsParams {
136
+ /** Key/value pairs to add. */
137
+ addSets?: Record<string, string>
138
+ /** Keys to delete. */
139
+ deleteSets?: Array<string>
140
+ }
141
+
142
+ /** Tag reference returned on bulk tag operations. */
143
+ export interface BulkTag {
144
+ /** Tag identifier. */
145
+ tagId: number
146
+ /** Tag label. */
147
+ label: string
148
+ }
149
+
150
+ /** Summary data for a `bulk_update_endpoint_status` response. */
151
+ export interface BulkUpdateEndpointStatusData {
150
152
  /** Total number of endpoints processed. */
151
153
  total: number
152
154
  /** Number successfully updated. */
@@ -156,22 +158,23 @@ export interface BulkRemoveTagData {
156
158
  /** Per-endpoint outcomes. */
157
159
  results: Array<BulkOperationResult>
158
160
  }
159
- /** Response from `bulk_remove_tag`. */
160
- export interface BulkRemoveTagResponse {
161
- /** Bulk remove-tag summary. */
162
- data?: BulkRemoveTagData
161
+
162
+ /** Parameters for `bulk_update_endpoint_status`. */
163
+ export interface BulkUpdateEndpointStatusRequest {
164
+ /** Endpoint ids to update. */
165
+ ids: Array<string>
166
+ /** Target status (`active` or `paused`). */
167
+ status: string
168
+ }
169
+
170
+ /** Response from `bulk_update_endpoint_status`. */
171
+ export interface BulkUpdateEndpointStatusResponse {
172
+ /** Bulk update summary. */
173
+ data?: BulkUpdateEndpointStatusData
163
174
  /** Error message when the request did not succeed. */
164
175
  error?: string
165
176
  }
166
- /** A network within a supported chain. */
167
- export interface ChainNetwork {
168
- /** Network slug (e.g. `mainnet`). */
169
- slug: string
170
- /** Human-readable network name. */
171
- name: string
172
- /** Numeric chain id, when applicable. */
173
- chainId?: number
174
- }
177
+
175
178
  /** A blockchain supported by Quicknode along with its networks. */
176
179
  export interface Chain {
177
180
  /** Chain slug (e.g. `ethereum`). */
@@ -181,77 +184,71 @@ export interface Chain {
181
184
  /** Whether the chain is shown in selection UIs. */
182
185
  isSelectChain?: boolean
183
186
  }
184
- /** Response from `list_chains`. */
185
- export interface ListChainsResponse {
186
- /** Supported chains and their networks. */
187
- data: Array<Chain>
188
- /** Error message when the request did not succeed. */
189
- error?: string
190
- }
191
- /** Parameters for `get_endpoint_metrics`. */
192
- export interface GetEndpointMetricsRequest {
193
- /** Time period (`hour`, `day`, `week`, or `month`). */
194
- period: string
195
- /** Metric name (e.g. `method_calls_over_time`, `response_status_breakdown`). */
196
- metric: string
187
+
188
+ /** A network within a supported chain. */
189
+ export interface ChainNetwork {
190
+ /** Network slug (e.g. `mainnet`). */
191
+ slug: string
192
+ /** Human-readable network name. */
193
+ name: string
194
+ /** Numeric chain id, when applicable. */
195
+ chainId?: number
197
196
  }
198
- /** Parameters for `get_account_metrics`. */
199
- export interface GetAccountMetricsRequest {
200
- /** Time period (`hour`, `day`, `week`, or `month`). */
201
- period: string
202
- /** Metric name (e.g. `method_calls_over_time`, `credits_over_time`). */
203
- metric: string
204
- /** Optional percentile for latency metrics (e.g. `p50`, `p95`, `p99`). */
205
- percentile?: string
197
+
198
+ /** Per-chain usage row. */
199
+ export interface ChainUsage {
200
+ /** Chain name or slug. */
201
+ name: string
202
+ /** Credits consumed on the chain. */
203
+ creditsUsed: number
206
204
  }
207
- /** A single metric series, consisting of a descriptive tag and timestamped data points. */
208
- export interface EndpointMetric {
209
- /** Data points, each as `[timestamp, value]`. */
210
- data: Array<Array<number>>
211
- /** Human-readable tag identifying the series. */
212
- tag: string
205
+
206
+ /** Parameters for `create_domain_mask`. */
207
+ export interface CreateDomainMaskRequest {
208
+ /** Custom domain that will mask the endpoint's Quicknode URL. */
209
+ domainMask?: string
213
210
  }
214
- /** Response from `get_endpoint_metrics`. */
215
- export interface GetEndpointMetricsResponse {
216
- /** Metric series returned for the endpoint. */
217
- data: Array<EndpointMetric>
218
- /** Error message when the request did not succeed. */
219
- error?: string
211
+
212
+ /** Parameters for `create_endpoint`. */
213
+ export interface CreateEndpointRequest {
214
+ /** Blockchain the endpoint should serve (e.g. `ethereum`). */
215
+ chain?: string
216
+ /** Specific network within the chain (e.g. `mainnet`). */
217
+ network?: string
220
218
  }
221
- /** Response from `get_account_metrics`. */
222
- export interface GetAccountMetricsResponse {
223
- /** Metric series returned for the account. */
224
- data: Array<EndpointMetric>
219
+
220
+ /** Response from `create_endpoint`. */
221
+ export interface CreateEndpointResponse {
222
+ /** The newly created endpoint. */
223
+ data: SingleEndpoint
225
224
  /** Error message when the request did not succeed. */
226
225
  error?: string
227
226
  }
228
- /** A per-method rate limiter configured on an endpoint. */
229
- export interface MethodRateLimiter {
230
- /** Rate limiter identifier. */
231
- id: string
232
- /** Interval over which the rate applies (e.g. `second`, `minute`). */
233
- interval: string
234
- /** RPC methods the limiter applies to. */
235
- methods: Array<string>
236
- /** Maximum number of calls allowed per interval. */
237
- rate: number
238
- /** Whether the limiter is `enabled` or `disabled`. */
239
- status: string
240
- /** Creation timestamp. */
241
- created: string
227
+
228
+ /** Parameters for `create_ip`. */
229
+ export interface CreateIpRequest {
230
+ /** IP address to whitelist. */
231
+ ip?: string
242
232
  }
243
- /** Inner data for `get_method_rate_limits`. */
244
- export interface GetMethodRateLimitsData {
245
- /** Rate limiters configured on the endpoint. */
246
- rateLimiters: Array<MethodRateLimiter>
233
+
234
+ /** Parameters for `create_jwt`. */
235
+ export interface CreateJwtRequest {
236
+ /** Public key used to verify signed JWTs. */
237
+ publicKey?: string
238
+ /** Key identifier (`kid`) embedded in JWT headers. */
239
+ kid?: string
240
+ /** Human-readable name for the JWT configuration. */
241
+ name?: string
247
242
  }
248
- /** Response from `get_method_rate_limits`. */
249
- export interface GetMethodRateLimitsResponse {
250
- /** Rate limiters payload. */
251
- data?: GetMethodRateLimitsData
252
- /** Error message when the request did not succeed. */
253
- error?: string
243
+
244
+ /** Parameters for `create_list`. */
245
+ export interface CreateListParams {
246
+ /** Unique key identifying the list. */
247
+ key: string
248
+ /** Initial items inserted into the list. */
249
+ items: Array<string>
254
250
  }
251
+
255
252
  /** Parameters for `create_method_rate_limit`. */
256
253
  export interface CreateMethodRateLimitRequest {
257
254
  /** Interval over which the rate applies (e.g. `second`). */
@@ -261,6 +258,7 @@ export interface CreateMethodRateLimitRequest {
261
258
  /** Maximum number of calls allowed per interval. */
262
259
  rate: number
263
260
  }
261
+
264
262
  /** Response from `create_method_rate_limit`. */
265
263
  export interface CreateMethodRateLimitResponse {
266
264
  /** The created rate limiter. */
@@ -268,117 +266,39 @@ export interface CreateMethodRateLimitResponse {
268
266
  /** Error message when the request did not succeed. */
269
267
  error?: string
270
268
  }
271
- /** Parameters for `update_method_rate_limit`. Only provided fields are changed. */
272
- export interface UpdateMethodRateLimitRequest {
273
- /** New set of RPC methods the limiter applies to. */
274
- methods?: Array<string>
275
- /** New status (`enabled` or `disabled`). */
276
- status?: string
277
- /** New rate value. */
278
- rate?: number
279
- }
280
- /** Response from `update_method_rate_limit`. */
281
- export interface UpdateMethodRateLimitResponse {
282
- /** The updated rate limiter. */
283
- data?: MethodRateLimiter
284
- /** Error message when the request did not succeed. */
285
- error?: string
286
- }
287
- /** Endpoint-wide rate limit settings. */
288
- export interface RateLimitSettings {
289
- /** Requests per second. */
290
- rps?: number
291
- /** Requests per minute. */
292
- rpm?: number
293
- /** Requests per day. */
294
- rpd?: number
295
- }
296
- /** Parameters for `update_rate_limits`. */
297
- export interface UpdateRateLimitsRequest {
298
- /** Rate limit values to apply. */
299
- rateLimits: RateLimitSettings
300
- }
301
- /** A single security feature's name, status, and optional value. */
302
- export interface SecurityOption {
303
- /** Name of the security feature (e.g. `tokens`, `jwts`, `ips`). */
304
- option: string
305
- /** Whether the feature is `enabled` or `disabled`. */
306
- status: string
307
- /** Optional configuration value associated with the feature. */
308
- value?: string
309
- }
310
- /** Response from `get_security_options`. */
311
- export interface GetSecurityOptionsResponse {
312
- /** Security options on the endpoint. */
313
- data: Array<SecurityOption>
314
- /** Error message when the request did not succeed. */
315
- error?: string
316
- }
317
- /**
318
- * Per-feature toggles for `update_security_options`. Each field accepts
319
- * `enabled` or `disabled`.
320
- */
321
- export interface SecurityOptionsUpdate {
322
- /** Token authentication toggle. */
323
- tokens?: string
324
- /** Referrer validation toggle. */
325
- referrers?: string
326
- /** JWT validation toggle. */
327
- jwts?: string
328
- /** IP whitelist toggle. */
329
- ips?: string
330
- /** Domain masking toggle. */
331
- domainMasks?: string
332
- /** HSTS (HTTP Strict Transport Security) toggle. */
333
- hsts?: string
334
- /** CORS toggle. */
335
- cors?: string
336
- /** Request (method) filter toggle. */
337
- requestFilters?: string
338
- /** Custom IP header toggle. */
339
- ipCustomHeader?: string
340
- }
341
- /** Parameters for `update_security_options`. */
342
- export interface UpdateSecurityOptionsRequest {
343
- /** Security toggles to apply. */
344
- options: SecurityOptionsUpdate
269
+
270
+ /** Parameters for `create_or_update_ip_custom_header`. */
271
+ export interface CreateOrUpdateIpCustomHeaderRequest {
272
+ /** Header name used to identify the client IP (e.g. `X-Forwarded-For`). */
273
+ headerName: string
345
274
  }
346
- /** Response from `update_security_options`. */
347
- export interface UpdateSecurityOptionsResponse {
348
- /** Updated security options. */
349
- data: Array<SecurityOption>
275
+
276
+ /** Response from `create_or_update_ip_custom_header`. */
277
+ export interface CreateOrUpdateIpCustomHeaderResponse {
278
+ /** Stored header configuration. */
279
+ data?: IpCustomHeaderData
350
280
  /** Error message when the request did not succeed. */
351
281
  error?: string
352
282
  }
283
+
353
284
  /** Parameters for `create_referrer`. */
354
285
  export interface CreateReferrerRequest {
355
286
  /** Allowed referrer URL or domain. */
356
287
  referrer?: string
357
288
  }
358
- /** Parameters for `create_ip`. */
359
- export interface CreateIpRequest {
360
- /** IP address to whitelist. */
361
- ip?: string
362
- }
363
- /** Parameters for `create_domain_mask`. */
364
- export interface CreateDomainMaskRequest {
365
- /** Custom domain that will mask the endpoint's Quicknode URL. */
366
- domainMask?: string
367
- }
368
- /** Parameters for `create_jwt`. */
369
- export interface CreateJwtRequest {
370
- /** Public key used to verify signed JWTs. */
371
- publicKey?: string
372
- /** Key identifier (`kid`) embedded in JWT headers. */
373
- kid?: string
374
- /** Human-readable name for the JWT configuration. */
375
- name?: string
289
+
290
+ /** Data wrapper for a created request filter. */
291
+ export interface CreateRequestFilterData {
292
+ /** Identifier of the newly created request filter. */
293
+ id: string
376
294
  }
295
+
377
296
  /** Parameters for `create_request_filter`. */
378
297
  export interface CreateRequestFilterRequest {
379
298
  /** Whitelisted RPC methods; other methods will be blocked. */
380
299
  method?: Array<string>
381
300
  }
301
+
382
302
  /** Response from `create_request_filter`. */
383
303
  export interface CreateRequestFilterResponse {
384
304
  /** The created filter payload. */
@@ -386,33 +306,61 @@ export interface CreateRequestFilterResponse {
386
306
  /** Error message when the request did not succeed. */
387
307
  error?: string
388
308
  }
389
- /** Data wrapper for a created request filter. */
390
- export interface CreateRequestFilterData {
391
- /** Identifier of the newly created request filter. */
392
- id: string
309
+
310
+ /** Parameters for `create_set`. */
311
+ export interface CreateSetParams {
312
+ /** Unique key identifying the set. */
313
+ key: string
314
+ /** String value stored under the key. */
315
+ value: string
393
316
  }
394
- /** Parameters for `update_request_filter`. */
395
- export interface UpdateRequestFilterRequest {
396
- /** New set of whitelisted RPC methods. */
397
- method?: Array<string>
317
+
318
+ /** Parameters for `create_tag` (on a specific endpoint). */
319
+ export interface CreateTagRequest {
320
+ /** Label for the new tag. Maximum 25 characters. */
321
+ label?: string
398
322
  }
399
- /** Parameters for `create_or_update_ip_custom_header`. */
400
- export interface CreateOrUpdateIpCustomHeaderRequest {
401
- /** Header name used to identify the client IP (e.g. `X-Forwarded-For`). */
402
- headerName: string
323
+
324
+ /** Inner data for `create_team` responses. */
325
+ export interface CreateTeamData {
326
+ /** Team identifier. */
327
+ id: number
328
+ /** Team name. */
329
+ name: string
330
+ /** Default role for newly invited members. */
331
+ defaultRole?: string
332
+ /** Initial member count. */
333
+ membersCount?: number
403
334
  }
404
- /** Data wrapper for the IP custom header configuration. */
405
- export interface IpCustomHeaderData {
406
- /** Configured header name. */
407
- headerName: string
335
+
336
+ /** Parameters for `create_team`. */
337
+ export interface CreateTeamRequest {
338
+ /** Team name. */
339
+ name: string
408
340
  }
409
- /** Response from `create_or_update_ip_custom_header`. */
410
- export interface CreateOrUpdateIpCustomHeaderResponse {
411
- /** Stored header configuration. */
412
- data?: IpCustomHeaderData
341
+
342
+ /** Response from `create_team`. */
343
+ export interface CreateTeamResponse {
344
+ /** The newly created team. */
345
+ data?: CreateTeamData
346
+ /** Error message when the request did not succeed. */
347
+ error?: string
348
+ }
349
+
350
+ /** Inner data for `delete_account_tag`. */
351
+ export interface DeleteAccountTagData {
352
+ /** `true` when the tag was deleted. */
353
+ success: boolean
354
+ }
355
+
356
+ /** Response from `delete_account_tag`. */
357
+ export interface DeleteAccountTagResponse {
358
+ /** Deletion result. */
359
+ data?: DeleteAccountTagData
413
360
  /** Error message when the request did not succeed. */
414
361
  error?: string
415
362
  }
363
+
416
364
  /** Response wrapper for delete operations that return a boolean success flag. */
417
365
  export interface DeleteBoolResponse {
418
366
  /** `true` when the deletion succeeded. */
@@ -420,51 +368,27 @@ export interface DeleteBoolResponse {
420
368
  /** Error message when the request did not succeed. */
421
369
  error?: string
422
370
  }
423
- /** Parameters for `get_endpoints`. */
424
- export interface GetEndpointsRequest {
425
- /** Maximum number of endpoints returned. */
426
- limit?: number
427
- /** Starting index into the result set. */
428
- offset?: number
429
- /** Search by subdomain or label. */
430
- search?: string
431
- /** Field to sort results by. */
432
- sortBy?: string
433
- /** Sort direction (`asc` or `desc`). */
434
- sortDirection?: string
435
- /** Filter results to endpoints on these networks. */
436
- networks?: Array<string>
437
- /** Filter results to endpoints in these statuses. */
438
- statuses?: Array<string>
439
- /** Filter results by label. */
440
- labels?: Array<string>
441
- /** When true, return only dedicated endpoints. */
442
- dedicated?: boolean
443
- /** When true, return only flat-rate endpoints. */
444
- isFlatRate?: boolean
445
- /** Filter results by associated tag ids. */
446
- tagIds?: Array<number>
447
- /** Filter results by associated tag labels. */
448
- tagLabels?: Array<string>
371
+
372
+ /** Inner data for `delete_team` responses. */
373
+ export interface DeleteTeamData {
374
+ /** Human-readable confirmation message. */
375
+ message?: string
449
376
  }
450
- /** Response from `get_endpoints`. */
451
- export interface GetEndpointsResponse {
452
- /** Endpoints on the current page. */
453
- data: Array<Endpoint>
454
- /** Pagination metadata for the response. */
455
- pagination?: Pagination
377
+
378
+ /** Response from `delete_team`. */
379
+ export interface DeleteTeamResponse {
380
+ /** Deletion result payload. */
381
+ data?: DeleteTeamData
456
382
  /** Error message when the request did not succeed. */
457
383
  error?: string
458
384
  }
459
- /** Pagination metadata for admin list responses. */
460
- export interface Pagination {
461
- /** Total number of items matching the query across all pages. */
385
+
386
+ /** Result of `get_enabled_count`. */
387
+ export interface EnabledCountResponse {
388
+ /** Total count of currently enabled streams. */
462
389
  total: number
463
- /** Page size used for this response. */
464
- limit: number
465
- /** Starting index of this page within the full result set. */
466
- offset: number
467
390
  }
391
+
468
392
  /** Summary representation of an endpoint in list responses. */
469
393
  export interface Endpoint {
470
394
  /** Unique endpoint identifier. */
@@ -489,51 +413,78 @@ export interface Endpoint {
489
413
  wssUrl?: string
490
414
  /** Tags applied to the endpoint. */
491
415
  tags: Array<EndpointTag>
416
+ /** Whether the endpoint is configured to serve multiple chains/networks. */
417
+ isMultichain: boolean
492
418
  }
493
- /** Tag reference as returned on an endpoint. */
494
- export interface EndpointTag {
495
- /** Tag identifier. */
496
- tagId: number
497
- /** Tag label. */
498
- label: string
419
+
420
+ /** Domain mask configured on an endpoint. */
421
+ export interface EndpointDomainMask {
422
+ /** Domain mask identifier. */
423
+ id: string
424
+ /** Masking domain. */
425
+ domain: string
499
426
  }
500
- /** Parameters for `create_endpoint`. */
501
- export interface CreateEndpointRequest {
502
- /** Blockchain the endpoint should serve (e.g. `ethereum`). */
503
- chain?: string
504
- /** Specific network within the chain (e.g. `mainnet`). */
505
- network?: string
427
+
428
+ /** Whitelisted IP address on an endpoint. */
429
+ export interface EndpointIp {
430
+ /** IP entry identifier. */
431
+ id: string
432
+ /** Whitelisted IP address. */
433
+ ip: string
506
434
  }
507
- /** Response from `create_endpoint`. */
508
- export interface CreateEndpointResponse {
509
- /** The newly created endpoint. */
510
- data: SingleEndpoint
511
- /** Error message when the request did not succeed. */
512
- error?: string
435
+
436
+ /** Custom header option value for IP identification. */
437
+ export interface EndpointIpCustomHeaderOption {
438
+ /** Header name (e.g. `X-Forwarded-For`). */
439
+ value?: string
513
440
  }
514
- /** Full representation of a single endpoint, including its security and rate limits. */
515
- export interface SingleEndpoint {
516
- /** Unique endpoint identifier. */
441
+
442
+ /** JWT configured on an endpoint for signed-request authentication. */
443
+ export interface EndpointJwt {
444
+ /** JWT identifier. */
517
445
  id: string
518
- /** Human-readable label. */
519
- label?: string
520
- /** Current operational status. */
521
- status?: string
522
- /** Blockchain the endpoint serves. */
523
- chain: string
524
- /** Specific network within the chain. */
525
- network: string
526
- /** HTTP RPC URL. */
527
- httpUrl: string
528
- /** WebSocket RPC URL, when available. */
529
- wssUrl?: string
530
- /** Endpoint security configuration. */
531
- security?: EndpointSecurity
532
- /** Endpoint rate limits. */
533
- rateLimits?: EndpointRateLimits
534
- /** Tags applied to the endpoint. */
535
- tags: Array<EndpointTag>
446
+ /** Public key used to verify signed JWTs. */
447
+ publicKey: string
448
+ /** Key identifier (`kid`) embedded in JWT headers. */
449
+ kid: string
450
+ /** Human-readable name. */
451
+ name: string
452
+ }
453
+
454
+ /** A single endpoint log entry. */
455
+ export interface EndpointLog {
456
+ /** Time the request was received. */
457
+ timestamp: string
458
+ /** RPC method called (e.g. `eth_blockNumber`). */
459
+ method?: string
460
+ /** Network the request was routed to. */
461
+ network?: string
462
+ /** HTTP verb (e.g. `POST`). */
463
+ httpMethod?: string
464
+ /** Response HTTP status code. */
465
+ status?: number
466
+ /** JSON-RPC error code, when present. */
467
+ errorCode?: number
468
+ /** Request URL. */
469
+ url?: string
470
+ /** Request UUID used to fetch full log details. */
471
+ requestId?: string
472
+ /** Full payloads, included when requested. */
473
+ details?: LogDetails
474
+ }
475
+
476
+ /** A single metric series, consisting of a descriptive tag and timestamped data points. */
477
+ export interface EndpointMetric {
478
+ /** Data points, each as `[timestamp, value]`. */
479
+ data: Array<Array<number>>
480
+ /**
481
+ * Tag identifying the series. Single-axis metrics return a one-element
482
+ * vector (e.g. `["total"]`, `["p95"]`); multi-axis metrics return the
483
+ * key/value pair (e.g. `["network", "arbitrum-mainnet"]`).
484
+ */
485
+ tag: Array<string>
536
486
  }
487
+
537
488
  /** Rate limits applied to an endpoint. */
538
489
  export interface EndpointRateLimits {
539
490
  /** Whether rate limits are applied per client IP instead of per endpoint. */
@@ -547,6 +498,23 @@ export interface EndpointRateLimits {
547
498
  /** Requests per day. */
548
499
  rpd?: number
549
500
  }
501
+
502
+ /** Allowed referrer entry for request-origin validation. */
503
+ export interface EndpointReferrer {
504
+ /** Referrer entry identifier. */
505
+ id: string
506
+ /** Allowed referrer URL or domain. */
507
+ referrer?: string
508
+ }
509
+
510
+ /** Request (method) filter configured on an endpoint. */
511
+ export interface EndpointRequestFilter {
512
+ /** Filter identifier. */
513
+ id: string
514
+ /** Whitelisted RPC methods. */
515
+ method: Array<string>
516
+ }
517
+
550
518
  /**
551
519
  * Security configuration for an endpoint — the aggregate of tokens, JWTs,
552
520
  * referrers, domain masks, IPs, and request filters plus their enabled
@@ -568,6 +536,7 @@ export interface EndpointSecurity {
568
536
  /** Request (method) filters. */
569
537
  requestFilters?: Array<EndpointRequestFilter>
570
538
  }
539
+
571
540
  /** Boolean toggles controlling which security features are enabled. */
572
541
  export interface EndpointSecurityOptions {
573
542
  /** Whether token authentication is enforced. */
@@ -585,11 +554,15 @@ export interface EndpointSecurityOptions {
585
554
  /** Custom header used to identify the client IP. */
586
555
  ipCustomHeader?: EndpointIpCustomHeaderOption
587
556
  }
588
- /** Custom header option value for IP identification. */
589
- export interface EndpointIpCustomHeaderOption {
590
- /** Header name (e.g. `X-Forwarded-For`). */
591
- value?: string
557
+
558
+ /** Tag reference as returned on an endpoint. */
559
+ export interface EndpointTag {
560
+ /** Tag identifier. */
561
+ tagId: number
562
+ /** Tag label. */
563
+ label: string
592
564
  }
565
+
593
566
  /** Authentication token configured on an endpoint. */
594
567
  export interface EndpointToken {
595
568
  /** Token identifier. */
@@ -597,81 +570,91 @@ export interface EndpointToken {
597
570
  /** Token secret. */
598
571
  token: string
599
572
  }
600
- /** JWT configured on an endpoint for signed-request authentication. */
601
- export interface EndpointJwt {
602
- /** JWT identifier. */
603
- id: string
604
- /** Public key used to verify signed JWTs. */
605
- publicKey: string
606
- /** Key identifier (`kid`) embedded in JWT headers. */
607
- kid: string
608
- /** Human-readable name. */
609
- name: string
573
+
574
+ /** HTTP/WSS URL pair for a single network on a multichain endpoint. */
575
+ export interface EndpointUrl {
576
+ /** HTTP RPC URL. */
577
+ httpUrl: string
578
+ /** WebSocket RPC URL, when available. */
579
+ wssUrl?: string
610
580
  }
611
- /** Allowed referrer entry for request-origin validation. */
612
- export interface EndpointReferrer {
613
- /** Referrer entry identifier. */
614
- id: string
615
- /** Allowed referrer URL or domain. */
616
- referrer?: string
581
+
582
+ /** Per-endpoint usage row. */
583
+ export interface EndpointUsage {
584
+ /** Endpoint subdomain. */
585
+ name: string
586
+ /** Blockchain the endpoint serves. */
587
+ chain?: string
588
+ /** Network within the chain. */
589
+ network?: string
590
+ /** Operational status during the window. */
591
+ status?: string
592
+ /** Total credits consumed by this endpoint. */
593
+ creditsUsed: number
594
+ /** Human-readable label. */
595
+ label?: string
596
+ /** Per-method credit breakdown. */
597
+ methodsBreakdown: Array<MethodUsage>
598
+ /** Request count during the window. */
599
+ requests?: number
617
600
  }
618
- /** Domain mask configured on an endpoint. */
619
- export interface EndpointDomainMask {
620
- /** Domain mask identifier. */
621
- id: string
622
- /** Masking domain. */
623
- domain: string
624
- }
625
- /** Whitelisted IP address on an endpoint. */
626
- export interface EndpointIp {
627
- /** IP entry identifier. */
628
- id: string
629
- /** Whitelisted IP address. */
630
- ip: string
631
- }
632
- /** Request (method) filter configured on an endpoint. */
633
- export interface EndpointRequestFilter {
634
- /** Filter identifier. */
635
- id: string
636
- /** Whitelisted RPC methods. */
637
- method: Array<string>
638
- }
639
- /** Response from `show_endpoint`. */
640
- export interface ShowEndpointResponse {
641
- /** The endpoint, when found. */
642
- data?: SingleEndpoint
643
- /** Error message when the request did not succeed. */
644
- error?: string
601
+
602
+ /**
603
+ * Template arguments for an EVM ABI filter: decodes and filters events for a
604
+ * set of contracts using a provided ABI.
605
+ */
606
+ export interface EvmAbiFilterTemplate {
607
+ /** JSON-encoded contract ABI used to decode event data. */
608
+ abi: string
609
+ /** Contract addresses to watch for events. */
610
+ contracts: Array<string>
645
611
  }
646
- /** Parameters for `update_endpoint`. */
647
- export interface UpdateEndpointRequest {
648
- /** New human-readable label. */
649
- label?: string
612
+
613
+ /**
614
+ * Template arguments for filtering EVM contract events, optionally scoped to
615
+ * a specific set of event topic hashes.
616
+ */
617
+ export interface EvmContractEventsTemplate {
618
+ /** Contract addresses to watch for events. */
619
+ contracts: Array<string>
620
+ /** Optional list of event topic hashes to restrict the filter to specific events. */
621
+ eventHashes?: Array<string>
650
622
  }
651
- /** Parameters for `update_endpoint_status`. */
652
- export interface UpdateEndpointStatusRequest {
653
- /** New status (`active` or `paused`). */
654
- status: string
623
+
624
+ /**
625
+ * Template arguments for an EVM wallet filter: matches activity for a list of
626
+ * wallet addresses.
627
+ */
628
+ export interface EvmWalletFilterTemplate {
629
+ /** Wallet addresses to match against. */
630
+ wallets: Array<string>
655
631
  }
656
- /** Response from `update_endpoint_status`. */
657
- export interface UpdateEndpointStatusResponse {
658
- /** Confirmation string returned by the API. */
659
- data?: string
660
- /** Error message when the request did not succeed. */
661
- error?: string
632
+
633
+ /** Language a stream's filter function is written in. */
634
+ export declare const enum FilterLanguage {
635
+ Javascript = 'Javascript',
636
+ Go = 'Go',
637
+ Wasm = 'Wasm'
662
638
  }
663
- /** Parameters for `create_tag` (on a specific endpoint). */
664
- export interface CreateTagRequest {
665
- /** Label for the new tag. Maximum 25 characters. */
666
- label?: string
639
+
640
+ /** Parameters for `get_account_metrics`. */
641
+ export interface GetAccountMetricsRequest {
642
+ /** Time period (`hour`, `day`, `week`, or `month`). */
643
+ period: string
644
+ /** Metric name (e.g. `method_calls_over_time`, `credits_over_time`). */
645
+ metric: string
646
+ /** Optional percentile for latency metrics (e.g. `p50`, `p95`, `p99`). */
647
+ percentile?: string
667
648
  }
668
- /** Response from `get_endpoint_security`. */
669
- export interface GetEndpointSecurityResponse {
670
- /** The endpoint's security configuration. */
671
- data?: EndpointSecurity
649
+
650
+ /** Response from `get_account_metrics`. */
651
+ export interface GetAccountMetricsResponse {
652
+ /** Metric series returned for the account. */
653
+ data: Array<EndpointMetric>
672
654
  /** Error message when the request did not succeed. */
673
655
  error?: string
674
656
  }
657
+
675
658
  /** Parameters for `get_endpoint_logs`. */
676
659
  export interface GetEndpointLogsRequest {
677
660
  /** Start of the query window (timestamp). */
@@ -685,34 +668,7 @@ export interface GetEndpointLogsRequest {
685
668
  /** Cursor returned by a previous page; pass to fetch the next page. */
686
669
  nextAt?: string
687
670
  }
688
- /** Raw request/response payloads attached to a log entry. */
689
- export interface LogDetails {
690
- /** JSON-encoded request body (truncated at 2KB). */
691
- request?: string
692
- /** JSON-encoded response body (truncated at 2KB). */
693
- response?: string
694
- }
695
- /** A single endpoint log entry. */
696
- export interface EndpointLog {
697
- /** Time the request was received. */
698
- timestamp: string
699
- /** RPC method called (e.g. `eth_blockNumber`). */
700
- method?: string
701
- /** Network the request was routed to. */
702
- network?: string
703
- /** HTTP verb (e.g. `POST`). */
704
- httpMethod?: string
705
- /** Response HTTP status code. */
706
- status?: number
707
- /** JSON-RPC error code, when present. */
708
- errorCode?: number
709
- /** Request URL. */
710
- url?: string
711
- /** Request UUID used to fetch full log details. */
712
- requestId?: string
713
- /** Full payloads, included when requested. */
714
- details?: LogDetails
715
- }
671
+
716
672
  /** Response from `get_endpoint_logs`. */
717
673
  export interface GetEndpointLogsResponse {
718
674
  /** Log entries on the current page. */
@@ -720,225 +676,238 @@ export interface GetEndpointLogsResponse {
720
676
  /** Cursor for the next page; `None` when there are no more entries. */
721
677
  nextAt?: string
722
678
  }
723
- /** Response from `get_log_details`. */
724
- export interface GetLogDetailsResponse {
725
- /** Raw request and response payloads for the log entry. */
726
- data?: LogDetails
727
- }
728
- /** An account-level tag, shared across endpoints. */
729
- export interface AccountTag {
730
- /** Tag identifier. */
731
- id: number
732
- /** Tag label. */
733
- label: string
734
- /** Number of endpoints the tag is applied to. */
735
- usageCount: number
679
+
680
+ /** Parameters for `get_endpoint_metrics`. */
681
+ export interface GetEndpointMetricsRequest {
682
+ /** Time period (`hour`, `day`, `week`, or `month`). */
683
+ period: string
684
+ /** Metric name (e.g. `method_calls_over_time`, `response_status_breakdown`). */
685
+ metric: string
736
686
  }
737
- /** Inner data wrapper for `list_tags`. */
738
- export interface ListTagsData {
739
- /** Tags on the account. */
740
- tags: Array<AccountTag>
687
+
688
+ /** Response from `get_endpoint_metrics`. */
689
+ export interface GetEndpointMetricsResponse {
690
+ /** Metric series returned for the endpoint. */
691
+ data: Array<EndpointMetric>
692
+ /** Error message when the request did not succeed. */
693
+ error?: string
741
694
  }
742
- /** Response from `list_tags`. */
743
- export interface ListTagsResponse {
744
- /** Account tags payload. */
745
- data?: ListTagsData
695
+
696
+ /** Response from `get_endpoint_security`. */
697
+ export interface GetEndpointSecurityResponse {
698
+ /** The endpoint's security configuration. */
699
+ data?: EndpointSecurity
746
700
  /** Error message when the request did not succeed. */
747
701
  error?: string
748
702
  }
749
- /** Parameters for `rename_tag`. */
750
- export interface RenameTagRequest {
751
- /** New label for the tag. */
752
- label: string
703
+
704
+ /** Parameters for `get_endpoints`. */
705
+ export interface GetEndpointsRequest {
706
+ /** Maximum number of endpoints returned. */
707
+ limit?: number
708
+ /** Starting index into the result set. */
709
+ offset?: number
710
+ /** Search by subdomain or label. */
711
+ search?: string
712
+ /** Field to sort results by. */
713
+ sortBy?: string
714
+ /** Sort direction (`asc` or `desc`). */
715
+ sortDirection?: string
716
+ /** Filter results to endpoints on these networks. */
717
+ networks?: Array<string>
718
+ /** Filter results to endpoints in these statuses. */
719
+ statuses?: Array<string>
720
+ /** Filter results by label. */
721
+ labels?: Array<string>
722
+ /** When true, return only dedicated endpoints. */
723
+ dedicated?: boolean
724
+ /** When true, return only flat-rate endpoints. */
725
+ isFlatRate?: boolean
726
+ /** Filter results by associated tag ids. */
727
+ tagIds?: Array<number>
728
+ /** Filter results by associated tag labels. */
729
+ tagLabels?: Array<string>
753
730
  }
754
- /** Response from `rename_tag`. */
755
- export interface RenameTagResponse {
756
- /** The renamed tag. */
757
- data?: AccountTag
731
+
732
+ /** Response from `get_endpoints`. */
733
+ export interface GetEndpointsResponse {
734
+ /** Endpoints on the current page. */
735
+ data: Array<Endpoint>
736
+ /** Pagination metadata for the response. */
737
+ pagination?: Pagination
758
738
  /** Error message when the request did not succeed. */
759
739
  error?: string
760
740
  }
761
- /** Inner data for `delete_account_tag`. */
762
- export interface DeleteAccountTagData {
763
- /** `true` when the tag was deleted. */
764
- success: boolean
741
+
742
+ /**
743
+ * Inner data for `get_endpoint_urls` the http/wss URLs for the endpoint and,
744
+ * when the endpoint is multichain, a per-network map of additional URLs.
745
+ */
746
+ export interface GetEndpointUrlsData {
747
+ /** HTTP RPC URL. */
748
+ httpUrl: string
749
+ /** WebSocket RPC URL, when available. */
750
+ wssUrl?: string
751
+ /** Per-network URLs for multichain endpoints; `None` for single-chain endpoints. */
752
+ multichainUrls?: Record<string, EndpointUrl>
765
753
  }
766
- /** Response from `delete_account_tag`. */
767
- export interface DeleteAccountTagResponse {
768
- /** Deletion result. */
769
- data?: DeleteAccountTagData
754
+
755
+ /** Response from `get_endpoint_urls`. */
756
+ export interface GetEndpointUrlsResponse {
757
+ /** URLs for the endpoint. */
758
+ data?: GetEndpointUrlsData
770
759
  /** Error message when the request did not succeed. */
771
760
  error?: string
772
761
  }
773
- /** A team member or pending invitee. */
774
- export interface TeamUser {
775
- /** User identifier. */
776
- id: number
777
- /** Display name. */
778
- fullName?: string
779
- /** Email address. */
780
- email: string
781
- /** Team role (e.g. `admin`, `viewer`, `billing`). */
782
- role?: string
783
- /** Membership status (e.g. `active`, `pending`). */
784
- status?: string
785
- /** When the user was added. */
786
- createdAt?: string
787
- /** Profile photo URL. */
788
- photoUrl?: string
789
- /** Whether this user is the primary user on the account. */
790
- accountPrimaryUser?: boolean
762
+
763
+ /** Inner data for `get_list` responses. */
764
+ export interface GetListData {
765
+ /** Items in the list on the current page. */
766
+ items: Array<string>
791
767
  }
792
- /** Summary representation of a team in list responses. */
793
- export interface TeamSummary {
794
- /** Team identifier. */
795
- id: number
796
- /** Team name. */
797
- name: string
798
- /** Current member count. */
799
- membersCount?: number
800
- /** Active team members. */
801
- users: Array<TeamUser>
768
+
769
+ /** Parameters for `get_list`. */
770
+ export interface GetListParams {
771
+ /** Maximum number of items returned. */
772
+ limit?: number
773
+ /** Cursor returned by a previous page; pass to fetch the next page. */
774
+ cursor?: string
802
775
  }
803
- /** Full team detail including pending invites. */
804
- export interface TeamDetail {
805
- /** Team identifier. */
806
- id: number
807
- /** Team name. */
808
- name: string
809
- /** Default role assigned to newly invited members. */
810
- defaultRole?: string
811
- /** Current member count. */
812
- membersCount?: number
813
- /** Active team members. */
814
- users: Array<TeamUser>
815
- /** Invites that have not yet been accepted. */
816
- pendingInvites: Array<TeamUser>
776
+
777
+ /** Response from `get_list`. */
778
+ export interface GetListResponse {
779
+ /** Items for the list on the current page. */
780
+ data: GetListData
781
+ /** Cursor for the next page; empty string when there are no more pages. */
782
+ cursor: string
817
783
  }
818
- /** Response from `list_teams`. */
819
- export interface ListTeamsResponse {
820
- /** Teams on the account. */
821
- data: Array<TeamSummary>
822
- /** Error message when the request did not succeed. */
823
- error?: string
784
+
785
+ /** Inner data for `get_lists` responses. */
786
+ export interface GetListsData {
787
+ /** List keys on the current page. */
788
+ keys: Array<string>
824
789
  }
825
- /** Parameters for `create_team`. */
826
- export interface CreateTeamRequest {
827
- /** Team name. */
828
- name: string
790
+
791
+ /** Parameters for `get_lists`. */
792
+ export interface GetListsParams {
793
+ /** Maximum number of list keys returned. */
794
+ limit?: number
795
+ /** Cursor returned by a previous page; pass to fetch the next page. */
796
+ cursor?: string
829
797
  }
830
- /** Inner data for `create_team` responses. */
831
- export interface CreateTeamData {
832
- /** Team identifier. */
833
- id: number
834
- /** Team name. */
835
- name: string
836
- /** Default role for newly invited members. */
837
- defaultRole?: string
838
- /** Initial member count. */
839
- membersCount?: number
798
+
799
+ /** Response from `get_lists`. */
800
+ export interface GetListsResponse {
801
+ /** List keys on the current page. */
802
+ data: GetListsData
803
+ /** Cursor for the next page; empty string when there are no more pages. */
804
+ cursor: string
840
805
  }
841
- /** Response from `create_team`. */
842
- export interface CreateTeamResponse {
843
- /** The newly created team. */
844
- data?: CreateTeamData
845
- /** Error message when the request did not succeed. */
846
- error?: string
806
+
807
+ /** Response from `get_log_details`. */
808
+ export interface GetLogDetailsResponse {
809
+ /** Raw request and response payloads for the log entry. */
810
+ data?: LogDetails
847
811
  }
848
- /** Response from `get_team`. */
849
- export interface GetTeamResponse {
850
- /** The team's full detail. */
851
- data?: TeamDetail
812
+
813
+ /** Inner data for `get_method_rate_limits`. */
814
+ export interface GetMethodRateLimitsData {
815
+ /** Rate limiters configured on the endpoint. */
816
+ rateLimiters: Array<MethodRateLimiter>
817
+ }
818
+
819
+ /** Response from `get_method_rate_limits`. */
820
+ export interface GetMethodRateLimitsResponse {
821
+ /** Rate limiters payload. */
822
+ data?: GetMethodRateLimitsData
852
823
  /** Error message when the request did not succeed. */
853
824
  error?: string
854
825
  }
855
- /** Inner data for `delete_team` responses. */
856
- export interface DeleteTeamData {
857
- /** Human-readable confirmation message. */
858
- message?: string
826
+
827
+ /** Inner data for `get_rate_limits`. */
828
+ export interface GetRateLimitsData {
829
+ /** One row per enforced bucket. */
830
+ rateLimits: Array<RateLimitEntry>
859
831
  }
860
- /** Response from `delete_team`. */
861
- export interface DeleteTeamResponse {
862
- /** Deletion result payload. */
863
- data?: DeleteTeamData
832
+
833
+ /** Response from `get_rate_limits`. */
834
+ export interface GetRateLimitsResponse {
835
+ /** Rate-limit rows with their source. */
836
+ data?: GetRateLimitsData
864
837
  /** Error message when the request did not succeed. */
865
838
  error?: string
866
839
  }
867
- /** A team's endpoint association. */
868
- export interface TeamEndpoint {
869
- /** Endpoint identifier. */
870
- id: number
871
- /** Endpoint subdomain. */
872
- subdomain: string
873
- /** Blockchain the endpoint serves. */
874
- chain?: string
875
- /** Network within the chain. */
876
- network?: string
877
- }
878
- /** Response from `list_team_endpoints`. */
879
- export interface ListTeamEndpointsResponse {
880
- /** Endpoints accessible to the team. */
881
- data: Array<TeamEndpoint>
840
+
841
+ /** Response from `get_security_options`. */
842
+ export interface GetSecurityOptionsResponse {
843
+ /** Security options on the endpoint. */
844
+ data: Array<SecurityOption>
882
845
  /** Error message when the request did not succeed. */
883
846
  error?: string
884
847
  }
885
- /** Parameters for `update_team_endpoints`. */
886
- export interface UpdateTeamEndpointsRequest {
887
- /** Endpoint ids to associate with the team; pass an empty array to remove all. */
888
- endpointIds: Array<string>
848
+
849
+ /** Response from `get_set`. */
850
+ export interface GetSetResponse {
851
+ /** Stored string value. */
852
+ value: string
889
853
  }
890
- /** Inner data for `update_team_endpoints` responses. */
891
- export interface UpdateTeamEndpointsData {
892
- /** `true` when the association update succeeded. */
893
- success?: boolean
854
+
855
+ /** Parameters for `get_sets`. */
856
+ export interface GetSetsParams {
857
+ /** Maximum number of entries returned. */
858
+ limit?: number
859
+ /** Cursor returned by a previous page; pass to fetch the next page. */
860
+ cursor?: string
894
861
  }
895
- /** Response from `update_team_endpoints`. */
896
- export interface UpdateTeamEndpointsResponse {
897
- /** Update result. */
898
- data?: UpdateTeamEndpointsData
862
+
863
+ /** Response from `get_sets`. */
864
+ export interface GetSetsResponse {
865
+ /** Key/value entries on the current page. */
866
+ data: Array<KvSetEntry>
867
+ /** Cursor for the next page; empty string when there are no more pages. */
868
+ cursor: string
869
+ }
870
+
871
+ /** Response from `get_team`. */
872
+ export interface GetTeamResponse {
873
+ /** The team's full detail. */
874
+ data?: TeamDetail
899
875
  /** Error message when the request did not succeed. */
900
876
  error?: string
901
877
  }
902
- /** Parameters for `invite_team_member`. */
903
- export interface InviteTeamMemberRequest {
904
- /** Email address to invite. */
905
- email: string
906
- /** Full name (required for new users). */
907
- fullName?: string
908
- /** Team role (`admin`, `viewer`, or `billing`); required for new users. */
909
- role?: string
910
- }
911
- /** Response from `invite_team_member`. */
912
- export interface InviteTeamMemberResponse {
913
- /** The invited user and their invitation status. */
914
- data?: TeamUser
878
+
879
+ /** Response from `get_usage_by_chain`. */
880
+ export interface GetUsageByChainResponse {
881
+ /** Per-chain usage payload. */
882
+ data?: UsageByChainData
915
883
  /** Error message when the request did not succeed. */
916
884
  error?: string
917
885
  }
918
- /** Parameters for `remove_team_member`. */
919
- export interface RemoveTeamMemberRequest {
920
- /** When true, also delete the user entirely rather than just removing them from the team. */
921
- destroyUser?: boolean
922
- }
923
- /** Shared message-shaped data wrapper for team operations. */
924
- export interface TeamMessageData {
925
- /** Human-readable confirmation message. */
926
- message?: string
886
+
887
+ /** Response from `get_usage_by_endpoint`. */
888
+ export interface GetUsageByEndpointResponse {
889
+ /** Per-endpoint usage payload. */
890
+ data?: UsageByEndpointData
891
+ /** Error message when the request did not succeed. */
892
+ error?: string
927
893
  }
928
- /** Response from `remove_team_member`. */
929
- export interface RemoveTeamMemberResponse {
930
- /** Operation result message. */
931
- data?: TeamMessageData
894
+
895
+ /** Response from `get_usage_by_method`. */
896
+ export interface GetUsageByMethodResponse {
897
+ /** Per-method usage payload. */
898
+ data?: UsageByMethodData
932
899
  /** Error message when the request did not succeed. */
933
900
  error?: string
934
901
  }
935
- /** Response from `resend_team_invite`. */
936
- export interface ResendTeamInviteResponse {
937
- /** Operation result message. */
938
- data?: TeamMessageData
902
+
903
+ /** Response from `get_usage_by_tag`. */
904
+ export interface GetUsageByTagResponse {
905
+ /** Per-tag usage payload. */
906
+ data?: UsageByTagData
939
907
  /** Error message when the request did not succeed. */
940
908
  error?: string
941
909
  }
910
+
942
911
  /**
943
912
  * Parameters for the account usage methods (`get_usage`, `get_usage_by_*`).
944
913
  * Both bounds are optional; omit for account-to-date totals.
@@ -949,21 +918,7 @@ export interface GetUsageRequest {
949
918
  /** End of the query window (Unix timestamp). */
950
919
  endTime?: number
951
920
  }
952
- /** Aggregate account usage for a time window. */
953
- export interface UsageData {
954
- /** Credits consumed during the window. */
955
- creditsUsed: number
956
- /** Credits still available, when the plan has a finite limit. */
957
- creditsRemaining?: number
958
- /** Plan's credit limit, when applicable. */
959
- limit?: number
960
- /** Credits consumed beyond the plan limit. */
961
- overages?: number
962
- /** Start of the queried window. */
963
- startTime: number
964
- /** End of the queried window. */
965
- endTime: number
966
- }
921
+
967
922
  /** Response from `get_usage`. */
968
923
  export interface GetUsageResponse {
969
924
  /** Aggregate usage payload. */
@@ -971,254 +926,508 @@ export interface GetUsageResponse {
971
926
  /** Error message when the request did not succeed. */
972
927
  error?: string
973
928
  }
974
- /** Per-endpoint usage row. */
975
- export interface EndpointUsage {
976
- /** Endpoint subdomain. */
977
- name: string
978
- /** Blockchain the endpoint serves. */
979
- chain?: string
980
- /** Network within the chain. */
981
- network?: string
982
- /** Operational status during the window. */
983
- status?: string
984
- /** Total credits consumed by this endpoint. */
985
- creditsUsed: number
986
- /** Human-readable label. */
987
- label?: string
988
- /** Per-method credit breakdown. */
989
- methodsBreakdown: Array<MethodUsage>
990
- /** Request count during the window. */
991
- requests?: number
929
+
930
+ /** Parameters for `list_webhooks`. */
931
+ export interface GetWebhooksParams {
932
+ /** Maximum number of webhooks returned. */
933
+ limit?: number
934
+ /** Starting index into the result set. */
935
+ offset?: number
992
936
  }
993
- /** Per-method usage row. */
994
- export interface MethodUsage {
995
- /** RPC method name. */
996
- methodName: string
997
- /** Credits consumed by this method. */
998
- creditsUsed: number
999
- /** Whether the call required an archival node. */
1000
- archive?: boolean
1001
- /** Network the calls targeted. */
1002
- network?: string
1003
- /** Chain the calls targeted. */
1004
- chain?: string
937
+
938
+ export interface HttpConfig {
939
+ timeoutSecs?: number
940
+ poolMaxIdlePerHost?: number
1005
941
  }
1006
- /** Per-chain usage row. */
1007
- export interface ChainUsage {
1008
- /** Chain name or slug. */
1009
- name: string
1010
- /** Credits consumed on the chain. */
1011
- creditsUsed: number
942
+
943
+ /** Template arguments for a Hyperliquid wallet-events filter. */
944
+ export interface HyperliquidWalletEventsFilterTemplate {
945
+ /** Hyperliquid wallet addresses to match against. */
946
+ wallets: Array<string>
1012
947
  }
1013
- /** Inner data for `get_usage_by_endpoint`. */
1014
- export interface UsageByEndpointData {
1015
- /** Per-endpoint rows. */
1016
- endpoints: Array<EndpointUsage>
1017
- /** Start of the queried window. */
1018
- startTime?: number
1019
- /** End of the queried window. */
1020
- endTime?: number
948
+
949
+ /** Parameters for `invite_team_member`. */
950
+ export interface InviteTeamMemberRequest {
951
+ /** Email address to invite. */
952
+ email: string
953
+ /** Full name (required for new users). */
954
+ fullName?: string
955
+ /** Team role (`admin`, `viewer`, or `billing`); required for new users. */
956
+ role?: string
1021
957
  }
1022
- /** Response from `get_usage_by_endpoint`. */
1023
- export interface GetUsageByEndpointResponse {
1024
- /** Per-endpoint usage payload. */
1025
- data?: UsageByEndpointData
958
+
959
+ /** Response from `invite_team_member`. */
960
+ export interface InviteTeamMemberResponse {
961
+ /** The invited user and their invitation status. */
962
+ data?: TeamUser
1026
963
  /** Error message when the request did not succeed. */
1027
964
  error?: string
1028
965
  }
1029
- /** Inner data for `get_usage_by_method`. */
1030
- export interface UsageByMethodData {
1031
- /** Per-method rows. */
1032
- methods: Array<MethodUsage>
1033
- /** Start of the queried window. */
1034
- startTime?: number
1035
- /** End of the queried window. */
1036
- endTime?: number
966
+
967
+ /** An invoice issued to the account. */
968
+ export interface Invoice {
969
+ /** Unique invoice identifier. */
970
+ id: string
971
+ /** Payment status (e.g. `paid`, `open`). */
972
+ status: string
973
+ /** Reason the invoice was generated (e.g. `subscription_cycle`). */
974
+ billingReason: string
975
+ /** Line items contributing to the invoice total. */
976
+ lines: Array<InvoiceLine>
977
+ /** Amount due in the smallest currency unit. */
978
+ amountDue: number
979
+ /** Amount already paid in the smallest currency unit. */
980
+ amountPaid: number
981
+ /** Start of the billing period (Unix timestamp). */
982
+ periodStart: number
983
+ /** End of the billing period (Unix timestamp). */
984
+ periodEnd: number
985
+ /** Timestamp when the invoice was created (Unix timestamp). */
986
+ created: number
987
+ /** Subtotal before taxes and adjustments. */
988
+ subtotal: number
1037
989
  }
1038
- /** Response from `get_usage_by_method`. */
1039
- export interface GetUsageByMethodResponse {
1040
- /** Per-method usage payload. */
1041
- data?: UsageByMethodData
990
+
991
+ /** A single line item on an invoice. */
992
+ export interface InvoiceLine {
993
+ /** Human-readable description of the line item. */
994
+ description: string
995
+ /** Line item amount in the smallest currency unit. */
996
+ amount: number
997
+ }
998
+
999
+ /** Data wrapper for the IP custom header configuration. */
1000
+ export interface IpCustomHeaderData {
1001
+ /** Configured header name. */
1002
+ headerName: string
1003
+ }
1004
+
1005
+ /** Configuration for delivering stream batches to a Kafka topic. */
1006
+ export interface KafkaAttributes {
1007
+ /** Comma-separated list of Kafka broker addresses (host:port). */
1008
+ bootstrapServers: string
1009
+ /** Destination topic. */
1010
+ topicName: string
1011
+ /** Compression codec applied to produced messages (e.g. `none`, `gzip`). */
1012
+ compressionType: string
1013
+ /** Maximum number of messages grouped per produce request. */
1014
+ batchSize: number
1015
+ /** Milliseconds the producer waits to batch additional messages. */
1016
+ lingerMs: number
1017
+ /** Maximum size in bytes of a single Kafka message (`max_message_bytes`). */
1018
+ maxMessageBytes: number
1019
+ /** Request timeout in seconds. */
1020
+ timeoutSec: number
1021
+ /** Maximum number of retry attempts for a failed produce. */
1022
+ maxRetry: number
1023
+ /** Seconds to wait between retry attempts. */
1024
+ retryIntervalSec: number
1025
+ /** Optional SASL username. */
1026
+ username?: string
1027
+ /** Optional SASL password. */
1028
+ password?: string
1029
+ /** Optional security protocol (e.g. `SASL_SSL`). */
1030
+ protocol?: string
1031
+ /** Optional SASL mechanism (e.g. `PLAIN`, `SCRAM-SHA-256`). */
1032
+ mechanisms?: string
1033
+ }
1034
+
1035
+ /** A single key/value entry returned by `get_sets`. */
1036
+ export interface KvSetEntry {
1037
+ /** Key identifying the set. */
1038
+ key: string
1039
+ /** Stored string value. */
1040
+ value: string
1041
+ }
1042
+
1043
+ export interface KvStoreConfig {
1044
+ baseUrl?: string
1045
+ }
1046
+
1047
+ /** Response from `list_chains`. */
1048
+ export interface ListChainsResponse {
1049
+ /** Supported chains and their networks. */
1050
+ data: Array<Chain>
1042
1051
  /** Error message when the request did not succeed. */
1043
1052
  error?: string
1044
1053
  }
1045
- /** Inner data for `get_usage_by_chain`. */
1046
- export interface UsageByChainData {
1047
- /** Per-chain rows. */
1048
- chains: Array<ChainUsage>
1049
- /** Start of the queried window. */
1050
- startTime?: number
1051
- /** End of the queried window. */
1052
- endTime?: number
1054
+
1055
+ /** Response from `list_contains_item`. */
1056
+ export interface ListContainsItemResponse {
1057
+ /** `true` when the item is present in the list. */
1058
+ exists: boolean
1053
1059
  }
1054
- /** Response from `get_usage_by_chain`. */
1055
- export interface GetUsageByChainResponse {
1056
- /** Per-chain usage payload. */
1057
- data?: UsageByChainData
1060
+
1061
+ /** Invoice list wrapper. */
1062
+ export interface ListInvoicesData {
1063
+ /** Invoices on the account. */
1064
+ invoices: Array<Invoice>
1065
+ }
1066
+
1067
+ /** Response from `list_invoices`. */
1068
+ export interface ListInvoicesResponse {
1069
+ /** Invoice data payload. */
1070
+ data?: ListInvoicesData
1058
1071
  /** Error message when the request did not succeed. */
1059
1072
  error?: string
1060
1073
  }
1061
- /** Per-tag usage row. */
1062
- export interface TagUsage {
1063
- /** Tag identifier. */
1064
- tagId?: number
1065
- /** Tag label. */
1066
- label: string
1067
- /** Credits consumed by endpoints with this tag. */
1068
- creditsUsed: number
1069
- /** Request count during the window. */
1070
- requests: number
1074
+
1075
+ /** Payment list wrapper. */
1076
+ export interface ListPaymentsData {
1077
+ /** Payments on the account. */
1078
+ payments: Array<Payment>
1071
1079
  }
1072
- /** Inner data for `get_usage_by_tag`. */
1073
- export interface UsageByTagData {
1074
- /** Per-tag rows. */
1075
- tags: Array<TagUsage>
1076
- /** Start of the queried window. */
1077
- startTime?: number
1078
- /** End of the queried window. */
1079
- endTime?: number
1080
+
1081
+ /** Response from `list_payments`. */
1082
+ export interface ListPaymentsResponse {
1083
+ /** Payment data payload. */
1084
+ data?: ListPaymentsData
1085
+ /** Error message when the request did not succeed. */
1086
+ error?: string
1080
1087
  }
1081
- /** Response from `get_usage_by_tag`. */
1082
- export interface GetUsageByTagResponse {
1083
- /** Per-tag usage payload. */
1084
- data?: UsageByTagData
1088
+
1089
+ /** Parameters for `list_streams`. */
1090
+ export interface ListStreamsParams {
1091
+ /** Filter results by stream type. */
1092
+ streamType?: string
1093
+ /** Starting index into the result set; defaults to 0. */
1094
+ offset?: number
1095
+ /** Maximum number of streams returned. */
1096
+ limit?: number
1097
+ /** Field to sort results by. */
1098
+ orderBy?: string
1099
+ /** Sort direction (`asc` or `desc`). */
1100
+ orderDirection?: string
1101
+ }
1102
+
1103
+ /** Inner data wrapper for `list_tags`. */
1104
+ export interface ListTagsData {
1105
+ /** Tags on the account. */
1106
+ tags: Array<AccountTag>
1107
+ }
1108
+
1109
+ /** Response from `list_tags`. */
1110
+ export interface ListTagsResponse {
1111
+ /** Account tags payload. */
1112
+ data?: ListTagsData
1085
1113
  /** Error message when the request did not succeed. */
1086
1114
  error?: string
1087
1115
  }
1088
- export interface HttpConfig {
1089
- timeoutSecs?: number
1090
- poolMaxIdlePerHost?: number
1116
+
1117
+ /** Response from `list_team_endpoints`. */
1118
+ export interface ListTeamEndpointsResponse {
1119
+ /** Endpoints accessible to the team. */
1120
+ data: Array<TeamEndpoint>
1121
+ /** Error message when the request did not succeed. */
1122
+ error?: string
1091
1123
  }
1092
- export interface AdminConfig {
1093
- baseUrl?: string
1124
+
1125
+ /** Response from `list_teams`. */
1126
+ export interface ListTeamsResponse {
1127
+ /** Teams on the account. */
1128
+ data: Array<TeamSummary>
1129
+ /** Error message when the request did not succeed. */
1130
+ error?: string
1094
1131
  }
1095
- export interface StreamsConfig {
1096
- baseUrl?: string
1132
+
1133
+ /** Response from `list_webhooks`. */
1134
+ export interface ListWebhooksResponse {
1135
+ /** Webhooks on the current page. */
1136
+ data: Array<Webhook>
1137
+ /** Pagination metadata for the response. */
1138
+ pageInfo: WebhookPageInfo
1097
1139
  }
1098
- export interface WebhooksConfig {
1099
- baseUrl?: string
1140
+
1141
+ /** Raw request/response payloads attached to a log entry. */
1142
+ export interface LogDetails {
1143
+ /** JSON-encoded request body (truncated at 2KB). */
1144
+ request?: string
1145
+ /** JSON-encoded response body (truncated at 2KB). */
1146
+ response?: string
1100
1147
  }
1101
- export interface KvStoreConfig {
1102
- baseUrl?: string
1148
+
1149
+ /** A per-method rate limiter configured on an endpoint. */
1150
+ export interface MethodRateLimiter {
1151
+ /** Rate limiter identifier. */
1152
+ id: string
1153
+ /** Interval over which the rate applies (e.g. `second`, `minute`). */
1154
+ interval: string
1155
+ /** RPC methods the limiter applies to. */
1156
+ methods: Array<string>
1157
+ /** Maximum number of calls allowed per interval. */
1158
+ rate: number
1159
+ /** Whether the limiter is `enabled` or `disabled`. */
1160
+ status: string
1161
+ /** Creation timestamp. */
1162
+ created: string
1103
1163
  }
1104
- export interface SdkFullConfig {
1105
- apiKey: string
1106
- http?: HttpConfig
1107
- admin?: AdminConfig
1108
- streams?: StreamsConfig
1109
- webhooks?: WebhooksConfig
1110
- kvstore?: KvStoreConfig
1164
+
1165
+ /** Per-method usage row. */
1166
+ export interface MethodUsage {
1167
+ /** RPC method name. */
1168
+ methodName: string
1169
+ /** Credits consumed by this method. */
1170
+ creditsUsed: number
1171
+ /** Whether the call required an archival node. */
1172
+ archive?: boolean
1173
+ /** Network the calls targeted. */
1174
+ network?: string
1175
+ /** Chain the calls targeted. */
1176
+ chain?: string
1111
1177
  }
1112
- /** Parameters for `create_set`. */
1113
- export interface CreateSetParams {
1114
- /** Unique key identifying the set. */
1115
- key: string
1116
- /** String value stored under the key. */
1117
- value: string
1178
+
1179
+ /** Pagination metadata returned alongside a paginated result set. */
1180
+ export interface PageInfo {
1181
+ /** Page size used for this response. */
1182
+ limit: number
1183
+ /** Starting index of this page within the full result set. */
1184
+ offset: number
1185
+ /** Total number of items matching the query across all pages. */
1186
+ total: number
1118
1187
  }
1119
- /** Parameters for `get_sets`. */
1120
- export interface GetSetsParams {
1121
- /** Maximum number of entries returned. */
1122
- limit?: number
1123
- /** Cursor returned by a previous page; pass to fetch the next page. */
1124
- cursor?: string
1188
+
1189
+ /** Pagination metadata for admin list responses. */
1190
+ export interface Pagination {
1191
+ /** Total number of items matching the query across all pages. */
1192
+ total: number
1193
+ /** Page size used for this response. */
1194
+ limit: number
1195
+ /** Starting index of this page within the full result set. */
1196
+ offset: number
1125
1197
  }
1126
- /** Parameters for `bulk_sets`. Either or both fields may be supplied. */
1127
- export interface BulkSetsParams {
1128
- /** Key/value pairs to add. */
1129
- addSets?: Record<string, string>
1130
- /** Keys to delete. */
1131
- deleteSets?: Array<string>
1198
+
1199
+ /** A payment recorded on the account. */
1200
+ export interface Payment {
1201
+ /** Payment amount as a string in the account's currency. */
1202
+ amount: string
1203
+ /** Last four digits of the card used for the payment. */
1204
+ cardLast4?: string
1205
+ /** Timestamp when the payment was recorded. */
1206
+ createdAt: string
1207
+ /** Currency code (e.g. `usd`). */
1208
+ currency: string
1209
+ /** Payment status. */
1210
+ status: string
1211
+ /** Portion of the payment attributed to marketplace spending. */
1212
+ marketplaceAmount?: string
1132
1213
  }
1133
- /** Parameters for `create_list`. */
1134
- export interface CreateListParams {
1135
- /** Unique key identifying the list. */
1136
- key: string
1137
- /** Initial items inserted into the list. */
1138
- items: Array<string>
1214
+
1215
+ /** Configuration for delivering stream batches to a PostgreSQL database. */
1216
+ export interface PostgresAttributes {
1217
+ /** Database host. */
1218
+ host: string
1219
+ /** Database port. */
1220
+ port: number
1221
+ /** Database name. */
1222
+ database: string
1223
+ /** Username used to authenticate. */
1224
+ username: string
1225
+ /** Password used to authenticate. */
1226
+ password: string
1227
+ /** Destination table for inserted rows. */
1228
+ tableName: string
1229
+ /** Postgres SSL mode. The Quicknode API accepts only `disable` or `require`. */
1230
+ sslmode: string
1231
+ /** Maximum number of retry attempts for a failed write. */
1232
+ maxRetry: number
1233
+ /** Seconds to wait between retry attempts. */
1234
+ retryIntervalSec: number
1139
1235
  }
1140
- /** Parameters for `get_lists`. */
1141
- export interface GetListsParams {
1142
- /** Maximum number of list keys returned. */
1143
- limit?: number
1144
- /** Cursor returned by a previous page; pass to fetch the next page. */
1145
- cursor?: string
1236
+
1237
+ /** Billing product type the stream is associated with. */
1238
+ export declare const enum ProductType {
1239
+ Stream = 'Stream',
1240
+ Webhook = 'Webhook'
1146
1241
  }
1147
- /** Parameters for `get_list`. */
1148
- export interface GetListParams {
1149
- /** Maximum number of items returned. */
1150
- limit?: number
1151
- /** Cursor returned by a previous page; pass to fetch the next page. */
1152
- cursor?: string
1242
+
1243
+ /**
1244
+ * A single rate-limit row returned by `get_rate_limits`, identifying the
1245
+ * bucket (`rps`/`rpm`/`rpd`), the value enforced, and whether the value comes
1246
+ * from the plan default or a user-set override.
1247
+ */
1248
+ export interface RateLimitEntry {
1249
+ /** Which bucket this row applies to: `rps`, `rpm`, or `rpd`. */
1250
+ bucket: string
1251
+ /** The enforced value for this bucket. */
1252
+ rateLimit: number
1253
+ /** Where the value comes from: `plan_default` or `user_override`. */
1254
+ source: string
1255
+ /**
1256
+ * Row identifier. Present on `user_override` rows — pass it to
1257
+ * `delete_rate_limit_override` to remove the override. May be absent on
1258
+ * `plan_default` rows and cannot be deleted there.
1259
+ */
1260
+ id?: string
1153
1261
  }
1154
- /** Parameters for `update_list`. Either or both fields may be supplied. */
1155
- export interface UpdateListParams {
1156
- /** Items to add to the list. */
1157
- addItems?: Array<string>
1158
- /** Items to remove from the list. */
1159
- removeItems?: Array<string>
1262
+
1263
+ /** Endpoint-wide rate limit settings. */
1264
+ export interface RateLimitSettings {
1265
+ /** Requests per second. */
1266
+ rps?: number
1267
+ /** Requests per minute. */
1268
+ rpm?: number
1269
+ /** Requests per day. */
1270
+ rpd?: number
1160
1271
  }
1161
- /** Parameters for `add_list_item`. */
1162
- export interface AddListItemParams {
1163
- /** Item to append to the list. */
1164
- item: string
1272
+
1273
+ /** Parameters for `remove_team_member`. */
1274
+ export interface RemoveTeamMemberRequest {
1275
+ /** When true, also delete the user entirely rather than just removing them from the team. */
1276
+ destroyUser?: boolean
1165
1277
  }
1166
- /** A single key/value entry returned by `get_sets`. */
1167
- export interface KvSetEntry {
1168
- /** Key identifying the set. */
1169
- key: string
1170
- /** Stored string value. */
1171
- value: string
1278
+
1279
+ /** Response from `remove_team_member`. */
1280
+ export interface RemoveTeamMemberResponse {
1281
+ /** Operation result message. */
1282
+ data?: TeamMessageData
1283
+ /** Error message when the request did not succeed. */
1284
+ error?: string
1285
+ }
1286
+
1287
+ /** Parameters for `rename_tag`. */
1288
+ export interface RenameTagRequest {
1289
+ /** New label for the tag. */
1290
+ label: string
1291
+ }
1292
+
1293
+ /** Response from `rename_tag`. */
1294
+ export interface RenameTagResponse {
1295
+ /** The renamed tag. */
1296
+ data?: AccountTag
1297
+ /** Error message when the request did not succeed. */
1298
+ error?: string
1299
+ }
1300
+
1301
+ /** Response from `resend_team_invite`. */
1302
+ export interface ResendTeamInviteResponse {
1303
+ /** Operation result message. */
1304
+ data?: TeamMessageData
1305
+ /** Error message when the request did not succeed. */
1306
+ error?: string
1172
1307
  }
1173
- /** Response from `get_sets`. */
1174
- export interface GetSetsResponse {
1175
- /** Key/value entries on the current page. */
1176
- data: Array<KvSetEntry>
1177
- /** Cursor for the next page; empty string when there are no more pages. */
1178
- cursor: string
1308
+
1309
+ /** Configuration for delivering stream batches to an S3-compatible object store. */
1310
+ export interface S3Attributes {
1311
+ /** S3 service endpoint (e.g. `s3.amazonaws.com`). */
1312
+ endpoint: string
1313
+ /** Access key used to authenticate with the S3 endpoint. */
1314
+ accessKey: string
1315
+ /** Secret key used to authenticate with the S3 endpoint. */
1316
+ secretKey: string
1317
+ /** Target bucket name. */
1318
+ bucket: string
1319
+ /** Key prefix prepended to each written object. */
1320
+ objectPrefix: string
1321
+ /** Compression applied to written objects (e.g. `none`, `gzip`). */
1322
+ compression: string
1323
+ /** File format/extension for written objects (e.g. `.json`). */
1324
+ fileType: string
1325
+ /** Maximum number of retry attempts for a failed write. */
1326
+ maxRetry: number
1327
+ /** Seconds to wait between retry attempts. */
1328
+ retryIntervalSec: number
1329
+ /** Whether to use TLS when connecting to the endpoint. */
1330
+ useSsl?: boolean
1179
1331
  }
1180
- /** Response from `get_set`. */
1181
- export interface GetSetResponse {
1182
- /** Stored string value. */
1183
- value: string
1332
+
1333
+ export interface SdkFullConfig {
1334
+ apiKey: string
1335
+ http?: HttpConfig
1336
+ admin?: AdminConfig
1337
+ streams?: StreamsConfig
1338
+ webhooks?: WebhooksConfig
1339
+ kvstore?: KvStoreConfig
1184
1340
  }
1185
- /** Inner data for `get_lists` responses. */
1186
- export interface GetListsData {
1187
- /** List keys on the current page. */
1188
- keys: Array<string>
1341
+
1342
+ /** A single security feature's name, status, and optional value. */
1343
+ export interface SecurityOption {
1344
+ /** Name of the security feature (e.g. `tokens`, `jwts`, `ips`). */
1345
+ option: string
1346
+ /** Whether the feature is `enabled` or `disabled`. */
1347
+ status: string
1348
+ /** Optional configuration value associated with the feature. */
1349
+ value?: string
1189
1350
  }
1190
- /** Response from `get_lists`. */
1191
- export interface GetListsResponse {
1192
- /** List keys on the current page. */
1193
- data: GetListsData
1194
- /** Cursor for the next page; empty string when there are no more pages. */
1195
- cursor: string
1351
+
1352
+ /**
1353
+ * Per-feature toggles for `update_security_options`. Each field accepts
1354
+ * `enabled` or `disabled`.
1355
+ */
1356
+ export interface SecurityOptionsUpdate {
1357
+ /** Token authentication toggle. */
1358
+ tokens?: string
1359
+ /** Referrer validation toggle. */
1360
+ referrers?: string
1361
+ /** JWT validation toggle. */
1362
+ jwts?: string
1363
+ /** IP whitelist toggle. */
1364
+ ips?: string
1365
+ /** Domain masking toggle. */
1366
+ domainMasks?: string
1367
+ /** HSTS (HTTP Strict Transport Security) toggle. */
1368
+ hsts?: string
1369
+ /** CORS toggle. */
1370
+ cors?: string
1371
+ /** Request (method) filter toggle. */
1372
+ requestFilters?: string
1373
+ /** Custom IP header toggle. */
1374
+ ipCustomHeader?: string
1196
1375
  }
1197
- /** Inner data for `get_list` responses. */
1198
- export interface GetListData {
1199
- /** Items in the list on the current page. */
1200
- items: Array<string>
1376
+
1377
+ /** Response from `show_endpoint`. */
1378
+ export interface ShowEndpointResponse {
1379
+ /** The endpoint, when found. */
1380
+ data?: SingleEndpoint
1381
+ /** Error message when the request did not succeed. */
1382
+ error?: string
1201
1383
  }
1202
- /** Response from `get_list`. */
1203
- export interface GetListResponse {
1204
- /** Items for the list on the current page. */
1205
- data: GetListData
1206
- /** Cursor for the next page; empty string when there are no more pages. */
1207
- cursor: string
1384
+
1385
+ /** Full representation of a single endpoint, including its security and rate limits. */
1386
+ export interface SingleEndpoint {
1387
+ /** Unique endpoint identifier. */
1388
+ id: string
1389
+ /** Human-readable label. */
1390
+ label?: string
1391
+ /** Current operational status. */
1392
+ status?: string
1393
+ /** Blockchain the endpoint serves. */
1394
+ chain: string
1395
+ /** Specific network within the chain. */
1396
+ network: string
1397
+ /** HTTP RPC URL. */
1398
+ httpUrl: string
1399
+ /** WebSocket RPC URL, when available. */
1400
+ wssUrl?: string
1401
+ /** Endpoint security configuration. */
1402
+ security?: EndpointSecurity
1403
+ /** Endpoint rate limits. */
1404
+ rateLimits?: EndpointRateLimits
1405
+ /** Tags applied to the endpoint. */
1406
+ tags: Array<EndpointTag>
1407
+ /** Whether the endpoint is configured to serve multiple chains/networks. */
1408
+ isMultichain: boolean
1208
1409
  }
1209
- /** Response from `list_contains_item`. */
1210
- export interface ListContainsItemResponse {
1211
- /** `true` when the item is present in the list. */
1212
- exists: boolean
1410
+
1411
+ /**
1412
+ * Template arguments for a Solana wallet filter: matches activity for a list
1413
+ * of Solana account addresses.
1414
+ */
1415
+ export interface SolanaWalletFilterTemplate {
1416
+ /** Solana account addresses to match against. */
1417
+ accounts: Array<string>
1213
1418
  }
1214
- /** Geographic region where a stream runs. */
1215
- export const enum StreamRegion {
1216
- UsaEast = 'UsaEast',
1217
- EuropeCentral = 'EuropeCentral',
1218
- AsiaEast = 'AsiaEast'
1419
+
1420
+ /**
1421
+ * Template arguments for a Stellar wallet-transactions filter, matching
1422
+ * transactions where the given wallets are the source account.
1423
+ */
1424
+ export interface StellarWalletTransactionsFilterTemplate {
1425
+ /** Stellar wallet addresses to match against. */
1426
+ wallets: Array<string>
1219
1427
  }
1428
+
1220
1429
  /** Type of on-chain data a stream delivers (blocks, transactions, logs, etc.). */
1221
- export const enum StreamDataset {
1430
+ export declare const enum StreamDataset {
1222
1431
  Block = 'Block',
1223
1432
  BlockWithReceipts = 'BlockWithReceipts',
1224
1433
  Transactions = 'Transactions',
@@ -1238,180 +1447,121 @@ export const enum StreamDataset {
1238
1447
  Twap = 'Twap',
1239
1448
  WriterActions = 'WriterActions'
1240
1449
  }
1450
+
1241
1451
  /** Destination kind a stream delivers to (webhook, S3, Postgres, etc.). */
1242
- export const enum StreamDestination {
1452
+ export declare const enum StreamDestination {
1243
1453
  Webhook = 'Webhook',
1244
1454
  S3 = 'S3',
1245
1455
  Azure = 'Azure',
1246
1456
  Postgres = 'Postgres',
1247
1457
  Kafka = 'Kafka'
1248
1458
  }
1249
- /** Language a stream's filter function is written in. */
1250
- export const enum FilterLanguage {
1251
- Javascript = 'Javascript',
1252
- Go = 'Go',
1253
- Wasm = 'Wasm'
1254
- }
1459
+
1255
1460
  /** Where stream metadata is included in delivered payloads. */
1256
- export const enum StreamMetadataLocation {
1461
+ export declare const enum StreamMetadataLocation {
1257
1462
  Body = 'Body',
1258
1463
  Header = 'Header',
1259
1464
  None = 'None'
1260
1465
  }
1261
- /** Billing product type the stream is associated with. */
1262
- export const enum ProductType {
1263
- Stream = 'Stream',
1264
- Webhook = 'Webhook'
1466
+
1467
+ /** Geographic region where a stream runs. */
1468
+ export declare const enum StreamRegion {
1469
+ UsaEast = 'UsaEast',
1470
+ EuropeCentral = 'EuropeCentral',
1471
+ AsiaEast = 'AsiaEast'
1472
+ }
1473
+
1474
+ export interface StreamsConfig {
1475
+ baseUrl?: string
1265
1476
  }
1477
+
1266
1478
  /** Operational state of a stream. */
1267
- export const enum StreamStatus {
1479
+ export declare const enum StreamStatus {
1268
1480
  Active = 'Active',
1269
- Paused = 'Paused',
1270
- Terminated = 'Terminated',
1271
- Completed = 'Completed',
1272
- Blocked = 'Blocked'
1273
- }
1274
- /** Configuration for delivering stream batches to an HTTP webhook endpoint. */
1275
- export interface WebhookAttributes {
1276
- /** Destination URL that receives batched stream payloads. */
1277
- url: string
1278
- /** Maximum number of retry attempts for a failed delivery. Must be in the range 1–10. */
1279
- maxRetry: number
1280
- /** Seconds to wait between retry attempts. */
1281
- retryIntervalSec: number
1282
- /** Timeout in seconds for each POST request. */
1283
- postTimeoutSec: number
1284
- /** Optional token included with each request so the receiver can verify authenticity. When supplied, must be at least 32 bytes (256 bits). */
1285
- securityToken?: string
1286
- /** Compression applied to the payload (e.g. `none`, `gzip`). When omitted the server defaults to no compression. */
1287
- compression?: string
1288
- }
1289
- /** Configuration for delivering stream batches to an S3-compatible object store. */
1290
- export interface S3Attributes {
1291
- /** S3 service endpoint (e.g. `s3.amazonaws.com`). */
1292
- endpoint: string
1293
- /** Access key used to authenticate with the S3 endpoint. */
1294
- accessKey: string
1295
- /** Secret key used to authenticate with the S3 endpoint. */
1296
- secretKey: string
1297
- /** Target bucket name. */
1298
- bucket: string
1299
- /** Key prefix prepended to each written object. */
1300
- objectPrefix: string
1301
- /** Compression applied to written objects (e.g. `none`, `gzip`). */
1302
- compression: string
1303
- /** File format/extension for written objects (e.g. `.json`). */
1304
- fileType: string
1305
- /** Maximum number of retry attempts for a failed write. */
1306
- maxRetry: number
1307
- /** Seconds to wait between retry attempts. */
1308
- retryIntervalSec: number
1309
- /** Whether to use TLS when connecting to the endpoint. */
1310
- useSsl?: boolean
1311
- }
1312
- /** Configuration for delivering stream batches to Azure Blob Storage. */
1313
- export interface AzureAttributes {
1314
- /** Azure storage account name. */
1315
- storageAccount: string
1316
- /** SAS token used to authorize writes. */
1317
- sasToken: string
1318
- /** Container that receives written blobs. */
1319
- container: string
1320
- /** Compression applied to written blobs (e.g. `none`, `gzip`). */
1321
- compression: string
1322
- /** File format/extension for written blobs (e.g. `.json`). */
1323
- fileType: string
1324
- /** Maximum number of retry attempts for a failed write. */
1325
- maxRetry: number
1326
- /** Seconds to wait between retry attempts. */
1327
- retryIntervalSec: number
1328
- /** Optional name prefix prepended to each written blob. */
1329
- blobPrefix?: string
1330
- }
1331
- /** Configuration for delivering stream batches to a PostgreSQL database. */
1332
- export interface PostgresAttributes {
1333
- /** Database host. */
1334
- host: string
1335
- /** Database port. */
1336
- port: number
1337
- /** Database name. */
1338
- database: string
1339
- /** Username used to authenticate. */
1340
- username: string
1341
- /** Password used to authenticate. */
1342
- password: string
1343
- /** Destination table for inserted rows. */
1344
- tableName: string
1345
- /** Postgres SSL mode. The Quicknode API accepts only `disable` or `require`. */
1346
- sslmode: string
1347
- /** Maximum number of retry attempts for a failed write. */
1348
- maxRetry: number
1349
- /** Seconds to wait between retry attempts. */
1350
- retryIntervalSec: number
1481
+ Paused = 'Paused',
1482
+ Terminated = 'Terminated',
1483
+ Completed = 'Completed',
1484
+ Blocked = 'Blocked'
1351
1485
  }
1352
- /** Configuration for delivering stream batches to a Kafka topic. */
1353
- export interface KafkaAttributes {
1354
- /** Comma-separated list of Kafka broker addresses (host:port). */
1355
- bootstrapServers: string
1356
- /** Destination topic. */
1357
- topicName: string
1358
- /** Compression codec applied to produced messages (e.g. `none`, `gzip`). */
1359
- compressionType: string
1360
- /** Maximum number of messages grouped per produce request. */
1361
- batchSize: number
1362
- /** Milliseconds the producer waits to batch additional messages. */
1363
- lingerMs: number
1364
- /** Maximum size in bytes of a single Kafka message (`max_message_bytes`). */
1365
- maxMessageBytes: number
1366
- /** Request timeout in seconds. */
1367
- timeoutSec: number
1368
- /** Maximum number of retry attempts for a failed produce. */
1369
- maxRetry: number
1370
- /** Seconds to wait between retry attempts. */
1371
- retryIntervalSec: number
1372
- /** Optional SASL username. */
1373
- username?: string
1374
- /** Optional SASL password. */
1375
- password?: string
1376
- /** Optional security protocol (e.g. `SASL_SSL`). */
1377
- protocol?: string
1378
- /** Optional SASL mechanism (e.g. `PLAIN`, `SCRAM-SHA-256`). */
1379
- mechanisms?: string
1486
+
1487
+ /** Per-tag usage row. */
1488
+ export interface TagUsage {
1489
+ /** Tag identifier. */
1490
+ tagId?: number
1491
+ /** Tag label. */
1492
+ label: string
1493
+ /** Credits consumed by endpoints with this tag. */
1494
+ creditsUsed: number
1495
+ /** Request count during the window. */
1496
+ requests: number
1380
1497
  }
1381
- /**
1382
- * Links a stream's filter to an address book so JSON paths resolve against its
1383
- * managed address set.
1384
- */
1385
- export interface AddressBookConfig {
1386
- /** Identifier of the address book to use. */
1387
- addressBookId: string
1388
- /** Optional JSON path that resolves to an object whose fields are matched against the book. */
1389
- objectsFilterPath?: string
1390
- /** JSON paths whose resolved values are matched against the book's addresses. */
1391
- elementsFilterPaths: Array<string>
1498
+
1499
+ /** Full team detail including pending invites. */
1500
+ export interface TeamDetail {
1501
+ /** Team identifier. */
1502
+ id: number
1503
+ /** Team name. */
1504
+ name: string
1505
+ /** Default role assigned to newly invited members. */
1506
+ defaultRole?: string
1507
+ /** Current member count. */
1508
+ membersCount?: number
1509
+ /** Active team members. */
1510
+ users: Array<TeamUser>
1511
+ /** Invites that have not yet been accepted. */
1512
+ pendingInvites: Array<TeamUser>
1392
1513
  }
1393
- /** Pagination metadata returned alongside a paginated result set. */
1394
- export interface PageInfo {
1395
- /** Page size used for this response. */
1396
- limit: number
1397
- /** Starting index of this page within the full result set. */
1398
- offset: number
1399
- /** Total number of items matching the query across all pages. */
1400
- total: number
1514
+
1515
+ /** A team's endpoint association. */
1516
+ export interface TeamEndpoint {
1517
+ /** Endpoint identifier. */
1518
+ id: number
1519
+ /** Endpoint subdomain. */
1520
+ subdomain: string
1521
+ /** Blockchain the endpoint serves. */
1522
+ chain?: string
1523
+ /** Network within the chain. */
1524
+ network?: string
1401
1525
  }
1402
- /** Parameters for `list_streams`. */
1403
- export interface ListStreamsParams {
1404
- /** Filter results by stream type. */
1405
- streamType?: string
1406
- /** Starting index into the result set; defaults to 0. */
1407
- offset?: number
1408
- /** Maximum number of streams returned. */
1409
- limit?: number
1410
- /** Field to sort results by. */
1411
- orderBy?: string
1412
- /** Sort direction (`asc` or `desc`). */
1413
- orderDirection?: string
1526
+
1527
+ /** Shared message-shaped data wrapper for team operations. */
1528
+ export interface TeamMessageData {
1529
+ /** Human-readable confirmation message. */
1530
+ message?: string
1531
+ }
1532
+
1533
+ /** Summary representation of a team in list responses. */
1534
+ export interface TeamSummary {
1535
+ /** Team identifier. */
1536
+ id: number
1537
+ /** Team name. */
1538
+ name: string
1539
+ /** Current member count. */
1540
+ membersCount?: number
1541
+ /** Active team members. */
1542
+ users: Array<TeamUser>
1543
+ }
1544
+
1545
+ /** A team member or pending invitee. */
1546
+ export interface TeamUser {
1547
+ /** User identifier. */
1548
+ id: number
1549
+ /** Display name. */
1550
+ fullName?: string
1551
+ /** Email address. */
1552
+ email: string
1553
+ /** Team role (e.g. `admin`, `viewer`, `billing`). */
1554
+ role?: string
1555
+ /** Membership status (e.g. `active`, `pending`). */
1556
+ status?: string
1557
+ /** When the user was added. */
1558
+ createdAt?: string
1559
+ /** Profile photo URL. */
1560
+ photoUrl?: string
1561
+ /** Whether this user is the primary user on the account. */
1562
+ accountPrimaryUser?: boolean
1414
1563
  }
1564
+
1415
1565
  /** Parameters for `test_filter`. */
1416
1566
  export interface TestFilterParams {
1417
1567
  /** Blockchain network to run the test against (e.g. `ethereum-mainnet`). */
@@ -1420,13 +1570,14 @@ export interface TestFilterParams {
1420
1570
  dataset: StreamDataset
1421
1571
  /** Specific block number to feed into the filter for the test. */
1422
1572
  block: string
1423
- /** Base64-encoded filter function to evaluate. */
1424
- filterFunction?: string
1573
+ /** Base64-encoded filter function to evaluate. Required by the API. To inspect raw block data with no transformation, supply a base64-encoded identity function such as `function main(d){return d;}`. */
1574
+ filterFunction: string
1425
1575
  /** Language the filter function is written in. */
1426
1576
  filterLanguage?: FilterLanguage
1427
1577
  /** Address book linked to the filter, if any. */
1428
1578
  addressBookConfig?: AddressBookConfig
1429
1579
  }
1580
+
1430
1581
  /** Result of a `test_filter` call. */
1431
1582
  export interface TestFilterResponse {
1432
1583
  /** Filter output as a JSON string. Shape depends on the dataset and the user's filter function. */
@@ -1434,104 +1585,99 @@ export interface TestFilterResponse {
1434
1585
  /** Log lines emitted by the filter function during evaluation. */
1435
1586
  logs: Array<string>
1436
1587
  }
1437
- /** Result of `get_enabled_count`. */
1438
- export interface EnabledCountResponse {
1439
- /** Total count of currently enabled streams. */
1440
- total: number
1441
- }
1442
- /** Identifier of a predefined webhook filter template. */
1443
- export const enum WebhookTemplateId {
1444
- EvmWalletFilter = 'EvmWalletFilter',
1445
- EvmContractEvents = 'EvmContractEvents',
1446
- EvmAbiFilter = 'EvmAbiFilter',
1447
- SolanaWalletFilter = 'SolanaWalletFilter',
1448
- BitcoinWalletFilter = 'BitcoinWalletFilter',
1449
- XrplWalletFilter = 'XrplWalletFilter',
1450
- HyperliquidWalletEventsFilter = 'HyperliquidWalletEventsFilter',
1451
- StellarWalletTransactionsSourceAccountFilter = 'StellarWalletTransactionsSourceAccountFilter'
1588
+
1589
+ /** Parameters for `update_endpoint`. */
1590
+ export interface UpdateEndpointRequest {
1591
+ /** New human-readable label. */
1592
+ label?: string
1452
1593
  }
1453
- /** Position a webhook begins (or resumes) delivering from when activated. */
1454
- export const enum WebhookStartFrom {
1455
- /** Resume from the last-delivered block. */
1456
- Last = 'Last',
1457
- /** Start from the newest available block. */
1458
- Latest = 'Latest'
1594
+
1595
+ /** Parameters for `update_endpoint_status`. */
1596
+ export interface UpdateEndpointStatusRequest {
1597
+ /** New status (`active` or `paused`). */
1598
+ status: string
1459
1599
  }
1460
- /**
1461
- * Template arguments for an EVM wallet filter: matches activity for a list of
1462
- * wallet addresses.
1463
- */
1464
- export interface EvmWalletFilterTemplate {
1465
- /** Wallet addresses to match against. */
1466
- wallets: Array<string>
1600
+
1601
+ /** Response from `update_endpoint_status`. */
1602
+ export interface UpdateEndpointStatusResponse {
1603
+ /** Confirmation string returned by the API. */
1604
+ data?: string
1605
+ /** Error message when the request did not succeed. */
1606
+ error?: string
1467
1607
  }
1468
- /**
1469
- * Template arguments for filtering EVM contract events, optionally scoped to
1470
- * a specific set of event topic hashes.
1471
- */
1472
- export interface EvmContractEventsTemplate {
1473
- /** Contract addresses to watch for events. */
1474
- contracts: Array<string>
1475
- /** Optional list of event topic hashes to restrict the filter to specific events. */
1476
- eventHashes?: Array<string>
1608
+
1609
+ /** Parameters for `update_list`. Either or both fields may be supplied. */
1610
+ export interface UpdateListParams {
1611
+ /** Items to add to the list. */
1612
+ addItems?: Array<string>
1613
+ /** Items to remove from the list. */
1614
+ removeItems?: Array<string>
1477
1615
  }
1478
- /**
1479
- * Template arguments for an EVM ABI filter: decodes and filters events for a
1480
- * set of contracts using a provided ABI.
1481
- */
1482
- export interface EvmAbiFilterTemplate {
1483
- /** JSON-encoded contract ABI used to decode event data. */
1484
- abi: string
1485
- /** Contract addresses to watch for events. */
1486
- contracts: Array<string>
1616
+
1617
+ /** Parameters for `update_method_rate_limit`. Only provided fields are changed. */
1618
+ export interface UpdateMethodRateLimitRequest {
1619
+ /** New set of RPC methods the limiter applies to. */
1620
+ methods?: Array<string>
1621
+ /** New status (`enabled` or `disabled`). */
1622
+ status?: string
1623
+ /** New rate value. */
1624
+ rate?: number
1487
1625
  }
1488
- /**
1489
- * Template arguments for a Solana wallet filter: matches activity for a list
1490
- * of Solana account addresses.
1491
- */
1492
- export interface SolanaWalletFilterTemplate {
1493
- /** Solana account addresses to match against. */
1494
- accounts: Array<string>
1626
+
1627
+ /** Response from `update_method_rate_limit`. */
1628
+ export interface UpdateMethodRateLimitResponse {
1629
+ /** The updated rate limiter. */
1630
+ data?: MethodRateLimiter
1631
+ /** Error message when the request did not succeed. */
1632
+ error?: string
1495
1633
  }
1496
- /** Template arguments for a Bitcoin wallet filter. */
1497
- export interface BitcoinWalletFilterTemplate {
1498
- /** Bitcoin wallet addresses to match against. */
1499
- wallets: Array<string>
1634
+
1635
+ /** Parameters for `update_rate_limits`. */
1636
+ export interface UpdateRateLimitsRequest {
1637
+ /** Rate limit values to apply. */
1638
+ rateLimits: RateLimitSettings
1500
1639
  }
1501
- /** Template arguments for an XRPL wallet filter. */
1502
- export interface XrplWalletFilterTemplate {
1503
- /** XRPL wallet addresses to match against. */
1504
- wallets: Array<string>
1640
+
1641
+ /** Parameters for `update_request_filter`. */
1642
+ export interface UpdateRequestFilterRequest {
1643
+ /** New set of whitelisted RPC methods. */
1644
+ method?: Array<string>
1505
1645
  }
1506
- /** Template arguments for a Hyperliquid wallet-events filter. */
1507
- export interface HyperliquidWalletEventsFilterTemplate {
1508
- /** Hyperliquid wallet addresses to match against. */
1509
- wallets: Array<string>
1646
+
1647
+ /** Parameters for `update_security_options`. */
1648
+ export interface UpdateSecurityOptionsRequest {
1649
+ /** Security toggles to apply. */
1650
+ options: SecurityOptionsUpdate
1510
1651
  }
1511
- /**
1512
- * Template arguments for a Stellar wallet-transactions filter, matching
1513
- * transactions where the given wallets are the source account.
1514
- */
1515
- export interface StellarWalletTransactionsFilterTemplate {
1516
- /** Stellar wallet addresses to match against. */
1517
- wallets: Array<string>
1652
+
1653
+ /** Response from `update_security_options`. */
1654
+ export interface UpdateSecurityOptionsResponse {
1655
+ /** Updated security options. */
1656
+ data: Array<SecurityOption>
1657
+ /** Error message when the request did not succeed. */
1658
+ error?: string
1518
1659
  }
1519
- /** Destination configuration for a webhook. */
1520
- export interface WebhookDestinationAttributes {
1521
- /** Target URL that receives webhook payloads. */
1522
- url: string
1523
- /** Optional token sent with each payload so the receiver can verify authenticity; generated automatically when omitted. */
1524
- securityToken?: string
1525
- /** Optional payload compression (`gzip` or `none`). */
1526
- compression?: string
1660
+
1661
+ /** Inner data for `update_team_endpoints` responses. */
1662
+ export interface UpdateTeamEndpointsData {
1663
+ /** `true` when the association update succeeded. */
1664
+ success?: boolean
1527
1665
  }
1528
- /** Parameters for `list_webhooks`. */
1529
- export interface GetWebhooksParams {
1530
- /** Maximum number of webhooks returned. */
1531
- limit?: number
1532
- /** Starting index into the result set. */
1533
- offset?: number
1666
+
1667
+ /** Parameters for `update_team_endpoints`. */
1668
+ export interface UpdateTeamEndpointsRequest {
1669
+ /** Endpoint ids to associate with the team; pass an empty array to remove all. */
1670
+ endpointIds: Array<string>
1671
+ }
1672
+
1673
+ /** Response from `update_team_endpoints`. */
1674
+ export interface UpdateTeamEndpointsResponse {
1675
+ /** Update result. */
1676
+ data?: UpdateTeamEndpointsData
1677
+ /** Error message when the request did not succeed. */
1678
+ error?: string
1534
1679
  }
1680
+
1535
1681
  /**
1536
1682
  * Parameters for `update_webhook`. All fields are optional; only set fields
1537
1683
  * are modified.
@@ -1544,11 +1690,63 @@ export interface UpdateWebhookParams {
1544
1690
  /** New destination configuration. */
1545
1691
  destinationAttributes?: WebhookDestinationAttributes
1546
1692
  }
1547
- /** Parameters for `activate_webhook`. */
1548
- export interface ActivateWebhookParams {
1549
- /** Position to begin (or resume) delivery from. */
1550
- startFrom: WebhookStartFrom
1693
+
1694
+ /** Inner data for `get_usage_by_chain`. */
1695
+ export interface UsageByChainData {
1696
+ /** Per-chain rows. */
1697
+ chains: Array<ChainUsage>
1698
+ /** Start of the queried window. */
1699
+ startTime?: number
1700
+ /** End of the queried window. */
1701
+ endTime?: number
1702
+ }
1703
+
1704
+ /** Inner data for `get_usage_by_endpoint`. */
1705
+ export interface UsageByEndpointData {
1706
+ /** Per-endpoint rows. */
1707
+ endpoints: Array<EndpointUsage>
1708
+ /** Start of the queried window. */
1709
+ startTime?: number
1710
+ /** End of the queried window. */
1711
+ endTime?: number
1712
+ }
1713
+
1714
+ /** Inner data for `get_usage_by_method`. */
1715
+ export interface UsageByMethodData {
1716
+ /** Per-method rows. */
1717
+ methods: Array<MethodUsage>
1718
+ /** Start of the queried window. */
1719
+ startTime?: number
1720
+ /** End of the queried window. */
1721
+ endTime?: number
1722
+ }
1723
+
1724
+ /** Inner data for `get_usage_by_tag`. */
1725
+ export interface UsageByTagData {
1726
+ /** Per-tag rows. */
1727
+ tags: Array<TagUsage>
1728
+ /** Start of the queried window. */
1729
+ startTime?: number
1730
+ /** End of the queried window. */
1731
+ endTime?: number
1732
+ }
1733
+
1734
+ /** Aggregate account usage for a time window. */
1735
+ export interface UsageData {
1736
+ /** Credits consumed during the window. */
1737
+ creditsUsed: number
1738
+ /** Credits still available, when the plan has a finite limit. */
1739
+ creditsRemaining?: number
1740
+ /** Plan's credit limit, when applicable. */
1741
+ limit?: number
1742
+ /** Credits consumed beyond the plan limit. */
1743
+ overages?: number
1744
+ /** Start of the queried window. */
1745
+ startTime: number
1746
+ /** End of the queried window. */
1747
+ endTime: number
1551
1748
  }
1749
+
1552
1750
  /** A webhook's full configuration and current state. */
1553
1751
  export interface Webhook {
1554
1752
  /** Unique webhook identifier. */
@@ -1570,6 +1768,39 @@ export interface Webhook {
1570
1768
  /** Destination-specific configuration as a JSON string. */
1571
1769
  destinationAttributes?: string
1572
1770
  }
1771
+
1772
+ /** Configuration for delivering stream batches to an HTTP webhook endpoint. */
1773
+ export interface WebhookAttributes {
1774
+ /** Destination URL that receives batched stream payloads. */
1775
+ url: string
1776
+ /** Maximum number of retry attempts for a failed delivery. Must be in the range 1–10. */
1777
+ maxRetry: number
1778
+ /** Seconds to wait between retry attempts. */
1779
+ retryIntervalSec: number
1780
+ /** Timeout in seconds for each POST request. */
1781
+ postTimeoutSec: number
1782
+ /** Optional token included with each request so the receiver can verify authenticity. When supplied, must be at least 32 bytes (256 bits). */
1783
+ securityToken?: string
1784
+ /** Compression applied to the payload (e.g. `none`, `gzip`). When omitted the server defaults to no compression. */
1785
+ compression?: string
1786
+ }
1787
+
1788
+ /** Destination configuration for a webhook. */
1789
+ export interface WebhookDestinationAttributes {
1790
+ /** Target URL that receives webhook payloads. */
1791
+ url: string
1792
+ /** Optional token sent with each payload so the receiver can verify authenticity; generated automatically when omitted. */
1793
+ securityToken?: string
1794
+ /** Optional payload compression (`gzip` or `none`). */
1795
+ compression?: string
1796
+ }
1797
+
1798
+ /** Response from `get_enabled_count` for webhooks. */
1799
+ export interface WebhookEnabledCountResponse {
1800
+ /** Total count of enabled webhooks on the account. */
1801
+ total: number
1802
+ }
1803
+
1573
1804
  /** Pagination metadata returned alongside a paginated webhooks list. */
1574
1805
  export interface WebhookPageInfo {
1575
1806
  /** Page size used for this response. */
@@ -1579,136 +1810,35 @@ export interface WebhookPageInfo {
1579
1810
  /** Total number of webhooks matching the query across all pages. */
1580
1811
  total: number
1581
1812
  }
1582
- /** Response from `list_webhooks`. */
1583
- export interface ListWebhooksResponse {
1584
- /** Webhooks on the current page. */
1585
- data: Array<Webhook>
1586
- /** Pagination metadata for the response. */
1587
- pageInfo: WebhookPageInfo
1588
- }
1589
- /** Response from `get_enabled_count` for webhooks. */
1590
- export interface WebhookEnabledCountResponse {
1591
- /** Total count of enabled webhooks on the account. */
1592
- total: number
1593
- }
1594
- export interface CreateStreamParamsNode {
1595
- name: string
1596
- region: StreamRegion
1597
- network: string
1598
- dataset: StreamDataset
1599
- startRange: number
1600
- endRange: number
1601
- destinationAttributes: any
1602
- plan?: string
1603
- thresholdFetchBuffer?: number
1604
- datasetBatchSize: number
1605
- maxBatchSize?: number
1606
- maxBufferRangeSize?: number
1607
- maxBufferProcessingWorkers?: number
1608
- keepDistanceFromTip?: number
1609
- filterFunction?: string
1610
- filterLanguage?: FilterLanguage
1611
- addressBookConfig?: AddressBookConfig
1612
- includeStreamMetadata?: StreamMetadataLocation
1613
- productType?: ProductType
1614
- status?: StreamStatus
1615
- notificationEmail?: string
1616
- chargeMinCap?: number
1617
- fixBlockReorgs?: number
1618
- elasticBatchEnabled: boolean
1619
- extraDestinations?: Array<any>
1620
- }
1621
- export interface UpdateStreamParamsNode {
1622
- name?: string
1623
- region?: StreamRegion
1624
- network?: string
1625
- dataset?: StreamDataset
1626
- startRange?: number
1627
- endRange?: number
1628
- destinationAttributes?: any
1629
- plan?: string
1630
- thresholdFetchBuffer?: number
1631
- datasetBatchSize?: number
1632
- maxBatchSize?: number
1633
- maxBufferRangeSize?: number
1634
- maxBufferProcessingWorkers?: number
1635
- keepDistanceFromTip?: number
1636
- filterFunction?: string
1637
- filterLanguage?: FilterLanguage
1638
- addressBookConfig?: AddressBookConfig
1639
- includeStreamMetadata?: StreamMetadataLocation
1640
- notificationEmail?: string
1641
- chargeMinCap?: number
1642
- fixBlockReorgs?: number
1643
- elasticBatchEnabled?: boolean
1644
- status?: StreamStatus
1645
- memo?: string
1646
- extraDestinations?: Array<any>
1647
- }
1648
- export interface StreamNode {
1649
- id: string
1650
- name: string
1651
- status: string
1652
- createdAt: string
1653
- updatedAt: string
1654
- sequence: number
1655
- network: string
1656
- dataset: string
1657
- region: string
1658
- startRange: number
1659
- endRange: number
1660
- plan?: string
1661
- thresholdFetchBuffer?: number
1662
- datasetBatchSize?: number
1663
- maxBatchSize?: number
1664
- maxBufferRangeSize?: number
1665
- maxBufferProcessingWorkers?: number
1666
- keepDistanceFromTip?: number
1667
- filterFunction?: string
1668
- filterLanguage?: string
1669
- includeStreamMetadata?: string
1670
- productType?: string
1671
- notificationEmail?: string
1672
- fixBlockReorgs?: number
1673
- currentHash?: string
1674
- destinationAttributes?: any
1675
- elasticBatchEnabled?: boolean
1676
- qnAccountId?: string
1677
- chargeMinCap?: number
1678
- memo?: string
1679
- addressBookConfig?: AddressBookConfig
1680
- extraDestinations?: Array<any>
1681
- }
1682
- export interface ListStreamsResponseNode {
1683
- data: Array<StreamNode>
1684
- pageInfo: PageInfo
1813
+
1814
+ export interface WebhooksConfig {
1815
+ baseUrl?: string
1685
1816
  }
1686
- export interface CreateWebhookFromTemplateParamsNode {
1687
- name: string
1688
- network: string
1689
- notificationEmail?: string
1690
- destinationAttributes: WebhookDestinationAttributes
1691
- templateArgs: any
1817
+
1818
+ /** Position a webhook begins (or resumes) delivering from when activated. */
1819
+ export declare const enum WebhookStartFrom {
1820
+ /** Resume from the last-delivered block. */
1821
+ Last = 'Last',
1822
+ /** Start from the newest available block. */
1823
+ Latest = 'Latest'
1692
1824
  }
1693
- export interface UpdateWebhookTemplateParamsNode {
1694
- name?: string
1695
- notificationEmail?: string
1696
- destinationAttributes?: WebhookDestinationAttributes
1697
- templateArgs: any
1825
+
1826
+ /** Identifier of a predefined webhook filter template. */
1827
+ export declare const enum WebhookTemplateId {
1828
+ EvmWalletFilter = 'EvmWalletFilter',
1829
+ EvmContractEvents = 'EvmContractEvents',
1830
+ EvmAbiFilter = 'EvmAbiFilter',
1831
+ SolanaWalletFilter = 'SolanaWalletFilter',
1832
+ BitcoinWalletFilter = 'BitcoinWalletFilter',
1833
+ XrplWalletFilter = 'XrplWalletFilter',
1834
+ HyperliquidWalletEventsFilter = 'HyperliquidWalletEventsFilter',
1835
+ StellarWalletTransactionsSourceAccountFilter = 'StellarWalletTransactionsSourceAccountFilter'
1698
1836
  }
1699
- export declare class QuicknodeSdk {
1700
- /** Creates a new SDK instance from an explicit configuration. */
1701
- constructor(config: SdkFullConfig)
1702
- /** Returns the admin sub-client. */
1703
- get admin(): AdminApiClient
1704
- /** Returns the streams sub-client. */
1705
- get streams(): StreamsApiClient
1706
- /** Returns the webhooks sub-client. */
1707
- get webhooks(): WebhooksApiClient
1708
- /** Returns the kvstore sub-client. */
1709
- get kvstore(): KvStoreApiClient
1710
- /** Creates a new SDK instance using configuration from environment variables. */
1711
- static fromEnv(): QuicknodeSdk
1837
+
1838
+ /** Template arguments for an XRPL wallet filter. */
1839
+ export interface XrplWalletFilterTemplate {
1840
+ /** XRPL wallet addresses to match against. */
1841
+ wallets: Array<string>
1712
1842
  }
1713
1843
  export declare class AdminApiClient {
1714
1844
  /**
@@ -1882,11 +2012,32 @@ export declare class AdminApiClient {
1882
2012
  /** Removes a method rate limit from an endpoint by method rate limit id. */
1883
2013
  deleteMethodRateLimit(id: string, methodRateLimitId: string): Promise<void>
1884
2014
  /**
1885
- * Updates the overall rate limits on an endpoint. Accepts `rps`
1886
- * (requests per second), `rpm` (requests per minute), and `rpd` (requests
1887
- * per day).
2015
+ * Partial update of the endpoint-level rate-limit overrides. Accepts
2016
+ * `rps` (requests per second), `rpm` (requests per minute), and `rpd`
2017
+ * (requests per day). Only buckets included are modified — omitted
2018
+ * buckets are left unchanged. Values are capped by the account's plan
2019
+ * tier.
1888
2020
  */
1889
2021
  updateRateLimits(id: string, params: UpdateRateLimitsRequest): Promise<void>
2022
+ /**
2023
+ * Returns the endpoint-level rate limits currently enforced, with each
2024
+ * row identifying its bucket (`rps`/`rpm`/`rpd`), value, and source
2025
+ * (`plan_default` or `user_override`). User-set overrides expose an
2026
+ * `overrideId` that can be passed to `deleteRateLimitOverride`.
2027
+ */
2028
+ getRateLimits(id: string): Promise<GetRateLimitsResponse>
2029
+ /**
2030
+ * Deletes a user-set rate-limit override by its UUID. Plan defaults are
2031
+ * not deletable.
2032
+ */
2033
+ deleteRateLimitOverride(id: string, overrideId: string): Promise<void>
2034
+ /**
2035
+ * Returns the HTTP and WebSocket URLs for the endpoint without fetching
2036
+ * the full endpoint record. For multichain endpoints, `multichainUrls`
2037
+ * is a per-network mapping of additional URLs; for single-chain endpoints
2038
+ * it is `null`.
2039
+ */
2040
+ getEndpointUrls(id: string): Promise<GetEndpointUrlsResponse>
1890
2041
  /**
1891
2042
  * Returns time-series metrics for a specific endpoint. Requires a
1892
2043
  * `period` (`hour`, `day`, `week`, or `month`) and a metric type such as
@@ -2005,6 +2156,66 @@ export declare class AdminApiClient {
2005
2156
  */
2006
2157
  getEndpointSecurity(id: string): Promise<GetEndpointSecurityResponse>
2007
2158
  }
2159
+
2160
+ export declare class KvStoreApiClient {
2161
+ /** Creates a new set, storing a single string value under the given key. */
2162
+ createSet(params: CreateSetParams): Promise<void>
2163
+ /**
2164
+ * Returns a paginated page of key/value entries from the store. Use the
2165
+ * response `cursor` to fetch subsequent pages.
2166
+ */
2167
+ getSets(params?: GetSetsParams | undefined | null): Promise<GetSetsResponse>
2168
+ /** Returns the string value stored for a single set by key. */
2169
+ getSet(key: string): Promise<GetSetResponse>
2170
+ /**
2171
+ * Adds and removes multiple sets in a single request. Either `add_sets`,
2172
+ * `delete_sets`, or both may be supplied.
2173
+ */
2174
+ bulkSets(params: BulkSetsParams): Promise<void>
2175
+ /** Removes a single set by key. */
2176
+ deleteSet(key: string): Promise<void>
2177
+ /** Creates a new list under the given key, seeded with the provided items. */
2178
+ createList(params: CreateListParams): Promise<void>
2179
+ /**
2180
+ * Returns a paginated page of list keys from the store. Use the response
2181
+ * `cursor` to fetch subsequent pages.
2182
+ */
2183
+ getLists(params?: GetListsParams | undefined | null): Promise<GetListsResponse>
2184
+ /**
2185
+ * Returns a paginated page of items from the list identified by `key`.
2186
+ * Use the response `cursor` to fetch subsequent pages.
2187
+ */
2188
+ getList(key: string, params?: GetListParams | undefined | null): Promise<GetListResponse>
2189
+ /**
2190
+ * Updates an existing list by adding and/or removing items in a single
2191
+ * operation. Either `add_items`, `remove_items`, or both may be supplied.
2192
+ */
2193
+ updateList(key: string, params: UpdateListParams): Promise<void>
2194
+ /** Appends a single item to the list identified by `key`. */
2195
+ addListItem(key: string, params: AddListItemParams): Promise<void>
2196
+ /** Checks whether the specified list contains the given item. */
2197
+ listContainsItem(key: string, item: string): Promise<ListContainsItemResponse>
2198
+ /** Removes a specific item from the list identified by `key`. */
2199
+ deleteListItem(key: string, item: string): Promise<void>
2200
+ /** Removes a list and all of its items by key. */
2201
+ deleteList(key: string): Promise<void>
2202
+ }
2203
+
2204
+ export declare class QuicknodeSdk {
2205
+ /** Creates a new SDK instance from an explicit configuration. */
2206
+ constructor(config: SdkFullConfig)
2207
+ /** Returns the admin sub-client. */
2208
+ get admin(): AdminApiClient
2209
+ /** Returns the streams sub-client. */
2210
+ get streams(): StreamsApiClient
2211
+ /** Returns the webhooks sub-client. */
2212
+ get webhooks(): WebhooksApiClient
2213
+ /** Returns the kvstore sub-client. */
2214
+ get kvstore(): KvStoreApiClient
2215
+ /** Creates a new SDK instance using configuration from environment variables. */
2216
+ static fromEnv(): QuicknodeSdk
2217
+ }
2218
+
2008
2219
  export declare class StreamsApiClient {
2009
2220
  /**
2010
2221
  * Creates a new Stream on a given blockchain network and dataset, delivering
@@ -2060,6 +2271,7 @@ export declare class StreamsApiClient {
2060
2271
  */
2061
2272
  getEnabledCount(streamType?: string | undefined | null): Promise<EnabledCountResponse>
2062
2273
  }
2274
+
2063
2275
  export declare class WebhooksApiClient {
2064
2276
  /**
2065
2277
  * Returns a paginated list of webhooks on the account. Each entry includes
@@ -2127,46 +2339,114 @@ export declare class WebhooksApiClient {
2127
2339
  */
2128
2340
  updateWebhookTemplate(webhookId: string, params: UpdateWebhookTemplateParamsNode): Promise<Webhook>
2129
2341
  }
2130
- export declare class KvStoreApiClient {
2131
- /** Creates a new set, storing a single string value under the given key. */
2132
- createSet(params: CreateSetParams): Promise<void>
2133
- /**
2134
- * Returns a paginated page of key/value entries from the store. Use the
2135
- * response `cursor` to fetch subsequent pages.
2136
- */
2137
- getSets(params?: GetSetsParams | undefined | null): Promise<GetSetsResponse>
2138
- /** Returns the string value stored for a single set by key. */
2139
- getSet(key: string): Promise<GetSetResponse>
2140
- /**
2141
- * Adds and removes multiple sets in a single request. Either `add_sets`,
2142
- * `delete_sets`, or both may be supplied.
2143
- */
2144
- bulkSets(params: BulkSetsParams): Promise<void>
2145
- /** Removes a single set by key. */
2146
- deleteSet(key: string): Promise<void>
2147
- /** Creates a new list under the given key, seeded with the provided items. */
2148
- createList(params: CreateListParams): Promise<void>
2149
- /**
2150
- * Returns a paginated page of list keys from the store. Use the response
2151
- * `cursor` to fetch subsequent pages.
2152
- */
2153
- getLists(params?: GetListsParams | undefined | null): Promise<GetListsResponse>
2154
- /**
2155
- * Returns a paginated page of items from the list identified by `key`.
2156
- * Use the response `cursor` to fetch subsequent pages.
2157
- */
2158
- getList(key: string, params?: GetListParams | undefined | null): Promise<GetListResponse>
2159
- /**
2160
- * Updates an existing list by adding and/or removing items in a single
2161
- * operation. Either `add_items`, `remove_items`, or both may be supplied.
2162
- */
2163
- updateList(key: string, params: UpdateListParams): Promise<void>
2164
- /** Appends a single item to the list identified by `key`. */
2165
- addListItem(key: string, params: AddListItemParams): Promise<void>
2166
- /** Checks whether the specified list contains the given item. */
2167
- listContainsItem(key: string, item: string): Promise<ListContainsItemResponse>
2168
- /** Removes a specific item from the list identified by `key`. */
2169
- deleteListItem(key: string, item: string): Promise<void>
2170
- /** Removes a list and all of its items by key. */
2171
- deleteList(key: string): Promise<void>
2342
+
2343
+ export interface CreateStreamParamsNode {
2344
+ name: string
2345
+ region: StreamRegion
2346
+ network: string
2347
+ dataset: StreamDataset
2348
+ startRange: number
2349
+ endRange: number
2350
+ destinationAttributes: any
2351
+ plan?: string
2352
+ thresholdFetchBuffer?: number
2353
+ datasetBatchSize: number
2354
+ maxBatchSize?: number
2355
+ maxBufferRangeSize?: number
2356
+ maxBufferProcessingWorkers?: number
2357
+ keepDistanceFromTip?: number
2358
+ filterFunction?: string
2359
+ filterLanguage?: FilterLanguage
2360
+ addressBookConfig?: AddressBookConfig
2361
+ includeStreamMetadata?: StreamMetadataLocation
2362
+ productType?: ProductType
2363
+ status?: StreamStatus
2364
+ notificationEmail?: string
2365
+ chargeMinCap?: number
2366
+ fixBlockReorgs?: number
2367
+ elasticBatchEnabled: boolean
2368
+ extraDestinations?: Array<any>
2369
+ }
2370
+
2371
+ export interface CreateWebhookFromTemplateParamsNode {
2372
+ name: string
2373
+ network: string
2374
+ notificationEmail?: string
2375
+ destinationAttributes: WebhookDestinationAttributes
2376
+ templateArgs: any
2377
+ }
2378
+
2379
+ export interface ListStreamsResponseNode {
2380
+ data: Array<StreamNode>
2381
+ pageInfo: PageInfo
2382
+ }
2383
+
2384
+ export interface StreamNode {
2385
+ id: string
2386
+ name: string
2387
+ status: string
2388
+ createdAt: string
2389
+ updatedAt: string
2390
+ sequence: number
2391
+ network: string
2392
+ dataset: string
2393
+ region: string
2394
+ startRange: number
2395
+ endRange: number
2396
+ plan?: string
2397
+ thresholdFetchBuffer?: number
2398
+ datasetBatchSize?: number
2399
+ maxBatchSize?: number
2400
+ maxBufferRangeSize?: number
2401
+ maxBufferProcessingWorkers?: number
2402
+ keepDistanceFromTip?: number
2403
+ filterFunction?: string
2404
+ filterLanguage?: string
2405
+ includeStreamMetadata?: string
2406
+ productType?: string
2407
+ notificationEmail?: string
2408
+ fixBlockReorgs?: number
2409
+ currentHash?: string
2410
+ destinationAttributes?: any
2411
+ elasticBatchEnabled?: boolean
2412
+ qnAccountId?: string
2413
+ chargeMinCap?: number
2414
+ memo?: string
2415
+ addressBookConfig?: AddressBookConfig
2416
+ extraDestinations?: Array<any>
2417
+ }
2418
+
2419
+ export interface UpdateStreamParamsNode {
2420
+ name?: string
2421
+ region?: StreamRegion
2422
+ network?: string
2423
+ dataset?: StreamDataset
2424
+ startRange?: number
2425
+ endRange?: number
2426
+ destinationAttributes?: any
2427
+ plan?: string
2428
+ thresholdFetchBuffer?: number
2429
+ datasetBatchSize?: number
2430
+ maxBatchSize?: number
2431
+ maxBufferRangeSize?: number
2432
+ maxBufferProcessingWorkers?: number
2433
+ keepDistanceFromTip?: number
2434
+ filterFunction?: string
2435
+ filterLanguage?: FilterLanguage
2436
+ addressBookConfig?: AddressBookConfig
2437
+ includeStreamMetadata?: StreamMetadataLocation
2438
+ notificationEmail?: string
2439
+ chargeMinCap?: number
2440
+ fixBlockReorgs?: number
2441
+ elasticBatchEnabled?: boolean
2442
+ status?: StreamStatus
2443
+ memo?: string
2444
+ extraDestinations?: Array<any>
2445
+ }
2446
+
2447
+ export interface UpdateWebhookTemplateParamsNode {
2448
+ name?: string
2449
+ notificationEmail?: string
2450
+ destinationAttributes?: WebhookDestinationAttributes
2451
+ templateArgs: any
2172
2452
  }