@insurance-broker/api-client 5.28.0 → 5.30.0

package/dist/schema.d.ts

@@ -6120,7 +6120,7 @@ export interface paths {
          * Takes exactly one option on exactly one presented version. Terminal.
          * @description Accepts one option on the version that is presented now. Accepting is terminal: the quote request is settled and no further decision is recorded on it.
          *
-         *     **An option whose premium is above the approval limit the acting member's role carries is a `409` typed `urn:brokerplatform:problem:acceptance-above-approval-limit`** (#197, #630). The limit is the broker's configuration, not the caller's permission, so retrying never helps: a member whose role carries a higher limit accepts it, or the caller accepts a smaller option. The other `409`s — a second acceptance, an option whose price has lapsed, a superseded version, a lost update — say which in their `detail`.
+         *     **An option whose premium is above the approval limit the acting member's role carries is a `409` typed `urn:brokerplatform:problem:acceptance-above-approval-limit`** (#197, #630). The limit is the broker's configuration, not the caller's permission, so retrying never helps: a member whose role carries a higher limit accepts it, or the caller accepts a smaller option. The same type answers an option priced in a currency the acting member's role has no limit in, at a broker that has chosen to refuse such a currency (#422). The other `409`s — a second acceptance, an option whose price has lapsed, a superseded version, a lost update — say which in their `detail`.
          */
         post: operations["AcceptCustomerQuote"];
         delete?: never;
@@ -6203,6 +6203,30 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
+    "/api/v1/acceptance-approval-limits/settings": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * What a currency with no ceiling means at this broker
+         * @description Whether a member of a customer organisation whose role has a ceiling in some currency, but none in the currency a premium is quoted in, may accept it (Unlimited, the default) or is refused (Refused). A role with no ceiling in any currency is never refused by this setting, and a broker with no ceilings at all is unaffected by it. Answered whether or not it has been set; the updated members are null while the default applies.
+         */
+        get: operations["ReadAcceptanceApprovalSettings"];
+        /**
+         * Choose what a currency with no ceiling means at this broker
+         * @description Sets currencyWithoutACeiling to Unlimited or Refused. Refused takes effect on the next acceptance: a member acting for an organisation whose role has a ceiling in another currency, and none in the premium's, is refused with the same 409 an acceptance above a ceiling receives. Unlimited restores the default.
+         */
+        put: operations["SetAcceptanceApprovalSettings"];
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     "/api/v1/acceptance-approval-limits/{role}/{currency}": {
         parameters: {
             query?: never;
@@ -6716,6 +6740,12 @@ export interface components {
             updatedAtUtc: string;
             setBySubjectId: string;
         };
+        AcceptanceApprovalSettingsResponse: {
+            currencyWithoutACeiling: string;
+            /** Format: date-time */
+            updatedAtUtc: null | string;
+            updatedBySubjectId: null | string;
+        };
         AcceptQuoteRequest: {
             /** Format: uuid */
             presentationVersionId: null | string;
@@ -6764,6 +6794,19 @@ export interface components {
             name: null | string;
             description: null | string;
         };
+        /** @description The members of errors that defining a product can answer 400 with, each keyed by the request member's own name. Any member may be absent; each present one is a list of sentences for a person. */
+        AddProductValidationErrors: {
+            /** @description The key is missing, or is not lower-case letters, digits and hyphens within the length limit. */
+            Key?: string[];
+            /** @description The name is missing or too long. */
+            Name?: string[];
+            /** @description The description is too long. */
+            Description?: string[];
+            /** @description The line of business is missing, or this broker has no line of business with that identifier. */
+            CategoryId?: string[];
+        } & {
+            [key: string]: string[];
+        };
         ApproachInsurerRequest: {
             /** Format: uuid */
             insurerId: null | string;
@@ -6801,6 +6844,13 @@ export interface components {
             /** Format: uuid */
             insurerId: null | string;
         };
+        /** @description The members of errors that naming an insurer on a product's panel can answer 400 with, each keyed by the request member's own name. Any member may be absent; each present one is a list of sentences for a person. */
+        AttachProductInsurerValidationErrors: {
+            /** @description The insurer is missing, or this broker has no insurer with that identifier. */
+            InsurerId?: string[];
+        } & {
+            [key: string]: string[];
+        };
         AuditActionsResponse: {
             actions: string[];
             incomplete: boolean;
@@ -9331,6 +9381,13 @@ export interface components {
             /** Format: date-time */
             attachedAtUtc: string;
         };
+        /** @description The members of errors that activating or withdrawing a product can answer 400 with. The routes take no body, so the If-Match header is the only key. */
+        ProductLifecycleValidationErrors: {
+            /** @description The If-Match header is not a concurrencyToken this API issued: send it exactly as it was read. */
+            "If-Match"?: string[];
+        } & {
+            [key: string]: string[];
+        };
         ProductResponse: {
             /** Format: uuid */
             id: string;
@@ -9585,6 +9642,15 @@ export interface components {
             /** Format: uuid */
             categoryId: null | string;
         };
+        /** @description The members of errors that reclassifying a product can answer 400 with, each keyed by the request member's own name, or If-Match for the header. Any member may be absent; each present one is a list of sentences for a person. */
+        ReclassifyProductValidationErrors: {
+            /** @description The line of business is missing, or this broker has no line of business with that identifier. */
+            CategoryId?: string[];
+            /** @description The If-Match header is not a concurrencyToken this API issued: send it exactly as it was read. */
+            "If-Match"?: string[];
+        } & {
+            [key: string]: string[];
+        };
         RecordAnswersRequest: {
             answers: null | components["schemas"]["JsonElement"];
             source: null | string;
@@ -10013,6 +10079,9 @@ export interface components {
             /** Format: double */
             maximumAmount: null | number | string;
         };
+        SetAcceptanceApprovalSettingsRequest: {
+            currencyWithoutACeiling: null | string;
+        };
         SetEmergencyContactRequest: {
             providerName: null | string;
             contactDetail: null | string;
@@ -10583,6 +10652,17 @@ export interface components {
             name: null | string;
             description: null | string;
         };
+        /** @description The members of errors that correcting a product can answer 400 with, each keyed by the request member's own name, or If-Match for the header. Any member may be absent; each present one is a list of sentences for a person. */
+        UpdateProductValidationErrors: {
+            /** @description The name is missing or too long. */
+            Name?: string[];
+            /** @description The description is too long. */
+            Description?: string[];
+            /** @description The If-Match header is not a concurrencyToken this API issued: send it exactly as it was read. */
+            "If-Match"?: string[];
+        } & {
+            [key: string]: string[];
+        };
         VerifyServiceLocationRequest: {
             assurance: null | string;
         };
@@ -12829,13 +12909,21 @@ export interface operations {
                     "application/json": components["schemas"]["ProductResponse"];
                 };
             };
-            /** @description Bad Request */
+            /** @description Bad Request. errors is keyed by the request member's own name, or by a header's name, and the keys this operation can send are the members of errors in this schema: Key, Name, Description, CategoryId. Each holds sentences for a person. A body the server could not read is answered 400 with no errors at all. */
             400: {
                 headers: {
                     [name: string]: unknown;
                 };
                 content: {
-                    "application/problem+json": components["schemas"]["HttpValidationProblemDetails"];
+                    "application/problem+json": {
+                        type?: null | string;
+                        title?: null | string;
+                        /** Format: int32 */
+                        status?: null | number;
+                        detail?: null | string;
+                        instance?: null | string;
+                        errors?: components["schemas"]["AddProductValidationErrors"];
+                    };
                 };
             };
             /** @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. */
@@ -12941,13 +13029,21 @@ export interface operations {
                     "application/json": components["schemas"]["ProductResponse"];
                 };
             };
-            /** @description Bad Request */
+            /** @description Bad Request. errors is keyed by the request member's own name, or by a header's name, and the keys this operation can send are the members of errors in this schema: Name, Description, If-Match. Each holds sentences for a person. A body the server could not read is answered 400 with no errors at all. */
             400: {
                 headers: {
                     [name: string]: unknown;
                 };
                 content: {
-                    "application/problem+json": components["schemas"]["HttpValidationProblemDetails"];
+                    "application/problem+json": {
+                        type?: null | string;
+                        title?: null | string;
+                        /** Format: int32 */
+                        status?: null | number;
+                        detail?: null | string;
+                        instance?: null | string;
+                        errors?: components["schemas"]["UpdateProductValidationErrors"];
+                    };
                 };
             };
             /** @description Not Found */
@@ -13004,13 +13100,21 @@ export interface operations {
                     "application/json": components["schemas"]["ProductResponse"];
                 };
             };
-            /** @description Bad Request */
+            /** @description Bad Request. errors is keyed by the request member's own name, or by a header's name, and the keys this operation can send are the members of errors in this schema: CategoryId, If-Match. Each holds sentences for a person. A body the server could not read is answered 400 with no errors at all. */
             400: {
                 headers: {
                     [name: string]: unknown;
                 };
                 content: {
-                    "application/problem+json": components["schemas"]["HttpValidationProblemDetails"];
+                    "application/problem+json": {
+                        type?: null | string;
+                        title?: null | string;
+                        /** Format: int32 */
+                        status?: null | number;
+                        detail?: null | string;
+                        instance?: null | string;
+                        errors?: components["schemas"]["ReclassifyProductValidationErrors"];
+                    };
                 };
             };
             /** @description Not Found */
@@ -13063,6 +13167,23 @@ export interface operations {
                     "application/json": components["schemas"]["ProductResponse"];
                 };
             };
+            /** @description Bad Request. errors is keyed by the request member's own name, or by a header's name, and the keys this operation can send are the members of errors in this schema: If-Match. Each holds sentences for a person. A body the server could not read is answered 400 with no errors at all. */
+            400: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/problem+json": {
+                        type?: null | string;
+                        title?: null | string;
+                        /** Format: int32 */
+                        status?: null | number;
+                        detail?: null | string;
+                        instance?: null | string;
+                        errors?: components["schemas"]["ProductLifecycleValidationErrors"];
+                    };
+                };
+            };
             /** @description Not Found */
             404: {
                 headers: {
@@ -13113,6 +13234,23 @@ export interface operations {
                     "application/json": components["schemas"]["ProductResponse"];
                 };
             };
+            /** @description Bad Request. errors is keyed by the request member's own name, or by a header's name, and the keys this operation can send are the members of errors in this schema: If-Match. Each holds sentences for a person. A body the server could not read is answered 400 with no errors at all. */
+            400: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/problem+json": {
+                        type?: null | string;
+                        title?: null | string;
+                        /** Format: int32 */
+                        status?: null | number;
+                        detail?: null | string;
+                        instance?: null | string;
+                        errors?: components["schemas"]["ProductLifecycleValidationErrors"];
+                    };
+                };
+            };
             /** @description Not Found */
             404: {
                 headers: {
@@ -13164,13 +13302,21 @@ export interface operations {
                     "application/json": components["schemas"]["ProductResponse"];
                 };
             };
-            /** @description Bad Request */
+            /** @description Bad Request. errors is keyed by the request member's own name, or by a header's name, and the keys this operation can send are the members of errors in this schema: InsurerId. Each holds sentences for a person. A body the server could not read is answered 400 with no errors at all. */
             400: {
                 headers: {
                     [name: string]: unknown;
                 };
                 content: {
-                    "application/problem+json": components["schemas"]["HttpValidationProblemDetails"];
+                    "application/problem+json": {
+                        type?: null | string;
+                        title?: null | string;
+                        /** Format: int32 */
+                        status?: null | number;
+                        detail?: null | string;
+                        instance?: null | string;
+                        errors?: components["schemas"]["AttachProductInsurerValidationErrors"];
+                    };
                 };
             };
             /** @description Not Found */
@@ -25462,6 +25608,68 @@ export interface operations {
             };
         };
     };
+    ReadAcceptanceApprovalSettings: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description OK */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["AcceptanceApprovalSettingsResponse"];
+                };
+            };
+        };
+    };
+    SetAcceptanceApprovalSettings: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody: {
+            content: {
+                "application/json": components["schemas"]["SetAcceptanceApprovalSettingsRequest"];
+            };
+        };
+        responses: {
+            /** @description OK */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["AcceptanceApprovalSettingsResponse"];
+                };
+            };
+            /** @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"];
+                };
+            };
+        };
+    };
     SetAcceptanceApprovalLimit: {
         parameters: {
             query?: never;

package/package.json

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