@insurance-broker/api-client 4.15.0 → 4.17.0

package/dist/schema.d.ts

@@ -1207,6 +1207,30 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
+    "/api/v1/form-submissions/for-customer": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        /**
+         * Starts answering a form for a named customer, pinning the version that is live now.
+         * @description Starts a submission of the named form that belongs to the named customer — the broker taking a quotation by telephone. Answer and submit it through the ordinary staff routes. It is marked `enteredBy: Staff`, the customer sees it in their own list, and a quote request may be raised against it once it is submitted. It reconfirms a renewal only if the customer enters every answer and submits it themselves (REN-003).
+         *
+         *     **A `400` on `customerId` is one answer** for a customer this broker does not have, whether the identifier belongs to another broker or to nobody.
+         *
+         *     **A `409` here is a settled fact, and `type` says which.** `urn:brokerplatform:problem:draft-already-open` means this customer already has a draft of this form open, named in `submissionId`; continue that one. `urn:brokerplatform:problem:product-not-open-to-new-business` means the product is not open to new business, or no longer exists. `urn:brokerplatform:problem:form-has-no-live-version` means no version of this form is published.
+         */
+        post: operations["StartFormSubmissionForCustomer"];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     "/api/v1/form-submissions/{id}": {
         parameters: {
             query?: never;
@@ -6488,6 +6512,7 @@ export interface components {
             answers: components["schemas"]["CustomerSubmittedAnswerResponse"][];
             evidence: components["schemas"]["SubmittedEvidenceResponse"][];
             isSatisfied: boolean;
+            enteredBy: string;
         };
         CustomerInsurerOutcomeResponse: {
             /** Format: uuid */
@@ -7022,6 +7047,163 @@ export interface components {
             producedAtUtc: string;
             producedBySubjectId: string;
         };
+        /** @description A published form version's body, in body language version 1 (ADR-0026 section 4). Only a Published or Retired version's body is promised to match; a draft's body is any JSON object. Referenced by no operation: opt into it after reading the version's status. */
+        FormBodyV1: {
+            /** @description The questions, in the order they are asked. May be empty only when the body asks for at least one document. */
+            questions: components["schemas"]["FormBodyV1Question"][];
+            /** @description The documents the form asks for, in order. Omitted when there are none. */
+            evidence?: components["schemas"]["FormBodyV1Evidence"][];
+        };
+        /** @description A predicate tree: exactly one of all, any, not, or a leaf. Nests at most 10 levels and holds at most 200 nodes. */
+        FormBodyV1Condition: {
+            all: components["schemas"]["FormBodyV1Condition"][];
+        } | {
+            any: components["schemas"]["FormBodyV1Condition"][];
+        } | {
+            not: components["schemas"]["FormBodyV1Condition"];
+        } | components["schemas"]["FormBodyV1ConditionLeaf"];
+        /** @description Compares one question's answer with a literal, or asks whether it has one. The question is a key declared in the same body; nothing else can be named. */
+        FormBodyV1ConditionLeaf: {
+            /** @description The question whose answer is compared. */
+            question: string;
+            /** @enum {string} */
+            op: "isAnswered" | "isBlank";
+        } | {
+            /** @description The question whose answer is compared. */
+            question: string;
+            /** @enum {string} */
+            op: "eq" | "ne" | "gt" | "gte" | "lt" | "lte";
+            value: components["schemas"]["FormBodyV1Literal"];
+        } | {
+            /** @description The question whose answer is compared. */
+            question: string;
+            /** @enum {string} */
+            op: "in" | "notIn";
+            /** @description The literals, all of one kind. */
+            value: components["schemas"]["FormBodyV1Literal"][];
+        };
+        /**
+         * @description A condition leaf's comparison: the closed operator set of ADR-0026 section 4.
+         * @enum {string}
+         */
+        FormBodyV1ConditionOperator: "eq" | "ne" | "in" | "notIn" | "gt" | "gte" | "lt" | "lte" | "isAnswered" | "isBlank";
+        /** @description One document the form asks for. */
+        FormBodyV1Evidence: {
+            /** @description The document's key. Unique in the body, across questions and documents. */
+            key: string;
+            /** @description What the customer is asked for. */
+            label: string;
+            /** @description Guidance shown with the request. */
+            help?: string;
+            /** @description When the document is required. Absent means always; a condition that cannot be decided requires it. */
+            requiredWhen?: components["schemas"]["FormBodyV1Condition"];
+        };
+        /** @description Text, a number, or true or false, of the kind the question it is compared with holds. A date is text written yyyy-MM-dd; a choice is an option value. */
+        FormBodyV1Literal: boolean | number | string;
+        /** @description One permitted answer of a choice question. */
+        FormBodyV1Option: {
+            /** @description What is stored when this option is chosen. */
+            value: string;
+            /** @description What the customer sees. */
+            label: string;
+        };
+        /** @description One question. options is present exactly when the type is singleChoice or multiChoice. */
+        FormBodyV1Question: {
+            /** @description The property the answer is stored under. Unique in the body, across questions and documents. */
+            key: string;
+            type: components["schemas"]["FormBodyV1QuestionType"];
+            /** @description What the customer is asked. */
+            label: string;
+            /** @description Guidance shown with the question. */
+            help?: string;
+            /** @description The display grouping. A heading only: it carries no visibility of its own. */
+            section?: string;
+            /** @description The permitted answers of a choice question, in display order. Values are unique. */
+            options?: components["schemas"]["FormBodyV1Option"][];
+            /** @description When the question is shown. Absent means always. */
+            visibleWhen?: components["schemas"]["FormBodyV1Condition"];
+            /** @description The rules an answer must satisfy. Each rule at most once. */
+            validators?: components["schemas"]["FormBodyV1Validator"][];
+        };
+        /**
+         * @description What a question asks for: the closed set of ADR-0026 section 4. text takes validators required, minLength, maxLength, pattern, oneOf and is compared with eq, ne, in, notIn, isAnswered, isBlank. longText takes validators required, minLength, maxLength, pattern, oneOf and is compared with eq, ne, in, notIn, isAnswered, isBlank. number takes validators required, min, max, oneOf, decimalPlaces and is compared with eq, ne, in, notIn, gt, gte, lt, lte, isAnswered, isBlank. yesNo takes validators required and is compared with eq, ne, isAnswered, isBlank. date takes validators required, minDate, maxDate, minAge, maxAge, minDaysAhead, maxDaysAhead and is compared with eq, ne, in, notIn, gt, gte, lt, lte, isAnswered, isBlank. singleChoice takes validators required and is compared with eq, ne, in, notIn, isAnswered, isBlank. multiChoice takes validators required and is compared with in, notIn, isAnswered, isBlank.
+         * @enum {string}
+         */
+        FormBodyV1QuestionType: "text" | "longText" | "number" | "yesNo" | "date" | "singleChoice" | "multiChoice";
+        /**
+         * @description A validator's rule: the closed catalogue of ADR-0026 section 4.
+         * @enum {string}
+         */
+        FormBodyV1ValidationRule: "required" | "minLength" | "maxLength" | "pattern" | "min" | "max" | "minDate" | "maxDate" | "minAge" | "maxAge" | "oneOf" | "decimalPlaces" | "minDaysAhead" | "maxDaysAhead";
+        /** @description One rule on a question: one variant per rule, each with the parameter it takes. */
+        FormBodyV1Validator: {
+            /** @constant */
+            rule: "required";
+        } | {
+            /** @constant */
+            rule: "minLength";
+            value: number;
+        } | {
+            /** @constant */
+            rule: "maxLength";
+            value: number;
+        } | {
+            /** @constant */
+            rule: "pattern";
+            /** @description A regular expression, matched non-backtracking with a timeout. */
+            value: string;
+        } | {
+            /** @constant */
+            rule: "min";
+            value: number;
+        } | {
+            /** @constant */
+            rule: "max";
+            value: number;
+        } | {
+            /** @constant */
+            rule: "minDate";
+            /**
+             * Format: date
+             * @description A calendar date written yyyy-MM-dd.
+             */
+            value: string;
+        } | {
+            /** @constant */
+            rule: "maxDate";
+            /**
+             * Format: date
+             * @description A calendar date written yyyy-MM-dd.
+             */
+            value: string;
+        } | {
+            /** @constant */
+            rule: "minAge";
+            value: number;
+        } | {
+            /** @constant */
+            rule: "maxAge";
+            value: number;
+        } | {
+            /** @constant */
+            rule: "oneOf";
+            /** @description The permitted answers, all of the question's own kind. */
+            value: components["schemas"]["FormBodyV1Literal"][];
+        } | {
+            /** @constant */
+            rule: "decimalPlaces";
+            value: number;
+        } | {
+            /** @constant */
+            rule: "minDaysAhead";
+            /** @description Whole days ahead of the date the submission is assessed on; negative for behind it. */
+            value: number;
+        } | {
+            /** @constant */
+            rule: "maxDaysAhead";
+            /** @description Whole days ahead of the date the submission is assessed on; negative for behind it. */
+            value: number;
+        };
         FormBodyViolationResponse: {
             path: string;
             /** @description Which refusal this is, as a stable name from a closed set. Key grouping, counting and translation on this, never on message. A new code is additive; renaming one is a break. */
@@ -7036,7 +7218,7 @@ export interface components {
             productId: string;
             productKey: string;
             productName: string;
-            kind: string;
+            kind: components["schemas"]["FormKind"];
             key: string;
             name: string;
             /** Format: date-time */
@@ -7048,6 +7230,8 @@ export interface components {
             /** Format: int32 */
             versionCount: number | string;
         };
+        /** @enum {string} */
+        FormKind: "Quote" | "Claim";
         FormQuestionOptionResponse: {
             value: string;
             label: string;
@@ -7085,6 +7269,9 @@ export interface components {
             answers: components["schemas"]["SubmittedAnswerResponse"][];
             evidence: components["schemas"]["SubmittedEvidenceResponse"][];
             isSatisfied: boolean;
+            /** Format: uuid */
+            customerId: null | string;
+            enteredBy: string;
         };
         FormTeamRequest: {
             code: string;
@@ -7101,7 +7288,7 @@ export interface components {
             id: string;
             /** Format: int32 */
             versionNumber: number | string;
-            status: string;
+            status: components["schemas"]["FormVersionStatus"];
             /** Format: int32 */
             bodySchemaVersion: number | string;
             contentHash: null | string;
@@ -7115,6 +7302,8 @@ export interface components {
             retiredAtUtc: null | string;
             retiredBySubjectId: null | string;
         };
+        /** @enum {string} */
+        FormVersionStatus: "Draft" | "Published" | "Retired";
         GenerateDocumentRequest: {
             format: null | string;
         };
@@ -7569,7 +7758,7 @@ export interface components {
             id: string;
             key: string;
             name: string;
-            kind: string;
+            kind: components["schemas"]["FormKind"];
             /** Format: int32 */
             publishedVersionNumber: number | string;
         };
@@ -8733,6 +8922,12 @@ export interface components {
             /** Format: uuid */
             copyFromVersionId: null | string;
         };
+        StartFormSubmissionForCustomerRequest: {
+            /** Format: uuid */
+            formDefinitionId: null | string;
+            /** Format: uuid */
+            customerId: null | string;
+        };
         StartFormSubmissionRequest: {
             /** Format: uuid */
             formDefinitionId: null | string;
@@ -11931,6 +12126,48 @@ export interface operations {
             };
         };
     };
+    StartFormSubmissionForCustomer: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody: {
+            content: {
+                "application/json": components["schemas"]["StartFormSubmissionForCustomerRequest"];
+            };
+        };
+        responses: {
+            /** @description Created */
+            201: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["FormSubmissionResponse"];
+                };
+            };
+            /** @description Bad Request */
+            400: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/problem+json": components["schemas"]["HttpValidationProblemDetails"];
+                };
+            };
+            /** @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"];
+                };
+            };
+        };
+    };
     GetFormSubmission: {
         parameters: {
             query?: never;

package/package.json

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