@insurance-broker/api-client 1.12.0 → 1.14.0

package/dist/schema.d.ts

@@ -851,6 +851,80 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
+    "/api/v1/claims": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        /**
+         * Record a first notice of loss against a policy
+         * @description CLM-001. Opens a claim-assistance case: the broker is helping, and nothing here decides anything about cover.
+         *
+         *     **The insurer decides, and this platform records.** A claim has no `Approved`, `Declined` or `Settled` state, because those are not states this platform can enter (ADR-0041 section 2). `status` says what the broker is doing.
+         *
+         *     **One refusal covers four facts.** A policy that does not exist, one belonging to another broker, one belonging to another customer, and one not in force on the incident date are all answered the same way, so the route cannot be used to discover which policies a broker holds.
+         *
+         *     The customer is named in the request and is not believed: it is checked against the policy, and the claim records the owner the policy gave.
+         */
+        post: operations["NotifyClaim"];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/api/v1/claims/{id}": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * Read one claim
+         * @description CLM-001. The claim's identifiers, the day of the incident, when the broker was told, and what the broker is doing about it.
+         *
+         *     Another broker's claim, another customer's claim and a claim that does not exist are one 404, so the route cannot be used to discover which claims exist.
+         *
+         *     `retentionAnchorAtUtc` is null while the claim is open. A claim open for two years has not started its disposal clock (ADR-0041 section 8).
+         */
+        get: operations["GetClaim"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/api/v1/claims/{id}/withdrawal": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        /**
+         * Retract a claim
+         * @description CLM-001. Retracts a notice: the customer decided not to claim, or the notice was raised against the wrong policy.
+         *
+         *     **This is not a decision about cover.** Nothing here says an insurer refused anything, and nothing says the incident did not happen. It records that the broker stopped.
+         *
+         *     Withdrawing concludes the claim, which is what starts its retention clock. A claim that has already concluded is refused with 409 rather than re-stamped, because re-stamping would move the anchor of a record that concluded earlier.
+         */
+        post: operations["WithdrawClaim"];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     "/api/v1/leads": {
         parameters: {
             query?: never;
@@ -1862,7 +1936,7 @@ export interface paths {
          *
          *     **One walk is measured against one day.** `asOf` is read from the clock on the first page and carried inside the cursor, so a walk that crosses UTC midnight stays internally consistent instead of losing part of a tie group as rows leave `upcoming`. The consequence is that a walk resumed the next day still reports - and still uses - the day it started on: compare `asOf` with your own clock and start a new walk without a cursor to get today's split.
          *
-         *     Carries identifiers and no names. A product's name lives in the catalogue, a person's in identity and access, and a customer's in CRM, so a client joins those surfaces itself. A cancelled renewal appears in none of the four views - REN-008 names four and cancelled is not one of them (issue #220).
+         *     Carries identifiers and no names. A product's name lives in the catalogue, a person's in identity and access, and a customer's in CRM, so a client joins those surfaces itself. `cancelled` is a fifth view beyond REN-008's four, so a renewal a broker stopped working is findable rather than reachable only by identifier (issue #220).
          */
         get: operations["ListRenewals"];
         put?: never;
@@ -2819,6 +2893,21 @@ export interface components {
             items: components["schemas"]["ProductResponse"][];
             nextCursor: null | string;
         };
+        ClaimResponse: {
+            /** Format: uuid */
+            id: string;
+            /** Format: uuid */
+            policyId: string;
+            /** Format: uuid */
+            customerId: string;
+            /** Format: date */
+            incidentOn: string;
+            /** Format: date-time */
+            notifiedAtUtc: string;
+            status: string;
+            /** Format: date-time */
+            retentionAnchorAtUtc: null | string;
+        };
         ComparedAttributeResponse: {
             key: string;
             label: string;
@@ -3350,6 +3439,14 @@ export interface components {
             releaseReason: null | string;
             isOpen: boolean;
         };
+        NotifyClaimRequest: {
+            /** Format: uuid */
+            policyId: string;
+            /** Format: uuid */
+            customerId: string;
+            /** Format: date */
+            incidentOn: string;
+        };
         OfferedFormResponse: {
             /** Format: uuid */
             id: string;
@@ -6539,6 +6636,106 @@ export interface operations {
             };
         };
     };
+    NotifyClaim: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody: {
+            content: {
+                "application/json": components["schemas"]["NotifyClaimRequest"];
+            };
+        };
+        responses: {
+            /** @description Created */
+            201: {
+                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"];
+                };
+            };
+        };
+    };
+    GetClaim: {
+        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"]["ClaimResponse"];
+                };
+            };
+            /** @description Not Found */
+            404: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+        };
+    };
+    WithdrawClaim: {
+        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"]["ClaimResponse"];
+                };
+            };
+            /** @description Not Found */
+            404: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+            /** @description Conflict */
+            409: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/problem+json": components["schemas"]["ProblemDetails"];
+                };
+            };
+        };
+    };
     ListLeads: {
         parameters: {
             query?: {

package/package.json

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