mudbase 1.0.0

data/docs/Project.md

@@ -0,0 +1,40 @@
+# Mudbase::Project
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **_id** | **String** |  | [optional] |
+| **name** | **String** |  | [optional] |
+| **description** | **String** |  | [optional] |
+| **slug** | **String** |  | [optional] |
+| **org** | **String** |  | [optional] |
+| **auth** | [**AuthConfig**](AuthConfig.md) |  | [optional] |
+| **database** | [**DatabaseConfig**](DatabaseConfig.md) |  | [optional] |
+| **storage** | [**StorageConfig**](StorageConfig.md) |  | [optional] |
+| **settings** | [**ProjectSettings**](ProjectSettings.md) |  | [optional] |
+| **usage** | [**ProjectUsage**](ProjectUsage.md) |  | [optional] |
+| **created_at** | **Time** |  | [optional] |
+| **updated_at** | **Time** |  | [optional] |
+
+## Example
+
+```ruby
+require 'mudbase'
+
+instance = Mudbase::Project.new(
+  _id: null,
+  name: null,
+  description: null,
+  slug: null,
+  org: null,
+  auth: null,
+  database: null,
+  storage: null,
+  settings: null,
+  usage: null,
+  created_at: null,
+  updated_at: null
+)
+```
+

data/docs/ProjectSettings.md

@@ -0,0 +1,30 @@
+# Mudbase::ProjectSettings
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **allow_anonymous_auth** | **Boolean** | Allow anonymous (unauthenticated) users | [optional][default to true] |
+| **require_email_verification** | **Boolean** | When true, users who sign up with email do not receive a token until they verify their email; login is blocked until verified. | [optional][default to true] |
+| **require_phone_verification** | **Boolean** | When true, users who sign in with phone (e.g. OTP) must have verified their phone before receiving a token. | [optional][default to false] |
+| **default_user_account_status** | **String** | Default account status for new signups. **active** = user can use the app immediately. **pending** = user must be approved by an org owner/admin (PATCH org user status to active) before they can perform protected operations.  | [optional][default to 'active'] |
+| **enable_realtime** | **Boolean** |  | [optional][default to true] |
+| **enable_storage** | **Boolean** |  | [optional][default to true] |
+| **enable_functions** | **Boolean** |  | [optional][default to false] |
+
+## Example
+
+```ruby
+require 'mudbase'
+
+instance = Mudbase::ProjectSettings.new(
+  allow_anonymous_auth: null,
+  require_email_verification: null,
+  require_phone_verification: null,
+  default_user_account_status: null,
+  enable_realtime: null,
+  enable_storage: null,
+  enable_functions: null
+)
+```
+

data/docs/ProjectSummary.md

@@ -0,0 +1,22 @@
+# Mudbase::ProjectSummary
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **_id** | **String** |  | [optional] |
+| **name** | **String** |  | [optional] |
+| **slug** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'mudbase'
+
+instance = Mudbase::ProjectSummary.new(
+  _id: null,
+  name: null,
+  slug: null
+)
+```
+

data/docs/ProjectUsage.md

@@ -0,0 +1,26 @@
+# Mudbase::ProjectUsage
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **api_calls** | **Integer** |  | [optional] |
+| **storage** | **Integer** |  | [optional] |
+| **bandwidth** | **Integer** |  | [optional] |
+| **db_reads** | **Integer** |  | [optional] |
+| **db_writes** | **Integer** |  | [optional] |
+
+## Example
+
+```ruby
+require 'mudbase'
+
+instance = Mudbase::ProjectUsage.new(
+  api_calls: null,
+  storage: null,
+  bandwidth: null,
+  db_reads: null,
+  db_writes: null
+)
+```
+

data/docs/ProjectUsageResponse.md

@@ -0,0 +1,20 @@
+# Mudbase::ProjectUsageResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **usage** | [**ProjectUsage**](ProjectUsage.md) |  | [optional] |
+| **limits** | [**Limits**](Limits.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'mudbase'
+
+instance = Mudbase::ProjectUsageResponse.new(
+  usage: null,
+  limits: null
+)
+```
+

data/docs/ProjectUsageStatsResponse.md

@@ -0,0 +1,22 @@
+# Mudbase::ProjectUsageStatsResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **project** | [**ProjectUsageStatsResponseProject**](ProjectUsageStatsResponseProject.md) |  | [optional] |
+| **usage** | [**ProjectUsage**](ProjectUsage.md) |  | [optional] |
+| **period** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'mudbase'
+
+instance = Mudbase::ProjectUsageStatsResponse.new(
+  project: null,
+  usage: null,
+  period: null
+)
+```
+

data/docs/ProjectUsageStatsResponseProject.md

@@ -0,0 +1,20 @@
+# Mudbase::ProjectUsageStatsResponseProject
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  | [optional] |
+| **name** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'mudbase'
+
+instance = Mudbase::ProjectUsageStatsResponseProject.new(
+  id: null,
+  name: null
+)
+```
+

data/docs/PushNotificationRequest.md

@@ -0,0 +1,26 @@
+# Mudbase::PushNotificationRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **tokens** | **Array<String>** |  |  |
+| **title** | **String** |  |  |
+| **body** | **String** |  |  |
+| **data** | **Object** |  | [optional] |
+| **image_url** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'mudbase'
+
+instance = Mudbase::PushNotificationRequest.new(
+  tokens: null,
+  title: null,
+  body: null,
+  data: null,
+  image_url: null
+)
+```
+

data/docs/RateLimit.md

@@ -0,0 +1,20 @@
+# Mudbase::RateLimit
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **requests** | **Integer** |  | [optional] |
+| **window** | **Integer** |  | [optional] |
+
+## Example
+
+```ruby
+require 'mudbase'
+
+instance = Mudbase::RateLimit.new(
+  requests: null,
+  window: null
+)
+```
+

data/docs/RealtimeAnalyticsApi.md

@@ -0,0 +1,367 @@
+# Mudbase::RealtimeAnalyticsApi
+
+All URIs are relative to *https://cloud.mudbase.dev*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**realtime_analytics_check_user_presence**](RealtimeAnalyticsApi.md#realtime_analytics_check_user_presence) | **POST** /api/realtime/projects/{projectId}/presence | Check presence status for users |
+| [**realtime_analytics_get_active_users**](RealtimeAnalyticsApi.md#realtime_analytics_get_active_users) | **GET** /api/realtime/projects/{projectId}/active-users | Get active users for a project |
+| [**realtime_analytics_get_event_throughput**](RealtimeAnalyticsApi.md#realtime_analytics_get_event_throughput) | **GET** /api/realtime/projects/{projectId}/throughput | Get event throughput metrics |
+| [**realtime_analytics_get_historical_analytics**](RealtimeAnalyticsApi.md#realtime_analytics_get_historical_analytics) | **GET** /api/realtime/projects/{projectId}/history | Get historical analytics |
+| [**realtime_analytics_get_project**](RealtimeAnalyticsApi.md#realtime_analytics_get_project) | **GET** /api/realtime/projects/{projectId}/analytics | Get project real-time analytics |
+
+
+## realtime_analytics_check_user_presence
+
+> <RealtimeAnalyticsCheckUserPresence200Response> realtime_analytics_check_user_presence(project_id, realtime_analytics_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): BearerToken
+  config.access_token = 'YOUR_BEARER_TOKEN'
+end
+
+api_instance = Mudbase::RealtimeAnalyticsApi.new
+project_id = 'project_id_example' # String | Project ID.
+realtime_analytics_check_user_presence_request = Mudbase::RealtimeAnalyticsCheckUserPresenceRequest.new({user_ids: ["685acbe0e129932fbb7a0fc2", "685acbe0e129932fbb7a0fc3"]}) # RealtimeAnalyticsCheckUserPresenceRequest | Array of user IDs to check presence for.
+
+begin
+  # Check presence status for users
+  result = api_instance.realtime_analytics_check_user_presence(project_id, realtime_analytics_check_user_presence_request)
+  p result
+rescue Mudbase::ApiError => e
+  puts "Error when calling RealtimeAnalyticsApi->realtime_analytics_check_user_presence: #{e}"
+end
+```
+
+#### Using the realtime_analytics_check_user_presence_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<RealtimeAnalyticsCheckUserPresence200Response>, Integer, Hash)> realtime_analytics_check_user_presence_with_http_info(project_id, realtime_analytics_check_user_presence_request)
+
+```ruby
+begin
+  # Check presence status for users
+  data, status_code, headers = api_instance.realtime_analytics_check_user_presence_with_http_info(project_id, realtime_analytics_check_user_presence_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <RealtimeAnalyticsCheckUserPresence200Response>
+rescue Mudbase::ApiError => e
+  puts "Error when calling RealtimeAnalyticsApi->realtime_analytics_check_user_presence_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **project_id** | **String** | Project ID. |  |
+| **realtime_analytics_check_user_presence_request** | [**RealtimeAnalyticsCheckUserPresenceRequest**](RealtimeAnalyticsCheckUserPresenceRequest.md) | Array of user IDs to check presence for. |  |
+
+### Return type
+
+[**RealtimeAnalyticsCheckUserPresence200Response**](RealtimeAnalyticsCheckUserPresence200Response.md)
+
+### Authorization
+
+[BearerToken](../README.md#BearerToken)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## realtime_analytics_get_active_users
+
+> <RealtimeAnalyticsGetActiveUsers200Response> realtime_analytics_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): BearerToken
+  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.realtime_analytics_get_active_users(project_id)
+  p result
+rescue Mudbase::ApiError => e
+  puts "Error when calling RealtimeAnalyticsApi->realtime_analytics_get_active_users: #{e}"
+end
+```
+
+#### Using the realtime_analytics_get_active_users_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<RealtimeAnalyticsGetActiveUsers200Response>, Integer, Hash)> realtime_analytics_get_active_users_with_http_info(project_id)
+
+```ruby
+begin
+  # Get active users for a project
+  data, status_code, headers = api_instance.realtime_analytics_get_active_users_with_http_info(project_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <RealtimeAnalyticsGetActiveUsers200Response>
+rescue Mudbase::ApiError => e
+  puts "Error when calling RealtimeAnalyticsApi->realtime_analytics_get_active_users_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **project_id** | **String** | Project ID. |  |
+
+### Return type
+
+[**RealtimeAnalyticsGetActiveUsers200Response**](RealtimeAnalyticsGetActiveUsers200Response.md)
+
+### Authorization
+
+[BearerToken](../README.md#BearerToken)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## realtime_analytics_get_event_throughput
+
+> <RealtimeAnalyticsGetEventThroughput200Response> realtime_analytics_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): BearerToken
+  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.realtime_analytics_get_event_throughput(project_id, opts)
+  p result
+rescue Mudbase::ApiError => e
+  puts "Error when calling RealtimeAnalyticsApi->realtime_analytics_get_event_throughput: #{e}"
+end
+```
+
+#### Using the realtime_analytics_get_event_throughput_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<RealtimeAnalyticsGetEventThroughput200Response>, Integer, Hash)> realtime_analytics_get_event_throughput_with_http_info(project_id, opts)
+
+```ruby
+begin
+  # Get event throughput metrics
+  data, status_code, headers = api_instance.realtime_analytics_get_event_throughput_with_http_info(project_id, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <RealtimeAnalyticsGetEventThroughput200Response>
+rescue Mudbase::ApiError => e
+  puts "Error when calling RealtimeAnalyticsApi->realtime_analytics_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
+
+[**RealtimeAnalyticsGetEventThroughput200Response**](RealtimeAnalyticsGetEventThroughput200Response.md)
+
+### Authorization
+
+[BearerToken](../README.md#BearerToken)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## realtime_analytics_get_historical_analytics
+
+> <RealtimeAnalyticsGetHistoricalAnalytics200Response> realtime_analytics_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): BearerToken
+  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.realtime_analytics_get_historical_analytics(project_id, opts)
+  p result
+rescue Mudbase::ApiError => e
+  puts "Error when calling RealtimeAnalyticsApi->realtime_analytics_get_historical_analytics: #{e}"
+end
+```
+
+#### Using the realtime_analytics_get_historical_analytics_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<RealtimeAnalyticsGetHistoricalAnalytics200Response>, Integer, Hash)> realtime_analytics_get_historical_analytics_with_http_info(project_id, opts)
+
+```ruby
+begin
+  # Get historical analytics
+  data, status_code, headers = api_instance.realtime_analytics_get_historical_analytics_with_http_info(project_id, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <RealtimeAnalyticsGetHistoricalAnalytics200Response>
+rescue Mudbase::ApiError => e
+  puts "Error when calling RealtimeAnalyticsApi->realtime_analytics_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
+
+[**RealtimeAnalyticsGetHistoricalAnalytics200Response**](RealtimeAnalyticsGetHistoricalAnalytics200Response.md)
+
+### Authorization
+
+[BearerToken](../README.md#BearerToken)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## realtime_analytics_get_project
+
+> <RealtimeAnalyticsGetProject200Response> realtime_analytics_get_project(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): BearerToken
+  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.realtime_analytics_get_project(project_id)
+  p result
+rescue Mudbase::ApiError => e
+  puts "Error when calling RealtimeAnalyticsApi->realtime_analytics_get_project: #{e}"
+end
+```
+
+#### Using the realtime_analytics_get_project_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<RealtimeAnalyticsGetProject200Response>, Integer, Hash)> realtime_analytics_get_project_with_http_info(project_id)
+
+```ruby
+begin
+  # Get project real-time analytics
+  data, status_code, headers = api_instance.realtime_analytics_get_project_with_http_info(project_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <RealtimeAnalyticsGetProject200Response>
+rescue Mudbase::ApiError => e
+  puts "Error when calling RealtimeAnalyticsApi->realtime_analytics_get_project_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
+
+[**RealtimeAnalyticsGetProject200Response**](RealtimeAnalyticsGetProject200Response.md)
+
+### Authorization
+
+[BearerToken](../README.md#BearerToken)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+

data/docs/RealtimeAnalyticsCheckUserPresence200Response.md

@@ -0,0 +1,20 @@
+# Mudbase::RealtimeAnalyticsCheckUserPresence200Response
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **presence** | [**Hash<String, RealtimeAnalyticsCheckUserPresence200ResponsePresenceValue>**](RealtimeAnalyticsCheckUserPresence200ResponsePresenceValue.md) |  | [optional] |
+| **timestamp** | **Time** |  | [optional] |
+
+## Example
+
+```ruby
+require 'mudbase'
+
+instance = Mudbase::RealtimeAnalyticsCheckUserPresence200Response.new(
+  presence: null,
+  timestamp: null
+)
+```
+

data/docs/RealtimeAnalyticsCheckUserPresence200ResponsePresenceValue.md

@@ -0,0 +1,20 @@
+# Mudbase::RealtimeAnalyticsCheckUserPresence200ResponsePresenceValue
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **online** | **Boolean** |  | [optional] |
+| **last_seen** | **Time** |  | [optional] |
+
+## Example
+
+```ruby
+require 'mudbase'
+
+instance = Mudbase::RealtimeAnalyticsCheckUserPresence200ResponsePresenceValue.new(
+  online: null,
+  last_seen: null
+)
+```
+

data/docs/RealtimeAnalyticsCheckUserPresenceRequest.md

@@ -0,0 +1,18 @@
+# Mudbase::RealtimeAnalyticsCheckUserPresenceRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **user_ids** | **Array<String>** |  |  |
+
+## Example
+
+```ruby
+require 'mudbase'
+
+instance = Mudbase::RealtimeAnalyticsCheckUserPresenceRequest.new(
+  user_ids: ["685acbe0e129932fbb7a0fc2","685acbe0e129932fbb7a0fc3"]
+)
+```
+

data/docs/RealtimeAnalyticsGetActiveUsers200Response.md

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