@insurance-broker/api-client 1.8.0 → 1.10.0

package/dist/schema.d.ts

@@ -1847,6 +1847,30 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
+    "/api/v1/renewals": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * List this broker's renewals in one of REN-008's four views
+         * @description REN-008. One of four views, named by `view`: `upcoming` and `overdue` are the live cases split by whether the previous cover end has passed the day the page was measured against, and `lost` and `completed` are the two terminal outcomes. Optionally narrowed by product, insurer or assigned staff member, which is REN-008's grouping. Paged by cursor, oldest previous-cover-end first.
+         *
+         *     **"Overdue" is not a status.** No row stores it: it is computed per request from the case's previous cover end against today, and the day used is returned as `asOf` so a page saying twelve are overdue also says what overdue was measured from.
+         *
+         *     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).
+         */
+        get: operations["ListRenewals"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     "/api/v1/renewals/{id}/customer-information": {
         parameters: {
             query?: never;
@@ -1907,6 +1931,54 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
+    "/api/v1/renewals/{id}/completion": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        /**
+         * Complete a renewal: open the successor policy and supersede the previous cover
+         * @description REN-007. The phase's exit criterion. Opens a policy from the acceptance this renewal's quote request already carries, links it to the case, and moves the previous policy to renewed with the instant its successor took over - all in one transaction, so the case's status, the link, the new policy and the previous policy's stamp commit together or not at all. Takes no body: the quote request is the one on the case, so this cannot be pointed at a different acceptance.
+         *
+         *     The successor is created proposed and nothing here binds cover (BR-005). It becomes active only when an insurer's confirmation is recorded against it, through the policy routes - so the renewal's insurer-confirmation condition is still outstanding after this, and so is approval where a broker requires it. REN-005's customer-facing renewal surface is untouched.
+         *
+         *     Refused if the customer has not accepted, if the renewal never went to market, if nothing has been accepted on the quote request it names, or if the previous policy never went into force - cover that was never in force cannot be renewed, and such a renewal is concluded as lost instead. Completing twice reads back the first result rather than making a second policy.
+         */
+        post: operations["CompleteRenewal"];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/api/v1/renewals/{id}/loss": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        /**
+         * Conclude a renewal that produced no replacement cover
+         * @description REN-008. Records that this renewal ended without a successor - the customer went elsewhere, the insurer declined, or nobody acted before the cover ended - and expires the previous policy where its cover was in force. This is the door ADR-0035 names for the expired status: a renewal process concluding without replacement. Nothing sweeps a policy there.
+         *
+         *     A previous policy that never went into force is left exactly where it stands, which is the correct outcome and not an error: cover that was never in force did not expire. The response says which of the two happened.
+         *
+         *     It creates no policy, satisfies no outstanding condition and withdraws none - a condition still outstanding when the renewal was given up stays outstanding, because that is what happened. Concluding twice reads back the first result. Refused only if the case has already concluded some other way.
+         */
+        post: operations["LoseRenewal"];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     "/api/v1/customer/policy-documents": {
         parameters: {
             query?: never;
@@ -3731,6 +3803,47 @@ export interface components {
         RenameFormDefinitionRequest: {
             name: null | string;
         };
+        RenewalCasePage: {
+            items: components["schemas"]["RenewalCaseSummaryResponse"][];
+            nextCursor: null | string;
+            /** Format: date */
+            asOf: string;
+        };
+        RenewalCaseSummaryResponse: {
+            /** Format: uuid */
+            id: string;
+            status: string;
+            /** Format: uuid */
+            customerId: null | string;
+            /** Format: uuid */
+            previousPolicyId: string;
+            /** Format: uuid */
+            newPolicyId: null | string;
+            /** Format: uuid */
+            productId: string;
+            /** Format: uuid */
+            insurerId: string;
+            assignedToSubjectId: null | string;
+            /** Format: date */
+            previousCoverEnd: string;
+            /** Format: date-time */
+            openedAtUtc: string;
+        };
+        RenewalCompletionResponse: {
+            /** Format: uuid */
+            renewalCaseId: string;
+            status: string;
+            /** Format: uuid */
+            quoteRequestId: string;
+            /** Format: uuid */
+            newPolicyId: string;
+            newPolicyStatus: string;
+            /** Format: uuid */
+            previousPolicyId: string;
+            previousPolicyStatus: string;
+            /** Format: date-time */
+            previousPolicyRenewedAtUtc: null | string;
+        };
         RenewalCustomerInformationResponse: {
             /** Format: uuid */
             renewalCaseId: string;
@@ -3766,6 +3879,14 @@ export interface components {
             changedAtUtc: null | string;
             changedBySubjectId: null | string;
         };
+        RenewalLossResponse: {
+            /** Format: uuid */
+            renewalCaseId: string;
+            status: string;
+            /** Format: uuid */
+            previousPolicyId: string;
+            previousPolicyStatus: string;
+        };
         RenewalTermsResponse: {
             /** Format: uuid */
             renewalCaseId: string;
@@ -8897,6 +9018,42 @@ export interface operations {
             };
         };
     };
+    ListRenewals: {
+        parameters: {
+            query?: {
+                view?: string;
+                productId?: string;
+                insurerId?: string;
+                assignedToSubjectId?: 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"]["RenewalCasePage"];
+                };
+            };
+            /** @description Bad Request */
+            400: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/problem+json": components["schemas"]["HttpValidationProblemDetails"];
+                };
+            };
+        };
+    };
     RecordRenewalCustomerInformation: {
         parameters: {
             query?: never;
@@ -9064,6 +9221,91 @@ export interface operations {
             };
         };
     };
+    CompleteRenewal: {
+        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"]["RenewalCompletionResponse"];
+                };
+            };
+            /** @description Not Found */
+            404: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+            /** @description Conflict */
+            409: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/problem+json": components["schemas"]["ProblemDetails"];
+                };
+            };
+            /** @description Unprocessable Entity */
+            422: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/problem+json": components["schemas"]["ProblemDetails"];
+                };
+            };
+        };
+    };
+    LoseRenewal: {
+        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"]["RenewalLossResponse"];
+                };
+            };
+            /** @description Not Found */
+            404: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+            /** @description Conflict */
+            409: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/problem+json": components["schemas"]["ProblemDetails"];
+                };
+            };
+        };
+    };
     ListCustomerPolicyDocuments: {
         parameters: {
             query?: {

package/package.json

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