@insurance-broker/api-client 1.42.0 → 1.43.0

package/dist/schema.d.ts

@@ -3186,6 +3186,132 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
+    "/api/v1/platform/plans": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * Every plan in the catalogue and what each one grants.
+         * @description TEN-005. Retired plans included: a plan withdrawn from sale still has brokers on it, and the question this list answers is usually "what is that broker actually on?"
+         *
+         *     **A feature absent from a plan is not the same as one granted `false`.** An absent feature falls through to the feature's own default; a granted `false` is the plan saying no. Both appear here as they are.
+         */
+        get: operations["ListPlans"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/api/v1/platform/plans/{planCode}/features": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        /**
+         * Make a plan carry a feature, or change what it grants.
+         * @description TEN-005, and the repair path issue #281 was opened for. Creates the `platform_tenancy_plan_features` row that seeding cannot create on a database whose plan predates the feature key.
+         *
+         *     **One route for both granting and repricing**, because the caller cannot know which it is without a read it would then race. `201` says the plan did not carry the feature before; `200` says the value moved. The audit entry records which, and from what.
+         *
+         *     **Nothing here defines a feature.** A key that is not already in the catalogue is refused: which features exist is configuration, and a surface that could mint one would create keys no gate reads.
+         *
+         *     **Every broker on this plan is affected**, including ones nobody named. This is the route on the platform with the widest blast radius per request, which is why it has a permission of its own rather than sharing tenant provisioning's.
+         */
+        post: operations["GrantPlanFeature"];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/api/v1/platform/plans/{planCode}/features/{featureKey}/withdrawal": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        /**
+         * Stop a plan carrying a feature.
+         * @description Removes the grant, so brokers on this plan fall back to the feature's own default.
+         *
+         *     **This is not the same as granting `false`**, and choosing the wrong one is how a withdrawal silently grants. If the feature's default is `true` — which is how a capability that shipped before its gate is kept working on existing deployments — removing the row leaves every broker on this plan entitled. Grant `false` to mean "this plan does not include it".
+         *
+         *     A plan that does not carry the feature answers `404`: there was nothing to withdraw, and reporting success would tell an operator a decision was taken that was not.
+         */
+        post: operations["WithdrawPlanFeature"];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/api/v1/platform/tenants/{tenantKey}/entitlements": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * What one broker is on, and every override it carries.
+         * @description TEN-005. The plan the broker is currently on, and the overrides that take precedence over it.
+         *
+         *     **Expired overrides are listed too**, marked `isEffective: false`. "Why did this broker lose a feature overnight?" is answerable only if the row that stopped applying is still visible.
+         */
+        get: operations["ListTenantEntitlements"];
+        put?: never;
+        /**
+         * Give one broker terms its plan does not express.
+         * @description TEN-005. Takes precedence over the broker's plan for this one feature, and over nothing else.
+         *
+         *     **`false` is a deliberate denial**, and a different state from having no override: it refuses the feature whatever the plan grants. Withdrawing the override is how a broker goes back to what its plan says.
+         *
+         *     **An expiry must be in the future.** An override that had already expired would look like something was granted when nothing was.
+         *
+         *     `201` says the override is new; `200` says an existing one was restated. The whole row is restated rather than patched, because a value, a reason and an expiry only make sense together — a patched value under an old reason describes a decision that has since changed.
+         */
+        post: operations["OverrideTenantEntitlement"];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/api/v1/platform/tenants/{tenantKey}/entitlements/{featureKey}/withdrawal": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        /**
+         * Remove a broker's override so it falls back to its plan.
+         * @description The override is deleted rather than expired: an expiry says "stop applying later", and an operator withdrawing one means now. A broker with no override for a feature is answered by its plan, and by the feature's default if the plan is silent.
+         *
+         *     A broker with no override for that feature answers `404`.
+         */
+        post: operations["WithdrawTenantEntitlement"];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     "/api/v1/public/branding": {
         parameters: {
             query?: never;
@@ -5185,6 +5311,10 @@ export interface components {
         GenerateDocumentRequest: {
             format: null | string;
         };
+        GrantPlanFeatureRequest: {
+            featureKey: null | string;
+            value: null | string;
+        };
         GrantPlatformAdministratorRequest: {
             subjectId: null | string;
             displayName: null | string;
@@ -5612,6 +5742,13 @@ export interface components {
             /** Format: date-time */
             updatedAtUtc: string;
         };
+        OverrideEntitlementRequest: {
+            featureKey: null | string;
+            value: null | string;
+            reason: null | string;
+            /** Format: date-time */
+            expiresAtUtc: null | string;
+        };
         OwnCustomerAccountResponse: {
             /** Format: uuid */
             customerId: string;
@@ -5791,6 +5928,20 @@ export interface components {
             /** Format: date-time */
             updatedAtUtc: string;
         };
+        PlatformPlanFeatureResponse: {
+            featureKey: string;
+            value: string;
+            valueKind: string;
+        };
+        PlatformPlanResponse: {
+            code: string;
+            name: string;
+            description: null | string;
+            isPubliclyAvailable: boolean;
+            /** Format: int32 */
+            sortOrder: number | string;
+            features: components["schemas"]["PlatformPlanFeatureResponse"][];
+        };
         PolicyDocumentResponse: {
             /** Format: uuid */
             id: string;
@@ -6647,6 +6798,19 @@ export interface components {
             supportPhone: null | string;
             websiteUrl: null | string;
         };
+        TenantEntitlementResponse: {
+            featureKey: string;
+            value: string;
+            reason: null | string;
+            /** Format: date-time */
+            expiresAtUtc: null | string;
+            isEffective: boolean;
+        };
+        TenantEntitlementsResponse: {
+            tenantKey: string;
+            planCode: null | string;
+            entitlements: components["schemas"]["TenantEntitlementResponse"][];
+        };
         TenantProfileResponse: {
             regulatorName: null | string;
             licenceNumber: null | string;
@@ -14426,6 +14590,255 @@ export interface operations {
             };
         };
     };
+    ListPlans: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description OK */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["PlatformPlanResponse"][];
+                };
+            };
+            /** @description Forbidden */
+            403: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+        };
+    };
+    GrantPlanFeature: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                planCode: string;
+            };
+            cookie?: never;
+        };
+        requestBody: {
+            content: {
+                "application/json": components["schemas"]["GrantPlanFeatureRequest"];
+            };
+        };
+        responses: {
+            /** @description OK */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["PlatformPlanFeatureResponse"];
+                };
+            };
+            /** @description Created */
+            201: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["PlatformPlanFeatureResponse"];
+                };
+            };
+            /** @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;
+            };
+        };
+    };
+    WithdrawPlanFeature: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                planCode: string;
+                featureKey: string;
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description No Content */
+            204: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+            /** @description Forbidden */
+            403: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+            /** @description Not Found */
+            404: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+        };
+    };
+    ListTenantEntitlements: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                tenantKey: string;
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description OK */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["TenantEntitlementsResponse"];
+                };
+            };
+            /** @description Forbidden */
+            403: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+            /** @description Not Found */
+            404: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+        };
+    };
+    OverrideTenantEntitlement: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                tenantKey: string;
+            };
+            cookie?: never;
+        };
+        requestBody: {
+            content: {
+                "application/json": components["schemas"]["OverrideEntitlementRequest"];
+            };
+        };
+        responses: {
+            /** @description OK */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["TenantEntitlementResponse"];
+                };
+            };
+            /** @description Created */
+            201: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["TenantEntitlementResponse"];
+                };
+            };
+            /** @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;
+            };
+        };
+    };
+    WithdrawTenantEntitlement: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                tenantKey: string;
+                featureKey: string;
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description No Content */
+            204: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+            /** @description Forbidden */
+            403: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+            /** @description Not Found */
+            404: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+        };
+    };
     GetPublicBranding: {
         parameters: {
             query?: never;

package/package.json

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