mudbase 1.1.4

data/lib/mudbase/api/search_api.rb

@@ -0,0 +1,263 @@
+=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)  ## Testing Configurations Below are example configurations for testing in different environments:  ### Production ```json {   \"scheme\": \"http\",   \"base_path\": \"\",   \"host\": \"cloud.mudbase.dev\",   \"xApiKey\": \"xApiKey\",   \"bearerToken\": \"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjY4NWFjYmUwZTEyOTkzMmZiYjdhMGZjMiIsImVtYWlsIjoibXVkaGF4a3NlcnZpY2VzQGdtYWlsLmNvbSIsImlhdCI6MTc1MDc4MDg5OCwiZXhwIjoxNzUwODY3Mjk4fQ.sfoqzEbCuz5Y8qHkLItzrZZYC823SPT4RbO7Kucqvuc\",   \"userId\": \"685acbe0e129932fbb7a0fc2\",   \"projectId\": \"685ad30be129932fbb7a1047\",   \"collectionId\": \"685ada8fd9416ac02f171abf\",   \"documentId\": \"685ae1210136e73fa1dcaf36\",   \"apikeyId\": \"685ae8a785426b6a4190d5fc\",   \"webhookId\": \"685af3992f9c4c96514247e9\",   \"functionId\": \"685af8b85d73a104065b6a77\",   \"fileId\": \"685af8b85d73a104065b6a77\" } 
+
+The version of the OpenAPI document: 1.1.4
+Contact: support@mudbase.dev
+Generated by: https://openapi-generator.tech
+Generator version: 7.20.0
+
+=end
+
+require 'cgi'
+
+module Mudbase
+  class SearchApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # Get search analytics
+    # Get search analytics including top queries, search volume, and performance metrics. Accepts ProjectBearerAuth (JWT) or ApiKeyAuth (X-API-Key). 
+    # @param project_id [String] Project ID (MongoDB ObjectId) to get analytics for.
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :timeframe Timeframe for analytics (1d, 7d, or 30d). (default to '7d')
+    # @return [GetSearchAnalytics200Response]
+    def get_search_analytics(project_id, opts = {})
+      data, _status_code, _headers = get_search_analytics_with_http_info(project_id, opts)
+      data
+    end
+
+    # Get search analytics
+    # Get search analytics including top queries, search volume, and performance metrics. Accepts ProjectBearerAuth (JWT) or ApiKeyAuth (X-API-Key). 
+    # @param project_id [String] Project ID (MongoDB ObjectId) to get analytics for.
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :timeframe Timeframe for analytics (1d, 7d, or 30d). (default to '7d')
+    # @return [Array<(GetSearchAnalytics200Response, Integer, Hash)>] GetSearchAnalytics200Response data, response status code and response headers
+    def get_search_analytics_with_http_info(project_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: SearchApi.get_search_analytics ...'
+      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 SearchApi.get_search_analytics"
+      end
+      allowable_values = ["1d", "7d", "30d"]
+      if @api_client.config.client_side_validation && opts[:'timeframe'] && !allowable_values.include?(opts[:'timeframe'])
+        fail ArgumentError, "invalid value for \"timeframe\", must be one of #{allowable_values}"
+      end
+      # resource path
+      local_var_path = '/api/search/projects/{projectId}/search/analytics'.sub('{' + 'projectId' + '}', CGI.escape(project_id.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'timeframe'] = opts[:'timeframe'] if !opts[:'timeframe'].nil?
+
+      # 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] || 'GetSearchAnalytics200Response'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['ProjectBearerAuth']
+
+      new_options = opts.merge(
+        :operation => :"SearchApi.get_search_analytics",
+        :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: SearchApi#get_search_analytics\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Get search suggestions
+    # Get search query suggestions based on partial input. Accepts ProjectBearerAuth (JWT) or ApiKeyAuth (X-API-Key). 
+    # @param project_id [String] Project ID (MongoDB ObjectId) to get suggestions for.
+    # @param q [String] Partial search query (min 2 characters, max 50); suggestions are based on past queries and indexed content.
+    # @param [Hash] opts the optional parameters
+    # @option opts [Integer] :limit Maximum number of suggestions to return (1–20). (default to 10)
+    # @return [GetSearchSuggestions200Response]
+    def get_search_suggestions(project_id, q, opts = {})
+      data, _status_code, _headers = get_search_suggestions_with_http_info(project_id, q, opts)
+      data
+    end
+
+    # Get search suggestions
+    # Get search query suggestions based on partial input. Accepts ProjectBearerAuth (JWT) or ApiKeyAuth (X-API-Key). 
+    # @param project_id [String] Project ID (MongoDB ObjectId) to get suggestions for.
+    # @param q [String] Partial search query (min 2 characters, max 50); suggestions are based on past queries and indexed content.
+    # @param [Hash] opts the optional parameters
+    # @option opts [Integer] :limit Maximum number of suggestions to return (1–20). (default to 10)
+    # @return [Array<(GetSearchSuggestions200Response, Integer, Hash)>] GetSearchSuggestions200Response data, response status code and response headers
+    def get_search_suggestions_with_http_info(project_id, q, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: SearchApi.get_search_suggestions ...'
+      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 SearchApi.get_search_suggestions"
+      end
+      # verify the required parameter 'q' is set
+      if @api_client.config.client_side_validation && q.nil?
+        fail ArgumentError, "Missing the required parameter 'q' when calling SearchApi.get_search_suggestions"
+      end
+      if @api_client.config.client_side_validation && q.to_s.length > 50
+        fail ArgumentError, 'invalid value for "q" when calling SearchApi.get_search_suggestions, the character length must be smaller than or equal to 50.'
+      end
+
+      if @api_client.config.client_side_validation && q.to_s.length < 2
+        fail ArgumentError, 'invalid value for "q" when calling SearchApi.get_search_suggestions, the character length must be greater than or equal to 2.'
+      end
+
+      if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] > 20
+        fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling SearchApi.get_search_suggestions, must be smaller than or equal to 20.'
+      end
+
+      if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] < 1
+        fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling SearchApi.get_search_suggestions, must be greater than or equal to 1.'
+      end
+
+      # resource path
+      local_var_path = '/api/search/projects/{projectId}/search/suggestions'.sub('{' + 'projectId' + '}', CGI.escape(project_id.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'q'] = q
+      query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
+
+      # 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] || 'GetSearchSuggestions200Response'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['ProjectBearerAuth']
+
+      new_options = opts.merge(
+        :operation => :"SearchApi.get_search_suggestions",
+        :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: SearchApi#get_search_suggestions\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Full-text search
+    # Perform full-text search across collections in a project. Accepts ProjectBearerAuth (JWT) or ApiKeyAuth (X-API-Key). 
+    # @param project_id [String] Project ID (MongoDB ObjectId) to search within.
+    # @param q [String] Full-text search query string.
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :collections Comma-separated collection slugs or IDs to limit search scope.
+    # @option opts [String] :fields Comma-separated field names to search or return in highlights.
+    # @option opts [Integer] :limit Maximum number of results to return per page. (default to 20)
+    # @option opts [Integer] :page Page number for pagination (1-based). (default to 1)
+    # @return [SearchResponse]
+    def search_data(project_id, q, opts = {})
+      data, _status_code, _headers = search_data_with_http_info(project_id, q, opts)
+      data
+    end
+
+    # Full-text search
+    # Perform full-text search across collections in a project. Accepts ProjectBearerAuth (JWT) or ApiKeyAuth (X-API-Key). 
+    # @param project_id [String] Project ID (MongoDB ObjectId) to search within.
+    # @param q [String] Full-text search query string.
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :collections Comma-separated collection slugs or IDs to limit search scope.
+    # @option opts [String] :fields Comma-separated field names to search or return in highlights.
+    # @option opts [Integer] :limit Maximum number of results to return per page. (default to 20)
+    # @option opts [Integer] :page Page number for pagination (1-based). (default to 1)
+    # @return [Array<(SearchResponse, Integer, Hash)>] SearchResponse data, response status code and response headers
+    def search_data_with_http_info(project_id, q, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: SearchApi.search_data ...'
+      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 SearchApi.search_data"
+      end
+      # verify the required parameter 'q' is set
+      if @api_client.config.client_side_validation && q.nil?
+        fail ArgumentError, "Missing the required parameter 'q' when calling SearchApi.search_data"
+      end
+      # resource path
+      local_var_path = '/api/search/projects/{projectId}/search'.sub('{' + 'projectId' + '}', CGI.escape(project_id.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'q'] = q
+      query_params[:'collections'] = opts[:'collections'] if !opts[:'collections'].nil?
+      query_params[:'fields'] = opts[:'fields'] if !opts[:'fields'].nil?
+      query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
+      query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
+
+      # 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] || 'SearchResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['ProjectBearerAuth']
+
+      new_options = opts.merge(
+        :operation => :"SearchApi.search_data",
+        :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: SearchApi#search_data\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end

data/lib/mudbase/api/usage_api.rb

@@ -0,0 +1,152 @@
+=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)  ## Testing Configurations Below are example configurations for testing in different environments:  ### Production ```json {   \"scheme\": \"http\",   \"base_path\": \"\",   \"host\": \"cloud.mudbase.dev\",   \"xApiKey\": \"xApiKey\",   \"bearerToken\": \"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjY4NWFjYmUwZTEyOTkzMmZiYjdhMGZjMiIsImVtYWlsIjoibXVkaGF4a3NlcnZpY2VzQGdtYWlsLmNvbSIsImlhdCI6MTc1MDc4MDg5OCwiZXhwIjoxNzUwODY3Mjk4fQ.sfoqzEbCuz5Y8qHkLItzrZZYC823SPT4RbO7Kucqvuc\",   \"userId\": \"685acbe0e129932fbb7a0fc2\",   \"projectId\": \"685ad30be129932fbb7a1047\",   \"collectionId\": \"685ada8fd9416ac02f171abf\",   \"documentId\": \"685ae1210136e73fa1dcaf36\",   \"apikeyId\": \"685ae8a785426b6a4190d5fc\",   \"webhookId\": \"685af3992f9c4c96514247e9\",   \"functionId\": \"685af8b85d73a104065b6a77\",   \"fileId\": \"685af8b85d73a104065b6a77\" } 
+
+The version of the OpenAPI document: 1.1.4
+Contact: support@mudbase.dev
+Generated by: https://openapi-generator.tech
+Generator version: 7.20.0
+
+=end
+
+require 'cgi'
+
+module Mudbase
+  class UsageApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # Get project usage
+    # Get usage statistics for a project (API calls, storage, bandwidth, database operations). Accepts ProjectBearerAuth (JWT) or ApiKeyAuth (X-API-Key). 
+    # @param project_id [String] Project ID (MongoDB ObjectId) to get usage for.
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :period Aggregation period for usage (day, week, or month). (default to 'month')
+    # @return [ProjectUsageStatsResponse]
+    def get_project_usage_stats(project_id, opts = {})
+      data, _status_code, _headers = get_project_usage_stats_with_http_info(project_id, opts)
+      data
+    end
+
+    # Get project usage
+    # Get usage statistics for a project (API calls, storage, bandwidth, database operations). Accepts ProjectBearerAuth (JWT) or ApiKeyAuth (X-API-Key). 
+    # @param project_id [String] Project ID (MongoDB ObjectId) to get usage for.
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :period Aggregation period for usage (day, week, or month). (default to 'month')
+    # @return [Array<(ProjectUsageStatsResponse, Integer, Hash)>] ProjectUsageStatsResponse data, response status code and response headers
+    def get_project_usage_stats_with_http_info(project_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: UsageApi.get_project_usage_stats ...'
+      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 UsageApi.get_project_usage_stats"
+      end
+      allowable_values = ["day", "week", "month"]
+      if @api_client.config.client_side_validation && opts[:'period'] && !allowable_values.include?(opts[:'period'])
+        fail ArgumentError, "invalid value for \"period\", must be one of #{allowable_values}"
+      end
+      # resource path
+      local_var_path = '/api/usage/projects/{projectId}'.sub('{' + 'projectId' + '}', CGI.escape(project_id.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'period'] = opts[:'period'] if !opts[:'period'].nil?
+
+      # 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] || 'ProjectUsageStatsResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['ProjectBearerAuth']
+
+      new_options = opts.merge(
+        :operation => :"UsageApi.get_project_usage_stats",
+        :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: UsageApi#get_project_usage_stats\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Get usage trends
+    # Get usage trends over time for the authenticated organization or project. Accepts ProjectBearerAuth (JWT) or ApiKeyAuth (X-API-Key). 
+    # @param [Hash] opts the optional parameters
+    # @option opts [Integer] :days Number of days of trend data to return (default 30). (default to 30)
+    # @return [UsageTrendsResponse]
+    def get_usage_trends(opts = {})
+      data, _status_code, _headers = get_usage_trends_with_http_info(opts)
+      data
+    end
+
+    # Get usage trends
+    # Get usage trends over time for the authenticated organization or project. Accepts ProjectBearerAuth (JWT) or ApiKeyAuth (X-API-Key). 
+    # @param [Hash] opts the optional parameters
+    # @option opts [Integer] :days Number of days of trend data to return (default 30). (default to 30)
+    # @return [Array<(UsageTrendsResponse, Integer, Hash)>] UsageTrendsResponse data, response status code and response headers
+    def get_usage_trends_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: UsageApi.get_usage_trends ...'
+      end
+      # resource path
+      local_var_path = '/api/usage/trends'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'days'] = opts[:'days'] if !opts[:'days'].nil?
+
+      # 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] || 'UsageTrendsResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['ProjectBearerAuth']
+
+      new_options = opts.merge(
+        :operation => :"UsageApi.get_usage_trends",
+        :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: UsageApi#get_usage_trends\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end