palbase 0.42.0 → 0.43.0

package/types/cloud/src/generated/studio.d.ts

@@ -347,10 +347,10 @@ export declare function client(t: Transport): {
             signal?: AbortSignal;
         }): Promise<Reply<200, ({
             id: string;
-            organization_id: string;
             name: string;
-            created_by: string | null;
             created_at: string;
+            created_by: string | null;
+            organization_id: string;
         }) | null>>;
         addEnvironment(input: {
             path: {
@@ -1336,13 +1336,6 @@ export declare function client(t: Transport): {
             }; /** Stops the call: the request in flight, a wait before a retry, a proof-of-work being solved. */
             signal?: AbortSignal;
         }): Promise<Reply<200, {
-            environments: ({
-                platform_id: string;
-                ref: string;
-                name: string;
-                project_id: string;
-                project_name: string;
-            })[];
             organization_id: string;
             exempt: boolean;
             has_account: boolean;
@@ -1374,14 +1367,11 @@ export declare function client(t: Transport): {
             owed_micros?: number;
             projects: ({
                 project_id: string;
-                ref: string;
                 name: string;
                 plan: "free" | "pay_as_you_go";
                 paid: boolean;
-                frozen: boolean;
                 at_limit: boolean;
                 gone: boolean;
-                deleted: boolean;
                 monthly_limit_micros?: number | null;
                 charged_micros?: number;
                 gross_micros?: number;
@@ -1392,6 +1382,20 @@ export declare function client(t: Transport): {
                     gross_micros?: number;
                     micros?: number;
                 })[];
+                environments: ({
+                    id: string;
+                    ref: string;
+                    name: string;
+                    paid: boolean;
+                    frozen: boolean;
+                    deleted: boolean;
+                    items: ({
+                        item: string;
+                        units: number;
+                        gross_micros?: number;
+                        micros?: number;
+                    })[];
+                })[];
             })[];
         }>>;
         confirm(input: {
@@ -1539,13 +1543,7 @@ export declare function client(t: Transport): {
                 units: number;
                 gross_micros: number;
                 micros: number;
-                environment: ({
-                    platform_id: string;
-                    ref: string;
-                    name: string;
-                    project_id: string;
-                    project_name: string;
-                }) | null;
+                project: string | null;
             })[];
             owed_micros: {
                 [key: string]: number;
@@ -1563,9 +1561,6 @@ export declare function client(t: Transport): {
         invoices(input: {
             path: {
                 id: string;
-            };
-            query?: {
-                environment?: string;
             }; /** Stops the call: the request in flight, a wait before a retry, a proof-of-work being solved. */
             signal?: AbortSignal;
         }): Promise<Reply<200, {
@@ -1584,10 +1579,8 @@ export declare function client(t: Transport): {
                 created_at: string;
                 number: string | null;
                 environment: ({
-                    platform_id: string;
                     ref: string;
                     name: string;
-                    project_id: string;
                     project_name: string;
                 }) | null;
             })[];
@@ -1604,13 +1597,6 @@ export declare function client(t: Transport): {
             }; /** Stops the call: the request in flight, a wait before a retry, a proof-of-work being solved. */
             signal?: AbortSignal;
         }): Promise<Reply<200, {
-            environments: ({
-                platform_id: string;
-                ref: string;
-                name: string;
-                project_id: string;
-                project_name: string;
-            })[];
             organization_id: string;
             exempt: boolean;
             has_account: boolean;
@@ -1642,14 +1628,11 @@ export declare function client(t: Transport): {
             owed_micros?: number;
             projects: ({
                 project_id: string;
-                ref: string;
                 name: string;
                 plan: "free" | "pay_as_you_go";
                 paid: boolean;
-                frozen: boolean;
                 at_limit: boolean;
                 gone: boolean;
-                deleted: boolean;
                 monthly_limit_micros?: number | null;
                 charged_micros?: number;
                 gross_micros?: number;
@@ -1660,6 +1643,20 @@ export declare function client(t: Transport): {
                     gross_micros?: number;
                     micros?: number;
                 })[];
+                environments: ({
+                    id: string;
+                    ref: string;
+                    name: string;
+                    paid: boolean;
+                    frozen: boolean;
+                    deleted: boolean;
+                    items: ({
+                        item: string;
+                        units: number;
+                        gross_micros?: number;
+                        micros?: number;
+                    })[];
+                })[];
             })[];
         }>>;
         paid(input: {
@@ -1671,7 +1668,7 @@ export declare function client(t: Transport): {
             organizations: ({
                 organization_id: string;
                 name: string;
-                environments: number;
+                projects: number;
                 pay_as_you_go: number;
             })[];
         }>>;
@@ -1705,9 +1702,8 @@ export declare function client(t: Transport): {
                 owed_micros: number;
                 charged_micros: number;
                 gross_micros: number;
-                environments: ({
+                projects: ({
                     project_id: string;
-                    ref: string;
                     name: string;
                     owed_micros: number;
                     charged_micros: number;
@@ -1718,13 +1714,15 @@ export declare function client(t: Transport): {
                         gross_micros: number;
                         micros: number;
                     })[];
-                    environment: ({
-                        platform_id: string;
+                    environments: ({
+                        id: string;
                         ref: string;
                         name: string;
-                        project_id: string;
-                        project_name: string;
-                    }) | null;
+                        items: ({
+                            item: string;
+                            units: number;
+                        })[];
+                    })[];
                 })[];
             })[];
         }>>;
@@ -1737,22 +1735,19 @@ export declare function client(t: Transport): {
             }; /** Stops the call: the request in flight, a wait before a retry, a proof-of-work being solved. */
             signal?: AbortSignal;
         }): Promise<Reply<number, Response>>;
-        environment(input: {
+        project(input: {
             path: {
                 id: string;
-                ref: string;
+                project: string;
             }; /** Stops the call: the request in flight, a wait before a retry, a proof-of-work being solved. */
             signal?: AbortSignal;
         }): Promise<Reply<200, {
             project_id: string;
-            ref: string;
             name: string;
             plan: "free" | "pay_as_you_go";
             paid: boolean;
-            frozen: boolean;
             at_limit: boolean;
             gone: boolean;
-            deleted: boolean;
             monthly_limit_micros?: number | null;
             charged_micros?: number;
             gross_micros?: number;
@@ -1763,38 +1758,41 @@ export declare function client(t: Transport): {
                 gross_micros?: number;
                 micros?: number;
             })[];
-            environment: {
-                platform_id: string;
+            environments: ({
+                id: string;
                 ref: string;
                 name: string;
-                project_id: string;
-                project_name: string;
-            };
+                paid: boolean;
+                frozen: boolean;
+                deleted: boolean;
+                items: ({
+                    item: string;
+                    units: number;
+                    gross_micros?: number;
+                    micros?: number;
+                })[];
+            })[];
         }>>;
         steer(input: {
             path: {
                 id: string;
-                ref: string;
+                project: string;
             };
             headers?: {
                 "Idempotency-Key"?: string;
             };
             body?: {
                 plan?: "free" | "pay_as_you_go";
-                frozen?: boolean;
                 monthly_limit_micros?: number | null;
             }; /** Stops the call: the request in flight, a wait before a retry, a proof-of-work being solved. */
             signal?: AbortSignal;
         }): Promise<Reply<200, {
             project_id: string;
-            ref: string;
             name: string;
             plan: "free" | "pay_as_you_go";
             paid: boolean;
-            frozen: boolean;
             at_limit: boolean;
             gone: boolean;
-            deleted: boolean;
             monthly_limit_micros?: number | null;
             charged_micros?: number;
             gross_micros?: number;
@@ -1805,13 +1803,46 @@ export declare function client(t: Transport): {
                 gross_micros?: number;
                 micros?: number;
             })[];
-            environment: {
-                platform_id: string;
+            environments: ({
+                id: string;
                 ref: string;
                 name: string;
-                project_id: string;
-                project_name: string;
+                paid: boolean;
+                frozen: boolean;
+                deleted: boolean;
+                items: ({
+                    item: string;
+                    units: number;
+                    gross_micros?: number;
+                    micros?: number;
+                })[];
+            })[];
+        }>>;
+        freeze(input: {
+            path: {
+                id: string;
+                ref: string;
+            };
+            headers?: {
+                "Idempotency-Key"?: string;
             };
+            body: {
+                frozen: boolean;
+            }; /** Stops the call: the request in flight, a wait before a retry, a proof-of-work being solved. */
+            signal?: AbortSignal;
+        }): Promise<Reply<200, {
+            id: string;
+            ref: string;
+            name: string;
+            paid: boolean;
+            frozen: boolean;
+            deleted: boolean;
+            items: ({
+                item: string;
+                units: number;
+                gross_micros?: number;
+                micros?: number;
+            })[];
         }>>;
     };
     accessRequests: {

package/types/internal/src/modules/machines.d.ts

@@ -210,7 +210,7 @@ export type Machine = {
      */
     replicas: number;
     /**
-     * Kept awake: a machine of a size that sleeps is never put to sleep when idle, and is started again at once when it is asleep — while its environment has paid rights (Pay as you go), which pays its every hour. Without them it sleeps as any; a dedicated size never sleeps.
+     * Kept awake: a machine of a size that sleeps is never put to sleep when idle, and is started again at once when it is asleep — while its project is on Pay as you go, which pays its every hour. Without them it sleeps as any; a dedicated size never sleeps.
      */
     always_on: boolean;
     /**
@@ -310,7 +310,7 @@ export type MachineCreate = {
      */
     replicas?: number;
     /**
-     * Keeps it awake (Machine.always_on): open to an environment on Pay as you go, refused `always_on_not_available` otherwise.
+     * Keeps it awake (Machine.always_on): open to a project on Pay as you go, refused `always_on_not_available` otherwise.
      */
     always_on?: boolean;
     /**
@@ -407,7 +407,7 @@ export type MachineUpdate = {
      */
     replicas?: number;
     /**
-     * Whether it is kept awake from now on (Machine.always_on): no version changes. Turning it on is open to an environment on Pay as you go, refused `always_on_not_available` otherwise.
+     * Whether it is kept awake from now on (Machine.always_on): no version changes. Turning it on is open to a project on Pay as you go, refused `always_on_not_available` otherwise.
      */
     always_on?: boolean;
     /**
@@ -553,13 +553,13 @@ export type Database = {
      */
     awake_hours?: number;
     /**
-     * How long a Free environment's free and preview databases may run in a month between them, in hours (environment_awake_hours): past it, they sleep until the month ends, and a client is told so. Absent for a size with no such limit.
+     * How long a Free project's free and preview databases may run in a month between them — every environment's together, not each environment's — in hours (project_awake_hours): past it, they all sleep until the month ends, and a client is told so. Absent for a size with no such limit.
      */
     awake_hours_limit?: number;
     /**
-     * How long the environment's free and preview databases have run this month between them, deleted ones too, in hours: what awake_hours_limit holds — a database deleted and opened again gets no new hours. Present with awake_hours_limit.
+     * How long the free and preview databases of every environment of the project have run this month between them, deleted ones too, in hours: what awake_hours_limit holds — a database deleted and opened again gets no new hours. Present with awake_hours_limit.
      */
-    environment_awake_hours?: number;
+    project_awake_hours?: number;
     /**
      * How much it held when last measured — every database in it summed, the ones its owner made too — measured while it is awake. Absent before its first measure.
      */
@@ -659,7 +659,7 @@ export type DatabaseUpdate = {
      */
     backup_days?: number;
     /**
-     * The database's size (see `Database.size`); one that is paid for is open to the platform's own project and those named for it alone, as it is opened (403 `size_not_available`). One of the same machine and disk and no larger volume — hobby to free — changes in place. Any other moves through an instance of the new size beside the one that serves, made where the new size lives (a disk of its own, or a SAN volume of its own), which then takes over: the database serves on meanwhile (`state` resizing); its sessions on the direct port end once, when its primary moves, and new logins and transactions wait a few seconds for it. One asleep is woken for its move — its awake hours or disk traffic spent or not, when the size it moves to has no such limit; to one whose it has spent, it sleeps — and the move's time counts against none of them. One down for want of room, moved to a size of a larger volume, is given that room first, in place, and moves once it serves. A move that has not come to its switchover within two hours, and a second for every 10 MB the database holds, is let go: the database stays its size, and `state_reason` says why until its size is changed again — as is one whose primary went down three times before it came to its switchover. One whose primary moves where the move did not ask is stopped, both its instances kept (`state_reason`); onto its instance of the new size, ready — as a node drained moves it — it has come to its switchover. One whose instance of the new size does not take over within five minutes of its switchover says so in `state_reason`, and moves on once it does. Its disk never shrinks, and a database on a disk of its own keeps its storage (`storage_gb`) through the change. While it moves it serves with the connections of the one of the two sizes that takes fewer; the machines given it are rolled out to their share of the new size's — at once when it takes fewer, once it has moved when it takes more. A size smaller than what it holds is refused (409 `database_too_large`), as is one of a smaller quota while what it holds is not measured yet (409 `database_not_measured`, Retry-After), and so is one the project's limit has no room for (409 `machines_over_limit`), a second free database (409 `free_database_taken`), or one whose connections are too few for the copies the machines given it run (409 `database_connections_short`).
+     * The database's size (see `Database.size`); one that is paid for is open to the platform's own project and those named for it alone, as it is opened (403 `size_not_available`). One of the same machine and disk and no larger volume — hobby to free — changes in place. Any other moves through an instance of the new size beside the one that serves, made where the new size lives (a disk of its own, or a SAN volume of its own), which then takes over: the database serves on meanwhile (`state` resizing); its sessions on the direct port end once, when its primary moves, and new logins and transactions wait a few seconds for it. One asleep is woken for its move — its awake hours or disk traffic spent or not, when the size it moves to has no such limit; to one whose it has spent, it sleeps — and the move's time counts against none of them. One down for want of room, moved to a size of a larger volume, is given that room first, in place, and moves once it serves. A move that has not come to its switchover within two hours, and a second for every 10 MB the database holds, is let go: the database stays its size, and `state_reason` says why until its size is changed again — as is one whose primary went down three times before it came to its switchover. One whose primary moves where the move did not ask is stopped, both its instances kept (`state_reason`); onto its instance of the new size, ready — as a node drained moves it — it has come to its switchover. One whose instance of the new size does not take over within five minutes of its switchover says so in `state_reason`, and moves on once it does. Its disk never shrinks, and a database on a disk of its own keeps its storage (`storage_gb`) through the change. While it moves it serves with the connections of the one of the two sizes that takes fewer; the machines given it are rolled out to their share of the new size's — at once when it takes fewer, once it has moved when it takes more. A size smaller than what it holds is refused (409 `database_too_large`), as is one of a smaller quota while what it holds is not measured yet (409 `database_not_measured`, Retry-After), and so is one the project's limit has no room for (409 `machines_over_limit`), or one whose connections are too few for the copies the machines given it run (409 `database_connections_short`).
      */
     size?: "dedicated-1x" | "dedicated-2x" | "free" | "hobby" | "standard-16x" | "standard-1x" | "standard-2x" | "standard-32x" | "standard-4x" | "standard-8x" | "starter";
     /**
@@ -1035,13 +1035,13 @@ export type DatabaseCreated = {
      */
     awake_hours?: number;
     /**
-     * How long a Free environment's free and preview databases may run in a month between them, in hours (environment_awake_hours): past it, they sleep until the month ends, and a client is told so. Absent for a size with no such limit.
+     * How long a Free project's free and preview databases may run in a month between them — every environment's together, not each environment's — in hours (project_awake_hours): past it, they all sleep until the month ends, and a client is told so. Absent for a size with no such limit.
      */
     awake_hours_limit?: number;
     /**
-     * How long the environment's free and preview databases have run this month between them, deleted ones too, in hours: what awake_hours_limit holds — a database deleted and opened again gets no new hours. Present with awake_hours_limit.
+     * How long the free and preview databases of every environment of the project have run this month between them, deleted ones too, in hours: what awake_hours_limit holds — a database deleted and opened again gets no new hours. Present with awake_hours_limit.
      */
-    environment_awake_hours?: number;
+    project_awake_hours?: number;
     /**
      * How much it held when last measured — every database in it summed, the ones its owner made too — measured while it is awake. Absent before its first measure.
      */
@@ -1308,7 +1308,7 @@ export type DatabaseSize = {
      */
     storage_price_micros_per_gb_month?: number;
     /**
-     * A size counted against the project's free databases; the others are paid for.
+     * A free size: its databases, as many as the project opens, share the project's free database hours (every environment's together); the others are paid for.
      */
     free: boolean;
     /**
@@ -2409,7 +2409,7 @@ export declare function client(t: Transport): {
     /**
      * Add a domain to a machine
      *
-     * Adds a domain of the customer's own the machine answers at too, once its owner has added the records the answer names to its DNS. Refused when another environment has it (domain_taken), when it is one of the platform's, or past the environment's twenty.
+     * Adds a domain of the customer's own the machine answers at too, once its owner has added the records the answer names to its DNS. Refused when another environment has it (domain_taken), when it is one of the platform's, or past the project's domains, every environment's together: twenty on Free, a hundred on Pay as you go (too_many_domains).
      */
     addMachineDomain(input: {
         path: {
@@ -2506,7 +2506,7 @@ export declare function client(t: Transport): {
     /**
      * List database sizes
      *
-     * Every database size, the ones that sleep first: what a database of it is given and may hold, its monthly limits, and whether this project may open one of it now. A size that is not open says why (`reason`): a size that is paid for is open to a project that may pay, and the free size to a project that has not its free databases already (a deleted one counting until it is purged).
+     * Every database size, the ones that sleep first: what a database of it is given and may hold, its monthly limits, and whether this project may open one of it now. A size that is not open says why (`reason`): a size that is paid for is open to a project that may pay; the free size is open to every project, its databases of it — as many as it opens — sharing its free database hours.
      */
     listDatabaseSizes(input?: {
         signal?: AbortSignal;
@@ -3025,7 +3025,7 @@ export declare function client(t: Transport): {
     /**
      * Add a domain to a site
      *
-     * Adds a domain of the customer's own the site answers at too, once its owner has added the records the answer names to its DNS. Refused when another environment has it (domain_taken), when it is one of the platform's, or past the environment's twenty.
+     * Adds a domain of the customer's own the site answers at too, once its owner has added the records the answer names to its DNS. Refused when another environment has it (domain_taken), when it is one of the platform's, or past the project's domains, every environment's together: twenty on Free, a hundred on Pay as you go (too_many_domains).
      */
     addSiteDomain(input: {
         path: {
@@ -3112,7 +3112,7 @@ export declare function client(t: Transport): {
     /**
      * Move a machine to another environment of its project
      *
-     * Binds the machine to another environment of its project (the user's call of 2026-11-01): it takes that environment's settings, secrets and modules from its next start, and its address names it (<name>-<the environment's ref>). The operator moves it — out of the environment it leaves, into the new one at the version it serves — in its own pass: the machine says where it is moving (moving_to) until it has, a second or so, and what ran where it left answers until it is up in the new one (moved_from; ten minutes at most). It answers at the address it had too, for good (former_urls; the user's call of 2026-11-02). Its domains of its own move with it, and answer throughout: none of them may be added in the new environment too (domain_in_environment), and the new environment must have room for them (too_many_domains). Its pull requests' previews are closed; a new push opens them in the new environment. The database it is given stays where it is kept, given across environments. Its name is the project's one (name_taken when the new environment holds a machine of that name). It needs the admin role in both environments (environment_role_required); an environment's own token or key moves nothing out of it (environment_not_found).
+     * Binds the machine to another environment of its project (the user's call of 2026-11-01): it takes that environment's settings, secrets and modules from its next start, and its address names it (<name>-<the environment's ref>). The operator moves it — out of the environment it leaves, into the new one at the version it serves — in its own pass: the machine says where it is moving (moving_to) until it has, a second or so, and what ran where it left answers until it is up in the new one (moved_from; ten minutes at most). It answers at the address it had too, for good (former_urls; the user's call of 2026-11-02). Its domains of its own move with it, and answer throughout: none of them may be added in the new environment too (domain_in_environment); they are the project's, counted across its environments, and take no room there. Its pull requests' previews are closed; a new push opens them in the new environment. The database it is given stays where it is kept, given across environments. Its name is the project's one (name_taken when the new environment holds a machine of that name). It needs the admin role in both environments (environment_role_required); an environment's own token or key moves nothing out of it (environment_not_found).
      */
     moveMachine(input: {
         path: {
@@ -3124,7 +3124,7 @@ export declare function client(t: Transport): {
     /**
      * Move a site to another environment of its project
      *
-     * Binds the site to another environment of its project (the user's call of 2026-11-01), as a machine moves: the operator copies its files and releases to the new environment while it serves on where it is, then moves it — its releases, its builds, its domains of its own — in one transaction, a few seconds after the request; its address names the new environment from then on (<name>-<the environment's ref>), and it answers at the one it had too, for good (urls; the user's call of 2026-11-02). Its pull requests' previews are closed; a new push opens them in the new environment. A build of it going on is stopped and built again there; the GitHub installation it is built through is linked to the new environment when it is not. Meanwhile a change of it is refused (409 site_moving), and a move to its own environment lets the move go. The new environment must have room for it (too_many_sites, sites_full, too_many_domains), no site of its name (name_taken) and none of its domains added too (domain_in_environment). A site the platform's operator took down moves nowhere (site_taken_down). It needs the admin role in both environments (environment_role_required); an environment's own token or key moves nothing out of it (environment_not_found). A move that cannot be made is let go of, and the site says why (move_note).
+     * Binds the site to another environment of its project (the user's call of 2026-11-01), as a machine moves: the operator copies its files and releases to the new environment while it serves on where it is, then moves it — its releases, its builds, its domains of its own — in one transaction, a few seconds after the request; its address names the new environment from then on (<name>-<the environment's ref>), and it answers at the one it had too, for good (urls; the user's call of 2026-11-02). Its pull requests' previews are closed; a new push opens them in the new environment. A build of it going on is stopped and built again there; the GitHub installation it is built through is linked to the new environment when it is not. Meanwhile a change of it is refused (409 site_moving), and a move to its own environment lets the move go. The new environment must have room for a site more (too_many_sites), no site of its name (name_taken) and none of its domains added too (domain_in_environment); its files and its domains are the project's, counted across its environments, and take no room there. A site the platform's operator took down moves nowhere (site_taken_down). It needs the admin role in both environments (environment_role_required); an environment's own token or key moves nothing out of it (environment_not_found). A move that cannot be made is let go of, and the site says why (move_note).
      */
     moveSite(input: {
         path: {
@@ -3136,7 +3136,7 @@ export declare function client(t: Transport): {
     /**
      * Move a database to another environment of its project
      *
-     * Binds the database to another environment of its project (the user's call of 2026-11-01): what it is — its row, what it is counted and paid for from then on, its address — becomes the new environment's, a few seconds after the request; what holds its data stays where it was made, so nothing is copied and it answers throughout. Its host names the new environment from then on (<name>-<the environment's ref>), and the one it had answers too, for good (former_hosts; the user's call of 2026-11-02); the machines given it are rolled out to the new host, beside the version that serves. Its migrations are the machines' of the environment that keeps it: the machines that run them move with it when with_machines says so — said to move in one step, each after the database — or the move is refused (migrations_where_kept, with the machines). A pull request preview's own database moves with nothing (preview_database); one being resized, restored or archived moves once that is done (database_busy). The new environment must have room for it as for a database opened there (free_database_taken, too_many_databases, size_not_available, backup_days_not_available) and no database of its name (name_taken). Meanwhile a change of it is refused (409 database_moving), and a move to its own environment lets the move go. It needs the admin role in both environments (environment_role_required); an environment's own token or key moves nothing out of it (environment_not_found). A move that cannot be made is let go of, and the database says why (move_note).
+     * Binds the database to another environment of its project (the user's call of 2026-11-01): what it is — its row, what it is counted and paid for from then on, its address — becomes the new environment's, a few seconds after the request; what holds its data stays where it was made, so nothing is copied and it answers throughout. Its host names the new environment from then on (<name>-<the environment's ref>), and the one it had answers too, for good (former_hosts; the user's call of 2026-11-02); the machines given it are rolled out to the new host, beside the version that serves. Its migrations are the machines' of the environment that keeps it: the machines that run them move with it when with_machines says so — said to move in one step, each after the database — or the move is refused (migrations_where_kept, with the machines). A pull request preview's own database moves with nothing (preview_database); one being resized, restored or archived moves once that is done (database_busy). The new environment must have room for it as for a database opened there (too_many_databases, size_not_available, backup_days_not_available) and no database of its name (name_taken). Meanwhile a change of it is refused (409 database_moving), and a move to its own environment lets the move go. It needs the admin role in both environments (environment_role_required); an environment's own token or key moves nothing out of it (environment_not_found). A move that cannot be made is let go of, and the database says why (move_note).
      */
     moveDatabase(input: {
         path: {