mudbase 1.2.12 → 1.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2c0bfeabe2ab3d0799e57d4209133f1db5d87945c3939c26bc7182a2f05ae808
-  data.tar.gz: b5dee3f3b9d5a40afbe3b95869c3475047773e7da4fe95f7a6ead8d9e4426279
+  metadata.gz: 6dd8f17eedc9516bdba707c983ca2d99ad9952efc372483156c533eea4b73d6d
+  data.tar.gz: 222ddc3f8c91ccfa8466a3e2f194ca81ad87548de807fe86527ba77ddbfffc69
 SHA512:
-  metadata.gz: 756dc1609bef2f4a79be76cef4203bf73a28b194ffcd0ef909513ef6a2c9bf843c2895a3bb3f73e94a829f057e47c20f1e9cdeec66c20bf96e410e7d5b3ac073
-  data.tar.gz: 70a9e903290ec25a39adee55beec5770f7c87284d12efb63dd448bcdff72b3434be27763b4a6fc87d250089b5e6b31cddad7e73ff551d67167b02c3802205429
+  metadata.gz: a07bb15edc76c233079cfdd7ff68a0ac3651f8da089168d8ef53cbd7451c2746e1d5771b54466b1ebbedb5f8fb805f3d9f6386e82067e9fe06d8d65765f07d28
+  data.tar.gz: 8d0b4c961c527c25aa58a7256ac50bf1ffc500d5a52494d444822760d8903bdf703e4c1ce56acaeb830d45f291f8fbea0c7400d1fc390a906ad9b3e70f2e258d

data/docs/APIKeysApi.md

@@ -0,0 +1,429 @@
+# Mudbase::APIKeysApi
+
+All URIs are relative to *https://cloud.mudbase.dev*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**create_api_key**](APIKeysApi.md#create_api_key) | **POST** /api/api-keys | Create API key |
+| [**delete_api_key**](APIKeysApi.md#delete_api_key) | **DELETE** /api/api-keys/{id} | Delete API key |
+| [**get_api_key_usage**](APIKeysApi.md#get_api_key_usage) | **GET** /api/api-keys/{id}/usage | Get API key usage |
+| [**list_api_keys**](APIKeysApi.md#list_api_keys) | **GET** /api/api-keys | List API keys |
+| [**regenerate_api_key**](APIKeysApi.md#regenerate_api_key) | **POST** /api/api-keys/{id}/regenerate | Regenerate API key secret |
+| [**update_api_key**](APIKeysApi.md#update_api_key) | **PATCH** /api/api-keys/{id} | Update API key |
+
+
+## create_api_key
+
+> <CreateApiKey201Response> create_api_key(create_api_key_request)
+
+Create API key
+
+Create a new API key for a project with specified permissions. Requires organization-level authentication (JWT Bearer token). API keys are not supported for this endpoint. 
+
+### Examples
+
+```ruby
+require 'time'
+require 'mudbase'
+# setup authorization
+Mudbase.configure do |config|
+  # Configure Bearer authorization (JWT): OrgBearerAuth
+  config.access_token = 'YOUR_BEARER_TOKEN'
+end
+
+api_instance = Mudbase::APIKeysApi.new
+create_api_key_request = Mudbase::CreateApiKeyRequest.new({name: 'name_example', project_id: 'project_id_example'}) # CreateApiKeyRequest | 
+
+begin
+  # Create API key
+  result = api_instance.create_api_key(create_api_key_request)
+  p result
+rescue Mudbase::ApiError => e
+  puts "Error when calling APIKeysApi->create_api_key: #{e}"
+end
+```
+
+#### Using the create_api_key_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<CreateApiKey201Response>, Integer, Hash)> create_api_key_with_http_info(create_api_key_request)
+
+```ruby
+begin
+  # Create API key
+  data, status_code, headers = api_instance.create_api_key_with_http_info(create_api_key_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <CreateApiKey201Response>
+rescue Mudbase::ApiError => e
+  puts "Error when calling APIKeysApi->create_api_key_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **create_api_key_request** | [**CreateApiKeyRequest**](CreateApiKeyRequest.md) |  |  |
+
+### Return type
+
+[**CreateApiKey201Response**](CreateApiKey201Response.md)
+
+### Authorization
+
+[OrgBearerAuth](../README.md#OrgBearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## delete_api_key
+
+> <MessageResponse> delete_api_key(id)
+
+Delete API key
+
+Delete an API key. Requires organization-level authentication (JWT Bearer token). API keys are not supported for this endpoint. 
+
+### Examples
+
+```ruby
+require 'time'
+require 'mudbase'
+# setup authorization
+Mudbase.configure do |config|
+  # Configure Bearer authorization (JWT): OrgBearerAuth
+  config.access_token = 'YOUR_BEARER_TOKEN'
+end
+
+api_instance = Mudbase::APIKeysApi.new
+id = 'id_example' # String | 
+
+begin
+  # Delete API key
+  result = api_instance.delete_api_key(id)
+  p result
+rescue Mudbase::ApiError => e
+  puts "Error when calling APIKeysApi->delete_api_key: #{e}"
+end
+```
+
+#### Using the delete_api_key_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<MessageResponse>, Integer, Hash)> delete_api_key_with_http_info(id)
+
+```ruby
+begin
+  # Delete API key
+  data, status_code, headers = api_instance.delete_api_key_with_http_info(id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <MessageResponse>
+rescue Mudbase::ApiError => e
+  puts "Error when calling APIKeysApi->delete_api_key_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  |  |
+
+### Return type
+
+[**MessageResponse**](MessageResponse.md)
+
+### Authorization
+
+[OrgBearerAuth](../README.md#OrgBearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## get_api_key_usage
+
+> <ApiKeyUsageResponse> get_api_key_usage(id)
+
+Get API key usage
+
+Get usage statistics for a specific API key including request count, rate limit status, and last used timestamp. Requires organization-level authentication (JWT Bearer token). API keys are not supported for this endpoint. 
+
+### Examples
+
+```ruby
+require 'time'
+require 'mudbase'
+# setup authorization
+Mudbase.configure do |config|
+  # Configure Bearer authorization (JWT): OrgBearerAuth
+  config.access_token = 'YOUR_BEARER_TOKEN'
+end
+
+api_instance = Mudbase::APIKeysApi.new
+id = 'id_example' # String | 
+
+begin
+  # Get API key usage
+  result = api_instance.get_api_key_usage(id)
+  p result
+rescue Mudbase::ApiError => e
+  puts "Error when calling APIKeysApi->get_api_key_usage: #{e}"
+end
+```
+
+#### Using the get_api_key_usage_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<ApiKeyUsageResponse>, Integer, Hash)> get_api_key_usage_with_http_info(id)
+
+```ruby
+begin
+  # Get API key usage
+  data, status_code, headers = api_instance.get_api_key_usage_with_http_info(id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <ApiKeyUsageResponse>
+rescue Mudbase::ApiError => e
+  puts "Error when calling APIKeysApi->get_api_key_usage_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  |  |
+
+### Return type
+
+[**ApiKeyUsageResponse**](ApiKeyUsageResponse.md)
+
+### Authorization
+
+[OrgBearerAuth](../README.md#OrgBearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## list_api_keys
+
+> <ListApiKeys200Response> list_api_keys
+
+List API keys
+
+List all API keys for the authenticated organization. Requires organization-level authentication (JWT Bearer token). API keys are not supported for this endpoint. 
+
+### Examples
+
+```ruby
+require 'time'
+require 'mudbase'
+# setup authorization
+Mudbase.configure do |config|
+  # Configure Bearer authorization (JWT): OrgBearerAuth
+  config.access_token = 'YOUR_BEARER_TOKEN'
+end
+
+api_instance = Mudbase::APIKeysApi.new
+
+begin
+  # List API keys
+  result = api_instance.list_api_keys
+  p result
+rescue Mudbase::ApiError => e
+  puts "Error when calling APIKeysApi->list_api_keys: #{e}"
+end
+```
+
+#### Using the list_api_keys_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<ListApiKeys200Response>, Integer, Hash)> list_api_keys_with_http_info
+
+```ruby
+begin
+  # List API keys
+  data, status_code, headers = api_instance.list_api_keys_with_http_info
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <ListApiKeys200Response>
+rescue Mudbase::ApiError => e
+  puts "Error when calling APIKeysApi->list_api_keys_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**ListApiKeys200Response**](ListApiKeys200Response.md)
+
+### Authorization
+
+[OrgBearerAuth](../README.md#OrgBearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## regenerate_api_key
+
+> <RegenerateApiKey200Response> regenerate_api_key(id)
+
+Regenerate API key secret
+
+Regenerate the secret for an API key. The old secret will be invalidated immediately. Accepts: OrgBearerAuth (for admin users), ProjectBearerAuth (JWT for authenticated users), or ApiKeyAuth (X-API-Key for programmatic access). Both ProjectBearerAuth and ApiKeyAuth are fully implemented. 
+
+### Examples
+
+```ruby
+require 'time'
+require 'mudbase'
+# setup authorization
+Mudbase.configure do |config|
+  # Configure Bearer authorization (JWT): OrgBearerAuth
+  config.access_token = 'YOUR_BEARER_TOKEN'
+
+  # Configure Bearer authorization (JWT): ProjectBearerAuth
+  config.access_token = 'YOUR_BEARER_TOKEN'
+end
+
+api_instance = Mudbase::APIKeysApi.new
+id = 'id_example' # String | 
+
+begin
+  # Regenerate API key secret
+  result = api_instance.regenerate_api_key(id)
+  p result
+rescue Mudbase::ApiError => e
+  puts "Error when calling APIKeysApi->regenerate_api_key: #{e}"
+end
+```
+
+#### Using the regenerate_api_key_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<RegenerateApiKey200Response>, Integer, Hash)> regenerate_api_key_with_http_info(id)
+
+```ruby
+begin
+  # Regenerate API key secret
+  data, status_code, headers = api_instance.regenerate_api_key_with_http_info(id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <RegenerateApiKey200Response>
+rescue Mudbase::ApiError => e
+  puts "Error when calling APIKeysApi->regenerate_api_key_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  |  |
+
+### Return type
+
+[**RegenerateApiKey200Response**](RegenerateApiKey200Response.md)
+
+### Authorization
+
+[OrgBearerAuth](../README.md#OrgBearerAuth), [ProjectBearerAuth](../README.md#ProjectBearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## update_api_key
+
+> <UpdateApiKey200Response> update_api_key(id, update_api_key_request)
+
+Update API key
+
+Update an API key's configuration (name, permissions, status). Requires organization-level authentication (JWT Bearer token). API keys are not supported for this endpoint. 
+
+### Examples
+
+```ruby
+require 'time'
+require 'mudbase'
+# setup authorization
+Mudbase.configure do |config|
+  # Configure Bearer authorization (JWT): OrgBearerAuth
+  config.access_token = 'YOUR_BEARER_TOKEN'
+end
+
+api_instance = Mudbase::APIKeysApi.new
+id = 'id_example' # String | 
+update_api_key_request = Mudbase::UpdateApiKeyRequest.new # UpdateApiKeyRequest | 
+
+begin
+  # Update API key
+  result = api_instance.update_api_key(id, update_api_key_request)
+  p result
+rescue Mudbase::ApiError => e
+  puts "Error when calling APIKeysApi->update_api_key: #{e}"
+end
+```
+
+#### Using the update_api_key_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<UpdateApiKey200Response>, Integer, Hash)> update_api_key_with_http_info(id, update_api_key_request)
+
+```ruby
+begin
+  # Update API key
+  data, status_code, headers = api_instance.update_api_key_with_http_info(id, update_api_key_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <UpdateApiKey200Response>
+rescue Mudbase::ApiError => e
+  puts "Error when calling APIKeysApi->update_api_key_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  |  |
+| **update_api_key_request** | [**UpdateApiKeyRequest**](UpdateApiKeyRequest.md) |  |  |
+
+### Return type
+
+[**UpdateApiKey200Response**](UpdateApiKey200Response.md)
+
+### Authorization
+
+[OrgBearerAuth](../README.md#OrgBearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+

data/docs/AcceptInvite201Response.md

@@ -0,0 +1,22 @@
+# Mudbase::AcceptInvite201Response
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **message** | **String** |  | [optional] |
+| **token** | **String** | JWT for the new user session | [optional] |
+| **user** | [**AcceptInvite201ResponseUser**](AcceptInvite201ResponseUser.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'mudbase'
+
+instance = Mudbase::AcceptInvite201Response.new(
+  message: null,
+  token: null,
+  user: null
+)
+```
+

data/docs/AcceptInvite201ResponseUser.md

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

data/docs/AcceptInviteRequest.md

@@ -0,0 +1,24 @@
+# Mudbase::AcceptInviteRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **token** | **String** | Invitation token from the invite email link |  |
+| **password** | **String** | Password for the new account |  |
+| **first_name** | **String** |  |  |
+| **last_name** | **String** |  |  |
+
+## Example
+
+```ruby
+require 'mudbase'
+
+instance = Mudbase::AcceptInviteRequest.new(
+  token: null,
+  password: null,
+  first_name: null,
+  last_name: null
+)
+```
+

data/docs/AddCustomRoleRequest.md

@@ -0,0 +1,38 @@
+# Mudbase::AddCustomRoleRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **slug** | **String** |  |  |
+| **name** | **String** |  |  |
+| **description** | **String** |  | [optional] |
+| **signup_endpoint** | **String** |  |  |
+| **requires_approval** | **Boolean** |  | [optional] |
+| **requires_payment** | **Boolean** |  | [optional] |
+| **requires_kyc** | **Boolean** |  | [optional] |
+| **default_permissions** | [**Array<AddCustomRoleRequestDefaultPermissionsInner>**](AddCustomRoleRequestDefaultPermissionsInner.md) | Optional global/base permissions. For collection-level CRUD use `collectionPermissions`. | [optional] |
+| **collection_permissions** | [**Hash<String, CreateRoleRequestCollectionPermissionsValue>**](CreateRoleRequestCollectionPermissionsValue.md) | Per-collection CRUD map (collection slug => actions or {actions,conditions}). | [optional] |
+| **metadata** | **Object** |  | [optional] |
+| **feature_permissions** | **Hash<String, Hash<String, Boolean>>** | App JWT feature toggles stored on `MultiRoleFeature.roles[].featurePermissions`. Structure: `{ [resource: string]: { [action: string]: boolean } }`. Only **explicit `false`** on a key that matches the resolved gate denies; missing resources/actions imply no extra denial.  **Canonical map** of `(resource, action)` pairs enforced at runtime: `services/appRoleFeatureMap.js` (`RULES`). Regenerate inventory: `node scripts/verify-app-role-feature-map.js`.  **Messaging** also accepts legacy keys (`email`, `sms`, `push`, `history`, `stats`) alongside `send_email`, `send_sms`, `send_push`, `read_history`, `read_stats` — see `services/appRoleFeatureService.js` (`MESSAGING_SYNONYMS`).  | Resource | Actions (boolean keys under the resource object) | |----------|--------------------------------------------------| | `messaging` | `send_email`, `send_sms`, `send_push`, `read_history`, `read_stats` (legacy: `email`, `sms`, `push`, `history`, `stats`) | | `integration` | `read`, `create`, `update`, `delete`, `execute`, `test`, `export`, `read_usage` | | `functions` | `create`, `read`, `update`, `delete`, `execute`, `simulate` | | `data` | `create`, `read`, `update`, `delete` | | `search` | `query`, `suggestions`, `read_analytics` | | `usage` | `read` | | `storage` | `read`, `create`, `update`, `delete`, `upload` | | `chat` | `read`, `create`, `update`, `delete` | | `realtime` | `read_analytics`, `read_active_users`, `presence`, `read_throughput`, `read_history` | | `roleElevation` | `request`, `status`, `documents` | | `webhooks` | `config_read`, `config_update`, `test_transformation` |  | [optional] |
+
+## Example
+
+```ruby
+require 'mudbase'
+
+instance = Mudbase::AddCustomRoleRequest.new(
+  slug: seller,
+  name: Seller,
+  description: Seller role with CRUD on seller-owned collections,
+  signup_endpoint: seller,
+  requires_approval: false,
+  requires_payment: false,
+  requires_kyc: false,
+  default_permissions: null,
+  collection_permissions: null,
+  metadata: null,
+  feature_permissions: {"messaging":{"email":true,"sms":true,"push":false,"history":true,"stats":true},"integration":{"read":true,"execute":true},"storage":{"read":true,"upload":true}}
+)
+```
+

data/docs/AddCustomRoleRequestDefaultPermissionsInner.md

@@ -0,0 +1,20 @@
+# Mudbase::AddCustomRoleRequestDefaultPermissionsInner
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **resource** | **String** |  | [optional] |
+| **actions** | **Array<String>** |  | [optional] |
+
+## Example
+
+```ruby
+require 'mudbase'
+
+instance = Mudbase::AddCustomRoleRequestDefaultPermissionsInner.new(
+  resource: null,
+  actions: null
+)
+```
+