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
data/docs/AppsApi.md
ADDED
@@ -0,0 +1,1843 @@
|
|
1
|
+
# IndexeaClient::AppsApi
|
2
|
+
|
3
|
+
All URIs are relative to *https://api.indexea.com/v1*
|
4
|
+
|
5
|
+
Method | HTTP request | Description
|
6
|
+
------------- | ------------- | -------------
|
7
|
+
[**app_add_mentor**](AppsApi.md#app_add_mentor) | **POST** /apps/{app}/mentors | 添加应用成员
|
8
|
+
[**app_blacklist**](AppsApi.md#app_blacklist) | **GET** /apps/{app}/blacklist | 获取黑名单信息
|
9
|
+
[**app_create**](AppsApi.md#app_create) | **POST** /apps | 创建应用
|
10
|
+
[**app_create_access_token**](AppsApi.md#app_create_access_token) | **POST** /apps/{app}/tokens | 创建 Access Token
|
11
|
+
[**app_create_oauth_app**](AppsApi.md#app_create_oauth_app) | **POST** /apps/{app}/oauth | 创建第三方应用
|
12
|
+
[**app_delete**](AppsApi.md#app_delete) | **DELETE** /apps/{app} | 删除应用
|
13
|
+
[**app_delete_access_token**](AppsApi.md#app_delete_access_token) | **DELETE** /apps/{app}/tokens | 删除 Access Token
|
14
|
+
[**app_delete_mentor**](AppsApi.md#app_delete_mentor) | **DELETE** /apps/{app}/mentors | 删除应用成员
|
15
|
+
[**app_delete_oauth_app**](AppsApi.md#app_delete_oauth_app) | **DELETE** /apps/{app}/oauth | 删除第三方应用
|
16
|
+
[**app_excel_of_logs**](AppsApi.md#app_excel_of_logs) | **GET** /apps/{app}/logs | 导出应用日志到 Excel
|
17
|
+
[**app_get**](AppsApi.md#app_get) | **GET** /apps/{app} | 获取应用详情
|
18
|
+
[**app_get_company**](AppsApi.md#app_get_company) | **POST** /apps/{app}/company | 获取应用填写的公司信息
|
19
|
+
[**app_get_company_pic**](AppsApi.md#app_get_company_pic) | **GET** /apps/{app}/company | 获取公司营业执照或者一般纳税人证明
|
20
|
+
[**app_list**](AppsApi.md#app_list) | **GET** /apps | 获取应用列表
|
21
|
+
[**app_list_mentors**](AppsApi.md#app_list_mentors) | **GET** /apps/{app}/mentors | 获取应用成员列表
|
22
|
+
[**app_list_oauth_apps**](AppsApi.md#app_list_oauth_apps) | **GET** /apps/{app}/oauth | 获取第三方应用列表
|
23
|
+
[**app_logs**](AppsApi.md#app_logs) | **POST** /apps/{app}/logs | 获取应用的日志列表
|
24
|
+
[**app_reset_access_token**](AppsApi.md#app_reset_access_token) | **PATCH** /apps/{app}/tokens | 重置 Access Token
|
25
|
+
[**app_reset_oauth_app_secret**](AppsApi.md#app_reset_oauth_app_secret) | **POST** /apps/{app}/oauth-reset-secret | 重新生成三方应用的密钥
|
26
|
+
[**app_save_blacklist**](AppsApi.md#app_save_blacklist) | **PUT** /apps/{app}/blacklist | 修改应用的黑名单信息
|
27
|
+
[**app_save_company**](AppsApi.md#app_save_company) | **PUT** /apps/{app}/company | 修改应用的公司信息
|
28
|
+
[**app_searchs_estimate**](AppsApi.md#app_searchs_estimate) | **GET** /apps/{app}/searchs-estimate | 获取搜索流量包使用配额信息
|
29
|
+
[**app_set_trigger**](AppsApi.md#app_set_trigger) | **PUT** /apps/{app}/trigger | 修改应用的触发器信息
|
30
|
+
[**app_tokens**](AppsApi.md#app_tokens) | **GET** /apps/{app}/tokens | 获取 Access Token 列表
|
31
|
+
[**app_transfer**](AppsApi.md#app_transfer) | **POST** /apps/{app}/transfer | 转让应用给他人
|
32
|
+
[**app_trigger**](AppsApi.md#app_trigger) | **GET** /apps/{app}/trigger | 获取应用触发器详情
|
33
|
+
[**app_trigger_logs**](AppsApi.md#app_trigger_logs) | **GET** /apps/{app}/trigger-logs | 获取应用触发日志列表
|
34
|
+
[**app_update**](AppsApi.md#app_update) | **PUT** /apps/{app} | 修改应用的基本信息
|
35
|
+
[**app_update_access_token**](AppsApi.md#app_update_access_token) | **PUT** /apps/{app}/tokens | 修改 Access Token
|
36
|
+
[**app_update_mentor**](AppsApi.md#app_update_mentor) | **PATCH** /apps/{app}/mentors | 修改成员备注和权限
|
37
|
+
[**app_update_mentor_options**](AppsApi.md#app_update_mentor_options) | **POST** /apps/{app}/mentors-options | 修改应用成员自身的设置(包括应用名备注,是否接收报告等)
|
38
|
+
[**app_update_mentor_report_options**](AppsApi.md#app_update_mentor_report_options) | **PATCH** /apps/{app}/mentors-options | 修改应用成员自身的通知设置
|
39
|
+
[**app_update_oauth_app**](AppsApi.md#app_update_oauth_app) | **PATCH** /apps/{app}/oauth | 修改第三方应用信息
|
40
|
+
[**app_update_oauth_app_logo**](AppsApi.md#app_update_oauth_app_logo) | **PUT** /apps/{app}/oauth | 修改三方应用图标
|
41
|
+
[**app_update_status**](AppsApi.md#app_update_status) | **PATCH** /apps/{app} | 修改应用的状态
|
42
|
+
|
43
|
+
# **app_add_mentor**
|
44
|
+
> MentorForm app_add_mentor(app, account, scopes, opts)
|
45
|
+
|
46
|
+
添加应用成员
|
47
|
+
|
48
|
+
### Example
|
49
|
+
```ruby
|
50
|
+
# load the gem
|
51
|
+
require 'indexea_client'
|
52
|
+
# setup authorization
|
53
|
+
IndexeaClient.configure do |config|
|
54
|
+
end
|
55
|
+
|
56
|
+
api_instance = IndexeaClient::AppsApi.new
|
57
|
+
app = 'app_example' # String | 应用标识
|
58
|
+
account = 'account_example' # String | 成员账号
|
59
|
+
scopes = 'scopes_example' # String | 权限
|
60
|
+
opts = {
|
61
|
+
name: 'name_example' # String | 备注名称
|
62
|
+
}
|
63
|
+
|
64
|
+
begin
|
65
|
+
#添加应用成员
|
66
|
+
result = api_instance.app_add_mentor(app, account, scopes, opts)
|
67
|
+
p result
|
68
|
+
rescue IndexeaClient::ApiError => e
|
69
|
+
puts "Exception when calling AppsApi->app_add_mentor: #{e}"
|
70
|
+
end
|
71
|
+
```
|
72
|
+
|
73
|
+
### Parameters
|
74
|
+
|
75
|
+
Name | Type | Description | Notes
|
76
|
+
------------- | ------------- | ------------- | -------------
|
77
|
+
**app** | **String**| 应用标识 |
|
78
|
+
**account** | **String**| 成员账号 |
|
79
|
+
**scopes** | **String**| 权限 |
|
80
|
+
**name** | **String**| 备注名称 | [optional]
|
81
|
+
|
82
|
+
### Return type
|
83
|
+
|
84
|
+
[**MentorForm**](MentorForm.md)
|
85
|
+
|
86
|
+
### Authorization
|
87
|
+
|
88
|
+
[TokenAuth](../README.md#TokenAuth)
|
89
|
+
|
90
|
+
### HTTP request headers
|
91
|
+
|
92
|
+
- **Content-Type**: Not defined
|
93
|
+
- **Accept**: application/json
|
94
|
+
|
95
|
+
|
96
|
+
|
97
|
+
# **app_blacklist**
|
98
|
+
> BlacklistBean app_blacklist(app)
|
99
|
+
|
100
|
+
获取黑名单信息
|
101
|
+
|
102
|
+
### Example
|
103
|
+
```ruby
|
104
|
+
# load the gem
|
105
|
+
require 'indexea_client'
|
106
|
+
# setup authorization
|
107
|
+
IndexeaClient.configure do |config|
|
108
|
+
end
|
109
|
+
|
110
|
+
api_instance = IndexeaClient::AppsApi.new
|
111
|
+
app = 'app_example' # String | 应用标识
|
112
|
+
|
113
|
+
|
114
|
+
begin
|
115
|
+
#获取黑名单信息
|
116
|
+
result = api_instance.app_blacklist(app)
|
117
|
+
p result
|
118
|
+
rescue IndexeaClient::ApiError => e
|
119
|
+
puts "Exception when calling AppsApi->app_blacklist: #{e}"
|
120
|
+
end
|
121
|
+
```
|
122
|
+
|
123
|
+
### Parameters
|
124
|
+
|
125
|
+
Name | Type | Description | Notes
|
126
|
+
------------- | ------------- | ------------- | -------------
|
127
|
+
**app** | **String**| 应用标识 |
|
128
|
+
|
129
|
+
### Return type
|
130
|
+
|
131
|
+
[**BlacklistBean**](BlacklistBean.md)
|
132
|
+
|
133
|
+
### Authorization
|
134
|
+
|
135
|
+
[TokenAuth](../README.md#TokenAuth)
|
136
|
+
|
137
|
+
### HTTP request headers
|
138
|
+
|
139
|
+
- **Content-Type**: Not defined
|
140
|
+
- **Accept**: application/json
|
141
|
+
|
142
|
+
|
143
|
+
|
144
|
+
# **app_create**
|
145
|
+
> AppBean app_create(opts)
|
146
|
+
|
147
|
+
创建应用
|
148
|
+
|
149
|
+
### Example
|
150
|
+
```ruby
|
151
|
+
# load the gem
|
152
|
+
require 'indexea_client'
|
153
|
+
# setup authorization
|
154
|
+
IndexeaClient.configure do |config|
|
155
|
+
end
|
156
|
+
|
157
|
+
api_instance = IndexeaClient::AppsApi.new
|
158
|
+
opts = {
|
159
|
+
name: 'name_example' # String |
|
160
|
+
intro: 'intro_example' # String |
|
161
|
+
}
|
162
|
+
|
163
|
+
begin
|
164
|
+
#创建应用
|
165
|
+
result = api_instance.app_create(opts)
|
166
|
+
p result
|
167
|
+
rescue IndexeaClient::ApiError => e
|
168
|
+
puts "Exception when calling AppsApi->app_create: #{e}"
|
169
|
+
end
|
170
|
+
```
|
171
|
+
|
172
|
+
### Parameters
|
173
|
+
|
174
|
+
Name | Type | Description | Notes
|
175
|
+
------------- | ------------- | ------------- | -------------
|
176
|
+
**name** | **String**| | [optional]
|
177
|
+
**intro** | **String**| | [optional]
|
178
|
+
|
179
|
+
### Return type
|
180
|
+
|
181
|
+
[**AppBean**](AppBean.md)
|
182
|
+
|
183
|
+
### Authorization
|
184
|
+
|
185
|
+
[TokenAuth](../README.md#TokenAuth)
|
186
|
+
|
187
|
+
### HTTP request headers
|
188
|
+
|
189
|
+
- **Content-Type**: application/x-www-form-urlencoded
|
190
|
+
- **Accept**: application/json
|
191
|
+
|
192
|
+
|
193
|
+
|
194
|
+
# **app_create_access_token**
|
195
|
+
> TokenBean app_create_access_token(bodyapp)
|
196
|
+
|
197
|
+
创建 Access Token
|
198
|
+
|
199
|
+
### Example
|
200
|
+
```ruby
|
201
|
+
# load the gem
|
202
|
+
require 'indexea_client'
|
203
|
+
# setup authorization
|
204
|
+
IndexeaClient.configure do |config|
|
205
|
+
end
|
206
|
+
|
207
|
+
api_instance = IndexeaClient::AppsApi.new
|
208
|
+
body = IndexeaClient::TokenBean.new # TokenBean |
|
209
|
+
app = 'app_example' # String | 应用标识
|
210
|
+
|
211
|
+
|
212
|
+
begin
|
213
|
+
#创建 Access Token
|
214
|
+
result = api_instance.app_create_access_token(bodyapp)
|
215
|
+
p result
|
216
|
+
rescue IndexeaClient::ApiError => e
|
217
|
+
puts "Exception when calling AppsApi->app_create_access_token: #{e}"
|
218
|
+
end
|
219
|
+
```
|
220
|
+
|
221
|
+
### Parameters
|
222
|
+
|
223
|
+
Name | Type | Description | Notes
|
224
|
+
------------- | ------------- | ------------- | -------------
|
225
|
+
**body** | [**TokenBean**](TokenBean.md)| |
|
226
|
+
**app** | **String**| 应用标识 |
|
227
|
+
|
228
|
+
### Return type
|
229
|
+
|
230
|
+
[**TokenBean**](TokenBean.md)
|
231
|
+
|
232
|
+
### Authorization
|
233
|
+
|
234
|
+
[TokenAuth](../README.md#TokenAuth)
|
235
|
+
|
236
|
+
### HTTP request headers
|
237
|
+
|
238
|
+
- **Content-Type**: application/json
|
239
|
+
- **Accept**: application/json
|
240
|
+
|
241
|
+
|
242
|
+
|
243
|
+
# **app_create_oauth_app**
|
244
|
+
> OauthAppBean app_create_oauth_app(bodyapp)
|
245
|
+
|
246
|
+
创建第三方应用
|
247
|
+
|
248
|
+
### Example
|
249
|
+
```ruby
|
250
|
+
# load the gem
|
251
|
+
require 'indexea_client'
|
252
|
+
# setup authorization
|
253
|
+
IndexeaClient.configure do |config|
|
254
|
+
end
|
255
|
+
|
256
|
+
api_instance = IndexeaClient::AppsApi.new
|
257
|
+
body = IndexeaClient::OauthAppBean.new # OauthAppBean |
|
258
|
+
app = 'app_example' # String | 应用标识
|
259
|
+
|
260
|
+
|
261
|
+
begin
|
262
|
+
#创建第三方应用
|
263
|
+
result = api_instance.app_create_oauth_app(bodyapp)
|
264
|
+
p result
|
265
|
+
rescue IndexeaClient::ApiError => e
|
266
|
+
puts "Exception when calling AppsApi->app_create_oauth_app: #{e}"
|
267
|
+
end
|
268
|
+
```
|
269
|
+
|
270
|
+
### Parameters
|
271
|
+
|
272
|
+
Name | Type | Description | Notes
|
273
|
+
------------- | ------------- | ------------- | -------------
|
274
|
+
**body** | [**OauthAppBean**](OauthAppBean.md)| |
|
275
|
+
**app** | **String**| 应用标识 |
|
276
|
+
|
277
|
+
### Return type
|
278
|
+
|
279
|
+
[**OauthAppBean**](OauthAppBean.md)
|
280
|
+
|
281
|
+
### Authorization
|
282
|
+
|
283
|
+
[TokenAuth](../README.md#TokenAuth)
|
284
|
+
|
285
|
+
### HTTP request headers
|
286
|
+
|
287
|
+
- **Content-Type**: application/json
|
288
|
+
- **Accept**: application/json
|
289
|
+
|
290
|
+
|
291
|
+
|
292
|
+
# **app_delete**
|
293
|
+
> BOOLEAN app_delete(app)
|
294
|
+
|
295
|
+
删除应用
|
296
|
+
|
297
|
+
### Example
|
298
|
+
```ruby
|
299
|
+
# load the gem
|
300
|
+
require 'indexea_client'
|
301
|
+
# setup authorization
|
302
|
+
IndexeaClient.configure do |config|
|
303
|
+
end
|
304
|
+
|
305
|
+
api_instance = IndexeaClient::AppsApi.new
|
306
|
+
app = 'app_example' # String | 应用标识
|
307
|
+
|
308
|
+
|
309
|
+
begin
|
310
|
+
#删除应用
|
311
|
+
result = api_instance.app_delete(app)
|
312
|
+
p result
|
313
|
+
rescue IndexeaClient::ApiError => e
|
314
|
+
puts "Exception when calling AppsApi->app_delete: #{e}"
|
315
|
+
end
|
316
|
+
```
|
317
|
+
|
318
|
+
### Parameters
|
319
|
+
|
320
|
+
Name | Type | Description | Notes
|
321
|
+
------------- | ------------- | ------------- | -------------
|
322
|
+
**app** | **String**| 应用标识 |
|
323
|
+
|
324
|
+
### Return type
|
325
|
+
|
326
|
+
**BOOLEAN**
|
327
|
+
|
328
|
+
### Authorization
|
329
|
+
|
330
|
+
[TokenAuth](../README.md#TokenAuth)
|
331
|
+
|
332
|
+
### HTTP request headers
|
333
|
+
|
334
|
+
- **Content-Type**: Not defined
|
335
|
+
- **Accept**: application/json
|
336
|
+
|
337
|
+
|
338
|
+
|
339
|
+
# **app_delete_access_token**
|
340
|
+
> BOOLEAN app_delete_access_token(idapp, opts)
|
341
|
+
|
342
|
+
删除 Access Token
|
343
|
+
|
344
|
+
### Example
|
345
|
+
```ruby
|
346
|
+
# load the gem
|
347
|
+
require 'indexea_client'
|
348
|
+
# setup authorization
|
349
|
+
IndexeaClient.configure do |config|
|
350
|
+
end
|
351
|
+
|
352
|
+
api_instance = IndexeaClient::AppsApi.new
|
353
|
+
id = 56 # Integer | Access Token 编号
|
354
|
+
app = 'app_example' # String | 应用标识
|
355
|
+
opts = {
|
356
|
+
vcode: 'vcode_example' # String |
|
357
|
+
}
|
358
|
+
|
359
|
+
begin
|
360
|
+
#删除 Access Token
|
361
|
+
result = api_instance.app_delete_access_token(idapp, opts)
|
362
|
+
p result
|
363
|
+
rescue IndexeaClient::ApiError => e
|
364
|
+
puts "Exception when calling AppsApi->app_delete_access_token: #{e}"
|
365
|
+
end
|
366
|
+
```
|
367
|
+
|
368
|
+
### Parameters
|
369
|
+
|
370
|
+
Name | Type | Description | Notes
|
371
|
+
------------- | ------------- | ------------- | -------------
|
372
|
+
**id** | **Integer**| Access Token 编号 |
|
373
|
+
**app** | **String**| 应用标识 |
|
374
|
+
**vcode** | **String**| | [optional]
|
375
|
+
|
376
|
+
### Return type
|
377
|
+
|
378
|
+
**BOOLEAN**
|
379
|
+
|
380
|
+
### Authorization
|
381
|
+
|
382
|
+
[TokenAuth](../README.md#TokenAuth)
|
383
|
+
|
384
|
+
### HTTP request headers
|
385
|
+
|
386
|
+
- **Content-Type**: application/x-www-form-urlencoded
|
387
|
+
- **Accept**: application/json
|
388
|
+
|
389
|
+
|
390
|
+
|
391
|
+
# **app_delete_mentor**
|
392
|
+
> BOOLEAN app_delete_mentor(app, account)
|
393
|
+
|
394
|
+
删除应用成员
|
395
|
+
|
396
|
+
### Example
|
397
|
+
```ruby
|
398
|
+
# load the gem
|
399
|
+
require 'indexea_client'
|
400
|
+
# setup authorization
|
401
|
+
IndexeaClient.configure do |config|
|
402
|
+
end
|
403
|
+
|
404
|
+
api_instance = IndexeaClient::AppsApi.new
|
405
|
+
app = 'app_example' # String | 应用标识
|
406
|
+
account = 56 # Integer | 成员编号
|
407
|
+
|
408
|
+
|
409
|
+
begin
|
410
|
+
#删除应用成员
|
411
|
+
result = api_instance.app_delete_mentor(app, account)
|
412
|
+
p result
|
413
|
+
rescue IndexeaClient::ApiError => e
|
414
|
+
puts "Exception when calling AppsApi->app_delete_mentor: #{e}"
|
415
|
+
end
|
416
|
+
```
|
417
|
+
|
418
|
+
### Parameters
|
419
|
+
|
420
|
+
Name | Type | Description | Notes
|
421
|
+
------------- | ------------- | ------------- | -------------
|
422
|
+
**app** | **String**| 应用标识 |
|
423
|
+
**account** | **Integer**| 成员编号 |
|
424
|
+
|
425
|
+
### Return type
|
426
|
+
|
427
|
+
**BOOLEAN**
|
428
|
+
|
429
|
+
### Authorization
|
430
|
+
|
431
|
+
[TokenAuth](../README.md#TokenAuth)
|
432
|
+
|
433
|
+
### HTTP request headers
|
434
|
+
|
435
|
+
- **Content-Type**: Not defined
|
436
|
+
- **Accept**: application/json
|
437
|
+
|
438
|
+
|
439
|
+
|
440
|
+
# **app_delete_oauth_app**
|
441
|
+
> BOOLEAN app_delete_oauth_app(identapp, opts)
|
442
|
+
|
443
|
+
删除第三方应用
|
444
|
+
|
445
|
+
### Example
|
446
|
+
```ruby
|
447
|
+
# load the gem
|
448
|
+
require 'indexea_client'
|
449
|
+
# setup authorization
|
450
|
+
IndexeaClient.configure do |config|
|
451
|
+
end
|
452
|
+
|
453
|
+
api_instance = IndexeaClient::AppsApi.new
|
454
|
+
ident = 'ident_example' # String | 三方应用编号
|
455
|
+
app = 'app_example' # String | 应用标识
|
456
|
+
opts = {
|
457
|
+
vcode: 'vcode_example' # String |
|
458
|
+
}
|
459
|
+
|
460
|
+
begin
|
461
|
+
#删除第三方应用
|
462
|
+
result = api_instance.app_delete_oauth_app(identapp, opts)
|
463
|
+
p result
|
464
|
+
rescue IndexeaClient::ApiError => e
|
465
|
+
puts "Exception when calling AppsApi->app_delete_oauth_app: #{e}"
|
466
|
+
end
|
467
|
+
```
|
468
|
+
|
469
|
+
### Parameters
|
470
|
+
|
471
|
+
Name | Type | Description | Notes
|
472
|
+
------------- | ------------- | ------------- | -------------
|
473
|
+
**ident** | **String**| 三方应用编号 |
|
474
|
+
**app** | **String**| 应用标识 |
|
475
|
+
**vcode** | **String**| | [optional]
|
476
|
+
|
477
|
+
### Return type
|
478
|
+
|
479
|
+
**BOOLEAN**
|
480
|
+
|
481
|
+
### Authorization
|
482
|
+
|
483
|
+
[TokenAuth](../README.md#TokenAuth)
|
484
|
+
|
485
|
+
### HTTP request headers
|
486
|
+
|
487
|
+
- **Content-Type**: application/x-www-form-urlencoded
|
488
|
+
- **Accept**: application/json
|
489
|
+
|
490
|
+
|
491
|
+
|
492
|
+
# **app_excel_of_logs**
|
493
|
+
> String app_excel_of_logs(app, opts)
|
494
|
+
|
495
|
+
导出应用日志到 Excel
|
496
|
+
|
497
|
+
### Example
|
498
|
+
```ruby
|
499
|
+
# load the gem
|
500
|
+
require 'indexea_client'
|
501
|
+
# setup authorization
|
502
|
+
IndexeaClient.configure do |config|
|
503
|
+
end
|
504
|
+
|
505
|
+
api_instance = IndexeaClient::AppsApi.new
|
506
|
+
app = 'app_example' # String | 应用标识
|
507
|
+
opts = {
|
508
|
+
account: 0, # Integer | 账号
|
509
|
+
indices: [56], # Array<Integer> | 索引
|
510
|
+
widget: 0, # Integer | 组件
|
511
|
+
query: 0, # Integer | 查询
|
512
|
+
type: 0, # Integer | 类型
|
513
|
+
start_date: Date.parse('2013-10-20'), # Date | 起始日期
|
514
|
+
end_date: Date.parse('2013-10-20') # Date | 结束日期
|
515
|
+
}
|
516
|
+
|
517
|
+
begin
|
518
|
+
#导出应用日志到 Excel
|
519
|
+
result = api_instance.app_excel_of_logs(app, opts)
|
520
|
+
p result
|
521
|
+
rescue IndexeaClient::ApiError => e
|
522
|
+
puts "Exception when calling AppsApi->app_excel_of_logs: #{e}"
|
523
|
+
end
|
524
|
+
```
|
525
|
+
|
526
|
+
### Parameters
|
527
|
+
|
528
|
+
Name | Type | Description | Notes
|
529
|
+
------------- | ------------- | ------------- | -------------
|
530
|
+
**app** | **String**| 应用标识 |
|
531
|
+
**account** | **Integer**| 账号 | [optional] [default to 0]
|
532
|
+
**indices** | [**Array<Integer>**](Integer.md)| 索引 | [optional]
|
533
|
+
**widget** | **Integer**| 组件 | [optional] [default to 0]
|
534
|
+
**query** | **Integer**| 查询 | [optional] [default to 0]
|
535
|
+
**type** | **Integer**| 类型 | [optional] [default to 0]
|
536
|
+
**start_date** | **Date**| 起始日期 | [optional]
|
537
|
+
**end_date** | **Date**| 结束日期 | [optional]
|
538
|
+
|
539
|
+
### Return type
|
540
|
+
|
541
|
+
**String**
|
542
|
+
|
543
|
+
### Authorization
|
544
|
+
|
545
|
+
[TokenAuth](../README.md#TokenAuth)
|
546
|
+
|
547
|
+
### HTTP request headers
|
548
|
+
|
549
|
+
- **Content-Type**: Not defined
|
550
|
+
- **Accept**: application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
|
551
|
+
|
552
|
+
|
553
|
+
|
554
|
+
# **app_get**
|
555
|
+
> AppBean app_get(app)
|
556
|
+
|
557
|
+
获取应用详情
|
558
|
+
|
559
|
+
### Example
|
560
|
+
```ruby
|
561
|
+
# load the gem
|
562
|
+
require 'indexea_client'
|
563
|
+
# setup authorization
|
564
|
+
IndexeaClient.configure do |config|
|
565
|
+
end
|
566
|
+
|
567
|
+
api_instance = IndexeaClient::AppsApi.new
|
568
|
+
app = 'app_example' # String | 应用标识
|
569
|
+
|
570
|
+
|
571
|
+
begin
|
572
|
+
#获取应用详情
|
573
|
+
result = api_instance.app_get(app)
|
574
|
+
p result
|
575
|
+
rescue IndexeaClient::ApiError => e
|
576
|
+
puts "Exception when calling AppsApi->app_get: #{e}"
|
577
|
+
end
|
578
|
+
```
|
579
|
+
|
580
|
+
### Parameters
|
581
|
+
|
582
|
+
Name | Type | Description | Notes
|
583
|
+
------------- | ------------- | ------------- | -------------
|
584
|
+
**app** | **String**| 应用标识 |
|
585
|
+
|
586
|
+
### Return type
|
587
|
+
|
588
|
+
[**AppBean**](AppBean.md)
|
589
|
+
|
590
|
+
### Authorization
|
591
|
+
|
592
|
+
[TokenAuth](../README.md#TokenAuth)
|
593
|
+
|
594
|
+
### HTTP request headers
|
595
|
+
|
596
|
+
- **Content-Type**: Not defined
|
597
|
+
- **Accept**: application/json
|
598
|
+
|
599
|
+
|
600
|
+
|
601
|
+
# **app_get_company**
|
602
|
+
> CompanyBean app_get_company(app)
|
603
|
+
|
604
|
+
获取应用填写的公司信息
|
605
|
+
|
606
|
+
### Example
|
607
|
+
```ruby
|
608
|
+
# load the gem
|
609
|
+
require 'indexea_client'
|
610
|
+
# setup authorization
|
611
|
+
IndexeaClient.configure do |config|
|
612
|
+
end
|
613
|
+
|
614
|
+
api_instance = IndexeaClient::AppsApi.new
|
615
|
+
app = 'app_example' # String | 应用标识
|
616
|
+
|
617
|
+
|
618
|
+
begin
|
619
|
+
#获取应用填写的公司信息
|
620
|
+
result = api_instance.app_get_company(app)
|
621
|
+
p result
|
622
|
+
rescue IndexeaClient::ApiError => e
|
623
|
+
puts "Exception when calling AppsApi->app_get_company: #{e}"
|
624
|
+
end
|
625
|
+
```
|
626
|
+
|
627
|
+
### Parameters
|
628
|
+
|
629
|
+
Name | Type | Description | Notes
|
630
|
+
------------- | ------------- | ------------- | -------------
|
631
|
+
**app** | **String**| 应用标识 |
|
632
|
+
|
633
|
+
### Return type
|
634
|
+
|
635
|
+
[**CompanyBean**](CompanyBean.md)
|
636
|
+
|
637
|
+
### Authorization
|
638
|
+
|
639
|
+
[TokenAuth](../README.md#TokenAuth)
|
640
|
+
|
641
|
+
### HTTP request headers
|
642
|
+
|
643
|
+
- **Content-Type**: Not defined
|
644
|
+
- **Accept**: application/json
|
645
|
+
|
646
|
+
|
647
|
+
|
648
|
+
# **app_get_company_pic**
|
649
|
+
> String app_get_company_pic(app, type)
|
650
|
+
|
651
|
+
获取公司营业执照或者一般纳税人证明
|
652
|
+
|
653
|
+
### Example
|
654
|
+
```ruby
|
655
|
+
# load the gem
|
656
|
+
require 'indexea_client'
|
657
|
+
# setup authorization
|
658
|
+
IndexeaClient.configure do |config|
|
659
|
+
end
|
660
|
+
|
661
|
+
api_instance = IndexeaClient::AppsApi.new
|
662
|
+
app = 'app_example' # String | 应用标识
|
663
|
+
type = 'type_example' # String | 获取图片的类型 [license,certificate]
|
664
|
+
|
665
|
+
|
666
|
+
begin
|
667
|
+
#获取公司营业执照或者一般纳税人证明
|
668
|
+
result = api_instance.app_get_company_pic(app, type)
|
669
|
+
p result
|
670
|
+
rescue IndexeaClient::ApiError => e
|
671
|
+
puts "Exception when calling AppsApi->app_get_company_pic: #{e}"
|
672
|
+
end
|
673
|
+
```
|
674
|
+
|
675
|
+
### Parameters
|
676
|
+
|
677
|
+
Name | Type | Description | Notes
|
678
|
+
------------- | ------------- | ------------- | -------------
|
679
|
+
**app** | **String**| 应用标识 |
|
680
|
+
**type** | **String**| 获取图片的类型 [license,certificate] |
|
681
|
+
|
682
|
+
### Return type
|
683
|
+
|
684
|
+
**String**
|
685
|
+
|
686
|
+
### Authorization
|
687
|
+
|
688
|
+
[TokenAuth](../README.md#TokenAuth)
|
689
|
+
|
690
|
+
### HTTP request headers
|
691
|
+
|
692
|
+
- **Content-Type**: Not defined
|
693
|
+
- **Accept**: default
|
694
|
+
|
695
|
+
|
696
|
+
|
697
|
+
# **app_list**
|
698
|
+
> Array<AppBean> app_list
|
699
|
+
|
700
|
+
获取应用列表
|
701
|
+
|
702
|
+
### Example
|
703
|
+
```ruby
|
704
|
+
# load the gem
|
705
|
+
require 'indexea_client'
|
706
|
+
# setup authorization
|
707
|
+
IndexeaClient.configure do |config|
|
708
|
+
end
|
709
|
+
|
710
|
+
api_instance = IndexeaClient::AppsApi.new
|
711
|
+
|
712
|
+
begin
|
713
|
+
#获取应用列表
|
714
|
+
result = api_instance.app_list
|
715
|
+
p result
|
716
|
+
rescue IndexeaClient::ApiError => e
|
717
|
+
puts "Exception when calling AppsApi->app_list: #{e}"
|
718
|
+
end
|
719
|
+
```
|
720
|
+
|
721
|
+
### Parameters
|
722
|
+
This endpoint does not need any parameter.
|
723
|
+
|
724
|
+
### Return type
|
725
|
+
|
726
|
+
[**Array<AppBean>**](AppBean.md)
|
727
|
+
|
728
|
+
### Authorization
|
729
|
+
|
730
|
+
[TokenAuth](../README.md#TokenAuth)
|
731
|
+
|
732
|
+
### HTTP request headers
|
733
|
+
|
734
|
+
- **Content-Type**: Not defined
|
735
|
+
- **Accept**: application/json
|
736
|
+
|
737
|
+
|
738
|
+
|
739
|
+
# **app_list_mentors**
|
740
|
+
> MentorForm app_list_mentors(app, opts)
|
741
|
+
|
742
|
+
获取应用成员列表
|
743
|
+
|
744
|
+
### Example
|
745
|
+
```ruby
|
746
|
+
# load the gem
|
747
|
+
require 'indexea_client'
|
748
|
+
# setup authorization
|
749
|
+
IndexeaClient.configure do |config|
|
750
|
+
end
|
751
|
+
|
752
|
+
api_instance = IndexeaClient::AppsApi.new
|
753
|
+
app = 'app_example' # String | 应用标识
|
754
|
+
opts = {
|
755
|
+
from: 0, # Integer | 开始位置
|
756
|
+
size: 20 # Integer | 获取的数量
|
757
|
+
}
|
758
|
+
|
759
|
+
begin
|
760
|
+
#获取应用成员列表
|
761
|
+
result = api_instance.app_list_mentors(app, opts)
|
762
|
+
p result
|
763
|
+
rescue IndexeaClient::ApiError => e
|
764
|
+
puts "Exception when calling AppsApi->app_list_mentors: #{e}"
|
765
|
+
end
|
766
|
+
```
|
767
|
+
|
768
|
+
### Parameters
|
769
|
+
|
770
|
+
Name | Type | Description | Notes
|
771
|
+
------------- | ------------- | ------------- | -------------
|
772
|
+
**app** | **String**| 应用标识 |
|
773
|
+
**from** | **Integer**| 开始位置 | [optional] [default to 0]
|
774
|
+
**size** | **Integer**| 获取的数量 | [optional] [default to 20]
|
775
|
+
|
776
|
+
### Return type
|
777
|
+
|
778
|
+
[**MentorForm**](MentorForm.md)
|
779
|
+
|
780
|
+
### Authorization
|
781
|
+
|
782
|
+
[TokenAuth](../README.md#TokenAuth)
|
783
|
+
|
784
|
+
### HTTP request headers
|
785
|
+
|
786
|
+
- **Content-Type**: Not defined
|
787
|
+
- **Accept**: application/json
|
788
|
+
|
789
|
+
|
790
|
+
|
791
|
+
# **app_list_oauth_apps**
|
792
|
+
> Array<OauthAppBean> app_list_oauth_apps(app)
|
793
|
+
|
794
|
+
获取第三方应用列表
|
795
|
+
|
796
|
+
### Example
|
797
|
+
```ruby
|
798
|
+
# load the gem
|
799
|
+
require 'indexea_client'
|
800
|
+
# setup authorization
|
801
|
+
IndexeaClient.configure do |config|
|
802
|
+
end
|
803
|
+
|
804
|
+
api_instance = IndexeaClient::AppsApi.new
|
805
|
+
app = 'app_example' # String | 应用标识
|
806
|
+
|
807
|
+
|
808
|
+
begin
|
809
|
+
#获取第三方应用列表
|
810
|
+
result = api_instance.app_list_oauth_apps(app)
|
811
|
+
p result
|
812
|
+
rescue IndexeaClient::ApiError => e
|
813
|
+
puts "Exception when calling AppsApi->app_list_oauth_apps: #{e}"
|
814
|
+
end
|
815
|
+
```
|
816
|
+
|
817
|
+
### Parameters
|
818
|
+
|
819
|
+
Name | Type | Description | Notes
|
820
|
+
------------- | ------------- | ------------- | -------------
|
821
|
+
**app** | **String**| 应用标识 |
|
822
|
+
|
823
|
+
### Return type
|
824
|
+
|
825
|
+
[**Array<OauthAppBean>**](OauthAppBean.md)
|
826
|
+
|
827
|
+
### Authorization
|
828
|
+
|
829
|
+
[TokenAuth](../README.md#TokenAuth)
|
830
|
+
|
831
|
+
### HTTP request headers
|
832
|
+
|
833
|
+
- **Content-Type**: Not defined
|
834
|
+
- **Accept**: application/json
|
835
|
+
|
836
|
+
|
837
|
+
|
838
|
+
# **app_logs**
|
839
|
+
> AppLogsBean app_logs(app, opts)
|
840
|
+
|
841
|
+
获取应用的日志列表
|
842
|
+
|
843
|
+
### Example
|
844
|
+
```ruby
|
845
|
+
# load the gem
|
846
|
+
require 'indexea_client'
|
847
|
+
# setup authorization
|
848
|
+
IndexeaClient.configure do |config|
|
849
|
+
end
|
850
|
+
|
851
|
+
api_instance = IndexeaClient::AppsApi.new
|
852
|
+
app = 'app_example' # String | 应用标识
|
853
|
+
opts = {
|
854
|
+
account: 0, # Integer | 账号
|
855
|
+
indices: [56], # Array<Integer> | 索引
|
856
|
+
widget: 0, # Integer | 组件
|
857
|
+
query: 0, # Integer | 查询
|
858
|
+
type: 0, # Integer | 类型
|
859
|
+
start_date: Date.parse('2013-10-20'), # Date | 起始日期
|
860
|
+
end_date: Date.parse('2013-10-20'), # Date | 结束日期
|
861
|
+
from: 0, # Integer | 起始位置
|
862
|
+
size: 20 # Integer | 数量
|
863
|
+
}
|
864
|
+
|
865
|
+
begin
|
866
|
+
#获取应用的日志列表
|
867
|
+
result = api_instance.app_logs(app, opts)
|
868
|
+
p result
|
869
|
+
rescue IndexeaClient::ApiError => e
|
870
|
+
puts "Exception when calling AppsApi->app_logs: #{e}"
|
871
|
+
end
|
872
|
+
```
|
873
|
+
|
874
|
+
### Parameters
|
875
|
+
|
876
|
+
Name | Type | Description | Notes
|
877
|
+
------------- | ------------- | ------------- | -------------
|
878
|
+
**app** | **String**| 应用标识 |
|
879
|
+
**account** | **Integer**| 账号 | [optional] [default to 0]
|
880
|
+
**indices** | [**Array<Integer>**](Integer.md)| 索引 | [optional]
|
881
|
+
**widget** | **Integer**| 组件 | [optional] [default to 0]
|
882
|
+
**query** | **Integer**| 查询 | [optional] [default to 0]
|
883
|
+
**type** | **Integer**| 类型 | [optional] [default to 0]
|
884
|
+
**start_date** | **Date**| 起始日期 | [optional]
|
885
|
+
**end_date** | **Date**| 结束日期 | [optional]
|
886
|
+
**from** | **Integer**| 起始位置 | [optional] [default to 0]
|
887
|
+
**size** | **Integer**| 数量 | [optional] [default to 20]
|
888
|
+
|
889
|
+
### Return type
|
890
|
+
|
891
|
+
[**AppLogsBean**](AppLogsBean.md)
|
892
|
+
|
893
|
+
### Authorization
|
894
|
+
|
895
|
+
[TokenAuth](../README.md#TokenAuth)
|
896
|
+
|
897
|
+
### HTTP request headers
|
898
|
+
|
899
|
+
- **Content-Type**: Not defined
|
900
|
+
- **Accept**: application/json
|
901
|
+
|
902
|
+
|
903
|
+
|
904
|
+
# **app_reset_access_token**
|
905
|
+
> TokenBean app_reset_access_token(idapp, opts)
|
906
|
+
|
907
|
+
重置 Access Token
|
908
|
+
|
909
|
+
### Example
|
910
|
+
```ruby
|
911
|
+
# load the gem
|
912
|
+
require 'indexea_client'
|
913
|
+
# setup authorization
|
914
|
+
IndexeaClient.configure do |config|
|
915
|
+
end
|
916
|
+
|
917
|
+
api_instance = IndexeaClient::AppsApi.new
|
918
|
+
id = 56 # Integer | Access Token 编号
|
919
|
+
app = 'app_example' # String | 应用标识
|
920
|
+
opts = {
|
921
|
+
vcode: 'vcode_example' # String |
|
922
|
+
}
|
923
|
+
|
924
|
+
begin
|
925
|
+
#重置 Access Token
|
926
|
+
result = api_instance.app_reset_access_token(idapp, opts)
|
927
|
+
p result
|
928
|
+
rescue IndexeaClient::ApiError => e
|
929
|
+
puts "Exception when calling AppsApi->app_reset_access_token: #{e}"
|
930
|
+
end
|
931
|
+
```
|
932
|
+
|
933
|
+
### Parameters
|
934
|
+
|
935
|
+
Name | Type | Description | Notes
|
936
|
+
------------- | ------------- | ------------- | -------------
|
937
|
+
**id** | **Integer**| Access Token 编号 |
|
938
|
+
**app** | **String**| 应用标识 |
|
939
|
+
**vcode** | **String**| | [optional]
|
940
|
+
|
941
|
+
### Return type
|
942
|
+
|
943
|
+
[**TokenBean**](TokenBean.md)
|
944
|
+
|
945
|
+
### Authorization
|
946
|
+
|
947
|
+
[TokenAuth](../README.md#TokenAuth)
|
948
|
+
|
949
|
+
### HTTP request headers
|
950
|
+
|
951
|
+
- **Content-Type**: application/x-www-form-urlencoded
|
952
|
+
- **Accept**: application/json
|
953
|
+
|
954
|
+
|
955
|
+
|
956
|
+
# **app_reset_oauth_app_secret**
|
957
|
+
> OauthAppBean app_reset_oauth_app_secret(identapp, opts)
|
958
|
+
|
959
|
+
重新生成三方应用的密钥
|
960
|
+
|
961
|
+
### Example
|
962
|
+
```ruby
|
963
|
+
# load the gem
|
964
|
+
require 'indexea_client'
|
965
|
+
# setup authorization
|
966
|
+
IndexeaClient.configure do |config|
|
967
|
+
end
|
968
|
+
|
969
|
+
api_instance = IndexeaClient::AppsApi.new
|
970
|
+
ident = 'ident_example' # String | 三方应用标识
|
971
|
+
app = 'app_example' # String | 应用标识
|
972
|
+
opts = {
|
973
|
+
vcode: 'vcode_example' # String |
|
974
|
+
}
|
975
|
+
|
976
|
+
begin
|
977
|
+
#重新生成三方应用的密钥
|
978
|
+
result = api_instance.app_reset_oauth_app_secret(identapp, opts)
|
979
|
+
p result
|
980
|
+
rescue IndexeaClient::ApiError => e
|
981
|
+
puts "Exception when calling AppsApi->app_reset_oauth_app_secret: #{e}"
|
982
|
+
end
|
983
|
+
```
|
984
|
+
|
985
|
+
### Parameters
|
986
|
+
|
987
|
+
Name | Type | Description | Notes
|
988
|
+
------------- | ------------- | ------------- | -------------
|
989
|
+
**ident** | **String**| 三方应用标识 |
|
990
|
+
**app** | **String**| 应用标识 |
|
991
|
+
**vcode** | **String**| | [optional]
|
992
|
+
|
993
|
+
### Return type
|
994
|
+
|
995
|
+
[**OauthAppBean**](OauthAppBean.md)
|
996
|
+
|
997
|
+
### Authorization
|
998
|
+
|
999
|
+
[TokenAuth](../README.md#TokenAuth)
|
1000
|
+
|
1001
|
+
### HTTP request headers
|
1002
|
+
|
1003
|
+
- **Content-Type**: application/x-www-form-urlencoded
|
1004
|
+
- **Accept**: application/json
|
1005
|
+
|
1006
|
+
|
1007
|
+
|
1008
|
+
# **app_save_blacklist**
|
1009
|
+
> BOOLEAN app_save_blacklist(bodyapp)
|
1010
|
+
|
1011
|
+
修改应用的黑名单信息
|
1012
|
+
|
1013
|
+
### Example
|
1014
|
+
```ruby
|
1015
|
+
# load the gem
|
1016
|
+
require 'indexea_client'
|
1017
|
+
# setup authorization
|
1018
|
+
IndexeaClient.configure do |config|
|
1019
|
+
end
|
1020
|
+
|
1021
|
+
api_instance = IndexeaClient::AppsApi.new
|
1022
|
+
body = IndexeaClient::BlacklistBean.new # BlacklistBean |
|
1023
|
+
app = 'app_example' # String | 应用标识
|
1024
|
+
|
1025
|
+
|
1026
|
+
begin
|
1027
|
+
#修改应用的黑名单信息
|
1028
|
+
result = api_instance.app_save_blacklist(bodyapp)
|
1029
|
+
p result
|
1030
|
+
rescue IndexeaClient::ApiError => e
|
1031
|
+
puts "Exception when calling AppsApi->app_save_blacklist: #{e}"
|
1032
|
+
end
|
1033
|
+
```
|
1034
|
+
|
1035
|
+
### Parameters
|
1036
|
+
|
1037
|
+
Name | Type | Description | Notes
|
1038
|
+
------------- | ------------- | ------------- | -------------
|
1039
|
+
**body** | [**BlacklistBean**](BlacklistBean.md)| |
|
1040
|
+
**app** | **String**| 应用标识 |
|
1041
|
+
|
1042
|
+
### Return type
|
1043
|
+
|
1044
|
+
**BOOLEAN**
|
1045
|
+
|
1046
|
+
### Authorization
|
1047
|
+
|
1048
|
+
[TokenAuth](../README.md#TokenAuth)
|
1049
|
+
|
1050
|
+
### HTTP request headers
|
1051
|
+
|
1052
|
+
- **Content-Type**: application/json
|
1053
|
+
- **Accept**: application/json
|
1054
|
+
|
1055
|
+
|
1056
|
+
|
1057
|
+
# **app_save_company**
|
1058
|
+
> CompanyBean app_save_company(app, opts)
|
1059
|
+
|
1060
|
+
修改应用的公司信息
|
1061
|
+
|
1062
|
+
### Example
|
1063
|
+
```ruby
|
1064
|
+
# load the gem
|
1065
|
+
require 'indexea_client'
|
1066
|
+
# setup authorization
|
1067
|
+
IndexeaClient.configure do |config|
|
1068
|
+
end
|
1069
|
+
|
1070
|
+
api_instance = IndexeaClient::AppsApi.new
|
1071
|
+
app = 'app_example' # String | 应用标识
|
1072
|
+
opts = {
|
1073
|
+
name: 'name_example' # String |
|
1074
|
+
url: 'url_example' # String |
|
1075
|
+
nation: 'nation_example' # String |
|
1076
|
+
province: 'province_example' # String |
|
1077
|
+
city: 'city_example' # String |
|
1078
|
+
taxpayer: 'taxpayer_example' # String |
|
1079
|
+
bank: 'bank_example' # String |
|
1080
|
+
account: 'account_example' # String |
|
1081
|
+
address: 'address_example' # String |
|
1082
|
+
tel: 'tel_example' # String |
|
1083
|
+
license: 'license_example' # String |
|
1084
|
+
certificate: 'certificate_example' # String |
|
1085
|
+
post_addr: 'post_addr_example' # String |
|
1086
|
+
post_code: 'post_code_example' # String |
|
1087
|
+
post_name: 'post_name_example' # String |
|
1088
|
+
post_tel: 'post_tel_example' # String |
|
1089
|
+
}
|
1090
|
+
|
1091
|
+
begin
|
1092
|
+
#修改应用的公司信息
|
1093
|
+
result = api_instance.app_save_company(app, opts)
|
1094
|
+
p result
|
1095
|
+
rescue IndexeaClient::ApiError => e
|
1096
|
+
puts "Exception when calling AppsApi->app_save_company: #{e}"
|
1097
|
+
end
|
1098
|
+
```
|
1099
|
+
|
1100
|
+
### Parameters
|
1101
|
+
|
1102
|
+
Name | Type | Description | Notes
|
1103
|
+
------------- | ------------- | ------------- | -------------
|
1104
|
+
**app** | **String**| 应用标识 |
|
1105
|
+
**name** | **String**| | [optional]
|
1106
|
+
**url** | **String**| | [optional]
|
1107
|
+
**nation** | **String**| | [optional]
|
1108
|
+
**province** | **String**| | [optional]
|
1109
|
+
**city** | **String**| | [optional]
|
1110
|
+
**taxpayer** | **String**| | [optional]
|
1111
|
+
**bank** | **String**| | [optional]
|
1112
|
+
**account** | **String**| | [optional]
|
1113
|
+
**address** | **String**| | [optional]
|
1114
|
+
**tel** | **String**| | [optional]
|
1115
|
+
**license** | **String**| | [optional]
|
1116
|
+
**certificate** | **String**| | [optional]
|
1117
|
+
**post_addr** | **String**| | [optional]
|
1118
|
+
**post_code** | **String**| | [optional]
|
1119
|
+
**post_name** | **String**| | [optional]
|
1120
|
+
**post_tel** | **String**| | [optional]
|
1121
|
+
|
1122
|
+
### Return type
|
1123
|
+
|
1124
|
+
[**CompanyBean**](CompanyBean.md)
|
1125
|
+
|
1126
|
+
### Authorization
|
1127
|
+
|
1128
|
+
[TokenAuth](../README.md#TokenAuth)
|
1129
|
+
|
1130
|
+
### HTTP request headers
|
1131
|
+
|
1132
|
+
- **Content-Type**: multipart/form-data
|
1133
|
+
- **Accept**: application/json
|
1134
|
+
|
1135
|
+
|
1136
|
+
|
1137
|
+
# **app_searchs_estimate**
|
1138
|
+
> SearchEstimateResult app_searchs_estimate(app, days)
|
1139
|
+
|
1140
|
+
获取搜索流量包使用配额信息
|
1141
|
+
|
1142
|
+
### Example
|
1143
|
+
```ruby
|
1144
|
+
# load the gem
|
1145
|
+
require 'indexea_client'
|
1146
|
+
# setup authorization
|
1147
|
+
IndexeaClient.configure do |config|
|
1148
|
+
end
|
1149
|
+
|
1150
|
+
api_instance = IndexeaClient::AppsApi.new
|
1151
|
+
app = 'app_example' # String | 应用标识
|
1152
|
+
days = 30 # Integer | 计算平均搜索数的最近天数
|
1153
|
+
|
1154
|
+
|
1155
|
+
begin
|
1156
|
+
#获取搜索流量包使用配额信息
|
1157
|
+
result = api_instance.app_searchs_estimate(app, days)
|
1158
|
+
p result
|
1159
|
+
rescue IndexeaClient::ApiError => e
|
1160
|
+
puts "Exception when calling AppsApi->app_searchs_estimate: #{e}"
|
1161
|
+
end
|
1162
|
+
```
|
1163
|
+
|
1164
|
+
### Parameters
|
1165
|
+
|
1166
|
+
Name | Type | Description | Notes
|
1167
|
+
------------- | ------------- | ------------- | -------------
|
1168
|
+
**app** | **String**| 应用标识 |
|
1169
|
+
**days** | **Integer**| 计算平均搜索数的最近天数 | [default to 30]
|
1170
|
+
|
1171
|
+
### Return type
|
1172
|
+
|
1173
|
+
[**SearchEstimateResult**](SearchEstimateResult.md)
|
1174
|
+
|
1175
|
+
### Authorization
|
1176
|
+
|
1177
|
+
[TokenAuth](../README.md#TokenAuth)
|
1178
|
+
|
1179
|
+
### HTTP request headers
|
1180
|
+
|
1181
|
+
- **Content-Type**: Not defined
|
1182
|
+
- **Accept**: application/json
|
1183
|
+
|
1184
|
+
|
1185
|
+
|
1186
|
+
# **app_set_trigger**
|
1187
|
+
> BOOLEAN app_set_trigger(bodyapp)
|
1188
|
+
|
1189
|
+
修改应用的触发器信息
|
1190
|
+
|
1191
|
+
### Example
|
1192
|
+
```ruby
|
1193
|
+
# load the gem
|
1194
|
+
require 'indexea_client'
|
1195
|
+
# setup authorization
|
1196
|
+
IndexeaClient.configure do |config|
|
1197
|
+
end
|
1198
|
+
|
1199
|
+
api_instance = IndexeaClient::AppsApi.new
|
1200
|
+
body = IndexeaClient::TriggerBean.new # TriggerBean |
|
1201
|
+
app = 'app_example' # String | 应用标识
|
1202
|
+
|
1203
|
+
|
1204
|
+
begin
|
1205
|
+
#修改应用的触发器信息
|
1206
|
+
result = api_instance.app_set_trigger(bodyapp)
|
1207
|
+
p result
|
1208
|
+
rescue IndexeaClient::ApiError => e
|
1209
|
+
puts "Exception when calling AppsApi->app_set_trigger: #{e}"
|
1210
|
+
end
|
1211
|
+
```
|
1212
|
+
|
1213
|
+
### Parameters
|
1214
|
+
|
1215
|
+
Name | Type | Description | Notes
|
1216
|
+
------------- | ------------- | ------------- | -------------
|
1217
|
+
**body** | [**TriggerBean**](TriggerBean.md)| |
|
1218
|
+
**app** | **String**| 应用标识 |
|
1219
|
+
|
1220
|
+
### Return type
|
1221
|
+
|
1222
|
+
**BOOLEAN**
|
1223
|
+
|
1224
|
+
### Authorization
|
1225
|
+
|
1226
|
+
[TokenAuth](../README.md#TokenAuth)
|
1227
|
+
|
1228
|
+
### HTTP request headers
|
1229
|
+
|
1230
|
+
- **Content-Type**: application/json
|
1231
|
+
- **Accept**: application/json
|
1232
|
+
|
1233
|
+
|
1234
|
+
|
1235
|
+
# **app_tokens**
|
1236
|
+
> Array<TokenBean> app_tokens(app)
|
1237
|
+
|
1238
|
+
获取 Access Token 列表
|
1239
|
+
|
1240
|
+
### Example
|
1241
|
+
```ruby
|
1242
|
+
# load the gem
|
1243
|
+
require 'indexea_client'
|
1244
|
+
# setup authorization
|
1245
|
+
IndexeaClient.configure do |config|
|
1246
|
+
end
|
1247
|
+
|
1248
|
+
api_instance = IndexeaClient::AppsApi.new
|
1249
|
+
app = 'app_example' # String | 应用标识
|
1250
|
+
|
1251
|
+
|
1252
|
+
begin
|
1253
|
+
#获取 Access Token 列表
|
1254
|
+
result = api_instance.app_tokens(app)
|
1255
|
+
p result
|
1256
|
+
rescue IndexeaClient::ApiError => e
|
1257
|
+
puts "Exception when calling AppsApi->app_tokens: #{e}"
|
1258
|
+
end
|
1259
|
+
```
|
1260
|
+
|
1261
|
+
### Parameters
|
1262
|
+
|
1263
|
+
Name | Type | Description | Notes
|
1264
|
+
------------- | ------------- | ------------- | -------------
|
1265
|
+
**app** | **String**| 应用标识 |
|
1266
|
+
|
1267
|
+
### Return type
|
1268
|
+
|
1269
|
+
[**Array<TokenBean>**](TokenBean.md)
|
1270
|
+
|
1271
|
+
### Authorization
|
1272
|
+
|
1273
|
+
[TokenAuth](../README.md#TokenAuth)
|
1274
|
+
|
1275
|
+
### HTTP request headers
|
1276
|
+
|
1277
|
+
- **Content-Type**: Not defined
|
1278
|
+
- **Accept**: application/json
|
1279
|
+
|
1280
|
+
|
1281
|
+
|
1282
|
+
# **app_transfer**
|
1283
|
+
> BOOLEAN app_transfer(app, vcode, account)
|
1284
|
+
|
1285
|
+
转让应用给他人
|
1286
|
+
|
1287
|
+
### Example
|
1288
|
+
```ruby
|
1289
|
+
# load the gem
|
1290
|
+
require 'indexea_client'
|
1291
|
+
# setup authorization
|
1292
|
+
IndexeaClient.configure do |config|
|
1293
|
+
end
|
1294
|
+
|
1295
|
+
api_instance = IndexeaClient::AppsApi.new
|
1296
|
+
app = 'app_example' # String | 应用标识
|
1297
|
+
vcode = 'vcode_example' # String | 验证码
|
1298
|
+
account = 56 # Integer | 目标账号
|
1299
|
+
|
1300
|
+
|
1301
|
+
begin
|
1302
|
+
#转让应用给他人
|
1303
|
+
result = api_instance.app_transfer(app, vcode, account)
|
1304
|
+
p result
|
1305
|
+
rescue IndexeaClient::ApiError => e
|
1306
|
+
puts "Exception when calling AppsApi->app_transfer: #{e}"
|
1307
|
+
end
|
1308
|
+
```
|
1309
|
+
|
1310
|
+
### Parameters
|
1311
|
+
|
1312
|
+
Name | Type | Description | Notes
|
1313
|
+
------------- | ------------- | ------------- | -------------
|
1314
|
+
**app** | **String**| 应用标识 |
|
1315
|
+
**vcode** | **String**| 验证码 |
|
1316
|
+
**account** | **Integer**| 目标账号 |
|
1317
|
+
|
1318
|
+
### Return type
|
1319
|
+
|
1320
|
+
**BOOLEAN**
|
1321
|
+
|
1322
|
+
### Authorization
|
1323
|
+
|
1324
|
+
[TokenAuth](../README.md#TokenAuth)
|
1325
|
+
|
1326
|
+
### HTTP request headers
|
1327
|
+
|
1328
|
+
- **Content-Type**: Not defined
|
1329
|
+
- **Accept**: application/json
|
1330
|
+
|
1331
|
+
|
1332
|
+
|
1333
|
+
# **app_trigger**
|
1334
|
+
> TriggerBean app_trigger(app)
|
1335
|
+
|
1336
|
+
获取应用触发器详情
|
1337
|
+
|
1338
|
+
### Example
|
1339
|
+
```ruby
|
1340
|
+
# load the gem
|
1341
|
+
require 'indexea_client'
|
1342
|
+
# setup authorization
|
1343
|
+
IndexeaClient.configure do |config|
|
1344
|
+
end
|
1345
|
+
|
1346
|
+
api_instance = IndexeaClient::AppsApi.new
|
1347
|
+
app = 'app_example' # String | 应用标识
|
1348
|
+
|
1349
|
+
|
1350
|
+
begin
|
1351
|
+
#获取应用触发器详情
|
1352
|
+
result = api_instance.app_trigger(app)
|
1353
|
+
p result
|
1354
|
+
rescue IndexeaClient::ApiError => e
|
1355
|
+
puts "Exception when calling AppsApi->app_trigger: #{e}"
|
1356
|
+
end
|
1357
|
+
```
|
1358
|
+
|
1359
|
+
### Parameters
|
1360
|
+
|
1361
|
+
Name | Type | Description | Notes
|
1362
|
+
------------- | ------------- | ------------- | -------------
|
1363
|
+
**app** | **String**| 应用标识 |
|
1364
|
+
|
1365
|
+
### Return type
|
1366
|
+
|
1367
|
+
[**TriggerBean**](TriggerBean.md)
|
1368
|
+
|
1369
|
+
### Authorization
|
1370
|
+
|
1371
|
+
[TokenAuth](../README.md#TokenAuth)
|
1372
|
+
|
1373
|
+
### HTTP request headers
|
1374
|
+
|
1375
|
+
- **Content-Type**: Not defined
|
1376
|
+
- **Accept**: application/json
|
1377
|
+
|
1378
|
+
|
1379
|
+
|
1380
|
+
# **app_trigger_logs**
|
1381
|
+
> Array<TriggerLogBean> app_trigger_logs(app, id, size)
|
1382
|
+
|
1383
|
+
获取应用触发日志列表
|
1384
|
+
|
1385
|
+
### Example
|
1386
|
+
```ruby
|
1387
|
+
# load the gem
|
1388
|
+
require 'indexea_client'
|
1389
|
+
# setup authorization
|
1390
|
+
IndexeaClient.configure do |config|
|
1391
|
+
end
|
1392
|
+
|
1393
|
+
api_instance = IndexeaClient::AppsApi.new
|
1394
|
+
app = 'app_example' # String | 应用标识
|
1395
|
+
id = 999999999 # Integer | 起始日志编号
|
1396
|
+
size = 20 # Integer | 日志数
|
1397
|
+
|
1398
|
+
|
1399
|
+
begin
|
1400
|
+
#获取应用触发日志列表
|
1401
|
+
result = api_instance.app_trigger_logs(app, id, size)
|
1402
|
+
p result
|
1403
|
+
rescue IndexeaClient::ApiError => e
|
1404
|
+
puts "Exception when calling AppsApi->app_trigger_logs: #{e}"
|
1405
|
+
end
|
1406
|
+
```
|
1407
|
+
|
1408
|
+
### Parameters
|
1409
|
+
|
1410
|
+
Name | Type | Description | Notes
|
1411
|
+
------------- | ------------- | ------------- | -------------
|
1412
|
+
**app** | **String**| 应用标识 |
|
1413
|
+
**id** | **Integer**| 起始日志编号 | [default to 999999999]
|
1414
|
+
**size** | **Integer**| 日志数 | [default to 20]
|
1415
|
+
|
1416
|
+
### Return type
|
1417
|
+
|
1418
|
+
[**Array<TriggerLogBean>**](TriggerLogBean.md)
|
1419
|
+
|
1420
|
+
### Authorization
|
1421
|
+
|
1422
|
+
[TokenAuth](../README.md#TokenAuth)
|
1423
|
+
|
1424
|
+
### HTTP request headers
|
1425
|
+
|
1426
|
+
- **Content-Type**: Not defined
|
1427
|
+
- **Accept**: application/json
|
1428
|
+
|
1429
|
+
|
1430
|
+
|
1431
|
+
# **app_update**
|
1432
|
+
> AppBean app_update(app, opts)
|
1433
|
+
|
1434
|
+
修改应用的基本信息
|
1435
|
+
|
1436
|
+
### Example
|
1437
|
+
```ruby
|
1438
|
+
# load the gem
|
1439
|
+
require 'indexea_client'
|
1440
|
+
# setup authorization
|
1441
|
+
IndexeaClient.configure do |config|
|
1442
|
+
end
|
1443
|
+
|
1444
|
+
api_instance = IndexeaClient::AppsApi.new
|
1445
|
+
app = 'app_example' # String | 应用标识
|
1446
|
+
opts = {
|
1447
|
+
name: 'name_example' # String |
|
1448
|
+
intro: 'intro_example' # String |
|
1449
|
+
}
|
1450
|
+
|
1451
|
+
begin
|
1452
|
+
#修改应用的基本信息
|
1453
|
+
result = api_instance.app_update(app, opts)
|
1454
|
+
p result
|
1455
|
+
rescue IndexeaClient::ApiError => e
|
1456
|
+
puts "Exception when calling AppsApi->app_update: #{e}"
|
1457
|
+
end
|
1458
|
+
```
|
1459
|
+
|
1460
|
+
### Parameters
|
1461
|
+
|
1462
|
+
Name | Type | Description | Notes
|
1463
|
+
------------- | ------------- | ------------- | -------------
|
1464
|
+
**app** | **String**| 应用标识 |
|
1465
|
+
**name** | **String**| | [optional]
|
1466
|
+
**intro** | **String**| | [optional]
|
1467
|
+
|
1468
|
+
### Return type
|
1469
|
+
|
1470
|
+
[**AppBean**](AppBean.md)
|
1471
|
+
|
1472
|
+
### Authorization
|
1473
|
+
|
1474
|
+
[TokenAuth](../README.md#TokenAuth)
|
1475
|
+
|
1476
|
+
### HTTP request headers
|
1477
|
+
|
1478
|
+
- **Content-Type**: application/x-www-form-urlencoded
|
1479
|
+
- **Accept**: application/json
|
1480
|
+
|
1481
|
+
|
1482
|
+
|
1483
|
+
# **app_update_access_token**
|
1484
|
+
> TokenBean app_update_access_token(bodyapp)
|
1485
|
+
|
1486
|
+
修改 Access Token
|
1487
|
+
|
1488
|
+
### Example
|
1489
|
+
```ruby
|
1490
|
+
# load the gem
|
1491
|
+
require 'indexea_client'
|
1492
|
+
# setup authorization
|
1493
|
+
IndexeaClient.configure do |config|
|
1494
|
+
end
|
1495
|
+
|
1496
|
+
api_instance = IndexeaClient::AppsApi.new
|
1497
|
+
body = IndexeaClient::TokenBean.new # TokenBean |
|
1498
|
+
app = 'app_example' # String | 应用标识
|
1499
|
+
|
1500
|
+
|
1501
|
+
begin
|
1502
|
+
#修改 Access Token
|
1503
|
+
result = api_instance.app_update_access_token(bodyapp)
|
1504
|
+
p result
|
1505
|
+
rescue IndexeaClient::ApiError => e
|
1506
|
+
puts "Exception when calling AppsApi->app_update_access_token: #{e}"
|
1507
|
+
end
|
1508
|
+
```
|
1509
|
+
|
1510
|
+
### Parameters
|
1511
|
+
|
1512
|
+
Name | Type | Description | Notes
|
1513
|
+
------------- | ------------- | ------------- | -------------
|
1514
|
+
**body** | [**TokenBean**](TokenBean.md)| |
|
1515
|
+
**app** | **String**| 应用标识 |
|
1516
|
+
|
1517
|
+
### Return type
|
1518
|
+
|
1519
|
+
[**TokenBean**](TokenBean.md)
|
1520
|
+
|
1521
|
+
### Authorization
|
1522
|
+
|
1523
|
+
[TokenAuth](../README.md#TokenAuth)
|
1524
|
+
|
1525
|
+
### HTTP request headers
|
1526
|
+
|
1527
|
+
- **Content-Type**: application/json
|
1528
|
+
- **Accept**: application/json
|
1529
|
+
|
1530
|
+
|
1531
|
+
|
1532
|
+
# **app_update_mentor**
|
1533
|
+
> BOOLEAN app_update_mentor(app, account, name, scopes)
|
1534
|
+
|
1535
|
+
修改成员备注和权限
|
1536
|
+
|
1537
|
+
### Example
|
1538
|
+
```ruby
|
1539
|
+
# load the gem
|
1540
|
+
require 'indexea_client'
|
1541
|
+
# setup authorization
|
1542
|
+
IndexeaClient.configure do |config|
|
1543
|
+
end
|
1544
|
+
|
1545
|
+
api_instance = IndexeaClient::AppsApi.new
|
1546
|
+
app = 'app_example' # String | 应用标识
|
1547
|
+
account = 56 # Integer | 成员编号
|
1548
|
+
name = 'name_example' # String | 备注名称
|
1549
|
+
scopes = 'scopes_example' # String | 权限
|
1550
|
+
|
1551
|
+
|
1552
|
+
begin
|
1553
|
+
#修改成员备注和权限
|
1554
|
+
result = api_instance.app_update_mentor(app, account, name, scopes)
|
1555
|
+
p result
|
1556
|
+
rescue IndexeaClient::ApiError => e
|
1557
|
+
puts "Exception when calling AppsApi->app_update_mentor: #{e}"
|
1558
|
+
end
|
1559
|
+
```
|
1560
|
+
|
1561
|
+
### Parameters
|
1562
|
+
|
1563
|
+
Name | Type | Description | Notes
|
1564
|
+
------------- | ------------- | ------------- | -------------
|
1565
|
+
**app** | **String**| 应用标识 |
|
1566
|
+
**account** | **Integer**| 成员编号 |
|
1567
|
+
**name** | **String**| 备注名称 |
|
1568
|
+
**scopes** | **String**| 权限 |
|
1569
|
+
|
1570
|
+
### Return type
|
1571
|
+
|
1572
|
+
**BOOLEAN**
|
1573
|
+
|
1574
|
+
### Authorization
|
1575
|
+
|
1576
|
+
[TokenAuth](../README.md#TokenAuth)
|
1577
|
+
|
1578
|
+
### HTTP request headers
|
1579
|
+
|
1580
|
+
- **Content-Type**: Not defined
|
1581
|
+
- **Accept**: application/json
|
1582
|
+
|
1583
|
+
|
1584
|
+
|
1585
|
+
# **app_update_mentor_options**
|
1586
|
+
> BOOLEAN app_update_mentor_options(app, opts)
|
1587
|
+
|
1588
|
+
修改应用成员自身的设置(包括应用名备注,是否接收报告等)
|
1589
|
+
|
1590
|
+
### Example
|
1591
|
+
```ruby
|
1592
|
+
# load the gem
|
1593
|
+
require 'indexea_client'
|
1594
|
+
# setup authorization
|
1595
|
+
IndexeaClient.configure do |config|
|
1596
|
+
end
|
1597
|
+
|
1598
|
+
api_instance = IndexeaClient::AppsApi.new
|
1599
|
+
app = 'app_example' # String | 应用标识
|
1600
|
+
opts = {
|
1601
|
+
name: 'name_example', # String | 应用备注名称,如果不填写则使用默认名称
|
1602
|
+
report: false # BOOLEAN | 是否接收使用情况报告
|
1603
|
+
}
|
1604
|
+
|
1605
|
+
begin
|
1606
|
+
#修改应用成员自身的设置(包括应用名备注,是否接收报告等)
|
1607
|
+
result = api_instance.app_update_mentor_options(app, opts)
|
1608
|
+
p result
|
1609
|
+
rescue IndexeaClient::ApiError => e
|
1610
|
+
puts "Exception when calling AppsApi->app_update_mentor_options: #{e}"
|
1611
|
+
end
|
1612
|
+
```
|
1613
|
+
|
1614
|
+
### Parameters
|
1615
|
+
|
1616
|
+
Name | Type | Description | Notes
|
1617
|
+
------------- | ------------- | ------------- | -------------
|
1618
|
+
**app** | **String**| 应用标识 |
|
1619
|
+
**name** | **String**| 应用备注名称,如果不填写则使用默认名称 | [optional]
|
1620
|
+
**report** | **BOOLEAN**| 是否接收使用情况报告 | [optional] [default to false]
|
1621
|
+
|
1622
|
+
### Return type
|
1623
|
+
|
1624
|
+
**BOOLEAN**
|
1625
|
+
|
1626
|
+
### Authorization
|
1627
|
+
|
1628
|
+
[TokenAuth](../README.md#TokenAuth)
|
1629
|
+
|
1630
|
+
### HTTP request headers
|
1631
|
+
|
1632
|
+
- **Content-Type**: Not defined
|
1633
|
+
- **Accept**: application/json
|
1634
|
+
|
1635
|
+
|
1636
|
+
|
1637
|
+
# **app_update_mentor_report_options**
|
1638
|
+
> BOOLEAN app_update_mentor_report_options(keytypevaluevcodeapp)
|
1639
|
+
|
1640
|
+
修改应用成员自身的通知设置
|
1641
|
+
|
1642
|
+
### Example
|
1643
|
+
```ruby
|
1644
|
+
# load the gem
|
1645
|
+
require 'indexea_client'
|
1646
|
+
# setup authorization
|
1647
|
+
IndexeaClient.configure do |config|
|
1648
|
+
end
|
1649
|
+
|
1650
|
+
api_instance = IndexeaClient::AppsApi.new
|
1651
|
+
key = 'key_example' # String |
|
1652
|
+
type = 'type_example' # String |
|
1653
|
+
value = 'value_example' # String |
|
1654
|
+
vcode = 'vcode_example' # String |
|
1655
|
+
app = 'app_example' # String | 应用标识
|
1656
|
+
|
1657
|
+
|
1658
|
+
begin
|
1659
|
+
#修改应用成员自身的通知设置
|
1660
|
+
result = api_instance.app_update_mentor_report_options(keytypevaluevcodeapp)
|
1661
|
+
p result
|
1662
|
+
rescue IndexeaClient::ApiError => e
|
1663
|
+
puts "Exception when calling AppsApi->app_update_mentor_report_options: #{e}"
|
1664
|
+
end
|
1665
|
+
```
|
1666
|
+
|
1667
|
+
### Parameters
|
1668
|
+
|
1669
|
+
Name | Type | Description | Notes
|
1670
|
+
------------- | ------------- | ------------- | -------------
|
1671
|
+
**key** | **String**| |
|
1672
|
+
**type** | **String**| |
|
1673
|
+
**value** | **String**| |
|
1674
|
+
**vcode** | **String**| |
|
1675
|
+
**app** | **String**| 应用标识 |
|
1676
|
+
|
1677
|
+
### Return type
|
1678
|
+
|
1679
|
+
**BOOLEAN**
|
1680
|
+
|
1681
|
+
### Authorization
|
1682
|
+
|
1683
|
+
[TokenAuth](../README.md#TokenAuth)
|
1684
|
+
|
1685
|
+
### HTTP request headers
|
1686
|
+
|
1687
|
+
- **Content-Type**: application/x-www-form-urlencoded
|
1688
|
+
- **Accept**: application/json
|
1689
|
+
|
1690
|
+
|
1691
|
+
|
1692
|
+
# **app_update_oauth_app**
|
1693
|
+
> OauthAppBean app_update_oauth_app(bodyapp)
|
1694
|
+
|
1695
|
+
修改第三方应用信息
|
1696
|
+
|
1697
|
+
### Example
|
1698
|
+
```ruby
|
1699
|
+
# load the gem
|
1700
|
+
require 'indexea_client'
|
1701
|
+
# setup authorization
|
1702
|
+
IndexeaClient.configure do |config|
|
1703
|
+
end
|
1704
|
+
|
1705
|
+
api_instance = IndexeaClient::AppsApi.new
|
1706
|
+
body = IndexeaClient::OauthAppBean.new # OauthAppBean |
|
1707
|
+
app = 'app_example' # String | 应用标识
|
1708
|
+
|
1709
|
+
|
1710
|
+
begin
|
1711
|
+
#修改第三方应用信息
|
1712
|
+
result = api_instance.app_update_oauth_app(bodyapp)
|
1713
|
+
p result
|
1714
|
+
rescue IndexeaClient::ApiError => e
|
1715
|
+
puts "Exception when calling AppsApi->app_update_oauth_app: #{e}"
|
1716
|
+
end
|
1717
|
+
```
|
1718
|
+
|
1719
|
+
### Parameters
|
1720
|
+
|
1721
|
+
Name | Type | Description | Notes
|
1722
|
+
------------- | ------------- | ------------- | -------------
|
1723
|
+
**body** | [**OauthAppBean**](OauthAppBean.md)| |
|
1724
|
+
**app** | **String**| 应用标识 |
|
1725
|
+
|
1726
|
+
### Return type
|
1727
|
+
|
1728
|
+
[**OauthAppBean**](OauthAppBean.md)
|
1729
|
+
|
1730
|
+
### Authorization
|
1731
|
+
|
1732
|
+
[TokenAuth](../README.md#TokenAuth)
|
1733
|
+
|
1734
|
+
### HTTP request headers
|
1735
|
+
|
1736
|
+
- **Content-Type**: application/json
|
1737
|
+
- **Accept**: application/json
|
1738
|
+
|
1739
|
+
|
1740
|
+
|
1741
|
+
# **app_update_oauth_app_logo**
|
1742
|
+
> OauthAppBean app_update_oauth_app_logo(identapp, opts)
|
1743
|
+
|
1744
|
+
修改三方应用图标
|
1745
|
+
|
1746
|
+
### Example
|
1747
|
+
```ruby
|
1748
|
+
# load the gem
|
1749
|
+
require 'indexea_client'
|
1750
|
+
# setup authorization
|
1751
|
+
IndexeaClient.configure do |config|
|
1752
|
+
end
|
1753
|
+
|
1754
|
+
api_instance = IndexeaClient::AppsApi.new
|
1755
|
+
ident = 'ident_example' # String | 三方应用标识
|
1756
|
+
app = 'app_example' # String | 应用标识
|
1757
|
+
opts = {
|
1758
|
+
logo: 'logo_example' # String |
|
1759
|
+
}
|
1760
|
+
|
1761
|
+
begin
|
1762
|
+
#修改三方应用图标
|
1763
|
+
result = api_instance.app_update_oauth_app_logo(identapp, opts)
|
1764
|
+
p result
|
1765
|
+
rescue IndexeaClient::ApiError => e
|
1766
|
+
puts "Exception when calling AppsApi->app_update_oauth_app_logo: #{e}"
|
1767
|
+
end
|
1768
|
+
```
|
1769
|
+
|
1770
|
+
### Parameters
|
1771
|
+
|
1772
|
+
Name | Type | Description | Notes
|
1773
|
+
------------- | ------------- | ------------- | -------------
|
1774
|
+
**ident** | **String**| 三方应用标识 |
|
1775
|
+
**app** | **String**| 应用标识 |
|
1776
|
+
**logo** | **String**| | [optional]
|
1777
|
+
|
1778
|
+
### Return type
|
1779
|
+
|
1780
|
+
[**OauthAppBean**](OauthAppBean.md)
|
1781
|
+
|
1782
|
+
### Authorization
|
1783
|
+
|
1784
|
+
[TokenAuth](../README.md#TokenAuth)
|
1785
|
+
|
1786
|
+
### HTTP request headers
|
1787
|
+
|
1788
|
+
- **Content-Type**: multipart/form-data
|
1789
|
+
- **Accept**: application/json
|
1790
|
+
|
1791
|
+
|
1792
|
+
|
1793
|
+
# **app_update_status**
|
1794
|
+
> BOOLEAN app_update_status(app, vcode, status)
|
1795
|
+
|
1796
|
+
修改应用的状态
|
1797
|
+
|
1798
|
+
### Example
|
1799
|
+
```ruby
|
1800
|
+
# load the gem
|
1801
|
+
require 'indexea_client'
|
1802
|
+
# setup authorization
|
1803
|
+
IndexeaClient.configure do |config|
|
1804
|
+
end
|
1805
|
+
|
1806
|
+
api_instance = IndexeaClient::AppsApi.new
|
1807
|
+
app = 'app_example' # String | 应用标识
|
1808
|
+
vcode = 'vcode_example' # String | 验证码
|
1809
|
+
status = 56 # Integer | 新状态
|
1810
|
+
|
1811
|
+
|
1812
|
+
begin
|
1813
|
+
#修改应用的状态
|
1814
|
+
result = api_instance.app_update_status(app, vcode, status)
|
1815
|
+
p result
|
1816
|
+
rescue IndexeaClient::ApiError => e
|
1817
|
+
puts "Exception when calling AppsApi->app_update_status: #{e}"
|
1818
|
+
end
|
1819
|
+
```
|
1820
|
+
|
1821
|
+
### Parameters
|
1822
|
+
|
1823
|
+
Name | Type | Description | Notes
|
1824
|
+
------------- | ------------- | ------------- | -------------
|
1825
|
+
**app** | **String**| 应用标识 |
|
1826
|
+
**vcode** | **String**| 验证码 |
|
1827
|
+
**status** | **Integer**| 新状态 |
|
1828
|
+
|
1829
|
+
### Return type
|
1830
|
+
|
1831
|
+
**BOOLEAN**
|
1832
|
+
|
1833
|
+
### Authorization
|
1834
|
+
|
1835
|
+
[TokenAuth](../README.md#TokenAuth)
|
1836
|
+
|
1837
|
+
### HTTP request headers
|
1838
|
+
|
1839
|
+
- **Content-Type**: Not defined
|
1840
|
+
- **Accept**: application/json
|
1841
|
+
|
1842
|
+
|
1843
|
+
|