cheminee 0.0.14

data/docs/DefaultApi.md

@@ -0,0 +1,529 @@
+# Cheminee::DefaultApi
+
+All URIs are relative to *http://localhost:3000/api*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**v1_indexes_get**](DefaultApi.md#v1_indexes_get) | **GET** /v1/indexes | List indexes |
+| [**v1_indexes_index_bulk_index_post**](DefaultApi.md#v1_indexes_index_bulk_index_post) | **POST** /v1/indexes/{index}/bulk_index | Index a list of SMILES and associated, free-form JSON attributes which are indexed and searchable |
+| [**v1_indexes_index_get**](DefaultApi.md#v1_indexes_index_get) | **GET** /v1/indexes/{index} | Get extended information about an index |
+| [**v1_indexes_index_post**](DefaultApi.md#v1_indexes_index_post) | **POST** /v1/indexes/{index} | Create an index |
+| [**v1_indexes_index_search_basic_get**](DefaultApi.md#v1_indexes_index_search_basic_get) | **GET** /v1/indexes/{index}/search/basic | Perform basic query search against index |
+| [**v1_indexes_index_search_substructure_get**](DefaultApi.md#v1_indexes_index_search_substructure_get) | **GET** /v1/indexes/{index}/search/substructure | Perform substructure search against index |
+| [**v1_schemas_get**](DefaultApi.md#v1_schemas_get) | **GET** /v1/schemas | List schemas available for creating indexes |
+| [**v1_standardize_post**](DefaultApi.md#v1_standardize_post) | **POST** /v1/standardize | Pass a list of SMILES through fragment_parent, uncharger, and canonicalization routines |
+
+
+## v1_indexes_get
+
+> <Array<IndexMeta>> v1_indexes_get
+
+List indexes
+
+### Examples
+
+```ruby
+require 'time'
+require 'cheminee'
+
+api_instance = Cheminee::DefaultApi.new
+
+begin
+  # List indexes
+  result = api_instance.v1_indexes_get
+  p result
+rescue Cheminee::ApiError => e
+  puts "Error when calling DefaultApi->v1_indexes_get: #{e}"
+end
+```
+
+#### Using the v1_indexes_get_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Array<IndexMeta>>, Integer, Hash)> v1_indexes_get_with_http_info
+
+```ruby
+begin
+  # List indexes
+  data, status_code, headers = api_instance.v1_indexes_get_with_http_info
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Array<IndexMeta>>
+rescue Cheminee::ApiError => e
+  puts "Error when calling DefaultApi->v1_indexes_get_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**Array&lt;IndexMeta&gt;**](IndexMeta.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json; charset=utf-8
+
+
+## v1_indexes_index_bulk_index_post
+
+> <PostIndexBulkResponseOk> v1_indexes_index_bulk_index_post(index, bulk_request)
+
+Index a list of SMILES and associated, free-form JSON attributes which are indexed and searchable
+
+### Examples
+
+```ruby
+require 'time'
+require 'cheminee'
+
+api_instance = Cheminee::DefaultApi.new
+index = 'index_example' # String | 
+bulk_request = Cheminee::BulkRequest.new({docs: [Cheminee::BulkRequestDoc.new({smiles: 'smiles_example'})]}) # BulkRequest | 
+
+begin
+  # Index a list of SMILES and associated, free-form JSON attributes which are indexed and searchable
+  result = api_instance.v1_indexes_index_bulk_index_post(index, bulk_request)
+  p result
+rescue Cheminee::ApiError => e
+  puts "Error when calling DefaultApi->v1_indexes_index_bulk_index_post: #{e}"
+end
+```
+
+#### Using the v1_indexes_index_bulk_index_post_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<PostIndexBulkResponseOk>, Integer, Hash)> v1_indexes_index_bulk_index_post_with_http_info(index, bulk_request)
+
+```ruby
+begin
+  # Index a list of SMILES and associated, free-form JSON attributes which are indexed and searchable
+  data, status_code, headers = api_instance.v1_indexes_index_bulk_index_post_with_http_info(index, bulk_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <PostIndexBulkResponseOk>
+rescue Cheminee::ApiError => e
+  puts "Error when calling DefaultApi->v1_indexes_index_bulk_index_post_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **index** | **String** |  |  |
+| **bulk_request** | [**BulkRequest**](BulkRequest.md) |  |  |
+
+### Return type
+
+[**PostIndexBulkResponseOk**](PostIndexBulkResponseOk.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: application/json; charset=utf-8
+- **Accept**: application/json; charset=utf-8
+
+
+## v1_indexes_index_get
+
+> <IndexSchema> v1_indexes_index_get(index)
+
+Get extended information about an index
+
+### Examples
+
+```ruby
+require 'time'
+require 'cheminee'
+
+api_instance = Cheminee::DefaultApi.new
+index = 'index_example' # String | 
+
+begin
+  # Get extended information about an index
+  result = api_instance.v1_indexes_index_get(index)
+  p result
+rescue Cheminee::ApiError => e
+  puts "Error when calling DefaultApi->v1_indexes_index_get: #{e}"
+end
+```
+
+#### Using the v1_indexes_index_get_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<IndexSchema>, Integer, Hash)> v1_indexes_index_get_with_http_info(index)
+
+```ruby
+begin
+  # Get extended information about an index
+  data, status_code, headers = api_instance.v1_indexes_index_get_with_http_info(index)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <IndexSchema>
+rescue Cheminee::ApiError => e
+  puts "Error when calling DefaultApi->v1_indexes_index_get_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **index** | **String** |  |  |
+
+### Return type
+
+[**IndexSchema**](IndexSchema.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json; charset=utf-8
+
+
+## v1_indexes_index_post
+
+> <IndexMeta> v1_indexes_index_post(index, schema, opts)
+
+Create an index
+
+### Examples
+
+```ruby
+require 'time'
+require 'cheminee'
+
+api_instance = Cheminee::DefaultApi.new
+index = 'index_example' # String | 
+schema = 'schema_example' # String | 
+opts = {
+  sort_by: 'sort_by_example' # String | 
+}
+
+begin
+  # Create an index
+  result = api_instance.v1_indexes_index_post(index, schema, opts)
+  p result
+rescue Cheminee::ApiError => e
+  puts "Error when calling DefaultApi->v1_indexes_index_post: #{e}"
+end
+```
+
+#### Using the v1_indexes_index_post_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<IndexMeta>, Integer, Hash)> v1_indexes_index_post_with_http_info(index, schema, opts)
+
+```ruby
+begin
+  # Create an index
+  data, status_code, headers = api_instance.v1_indexes_index_post_with_http_info(index, schema, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <IndexMeta>
+rescue Cheminee::ApiError => e
+  puts "Error when calling DefaultApi->v1_indexes_index_post_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **index** | **String** |  |  |
+| **schema** | **String** |  |  |
+| **sort_by** | **String** |  | [optional] |
+
+### Return type
+
+[**IndexMeta**](IndexMeta.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json; charset=utf-8
+
+
+## v1_indexes_index_search_basic_get
+
+> <Array<QuerySearchHit>> v1_indexes_index_search_basic_get(index, query, opts)
+
+Perform basic query search against index
+
+### Examples
+
+```ruby
+require 'time'
+require 'cheminee'
+
+api_instance = Cheminee::DefaultApi.new
+index = 'index_example' # String | 
+query = 'query_example' # String | 
+opts = {
+  limit: 56 # Integer | 
+}
+
+begin
+  # Perform basic query search against index
+  result = api_instance.v1_indexes_index_search_basic_get(index, query, opts)
+  p result
+rescue Cheminee::ApiError => e
+  puts "Error when calling DefaultApi->v1_indexes_index_search_basic_get: #{e}"
+end
+```
+
+#### Using the v1_indexes_index_search_basic_get_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Array<QuerySearchHit>>, Integer, Hash)> v1_indexes_index_search_basic_get_with_http_info(index, query, opts)
+
+```ruby
+begin
+  # Perform basic query search against index
+  data, status_code, headers = api_instance.v1_indexes_index_search_basic_get_with_http_info(index, query, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Array<QuerySearchHit>>
+rescue Cheminee::ApiError => e
+  puts "Error when calling DefaultApi->v1_indexes_index_search_basic_get_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **index** | **String** |  |  |
+| **query** | **String** |  |  |
+| **limit** | **Integer** |  | [optional] |
+
+### Return type
+
+[**Array&lt;QuerySearchHit&gt;**](QuerySearchHit.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json; charset=utf-8
+
+
+## v1_indexes_index_search_substructure_get
+
+> <Array<StructureSearchHit>> v1_indexes_index_search_substructure_get(index, smiles, opts)
+
+Perform substructure search against index
+
+### Examples
+
+```ruby
+require 'time'
+require 'cheminee'
+
+api_instance = Cheminee::DefaultApi.new
+index = 'index_example' # String | 
+smiles = 'smiles_example' # String | 
+opts = {
+  result_limit: 56, # Integer | 
+  tautomer_limit: 56, # Integer | 
+  extra_query: 'extra_query_example' # String | 
+}
+
+begin
+  # Perform substructure search against index
+  result = api_instance.v1_indexes_index_search_substructure_get(index, smiles, opts)
+  p result
+rescue Cheminee::ApiError => e
+  puts "Error when calling DefaultApi->v1_indexes_index_search_substructure_get: #{e}"
+end
+```
+
+#### Using the v1_indexes_index_search_substructure_get_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Array<StructureSearchHit>>, Integer, Hash)> v1_indexes_index_search_substructure_get_with_http_info(index, smiles, opts)
+
+```ruby
+begin
+  # Perform substructure search against index
+  data, status_code, headers = api_instance.v1_indexes_index_search_substructure_get_with_http_info(index, smiles, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Array<StructureSearchHit>>
+rescue Cheminee::ApiError => e
+  puts "Error when calling DefaultApi->v1_indexes_index_search_substructure_get_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **index** | **String** |  |  |
+| **smiles** | **String** |  |  |
+| **result_limit** | **Integer** |  | [optional] |
+| **tautomer_limit** | **Integer** |  | [optional] |
+| **extra_query** | **String** |  | [optional] |
+
+### Return type
+
+[**Array&lt;StructureSearchHit&gt;**](StructureSearchHit.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json; charset=utf-8
+
+
+## v1_schemas_get
+
+> <Array<Schema>> v1_schemas_get
+
+List schemas available for creating indexes
+
+### Examples
+
+```ruby
+require 'time'
+require 'cheminee'
+
+api_instance = Cheminee::DefaultApi.new
+
+begin
+  # List schemas available for creating indexes
+  result = api_instance.v1_schemas_get
+  p result
+rescue Cheminee::ApiError => e
+  puts "Error when calling DefaultApi->v1_schemas_get: #{e}"
+end
+```
+
+#### Using the v1_schemas_get_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Array<Schema>>, Integer, Hash)> v1_schemas_get_with_http_info
+
+```ruby
+begin
+  # List schemas available for creating indexes
+  data, status_code, headers = api_instance.v1_schemas_get_with_http_info
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Array<Schema>>
+rescue Cheminee::ApiError => e
+  puts "Error when calling DefaultApi->v1_schemas_get_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**Array&lt;Schema&gt;**](Schema.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json; charset=utf-8
+
+
+## v1_standardize_post
+
+> <Array<StandardizedSmiles>> v1_standardize_post(smiles)
+
+Pass a list of SMILES through fragment_parent, uncharger, and canonicalization routines
+
+### Examples
+
+```ruby
+require 'time'
+require 'cheminee'
+
+api_instance = Cheminee::DefaultApi.new
+smiles = [Cheminee::Smiles.new({smiles: 'smiles_example'})] # Array<Smiles> | 
+
+begin
+  # Pass a list of SMILES through fragment_parent, uncharger, and canonicalization routines
+  result = api_instance.v1_standardize_post(smiles)
+  p result
+rescue Cheminee::ApiError => e
+  puts "Error when calling DefaultApi->v1_standardize_post: #{e}"
+end
+```
+
+#### Using the v1_standardize_post_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Array<StandardizedSmiles>>, Integer, Hash)> v1_standardize_post_with_http_info(smiles)
+
+```ruby
+begin
+  # Pass a list of SMILES through fragment_parent, uncharger, and canonicalization routines
+  data, status_code, headers = api_instance.v1_standardize_post_with_http_info(smiles)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Array<StandardizedSmiles>>
+rescue Cheminee::ApiError => e
+  puts "Error when calling DefaultApi->v1_standardize_post_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **smiles** | [**Array&lt;Smiles&gt;**](Smiles.md) |  |  |
+
+### Return type
+
+[**Array&lt;StandardizedSmiles&gt;**](StandardizedSmiles.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: application/json; charset=utf-8
+- **Accept**: application/json; charset=utf-8
+

data/docs/GetIndexesResponseError.md

@@ -0,0 +1,18 @@
+# Cheminee::GetIndexesResponseError
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **error** | **String** |  |  |
+
+## Example
+
+```ruby
+require 'cheminee'
+
+instance = Cheminee::GetIndexesResponseError.new(
+  error: null
+)
+```
+

data/docs/IndexMeta.md

@@ -0,0 +1,20 @@
+# Cheminee::IndexMeta
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** |  |  |
+| **schema** | **String** |  |  |
+
+## Example
+
+```ruby
+require 'cheminee'
+
+instance = Cheminee::IndexMeta.new(
+  name: null,
+  schema: null
+)
+```
+

data/docs/IndexSchema.md

@@ -0,0 +1,20 @@
+# Cheminee::IndexSchema
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **index** | **String** |  |  |
+| **schema** | **Object** |  |  |
+
+## Example
+
+```ruby
+require 'cheminee'
+
+instance = Cheminee::IndexSchema.new(
+  index: null,
+  schema: null
+)
+```
+

data/docs/ListIndexResponseErr.md

@@ -0,0 +1,18 @@
+# Cheminee::ListIndexResponseErr
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **error** | **String** |  |  |
+
+## Example
+
+```ruby
+require 'cheminee'
+
+instance = Cheminee::ListIndexResponseErr.new(
+  error: null
+)
+```
+

data/docs/PostIndexBulkResponseError.md

@@ -0,0 +1,18 @@
+# Cheminee::PostIndexBulkResponseError
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **error** | **String** |  |  |
+
+## Example
+
+```ruby
+require 'cheminee'
+
+instance = Cheminee::PostIndexBulkResponseError.new(
+  error: null
+)
+```
+

data/docs/PostIndexBulkResponseOk.md

@@ -0,0 +1,18 @@
+# Cheminee::PostIndexBulkResponseOk
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **statuses** | [**Array<PostIndexBulkResponseOkStatus>**](PostIndexBulkResponseOkStatus.md) |  |  |
+
+## Example
+
+```ruby
+require 'cheminee'
+
+instance = Cheminee::PostIndexBulkResponseOk.new(
+  statuses: null
+)
+```
+

data/docs/PostIndexBulkResponseOkStatus.md

@@ -0,0 +1,20 @@
+# Cheminee::PostIndexBulkResponseOkStatus
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **opcode** | **Integer** |  | [optional] |
+| **error** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'cheminee'
+
+instance = Cheminee::PostIndexBulkResponseOkStatus.new(
+  opcode: null,
+  error: null
+)
+```
+

data/docs/QueryResponseError.md

@@ -0,0 +1,18 @@
+# Cheminee::QueryResponseError
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **error** | **String** |  |  |
+
+## Example
+
+```ruby
+require 'cheminee'
+
+instance = Cheminee::QueryResponseError.new(
+  error: null
+)
+```
+

data/docs/QuerySearchHit.md

@@ -0,0 +1,22 @@
+# Cheminee::QuerySearchHit
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **extra_data** | **Object** |  |  |
+| **smiles** | **String** |  |  |
+| **query** | **String** |  |  |
+
+## Example
+
+```ruby
+require 'cheminee'
+
+instance = Cheminee::QuerySearchHit.new(
+  extra_data: null,
+  smiles: null,
+  query: null
+)
+```
+