@insurance-broker/api-client 5.17.0 → 5.19.0

package/dist/schema.d.ts

@@ -1656,6 +1656,28 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
+    "/api/v1/customer/form-submissions/{id}/pinned-version": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        /**
+         * Moves their draft onto the version of its form that is live now.
+         * @description Moves the customer's own draft onto the version of its form that is live now — the answer to a draft read with `pinnedVersionIsLive: false`. Every answer whose question survived is carried, and the ones the new version no longer asks are named in `droppedAnswerKeys`.
+         *
+         *     **A `409` here is a settled fact, and `type` says which** (#459, #470). `urn:brokerplatform:problem:product-not-open-to-new-business` means the product is no longer offered, or no longer exists, so the draft stays on the version it has. `urn:brokerplatform:problem:form-has-no-live-version` means the broker took the form's live version down and there is nothing to move onto. `urn:brokerplatform:problem:draft-already-on-live-version` means there is nothing to move: the draft already answers the live version. `urn:brokerplatform:problem:submission-already-submitted` means the form has been submitted and is never moved. `urn:brokerplatform:problem:form-version-unreadable` means the version it is on, or the one it would move onto, is in a schema this engine cannot read. `urn:brokerplatform:problem:recorded-answers-unreadable` means the answers saved so far cannot be read, so nothing could be carried; saving them again replaces them. `urn:brokerplatform:problem:concurrency-conflict` means another of their devices wrote first; read again and retry.
+         */
+        post: operations["RepinCustomerFormSubmission"];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     "/api/v1/form-submissions/{id}/attachments/{evidenceKey}": {
         parameters: {
             query?: never;
@@ -4731,6 +4753,8 @@ 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).
          *
+         *     **One row is the exception, and it is never the customer's.** `BrokerRecordedInformation` appears only where you recorded what the customer told you (#228). It is owed by the broker, enforced by `ExternalRecord`, and its `recordedFrom` says how you heard; `brokerRecordedInformationBySubjectId` says who recorded it. It satisfies nothing else: the customer's `CustomerInformation` row reads exactly as it would without it.
+         *
          *     `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.
@@ -4766,6 +4790,32 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
+    "/api/v1/renewals/{id}/broker-recorded-information": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        /**
+         * Record that the customer told you their details still stand
+         * @description #228. Records that the customer told you, by telephone, in person, by email or by letter, that the details the renewal rests on still stand. It adds a separate checklist row, `BrokerRecordedInformation`, owed by the broker, enforced by `ExternalRecord`, and carrying `recordedFrom`. That row reads "recorded by the broker from a telephone call" rather than plain "satisfied".
+         *
+         *     **It does not satisfy the customer's own `CustomerInformation` condition, and it never will.** REN-003 asks the customer to confirm their own details. That row stays outstanding and owed by the customer, so the checklist keeps showing that the customer never confirmed anything here. If the customer answers for themselves later, through `customer-information` or their own app, their row is satisfied as usual and both facts stay on the renewal.
+         *
+         *     **A `409` here is a settled fact, and `type` says which.** `urn:brokerplatform:problem:customer-already-confirmed` means the customer confirmed for themselves, so there is nothing for a broker's record to stand in for. `urn:brokerplatform:problem:renewal-concluded` means the renewal has concluded. `urn:brokerplatform:problem:broker-record-already-made` means a broker already recorded it with a different channel; it is recorded once. `urn:brokerplatform:problem:concurrency-conflict` means somebody wrote first; read again and retry.
+         *
+         *     Recording the same channel again reads back what is stored. Records no free text: what the customer said belongs in their CRM record, where it can be corrected.
+         */
+        put: operations["RecordRenewalBrokerRecordedInformation"];
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     "/api/v1/renewals/{id}/quote-request": {
         parameters: {
             query?: never;
@@ -7149,6 +7199,11 @@ export interface components {
             /** Format: date-time */
             openedAtUtc: string;
         };
+        CustomerRepinnedSubmissionResponse: {
+            submission: components["schemas"]["CustomerFormSubmissionResponse"];
+            carriedAnswerKeys: string[];
+            droppedAnswerKeys: string[];
+        };
         CustomerResponse: {
             /** Format: uuid */
             id: string;
@@ -9055,6 +9110,9 @@ export interface components {
             answers: null | components["schemas"]["JsonElement"];
             source: null | string;
         };
+        RecordBrokerRecordedInformationRequest: {
+            channel: null | string;
+        };
         RecordClaimFormRequest: {
             /** Format: uuid */
             submissionId: string;
@@ -9173,6 +9231,14 @@ export interface components {
             name: string;
             legalName: null | string;
         };
+        RenewalBrokerRecordedInformationResponse: {
+            /** Format: uuid */
+            renewalCaseId: string;
+            channel: string;
+            recordedBySubjectId: string;
+            /** Format: date-time */
+            recordedAtUtc: string;
+        };
         RenewalCaseDetailResponse: {
             case: components["schemas"]["RenewalCaseSummaryResponse"];
             /** Format: uuid */
@@ -9182,6 +9248,7 @@ export interface components {
             quoteRequestId: null | string;
             checklist: components["schemas"]["RenewalChecklistItemResponse"][];
             customerAnswers: components["schemas"]["CustomerRenewalAnswerResponse"][];
+            brokerRecordedInformationBySubjectId: null | string;
         };
         RenewalCasePage: {
             items: components["schemas"]["RenewalCaseSummaryResponse"][];
@@ -9217,6 +9284,7 @@ export interface components {
             isRequired: boolean;
             /** Format: date-time */
             satisfiedAtUtc: null | string;
+            recordedFrom: null | string;
         };
         RenewalClockViolationResponse: {
             milestone: string;
@@ -13642,6 +13710,53 @@ export interface operations {
             };
         };
     };
+    RepinCustomerFormSubmission: {
+        parameters: {
+            query?: never;
+            header?: {
+                /** @description The organisation to act for: one of the identifiers GET /api/v1/customer/contexts lists. Omit it, or send it empty, to act for your own account; there is no mode in which it becomes mandatory. A value you hold no active membership of, or one that is not an organisation identifier, is refused with 403 naming nothing, and never quietly treated as your own account. */
+                "X-Broker-Acting-For"?: components["parameters"]["ActingFor"];
+            };
+            path: {
+                id: string;
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description OK */
+            200: {
+                headers: {
+                    /** @description The party this request actually acted for. Present, carrying the organisation identifier, when it acted for an organisation; absent when it acted for your own account. It mirrors the request header, so it can be sent back unchanged. Compare it with what you meant to send: it is the only way to see that a request you meant for an organisation was made personally. */
+                    "X-Broker-Acting-For"?: string;
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["CustomerRepinnedSubmissionResponse"];
+                };
+            };
+            /** @description Not Found */
+            404: {
+                headers: {
+                    /** @description The party this request actually acted for. Present, carrying the organisation identifier, when it acted for an organisation; absent when it acted for your own account. It mirrors the request header, so it can be sent back unchanged. Compare it with what you meant to send: it is the only way to see that a request you meant for an organisation was made personally. */
+                    "X-Broker-Acting-For"?: string;
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+            /** @description Conflict. A type of urn:brokerplatform:problem:concurrency-conflict means someone else changed the record first and nothing was written: read it again and decide again. Any other type is a conflict this operation decided itself, and retrying it unchanged will not help. */
+            409: {
+                headers: {
+                    /** @description The party this request actually acted for. Present, carrying the organisation identifier, when it acted for an organisation; absent when it acted for your own account. It mirrors the request header, so it can be sent back unchanged. Compare it with what you meant to send: it is the only way to see that a request you meant for an organisation was made personally. */
+                    "X-Broker-Acting-For"?: string;
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/problem+json": components["schemas"]["ConcurrencyConflictProblem"] | components["schemas"]["ProblemDetails"];
+                };
+            };
+        };
+    };
     UploadSubmissionAttachment: {
         parameters: {
             query?: never;
@@ -21172,6 +21287,57 @@ export interface operations {
             };
         };
     };
+    RecordRenewalBrokerRecordedInformation: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                id: string;
+            };
+            cookie?: never;
+        };
+        requestBody: {
+            content: {
+                "application/json": components["schemas"]["RecordBrokerRecordedInformationRequest"];
+            };
+        };
+        responses: {
+            /** @description OK */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["RenewalBrokerRecordedInformationResponse"];
+                };
+            };
+            /** @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. A type of urn:brokerplatform:problem:concurrency-conflict means someone else changed the record first and nothing was written: read it again and decide again. Any other type is a conflict this operation decided itself, and retrying it unchanged will not help. */
+            409: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/problem+json": components["schemas"]["ConcurrencyConflictProblem"] | components["schemas"]["ProblemDetails"];
+                };
+            };
+        };
+    };
     RecordRenewalQuoteRequest: {
         parameters: {
             query?: never;

package/package.json

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