@insurance-broker/api-client 2.16.1 → 2.17.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/dist/schema.d.ts +16 -2
  2. package/package.json +1 -1
package/dist/schema.d.ts CHANGED
@@ -4562,7 +4562,14 @@ export interface paths {
4562
4562
  /** The broker's quote requests, newest first, one page at a time. */
4563
4563
  get: operations["ListQuoteRequests"];
4564
4564
  put?: never;
4565
- /** Raises a quote request against a submitted form. */
4565
+ /**
4566
+ * Raises a quote request against a submitted form.
4567
+ * @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.
4568
+ *
4569
+ * **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.
4570
+ *
4571
+ * **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.
4572
+ */
4566
4573
  post: operations["RaiseQuoteRequest"];
4567
4574
  delete?: never;
4568
4575
  options?: never;
@@ -5031,7 +5038,14 @@ export interface paths {
5031
5038
  /** Lists the caller's own quote requests, newest first. */
5032
5039
  get: operations["ListCustomerQuotes"];
5033
5040
  put?: never;
5034
- /** Asks the broker for a quote against one of the caller's submitted forms. */
5041
+ /**
5042
+ * Asks the broker for a quote against one of the caller's submitted forms.
5043
+ * @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.
5044
+ *
5045
+ * **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.
5046
+ *
5047
+ * **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.
5048
+ */
5035
5049
  post: operations["RaiseCustomerQuote"];
5036
5050
  delete?: never;
5037
5051
  options?: never;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@insurance-broker/api-client",
3
- "version": "2.16.1",
3
+ "version": "2.17.0",
4
4
  "description": "Generated TypeScript client for the Insurance Broker Platform API. Do not edit by hand: regenerate with scripts/update-api-contract.",
5
5
  "license": "UNLICENSED",
6
6
  "private": false,