@insurance-broker/api-client 5.53.0 → 5.56.0

package/dist/schema.d.ts

@@ -3091,6 +3091,8 @@ export interface paths {
          * Read what has happened on a customer's relationship with the broker
          * @description CRM-008. Policies, claims, payments, quotes and form submissions as their modules report them, with the notes, logged calls and emails, shares and next actions staff recorded here. Newest first. Each row says what kind of thing happened and when. It never carries a note's words: read those through the notes route, which needs `crm.customer-notes.read`.
          *
+         *     A row about another module's record carries `recordKind` and `recordId`, a pointer to the record it describes: `Policy` (`/policies/{id}`), `Claim` (`/claims/{id}`), `Payment` (`/payments/{id}`), `QuoteRequest` (`/quote-requests/{id}`), `FormSubmission` (`/form-submissions/{id}`) or `Renewal` (`/renewals/{id}`). New kinds may be added: show a row whose kind you do not know without a link. Opening the record needs that route's own permission. Both are null on CRM's own rows, on rows recorded before this pointer existed, and where the activity had no single record.
+         *
          *     The timeline begins when this release was deployed; earlier activity is not on it.
          *
          *     Paged by cursor (ADR-0031): pass `nextCursor` back as `cursor` until it is null. A cursor this list did not issue is a `400`.
@@ -5070,6 +5072,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;
@@ -5866,23 +5971,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;
@@ -8145,6 +8233,9 @@ export interface components {
             referenceId: null | string;
             /** Format: date-time */
             occurredAtUtc: string;
+            recordKind: null | string;
+            /** Format: uuid */
+            recordId: null | string;
         };
         CustomerTimelinePage: {
             items: components["schemas"]["CustomerTimelineEntryResponse"][];
@@ -9279,6 +9370,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;
@@ -9659,6 +9773,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;
@@ -10058,6 +10191,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;
@@ -23153,6 +23292,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;
@@ -24872,42 +25201,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.53.0",
+  "version": "5.56.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,