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.
@@ -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 500
435
+ * @maxLength 1000
358
436
  * @default 100
359
437
  * @type integer | undefined
360
438
  */
@@ -369,22 +447,37 @@ 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;
462
+ /**
463
+ * @description Rate limited. Try again later.
464
+ */
465
+ type GetOrganizationActivity429 = Error$1;
376
466
  type GetOrganizationActivityQueryResponse = GetOrganizationActivity200;
377
467
  type GetOrganizationActivityQuery = {
378
468
  Response: GetOrganizationActivity200;
379
469
  PathParams: GetOrganizationActivityPathParams;
380
470
  QueryParams: GetOrganizationActivityQueryParams;
381
- Errors: GetOrganizationActivity401;
471
+ Errors: GetOrganizationActivity400 | GetOrganizationActivity401 | GetOrganizationActivity403 | GetOrganizationActivity429;
382
472
  };
383
473
 
384
474
  /**
385
475
  * Generated by Kubb (https://kubb.dev/).
386
476
  * Do not edit manually.
387
477
  */
478
+ /**
479
+ * @description Effective usage limits enforced for an organization plan.
480
+ */
388
481
  type PlanLimits = {
389
482
  /**
390
483
  * @description Maximum queries per day across all projects. 0 means unlimited.
@@ -416,6 +509,16 @@ type PlanLimits = {
416
509
  * @type integer, int64
417
510
  */
418
511
  bytes_per_month: number;
512
+ /**
513
+ * @description Maximum query shapes in cache rules. 0 means unlimited.
514
+ * @type integer
515
+ */
516
+ max_query_shapes: number;
517
+ /**
518
+ * @description Number of seats included in the plan.
519
+ * @type integer
520
+ */
521
+ included_seats: number;
419
522
  };
420
523
 
421
524
  /**
@@ -423,6 +526,9 @@ type PlanLimits = {
423
526
  * Do not edit manually.
424
527
  */
425
528
 
529
+ /**
530
+ * @description Publicly visible plan metadata and limits.
531
+ */
426
532
  type PlanInfo = {
427
533
  /**
428
534
  * @description Plan tier name (starter, pro, scale).
@@ -460,6 +566,7 @@ type PlanInfo = {
460
566
  */
461
567
  trial_days?: number;
462
568
  /**
569
+ * @description Effective usage limits enforced for an organization plan.
463
570
  * @type object
464
571
  */
465
572
  limits: PlanLimits;
@@ -470,8 +577,12 @@ type PlanInfo = {
470
577
  * Do not edit manually.
471
578
  */
472
579
 
580
+ /**
581
+ * @description Response envelope for listing available billing plans.
582
+ */
473
583
  type ListPlansResponse = {
474
584
  /**
585
+ * @description Billing plans available for self-serve signups.
475
586
  * @type array
476
587
  */
477
588
  plans: PlanInfo[];
@@ -490,10 +601,14 @@ type ListPlans200 = ListPlansResponse;
490
601
  * @description Missing or invalid authentication.
491
602
  */
492
603
  type ListPlans401 = Error$1;
604
+ /**
605
+ * @description Rate limited. Try again later.
606
+ */
607
+ type ListPlans429 = Error$1;
493
608
  type ListPlansQueryResponse = ListPlans200;
494
609
  type ListPlansQuery = {
495
610
  Response: ListPlans200;
496
- Errors: ListPlans401;
611
+ Errors: ListPlans401 | ListPlans429;
497
612
  };
498
613
 
499
614
  /**
@@ -505,8 +620,15 @@ declare const organizationPlanPlanEnum: {
505
620
  readonly starter: "starter";
506
621
  readonly pro: "pro";
507
622
  readonly scale: "scale";
623
+ readonly enterprise: "enterprise";
508
624
  };
509
625
  type OrganizationPlanPlanEnumKey = (typeof organizationPlanPlanEnum)[keyof typeof organizationPlanPlanEnum];
626
+ declare const organizationPlanBillingProviderEnum: {
627
+ readonly stripe: "stripe";
628
+ readonly vercel: "vercel";
629
+ readonly aws: "aws";
630
+ };
631
+ type OrganizationPlanBillingProviderEnumKey = (typeof organizationPlanBillingProviderEnum)[keyof typeof organizationPlanBillingProviderEnum];
510
632
  declare const organizationPlanSubscriptionStatusEnum: {
511
633
  readonly none: "none";
512
634
  readonly active: "active";
@@ -519,8 +641,12 @@ declare const organizationPlanSubscriptionStatusEnum: {
519
641
  readonly paused: "paused";
520
642
  };
521
643
  type OrganizationPlanSubscriptionStatusEnumKey = (typeof organizationPlanSubscriptionStatusEnum)[keyof typeof organizationPlanSubscriptionStatusEnum];
644
+ /**
645
+ * @description Billing state and plan limits for an organization.
646
+ */
522
647
  type OrganizationPlan = {
523
648
  /**
649
+ * @description Organization identifier the plan applies to.
524
650
  * @type string
525
651
  */
526
652
  org_id: string;
@@ -529,6 +655,11 @@ type OrganizationPlan = {
529
655
  * @type string
530
656
  */
531
657
  plan: OrganizationPlanPlanEnumKey;
658
+ /**
659
+ * @description Which billing provider manages this organization\'s subscription.
660
+ * @type string | undefined
661
+ */
662
+ billing_provider?: OrganizationPlanBillingProviderEnumKey;
532
663
  /**
533
664
  * @description Stripe subscription status.
534
665
  * @type string | undefined
@@ -545,14 +676,27 @@ type OrganizationPlan = {
545
676
  */
546
677
  enabled?: boolean;
547
678
  /**
679
+ * @description Whether the organization has custom enterprise pricing.
680
+ * @type boolean | undefined
681
+ */
682
+ custom_pricing?: boolean;
683
+ /**
684
+ * @description Monthly spend limit in dollars. Null means no limit.
685
+ * @type number, double
686
+ */
687
+ spend_limit?: number | null;
688
+ /**
689
+ * @description Effective usage limits enforced for an organization plan.
548
690
  * @type object
549
691
  */
550
692
  limits: PlanLimits;
551
693
  /**
694
+ * @description When the billing record was created.
552
695
  * @type string | undefined, date-time
553
696
  */
554
697
  created_at?: string;
555
698
  /**
699
+ * @description When the billing record was last updated.
556
700
  * @type string | undefined, date-time
557
701
  */
558
702
  updated_at?: string;
@@ -565,6 +709,8 @@ type OrganizationPlan = {
565
709
 
566
710
  type GetOrganizationPlanPathParams = {
567
711
  /**
712
+ * @description Unique organization identifier.
713
+ * @pattern ^[a-zA-Z0-9_.-]+$
568
714
  * @type string
569
715
  */
570
716
  org_id: string;
@@ -573,35 +719,169 @@ type GetOrganizationPlanPathParams = {
573
719
  * @description Organization plan details.
574
720
  */
575
721
  type GetOrganizationPlan200 = OrganizationPlan;
722
+ /**
723
+ * @description Invalid request parameters.
724
+ */
725
+ type GetOrganizationPlan400 = Error$1;
576
726
  /**
577
727
  * @description Missing or invalid authentication.
578
728
  */
579
729
  type GetOrganizationPlan401 = Error$1;
730
+ /**
731
+ * @description Operation not allowed by current plan limits.
732
+ */
733
+ type GetOrganizationPlan403 = Error$1;
734
+ /**
735
+ * @description Rate limited. Try again later.
736
+ */
737
+ type GetOrganizationPlan429 = Error$1;
580
738
  type GetOrganizationPlanQueryResponse = GetOrganizationPlan200;
581
739
  type GetOrganizationPlanQuery = {
582
740
  Response: GetOrganizationPlan200;
583
741
  PathParams: GetOrganizationPlanPathParams;
584
- Errors: GetOrganizationPlan401;
742
+ Errors: GetOrganizationPlan400 | GetOrganizationPlan401 | GetOrganizationPlan403 | GetOrganizationPlan429;
585
743
  };
586
744
 
587
745
  /**
588
746
  * Generated by Kubb (https://kubb.dev/).
589
747
  * Do not edit manually.
590
748
  */
591
- declare const queryCatalogEntryQueryTypeEnum: {
749
+ /**
750
+ * @description Request body for updating an organization\'s monthly spend cap.
751
+ */
752
+ type UpdateSpendLimitRequest = {
753
+ /**
754
+ * @description Monthly spend limit in dollars. Null to remove the limit.
755
+ * @type number, double
756
+ */
757
+ spend_limit?: number | null;
758
+ };
759
+
760
+ /**
761
+ * Generated by Kubb (https://kubb.dev/).
762
+ * Do not edit manually.
763
+ */
764
+
765
+ type UpdateSpendLimitPathParams = {
766
+ /**
767
+ * @description Unique organization identifier.
768
+ * @pattern ^[a-zA-Z0-9_.-]+$
769
+ * @type string
770
+ */
771
+ org_id: string;
772
+ };
773
+ /**
774
+ * @description Spend limit updated.
775
+ */
776
+ type UpdateSpendLimit200 = OrganizationPlan;
777
+ /**
778
+ * @description Invalid request parameters.
779
+ */
780
+ type UpdateSpendLimit400 = Error$1;
781
+ /**
782
+ * @description Missing or invalid authentication.
783
+ */
784
+ type UpdateSpendLimit401 = Error$1;
785
+ /**
786
+ * @description Operation not allowed by current plan limits.
787
+ */
788
+ type UpdateSpendLimit403 = Error$1;
789
+ /**
790
+ * @description Rate limited. Try again later.
791
+ */
792
+ type UpdateSpendLimit429 = Error$1;
793
+ type UpdateSpendLimitMutationRequest = UpdateSpendLimitRequest;
794
+ type UpdateSpendLimitMutationResponse = UpdateSpendLimit200;
795
+ type UpdateSpendLimitMutation = {
796
+ Response: UpdateSpendLimit200;
797
+ Request: UpdateSpendLimitMutationRequest;
798
+ PathParams: UpdateSpendLimitPathParams;
799
+ Errors: UpdateSpendLimit400 | UpdateSpendLimit401 | UpdateSpendLimit403 | UpdateSpendLimit429;
800
+ };
801
+
802
+ /**
803
+ * Generated by Kubb (https://kubb.dev/).
804
+ * Do not edit manually.
805
+ */
806
+ /**
807
+ * @description Request body for capturing cancellation feedback from a user.
808
+ */
809
+ type CancellationFeedbackRequest = {
810
+ /**
811
+ * @description Predefined cancellation reason.
812
+ * @type string | undefined
813
+ */
814
+ reason?: string;
815
+ /**
816
+ * @description Free-text feedback from the user.
817
+ * @type string | undefined
818
+ */
819
+ feedback?: string;
820
+ };
821
+
822
+ /**
823
+ * Generated by Kubb (https://kubb.dev/).
824
+ * Do not edit manually.
825
+ */
826
+
827
+ type SubmitCancellationFeedbackPathParams = {
828
+ /**
829
+ * @description Unique organization identifier.
830
+ * @pattern ^[a-zA-Z0-9_.-]+$
831
+ * @type string
832
+ */
833
+ org_id: string;
834
+ };
835
+ /**
836
+ * @description Feedback recorded.
837
+ */
838
+ type SubmitCancellationFeedback204 = any;
839
+ /**
840
+ * @description Invalid request parameters.
841
+ */
842
+ type SubmitCancellationFeedback400 = Error$1;
843
+ /**
844
+ * @description Missing or invalid authentication.
845
+ */
846
+ type SubmitCancellationFeedback401 = Error$1;
847
+ /**
848
+ * @description Operation not allowed by current plan limits.
849
+ */
850
+ type SubmitCancellationFeedback403 = Error$1;
851
+ /**
852
+ * @description Rate limited. Try again later.
853
+ */
854
+ type SubmitCancellationFeedback429 = Error$1;
855
+ type SubmitCancellationFeedbackMutationRequest = CancellationFeedbackRequest;
856
+ type SubmitCancellationFeedbackMutationResponse = SubmitCancellationFeedback204;
857
+ type SubmitCancellationFeedbackMutation = {
858
+ Response: SubmitCancellationFeedback204;
859
+ Request: SubmitCancellationFeedbackMutationRequest;
860
+ PathParams: SubmitCancellationFeedbackPathParams;
861
+ Errors: SubmitCancellationFeedback400 | SubmitCancellationFeedback401 | SubmitCancellationFeedback403 | SubmitCancellationFeedback429;
862
+ };
863
+
864
+ /**
865
+ * Generated by Kubb (https://kubb.dev/).
866
+ * Do not edit manually.
867
+ */
868
+ declare const cacheRuleEntryQueryTypeEnum: {
592
869
  readonly read: "read";
593
870
  readonly write: "write";
594
871
  readonly other: "other";
595
872
  };
596
- type QueryCatalogEntryQueryTypeEnumKey = (typeof queryCatalogEntryQueryTypeEnum)[keyof typeof queryCatalogEntryQueryTypeEnum];
597
- declare const queryCatalogEntryRecommendationEnum: {
873
+ type CacheRuleEntryQueryTypeEnumKey = (typeof cacheRuleEntryQueryTypeEnum)[keyof typeof cacheRuleEntryQueryTypeEnum];
874
+ declare const cacheRuleEntryRecommendationEnum: {
598
875
  readonly great: "great";
599
876
  readonly good: "good";
600
877
  readonly fair: "fair";
601
878
  readonly poor: "poor";
602
879
  };
603
- type QueryCatalogEntryRecommendationEnumKey = (typeof queryCatalogEntryRecommendationEnum)[keyof typeof queryCatalogEntryRecommendationEnum];
604
- type QueryCatalogEntry = {
880
+ type CacheRuleEntryRecommendationEnumKey = (typeof cacheRuleEntryRecommendationEnum)[keyof typeof cacheRuleEntryRecommendationEnum];
881
+ /**
882
+ * @description Observed query shape and its cache recommendation for a database.
883
+ */
884
+ type CacheRuleEntry = {
605
885
  /**
606
886
  * @description xxhash64 hex of the normalized SQL.
607
887
  * @type string
@@ -616,7 +896,7 @@ type QueryCatalogEntry = {
616
896
  * @description Query classification.
617
897
  * @type string
618
898
  */
619
- query_type: QueryCatalogEntryQueryTypeEnumKey;
899
+ query_type: CacheRuleEntryQueryTypeEnumKey;
620
900
  /**
621
901
  * @description Whether caching is enabled for this query shape.
622
902
  * @type boolean
@@ -663,7 +943,7 @@ type QueryCatalogEntry = {
663
943
  * @description Cache recommendation based on frequency, latency, and stability.
664
944
  * @type string
665
945
  */
666
- recommendation: QueryCatalogEntryRecommendationEnumKey;
946
+ recommendation: CacheRuleEntryRecommendationEnumKey;
667
947
  /**
668
948
  * @description When this query was first observed.
669
949
  * @type string, date-time
@@ -681,11 +961,15 @@ type QueryCatalogEntry = {
681
961
  * Do not edit manually.
682
962
  */
683
963
 
684
- type ListQueryCatalogResponse = {
964
+ /**
965
+ * @description Cursor-paginated cache-rule entries for a database.
966
+ */
967
+ type ListCacheRulesResponse = {
685
968
  /**
969
+ * @description Query shapes returned for the current page.
686
970
  * @type array
687
971
  */
688
- entries: QueryCatalogEntry[];
972
+ entries: CacheRuleEntry[];
689
973
  /**
690
974
  * @description Opaque token for cursor-based pagination.
691
975
  * @type string | undefined
@@ -698,7 +982,7 @@ type ListQueryCatalogResponse = {
698
982
  * Do not edit manually.
699
983
  */
700
984
 
701
- type ListQueryCatalogPathParams = {
985
+ type ListCacheRulesPathParams = {
702
986
  /**
703
987
  * @description Unique project identifier (prefixed, e.g. prj_xxx).
704
988
  * @pattern ^[a-zA-Z0-9_.-]+$
@@ -712,7 +996,7 @@ type ListQueryCatalogPathParams = {
712
996
  */
713
997
  database_id: string;
714
998
  };
715
- type ListQueryCatalogQueryParams = {
999
+ type ListCacheRulesQueryParams = {
716
1000
  /**
717
1001
  * @description Maximum number of items to return (1-100, default 20).
718
1002
  * @minLength 1
@@ -729,33 +1013,44 @@ type ListQueryCatalogQueryParams = {
729
1013
  page_token?: string;
730
1014
  };
731
1015
  /**
732
- * @description Query catalog entries.
1016
+ * @description Cache rule entries.
733
1017
  */
734
- type ListQueryCatalog200 = ListQueryCatalogResponse;
1018
+ type ListCacheRules200 = ListCacheRulesResponse;
1019
+ /**
1020
+ * @description Invalid request parameters.
1021
+ */
1022
+ type ListCacheRules400 = Error$1;
735
1023
  /**
736
1024
  * @description Missing or invalid authentication.
737
1025
  */
738
- type ListQueryCatalog401 = Error$1;
1026
+ type ListCacheRules401 = Error$1;
739
1027
  /**
740
1028
  * @description Operation not allowed by current plan limits.
741
1029
  */
742
- type ListQueryCatalog403 = Error$1;
1030
+ type ListCacheRules403 = Error$1;
743
1031
  /**
744
1032
  * @description Resource not found.
745
1033
  */
746
- type ListQueryCatalog404 = Error$1;
747
- type ListQueryCatalogQueryResponse = ListQueryCatalog200;
748
- type ListQueryCatalogQuery = {
749
- Response: ListQueryCatalog200;
750
- PathParams: ListQueryCatalogPathParams;
751
- QueryParams: ListQueryCatalogQueryParams;
752
- Errors: ListQueryCatalog401 | ListQueryCatalog403 | ListQueryCatalog404;
1034
+ type ListCacheRules404 = Error$1;
1035
+ /**
1036
+ * @description Rate limited. Try again later.
1037
+ */
1038
+ type ListCacheRules429 = Error$1;
1039
+ type ListCacheRulesQueryResponse = ListCacheRules200;
1040
+ type ListCacheRulesQuery = {
1041
+ Response: ListCacheRules200;
1042
+ PathParams: ListCacheRulesPathParams;
1043
+ QueryParams: ListCacheRulesQueryParams;
1044
+ Errors: ListCacheRules400 | ListCacheRules401 | ListCacheRules403 | ListCacheRules404 | ListCacheRules429;
753
1045
  };
754
1046
 
755
1047
  /**
756
1048
  * Generated by Kubb (https://kubb.dev/).
757
1049
  * Do not edit manually.
758
1050
  */
1051
+ /**
1052
+ * @description Request body for updating cache behavior of a query shape.
1053
+ */
759
1054
  type UpdateCacheRuleRequest = {
760
1055
  /**
761
1056
  * @description Whether to enable caching for this query shape.
@@ -783,11 +1078,15 @@ type UpdateCacheRuleRequest = {
783
1078
  * Do not edit manually.
784
1079
  */
785
1080
 
1081
+ /**
1082
+ * @description Response returned after updating a cache rule.
1083
+ */
786
1084
  type UpdateCacheRuleResponse = {
787
1085
  /**
1086
+ * @description Observed query shape and its cache recommendation for a database.
788
1087
  * @type object
789
1088
  */
790
- entry: QueryCatalogEntry;
1089
+ entry: CacheRuleEntry;
791
1090
  };
792
1091
 
793
1092
  /**
@@ -837,13 +1136,17 @@ type UpdateCacheRule403 = Error$1;
837
1136
  * @description Resource not found.
838
1137
  */
839
1138
  type UpdateCacheRule404 = Error$1;
1139
+ /**
1140
+ * @description Rate limited. Try again later.
1141
+ */
1142
+ type UpdateCacheRule429 = Error$1;
840
1143
  type UpdateCacheRuleMutationRequest = UpdateCacheRuleRequest;
841
1144
  type UpdateCacheRuleMutationResponse = UpdateCacheRule200;
842
1145
  type UpdateCacheRuleMutation = {
843
1146
  Response: UpdateCacheRule200;
844
1147
  Request: UpdateCacheRuleMutationRequest;
845
1148
  PathParams: UpdateCacheRulePathParams;
846
- Errors: UpdateCacheRule400 | UpdateCacheRule401 | UpdateCacheRule403 | UpdateCacheRule404;
1149
+ Errors: UpdateCacheRule400 | UpdateCacheRule401 | UpdateCacheRule403 | UpdateCacheRule404 | UpdateCacheRule429;
847
1150
  };
848
1151
 
849
1152
  /**
@@ -946,6 +1249,14 @@ type PoolConfig = {
946
1249
  * @type string
947
1250
  */
948
1251
  pool_mode: PoolMode;
1252
+ /**
1253
+ * @description Maximum concurrent upstream connections per pool.
1254
+ * @minLength 1
1255
+ * @maxLength 10000
1256
+ * @default 200
1257
+ * @type integer | undefined
1258
+ */
1259
+ max_active?: number;
949
1260
  };
950
1261
 
951
1262
  /**
@@ -971,6 +1282,9 @@ type SSLMode = SSLModeEnumKey;
971
1282
  * Do not edit manually.
972
1283
  */
973
1284
 
1285
+ /**
1286
+ * @description Registered upstream PostgreSQL database for a project.
1287
+ */
974
1288
  type Database = {
975
1289
  /**
976
1290
  * @description Unique database identifier (prefixed).
@@ -1021,7 +1335,7 @@ type Database = {
1021
1335
  */
1022
1336
  role?: DatabaseRole;
1023
1337
  /**
1024
- * @description AWS 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
1338
+ * @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
1025
1339
  * @type string | undefined
1026
1340
  */
1027
1341
  pool_region?: string;
@@ -1036,10 +1350,12 @@ type Database = {
1036
1350
  */
1037
1351
  pool_config: PoolConfig;
1038
1352
  /**
1353
+ * @description When the database registration was created.
1039
1354
  * @type string, date-time
1040
1355
  */
1041
1356
  created_at: string;
1042
1357
  /**
1358
+ * @description When the database registration was last updated.
1043
1359
  * @type string, date-time
1044
1360
  */
1045
1361
  updated_at: string;
@@ -1050,8 +1366,12 @@ type Database = {
1050
1366
  * Do not edit manually.
1051
1367
  */
1052
1368
 
1369
+ /**
1370
+ * @description Cursor-paginated list of databases attached to a project.
1371
+ */
1053
1372
  type ListDatabasesResponse = {
1054
1373
  /**
1374
+ * @description Databases on the current page.
1055
1375
  * @type array
1056
1376
  */
1057
1377
  databases: Database[];
@@ -1111,12 +1431,16 @@ type ListDatabases403 = Error$1;
1111
1431
  * @description Resource not found.
1112
1432
  */
1113
1433
  type ListDatabases404 = Error$1;
1434
+ /**
1435
+ * @description Rate limited. Try again later.
1436
+ */
1437
+ type ListDatabases429 = Error$1;
1114
1438
  type ListDatabasesQueryResponse = ListDatabases200;
1115
1439
  type ListDatabasesQuery = {
1116
1440
  Response: ListDatabases200;
1117
1441
  PathParams: ListDatabasesPathParams;
1118
1442
  QueryParams: ListDatabasesQueryParams;
1119
- Errors: ListDatabases400 | ListDatabases401 | ListDatabases403 | ListDatabases404;
1443
+ Errors: ListDatabases400 | ListDatabases401 | ListDatabases403 | ListDatabases404 | ListDatabases429;
1120
1444
  };
1121
1445
 
1122
1446
  /**
@@ -1124,6 +1448,9 @@ type ListDatabasesQuery = {
1124
1448
  * Do not edit manually.
1125
1449
  */
1126
1450
 
1451
+ /**
1452
+ * @description Request body for registering an upstream database.
1453
+ */
1127
1454
  type CreateDatabaseRequest = {
1128
1455
  /**
1129
1456
  * @description PostgreSQL host.
@@ -1172,7 +1499,7 @@ type CreateDatabaseRequest = {
1172
1499
  */
1173
1500
  role?: DatabaseRole;
1174
1501
  /**
1175
- * @description AWS 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
1502
+ * @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
1176
1503
  * @type string | undefined
1177
1504
  */
1178
1505
  pool_region?: string;
@@ -1221,13 +1548,17 @@ type CreateDatabase403 = Error$1;
1221
1548
  * @description Resource not found.
1222
1549
  */
1223
1550
  type CreateDatabase404 = Error$1;
1551
+ /**
1552
+ * @description Rate limited. Try again later.
1553
+ */
1554
+ type CreateDatabase429 = Error$1;
1224
1555
  type CreateDatabaseMutationRequest = CreateDatabaseRequest;
1225
1556
  type CreateDatabaseMutationResponse = CreateDatabase201;
1226
1557
  type CreateDatabaseMutation = {
1227
1558
  Response: CreateDatabase201;
1228
1559
  Request: CreateDatabaseMutationRequest;
1229
1560
  PathParams: CreateDatabasePathParams;
1230
- Errors: CreateDatabase400 | CreateDatabase401 | CreateDatabase403 | CreateDatabase404;
1561
+ Errors: CreateDatabase400 | CreateDatabase401 | CreateDatabase403 | CreateDatabase404 | CreateDatabase429;
1231
1562
  };
1232
1563
 
1233
1564
  /**
@@ -1269,11 +1600,15 @@ type GetDatabase403 = Error$1;
1269
1600
  * @description Resource not found.
1270
1601
  */
1271
1602
  type GetDatabase404 = Error$1;
1603
+ /**
1604
+ * @description Rate limited. Try again later.
1605
+ */
1606
+ type GetDatabase429 = Error$1;
1272
1607
  type GetDatabaseQueryResponse = GetDatabase200;
1273
1608
  type GetDatabaseQuery = {
1274
1609
  Response: GetDatabase200;
1275
1610
  PathParams: GetDatabasePathParams;
1276
- Errors: GetDatabase400 | GetDatabase401 | GetDatabase403 | GetDatabase404;
1611
+ Errors: GetDatabase400 | GetDatabase401 | GetDatabase403 | GetDatabase404 | GetDatabase429;
1277
1612
  };
1278
1613
 
1279
1614
  /**
@@ -1281,6 +1616,9 @@ type GetDatabaseQuery = {
1281
1616
  * Do not edit manually.
1282
1617
  */
1283
1618
 
1619
+ /**
1620
+ * @description Request body for partially updating an upstream database.
1621
+ */
1284
1622
  type UpdateDatabaseRequest = {
1285
1623
  /**
1286
1624
  * @description Updated PostgreSQL host.
@@ -1326,7 +1664,7 @@ type UpdateDatabaseRequest = {
1326
1664
  */
1327
1665
  role?: DatabaseRole;
1328
1666
  /**
1329
- * @description AWS 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
1667
+ * @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
1330
1668
  * @type string | undefined
1331
1669
  */
1332
1670
  pool_region?: string;
@@ -1381,13 +1719,17 @@ type UpdateDatabase403 = Error$1;
1381
1719
  * @description Resource not found.
1382
1720
  */
1383
1721
  type UpdateDatabase404 = Error$1;
1722
+ /**
1723
+ * @description Rate limited. Try again later.
1724
+ */
1725
+ type UpdateDatabase429 = Error$1;
1384
1726
  type UpdateDatabaseMutationRequest = UpdateDatabaseRequest;
1385
1727
  type UpdateDatabaseMutationResponse = UpdateDatabase200;
1386
1728
  type UpdateDatabaseMutation = {
1387
1729
  Response: UpdateDatabase200;
1388
1730
  Request: UpdateDatabaseMutationRequest;
1389
1731
  PathParams: UpdateDatabasePathParams;
1390
- Errors: UpdateDatabase400 | UpdateDatabase401 | UpdateDatabase403 | UpdateDatabase404;
1732
+ Errors: UpdateDatabase400 | UpdateDatabase401 | UpdateDatabase403 | UpdateDatabase404 | UpdateDatabase429;
1391
1733
  };
1392
1734
 
1393
1735
  /**
@@ -1429,17 +1771,24 @@ type DeleteDatabase403 = Error$1;
1429
1771
  * @description Resource not found.
1430
1772
  */
1431
1773
  type DeleteDatabase404 = Error$1;
1774
+ /**
1775
+ * @description Rate limited. Try again later.
1776
+ */
1777
+ type DeleteDatabase429 = Error$1;
1432
1778
  type DeleteDatabaseMutationResponse = DeleteDatabase204;
1433
1779
  type DeleteDatabaseMutation = {
1434
1780
  Response: DeleteDatabase204;
1435
1781
  PathParams: DeleteDatabasePathParams;
1436
- Errors: DeleteDatabase400 | DeleteDatabase401 | DeleteDatabase403 | DeleteDatabase404;
1782
+ Errors: DeleteDatabase400 | DeleteDatabase401 | DeleteDatabase403 | DeleteDatabase404 | DeleteDatabase429;
1437
1783
  };
1438
1784
 
1439
1785
  /**
1440
1786
  * Generated by Kubb (https://kubb.dev/).
1441
1787
  * Do not edit manually.
1442
1788
  */
1789
+ /**
1790
+ * @description Result of testing connectivity to an upstream database.
1791
+ */
1443
1792
  type TestConnectionResult = {
1444
1793
  /**
1445
1794
  * @description Whether the connection test succeeded.
@@ -1502,17 +1851,24 @@ type TestDatabaseConnection403 = Error$1;
1502
1851
  * @description Resource not found.
1503
1852
  */
1504
1853
  type TestDatabaseConnection404 = Error$1;
1854
+ /**
1855
+ * @description Rate limited. Try again later.
1856
+ */
1857
+ type TestDatabaseConnection429 = Error$1;
1505
1858
  type TestDatabaseConnectionMutationResponse = TestDatabaseConnection200;
1506
1859
  type TestDatabaseConnectionMutation = {
1507
1860
  Response: TestDatabaseConnection200;
1508
1861
  PathParams: TestDatabaseConnectionPathParams;
1509
- Errors: TestDatabaseConnection400 | TestDatabaseConnection401 | TestDatabaseConnection403 | TestDatabaseConnection404;
1862
+ Errors: TestDatabaseConnection400 | TestDatabaseConnection401 | TestDatabaseConnection403 | TestDatabaseConnection404 | TestDatabaseConnection429;
1510
1863
  };
1511
1864
 
1512
1865
  /**
1513
1866
  * Generated by Kubb (https://kubb.dev/).
1514
1867
  * Do not edit manually.
1515
1868
  */
1869
+ /**
1870
+ * @description Custom database hostname attached to a project.
1871
+ */
1516
1872
  type CustomDomain = {
1517
1873
  /**
1518
1874
  * @description Unique domain identifier (prefixed).
@@ -1586,10 +1942,12 @@ type CustomDomain = {
1586
1942
  acme_cname_target?: string;
1587
1943
  };
1588
1944
  /**
1945
+ * @description When the custom domain was created.
1589
1946
  * @type string, date-time
1590
1947
  */
1591
1948
  created_at: string;
1592
1949
  /**
1950
+ * @description When the custom domain was last updated.
1593
1951
  * @type string, date-time
1594
1952
  */
1595
1953
  updated_at: string;
@@ -1600,8 +1958,12 @@ type CustomDomain = {
1600
1958
  * Do not edit manually.
1601
1959
  */
1602
1960
 
1961
+ /**
1962
+ * @description Cursor-paginated list of custom domains for a project.
1963
+ */
1603
1964
  type ListCustomDomainsResponse = {
1604
1965
  /**
1966
+ * @description Custom domains on the current page.
1605
1967
  * @type array
1606
1968
  */
1607
1969
  domains: CustomDomain[];
@@ -1661,18 +2023,25 @@ type ListCustomDomains403 = Error$1;
1661
2023
  * @description Resource not found.
1662
2024
  */
1663
2025
  type ListCustomDomains404 = Error$1;
2026
+ /**
2027
+ * @description Rate limited. Try again later.
2028
+ */
2029
+ type ListCustomDomains429 = Error$1;
1664
2030
  type ListCustomDomainsQueryResponse = ListCustomDomains200;
1665
2031
  type ListCustomDomainsQuery = {
1666
2032
  Response: ListCustomDomains200;
1667
2033
  PathParams: ListCustomDomainsPathParams;
1668
2034
  QueryParams: ListCustomDomainsQueryParams;
1669
- Errors: ListCustomDomains400 | ListCustomDomains401 | ListCustomDomains403 | ListCustomDomains404;
2035
+ Errors: ListCustomDomains400 | ListCustomDomains401 | ListCustomDomains403 | ListCustomDomains404 | ListCustomDomains429;
1670
2036
  };
1671
2037
 
1672
2038
  /**
1673
2039
  * Generated by Kubb (https://kubb.dev/).
1674
2040
  * Do not edit manually.
1675
2041
  */
2042
+ /**
2043
+ * @description Request body for attaching a custom domain to a project.
2044
+ */
1676
2045
  type CreateCustomDomainRequest = {
1677
2046
  /**
1678
2047
  * @description The custom domain name to add (e.g., db.example.com).
@@ -1721,13 +2090,17 @@ type CreateCustomDomain404 = Error$1;
1721
2090
  * @description Resource already exists or conflicts with current state.
1722
2091
  */
1723
2092
  type CreateCustomDomain409 = Error$1;
2093
+ /**
2094
+ * @description Rate limited. Try again later.
2095
+ */
2096
+ type CreateCustomDomain429 = Error$1;
1724
2097
  type CreateCustomDomainMutationRequest = CreateCustomDomainRequest;
1725
2098
  type CreateCustomDomainMutationResponse = CreateCustomDomain201;
1726
2099
  type CreateCustomDomainMutation = {
1727
2100
  Response: CreateCustomDomain201;
1728
2101
  Request: CreateCustomDomainMutationRequest;
1729
2102
  PathParams: CreateCustomDomainPathParams;
1730
- Errors: CreateCustomDomain400 | CreateCustomDomain401 | CreateCustomDomain403 | CreateCustomDomain404 | CreateCustomDomain409;
2103
+ Errors: CreateCustomDomain400 | CreateCustomDomain401 | CreateCustomDomain403 | CreateCustomDomain404 | CreateCustomDomain409 | CreateCustomDomain429;
1731
2104
  };
1732
2105
 
1733
2106
  /**
@@ -1769,11 +2142,15 @@ type DeleteCustomDomain403 = Error$1;
1769
2142
  * @description Resource not found.
1770
2143
  */
1771
2144
  type DeleteCustomDomain404 = Error$1;
2145
+ /**
2146
+ * @description Rate limited. Try again later.
2147
+ */
2148
+ type DeleteCustomDomain429 = Error$1;
1772
2149
  type DeleteCustomDomainMutationResponse = DeleteCustomDomain204;
1773
2150
  type DeleteCustomDomainMutation = {
1774
2151
  Response: DeleteCustomDomain204;
1775
2152
  PathParams: DeleteCustomDomainPathParams;
1776
- Errors: DeleteCustomDomain400 | DeleteCustomDomain401 | DeleteCustomDomain403 | DeleteCustomDomain404;
2153
+ Errors: DeleteCustomDomain400 | DeleteCustomDomain401 | DeleteCustomDomain403 | DeleteCustomDomain404 | DeleteCustomDomain429;
1777
2154
  };
1778
2155
 
1779
2156
  /**
@@ -1781,6 +2158,9 @@ type DeleteCustomDomainMutation = {
1781
2158
  * Do not edit manually.
1782
2159
  */
1783
2160
 
2161
+ /**
2162
+ * @description Result of checking DNS ownership for a custom domain.
2163
+ */
1784
2164
  type VerifyCustomDomainResponse = {
1785
2165
  /**
1786
2166
  * @description Whether DNS verification succeeded.
@@ -1793,6 +2173,7 @@ type VerifyCustomDomainResponse = {
1793
2173
  */
1794
2174
  error?: string;
1795
2175
  /**
2176
+ * @description Custom database hostname attached to a project.
1796
2177
  * @type object | undefined
1797
2178
  */
1798
2179
  domain?: CustomDomain;
@@ -1837,11 +2218,15 @@ type VerifyCustomDomain403 = Error$1;
1837
2218
  * @description Resource not found.
1838
2219
  */
1839
2220
  type VerifyCustomDomain404 = Error$1;
2221
+ /**
2222
+ * @description Rate limited. Try again later.
2223
+ */
2224
+ type VerifyCustomDomain429 = Error$1;
1840
2225
  type VerifyCustomDomainMutationResponse = VerifyCustomDomain200;
1841
2226
  type VerifyCustomDomainMutation = {
1842
2227
  Response: VerifyCustomDomain200;
1843
2228
  PathParams: VerifyCustomDomainPathParams;
1844
- Errors: VerifyCustomDomain400 | VerifyCustomDomain401 | VerifyCustomDomain403 | VerifyCustomDomain404;
2229
+ Errors: VerifyCustomDomain400 | VerifyCustomDomain401 | VerifyCustomDomain403 | VerifyCustomDomain404 | VerifyCustomDomain429;
1845
2230
  };
1846
2231
 
1847
2232
  /**
@@ -1853,6 +2238,9 @@ declare const healthResponseStatusEnum: {
1853
2238
  readonly degraded: "degraded";
1854
2239
  };
1855
2240
  type HealthResponseStatusEnumKey = (typeof healthResponseStatusEnum)[keyof typeof healthResponseStatusEnum];
2241
+ /**
2242
+ * @description Health status and build metadata for the API service.
2243
+ */
1856
2244
  type HealthResponse = {
1857
2245
  /**
1858
2246
  * @description Overall service health.
@@ -1886,9 +2274,9 @@ type HealthResponse = {
1886
2274
  */
1887
2275
  type GetHealth200 = HealthResponse;
1888
2276
  /**
1889
- * @description Too many requests.
2277
+ * @description Rate limited. Try again later.
1890
2278
  */
1891
- type GetHealth429 = any;
2279
+ type GetHealth429 = Error$1;
1892
2280
  type GetHealthQueryResponse = GetHealth200;
1893
2281
  type GetHealthQuery = {
1894
2282
  Response: GetHealth200;
@@ -1899,12 +2287,17 @@ type GetHealthQuery = {
1899
2287
  * Generated by Kubb (https://kubb.dev/).
1900
2288
  * Do not edit manually.
1901
2289
  */
2290
+ /**
2291
+ * @description Aggregate cache performance metrics for the selected time range.
2292
+ */
1902
2293
  type CacheSummary = {
1903
2294
  /**
2295
+ * @description Total number of cache hits in the selected time range.
1904
2296
  * @type integer, int64
1905
2297
  */
1906
2298
  total_hits: number;
1907
2299
  /**
2300
+ * @description Total number of cache misses in the selected time range.
1908
2301
  * @type integer, int64
1909
2302
  */
1910
2303
  total_misses: number;
@@ -1919,6 +2312,9 @@ type CacheSummary = {
1919
2312
  * Generated by Kubb (https://kubb.dev/).
1920
2313
  * Do not edit manually.
1921
2314
  */
2315
+ /**
2316
+ * @description Aggregate latency metrics for the selected time range.
2317
+ */
1922
2318
  type LatencySummary = {
1923
2319
  /**
1924
2320
  * @description Average latency in milliseconds across all queries.
@@ -1936,6 +2332,9 @@ type LatencySummary = {
1936
2332
  * Generated by Kubb (https://kubb.dev/).
1937
2333
  * Do not edit manually.
1938
2334
  */
2335
+ /**
2336
+ * @description Aggregated analytics for a normalized SQL query shape.
2337
+ */
1939
2338
  type QueryInsight = {
1940
2339
  /**
1941
2340
  * @description xxhash64 of the normalized SQL pattern (hex).
@@ -1953,10 +2352,12 @@ type QueryInsight = {
1953
2352
  */
1954
2353
  total_count: number;
1955
2354
  /**
2355
+ * @description Total cache hits attributed to the query shape.
1956
2356
  * @type integer, int64
1957
2357
  */
1958
2358
  total_cache_hits: number;
1959
2359
  /**
2360
+ * @description Total cache misses attributed to the query shape.
1960
2361
  * @type integer, int64
1961
2362
  */
1962
2363
  total_cache_misses: number;
@@ -1977,16 +2378,22 @@ type QueryInsight = {
1977
2378
  * Do not edit manually.
1978
2379
  */
1979
2380
 
2381
+ /**
2382
+ * @description Query insights, cache performance, and latency for a project.
2383
+ */
1980
2384
  type ProjectInsights = {
1981
2385
  /**
2386
+ * @description Top query shapes observed for the project.
1982
2387
  * @type array
1983
2388
  */
1984
2389
  queries: QueryInsight[];
1985
2390
  /**
2391
+ * @description Aggregate cache performance metrics for the selected time range.
1986
2392
  * @type object
1987
2393
  */
1988
2394
  cache: CacheSummary;
1989
2395
  /**
2396
+ * @description Aggregate latency metrics for the selected time range.
1990
2397
  * @type object
1991
2398
  */
1992
2399
  latency: LatencySummary;
@@ -2032,6 +2439,10 @@ type GetProjectInsightsQueryParams = {
2032
2439
  * @description Query insights for the project.
2033
2440
  */
2034
2441
  type GetProjectInsights200 = ProjectInsights;
2442
+ /**
2443
+ * @description Invalid request parameters.
2444
+ */
2445
+ type GetProjectInsights400 = Error$1;
2035
2446
  /**
2036
2447
  * @description Missing or invalid authentication.
2037
2448
  */
@@ -2040,18 +2451,25 @@ type GetProjectInsights401 = Error$1;
2040
2451
  * @description Resource not found.
2041
2452
  */
2042
2453
  type GetProjectInsights404 = Error$1;
2454
+ /**
2455
+ * @description Rate limited. Try again later.
2456
+ */
2457
+ type GetProjectInsights429 = Error$1;
2043
2458
  type GetProjectInsightsQueryResponse = GetProjectInsights200;
2044
2459
  type GetProjectInsightsQuery = {
2045
2460
  Response: GetProjectInsights200;
2046
2461
  PathParams: GetProjectInsightsPathParams;
2047
2462
  QueryParams: GetProjectInsightsQueryParams;
2048
- Errors: GetProjectInsights401 | GetProjectInsights404;
2463
+ Errors: GetProjectInsights400 | GetProjectInsights401 | GetProjectInsights404 | GetProjectInsights429;
2049
2464
  };
2050
2465
 
2051
2466
  /**
2052
2467
  * Generated by Kubb (https://kubb.dev/).
2053
2468
  * Do not edit manually.
2054
2469
  */
2470
+ /**
2471
+ * @description Progress state for the dashboard onboarding checklist.
2472
+ */
2055
2473
  type OnboardingProgress = {
2056
2474
  /**
2057
2475
  * @description Organization ID this onboarding belongs to.
@@ -2110,9 +2528,9 @@ type OnboardingProgress = {
2110
2528
  steps_total: number;
2111
2529
  /**
2112
2530
  * @description When onboarding was completed. Null if not yet completed.
2113
- * @type string | undefined, date-time
2531
+ * @type string, date-time
2114
2532
  */
2115
- completed_at?: string;
2533
+ completed_at?: string | null;
2116
2534
  };
2117
2535
 
2118
2536
  /**
@@ -2122,8 +2540,8 @@ type OnboardingProgress = {
2122
2540
 
2123
2541
  type GetOnboardingProgressPathParams = {
2124
2542
  /**
2125
- * @description Organization ID.
2126
- * @pattern ^[\x20-\x7E]+$
2543
+ * @description Unique organization identifier.
2544
+ * @pattern ^[a-zA-Z0-9_.-]+$
2127
2545
  * @type string
2128
2546
  */
2129
2547
  org_id: string;
@@ -2132,6 +2550,10 @@ type GetOnboardingProgressPathParams = {
2132
2550
  * @description Onboarding progress.
2133
2551
  */
2134
2552
  type GetOnboardingProgress200 = OnboardingProgress;
2553
+ /**
2554
+ * @description Invalid request parameters.
2555
+ */
2556
+ type GetOnboardingProgress400 = Error$1;
2135
2557
  /**
2136
2558
  * @description Missing or invalid authentication.
2137
2559
  */
@@ -2144,11 +2566,15 @@ type GetOnboardingProgress403 = Error$1;
2144
2566
  * @description Resource not found.
2145
2567
  */
2146
2568
  type GetOnboardingProgress404 = Error$1;
2569
+ /**
2570
+ * @description Rate limited. Try again later.
2571
+ */
2572
+ type GetOnboardingProgress429 = Error$1;
2147
2573
  type GetOnboardingProgressQueryResponse = GetOnboardingProgress200;
2148
2574
  type GetOnboardingProgressQuery = {
2149
2575
  Response: GetOnboardingProgress200;
2150
2576
  PathParams: GetOnboardingProgressPathParams;
2151
- Errors: GetOnboardingProgress401 | GetOnboardingProgress403 | GetOnboardingProgress404;
2577
+ Errors: GetOnboardingProgress400 | GetOnboardingProgress401 | GetOnboardingProgress403 | GetOnboardingProgress404 | GetOnboardingProgress429;
2152
2578
  };
2153
2579
 
2154
2580
  /**
@@ -2163,6 +2589,9 @@ declare const updateOnboardingRequestStepEnum: {
2163
2589
  readonly first_query_run: "first_query_run";
2164
2590
  };
2165
2591
  type UpdateOnboardingRequestStepEnumKey = (typeof updateOnboardingRequestStepEnum)[keyof typeof updateOnboardingRequestStepEnum];
2592
+ /**
2593
+ * @description Request body for advancing or dismissing onboarding.
2594
+ */
2166
2595
  type UpdateOnboardingRequest = {
2167
2596
  /**
2168
2597
  * @description The onboarding step to mark as complete.
@@ -2183,8 +2612,8 @@ type UpdateOnboardingRequest = {
2183
2612
 
2184
2613
  type UpdateOnboardingProgressPathParams = {
2185
2614
  /**
2186
- * @description Organization ID.
2187
- * @pattern ^[\x20-\x7E]+$
2615
+ * @description Unique organization identifier.
2616
+ * @pattern ^[a-zA-Z0-9_.-]+$
2188
2617
  * @type string
2189
2618
  */
2190
2619
  org_id: string;
@@ -2209,13 +2638,17 @@ type UpdateOnboardingProgress403 = Error$1;
2209
2638
  * @description Resource not found.
2210
2639
  */
2211
2640
  type UpdateOnboardingProgress404 = Error$1;
2641
+ /**
2642
+ * @description Rate limited. Try again later.
2643
+ */
2644
+ type UpdateOnboardingProgress429 = Error$1;
2212
2645
  type UpdateOnboardingProgressMutationRequest = UpdateOnboardingRequest;
2213
2646
  type UpdateOnboardingProgressMutationResponse = UpdateOnboardingProgress200;
2214
2647
  type UpdateOnboardingProgressMutation = {
2215
2648
  Response: UpdateOnboardingProgress200;
2216
2649
  Request: UpdateOnboardingProgressMutationRequest;
2217
2650
  PathParams: UpdateOnboardingProgressPathParams;
2218
- Errors: UpdateOnboardingProgress400 | UpdateOnboardingProgress401 | UpdateOnboardingProgress403 | UpdateOnboardingProgress404;
2651
+ Errors: UpdateOnboardingProgress400 | UpdateOnboardingProgress401 | UpdateOnboardingProgress403 | UpdateOnboardingProgress404 | UpdateOnboardingProgress429;
2219
2652
  };
2220
2653
 
2221
2654
  /**
@@ -2238,6 +2671,15 @@ type ProjectStatus = ProjectStatusEnumKey;
2238
2671
  * Do not edit manually.
2239
2672
  */
2240
2673
 
2674
+ declare const projectCloudEnum: {
2675
+ readonly aws: "aws";
2676
+ readonly azure: "azure";
2677
+ readonly gcp: "gcp";
2678
+ };
2679
+ type ProjectCloudEnumKey = (typeof projectCloudEnum)[keyof typeof projectCloudEnum];
2680
+ /**
2681
+ * @description Project configuration and current control-plane state.
2682
+ */
2241
2683
  type Project = {
2242
2684
  /**
2243
2685
  * @description Unique project identifier (prefixed).
@@ -2263,11 +2705,17 @@ type Project = {
2263
2705
  */
2264
2706
  description?: string;
2265
2707
  /**
2708
+ * @description User-defined labels applied to the project.
2266
2709
  * @type array | undefined
2267
2710
  */
2268
2711
  tags?: string[];
2269
2712
  /**
2270
- * @description Proxy hostname for connecting through PgBeam (e.g., myproject.gw.pgbeam.app).
2713
+ * @description Cloud provider where the project runs.
2714
+ * @type string | undefined
2715
+ */
2716
+ readonly cloud?: ProjectCloudEnumKey;
2717
+ /**
2718
+ * @description Proxy hostname for connecting through PgBeam (e.g., myproject.aws.pgbeam.app).
2271
2719
  * @type string | undefined
2272
2720
  */
2273
2721
  readonly proxy_host?: string;
@@ -2308,10 +2756,12 @@ type Project = {
2308
2756
  */
2309
2757
  status: ProjectStatus;
2310
2758
  /**
2759
+ * @description When the project was created.
2311
2760
  * @type string, date-time
2312
2761
  */
2313
2762
  created_at: string;
2314
2763
  /**
2764
+ * @description When the project was last updated.
2315
2765
  * @type string, date-time
2316
2766
  */
2317
2767
  updated_at: string;
@@ -2322,8 +2772,12 @@ type Project = {
2322
2772
  * Do not edit manually.
2323
2773
  */
2324
2774
 
2775
+ /**
2776
+ * @description Cursor-paginated list of projects for an organization.
2777
+ */
2325
2778
  type ListProjectsResponse = {
2326
2779
  /**
2780
+ * @description Projects on the current page.
2327
2781
  * @type array
2328
2782
  */
2329
2783
  projects: Project[];
@@ -2394,11 +2848,15 @@ type ListProjects401 = Error$1;
2394
2848
  * @description Operation not allowed by current plan limits.
2395
2849
  */
2396
2850
  type ListProjects403 = Error$1;
2851
+ /**
2852
+ * @description Rate limited. Try again later.
2853
+ */
2854
+ type ListProjects429 = Error$1;
2397
2855
  type ListProjectsQueryResponse = ListProjects200;
2398
2856
  type ListProjectsQuery = {
2399
2857
  Response: ListProjects200;
2400
2858
  QueryParams: ListProjectsQueryParams;
2401
- Errors: ListProjects400 | ListProjects401 | ListProjects403;
2859
+ Errors: ListProjects400 | ListProjects401 | ListProjects403 | ListProjects429;
2402
2860
  };
2403
2861
 
2404
2862
  /**
@@ -2406,6 +2864,15 @@ type ListProjectsQuery = {
2406
2864
  * Do not edit manually.
2407
2865
  */
2408
2866
 
2867
+ declare const createProjectRequestCloudEnum: {
2868
+ readonly aws: "aws";
2869
+ readonly azure: "azure";
2870
+ readonly gcp: "gcp";
2871
+ };
2872
+ type CreateProjectRequestCloudEnumKey = (typeof createProjectRequestCloudEnum)[keyof typeof createProjectRequestCloudEnum];
2873
+ /**
2874
+ * @description Request body for creating a project and its primary database.
2875
+ */
2409
2876
  type CreateProjectRequest = {
2410
2877
  /**
2411
2878
  * @description Human-readable project name.
@@ -2417,21 +2884,30 @@ type CreateProjectRequest = {
2417
2884
  name: string;
2418
2885
  /**
2419
2886
  * @description Better Auth organization ID.
2420
- * @pattern ^[^\x00]*$
2887
+ * @minLength 1
2888
+ * @pattern ^[^\x00]+$
2421
2889
  * @type string
2422
2890
  */
2423
2891
  org_id: string;
2424
2892
  /**
2893
+ * @description Optional project description.
2425
2894
  * @maxLength 500
2426
2895
  * @type string | undefined
2427
2896
  */
2428
2897
  description?: string;
2429
2898
  /**
2899
+ * @description User-defined labels to attach to the project.
2430
2900
  * @type array | undefined
2431
2901
  */
2432
2902
  tags?: string[];
2433
2903
  /**
2434
- * @description Primary database. Created atomically with the project.
2904
+ * @description Cloud provider for the project.
2905
+ * @default "aws"
2906
+ * @type string | undefined
2907
+ */
2908
+ cloud?: CreateProjectRequestCloudEnumKey;
2909
+ /**
2910
+ * @description Request body for registering an upstream database.
2435
2911
  * @type object
2436
2912
  */
2437
2913
  database: CreateDatabaseRequest;
@@ -2442,12 +2918,17 @@ type CreateProjectRequest = {
2442
2918
  * Do not edit manually.
2443
2919
  */
2444
2920
 
2921
+ /**
2922
+ * @description Response returned after creating a project and its primary database.
2923
+ */
2445
2924
  type CreateProjectResponse = {
2446
2925
  /**
2926
+ * @description Project configuration and current control-plane state.
2447
2927
  * @type object
2448
2928
  */
2449
2929
  project: Project;
2450
2930
  /**
2931
+ * @description Registered upstream PostgreSQL database for a project.
2451
2932
  * @type object | undefined
2452
2933
  */
2453
2934
  database?: Database;
@@ -2478,12 +2959,16 @@ type CreateProject403 = Error$1;
2478
2959
  * @description Resource already exists or conflicts with current state.
2479
2960
  */
2480
2961
  type CreateProject409 = Error$1;
2962
+ /**
2963
+ * @description Rate limited. Try again later.
2964
+ */
2965
+ type CreateProject429 = Error$1;
2481
2966
  type CreateProjectMutationRequest = CreateProjectRequest;
2482
2967
  type CreateProjectMutationResponse = CreateProject201;
2483
2968
  type CreateProjectMutation = {
2484
2969
  Response: CreateProject201;
2485
2970
  Request: CreateProjectMutationRequest;
2486
- Errors: CreateProject400 | CreateProject401 | CreateProject403 | CreateProject409;
2971
+ Errors: CreateProject400 | CreateProject401 | CreateProject403 | CreateProject409 | CreateProject429;
2487
2972
  };
2488
2973
 
2489
2974
  /**
@@ -2519,11 +3004,15 @@ type GetProject403 = Error$1;
2519
3004
  * @description Resource not found.
2520
3005
  */
2521
3006
  type GetProject404 = Error$1;
3007
+ /**
3008
+ * @description Rate limited. Try again later.
3009
+ */
3010
+ type GetProject429 = Error$1;
2522
3011
  type GetProjectQueryResponse = GetProject200;
2523
3012
  type GetProjectQuery = {
2524
3013
  Response: GetProject200;
2525
3014
  PathParams: GetProjectPathParams;
2526
- Errors: GetProject400 | GetProject401 | GetProject403 | GetProject404;
3015
+ Errors: GetProject400 | GetProject401 | GetProject403 | GetProject404 | GetProject429;
2527
3016
  };
2528
3017
 
2529
3018
  /**
@@ -2531,6 +3020,9 @@ type GetProjectQuery = {
2531
3020
  * Do not edit manually.
2532
3021
  */
2533
3022
 
3023
+ /**
3024
+ * @description Request body for partially updating a project.
3025
+ */
2534
3026
  type UpdateProjectRequest = {
2535
3027
  /**
2536
3028
  * @description Updated project name.
@@ -2541,11 +3033,13 @@ type UpdateProjectRequest = {
2541
3033
  */
2542
3034
  name?: string;
2543
3035
  /**
3036
+ * @description Updated project description.
2544
3037
  * @maxLength 500
2545
3038
  * @type string | undefined
2546
3039
  */
2547
3040
  description?: string;
2548
3041
  /**
3042
+ * @description Replacement set of user-defined project labels.
2549
3043
  * @type array | undefined
2550
3044
  */
2551
3045
  tags?: string[];
@@ -2610,13 +3104,17 @@ type UpdateProject403 = Error$1;
2610
3104
  * @description Resource not found.
2611
3105
  */
2612
3106
  type UpdateProject404 = Error$1;
3107
+ /**
3108
+ * @description Rate limited. Try again later.
3109
+ */
3110
+ type UpdateProject429 = Error$1;
2613
3111
  type UpdateProjectMutationRequest = UpdateProjectRequest;
2614
3112
  type UpdateProjectMutationResponse = UpdateProject200;
2615
3113
  type UpdateProjectMutation = {
2616
3114
  Response: UpdateProject200;
2617
3115
  Request: UpdateProjectMutationRequest;
2618
3116
  PathParams: UpdateProjectPathParams;
2619
- Errors: UpdateProject400 | UpdateProject401 | UpdateProject403 | UpdateProject404;
3117
+ Errors: UpdateProject400 | UpdateProject401 | UpdateProject403 | UpdateProject404 | UpdateProject429;
2620
3118
  };
2621
3119
 
2622
3120
  /**
@@ -2652,51 +3150,67 @@ type DeleteProject403 = Error$1;
2652
3150
  * @description Resource not found.
2653
3151
  */
2654
3152
  type DeleteProject404 = Error$1;
3153
+ /**
3154
+ * @description Rate limited. Try again later.
3155
+ */
3156
+ type DeleteProject429 = Error$1;
2655
3157
  type DeleteProjectMutationResponse = DeleteProject204;
2656
3158
  type DeleteProjectMutation = {
2657
3159
  Response: DeleteProject204;
2658
3160
  PathParams: DeleteProjectPathParams;
2659
- Errors: DeleteProject400 | DeleteProject401 | DeleteProject403 | DeleteProject404;
3161
+ Errors: DeleteProject400 | DeleteProject401 | DeleteProject403 | DeleteProject404 | DeleteProject429;
2660
3162
  };
2661
3163
 
2662
3164
  /**
2663
3165
  * Generated by Kubb (https://kubb.dev/).
2664
3166
  * Do not edit manually.
2665
3167
  */
3168
+ /**
3169
+ * @description Aggregated project metrics captured for a point in time.
3170
+ */
2666
3171
  type MetricsSnapshot = {
2667
3172
  /**
3173
+ * @description Unique metrics snapshot identifier.
2668
3174
  * @type string
2669
3175
  */
2670
3176
  id: string;
2671
3177
  /**
3178
+ * @description Project that produced the metrics snapshot.
2672
3179
  * @type string
2673
3180
  */
2674
3181
  project_id: string;
2675
3182
  /**
3183
+ * @description Region where the traffic was served.
2676
3184
  * @type string
2677
3185
  */
2678
3186
  region: string;
2679
3187
  /**
3188
+ * @description Total queries served during the snapshot interval.
2680
3189
  * @type integer, int64
2681
3190
  */
2682
3191
  queries_total: number;
2683
3192
  /**
3193
+ * @description Number of queries served from cache.
2684
3194
  * @type integer, int64
2685
3195
  */
2686
3196
  cache_hits: number;
2687
3197
  /**
3198
+ * @description Number of queries forwarded upstream.
2688
3199
  * @type integer, int64
2689
3200
  */
2690
3201
  cache_misses: number;
2691
3202
  /**
3203
+ * @description Current active proxy connections.
2692
3204
  * @type integer
2693
3205
  */
2694
3206
  active_connections: number;
2695
3207
  /**
3208
+ * @description Average end-to-end query latency in milliseconds.
2696
3209
  * @type number, double
2697
3210
  */
2698
3211
  avg_latency_ms: number;
2699
3212
  /**
3213
+ * @description 99th percentile end-to-end query latency in milliseconds.
2700
3214
  * @type number, double
2701
3215
  */
2702
3216
  p99_latency_ms: number;
@@ -2711,11 +3225,28 @@ type MetricsSnapshot = {
2711
3225
  */
2712
3226
  avg_query_ms?: number;
2713
3227
  /**
3228
+ * @description When the snapshot was recorded.
2714
3229
  * @type string, date-time
2715
3230
  */
2716
3231
  created_at: string;
2717
3232
  };
2718
3233
 
3234
+ /**
3235
+ * Generated by Kubb (https://kubb.dev/).
3236
+ * Do not edit manually.
3237
+ */
3238
+
3239
+ /**
3240
+ * @description Response envelope for recent project metrics snapshots.
3241
+ */
3242
+ type ProjectMetricsResponse = {
3243
+ /**
3244
+ * @description Metrics snapshots ordered from newest to oldest.
3245
+ * @type array
3246
+ */
3247
+ snapshots: MetricsSnapshot[];
3248
+ };
3249
+
2719
3250
  /**
2720
3251
  * Generated by Kubb (https://kubb.dev/).
2721
3252
  * Do not edit manually.
@@ -2731,6 +3262,7 @@ type GetProjectMetricsPathParams = {
2731
3262
  };
2732
3263
  type GetProjectMetricsQueryParams = {
2733
3264
  /**
3265
+ * @description Maximum number of recent snapshots to return.
2734
3266
  * @minLength 1
2735
3267
  * @maxLength 1000
2736
3268
  * @default 60
@@ -2746,12 +3278,7 @@ type GetProjectMetricsQueryParams = {
2746
3278
  /**
2747
3279
  * @description Metrics snapshots
2748
3280
  */
2749
- type GetProjectMetrics200 = {
2750
- /**
2751
- * @type array
2752
- */
2753
- snapshots: MetricsSnapshot[];
2754
- };
3281
+ type GetProjectMetrics200 = ProjectMetricsResponse;
2755
3282
  /**
2756
3283
  * @description Invalid request parameters.
2757
3284
  */
@@ -2764,24 +3291,37 @@ type GetProjectMetrics401 = Error$1;
2764
3291
  * @description Resource not found.
2765
3292
  */
2766
3293
  type GetProjectMetrics404 = Error$1;
3294
+ /**
3295
+ * @description Rate limited. Try again later.
3296
+ */
3297
+ type GetProjectMetrics429 = Error$1;
2767
3298
  type GetProjectMetricsQueryResponse = GetProjectMetrics200;
2768
3299
  type GetProjectMetricsQuery = {
2769
3300
  Response: GetProjectMetrics200;
2770
3301
  PathParams: GetProjectMetricsPathParams;
2771
3302
  QueryParams: GetProjectMetricsQueryParams;
2772
- Errors: GetProjectMetrics400 | GetProjectMetrics401 | GetProjectMetrics404;
3303
+ Errors: GetProjectMetrics400 | GetProjectMetrics401 | GetProjectMetrics404 | GetProjectMetrics429;
2773
3304
  };
2774
3305
 
2775
3306
  /**
2776
3307
  * Generated by Kubb (https://kubb.dev/).
2777
3308
  * Do not edit manually.
2778
3309
  */
3310
+ declare const regionProviderEnum: {
3311
+ readonly aws: "aws";
3312
+ readonly azure: "azure";
3313
+ readonly gcp: "gcp";
3314
+ };
3315
+ type RegionProviderEnumKey = (typeof regionProviderEnum)[keyof typeof regionProviderEnum];
2779
3316
  declare const regionStatusEnum: {
2780
3317
  readonly active: "active";
2781
3318
  readonly draining: "draining";
2782
3319
  readonly inactive: "inactive";
2783
3320
  };
2784
3321
  type RegionStatusEnumKey = (typeof regionStatusEnum)[keyof typeof regionStatusEnum];
3322
+ /**
3323
+ * @description Data plane region available for PgBeam traffic.
3324
+ */
2785
3325
  type Region = {
2786
3326
  /**
2787
3327
  * @description Region identifier (e.g. us-east-1).
@@ -2797,21 +3337,24 @@ type Region = {
2797
3337
  * @description Cloud provider.
2798
3338
  * @type string
2799
3339
  */
2800
- provider: string;
3340
+ provider: RegionProviderEnumKey;
2801
3341
  /**
2802
3342
  * @description Region operational status.
2803
3343
  * @type string
2804
3344
  */
2805
3345
  status: RegionStatusEnumKey;
2806
3346
  /**
3347
+ * @description Whether new projects can currently be assigned to the region.
2807
3348
  * @type boolean
2808
3349
  */
2809
3350
  available: boolean;
2810
3351
  /**
3352
+ * @description Continent where the region is located.
2811
3353
  * @type string | undefined
2812
3354
  */
2813
3355
  continent?: string;
2814
3356
  /**
3357
+ * @description Country where the region is located.
2815
3358
  * @type string | undefined
2816
3359
  */
2817
3360
  country?: string;
@@ -2822,8 +3365,12 @@ type Region = {
2822
3365
  * Do not edit manually.
2823
3366
  */
2824
3367
 
3368
+ /**
3369
+ * @description Response envelope for available region queries.
3370
+ */
2825
3371
  type ListRegionsResponse = {
2826
3372
  /**
3373
+ * @description Regions currently known to the control plane.
2827
3374
  * @type array
2828
3375
  */
2829
3376
  regions: Region[];
@@ -2842,10 +3389,14 @@ type ListRegions200 = ListRegionsResponse;
2842
3389
  * @description Missing or invalid authentication.
2843
3390
  */
2844
3391
  type ListRegions401 = Error$1;
3392
+ /**
3393
+ * @description Rate limited. Try again later.
3394
+ */
3395
+ type ListRegions429 = Error$1;
2845
3396
  type ListRegionsQueryResponse = ListRegions200;
2846
3397
  type ListRegionsQuery = {
2847
3398
  Response: ListRegions200;
2848
- Errors: ListRegions401;
3399
+ Errors: ListRegions401 | ListRegions429;
2849
3400
  };
2850
3401
 
2851
3402
  /**
@@ -2853,6 +3404,9 @@ type ListRegionsQuery = {
2853
3404
  * Do not edit manually.
2854
3405
  */
2855
3406
 
3407
+ /**
3408
+ * @description Read replica registered for a primary database.
3409
+ */
2856
3410
  type Replica = {
2857
3411
  /**
2858
3412
  * @description Unique replica identifier (prefixed).
@@ -2882,10 +3436,12 @@ type Replica = {
2882
3436
  */
2883
3437
  ssl_mode: SSLMode;
2884
3438
  /**
3439
+ * @description When the replica was created.
2885
3440
  * @type string, date-time
2886
3441
  */
2887
3442
  created_at: string;
2888
3443
  /**
3444
+ * @description When the replica was last updated.
2889
3445
  * @type string, date-time
2890
3446
  */
2891
3447
  updated_at: string;
@@ -2896,8 +3452,12 @@ type Replica = {
2896
3452
  * Do not edit manually.
2897
3453
  */
2898
3454
 
3455
+ /**
3456
+ * @description Response envelope for listing registered replicas.
3457
+ */
2899
3458
  type ListReplicasResponse = {
2900
3459
  /**
3460
+ * @description Read replicas attached to the database.
2901
3461
  * @type array
2902
3462
  */
2903
3463
  replicas: Replica[];
@@ -2936,11 +3496,15 @@ type ListReplicas403 = Error$1;
2936
3496
  * @description Resource not found.
2937
3497
  */
2938
3498
  type ListReplicas404 = Error$1;
3499
+ /**
3500
+ * @description Rate limited. Try again later.
3501
+ */
3502
+ type ListReplicas429 = Error$1;
2939
3503
  type ListReplicasQueryResponse = ListReplicas200;
2940
3504
  type ListReplicasQuery = {
2941
3505
  Response: ListReplicas200;
2942
3506
  PathParams: ListReplicasPathParams;
2943
- Errors: ListReplicas400 | ListReplicas401 | ListReplicas403 | ListReplicas404;
3507
+ Errors: ListReplicas400 | ListReplicas401 | ListReplicas403 | ListReplicas404 | ListReplicas429;
2944
3508
  };
2945
3509
 
2946
3510
  /**
@@ -2948,6 +3512,9 @@ type ListReplicasQuery = {
2948
3512
  * Do not edit manually.
2949
3513
  */
2950
3514
 
3515
+ /**
3516
+ * @description Request body for adding a read replica to a database.
3517
+ */
2951
3518
  type CreateReplicaRequest = {
2952
3519
  /**
2953
3520
  * @description PostgreSQL replica host.
@@ -3003,13 +3570,17 @@ type CreateReplica403 = Error$1;
3003
3570
  * @description Resource not found.
3004
3571
  */
3005
3572
  type CreateReplica404 = Error$1;
3573
+ /**
3574
+ * @description Rate limited. Try again later.
3575
+ */
3576
+ type CreateReplica429 = Error$1;
3006
3577
  type CreateReplicaMutationRequest = CreateReplicaRequest;
3007
3578
  type CreateReplicaMutationResponse = CreateReplica201;
3008
3579
  type CreateReplicaMutation = {
3009
3580
  Response: CreateReplica201;
3010
3581
  Request: CreateReplicaMutationRequest;
3011
3582
  PathParams: CreateReplicaPathParams;
3012
- Errors: CreateReplica400 | CreateReplica401 | CreateReplica403 | CreateReplica404;
3583
+ Errors: CreateReplica400 | CreateReplica401 | CreateReplica403 | CreateReplica404 | CreateReplica429;
3013
3584
  };
3014
3585
 
3015
3586
  /**
@@ -3051,35 +3622,47 @@ type DeleteReplica403 = Error$1;
3051
3622
  * @description Resource not found.
3052
3623
  */
3053
3624
  type DeleteReplica404 = Error$1;
3625
+ /**
3626
+ * @description Rate limited. Try again later.
3627
+ */
3628
+ type DeleteReplica429 = Error$1;
3054
3629
  type DeleteReplicaMutationResponse = DeleteReplica204;
3055
3630
  type DeleteReplicaMutation = {
3056
3631
  Response: DeleteReplica204;
3057
3632
  PathParams: DeleteReplicaPathParams;
3058
- Errors: DeleteReplica400 | DeleteReplica401 | DeleteReplica403 | DeleteReplica404;
3633
+ Errors: DeleteReplica400 | DeleteReplica401 | DeleteReplica403 | DeleteReplica404 | DeleteReplica429;
3059
3634
  };
3060
3635
 
3061
3636
  /**
3062
3637
  * Generated by Kubb (https://kubb.dev/).
3063
3638
  * Do not edit manually.
3064
3639
  */
3640
+ /**
3641
+ * @description Daily usage totals aggregated across all projects in an organization.
3642
+ */
3065
3643
  type DailyUsage = {
3066
3644
  /**
3645
+ * @description Usage date in UTC.
3067
3646
  * @type string, date
3068
3647
  */
3069
3648
  day: string;
3070
3649
  /**
3650
+ * @description Total queries served on the day.
3071
3651
  * @type integer, int64
3072
3652
  */
3073
3653
  queries_total: number;
3074
3654
  /**
3655
+ * @description Total cache hits on the day.
3075
3656
  * @type integer, int64
3076
3657
  */
3077
3658
  cache_hits: number;
3078
3659
  /**
3660
+ * @description Total cache misses on the day.
3079
3661
  * @type integer, int64
3080
3662
  */
3081
3663
  cache_misses: number;
3082
3664
  /**
3665
+ * @description Total proxy connection time consumed on the day.
3083
3666
  * @type integer, int64
3084
3667
  */
3085
3668
  connection_seconds: number;
@@ -3095,8 +3678,12 @@ type DailyUsage = {
3095
3678
  * Do not edit manually.
3096
3679
  */
3097
3680
 
3681
+ /**
3682
+ * @description Response envelope for organization usage queries.
3683
+ */
3098
3684
  type UsageResponse = {
3099
3685
  /**
3686
+ * @description Daily usage entries aggregated across the organization.
3100
3687
  * @type array
3101
3688
  */
3102
3689
  usage: DailyUsage[];
@@ -3109,6 +3696,8 @@ type UsageResponse = {
3109
3696
 
3110
3697
  type GetOrganizationUsagePathParams = {
3111
3698
  /**
3699
+ * @description Unique organization identifier.
3700
+ * @pattern ^[a-zA-Z0-9_.-]+$
3112
3701
  * @type string
3113
3702
  */
3114
3703
  org_id: string;
@@ -3129,44 +3718,65 @@ type GetOrganizationUsageQueryParams = {
3129
3718
  * @description Daily usage data.
3130
3719
  */
3131
3720
  type GetOrganizationUsage200 = UsageResponse;
3721
+ /**
3722
+ * @description Invalid request parameters.
3723
+ */
3724
+ type GetOrganizationUsage400 = Error$1;
3132
3725
  /**
3133
3726
  * @description Missing or invalid authentication.
3134
3727
  */
3135
3728
  type GetOrganizationUsage401 = Error$1;
3729
+ /**
3730
+ * @description Operation not allowed by current plan limits.
3731
+ */
3732
+ type GetOrganizationUsage403 = Error$1;
3733
+ /**
3734
+ * @description Rate limited. Try again later.
3735
+ */
3736
+ type GetOrganizationUsage429 = Error$1;
3136
3737
  type GetOrganizationUsageQueryResponse = GetOrganizationUsage200;
3137
3738
  type GetOrganizationUsageQuery = {
3138
3739
  Response: GetOrganizationUsage200;
3139
3740
  PathParams: GetOrganizationUsagePathParams;
3140
3741
  QueryParams: GetOrganizationUsageQueryParams;
3141
- Errors: GetOrganizationUsage401;
3742
+ Errors: GetOrganizationUsage400 | GetOrganizationUsage401 | GetOrganizationUsage403 | GetOrganizationUsage429;
3142
3743
  };
3143
3744
 
3144
3745
  /**
3145
3746
  * Generated by Kubb (https://kubb.dev/).
3146
3747
  * Do not edit manually.
3147
3748
  */
3749
+ /**
3750
+ * @description Daily usage totals for a single project and region.
3751
+ */
3148
3752
  type ProjectDailyUsage = {
3149
3753
  /**
3754
+ * @description Usage date in UTC.
3150
3755
  * @type string, date
3151
3756
  */
3152
3757
  day: string;
3153
3758
  /**
3759
+ * @description Region where the traffic was served.
3154
3760
  * @type string
3155
3761
  */
3156
3762
  region: string;
3157
3763
  /**
3764
+ * @description Total queries served on the day.
3158
3765
  * @type integer, int64
3159
3766
  */
3160
3767
  queries_total: number;
3161
3768
  /**
3769
+ * @description Total cache hits on the day.
3162
3770
  * @type integer, int64
3163
3771
  */
3164
3772
  cache_hits: number;
3165
3773
  /**
3774
+ * @description Total cache misses on the day.
3166
3775
  * @type integer, int64
3167
3776
  */
3168
3777
  cache_misses: number;
3169
3778
  /**
3779
+ * @description Total proxy connection time consumed on the day.
3170
3780
  * @type integer, int64
3171
3781
  */
3172
3782
  connection_seconds: number;
@@ -3182,8 +3792,12 @@ type ProjectDailyUsage = {
3182
3792
  * Do not edit manually.
3183
3793
  */
3184
3794
 
3795
+ /**
3796
+ * @description Response envelope for project usage queries.
3797
+ */
3185
3798
  type ProjectUsageResponse = {
3186
3799
  /**
3800
+ * @description Daily usage entries grouped by region for the project.
3187
3801
  * @type array
3188
3802
  */
3189
3803
  usage: ProjectDailyUsage[];
@@ -3218,6 +3832,10 @@ type GetProjectUsageQueryParams = {
3218
3832
  * @description Daily usage data by region.
3219
3833
  */
3220
3834
  type GetProjectUsage200 = ProjectUsageResponse;
3835
+ /**
3836
+ * @description Invalid request parameters.
3837
+ */
3838
+ type GetProjectUsage400 = Error$1;
3221
3839
  /**
3222
3840
  * @description Missing or invalid authentication.
3223
3841
  */
@@ -3226,99 +3844,16 @@ type GetProjectUsage401 = Error$1;
3226
3844
  * @description Resource not found.
3227
3845
  */
3228
3846
  type GetProjectUsage404 = Error$1;
3847
+ /**
3848
+ * @description Rate limited. Try again later.
3849
+ */
3850
+ type GetProjectUsage429 = Error$1;
3229
3851
  type GetProjectUsageQueryResponse = GetProjectUsage200;
3230
3852
  type GetProjectUsageQuery = {
3231
3853
  Response: GetProjectUsage200;
3232
3854
  PathParams: GetProjectUsagePathParams;
3233
3855
  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;
3856
+ Errors: GetProjectUsage400 | GetProjectUsage401 | GetProjectUsage404 | GetProjectUsage429;
3322
3857
  };
3323
3858
 
3324
3859
  /**
@@ -3329,8 +3864,15 @@ type JoinWaitlistMutation = {
3329
3864
  interface ApiOperations {
3330
3865
  account: {
3331
3866
  exportAccountData(): Promise<ExportAccountDataQueryResponse>;
3867
+ getOnboardingProgress(params: {
3868
+ pathParams: GetOnboardingProgressPathParams;
3869
+ }): Promise<GetOnboardingProgressQueryResponse>;
3870
+ updateOnboardingProgress(params: {
3871
+ pathParams: UpdateOnboardingProgressPathParams;
3872
+ body: UpdateOnboardingProgressMutationRequest;
3873
+ }): Promise<UpdateOnboardingProgressMutationResponse>;
3332
3874
  };
3333
- usage: {
3875
+ analytics: {
3334
3876
  getOrganizationActivity(params: {
3335
3877
  pathParams: GetOrganizationActivityPathParams;
3336
3878
  queryParams?: GetOrganizationActivityQueryParams;
@@ -3339,6 +3881,14 @@ interface ApiOperations {
3339
3881
  getOrganizationPlan(params: {
3340
3882
  pathParams: GetOrganizationPlanPathParams;
3341
3883
  }): Promise<GetOrganizationPlanQueryResponse>;
3884
+ updateSpendLimit(params: {
3885
+ pathParams: UpdateSpendLimitPathParams;
3886
+ body: UpdateSpendLimitMutationRequest;
3887
+ }): Promise<UpdateSpendLimitMutationResponse>;
3888
+ submitCancellationFeedback(params: {
3889
+ pathParams: SubmitCancellationFeedbackPathParams;
3890
+ body: SubmitCancellationFeedbackMutationRequest;
3891
+ }): Promise<void>;
3342
3892
  getProjectInsights(params: {
3343
3893
  pathParams: GetProjectInsightsPathParams;
3344
3894
  queryParams?: GetProjectInsightsQueryParams;
@@ -3352,40 +3902,15 @@ interface ApiOperations {
3352
3902
  queryParams: GetProjectUsageQueryParams;
3353
3903
  }): Promise<GetProjectUsageQueryResponse>;
3354
3904
  };
3355
- catalog: {
3356
- listQueryCatalog(params: {
3357
- pathParams: ListQueryCatalogPathParams;
3358
- queryParams?: ListQueryCatalogQueryParams;
3359
- }): Promise<ListQueryCatalogQueryResponse>;
3905
+ projects: {
3906
+ listCacheRules(params: {
3907
+ pathParams: ListCacheRulesPathParams;
3908
+ queryParams?: ListCacheRulesQueryParams;
3909
+ }): Promise<ListCacheRulesQueryResponse>;
3360
3910
  updateCacheRule(params: {
3361
3911
  pathParams: UpdateCacheRulePathParams;
3362
3912
  body: UpdateCacheRuleMutationRequest;
3363
3913
  }): 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
3914
  listCustomDomains(params: {
3390
3915
  pathParams: ListCustomDomainsPathParams;
3391
3916
  queryParams?: ListCustomDomainsQueryParams;
@@ -3400,20 +3925,6 @@ interface ApiOperations {
3400
3925
  verifyCustomDomain(params: {
3401
3926
  pathParams: VerifyCustomDomainPathParams;
3402
3927
  }): 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
3928
  listProjects(params: {
3418
3929
  queryParams: ListProjectsQueryParams;
3419
3930
  }): Promise<ListProjectsQueryResponse>;
@@ -3434,11 +3945,6 @@ interface ApiOperations {
3434
3945
  pathParams: GetProjectMetricsPathParams;
3435
3946
  queryParams?: GetProjectMetricsQueryParams;
3436
3947
  }): Promise<GetProjectMetricsQueryResponse>;
3437
- };
3438
- regions: {
3439
- listRegions(): Promise<ListRegionsQueryResponse>;
3440
- };
3441
- replicas: {
3442
3948
  listReplicas(params: {
3443
3949
  pathParams: ListReplicasPathParams;
3444
3950
  }): Promise<ListReplicasQueryResponse>;
@@ -3450,10 +3956,32 @@ interface ApiOperations {
3450
3956
  pathParams: DeleteReplicaPathParams;
3451
3957
  }): Promise<void>;
3452
3958
  };
3453
- waitlist: {
3454
- joinWaitlist(params: {
3455
- body: JoinWaitlistMutationRequest;
3456
- }): Promise<JoinWaitlistMutationResponse>;
3959
+ databases: {
3960
+ listDatabases(params: {
3961
+ pathParams: ListDatabasesPathParams;
3962
+ queryParams?: ListDatabasesQueryParams;
3963
+ }): Promise<ListDatabasesQueryResponse>;
3964
+ createDatabase(params: {
3965
+ pathParams: CreateDatabasePathParams;
3966
+ body: CreateDatabaseMutationRequest;
3967
+ }): Promise<CreateDatabaseMutationResponse>;
3968
+ getDatabase(params: {
3969
+ pathParams: GetDatabasePathParams;
3970
+ }): Promise<GetDatabaseQueryResponse>;
3971
+ updateDatabase(params: {
3972
+ pathParams: UpdateDatabasePathParams;
3973
+ body: UpdateDatabaseMutationRequest;
3974
+ }): Promise<UpdateDatabaseMutationResponse>;
3975
+ deleteDatabase(params: {
3976
+ pathParams: DeleteDatabasePathParams;
3977
+ }): Promise<void>;
3978
+ testDatabaseConnection(params: {
3979
+ pathParams: TestDatabaseConnectionPathParams;
3980
+ }): Promise<TestDatabaseConnectionMutationResponse>;
3981
+ };
3982
+ platform: {
3983
+ getHealth(): Promise<GetHealthQueryResponse>;
3984
+ listRegions(): Promise<ListRegionsQueryResponse>;
3457
3985
  };
3458
3986
  }
3459
3987
  interface RequestMap {
@@ -3478,14 +4006,28 @@ interface RequestMap {
3478
4006
  };
3479
4007
  response: GetOrganizationPlanQueryResponse;
3480
4008
  };
3481
- "GET /v1/projects/{project_id}/databases/{database_id}/catalog": {
4009
+ "PUT /v1/organizations/{org_id}/spend-limit": {
3482
4010
  params: {
3483
- pathParams: ListQueryCatalogPathParams;
3484
- queryParams?: ListQueryCatalogQueryParams;
4011
+ pathParams: UpdateSpendLimitPathParams;
4012
+ body: UpdateSpendLimitMutationRequest;
3485
4013
  };
3486
- response: ListQueryCatalogQueryResponse;
4014
+ response: UpdateSpendLimitMutationResponse;
4015
+ };
4016
+ "POST /v1/organizations/{org_id}/cancellation-feedback": {
4017
+ params: {
4018
+ pathParams: SubmitCancellationFeedbackPathParams;
4019
+ body: SubmitCancellationFeedbackMutationRequest;
4020
+ };
4021
+ response: void;
3487
4022
  };
3488
- "PUT /v1/projects/{project_id}/databases/{database_id}/catalog/{query_hash}/cache-rule": {
4023
+ "GET /v1/projects/{project_id}/databases/{database_id}/cache-rules": {
4024
+ params: {
4025
+ pathParams: ListCacheRulesPathParams;
4026
+ queryParams?: ListCacheRulesQueryParams;
4027
+ };
4028
+ response: ListCacheRulesQueryResponse;
4029
+ };
4030
+ "PUT /v1/projects/{project_id}/databases/{database_id}/cache-rules/{query_hash}": {
3489
4031
  params: {
3490
4032
  pathParams: UpdateCacheRulePathParams;
3491
4033
  body: UpdateCacheRuleMutationRequest;
@@ -3656,12 +4198,6 @@ interface RequestMap {
3656
4198
  };
3657
4199
  response: GetProjectUsageQueryResponse;
3658
4200
  };
3659
- "POST /v1/waitlist": {
3660
- params: {
3661
- body: JoinWaitlistMutationRequest;
3662
- };
3663
- response: JoinWaitlistMutationResponse;
3664
- };
3665
4201
  }
3666
4202
  type Route = keyof RequestMap;
3667
4203
 
@@ -3674,6 +4210,16 @@ declare class ApiError extends Error {
3674
4210
  /** Extract a human-readable message from an API error body. */
3675
4211
  declare function extractMessage(body: unknown): string | undefined;
3676
4212
  type OnResponseHook = (response: Response) => void | Promise<void>;
4213
+ interface RetryConfig {
4214
+ /** Max retry attempts after initial request (default: 5, 0 = disabled). */
4215
+ maxRetries?: number;
4216
+ /** Initial backoff in ms (default: 500). */
4217
+ initialDelayMs?: number;
4218
+ /** Max backoff in ms (default: 30_000). */
4219
+ maxDelayMs?: number;
4220
+ /** Auto-send Idempotency-Key on mutating retries (default: true). */
4221
+ idempotencyKeys?: boolean;
4222
+ }
3677
4223
 
3678
4224
  interface PgBeamClientOptions {
3679
4225
  /** JWT token, or async function that resolves one (for lazy/refreshing tokens). */
@@ -3684,6 +4230,8 @@ interface PgBeamClientOptions {
3684
4230
  fetch?: typeof globalThis.fetch;
3685
4231
  /** Optional hook called after every response (e.g. for 401 redirect). */
3686
4232
  onResponse?: OnResponseHook;
4233
+ /** Retry configuration. Default: { maxRetries: 5 }. Set false to disable. */
4234
+ retry?: RetryConfig | false;
3687
4235
  }
3688
4236
  /** Type-safe client with tag-based proxy access and .request() method. */
3689
4237
  type ApiClient = ApiOperations & {
@@ -3701,6 +4249,7 @@ declare class PgBeamClient {
3701
4249
  private _tokenOrFn;
3702
4250
  private _fetchImpl?;
3703
4251
  private _onResponse?;
4252
+ private _retry?;
3704
4253
  private _api?;
3705
4254
  constructor(options: PgBeamClientOptions);
3706
4255
  private _resolveToken;
@@ -3709,5 +4258,5 @@ declare class PgBeamClient {
3709
4258
  get api(): ApiClient;
3710
4259
  }
3711
4260
 
3712
- export { ApiError, PgBeamClient, SSLModeEnum, databaseRoleEnum, extractMessage, getProjectInsightsQueryParamsRangeEnum, healthResponseStatusEnum, listProjectsQueryParamsSortByEnum, organizationPlanPlanEnum, organizationPlanSubscriptionStatusEnum, poolModeEnum, projectStatusEnum, queryCatalogEntryQueryTypeEnum, queryCatalogEntryRecommendationEnum, regionStatusEnum, updateOnboardingRequestStepEnum };
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, JoinWaitlist200, JoinWaitlist400, JoinWaitlistMutation, JoinWaitlistMutationRequest, JoinWaitlistMutationResponse, JoinWaitlistRequest, JoinWaitlistResponse, LatencySummary, 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, ListQueryCatalog200, ListQueryCatalog401, ListQueryCatalog403, ListQueryCatalog404, ListQueryCatalogPathParams, ListQueryCatalogQuery, ListQueryCatalogQueryParams, ListQueryCatalogQueryResponse, ListQueryCatalogResponse, ListRegions200, ListRegions401, ListRegionsQuery, ListRegionsQueryResponse, ListRegionsResponse, ListReplicas200, ListReplicas400, ListReplicas401, ListReplicas403, ListReplicas404, ListReplicasPathParams, ListReplicasQuery, ListReplicasQueryResponse, ListReplicasResponse, MetricsSnapshot, OnboardingProgress, OrganizationPlan, OrganizationPlanPlanEnumKey, OrganizationPlanSubscriptionStatusEnumKey, PgBeamClientOptions, PlanInfo, PlanLimits, PoolConfig, PoolMode, PoolModeEnumKey, Project, ProjectDailyUsage, ProjectInsights, ProjectStatus, ProjectStatusEnumKey, ProjectUsageResponse, QueryCatalogEntry, QueryCatalogEntryQueryTypeEnumKey, QueryCatalogEntryRecommendationEnumKey, QueryInsight, Region, RegionStatusEnumKey, Replica, SSLMode, SSLModeEnumKey, 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, UsageResponse, VerifyCustomDomain200, VerifyCustomDomain400, VerifyCustomDomain401, VerifyCustomDomain403, VerifyCustomDomain404, VerifyCustomDomainMutation, VerifyCustomDomainMutationResponse, VerifyCustomDomainPathParams, VerifyCustomDomainResponse, WaitlistEntry };
4261
+ export { ApiError, PgBeamClient, SSLModeEnum, cacheRuleEntryQueryTypeEnum, cacheRuleEntryRecommendationEnum, createProjectRequestCloudEnum, databaseRoleEnum, extractMessage, getProjectInsightsQueryParamsRangeEnum, healthResponseStatusEnum, listProjectsQueryParamsSortByEnum, organizationPlanBillingProviderEnum, organizationPlanPlanEnum, organizationPlanSubscriptionStatusEnum, poolModeEnum, projectCloudEnum, projectStatusEnum, regionProviderEnum, regionStatusEnum, updateOnboardingRequestStepEnum };
4262
+ export type { AccountExport, ActivityEntry, ActivityResponse, ApiClient, CacheConfig, CacheRuleEntry, CacheRuleEntryQueryTypeEnumKey, CacheRuleEntryRecommendationEnumKey, CacheSummary, CancellationFeedbackRequest, CreateCustomDomain201, CreateCustomDomain400, CreateCustomDomain401, CreateCustomDomain403, CreateCustomDomain404, CreateCustomDomain409, CreateCustomDomain429, CreateCustomDomainMutation, CreateCustomDomainMutationRequest, CreateCustomDomainMutationResponse, CreateCustomDomainPathParams, CreateCustomDomainRequest, CreateDatabase201, CreateDatabase400, CreateDatabase401, CreateDatabase403, CreateDatabase404, CreateDatabase429, CreateDatabaseMutation, CreateDatabaseMutationRequest, CreateDatabaseMutationResponse, CreateDatabasePathParams, CreateDatabaseRequest, CreateProject201, CreateProject400, CreateProject401, CreateProject403, CreateProject409, CreateProject429, CreateProjectMutation, CreateProjectMutationRequest, CreateProjectMutationResponse, CreateProjectRequest, CreateProjectRequestCloudEnumKey, CreateProjectResponse, CreateReplica201, CreateReplica400, CreateReplica401, CreateReplica403, CreateReplica404, CreateReplica429, CreateReplicaMutation, CreateReplicaMutationRequest, CreateReplicaMutationResponse, CreateReplicaPathParams, CreateReplicaRequest, CustomDomain, DailyUsage, Database, DatabaseRole, DatabaseRoleEnumKey, DeleteCustomDomain204, DeleteCustomDomain400, DeleteCustomDomain401, DeleteCustomDomain403, DeleteCustomDomain404, DeleteCustomDomain429, DeleteCustomDomainMutation, DeleteCustomDomainMutationResponse, DeleteCustomDomainPathParams, DeleteDatabase204, DeleteDatabase400, DeleteDatabase401, DeleteDatabase403, DeleteDatabase404, DeleteDatabase429, DeleteDatabaseMutation, DeleteDatabaseMutationResponse, DeleteDatabasePathParams, DeleteProject204, DeleteProject400, DeleteProject401, DeleteProject403, DeleteProject404, DeleteProject429, DeleteProjectMutation, DeleteProjectMutationResponse, DeleteProjectPathParams, DeleteReplica204, DeleteReplica400, DeleteReplica401, DeleteReplica403, DeleteReplica404, DeleteReplica429, DeleteReplicaMutation, DeleteReplicaMutationResponse, DeleteReplicaPathParams, Error$1 as Error, ExportAccountData200, ExportAccountData401, ExportAccountData404, ExportAccountData429, ExportAccountDataQuery, ExportAccountDataQueryResponse, GetDatabase200, GetDatabase400, GetDatabase401, GetDatabase403, GetDatabase404, GetDatabase429, GetDatabasePathParams, GetDatabaseQuery, GetDatabaseQueryResponse, GetHealth200, GetHealth429, GetHealthQuery, GetHealthQueryResponse, GetOnboardingProgress200, GetOnboardingProgress400, GetOnboardingProgress401, GetOnboardingProgress403, GetOnboardingProgress404, GetOnboardingProgress429, GetOnboardingProgressPathParams, GetOnboardingProgressQuery, GetOnboardingProgressQueryResponse, GetOrganizationActivity200, GetOrganizationActivity400, GetOrganizationActivity401, GetOrganizationActivity403, GetOrganizationActivity429, GetOrganizationActivityPathParams, GetOrganizationActivityQuery, GetOrganizationActivityQueryParams, GetOrganizationActivityQueryResponse, GetOrganizationPlan200, GetOrganizationPlan400, GetOrganizationPlan401, GetOrganizationPlan403, GetOrganizationPlan429, GetOrganizationPlanPathParams, GetOrganizationPlanQuery, GetOrganizationPlanQueryResponse, GetOrganizationUsage200, GetOrganizationUsage400, GetOrganizationUsage401, GetOrganizationUsage403, GetOrganizationUsage429, GetOrganizationUsagePathParams, GetOrganizationUsageQuery, GetOrganizationUsageQueryParams, GetOrganizationUsageQueryResponse, GetProject200, GetProject400, GetProject401, GetProject403, GetProject404, GetProject429, GetProjectInsights200, GetProjectInsights400, GetProjectInsights401, GetProjectInsights404, GetProjectInsights429, GetProjectInsightsPathParams, GetProjectInsightsQuery, GetProjectInsightsQueryParams, GetProjectInsightsQueryParamsRangeEnumKey, GetProjectInsightsQueryResponse, GetProjectMetrics200, GetProjectMetrics400, GetProjectMetrics401, GetProjectMetrics404, GetProjectMetrics429, GetProjectMetricsPathParams, GetProjectMetricsQuery, GetProjectMetricsQueryParams, GetProjectMetricsQueryResponse, GetProjectPathParams, GetProjectQuery, GetProjectQueryResponse, GetProjectUsage200, GetProjectUsage400, GetProjectUsage401, GetProjectUsage404, GetProjectUsage429, GetProjectUsagePathParams, GetProjectUsageQuery, GetProjectUsageQueryParams, GetProjectUsageQueryResponse, HealthResponse, HealthResponseStatusEnumKey, LatencySummary, ListCacheRules200, ListCacheRules400, ListCacheRules401, ListCacheRules403, ListCacheRules404, ListCacheRules429, ListCacheRulesPathParams, ListCacheRulesQuery, ListCacheRulesQueryParams, ListCacheRulesQueryResponse, ListCacheRulesResponse, ListCustomDomains200, ListCustomDomains400, ListCustomDomains401, ListCustomDomains403, ListCustomDomains404, ListCustomDomains429, ListCustomDomainsPathParams, ListCustomDomainsQuery, ListCustomDomainsQueryParams, ListCustomDomainsQueryResponse, ListCustomDomainsResponse, ListDatabases200, ListDatabases400, ListDatabases401, ListDatabases403, ListDatabases404, ListDatabases429, ListDatabasesPathParams, ListDatabasesQuery, ListDatabasesQueryParams, ListDatabasesQueryResponse, ListDatabasesResponse, ListPlans200, ListPlans401, ListPlans429, ListPlansQuery, ListPlansQueryResponse, ListPlansResponse, ListProjects200, ListProjects400, ListProjects401, ListProjects403, ListProjects429, ListProjectsQuery, ListProjectsQueryParams, ListProjectsQueryParamsSortByEnumKey, ListProjectsQueryResponse, ListProjectsResponse, ListRegions200, ListRegions401, ListRegions429, ListRegionsQuery, ListRegionsQueryResponse, ListRegionsResponse, ListReplicas200, ListReplicas400, ListReplicas401, ListReplicas403, ListReplicas404, ListReplicas429, ListReplicasPathParams, ListReplicasQuery, ListReplicasQueryResponse, ListReplicasResponse, MetricsSnapshot, OnboardingProgress, OrganizationPlan, OrganizationPlanBillingProviderEnumKey, OrganizationPlanPlanEnumKey, OrganizationPlanSubscriptionStatusEnumKey, PgBeamClientOptions, PlanInfo, PlanLimits, PoolConfig, PoolMode, PoolModeEnumKey, Project, ProjectCloudEnumKey, ProjectDailyUsage, ProjectInsights, ProjectMetricsResponse, ProjectStatus, ProjectStatusEnumKey, ProjectUsageResponse, QueryInsight, Region, RegionProviderEnumKey, RegionStatusEnumKey, Replica, RetryConfig, SSLMode, SSLModeEnumKey, SubmitCancellationFeedback204, SubmitCancellationFeedback400, SubmitCancellationFeedback401, SubmitCancellationFeedback403, SubmitCancellationFeedback429, SubmitCancellationFeedbackMutation, SubmitCancellationFeedbackMutationRequest, SubmitCancellationFeedbackMutationResponse, SubmitCancellationFeedbackPathParams, TestConnectionResult, TestDatabaseConnection200, TestDatabaseConnection400, TestDatabaseConnection401, TestDatabaseConnection403, TestDatabaseConnection404, TestDatabaseConnection429, TestDatabaseConnectionMutation, TestDatabaseConnectionMutationResponse, TestDatabaseConnectionPathParams, UpdateCacheRule200, UpdateCacheRule400, UpdateCacheRule401, UpdateCacheRule403, UpdateCacheRule404, UpdateCacheRule429, UpdateCacheRuleMutation, UpdateCacheRuleMutationRequest, UpdateCacheRuleMutationResponse, UpdateCacheRulePathParams, UpdateCacheRuleRequest, UpdateCacheRuleResponse, UpdateDatabase200, UpdateDatabase400, UpdateDatabase401, UpdateDatabase403, UpdateDatabase404, UpdateDatabase429, UpdateDatabaseMutation, UpdateDatabaseMutationRequest, UpdateDatabaseMutationResponse, UpdateDatabasePathParams, UpdateDatabaseRequest, UpdateOnboardingProgress200, UpdateOnboardingProgress400, UpdateOnboardingProgress401, UpdateOnboardingProgress403, UpdateOnboardingProgress404, UpdateOnboardingProgress429, UpdateOnboardingProgressMutation, UpdateOnboardingProgressMutationRequest, UpdateOnboardingProgressMutationResponse, UpdateOnboardingProgressPathParams, UpdateOnboardingRequest, UpdateOnboardingRequestStepEnumKey, UpdateProject200, UpdateProject400, UpdateProject401, UpdateProject403, UpdateProject404, UpdateProject429, UpdateProjectMutation, UpdateProjectMutationRequest, UpdateProjectMutationResponse, UpdateProjectPathParams, UpdateProjectRequest, UpdateSpendLimit200, UpdateSpendLimit400, UpdateSpendLimit401, UpdateSpendLimit403, UpdateSpendLimit429, UpdateSpendLimitMutation, UpdateSpendLimitMutationRequest, UpdateSpendLimitMutationResponse, UpdateSpendLimitPathParams, UpdateSpendLimitRequest, UsageResponse, VerifyCustomDomain200, VerifyCustomDomain400, VerifyCustomDomain401, VerifyCustomDomain403, VerifyCustomDomain404, VerifyCustomDomain429, VerifyCustomDomainMutation, VerifyCustomDomainMutationResponse, VerifyCustomDomainPathParams, VerifyCustomDomainResponse };