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
@@ -0,0 +1,8 @@
1
+ # IndexeaClient::AppsAppBody
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **name** | **String** | | [optional]
7
+ **intro** | **String** | | [optional]
8
+
data/docs/AppsBody.md ADDED
@@ -0,0 +1,8 @@
1
+ # IndexeaClient::AppsBody
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **name** | **String** | |
7
+ **intro** | **String** | | [optional]
8
+
@@ -0,0 +1,9 @@
1
+ # IndexeaClient::AutoCompleteItem
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **value** | **String** | | [optional]
7
+ **url** | **String** | | [optional]
8
+ **props** | **Object** | | [optional]
9
+
@@ -0,0 +1,12 @@
1
+ # IndexeaClient::BlacklistBean
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **app** | **Integer** | | [optional]
7
+ **block_type** | **Integer** | | [optional]
8
+ **badwords** | **Array<String>** | | [optional]
9
+ **black_ips** | **Array<String>** | | [optional]
10
+ **white_ips** | **Array<String>** | | [optional]
11
+ **updated_at** | **DateTime** | | [optional]
12
+
data/docs/Bulletin.md ADDED
@@ -0,0 +1,15 @@
1
+ # IndexeaClient::Bulletin
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **id** | **Integer** | | [optional]
7
+ **level** | **String** | | [optional]
8
+ **scope** | **Integer** | | [optional]
9
+ **title** | **String** | | [optional]
10
+ **content** | **String** | | [optional]
11
+ **created_at** | **DateTime** | | [optional]
12
+ **start_at** | **DateTime** | | [optional]
13
+ **expired_at** | **DateTime** | | [optional]
14
+ **closable** | **BOOLEAN** | | [optional]
15
+
@@ -0,0 +1,24 @@
1
+ # IndexeaClient::CompanyBean
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **name** | **String** | 公司名称 | [optional]
7
+ **url** | **String** | 公司网址 | [optional]
8
+ **nation** | **String** | 国家 | [optional]
9
+ **province** | **String** | 省/州/地区 | [optional]
10
+ **city** | **String** | 城市 | [optional]
11
+ **taxpayer** | **String** | 纳税人识别号 | [optional]
12
+ **bank** | **String** | 开户行 | [optional]
13
+ **account** | **String** | 银行账号 | [optional]
14
+ **address** | **String** | 公司注册地址 | [optional]
15
+ **tel** | **String** | 公司电话 | [optional]
16
+ **license** | **String** | 营业执照图片地址 | [optional]
17
+ **certificate** | **String** | 一般纳税人证明扫描件图片地址 | [optional]
18
+ **post_addr** | **String** | 快递地址 | [optional]
19
+ **post_code** | **String** | 邮编 | [optional]
20
+ **post_name** | **String** | 收件人姓名 | [optional]
21
+ **post_tel** | **String** | 收件人电话 | [optional]
22
+ **created_at** | **DateTime** | 首次填写时间 | [optional]
23
+ **updated_at** | **DateTime** | 最后更新时间 | [optional]
24
+
@@ -0,0 +1,11 @@
1
+ # IndexeaClient::ContactForm
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **company** | **String** | |
7
+ **name** | **String** | |
8
+ **tel** | **String** | |
9
+ **email** | **String** | | [optional]
10
+ **memo** | **String** | | [optional]
11
+
@@ -0,0 +1,14 @@
1
+ # IndexeaClient::CrawlerLog
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **id** | **Integer** | | [optional]
7
+ **index** | **Integer** | | [optional]
8
+ **home_url** | **String** | | [optional]
9
+ **begin_at** | **DateTime** | | [optional]
10
+ **end_at** | **DateTime** | | [optional]
11
+ **used_seconds** | **Integer** | | [optional]
12
+ **success_count** | **Integer** | | [optional]
13
+ **failed_count** | **Integer** | | [optional]
14
+
@@ -0,0 +1,8 @@
1
+ # IndexeaClient::CrawlerLogs
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **total** | **Integer** | | [optional]
7
+ **logs** | [**Array<CrawlerLog>**](CrawlerLog.md) | | [optional]
8
+
@@ -0,0 +1,16 @@
1
+ # IndexeaClient::CrawlerTask
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **index** | **Integer** | | [optional]
7
+ **template** | **String** | | [optional]
8
+ **period** | **Integer** | | [optional]
9
+ **settings** | **Object** | | [optional]
10
+ **created_at** | **DateTime** | | [optional]
11
+ **run_times** | **Integer** | | [optional]
12
+ **last_updated_at** | **DateTime** | | [optional]
13
+ **last_error** | **String** | | [optional]
14
+ **error_count** | **Integer** | | [optional]
15
+ **status** | **Integer** | | [optional]
16
+
data/docs/FieldsApi.md ADDED
@@ -0,0 +1,215 @@
1
+ # IndexeaClient::FieldsApi
2
+
3
+ All URIs are relative to *https://api.indexea.com/v1*
4
+
5
+ Method | HTTP request | Description
6
+ ------------- | ------------- | -------------
7
+ [**index_fields**](FieldsApi.md#index_fields) | **GET** /indices/{app}/{index}/fields | 获取索引字段映射详情
8
+ [**index_update_fields**](FieldsApi.md#index_update_fields) | **POST** /indices/{app}/{index}/fields | 更新索引的字段映射
9
+ [**index_update_html_strip_fields**](FieldsApi.md#index_update_html_strip_fields) | **PATCH** /indices/{app}/{index}/fields | 更新索引的HTML过滤字段列表
10
+ [**index_values_of_field**](FieldsApi.md#index_values_of_field) | **GET** /indices/{app}/{index}/fields/{field} | 获取索引字段的所有值列表
11
+
12
+ # **index_fields**
13
+ > Object index_fields(app, index)
14
+
15
+ 获取索引字段映射详情
16
+
17
+ ### Example
18
+ ```ruby
19
+ # load the gem
20
+ require 'indexea_client'
21
+ # setup authorization
22
+ IndexeaClient.configure do |config|
23
+ end
24
+
25
+ api_instance = IndexeaClient::FieldsApi.new
26
+ app = 'app_example' # String | 应用标识
27
+ index = 56 # Integer | 索引编号
28
+
29
+
30
+ begin
31
+ #获取索引字段映射详情
32
+ result = api_instance.index_fields(app, index)
33
+ p result
34
+ rescue IndexeaClient::ApiError => e
35
+ puts "Exception when calling FieldsApi->index_fields: #{e}"
36
+ end
37
+ ```
38
+
39
+ ### Parameters
40
+
41
+ Name | Type | Description | Notes
42
+ ------------- | ------------- | ------------- | -------------
43
+ **app** | **String**| 应用标识 |
44
+ **index** | **Integer**| 索引编号 |
45
+
46
+ ### Return type
47
+
48
+ **Object**
49
+
50
+ ### Authorization
51
+
52
+ [TokenAuth](../README.md#TokenAuth)
53
+
54
+ ### HTTP request headers
55
+
56
+ - **Content-Type**: Not defined
57
+ - **Accept**: application/json
58
+
59
+
60
+
61
+ # **index_update_fields**
62
+ > Object index_update_fields(bodyappindex)
63
+
64
+ 更新索引的字段映射
65
+
66
+ ### Example
67
+ ```ruby
68
+ # load the gem
69
+ require 'indexea_client'
70
+ # setup authorization
71
+ IndexeaClient.configure do |config|
72
+ end
73
+
74
+ api_instance = IndexeaClient::FieldsApi.new
75
+ body = nil # Object |
76
+ app = 'app_example' # String | 应用标识
77
+ index = 56 # Integer | 索引编号
78
+
79
+
80
+ begin
81
+ #更新索引的字段映射
82
+ result = api_instance.index_update_fields(bodyappindex)
83
+ p result
84
+ rescue IndexeaClient::ApiError => e
85
+ puts "Exception when calling FieldsApi->index_update_fields: #{e}"
86
+ end
87
+ ```
88
+
89
+ ### Parameters
90
+
91
+ Name | Type | Description | Notes
92
+ ------------- | ------------- | ------------- | -------------
93
+ **body** | [**Object**](Object.md)| |
94
+ **app** | **String**| 应用标识 |
95
+ **index** | **Integer**| 索引编号 |
96
+
97
+ ### Return type
98
+
99
+ **Object**
100
+
101
+ ### Authorization
102
+
103
+ [TokenAuth](../README.md#TokenAuth)
104
+
105
+ ### HTTP request headers
106
+
107
+ - **Content-Type**: application/json
108
+ - **Accept**: application/json
109
+
110
+
111
+
112
+ # **index_update_html_strip_fields**
113
+ > Object index_update_html_strip_fields(bodyappindex)
114
+
115
+ 更新索引的HTML过滤字段列表
116
+
117
+ ### Example
118
+ ```ruby
119
+ # load the gem
120
+ require 'indexea_client'
121
+ # setup authorization
122
+ IndexeaClient.configure do |config|
123
+ end
124
+
125
+ api_instance = IndexeaClient::FieldsApi.new
126
+ body = nil # Object |
127
+ app = 'app_example' # String | 应用标识
128
+ index = 56 # Integer | 索引编号
129
+
130
+
131
+ begin
132
+ #更新索引的HTML过滤字段列表
133
+ result = api_instance.index_update_html_strip_fields(bodyappindex)
134
+ p result
135
+ rescue IndexeaClient::ApiError => e
136
+ puts "Exception when calling FieldsApi->index_update_html_strip_fields: #{e}"
137
+ end
138
+ ```
139
+
140
+ ### Parameters
141
+
142
+ Name | Type | Description | Notes
143
+ ------------- | ------------- | ------------- | -------------
144
+ **body** | [**Object**](Object.md)| |
145
+ **app** | **String**| 应用标识 |
146
+ **index** | **Integer**| 索引编号 |
147
+
148
+ ### Return type
149
+
150
+ **Object**
151
+
152
+ ### Authorization
153
+
154
+ [TokenAuth](../README.md#TokenAuth)
155
+
156
+ ### HTTP request headers
157
+
158
+ - **Content-Type**: application/json
159
+ - **Accept**: application/json
160
+
161
+
162
+
163
+ # **index_values_of_field**
164
+ > Array<ValueOfField> index_values_of_field(app, index, field, size)
165
+
166
+ 获取索引字段的所有值列表
167
+
168
+ ### Example
169
+ ```ruby
170
+ # load the gem
171
+ require 'indexea_client'
172
+ # setup authorization
173
+ IndexeaClient.configure do |config|
174
+ end
175
+
176
+ api_instance = IndexeaClient::FieldsApi.new
177
+ app = 'app_example' # String | 应用标识
178
+ index = 56 # Integer | 索引编号
179
+ field = 'field_example' # String | 字段名称
180
+ size = 20 # Integer | values count
181
+
182
+
183
+ begin
184
+ #获取索引字段的所有值列表
185
+ result = api_instance.index_values_of_field(app, index, field, size)
186
+ p result
187
+ rescue IndexeaClient::ApiError => e
188
+ puts "Exception when calling FieldsApi->index_values_of_field: #{e}"
189
+ end
190
+ ```
191
+
192
+ ### Parameters
193
+
194
+ Name | Type | Description | Notes
195
+ ------------- | ------------- | ------------- | -------------
196
+ **app** | **String**| 应用标识 |
197
+ **index** | **Integer**| 索引编号 |
198
+ **field** | **String**| 字段名称 |
199
+ **size** | **Integer**| values count | [default to 20]
200
+
201
+ ### Return type
202
+
203
+ [**Array<ValueOfField>**](ValueOfField.md)
204
+
205
+ ### Authorization
206
+
207
+ [TokenAuth](../README.md#TokenAuth)
208
+
209
+ ### HTTP request headers
210
+
211
+ - **Content-Type**: Not defined
212
+ - **Accept**: application/json
213
+
214
+
215
+
data/docs/GlobalApi.md ADDED
@@ -0,0 +1,258 @@
1
+ # IndexeaClient::GlobalApi
2
+
3
+ All URIs are relative to *https://api.indexea.com/v1*
4
+
5
+ Method | HTTP request | Description
6
+ ------------- | ------------- | -------------
7
+ [**json**](GlobalApi.md#json) | **GET** /json | 接口定义(JSON)
8
+ [**options_get**](GlobalApi.md#options_get) | **GET** /options | 系统全局配置接口
9
+ [**status_database**](GlobalApi.md#status_database) | **GET** /status/database | 数据库服务状态测试
10
+ [**status_engine**](GlobalApi.md#status_engine) | **GET** /status/engine | 搜索引擎状态测试
11
+ [**welcome**](GlobalApi.md#welcome) | **GET** / | 接口欢迎信息
12
+ [**yaml**](GlobalApi.md#yaml) | **GET** /yaml | 接口定义(YAML)
13
+
14
+ # **json**
15
+ > Object json
16
+
17
+ 接口定义(JSON)
18
+
19
+ 获取 OpenAPI 接口定义(JSON)
20
+
21
+ ### Example
22
+ ```ruby
23
+ # load the gem
24
+ require 'indexea_client'
25
+
26
+ api_instance = IndexeaClient::GlobalApi.new
27
+
28
+ begin
29
+ #接口定义(JSON)
30
+ result = api_instance.json
31
+ p result
32
+ rescue IndexeaClient::ApiError => e
33
+ puts "Exception when calling GlobalApi->json: #{e}"
34
+ end
35
+ ```
36
+
37
+ ### Parameters
38
+ This endpoint does not need any parameter.
39
+
40
+ ### Return type
41
+
42
+ **Object**
43
+
44
+ ### Authorization
45
+
46
+ No authorization required
47
+
48
+ ### HTTP request headers
49
+
50
+ - **Content-Type**: Not defined
51
+ - **Accept**: application/json
52
+
53
+
54
+
55
+ # **options_get**
56
+ > Object options_get(name, keys)
57
+
58
+ 系统全局配置接口
59
+
60
+ ### Example
61
+ ```ruby
62
+ # load the gem
63
+ require 'indexea_client'
64
+
65
+ api_instance = IndexeaClient::GlobalApi.new
66
+ name = 'name_example' # String |
67
+ keys = 'keys_example' # String | 配置项名,多个配置项请使用逗号隔开
68
+
69
+
70
+ begin
71
+ #系统全局配置接口
72
+ result = api_instance.options_get(name, keys)
73
+ p result
74
+ rescue IndexeaClient::ApiError => e
75
+ puts "Exception when calling GlobalApi->options_get: #{e}"
76
+ end
77
+ ```
78
+
79
+ ### Parameters
80
+
81
+ Name | Type | Description | Notes
82
+ ------------- | ------------- | ------------- | -------------
83
+ **name** | **String**| |
84
+ **keys** | **String**| 配置项名,多个配置项请使用逗号隔开 |
85
+
86
+ ### Return type
87
+
88
+ **Object**
89
+
90
+ ### Authorization
91
+
92
+ No authorization required
93
+
94
+ ### HTTP request headers
95
+
96
+ - **Content-Type**: Not defined
97
+ - **Accept**: application/json
98
+
99
+
100
+
101
+ # **status_database**
102
+ > String status_database
103
+
104
+ 数据库服务状态测试
105
+
106
+ ### Example
107
+ ```ruby
108
+ # load the gem
109
+ require 'indexea_client'
110
+
111
+ api_instance = IndexeaClient::GlobalApi.new
112
+
113
+ begin
114
+ #数据库服务状态测试
115
+ result = api_instance.status_database
116
+ p result
117
+ rescue IndexeaClient::ApiError => e
118
+ puts "Exception when calling GlobalApi->status_database: #{e}"
119
+ end
120
+ ```
121
+
122
+ ### Parameters
123
+ This endpoint does not need any parameter.
124
+
125
+ ### Return type
126
+
127
+ **String**
128
+
129
+ ### Authorization
130
+
131
+ No authorization required
132
+
133
+ ### HTTP request headers
134
+
135
+ - **Content-Type**: Not defined
136
+ - **Accept**: text/plain
137
+
138
+
139
+
140
+ # **status_engine**
141
+ > String status_engine
142
+
143
+ 搜索引擎状态测试
144
+
145
+ ### Example
146
+ ```ruby
147
+ # load the gem
148
+ require 'indexea_client'
149
+
150
+ api_instance = IndexeaClient::GlobalApi.new
151
+
152
+ begin
153
+ #搜索引擎状态测试
154
+ result = api_instance.status_engine
155
+ p result
156
+ rescue IndexeaClient::ApiError => e
157
+ puts "Exception when calling GlobalApi->status_engine: #{e}"
158
+ end
159
+ ```
160
+
161
+ ### Parameters
162
+ This endpoint does not need any parameter.
163
+
164
+ ### Return type
165
+
166
+ **String**
167
+
168
+ ### Authorization
169
+
170
+ No authorization required
171
+
172
+ ### HTTP request headers
173
+
174
+ - **Content-Type**: Not defined
175
+ - **Accept**: text/plain
176
+
177
+
178
+
179
+ # **welcome**
180
+ > String welcome
181
+
182
+ 接口欢迎信息
183
+
184
+ ### Example
185
+ ```ruby
186
+ # load the gem
187
+ require 'indexea_client'
188
+
189
+ api_instance = IndexeaClient::GlobalApi.new
190
+
191
+ begin
192
+ #接口欢迎信息
193
+ result = api_instance.welcome
194
+ p result
195
+ rescue IndexeaClient::ApiError => e
196
+ puts "Exception when calling GlobalApi->welcome: #{e}"
197
+ end
198
+ ```
199
+
200
+ ### Parameters
201
+ This endpoint does not need any parameter.
202
+
203
+ ### Return type
204
+
205
+ **String**
206
+
207
+ ### Authorization
208
+
209
+ No authorization required
210
+
211
+ ### HTTP request headers
212
+
213
+ - **Content-Type**: Not defined
214
+ - **Accept**: text/plain, text/html, application/json, application/x-yaml
215
+
216
+
217
+
218
+ # **yaml**
219
+ > String yaml
220
+
221
+ 接口定义(YAML)
222
+
223
+ 获取 OpenAPI 接口定义(YAML)
224
+
225
+ ### Example
226
+ ```ruby
227
+ # load the gem
228
+ require 'indexea_client'
229
+
230
+ api_instance = IndexeaClient::GlobalApi.new
231
+
232
+ begin
233
+ #接口定义(YAML)
234
+ result = api_instance.yaml
235
+ p result
236
+ rescue IndexeaClient::ApiError => e
237
+ puts "Exception when calling GlobalApi->yaml: #{e}"
238
+ end
239
+ ```
240
+
241
+ ### Parameters
242
+ This endpoint does not need any parameter.
243
+
244
+ ### Return type
245
+
246
+ **String**
247
+
248
+ ### Authorization
249
+
250
+ No authorization required
251
+
252
+ ### HTTP request headers
253
+
254
+ - **Content-Type**: Not defined
255
+ - **Accept**: application/x-yaml
256
+
257
+
258
+
@@ -0,0 +1,8 @@
1
+ # IndexeaClient::GlobalOptionForm
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **name** | **String** | 配置项名称 | [optional]
7
+ **value** | **Object** | 配置值 | [optional]
8
+
data/docs/IndexBean.md ADDED
@@ -0,0 +1,26 @@
1
+ # IndexeaClient::IndexBean
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **id** | **Integer** | | [optional]
7
+ **account** | **Integer** | | [optional]
8
+ **app** | **Integer** | | [optional]
9
+ **name** | **String** | | [optional]
10
+ **system** | **BOOLEAN** | 是否系统索引(系统索引不允许用户删除) | [optional]
11
+ **intro** | **String** | | [optional]
12
+ **_alias** | **Array<String>** | | [optional]
13
+ **type** | **String** | | [optional]
14
+ **filters** | **Array<Object>** | 索引关联的临时过滤器 | [optional]
15
+ **aggs** | **Object** | 索引关联的临时聚合器 | [optional]
16
+ **sorts** | **Array<Object>** | 索引关联的临时排序 | [optional]
17
+ **shards** | **Integer** | 该索引的分片数 | [optional]
18
+ **replicas** | **Integer** | 该索引的副本数 | [optional]
19
+ **analyzer** | **String** | | [optional]
20
+ **search_analyzer** | **String** | | [optional]
21
+ **stat** | [**IndexStatBean**](IndexStatBean.md) | | [optional]
22
+ **options** | **Object** | | [optional]
23
+ **created_at** | **DateTime** | | [optional]
24
+ **updated_at** | **DateTime** | | [optional]
25
+ **status** | **Integer** | | [optional]
26
+
@@ -0,0 +1,8 @@
1
+ # IndexeaClient::IndexFieldBean
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **index** | [**IndexBean**](IndexBean.md) | | [optional]
7
+ **fields** | **Object** | 字段列表信息 | [optional]
8
+
data/docs/IndexForm.md ADDED
@@ -0,0 +1,15 @@
1
+ # IndexeaClient::IndexForm
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **name** | **String** | | [optional]
7
+ **intro** | **String** | | [optional]
8
+ **_alias** | **Array<String>** | | [optional]
9
+ **type** | **String** | | [optional]
10
+ **shards** | **Integer** | 该索引的分片数 | [optional]
11
+ **replicas** | **Integer** | 该索引的副本数 | [optional]
12
+ **analyzer** | **String** | | [optional]
13
+ **search_analyzer** | **String** | | [optional]
14
+ **status** | **Integer** | | [optional]
15
+
@@ -0,0 +1,12 @@
1
+ # IndexeaClient::IndexRebuildForm
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **shards** | **Integer** | 该索引的分片数 | [optional]
7
+ **replicas** | **Integer** | 该索引的副本数 | [optional]
8
+ **analyzer** | **String** | | [optional]
9
+ **search_analyzer** | **String** | | [optional]
10
+ **fields** | **Object** | | [optional]
11
+ **vcode** | **String** | | [optional]
12
+
@@ -0,0 +1,10 @@
1
+ # IndexeaClient::IndexSettings
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **index** | **Integer** | | [optional]
7
+ **type** | **String** | | [optional]
8
+ **settings** | **Object** | | [optional]
9
+ **updated_at** | **DateTime** | | [optional]
10
+