@insurance-broker/api-client 2.18.0 → 2.19.0

package/dist/schema.d.ts

@@ -2032,6 +2032,30 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
+    "/api/v1/claims/{id}/outstanding-items/{itemId}/publication": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        /**
+         * Tell the customer what their claim is waiting on
+         * @description CLM-005, CLM-006. Copies one outstanding item onto the customer's timeline as an entry of kind `OutstandingItem`, carrying the description **as you wrote it** and which side owes it, and recording who decided to and when.
+         *
+         *     **Publishing is the judgment that the words are fit for the customer.** An item is written for your own desk, and some of those words are not addressed to the customer even when the customer owes the thing - so nothing is published by default, and there is no second field to say it differently in. If the description is not something you would say to them, tell them on the timeline in words you would, and leave the item unpublished.
+         *
+         *     **A copy, not a flag.** The item is unchanged, and resolving it afterwards does not reach back into the timeline: tell the customer it arrived as a further entry. Publishing the same item twice is refused with 409, as a note is. Refused with 409 once the item has been resolved - the entry would say you are waiting on something you already have - and once the claim has concluded.
+         */
+        post: operations["PublishClaimOutstandingItem"];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     "/api/v1/claims/{id}/appointments": {
         parameters: {
             query?: never;
@@ -2092,6 +2116,30 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
+    "/api/v1/claims/{id}/appointments/{appointmentId}/publication": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        /**
+         * Tell the customer a visit has been arranged
+         * @description CLM-005, CLM-006. Copies one appointment onto the customer's timeline as an entry of kind `Appointment`, carrying the purpose **as you wrote it** and when the visit is expected, and recording who decided to and when.
+         *
+         *     **Whether the customer learns who is coming is whatever you wrote.** This platform names no assessor, adjuster or provider on your behalf; the purpose is your sentence, and publishing it is your judgment that it reads well to the person who has to be there.
+         *
+         *     **A copy, not a flag.** The appointment is unchanged, and cancelling it afterwards does not reach back into the timeline: tell the customer it was called off as a further entry. Publishing the same visit twice is refused with 409, as a note is. Refused with 409 once the visit has been cancelled - the entry would say somebody is coming who is not - and once the claim has concluded.
+         */
+        post: operations["PublishClaimAppointment"];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     "/api/v1/customer/claims": {
         parameters: {
             query?: never;
@@ -2146,6 +2194,8 @@ export interface paths {
          *     **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.
+         *
+         *     **`kind` says what shape of thing you were told.** `Message` is something your broker wrote to you. `OutstandingItem` is something your claim is waiting on, published so you know what is needed and from whom - `awaitedFrom` says whether it is you or your broker who owes it. `Appointment` is a visit arranged about your claim - `scheduledAtUtc` says when. In every case `body` is your broker's own words. An entry is a copy made at the moment you were told: if what your claim is waiting on has since arrived, or a visit has since been called off, your broker tells you that as a further entry.
          */
         get: operations["GetOwnClaimTimeline"];
         put?: never;
@@ -5938,6 +5988,10 @@ export interface components {
             body: string;
             /** Format: date-time */
             occurredAtUtc: string;
+            kind: string;
+            awaitedFrom: null | string;
+            /** Format: date-time */
+            scheduledAtUtc: null | string;
         };
         CloseClaimRequest: {
             reason: string;
@@ -12905,6 +12959,45 @@ export interface operations {
             };
         };
     };
+    PublishClaimOutstandingItem: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                id: string;
+                itemId: 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"];
+                };
+            };
+        };
+    };
     ListClaimAppointments: {
         parameters: {
             query?: never;
@@ -13024,6 +13117,45 @@ export interface operations {
             };
         };
     };
+    PublishClaimAppointment: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                id: string;
+                appointmentId: 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"];
+                };
+            };
+        };
+    };
     ListOwnClaims: {
         parameters: {
             query?: {

package/package.json

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