pgbeam 0.1.0 → 0.2.1
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 +56 -0
- package/dist/index.cjs +568 -0
- package/dist/{index.d.ts → index.d.cts} +785 -236
- package/dist/index.d.mts +4262 -0
- package/dist/{index.js → index.mjs} +190 -89
- package/dist/operations.cjs +328 -0
- package/dist/{operations.d.ts → operations.d.cts} +582 -250
- package/dist/operations.d.mts +3692 -0
- package/dist/{operations.js → operations.mjs} +70 -73
- package/package.json +31 -28
|
@@ -0,0 +1,3692 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Generated by Kubb (https://kubb.dev/).
|
|
3
|
+
* Do not edit manually.
|
|
4
|
+
*/
|
|
5
|
+
/**
|
|
6
|
+
* @description Full account data export for privacy and data-portability requests.
|
|
7
|
+
*/
|
|
8
|
+
type AccountExport = {
|
|
9
|
+
/**
|
|
10
|
+
* @description Core user profile data.
|
|
11
|
+
* @type object
|
|
12
|
+
*/
|
|
13
|
+
user: {
|
|
14
|
+
/**
|
|
15
|
+
* @description User identifier.
|
|
16
|
+
* @type string
|
|
17
|
+
*/
|
|
18
|
+
id: string;
|
|
19
|
+
/**
|
|
20
|
+
* @description Display name for the user.
|
|
21
|
+
* @type string
|
|
22
|
+
*/
|
|
23
|
+
name: string;
|
|
24
|
+
/**
|
|
25
|
+
* @description Primary account email address.
|
|
26
|
+
* @type string, email
|
|
27
|
+
*/
|
|
28
|
+
email: string;
|
|
29
|
+
/**
|
|
30
|
+
* @description Whether the email address has been verified.
|
|
31
|
+
* @type boolean
|
|
32
|
+
*/
|
|
33
|
+
email_verified: boolean;
|
|
34
|
+
/**
|
|
35
|
+
* @description Avatar image URL, if present.
|
|
36
|
+
* @type string | undefined
|
|
37
|
+
*/
|
|
38
|
+
image?: string;
|
|
39
|
+
/**
|
|
40
|
+
* @description When the user account was created.
|
|
41
|
+
* @type string, date-time
|
|
42
|
+
*/
|
|
43
|
+
created_at: string;
|
|
44
|
+
/**
|
|
45
|
+
* @description When the user profile was last updated.
|
|
46
|
+
* @type string, date-time
|
|
47
|
+
*/
|
|
48
|
+
updated_at: string;
|
|
49
|
+
};
|
|
50
|
+
/**
|
|
51
|
+
* @description Organizations the user belongs to.
|
|
52
|
+
* @type array
|
|
53
|
+
*/
|
|
54
|
+
organizations: {
|
|
55
|
+
/**
|
|
56
|
+
* @description Organization identifier.
|
|
57
|
+
* @type string
|
|
58
|
+
*/
|
|
59
|
+
id: string;
|
|
60
|
+
/**
|
|
61
|
+
* @description Organization display name.
|
|
62
|
+
* @type string
|
|
63
|
+
*/
|
|
64
|
+
name: string;
|
|
65
|
+
/**
|
|
66
|
+
* @description Organization slug used in URLs and routing.
|
|
67
|
+
* @type string
|
|
68
|
+
*/
|
|
69
|
+
slug: string;
|
|
70
|
+
/**
|
|
71
|
+
* @description User role within the organization.
|
|
72
|
+
* @type string
|
|
73
|
+
*/
|
|
74
|
+
role: string;
|
|
75
|
+
/**
|
|
76
|
+
* @description When the organization membership was created.
|
|
77
|
+
* @type string, date-time
|
|
78
|
+
*/
|
|
79
|
+
created_at: string;
|
|
80
|
+
}[];
|
|
81
|
+
/**
|
|
82
|
+
* @description Projects owned through the user\'s organizations.
|
|
83
|
+
* @type array
|
|
84
|
+
*/
|
|
85
|
+
projects: {
|
|
86
|
+
/**
|
|
87
|
+
* @description Project identifier.
|
|
88
|
+
* @type string
|
|
89
|
+
*/
|
|
90
|
+
id: string;
|
|
91
|
+
/**
|
|
92
|
+
* @description Owning organization identifier.
|
|
93
|
+
* @type string
|
|
94
|
+
*/
|
|
95
|
+
org_id: string;
|
|
96
|
+
/**
|
|
97
|
+
* @description Project display name.
|
|
98
|
+
* @type string
|
|
99
|
+
*/
|
|
100
|
+
name: string;
|
|
101
|
+
/**
|
|
102
|
+
* @description Project description at export time.
|
|
103
|
+
* @type string
|
|
104
|
+
*/
|
|
105
|
+
description: string;
|
|
106
|
+
/**
|
|
107
|
+
* @description Project lifecycle status.
|
|
108
|
+
* @type string
|
|
109
|
+
*/
|
|
110
|
+
status: string;
|
|
111
|
+
/**
|
|
112
|
+
* @description When the project was created.
|
|
113
|
+
* @type string, date-time
|
|
114
|
+
*/
|
|
115
|
+
created_at: string;
|
|
116
|
+
}[];
|
|
117
|
+
/**
|
|
118
|
+
* @description Databases registered under the exported projects.
|
|
119
|
+
* @type array
|
|
120
|
+
*/
|
|
121
|
+
databases: {
|
|
122
|
+
/**
|
|
123
|
+
* @description Database identifier.
|
|
124
|
+
* @type string
|
|
125
|
+
*/
|
|
126
|
+
id: string;
|
|
127
|
+
/**
|
|
128
|
+
* @description Owning project identifier.
|
|
129
|
+
* @type string
|
|
130
|
+
*/
|
|
131
|
+
project_id: string;
|
|
132
|
+
/**
|
|
133
|
+
* @description Upstream PostgreSQL host.
|
|
134
|
+
* @type string
|
|
135
|
+
*/
|
|
136
|
+
host: string;
|
|
137
|
+
/**
|
|
138
|
+
* @description Upstream PostgreSQL port.
|
|
139
|
+
* @type integer
|
|
140
|
+
*/
|
|
141
|
+
port: number;
|
|
142
|
+
/**
|
|
143
|
+
* @description Upstream PostgreSQL database name.
|
|
144
|
+
* @type string
|
|
145
|
+
*/
|
|
146
|
+
name: string;
|
|
147
|
+
/**
|
|
148
|
+
* @description PostgreSQL SSL mode in use for the database.
|
|
149
|
+
* @type string
|
|
150
|
+
*/
|
|
151
|
+
ssl_mode: string;
|
|
152
|
+
/**
|
|
153
|
+
* @description Database role within the project.
|
|
154
|
+
* @type string
|
|
155
|
+
*/
|
|
156
|
+
role: string;
|
|
157
|
+
/**
|
|
158
|
+
* @description When the database registration was created.
|
|
159
|
+
* @type string, date-time
|
|
160
|
+
*/
|
|
161
|
+
created_at: string;
|
|
162
|
+
}[];
|
|
163
|
+
/**
|
|
164
|
+
* @description Auth sessions associated with the user.
|
|
165
|
+
* @type array
|
|
166
|
+
*/
|
|
167
|
+
sessions: {
|
|
168
|
+
/**
|
|
169
|
+
* @description Session identifier.
|
|
170
|
+
* @type string
|
|
171
|
+
*/
|
|
172
|
+
id: string;
|
|
173
|
+
/**
|
|
174
|
+
* @description When the session expires.
|
|
175
|
+
* @type string, date-time
|
|
176
|
+
*/
|
|
177
|
+
expires_at: string;
|
|
178
|
+
/**
|
|
179
|
+
* @description When the session was created.
|
|
180
|
+
* @type string, date-time
|
|
181
|
+
*/
|
|
182
|
+
created_at: string;
|
|
183
|
+
/**
|
|
184
|
+
* @description IP address used to create the session, if known.
|
|
185
|
+
* @type string | undefined
|
|
186
|
+
*/
|
|
187
|
+
ip_address?: string;
|
|
188
|
+
/**
|
|
189
|
+
* @description User agent captured for the session, if known.
|
|
190
|
+
* @type string | undefined
|
|
191
|
+
*/
|
|
192
|
+
user_agent?: string;
|
|
193
|
+
}[];
|
|
194
|
+
/**
|
|
195
|
+
* @description User communication preferences.
|
|
196
|
+
* @type object
|
|
197
|
+
*/
|
|
198
|
+
email_preferences: {
|
|
199
|
+
/**
|
|
200
|
+
* @description Whether marketing emails are enabled.
|
|
201
|
+
* @type boolean | undefined
|
|
202
|
+
*/
|
|
203
|
+
marketing_emails?: boolean;
|
|
204
|
+
/**
|
|
205
|
+
* @description Whether usage alert emails are enabled.
|
|
206
|
+
* @type boolean | undefined
|
|
207
|
+
*/
|
|
208
|
+
usage_limit_alerts?: boolean;
|
|
209
|
+
};
|
|
210
|
+
/**
|
|
211
|
+
* @description Recorded legal-document acceptances for the user.
|
|
212
|
+
* @type array
|
|
213
|
+
*/
|
|
214
|
+
consents: {
|
|
215
|
+
/**
|
|
216
|
+
* @description Consent record identifier.
|
|
217
|
+
* @type string
|
|
218
|
+
*/
|
|
219
|
+
id: string;
|
|
220
|
+
/**
|
|
221
|
+
* @description Legal document type accepted by the user.
|
|
222
|
+
* @type string
|
|
223
|
+
*/
|
|
224
|
+
document_type: string;
|
|
225
|
+
/**
|
|
226
|
+
* @description Accepted document version.
|
|
227
|
+
* @type string
|
|
228
|
+
*/
|
|
229
|
+
document_version: string;
|
|
230
|
+
/**
|
|
231
|
+
* @description When the document was accepted.
|
|
232
|
+
* @type string, date-time
|
|
233
|
+
*/
|
|
234
|
+
accepted_at: string;
|
|
235
|
+
/**
|
|
236
|
+
* @description IP address captured when consent was recorded.
|
|
237
|
+
* @type string | undefined
|
|
238
|
+
*/
|
|
239
|
+
ip_address?: string;
|
|
240
|
+
}[];
|
|
241
|
+
/**
|
|
242
|
+
* @description Recent audit log entries associated with the account.
|
|
243
|
+
* @type array
|
|
244
|
+
*/
|
|
245
|
+
audit_logs: {
|
|
246
|
+
/**
|
|
247
|
+
* @description Audit log entry identifier.
|
|
248
|
+
* @type string
|
|
249
|
+
*/
|
|
250
|
+
id: string;
|
|
251
|
+
/**
|
|
252
|
+
* @description Action captured by the audit log entry.
|
|
253
|
+
* @type string
|
|
254
|
+
*/
|
|
255
|
+
action: string;
|
|
256
|
+
/**
|
|
257
|
+
* @description Type of resource affected by the action.
|
|
258
|
+
* @type string | undefined
|
|
259
|
+
*/
|
|
260
|
+
resource_type?: string;
|
|
261
|
+
/**
|
|
262
|
+
* @description Identifier of the affected resource.
|
|
263
|
+
* @type string | undefined
|
|
264
|
+
*/
|
|
265
|
+
resource_id?: string;
|
|
266
|
+
/**
|
|
267
|
+
* @description IP address associated with the action, if known.
|
|
268
|
+
* @type string | undefined
|
|
269
|
+
*/
|
|
270
|
+
ip_address?: string;
|
|
271
|
+
/**
|
|
272
|
+
* @description When the audit log entry was recorded.
|
|
273
|
+
* @type string, date-time
|
|
274
|
+
*/
|
|
275
|
+
created_at: string;
|
|
276
|
+
}[];
|
|
277
|
+
/**
|
|
278
|
+
* @description When the export was generated.
|
|
279
|
+
* @type string, date-time
|
|
280
|
+
*/
|
|
281
|
+
exported_at: string;
|
|
282
|
+
};
|
|
283
|
+
|
|
284
|
+
/**
|
|
285
|
+
* Generated by Kubb (https://kubb.dev/).
|
|
286
|
+
* Do not edit manually.
|
|
287
|
+
*/
|
|
288
|
+
|
|
289
|
+
/**
|
|
290
|
+
* @description Account data export.
|
|
291
|
+
*/
|
|
292
|
+
type ExportAccountData200 = AccountExport;
|
|
293
|
+
type ExportAccountDataQueryResponse = ExportAccountData200;
|
|
294
|
+
|
|
295
|
+
/**
|
|
296
|
+
* Generated by Kubb (https://kubb.dev/).
|
|
297
|
+
* Do not edit manually.
|
|
298
|
+
*/
|
|
299
|
+
/**
|
|
300
|
+
* @description Recent activity snapshot for a project in an organization.
|
|
301
|
+
*/
|
|
302
|
+
type ActivityEntry = {
|
|
303
|
+
/**
|
|
304
|
+
* @description Unique activity snapshot identifier.
|
|
305
|
+
* @type string
|
|
306
|
+
*/
|
|
307
|
+
id: string;
|
|
308
|
+
/**
|
|
309
|
+
* @description Project that produced the activity snapshot.
|
|
310
|
+
* @type string
|
|
311
|
+
*/
|
|
312
|
+
project_id: string;
|
|
313
|
+
/**
|
|
314
|
+
* @description Project display name at the time of the snapshot.
|
|
315
|
+
* @type string
|
|
316
|
+
*/
|
|
317
|
+
project_name: string;
|
|
318
|
+
/**
|
|
319
|
+
* @description Region where the activity was observed.
|
|
320
|
+
* @type string
|
|
321
|
+
*/
|
|
322
|
+
region: string;
|
|
323
|
+
/**
|
|
324
|
+
* @description Total queries observed in the snapshot interval.
|
|
325
|
+
* @type integer, int64
|
|
326
|
+
*/
|
|
327
|
+
queries_total: number;
|
|
328
|
+
/**
|
|
329
|
+
* @description Number of cache hits during the interval.
|
|
330
|
+
* @type integer, int64
|
|
331
|
+
*/
|
|
332
|
+
cache_hits: number;
|
|
333
|
+
/**
|
|
334
|
+
* @description Number of cache misses during the interval.
|
|
335
|
+
* @type integer, int64
|
|
336
|
+
*/
|
|
337
|
+
cache_misses: number;
|
|
338
|
+
/**
|
|
339
|
+
* @description Average query latency in milliseconds.
|
|
340
|
+
* @type number, double
|
|
341
|
+
*/
|
|
342
|
+
avg_latency_ms: number;
|
|
343
|
+
/**
|
|
344
|
+
* @description 99th percentile query latency in milliseconds.
|
|
345
|
+
* @type number, double
|
|
346
|
+
*/
|
|
347
|
+
p99_latency_ms: number;
|
|
348
|
+
/**
|
|
349
|
+
* @description Number of active proxy connections during the interval.
|
|
350
|
+
* @type integer
|
|
351
|
+
*/
|
|
352
|
+
active_connections: number;
|
|
353
|
+
/**
|
|
354
|
+
* @description When the activity snapshot was recorded.
|
|
355
|
+
* @type string, date-time
|
|
356
|
+
*/
|
|
357
|
+
created_at: string;
|
|
358
|
+
};
|
|
359
|
+
|
|
360
|
+
/**
|
|
361
|
+
* Generated by Kubb (https://kubb.dev/).
|
|
362
|
+
* Do not edit manually.
|
|
363
|
+
*/
|
|
364
|
+
|
|
365
|
+
/**
|
|
366
|
+
* @description Response envelope for organization activity queries.
|
|
367
|
+
*/
|
|
368
|
+
type ActivityResponse = {
|
|
369
|
+
/**
|
|
370
|
+
* @description Recent activity snapshots for projects in the organization.
|
|
371
|
+
* @type array
|
|
372
|
+
*/
|
|
373
|
+
entries: ActivityEntry[];
|
|
374
|
+
};
|
|
375
|
+
|
|
376
|
+
/**
|
|
377
|
+
* Generated by Kubb (https://kubb.dev/).
|
|
378
|
+
* Do not edit manually.
|
|
379
|
+
*/
|
|
380
|
+
|
|
381
|
+
type GetOrganizationActivityPathParams = {
|
|
382
|
+
/**
|
|
383
|
+
* @description Unique organization identifier.
|
|
384
|
+
* @pattern ^[a-zA-Z0-9_.-]+$
|
|
385
|
+
* @type string
|
|
386
|
+
*/
|
|
387
|
+
org_id: string;
|
|
388
|
+
};
|
|
389
|
+
type GetOrganizationActivityQueryParams = {
|
|
390
|
+
/**
|
|
391
|
+
* @description Maximum number of activity entries to return.
|
|
392
|
+
* @minLength 1
|
|
393
|
+
* @maxLength 1000
|
|
394
|
+
* @default 100
|
|
395
|
+
* @type integer | undefined
|
|
396
|
+
*/
|
|
397
|
+
limit?: number;
|
|
398
|
+
/**
|
|
399
|
+
* @description Filter activity by event type (e.g. metrics, connection).
|
|
400
|
+
* @type string | undefined
|
|
401
|
+
*/
|
|
402
|
+
event_type?: string;
|
|
403
|
+
};
|
|
404
|
+
/**
|
|
405
|
+
* @description Recent activity entries.
|
|
406
|
+
*/
|
|
407
|
+
type GetOrganizationActivity200 = ActivityResponse;
|
|
408
|
+
type GetOrganizationActivityQueryResponse = GetOrganizationActivity200;
|
|
409
|
+
|
|
410
|
+
/**
|
|
411
|
+
* Generated by Kubb (https://kubb.dev/).
|
|
412
|
+
* Do not edit manually.
|
|
413
|
+
*/
|
|
414
|
+
/**
|
|
415
|
+
* @description Effective usage limits enforced for an organization plan.
|
|
416
|
+
*/
|
|
417
|
+
type PlanLimits = {
|
|
418
|
+
/**
|
|
419
|
+
* @description Maximum queries per day across all projects. 0 means unlimited.
|
|
420
|
+
* @type integer, int64
|
|
421
|
+
*/
|
|
422
|
+
queries_per_day: number;
|
|
423
|
+
/**
|
|
424
|
+
* @description Maximum number of active projects.
|
|
425
|
+
* @type integer
|
|
426
|
+
*/
|
|
427
|
+
max_projects: number;
|
|
428
|
+
/**
|
|
429
|
+
* @description Maximum databases per project.
|
|
430
|
+
* @type integer
|
|
431
|
+
*/
|
|
432
|
+
max_databases: number;
|
|
433
|
+
/**
|
|
434
|
+
* @description Maximum concurrent connections per project.
|
|
435
|
+
* @type integer
|
|
436
|
+
*/
|
|
437
|
+
max_connections: number;
|
|
438
|
+
/**
|
|
439
|
+
* @description Maximum queries per second per project.
|
|
440
|
+
* @type integer
|
|
441
|
+
*/
|
|
442
|
+
queries_per_second: number;
|
|
443
|
+
/**
|
|
444
|
+
* @description Monthly data transfer quota in bytes. 0 means unlimited.
|
|
445
|
+
* @type integer, int64
|
|
446
|
+
*/
|
|
447
|
+
bytes_per_month: number;
|
|
448
|
+
/**
|
|
449
|
+
* @description Maximum query shapes in cache rules. 0 means unlimited.
|
|
450
|
+
* @type integer
|
|
451
|
+
*/
|
|
452
|
+
max_query_shapes: number;
|
|
453
|
+
/**
|
|
454
|
+
* @description Number of seats included in the plan.
|
|
455
|
+
* @type integer
|
|
456
|
+
*/
|
|
457
|
+
included_seats: number;
|
|
458
|
+
};
|
|
459
|
+
|
|
460
|
+
/**
|
|
461
|
+
* Generated by Kubb (https://kubb.dev/).
|
|
462
|
+
* Do not edit manually.
|
|
463
|
+
*/
|
|
464
|
+
|
|
465
|
+
/**
|
|
466
|
+
* @description Publicly visible plan metadata and limits.
|
|
467
|
+
*/
|
|
468
|
+
type PlanInfo = {
|
|
469
|
+
/**
|
|
470
|
+
* @description Plan tier name (starter, pro, scale).
|
|
471
|
+
* @type string
|
|
472
|
+
*/
|
|
473
|
+
name: string;
|
|
474
|
+
/**
|
|
475
|
+
* @description Display label for the plan.
|
|
476
|
+
* @type string
|
|
477
|
+
*/
|
|
478
|
+
label: string;
|
|
479
|
+
/**
|
|
480
|
+
* @description Monthly price in dollars.
|
|
481
|
+
* @type integer
|
|
482
|
+
*/
|
|
483
|
+
monthly_price: number;
|
|
484
|
+
/**
|
|
485
|
+
* @description Annual price in dollars (if applicable).
|
|
486
|
+
* @type integer | undefined
|
|
487
|
+
*/
|
|
488
|
+
annual_price?: number;
|
|
489
|
+
/**
|
|
490
|
+
* @description Short description of the plan.
|
|
491
|
+
* @type string | undefined
|
|
492
|
+
*/
|
|
493
|
+
description?: string;
|
|
494
|
+
/**
|
|
495
|
+
* @description Human-readable overage pricing text.
|
|
496
|
+
* @type string | undefined
|
|
497
|
+
*/
|
|
498
|
+
overage_text?: string;
|
|
499
|
+
/**
|
|
500
|
+
* @description Number of trial days for new signups.
|
|
501
|
+
* @type integer | undefined
|
|
502
|
+
*/
|
|
503
|
+
trial_days?: number;
|
|
504
|
+
/**
|
|
505
|
+
* @description Effective usage limits enforced for an organization plan.
|
|
506
|
+
* @type object
|
|
507
|
+
*/
|
|
508
|
+
limits: PlanLimits;
|
|
509
|
+
};
|
|
510
|
+
|
|
511
|
+
/**
|
|
512
|
+
* Generated by Kubb (https://kubb.dev/).
|
|
513
|
+
* Do not edit manually.
|
|
514
|
+
*/
|
|
515
|
+
|
|
516
|
+
/**
|
|
517
|
+
* @description Response envelope for listing available billing plans.
|
|
518
|
+
*/
|
|
519
|
+
type ListPlansResponse = {
|
|
520
|
+
/**
|
|
521
|
+
* @description Billing plans available for self-serve signups.
|
|
522
|
+
* @type array
|
|
523
|
+
*/
|
|
524
|
+
plans: PlanInfo[];
|
|
525
|
+
};
|
|
526
|
+
|
|
527
|
+
/**
|
|
528
|
+
* Generated by Kubb (https://kubb.dev/).
|
|
529
|
+
* Do not edit manually.
|
|
530
|
+
*/
|
|
531
|
+
|
|
532
|
+
/**
|
|
533
|
+
* @description List of available plans.
|
|
534
|
+
*/
|
|
535
|
+
type ListPlans200 = ListPlansResponse;
|
|
536
|
+
type ListPlansQueryResponse = ListPlans200;
|
|
537
|
+
|
|
538
|
+
/**
|
|
539
|
+
* Generated by Kubb (https://kubb.dev/).
|
|
540
|
+
* Do not edit manually.
|
|
541
|
+
*/
|
|
542
|
+
|
|
543
|
+
declare const organizationPlanPlanEnum: {
|
|
544
|
+
readonly starter: "starter";
|
|
545
|
+
readonly pro: "pro";
|
|
546
|
+
readonly scale: "scale";
|
|
547
|
+
readonly enterprise: "enterprise";
|
|
548
|
+
};
|
|
549
|
+
type OrganizationPlanPlanEnumKey = (typeof organizationPlanPlanEnum)[keyof typeof organizationPlanPlanEnum];
|
|
550
|
+
declare const organizationPlanBillingProviderEnum: {
|
|
551
|
+
readonly stripe: "stripe";
|
|
552
|
+
readonly vercel: "vercel";
|
|
553
|
+
readonly aws: "aws";
|
|
554
|
+
};
|
|
555
|
+
type OrganizationPlanBillingProviderEnumKey = (typeof organizationPlanBillingProviderEnum)[keyof typeof organizationPlanBillingProviderEnum];
|
|
556
|
+
declare const organizationPlanSubscriptionStatusEnum: {
|
|
557
|
+
readonly none: "none";
|
|
558
|
+
readonly active: "active";
|
|
559
|
+
readonly trialing: "trialing";
|
|
560
|
+
readonly past_due: "past_due";
|
|
561
|
+
readonly canceled: "canceled";
|
|
562
|
+
readonly unpaid: "unpaid";
|
|
563
|
+
readonly incomplete: "incomplete";
|
|
564
|
+
readonly incomplete_expired: "incomplete_expired";
|
|
565
|
+
readonly paused: "paused";
|
|
566
|
+
};
|
|
567
|
+
type OrganizationPlanSubscriptionStatusEnumKey = (typeof organizationPlanSubscriptionStatusEnum)[keyof typeof organizationPlanSubscriptionStatusEnum];
|
|
568
|
+
/**
|
|
569
|
+
* @description Billing state and plan limits for an organization.
|
|
570
|
+
*/
|
|
571
|
+
type OrganizationPlan = {
|
|
572
|
+
/**
|
|
573
|
+
* @description Organization identifier the plan applies to.
|
|
574
|
+
* @type string
|
|
575
|
+
*/
|
|
576
|
+
org_id: string;
|
|
577
|
+
/**
|
|
578
|
+
* @description Current plan tier.
|
|
579
|
+
* @type string
|
|
580
|
+
*/
|
|
581
|
+
plan: OrganizationPlanPlanEnumKey;
|
|
582
|
+
/**
|
|
583
|
+
* @description Which billing provider manages this organization\'s subscription.
|
|
584
|
+
* @type string | undefined
|
|
585
|
+
*/
|
|
586
|
+
billing_provider?: OrganizationPlanBillingProviderEnumKey;
|
|
587
|
+
/**
|
|
588
|
+
* @description Stripe subscription status.
|
|
589
|
+
* @type string | undefined
|
|
590
|
+
*/
|
|
591
|
+
subscription_status?: OrganizationPlanSubscriptionStatusEnumKey;
|
|
592
|
+
/**
|
|
593
|
+
* @description End of current billing period.
|
|
594
|
+
* @type string | undefined, date-time
|
|
595
|
+
*/
|
|
596
|
+
current_period_end?: string;
|
|
597
|
+
/**
|
|
598
|
+
* @description Whether the organization billing is active (false = suspended).
|
|
599
|
+
* @type boolean | undefined
|
|
600
|
+
*/
|
|
601
|
+
enabled?: boolean;
|
|
602
|
+
/**
|
|
603
|
+
* @description Whether the organization has custom enterprise pricing.
|
|
604
|
+
* @type boolean | undefined
|
|
605
|
+
*/
|
|
606
|
+
custom_pricing?: boolean;
|
|
607
|
+
/**
|
|
608
|
+
* @description Monthly spend limit in dollars. Null means no limit.
|
|
609
|
+
* @type number, double
|
|
610
|
+
*/
|
|
611
|
+
spend_limit?: number | null;
|
|
612
|
+
/**
|
|
613
|
+
* @description Effective usage limits enforced for an organization plan.
|
|
614
|
+
* @type object
|
|
615
|
+
*/
|
|
616
|
+
limits: PlanLimits;
|
|
617
|
+
/**
|
|
618
|
+
* @description When the billing record was created.
|
|
619
|
+
* @type string | undefined, date-time
|
|
620
|
+
*/
|
|
621
|
+
created_at?: string;
|
|
622
|
+
/**
|
|
623
|
+
* @description When the billing record was last updated.
|
|
624
|
+
* @type string | undefined, date-time
|
|
625
|
+
*/
|
|
626
|
+
updated_at?: string;
|
|
627
|
+
};
|
|
628
|
+
|
|
629
|
+
/**
|
|
630
|
+
* Generated by Kubb (https://kubb.dev/).
|
|
631
|
+
* Do not edit manually.
|
|
632
|
+
*/
|
|
633
|
+
|
|
634
|
+
type GetOrganizationPlanPathParams = {
|
|
635
|
+
/**
|
|
636
|
+
* @description Unique organization identifier.
|
|
637
|
+
* @pattern ^[a-zA-Z0-9_.-]+$
|
|
638
|
+
* @type string
|
|
639
|
+
*/
|
|
640
|
+
org_id: string;
|
|
641
|
+
};
|
|
642
|
+
/**
|
|
643
|
+
* @description Organization plan details.
|
|
644
|
+
*/
|
|
645
|
+
type GetOrganizationPlan200 = OrganizationPlan;
|
|
646
|
+
type GetOrganizationPlanQueryResponse = GetOrganizationPlan200;
|
|
647
|
+
|
|
648
|
+
/**
|
|
649
|
+
* Generated by Kubb (https://kubb.dev/).
|
|
650
|
+
* Do not edit manually.
|
|
651
|
+
*/
|
|
652
|
+
/**
|
|
653
|
+
* @description Request body for updating an organization\'s monthly spend cap.
|
|
654
|
+
*/
|
|
655
|
+
type UpdateSpendLimitRequest = {
|
|
656
|
+
/**
|
|
657
|
+
* @description Monthly spend limit in dollars. Null to remove the limit.
|
|
658
|
+
* @type number, double
|
|
659
|
+
*/
|
|
660
|
+
spend_limit?: number | null;
|
|
661
|
+
};
|
|
662
|
+
|
|
663
|
+
/**
|
|
664
|
+
* Generated by Kubb (https://kubb.dev/).
|
|
665
|
+
* Do not edit manually.
|
|
666
|
+
*/
|
|
667
|
+
|
|
668
|
+
type UpdateSpendLimitPathParams = {
|
|
669
|
+
/**
|
|
670
|
+
* @description Unique organization identifier.
|
|
671
|
+
* @pattern ^[a-zA-Z0-9_.-]+$
|
|
672
|
+
* @type string
|
|
673
|
+
*/
|
|
674
|
+
org_id: string;
|
|
675
|
+
};
|
|
676
|
+
/**
|
|
677
|
+
* @description Spend limit updated.
|
|
678
|
+
*/
|
|
679
|
+
type UpdateSpendLimit200 = OrganizationPlan;
|
|
680
|
+
type UpdateSpendLimitMutationRequest = UpdateSpendLimitRequest;
|
|
681
|
+
type UpdateSpendLimitMutationResponse = UpdateSpendLimit200;
|
|
682
|
+
|
|
683
|
+
/**
|
|
684
|
+
* Generated by Kubb (https://kubb.dev/).
|
|
685
|
+
* Do not edit manually.
|
|
686
|
+
*/
|
|
687
|
+
/**
|
|
688
|
+
* @description Request body for capturing cancellation feedback from a user.
|
|
689
|
+
*/
|
|
690
|
+
type CancellationFeedbackRequest = {
|
|
691
|
+
/**
|
|
692
|
+
* @description Predefined cancellation reason.
|
|
693
|
+
* @type string | undefined
|
|
694
|
+
*/
|
|
695
|
+
reason?: string;
|
|
696
|
+
/**
|
|
697
|
+
* @description Free-text feedback from the user.
|
|
698
|
+
* @type string | undefined
|
|
699
|
+
*/
|
|
700
|
+
feedback?: string;
|
|
701
|
+
};
|
|
702
|
+
|
|
703
|
+
/**
|
|
704
|
+
* Generated by Kubb (https://kubb.dev/).
|
|
705
|
+
* Do not edit manually.
|
|
706
|
+
*/
|
|
707
|
+
|
|
708
|
+
type SubmitCancellationFeedbackPathParams = {
|
|
709
|
+
/**
|
|
710
|
+
* @description Unique organization identifier.
|
|
711
|
+
* @pattern ^[a-zA-Z0-9_.-]+$
|
|
712
|
+
* @type string
|
|
713
|
+
*/
|
|
714
|
+
org_id: string;
|
|
715
|
+
};
|
|
716
|
+
type SubmitCancellationFeedbackMutationRequest = CancellationFeedbackRequest;
|
|
717
|
+
|
|
718
|
+
/**
|
|
719
|
+
* Generated by Kubb (https://kubb.dev/).
|
|
720
|
+
* Do not edit manually.
|
|
721
|
+
*/
|
|
722
|
+
declare const cacheRuleEntryQueryTypeEnum: {
|
|
723
|
+
readonly read: "read";
|
|
724
|
+
readonly write: "write";
|
|
725
|
+
readonly other: "other";
|
|
726
|
+
};
|
|
727
|
+
type CacheRuleEntryQueryTypeEnumKey = (typeof cacheRuleEntryQueryTypeEnum)[keyof typeof cacheRuleEntryQueryTypeEnum];
|
|
728
|
+
declare const cacheRuleEntryRecommendationEnum: {
|
|
729
|
+
readonly great: "great";
|
|
730
|
+
readonly good: "good";
|
|
731
|
+
readonly fair: "fair";
|
|
732
|
+
readonly poor: "poor";
|
|
733
|
+
};
|
|
734
|
+
type CacheRuleEntryRecommendationEnumKey = (typeof cacheRuleEntryRecommendationEnum)[keyof typeof cacheRuleEntryRecommendationEnum];
|
|
735
|
+
/**
|
|
736
|
+
* @description Observed query shape and its cache recommendation for a database.
|
|
737
|
+
*/
|
|
738
|
+
type CacheRuleEntry = {
|
|
739
|
+
/**
|
|
740
|
+
* @description xxhash64 hex of the normalized SQL.
|
|
741
|
+
* @type string
|
|
742
|
+
*/
|
|
743
|
+
query_hash: string;
|
|
744
|
+
/**
|
|
745
|
+
* @description SQL with literals replaced by $N placeholders.
|
|
746
|
+
* @type string
|
|
747
|
+
*/
|
|
748
|
+
normalized_sql: string;
|
|
749
|
+
/**
|
|
750
|
+
* @description Query classification.
|
|
751
|
+
* @type string
|
|
752
|
+
*/
|
|
753
|
+
query_type: CacheRuleEntryQueryTypeEnumKey;
|
|
754
|
+
/**
|
|
755
|
+
* @description Whether caching is enabled for this query shape.
|
|
756
|
+
* @type boolean
|
|
757
|
+
*/
|
|
758
|
+
cache_enabled: boolean;
|
|
759
|
+
/**
|
|
760
|
+
* @description TTL override in seconds. Null means use project default.
|
|
761
|
+
* @minLength 0
|
|
762
|
+
* @type integer
|
|
763
|
+
*/
|
|
764
|
+
cache_ttl_seconds?: number | null;
|
|
765
|
+
/**
|
|
766
|
+
* @description SWR override in seconds. Null means use project default.
|
|
767
|
+
* @minLength 0
|
|
768
|
+
* @type integer
|
|
769
|
+
*/
|
|
770
|
+
cache_swr_seconds?: number | null;
|
|
771
|
+
/**
|
|
772
|
+
* @description Total number of executions observed.
|
|
773
|
+
* @type integer, int64
|
|
774
|
+
*/
|
|
775
|
+
call_count: number;
|
|
776
|
+
/**
|
|
777
|
+
* @description Average query latency in milliseconds.
|
|
778
|
+
* @type number, double
|
|
779
|
+
*/
|
|
780
|
+
avg_latency_ms: number;
|
|
781
|
+
/**
|
|
782
|
+
* @description 95th percentile latency in milliseconds.
|
|
783
|
+
* @type number, double
|
|
784
|
+
*/
|
|
785
|
+
p95_latency_ms: number;
|
|
786
|
+
/**
|
|
787
|
+
* @description Average response size in bytes.
|
|
788
|
+
* @type integer, int64
|
|
789
|
+
*/
|
|
790
|
+
avg_response_bytes: number;
|
|
791
|
+
/**
|
|
792
|
+
* @description Response stability rate (0.0 to 1.0). Higher means more stable.
|
|
793
|
+
* @type number, double
|
|
794
|
+
*/
|
|
795
|
+
stability_rate: number;
|
|
796
|
+
/**
|
|
797
|
+
* @description Cache recommendation based on frequency, latency, and stability.
|
|
798
|
+
* @type string
|
|
799
|
+
*/
|
|
800
|
+
recommendation: CacheRuleEntryRecommendationEnumKey;
|
|
801
|
+
/**
|
|
802
|
+
* @description When this query was first observed.
|
|
803
|
+
* @type string, date-time
|
|
804
|
+
*/
|
|
805
|
+
first_seen_at: string;
|
|
806
|
+
/**
|
|
807
|
+
* @description When this query was last observed.
|
|
808
|
+
* @type string, date-time
|
|
809
|
+
*/
|
|
810
|
+
last_seen_at: string;
|
|
811
|
+
};
|
|
812
|
+
|
|
813
|
+
/**
|
|
814
|
+
* Generated by Kubb (https://kubb.dev/).
|
|
815
|
+
* Do not edit manually.
|
|
816
|
+
*/
|
|
817
|
+
|
|
818
|
+
/**
|
|
819
|
+
* @description Cursor-paginated cache-rule entries for a database.
|
|
820
|
+
*/
|
|
821
|
+
type ListCacheRulesResponse = {
|
|
822
|
+
/**
|
|
823
|
+
* @description Query shapes returned for the current page.
|
|
824
|
+
* @type array
|
|
825
|
+
*/
|
|
826
|
+
entries: CacheRuleEntry[];
|
|
827
|
+
/**
|
|
828
|
+
* @description Opaque token for cursor-based pagination.
|
|
829
|
+
* @type string | undefined
|
|
830
|
+
*/
|
|
831
|
+
next_page_token?: string;
|
|
832
|
+
};
|
|
833
|
+
|
|
834
|
+
/**
|
|
835
|
+
* Generated by Kubb (https://kubb.dev/).
|
|
836
|
+
* Do not edit manually.
|
|
837
|
+
*/
|
|
838
|
+
|
|
839
|
+
type ListCacheRulesPathParams = {
|
|
840
|
+
/**
|
|
841
|
+
* @description Unique project identifier (prefixed, e.g. prj_xxx).
|
|
842
|
+
* @pattern ^[a-zA-Z0-9_.-]+$
|
|
843
|
+
* @type string
|
|
844
|
+
*/
|
|
845
|
+
project_id: string;
|
|
846
|
+
/**
|
|
847
|
+
* @description Unique database identifier (prefixed, e.g. db_xxx).
|
|
848
|
+
* @pattern ^[a-zA-Z0-9_.-]+$
|
|
849
|
+
* @type string
|
|
850
|
+
*/
|
|
851
|
+
database_id: string;
|
|
852
|
+
};
|
|
853
|
+
type ListCacheRulesQueryParams = {
|
|
854
|
+
/**
|
|
855
|
+
* @description Maximum number of items to return (1-100, default 20).
|
|
856
|
+
* @minLength 1
|
|
857
|
+
* @maxLength 100
|
|
858
|
+
* @default 20
|
|
859
|
+
* @type integer | undefined
|
|
860
|
+
*/
|
|
861
|
+
page_size?: number;
|
|
862
|
+
/**
|
|
863
|
+
* @description Opaque token for cursor-based pagination.
|
|
864
|
+
* @pattern ^[a-zA-Z0-9_.-]+$
|
|
865
|
+
* @type string | undefined
|
|
866
|
+
*/
|
|
867
|
+
page_token?: string;
|
|
868
|
+
};
|
|
869
|
+
/**
|
|
870
|
+
* @description Cache rule entries.
|
|
871
|
+
*/
|
|
872
|
+
type ListCacheRules200 = ListCacheRulesResponse;
|
|
873
|
+
type ListCacheRulesQueryResponse = ListCacheRules200;
|
|
874
|
+
|
|
875
|
+
/**
|
|
876
|
+
* Generated by Kubb (https://kubb.dev/).
|
|
877
|
+
* Do not edit manually.
|
|
878
|
+
*/
|
|
879
|
+
/**
|
|
880
|
+
* @description Request body for updating cache behavior of a query shape.
|
|
881
|
+
*/
|
|
882
|
+
type UpdateCacheRuleRequest = {
|
|
883
|
+
/**
|
|
884
|
+
* @description Whether to enable caching for this query shape.
|
|
885
|
+
* @type boolean
|
|
886
|
+
*/
|
|
887
|
+
cache_enabled: boolean;
|
|
888
|
+
/**
|
|
889
|
+
* @description TTL override in seconds. Null to use project default.
|
|
890
|
+
* @minLength 0
|
|
891
|
+
* @maxLength 86400
|
|
892
|
+
* @type integer
|
|
893
|
+
*/
|
|
894
|
+
cache_ttl_seconds?: number | null;
|
|
895
|
+
/**
|
|
896
|
+
* @description SWR override in seconds. Null to use project default.
|
|
897
|
+
* @minLength 0
|
|
898
|
+
* @maxLength 86400
|
|
899
|
+
* @type integer
|
|
900
|
+
*/
|
|
901
|
+
cache_swr_seconds?: number | null;
|
|
902
|
+
};
|
|
903
|
+
|
|
904
|
+
/**
|
|
905
|
+
* Generated by Kubb (https://kubb.dev/).
|
|
906
|
+
* Do not edit manually.
|
|
907
|
+
*/
|
|
908
|
+
|
|
909
|
+
/**
|
|
910
|
+
* @description Response returned after updating a cache rule.
|
|
911
|
+
*/
|
|
912
|
+
type UpdateCacheRuleResponse = {
|
|
913
|
+
/**
|
|
914
|
+
* @description Observed query shape and its cache recommendation for a database.
|
|
915
|
+
* @type object
|
|
916
|
+
*/
|
|
917
|
+
entry: CacheRuleEntry;
|
|
918
|
+
};
|
|
919
|
+
|
|
920
|
+
/**
|
|
921
|
+
* Generated by Kubb (https://kubb.dev/).
|
|
922
|
+
* Do not edit manually.
|
|
923
|
+
*/
|
|
924
|
+
|
|
925
|
+
type UpdateCacheRulePathParams = {
|
|
926
|
+
/**
|
|
927
|
+
* @description Unique project identifier (prefixed, e.g. prj_xxx).
|
|
928
|
+
* @pattern ^[a-zA-Z0-9_.-]+$
|
|
929
|
+
* @type string
|
|
930
|
+
*/
|
|
931
|
+
project_id: string;
|
|
932
|
+
/**
|
|
933
|
+
* @description Unique database identifier (prefixed, e.g. db_xxx).
|
|
934
|
+
* @pattern ^[a-zA-Z0-9_.-]+$
|
|
935
|
+
* @type string
|
|
936
|
+
*/
|
|
937
|
+
database_id: string;
|
|
938
|
+
/**
|
|
939
|
+
* @description xxhash64 hex of the normalized SQL.
|
|
940
|
+
* @minLength 16
|
|
941
|
+
* @maxLength 16
|
|
942
|
+
* @pattern ^[a-f0-9]+$
|
|
943
|
+
* @type string
|
|
944
|
+
*/
|
|
945
|
+
query_hash: string;
|
|
946
|
+
};
|
|
947
|
+
/**
|
|
948
|
+
* @description Cache rule updated.
|
|
949
|
+
*/
|
|
950
|
+
type UpdateCacheRule200 = UpdateCacheRuleResponse;
|
|
951
|
+
type UpdateCacheRuleMutationRequest = UpdateCacheRuleRequest;
|
|
952
|
+
type UpdateCacheRuleMutationResponse = UpdateCacheRule200;
|
|
953
|
+
|
|
954
|
+
/**
|
|
955
|
+
* Generated by Kubb (https://kubb.dev/).
|
|
956
|
+
* Do not edit manually.
|
|
957
|
+
*/
|
|
958
|
+
/**
|
|
959
|
+
* @description Query cache configuration.
|
|
960
|
+
*/
|
|
961
|
+
type CacheConfig = {
|
|
962
|
+
/**
|
|
963
|
+
* @description Whether query caching is enabled. When false, all queries bypass the cache.
|
|
964
|
+
* @default true
|
|
965
|
+
* @type boolean
|
|
966
|
+
*/
|
|
967
|
+
enabled: boolean;
|
|
968
|
+
/**
|
|
969
|
+
* @description Cache TTL in seconds for query results.
|
|
970
|
+
* @minLength 0
|
|
971
|
+
* @maxLength 86400
|
|
972
|
+
* @default 60
|
|
973
|
+
* @type integer
|
|
974
|
+
*/
|
|
975
|
+
ttl_seconds: number;
|
|
976
|
+
/**
|
|
977
|
+
* @description Maximum number of cached query results.
|
|
978
|
+
* @minLength 0
|
|
979
|
+
* @maxLength 1000000
|
|
980
|
+
* @default 10000
|
|
981
|
+
* @type integer
|
|
982
|
+
*/
|
|
983
|
+
max_entries: number;
|
|
984
|
+
/**
|
|
985
|
+
* @description Stale-while-revalidate window in seconds.
|
|
986
|
+
* @minLength 0
|
|
987
|
+
* @maxLength 86400
|
|
988
|
+
* @default 30
|
|
989
|
+
* @type integer
|
|
990
|
+
*/
|
|
991
|
+
swr_seconds: number;
|
|
992
|
+
};
|
|
993
|
+
|
|
994
|
+
/**
|
|
995
|
+
* Generated by Kubb (https://kubb.dev/).
|
|
996
|
+
* Do not edit manually.
|
|
997
|
+
*/
|
|
998
|
+
declare const databaseRoleEnum: {
|
|
999
|
+
readonly primary: "primary";
|
|
1000
|
+
readonly replica: "replica";
|
|
1001
|
+
};
|
|
1002
|
+
type DatabaseRoleEnumKey = (typeof databaseRoleEnum)[keyof typeof databaseRoleEnum];
|
|
1003
|
+
/**
|
|
1004
|
+
* @description Database role. Primary receives writes, replicas receive reads.
|
|
1005
|
+
* @default primary
|
|
1006
|
+
*/
|
|
1007
|
+
type DatabaseRole = DatabaseRoleEnumKey;
|
|
1008
|
+
|
|
1009
|
+
/**
|
|
1010
|
+
* Generated by Kubb (https://kubb.dev/).
|
|
1011
|
+
* Do not edit manually.
|
|
1012
|
+
*/
|
|
1013
|
+
declare const poolModeEnum: {
|
|
1014
|
+
readonly session: "session";
|
|
1015
|
+
readonly transaction: "transaction";
|
|
1016
|
+
readonly statement: "statement";
|
|
1017
|
+
};
|
|
1018
|
+
type PoolModeEnumKey = (typeof poolModeEnum)[keyof typeof poolModeEnum];
|
|
1019
|
+
/**
|
|
1020
|
+
* @description Connection pool mode.
|
|
1021
|
+
*/
|
|
1022
|
+
type PoolMode = PoolModeEnumKey;
|
|
1023
|
+
|
|
1024
|
+
/**
|
|
1025
|
+
* Generated by Kubb (https://kubb.dev/).
|
|
1026
|
+
* Do not edit manually.
|
|
1027
|
+
*/
|
|
1028
|
+
|
|
1029
|
+
/**
|
|
1030
|
+
* @description Connection pool configuration.
|
|
1031
|
+
*/
|
|
1032
|
+
type PoolConfig = {
|
|
1033
|
+
/**
|
|
1034
|
+
* @description Maximum connections in the pool.
|
|
1035
|
+
* @minLength 1
|
|
1036
|
+
* @maxLength 10000
|
|
1037
|
+
* @default 10
|
|
1038
|
+
* @type integer
|
|
1039
|
+
*/
|
|
1040
|
+
pool_size: number;
|
|
1041
|
+
/**
|
|
1042
|
+
* @description Minimum idle connections maintained.
|
|
1043
|
+
* @minLength 1
|
|
1044
|
+
* @maxLength 10000
|
|
1045
|
+
* @default 1
|
|
1046
|
+
* @type integer
|
|
1047
|
+
*/
|
|
1048
|
+
min_pool_size: number;
|
|
1049
|
+
/**
|
|
1050
|
+
* @description Connection pool mode.
|
|
1051
|
+
* @type string
|
|
1052
|
+
*/
|
|
1053
|
+
pool_mode: PoolMode;
|
|
1054
|
+
/**
|
|
1055
|
+
* @description Maximum concurrent upstream connections per pool.
|
|
1056
|
+
* @minLength 1
|
|
1057
|
+
* @maxLength 10000
|
|
1058
|
+
* @default 200
|
|
1059
|
+
* @type integer | undefined
|
|
1060
|
+
*/
|
|
1061
|
+
max_active?: number;
|
|
1062
|
+
};
|
|
1063
|
+
|
|
1064
|
+
/**
|
|
1065
|
+
* Generated by Kubb (https://kubb.dev/).
|
|
1066
|
+
* Do not edit manually.
|
|
1067
|
+
*/
|
|
1068
|
+
declare const SSLModeEnum: {
|
|
1069
|
+
readonly disable: "disable";
|
|
1070
|
+
readonly allow: "allow";
|
|
1071
|
+
readonly prefer: "prefer";
|
|
1072
|
+
readonly require: "require";
|
|
1073
|
+
readonly "verify-ca": "verify-ca";
|
|
1074
|
+
readonly "verify-full": "verify-full";
|
|
1075
|
+
};
|
|
1076
|
+
type SSLModeEnumKey = (typeof SSLModeEnum)[keyof typeof SSLModeEnum];
|
|
1077
|
+
/**
|
|
1078
|
+
* @description PostgreSQL SSL connection mode.
|
|
1079
|
+
*/
|
|
1080
|
+
type SSLMode = SSLModeEnumKey;
|
|
1081
|
+
|
|
1082
|
+
/**
|
|
1083
|
+
* Generated by Kubb (https://kubb.dev/).
|
|
1084
|
+
* Do not edit manually.
|
|
1085
|
+
*/
|
|
1086
|
+
|
|
1087
|
+
/**
|
|
1088
|
+
* @description Registered upstream PostgreSQL database for a project.
|
|
1089
|
+
*/
|
|
1090
|
+
type Database = {
|
|
1091
|
+
/**
|
|
1092
|
+
* @description Unique database identifier (prefixed).
|
|
1093
|
+
* @type string
|
|
1094
|
+
*/
|
|
1095
|
+
id: string;
|
|
1096
|
+
/**
|
|
1097
|
+
* @description Owning project ID.
|
|
1098
|
+
* @type string
|
|
1099
|
+
*/
|
|
1100
|
+
project_id: string;
|
|
1101
|
+
/**
|
|
1102
|
+
* @description Connection string for connecting through PgBeam proxy. Password is replaced with a placeholder.
|
|
1103
|
+
* @type string | undefined
|
|
1104
|
+
*/
|
|
1105
|
+
readonly connection_string?: string;
|
|
1106
|
+
/**
|
|
1107
|
+
* @description PostgreSQL host.
|
|
1108
|
+
* @type string
|
|
1109
|
+
*/
|
|
1110
|
+
host: string;
|
|
1111
|
+
/**
|
|
1112
|
+
* @description PostgreSQL port.
|
|
1113
|
+
* @minLength 1
|
|
1114
|
+
* @maxLength 65535
|
|
1115
|
+
* @type integer
|
|
1116
|
+
*/
|
|
1117
|
+
port: number;
|
|
1118
|
+
/**
|
|
1119
|
+
* @description PostgreSQL database name.
|
|
1120
|
+
* @type string
|
|
1121
|
+
*/
|
|
1122
|
+
name: string;
|
|
1123
|
+
/**
|
|
1124
|
+
* @description PostgreSQL username.
|
|
1125
|
+
* @type string
|
|
1126
|
+
*/
|
|
1127
|
+
username: string;
|
|
1128
|
+
/**
|
|
1129
|
+
* @description PostgreSQL SSL connection mode.
|
|
1130
|
+
* @type string
|
|
1131
|
+
*/
|
|
1132
|
+
ssl_mode: SSLMode;
|
|
1133
|
+
/**
|
|
1134
|
+
* @description Database role. Primary receives writes, replicas receive reads.
|
|
1135
|
+
* @default "primary"
|
|
1136
|
+
* @type string | undefined
|
|
1137
|
+
*/
|
|
1138
|
+
role?: DatabaseRole;
|
|
1139
|
+
/**
|
|
1140
|
+
* @description Region where the connection pool is maintained (near the database). When set and different from the client\'s edge region, queries are relayed through the pool region\'s data plane. Empty means direct connection.\n
|
|
1141
|
+
* @type string | undefined
|
|
1142
|
+
*/
|
|
1143
|
+
pool_region?: string;
|
|
1144
|
+
/**
|
|
1145
|
+
* @description Query cache configuration.
|
|
1146
|
+
* @type object
|
|
1147
|
+
*/
|
|
1148
|
+
cache_config: CacheConfig;
|
|
1149
|
+
/**
|
|
1150
|
+
* @description Connection pool configuration.
|
|
1151
|
+
* @type object
|
|
1152
|
+
*/
|
|
1153
|
+
pool_config: PoolConfig;
|
|
1154
|
+
/**
|
|
1155
|
+
* @description When the database registration was created.
|
|
1156
|
+
* @type string, date-time
|
|
1157
|
+
*/
|
|
1158
|
+
created_at: string;
|
|
1159
|
+
/**
|
|
1160
|
+
* @description When the database registration was last updated.
|
|
1161
|
+
* @type string, date-time
|
|
1162
|
+
*/
|
|
1163
|
+
updated_at: string;
|
|
1164
|
+
};
|
|
1165
|
+
|
|
1166
|
+
/**
|
|
1167
|
+
* Generated by Kubb (https://kubb.dev/).
|
|
1168
|
+
* Do not edit manually.
|
|
1169
|
+
*/
|
|
1170
|
+
|
|
1171
|
+
/**
|
|
1172
|
+
* @description Cursor-paginated list of databases attached to a project.
|
|
1173
|
+
*/
|
|
1174
|
+
type ListDatabasesResponse = {
|
|
1175
|
+
/**
|
|
1176
|
+
* @description Databases on the current page.
|
|
1177
|
+
* @type array
|
|
1178
|
+
*/
|
|
1179
|
+
databases: Database[];
|
|
1180
|
+
/**
|
|
1181
|
+
* @description Token for the next page. Empty if no more results.
|
|
1182
|
+
* @type string | undefined
|
|
1183
|
+
*/
|
|
1184
|
+
next_page_token?: string;
|
|
1185
|
+
};
|
|
1186
|
+
|
|
1187
|
+
/**
|
|
1188
|
+
* Generated by Kubb (https://kubb.dev/).
|
|
1189
|
+
* Do not edit manually.
|
|
1190
|
+
*/
|
|
1191
|
+
|
|
1192
|
+
type ListDatabasesPathParams = {
|
|
1193
|
+
/**
|
|
1194
|
+
* @description Unique project identifier (prefixed, e.g. prj_xxx).
|
|
1195
|
+
* @pattern ^[a-zA-Z0-9_.-]+$
|
|
1196
|
+
* @type string
|
|
1197
|
+
*/
|
|
1198
|
+
project_id: string;
|
|
1199
|
+
};
|
|
1200
|
+
type ListDatabasesQueryParams = {
|
|
1201
|
+
/**
|
|
1202
|
+
* @description Maximum number of items to return (1-100, default 20).
|
|
1203
|
+
* @minLength 1
|
|
1204
|
+
* @maxLength 100
|
|
1205
|
+
* @default 20
|
|
1206
|
+
* @type integer | undefined
|
|
1207
|
+
*/
|
|
1208
|
+
page_size?: number;
|
|
1209
|
+
/**
|
|
1210
|
+
* @description Opaque token for cursor-based pagination.
|
|
1211
|
+
* @pattern ^[a-zA-Z0-9_.-]+$
|
|
1212
|
+
* @type string | undefined
|
|
1213
|
+
*/
|
|
1214
|
+
page_token?: string;
|
|
1215
|
+
};
|
|
1216
|
+
/**
|
|
1217
|
+
* @description List of databases.
|
|
1218
|
+
*/
|
|
1219
|
+
type ListDatabases200 = ListDatabasesResponse;
|
|
1220
|
+
type ListDatabasesQueryResponse = ListDatabases200;
|
|
1221
|
+
|
|
1222
|
+
/**
|
|
1223
|
+
* Generated by Kubb (https://kubb.dev/).
|
|
1224
|
+
* Do not edit manually.
|
|
1225
|
+
*/
|
|
1226
|
+
|
|
1227
|
+
/**
|
|
1228
|
+
* @description Request body for registering an upstream database.
|
|
1229
|
+
*/
|
|
1230
|
+
type CreateDatabaseRequest = {
|
|
1231
|
+
/**
|
|
1232
|
+
* @description PostgreSQL host.
|
|
1233
|
+
* @minLength 1
|
|
1234
|
+
* @pattern ^[^\s\x00]+$
|
|
1235
|
+
* @type string
|
|
1236
|
+
*/
|
|
1237
|
+
host: string;
|
|
1238
|
+
/**
|
|
1239
|
+
* @description PostgreSQL port.
|
|
1240
|
+
* @minLength 1
|
|
1241
|
+
* @maxLength 65535
|
|
1242
|
+
* @type integer
|
|
1243
|
+
*/
|
|
1244
|
+
port: number;
|
|
1245
|
+
/**
|
|
1246
|
+
* @description PostgreSQL database name.
|
|
1247
|
+
* @minLength 1
|
|
1248
|
+
* @pattern ^[^\x00]+$
|
|
1249
|
+
* @type string
|
|
1250
|
+
*/
|
|
1251
|
+
name: string;
|
|
1252
|
+
/**
|
|
1253
|
+
* @description PostgreSQL username.
|
|
1254
|
+
* @minLength 1
|
|
1255
|
+
* @pattern ^[^\x00]+$
|
|
1256
|
+
* @type string
|
|
1257
|
+
*/
|
|
1258
|
+
username: string;
|
|
1259
|
+
/**
|
|
1260
|
+
* @description PostgreSQL password. Stored encrypted at rest.
|
|
1261
|
+
* @minLength 1
|
|
1262
|
+
* @pattern ^[^\x00]+$
|
|
1263
|
+
* @type string, password
|
|
1264
|
+
*/
|
|
1265
|
+
password: string;
|
|
1266
|
+
/**
|
|
1267
|
+
* @description PostgreSQL SSL connection mode.
|
|
1268
|
+
* @type string | undefined
|
|
1269
|
+
*/
|
|
1270
|
+
ssl_mode?: SSLMode;
|
|
1271
|
+
/**
|
|
1272
|
+
* @description Database role. Primary receives writes, replicas receive reads.
|
|
1273
|
+
* @default "primary"
|
|
1274
|
+
* @type string | undefined
|
|
1275
|
+
*/
|
|
1276
|
+
role?: DatabaseRole;
|
|
1277
|
+
/**
|
|
1278
|
+
* @description Region where the connection pool is maintained (near the database). When set and different from the client\'s edge region, queries are relayed through the pool region\'s data plane. Empty means direct connection.\n
|
|
1279
|
+
* @type string | undefined
|
|
1280
|
+
*/
|
|
1281
|
+
pool_region?: string;
|
|
1282
|
+
/**
|
|
1283
|
+
* @description Query cache configuration.
|
|
1284
|
+
* @type object | undefined
|
|
1285
|
+
*/
|
|
1286
|
+
cache_config?: CacheConfig;
|
|
1287
|
+
/**
|
|
1288
|
+
* @description Connection pool configuration.
|
|
1289
|
+
* @type object | undefined
|
|
1290
|
+
*/
|
|
1291
|
+
pool_config?: PoolConfig;
|
|
1292
|
+
};
|
|
1293
|
+
|
|
1294
|
+
/**
|
|
1295
|
+
* Generated by Kubb (https://kubb.dev/).
|
|
1296
|
+
* Do not edit manually.
|
|
1297
|
+
*/
|
|
1298
|
+
|
|
1299
|
+
type CreateDatabasePathParams = {
|
|
1300
|
+
/**
|
|
1301
|
+
* @description Unique project identifier (prefixed, e.g. prj_xxx).
|
|
1302
|
+
* @pattern ^[a-zA-Z0-9_.-]+$
|
|
1303
|
+
* @type string
|
|
1304
|
+
*/
|
|
1305
|
+
project_id: string;
|
|
1306
|
+
};
|
|
1307
|
+
/**
|
|
1308
|
+
* @description Database created.
|
|
1309
|
+
*/
|
|
1310
|
+
type CreateDatabase201 = Database;
|
|
1311
|
+
type CreateDatabaseMutationRequest = CreateDatabaseRequest;
|
|
1312
|
+
type CreateDatabaseMutationResponse = CreateDatabase201;
|
|
1313
|
+
|
|
1314
|
+
/**
|
|
1315
|
+
* Generated by Kubb (https://kubb.dev/).
|
|
1316
|
+
* Do not edit manually.
|
|
1317
|
+
*/
|
|
1318
|
+
|
|
1319
|
+
type GetDatabasePathParams = {
|
|
1320
|
+
/**
|
|
1321
|
+
* @description Unique project identifier (prefixed, e.g. prj_xxx).
|
|
1322
|
+
* @pattern ^[a-zA-Z0-9_.-]+$
|
|
1323
|
+
* @type string
|
|
1324
|
+
*/
|
|
1325
|
+
project_id: string;
|
|
1326
|
+
/**
|
|
1327
|
+
* @description Unique database identifier (prefixed, e.g. db_xxx).
|
|
1328
|
+
* @pattern ^[a-zA-Z0-9_.-]+$
|
|
1329
|
+
* @type string
|
|
1330
|
+
*/
|
|
1331
|
+
database_id: string;
|
|
1332
|
+
};
|
|
1333
|
+
/**
|
|
1334
|
+
* @description Database found.
|
|
1335
|
+
*/
|
|
1336
|
+
type GetDatabase200 = Database;
|
|
1337
|
+
type GetDatabaseQueryResponse = GetDatabase200;
|
|
1338
|
+
|
|
1339
|
+
/**
|
|
1340
|
+
* Generated by Kubb (https://kubb.dev/).
|
|
1341
|
+
* Do not edit manually.
|
|
1342
|
+
*/
|
|
1343
|
+
|
|
1344
|
+
/**
|
|
1345
|
+
* @description Request body for partially updating an upstream database.
|
|
1346
|
+
*/
|
|
1347
|
+
type UpdateDatabaseRequest = {
|
|
1348
|
+
/**
|
|
1349
|
+
* @description Updated PostgreSQL host.
|
|
1350
|
+
* @minLength 1
|
|
1351
|
+
* @pattern ^[^\x00]+$
|
|
1352
|
+
* @type string | undefined
|
|
1353
|
+
*/
|
|
1354
|
+
host?: string;
|
|
1355
|
+
/**
|
|
1356
|
+
* @description Updated PostgreSQL port.
|
|
1357
|
+
* @minLength 1
|
|
1358
|
+
* @maxLength 65535
|
|
1359
|
+
* @type integer | undefined
|
|
1360
|
+
*/
|
|
1361
|
+
port?: number;
|
|
1362
|
+
/**
|
|
1363
|
+
* @description Updated PostgreSQL database name.
|
|
1364
|
+
* @pattern ^[^\x00]*$
|
|
1365
|
+
* @type string | undefined
|
|
1366
|
+
*/
|
|
1367
|
+
name?: string;
|
|
1368
|
+
/**
|
|
1369
|
+
* @description Updated PostgreSQL username.
|
|
1370
|
+
* @pattern ^[^\x00]*$
|
|
1371
|
+
* @type string | undefined
|
|
1372
|
+
*/
|
|
1373
|
+
username?: string;
|
|
1374
|
+
/**
|
|
1375
|
+
* @description Updated PostgreSQL password.
|
|
1376
|
+
* @pattern ^[^\x00]*$
|
|
1377
|
+
* @type string | undefined, password
|
|
1378
|
+
*/
|
|
1379
|
+
password?: string;
|
|
1380
|
+
/**
|
|
1381
|
+
* @description PostgreSQL SSL connection mode.
|
|
1382
|
+
* @type string | undefined
|
|
1383
|
+
*/
|
|
1384
|
+
ssl_mode?: SSLMode;
|
|
1385
|
+
/**
|
|
1386
|
+
* @description Database role. Primary receives writes, replicas receive reads.
|
|
1387
|
+
* @default "primary"
|
|
1388
|
+
* @type string | undefined
|
|
1389
|
+
*/
|
|
1390
|
+
role?: DatabaseRole;
|
|
1391
|
+
/**
|
|
1392
|
+
* @description Region where the connection pool is maintained (near the database). When set and different from the client\'s edge region, queries are relayed through the pool region\'s data plane. Empty means direct connection.\n
|
|
1393
|
+
* @type string | undefined
|
|
1394
|
+
*/
|
|
1395
|
+
pool_region?: string;
|
|
1396
|
+
/**
|
|
1397
|
+
* @description Query cache configuration.
|
|
1398
|
+
* @type object | undefined
|
|
1399
|
+
*/
|
|
1400
|
+
cache_config?: CacheConfig;
|
|
1401
|
+
/**
|
|
1402
|
+
* @description Connection pool configuration.
|
|
1403
|
+
* @type object | undefined
|
|
1404
|
+
*/
|
|
1405
|
+
pool_config?: PoolConfig;
|
|
1406
|
+
};
|
|
1407
|
+
|
|
1408
|
+
/**
|
|
1409
|
+
* Generated by Kubb (https://kubb.dev/).
|
|
1410
|
+
* Do not edit manually.
|
|
1411
|
+
*/
|
|
1412
|
+
|
|
1413
|
+
type UpdateDatabasePathParams = {
|
|
1414
|
+
/**
|
|
1415
|
+
* @description Unique project identifier (prefixed, e.g. prj_xxx).
|
|
1416
|
+
* @pattern ^[a-zA-Z0-9_.-]+$
|
|
1417
|
+
* @type string
|
|
1418
|
+
*/
|
|
1419
|
+
project_id: string;
|
|
1420
|
+
/**
|
|
1421
|
+
* @description Unique database identifier (prefixed, e.g. db_xxx).
|
|
1422
|
+
* @pattern ^[a-zA-Z0-9_.-]+$
|
|
1423
|
+
* @type string
|
|
1424
|
+
*/
|
|
1425
|
+
database_id: string;
|
|
1426
|
+
};
|
|
1427
|
+
/**
|
|
1428
|
+
* @description Database updated.
|
|
1429
|
+
*/
|
|
1430
|
+
type UpdateDatabase200 = Database;
|
|
1431
|
+
type UpdateDatabaseMutationRequest = UpdateDatabaseRequest;
|
|
1432
|
+
type UpdateDatabaseMutationResponse = UpdateDatabase200;
|
|
1433
|
+
|
|
1434
|
+
/**
|
|
1435
|
+
* Generated by Kubb (https://kubb.dev/).
|
|
1436
|
+
* Do not edit manually.
|
|
1437
|
+
*/
|
|
1438
|
+
|
|
1439
|
+
type DeleteDatabasePathParams = {
|
|
1440
|
+
/**
|
|
1441
|
+
* @description Unique project identifier (prefixed, e.g. prj_xxx).
|
|
1442
|
+
* @pattern ^[a-zA-Z0-9_.-]+$
|
|
1443
|
+
* @type string
|
|
1444
|
+
*/
|
|
1445
|
+
project_id: string;
|
|
1446
|
+
/**
|
|
1447
|
+
* @description Unique database identifier (prefixed, e.g. db_xxx).
|
|
1448
|
+
* @pattern ^[a-zA-Z0-9_.-]+$
|
|
1449
|
+
* @type string
|
|
1450
|
+
*/
|
|
1451
|
+
database_id: string;
|
|
1452
|
+
};
|
|
1453
|
+
|
|
1454
|
+
/**
|
|
1455
|
+
* Generated by Kubb (https://kubb.dev/).
|
|
1456
|
+
* Do not edit manually.
|
|
1457
|
+
*/
|
|
1458
|
+
/**
|
|
1459
|
+
* @description Result of testing connectivity to an upstream database.
|
|
1460
|
+
*/
|
|
1461
|
+
type TestConnectionResult = {
|
|
1462
|
+
/**
|
|
1463
|
+
* @description Whether the connection test succeeded.
|
|
1464
|
+
* @type boolean
|
|
1465
|
+
*/
|
|
1466
|
+
ok: boolean;
|
|
1467
|
+
/**
|
|
1468
|
+
* @description Round-trip connection time in milliseconds.
|
|
1469
|
+
* @type number
|
|
1470
|
+
*/
|
|
1471
|
+
latency_ms?: number | null;
|
|
1472
|
+
/**
|
|
1473
|
+
* @description Error message if the connection test failed.
|
|
1474
|
+
* @type string | undefined
|
|
1475
|
+
*/
|
|
1476
|
+
error?: string;
|
|
1477
|
+
/**
|
|
1478
|
+
* @description PostgreSQL server version string, if available.
|
|
1479
|
+
* @type string | undefined
|
|
1480
|
+
*/
|
|
1481
|
+
server_version?: string;
|
|
1482
|
+
};
|
|
1483
|
+
|
|
1484
|
+
/**
|
|
1485
|
+
* Generated by Kubb (https://kubb.dev/).
|
|
1486
|
+
* Do not edit manually.
|
|
1487
|
+
*/
|
|
1488
|
+
|
|
1489
|
+
type TestDatabaseConnectionPathParams = {
|
|
1490
|
+
/**
|
|
1491
|
+
* @description Unique project identifier (prefixed, e.g. prj_xxx).
|
|
1492
|
+
* @pattern ^[a-zA-Z0-9_.-]+$
|
|
1493
|
+
* @type string
|
|
1494
|
+
*/
|
|
1495
|
+
project_id: string;
|
|
1496
|
+
/**
|
|
1497
|
+
* @description Unique database identifier (prefixed, e.g. db_xxx).
|
|
1498
|
+
* @pattern ^[a-zA-Z0-9_.-]+$
|
|
1499
|
+
* @type string
|
|
1500
|
+
*/
|
|
1501
|
+
database_id: string;
|
|
1502
|
+
};
|
|
1503
|
+
/**
|
|
1504
|
+
* @description Connection test result.
|
|
1505
|
+
*/
|
|
1506
|
+
type TestDatabaseConnection200 = TestConnectionResult;
|
|
1507
|
+
type TestDatabaseConnectionMutationResponse = TestDatabaseConnection200;
|
|
1508
|
+
|
|
1509
|
+
/**
|
|
1510
|
+
* Generated by Kubb (https://kubb.dev/).
|
|
1511
|
+
* Do not edit manually.
|
|
1512
|
+
*/
|
|
1513
|
+
/**
|
|
1514
|
+
* @description Custom database hostname attached to a project.
|
|
1515
|
+
*/
|
|
1516
|
+
type CustomDomain = {
|
|
1517
|
+
/**
|
|
1518
|
+
* @description Unique domain identifier (prefixed).
|
|
1519
|
+
* @type string
|
|
1520
|
+
*/
|
|
1521
|
+
id: string;
|
|
1522
|
+
/**
|
|
1523
|
+
* @description Owning project ID.
|
|
1524
|
+
* @type string
|
|
1525
|
+
*/
|
|
1526
|
+
project_id: string;
|
|
1527
|
+
/**
|
|
1528
|
+
* @description The custom domain name.
|
|
1529
|
+
* @type string
|
|
1530
|
+
*/
|
|
1531
|
+
domain: string;
|
|
1532
|
+
/**
|
|
1533
|
+
* @description Whether DNS ownership has been verified.
|
|
1534
|
+
* @type boolean
|
|
1535
|
+
*/
|
|
1536
|
+
verified: boolean;
|
|
1537
|
+
/**
|
|
1538
|
+
* @description When DNS verification was completed.
|
|
1539
|
+
* @type string, date-time
|
|
1540
|
+
*/
|
|
1541
|
+
verified_at?: string | null;
|
|
1542
|
+
/**
|
|
1543
|
+
* @description When the TLS certificate expires.
|
|
1544
|
+
* @type string, date-time
|
|
1545
|
+
*/
|
|
1546
|
+
tls_cert_expiry?: string | null;
|
|
1547
|
+
/**
|
|
1548
|
+
* @description Token value for the DNS TXT record verification.
|
|
1549
|
+
* @type string
|
|
1550
|
+
*/
|
|
1551
|
+
dns_verification_token: string;
|
|
1552
|
+
/**
|
|
1553
|
+
* @description DNS records the user needs to create.
|
|
1554
|
+
* @type object | undefined
|
|
1555
|
+
*/
|
|
1556
|
+
dns_instructions?: {
|
|
1557
|
+
/**
|
|
1558
|
+
* @description The CNAME record host.
|
|
1559
|
+
* @type string | undefined
|
|
1560
|
+
*/
|
|
1561
|
+
cname_host?: string;
|
|
1562
|
+
/**
|
|
1563
|
+
* @description The CNAME record target.
|
|
1564
|
+
* @type string | undefined
|
|
1565
|
+
*/
|
|
1566
|
+
cname_target?: string;
|
|
1567
|
+
/**
|
|
1568
|
+
* @description The TXT record host for verification.
|
|
1569
|
+
* @type string | undefined
|
|
1570
|
+
*/
|
|
1571
|
+
txt_host?: string;
|
|
1572
|
+
/**
|
|
1573
|
+
* @description The TXT record value for verification.
|
|
1574
|
+
* @type string | undefined
|
|
1575
|
+
*/
|
|
1576
|
+
txt_value?: string;
|
|
1577
|
+
/**
|
|
1578
|
+
* @description The CNAME record host for ACME TLS certificate issuance.
|
|
1579
|
+
* @type string | undefined
|
|
1580
|
+
*/
|
|
1581
|
+
acme_cname_host?: string;
|
|
1582
|
+
/**
|
|
1583
|
+
* @description The CNAME target for ACME challenge delegation.
|
|
1584
|
+
* @type string | undefined
|
|
1585
|
+
*/
|
|
1586
|
+
acme_cname_target?: string;
|
|
1587
|
+
};
|
|
1588
|
+
/**
|
|
1589
|
+
* @description When the custom domain was created.
|
|
1590
|
+
* @type string, date-time
|
|
1591
|
+
*/
|
|
1592
|
+
created_at: string;
|
|
1593
|
+
/**
|
|
1594
|
+
* @description When the custom domain was last updated.
|
|
1595
|
+
* @type string, date-time
|
|
1596
|
+
*/
|
|
1597
|
+
updated_at: string;
|
|
1598
|
+
};
|
|
1599
|
+
|
|
1600
|
+
/**
|
|
1601
|
+
* Generated by Kubb (https://kubb.dev/).
|
|
1602
|
+
* Do not edit manually.
|
|
1603
|
+
*/
|
|
1604
|
+
|
|
1605
|
+
/**
|
|
1606
|
+
* @description Cursor-paginated list of custom domains for a project.
|
|
1607
|
+
*/
|
|
1608
|
+
type ListCustomDomainsResponse = {
|
|
1609
|
+
/**
|
|
1610
|
+
* @description Custom domains on the current page.
|
|
1611
|
+
* @type array
|
|
1612
|
+
*/
|
|
1613
|
+
domains: CustomDomain[];
|
|
1614
|
+
/**
|
|
1615
|
+
* @description Token for the next page. Empty if no more results.
|
|
1616
|
+
* @type string | undefined
|
|
1617
|
+
*/
|
|
1618
|
+
next_page_token?: string;
|
|
1619
|
+
};
|
|
1620
|
+
|
|
1621
|
+
/**
|
|
1622
|
+
* Generated by Kubb (https://kubb.dev/).
|
|
1623
|
+
* Do not edit manually.
|
|
1624
|
+
*/
|
|
1625
|
+
|
|
1626
|
+
type ListCustomDomainsPathParams = {
|
|
1627
|
+
/**
|
|
1628
|
+
* @description Unique project identifier (prefixed, e.g. prj_xxx).
|
|
1629
|
+
* @pattern ^[a-zA-Z0-9_.-]+$
|
|
1630
|
+
* @type string
|
|
1631
|
+
*/
|
|
1632
|
+
project_id: string;
|
|
1633
|
+
};
|
|
1634
|
+
type ListCustomDomainsQueryParams = {
|
|
1635
|
+
/**
|
|
1636
|
+
* @description Maximum number of items to return (1-100, default 20).
|
|
1637
|
+
* @minLength 1
|
|
1638
|
+
* @maxLength 100
|
|
1639
|
+
* @default 20
|
|
1640
|
+
* @type integer | undefined
|
|
1641
|
+
*/
|
|
1642
|
+
page_size?: number;
|
|
1643
|
+
/**
|
|
1644
|
+
* @description Opaque token for cursor-based pagination.
|
|
1645
|
+
* @pattern ^[a-zA-Z0-9_.-]+$
|
|
1646
|
+
* @type string | undefined
|
|
1647
|
+
*/
|
|
1648
|
+
page_token?: string;
|
|
1649
|
+
};
|
|
1650
|
+
/**
|
|
1651
|
+
* @description List of custom domains.
|
|
1652
|
+
*/
|
|
1653
|
+
type ListCustomDomains200 = ListCustomDomainsResponse;
|
|
1654
|
+
type ListCustomDomainsQueryResponse = ListCustomDomains200;
|
|
1655
|
+
|
|
1656
|
+
/**
|
|
1657
|
+
* Generated by Kubb (https://kubb.dev/).
|
|
1658
|
+
* Do not edit manually.
|
|
1659
|
+
*/
|
|
1660
|
+
/**
|
|
1661
|
+
* @description Request body for attaching a custom domain to a project.
|
|
1662
|
+
*/
|
|
1663
|
+
type CreateCustomDomainRequest = {
|
|
1664
|
+
/**
|
|
1665
|
+
* @description The custom domain name to add (e.g., db.example.com).
|
|
1666
|
+
* @minLength 1
|
|
1667
|
+
* @maxLength 253
|
|
1668
|
+
* @pattern ^[a-zA-Z0-9]([a-zA-Z0-9-]*[a-zA-Z0-9])?(\.[a-zA-Z0-9]([a-zA-Z0-9-]*[a-zA-Z0-9])?)*$
|
|
1669
|
+
* @type string
|
|
1670
|
+
*/
|
|
1671
|
+
domain: string;
|
|
1672
|
+
};
|
|
1673
|
+
|
|
1674
|
+
/**
|
|
1675
|
+
* Generated by Kubb (https://kubb.dev/).
|
|
1676
|
+
* Do not edit manually.
|
|
1677
|
+
*/
|
|
1678
|
+
|
|
1679
|
+
type CreateCustomDomainPathParams = {
|
|
1680
|
+
/**
|
|
1681
|
+
* @description Unique project identifier (prefixed, e.g. prj_xxx).
|
|
1682
|
+
* @pattern ^[a-zA-Z0-9_.-]+$
|
|
1683
|
+
* @type string
|
|
1684
|
+
*/
|
|
1685
|
+
project_id: string;
|
|
1686
|
+
};
|
|
1687
|
+
/**
|
|
1688
|
+
* @description Custom domain created.
|
|
1689
|
+
*/
|
|
1690
|
+
type CreateCustomDomain201 = CustomDomain;
|
|
1691
|
+
type CreateCustomDomainMutationRequest = CreateCustomDomainRequest;
|
|
1692
|
+
type CreateCustomDomainMutationResponse = CreateCustomDomain201;
|
|
1693
|
+
|
|
1694
|
+
/**
|
|
1695
|
+
* Generated by Kubb (https://kubb.dev/).
|
|
1696
|
+
* Do not edit manually.
|
|
1697
|
+
*/
|
|
1698
|
+
|
|
1699
|
+
type DeleteCustomDomainPathParams = {
|
|
1700
|
+
/**
|
|
1701
|
+
* @description Unique project identifier (prefixed, e.g. prj_xxx).
|
|
1702
|
+
* @pattern ^[a-zA-Z0-9_.-]+$
|
|
1703
|
+
* @type string
|
|
1704
|
+
*/
|
|
1705
|
+
project_id: string;
|
|
1706
|
+
/**
|
|
1707
|
+
* @description Unique custom domain identifier (prefixed, e.g. dom_xxx).
|
|
1708
|
+
* @pattern ^[a-zA-Z0-9_.-]+$
|
|
1709
|
+
* @type string
|
|
1710
|
+
*/
|
|
1711
|
+
domain_id: string;
|
|
1712
|
+
};
|
|
1713
|
+
|
|
1714
|
+
/**
|
|
1715
|
+
* Generated by Kubb (https://kubb.dev/).
|
|
1716
|
+
* Do not edit manually.
|
|
1717
|
+
*/
|
|
1718
|
+
|
|
1719
|
+
/**
|
|
1720
|
+
* @description Result of checking DNS ownership for a custom domain.
|
|
1721
|
+
*/
|
|
1722
|
+
type VerifyCustomDomainResponse = {
|
|
1723
|
+
/**
|
|
1724
|
+
* @description Whether DNS verification succeeded.
|
|
1725
|
+
* @type boolean
|
|
1726
|
+
*/
|
|
1727
|
+
verified: boolean;
|
|
1728
|
+
/**
|
|
1729
|
+
* @description Error message if verification failed.
|
|
1730
|
+
* @type string | undefined
|
|
1731
|
+
*/
|
|
1732
|
+
error?: string;
|
|
1733
|
+
/**
|
|
1734
|
+
* @description Custom database hostname attached to a project.
|
|
1735
|
+
* @type object | undefined
|
|
1736
|
+
*/
|
|
1737
|
+
domain?: CustomDomain;
|
|
1738
|
+
};
|
|
1739
|
+
|
|
1740
|
+
/**
|
|
1741
|
+
* Generated by Kubb (https://kubb.dev/).
|
|
1742
|
+
* Do not edit manually.
|
|
1743
|
+
*/
|
|
1744
|
+
|
|
1745
|
+
type VerifyCustomDomainPathParams = {
|
|
1746
|
+
/**
|
|
1747
|
+
* @description Unique project identifier (prefixed, e.g. prj_xxx).
|
|
1748
|
+
* @pattern ^[a-zA-Z0-9_.-]+$
|
|
1749
|
+
* @type string
|
|
1750
|
+
*/
|
|
1751
|
+
project_id: string;
|
|
1752
|
+
/**
|
|
1753
|
+
* @description Unique custom domain identifier (prefixed, e.g. dom_xxx).
|
|
1754
|
+
* @pattern ^[a-zA-Z0-9_.-]+$
|
|
1755
|
+
* @type string
|
|
1756
|
+
*/
|
|
1757
|
+
domain_id: string;
|
|
1758
|
+
};
|
|
1759
|
+
/**
|
|
1760
|
+
* @description Verification result.
|
|
1761
|
+
*/
|
|
1762
|
+
type VerifyCustomDomain200 = VerifyCustomDomainResponse;
|
|
1763
|
+
type VerifyCustomDomainMutationResponse = VerifyCustomDomain200;
|
|
1764
|
+
|
|
1765
|
+
/**
|
|
1766
|
+
* Generated by Kubb (https://kubb.dev/).
|
|
1767
|
+
* Do not edit manually.
|
|
1768
|
+
*/
|
|
1769
|
+
declare const healthResponseStatusEnum: {
|
|
1770
|
+
readonly ok: "ok";
|
|
1771
|
+
readonly degraded: "degraded";
|
|
1772
|
+
};
|
|
1773
|
+
type HealthResponseStatusEnumKey = (typeof healthResponseStatusEnum)[keyof typeof healthResponseStatusEnum];
|
|
1774
|
+
/**
|
|
1775
|
+
* @description Health status and build metadata for the API service.
|
|
1776
|
+
*/
|
|
1777
|
+
type HealthResponse = {
|
|
1778
|
+
/**
|
|
1779
|
+
* @description Overall service health.
|
|
1780
|
+
* @type string
|
|
1781
|
+
*/
|
|
1782
|
+
status: HealthResponseStatusEnumKey;
|
|
1783
|
+
/**
|
|
1784
|
+
* @description API server version.
|
|
1785
|
+
* @type string
|
|
1786
|
+
*/
|
|
1787
|
+
version: string;
|
|
1788
|
+
/**
|
|
1789
|
+
* @description Resolved image SHA (digest or SHA tag).
|
|
1790
|
+
* @type string
|
|
1791
|
+
*/
|
|
1792
|
+
image_sha: string;
|
|
1793
|
+
/**
|
|
1794
|
+
* @description Server time.
|
|
1795
|
+
* @type string | undefined, date-time
|
|
1796
|
+
*/
|
|
1797
|
+
timestamp?: string;
|
|
1798
|
+
};
|
|
1799
|
+
|
|
1800
|
+
/**
|
|
1801
|
+
* Generated by Kubb (https://kubb.dev/).
|
|
1802
|
+
* Do not edit manually.
|
|
1803
|
+
*/
|
|
1804
|
+
|
|
1805
|
+
/**
|
|
1806
|
+
* @description Service is healthy.
|
|
1807
|
+
*/
|
|
1808
|
+
type GetHealth200 = HealthResponse;
|
|
1809
|
+
type GetHealthQueryResponse = GetHealth200;
|
|
1810
|
+
|
|
1811
|
+
/**
|
|
1812
|
+
* Generated by Kubb (https://kubb.dev/).
|
|
1813
|
+
* Do not edit manually.
|
|
1814
|
+
*/
|
|
1815
|
+
/**
|
|
1816
|
+
* @description Aggregate cache performance metrics for the selected time range.
|
|
1817
|
+
*/
|
|
1818
|
+
type CacheSummary = {
|
|
1819
|
+
/**
|
|
1820
|
+
* @description Total number of cache hits in the selected time range.
|
|
1821
|
+
* @type integer, int64
|
|
1822
|
+
*/
|
|
1823
|
+
total_hits: number;
|
|
1824
|
+
/**
|
|
1825
|
+
* @description Total number of cache misses in the selected time range.
|
|
1826
|
+
* @type integer, int64
|
|
1827
|
+
*/
|
|
1828
|
+
total_misses: number;
|
|
1829
|
+
/**
|
|
1830
|
+
* @description Cache hit rate as a fraction (0.0 to 1.0).
|
|
1831
|
+
* @type number, double
|
|
1832
|
+
*/
|
|
1833
|
+
hit_rate: number;
|
|
1834
|
+
};
|
|
1835
|
+
|
|
1836
|
+
/**
|
|
1837
|
+
* Generated by Kubb (https://kubb.dev/).
|
|
1838
|
+
* Do not edit manually.
|
|
1839
|
+
*/
|
|
1840
|
+
/**
|
|
1841
|
+
* @description Aggregate latency metrics for the selected time range.
|
|
1842
|
+
*/
|
|
1843
|
+
type LatencySummary = {
|
|
1844
|
+
/**
|
|
1845
|
+
* @description Average latency in milliseconds across all queries.
|
|
1846
|
+
* @type number, double
|
|
1847
|
+
*/
|
|
1848
|
+
avg_ms: number;
|
|
1849
|
+
/**
|
|
1850
|
+
* @description P99 latency in milliseconds across all queries.
|
|
1851
|
+
* @type number, double
|
|
1852
|
+
*/
|
|
1853
|
+
p99_ms: number;
|
|
1854
|
+
};
|
|
1855
|
+
|
|
1856
|
+
/**
|
|
1857
|
+
* Generated by Kubb (https://kubb.dev/).
|
|
1858
|
+
* Do not edit manually.
|
|
1859
|
+
*/
|
|
1860
|
+
/**
|
|
1861
|
+
* @description Aggregated analytics for a normalized SQL query shape.
|
|
1862
|
+
*/
|
|
1863
|
+
type QueryInsight = {
|
|
1864
|
+
/**
|
|
1865
|
+
* @description xxhash64 of the normalized SQL pattern (hex).
|
|
1866
|
+
* @type string
|
|
1867
|
+
*/
|
|
1868
|
+
query_hash: string;
|
|
1869
|
+
/**
|
|
1870
|
+
* @description Normalized SQL pattern (truncated to 500 chars).
|
|
1871
|
+
* @type string
|
|
1872
|
+
*/
|
|
1873
|
+
query_pattern: string;
|
|
1874
|
+
/**
|
|
1875
|
+
* @description Total number of executions in the time range.
|
|
1876
|
+
* @type integer, int64
|
|
1877
|
+
*/
|
|
1878
|
+
total_count: number;
|
|
1879
|
+
/**
|
|
1880
|
+
* @description Total cache hits attributed to the query shape.
|
|
1881
|
+
* @type integer, int64
|
|
1882
|
+
*/
|
|
1883
|
+
total_cache_hits: number;
|
|
1884
|
+
/**
|
|
1885
|
+
* @description Total cache misses attributed to the query shape.
|
|
1886
|
+
* @type integer, int64
|
|
1887
|
+
*/
|
|
1888
|
+
total_cache_misses: number;
|
|
1889
|
+
/**
|
|
1890
|
+
* @description Average query latency in milliseconds.
|
|
1891
|
+
* @type number, double
|
|
1892
|
+
*/
|
|
1893
|
+
avg_latency_ms: number;
|
|
1894
|
+
/**
|
|
1895
|
+
* @description P99 query latency in milliseconds.
|
|
1896
|
+
* @type number, double
|
|
1897
|
+
*/
|
|
1898
|
+
p99_latency_ms: number;
|
|
1899
|
+
};
|
|
1900
|
+
|
|
1901
|
+
/**
|
|
1902
|
+
* Generated by Kubb (https://kubb.dev/).
|
|
1903
|
+
* Do not edit manually.
|
|
1904
|
+
*/
|
|
1905
|
+
|
|
1906
|
+
/**
|
|
1907
|
+
* @description Query insights, cache performance, and latency for a project.
|
|
1908
|
+
*/
|
|
1909
|
+
type ProjectInsights = {
|
|
1910
|
+
/**
|
|
1911
|
+
* @description Top query shapes observed for the project.
|
|
1912
|
+
* @type array
|
|
1913
|
+
*/
|
|
1914
|
+
queries: QueryInsight[];
|
|
1915
|
+
/**
|
|
1916
|
+
* @description Aggregate cache performance metrics for the selected time range.
|
|
1917
|
+
* @type object
|
|
1918
|
+
*/
|
|
1919
|
+
cache: CacheSummary;
|
|
1920
|
+
/**
|
|
1921
|
+
* @description Aggregate latency metrics for the selected time range.
|
|
1922
|
+
* @type object
|
|
1923
|
+
*/
|
|
1924
|
+
latency: LatencySummary;
|
|
1925
|
+
};
|
|
1926
|
+
|
|
1927
|
+
/**
|
|
1928
|
+
* Generated by Kubb (https://kubb.dev/).
|
|
1929
|
+
* Do not edit manually.
|
|
1930
|
+
*/
|
|
1931
|
+
|
|
1932
|
+
type GetProjectInsightsPathParams = {
|
|
1933
|
+
/**
|
|
1934
|
+
* @description Unique project identifier (prefixed, e.g. prj_xxx).
|
|
1935
|
+
* @pattern ^[a-zA-Z0-9_.-]+$
|
|
1936
|
+
* @type string
|
|
1937
|
+
*/
|
|
1938
|
+
project_id: string;
|
|
1939
|
+
};
|
|
1940
|
+
declare const getProjectInsightsQueryParamsRangeEnum: {
|
|
1941
|
+
readonly "1h": "1h";
|
|
1942
|
+
readonly "6h": "6h";
|
|
1943
|
+
readonly "24h": "24h";
|
|
1944
|
+
readonly "7d": "7d";
|
|
1945
|
+
};
|
|
1946
|
+
type GetProjectInsightsQueryParamsRangeEnumKey = (typeof getProjectInsightsQueryParamsRangeEnum)[keyof typeof getProjectInsightsQueryParamsRangeEnum];
|
|
1947
|
+
type GetProjectInsightsQueryParams = {
|
|
1948
|
+
/**
|
|
1949
|
+
* @description Time range to query. Defaults to 24h.
|
|
1950
|
+
* @default "24h"
|
|
1951
|
+
* @type string | undefined
|
|
1952
|
+
*/
|
|
1953
|
+
range?: GetProjectInsightsQueryParamsRangeEnumKey;
|
|
1954
|
+
/**
|
|
1955
|
+
* @description Maximum number of top queries to return (1-100).
|
|
1956
|
+
* @minLength 1
|
|
1957
|
+
* @maxLength 100
|
|
1958
|
+
* @default 20
|
|
1959
|
+
* @type integer | undefined
|
|
1960
|
+
*/
|
|
1961
|
+
limit?: number;
|
|
1962
|
+
};
|
|
1963
|
+
/**
|
|
1964
|
+
* @description Query insights for the project.
|
|
1965
|
+
*/
|
|
1966
|
+
type GetProjectInsights200 = ProjectInsights;
|
|
1967
|
+
type GetProjectInsightsQueryResponse = GetProjectInsights200;
|
|
1968
|
+
|
|
1969
|
+
/**
|
|
1970
|
+
* Generated by Kubb (https://kubb.dev/).
|
|
1971
|
+
* Do not edit manually.
|
|
1972
|
+
*/
|
|
1973
|
+
/**
|
|
1974
|
+
* @description Progress state for the dashboard onboarding checklist.
|
|
1975
|
+
*/
|
|
1976
|
+
type OnboardingProgress = {
|
|
1977
|
+
/**
|
|
1978
|
+
* @description Organization ID this onboarding belongs to.
|
|
1979
|
+
* @type string
|
|
1980
|
+
*/
|
|
1981
|
+
organization_id: string;
|
|
1982
|
+
/**
|
|
1983
|
+
* @description Whether the organization has been created.
|
|
1984
|
+
* @type boolean
|
|
1985
|
+
*/
|
|
1986
|
+
org_created: boolean;
|
|
1987
|
+
/**
|
|
1988
|
+
* @description Whether a project has been created.
|
|
1989
|
+
* @type boolean
|
|
1990
|
+
*/
|
|
1991
|
+
project_created: boolean;
|
|
1992
|
+
/**
|
|
1993
|
+
* @description Whether a database has been added.
|
|
1994
|
+
* @type boolean
|
|
1995
|
+
*/
|
|
1996
|
+
database_added: boolean;
|
|
1997
|
+
/**
|
|
1998
|
+
* @description Whether the database connection has been tested.
|
|
1999
|
+
* @type boolean
|
|
2000
|
+
*/
|
|
2001
|
+
connection_tested: boolean;
|
|
2002
|
+
/**
|
|
2003
|
+
* @description Whether the connection string has been copied.
|
|
2004
|
+
* @type boolean
|
|
2005
|
+
*/
|
|
2006
|
+
connection_string_copied: boolean;
|
|
2007
|
+
/**
|
|
2008
|
+
* @description Whether the first query has been run through PgBeam.
|
|
2009
|
+
* @type boolean
|
|
2010
|
+
*/
|
|
2011
|
+
first_query_run: boolean;
|
|
2012
|
+
/**
|
|
2013
|
+
* @description Whether the user has dismissed the onboarding checklist.
|
|
2014
|
+
* @type boolean
|
|
2015
|
+
*/
|
|
2016
|
+
dismissed: boolean;
|
|
2017
|
+
/**
|
|
2018
|
+
* @description Whether all onboarding steps are complete.
|
|
2019
|
+
* @type boolean
|
|
2020
|
+
*/
|
|
2021
|
+
completed: boolean;
|
|
2022
|
+
/**
|
|
2023
|
+
* @description Number of completed onboarding steps.
|
|
2024
|
+
* @type integer
|
|
2025
|
+
*/
|
|
2026
|
+
steps_completed: number;
|
|
2027
|
+
/**
|
|
2028
|
+
* @description Total number of onboarding steps.
|
|
2029
|
+
* @type integer
|
|
2030
|
+
*/
|
|
2031
|
+
steps_total: number;
|
|
2032
|
+
/**
|
|
2033
|
+
* @description When onboarding was completed. Null if not yet completed.
|
|
2034
|
+
* @type string, date-time
|
|
2035
|
+
*/
|
|
2036
|
+
completed_at?: string | null;
|
|
2037
|
+
};
|
|
2038
|
+
|
|
2039
|
+
/**
|
|
2040
|
+
* Generated by Kubb (https://kubb.dev/).
|
|
2041
|
+
* Do not edit manually.
|
|
2042
|
+
*/
|
|
2043
|
+
|
|
2044
|
+
type GetOnboardingProgressPathParams = {
|
|
2045
|
+
/**
|
|
2046
|
+
* @description Unique organization identifier.
|
|
2047
|
+
* @pattern ^[a-zA-Z0-9_.-]+$
|
|
2048
|
+
* @type string
|
|
2049
|
+
*/
|
|
2050
|
+
org_id: string;
|
|
2051
|
+
};
|
|
2052
|
+
/**
|
|
2053
|
+
* @description Onboarding progress.
|
|
2054
|
+
*/
|
|
2055
|
+
type GetOnboardingProgress200 = OnboardingProgress;
|
|
2056
|
+
type GetOnboardingProgressQueryResponse = GetOnboardingProgress200;
|
|
2057
|
+
|
|
2058
|
+
/**
|
|
2059
|
+
* Generated by Kubb (https://kubb.dev/).
|
|
2060
|
+
* Do not edit manually.
|
|
2061
|
+
*/
|
|
2062
|
+
declare const updateOnboardingRequestStepEnum: {
|
|
2063
|
+
readonly project_created: "project_created";
|
|
2064
|
+
readonly database_added: "database_added";
|
|
2065
|
+
readonly connection_tested: "connection_tested";
|
|
2066
|
+
readonly connection_string_copied: "connection_string_copied";
|
|
2067
|
+
readonly first_query_run: "first_query_run";
|
|
2068
|
+
};
|
|
2069
|
+
type UpdateOnboardingRequestStepEnumKey = (typeof updateOnboardingRequestStepEnum)[keyof typeof updateOnboardingRequestStepEnum];
|
|
2070
|
+
/**
|
|
2071
|
+
* @description Request body for advancing or dismissing onboarding.
|
|
2072
|
+
*/
|
|
2073
|
+
type UpdateOnboardingRequest = {
|
|
2074
|
+
/**
|
|
2075
|
+
* @description The onboarding step to mark as complete.
|
|
2076
|
+
* @type string | undefined
|
|
2077
|
+
*/
|
|
2078
|
+
step?: UpdateOnboardingRequestStepEnumKey;
|
|
2079
|
+
/**
|
|
2080
|
+
* @description Set to true to dismiss the onboarding checklist.
|
|
2081
|
+
* @type boolean | undefined
|
|
2082
|
+
*/
|
|
2083
|
+
dismiss?: boolean;
|
|
2084
|
+
};
|
|
2085
|
+
|
|
2086
|
+
/**
|
|
2087
|
+
* Generated by Kubb (https://kubb.dev/).
|
|
2088
|
+
* Do not edit manually.
|
|
2089
|
+
*/
|
|
2090
|
+
|
|
2091
|
+
type UpdateOnboardingProgressPathParams = {
|
|
2092
|
+
/**
|
|
2093
|
+
* @description Unique organization identifier.
|
|
2094
|
+
* @pattern ^[a-zA-Z0-9_.-]+$
|
|
2095
|
+
* @type string
|
|
2096
|
+
*/
|
|
2097
|
+
org_id: string;
|
|
2098
|
+
};
|
|
2099
|
+
/**
|
|
2100
|
+
* @description Updated onboarding progress.
|
|
2101
|
+
*/
|
|
2102
|
+
type UpdateOnboardingProgress200 = OnboardingProgress;
|
|
2103
|
+
type UpdateOnboardingProgressMutationRequest = UpdateOnboardingRequest;
|
|
2104
|
+
type UpdateOnboardingProgressMutationResponse = UpdateOnboardingProgress200;
|
|
2105
|
+
|
|
2106
|
+
/**
|
|
2107
|
+
* Generated by Kubb (https://kubb.dev/).
|
|
2108
|
+
* Do not edit manually.
|
|
2109
|
+
*/
|
|
2110
|
+
declare const projectStatusEnum: {
|
|
2111
|
+
readonly active: "active";
|
|
2112
|
+
readonly suspended: "suspended";
|
|
2113
|
+
readonly deleted: "deleted";
|
|
2114
|
+
};
|
|
2115
|
+
type ProjectStatusEnumKey = (typeof projectStatusEnum)[keyof typeof projectStatusEnum];
|
|
2116
|
+
/**
|
|
2117
|
+
* @description Project lifecycle status.
|
|
2118
|
+
*/
|
|
2119
|
+
type ProjectStatus = ProjectStatusEnumKey;
|
|
2120
|
+
|
|
2121
|
+
/**
|
|
2122
|
+
* Generated by Kubb (https://kubb.dev/).
|
|
2123
|
+
* Do not edit manually.
|
|
2124
|
+
*/
|
|
2125
|
+
|
|
2126
|
+
declare const projectCloudEnum: {
|
|
2127
|
+
readonly aws: "aws";
|
|
2128
|
+
readonly azure: "azure";
|
|
2129
|
+
readonly gcp: "gcp";
|
|
2130
|
+
};
|
|
2131
|
+
type ProjectCloudEnumKey = (typeof projectCloudEnum)[keyof typeof projectCloudEnum];
|
|
2132
|
+
/**
|
|
2133
|
+
* @description Project configuration and current control-plane state.
|
|
2134
|
+
*/
|
|
2135
|
+
type Project = {
|
|
2136
|
+
/**
|
|
2137
|
+
* @description Unique project identifier (prefixed).
|
|
2138
|
+
* @type string
|
|
2139
|
+
*/
|
|
2140
|
+
id: string;
|
|
2141
|
+
/**
|
|
2142
|
+
* @description Better Auth organization ID that owns this project.
|
|
2143
|
+
* @type string
|
|
2144
|
+
*/
|
|
2145
|
+
org_id: string;
|
|
2146
|
+
/**
|
|
2147
|
+
* @description Human-readable project name.
|
|
2148
|
+
* @minLength 1
|
|
2149
|
+
* @maxLength 100
|
|
2150
|
+
* @type string
|
|
2151
|
+
*/
|
|
2152
|
+
name: string;
|
|
2153
|
+
/**
|
|
2154
|
+
* @description Optional project description.
|
|
2155
|
+
* @maxLength 500
|
|
2156
|
+
* @type string | undefined
|
|
2157
|
+
*/
|
|
2158
|
+
description?: string;
|
|
2159
|
+
/**
|
|
2160
|
+
* @description User-defined labels applied to the project.
|
|
2161
|
+
* @type array | undefined
|
|
2162
|
+
*/
|
|
2163
|
+
tags?: string[];
|
|
2164
|
+
/**
|
|
2165
|
+
* @description Cloud provider where the project runs.
|
|
2166
|
+
* @type string | undefined
|
|
2167
|
+
*/
|
|
2168
|
+
readonly cloud?: ProjectCloudEnumKey;
|
|
2169
|
+
/**
|
|
2170
|
+
* @description Proxy hostname for connecting through PgBeam (e.g., myproject.aws.pgbeam.app).
|
|
2171
|
+
* @type string | undefined
|
|
2172
|
+
*/
|
|
2173
|
+
readonly proxy_host?: string;
|
|
2174
|
+
/**
|
|
2175
|
+
* @description Maximum queries per second for this project. 0 means unlimited.
|
|
2176
|
+
* @minLength 0
|
|
2177
|
+
* @maxLength 2147483647
|
|
2178
|
+
* @type integer | undefined, int32
|
|
2179
|
+
*/
|
|
2180
|
+
queries_per_second?: number;
|
|
2181
|
+
/**
|
|
2182
|
+
* @description Burst allowance above the steady-state rate. 0 uses queries_per_second as burst.
|
|
2183
|
+
* @minLength 0
|
|
2184
|
+
* @maxLength 2147483647
|
|
2185
|
+
* @type integer | undefined, int32
|
|
2186
|
+
*/
|
|
2187
|
+
burst_size?: number;
|
|
2188
|
+
/**
|
|
2189
|
+
* @description Maximum concurrent proxy connections. 0 means unlimited.
|
|
2190
|
+
* @minLength 0
|
|
2191
|
+
* @maxLength 2147483647
|
|
2192
|
+
* @type integer | undefined, int32
|
|
2193
|
+
*/
|
|
2194
|
+
max_connections?: number;
|
|
2195
|
+
/**
|
|
2196
|
+
* @description Number of databases attached to this project.
|
|
2197
|
+
* @type integer | undefined
|
|
2198
|
+
*/
|
|
2199
|
+
readonly database_count?: number;
|
|
2200
|
+
/**
|
|
2201
|
+
* @description Current active connections (latest metrics snapshot). 0 when no metrics data.
|
|
2202
|
+
* @type integer | undefined
|
|
2203
|
+
*/
|
|
2204
|
+
readonly active_connections?: number;
|
|
2205
|
+
/**
|
|
2206
|
+
* @description Project lifecycle status.
|
|
2207
|
+
* @type string
|
|
2208
|
+
*/
|
|
2209
|
+
status: ProjectStatus;
|
|
2210
|
+
/**
|
|
2211
|
+
* @description When the project was created.
|
|
2212
|
+
* @type string, date-time
|
|
2213
|
+
*/
|
|
2214
|
+
created_at: string;
|
|
2215
|
+
/**
|
|
2216
|
+
* @description When the project was last updated.
|
|
2217
|
+
* @type string, date-time
|
|
2218
|
+
*/
|
|
2219
|
+
updated_at: string;
|
|
2220
|
+
};
|
|
2221
|
+
|
|
2222
|
+
/**
|
|
2223
|
+
* Generated by Kubb (https://kubb.dev/).
|
|
2224
|
+
* Do not edit manually.
|
|
2225
|
+
*/
|
|
2226
|
+
|
|
2227
|
+
/**
|
|
2228
|
+
* @description Cursor-paginated list of projects for an organization.
|
|
2229
|
+
*/
|
|
2230
|
+
type ListProjectsResponse = {
|
|
2231
|
+
/**
|
|
2232
|
+
* @description Projects on the current page.
|
|
2233
|
+
* @type array
|
|
2234
|
+
*/
|
|
2235
|
+
projects: Project[];
|
|
2236
|
+
/**
|
|
2237
|
+
* @description Total number of projects (across all pages).
|
|
2238
|
+
* @type integer
|
|
2239
|
+
*/
|
|
2240
|
+
total: number;
|
|
2241
|
+
/**
|
|
2242
|
+
* @description Token for the next page. Empty if no more results.
|
|
2243
|
+
* @type string | undefined
|
|
2244
|
+
*/
|
|
2245
|
+
next_page_token?: string;
|
|
2246
|
+
};
|
|
2247
|
+
|
|
2248
|
+
/**
|
|
2249
|
+
* Generated by Kubb (https://kubb.dev/).
|
|
2250
|
+
* Do not edit manually.
|
|
2251
|
+
*/
|
|
2252
|
+
|
|
2253
|
+
declare const listProjectsQueryParamsSortByEnum: {
|
|
2254
|
+
readonly name: "name";
|
|
2255
|
+
readonly created_at: "created_at";
|
|
2256
|
+
readonly active_connections: "active_connections";
|
|
2257
|
+
};
|
|
2258
|
+
type ListProjectsQueryParamsSortByEnumKey = (typeof listProjectsQueryParamsSortByEnum)[keyof typeof listProjectsQueryParamsSortByEnum];
|
|
2259
|
+
type ListProjectsQueryParams = {
|
|
2260
|
+
/**
|
|
2261
|
+
* @description Organization ID to filter projects.
|
|
2262
|
+
* @pattern ^[\x20-\x7E]+$
|
|
2263
|
+
* @type string
|
|
2264
|
+
*/
|
|
2265
|
+
org_id: string;
|
|
2266
|
+
/**
|
|
2267
|
+
* @description Maximum number of items to return (1-100, default 20).
|
|
2268
|
+
* @minLength 1
|
|
2269
|
+
* @maxLength 100
|
|
2270
|
+
* @default 20
|
|
2271
|
+
* @type integer | undefined
|
|
2272
|
+
*/
|
|
2273
|
+
page_size?: number;
|
|
2274
|
+
/**
|
|
2275
|
+
* @description Opaque token for cursor-based pagination.
|
|
2276
|
+
* @pattern ^[a-zA-Z0-9_.-]+$
|
|
2277
|
+
* @type string | undefined
|
|
2278
|
+
*/
|
|
2279
|
+
page_token?: string;
|
|
2280
|
+
/**
|
|
2281
|
+
* @description Sort field for projects list.
|
|
2282
|
+
* @default "created_at"
|
|
2283
|
+
* @type string | undefined
|
|
2284
|
+
*/
|
|
2285
|
+
sort_by?: ListProjectsQueryParamsSortByEnumKey;
|
|
2286
|
+
};
|
|
2287
|
+
/**
|
|
2288
|
+
* @description List of projects.
|
|
2289
|
+
*/
|
|
2290
|
+
type ListProjects200 = ListProjectsResponse;
|
|
2291
|
+
type ListProjectsQueryResponse = ListProjects200;
|
|
2292
|
+
|
|
2293
|
+
/**
|
|
2294
|
+
* Generated by Kubb (https://kubb.dev/).
|
|
2295
|
+
* Do not edit manually.
|
|
2296
|
+
*/
|
|
2297
|
+
|
|
2298
|
+
declare const createProjectRequestCloudEnum: {
|
|
2299
|
+
readonly aws: "aws";
|
|
2300
|
+
readonly azure: "azure";
|
|
2301
|
+
readonly gcp: "gcp";
|
|
2302
|
+
};
|
|
2303
|
+
type CreateProjectRequestCloudEnumKey = (typeof createProjectRequestCloudEnum)[keyof typeof createProjectRequestCloudEnum];
|
|
2304
|
+
/**
|
|
2305
|
+
* @description Request body for creating a project and its primary database.
|
|
2306
|
+
*/
|
|
2307
|
+
type CreateProjectRequest = {
|
|
2308
|
+
/**
|
|
2309
|
+
* @description Human-readable project name.
|
|
2310
|
+
* @minLength 1
|
|
2311
|
+
* @maxLength 100
|
|
2312
|
+
* @pattern ^[^\x00]*$
|
|
2313
|
+
* @type string
|
|
2314
|
+
*/
|
|
2315
|
+
name: string;
|
|
2316
|
+
/**
|
|
2317
|
+
* @description Better Auth organization ID.
|
|
2318
|
+
* @minLength 1
|
|
2319
|
+
* @pattern ^[^\x00]+$
|
|
2320
|
+
* @type string
|
|
2321
|
+
*/
|
|
2322
|
+
org_id: string;
|
|
2323
|
+
/**
|
|
2324
|
+
* @description Optional project description.
|
|
2325
|
+
* @maxLength 500
|
|
2326
|
+
* @type string | undefined
|
|
2327
|
+
*/
|
|
2328
|
+
description?: string;
|
|
2329
|
+
/**
|
|
2330
|
+
* @description User-defined labels to attach to the project.
|
|
2331
|
+
* @type array | undefined
|
|
2332
|
+
*/
|
|
2333
|
+
tags?: string[];
|
|
2334
|
+
/**
|
|
2335
|
+
* @description Cloud provider for the project.
|
|
2336
|
+
* @default "aws"
|
|
2337
|
+
* @type string | undefined
|
|
2338
|
+
*/
|
|
2339
|
+
cloud?: CreateProjectRequestCloudEnumKey;
|
|
2340
|
+
/**
|
|
2341
|
+
* @description Request body for registering an upstream database.
|
|
2342
|
+
* @type object
|
|
2343
|
+
*/
|
|
2344
|
+
database: CreateDatabaseRequest;
|
|
2345
|
+
};
|
|
2346
|
+
|
|
2347
|
+
/**
|
|
2348
|
+
* Generated by Kubb (https://kubb.dev/).
|
|
2349
|
+
* Do not edit manually.
|
|
2350
|
+
*/
|
|
2351
|
+
|
|
2352
|
+
/**
|
|
2353
|
+
* @description Response returned after creating a project and its primary database.
|
|
2354
|
+
*/
|
|
2355
|
+
type CreateProjectResponse = {
|
|
2356
|
+
/**
|
|
2357
|
+
* @description Project configuration and current control-plane state.
|
|
2358
|
+
* @type object
|
|
2359
|
+
*/
|
|
2360
|
+
project: Project;
|
|
2361
|
+
/**
|
|
2362
|
+
* @description Registered upstream PostgreSQL database for a project.
|
|
2363
|
+
* @type object | undefined
|
|
2364
|
+
*/
|
|
2365
|
+
database?: Database;
|
|
2366
|
+
};
|
|
2367
|
+
|
|
2368
|
+
/**
|
|
2369
|
+
* Generated by Kubb (https://kubb.dev/).
|
|
2370
|
+
* Do not edit manually.
|
|
2371
|
+
*/
|
|
2372
|
+
|
|
2373
|
+
/**
|
|
2374
|
+
* @description Project created.
|
|
2375
|
+
*/
|
|
2376
|
+
type CreateProject201 = CreateProjectResponse;
|
|
2377
|
+
type CreateProjectMutationRequest = CreateProjectRequest;
|
|
2378
|
+
type CreateProjectMutationResponse = CreateProject201;
|
|
2379
|
+
|
|
2380
|
+
/**
|
|
2381
|
+
* Generated by Kubb (https://kubb.dev/).
|
|
2382
|
+
* Do not edit manually.
|
|
2383
|
+
*/
|
|
2384
|
+
|
|
2385
|
+
type GetProjectPathParams = {
|
|
2386
|
+
/**
|
|
2387
|
+
* @description Unique project identifier (prefixed, e.g. prj_xxx).
|
|
2388
|
+
* @pattern ^[a-zA-Z0-9_.-]+$
|
|
2389
|
+
* @type string
|
|
2390
|
+
*/
|
|
2391
|
+
project_id: string;
|
|
2392
|
+
};
|
|
2393
|
+
/**
|
|
2394
|
+
* @description Project found.
|
|
2395
|
+
*/
|
|
2396
|
+
type GetProject200 = Project;
|
|
2397
|
+
type GetProjectQueryResponse = GetProject200;
|
|
2398
|
+
|
|
2399
|
+
/**
|
|
2400
|
+
* Generated by Kubb (https://kubb.dev/).
|
|
2401
|
+
* Do not edit manually.
|
|
2402
|
+
*/
|
|
2403
|
+
|
|
2404
|
+
/**
|
|
2405
|
+
* @description Request body for partially updating a project.
|
|
2406
|
+
*/
|
|
2407
|
+
type UpdateProjectRequest = {
|
|
2408
|
+
/**
|
|
2409
|
+
* @description Updated project name.
|
|
2410
|
+
* @minLength 1
|
|
2411
|
+
* @maxLength 100
|
|
2412
|
+
* @pattern ^[^\x00]*$
|
|
2413
|
+
* @type string | undefined
|
|
2414
|
+
*/
|
|
2415
|
+
name?: string;
|
|
2416
|
+
/**
|
|
2417
|
+
* @description Updated project description.
|
|
2418
|
+
* @maxLength 500
|
|
2419
|
+
* @type string | undefined
|
|
2420
|
+
*/
|
|
2421
|
+
description?: string;
|
|
2422
|
+
/**
|
|
2423
|
+
* @description Replacement set of user-defined project labels.
|
|
2424
|
+
* @type array | undefined
|
|
2425
|
+
*/
|
|
2426
|
+
tags?: string[];
|
|
2427
|
+
/**
|
|
2428
|
+
* @description Project lifecycle status.
|
|
2429
|
+
* @type string | undefined
|
|
2430
|
+
*/
|
|
2431
|
+
status?: ProjectStatus;
|
|
2432
|
+
/**
|
|
2433
|
+
* @description Maximum queries per second. 0 means unlimited.
|
|
2434
|
+
* @minLength 0
|
|
2435
|
+
* @maxLength 2147483647
|
|
2436
|
+
* @type integer | undefined, int32
|
|
2437
|
+
*/
|
|
2438
|
+
queries_per_second?: number;
|
|
2439
|
+
/**
|
|
2440
|
+
* @description Burst allowance above steady-state rate.
|
|
2441
|
+
* @minLength 0
|
|
2442
|
+
* @maxLength 2147483647
|
|
2443
|
+
* @type integer | undefined, int32
|
|
2444
|
+
*/
|
|
2445
|
+
burst_size?: number;
|
|
2446
|
+
/**
|
|
2447
|
+
* @description Maximum concurrent proxy connections. 0 means unlimited.
|
|
2448
|
+
* @minLength 0
|
|
2449
|
+
* @maxLength 2147483647
|
|
2450
|
+
* @type integer | undefined, int32
|
|
2451
|
+
*/
|
|
2452
|
+
max_connections?: number;
|
|
2453
|
+
};
|
|
2454
|
+
|
|
2455
|
+
/**
|
|
2456
|
+
* Generated by Kubb (https://kubb.dev/).
|
|
2457
|
+
* Do not edit manually.
|
|
2458
|
+
*/
|
|
2459
|
+
|
|
2460
|
+
type UpdateProjectPathParams = {
|
|
2461
|
+
/**
|
|
2462
|
+
* @description Unique project identifier (prefixed, e.g. prj_xxx).
|
|
2463
|
+
* @pattern ^[a-zA-Z0-9_.-]+$
|
|
2464
|
+
* @type string
|
|
2465
|
+
*/
|
|
2466
|
+
project_id: string;
|
|
2467
|
+
};
|
|
2468
|
+
/**
|
|
2469
|
+
* @description Project updated.
|
|
2470
|
+
*/
|
|
2471
|
+
type UpdateProject200 = Project;
|
|
2472
|
+
type UpdateProjectMutationRequest = UpdateProjectRequest;
|
|
2473
|
+
type UpdateProjectMutationResponse = UpdateProject200;
|
|
2474
|
+
|
|
2475
|
+
/**
|
|
2476
|
+
* Generated by Kubb (https://kubb.dev/).
|
|
2477
|
+
* Do not edit manually.
|
|
2478
|
+
*/
|
|
2479
|
+
|
|
2480
|
+
type DeleteProjectPathParams = {
|
|
2481
|
+
/**
|
|
2482
|
+
* @description Unique project identifier (prefixed, e.g. prj_xxx).
|
|
2483
|
+
* @pattern ^[a-zA-Z0-9_.-]+$
|
|
2484
|
+
* @type string
|
|
2485
|
+
*/
|
|
2486
|
+
project_id: string;
|
|
2487
|
+
};
|
|
2488
|
+
|
|
2489
|
+
/**
|
|
2490
|
+
* Generated by Kubb (https://kubb.dev/).
|
|
2491
|
+
* Do not edit manually.
|
|
2492
|
+
*/
|
|
2493
|
+
/**
|
|
2494
|
+
* @description Aggregated project metrics captured for a point in time.
|
|
2495
|
+
*/
|
|
2496
|
+
type MetricsSnapshot = {
|
|
2497
|
+
/**
|
|
2498
|
+
* @description Unique metrics snapshot identifier.
|
|
2499
|
+
* @type string
|
|
2500
|
+
*/
|
|
2501
|
+
id: string;
|
|
2502
|
+
/**
|
|
2503
|
+
* @description Project that produced the metrics snapshot.
|
|
2504
|
+
* @type string
|
|
2505
|
+
*/
|
|
2506
|
+
project_id: string;
|
|
2507
|
+
/**
|
|
2508
|
+
* @description Region where the traffic was served.
|
|
2509
|
+
* @type string
|
|
2510
|
+
*/
|
|
2511
|
+
region: string;
|
|
2512
|
+
/**
|
|
2513
|
+
* @description Total queries served during the snapshot interval.
|
|
2514
|
+
* @type integer, int64
|
|
2515
|
+
*/
|
|
2516
|
+
queries_total: number;
|
|
2517
|
+
/**
|
|
2518
|
+
* @description Number of queries served from cache.
|
|
2519
|
+
* @type integer, int64
|
|
2520
|
+
*/
|
|
2521
|
+
cache_hits: number;
|
|
2522
|
+
/**
|
|
2523
|
+
* @description Number of queries forwarded upstream.
|
|
2524
|
+
* @type integer, int64
|
|
2525
|
+
*/
|
|
2526
|
+
cache_misses: number;
|
|
2527
|
+
/**
|
|
2528
|
+
* @description Current active proxy connections.
|
|
2529
|
+
* @type integer
|
|
2530
|
+
*/
|
|
2531
|
+
active_connections: number;
|
|
2532
|
+
/**
|
|
2533
|
+
* @description Average end-to-end query latency in milliseconds.
|
|
2534
|
+
* @type number, double
|
|
2535
|
+
*/
|
|
2536
|
+
avg_latency_ms: number;
|
|
2537
|
+
/**
|
|
2538
|
+
* @description 99th percentile end-to-end query latency in milliseconds.
|
|
2539
|
+
* @type number, double
|
|
2540
|
+
*/
|
|
2541
|
+
p99_latency_ms: number;
|
|
2542
|
+
/**
|
|
2543
|
+
* @description Average upstream connection acquisition latency in milliseconds.
|
|
2544
|
+
* @type number | undefined, double
|
|
2545
|
+
*/
|
|
2546
|
+
avg_connect_ms?: number;
|
|
2547
|
+
/**
|
|
2548
|
+
* @description Average upstream query execution latency in milliseconds.
|
|
2549
|
+
* @type number | undefined, double
|
|
2550
|
+
*/
|
|
2551
|
+
avg_query_ms?: number;
|
|
2552
|
+
/**
|
|
2553
|
+
* @description When the snapshot was recorded.
|
|
2554
|
+
* @type string, date-time
|
|
2555
|
+
*/
|
|
2556
|
+
created_at: string;
|
|
2557
|
+
};
|
|
2558
|
+
|
|
2559
|
+
/**
|
|
2560
|
+
* Generated by Kubb (https://kubb.dev/).
|
|
2561
|
+
* Do not edit manually.
|
|
2562
|
+
*/
|
|
2563
|
+
|
|
2564
|
+
/**
|
|
2565
|
+
* @description Response envelope for recent project metrics snapshots.
|
|
2566
|
+
*/
|
|
2567
|
+
type ProjectMetricsResponse = {
|
|
2568
|
+
/**
|
|
2569
|
+
* @description Metrics snapshots ordered from newest to oldest.
|
|
2570
|
+
* @type array
|
|
2571
|
+
*/
|
|
2572
|
+
snapshots: MetricsSnapshot[];
|
|
2573
|
+
};
|
|
2574
|
+
|
|
2575
|
+
/**
|
|
2576
|
+
* Generated by Kubb (https://kubb.dev/).
|
|
2577
|
+
* Do not edit manually.
|
|
2578
|
+
*/
|
|
2579
|
+
|
|
2580
|
+
type GetProjectMetricsPathParams = {
|
|
2581
|
+
/**
|
|
2582
|
+
* @description Unique project identifier (prefixed, e.g. prj_xxx).
|
|
2583
|
+
* @pattern ^[a-zA-Z0-9_.-]+$
|
|
2584
|
+
* @type string
|
|
2585
|
+
*/
|
|
2586
|
+
project_id: string;
|
|
2587
|
+
};
|
|
2588
|
+
type GetProjectMetricsQueryParams = {
|
|
2589
|
+
/**
|
|
2590
|
+
* @description Maximum number of recent snapshots to return.
|
|
2591
|
+
* @minLength 1
|
|
2592
|
+
* @maxLength 1000
|
|
2593
|
+
* @default 60
|
|
2594
|
+
* @type integer | undefined
|
|
2595
|
+
*/
|
|
2596
|
+
limit?: number;
|
|
2597
|
+
/**
|
|
2598
|
+
* @description Filter metrics by region code.
|
|
2599
|
+
* @type string | undefined
|
|
2600
|
+
*/
|
|
2601
|
+
region?: string;
|
|
2602
|
+
};
|
|
2603
|
+
/**
|
|
2604
|
+
* @description Metrics snapshots
|
|
2605
|
+
*/
|
|
2606
|
+
type GetProjectMetrics200 = ProjectMetricsResponse;
|
|
2607
|
+
type GetProjectMetricsQueryResponse = GetProjectMetrics200;
|
|
2608
|
+
|
|
2609
|
+
/**
|
|
2610
|
+
* Generated by Kubb (https://kubb.dev/).
|
|
2611
|
+
* Do not edit manually.
|
|
2612
|
+
*/
|
|
2613
|
+
declare const regionProviderEnum: {
|
|
2614
|
+
readonly aws: "aws";
|
|
2615
|
+
readonly azure: "azure";
|
|
2616
|
+
readonly gcp: "gcp";
|
|
2617
|
+
};
|
|
2618
|
+
type RegionProviderEnumKey = (typeof regionProviderEnum)[keyof typeof regionProviderEnum];
|
|
2619
|
+
declare const regionStatusEnum: {
|
|
2620
|
+
readonly active: "active";
|
|
2621
|
+
readonly draining: "draining";
|
|
2622
|
+
readonly inactive: "inactive";
|
|
2623
|
+
};
|
|
2624
|
+
type RegionStatusEnumKey = (typeof regionStatusEnum)[keyof typeof regionStatusEnum];
|
|
2625
|
+
/**
|
|
2626
|
+
* @description Data plane region available for PgBeam traffic.
|
|
2627
|
+
*/
|
|
2628
|
+
type Region = {
|
|
2629
|
+
/**
|
|
2630
|
+
* @description Region identifier (e.g. us-east-1).
|
|
2631
|
+
* @type string
|
|
2632
|
+
*/
|
|
2633
|
+
id: string;
|
|
2634
|
+
/**
|
|
2635
|
+
* @description Human-readable region name.
|
|
2636
|
+
* @type string
|
|
2637
|
+
*/
|
|
2638
|
+
name: string;
|
|
2639
|
+
/**
|
|
2640
|
+
* @description Cloud provider.
|
|
2641
|
+
* @type string
|
|
2642
|
+
*/
|
|
2643
|
+
provider: RegionProviderEnumKey;
|
|
2644
|
+
/**
|
|
2645
|
+
* @description Region operational status.
|
|
2646
|
+
* @type string
|
|
2647
|
+
*/
|
|
2648
|
+
status: RegionStatusEnumKey;
|
|
2649
|
+
/**
|
|
2650
|
+
* @description Whether new projects can currently be assigned to the region.
|
|
2651
|
+
* @type boolean
|
|
2652
|
+
*/
|
|
2653
|
+
available: boolean;
|
|
2654
|
+
/**
|
|
2655
|
+
* @description Continent where the region is located.
|
|
2656
|
+
* @type string | undefined
|
|
2657
|
+
*/
|
|
2658
|
+
continent?: string;
|
|
2659
|
+
/**
|
|
2660
|
+
* @description Country where the region is located.
|
|
2661
|
+
* @type string | undefined
|
|
2662
|
+
*/
|
|
2663
|
+
country?: string;
|
|
2664
|
+
};
|
|
2665
|
+
|
|
2666
|
+
/**
|
|
2667
|
+
* Generated by Kubb (https://kubb.dev/).
|
|
2668
|
+
* Do not edit manually.
|
|
2669
|
+
*/
|
|
2670
|
+
|
|
2671
|
+
/**
|
|
2672
|
+
* @description Response envelope for available region queries.
|
|
2673
|
+
*/
|
|
2674
|
+
type ListRegionsResponse = {
|
|
2675
|
+
/**
|
|
2676
|
+
* @description Regions currently known to the control plane.
|
|
2677
|
+
* @type array
|
|
2678
|
+
*/
|
|
2679
|
+
regions: Region[];
|
|
2680
|
+
};
|
|
2681
|
+
|
|
2682
|
+
/**
|
|
2683
|
+
* Generated by Kubb (https://kubb.dev/).
|
|
2684
|
+
* Do not edit manually.
|
|
2685
|
+
*/
|
|
2686
|
+
|
|
2687
|
+
/**
|
|
2688
|
+
* @description List of regions.
|
|
2689
|
+
*/
|
|
2690
|
+
type ListRegions200 = ListRegionsResponse;
|
|
2691
|
+
type ListRegionsQueryResponse = ListRegions200;
|
|
2692
|
+
|
|
2693
|
+
/**
|
|
2694
|
+
* Generated by Kubb (https://kubb.dev/).
|
|
2695
|
+
* Do not edit manually.
|
|
2696
|
+
*/
|
|
2697
|
+
|
|
2698
|
+
/**
|
|
2699
|
+
* @description Read replica registered for a primary database.
|
|
2700
|
+
*/
|
|
2701
|
+
type Replica = {
|
|
2702
|
+
/**
|
|
2703
|
+
* @description Unique replica identifier (prefixed).
|
|
2704
|
+
* @type string
|
|
2705
|
+
*/
|
|
2706
|
+
id: string;
|
|
2707
|
+
/**
|
|
2708
|
+
* @description Parent database ID.
|
|
2709
|
+
* @type string
|
|
2710
|
+
*/
|
|
2711
|
+
database_id: string;
|
|
2712
|
+
/**
|
|
2713
|
+
* @description PostgreSQL replica host.
|
|
2714
|
+
* @type string
|
|
2715
|
+
*/
|
|
2716
|
+
host: string;
|
|
2717
|
+
/**
|
|
2718
|
+
* @description PostgreSQL replica port.
|
|
2719
|
+
* @minLength 1
|
|
2720
|
+
* @maxLength 65535
|
|
2721
|
+
* @type integer
|
|
2722
|
+
*/
|
|
2723
|
+
port: number;
|
|
2724
|
+
/**
|
|
2725
|
+
* @description PostgreSQL SSL connection mode.
|
|
2726
|
+
* @type string
|
|
2727
|
+
*/
|
|
2728
|
+
ssl_mode: SSLMode;
|
|
2729
|
+
/**
|
|
2730
|
+
* @description When the replica was created.
|
|
2731
|
+
* @type string, date-time
|
|
2732
|
+
*/
|
|
2733
|
+
created_at: string;
|
|
2734
|
+
/**
|
|
2735
|
+
* @description When the replica was last updated.
|
|
2736
|
+
* @type string, date-time
|
|
2737
|
+
*/
|
|
2738
|
+
updated_at: string;
|
|
2739
|
+
};
|
|
2740
|
+
|
|
2741
|
+
/**
|
|
2742
|
+
* Generated by Kubb (https://kubb.dev/).
|
|
2743
|
+
* Do not edit manually.
|
|
2744
|
+
*/
|
|
2745
|
+
|
|
2746
|
+
/**
|
|
2747
|
+
* @description Response envelope for listing registered replicas.
|
|
2748
|
+
*/
|
|
2749
|
+
type ListReplicasResponse = {
|
|
2750
|
+
/**
|
|
2751
|
+
* @description Read replicas attached to the database.
|
|
2752
|
+
* @type array
|
|
2753
|
+
*/
|
|
2754
|
+
replicas: Replica[];
|
|
2755
|
+
};
|
|
2756
|
+
|
|
2757
|
+
/**
|
|
2758
|
+
* Generated by Kubb (https://kubb.dev/).
|
|
2759
|
+
* Do not edit manually.
|
|
2760
|
+
*/
|
|
2761
|
+
|
|
2762
|
+
type ListReplicasPathParams = {
|
|
2763
|
+
/**
|
|
2764
|
+
* @description Unique database identifier (prefixed, e.g. db_xxx).
|
|
2765
|
+
* @pattern ^[a-zA-Z0-9_.-]+$
|
|
2766
|
+
* @type string
|
|
2767
|
+
*/
|
|
2768
|
+
database_id: string;
|
|
2769
|
+
};
|
|
2770
|
+
/**
|
|
2771
|
+
* @description List of replicas.
|
|
2772
|
+
*/
|
|
2773
|
+
type ListReplicas200 = ListReplicasResponse;
|
|
2774
|
+
type ListReplicasQueryResponse = ListReplicas200;
|
|
2775
|
+
|
|
2776
|
+
/**
|
|
2777
|
+
* Generated by Kubb (https://kubb.dev/).
|
|
2778
|
+
* Do not edit manually.
|
|
2779
|
+
*/
|
|
2780
|
+
|
|
2781
|
+
/**
|
|
2782
|
+
* @description Request body for adding a read replica to a database.
|
|
2783
|
+
*/
|
|
2784
|
+
type CreateReplicaRequest = {
|
|
2785
|
+
/**
|
|
2786
|
+
* @description PostgreSQL replica host.
|
|
2787
|
+
* @minLength 1
|
|
2788
|
+
* @pattern ^[^\s\x00]+$
|
|
2789
|
+
* @type string
|
|
2790
|
+
*/
|
|
2791
|
+
host: string;
|
|
2792
|
+
/**
|
|
2793
|
+
* @description PostgreSQL replica port.
|
|
2794
|
+
* @minLength 1
|
|
2795
|
+
* @maxLength 65535
|
|
2796
|
+
* @type integer
|
|
2797
|
+
*/
|
|
2798
|
+
port: number;
|
|
2799
|
+
/**
|
|
2800
|
+
* @description PostgreSQL SSL connection mode.
|
|
2801
|
+
* @type string | undefined
|
|
2802
|
+
*/
|
|
2803
|
+
ssl_mode?: SSLMode;
|
|
2804
|
+
};
|
|
2805
|
+
|
|
2806
|
+
/**
|
|
2807
|
+
* Generated by Kubb (https://kubb.dev/).
|
|
2808
|
+
* Do not edit manually.
|
|
2809
|
+
*/
|
|
2810
|
+
|
|
2811
|
+
type CreateReplicaPathParams = {
|
|
2812
|
+
/**
|
|
2813
|
+
* @description Unique database identifier (prefixed, e.g. db_xxx).
|
|
2814
|
+
* @pattern ^[a-zA-Z0-9_.-]+$
|
|
2815
|
+
* @type string
|
|
2816
|
+
*/
|
|
2817
|
+
database_id: string;
|
|
2818
|
+
};
|
|
2819
|
+
/**
|
|
2820
|
+
* @description Replica created.
|
|
2821
|
+
*/
|
|
2822
|
+
type CreateReplica201 = Replica;
|
|
2823
|
+
type CreateReplicaMutationRequest = CreateReplicaRequest;
|
|
2824
|
+
type CreateReplicaMutationResponse = CreateReplica201;
|
|
2825
|
+
|
|
2826
|
+
/**
|
|
2827
|
+
* Generated by Kubb (https://kubb.dev/).
|
|
2828
|
+
* Do not edit manually.
|
|
2829
|
+
*/
|
|
2830
|
+
|
|
2831
|
+
type DeleteReplicaPathParams = {
|
|
2832
|
+
/**
|
|
2833
|
+
* @description Unique database identifier (prefixed, e.g. db_xxx).
|
|
2834
|
+
* @pattern ^[a-zA-Z0-9_.-]+$
|
|
2835
|
+
* @type string
|
|
2836
|
+
*/
|
|
2837
|
+
database_id: string;
|
|
2838
|
+
/**
|
|
2839
|
+
* @description Unique replica identifier (prefixed, e.g. rep_xxx).
|
|
2840
|
+
* @pattern ^[a-zA-Z0-9_.-]+$
|
|
2841
|
+
* @type string
|
|
2842
|
+
*/
|
|
2843
|
+
replica_id: string;
|
|
2844
|
+
};
|
|
2845
|
+
|
|
2846
|
+
/**
|
|
2847
|
+
* Generated by Kubb (https://kubb.dev/).
|
|
2848
|
+
* Do not edit manually.
|
|
2849
|
+
*/
|
|
2850
|
+
/**
|
|
2851
|
+
* @description Daily usage totals aggregated across all projects in an organization.
|
|
2852
|
+
*/
|
|
2853
|
+
type DailyUsage = {
|
|
2854
|
+
/**
|
|
2855
|
+
* @description Usage date in UTC.
|
|
2856
|
+
* @type string, date
|
|
2857
|
+
*/
|
|
2858
|
+
day: string;
|
|
2859
|
+
/**
|
|
2860
|
+
* @description Total queries served on the day.
|
|
2861
|
+
* @type integer, int64
|
|
2862
|
+
*/
|
|
2863
|
+
queries_total: number;
|
|
2864
|
+
/**
|
|
2865
|
+
* @description Total cache hits on the day.
|
|
2866
|
+
* @type integer, int64
|
|
2867
|
+
*/
|
|
2868
|
+
cache_hits: number;
|
|
2869
|
+
/**
|
|
2870
|
+
* @description Total cache misses on the day.
|
|
2871
|
+
* @type integer, int64
|
|
2872
|
+
*/
|
|
2873
|
+
cache_misses: number;
|
|
2874
|
+
/**
|
|
2875
|
+
* @description Total proxy connection time consumed on the day.
|
|
2876
|
+
* @type integer, int64
|
|
2877
|
+
*/
|
|
2878
|
+
connection_seconds: number;
|
|
2879
|
+
/**
|
|
2880
|
+
* @description Total bytes transferred to clients.
|
|
2881
|
+
* @type integer, int64
|
|
2882
|
+
*/
|
|
2883
|
+
bytes_transferred: number;
|
|
2884
|
+
};
|
|
2885
|
+
|
|
2886
|
+
/**
|
|
2887
|
+
* Generated by Kubb (https://kubb.dev/).
|
|
2888
|
+
* Do not edit manually.
|
|
2889
|
+
*/
|
|
2890
|
+
|
|
2891
|
+
/**
|
|
2892
|
+
* @description Response envelope for organization usage queries.
|
|
2893
|
+
*/
|
|
2894
|
+
type UsageResponse = {
|
|
2895
|
+
/**
|
|
2896
|
+
* @description Daily usage entries aggregated across the organization.
|
|
2897
|
+
* @type array
|
|
2898
|
+
*/
|
|
2899
|
+
usage: DailyUsage[];
|
|
2900
|
+
};
|
|
2901
|
+
|
|
2902
|
+
/**
|
|
2903
|
+
* Generated by Kubb (https://kubb.dev/).
|
|
2904
|
+
* Do not edit manually.
|
|
2905
|
+
*/
|
|
2906
|
+
|
|
2907
|
+
type GetOrganizationUsagePathParams = {
|
|
2908
|
+
/**
|
|
2909
|
+
* @description Unique organization identifier.
|
|
2910
|
+
* @pattern ^[a-zA-Z0-9_.-]+$
|
|
2911
|
+
* @type string
|
|
2912
|
+
*/
|
|
2913
|
+
org_id: string;
|
|
2914
|
+
};
|
|
2915
|
+
type GetOrganizationUsageQueryParams = {
|
|
2916
|
+
/**
|
|
2917
|
+
* @description Start date (inclusive, YYYY-MM-DD).
|
|
2918
|
+
* @type string, date
|
|
2919
|
+
*/
|
|
2920
|
+
start_date: string;
|
|
2921
|
+
/**
|
|
2922
|
+
* @description End date (inclusive, YYYY-MM-DD).
|
|
2923
|
+
* @type string, date
|
|
2924
|
+
*/
|
|
2925
|
+
end_date: string;
|
|
2926
|
+
};
|
|
2927
|
+
/**
|
|
2928
|
+
* @description Daily usage data.
|
|
2929
|
+
*/
|
|
2930
|
+
type GetOrganizationUsage200 = UsageResponse;
|
|
2931
|
+
type GetOrganizationUsageQueryResponse = GetOrganizationUsage200;
|
|
2932
|
+
|
|
2933
|
+
/**
|
|
2934
|
+
* Generated by Kubb (https://kubb.dev/).
|
|
2935
|
+
* Do not edit manually.
|
|
2936
|
+
*/
|
|
2937
|
+
/**
|
|
2938
|
+
* @description Daily usage totals for a single project and region.
|
|
2939
|
+
*/
|
|
2940
|
+
type ProjectDailyUsage = {
|
|
2941
|
+
/**
|
|
2942
|
+
* @description Usage date in UTC.
|
|
2943
|
+
* @type string, date
|
|
2944
|
+
*/
|
|
2945
|
+
day: string;
|
|
2946
|
+
/**
|
|
2947
|
+
* @description Region where the traffic was served.
|
|
2948
|
+
* @type string
|
|
2949
|
+
*/
|
|
2950
|
+
region: string;
|
|
2951
|
+
/**
|
|
2952
|
+
* @description Total queries served on the day.
|
|
2953
|
+
* @type integer, int64
|
|
2954
|
+
*/
|
|
2955
|
+
queries_total: number;
|
|
2956
|
+
/**
|
|
2957
|
+
* @description Total cache hits on the day.
|
|
2958
|
+
* @type integer, int64
|
|
2959
|
+
*/
|
|
2960
|
+
cache_hits: number;
|
|
2961
|
+
/**
|
|
2962
|
+
* @description Total cache misses on the day.
|
|
2963
|
+
* @type integer, int64
|
|
2964
|
+
*/
|
|
2965
|
+
cache_misses: number;
|
|
2966
|
+
/**
|
|
2967
|
+
* @description Total proxy connection time consumed on the day.
|
|
2968
|
+
* @type integer, int64
|
|
2969
|
+
*/
|
|
2970
|
+
connection_seconds: number;
|
|
2971
|
+
/**
|
|
2972
|
+
* @description Total bytes transferred to clients.
|
|
2973
|
+
* @type integer, int64
|
|
2974
|
+
*/
|
|
2975
|
+
bytes_transferred: number;
|
|
2976
|
+
};
|
|
2977
|
+
|
|
2978
|
+
/**
|
|
2979
|
+
* Generated by Kubb (https://kubb.dev/).
|
|
2980
|
+
* Do not edit manually.
|
|
2981
|
+
*/
|
|
2982
|
+
|
|
2983
|
+
/**
|
|
2984
|
+
* @description Response envelope for project usage queries.
|
|
2985
|
+
*/
|
|
2986
|
+
type ProjectUsageResponse = {
|
|
2987
|
+
/**
|
|
2988
|
+
* @description Daily usage entries grouped by region for the project.
|
|
2989
|
+
* @type array
|
|
2990
|
+
*/
|
|
2991
|
+
usage: ProjectDailyUsage[];
|
|
2992
|
+
};
|
|
2993
|
+
|
|
2994
|
+
/**
|
|
2995
|
+
* Generated by Kubb (https://kubb.dev/).
|
|
2996
|
+
* Do not edit manually.
|
|
2997
|
+
*/
|
|
2998
|
+
|
|
2999
|
+
type GetProjectUsagePathParams = {
|
|
3000
|
+
/**
|
|
3001
|
+
* @description Unique project identifier (prefixed, e.g. prj_xxx).
|
|
3002
|
+
* @pattern ^[a-zA-Z0-9_.-]+$
|
|
3003
|
+
* @type string
|
|
3004
|
+
*/
|
|
3005
|
+
project_id: string;
|
|
3006
|
+
};
|
|
3007
|
+
type GetProjectUsageQueryParams = {
|
|
3008
|
+
/**
|
|
3009
|
+
* @description Start date (inclusive, YYYY-MM-DD).
|
|
3010
|
+
* @type string, date
|
|
3011
|
+
*/
|
|
3012
|
+
start_date: string;
|
|
3013
|
+
/**
|
|
3014
|
+
* @description End date (inclusive, YYYY-MM-DD).
|
|
3015
|
+
* @type string, date
|
|
3016
|
+
*/
|
|
3017
|
+
end_date: string;
|
|
3018
|
+
};
|
|
3019
|
+
/**
|
|
3020
|
+
* @description Daily usage data by region.
|
|
3021
|
+
*/
|
|
3022
|
+
type GetProjectUsage200 = ProjectUsageResponse;
|
|
3023
|
+
type GetProjectUsageQueryResponse = GetProjectUsage200;
|
|
3024
|
+
|
|
3025
|
+
/**
|
|
3026
|
+
* Generated by scripts/generate-maps.ts — do not edit manually.
|
|
3027
|
+
* Run: pnpm --filter pgbeam generate
|
|
3028
|
+
*/
|
|
3029
|
+
|
|
3030
|
+
declare const operationsByTag: {
|
|
3031
|
+
readonly account: {
|
|
3032
|
+
readonly exportAccountData: {
|
|
3033
|
+
readonly method: "GET";
|
|
3034
|
+
readonly path: "/v1/account/export";
|
|
3035
|
+
};
|
|
3036
|
+
readonly getOnboardingProgress: {
|
|
3037
|
+
readonly method: "GET";
|
|
3038
|
+
readonly path: "/v1/organizations/{org_id}/onboarding";
|
|
3039
|
+
};
|
|
3040
|
+
readonly updateOnboardingProgress: {
|
|
3041
|
+
readonly method: "PATCH";
|
|
3042
|
+
readonly path: "/v1/organizations/{org_id}/onboarding";
|
|
3043
|
+
};
|
|
3044
|
+
};
|
|
3045
|
+
readonly analytics: {
|
|
3046
|
+
readonly getOrganizationActivity: {
|
|
3047
|
+
readonly method: "GET";
|
|
3048
|
+
readonly path: "/v1/organizations/{org_id}/activity";
|
|
3049
|
+
};
|
|
3050
|
+
readonly listPlans: {
|
|
3051
|
+
readonly method: "GET";
|
|
3052
|
+
readonly path: "/v1/plans";
|
|
3053
|
+
};
|
|
3054
|
+
readonly getOrganizationPlan: {
|
|
3055
|
+
readonly method: "GET";
|
|
3056
|
+
readonly path: "/v1/organizations/{org_id}/plan";
|
|
3057
|
+
};
|
|
3058
|
+
readonly updateSpendLimit: {
|
|
3059
|
+
readonly method: "PUT";
|
|
3060
|
+
readonly path: "/v1/organizations/{org_id}/spend-limit";
|
|
3061
|
+
};
|
|
3062
|
+
readonly submitCancellationFeedback: {
|
|
3063
|
+
readonly method: "POST";
|
|
3064
|
+
readonly path: "/v1/organizations/{org_id}/cancellation-feedback";
|
|
3065
|
+
};
|
|
3066
|
+
readonly getProjectInsights: {
|
|
3067
|
+
readonly method: "GET";
|
|
3068
|
+
readonly path: "/v1/projects/{project_id}/insights";
|
|
3069
|
+
};
|
|
3070
|
+
readonly getOrganizationUsage: {
|
|
3071
|
+
readonly method: "GET";
|
|
3072
|
+
readonly path: "/v1/organizations/{org_id}/usage";
|
|
3073
|
+
};
|
|
3074
|
+
readonly getProjectUsage: {
|
|
3075
|
+
readonly method: "GET";
|
|
3076
|
+
readonly path: "/v1/projects/{project_id}/usage";
|
|
3077
|
+
};
|
|
3078
|
+
};
|
|
3079
|
+
readonly projects: {
|
|
3080
|
+
readonly listCacheRules: {
|
|
3081
|
+
readonly method: "GET";
|
|
3082
|
+
readonly path: "/v1/projects/{project_id}/databases/{database_id}/cache-rules";
|
|
3083
|
+
};
|
|
3084
|
+
readonly updateCacheRule: {
|
|
3085
|
+
readonly method: "PUT";
|
|
3086
|
+
readonly path: "/v1/projects/{project_id}/databases/{database_id}/cache-rules/{query_hash}";
|
|
3087
|
+
};
|
|
3088
|
+
readonly listCustomDomains: {
|
|
3089
|
+
readonly method: "GET";
|
|
3090
|
+
readonly path: "/v1/projects/{project_id}/domains";
|
|
3091
|
+
};
|
|
3092
|
+
readonly createCustomDomain: {
|
|
3093
|
+
readonly method: "POST";
|
|
3094
|
+
readonly path: "/v1/projects/{project_id}/domains";
|
|
3095
|
+
};
|
|
3096
|
+
readonly deleteCustomDomain: {
|
|
3097
|
+
readonly method: "DELETE";
|
|
3098
|
+
readonly path: "/v1/projects/{project_id}/domains/{domain_id}";
|
|
3099
|
+
};
|
|
3100
|
+
readonly verifyCustomDomain: {
|
|
3101
|
+
readonly method: "POST";
|
|
3102
|
+
readonly path: "/v1/projects/{project_id}/domains/{domain_id}/verify";
|
|
3103
|
+
};
|
|
3104
|
+
readonly listProjects: {
|
|
3105
|
+
readonly method: "GET";
|
|
3106
|
+
readonly path: "/v1/projects";
|
|
3107
|
+
};
|
|
3108
|
+
readonly createProject: {
|
|
3109
|
+
readonly method: "POST";
|
|
3110
|
+
readonly path: "/v1/projects";
|
|
3111
|
+
};
|
|
3112
|
+
readonly getProject: {
|
|
3113
|
+
readonly method: "GET";
|
|
3114
|
+
readonly path: "/v1/projects/{project_id}";
|
|
3115
|
+
};
|
|
3116
|
+
readonly updateProject: {
|
|
3117
|
+
readonly method: "PATCH";
|
|
3118
|
+
readonly path: "/v1/projects/{project_id}";
|
|
3119
|
+
};
|
|
3120
|
+
readonly deleteProject: {
|
|
3121
|
+
readonly method: "DELETE";
|
|
3122
|
+
readonly path: "/v1/projects/{project_id}";
|
|
3123
|
+
};
|
|
3124
|
+
readonly getProjectMetrics: {
|
|
3125
|
+
readonly method: "GET";
|
|
3126
|
+
readonly path: "/v1/projects/{project_id}/metrics";
|
|
3127
|
+
};
|
|
3128
|
+
readonly listReplicas: {
|
|
3129
|
+
readonly method: "GET";
|
|
3130
|
+
readonly path: "/v1/databases/{database_id}/replicas";
|
|
3131
|
+
};
|
|
3132
|
+
readonly createReplica: {
|
|
3133
|
+
readonly method: "POST";
|
|
3134
|
+
readonly path: "/v1/databases/{database_id}/replicas";
|
|
3135
|
+
};
|
|
3136
|
+
readonly deleteReplica: {
|
|
3137
|
+
readonly method: "DELETE";
|
|
3138
|
+
readonly path: "/v1/databases/{database_id}/replicas/{replica_id}";
|
|
3139
|
+
};
|
|
3140
|
+
};
|
|
3141
|
+
readonly databases: {
|
|
3142
|
+
readonly listDatabases: {
|
|
3143
|
+
readonly method: "GET";
|
|
3144
|
+
readonly path: "/v1/projects/{project_id}/databases";
|
|
3145
|
+
};
|
|
3146
|
+
readonly createDatabase: {
|
|
3147
|
+
readonly method: "POST";
|
|
3148
|
+
readonly path: "/v1/projects/{project_id}/databases";
|
|
3149
|
+
};
|
|
3150
|
+
readonly getDatabase: {
|
|
3151
|
+
readonly method: "GET";
|
|
3152
|
+
readonly path: "/v1/projects/{project_id}/databases/{database_id}";
|
|
3153
|
+
};
|
|
3154
|
+
readonly updateDatabase: {
|
|
3155
|
+
readonly method: "PATCH";
|
|
3156
|
+
readonly path: "/v1/projects/{project_id}/databases/{database_id}";
|
|
3157
|
+
};
|
|
3158
|
+
readonly deleteDatabase: {
|
|
3159
|
+
readonly method: "DELETE";
|
|
3160
|
+
readonly path: "/v1/projects/{project_id}/databases/{database_id}";
|
|
3161
|
+
};
|
|
3162
|
+
readonly testDatabaseConnection: {
|
|
3163
|
+
readonly method: "POST";
|
|
3164
|
+
readonly path: "/v1/projects/{project_id}/databases/{database_id}/test-connection";
|
|
3165
|
+
};
|
|
3166
|
+
};
|
|
3167
|
+
readonly platform: {
|
|
3168
|
+
readonly getHealth: {
|
|
3169
|
+
readonly method: "GET";
|
|
3170
|
+
readonly path: "/v1/health";
|
|
3171
|
+
};
|
|
3172
|
+
readonly listRegions: {
|
|
3173
|
+
readonly method: "GET";
|
|
3174
|
+
readonly path: "/v1/regions";
|
|
3175
|
+
};
|
|
3176
|
+
};
|
|
3177
|
+
};
|
|
3178
|
+
declare const operationsByPath: {
|
|
3179
|
+
readonly "GET /v1/account/export": {
|
|
3180
|
+
readonly method: "GET";
|
|
3181
|
+
readonly path: "/v1/account/export";
|
|
3182
|
+
readonly operationId: "exportAccountData";
|
|
3183
|
+
};
|
|
3184
|
+
readonly "GET /v1/organizations/{org_id}/activity": {
|
|
3185
|
+
readonly method: "GET";
|
|
3186
|
+
readonly path: "/v1/organizations/{org_id}/activity";
|
|
3187
|
+
readonly operationId: "getOrganizationActivity";
|
|
3188
|
+
};
|
|
3189
|
+
readonly "GET /v1/plans": {
|
|
3190
|
+
readonly method: "GET";
|
|
3191
|
+
readonly path: "/v1/plans";
|
|
3192
|
+
readonly operationId: "listPlans";
|
|
3193
|
+
};
|
|
3194
|
+
readonly "GET /v1/organizations/{org_id}/plan": {
|
|
3195
|
+
readonly method: "GET";
|
|
3196
|
+
readonly path: "/v1/organizations/{org_id}/plan";
|
|
3197
|
+
readonly operationId: "getOrganizationPlan";
|
|
3198
|
+
};
|
|
3199
|
+
readonly "PUT /v1/organizations/{org_id}/spend-limit": {
|
|
3200
|
+
readonly method: "PUT";
|
|
3201
|
+
readonly path: "/v1/organizations/{org_id}/spend-limit";
|
|
3202
|
+
readonly operationId: "updateSpendLimit";
|
|
3203
|
+
};
|
|
3204
|
+
readonly "POST /v1/organizations/{org_id}/cancellation-feedback": {
|
|
3205
|
+
readonly method: "POST";
|
|
3206
|
+
readonly path: "/v1/organizations/{org_id}/cancellation-feedback";
|
|
3207
|
+
readonly operationId: "submitCancellationFeedback";
|
|
3208
|
+
};
|
|
3209
|
+
readonly "GET /v1/projects/{project_id}/databases/{database_id}/cache-rules": {
|
|
3210
|
+
readonly method: "GET";
|
|
3211
|
+
readonly path: "/v1/projects/{project_id}/databases/{database_id}/cache-rules";
|
|
3212
|
+
readonly operationId: "listCacheRules";
|
|
3213
|
+
};
|
|
3214
|
+
readonly "PUT /v1/projects/{project_id}/databases/{database_id}/cache-rules/{query_hash}": {
|
|
3215
|
+
readonly method: "PUT";
|
|
3216
|
+
readonly path: "/v1/projects/{project_id}/databases/{database_id}/cache-rules/{query_hash}";
|
|
3217
|
+
readonly operationId: "updateCacheRule";
|
|
3218
|
+
};
|
|
3219
|
+
readonly "GET /v1/projects/{project_id}/databases": {
|
|
3220
|
+
readonly method: "GET";
|
|
3221
|
+
readonly path: "/v1/projects/{project_id}/databases";
|
|
3222
|
+
readonly operationId: "listDatabases";
|
|
3223
|
+
};
|
|
3224
|
+
readonly "POST /v1/projects/{project_id}/databases": {
|
|
3225
|
+
readonly method: "POST";
|
|
3226
|
+
readonly path: "/v1/projects/{project_id}/databases";
|
|
3227
|
+
readonly operationId: "createDatabase";
|
|
3228
|
+
};
|
|
3229
|
+
readonly "GET /v1/projects/{project_id}/databases/{database_id}": {
|
|
3230
|
+
readonly method: "GET";
|
|
3231
|
+
readonly path: "/v1/projects/{project_id}/databases/{database_id}";
|
|
3232
|
+
readonly operationId: "getDatabase";
|
|
3233
|
+
};
|
|
3234
|
+
readonly "PATCH /v1/projects/{project_id}/databases/{database_id}": {
|
|
3235
|
+
readonly method: "PATCH";
|
|
3236
|
+
readonly path: "/v1/projects/{project_id}/databases/{database_id}";
|
|
3237
|
+
readonly operationId: "updateDatabase";
|
|
3238
|
+
};
|
|
3239
|
+
readonly "DELETE /v1/projects/{project_id}/databases/{database_id}": {
|
|
3240
|
+
readonly method: "DELETE";
|
|
3241
|
+
readonly path: "/v1/projects/{project_id}/databases/{database_id}";
|
|
3242
|
+
readonly operationId: "deleteDatabase";
|
|
3243
|
+
};
|
|
3244
|
+
readonly "POST /v1/projects/{project_id}/databases/{database_id}/test-connection": {
|
|
3245
|
+
readonly method: "POST";
|
|
3246
|
+
readonly path: "/v1/projects/{project_id}/databases/{database_id}/test-connection";
|
|
3247
|
+
readonly operationId: "testDatabaseConnection";
|
|
3248
|
+
};
|
|
3249
|
+
readonly "GET /v1/projects/{project_id}/domains": {
|
|
3250
|
+
readonly method: "GET";
|
|
3251
|
+
readonly path: "/v1/projects/{project_id}/domains";
|
|
3252
|
+
readonly operationId: "listCustomDomains";
|
|
3253
|
+
};
|
|
3254
|
+
readonly "POST /v1/projects/{project_id}/domains": {
|
|
3255
|
+
readonly method: "POST";
|
|
3256
|
+
readonly path: "/v1/projects/{project_id}/domains";
|
|
3257
|
+
readonly operationId: "createCustomDomain";
|
|
3258
|
+
};
|
|
3259
|
+
readonly "DELETE /v1/projects/{project_id}/domains/{domain_id}": {
|
|
3260
|
+
readonly method: "DELETE";
|
|
3261
|
+
readonly path: "/v1/projects/{project_id}/domains/{domain_id}";
|
|
3262
|
+
readonly operationId: "deleteCustomDomain";
|
|
3263
|
+
};
|
|
3264
|
+
readonly "POST /v1/projects/{project_id}/domains/{domain_id}/verify": {
|
|
3265
|
+
readonly method: "POST";
|
|
3266
|
+
readonly path: "/v1/projects/{project_id}/domains/{domain_id}/verify";
|
|
3267
|
+
readonly operationId: "verifyCustomDomain";
|
|
3268
|
+
};
|
|
3269
|
+
readonly "GET /v1/health": {
|
|
3270
|
+
readonly method: "GET";
|
|
3271
|
+
readonly path: "/v1/health";
|
|
3272
|
+
readonly operationId: "getHealth";
|
|
3273
|
+
};
|
|
3274
|
+
readonly "GET /v1/projects/{project_id}/insights": {
|
|
3275
|
+
readonly method: "GET";
|
|
3276
|
+
readonly path: "/v1/projects/{project_id}/insights";
|
|
3277
|
+
readonly operationId: "getProjectInsights";
|
|
3278
|
+
};
|
|
3279
|
+
readonly "GET /v1/organizations/{org_id}/onboarding": {
|
|
3280
|
+
readonly method: "GET";
|
|
3281
|
+
readonly path: "/v1/organizations/{org_id}/onboarding";
|
|
3282
|
+
readonly operationId: "getOnboardingProgress";
|
|
3283
|
+
};
|
|
3284
|
+
readonly "PATCH /v1/organizations/{org_id}/onboarding": {
|
|
3285
|
+
readonly method: "PATCH";
|
|
3286
|
+
readonly path: "/v1/organizations/{org_id}/onboarding";
|
|
3287
|
+
readonly operationId: "updateOnboardingProgress";
|
|
3288
|
+
};
|
|
3289
|
+
readonly "GET /v1/projects": {
|
|
3290
|
+
readonly method: "GET";
|
|
3291
|
+
readonly path: "/v1/projects";
|
|
3292
|
+
readonly operationId: "listProjects";
|
|
3293
|
+
};
|
|
3294
|
+
readonly "POST /v1/projects": {
|
|
3295
|
+
readonly method: "POST";
|
|
3296
|
+
readonly path: "/v1/projects";
|
|
3297
|
+
readonly operationId: "createProject";
|
|
3298
|
+
};
|
|
3299
|
+
readonly "GET /v1/projects/{project_id}": {
|
|
3300
|
+
readonly method: "GET";
|
|
3301
|
+
readonly path: "/v1/projects/{project_id}";
|
|
3302
|
+
readonly operationId: "getProject";
|
|
3303
|
+
};
|
|
3304
|
+
readonly "PATCH /v1/projects/{project_id}": {
|
|
3305
|
+
readonly method: "PATCH";
|
|
3306
|
+
readonly path: "/v1/projects/{project_id}";
|
|
3307
|
+
readonly operationId: "updateProject";
|
|
3308
|
+
};
|
|
3309
|
+
readonly "DELETE /v1/projects/{project_id}": {
|
|
3310
|
+
readonly method: "DELETE";
|
|
3311
|
+
readonly path: "/v1/projects/{project_id}";
|
|
3312
|
+
readonly operationId: "deleteProject";
|
|
3313
|
+
};
|
|
3314
|
+
readonly "GET /v1/projects/{project_id}/metrics": {
|
|
3315
|
+
readonly method: "GET";
|
|
3316
|
+
readonly path: "/v1/projects/{project_id}/metrics";
|
|
3317
|
+
readonly operationId: "getProjectMetrics";
|
|
3318
|
+
};
|
|
3319
|
+
readonly "GET /v1/regions": {
|
|
3320
|
+
readonly method: "GET";
|
|
3321
|
+
readonly path: "/v1/regions";
|
|
3322
|
+
readonly operationId: "listRegions";
|
|
3323
|
+
};
|
|
3324
|
+
readonly "GET /v1/databases/{database_id}/replicas": {
|
|
3325
|
+
readonly method: "GET";
|
|
3326
|
+
readonly path: "/v1/databases/{database_id}/replicas";
|
|
3327
|
+
readonly operationId: "listReplicas";
|
|
3328
|
+
};
|
|
3329
|
+
readonly "POST /v1/databases/{database_id}/replicas": {
|
|
3330
|
+
readonly method: "POST";
|
|
3331
|
+
readonly path: "/v1/databases/{database_id}/replicas";
|
|
3332
|
+
readonly operationId: "createReplica";
|
|
3333
|
+
};
|
|
3334
|
+
readonly "DELETE /v1/databases/{database_id}/replicas/{replica_id}": {
|
|
3335
|
+
readonly method: "DELETE";
|
|
3336
|
+
readonly path: "/v1/databases/{database_id}/replicas/{replica_id}";
|
|
3337
|
+
readonly operationId: "deleteReplica";
|
|
3338
|
+
};
|
|
3339
|
+
readonly "GET /v1/organizations/{org_id}/usage": {
|
|
3340
|
+
readonly method: "GET";
|
|
3341
|
+
readonly path: "/v1/organizations/{org_id}/usage";
|
|
3342
|
+
readonly operationId: "getOrganizationUsage";
|
|
3343
|
+
};
|
|
3344
|
+
readonly "GET /v1/projects/{project_id}/usage": {
|
|
3345
|
+
readonly method: "GET";
|
|
3346
|
+
readonly path: "/v1/projects/{project_id}/usage";
|
|
3347
|
+
readonly operationId: "getProjectUsage";
|
|
3348
|
+
};
|
|
3349
|
+
};
|
|
3350
|
+
interface ApiOperations {
|
|
3351
|
+
account: {
|
|
3352
|
+
exportAccountData(): Promise<ExportAccountDataQueryResponse>;
|
|
3353
|
+
getOnboardingProgress(params: {
|
|
3354
|
+
pathParams: GetOnboardingProgressPathParams;
|
|
3355
|
+
}): Promise<GetOnboardingProgressQueryResponse>;
|
|
3356
|
+
updateOnboardingProgress(params: {
|
|
3357
|
+
pathParams: UpdateOnboardingProgressPathParams;
|
|
3358
|
+
body: UpdateOnboardingProgressMutationRequest;
|
|
3359
|
+
}): Promise<UpdateOnboardingProgressMutationResponse>;
|
|
3360
|
+
};
|
|
3361
|
+
analytics: {
|
|
3362
|
+
getOrganizationActivity(params: {
|
|
3363
|
+
pathParams: GetOrganizationActivityPathParams;
|
|
3364
|
+
queryParams?: GetOrganizationActivityQueryParams;
|
|
3365
|
+
}): Promise<GetOrganizationActivityQueryResponse>;
|
|
3366
|
+
listPlans(): Promise<ListPlansQueryResponse>;
|
|
3367
|
+
getOrganizationPlan(params: {
|
|
3368
|
+
pathParams: GetOrganizationPlanPathParams;
|
|
3369
|
+
}): Promise<GetOrganizationPlanQueryResponse>;
|
|
3370
|
+
updateSpendLimit(params: {
|
|
3371
|
+
pathParams: UpdateSpendLimitPathParams;
|
|
3372
|
+
body: UpdateSpendLimitMutationRequest;
|
|
3373
|
+
}): Promise<UpdateSpendLimitMutationResponse>;
|
|
3374
|
+
submitCancellationFeedback(params: {
|
|
3375
|
+
pathParams: SubmitCancellationFeedbackPathParams;
|
|
3376
|
+
body: SubmitCancellationFeedbackMutationRequest;
|
|
3377
|
+
}): Promise<void>;
|
|
3378
|
+
getProjectInsights(params: {
|
|
3379
|
+
pathParams: GetProjectInsightsPathParams;
|
|
3380
|
+
queryParams?: GetProjectInsightsQueryParams;
|
|
3381
|
+
}): Promise<GetProjectInsightsQueryResponse>;
|
|
3382
|
+
getOrganizationUsage(params: {
|
|
3383
|
+
pathParams: GetOrganizationUsagePathParams;
|
|
3384
|
+
queryParams: GetOrganizationUsageQueryParams;
|
|
3385
|
+
}): Promise<GetOrganizationUsageQueryResponse>;
|
|
3386
|
+
getProjectUsage(params: {
|
|
3387
|
+
pathParams: GetProjectUsagePathParams;
|
|
3388
|
+
queryParams: GetProjectUsageQueryParams;
|
|
3389
|
+
}): Promise<GetProjectUsageQueryResponse>;
|
|
3390
|
+
};
|
|
3391
|
+
projects: {
|
|
3392
|
+
listCacheRules(params: {
|
|
3393
|
+
pathParams: ListCacheRulesPathParams;
|
|
3394
|
+
queryParams?: ListCacheRulesQueryParams;
|
|
3395
|
+
}): Promise<ListCacheRulesQueryResponse>;
|
|
3396
|
+
updateCacheRule(params: {
|
|
3397
|
+
pathParams: UpdateCacheRulePathParams;
|
|
3398
|
+
body: UpdateCacheRuleMutationRequest;
|
|
3399
|
+
}): Promise<UpdateCacheRuleMutationResponse>;
|
|
3400
|
+
listCustomDomains(params: {
|
|
3401
|
+
pathParams: ListCustomDomainsPathParams;
|
|
3402
|
+
queryParams?: ListCustomDomainsQueryParams;
|
|
3403
|
+
}): Promise<ListCustomDomainsQueryResponse>;
|
|
3404
|
+
createCustomDomain(params: {
|
|
3405
|
+
pathParams: CreateCustomDomainPathParams;
|
|
3406
|
+
body: CreateCustomDomainMutationRequest;
|
|
3407
|
+
}): Promise<CreateCustomDomainMutationResponse>;
|
|
3408
|
+
deleteCustomDomain(params: {
|
|
3409
|
+
pathParams: DeleteCustomDomainPathParams;
|
|
3410
|
+
}): Promise<void>;
|
|
3411
|
+
verifyCustomDomain(params: {
|
|
3412
|
+
pathParams: VerifyCustomDomainPathParams;
|
|
3413
|
+
}): Promise<VerifyCustomDomainMutationResponse>;
|
|
3414
|
+
listProjects(params: {
|
|
3415
|
+
queryParams: ListProjectsQueryParams;
|
|
3416
|
+
}): Promise<ListProjectsQueryResponse>;
|
|
3417
|
+
createProject(params: {
|
|
3418
|
+
body: CreateProjectMutationRequest;
|
|
3419
|
+
}): Promise<CreateProjectMutationResponse>;
|
|
3420
|
+
getProject(params: {
|
|
3421
|
+
pathParams: GetProjectPathParams;
|
|
3422
|
+
}): Promise<GetProjectQueryResponse>;
|
|
3423
|
+
updateProject(params: {
|
|
3424
|
+
pathParams: UpdateProjectPathParams;
|
|
3425
|
+
body: UpdateProjectMutationRequest;
|
|
3426
|
+
}): Promise<UpdateProjectMutationResponse>;
|
|
3427
|
+
deleteProject(params: {
|
|
3428
|
+
pathParams: DeleteProjectPathParams;
|
|
3429
|
+
}): Promise<void>;
|
|
3430
|
+
getProjectMetrics(params: {
|
|
3431
|
+
pathParams: GetProjectMetricsPathParams;
|
|
3432
|
+
queryParams?: GetProjectMetricsQueryParams;
|
|
3433
|
+
}): Promise<GetProjectMetricsQueryResponse>;
|
|
3434
|
+
listReplicas(params: {
|
|
3435
|
+
pathParams: ListReplicasPathParams;
|
|
3436
|
+
}): Promise<ListReplicasQueryResponse>;
|
|
3437
|
+
createReplica(params: {
|
|
3438
|
+
pathParams: CreateReplicaPathParams;
|
|
3439
|
+
body: CreateReplicaMutationRequest;
|
|
3440
|
+
}): Promise<CreateReplicaMutationResponse>;
|
|
3441
|
+
deleteReplica(params: {
|
|
3442
|
+
pathParams: DeleteReplicaPathParams;
|
|
3443
|
+
}): Promise<void>;
|
|
3444
|
+
};
|
|
3445
|
+
databases: {
|
|
3446
|
+
listDatabases(params: {
|
|
3447
|
+
pathParams: ListDatabasesPathParams;
|
|
3448
|
+
queryParams?: ListDatabasesQueryParams;
|
|
3449
|
+
}): Promise<ListDatabasesQueryResponse>;
|
|
3450
|
+
createDatabase(params: {
|
|
3451
|
+
pathParams: CreateDatabasePathParams;
|
|
3452
|
+
body: CreateDatabaseMutationRequest;
|
|
3453
|
+
}): Promise<CreateDatabaseMutationResponse>;
|
|
3454
|
+
getDatabase(params: {
|
|
3455
|
+
pathParams: GetDatabasePathParams;
|
|
3456
|
+
}): Promise<GetDatabaseQueryResponse>;
|
|
3457
|
+
updateDatabase(params: {
|
|
3458
|
+
pathParams: UpdateDatabasePathParams;
|
|
3459
|
+
body: UpdateDatabaseMutationRequest;
|
|
3460
|
+
}): Promise<UpdateDatabaseMutationResponse>;
|
|
3461
|
+
deleteDatabase(params: {
|
|
3462
|
+
pathParams: DeleteDatabasePathParams;
|
|
3463
|
+
}): Promise<void>;
|
|
3464
|
+
testDatabaseConnection(params: {
|
|
3465
|
+
pathParams: TestDatabaseConnectionPathParams;
|
|
3466
|
+
}): Promise<TestDatabaseConnectionMutationResponse>;
|
|
3467
|
+
};
|
|
3468
|
+
platform: {
|
|
3469
|
+
getHealth(): Promise<GetHealthQueryResponse>;
|
|
3470
|
+
listRegions(): Promise<ListRegionsQueryResponse>;
|
|
3471
|
+
};
|
|
3472
|
+
}
|
|
3473
|
+
interface RequestMap {
|
|
3474
|
+
"GET /v1/account/export": {
|
|
3475
|
+
params?: undefined;
|
|
3476
|
+
response: ExportAccountDataQueryResponse;
|
|
3477
|
+
};
|
|
3478
|
+
"GET /v1/organizations/{org_id}/activity": {
|
|
3479
|
+
params: {
|
|
3480
|
+
pathParams: GetOrganizationActivityPathParams;
|
|
3481
|
+
queryParams?: GetOrganizationActivityQueryParams;
|
|
3482
|
+
};
|
|
3483
|
+
response: GetOrganizationActivityQueryResponse;
|
|
3484
|
+
};
|
|
3485
|
+
"GET /v1/plans": {
|
|
3486
|
+
params?: undefined;
|
|
3487
|
+
response: ListPlansQueryResponse;
|
|
3488
|
+
};
|
|
3489
|
+
"GET /v1/organizations/{org_id}/plan": {
|
|
3490
|
+
params: {
|
|
3491
|
+
pathParams: GetOrganizationPlanPathParams;
|
|
3492
|
+
};
|
|
3493
|
+
response: GetOrganizationPlanQueryResponse;
|
|
3494
|
+
};
|
|
3495
|
+
"PUT /v1/organizations/{org_id}/spend-limit": {
|
|
3496
|
+
params: {
|
|
3497
|
+
pathParams: UpdateSpendLimitPathParams;
|
|
3498
|
+
body: UpdateSpendLimitMutationRequest;
|
|
3499
|
+
};
|
|
3500
|
+
response: UpdateSpendLimitMutationResponse;
|
|
3501
|
+
};
|
|
3502
|
+
"POST /v1/organizations/{org_id}/cancellation-feedback": {
|
|
3503
|
+
params: {
|
|
3504
|
+
pathParams: SubmitCancellationFeedbackPathParams;
|
|
3505
|
+
body: SubmitCancellationFeedbackMutationRequest;
|
|
3506
|
+
};
|
|
3507
|
+
response: void;
|
|
3508
|
+
};
|
|
3509
|
+
"GET /v1/projects/{project_id}/databases/{database_id}/cache-rules": {
|
|
3510
|
+
params: {
|
|
3511
|
+
pathParams: ListCacheRulesPathParams;
|
|
3512
|
+
queryParams?: ListCacheRulesQueryParams;
|
|
3513
|
+
};
|
|
3514
|
+
response: ListCacheRulesQueryResponse;
|
|
3515
|
+
};
|
|
3516
|
+
"PUT /v1/projects/{project_id}/databases/{database_id}/cache-rules/{query_hash}": {
|
|
3517
|
+
params: {
|
|
3518
|
+
pathParams: UpdateCacheRulePathParams;
|
|
3519
|
+
body: UpdateCacheRuleMutationRequest;
|
|
3520
|
+
};
|
|
3521
|
+
response: UpdateCacheRuleMutationResponse;
|
|
3522
|
+
};
|
|
3523
|
+
"GET /v1/projects/{project_id}/databases": {
|
|
3524
|
+
params: {
|
|
3525
|
+
pathParams: ListDatabasesPathParams;
|
|
3526
|
+
queryParams?: ListDatabasesQueryParams;
|
|
3527
|
+
};
|
|
3528
|
+
response: ListDatabasesQueryResponse;
|
|
3529
|
+
};
|
|
3530
|
+
"POST /v1/projects/{project_id}/databases": {
|
|
3531
|
+
params: {
|
|
3532
|
+
pathParams: CreateDatabasePathParams;
|
|
3533
|
+
body: CreateDatabaseMutationRequest;
|
|
3534
|
+
};
|
|
3535
|
+
response: CreateDatabaseMutationResponse;
|
|
3536
|
+
};
|
|
3537
|
+
"GET /v1/projects/{project_id}/databases/{database_id}": {
|
|
3538
|
+
params: {
|
|
3539
|
+
pathParams: GetDatabasePathParams;
|
|
3540
|
+
};
|
|
3541
|
+
response: GetDatabaseQueryResponse;
|
|
3542
|
+
};
|
|
3543
|
+
"PATCH /v1/projects/{project_id}/databases/{database_id}": {
|
|
3544
|
+
params: {
|
|
3545
|
+
pathParams: UpdateDatabasePathParams;
|
|
3546
|
+
body: UpdateDatabaseMutationRequest;
|
|
3547
|
+
};
|
|
3548
|
+
response: UpdateDatabaseMutationResponse;
|
|
3549
|
+
};
|
|
3550
|
+
"DELETE /v1/projects/{project_id}/databases/{database_id}": {
|
|
3551
|
+
params: {
|
|
3552
|
+
pathParams: DeleteDatabasePathParams;
|
|
3553
|
+
};
|
|
3554
|
+
response: void;
|
|
3555
|
+
};
|
|
3556
|
+
"POST /v1/projects/{project_id}/databases/{database_id}/test-connection": {
|
|
3557
|
+
params: {
|
|
3558
|
+
pathParams: TestDatabaseConnectionPathParams;
|
|
3559
|
+
};
|
|
3560
|
+
response: TestDatabaseConnectionMutationResponse;
|
|
3561
|
+
};
|
|
3562
|
+
"GET /v1/projects/{project_id}/domains": {
|
|
3563
|
+
params: {
|
|
3564
|
+
pathParams: ListCustomDomainsPathParams;
|
|
3565
|
+
queryParams?: ListCustomDomainsQueryParams;
|
|
3566
|
+
};
|
|
3567
|
+
response: ListCustomDomainsQueryResponse;
|
|
3568
|
+
};
|
|
3569
|
+
"POST /v1/projects/{project_id}/domains": {
|
|
3570
|
+
params: {
|
|
3571
|
+
pathParams: CreateCustomDomainPathParams;
|
|
3572
|
+
body: CreateCustomDomainMutationRequest;
|
|
3573
|
+
};
|
|
3574
|
+
response: CreateCustomDomainMutationResponse;
|
|
3575
|
+
};
|
|
3576
|
+
"DELETE /v1/projects/{project_id}/domains/{domain_id}": {
|
|
3577
|
+
params: {
|
|
3578
|
+
pathParams: DeleteCustomDomainPathParams;
|
|
3579
|
+
};
|
|
3580
|
+
response: void;
|
|
3581
|
+
};
|
|
3582
|
+
"POST /v1/projects/{project_id}/domains/{domain_id}/verify": {
|
|
3583
|
+
params: {
|
|
3584
|
+
pathParams: VerifyCustomDomainPathParams;
|
|
3585
|
+
};
|
|
3586
|
+
response: VerifyCustomDomainMutationResponse;
|
|
3587
|
+
};
|
|
3588
|
+
"GET /v1/health": {
|
|
3589
|
+
params?: undefined;
|
|
3590
|
+
response: GetHealthQueryResponse;
|
|
3591
|
+
};
|
|
3592
|
+
"GET /v1/projects/{project_id}/insights": {
|
|
3593
|
+
params: {
|
|
3594
|
+
pathParams: GetProjectInsightsPathParams;
|
|
3595
|
+
queryParams?: GetProjectInsightsQueryParams;
|
|
3596
|
+
};
|
|
3597
|
+
response: GetProjectInsightsQueryResponse;
|
|
3598
|
+
};
|
|
3599
|
+
"GET /v1/organizations/{org_id}/onboarding": {
|
|
3600
|
+
params: {
|
|
3601
|
+
pathParams: GetOnboardingProgressPathParams;
|
|
3602
|
+
};
|
|
3603
|
+
response: GetOnboardingProgressQueryResponse;
|
|
3604
|
+
};
|
|
3605
|
+
"PATCH /v1/organizations/{org_id}/onboarding": {
|
|
3606
|
+
params: {
|
|
3607
|
+
pathParams: UpdateOnboardingProgressPathParams;
|
|
3608
|
+
body: UpdateOnboardingProgressMutationRequest;
|
|
3609
|
+
};
|
|
3610
|
+
response: UpdateOnboardingProgressMutationResponse;
|
|
3611
|
+
};
|
|
3612
|
+
"GET /v1/projects": {
|
|
3613
|
+
params: {
|
|
3614
|
+
queryParams: ListProjectsQueryParams;
|
|
3615
|
+
};
|
|
3616
|
+
response: ListProjectsQueryResponse;
|
|
3617
|
+
};
|
|
3618
|
+
"POST /v1/projects": {
|
|
3619
|
+
params: {
|
|
3620
|
+
body: CreateProjectMutationRequest;
|
|
3621
|
+
};
|
|
3622
|
+
response: CreateProjectMutationResponse;
|
|
3623
|
+
};
|
|
3624
|
+
"GET /v1/projects/{project_id}": {
|
|
3625
|
+
params: {
|
|
3626
|
+
pathParams: GetProjectPathParams;
|
|
3627
|
+
};
|
|
3628
|
+
response: GetProjectQueryResponse;
|
|
3629
|
+
};
|
|
3630
|
+
"PATCH /v1/projects/{project_id}": {
|
|
3631
|
+
params: {
|
|
3632
|
+
pathParams: UpdateProjectPathParams;
|
|
3633
|
+
body: UpdateProjectMutationRequest;
|
|
3634
|
+
};
|
|
3635
|
+
response: UpdateProjectMutationResponse;
|
|
3636
|
+
};
|
|
3637
|
+
"DELETE /v1/projects/{project_id}": {
|
|
3638
|
+
params: {
|
|
3639
|
+
pathParams: DeleteProjectPathParams;
|
|
3640
|
+
};
|
|
3641
|
+
response: void;
|
|
3642
|
+
};
|
|
3643
|
+
"GET /v1/projects/{project_id}/metrics": {
|
|
3644
|
+
params: {
|
|
3645
|
+
pathParams: GetProjectMetricsPathParams;
|
|
3646
|
+
queryParams?: GetProjectMetricsQueryParams;
|
|
3647
|
+
};
|
|
3648
|
+
response: GetProjectMetricsQueryResponse;
|
|
3649
|
+
};
|
|
3650
|
+
"GET /v1/regions": {
|
|
3651
|
+
params?: undefined;
|
|
3652
|
+
response: ListRegionsQueryResponse;
|
|
3653
|
+
};
|
|
3654
|
+
"GET /v1/databases/{database_id}/replicas": {
|
|
3655
|
+
params: {
|
|
3656
|
+
pathParams: ListReplicasPathParams;
|
|
3657
|
+
};
|
|
3658
|
+
response: ListReplicasQueryResponse;
|
|
3659
|
+
};
|
|
3660
|
+
"POST /v1/databases/{database_id}/replicas": {
|
|
3661
|
+
params: {
|
|
3662
|
+
pathParams: CreateReplicaPathParams;
|
|
3663
|
+
body: CreateReplicaMutationRequest;
|
|
3664
|
+
};
|
|
3665
|
+
response: CreateReplicaMutationResponse;
|
|
3666
|
+
};
|
|
3667
|
+
"DELETE /v1/databases/{database_id}/replicas/{replica_id}": {
|
|
3668
|
+
params: {
|
|
3669
|
+
pathParams: DeleteReplicaPathParams;
|
|
3670
|
+
};
|
|
3671
|
+
response: void;
|
|
3672
|
+
};
|
|
3673
|
+
"GET /v1/organizations/{org_id}/usage": {
|
|
3674
|
+
params: {
|
|
3675
|
+
pathParams: GetOrganizationUsagePathParams;
|
|
3676
|
+
queryParams: GetOrganizationUsageQueryParams;
|
|
3677
|
+
};
|
|
3678
|
+
response: GetOrganizationUsageQueryResponse;
|
|
3679
|
+
};
|
|
3680
|
+
"GET /v1/projects/{project_id}/usage": {
|
|
3681
|
+
params: {
|
|
3682
|
+
pathParams: GetProjectUsagePathParams;
|
|
3683
|
+
queryParams: GetProjectUsageQueryParams;
|
|
3684
|
+
};
|
|
3685
|
+
response: GetProjectUsageQueryResponse;
|
|
3686
|
+
};
|
|
3687
|
+
}
|
|
3688
|
+
type ApiTag = keyof ApiOperations;
|
|
3689
|
+
type Route = keyof RequestMap;
|
|
3690
|
+
|
|
3691
|
+
export { operationsByPath, operationsByTag };
|
|
3692
|
+
export type { ApiOperations, ApiTag, RequestMap, Route };
|