indexea_client 0.0.9

data/docs/IntelligentMapping.md

@@ -0,0 +1,8 @@
+# IndexeaClient::IntelligentMapping
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**word** | **String** | 关键词 | [optional] 
+**field** | **String** | 匹配字段 | [optional] 
+

data/docs/KeywordBindingBean.md

@@ -0,0 +1,14 @@
+# IndexeaClient::KeywordBindingBean
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **Integer** |  | [optional] 
+**app** | **Integer** |  | [optional] 
+**index** | **Integer** |  | [optional] 
+**query** | **Integer** |  | [optional] 
+**keyword** | **String** |  | [optional] 
+**_alias** | **Array<String>** |  | [optional] 
+**ids** | **Array<String>** |  | [optional] 
+**created_at** | **DateTime** |  | [optional] 
+

data/docs/MentorForm.md

@@ -0,0 +1,8 @@
+# IndexeaClient::MentorForm
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**total** | **Integer** | 成员总数 | [optional] 
+**mentors** | [**Array<AccountBean>**](AccountBean.md) | 成员列表 | [optional] 
+

data/docs/Message.md

@@ -0,0 +1,18 @@
+# IndexeaClient::Message
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **Integer** |  | [optional] 
+**account** | **Integer** |  | [optional] 
+**sender** | **Integer** |  | [optional] 
+**receiver** | **Integer** |  | [optional] 
+**name** | **String** |  | [optional] 
+**avater** | **String** |  | [optional] 
+**msg** | **String** |  | [optional] 
+**type** | **Integer** |  | [optional] 
+**msgid** | **Integer** |  | [optional] 
+**created_at** | **DateTime** |  | [optional] 
+**read_at** | **DateTime** |  | [optional] 
+**status** | **Integer** |  | [optional] 
+

data/docs/MessageApi.md

@@ -0,0 +1,262 @@
+# IndexeaClient::MessageApi
+
+All URIs are relative to *https://api.indexea.com/v1*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**message_delete**](MessageApi.md#message_delete) | **DELETE** /accounts/message | 删除消息
+[**message_feedback**](MessageApi.md#message_feedback) | **POST** /accounts/feedback | 反馈意见
+[**message_list**](MessageApi.md#message_list) | **GET** /accounts/message | 获取我相关的消息信息，包括未读消息数量、最新消息等
+[**message_read**](MessageApi.md#message_read) | **PATCH** /accounts/message | 标识消息为已读
+[**message_send**](MessageApi.md#message_send) | **POST** /accounts/message | 发送消息
+
+# **message_delete**
+> BOOLEAN message_delete(id)
+
+删除消息
+
+删除消息
+
+### Example
+```ruby
+# load the gem
+require 'indexea_client'
+# setup authorization
+IndexeaClient.configure do |config|
+end
+
+api_instance = IndexeaClient::MessageApi.new
+id = 56 # Integer | 消息编号
+
+
+begin
+  #删除消息
+  result = api_instance.message_delete(id)
+  p result
+rescue IndexeaClient::ApiError => e
+  puts "Exception when calling MessageApi->message_delete: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **id** | **Integer**| 消息编号 | 
+
+### Return type
+
+**BOOLEAN**
+
+### Authorization
+
+[TokenAuth](../README.md#TokenAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+
+# **message_feedback**
+> BOOLEAN message_feedback(contenttype)
+
+反馈意见
+
+### Example
+```ruby
+# load the gem
+require 'indexea_client'
+# setup authorization
+IndexeaClient.configure do |config|
+end
+
+api_instance = IndexeaClient::MessageApi.new
+content = 'content_example' # String | 
+type = 'type_example' # String | 
+
+
+begin
+  #反馈意见
+  result = api_instance.message_feedback(contenttype)
+  p result
+rescue IndexeaClient::ApiError => e
+  puts "Exception when calling MessageApi->message_feedback: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **content** | **String**|  | 
+ **type** | **String**|  | 
+
+### Return type
+
+**BOOLEAN**
+
+### Authorization
+
+[TokenAuth](../README.md#TokenAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/x-www-form-urlencoded
+ - **Accept**: application/json
+
+
+
+# **message_list**
+> Messages message_list(scope, size, opts)
+
+获取我相关的消息信息，包括未读消息数量、最新消息等
+
+### Example
+```ruby
+# load the gem
+require 'indexea_client'
+# setup authorization
+IndexeaClient.configure do |config|
+end
+
+api_instance = IndexeaClient::MessageApi.new
+scope = 'unread' # String | 
+size = 10 # Integer | 消息数量
+opts = { 
+  from: 0 # Integer | 用于翻页的起始位置
+}
+
+begin
+  #获取我相关的消息信息，包括未读消息数量、最新消息等
+  result = api_instance.message_list(scope, size, opts)
+  p result
+rescue IndexeaClient::ApiError => e
+  puts "Exception when calling MessageApi->message_list: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **scope** | **String**|  | [default to unread]
+ **size** | **Integer**| 消息数量 | [default to 10]
+ **from** | **Integer**| 用于翻页的起始位置 | [optional] [default to 0]
+
+### Return type
+
+[**Messages**](Messages.md)
+
+### Authorization
+
+[TokenAuth](../README.md#TokenAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+
+# **message_read**
+> Messages message_read(id)
+
+标识消息为已读
+
+标识消息为已读
+
+### Example
+```ruby
+# load the gem
+require 'indexea_client'
+# setup authorization
+IndexeaClient.configure do |config|
+end
+
+api_instance = IndexeaClient::MessageApi.new
+id = 'id_example' # String | 消息编号,多个消息使用逗号隔开
+
+
+begin
+  #标识消息为已读
+  result = api_instance.message_read(id)
+  p result
+rescue IndexeaClient::ApiError => e
+  puts "Exception when calling MessageApi->message_read: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **id** | **String**| 消息编号,多个消息使用逗号隔开 | 
+
+### Return type
+
+[**Messages**](Messages.md)
+
+### Authorization
+
+[TokenAuth](../README.md#TokenAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+
+# **message_send**
+> Message message_send(receivermsg)
+
+发送消息
+
+发送站内消息给某人
+
+### Example
+```ruby
+# load the gem
+require 'indexea_client'
+# setup authorization
+IndexeaClient.configure do |config|
+end
+
+api_instance = IndexeaClient::MessageApi.new
+receiver = 56 # Integer | 
+msg = 'msg_example' # String | 
+
+
+begin
+  #发送消息
+  result = api_instance.message_send(receivermsg)
+  p result
+rescue IndexeaClient::ApiError => e
+  puts "Exception when calling MessageApi->message_send: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **receiver** | **Integer**|  | 
+ **msg** | **String**|  | 
+
+### Return type
+
+[**Message**](Message.md)
+
+### Authorization
+
+[TokenAuth](../README.md#TokenAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/x-www-form-urlencoded
+ - **Accept**: application/json
+
+
+

data/docs/Messages.md

@@ -0,0 +1,8 @@
+# IndexeaClient::Messages
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**count** | **Integer** |  | [optional] 
+**msgs** | [**Array<Message>**](Message.md) |  | [optional] 
+

data/docs/OauthAppBean.md

@@ -0,0 +1,20 @@
+# IndexeaClient::OauthAppBean
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **Integer** |  | [optional] 
+**account** | **Integer** |  | [optional] 
+**app** | **Integer** |  | [optional] 
+**ident** | **String** | 三方应用标识 client id | [optional] 
+**name** | **String** |  | [optional] 
+**intro** | **String** |  | [optional] 
+**logo** | **String** |  | [optional] 
+**url** | **String** | 应用地址 | [optional] 
+**secret** | **String** | 第三方应用密钥, 该值仅在创建和重置密钥时返回 | [optional] 
+**callback** | **String** | 回调地址 | [optional] 
+**scopes** | **String** | 授权范围 | [optional] 
+**created_at** | **DateTime** |  | [optional] 
+**updated_at** | **DateTime** |  | [optional] 
+**status** | **Integer** |  | [optional] 
+

data/docs/OpenidBean.md

@@ -0,0 +1,10 @@
+# IndexeaClient::OpenidBean
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**type** | **String** | 类型 | [optional] 
+**openid** | **String** | 三方账号唯一标识 | [optional] 
+**name** | **String** | 三方账号昵称 | [optional] 
+**created_at** | **DateTime** | 首次登录时间 | [optional] 
+

data/docs/OptionForm.md

@@ -0,0 +1,10 @@
+# IndexeaClient::OptionForm
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**key** | **String** | 配置项名称 | 
+**type** | **String** | 配置值类型 | 
+**value** | **String** | 配置值 | 
+**vcode** | **String** | 验证码(非必须，只有在配置通知邮箱和手机的时候才需要) | [optional] 
+

data/docs/OrdersIdentBody.md

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

data/docs/PayResult.md

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