@insurance-broker/api-client 1.36.0 → 1.38.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;
@@ -2801,7 +2841,9 @@ export interface paths {
         put?: never;
         /**
          * Record what the insurer confirmed
-         * @description Records the insurer's own reference and the date the insurer confirmed cover from, and makes the policy active. This is the only way a policy becomes active: the platform does not bind cover, so active is what an insurer confirmed and never something a caller asserts.
+         * @description Records the insurer's own reference and the date the insurer confirmed cover from. This is the only way a policy leaves `pendingInsurer`: the platform does not bind cover, so what happens next is what an insurer confirmed and never something a caller asserts.
+         *
+         *     **Where it lands depends on whether this broker has declared a payment gate** (`GET /policies/payment-gates`, BR-004). With no gate - which is every broker that has configured nothing - the policy becomes `active`. With one, it becomes `pendingPayment`, and cover begins when somebody records that the requirement was met.
          */
         post: operations["RecordInsurerConfirmation"];
         delete?: never;
@@ -2810,6 +2852,32 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
+    "/api/v1/policies/{id}/payment-requirement": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        /**
+         * Record that the outstanding payment requirement has been met
+         * @description BR-004. Releases a policy this broker's payment gate is holding, naming the billing record the recorder relied on, and makes it `active`.
+         *
+         *     **A payment posting does not do this** (ADR-0042 section 7). If it did, the platform would be asserting that cover began. A person looks at a payment and records that the requirement is discharged: the payment is the evidence, the person is the actor, and the platform is neither. There is no consumer, no sweep and no side effect that reaches this route.
+         *
+         *     **Only a policy in `pendingPayment` can be released, and only once.** Recording it against a policy no gate ever held would write an evidence trail for a requirement that never existed.
+         *
+         *     **The `paymentId` is recorded and not verified.** The payment lives in another module this one may not read (ADR-0002), so a mistyped identifier is a bad record rather than a refusal - issue #306 carries the contract that would check it.
+         */
+        post: operations["RecordPaymentRequirementMet"];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     "/api/v1/policies/{id}": {
         parameters: {
             query?: never;
@@ -2827,6 +2895,62 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
+    "/api/v1/policies/payment-gates": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * Whether this broker's cover waits for a payment
+         * @description BR-004. Every gate this broker has declared: one for its whole book, one per product, or any combination.
+         *
+         *     **An empty list is the normal answer and it means no gate.** Cover begins when the insurer's confirmation is recorded, which is what this platform did before step 9.11. A row exists only where a broker has asked for the gate, so there is nothing to turn off and nothing to seed.
+         *
+         *     **A gate for the whole book cannot be exempted for one product.** An exemption would be a claim about a broker's credit policy that BR-004 does not ask this platform to model; a broker wanting to gate all but one product declares the rest.
+         */
+        get: operations["ReadPaymentGates"];
+        put?: never;
+        /**
+         * Declare that cover waits for a payment
+         * @description BR-004. Records that a payment must be recorded before cover begins - for every product this broker sells, or for one of them.
+         *
+         *     **It changes no existing policy.** A confirmation resolves the gate at the instant it is recorded, so a policy already active stays active and one already held stays held. What changes is where the *next* confirmation lands: `PendingPayment` instead of `Active`.
+         *
+         *     **Declaring the same gate twice is a `409`.** The row is the declaration, so a second one would be the same fact recorded twice with two authors and two instants.
+         *
+         *     **A product this broker does not sell is a `400`.** Checked through the catalogue before the row is written.
+         */
+        post: operations["DeclarePaymentGate"];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/api/v1/policies/payment-gates/{id}": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        post?: never;
+        /**
+         * Stop requiring a payment before cover begins
+         * @description Deletes the declaration. No gate applies by absence, which is what an empty table means.
+         *
+         *     **Policies already held are not released by this.** They stay `PendingPayment` until somebody records that the requirement was met, because releasing cover is an act with an author and evidence (ADR-0042 section 7) and withdrawing a rule is neither. A broker that gated its book by mistake releases each held policy deliberately.
+         */
+        delete: operations["WithdrawPaymentGate"];
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     "/api/v1/policies/{id}/documents/{kind}": {
         parameters: {
             query?: never;
@@ -4411,6 +4535,10 @@ export interface components {
             key: null | string;
             name: null | string;
         };
+        DeclarePaymentGateRequest: {
+            /** Format: uuid */
+            productId: null | string;
+        };
         DeclineQuoteRequest: {
             /** Format: uuid */
             presentationVersionId: null | string;
@@ -4867,6 +4995,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;
@@ -4889,6 +5023,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;
@@ -5025,6 +5180,20 @@ export interface components {
         PaymentEvidenceUpload: {
             file: components["schemas"]["IFormFile"];
         };
+        PaymentGateResponse: {
+            /** Format: uuid */
+            id: string;
+            /** Format: uuid */
+            productId: null | string;
+            appliesToEveryProduct: boolean;
+            /** Format: date-time */
+            setAtUtc: string;
+            setBySubjectId: string;
+        };
+        PaymentPage: {
+            items: components["schemas"]["PaymentSummaryResponse"][];
+            nextCursor: null | string;
+        };
         PaymentResponse: {
             /** Format: uuid */
             id: string;
@@ -5058,6 +5227,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;
@@ -5150,6 +5338,11 @@ export interface components {
             /** Format: date-time */
             importedAtUtc: null | string;
             importedBySubjectId: null | string;
+            /** Format: date-time */
+            paymentRequirementMetAtUtc: null | string;
+            paymentRequirementMetBySubjectId: null | string;
+            /** Format: uuid */
+            paymentEvidenceReference: null | string;
         };
         PresentationBodyResponse: {
             version: components["schemas"]["PresentationVersionResponse"];
@@ -5462,6 +5655,10 @@ export interface components {
             source: string;
             externalReference: string;
         };
+        RecordPaymentRequirementMetRequest: {
+            /** Format: uuid */
+            paymentId: null | string;
+        };
         RecordRenewalCustomerInformationRequest: {
             /** Format: uuid */
             formSubmissionId: null | string;
@@ -5907,6 +6104,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;
@@ -6407,6 +6639,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;
@@ -12368,6 +12634,59 @@ export interface operations {
             };
         };
     };
+    RecordPaymentRequirementMet: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                id: string;
+            };
+            cookie?: never;
+        };
+        requestBody: {
+            content: {
+                "application/json": components["schemas"]["RecordPaymentRequirementMetRequest"];
+            };
+        };
+        responses: {
+            /** @description OK */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["PolicyResponse"];
+                };
+            };
+            /** @description Bad Request */
+            400: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/problem+json": components["schemas"]["HttpValidationProblemDetails"];
+                };
+            };
+            /** @description Not Found */
+            404: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/problem+json": components["schemas"]["ProblemDetails"];
+                };
+            };
+            /** @description Conflict */
+            409: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/problem+json": components["schemas"]["ProblemDetails"];
+                };
+            };
+        };
+    };
     GetPolicy: {
         parameters: {
             query?: never;
@@ -12399,6 +12718,95 @@ export interface operations {
             };
         };
     };
+    ReadPaymentGates: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description OK */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["PaymentGateResponse"][];
+                };
+            };
+        };
+    };
+    DeclarePaymentGate: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody: {
+            content: {
+                "application/json": components["schemas"]["DeclarePaymentGateRequest"];
+            };
+        };
+        responses: {
+            /** @description Created */
+            201: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["PaymentGateResponse"];
+                };
+            };
+            /** @description Bad Request */
+            400: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/problem+json": components["schemas"]["HttpValidationProblemDetails"];
+                };
+            };
+            /** @description Conflict */
+            409: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/problem+json": components["schemas"]["ProblemDetails"];
+                };
+            };
+        };
+    };
+    WithdrawPaymentGate: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                id: string;
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description No Content */
+            204: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+            /** @description Not Found */
+            404: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+        };
+    };
     UploadPolicyDocument: {
         parameters: {
             query?: never;

package/package.json

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