manticore-client 1.0.0

data/docs/AggCompositeTerm.md

@@ -0,0 +1,18 @@
+# Manticore::Client::AggCompositeTerm
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **field** | **String** | Name of field to operate with |  |
+
+## Example
+
+```ruby
+require 'manticore/client'
+
+instance = Manticore::Client::AggCompositeTerm.new(
+  field: field1
+)
+```
+

data/docs/AggTerms.md

@@ -0,0 +1,20 @@
+# Manticore::Client::AggTerms
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **field** | **String** | Name of attribute to aggregate by |  |
+| **size** | **Integer** | Maximum number of buckets in the result | [optional] |
+
+## Example
+
+```ruby
+require 'manticore/client'
+
+instance = Manticore::Client::AggTerms.new(
+  field: field1,
+  size: 1000
+)
+```
+

data/docs/Aggregation.md

@@ -0,0 +1,22 @@
+# Manticore::Client::Aggregation
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **terms** | [**AggTerms**](AggTerms.md) |  | [optional] |
+| **sort** | **Array<Object>** |  | [optional] |
+| **composite** | [**AggComposite**](AggComposite.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'manticore/client'
+
+instance = Manticore::Client::Aggregation.new(
+  terms: null,
+  sort: null,
+  composite: null
+)
+```
+

data/docs/AutocompleteRequest.md

@@ -0,0 +1,22 @@
+# Manticore::Client::AutocompleteRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **table** | **String** | The table to perform the search on |  |
+| **query** | **String** | The beginning of the string to autocomplete |  |
+| **options** | **Object** | Autocomplete options   - layouts: A comma-separated string of keyboard layout codes to validate and check for spell correction. Available options - us, ru, ua, se, pt, no, it, gr, uk, fr, es, dk, de, ch, br, bg, be. By default, all are enabled.   - fuzziness: (0,1 or 2) Maximum Levenshtein distance for finding typos. Set to 0 to disable fuzzy matching. Default is 2   - prepend: true/false If true, adds an asterisk before the last word for prefix expansion (e.g., *word )   - append:  true/false If true, adds an asterisk after the last word for prefix expansion (e.g., word* )   - expansion_len: Number of characters to expand in the last word. Default is 10.  | [optional] |
+
+## Example
+
+```ruby
+require 'manticore/client'
+
+instance = Manticore::Client::AutocompleteRequest.new(
+  table: null,
+  query: null,
+  options: null
+)
+```
+

data/docs/BoolFilter.md

@@ -0,0 +1,22 @@
+# Manticore::Client::BoolFilter
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **must** | [**Array<QueryFilter>**](QueryFilter.md) | Query clauses that must match for the document to be included | [optional] |
+| **must_not** | [**Array<QueryFilter>**](QueryFilter.md) | Query clauses that must not match for the document to be included | [optional] |
+| **should** | [**Array<QueryFilter>**](QueryFilter.md) | Query clauses that should be matched, but are not required | [optional] |
+
+## Example
+
+```ruby
+require 'manticore/client'
+
+instance = Manticore::Client::BoolFilter.new(
+  must: null,
+  must_not: null,
+  should: null
+)
+```
+

data/docs/BulkResponse.md

@@ -0,0 +1,26 @@
+# Manticore::Client::BulkResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **items** | **Array<Object>** | List of results | [optional] |
+| **errors** | **Boolean** | Errors occurred during the bulk operation | [optional] |
+| **error** | **String** | Error message describing an error if such occurred | [optional] |
+| **current_line** | **Integer** | Number of the row returned in the response | [optional] |
+| **skipped_lines** | **Integer** | Number of rows skipped in the response | [optional] |
+
+## Example
+
+```ruby
+require 'manticore/client'
+
+instance = Manticore::Client::BulkResponse.new(
+  items: null,
+  errors: null,
+  error: null,
+  current_line: null,
+  skipped_lines: null
+)
+```
+

data/docs/DeleteDocumentRequest.md

@@ -0,0 +1,24 @@
+# Manticore::Client::DeleteDocumentRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **table** | **String** | Table name |  |
+| **cluster** | **String** | Cluster name | [optional] |
+| **id** | **Integer** | The ID of document for deletion | [optional] |
+| **query** | **Object** | Defines the criteria to match documents for deletion | [optional] |
+
+## Example
+
+```ruby
+require 'manticore/client'
+
+instance = Manticore::Client::DeleteDocumentRequest.new(
+  table: null,
+  cluster: null,
+  id: null,
+  query: null
+)
+```
+

data/docs/DeleteResponse.md

@@ -0,0 +1,26 @@
+# Manticore::Client::DeleteResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **table** | **String** | The name of the table from which the document was deleted | [optional] |
+| **deleted** | **Integer** | Number of documents deleted | [optional] |
+| **id** | **Integer** | The ID of the deleted document. If multiple documents are deleted, the ID of the first deleted document is returned | [optional] |
+| **found** | **Boolean** | Indicates whether any documents to be deleted were found | [optional] |
+| **result** | **String** | Result of the delete operation, typically 'deleted' | [optional] |
+
+## Example
+
+```ruby
+require 'manticore/client'
+
+instance = Manticore::Client::DeleteResponse.new(
+  table: null,
+  deleted: null,
+  id: null,
+  found: null,
+  result: null
+)
+```
+

data/docs/ErrorResponse.md

@@ -0,0 +1,20 @@
+# Manticore::Client::ErrorResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **error** | [**ResponseError**](ResponseError.md) |  |  |
+| **status** | **Integer** | HTTP status code of the error response | [optional][default to 500] |
+
+## Example
+
+```ruby
+require 'manticore/client'
+
+instance = Manticore::Client::ErrorResponse.new(
+  error: null,
+  status: null
+)
+```
+

data/docs/FulltextFilter.md

@@ -0,0 +1,24 @@
+# Manticore::Client::FulltextFilter
+
+## 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] |
+
+## Example
+
+```ruby
+require 'manticore/client'
+
+instance = Manticore::Client::FulltextFilter.new(
+  query_string: null,
+  match: null,
+  match_phrase: null,
+  match_all: null
+)
+```
+

data/docs/GeoDistance.md

@@ -0,0 +1,24 @@
+# Manticore::Client::GeoDistance
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **location_anchor** | [**GeoDistanceLocationAnchor**](GeoDistanceLocationAnchor.md) |  | [optional] |
+| **location_source** | **String** | Field name in the document that contains location data | [optional] |
+| **distance_type** | **String** | Algorithm used to calculate the distance | [optional] |
+| **distance** | **String** | The distance from the anchor point to filter results by | [optional] |
+
+## Example
+
+```ruby
+require 'manticore/client'
+
+instance = Manticore::Client::GeoDistance.new(
+  location_anchor: null,
+  location_source: null,
+  distance_type: null,
+  distance: null
+)
+```
+

data/docs/GeoDistanceLocationAnchor.md

@@ -0,0 +1,20 @@
+# Manticore::Client::GeoDistanceLocationAnchor
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **lat** | **Float** | Latitude of the anchor point | [optional] |
+| **lon** | **Float** | Longitude of the anchor point | [optional] |
+
+## Example
+
+```ruby
+require 'manticore/client'
+
+instance = Manticore::Client::GeoDistanceLocationAnchor.new(
+  lat: null,
+  lon: null
+)
+```
+

data/docs/Highlight.md

@@ -0,0 +1,62 @@
+# Manticore::Client::Highlight
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **fragment_size** | **Integer** | Maximum size of the text fragments in highlighted snippets per field | [optional] |
+| **limit** | **Integer** | Maximum size of snippets per field | [optional] |
+| **limit_snippets** | **Integer** | Maximum number of snippets per field | [optional] |
+| **limit_words** | **Integer** | Maximum number of words per field | [optional] |
+| **number_of_fragments** | **Integer** | Total number of highlighted fragments per field | [optional] |
+| **after_match** | **String** | Text inserted after the matched term, typically used for HTML formatting | [optional][default to '</strong>'] |
+| **allow_empty** | **Boolean** | Permits an empty string to be returned as the highlighting result. Otherwise, the beginning of the original text would be returned | [optional] |
+| **around** | **Integer** | Number of words around the match to include in the highlight | [optional] |
+| **before_match** | **String** | Text inserted before the match, typically used for HTML formatting | [optional][default to '<strong>'] |
+| **emit_zones** | **Boolean** | Emits an HTML tag with the enclosing zone name before each highlighted snippet | [optional] |
+| **encoder** | **String** | If set to 'html', retains HTML markup when highlighting | [optional] |
+| **fields** | [**HighlightAllOfFields**](HighlightAllOfFields.md) |  | [optional] |
+| **force_all_words** | **Boolean** | Ignores the length limit until the result includes all keywords | [optional] |
+| **force_snippets** | **Boolean** | Forces snippet generation even if limits allow highlighting the entire text | [optional] |
+| **highlight_query** | [**QueryFilter**](QueryFilter.md) |  | [optional] |
+| **html_strip_mode** | **String** | Defines the mode for handling HTML markup in the highlight | [optional] |
+| **limits_per_field** | **Boolean** | Determines whether the 'limit', 'limit_words', and 'limit_snippets' options operate as individual limits in each field of the document | [optional] |
+| **no_match_size** | **Integer** | If set to 1, allows an empty string to be returned as a highlighting result | [optional] |
+| **order** | **String** | Sets the sorting order of highlighted snippets | [optional] |
+| **pre_tags** | **String** | Text inserted before each highlighted snippet | [optional][default to '<strong>'] |
+| **post_tags** | **String** | Text inserted after each highlighted snippet | [optional][default to '</strong>'] |
+| **start_snippet_id** | **Integer** | Sets the starting value of the %SNIPPET_ID% macro | [optional] |
+| **use_boundaries** | **Boolean** | Defines whether to additionally break snippets by phrase boundary characters | [optional] |
+
+## Example
+
+```ruby
+require 'manticore/client'
+
+instance = Manticore::Client::Highlight.new(
+  fragment_size: null,
+  limit: null,
+  limit_snippets: null,
+  limit_words: null,
+  number_of_fragments: null,
+  after_match: null,
+  allow_empty: null,
+  around: null,
+  before_match: null,
+  emit_zones: null,
+  encoder: null,
+  fields: null,
+  force_all_words: null,
+  force_snippets: null,
+  highlight_query: null,
+  html_strip_mode: null,
+  limits_per_field: null,
+  no_match_size: null,
+  order: null,
+  pre_tags: null,
+  post_tags: null,
+  start_snippet_id: null,
+  use_boundaries: null
+)
+```
+

data/docs/HighlightAllOfFields.md

@@ -0,0 +1,15 @@
+# Manticore::Client::HighlightAllOfFields
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+
+## Example
+
+```ruby
+require 'manticore/client'
+
+instance = Manticore::Client::HighlightAllOfFields.new()
+```
+

data/docs/HighlightFieldOption.md

@@ -0,0 +1,26 @@
+# Manticore::Client::HighlightFieldOption
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **fragment_size** | **Integer** | Maximum size of the text fragments in highlighted snippets per field | [optional] |
+| **limit** | **Integer** | Maximum size of snippets per field | [optional] |
+| **limit_snippets** | **Integer** | Maximum number of snippets per field | [optional] |
+| **limit_words** | **Integer** | Maximum number of words per field | [optional] |
+| **number_of_fragments** | **Integer** | Total number of highlighted fragments per field | [optional] |
+
+## Example
+
+```ruby
+require 'manticore/client'
+
+instance = Manticore::Client::HighlightFieldOption.new(
+  fragment_size: null,
+  limit: null,
+  limit_snippets: null,
+  limit_words: null,
+  number_of_fragments: null
+)
+```
+

data/docs/HitsHits.md

@@ -0,0 +1,22 @@
+# Manticore::Client::HitsHits
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **_id** | **Integer** | The ID of the matched document | [optional] |
+| **_score** | **Integer** | The score of the matched document | [optional] |
+| **_source** | **Object** | The source data of the matched document | [optional] |
+
+## Example
+
+```ruby
+require 'manticore/client'
+
+instance = Manticore::Client::HitsHits.new(
+  _id: null,
+  _score: null,
+  _source: null
+)
+```
+