@runlot/api 0.1.0-rc.182 → 0.1.0-rc.183

package/dist/schema.d.ts

@@ -4900,13 +4900,21 @@ export interface paths {
          * @description **Requires admin or higher — this spends money.** Audited as `domain.purchase`; the
          *     contact details are not retained in the audit log.
          *
+         *     **Payment comes first.** With a saved payment method the price is charged at once
+         *     and the request waits for the registration: `201` with the domain. Without one —
+         *     or with `checkout: true` — the answer is `202` with a `checkoutUrl`; the domain is
+         *     registered once that checkout is paid, and `GET /domain-charges/{chargeId}` follows
+         *     it. If the registrar refuses after payment, the payment is refunded in full. While
+         *     the registrar is in sandbox mode nothing is registered and nothing is charged.
+         *
+         *     Paying also agrees to automatic renewal: one year at the registrar's renewal price is
+         *     charged to the saved payment method 30 days before expiry (retried 7 days and 1 day
+         *     before) until auto-renew is turned off.
+         *
          *     Right after registration the domain's nameservers are set to Runlot's
          *     (`ns1~3.runlot.app`), so no separate ownership verification is needed and you can
          *     connect an app immediately. **ICANN's verification email is sent to the `contact`
          *     address** — tell the customer before they register.
-         *
-         *     Sending the same request again is safe: a completed purchase returns 200, and a
-         *     purchase that was interrupted resumes from where it stopped.
          */
         post: operations["purchaseDomain"];
         delete?: never;
@@ -5004,8 +5012,10 @@ export interface paths {
         get?: never;
         put?: never;
         /**
-         * Renews a domain (`runlot domains renew`)
-         * @description Requires admin or higher. Audited as `domain.renew`.
+         * Renews a domain now (`runlot domains renew`)
+         * @description Requires admin or higher. Audited as `domain.renew`. Paid the same way as a purchase:
+         *     a saved payment method is charged and the request waits for the renewal (`200`);
+         *     otherwise `202` with a checkout. Automatic renewal does not need this call.
          */
         post: operations["renewDomain"];
         delete?: never;
@@ -5029,9 +5039,10 @@ export interface paths {
         put?: never;
         /**
          * Changes the auto-renew preference
-         * @description Requires admin or higher. **Auto-renewal at the registrar stays on regardless** — a
-         *     domain is lost if its renewal is a day late, so Runlot renews first and bills
-         *     afterwards. Turning this setting off is not a cancellation, and the UI should say so.
+         * @description Requires admin or higher. On: one year is charged to the saved payment method 30 days
+         *     before expiry (retried 7 days and 1 day before) and the domain is renewed. Off: nothing
+         *     is charged, the registrar's own auto-renew is turned off too, and the domain lapses at
+         *     expiry unless it is renewed by hand.
          */
         post: operations["setDomainAutoRenew"];
         delete?: never;
@@ -5119,6 +5130,51 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
+    "/v1/orgs/{orgSlug}/domain-charges": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                orgSlug: components["parameters"]["OrgSlug"];
+            };
+            cookie?: never;
+        };
+        /**
+         * Domain payments, newest first (the latest 50)
+         * @description Requires member or higher. Registrations and renewals, paid or not.
+         */
+        get: operations["listDomainCharges"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/v1/orgs/{orgSlug}/domain-charges/{chargeId}": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                orgSlug: components["parameters"]["OrgSlug"];
+                chargeId: string;
+            };
+            cookie?: never;
+        };
+        /**
+         * One domain payment — what a 202 from purchase or renewal is followed with
+         * @description Requires member or higher.
+         */
+        get: operations["getDomainCharge"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     "/v1/orgs/{orgSlug}/projects/{projectName}/repos": {
         parameters: {
             query?: never;
@@ -9686,7 +9742,7 @@ export interface components {
              *     human-readable wording is produced separately by the dashboard and by email.
              * @enum {string}
              */
-            kind: "project_limit" | "db_near_cap" | "storage_near_quota" | "storage_quota_hit" | "backup_failed" | "cron_failed" | "queue_failed" | "queue_ops_cap" | "build_failed" | "restore_done" | "dns_publish_stalled" | "billing_past_due" | "overage_charge_failed" | "disabled_project_deletion" | "backup_stalled" | "backup_no_restore_point" | "backup_chain_broken" | "backup_always_full" | "budget_exhausted" | "ai_credit_low" | "ai_credit_exhausted" | "ai_autotopup_failed" | "ai_autotopup_disabled" | "license_expiring" | "license_grace" | "license_restricted" | "new_device" | "error_issue_new" | "app_out_of_memory" | "monitor_alert" | "watchdog_digest";
+            kind: "project_limit" | "db_near_cap" | "storage_near_quota" | "storage_quota_hit" | "backup_failed" | "cron_failed" | "queue_failed" | "queue_ops_cap" | "build_failed" | "restore_done" | "dns_publish_stalled" | "billing_past_due" | "overage_charge_failed" | "domain_renewal_failed" | "disabled_project_deletion" | "backup_stalled" | "backup_no_restore_point" | "backup_chain_broken" | "backup_always_full" | "budget_exhausted" | "ai_credit_low" | "ai_credit_exhausted" | "ai_autotopup_failed" | "ai_autotopup_disabled" | "license_expiring" | "license_grace" | "license_restricted" | "new_device" | "error_issue_new" | "app_out_of_memory" | "monitor_alert" | "watchdog_digest";
             /** @description If this is a project-related notification, the name of that project. Absent for org-level notifications (`project_limit`) */
             projectName?: string;
             /**
@@ -13416,6 +13472,36 @@ export interface components {
             /** @description The latest 20 lines (newest first) */
             events: components["schemas"]["DomainEvent"][];
         };
+        /**
+         * @description One payment for a domain registration or renewal. `status`: `checkout` (waiting
+         *     for the customer to pay in `checkoutUrl`), `open`/`pending` (charging the saved
+         *     card), `failed` (declined), `paid` (paid, registering), `done`, `refund_due` /
+         *     `refunded` (the registrar refused and the payment is returned), `abandoned`.
+         */
+        DomainCharge: {
+            /** Format: uuid */
+            chargeId: string;
+            /** @example example.com */
+            name: string;
+            /** @enum {string} */
+            kind: "register" | "renew";
+            years: number;
+            /** @description USD cents, before any tax Polar adds */
+            amountCents: number;
+            /** @enum {string} */
+            status: "checkout" | "open" | "pending" | "failed" | "paid" | "done" | "refund_due" | "refunded" | "abandoned";
+            /** @description Made by the automatic renewal, not by a person */
+            auto: boolean;
+            lastError?: string;
+            /** @description Only on the 202 that opened a checkout */
+            checkoutUrl?: string;
+            /** Format: date-time */
+            createdAt: string;
+            /** Format: date-time */
+            paidAt?: string;
+            /** Format: date-time */
+            settledAt?: string;
+        };
         DomainList: {
             domains: components["schemas"]["Domain"][];
             /**
@@ -22614,12 +22700,16 @@ export interface operations {
                     contact: components["schemas"]["DomainContact"];
                     /** Format: uuid */
                     projectId?: string;
+                    /** @description Pay in a checkout even when a payment method is saved. */
+                    checkout?: boolean;
+                    /** @description Where the checkout returns. Empty returns to the org's domain list. */
+                    returnTo?: string;
                 };
             };
         };
         responses: {
-            /** @description Domain already purchased (idempotent) */
-            200: {
+            /** @description Paid and registered */
+            201: {
                 headers: {
                     [name: string]: unknown;
                 };
@@ -22627,17 +22717,17 @@ export interface operations {
                     "application/json": components["schemas"]["Domain"];
                 };
             };
-            /** @description Purchase complete */
-            201: {
+            /** @description Payment is on its way: `status: checkout` carries the `checkoutUrl` to pay in; any other status is a charge still settling. Follow it with getDomainCharge. */
+            202: {
                 headers: {
                     [name: string]: unknown;
                 };
                 content: {
-                    "application/json": components["schemas"]["Domain"];
+                    "application/json": components["schemas"]["DomainCharge"];
                 };
             };
             400: components["responses"]["BadRequest"];
-            /** @description `payment_failed` — the payment was declined */
+            /** @description `payment_failed` — the saved card was declined. Retry with `checkout: true`. */
             402: {
                 headers: {
                     [name: string]: unknown;
@@ -22647,7 +22737,7 @@ export interface operations {
                 };
             };
             403: components["responses"]["Forbidden"];
-            /** @description `domain_taken`·`domain_unavailable` */
+            /** @description `domain_taken`·`domain_owned`·`domain_unavailable`·`domain_premium`·`purchase_in_progress` */
             409: {
                 headers: {
                     [name: string]: unknown;
@@ -22674,7 +22764,7 @@ export interface operations {
                     "application/json": components["schemas"]["Error"];
                 };
             };
-            /** @description `no_core`·`registrar_not_configured`·`dns_not_configured` */
+            /** @description `no_core`·`registrar_not_configured`·`dns_not_configured`·`domain_billing_off` */
             503: {
                 headers: {
                     [name: string]: unknown;
@@ -22827,11 +22917,13 @@ export interface operations {
                 "application/json": {
                     /** @default 1 */
                     years?: number;
+                    checkout?: boolean;
+                    returnTo?: string;
                 };
             };
         };
         responses: {
-            /** @description Renewed domain */
+            /** @description Paid and renewed */
             200: {
                 headers: {
                     [name: string]: unknown;
@@ -22840,9 +22932,36 @@ export interface operations {
                     "application/json": components["schemas"]["Domain"];
                 };
             };
+            /** @description Payment is on its way — see purchaseDomain */
+            202: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["DomainCharge"];
+                };
+            };
             400: components["responses"]["BadRequest"];
+            /** @description `payment_failed` — the saved card was declined */
+            402: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["Error"];
+                };
+            };
             403: components["responses"]["Forbidden"];
             404: components["responses"]["NotFound"];
+            /** @description `renewal_in_progress`·`domain_not_ready` */
+            409: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["Error"];
+                };
+            };
         };
     };
     setDomainAutoRenew: {
@@ -22966,6 +23085,56 @@ export interface operations {
             404: components["responses"]["NotFound"];
         };
     };
+    listDomainCharges: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                orgSlug: components["parameters"]["OrgSlug"];
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description Charges */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": {
+                        charges: components["schemas"]["DomainCharge"][];
+                    };
+                };
+            };
+            403: components["responses"]["Forbidden"];
+        };
+    };
+    getDomainCharge: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                orgSlug: components["parameters"]["OrgSlug"];
+                chargeId: string;
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description The charge */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["DomainCharge"];
+                };
+            };
+            403: components["responses"]["Forbidden"];
+            404: components["responses"]["NotFound"];
+        };
+    };
     listRepos: {
         parameters: {
             query?: never;