@insurance-broker/api-client 5.52.0 → 5.54.0

package/dist/schema.d.ts

@@ -3939,7 +3939,12 @@ export interface paths {
         };
         get?: never;
         put?: never;
-        /** Records where one of this broker's people works and which desk they sit on. */
+        /**
+         * Records where one of this broker's people works and which desk they sit on.
+         * @description A caller may place only a member every one of whose permission keys the caller holds, and may not place themselves.
+         *
+         *     **Refusals.** `400`: no branch or team of this broker has that identifier (`GET /api/v1/branches` and `GET /api/v1/teams` list them). `403` `urn:brokerplatform:problem:permissions-beyond-caller`: the member holds a permission the caller does not; a `403` with no body means the caller does not hold `identity.members.manage`. `404` with no body: no member of this broker has that identifier. `409` `urn:brokerplatform:problem:member-self-administration`: the member is the caller (`isCaller` is true on them in `GET /api/v1/members`), and another administrator must place them. `409` `urn:brokerplatform:problem:member-revoked`: the member's access has been revoked. Problem details are written for the person using the screen and name no route.
+         */
         post: operations["PlaceMember"];
         delete?: never;
         options?: never;
@@ -3956,13 +3961,15 @@ export interface paths {
         };
         /**
          * This broker's memberships, with status, roles and placement, oldest first.
-         * @description Paged by an opaque cursor: pass `nextCursor` back as `cursor` until it is null. `limit` is 25 by default and at most 100; zero or less means the default. `status` narrows the list to `Invited`, `Active`, `Suspended` or `Revoked`. A revoked member whose name has been erased comes back as "Former member of staff". Names are personal data.
+         * @description Paged by an opaque cursor: pass `nextCursor` back as `cursor` until it is null. `limit` is 25 by default and at most 100; zero or less means the default. `status` narrows the list to `Invited`, `Active`, `Suspended` or `Revoked`. A revoked member whose name has been erased comes back as "Former member of staff". Names are personal data. Each role carries the permission keys it grants, so a client can tell which roles the caller may give or take, and `isCaller` marks the caller's own live membership, which the caller may not change, place or revoke.
          */
         get: operations["ListMembers"];
         put?: never;
         /**
          * Gives a person with a staff account access to this broker, holding the named roles.
-         * @description The subject must name an account that already exists in the staff realm; this platform does not create staff accounts. The membership is active at once, as the platform's own grant is: there is no acceptance step. At least one role is required, and each must hold only permissions the caller holds. A person who already has a live membership of this broker is refused 409.
+         * @description The subject must name an account that already exists in the staff realm; this platform does not create staff accounts. The membership is active at once, as the platform's own grant is: there is no acceptance step. At least one role is required, and each must hold only permissions the caller holds.
+         *
+         *     **Refusals.** A role identifier this broker does not have is a `400` validation problem against `roleIds`; `GET /api/v1/roles` lists the roles it has. A role holding a permission the caller does not hold is `403` `urn:brokerplatform:problem:permissions-beyond-caller`; a `403` with no body means the caller does not hold `identity.members.manage`. A person who already has a live membership of this broker is `409` `urn:brokerplatform:problem:already-a-member`: change what they hold with `PUT` or `DELETE /api/v1/members/{membershipId}/roles/{roleId}` instead. Problem details are written for the person using the screen and name no route.
          */
         post: operations["InviteMember"];
         delete?: never;
@@ -3983,6 +3990,8 @@ export interface paths {
         /**
          * Withdraws a member of staff's access to this broker permanently. Terminal.
          * @description Every request from that person to this broker that starts after the revocation commits is refused; one already past authorization completes. Their identity-provider account is not changed. Revoking a membership that is already revoked answers it as it stands and changes nothing. A caller may not revoke their own membership. A revoked membership cannot be restored.
+         *
+         *     **Typed refusals.** `403` `urn:brokerplatform:problem:permissions-beyond-caller`: the member holds a permission the caller does not; a `403` with no body means the caller does not hold `identity.members.manage`. `409` `urn:brokerplatform:problem:member-self-administration`: the member is the caller (`isCaller` is true on them in `GET /api/v1/members`), and another administrator must do it.
          */
         post: operations["RevokeMembership"];
         delete?: never;
@@ -4002,12 +4011,16 @@ export interface paths {
         /**
          * Gives a member of staff one of this broker's roles. Idempotent.
          * @description The member can do what the role grants from their next request onward. The role must hold only permissions the caller holds. A caller may not change their own roles, and a revoked membership's roles are not changed. Assigning a role the member already holds answers the member as they stand and writes nothing.
+         *
+         *     **Refusals, each with its own `type`.** `404` `urn:brokerplatform:problem:member-not-found`: no member of this broker has that identifier (`GET /api/v1/members` lists them). `404` `urn:brokerplatform:problem:role-not-found`: no role of this broker has that identifier (`GET /api/v1/roles` lists them). `403` `urn:brokerplatform:problem:permissions-beyond-caller`: the role holds a permission the caller does not; a `403` with no body means the caller does not hold `identity.members.manage`. `409` `urn:brokerplatform:problem:member-self-administration`: the member is the caller (`isCaller` is true on them), and another administrator must make the change. `409` `urn:brokerplatform:problem:member-revoked`: the member's access has been revoked, so their roles are a record. Problem details are written for the person using the screen and name no route.
          */
         put: operations["AssignMemberRole"];
         post?: never;
         /**
          * Takes one of this broker's roles away from a member of staff. Idempotent.
          * @description The member can no longer do what only that role granted from their next request onward. The role must hold only permissions the caller holds: a caller may not take away what they could not have given. A caller may not change their own roles, and a revoked membership's roles are not changed. Removing a role the member does not hold answers the member as they stand and writes nothing.
+         *
+         *     **Refusals, each with its own `type`.** `404` `urn:brokerplatform:problem:member-not-found`: no member of this broker has that identifier (`GET /api/v1/members` lists them). `404` `urn:brokerplatform:problem:role-not-found`: no role of this broker has that identifier (`GET /api/v1/roles` lists them). `403` `urn:brokerplatform:problem:permissions-beyond-caller`: the role holds a permission the caller does not; a `403` with no body means the caller does not hold `identity.members.manage`. `409` `urn:brokerplatform:problem:member-self-administration`: the member is the caller (`isCaller` is true on them), and another administrator must make the change. `409` `urn:brokerplatform:problem:member-revoked`: the member's access has been revoked, so their roles are a record. Problem details are written for the person using the screen and name no route.
          */
         delete: operations["RemoveMemberRole"];
         options?: never;
@@ -5057,6 +5070,109 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
+    "/api/v1/policies/outstanding-items/overdue": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * Read what is overdue across this broker's policies
+         * @description POL-007. Every outstanding item, on any of this broker's policies, that has not been satisfied and was due before today. **Most overdue first**: due date ascending, ties broken by identifier.
+         *
+         *     `awaitedFrom` narrows it to `Insurer` or `Customer`, so the insurer chasing and the customer chasing can be worked separately.
+         *
+         *     **Overdue is computed, never stored.** Today is UTC's day, read on each request and reported as `asOf` on every page. A walk that crosses midnight loses nothing: the items that become overdue at midnight are due on the latest day in the list, so they join the end of the walk.
+         *
+         *     Paged by cursor (ADR-0031): pass `nextCursor` back as `cursor` until it is null. `limit` is 25 by default and at most 100. A cursor this list did not issue is a `400`.
+         */
+        get: operations["ListOverduePolicyOutstandingItems"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/api/v1/policy-documents/download-links/{token}": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /** Redeems a short-lived download link and streams the policy document it names. */
+        get: operations["RedeemPolicyDocumentDownloadLink"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/api/v1/policies/{id}/outstanding-items": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * Read what a policy is or was waiting on
+         * @description POL-007. Everything recorded as outstanding on this policy, newest raised first.
+         *
+         *     `outstanding=true` narrows it to what is still being waited on and `outstanding=false` to what has been satisfied. Absent, the whole history comes back. Not paged: the set is bounded by how many things one policy waited on.
+         *
+         *     **Staff only.** Nothing here is shown to the customer.
+         */
+        get: operations["ListPolicyOutstandingItems"];
+        put?: never;
+        /**
+         * Record that a policy is waiting on the insurer or the customer
+         * @description POL-007. Records what this policy is waiting on, which side owes it, and the day it is due.
+         *
+         *     **This creates a row and never changes the policy's status.** A policy waiting on a certificate is still `Active`.
+         *
+         *     **What is outstanding is your own words**, not a code from a list. The side is `Insurer` or `Customer`. `dueOn` is required and may be in the past.
+         *
+         *     **Nothing about an item can be edited afterwards.** A wrong item is satisfied and the right one raised; a moved deadline is a new item, because the old one was missed.
+         *
+         *     Refused with 409 when the policy has been renewed: its successor is where the work is.
+         */
+        post: operations["RaisePolicyOutstandingItem"];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/api/v1/policies/{id}/outstanding-items/{itemId}/satisfaction": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        /**
+         * Record that what a policy was waiting on has arrived
+         * @description POL-007. Marks one outstanding item satisfied, naming you and the instant.
+         *
+         *     **Allowed after the policy has been renewed**: something can arrive late, and the record may not be made to deny it.
+         *
+         *     A second satisfaction is refused with 409 naming who dealt with it, and so is the second of two racing each other.
+         */
+        post: operations["SatisfyPolicyOutstandingItem"];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     "/api/v1/policies/{id}/documents/{kind}": {
         parameters: {
             query?: never;
@@ -5853,23 +5969,6 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
-    "/api/v1/policy-documents/download-links/{token}": {
-        parameters: {
-            query?: never;
-            header?: never;
-            path?: never;
-            cookie?: never;
-        };
-        /** Redeems a short-lived download link and streams the policy document it names. */
-        get: operations["RedeemPolicyDocumentDownloadLink"];
-        put?: never;
-        post?: never;
-        delete?: never;
-        options?: never;
-        head?: never;
-        patch?: never;
-        trace?: never;
-    };
     "/api/v1/quote-requests": {
         parameters: {
             query?: never;
@@ -9047,12 +9146,14 @@ export interface components {
             branchId: null | string;
             /** Format: uuid */
             teamId: null | string;
+            isCaller: boolean;
         };
         MemberRoleResponse: {
             /** Format: uuid */
             roleId: string;
             key: string;
             name: string;
+            permissionKeys: string[];
         };
         MissingTemplateValueResponse: {
             key: string;
@@ -9264,6 +9365,29 @@ export interface components {
             /** Format: int32 */
             attempts: number;
         };
+        OverduePolicyOutstandingItemPage: {
+            items: components["schemas"]["OverduePolicyOutstandingItemResponse"][];
+            nextCursor: null | string;
+            /** Format: date */
+            asOf: string;
+        };
+        OverduePolicyOutstandingItemResponse: {
+            /** Format: uuid */
+            id: string;
+            /** Format: uuid */
+            policyId: string;
+            /** Format: uuid */
+            customerId: string;
+            awaitedFrom: string;
+            description: string;
+            /** Format: date */
+            dueOn: string;
+            raisedBySubjectId: string;
+            /** Format: date-time */
+            raisedAtUtc: string;
+            productName: null | string;
+            insurerReference: null | string;
+        };
         OverrideEntitlementRequest: {
             featureKey: null | string;
             value: null | string;
@@ -9644,6 +9768,25 @@ export interface components {
         PolicyImportUpload: {
             file: components["schemas"]["IFormFile"];
         };
+        PolicyOutstandingItemResponse: {
+            /** Format: uuid */
+            id: string;
+            /** Format: uuid */
+            policyId: string;
+            /** Format: uuid */
+            customerId: string;
+            awaitedFrom: string;
+            description: string;
+            /** Format: date */
+            dueOn: string;
+            raisedBySubjectId: string;
+            /** Format: date-time */
+            raisedAtUtc: string;
+            satisfiedBySubjectId: null | string;
+            /** Format: date-time */
+            satisfiedAtUtc: null | string;
+            isOutstanding: boolean;
+        };
         PolicyPage: {
             items: components["schemas"]["PolicyResponse"][];
             nextCursor: null | string;
@@ -10043,6 +10186,12 @@ export interface components {
             awaitedFrom: null | string;
             description: null | string;
         };
+        RaisePolicyOutstandingItemRequest: {
+            awaitedFrom: string;
+            description: string;
+            /** Format: date */
+            dueOn: null | string;
+        };
         RaiseQuoteRequestRequest: {
             /** Format: uuid */
             formSubmissionId: null | string;
@@ -23138,6 +23287,196 @@ export interface operations {
             };
         };
     };
+    ListOverduePolicyOutstandingItems: {
+        parameters: {
+            query?: {
+                awaitedFrom?: 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"]["OverduePolicyOutstandingItemPage"];
+                };
+            };
+            /** @description Bad Request */
+            400: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/problem+json": components["schemas"]["HttpValidationProblemDetails"];
+                };
+            };
+        };
+    };
+    RedeemPolicyDocumentDownloadLink: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                token: string;
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description OK */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+            /** @description Not Found */
+            404: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+            /** @description Conflict */
+            409: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/problem+json": components["schemas"]["ProblemDetails"];
+                };
+            };
+        };
+    };
+    ListPolicyOutstandingItems: {
+        parameters: {
+            query?: {
+                outstanding?: boolean;
+            };
+            header?: never;
+            path: {
+                id: string;
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description OK */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["PolicyOutstandingItemResponse"][];
+                };
+            };
+            /** @description Not Found */
+            404: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+        };
+    };
+    RaisePolicyOutstandingItem: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                id: string;
+            };
+            cookie?: never;
+        };
+        requestBody: {
+            content: {
+                "application/json": components["schemas"]["RaisePolicyOutstandingItemRequest"];
+            };
+        };
+        responses: {
+            /** @description Created */
+            201: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["PolicyOutstandingItemResponse"];
+                };
+            };
+            /** @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"];
+                };
+            };
+        };
+    };
+    SatisfyPolicyOutstandingItem: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                id: string;
+                itemId: string;
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description OK */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["PolicyOutstandingItemResponse"];
+                };
+            };
+            /** @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"];
+                };
+            };
+        };
+    };
     UploadPolicyDocument: {
         parameters: {
             query?: never;
@@ -24857,42 +25196,6 @@ export interface operations {
             };
         };
     };
-    RedeemPolicyDocumentDownloadLink: {
-        parameters: {
-            query?: never;
-            header?: never;
-            path: {
-                token: string;
-            };
-            cookie?: never;
-        };
-        requestBody?: never;
-        responses: {
-            /** @description OK */
-            200: {
-                headers: {
-                    [name: string]: unknown;
-                };
-                content?: never;
-            };
-            /** @description Not Found */
-            404: {
-                headers: {
-                    [name: string]: unknown;
-                };
-                content?: never;
-            };
-            /** @description Conflict */
-            409: {
-                headers: {
-                    [name: string]: unknown;
-                };
-                content: {
-                    "application/problem+json": components["schemas"]["ProblemDetails"];
-                };
-            };
-        };
-    };
     ListQuoteRequests: {
         parameters: {
             query?: {

package/package.json

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