@insurance-broker/api-client 5.12.0 → 5.14.0

package/dist/schema.d.ts

@@ -3555,6 +3555,26 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
+    "/api/v1/members/{membershipId}/revocation": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        /**
+         * 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.
+         */
+        post: operations["RevokeMembership"];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     "/api/v1/staff": {
         parameters: {
             query?: never;
@@ -4034,6 +4054,34 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
+    "/api/v1/me/capabilities": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * What the signed-in caller may do here, and what their broker's plan includes.
+         * @description Clients read this once per session to hide controls the caller lacks. **It grants nothing**: every route still enforces its own permission and entitlement, so a stale answer costs a refusal, never an action.
+         *
+         *     `permissions` are the keys the caller holds in the scope they are in, spelled as each route requires them. `features` are the on/off plan features switched on for the caller's broker, spelled as the `feature` extension of a `urn:brokerplatform:problem:feature-not-entitled` refusal names them; numeric allowances are never listed. Both arrays are sorted ordinally.
+         *
+         *     Any authenticated caller may read their own: staff, customers and platform administrators. A platform administrator in the platform console receives their platform permissions and no features, because that console belongs to no broker. An authenticated customer not yet attached to a broker receives two empty arrays, and so does any caller who holds no permission where they are: `features` is never answered without at least one permission.
+         *
+         *     A customer acting for an organisation (the `X-Broker-Acting-For` header) receives the union of their customer keys and the keys their organisation role grants. The answer describes the acting context of *this* request, so clients re-read it after switching between acting personally and acting for an organisation.
+         *
+         *     Answered `Cache-Control: no-store`.
+         */
+        get: operations["GetMyCapabilities"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     "/api/v1/service-locations": {
         parameters: {
             query?: never;
@@ -6352,6 +6400,10 @@ export interface components {
             /** Format: date-time */
             updatedAtUtc: string;
         };
+        CallerCapabilitiesResponse: {
+            permissions: string[];
+            features: string[];
+        };
         CaptureLeadRequest: {
             contactName: null | string;
             email: null | string;
@@ -9288,6 +9340,17 @@ export interface components {
             /** Format: int32 */
             bodySchemaVersion: null | number | string;
         };
+        RevokedMembershipResponse: {
+            /** Format: uuid */
+            membershipId: string;
+            subjectId: string;
+            reason: null | string;
+            /** Format: date-time */
+            revokedAtUtc: null | string;
+        };
+        RevokeMembershipRequest: {
+            reason: null | string;
+        };
         RoleResponse: {
             /** Format: uuid */
             id: string;
@@ -18125,6 +18188,64 @@ export interface operations {
             };
         };
     };
+    RevokeMembership: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                membershipId: string;
+            };
+            cookie?: never;
+        };
+        requestBody: {
+            content: {
+                "application/json": components["schemas"]["RevokeMembershipRequest"];
+            };
+        };
+        responses: {
+            /** @description OK */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["RevokedMembershipResponse"];
+                };
+            };
+            /** @description Bad Request */
+            400: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "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. 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"];
+                };
+            };
+        };
+    };
     ResolveStaffNames: {
         parameters: {
             query?: {
@@ -19356,6 +19477,33 @@ export interface operations {
             };
         };
     };
+    GetMyCapabilities: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description OK */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["CallerCapabilitiesResponse"];
+                };
+            };
+            /** @description Unauthorized */
+            401: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+        };
+    };
     ListServiceLocations: {
         parameters: {
             query?: {

package/package.json

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