mudbase-sdk 1.2.9 → 1.2.12

package/docs/MultiRoleApi.md

@@ -6,6 +6,16 @@ All URIs are relative to *https://cloud.mudbase.dev*
 |------------- | ------------- | -------------|
 | [**authOauthSignupWithRole**](MultiRoleApi.md#authoauthsignupwithrole) | **GET** /api/auth/oauth/signup/{role}/{provider}/{projectId} | OAuth signup with specific role |
 | [**authRegisterWithRole**](MultiRoleApi.md#authregisterwithroleoperation) | **POST** /api/auth/local/signup/{role} | Register user with specific role (Local Auth) |
+| [**multiRoleAddRole**](MultiRoleApi.md#multiroleaddroleoperation) | **POST** /api/projects/{projectId}/multi-role/roles | Add custom role |
+| [**multiRoleApplyRoleFeaturePreset**](MultiRoleApi.md#multiroleapplyrolefeaturepresetoperation) | **POST** /api/projects/{projectId}/multi-role/roles/{roleSlug}/apply-preset | Apply Admin / User / Viewer feature permission preset |
+| [**multiRoleGetAvailableRoles**](MultiRoleApi.md#multirolegetavailableroles) | **GET** /api/projects/{projectId}/multi-role/roles/available | Get available roles for signup |
+| [**multiRoleGetConfig**](MultiRoleApi.md#multirolegetconfig) | **GET** /api/projects/{projectId}/multi-role | Get multi-role feature configuration |
+| [**multiRoleGetPermissionsMatrix**](MultiRoleApi.md#multirolegetpermissionsmatrix) | **GET** /api/projects/{projectId}/permissions-matrix | Get permissions matrix (collections + featurePermissions) |
+| [**multiRoleSimulateAppPermissions**](MultiRoleApi.md#multirolesimulateapppermissionsoperation) | **POST** /api/projects/{projectId}/multi-role/simulate-permissions | Simulate app-role feature permission for a path |
+| [**multiRoleToggleRole**](MultiRoleApi.md#multiroletoggleroleoperation) | **PATCH** /api/projects/{projectId}/multi-role/roles/{roleSlug}/toggle | Toggle role on/off |
+| [**multiRoleUpdateCollectionPermissions**](MultiRoleApi.md#multiroleupdatecollectionpermissionsoperation) | **PATCH** /api/projects/{projectId}/multi-role/roles/{roleSlug}/collections/{collectionId}/permissions | Update collection permissions for a role |
+| [**multiRoleUpdateRole**](MultiRoleApi.md#multiroleupdateroleoperation) | **PATCH** /api/projects/{projectId}/multi-role/roles/{roleSlug} | Update role configuration |
+| [**multiRoleUpdateSettings**](MultiRoleApi.md#multiroleupdatesettingsoperation) | **PATCH** /api/projects/{projectId}/multi-role/settings | Update multi-role feature settings |
 
 
 
@@ -164,3 +174,776 @@ No authorization required
 
 [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
 
+
+## multiRoleAddRole
+
+> MultiRoleToggleRole200Response multiRoleAddRole(projectId, multiRoleAddRoleRequest)
+
+Add custom role
+
+Add a custom role to a project with specific permissions and signup endpoint. Optional **featurePermissions** must align with app JWT gates — see schema `AppRoleFeaturePermissions`. Accepts BearerToken (JWT) or ApiKeyAuth (X-API-Key). 
+
+### Example
+
+```ts
+import {
+  Configuration,
+  MultiRoleApi,
+} from 'mudbase-sdk';
+import type { MultiRoleAddRoleOperationRequest } from 'mudbase-sdk';
+
+async function example() {
+  console.log("🚀 Testing mudbase-sdk SDK...");
+  const config = new Configuration({ 
+    // Configure HTTP bearer authorization: BearerToken
+    accessToken: "YOUR BEARER TOKEN",
+  });
+  const api = new MultiRoleApi(config);
+
+  const body = {
+    // string | Project ID.
+    projectId: 685ad30be129932fbb7a1047,
+    // MultiRoleAddRoleRequest | Custom role definition. Use `collectionPermissions` to apply CRUD per collection slug (e.g. users/products/orders). `defaultPermissions` is optional for global/base permissions.
+    multiRoleAddRoleRequest: {"slug":"seller","name":"Seller","description":"Seller role with CRUD on seller-owned collections","signupEndpoint":"seller","requiresApproval":false,"requiresPayment":false,"requiresKYC":false,"metadata":{"notes":"Example role for API integration tests"},"defaultPermissions":[{"resource":"project","actions":["read"]},{"resource":"data","actions":["read","create"]}],"collectionPermissions":{"listings":["create","read","update","delete"],"orders":{"actions":["create","read"],"conditions":{"status":"active"}}},"featurePermissions":{"messaging":{"email":true,"sms":true,"push":true,"history":true,"stats":true},"integration":{"read":true,"create":true,"update":true,"delete":false,"execute":true,"test":true,"export":true,"read_usage":true},"functions":{"create":true,"read":true,"update":true,"delete":false,"execute":true,"simulate":true},"data":{"create":true,"read":true,"update":true,"delete":false},"search":{"query":true,"suggestions":true,"read_analytics":true},"usage":{"read":true},"storage":{"read":true,"create":true,"update":true,"delete":false,"upload":true},"chat":{"read":true,"create":true,"update":true,"delete":false},"realtime":{"read_analytics":true,"read_active_users":true,"presence":true,"read_throughput":true,"read_history":true},"roleElevation":{"request":true,"status":true,"documents":true},"webhooks":{"config_read":true,"config_update":true,"test_transformation":true}}},
+  } satisfies MultiRoleAddRoleOperationRequest;
+
+  try {
+    const data = await api.multiRoleAddRole(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **projectId** | `string` | Project ID. | [Defaults to `undefined`] |
+| **multiRoleAddRoleRequest** | [MultiRoleAddRoleRequest](MultiRoleAddRoleRequest.md) | Custom role definition. Use `collectionPermissions` to apply CRUD per collection slug (e.g. users/products/orders). `defaultPermissions` is optional for global/base permissions. | |
+
+### Return type
+
+[**MultiRoleToggleRole200Response**](MultiRoleToggleRole200Response.md)
+
+### Authorization
+
+[BearerToken](../README.md#BearerToken)
+
+### HTTP request headers
+
+- **Content-Type**: `application/json`
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **201** | Custom role added |  -  |
+| **400** | Bad request or validation error. The **error** field contains the exact backend message, e.g. \"Validation failed\", \"projectId is required\", \"No file provided\", \"Invalid project ID format\". **details** may contain validation errors when present.  |  -  |
+| **401** | Not authenticated. The **error** field contains the exact backend message, e.g. \"Invalid token.\", \"Access denied. No token provided.\", \"Authentication required\", \"Invalid API key\", \"API key expired\".  |  -  |
+| **403** | Access denied. The **error** field contains the exact backend message, e.g. \"Access denied\", \"Insufficient permissions\", \"You don\'t have permission to view this organization\'s projects\", \"Account suspended\".  |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## multiRoleApplyRoleFeaturePreset
+
+> multiRoleApplyRoleFeaturePreset(projectId, roleSlug, multiRoleApplyRoleFeaturePresetRequest)
+
+Apply Admin / User / Viewer feature permission preset
+
+Sets `featurePermissions` from preset `admin`, `user`, or `viewer`.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  MultiRoleApi,
+} from 'mudbase-sdk';
+import type { MultiRoleApplyRoleFeaturePresetOperationRequest } from 'mudbase-sdk';
+
+async function example() {
+  console.log("🚀 Testing mudbase-sdk SDK...");
+  const config = new Configuration({ 
+    // Configure HTTP bearer authorization: BearerToken
+    accessToken: "YOUR BEARER TOKEN",
+  });
+  const api = new MultiRoleApi(config);
+
+  const body = {
+    // string | Project ID.
+    projectId: projectId_example,
+    // string | Role slug to apply the preset to (e.g. `customer`).
+    roleSlug: roleSlug_example,
+    // MultiRoleApplyRoleFeaturePresetRequest | JSON body with `preset` set to `admin`, `user`, or `viewer`.
+    multiRoleApplyRoleFeaturePresetRequest: ...,
+  } satisfies MultiRoleApplyRoleFeaturePresetOperationRequest;
+
+  try {
+    const data = await api.multiRoleApplyRoleFeaturePreset(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **projectId** | `string` | Project ID. | [Defaults to `undefined`] |
+| **roleSlug** | `string` | Role slug to apply the preset to (e.g. `customer`). | [Defaults to `undefined`] |
+| **multiRoleApplyRoleFeaturePresetRequest** | [MultiRoleApplyRoleFeaturePresetRequest](MultiRoleApplyRoleFeaturePresetRequest.md) | JSON body with `preset` set to `admin`, `user`, or `viewer`. | |
+
+### Return type
+
+`void` (Empty response body)
+
+### Authorization
+
+[BearerToken](../README.md#BearerToken)
+
+### HTTP request headers
+
+- **Content-Type**: `application/json`
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Preset applied |  -  |
+| **400** | Bad request or validation error. The **error** field contains the exact backend message, e.g. \"Validation failed\", \"projectId is required\", \"No file provided\", \"Invalid project ID format\". **details** may contain validation errors when present.  |  -  |
+| **401** | Not authenticated. The **error** field contains the exact backend message, e.g. \"Invalid token.\", \"Access denied. No token provided.\", \"Authentication required\", \"Invalid API key\", \"API key expired\".  |  -  |
+| **403** | Access denied. The **error** field contains the exact backend message, e.g. \"Access denied\", \"Insufficient permissions\", \"You don\'t have permission to view this organization\'s projects\", \"Account suspended\".  |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## multiRoleGetAvailableRoles
+
+> MultiRoleGetAvailableRoles200Response multiRoleGetAvailableRoles(projectId)
+
+Get available roles for signup
+
+Get all available roles for user signup in a project. Accepts BearerToken (JWT) or ApiKeyAuth (X-API-Key). 
+
+### Example
+
+```ts
+import {
+  Configuration,
+  MultiRoleApi,
+} from 'mudbase-sdk';
+import type { MultiRoleGetAvailableRolesRequest } from 'mudbase-sdk';
+
+async function example() {
+  console.log("🚀 Testing mudbase-sdk SDK...");
+  const config = new Configuration({ 
+    // Configure HTTP bearer authorization: BearerToken
+    accessToken: "YOUR BEARER TOKEN",
+  });
+  const api = new MultiRoleApi(config);
+
+  const body = {
+    // string | Project ID.
+    projectId: 685ad30be129932fbb7a1047,
+  } satisfies MultiRoleGetAvailableRolesRequest;
+
+  try {
+    const data = await api.multiRoleGetAvailableRoles(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **projectId** | `string` | Project ID. | [Defaults to `undefined`] |
+
+### Return type
+
+[**MultiRoleGetAvailableRoles200Response**](MultiRoleGetAvailableRoles200Response.md)
+
+### Authorization
+
+[BearerToken](../README.md#BearerToken)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | List of available roles |  -  |
+| **401** | Not authenticated. The **error** field contains the exact backend message, e.g. \"Invalid token.\", \"Access denied. No token provided.\", \"Authentication required\", \"Invalid API key\", \"API key expired\".  |  -  |
+| **403** | Access denied. The **error** field contains the exact backend message, e.g. \"Access denied\", \"Insufficient permissions\", \"You don\'t have permission to view this organization\'s projects\", \"Account suspended\".  |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## multiRoleGetConfig
+
+> MultiRoleGetConfig200Response multiRoleGetConfig(projectId)
+
+Get multi-role feature configuration
+
+Returns project app roles (default one editable `customer` starter until you add more) and settings.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  MultiRoleApi,
+} from 'mudbase-sdk';
+import type { MultiRoleGetConfigRequest } from 'mudbase-sdk';
+
+async function example() {
+  console.log("🚀 Testing mudbase-sdk SDK...");
+  const config = new Configuration({ 
+    // Configure HTTP bearer authorization: BearerToken
+    accessToken: "YOUR BEARER TOKEN",
+  });
+  const api = new MultiRoleApi(config);
+
+  const body = {
+    // string | Project ID.
+    projectId: 685ad30be129932fbb7a1047,
+  } satisfies MultiRoleGetConfigRequest;
+
+  try {
+    const data = await api.multiRoleGetConfig(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **projectId** | `string` | Project ID. | [Defaults to `undefined`] |
+
+### Return type
+
+[**MultiRoleGetConfig200Response**](MultiRoleGetConfig200Response.md)
+
+### Authorization
+
+[BearerToken](../README.md#BearerToken)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Multi-role configuration |  -  |
+| **401** | Not authenticated. The **error** field contains the exact backend message, e.g. \"Invalid token.\", \"Access denied. No token provided.\", \"Authentication required\", \"Invalid API key\", \"API key expired\".  |  -  |
+| **403** | Access denied. The **error** field contains the exact backend message, e.g. \"Access denied\", \"Insufficient permissions\", \"You don\'t have permission to view this organization\'s projects\", \"Account suspended\".  |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## multiRoleGetPermissionsMatrix
+
+> MultiRoleGetPermissionsMatrix200Response multiRoleGetPermissionsMatrix(projectId)
+
+Get permissions matrix (collections + featurePermissions)
+
+Per-collection role actions and per-role `featurePermissions` for app-role gates.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  MultiRoleApi,
+} from 'mudbase-sdk';
+import type { MultiRoleGetPermissionsMatrixRequest } from 'mudbase-sdk';
+
+async function example() {
+  console.log("🚀 Testing mudbase-sdk SDK...");
+  const config = new Configuration({ 
+    // Configure HTTP bearer authorization: BearerToken
+    accessToken: "YOUR BEARER TOKEN",
+  });
+  const api = new MultiRoleApi(config);
+
+  const body = {
+    // string | Project ID whose multi-role matrix is returned.
+    projectId: 685ad30be129932fbb7a1047,
+  } satisfies MultiRoleGetPermissionsMatrixRequest;
+
+  try {
+    const data = await api.multiRoleGetPermissionsMatrix(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **projectId** | `string` | Project ID whose multi-role matrix is returned. | [Defaults to `undefined`] |
+
+### Return type
+
+[**MultiRoleGetPermissionsMatrix200Response**](MultiRoleGetPermissionsMatrix200Response.md)
+
+### Authorization
+
+[BearerToken](../README.md#BearerToken)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Matrix payload |  -  |
+| **401** | Not authenticated. The **error** field contains the exact backend message, e.g. \"Invalid token.\", \"Access denied. No token provided.\", \"Authentication required\", \"Invalid API key\", \"API key expired\".  |  -  |
+| **403** | Access denied. The **error** field contains the exact backend message, e.g. \"Access denied\", \"Insufficient permissions\", \"You don\'t have permission to view this organization\'s projects\", \"Account suspended\".  |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## multiRoleSimulateAppPermissions
+
+> object multiRoleSimulateAppPermissions(projectId, multiRoleSimulateAppPermissionsRequest)
+
+Simulate app-role feature permission for a path
+
+Given role slug and either `operationId` or HTTP method + pathname, returns whether `featurePermissions` would allow gated routes. Unmapped paths or unknown operation IDs return allowed with `no_feature_gate_for_path` or `no_feature_gate_for_operation_id`.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  MultiRoleApi,
+} from 'mudbase-sdk';
+import type { MultiRoleSimulateAppPermissionsOperationRequest } from 'mudbase-sdk';
+
+async function example() {
+  console.log("🚀 Testing mudbase-sdk SDK...");
+  const config = new Configuration({ 
+    // Configure HTTP bearer authorization: BearerToken
+    accessToken: "YOUR BEARER TOKEN",
+  });
+  const api = new MultiRoleApi(config);
+
+  const body = {
+    // string | Project ID used to resolve role configuration.
+    projectId: projectId_example,
+    // MultiRoleSimulateAppPermissionsRequest | Role slug plus either OpenAPI `operationId` or HTTP `method` and `pathname` to evaluate.
+    multiRoleSimulateAppPermissionsRequest: {"role":"customer","method":"POST","pathname":"/api/messaging/projects/685ad30be129932fbb7a1047/messaging/email"},
+  } satisfies MultiRoleSimulateAppPermissionsOperationRequest;
+
+  try {
+    const data = await api.multiRoleSimulateAppPermissions(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **projectId** | `string` | Project ID used to resolve role configuration. | [Defaults to `undefined`] |
+| **multiRoleSimulateAppPermissionsRequest** | [MultiRoleSimulateAppPermissionsRequest](MultiRoleSimulateAppPermissionsRequest.md) | Role slug plus either OpenAPI `operationId` or HTTP `method` and `pathname` to evaluate. | |
+
+### Return type
+
+**object**
+
+### Authorization
+
+[BearerToken](../README.md#BearerToken)
+
+### HTTP request headers
+
+- **Content-Type**: `application/json`
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Simulation result |  -  |
+| **400** | Bad request or validation error. The **error** field contains the exact backend message, e.g. \"Validation failed\", \"projectId is required\", \"No file provided\", \"Invalid project ID format\". **details** may contain validation errors when present.  |  -  |
+| **401** | Not authenticated. The **error** field contains the exact backend message, e.g. \"Invalid token.\", \"Access denied. No token provided.\", \"Authentication required\", \"Invalid API key\", \"API key expired\".  |  -  |
+| **403** | Access denied. The **error** field contains the exact backend message, e.g. \"Access denied\", \"Insufficient permissions\", \"You don\'t have permission to view this organization\'s projects\", \"Account suspended\".  |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## multiRoleToggleRole
+
+> MultiRoleToggleRole200Response multiRoleToggleRole(projectId, roleSlug, multiRoleToggleRoleRequest)
+
+Toggle role on/off
+
+Enable or disable a role for the project. When disabled, the role is no longer available for signup or assignment.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  MultiRoleApi,
+} from 'mudbase-sdk';
+import type { MultiRoleToggleRoleOperationRequest } from 'mudbase-sdk';
+
+async function example() {
+  console.log("🚀 Testing mudbase-sdk SDK...");
+  const config = new Configuration({ 
+    // Configure HTTP bearer authorization: BearerToken
+    accessToken: "YOUR BEARER TOKEN",
+  });
+  const api = new MultiRoleApi(config);
+
+  const body = {
+    // string | Project ID.
+    projectId: 685ad30be129932fbb7a1047,
+    // string | Role slug to toggle (e.g. starter `customer` or a role you added).
+    roleSlug: customer,
+    // MultiRoleToggleRoleRequest | Whether the role is enabled (true) or disabled (false).
+    multiRoleToggleRoleRequest: {"isEnabled":true},
+  } satisfies MultiRoleToggleRoleOperationRequest;
+
+  try {
+    const data = await api.multiRoleToggleRole(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **projectId** | `string` | Project ID. | [Defaults to `undefined`] |
+| **roleSlug** | `string` | Role slug to toggle (e.g. starter `customer` or a role you added). | [Defaults to `undefined`] |
+| **multiRoleToggleRoleRequest** | [MultiRoleToggleRoleRequest](MultiRoleToggleRoleRequest.md) | Whether the role is enabled (true) or disabled (false). | |
+
+### Return type
+
+[**MultiRoleToggleRole200Response**](MultiRoleToggleRole200Response.md)
+
+### Authorization
+
+[BearerToken](../README.md#BearerToken)
+
+### HTTP request headers
+
+- **Content-Type**: `application/json`
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Role toggled |  -  |
+| **400** | Bad request or validation error. The **error** field contains the exact backend message, e.g. \"Validation failed\", \"projectId is required\", \"No file provided\", \"Invalid project ID format\". **details** may contain validation errors when present.  |  -  |
+| **401** | Not authenticated. The **error** field contains the exact backend message, e.g. \"Invalid token.\", \"Access denied. No token provided.\", \"Authentication required\", \"Invalid API key\", \"API key expired\".  |  -  |
+| **403** | Access denied. The **error** field contains the exact backend message, e.g. \"Access denied\", \"Insufficient permissions\", \"You don\'t have permission to view this organization\'s projects\", \"Account suspended\".  |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## multiRoleUpdateCollectionPermissions
+
+> MultiRoleToggleRole200Response multiRoleUpdateCollectionPermissions(projectId, roleSlug, collectionId, multiRoleUpdateCollectionPermissionsRequest)
+
+Update collection permissions for a role
+
+Update collection-specific permissions for a role in a project. Accepts BearerToken (JWT) or ApiKeyAuth (X-API-Key). 
+
+### Example
+
+```ts
+import {
+  Configuration,
+  MultiRoleApi,
+} from 'mudbase-sdk';
+import type { MultiRoleUpdateCollectionPermissionsOperationRequest } from 'mudbase-sdk';
+
+async function example() {
+  console.log("🚀 Testing mudbase-sdk SDK...");
+  const config = new Configuration({ 
+    // Configure HTTP bearer authorization: BearerToken
+    accessToken: "YOUR BEARER TOKEN",
+  });
+  const api = new MultiRoleApi(config);
+
+  const body = {
+    // string | Project ID.
+    projectId: 685ad30be129932fbb7a1047,
+    // string | Role slug (e.g. starter `customer` or a role you added).
+    roleSlug: customer,
+    // string | Collection ID to set permissions for.
+    collectionId: 696ba6e4f4a9422ac4be4f74,
+    // MultiRoleUpdateCollectionPermissionsRequest | Allowed actions and optional conditions for the role on this collection.
+    multiRoleUpdateCollectionPermissionsRequest: {"actions":["create","read","update","delete"],"conditions":{"status":"active"}},
+  } satisfies MultiRoleUpdateCollectionPermissionsOperationRequest;
+
+  try {
+    const data = await api.multiRoleUpdateCollectionPermissions(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **projectId** | `string` | Project ID. | [Defaults to `undefined`] |
+| **roleSlug** | `string` | Role slug (e.g. starter `customer` or a role you added). | [Defaults to `undefined`] |
+| **collectionId** | `string` | Collection ID to set permissions for. | [Defaults to `undefined`] |
+| **multiRoleUpdateCollectionPermissionsRequest** | [MultiRoleUpdateCollectionPermissionsRequest](MultiRoleUpdateCollectionPermissionsRequest.md) | Allowed actions and optional conditions for the role on this collection. | |
+
+### Return type
+
+[**MultiRoleToggleRole200Response**](MultiRoleToggleRole200Response.md)
+
+### Authorization
+
+[BearerToken](../README.md#BearerToken)
+
+### HTTP request headers
+
+- **Content-Type**: `application/json`
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Collection permissions updated |  -  |
+| **400** | Bad request or validation error. The **error** field contains the exact backend message, e.g. \"Validation failed\", \"projectId is required\", \"No file provided\", \"Invalid project ID format\". **details** may contain validation errors when present.  |  -  |
+| **401** | Not authenticated. The **error** field contains the exact backend message, e.g. \"Invalid token.\", \"Access denied. No token provided.\", \"Authentication required\", \"Invalid API key\", \"API key expired\".  |  -  |
+| **403** | Access denied. The **error** field contains the exact backend message, e.g. \"Access denied\", \"Insufficient permissions\", \"You don\'t have permission to view this organization\'s projects\", \"Account suspended\".  |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## multiRoleUpdateRole
+
+> MultiRoleToggleRole200Response multiRoleUpdateRole(projectId, roleSlug, multiRoleUpdateRoleRequest)
+
+Update role configuration
+
+Update an app role — same fields as **Add custom role** (partial). `defaultPermissions` / `collectionPermissions` use the same normalization as on create. **featurePermissions:** see schema `AppRoleFeaturePermissions`.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  MultiRoleApi,
+} from 'mudbase-sdk';
+import type { MultiRoleUpdateRoleOperationRequest } from 'mudbase-sdk';
+
+async function example() {
+  console.log("🚀 Testing mudbase-sdk SDK...");
+  const config = new Configuration({ 
+    // Configure HTTP bearer authorization: BearerToken
+    accessToken: "YOUR BEARER TOKEN",
+  });
+  const api = new MultiRoleApi(config);
+
+  const body = {
+    // string | Project ID.
+    projectId: 685ad30be129932fbb7a1047,
+    // string | Role slug to update (e.g. starter `customer` or a role you added).
+    roleSlug: customer,
+    // MultiRoleUpdateRoleRequest | Same fields as **Add custom role** — send only fields you want to change. `defaultPermissions` / `collectionPermissions` are normalized the same way as on create.
+    multiRoleUpdateRoleRequest: {"name":"App user","description":"End users of the app","signupEndpoint":"customer","requiresApproval":false,"requiresPayment":false,"requiresKYC":false,"collectionPermissions":{"posts":["create","read","update","delete"]},"featurePermissions":{"messaging":{"email":true,"sms":false},"integration":{"read":true,"execute":true}}},
+  } satisfies MultiRoleUpdateRoleOperationRequest;
+
+  try {
+    const data = await api.multiRoleUpdateRole(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **projectId** | `string` | Project ID. | [Defaults to `undefined`] |
+| **roleSlug** | `string` | Role slug to update (e.g. starter `customer` or a role you added). | [Defaults to `undefined`] |
+| **multiRoleUpdateRoleRequest** | [MultiRoleUpdateRoleRequest](MultiRoleUpdateRoleRequest.md) | Same fields as **Add custom role** — send only fields you want to change. `defaultPermissions` / `collectionPermissions` are normalized the same way as on create. | |
+
+### Return type
+
+[**MultiRoleToggleRole200Response**](MultiRoleToggleRole200Response.md)
+
+### Authorization
+
+[BearerToken](../README.md#BearerToken)
+
+### HTTP request headers
+
+- **Content-Type**: `application/json`
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Role updated |  -  |
+| **400** | Bad request or validation error. The **error** field contains the exact backend message, e.g. \"Validation failed\", \"projectId is required\", \"No file provided\", \"Invalid project ID format\". **details** may contain validation errors when present.  |  -  |
+| **401** | Not authenticated. The **error** field contains the exact backend message, e.g. \"Invalid token.\", \"Access denied. No token provided.\", \"Authentication required\", \"Invalid API key\", \"API key expired\".  |  -  |
+| **403** | Access denied. The **error** field contains the exact backend message, e.g. \"Access denied\", \"Insufficient permissions\", \"You don\'t have permission to view this organization\'s projects\", \"Account suspended\".  |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## multiRoleUpdateSettings
+
+> MultiRoleUpdateSettings200Response multiRoleUpdateSettings(projectId, multiRoleUpdateSettingsRequest)
+
+Update multi-role feature settings
+
+Update multi-role feature settings: enable/disable the feature, `defaultRole`, and `settings` (`allowMultipleRoles`, `requireRoleSelection`, `autoAssignDefault`, `dataOwnerField`). Does not edit role definitions — use `POST/PATCH .../multi-role/roles` (same body shape as add role). Accepts BearerToken (JWT) or ApiKeyAuth (X-API-Key). 
+
+### Example
+
+```ts
+import {
+  Configuration,
+  MultiRoleApi,
+} from 'mudbase-sdk';
+import type { MultiRoleUpdateSettingsOperationRequest } from 'mudbase-sdk';
+
+async function example() {
+  console.log("🚀 Testing mudbase-sdk SDK...");
+  const config = new Configuration({ 
+    // Configure HTTP bearer authorization: BearerToken
+    accessToken: "YOUR BEARER TOKEN",
+  });
+  const api = new MultiRoleApi(config);
+
+  const body = {
+    // string | Project ID.
+    projectId: 685ad30be129932fbb7a1047,
+    // MultiRoleUpdateSettingsRequest | Feature flags only — not per-role approval. Use `settings.allowMultipleRoles`, `requireRoleSelection`, `autoAssignDefault`, `dataOwnerField`.
+    multiRoleUpdateSettingsRequest: {"isEnabled":true,"defaultRole":"customer","settings":{"allowMultipleRoles":false,"requireRoleSelection":false,"autoAssignDefault":true,"dataOwnerField":"createdBy"}},
+  } satisfies MultiRoleUpdateSettingsOperationRequest;
+
+  try {
+    const data = await api.multiRoleUpdateSettings(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **projectId** | `string` | Project ID. | [Defaults to `undefined`] |
+| **multiRoleUpdateSettingsRequest** | [MultiRoleUpdateSettingsRequest](MultiRoleUpdateSettingsRequest.md) | Feature flags only — not per-role approval. Use `settings.allowMultipleRoles`, `requireRoleSelection`, `autoAssignDefault`, `dataOwnerField`. | |
+
+### Return type
+
+[**MultiRoleUpdateSettings200Response**](MultiRoleUpdateSettings200Response.md)
+
+### Authorization
+
+[BearerToken](../README.md#BearerToken)
+
+### HTTP request headers
+
+- **Content-Type**: `application/json`
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Settings updated |  -  |
+| **400** | Bad request or validation error. The **error** field contains the exact backend message, e.g. \"Validation failed\", \"projectId is required\", \"No file provided\", \"Invalid project ID format\". **details** may contain validation errors when present.  |  -  |
+| **401** | Not authenticated. The **error** field contains the exact backend message, e.g. \"Invalid token.\", \"Access denied. No token provided.\", \"Authentication required\", \"Invalid API key\", \"API key expired\".  |  -  |
+| **403** | Access denied. The **error** field contains the exact backend message, e.g. \"Access denied\", \"Insufficient permissions\", \"You don\'t have permission to view this organization\'s projects\", \"Account suspended\".  |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+