@insurance-broker/api-client 1.35.0 → 1.37.0

package/dist/schema.d.ts

@@ -11,7 +11,19 @@ export interface paths {
             path?: never;
             cookie?: never;
         };
-        get?: never;
+        /**
+         * List what this broker is owed, what is overdue, and what has concluded
+         * @description PAY-002. Five views over one collection, oldest due date first, paged by cursor: `owed`, `overdue`, `settled`, `written-off` and `cancelled`. A `customerId` or a `policyId` narrows any of them.
+         *
+         *     **Nothing stores `overdue`.** A charge is overdue when its due date is before the day the page was measured against and its balance is above nil, computed as the page is read (ADR-0042 section 9, section 14). The day is returned as `asOf` on every page, so a page saying nine charges are overdue also says what overdue meant when it said so.
+         *
+         *     **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 cannot lose the tie group it is inside. 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 cancelled charge is owed nothing, so money paid against one leaves the customer in credit; a written-off charge is owed what actually arrived and no more, because a write-off forgives the remainder rather than the part that was paid. The same rule the customer's statement uses.
+         *
+         *     **`customerId` and `policyId` are filters and never authorisation.** The broker whose charges these are comes from the session; naming a customer here selects among this broker's own rows and can reach nobody else's.
+         */
+        get: operations["ListObligations"];
         put?: never;
         /**
          * Record what a customer owes against one of their policies
@@ -306,6 +318,34 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
+    "/api/v1/payments": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * List the money this broker has recorded, most recent first
+         * @description PAY-005. The payments this broker has recorded, ordered by when they posted, paged by cursor. A `customerId` or an `obligationId` narrows the list.
+         *
+         *     **There is no `asOf` here, unlike `GET /obligations`.** Nothing in this list's predicate reads the clock - a payment posted at an instant the row records - so a member reporting when the page was measured would read as a freshness guarantee while guaranteeing nothing.
+         *
+         *     **A reversed payment stays on the list** and carries `reversed: true`. Money that arrived and was sent back is a fact a reconciliation has to see, and a reversal is its own record rather than an edit to this one (ADR-0042 section 8).
+         *
+         *     **Rows carry no subject identifiers.** Who recorded a payment and who approved it is the separation-of-duties record and it is on the payment itself, so a page-sized read cannot enumerate a broker's finance staff.
+         *
+         *     **`customerId` and `obligationId` are filters and never authorisation.** The broker whose payments these are comes from the session.
+         */
+        get: operations["ListPayments"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     "/api/v1/payments/{id}": {
         parameters: {
             query?: never;
@@ -472,6 +512,122 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
+    "/api/v1/statements": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * List the statements this broker has produced
+         * @description Newest period first, paged by cursor. A `customerId` narrows the list to one customer.
+         *
+         *     **`customerId` is a filter and never an authorisation.** The broker whose statements these are comes from the session; naming a customer here selects among this broker's own rows and can reach nobody else's.
+         *
+         *     Rows carry what each statement covers and not its figures: computing every statement's balance to render one page would make a list cost what a year of reading costs.
+         */
+        get: operations["ListStatements"];
+        put?: never;
+        /**
+         * Produce a statement of account for a customer
+         * @description PAY-011. Records that a statement was produced for one customer, in one currency, over one period that has already finished, and answers its charges, payments, allocations and balances.
+         *
+         *     **The period must have ended.** A statement's figures are computed from the ledger rather than stored, so one covering a day that is still running would answer differently every time it was read - and a statement of account that changes after it has been sent is worse than none.
+         *
+         *     **One currency per statement.** A charge carries its own currency, and a balance in two of them is not a number. A customer owing in two currencies gets two statements.
+         *
+         *     **Nothing about money is stored on the row.** There is no balance column: every figure is derived from the obligations and payments the statement renders, bounded by its period and by the instant it was produced.
+         */
+        post: operations["ProduceStatement"];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/api/v1/statements/{id}": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * Read one statement, with its lines and figures
+         * @description PAY-011's whole sentence: the charges raised in the period, the payments recorded against them, which charge each payment went to, and the balance at either end of it.
+         *
+         *     **`closingBalance` is `openingBalance` plus `charged` less `paid`**, and `charged` is the sum of the `amountOwed` column, so the statement reconciles against its own lines.
+         *
+         *     **Each charge carries `amountOwed` beside `amount`, and the two differ when the charge has concluded.** A charge still outstanding, or one settled by payments on this statement, is owed in full. A charge the broker **cancelled** is owed nothing - it should never have existed, so money paid against it leaves the customer in credit. A charge the broker **wrote off** is owed what was actually paid against it, because a write-off forgives the remainder and never the part that arrived.
+         *
+         *     **Every figure is measured as at `producedAtUtc`.** A charge cancelled or written off after this statement was produced still shows what it was owed at the time, so `status` and `amountOwed` can disagree - and that pair is the record rather than a contradiction. A payment reversed afterwards still stands here for the same reason.
+         */
+        get: operations["GetStatement"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/api/v1/customer/statements": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * List the statements of account your broker has produced for you
+         * @description PAY-011. Every statement of yours, newest period 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 statements are not in it - not filtered out of it, but absent, because a statement that is not yours is not visible to this route at all.
+         *
+         *     Each row says what the statement covers and when it was produced. Its charges, payments and balances are on its own route.
+         *
+         *     **A statement per currency.** A charge carries its own currency and a balance in two of them is not a number, so if you are billed in more than one you have a statement in each.
+         */
+        get: operations["ListOwnStatements"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/api/v1/customer/statements/{id}": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * Read one of your own statements of account
+         * @description PAY-011. What was charged in the period, what you paid, which charge each payment went to, the policies the charges relate to, and what was owed at either end of it.
+         *
+         *     **The balance is worked out from your broker's ledger rather than stored**, and it is measured as at the moment the statement was produced: a charge raised or a payment recorded afterwards is on a later statement, never added to this one. So this answer is the same today as the day it was sent to you.
+         *
+         *     **`closingBalance` is `openingBalance` plus `charged` less `paid`**, and `charged` is the sum of the `amountOwed` column, so you can add the charges up and arrive at the total.
+         *
+         *     **Each charge shows `amountOwed` as well as `amount`.** A charge still owed, or one your payments have settled, is owed in full. 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 you had already paid - the rest was forgiven, and neither of you owes it.
+         *
+         *     A payment that was reversed is listed and does not reduce what is owed, because it happened.
+         *
+         *     A statement that is not yours and one that does not exist are the same answer, because a statement belonging to somebody else is not visible here at all.
+         */
+        get: operations["GetOwnStatement"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     "/api/v1/insurers": {
         parameters: {
             query?: never;
@@ -4751,6 +4907,12 @@ export interface components {
             /** Format: date */
             incidentOn: string;
         };
+        ObligationPage: {
+            items: components["schemas"]["ObligationSummaryResponse"][];
+            nextCursor: null | string;
+            /** Format: date */
+            asOf: string;
+        };
         ObligationResponse: {
             /** Format: uuid */
             id: string;
@@ -4773,6 +4935,27 @@ export interface components {
             retentionAnchorAtUtc: null | string;
             writeOffReason: null | string;
         };
+        ObligationSummaryResponse: {
+            /** Format: uuid */
+            id: string;
+            /** Format: uuid */
+            customerId: string;
+            /** Format: uuid */
+            policyId: string;
+            /** Format: uuid */
+            productId: string;
+            /** Format: double */
+            amount: number | string;
+            /** Format: double */
+            paid: number | string;
+            /** Format: double */
+            balance: number | string;
+            currency: string;
+            /** Format: date */
+            dueOn: string;
+            description: string;
+            status: string;
+        };
         OfferedFormResponse: {
             /** Format: uuid */
             id: string;
@@ -4909,6 +5092,10 @@ export interface components {
         PaymentEvidenceUpload: {
             file: components["schemas"]["IFormFile"];
         };
+        PaymentPage: {
+            items: components["schemas"]["PaymentSummaryResponse"][];
+            nextCursor: null | string;
+        };
         PaymentResponse: {
             /** Format: uuid */
             id: string;
@@ -4942,6 +5129,25 @@ export interface components {
             reversedAtUtc: string;
             reversedBySubjectId: string;
         };
+        PaymentSummaryResponse: {
+            /** Format: uuid */
+            id: string;
+            /** Format: uuid */
+            obligationId: string;
+            /** Format: uuid */
+            customerId: string;
+            /** Format: double */
+            amount: number | string;
+            currency: string;
+            source: string;
+            externalReference: string;
+            status: string;
+            /** Format: date-time */
+            postedAtUtc: string;
+            /** Format: date-time */
+            approvedAtUtc: null | string;
+            reversed: boolean;
+        };
         PlaceLegalHoldRequest: {
             moduleName: null | string;
             entityType: null | string;
@@ -5095,6 +5301,15 @@ export interface components {
             detail?: null | string;
             instance?: null | string;
         };
+        ProduceStatementRequest: {
+            /** Format: uuid */
+            customerId: string;
+            currency: string;
+            /** Format: date */
+            periodStart: string;
+            /** Format: date */
+            periodEnd: string;
+        };
         ProductCategoryResponse: {
             /** Format: uuid */
             id: string;
@@ -5597,6 +5812,78 @@ export interface components {
             quoteRequestId: null | string;
             options: null | components["schemas"]["PresentedOptionRequest"][];
         };
+        StatementChargeResponse: {
+            /** Format: uuid */
+            obligationId: string;
+            /** Format: uuid */
+            policyId: string;
+            /** Format: uuid */
+            productId: string;
+            description: string;
+            /** Format: double */
+            amount: number | string;
+            /** Format: double */
+            amountOwed: number | string;
+            /** Format: date */
+            dueOn: string;
+            /** Format: date-time */
+            raisedAtUtc: string;
+            status: string;
+        };
+        StatementPage: {
+            items: components["schemas"]["StatementSummaryResponse"][];
+            nextCursor: null | string;
+        };
+        StatementPaymentResponse: {
+            /** Format: uuid */
+            paymentId: string;
+            /** Format: uuid */
+            obligationId: string;
+            /** Format: double */
+            amount: number | string;
+            source: string;
+            externalReference: string;
+            /** Format: date-time */
+            postedAtUtc: string;
+            isReversed: boolean;
+        };
+        StatementResponse: {
+            /** Format: uuid */
+            id: string;
+            /** Format: uuid */
+            customerId: string;
+            currency: string;
+            /** Format: date */
+            periodStart: string;
+            /** Format: date */
+            periodEnd: string;
+            /** Format: date-time */
+            producedAtUtc: string;
+            /** Format: double */
+            openingBalance: number | string;
+            /** Format: double */
+            charged: number | string;
+            /** Format: double */
+            paid: number | string;
+            /** Format: double */
+            closingBalance: number | string;
+            policyIds: string[];
+            charges: components["schemas"]["StatementChargeResponse"][];
+            payments: components["schemas"]["StatementPaymentResponse"][];
+        };
+        StatementSummaryResponse: {
+            /** Format: uuid */
+            id: string;
+            /** Format: uuid */
+            customerId: string;
+            currency: string;
+            /** Format: date */
+            periodStart: string;
+            /** Format: date */
+            periodEnd: string;
+            /** Format: date-time */
+            producedAtUtc: string;
+        };
         SubmissionAttachmentDownloadLinkResponse: {
             url: string;
             /** Format: date-time */
@@ -5710,6 +5997,41 @@ export interface components {
 }
 export type $defs = Record<string, never>;
 export interface operations {
+    ListObligations: {
+        parameters: {
+            query?: {
+                view?: string;
+                customerId?: string;
+                policyId?: string;
+                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"]["ObligationPage"];
+                };
+            };
+            /** @description Bad Request */
+            400: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/problem+json": components["schemas"]["HttpValidationProblemDetails"];
+                };
+            };
+        };
+    };
     RaiseObligation: {
         parameters: {
             query?: never;
@@ -6210,6 +6532,40 @@ export interface operations {
             };
         };
     };
+    ListPayments: {
+        parameters: {
+            query?: {
+                customerId?: string;
+                obligationId?: string;
+                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"]["PaymentPage"];
+                };
+            };
+            /** @description Bad Request */
+            400: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/problem+json": components["schemas"]["HttpValidationProblemDetails"];
+                };
+            };
+        };
+    };
     GetPayment: {
         parameters: {
             query?: never;
@@ -6505,6 +6861,162 @@ export interface operations {
             };
         };
     };
+    ListStatements: {
+        parameters: {
+            query?: {
+                customerId?: string;
+                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"]["StatementPage"];
+                };
+            };
+            /** @description Bad Request */
+            400: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/problem+json": components["schemas"]["HttpValidationProblemDetails"];
+                };
+            };
+        };
+    };
+    ProduceStatement: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody: {
+            content: {
+                "application/json": components["schemas"]["ProduceStatementRequest"];
+            };
+        };
+        responses: {
+            /** @description Created */
+            201: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["StatementResponse"];
+                };
+            };
+            /** @description Bad Request */
+            400: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/problem+json": components["schemas"]["HttpValidationProblemDetails"];
+                };
+            };
+        };
+    };
+    GetStatement: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                id: string;
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description OK */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["StatementResponse"];
+                };
+            };
+            /** @description Not Found */
+            404: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+        };
+    };
+    ListOwnStatements: {
+        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"]["StatementPage"];
+                };
+            };
+            /** @description Bad Request */
+            400: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/problem+json": components["schemas"]["HttpValidationProblemDetails"];
+                };
+            };
+        };
+    };
+    GetOwnStatement: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                id: string;
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description OK */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["StatementResponse"];
+                };
+            };
+            /** @description Not Found */
+            404: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+        };
+    };
     ListInsurers: {
         parameters: {
             query?: {

package/package.json

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