@insurance-broker/api-client 5.52.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;
@@ -9047,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;

package/package.json

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