@insurance-broker/api-client 5.51.0 → 5.53.0

package/dist/schema.d.ts

@@ -3939,7 +3939,12 @@ export interface paths {
         };
         get?: never;
         put?: never;
-        /** Records where one of this broker's people works and which desk they sit on. */
+        /**
+         * Records where one of this broker's people works and which desk they sit on.
+         * @description A caller may place only a member every one of whose permission keys the caller holds, and may not place themselves.
+         *
+         *     **Refusals.** `400`: no branch or team of this broker has that identifier (`GET /api/v1/branches` and `GET /api/v1/teams` list them). `403` `urn:brokerplatform:problem:permissions-beyond-caller`: the member holds a permission the caller does not; a `403` with no body means the caller does not hold `identity.members.manage`. `404` with no body: no member of this broker has that identifier. `409` `urn:brokerplatform:problem:member-self-administration`: the member is the caller (`isCaller` is true on them in `GET /api/v1/members`), and another administrator must place them. `409` `urn:brokerplatform:problem:member-revoked`: the member's access has been revoked. Problem details are written for the person using the screen and name no route.
+         */
         post: operations["PlaceMember"];
         delete?: never;
         options?: never;
@@ -3956,13 +3961,15 @@ export interface paths {
         };
         /**
          * This broker's memberships, with status, roles and placement, oldest first.
-         * @description Paged by an opaque cursor: pass `nextCursor` back as `cursor` until it is null. `limit` is 25 by default and at most 100; zero or less means the default. `status` narrows the list to `Invited`, `Active`, `Suspended` or `Revoked`. A revoked member whose name has been erased comes back as "Former member of staff". Names are personal data.
+         * @description Paged by an opaque cursor: pass `nextCursor` back as `cursor` until it is null. `limit` is 25 by default and at most 100; zero or less means the default. `status` narrows the list to `Invited`, `Active`, `Suspended` or `Revoked`. A revoked member whose name has been erased comes back as "Former member of staff". Names are personal data. Each role carries the permission keys it grants, so a client can tell which roles the caller may give or take, and `isCaller` marks the caller's own live membership, which the caller may not change, place or revoke.
          */
         get: operations["ListMembers"];
         put?: never;
         /**
          * Gives a person with a staff account access to this broker, holding the named roles.
-         * @description The subject must name an account that already exists in the staff realm; this platform does not create staff accounts. The membership is active at once, as the platform's own grant is: there is no acceptance step. At least one role is required, and each must hold only permissions the caller holds. A person who already has a live membership of this broker is refused 409.
+         * @description The subject must name an account that already exists in the staff realm; this platform does not create staff accounts. The membership is active at once, as the platform's own grant is: there is no acceptance step. At least one role is required, and each must hold only permissions the caller holds.
+         *
+         *     **Refusals.** A role identifier this broker does not have is a `400` validation problem against `roleIds`; `GET /api/v1/roles` lists the roles it has. A role holding a permission the caller does not hold is `403` `urn:brokerplatform:problem:permissions-beyond-caller`; a `403` with no body means the caller does not hold `identity.members.manage`. A person who already has a live membership of this broker is `409` `urn:brokerplatform:problem:already-a-member`: change what they hold with `PUT` or `DELETE /api/v1/members/{membershipId}/roles/{roleId}` instead. Problem details are written for the person using the screen and name no route.
          */
         post: operations["InviteMember"];
         delete?: never;
@@ -3983,6 +3990,8 @@ export interface paths {
         /**
          * Withdraws a member of staff's access to this broker permanently. Terminal.
          * @description Every request from that person to this broker that starts after the revocation commits is refused; one already past authorization completes. Their identity-provider account is not changed. Revoking a membership that is already revoked answers it as it stands and changes nothing. A caller may not revoke their own membership. A revoked membership cannot be restored.
+         *
+         *     **Typed refusals.** `403` `urn:brokerplatform:problem:permissions-beyond-caller`: the member holds a permission the caller does not; a `403` with no body means the caller does not hold `identity.members.manage`. `409` `urn:brokerplatform:problem:member-self-administration`: the member is the caller (`isCaller` is true on them in `GET /api/v1/members`), and another administrator must do it.
          */
         post: operations["RevokeMembership"];
         delete?: never;
@@ -4002,12 +4011,16 @@ export interface paths {
         /**
          * Gives a member of staff one of this broker's roles. Idempotent.
          * @description The member can do what the role grants from their next request onward. The role must hold only permissions the caller holds. A caller may not change their own roles, and a revoked membership's roles are not changed. Assigning a role the member already holds answers the member as they stand and writes nothing.
+         *
+         *     **Refusals, each with its own `type`.** `404` `urn:brokerplatform:problem:member-not-found`: no member of this broker has that identifier (`GET /api/v1/members` lists them). `404` `urn:brokerplatform:problem:role-not-found`: no role of this broker has that identifier (`GET /api/v1/roles` lists them). `403` `urn:brokerplatform:problem:permissions-beyond-caller`: the role holds a permission the caller does not; a `403` with no body means the caller does not hold `identity.members.manage`. `409` `urn:brokerplatform:problem:member-self-administration`: the member is the caller (`isCaller` is true on them), and another administrator must make the change. `409` `urn:brokerplatform:problem:member-revoked`: the member's access has been revoked, so their roles are a record. Problem details are written for the person using the screen and name no route.
          */
         put: operations["AssignMemberRole"];
         post?: never;
         /**
          * Takes one of this broker's roles away from a member of staff. Idempotent.
          * @description The member can no longer do what only that role granted from their next request onward. The role must hold only permissions the caller holds: a caller may not take away what they could not have given. A caller may not change their own roles, and a revoked membership's roles are not changed. Removing a role the member does not hold answers the member as they stand and writes nothing.
+         *
+         *     **Refusals, each with its own `type`.** `404` `urn:brokerplatform:problem:member-not-found`: no member of this broker has that identifier (`GET /api/v1/members` lists them). `404` `urn:brokerplatform:problem:role-not-found`: no role of this broker has that identifier (`GET /api/v1/roles` lists them). `403` `urn:brokerplatform:problem:permissions-beyond-caller`: the role holds a permission the caller does not; a `403` with no body means the caller does not hold `identity.members.manage`. `409` `urn:brokerplatform:problem:member-self-administration`: the member is the caller (`isCaller` is true on them), and another administrator must make the change. `409` `urn:brokerplatform:problem:member-revoked`: the member's access has been revoked, so their roles are a record. Problem details are written for the person using the screen and name no route.
          */
         delete: operations["RemoveMemberRole"];
         options?: never;
@@ -4591,6 +4604,46 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
+    "/api/v1/service-locations/search": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * This broker's service locations, a page at a time, drafts included.
+         * @description The maintenance view, paged: the same rows, filters and order (name, then identifier) as `GET /service-locations`, answered as `{ items, nextCursor }` so a directory of any size can be listed completely. Pass `nextCursor` back as `cursor`; a null one means this is the last page. A cursor names a position in the list, not the filters that produced it: start a new walk, without a cursor, when a filter changes. A cursor this list did not issue is a 400 on `cursor`. The bare list is unchanged, for the clients that already read it.
+         */
+        get: operations["SearchServiceLocations"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/api/v1/service-locations/{id}": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * One of this broker's service locations, whatever its state.
+         * @description Another broker's location answers 404, exactly as one that does not exist. There is no delete: a location is taken out of use by withdrawing it (`POST .../withdrawal`), and a wrong draft is corrected rather than removed, because the audit trail and the attestation name the row (ADR-0048, amendment of 2026-10-28).
+         */
+        get: operations["GetServiceLocation"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     "/api/v1/service-locations/{id}/description": {
         parameters: {
             query?: never;
@@ -9007,12 +9060,14 @@ export interface components {
             branchId: null | string;
             /** Format: uuid */
             teamId: null | string;
+            isCaller: boolean;
         };
         MemberRoleResponse: {
             /** Format: uuid */
             roleId: string;
             key: string;
             name: string;
+            permissionKeys: string[];
         };
         MissingTemplateValueResponse: {
             key: string;
@@ -10471,11 +10526,18 @@ export interface components {
         };
         /** @enum {string} */
         ScanVerdict: "Quarantined" | "Clean" | "Infected" | "Unscannable";
+        /** @enum {string} */
+        ServiceLocationCategory: "BrokerBranch" | "InsurerOffice" | "ApprovedRepairer" | "Hospital" | "Assessor";
+        ServiceLocationPage: {
+            items: components["schemas"]["ServiceLocationResponse"][];
+            nextCursor: null | string;
+        };
         ServiceLocationResponse: {
             /** Format: uuid */
             id: string;
-            category: string;
-            status: string;
+            category: components["schemas"]["ServiceLocationCategory"];
+            categoryLabel: string;
+            status: components["schemas"]["ServiceLocationStatus"];
             isVisibleToCustomers: boolean;
             name: string;
             description: null | string;
@@ -10499,6 +10561,8 @@ export interface components {
             /** Format: date-time */
             updatedAtUtc: string;
         };
+        /** @enum {string} */
+        ServiceLocationStatus: "Draft" | "Verified" | "Published";
         SetAcceptanceApprovalLimitRequest: {
             /** Format: double */
             maximumAmount: null | number | string;
@@ -22034,6 +22098,84 @@ export interface operations {
             };
         };
     };
+    SearchServiceLocations: {
+        parameters: {
+            query?: {
+                category?: string;
+                status?: string;
+                search?: string;
+                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"]["ServiceLocationPage"];
+                };
+            };
+            /** @description Bad Request */
+            400: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/problem+json": components["schemas"]["ProblemDetails"];
+                };
+            };
+            /** @description Forbidden */
+            403: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+        };
+    };
+    GetServiceLocation: {
+        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;
+            };
+        };
+    };
     ReviseServiceLocation: {
         parameters: {
             query?: never;

package/package.json

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