@insurance-broker/api-client 1.46.0 → 1.48.0

package/dist/schema.d.ts

@@ -628,6 +628,116 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
+    "/api/v1/customer/charges": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * See what you owe, and what you have already covered
+         * @description PAY-002, PAY-005. Every charge your broker has raised against your policies, oldest due date first, paged by cursor.
+         *
+         *     **You are not named in the request.** There is no customer field and no broker field: the list is whoever is signed in, resolved from the session. Another person's charges are not in it - not filtered out of it, but absent.
+         *
+         *     **This is a live position, not a statement.** Nothing here was produced for you in advance: the figures and the state on each row are worked out as this answer is written, so it can change between one request and the next. A statement is the other thing - a document your broker produced deliberately, for a period, fixed at the moment they produced it - and it is on `/api/v1/customer/statements`.
+         *
+         *     **`state` is one of `due`, `overdue`, `paid` and `closed`**, and nothing stores it. A charge is `overdue` when its due date is before the day this page was measured against and something is still owed on it; that day is returned as `asOf`, so you can bucket the page against your own clock without asking again. `closed` means the charge has finished and nothing further is owed on it.
+         *
+         *     **One walk is measured against one day.** `asOf` is read from the clock on the first page and carried inside the cursor, so a walk crossing UTC midnight stays consistent. A walk resumed the next morning therefore serves the previous day's buckets: compare `asOf` with your own clock and start a new walk without a cursor.
+         *
+         *     **`balance` is not always `amount` less `paid`.** A charge your broker cancelled is owed nothing, so anything you paid against it counts in your favour; a charge your broker wrote off is owed only what had already arrived, because the rest was forgiven. The same rule your statement uses, so the two cannot disagree.
+         *
+         *     **There is no total.** What you owe overall is a sum across a whole book and across currencies, which is what a statement is for.
+         */
+        get: operations["ListOwnCharges"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/api/v1/customer/payments": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * See the payments your broker has recorded from you
+         * @description PAY-005. Every payment recorded against your charges, most recently recorded first, paged by cursor.
+         *
+         *     **Recorded, not taken.** This platform does not collect money: a payment here is your broker writing down that money reached them somewhere else - a bank, a mobile-money service, a counter - with the reference it arrived under. **There is no route here that pays anything**, deliberately.
+         *
+         *     **`state` is `received` or `returned`.** `received` means your broker has recorded the money and it counts against what you owe. `returned` means a reversal was recorded afterwards - the money did not arrive after all, or went back - so it no longer counts. A returned payment stays on this list rather than disappearing from it, because it happened.
+         *
+         *     **No `asOf`**, unlike the charges list: a payment was recorded at an instant this row holds, and nothing about this list moves at midnight.
+         *
+         *     **Each payment names the one charge it was recorded against**, and the policy that charge is owed under.
+         */
+        get: operations["ListOwnPayments"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        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;
@@ -5257,6 +5367,29 @@ export interface components {
             issuedBySubjectId: string;
             lines: components["schemas"]["CreditNoteLineResponse"][];
         };
+        CustomerChargePageResponse: {
+            items: components["schemas"]["CustomerChargeResponse"][];
+            nextCursor: null | string;
+            /** Format: date */
+            asOf: string;
+        };
+        CustomerChargeResponse: {
+            /** Format: uuid */
+            id: string;
+            /** Format: uuid */
+            policyId: string;
+            /** Format: double */
+            amount: number | string;
+            /** Format: double */
+            paid: number | string;
+            /** Format: double */
+            balance: number | string;
+            currency: string;
+            /** Format: date */
+            dueOn: string;
+            description: string;
+            state: string;
+        };
         CustomerClaimPage: {
             items: components["schemas"]["ClaimResponse"][];
             nextCursor: null | string;
@@ -5290,6 +5423,26 @@ export interface components {
             /** Format: date-time */
             revokedAtUtc: null | string;
         };
+        CustomerPaymentPageResponse: {
+            items: components["schemas"]["CustomerPaymentResponse"][];
+            nextCursor: null | string;
+        };
+        CustomerPaymentResponse: {
+            /** Format: uuid */
+            id: string;
+            /** Format: uuid */
+            chargeId: string;
+            /** Format: uuid */
+            policyId: string;
+            /** Format: double */
+            amount: number | string;
+            currency: string;
+            source: string;
+            externalReference: string;
+            /** Format: date-time */
+            recordedAtUtc: string;
+            state: string;
+        };
         CustomerPresentedQuoteResponse: {
             /** Format: uuid */
             presentationVersionId: string;
@@ -5519,6 +5672,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;
@@ -8328,6 +8514,156 @@ export interface operations {
             };
         };
     };
+    ListOwnCharges: {
+        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"]["CustomerChargePageResponse"];
+                };
+            };
+            /** @description Bad Request */
+            400: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/problem+json": components["schemas"]["HttpValidationProblemDetails"];
+                };
+            };
+        };
+    };
+    ListOwnPayments: {
+        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"]["CustomerPaymentPageResponse"];
+                };
+            };
+            /** @description Bad Request */
+            400: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/problem+json": components["schemas"]["HttpValidationProblemDetails"];
+                };
+            };
+        };
+    };
+    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?: {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@insurance-broker/api-client",
-  "version": "1.46.0",
+  "version": "1.48.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,