@insurance-broker/api-client 1.45.0 → 1.47.0

package/dist/schema.d.ts

@@ -628,6 +628,56 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
+    "/api/v1/exports/obligations": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        /**
+         * Export this broker's obligations book to CSV or PDF
+         * @description RPT-004, under ADM-008's control. Produces a file of exactly the rows `GET /obligations` would return for the same view and filters — no more — and returns the bytes in the response.
+         *
+         *     **Every export is logged before the file is handed over.** A receipt row and an audit entry naming what was exported, by whom, how much and a SHA-256 of the exact bytes are committed in one transaction first; if that commit fails, no data leaves. The receipts are readable at `GET /exports` under a separate key.
+         *
+         *     **Nothing is stored.** The bytes are produced for this response and never written to the object store, so there is no link to fetch later and no file to orphan (ADR-0038 section 7 and section 11). The price is a ceiling: a selection of more than 5000 charges is refused with a `422` naming the count, and the caller narrows by customer, by policy or by view.
+         *
+         *     **A PDF stops far sooner — 500 charges.** It is laid out one paragraph per charge and rendered under a lock the whole process shares, so a hundred-page one would be paid for by every other tenant's documents. The `422` names the format and its own ceiling; the same selection as a CSV carries the full amount.
+         *
+         *     **`customerId` and `policyId` are filters and never authorisation.** The broker is the one in scope; another broker's charges are invisible rather than forbidden.
+         */
+        post: operations["ExportObligations"];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/api/v1/exports": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * What this broker has taken out of the platform, newest first
+         * @description ADM-008's logged half, and what SEC-008's alerting reads. One row per export: the dataset, the view, the format, the row count, the byte count, a SHA-256 of the bytes, the filters that were applied, and who produced it — paged by cursor, newest first (ADR-0031).
+         *
+         *     **No row offers the file back.** The bytes were never stored, so there is nothing to re-download; a log entry that handed out a second copy would be a second export with none of the controls that governed the first.
+         */
+        get: operations["ListExportReceipts"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     "/api/v1/insurers": {
         parameters: {
             query?: never;
@@ -4816,6 +4866,46 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
+    "/api/v1/dashboards/leads": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * How many enquiries arrived, how many nobody has taken, and where they came from
+         * @description The lead funnel, read from phase 10's read model rather than from the module that owns leads (ADR-0047). Filter by a period and by a source; the response echoes both, so a figure carries its own question. Every response reports an as-at, which is the oldest projection instant among the rows counted: a read model is written when the Worker consumes an event, so a figure from one is about a recent past, and a count is only as current as its least-current row. A count of nil has no as-at, because it lags nothing. RPT-001 names eleven subjects and this is the only one with a read model behind it: the rest wait on the modules that own those facts publishing the lifecycle events to feed one, and a dashboard built over their tables instead would be the cross-module join the platform forbids everywhere else.
+         */
+        get: operations["ReadLeadFunnelDashboard"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/api/v1/dashboards/leads/entries": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * The leads behind a figure on the funnel dashboard
+         * @description The rows the dashboard counted, newest first, paged by an opaque cursor. The filters are the dashboard's own plus 'assigned', which is how the unassigned figure is traced to its rows. Identifiers and dates only: a lead's name and contact details stay in the module that owns them, so this projection never becomes a second copy of personal data somebody has to find at erasure time (ADR-0047 section 6). There is no branch filter and no staff-member filter: the read model carries neither a branch nor a person, and resolving either would be a read of another module's tables.
+         */
+        get: operations["ListLeadFunnelEntries"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     "/api/v1/notifications": {
         parameters: {
             query?: never;
@@ -5479,6 +5569,39 @@ export interface components {
             source: string;
             isResolved: boolean;
         };
+        ExportObligationsRequest: {
+            view: null | string;
+            format: null | string;
+            /** Format: uuid */
+            customerId: null | string;
+            /** Format: uuid */
+            policyId: null | string;
+        };
+        ExportReceiptPage: {
+            items: components["schemas"]["ExportReceiptResponse"][];
+            nextCursor: null | string;
+        };
+        ExportReceiptResponse: {
+            /** Format: uuid */
+            id: string;
+            subject: string;
+            view: string;
+            format: string;
+            /** Format: int32 */
+            rowCount: number | string;
+            /** Format: int64 */
+            byteCount: number | string;
+            contentSha256: string;
+            /** Format: uuid */
+            customerId: null | string;
+            /** Format: uuid */
+            policyId: null | string;
+            /** Format: date */
+            measuredOn: string;
+            /** Format: date-time */
+            producedAtUtc: string;
+            producedBySubjectId: string;
+        };
         FormDefinitionResponse: {
             /** Format: uuid */
             id: string;
@@ -5827,6 +5950,49 @@ export interface components {
             integrationName: null | string;
         };
         JsonElement: unknown;
+        LeadFunnelDashboard: {
+            /** Format: date-time */
+            from: null | string;
+            /** Format: date-time */
+            to: null | string;
+            source: null | string;
+            /** Format: int32 */
+            arrived: number | string;
+            /** Format: int32 */
+            unassigned: number | string;
+            /** Format: int32 */
+            assigned: number | string;
+            bySource: components["schemas"]["LeadFunnelSourceRow"][];
+            /** Format: date-time */
+            asAtUtc: null | string;
+        };
+        LeadFunnelEntryPage: {
+            items: components["schemas"]["LeadFunnelEntryResponse"][];
+            nextCursor: null | string;
+            /** Format: date-time */
+            asAtUtc: null | string;
+        };
+        LeadFunnelEntryResponse: {
+            /** Format: uuid */
+            leadId: string;
+            source: string;
+            /** Format: date-time */
+            createdAtUtc: string;
+            assignedToSubjectId: null | string;
+            /** Format: date-time */
+            assignedAtUtc: null | string;
+            /** Format: date-time */
+            projectedAtUtc: string;
+        };
+        LeadFunnelSourceRow: {
+            source: string;
+            /** Format: int32 */
+            arrived: number | string;
+            /** Format: int32 */
+            unassigned: number | string;
+            /** Format: int32 */
+            assigned: number | string;
+        };
         LeadResponse: {
             /** Format: uuid */
             id: string;
@@ -8245,6 +8411,92 @@ export interface operations {
             };
         };
     };
+    ExportObligations: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody: {
+            content: {
+                "application/json": components["schemas"]["ExportObligationsRequest"];
+            };
+        };
+        responses: {
+            /** @description OK */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+            /** @description Bad Request */
+            400: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/problem+json": components["schemas"]["HttpValidationProblemDetails"];
+                };
+            };
+            /** @description Forbidden */
+            403: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+            /** @description Unprocessable Entity */
+            422: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/problem+json": components["schemas"]["ProblemDetails"];
+                };
+            };
+        };
+    };
+    ListExportReceipts: {
+        parameters: {
+            query?: {
+                cursor?: string;
+                limit?: number | string;
+            };
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description OK */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["ExportReceiptPage"];
+                };
+            };
+            /** @description Bad Request */
+            400: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/problem+json": components["schemas"]["HttpValidationProblemDetails"];
+                };
+            };
+            /** @description Forbidden */
+            403: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+        };
+    };
     ListInsurers: {
         parameters: {
             query?: {
@@ -19104,6 +19356,75 @@ export interface operations {
             };
         };
     };
+    ReadLeadFunnelDashboard: {
+        parameters: {
+            query?: {
+                from?: string;
+                to?: string;
+                source?: string;
+            };
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description OK */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["LeadFunnelDashboard"];
+                };
+            };
+            /** @description Bad Request */
+            400: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/problem+json": components["schemas"]["HttpValidationProblemDetails"];
+                };
+            };
+        };
+    };
+    ListLeadFunnelEntries: {
+        parameters: {
+            query?: {
+                from?: string;
+                to?: string;
+                source?: string;
+                assigned?: boolean;
+                cursor?: string;
+                limit?: number | string;
+            };
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description OK */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["LeadFunnelEntryPage"];
+                };
+            };
+            /** @description Bad Request */
+            400: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/problem+json": components["schemas"]["HttpValidationProblemDetails"];
+                };
+            };
+        };
+    };
     ListNotifications: {
         parameters: {
             query?: {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@insurance-broker/api-client",
-  "version": "1.45.0",
+  "version": "1.47.0",
   "description": "Generated TypeScript client for the Insurance Broker Platform API. Do not edit by hand: regenerate with scripts/update-api-contract.",
   "license": "UNLICENSED",
   "private": false,