@insurance-broker/api-client 1.7.0 → 1.9.0

package/dist/schema.d.ts

@@ -1867,6 +1867,94 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
+    "/api/v1/renewals/{id}/quote-request": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        /**
+         * Name the quote request this renewal went to market on
+         * @description REN-004. A renewal that goes to market raises an ordinary quote request through the quote routes; this records which one. It records no terms and satisfies no condition - going to market is not a promise about anything. Refused if the quote request has already been accepted by someone else or for another product, if its acceptance predates the renewal - which means it is the quote that placed the policy being renewed - or if another renewal already names it.
+         */
+        put: operations["RecordRenewalQuoteRequest"];
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/api/v1/renewals/{id}/terms": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        /**
+         * Record that the customer accepted this renewal's quote
+         * @description REN-004. Reads the acceptance for the quote request this renewal already names and satisfies both terms conditions from it, because a quote cannot be accepted unless it was presented. Takes no body: the request is the one on the case, so this cannot be pointed at a different quote. The customer accepts on the quote itself - this platform has no route for a broker to accept on their behalf - so this is refused until they have, naming the conditions still outstanding. It creates no policy and moves no policy's status: two of the five conditions remain.
+         */
+        put: operations["RecordRenewalTerms"];
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        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;
@@ -3658,6 +3746,10 @@ export interface components {
             /** Format: uuid */
             formSubmissionId: null | string;
         };
+        RecordRenewalQuoteRequestRequest: {
+            /** Format: uuid */
+            quoteRequestId: null | string;
+        };
         RedeemedCustomerAccountResponse: {
             /** Format: uuid */
             customerId: string;
@@ -3687,6 +3779,21 @@ export interface components {
         RenameFormDefinitionRequest: {
             name: null | 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;
@@ -3722,6 +3829,25 @@ 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;
+            /** Format: uuid */
+            quoteRequestId: string;
+            status: string;
+            /** Format: date-time */
+            insurerTermsSatisfiedAtUtc: null | string;
+            /** Format: date-time */
+            customerAcceptanceSatisfiedAtUtc: null | string;
+        };
         RepinnedSubmissionResponse: {
             submission: components["schemas"]["FormSubmissionResponse"];
             carriedAnswerKeys: string[];
@@ -8902,6 +9028,198 @@ export interface operations {
             };
         };
     };
+    RecordRenewalQuoteRequest: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                id: string;
+            };
+            cookie?: never;
+        };
+        requestBody: {
+            content: {
+                "application/json": components["schemas"]["RecordRenewalQuoteRequestRequest"];
+            };
+        };
+        responses: {
+            /** @description OK */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["RenewalTermsResponse"];
+                };
+            };
+            /** @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"];
+                };
+            };
+            /** @description Unprocessable Entity */
+            422: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/problem+json": components["schemas"]["ProblemDetails"];
+                };
+            };
+        };
+    };
+    RecordRenewalTerms: {
+        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"]["RenewalTermsResponse"];
+                };
+            };
+            /** @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"];
+                };
+            };
+        };
+    };
+    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.7.0",
+  "version": "1.9.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,