@insurance-broker/api-client 2.20.0 → 2.23.0

package/dist/schema.d.ts

@@ -1167,7 +1167,7 @@ export interface paths {
          * Starts answering a form, pinning the version that is live now.
          * @description Starts a submission of the named form on a customer's behalf, against the version of it that is live now.
          *
-         *     **A `409` here is a settled fact, and `type` says which** (#459). `urn:brokerplatform:problem:product-not-open-to-new-business` means the product is not open to new business — still a draft, or withdrawn — so there is nothing to answer against and nothing to retry. `urn:brokerplatform:problem:form-has-no-live-version` means no version of this form is published, so there is nothing to answer until one is.
+         *     **A `409` here is a settled fact, and `type` says which** (#459). `urn:brokerplatform:problem:product-not-open-to-new-business` means the product is not open to new business — still a draft, or withdrawn — so there is nothing to answer against and nothing to retry. `urn:brokerplatform:problem:form-has-no-live-version` means no version of this form is published, so there is nothing to answer until one is. A form whose product no longer exists answers `urn:brokerplatform:problem:product-not-open-to-new-business` too (#470): there is nothing to offer either way.
          */
         post: operations["StartFormSubmission"];
         delete?: never;
@@ -1201,7 +1201,12 @@ export interface paths {
             cookie?: never;
         };
         get?: never;
-        /** Records what has been answered so far. */
+        /**
+         * Records what has been answered so far.
+         * @description Records what has been answered so far, replacing the answers recorded before. Nothing is validated until the submission is made.
+         *
+         *     **A `409` here is one of four things, and `type` is what tells them apart** (#470). `urn:brokerplatform:problem:submission-already-submitted` means the submission has been made, so read it rather than editing it. `urn:brokerplatform:problem:pinned-version-changed` means the version this draft is pinned to no longer hashes to what it started against, so nothing more can be recorded on it; read it again to show what it now asks. `urn:brokerplatform:problem:form-version-unreadable` means the version is in a schema this engine cannot read, and nothing sent here will change that. `urn:brokerplatform:problem:concurrency-conflict` means somebody wrote first; read again and retry.
+         */
         put: operations["RecordFormSubmissionAnswers"];
         post?: never;
         delete?: never;
@@ -1219,7 +1224,14 @@ export interface paths {
         };
         get?: never;
         put?: never;
-        /** Makes the submission, if the answers satisfy the version. */
+        /**
+         * Makes the submission, if the answers satisfy the version.
+         * @description Makes the submission from the answers recorded so far, if they satisfy the version it is pinned to. Sent again with the same `idempotencyKey`, it answers the submission rather than refusing it.
+         *
+         *     **A `409` here is a settled fact, and `type` says which** (#470). `urn:brokerplatform:problem:submission-already-submitted` means it was already made, with a different key or none. `urn:brokerplatform:problem:pinned-version-changed` means the version it is pinned to no longer hashes to what it started against, so it cannot be made. `urn:brokerplatform:problem:form-version-unreadable` means the version is in a schema this engine cannot read. `urn:brokerplatform:problem:recorded-answers-unreadable` means the answers recorded so far cannot be read; recording them again replaces them. `urn:brokerplatform:problem:concurrency-conflict` means answers were recorded in the same instant; read again and retry.
+         *
+         *     **A `422` is `urn:brokerplatform:problem:unsatisfied-answers`**, and its `violations` name each answer to correct.
+         */
         post: operations["SubmitFormSubmission"];
         delete?: never;
         options?: never;
@@ -1240,7 +1252,7 @@ export interface paths {
          * Moves a draft onto the version of its form that is live now.
          * @description Moves a draft onto the version of its form that is live now, carrying every answer whose question survived and naming the ones that did not.
          *
-         *     **A `409` here is a settled fact.** Two of them carry their own `type` (#459): `urn:brokerplatform:problem:product-not-open-to-new-business` means the product is no longer open to new business, so the draft stays on the version it has; `urn:brokerplatform:problem:form-has-no-live-version` means the form's live version was taken down and there is nothing to move onto. A `409` with the default `type` is the draft already being on the live version, or the submission already having been made.
+         *     **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 open to new business, or no longer exists, so the draft stays on the version it has. `urn:brokerplatform:problem:form-has-no-live-version` means the form's live version was taken 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 submission has been made 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 recorded so far cannot be read, so nothing could be carried; recording them again replaces them. `urn:brokerplatform:problem:concurrency-conflict` means somebody wrote first; read again and retry.
          */
         post: operations["RepinFormSubmission"];
         delete?: never;
@@ -1263,7 +1275,7 @@ export interface paths {
          * Starts answering a form, pinning the version that is live now.
          * @description Starts a submission of the named form for the calling customer, against the version of it that is live now. The owner is never in the request.
          *
-         *     **A `409` here is one of three things, and `type` is what tells them apart** (#459). `urn:brokerplatform:problem:draft-already-open` means you already have a draft of this form open and it is named in `submissionId`, so resume that one rather than showing the sentence in `detail`. `urn:brokerplatform:problem:product-not-open-to-new-business` means the product is no longer offered, so there is nothing to open and nothing to retry. `urn:brokerplatform:problem:form-has-no-live-version` means the broker has not published a version of this form to answer; retrying will not change that until they do.
+         *     **A `409` here is one of three things, and `type` is what tells them apart** (#459). `urn:brokerplatform:problem:draft-already-open` means you already have a draft of this form open and it is named in `submissionId`, so resume that one rather than showing the sentence in `detail`. `urn:brokerplatform:problem:product-not-open-to-new-business` means the product is no longer offered, or no longer exists, so there is nothing to open and nothing to retry (#470). `urn:brokerplatform:problem:form-has-no-live-version` means the broker has not published a version of this form to answer; retrying will not change that until they do.
          */
         post: operations["StartCustomerFormSubmission"];
         delete?: never;
@@ -1297,7 +1309,12 @@ export interface paths {
             cookie?: never;
         };
         get?: never;
-        /** Saves what they have answered so far. No validation until submit. */
+        /**
+         * Saves what they have answered so far. No validation until submit.
+         * @description Saves what the customer has answered so far, replacing the answers saved before. Nothing is checked until they submit.
+         *
+         *     **A `409` here is one of four things, and `type` is what tells them apart** (#470). `urn:brokerplatform:problem:submission-already-submitted` means the form has been submitted, so show it rather than editing it. `urn:brokerplatform:problem:pinned-version-changed` means the version this draft is pinned to no longer hashes to what it started against, so nothing more can be recorded on it; read it again to show what it now asks. `urn:brokerplatform:problem:form-version-unreadable` means the version is in a schema this engine cannot read, and nothing sent here will change that. `urn:brokerplatform:problem:concurrency-conflict` means another of their devices saved first; read again and retry.
+         */
         put: operations["RecordCustomerFormSubmissionAnswers"];
         post?: never;
         delete?: never;
@@ -1315,7 +1332,14 @@ export interface paths {
         };
         get?: never;
         put?: never;
-        /** Submits their form, if the answers satisfy the version. */
+        /**
+         * Submits their form, if the answers satisfy the version.
+         * @description Submits the customer's form from the answers saved so far, if they satisfy the version it is pinned to. Sent again with the same `idempotencyKey`, it answers the submission rather than refusing it.
+         *
+         *     **A `409` here is a settled fact, and `type` says which** (#470). `urn:brokerplatform:problem:submission-already-submitted` means it was already submitted, with a different key or none. `urn:brokerplatform:problem:pinned-version-changed` means the version it is pinned to no longer hashes to what it started against, so it cannot be submitted. `urn:brokerplatform:problem:form-version-unreadable` means the version is in a schema this engine cannot read. `urn:brokerplatform:problem:recorded-answers-unreadable` means the answers saved so far cannot be read; saving them again replaces them. `urn:brokerplatform:problem:concurrency-conflict` means answers were saved in the same instant; read again and retry.
+         *
+         *     **A `422` is `urn:brokerplatform:problem:unsatisfied-answers`**, and its `violations` name each answer to correct.
+         */
         post: operations["SubmitCustomerFormSubmission"];
         delete?: never;
         options?: never;
@@ -1332,7 +1356,12 @@ export interface paths {
         };
         get?: never;
         put?: never;
-        /** Attaches a file to one of the evidence requirements the form asks for. */
+        /**
+         * Attaches a file to one of the evidence requirements the form asks for.
+         * @description Attaches one file to the evidence requirement named by `evidenceKey`, on a submission that has not been made yet.
+         *
+         *     **A `409` here is a settled fact.** Three of them carry their own `type` (#470): `urn:brokerplatform:problem:submission-already-submitted` means the submission has been made, and evidence added now would change what was submitted. `urn:brokerplatform:problem:pinned-version-changed` means the version it is pinned to no longer hashes to what it started against, so what the form asks for cannot be proved. `urn:brokerplatform:problem:form-version-unreadable` means the version is in a schema this engine cannot read. A `409` with the default `type` is the requirement already holding a file; remove that one first.
+         */
         post: operations["UploadSubmissionAttachment"];
         delete?: never;
         options?: never;
@@ -1417,7 +1446,12 @@ export interface paths {
         };
         get?: never;
         put?: never;
-        /** Attaches a file to one of the evidence requirements the form asks for. */
+        /**
+         * Attaches a file to one of the evidence requirements the form asks for.
+         * @description Attaches one file to the evidence requirement named by `evidenceKey`, on a submission that has not been made yet.
+         *
+         *     **A `409` here is a settled fact.** Three of them carry their own `type` (#470): `urn:brokerplatform:problem:submission-already-submitted` means the submission has been made, and evidence added now would change what was submitted. `urn:brokerplatform:problem:pinned-version-changed` means the version it is pinned to no longer hashes to what it started against, so what the form asks for cannot be proved. `urn:brokerplatform:problem:form-version-unreadable` means the version is in a schema this engine cannot read. A `409` with the default `type` is the requirement already holding a file; remove that one first.
+         */
         post: operations["UploadCustomerSubmissionAttachment"];
         delete?: never;
         options?: never;
@@ -3209,6 +3243,23 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
+    "/api/v1/tenant/branding/mark": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /** The broker's name, logo and two colours, for its staff: exactly what its public branding publishes, and nothing more. */
+        get: operations["GetTenantBrandingMark"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     "/api/v1/tenant/profile": {
         parameters: {
             query?: never;
@@ -15877,6 +15928,26 @@ export interface operations {
             };
         };
     };
+    GetTenantBrandingMark: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description OK */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["PublicBrandingResponse"];
+                };
+            };
+        };
+    };
     GetTenantProfile: {
         parameters: {
             query?: never;

package/package.json

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