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.
Files changed (301) hide show
  1. checksums.yaml +7 -0
  2. data/Gemfile +9 -0
  3. data/README.md +3413 -0
  4. data/Rakefile +8 -0
  5. data/docs/AccountApi.md +685 -0
  6. data/docs/AccountBean.md +27 -0
  7. data/docs/AccountPasswdBody.md +8 -0
  8. data/docs/AccountPortraitBody.md +7 -0
  9. data/docs/AccountProfileBody.md +8 -0
  10. data/docs/AccountResetpwdBody.md +9 -0
  11. data/docs/AccountSigninBody.md +9 -0
  12. data/docs/AccountSignupBody.md +10 -0
  13. data/docs/AccountsFeedbackBody.md +8 -0
  14. data/docs/AccountsMessageBody.md +8 -0
  15. data/docs/AnalyzeObject.md +8 -0
  16. data/docs/AnalyzeToken.md +11 -0
  17. data/docs/AppBean.md +23 -0
  18. data/docs/AppCompanyBody.md +22 -0
  19. data/docs/AppIndexBody.md +7 -0
  20. data/docs/AppLogAccount.md +9 -0
  21. data/docs/AppLogBean.md +19 -0
  22. data/docs/AppLogsBean.md +9 -0
  23. data/docs/AppMentorBean.md +14 -0
  24. data/docs/AppOauthBody.md +7 -0
  25. data/docs/AppOauthBody1.md +7 -0
  26. data/docs/AppOauthresetsecretBody.md +7 -0
  27. data/docs/AppTokensBody.md +7 -0
  28. data/docs/AppTokensBody1.md +7 -0
  29. data/docs/AppWidgetBody.md +7 -0
  30. data/docs/AppsApi.md +1843 -0
  31. data/docs/AppsAppBody.md +8 -0
  32. data/docs/AppsBody.md +8 -0
  33. data/docs/AutoCompleteItem.md +9 -0
  34. data/docs/BlacklistBean.md +12 -0
  35. data/docs/Bulletin.md +15 -0
  36. data/docs/CompanyBean.md +24 -0
  37. data/docs/ContactForm.md +11 -0
  38. data/docs/CrawlerLog.md +14 -0
  39. data/docs/CrawlerLogs.md +8 -0
  40. data/docs/CrawlerTask.md +16 -0
  41. data/docs/FieldsApi.md +215 -0
  42. data/docs/GlobalApi.md +258 -0
  43. data/docs/GlobalOptionForm.md +8 -0
  44. data/docs/IndexBean.md +26 -0
  45. data/docs/IndexFieldBean.md +8 -0
  46. data/docs/IndexForm.md +15 -0
  47. data/docs/IndexRebuildForm.md +12 -0
  48. data/docs/IndexSettings.md +10 -0
  49. data/docs/IndexSettingsBody.md +7 -0
  50. data/docs/IndexStatBean.md +14 -0
  51. data/docs/IndexSynonymsflushBody.md +7 -0
  52. data/docs/IndexTask.md +13 -0
  53. data/docs/IndexTemplate.md +17 -0
  54. data/docs/IndexTemplates.md +8 -0
  55. data/docs/IndexUploadBody.md +7 -0
  56. data/docs/IndicesApi.md +1620 -0
  57. data/docs/IntelligentMapping.md +8 -0
  58. data/docs/KeywordBindingBean.md +14 -0
  59. data/docs/MentorForm.md +8 -0
  60. data/docs/Message.md +18 -0
  61. data/docs/MessageApi.md +262 -0
  62. data/docs/Messages.md +8 -0
  63. data/docs/OauthAppBean.md +20 -0
  64. data/docs/OpenidBean.md +10 -0
  65. data/docs/OptionForm.md +10 -0
  66. data/docs/OrdersIdentBody.md +7 -0
  67. data/docs/PayResult.md +9 -0
  68. data/docs/PaymentApi.md +788 -0
  69. data/docs/PaymentInvoice.md +15 -0
  70. data/docs/PaymentOrder.md +25 -0
  71. data/docs/PaymentRecord.md +13 -0
  72. data/docs/PaymentService.md +12 -0
  73. data/docs/QueriesApi.md +1821 -0
  74. data/docs/QueryActionBean.md +27 -0
  75. data/docs/QueryBean.md +22 -0
  76. data/docs/QueryForm.md +15 -0
  77. data/docs/QueryNode.md +10 -0
  78. data/docs/QuerySortField.md +9 -0
  79. data/docs/QueryVariableBean.md +17 -0
  80. data/docs/RecommendApi.md +365 -0
  81. data/docs/RecommendBean.md +18 -0
  82. data/docs/RecordFilter.md +10 -0
  83. data/docs/RecordsApi.md +286 -0
  84. data/docs/SearchApi.md +646 -0
  85. data/docs/SearchEstimateResult.md +11 -0
  86. data/docs/SearchWord.md +8 -0
  87. data/docs/StatIndexBean.md +14 -0
  88. data/docs/StatsApi.md +245 -0
  89. data/docs/SynonymsBean.md +14 -0
  90. data/docs/TokenBean.md +12 -0
  91. data/docs/TriggerBean.md +13 -0
  92. data/docs/TriggerLogBean.md +15 -0
  93. data/docs/ValueOfField.md +8 -0
  94. data/docs/WidgetBean.md +21 -0
  95. data/docs/WidgetForm.md +13 -0
  96. data/docs/WidgetLogo.md +7 -0
  97. data/docs/WidgetLogoBody.md +7 -0
  98. data/docs/WidgetStatusForm.md +8 -0
  99. data/docs/WidgetsApi.md +573 -0
  100. data/git_push.sh +55 -0
  101. data/indexea_client.gemspec +38 -0
  102. data/lib/indexea_client/api/account_api.rb +846 -0
  103. data/lib/indexea_client/api/apps_api.rb +2271 -0
  104. data/lib/indexea_client/api/fields_api.rb +289 -0
  105. data/lib/indexea_client/api/global_api.rb +326 -0
  106. data/lib/indexea_client/api/indices_api.rb +2076 -0
  107. data/lib/indexea_client/api/message_api.rb +337 -0
  108. data/lib/indexea_client/api/payment_api.rb +975 -0
  109. data/lib/indexea_client/api/queries_api.rb +2320 -0
  110. data/lib/indexea_client/api/recommend_api.rb +461 -0
  111. data/lib/indexea_client/api/records_api.rb +375 -0
  112. data/lib/indexea_client/api/search_api.rb +892 -0
  113. data/lib/indexea_client/api/stats_api.rb +312 -0
  114. data/lib/indexea_client/api/widgets_api.rb +741 -0
  115. data/lib/indexea_client/api_client.rb +391 -0
  116. data/lib/indexea_client/api_error.rb +57 -0
  117. data/lib/indexea_client/configuration.rb +205 -0
  118. data/lib/indexea_client/models/account_bean.rb +396 -0
  119. data/lib/indexea_client/models/account_passwd_body.rb +227 -0
  120. data/lib/indexea_client/models/account_portrait_body.rb +206 -0
  121. data/lib/indexea_client/models/account_profile_body.rb +228 -0
  122. data/lib/indexea_client/models/account_resetpwd_body.rb +240 -0
  123. data/lib/indexea_client/models/account_signin_body.rb +237 -0
  124. data/lib/indexea_client/models/account_signup_body.rb +254 -0
  125. data/lib/indexea_client/models/accounts_feedback_body.rb +262 -0
  126. data/lib/indexea_client/models/accounts_message_body.rb +226 -0
  127. data/lib/indexea_client/models/analyze_object.rb +216 -0
  128. data/lib/indexea_client/models/analyze_token.rb +243 -0
  129. data/lib/indexea_client/models/app_bean.rb +360 -0
  130. data/lib/indexea_client/models/app_company_body.rb +357 -0
  131. data/lib/indexea_client/models/app_index_body.rb +212 -0
  132. data/lib/indexea_client/models/app_log_account.rb +224 -0
  133. data/lib/indexea_client/models/app_log_bean.rb +318 -0
  134. data/lib/indexea_client/models/app_logs_bean.rb +229 -0
  135. data/lib/indexea_client/models/app_mentor_bean.rb +277 -0
  136. data/lib/indexea_client/models/app_oauth_body.rb +206 -0
  137. data/lib/indexea_client/models/app_oauth_body_1.rb +212 -0
  138. data/lib/indexea_client/models/app_oauthresetsecret_body.rb +212 -0
  139. data/lib/indexea_client/models/app_tokens_body.rb +212 -0
  140. data/lib/indexea_client/models/app_tokens_body_1.rb +212 -0
  141. data/lib/indexea_client/models/app_widget_body.rb +212 -0
  142. data/lib/indexea_client/models/apps_app_body.rb +216 -0
  143. data/lib/indexea_client/models/apps_body.rb +221 -0
  144. data/lib/indexea_client/models/auto_complete_item.rb +224 -0
  145. data/lib/indexea_client/models/blacklist_bean.rb +258 -0
  146. data/lib/indexea_client/models/bulletin.rb +312 -0
  147. data/lib/indexea_client/models/company_bean.rb +378 -0
  148. data/lib/indexea_client/models/contact_form.rb +258 -0
  149. data/lib/indexea_client/models/crawler_log.rb +270 -0
  150. data/lib/indexea_client/models/crawler_logs.rb +217 -0
  151. data/lib/indexea_client/models/crawler_task.rb +288 -0
  152. data/lib/indexea_client/models/global_option_form.rb +218 -0
  153. data/lib/indexea_client/models/index_bean.rb +390 -0
  154. data/lib/indexea_client/models/index_field_bean.rb +217 -0
  155. data/lib/indexea_client/models/index_form.rb +283 -0
  156. data/lib/indexea_client/models/index_rebuild_form.rb +254 -0
  157. data/lib/indexea_client/models/index_settings.rb +234 -0
  158. data/lib/indexea_client/models/index_settings_body.rb +212 -0
  159. data/lib/indexea_client/models/index_stat_bean.rb +270 -0
  160. data/lib/indexea_client/models/index_synonymsflush_body.rb +212 -0
  161. data/lib/indexea_client/models/index_task.rb +261 -0
  162. data/lib/indexea_client/models/index_template.rb +299 -0
  163. data/lib/indexea_client/models/index_templates.rb +219 -0
  164. data/lib/indexea_client/models/index_upload_body.rb +208 -0
  165. data/lib/indexea_client/models/intelligent_mapping.rb +217 -0
  166. data/lib/indexea_client/models/keyword_binding_bean.rb +274 -0
  167. data/lib/indexea_client/models/mentor_form.rb +220 -0
  168. data/lib/indexea_client/models/message.rb +306 -0
  169. data/lib/indexea_client/models/messages.rb +217 -0
  170. data/lib/indexea_client/models/oauth_app_bean.rb +329 -0
  171. data/lib/indexea_client/models/openid_bean.rb +238 -0
  172. data/lib/indexea_client/models/option_form.rb +287 -0
  173. data/lib/indexea_client/models/orders_ident_body.rb +206 -0
  174. data/lib/indexea_client/models/pay_result.rb +258 -0
  175. data/lib/indexea_client/models/payment_invoice.rb +283 -0
  176. data/lib/indexea_client/models/payment_order.rb +412 -0
  177. data/lib/indexea_client/models/payment_record.rb +261 -0
  178. data/lib/indexea_client/models/payment_service.rb +258 -0
  179. data/lib/indexea_client/models/query_action_bean.rb +391 -0
  180. data/lib/indexea_client/models/query_bean.rb +348 -0
  181. data/lib/indexea_client/models/query_form.rb +285 -0
  182. data/lib/indexea_client/models/query_node.rb +234 -0
  183. data/lib/indexea_client/models/query_sort_field.rb +264 -0
  184. data/lib/indexea_client/models/query_variable_bean.rb +335 -0
  185. data/lib/indexea_client/models/recommend_bean.rb +318 -0
  186. data/lib/indexea_client/models/record_filter.rb +242 -0
  187. data/lib/indexea_client/models/search_estimate_result.rb +242 -0
  188. data/lib/indexea_client/models/search_word.rb +218 -0
  189. data/lib/indexea_client/models/stat_index_bean.rb +270 -0
  190. data/lib/indexea_client/models/synonyms_bean.rb +274 -0
  191. data/lib/indexea_client/models/token_bean.rb +252 -0
  192. data/lib/indexea_client/models/trigger_bean.rb +263 -0
  193. data/lib/indexea_client/models/trigger_log_bean.rb +279 -0
  194. data/lib/indexea_client/models/value_of_field.rb +217 -0
  195. data/lib/indexea_client/models/widget_bean.rb +387 -0
  196. data/lib/indexea_client/models/widget_form.rb +328 -0
  197. data/lib/indexea_client/models/widget_logo.rb +206 -0
  198. data/lib/indexea_client/models/widget_logo_body.rb +206 -0
  199. data/lib/indexea_client/models/widget_status_form.rb +223 -0
  200. data/lib/indexea_client/version.rb +14 -0
  201. data/lib/indexea_client.rb +133 -0
  202. data/spec/api/account_api_spec.rb +200 -0
  203. data/spec/api/apps_api_spec.rb +492 -0
  204. data/spec/api/fields_api_spec.rb +86 -0
  205. data/spec/api/global_api_spec.rb +98 -0
  206. data/spec/api/indices_api_spec.rb +434 -0
  207. data/spec/api/message_api_spec.rb +96 -0
  208. data/spec/api/payment_api_spec.rb +227 -0
  209. data/spec/api/queries_api_spec.rb +482 -0
  210. data/spec/api/recommend_api_spec.rb +125 -0
  211. data/spec/api/records_api_spec.rb +107 -0
  212. data/spec/api/search_api_spec.rb +220 -0
  213. data/spec/api/stats_api_spec.rb +99 -0
  214. data/spec/api/widgets_api_spec.rb +174 -0
  215. data/spec/api_client_spec.rb +225 -0
  216. data/spec/base_object_spec.rb +109 -0
  217. data/spec/configuration_spec.rb +41 -0
  218. data/spec/models/account_bean_spec.rb +160 -0
  219. data/spec/models/account_passwd_body_spec.rb +46 -0
  220. data/spec/models/account_portrait_body_spec.rb +40 -0
  221. data/spec/models/account_profile_body_spec.rb +46 -0
  222. data/spec/models/account_resetpwd_body_spec.rb +52 -0
  223. data/spec/models/account_signin_body_spec.rb +52 -0
  224. data/spec/models/account_signup_body_spec.rb +58 -0
  225. data/spec/models/accounts_feedback_body_spec.rb +50 -0
  226. data/spec/models/accounts_message_body_spec.rb +46 -0
  227. data/spec/models/analyze_object_spec.rb +46 -0
  228. data/spec/models/analyze_token_spec.rb +64 -0
  229. data/spec/models/app_bean_spec.rb +136 -0
  230. data/spec/models/app_company_body_spec.rb +130 -0
  231. data/spec/models/app_index_body_spec.rb +40 -0
  232. data/spec/models/app_log_account_spec.rb +52 -0
  233. data/spec/models/app_log_bean_spec.rb +112 -0
  234. data/spec/models/app_logs_bean_spec.rb +52 -0
  235. data/spec/models/app_mentor_bean_spec.rb +82 -0
  236. data/spec/models/app_oauth_body_1_spec.rb +40 -0
  237. data/spec/models/app_oauth_body_spec.rb +40 -0
  238. data/spec/models/app_oauthresetsecret_body_spec.rb +40 -0
  239. data/spec/models/app_tokens_body_1_spec.rb +40 -0
  240. data/spec/models/app_tokens_body_spec.rb +40 -0
  241. data/spec/models/app_widget_body_spec.rb +40 -0
  242. data/spec/models/apps_app_body_spec.rb +46 -0
  243. data/spec/models/apps_body_spec.rb +46 -0
  244. data/spec/models/auto_complete_item_spec.rb +52 -0
  245. data/spec/models/blacklist_bean_spec.rb +70 -0
  246. data/spec/models/bulletin_spec.rb +92 -0
  247. data/spec/models/company_bean_spec.rb +142 -0
  248. data/spec/models/contact_form_spec.rb +64 -0
  249. data/spec/models/crawler_log_spec.rb +82 -0
  250. data/spec/models/crawler_logs_spec.rb +46 -0
  251. data/spec/models/crawler_task_spec.rb +94 -0
  252. data/spec/models/global_option_form_spec.rb +46 -0
  253. data/spec/models/index_bean_spec.rb +154 -0
  254. data/spec/models/index_field_bean_spec.rb +46 -0
  255. data/spec/models/index_form_spec.rb +88 -0
  256. data/spec/models/index_rebuild_form_spec.rb +70 -0
  257. data/spec/models/index_settings_body_spec.rb +40 -0
  258. data/spec/models/index_settings_spec.rb +58 -0
  259. data/spec/models/index_stat_bean_spec.rb +82 -0
  260. data/spec/models/index_synonymsflush_body_spec.rb +40 -0
  261. data/spec/models/index_task_spec.rb +76 -0
  262. data/spec/models/index_template_spec.rb +100 -0
  263. data/spec/models/index_templates_spec.rb +46 -0
  264. data/spec/models/index_upload_body_spec.rb +40 -0
  265. data/spec/models/intelligent_mapping_spec.rb +46 -0
  266. data/spec/models/keyword_binding_bean_spec.rb +82 -0
  267. data/spec/models/mentor_form_spec.rb +46 -0
  268. data/spec/models/message_spec.rb +106 -0
  269. data/spec/models/messages_spec.rb +46 -0
  270. data/spec/models/oauth_app_bean_spec.rb +118 -0
  271. data/spec/models/openid_bean_spec.rb +58 -0
  272. data/spec/models/option_form_spec.rb +62 -0
  273. data/spec/models/orders_ident_body_spec.rb +40 -0
  274. data/spec/models/pay_result_spec.rb +56 -0
  275. data/spec/models/payment_invoice_spec.rb +88 -0
  276. data/spec/models/payment_order_spec.rb +152 -0
  277. data/spec/models/payment_record_spec.rb +76 -0
  278. data/spec/models/payment_service_spec.rb +70 -0
  279. data/spec/models/query_action_bean_spec.rb +160 -0
  280. data/spec/models/query_bean_spec.rb +130 -0
  281. data/spec/models/query_form_spec.rb +88 -0
  282. data/spec/models/query_node_spec.rb +58 -0
  283. data/spec/models/query_sort_field_spec.rb +56 -0
  284. data/spec/models/query_variable_bean_spec.rb +104 -0
  285. data/spec/models/recommend_bean_spec.rb +106 -0
  286. data/spec/models/record_filter_spec.rb +58 -0
  287. data/spec/models/search_estimate_result_spec.rb +64 -0
  288. data/spec/models/search_word_spec.rb +46 -0
  289. data/spec/models/stat_index_bean_spec.rb +82 -0
  290. data/spec/models/synonyms_bean_spec.rb +82 -0
  291. data/spec/models/token_bean_spec.rb +70 -0
  292. data/spec/models/trigger_bean_spec.rb +76 -0
  293. data/spec/models/trigger_log_bean_spec.rb +88 -0
  294. data/spec/models/value_of_field_spec.rb +46 -0
  295. data/spec/models/widget_bean_spec.rb +132 -0
  296. data/spec/models/widget_form_spec.rb +84 -0
  297. data/spec/models/widget_logo_body_spec.rb +40 -0
  298. data/spec/models/widget_logo_spec.rb +40 -0
  299. data/spec/models/widget_status_form_spec.rb +46 -0
  300. data/spec/spec_helper.rb +110 -0
  301. metadata +501 -0
data/Rakefile ADDED
@@ -0,0 +1,8 @@
1
+ begin
2
+ require 'rspec/core/rake_task'
3
+
4
+ RSpec::Core::RakeTask.new(:spec)
5
+ task default: :spec
6
+ rescue LoadError
7
+ # no rspec available
8
+ end
@@ -0,0 +1,685 @@
1
+ # IndexeaClient::AccountApi
2
+
3
+ All URIs are relative to *https://api.indexea.com/v1*
4
+
5
+ Method | HTTP request | Description
6
+ ------------- | ------------- | -------------
7
+ [**account_bulletin**](AccountApi.md#account_bulletin) | **GET** /accounts/bulletin | 获取系统公告
8
+ [**account_delete**](AccountApi.md#account_delete) | **DELETE** /account/profile | 注销账号
9
+ [**account_delete_openid**](AccountApi.md#account_delete_openid) | **DELETE** /account/openid | 解绑三方账号
10
+ [**account_openid**](AccountApi.md#account_openid) | **GET** /account/openid | 获取绑定的所有三方账号
11
+ [**account_passwd**](AccountApi.md#account_passwd) | **POST** /account/passwd | 修改账号密码
12
+ [**account_portrait**](AccountApi.md#account_portrait) | **POST** /account/portrait | 修改账号头像
13
+ [**account_profile**](AccountApi.md#account_profile) | **GET** /account/profile | 获取登录账号信息
14
+ [**account_reset_pwd**](AccountApi.md#account_reset_pwd) | **POST** /account/reset-pwd | 重置账号密码
15
+ [**account_send_verify_code**](AccountApi.md#account_send_verify_code) | **GET** /account/send-verify-code | 发送账号验证码
16
+ [**account_signin**](AccountApi.md#account_signin) | **POST** /account/signin | 登录系统
17
+ [**account_signout**](AccountApi.md#account_signout) | **POST** /account/sign-out | 退出登录状态
18
+ [**account_signup**](AccountApi.md#account_signup) | **POST** /account/signup | 注册新账号
19
+ [**account_update**](AccountApi.md#account_update) | **POST** /account/profile | 修改账号资料
20
+ [**account_update_settings**](AccountApi.md#account_update_settings) | **POST** /account/settings | 修改账号设置
21
+
22
+ # **account_bulletin**
23
+ > Bulletin account_bulletin
24
+
25
+ 获取系统公告
26
+
27
+ 获取系统公告
28
+
29
+ ### Example
30
+ ```ruby
31
+ # load the gem
32
+ require 'indexea_client'
33
+ # setup authorization
34
+ IndexeaClient.configure do |config|
35
+ end
36
+
37
+ api_instance = IndexeaClient::AccountApi.new
38
+
39
+ begin
40
+ #获取系统公告
41
+ result = api_instance.account_bulletin
42
+ p result
43
+ rescue IndexeaClient::ApiError => e
44
+ puts "Exception when calling AccountApi->account_bulletin: #{e}"
45
+ end
46
+ ```
47
+
48
+ ### Parameters
49
+ This endpoint does not need any parameter.
50
+
51
+ ### Return type
52
+
53
+ [**Bulletin**](Bulletin.md)
54
+
55
+ ### Authorization
56
+
57
+ [TokenAuth](../README.md#TokenAuth)
58
+
59
+ ### HTTP request headers
60
+
61
+ - **Content-Type**: Not defined
62
+ - **Accept**: application/json
63
+
64
+
65
+
66
+ # **account_delete**
67
+ > BOOLEAN account_delete(opts)
68
+
69
+ 注销账号
70
+
71
+ ### Example
72
+ ```ruby
73
+ # load the gem
74
+ require 'indexea_client'
75
+ # setup authorization
76
+ IndexeaClient.configure do |config|
77
+ end
78
+
79
+ api_instance = IndexeaClient::AccountApi.new
80
+ opts = {
81
+ pwd: 'pwd_example' # String |
82
+ vcode: 'vcode_example' # String |
83
+ }
84
+
85
+ begin
86
+ #注销账号
87
+ result = api_instance.account_delete(opts)
88
+ p result
89
+ rescue IndexeaClient::ApiError => e
90
+ puts "Exception when calling AccountApi->account_delete: #{e}"
91
+ end
92
+ ```
93
+
94
+ ### Parameters
95
+
96
+ Name | Type | Description | Notes
97
+ ------------- | ------------- | ------------- | -------------
98
+ **pwd** | [**String**](.md)| | [optional]
99
+ **vcode** | **String**| | [optional]
100
+
101
+ ### Return type
102
+
103
+ **BOOLEAN**
104
+
105
+ ### Authorization
106
+
107
+ [TokenAuth](../README.md#TokenAuth)
108
+
109
+ ### HTTP request headers
110
+
111
+ - **Content-Type**: application/x-www-form-urlencoded
112
+ - **Accept**: application/json
113
+
114
+
115
+
116
+ # **account_delete_openid**
117
+ > BOOLEAN account_delete_openid(type, openid)
118
+
119
+ 解绑三方账号
120
+
121
+ ### Example
122
+ ```ruby
123
+ # load the gem
124
+ require 'indexea_client'
125
+ # setup authorization
126
+ IndexeaClient.configure do |config|
127
+ end
128
+
129
+ api_instance = IndexeaClient::AccountApi.new
130
+ type = 'type_example' # String | 三方账号类型
131
+ openid = 'openid_example' # String | 三方账号唯一标识
132
+
133
+
134
+ begin
135
+ #解绑三方账号
136
+ result = api_instance.account_delete_openid(type, openid)
137
+ p result
138
+ rescue IndexeaClient::ApiError => e
139
+ puts "Exception when calling AccountApi->account_delete_openid: #{e}"
140
+ end
141
+ ```
142
+
143
+ ### Parameters
144
+
145
+ Name | Type | Description | Notes
146
+ ------------- | ------------- | ------------- | -------------
147
+ **type** | **String**| 三方账号类型 |
148
+ **openid** | **String**| 三方账号唯一标识 |
149
+
150
+ ### Return type
151
+
152
+ **BOOLEAN**
153
+
154
+ ### Authorization
155
+
156
+ [TokenAuth](../README.md#TokenAuth)
157
+
158
+ ### HTTP request headers
159
+
160
+ - **Content-Type**: Not defined
161
+ - **Accept**: application/json
162
+
163
+
164
+
165
+ # **account_openid**
166
+ > Array<OpenidBean> account_openid
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::AccountApi.new
179
+
180
+ begin
181
+ #获取绑定的所有三方账号
182
+ result = api_instance.account_openid
183
+ p result
184
+ rescue IndexeaClient::ApiError => e
185
+ puts "Exception when calling AccountApi->account_openid: #{e}"
186
+ end
187
+ ```
188
+
189
+ ### Parameters
190
+ This endpoint does not need any parameter.
191
+
192
+ ### Return type
193
+
194
+ [**Array<OpenidBean>**](OpenidBean.md)
195
+
196
+ ### Authorization
197
+
198
+ [TokenAuth](../README.md#TokenAuth)
199
+
200
+ ### HTTP request headers
201
+
202
+ - **Content-Type**: Not defined
203
+ - **Accept**: application/json
204
+
205
+
206
+
207
+ # **account_passwd**
208
+ > BOOLEAN account_passwd(passwordnew_password)
209
+
210
+ 修改账号密码
211
+
212
+ ### Example
213
+ ```ruby
214
+ # load the gem
215
+ require 'indexea_client'
216
+ # setup authorization
217
+ IndexeaClient.configure do |config|
218
+ end
219
+
220
+ api_instance = IndexeaClient::AccountApi.new
221
+ password = 'password_example' # String |
222
+ new_password = 'new_password_example' # String |
223
+
224
+
225
+ begin
226
+ #修改账号密码
227
+ result = api_instance.account_passwd(passwordnew_password)
228
+ p result
229
+ rescue IndexeaClient::ApiError => e
230
+ puts "Exception when calling AccountApi->account_passwd: #{e}"
231
+ end
232
+ ```
233
+
234
+ ### Parameters
235
+
236
+ Name | Type | Description | Notes
237
+ ------------- | ------------- | ------------- | -------------
238
+ **password** | [**String**](.md)| |
239
+ **new_password** | [**String**](.md)| |
240
+
241
+ ### Return type
242
+
243
+ **BOOLEAN**
244
+
245
+ ### Authorization
246
+
247
+ [TokenAuth](../README.md#TokenAuth)
248
+
249
+ ### HTTP request headers
250
+
251
+ - **Content-Type**: application/x-www-form-urlencoded
252
+ - **Accept**: application/json
253
+
254
+
255
+
256
+ # **account_portrait**
257
+ > AccountBean account_portrait(portrait)
258
+
259
+ 修改账号头像
260
+
261
+ ### Example
262
+ ```ruby
263
+ # load the gem
264
+ require 'indexea_client'
265
+ # setup authorization
266
+ IndexeaClient.configure do |config|
267
+ end
268
+
269
+ api_instance = IndexeaClient::AccountApi.new
270
+ portrait = 'portrait_example' # String |
271
+
272
+
273
+ begin
274
+ #修改账号头像
275
+ result = api_instance.account_portrait(portrait)
276
+ p result
277
+ rescue IndexeaClient::ApiError => e
278
+ puts "Exception when calling AccountApi->account_portrait: #{e}"
279
+ end
280
+ ```
281
+
282
+ ### Parameters
283
+
284
+ Name | Type | Description | Notes
285
+ ------------- | ------------- | ------------- | -------------
286
+ **portrait** | **String**| |
287
+
288
+ ### Return type
289
+
290
+ [**AccountBean**](AccountBean.md)
291
+
292
+ ### Authorization
293
+
294
+ [TokenAuth](../README.md#TokenAuth)
295
+
296
+ ### HTTP request headers
297
+
298
+ - **Content-Type**: multipart/form-data
299
+ - **Accept**: application/json
300
+
301
+
302
+
303
+ # **account_profile**
304
+ > AccountBean account_profile(opts)
305
+
306
+ 获取登录账号信息
307
+
308
+ ### Example
309
+ ```ruby
310
+ # load the gem
311
+ require 'indexea_client'
312
+ # setup authorization
313
+ IndexeaClient.configure do |config|
314
+ end
315
+
316
+ api_instance = IndexeaClient::AccountApi.new
317
+ opts = {
318
+ account: 'account_example' # String | 获取指定账号信息,如果不指定,则返回当前登录账号
319
+ }
320
+
321
+ begin
322
+ #获取登录账号信息
323
+ result = api_instance.account_profile(opts)
324
+ p result
325
+ rescue IndexeaClient::ApiError => e
326
+ puts "Exception when calling AccountApi->account_profile: #{e}"
327
+ end
328
+ ```
329
+
330
+ ### Parameters
331
+
332
+ Name | Type | Description | Notes
333
+ ------------- | ------------- | ------------- | -------------
334
+ **account** | **String**| 获取指定账号信息,如果不指定,则返回当前登录账号 | [optional]
335
+
336
+ ### Return type
337
+
338
+ [**AccountBean**](AccountBean.md)
339
+
340
+ ### Authorization
341
+
342
+ [TokenAuth](../README.md#TokenAuth)
343
+
344
+ ### HTTP request headers
345
+
346
+ - **Content-Type**: Not defined
347
+ - **Accept**: application/json
348
+
349
+
350
+
351
+ # **account_reset_pwd**
352
+ > BOOLEAN account_reset_pwd(opts)
353
+
354
+ 重置账号密码
355
+
356
+ ### Example
357
+ ```ruby
358
+ # load the gem
359
+ require 'indexea_client'
360
+
361
+ api_instance = IndexeaClient::AccountApi.new
362
+ opts = {
363
+ account: 'account_example' # String |
364
+ verify_code: 'verify_code_example' # String |
365
+ pwd: 'pwd_example' # String |
366
+ }
367
+
368
+ begin
369
+ #重置账号密码
370
+ result = api_instance.account_reset_pwd(opts)
371
+ p result
372
+ rescue IndexeaClient::ApiError => e
373
+ puts "Exception when calling AccountApi->account_reset_pwd: #{e}"
374
+ end
375
+ ```
376
+
377
+ ### Parameters
378
+
379
+ Name | Type | Description | Notes
380
+ ------------- | ------------- | ------------- | -------------
381
+ **account** | **String**| | [optional]
382
+ **verify_code** | **String**| | [optional]
383
+ **pwd** | [**String**](.md)| | [optional]
384
+
385
+ ### Return type
386
+
387
+ **BOOLEAN**
388
+
389
+ ### Authorization
390
+
391
+ No authorization required
392
+
393
+ ### HTTP request headers
394
+
395
+ - **Content-Type**: application/x-www-form-urlencoded
396
+ - **Accept**: application/json
397
+
398
+
399
+
400
+ # **account_send_verify_code**
401
+ > BOOLEAN account_send_verify_code(account, purpose)
402
+
403
+ 发送账号验证码
404
+
405
+ ### Example
406
+ ```ruby
407
+ # load the gem
408
+ require 'indexea_client'
409
+
410
+ api_instance = IndexeaClient::AccountApi.new
411
+ account = 'account_example' # String | 账号
412
+ purpose = 'purpose_example' # String | 验证码的用途
413
+
414
+
415
+ begin
416
+ #发送账号验证码
417
+ result = api_instance.account_send_verify_code(account, purpose)
418
+ p result
419
+ rescue IndexeaClient::ApiError => e
420
+ puts "Exception when calling AccountApi->account_send_verify_code: #{e}"
421
+ end
422
+ ```
423
+
424
+ ### Parameters
425
+
426
+ Name | Type | Description | Notes
427
+ ------------- | ------------- | ------------- | -------------
428
+ **account** | **String**| 账号 |
429
+ **purpose** | **String**| 验证码的用途 |
430
+
431
+ ### Return type
432
+
433
+ **BOOLEAN**
434
+
435
+ ### Authorization
436
+
437
+ No authorization required
438
+
439
+ ### HTTP request headers
440
+
441
+ - **Content-Type**: Not defined
442
+ - **Accept**: application/json
443
+
444
+
445
+
446
+ # **account_signin**
447
+ > AccountBean account_signin(accountpwdkeep_login)
448
+
449
+ 登录系统
450
+
451
+ ### Example
452
+ ```ruby
453
+ # load the gem
454
+ require 'indexea_client'
455
+
456
+ api_instance = IndexeaClient::AccountApi.new
457
+ account = 'account_example' # String |
458
+ pwd = 'pwd_example' # String |
459
+ keep_login = true # BOOLEAN |
460
+
461
+
462
+ begin
463
+ #登录系统
464
+ result = api_instance.account_signin(accountpwdkeep_login)
465
+ p result
466
+ rescue IndexeaClient::ApiError => e
467
+ puts "Exception when calling AccountApi->account_signin: #{e}"
468
+ end
469
+ ```
470
+
471
+ ### Parameters
472
+
473
+ Name | Type | Description | Notes
474
+ ------------- | ------------- | ------------- | -------------
475
+ **account** | **String**| |
476
+ **pwd** | [**String**](.md)| |
477
+ **keep_login** | **BOOLEAN**| |
478
+
479
+ ### Return type
480
+
481
+ [**AccountBean**](AccountBean.md)
482
+
483
+ ### Authorization
484
+
485
+ No authorization required
486
+
487
+ ### HTTP request headers
488
+
489
+ - **Content-Type**: application/x-www-form-urlencoded
490
+ - **Accept**: application/json
491
+
492
+
493
+
494
+ # **account_signout**
495
+ > account_signout
496
+
497
+ 退出登录状态
498
+
499
+ ### Example
500
+ ```ruby
501
+ # load the gem
502
+ require 'indexea_client'
503
+ # setup authorization
504
+ IndexeaClient.configure do |config|
505
+ end
506
+
507
+ api_instance = IndexeaClient::AccountApi.new
508
+
509
+ begin
510
+ #退出登录状态
511
+ api_instance.account_signout
512
+ rescue IndexeaClient::ApiError => e
513
+ puts "Exception when calling AccountApi->account_signout: #{e}"
514
+ end
515
+ ```
516
+
517
+ ### Parameters
518
+ This endpoint does not need any parameter.
519
+
520
+ ### Return type
521
+
522
+ nil (empty response body)
523
+
524
+ ### Authorization
525
+
526
+ [TokenAuth](../README.md#TokenAuth)
527
+
528
+ ### HTTP request headers
529
+
530
+ - **Content-Type**: Not defined
531
+ - **Accept**: Not defined
532
+
533
+
534
+
535
+ # **account_signup**
536
+ > AccountBean account_signup(opts)
537
+
538
+ 注册新账号
539
+
540
+ ### Example
541
+ ```ruby
542
+ # load the gem
543
+ require 'indexea_client'
544
+
545
+ api_instance = IndexeaClient::AccountApi.new
546
+ opts = {
547
+ account: 'account_example' # String |
548
+ pwd: 'pwd_example' # String |
549
+ name: 'name_example' # String |
550
+ activate_code: 'activate_code_example' # String |
551
+ }
552
+
553
+ begin
554
+ #注册新账号
555
+ result = api_instance.account_signup(opts)
556
+ p result
557
+ rescue IndexeaClient::ApiError => e
558
+ puts "Exception when calling AccountApi->account_signup: #{e}"
559
+ end
560
+ ```
561
+
562
+ ### Parameters
563
+
564
+ Name | Type | Description | Notes
565
+ ------------- | ------------- | ------------- | -------------
566
+ **account** | **String**| | [optional]
567
+ **pwd** | [**String**](.md)| | [optional]
568
+ **name** | **String**| | [optional]
569
+ **activate_code** | **String**| | [optional]
570
+
571
+ ### Return type
572
+
573
+ [**AccountBean**](AccountBean.md)
574
+
575
+ ### Authorization
576
+
577
+ No authorization required
578
+
579
+ ### HTTP request headers
580
+
581
+ - **Content-Type**: application/x-www-form-urlencoded
582
+ - **Accept**: application/json
583
+
584
+
585
+
586
+ # **account_update**
587
+ > AccountBean account_update(body)
588
+
589
+ 修改账号资料
590
+
591
+ ### Example
592
+ ```ruby
593
+ # load the gem
594
+ require 'indexea_client'
595
+ # setup authorization
596
+ IndexeaClient.configure do |config|
597
+ end
598
+
599
+ api_instance = IndexeaClient::AccountApi.new
600
+ body = IndexeaClient::AccountBean.new # AccountBean |
601
+
602
+
603
+ begin
604
+ #修改账号资料
605
+ result = api_instance.account_update(body)
606
+ p result
607
+ rescue IndexeaClient::ApiError => e
608
+ puts "Exception when calling AccountApi->account_update: #{e}"
609
+ end
610
+ ```
611
+
612
+ ### Parameters
613
+
614
+ Name | Type | Description | Notes
615
+ ------------- | ------------- | ------------- | -------------
616
+ **body** | [**AccountBean**](AccountBean.md)| |
617
+
618
+ ### Return type
619
+
620
+ [**AccountBean**](AccountBean.md)
621
+
622
+ ### Authorization
623
+
624
+ [TokenAuth](../README.md#TokenAuth)
625
+
626
+ ### HTTP request headers
627
+
628
+ - **Content-Type**: application/json
629
+ - **Accept**: application/json
630
+
631
+
632
+
633
+ # **account_update_settings**
634
+ > BOOLEAN account_update_settings(keytypevaluevcode)
635
+
636
+ 修改账号设置
637
+
638
+ ### Example
639
+ ```ruby
640
+ # load the gem
641
+ require 'indexea_client'
642
+ # setup authorization
643
+ IndexeaClient.configure do |config|
644
+ end
645
+
646
+ api_instance = IndexeaClient::AccountApi.new
647
+ key = 'key_example' # String |
648
+ type = 'type_example' # String |
649
+ value = 'value_example' # String |
650
+ vcode = 'vcode_example' # String |
651
+
652
+
653
+ begin
654
+ #修改账号设置
655
+ result = api_instance.account_update_settings(keytypevaluevcode)
656
+ p result
657
+ rescue IndexeaClient::ApiError => e
658
+ puts "Exception when calling AccountApi->account_update_settings: #{e}"
659
+ end
660
+ ```
661
+
662
+ ### Parameters
663
+
664
+ Name | Type | Description | Notes
665
+ ------------- | ------------- | ------------- | -------------
666
+ **key** | **String**| |
667
+ **type** | **String**| |
668
+ **value** | **String**| |
669
+ **vcode** | **String**| |
670
+
671
+ ### Return type
672
+
673
+ **BOOLEAN**
674
+
675
+ ### Authorization
676
+
677
+ [TokenAuth](../README.md#TokenAuth)
678
+
679
+ ### HTTP request headers
680
+
681
+ - **Content-Type**: application/x-www-form-urlencoded
682
+ - **Accept**: application/json
683
+
684
+
685
+
@@ -0,0 +1,27 @@
1
+ # IndexeaClient::AccountBean
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **id** | **Integer** | | [optional]
7
+ **scopes** | **String** | 如果是第三方应用,此值为三方应用的权限 | [optional]
8
+ **token** | **String** | 登录令牌(执行登录方法时该值为可用的 token) | [optional]
9
+ **token_at** | **DateTime** | token 的有效时间 | [optional]
10
+ **name** | **String** | | [optional]
11
+ **account** | **String** | | [optional]
12
+ **avatar** | **String** | | [optional]
13
+ **company** | **String** | | [optional]
14
+ **nation** | **String** | | [optional]
15
+ **state** | **String** | | [optional]
16
+ **city** | **String** | | [optional]
17
+ **address** | **String** | | [optional]
18
+ **login_ip** | **String** | | [optional]
19
+ **login_at** | **DateTime** | | [optional]
20
+ **created_at** | **DateTime** | | [optional]
21
+ **origin** | **String** | 账号来源 | [optional]
22
+ **subscription** | **Integer** | | [optional]
23
+ **settings** | **Object** | | [optional]
24
+ **roles** | **Array<String>** | | [optional]
25
+ **status** | **Integer** | | [optional]
26
+ **apps** | [**Array<AppBean>**](AppBean.md) | 应用列表 | [optional]
27
+
@@ -0,0 +1,8 @@
1
+ # IndexeaClient::AccountPasswdBody
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **password** | **String** | 旧密码 |
7
+ **new_password** | **String** | 新密码 |
8
+