@quicknode/sdk 3.1.0-alpha.17 → 3.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +1582 -139
- package/index.d.ts +1562 -1359
- package/index.darwin-arm64.node +0 -0
- package/index.js +533 -269
- package/package.json +20 -12
- package/index.linux-arm64-gnu.node +0 -0
- package/index.linux-arm64-musl.node +0 -0
- package/index.linux-x64-gnu.node +0 -0
- package/index.linux-x64-musl.node +0 -0
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
|
-
/**
|
|
7
|
-
export interface
|
|
8
|
-
/**
|
|
9
|
-
|
|
10
|
-
/**
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
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
|
-
|
|
44
|
-
|
|
45
|
-
|
|
46
|
-
|
|
12
|
+
|
|
13
|
+
/** Parameters for `activate_webhook`. */
|
|
14
|
+
export interface ActivateWebhookParams {
|
|
15
|
+
/** Position to begin (or resume) delivery from. */
|
|
16
|
+
startFrom: WebhookStartFrom
|
|
47
17
|
}
|
|
48
|
-
|
|
49
|
-
|
|
50
|
-
|
|
51
|
-
|
|
52
|
-
|
|
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
|
-
|
|
64
|
-
|
|
65
|
-
|
|
66
|
-
|
|
67
|
-
|
|
68
|
-
|
|
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
|
-
|
|
71
|
-
export interface
|
|
72
|
-
|
|
73
|
-
payments: Array<Payment>
|
|
37
|
+
|
|
38
|
+
export interface AdminConfig {
|
|
39
|
+
baseUrl?: string
|
|
74
40
|
}
|
|
75
|
-
|
|
76
|
-
|
|
77
|
-
|
|
78
|
-
|
|
79
|
-
|
|
80
|
-
|
|
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
|
-
|
|
83
|
-
|
|
84
|
-
|
|
85
|
-
|
|
86
|
-
|
|
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
|
-
|
|
90
|
-
|
|
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
|
|
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
|
-
|
|
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
|
-
|
|
115
|
-
|
|
116
|
-
|
|
117
|
-
|
|
118
|
-
|
|
119
|
-
|
|
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
|
-
|
|
122
|
-
|
|
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
|
|
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
|
-
|
|
149
|
-
|
|
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
|
-
|
|
160
|
-
|
|
161
|
-
|
|
162
|
-
|
|
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
|
-
|
|
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
|
-
|
|
185
|
-
|
|
186
|
-
|
|
187
|
-
|
|
188
|
-
|
|
189
|
-
|
|
190
|
-
|
|
191
|
-
/**
|
|
192
|
-
|
|
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
|
-
|
|
199
|
-
|
|
200
|
-
|
|
201
|
-
|
|
202
|
-
|
|
203
|
-
|
|
204
|
-
|
|
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
|
-
|
|
208
|
-
|
|
209
|
-
|
|
210
|
-
|
|
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
|
-
|
|
219
|
-
|
|
220
|
-
|
|
221
|
-
|
|
222
|
-
|
|
223
|
-
|
|
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
|
-
|
|
226
|
-
|
|
227
|
-
|
|
228
|
-
|
|
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
|
-
|
|
233
|
-
|
|
234
|
-
|
|
235
|
-
|
|
236
|
-
|
|
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
|
-
|
|
248
|
-
|
|
249
|
-
|
|
250
|
-
|
|
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
|
-
|
|
253
|
-
|
|
254
|
-
|
|
255
|
-
|
|
256
|
-
|
|
257
|
-
|
|
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
|
-
|
|
276
|
-
|
|
277
|
-
|
|
278
|
-
|
|
279
|
-
|
|
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
|
-
|
|
285
|
-
|
|
286
|
-
|
|
287
|
-
|
|
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
|
-
|
|
292
|
-
|
|
293
|
-
|
|
294
|
-
|
|
295
|
-
|
|
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
|
-
|
|
301
|
-
|
|
302
|
-
|
|
303
|
-
|
|
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
|
-
|
|
307
|
-
|
|
308
|
-
|
|
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
|
-
|
|
325
|
-
|
|
326
|
-
|
|
327
|
-
|
|
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
|
-
|
|
330
|
-
|
|
331
|
-
|
|
332
|
-
|
|
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
|
-
|
|
337
|
-
|
|
338
|
-
|
|
339
|
-
|
|
340
|
-
|
|
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
|
-
|
|
346
|
-
|
|
347
|
-
|
|
348
|
-
|
|
349
|
-
|
|
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
|
-
|
|
459
|
-
|
|
460
|
-
|
|
461
|
-
|
|
462
|
-
|
|
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
|
-
|
|
512
|
-
|
|
513
|
-
|
|
514
|
-
|
|
515
|
-
|
|
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
|
-
|
|
521
|
-
|
|
522
|
-
|
|
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
|
-
|
|
557
|
-
|
|
558
|
-
|
|
559
|
-
|
|
560
|
-
|
|
561
|
-
|
|
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
|
-
|
|
564
|
-
|
|
565
|
-
|
|
566
|
-
|
|
567
|
-
|
|
568
|
-
|
|
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
|
-
|
|
571
|
-
|
|
572
|
-
|
|
573
|
-
|
|
574
|
-
|
|
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
|
-
|
|
578
|
-
|
|
579
|
-
|
|
441
|
+
|
|
442
|
+
/** JWT configured on an endpoint for signed-request authentication. */
|
|
443
|
+
export interface EndpointJwt {
|
|
444
|
+
/** JWT identifier. */
|
|
580
445
|
id: string
|
|
581
|
-
/**
|
|
582
|
-
|
|
583
|
-
/**
|
|
584
|
-
|
|
585
|
-
/**
|
|
586
|
-
|
|
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
|
-
|
|
603
|
-
|
|
604
|
-
|
|
605
|
-
|
|
606
|
-
|
|
607
|
-
|
|
608
|
-
|
|
609
|
-
|
|
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
|
-
|
|
654
|
-
|
|
655
|
-
|
|
656
|
-
|
|
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
|
-
|
|
666
|
-
|
|
667
|
-
|
|
668
|
-
|
|
669
|
-
|
|
670
|
-
|
|
671
|
-
|
|
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
|
-
|
|
698
|
-
|
|
699
|
-
|
|
700
|
-
|
|
701
|
-
|
|
702
|
-
|
|
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
|
-
|
|
705
|
-
|
|
706
|
-
|
|
707
|
-
|
|
708
|
-
|
|
709
|
-
|
|
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
|
-
|
|
712
|
-
|
|
713
|
-
|
|
714
|
-
|
|
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
|
-
|
|
717
|
-
|
|
718
|
-
|
|
719
|
-
|
|
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
|
-
|
|
722
|
-
|
|
723
|
-
|
|
724
|
-
|
|
725
|
-
|
|
726
|
-
|
|
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
|
-
|
|
729
|
-
|
|
730
|
-
|
|
731
|
-
|
|
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
|
-
|
|
734
|
-
|
|
735
|
-
|
|
736
|
-
|
|
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
|
-
|
|
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
|
-
|
|
789
|
-
|
|
790
|
-
|
|
791
|
-
|
|
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
|
-
|
|
794
|
-
|
|
795
|
-
|
|
796
|
-
|
|
797
|
-
|
|
798
|
-
|
|
799
|
-
|
|
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
|
-
|
|
808
|
-
|
|
809
|
-
|
|
810
|
-
|
|
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
|
-
|
|
815
|
-
|
|
816
|
-
|
|
817
|
-
|
|
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
|
-
|
|
820
|
-
|
|
821
|
-
|
|
822
|
-
|
|
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
|
-
|
|
827
|
-
|
|
828
|
-
|
|
829
|
-
|
|
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
|
-
|
|
832
|
-
|
|
833
|
-
|
|
834
|
-
|
|
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
|
-
|
|
839
|
-
|
|
840
|
-
|
|
841
|
-
|
|
842
|
-
|
|
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
|
-
|
|
858
|
-
|
|
859
|
-
|
|
860
|
-
|
|
861
|
-
|
|
862
|
-
|
|
863
|
-
|
|
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
|
-
|
|
869
|
-
|
|
870
|
-
|
|
871
|
-
|
|
872
|
-
|
|
873
|
-
|
|
874
|
-
|
|
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
|
-
|
|
884
|
-
|
|
885
|
-
|
|
886
|
-
|
|
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
|
-
|
|
891
|
-
|
|
892
|
-
|
|
893
|
-
|
|
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
|
-
|
|
896
|
-
|
|
897
|
-
|
|
898
|
-
|
|
899
|
-
|
|
900
|
-
|
|
901
|
-
|
|
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
|
-
|
|
907
|
-
|
|
908
|
-
|
|
909
|
-
|
|
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,86 @@ export interface GetTeamResponse {
|
|
|
917
875
|
/** Error message when the request did not succeed. */
|
|
918
876
|
error?: string
|
|
919
877
|
}
|
|
920
|
-
|
|
921
|
-
|
|
922
|
-
|
|
923
|
-
|
|
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
|
-
|
|
933
|
-
|
|
934
|
-
|
|
935
|
-
|
|
936
|
-
|
|
937
|
-
|
|
938
|
-
|
|
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
|
-
|
|
944
|
-
|
|
945
|
-
|
|
946
|
-
|
|
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
|
-
|
|
951
|
-
|
|
952
|
-
|
|
953
|
-
|
|
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
|
-
|
|
956
|
-
|
|
957
|
-
|
|
958
|
-
|
|
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
|
-
|
|
961
|
-
|
|
962
|
-
|
|
963
|
-
|
|
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
|
+
* Custom HTTP headers added to every outbound request.
|
|
943
|
+
*
|
|
944
|
+
* **These headers OVERRIDE any SDK-managed header with the same name**,
|
|
945
|
+
* including `User-Agent`, `x-api-key`, `Accept`, and `Content-Type`.
|
|
946
|
+
* Header names are matched case-insensitively. Use this to override the
|
|
947
|
+
* auto-generated User-Agent or inject correlation IDs, proxy auth, etc.
|
|
948
|
+
*/
|
|
949
|
+
headers?: Record<string, string>
|
|
950
|
+
}
|
|
951
|
+
|
|
952
|
+
/** Template arguments for a Hyperliquid wallet-events filter. */
|
|
953
|
+
export interface HyperliquidWalletEventsFilterTemplate {
|
|
954
|
+
/** Hyperliquid wallet addresses to match against. */
|
|
955
|
+
wallets: Array<string>
|
|
956
|
+
}
|
|
957
|
+
|
|
967
958
|
/** Parameters for `invite_team_member`. */
|
|
968
959
|
export interface InviteTeamMemberRequest {
|
|
969
960
|
/** Email address to invite. */
|
|
@@ -973,6 +964,7 @@ export interface InviteTeamMemberRequest {
|
|
|
973
964
|
/** Team role (`admin`, `viewer`, or `billing`); required for new users. */
|
|
974
965
|
role?: string
|
|
975
966
|
}
|
|
967
|
+
|
|
976
968
|
/** Response from `invite_team_member`. */
|
|
977
969
|
export interface InviteTeamMemberResponse {
|
|
978
970
|
/** The invited user and their invitation status. */
|
|
@@ -980,81 +972,205 @@ export interface InviteTeamMemberResponse {
|
|
|
980
972
|
/** Error message when the request did not succeed. */
|
|
981
973
|
error?: string
|
|
982
974
|
}
|
|
983
|
-
|
|
984
|
-
|
|
985
|
-
|
|
986
|
-
|
|
975
|
+
|
|
976
|
+
/** An invoice issued to the account. */
|
|
977
|
+
export interface Invoice {
|
|
978
|
+
/** Unique invoice identifier. */
|
|
979
|
+
id: string
|
|
980
|
+
/** Payment status (e.g. `paid`, `open`). */
|
|
981
|
+
status: string
|
|
982
|
+
/** Reason the invoice was generated (e.g. `subscription_cycle`). */
|
|
983
|
+
billingReason: string
|
|
984
|
+
/** Line items contributing to the invoice total. */
|
|
985
|
+
lines: Array<InvoiceLine>
|
|
986
|
+
/** Amount due in the smallest currency unit. */
|
|
987
|
+
amountDue: number
|
|
988
|
+
/** Amount already paid in the smallest currency unit. */
|
|
989
|
+
amountPaid: number
|
|
990
|
+
/** Start of the billing period (Unix timestamp). */
|
|
991
|
+
periodStart: number
|
|
992
|
+
/** End of the billing period (Unix timestamp). */
|
|
993
|
+
periodEnd: number
|
|
994
|
+
/** Timestamp when the invoice was created (Unix timestamp). */
|
|
995
|
+
created: number
|
|
996
|
+
/** Subtotal before taxes and adjustments. */
|
|
997
|
+
subtotal: number
|
|
987
998
|
}
|
|
988
|
-
|
|
989
|
-
|
|
990
|
-
|
|
991
|
-
|
|
999
|
+
|
|
1000
|
+
/** A single line item on an invoice. */
|
|
1001
|
+
export interface InvoiceLine {
|
|
1002
|
+
/** Human-readable description of the line item. */
|
|
1003
|
+
description: string
|
|
1004
|
+
/** Line item amount in the smallest currency unit. */
|
|
1005
|
+
amount: number
|
|
992
1006
|
}
|
|
993
|
-
|
|
994
|
-
|
|
995
|
-
|
|
996
|
-
|
|
1007
|
+
|
|
1008
|
+
/** Data wrapper for the IP custom header configuration. */
|
|
1009
|
+
export interface IpCustomHeaderData {
|
|
1010
|
+
/** Configured header name. */
|
|
1011
|
+
headerName: string
|
|
1012
|
+
}
|
|
1013
|
+
|
|
1014
|
+
/** Configuration for delivering stream batches to a Kafka topic. */
|
|
1015
|
+
export interface KafkaAttributes {
|
|
1016
|
+
/** Comma-separated list of Kafka broker addresses (host:port). */
|
|
1017
|
+
bootstrapServers: string
|
|
1018
|
+
/** Destination topic. */
|
|
1019
|
+
topicName: string
|
|
1020
|
+
/** Compression codec applied to produced messages (e.g. `none`, `gzip`). */
|
|
1021
|
+
compressionType: string
|
|
1022
|
+
/** Maximum number of messages grouped per produce request. */
|
|
1023
|
+
batchSize: number
|
|
1024
|
+
/** Milliseconds the producer waits to batch additional messages. */
|
|
1025
|
+
lingerMs: number
|
|
1026
|
+
/** Maximum size in bytes of a single Kafka message (`max_message_bytes`). */
|
|
1027
|
+
maxMessageBytes: number
|
|
1028
|
+
/** Request timeout in seconds. */
|
|
1029
|
+
timeoutSec: number
|
|
1030
|
+
/** Maximum number of retry attempts for a failed produce. */
|
|
1031
|
+
maxRetry: number
|
|
1032
|
+
/** Seconds to wait between retry attempts. */
|
|
1033
|
+
retryIntervalSec: number
|
|
1034
|
+
/** Optional SASL username. */
|
|
1035
|
+
username?: string
|
|
1036
|
+
/** Optional SASL password. */
|
|
1037
|
+
password?: string
|
|
1038
|
+
/** Optional security protocol (e.g. `SASL_SSL`). */
|
|
1039
|
+
protocol?: string
|
|
1040
|
+
/** Optional SASL mechanism (e.g. `PLAIN`, `SCRAM-SHA-256`). */
|
|
1041
|
+
mechanisms?: string
|
|
1042
|
+
}
|
|
1043
|
+
|
|
1044
|
+
/** A single key/value entry returned by `get_sets`. */
|
|
1045
|
+
export interface KvSetEntry {
|
|
1046
|
+
/** Key identifying the set. */
|
|
1047
|
+
key: string
|
|
1048
|
+
/** Stored string value. */
|
|
1049
|
+
value: string
|
|
1050
|
+
}
|
|
1051
|
+
|
|
1052
|
+
export interface KvStoreConfig {
|
|
1053
|
+
baseUrl?: string
|
|
1054
|
+
}
|
|
1055
|
+
|
|
1056
|
+
/** Response from `list_chains`. */
|
|
1057
|
+
export interface ListChainsResponse {
|
|
1058
|
+
/** Supported chains and their networks. */
|
|
1059
|
+
data: Array<Chain>
|
|
997
1060
|
/** Error message when the request did not succeed. */
|
|
998
1061
|
error?: string
|
|
999
1062
|
}
|
|
1000
|
-
|
|
1001
|
-
|
|
1002
|
-
|
|
1003
|
-
|
|
1063
|
+
|
|
1064
|
+
/** Response from `list_contains_item`. */
|
|
1065
|
+
export interface ListContainsItemResponse {
|
|
1066
|
+
/** `true` when the item is present in the list. */
|
|
1067
|
+
exists: boolean
|
|
1068
|
+
}
|
|
1069
|
+
|
|
1070
|
+
/** Invoice list wrapper. */
|
|
1071
|
+
export interface ListInvoicesData {
|
|
1072
|
+
/** Invoices on the account. */
|
|
1073
|
+
invoices: Array<Invoice>
|
|
1074
|
+
}
|
|
1075
|
+
|
|
1076
|
+
/** Response from `list_invoices`. */
|
|
1077
|
+
export interface ListInvoicesResponse {
|
|
1078
|
+
/** Invoice data payload. */
|
|
1079
|
+
data?: ListInvoicesData
|
|
1004
1080
|
/** Error message when the request did not succeed. */
|
|
1005
1081
|
error?: string
|
|
1006
1082
|
}
|
|
1007
|
-
|
|
1008
|
-
|
|
1009
|
-
|
|
1010
|
-
*/
|
|
1011
|
-
|
|
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
|
|
1083
|
+
|
|
1084
|
+
/** Payment list wrapper. */
|
|
1085
|
+
export interface ListPaymentsData {
|
|
1086
|
+
/** Payments on the account. */
|
|
1087
|
+
payments: Array<Payment>
|
|
1031
1088
|
}
|
|
1032
|
-
|
|
1033
|
-
|
|
1034
|
-
|
|
1035
|
-
data
|
|
1089
|
+
|
|
1090
|
+
/** Response from `list_payments`. */
|
|
1091
|
+
export interface ListPaymentsResponse {
|
|
1092
|
+
/** Payment data payload. */
|
|
1093
|
+
data?: ListPaymentsData
|
|
1036
1094
|
/** Error message when the request did not succeed. */
|
|
1037
1095
|
error?: string
|
|
1038
1096
|
}
|
|
1039
|
-
|
|
1040
|
-
|
|
1041
|
-
|
|
1042
|
-
|
|
1043
|
-
|
|
1044
|
-
|
|
1045
|
-
|
|
1046
|
-
|
|
1047
|
-
|
|
1048
|
-
|
|
1049
|
-
|
|
1050
|
-
|
|
1051
|
-
|
|
1052
|
-
|
|
1053
|
-
|
|
1054
|
-
|
|
1055
|
-
|
|
1056
|
-
|
|
1097
|
+
|
|
1098
|
+
/** Parameters for `list_streams`. */
|
|
1099
|
+
export interface ListStreamsParams {
|
|
1100
|
+
/** Filter results by stream type. */
|
|
1101
|
+
streamType?: string
|
|
1102
|
+
/** Starting index into the result set; defaults to 0. */
|
|
1103
|
+
offset?: number
|
|
1104
|
+
/** Maximum number of streams returned. */
|
|
1105
|
+
limit?: number
|
|
1106
|
+
/** Field to sort results by. */
|
|
1107
|
+
orderBy?: string
|
|
1108
|
+
/** Sort direction (`asc` or `desc`). */
|
|
1109
|
+
orderDirection?: string
|
|
1110
|
+
}
|
|
1111
|
+
|
|
1112
|
+
/** Inner data wrapper for `list_tags`. */
|
|
1113
|
+
export interface ListTagsData {
|
|
1114
|
+
/** Tags on the account. */
|
|
1115
|
+
tags: Array<AccountTag>
|
|
1116
|
+
}
|
|
1117
|
+
|
|
1118
|
+
/** Response from `list_tags`. */
|
|
1119
|
+
export interface ListTagsResponse {
|
|
1120
|
+
/** Account tags payload. */
|
|
1121
|
+
data?: ListTagsData
|
|
1122
|
+
/** Error message when the request did not succeed. */
|
|
1123
|
+
error?: string
|
|
1124
|
+
}
|
|
1125
|
+
|
|
1126
|
+
/** Response from `list_team_endpoints`. */
|
|
1127
|
+
export interface ListTeamEndpointsResponse {
|
|
1128
|
+
/** Endpoints accessible to the team. */
|
|
1129
|
+
data: Array<TeamEndpoint>
|
|
1130
|
+
/** Error message when the request did not succeed. */
|
|
1131
|
+
error?: string
|
|
1132
|
+
}
|
|
1133
|
+
|
|
1134
|
+
/** Response from `list_teams`. */
|
|
1135
|
+
export interface ListTeamsResponse {
|
|
1136
|
+
/** Teams on the account. */
|
|
1137
|
+
data: Array<TeamSummary>
|
|
1138
|
+
/** Error message when the request did not succeed. */
|
|
1139
|
+
error?: string
|
|
1140
|
+
}
|
|
1141
|
+
|
|
1142
|
+
/** Response from `list_webhooks`. */
|
|
1143
|
+
export interface ListWebhooksResponse {
|
|
1144
|
+
/** Webhooks on the current page. */
|
|
1145
|
+
data: Array<Webhook>
|
|
1146
|
+
/** Pagination metadata for the response. */
|
|
1147
|
+
pageInfo: WebhookPageInfo
|
|
1148
|
+
}
|
|
1149
|
+
|
|
1150
|
+
/** Raw request/response payloads attached to a log entry. */
|
|
1151
|
+
export interface LogDetails {
|
|
1152
|
+
/** JSON-encoded request body (truncated at 2KB). */
|
|
1153
|
+
request?: string
|
|
1154
|
+
/** JSON-encoded response body (truncated at 2KB). */
|
|
1155
|
+
response?: string
|
|
1156
|
+
}
|
|
1157
|
+
|
|
1158
|
+
/** A per-method rate limiter configured on an endpoint. */
|
|
1159
|
+
export interface MethodRateLimiter {
|
|
1160
|
+
/** Rate limiter identifier. */
|
|
1161
|
+
id: string
|
|
1162
|
+
/** Interval over which the rate applies (e.g. `second`, `minute`). */
|
|
1163
|
+
interval: string
|
|
1164
|
+
/** RPC methods the limiter applies to. */
|
|
1165
|
+
methods: Array<string>
|
|
1166
|
+
/** Maximum number of calls allowed per interval. */
|
|
1167
|
+
rate: number
|
|
1168
|
+
/** Whether the limiter is `enabled` or `disabled`. */
|
|
1169
|
+
status: string
|
|
1170
|
+
/** Creation timestamp. */
|
|
1171
|
+
created: string
|
|
1057
1172
|
}
|
|
1173
|
+
|
|
1058
1174
|
/** Per-method usage row. */
|
|
1059
1175
|
export interface MethodUsage {
|
|
1060
1176
|
/** RPC method name. */
|
|
@@ -1068,222 +1184,259 @@ export interface MethodUsage {
|
|
|
1068
1184
|
/** Chain the calls targeted. */
|
|
1069
1185
|
chain?: string
|
|
1070
1186
|
}
|
|
1071
|
-
|
|
1072
|
-
|
|
1073
|
-
|
|
1074
|
-
|
|
1075
|
-
|
|
1076
|
-
|
|
1077
|
-
|
|
1078
|
-
/**
|
|
1079
|
-
|
|
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
|
|
1187
|
+
|
|
1188
|
+
/** Pagination metadata returned alongside a paginated result set. */
|
|
1189
|
+
export interface PageInfo {
|
|
1190
|
+
/** Page size used for this response. */
|
|
1191
|
+
limit: number
|
|
1192
|
+
/** Starting index of this page within the full result set. */
|
|
1193
|
+
offset: number
|
|
1194
|
+
/** Total number of items matching the query across all pages. */
|
|
1195
|
+
total: number
|
|
1086
1196
|
}
|
|
1087
|
-
|
|
1088
|
-
|
|
1089
|
-
|
|
1090
|
-
|
|
1091
|
-
|
|
1092
|
-
|
|
1197
|
+
|
|
1198
|
+
/** Pagination metadata for admin list responses. */
|
|
1199
|
+
export interface Pagination {
|
|
1200
|
+
/** Total number of items matching the query across all pages. */
|
|
1201
|
+
total: number
|
|
1202
|
+
/** Page size used for this response. */
|
|
1203
|
+
limit: number
|
|
1204
|
+
/** Starting index of this page within the full result set. */
|
|
1205
|
+
offset: number
|
|
1093
1206
|
}
|
|
1094
|
-
|
|
1095
|
-
|
|
1096
|
-
|
|
1097
|
-
|
|
1098
|
-
|
|
1099
|
-
|
|
1100
|
-
|
|
1101
|
-
|
|
1207
|
+
|
|
1208
|
+
/** A payment recorded on the account. */
|
|
1209
|
+
export interface Payment {
|
|
1210
|
+
/** Payment amount as a string in the account's currency. */
|
|
1211
|
+
amount: string
|
|
1212
|
+
/** Last four digits of the card used for the payment. */
|
|
1213
|
+
cardLast4?: string
|
|
1214
|
+
/** Timestamp when the payment was recorded. */
|
|
1215
|
+
createdAt: string
|
|
1216
|
+
/** Currency code (e.g. `usd`). */
|
|
1217
|
+
currency: string
|
|
1218
|
+
/** Payment status. */
|
|
1219
|
+
status: string
|
|
1220
|
+
/** Portion of the payment attributed to marketplace spending. */
|
|
1221
|
+
marketplaceAmount?: string
|
|
1102
1222
|
}
|
|
1103
|
-
|
|
1104
|
-
|
|
1105
|
-
|
|
1106
|
-
|
|
1107
|
-
|
|
1108
|
-
|
|
1223
|
+
|
|
1224
|
+
/** Configuration for delivering stream batches to a PostgreSQL database. */
|
|
1225
|
+
export interface PostgresAttributes {
|
|
1226
|
+
/** Database host. */
|
|
1227
|
+
host: string
|
|
1228
|
+
/** Database port. */
|
|
1229
|
+
port: number
|
|
1230
|
+
/** Database name. */
|
|
1231
|
+
database: string
|
|
1232
|
+
/** Username used to authenticate. */
|
|
1233
|
+
username: string
|
|
1234
|
+
/** Password used to authenticate. */
|
|
1235
|
+
password: string
|
|
1236
|
+
/** Destination table for inserted rows. */
|
|
1237
|
+
tableName: string
|
|
1238
|
+
/** Postgres SSL mode. The Quicknode API accepts only `disable` or `require`. */
|
|
1239
|
+
sslmode: string
|
|
1240
|
+
/** Maximum number of retry attempts for a failed write. */
|
|
1241
|
+
maxRetry: number
|
|
1242
|
+
/** Seconds to wait between retry attempts. */
|
|
1243
|
+
retryIntervalSec: number
|
|
1109
1244
|
}
|
|
1110
|
-
|
|
1111
|
-
|
|
1112
|
-
|
|
1113
|
-
|
|
1114
|
-
|
|
1115
|
-
startTime?: number
|
|
1116
|
-
/** End of the queried window. */
|
|
1117
|
-
endTime?: number
|
|
1245
|
+
|
|
1246
|
+
/** Billing product type the stream is associated with. */
|
|
1247
|
+
export declare const enum ProductType {
|
|
1248
|
+
Stream = 'Stream',
|
|
1249
|
+
Webhook = 'Webhook'
|
|
1118
1250
|
}
|
|
1119
|
-
|
|
1120
|
-
|
|
1121
|
-
|
|
1122
|
-
|
|
1123
|
-
|
|
1124
|
-
|
|
1251
|
+
|
|
1252
|
+
/**
|
|
1253
|
+
* A single rate-limit row returned by `get_rate_limits`, identifying the
|
|
1254
|
+
* bucket (`rps`/`rpm`/`rpd`), the value enforced, and whether the value comes
|
|
1255
|
+
* from the plan default or a user-set override.
|
|
1256
|
+
*/
|
|
1257
|
+
export interface RateLimitEntry {
|
|
1258
|
+
/** Which bucket this row applies to: `rps`, `rpm`, or `rpd`. */
|
|
1259
|
+
bucket: string
|
|
1260
|
+
/** The enforced value for this bucket. */
|
|
1261
|
+
rateLimit: number
|
|
1262
|
+
/** Where the value comes from: `plan_default` or `user_override`. */
|
|
1263
|
+
source: string
|
|
1264
|
+
/**
|
|
1265
|
+
* Row identifier. Present on `user_override` rows — pass it to
|
|
1266
|
+
* `delete_rate_limit_override` to remove the override. May be absent on
|
|
1267
|
+
* `plan_default` rows and cannot be deleted there.
|
|
1268
|
+
*/
|
|
1269
|
+
id?: string
|
|
1125
1270
|
}
|
|
1126
|
-
|
|
1127
|
-
|
|
1128
|
-
|
|
1129
|
-
|
|
1130
|
-
|
|
1131
|
-
|
|
1132
|
-
|
|
1133
|
-
|
|
1134
|
-
|
|
1135
|
-
requests: number
|
|
1271
|
+
|
|
1272
|
+
/** Endpoint-wide rate limit settings. */
|
|
1273
|
+
export interface RateLimitSettings {
|
|
1274
|
+
/** Requests per second. */
|
|
1275
|
+
rps?: number
|
|
1276
|
+
/** Requests per minute. */
|
|
1277
|
+
rpm?: number
|
|
1278
|
+
/** Requests per day. */
|
|
1279
|
+
rpd?: number
|
|
1136
1280
|
}
|
|
1137
|
-
|
|
1138
|
-
|
|
1139
|
-
|
|
1140
|
-
|
|
1141
|
-
|
|
1142
|
-
startTime?: number
|
|
1143
|
-
/** End of the queried window. */
|
|
1144
|
-
endTime?: number
|
|
1281
|
+
|
|
1282
|
+
/** Parameters for `remove_team_member`. */
|
|
1283
|
+
export interface RemoveTeamMemberRequest {
|
|
1284
|
+
/** When true, also delete the user entirely rather than just removing them from the team. */
|
|
1285
|
+
destroyUser?: boolean
|
|
1145
1286
|
}
|
|
1146
|
-
|
|
1147
|
-
|
|
1148
|
-
|
|
1149
|
-
|
|
1287
|
+
|
|
1288
|
+
/** Response from `remove_team_member`. */
|
|
1289
|
+
export interface RemoveTeamMemberResponse {
|
|
1290
|
+
/** Operation result message. */
|
|
1291
|
+
data?: TeamMessageData
|
|
1150
1292
|
/** Error message when the request did not succeed. */
|
|
1151
1293
|
error?: string
|
|
1152
1294
|
}
|
|
1153
|
-
|
|
1154
|
-
|
|
1155
|
-
|
|
1156
|
-
|
|
1157
|
-
|
|
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
|
|
1295
|
+
|
|
1296
|
+
/** Parameters for `rename_tag`. */
|
|
1297
|
+
export interface RenameTagRequest {
|
|
1298
|
+
/** New label for the tag. */
|
|
1299
|
+
label: string
|
|
1230
1300
|
}
|
|
1231
|
-
|
|
1232
|
-
|
|
1233
|
-
|
|
1234
|
-
|
|
1235
|
-
|
|
1236
|
-
|
|
1301
|
+
|
|
1302
|
+
/** Response from `rename_tag`. */
|
|
1303
|
+
export interface RenameTagResponse {
|
|
1304
|
+
/** The renamed tag. */
|
|
1305
|
+
data?: AccountTag
|
|
1306
|
+
/** Error message when the request did not succeed. */
|
|
1307
|
+
error?: string
|
|
1237
1308
|
}
|
|
1238
|
-
|
|
1239
|
-
|
|
1240
|
-
|
|
1241
|
-
|
|
1242
|
-
|
|
1243
|
-
|
|
1309
|
+
|
|
1310
|
+
/** Response from `resend_team_invite`. */
|
|
1311
|
+
export interface ResendTeamInviteResponse {
|
|
1312
|
+
/** Operation result message. */
|
|
1313
|
+
data?: TeamMessageData
|
|
1314
|
+
/** Error message when the request did not succeed. */
|
|
1315
|
+
error?: string
|
|
1244
1316
|
}
|
|
1245
|
-
|
|
1246
|
-
|
|
1247
|
-
|
|
1248
|
-
|
|
1317
|
+
|
|
1318
|
+
/** Configuration for delivering stream batches to an S3-compatible object store. */
|
|
1319
|
+
export interface S3Attributes {
|
|
1320
|
+
/** S3 service endpoint (e.g. `s3.amazonaws.com`). */
|
|
1321
|
+
endpoint: string
|
|
1322
|
+
/** Access key used to authenticate with the S3 endpoint. */
|
|
1323
|
+
accessKey: string
|
|
1324
|
+
/** Secret key used to authenticate with the S3 endpoint. */
|
|
1325
|
+
secretKey: string
|
|
1326
|
+
/** Target bucket name. */
|
|
1327
|
+
bucket: string
|
|
1328
|
+
/** Key prefix prepended to each written object. */
|
|
1329
|
+
objectPrefix: string
|
|
1330
|
+
/** Compression applied to written objects (e.g. `none`, `gzip`). */
|
|
1331
|
+
compression: string
|
|
1332
|
+
/** File format/extension for written objects (e.g. `.json`). */
|
|
1333
|
+
fileType: string
|
|
1334
|
+
/** Maximum number of retry attempts for a failed write. */
|
|
1335
|
+
maxRetry: number
|
|
1336
|
+
/** Seconds to wait between retry attempts. */
|
|
1337
|
+
retryIntervalSec: number
|
|
1338
|
+
/** Whether to use TLS when connecting to the endpoint. */
|
|
1339
|
+
useSsl?: boolean
|
|
1249
1340
|
}
|
|
1250
|
-
|
|
1251
|
-
export interface
|
|
1252
|
-
|
|
1253
|
-
|
|
1341
|
+
|
|
1342
|
+
export interface SdkFullConfig {
|
|
1343
|
+
apiKey: string
|
|
1344
|
+
http?: HttpConfig
|
|
1345
|
+
admin?: AdminConfig
|
|
1346
|
+
streams?: StreamsConfig
|
|
1347
|
+
webhooks?: WebhooksConfig
|
|
1348
|
+
kvstore?: KvStoreConfig
|
|
1254
1349
|
}
|
|
1255
|
-
|
|
1256
|
-
|
|
1257
|
-
|
|
1258
|
-
|
|
1259
|
-
|
|
1260
|
-
|
|
1350
|
+
|
|
1351
|
+
/** A single security feature's name, status, and optional value. */
|
|
1352
|
+
export interface SecurityOption {
|
|
1353
|
+
/** Name of the security feature (e.g. `tokens`, `jwts`, `ips`). */
|
|
1354
|
+
option: string
|
|
1355
|
+
/** Whether the feature is `enabled` or `disabled`. */
|
|
1356
|
+
status: string
|
|
1357
|
+
/** Optional configuration value associated with the feature. */
|
|
1358
|
+
value?: string
|
|
1261
1359
|
}
|
|
1262
|
-
|
|
1263
|
-
|
|
1264
|
-
|
|
1265
|
-
|
|
1360
|
+
|
|
1361
|
+
/**
|
|
1362
|
+
* Per-feature toggles for `update_security_options`. Each field accepts
|
|
1363
|
+
* `enabled` or `disabled`.
|
|
1364
|
+
*/
|
|
1365
|
+
export interface SecurityOptionsUpdate {
|
|
1366
|
+
/** Token authentication toggle. */
|
|
1367
|
+
tokens?: string
|
|
1368
|
+
/** Referrer validation toggle. */
|
|
1369
|
+
referrers?: string
|
|
1370
|
+
/** JWT validation toggle. */
|
|
1371
|
+
jwts?: string
|
|
1372
|
+
/** IP whitelist toggle. */
|
|
1373
|
+
ips?: string
|
|
1374
|
+
/** Domain masking toggle. */
|
|
1375
|
+
domainMasks?: string
|
|
1376
|
+
/** HSTS (HTTP Strict Transport Security) toggle. */
|
|
1377
|
+
hsts?: string
|
|
1378
|
+
/** CORS toggle. */
|
|
1379
|
+
cors?: string
|
|
1380
|
+
/** Request (method) filter toggle. */
|
|
1381
|
+
requestFilters?: string
|
|
1382
|
+
/** Custom IP header toggle. */
|
|
1383
|
+
ipCustomHeader?: string
|
|
1266
1384
|
}
|
|
1267
|
-
|
|
1268
|
-
|
|
1269
|
-
|
|
1270
|
-
|
|
1271
|
-
|
|
1272
|
-
|
|
1385
|
+
|
|
1386
|
+
/** Response from `show_endpoint`. */
|
|
1387
|
+
export interface ShowEndpointResponse {
|
|
1388
|
+
/** The endpoint, when found. */
|
|
1389
|
+
data?: SingleEndpoint
|
|
1390
|
+
/** Error message when the request did not succeed. */
|
|
1391
|
+
error?: string
|
|
1273
1392
|
}
|
|
1274
|
-
|
|
1275
|
-
|
|
1276
|
-
|
|
1277
|
-
|
|
1393
|
+
|
|
1394
|
+
/** Full representation of a single endpoint, including its security and rate limits. */
|
|
1395
|
+
export interface SingleEndpoint {
|
|
1396
|
+
/** Unique endpoint identifier. */
|
|
1397
|
+
id: string
|
|
1398
|
+
/** Human-readable label. */
|
|
1399
|
+
label?: string
|
|
1400
|
+
/** Current operational status. */
|
|
1401
|
+
status?: string
|
|
1402
|
+
/** Blockchain the endpoint serves. */
|
|
1403
|
+
chain: string
|
|
1404
|
+
/** Specific network within the chain. */
|
|
1405
|
+
network: string
|
|
1406
|
+
/** HTTP RPC URL. */
|
|
1407
|
+
httpUrl: string
|
|
1408
|
+
/** WebSocket RPC URL, when available. */
|
|
1409
|
+
wssUrl?: string
|
|
1410
|
+
/** Endpoint security configuration. */
|
|
1411
|
+
security?: EndpointSecurity
|
|
1412
|
+
/** Endpoint rate limits. */
|
|
1413
|
+
rateLimits?: EndpointRateLimits
|
|
1414
|
+
/** Tags applied to the endpoint. */
|
|
1415
|
+
tags: Array<EndpointTag>
|
|
1416
|
+
/** Whether the endpoint is configured to serve multiple chains/networks. */
|
|
1417
|
+
isMultichain: boolean
|
|
1278
1418
|
}
|
|
1279
|
-
|
|
1280
|
-
|
|
1281
|
-
|
|
1282
|
-
|
|
1283
|
-
|
|
1419
|
+
|
|
1420
|
+
/**
|
|
1421
|
+
* Template arguments for a Solana wallet filter: matches activity for a list
|
|
1422
|
+
* of Solana account addresses.
|
|
1423
|
+
*/
|
|
1424
|
+
export interface SolanaWalletFilterTemplate {
|
|
1425
|
+
/** Solana account addresses to match against. */
|
|
1426
|
+
accounts: Array<string>
|
|
1427
|
+
}
|
|
1428
|
+
|
|
1429
|
+
/**
|
|
1430
|
+
* Template arguments for a Stellar wallet-transactions filter, matching
|
|
1431
|
+
* transactions where the given wallets are the source account.
|
|
1432
|
+
*/
|
|
1433
|
+
export interface StellarWalletTransactionsFilterTemplate {
|
|
1434
|
+
/** Stellar wallet addresses to match against. */
|
|
1435
|
+
wallets: Array<string>
|
|
1284
1436
|
}
|
|
1437
|
+
|
|
1285
1438
|
/** Type of on-chain data a stream delivers (blocks, transactions, logs, etc.). */
|
|
1286
|
-
export const enum StreamDataset {
|
|
1439
|
+
export declare const enum StreamDataset {
|
|
1287
1440
|
Block = 'Block',
|
|
1288
1441
|
BlockWithReceipts = 'BlockWithReceipts',
|
|
1289
1442
|
Transactions = 'Transactions',
|
|
@@ -1303,180 +1456,121 @@ export const enum StreamDataset {
|
|
|
1303
1456
|
Twap = 'Twap',
|
|
1304
1457
|
WriterActions = 'WriterActions'
|
|
1305
1458
|
}
|
|
1459
|
+
|
|
1306
1460
|
/** Destination kind a stream delivers to (webhook, S3, Postgres, etc.). */
|
|
1307
|
-
export const enum StreamDestination {
|
|
1461
|
+
export declare const enum StreamDestination {
|
|
1308
1462
|
Webhook = 'Webhook',
|
|
1309
1463
|
S3 = 'S3',
|
|
1310
1464
|
Azure = 'Azure',
|
|
1311
1465
|
Postgres = 'Postgres',
|
|
1312
1466
|
Kafka = 'Kafka'
|
|
1313
1467
|
}
|
|
1314
|
-
|
|
1315
|
-
export const enum FilterLanguage {
|
|
1316
|
-
Javascript = 'Javascript',
|
|
1317
|
-
Go = 'Go',
|
|
1318
|
-
Wasm = 'Wasm'
|
|
1319
|
-
}
|
|
1468
|
+
|
|
1320
1469
|
/** Where stream metadata is included in delivered payloads. */
|
|
1321
|
-
export const enum StreamMetadataLocation {
|
|
1470
|
+
export declare const enum StreamMetadataLocation {
|
|
1322
1471
|
Body = 'Body',
|
|
1323
1472
|
Header = 'Header',
|
|
1324
1473
|
None = 'None'
|
|
1325
1474
|
}
|
|
1326
|
-
|
|
1327
|
-
|
|
1328
|
-
|
|
1329
|
-
|
|
1475
|
+
|
|
1476
|
+
/** Geographic region where a stream runs. */
|
|
1477
|
+
export declare const enum StreamRegion {
|
|
1478
|
+
UsaEast = 'UsaEast',
|
|
1479
|
+
EuropeCentral = 'EuropeCentral',
|
|
1480
|
+
AsiaEast = 'AsiaEast'
|
|
1481
|
+
}
|
|
1482
|
+
|
|
1483
|
+
export interface StreamsConfig {
|
|
1484
|
+
baseUrl?: string
|
|
1330
1485
|
}
|
|
1486
|
+
|
|
1331
1487
|
/** Operational state of a stream. */
|
|
1332
|
-
export const enum StreamStatus {
|
|
1488
|
+
export declare const enum StreamStatus {
|
|
1333
1489
|
Active = 'Active',
|
|
1334
1490
|
Paused = 'Paused',
|
|
1335
1491
|
Terminated = 'Terminated',
|
|
1336
1492
|
Completed = 'Completed',
|
|
1337
1493
|
Blocked = 'Blocked'
|
|
1338
1494
|
}
|
|
1339
|
-
|
|
1340
|
-
|
|
1341
|
-
|
|
1342
|
-
|
|
1343
|
-
|
|
1344
|
-
|
|
1345
|
-
|
|
1346
|
-
|
|
1347
|
-
|
|
1348
|
-
|
|
1349
|
-
|
|
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
|
|
1495
|
+
|
|
1496
|
+
/** Per-tag usage row. */
|
|
1497
|
+
export interface TagUsage {
|
|
1498
|
+
/** Tag identifier. */
|
|
1499
|
+
tagId?: number
|
|
1500
|
+
/** Tag label. */
|
|
1501
|
+
label: string
|
|
1502
|
+
/** Credits consumed by endpoints with this tag. */
|
|
1503
|
+
creditsUsed: number
|
|
1504
|
+
/** Request count during the window. */
|
|
1505
|
+
requests: number
|
|
1395
1506
|
}
|
|
1396
|
-
|
|
1397
|
-
|
|
1398
|
-
|
|
1399
|
-
|
|
1400
|
-
|
|
1401
|
-
|
|
1402
|
-
|
|
1403
|
-
|
|
1404
|
-
|
|
1405
|
-
|
|
1406
|
-
|
|
1407
|
-
|
|
1408
|
-
|
|
1409
|
-
|
|
1410
|
-
|
|
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
|
|
1507
|
+
|
|
1508
|
+
/** Full team detail including pending invites. */
|
|
1509
|
+
export interface TeamDetail {
|
|
1510
|
+
/** Team identifier. */
|
|
1511
|
+
id: number
|
|
1512
|
+
/** Team name. */
|
|
1513
|
+
name: string
|
|
1514
|
+
/** Default role assigned to newly invited members. */
|
|
1515
|
+
defaultRole?: string
|
|
1516
|
+
/** Current member count. */
|
|
1517
|
+
membersCount?: number
|
|
1518
|
+
/** Active team members. */
|
|
1519
|
+
users: Array<TeamUser>
|
|
1520
|
+
/** Invites that have not yet been accepted. */
|
|
1521
|
+
pendingInvites: Array<TeamUser>
|
|
1416
1522
|
}
|
|
1417
|
-
|
|
1418
|
-
|
|
1419
|
-
|
|
1420
|
-
|
|
1421
|
-
|
|
1422
|
-
|
|
1423
|
-
|
|
1424
|
-
|
|
1425
|
-
|
|
1426
|
-
|
|
1427
|
-
|
|
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
|
|
1523
|
+
|
|
1524
|
+
/** A team's endpoint association. */
|
|
1525
|
+
export interface TeamEndpoint {
|
|
1526
|
+
/** Endpoint identifier. */
|
|
1527
|
+
id: number
|
|
1528
|
+
/** Endpoint subdomain. */
|
|
1529
|
+
subdomain: string
|
|
1530
|
+
/** Blockchain the endpoint serves. */
|
|
1531
|
+
chain?: string
|
|
1532
|
+
/** Network within the chain. */
|
|
1533
|
+
network?: string
|
|
1445
1534
|
}
|
|
1446
|
-
|
|
1447
|
-
|
|
1448
|
-
|
|
1449
|
-
*/
|
|
1450
|
-
|
|
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>
|
|
1535
|
+
|
|
1536
|
+
/** Shared message-shaped data wrapper for team operations. */
|
|
1537
|
+
export interface TeamMessageData {
|
|
1538
|
+
/** Human-readable confirmation message. */
|
|
1539
|
+
message?: string
|
|
1457
1540
|
}
|
|
1458
|
-
|
|
1459
|
-
|
|
1460
|
-
|
|
1461
|
-
|
|
1462
|
-
|
|
1463
|
-
|
|
1464
|
-
|
|
1465
|
-
|
|
1541
|
+
|
|
1542
|
+
/** Summary representation of a team in list responses. */
|
|
1543
|
+
export interface TeamSummary {
|
|
1544
|
+
/** Team identifier. */
|
|
1545
|
+
id: number
|
|
1546
|
+
/** Team name. */
|
|
1547
|
+
name: string
|
|
1548
|
+
/** Current member count. */
|
|
1549
|
+
membersCount?: number
|
|
1550
|
+
/** Active team members. */
|
|
1551
|
+
users: Array<TeamUser>
|
|
1466
1552
|
}
|
|
1467
|
-
|
|
1468
|
-
|
|
1469
|
-
|
|
1470
|
-
|
|
1471
|
-
|
|
1472
|
-
|
|
1473
|
-
|
|
1474
|
-
|
|
1475
|
-
|
|
1476
|
-
|
|
1477
|
-
|
|
1478
|
-
|
|
1553
|
+
|
|
1554
|
+
/** A team member or pending invitee. */
|
|
1555
|
+
export interface TeamUser {
|
|
1556
|
+
/** User identifier. */
|
|
1557
|
+
id: number
|
|
1558
|
+
/** Display name. */
|
|
1559
|
+
fullName?: string
|
|
1560
|
+
/** Email address. */
|
|
1561
|
+
email: string
|
|
1562
|
+
/** Team role (e.g. `admin`, `viewer`, `billing`). */
|
|
1563
|
+
role?: string
|
|
1564
|
+
/** Membership status (e.g. `active`, `pending`). */
|
|
1565
|
+
status?: string
|
|
1566
|
+
/** When the user was added. */
|
|
1567
|
+
createdAt?: string
|
|
1568
|
+
/** Profile photo URL. */
|
|
1569
|
+
photoUrl?: string
|
|
1570
|
+
/** Whether this user is the primary user on the account. */
|
|
1571
|
+
accountPrimaryUser?: boolean
|
|
1479
1572
|
}
|
|
1573
|
+
|
|
1480
1574
|
/** Parameters for `test_filter`. */
|
|
1481
1575
|
export interface TestFilterParams {
|
|
1482
1576
|
/** Blockchain network to run the test against (e.g. `ethereum-mainnet`). */
|
|
@@ -1492,6 +1586,7 @@ export interface TestFilterParams {
|
|
|
1492
1586
|
/** Address book linked to the filter, if any. */
|
|
1493
1587
|
addressBookConfig?: AddressBookConfig
|
|
1494
1588
|
}
|
|
1589
|
+
|
|
1495
1590
|
/** Result of a `test_filter` call. */
|
|
1496
1591
|
export interface TestFilterResponse {
|
|
1497
1592
|
/** Filter output as a JSON string. Shape depends on the dataset and the user's filter function. */
|
|
@@ -1499,104 +1594,99 @@ export interface TestFilterResponse {
|
|
|
1499
1594
|
/** Log lines emitted by the filter function during evaluation. */
|
|
1500
1595
|
logs: Array<string>
|
|
1501
1596
|
}
|
|
1502
|
-
|
|
1503
|
-
|
|
1504
|
-
|
|
1505
|
-
|
|
1597
|
+
|
|
1598
|
+
/** Parameters for `update_endpoint`. */
|
|
1599
|
+
export interface UpdateEndpointRequest {
|
|
1600
|
+
/** New human-readable label. */
|
|
1601
|
+
label?: string
|
|
1506
1602
|
}
|
|
1507
|
-
|
|
1508
|
-
|
|
1509
|
-
|
|
1510
|
-
|
|
1511
|
-
|
|
1512
|
-
SolanaWalletFilter = 'SolanaWalletFilter',
|
|
1513
|
-
BitcoinWalletFilter = 'BitcoinWalletFilter',
|
|
1514
|
-
XrplWalletFilter = 'XrplWalletFilter',
|
|
1515
|
-
HyperliquidWalletEventsFilter = 'HyperliquidWalletEventsFilter',
|
|
1516
|
-
StellarWalletTransactionsSourceAccountFilter = 'StellarWalletTransactionsSourceAccountFilter'
|
|
1603
|
+
|
|
1604
|
+
/** Parameters for `update_endpoint_status`. */
|
|
1605
|
+
export interface UpdateEndpointStatusRequest {
|
|
1606
|
+
/** New status (`active` or `paused`). */
|
|
1607
|
+
status: string
|
|
1517
1608
|
}
|
|
1518
|
-
|
|
1519
|
-
|
|
1520
|
-
|
|
1521
|
-
|
|
1522
|
-
|
|
1523
|
-
|
|
1609
|
+
|
|
1610
|
+
/** Response from `update_endpoint_status`. */
|
|
1611
|
+
export interface UpdateEndpointStatusResponse {
|
|
1612
|
+
/** Confirmation string returned by the API. */
|
|
1613
|
+
data?: string
|
|
1614
|
+
/** Error message when the request did not succeed. */
|
|
1615
|
+
error?: string
|
|
1524
1616
|
}
|
|
1525
|
-
|
|
1526
|
-
|
|
1527
|
-
|
|
1528
|
-
*/
|
|
1529
|
-
|
|
1530
|
-
/**
|
|
1531
|
-
|
|
1617
|
+
|
|
1618
|
+
/** Parameters for `update_list`. Either or both fields may be supplied. */
|
|
1619
|
+
export interface UpdateListParams {
|
|
1620
|
+
/** Items to add to the list. */
|
|
1621
|
+
addItems?: Array<string>
|
|
1622
|
+
/** Items to remove from the list. */
|
|
1623
|
+
removeItems?: Array<string>
|
|
1532
1624
|
}
|
|
1533
|
-
|
|
1534
|
-
|
|
1535
|
-
|
|
1536
|
-
*/
|
|
1537
|
-
|
|
1538
|
-
/**
|
|
1539
|
-
|
|
1540
|
-
/**
|
|
1541
|
-
|
|
1625
|
+
|
|
1626
|
+
/** Parameters for `update_method_rate_limit`. Only provided fields are changed. */
|
|
1627
|
+
export interface UpdateMethodRateLimitRequest {
|
|
1628
|
+
/** New set of RPC methods the limiter applies to. */
|
|
1629
|
+
methods?: Array<string>
|
|
1630
|
+
/** New status (`enabled` or `disabled`). */
|
|
1631
|
+
status?: string
|
|
1632
|
+
/** New rate value. */
|
|
1633
|
+
rate?: number
|
|
1542
1634
|
}
|
|
1543
|
-
|
|
1544
|
-
|
|
1545
|
-
|
|
1546
|
-
*/
|
|
1547
|
-
|
|
1548
|
-
/**
|
|
1549
|
-
|
|
1550
|
-
/** Contract addresses to watch for events. */
|
|
1551
|
-
contracts: Array<string>
|
|
1635
|
+
|
|
1636
|
+
/** Response from `update_method_rate_limit`. */
|
|
1637
|
+
export interface UpdateMethodRateLimitResponse {
|
|
1638
|
+
/** The updated rate limiter. */
|
|
1639
|
+
data?: MethodRateLimiter
|
|
1640
|
+
/** Error message when the request did not succeed. */
|
|
1641
|
+
error?: string
|
|
1552
1642
|
}
|
|
1553
|
-
|
|
1554
|
-
|
|
1555
|
-
|
|
1556
|
-
*/
|
|
1557
|
-
|
|
1558
|
-
/** Solana account addresses to match against. */
|
|
1559
|
-
accounts: Array<string>
|
|
1643
|
+
|
|
1644
|
+
/** Parameters for `update_rate_limits`. */
|
|
1645
|
+
export interface UpdateRateLimitsRequest {
|
|
1646
|
+
/** Rate limit values to apply. */
|
|
1647
|
+
rateLimits: RateLimitSettings
|
|
1560
1648
|
}
|
|
1561
|
-
|
|
1562
|
-
|
|
1563
|
-
|
|
1564
|
-
|
|
1649
|
+
|
|
1650
|
+
/** Parameters for `update_request_filter`. */
|
|
1651
|
+
export interface UpdateRequestFilterRequest {
|
|
1652
|
+
/** New set of whitelisted RPC methods. */
|
|
1653
|
+
method?: Array<string>
|
|
1565
1654
|
}
|
|
1566
|
-
|
|
1567
|
-
|
|
1568
|
-
|
|
1569
|
-
|
|
1655
|
+
|
|
1656
|
+
/** Parameters for `update_security_options`. */
|
|
1657
|
+
export interface UpdateSecurityOptionsRequest {
|
|
1658
|
+
/** Security toggles to apply. */
|
|
1659
|
+
options: SecurityOptionsUpdate
|
|
1570
1660
|
}
|
|
1571
|
-
|
|
1572
|
-
|
|
1573
|
-
|
|
1574
|
-
|
|
1661
|
+
|
|
1662
|
+
/** Response from `update_security_options`. */
|
|
1663
|
+
export interface UpdateSecurityOptionsResponse {
|
|
1664
|
+
/** Updated security options. */
|
|
1665
|
+
data: Array<SecurityOption>
|
|
1666
|
+
/** Error message when the request did not succeed. */
|
|
1667
|
+
error?: string
|
|
1575
1668
|
}
|
|
1576
|
-
|
|
1577
|
-
|
|
1578
|
-
|
|
1579
|
-
*/
|
|
1580
|
-
|
|
1581
|
-
/** Stellar wallet addresses to match against. */
|
|
1582
|
-
wallets: Array<string>
|
|
1669
|
+
|
|
1670
|
+
/** Inner data for `update_team_endpoints` responses. */
|
|
1671
|
+
export interface UpdateTeamEndpointsData {
|
|
1672
|
+
/** `true` when the association update succeeded. */
|
|
1673
|
+
success?: boolean
|
|
1583
1674
|
}
|
|
1584
|
-
|
|
1585
|
-
|
|
1586
|
-
|
|
1587
|
-
|
|
1588
|
-
|
|
1589
|
-
securityToken?: string
|
|
1590
|
-
/** Optional payload compression (`gzip` or `none`). */
|
|
1591
|
-
compression?: string
|
|
1675
|
+
|
|
1676
|
+
/** Parameters for `update_team_endpoints`. */
|
|
1677
|
+
export interface UpdateTeamEndpointsRequest {
|
|
1678
|
+
/** Endpoint ids to associate with the team; pass an empty array to remove all. */
|
|
1679
|
+
endpointIds: Array<string>
|
|
1592
1680
|
}
|
|
1593
|
-
|
|
1594
|
-
|
|
1595
|
-
|
|
1596
|
-
|
|
1597
|
-
|
|
1598
|
-
|
|
1681
|
+
|
|
1682
|
+
/** Response from `update_team_endpoints`. */
|
|
1683
|
+
export interface UpdateTeamEndpointsResponse {
|
|
1684
|
+
/** Update result. */
|
|
1685
|
+
data?: UpdateTeamEndpointsData
|
|
1686
|
+
/** Error message when the request did not succeed. */
|
|
1687
|
+
error?: string
|
|
1599
1688
|
}
|
|
1689
|
+
|
|
1600
1690
|
/**
|
|
1601
1691
|
* Parameters for `update_webhook`. All fields are optional; only set fields
|
|
1602
1692
|
* are modified.
|
|
@@ -1609,11 +1699,63 @@ export interface UpdateWebhookParams {
|
|
|
1609
1699
|
/** New destination configuration. */
|
|
1610
1700
|
destinationAttributes?: WebhookDestinationAttributes
|
|
1611
1701
|
}
|
|
1612
|
-
|
|
1613
|
-
|
|
1614
|
-
|
|
1615
|
-
|
|
1702
|
+
|
|
1703
|
+
/** Inner data for `get_usage_by_chain`. */
|
|
1704
|
+
export interface UsageByChainData {
|
|
1705
|
+
/** Per-chain rows. */
|
|
1706
|
+
chains: Array<ChainUsage>
|
|
1707
|
+
/** Start of the queried window. */
|
|
1708
|
+
startTime?: number
|
|
1709
|
+
/** End of the queried window. */
|
|
1710
|
+
endTime?: number
|
|
1711
|
+
}
|
|
1712
|
+
|
|
1713
|
+
/** Inner data for `get_usage_by_endpoint`. */
|
|
1714
|
+
export interface UsageByEndpointData {
|
|
1715
|
+
/** Per-endpoint rows. */
|
|
1716
|
+
endpoints: Array<EndpointUsage>
|
|
1717
|
+
/** Start of the queried window. */
|
|
1718
|
+
startTime?: number
|
|
1719
|
+
/** End of the queried window. */
|
|
1720
|
+
endTime?: number
|
|
1721
|
+
}
|
|
1722
|
+
|
|
1723
|
+
/** Inner data for `get_usage_by_method`. */
|
|
1724
|
+
export interface UsageByMethodData {
|
|
1725
|
+
/** Per-method rows. */
|
|
1726
|
+
methods: Array<MethodUsage>
|
|
1727
|
+
/** Start of the queried window. */
|
|
1728
|
+
startTime?: number
|
|
1729
|
+
/** End of the queried window. */
|
|
1730
|
+
endTime?: number
|
|
1731
|
+
}
|
|
1732
|
+
|
|
1733
|
+
/** Inner data for `get_usage_by_tag`. */
|
|
1734
|
+
export interface UsageByTagData {
|
|
1735
|
+
/** Per-tag rows. */
|
|
1736
|
+
tags: Array<TagUsage>
|
|
1737
|
+
/** Start of the queried window. */
|
|
1738
|
+
startTime?: number
|
|
1739
|
+
/** End of the queried window. */
|
|
1740
|
+
endTime?: number
|
|
1616
1741
|
}
|
|
1742
|
+
|
|
1743
|
+
/** Aggregate account usage for a time window. */
|
|
1744
|
+
export interface UsageData {
|
|
1745
|
+
/** Credits consumed during the window. */
|
|
1746
|
+
creditsUsed: number
|
|
1747
|
+
/** Credits still available, when the plan has a finite limit. */
|
|
1748
|
+
creditsRemaining?: number
|
|
1749
|
+
/** Plan's credit limit, when applicable. */
|
|
1750
|
+
limit?: number
|
|
1751
|
+
/** Credits consumed beyond the plan limit. */
|
|
1752
|
+
overages?: number
|
|
1753
|
+
/** Start of the queried window. */
|
|
1754
|
+
startTime: number
|
|
1755
|
+
/** End of the queried window. */
|
|
1756
|
+
endTime: number
|
|
1757
|
+
}
|
|
1758
|
+
|
|
1617
1759
|
/** A webhook's full configuration and current state. */
|
|
1618
1760
|
export interface Webhook {
|
|
1619
1761
|
/** Unique webhook identifier. */
|
|
@@ -1635,6 +1777,39 @@ export interface Webhook {
|
|
|
1635
1777
|
/** Destination-specific configuration as a JSON string. */
|
|
1636
1778
|
destinationAttributes?: string
|
|
1637
1779
|
}
|
|
1780
|
+
|
|
1781
|
+
/** Configuration for delivering stream batches to an HTTP webhook endpoint. */
|
|
1782
|
+
export interface WebhookAttributes {
|
|
1783
|
+
/** Destination URL that receives batched stream payloads. */
|
|
1784
|
+
url: string
|
|
1785
|
+
/** Maximum number of retry attempts for a failed delivery. Must be in the range 1–10. */
|
|
1786
|
+
maxRetry: number
|
|
1787
|
+
/** Seconds to wait between retry attempts. */
|
|
1788
|
+
retryIntervalSec: number
|
|
1789
|
+
/** Timeout in seconds for each POST request. */
|
|
1790
|
+
postTimeoutSec: number
|
|
1791
|
+
/** Optional token included with each request so the receiver can verify authenticity. When supplied, must be at least 32 bytes (256 bits). */
|
|
1792
|
+
securityToken?: string
|
|
1793
|
+
/** Compression applied to the payload (e.g. `none`, `gzip`). When omitted the server defaults to no compression. */
|
|
1794
|
+
compression?: string
|
|
1795
|
+
}
|
|
1796
|
+
|
|
1797
|
+
/** Destination configuration for a webhook. */
|
|
1798
|
+
export interface WebhookDestinationAttributes {
|
|
1799
|
+
/** Target URL that receives webhook payloads. */
|
|
1800
|
+
url: string
|
|
1801
|
+
/** Optional token sent with each payload so the receiver can verify authenticity; generated automatically when omitted. */
|
|
1802
|
+
securityToken?: string
|
|
1803
|
+
/** Optional payload compression (`gzip` or `none`). */
|
|
1804
|
+
compression?: string
|
|
1805
|
+
}
|
|
1806
|
+
|
|
1807
|
+
/** Response from `get_enabled_count` for webhooks. */
|
|
1808
|
+
export interface WebhookEnabledCountResponse {
|
|
1809
|
+
/** Total count of enabled webhooks on the account. */
|
|
1810
|
+
total: number
|
|
1811
|
+
}
|
|
1812
|
+
|
|
1638
1813
|
/** Pagination metadata returned alongside a paginated webhooks list. */
|
|
1639
1814
|
export interface WebhookPageInfo {
|
|
1640
1815
|
/** Page size used for this response. */
|
|
@@ -1644,136 +1819,35 @@ export interface WebhookPageInfo {
|
|
|
1644
1819
|
/** Total number of webhooks matching the query across all pages. */
|
|
1645
1820
|
total: number
|
|
1646
1821
|
}
|
|
1647
|
-
|
|
1648
|
-
export interface
|
|
1649
|
-
|
|
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
|
|
1822
|
+
|
|
1823
|
+
export interface WebhooksConfig {
|
|
1824
|
+
baseUrl?: string
|
|
1757
1825
|
}
|
|
1758
|
-
|
|
1759
|
-
|
|
1760
|
-
|
|
1761
|
-
|
|
1762
|
-
|
|
1826
|
+
|
|
1827
|
+
/** Position a webhook begins (or resumes) delivering from when activated. */
|
|
1828
|
+
export declare const enum WebhookStartFrom {
|
|
1829
|
+
/** Resume from the last-delivered block. */
|
|
1830
|
+
Last = 'Last',
|
|
1831
|
+
/** Start from the newest available block. */
|
|
1832
|
+
Latest = 'Latest'
|
|
1763
1833
|
}
|
|
1764
|
-
|
|
1765
|
-
|
|
1766
|
-
|
|
1767
|
-
|
|
1768
|
-
|
|
1769
|
-
|
|
1770
|
-
|
|
1771
|
-
|
|
1772
|
-
|
|
1773
|
-
|
|
1774
|
-
|
|
1775
|
-
|
|
1776
|
-
|
|
1834
|
+
|
|
1835
|
+
/** Identifier of a predefined webhook filter template. */
|
|
1836
|
+
export declare const enum WebhookTemplateId {
|
|
1837
|
+
EvmWalletFilter = 'EvmWalletFilter',
|
|
1838
|
+
EvmContractEvents = 'EvmContractEvents',
|
|
1839
|
+
EvmAbiFilter = 'EvmAbiFilter',
|
|
1840
|
+
SolanaWalletFilter = 'SolanaWalletFilter',
|
|
1841
|
+
BitcoinWalletFilter = 'BitcoinWalletFilter',
|
|
1842
|
+
XrplWalletFilter = 'XrplWalletFilter',
|
|
1843
|
+
HyperliquidWalletEventsFilter = 'HyperliquidWalletEventsFilter',
|
|
1844
|
+
StellarWalletTransactionsSourceAccountFilter = 'StellarWalletTransactionsSourceAccountFilter'
|
|
1845
|
+
}
|
|
1846
|
+
|
|
1847
|
+
/** Template arguments for an XRPL wallet filter. */
|
|
1848
|
+
export interface XrplWalletFilterTemplate {
|
|
1849
|
+
/** XRPL wallet addresses to match against. */
|
|
1850
|
+
wallets: Array<string>
|
|
1777
1851
|
}
|
|
1778
1852
|
export declare class AdminApiClient {
|
|
1779
1853
|
/**
|
|
@@ -2091,6 +2165,66 @@ export declare class AdminApiClient {
|
|
|
2091
2165
|
*/
|
|
2092
2166
|
getEndpointSecurity(id: string): Promise<GetEndpointSecurityResponse>
|
|
2093
2167
|
}
|
|
2168
|
+
|
|
2169
|
+
export declare class KvStoreApiClient {
|
|
2170
|
+
/** Creates a new set, storing a single string value under the given key. */
|
|
2171
|
+
createSet(params: CreateSetParams): Promise<void>
|
|
2172
|
+
/**
|
|
2173
|
+
* Returns a paginated page of key/value entries from the store. Use the
|
|
2174
|
+
* response `cursor` to fetch subsequent pages.
|
|
2175
|
+
*/
|
|
2176
|
+
getSets(params?: GetSetsParams | undefined | null): Promise<GetSetsResponse>
|
|
2177
|
+
/** Returns the string value stored for a single set by key. */
|
|
2178
|
+
getSet(key: string): Promise<GetSetResponse>
|
|
2179
|
+
/**
|
|
2180
|
+
* Adds and removes multiple sets in a single request. Either `add_sets`,
|
|
2181
|
+
* `delete_sets`, or both may be supplied.
|
|
2182
|
+
*/
|
|
2183
|
+
bulkSets(params: BulkSetsParams): Promise<void>
|
|
2184
|
+
/** Removes a single set by key. */
|
|
2185
|
+
deleteSet(key: string): Promise<void>
|
|
2186
|
+
/** Creates a new list under the given key, seeded with the provided items. */
|
|
2187
|
+
createList(params: CreateListParams): Promise<void>
|
|
2188
|
+
/**
|
|
2189
|
+
* Returns a paginated page of list keys from the store. Use the response
|
|
2190
|
+
* `cursor` to fetch subsequent pages.
|
|
2191
|
+
*/
|
|
2192
|
+
getLists(params?: GetListsParams | undefined | null): Promise<GetListsResponse>
|
|
2193
|
+
/**
|
|
2194
|
+
* Returns a paginated page of items from the list identified by `key`.
|
|
2195
|
+
* Use the response `cursor` to fetch subsequent pages.
|
|
2196
|
+
*/
|
|
2197
|
+
getList(key: string, params?: GetListParams | undefined | null): Promise<GetListResponse>
|
|
2198
|
+
/**
|
|
2199
|
+
* Updates an existing list by adding and/or removing items in a single
|
|
2200
|
+
* operation. Either `add_items`, `remove_items`, or both may be supplied.
|
|
2201
|
+
*/
|
|
2202
|
+
updateList(key: string, params: UpdateListParams): Promise<void>
|
|
2203
|
+
/** Appends a single item to the list identified by `key`. */
|
|
2204
|
+
addListItem(key: string, params: AddListItemParams): Promise<void>
|
|
2205
|
+
/** Checks whether the specified list contains the given item. */
|
|
2206
|
+
listContainsItem(key: string, item: string): Promise<ListContainsItemResponse>
|
|
2207
|
+
/** Removes a specific item from the list identified by `key`. */
|
|
2208
|
+
deleteListItem(key: string, item: string): Promise<void>
|
|
2209
|
+
/** Removes a list and all of its items by key. */
|
|
2210
|
+
deleteList(key: string): Promise<void>
|
|
2211
|
+
}
|
|
2212
|
+
|
|
2213
|
+
export declare class QuicknodeSdk {
|
|
2214
|
+
/** Creates a new SDK instance from an explicit configuration. */
|
|
2215
|
+
constructor(config: SdkFullConfig)
|
|
2216
|
+
/** Returns the admin sub-client. */
|
|
2217
|
+
get admin(): AdminApiClient
|
|
2218
|
+
/** Returns the streams sub-client. */
|
|
2219
|
+
get streams(): StreamsApiClient
|
|
2220
|
+
/** Returns the webhooks sub-client. */
|
|
2221
|
+
get webhooks(): WebhooksApiClient
|
|
2222
|
+
/** Returns the kvstore sub-client. */
|
|
2223
|
+
get kvstore(): KvStoreApiClient
|
|
2224
|
+
/** Creates a new SDK instance using configuration from environment variables. */
|
|
2225
|
+
static fromEnv(): QuicknodeSdk
|
|
2226
|
+
}
|
|
2227
|
+
|
|
2094
2228
|
export declare class StreamsApiClient {
|
|
2095
2229
|
/**
|
|
2096
2230
|
* Creates a new Stream on a given blockchain network and dataset, delivering
|
|
@@ -2146,6 +2280,7 @@ export declare class StreamsApiClient {
|
|
|
2146
2280
|
*/
|
|
2147
2281
|
getEnabledCount(streamType?: string | undefined | null): Promise<EnabledCountResponse>
|
|
2148
2282
|
}
|
|
2283
|
+
|
|
2149
2284
|
export declare class WebhooksApiClient {
|
|
2150
2285
|
/**
|
|
2151
2286
|
* Returns a paginated list of webhooks on the account. Each entry includes
|
|
@@ -2213,46 +2348,114 @@ export declare class WebhooksApiClient {
|
|
|
2213
2348
|
*/
|
|
2214
2349
|
updateWebhookTemplate(webhookId: string, params: UpdateWebhookTemplateParamsNode): Promise<Webhook>
|
|
2215
2350
|
}
|
|
2216
|
-
|
|
2217
|
-
|
|
2218
|
-
|
|
2219
|
-
|
|
2220
|
-
|
|
2221
|
-
|
|
2222
|
-
|
|
2223
|
-
|
|
2224
|
-
|
|
2225
|
-
|
|
2226
|
-
|
|
2227
|
-
|
|
2228
|
-
|
|
2229
|
-
|
|
2230
|
-
|
|
2231
|
-
|
|
2232
|
-
|
|
2233
|
-
|
|
2234
|
-
|
|
2235
|
-
|
|
2236
|
-
|
|
2237
|
-
|
|
2238
|
-
|
|
2239
|
-
|
|
2240
|
-
|
|
2241
|
-
|
|
2242
|
-
|
|
2243
|
-
|
|
2244
|
-
|
|
2245
|
-
|
|
2246
|
-
|
|
2247
|
-
|
|
2248
|
-
|
|
2249
|
-
|
|
2250
|
-
|
|
2251
|
-
|
|
2252
|
-
|
|
2253
|
-
|
|
2254
|
-
|
|
2255
|
-
|
|
2256
|
-
|
|
2257
|
-
|
|
2351
|
+
|
|
2352
|
+
export interface CreateStreamParamsNode {
|
|
2353
|
+
name: string
|
|
2354
|
+
region: StreamRegion
|
|
2355
|
+
network: string
|
|
2356
|
+
dataset: StreamDataset
|
|
2357
|
+
startRange: number
|
|
2358
|
+
endRange: number
|
|
2359
|
+
destinationAttributes: any
|
|
2360
|
+
plan?: string
|
|
2361
|
+
thresholdFetchBuffer?: number
|
|
2362
|
+
datasetBatchSize: number
|
|
2363
|
+
maxBatchSize?: number
|
|
2364
|
+
maxBufferRangeSize?: number
|
|
2365
|
+
maxBufferProcessingWorkers?: number
|
|
2366
|
+
keepDistanceFromTip?: number
|
|
2367
|
+
filterFunction?: string
|
|
2368
|
+
filterLanguage?: FilterLanguage
|
|
2369
|
+
addressBookConfig?: AddressBookConfig
|
|
2370
|
+
includeStreamMetadata?: StreamMetadataLocation
|
|
2371
|
+
productType?: ProductType
|
|
2372
|
+
status?: StreamStatus
|
|
2373
|
+
notificationEmail?: string
|
|
2374
|
+
chargeMinCap?: number
|
|
2375
|
+
fixBlockReorgs?: number
|
|
2376
|
+
elasticBatchEnabled: boolean
|
|
2377
|
+
extraDestinations?: Array<any>
|
|
2378
|
+
}
|
|
2379
|
+
|
|
2380
|
+
export interface CreateWebhookFromTemplateParamsNode {
|
|
2381
|
+
name: string
|
|
2382
|
+
network: string
|
|
2383
|
+
notificationEmail?: string
|
|
2384
|
+
destinationAttributes: WebhookDestinationAttributes
|
|
2385
|
+
templateArgs: any
|
|
2386
|
+
}
|
|
2387
|
+
|
|
2388
|
+
export interface ListStreamsResponseNode {
|
|
2389
|
+
data: Array<StreamNode>
|
|
2390
|
+
pageInfo: PageInfo
|
|
2391
|
+
}
|
|
2392
|
+
|
|
2393
|
+
export interface StreamNode {
|
|
2394
|
+
id: string
|
|
2395
|
+
name: string
|
|
2396
|
+
status: string
|
|
2397
|
+
createdAt: string
|
|
2398
|
+
updatedAt: string
|
|
2399
|
+
sequence: number
|
|
2400
|
+
network: string
|
|
2401
|
+
dataset: string
|
|
2402
|
+
region: string
|
|
2403
|
+
startRange: number
|
|
2404
|
+
endRange: number
|
|
2405
|
+
plan?: string
|
|
2406
|
+
thresholdFetchBuffer?: number
|
|
2407
|
+
datasetBatchSize?: number
|
|
2408
|
+
maxBatchSize?: number
|
|
2409
|
+
maxBufferRangeSize?: number
|
|
2410
|
+
maxBufferProcessingWorkers?: number
|
|
2411
|
+
keepDistanceFromTip?: number
|
|
2412
|
+
filterFunction?: string
|
|
2413
|
+
filterLanguage?: string
|
|
2414
|
+
includeStreamMetadata?: string
|
|
2415
|
+
productType?: string
|
|
2416
|
+
notificationEmail?: string
|
|
2417
|
+
fixBlockReorgs?: number
|
|
2418
|
+
currentHash?: string
|
|
2419
|
+
destinationAttributes?: any
|
|
2420
|
+
elasticBatchEnabled?: boolean
|
|
2421
|
+
qnAccountId?: string
|
|
2422
|
+
chargeMinCap?: number
|
|
2423
|
+
memo?: string
|
|
2424
|
+
addressBookConfig?: AddressBookConfig
|
|
2425
|
+
extraDestinations?: Array<any>
|
|
2426
|
+
}
|
|
2427
|
+
|
|
2428
|
+
export interface UpdateStreamParamsNode {
|
|
2429
|
+
name?: string
|
|
2430
|
+
region?: StreamRegion
|
|
2431
|
+
network?: string
|
|
2432
|
+
dataset?: StreamDataset
|
|
2433
|
+
startRange?: number
|
|
2434
|
+
endRange?: number
|
|
2435
|
+
destinationAttributes?: any
|
|
2436
|
+
plan?: string
|
|
2437
|
+
thresholdFetchBuffer?: number
|
|
2438
|
+
datasetBatchSize?: number
|
|
2439
|
+
maxBatchSize?: number
|
|
2440
|
+
maxBufferRangeSize?: number
|
|
2441
|
+
maxBufferProcessingWorkers?: number
|
|
2442
|
+
keepDistanceFromTip?: number
|
|
2443
|
+
filterFunction?: string
|
|
2444
|
+
filterLanguage?: FilterLanguage
|
|
2445
|
+
addressBookConfig?: AddressBookConfig
|
|
2446
|
+
includeStreamMetadata?: StreamMetadataLocation
|
|
2447
|
+
notificationEmail?: string
|
|
2448
|
+
chargeMinCap?: number
|
|
2449
|
+
fixBlockReorgs?: number
|
|
2450
|
+
elasticBatchEnabled?: boolean
|
|
2451
|
+
status?: StreamStatus
|
|
2452
|
+
memo?: string
|
|
2453
|
+
extraDestinations?: Array<any>
|
|
2454
|
+
}
|
|
2455
|
+
|
|
2456
|
+
export interface UpdateWebhookTemplateParamsNode {
|
|
2457
|
+
name?: string
|
|
2458
|
+
notificationEmail?: string
|
|
2459
|
+
destinationAttributes?: WebhookDestinationAttributes
|
|
2460
|
+
templateArgs: any
|
|
2258
2461
|
}
|