@insurance-broker/api-client 1.26.0 → 1.28.0

package/dist/schema.d.ts

@@ -858,7 +858,19 @@ export interface paths {
             path?: never;
             cookie?: never;
         };
-        get?: never;
+        /**
+         * List this broker's claims in one of three views
+         * @description CLM-005. The broker's claims, newest notification first, in one of three views named by `view`: `open` is every claim still being worked, and `withdrawn` and `closed` are the two concluded outcomes. Optionally narrowed by product, insurer, customer or policy. Paged by cursor.
+         *
+         *     **Carries identifiers and no names.** A product's name and an insurer's live in the catalogue and a customer's in CRM, so a client joins those surfaces itself (ADR-0002).
+         *
+         *     **There is no filter for the member of staff working a claim, because a claim does not record one.** Nothing in this phase assigns claim work; a renewal case carries an assignee and a claim does not, and inventing the column here would be inventing an assignment model inside a list.
+         *
+         *     **`status` is what the broker is doing, never what an insurer decided** (ADR-0041 section 2). What an insurer said is a separate recorded fact with its own route and its own provenance.
+         *
+         *     Another broker's claims are not in any view. The tenant is never a parameter here: it comes from the caller's own session, and the four filters this route accepts all narrow within it.
+         */
+        get: operations["ListClaims"];
         put?: never;
         /**
          * Record a first notice of loss against a policy
@@ -1197,7 +1209,45 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
-    "/api/v1/customer/claims": {
+    "/api/v1/claims/{id}/outstanding-items": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * Read what a claim is or was waiting on
+         * @description CLM-005. Everything recorded as outstanding on this claim, newest raised first.
+         *
+         *     `outstanding=true` narrows it to what is still being waited on - the operational question, *what is holding this up* - and `outstanding=false` to what has arrived. Absent, the whole history comes back.
+         *
+         *     Ordered on when an item was **raised** and never on when it was resolved: the list is a history, and ordering on a column that changes moves the boundaries under a reader.
+         *
+         *     **Staff only.** A customer is told what you need from them by being told, on their timeline, in words you chose - not by being handed the working list, which also names everything you owe.
+         */
+        get: operations["ListClaimOutstandingItems"];
+        put?: never;
+        /**
+         * Record that a claim is waiting on something
+         * @description CLM-005. Records what this claim is waiting on, and which side owes it.
+         *
+         *     **This creates a row and never changes the claim's status.** A claim waiting on a customer's photographs is still `Notified`, because the broker is still assisting - which is what that status says (ADR-0041 section 5). A status could not have said *what* is outstanding in any case, which is the other half of why this is a row.
+         *
+         *     **What is outstanding is your own words, not a code from a list.** This platform does not name insurance fields, so there is no vocabulary of permitted items and there will not be one; a broker's own list of the things it asks for is that broker's configuration.
+         *
+         *     **The side is a closed set of two.** `Customer` means the customer owes it and you are waiting on them. `Broker` means you owe it - including when it is your insurer who is waiting. If you in turn need something from the customer to produce it, that is a second item, because it is a different wait with a different person to chase.
+         *
+         *     Refused with 409 once the claim has concluded: nobody is waiting on a claim you have stopped working, and closing starts the disposal clock on everything filed against it.
+         */
+        post: operations["RaiseClaimOutstandingItem"];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/api/v1/claims/{id}/outstanding-items/{itemId}/resolution": {
         parameters: {
             query?: never;
             header?: never;
@@ -1206,6 +1256,100 @@ export interface paths {
         };
         get?: never;
         put?: never;
+        /**
+         * Record that what a claim was waiting on has arrived
+         * @description CLM-005. Marks one outstanding item as received, naming you and the instant.
+         *
+         *     **This is allowed after the claim has concluded**, which is the one place this surface differs from everything else that hangs off a claim. Filing evidence or recording a dealing with an insurer against a closed claim is refused, because both write a row that would carry no disposal clock. This writes no row - it stamps two columns on one that already has a clock - and a police report that arrives in January against a claim closed in December is a fact the record may not be made to deny.
+         *
+         *     A second resolution is refused with 409 naming who dealt with it. Somebody read the item outstanding and decided from it, and overwriting their name would lose the only record of who did the work. Nothing here edits the description or moves the side: correcting a mistake is resolving the wrong item and raising the right one, which is what happened.
+         */
+        post: operations["ResolveClaimOutstandingItem"];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/api/v1/claims/{id}/appointments": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * Read the visits arranged about a claim
+         * @description CLM-005. Every visit recorded against this claim, soonest first, cancelled ones included and marked as such - a diary is read forwards, and a visit that was called off is part of the account of how the claim went.
+         *
+         *     **Staff only**, for the same reason the outstanding items are.
+         */
+        get: operations["ListClaimAppointments"];
+        put?: never;
+        /**
+         * Record a visit arranged about a claim
+         * @description CLM-005. Records that somebody is expected - an assessor, a repairer, a surveyor - and when.
+         *
+         *     **There is no appointment type and no provider directory, and that is deliberate.** This platform does not name a trade, a service or a provider on behalf of every broker in every country it serves (ADR-0041 section 6). What the visit is for, and who is coming if you want that written down, is `purpose` - your own words.
+         *
+         *     **The time may be in the past**, so last week's visit can be written up on Friday. It is an instant rather than a day, because the time of day is the operative fact about a visit.
+         *
+         *     **Nothing here is a status on the claim.** A claim with an assessor booked is still `Notified`.
+         *
+         *     **There is no reschedule.** Moving a visit is cancelling one and arranging another, which is what actually happened and what a customer told twice experienced; a date that could be edited would leave nothing saying anybody was ever expected on the first day.
+         *
+         *     Refused with 409 once the claim has concluded.
+         */
+        post: operations["ArrangeClaimAppointment"];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/api/v1/claims/{id}/appointments/{appointmentId}/cancellation": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        /**
+         * Record that a visit was called off
+         * @description CLM-005. Marks one appointment cancelled, naming you and the instant.
+         *
+         *     **Allowed after the claim has concluded**, for the same reason resolving an outstanding item is: it writes no row, and an assessor stood down in January for a claim closed in December is a thing that happened.
+         *
+         *     A second cancellation is refused with 409. There is no reason field - why a visit was called off is a note, and who did it and when is on the row and in the audit trail.
+         */
+        post: operations["CancelClaimAppointment"];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/api/v1/customer/claims": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * List the claims you have reported
+         * @description CLM-006. Every claim of yours, most recent incident first, paged by cursor.
+         *
+         *     **You are not named in the request.** There is no customer field and no broker field: the list is whoever is signed in, resolved from the session. Another person's claims are not in it - not filtered out of it, but absent, because a claim that is not yours is not visible to this route at all.
+         *
+         *     **This carries nothing your broker wrote for themselves.** Each row says what the claim is and what your broker is doing about it. Your broker's working notes are a different record entirely, which nothing here can reach (ADR-0041 section 3); what they have chosen to tell you is on each claim's own timeline.
+         *
+         *     **`status` is what your broker is doing, never what your insurer decided** (ADR-0041 section 2). What the insurer said is on each claim's own insurer-outcomes route.
+         */
+        get: operations["ListOwnClaims"];
+        put?: never;
         /**
          * Report a loss on one of your own policies
          * @description CLM-001, the customer's half. Opens a claim-assistance case against a policy you own: the broker is helping, and nothing here decides anything about cover.
@@ -3271,6 +3415,11 @@ export interface components {
             insurerId: null | string;
             channel: null | string;
         };
+        ArrangeClaimAppointmentRequest: {
+            /** Format: date-time */
+            scheduledAtUtc: string;
+            purpose: string;
+        };
         AskAboutQuoteRequest: {
             /** Format: uuid */
             presentationVersionId: null | string;
@@ -3317,6 +3466,22 @@ export interface components {
             items: components["schemas"]["ProductResponse"][];
             nextCursor: null | string;
         };
+        ClaimAppointmentResponse: {
+            /** Format: uuid */
+            id: string;
+            /** Format: uuid */
+            claimId: string;
+            /** Format: date-time */
+            scheduledAtUtc: string;
+            purpose: string;
+            arrangedBySubjectId: string;
+            /** Format: date-time */
+            arrangedAtUtc: string;
+            cancelledBySubjectId: null | string;
+            /** Format: date-time */
+            cancelledAtUtc: null | string;
+            isCancelled: boolean;
+        };
         ClaimEvidenceResponse: {
             /** Format: uuid */
             id: string;
@@ -3351,6 +3516,25 @@ export interface components {
             /** Format: date-time */
             publishedAtUtc: null | string;
         };
+        ClaimOutstandingItemResponse: {
+            /** Format: uuid */
+            id: string;
+            /** Format: uuid */
+            claimId: string;
+            awaitedFrom: string;
+            description: string;
+            raisedBySubjectId: string;
+            /** Format: date-time */
+            raisedAtUtc: string;
+            resolvedBySubjectId: null | string;
+            /** Format: date-time */
+            resolvedAtUtc: null | string;
+            isOutstanding: boolean;
+        };
+        ClaimPage: {
+            items: components["schemas"]["ClaimSummaryResponse"][];
+            nextCursor: null | string;
+        };
         ClaimResponse: {
             /** Format: uuid */
             id: string;
@@ -3368,6 +3552,27 @@ export interface components {
             /** Format: uuid */
             claimFormSubmissionId: null | string;
         };
+        ClaimSummaryResponse: {
+            /** Format: uuid */
+            id: string;
+            status: string;
+            /** Format: uuid */
+            customerId: string;
+            /** Format: uuid */
+            policyId: string;
+            /** Format: uuid */
+            productId: string;
+            /** Format: uuid */
+            insurerId: string;
+            /** Format: date */
+            incidentOn: string;
+            /** Format: date-time */
+            notifiedAtUtc: string;
+            /** Format: date-time */
+            retentionAnchorAtUtc: null | string;
+            /** Format: uuid */
+            claimFormSubmissionId: null | string;
+        };
         ClaimTimelineEntryResponse: {
             /** Format: uuid */
             id: string;
@@ -3454,6 +3659,10 @@ export interface components {
             name: null | string;
             registrationNumber: null | string;
         };
+        CustomerClaimPage: {
+            items: components["schemas"]["ClaimResponse"][];
+            nextCursor: null | string;
+        };
         CustomerInsurerOutcomeResponse: {
             /** Format: uuid */
             id: string;
@@ -4408,6 +4617,10 @@ export interface components {
             /** Format: date-time */
             declinedAtUtc: null | string;
         };
+        RaiseClaimOutstandingItemRequest: {
+            awaitedFrom: string;
+            description: string;
+        };
         RaiseOutstandingItemRequest: {
             awaitedFrom: null | string;
             description: null | string;
@@ -7217,6 +7430,43 @@ export interface operations {
             };
         };
     };
+    ListClaims: {
+        parameters: {
+            query?: {
+                view?: string;
+                productId?: string;
+                insurerId?: string;
+                customerId?: string;
+                policyId?: 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"]["ClaimPage"];
+                };
+            };
+            /** @description Bad Request */
+            400: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/problem+json": components["schemas"]["HttpValidationProblemDetails"];
+                };
+            };
+        };
+    };
     NotifyClaim: {
         parameters: {
             query?: never;
@@ -7930,6 +8180,287 @@ export interface operations {
             };
         };
     };
+    ListClaimOutstandingItems: {
+        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"]["ClaimOutstandingItemResponse"][];
+                };
+            };
+            /** @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;
+            };
+        };
+    };
+    RaiseClaimOutstandingItem: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                id: string;
+            };
+            cookie?: never;
+        };
+        requestBody: {
+            content: {
+                "application/json": components["schemas"]["RaiseClaimOutstandingItemRequest"];
+            };
+        };
+        responses: {
+            /** @description Created */
+            201: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["ClaimOutstandingItemResponse"];
+                };
+            };
+            /** @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"];
+                };
+            };
+        };
+    };
+    ResolveClaimOutstandingItem: {
+        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"]["ClaimOutstandingItemResponse"];
+                };
+            };
+            /** @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;
+            header?: never;
+            path: {
+                id: string;
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description OK */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["ClaimAppointmentResponse"][];
+                };
+            };
+            /** @description Not Found */
+            404: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+        };
+    };
+    ArrangeClaimAppointment: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                id: string;
+            };
+            cookie?: never;
+        };
+        requestBody: {
+            content: {
+                "application/json": components["schemas"]["ArrangeClaimAppointmentRequest"];
+            };
+        };
+        responses: {
+            /** @description Created */
+            201: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["ClaimAppointmentResponse"];
+                };
+            };
+            /** @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"];
+                };
+            };
+        };
+    };
+    CancelClaimAppointment: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                id: string;
+                appointmentId: string;
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description OK */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["ClaimAppointmentResponse"];
+                };
+            };
+            /** @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?: {
+                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"]["CustomerClaimPage"];
+                };
+            };
+            /** @description Bad Request */
+            400: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/problem+json": components["schemas"]["HttpValidationProblemDetails"];
+                };
+            };
+        };
+    };
     ReportOwnClaim: {
         parameters: {
             query?: never;

package/package.json

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