indexea_client 0.0.9

data/docs/StatsApi.md

@@ -0,0 +1,245 @@
+# IndexeaClient::StatsApi
+
+All URIs are relative to *https://api.indexea.com/v1*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**stats_recomms**](StatsApi.md#stats_recomms) | **GET** /stats/{app}/recomms | 获取推荐日志的汇总信息
+[**stats_searchs**](StatsApi.md#stats_searchs) | **GET** /stats/{app}/searchs | 获取搜索日志的汇总信息
+[**stats_top_clicks**](StatsApi.md#stats_top_clicks) | **GET** /stats/{app}/top-clicks | 获取点击排行榜
+[**stats_widgets**](StatsApi.md#stats_widgets) | **GET** /stats/{app}/widgets | 获取模板与组件的统计信息
+
+# **stats_recomms**
+> Object stats_recomms(app, opts)
+
+获取推荐日志的汇总信息
+
+### Example
+```ruby
+# load the gem
+require 'indexea_client'
+# setup authorization
+IndexeaClient.configure do |config|
+end
+
+api_instance = IndexeaClient::StatsApi.new
+app = 'app_example' # String | 应用标识
+opts = { 
+  recomm: 0, # Integer | 统计指定推荐
+  start_date: Date.parse('2013-10-20'), # Date | 统计起始日期
+  end_date: Date.parse('2013-10-20'), # Date | 统计结束日期
+  interval: 'date' # String | 统计间隔 - 日、周、月、季度、年
+}
+
+begin
+  #获取推荐日志的汇总信息
+  result = api_instance.stats_recomms(app, opts)
+  p result
+rescue IndexeaClient::ApiError => e
+  puts "Exception when calling StatsApi->stats_recomms: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **app** | **String**| 应用标识 | 
+ **recomm** | **Integer**| 统计指定推荐 | [optional] [default to 0]
+ **start_date** | **Date**| 统计起始日期 | [optional] 
+ **end_date** | **Date**| 统计结束日期 | [optional] 
+ **interval** | **String**| 统计间隔 - 日、周、月、季度、年 | [optional] [default to date]
+
+### Return type
+
+**Object**
+
+### Authorization
+
+[TokenAuth](../README.md#TokenAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+
+# **stats_searchs**
+> Object stats_searchs(app, opts)
+
+获取搜索日志的汇总信息
+
+### Example
+```ruby
+# load the gem
+require 'indexea_client'
+# setup authorization
+IndexeaClient.configure do |config|
+end
+
+api_instance = IndexeaClient::StatsApi.new
+app = 'app_example' # String | 应用标识
+opts = { 
+  index: 0, # Integer | 统计指定索引
+  query: 0, # Integer | 统计指定查询
+  widget: 0, # Integer | 统计指定组件
+  start_date: Date.parse('2013-10-20'), # Date | 统计起始日期
+  end_date: Date.parse('2013-10-20'), # Date | 统计结束日期
+  interval: 'date' # String | 统计间隔 - 日、周、月、季度、年
+}
+
+begin
+  #获取搜索日志的汇总信息
+  result = api_instance.stats_searchs(app, opts)
+  p result
+rescue IndexeaClient::ApiError => e
+  puts "Exception when calling StatsApi->stats_searchs: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **app** | **String**| 应用标识 | 
+ **index** | **Integer**| 统计指定索引 | [optional] [default to 0]
+ **query** | **Integer**| 统计指定查询 | [optional] [default to 0]
+ **widget** | **Integer**| 统计指定组件 | [optional] [default to 0]
+ **start_date** | **Date**| 统计起始日期 | [optional] 
+ **end_date** | **Date**| 统计结束日期 | [optional] 
+ **interval** | **String**| 统计间隔 - 日、周、月、季度、年 | [optional] [default to date]
+
+### Return type
+
+**Object**
+
+### Authorization
+
+[TokenAuth](../README.md#TokenAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+
+# **stats_top_clicks**
+> Array<Object> stats_top_clicks(app, size, opts)
+
+获取点击排行榜
+
+### Example
+```ruby
+# load the gem
+require 'indexea_client'
+# setup authorization
+IndexeaClient.configure do |config|
+end
+
+api_instance = IndexeaClient::StatsApi.new
+app = 'app_example' # String | 应用标识
+size = 10 # Integer | 排行榜大小
+opts = { 
+  index: 0, # Integer | 统计指定索引
+  query: 0, # Integer | 统计指定查询
+  recomm: 0, # Integer | 统计指定推荐组件
+  widget: 0, # Integer | 统计指定组件
+  start_date: Date.parse('2013-10-20'), # Date | 统计起始日期
+  end_date: Date.parse('2013-10-20') # Date | 统计结束日期
+}
+
+begin
+  #获取点击排行榜
+  result = api_instance.stats_top_clicks(app, size, opts)
+  p result
+rescue IndexeaClient::ApiError => e
+  puts "Exception when calling StatsApi->stats_top_clicks: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **app** | **String**| 应用标识 | 
+ **size** | **Integer**| 排行榜大小 | [default to 10]
+ **index** | **Integer**| 统计指定索引 | [optional] [default to 0]
+ **query** | **Integer**| 统计指定查询 | [optional] [default to 0]
+ **recomm** | **Integer**| 统计指定推荐组件 | [optional] [default to 0]
+ **widget** | **Integer**| 统计指定组件 | [optional] [default to 0]
+ **start_date** | **Date**| 统计起始日期 | [optional] 
+ **end_date** | **Date**| 统计结束日期 | [optional] 
+
+### Return type
+
+**Array<Object>**
+
+### Authorization
+
+[TokenAuth](../README.md#TokenAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+
+# **stats_widgets**
+> Object stats_widgets(app, opts)
+
+获取模板与组件的统计信息
+
+### Example
+```ruby
+# load the gem
+require 'indexea_client'
+# setup authorization
+IndexeaClient.configure do |config|
+end
+
+api_instance = IndexeaClient::StatsApi.new
+app = 'app_example' # String | 应用标识
+opts = { 
+  widget: 0, # Integer | 统计指定模板或组件
+  start_date: Date.parse('2013-10-20'), # Date | 统计起始日期
+  end_date: Date.parse('2013-10-20'), # Date | 统计结束日期
+  interval: 'date' # String | 统计间隔 - 日、周、月、季度、年
+}
+
+begin
+  #获取模板与组件的统计信息
+  result = api_instance.stats_widgets(app, opts)
+  p result
+rescue IndexeaClient::ApiError => e
+  puts "Exception when calling StatsApi->stats_widgets: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **app** | **String**| 应用标识 | 
+ **widget** | **Integer**| 统计指定模板或组件 | [optional] [default to 0]
+ **start_date** | **Date**| 统计起始日期 | [optional] 
+ **end_date** | **Date**| 统计结束日期 | [optional] 
+ **interval** | **String**| 统计间隔 - 日、周、月、季度、年 | [optional] [default to date]
+
+### Return type
+
+**Object**
+
+### Authorization
+
+[TokenAuth](../README.md#TokenAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+

data/docs/SynonymsBean.md

@@ -0,0 +1,14 @@
+# IndexeaClient::SynonymsBean
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **Integer** |  | [optional] 
+**app** | **Integer** |  | [optional] 
+**index** | **Integer** |  | [optional] 
+**type** | **Integer** |  | [optional] 
+**words** | **Array<String>** |  | [optional] 
+**synonyms** | **Array<String>** |  | [optional] 
+**updated_at** | **DateTime** |  | [optional] 
+**status** | **Integer** |  | [optional] 
+

data/docs/TokenBean.md

@@ -0,0 +1,12 @@
+# IndexeaClient::TokenBean
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **Integer** |  | [optional] 
+**name** | **String** |  | [optional] 
+**token** | **String** |  | [optional] 
+**scopes** | **Object** |  | [optional] 
+**created_at** | **DateTime** |  | [optional] 
+**expired_at** | **DateTime** |  | [optional] 
+

data/docs/TriggerBean.md

@@ -0,0 +1,13 @@
+# IndexeaClient::TriggerBean
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**app** | **Integer** |  | [optional] 
+**url** | **String** |  | [optional] 
+**triggers** | **String** |  | [optional] 
+**password** | **String** |  | [optional] 
+**all_triggers** | **Array<String>** |  | [optional] 
+**enabled** | **BOOLEAN** |  | [optional] 
+**created_at** | **DateTime** |  | [optional] 
+

data/docs/TriggerLogBean.md

@@ -0,0 +1,15 @@
+# IndexeaClient::TriggerLogBean
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **Integer** |  | [optional] 
+**app** | **Integer** |  | [optional] 
+**log** | **Integer** |  | [optional] 
+**url** | **String** |  | [optional] 
+**body** | **String** |  | [optional] 
+**resp_code** | **Integer** |  | [optional] 
+**resp_body** | **String** |  | [optional] 
+**resp_time** | **Integer** |  | [optional] 
+**created_at** | **DateTime** |  | [optional] 
+

data/docs/ValueOfField.md

@@ -0,0 +1,8 @@
+# IndexeaClient::ValueOfField
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**key** | **String** | 字段值 | [optional] 
+**doc_count** | **Integer** | 记录数 | [optional] 
+

data/docs/WidgetBean.md

@@ -0,0 +1,21 @@
+# IndexeaClient::WidgetBean
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **Integer** |  | [optional] 
+**ident** | **String** |  | [optional] 
+**account** | **Integer** |  | [optional] 
+**app** | **Integer** |  | [optional] 
+**name** | **String** |  | [optional] 
+**type** | **String** |  | [optional] [default to 'web']
+**sub_type** | **String** |  | [optional] [default to 'None']
+**intro** | **String** |  | [optional] 
+**queries** | [**Array<QueryBean>**](QueryBean.md) |  | [optional] 
+**layout** | **String** | 组件布局 | [optional] 
+**settings** | **Object** | 组件设置参数 | [optional] 
+**download_url** | **String** |  | [optional] 
+**created_at** | **DateTime** |  | [optional] 
+**updated_at** | **DateTime** |  | [optional] 
+**status** | **Integer** |  | [optional] 
+

data/docs/WidgetForm.md

@@ -0,0 +1,13 @@
+# IndexeaClient::WidgetForm
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **String** |  | 
+**type** | **String** |  | [default to 'web']
+**sub_type** | **String** |  | [optional] [default to 'None']
+**intro** | **String** |  | [optional] 
+**queries** | **Array<Integer>** |  | 
+**layout** | **String** |  | [optional] 
+**status** | **Integer** |  | [optional] 
+

data/docs/WidgetLogo.md

@@ -0,0 +1,7 @@
+# IndexeaClient::WidgetLogo
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**logo** | **String** |  | [optional] 
+

data/docs/WidgetLogoBody.md

@@ -0,0 +1,7 @@
+# IndexeaClient::WidgetLogoBody
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**logo** | **String** |  | [optional] 
+

data/docs/WidgetStatusForm.md

@@ -0,0 +1,8 @@
+# IndexeaClient::WidgetStatusForm
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**status** | **Integer** |  | 
+**options** | [**Array<OptionForm>**](OptionForm.md) |  | [optional] 
+