@insurance-broker/api-client 3.0.1 → 3.2.0

package/dist/schema.d.ts

@@ -1655,15 +1655,15 @@ export interface paths {
         };
         /**
          * 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.
+         * @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, policy or the member of staff working the claim. 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).
+         *     **Carries identifiers and no names.** A product's name and an insurer's live in the catalogue, a customer's in CRM and a member of staff's in identity and access, 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.
+         *     **`assignedToSubjectId` is what is on one person's desk, and `unassigned=true` is the work nobody has taken.** The two cannot be combined. An assignee is kept when a claim concludes, so `view=closed` with `assignedToSubjectId` is what that person finished (ADR-0041 section 1).
          *
          *     **`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.
+         *     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 every filter this route accepts narrows within it.
          */
         get: operations["ListClaims"];
         put?: never;
@@ -1782,6 +1782,36 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
+    "/api/v1/claims/{id}/assignment": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        /**
+         * Give a claim to a member of staff, or move it to a different one
+         * @description Records who is working a claim, so a broker can ask what is on one person's desk (ADR-0041 section 1).
+         *
+         *     The assignee must be an active member of this broker who holds `claims.cases.manage` - somebody who can work the claim they are given. A subject that is not, or that belongs to another broker, is refused with the same `400`, so the route cannot be used to learn who works where.
+         *
+         *     Giving a claim to the person who already has it changes nothing and answers `200`. A claim that has concluded is refused with `409`: its assignee is kept as the record of who had it, and is not moved afterwards.
+         *
+         *     **Never shown to the customer.** The customer's view of their claim carries no member of staff (ADR-0033 section 8).
+         */
+        post: operations["AssignClaim"];
+        /**
+         * Take a claim off whoever has it
+         * @description Returns a claim to unassigned work, where `unassigned=true` on the list finds it. A claim nobody has changes nothing and answers `200`. A claim that has concluded is refused with `409`, for the reason assigning one is.
+         */
+        delete: operations["UnassignClaim"];
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     "/api/v1/claims/{id}/notes": {
         parameters: {
             query?: never;
@@ -3885,9 +3915,9 @@ export interface paths {
          *
          *     **A payment posting does not do this** (ADR-0042 section 7). If it did, the platform would be asserting that cover began. A person looks at a payment and records that the requirement is discharged: the payment is the evidence, the person is the actor, and the platform is neither. There is no consumer, no sweep and no side effect that reaches this route.
          *
-         *     **Only a policy in `pendingPayment` can be released, and only once.** Recording it against a policy no gate ever held would write an evidence trail for a requirement that never existed.
+         *     **Only a policy in `pendingPayment` can be released, and only once.** Recording it against a policy no gate ever held would write an evidence trail for a requirement that never existed; that is a `409`.
          *
-         *     **The `paymentId` is recorded and not verified.** The payment lives in another module this one may not read (ADR-0002), so a mistyped identifier is a bad record rather than a refusal - issue #306 carries the contract that would check it.
+         *     **The `paymentId` must name an approved payment against a charge for this policy** (PAY-003, ADR-0042 section 7). A payment posts and settles its charge the moment it is recorded, but it releases cover only once a second person has approved it. Anything else is a `422` of type `urn:brokerplatform:problem:unusable-payment-evidence`, with one entry under `violations` whose `code` is `payment-not-this-policys` (no such payment in this broker's books, or one against another policy - deliberately the same answer), `payment-reversed`, or `payment-not-approved`.
          */
         post: operations["RecordPaymentRequirementMet"];
         delete?: never;
@@ -5882,6 +5912,9 @@ export interface components {
             name: string;
             description: null | string;
         };
+        AssignClaimRequest: {
+            assigneeSubjectId: null | string;
+        };
         AssignLeadRequest: {
             advisorSubjectId: null | string;
         };
@@ -5986,6 +6019,26 @@ export interface components {
             cancelledAtUtc: null | string;
             isCancelled: boolean;
         };
+        ClaimDetailResponse: {
+            /** 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;
+            /** Format: uuid */
+            claimFormSubmissionId: null | string;
+            assignedToSubjectId: null | string;
+            /** Format: date-time */
+            assignedAtUtc: null | string;
+        };
         ClaimEvidenceResponse: {
             /** Format: uuid */
             id: string;
@@ -6076,6 +6129,9 @@ export interface components {
             retentionAnchorAtUtc: null | string;
             /** Format: uuid */
             claimFormSubmissionId: null | string;
+            assignedToSubjectId: null | string;
+            /** Format: date-time */
+            assignedAtUtc: null | string;
         };
         ClaimTimelineEntryResponse: {
             /** Format: uuid */
@@ -12407,6 +12463,8 @@ export interface operations {
                 insurerId?: string;
                 customerId?: string;
                 policyId?: string;
+                assignedToSubjectId?: string;
+                unassigned?: boolean;
                 cursor?: string;
                 limit?: number | string;
             };
@@ -12455,7 +12513,7 @@ export interface operations {
                     [name: string]: unknown;
                 };
                 content: {
-                    "application/json": components["schemas"]["ClaimResponse"];
+                    "application/json": components["schemas"]["ClaimDetailResponse"];
                 };
             };
             /** @description Bad Request */
@@ -12486,7 +12544,7 @@ export interface operations {
                     [name: string]: unknown;
                 };
                 content: {
-                    "application/json": components["schemas"]["ClaimResponse"];
+                    "application/json": components["schemas"]["ClaimDetailResponse"];
                 };
             };
             /** @description Not Found */
@@ -12519,7 +12577,7 @@ export interface operations {
                     [name: string]: unknown;
                 };
                 content: {
-                    "application/json": components["schemas"]["ClaimResponse"];
+                    "application/json": components["schemas"]["ClaimDetailResponse"];
                 };
             };
             /** @description Bad Request */
@@ -12570,7 +12628,7 @@ export interface operations {
                     [name: string]: unknown;
                 };
                 content: {
-                    "application/json": components["schemas"]["ClaimResponse"];
+                    "application/json": components["schemas"]["ClaimDetailResponse"];
                 };
             };
             /** @description Bad Request */
@@ -12617,7 +12675,96 @@ export interface operations {
                     [name: string]: unknown;
                 };
                 content: {
-                    "application/json": components["schemas"]["ClaimResponse"];
+                    "application/json": components["schemas"]["ClaimDetailResponse"];
+                };
+            };
+            /** @description Not Found */
+            404: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+            /** @description Conflict */
+            409: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/problem+json": components["schemas"]["ProblemDetails"];
+                };
+            };
+        };
+    };
+    AssignClaim: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                id: string;
+            };
+            cookie?: never;
+        };
+        requestBody: {
+            content: {
+                "application/json": components["schemas"]["AssignClaimRequest"];
+            };
+        };
+        responses: {
+            /** @description OK */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["ClaimDetailResponse"];
+                };
+            };
+            /** @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"];
+                };
+            };
+        };
+    };
+    UnassignClaim: {
+        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"]["ClaimDetailResponse"];
                 };
             };
             /** @description Not Found */
@@ -17937,6 +18084,15 @@ export interface operations {
                     "application/problem+json": components["schemas"]["ProblemDetails"];
                 };
             };
+            /** @description Unprocessable Entity */
+            422: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/problem+json": components["schemas"]["ProblemDetails"];
+                };
+            };
         };
     };
     GetPolicy: {

package/package.json

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