pgbeam 0.1.0 → 0.2.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +56 -0
- package/dist/{index.d.ts → index.d.mts} +579 -208
- package/dist/{index.js → index.mjs} +71 -74
- package/dist/{operations.d.ts → operations.d.mts} +540 -245
- package/dist/{operations.js → operations.mjs} +70 -73
- package/package.json +22 -32
|
@@ -2,224 +2,280 @@
|
|
|
2
2
|
* Generated by Kubb (https://kubb.dev/).
|
|
3
3
|
* Do not edit manually.
|
|
4
4
|
*/
|
|
5
|
+
/**
|
|
6
|
+
* @description Full account data export for privacy and data-portability requests.
|
|
7
|
+
*/
|
|
5
8
|
type AccountExport = {
|
|
6
9
|
/**
|
|
10
|
+
* @description Core user profile data.
|
|
7
11
|
* @type object
|
|
8
12
|
*/
|
|
9
13
|
user: {
|
|
10
14
|
/**
|
|
15
|
+
* @description User identifier.
|
|
11
16
|
* @type string
|
|
12
17
|
*/
|
|
13
18
|
id: string;
|
|
14
19
|
/**
|
|
20
|
+
* @description Display name for the user.
|
|
15
21
|
* @type string
|
|
16
22
|
*/
|
|
17
23
|
name: string;
|
|
18
24
|
/**
|
|
25
|
+
* @description Primary account email address.
|
|
19
26
|
* @type string, email
|
|
20
27
|
*/
|
|
21
28
|
email: string;
|
|
22
29
|
/**
|
|
30
|
+
* @description Whether the email address has been verified.
|
|
23
31
|
* @type boolean
|
|
24
32
|
*/
|
|
25
33
|
email_verified: boolean;
|
|
26
34
|
/**
|
|
35
|
+
* @description Avatar image URL, if present.
|
|
27
36
|
* @type string | undefined
|
|
28
37
|
*/
|
|
29
38
|
image?: string;
|
|
30
39
|
/**
|
|
40
|
+
* @description When the user account was created.
|
|
31
41
|
* @type string, date-time
|
|
32
42
|
*/
|
|
33
43
|
created_at: string;
|
|
34
44
|
/**
|
|
45
|
+
* @description When the user profile was last updated.
|
|
35
46
|
* @type string, date-time
|
|
36
47
|
*/
|
|
37
48
|
updated_at: string;
|
|
38
49
|
};
|
|
39
50
|
/**
|
|
51
|
+
* @description Organizations the user belongs to.
|
|
40
52
|
* @type array
|
|
41
53
|
*/
|
|
42
54
|
organizations: {
|
|
43
55
|
/**
|
|
56
|
+
* @description Organization identifier.
|
|
44
57
|
* @type string
|
|
45
58
|
*/
|
|
46
59
|
id: string;
|
|
47
60
|
/**
|
|
61
|
+
* @description Organization display name.
|
|
48
62
|
* @type string
|
|
49
63
|
*/
|
|
50
64
|
name: string;
|
|
51
65
|
/**
|
|
66
|
+
* @description Organization slug used in URLs and routing.
|
|
52
67
|
* @type string
|
|
53
68
|
*/
|
|
54
69
|
slug: string;
|
|
55
70
|
/**
|
|
71
|
+
* @description User role within the organization.
|
|
56
72
|
* @type string
|
|
57
73
|
*/
|
|
58
74
|
role: string;
|
|
59
75
|
/**
|
|
76
|
+
* @description When the organization membership was created.
|
|
60
77
|
* @type string, date-time
|
|
61
78
|
*/
|
|
62
79
|
created_at: string;
|
|
63
80
|
}[];
|
|
64
81
|
/**
|
|
82
|
+
* @description Projects owned through the user\'s organizations.
|
|
65
83
|
* @type array
|
|
66
84
|
*/
|
|
67
85
|
projects: {
|
|
68
86
|
/**
|
|
87
|
+
* @description Project identifier.
|
|
69
88
|
* @type string
|
|
70
89
|
*/
|
|
71
90
|
id: string;
|
|
72
91
|
/**
|
|
92
|
+
* @description Owning organization identifier.
|
|
73
93
|
* @type string
|
|
74
94
|
*/
|
|
75
95
|
org_id: string;
|
|
76
96
|
/**
|
|
97
|
+
* @description Project display name.
|
|
77
98
|
* @type string
|
|
78
99
|
*/
|
|
79
100
|
name: string;
|
|
80
101
|
/**
|
|
102
|
+
* @description Project description at export time.
|
|
81
103
|
* @type string
|
|
82
104
|
*/
|
|
83
105
|
description: string;
|
|
84
106
|
/**
|
|
107
|
+
* @description Project lifecycle status.
|
|
85
108
|
* @type string
|
|
86
109
|
*/
|
|
87
110
|
status: string;
|
|
88
111
|
/**
|
|
112
|
+
* @description When the project was created.
|
|
89
113
|
* @type string, date-time
|
|
90
114
|
*/
|
|
91
115
|
created_at: string;
|
|
92
116
|
}[];
|
|
93
117
|
/**
|
|
118
|
+
* @description Databases registered under the exported projects.
|
|
94
119
|
* @type array
|
|
95
120
|
*/
|
|
96
121
|
databases: {
|
|
97
122
|
/**
|
|
123
|
+
* @description Database identifier.
|
|
98
124
|
* @type string
|
|
99
125
|
*/
|
|
100
126
|
id: string;
|
|
101
127
|
/**
|
|
128
|
+
* @description Owning project identifier.
|
|
102
129
|
* @type string
|
|
103
130
|
*/
|
|
104
131
|
project_id: string;
|
|
105
132
|
/**
|
|
133
|
+
* @description Upstream PostgreSQL host.
|
|
106
134
|
* @type string
|
|
107
135
|
*/
|
|
108
136
|
host: string;
|
|
109
137
|
/**
|
|
138
|
+
* @description Upstream PostgreSQL port.
|
|
110
139
|
* @type integer
|
|
111
140
|
*/
|
|
112
141
|
port: number;
|
|
113
142
|
/**
|
|
143
|
+
* @description Upstream PostgreSQL database name.
|
|
114
144
|
* @type string
|
|
115
145
|
*/
|
|
116
146
|
name: string;
|
|
117
147
|
/**
|
|
148
|
+
* @description PostgreSQL SSL mode in use for the database.
|
|
118
149
|
* @type string
|
|
119
150
|
*/
|
|
120
151
|
ssl_mode: string;
|
|
121
152
|
/**
|
|
153
|
+
* @description Database role within the project.
|
|
122
154
|
* @type string
|
|
123
155
|
*/
|
|
124
156
|
role: string;
|
|
125
157
|
/**
|
|
158
|
+
* @description When the database registration was created.
|
|
126
159
|
* @type string, date-time
|
|
127
160
|
*/
|
|
128
161
|
created_at: string;
|
|
129
162
|
}[];
|
|
130
163
|
/**
|
|
164
|
+
* @description Auth sessions associated with the user.
|
|
131
165
|
* @type array
|
|
132
166
|
*/
|
|
133
167
|
sessions: {
|
|
134
168
|
/**
|
|
169
|
+
* @description Session identifier.
|
|
135
170
|
* @type string
|
|
136
171
|
*/
|
|
137
172
|
id: string;
|
|
138
173
|
/**
|
|
174
|
+
* @description When the session expires.
|
|
139
175
|
* @type string, date-time
|
|
140
176
|
*/
|
|
141
177
|
expires_at: string;
|
|
142
178
|
/**
|
|
179
|
+
* @description When the session was created.
|
|
143
180
|
* @type string, date-time
|
|
144
181
|
*/
|
|
145
182
|
created_at: string;
|
|
146
183
|
/**
|
|
184
|
+
* @description IP address used to create the session, if known.
|
|
147
185
|
* @type string | undefined
|
|
148
186
|
*/
|
|
149
187
|
ip_address?: string;
|
|
150
188
|
/**
|
|
189
|
+
* @description User agent captured for the session, if known.
|
|
151
190
|
* @type string | undefined
|
|
152
191
|
*/
|
|
153
192
|
user_agent?: string;
|
|
154
193
|
}[];
|
|
155
194
|
/**
|
|
195
|
+
* @description User communication preferences.
|
|
156
196
|
* @type object
|
|
157
197
|
*/
|
|
158
198
|
email_preferences: {
|
|
159
199
|
/**
|
|
200
|
+
* @description Whether marketing emails are enabled.
|
|
160
201
|
* @type boolean | undefined
|
|
161
202
|
*/
|
|
162
203
|
marketing_emails?: boolean;
|
|
163
204
|
/**
|
|
205
|
+
* @description Whether usage alert emails are enabled.
|
|
164
206
|
* @type boolean | undefined
|
|
165
207
|
*/
|
|
166
208
|
usage_limit_alerts?: boolean;
|
|
167
209
|
};
|
|
168
210
|
/**
|
|
211
|
+
* @description Recorded legal-document acceptances for the user.
|
|
169
212
|
* @type array
|
|
170
213
|
*/
|
|
171
214
|
consents: {
|
|
172
215
|
/**
|
|
216
|
+
* @description Consent record identifier.
|
|
173
217
|
* @type string
|
|
174
218
|
*/
|
|
175
219
|
id: string;
|
|
176
220
|
/**
|
|
221
|
+
* @description Legal document type accepted by the user.
|
|
177
222
|
* @type string
|
|
178
223
|
*/
|
|
179
224
|
document_type: string;
|
|
180
225
|
/**
|
|
226
|
+
* @description Accepted document version.
|
|
181
227
|
* @type string
|
|
182
228
|
*/
|
|
183
229
|
document_version: string;
|
|
184
230
|
/**
|
|
231
|
+
* @description When the document was accepted.
|
|
185
232
|
* @type string, date-time
|
|
186
233
|
*/
|
|
187
234
|
accepted_at: string;
|
|
188
235
|
/**
|
|
236
|
+
* @description IP address captured when consent was recorded.
|
|
189
237
|
* @type string | undefined
|
|
190
238
|
*/
|
|
191
239
|
ip_address?: string;
|
|
192
240
|
}[];
|
|
193
241
|
/**
|
|
242
|
+
* @description Recent audit log entries associated with the account.
|
|
194
243
|
* @type array
|
|
195
244
|
*/
|
|
196
245
|
audit_logs: {
|
|
197
246
|
/**
|
|
247
|
+
* @description Audit log entry identifier.
|
|
198
248
|
* @type string
|
|
199
249
|
*/
|
|
200
250
|
id: string;
|
|
201
251
|
/**
|
|
252
|
+
* @description Action captured by the audit log entry.
|
|
202
253
|
* @type string
|
|
203
254
|
*/
|
|
204
255
|
action: string;
|
|
205
256
|
/**
|
|
257
|
+
* @description Type of resource affected by the action.
|
|
206
258
|
* @type string | undefined
|
|
207
259
|
*/
|
|
208
260
|
resource_type?: string;
|
|
209
261
|
/**
|
|
262
|
+
* @description Identifier of the affected resource.
|
|
210
263
|
* @type string | undefined
|
|
211
264
|
*/
|
|
212
265
|
resource_id?: string;
|
|
213
266
|
/**
|
|
267
|
+
* @description IP address associated with the action, if known.
|
|
214
268
|
* @type string | undefined
|
|
215
269
|
*/
|
|
216
270
|
ip_address?: string;
|
|
217
271
|
/**
|
|
272
|
+
* @description When the audit log entry was recorded.
|
|
218
273
|
* @type string, date-time
|
|
219
274
|
*/
|
|
220
275
|
created_at: string;
|
|
221
276
|
}[];
|
|
222
277
|
/**
|
|
278
|
+
* @description When the export was generated.
|
|
223
279
|
* @type string, date-time
|
|
224
280
|
*/
|
|
225
281
|
exported_at: string;
|
|
@@ -229,8 +285,12 @@ type AccountExport = {
|
|
|
229
285
|
* Generated by Kubb (https://kubb.dev/).
|
|
230
286
|
* Do not edit manually.
|
|
231
287
|
*/
|
|
288
|
+
/**
|
|
289
|
+
* @description Standard error response envelope for PgBeam API requests.
|
|
290
|
+
*/
|
|
232
291
|
type Error$1 = {
|
|
233
292
|
/**
|
|
293
|
+
* @description Error metadata for the failed request.
|
|
234
294
|
* @type object
|
|
235
295
|
*/
|
|
236
296
|
error: {
|
|
@@ -244,13 +304,6 @@ type Error$1 = {
|
|
|
244
304
|
* @type string
|
|
245
305
|
*/
|
|
246
306
|
message: string;
|
|
247
|
-
/**
|
|
248
|
-
* @description Optional structured error details.
|
|
249
|
-
* @type object | undefined
|
|
250
|
-
*/
|
|
251
|
-
details?: {
|
|
252
|
-
[key: string]: any;
|
|
253
|
-
};
|
|
254
307
|
};
|
|
255
308
|
};
|
|
256
309
|
|
|
@@ -267,6 +320,10 @@ type ExportAccountData200 = AccountExport;
|
|
|
267
320
|
* @description Missing or invalid authentication.
|
|
268
321
|
*/
|
|
269
322
|
type ExportAccountData401 = Error$1;
|
|
323
|
+
/**
|
|
324
|
+
* @description Resource not found.
|
|
325
|
+
*/
|
|
326
|
+
type ExportAccountData404 = Error$1;
|
|
270
327
|
/**
|
|
271
328
|
* @description Rate limited. Try again later.
|
|
272
329
|
*/
|
|
@@ -274,55 +331,69 @@ type ExportAccountData429 = Error$1;
|
|
|
274
331
|
type ExportAccountDataQueryResponse = ExportAccountData200;
|
|
275
332
|
type ExportAccountDataQuery = {
|
|
276
333
|
Response: ExportAccountData200;
|
|
277
|
-
Errors: ExportAccountData401 | ExportAccountData429;
|
|
334
|
+
Errors: ExportAccountData401 | ExportAccountData404 | ExportAccountData429;
|
|
278
335
|
};
|
|
279
336
|
|
|
280
337
|
/**
|
|
281
338
|
* Generated by Kubb (https://kubb.dev/).
|
|
282
339
|
* Do not edit manually.
|
|
283
340
|
*/
|
|
341
|
+
/**
|
|
342
|
+
* @description Recent activity snapshot for a project in an organization.
|
|
343
|
+
*/
|
|
284
344
|
type ActivityEntry = {
|
|
285
345
|
/**
|
|
346
|
+
* @description Unique activity snapshot identifier.
|
|
286
347
|
* @type string
|
|
287
348
|
*/
|
|
288
349
|
id: string;
|
|
289
350
|
/**
|
|
351
|
+
* @description Project that produced the activity snapshot.
|
|
290
352
|
* @type string
|
|
291
353
|
*/
|
|
292
354
|
project_id: string;
|
|
293
355
|
/**
|
|
356
|
+
* @description Project display name at the time of the snapshot.
|
|
294
357
|
* @type string
|
|
295
358
|
*/
|
|
296
359
|
project_name: string;
|
|
297
360
|
/**
|
|
361
|
+
* @description Region where the activity was observed.
|
|
298
362
|
* @type string
|
|
299
363
|
*/
|
|
300
364
|
region: string;
|
|
301
365
|
/**
|
|
366
|
+
* @description Total queries observed in the snapshot interval.
|
|
302
367
|
* @type integer, int64
|
|
303
368
|
*/
|
|
304
369
|
queries_total: number;
|
|
305
370
|
/**
|
|
371
|
+
* @description Number of cache hits during the interval.
|
|
306
372
|
* @type integer, int64
|
|
307
373
|
*/
|
|
308
374
|
cache_hits: number;
|
|
309
375
|
/**
|
|
376
|
+
* @description Number of cache misses during the interval.
|
|
310
377
|
* @type integer, int64
|
|
311
378
|
*/
|
|
312
379
|
cache_misses: number;
|
|
313
380
|
/**
|
|
381
|
+
* @description Average query latency in milliseconds.
|
|
314
382
|
* @type number, double
|
|
315
383
|
*/
|
|
316
384
|
avg_latency_ms: number;
|
|
317
385
|
/**
|
|
386
|
+
* @description 99th percentile query latency in milliseconds.
|
|
318
387
|
* @type number, double
|
|
319
388
|
*/
|
|
320
389
|
p99_latency_ms: number;
|
|
321
390
|
/**
|
|
391
|
+
* @description Number of active proxy connections during the interval.
|
|
322
392
|
* @type integer
|
|
323
393
|
*/
|
|
324
394
|
active_connections: number;
|
|
325
395
|
/**
|
|
396
|
+
* @description When the activity snapshot was recorded.
|
|
326
397
|
* @type string, date-time
|
|
327
398
|
*/
|
|
328
399
|
created_at: string;
|
|
@@ -333,8 +404,12 @@ type ActivityEntry = {
|
|
|
333
404
|
* Do not edit manually.
|
|
334
405
|
*/
|
|
335
406
|
|
|
407
|
+
/**
|
|
408
|
+
* @description Response envelope for organization activity queries.
|
|
409
|
+
*/
|
|
336
410
|
type ActivityResponse = {
|
|
337
411
|
/**
|
|
412
|
+
* @description Recent activity snapshots for projects in the organization.
|
|
338
413
|
* @type array
|
|
339
414
|
*/
|
|
340
415
|
entries: ActivityEntry[];
|
|
@@ -347,14 +422,17 @@ type ActivityResponse = {
|
|
|
347
422
|
|
|
348
423
|
type GetOrganizationActivityPathParams = {
|
|
349
424
|
/**
|
|
425
|
+
* @description Unique organization identifier.
|
|
426
|
+
* @pattern ^[a-zA-Z0-9_.-]+$
|
|
350
427
|
* @type string
|
|
351
428
|
*/
|
|
352
429
|
org_id: string;
|
|
353
430
|
};
|
|
354
431
|
type GetOrganizationActivityQueryParams = {
|
|
355
432
|
/**
|
|
433
|
+
* @description Maximum number of activity entries to return.
|
|
356
434
|
* @minLength 1
|
|
357
|
-
* @maxLength
|
|
435
|
+
* @maxLength 1000
|
|
358
436
|
* @default 100
|
|
359
437
|
* @type integer | undefined
|
|
360
438
|
*/
|
|
@@ -369,22 +447,33 @@ type GetOrganizationActivityQueryParams = {
|
|
|
369
447
|
* @description Recent activity entries.
|
|
370
448
|
*/
|
|
371
449
|
type GetOrganizationActivity200 = ActivityResponse;
|
|
450
|
+
/**
|
|
451
|
+
* @description Invalid request parameters.
|
|
452
|
+
*/
|
|
453
|
+
type GetOrganizationActivity400 = Error$1;
|
|
372
454
|
/**
|
|
373
455
|
* @description Missing or invalid authentication.
|
|
374
456
|
*/
|
|
375
457
|
type GetOrganizationActivity401 = Error$1;
|
|
458
|
+
/**
|
|
459
|
+
* @description Operation not allowed by current plan limits.
|
|
460
|
+
*/
|
|
461
|
+
type GetOrganizationActivity403 = Error$1;
|
|
376
462
|
type GetOrganizationActivityQueryResponse = GetOrganizationActivity200;
|
|
377
463
|
type GetOrganizationActivityQuery = {
|
|
378
464
|
Response: GetOrganizationActivity200;
|
|
379
465
|
PathParams: GetOrganizationActivityPathParams;
|
|
380
466
|
QueryParams: GetOrganizationActivityQueryParams;
|
|
381
|
-
Errors: GetOrganizationActivity401;
|
|
467
|
+
Errors: GetOrganizationActivity400 | GetOrganizationActivity401 | GetOrganizationActivity403;
|
|
382
468
|
};
|
|
383
469
|
|
|
384
470
|
/**
|
|
385
471
|
* Generated by Kubb (https://kubb.dev/).
|
|
386
472
|
* Do not edit manually.
|
|
387
473
|
*/
|
|
474
|
+
/**
|
|
475
|
+
* @description Effective usage limits enforced for an organization plan.
|
|
476
|
+
*/
|
|
388
477
|
type PlanLimits = {
|
|
389
478
|
/**
|
|
390
479
|
* @description Maximum queries per day across all projects. 0 means unlimited.
|
|
@@ -416,6 +505,16 @@ type PlanLimits = {
|
|
|
416
505
|
* @type integer, int64
|
|
417
506
|
*/
|
|
418
507
|
bytes_per_month: number;
|
|
508
|
+
/**
|
|
509
|
+
* @description Maximum query shapes in cache rules. 0 means unlimited.
|
|
510
|
+
* @type integer
|
|
511
|
+
*/
|
|
512
|
+
max_query_shapes: number;
|
|
513
|
+
/**
|
|
514
|
+
* @description Number of seats included in the plan.
|
|
515
|
+
* @type integer
|
|
516
|
+
*/
|
|
517
|
+
included_seats: number;
|
|
419
518
|
};
|
|
420
519
|
|
|
421
520
|
/**
|
|
@@ -423,6 +522,9 @@ type PlanLimits = {
|
|
|
423
522
|
* Do not edit manually.
|
|
424
523
|
*/
|
|
425
524
|
|
|
525
|
+
/**
|
|
526
|
+
* @description Publicly visible plan metadata and limits.
|
|
527
|
+
*/
|
|
426
528
|
type PlanInfo = {
|
|
427
529
|
/**
|
|
428
530
|
* @description Plan tier name (starter, pro, scale).
|
|
@@ -460,6 +562,7 @@ type PlanInfo = {
|
|
|
460
562
|
*/
|
|
461
563
|
trial_days?: number;
|
|
462
564
|
/**
|
|
565
|
+
* @description Effective usage limits enforced for an organization plan.
|
|
463
566
|
* @type object
|
|
464
567
|
*/
|
|
465
568
|
limits: PlanLimits;
|
|
@@ -470,8 +573,12 @@ type PlanInfo = {
|
|
|
470
573
|
* Do not edit manually.
|
|
471
574
|
*/
|
|
472
575
|
|
|
576
|
+
/**
|
|
577
|
+
* @description Response envelope for listing available billing plans.
|
|
578
|
+
*/
|
|
473
579
|
type ListPlansResponse = {
|
|
474
580
|
/**
|
|
581
|
+
* @description Billing plans available for self-serve signups.
|
|
475
582
|
* @type array
|
|
476
583
|
*/
|
|
477
584
|
plans: PlanInfo[];
|
|
@@ -505,8 +612,15 @@ declare const organizationPlanPlanEnum: {
|
|
|
505
612
|
readonly starter: "starter";
|
|
506
613
|
readonly pro: "pro";
|
|
507
614
|
readonly scale: "scale";
|
|
615
|
+
readonly enterprise: "enterprise";
|
|
508
616
|
};
|
|
509
617
|
type OrganizationPlanPlanEnumKey = (typeof organizationPlanPlanEnum)[keyof typeof organizationPlanPlanEnum];
|
|
618
|
+
declare const organizationPlanBillingProviderEnum: {
|
|
619
|
+
readonly stripe: "stripe";
|
|
620
|
+
readonly vercel: "vercel";
|
|
621
|
+
readonly aws: "aws";
|
|
622
|
+
};
|
|
623
|
+
type OrganizationPlanBillingProviderEnumKey = (typeof organizationPlanBillingProviderEnum)[keyof typeof organizationPlanBillingProviderEnum];
|
|
510
624
|
declare const organizationPlanSubscriptionStatusEnum: {
|
|
511
625
|
readonly none: "none";
|
|
512
626
|
readonly active: "active";
|
|
@@ -519,8 +633,12 @@ declare const organizationPlanSubscriptionStatusEnum: {
|
|
|
519
633
|
readonly paused: "paused";
|
|
520
634
|
};
|
|
521
635
|
type OrganizationPlanSubscriptionStatusEnumKey = (typeof organizationPlanSubscriptionStatusEnum)[keyof typeof organizationPlanSubscriptionStatusEnum];
|
|
636
|
+
/**
|
|
637
|
+
* @description Billing state and plan limits for an organization.
|
|
638
|
+
*/
|
|
522
639
|
type OrganizationPlan = {
|
|
523
640
|
/**
|
|
641
|
+
* @description Organization identifier the plan applies to.
|
|
524
642
|
* @type string
|
|
525
643
|
*/
|
|
526
644
|
org_id: string;
|
|
@@ -529,6 +647,11 @@ type OrganizationPlan = {
|
|
|
529
647
|
* @type string
|
|
530
648
|
*/
|
|
531
649
|
plan: OrganizationPlanPlanEnumKey;
|
|
650
|
+
/**
|
|
651
|
+
* @description Which billing provider manages this organization\'s subscription.
|
|
652
|
+
* @type string | undefined
|
|
653
|
+
*/
|
|
654
|
+
billing_provider?: OrganizationPlanBillingProviderEnumKey;
|
|
532
655
|
/**
|
|
533
656
|
* @description Stripe subscription status.
|
|
534
657
|
* @type string | undefined
|
|
@@ -545,14 +668,27 @@ type OrganizationPlan = {
|
|
|
545
668
|
*/
|
|
546
669
|
enabled?: boolean;
|
|
547
670
|
/**
|
|
671
|
+
* @description Whether the organization has custom enterprise pricing.
|
|
672
|
+
* @type boolean | undefined
|
|
673
|
+
*/
|
|
674
|
+
custom_pricing?: boolean;
|
|
675
|
+
/**
|
|
676
|
+
* @description Monthly spend limit in dollars. Null means no limit.
|
|
677
|
+
* @type number, double
|
|
678
|
+
*/
|
|
679
|
+
spend_limit?: number | null;
|
|
680
|
+
/**
|
|
681
|
+
* @description Effective usage limits enforced for an organization plan.
|
|
548
682
|
* @type object
|
|
549
683
|
*/
|
|
550
684
|
limits: PlanLimits;
|
|
551
685
|
/**
|
|
686
|
+
* @description When the billing record was created.
|
|
552
687
|
* @type string | undefined, date-time
|
|
553
688
|
*/
|
|
554
689
|
created_at?: string;
|
|
555
690
|
/**
|
|
691
|
+
* @description When the billing record was last updated.
|
|
556
692
|
* @type string | undefined, date-time
|
|
557
693
|
*/
|
|
558
694
|
updated_at?: string;
|
|
@@ -565,6 +701,8 @@ type OrganizationPlan = {
|
|
|
565
701
|
|
|
566
702
|
type GetOrganizationPlanPathParams = {
|
|
567
703
|
/**
|
|
704
|
+
* @description Unique organization identifier.
|
|
705
|
+
* @pattern ^[a-zA-Z0-9_.-]+$
|
|
568
706
|
* @type string
|
|
569
707
|
*/
|
|
570
708
|
org_id: string;
|
|
@@ -573,35 +711,157 @@ type GetOrganizationPlanPathParams = {
|
|
|
573
711
|
* @description Organization plan details.
|
|
574
712
|
*/
|
|
575
713
|
type GetOrganizationPlan200 = OrganizationPlan;
|
|
714
|
+
/**
|
|
715
|
+
* @description Invalid request parameters.
|
|
716
|
+
*/
|
|
717
|
+
type GetOrganizationPlan400 = Error$1;
|
|
576
718
|
/**
|
|
577
719
|
* @description Missing or invalid authentication.
|
|
578
720
|
*/
|
|
579
721
|
type GetOrganizationPlan401 = Error$1;
|
|
722
|
+
/**
|
|
723
|
+
* @description Operation not allowed by current plan limits.
|
|
724
|
+
*/
|
|
725
|
+
type GetOrganizationPlan403 = Error$1;
|
|
580
726
|
type GetOrganizationPlanQueryResponse = GetOrganizationPlan200;
|
|
581
727
|
type GetOrganizationPlanQuery = {
|
|
582
728
|
Response: GetOrganizationPlan200;
|
|
583
729
|
PathParams: GetOrganizationPlanPathParams;
|
|
584
|
-
Errors: GetOrganizationPlan401;
|
|
730
|
+
Errors: GetOrganizationPlan400 | GetOrganizationPlan401 | GetOrganizationPlan403;
|
|
731
|
+
};
|
|
732
|
+
|
|
733
|
+
/**
|
|
734
|
+
* Generated by Kubb (https://kubb.dev/).
|
|
735
|
+
* Do not edit manually.
|
|
736
|
+
*/
|
|
737
|
+
/**
|
|
738
|
+
* @description Request body for updating an organization\'s monthly spend cap.
|
|
739
|
+
*/
|
|
740
|
+
type UpdateSpendLimitRequest = {
|
|
741
|
+
/**
|
|
742
|
+
* @description Monthly spend limit in dollars. Null to remove the limit.
|
|
743
|
+
* @type number, double
|
|
744
|
+
*/
|
|
745
|
+
spend_limit?: number | null;
|
|
746
|
+
};
|
|
747
|
+
|
|
748
|
+
/**
|
|
749
|
+
* Generated by Kubb (https://kubb.dev/).
|
|
750
|
+
* Do not edit manually.
|
|
751
|
+
*/
|
|
752
|
+
|
|
753
|
+
type UpdateSpendLimitPathParams = {
|
|
754
|
+
/**
|
|
755
|
+
* @description Unique organization identifier.
|
|
756
|
+
* @pattern ^[a-zA-Z0-9_.-]+$
|
|
757
|
+
* @type string
|
|
758
|
+
*/
|
|
759
|
+
org_id: string;
|
|
760
|
+
};
|
|
761
|
+
/**
|
|
762
|
+
* @description Spend limit updated.
|
|
763
|
+
*/
|
|
764
|
+
type UpdateSpendLimit200 = OrganizationPlan;
|
|
765
|
+
/**
|
|
766
|
+
* @description Invalid request parameters.
|
|
767
|
+
*/
|
|
768
|
+
type UpdateSpendLimit400 = Error$1;
|
|
769
|
+
/**
|
|
770
|
+
* @description Missing or invalid authentication.
|
|
771
|
+
*/
|
|
772
|
+
type UpdateSpendLimit401 = Error$1;
|
|
773
|
+
/**
|
|
774
|
+
* @description Operation not allowed by current plan limits.
|
|
775
|
+
*/
|
|
776
|
+
type UpdateSpendLimit403 = Error$1;
|
|
777
|
+
type UpdateSpendLimitMutationRequest = UpdateSpendLimitRequest;
|
|
778
|
+
type UpdateSpendLimitMutationResponse = UpdateSpendLimit200;
|
|
779
|
+
type UpdateSpendLimitMutation = {
|
|
780
|
+
Response: UpdateSpendLimit200;
|
|
781
|
+
Request: UpdateSpendLimitMutationRequest;
|
|
782
|
+
PathParams: UpdateSpendLimitPathParams;
|
|
783
|
+
Errors: UpdateSpendLimit400 | UpdateSpendLimit401 | UpdateSpendLimit403;
|
|
784
|
+
};
|
|
785
|
+
|
|
786
|
+
/**
|
|
787
|
+
* Generated by Kubb (https://kubb.dev/).
|
|
788
|
+
* Do not edit manually.
|
|
789
|
+
*/
|
|
790
|
+
/**
|
|
791
|
+
* @description Request body for capturing cancellation feedback from a user.
|
|
792
|
+
*/
|
|
793
|
+
type CancellationFeedbackRequest = {
|
|
794
|
+
/**
|
|
795
|
+
* @description Predefined cancellation reason.
|
|
796
|
+
* @type string | undefined
|
|
797
|
+
*/
|
|
798
|
+
reason?: string;
|
|
799
|
+
/**
|
|
800
|
+
* @description Free-text feedback from the user.
|
|
801
|
+
* @type string | undefined
|
|
802
|
+
*/
|
|
803
|
+
feedback?: string;
|
|
804
|
+
};
|
|
805
|
+
|
|
806
|
+
/**
|
|
807
|
+
* Generated by Kubb (https://kubb.dev/).
|
|
808
|
+
* Do not edit manually.
|
|
809
|
+
*/
|
|
810
|
+
|
|
811
|
+
type SubmitCancellationFeedbackPathParams = {
|
|
812
|
+
/**
|
|
813
|
+
* @description Unique organization identifier.
|
|
814
|
+
* @pattern ^[a-zA-Z0-9_.-]+$
|
|
815
|
+
* @type string
|
|
816
|
+
*/
|
|
817
|
+
org_id: string;
|
|
818
|
+
};
|
|
819
|
+
/**
|
|
820
|
+
* @description Feedback recorded.
|
|
821
|
+
*/
|
|
822
|
+
type SubmitCancellationFeedback204 = any;
|
|
823
|
+
/**
|
|
824
|
+
* @description Invalid request parameters.
|
|
825
|
+
*/
|
|
826
|
+
type SubmitCancellationFeedback400 = Error$1;
|
|
827
|
+
/**
|
|
828
|
+
* @description Missing or invalid authentication.
|
|
829
|
+
*/
|
|
830
|
+
type SubmitCancellationFeedback401 = Error$1;
|
|
831
|
+
/**
|
|
832
|
+
* @description Operation not allowed by current plan limits.
|
|
833
|
+
*/
|
|
834
|
+
type SubmitCancellationFeedback403 = Error$1;
|
|
835
|
+
type SubmitCancellationFeedbackMutationRequest = CancellationFeedbackRequest;
|
|
836
|
+
type SubmitCancellationFeedbackMutationResponse = SubmitCancellationFeedback204;
|
|
837
|
+
type SubmitCancellationFeedbackMutation = {
|
|
838
|
+
Response: SubmitCancellationFeedback204;
|
|
839
|
+
Request: SubmitCancellationFeedbackMutationRequest;
|
|
840
|
+
PathParams: SubmitCancellationFeedbackPathParams;
|
|
841
|
+
Errors: SubmitCancellationFeedback400 | SubmitCancellationFeedback401 | SubmitCancellationFeedback403;
|
|
585
842
|
};
|
|
586
843
|
|
|
587
844
|
/**
|
|
588
845
|
* Generated by Kubb (https://kubb.dev/).
|
|
589
846
|
* Do not edit manually.
|
|
590
847
|
*/
|
|
591
|
-
declare const
|
|
848
|
+
declare const cacheRuleEntryQueryTypeEnum: {
|
|
592
849
|
readonly read: "read";
|
|
593
850
|
readonly write: "write";
|
|
594
851
|
readonly other: "other";
|
|
595
852
|
};
|
|
596
|
-
type
|
|
597
|
-
declare const
|
|
853
|
+
type CacheRuleEntryQueryTypeEnumKey = (typeof cacheRuleEntryQueryTypeEnum)[keyof typeof cacheRuleEntryQueryTypeEnum];
|
|
854
|
+
declare const cacheRuleEntryRecommendationEnum: {
|
|
598
855
|
readonly great: "great";
|
|
599
856
|
readonly good: "good";
|
|
600
857
|
readonly fair: "fair";
|
|
601
858
|
readonly poor: "poor";
|
|
602
859
|
};
|
|
603
|
-
type
|
|
604
|
-
|
|
860
|
+
type CacheRuleEntryRecommendationEnumKey = (typeof cacheRuleEntryRecommendationEnum)[keyof typeof cacheRuleEntryRecommendationEnum];
|
|
861
|
+
/**
|
|
862
|
+
* @description Observed query shape and its cache recommendation for a database.
|
|
863
|
+
*/
|
|
864
|
+
type CacheRuleEntry = {
|
|
605
865
|
/**
|
|
606
866
|
* @description xxhash64 hex of the normalized SQL.
|
|
607
867
|
* @type string
|
|
@@ -616,7 +876,7 @@ type QueryCatalogEntry = {
|
|
|
616
876
|
* @description Query classification.
|
|
617
877
|
* @type string
|
|
618
878
|
*/
|
|
619
|
-
query_type:
|
|
879
|
+
query_type: CacheRuleEntryQueryTypeEnumKey;
|
|
620
880
|
/**
|
|
621
881
|
* @description Whether caching is enabled for this query shape.
|
|
622
882
|
* @type boolean
|
|
@@ -663,7 +923,7 @@ type QueryCatalogEntry = {
|
|
|
663
923
|
* @description Cache recommendation based on frequency, latency, and stability.
|
|
664
924
|
* @type string
|
|
665
925
|
*/
|
|
666
|
-
recommendation:
|
|
926
|
+
recommendation: CacheRuleEntryRecommendationEnumKey;
|
|
667
927
|
/**
|
|
668
928
|
* @description When this query was first observed.
|
|
669
929
|
* @type string, date-time
|
|
@@ -681,11 +941,15 @@ type QueryCatalogEntry = {
|
|
|
681
941
|
* Do not edit manually.
|
|
682
942
|
*/
|
|
683
943
|
|
|
684
|
-
|
|
944
|
+
/**
|
|
945
|
+
* @description Cursor-paginated cache-rule entries for a database.
|
|
946
|
+
*/
|
|
947
|
+
type ListCacheRulesResponse = {
|
|
685
948
|
/**
|
|
949
|
+
* @description Query shapes returned for the current page.
|
|
686
950
|
* @type array
|
|
687
951
|
*/
|
|
688
|
-
entries:
|
|
952
|
+
entries: CacheRuleEntry[];
|
|
689
953
|
/**
|
|
690
954
|
* @description Opaque token for cursor-based pagination.
|
|
691
955
|
* @type string | undefined
|
|
@@ -698,7 +962,7 @@ type ListQueryCatalogResponse = {
|
|
|
698
962
|
* Do not edit manually.
|
|
699
963
|
*/
|
|
700
964
|
|
|
701
|
-
type
|
|
965
|
+
type ListCacheRulesPathParams = {
|
|
702
966
|
/**
|
|
703
967
|
* @description Unique project identifier (prefixed, e.g. prj_xxx).
|
|
704
968
|
* @pattern ^[a-zA-Z0-9_.-]+$
|
|
@@ -712,7 +976,7 @@ type ListQueryCatalogPathParams = {
|
|
|
712
976
|
*/
|
|
713
977
|
database_id: string;
|
|
714
978
|
};
|
|
715
|
-
type
|
|
979
|
+
type ListCacheRulesQueryParams = {
|
|
716
980
|
/**
|
|
717
981
|
* @description Maximum number of items to return (1-100, default 20).
|
|
718
982
|
* @minLength 1
|
|
@@ -729,33 +993,40 @@ type ListQueryCatalogQueryParams = {
|
|
|
729
993
|
page_token?: string;
|
|
730
994
|
};
|
|
731
995
|
/**
|
|
732
|
-
* @description
|
|
996
|
+
* @description Cache rule entries.
|
|
997
|
+
*/
|
|
998
|
+
type ListCacheRules200 = ListCacheRulesResponse;
|
|
999
|
+
/**
|
|
1000
|
+
* @description Invalid request parameters.
|
|
733
1001
|
*/
|
|
734
|
-
type
|
|
1002
|
+
type ListCacheRules400 = Error$1;
|
|
735
1003
|
/**
|
|
736
1004
|
* @description Missing or invalid authentication.
|
|
737
1005
|
*/
|
|
738
|
-
type
|
|
1006
|
+
type ListCacheRules401 = Error$1;
|
|
739
1007
|
/**
|
|
740
1008
|
* @description Operation not allowed by current plan limits.
|
|
741
1009
|
*/
|
|
742
|
-
type
|
|
1010
|
+
type ListCacheRules403 = Error$1;
|
|
743
1011
|
/**
|
|
744
1012
|
* @description Resource not found.
|
|
745
1013
|
*/
|
|
746
|
-
type
|
|
747
|
-
type
|
|
748
|
-
type
|
|
749
|
-
Response:
|
|
750
|
-
PathParams:
|
|
751
|
-
QueryParams:
|
|
752
|
-
Errors:
|
|
1014
|
+
type ListCacheRules404 = Error$1;
|
|
1015
|
+
type ListCacheRulesQueryResponse = ListCacheRules200;
|
|
1016
|
+
type ListCacheRulesQuery = {
|
|
1017
|
+
Response: ListCacheRules200;
|
|
1018
|
+
PathParams: ListCacheRulesPathParams;
|
|
1019
|
+
QueryParams: ListCacheRulesQueryParams;
|
|
1020
|
+
Errors: ListCacheRules400 | ListCacheRules401 | ListCacheRules403 | ListCacheRules404;
|
|
753
1021
|
};
|
|
754
1022
|
|
|
755
1023
|
/**
|
|
756
1024
|
* Generated by Kubb (https://kubb.dev/).
|
|
757
1025
|
* Do not edit manually.
|
|
758
1026
|
*/
|
|
1027
|
+
/**
|
|
1028
|
+
* @description Request body for updating cache behavior of a query shape.
|
|
1029
|
+
*/
|
|
759
1030
|
type UpdateCacheRuleRequest = {
|
|
760
1031
|
/**
|
|
761
1032
|
* @description Whether to enable caching for this query shape.
|
|
@@ -783,11 +1054,15 @@ type UpdateCacheRuleRequest = {
|
|
|
783
1054
|
* Do not edit manually.
|
|
784
1055
|
*/
|
|
785
1056
|
|
|
1057
|
+
/**
|
|
1058
|
+
* @description Response returned after updating a cache rule.
|
|
1059
|
+
*/
|
|
786
1060
|
type UpdateCacheRuleResponse = {
|
|
787
1061
|
/**
|
|
1062
|
+
* @description Observed query shape and its cache recommendation for a database.
|
|
788
1063
|
* @type object
|
|
789
1064
|
*/
|
|
790
|
-
entry:
|
|
1065
|
+
entry: CacheRuleEntry;
|
|
791
1066
|
};
|
|
792
1067
|
|
|
793
1068
|
/**
|
|
@@ -971,6 +1246,9 @@ type SSLMode = SSLModeEnumKey;
|
|
|
971
1246
|
* Do not edit manually.
|
|
972
1247
|
*/
|
|
973
1248
|
|
|
1249
|
+
/**
|
|
1250
|
+
* @description Registered upstream PostgreSQL database for a project.
|
|
1251
|
+
*/
|
|
974
1252
|
type Database = {
|
|
975
1253
|
/**
|
|
976
1254
|
* @description Unique database identifier (prefixed).
|
|
@@ -1036,10 +1314,12 @@ type Database = {
|
|
|
1036
1314
|
*/
|
|
1037
1315
|
pool_config: PoolConfig;
|
|
1038
1316
|
/**
|
|
1317
|
+
* @description When the database registration was created.
|
|
1039
1318
|
* @type string, date-time
|
|
1040
1319
|
*/
|
|
1041
1320
|
created_at: string;
|
|
1042
1321
|
/**
|
|
1322
|
+
* @description When the database registration was last updated.
|
|
1043
1323
|
* @type string, date-time
|
|
1044
1324
|
*/
|
|
1045
1325
|
updated_at: string;
|
|
@@ -1050,8 +1330,12 @@ type Database = {
|
|
|
1050
1330
|
* Do not edit manually.
|
|
1051
1331
|
*/
|
|
1052
1332
|
|
|
1333
|
+
/**
|
|
1334
|
+
* @description Cursor-paginated list of databases attached to a project.
|
|
1335
|
+
*/
|
|
1053
1336
|
type ListDatabasesResponse = {
|
|
1054
1337
|
/**
|
|
1338
|
+
* @description Databases on the current page.
|
|
1055
1339
|
* @type array
|
|
1056
1340
|
*/
|
|
1057
1341
|
databases: Database[];
|
|
@@ -1124,6 +1408,9 @@ type ListDatabasesQuery = {
|
|
|
1124
1408
|
* Do not edit manually.
|
|
1125
1409
|
*/
|
|
1126
1410
|
|
|
1411
|
+
/**
|
|
1412
|
+
* @description Request body for registering an upstream database.
|
|
1413
|
+
*/
|
|
1127
1414
|
type CreateDatabaseRequest = {
|
|
1128
1415
|
/**
|
|
1129
1416
|
* @description PostgreSQL host.
|
|
@@ -1281,6 +1568,9 @@ type GetDatabaseQuery = {
|
|
|
1281
1568
|
* Do not edit manually.
|
|
1282
1569
|
*/
|
|
1283
1570
|
|
|
1571
|
+
/**
|
|
1572
|
+
* @description Request body for partially updating an upstream database.
|
|
1573
|
+
*/
|
|
1284
1574
|
type UpdateDatabaseRequest = {
|
|
1285
1575
|
/**
|
|
1286
1576
|
* @description Updated PostgreSQL host.
|
|
@@ -1440,6 +1730,9 @@ type DeleteDatabaseMutation = {
|
|
|
1440
1730
|
* Generated by Kubb (https://kubb.dev/).
|
|
1441
1731
|
* Do not edit manually.
|
|
1442
1732
|
*/
|
|
1733
|
+
/**
|
|
1734
|
+
* @description Result of testing connectivity to an upstream database.
|
|
1735
|
+
*/
|
|
1443
1736
|
type TestConnectionResult = {
|
|
1444
1737
|
/**
|
|
1445
1738
|
* @description Whether the connection test succeeded.
|
|
@@ -1513,6 +1806,9 @@ type TestDatabaseConnectionMutation = {
|
|
|
1513
1806
|
* Generated by Kubb (https://kubb.dev/).
|
|
1514
1807
|
* Do not edit manually.
|
|
1515
1808
|
*/
|
|
1809
|
+
/**
|
|
1810
|
+
* @description Custom database hostname attached to a project.
|
|
1811
|
+
*/
|
|
1516
1812
|
type CustomDomain = {
|
|
1517
1813
|
/**
|
|
1518
1814
|
* @description Unique domain identifier (prefixed).
|
|
@@ -1586,10 +1882,12 @@ type CustomDomain = {
|
|
|
1586
1882
|
acme_cname_target?: string;
|
|
1587
1883
|
};
|
|
1588
1884
|
/**
|
|
1885
|
+
* @description When the custom domain was created.
|
|
1589
1886
|
* @type string, date-time
|
|
1590
1887
|
*/
|
|
1591
1888
|
created_at: string;
|
|
1592
1889
|
/**
|
|
1890
|
+
* @description When the custom domain was last updated.
|
|
1593
1891
|
* @type string, date-time
|
|
1594
1892
|
*/
|
|
1595
1893
|
updated_at: string;
|
|
@@ -1600,8 +1898,12 @@ type CustomDomain = {
|
|
|
1600
1898
|
* Do not edit manually.
|
|
1601
1899
|
*/
|
|
1602
1900
|
|
|
1901
|
+
/**
|
|
1902
|
+
* @description Cursor-paginated list of custom domains for a project.
|
|
1903
|
+
*/
|
|
1603
1904
|
type ListCustomDomainsResponse = {
|
|
1604
1905
|
/**
|
|
1906
|
+
* @description Custom domains on the current page.
|
|
1605
1907
|
* @type array
|
|
1606
1908
|
*/
|
|
1607
1909
|
domains: CustomDomain[];
|
|
@@ -1673,6 +1975,9 @@ type ListCustomDomainsQuery = {
|
|
|
1673
1975
|
* Generated by Kubb (https://kubb.dev/).
|
|
1674
1976
|
* Do not edit manually.
|
|
1675
1977
|
*/
|
|
1978
|
+
/**
|
|
1979
|
+
* @description Request body for attaching a custom domain to a project.
|
|
1980
|
+
*/
|
|
1676
1981
|
type CreateCustomDomainRequest = {
|
|
1677
1982
|
/**
|
|
1678
1983
|
* @description The custom domain name to add (e.g., db.example.com).
|
|
@@ -1781,6 +2086,9 @@ type DeleteCustomDomainMutation = {
|
|
|
1781
2086
|
* Do not edit manually.
|
|
1782
2087
|
*/
|
|
1783
2088
|
|
|
2089
|
+
/**
|
|
2090
|
+
* @description Result of checking DNS ownership for a custom domain.
|
|
2091
|
+
*/
|
|
1784
2092
|
type VerifyCustomDomainResponse = {
|
|
1785
2093
|
/**
|
|
1786
2094
|
* @description Whether DNS verification succeeded.
|
|
@@ -1793,6 +2101,7 @@ type VerifyCustomDomainResponse = {
|
|
|
1793
2101
|
*/
|
|
1794
2102
|
error?: string;
|
|
1795
2103
|
/**
|
|
2104
|
+
* @description Custom database hostname attached to a project.
|
|
1796
2105
|
* @type object | undefined
|
|
1797
2106
|
*/
|
|
1798
2107
|
domain?: CustomDomain;
|
|
@@ -1853,6 +2162,9 @@ declare const healthResponseStatusEnum: {
|
|
|
1853
2162
|
readonly degraded: "degraded";
|
|
1854
2163
|
};
|
|
1855
2164
|
type HealthResponseStatusEnumKey = (typeof healthResponseStatusEnum)[keyof typeof healthResponseStatusEnum];
|
|
2165
|
+
/**
|
|
2166
|
+
* @description Health status and build metadata for the API service.
|
|
2167
|
+
*/
|
|
1856
2168
|
type HealthResponse = {
|
|
1857
2169
|
/**
|
|
1858
2170
|
* @description Overall service health.
|
|
@@ -1886,9 +2198,9 @@ type HealthResponse = {
|
|
|
1886
2198
|
*/
|
|
1887
2199
|
type GetHealth200 = HealthResponse;
|
|
1888
2200
|
/**
|
|
1889
|
-
* @description
|
|
2201
|
+
* @description Rate limited. Try again later.
|
|
1890
2202
|
*/
|
|
1891
|
-
type GetHealth429 =
|
|
2203
|
+
type GetHealth429 = Error$1;
|
|
1892
2204
|
type GetHealthQueryResponse = GetHealth200;
|
|
1893
2205
|
type GetHealthQuery = {
|
|
1894
2206
|
Response: GetHealth200;
|
|
@@ -1899,12 +2211,17 @@ type GetHealthQuery = {
|
|
|
1899
2211
|
* Generated by Kubb (https://kubb.dev/).
|
|
1900
2212
|
* Do not edit manually.
|
|
1901
2213
|
*/
|
|
2214
|
+
/**
|
|
2215
|
+
* @description Aggregate cache performance metrics for the selected time range.
|
|
2216
|
+
*/
|
|
1902
2217
|
type CacheSummary = {
|
|
1903
2218
|
/**
|
|
2219
|
+
* @description Total number of cache hits in the selected time range.
|
|
1904
2220
|
* @type integer, int64
|
|
1905
2221
|
*/
|
|
1906
2222
|
total_hits: number;
|
|
1907
2223
|
/**
|
|
2224
|
+
* @description Total number of cache misses in the selected time range.
|
|
1908
2225
|
* @type integer, int64
|
|
1909
2226
|
*/
|
|
1910
2227
|
total_misses: number;
|
|
@@ -1919,6 +2236,9 @@ type CacheSummary = {
|
|
|
1919
2236
|
* Generated by Kubb (https://kubb.dev/).
|
|
1920
2237
|
* Do not edit manually.
|
|
1921
2238
|
*/
|
|
2239
|
+
/**
|
|
2240
|
+
* @description Aggregate latency metrics for the selected time range.
|
|
2241
|
+
*/
|
|
1922
2242
|
type LatencySummary = {
|
|
1923
2243
|
/**
|
|
1924
2244
|
* @description Average latency in milliseconds across all queries.
|
|
@@ -1936,6 +2256,9 @@ type LatencySummary = {
|
|
|
1936
2256
|
* Generated by Kubb (https://kubb.dev/).
|
|
1937
2257
|
* Do not edit manually.
|
|
1938
2258
|
*/
|
|
2259
|
+
/**
|
|
2260
|
+
* @description Aggregated analytics for a normalized SQL query shape.
|
|
2261
|
+
*/
|
|
1939
2262
|
type QueryInsight = {
|
|
1940
2263
|
/**
|
|
1941
2264
|
* @description xxhash64 of the normalized SQL pattern (hex).
|
|
@@ -1953,10 +2276,12 @@ type QueryInsight = {
|
|
|
1953
2276
|
*/
|
|
1954
2277
|
total_count: number;
|
|
1955
2278
|
/**
|
|
2279
|
+
* @description Total cache hits attributed to the query shape.
|
|
1956
2280
|
* @type integer, int64
|
|
1957
2281
|
*/
|
|
1958
2282
|
total_cache_hits: number;
|
|
1959
2283
|
/**
|
|
2284
|
+
* @description Total cache misses attributed to the query shape.
|
|
1960
2285
|
* @type integer, int64
|
|
1961
2286
|
*/
|
|
1962
2287
|
total_cache_misses: number;
|
|
@@ -1977,16 +2302,22 @@ type QueryInsight = {
|
|
|
1977
2302
|
* Do not edit manually.
|
|
1978
2303
|
*/
|
|
1979
2304
|
|
|
2305
|
+
/**
|
|
2306
|
+
* @description Query insights, cache performance, and latency for a project.
|
|
2307
|
+
*/
|
|
1980
2308
|
type ProjectInsights = {
|
|
1981
2309
|
/**
|
|
2310
|
+
* @description Top query shapes observed for the project.
|
|
1982
2311
|
* @type array
|
|
1983
2312
|
*/
|
|
1984
2313
|
queries: QueryInsight[];
|
|
1985
2314
|
/**
|
|
2315
|
+
* @description Aggregate cache performance metrics for the selected time range.
|
|
1986
2316
|
* @type object
|
|
1987
2317
|
*/
|
|
1988
2318
|
cache: CacheSummary;
|
|
1989
2319
|
/**
|
|
2320
|
+
* @description Aggregate latency metrics for the selected time range.
|
|
1990
2321
|
* @type object
|
|
1991
2322
|
*/
|
|
1992
2323
|
latency: LatencySummary;
|
|
@@ -2032,6 +2363,10 @@ type GetProjectInsightsQueryParams = {
|
|
|
2032
2363
|
* @description Query insights for the project.
|
|
2033
2364
|
*/
|
|
2034
2365
|
type GetProjectInsights200 = ProjectInsights;
|
|
2366
|
+
/**
|
|
2367
|
+
* @description Invalid request parameters.
|
|
2368
|
+
*/
|
|
2369
|
+
type GetProjectInsights400 = Error$1;
|
|
2035
2370
|
/**
|
|
2036
2371
|
* @description Missing or invalid authentication.
|
|
2037
2372
|
*/
|
|
@@ -2045,13 +2380,16 @@ type GetProjectInsightsQuery = {
|
|
|
2045
2380
|
Response: GetProjectInsights200;
|
|
2046
2381
|
PathParams: GetProjectInsightsPathParams;
|
|
2047
2382
|
QueryParams: GetProjectInsightsQueryParams;
|
|
2048
|
-
Errors: GetProjectInsights401 | GetProjectInsights404;
|
|
2383
|
+
Errors: GetProjectInsights400 | GetProjectInsights401 | GetProjectInsights404;
|
|
2049
2384
|
};
|
|
2050
2385
|
|
|
2051
2386
|
/**
|
|
2052
2387
|
* Generated by Kubb (https://kubb.dev/).
|
|
2053
2388
|
* Do not edit manually.
|
|
2054
2389
|
*/
|
|
2390
|
+
/**
|
|
2391
|
+
* @description Progress state for the dashboard onboarding checklist.
|
|
2392
|
+
*/
|
|
2055
2393
|
type OnboardingProgress = {
|
|
2056
2394
|
/**
|
|
2057
2395
|
* @description Organization ID this onboarding belongs to.
|
|
@@ -2110,9 +2448,9 @@ type OnboardingProgress = {
|
|
|
2110
2448
|
steps_total: number;
|
|
2111
2449
|
/**
|
|
2112
2450
|
* @description When onboarding was completed. Null if not yet completed.
|
|
2113
|
-
* @type string
|
|
2451
|
+
* @type string, date-time
|
|
2114
2452
|
*/
|
|
2115
|
-
completed_at?: string;
|
|
2453
|
+
completed_at?: string | null;
|
|
2116
2454
|
};
|
|
2117
2455
|
|
|
2118
2456
|
/**
|
|
@@ -2122,8 +2460,8 @@ type OnboardingProgress = {
|
|
|
2122
2460
|
|
|
2123
2461
|
type GetOnboardingProgressPathParams = {
|
|
2124
2462
|
/**
|
|
2125
|
-
* @description
|
|
2126
|
-
* @pattern ^[
|
|
2463
|
+
* @description Unique organization identifier.
|
|
2464
|
+
* @pattern ^[a-zA-Z0-9_.-]+$
|
|
2127
2465
|
* @type string
|
|
2128
2466
|
*/
|
|
2129
2467
|
org_id: string;
|
|
@@ -2132,6 +2470,10 @@ type GetOnboardingProgressPathParams = {
|
|
|
2132
2470
|
* @description Onboarding progress.
|
|
2133
2471
|
*/
|
|
2134
2472
|
type GetOnboardingProgress200 = OnboardingProgress;
|
|
2473
|
+
/**
|
|
2474
|
+
* @description Invalid request parameters.
|
|
2475
|
+
*/
|
|
2476
|
+
type GetOnboardingProgress400 = Error$1;
|
|
2135
2477
|
/**
|
|
2136
2478
|
* @description Missing or invalid authentication.
|
|
2137
2479
|
*/
|
|
@@ -2148,7 +2490,7 @@ type GetOnboardingProgressQueryResponse = GetOnboardingProgress200;
|
|
|
2148
2490
|
type GetOnboardingProgressQuery = {
|
|
2149
2491
|
Response: GetOnboardingProgress200;
|
|
2150
2492
|
PathParams: GetOnboardingProgressPathParams;
|
|
2151
|
-
Errors: GetOnboardingProgress401 | GetOnboardingProgress403 | GetOnboardingProgress404;
|
|
2493
|
+
Errors: GetOnboardingProgress400 | GetOnboardingProgress401 | GetOnboardingProgress403 | GetOnboardingProgress404;
|
|
2152
2494
|
};
|
|
2153
2495
|
|
|
2154
2496
|
/**
|
|
@@ -2163,6 +2505,9 @@ declare const updateOnboardingRequestStepEnum: {
|
|
|
2163
2505
|
readonly first_query_run: "first_query_run";
|
|
2164
2506
|
};
|
|
2165
2507
|
type UpdateOnboardingRequestStepEnumKey = (typeof updateOnboardingRequestStepEnum)[keyof typeof updateOnboardingRequestStepEnum];
|
|
2508
|
+
/**
|
|
2509
|
+
* @description Request body for advancing or dismissing onboarding.
|
|
2510
|
+
*/
|
|
2166
2511
|
type UpdateOnboardingRequest = {
|
|
2167
2512
|
/**
|
|
2168
2513
|
* @description The onboarding step to mark as complete.
|
|
@@ -2183,8 +2528,8 @@ type UpdateOnboardingRequest = {
|
|
|
2183
2528
|
|
|
2184
2529
|
type UpdateOnboardingProgressPathParams = {
|
|
2185
2530
|
/**
|
|
2186
|
-
* @description
|
|
2187
|
-
* @pattern ^[
|
|
2531
|
+
* @description Unique organization identifier.
|
|
2532
|
+
* @pattern ^[a-zA-Z0-9_.-]+$
|
|
2188
2533
|
* @type string
|
|
2189
2534
|
*/
|
|
2190
2535
|
org_id: string;
|
|
@@ -2238,6 +2583,9 @@ type ProjectStatus = ProjectStatusEnumKey;
|
|
|
2238
2583
|
* Do not edit manually.
|
|
2239
2584
|
*/
|
|
2240
2585
|
|
|
2586
|
+
/**
|
|
2587
|
+
* @description Project configuration and current control-plane state.
|
|
2588
|
+
*/
|
|
2241
2589
|
type Project = {
|
|
2242
2590
|
/**
|
|
2243
2591
|
* @description Unique project identifier (prefixed).
|
|
@@ -2263,6 +2611,7 @@ type Project = {
|
|
|
2263
2611
|
*/
|
|
2264
2612
|
description?: string;
|
|
2265
2613
|
/**
|
|
2614
|
+
* @description User-defined labels applied to the project.
|
|
2266
2615
|
* @type array | undefined
|
|
2267
2616
|
*/
|
|
2268
2617
|
tags?: string[];
|
|
@@ -2308,10 +2657,12 @@ type Project = {
|
|
|
2308
2657
|
*/
|
|
2309
2658
|
status: ProjectStatus;
|
|
2310
2659
|
/**
|
|
2660
|
+
* @description When the project was created.
|
|
2311
2661
|
* @type string, date-time
|
|
2312
2662
|
*/
|
|
2313
2663
|
created_at: string;
|
|
2314
2664
|
/**
|
|
2665
|
+
* @description When the project was last updated.
|
|
2315
2666
|
* @type string, date-time
|
|
2316
2667
|
*/
|
|
2317
2668
|
updated_at: string;
|
|
@@ -2322,8 +2673,12 @@ type Project = {
|
|
|
2322
2673
|
* Do not edit manually.
|
|
2323
2674
|
*/
|
|
2324
2675
|
|
|
2676
|
+
/**
|
|
2677
|
+
* @description Cursor-paginated list of projects for an organization.
|
|
2678
|
+
*/
|
|
2325
2679
|
type ListProjectsResponse = {
|
|
2326
2680
|
/**
|
|
2681
|
+
* @description Projects on the current page.
|
|
2327
2682
|
* @type array
|
|
2328
2683
|
*/
|
|
2329
2684
|
projects: Project[];
|
|
@@ -2406,6 +2761,9 @@ type ListProjectsQuery = {
|
|
|
2406
2761
|
* Do not edit manually.
|
|
2407
2762
|
*/
|
|
2408
2763
|
|
|
2764
|
+
/**
|
|
2765
|
+
* @description Request body for creating a project and its primary database.
|
|
2766
|
+
*/
|
|
2409
2767
|
type CreateProjectRequest = {
|
|
2410
2768
|
/**
|
|
2411
2769
|
* @description Human-readable project name.
|
|
@@ -2417,21 +2775,24 @@ type CreateProjectRequest = {
|
|
|
2417
2775
|
name: string;
|
|
2418
2776
|
/**
|
|
2419
2777
|
* @description Better Auth organization ID.
|
|
2420
|
-
* @
|
|
2778
|
+
* @minLength 1
|
|
2779
|
+
* @pattern ^[^\x00]+$
|
|
2421
2780
|
* @type string
|
|
2422
2781
|
*/
|
|
2423
2782
|
org_id: string;
|
|
2424
2783
|
/**
|
|
2784
|
+
* @description Optional project description.
|
|
2425
2785
|
* @maxLength 500
|
|
2426
2786
|
* @type string | undefined
|
|
2427
2787
|
*/
|
|
2428
2788
|
description?: string;
|
|
2429
2789
|
/**
|
|
2790
|
+
* @description User-defined labels to attach to the project.
|
|
2430
2791
|
* @type array | undefined
|
|
2431
2792
|
*/
|
|
2432
2793
|
tags?: string[];
|
|
2433
2794
|
/**
|
|
2434
|
-
* @description
|
|
2795
|
+
* @description Request body for registering an upstream database.
|
|
2435
2796
|
* @type object
|
|
2436
2797
|
*/
|
|
2437
2798
|
database: CreateDatabaseRequest;
|
|
@@ -2442,12 +2803,17 @@ type CreateProjectRequest = {
|
|
|
2442
2803
|
* Do not edit manually.
|
|
2443
2804
|
*/
|
|
2444
2805
|
|
|
2806
|
+
/**
|
|
2807
|
+
* @description Response returned after creating a project and its primary database.
|
|
2808
|
+
*/
|
|
2445
2809
|
type CreateProjectResponse = {
|
|
2446
2810
|
/**
|
|
2811
|
+
* @description Project configuration and current control-plane state.
|
|
2447
2812
|
* @type object
|
|
2448
2813
|
*/
|
|
2449
2814
|
project: Project;
|
|
2450
2815
|
/**
|
|
2816
|
+
* @description Registered upstream PostgreSQL database for a project.
|
|
2451
2817
|
* @type object | undefined
|
|
2452
2818
|
*/
|
|
2453
2819
|
database?: Database;
|
|
@@ -2531,6 +2897,9 @@ type GetProjectQuery = {
|
|
|
2531
2897
|
* Do not edit manually.
|
|
2532
2898
|
*/
|
|
2533
2899
|
|
|
2900
|
+
/**
|
|
2901
|
+
* @description Request body for partially updating a project.
|
|
2902
|
+
*/
|
|
2534
2903
|
type UpdateProjectRequest = {
|
|
2535
2904
|
/**
|
|
2536
2905
|
* @description Updated project name.
|
|
@@ -2541,11 +2910,13 @@ type UpdateProjectRequest = {
|
|
|
2541
2910
|
*/
|
|
2542
2911
|
name?: string;
|
|
2543
2912
|
/**
|
|
2913
|
+
* @description Updated project description.
|
|
2544
2914
|
* @maxLength 500
|
|
2545
2915
|
* @type string | undefined
|
|
2546
2916
|
*/
|
|
2547
2917
|
description?: string;
|
|
2548
2918
|
/**
|
|
2919
|
+
* @description Replacement set of user-defined project labels.
|
|
2549
2920
|
* @type array | undefined
|
|
2550
2921
|
*/
|
|
2551
2922
|
tags?: string[];
|
|
@@ -2663,40 +3034,52 @@ type DeleteProjectMutation = {
|
|
|
2663
3034
|
* Generated by Kubb (https://kubb.dev/).
|
|
2664
3035
|
* Do not edit manually.
|
|
2665
3036
|
*/
|
|
3037
|
+
/**
|
|
3038
|
+
* @description Aggregated project metrics captured for a point in time.
|
|
3039
|
+
*/
|
|
2666
3040
|
type MetricsSnapshot = {
|
|
2667
3041
|
/**
|
|
3042
|
+
* @description Unique metrics snapshot identifier.
|
|
2668
3043
|
* @type string
|
|
2669
3044
|
*/
|
|
2670
3045
|
id: string;
|
|
2671
3046
|
/**
|
|
3047
|
+
* @description Project that produced the metrics snapshot.
|
|
2672
3048
|
* @type string
|
|
2673
3049
|
*/
|
|
2674
3050
|
project_id: string;
|
|
2675
3051
|
/**
|
|
3052
|
+
* @description Region where the traffic was served.
|
|
2676
3053
|
* @type string
|
|
2677
3054
|
*/
|
|
2678
3055
|
region: string;
|
|
2679
3056
|
/**
|
|
3057
|
+
* @description Total queries served during the snapshot interval.
|
|
2680
3058
|
* @type integer, int64
|
|
2681
3059
|
*/
|
|
2682
3060
|
queries_total: number;
|
|
2683
3061
|
/**
|
|
3062
|
+
* @description Number of queries served from cache.
|
|
2684
3063
|
* @type integer, int64
|
|
2685
3064
|
*/
|
|
2686
3065
|
cache_hits: number;
|
|
2687
3066
|
/**
|
|
3067
|
+
* @description Number of queries forwarded upstream.
|
|
2688
3068
|
* @type integer, int64
|
|
2689
3069
|
*/
|
|
2690
3070
|
cache_misses: number;
|
|
2691
3071
|
/**
|
|
3072
|
+
* @description Current active proxy connections.
|
|
2692
3073
|
* @type integer
|
|
2693
3074
|
*/
|
|
2694
3075
|
active_connections: number;
|
|
2695
3076
|
/**
|
|
3077
|
+
* @description Average end-to-end query latency in milliseconds.
|
|
2696
3078
|
* @type number, double
|
|
2697
3079
|
*/
|
|
2698
3080
|
avg_latency_ms: number;
|
|
2699
3081
|
/**
|
|
3082
|
+
* @description 99th percentile end-to-end query latency in milliseconds.
|
|
2700
3083
|
* @type number, double
|
|
2701
3084
|
*/
|
|
2702
3085
|
p99_latency_ms: number;
|
|
@@ -2711,11 +3094,28 @@ type MetricsSnapshot = {
|
|
|
2711
3094
|
*/
|
|
2712
3095
|
avg_query_ms?: number;
|
|
2713
3096
|
/**
|
|
3097
|
+
* @description When the snapshot was recorded.
|
|
2714
3098
|
* @type string, date-time
|
|
2715
3099
|
*/
|
|
2716
3100
|
created_at: string;
|
|
2717
3101
|
};
|
|
2718
3102
|
|
|
3103
|
+
/**
|
|
3104
|
+
* Generated by Kubb (https://kubb.dev/).
|
|
3105
|
+
* Do not edit manually.
|
|
3106
|
+
*/
|
|
3107
|
+
|
|
3108
|
+
/**
|
|
3109
|
+
* @description Response envelope for recent project metrics snapshots.
|
|
3110
|
+
*/
|
|
3111
|
+
type ProjectMetricsResponse = {
|
|
3112
|
+
/**
|
|
3113
|
+
* @description Metrics snapshots ordered from newest to oldest.
|
|
3114
|
+
* @type array
|
|
3115
|
+
*/
|
|
3116
|
+
snapshots: MetricsSnapshot[];
|
|
3117
|
+
};
|
|
3118
|
+
|
|
2719
3119
|
/**
|
|
2720
3120
|
* Generated by Kubb (https://kubb.dev/).
|
|
2721
3121
|
* Do not edit manually.
|
|
@@ -2731,6 +3131,7 @@ type GetProjectMetricsPathParams = {
|
|
|
2731
3131
|
};
|
|
2732
3132
|
type GetProjectMetricsQueryParams = {
|
|
2733
3133
|
/**
|
|
3134
|
+
* @description Maximum number of recent snapshots to return.
|
|
2734
3135
|
* @minLength 1
|
|
2735
3136
|
* @maxLength 1000
|
|
2736
3137
|
* @default 60
|
|
@@ -2746,12 +3147,7 @@ type GetProjectMetricsQueryParams = {
|
|
|
2746
3147
|
/**
|
|
2747
3148
|
* @description Metrics snapshots
|
|
2748
3149
|
*/
|
|
2749
|
-
type GetProjectMetrics200 =
|
|
2750
|
-
/**
|
|
2751
|
-
* @type array
|
|
2752
|
-
*/
|
|
2753
|
-
snapshots: MetricsSnapshot[];
|
|
2754
|
-
};
|
|
3150
|
+
type GetProjectMetrics200 = ProjectMetricsResponse;
|
|
2755
3151
|
/**
|
|
2756
3152
|
* @description Invalid request parameters.
|
|
2757
3153
|
*/
|
|
@@ -2782,6 +3178,9 @@ declare const regionStatusEnum: {
|
|
|
2782
3178
|
readonly inactive: "inactive";
|
|
2783
3179
|
};
|
|
2784
3180
|
type RegionStatusEnumKey = (typeof regionStatusEnum)[keyof typeof regionStatusEnum];
|
|
3181
|
+
/**
|
|
3182
|
+
* @description Data plane region available for PgBeam traffic.
|
|
3183
|
+
*/
|
|
2785
3184
|
type Region = {
|
|
2786
3185
|
/**
|
|
2787
3186
|
* @description Region identifier (e.g. us-east-1).
|
|
@@ -2804,14 +3203,17 @@ type Region = {
|
|
|
2804
3203
|
*/
|
|
2805
3204
|
status: RegionStatusEnumKey;
|
|
2806
3205
|
/**
|
|
3206
|
+
* @description Whether new projects can currently be assigned to the region.
|
|
2807
3207
|
* @type boolean
|
|
2808
3208
|
*/
|
|
2809
3209
|
available: boolean;
|
|
2810
3210
|
/**
|
|
3211
|
+
* @description Continent where the region is located.
|
|
2811
3212
|
* @type string | undefined
|
|
2812
3213
|
*/
|
|
2813
3214
|
continent?: string;
|
|
2814
3215
|
/**
|
|
3216
|
+
* @description Country where the region is located.
|
|
2815
3217
|
* @type string | undefined
|
|
2816
3218
|
*/
|
|
2817
3219
|
country?: string;
|
|
@@ -2822,8 +3224,12 @@ type Region = {
|
|
|
2822
3224
|
* Do not edit manually.
|
|
2823
3225
|
*/
|
|
2824
3226
|
|
|
3227
|
+
/**
|
|
3228
|
+
* @description Response envelope for available region queries.
|
|
3229
|
+
*/
|
|
2825
3230
|
type ListRegionsResponse = {
|
|
2826
3231
|
/**
|
|
3232
|
+
* @description Regions currently known to the control plane.
|
|
2827
3233
|
* @type array
|
|
2828
3234
|
*/
|
|
2829
3235
|
regions: Region[];
|
|
@@ -2853,6 +3259,9 @@ type ListRegionsQuery = {
|
|
|
2853
3259
|
* Do not edit manually.
|
|
2854
3260
|
*/
|
|
2855
3261
|
|
|
3262
|
+
/**
|
|
3263
|
+
* @description Read replica registered for a primary database.
|
|
3264
|
+
*/
|
|
2856
3265
|
type Replica = {
|
|
2857
3266
|
/**
|
|
2858
3267
|
* @description Unique replica identifier (prefixed).
|
|
@@ -2882,10 +3291,12 @@ type Replica = {
|
|
|
2882
3291
|
*/
|
|
2883
3292
|
ssl_mode: SSLMode;
|
|
2884
3293
|
/**
|
|
3294
|
+
* @description When the replica was created.
|
|
2885
3295
|
* @type string, date-time
|
|
2886
3296
|
*/
|
|
2887
3297
|
created_at: string;
|
|
2888
3298
|
/**
|
|
3299
|
+
* @description When the replica was last updated.
|
|
2889
3300
|
* @type string, date-time
|
|
2890
3301
|
*/
|
|
2891
3302
|
updated_at: string;
|
|
@@ -2896,8 +3307,12 @@ type Replica = {
|
|
|
2896
3307
|
* Do not edit manually.
|
|
2897
3308
|
*/
|
|
2898
3309
|
|
|
3310
|
+
/**
|
|
3311
|
+
* @description Response envelope for listing registered replicas.
|
|
3312
|
+
*/
|
|
2899
3313
|
type ListReplicasResponse = {
|
|
2900
3314
|
/**
|
|
3315
|
+
* @description Read replicas attached to the database.
|
|
2901
3316
|
* @type array
|
|
2902
3317
|
*/
|
|
2903
3318
|
replicas: Replica[];
|
|
@@ -2948,6 +3363,9 @@ type ListReplicasQuery = {
|
|
|
2948
3363
|
* Do not edit manually.
|
|
2949
3364
|
*/
|
|
2950
3365
|
|
|
3366
|
+
/**
|
|
3367
|
+
* @description Request body for adding a read replica to a database.
|
|
3368
|
+
*/
|
|
2951
3369
|
type CreateReplicaRequest = {
|
|
2952
3370
|
/**
|
|
2953
3371
|
* @description PostgreSQL replica host.
|
|
@@ -3062,24 +3480,32 @@ type DeleteReplicaMutation = {
|
|
|
3062
3480
|
* Generated by Kubb (https://kubb.dev/).
|
|
3063
3481
|
* Do not edit manually.
|
|
3064
3482
|
*/
|
|
3483
|
+
/**
|
|
3484
|
+
* @description Daily usage totals aggregated across all projects in an organization.
|
|
3485
|
+
*/
|
|
3065
3486
|
type DailyUsage = {
|
|
3066
3487
|
/**
|
|
3488
|
+
* @description Usage date in UTC.
|
|
3067
3489
|
* @type string, date
|
|
3068
3490
|
*/
|
|
3069
3491
|
day: string;
|
|
3070
3492
|
/**
|
|
3493
|
+
* @description Total queries served on the day.
|
|
3071
3494
|
* @type integer, int64
|
|
3072
3495
|
*/
|
|
3073
3496
|
queries_total: number;
|
|
3074
3497
|
/**
|
|
3498
|
+
* @description Total cache hits on the day.
|
|
3075
3499
|
* @type integer, int64
|
|
3076
3500
|
*/
|
|
3077
3501
|
cache_hits: number;
|
|
3078
3502
|
/**
|
|
3503
|
+
* @description Total cache misses on the day.
|
|
3079
3504
|
* @type integer, int64
|
|
3080
3505
|
*/
|
|
3081
3506
|
cache_misses: number;
|
|
3082
3507
|
/**
|
|
3508
|
+
* @description Total proxy connection time consumed on the day.
|
|
3083
3509
|
* @type integer, int64
|
|
3084
3510
|
*/
|
|
3085
3511
|
connection_seconds: number;
|
|
@@ -3095,8 +3521,12 @@ type DailyUsage = {
|
|
|
3095
3521
|
* Do not edit manually.
|
|
3096
3522
|
*/
|
|
3097
3523
|
|
|
3524
|
+
/**
|
|
3525
|
+
* @description Response envelope for organization usage queries.
|
|
3526
|
+
*/
|
|
3098
3527
|
type UsageResponse = {
|
|
3099
3528
|
/**
|
|
3529
|
+
* @description Daily usage entries aggregated across the organization.
|
|
3100
3530
|
* @type array
|
|
3101
3531
|
*/
|
|
3102
3532
|
usage: DailyUsage[];
|
|
@@ -3109,6 +3539,8 @@ type UsageResponse = {
|
|
|
3109
3539
|
|
|
3110
3540
|
type GetOrganizationUsagePathParams = {
|
|
3111
3541
|
/**
|
|
3542
|
+
* @description Unique organization identifier.
|
|
3543
|
+
* @pattern ^[a-zA-Z0-9_.-]+$
|
|
3112
3544
|
* @type string
|
|
3113
3545
|
*/
|
|
3114
3546
|
org_id: string;
|
|
@@ -3129,44 +3561,61 @@ type GetOrganizationUsageQueryParams = {
|
|
|
3129
3561
|
* @description Daily usage data.
|
|
3130
3562
|
*/
|
|
3131
3563
|
type GetOrganizationUsage200 = UsageResponse;
|
|
3564
|
+
/**
|
|
3565
|
+
* @description Invalid request parameters.
|
|
3566
|
+
*/
|
|
3567
|
+
type GetOrganizationUsage400 = Error$1;
|
|
3132
3568
|
/**
|
|
3133
3569
|
* @description Missing or invalid authentication.
|
|
3134
3570
|
*/
|
|
3135
3571
|
type GetOrganizationUsage401 = Error$1;
|
|
3572
|
+
/**
|
|
3573
|
+
* @description Operation not allowed by current plan limits.
|
|
3574
|
+
*/
|
|
3575
|
+
type GetOrganizationUsage403 = Error$1;
|
|
3136
3576
|
type GetOrganizationUsageQueryResponse = GetOrganizationUsage200;
|
|
3137
3577
|
type GetOrganizationUsageQuery = {
|
|
3138
3578
|
Response: GetOrganizationUsage200;
|
|
3139
3579
|
PathParams: GetOrganizationUsagePathParams;
|
|
3140
3580
|
QueryParams: GetOrganizationUsageQueryParams;
|
|
3141
|
-
Errors: GetOrganizationUsage401;
|
|
3581
|
+
Errors: GetOrganizationUsage400 | GetOrganizationUsage401 | GetOrganizationUsage403;
|
|
3142
3582
|
};
|
|
3143
3583
|
|
|
3144
3584
|
/**
|
|
3145
3585
|
* Generated by Kubb (https://kubb.dev/).
|
|
3146
3586
|
* Do not edit manually.
|
|
3147
3587
|
*/
|
|
3588
|
+
/**
|
|
3589
|
+
* @description Daily usage totals for a single project and region.
|
|
3590
|
+
*/
|
|
3148
3591
|
type ProjectDailyUsage = {
|
|
3149
3592
|
/**
|
|
3593
|
+
* @description Usage date in UTC.
|
|
3150
3594
|
* @type string, date
|
|
3151
3595
|
*/
|
|
3152
3596
|
day: string;
|
|
3153
3597
|
/**
|
|
3598
|
+
* @description Region where the traffic was served.
|
|
3154
3599
|
* @type string
|
|
3155
3600
|
*/
|
|
3156
3601
|
region: string;
|
|
3157
3602
|
/**
|
|
3603
|
+
* @description Total queries served on the day.
|
|
3158
3604
|
* @type integer, int64
|
|
3159
3605
|
*/
|
|
3160
3606
|
queries_total: number;
|
|
3161
3607
|
/**
|
|
3608
|
+
* @description Total cache hits on the day.
|
|
3162
3609
|
* @type integer, int64
|
|
3163
3610
|
*/
|
|
3164
3611
|
cache_hits: number;
|
|
3165
3612
|
/**
|
|
3613
|
+
* @description Total cache misses on the day.
|
|
3166
3614
|
* @type integer, int64
|
|
3167
3615
|
*/
|
|
3168
3616
|
cache_misses: number;
|
|
3169
3617
|
/**
|
|
3618
|
+
* @description Total proxy connection time consumed on the day.
|
|
3170
3619
|
* @type integer, int64
|
|
3171
3620
|
*/
|
|
3172
3621
|
connection_seconds: number;
|
|
@@ -3182,8 +3631,12 @@ type ProjectDailyUsage = {
|
|
|
3182
3631
|
* Do not edit manually.
|
|
3183
3632
|
*/
|
|
3184
3633
|
|
|
3634
|
+
/**
|
|
3635
|
+
* @description Response envelope for project usage queries.
|
|
3636
|
+
*/
|
|
3185
3637
|
type ProjectUsageResponse = {
|
|
3186
3638
|
/**
|
|
3639
|
+
* @description Daily usage entries grouped by region for the project.
|
|
3187
3640
|
* @type array
|
|
3188
3641
|
*/
|
|
3189
3642
|
usage: ProjectDailyUsage[];
|
|
@@ -3218,6 +3671,10 @@ type GetProjectUsageQueryParams = {
|
|
|
3218
3671
|
* @description Daily usage data by region.
|
|
3219
3672
|
*/
|
|
3220
3673
|
type GetProjectUsage200 = ProjectUsageResponse;
|
|
3674
|
+
/**
|
|
3675
|
+
* @description Invalid request parameters.
|
|
3676
|
+
*/
|
|
3677
|
+
type GetProjectUsage400 = Error$1;
|
|
3221
3678
|
/**
|
|
3222
3679
|
* @description Missing or invalid authentication.
|
|
3223
3680
|
*/
|
|
@@ -3231,94 +3688,7 @@ type GetProjectUsageQuery = {
|
|
|
3231
3688
|
Response: GetProjectUsage200;
|
|
3232
3689
|
PathParams: GetProjectUsagePathParams;
|
|
3233
3690
|
QueryParams: GetProjectUsageQueryParams;
|
|
3234
|
-
Errors: GetProjectUsage401 | GetProjectUsage404;
|
|
3235
|
-
};
|
|
3236
|
-
|
|
3237
|
-
/**
|
|
3238
|
-
* Generated by Kubb (https://kubb.dev/).
|
|
3239
|
-
* Do not edit manually.
|
|
3240
|
-
*/
|
|
3241
|
-
type JoinWaitlistRequest = {
|
|
3242
|
-
/**
|
|
3243
|
-
* @type string, email
|
|
3244
|
-
*/
|
|
3245
|
-
email: string;
|
|
3246
|
-
/**
|
|
3247
|
-
* @type string | undefined
|
|
3248
|
-
*/
|
|
3249
|
-
name?: string;
|
|
3250
|
-
/**
|
|
3251
|
-
* @type string | undefined
|
|
3252
|
-
*/
|
|
3253
|
-
company?: string;
|
|
3254
|
-
};
|
|
3255
|
-
|
|
3256
|
-
/**
|
|
3257
|
-
* Generated by Kubb (https://kubb.dev/).
|
|
3258
|
-
* Do not edit manually.
|
|
3259
|
-
*/
|
|
3260
|
-
type WaitlistEntry = {
|
|
3261
|
-
/**
|
|
3262
|
-
* @type string
|
|
3263
|
-
*/
|
|
3264
|
-
id: string;
|
|
3265
|
-
/**
|
|
3266
|
-
* @type string, email
|
|
3267
|
-
*/
|
|
3268
|
-
email: string;
|
|
3269
|
-
/**
|
|
3270
|
-
* @type string
|
|
3271
|
-
*/
|
|
3272
|
-
name: string;
|
|
3273
|
-
/**
|
|
3274
|
-
* @type string
|
|
3275
|
-
*/
|
|
3276
|
-
company: string;
|
|
3277
|
-
/**
|
|
3278
|
-
* @type boolean
|
|
3279
|
-
*/
|
|
3280
|
-
invited: boolean;
|
|
3281
|
-
/**
|
|
3282
|
-
* @type string, date-time
|
|
3283
|
-
*/
|
|
3284
|
-
created_at: string;
|
|
3285
|
-
/**
|
|
3286
|
-
* @type string | undefined, date-time
|
|
3287
|
-
*/
|
|
3288
|
-
invited_at?: string;
|
|
3289
|
-
};
|
|
3290
|
-
|
|
3291
|
-
/**
|
|
3292
|
-
* Generated by Kubb (https://kubb.dev/).
|
|
3293
|
-
* Do not edit manually.
|
|
3294
|
-
*/
|
|
3295
|
-
|
|
3296
|
-
type JoinWaitlistResponse = {
|
|
3297
|
-
/**
|
|
3298
|
-
* @type object
|
|
3299
|
-
*/
|
|
3300
|
-
entry: WaitlistEntry;
|
|
3301
|
-
};
|
|
3302
|
-
|
|
3303
|
-
/**
|
|
3304
|
-
* Generated by Kubb (https://kubb.dev/).
|
|
3305
|
-
* Do not edit manually.
|
|
3306
|
-
*/
|
|
3307
|
-
|
|
3308
|
-
/**
|
|
3309
|
-
* @description Successfully joined or already on the waitlist.
|
|
3310
|
-
*/
|
|
3311
|
-
type JoinWaitlist200 = JoinWaitlistResponse;
|
|
3312
|
-
/**
|
|
3313
|
-
* @description Invalid request parameters.
|
|
3314
|
-
*/
|
|
3315
|
-
type JoinWaitlist400 = Error$1;
|
|
3316
|
-
type JoinWaitlistMutationRequest = JoinWaitlistRequest;
|
|
3317
|
-
type JoinWaitlistMutationResponse = JoinWaitlist200;
|
|
3318
|
-
type JoinWaitlistMutation = {
|
|
3319
|
-
Response: JoinWaitlist200;
|
|
3320
|
-
Request: JoinWaitlistMutationRequest;
|
|
3321
|
-
Errors: JoinWaitlist400;
|
|
3691
|
+
Errors: GetProjectUsage400 | GetProjectUsage401 | GetProjectUsage404;
|
|
3322
3692
|
};
|
|
3323
3693
|
|
|
3324
3694
|
/**
|
|
@@ -3329,8 +3699,15 @@ type JoinWaitlistMutation = {
|
|
|
3329
3699
|
interface ApiOperations {
|
|
3330
3700
|
account: {
|
|
3331
3701
|
exportAccountData(): Promise<ExportAccountDataQueryResponse>;
|
|
3702
|
+
getOnboardingProgress(params: {
|
|
3703
|
+
pathParams: GetOnboardingProgressPathParams;
|
|
3704
|
+
}): Promise<GetOnboardingProgressQueryResponse>;
|
|
3705
|
+
updateOnboardingProgress(params: {
|
|
3706
|
+
pathParams: UpdateOnboardingProgressPathParams;
|
|
3707
|
+
body: UpdateOnboardingProgressMutationRequest;
|
|
3708
|
+
}): Promise<UpdateOnboardingProgressMutationResponse>;
|
|
3332
3709
|
};
|
|
3333
|
-
|
|
3710
|
+
analytics: {
|
|
3334
3711
|
getOrganizationActivity(params: {
|
|
3335
3712
|
pathParams: GetOrganizationActivityPathParams;
|
|
3336
3713
|
queryParams?: GetOrganizationActivityQueryParams;
|
|
@@ -3339,6 +3716,14 @@ interface ApiOperations {
|
|
|
3339
3716
|
getOrganizationPlan(params: {
|
|
3340
3717
|
pathParams: GetOrganizationPlanPathParams;
|
|
3341
3718
|
}): Promise<GetOrganizationPlanQueryResponse>;
|
|
3719
|
+
updateSpendLimit(params: {
|
|
3720
|
+
pathParams: UpdateSpendLimitPathParams;
|
|
3721
|
+
body: UpdateSpendLimitMutationRequest;
|
|
3722
|
+
}): Promise<UpdateSpendLimitMutationResponse>;
|
|
3723
|
+
submitCancellationFeedback(params: {
|
|
3724
|
+
pathParams: SubmitCancellationFeedbackPathParams;
|
|
3725
|
+
body: SubmitCancellationFeedbackMutationRequest;
|
|
3726
|
+
}): Promise<void>;
|
|
3342
3727
|
getProjectInsights(params: {
|
|
3343
3728
|
pathParams: GetProjectInsightsPathParams;
|
|
3344
3729
|
queryParams?: GetProjectInsightsQueryParams;
|
|
@@ -3352,40 +3737,15 @@ interface ApiOperations {
|
|
|
3352
3737
|
queryParams: GetProjectUsageQueryParams;
|
|
3353
3738
|
}): Promise<GetProjectUsageQueryResponse>;
|
|
3354
3739
|
};
|
|
3355
|
-
|
|
3356
|
-
|
|
3357
|
-
pathParams:
|
|
3358
|
-
queryParams?:
|
|
3359
|
-
}): Promise<
|
|
3740
|
+
projects: {
|
|
3741
|
+
listCacheRules(params: {
|
|
3742
|
+
pathParams: ListCacheRulesPathParams;
|
|
3743
|
+
queryParams?: ListCacheRulesQueryParams;
|
|
3744
|
+
}): Promise<ListCacheRulesQueryResponse>;
|
|
3360
3745
|
updateCacheRule(params: {
|
|
3361
3746
|
pathParams: UpdateCacheRulePathParams;
|
|
3362
3747
|
body: UpdateCacheRuleMutationRequest;
|
|
3363
3748
|
}): Promise<UpdateCacheRuleMutationResponse>;
|
|
3364
|
-
};
|
|
3365
|
-
databases: {
|
|
3366
|
-
listDatabases(params: {
|
|
3367
|
-
pathParams: ListDatabasesPathParams;
|
|
3368
|
-
queryParams?: ListDatabasesQueryParams;
|
|
3369
|
-
}): Promise<ListDatabasesQueryResponse>;
|
|
3370
|
-
createDatabase(params: {
|
|
3371
|
-
pathParams: CreateDatabasePathParams;
|
|
3372
|
-
body: CreateDatabaseMutationRequest;
|
|
3373
|
-
}): Promise<CreateDatabaseMutationResponse>;
|
|
3374
|
-
getDatabase(params: {
|
|
3375
|
-
pathParams: GetDatabasePathParams;
|
|
3376
|
-
}): Promise<GetDatabaseQueryResponse>;
|
|
3377
|
-
updateDatabase(params: {
|
|
3378
|
-
pathParams: UpdateDatabasePathParams;
|
|
3379
|
-
body: UpdateDatabaseMutationRequest;
|
|
3380
|
-
}): Promise<UpdateDatabaseMutationResponse>;
|
|
3381
|
-
deleteDatabase(params: {
|
|
3382
|
-
pathParams: DeleteDatabasePathParams;
|
|
3383
|
-
}): Promise<void>;
|
|
3384
|
-
testDatabaseConnection(params: {
|
|
3385
|
-
pathParams: TestDatabaseConnectionPathParams;
|
|
3386
|
-
}): Promise<TestDatabaseConnectionMutationResponse>;
|
|
3387
|
-
};
|
|
3388
|
-
domains: {
|
|
3389
3749
|
listCustomDomains(params: {
|
|
3390
3750
|
pathParams: ListCustomDomainsPathParams;
|
|
3391
3751
|
queryParams?: ListCustomDomainsQueryParams;
|
|
@@ -3400,20 +3760,6 @@ interface ApiOperations {
|
|
|
3400
3760
|
verifyCustomDomain(params: {
|
|
3401
3761
|
pathParams: VerifyCustomDomainPathParams;
|
|
3402
3762
|
}): Promise<VerifyCustomDomainMutationResponse>;
|
|
3403
|
-
};
|
|
3404
|
-
health: {
|
|
3405
|
-
getHealth(): Promise<GetHealthQueryResponse>;
|
|
3406
|
-
};
|
|
3407
|
-
onboarding: {
|
|
3408
|
-
getOnboardingProgress(params: {
|
|
3409
|
-
pathParams: GetOnboardingProgressPathParams;
|
|
3410
|
-
}): Promise<GetOnboardingProgressQueryResponse>;
|
|
3411
|
-
updateOnboardingProgress(params: {
|
|
3412
|
-
pathParams: UpdateOnboardingProgressPathParams;
|
|
3413
|
-
body: UpdateOnboardingProgressMutationRequest;
|
|
3414
|
-
}): Promise<UpdateOnboardingProgressMutationResponse>;
|
|
3415
|
-
};
|
|
3416
|
-
projects: {
|
|
3417
3763
|
listProjects(params: {
|
|
3418
3764
|
queryParams: ListProjectsQueryParams;
|
|
3419
3765
|
}): Promise<ListProjectsQueryResponse>;
|
|
@@ -3434,11 +3780,6 @@ interface ApiOperations {
|
|
|
3434
3780
|
pathParams: GetProjectMetricsPathParams;
|
|
3435
3781
|
queryParams?: GetProjectMetricsQueryParams;
|
|
3436
3782
|
}): Promise<GetProjectMetricsQueryResponse>;
|
|
3437
|
-
};
|
|
3438
|
-
regions: {
|
|
3439
|
-
listRegions(): Promise<ListRegionsQueryResponse>;
|
|
3440
|
-
};
|
|
3441
|
-
replicas: {
|
|
3442
3783
|
listReplicas(params: {
|
|
3443
3784
|
pathParams: ListReplicasPathParams;
|
|
3444
3785
|
}): Promise<ListReplicasQueryResponse>;
|
|
@@ -3450,10 +3791,32 @@ interface ApiOperations {
|
|
|
3450
3791
|
pathParams: DeleteReplicaPathParams;
|
|
3451
3792
|
}): Promise<void>;
|
|
3452
3793
|
};
|
|
3453
|
-
|
|
3454
|
-
|
|
3455
|
-
|
|
3456
|
-
|
|
3794
|
+
databases: {
|
|
3795
|
+
listDatabases(params: {
|
|
3796
|
+
pathParams: ListDatabasesPathParams;
|
|
3797
|
+
queryParams?: ListDatabasesQueryParams;
|
|
3798
|
+
}): Promise<ListDatabasesQueryResponse>;
|
|
3799
|
+
createDatabase(params: {
|
|
3800
|
+
pathParams: CreateDatabasePathParams;
|
|
3801
|
+
body: CreateDatabaseMutationRequest;
|
|
3802
|
+
}): Promise<CreateDatabaseMutationResponse>;
|
|
3803
|
+
getDatabase(params: {
|
|
3804
|
+
pathParams: GetDatabasePathParams;
|
|
3805
|
+
}): Promise<GetDatabaseQueryResponse>;
|
|
3806
|
+
updateDatabase(params: {
|
|
3807
|
+
pathParams: UpdateDatabasePathParams;
|
|
3808
|
+
body: UpdateDatabaseMutationRequest;
|
|
3809
|
+
}): Promise<UpdateDatabaseMutationResponse>;
|
|
3810
|
+
deleteDatabase(params: {
|
|
3811
|
+
pathParams: DeleteDatabasePathParams;
|
|
3812
|
+
}): Promise<void>;
|
|
3813
|
+
testDatabaseConnection(params: {
|
|
3814
|
+
pathParams: TestDatabaseConnectionPathParams;
|
|
3815
|
+
}): Promise<TestDatabaseConnectionMutationResponse>;
|
|
3816
|
+
};
|
|
3817
|
+
platform: {
|
|
3818
|
+
getHealth(): Promise<GetHealthQueryResponse>;
|
|
3819
|
+
listRegions(): Promise<ListRegionsQueryResponse>;
|
|
3457
3820
|
};
|
|
3458
3821
|
}
|
|
3459
3822
|
interface RequestMap {
|
|
@@ -3478,14 +3841,28 @@ interface RequestMap {
|
|
|
3478
3841
|
};
|
|
3479
3842
|
response: GetOrganizationPlanQueryResponse;
|
|
3480
3843
|
};
|
|
3481
|
-
"
|
|
3844
|
+
"PUT /v1/organizations/{org_id}/spend-limit": {
|
|
3845
|
+
params: {
|
|
3846
|
+
pathParams: UpdateSpendLimitPathParams;
|
|
3847
|
+
body: UpdateSpendLimitMutationRequest;
|
|
3848
|
+
};
|
|
3849
|
+
response: UpdateSpendLimitMutationResponse;
|
|
3850
|
+
};
|
|
3851
|
+
"POST /v1/organizations/{org_id}/cancellation-feedback": {
|
|
3852
|
+
params: {
|
|
3853
|
+
pathParams: SubmitCancellationFeedbackPathParams;
|
|
3854
|
+
body: SubmitCancellationFeedbackMutationRequest;
|
|
3855
|
+
};
|
|
3856
|
+
response: void;
|
|
3857
|
+
};
|
|
3858
|
+
"GET /v1/projects/{project_id}/databases/{database_id}/cache-rules": {
|
|
3482
3859
|
params: {
|
|
3483
|
-
pathParams:
|
|
3484
|
-
queryParams?:
|
|
3860
|
+
pathParams: ListCacheRulesPathParams;
|
|
3861
|
+
queryParams?: ListCacheRulesQueryParams;
|
|
3485
3862
|
};
|
|
3486
|
-
response:
|
|
3863
|
+
response: ListCacheRulesQueryResponse;
|
|
3487
3864
|
};
|
|
3488
|
-
"PUT /v1/projects/{project_id}/databases/{database_id}/
|
|
3865
|
+
"PUT /v1/projects/{project_id}/databases/{database_id}/cache-rules/{query_hash}": {
|
|
3489
3866
|
params: {
|
|
3490
3867
|
pathParams: UpdateCacheRulePathParams;
|
|
3491
3868
|
body: UpdateCacheRuleMutationRequest;
|
|
@@ -3656,12 +4033,6 @@ interface RequestMap {
|
|
|
3656
4033
|
};
|
|
3657
4034
|
response: GetProjectUsageQueryResponse;
|
|
3658
4035
|
};
|
|
3659
|
-
"POST /v1/waitlist": {
|
|
3660
|
-
params: {
|
|
3661
|
-
body: JoinWaitlistMutationRequest;
|
|
3662
|
-
};
|
|
3663
|
-
response: JoinWaitlistMutationResponse;
|
|
3664
|
-
};
|
|
3665
4036
|
}
|
|
3666
4037
|
type Route = keyof RequestMap;
|
|
3667
4038
|
|
|
@@ -3709,5 +4080,5 @@ declare class PgBeamClient {
|
|
|
3709
4080
|
get api(): ApiClient;
|
|
3710
4081
|
}
|
|
3711
4082
|
|
|
3712
|
-
export { ApiError, PgBeamClient, SSLModeEnum, databaseRoleEnum, extractMessage, getProjectInsightsQueryParamsRangeEnum, healthResponseStatusEnum, listProjectsQueryParamsSortByEnum, organizationPlanPlanEnum, organizationPlanSubscriptionStatusEnum, poolModeEnum, projectStatusEnum,
|
|
3713
|
-
export type { AccountExport, ActivityEntry, ActivityResponse, ApiClient, CacheConfig, CacheSummary, CreateCustomDomain201, CreateCustomDomain400, CreateCustomDomain401, CreateCustomDomain403, CreateCustomDomain404, CreateCustomDomain409, CreateCustomDomainMutation, CreateCustomDomainMutationRequest, CreateCustomDomainMutationResponse, CreateCustomDomainPathParams, CreateCustomDomainRequest, CreateDatabase201, CreateDatabase400, CreateDatabase401, CreateDatabase403, CreateDatabase404, CreateDatabaseMutation, CreateDatabaseMutationRequest, CreateDatabaseMutationResponse, CreateDatabasePathParams, CreateDatabaseRequest, CreateProject201, CreateProject400, CreateProject401, CreateProject403, CreateProject409, CreateProjectMutation, CreateProjectMutationRequest, CreateProjectMutationResponse, CreateProjectRequest, CreateProjectResponse, CreateReplica201, CreateReplica400, CreateReplica401, CreateReplica403, CreateReplica404, CreateReplicaMutation, CreateReplicaMutationRequest, CreateReplicaMutationResponse, CreateReplicaPathParams, CreateReplicaRequest, CustomDomain, DailyUsage, Database, DatabaseRole, DatabaseRoleEnumKey, DeleteCustomDomain204, DeleteCustomDomain400, DeleteCustomDomain401, DeleteCustomDomain403, DeleteCustomDomain404, DeleteCustomDomainMutation, DeleteCustomDomainMutationResponse, DeleteCustomDomainPathParams, DeleteDatabase204, DeleteDatabase400, DeleteDatabase401, DeleteDatabase403, DeleteDatabase404, DeleteDatabaseMutation, DeleteDatabaseMutationResponse, DeleteDatabasePathParams, DeleteProject204, DeleteProject400, DeleteProject401, DeleteProject403, DeleteProject404, DeleteProjectMutation, DeleteProjectMutationResponse, DeleteProjectPathParams, DeleteReplica204, DeleteReplica400, DeleteReplica401, DeleteReplica403, DeleteReplica404, DeleteReplicaMutation, DeleteReplicaMutationResponse, DeleteReplicaPathParams, Error$1 as Error, ExportAccountData200, ExportAccountData401, ExportAccountData429, ExportAccountDataQuery, ExportAccountDataQueryResponse, GetDatabase200, GetDatabase400, GetDatabase401, GetDatabase403, GetDatabase404, GetDatabasePathParams, GetDatabaseQuery, GetDatabaseQueryResponse, GetHealth200, GetHealth429, GetHealthQuery, GetHealthQueryResponse, GetOnboardingProgress200, GetOnboardingProgress401, GetOnboardingProgress403, GetOnboardingProgress404, GetOnboardingProgressPathParams, GetOnboardingProgressQuery, GetOnboardingProgressQueryResponse, GetOrganizationActivity200, GetOrganizationActivity401, GetOrganizationActivityPathParams, GetOrganizationActivityQuery, GetOrganizationActivityQueryParams, GetOrganizationActivityQueryResponse, GetOrganizationPlan200, GetOrganizationPlan401, GetOrganizationPlanPathParams, GetOrganizationPlanQuery, GetOrganizationPlanQueryResponse, GetOrganizationUsage200, GetOrganizationUsage401, GetOrganizationUsagePathParams, GetOrganizationUsageQuery, GetOrganizationUsageQueryParams, GetOrganizationUsageQueryResponse, GetProject200, GetProject400, GetProject401, GetProject403, GetProject404, GetProjectInsights200, GetProjectInsights401, GetProjectInsights404, GetProjectInsightsPathParams, GetProjectInsightsQuery, GetProjectInsightsQueryParams, GetProjectInsightsQueryParamsRangeEnumKey, GetProjectInsightsQueryResponse, GetProjectMetrics200, GetProjectMetrics400, GetProjectMetrics401, GetProjectMetrics404, GetProjectMetricsPathParams, GetProjectMetricsQuery, GetProjectMetricsQueryParams, GetProjectMetricsQueryResponse, GetProjectPathParams, GetProjectQuery, GetProjectQueryResponse, GetProjectUsage200, GetProjectUsage401, GetProjectUsage404, GetProjectUsagePathParams, GetProjectUsageQuery, GetProjectUsageQueryParams, GetProjectUsageQueryResponse, HealthResponse, HealthResponseStatusEnumKey,
|
|
4083
|
+
export { ApiError, PgBeamClient, SSLModeEnum, cacheRuleEntryQueryTypeEnum, cacheRuleEntryRecommendationEnum, databaseRoleEnum, extractMessage, getProjectInsightsQueryParamsRangeEnum, healthResponseStatusEnum, listProjectsQueryParamsSortByEnum, organizationPlanBillingProviderEnum, organizationPlanPlanEnum, organizationPlanSubscriptionStatusEnum, poolModeEnum, projectStatusEnum, regionStatusEnum, updateOnboardingRequestStepEnum };
|
|
4084
|
+
export type { AccountExport, ActivityEntry, ActivityResponse, ApiClient, CacheConfig, CacheRuleEntry, CacheRuleEntryQueryTypeEnumKey, CacheRuleEntryRecommendationEnumKey, CacheSummary, CancellationFeedbackRequest, CreateCustomDomain201, CreateCustomDomain400, CreateCustomDomain401, CreateCustomDomain403, CreateCustomDomain404, CreateCustomDomain409, CreateCustomDomainMutation, CreateCustomDomainMutationRequest, CreateCustomDomainMutationResponse, CreateCustomDomainPathParams, CreateCustomDomainRequest, CreateDatabase201, CreateDatabase400, CreateDatabase401, CreateDatabase403, CreateDatabase404, CreateDatabaseMutation, CreateDatabaseMutationRequest, CreateDatabaseMutationResponse, CreateDatabasePathParams, CreateDatabaseRequest, CreateProject201, CreateProject400, CreateProject401, CreateProject403, CreateProject409, CreateProjectMutation, CreateProjectMutationRequest, CreateProjectMutationResponse, CreateProjectRequest, CreateProjectResponse, CreateReplica201, CreateReplica400, CreateReplica401, CreateReplica403, CreateReplica404, CreateReplicaMutation, CreateReplicaMutationRequest, CreateReplicaMutationResponse, CreateReplicaPathParams, CreateReplicaRequest, CustomDomain, DailyUsage, Database, DatabaseRole, DatabaseRoleEnumKey, DeleteCustomDomain204, DeleteCustomDomain400, DeleteCustomDomain401, DeleteCustomDomain403, DeleteCustomDomain404, DeleteCustomDomainMutation, DeleteCustomDomainMutationResponse, DeleteCustomDomainPathParams, DeleteDatabase204, DeleteDatabase400, DeleteDatabase401, DeleteDatabase403, DeleteDatabase404, DeleteDatabaseMutation, DeleteDatabaseMutationResponse, DeleteDatabasePathParams, DeleteProject204, DeleteProject400, DeleteProject401, DeleteProject403, DeleteProject404, DeleteProjectMutation, DeleteProjectMutationResponse, DeleteProjectPathParams, DeleteReplica204, DeleteReplica400, DeleteReplica401, DeleteReplica403, DeleteReplica404, DeleteReplicaMutation, DeleteReplicaMutationResponse, DeleteReplicaPathParams, Error$1 as Error, ExportAccountData200, ExportAccountData401, ExportAccountData404, ExportAccountData429, ExportAccountDataQuery, ExportAccountDataQueryResponse, GetDatabase200, GetDatabase400, GetDatabase401, GetDatabase403, GetDatabase404, GetDatabasePathParams, GetDatabaseQuery, GetDatabaseQueryResponse, GetHealth200, GetHealth429, GetHealthQuery, GetHealthQueryResponse, GetOnboardingProgress200, GetOnboardingProgress400, GetOnboardingProgress401, GetOnboardingProgress403, GetOnboardingProgress404, GetOnboardingProgressPathParams, GetOnboardingProgressQuery, GetOnboardingProgressQueryResponse, GetOrganizationActivity200, GetOrganizationActivity400, GetOrganizationActivity401, GetOrganizationActivity403, GetOrganizationActivityPathParams, GetOrganizationActivityQuery, GetOrganizationActivityQueryParams, GetOrganizationActivityQueryResponse, GetOrganizationPlan200, GetOrganizationPlan400, GetOrganizationPlan401, GetOrganizationPlan403, GetOrganizationPlanPathParams, GetOrganizationPlanQuery, GetOrganizationPlanQueryResponse, GetOrganizationUsage200, GetOrganizationUsage400, GetOrganizationUsage401, GetOrganizationUsage403, GetOrganizationUsagePathParams, GetOrganizationUsageQuery, GetOrganizationUsageQueryParams, GetOrganizationUsageQueryResponse, GetProject200, GetProject400, GetProject401, GetProject403, GetProject404, GetProjectInsights200, GetProjectInsights400, GetProjectInsights401, GetProjectInsights404, GetProjectInsightsPathParams, GetProjectInsightsQuery, GetProjectInsightsQueryParams, GetProjectInsightsQueryParamsRangeEnumKey, GetProjectInsightsQueryResponse, GetProjectMetrics200, GetProjectMetrics400, GetProjectMetrics401, GetProjectMetrics404, GetProjectMetricsPathParams, GetProjectMetricsQuery, GetProjectMetricsQueryParams, GetProjectMetricsQueryResponse, GetProjectPathParams, GetProjectQuery, GetProjectQueryResponse, GetProjectUsage200, GetProjectUsage400, GetProjectUsage401, GetProjectUsage404, GetProjectUsagePathParams, GetProjectUsageQuery, GetProjectUsageQueryParams, GetProjectUsageQueryResponse, HealthResponse, HealthResponseStatusEnumKey, LatencySummary, ListCacheRules200, ListCacheRules400, ListCacheRules401, ListCacheRules403, ListCacheRules404, ListCacheRulesPathParams, ListCacheRulesQuery, ListCacheRulesQueryParams, ListCacheRulesQueryResponse, ListCacheRulesResponse, ListCustomDomains200, ListCustomDomains400, ListCustomDomains401, ListCustomDomains403, ListCustomDomains404, ListCustomDomainsPathParams, ListCustomDomainsQuery, ListCustomDomainsQueryParams, ListCustomDomainsQueryResponse, ListCustomDomainsResponse, ListDatabases200, ListDatabases400, ListDatabases401, ListDatabases403, ListDatabases404, ListDatabasesPathParams, ListDatabasesQuery, ListDatabasesQueryParams, ListDatabasesQueryResponse, ListDatabasesResponse, ListPlans200, ListPlans401, ListPlansQuery, ListPlansQueryResponse, ListPlansResponse, ListProjects200, ListProjects400, ListProjects401, ListProjects403, ListProjectsQuery, ListProjectsQueryParams, ListProjectsQueryParamsSortByEnumKey, ListProjectsQueryResponse, ListProjectsResponse, ListRegions200, ListRegions401, ListRegionsQuery, ListRegionsQueryResponse, ListRegionsResponse, ListReplicas200, ListReplicas400, ListReplicas401, ListReplicas403, ListReplicas404, ListReplicasPathParams, ListReplicasQuery, ListReplicasQueryResponse, ListReplicasResponse, MetricsSnapshot, OnboardingProgress, OrganizationPlan, OrganizationPlanBillingProviderEnumKey, OrganizationPlanPlanEnumKey, OrganizationPlanSubscriptionStatusEnumKey, PgBeamClientOptions, PlanInfo, PlanLimits, PoolConfig, PoolMode, PoolModeEnumKey, Project, ProjectDailyUsage, ProjectInsights, ProjectMetricsResponse, ProjectStatus, ProjectStatusEnumKey, ProjectUsageResponse, QueryInsight, Region, RegionStatusEnumKey, Replica, SSLMode, SSLModeEnumKey, SubmitCancellationFeedback204, SubmitCancellationFeedback400, SubmitCancellationFeedback401, SubmitCancellationFeedback403, SubmitCancellationFeedbackMutation, SubmitCancellationFeedbackMutationRequest, SubmitCancellationFeedbackMutationResponse, SubmitCancellationFeedbackPathParams, TestConnectionResult, TestDatabaseConnection200, TestDatabaseConnection400, TestDatabaseConnection401, TestDatabaseConnection403, TestDatabaseConnection404, TestDatabaseConnectionMutation, TestDatabaseConnectionMutationResponse, TestDatabaseConnectionPathParams, UpdateCacheRule200, UpdateCacheRule400, UpdateCacheRule401, UpdateCacheRule403, UpdateCacheRule404, UpdateCacheRuleMutation, UpdateCacheRuleMutationRequest, UpdateCacheRuleMutationResponse, UpdateCacheRulePathParams, UpdateCacheRuleRequest, UpdateCacheRuleResponse, UpdateDatabase200, UpdateDatabase400, UpdateDatabase401, UpdateDatabase403, UpdateDatabase404, UpdateDatabaseMutation, UpdateDatabaseMutationRequest, UpdateDatabaseMutationResponse, UpdateDatabasePathParams, UpdateDatabaseRequest, UpdateOnboardingProgress200, UpdateOnboardingProgress400, UpdateOnboardingProgress401, UpdateOnboardingProgress403, UpdateOnboardingProgress404, UpdateOnboardingProgressMutation, UpdateOnboardingProgressMutationRequest, UpdateOnboardingProgressMutationResponse, UpdateOnboardingProgressPathParams, UpdateOnboardingRequest, UpdateOnboardingRequestStepEnumKey, UpdateProject200, UpdateProject400, UpdateProject401, UpdateProject403, UpdateProject404, UpdateProjectMutation, UpdateProjectMutationRequest, UpdateProjectMutationResponse, UpdateProjectPathParams, UpdateProjectRequest, UpdateSpendLimit200, UpdateSpendLimit400, UpdateSpendLimit401, UpdateSpendLimit403, UpdateSpendLimitMutation, UpdateSpendLimitMutationRequest, UpdateSpendLimitMutationResponse, UpdateSpendLimitPathParams, UpdateSpendLimitRequest, UsageResponse, VerifyCustomDomain200, VerifyCustomDomain400, VerifyCustomDomain401, VerifyCustomDomain403, VerifyCustomDomain404, VerifyCustomDomainMutation, VerifyCustomDomainMutationResponse, VerifyCustomDomainPathParams, VerifyCustomDomainResponse };
|