@insurance-broker/api-client 5.18.0 → 5.20.0

package/README.md

@@ -27,6 +27,26 @@ package only describes the shapes it carries.
 Nothing here is written by hand except the entry point. The types come from the backend's committed
 `docs/api/openapi.json`, and the backend's own CI fails if the two drift apart.
 
+## Responses the per-route types do not list
+
+**Any customer-realm route can answer `401` with problem type
+`urn:brokerplatform:problem:session-revoked`**, not only the routes whose description mentions it.
+The platform's tenant resolution produces this answer before a route runs, so the generated types do
+not list it on each operation. It means the customer signed out every session
+(`POST /api/v1/customer-account/sessions/revocation`) after this session was authenticated.
+
+- Do **not** answer it by refreshing. The identity provider will issue a new token, and the API will
+  refuse it in the same way.
+- Do **not** answer it with a `prompt=login` sign-in on its own. On a device that still holds the
+  identity provider's session cookie, that re-authenticates the *same* session and re-admits every
+  refresh token copied from it.
+- Do this instead:
+  1. End the identity provider's session with RP-initiated logout and `id_token_hint`.
+  2. Discard the stored tokens.
+  3. Sign in again.
+
+The backend's ADR-0049 has the reasoning, including the 2026-10-11 amendment.
+
 ## Versioning
 
 Semantic versioning against the **contract**, not against this file:

package/dist/schema.d.ts

@@ -3009,6 +3009,32 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
+    "/api/v1/customer-account/sessions/revocation": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        /**
+         * Signs the customer out of every session they have established, including this one.
+         * @description **Every sign-in this customer established up to now stops working against this API on its next request — including the one making this call.** That is the stolen-device remedy (SEC-012): a phone that is lost keeps a session the customer cannot reach, and this ends what that session can do here without needing the phone.
+         *
+         *     **What a client must do afterwards.** Every request from a session established before the returned `revokedAtUtc` (plus a few seconds' clock allowance) is answered `401` with problem type `urn:brokerplatform:problem:session-revoked` — on any customer route, not only this one. **Do not refresh in answer to it**: the identity provider will issue a new token and that token will be refused the same way, because it belongs to the same sign-in. **Do not answer it with a `prompt=login` sign-in alone either**: on a device that still holds the identity provider's session cookie, that re-authenticates the *same* session and re-admits every refresh token copied from it. End the identity provider's session first (RP-initiated logout with `id_token_hint`), discard the stored tokens, then sign in.
+         *
+         *     **Tell the customer to change their password, and to secure their email account.** Signing out does not stop somebody who knows the password from signing in again, and a password can be reset through the email address.
+         *
+         *     **What it does not do yet.** It does not end the sessions at the identity provider, list them, or end one and keep the others; those need the isolated identity-management component ADR-0049 describes. A `409` means the caller is acting for an organisation: sessions belong to the person, so act personally to revoke them.
+         */
+        post: operations["RevokeOwnCustomerSessions"];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     "/api/v1/customer-account/redemption": {
         parameters: {
             query?: never;
@@ -4753,6 +4779,8 @@ export interface paths {
          *
          *     Every condition is resolved onto every case, so `approval` is present with `isRequired` false rather than absent. Read `isRequired` instead of assuming: a broker's configuration moves the flag, not the row (ADR-0040 section 4).
          *
+         *     **One row is the exception, and it is never the customer's.** `BrokerRecordedInformation` appears only where you recorded what the customer told you (#228). It is owed by the broker, enforced by `ExternalRecord`, and its `recordedFrom` says how you heard; `brokerRecordedInformationBySubjectId` says who recorded it. It satisfies nothing else: the customer's `CustomerInformation` row reads exactly as it would without it.
+         *
          *     `customerAnswers` is what the customer said through their own app (REN-005): confirm, decline or request changes, oldest first, with the short note they may attach to the last two. It is empty on a renewal the customer has not answered, and empty for ever on one only you ever touched - a reconfirmation you recorded on their behalf satisfies the condition and is not one of their answers.
          *
          *     **A decline does not conclude anything.** It satisfies no condition and moves no status, so the checklist still reads outstanding and owed by the customer; what changed is that you can now see they answered. Concluding the renewal is still yours, on the loss route.
@@ -4788,6 +4816,32 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
+    "/api/v1/renewals/{id}/broker-recorded-information": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        /**
+         * Record that the customer told you their details still stand
+         * @description #228. Records that the customer told you, by telephone, in person, by email or by letter, that the details the renewal rests on still stand. It adds a separate checklist row, `BrokerRecordedInformation`, owed by the broker, enforced by `ExternalRecord`, and carrying `recordedFrom`. That row reads "recorded by the broker from a telephone call" rather than plain "satisfied".
+         *
+         *     **It does not satisfy the customer's own `CustomerInformation` condition, and it never will.** REN-003 asks the customer to confirm their own details. That row stays outstanding and owed by the customer, so the checklist keeps showing that the customer never confirmed anything here. If the customer answers for themselves later, through `customer-information` or their own app, their row is satisfied as usual and both facts stay on the renewal.
+         *
+         *     **A `409` here is a settled fact, and `type` says which.** `urn:brokerplatform:problem:customer-already-confirmed` means the customer confirmed for themselves, so there is nothing for a broker's record to stand in for. `urn:brokerplatform:problem:renewal-concluded` means the renewal has concluded. `urn:brokerplatform:problem:broker-record-already-made` means a broker already recorded it with a different channel; it is recorded once. `urn:brokerplatform:problem:concurrency-conflict` means somebody wrote first; read again and retry.
+         *
+         *     Recording the same channel again reads back what is stored. Records no free text: what the customer said belongs in their CRM record, where it can be corrected.
+         */
+        put: operations["RecordRenewalBrokerRecordedInformation"];
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     "/api/v1/renewals/{id}/quote-request": {
         parameters: {
             query?: never;
@@ -7212,6 +7266,10 @@ export interface components {
             /** Format: double */
             distanceKm: null | number | string;
         };
+        CustomerSessionRevocationResponse: {
+            /** Format: date-time */
+            revokedAtUtc: string;
+        };
         CustomerSubmissionAttachmentResponse: {
             /** Format: uuid */
             id: string;
@@ -9082,6 +9140,9 @@ export interface components {
             answers: null | components["schemas"]["JsonElement"];
             source: null | string;
         };
+        RecordBrokerRecordedInformationRequest: {
+            channel: null | string;
+        };
         RecordClaimFormRequest: {
             /** Format: uuid */
             submissionId: string;
@@ -9200,6 +9261,14 @@ export interface components {
             name: string;
             legalName: null | string;
         };
+        RenewalBrokerRecordedInformationResponse: {
+            /** Format: uuid */
+            renewalCaseId: string;
+            channel: string;
+            recordedBySubjectId: string;
+            /** Format: date-time */
+            recordedAtUtc: string;
+        };
         RenewalCaseDetailResponse: {
             case: components["schemas"]["RenewalCaseSummaryResponse"];
             /** Format: uuid */
@@ -9209,6 +9278,7 @@ export interface components {
             quoteRequestId: null | string;
             checklist: components["schemas"]["RenewalChecklistItemResponse"][];
             customerAnswers: components["schemas"]["CustomerRenewalAnswerResponse"][];
+            brokerRecordedInformationBySubjectId: null | string;
         };
         RenewalCasePage: {
             items: components["schemas"]["RenewalCaseSummaryResponse"][];
@@ -9244,6 +9314,7 @@ export interface components {
             isRequired: boolean;
             /** Format: date-time */
             satisfiedAtUtc: null | string;
+            recordedFrom: null | string;
         };
         RenewalClockViolationResponse: {
             milestone: string;
@@ -16627,6 +16698,42 @@ export interface operations {
             };
         };
     };
+    RevokeOwnCustomerSessions: {
+        parameters: {
+            query?: never;
+            header?: {
+                /** @description The organisation to act for: one of the identifiers GET /api/v1/customer/contexts lists. Omit it, or send it empty, to act for your own account; there is no mode in which it becomes mandatory. A value you hold no active membership of, or one that is not an organisation identifier, is refused with 403 naming nothing, and never quietly treated as your own account. */
+                "X-Broker-Acting-For"?: components["parameters"]["ActingFor"];
+            };
+            path?: never;
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description OK */
+            200: {
+                headers: {
+                    /** @description The party this request actually acted for. Present, carrying the organisation identifier, when it acted for an organisation; absent when it acted for your own account. It mirrors the request header, so it can be sent back unchanged. Compare it with what you meant to send: it is the only way to see that a request you meant for an organisation was made personally. */
+                    "X-Broker-Acting-For"?: string;
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["CustomerSessionRevocationResponse"];
+                };
+            };
+            /** @description Conflict. A type of urn:brokerplatform:problem:concurrency-conflict means someone else changed the record first and nothing was written: read it again and decide again. Any other type is a conflict this operation decided itself, and retrying it unchanged will not help. */
+            409: {
+                headers: {
+                    /** @description The party this request actually acted for. Present, carrying the organisation identifier, when it acted for an organisation; absent when it acted for your own account. It mirrors the request header, so it can be sent back unchanged. Compare it with what you meant to send: it is the only way to see that a request you meant for an organisation was made personally. */
+                    "X-Broker-Acting-For"?: string;
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/problem+json": components["schemas"]["ConcurrencyConflictProblem"] | components["schemas"]["ProblemDetails"];
+                };
+            };
+        };
+    };
     RedeemCustomerInvitation: {
         parameters: {
             query?: never;
@@ -21246,6 +21353,57 @@ export interface operations {
             };
         };
     };
+    RecordRenewalBrokerRecordedInformation: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                id: string;
+            };
+            cookie?: never;
+        };
+        requestBody: {
+            content: {
+                "application/json": components["schemas"]["RecordBrokerRecordedInformationRequest"];
+            };
+        };
+        responses: {
+            /** @description OK */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["RenewalBrokerRecordedInformationResponse"];
+                };
+            };
+            /** @description Bad Request */
+            400: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/problem+json": components["schemas"]["HttpValidationProblemDetails"];
+                };
+            };
+            /** @description Not Found */
+            404: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+            /** @description Conflict. A type of urn:brokerplatform:problem:concurrency-conflict means someone else changed the record first and nothing was written: read it again and decide again. Any other type is a conflict this operation decided itself, and retrying it unchanged will not help. */
+            409: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/problem+json": components["schemas"]["ConcurrencyConflictProblem"] | components["schemas"]["ProblemDetails"];
+                };
+            };
+        };
+    };
     RecordRenewalQuoteRequest: {
         parameters: {
             query?: never;

package/package.json

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