pgbeam 0.3.6 → 0.3.8

package/dist/operations.d.mts

@@ -1697,6 +1697,36 @@ type PlanLimits = {
      * @type integer
     */
     included_seats: number;
+    /**
+     * @description Maximum agent credentials per organization. 0 means unlimited.
+     * @type integer
+    */
+    max_agent_credentials: number;
+    /**
+     * @description Agent audit-log retention window in days.
+     * @type integer
+    */
+    audit_retention_days: number;
+    /**
+     * @description Maximum concurrently active instant (sandbox) branches. 0 means no limit.
+     * @type integer
+    */
+    sandbox_max_branches: number;
+    /**
+     * @description Maximum upstream source-database size a sandbox base sync accepts, in bytes. 0 means no limit.
+     * @type integer
+    */
+    sandbox_max_upstream_bytes: number;
+    /**
+     * @description Idle time before an instant (sandbox) branch scales to zero, in seconds.
+     * @type integer
+    */
+    sandbox_idle_seconds: number;
+    /**
+     * @description Lifetime of an instant (sandbox) branch before the TTL sweep discards it, in seconds.
+     * @type integer
+    */
+    sandbox_ttl_seconds: number;
 };
 
 /**
@@ -1857,6 +1887,16 @@ type OrganizationPlan = {
      * @type number
     */
     spend_limit?: number | null;
+    /**
+     * @description Whether the organization has hit its spend limit and agent access is paused at the proxy. Lifts automatically when usage resets for the new billing period, or immediately when the spend limit is raised or removed.
+     * @type boolean | undefined
+    */
+    spend_capped?: boolean;
+    /**
+     * @description When the spend cap was applied. Null when not capped.
+     * @type string
+    */
+    spend_capped_at?: string | null;
     /**
      * @description Effective usage limits enforced for an organization plan.
      * @type object
@@ -4796,6 +4836,13 @@ type PolicyProfile = {
      * @type integer | undefined
     */
     egress_bytes_per_day?: number;
+    /**
+     * @description Hard cap on rows a single write (INSERT/UPDATE/DELETE) may affect. A write whose affected-row count would exceed this is executed inside a transaction, checked, and rolled back so nothing persists, then blocked. Enforced independently of human approval. 0 means unlimited.
+     * @minLength 0
+     * @default 0
+     * @type integer | undefined
+    */
+    max_affected_rows?: number;
     /**
      * @description When the policy profile was created.
      * @type string
@@ -5024,6 +5071,13 @@ type PolicyProfileInput = {
      * @type integer | undefined
     */
     egress_bytes_per_day?: number;
+    /**
+     * @description Hard cap on rows a single write (INSERT/UPDATE/DELETE) may affect. A write whose affected-row count would exceed this is executed inside a transaction, checked, and rolled back so nothing persists, then blocked. Enforced independently of human approval. 0 means unlimited.
+     * @minLength 0
+     * @default 0
+     * @type integer | undefined
+    */
+    max_affected_rows?: number;
 };
 
 /**
@@ -5377,6 +5431,17 @@ type CidrEntry = {
     label?: string;
 };
 
+/**
+* Generated by Kubb (https://kubb.dev/).
+* Do not edit manually.
+*/
+declare const dataResidency: {
+    readonly any: "any";
+    readonly us: "us";
+    readonly eu: "eu";
+};
+type DataResidencyKey = (typeof dataResidency)[keyof typeof dataResidency];
+
 /**
 * Generated by Kubb (https://kubb.dev/).
 * Do not edit manually.
@@ -5442,6 +5507,12 @@ type Project = {
      * @type string | undefined
     */
     readonly cloud?: ProjectCloudEnumKey;
+    /**
+     * @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
+     * @example false
+     * @type boolean | undefined
+    */
+    readonly self_hosted?: boolean;
     /**
      * @description Proxy hostname for connecting through PgBeam (e.g., myproject.proxy.pgbeam.app).
      * @type string | undefined
@@ -5477,6 +5548,13 @@ type Project = {
      * @type string
     */
     default_policy_profile_id?: string | null;
+    /**
+     * @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
+     * @default "any"
+     * @example eu
+     * @type string | undefined
+    */
+    residency?: DataResidencyKey;
     /**
      * @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
      * @example false
@@ -5649,6 +5727,12 @@ type CreateProjectRequest = {
      * @type string | undefined
     */
     cloud?: CreateProjectRequestCloudEnumKey;
+    /**
+     * @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
+     * @default false
+     * @type boolean | undefined
+    */
+    self_hosted?: boolean;
     /**
      * @description Primary database. Created atomically with the project.
      * @type object
@@ -5791,6 +5875,13 @@ type UpdateProjectRequest = {
      * @type string
     */
     default_policy_profile_id?: string | null;
+    /**
+     * @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
+     * @default "any"
+     * @example eu
+     * @type string | undefined
+    */
+    residency?: DataResidencyKey;
     /**
      * @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
      * @example true
@@ -6323,6 +6414,244 @@ type DeleteReplicaRequestConfig = {
     url: `/v1/databases/${string}/replicas/${string}`;
 };
 
+/**
+* Generated by Kubb (https://kubb.dev/).
+* Do not edit manually.
+*/
+/**
+ * @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
+ * @type object
+*/
+type SelfHostEnrollment = {
+    /**
+     * @description Unique enrollment identifier.
+     * @example she_01h455vb4pex5vsknk084sn02q
+     * @type string
+    */
+    id: string;
+    /**
+     * @description Organization that owns this enrollment.
+     * @example org_abc123
+     * @type string
+    */
+    org_id: string;
+    /**
+     * @description Operator-supplied label for where the proxy runs (informational).
+     * @example customer-vpc-us-east
+     * @type string | undefined
+    */
+    region_label?: string;
+    /**
+     * @description Optional human-readable note.
+     * @example prod cluster
+     * @type string | undefined
+    */
+    description?: string;
+    /**
+     * @description User ID that created the enrollment.
+     * @type string
+    */
+    created_by?: string | null;
+    /**
+     * @description When the enrollment was created.
+     * @type string
+    */
+    created_at: string;
+    /**
+     * @description Last time a proxy authenticated with this enrollment.
+     * @type string
+    */
+    last_seen_at?: string | null;
+    /**
+     * @description When the enrollment was revoked. Null means active.
+     * @type string
+    */
+    revoked_at?: string | null;
+};
+
+/**
+* Generated by Kubb (https://kubb.dev/).
+* Do not edit manually.
+*/
+
+/**
+ * @description List of self-host enrollments for an organization.
+ * @type object
+*/
+type ListSelfHostEnrollmentsResponse = {
+    /**
+     * @description The organization\'s self-host enrollments, newest first.
+     * @type array
+    */
+    enrollments: SelfHostEnrollment[];
+};
+
+/**
+* Generated by Kubb (https://kubb.dev/).
+* Do not edit manually.
+*/
+
+/**
+ * @description Unique organization identifier.
+ * @pattern ^[a-zA-Z0-9_.-]+$
+ * @example org_abc123
+ * @type string
+*/
+type ListSelfHostEnrollmentsPathOrgId = string;
+/**
+ * @description List of self-host enrollments for an organization.
+ * @type object
+*/
+type ListSelfHostEnrollmentsStatus200 = ListSelfHostEnrollmentsResponse;
+/**
+ * @type object
+*/
+type ListSelfHostEnrollmentsRequestConfig = {
+    data?: never;
+    /**
+     * @type object
+    */
+    pathParams: {
+        org_id: ListSelfHostEnrollmentsPathOrgId;
+    };
+    queryParams?: never;
+    headerParams?: never;
+    /**
+     * @type string
+    */
+    url: `/v1/organizations/${string}/self-host-enrollments`;
+};
+
+/**
+* Generated by Kubb (https://kubb.dev/).
+* Do not edit manually.
+*/
+/**
+ * @description Request body for issuing a self-host enrollment token.
+ * @type object
+*/
+type CreateSelfHostEnrollmentRequest = {
+    /**
+     * @description Operator-supplied label for where the proxy runs.
+     * @maxLength 100
+     * @pattern ^[^\x00]*$
+     * @example customer-vpc-us-east
+     * @type string | undefined
+    */
+    region_label?: string;
+    /**
+     * @description Optional human-readable note.
+     * @maxLength 500
+     * @pattern ^[^\x00]*$
+     * @example prod cluster
+     * @type string | undefined
+    */
+    description?: string;
+};
+
+/**
+* Generated by Kubb (https://kubb.dev/).
+* Do not edit manually.
+*/
+
+/**
+ * @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
+ * @type object
+*/
+type SelfHostEnrollmentSecret = {
+    /**
+     * @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
+     * @type object
+    */
+    enrollment: SelfHostEnrollment;
+    /**
+     * @description The plaintext enrollment token (pbh_...). Shown once.
+     * @example pbh_01h455vb4pex5vsknk084sn02q9zk3m7
+     * @type string
+    */
+    token: string;
+};
+
+/**
+* Generated by Kubb (https://kubb.dev/).
+* Do not edit manually.
+*/
+
+/**
+ * @description Unique organization identifier.
+ * @pattern ^[a-zA-Z0-9_.-]+$
+ * @example org_abc123
+ * @type string
+*/
+type CreateSelfHostEnrollmentPathOrgId = string;
+/**
+ * @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
+ * @type object
+*/
+type CreateSelfHostEnrollmentStatus201 = SelfHostEnrollmentSecret;
+/**
+ * @description Request body for issuing a self-host enrollment token.
+ * @type object | undefined
+*/
+type CreateSelfHostEnrollmentData = CreateSelfHostEnrollmentRequest | undefined;
+/**
+ * @type object
+*/
+type CreateSelfHostEnrollmentRequestConfig = {
+    data?: CreateSelfHostEnrollmentData;
+    /**
+     * @type object
+    */
+    pathParams: {
+        org_id: CreateSelfHostEnrollmentPathOrgId;
+    };
+    queryParams?: never;
+    headerParams?: never;
+    /**
+     * @type string
+    */
+    url: `/v1/organizations/${string}/self-host-enrollments`;
+};
+
+/**
+* Generated by Kubb (https://kubb.dev/).
+* Do not edit manually.
+*/
+
+/**
+ * @description Unique organization identifier.
+ * @pattern ^[a-zA-Z0-9_.-]+$
+ * @example org_abc123
+ * @type string
+*/
+type RevokeSelfHostEnrollmentPathOrgId = string;
+/**
+ * @description Unique enrollment identifier.
+ * @pattern ^[a-zA-Z0-9_.-]+$
+ * @example she_01h455vb4pex5vsknk084sn02q
+ * @type string
+*/
+type RevokeSelfHostEnrollmentPathEnrollmentId = string;
+/**
+ * @type object
+*/
+type RevokeSelfHostEnrollmentRequestConfig = {
+    data?: never;
+    /**
+     * @type object
+    */
+    pathParams: {
+        org_id: RevokeSelfHostEnrollmentPathOrgId;
+        enrollment_id: RevokeSelfHostEnrollmentPathEnrollmentId;
+    };
+    queryParams?: never;
+    headerParams?: never;
+    /**
+     * @type string
+    */
+    url: `/v1/organizations/${string}/self-host-enrollments/${string}`;
+};
+
 /**
 * Generated by Kubb (https://kubb.dev/).
 * Do not edit manually.
@@ -7792,6 +8121,18 @@ declare const operationsByTag: {
             readonly method: "GET";
             readonly path: "/v1/regions";
         };
+        readonly listSelfHostEnrollments: {
+            readonly method: "GET";
+            readonly path: "/v1/organizations/{org_id}/self-host-enrollments";
+        };
+        readonly createSelfHostEnrollment: {
+            readonly method: "POST";
+            readonly path: "/v1/organizations/{org_id}/self-host-enrollments";
+        };
+        readonly revokeSelfHostEnrollment: {
+            readonly method: "DELETE";
+            readonly path: "/v1/organizations/{org_id}/self-host-enrollments/{enrollment_id}";
+        };
     };
     readonly migrations: {
         readonly lintMigration: {
@@ -8161,6 +8502,21 @@ declare const operationsByPath: {
         readonly path: "/v1/databases/{database_id}/replicas/{replica_id}";
         readonly operationId: "deleteReplica";
     };
+    readonly "GET /v1/organizations/{org_id}/self-host-enrollments": {
+        readonly method: "GET";
+        readonly path: "/v1/organizations/{org_id}/self-host-enrollments";
+        readonly operationId: "listSelfHostEnrollments";
+    };
+    readonly "POST /v1/organizations/{org_id}/self-host-enrollments": {
+        readonly method: "POST";
+        readonly path: "/v1/organizations/{org_id}/self-host-enrollments";
+        readonly operationId: "createSelfHostEnrollment";
+    };
+    readonly "DELETE /v1/organizations/{org_id}/self-host-enrollments/{enrollment_id}": {
+        readonly method: "DELETE";
+        readonly path: "/v1/organizations/{org_id}/self-host-enrollments/{enrollment_id}";
+        readonly operationId: "revokeSelfHostEnrollment";
+    };
     readonly "GET /v1/organizations/{org_id}/support/cases": {
         readonly method: "GET";
         readonly path: "/v1/organizations/{org_id}/support/cases";
@@ -8418,6 +8774,16 @@ type CreateReplicaParams = {
 type DeleteReplicaParams = {
     pathParams: NonNullable<DeleteReplicaRequestConfig["pathParams"]>;
 };
+type ListSelfHostEnrollmentsParams = {
+    pathParams: NonNullable<ListSelfHostEnrollmentsRequestConfig["pathParams"]>;
+};
+type CreateSelfHostEnrollmentParams = {
+    pathParams: NonNullable<CreateSelfHostEnrollmentRequestConfig["pathParams"]>;
+    body: NonNullable<CreateSelfHostEnrollmentRequestConfig["data"]>;
+};
+type RevokeSelfHostEnrollmentParams = {
+    pathParams: NonNullable<RevokeSelfHostEnrollmentRequestConfig["pathParams"]>;
+};
 type ListSupportCasesParams = {
     pathParams: NonNullable<ListSupportCasesRequestConfig["pathParams"]>;
     queryParams?: NonNullable<ListSupportCasesRequestConfig["queryParams"]>;
@@ -8538,6 +8904,9 @@ interface ApiOperations {
     platform: {
         getHealth(): Promise<GetHealthStatus200>;
         listRegions(): Promise<ListRegionsStatus200>;
+        listSelfHostEnrollments(params: ListSelfHostEnrollmentsParams): Promise<ListSelfHostEnrollmentsStatus200>;
+        createSelfHostEnrollment(params: CreateSelfHostEnrollmentParams): Promise<CreateSelfHostEnrollmentStatus201>;
+        revokeSelfHostEnrollment(params: RevokeSelfHostEnrollmentParams): Promise<void>;
     };
     migrations: {
         lintMigration(params: LintMigrationParams): Promise<LintMigrationStatus200>;
@@ -8794,6 +9163,18 @@ interface RequestMap {
         params: DeleteReplicaParams;
         response: void;
     };
+    "GET /v1/organizations/{org_id}/self-host-enrollments": {
+        params: ListSelfHostEnrollmentsParams;
+        response: ListSelfHostEnrollmentsStatus200;
+    };
+    "POST /v1/organizations/{org_id}/self-host-enrollments": {
+        params: CreateSelfHostEnrollmentParams;
+        response: CreateSelfHostEnrollmentStatus201;
+    };
+    "DELETE /v1/organizations/{org_id}/self-host-enrollments/{enrollment_id}": {
+        params: RevokeSelfHostEnrollmentParams;
+        response: void;
+    };
     "GET /v1/organizations/{org_id}/support/cases": {
         params: ListSupportCasesParams;
         response: ListSupportCasesStatus200;