mudbase 1.2.8 → 1.2.10

data/lib/mudbase/api/multi_role_api.rb

@@ -1,9 +1,9 @@
 =begin
 #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 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) - 🏢 Enterprise: custom domains under `GET/POST/PATCH/DELETE /api/orgs/{orgId}/projects/{projectId}/domains` (plan `features.customDomainAllowed`); stable error codes `hostname_in_use`, `domain_limit_reached`, `domain_rate_limited`, `custom_domain_not_allowed`, `provision_conflict`, `not_enterprise_plan`; internal `POST /internal/provision-enterprise` with header `X-Internal-Api-Key`; responses on platform host may include `X-Mudbase-Warning: use_dedicated_api` for dedicated orgs. 
 
-The version of the OpenAPI document: 1.2.8
+The version of the OpenAPI document: 1.2.10
 Contact: support@mudbase.dev
 Generated by: https://openapi-generator.tech
 Generator version: 7.20.0
@@ -177,7 +177,7 @@ module Mudbase
     end
 
     # Add custom role
-    # Add a custom role to a project with specific permissions and signup endpoint. Accepts BearerToken (JWT) or ApiKeyAuth (X-API-Key). 
+    # Add a custom role to a project with specific permissions and signup endpoint. Optional **featurePermissions** must align with app JWT gates — see `components/schemas/AppRoleFeaturePermissions` and `services/appRoleFeatureMap.js`. Accepts BearerToken (JWT) or ApiKeyAuth (X-API-Key). 
     # @param project_id [String] Project ID.
     # @param multi_role_add_role_request [MultiRoleAddRoleRequest] Custom role definition. Use `collectionPermissions` to apply CRUD per collection slug (e.g. users/products/orders). `defaultPermissions` is optional for global/base permissions.
     # @param [Hash] opts the optional parameters
@@ -188,7 +188,7 @@ module Mudbase
     end
 
     # Add custom role
-    # Add a custom role to a project with specific permissions and signup endpoint. Accepts BearerToken (JWT) or ApiKeyAuth (X-API-Key). 
+    # Add a custom role to a project with specific permissions and signup endpoint. Optional **featurePermissions** must align with app JWT gates — see `components/schemas/AppRoleFeaturePermissions` and `services/appRoleFeatureMap.js`. Accepts BearerToken (JWT) or ApiKeyAuth (X-API-Key). 
     # @param project_id [String] Project ID.
     # @param multi_role_add_role_request [MultiRoleAddRoleRequest] Custom role definition. Use `collectionPermissions` to apply CRUD per collection slug (e.g. users/products/orders). `defaultPermissions` is optional for global/base permissions.
     # @param [Hash] opts the optional parameters
@@ -250,6 +250,86 @@ module Mudbase
       return data, status_code, headers
     end
 
+    # Apply Admin / User / Viewer feature permission preset
+    # Sets `featurePermissions` from preset `admin`, `user`, or `viewer`.
+    # @param project_id [String] 
+    # @param role_slug [String] 
+    # @param multi_role_apply_role_feature_preset_request [MultiRoleApplyRoleFeaturePresetRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [nil]
+    def multi_role_apply_role_feature_preset(project_id, role_slug, multi_role_apply_role_feature_preset_request, opts = {})
+      multi_role_apply_role_feature_preset_with_http_info(project_id, role_slug, multi_role_apply_role_feature_preset_request, opts)
+      nil
+    end
+
+    # Apply Admin / User / Viewer feature permission preset
+    # Sets `featurePermissions` from preset `admin`, `user`, or `viewer`.
+    # @param project_id [String] 
+    # @param role_slug [String] 
+    # @param multi_role_apply_role_feature_preset_request [MultiRoleApplyRoleFeaturePresetRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
+    def multi_role_apply_role_feature_preset_with_http_info(project_id, role_slug, multi_role_apply_role_feature_preset_request, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: MultiRoleApi.multi_role_apply_role_feature_preset ...'
+      end
+      # verify the required parameter 'project_id' is set
+      if @api_client.config.client_side_validation && project_id.nil?
+        fail ArgumentError, "Missing the required parameter 'project_id' when calling MultiRoleApi.multi_role_apply_role_feature_preset"
+      end
+      # verify the required parameter 'role_slug' is set
+      if @api_client.config.client_side_validation && role_slug.nil?
+        fail ArgumentError, "Missing the required parameter 'role_slug' when calling MultiRoleApi.multi_role_apply_role_feature_preset"
+      end
+      # verify the required parameter 'multi_role_apply_role_feature_preset_request' is set
+      if @api_client.config.client_side_validation && multi_role_apply_role_feature_preset_request.nil?
+        fail ArgumentError, "Missing the required parameter 'multi_role_apply_role_feature_preset_request' when calling MultiRoleApi.multi_role_apply_role_feature_preset"
+      end
+      # resource path
+      local_var_path = '/api/projects/{projectId}/multi-role/roles/{roleSlug}/apply-preset'.sub('{' + 'projectId' + '}', CGI.escape(project_id.to_s)).sub('{' + 'roleSlug' + '}', CGI.escape(role_slug.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
+      # HTTP header 'Content-Type'
+      content_type = @api_client.select_header_content_type(['application/json'])
+      if !content_type.nil?
+          header_params['Content-Type'] = content_type
+      end
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body] || @api_client.object_to_http_body(multi_role_apply_role_feature_preset_request)
+
+      # return_type
+      return_type = opts[:debug_return_type]
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['BearerToken']
+
+      new_options = opts.merge(
+        :operation => :"MultiRoleApi.multi_role_apply_role_feature_preset",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: MultiRoleApi#multi_role_apply_role_feature_preset\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Get available roles for signup
     # Get all available roles for user signup in a project. Accepts BearerToken (JWT) or ApiKeyAuth (X-API-Key). 
     # @param project_id [String] Project ID.
@@ -376,6 +456,139 @@ module Mudbase
       return data, status_code, headers
     end
 
+    # Get permissions matrix (collections + featurePermissions)
+    # Per-collection role actions and per-role `featurePermissions` for app-role gates.
+    # @param project_id [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [MultiRoleGetPermissionsMatrix200Response]
+    def multi_role_get_permissions_matrix(project_id, opts = {})
+      data, _status_code, _headers = multi_role_get_permissions_matrix_with_http_info(project_id, opts)
+      data
+    end
+
+    # Get permissions matrix (collections + featurePermissions)
+    # Per-collection role actions and per-role &#x60;featurePermissions&#x60; for app-role gates.
+    # @param project_id [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(MultiRoleGetPermissionsMatrix200Response, Integer, Hash)>] MultiRoleGetPermissionsMatrix200Response data, response status code and response headers
+    def multi_role_get_permissions_matrix_with_http_info(project_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: MultiRoleApi.multi_role_get_permissions_matrix ...'
+      end
+      # verify the required parameter 'project_id' is set
+      if @api_client.config.client_side_validation && project_id.nil?
+        fail ArgumentError, "Missing the required parameter 'project_id' when calling MultiRoleApi.multi_role_get_permissions_matrix"
+      end
+      # resource path
+      local_var_path = '/api/projects/{projectId}/permissions-matrix'.sub('{' + 'projectId' + '}', CGI.escape(project_id.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'MultiRoleGetPermissionsMatrix200Response'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['BearerToken']
+
+      new_options = opts.merge(
+        :operation => :"MultiRoleApi.multi_role_get_permissions_matrix",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: MultiRoleApi#multi_role_get_permissions_matrix\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # 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`.
+    # @param project_id [String] 
+    # @param multi_role_simulate_app_permissions_request [MultiRoleSimulateAppPermissionsRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [Object]
+    def multi_role_simulate_app_permissions(project_id, multi_role_simulate_app_permissions_request, opts = {})
+      data, _status_code, _headers = multi_role_simulate_app_permissions_with_http_info(project_id, multi_role_simulate_app_permissions_request, opts)
+      data
+    end
+
+    # Simulate app-role feature permission for a path
+    # Given role slug and either &#x60;operationId&#x60; or HTTP method + pathname, returns whether &#x60;featurePermissions&#x60; would allow gated routes. Unmapped paths or unknown operation IDs return allowed with &#x60;no_feature_gate_for_path&#x60; or &#x60;no_feature_gate_for_operation_id&#x60;.
+    # @param project_id [String] 
+    # @param multi_role_simulate_app_permissions_request [MultiRoleSimulateAppPermissionsRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(Object, Integer, Hash)>] Object data, response status code and response headers
+    def multi_role_simulate_app_permissions_with_http_info(project_id, multi_role_simulate_app_permissions_request, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: MultiRoleApi.multi_role_simulate_app_permissions ...'
+      end
+      # verify the required parameter 'project_id' is set
+      if @api_client.config.client_side_validation && project_id.nil?
+        fail ArgumentError, "Missing the required parameter 'project_id' when calling MultiRoleApi.multi_role_simulate_app_permissions"
+      end
+      # resource path
+      local_var_path = '/api/projects/{projectId}/multi-role/simulate-permissions'.sub('{' + 'projectId' + '}', CGI.escape(project_id.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
+      # HTTP header 'Content-Type'
+      content_type = @api_client.select_header_content_type(['application/json'])
+      if !content_type.nil?
+          header_params['Content-Type'] = content_type
+      end
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body] || @api_client.object_to_http_body(multi_role_simulate_app_permissions_request)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'Object'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['BearerToken']
+
+      new_options = opts.merge(
+        :operation => :"MultiRoleApi.multi_role_simulate_app_permissions",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: MultiRoleApi#multi_role_simulate_app_permissions\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Toggle role on/off
     # Enable or disable a role for the project. When disabled, the role is no longer available for signup or assignment.
     # @param project_id [String] Project ID.
@@ -543,7 +756,7 @@ module Mudbase
     end
 
     # Update role configuration
-    # Update an app role — same fields as **Add custom role** (partial). `defaultPermissions` / `collectionPermissions` use the same normalization as on create.
+    # Update an app role — same fields as **Add custom role** (partial). `defaultPermissions` / `collectionPermissions` use the same normalization as on create. **featurePermissions:** `components/schemas/AppRoleFeaturePermissions` (see `services/appRoleFeatureMap.js`).
     # @param project_id [String] Project ID.
     # @param role_slug [String] Role slug to update (e.g. starter &#x60;customer&#x60; or a role you added).
     # @param multi_role_update_role_request [MultiRoleUpdateRoleRequest] Same fields as **Add custom role** — send only fields you want to change. &#x60;defaultPermissions&#x60; / &#x60;collectionPermissions&#x60; are normalized the same way as on create.
@@ -555,7 +768,7 @@ module Mudbase
     end
 
     # Update role configuration
-    # Update an app role — same fields as **Add custom role** (partial). &#x60;defaultPermissions&#x60; / &#x60;collectionPermissions&#x60; use the same normalization as on create.
+    # Update an app role — same fields as **Add custom role** (partial). &#x60;defaultPermissions&#x60; / &#x60;collectionPermissions&#x60; use the same normalization as on create. **featurePermissions:** &#x60;components/schemas/AppRoleFeaturePermissions&#x60; (see &#x60;services/appRoleFeatureMap.js&#x60;).
     # @param project_id [String] Project ID.
     # @param role_slug [String] Role slug to update (e.g. starter &#x60;customer&#x60; or a role you added).
     # @param multi_role_update_role_request [MultiRoleUpdateRoleRequest] Same fields as **Add custom role** — send only fields you want to change. &#x60;defaultPermissions&#x60; / &#x60;collectionPermissions&#x60; are normalized the same way as on create.
@@ -623,9 +836,9 @@ module Mudbase
     end
 
     # Update multi-role feature settings
-    # Update multi-role feature settings: enable/disable the feature, `defaultRole`, and `settings` (`allowMultipleRoles`, `requireRoleSelection`, `autoAssignDefault`). 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: 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). 
     # @param project_id [String] Project ID.
-    # @param multi_role_update_settings_request [MultiRoleUpdateSettingsRequest] Feature flags only — not per-role approval. Use &#x60;settings.allowMultipleRoles&#x60;, &#x60;requireRoleSelection&#x60;, &#x60;autoAssignDefault&#x60;.
+    # @param multi_role_update_settings_request [MultiRoleUpdateSettingsRequest] Feature flags only — not per-role approval. Use &#x60;settings.allowMultipleRoles&#x60;, &#x60;requireRoleSelection&#x60;, &#x60;autoAssignDefault&#x60;, &#x60;dataOwnerField&#x60;.
     # @param [Hash] opts the optional parameters
     # @return [MultiRoleUpdateSettings200Response]
     def multi_role_update_settings(project_id, multi_role_update_settings_request, opts = {})
@@ -634,9 +847,9 @@ module Mudbase
     end
 
     # Update multi-role feature settings
-    # Update multi-role feature settings: enable/disable the feature, &#x60;defaultRole&#x60;, and &#x60;settings&#x60; (&#x60;allowMultipleRoles&#x60;, &#x60;requireRoleSelection&#x60;, &#x60;autoAssignDefault&#x60;). Does not edit role definitions — use &#x60;POST/PATCH .../multi-role/roles&#x60; (same body shape as add role). Accepts BearerToken (JWT) or ApiKeyAuth (X-API-Key). 
+    # Update multi-role feature settings: enable/disable the feature, &#x60;defaultRole&#x60;, and &#x60;settings&#x60; (&#x60;allowMultipleRoles&#x60;, &#x60;requireRoleSelection&#x60;, &#x60;autoAssignDefault&#x60;, &#x60;dataOwnerField&#x60;). Does not edit role definitions — use &#x60;POST/PATCH .../multi-role/roles&#x60; (same body shape as add role). Accepts BearerToken (JWT) or ApiKeyAuth (X-API-Key). 
     # @param project_id [String] Project ID.
-    # @param multi_role_update_settings_request [MultiRoleUpdateSettingsRequest] Feature flags only — not per-role approval. Use &#x60;settings.allowMultipleRoles&#x60;, &#x60;requireRoleSelection&#x60;, &#x60;autoAssignDefault&#x60;.
+    # @param multi_role_update_settings_request [MultiRoleUpdateSettingsRequest] Feature flags only — not per-role approval. Use &#x60;settings.allowMultipleRoles&#x60;, &#x60;requireRoleSelection&#x60;, &#x60;autoAssignDefault&#x60;, &#x60;dataOwnerField&#x60;.
     # @param [Hash] opts the optional parameters
     # @return [Array<(MultiRoleUpdateSettings200Response, Integer, Hash)>] MultiRoleUpdateSettings200Response data, response status code and response headers
     def multi_role_update_settings_with_http_info(project_id, multi_role_update_settings_request, opts = {})