mudbase-sdk 1.2.9 → 1.2.12

package/dist/esm/apis/MultiRoleApi.d.ts

@@ -1,8 +1,8 @@
 /**
  * MUDBASESDK
- * MUDBASE is a scalable, real-time, and secure Backend-as-a-Service (BaaS) platform  designed for modern applications. Built with custom logic, it offers fine-grained  control, extensibility, and enterprise-grade security.  ## Features - 🔐 Multi-provider authentication (30+ OAuth providers) - 📊 Real-time database with collections - 📁 File storage and management - 🔑 API key management with permissions - 🔗 Webhook system with retry logic - ⚡ Serverless functions - 💬 Multi-channel messaging (Push, Email, SMS) - 📈 Usage analytics and monitoring - 🌐 Real-time WebSocket events - 🔍 Full-text search capabilities - 💳 Billing: Flutterwave only for fiat (platform subscriptions + org payment processing with 7% + $0.50 split); crypto payment processor for multi-chain checkout - 📡 Block-based multi-chain wallet monitoring (ETH/UTXO scanners, GetBlock, scanner metrics API)
+ * MUDBASE is a scalable, real-time, and secure Backend-as-a-Service (BaaS) platform  designed for modern applications. Built with custom logic, it offers fine-grained  control, extensibility, and enterprise-grade security.  ## Features - 🔐 Multi-provider authentication (30+ OAuth providers) - 📊 Real-time database with collections - 📁 File storage and management - 🔑 API key management with permissions - 🔗 Webhook system with retry logic - ⚡ Serverless functions - 💬 Multi-channel messaging (Push, Email, SMS) - 📈 Usage analytics and monitoring - 🌐 Real-time WebSocket events - 🔍 Full-text search capabilities - 💳 Billing: Flutterwave for fiat (platform subscriptions and payment processing with 7% + $0.50 split); crypto payment processor for multi-chain checkout - 📡 Block-based multi-chain wallet monitoring (ETH/UTXO scanners, GetBlock, scanner metrics API)
  *
- * The version of the OpenAPI document: 1.2.9
+ * The version of the OpenAPI document: 1.2.12
  * Contact: support@mudbase.dev
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -10,7 +10,7 @@
  * Do not edit the class manually.
  */
 import * as runtime from '../runtime';
-import type { AuthRegisterWithRoleRequest, UsersLinkOAuthProvider200Response } from '../models/index';
+import type { AuthRegisterWithRoleRequest, MultiRoleAddRoleRequest, MultiRoleApplyRoleFeaturePresetRequest, MultiRoleGetAvailableRoles200Response, MultiRoleGetConfig200Response, MultiRoleGetPermissionsMatrix200Response, MultiRoleSimulateAppPermissionsRequest, MultiRoleToggleRole200Response, MultiRoleToggleRoleRequest, MultiRoleUpdateCollectionPermissionsRequest, MultiRoleUpdateRoleRequest, MultiRoleUpdateSettings200Response, MultiRoleUpdateSettingsRequest, UsersLinkOAuthProvider200Response } from '../models/index';
 export interface AuthOauthSignupWithRoleRequest {
     role: string;
     provider: AuthOauthSignupWithRoleProviderEnum;
@@ -21,6 +21,48 @@ export interface AuthRegisterWithRoleOperationRequest {
     role: string;
     authRegisterWithRoleRequest: AuthRegisterWithRoleRequest;
 }
+export interface MultiRoleAddRoleOperationRequest {
+    projectId: string;
+    multiRoleAddRoleRequest: MultiRoleAddRoleRequest;
+}
+export interface MultiRoleApplyRoleFeaturePresetOperationRequest {
+    projectId: string;
+    roleSlug: string;
+    multiRoleApplyRoleFeaturePresetRequest: MultiRoleApplyRoleFeaturePresetRequest;
+}
+export interface MultiRoleGetAvailableRolesRequest {
+    projectId: string;
+}
+export interface MultiRoleGetConfigRequest {
+    projectId: string;
+}
+export interface MultiRoleGetPermissionsMatrixRequest {
+    projectId: string;
+}
+export interface MultiRoleSimulateAppPermissionsOperationRequest {
+    projectId: string;
+    multiRoleSimulateAppPermissionsRequest: MultiRoleSimulateAppPermissionsRequest | null;
+}
+export interface MultiRoleToggleRoleOperationRequest {
+    projectId: string;
+    roleSlug: string;
+    multiRoleToggleRoleRequest: MultiRoleToggleRoleRequest;
+}
+export interface MultiRoleUpdateCollectionPermissionsOperationRequest {
+    projectId: string;
+    roleSlug: string;
+    collectionId: string;
+    multiRoleUpdateCollectionPermissionsRequest: MultiRoleUpdateCollectionPermissionsRequest;
+}
+export interface MultiRoleUpdateRoleOperationRequest {
+    projectId: string;
+    roleSlug: string;
+    multiRoleUpdateRoleRequest: MultiRoleUpdateRoleRequest;
+}
+export interface MultiRoleUpdateSettingsOperationRequest {
+    projectId: string;
+    multiRoleUpdateSettingsRequest: MultiRoleUpdateSettingsRequest;
+}
 /**
  *
  */
@@ -53,6 +95,146 @@ export declare class MultiRoleApi extends runtime.BaseAPI {
      * Register user with specific role (Local Auth)
      */
     authRegisterWithRole(requestParameters: AuthRegisterWithRoleOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     * Creates request options for multiRoleAddRole without sending the request
+     */
+    multiRoleAddRoleRequestOpts(requestParameters: MultiRoleAddRoleOperationRequest): Promise<runtime.RequestOpts>;
+    /**
+     * 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).
+     * Add custom role
+     */
+    multiRoleAddRoleRaw(requestParameters: MultiRoleAddRoleOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<MultiRoleToggleRole200Response>>;
+    /**
+     * 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).
+     * Add custom role
+     */
+    multiRoleAddRole(requestParameters: MultiRoleAddRoleOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<MultiRoleToggleRole200Response>;
+    /**
+     * Creates request options for multiRoleApplyRoleFeaturePreset without sending the request
+     */
+    multiRoleApplyRoleFeaturePresetRequestOpts(requestParameters: MultiRoleApplyRoleFeaturePresetOperationRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Sets `featurePermissions` from preset `admin`, `user`, or `viewer`.
+     * Apply Admin / User / Viewer feature permission preset
+     */
+    multiRoleApplyRoleFeaturePresetRaw(requestParameters: MultiRoleApplyRoleFeaturePresetOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * Sets `featurePermissions` from preset `admin`, `user`, or `viewer`.
+     * Apply Admin / User / Viewer feature permission preset
+     */
+    multiRoleApplyRoleFeaturePreset(requestParameters: MultiRoleApplyRoleFeaturePresetOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     * Creates request options for multiRoleGetAvailableRoles without sending the request
+     */
+    multiRoleGetAvailableRolesRequestOpts(requestParameters: MultiRoleGetAvailableRolesRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Get all available roles for user signup in a project. Accepts BearerToken (JWT) or ApiKeyAuth (X-API-Key).
+     * Get available roles for signup
+     */
+    multiRoleGetAvailableRolesRaw(requestParameters: MultiRoleGetAvailableRolesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<MultiRoleGetAvailableRoles200Response>>;
+    /**
+     * Get all available roles for user signup in a project. Accepts BearerToken (JWT) or ApiKeyAuth (X-API-Key).
+     * Get available roles for signup
+     */
+    multiRoleGetAvailableRoles(requestParameters: MultiRoleGetAvailableRolesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<MultiRoleGetAvailableRoles200Response>;
+    /**
+     * Creates request options for multiRoleGetConfig without sending the request
+     */
+    multiRoleGetConfigRequestOpts(requestParameters: MultiRoleGetConfigRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Returns project app roles (default one editable `customer` starter until you add more) and settings.
+     * Get multi-role feature configuration
+     */
+    multiRoleGetConfigRaw(requestParameters: MultiRoleGetConfigRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<MultiRoleGetConfig200Response>>;
+    /**
+     * Returns project app roles (default one editable `customer` starter until you add more) and settings.
+     * Get multi-role feature configuration
+     */
+    multiRoleGetConfig(requestParameters: MultiRoleGetConfigRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<MultiRoleGetConfig200Response>;
+    /**
+     * Creates request options for multiRoleGetPermissionsMatrix without sending the request
+     */
+    multiRoleGetPermissionsMatrixRequestOpts(requestParameters: MultiRoleGetPermissionsMatrixRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Per-collection role actions and per-role `featurePermissions` for app-role gates.
+     * Get permissions matrix (collections + featurePermissions)
+     */
+    multiRoleGetPermissionsMatrixRaw(requestParameters: MultiRoleGetPermissionsMatrixRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<MultiRoleGetPermissionsMatrix200Response>>;
+    /**
+     * Per-collection role actions and per-role `featurePermissions` for app-role gates.
+     * Get permissions matrix (collections + featurePermissions)
+     */
+    multiRoleGetPermissionsMatrix(requestParameters: MultiRoleGetPermissionsMatrixRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<MultiRoleGetPermissionsMatrix200Response>;
+    /**
+     * Creates request options for multiRoleSimulateAppPermissions without sending the request
+     */
+    multiRoleSimulateAppPermissionsRequestOpts(requestParameters: MultiRoleSimulateAppPermissionsOperationRequest): Promise<runtime.RequestOpts>;
+    /**
+     * 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`.
+     * Simulate app-role feature permission for a path
+     */
+    multiRoleSimulateAppPermissionsRaw(requestParameters: MultiRoleSimulateAppPermissionsOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<object>>;
+    /**
+     * 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`.
+     * Simulate app-role feature permission for a path
+     */
+    multiRoleSimulateAppPermissions(requestParameters: MultiRoleSimulateAppPermissionsOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<object>;
+    /**
+     * Creates request options for multiRoleToggleRole without sending the request
+     */
+    multiRoleToggleRoleRequestOpts(requestParameters: MultiRoleToggleRoleOperationRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Enable or disable a role for the project. When disabled, the role is no longer available for signup or assignment.
+     * Toggle role on/off
+     */
+    multiRoleToggleRoleRaw(requestParameters: MultiRoleToggleRoleOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<MultiRoleToggleRole200Response>>;
+    /**
+     * Enable or disable a role for the project. When disabled, the role is no longer available for signup or assignment.
+     * Toggle role on/off
+     */
+    multiRoleToggleRole(requestParameters: MultiRoleToggleRoleOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<MultiRoleToggleRole200Response>;
+    /**
+     * Creates request options for multiRoleUpdateCollectionPermissions without sending the request
+     */
+    multiRoleUpdateCollectionPermissionsRequestOpts(requestParameters: MultiRoleUpdateCollectionPermissionsOperationRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Update collection-specific permissions for a role in a project. Accepts BearerToken (JWT) or ApiKeyAuth (X-API-Key).
+     * Update collection permissions for a role
+     */
+    multiRoleUpdateCollectionPermissionsRaw(requestParameters: MultiRoleUpdateCollectionPermissionsOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<MultiRoleToggleRole200Response>>;
+    /**
+     * Update collection-specific permissions for a role in a project. Accepts BearerToken (JWT) or ApiKeyAuth (X-API-Key).
+     * Update collection permissions for a role
+     */
+    multiRoleUpdateCollectionPermissions(requestParameters: MultiRoleUpdateCollectionPermissionsOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<MultiRoleToggleRole200Response>;
+    /**
+     * Creates request options for multiRoleUpdateRole without sending the request
+     */
+    multiRoleUpdateRoleRequestOpts(requestParameters: MultiRoleUpdateRoleOperationRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Update an app role — same fields as **Add custom role** (partial). `defaultPermissions` / `collectionPermissions` use the same normalization as on create. **featurePermissions:** see schema `AppRoleFeaturePermissions`.
+     * Update role configuration
+     */
+    multiRoleUpdateRoleRaw(requestParameters: MultiRoleUpdateRoleOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<MultiRoleToggleRole200Response>>;
+    /**
+     * Update an app role — same fields as **Add custom role** (partial). `defaultPermissions` / `collectionPermissions` use the same normalization as on create. **featurePermissions:** see schema `AppRoleFeaturePermissions`.
+     * Update role configuration
+     */
+    multiRoleUpdateRole(requestParameters: MultiRoleUpdateRoleOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<MultiRoleToggleRole200Response>;
+    /**
+     * Creates request options for multiRoleUpdateSettings without sending the request
+     */
+    multiRoleUpdateSettingsRequestOpts(requestParameters: MultiRoleUpdateSettingsOperationRequest): Promise<runtime.RequestOpts>;
+    /**
+     * 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).
+     * Update multi-role feature settings
+     */
+    multiRoleUpdateSettingsRaw(requestParameters: MultiRoleUpdateSettingsOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<MultiRoleUpdateSettings200Response>>;
+    /**
+     * 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).
+     * Update multi-role feature settings
+     */
+    multiRoleUpdateSettings(requestParameters: MultiRoleUpdateSettingsOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<MultiRoleUpdateSettings200Response>;
 }
 /**
  * @export