@insurance-broker/api-client 2.7.0 → 2.9.0

package/dist/schema.d.ts

@@ -39,7 +39,9 @@ export interface paths {
          *
          *     With one: a repeat carrying a key already used **returns the original charge and the same `201 Created` with the same `Location`**, so an honest retry is indistinguishable from a first call and no second debt exists. A repeat carrying that key with a **different** policy, amount, due date or description is a `409` and raises nothing.
          *
-         *     **A key is honoured for as long as the charge it raised is kept, and nothing sweeps keys.** It is stored on the obligation rather than in a store of its own. Mint a fresh key per intended charge; do not recycle one (#394).
+         *     **A key is honoured for 30 days from the moment the charge was raised, and then stops being honoured.** After that the same key is one this platform has never seen, and the request carrying it raises a fresh charge. Mint a fresh key per intended charge; do not recycle one (#394).
+         *
+         *     **Expiry restores no other protection, and that is not an oversight.** Nothing else prevents a duplicate charge: no natural key on `(policy, amount, due date, description)` exists or can, for the reason above. A repeat of a month-old request therefore raises a second debt.
          *
          *     **What a key does not do**: it assumes the retrying client owns it. Two people at two desks recording the same instalment invent two keys, and both charges are raised (ADR-0042 §19).
          *
@@ -3978,6 +3980,10 @@ export interface paths {
          *
          *     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).
          *
+         *     `customerAnswers` is what the customer said through their own app (REN-005): confirm, decline or request changes, oldest first, with the short note they may attach to the last two. It is empty on a renewal the customer has not answered, and empty for ever on one only you ever touched - a reconfirmation you recorded on their behalf satisfies the condition and is not one of their answers.
+         *
+         *     **A decline does not conclude anything.** It satisfies no condition and moves no status, so the checklist still reads outstanding and owed by the customer; what changed is that you can now see they answered. Concluding the renewal is still yours, on the loss route.
+         *
          *     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"];
@@ -4289,6 +4295,86 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
+    "/api/v1/customer/renewals": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * The renewals your broker has raised on your policies, most recent first
+         * @description REN-005. Every renewal of yours, paged by cursor.
+         *
+         *     **You are not named in the request.** There is no customer field and no broker field: the list is whoever is signed in, resolved from the session. Another person's renewals are not filtered out of it, they are absent, because a renewal that is not yours is not visible to this route at all.
+         *
+         *     **`status` is where your broker's process has got to, not what you said.** Answering a renewal does not move it: your answer is recorded as a fact against the renewal and your broker concludes the case (ADR-0040 section 3).
+         *
+         *     **Nothing here says you were reminded.** This platform has no notification channel yet, so there is no unread flag and no reminder date: REN-005's reminder half is unmet and tracked as issue #371.
+         *
+         *     `productId` and `insurerId` are identifiers, not names. Read their names from their own routes.
+         */
+        get: operations["ListCustomerRenewals"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/api/v1/customer/renewals/{id}": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * One of your own renewals, what it still needs, and what you have said about it
+         * @description REN-002, REN-005 and REN-006. The renewal, its checklist, and every answer you have given about it.
+         *
+         *     **`enforcedBy` is the field to read before trusting `satisfiedAtUtc`.** A condition nothing on this platform enforces reports `NotBuilt`, so a satisfied condition may mean a rule that does not exist is vacuously satisfied rather than that something happened (ADR-0040 section 4).
+         *
+         *     **`answers` is empty if your broker recorded your reconfirmation for you.** Only an answer you gave through this surface appears there, which is what makes it yours.
+         *
+         *     A renewal belonging to somebody else and a renewal that does not exist are one 404, so this route cannot be used to discover which renewals exist.
+         */
+        get: operations["GetCustomerRenewal"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/api/v1/customer/renewals/{id}/responses": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        /**
+         * Confirm, decline or ask for changes to one of your own renewals
+         * @description REN-005 and REN-003, the customer's half. Send `answer` as one of `Confirmed`, `Declined` or `ChangesRequested`, and the renewal comes back with your answer recorded on it.
+         *
+         *     **`Confirmed` names the form submission you answered**, which you make on the customer form routes. It satisfies the renewal's customer-information condition and is refused if the submission is not your own answer to this policy's product form, or if it was made before the renewal was raised - a submission that predates the renewal is your original application and reconfirms nothing.
+         *
+         *     **`Declined` and `ChangesRequested` change nothing about your cover.** They are recorded for your broker to act on, they satisfy no condition, and they do not end your policy: concluding a renewal is your broker's act, because it expires cover that is still in force. Either may carry one short `note` saying what needs to change.
+         *
+         *     Sending the same answer twice reads the first one back rather than recording it twice, so a lost response or a double tap is safe. You may ask for changes and confirm later; you cannot un-say an answer, and a renewal your broker has already concluded is refused.
+         */
+        post: operations["RespondToCustomerRenewal"];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     "/api/v1/policy-documents/download-links/{token}": {
         parameters: {
             query?: never;
@@ -5804,6 +5890,42 @@ export interface components {
             /** Format: date-time */
             withdrawnAtUtc: null | string;
         };
+        CustomerRenewalAnswerResponse: {
+            /** Format: uuid */
+            id: string;
+            answer: string;
+            /** Format: uuid */
+            formSubmissionId: null | string;
+            note: null | string;
+            /** Format: date-time */
+            recordedAtUtc: string;
+        };
+        CustomerRenewalDetailResponse: {
+            renewal: components["schemas"]["CustomerRenewalSummary"];
+            checklist: components["schemas"]["RenewalChecklistItemResponse"][];
+            answers: components["schemas"]["CustomerRenewalAnswerResponse"][];
+        };
+        CustomerRenewalPage: {
+            items: components["schemas"]["CustomerRenewalSummary"][];
+            nextCursor: null | string;
+        };
+        CustomerRenewalSummary: {
+            /** Format: uuid */
+            id: string;
+            status: string;
+            /** Format: uuid */
+            previousPolicyId: string;
+            /** Format: uuid */
+            newPolicyId: null | string;
+            /** Format: uuid */
+            productId: string;
+            /** Format: uuid */
+            insurerId: string;
+            /** Format: date */
+            previousCoverEnd: string;
+            /** Format: date-time */
+            openedAtUtc: string;
+        };
         CustomerResponse: {
             /** Format: uuid */
             id: string;
@@ -7318,6 +7440,7 @@ export interface components {
             /** Format: uuid */
             quoteRequestId: null | string;
             checklist: components["schemas"]["RenewalChecklistItemResponse"][];
+            customerAnswers: components["schemas"]["CustomerRenewalAnswerResponse"][];
         };
         RenewalCasePage: {
             items: components["schemas"]["RenewalCaseSummaryResponse"][];
@@ -7433,6 +7556,12 @@ export interface components {
             /** Format: date */
             incidentOn: string;
         };
+        RespondToRenewalRequest: {
+            answer: null | string;
+            /** Format: uuid */
+            formSubmissionId: null | string;
+            note: null | string;
+        };
         RetentionPeriodResponse: {
             /** Format: int32 */
             amount: number | string;
@@ -17632,6 +17761,127 @@ export interface operations {
             };
         };
     };
+    ListCustomerRenewals: {
+        parameters: {
+            query?: {
+                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"]["CustomerRenewalPage"];
+                };
+            };
+            /** @description Bad Request */
+            400: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/problem+json": components["schemas"]["HttpValidationProblemDetails"];
+                };
+            };
+        };
+    };
+    GetCustomerRenewal: {
+        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"]["CustomerRenewalDetailResponse"];
+                };
+            };
+            /** @description Not Found */
+            404: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+        };
+    };
+    RespondToCustomerRenewal: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                id: string;
+            };
+            cookie?: never;
+        };
+        requestBody: {
+            content: {
+                "application/json": components["schemas"]["RespondToRenewalRequest"];
+            };
+        };
+        responses: {
+            /** @description OK */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["CustomerRenewalDetailResponse"];
+                };
+            };
+            /** @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"];
+                };
+            };
+        };
+    };
     RedeemPolicyDocumentDownloadLink: {
         parameters: {
             query?: never;

package/package.json

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