indexea_client 0.0.9
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +7 -0
- data/Gemfile +9 -0
- data/README.md +3413 -0
- data/Rakefile +8 -0
- data/docs/AccountApi.md +685 -0
- data/docs/AccountBean.md +27 -0
- data/docs/AccountPasswdBody.md +8 -0
- data/docs/AccountPortraitBody.md +7 -0
- data/docs/AccountProfileBody.md +8 -0
- data/docs/AccountResetpwdBody.md +9 -0
- data/docs/AccountSigninBody.md +9 -0
- data/docs/AccountSignupBody.md +10 -0
- data/docs/AccountsFeedbackBody.md +8 -0
- data/docs/AccountsMessageBody.md +8 -0
- data/docs/AnalyzeObject.md +8 -0
- data/docs/AnalyzeToken.md +11 -0
- data/docs/AppBean.md +23 -0
- data/docs/AppCompanyBody.md +22 -0
- data/docs/AppIndexBody.md +7 -0
- data/docs/AppLogAccount.md +9 -0
- data/docs/AppLogBean.md +19 -0
- data/docs/AppLogsBean.md +9 -0
- data/docs/AppMentorBean.md +14 -0
- data/docs/AppOauthBody.md +7 -0
- data/docs/AppOauthBody1.md +7 -0
- data/docs/AppOauthresetsecretBody.md +7 -0
- data/docs/AppTokensBody.md +7 -0
- data/docs/AppTokensBody1.md +7 -0
- data/docs/AppWidgetBody.md +7 -0
- data/docs/AppsApi.md +1843 -0
- data/docs/AppsAppBody.md +8 -0
- data/docs/AppsBody.md +8 -0
- data/docs/AutoCompleteItem.md +9 -0
- data/docs/BlacklistBean.md +12 -0
- data/docs/Bulletin.md +15 -0
- data/docs/CompanyBean.md +24 -0
- data/docs/ContactForm.md +11 -0
- data/docs/CrawlerLog.md +14 -0
- data/docs/CrawlerLogs.md +8 -0
- data/docs/CrawlerTask.md +16 -0
- data/docs/FieldsApi.md +215 -0
- data/docs/GlobalApi.md +258 -0
- data/docs/GlobalOptionForm.md +8 -0
- data/docs/IndexBean.md +26 -0
- data/docs/IndexFieldBean.md +8 -0
- data/docs/IndexForm.md +15 -0
- data/docs/IndexRebuildForm.md +12 -0
- data/docs/IndexSettings.md +10 -0
- data/docs/IndexSettingsBody.md +7 -0
- data/docs/IndexStatBean.md +14 -0
- data/docs/IndexSynonymsflushBody.md +7 -0
- data/docs/IndexTask.md +13 -0
- data/docs/IndexTemplate.md +17 -0
- data/docs/IndexTemplates.md +8 -0
- data/docs/IndexUploadBody.md +7 -0
- data/docs/IndicesApi.md +1620 -0
- data/docs/IntelligentMapping.md +8 -0
- data/docs/KeywordBindingBean.md +14 -0
- data/docs/MentorForm.md +8 -0
- data/docs/Message.md +18 -0
- data/docs/MessageApi.md +262 -0
- data/docs/Messages.md +8 -0
- data/docs/OauthAppBean.md +20 -0
- data/docs/OpenidBean.md +10 -0
- data/docs/OptionForm.md +10 -0
- data/docs/OrdersIdentBody.md +7 -0
- data/docs/PayResult.md +9 -0
- data/docs/PaymentApi.md +788 -0
- data/docs/PaymentInvoice.md +15 -0
- data/docs/PaymentOrder.md +25 -0
- data/docs/PaymentRecord.md +13 -0
- data/docs/PaymentService.md +12 -0
- data/docs/QueriesApi.md +1821 -0
- data/docs/QueryActionBean.md +27 -0
- data/docs/QueryBean.md +22 -0
- data/docs/QueryForm.md +15 -0
- data/docs/QueryNode.md +10 -0
- data/docs/QuerySortField.md +9 -0
- data/docs/QueryVariableBean.md +17 -0
- data/docs/RecommendApi.md +365 -0
- data/docs/RecommendBean.md +18 -0
- data/docs/RecordFilter.md +10 -0
- data/docs/RecordsApi.md +286 -0
- data/docs/SearchApi.md +646 -0
- data/docs/SearchEstimateResult.md +11 -0
- data/docs/SearchWord.md +8 -0
- data/docs/StatIndexBean.md +14 -0
- data/docs/StatsApi.md +245 -0
- data/docs/SynonymsBean.md +14 -0
- data/docs/TokenBean.md +12 -0
- data/docs/TriggerBean.md +13 -0
- data/docs/TriggerLogBean.md +15 -0
- data/docs/ValueOfField.md +8 -0
- data/docs/WidgetBean.md +21 -0
- data/docs/WidgetForm.md +13 -0
- data/docs/WidgetLogo.md +7 -0
- data/docs/WidgetLogoBody.md +7 -0
- data/docs/WidgetStatusForm.md +8 -0
- data/docs/WidgetsApi.md +573 -0
- data/git_push.sh +55 -0
- data/indexea_client.gemspec +38 -0
- data/lib/indexea_client/api/account_api.rb +846 -0
- data/lib/indexea_client/api/apps_api.rb +2271 -0
- data/lib/indexea_client/api/fields_api.rb +289 -0
- data/lib/indexea_client/api/global_api.rb +326 -0
- data/lib/indexea_client/api/indices_api.rb +2076 -0
- data/lib/indexea_client/api/message_api.rb +337 -0
- data/lib/indexea_client/api/payment_api.rb +975 -0
- data/lib/indexea_client/api/queries_api.rb +2320 -0
- data/lib/indexea_client/api/recommend_api.rb +461 -0
- data/lib/indexea_client/api/records_api.rb +375 -0
- data/lib/indexea_client/api/search_api.rb +892 -0
- data/lib/indexea_client/api/stats_api.rb +312 -0
- data/lib/indexea_client/api/widgets_api.rb +741 -0
- data/lib/indexea_client/api_client.rb +391 -0
- data/lib/indexea_client/api_error.rb +57 -0
- data/lib/indexea_client/configuration.rb +205 -0
- data/lib/indexea_client/models/account_bean.rb +396 -0
- data/lib/indexea_client/models/account_passwd_body.rb +227 -0
- data/lib/indexea_client/models/account_portrait_body.rb +206 -0
- data/lib/indexea_client/models/account_profile_body.rb +228 -0
- data/lib/indexea_client/models/account_resetpwd_body.rb +240 -0
- data/lib/indexea_client/models/account_signin_body.rb +237 -0
- data/lib/indexea_client/models/account_signup_body.rb +254 -0
- data/lib/indexea_client/models/accounts_feedback_body.rb +262 -0
- data/lib/indexea_client/models/accounts_message_body.rb +226 -0
- data/lib/indexea_client/models/analyze_object.rb +216 -0
- data/lib/indexea_client/models/analyze_token.rb +243 -0
- data/lib/indexea_client/models/app_bean.rb +360 -0
- data/lib/indexea_client/models/app_company_body.rb +357 -0
- data/lib/indexea_client/models/app_index_body.rb +212 -0
- data/lib/indexea_client/models/app_log_account.rb +224 -0
- data/lib/indexea_client/models/app_log_bean.rb +318 -0
- data/lib/indexea_client/models/app_logs_bean.rb +229 -0
- data/lib/indexea_client/models/app_mentor_bean.rb +277 -0
- data/lib/indexea_client/models/app_oauth_body.rb +206 -0
- data/lib/indexea_client/models/app_oauth_body_1.rb +212 -0
- data/lib/indexea_client/models/app_oauthresetsecret_body.rb +212 -0
- data/lib/indexea_client/models/app_tokens_body.rb +212 -0
- data/lib/indexea_client/models/app_tokens_body_1.rb +212 -0
- data/lib/indexea_client/models/app_widget_body.rb +212 -0
- data/lib/indexea_client/models/apps_app_body.rb +216 -0
- data/lib/indexea_client/models/apps_body.rb +221 -0
- data/lib/indexea_client/models/auto_complete_item.rb +224 -0
- data/lib/indexea_client/models/blacklist_bean.rb +258 -0
- data/lib/indexea_client/models/bulletin.rb +312 -0
- data/lib/indexea_client/models/company_bean.rb +378 -0
- data/lib/indexea_client/models/contact_form.rb +258 -0
- data/lib/indexea_client/models/crawler_log.rb +270 -0
- data/lib/indexea_client/models/crawler_logs.rb +217 -0
- data/lib/indexea_client/models/crawler_task.rb +288 -0
- data/lib/indexea_client/models/global_option_form.rb +218 -0
- data/lib/indexea_client/models/index_bean.rb +390 -0
- data/lib/indexea_client/models/index_field_bean.rb +217 -0
- data/lib/indexea_client/models/index_form.rb +283 -0
- data/lib/indexea_client/models/index_rebuild_form.rb +254 -0
- data/lib/indexea_client/models/index_settings.rb +234 -0
- data/lib/indexea_client/models/index_settings_body.rb +212 -0
- data/lib/indexea_client/models/index_stat_bean.rb +270 -0
- data/lib/indexea_client/models/index_synonymsflush_body.rb +212 -0
- data/lib/indexea_client/models/index_task.rb +261 -0
- data/lib/indexea_client/models/index_template.rb +299 -0
- data/lib/indexea_client/models/index_templates.rb +219 -0
- data/lib/indexea_client/models/index_upload_body.rb +208 -0
- data/lib/indexea_client/models/intelligent_mapping.rb +217 -0
- data/lib/indexea_client/models/keyword_binding_bean.rb +274 -0
- data/lib/indexea_client/models/mentor_form.rb +220 -0
- data/lib/indexea_client/models/message.rb +306 -0
- data/lib/indexea_client/models/messages.rb +217 -0
- data/lib/indexea_client/models/oauth_app_bean.rb +329 -0
- data/lib/indexea_client/models/openid_bean.rb +238 -0
- data/lib/indexea_client/models/option_form.rb +287 -0
- data/lib/indexea_client/models/orders_ident_body.rb +206 -0
- data/lib/indexea_client/models/pay_result.rb +258 -0
- data/lib/indexea_client/models/payment_invoice.rb +283 -0
- data/lib/indexea_client/models/payment_order.rb +412 -0
- data/lib/indexea_client/models/payment_record.rb +261 -0
- data/lib/indexea_client/models/payment_service.rb +258 -0
- data/lib/indexea_client/models/query_action_bean.rb +391 -0
- data/lib/indexea_client/models/query_bean.rb +348 -0
- data/lib/indexea_client/models/query_form.rb +285 -0
- data/lib/indexea_client/models/query_node.rb +234 -0
- data/lib/indexea_client/models/query_sort_field.rb +264 -0
- data/lib/indexea_client/models/query_variable_bean.rb +335 -0
- data/lib/indexea_client/models/recommend_bean.rb +318 -0
- data/lib/indexea_client/models/record_filter.rb +242 -0
- data/lib/indexea_client/models/search_estimate_result.rb +242 -0
- data/lib/indexea_client/models/search_word.rb +218 -0
- data/lib/indexea_client/models/stat_index_bean.rb +270 -0
- data/lib/indexea_client/models/synonyms_bean.rb +274 -0
- data/lib/indexea_client/models/token_bean.rb +252 -0
- data/lib/indexea_client/models/trigger_bean.rb +263 -0
- data/lib/indexea_client/models/trigger_log_bean.rb +279 -0
- data/lib/indexea_client/models/value_of_field.rb +217 -0
- data/lib/indexea_client/models/widget_bean.rb +387 -0
- data/lib/indexea_client/models/widget_form.rb +328 -0
- data/lib/indexea_client/models/widget_logo.rb +206 -0
- data/lib/indexea_client/models/widget_logo_body.rb +206 -0
- data/lib/indexea_client/models/widget_status_form.rb +223 -0
- data/lib/indexea_client/version.rb +14 -0
- data/lib/indexea_client.rb +133 -0
- data/spec/api/account_api_spec.rb +200 -0
- data/spec/api/apps_api_spec.rb +492 -0
- data/spec/api/fields_api_spec.rb +86 -0
- data/spec/api/global_api_spec.rb +98 -0
- data/spec/api/indices_api_spec.rb +434 -0
- data/spec/api/message_api_spec.rb +96 -0
- data/spec/api/payment_api_spec.rb +227 -0
- data/spec/api/queries_api_spec.rb +482 -0
- data/spec/api/recommend_api_spec.rb +125 -0
- data/spec/api/records_api_spec.rb +107 -0
- data/spec/api/search_api_spec.rb +220 -0
- data/spec/api/stats_api_spec.rb +99 -0
- data/spec/api/widgets_api_spec.rb +174 -0
- data/spec/api_client_spec.rb +225 -0
- data/spec/base_object_spec.rb +109 -0
- data/spec/configuration_spec.rb +41 -0
- data/spec/models/account_bean_spec.rb +160 -0
- data/spec/models/account_passwd_body_spec.rb +46 -0
- data/spec/models/account_portrait_body_spec.rb +40 -0
- data/spec/models/account_profile_body_spec.rb +46 -0
- data/spec/models/account_resetpwd_body_spec.rb +52 -0
- data/spec/models/account_signin_body_spec.rb +52 -0
- data/spec/models/account_signup_body_spec.rb +58 -0
- data/spec/models/accounts_feedback_body_spec.rb +50 -0
- data/spec/models/accounts_message_body_spec.rb +46 -0
- data/spec/models/analyze_object_spec.rb +46 -0
- data/spec/models/analyze_token_spec.rb +64 -0
- data/spec/models/app_bean_spec.rb +136 -0
- data/spec/models/app_company_body_spec.rb +130 -0
- data/spec/models/app_index_body_spec.rb +40 -0
- data/spec/models/app_log_account_spec.rb +52 -0
- data/spec/models/app_log_bean_spec.rb +112 -0
- data/spec/models/app_logs_bean_spec.rb +52 -0
- data/spec/models/app_mentor_bean_spec.rb +82 -0
- data/spec/models/app_oauth_body_1_spec.rb +40 -0
- data/spec/models/app_oauth_body_spec.rb +40 -0
- data/spec/models/app_oauthresetsecret_body_spec.rb +40 -0
- data/spec/models/app_tokens_body_1_spec.rb +40 -0
- data/spec/models/app_tokens_body_spec.rb +40 -0
- data/spec/models/app_widget_body_spec.rb +40 -0
- data/spec/models/apps_app_body_spec.rb +46 -0
- data/spec/models/apps_body_spec.rb +46 -0
- data/spec/models/auto_complete_item_spec.rb +52 -0
- data/spec/models/blacklist_bean_spec.rb +70 -0
- data/spec/models/bulletin_spec.rb +92 -0
- data/spec/models/company_bean_spec.rb +142 -0
- data/spec/models/contact_form_spec.rb +64 -0
- data/spec/models/crawler_log_spec.rb +82 -0
- data/spec/models/crawler_logs_spec.rb +46 -0
- data/spec/models/crawler_task_spec.rb +94 -0
- data/spec/models/global_option_form_spec.rb +46 -0
- data/spec/models/index_bean_spec.rb +154 -0
- data/spec/models/index_field_bean_spec.rb +46 -0
- data/spec/models/index_form_spec.rb +88 -0
- data/spec/models/index_rebuild_form_spec.rb +70 -0
- data/spec/models/index_settings_body_spec.rb +40 -0
- data/spec/models/index_settings_spec.rb +58 -0
- data/spec/models/index_stat_bean_spec.rb +82 -0
- data/spec/models/index_synonymsflush_body_spec.rb +40 -0
- data/spec/models/index_task_spec.rb +76 -0
- data/spec/models/index_template_spec.rb +100 -0
- data/spec/models/index_templates_spec.rb +46 -0
- data/spec/models/index_upload_body_spec.rb +40 -0
- data/spec/models/intelligent_mapping_spec.rb +46 -0
- data/spec/models/keyword_binding_bean_spec.rb +82 -0
- data/spec/models/mentor_form_spec.rb +46 -0
- data/spec/models/message_spec.rb +106 -0
- data/spec/models/messages_spec.rb +46 -0
- data/spec/models/oauth_app_bean_spec.rb +118 -0
- data/spec/models/openid_bean_spec.rb +58 -0
- data/spec/models/option_form_spec.rb +62 -0
- data/spec/models/orders_ident_body_spec.rb +40 -0
- data/spec/models/pay_result_spec.rb +56 -0
- data/spec/models/payment_invoice_spec.rb +88 -0
- data/spec/models/payment_order_spec.rb +152 -0
- data/spec/models/payment_record_spec.rb +76 -0
- data/spec/models/payment_service_spec.rb +70 -0
- data/spec/models/query_action_bean_spec.rb +160 -0
- data/spec/models/query_bean_spec.rb +130 -0
- data/spec/models/query_form_spec.rb +88 -0
- data/spec/models/query_node_spec.rb +58 -0
- data/spec/models/query_sort_field_spec.rb +56 -0
- data/spec/models/query_variable_bean_spec.rb +104 -0
- data/spec/models/recommend_bean_spec.rb +106 -0
- data/spec/models/record_filter_spec.rb +58 -0
- data/spec/models/search_estimate_result_spec.rb +64 -0
- data/spec/models/search_word_spec.rb +46 -0
- data/spec/models/stat_index_bean_spec.rb +82 -0
- data/spec/models/synonyms_bean_spec.rb +82 -0
- data/spec/models/token_bean_spec.rb +70 -0
- data/spec/models/trigger_bean_spec.rb +76 -0
- data/spec/models/trigger_log_bean_spec.rb +88 -0
- data/spec/models/value_of_field_spec.rb +46 -0
- data/spec/models/widget_bean_spec.rb +132 -0
- data/spec/models/widget_form_spec.rb +84 -0
- data/spec/models/widget_logo_body_spec.rb +40 -0
- data/spec/models/widget_logo_spec.rb +40 -0
- data/spec/models/widget_status_form_spec.rb +46 -0
- data/spec/spec_helper.rb +110 -0
- metadata +501 -0
@@ -0,0 +1,14 @@
|
|
1
|
+
# IndexeaClient::KeywordBindingBean
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**id** | **Integer** | | [optional]
|
7
|
+
**app** | **Integer** | | [optional]
|
8
|
+
**index** | **Integer** | | [optional]
|
9
|
+
**query** | **Integer** | | [optional]
|
10
|
+
**keyword** | **String** | | [optional]
|
11
|
+
**_alias** | **Array<String>** | | [optional]
|
12
|
+
**ids** | **Array<String>** | | [optional]
|
13
|
+
**created_at** | **DateTime** | | [optional]
|
14
|
+
|
data/docs/MentorForm.md
ADDED
@@ -0,0 +1,8 @@
|
|
1
|
+
# IndexeaClient::MentorForm
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**total** | **Integer** | 成员总数 | [optional]
|
7
|
+
**mentors** | [**Array<AccountBean>**](AccountBean.md) | 成员列表 | [optional]
|
8
|
+
|
data/docs/Message.md
ADDED
@@ -0,0 +1,18 @@
|
|
1
|
+
# IndexeaClient::Message
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**id** | **Integer** | | [optional]
|
7
|
+
**account** | **Integer** | | [optional]
|
8
|
+
**sender** | **Integer** | | [optional]
|
9
|
+
**receiver** | **Integer** | | [optional]
|
10
|
+
**name** | **String** | | [optional]
|
11
|
+
**avater** | **String** | | [optional]
|
12
|
+
**msg** | **String** | | [optional]
|
13
|
+
**type** | **Integer** | | [optional]
|
14
|
+
**msgid** | **Integer** | | [optional]
|
15
|
+
**created_at** | **DateTime** | | [optional]
|
16
|
+
**read_at** | **DateTime** | | [optional]
|
17
|
+
**status** | **Integer** | | [optional]
|
18
|
+
|
data/docs/MessageApi.md
ADDED
@@ -0,0 +1,262 @@
|
|
1
|
+
# IndexeaClient::MessageApi
|
2
|
+
|
3
|
+
All URIs are relative to *https://api.indexea.com/v1*
|
4
|
+
|
5
|
+
Method | HTTP request | Description
|
6
|
+
------------- | ------------- | -------------
|
7
|
+
[**message_delete**](MessageApi.md#message_delete) | **DELETE** /accounts/message | 删除消息
|
8
|
+
[**message_feedback**](MessageApi.md#message_feedback) | **POST** /accounts/feedback | 反馈意见
|
9
|
+
[**message_list**](MessageApi.md#message_list) | **GET** /accounts/message | 获取我相关的消息信息,包括未读消息数量、最新消息等
|
10
|
+
[**message_read**](MessageApi.md#message_read) | **PATCH** /accounts/message | 标识消息为已读
|
11
|
+
[**message_send**](MessageApi.md#message_send) | **POST** /accounts/message | 发送消息
|
12
|
+
|
13
|
+
# **message_delete**
|
14
|
+
> BOOLEAN message_delete(id)
|
15
|
+
|
16
|
+
删除消息
|
17
|
+
|
18
|
+
删除消息
|
19
|
+
|
20
|
+
### Example
|
21
|
+
```ruby
|
22
|
+
# load the gem
|
23
|
+
require 'indexea_client'
|
24
|
+
# setup authorization
|
25
|
+
IndexeaClient.configure do |config|
|
26
|
+
end
|
27
|
+
|
28
|
+
api_instance = IndexeaClient::MessageApi.new
|
29
|
+
id = 56 # Integer | 消息编号
|
30
|
+
|
31
|
+
|
32
|
+
begin
|
33
|
+
#删除消息
|
34
|
+
result = api_instance.message_delete(id)
|
35
|
+
p result
|
36
|
+
rescue IndexeaClient::ApiError => e
|
37
|
+
puts "Exception when calling MessageApi->message_delete: #{e}"
|
38
|
+
end
|
39
|
+
```
|
40
|
+
|
41
|
+
### Parameters
|
42
|
+
|
43
|
+
Name | Type | Description | Notes
|
44
|
+
------------- | ------------- | ------------- | -------------
|
45
|
+
**id** | **Integer**| 消息编号 |
|
46
|
+
|
47
|
+
### Return type
|
48
|
+
|
49
|
+
**BOOLEAN**
|
50
|
+
|
51
|
+
### Authorization
|
52
|
+
|
53
|
+
[TokenAuth](../README.md#TokenAuth)
|
54
|
+
|
55
|
+
### HTTP request headers
|
56
|
+
|
57
|
+
- **Content-Type**: Not defined
|
58
|
+
- **Accept**: application/json
|
59
|
+
|
60
|
+
|
61
|
+
|
62
|
+
# **message_feedback**
|
63
|
+
> BOOLEAN message_feedback(contenttype)
|
64
|
+
|
65
|
+
反馈意见
|
66
|
+
|
67
|
+
### Example
|
68
|
+
```ruby
|
69
|
+
# load the gem
|
70
|
+
require 'indexea_client'
|
71
|
+
# setup authorization
|
72
|
+
IndexeaClient.configure do |config|
|
73
|
+
end
|
74
|
+
|
75
|
+
api_instance = IndexeaClient::MessageApi.new
|
76
|
+
content = 'content_example' # String |
|
77
|
+
type = 'type_example' # String |
|
78
|
+
|
79
|
+
|
80
|
+
begin
|
81
|
+
#反馈意见
|
82
|
+
result = api_instance.message_feedback(contenttype)
|
83
|
+
p result
|
84
|
+
rescue IndexeaClient::ApiError => e
|
85
|
+
puts "Exception when calling MessageApi->message_feedback: #{e}"
|
86
|
+
end
|
87
|
+
```
|
88
|
+
|
89
|
+
### Parameters
|
90
|
+
|
91
|
+
Name | Type | Description | Notes
|
92
|
+
------------- | ------------- | ------------- | -------------
|
93
|
+
**content** | **String**| |
|
94
|
+
**type** | **String**| |
|
95
|
+
|
96
|
+
### Return type
|
97
|
+
|
98
|
+
**BOOLEAN**
|
99
|
+
|
100
|
+
### Authorization
|
101
|
+
|
102
|
+
[TokenAuth](../README.md#TokenAuth)
|
103
|
+
|
104
|
+
### HTTP request headers
|
105
|
+
|
106
|
+
- **Content-Type**: application/x-www-form-urlencoded
|
107
|
+
- **Accept**: application/json
|
108
|
+
|
109
|
+
|
110
|
+
|
111
|
+
# **message_list**
|
112
|
+
> Messages message_list(scope, size, opts)
|
113
|
+
|
114
|
+
获取我相关的消息信息,包括未读消息数量、最新消息等
|
115
|
+
|
116
|
+
### Example
|
117
|
+
```ruby
|
118
|
+
# load the gem
|
119
|
+
require 'indexea_client'
|
120
|
+
# setup authorization
|
121
|
+
IndexeaClient.configure do |config|
|
122
|
+
end
|
123
|
+
|
124
|
+
api_instance = IndexeaClient::MessageApi.new
|
125
|
+
scope = 'unread' # String |
|
126
|
+
size = 10 # Integer | 消息数量
|
127
|
+
opts = {
|
128
|
+
from: 0 # Integer | 用于翻页的起始位置
|
129
|
+
}
|
130
|
+
|
131
|
+
begin
|
132
|
+
#获取我相关的消息信息,包括未读消息数量、最新消息等
|
133
|
+
result = api_instance.message_list(scope, size, opts)
|
134
|
+
p result
|
135
|
+
rescue IndexeaClient::ApiError => e
|
136
|
+
puts "Exception when calling MessageApi->message_list: #{e}"
|
137
|
+
end
|
138
|
+
```
|
139
|
+
|
140
|
+
### Parameters
|
141
|
+
|
142
|
+
Name | Type | Description | Notes
|
143
|
+
------------- | ------------- | ------------- | -------------
|
144
|
+
**scope** | **String**| | [default to unread]
|
145
|
+
**size** | **Integer**| 消息数量 | [default to 10]
|
146
|
+
**from** | **Integer**| 用于翻页的起始位置 | [optional] [default to 0]
|
147
|
+
|
148
|
+
### Return type
|
149
|
+
|
150
|
+
[**Messages**](Messages.md)
|
151
|
+
|
152
|
+
### Authorization
|
153
|
+
|
154
|
+
[TokenAuth](../README.md#TokenAuth)
|
155
|
+
|
156
|
+
### HTTP request headers
|
157
|
+
|
158
|
+
- **Content-Type**: Not defined
|
159
|
+
- **Accept**: application/json
|
160
|
+
|
161
|
+
|
162
|
+
|
163
|
+
# **message_read**
|
164
|
+
> Messages message_read(id)
|
165
|
+
|
166
|
+
标识消息为已读
|
167
|
+
|
168
|
+
标识消息为已读
|
169
|
+
|
170
|
+
### Example
|
171
|
+
```ruby
|
172
|
+
# load the gem
|
173
|
+
require 'indexea_client'
|
174
|
+
# setup authorization
|
175
|
+
IndexeaClient.configure do |config|
|
176
|
+
end
|
177
|
+
|
178
|
+
api_instance = IndexeaClient::MessageApi.new
|
179
|
+
id = 'id_example' # String | 消息编号,多个消息使用逗号隔开
|
180
|
+
|
181
|
+
|
182
|
+
begin
|
183
|
+
#标识消息为已读
|
184
|
+
result = api_instance.message_read(id)
|
185
|
+
p result
|
186
|
+
rescue IndexeaClient::ApiError => e
|
187
|
+
puts "Exception when calling MessageApi->message_read: #{e}"
|
188
|
+
end
|
189
|
+
```
|
190
|
+
|
191
|
+
### Parameters
|
192
|
+
|
193
|
+
Name | Type | Description | Notes
|
194
|
+
------------- | ------------- | ------------- | -------------
|
195
|
+
**id** | **String**| 消息编号,多个消息使用逗号隔开 |
|
196
|
+
|
197
|
+
### Return type
|
198
|
+
|
199
|
+
[**Messages**](Messages.md)
|
200
|
+
|
201
|
+
### Authorization
|
202
|
+
|
203
|
+
[TokenAuth](../README.md#TokenAuth)
|
204
|
+
|
205
|
+
### HTTP request headers
|
206
|
+
|
207
|
+
- **Content-Type**: Not defined
|
208
|
+
- **Accept**: application/json
|
209
|
+
|
210
|
+
|
211
|
+
|
212
|
+
# **message_send**
|
213
|
+
> Message message_send(receivermsg)
|
214
|
+
|
215
|
+
发送消息
|
216
|
+
|
217
|
+
发送站内消息给某人
|
218
|
+
|
219
|
+
### Example
|
220
|
+
```ruby
|
221
|
+
# load the gem
|
222
|
+
require 'indexea_client'
|
223
|
+
# setup authorization
|
224
|
+
IndexeaClient.configure do |config|
|
225
|
+
end
|
226
|
+
|
227
|
+
api_instance = IndexeaClient::MessageApi.new
|
228
|
+
receiver = 56 # Integer |
|
229
|
+
msg = 'msg_example' # String |
|
230
|
+
|
231
|
+
|
232
|
+
begin
|
233
|
+
#发送消息
|
234
|
+
result = api_instance.message_send(receivermsg)
|
235
|
+
p result
|
236
|
+
rescue IndexeaClient::ApiError => e
|
237
|
+
puts "Exception when calling MessageApi->message_send: #{e}"
|
238
|
+
end
|
239
|
+
```
|
240
|
+
|
241
|
+
### Parameters
|
242
|
+
|
243
|
+
Name | Type | Description | Notes
|
244
|
+
------------- | ------------- | ------------- | -------------
|
245
|
+
**receiver** | **Integer**| |
|
246
|
+
**msg** | **String**| |
|
247
|
+
|
248
|
+
### Return type
|
249
|
+
|
250
|
+
[**Message**](Message.md)
|
251
|
+
|
252
|
+
### Authorization
|
253
|
+
|
254
|
+
[TokenAuth](../README.md#TokenAuth)
|
255
|
+
|
256
|
+
### HTTP request headers
|
257
|
+
|
258
|
+
- **Content-Type**: application/x-www-form-urlencoded
|
259
|
+
- **Accept**: application/json
|
260
|
+
|
261
|
+
|
262
|
+
|
data/docs/Messages.md
ADDED
@@ -0,0 +1,20 @@
|
|
1
|
+
# IndexeaClient::OauthAppBean
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**id** | **Integer** | | [optional]
|
7
|
+
**account** | **Integer** | | [optional]
|
8
|
+
**app** | **Integer** | | [optional]
|
9
|
+
**ident** | **String** | 三方应用标识 client id | [optional]
|
10
|
+
**name** | **String** | | [optional]
|
11
|
+
**intro** | **String** | | [optional]
|
12
|
+
**logo** | **String** | | [optional]
|
13
|
+
**url** | **String** | 应用地址 | [optional]
|
14
|
+
**secret** | **String** | 第三方应用密钥, 该值仅在创建和重置密钥时返回 | [optional]
|
15
|
+
**callback** | **String** | 回调地址 | [optional]
|
16
|
+
**scopes** | **String** | 授权范围 | [optional]
|
17
|
+
**created_at** | **DateTime** | | [optional]
|
18
|
+
**updated_at** | **DateTime** | | [optional]
|
19
|
+
**status** | **Integer** | | [optional]
|
20
|
+
|
data/docs/OpenidBean.md
ADDED
@@ -0,0 +1,10 @@
|
|
1
|
+
# IndexeaClient::OpenidBean
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**type** | **String** | 类型 | [optional]
|
7
|
+
**openid** | **String** | 三方账号唯一标识 | [optional]
|
8
|
+
**name** | **String** | 三方账号昵称 | [optional]
|
9
|
+
**created_at** | **DateTime** | 首次登录时间 | [optional]
|
10
|
+
|
data/docs/OptionForm.md
ADDED
@@ -0,0 +1,10 @@
|
|
1
|
+
# IndexeaClient::OptionForm
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**key** | **String** | 配置项名称 |
|
7
|
+
**type** | **String** | 配置值类型 |
|
8
|
+
**value** | **String** | 配置值 |
|
9
|
+
**vcode** | **String** | 验证码(非必须,只有在配置通知邮箱和手机的时候才需要) | [optional]
|
10
|
+
|
data/docs/PayResult.md
ADDED
@@ -0,0 +1,9 @@
|
|
1
|
+
# IndexeaClient::PayResult
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**status** | **String** | | [optional]
|
7
|
+
**url** | **String** | | [optional]
|
8
|
+
**props** | **Object** | | [optional]
|
9
|
+
|