@insurance-broker/api-client 2.9.0 → 2.11.0

package/dist/schema.d.ts

@@ -3486,6 +3486,127 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
+    "/api/v1/service-locations": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * This broker's service locations, drafts and unpublished ones included.
+         * @description The maintenance view. Unlike the customer's read, it shows every location whatever its state, because hiding a draft would make an unpublished location look deleted.
+         */
+        get: operations["ListServiceLocations"];
+        put?: never;
+        /** Records a place, as a draft nobody has attested to. */
+        post: operations["RecordServiceLocation"];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/api/v1/service-locations/{id}/description": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        /**
+         * Replaces a location's particulars. It returns to a draft.
+         * @description Every field is replaced, and the location goes back to being a draft: an attestation is about a set of particulars, so it does not survive them being rewritten. Correcting a published location therefore takes it off show until somebody verifies it again.
+         */
+        post: operations["ReviseServiceLocation"];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/api/v1/service-locations/{id}/verification": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        /**
+         * Records that somebody at this broker has checked the location.
+         * @description A repairer, a hospital or an assessor cannot be verified without an assurance saying what was checked; the broker's own office and an insurer's can. Nothing is published that has not been through here.
+         */
+        post: operations["VerifyServiceLocation"];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/api/v1/service-locations/{id}/publication": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        /** Puts a verified location in front of this broker's customers. */
+        post: operations["PublishServiceLocation"];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/api/v1/service-locations/{id}/withdrawal": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        /** Takes a location off show, leaving its attestation intact. */
+        post: operations["UnpublishServiceLocation"];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/api/v1/customer/service-locations": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * Where you can go: your broker's branches, insurers and approved providers
+         * @description LOC-001 and LOC-002, the customer's half. The places your broker publishes — its own offices, the insurers it places business with, and the repairers, hospitals and assessors in the network it stands behind.
+         *
+         *     **Everything here has been checked by your broker.** A place they have recorded but not yet verified, or have taken down, is not in this list at all.
+         *
+         *     **Location is optional.** Send nothing and you get the whole directory; send `search` to find a place or an area by name; send `latitude` and `longitude` to get the same list nearest first, with the distance in kilometres. Distance is a straight line, not a route.
+         *
+         *     **You are not named in the request, and neither is your broker.** The directory is your own broker's, resolved from the session you are signed in with.
+         */
+        get: operations["ReadOwnBrokersServiceLocations"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     "/api/v1/policies": {
         parameters: {
             query?: never;
@@ -4981,6 +5102,50 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
+    "/api/v1/acceptance-approval-limits": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * How much a member of a customer organisation may commit on their own
+         * @description Every ceiling this broker has configured, by membership role and currency. A role and currency with no row here is unlimited, which is where every broker starts: an empty list means nothing is refused.
+         */
+        get: operations["ReadAcceptanceApprovalLimits"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/api/v1/acceptance-approval-limits/{role}/{currency}": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        /**
+         * Set what a membership role may commit in one currency
+         * @description Records a ceiling. A person acting for one of this broker's customer organisations with the role named here may accept a quote whose premium is at or below this amount, in this currency, and is refused above it. Nothing about a customer acting personally is affected, and a premium quoted in a currency with no ceiling is not measured against anything.
+         */
+        put: operations["SetAcceptanceApprovalLimit"];
+        post?: never;
+        /**
+         * Let a membership role commit any amount in one currency again
+         * @description Deletes the ceiling. Unlimited applies again by absence, which is what an empty set means. Clearing a ceiling this broker does not have answers 404.
+         */
+        delete: operations["ClearAcceptanceApprovalLimit"];
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     "/api/v1/retention/schedule": {
         parameters: {
             query?: never;
@@ -5313,6 +5478,17 @@ export interface paths {
 export type webhooks = Record<string, never>;
 export interface components {
     schemas: {
+        AcceptanceApprovalLimitResponse: {
+            membershipRole: string;
+            currency: string;
+            /** Format: double */
+            maximumAmount: number | string;
+            /** Format: date-time */
+            setAtUtc: string;
+            /** Format: date-time */
+            updatedAtUtc: string;
+            setBySubjectId: string;
+        };
         AcceptQuoteRequest: {
             /** Format: uuid */
             presentationVersionId: null | string;
@@ -5943,6 +6119,24 @@ export interface components {
             /** Format: date-time */
             updatedAtUtc: string;
         };
+        CustomerServiceLocationResponse: {
+            /** Format: uuid */
+            id: string;
+            category: string;
+            name: string;
+            description: null | string;
+            address: null | string;
+            locality: null | string;
+            contactPhone: null | string;
+            contactEmail: null | string;
+            openingHours: null | string;
+            /** Format: double */
+            latitude: null | number | string;
+            /** Format: double */
+            longitude: null | number | string;
+            /** Format: double */
+            distanceKm: null | number | string;
+        };
         DataClassificationResponse: {
             key: string;
             name: string;
@@ -7392,6 +7586,20 @@ export interface components {
             /** Format: uuid */
             quoteRequestId: null | string;
         };
+        RecordServiceLocationRequest: {
+            category: string;
+            name: string;
+            description: null | string;
+            address: null | string;
+            locality: null | string;
+            contactPhone: null | string;
+            contactEmail: null | string;
+            openingHours: null | string;
+            /** Format: double */
+            latitude: null | number | string;
+            /** Format: double */
+            longitude: null | number | string;
+        };
         RecordTimelineEntryRequest: {
             body: string;
         };
@@ -7611,6 +7819,19 @@ export interface components {
             validUntil: null | string;
             attributes: null | string;
         };
+        ReviseServiceLocationRequest: {
+            name: string;
+            description: null | string;
+            address: null | string;
+            locality: null | string;
+            contactPhone: null | string;
+            contactEmail: null | string;
+            openingHours: null | string;
+            /** Format: double */
+            latitude: null | number | string;
+            /** Format: double */
+            longitude: null | number | string;
+        };
         ReviseTemplateVersionBodyRequest: {
             body: null | components["schemas"]["JsonElement"];
             /** Format: int32 */
@@ -7642,6 +7863,38 @@ export interface components {
             email: null | string;
             phone: null | string;
         };
+        ServiceLocationResponse: {
+            /** Format: uuid */
+            id: string;
+            category: string;
+            status: string;
+            isVisibleToCustomers: boolean;
+            name: string;
+            description: null | string;
+            address: null | string;
+            locality: null | string;
+            contactPhone: null | string;
+            contactEmail: null | string;
+            openingHours: null | string;
+            /** Format: double */
+            latitude: null | number | string;
+            /** Format: double */
+            longitude: null | number | string;
+            verifiedBySubjectId: null | string;
+            /** Format: date-time */
+            verifiedAtUtc: null | string;
+            verificationAssurance: null | string;
+            /** Format: date-time */
+            publishedAtUtc: null | string;
+            /** Format: date-time */
+            createdAtUtc: string;
+            /** Format: date-time */
+            updatedAtUtc: string;
+        };
+        SetAcceptanceApprovalLimitRequest: {
+            /** Format: double */
+            maximumAmount: null | number | string;
+        };
         SetEmergencyContactRequest: {
             providerName: null | string;
             contactDetail: null | string;
@@ -7911,6 +8164,9 @@ export interface components {
             name: null | string;
             description: null | string;
         };
+        VerifyServiceLocationRequest: {
+            assurance: null | string;
+        };
         WebsiteLeadReceipt: {
             /** Format: uuid */
             leadId: string;
@@ -16120,39 +16376,31 @@ export interface operations {
             };
         };
     };
-    OpenPolicy: {
+    ListServiceLocations: {
         parameters: {
-            query?: never;
+            query?: {
+                category?: string;
+                status?: string;
+                search?: string;
+                limit?: number | string;
+            };
             header?: never;
             path?: never;
             cookie?: never;
         };
-        requestBody: {
-            content: {
-                "application/json": components["schemas"]["OpenPolicyRequest"];
-            };
-        };
+        requestBody?: never;
         responses: {
-            /** @description Created */
-            201: {
+            /** @description OK */
+            200: {
                 headers: {
                     [name: string]: unknown;
                 };
                 content: {
-                    "application/json": components["schemas"]["PolicyResponse"];
+                    "application/json": components["schemas"]["ServiceLocationResponse"][];
                 };
             };
             /** @description Bad Request */
             400: {
-                headers: {
-                    [name: string]: unknown;
-                };
-                content: {
-                    "application/problem+json": components["schemas"]["HttpValidationProblemDetails"];
-                };
-            };
-            /** @description Conflict */
-            409: {
                 headers: {
                     [name: string]: unknown;
                 };
@@ -16160,18 +16408,16 @@ export interface operations {
                     "application/problem+json": components["schemas"]["ProblemDetails"];
                 };
             };
-            /** @description Unprocessable Entity */
-            422: {
+            /** @description Forbidden */
+            403: {
                 headers: {
                     [name: string]: unknown;
                 };
-                content: {
-                    "application/problem+json": components["schemas"]["ProblemDetails"];
-                };
+                content?: never;
             };
         };
     };
-    ImportPolicy: {
+    RecordServiceLocation: {
         parameters: {
             query?: never;
             header?: never;
@@ -16180,7 +16426,7 @@ export interface operations {
         };
         requestBody: {
             content: {
-                "application/json": components["schemas"]["ImportPolicyRequest"];
+                "application/json": components["schemas"]["RecordServiceLocationRequest"];
             };
         };
         responses: {
@@ -16190,7 +16436,7 @@ export interface operations {
                     [name: string]: unknown;
                 };
                 content: {
-                    "application/json": components["schemas"]["PolicyResponse"];
+                    "application/json": components["schemas"]["ServiceLocationResponse"];
                 };
             };
             /** @description Bad Request */
@@ -16199,21 +16445,19 @@ export interface operations {
                     [name: string]: unknown;
                 };
                 content: {
-                    "application/problem+json": components["schemas"]["HttpValidationProblemDetails"];
+                    "application/problem+json": components["schemas"]["ProblemDetails"];
                 };
             };
-            /** @description Conflict */
-            409: {
+            /** @description Forbidden */
+            403: {
                 headers: {
                     [name: string]: unknown;
                 };
-                content: {
-                    "application/problem+json": components["schemas"]["ProblemDetails"];
-                };
+                content?: never;
             };
         };
     };
-    ReferPolicyToInsurer: {
+    ReviseServiceLocation: {
         parameters: {
             query?: never;
             header?: never;
@@ -16222,7 +16466,11 @@ export interface operations {
             };
             cookie?: never;
         };
-        requestBody?: never;
+        requestBody: {
+            content: {
+                "application/json": components["schemas"]["ReviseServiceLocationRequest"];
+            };
+        };
         responses: {
             /** @description OK */
             200: {
@@ -16230,11 +16478,11 @@ export interface operations {
                     [name: string]: unknown;
                 };
                 content: {
-                    "application/json": components["schemas"]["PolicyResponse"];
+                    "application/json": components["schemas"]["ServiceLocationResponse"];
                 };
             };
-            /** @description Not Found */
-            404: {
+            /** @description Bad Request */
+            400: {
                 headers: {
                     [name: string]: unknown;
                 };
@@ -16242,6 +16490,20 @@ export interface operations {
                     "application/problem+json": components["schemas"]["ProblemDetails"];
                 };
             };
+            /** @description Forbidden */
+            403: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+            /** @description Not Found */
+            404: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
             /** @description Conflict */
             409: {
                 headers: {
@@ -16253,7 +16515,7 @@ export interface operations {
             };
         };
     };
-    RecordInsurerConfirmation: {
+    VerifyServiceLocation: {
         parameters: {
             query?: never;
             header?: never;
@@ -16264,7 +16526,7 @@ export interface operations {
         };
         requestBody: {
             content: {
-                "application/json": components["schemas"]["RecordInsurerConfirmationRequest"];
+                "application/json": components["schemas"]["VerifyServiceLocationRequest"];
             };
         };
         responses: {
@@ -16274,7 +16536,7 @@ export interface operations {
                     [name: string]: unknown;
                 };
                 content: {
-                    "application/json": components["schemas"]["PolicyResponse"];
+                    "application/json": components["schemas"]["ServiceLocationResponse"];
                 };
             };
             /** @description Bad Request */
@@ -16283,7 +16545,324 @@ export interface operations {
                     [name: string]: unknown;
                 };
                 content: {
-                    "application/problem+json": components["schemas"]["HttpValidationProblemDetails"];
+                    "application/problem+json": components["schemas"]["ProblemDetails"];
+                };
+            };
+            /** @description Forbidden */
+            403: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+            /** @description Not Found */
+            404: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+            /** @description Conflict */
+            409: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/problem+json": components["schemas"]["ProblemDetails"];
+                };
+            };
+        };
+    };
+    PublishServiceLocation: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                id: string;
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description OK */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["ServiceLocationResponse"];
+                };
+            };
+            /** @description Forbidden */
+            403: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+            /** @description Not Found */
+            404: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+            /** @description Conflict */
+            409: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/problem+json": components["schemas"]["ProblemDetails"];
+                };
+            };
+        };
+    };
+    UnpublishServiceLocation: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                id: string;
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description OK */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["ServiceLocationResponse"];
+                };
+            };
+            /** @description Forbidden */
+            403: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+            /** @description Not Found */
+            404: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+            /** @description Conflict */
+            409: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/problem+json": components["schemas"]["ProblemDetails"];
+                };
+            };
+        };
+    };
+    ReadOwnBrokersServiceLocations: {
+        parameters: {
+            query?: {
+                category?: string;
+                search?: string;
+                latitude?: number | string;
+                longitude?: number | string;
+                radiusKm?: number | 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"]["CustomerServiceLocationResponse"][];
+                };
+            };
+            /** @description Bad Request */
+            400: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/problem+json": components["schemas"]["ProblemDetails"];
+                };
+            };
+        };
+    };
+    OpenPolicy: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody: {
+            content: {
+                "application/json": components["schemas"]["OpenPolicyRequest"];
+            };
+        };
+        responses: {
+            /** @description Created */
+            201: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["PolicyResponse"];
+                };
+            };
+            /** @description Bad Request */
+            400: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/problem+json": components["schemas"]["HttpValidationProblemDetails"];
+                };
+            };
+            /** @description Conflict */
+            409: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/problem+json": components["schemas"]["ProblemDetails"];
+                };
+            };
+            /** @description Unprocessable Entity */
+            422: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/problem+json": components["schemas"]["ProblemDetails"];
+                };
+            };
+        };
+    };
+    ImportPolicy: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody: {
+            content: {
+                "application/json": components["schemas"]["ImportPolicyRequest"];
+            };
+        };
+        responses: {
+            /** @description Created */
+            201: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["PolicyResponse"];
+                };
+            };
+            /** @description Bad Request */
+            400: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/problem+json": components["schemas"]["HttpValidationProblemDetails"];
+                };
+            };
+            /** @description Conflict */
+            409: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/problem+json": components["schemas"]["ProblemDetails"];
+                };
+            };
+        };
+    };
+    ReferPolicyToInsurer: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                id: string;
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description OK */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["PolicyResponse"];
+                };
+            };
+            /** @description Not Found */
+            404: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/problem+json": components["schemas"]["ProblemDetails"];
+                };
+            };
+            /** @description Conflict */
+            409: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/problem+json": components["schemas"]["ProblemDetails"];
+                };
+            };
+        };
+    };
+    RecordInsurerConfirmation: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                id: string;
+            };
+            cookie?: never;
+        };
+        requestBody: {
+            content: {
+                "application/json": components["schemas"]["RecordInsurerConfirmationRequest"];
+            };
+        };
+        responses: {
+            /** @description OK */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["PolicyResponse"];
+                };
+            };
+            /** @description Bad Request */
+            400: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/problem+json": components["schemas"]["HttpValidationProblemDetails"];
                 };
             };
             /** @description Not Found */
@@ -19868,6 +20447,108 @@ export interface operations {
             };
         };
     };
+    ReadAcceptanceApprovalLimits: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description OK */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["AcceptanceApprovalLimitResponse"][];
+                };
+            };
+        };
+    };
+    SetAcceptanceApprovalLimit: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                role: string;
+                currency: string;
+            };
+            cookie?: never;
+        };
+        requestBody: {
+            content: {
+                "application/json": components["schemas"]["SetAcceptanceApprovalLimitRequest"];
+            };
+        };
+        responses: {
+            /** @description OK */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["AcceptanceApprovalLimitResponse"];
+                };
+            };
+            /** @description Bad Request */
+            400: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/problem+json": components["schemas"]["HttpValidationProblemDetails"];
+                };
+            };
+            /** @description Conflict */
+            409: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/problem+json": components["schemas"]["ProblemDetails"];
+                };
+            };
+        };
+    };
+    ClearAcceptanceApprovalLimit: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                role: string;
+                currency: string;
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description No Content */
+            204: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+            /** @description Bad Request */
+            400: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/problem+json": components["schemas"]["HttpValidationProblemDetails"];
+                };
+            };
+            /** @description Not Found */
+            404: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+        };
+    };
     ReadRetentionSchedule: {
         parameters: {
             query?: never;

package/package.json

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