mudbase 1.0.0

data/docs/SearchApi.md

@@ -0,0 +1,239 @@
+# Mudbase::SearchApi
+
+All URIs are relative to *https://cloud.mudbase.dev*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**search_get_analytics**](SearchApi.md#search_get_analytics) | **GET** /api/search/projects/{projectId}/search/analytics | Get search analytics |
+| [**search_get_suggestions**](SearchApi.md#search_get_suggestions) | **GET** /api/search/projects/{projectId}/search/suggestions | Get search suggestions |
+| [**search_search**](SearchApi.md#search_search) | **GET** /api/search/projects/{projectId}/search | Full-text search |
+
+
+## search_get_analytics
+
+> <SearchGetAnalytics200Response> search_get_analytics(project_id, opts)
+
+Get search analytics
+
+Get search analytics including top queries, search volume, and performance metrics. 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::SearchApi.new
+project_id = '685ad30be129932fbb7a1047' # String | Project ID (MongoDB ObjectId) to get analytics for.
+opts = {
+  timeframe: '1d' # String | Timeframe for analytics (1d, 7d, or 30d).
+}
+
+begin
+  # Get search analytics
+  result = api_instance.search_get_analytics(project_id, opts)
+  p result
+rescue Mudbase::ApiError => e
+  puts "Error when calling SearchApi->search_get_analytics: #{e}"
+end
+```
+
+#### Using the search_get_analytics_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<SearchGetAnalytics200Response>, Integer, Hash)> search_get_analytics_with_http_info(project_id, opts)
+
+```ruby
+begin
+  # Get search analytics
+  data, status_code, headers = api_instance.search_get_analytics_with_http_info(project_id, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <SearchGetAnalytics200Response>
+rescue Mudbase::ApiError => e
+  puts "Error when calling SearchApi->search_get_analytics_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **project_id** | **String** | Project ID (MongoDB ObjectId) to get analytics for. |  |
+| **timeframe** | **String** | Timeframe for analytics (1d, 7d, or 30d). | [optional][default to &#39;7d&#39;] |
+
+### Return type
+
+[**SearchGetAnalytics200Response**](SearchGetAnalytics200Response.md)
+
+### Authorization
+
+[BearerToken](../README.md#BearerToken)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## search_get_suggestions
+
+> <SearchGetSuggestions200Response> search_get_suggestions(project_id, q, opts)
+
+Get search suggestions
+
+Get search query suggestions based on partial input. 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::SearchApi.new
+project_id = '685ad30be129932fbb7a1047' # String | Project ID (MongoDB ObjectId) to get suggestions for.
+q = 'q_example' # String | Partial search query (min 2 characters, max 50); suggestions are based on past queries and indexed content.
+opts = {
+  limit: 56 # Integer | Maximum number of suggestions to return (1–20).
+}
+
+begin
+  # Get search suggestions
+  result = api_instance.search_get_suggestions(project_id, q, opts)
+  p result
+rescue Mudbase::ApiError => e
+  puts "Error when calling SearchApi->search_get_suggestions: #{e}"
+end
+```
+
+#### Using the search_get_suggestions_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<SearchGetSuggestions200Response>, Integer, Hash)> search_get_suggestions_with_http_info(project_id, q, opts)
+
+```ruby
+begin
+  # Get search suggestions
+  data, status_code, headers = api_instance.search_get_suggestions_with_http_info(project_id, q, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <SearchGetSuggestions200Response>
+rescue Mudbase::ApiError => e
+  puts "Error when calling SearchApi->search_get_suggestions_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **project_id** | **String** | Project ID (MongoDB ObjectId) to get suggestions for. |  |
+| **q** | **String** | Partial search query (min 2 characters, max 50); suggestions are based on past queries and indexed content. |  |
+| **limit** | **Integer** | Maximum number of suggestions to return (1–20). | [optional][default to 10] |
+
+### Return type
+
+[**SearchGetSuggestions200Response**](SearchGetSuggestions200Response.md)
+
+### Authorization
+
+[BearerToken](../README.md#BearerToken)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## search_search
+
+> <SearchResponse> search_search(project_id, q, opts)
+
+Full-text search
+
+Perform full-text search across 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::SearchApi.new
+project_id = 'project_id_example' # String | Project ID (MongoDB ObjectId) to search within.
+q = 'q_example' # String | Full-text search query string.
+opts = {
+  collections: 'collections_example', # String | Comma-separated collection slugs or IDs to limit search scope.
+  fields: 'fields_example', # String | Comma-separated field names to search or return in highlights.
+  limit: 56, # Integer | Maximum number of results to return per page.
+  page: 56 # Integer | Page number for pagination (1-based).
+}
+
+begin
+  # Full-text search
+  result = api_instance.search_search(project_id, q, opts)
+  p result
+rescue Mudbase::ApiError => e
+  puts "Error when calling SearchApi->search_search: #{e}"
+end
+```
+
+#### Using the search_search_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<SearchResponse>, Integer, Hash)> search_search_with_http_info(project_id, q, opts)
+
+```ruby
+begin
+  # Full-text search
+  data, status_code, headers = api_instance.search_search_with_http_info(project_id, q, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <SearchResponse>
+rescue Mudbase::ApiError => e
+  puts "Error when calling SearchApi->search_search_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **project_id** | **String** | Project ID (MongoDB ObjectId) to search within. |  |
+| **q** | **String** | Full-text search query string. |  |
+| **collections** | **String** | Comma-separated collection slugs or IDs to limit search scope. | [optional] |
+| **fields** | **String** | Comma-separated field names to search or return in highlights. | [optional] |
+| **limit** | **Integer** | Maximum number of results to return per page. | [optional][default to 20] |
+| **page** | **Integer** | Page number for pagination (1-based). | [optional][default to 1] |
+
+### Return type
+
+[**SearchResponse**](SearchResponse.md)
+
+### Authorization
+
+[BearerToken](../README.md#BearerToken)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+

data/docs/SearchGetAnalytics200Response.md

@@ -0,0 +1,24 @@
+# Mudbase::SearchGetAnalytics200Response
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **total_searches** | **Integer** |  | [optional] |
+| **top_queries** | [**Array<SearchGetAnalytics200ResponseTopQueriesInner>**](SearchGetAnalytics200ResponseTopQueriesInner.md) |  | [optional] |
+| **searches_by_collection** | **Object** |  | [optional] |
+| **average_response_time** | **Float** |  | [optional] |
+
+## Example
+
+```ruby
+require 'mudbase'
+
+instance = Mudbase::SearchGetAnalytics200Response.new(
+  total_searches: null,
+  top_queries: null,
+  searches_by_collection: null,
+  average_response_time: null
+)
+```
+

data/docs/SearchGetAnalytics200ResponseTopQueriesInner.md

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

data/docs/SearchGetSuggestions200Response.md

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

data/docs/SearchResponse.md

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

data/docs/SearchResponseData.md

@@ -0,0 +1,24 @@
+# Mudbase::SearchResponseData
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **results** | [**Array<SearchResult>**](SearchResult.md) |  | [optional] |
+| **pagination** | [**Pagination**](Pagination.md) |  | [optional] |
+| **query** | **String** |  | [optional] |
+| **search_time** | **Integer** |  | [optional] |
+
+## Example
+
+```ruby
+require 'mudbase'
+
+instance = Mudbase::SearchResponseData.new(
+  results: null,
+  pagination: null,
+  query: null,
+  search_time: null
+)
+```
+

data/docs/SearchResult.md

@@ -0,0 +1,22 @@
+# Mudbase::SearchResult
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **collection** | **String** |  | [optional] |
+| **item** | [**SearchResultItem**](SearchResultItem.md) |  | [optional] |
+| **highlight** | **Object** |  | [optional] |
+
+## Example
+
+```ruby
+require 'mudbase'
+
+instance = Mudbase::SearchResult.new(
+  collection: null,
+  item: null,
+  highlight: null
+)
+```
+

data/docs/SearchResultItem.md

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

data/docs/SessionResponse.md

@@ -0,0 +1,20 @@
+# Mudbase::SessionResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **user** | [**User**](User.md) |  | [optional] |
+| **authenticated** | **Boolean** |  | [optional] |
+
+## Example
+
+```ruby
+require 'mudbase'
+
+instance = Mudbase::SessionResponse.new(
+  user: null,
+  authenticated: null
+)
+```
+

data/docs/SignedUrlResponse.md

@@ -0,0 +1,24 @@
+# Mudbase::SignedUrlResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **success** | **Boolean** |  | [optional] |
+| **url** | **String** | Signed URL for file access | [optional] |
+| **expires_at** | **Time** | Expiration time of the signed URL (optional - some endpoints return expiresIn instead) | [optional] |
+| **expires_in** | **Integer** | Time-to-live in seconds for the signed URL (optional) | [optional] |
+
+## Example
+
+```ruby
+require 'mudbase'
+
+instance = Mudbase::SignedUrlResponse.new(
+  success: null,
+  url: null,
+  expires_at: null,
+  expires_in: null
+)
+```
+