@insurance-broker/api-client 5.33.0 → 5.40.0

package/dist/schema.d.ts

@@ -3026,7 +3026,7 @@ export interface paths {
          *
          *     **Tell the customer to change their password, and to secure their email account.** Signing out does not stop somebody who knows the password from signing in again, and a password can be reset through the email address.
          *
-         *     **What it does not do yet.** It does not end the sessions at the identity provider, list them, or end one and keep the others; those need the isolated identity-management component ADR-0049 describes. A `409` means the caller is acting for an organisation: sessions belong to the person, so act personally to revoke them.
+         *     **Where a deployment has enabled the isolated identity-management component (ADR-0049), the identity provider's sessions are also ended**, shortly after this answer and not before it: the request is recorded here and carried out in the background. Nowhere is that a reason to skip the steps above. It does not list sessions, or end one and keep the others. A `409` means the caller is acting for an organisation: sessions belong to the person, so act personally to revoke them.
          */
         post: operations["RevokeOwnCustomerSessions"];
         delete?: never;
@@ -3097,7 +3097,7 @@ export interface paths {
          *
          *     **Refusals.** `400` when either field is missing or the reason is too long. `404` when the customer is not this broker's. `409` with problem type `urn:brokerplatform:problem:verification-method-not-offered` when the method is not in this broker's set, has been retired, or the broker has configured none — read the set and choose from it. `409` with no type when the customer has never attached a sign-in account, so has no session to end.
          *
-         *     **What it does not do yet.** It does not end the sessions at the identity provider or list them; those need the isolated identity-management component ADR-0049 describes.
+         *     **Where a deployment has enabled the isolated identity-management component (ADR-0049), the identity provider's sessions are also ended**, shortly after this answer and not before it, on this member of staff's own sign-in: the request is recorded here and carried out in the background. It does not list sessions.
          */
         post: operations["RevokeCustomerSessions"];
         delete?: never;
@@ -3890,6 +3890,54 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
+    "/api/v1/email-settings": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * This broker's SMTP provider for notification email
+         * @description Where this broker's notification email is sent from and through which SMTP provider. Answered whether or not anything has been configured: configured is false and every provider field null until somebody saves one. The password is never returned; passwordSet says whether one is stored.
+         */
+        get: operations["ReadEmailSettings"];
+        /**
+         * Set this broker's SMTP provider for notification email
+         * @description Saves the provider's host, port, TLS mode, username and sender, and turns email on or off. The password is write-only: send it to set or replace it, or omit it to keep the stored one; removing the username removes it. A kept password is refused when the host, port, TLS mode or username changes, so it is only ever sent to the server it was entered for. A username is refused with tlsMode None, so credentials never cross an unencrypted connection. While email is off or not configured, a notification that would have gone by email is recorded Undeliverable.
+         */
+        put: operations["SetEmailSettings"];
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/api/v1/push-settings": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * Whether this broker sends notifications by push
+         * @description Whether notifications to this broker's customers may be sent as push notifications to their registered devices. Answered whether or not anything has been saved: push is off until a broker turns it on. Push uses the platform's own credential, so there is nothing else to configure.
+         */
+        get: operations["ReadPushSettings"];
+        /**
+         * Turn push notifications on or off for this broker
+         * @description Turns push on or off. While it is off, a notification that would have gone by push goes by the recipient's other channels, or is recorded Undeliverable when there are none.
+         */
+        put: operations["SetPushSettings"];
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     "/api/v1/tenant": {
         parameters: {
             query?: never;
@@ -6600,7 +6648,7 @@ export interface paths {
         };
         /**
          * What this broker's platform tried to tell somebody
-         * @description Newest first, paged by an opaque cursor with no total count. Filter by status — the one worth opening this for is Undeliverable, which means the platform raised a notification and had nobody to send it to. The message body is not returned; the kind, the reference and the subject say what it was about.
+         * @description Newest first, paged by an opaque cursor with no total count. Filter by status — the one worth opening this for is Undeliverable, which means the platform raised a notification and could not send it: either there was nobody to send it to, or no channel could reach the person (for example, email is not configured). deliveryReason says which. The message body is not returned; the kind, the reference and the subject say what it was about.
          */
         get: operations["ListNotifications"];
         put?: never;
@@ -7886,6 +7934,21 @@ export interface components {
             policyId: string;
             idempotencyKey?: null | string;
         };
+        EmailSettingsResponse: {
+            configured: boolean;
+            enabled: boolean;
+            host: null | string;
+            /** Format: int32 */
+            port: null | number;
+            tlsMode: null | string;
+            username: null | string;
+            passwordSet: boolean;
+            fromAddress: null | string;
+            fromName: null | string;
+            /** Format: date-time */
+            updatedAtUtc: null | string;
+            updatedBySubjectId: null | string;
+        };
         EmergencyContactDetailsResponse: {
             providerName: string;
             contactDetail: string;
@@ -8669,6 +8732,7 @@ export interface components {
             createdAtUtc: string;
             /** Format: date-time */
             sentAtUtc: null | string;
+            deliveryReason?: null | string;
         };
         NotifyClaimRequest: {
             /** Format: uuid */
@@ -9431,6 +9495,13 @@ export interface components {
         PublishLegalTextRequest: {
             body: string;
         };
+        PushSettingsResponse: {
+            configured: boolean;
+            enabled: boolean;
+            /** Format: date-time */
+            updatedAtUtc: null | string;
+            updatedBySubjectId: null | string;
+        };
         QuotationPageOfComparisonSchemaVersionResponse: {
             items: components["schemas"]["ComparisonSchemaVersionResponse"][];
             nextCursor: null | string;
@@ -10085,6 +10156,17 @@ export interface components {
         SetAcceptanceApprovalSettingsRequest: {
             currencyWithoutACeiling: null | string;
         };
+        SetEmailSettingsRequest: {
+            enabled: null | boolean;
+            host: null | string;
+            /** Format: int32 */
+            port: null | number | string;
+            tlsMode: null | string;
+            username: null | string;
+            password: null | string;
+            fromAddress: null | string;
+            fromName: null | string;
+        };
         SetEmergencyContactRequest: {
             providerName: null | string;
             contactDetail: null | string;
@@ -10095,6 +10177,9 @@ export interface components {
             email: null | boolean;
             push: null | boolean;
         };
+        SetPushSettingsRequest: {
+            enabled: null | boolean;
+        };
         SetQuoteRequestReferenceFormatRequest: {
             format: null | string;
         };
@@ -19709,6 +19794,130 @@ export interface operations {
             };
         };
     };
+    ReadEmailSettings: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description OK */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["EmailSettingsResponse"];
+                };
+            };
+        };
+    };
+    SetEmailSettings: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody: {
+            content: {
+                "application/json": components["schemas"]["SetEmailSettingsRequest"];
+            };
+        };
+        responses: {
+            /** @description OK */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["EmailSettingsResponse"];
+                };
+            };
+            /** @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"];
+                };
+            };
+        };
+    };
+    ReadPushSettings: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description OK */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["PushSettingsResponse"];
+                };
+            };
+        };
+    };
+    SetPushSettings: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody: {
+            content: {
+                "application/json": components["schemas"]["SetPushSettingsRequest"];
+            };
+        };
+        responses: {
+            /** @description OK */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["PushSettingsResponse"];
+                };
+            };
+            /** @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"];
+                };
+            };
+        };
+    };
     GetTenantSettings: {
         parameters: {
             query?: never;

package/package.json

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