indexea_client 0.0.9

data/docs/AppsAppBody.md

@@ -0,0 +1,8 @@
+# IndexeaClient::AppsAppBody
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **String** |  | [optional] 
+**intro** | **String** |  | [optional] 
+

data/docs/AppsBody.md

@@ -0,0 +1,8 @@
+# IndexeaClient::AppsBody
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **String** |  | 
+**intro** | **String** |  | [optional] 
+

data/docs/AutoCompleteItem.md

@@ -0,0 +1,9 @@
+# IndexeaClient::AutoCompleteItem
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**value** | **String** |  | [optional] 
+**url** | **String** |  | [optional] 
+**props** | **Object** |  | [optional] 
+

data/docs/BlacklistBean.md

@@ -0,0 +1,12 @@
+# IndexeaClient::BlacklistBean
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**app** | **Integer** |  | [optional] 
+**block_type** | **Integer** |  | [optional] 
+**badwords** | **Array<String>** |  | [optional] 
+**black_ips** | **Array<String>** |  | [optional] 
+**white_ips** | **Array<String>** |  | [optional] 
+**updated_at** | **DateTime** |  | [optional] 
+

data/docs/Bulletin.md

@@ -0,0 +1,15 @@
+# IndexeaClient::Bulletin
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **Integer** |  | [optional] 
+**level** | **String** |  | [optional] 
+**scope** | **Integer** |  | [optional] 
+**title** | **String** |  | [optional] 
+**content** | **String** |  | [optional] 
+**created_at** | **DateTime** |  | [optional] 
+**start_at** | **DateTime** |  | [optional] 
+**expired_at** | **DateTime** |  | [optional] 
+**closable** | **BOOLEAN** |  | [optional] 
+

data/docs/CompanyBean.md

@@ -0,0 +1,24 @@
+# IndexeaClient::CompanyBean
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **String** | 公司名称 | [optional] 
+**url** | **String** | 公司网址 | [optional] 
+**nation** | **String** | 国家 | [optional] 
+**province** | **String** | 省/州/地区 | [optional] 
+**city** | **String** | 城市 | [optional] 
+**taxpayer** | **String** | 纳税人识别号 | [optional] 
+**bank** | **String** | 开户行 | [optional] 
+**account** | **String** | 银行账号 | [optional] 
+**address** | **String** | 公司注册地址 | [optional] 
+**tel** | **String** | 公司电话 | [optional] 
+**license** | **String** | 营业执照图片地址 | [optional] 
+**certificate** | **String** | 一般纳税人证明扫描件图片地址 | [optional] 
+**post_addr** | **String** | 快递地址 | [optional] 
+**post_code** | **String** | 邮编 | [optional] 
+**post_name** | **String** | 收件人姓名 | [optional] 
+**post_tel** | **String** | 收件人电话 | [optional] 
+**created_at** | **DateTime** | 首次填写时间 | [optional] 
+**updated_at** | **DateTime** | 最后更新时间 | [optional] 
+

data/docs/ContactForm.md

@@ -0,0 +1,11 @@
+# IndexeaClient::ContactForm
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**company** | **String** |  | 
+**name** | **String** |  | 
+**tel** | **String** |  | 
+**email** | **String** |  | [optional] 
+**memo** | **String** |  | [optional] 
+

data/docs/CrawlerLog.md

@@ -0,0 +1,14 @@
+# IndexeaClient::CrawlerLog
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **Integer** |  | [optional] 
+**index** | **Integer** |  | [optional] 
+**home_url** | **String** |  | [optional] 
+**begin_at** | **DateTime** |  | [optional] 
+**end_at** | **DateTime** |  | [optional] 
+**used_seconds** | **Integer** |  | [optional] 
+**success_count** | **Integer** |  | [optional] 
+**failed_count** | **Integer** |  | [optional] 
+

data/docs/CrawlerLogs.md

@@ -0,0 +1,8 @@
+# IndexeaClient::CrawlerLogs
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**total** | **Integer** |  | [optional] 
+**logs** | [**Array<CrawlerLog>**](CrawlerLog.md) |  | [optional] 
+

data/docs/CrawlerTask.md

@@ -0,0 +1,16 @@
+# IndexeaClient::CrawlerTask
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**index** | **Integer** |  | [optional] 
+**template** | **String** |  | [optional] 
+**period** | **Integer** |  | [optional] 
+**settings** | **Object** |  | [optional] 
+**created_at** | **DateTime** |  | [optional] 
+**run_times** | **Integer** |  | [optional] 
+**last_updated_at** | **DateTime** |  | [optional] 
+**last_error** | **String** |  | [optional] 
+**error_count** | **Integer** |  | [optional] 
+**status** | **Integer** |  | [optional] 
+

data/docs/FieldsApi.md

@@ -0,0 +1,215 @@
+# IndexeaClient::FieldsApi
+
+All URIs are relative to *https://api.indexea.com/v1*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**index_fields**](FieldsApi.md#index_fields) | **GET** /indices/{app}/{index}/fields | 获取索引字段映射详情
+[**index_update_fields**](FieldsApi.md#index_update_fields) | **POST** /indices/{app}/{index}/fields | 更新索引的字段映射
+[**index_update_html_strip_fields**](FieldsApi.md#index_update_html_strip_fields) | **PATCH** /indices/{app}/{index}/fields | 更新索引的HTML过滤字段列表
+[**index_values_of_field**](FieldsApi.md#index_values_of_field) | **GET** /indices/{app}/{index}/fields/{field} | 获取索引字段的所有值列表
+
+# **index_fields**
+> Object index_fields(app, index)
+
+获取索引字段映射详情
+
+### Example
+```ruby
+# load the gem
+require 'indexea_client'
+# setup authorization
+IndexeaClient.configure do |config|
+end
+
+api_instance = IndexeaClient::FieldsApi.new
+app = 'app_example' # String | 应用标识
+index = 56 # Integer | 索引编号
+
+
+begin
+  #获取索引字段映射详情
+  result = api_instance.index_fields(app, index)
+  p result
+rescue IndexeaClient::ApiError => e
+  puts "Exception when calling FieldsApi->index_fields: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **app** | **String**| 应用标识 | 
+ **index** | **Integer**| 索引编号 | 
+
+### Return type
+
+**Object**
+
+### Authorization
+
+[TokenAuth](../README.md#TokenAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+
+# **index_update_fields**
+> Object index_update_fields(bodyappindex)
+
+更新索引的字段映射
+
+### Example
+```ruby
+# load the gem
+require 'indexea_client'
+# setup authorization
+IndexeaClient.configure do |config|
+end
+
+api_instance = IndexeaClient::FieldsApi.new
+body = nil # Object | 
+app = 'app_example' # String | 应用标识
+index = 56 # Integer | 索引编号
+
+
+begin
+  #更新索引的字段映射
+  result = api_instance.index_update_fields(bodyappindex)
+  p result
+rescue IndexeaClient::ApiError => e
+  puts "Exception when calling FieldsApi->index_update_fields: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **body** | [**Object**](Object.md)|  | 
+ **app** | **String**| 应用标识 | 
+ **index** | **Integer**| 索引编号 | 
+
+### Return type
+
+**Object**
+
+### Authorization
+
+[TokenAuth](../README.md#TokenAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **index_update_html_strip_fields**
+> Object index_update_html_strip_fields(bodyappindex)
+
+更新索引的HTML过滤字段列表
+
+### Example
+```ruby
+# load the gem
+require 'indexea_client'
+# setup authorization
+IndexeaClient.configure do |config|
+end
+
+api_instance = IndexeaClient::FieldsApi.new
+body = nil # Object | 
+app = 'app_example' # String | 应用标识
+index = 56 # Integer | 索引编号
+
+
+begin
+  #更新索引的HTML过滤字段列表
+  result = api_instance.index_update_html_strip_fields(bodyappindex)
+  p result
+rescue IndexeaClient::ApiError => e
+  puts "Exception when calling FieldsApi->index_update_html_strip_fields: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **body** | [**Object**](Object.md)|  | 
+ **app** | **String**| 应用标识 | 
+ **index** | **Integer**| 索引编号 | 
+
+### Return type
+
+**Object**
+
+### Authorization
+
+[TokenAuth](../README.md#TokenAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **index_values_of_field**
+> Array<ValueOfField> index_values_of_field(app, index, field, size)
+
+获取索引字段的所有值列表
+
+### Example
+```ruby
+# load the gem
+require 'indexea_client'
+# setup authorization
+IndexeaClient.configure do |config|
+end
+
+api_instance = IndexeaClient::FieldsApi.new
+app = 'app_example' # String | 应用标识
+index = 56 # Integer | 索引编号
+field = 'field_example' # String | 字段名称
+size = 20 # Integer | values count
+
+
+begin
+  #获取索引字段的所有值列表
+  result = api_instance.index_values_of_field(app, index, field, size)
+  p result
+rescue IndexeaClient::ApiError => e
+  puts "Exception when calling FieldsApi->index_values_of_field: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **app** | **String**| 应用标识 | 
+ **index** | **Integer**| 索引编号 | 
+ **field** | **String**| 字段名称 | 
+ **size** | **Integer**| values count | [default to 20]
+
+### Return type
+
+[**Array<ValueOfField>**](ValueOfField.md)
+
+### Authorization
+
+[TokenAuth](../README.md#TokenAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+

data/docs/GlobalApi.md

@@ -0,0 +1,258 @@
+# IndexeaClient::GlobalApi
+
+All URIs are relative to *https://api.indexea.com/v1*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**json**](GlobalApi.md#json) | **GET** /json | 接口定义(JSON)
+[**options_get**](GlobalApi.md#options_get) | **GET** /options | 系统全局配置接口
+[**status_database**](GlobalApi.md#status_database) | **GET** /status/database | 数据库服务状态测试
+[**status_engine**](GlobalApi.md#status_engine) | **GET** /status/engine | 搜索引擎状态测试
+[**welcome**](GlobalApi.md#welcome) | **GET** / | 接口欢迎信息
+[**yaml**](GlobalApi.md#yaml) | **GET** /yaml | 接口定义(YAML)
+
+# **json**
+> Object json
+
+接口定义(JSON)
+
+获取 OpenAPI 接口定义(JSON)
+
+### Example
+```ruby
+# load the gem
+require 'indexea_client'
+
+api_instance = IndexeaClient::GlobalApi.new
+
+begin
+  #接口定义(JSON)
+  result = api_instance.json
+  p result
+rescue IndexeaClient::ApiError => e
+  puts "Exception when calling GlobalApi->json: #{e}"
+end
+```
+
+### Parameters
+This endpoint does not need any parameter.
+
+### Return type
+
+**Object**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+
+# **options_get**
+> Object options_get(name, keys)
+
+系统全局配置接口
+
+### Example
+```ruby
+# load the gem
+require 'indexea_client'
+
+api_instance = IndexeaClient::GlobalApi.new
+name = 'name_example' # String | 
+keys = 'keys_example' # String | 配置项名,多个配置项请使用逗号隔开
+
+
+begin
+  #系统全局配置接口
+  result = api_instance.options_get(name, keys)
+  p result
+rescue IndexeaClient::ApiError => e
+  puts "Exception when calling GlobalApi->options_get: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **name** | **String**|  | 
+ **keys** | **String**| 配置项名,多个配置项请使用逗号隔开 | 
+
+### Return type
+
+**Object**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+
+# **status_database**
+> String status_database
+
+数据库服务状态测试
+
+### Example
+```ruby
+# load the gem
+require 'indexea_client'
+
+api_instance = IndexeaClient::GlobalApi.new
+
+begin
+  #数据库服务状态测试
+  result = api_instance.status_database
+  p result
+rescue IndexeaClient::ApiError => e
+  puts "Exception when calling GlobalApi->status_database: #{e}"
+end
+```
+
+### Parameters
+This endpoint does not need any parameter.
+
+### Return type
+
+**String**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: text/plain
+
+
+
+# **status_engine**
+> String status_engine
+
+搜索引擎状态测试
+
+### Example
+```ruby
+# load the gem
+require 'indexea_client'
+
+api_instance = IndexeaClient::GlobalApi.new
+
+begin
+  #搜索引擎状态测试
+  result = api_instance.status_engine
+  p result
+rescue IndexeaClient::ApiError => e
+  puts "Exception when calling GlobalApi->status_engine: #{e}"
+end
+```
+
+### Parameters
+This endpoint does not need any parameter.
+
+### Return type
+
+**String**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: text/plain
+
+
+
+# **welcome**
+> String welcome
+
+接口欢迎信息
+
+### Example
+```ruby
+# load the gem
+require 'indexea_client'
+
+api_instance = IndexeaClient::GlobalApi.new
+
+begin
+  #接口欢迎信息
+  result = api_instance.welcome
+  p result
+rescue IndexeaClient::ApiError => e
+  puts "Exception when calling GlobalApi->welcome: #{e}"
+end
+```
+
+### Parameters
+This endpoint does not need any parameter.
+
+### Return type
+
+**String**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: text/plain, text/html, application/json, application/x-yaml
+
+
+
+# **yaml**
+> String yaml
+
+接口定义(YAML)
+
+获取 OpenAPI 接口定义(YAML)
+
+### Example
+```ruby
+# load the gem
+require 'indexea_client'
+
+api_instance = IndexeaClient::GlobalApi.new
+
+begin
+  #接口定义(YAML)
+  result = api_instance.yaml
+  p result
+rescue IndexeaClient::ApiError => e
+  puts "Exception when calling GlobalApi->yaml: #{e}"
+end
+```
+
+### Parameters
+This endpoint does not need any parameter.
+
+### Return type
+
+**String**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/x-yaml
+
+
+

data/docs/GlobalOptionForm.md

@@ -0,0 +1,8 @@
+# IndexeaClient::GlobalOptionForm
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **String** | 配置项名称 | [optional] 
+**value** | **Object** | 配置值 | [optional] 
+

data/docs/IndexBean.md

@@ -0,0 +1,26 @@
+# IndexeaClient::IndexBean
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **Integer** |  | [optional] 
+**account** | **Integer** |  | [optional] 
+**app** | **Integer** |  | [optional] 
+**name** | **String** |  | [optional] 
+**system** | **BOOLEAN** | 是否系统索引（系统索引不允许用户删除） | [optional] 
+**intro** | **String** |  | [optional] 
+**_alias** | **Array<String>** |  | [optional] 
+**type** | **String** |  | [optional] 
+**filters** | **Array<Object>** | 索引关联的临时过滤器 | [optional] 
+**aggs** | **Object** | 索引关联的临时聚合器 | [optional] 
+**sorts** | **Array<Object>** | 索引关联的临时排序 | [optional] 
+**shards** | **Integer** | 该索引的分片数 | [optional] 
+**replicas** | **Integer** | 该索引的副本数 | [optional] 
+**analyzer** | **String** |  | [optional] 
+**search_analyzer** | **String** |  | [optional] 
+**stat** | [**IndexStatBean**](IndexStatBean.md) |  | [optional] 
+**options** | **Object** |  | [optional] 
+**created_at** | **DateTime** |  | [optional] 
+**updated_at** | **DateTime** |  | [optional] 
+**status** | **Integer** |  | [optional] 
+

data/docs/IndexFieldBean.md

@@ -0,0 +1,8 @@
+# IndexeaClient::IndexFieldBean
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**index** | [**IndexBean**](IndexBean.md) |  | [optional] 
+**fields** | **Object** | 字段列表信息 | [optional] 
+

data/docs/IndexForm.md

@@ -0,0 +1,15 @@
+# IndexeaClient::IndexForm
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **String** |  | [optional] 
+**intro** | **String** |  | [optional] 
+**_alias** | **Array<String>** |  | [optional] 
+**type** | **String** |  | [optional] 
+**shards** | **Integer** | 该索引的分片数 | [optional] 
+**replicas** | **Integer** | 该索引的副本数 | [optional] 
+**analyzer** | **String** |  | [optional] 
+**search_analyzer** | **String** |  | [optional] 
+**status** | **Integer** |  | [optional] 
+

data/docs/IndexRebuildForm.md

@@ -0,0 +1,12 @@
+# IndexeaClient::IndexRebuildForm
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**shards** | **Integer** | 该索引的分片数 | [optional] 
+**replicas** | **Integer** | 该索引的副本数 | [optional] 
+**analyzer** | **String** |  | [optional] 
+**search_analyzer** | **String** |  | [optional] 
+**fields** | **Object** |  | [optional] 
+**vcode** | **String** |  | [optional] 
+

data/docs/IndexSettings.md

@@ -0,0 +1,10 @@
+# IndexeaClient::IndexSettings
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**index** | **Integer** |  | [optional] 
+**type** | **String** |  | [optional] 
+**settings** | **Object** |  | [optional] 
+**updated_at** | **DateTime** |  | [optional] 
+