@devdash/bofrid-api-types 0.1.5

package/dist/routes/references.d.ts

@@ -0,0 +1,695 @@
+import { OpenAPIHono } from "@hono/zod-openapi";
+import type { AppBindings } from "../app";
+export declare const referencesApp: OpenAPIHono<AppBindings, {
+    "/references": {
+        $get: {
+            input: {
+                query: {
+                    type?: "housing" | "personal" | undefined;
+                    status?: "active" | "draft" | "archived" | "expired" | undefined;
+                };
+            };
+            output: {
+                error: string;
+            };
+            outputFormat: "json";
+            status: 401;
+        } | {
+            input: {
+                query: {
+                    type?: "housing" | "personal" | undefined;
+                    status?: "active" | "draft" | "archived" | "expired" | undefined;
+                };
+            };
+            output: {
+                references: {
+                    type: string;
+                    status: string;
+                    id: string;
+                    createdAt: string;
+                    updatedAt: string;
+                    config: string | number | boolean | any[] | {
+                        [x: string]: any;
+                    } | null;
+                    housingHistoryId: string | null;
+                    receiverId: string;
+                    signerId: string | null;
+                    visibility: string;
+                    metadata: string | number | boolean | any[] | {
+                        [x: string]: any;
+                    } | null;
+                    signerName: string | null;
+                    signerPersonnummer: string | null;
+                    signerPhone: string | null;
+                    signerComment: string | null;
+                    verificationLevel: string | null;
+                    signedAt: string | null;
+                    expiresAt: string | null;
+                    sourceId: string | null;
+                }[];
+            };
+            outputFormat: "json";
+            status: 200;
+        };
+    };
+} & {
+    "/references": {
+        $post: {
+            input: {
+                json: {
+                    type: "housing" | "personal";
+                    config?: {
+                        requiresVerification?: boolean | undefined;
+                        maxSignatures?: number | undefined;
+                        expiresAfterDays?: number | undefined;
+                    } | undefined;
+                    housingHistoryId?: string | undefined;
+                    visibility?: "private" | "public" | "shared" | undefined;
+                    metadata?: Record<string, unknown> | undefined;
+                };
+            };
+            output: {
+                error: string;
+            };
+            outputFormat: "json";
+            status: 401;
+        } | {
+            input: {
+                json: {
+                    type: "housing" | "personal";
+                    config?: {
+                        requiresVerification?: boolean | undefined;
+                        maxSignatures?: number | undefined;
+                        expiresAfterDays?: number | undefined;
+                    } | undefined;
+                    housingHistoryId?: string | undefined;
+                    visibility?: "private" | "public" | "shared" | undefined;
+                    metadata?: Record<string, unknown> | undefined;
+                };
+            };
+            output: {
+                error: string;
+            };
+            outputFormat: "json";
+            status: 404;
+        } | {
+            input: {
+                json: {
+                    type: "housing" | "personal";
+                    config?: {
+                        requiresVerification?: boolean | undefined;
+                        maxSignatures?: number | undefined;
+                        expiresAfterDays?: number | undefined;
+                    } | undefined;
+                    housingHistoryId?: string | undefined;
+                    visibility?: "private" | "public" | "shared" | undefined;
+                    metadata?: Record<string, unknown> | undefined;
+                };
+            };
+            output: {
+                error: string;
+            };
+            outputFormat: "json";
+            status: 400;
+        } | {
+            input: {
+                json: {
+                    type: "housing" | "personal";
+                    config?: {
+                        requiresVerification?: boolean | undefined;
+                        maxSignatures?: number | undefined;
+                        expiresAfterDays?: number | undefined;
+                    } | undefined;
+                    housingHistoryId?: string | undefined;
+                    visibility?: "private" | "public" | "shared" | undefined;
+                    metadata?: Record<string, unknown> | undefined;
+                };
+            };
+            output: {
+                error: string;
+            };
+            outputFormat: "json";
+            status: 409;
+        } | {
+            input: {
+                json: {
+                    type: "housing" | "personal";
+                    config?: {
+                        requiresVerification?: boolean | undefined;
+                        maxSignatures?: number | undefined;
+                        expiresAfterDays?: number | undefined;
+                    } | undefined;
+                    housingHistoryId?: string | undefined;
+                    visibility?: "private" | "public" | "shared" | undefined;
+                    metadata?: Record<string, unknown> | undefined;
+                };
+            };
+            output: {
+                type: string;
+                status: string;
+                id: string;
+                createdAt: string;
+                updatedAt: string;
+                config: string | number | boolean | any[] | {
+                    [x: string]: any;
+                } | null;
+                housingHistoryId: string | null;
+                receiverId: string;
+                signerId: string | null;
+                visibility: string;
+                metadata: string | number | boolean | any[] | {
+                    [x: string]: any;
+                } | null;
+                signerName: string | null;
+                signerPersonnummer: string | null;
+                signerPhone: string | null;
+                signerComment: string | null;
+                verificationLevel: string | null;
+                signedAt: string | null;
+                expiresAt: string | null;
+                sourceId: string | null;
+            };
+            outputFormat: "json";
+            status: 201;
+        };
+    };
+} & {
+    "/references/given": {
+        $get: {
+            input: {};
+            output: {
+                error: string;
+            };
+            outputFormat: "json";
+            status: 401;
+        } | {
+            input: {};
+            output: {
+                references: {
+                    type: string;
+                    status: string;
+                    id: string;
+                    createdAt: string;
+                    updatedAt: string;
+                    config: string | number | boolean | any[] | {
+                        [x: string]: any;
+                    } | null;
+                    housingHistoryId: string | null;
+                    receiverId: string;
+                    signerId: string | null;
+                    visibility: string;
+                    metadata: string | number | boolean | any[] | {
+                        [x: string]: any;
+                    } | null;
+                    signerName: string | null;
+                    signerPersonnummer: string | null;
+                    signerPhone: string | null;
+                    signerComment: string | null;
+                    verificationLevel: string | null;
+                    signedAt: string | null;
+                    expiresAt: string | null;
+                    sourceId: string | null;
+                }[];
+            };
+            outputFormat: "json";
+            status: 200;
+        };
+    };
+} & {
+    "/references/:id": {
+        $get: {
+            input: {
+                param: {
+                    id: string;
+                };
+            };
+            output: {
+                error: string;
+            };
+            outputFormat: "json";
+            status: 401;
+        } | {
+            input: {
+                param: {
+                    id: string;
+                };
+            };
+            output: {
+                error: string;
+            };
+            outputFormat: "json";
+            status: 404;
+        } | {
+            input: {
+                param: {
+                    id: string;
+                };
+            };
+            output: {
+                error: string;
+            };
+            outputFormat: "json";
+            status: 403;
+        } | {
+            input: {
+                param: {
+                    id: string;
+                };
+            };
+            output: {
+                type: string;
+                status: string;
+                id: string;
+                createdAt: string;
+                updatedAt: string;
+                config: string | number | boolean | any[] | {
+                    [x: string]: any;
+                } | null;
+                housingHistoryId: string | null;
+                receiverId: string;
+                signerId: string | null;
+                visibility: string;
+                metadata: string | number | boolean | any[] | {
+                    [x: string]: any;
+                } | null;
+                signerName: string | null;
+                signerPersonnummer: string | null;
+                signerPhone: string | null;
+                signerComment: string | null;
+                verificationLevel: string | null;
+                signedAt: string | null;
+                expiresAt: string | null;
+                sourceId: string | null;
+            };
+            outputFormat: "json";
+            status: 200;
+        };
+    };
+} & {
+    "/references/:id": {
+        $put: {
+            input: {
+                param: {
+                    id: string;
+                };
+            } & {
+                json: {
+                    status?: "active" | "draft" | "archived" | "expired" | undefined;
+                    config?: Record<string, unknown> | undefined;
+                    visibility?: "private" | "public" | "shared" | undefined;
+                    metadata?: Record<string, unknown> | undefined;
+                };
+            };
+            output: {
+                error: string;
+            };
+            outputFormat: "json";
+            status: 401;
+        } | {
+            input: {
+                param: {
+                    id: string;
+                };
+            } & {
+                json: {
+                    status?: "active" | "draft" | "archived" | "expired" | undefined;
+                    config?: Record<string, unknown> | undefined;
+                    visibility?: "private" | "public" | "shared" | undefined;
+                    metadata?: Record<string, unknown> | undefined;
+                };
+            };
+            output: {
+                error: string;
+            };
+            outputFormat: "json";
+            status: 404;
+        } | {
+            input: {
+                param: {
+                    id: string;
+                };
+            } & {
+                json: {
+                    status?: "active" | "draft" | "archived" | "expired" | undefined;
+                    config?: Record<string, unknown> | undefined;
+                    visibility?: "private" | "public" | "shared" | undefined;
+                    metadata?: Record<string, unknown> | undefined;
+                };
+            };
+            output: {
+                error: string;
+            };
+            outputFormat: "json";
+            status: 400;
+        } | {
+            input: {
+                param: {
+                    id: string;
+                };
+            } & {
+                json: {
+                    status?: "active" | "draft" | "archived" | "expired" | undefined;
+                    config?: Record<string, unknown> | undefined;
+                    visibility?: "private" | "public" | "shared" | undefined;
+                    metadata?: Record<string, unknown> | undefined;
+                };
+            };
+            output: {
+                type: string;
+                status: string;
+                id: string;
+                createdAt: string;
+                updatedAt: string;
+                config: string | number | boolean | any[] | {
+                    [x: string]: any;
+                } | null;
+                housingHistoryId: string | null;
+                receiverId: string;
+                signerId: string | null;
+                visibility: string;
+                metadata: string | number | boolean | any[] | {
+                    [x: string]: any;
+                } | null;
+                signerName: string | null;
+                signerPersonnummer: string | null;
+                signerPhone: string | null;
+                signerComment: string | null;
+                verificationLevel: string | null;
+                signedAt: string | null;
+                expiresAt: string | null;
+                sourceId: string | null;
+            };
+            outputFormat: "json";
+            status: 200;
+        };
+    };
+} & {
+    "/references/:id": {
+        $delete: {
+            input: {
+                param: {
+                    id: string;
+                };
+            };
+            output: {
+                error: string;
+            };
+            outputFormat: "json";
+            status: 401;
+        } | {
+            input: {
+                param: {
+                    id: string;
+                };
+            };
+            output: {
+                error: string;
+            };
+            outputFormat: "json";
+            status: 404;
+        } | {
+            input: {
+                param: {
+                    id: string;
+                };
+            };
+            output: {
+                success: boolean;
+            };
+            outputFormat: "json";
+            status: 200;
+        };
+    };
+} & {
+    "/references/:id/signatures": {
+        $get: {
+            input: {
+                param: {
+                    id: string;
+                };
+            };
+            output: {
+                error: string;
+            };
+            outputFormat: "json";
+            status: 401;
+        } | {
+            input: {
+                param: {
+                    id: string;
+                };
+            };
+            output: {
+                error: string;
+            };
+            outputFormat: "json";
+            status: 404;
+        } | {
+            input: {
+                param: {
+                    id: string;
+                };
+            };
+            output: {
+                signerName: string | null;
+                signerComment: string | null;
+                verificationLevel: string | null;
+                signedAt: string | null;
+            };
+            outputFormat: "json";
+            status: 200;
+        };
+    };
+} & {
+    "/references/given/:givenId": {
+        $delete: {
+            input: {
+                param: {
+                    givenId: string;
+                };
+            };
+            output: {
+                error: string;
+            };
+            outputFormat: "json";
+            status: 401;
+        } | {
+            input: {
+                param: {
+                    givenId: string;
+                };
+            };
+            output: {
+                error: string;
+            };
+            outputFormat: "json";
+            status: 404;
+        } | {
+            input: {
+                param: {
+                    givenId: string;
+                };
+            };
+            output: {
+                success: boolean;
+            };
+            outputFormat: "json";
+            status: 200;
+        };
+    };
+} & {
+    "/ref/:id": {
+        $get: {
+            input: {
+                param: {
+                    id: string;
+                };
+            };
+            output: {
+                error: string;
+            };
+            outputFormat: "json";
+            status: 404;
+        } | {
+            input: {
+                param: {
+                    id: string;
+                };
+            };
+            output: {
+                type: "collection" | "reference";
+                owner: {
+                    id: string;
+                    personnummer: string | null;
+                    displayName: string;
+                    profilePictureUrl: string | null;
+                    bostadsmeritScore: number;
+                } | null;
+                reference: {
+                    type: string;
+                    status: string;
+                    id: string;
+                    createdAt: string;
+                    updatedAt: string;
+                    config: string | number | boolean | any[] | {
+                        [x: string]: any;
+                    } | null;
+                    housingHistoryId: string | null;
+                    receiverId: string;
+                    signerId: string | null;
+                    visibility: string;
+                    metadata: string | number | boolean | any[] | {
+                        [x: string]: any;
+                    } | null;
+                    signerName: string | null;
+                    signerPersonnummer: string | null;
+                    signerPhone: string | null;
+                    signerComment: string | null;
+                    verificationLevel: string | null;
+                    signedAt: string | null;
+                    expiresAt: string | null;
+                    sourceId: string | null;
+                } | null;
+                alreadySigned: boolean;
+            };
+            outputFormat: "json";
+            status: 200;
+        };
+    };
+} & {
+    "/ref/:id": {
+        $post: {
+            input: {
+                param: {
+                    id: string;
+                };
+            } & {
+                json: {
+                    phoneNumber?: string | undefined;
+                    comment?: string | undefined;
+                };
+            };
+            output: {
+                error: string;
+            };
+            outputFormat: "json";
+            status: 401;
+        } | {
+            input: {
+                param: {
+                    id: string;
+                };
+            } & {
+                json: {
+                    phoneNumber?: string | undefined;
+                    comment?: string | undefined;
+                };
+            };
+            output: {
+                error: string;
+            };
+            outputFormat: "json";
+            status: 404;
+        } | {
+            input: {
+                param: {
+                    id: string;
+                };
+            } & {
+                json: {
+                    phoneNumber?: string | undefined;
+                    comment?: string | undefined;
+                };
+            };
+            output: {
+                error: string;
+            };
+            outputFormat: "json";
+            status: 400;
+        } | {
+            input: {
+                param: {
+                    id: string;
+                };
+            } & {
+                json: {
+                    phoneNumber?: string | undefined;
+                    comment?: string | undefined;
+                };
+            };
+            output: {
+                message: string;
+                signerName: string;
+                referenceId: string;
+            };
+            outputFormat: "json";
+            status: 200;
+        };
+    };
+} & {
+    "/ref/lookup/:id": {
+        $get: {
+            input: {
+                param: {
+                    id: string;
+                };
+            } & {
+                query: {
+                    type?: string | undefined;
+                    sourceId?: string | undefined;
+                };
+            };
+            output: {
+                error: string;
+            };
+            outputFormat: "json";
+            status: 404;
+        } | {
+            input: {
+                param: {
+                    id: string;
+                };
+            } & {
+                query: {
+                    type?: string | undefined;
+                    sourceId?: string | undefined;
+                };
+            };
+            output: {
+                error: string;
+            };
+            outputFormat: "json";
+            status: 400;
+        } | {
+            input: {
+                param: {
+                    id: string;
+                };
+            } & {
+                query: {
+                    type?: string | undefined;
+                    sourceId?: string | undefined;
+                };
+            };
+            output: {
+                type: "reference" | "collect";
+                userId: string;
+                metadata?: {
+                    requiresAuth: boolean;
+                    address?: string | undefined;
+                    landlordName?: string | undefined;
+                    sourceId?: string | undefined;
+                    sourceName?: string | undefined;
+                    requestorName?: string | undefined;
+                    context?: string | undefined;
+                    relationship?: string | undefined;
+                    tenancyPeriod?: string | undefined;
+                } | undefined;
+                referenceId?: string | undefined;
+                referenceType?: "housing" | "personal" | undefined;
+            };
+            outputFormat: "json";
+            status: 200;
+        };
+    };
+}, "/">;

package/dist/routes/search-partners.d.ts

@@ -0,0 +1,4 @@
+import { OpenAPIHono } from "@hono/zod-openapi";
+import type { AppBindings } from "../app";
+declare const app: OpenAPIHono<AppBindings, {}, "/">;
+export { app as searchPartnersApp };