pgbeam 0.3.7 → 0.3.8

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.
@@ -492,7 +492,7 @@ Object.defineProperty(exports, '__esModule', { value: true });
492
492
  "parameters": [],
493
493
  "requestBodyType": "",
494
494
  "requestBodyRequired": false,
495
- "responseType": "{ plans: ({ annual_price?: number; description?: string; label: string; limits: { bytes_per_month: number; included_seats: number; max_connections: number; max_databases: number; max_projects: number; max_query_shapes: number; queries_per_day: number; queries_per_second: number }; monthly_price: number; name: string; overage_text?: string; trial_days?: number })[] }",
495
+ "responseType": "{ plans: ({ annual_price?: number; description?: string; label: string; limits: { audit_retention_days: number; bytes_per_month: number; included_seats: number; max_agent_credentials: number; max_connections: number; max_databases: number; max_projects: number; max_query_shapes: number; queries_per_day: number; queries_per_second: number; sandbox_idle_seconds: number; sandbox_max_branches: number; sandbox_max_upstream_bytes: number; sandbox_ttl_seconds: number }; monthly_price: number; name: string; overage_text?: string; trial_days?: number })[] }",
496
496
  "responseStatus": "200"
497
497
  },
498
498
  "getOrganizationPlan": {
@@ -512,7 +512,7 @@ Object.defineProperty(exports, '__esModule', { value: true });
512
512
  ],
513
513
  "requestBodyType": "",
514
514
  "requestBodyRequired": false,
515
- "responseType": "{ billing_provider?: \"stripe\" | \"vercel\" | \"aws\" | \"manual\"; created_at?: string; current_period_end?: string; custom_pricing?: boolean; enabled?: boolean; limits: { bytes_per_month: number; included_seats: number; max_connections: number; max_databases: number; max_projects: number; max_query_shapes: number; queries_per_day: number; queries_per_second: number }; org_id: string; plan: \"starter\" | \"pro\" | \"scale\" | \"enterprise\"; spend_capped?: boolean; spend_capped_at?: string; spend_limit?: number; subscription_status?: \"none\" | \"active\" | \"trialing\" | \"past_due\" | \"canceled\" | \"unpaid\" | \"incomplete\" | \"incomplete_expired\" | \"paused\"; updated_at?: string }",
515
+ "responseType": "{ billing_provider?: \"stripe\" | \"vercel\" | \"aws\" | \"manual\"; created_at?: string; current_period_end?: string; custom_pricing?: boolean; enabled?: boolean; limits: { audit_retention_days: number; bytes_per_month: number; included_seats: number; max_agent_credentials: number; max_connections: number; max_databases: number; max_projects: number; max_query_shapes: number; queries_per_day: number; queries_per_second: number; sandbox_idle_seconds: number; sandbox_max_branches: number; sandbox_max_upstream_bytes: number; sandbox_ttl_seconds: number }; org_id: string; plan: \"starter\" | \"pro\" | \"scale\" | \"enterprise\"; spend_capped?: boolean; spend_capped_at?: string; spend_limit?: number; subscription_status?: \"none\" | \"active\" | \"trialing\" | \"past_due\" | \"canceled\" | \"unpaid\" | \"incomplete\" | \"incomplete_expired\" | \"paused\"; updated_at?: string }",
516
516
  "responseStatus": "200"
517
517
  },
518
518
  "getVercelInstallation": {
@@ -552,7 +552,7 @@ Object.defineProperty(exports, '__esModule', { value: true });
552
552
  ],
553
553
  "requestBodyType": "{ spend_limit?: number }",
554
554
  "requestBodyRequired": true,
555
- "responseType": "{ billing_provider?: \"stripe\" | \"vercel\" | \"aws\" | \"manual\"; created_at?: string; current_period_end?: string; custom_pricing?: boolean; enabled?: boolean; limits: { bytes_per_month: number; included_seats: number; max_connections: number; max_databases: number; max_projects: number; max_query_shapes: number; queries_per_day: number; queries_per_second: number }; org_id: string; plan: \"starter\" | \"pro\" | \"scale\" | \"enterprise\"; spend_capped?: boolean; spend_capped_at?: string; spend_limit?: number; subscription_status?: \"none\" | \"active\" | \"trialing\" | \"past_due\" | \"canceled\" | \"unpaid\" | \"incomplete\" | \"incomplete_expired\" | \"paused\"; updated_at?: string }",
555
+ "responseType": "{ billing_provider?: \"stripe\" | \"vercel\" | \"aws\" | \"manual\"; created_at?: string; current_period_end?: string; custom_pricing?: boolean; enabled?: boolean; limits: { audit_retention_days: number; bytes_per_month: number; included_seats: number; max_agent_credentials: number; max_connections: number; max_databases: number; max_projects: number; max_query_shapes: number; queries_per_day: number; queries_per_second: number; sandbox_idle_seconds: number; sandbox_max_branches: number; sandbox_max_upstream_bytes: number; sandbox_ttl_seconds: number }; org_id: string; plan: \"starter\" | \"pro\" | \"scale\" | \"enterprise\"; spend_capped?: boolean; spend_capped_at?: string; spend_limit?: number; subscription_status?: \"none\" | \"active\" | \"trialing\" | \"past_due\" | \"canceled\" | \"unpaid\" | \"incomplete\" | \"incomplete_expired\" | \"paused\"; updated_at?: string }",
556
556
  "responseStatus": "200"
557
557
  },
558
558
  "submitCancellationFeedback": {
@@ -1341,7 +1341,7 @@ Object.defineProperty(exports, '__esModule', { value: true });
1341
1341
  ],
1342
1342
  "requestBodyType": "",
1343
1343
  "requestBodyRequired": false,
1344
- "responseType": "{ next_page_token?: string; projects: ({ active_connections?: number; agents_disabled?: boolean; allowed_cidrs?: ({ cidr: string; label?: string })[]; burst_size?: number; cloud?: \"aws\" | \"azure\" | \"gcp\"; created_at: string; database_count?: number; default_policy_profile_id?: string; description?: string; id: string; max_connections?: number; name: string; org_id: string; proxy_host?: string; queries_per_second?: number; status: \"active\" | \"suspended\" | \"deleted\"; tags?: string[]; updated_at: string })[]; total: number }",
1344
+ "responseType": "{ next_page_token?: string; projects: ({ active_connections?: number; agents_disabled?: boolean; allowed_cidrs?: ({ cidr: string; label?: string })[]; burst_size?: number; cloud?: \"aws\" | \"azure\" | \"gcp\"; created_at: string; database_count?: number; default_policy_profile_id?: string; description?: string; id: string; max_connections?: number; name: string; org_id: string; proxy_host?: string; queries_per_second?: number; residency?: \"any\" | \"us\" | \"eu\"; self_hosted?: boolean; status: \"active\" | \"suspended\" | \"deleted\"; tags?: string[]; updated_at: string })[]; total: number }",
1345
1345
  "responseStatus": "200"
1346
1346
  },
1347
1347
  "createProject": {
@@ -1351,9 +1351,9 @@ Object.defineProperty(exports, '__esModule', { value: true });
1351
1351
  "summary": "Create a project",
1352
1352
  "description": "Creates a new project within the specified organization.",
1353
1353
  "parameters": [],
1354
- "requestBodyType": "{ cloud?: \"aws\" | \"azure\" | \"gcp\"; database: { auto_read_routing?: boolean; cache_config?: { enabled: boolean; max_entries: number; swr_seconds: number; ttl_seconds: number }; host: string; name: string; password: string; pool_config?: { max_active?: number; min_pool_size: number; pool_mode: \"session\" | \"transaction\" | \"statement\"; pool_size: number }; pool_region?: string; port: number; query_timeout_ms?: number; role?: \"primary\" | \"replica\"; ssl_mode?: \"disable\" | \"allow\" | \"prefer\" | \"require\" | \"verify-ca\" | \"verify-full\"; username: string }; description?: string; name: string; org_id: string; tags?: string[] }",
1354
+ "requestBodyType": "{ cloud?: \"aws\" | \"azure\" | \"gcp\"; database: { auto_read_routing?: boolean; cache_config?: { enabled: boolean; max_entries: number; swr_seconds: number; ttl_seconds: number }; host: string; name: string; password: string; pool_config?: { max_active?: number; min_pool_size: number; pool_mode: \"session\" | \"transaction\" | \"statement\"; pool_size: number }; pool_region?: string; port: number; query_timeout_ms?: number; role?: \"primary\" | \"replica\"; ssl_mode?: \"disable\" | \"allow\" | \"prefer\" | \"require\" | \"verify-ca\" | \"verify-full\"; username: string }; description?: string; name: string; org_id: string; self_hosted?: boolean; tags?: string[] }",
1355
1355
  "requestBodyRequired": true,
1356
- "responseType": "{ database?: { auto_read_routing?: boolean; cache_config: { enabled: boolean; max_entries: number; swr_seconds: number; ttl_seconds: number }; connection_string?: string; created_at: string; host: string; id: string; name: string; pool_config: { max_active?: number; min_pool_size: number; pool_mode: \"session\" | \"transaction\" | \"statement\"; pool_size: number }; pool_region?: string; port: number; project_id: string; query_timeout_ms?: number; role?: \"primary\" | \"replica\"; ssl_mode: \"disable\" | \"allow\" | \"prefer\" | \"require\" | \"verify-ca\" | \"verify-full\"; updated_at: string; username: string }; project: { active_connections?: number; agents_disabled?: boolean; allowed_cidrs?: ({ cidr: string; label?: string })[]; burst_size?: number; cloud?: \"aws\" | \"azure\" | \"gcp\"; created_at: string; database_count?: number; default_policy_profile_id?: string; description?: string; id: string; max_connections?: number; name: string; org_id: string; proxy_host?: string; queries_per_second?: number; status: \"active\" | \"suspended\" | \"deleted\"; tags?: string[]; updated_at: string } }",
1356
+ "responseType": "{ database?: { auto_read_routing?: boolean; cache_config: { enabled: boolean; max_entries: number; swr_seconds: number; ttl_seconds: number }; connection_string?: string; created_at: string; host: string; id: string; name: string; pool_config: { max_active?: number; min_pool_size: number; pool_mode: \"session\" | \"transaction\" | \"statement\"; pool_size: number }; pool_region?: string; port: number; project_id: string; query_timeout_ms?: number; role?: \"primary\" | \"replica\"; ssl_mode: \"disable\" | \"allow\" | \"prefer\" | \"require\" | \"verify-ca\" | \"verify-full\"; updated_at: string; username: string }; project: { active_connections?: number; agents_disabled?: boolean; allowed_cidrs?: ({ cidr: string; label?: string })[]; burst_size?: number; cloud?: \"aws\" | \"azure\" | \"gcp\"; created_at: string; database_count?: number; default_policy_profile_id?: string; description?: string; id: string; max_connections?: number; name: string; org_id: string; proxy_host?: string; queries_per_second?: number; residency?: \"any\" | \"us\" | \"eu\"; self_hosted?: boolean; status: \"active\" | \"suspended\" | \"deleted\"; tags?: string[]; updated_at: string } }",
1357
1357
  "responseStatus": "201"
1358
1358
  },
1359
1359
  "getProject": {
@@ -1373,7 +1373,7 @@ Object.defineProperty(exports, '__esModule', { value: true });
1373
1373
  ],
1374
1374
  "requestBodyType": "",
1375
1375
  "requestBodyRequired": false,
1376
- "responseType": "{ active_connections?: number; agents_disabled?: boolean; allowed_cidrs?: ({ cidr: string; label?: string })[]; burst_size?: number; cloud?: \"aws\" | \"azure\" | \"gcp\"; created_at: string; database_count?: number; default_policy_profile_id?: string; description?: string; id: string; max_connections?: number; name: string; org_id: string; proxy_host?: string; queries_per_second?: number; status: \"active\" | \"suspended\" | \"deleted\"; tags?: string[]; updated_at: string }",
1376
+ "responseType": "{ active_connections?: number; agents_disabled?: boolean; allowed_cidrs?: ({ cidr: string; label?: string })[]; burst_size?: number; cloud?: \"aws\" | \"azure\" | \"gcp\"; created_at: string; database_count?: number; default_policy_profile_id?: string; description?: string; id: string; max_connections?: number; name: string; org_id: string; proxy_host?: string; queries_per_second?: number; residency?: \"any\" | \"us\" | \"eu\"; self_hosted?: boolean; status: \"active\" | \"suspended\" | \"deleted\"; tags?: string[]; updated_at: string }",
1377
1377
  "responseStatus": "200"
1378
1378
  },
1379
1379
  "updateProject": {
@@ -1391,9 +1391,9 @@ Object.defineProperty(exports, '__esModule', { value: true });
1391
1391
  "description": "Unique project identifier (prefixed, e.g. prj_xxx)."
1392
1392
  }
1393
1393
  ],
1394
- "requestBodyType": "{ agents_disabled?: boolean; allowed_cidrs?: ({ cidr: string; label?: string })[]; default_policy_profile_id?: string; description?: string; name?: string; status?: \"active\" | \"suspended\" | \"deleted\"; tags?: string[] }",
1394
+ "requestBodyType": "{ agents_disabled?: boolean; allowed_cidrs?: ({ cidr: string; label?: string })[]; default_policy_profile_id?: string; description?: string; name?: string; residency?: \"any\" | \"us\" | \"eu\"; status?: \"active\" | \"suspended\" | \"deleted\"; tags?: string[] }",
1395
1395
  "requestBodyRequired": true,
1396
- "responseType": "{ active_connections?: number; agents_disabled?: boolean; allowed_cidrs?: ({ cidr: string; label?: string })[]; burst_size?: number; cloud?: \"aws\" | \"azure\" | \"gcp\"; created_at: string; database_count?: number; default_policy_profile_id?: string; description?: string; id: string; max_connections?: number; name: string; org_id: string; proxy_host?: string; queries_per_second?: number; status: \"active\" | \"suspended\" | \"deleted\"; tags?: string[]; updated_at: string }",
1396
+ "responseType": "{ active_connections?: number; agents_disabled?: boolean; allowed_cidrs?: ({ cidr: string; label?: string })[]; burst_size?: number; cloud?: \"aws\" | \"azure\" | \"gcp\"; created_at: string; database_count?: number; default_policy_profile_id?: string; description?: string; id: string; max_connections?: number; name: string; org_id: string; proxy_host?: string; queries_per_second?: number; residency?: \"any\" | \"us\" | \"eu\"; self_hosted?: boolean; status: \"active\" | \"suspended\" | \"deleted\"; tags?: string[]; updated_at: string }",
1397
1397
  "responseStatus": "200"
1398
1398
  },
1399
1399
  "deleteProject": {
@@ -1529,6 +1529,73 @@ Object.defineProperty(exports, '__esModule', { value: true });
1529
1529
  "responseType": "",
1530
1530
  "responseStatus": "204"
1531
1531
  },
1532
+ "listSelfHostEnrollments": {
1533
+ "operationId": "listSelfHostEnrollments",
1534
+ "method": "GET",
1535
+ "path": "/v1/organizations/{org_id}/self-host-enrollments",
1536
+ "summary": "List self-host enrollments",
1537
+ "description": "Lists an organization's self-host enrollments. Tokens are never returned.",
1538
+ "parameters": [
1539
+ {
1540
+ "name": "org_id",
1541
+ "in": "path",
1542
+ "required": true,
1543
+ "type": "string",
1544
+ "description": "Unique organization identifier."
1545
+ }
1546
+ ],
1547
+ "requestBodyType": "",
1548
+ "requestBodyRequired": false,
1549
+ "responseType": "{ enrollments: ({ created_at: string; created_by?: string; description?: string; id: string; last_seen_at?: string; org_id: string; region_label?: string; revoked_at?: string })[] }",
1550
+ "responseStatus": "200"
1551
+ },
1552
+ "createSelfHostEnrollment": {
1553
+ "operationId": "createSelfHostEnrollment",
1554
+ "method": "POST",
1555
+ "path": "/v1/organizations/{org_id}/self-host-enrollments",
1556
+ "summary": "Issue a self-host enrollment token",
1557
+ "description": "Issues an enrollment token a self-hosted (BYOC) proxy uses to authenticate to the control plane's config/audit gRPC stream. The token is returned once and cannot be retrieved again. Requires the Scale or enterprise plan.",
1558
+ "parameters": [
1559
+ {
1560
+ "name": "org_id",
1561
+ "in": "path",
1562
+ "required": true,
1563
+ "type": "string",
1564
+ "description": "Unique organization identifier."
1565
+ }
1566
+ ],
1567
+ "requestBodyType": "{ description?: string; region_label?: string }",
1568
+ "requestBodyRequired": false,
1569
+ "responseType": "{ enrollment: { created_at: string; created_by?: string; description?: string; id: string; last_seen_at?: string; org_id: string; region_label?: string; revoked_at?: string }; token: string }",
1570
+ "responseStatus": "201"
1571
+ },
1572
+ "revokeSelfHostEnrollment": {
1573
+ "operationId": "revokeSelfHostEnrollment",
1574
+ "method": "DELETE",
1575
+ "path": "/v1/organizations/{org_id}/self-host-enrollments/{enrollment_id}",
1576
+ "summary": "Revoke a self-host enrollment",
1577
+ "description": "Revokes an enrollment so its token can no longer authenticate a proxy. Connected proxies keep their last-known config until they reconnect.",
1578
+ "parameters": [
1579
+ {
1580
+ "name": "org_id",
1581
+ "in": "path",
1582
+ "required": true,
1583
+ "type": "string",
1584
+ "description": "Unique organization identifier."
1585
+ },
1586
+ {
1587
+ "name": "enrollment_id",
1588
+ "in": "path",
1589
+ "required": true,
1590
+ "type": "string",
1591
+ "description": "Unique enrollment identifier."
1592
+ }
1593
+ ],
1594
+ "requestBodyType": "",
1595
+ "requestBodyRequired": false,
1596
+ "responseType": "",
1597
+ "responseStatus": "204"
1598
+ },
1532
1599
  "listSupportCases": {
1533
1600
  "operationId": "listSupportCases",
1534
1601
  "method": "GET",
@@ -2146,6 +2213,18 @@ Object.defineProperty(exports, '__esModule', { value: true });
2146
2213
  listRegions: {
2147
2214
  method: "GET",
2148
2215
  path: "/v1/regions"
2216
+ },
2217
+ listSelfHostEnrollments: {
2218
+ method: "GET",
2219
+ path: "/v1/organizations/{org_id}/self-host-enrollments"
2220
+ },
2221
+ createSelfHostEnrollment: {
2222
+ method: "POST",
2223
+ path: "/v1/organizations/{org_id}/self-host-enrollments"
2224
+ },
2225
+ revokeSelfHostEnrollment: {
2226
+ method: "DELETE",
2227
+ path: "/v1/organizations/{org_id}/self-host-enrollments/{enrollment_id}"
2149
2228
  }
2150
2229
  },
2151
2230
  migrations: {
@@ -2516,6 +2595,21 @@ const operationsByPath = {
2516
2595
  path: "/v1/databases/{database_id}/replicas/{replica_id}",
2517
2596
  operationId: "deleteReplica"
2518
2597
  },
2598
+ "GET /v1/organizations/{org_id}/self-host-enrollments": {
2599
+ method: "GET",
2600
+ path: "/v1/organizations/{org_id}/self-host-enrollments",
2601
+ operationId: "listSelfHostEnrollments"
2602
+ },
2603
+ "POST /v1/organizations/{org_id}/self-host-enrollments": {
2604
+ method: "POST",
2605
+ path: "/v1/organizations/{org_id}/self-host-enrollments",
2606
+ operationId: "createSelfHostEnrollment"
2607
+ },
2608
+ "DELETE /v1/organizations/{org_id}/self-host-enrollments/{enrollment_id}": {
2609
+ method: "DELETE",
2610
+ path: "/v1/organizations/{org_id}/self-host-enrollments/{enrollment_id}",
2611
+ operationId: "revokeSelfHostEnrollment"
2612
+ },
2519
2613
  "GET /v1/organizations/{org_id}/support/cases": {
2520
2614
  method: "GET",
2521
2615
  path: "/v1/organizations/{org_id}/support/cases",
@@ -1697,6 +1697,36 @@ type PlanLimits = {
1697
1697
  * @type integer
1698
1698
  */
1699
1699
  included_seats: number;
1700
+ /**
1701
+ * @description Maximum agent credentials per organization. 0 means unlimited.
1702
+ * @type integer
1703
+ */
1704
+ max_agent_credentials: number;
1705
+ /**
1706
+ * @description Agent audit-log retention window in days.
1707
+ * @type integer
1708
+ */
1709
+ audit_retention_days: number;
1710
+ /**
1711
+ * @description Maximum concurrently active instant (sandbox) branches. 0 means no limit.
1712
+ * @type integer
1713
+ */
1714
+ sandbox_max_branches: number;
1715
+ /**
1716
+ * @description Maximum upstream source-database size a sandbox base sync accepts, in bytes. 0 means no limit.
1717
+ * @type integer
1718
+ */
1719
+ sandbox_max_upstream_bytes: number;
1720
+ /**
1721
+ * @description Idle time before an instant (sandbox) branch scales to zero, in seconds.
1722
+ * @type integer
1723
+ */
1724
+ sandbox_idle_seconds: number;
1725
+ /**
1726
+ * @description Lifetime of an instant (sandbox) branch before the TTL sweep discards it, in seconds.
1727
+ * @type integer
1728
+ */
1729
+ sandbox_ttl_seconds: number;
1700
1730
  };
1701
1731
 
1702
1732
  /**
@@ -5401,6 +5431,17 @@ type CidrEntry = {
5401
5431
  label?: string;
5402
5432
  };
5403
5433
 
5434
+ /**
5435
+ * Generated by Kubb (https://kubb.dev/).
5436
+ * Do not edit manually.
5437
+ */
5438
+ declare const dataResidency: {
5439
+ readonly any: "any";
5440
+ readonly us: "us";
5441
+ readonly eu: "eu";
5442
+ };
5443
+ type DataResidencyKey = (typeof dataResidency)[keyof typeof dataResidency];
5444
+
5404
5445
  /**
5405
5446
  * Generated by Kubb (https://kubb.dev/).
5406
5447
  * Do not edit manually.
@@ -5466,6 +5507,12 @@ type Project = {
5466
5507
  * @type string | undefined
5467
5508
  */
5468
5509
  readonly cloud?: ProjectCloudEnumKey;
5510
+ /**
5511
+ * @description When true, this project\'s data plane runs in the customer\'s own VPC/cluster (BYOC): the control plane does not provision hosted infra, and a self-hosted proxy dials home over the config/audit gRPC stream. Requires the Scale or enterprise plan.\n
5512
+ * @example false
5513
+ * @type boolean | undefined
5514
+ */
5515
+ readonly self_hosted?: boolean;
5469
5516
  /**
5470
5517
  * @description Proxy hostname for connecting through PgBeam (e.g., myproject.proxy.pgbeam.app).
5471
5518
  * @type string | undefined
@@ -5501,6 +5548,13 @@ type Project = {
5501
5548
  * @type string
5502
5549
  */
5503
5550
  default_policy_profile_id?: string | null;
5551
+ /**
5552
+ * @description Data-residency requirement for the project. \"any\" (default) lets queries be served from the nearest data-plane metro. \"us\" or \"eu\" require the serving metro to be in that jurisdiction; the proxy fails a connection closed when it is served from a metro outside the required jurisdiction, so regulated workloads never process outside their permitted region.\n
5553
+ * @default "any"
5554
+ * @example eu
5555
+ * @type string | undefined
5556
+ */
5557
+ residency?: DataResidencyKey;
5504
5558
  /**
5505
5559
  * @description Project-level kill-switch. When true, ALL agent-credential connections to this project are blocked at the proxy and live agent sessions are dropped within seconds. Passthrough/human connections are unaffected.\n
5506
5560
  * @example false
@@ -5673,6 +5727,12 @@ type CreateProjectRequest = {
5673
5727
  * @type string | undefined
5674
5728
  */
5675
5729
  cloud?: CreateProjectRequestCloudEnumKey;
5730
+ /**
5731
+ * @description Mark this project as running on a self-hosted (BYOC) data plane in the customer\'s own VPC/cluster. Requires the Scale or enterprise plan.\n
5732
+ * @default false
5733
+ * @type boolean | undefined
5734
+ */
5735
+ self_hosted?: boolean;
5676
5736
  /**
5677
5737
  * @description Primary database. Created atomically with the project.
5678
5738
  * @type object
@@ -5815,6 +5875,13 @@ type UpdateProjectRequest = {
5815
5875
  * @type string
5816
5876
  */
5817
5877
  default_policy_profile_id?: string | null;
5878
+ /**
5879
+ * @description Data-residency requirement for the project. \"any\" (default) lets queries be served from the nearest data-plane metro. \"us\" or \"eu\" require the serving metro to be in that jurisdiction; the proxy fails a connection closed when it is served from a metro outside the required jurisdiction, so regulated workloads never process outside their permitted region.\n
5880
+ * @default "any"
5881
+ * @example eu
5882
+ * @type string | undefined
5883
+ */
5884
+ residency?: DataResidencyKey;
5818
5885
  /**
5819
5886
  * @description Project-level kill-switch. Set true to block ALL agent-credential connections to this project (live agent sessions are dropped within seconds); set false to re-enable them. Passthrough/human connections are unaffected. Engaging the kill-switch emits a kill_switch webhook event.\n
5820
5887
  * @example true
@@ -6347,6 +6414,244 @@ type DeleteReplicaRequestConfig = {
6347
6414
  url: `/v1/databases/${string}/replicas/${string}`;
6348
6415
  };
6349
6416
 
6417
+ /**
6418
+ * Generated by Kubb (https://kubb.dev/).
6419
+ * Do not edit manually.
6420
+ */
6421
+ /**
6422
+ * @description An enrollment that lets a self-hosted (BYOC) proxy authenticate to the control plane\'s config/audit gRPC stream on behalf of an organization. The token itself is never returned after creation, only its metadata.\n
6423
+ * @type object
6424
+ */
6425
+ type SelfHostEnrollment = {
6426
+ /**
6427
+ * @description Unique enrollment identifier.
6428
+ * @example she_01h455vb4pex5vsknk084sn02q
6429
+ * @type string
6430
+ */
6431
+ id: string;
6432
+ /**
6433
+ * @description Organization that owns this enrollment.
6434
+ * @example org_abc123
6435
+ * @type string
6436
+ */
6437
+ org_id: string;
6438
+ /**
6439
+ * @description Operator-supplied label for where the proxy runs (informational).
6440
+ * @example customer-vpc-us-east
6441
+ * @type string | undefined
6442
+ */
6443
+ region_label?: string;
6444
+ /**
6445
+ * @description Optional human-readable note.
6446
+ * @example prod cluster
6447
+ * @type string | undefined
6448
+ */
6449
+ description?: string;
6450
+ /**
6451
+ * @description User ID that created the enrollment.
6452
+ * @type string
6453
+ */
6454
+ created_by?: string | null;
6455
+ /**
6456
+ * @description When the enrollment was created.
6457
+ * @type string
6458
+ */
6459
+ created_at: string;
6460
+ /**
6461
+ * @description Last time a proxy authenticated with this enrollment.
6462
+ * @type string
6463
+ */
6464
+ last_seen_at?: string | null;
6465
+ /**
6466
+ * @description When the enrollment was revoked. Null means active.
6467
+ * @type string
6468
+ */
6469
+ revoked_at?: string | null;
6470
+ };
6471
+
6472
+ /**
6473
+ * Generated by Kubb (https://kubb.dev/).
6474
+ * Do not edit manually.
6475
+ */
6476
+
6477
+ /**
6478
+ * @description List of self-host enrollments for an organization.
6479
+ * @type object
6480
+ */
6481
+ type ListSelfHostEnrollmentsResponse = {
6482
+ /**
6483
+ * @description The organization\'s self-host enrollments, newest first.
6484
+ * @type array
6485
+ */
6486
+ enrollments: SelfHostEnrollment[];
6487
+ };
6488
+
6489
+ /**
6490
+ * Generated by Kubb (https://kubb.dev/).
6491
+ * Do not edit manually.
6492
+ */
6493
+
6494
+ /**
6495
+ * @description Unique organization identifier.
6496
+ * @pattern ^[a-zA-Z0-9_.-]+$
6497
+ * @example org_abc123
6498
+ * @type string
6499
+ */
6500
+ type ListSelfHostEnrollmentsPathOrgId = string;
6501
+ /**
6502
+ * @description List of self-host enrollments for an organization.
6503
+ * @type object
6504
+ */
6505
+ type ListSelfHostEnrollmentsStatus200 = ListSelfHostEnrollmentsResponse;
6506
+ /**
6507
+ * @type object
6508
+ */
6509
+ type ListSelfHostEnrollmentsRequestConfig = {
6510
+ data?: never;
6511
+ /**
6512
+ * @type object
6513
+ */
6514
+ pathParams: {
6515
+ org_id: ListSelfHostEnrollmentsPathOrgId;
6516
+ };
6517
+ queryParams?: never;
6518
+ headerParams?: never;
6519
+ /**
6520
+ * @type string
6521
+ */
6522
+ url: `/v1/organizations/${string}/self-host-enrollments`;
6523
+ };
6524
+
6525
+ /**
6526
+ * Generated by Kubb (https://kubb.dev/).
6527
+ * Do not edit manually.
6528
+ */
6529
+ /**
6530
+ * @description Request body for issuing a self-host enrollment token.
6531
+ * @type object
6532
+ */
6533
+ type CreateSelfHostEnrollmentRequest = {
6534
+ /**
6535
+ * @description Operator-supplied label for where the proxy runs.
6536
+ * @maxLength 100
6537
+ * @pattern ^[^\x00]*$
6538
+ * @example customer-vpc-us-east
6539
+ * @type string | undefined
6540
+ */
6541
+ region_label?: string;
6542
+ /**
6543
+ * @description Optional human-readable note.
6544
+ * @maxLength 500
6545
+ * @pattern ^[^\x00]*$
6546
+ * @example prod cluster
6547
+ * @type string | undefined
6548
+ */
6549
+ description?: string;
6550
+ };
6551
+
6552
+ /**
6553
+ * Generated by Kubb (https://kubb.dev/).
6554
+ * Do not edit manually.
6555
+ */
6556
+
6557
+ /**
6558
+ * @description Response returned once when an enrollment is created. The token is shown a single time and cannot be retrieved again; set it as GRPC_AUTH_TOKEN on the self-hosted proxy.\n
6559
+ * @type object
6560
+ */
6561
+ type SelfHostEnrollmentSecret = {
6562
+ /**
6563
+ * @description An enrollment that lets a self-hosted (BYOC) proxy authenticate to the control plane\'s config/audit gRPC stream on behalf of an organization. The token itself is never returned after creation, only its metadata.\n
6564
+ * @type object
6565
+ */
6566
+ enrollment: SelfHostEnrollment;
6567
+ /**
6568
+ * @description The plaintext enrollment token (pbh_...). Shown once.
6569
+ * @example pbh_01h455vb4pex5vsknk084sn02q9zk3m7
6570
+ * @type string
6571
+ */
6572
+ token: string;
6573
+ };
6574
+
6575
+ /**
6576
+ * Generated by Kubb (https://kubb.dev/).
6577
+ * Do not edit manually.
6578
+ */
6579
+
6580
+ /**
6581
+ * @description Unique organization identifier.
6582
+ * @pattern ^[a-zA-Z0-9_.-]+$
6583
+ * @example org_abc123
6584
+ * @type string
6585
+ */
6586
+ type CreateSelfHostEnrollmentPathOrgId = string;
6587
+ /**
6588
+ * @description Response returned once when an enrollment is created. The token is shown a single time and cannot be retrieved again; set it as GRPC_AUTH_TOKEN on the self-hosted proxy.\n
6589
+ * @type object
6590
+ */
6591
+ type CreateSelfHostEnrollmentStatus201 = SelfHostEnrollmentSecret;
6592
+ /**
6593
+ * @description Request body for issuing a self-host enrollment token.
6594
+ * @type object | undefined
6595
+ */
6596
+ type CreateSelfHostEnrollmentData = CreateSelfHostEnrollmentRequest | undefined;
6597
+ /**
6598
+ * @type object
6599
+ */
6600
+ type CreateSelfHostEnrollmentRequestConfig = {
6601
+ data?: CreateSelfHostEnrollmentData;
6602
+ /**
6603
+ * @type object
6604
+ */
6605
+ pathParams: {
6606
+ org_id: CreateSelfHostEnrollmentPathOrgId;
6607
+ };
6608
+ queryParams?: never;
6609
+ headerParams?: never;
6610
+ /**
6611
+ * @type string
6612
+ */
6613
+ url: `/v1/organizations/${string}/self-host-enrollments`;
6614
+ };
6615
+
6616
+ /**
6617
+ * Generated by Kubb (https://kubb.dev/).
6618
+ * Do not edit manually.
6619
+ */
6620
+
6621
+ /**
6622
+ * @description Unique organization identifier.
6623
+ * @pattern ^[a-zA-Z0-9_.-]+$
6624
+ * @example org_abc123
6625
+ * @type string
6626
+ */
6627
+ type RevokeSelfHostEnrollmentPathOrgId = string;
6628
+ /**
6629
+ * @description Unique enrollment identifier.
6630
+ * @pattern ^[a-zA-Z0-9_.-]+$
6631
+ * @example she_01h455vb4pex5vsknk084sn02q
6632
+ * @type string
6633
+ */
6634
+ type RevokeSelfHostEnrollmentPathEnrollmentId = string;
6635
+ /**
6636
+ * @type object
6637
+ */
6638
+ type RevokeSelfHostEnrollmentRequestConfig = {
6639
+ data?: never;
6640
+ /**
6641
+ * @type object
6642
+ */
6643
+ pathParams: {
6644
+ org_id: RevokeSelfHostEnrollmentPathOrgId;
6645
+ enrollment_id: RevokeSelfHostEnrollmentPathEnrollmentId;
6646
+ };
6647
+ queryParams?: never;
6648
+ headerParams?: never;
6649
+ /**
6650
+ * @type string
6651
+ */
6652
+ url: `/v1/organizations/${string}/self-host-enrollments/${string}`;
6653
+ };
6654
+
6350
6655
  /**
6351
6656
  * Generated by Kubb (https://kubb.dev/).
6352
6657
  * Do not edit manually.
@@ -7816,6 +8121,18 @@ declare const operationsByTag: {
7816
8121
  readonly method: "GET";
7817
8122
  readonly path: "/v1/regions";
7818
8123
  };
8124
+ readonly listSelfHostEnrollments: {
8125
+ readonly method: "GET";
8126
+ readonly path: "/v1/organizations/{org_id}/self-host-enrollments";
8127
+ };
8128
+ readonly createSelfHostEnrollment: {
8129
+ readonly method: "POST";
8130
+ readonly path: "/v1/organizations/{org_id}/self-host-enrollments";
8131
+ };
8132
+ readonly revokeSelfHostEnrollment: {
8133
+ readonly method: "DELETE";
8134
+ readonly path: "/v1/organizations/{org_id}/self-host-enrollments/{enrollment_id}";
8135
+ };
7819
8136
  };
7820
8137
  readonly migrations: {
7821
8138
  readonly lintMigration: {
@@ -8185,6 +8502,21 @@ declare const operationsByPath: {
8185
8502
  readonly path: "/v1/databases/{database_id}/replicas/{replica_id}";
8186
8503
  readonly operationId: "deleteReplica";
8187
8504
  };
8505
+ readonly "GET /v1/organizations/{org_id}/self-host-enrollments": {
8506
+ readonly method: "GET";
8507
+ readonly path: "/v1/organizations/{org_id}/self-host-enrollments";
8508
+ readonly operationId: "listSelfHostEnrollments";
8509
+ };
8510
+ readonly "POST /v1/organizations/{org_id}/self-host-enrollments": {
8511
+ readonly method: "POST";
8512
+ readonly path: "/v1/organizations/{org_id}/self-host-enrollments";
8513
+ readonly operationId: "createSelfHostEnrollment";
8514
+ };
8515
+ readonly "DELETE /v1/organizations/{org_id}/self-host-enrollments/{enrollment_id}": {
8516
+ readonly method: "DELETE";
8517
+ readonly path: "/v1/organizations/{org_id}/self-host-enrollments/{enrollment_id}";
8518
+ readonly operationId: "revokeSelfHostEnrollment";
8519
+ };
8188
8520
  readonly "GET /v1/organizations/{org_id}/support/cases": {
8189
8521
  readonly method: "GET";
8190
8522
  readonly path: "/v1/organizations/{org_id}/support/cases";
@@ -8442,6 +8774,16 @@ type CreateReplicaParams = {
8442
8774
  type DeleteReplicaParams = {
8443
8775
  pathParams: NonNullable<DeleteReplicaRequestConfig["pathParams"]>;
8444
8776
  };
8777
+ type ListSelfHostEnrollmentsParams = {
8778
+ pathParams: NonNullable<ListSelfHostEnrollmentsRequestConfig["pathParams"]>;
8779
+ };
8780
+ type CreateSelfHostEnrollmentParams = {
8781
+ pathParams: NonNullable<CreateSelfHostEnrollmentRequestConfig["pathParams"]>;
8782
+ body: NonNullable<CreateSelfHostEnrollmentRequestConfig["data"]>;
8783
+ };
8784
+ type RevokeSelfHostEnrollmentParams = {
8785
+ pathParams: NonNullable<RevokeSelfHostEnrollmentRequestConfig["pathParams"]>;
8786
+ };
8445
8787
  type ListSupportCasesParams = {
8446
8788
  pathParams: NonNullable<ListSupportCasesRequestConfig["pathParams"]>;
8447
8789
  queryParams?: NonNullable<ListSupportCasesRequestConfig["queryParams"]>;
@@ -8562,6 +8904,9 @@ interface ApiOperations {
8562
8904
  platform: {
8563
8905
  getHealth(): Promise<GetHealthStatus200>;
8564
8906
  listRegions(): Promise<ListRegionsStatus200>;
8907
+ listSelfHostEnrollments(params: ListSelfHostEnrollmentsParams): Promise<ListSelfHostEnrollmentsStatus200>;
8908
+ createSelfHostEnrollment(params: CreateSelfHostEnrollmentParams): Promise<CreateSelfHostEnrollmentStatus201>;
8909
+ revokeSelfHostEnrollment(params: RevokeSelfHostEnrollmentParams): Promise<void>;
8565
8910
  };
8566
8911
  migrations: {
8567
8912
  lintMigration(params: LintMigrationParams): Promise<LintMigrationStatus200>;
@@ -8818,6 +9163,18 @@ interface RequestMap {
8818
9163
  params: DeleteReplicaParams;
8819
9164
  response: void;
8820
9165
  };
9166
+ "GET /v1/organizations/{org_id}/self-host-enrollments": {
9167
+ params: ListSelfHostEnrollmentsParams;
9168
+ response: ListSelfHostEnrollmentsStatus200;
9169
+ };
9170
+ "POST /v1/organizations/{org_id}/self-host-enrollments": {
9171
+ params: CreateSelfHostEnrollmentParams;
9172
+ response: CreateSelfHostEnrollmentStatus201;
9173
+ };
9174
+ "DELETE /v1/organizations/{org_id}/self-host-enrollments/{enrollment_id}": {
9175
+ params: RevokeSelfHostEnrollmentParams;
9176
+ response: void;
9177
+ };
8821
9178
  "GET /v1/organizations/{org_id}/support/cases": {
8822
9179
  params: ListSupportCasesParams;
8823
9180
  response: ListSupportCasesStatus200;