@insurance-broker/api-client 2.16.1 → 2.18.0

package/dist/schema.d.ts

@@ -1163,7 +1163,12 @@ export interface paths {
         /** The broker's submissions, newest first. */
         get: operations["ListFormSubmissions"];
         put?: never;
-        /** Starts answering a form, pinning the version that is live now. */
+        /**
+         * 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.
+         */
         post: operations["StartFormSubmission"];
         delete?: never;
         options?: never;
@@ -1231,7 +1236,12 @@ export interface paths {
         };
         get?: never;
         put?: never;
-        /** Moves a draft onto the version of its form that is live now. */
+        /**
+         * 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.
+         */
         post: operations["RepinFormSubmission"];
         delete?: never;
         options?: never;
@@ -1249,7 +1259,12 @@ export interface paths {
         /** This customer's own submissions, newest first. */
         get: operations["ListCustomerFormSubmissions"];
         put?: never;
-        /** Starts answering a form, pinning the version that is live now. */
+        /**
+         * 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.
+         */
         post: operations["StartCustomerFormSubmission"];
         delete?: never;
         options?: never;
@@ -4562,7 +4577,14 @@ export interface paths {
         /** The broker's quote requests, newest first, one page at a time. */
         get: operations["ListQuoteRequests"];
         put?: never;
-        /** Raises a quote request against a submitted form. */
+        /**
+         * Raises a quote request against a submitted form.
+         * @description QTE-001. Raises a quote request from a submitted form on the customer's behalf; the product, the owner and the risk details all come from the form and never from this request.
+         *
+         *     **A `409` here is one of three things, and `type` is what tells them apart** (#430). `urn:brokerplatform:problem:quote-already-requested` means an active request already exists against this form and it is named in `quoteRequestId`, so open that one rather than showing the sentence in `detail`. `urn:brokerplatform:problem:product-not-open-to-new-business` means the product is not open to new business, so there is nothing to open and nothing to retry. `urn:brokerplatform:problem:concurrency-conflict` means somebody wrote first; read again and retry.
+         *
+         *     **A `422` is `urn:brokerplatform:problem:unquotable-submission`**, and its `violations` say why: `submission-not-submitted` covers a draft, another broker's form and a form that does not exist, deliberately as one; `submission-has-no-customer` is its own code because the fix is different.
+         */
         post: operations["RaiseQuoteRequest"];
         delete?: never;
         options?: never;
@@ -5031,7 +5053,14 @@ export interface paths {
         /** Lists the caller's own quote requests, newest first. */
         get: operations["ListCustomerQuotes"];
         put?: never;
-        /** Asks the broker for a quote against one of the caller's submitted forms. */
+        /**
+         * Asks the broker for a quote against one of the caller's submitted forms.
+         * @description QTE-001. Raises a quote request from one of your submitted forms; the product, the owner and the risk details all come from the form and never from this request.
+         *
+         *     **A `409` here is one of three things, and `type` is what tells them apart** (#430). `urn:brokerplatform:problem:quote-already-requested` means a request is already open against this form and the one to resume is named in `quoteRequestId`, so open 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:concurrency-conflict` means somebody wrote first; read again and retry.
+         *
+         *     **A `422` is `urn:brokerplatform:problem:unquotable-submission`**: the form is a draft, is not yours, or does not exist — one refusal for all three, so this route cannot be used to discover which forms exist. Its `violations` name the form.
+         */
         post: operations["RaiseCustomerQuote"];
         delete?: never;
         options?: never;

package/package.json

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