@insurance-broker/api-client 4.12.0 → 4.14.0

package/dist/schema.d.ts

@@ -5436,6 +5436,34 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
+    "/api/v1/quote-request-reference-format": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * The format this broker's quote request references are issued in
+         * @description The format the next quote request is numbered in, whether it is the platform default, the default itself, and a preview of the next reference. References already issued keep theirs: a reference is stored when its quote request is first saved and is never re-rendered, and numbering carries on from where it is rather than restarting. {year} is the UTC year a request is raised in, not the year in the broker's time zone. Numbering never restarts each year.
+         */
+        get: operations["ReadQuoteRequestReferenceFormat"];
+        /**
+         * Set the format this broker's quote request references are issued in
+         * @description Literal text, {year}, and exactly one {number} or {number:000000}, at most 32 characters; literal text is letters, digits, spaces and . _ / - and does not begin or end with a space. Applies to quote requests raised from now on. References already issued keep theirs: a reference is stored when its quote request is first saved and is never re-rendered, and numbering carries on from where it is rather than restarting. {year} is the UTC year a request is raised in, not the year in the broker's time zone. Numbering never restarts each year. A format that would issue a reference this broker already holds is refused with 409.
+         */
+        put: operations["SetQuoteRequestReferenceFormat"];
+        post?: never;
+        /**
+         * Issue quote request references in the platform default format again
+         * @description Removes this broker's own format, so quote requests raised from now on are numbered in the platform default. References already issued keep theirs: a reference is stored when its quote request is first saved and is never re-rendered, and numbering carries on from where it is rather than restarting. {year} is the UTC year a request is raised in, not the year in the broker's time zone. Numbering never restarts each year. Answers 404 when this broker is already on the default, and 409 when the default would issue a reference this broker already holds.
+         */
+        delete: operations["ClearQuoteRequestReferenceFormat"];
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     "/api/v1/retention/schedule": {
         parameters: {
             query?: never;
@@ -6235,6 +6263,13 @@ export interface components {
             state: string;
             value: null | string;
         };
+        ComparisonBodyViolationResponse: {
+            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. */
+            code: string;
+            /** @description Why, in a sentence a person can act on. Prose: it will be reworded, so never parse it or key on it. */
+            message: string;
+        };
         ComparisonDisclosureResponse: {
             optionsAreMarked: boolean;
             method: null | string;
@@ -6979,6 +7014,13 @@ export interface components {
             producedAtUtc: string;
             producedBySubjectId: string;
         };
+        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. */
+            code: string;
+            /** @description Why, in a sentence a person can act on. Prose: it will be reworded, so never parse it or key on it. */
+            message: string;
+        };
         FormDefinitionResponse: {
             /** Format: uuid */
             id: string;
@@ -7415,6 +7457,13 @@ export interface components {
             /** Format: date-time */
             publishedAtUtc: string;
         };
+        MissingTemplateValueResponse: {
+            key: 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. */
+            code: string;
+            /** @description Why, in a sentence a person can act on. Prose: it will be reworded, so never parse it or key on it. */
+            message: string;
+        };
         NativeApplicationResponse: {
             /** Format: uuid */
             id: string;
@@ -7688,6 +7737,13 @@ export interface components {
         PaymentEvidenceUpload: {
             file: components["schemas"]["IFormFile"];
         };
+        PaymentEvidenceViolationResponse: {
+            field: 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. */
+            code: string;
+            /** @description Why, in a sentence a person can act on. Prose: it will be reworded, so never parse it or key on it. */
+            message: string;
+        };
         PaymentGateResponse: {
             /** Format: uuid */
             id: string;
@@ -7921,6 +7977,13 @@ export interface components {
             /** Format: uuid */
             paymentEvidenceReference: null | string;
         };
+        PolicyViolationResponse: {
+            field: 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. */
+            code: string;
+            /** @description Why, in a sentence a person can act on. Prose: it will be reworded, so never parse it or key on it. */
+            message: string;
+        };
         PresentationBodyResponse: {
             version: components["schemas"]["PresentationVersionResponse"];
             body: string;
@@ -8163,6 +8226,19 @@ export interface components {
             expiryAsOf: string;
             expired: boolean;
         };
+        QuoteOptionViolationResponse: {
+            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. */
+            code: string;
+            /** @description Why, in a sentence a person can act on. Prose: it will be reworded, so never parse it or key on it. */
+            message: string;
+        };
+        QuoteRequestReferenceFormatResponse: {
+            format: string;
+            isPlatformDefault: boolean;
+            platformDefaultFormat: string;
+            nextReference: string;
+        };
         QuoteRequestResponse: {
             /** Format: uuid */
             id: string;
@@ -8187,6 +8263,14 @@ export interface components {
             /** Format: date-time */
             declinedAtUtc: null | string;
         };
+        QuoteRequestViolationResponse: {
+            /** @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. */
+            code: string;
+            /** Format: uuid */
+            formSubmissionId: string;
+            /** @description Why, in a sentence a person can act on. Prose: it will be reworded, so never parse it or key on it. */
+            message: string;
+        };
         RaiseClaimOutstandingItemRequest: {
             awaitedFrom: string;
             description: string;
@@ -8378,6 +8462,13 @@ export interface components {
             /** Format: date-time */
             satisfiedAtUtc: null | string;
         };
+        RenewalClockViolationResponse: {
+            milestone: 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. */
+            code: string;
+            /** @description Why, in a sentence a person can act on. Prose: it will be reworded, so never parse it or key on it. */
+            message: string;
+        };
         RenewalCompletionResponse: {
             /** Format: uuid */
             renewalCaseId: string;
@@ -8393,6 +8484,12 @@ export interface components {
             /** Format: date-time */
             previousPolicyRenewedAtUtc: null | string;
         };
+        RenewalConfirmationViolationResponse: {
+            /** @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. */
+            code: string;
+            /** @description Why, in a sentence a person can act on. Prose: it will be reworded, so never parse it or key on it. */
+            message: string;
+        };
         RenewalCustomerInformationResponse: {
             /** Format: uuid */
             renewalCaseId: string;
@@ -8447,6 +8544,12 @@ export interface components {
             /** Format: date-time */
             customerAcceptanceSatisfiedAtUtc: null | string;
         };
+        RenewalTermsViolationResponse: {
+            /** @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. */
+            code: string;
+            /** @description Why, in a sentence a person can act on. Prose: it will be reworded, so never parse it or key on it. */
+            message: string;
+        };
         RepinnedSubmissionResponse: {
             submission: components["schemas"]["FormSubmissionResponse"];
             carriedAnswerKeys: string[];
@@ -8600,6 +8703,9 @@ export interface components {
             email: null | boolean;
             push: null | boolean;
         };
+        SetQuoteRequestReferenceFormatRequest: {
+            format: null | string;
+        };
         SetRenewalLeadTimeRequest: {
             /** Format: int32 */
             leadDays: null | number | string;
@@ -8773,6 +8879,13 @@ export interface components {
             /** Format: date-time */
             updatedAtUtc: string;
         };
+        TemplateBodyViolationResponse: {
+            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. */
+            code: string;
+            /** @description Why, in a sentence a person can act on. Prose: it will be reworded, so never parse it or key on it. */
+            message: string;
+        };
         TenantAdministratorResponse: {
             /** Format: uuid */
             membershipId: string;
@@ -8846,6 +8959,258 @@ export interface components {
             primaryDomain: null | string;
             plan: null | components["schemas"]["PlanResponse"];
         };
+        /** @description RFC 9457 problem answered when quote options cannot be captured, imported, compared or presented against the product's published comparison schema (ADR-0028). The title says which act was refused; the move is to change the answers or publish a comparison schema that declares them. */
+        UncapturableQuoteOptionProblem: {
+            /**
+             * @description Identifies the problem kind, and is what a client branches on. A stable URN; it is not promised to resolve.
+             * @constant
+             */
+            type: "urn:brokerplatform:problem:uncapturable-quote-option";
+            /** @description Says what was refused, for a person. Human-readable and not fixed. */
+            title: string;
+            /**
+             * Format: int32
+             * @enum {integer}
+             */
+            status: 422;
+            /** @description How many things are wrong and where to look, for a person. Not fixed. */
+            detail: string;
+            /** @description RFC 9457's instance. Not sent by these problems today; never rely on it. */
+            instance?: null | string;
+            /** @description Every reason, never only the first. Each path is an RFC 6901 JSON pointer: into the answers on a capture, into the request on an import (/rows/3/premiumAmount), or /quote-options/{id} naming the offending option on a comparison or a presentation. The empty string means the reason is about the comparison schema rather than any answer. */
+            violations: components["schemas"]["QuoteOptionViolationResponse"][];
+        };
+        /** @description RFC 9457 problem answered when a lead-time change would produce a renewal clock that cannot be stored (ADR-0040). The number is legal on its own; the schedule it produces is not. */
+        UnconfigurableRenewalClockProblem: {
+            /**
+             * @description Identifies the problem kind, and is what a client branches on. A stable URN; it is not promised to resolve.
+             * @constant
+             */
+            type: "urn:brokerplatform:problem:unconfigurable-renewal-clock";
+            /** @description Says what was refused, for a person. Human-readable and not fixed. */
+            title: string;
+            /**
+             * Format: int32
+             * @enum {integer}
+             */
+            status: 422;
+            /** @description How many things are wrong and where to look, for a person. Not fixed. */
+            detail: string;
+            /** @description RFC 9457's instance. Not sent by these problems today; never rely on it. */
+            instance?: null | string;
+            /** @description Every breach, never only the first. Each names the milestone it is about. */
+            violations: components["schemas"]["RenewalClockViolationResponse"][];
+        };
+        /** @description RFC 9457 problem answered when the submission named cannot be this renewal's reconfirmation (REN-003, ADR-0028). The move is back to the customer's forms. */
+        UnconfirmedRenewalProblem: {
+            /**
+             * @description Identifies the problem kind, and is what a client branches on. A stable URN; it is not promised to resolve.
+             * @constant
+             */
+            type: "urn:brokerplatform:problem:unconfirmed-renewal";
+            /** @description Says what was refused, for a person. Human-readable and not fixed. */
+            title: string;
+            /**
+             * Format: int32
+             * @enum {integer}
+             */
+            status: 422;
+            /** @description How many things are wrong and where to look, for a person. Not fixed. */
+            detail: string;
+            /** @description RFC 9457's instance. Not sent by these problems today; never rely on it. */
+            instance?: null | string;
+            /** @description The reason. One, because the caller named one submission; still an array. */
+            violations: components["schemas"]["RenewalConfirmationViolationResponse"][];
+        };
+        /** @description RFC 9457 problem answered when a policy cannot be opened because the quote request it names has no acceptance behind it (ADR-0028). Go back to the quote; nothing about this request will help. */
+        UnplaceableQuoteProblem: {
+            /**
+             * @description Identifies the problem kind, and is what a client branches on. A stable URN; it is not promised to resolve.
+             * @constant
+             */
+            type: "urn:brokerplatform:problem:unplaceable-quote";
+            /** @description Says what was refused, for a person. Human-readable and not fixed. */
+            title: string;
+            /**
+             * Format: int32
+             * @enum {integer}
+             */
+            status: 422;
+            /** @description How many things are wrong and where to look, for a person. Not fixed. */
+            detail: string;
+            /** @description RFC 9457's instance. Not sent by these problems today; never rely on it. */
+            instance?: null | string;
+            /** @description Every reason. field names the request member it concerns, spelled QuoteRequestId. */
+            violations: components["schemas"]["PolicyViolationResponse"][];
+        };
+        /** @description RFC 9457 problem answered when the quote named cannot be this renewal's terms (REN-004, ADR-0028). The move is the quote: go to market, chase the presentation, or wait for the customer to accept. */
+        UnplacedRenewalTermsProblem: {
+            /**
+             * @description Identifies the problem kind, and is what a client branches on. A stable URN; it is not promised to resolve.
+             * @constant
+             */
+            type: "urn:brokerplatform:problem:unplaced-renewal-terms";
+            /** @description Says what was refused, for a person. Human-readable and not fixed. */
+            title: string;
+            /**
+             * Format: int32
+             * @enum {integer}
+             */
+            status: 422;
+            /** @description How many things are wrong and where to look, for a person. Not fixed. */
+            detail: string;
+            /** @description RFC 9457's instance. Not sent by these problems today; never rely on it. */
+            instance?: null | string;
+            /** @description The reason. One, because the caller named one quote request; still an array. */
+            violations: components["schemas"]["RenewalTermsViolationResponse"][];
+        };
+        /** @description RFC 9457 problem answered when a comparison schema draft cannot be published because the body language refuses its attribute set (ADR-0028). Nothing about this request is wrong; fix the body and publish again. */
+        UnpublishableComparisonBodyProblem: {
+            /**
+             * @description Identifies the problem kind, and is what a client branches on. A stable URN; it is not promised to resolve.
+             * @constant
+             */
+            type: "urn:brokerplatform:problem:unpublishable-body";
+            /** @description Says what was refused, for a person. Human-readable and not fixed. */
+            title: string;
+            /**
+             * Format: int32
+             * @enum {integer}
+             */
+            status: 422;
+            /** @description How many things are wrong and where to look, for a person. Not fixed. */
+            detail: string;
+            /** @description RFC 9457's instance. Not sent by these problems today; never rely on it. */
+            instance?: null | string;
+            /** @description Every reason, never only the first. Each path is an RFC 6901 JSON pointer into the comparison schema body, or the empty string for the body as a whole. */
+            violations: components["schemas"]["ComparisonBodyViolationResponse"][];
+        };
+        /** @description RFC 9457 problem answered when a form definition draft cannot be published because the body language refuses its body (ADR-0028). Nothing about this request is wrong; fix the body and publish again. */
+        UnpublishableFormBodyProblem: {
+            /**
+             * @description Identifies the problem kind, and is what a client branches on. A stable URN; it is not promised to resolve.
+             * @constant
+             */
+            type: "urn:brokerplatform:problem:unpublishable-body";
+            /** @description Says what was refused, for a person. Human-readable and not fixed. */
+            title: string;
+            /**
+             * Format: int32
+             * @enum {integer}
+             */
+            status: 422;
+            /** @description How many things are wrong and where to look, for a person. Not fixed. */
+            detail: string;
+            /** @description RFC 9457's instance. Not sent by these problems today; never rely on it. */
+            instance?: null | string;
+            /** @description Every reason, never only the first. Each path is an RFC 6901 JSON pointer into the definition body, such as /questions/3/validators/1/value, or the empty string for the body as a whole. */
+            violations: components["schemas"]["FormBodyViolationResponse"][];
+        };
+        /** @description RFC 9457 problem answered when a document template body cannot be used: a draft the body language refuses to publish, or a published version written for a later engine than this deployment runs (ADR-0028, ADR-0036). The move is the template body, not this request. */
+        UnpublishableTemplateBodyProblem: {
+            /**
+             * @description Identifies the problem kind, and is what a client branches on. A stable URN; it is not promised to resolve.
+             * @constant
+             */
+            type: "urn:brokerplatform:problem:unpublishable-template-body";
+            /** @description Says what was refused, for a person. Human-readable and not fixed. */
+            title: string;
+            /**
+             * Format: int32
+             * @enum {integer}
+             */
+            status: 422;
+            /** @description How many things are wrong and where to look, for a person. Not fixed. */
+            detail: string;
+            /** @description RFC 9457's instance. Not sent by these problems today; never rely on it. */
+            instance?: null | string;
+            /** @description Every reason, never only the first. Each path is an RFC 6901 JSON pointer into the template body, or the empty string for the body as a whole. */
+            violations: components["schemas"]["TemplateBodyViolationResponse"][];
+        };
+        /** @description RFC 9457 problem answered when the form submission named cannot be quoted (ADR-0028). Go back to the submission: submit it, or attach it to a customer. */
+        UnquotableSubmissionProblem: {
+            /**
+             * @description Identifies the problem kind, and is what a client branches on. A stable URN; it is not promised to resolve.
+             * @constant
+             */
+            type: "urn:brokerplatform:problem:unquotable-submission";
+            /** @description Says what was refused, for a person. Human-readable and not fixed. */
+            title: string;
+            /**
+             * Format: int32
+             * @enum {integer}
+             */
+            status: 422;
+            /** @description How many things are wrong and where to look, for a person. Not fixed. */
+            detail: string;
+            /** @description RFC 9457's instance. Not sent by these problems today; never rely on it. */
+            instance?: null | string;
+            /** @description Every reason. Each names the submission it is about in formSubmissionId. */
+            violations: components["schemas"]["QuoteRequestViolationResponse"][];
+        };
+        /** @description RFC 9457 problem answered when a template asks for values this policy does not have (ADR-0036). A missing value is a refusal rather than a blank, and nothing was stored. */
+        UnrenderableTemplateProblem: {
+            /**
+             * @description Identifies the problem kind, and is what a client branches on. A stable URN; it is not promised to resolve.
+             * @constant
+             */
+            type: "urn:brokerplatform:problem:unrenderable-template";
+            /** @description Says what was refused, for a person. Human-readable and not fixed. */
+            title: string;
+            /**
+             * Format: int32
+             * @enum {integer}
+             */
+            status: 422;
+            /** @description How many things are wrong and where to look, for a person. Not fixed. */
+            detail: string;
+            /** @description RFC 9457's instance. Not sent by these problems today; never rely on it. */
+            instance?: null | string;
+            /** @description Every missing value, each once, in the order the template first uses it. Each key is the placeholder key exactly as the template declares it. */
+            violations: components["schemas"]["MissingTemplateValueResponse"][];
+        };
+        /** @description RFC 9457 problem answered when a form submission cannot be submitted because its answers do not satisfy the published version it is pinned to (ADR-0028). Fix the answers and submit again. */
+        UnsatisfiedAnswersProblem: {
+            /**
+             * @description Identifies the problem kind, and is what a client branches on. A stable URN; it is not promised to resolve.
+             * @constant
+             */
+            type: "urn:brokerplatform:problem:unsatisfied-answers";
+            /** @description Says what was refused, for a person. Human-readable and not fixed. */
+            title: string;
+            /**
+             * Format: int32
+             * @enum {integer}
+             */
+            status: 422;
+            /** @description How many things are wrong and where to look, for a person. Not fixed. */
+            detail: string;
+            /** @description RFC 9457's instance. Not sent by these problems today; never rely on it. */
+            instance?: null | string;
+            /** @description Every reason, never only the first. Each path is the key of the question the answer concerns, not a JSON pointer. */
+            violations: components["schemas"]["FormBodyViolationResponse"][];
+        };
+        /** @description RFC 9457 problem answered when the payment named cannot release this policy's cover (ADR-0042). The move is the payment: find the right one, have it approved, or record the money again. */
+        UnusablePaymentEvidenceProblem: {
+            /**
+             * @description Identifies the problem kind, and is what a client branches on. A stable URN; it is not promised to resolve.
+             * @constant
+             */
+            type: "urn:brokerplatform:problem:unusable-payment-evidence";
+            /** @description Says what was refused, for a person. Human-readable and not fixed. */
+            title: string;
+            /**
+             * Format: int32
+             * @enum {integer}
+             */
+            status: 422;
+            /** @description How many things are wrong and where to look, for a person. Not fixed. */
+            detail: string;
+            /** @description RFC 9457's instance. Not sent by these problems today; never rely on it. */
+            instance?: null | string;
+            /** @description The reason. One, because the caller named one payment; field is always PaymentId. */
+            violations: components["schemas"]["PaymentEvidenceViolationResponse"][];
+        };
         UpdateInsurerRequest: {
             name: null | string;
             legalName: null | string;
@@ -11433,13 +11798,13 @@ export interface operations {
                     "application/problem+json": components["schemas"]["ConcurrencyConflictProblem"] | components["schemas"]["ProblemDetails"];
                 };
             };
-            /** @description Unprocessable Entity */
+            /** @description Unprocessable Content (ADR-0028). The request is well-formed and permitted, and what it points at cannot be processed. Branch on type. Every reason is listed under violations, each with a stable code to key on and a message in prose. */
             422: {
                 headers: {
                     [name: string]: unknown;
                 };
                 content: {
-                    "application/problem+json": components["schemas"]["ProblemDetails"];
+                    "application/problem+json": components["schemas"]["UnpublishableFormBodyProblem"];
                 };
             };
         };
@@ -11678,13 +12043,13 @@ export interface operations {
                     "application/problem+json": components["schemas"]["ConcurrencyConflictProblem"] | components["schemas"]["ProblemDetails"];
                 };
             };
-            /** @description Unprocessable Entity */
+            /** @description Unprocessable Content (ADR-0028). The request is well-formed and permitted, and what it points at cannot be processed. Branch on type. Every reason is listed under violations, each with a stable code to key on and a message in prose. */
             422: {
                 headers: {
                     [name: string]: unknown;
                 };
                 content: {
-                    "application/problem+json": components["schemas"]["ProblemDetails"];
+                    "application/problem+json": components["schemas"]["UnsatisfiedAnswersProblem"];
                 };
             };
         };
@@ -11952,7 +12317,7 @@ export interface operations {
                     "application/problem+json": components["schemas"]["ConcurrencyConflictProblem"] | components["schemas"]["ProblemDetails"];
                 };
             };
-            /** @description Unprocessable Entity */
+            /** @description Unprocessable Content (ADR-0028). The request is well-formed and permitted, and what it points at cannot be processed. Branch on type. Every reason is listed under violations, each with a stable code to key on and a message in prose. */
             422: {
                 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. */
@@ -11960,7 +12325,7 @@ export interface operations {
                     [name: string]: unknown;
                 };
                 content: {
-                    "application/problem+json": components["schemas"]["ProblemDetails"];
+                    "application/problem+json": components["schemas"]["UnsatisfiedAnswersProblem"];
                 };
             };
         };
@@ -18151,13 +18516,13 @@ export interface operations {
                     "application/problem+json": components["schemas"]["ConcurrencyConflictProblem"] | components["schemas"]["ProblemDetails"];
                 };
             };
-            /** @description Unprocessable Entity */
+            /** @description Unprocessable Content (ADR-0028). The request is well-formed and permitted, and what it points at cannot be processed. Branch on type. Every reason is listed under violations, each with a stable code to key on and a message in prose. */
             422: {
                 headers: {
                     [name: string]: unknown;
                 };
                 content: {
-                    "application/problem+json": components["schemas"]["ProblemDetails"];
+                    "application/problem+json": components["schemas"]["UnplaceableQuoteProblem"];
                 };
             };
         };
@@ -18348,13 +18713,13 @@ export interface operations {
                     "application/problem+json": components["schemas"]["ConcurrencyConflictProblem"] | components["schemas"]["ProblemDetails"];
                 };
             };
-            /** @description Unprocessable Entity */
+            /** @description Unprocessable Content (ADR-0028). The request is well-formed and permitted, and what it points at cannot be processed. Branch on type. Every reason is listed under violations, each with a stable code to key on and a message in prose. */
             422: {
                 headers: {
                     [name: string]: unknown;
                 };
                 content: {
-                    "application/problem+json": components["schemas"]["ProblemDetails"];
+                    "application/problem+json": components["schemas"]["UnusablePaymentEvidenceProblem"];
                 };
             };
         };
@@ -18941,13 +19306,13 @@ export interface operations {
                     "application/problem+json": components["schemas"]["ConcurrencyConflictProblem"] | components["schemas"]["ProblemDetails"];
                 };
             };
-            /** @description Unprocessable Entity */
+            /** @description Unprocessable Content (ADR-0028). The request is well-formed and permitted, and what it points at cannot be processed. Branch on type. Every reason is listed under violations, each with a stable code to key on and a message in prose. */
             422: {
                 headers: {
                     [name: string]: unknown;
                 };
                 content: {
-                    "application/problem+json": components["schemas"]["ProblemDetails"];
+                    "application/problem+json": components["schemas"]["UnpublishableTemplateBodyProblem"];
                 };
             };
         };
@@ -19041,13 +19406,13 @@ export interface operations {
                     "application/problem+json": components["schemas"]["ConcurrencyConflictProblem"] | components["schemas"]["ProblemDetails"];
                 };
             };
-            /** @description Unprocessable Entity */
+            /** @description Unprocessable Content (ADR-0028). The request is well-formed and permitted, and what it points at cannot be processed. Branch on type. Every reason is listed under violations, each with a stable code to key on and a message in prose. */
             422: {
                 headers: {
                     [name: string]: unknown;
                 };
                 content: {
-                    "application/problem+json": components["schemas"]["ProblemDetails"];
+                    "application/problem+json": components["schemas"]["UnrenderableTemplateProblem"] | components["schemas"]["UnpublishableTemplateBodyProblem"];
                 };
             };
         };
@@ -19125,13 +19490,13 @@ export interface operations {
                     "application/problem+json": components["schemas"]["ConcurrencyConflictProblem"] | components["schemas"]["ProblemDetails"];
                 };
             };
-            /** @description Unprocessable Entity */
+            /** @description Unprocessable Content (ADR-0028). The request is well-formed and permitted, and what it points at cannot be processed. Branch on type. Every reason is listed under violations, each with a stable code to key on and a message in prose. */
             422: {
                 headers: {
                     [name: string]: unknown;
                 };
                 content: {
-                    "application/problem+json": components["schemas"]["ProblemDetails"];
+                    "application/problem+json": components["schemas"]["UnconfigurableRenewalClockProblem"];
                 };
             };
         };
@@ -19174,13 +19539,13 @@ export interface operations {
                     "application/problem+json": components["schemas"]["ConcurrencyConflictProblem"] | components["schemas"]["ProblemDetails"];
                 };
             };
-            /** @description Unprocessable Entity */
+            /** @description Unprocessable Content (ADR-0028). The request is well-formed and permitted, and what it points at cannot be processed. Branch on type. Every reason is listed under violations, each with a stable code to key on and a message in prose. */
             422: {
                 headers: {
                     [name: string]: unknown;
                 };
                 content: {
-                    "application/problem+json": components["schemas"]["ProblemDetails"];
+                    "application/problem+json": components["schemas"]["UnconfigurableRenewalClockProblem"];
                 };
             };
         };
@@ -19301,13 +19666,13 @@ export interface operations {
                     "application/problem+json": components["schemas"]["ConcurrencyConflictProblem"] | components["schemas"]["ProblemDetails"];
                 };
             };
-            /** @description Unprocessable Entity */
+            /** @description Unprocessable Content (ADR-0028). The request is well-formed and permitted, and what it points at cannot be processed. Branch on type. Every reason is listed under violations, each with a stable code to key on and a message in prose. */
             422: {
                 headers: {
                     [name: string]: unknown;
                 };
                 content: {
-                    "application/problem+json": components["schemas"]["ProblemDetails"];
+                    "application/problem+json": components["schemas"]["UnconfirmedRenewalProblem"];
                 };
             };
         };
@@ -19361,13 +19726,13 @@ export interface operations {
                     "application/problem+json": components["schemas"]["ConcurrencyConflictProblem"] | components["schemas"]["ProblemDetails"];
                 };
             };
-            /** @description Unprocessable Entity */
+            /** @description Unprocessable Content (ADR-0028). The request is well-formed and permitted, and what it points at cannot be processed. Branch on type. Every reason is listed under violations, each with a stable code to key on and a message in prose. */
             422: {
                 headers: {
                     [name: string]: unknown;
                 };
                 content: {
-                    "application/problem+json": components["schemas"]["ProblemDetails"];
+                    "application/problem+json": components["schemas"]["UnplacedRenewalTermsProblem"];
                 };
             };
         };
@@ -19408,13 +19773,13 @@ export interface operations {
                     "application/problem+json": components["schemas"]["ConcurrencyConflictProblem"] | components["schemas"]["ProblemDetails"];
                 };
             };
-            /** @description Unprocessable Entity */
+            /** @description Unprocessable Content (ADR-0028). The request is well-formed and permitted, and what it points at cannot be processed. Branch on type. Every reason is listed under violations, each with a stable code to key on and a message in prose. */
             422: {
                 headers: {
                     [name: string]: unknown;
                 };
                 content: {
-                    "application/problem+json": components["schemas"]["ProblemDetails"];
+                    "application/problem+json": components["schemas"]["UnplacedRenewalTermsProblem"];
                 };
             };
         };
@@ -19455,13 +19820,13 @@ export interface operations {
                     "application/problem+json": components["schemas"]["ConcurrencyConflictProblem"] | components["schemas"]["ProblemDetails"];
                 };
             };
-            /** @description Unprocessable Entity */
+            /** @description Unprocessable Content (ADR-0028). The request is well-formed and permitted, and what it points at cannot be processed. Branch on type. Every reason is listed under violations, each with a stable code to key on and a message in prose. */
             422: {
                 headers: {
                     [name: string]: unknown;
                 };
                 content: {
-                    "application/problem+json": components["schemas"]["ProblemDetails"];
+                    "application/problem+json": components["schemas"]["UnplacedRenewalTermsProblem"];
                 };
             };
         };
@@ -19979,7 +20344,7 @@ export interface operations {
                     "application/problem+json": components["schemas"]["ConcurrencyConflictProblem"] | components["schemas"]["ProblemDetails"];
                 };
             };
-            /** @description Unprocessable Entity */
+            /** @description Unprocessable Content (ADR-0028). The request is well-formed and permitted, and what it points at cannot be processed. Branch on type. Every reason is listed under violations, each with a stable code to key on and a message in prose. */
             422: {
                 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. */
@@ -19987,7 +20352,7 @@ export interface operations {
                     [name: string]: unknown;
                 };
                 content: {
-                    "application/problem+json": components["schemas"]["ProblemDetails"];
+                    "application/problem+json": components["schemas"]["UnconfirmedRenewalProblem"];
                 };
             };
         };
@@ -20102,13 +20467,13 @@ export interface operations {
                     "application/problem+json": components["schemas"]["ConcurrencyConflictProblem"] | components["schemas"]["ProblemDetails"];
                 };
             };
-            /** @description Unprocessable Entity */
+            /** @description Unprocessable Content (ADR-0028). The request is well-formed and permitted, and what it points at cannot be processed. Branch on type. Every reason is listed under violations, each with a stable code to key on and a message in prose. */
             422: {
                 headers: {
                     [name: string]: unknown;
                 };
                 content: {
-                    "application/problem+json": components["schemas"]["ProblemDetails"];
+                    "application/problem+json": components["schemas"]["UnquotableSubmissionProblem"];
                 };
             };
         };
@@ -20880,13 +21245,13 @@ export interface operations {
                     "application/problem+json": components["schemas"]["ConcurrencyConflictProblem"] | components["schemas"]["ProblemDetails"];
                 };
             };
-            /** @description Unprocessable Entity */
+            /** @description Unprocessable Content (ADR-0028). The request is well-formed and permitted, and what it points at cannot be processed. Branch on type. Every reason is listed under violations, each with a stable code to key on and a message in prose. */
             422: {
                 headers: {
                     [name: string]: unknown;
                 };
                 content: {
-                    "application/problem+json": components["schemas"]["ProblemDetails"];
+                    "application/problem+json": components["schemas"]["UnpublishableComparisonBodyProblem"];
                 };
             };
         };
@@ -21020,13 +21385,13 @@ export interface operations {
                     "application/problem+json": components["schemas"]["ConcurrencyConflictProblem"] | components["schemas"]["ProblemDetails"];
                 };
             };
-            /** @description Unprocessable Entity */
+            /** @description Unprocessable Content (ADR-0028). The request is well-formed and permitted, and what it points at cannot be processed. Branch on type. Every reason is listed under violations, each with a stable code to key on and a message in prose. */
             422: {
                 headers: {
                     [name: string]: unknown;
                 };
                 content: {
-                    "application/problem+json": components["schemas"]["ProblemDetails"];
+                    "application/problem+json": components["schemas"]["UncapturableQuoteOptionProblem"];
                 };
             };
         };
@@ -21080,13 +21445,13 @@ export interface operations {
                     "application/problem+json": components["schemas"]["ConcurrencyConflictProblem"] | components["schemas"]["ProblemDetails"];
                 };
             };
-            /** @description Unprocessable Entity */
+            /** @description Unprocessable Content (ADR-0028). The request is well-formed and permitted, and what it points at cannot be processed. Branch on type. Every reason is listed under violations, each with a stable code to key on and a message in prose. */
             422: {
                 headers: {
                     [name: string]: unknown;
                 };
                 content: {
-                    "application/problem+json": components["schemas"]["ProblemDetails"];
+                    "application/problem+json": components["schemas"]["UncapturableQuoteOptionProblem"];
                 };
             };
         };
@@ -21171,13 +21536,13 @@ export interface operations {
                     "application/problem+json": components["schemas"]["ConcurrencyConflictProblem"] | components["schemas"]["ProblemDetails"];
                 };
             };
-            /** @description Unprocessable Entity */
+            /** @description Unprocessable Content (ADR-0028). The request is well-formed and permitted, and what it points at cannot be processed. Branch on type. Every reason is listed under violations, each with a stable code to key on and a message in prose. */
             422: {
                 headers: {
                     [name: string]: unknown;
                 };
                 content: {
-                    "application/problem+json": components["schemas"]["ProblemDetails"];
+                    "application/problem+json": components["schemas"]["UncapturableQuoteOptionProblem"];
                 };
             };
         };
@@ -21296,13 +21661,13 @@ export interface operations {
                 };
                 content?: never;
             };
-            /** @description Unprocessable Entity */
+            /** @description Unprocessable Content (ADR-0028). The request is well-formed and permitted, and what it points at cannot be processed. Branch on type. Every reason is listed under violations, each with a stable code to key on and a message in prose. */
             422: {
                 headers: {
                     [name: string]: unknown;
                 };
                 content: {
-                    "application/problem+json": components["schemas"]["ProblemDetails"];
+                    "application/problem+json": components["schemas"]["UncapturableQuoteOptionProblem"];
                 };
             };
         };
@@ -21388,13 +21753,13 @@ export interface operations {
                     "application/problem+json": components["schemas"]["ConcurrencyConflictProblem"] | components["schemas"]["ProblemDetails"];
                 };
             };
-            /** @description Unprocessable Entity */
+            /** @description Unprocessable Content (ADR-0028). The request is well-formed and permitted, and what it points at cannot be processed. Branch on type. Every reason is listed under violations, each with a stable code to key on and a message in prose. */
             422: {
                 headers: {
                     [name: string]: unknown;
                 };
                 content: {
-                    "application/problem+json": components["schemas"]["ProblemDetails"];
+                    "application/problem+json": components["schemas"]["UncapturableQuoteOptionProblem"];
                 };
             };
         };
@@ -21513,13 +21878,13 @@ export interface operations {
                     "application/problem+json": components["schemas"]["ConcurrencyConflictProblem"] | components["schemas"]["ProblemDetails"];
                 };
             };
-            /** @description Unprocessable Entity */
+            /** @description Unprocessable Content (ADR-0028). The request is well-formed and permitted, and what it points at cannot be processed. Branch on type. Every reason is listed under violations, each with a stable code to key on and a message in prose. */
             422: {
                 headers: {
                     [name: string]: unknown;
                 };
                 content: {
-                    "application/problem+json": components["schemas"]["ProblemDetails"];
+                    "application/problem+json": components["schemas"]["UncapturableQuoteOptionProblem"];
                 };
             };
         };
@@ -21560,13 +21925,13 @@ export interface operations {
                     "application/problem+json": components["schemas"]["ConcurrencyConflictProblem"] | components["schemas"]["ProblemDetails"];
                 };
             };
-            /** @description Unprocessable Entity */
+            /** @description Unprocessable Content (ADR-0028). The request is well-formed and permitted, and what it points at cannot be processed. Branch on type. Every reason is listed under violations, each with a stable code to key on and a message in prose. */
             422: {
                 headers: {
                     [name: string]: unknown;
                 };
                 content: {
-                    "application/problem+json": components["schemas"]["ProblemDetails"];
+                    "application/problem+json": components["schemas"]["UncapturableQuoteOptionProblem"];
                 };
             };
         };
@@ -21700,7 +22065,7 @@ export interface operations {
                     "application/problem+json": components["schemas"]["ConcurrencyConflictProblem"] | components["schemas"]["ProblemDetails"];
                 };
             };
-            /** @description Unprocessable Entity */
+            /** @description Unprocessable Content (ADR-0028). The request is well-formed and permitted, and what it points at cannot be processed. Branch on type. Every reason is listed under violations, each with a stable code to key on and a message in prose. */
             422: {
                 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. */
@@ -21708,7 +22073,7 @@ export interface operations {
                     [name: string]: unknown;
                 };
                 content: {
-                    "application/problem+json": components["schemas"]["ProblemDetails"];
+                    "application/problem+json": components["schemas"]["UnquotableSubmissionProblem"];
                 };
             };
         };
@@ -22189,6 +22554,104 @@ export interface operations {
             };
         };
     };
+    ReadQuoteRequestReferenceFormat: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description OK */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["QuoteRequestReferenceFormatResponse"];
+                };
+            };
+        };
+    };
+    SetQuoteRequestReferenceFormat: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody: {
+            content: {
+                "application/json": components["schemas"]["SetQuoteRequestReferenceFormatRequest"];
+            };
+        };
+        responses: {
+            /** @description OK */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["QuoteRequestReferenceFormatResponse"];
+                };
+            };
+            /** @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"];
+                };
+            };
+        };
+    };
+    ClearQuoteRequestReferenceFormat: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description OK */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["QuoteRequestReferenceFormatResponse"];
+                };
+            };
+            /** @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"];
+                };
+            };
+        };
+    };
     ReadRetentionSchedule: {
         parameters: {
             query?: never;

package/package.json

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