@insurance-broker/api-client 5.39.0 → 5.41.0

package/dist/schema.d.ts

@@ -2962,7 +2962,10 @@ export interface paths {
         /** This customer's invitations and their lifecycle. Never the code or its hash. */
         get: operations["ListCustomerInvitations"];
         put?: never;
-        /** Issues a single-use code the customer redeems to attach a sign-in account. The code is shown once. */
+        /**
+         * Issues a single-use code the customer redeems to attach a sign-in account. The code is shown once.
+         * @description The code is returned once and is for the member of staff to hand to the customer. Issuing it also creates the customer's sign-in account, where the deployment has enabled that, and the sign-in service emails the customer a link to verify their address and choose a password. If no such email arrives, the customer may already have an account: they sign in with it, or use "Forgot password" on the sign-in page with the address the invitation was issued to. Whether an account already existed is never reported.
+         */
         post: operations["IssueCustomerInvitation"];
         delete?: never;
         options?: never;
@@ -3026,7 +3029,7 @@ export interface paths {
          *
          *     **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.
+         *     **Where a deployment has enabled the isolated identity-management component (ADR-0049), the identity provider's sessions are also ended**, shortly after this answer and not before it: the request is recorded here and carried out in the background. Nowhere is that a reason to skip the steps above. It does not list sessions, or end one and keep the others. 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;
@@ -3097,7 +3100,7 @@ export interface paths {
          *
          *     **Refusals.** `400` when either field is missing or the reason is too long. `404` when the customer is not this broker's. `409` with problem type `urn:brokerplatform:problem:verification-method-not-offered` when the method is not in this broker's set, has been retired, or the broker has configured none — read the set and choose from it. `409` with no type when the customer has never attached a sign-in account, so has no session to end.
          *
-         *     **What it does not do yet.** It does not end the sessions at the identity provider or list them; those need the isolated identity-management component ADR-0049 describes.
+         *     **Where a deployment has enabled the isolated identity-management component (ADR-0049), the identity provider's sessions are also ended**, shortly after this answer and not before it, on this member of staff's own sign-in: the request is recorded here and carried out in the background. It does not list sessions.
          */
         post: operations["RevokeCustomerSessions"];
         delete?: never;

package/package.json

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