@insurance-broker/api-client 1.9.0 → 1.11.0

package/dist/schema.d.ts

@@ -1847,6 +1847,56 @@ 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}": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * Read one renewal and its checklist
+         * @description REN-002 and REN-006. The case's identifiers and stored status, the identifiers of what satisfied its reconfirmation and its terms, and its checklist: one row per condition with which side owes it, what enforces it, whether this case requires it, and when it was satisfied.
+         *
+         *     **`enforcedBy` is the field to read before trusting `satisfiedAtUtc`.** A condition nothing on this platform enforces reports `NotBuilt`, so a satisfied payment condition means a payment rule that does not exist is vacuously satisfied - not that a payment was taken (ADR-0040 section 4).
+         *
+         *     Every condition is resolved onto every case, so `approval` is present with `isRequired` false rather than absent. Read `isRequired` instead of assuming: a broker's configuration moves the flag, not the row (ADR-0040 section 4).
+         *
+         *     Carries identifiers and no names, and not the previous policy's pinned snapshot. Another broker's case, another customer's case and a case that does not exist are one 404, so the route cannot be used to discover which renewals exist.
+         */
+        get: operations["GetRenewal"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     "/api/v1/renewals/{id}/customer-information": {
         parameters: {
             query?: never;
@@ -3779,6 +3829,49 @@ export interface components {
         RenameFormDefinitionRequest: {
             name: null | string;
         };
+        RenewalCaseDetailResponse: {
+            case: components["schemas"]["RenewalCaseSummaryResponse"];
+            /** Format: uuid */
+            customerInformationSubmissionId: null | string;
+            customerInformationDefinitionContentHash: null | string;
+            /** Format: uuid */
+            quoteRequestId: null | string;
+            checklist: components["schemas"]["RenewalChecklistItemResponse"][];
+        };
+        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;
+        };
+        RenewalChecklistItemResponse: {
+            condition: string;
+            owedBy: string;
+            enforcedBy: string;
+            isRequired: boolean;
+            /** Format: date-time */
+            satisfiedAtUtc: null | string;
+        };
         RenewalCompletionResponse: {
             /** Format: uuid */
             renewalCaseId: string;
@@ -8968,6 +9061,73 @@ 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"];
+                };
+            };
+        };
+    };
+    GetRenewal: {
+        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"]["RenewalCaseDetailResponse"];
+                };
+            };
+            /** @description Not Found */
+            404: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/problem+json": components["schemas"]["ProblemDetails"];
+                };
+            };
+        };
+    };
     RecordRenewalCustomerInformation: {
         parameters: {
             query?: never;

package/package.json

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