@insurance-broker/api-client 2.11.0 → 2.12.0

package/dist/schema.d.ts

@@ -5474,6 +5474,120 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
+    "/api/v1/customer/notifications": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * What your broker has told you
+         * @description Your own notifications, newest first, paged by an opaque cursor with no total count.
+         *
+         *     **Including the ones that did not reach you.** A notification whose delivery had nowhere to go is recorded as `Undeliverable` rather than discarded, and it is shown here, because the person it was for is the one party with a reason to know it was raised.
+         *
+         *     You are not named in the request. The list is your own and there is no way to ask for anybody else's.
+         *
+         *     **This one follows who you are acting as.** Acting for an organisation lists the organisation's notifications, because what a message is about is the organisation's business. The preference and device routes beneath this path deliberately do not: where you are told, and how, is yours.
+         */
+        get: operations["ListOwnNotifications"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/api/v1/customer/notifications/preferences": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * How you have asked to be told
+         * @description COM-002. Which channels your broker may use to tell you about your own cover.
+         *
+         *     **This is not marketing consent.** Marketing consent, the necessity of a service notification and the lawful basis for processing your data are recorded separately (BR-007), and nothing on this resource expresses any of them.
+         *
+         *     If you have never chosen, you are answered with the defaults and `updatedAtUtc` is null.
+         *
+         *     **This is yours and never an organisation's.** If you are acting for an organisation the request is refused: drop `X-Broker-Acting-For` to read your own.
+         */
+        get: operations["ReadOwnNotificationPreferences"];
+        /**
+         * Choose how you are told
+         * @description COM-002. Replaces the whole choice, so all three channels have to be stated.
+         *
+         *     **At least one has to stay on.** Messages about your own cover — a renewal falling due, a payment owed, something happening on a claim — are not marketing and there is no opt-out from them; what you choose is which way they reach you. A request that turns everything off is refused.
+         *
+         *     **Nothing here records a marketing preference** (BR-007).
+         *
+         *     **This is yours and never an organisation's.** If you are acting for an organisation the request is refused: drop `X-Broker-Acting-For` to set your own.
+         */
+        put: operations["SetOwnNotificationPreferences"];
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/api/v1/customer/notifications/devices": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        /**
+         * Register this device to be told on
+         * @description Records the push token this installation currently holds, against you.
+         *
+         *     **Safe to call again, and meant to be.** Send it at every sign-in and whenever the operating system rotates the token: the installation identifier is what ties the new token to the same device, so a rotation replaces the address rather than adding a second one. The first call answers 201 and later calls answer 200.
+         *
+         *     **The token is never returned and never logged.** Keep the `id` from the response; it is what you revoke at sign-out.
+         *
+         *     **Registering does not mean anything will be sent.** This platform has no push provider (#371); the registration exists so that the one eventually chosen has an address.
+         *
+         *     **A handset is yours and never an organisation's.** If you are acting for an organisation the request is refused: drop `X-Broker-Acting-For`. A phone registered to an organisation would outlive your membership of it.
+         */
+        post: operations["RegisterOwnDevice"];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/api/v1/customer/notifications/devices/{id}": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        post?: never;
+        /**
+         * Stop this device being told on
+         * @description Call this as part of signing out. The stored token is discarded, not merely flagged, so nothing can be delivered to the handset after the person using it has left.
+         *
+         *     Repeating it is harmless. A device that is not yours answers 404.
+         *
+         *     **Your handsets are yours and never an organisation's.** If you are acting for an organisation the request is refused: drop `X-Broker-Acting-For` to revoke your own.
+         */
+        delete: operations["RevokeOwnDevice"];
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
 }
 export type webhooks = Record<string, never>;
 export interface components {
@@ -5927,6 +6041,16 @@ export interface components {
             state: string;
             value: null | string;
         };
+        CustomerDeviceResponse: {
+            /** Format: uuid */
+            id: string;
+            platform: string;
+            appVersion: string;
+            /** Format: date-time */
+            registeredAtUtc: string;
+            /** Format: date-time */
+            lastRegisteredAtUtc: string;
+        };
         CustomerEmergencyContactResponse: {
             countryCode: string;
             contact: string;
@@ -5965,6 +6089,23 @@ export interface components {
             /** Format: date-time */
             revokedAtUtc: null | string;
         };
+        CustomerNotificationPage: {
+            items: components["schemas"]["CustomerNotificationResponse"][];
+            nextCursor: null | string;
+        };
+        CustomerNotificationResponse: {
+            /** Format: uuid */
+            id: string;
+            kind: string;
+            reference: null | string;
+            subject: string;
+            body: string;
+            delivery: string;
+            /** Format: date-time */
+            createdAtUtc: string;
+            /** Format: date-time */
+            sentAtUtc: null | string;
+        };
         CustomerPaymentPageResponse: {
             items: components["schemas"]["CustomerPaymentResponse"][];
             nextCursor: null | string;
@@ -6761,6 +6902,13 @@ export interface components {
             items: components["schemas"]["NotificationResponse"][];
             nextCursor: null | string;
         };
+        NotificationPreferenceResponse: {
+            sms: boolean;
+            email: boolean;
+            push: boolean;
+            /** Format: date-time */
+            updatedAtUtc: null | string;
+        };
         NotificationResponse: {
             /** Format: uuid */
             id: string;
@@ -7622,6 +7770,12 @@ export interface components {
             email: null | string;
             phone: null | string;
         };
+        RegisterDeviceRequest: {
+            installationId: null | string;
+            platform: null | string;
+            token: null | string;
+            appVersion: null | string;
+        };
         RegisterOrganisationRequest: {
             name: null | string;
             registrationNumber: null | string;
@@ -7900,6 +8054,11 @@ export interface components {
             contactDetail: null | string;
             instruction: null | string;
         };
+        SetNotificationPreferenceRequest: {
+            sms: null | boolean;
+            email: null | boolean;
+            push: null | boolean;
+        };
         SetRenewalLeadTimeRequest: {
             /** Format: int32 */
             leadDays: null | number | string;
@@ -21243,4 +21402,194 @@ export interface operations {
             };
         };
     };
+    ListOwnNotifications: {
+        parameters: {
+            query?: {
+                cursor?: string;
+                limit?: number | string;
+            };
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description OK */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["CustomerNotificationPage"];
+                };
+            };
+            /** @description Bad Request */
+            400: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/problem+json": components["schemas"]["HttpValidationProblemDetails"];
+                };
+            };
+        };
+    };
+    ReadOwnNotificationPreferences: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description OK */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["NotificationPreferenceResponse"];
+                };
+            };
+            /** @description Forbidden */
+            403: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/problem+json": components["schemas"]["ProblemDetails"];
+                };
+            };
+        };
+    };
+    SetOwnNotificationPreferences: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody: {
+            content: {
+                "application/json": components["schemas"]["SetNotificationPreferenceRequest"];
+            };
+        };
+        responses: {
+            /** @description OK */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["NotificationPreferenceResponse"];
+                };
+            };
+            /** @description Bad Request */
+            400: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/problem+json": components["schemas"]["HttpValidationProblemDetails"];
+                };
+            };
+            /** @description Forbidden */
+            403: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/problem+json": components["schemas"]["ProblemDetails"];
+                };
+            };
+        };
+    };
+    RegisterOwnDevice: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody: {
+            content: {
+                "application/json": components["schemas"]["RegisterDeviceRequest"];
+            };
+        };
+        responses: {
+            /** @description OK */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["CustomerDeviceResponse"];
+                };
+            };
+            /** @description Created */
+            201: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["CustomerDeviceResponse"];
+                };
+            };
+            /** @description Bad Request */
+            400: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/problem+json": components["schemas"]["HttpValidationProblemDetails"];
+                };
+            };
+            /** @description Forbidden */
+            403: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/problem+json": components["schemas"]["ProblemDetails"];
+                };
+            };
+        };
+    };
+    RevokeOwnDevice: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                id: string;
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description No Content */
+            204: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+            /** @description Forbidden */
+            403: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/problem+json": components["schemas"]["ProblemDetails"];
+                };
+            };
+            /** @description Not Found */
+            404: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+        };
+    };
 }

package/package.json

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