manticore-client 1.0.0

data/docs/ResponseError.md

@@ -0,0 +1,49 @@
+# Manticore::Client::ResponseError
+
+## Class instance methods
+
+### `openapi_one_of`
+
+Returns the list of classes defined in oneOf.
+
+#### Example
+
+```ruby
+require 'manticore/client'
+
+Manticore::Client::ResponseError.openapi_one_of
+# =>
+# [
+#   :'ResponseErrorDetails',
+#   :'String'
+# ]
+```
+
+### build
+
+Find the appropriate object from the `openapi_one_of` list and casts the data into it.
+
+#### Example
+
+```ruby
+require 'manticore/client'
+
+Manticore::Client::ResponseError.build(data)
+# => #<ResponseErrorDetails:0x00007fdd4aab02a0>
+
+Manticore::Client::ResponseError.build(data_that_doesnt_match)
+# => nil
+```
+
+#### Parameters
+
+| Name | Type | Description |
+| ---- | ---- | ----------- |
+| **data** | **Mixed** | data to be matched against the list of oneOf items |
+
+#### Return type
+
+- `ResponseErrorDetails`
+- `String`
+- `nil` (if no type matches)
+

data/docs/ResponseErrorDetails.md

@@ -0,0 +1,22 @@
+# Manticore::Client::ResponseErrorDetails
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **type** | **String** | Type or category of the error |  |
+| **reason** | **String** | Detailed explanation of why the error occurred | [optional] |
+| **table** | **String** | The table related to the error, if applicable | [optional] |
+
+## Example
+
+```ruby
+require 'manticore/client'
+
+instance = Manticore::Client::ResponseErrorDetails.new(
+  type: null,
+  reason: null,
+  table: null
+)
+```
+

data/docs/SearchApi.md

@@ -0,0 +1,204 @@
+# Manticore::Client::SearchApi
+
+All URIs are relative to *http://127.0.0.1:9308*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**autocomplete**](SearchApi.md#autocomplete) | **POST** /autocomplete | Performs an autocomplete search on a table |
+| [**percolate**](SearchApi.md#percolate) | **POST** /pq/{table}/search | Perform reverse search on a percolate table |
+| [**search**](SearchApi.md#search) | **POST** /search | Performs a search on a table |
+
+
+## autocomplete
+
+> Array<Object> autocomplete(autocomplete_request)
+
+Performs an autocomplete search on a table
+
+ The method expects an object with the following mandatory properties: * the name of the table to search * the query string to autocomplete For details, see the documentation on [**Autocomplete**](Autocomplete.md) An example: ``` {   \"table\":\"table_name\",   \"query\":\"query_beginning\" }         ``` An example of the method's response:   ```  [    {      \"total\": 3,      \"error\": \"\",      \"warning\": \"\",      \"columns\": [        {          \"query\": {            \"type\": \"string\"          }        }      ],      \"data\": [        {          \"query\": \"hello\"        },        {          \"query\": \"helio\"        },        {          \"query\": \"hell\"        }      ]    }  ]   ```  For more detailed information about the autocomplete queries, please refer to the documentation [here](https://manual.manticoresearch.com/Searching/Autocomplete). 
+
+### Examples
+
+```ruby
+require 'time'
+require 'manticore/client'
+
+api_instance = Manticore::Client::SearchApi.new
+autocomplete_request = Manticore::Client::AutocompleteRequest.new({table: 'table_example', query: 'query_example'}) # AutocompleteRequest | 
+
+begin
+  # Performs an autocomplete search on a table
+  result = api_instance.autocomplete(autocomplete_request)
+  p result
+rescue Manticore::Client::ApiError => e
+  puts "Error when calling SearchApi->autocomplete: #{e}"
+end
+```
+
+#### Using the autocomplete_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(Array&lt;Object&gt;, Integer, Hash)> autocomplete_with_http_info(autocomplete_request)
+
+```ruby
+begin
+  # Performs an autocomplete search on a table
+  data, status_code, headers = api_instance.autocomplete_with_http_info(autocomplete_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => Array&lt;Object&gt;
+rescue Manticore::Client::ApiError => e
+  puts "Error when calling SearchApi->autocomplete_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **autocomplete_request** | [**AutocompleteRequest**](AutocompleteRequest.md) |  |  |
+
+### Return type
+
+**Array&lt;Object&gt;**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## percolate
+
+> <SearchResponse> percolate(table, percolate_request)
+
+Perform reverse search on a percolate table
+
+Performs a percolate search. This method must be used only on percolate tables. Expects two parameters: the table name and an object with array of documents to be tested. An example of the documents object: ```   {     \"query\" {       \"percolate\": {         \"document\": {           \"content\":\"sample content\"         }       }     }   } ``` Responds with an object with matched stored queries:  ```   {     'timed_out':false,     'hits': {       'total':2,       'max_score':1,       'hits': [         {           'table':'idx_pq_1',           '_type':'doc',           '_id':'2',           '_score':'1',           '_source': {             'query': {               'match':{'title':'some'}             }           }         },         {           'table':'idx_pq_1',           '_type':'doc',           '_id':'5',           '_score':'1',           '_source': {             'query': {               'ql':'some | none'             }           }         }       ]     }   } ``` 
+
+### Examples
+
+```ruby
+require 'time'
+require 'manticore/client'
+
+api_instance = Manticore::Client::SearchApi.new
+table = 'table_example' # String | Name of the percolate table
+percolate_request = Manticore::Client::PercolateRequest.new({query: Manticore::Client::PercolateRequestQuery.new({percolate: 3.56})}) # PercolateRequest | 
+
+begin
+  # Perform reverse search on a percolate table
+  result = api_instance.percolate(table, percolate_request)
+  p result
+rescue Manticore::Client::ApiError => e
+  puts "Error when calling SearchApi->percolate: #{e}"
+end
+```
+
+#### Using the percolate_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<SearchResponse>, Integer, Hash)> percolate_with_http_info(table, percolate_request)
+
+```ruby
+begin
+  # Perform reverse search on a percolate table
+  data, status_code, headers = api_instance.percolate_with_http_info(table, percolate_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <SearchResponse>
+rescue Manticore::Client::ApiError => e
+  puts "Error when calling SearchApi->percolate_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **table** | **String** | Name of the percolate table |  |
+| **percolate_request** | [**PercolateRequest**](PercolateRequest.md) |  |  |
+
+### Return type
+
+[**SearchResponse**](SearchResponse.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## search
+
+> <SearchResponse> search(search_request)
+
+Performs a search on a table
+
+ The method expects an object with the following mandatory properties: * the name of the table to search * the match query object For details, see the documentation on [**SearchRequest**](SearchRequest.md) The method returns an object with the following properties: - took: the time taken to execute the search query. - timed_out: a boolean indicating whether the query timed out. - hits: an object with the following properties:    - total: the total number of hits found.    - hits: an array of hit objects, where each hit object represents a matched document. Each hit object has the following properties:      - _id: the ID of the matched document.      - _score: the score of the matched document.      - _source: the source data of the matched document.  In addition, if profiling is enabled, the response will include an additional array with profiling information attached. Also, if pagination is enabled, the response will include an additional 'scroll' property with a scroll token to use for pagination Here is an example search response:    ```   {     'took':10,     'timed_out':false,     'hits':     {       'total':2,       'hits':       [         {'_id':'1','_score':1,'_source':{'gid':11}},         {'_id':'2','_score':1,'_source':{'gid':12}}       ]     }   }   ```  For more information about the match query syntax and additional parameters that can be added to request and response, please see the documentation [here](https://manual.manticoresearch.com/Searching/Full_text_matching/Basic_usage#HTTP-JSON). 
+
+### Examples
+
+```ruby
+require 'time'
+require 'manticore/client'
+
+api_instance = Manticore::Client::SearchApi.new
+search_request = Manticore::Client::SearchRequest.new({table: 'table_example'}) # SearchRequest | 
+
+begin
+  # Performs a search on a table
+  result = api_instance.search(search_request)
+  p result
+rescue Manticore::Client::ApiError => e
+  puts "Error when calling SearchApi->search: #{e}"
+end
+```
+
+#### Using the search_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<SearchResponse>, Integer, Hash)> search_with_http_info(search_request)
+
+```ruby
+begin
+  # Performs a search on a table
+  data, status_code, headers = api_instance.search_with_http_info(search_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <SearchResponse>
+rescue Manticore::Client::ApiError => e
+  puts "Error when calling SearchApi->search_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **search_request** | [**SearchRequest**](SearchRequest.md) |  |  |
+
+### Return type
+
+[**SearchResponse**](SearchResponse.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+

data/docs/SearchQuery.md

@@ -0,0 +1,36 @@
+# Manticore::Client::SearchQuery
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **query_string** | **String** | Filter object defining a query string | [optional] |
+| **match** | **Object** | Filter object defining a match keyword passed as a string or in a Match object | [optional] |
+| **match_phrase** | **Object** | Filter object defining a match phrase | [optional] |
+| **match_all** | **Object** | Filter object to select all documents | [optional] |
+| **bool** | [**BoolFilter**](BoolFilter.md) |  | [optional] |
+| **equals** | **Object** |  | [optional] |
+| **_in** | **Object** | Filter to match a given set of attribute values. | [optional] |
+| **range** | **Object** | Filter to match a given range of attribute values passed in Range objects | [optional] |
+| **geo_distance** | [**GeoDistance**](GeoDistance.md) |  | [optional] |
+| **highlight** | [**Highlight**](Highlight.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'manticore/client'
+
+instance = Manticore::Client::SearchQuery.new(
+  query_string: null,
+  match: null,
+  match_phrase: null,
+  match_all: null,
+  bool: null,
+  equals: null,
+  _in: null,
+  range: null,
+  geo_distance: null,
+  highlight: null
+)
+```
+

data/docs/SearchRequest.md

@@ -0,0 +1,46 @@
+# Manticore::Client::SearchRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **table** | **String** | The table to perform the search on |  |
+| **query** | [**SearchQuery**](SearchQuery.md) |  | [optional] |
+| **join** | [**Array<Join>**](Join.md) | Join clause to combine search data from multiple tables | [optional] |
+| **highlight** | [**Highlight**](Highlight.md) |  | [optional] |
+| **limit** | **Integer** | Maximum number of results to return | [optional] |
+| **knn** | [**KnnQuery**](KnnQuery.md) |  | [optional] |
+| **aggs** | [**Hash<String, Aggregation>**](Aggregation.md) | Defines aggregation settings for grouping results | [optional] |
+| **expressions** | **Hash<String, String>** | Expressions to calculate additional values for the result | [optional] |
+| **max_matches** | **Integer** | Maximum number of matches allowed in the result | [optional] |
+| **offset** | **Integer** | Starting point for pagination of the result | [optional] |
+| **options** | **Object** | Additional search options | [optional] |
+| **profile** | **Boolean** | Enable or disable profiling of the search request | [optional] |
+| **sort** | **Object** |  | [optional] |
+| **_source** | **Object** |  | [optional] |
+| **track_scores** | **Boolean** | Enable or disable result weight calculation used for sorting | [optional] |
+
+## Example
+
+```ruby
+require 'manticore/client'
+
+instance = Manticore::Client::SearchRequest.new(
+  table: null,
+  query: null,
+  join: null,
+  highlight: null,
+  limit: null,
+  knn: null,
+  aggs: {agg1={terms={field=field1, size=1000, sort=[{field1=null, order=asc}]}}},
+  expressions: {title_len=crc32(title)},
+  max_matches: null,
+  offset: null,
+  options: null,
+  profile: null,
+  sort: null,
+  _source: null,
+  track_scores: null
+)
+```
+

data/docs/SearchResponse.md

@@ -0,0 +1,30 @@
+# Manticore::Client::SearchResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **took** | **Integer** | Time taken to execute the search | [optional] |
+| **timed_out** | **Boolean** | Indicates whether the search operation timed out | [optional] |
+| **aggregations** | **Object** | Aggregated search results grouped by the specified criteria | [optional] |
+| **hits** | [**SearchResponseHits**](SearchResponseHits.md) |  | [optional] |
+| **profile** | **Object** | Profile information about the search execution, if profiling is enabled | [optional] |
+| **scroll** | **String** | Scroll token to be used fo pagination | [optional] |
+| **warning** | **Object** | Warnings encountered during the search operation | [optional] |
+
+## Example
+
+```ruby
+require 'manticore/client'
+
+instance = Manticore::Client::SearchResponse.new(
+  took: null,
+  timed_out: null,
+  aggregations: null,
+  hits: null,
+  profile: null,
+  scroll: null,
+  warning: null
+)
+```
+

data/docs/SearchResponseHits.md

@@ -0,0 +1,24 @@
+# Manticore::Client::SearchResponseHits
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **max_score** | **Integer** | Maximum score among the matched documents | [optional] |
+| **total** | **Integer** | Total number of matched documents | [optional] |
+| **total_relation** | **String** | Indicates whether the total number of hits is accurate or an estimate | [optional] |
+| **hits** | [**Array<HitsHits>**](HitsHits.md) | Array of hit objects, each representing a matched document | [optional] |
+
+## Example
+
+```ruby
+require 'manticore/client'
+
+instance = Manticore::Client::SearchResponseHits.new(
+  max_score: null,
+  total: null,
+  total_relation: null,
+  hits: null
+)
+```
+

data/docs/SourceRules.md

@@ -0,0 +1,20 @@
+# Manticore::Client::SourceRules
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **includes** | **Array<String>** | List of fields to include in the response | [optional] |
+| **excludes** | **Array<String>** | List of fields to exclude from the response | [optional] |
+
+## Example
+
+```ruby
+require 'manticore/client'
+
+instance = Manticore::Client::SourceRules.new(
+  includes: null,
+  excludes: null
+)
+```
+

data/docs/SqlResponse.md

@@ -0,0 +1,49 @@
+# Manticore::Client::SqlResponse
+
+## Class instance methods
+
+### `openapi_one_of`
+
+Returns the list of classes defined in oneOf.
+
+#### Example
+
+```ruby
+require 'manticore/client'
+
+Manticore::Client::SqlResponse.openapi_one_of
+# =>
+# [
+#   :'Array<Object>',
+#   :'Object'
+# ]
+```
+
+### build
+
+Find the appropriate object from the `openapi_one_of` list and casts the data into it.
+
+#### Example
+
+```ruby
+require 'manticore/client'
+
+Manticore::Client::SqlResponse.build(data)
+# => #<Array<Object>:0x00007fdd4aab02a0>
+
+Manticore::Client::SqlResponse.build(data_that_doesnt_match)
+# => nil
+```
+
+#### Parameters
+
+| Name | Type | Description |
+| ---- | ---- | ----------- |
+| **data** | **Mixed** | data to be matched against the list of oneOf items |
+
+#### Return type
+
+- `Array<Object>`
+- `Object`
+- `nil` (if no type matches)
+

data/docs/SuccessResponse.md

@@ -0,0 +1,28 @@
+# Manticore::Client::SuccessResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **table** | **String** | Name of the document table | [optional] |
+| **id** | **Integer** | ID of the document affected by the request operation | [optional] |
+| **created** | **Boolean** | Indicates whether the document was created as a result of the operation | [optional] |
+| **result** | **String** | Result of the operation, typically 'created', 'updated', or 'deleted' | [optional] |
+| **found** | **Boolean** | Indicates whether the document was found in the table | [optional] |
+| **status** | **Integer** | HTTP status code representing the result of the operation | [optional] |
+
+## Example
+
+```ruby
+require 'manticore/client'
+
+instance = Manticore::Client::SuccessResponse.new(
+  table: null,
+  id: null,
+  created: null,
+  result: null,
+  found: null,
+  status: null
+)
+```
+

data/docs/UpdateDocumentRequest.md

@@ -0,0 +1,26 @@
+# Manticore::Client::UpdateDocumentRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **table** | **String** | Name of the document table |  |
+| **cluster** | **String** | Name of the document cluster | [optional] |
+| **doc** | **Object** | Object containing the document fields to update |  |
+| **id** | **Integer** | Document ID | [optional] |
+| **query** | [**QueryFilter**](QueryFilter.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'manticore/client'
+
+instance = Manticore::Client::UpdateDocumentRequest.new(
+  table: null,
+  cluster: null,
+  doc: {gid=10},
+  id: null,
+  query: null
+)
+```
+

data/docs/UpdateResponse.md

@@ -0,0 +1,24 @@
+# Manticore::Client::UpdateResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **table** | **String** | Name of the document table | [optional] |
+| **updated** | **Integer** | Number of documents updated | [optional] |
+| **id** | **Integer** | Document ID | [optional] |
+| **result** | **String** | Result of the update operation, typically 'updated' | [optional] |
+
+## Example
+
+```ruby
+require 'manticore/client'
+
+instance = Manticore::Client::UpdateResponse.new(
+  table: null,
+  updated: null,
+  id: null,
+  result: null
+)
+```
+

data/docs/UtilsApi.md

@@ -0,0 +1,76 @@
+# Manticore::Client::UtilsApi
+
+All URIs are relative to *http://127.0.0.1:9308*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**sql**](UtilsApi.md#sql) | **POST** /sql | Perform SQL requests |
+
+
+## sql
+
+> <SqlResponse> sql(body, opts)
+
+Perform SQL requests
+
+Run a query in SQL format. Expects a query string passed through `body` parameter and optional `raw_response` parameter that defines a format of response. `raw_response` can be set to `False` for Select queries only, e.g., `SELECT * FROM mytable` The query string must stay as it is, no URL encoding is needed. The response object depends on the query executed. In select mode the response has same format as `/search` operation. 
+
+### Examples
+
+```ruby
+require 'time'
+require 'manticore/client'
+
+api_instance = Manticore::Client::UtilsApi.new
+body = 'SHOW TABLES' # String | A query parameter string. 
+opts = {
+  raw_response: true # Boolean | Optional parameter, defines a format of response. Can be set to `False` for Select only queries and set to `True` for any type of queries. Default value is 'True'. 
+}
+
+begin
+  # Perform SQL requests
+  result = api_instance.sql(body, opts)
+  p result
+rescue Manticore::Client::ApiError => e
+  puts "Error when calling UtilsApi->sql: #{e}"
+end
+```
+
+#### Using the sql_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<SqlResponse>, Integer, Hash)> sql_with_http_info(body, opts)
+
+```ruby
+begin
+  # Perform SQL requests
+  data, status_code, headers = api_instance.sql_with_http_info(body, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <SqlResponse>
+rescue Manticore::Client::ApiError => e
+  puts "Error when calling UtilsApi->sql_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **body** | **String** | A query parameter string.  |  |
+| **raw_response** | **Boolean** | Optional parameter, defines a format of response. Can be set to &#x60;False&#x60; for Select only queries and set to &#x60;True&#x60; for any type of queries. Default value is &#39;True&#39;.  | [optional][default to true] |
+
+### Return type
+
+[**SqlResponse**](SqlResponse.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: text/plain
+- **Accept**: application/json
+