@quicknode/sdk 3.1.0-alpha.17 → 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,81 +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
- /**
212
- * Tag identifying the series. Single-axis metrics return a one-element
213
- * vector (e.g. `["total"]`, `["p95"]`); multi-axis metrics return the
214
- * key/value pair (e.g. `["network", "arbitrum-mainnet"]`).
215
- */
216
- tag: Array<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
217
210
  }
218
- /** Response from `get_endpoint_metrics`. */
219
- export interface GetEndpointMetricsResponse {
220
- /** Metric series returned for the endpoint. */
221
- data: Array<EndpointMetric>
222
- /** Error message when the request did not succeed. */
223
- 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
224
218
  }
225
- /** Response from `get_account_metrics`. */
226
- export interface GetAccountMetricsResponse {
227
- /** Metric series returned for the account. */
228
- data: Array<EndpointMetric>
219
+
220
+ /** Response from `create_endpoint`. */
221
+ export interface CreateEndpointResponse {
222
+ /** The newly created endpoint. */
223
+ data: SingleEndpoint
229
224
  /** Error message when the request did not succeed. */
230
225
  error?: string
231
226
  }
232
- /** A per-method rate limiter configured on an endpoint. */
233
- export interface MethodRateLimiter {
234
- /** Rate limiter identifier. */
235
- id: string
236
- /** Interval over which the rate applies (e.g. `second`, `minute`). */
237
- interval: string
238
- /** RPC methods the limiter applies to. */
239
- methods: Array<string>
240
- /** Maximum number of calls allowed per interval. */
241
- rate: number
242
- /** Whether the limiter is `enabled` or `disabled`. */
243
- status: string
244
- /** Creation timestamp. */
245
- created: string
227
+
228
+ /** Parameters for `create_ip`. */
229
+ export interface CreateIpRequest {
230
+ /** IP address to whitelist. */
231
+ ip?: string
246
232
  }
247
- /** Inner data for `get_method_rate_limits`. */
248
- export interface GetMethodRateLimitsData {
249
- /** Rate limiters configured on the endpoint. */
250
- 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
251
242
  }
252
- /** Response from `get_method_rate_limits`. */
253
- export interface GetMethodRateLimitsResponse {
254
- /** Rate limiters payload. */
255
- data?: GetMethodRateLimitsData
256
- /** Error message when the request did not succeed. */
257
- 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>
258
250
  }
251
+
259
252
  /** Parameters for `create_method_rate_limit`. */
260
253
  export interface CreateMethodRateLimitRequest {
261
254
  /** Interval over which the rate applies (e.g. `second`). */
@@ -265,6 +258,7 @@ export interface CreateMethodRateLimitRequest {
265
258
  /** Maximum number of calls allowed per interval. */
266
259
  rate: number
267
260
  }
261
+
268
262
  /** Response from `create_method_rate_limit`. */
269
263
  export interface CreateMethodRateLimitResponse {
270
264
  /** The created rate limiter. */
@@ -272,182 +266,101 @@ export interface CreateMethodRateLimitResponse {
272
266
  /** Error message when the request did not succeed. */
273
267
  error?: string
274
268
  }
275
- /** Parameters for `update_method_rate_limit`. Only provided fields are changed. */
276
- export interface UpdateMethodRateLimitRequest {
277
- /** New set of RPC methods the limiter applies to. */
278
- methods?: Array<string>
279
- /** New status (`enabled` or `disabled`). */
280
- status?: string
281
- /** New rate value. */
282
- rate?: number
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
283
274
  }
284
- /** Response from `update_method_rate_limit`. */
285
- export interface UpdateMethodRateLimitResponse {
286
- /** The updated rate limiter. */
287
- data?: MethodRateLimiter
275
+
276
+ /** Response from `create_or_update_ip_custom_header`. */
277
+ export interface CreateOrUpdateIpCustomHeaderResponse {
278
+ /** Stored header configuration. */
279
+ data?: IpCustomHeaderData
288
280
  /** Error message when the request did not succeed. */
289
281
  error?: string
290
282
  }
291
- /** Endpoint-wide rate limit settings. */
292
- export interface RateLimitSettings {
293
- /** Requests per second. */
294
- rps?: number
295
- /** Requests per minute. */
296
- rpm?: number
297
- /** Requests per day. */
298
- rpd?: number
283
+
284
+ /** Parameters for `create_referrer`. */
285
+ export interface CreateReferrerRequest {
286
+ /** Allowed referrer URL or domain. */
287
+ referrer?: string
299
288
  }
300
- /** Parameters for `update_rate_limits`. */
301
- export interface UpdateRateLimitsRequest {
302
- /** Rate limit values to apply. */
303
- rateLimits: RateLimitSettings
289
+
290
+ /** Data wrapper for a created request filter. */
291
+ export interface CreateRequestFilterData {
292
+ /** Identifier of the newly created request filter. */
293
+ id: string
304
294
  }
305
- /**
306
- * A single rate-limit row returned by `get_rate_limits`, identifying the
307
- * bucket (`rps`/`rpm`/`rpd`), the value enforced, and whether the value comes
308
- * from the plan default or a user-set override.
309
- */
310
- export interface RateLimitEntry {
311
- /** Which bucket this row applies to: `rps`, `rpm`, or `rpd`. */
312
- bucket: string
313
- /** The enforced value for this bucket. */
314
- rateLimit: number
315
- /** Where the value comes from: `plan_default` or `user_override`. */
316
- source: string
317
- /**
318
- * Row identifier. Present on `user_override` rows — pass it to
319
- * `delete_rate_limit_override` to remove the override. May be absent on
320
- * `plan_default` rows and cannot be deleted there.
321
- */
322
- id?: string
295
+
296
+ /** Parameters for `create_request_filter`. */
297
+ export interface CreateRequestFilterRequest {
298
+ /** Whitelisted RPC methods; other methods will be blocked. */
299
+ method?: Array<string>
323
300
  }
324
- /** Inner data for `get_rate_limits`. */
325
- export interface GetRateLimitsData {
326
- /** One row per enforced bucket. */
327
- rateLimits: Array<RateLimitEntry>
301
+
302
+ /** Response from `create_request_filter`. */
303
+ export interface CreateRequestFilterResponse {
304
+ /** The created filter payload. */
305
+ data?: CreateRequestFilterData
306
+ /** Error message when the request did not succeed. */
307
+ error?: string
328
308
  }
329
- /** Response from `get_rate_limits`. */
330
- export interface GetRateLimitsResponse {
331
- /** Rate-limit rows with their source. */
332
- data?: GetRateLimitsData
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
316
+ }
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
322
+ }
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
334
+ }
335
+
336
+ /** Parameters for `create_team`. */
337
+ export interface CreateTeamRequest {
338
+ /** Team name. */
339
+ name: string
340
+ }
341
+
342
+ /** Response from `create_team`. */
343
+ export interface CreateTeamResponse {
344
+ /** The newly created team. */
345
+ data?: CreateTeamData
333
346
  /** Error message when the request did not succeed. */
334
347
  error?: string
335
348
  }
336
- /** A single security feature's name, status, and optional value. */
337
- export interface SecurityOption {
338
- /** Name of the security feature (e.g. `tokens`, `jwts`, `ips`). */
339
- option: string
340
- /** Whether the feature is `enabled` or `disabled`. */
341
- status: string
342
- /** Optional configuration value associated with the feature. */
343
- value?: string
349
+
350
+ /** Inner data for `delete_account_tag`. */
351
+ export interface DeleteAccountTagData {
352
+ /** `true` when the tag was deleted. */
353
+ success: boolean
344
354
  }
345
- /** Response from `get_security_options`. */
346
- export interface GetSecurityOptionsResponse {
347
- /** Security options on the endpoint. */
348
- data: Array<SecurityOption>
349
- /** Error message when the request did not succeed. */
350
- error?: string
351
- }
352
- /**
353
- * Per-feature toggles for `update_security_options`. Each field accepts
354
- * `enabled` or `disabled`.
355
- */
356
- export interface SecurityOptionsUpdate {
357
- /** Token authentication toggle. */
358
- tokens?: string
359
- /** Referrer validation toggle. */
360
- referrers?: string
361
- /** JWT validation toggle. */
362
- jwts?: string
363
- /** IP whitelist toggle. */
364
- ips?: string
365
- /** Domain masking toggle. */
366
- domainMasks?: string
367
- /** HSTS (HTTP Strict Transport Security) toggle. */
368
- hsts?: string
369
- /** CORS toggle. */
370
- cors?: string
371
- /** Request (method) filter toggle. */
372
- requestFilters?: string
373
- /** Custom IP header toggle. */
374
- ipCustomHeader?: string
375
- }
376
- /** Parameters for `update_security_options`. */
377
- export interface UpdateSecurityOptionsRequest {
378
- /** Security toggles to apply. */
379
- options: SecurityOptionsUpdate
380
- }
381
- /** Response from `update_security_options`. */
382
- export interface UpdateSecurityOptionsResponse {
383
- /** Updated security options. */
384
- data: Array<SecurityOption>
385
- /** Error message when the request did not succeed. */
386
- error?: string
387
- }
388
- /** Parameters for `create_referrer`. */
389
- export interface CreateReferrerRequest {
390
- /** Allowed referrer URL or domain. */
391
- referrer?: string
392
- }
393
- /** Parameters for `create_ip`. */
394
- export interface CreateIpRequest {
395
- /** IP address to whitelist. */
396
- ip?: string
397
- }
398
- /** Parameters for `create_domain_mask`. */
399
- export interface CreateDomainMaskRequest {
400
- /** Custom domain that will mask the endpoint's Quicknode URL. */
401
- domainMask?: string
402
- }
403
- /** Parameters for `create_jwt`. */
404
- export interface CreateJwtRequest {
405
- /** Public key used to verify signed JWTs. */
406
- publicKey?: string
407
- /** Key identifier (`kid`) embedded in JWT headers. */
408
- kid?: string
409
- /** Human-readable name for the JWT configuration. */
410
- name?: string
411
- }
412
- /** Parameters for `create_request_filter`. */
413
- export interface CreateRequestFilterRequest {
414
- /** Whitelisted RPC methods; other methods will be blocked. */
415
- method?: Array<string>
416
- }
417
- /** Response from `create_request_filter`. */
418
- export interface CreateRequestFilterResponse {
419
- /** The created filter payload. */
420
- data?: CreateRequestFilterData
421
- /** Error message when the request did not succeed. */
422
- error?: string
423
- }
424
- /** Data wrapper for a created request filter. */
425
- export interface CreateRequestFilterData {
426
- /** Identifier of the newly created request filter. */
427
- id: string
428
- }
429
- /** Parameters for `update_request_filter`. */
430
- export interface UpdateRequestFilterRequest {
431
- /** New set of whitelisted RPC methods. */
432
- method?: Array<string>
433
- }
434
- /** Parameters for `create_or_update_ip_custom_header`. */
435
- export interface CreateOrUpdateIpCustomHeaderRequest {
436
- /** Header name used to identify the client IP (e.g. `X-Forwarded-For`). */
437
- headerName: string
438
- }
439
- /** Data wrapper for the IP custom header configuration. */
440
- export interface IpCustomHeaderData {
441
- /** Configured header name. */
442
- headerName: string
443
- }
444
- /** Response from `create_or_update_ip_custom_header`. */
445
- export interface CreateOrUpdateIpCustomHeaderResponse {
446
- /** Stored header configuration. */
447
- data?: IpCustomHeaderData
355
+
356
+ /** Response from `delete_account_tag`. */
357
+ export interface DeleteAccountTagResponse {
358
+ /** Deletion result. */
359
+ data?: DeleteAccountTagData
448
360
  /** Error message when the request did not succeed. */
449
361
  error?: string
450
362
  }
363
+
451
364
  /** Response wrapper for delete operations that return a boolean success flag. */
452
365
  export interface DeleteBoolResponse {
453
366
  /** `true` when the deletion succeeded. */
@@ -455,77 +368,27 @@ export interface DeleteBoolResponse {
455
368
  /** Error message when the request did not succeed. */
456
369
  error?: string
457
370
  }
458
- /** HTTP/WSS URL pair for a single network on a multichain endpoint. */
459
- export interface EndpointUrl {
460
- /** HTTP RPC URL. */
461
- httpUrl: string
462
- /** WebSocket RPC URL, when available. */
463
- wssUrl?: string
464
- }
465
- /**
466
- * Inner data for `get_endpoint_urls` — the http/wss URLs for the endpoint and,
467
- * when the endpoint is multichain, a per-network map of additional URLs.
468
- */
469
- export interface GetEndpointUrlsData {
470
- /** HTTP RPC URL. */
471
- httpUrl: string
472
- /** WebSocket RPC URL, when available. */
473
- wssUrl?: string
474
- /** Per-network URLs for multichain endpoints; `None` for single-chain endpoints. */
475
- multichainUrls?: Record<string, EndpointUrl>
476
- }
477
- /** Response from `get_endpoint_urls`. */
478
- export interface GetEndpointUrlsResponse {
479
- /** URLs for the endpoint. */
480
- data?: GetEndpointUrlsData
481
- /** Error message when the request did not succeed. */
482
- error?: string
483
- }
484
- /** Parameters for `get_endpoints`. */
485
- export interface GetEndpointsRequest {
486
- /** Maximum number of endpoints returned. */
487
- limit?: number
488
- /** Starting index into the result set. */
489
- offset?: number
490
- /** Search by subdomain or label. */
491
- search?: string
492
- /** Field to sort results by. */
493
- sortBy?: string
494
- /** Sort direction (`asc` or `desc`). */
495
- sortDirection?: string
496
- /** Filter results to endpoints on these networks. */
497
- networks?: Array<string>
498
- /** Filter results to endpoints in these statuses. */
499
- statuses?: Array<string>
500
- /** Filter results by label. */
501
- labels?: Array<string>
502
- /** When true, return only dedicated endpoints. */
503
- dedicated?: boolean
504
- /** When true, return only flat-rate endpoints. */
505
- isFlatRate?: boolean
506
- /** Filter results by associated tag ids. */
507
- tagIds?: Array<number>
508
- /** Filter results by associated tag labels. */
509
- tagLabels?: Array<string>
371
+
372
+ /** Inner data for `delete_team` responses. */
373
+ export interface DeleteTeamData {
374
+ /** Human-readable confirmation message. */
375
+ message?: string
510
376
  }
511
- /** Response from `get_endpoints`. */
512
- export interface GetEndpointsResponse {
513
- /** Endpoints on the current page. */
514
- data: Array<Endpoint>
515
- /** Pagination metadata for the response. */
516
- pagination?: Pagination
377
+
378
+ /** Response from `delete_team`. */
379
+ export interface DeleteTeamResponse {
380
+ /** Deletion result payload. */
381
+ data?: DeleteTeamData
517
382
  /** Error message when the request did not succeed. */
518
383
  error?: string
519
384
  }
520
- /** Pagination metadata for admin list responses. */
521
- export interface Pagination {
522
- /** 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. */
523
389
  total: number
524
- /** Page size used for this response. */
525
- limit: number
526
- /** Starting index of this page within the full result set. */
527
- offset: number
528
390
  }
391
+
529
392
  /** Summary representation of an endpoint in list responses. */
530
393
  export interface Endpoint {
531
394
  /** Unique endpoint identifier. */
@@ -553,65 +416,105 @@ export interface Endpoint {
553
416
  /** Whether the endpoint is configured to serve multiple chains/networks. */
554
417
  isMultichain: boolean
555
418
  }
556
- /** Tag reference as returned on an endpoint. */
557
- export interface EndpointTag {
558
- /** Tag identifier. */
559
- tagId: number
560
- /** Tag label. */
561
- 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
562
426
  }
563
- /** Parameters for `create_endpoint`. */
564
- export interface CreateEndpointRequest {
565
- /** Blockchain the endpoint should serve (e.g. `ethereum`). */
566
- chain?: string
567
- /** Specific network within the chain (e.g. `mainnet`). */
568
- 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
569
434
  }
570
- /** Response from `create_endpoint`. */
571
- export interface CreateEndpointResponse {
572
- /** The newly created endpoint. */
573
- data: SingleEndpoint
574
- /** Error message when the request did not succeed. */
575
- 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
576
440
  }
577
- /** Full representation of a single endpoint, including its security and rate limits. */
578
- export interface SingleEndpoint {
579
- /** Unique endpoint identifier. */
441
+
442
+ /** JWT configured on an endpoint for signed-request authentication. */
443
+ export interface EndpointJwt {
444
+ /** JWT identifier. */
580
445
  id: string
581
- /** Human-readable label. */
582
- label?: string
583
- /** Current operational status. */
584
- status?: string
585
- /** Blockchain the endpoint serves. */
586
- chain: string
587
- /** Specific network within the chain. */
588
- network: string
589
- /** HTTP RPC URL. */
590
- httpUrl: string
591
- /** WebSocket RPC URL, when available. */
592
- wssUrl?: string
593
- /** Endpoint security configuration. */
594
- security?: EndpointSecurity
595
- /** Endpoint rate limits. */
596
- rateLimits?: EndpointRateLimits
597
- /** Tags applied to the endpoint. */
598
- tags: Array<EndpointTag>
599
- /** Whether the endpoint is configured to serve multiple chains/networks. */
600
- isMultichain: boolean
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
601
452
  }
602
- /** Rate limits applied to an endpoint. */
603
- export interface EndpointRateLimits {
604
- /** Whether rate limits are applied per client IP instead of per endpoint. */
605
- rateLimitByIp?: boolean
606
- /** Account-level rate limit, when applicable. */
607
- account?: number
608
- /** Requests per second. */
609
- rps?: number
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>
486
+ }
487
+
488
+ /** Rate limits applied to an endpoint. */
489
+ export interface EndpointRateLimits {
490
+ /** Whether rate limits are applied per client IP instead of per endpoint. */
491
+ rateLimitByIp?: boolean
492
+ /** Account-level rate limit, when applicable. */
493
+ account?: number
494
+ /** Requests per second. */
495
+ rps?: number
610
496
  /** Requests per minute. */
611
497
  rpm?: number
612
498
  /** Requests per day. */
613
499
  rpd?: number
614
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
+
615
518
  /**
616
519
  * Security configuration for an endpoint — the aggregate of tokens, JWTs,
617
520
  * referrers, domain masks, IPs, and request filters plus their enabled
@@ -633,6 +536,7 @@ export interface EndpointSecurity {
633
536
  /** Request (method) filters. */
634
537
  requestFilters?: Array<EndpointRequestFilter>
635
538
  }
539
+
636
540
  /** Boolean toggles controlling which security features are enabled. */
637
541
  export interface EndpointSecurityOptions {
638
542
  /** Whether token authentication is enforced. */
@@ -650,11 +554,15 @@ export interface EndpointSecurityOptions {
650
554
  /** Custom header used to identify the client IP. */
651
555
  ipCustomHeader?: EndpointIpCustomHeaderOption
652
556
  }
653
- /** Custom header option value for IP identification. */
654
- export interface EndpointIpCustomHeaderOption {
655
- /** Header name (e.g. `X-Forwarded-For`). */
656
- 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
657
564
  }
565
+
658
566
  /** Authentication token configured on an endpoint. */
659
567
  export interface EndpointToken {
660
568
  /** Token identifier. */
@@ -662,81 +570,91 @@ export interface EndpointToken {
662
570
  /** Token secret. */
663
571
  token: string
664
572
  }
665
- /** JWT configured on an endpoint for signed-request authentication. */
666
- export interface EndpointJwt {
667
- /** JWT identifier. */
668
- id: string
669
- /** Public key used to verify signed JWTs. */
670
- publicKey: string
671
- /** Key identifier (`kid`) embedded in JWT headers. */
672
- kid: string
673
- /** Human-readable name. */
674
- name: string
675
- }
676
- /** Allowed referrer entry for request-origin validation. */
677
- export interface EndpointReferrer {
678
- /** Referrer entry identifier. */
679
- id: string
680
- /** Allowed referrer URL or domain. */
681
- referrer?: string
682
- }
683
- /** Domain mask configured on an endpoint. */
684
- export interface EndpointDomainMask {
685
- /** Domain mask identifier. */
686
- id: string
687
- /** Masking domain. */
688
- domain: string
689
- }
690
- /** Whitelisted IP address on an endpoint. */
691
- export interface EndpointIp {
692
- /** IP entry identifier. */
693
- id: string
694
- /** Whitelisted IP address. */
695
- ip: 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
696
580
  }
697
- /** Request (method) filter configured on an endpoint. */
698
- export interface EndpointRequestFilter {
699
- /** Filter identifier. */
700
- id: string
701
- /** Whitelisted RPC methods. */
702
- method: Array<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
703
600
  }
704
- /** Response from `show_endpoint`. */
705
- export interface ShowEndpointResponse {
706
- /** The endpoint, when found. */
707
- data?: SingleEndpoint
708
- /** Error message when the request did not succeed. */
709
- 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>
710
611
  }
711
- /** Parameters for `update_endpoint`. */
712
- export interface UpdateEndpointRequest {
713
- /** New human-readable label. */
714
- 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>
715
622
  }
716
- /** Parameters for `update_endpoint_status`. */
717
- export interface UpdateEndpointStatusRequest {
718
- /** New status (`active` or `paused`). */
719
- 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>
720
631
  }
721
- /** Response from `update_endpoint_status`. */
722
- export interface UpdateEndpointStatusResponse {
723
- /** Confirmation string returned by the API. */
724
- data?: string
725
- /** Error message when the request did not succeed. */
726
- 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'
727
638
  }
728
- /** Parameters for `create_tag` (on a specific endpoint). */
729
- export interface CreateTagRequest {
730
- /** Label for the new tag. Maximum 25 characters. */
731
- 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
732
648
  }
733
- /** Response from `get_endpoint_security`. */
734
- export interface GetEndpointSecurityResponse {
735
- /** The endpoint's security configuration. */
736
- data?: EndpointSecurity
649
+
650
+ /** Response from `get_account_metrics`. */
651
+ export interface GetAccountMetricsResponse {
652
+ /** Metric series returned for the account. */
653
+ data: Array<EndpointMetric>
737
654
  /** Error message when the request did not succeed. */
738
655
  error?: string
739
656
  }
657
+
740
658
  /** Parameters for `get_endpoint_logs`. */
741
659
  export interface GetEndpointLogsRequest {
742
660
  /** Start of the query window (timestamp). */
@@ -750,34 +668,7 @@ export interface GetEndpointLogsRequest {
750
668
  /** Cursor returned by a previous page; pass to fetch the next page. */
751
669
  nextAt?: string
752
670
  }
753
- /** Raw request/response payloads attached to a log entry. */
754
- export interface LogDetails {
755
- /** JSON-encoded request body (truncated at 2KB). */
756
- request?: string
757
- /** JSON-encoded response body (truncated at 2KB). */
758
- response?: string
759
- }
760
- /** A single endpoint log entry. */
761
- export interface EndpointLog {
762
- /** Time the request was received. */
763
- timestamp: string
764
- /** RPC method called (e.g. `eth_blockNumber`). */
765
- method?: string
766
- /** Network the request was routed to. */
767
- network?: string
768
- /** HTTP verb (e.g. `POST`). */
769
- httpMethod?: string
770
- /** Response HTTP status code. */
771
- status?: number
772
- /** JSON-RPC error code, when present. */
773
- errorCode?: number
774
- /** Request URL. */
775
- url?: string
776
- /** Request UUID used to fetch full log details. */
777
- requestId?: string
778
- /** Full payloads, included when requested. */
779
- details?: LogDetails
780
- }
671
+
781
672
  /** Response from `get_endpoint_logs`. */
782
673
  export interface GetEndpointLogsResponse {
783
674
  /** Log entries on the current page. */
@@ -785,131 +676,198 @@ export interface GetEndpointLogsResponse {
785
676
  /** Cursor for the next page; `None` when there are no more entries. */
786
677
  nextAt?: string
787
678
  }
788
- /** Response from `get_log_details`. */
789
- export interface GetLogDetailsResponse {
790
- /** Raw request and response payloads for the log entry. */
791
- data?: LogDetails
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
792
686
  }
793
- /** An account-level tag, shared across endpoints. */
794
- export interface AccountTag {
795
- /** Tag identifier. */
796
- id: number
797
- /** Tag label. */
798
- label: string
799
- /** Number of endpoints the tag is applied to. */
800
- usageCount: number
801
- }
802
- /** Inner data wrapper for `list_tags`. */
803
- export interface ListTagsData {
804
- /** Tags on the account. */
805
- 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
806
694
  }
807
- /** Response from `list_tags`. */
808
- export interface ListTagsResponse {
809
- /** Account tags payload. */
810
- data?: ListTagsData
695
+
696
+ /** Response from `get_endpoint_security`. */
697
+ export interface GetEndpointSecurityResponse {
698
+ /** The endpoint's security configuration. */
699
+ data?: EndpointSecurity
811
700
  /** Error message when the request did not succeed. */
812
701
  error?: string
813
702
  }
814
- /** Parameters for `rename_tag`. */
815
- export interface RenameTagRequest {
816
- /** New label for the tag. */
817
- 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>
818
730
  }
819
- /** Response from `rename_tag`. */
820
- export interface RenameTagResponse {
821
- /** The renamed tag. */
822
- 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
823
738
  /** Error message when the request did not succeed. */
824
739
  error?: string
825
740
  }
826
- /** Inner data for `delete_account_tag`. */
827
- export interface DeleteAccountTagData {
828
- /** `true` when the tag was deleted. */
829
- 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>
830
753
  }
831
- /** Response from `delete_account_tag`. */
832
- export interface DeleteAccountTagResponse {
833
- /** Deletion result. */
834
- data?: DeleteAccountTagData
754
+
755
+ /** Response from `get_endpoint_urls`. */
756
+ export interface GetEndpointUrlsResponse {
757
+ /** URLs for the endpoint. */
758
+ data?: GetEndpointUrlsData
835
759
  /** Error message when the request did not succeed. */
836
760
  error?: string
837
761
  }
838
- /** A team member or pending invitee. */
839
- export interface TeamUser {
840
- /** User identifier. */
841
- id: number
842
- /** Display name. */
843
- fullName?: string
844
- /** Email address. */
845
- email: string
846
- /** Team role (e.g. `admin`, `viewer`, `billing`). */
847
- role?: string
848
- /** Membership status (e.g. `active`, `pending`). */
849
- status?: string
850
- /** When the user was added. */
851
- createdAt?: string
852
- /** Profile photo URL. */
853
- photoUrl?: string
854
- /** Whether this user is the primary user on the account. */
855
- 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>
856
767
  }
857
- /** Summary representation of a team in list responses. */
858
- export interface TeamSummary {
859
- /** Team identifier. */
860
- id: number
861
- /** Team name. */
862
- name: string
863
- /** Current member count. */
864
- membersCount?: number
865
- /** Active team members. */
866
- 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
867
775
  }
868
- /** Full team detail including pending invites. */
869
- export interface TeamDetail {
870
- /** Team identifier. */
871
- id: number
872
- /** Team name. */
873
- name: string
874
- /** Default role assigned to newly invited members. */
875
- defaultRole?: string
876
- /** Current member count. */
877
- membersCount?: number
878
- /** Active team members. */
879
- users: Array<TeamUser>
880
- /** Invites that have not yet been accepted. */
881
- 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
882
783
  }
883
- /** Response from `list_teams`. */
884
- export interface ListTeamsResponse {
885
- /** Teams on the account. */
886
- data: Array<TeamSummary>
784
+
785
+ /** Inner data for `get_lists` responses. */
786
+ export interface GetListsData {
787
+ /** List keys on the current page. */
788
+ keys: Array<string>
789
+ }
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
797
+ }
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
805
+ }
806
+
807
+ /** Response from `get_log_details`. */
808
+ export interface GetLogDetailsResponse {
809
+ /** Raw request and response payloads for the log entry. */
810
+ data?: LogDetails
811
+ }
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
887
823
  /** Error message when the request did not succeed. */
888
824
  error?: string
889
825
  }
890
- /** Parameters for `create_team`. */
891
- export interface CreateTeamRequest {
892
- /** Team name. */
893
- name: string
826
+
827
+ /** Inner data for `get_rate_limits`. */
828
+ export interface GetRateLimitsData {
829
+ /** One row per enforced bucket. */
830
+ rateLimits: Array<RateLimitEntry>
894
831
  }
895
- /** Inner data for `create_team` responses. */
896
- export interface CreateTeamData {
897
- /** Team identifier. */
898
- id: number
899
- /** Team name. */
900
- name: string
901
- /** Default role for newly invited members. */
902
- defaultRole?: string
903
- /** Initial member count. */
904
- membersCount?: number
832
+
833
+ /** Response from `get_rate_limits`. */
834
+ export interface GetRateLimitsResponse {
835
+ /** Rate-limit rows with their source. */
836
+ data?: GetRateLimitsData
837
+ /** Error message when the request did not succeed. */
838
+ error?: string
905
839
  }
906
- /** Response from `create_team`. */
907
- export interface CreateTeamResponse {
908
- /** The newly created team. */
909
- data?: CreateTeamData
840
+
841
+ /** Response from `get_security_options`. */
842
+ export interface GetSecurityOptionsResponse {
843
+ /** Security options on the endpoint. */
844
+ data: Array<SecurityOption>
910
845
  /** Error message when the request did not succeed. */
911
846
  error?: string
912
847
  }
848
+
849
+ /** Response from `get_set`. */
850
+ export interface GetSetResponse {
851
+ /** Stored string value. */
852
+ value: string
853
+ }
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
861
+ }
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
+
913
871
  /** Response from `get_team`. */
914
872
  export interface GetTeamResponse {
915
873
  /** The team's full detail. */
@@ -917,53 +875,77 @@ export interface GetTeamResponse {
917
875
  /** Error message when the request did not succeed. */
918
876
  error?: string
919
877
  }
920
- /** Inner data for `delete_team` responses. */
921
- export interface DeleteTeamData {
922
- /** Human-readable confirmation message. */
923
- message?: string
924
- }
925
- /** Response from `delete_team`. */
926
- export interface DeleteTeamResponse {
927
- /** Deletion result payload. */
928
- data?: DeleteTeamData
878
+
879
+ /** Response from `get_usage_by_chain`. */
880
+ export interface GetUsageByChainResponse {
881
+ /** Per-chain usage payload. */
882
+ data?: UsageByChainData
929
883
  /** Error message when the request did not succeed. */
930
884
  error?: string
931
885
  }
932
- /** A team's endpoint association. */
933
- export interface TeamEndpoint {
934
- /** Endpoint identifier. */
935
- id: number
936
- /** Endpoint subdomain. */
937
- subdomain: string
938
- /** Blockchain the endpoint serves. */
939
- chain?: string
940
- /** Network within the chain. */
941
- network?: 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
942
893
  }
943
- /** Response from `list_team_endpoints`. */
944
- export interface ListTeamEndpointsResponse {
945
- /** Endpoints accessible to the team. */
946
- data: Array<TeamEndpoint>
894
+
895
+ /** Response from `get_usage_by_method`. */
896
+ export interface GetUsageByMethodResponse {
897
+ /** Per-method usage payload. */
898
+ data?: UsageByMethodData
947
899
  /** Error message when the request did not succeed. */
948
900
  error?: string
949
901
  }
950
- /** Parameters for `update_team_endpoints`. */
951
- export interface UpdateTeamEndpointsRequest {
952
- /** Endpoint ids to associate with the team; pass an empty array to remove all. */
953
- endpointIds: Array<string>
902
+
903
+ /** Response from `get_usage_by_tag`. */
904
+ export interface GetUsageByTagResponse {
905
+ /** Per-tag usage payload. */
906
+ data?: UsageByTagData
907
+ /** Error message when the request did not succeed. */
908
+ error?: string
954
909
  }
955
- /** Inner data for `update_team_endpoints` responses. */
956
- export interface UpdateTeamEndpointsData {
957
- /** `true` when the association update succeeded. */
958
- success?: boolean
910
+
911
+ /**
912
+ * Parameters for the account usage methods (`get_usage`, `get_usage_by_*`).
913
+ * Both bounds are optional; omit for account-to-date totals.
914
+ */
915
+ export interface GetUsageRequest {
916
+ /** Start of the query window (Unix timestamp). */
917
+ startTime?: number
918
+ /** End of the query window (Unix timestamp). */
919
+ endTime?: number
959
920
  }
960
- /** Response from `update_team_endpoints`. */
961
- export interface UpdateTeamEndpointsResponse {
962
- /** Update result. */
963
- data?: UpdateTeamEndpointsData
921
+
922
+ /** Response from `get_usage`. */
923
+ export interface GetUsageResponse {
924
+ /** Aggregate usage payload. */
925
+ data?: UsageData
964
926
  /** Error message when the request did not succeed. */
965
927
  error?: string
966
928
  }
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
936
+ }
937
+
938
+ export interface HttpConfig {
939
+ timeoutSecs?: number
940
+ poolMaxIdlePerHost?: number
941
+ }
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>
947
+ }
948
+
967
949
  /** Parameters for `invite_team_member`. */
968
950
  export interface InviteTeamMemberRequest {
969
951
  /** Email address to invite. */
@@ -973,6 +955,7 @@ export interface InviteTeamMemberRequest {
973
955
  /** Team role (`admin`, `viewer`, or `billing`); required for new users. */
974
956
  role?: string
975
957
  }
958
+
976
959
  /** Response from `invite_team_member`. */
977
960
  export interface InviteTeamMemberResponse {
978
961
  /** The invited user and their invitation status. */
@@ -980,81 +963,205 @@ export interface InviteTeamMemberResponse {
980
963
  /** Error message when the request did not succeed. */
981
964
  error?: string
982
965
  }
983
- /** Parameters for `remove_team_member`. */
984
- export interface RemoveTeamMemberRequest {
985
- /** When true, also delete the user entirely rather than just removing them from the team. */
986
- destroyUser?: boolean
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
987
989
  }
988
- /** Shared message-shaped data wrapper for team operations. */
989
- export interface TeamMessageData {
990
- /** Human-readable confirmation message. */
991
- message?: string
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
992
997
  }
993
- /** Response from `remove_team_member`. */
994
- export interface RemoveTeamMemberResponse {
995
- /** Operation result message. */
996
- data?: TeamMessageData
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>
997
1051
  /** Error message when the request did not succeed. */
998
1052
  error?: string
999
1053
  }
1000
- /** Response from `resend_team_invite`. */
1001
- export interface ResendTeamInviteResponse {
1002
- /** Operation result message. */
1003
- data?: TeamMessageData
1054
+
1055
+ /** Response from `list_contains_item`. */
1056
+ export interface ListContainsItemResponse {
1057
+ /** `true` when the item is present in the list. */
1058
+ exists: boolean
1059
+ }
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
1004
1071
  /** Error message when the request did not succeed. */
1005
1072
  error?: string
1006
1073
  }
1007
- /**
1008
- * Parameters for the account usage methods (`get_usage`, `get_usage_by_*`).
1009
- * Both bounds are optional; omit for account-to-date totals.
1010
- */
1011
- export interface GetUsageRequest {
1012
- /** Start of the query window (Unix timestamp). */
1013
- startTime?: number
1014
- /** End of the query window (Unix timestamp). */
1015
- endTime?: number
1016
- }
1017
- /** Aggregate account usage for a time window. */
1018
- export interface UsageData {
1019
- /** Credits consumed during the window. */
1020
- creditsUsed: number
1021
- /** Credits still available, when the plan has a finite limit. */
1022
- creditsRemaining?: number
1023
- /** Plan's credit limit, when applicable. */
1024
- limit?: number
1025
- /** Credits consumed beyond the plan limit. */
1026
- overages?: number
1027
- /** Start of the queried window. */
1028
- startTime: number
1029
- /** End of the queried window. */
1030
- endTime: number
1074
+
1075
+ /** Payment list wrapper. */
1076
+ export interface ListPaymentsData {
1077
+ /** Payments on the account. */
1078
+ payments: Array<Payment>
1031
1079
  }
1032
- /** Response from `get_usage`. */
1033
- export interface GetUsageResponse {
1034
- /** Aggregate usage payload. */
1035
- data?: UsageData
1080
+
1081
+ /** Response from `list_payments`. */
1082
+ export interface ListPaymentsResponse {
1083
+ /** Payment data payload. */
1084
+ data?: ListPaymentsData
1036
1085
  /** Error message when the request did not succeed. */
1037
1086
  error?: string
1038
1087
  }
1039
- /** Per-endpoint usage row. */
1040
- export interface EndpointUsage {
1041
- /** Endpoint subdomain. */
1042
- name: string
1043
- /** Blockchain the endpoint serves. */
1044
- chain?: string
1045
- /** Network within the chain. */
1046
- network?: string
1047
- /** Operational status during the window. */
1048
- status?: string
1049
- /** Total credits consumed by this endpoint. */
1050
- creditsUsed: number
1051
- /** Human-readable label. */
1052
- label?: string
1053
- /** Per-method credit breakdown. */
1054
- methodsBreakdown: Array<MethodUsage>
1055
- /** Request count during the window. */
1056
- requests?: number
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
1113
+ /** Error message when the request did not succeed. */
1114
+ error?: string
1115
+ }
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
1123
+ }
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
1131
+ }
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
1139
+ }
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
1147
+ }
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
1057
1163
  }
1164
+
1058
1165
  /** Per-method usage row. */
1059
1166
  export interface MethodUsage {
1060
1167
  /** RPC method name. */
@@ -1068,222 +1175,259 @@ export interface MethodUsage {
1068
1175
  /** Chain the calls targeted. */
1069
1176
  chain?: string
1070
1177
  }
1071
- /** Per-chain usage row. */
1072
- export interface ChainUsage {
1073
- /** Chain name or slug. */
1074
- name: string
1075
- /** Credits consumed on the chain. */
1076
- creditsUsed: number
1077
- }
1078
- /** Inner data for `get_usage_by_endpoint`. */
1079
- export interface UsageByEndpointData {
1080
- /** Per-endpoint rows. */
1081
- endpoints: Array<EndpointUsage>
1082
- /** Start of the queried window. */
1083
- startTime?: number
1084
- /** End of the queried window. */
1085
- endTime?: number
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
1086
1187
  }
1087
- /** Response from `get_usage_by_endpoint`. */
1088
- export interface GetUsageByEndpointResponse {
1089
- /** Per-endpoint usage payload. */
1090
- data?: UsageByEndpointData
1091
- /** Error message when the request did not succeed. */
1092
- error?: 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
1093
1197
  }
1094
- /** Inner data for `get_usage_by_method`. */
1095
- export interface UsageByMethodData {
1096
- /** Per-method rows. */
1097
- methods: Array<MethodUsage>
1098
- /** Start of the queried window. */
1099
- startTime?: number
1100
- /** End of the queried window. */
1101
- endTime?: number
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
1102
1213
  }
1103
- /** Response from `get_usage_by_method`. */
1104
- export interface GetUsageByMethodResponse {
1105
- /** Per-method usage payload. */
1106
- data?: UsageByMethodData
1107
- /** Error message when the request did not succeed. */
1108
- error?: 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
1109
1235
  }
1110
- /** Inner data for `get_usage_by_chain`. */
1111
- export interface UsageByChainData {
1112
- /** Per-chain rows. */
1113
- chains: Array<ChainUsage>
1114
- /** Start of the queried window. */
1115
- startTime?: number
1116
- /** End of the queried window. */
1117
- endTime?: number
1236
+
1237
+ /** Billing product type the stream is associated with. */
1238
+ export declare const enum ProductType {
1239
+ Stream = 'Stream',
1240
+ Webhook = 'Webhook'
1118
1241
  }
1119
- /** Response from `get_usage_by_chain`. */
1120
- export interface GetUsageByChainResponse {
1121
- /** Per-chain usage payload. */
1122
- data?: UsageByChainData
1123
- /** Error message when the request did not succeed. */
1124
- error?: 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
1125
1261
  }
1126
- /** Per-tag usage row. */
1127
- export interface TagUsage {
1128
- /** Tag identifier. */
1129
- tagId?: number
1130
- /** Tag label. */
1131
- label: string
1132
- /** Credits consumed by endpoints with this tag. */
1133
- creditsUsed: number
1134
- /** Request count during the window. */
1135
- requests: number
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
1136
1271
  }
1137
- /** Inner data for `get_usage_by_tag`. */
1138
- export interface UsageByTagData {
1139
- /** Per-tag rows. */
1140
- tags: Array<TagUsage>
1141
- /** Start of the queried window. */
1142
- startTime?: number
1143
- /** End of the queried window. */
1144
- endTime?: number
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
1145
1277
  }
1146
- /** Response from `get_usage_by_tag`. */
1147
- export interface GetUsageByTagResponse {
1148
- /** Per-tag usage payload. */
1149
- data?: UsageByTagData
1278
+
1279
+ /** Response from `remove_team_member`. */
1280
+ export interface RemoveTeamMemberResponse {
1281
+ /** Operation result message. */
1282
+ data?: TeamMessageData
1150
1283
  /** Error message when the request did not succeed. */
1151
1284
  error?: string
1152
1285
  }
1153
- export interface HttpConfig {
1154
- timeoutSecs?: number
1155
- poolMaxIdlePerHost?: number
1156
- }
1157
- export interface AdminConfig {
1158
- baseUrl?: string
1159
- }
1160
- export interface StreamsConfig {
1161
- baseUrl?: string
1162
- }
1163
- export interface WebhooksConfig {
1164
- baseUrl?: string
1165
- }
1166
- export interface KvStoreConfig {
1167
- baseUrl?: string
1168
- }
1169
- export interface SdkFullConfig {
1170
- apiKey: string
1171
- http?: HttpConfig
1172
- admin?: AdminConfig
1173
- streams?: StreamsConfig
1174
- webhooks?: WebhooksConfig
1175
- kvstore?: KvStoreConfig
1176
- }
1177
- /** Parameters for `create_set`. */
1178
- export interface CreateSetParams {
1179
- /** Unique key identifying the set. */
1180
- key: string
1181
- /** String value stored under the key. */
1182
- value: string
1183
- }
1184
- /** Parameters for `get_sets`. */
1185
- export interface GetSetsParams {
1186
- /** Maximum number of entries returned. */
1187
- limit?: number
1188
- /** Cursor returned by a previous page; pass to fetch the next page. */
1189
- cursor?: string
1190
- }
1191
- /** Parameters for `bulk_sets`. Either or both fields may be supplied. */
1192
- export interface BulkSetsParams {
1193
- /** Key/value pairs to add. */
1194
- addSets?: Record<string, string>
1195
- /** Keys to delete. */
1196
- deleteSets?: Array<string>
1197
- }
1198
- /** Parameters for `create_list`. */
1199
- export interface CreateListParams {
1200
- /** Unique key identifying the list. */
1201
- key: string
1202
- /** Initial items inserted into the list. */
1203
- items: Array<string>
1204
- }
1205
- /** Parameters for `get_lists`. */
1206
- export interface GetListsParams {
1207
- /** Maximum number of list keys returned. */
1208
- limit?: number
1209
- /** Cursor returned by a previous page; pass to fetch the next page. */
1210
- cursor?: string
1211
- }
1212
- /** Parameters for `get_list`. */
1213
- export interface GetListParams {
1214
- /** Maximum number of items returned. */
1215
- limit?: number
1216
- /** Cursor returned by a previous page; pass to fetch the next page. */
1217
- cursor?: string
1218
- }
1219
- /** Parameters for `update_list`. Either or both fields may be supplied. */
1220
- export interface UpdateListParams {
1221
- /** Items to add to the list. */
1222
- addItems?: Array<string>
1223
- /** Items to remove from the list. */
1224
- removeItems?: Array<string>
1225
- }
1226
- /** Parameters for `add_list_item`. */
1227
- export interface AddListItemParams {
1228
- /** Item to append to the list. */
1229
- item: string
1286
+
1287
+ /** Parameters for `rename_tag`. */
1288
+ export interface RenameTagRequest {
1289
+ /** New label for the tag. */
1290
+ label: string
1230
1291
  }
1231
- /** A single key/value entry returned by `get_sets`. */
1232
- export interface KvSetEntry {
1233
- /** Key identifying the set. */
1234
- key: string
1235
- /** Stored string value. */
1236
- value: string
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
1237
1299
  }
1238
- /** Response from `get_sets`. */
1239
- export interface GetSetsResponse {
1240
- /** Key/value entries on the current page. */
1241
- data: Array<KvSetEntry>
1242
- /** Cursor for the next page; empty string when there are no more pages. */
1243
- cursor: string
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
1244
1307
  }
1245
- /** Response from `get_set`. */
1246
- export interface GetSetResponse {
1247
- /** Stored string value. */
1248
- value: 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
1249
1331
  }
1250
- /** Inner data for `get_lists` responses. */
1251
- export interface GetListsData {
1252
- /** List keys on the current page. */
1253
- keys: Array<string>
1332
+
1333
+ export interface SdkFullConfig {
1334
+ apiKey: string
1335
+ http?: HttpConfig
1336
+ admin?: AdminConfig
1337
+ streams?: StreamsConfig
1338
+ webhooks?: WebhooksConfig
1339
+ kvstore?: KvStoreConfig
1254
1340
  }
1255
- /** Response from `get_lists`. */
1256
- export interface GetListsResponse {
1257
- /** List keys on the current page. */
1258
- data: GetListsData
1259
- /** Cursor for the next page; empty string when there are no more pages. */
1260
- cursor: 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
1261
1350
  }
1262
- /** Inner data for `get_list` responses. */
1263
- export interface GetListData {
1264
- /** Items in the list on the current page. */
1265
- items: Array<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
1266
1375
  }
1267
- /** Response from `get_list`. */
1268
- export interface GetListResponse {
1269
- /** Items for the list on the current page. */
1270
- data: GetListData
1271
- /** Cursor for the next page; empty string when there are no more pages. */
1272
- cursor: 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
1273
1383
  }
1274
- /** Response from `list_contains_item`. */
1275
- export interface ListContainsItemResponse {
1276
- /** `true` when the item is present in the list. */
1277
- exists: boolean
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
1278
1409
  }
1279
- /** Geographic region where a stream runs. */
1280
- export const enum StreamRegion {
1281
- UsaEast = 'UsaEast',
1282
- EuropeCentral = 'EuropeCentral',
1283
- AsiaEast = 'AsiaEast'
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>
1418
+ }
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>
1284
1427
  }
1428
+
1285
1429
  /** Type of on-chain data a stream delivers (blocks, transactions, logs, etc.). */
1286
- export const enum StreamDataset {
1430
+ export declare const enum StreamDataset {
1287
1431
  Block = 'Block',
1288
1432
  BlockWithReceipts = 'BlockWithReceipts',
1289
1433
  Transactions = 'Transactions',
@@ -1303,180 +1447,121 @@ export const enum StreamDataset {
1303
1447
  Twap = 'Twap',
1304
1448
  WriterActions = 'WriterActions'
1305
1449
  }
1450
+
1306
1451
  /** Destination kind a stream delivers to (webhook, S3, Postgres, etc.). */
1307
- export const enum StreamDestination {
1452
+ export declare const enum StreamDestination {
1308
1453
  Webhook = 'Webhook',
1309
1454
  S3 = 'S3',
1310
1455
  Azure = 'Azure',
1311
1456
  Postgres = 'Postgres',
1312
1457
  Kafka = 'Kafka'
1313
1458
  }
1314
- /** Language a stream's filter function is written in. */
1315
- export const enum FilterLanguage {
1316
- Javascript = 'Javascript',
1317
- Go = 'Go',
1318
- Wasm = 'Wasm'
1319
- }
1459
+
1320
1460
  /** Where stream metadata is included in delivered payloads. */
1321
- export const enum StreamMetadataLocation {
1461
+ export declare const enum StreamMetadataLocation {
1322
1462
  Body = 'Body',
1323
1463
  Header = 'Header',
1324
1464
  None = 'None'
1325
1465
  }
1326
- /** Billing product type the stream is associated with. */
1327
- export const enum ProductType {
1328
- Stream = 'Stream',
1329
- 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
1330
1476
  }
1477
+
1331
1478
  /** Operational state of a stream. */
1332
- export const enum StreamStatus {
1479
+ export declare const enum StreamStatus {
1333
1480
  Active = 'Active',
1334
1481
  Paused = 'Paused',
1335
1482
  Terminated = 'Terminated',
1336
1483
  Completed = 'Completed',
1337
1484
  Blocked = 'Blocked'
1338
1485
  }
1339
- /** Configuration for delivering stream batches to an HTTP webhook endpoint. */
1340
- export interface WebhookAttributes {
1341
- /** Destination URL that receives batched stream payloads. */
1342
- url: string
1343
- /** Maximum number of retry attempts for a failed delivery. Must be in the range 1–10. */
1344
- maxRetry: number
1345
- /** Seconds to wait between retry attempts. */
1346
- retryIntervalSec: number
1347
- /** Timeout in seconds for each POST request. */
1348
- postTimeoutSec: number
1349
- /** Optional token included with each request so the receiver can verify authenticity. When supplied, must be at least 32 bytes (256 bits). */
1350
- securityToken?: string
1351
- /** Compression applied to the payload (e.g. `none`, `gzip`). When omitted the server defaults to no compression. */
1352
- compression?: string
1353
- }
1354
- /** Configuration for delivering stream batches to an S3-compatible object store. */
1355
- export interface S3Attributes {
1356
- /** S3 service endpoint (e.g. `s3.amazonaws.com`). */
1357
- endpoint: string
1358
- /** Access key used to authenticate with the S3 endpoint. */
1359
- accessKey: string
1360
- /** Secret key used to authenticate with the S3 endpoint. */
1361
- secretKey: string
1362
- /** Target bucket name. */
1363
- bucket: string
1364
- /** Key prefix prepended to each written object. */
1365
- objectPrefix: string
1366
- /** Compression applied to written objects (e.g. `none`, `gzip`). */
1367
- compression: string
1368
- /** File format/extension for written objects (e.g. `.json`). */
1369
- fileType: string
1370
- /** Maximum number of retry attempts for a failed write. */
1371
- maxRetry: number
1372
- /** Seconds to wait between retry attempts. */
1373
- retryIntervalSec: number
1374
- /** Whether to use TLS when connecting to the endpoint. */
1375
- useSsl?: boolean
1376
- }
1377
- /** Configuration for delivering stream batches to Azure Blob Storage. */
1378
- export interface AzureAttributes {
1379
- /** Azure storage account name. */
1380
- storageAccount: string
1381
- /** SAS token used to authorize writes. */
1382
- sasToken: string
1383
- /** Container that receives written blobs. */
1384
- container: string
1385
- /** Compression applied to written blobs (e.g. `none`, `gzip`). */
1386
- compression: string
1387
- /** File format/extension for written blobs (e.g. `.json`). */
1388
- fileType: string
1389
- /** Maximum number of retry attempts for a failed write. */
1390
- maxRetry: number
1391
- /** Seconds to wait between retry attempts. */
1392
- retryIntervalSec: number
1393
- /** Optional name prefix prepended to each written blob. */
1394
- blobPrefix?: 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
1395
1497
  }
1396
- /** Configuration for delivering stream batches to a PostgreSQL database. */
1397
- export interface PostgresAttributes {
1398
- /** Database host. */
1399
- host: string
1400
- /** Database port. */
1401
- port: number
1402
- /** Database name. */
1403
- database: string
1404
- /** Username used to authenticate. */
1405
- username: string
1406
- /** Password used to authenticate. */
1407
- password: string
1408
- /** Destination table for inserted rows. */
1409
- tableName: string
1410
- /** Postgres SSL mode. The Quicknode API accepts only `disable` or `require`. */
1411
- sslmode: string
1412
- /** Maximum number of retry attempts for a failed write. */
1413
- maxRetry: number
1414
- /** Seconds to wait between retry attempts. */
1415
- retryIntervalSec: number
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>
1416
1513
  }
1417
- /** Configuration for delivering stream batches to a Kafka topic. */
1418
- export interface KafkaAttributes {
1419
- /** Comma-separated list of Kafka broker addresses (host:port). */
1420
- bootstrapServers: string
1421
- /** Destination topic. */
1422
- topicName: string
1423
- /** Compression codec applied to produced messages (e.g. `none`, `gzip`). */
1424
- compressionType: string
1425
- /** Maximum number of messages grouped per produce request. */
1426
- batchSize: number
1427
- /** Milliseconds the producer waits to batch additional messages. */
1428
- lingerMs: number
1429
- /** Maximum size in bytes of a single Kafka message (`max_message_bytes`). */
1430
- maxMessageBytes: number
1431
- /** Request timeout in seconds. */
1432
- timeoutSec: number
1433
- /** Maximum number of retry attempts for a failed produce. */
1434
- maxRetry: number
1435
- /** Seconds to wait between retry attempts. */
1436
- retryIntervalSec: number
1437
- /** Optional SASL username. */
1438
- username?: string
1439
- /** Optional SASL password. */
1440
- password?: string
1441
- /** Optional security protocol (e.g. `SASL_SSL`). */
1442
- protocol?: string
1443
- /** Optional SASL mechanism (e.g. `PLAIN`, `SCRAM-SHA-256`). */
1444
- mechanisms?: string
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
1445
1525
  }
1446
- /**
1447
- * Links a stream's filter to an address book so JSON paths resolve against its
1448
- * managed address set.
1449
- */
1450
- export interface AddressBookConfig {
1451
- /** Identifier of the address book to use. */
1452
- addressBookId: string
1453
- /** Optional JSON path that resolves to an object whose fields are matched against the book. */
1454
- objectsFilterPath?: string
1455
- /** JSON paths whose resolved values are matched against the book's addresses. */
1456
- elementsFilterPaths: Array<string>
1526
+
1527
+ /** Shared message-shaped data wrapper for team operations. */
1528
+ export interface TeamMessageData {
1529
+ /** Human-readable confirmation message. */
1530
+ message?: string
1457
1531
  }
1458
- /** Pagination metadata returned alongside a paginated result set. */
1459
- export interface PageInfo {
1460
- /** Page size used for this response. */
1461
- limit: number
1462
- /** Starting index of this page within the full result set. */
1463
- offset: number
1464
- /** Total number of items matching the query across all pages. */
1465
- total: number
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>
1466
1543
  }
1467
- /** Parameters for `list_streams`. */
1468
- export interface ListStreamsParams {
1469
- /** Filter results by stream type. */
1470
- streamType?: string
1471
- /** Starting index into the result set; defaults to 0. */
1472
- offset?: number
1473
- /** Maximum number of streams returned. */
1474
- limit?: number
1475
- /** Field to sort results by. */
1476
- orderBy?: string
1477
- /** Sort direction (`asc` or `desc`). */
1478
- orderDirection?: string
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
1479
1563
  }
1564
+
1480
1565
  /** Parameters for `test_filter`. */
1481
1566
  export interface TestFilterParams {
1482
1567
  /** Blockchain network to run the test against (e.g. `ethereum-mainnet`). */
@@ -1492,6 +1577,7 @@ export interface TestFilterParams {
1492
1577
  /** Address book linked to the filter, if any. */
1493
1578
  addressBookConfig?: AddressBookConfig
1494
1579
  }
1580
+
1495
1581
  /** Result of a `test_filter` call. */
1496
1582
  export interface TestFilterResponse {
1497
1583
  /** Filter output as a JSON string. Shape depends on the dataset and the user's filter function. */
@@ -1499,104 +1585,99 @@ export interface TestFilterResponse {
1499
1585
  /** Log lines emitted by the filter function during evaluation. */
1500
1586
  logs: Array<string>
1501
1587
  }
1502
- /** Result of `get_enabled_count`. */
1503
- export interface EnabledCountResponse {
1504
- /** Total count of currently enabled streams. */
1505
- total: number
1588
+
1589
+ /** Parameters for `update_endpoint`. */
1590
+ export interface UpdateEndpointRequest {
1591
+ /** New human-readable label. */
1592
+ label?: string
1506
1593
  }
1507
- /** Identifier of a predefined webhook filter template. */
1508
- export const enum WebhookTemplateId {
1509
- EvmWalletFilter = 'EvmWalletFilter',
1510
- EvmContractEvents = 'EvmContractEvents',
1511
- EvmAbiFilter = 'EvmAbiFilter',
1512
- SolanaWalletFilter = 'SolanaWalletFilter',
1513
- BitcoinWalletFilter = 'BitcoinWalletFilter',
1514
- XrplWalletFilter = 'XrplWalletFilter',
1515
- HyperliquidWalletEventsFilter = 'HyperliquidWalletEventsFilter',
1516
- StellarWalletTransactionsSourceAccountFilter = 'StellarWalletTransactionsSourceAccountFilter'
1594
+
1595
+ /** Parameters for `update_endpoint_status`. */
1596
+ export interface UpdateEndpointStatusRequest {
1597
+ /** New status (`active` or `paused`). */
1598
+ status: string
1517
1599
  }
1518
- /** Position a webhook begins (or resumes) delivering from when activated. */
1519
- export const enum WebhookStartFrom {
1520
- /** Resume from the last-delivered block. */
1521
- Last = 'Last',
1522
- /** Start from the newest available block. */
1523
- Latest = 'Latest'
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
1524
1607
  }
1525
- /**
1526
- * Template arguments for an EVM wallet filter: matches activity for a list of
1527
- * wallet addresses.
1528
- */
1529
- export interface EvmWalletFilterTemplate {
1530
- /** Wallet addresses to match against. */
1531
- wallets: 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>
1532
1615
  }
1533
- /**
1534
- * Template arguments for filtering EVM contract events, optionally scoped to
1535
- * a specific set of event topic hashes.
1536
- */
1537
- export interface EvmContractEventsTemplate {
1538
- /** Contract addresses to watch for events. */
1539
- contracts: Array<string>
1540
- /** Optional list of event topic hashes to restrict the filter to specific events. */
1541
- eventHashes?: 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
1542
1625
  }
1543
- /**
1544
- * Template arguments for an EVM ABI filter: decodes and filters events for a
1545
- * set of contracts using a provided ABI.
1546
- */
1547
- export interface EvmAbiFilterTemplate {
1548
- /** JSON-encoded contract ABI used to decode event data. */
1549
- abi: string
1550
- /** Contract addresses to watch for events. */
1551
- contracts: 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
1552
1633
  }
1553
- /**
1554
- * Template arguments for a Solana wallet filter: matches activity for a list
1555
- * of Solana account addresses.
1556
- */
1557
- export interface SolanaWalletFilterTemplate {
1558
- /** Solana account addresses to match against. */
1559
- accounts: Array<string>
1634
+
1635
+ /** Parameters for `update_rate_limits`. */
1636
+ export interface UpdateRateLimitsRequest {
1637
+ /** Rate limit values to apply. */
1638
+ rateLimits: RateLimitSettings
1560
1639
  }
1561
- /** Template arguments for a Bitcoin wallet filter. */
1562
- export interface BitcoinWalletFilterTemplate {
1563
- /** Bitcoin wallet addresses to match against. */
1564
- 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>
1565
1645
  }
1566
- /** Template arguments for an XRPL wallet filter. */
1567
- export interface XrplWalletFilterTemplate {
1568
- /** XRPL wallet addresses to match against. */
1569
- wallets: Array<string>
1646
+
1647
+ /** Parameters for `update_security_options`. */
1648
+ export interface UpdateSecurityOptionsRequest {
1649
+ /** Security toggles to apply. */
1650
+ options: SecurityOptionsUpdate
1570
1651
  }
1571
- /** Template arguments for a Hyperliquid wallet-events filter. */
1572
- export interface HyperliquidWalletEventsFilterTemplate {
1573
- /** Hyperliquid wallet addresses to match against. */
1574
- 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
1575
1659
  }
1576
- /**
1577
- * Template arguments for a Stellar wallet-transactions filter, matching
1578
- * transactions where the given wallets are the source account.
1579
- */
1580
- export interface StellarWalletTransactionsFilterTemplate {
1581
- /** Stellar wallet addresses to match against. */
1582
- wallets: Array<string>
1660
+
1661
+ /** Inner data for `update_team_endpoints` responses. */
1662
+ export interface UpdateTeamEndpointsData {
1663
+ /** `true` when the association update succeeded. */
1664
+ success?: boolean
1583
1665
  }
1584
- /** Destination configuration for a webhook. */
1585
- export interface WebhookDestinationAttributes {
1586
- /** Target URL that receives webhook payloads. */
1587
- url: string
1588
- /** Optional token sent with each payload so the receiver can verify authenticity; generated automatically when omitted. */
1589
- securityToken?: string
1590
- /** Optional payload compression (`gzip` or `none`). */
1591
- compression?: string
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>
1592
1671
  }
1593
- /** Parameters for `list_webhooks`. */
1594
- export interface GetWebhooksParams {
1595
- /** Maximum number of webhooks returned. */
1596
- limit?: number
1597
- /** Starting index into the result set. */
1598
- offset?: number
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
1599
1679
  }
1680
+
1600
1681
  /**
1601
1682
  * Parameters for `update_webhook`. All fields are optional; only set fields
1602
1683
  * are modified.
@@ -1609,11 +1690,63 @@ export interface UpdateWebhookParams {
1609
1690
  /** New destination configuration. */
1610
1691
  destinationAttributes?: WebhookDestinationAttributes
1611
1692
  }
1612
- /** Parameters for `activate_webhook`. */
1613
- export interface ActivateWebhookParams {
1614
- /** Position to begin (or resume) delivery from. */
1615
- 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
1616
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
1748
+ }
1749
+
1617
1750
  /** A webhook's full configuration and current state. */
1618
1751
  export interface Webhook {
1619
1752
  /** Unique webhook identifier. */
@@ -1635,6 +1768,39 @@ export interface Webhook {
1635
1768
  /** Destination-specific configuration as a JSON string. */
1636
1769
  destinationAttributes?: string
1637
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
+
1638
1804
  /** Pagination metadata returned alongside a paginated webhooks list. */
1639
1805
  export interface WebhookPageInfo {
1640
1806
  /** Page size used for this response. */
@@ -1644,136 +1810,35 @@ export interface WebhookPageInfo {
1644
1810
  /** Total number of webhooks matching the query across all pages. */
1645
1811
  total: number
1646
1812
  }
1647
- /** Response from `list_webhooks`. */
1648
- export interface ListWebhooksResponse {
1649
- /** Webhooks on the current page. */
1650
- data: Array<Webhook>
1651
- /** Pagination metadata for the response. */
1652
- pageInfo: WebhookPageInfo
1653
- }
1654
- /** Response from `get_enabled_count` for webhooks. */
1655
- export interface WebhookEnabledCountResponse {
1656
- /** Total count of enabled webhooks on the account. */
1657
- total: number
1658
- }
1659
- export interface CreateStreamParamsNode {
1660
- name: string
1661
- region: StreamRegion
1662
- network: string
1663
- dataset: StreamDataset
1664
- startRange: number
1665
- endRange: number
1666
- destinationAttributes: any
1667
- plan?: string
1668
- thresholdFetchBuffer?: number
1669
- datasetBatchSize: number
1670
- maxBatchSize?: number
1671
- maxBufferRangeSize?: number
1672
- maxBufferProcessingWorkers?: number
1673
- keepDistanceFromTip?: number
1674
- filterFunction?: string
1675
- filterLanguage?: FilterLanguage
1676
- addressBookConfig?: AddressBookConfig
1677
- includeStreamMetadata?: StreamMetadataLocation
1678
- productType?: ProductType
1679
- status?: StreamStatus
1680
- notificationEmail?: string
1681
- chargeMinCap?: number
1682
- fixBlockReorgs?: number
1683
- elasticBatchEnabled: boolean
1684
- extraDestinations?: Array<any>
1685
- }
1686
- export interface UpdateStreamParamsNode {
1687
- name?: string
1688
- region?: StreamRegion
1689
- network?: string
1690
- dataset?: StreamDataset
1691
- startRange?: number
1692
- endRange?: number
1693
- destinationAttributes?: any
1694
- plan?: string
1695
- thresholdFetchBuffer?: number
1696
- datasetBatchSize?: number
1697
- maxBatchSize?: number
1698
- maxBufferRangeSize?: number
1699
- maxBufferProcessingWorkers?: number
1700
- keepDistanceFromTip?: number
1701
- filterFunction?: string
1702
- filterLanguage?: FilterLanguage
1703
- addressBookConfig?: AddressBookConfig
1704
- includeStreamMetadata?: StreamMetadataLocation
1705
- notificationEmail?: string
1706
- chargeMinCap?: number
1707
- fixBlockReorgs?: number
1708
- elasticBatchEnabled?: boolean
1709
- status?: StreamStatus
1710
- memo?: string
1711
- extraDestinations?: Array<any>
1712
- }
1713
- export interface StreamNode {
1714
- id: string
1715
- name: string
1716
- status: string
1717
- createdAt: string
1718
- updatedAt: string
1719
- sequence: number
1720
- network: string
1721
- dataset: string
1722
- region: string
1723
- startRange: number
1724
- endRange: number
1725
- plan?: string
1726
- thresholdFetchBuffer?: number
1727
- datasetBatchSize?: number
1728
- maxBatchSize?: number
1729
- maxBufferRangeSize?: number
1730
- maxBufferProcessingWorkers?: number
1731
- keepDistanceFromTip?: number
1732
- filterFunction?: string
1733
- filterLanguage?: string
1734
- includeStreamMetadata?: string
1735
- productType?: string
1736
- notificationEmail?: string
1737
- fixBlockReorgs?: number
1738
- currentHash?: string
1739
- destinationAttributes?: any
1740
- elasticBatchEnabled?: boolean
1741
- qnAccountId?: string
1742
- chargeMinCap?: number
1743
- memo?: string
1744
- addressBookConfig?: AddressBookConfig
1745
- extraDestinations?: Array<any>
1746
- }
1747
- export interface ListStreamsResponseNode {
1748
- data: Array<StreamNode>
1749
- pageInfo: PageInfo
1750
- }
1751
- export interface CreateWebhookFromTemplateParamsNode {
1752
- name: string
1753
- network: string
1754
- notificationEmail?: string
1755
- destinationAttributes: WebhookDestinationAttributes
1756
- templateArgs: any
1813
+
1814
+ export interface WebhooksConfig {
1815
+ baseUrl?: string
1757
1816
  }
1758
- export interface UpdateWebhookTemplateParamsNode {
1759
- name?: string
1760
- notificationEmail?: string
1761
- destinationAttributes?: WebhookDestinationAttributes
1762
- 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'
1763
1824
  }
1764
- export declare class QuicknodeSdk {
1765
- /** Creates a new SDK instance from an explicit configuration. */
1766
- constructor(config: SdkFullConfig)
1767
- /** Returns the admin sub-client. */
1768
- get admin(): AdminApiClient
1769
- /** Returns the streams sub-client. */
1770
- get streams(): StreamsApiClient
1771
- /** Returns the webhooks sub-client. */
1772
- get webhooks(): WebhooksApiClient
1773
- /** Returns the kvstore sub-client. */
1774
- get kvstore(): KvStoreApiClient
1775
- /** Creates a new SDK instance using configuration from environment variables. */
1776
- static fromEnv(): QuicknodeSdk
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'
1836
+ }
1837
+
1838
+ /** Template arguments for an XRPL wallet filter. */
1839
+ export interface XrplWalletFilterTemplate {
1840
+ /** XRPL wallet addresses to match against. */
1841
+ wallets: Array<string>
1777
1842
  }
1778
1843
  export declare class AdminApiClient {
1779
1844
  /**
@@ -2091,6 +2156,66 @@ export declare class AdminApiClient {
2091
2156
  */
2092
2157
  getEndpointSecurity(id: string): Promise<GetEndpointSecurityResponse>
2093
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
+
2094
2219
  export declare class StreamsApiClient {
2095
2220
  /**
2096
2221
  * Creates a new Stream on a given blockchain network and dataset, delivering
@@ -2146,6 +2271,7 @@ export declare class StreamsApiClient {
2146
2271
  */
2147
2272
  getEnabledCount(streamType?: string | undefined | null): Promise<EnabledCountResponse>
2148
2273
  }
2274
+
2149
2275
  export declare class WebhooksApiClient {
2150
2276
  /**
2151
2277
  * Returns a paginated list of webhooks on the account. Each entry includes
@@ -2213,46 +2339,114 @@ export declare class WebhooksApiClient {
2213
2339
  */
2214
2340
  updateWebhookTemplate(webhookId: string, params: UpdateWebhookTemplateParamsNode): Promise<Webhook>
2215
2341
  }
2216
- export declare class KvStoreApiClient {
2217
- /** Creates a new set, storing a single string value under the given key. */
2218
- createSet(params: CreateSetParams): Promise<void>
2219
- /**
2220
- * Returns a paginated page of key/value entries from the store. Use the
2221
- * response `cursor` to fetch subsequent pages.
2222
- */
2223
- getSets(params?: GetSetsParams | undefined | null): Promise<GetSetsResponse>
2224
- /** Returns the string value stored for a single set by key. */
2225
- getSet(key: string): Promise<GetSetResponse>
2226
- /**
2227
- * Adds and removes multiple sets in a single request. Either `add_sets`,
2228
- * `delete_sets`, or both may be supplied.
2229
- */
2230
- bulkSets(params: BulkSetsParams): Promise<void>
2231
- /** Removes a single set by key. */
2232
- deleteSet(key: string): Promise<void>
2233
- /** Creates a new list under the given key, seeded with the provided items. */
2234
- createList(params: CreateListParams): Promise<void>
2235
- /**
2236
- * Returns a paginated page of list keys from the store. Use the response
2237
- * `cursor` to fetch subsequent pages.
2238
- */
2239
- getLists(params?: GetListsParams | undefined | null): Promise<GetListsResponse>
2240
- /**
2241
- * Returns a paginated page of items from the list identified by `key`.
2242
- * Use the response `cursor` to fetch subsequent pages.
2243
- */
2244
- getList(key: string, params?: GetListParams | undefined | null): Promise<GetListResponse>
2245
- /**
2246
- * Updates an existing list by adding and/or removing items in a single
2247
- * operation. Either `add_items`, `remove_items`, or both may be supplied.
2248
- */
2249
- updateList(key: string, params: UpdateListParams): Promise<void>
2250
- /** Appends a single item to the list identified by `key`. */
2251
- addListItem(key: string, params: AddListItemParams): Promise<void>
2252
- /** Checks whether the specified list contains the given item. */
2253
- listContainsItem(key: string, item: string): Promise<ListContainsItemResponse>
2254
- /** Removes a specific item from the list identified by `key`. */
2255
- deleteListItem(key: string, item: string): Promise<void>
2256
- /** Removes a list and all of its items by key. */
2257
- 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
2258
2452
  }