mudbase-sdk 1.0.0

package/docs/MultiRoleFeatureApi.md

@@ -0,0 +1,716 @@
+# MultiRoleFeatureApi
+
+All URIs are relative to *https://cloud.mudbase.dev*
+
+| Method | HTTP request | Description |
+|------------- | ------------- | -------------|
+| [**addCustomRole**](MultiRoleFeatureApi.md#addcustomroleoperation) | **POST** /api/projects/{projectId}/multi-role/roles | Add custom role |
+| [**getAvailableRoles**](MultiRoleFeatureApi.md#getavailableroles) | **GET** /api/projects/{projectId}/multi-role/roles/available | Get available roles for signup |
+| [**getMultiRoleConfig**](MultiRoleFeatureApi.md#getmultiroleconfig) | **GET** /api/projects/{projectId}/multi-role | Get multi-role feature configuration |
+| [**oauthSignupWithRole**](MultiRoleFeatureApi.md#oauthsignupwithrole) | **GET** /api/auth/oauth/signup/{role}/{provider}/{projectId} | OAuth signup with specific role |
+| [**registerWithRole**](MultiRoleFeatureApi.md#registerwithroleoperation) | **POST** /api/auth/local/signup/{role} | Register user with specific role (Local Auth) |
+| [**toggleRole**](MultiRoleFeatureApi.md#toggleroleoperation) | **PATCH** /api/projects/{projectId}/multi-role/roles/{roleSlug}/toggle | Toggle role on/off |
+| [**updateCollectionPermissions**](MultiRoleFeatureApi.md#updatecollectionpermissionsoperation) | **PATCH** /api/projects/{projectId}/multi-role/roles/{roleSlug}/collections/{collectionId}/permissions | Update collection permissions for a role |
+| [**updateMultiRoleSettings**](MultiRoleFeatureApi.md#updatemultirolesettingsoperation) | **PATCH** /api/projects/{projectId}/multi-role/settings | Update multi-role feature settings |
+| [**updateProjectRole**](MultiRoleFeatureApi.md#updateprojectroleoperation) | **PATCH** /api/projects/{projectId}/multi-role/roles/{roleSlug} | Update role configuration |
+
+
+
+## addCustomRole
+
+> UpdateMultiRoleSettings200Response addCustomRole(projectId, addCustomRoleRequest)
+
+Add custom role
+
+Add a custom role to a project with specific permissions and signup endpoint. Accepts ProjectBearerAuth (JWT) or ApiKeyAuth (X-API-Key). 
+
+### Example
+
+```ts
+import {
+  Configuration,
+  MultiRoleFeatureApi,
+} from 'mudbase-sdk';
+import type { AddCustomRoleOperationRequest } from 'mudbase-sdk';
+
+async function example() {
+  console.log("🚀 Testing mudbase-sdk SDK...");
+  const config = new Configuration({ 
+    // Configure HTTP bearer authorization: ProjectBearerAuth
+    accessToken: "YOUR BEARER TOKEN",
+  });
+  const api = new MultiRoleFeatureApi(config);
+
+  const body = {
+    // string | Project ID.
+    projectId: 685ad30be129932fbb7a1047,
+    // AddCustomRoleRequest | Custom role definition (slug, name, description, signupEndpoint, hierarchy, defaultPermissions).
+    addCustomRoleRequest: {"slug":"rider","name":"Delivery Rider","description":"Delivery rider role for logistics","signupEndpoint":"/api/auth/local/signup/rider","hierarchy":25,"defaultPermissions":[{"resource":"data","actions":["read","update"]}]},
+  } satisfies AddCustomRoleOperationRequest;
+
+  try {
+    const data = await api.addCustomRole(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`] |
+| **addCustomRoleRequest** | [AddCustomRoleRequest](AddCustomRoleRequest.md) | Custom role definition (slug, name, description, signupEndpoint, hierarchy, defaultPermissions). | |
+
+### Return type
+
+[**UpdateMultiRoleSettings200Response**](UpdateMultiRoleSettings200Response.md)
+
+### Authorization
+
+[ProjectBearerAuth](../README.md#ProjectBearerAuth)
+
+### 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 |  -  |
+| **401** | Authentication required |  -  |
+| **403** | Access denied |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## getAvailableRoles
+
+> GetAvailableRoles200Response getAvailableRoles(projectId)
+
+Get available roles for signup
+
+Get all available roles for user signup in a project. Accepts ProjectBearerAuth (JWT) or ApiKeyAuth (X-API-Key). 
+
+### Example
+
+```ts
+import {
+  Configuration,
+  MultiRoleFeatureApi,
+} from 'mudbase-sdk';
+import type { GetAvailableRolesRequest } from 'mudbase-sdk';
+
+async function example() {
+  console.log("🚀 Testing mudbase-sdk SDK...");
+  const config = new Configuration({ 
+    // Configure HTTP bearer authorization: ProjectBearerAuth
+    accessToken: "YOUR BEARER TOKEN",
+  });
+  const api = new MultiRoleFeatureApi(config);
+
+  const body = {
+    // string | Project ID.
+    projectId: 685ad30be129932fbb7a1047,
+  } satisfies GetAvailableRolesRequest;
+
+  try {
+    const data = await api.getAvailableRoles(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
+
+[**GetAvailableRoles200Response**](GetAvailableRoles200Response.md)
+
+### Authorization
+
+[ProjectBearerAuth](../README.md#ProjectBearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | List of available roles |  -  |
+| **401** | Authentication required |  -  |
+| **403** | Access denied |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## getMultiRoleConfig
+
+> GetMultiRoleConfig200Response getMultiRoleConfig(projectId)
+
+Get multi-role feature configuration
+
+Get the ready-to-use multi-role system configuration for a project
+
+### Example
+
+```ts
+import {
+  Configuration,
+  MultiRoleFeatureApi,
+} from 'mudbase-sdk';
+import type { GetMultiRoleConfigRequest } from 'mudbase-sdk';
+
+async function example() {
+  console.log("🚀 Testing mudbase-sdk SDK...");
+  const config = new Configuration({ 
+    // Configure HTTP bearer authorization: ProjectBearerAuth
+    accessToken: "YOUR BEARER TOKEN",
+  });
+  const api = new MultiRoleFeatureApi(config);
+
+  const body = {
+    // string | Project ID.
+    projectId: 685ad30be129932fbb7a1047,
+  } satisfies GetMultiRoleConfigRequest;
+
+  try {
+    const data = await api.getMultiRoleConfig(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
+
+[**GetMultiRoleConfig200Response**](GetMultiRoleConfig200Response.md)
+
+### Authorization
+
+[ProjectBearerAuth](../README.md#ProjectBearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Multi-role configuration |  -  |
+| **401** | Authentication required |  -  |
+| **403** | Access denied |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## oauthSignupWithRole
+
+> LinkOAuthProvider200Response oauthSignupWithRole(role, provider, projectId, redirectUrl)
+
+OAuth signup with specific role
+
+Public endpoint that initiates OAuth signup flow with a specific role assigned during registration. The OAuth provider must be configured and enabled for the project first. The role must be available for signup in the project\'s multi-role configuration. After successful OAuth authentication, the user will be created with the specified role. No authentication required - this is a public signup endpoint. 
+
+### Example
+
+```ts
+import {
+  Configuration,
+  MultiRoleFeatureApi,
+} from 'mudbase-sdk';
+import type { OauthSignupWithRoleRequest } from 'mudbase-sdk';
+
+async function example() {
+  console.log("🚀 Testing mudbase-sdk SDK...");
+  const api = new MultiRoleFeatureApi();
+
+  const body = {
+    // string | Role slug for signup (e.g. customer, vendor, seller).
+    role: vendor,
+    // 'google' | 'github' | 'facebook' | 'microsoft' | 'apple' | 'twitter' | 'discord' | 'linkedin' | 'dropbox' | 'slack' | 'reddit' | 'twitch' | 'figma' | 'zoom' | 'bitbucket' | 'salesforce' | 'shopify' | 'line' | 'spotify' | 'strava' | 'paypal' | 'asana' | 'trello' | 'okta' | 'gitea' | 'yandex' | 'yahoo' | 'vk' | 'meetup' | OAuth provider (e.g. google, github).
+    provider: google,
+    // string | Project ID.
+    projectId: 685ad30be129932fbb7a1047,
+    // string | The URL to redirect to after authentication (optional)
+    redirectUrl: https://client.app/auth/callback,
+  } satisfies OauthSignupWithRoleRequest;
+
+  try {
+    const data = await api.oauthSignupWithRole(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **role** | `string` | Role slug for signup (e.g. customer, vendor, seller). | [Defaults to `undefined`] |
+| **provider** | `google`, `github`, `facebook`, `microsoft`, `apple`, `twitter`, `discord`, `linkedin`, `dropbox`, `slack`, `reddit`, `twitch`, `figma`, `zoom`, `bitbucket`, `salesforce`, `shopify`, `line`, `spotify`, `strava`, `paypal`, `asana`, `trello`, `okta`, `gitea`, `yandex`, `yahoo`, `vk`, `meetup` | OAuth provider (e.g. google, github). | [Defaults to `undefined`] [Enum: google, github, facebook, microsoft, apple, twitter, discord, linkedin, dropbox, slack, reddit, twitch, figma, zoom, bitbucket, salesforce, shopify, line, spotify, strava, paypal, asana, trello, okta, gitea, yandex, yahoo, vk, meetup] |
+| **projectId** | `string` | Project ID. | [Defaults to `undefined`] |
+| **redirectUrl** | `string` | The URL to redirect to after authentication | [Optional] [Defaults to `undefined`] |
+
+### Return type
+
+[**LinkOAuthProvider200Response**](LinkOAuthProvider200Response.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Success (OAuth signup flow initiated; in most cases the server responds with 302 redirect). |  -  |
+| **302** | Redirects to OAuth provider\&#39;s consent screen |  * Location - OAuth provider authorization URL <br>  |
+| **400** | OAuth provider not configured, role not found, or validation error |  -  |
+| **401** | Authentication required |  -  |
+| **403** | Access denied |  -  |
+| **404** | Project not found |  -  |
+| **500** | Internal server error |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## registerWithRole
+
+> registerWithRole(role, registerWithRoleRequest)
+
+Register user with specific role (Local Auth)
+
+Public endpoint for user registration with a specific role. The role is specified in the URL path (e.g., /signup/customer, /signup/vendor). No authentication required - this is a public signup endpoint. 
+
+### Example
+
+```ts
+import {
+  Configuration,
+  MultiRoleFeatureApi,
+} from 'mudbase-sdk';
+import type { RegisterWithRoleOperationRequest } from 'mudbase-sdk';
+
+async function example() {
+  console.log("🚀 Testing mudbase-sdk SDK...");
+  const api = new MultiRoleFeatureApi();
+
+  const body = {
+    // string | Role slug for signup (e.g. customer, vendor).
+    role: customer,
+    // RegisterWithRoleRequest | Registration payload (email, password, firstName, lastName, projectId).
+    registerWithRoleRequest: {"email":"customer@example.com","password":"SecurePass123!","firstName":"Jane","lastName":"Doe","projectId":"685ad30be129932fbb7a1047"},
+  } satisfies RegisterWithRoleOperationRequest;
+
+  try {
+    const data = await api.registerWithRole(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **role** | `string` | Role slug for signup (e.g. customer, vendor). | [Defaults to `undefined`] |
+| **registerWithRoleRequest** | [RegisterWithRoleRequest](RegisterWithRoleRequest.md) | Registration payload (email, password, firstName, lastName, projectId). | |
+
+### Return type
+
+`void` (Empty response body)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: `application/json`
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **201** | Registration successful |  -  |
+| **400** | Bad request |  -  |
+| **401** | Authentication required |  -  |
+| **403** | Access denied |  -  |
+| **404** | Role not found or not enabled |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## toggleRole
+
+> UpdateMultiRoleSettings200Response toggleRole(projectId, roleSlug, toggleRoleRequest)
+
+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,
+  MultiRoleFeatureApi,
+} from 'mudbase-sdk';
+import type { ToggleRoleOperationRequest } from 'mudbase-sdk';
+
+async function example() {
+  console.log("🚀 Testing mudbase-sdk SDK...");
+  const config = new Configuration({ 
+    // Configure HTTP bearer authorization: ProjectBearerAuth
+    accessToken: "YOUR BEARER TOKEN",
+  });
+  const api = new MultiRoleFeatureApi(config);
+
+  const body = {
+    // string | Project ID.
+    projectId: 685ad30be129932fbb7a1047,
+    // string | Role slug to toggle (e.g. vendor, customer).
+    roleSlug: vendor,
+    // ToggleRoleRequest | Whether the role is enabled (true) or disabled (false).
+    toggleRoleRequest: {"isEnabled":true},
+  } satisfies ToggleRoleOperationRequest;
+
+  try {
+    const data = await api.toggleRole(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. vendor, customer). | [Defaults to `undefined`] |
+| **toggleRoleRequest** | [ToggleRoleRequest](ToggleRoleRequest.md) | Whether the role is enabled (true) or disabled (false). | |
+
+### Return type
+
+[**UpdateMultiRoleSettings200Response**](UpdateMultiRoleSettings200Response.md)
+
+### Authorization
+
+[ProjectBearerAuth](../README.md#ProjectBearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: `application/json`
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Role toggled |  -  |
+| **400** | Bad request |  -  |
+| **401** | Authentication required |  -  |
+| **403** | Access denied |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## updateCollectionPermissions
+
+> UpdateMultiRoleSettings200Response updateCollectionPermissions(projectId, roleSlug, collectionId, updateCollectionPermissionsRequest)
+
+Update collection permissions for a role
+
+Update collection-specific permissions for a role in a project. Accepts ProjectBearerAuth (JWT) or ApiKeyAuth (X-API-Key). 
+
+### Example
+
+```ts
+import {
+  Configuration,
+  MultiRoleFeatureApi,
+} from 'mudbase-sdk';
+import type { UpdateCollectionPermissionsOperationRequest } from 'mudbase-sdk';
+
+async function example() {
+  console.log("🚀 Testing mudbase-sdk SDK...");
+  const config = new Configuration({ 
+    // Configure HTTP bearer authorization: ProjectBearerAuth
+    accessToken: "YOUR BEARER TOKEN",
+  });
+  const api = new MultiRoleFeatureApi(config);
+
+  const body = {
+    // string | Project ID.
+    projectId: 685ad30be129932fbb7a1047,
+    // string | Role slug (e.g. vendor, customer).
+    roleSlug: vendor,
+    // string | Collection ID to set permissions for.
+    collectionId: 696ba6e4f4a9422ac4be4f74,
+    // UpdateCollectionPermissionsRequest | Allowed actions and optional conditions for the role on this collection.
+    updateCollectionPermissionsRequest: {"actions":["create","read","update","delete"],"conditions":{"status":"active"}},
+  } satisfies UpdateCollectionPermissionsOperationRequest;
+
+  try {
+    const data = await api.updateCollectionPermissions(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. vendor, customer). | [Defaults to `undefined`] |
+| **collectionId** | `string` | Collection ID to set permissions for. | [Defaults to `undefined`] |
+| **updateCollectionPermissionsRequest** | [UpdateCollectionPermissionsRequest](UpdateCollectionPermissionsRequest.md) | Allowed actions and optional conditions for the role on this collection. | |
+
+### Return type
+
+[**UpdateMultiRoleSettings200Response**](UpdateMultiRoleSettings200Response.md)
+
+### Authorization
+
+[ProjectBearerAuth](../README.md#ProjectBearerAuth)
+
+### 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 |  -  |
+| **401** | Authentication required |  -  |
+| **403** | Access denied |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## updateMultiRoleSettings
+
+> UpdateMultiRoleSettings200Response updateMultiRoleSettings(projectId, updateMultiRoleSettingsRequest)
+
+Update multi-role feature settings
+
+Update multi-role feature settings for a project, including enabling/disabling the feature and configuring default roles. Accepts ProjectBearerAuth (JWT) or ApiKeyAuth (X-API-Key). 
+
+### Example
+
+```ts
+import {
+  Configuration,
+  MultiRoleFeatureApi,
+} from 'mudbase-sdk';
+import type { UpdateMultiRoleSettingsOperationRequest } from 'mudbase-sdk';
+
+async function example() {
+  console.log("🚀 Testing mudbase-sdk SDK...");
+  const config = new Configuration({ 
+    // Configure HTTP bearer authorization: ProjectBearerAuth
+    accessToken: "YOUR BEARER TOKEN",
+  });
+  const api = new MultiRoleFeatureApi(config);
+
+  const body = {
+    // string | Project ID.
+    projectId: 685ad30be129932fbb7a1047,
+    // UpdateMultiRoleSettingsRequest | Multi-role settings (e.g. isEnabled, defaultRole, allowMultipleRoles, requireApproval).
+    updateMultiRoleSettingsRequest: {"isEnabled":true,"defaultRole":"customer","settings":{"allowMultipleRoles":false,"requireApproval":false}},
+  } satisfies UpdateMultiRoleSettingsOperationRequest;
+
+  try {
+    const data = await api.updateMultiRoleSettings(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`] |
+| **updateMultiRoleSettingsRequest** | [UpdateMultiRoleSettingsRequest](UpdateMultiRoleSettingsRequest.md) | Multi-role settings (e.g. isEnabled, defaultRole, allowMultipleRoles, requireApproval). | |
+
+### Return type
+
+[**UpdateMultiRoleSettings200Response**](UpdateMultiRoleSettings200Response.md)
+
+### Authorization
+
+[ProjectBearerAuth](../README.md#ProjectBearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: `application/json`
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Settings updated |  -  |
+| **400** | Bad request |  -  |
+| **401** | Authentication required |  -  |
+| **403** | Access denied |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## updateProjectRole
+
+> UpdateMultiRoleSettings200Response updateProjectRole(projectId, roleSlug, updateProjectRoleRequest)
+
+Update role configuration
+
+Update an existing role\&#39;s metadata and requirements (name, description, hierarchy, approval/payment/KYC flags).
+
+### Example
+
+```ts
+import {
+  Configuration,
+  MultiRoleFeatureApi,
+} from 'mudbase-sdk';
+import type { UpdateProjectRoleOperationRequest } from 'mudbase-sdk';
+
+async function example() {
+  console.log("🚀 Testing mudbase-sdk SDK...");
+  const config = new Configuration({ 
+    // Configure HTTP bearer authorization: ProjectBearerAuth
+    accessToken: "YOUR BEARER TOKEN",
+  });
+  const api = new MultiRoleFeatureApi(config);
+
+  const body = {
+    // string | Project ID.
+    projectId: 685ad30be129932fbb7a1047,
+    // string | Role slug to update (e.g. vendor, customer).
+    roleSlug: vendor,
+    // UpdateProjectRoleRequest | Role fields to update (name, description, hierarchy, requiresApproval, requiresPayment, requiresKYC).
+    updateProjectRoleRequest: {"name":"Vendor","description":"Vendor/seller role with enhanced permissions","hierarchy":35,"requiresApproval":true,"requiresPayment":true,"requiresKYC":false},
+  } satisfies UpdateProjectRoleOperationRequest;
+
+  try {
+    const data = await api.updateProjectRole(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. vendor, customer). | [Defaults to `undefined`] |
+| **updateProjectRoleRequest** | [UpdateProjectRoleRequest](UpdateProjectRoleRequest.md) | Role fields to update (name, description, hierarchy, requiresApproval, requiresPayment, requiresKYC). | |
+
+### Return type
+
+[**UpdateMultiRoleSettings200Response**](UpdateMultiRoleSettings200Response.md)
+
+### Authorization
+
+[ProjectBearerAuth](../README.md#ProjectBearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: `application/json`
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Role updated |  -  |
+| **400** | Bad request |  -  |
+| **401** | Authentication required |  -  |
+| **403** | Access denied |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+