mudbase 1.0.0

data/docs/CollectionsApi.md

@@ -0,0 +1,367 @@
+# Mudbase::CollectionsApi
+
+All URIs are relative to *https://cloud.mudbase.dev*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**collections_create**](CollectionsApi.md#collections_create) | **POST** /api/schemas/projects/{projectId}/collections | Create new collection |
+| [**collections_delete**](CollectionsApi.md#collections_delete) | **DELETE** /api/schemas/projects/{projectId}/collections/{collectionId} | Delete collection |
+| [**collections_get**](CollectionsApi.md#collections_get) | **GET** /api/schemas/projects/{projectId}/collections/{collectionId} | Get single collection |
+| [**collections_list**](CollectionsApi.md#collections_list) | **GET** /api/schemas/projects/{projectId}/collections | List collections in project |
+| [**collections_update**](CollectionsApi.md#collections_update) | **PATCH** /api/schemas/projects/{projectId}/collections/{collectionId} | Update collection |
+
+
+## collections_create
+
+> <CollectionsCreate201Response> collections_create(project_id, create_collection_request)
+
+Create new collection
+
+Create a new collection in a project. Accepts BearerToken (JWT) or ApiKeyAuth (X-API-Key). 
+
+### 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::CollectionsApi.new
+project_id = 'project_id_example' # String | Project ID.
+create_collection_request = Mudbase::CreateCollectionRequest.new({name: 'name_example', fields: [Mudbase::Field.new({name: 'name_example', type: 'string'})]}) # CreateCollectionRequest | Collection name, optional slug, fields, permissions, and settings.
+
+begin
+  # Create new collection
+  result = api_instance.collections_create(project_id, create_collection_request)
+  p result
+rescue Mudbase::ApiError => e
+  puts "Error when calling CollectionsApi->collections_create: #{e}"
+end
+```
+
+#### Using the collections_create_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<CollectionsCreate201Response>, Integer, Hash)> collections_create_with_http_info(project_id, create_collection_request)
+
+```ruby
+begin
+  # Create new collection
+  data, status_code, headers = api_instance.collections_create_with_http_info(project_id, create_collection_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <CollectionsCreate201Response>
+rescue Mudbase::ApiError => e
+  puts "Error when calling CollectionsApi->collections_create_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **project_id** | **String** | Project ID. |  |
+| **create_collection_request** | [**CreateCollectionRequest**](CreateCollectionRequest.md) | Collection name, optional slug, fields, permissions, and settings. |  |
+
+### Return type
+
+[**CollectionsCreate201Response**](CollectionsCreate201Response.md)
+
+### Authorization
+
+[BearerToken](../README.md#BearerToken)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## collections_delete
+
+> <MessageResponse> collections_delete(project_id, collection_id)
+
+Delete collection
+
+Delete a collection permanently. This is a destructive operation. Accepts BearerToken (JWT) or ApiKeyAuth (X-API-Key). 
+
+### 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::CollectionsApi.new
+project_id = 'project_id_example' # String | Project ID.
+collection_id = 'collection_id_example' # String | Collection ID.
+
+begin
+  # Delete collection
+  result = api_instance.collections_delete(project_id, collection_id)
+  p result
+rescue Mudbase::ApiError => e
+  puts "Error when calling CollectionsApi->collections_delete: #{e}"
+end
+```
+
+#### Using the collections_delete_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<MessageResponse>, Integer, Hash)> collections_delete_with_http_info(project_id, collection_id)
+
+```ruby
+begin
+  # Delete collection
+  data, status_code, headers = api_instance.collections_delete_with_http_info(project_id, collection_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <MessageResponse>
+rescue Mudbase::ApiError => e
+  puts "Error when calling CollectionsApi->collections_delete_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **project_id** | **String** | Project ID. |  |
+| **collection_id** | **String** | Collection ID. |  |
+
+### Return type
+
+[**MessageResponse**](MessageResponse.md)
+
+### Authorization
+
+[BearerToken](../README.md#BearerToken)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## collections_get
+
+> <Collection> collections_get(project_id, collection_id)
+
+Get single collection
+
+Get collection details by ID. Accepts BearerToken (JWT) or ApiKeyAuth (X-API-Key). 
+
+### 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::CollectionsApi.new
+project_id = 'project_id_example' # String | Project ID.
+collection_id = 'collection_id_example' # String | Collection ID.
+
+begin
+  # Get single collection
+  result = api_instance.collections_get(project_id, collection_id)
+  p result
+rescue Mudbase::ApiError => e
+  puts "Error when calling CollectionsApi->collections_get: #{e}"
+end
+```
+
+#### Using the collections_get_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Collection>, Integer, Hash)> collections_get_with_http_info(project_id, collection_id)
+
+```ruby
+begin
+  # Get single collection
+  data, status_code, headers = api_instance.collections_get_with_http_info(project_id, collection_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Collection>
+rescue Mudbase::ApiError => e
+  puts "Error when calling CollectionsApi->collections_get_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **project_id** | **String** | Project ID. |  |
+| **collection_id** | **String** | Collection ID. |  |
+
+### Return type
+
+[**Collection**](Collection.md)
+
+### Authorization
+
+[BearerToken](../README.md#BearerToken)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## collections_list
+
+> <CollectionsList200Response> collections_list(project_id)
+
+List collections in project
+
+List all collections in a project. Accepts BearerToken (JWT) or ApiKeyAuth (X-API-Key). 
+
+### 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::CollectionsApi.new
+project_id = 'project_id_example' # String | Project ID.
+
+begin
+  # List collections in project
+  result = api_instance.collections_list(project_id)
+  p result
+rescue Mudbase::ApiError => e
+  puts "Error when calling CollectionsApi->collections_list: #{e}"
+end
+```
+
+#### Using the collections_list_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<CollectionsList200Response>, Integer, Hash)> collections_list_with_http_info(project_id)
+
+```ruby
+begin
+  # List collections in project
+  data, status_code, headers = api_instance.collections_list_with_http_info(project_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <CollectionsList200Response>
+rescue Mudbase::ApiError => e
+  puts "Error when calling CollectionsApi->collections_list_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **project_id** | **String** | Project ID. |  |
+
+### Return type
+
+[**CollectionsList200Response**](CollectionsList200Response.md)
+
+### Authorization
+
+[BearerToken](../README.md#BearerToken)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## collections_update
+
+> <CollectionsCreate201Response> collections_update(project_id, collection_id, update_collection_request)
+
+Update collection
+
+Update collection configuration (name, fields, permissions). Accepts BearerToken (JWT) or ApiKeyAuth (X-API-Key). 
+
+### 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::CollectionsApi.new
+project_id = 'project_id_example' # String | Project ID.
+collection_id = 'collection_id_example' # String | Collection ID.
+update_collection_request = Mudbase::UpdateCollectionRequest.new # UpdateCollectionRequest | Fields to update (name, fields, permissions, settings).
+
+begin
+  # Update collection
+  result = api_instance.collections_update(project_id, collection_id, update_collection_request)
+  p result
+rescue Mudbase::ApiError => e
+  puts "Error when calling CollectionsApi->collections_update: #{e}"
+end
+```
+
+#### Using the collections_update_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<CollectionsCreate201Response>, Integer, Hash)> collections_update_with_http_info(project_id, collection_id, update_collection_request)
+
+```ruby
+begin
+  # Update collection
+  data, status_code, headers = api_instance.collections_update_with_http_info(project_id, collection_id, update_collection_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <CollectionsCreate201Response>
+rescue Mudbase::ApiError => e
+  puts "Error when calling CollectionsApi->collections_update_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **project_id** | **String** | Project ID. |  |
+| **collection_id** | **String** | Collection ID. |  |
+| **update_collection_request** | [**UpdateCollectionRequest**](UpdateCollectionRequest.md) | Fields to update (name, fields, permissions, settings). |  |
+
+### Return type
+
+[**CollectionsCreate201Response**](CollectionsCreate201Response.md)
+
+### Authorization
+
+[BearerToken](../README.md#BearerToken)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+

data/docs/CollectionsCreate201Response.md

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

data/docs/CollectionsList200Response.md

@@ -0,0 +1,20 @@
+# Mudbase::CollectionsList200Response
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **collections** | [**Array<Collection>**](Collection.md) |  | [optional] |
+| **total** | **Integer** |  | [optional] |
+
+## Example
+
+```ruby
+require 'mudbase'
+
+instance = Mudbase::CollectionsList200Response.new(
+  collections: null,
+  total: null
+)
+```
+

data/docs/ComplianceApi.md

@@ -0,0 +1,77 @@
+# Mudbase::ComplianceApi
+
+All URIs are relative to *https://cloud.mudbase.dev*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**compliance_log_security_event**](ComplianceApi.md#compliance_log_security_event) | **POST** /api/compliance/security-event | Log security event |
+
+
+## compliance_log_security_event
+
+> <ComplianceLogSecurityEvent200Response> compliance_log_security_event(compliance_log_security_event_request)
+
+Log security event
+
+Log a security event for compliance and audit (e.g. SOC 2, GDPR). Event type and severity are required; optional details (userId, resource, ipAddress, etc.) for forensics.
+
+### 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::ComplianceApi.new
+compliance_log_security_event_request = Mudbase::ComplianceLogSecurityEventRequest.new({event_type: 'unauthorized_access_attempt', severity: 'low'}) # ComplianceLogSecurityEventRequest | Event type (e.g. unauthorized_access_attempt, brute_force_attempt), severity (low–critical), and optional details object for context.
+
+begin
+  # Log security event
+  result = api_instance.compliance_log_security_event(compliance_log_security_event_request)
+  p result
+rescue Mudbase::ApiError => e
+  puts "Error when calling ComplianceApi->compliance_log_security_event: #{e}"
+end
+```
+
+#### Using the compliance_log_security_event_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<ComplianceLogSecurityEvent200Response>, Integer, Hash)> compliance_log_security_event_with_http_info(compliance_log_security_event_request)
+
+```ruby
+begin
+  # Log security event
+  data, status_code, headers = api_instance.compliance_log_security_event_with_http_info(compliance_log_security_event_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <ComplianceLogSecurityEvent200Response>
+rescue Mudbase::ApiError => e
+  puts "Error when calling ComplianceApi->compliance_log_security_event_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **compliance_log_security_event_request** | [**ComplianceLogSecurityEventRequest**](ComplianceLogSecurityEventRequest.md) | Event type (e.g. unauthorized_access_attempt, brute_force_attempt), severity (low–critical), and optional details object for context. |  |
+
+### Return type
+
+[**ComplianceLogSecurityEvent200Response**](ComplianceLogSecurityEvent200Response.md)
+
+### Authorization
+
+[BearerToken](../README.md#BearerToken)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+

data/docs/ComplianceLogSecurityEvent200Response.md

@@ -0,0 +1,20 @@
+# Mudbase::ComplianceLogSecurityEvent200Response
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **message** | **String** |  | [optional] |
+| **event** | [**ComplianceLogSecurityEvent200ResponseEvent**](ComplianceLogSecurityEvent200ResponseEvent.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'mudbase'
+
+instance = Mudbase::ComplianceLogSecurityEvent200Response.new(
+  message: Security event logged,
+  event: null
+)
+```
+

data/docs/ComplianceLogSecurityEvent200ResponseEvent.md

@@ -0,0 +1,24 @@
+# Mudbase::ComplianceLogSecurityEvent200ResponseEvent
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **_id** | **String** |  | [optional] |
+| **event_type** | **String** |  | [optional] |
+| **severity** | **String** |  | [optional] |
+| **timestamp** | **Time** |  | [optional] |
+
+## Example
+
+```ruby
+require 'mudbase'
+
+instance = Mudbase::ComplianceLogSecurityEvent200ResponseEvent.new(
+  _id: null,
+  event_type: null,
+  severity: null,
+  timestamp: null
+)
+```
+

data/docs/ComplianceLogSecurityEventRequest.md

@@ -0,0 +1,22 @@
+# Mudbase::ComplianceLogSecurityEventRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **event_type** | **String** |  |  |
+| **severity** | **String** |  |  |
+| **details** | [**ComplianceLogSecurityEventRequestDetails**](ComplianceLogSecurityEventRequestDetails.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'mudbase'
+
+instance = Mudbase::ComplianceLogSecurityEventRequest.new(
+  event_type: unauthorized_access_attempt,
+  severity: high,
+  details: null
+)
+```
+

data/docs/ComplianceLogSecurityEventRequestDetails.md

@@ -0,0 +1,28 @@
+# Mudbase::ComplianceLogSecurityEventRequestDetails
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **user_id** | **String** |  | [optional] |
+| **resource** | **String** |  | [optional] |
+| **ip_address** | **String** |  | [optional] |
+| **user_agent** | **String** |  | [optional] |
+| **action** | **String** |  | [optional] |
+| **reason** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'mudbase'
+
+instance = Mudbase::ComplianceLogSecurityEventRequestDetails.new(
+  user_id: null,
+  resource: null,
+  ip_address: null,
+  user_agent: null,
+  action: null,
+  reason: null
+)
+```
+

data/docs/ConfirmUploadResponse.md

@@ -0,0 +1,22 @@
+# Mudbase::ConfirmUploadResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **file_id** | **String** |  | [optional] |
+| **status** | **String** |  | [optional] |
+| **scan** | [**ConfirmUploadResponseScan**](ConfirmUploadResponseScan.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'mudbase'
+
+instance = Mudbase::ConfirmUploadResponse.new(
+  file_id: null,
+  status: null,
+  scan: null
+)
+```
+

data/docs/ConfirmUploadResponseScan.md

@@ -0,0 +1,24 @@
+# Mudbase::ConfirmUploadResponseScan
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **status** | **String** |  | [optional] |
+| **provider** | **String** |  | [optional] |
+| **detections** | **Integer** |  | [optional] |
+| **analysis** | **Object** | Raw analysis object returned by the scanner (e.g., VirusTotal) | [optional] |
+
+## Example
+
+```ruby
+require 'mudbase'
+
+instance = Mudbase::ConfirmUploadResponseScan.new(
+  status: null,
+  provider: null,
+  detections: null,
+  analysis: null
+)
+```
+

data/docs/CreateApiKeyRequest.md

@@ -0,0 +1,26 @@
+# Mudbase::CreateApiKeyRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** |  |  |
+| **project_id** | **String** | MongoDB ObjectId of the project |  |
+| **permissions** | [**Array<ApiKeyPermission>**](ApiKeyPermission.md) | Optional. Permission objects (resource + actions). Omit or pass [] for full access (all resources and actions). Include only the entries you want; remove resources or actions to restrict the key. | [optional] |
+| **rate_limit** | [**RateLimit**](RateLimit.md) |  | [optional] |
+| **expires_at** | **Time** | Optional. When provided, must be a valid ISO 8601 date-time in the future. Omit for no expiration. | [optional] |
+
+## Example
+
+```ruby
+require 'mudbase'
+
+instance = Mudbase::CreateApiKeyRequest.new(
+  name: null,
+  project_id: null,
+  permissions: null,
+  rate_limit: null,
+  expires_at: null
+)
+```
+

data/docs/CreateBucketRequest.md

@@ -0,0 +1,22 @@
+# Mudbase::CreateBucketRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** | The name of the bucket |  |
+| **is_public** | **Boolean** | Whether the bucket is publicly accessible | [optional][default to false] |
+| **settings** | **Object** | Additional bucket settings | [optional] |
+
+## Example
+
+```ruby
+require 'mudbase'
+
+instance = Mudbase::CreateBucketRequest.new(
+  name: null,
+  is_public: null,
+  settings: null
+)
+```
+