mudbase 1.1.4

data/docs/RealTimeAnalyticsApi.md

@@ -0,0 +1,367 @@
+# Mudbase::RealTimeAnalyticsApi
+
+All URIs are relative to *https://cloud.mudbase.dev*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**check_user_presence**](RealTimeAnalyticsApi.md#check_user_presence) | **POST** /api/realtime/projects/{projectId}/presence | Check presence status for users |
+| [**get_active_users**](RealTimeAnalyticsApi.md#get_active_users) | **GET** /api/realtime/projects/{projectId}/active-users | Get active users for a project |
+| [**get_event_throughput**](RealTimeAnalyticsApi.md#get_event_throughput) | **GET** /api/realtime/projects/{projectId}/throughput | Get event throughput metrics |
+| [**get_historical_analytics**](RealTimeAnalyticsApi.md#get_historical_analytics) | **GET** /api/realtime/projects/{projectId}/history | Get historical analytics |
+| [**get_project_analytics**](RealTimeAnalyticsApi.md#get_project_analytics) | **GET** /api/realtime/projects/{projectId}/analytics | Get project real-time analytics |
+
+
+## check_user_presence
+
+> <CheckUserPresence200Response> check_user_presence(project_id, check_user_presence_request)
+
+Check presence status for users
+
+Returns online status for specified user IDs
+
+### Examples
+
+```ruby
+require 'time'
+require 'mudbase'
+# setup authorization
+Mudbase.configure do |config|
+  # Configure Bearer authorization (JWT): ProjectBearerAuth
+  config.access_token = 'YOUR_BEARER_TOKEN'
+end
+
+api_instance = Mudbase::RealTimeAnalyticsApi.new
+project_id = 'project_id_example' # String | Project ID.
+check_user_presence_request = Mudbase::CheckUserPresenceRequest.new({user_ids: ["685acbe0e129932fbb7a0fc2", "685acbe0e129932fbb7a0fc3"]}) # CheckUserPresenceRequest | Array of user IDs to check presence for.
+
+begin
+  # Check presence status for users
+  result = api_instance.check_user_presence(project_id, check_user_presence_request)
+  p result
+rescue Mudbase::ApiError => e
+  puts "Error when calling RealTimeAnalyticsApi->check_user_presence: #{e}"
+end
+```
+
+#### Using the check_user_presence_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<CheckUserPresence200Response>, Integer, Hash)> check_user_presence_with_http_info(project_id, check_user_presence_request)
+
+```ruby
+begin
+  # Check presence status for users
+  data, status_code, headers = api_instance.check_user_presence_with_http_info(project_id, check_user_presence_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <CheckUserPresence200Response>
+rescue Mudbase::ApiError => e
+  puts "Error when calling RealTimeAnalyticsApi->check_user_presence_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **project_id** | **String** | Project ID. |  |
+| **check_user_presence_request** | [**CheckUserPresenceRequest**](CheckUserPresenceRequest.md) | Array of user IDs to check presence for. |  |
+
+### Return type
+
+[**CheckUserPresence200Response**](CheckUserPresence200Response.md)
+
+### Authorization
+
+[ProjectBearerAuth](../README.md#ProjectBearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## get_active_users
+
+> <GetActiveUsers200Response> get_active_users(project_id)
+
+Get active users for a project
+
+Returns list of currently connected users
+
+### Examples
+
+```ruby
+require 'time'
+require 'mudbase'
+# setup authorization
+Mudbase.configure do |config|
+  # Configure Bearer authorization (JWT): ProjectBearerAuth
+  config.access_token = 'YOUR_BEARER_TOKEN'
+end
+
+api_instance = Mudbase::RealTimeAnalyticsApi.new
+project_id = 'project_id_example' # String | Project ID.
+
+begin
+  # Get active users for a project
+  result = api_instance.get_active_users(project_id)
+  p result
+rescue Mudbase::ApiError => e
+  puts "Error when calling RealTimeAnalyticsApi->get_active_users: #{e}"
+end
+```
+
+#### Using the get_active_users_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<GetActiveUsers200Response>, Integer, Hash)> get_active_users_with_http_info(project_id)
+
+```ruby
+begin
+  # Get active users for a project
+  data, status_code, headers = api_instance.get_active_users_with_http_info(project_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <GetActiveUsers200Response>
+rescue Mudbase::ApiError => e
+  puts "Error when calling RealTimeAnalyticsApi->get_active_users_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **project_id** | **String** | Project ID. |  |
+
+### Return type
+
+[**GetActiveUsers200Response**](GetActiveUsers200Response.md)
+
+### Authorization
+
+[ProjectBearerAuth](../README.md#ProjectBearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## get_event_throughput
+
+> <GetEventThroughput200Response> get_event_throughput(project_id, opts)
+
+Get event throughput metrics
+
+Returns event throughput for a project
+
+### Examples
+
+```ruby
+require 'time'
+require 'mudbase'
+# setup authorization
+Mudbase.configure do |config|
+  # Configure Bearer authorization (JWT): ProjectBearerAuth
+  config.access_token = 'YOUR_BEARER_TOKEN'
+end
+
+api_instance = Mudbase::RealTimeAnalyticsApi.new
+project_id = 'project_id_example' # String | Project ID.
+opts = {
+  window: 56 # Integer | Time window in milliseconds
+}
+
+begin
+  # Get event throughput metrics
+  result = api_instance.get_event_throughput(project_id, opts)
+  p result
+rescue Mudbase::ApiError => e
+  puts "Error when calling RealTimeAnalyticsApi->get_event_throughput: #{e}"
+end
+```
+
+#### Using the get_event_throughput_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<GetEventThroughput200Response>, Integer, Hash)> get_event_throughput_with_http_info(project_id, opts)
+
+```ruby
+begin
+  # Get event throughput metrics
+  data, status_code, headers = api_instance.get_event_throughput_with_http_info(project_id, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <GetEventThroughput200Response>
+rescue Mudbase::ApiError => e
+  puts "Error when calling RealTimeAnalyticsApi->get_event_throughput_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **project_id** | **String** | Project ID. |  |
+| **window** | **Integer** | Time window in milliseconds | [optional][default to 60000] |
+
+### Return type
+
+[**GetEventThroughput200Response**](GetEventThroughput200Response.md)
+
+### Authorization
+
+[ProjectBearerAuth](../README.md#ProjectBearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## get_historical_analytics
+
+> <GetHistoricalAnalytics200Response> get_historical_analytics(project_id, opts)
+
+Get historical analytics
+
+Returns historical analytics for charting
+
+### Examples
+
+```ruby
+require 'time'
+require 'mudbase'
+# setup authorization
+Mudbase.configure do |config|
+  # Configure Bearer authorization (JWT): ProjectBearerAuth
+  config.access_token = 'YOUR_BEARER_TOKEN'
+end
+
+api_instance = Mudbase::RealTimeAnalyticsApi.new
+project_id = 'project_id_example' # String | Project ID.
+opts = {
+  period: 'hour' # String | Time period for historical data
+}
+
+begin
+  # Get historical analytics
+  result = api_instance.get_historical_analytics(project_id, opts)
+  p result
+rescue Mudbase::ApiError => e
+  puts "Error when calling RealTimeAnalyticsApi->get_historical_analytics: #{e}"
+end
+```
+
+#### Using the get_historical_analytics_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<GetHistoricalAnalytics200Response>, Integer, Hash)> get_historical_analytics_with_http_info(project_id, opts)
+
+```ruby
+begin
+  # Get historical analytics
+  data, status_code, headers = api_instance.get_historical_analytics_with_http_info(project_id, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <GetHistoricalAnalytics200Response>
+rescue Mudbase::ApiError => e
+  puts "Error when calling RealTimeAnalyticsApi->get_historical_analytics_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **project_id** | **String** | Project ID. |  |
+| **period** | **String** | Time period for historical data | [optional][default to &#39;hour&#39;] |
+
+### Return type
+
+[**GetHistoricalAnalytics200Response**](GetHistoricalAnalytics200Response.md)
+
+### Authorization
+
+[ProjectBearerAuth](../README.md#ProjectBearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## get_project_analytics
+
+> <GetProjectAnalytics200Response> get_project_analytics(project_id)
+
+Get project real-time analytics
+
+Returns real-time metrics for a specific project (active connections, events, etc.)
+
+### Examples
+
+```ruby
+require 'time'
+require 'mudbase'
+# setup authorization
+Mudbase.configure do |config|
+  # Configure Bearer authorization (JWT): ProjectBearerAuth
+  config.access_token = 'YOUR_BEARER_TOKEN'
+end
+
+api_instance = Mudbase::RealTimeAnalyticsApi.new
+project_id = '685ad30be129932fbb7a1047' # String | Project ID (MongoDB ObjectId) to get real-time analytics for.
+
+begin
+  # Get project real-time analytics
+  result = api_instance.get_project_analytics(project_id)
+  p result
+rescue Mudbase::ApiError => e
+  puts "Error when calling RealTimeAnalyticsApi->get_project_analytics: #{e}"
+end
+```
+
+#### Using the get_project_analytics_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<GetProjectAnalytics200Response>, Integer, Hash)> get_project_analytics_with_http_info(project_id)
+
+```ruby
+begin
+  # Get project real-time analytics
+  data, status_code, headers = api_instance.get_project_analytics_with_http_info(project_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <GetProjectAnalytics200Response>
+rescue Mudbase::ApiError => e
+  puts "Error when calling RealTimeAnalyticsApi->get_project_analytics_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **project_id** | **String** | Project ID (MongoDB ObjectId) to get real-time analytics for. |  |
+
+### Return type
+
+[**GetProjectAnalytics200Response**](GetProjectAnalytics200Response.md)
+
+### Authorization
+
+[ProjectBearerAuth](../README.md#ProjectBearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+

data/docs/RecordUsageRequest.md

@@ -0,0 +1,22 @@
+# Mudbase::RecordUsageRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **email** | **String** | Customer email |  |
+| **metric** | **String** | Usage metric name (e.g. api_calls, storage_mb) |  |
+| **quantity** | **Float** | Quantity to record |  |
+
+## Example
+
+```ruby
+require 'mudbase'
+
+instance = Mudbase::RecordUsageRequest.new(
+  email: null,
+  metric: null,
+  quantity: null
+)
+```
+

data/docs/RegisterLocalUser201Response.md

@@ -0,0 +1,28 @@
+# Mudbase::RegisterLocalUser201Response
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **message** | **String** |  | [optional] |
+| **require_verification** | **Boolean** | true when email verification is required; no token in response | [optional] |
+| **token** | **String** | Present only when requireEmailVerification is false | [optional] |
+| **refresh_token** | **String** | Present only when requireEmailVerification is false | [optional] |
+| **expires_in** | **Integer** | Present only when token is returned | [optional] |
+| **user** | [**RegisterLocalUser201ResponseUser**](RegisterLocalUser201ResponseUser.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'mudbase'
+
+instance = Mudbase::RegisterLocalUser201Response.new(
+  message: null,
+  require_verification: null,
+  token: null,
+  refresh_token: null,
+  expires_in: null,
+  user: null
+)
+```
+

data/docs/RegisterLocalUser201ResponseUser.md

@@ -0,0 +1,28 @@
+# Mudbase::RegisterLocalUser201ResponseUser
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  | [optional] |
+| **email** | **String** |  | [optional] |
+| **first_name** | **String** |  | [optional] |
+| **last_name** | **String** |  | [optional] |
+| **email_verified** | **Boolean** |  | [optional] |
+| **custom_role** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'mudbase'
+
+instance = Mudbase::RegisterLocalUser201ResponseUser.new(
+  id: null,
+  email: null,
+  first_name: null,
+  last_name: null,
+  email_verified: null,
+  custom_role: null
+)
+```
+

data/docs/RegisterLocalUser429Response.md

@@ -0,0 +1,30 @@
+# Mudbase::RegisterLocalUser429Response
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **error** | **String** |  | [optional] |
+| **code** | **String** |  | [optional] |
+| **details** | [**ErrorDetails**](ErrorDetails.md) |  | [optional] |
+| **timestamp** | **Time** |  | [optional] |
+| **path** | **String** |  | [optional] |
+| **request_id** | **String** |  | [optional] |
+| **retry_after** | **Integer** |  | [optional] |
+
+## Example
+
+```ruby
+require 'mudbase'
+
+instance = Mudbase::RegisterLocalUser429Response.new(
+  error: null,
+  code: null,
+  details: null,
+  timestamp: null,
+  path: null,
+  request_id: null,
+  retry_after: null
+)
+```
+

data/docs/RegisterLocalUserRequest.md

@@ -0,0 +1,26 @@
+# Mudbase::RegisterLocalUserRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **email** | **String** |  |  |
+| **password** | **String** |  |  |
+| **first_name** | **String** |  |  |
+| **last_name** | **String** |  |  |
+| **project_id** | **String** |  |  |
+
+## Example
+
+```ruby
+require 'mudbase'
+
+instance = Mudbase::RegisterLocalUserRequest.new(
+  email: null,
+  password: null,
+  first_name: null,
+  last_name: null,
+  project_id: null
+)
+```
+

data/docs/RegisterNonCustodialAddressRequest.md

@@ -0,0 +1,26 @@
+# Mudbase::RegisterNonCustodialAddressRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **address** | **String** | Public wallet address |  |
+| **chain** | **String** | Blockchain network (EVM, UTXO, or chain-specific). Use bsc or binance for BNB Smart Chain; avalanche for Avalanche C-Chain. |  |
+| **derivation_path** | **String** | HD wallet derivation path (metadata only) | [optional] |
+| **label** | **String** | Optional label for the address | [optional] |
+| **project_id** | **String** | Optional project ID | [optional] |
+
+## Example
+
+```ruby
+require 'mudbase'
+
+instance = Mudbase::RegisterNonCustodialAddressRequest.new(
+  address: 0x742d35Cc6634C0532925a3b844Bc9e7595f0bEb,
+  chain: null,
+  derivation_path: m/44'/60'/0'/0/5,
+  label: User Wallet 5,
+  project_id: null
+)
+```
+

data/docs/RegisterRequest.md

@@ -0,0 +1,26 @@
+# Mudbase::RegisterRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **email** | **String** |  |  |
+| **password** | **String** |  |  |
+| **first_name** | **String** |  |  |
+| **last_name** | **String** |  |  |
+| **org_name** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'mudbase'
+
+instance = Mudbase::RegisterRequest.new(
+  email: john.doe@mudbase.dev,
+  password: SecurePass123!,
+  first_name: John,
+  last_name: Doe,
+  org_name: Mudbase
+)
+```
+

data/docs/RegisterWithRoleRequest.md

@@ -0,0 +1,26 @@
+# Mudbase::RegisterWithRoleRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **email** | **String** |  |  |
+| **password** | **String** |  |  |
+| **first_name** | **String** |  |  |
+| **last_name** | **String** |  |  |
+| **project_id** | **String** |  |  |
+
+## Example
+
+```ruby
+require 'mudbase'
+
+instance = Mudbase::RegisterWithRoleRequest.new(
+  email: null,
+  password: null,
+  first_name: null,
+  last_name: null,
+  project_id: null
+)
+```
+

data/docs/RemoveParticipantRequest.md

@@ -0,0 +1,18 @@
+# Mudbase::RemoveParticipantRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **user_id** | **String** |  |  |
+
+## Example
+
+```ruby
+require 'mudbase'
+
+instance = Mudbase::RemoveParticipantRequest.new(
+  user_id: null
+)
+```
+

data/docs/RemoveReaction200Response.md

@@ -0,0 +1,20 @@
+# Mudbase::RemoveReaction200Response
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **success** | **Boolean** |  | [optional] |
+| **data** | [**Array<RemoveReaction200ResponseDataInner>**](RemoveReaction200ResponseDataInner.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'mudbase'
+
+instance = Mudbase::RemoveReaction200Response.new(
+  success: null,
+  data: null
+)
+```
+

data/docs/RemoveReaction200ResponseDataInner.md

@@ -0,0 +1,22 @@
+# Mudbase::RemoveReaction200ResponseDataInner
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **emoji** | **String** |  | [optional] |
+| **count** | **Integer** |  | [optional] |
+| **users** | **Array<String>** |  | [optional] |
+
+## Example
+
+```ruby
+require 'mudbase'
+
+instance = Mudbase::RemoveReaction200ResponseDataInner.new(
+  emoji: null,
+  count: null,
+  users: null
+)
+```
+

data/docs/RequestLocalPasswordResetRequest.md

@@ -0,0 +1,20 @@
+# Mudbase::RequestLocalPasswordResetRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **email** | **String** |  |  |
+| **project_id** | **String** | Required for project-based reset (sends OTP). Omit for org token link. | [optional] |
+
+## Example
+
+```ruby
+require 'mudbase'
+
+instance = Mudbase::RequestLocalPasswordResetRequest.new(
+  email: user@example.com,
+  project_id: 685ad30be129932fbb7a1047
+)
+```
+

data/docs/RequestRoleElevation200Response.md

@@ -0,0 +1,28 @@
+# Mudbase::RequestRoleElevation200Response
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **message** | **String** |  | [optional] |
+| **request_id** | **String** |  | [optional] |
+| **workflow** | **String** |  | [optional] |
+| **status** | **String** |  | [optional] |
+| **next_steps** | **Array<String>** |  | [optional] |
+| **estimated_approval_time** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'mudbase'
+
+instance = Mudbase::RequestRoleElevation200Response.new(
+  message: null,
+  request_id: null,
+  workflow: null,
+  status: null,
+  next_steps: null,
+  estimated_approval_time: null
+)
+```
+