tapimo 0.1.0 → 0.3.0

package/dist/apps/platform/routes/invitations.d.ts

@@ -0,0 +1,851 @@
+import * as z from 'zod/mini';
+import * as Response from '../../../internal/Response.js';
+import type { Environment } from '../App.js';
+/** Zod schemas owned by the invitations resource. */
+export declare namespace schema {
+    /** One pending invitation. */
+    const Invitation: z.ZodMiniObject<{
+        createdAt: z.ZodMiniString<string>;
+        email: z.ZodMiniString<string>;
+        expiresAt: z.ZodMiniString<string>;
+        id: z.ZodMiniString<string>;
+        invitedBy: z.ZodMiniString<string>;
+        orgId: z.ZodMiniString<string>;
+        role: z.ZodMiniEnum<{
+            admin: "admin";
+            member: "member";
+            owner: "owner";
+        }>;
+    }, z.core.$strip>;
+    /** Path parameters addressing an organization's invitation collection. */
+    const Params: z.ZodMiniObject<{
+        orgId: z.ZodMiniString<string>;
+    }, z.core.$strip>;
+    /** Path parameters addressing one org-scoped invitation. */
+    const InvitationParams: z.ZodMiniObject<{
+        invitationId: z.ZodMiniString<string>;
+        orgId: z.ZodMiniString<string>;
+    }, z.core.$strip>;
+    /** Path parameters addressing one of the caller's invitations. */
+    const AcceptParams: z.ZodMiniObject<{
+        invitationId: z.ZodMiniString<string>;
+    }, z.core.$strip>;
+    /** Request body creating an invitation. */
+    const InvitationBody: z.ZodMiniObject<{
+        email: z.ZodMiniEmail;
+        role: z.ZodMiniEnum<{
+            admin: "admin";
+            member: "member";
+            owner: "owner";
+        }>;
+    }, z.core.$strip>;
+    /** Schemas for the listInvitations / listMyInvitations operations. */
+    namespace listInvitations {
+        /** Non-paginated list of pending invitations. */
+        const Response: z.ZodMiniObject<{
+            data: z.ZodMiniArray<z.ZodMiniObject<{
+                createdAt: z.ZodMiniString<string>;
+                email: z.ZodMiniString<string>;
+                expiresAt: z.ZodMiniString<string>;
+                id: z.ZodMiniString<string>;
+                invitedBy: z.ZodMiniString<string>;
+                orgId: z.ZodMiniString<string>;
+                role: z.ZodMiniEnum<{
+                    admin: "admin";
+                    member: "member";
+                    owner: "owner";
+                }>;
+            }, z.core.$strip>>;
+        }, z.core.$strip>;
+    }
+    /** Schemas for the listMyInvitations operation. */
+    namespace listMyInvitations {
+        /** A pending invitation addressed to the caller, with the inviting org's name. */
+        const Item: z.ZodMiniObject<{
+            createdAt: z.ZodMiniString<string>;
+            email: z.ZodMiniString<string>;
+            expiresAt: z.ZodMiniString<string>;
+            id: z.ZodMiniString<string>;
+            invitedBy: z.ZodMiniString<string>;
+            orgId: z.ZodMiniString<string>;
+            role: z.ZodMiniEnum<{
+                admin: "admin";
+                member: "member";
+                owner: "owner";
+            }>;
+            orgName: z.ZodMiniString<string>;
+        }, z.core.$strip>;
+        /** Non-paginated list of the caller's pending invitations. */
+        const Response: z.ZodMiniObject<{
+            data: z.ZodMiniArray<z.ZodMiniObject<{
+                createdAt: z.ZodMiniString<string>;
+                email: z.ZodMiniString<string>;
+                expiresAt: z.ZodMiniString<string>;
+                id: z.ZodMiniString<string>;
+                invitedBy: z.ZodMiniString<string>;
+                orgId: z.ZodMiniString<string>;
+                role: z.ZodMiniEnum<{
+                    admin: "admin";
+                    member: "member";
+                    owner: "owner";
+                }>;
+                orgName: z.ZodMiniString<string>;
+            }, z.core.$strip>>;
+        }, z.core.$strip>;
+    }
+    /** Schemas for the acceptInvitation operation. */
+    namespace acceptInvitation {
+        /** The membership granted by accepting. */
+        const Response: z.ZodMiniObject<{
+            orgId: z.ZodMiniString<string>;
+            role: z.ZodMiniEnum<{
+                admin: "admin";
+                member: "member";
+                owner: "owner";
+            }>;
+            userId: z.ZodMiniString<string>;
+        }, z.core.$strip>;
+    }
+    /** Schemas for the declineInvitation operation. */
+    namespace declineInvitation {
+        /** Confirmation that the invitation was declined. */
+        const Response: z.ZodMiniObject<{
+            id: z.ZodMiniString<string>;
+        }, z.core.$strip>;
+    }
+    /** Schemas for the revokeInvitation operation. */
+    namespace revokeInvitation {
+        /** Confirmation that the invitation was revoked. */
+        const Response: z.ZodMiniObject<{
+            id: z.ZodMiniString<string>;
+        }, z.core.$strip>;
+    }
+}
+/**
+ * Mounts the invitations surface: org-scoped management
+ * (`/orgs/:orgId/invitations`, admins and owners) plus the invitee's side
+ * (`/invitations`, matched against the session's verified email). Invitation
+ * emails dispatch through the sender the platform group publishes on context
+ * (`c.get('email')`), best-effort.
+ */
+export declare function invitations(): import("hono/hono-base").HonoBase<Environment, {
+    "/v1/orgs/:orgId{org_[A-Za-z0-9_-]+}/invitations": {
+        $post: {
+            output: {
+                error: {
+                    code: "api_key_malformed";
+                    details?: readonly Response.error.Detail[] | undefined;
+                    message: string;
+                };
+                requestId: string;
+            };
+            outputFormat: "json";
+            status: 400;
+            input: {
+                param: {
+                    orgId: string;
+                };
+            } & {
+                json: {
+                    email: string;
+                    role: "admin" | "member" | "owner";
+                };
+            };
+        } | {
+            output: {
+                error: {
+                    code: "api_key_invalid" | "api_key_missing";
+                    details?: readonly Response.error.Detail[] | undefined;
+                    message: string;
+                };
+                requestId: string;
+            };
+            outputFormat: "json";
+            status: 401;
+            input: {
+                param: {
+                    orgId: string;
+                };
+            } & {
+                json: {
+                    email: string;
+                    role: "admin" | "member" | "owner";
+                };
+            };
+        } | {
+            output: {
+                error: {
+                    code: "upstream_error";
+                    details?: readonly Response.error.Detail[] | undefined;
+                    message: string;
+                };
+                requestId: string;
+            };
+            outputFormat: "json";
+            status: 502;
+            input: {
+                param: {
+                    orgId: string;
+                };
+            } & {
+                json: {
+                    email: string;
+                    role: "admin" | "member" | "owner";
+                };
+            };
+        } | {
+            output: {
+                error: {
+                    code: "body_invalid";
+                    details?: readonly Response.error.Detail[] | undefined;
+                    message: string;
+                };
+                requestId: string;
+            };
+            outputFormat: "json";
+            status: 400;
+            input: {
+                param: {
+                    orgId: string;
+                };
+            } & {
+                json: {
+                    email: string;
+                    role: "admin" | "member" | "owner";
+                };
+            };
+        } | {
+            output: {
+                error: {
+                    code: "param_invalid";
+                    details?: readonly Response.error.Detail[] | undefined;
+                    message: string;
+                };
+                requestId: string;
+            };
+            outputFormat: "json";
+            status: 400;
+            input: {
+                param: {
+                    orgId: string;
+                };
+            } & {
+                json: {
+                    email: string;
+                    role: "admin" | "member" | "owner";
+                };
+            };
+        } | {
+            output: {
+                error: {
+                    code: "forbidden";
+                    details?: readonly Response.error.Detail[] | undefined;
+                    message: string;
+                };
+                requestId: string;
+            };
+            outputFormat: "json";
+            status: 403;
+            input: {
+                param: {
+                    orgId: string;
+                };
+            } & {
+                json: {
+                    email: string;
+                    role: "admin" | "member" | "owner";
+                };
+            };
+        } | {
+            output: {
+                error: {
+                    code: "organization_not_found";
+                    details?: readonly Response.error.Detail[] | undefined;
+                    message: string;
+                };
+                requestId: string;
+            };
+            outputFormat: "json";
+            status: 404;
+            input: {
+                param: {
+                    orgId: string;
+                };
+            } & {
+                json: {
+                    email: string;
+                    role: "admin" | "member" | "owner";
+                };
+            };
+        } | {
+            output: {
+                createdAt: string;
+                email: string;
+                expiresAt: string;
+                id: string;
+                invitedBy: string;
+                orgId: string;
+                role: "admin" | "member" | "owner";
+            };
+            outputFormat: "json";
+            status: 200;
+            input: {
+                param: {
+                    orgId: string;
+                };
+            } & {
+                json: {
+                    email: string;
+                    role: "admin" | "member" | "owner";
+                };
+            };
+        };
+    };
+} & {
+    "/v1/orgs/:orgId{org_[A-Za-z0-9_-]+}/invitations": {
+        $get: {
+            output: {
+                error: {
+                    code: "api_key_malformed";
+                    details?: readonly Response.error.Detail[] | undefined;
+                    message: string;
+                };
+                requestId: string;
+            };
+            outputFormat: "json";
+            status: 400;
+            input: {
+                param: {
+                    orgId: string;
+                };
+            };
+        } | {
+            output: {
+                error: {
+                    code: "api_key_invalid" | "api_key_missing";
+                    details?: readonly Response.error.Detail[] | undefined;
+                    message: string;
+                };
+                requestId: string;
+            };
+            outputFormat: "json";
+            status: 401;
+            input: {
+                param: {
+                    orgId: string;
+                };
+            };
+        } | {
+            output: {
+                error: {
+                    code: "upstream_error";
+                    details?: readonly Response.error.Detail[] | undefined;
+                    message: string;
+                };
+                requestId: string;
+            };
+            outputFormat: "json";
+            status: 502;
+            input: {
+                param: {
+                    orgId: string;
+                };
+            };
+        } | {
+            output: {
+                error: {
+                    code: "param_invalid";
+                    details?: readonly Response.error.Detail[] | undefined;
+                    message: string;
+                };
+                requestId: string;
+            };
+            outputFormat: "json";
+            status: 400;
+            input: {
+                param: {
+                    orgId: string;
+                };
+            };
+        } | {
+            output: {
+                error: {
+                    code: "forbidden";
+                    details?: readonly Response.error.Detail[] | undefined;
+                    message: string;
+                };
+                requestId: string;
+            };
+            outputFormat: "json";
+            status: 403;
+            input: {
+                param: {
+                    orgId: string;
+                };
+            };
+        } | {
+            output: {
+                error: {
+                    code: "organization_not_found";
+                    details?: readonly Response.error.Detail[] | undefined;
+                    message: string;
+                };
+                requestId: string;
+            };
+            outputFormat: "json";
+            status: 404;
+            input: {
+                param: {
+                    orgId: string;
+                };
+            };
+        } | {
+            output: {
+                data: {
+                    createdAt: string;
+                    email: string;
+                    expiresAt: string;
+                    id: string;
+                    invitedBy: string;
+                    orgId: string;
+                    role: "admin" | "member" | "owner";
+                }[];
+            };
+            outputFormat: "json";
+            status: 200;
+            input: {
+                param: {
+                    orgId: string;
+                };
+            };
+        };
+    };
+} & {
+    "/v1/orgs/:orgId{org_[A-Za-z0-9_-]+}/invitations/:invitationId{inv_[A-Za-z0-9_-]+}": {
+        $delete: {
+            output: {
+                error: {
+                    code: "api_key_malformed";
+                    details?: readonly Response.error.Detail[] | undefined;
+                    message: string;
+                };
+                requestId: string;
+            };
+            outputFormat: "json";
+            status: 400;
+            input: {
+                param: {
+                    invitationId: string;
+                    orgId: string;
+                };
+            };
+        } | {
+            output: {
+                error: {
+                    code: "api_key_invalid" | "api_key_missing";
+                    details?: readonly Response.error.Detail[] | undefined;
+                    message: string;
+                };
+                requestId: string;
+            };
+            outputFormat: "json";
+            status: 401;
+            input: {
+                param: {
+                    invitationId: string;
+                    orgId: string;
+                };
+            };
+        } | {
+            output: {
+                error: {
+                    code: "upstream_error";
+                    details?: readonly Response.error.Detail[] | undefined;
+                    message: string;
+                };
+                requestId: string;
+            };
+            outputFormat: "json";
+            status: 502;
+            input: {
+                param: {
+                    invitationId: string;
+                    orgId: string;
+                };
+            };
+        } | {
+            output: {
+                error: {
+                    code: "param_invalid";
+                    details?: readonly Response.error.Detail[] | undefined;
+                    message: string;
+                };
+                requestId: string;
+            };
+            outputFormat: "json";
+            status: 400;
+            input: {
+                param: {
+                    invitationId: string;
+                    orgId: string;
+                };
+            };
+        } | {
+            output: {
+                error: {
+                    code: "forbidden";
+                    details?: readonly Response.error.Detail[] | undefined;
+                    message: string;
+                };
+                requestId: string;
+            };
+            outputFormat: "json";
+            status: 403;
+            input: {
+                param: {
+                    invitationId: string;
+                    orgId: string;
+                };
+            };
+        } | {
+            output: {
+                error: {
+                    code: "organization_not_found";
+                    details?: readonly Response.error.Detail[] | undefined;
+                    message: string;
+                };
+                requestId: string;
+            };
+            outputFormat: "json";
+            status: 404;
+            input: {
+                param: {
+                    invitationId: string;
+                    orgId: string;
+                };
+            };
+        } | {
+            output: {
+                error: {
+                    code: "invitation_not_found";
+                    details?: readonly Response.error.Detail[] | undefined;
+                    message: string;
+                };
+                requestId: string;
+            };
+            outputFormat: "json";
+            status: 404;
+            input: {
+                param: {
+                    invitationId: string;
+                    orgId: string;
+                };
+            };
+        } | {
+            output: {
+                id: string;
+            };
+            outputFormat: "json";
+            status: 200;
+            input: {
+                param: {
+                    invitationId: string;
+                    orgId: string;
+                };
+            };
+        };
+    };
+} & {
+    "/v1/invitations": {
+        $get: {
+            output: {
+                error: {
+                    code: "api_key_malformed";
+                    details?: readonly Response.error.Detail[] | undefined;
+                    message: string;
+                };
+                requestId: string;
+            };
+            outputFormat: "json";
+            status: 400;
+            input: {};
+        } | {
+            output: {
+                error: {
+                    code: "api_key_invalid" | "api_key_missing";
+                    details?: readonly Response.error.Detail[] | undefined;
+                    message: string;
+                };
+                requestId: string;
+            };
+            outputFormat: "json";
+            status: 401;
+            input: {};
+        } | {
+            output: {
+                error: {
+                    code: "upstream_error";
+                    details?: readonly Response.error.Detail[] | undefined;
+                    message: string;
+                };
+                requestId: string;
+            };
+            outputFormat: "json";
+            status: 502;
+            input: {};
+        } | {
+            output: {
+                error: {
+                    code: "forbidden";
+                    details?: readonly Response.error.Detail[] | undefined;
+                    message: string;
+                };
+                requestId: string;
+            };
+            outputFormat: "json";
+            status: 403;
+            input: {};
+        } | {
+            output: {
+                data: {
+                    createdAt: string;
+                    email: string;
+                    expiresAt: string;
+                    id: string;
+                    invitedBy: string;
+                    orgId: string;
+                    role: "admin" | "member" | "owner";
+                    orgName: string;
+                }[];
+            };
+            outputFormat: "json";
+            status: 200;
+            input: {};
+        };
+    };
+} & {
+    "/v1/invitations/:invitationId{inv_[A-Za-z0-9_-]+}/accept": {
+        $post: {
+            output: {
+                error: {
+                    code: "api_key_malformed";
+                    details?: readonly Response.error.Detail[] | undefined;
+                    message: string;
+                };
+                requestId: string;
+            };
+            outputFormat: "json";
+            status: 400;
+            input: {
+                param: {
+                    invitationId: string;
+                };
+            };
+        } | {
+            output: {
+                error: {
+                    code: "api_key_invalid" | "api_key_missing";
+                    details?: readonly Response.error.Detail[] | undefined;
+                    message: string;
+                };
+                requestId: string;
+            };
+            outputFormat: "json";
+            status: 401;
+            input: {
+                param: {
+                    invitationId: string;
+                };
+            };
+        } | {
+            output: {
+                error: {
+                    code: "upstream_error";
+                    details?: readonly Response.error.Detail[] | undefined;
+                    message: string;
+                };
+                requestId: string;
+            };
+            outputFormat: "json";
+            status: 502;
+            input: {
+                param: {
+                    invitationId: string;
+                };
+            };
+        } | {
+            output: {
+                error: {
+                    code: "param_invalid";
+                    details?: readonly Response.error.Detail[] | undefined;
+                    message: string;
+                };
+                requestId: string;
+            };
+            outputFormat: "json";
+            status: 400;
+            input: {
+                param: {
+                    invitationId: string;
+                };
+            };
+        } | {
+            output: {
+                error: {
+                    code: "forbidden";
+                    details?: readonly Response.error.Detail[] | undefined;
+                    message: string;
+                };
+                requestId: string;
+            };
+            outputFormat: "json";
+            status: 403;
+            input: {
+                param: {
+                    invitationId: string;
+                };
+            };
+        } | {
+            output: {
+                error: {
+                    code: "invitation_not_found";
+                    details?: readonly Response.error.Detail[] | undefined;
+                    message: string;
+                };
+                requestId: string;
+            };
+            outputFormat: "json";
+            status: 404;
+            input: {
+                param: {
+                    invitationId: string;
+                };
+            };
+        } | {
+            output: {
+                orgId: string;
+                role: "admin" | "member" | "owner";
+                userId: string;
+            };
+            outputFormat: "json";
+            status: 200;
+            input: {
+                param: {
+                    invitationId: string;
+                };
+            };
+        };
+    };
+} & {
+    "/v1/invitations/:invitationId{inv_[A-Za-z0-9_-]+}/decline": {
+        $post: {
+            output: {
+                error: {
+                    code: "api_key_malformed";
+                    details?: readonly Response.error.Detail[] | undefined;
+                    message: string;
+                };
+                requestId: string;
+            };
+            outputFormat: "json";
+            status: 400;
+            input: {
+                param: {
+                    invitationId: string;
+                };
+            };
+        } | {
+            output: {
+                error: {
+                    code: "api_key_invalid" | "api_key_missing";
+                    details?: readonly Response.error.Detail[] | undefined;
+                    message: string;
+                };
+                requestId: string;
+            };
+            outputFormat: "json";
+            status: 401;
+            input: {
+                param: {
+                    invitationId: string;
+                };
+            };
+        } | {
+            output: {
+                error: {
+                    code: "upstream_error";
+                    details?: readonly Response.error.Detail[] | undefined;
+                    message: string;
+                };
+                requestId: string;
+            };
+            outputFormat: "json";
+            status: 502;
+            input: {
+                param: {
+                    invitationId: string;
+                };
+            };
+        } | {
+            output: {
+                error: {
+                    code: "param_invalid";
+                    details?: readonly Response.error.Detail[] | undefined;
+                    message: string;
+                };
+                requestId: string;
+            };
+            outputFormat: "json";
+            status: 400;
+            input: {
+                param: {
+                    invitationId: string;
+                };
+            };
+        } | {
+            output: {
+                error: {
+                    code: "forbidden";
+                    details?: readonly Response.error.Detail[] | undefined;
+                    message: string;
+                };
+                requestId: string;
+            };
+            outputFormat: "json";
+            status: 403;
+            input: {
+                param: {
+                    invitationId: string;
+                };
+            };
+        } | {
+            output: {
+                error: {
+                    code: "invitation_not_found";
+                    details?: readonly Response.error.Detail[] | undefined;
+                    message: string;
+                };
+                requestId: string;
+            };
+            outputFormat: "json";
+            status: 404;
+            input: {
+                param: {
+                    invitationId: string;
+                };
+            };
+        } | {
+            output: {
+                id: string;
+            };
+            outputFormat: "json";
+            status: 200;
+            input: {
+                param: {
+                    invitationId: string;
+                };
+            };
+        };
+    };
+}, "/", "/v1/invitations/:invitationId{inv_[A-Za-z0-9_-]+}/decline">;
+//# sourceMappingURL=invitations.d.ts.map