@runlot/api 0.1.0-rc.35 → 0.1.0-rc.37

package/dist/schema.d.ts

@@ -100,6 +100,34 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
+    "/v1/hooks/polar": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        /**
+         * Polar 결제 웹훅 (docs/billing.md)
+         * @description 사용자가 부르는 경로가 아니다. Polar 가 구독 사건을 여기에 배달한다.
+         *     인증은 토큰이 아니라 **Standard Webhooks 서명**이다 — `webhook-id`·
+         *     `webhook-timestamp`·`webhook-signature` 셋과 서버의
+         *     `RUNLOT_POLAR_WEBHOOK_SECRET` 으로 검증한다 (아니면 403, 시각 ±5 분).
+         *     같은 `webhook-id` 는 한 번만 적용한다 (재전달은 200 이고 무시).
+         *
+         *     `orgs.plan` 을 바꾸는 유일한 자리다: `subscription.active`·`updated` 의
+         *     status `active`/`trialing`/`past_due` 는 pro, 그 밖(`canceled`·`unpaid`…)은
+         *     free. 서버에 토큰이 없으면 501. 클라이언트 라이브러리는 부르지 않는다.
+         */
+        post: operations["polarHook"];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     "/v1/me": {
         parameters: {
             query?: never;
@@ -1225,6 +1253,136 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
+    "/v1/orgs/{orgSlug}/billing": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                orgSlug: components["parameters"]["OrgSlug"];
+            };
+            cookie?: never;
+        };
+        /**
+         * 조직의 요금제와 결제 상태 (docs/billing.md)
+         * @description 요금제(`plan`)와, 프로면 그 상태(`status`: active · past_due · canceled)와
+         *     현재 기간의 끝(`periodEnd`)을 준다. `enabled` 가 거짓이면 이 배치에
+         *     결제가 설정되지 않은 것이다 — 화면은 문의 주소만 둔다. `sandbox` 가 참이면
+         *     Polar 의 테스트 환경이라 실제 청구가 없다.
+         *
+         *     `limits` 는 두 요금제의 한도 표다 (cp/internal/plan). 화면에 숫자를 두지
+         *     않는 이유는 `OrgMembership.projectLimit` 과 같다. viewer 이상.
+         */
+        get: operations["getBilling"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/v1/orgs/{orgSlug}/billing/checkout": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                orgSlug: components["parameters"]["OrgSlug"];
+            };
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        /**
+         * 프로 요금제 체크아웃 세션을 만든다
+         * @description Polar 체크아웃 세션 하나를 만들고 그 `url` 을 준다. 대시보드는 그 URL 을
+         *     **자기 페이지 위의 iframe** 으로 띄운다 (`@polar-sh/checkout`; 세션의
+         *     `embed_origin` 은 `returnTo` 의 origin). 결제가 끝나도 **그것이 요금제를
+         *     바꾸지는 않는다**: 요금제는 웹훅(`/v1/hooks/polar`)이 바꾼다. 화면은
+         *     성공 사건 뒤 상태를 다시 읽는다.
+         *
+         *     `returnTo` 는 서버의 `RUNLOT_PUBLIC_URL` 아래여야 한다 (아니면 400).
+         *     이미 프로면 409 `already_pro` — 포털을 열어야 한다. admin.
+         */
+        post: operations["createBillingCheckout"];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/v1/orgs/{orgSlug}/billing/portal": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                orgSlug: components["parameters"]["OrgSlug"];
+            };
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        /**
+         * 고객 포털 세션을 만든다 (결제 수단·영수증·해지)
+         * @description Polar 고객 포털의 일회용 `url` 을 준다. 결제 수단 변경·영수증·해지는
+         *     전부 거기서 한다 — 우리 화면에 그 폼을 두지 않는다 (카드 번호가 우리
+         *     서버를 지나지 않는 것이 MoR 의 값이다). 한 번도 결제한 적 없는 org 는
+         *     404. admin.
+         */
+        post: operations["createBillingPortal"];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/v1/orgs/{orgSlug}/billing/session": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                orgSlug: components["parameters"]["OrgSlug"];
+            };
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        /**
+         * 고객 세션 토큰 (결제 수단 임베드의 인증)
+         * @description `@polar-sh/checkout` 의 결제 수단 임베드가 요구하는 고객 세션 토큰. 1 시간,
+         *     그 고객 하나. 화면이 열릴 때마다 새로 받는다. 결제 이력 없는 org 는 404. admin.
+         */
+        post: operations["createBillingSession"];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/v1/orgs/{orgSlug}/billing/cancel": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                orgSlug: components["parameters"]["OrgSlug"];
+            };
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        /**
+         * 기간 끝 해지를 예약하거나 되돌린다
+         * @description `cancel: true` 면 현재 기간이 끝나는 날 프로가 끝난다 (그날까지는 프로) —
+         *     Polar 의 `cancel_at_period_end`. `false` 면 예약을 되돌린다. 즉시 회수는 없다:
+         *     낸 기간은 다 쓴다. 응답으로 우리 행의 `status` 를 바로 맞추고, 웹훅도 곧
+         *     같은 결론으로 온다. 프로가 아니면 409 `not_pro`. admin.
+         */
+        post: operations["cancelBilling"];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     "/v1/orgs/{orgSlug}/members": {
         parameters: {
             query?: never;
@@ -3053,6 +3211,40 @@ export interface components {
             /** @description 이 org 의 보관 일수 */
             keepDays: number;
         };
+        BillingStatus: {
+            /** @description 이 배치에 결제가 설정돼 있다 */
+            enabled: boolean;
+            /** @description Polar 테스트 환경 — 실제 청구 없음 */
+            sandbox: boolean;
+            /** @enum {string} */
+            plan: "free" | "pro";
+            /**
+             * @description 프로의 상태. canceled 는 기간 끝까지 프로. free 는 없다
+             * @enum {string}
+             */
+            status?: "active" | "past_due" | "canceled";
+            /**
+             * Format: date-time
+             * @description 현재 결제 기간의 끝
+             */
+            periodEnd?: string;
+            /** @description 결제 이력이 있어 포털을 열 수 있다 */
+            hasPortal: boolean;
+            limits: {
+                free: components["schemas"]["PlanLimits"];
+                pro: components["schemas"]["PlanLimits"];
+            };
+        };
+        /** @description 요금제 하나의 한도 (docs/limits.md §1) */
+        PlanLimits: {
+            projects: number;
+            /** Format: int64 */
+            storageBytes: number;
+            /** @description 보존 세대 수 (= 시간) */
+            backupKeep: number;
+            crons: number;
+            mailPerHour: number;
+        };
         /**
          * @description 프로젝트 전용 오브젝트 스토리지 상태다 (docs/storage.md §7).
          *
@@ -3675,6 +3867,43 @@ export interface operations {
             };
         };
     };
+    polarHook: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody: {
+            content: {
+                "application/json": Record<string, never>;
+            };
+        };
+        responses: {
+            /** @description 받았다 (`applied` 가 참이면 요금제를 바꿨다) */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+            400: components["responses"]["BadRequest"];
+            /** @description 서명이 맞지 않는다 */
+            403: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+            /** @description 결제가 꺼져 있다 */
+            501: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+        };
+    };
     getMe: {
         parameters: {
             query?: never;
@@ -5411,6 +5640,241 @@ export interface operations {
             404: components["responses"]["NotFound"];
         };
     };
+    getBilling: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                orgSlug: components["parameters"]["OrgSlug"];
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description 결제 상태 */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["BillingStatus"];
+                };
+            };
+            403: components["responses"]["Forbidden"];
+            404: components["responses"]["NotFound"];
+        };
+    };
+    createBillingCheckout: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                orgSlug: components["parameters"]["OrgSlug"];
+            };
+            cookie?: never;
+        };
+        requestBody: {
+            content: {
+                "application/json": {
+                    /** Format: uri */
+                    returnTo: string;
+                };
+            };
+        };
+        responses: {
+            /** @description 체크아웃 세션 */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": {
+                        /** Format: uri */
+                        url: string;
+                        checkoutId: string;
+                    };
+                };
+            };
+            400: components["responses"]["BadRequest"];
+            403: components["responses"]["Forbidden"];
+            404: components["responses"]["NotFound"];
+            /** @description `already_pro` */
+            409: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["Error"];
+                };
+            };
+            /** @description `billing_off` — 결제가 설정되지 않았다 */
+            501: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+            /** @description `billing_unavailable` — Polar 가 응답하지 않는다 */
+            502: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+        };
+    };
+    createBillingPortal: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                orgSlug: components["parameters"]["OrgSlug"];
+            };
+            cookie?: never;
+        };
+        requestBody: {
+            content: {
+                "application/json": {
+                    /** Format: uri */
+                    returnTo: string;
+                };
+            };
+        };
+        responses: {
+            /** @description 포털 세션 */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": {
+                        /** Format: uri */
+                        url: string;
+                    };
+                };
+            };
+            400: components["responses"]["BadRequest"];
+            403: components["responses"]["Forbidden"];
+            404: components["responses"]["NotFound"];
+            /** @description `billing_off` */
+            501: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+            /** @description `billing_unavailable` */
+            502: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+        };
+    };
+    createBillingSession: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                orgSlug: components["parameters"]["OrgSlug"];
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description 고객 세션 */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": {
+                        token: string;
+                        /** Format: date-time */
+                        expiresAt: string;
+                    };
+                };
+            };
+            403: components["responses"]["Forbidden"];
+            404: components["responses"]["NotFound"];
+            /** @description `billing_off` */
+            501: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+            /** @description `billing_unavailable` */
+            502: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+        };
+    };
+    cancelBilling: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                orgSlug: components["parameters"]["OrgSlug"];
+            };
+            cookie?: never;
+        };
+        requestBody: {
+            content: {
+                "application/json": {
+                    cancel: boolean;
+                    /** @enum {string} */
+                    reason?: "customer_service" | "low_quality" | "missing_features" | "switched_service" | "too_complex" | "too_expensive" | "unused" | "other";
+                    comment?: string;
+                };
+            };
+        };
+        responses: {
+            /** @description 바뀐 상태 */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": {
+                        /** @enum {string} */
+                        status: "active" | "canceled";
+                        /** Format: date-time */
+                        periodEnd: string;
+                    };
+                };
+            };
+            403: components["responses"]["Forbidden"];
+            404: components["responses"]["NotFound"];
+            /** @description `not_pro` */
+            409: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["Error"];
+                };
+            };
+            /** @description `billing_off` */
+            501: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+            /** @description `billing_unavailable` */
+            502: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+        };
+    };
     listMembers: {
         parameters: {
             query?: never;