@insurance-broker/api-client 1.19.0 → 1.21.0

package/dist/schema.d.ts

@@ -901,6 +901,32 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
+    "/api/v1/claims/{id}/form": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        /**
+         * Record the claim form the customer answered
+         * @description CLM-002. The customer answers the product's published claim form through the form routes; this records which submission it was.
+         *
+         *     **Nothing here captures or validates an answer.** A claim form is an ordinary form definition of kind `Claim` against the same product, read by the same engine that serves quotes (ADR-0041 section 4).
+         *
+         *     Refused if the submission is not a submitted claim form for this claim's product, or if it was submitted before the claim was reported - a submission that predates the claim cannot be an account of it. A submission already recorded against another claim is refused too.
+         *
+         *     **A submission with no owner is accepted.** A claim already knows whose it is, from the policy it was checked against, so it asks nothing of the submission's ownership - which is what lets a broker take a first notice of loss over the telephone and answer the form with the customer on the line.
+         */
+        put: operations["RecordClaimForm"];
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     "/api/v1/claims/{id}/withdrawal": {
         parameters: {
             query?: never;
@@ -925,6 +951,80 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
+    "/api/v1/claims/{id}/notes": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * Read a claim's internal notes
+         * @description CLM-005. Your own staff's notes, oldest first, each saying who wrote it and whether it has been published to the customer's timeline.
+         */
+        get: operations["ListClaimNotes"];
+        put?: never;
+        /**
+         * Write an internal note on a claim
+         * @description CLM-005. A note your own staff can see. **The customer never sees it.**
+         *
+         *     Internal notes and the customer's timeline are two different tables, so a note is not hidden from the customer by a filter - there is no route by which a customer can reach one at all (ADR-0041 section 3). To tell the customer what a note says, publish it: that copies its words onto the timeline as a new, attributed entry.
+         */
+        post: operations["WriteClaimNote"];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/api/v1/claims/{id}/notes/{noteId}/publication": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        /**
+         * Tell the customer what an internal note says
+         * @description CLM-006. Copies the note's words onto the customer's timeline as a new entry, recording who decided to and when.
+         *
+         *     **A copy, not a flag.** The note is unchanged, so editing it afterwards cannot rewrite what the customer was shown, and an entry cannot be un-published. Publishing the same note twice is refused with 409 rather than showing the customer the same words at two instants as though they were two disclosures.
+         */
+        post: operations["PublishClaimNote"];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/api/v1/claims/{id}/timeline": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * Read what the customer has been told
+         * @description CLM-006, from the broker's side: the same entries the customer sees, oldest first, so staff can see what has been disclosed before adding to it.
+         */
+        get: operations["ListClaimTimeline"];
+        put?: never;
+        /**
+         * Tell the customer something about their claim
+         * @description CLM-006. Adds an entry to the customer's timeline directly, without an internal note behind it - which is the ordinary case, because most of what a broker tells a customer was never a note.
+         *
+         *     The timeline is append-only: there is no route that edits or removes an entry. A broker who told a customer something wrong tells them again, and the record keeps both.
+         */
+        post: operations["RecordClaimTimelineEntry"];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     "/api/v1/customer/claims": {
         parameters: {
             query?: never;
@@ -951,6 +1051,30 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
+    "/api/v1/customer/claims/{id}/timeline": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * Read what your broker has told you about your claim
+         * @description CLM-006. What your broker has chosen to tell you, oldest first.
+         *
+         *     **This is everything there is to see.** It is not a filtered view of your broker's own notes with the private parts removed - your broker's working papers are a different record entirely, which nothing here can reach (ADR-0041 section 3). When your broker wants you to know what one of their notes says, they publish it, and it appears here as an entry with the time they told you.
+         *
+         *     Each entry says what you were told and when. It does not say which member of staff decided to tell you.
+         */
+        get: operations["GetOwnClaimTimeline"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     "/api/v1/customer/claims/{id}": {
         parameters: {
             query?: never;
@@ -2943,6 +3067,18 @@ export interface components {
             items: components["schemas"]["ProductResponse"][];
             nextCursor: null | string;
         };
+        ClaimNoteResponse: {
+            /** Format: uuid */
+            id: string;
+            /** Format: uuid */
+            claimId: string;
+            body: string;
+            /** Format: date-time */
+            writtenAtUtc: string;
+            writtenBySubjectId: string;
+            /** Format: date-time */
+            publishedAtUtc: null | string;
+        };
         ClaimResponse: {
             /** Format: uuid */
             id: string;
@@ -2957,6 +3093,17 @@ export interface components {
             status: string;
             /** Format: date-time */
             retentionAnchorAtUtc: null | string;
+            /** Format: uuid */
+            claimFormSubmissionId: null | string;
+        };
+        ClaimTimelineEntryResponse: {
+            /** Format: uuid */
+            id: string;
+            /** Format: uuid */
+            claimId: string;
+            body: string;
+            /** Format: date-time */
+            occurredAtUtc: string;
         };
         ComparedAttributeResponse: {
             key: string;
@@ -3935,6 +4082,10 @@ export interface components {
             answers: null | components["schemas"]["JsonElement"];
             source: null | string;
         };
+        RecordClaimFormRequest: {
+            /** Format: uuid */
+            submissionId: string;
+        };
         RecordFollowUpRequest: {
             /** Format: date */
             dueOn: null | string;
@@ -3953,6 +4104,9 @@ export interface components {
             /** Format: uuid */
             quoteRequestId: null | string;
         };
+        RecordTimelineEntryRequest: {
+            body: string;
+        };
         RedeemedCustomerAccountResponse: {
             /** Format: uuid */
             customerId: string;
@@ -4292,6 +4446,9 @@ export interface components {
         WithdrawPlatformAdministratorRequest: {
             reason: null | string;
         };
+        WriteClaimNoteRequest: {
+            body: string;
+        };
     };
     responses: never;
     parameters: never;
@@ -6762,6 +6919,57 @@ export interface operations {
             };
         };
     };
+    RecordClaimForm: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                id: string;
+            };
+            cookie?: never;
+        };
+        requestBody: {
+            content: {
+                "application/json": components["schemas"]["RecordClaimFormRequest"];
+            };
+        };
+        responses: {
+            /** @description OK */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["ClaimResponse"];
+                };
+            };
+            /** @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 */
+            409: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/problem+json": components["schemas"]["ProblemDetails"];
+                };
+            };
+        };
+    };
     WithdrawClaim: {
         parameters: {
             query?: never;
@@ -6800,6 +7008,187 @@ export interface operations {
             };
         };
     };
+    ListClaimNotes: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                id: string;
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description OK */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["ClaimNoteResponse"][];
+                };
+            };
+            /** @description Not Found */
+            404: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+        };
+    };
+    WriteClaimNote: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                id: string;
+            };
+            cookie?: never;
+        };
+        requestBody: {
+            content: {
+                "application/json": components["schemas"]["WriteClaimNoteRequest"];
+            };
+        };
+        responses: {
+            /** @description Created */
+            201: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["ClaimNoteResponse"];
+                };
+            };
+            /** @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;
+            };
+        };
+    };
+    PublishClaimNote: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                id: string;
+                noteId: string;
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description Created */
+            201: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["ClaimTimelineEntryResponse"];
+                };
+            };
+            /** @description Not Found */
+            404: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+            /** @description Conflict */
+            409: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/problem+json": components["schemas"]["ProblemDetails"];
+                };
+            };
+        };
+    };
+    ListClaimTimeline: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                id: string;
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description OK */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["ClaimTimelineEntryResponse"][];
+                };
+            };
+            /** @description Not Found */
+            404: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+        };
+    };
+    RecordClaimTimelineEntry: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                id: string;
+            };
+            cookie?: never;
+        };
+        requestBody: {
+            content: {
+                "application/json": components["schemas"]["RecordTimelineEntryRequest"];
+            };
+        };
+        responses: {
+            /** @description Created */
+            201: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["ClaimTimelineEntryResponse"];
+                };
+            };
+            /** @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;
+            };
+        };
+    };
     ReportOwnClaim: {
         parameters: {
             query?: never;
@@ -6833,6 +7222,35 @@ export interface operations {
             };
         };
     };
+    GetOwnClaimTimeline: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                id: string;
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description OK */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["ClaimTimelineEntryResponse"][];
+                };
+            };
+            /** @description Not Found */
+            404: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+        };
+    };
     GetOwnClaim: {
         parameters: {
             query?: never;

package/package.json

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