# indexea-java-sdk

**Repository Path**: indexea/indexea-java-sdk

## Basic Information

- **Project Name**: indexea-java-sdk
- **Description**: Indexea Java SDK
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2022-10-19
- **Last Updated**: 2024-06-13

## Categories & Tags

**Categories**: search-engine

**Tags**: None

## README

# indexea-java-sdk

Indexea OpenAPI
- API version: 1.0.0
  - Build date: 2023-06-16T16:42:33.863722700+08:00[Asia/Shanghai]

OpenAPI of Indexea

  For more information, please visit [https://indexea.com/support](https://indexea.com/support)

*Automatically generated by the [OpenAPI Generator](https://openapi-generator.tech)*


## Requirements

Building the API client library requires:
1. Java 1.8+
2. Maven (3.8.3+)/Gradle (7.2+)

## Installation

To install the API client library to your local Maven repository, simply execute:

```shell
mvn clean install
```

To deploy it to a remote Maven repository instead, configure the settings of the repository and execute:

```shell
mvn clean deploy
```

Refer to the [OSSRH Guide](http://central.sonatype.org/pages/ossrh-guide.html) for more information.

### Maven users

Add this dependency to your project's POM:

```xml
<dependency>
  <groupId>com.indexea.openapi</groupId>
  <artifactId>indexea-java-sdk</artifactId>
  <version>1.0-dev</version>
  <scope>compile</scope>
</dependency>
```

### Gradle users

Add this dependency to your project's build file:

```groovy
  repositories {
    mavenCentral()     // Needed if the 'indexea-java-sdk' jar has been published to maven central.
    mavenLocal()       // Needed if the 'indexea-java-sdk' jar has been published to the local maven repo.
  }

  dependencies {
     implementation "com.indexea.openapi:indexea-java-sdk:1.0-dev"
  }
```

### Others

At first generate the JAR by executing:

```shell
mvn clean package
```

Then manually install the following JARs:

* `target/indexea-java-sdk-1.0-dev.jar`
* `target/lib/*.jar`

## Getting Started

Please follow the [installation](#installation) instruction and execute the following Java code:

```java

// Import classes:
import com.indexea.openapi.ApiClient;
import com.indexea.openapi.ApiException;
import com.indexea.openapi.Configuration;
import com.indexea.openapi.auth.*;
import com.indexea.openapi.models.*;
import com.indexea.openapi.client.AccountApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://api.indexea.com/v1");
    
    // Configure HTTP bearer authorization: TokenAuth
    HttpBearerAuth TokenAuth = (HttpBearerAuth) defaultClient.getAuthentication("TokenAuth");
    TokenAuth.setBearerToken("BEARER TOKEN");

    AccountApi apiInstance = new AccountApi(defaultClient);
    String pwd = "pwd_example"; // String | 操作者的登录密码
    String vcode = "vcode_example"; // String | 操作验证码
    try {
      Boolean result = apiInstance.accountDelete(pwd, vcode);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling AccountApi#accountDelete");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

```

## Documentation for API Endpoints

All URIs are relative to *https://api.indexea.com/v1*

Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
*AccountApi* | [**accountDelete**](docs/AccountApi.md#accountDelete) | **DELETE** /account/profile | 注销账号
*AccountApi* | [**accountDeleteOpenid**](docs/AccountApi.md#accountDeleteOpenid) | **DELETE** /account/openid | 解绑三方账号
*AccountApi* | [**accountOpenid**](docs/AccountApi.md#accountOpenid) | **GET** /account/openid | 获取绑定的所有三方账号
*AccountApi* | [**accountPasswd**](docs/AccountApi.md#accountPasswd) | **POST** /account/passwd | 修改账号密码
*AccountApi* | [**accountPortrait**](docs/AccountApi.md#accountPortrait) | **POST** /account/portrait | 修改账号头像
*AccountApi* | [**accountProfile**](docs/AccountApi.md#accountProfile) | **GET** /account/profile | 获取登录账号信息
*AccountApi* | [**accountResetPwd**](docs/AccountApi.md#accountResetPwd) | **POST** /account/reset-pwd | 重置账号密码
*AccountApi* | [**accountSendVerifyCode**](docs/AccountApi.md#accountSendVerifyCode) | **GET** /account/send-verify-code | 发送账号验证码
*AccountApi* | [**accountSignin**](docs/AccountApi.md#accountSignin) | **POST** /account/signin | 登录系统
*AccountApi* | [**accountSignout**](docs/AccountApi.md#accountSignout) | **POST** /account/sign-out | 退出登录状态
*AccountApi* | [**accountSignup**](docs/AccountApi.md#accountSignup) | **POST** /account/signup | 注册新账号
*AccountApi* | [**accountUpdate**](docs/AccountApi.md#accountUpdate) | **POST** /account/profile | 修改账号资料
*AccountApi* | [**accountUpdateSettings**](docs/AccountApi.md#accountUpdateSettings) | **POST** /account/settings | 修改账号设置
*AppsApi* | [**appAddMentor**](docs/AppsApi.md#appAddMentor) | **POST** /apps/{app}/mentors | 添加应用成员
*AppsApi* | [**appBlacklist**](docs/AppsApi.md#appBlacklist) | **GET** /apps/{app}/blacklist | 获取黑名单信息
*AppsApi* | [**appCreate**](docs/AppsApi.md#appCreate) | **POST** /apps | 创建应用
*AppsApi* | [**appCreateAccessToken**](docs/AppsApi.md#appCreateAccessToken) | **POST** /apps/{app}/tokens | 创建 Access Token
*AppsApi* | [**appCreateOauthApp**](docs/AppsApi.md#appCreateOauthApp) | **POST** /apps/{app}/oauth | 创建第三方应用
*AppsApi* | [**appDelete**](docs/AppsApi.md#appDelete) | **DELETE** /apps/{app} | 删除应用
*AppsApi* | [**appDeleteAccessToken**](docs/AppsApi.md#appDeleteAccessToken) | **DELETE** /apps/{app}/tokens | 删除 Access Token
*AppsApi* | [**appDeleteMentor**](docs/AppsApi.md#appDeleteMentor) | **DELETE** /apps/{app}/mentors | 删除应用成员
*AppsApi* | [**appDeleteOauthApp**](docs/AppsApi.md#appDeleteOauthApp) | **DELETE** /apps/{app}/oauth | 删除第三方应用
*AppsApi* | [**appExcelOfLogs**](docs/AppsApi.md#appExcelOfLogs) | **GET** /apps/{app}/logs | 导出应用日志到 Excel
*AppsApi* | [**appGet**](docs/AppsApi.md#appGet) | **GET** /apps/{app} | 获取应用详情
*AppsApi* | [**appGetCompany**](docs/AppsApi.md#appGetCompany) | **POST** /apps/{app}/company | 获取应用填写的公司信息
*AppsApi* | [**appGetCompanyPic**](docs/AppsApi.md#appGetCompanyPic) | **GET** /apps/{app}/company | 获取公司营业执照或者一般纳税人证明
*AppsApi* | [**appList**](docs/AppsApi.md#appList) | **GET** /apps | 获取应用列表
*AppsApi* | [**appListMentors**](docs/AppsApi.md#appListMentors) | **GET** /apps/{app}/mentors | 获取应用成员列表
*AppsApi* | [**appListOauthApps**](docs/AppsApi.md#appListOauthApps) | **GET** /apps/{app}/oauth | 获取第三方应用列表
*AppsApi* | [**appLogs**](docs/AppsApi.md#appLogs) | **POST** /apps/{app}/logs | 获取应用的日志列表
*AppsApi* | [**appResetAccessToken**](docs/AppsApi.md#appResetAccessToken) | **PATCH** /apps/{app}/tokens | 重置 Access Token
*AppsApi* | [**appResetOauthAppSecret**](docs/AppsApi.md#appResetOauthAppSecret) | **POST** /apps/{app}/oauth-reset-secret | 重新生成三方应用的密钥
*AppsApi* | [**appSaveBlacklist**](docs/AppsApi.md#appSaveBlacklist) | **PUT** /apps/{app}/blacklist | 修改应用的黑名单信息
*AppsApi* | [**appSaveCompany**](docs/AppsApi.md#appSaveCompany) | **PUT** /apps/{app}/company | 修改应用的公司信息
*AppsApi* | [**appSearchsEstimate**](docs/AppsApi.md#appSearchsEstimate) | **GET** /apps/{app}/searchs-estimate | 获取搜索流量包使用配额信息
*AppsApi* | [**appSetTrigger**](docs/AppsApi.md#appSetTrigger) | **PUT** /apps/{app}/trigger | 修改应用的触发器信息
*AppsApi* | [**appTokens**](docs/AppsApi.md#appTokens) | **GET** /apps/{app}/tokens | 获取 Access Token 列表
*AppsApi* | [**appTransfer**](docs/AppsApi.md#appTransfer) | **POST** /apps/{app}/transfer | 转让应用给他人
*AppsApi* | [**appTrigger**](docs/AppsApi.md#appTrigger) | **GET** /apps/{app}/trigger | 获取应用触发器详情
*AppsApi* | [**appTriggerLogs**](docs/AppsApi.md#appTriggerLogs) | **GET** /apps/{app}/trigger-logs | 获取应用触发日志列表
*AppsApi* | [**appUpdate**](docs/AppsApi.md#appUpdate) | **PUT** /apps/{app} | 修改应用的基本信息
*AppsApi* | [**appUpdateAccessToken**](docs/AppsApi.md#appUpdateAccessToken) | **PUT** /apps/{app}/tokens | 修改 Access Token
*AppsApi* | [**appUpdateMentor**](docs/AppsApi.md#appUpdateMentor) | **PATCH** /apps/{app}/mentors | 修改成员备注和权限
*AppsApi* | [**appUpdateMentorOptions**](docs/AppsApi.md#appUpdateMentorOptions) | **POST** /apps/{app}/mentors-options | 修改应用成员自身的设置（包括应用名备注，是否接收报告等）
*AppsApi* | [**appUpdateMentorReportOptions**](docs/AppsApi.md#appUpdateMentorReportOptions) | **PATCH** /apps/{app}/mentors-options | 修改应用成员自身的通知设置
*AppsApi* | [**appUpdateOauthApp**](docs/AppsApi.md#appUpdateOauthApp) | **PATCH** /apps/{app}/oauth | 修改第三方应用信息
*AppsApi* | [**appUpdateOauthAppLogo**](docs/AppsApi.md#appUpdateOauthAppLogo) | **PUT** /apps/{app}/oauth | 修改三方应用图标
*AppsApi* | [**appUpdateStatus**](docs/AppsApi.md#appUpdateStatus) | **PATCH** /apps/{app} | 修改应用的状态
*FieldsApi* | [**indexFields**](docs/FieldsApi.md#indexFields) | **GET** /indices/{app}/{index}/fields | 获取索引字段映射详情
*FieldsApi* | [**indexUpdateFields**](docs/FieldsApi.md#indexUpdateFields) | **POST** /indices/{app}/{index}/fields | 更新索引的字段映射
*FieldsApi* | [**indexValuesOfField**](docs/FieldsApi.md#indexValuesOfField) | **GET** /indices/{app}/{index}/fields/{field} | 获取索引字段的所有值列表
*GlobalApi* | [**json**](docs/GlobalApi.md#json) | **GET** /json | 接口定义(JSON)
*GlobalApi* | [**optionsGet**](docs/GlobalApi.md#optionsGet) | **GET** /options | 系统全局配置接口
*GlobalApi* | [**welcome**](docs/GlobalApi.md#welcome) | **GET** / | 接口欢迎信息
*GlobalApi* | [**yaml**](docs/GlobalApi.md#yaml) | **GET** /yaml | 接口定义(YAML)
*IndicesApi* | [**indexAnalyze**](docs/IndicesApi.md#indexAnalyze) | **POST** /indices/{app}/{index}/analyze | 分词测试
*IndicesApi* | [**indexCleanup**](docs/IndicesApi.md#indexCleanup) | **POST** /indices/{app}/{index}/cleanup | 清空索引记录
*IndicesApi* | [**indexCopyTo**](docs/IndicesApi.md#indexCopyTo) | **POST** /indices/{app}/{index}/copyto | 导出索引数据
*IndicesApi* | [**indexCreate**](docs/IndicesApi.md#indexCreate) | **POST** /indices/{app} | 创建索引
*IndicesApi* | [**indexDelete**](docs/IndicesApi.md#indexDelete) | **DELETE** /indices/{app}/{index} | 删除索引
*IndicesApi* | [**indexExport**](docs/IndicesApi.md#indexExport) | **POST** /indices/{app}/{index}/export | 导出索引数据
*IndicesApi* | [**indexFlushSettings**](docs/IndicesApi.md#indexFlushSettings) | **PUT** /indices/{app}/{index}/settings | 写入设置信息到索引
*IndicesApi* | [**indexGet**](docs/IndicesApi.md#indexGet) | **GET** /indices/{app}/{index} | 获取单个索引详情
*IndicesApi* | [**indexGetFilterSettings**](docs/IndicesApi.md#indexGetFilterSettings) | **GET** /indices/{app}/{index}/filter-settings | 获取索引设置信息
*IndicesApi* | [**indexGetSettings**](docs/IndicesApi.md#indexGetSettings) | **GET** /indices/{app}/{index}/settings | 获取索引设置信息
*IndicesApi* | [**indexList**](docs/IndicesApi.md#indexList) | **GET** /indices/{app} | 获取应用的索引列表
*IndicesApi* | [**indexListTemplates**](docs/IndicesApi.md#indexListTemplates) | **GET** /templates | 获取模板列表
*IndicesApi* | [**indexRebuild**](docs/IndicesApi.md#indexRebuild) | **POST** /indices/{app}/{index}/rebuild | 重建索引数据
*IndicesApi* | [**indexRebuildTask**](docs/IndicesApi.md#indexRebuildTask) | **GET** /indices/{app}/{index}/rebuild | 获取重建索引任务的详情
*IndicesApi* | [**indexUpdate**](docs/IndicesApi.md#indexUpdate) | **PUT** /indices/{app}/{index} | 修改索引
*IndicesApi* | [**indexUpdateSettings**](docs/IndicesApi.md#indexUpdateSettings) | **POST** /indices/{app}/{index}/settings | 更新索引设置信息
*IndicesApi* | [**synonymsAdd**](docs/IndicesApi.md#synonymsAdd) | **POST** /indices/{app}/{index}/synonyms | 添加同义词
*IndicesApi* | [**synonymsDelete**](docs/IndicesApi.md#synonymsDelete) | **DELETE** /indices/{app}/{index}/synonyms | 删除同义词
*IndicesApi* | [**synonymsEnable**](docs/IndicesApi.md#synonymsEnable) | **PATCH** /indices/{app}/{index}/synonyms | 启用禁用同义词
*IndicesApi* | [**synonymsFlush**](docs/IndicesApi.md#synonymsFlush) | **POST** /indices/{app}/{index}/synonyms-flush | 将同义词更新到搜索引擎的同义词表
*IndicesApi* | [**synonymsImport**](docs/IndicesApi.md#synonymsImport) | **POST** /indices/{app}/{index}/synonyms-import | 导入同义词
*IndicesApi* | [**synonymsList**](docs/IndicesApi.md#synonymsList) | **GET** /indices/{app}/{index}/synonyms | 获取索引的所有同义词
*IndicesApi* | [**synonymsUpdate**](docs/IndicesApi.md#synonymsUpdate) | **PUT** /indices/{app}/{index}/synonyms | 修改同义词
*MessageApi* | [**messageDelete**](docs/MessageApi.md#messageDelete) | **DELETE** /accounts/message | 删除消息
*MessageApi* | [**messageFeedback**](docs/MessageApi.md#messageFeedback) | **POST** /accounts/feedback | 反馈意见
*MessageApi* | [**messageList**](docs/MessageApi.md#messageList) | **GET** /accounts/message | 获取我相关的消息信息，包括未读消息数量、最新消息等
*MessageApi* | [**messageRead**](docs/MessageApi.md#messageRead) | **PATCH** /accounts/message | 标识消息为已读
*MessageApi* | [**messageSend**](docs/MessageApi.md#messageSend) | **POST** /accounts/message | 发送消息
*PaymentApi* | [**paymentAlipay**](docs/PaymentApi.md#paymentAlipay) | **POST** /payment/alipay | 接受支付宝的支付结果
*PaymentApi* | [**paymentAlipayReturn**](docs/PaymentApi.md#paymentAlipayReturn) | **GET** /payment/alipay | 支付宝平台支付完毕后调整到该接口
*PaymentApi* | [**paymentBeginPay**](docs/PaymentApi.md#paymentBeginPay) | **POST** /payment/{app}/orders/{ident} | 支付订单
*PaymentApi* | [**paymentBuy**](docs/PaymentApi.md#paymentBuy) | **PUT** /payment/{app}/orders | 下单购买
*PaymentApi* | [**paymentDeleteOrder**](docs/PaymentApi.md#paymentDeleteOrder) | **DELETE** /payment/{app}/orders/{ident} | 取消订单
*PaymentApi* | [**paymentOrder**](docs/PaymentApi.md#paymentOrder) | **GET** /payment/{app}/orders/{ident} | 获取订单详情
*PaymentApi* | [**paymentOrders**](docs/PaymentApi.md#paymentOrders) | **POST** /payment/{app}/orders | 订单列表
*PaymentApi* | [**paymentPrice**](docs/PaymentApi.md#paymentPrice) | **GET** /payment/{app}/price | 获取套餐价格
*PaymentApi* | [**paymentReceipt**](docs/PaymentApi.md#paymentReceipt) | **GET** /payment/{app}/orders | 获取订单回执图片
*PaymentApi* | [**paymentRequestContact**](docs/PaymentApi.md#paymentRequestContact) | **POST** /payment/{app}/contact | 联系销售获取私有化报价
*PaymentApi* | [**paymentUploadReceipt**](docs/PaymentApi.md#paymentUploadReceipt) | **PUT** /payment/{app}/orders/{ident} | 上传转账回执
*PaymentApi* | [**paymentWepay**](docs/PaymentApi.md#paymentWepay) | **POST** /payment/wepay | 接受微信支付的支付结果
*QueriesApi* | [**queryCreate**](docs/QueriesApi.md#queryCreate) | **POST** /queries/{app} | 创建搜索
*QueriesApi* | [**queryCreateKeywordBindings**](docs/QueriesApi.md#queryCreateKeywordBindings) | **POST** /queries/{app}/keyword-bindings | 创建新的关键词文档绑定
*QueriesApi* | [**queryCreateVariable**](docs/QueriesApi.md#queryCreateVariable) | **POST** /queries/{app}/variables | 创建新的预定义查询变量
*QueriesApi* | [**queryDelete**](docs/QueriesApi.md#queryDelete) | **DELETE** /queries/{app} | 删除搜索
*QueriesApi* | [**queryDeleteKeywordBindings**](docs/QueriesApi.md#queryDeleteKeywordBindings) | **DELETE** /queries/{app}/keyword-bindings | 删除关键词文档绑定
*QueriesApi* | [**queryDeleteVariable**](docs/QueriesApi.md#queryDeleteVariable) | **DELETE** /queries/{app}/variables | 删除预定义查询变量
*QueriesApi* | [**queryFields**](docs/QueriesApi.md#queryFields) | **GET** /queries/{app}/fields | 获取查询关联的所有索引的字段信息
*QueriesApi* | [**queryGet**](docs/QueriesApi.md#queryGet) | **GET** /queries/{app}/{query} | 获取查询的详情
*QueriesApi* | [**queryGetRecord**](docs/QueriesApi.md#queryGetRecord) | **GET** /queries/{app}/record | 获取记录的详情
*QueriesApi* | [**queryKeywordBindings**](docs/QueriesApi.md#queryKeywordBindings) | **GET** /queries/{app}/keyword-bindings | 获取查询的关键词文档绑定列表
*QueriesApi* | [**queryList**](docs/QueriesApi.md#queryList) | **GET** /queries/{app} | 获取应用下所有索引下的查询列表（按索引进行分组）
*QueriesApi* | [**queryProfile**](docs/QueriesApi.md#queryProfile) | **GET** /queries/{app}/profiler | 获取搜索诊断信息
*QueriesApi* | [**queryRecordsOfKeywordBinding**](docs/QueriesApi.md#queryRecordsOfKeywordBinding) | **GET** /queries/{app}/keyword-bindings-records | 获取关键词绑定对应的记录列表
*QueriesApi* | [**querySaveIntelligentMappings**](docs/QueriesApi.md#querySaveIntelligentMappings) | **PUT** /queries/{app}/intelligent-mappings | 设置索引智能匹配字段
*QueriesApi* | [**querySearch**](docs/QueriesApi.md#querySearch) | **GET** /queries/{app}/search | 搜索测试
*QueriesApi* | [**querySource**](docs/QueriesApi.md#querySource) | **POST** /queries/{app}/{query} | 获取最终查询的源码(JSON)
*QueriesApi* | [**querySuggest**](docs/QueriesApi.md#querySuggest) | **GET** /queries/{app}/suggest | 获取搜索建议列表
*QueriesApi* | [**queryTestIntelligentMappings**](docs/QueriesApi.md#queryTestIntelligentMappings) | **POST** /queries/{app}/intelligent-mappings | 测试索引智能匹配字段
*QueriesApi* | [**queryUpdate**](docs/QueriesApi.md#queryUpdate) | **PUT** /queries/{app} | 修改查询
*QueriesApi* | [**queryUpdateKeywordBindings**](docs/QueriesApi.md#queryUpdateKeywordBindings) | **PATCH** /queries/{app}/keyword-bindings | 修改关键词文档绑定
*QueriesApi* | [**queryUpdateSettings**](docs/QueriesApi.md#queryUpdateSettings) | **POST** /queries/{app}/settings | 更改查询的设置项
*QueriesApi* | [**queryUpdateVariable**](docs/QueriesApi.md#queryUpdateVariable) | **PATCH** /queries/{app}/variables | 修改预定义查询变量
*QueriesApi* | [**queryValidate**](docs/QueriesApi.md#queryValidate) | **GET** /queries/{app}/validate | 获取搜索验证结果
*QueriesApi* | [**queryValidateAggregation**](docs/QueriesApi.md#queryValidateAggregation) | **POST** /queries/{app}/validate-aggregation | 验证聚合定义是否正确
*QueriesApi* | [**queryValidateQuery**](docs/QueriesApi.md#queryValidateQuery) | **POST** /queries/{app}/validate-query | 验证聚合定义是否正确
*QueriesApi* | [**queryValidateScriptField**](docs/QueriesApi.md#queryValidateScriptField) | **POST** /queries/{app}/validate-script-field | 验证脚本字段是否正确
*QueriesApi* | [**queryValidateScriptScore**](docs/QueriesApi.md#queryValidateScriptScore) | **POST** /queries/{app}/validate-script-score | 验证脚本字段是否正确
*QueriesApi* | [**queryValidateSuggestion**](docs/QueriesApi.md#queryValidateSuggestion) | **POST** /queries/{app}/validate-suggest | 验证建议是否正确
*QueriesApi* | [**queryVariables**](docs/QueriesApi.md#queryVariables) | **GET** /queries/{app}/variables | 获取应用的预定义查询变量列表
*RecommendApi* | [**recommendClick**](docs/RecommendApi.md#recommendClick) | **POST** /recommend/{ident}/click | 推荐结果点击行为收集
*RecommendApi* | [**recommendCreate**](docs/RecommendApi.md#recommendCreate) | **POST** /recommends/{app} | 创建新的推荐
*RecommendApi* | [**recommendDelete**](docs/RecommendApi.md#recommendDelete) | **DELETE** /recommends/{app} | 删除推荐
*RecommendApi* | [**recommendDetail**](docs/RecommendApi.md#recommendDetail) | **GET** /recommend/{ident} | 获取推荐的记录列表
*RecommendApi* | [**recommendFetch**](docs/RecommendApi.md#recommendFetch) | **POST** /recommend/{ident} | 获取推荐的记录列表
*RecommendApi* | [**recommendList**](docs/RecommendApi.md#recommendList) | **GET** /recommends/{app} | 获取已定义的推荐列表
*RecommendApi* | [**recommendUpdate**](docs/RecommendApi.md#recommendUpdate) | **PUT** /recommends/{app} | 更新推荐信息
*RecordsApi* | [**recordDelete**](docs/RecordsApi.md#recordDelete) | **DELETE** /records/{app}/{index} | 删除记录数据
*RecordsApi* | [**recordGet**](docs/RecordsApi.md#recordGet) | **GET** /records/{app}/{index} | 获取单条记录详情
*RecordsApi* | [**recordList**](docs/RecordsApi.md#recordList) | **POST** /records/{app}/{index} | 获取索引记录列表
*RecordsApi* | [**recordPush**](docs/RecordsApi.md#recordPush) | **PUT** /records/{app}/{index} | 插入或者更新索引数据
*RecordsApi* | [**recordUpload**](docs/RecordsApi.md#recordUpload) | **POST** /records/{app}/{index}/upload | 上传记录
*SearchApi* | [**searchClick**](docs/SearchApi.md#searchClick) | **POST** /search/widget/{widget}/click | 搜索结果点击行为收集
*SearchApi* | [**searchHistories**](docs/SearchApi.md#searchHistories) | **GET** /search/widget/{widget}/histories | 获取当前搜索用户的最新搜索记录
*SearchApi* | [**searchLogs**](docs/SearchApi.md#searchLogs) | **GET** /apps/{app}/logs-searchs | 获取搜索日志
*SearchApi* | [**searchQueryHotWords**](docs/SearchApi.md#searchQueryHotWords) | **GET** /search/query/{query}/hotwords | 获取查询相关热词
*SearchApi* | [**searchQuerySearch**](docs/SearchApi.md#searchQuerySearch) | **GET** /search/query/{query} | 基于查询的公开搜索
*SearchApi* | [**searchWidgetAutoComplete**](docs/SearchApi.md#searchWidgetAutoComplete) | **GET** /search/widget/{widget}/autocomplete | 基于组件的搜索词自动完成
*SearchApi* | [**searchWidgetHotWords**](docs/SearchApi.md#searchWidgetHotWords) | **GET** /search/widget/{widget}/hotwords | 获取组件搜索的相关热词
*SearchApi* | [**searchWidgetSearch**](docs/SearchApi.md#searchWidgetSearch) | **GET** /search/widget/{widget} | 基于组件的公开搜索
*StatsApi* | [**statsIndices**](docs/StatsApi.md#statsIndices) | **GET** /stats/{app}/indices/{index} | 获取索引统计列表
*StatsApi* | [**statsRecomms**](docs/StatsApi.md#statsRecomms) | **GET** /stats/{app}/recomms | 获取推荐日志的汇总信息
*StatsApi* | [**statsSearchs**](docs/StatsApi.md#statsSearchs) | **GET** /stats/{app}/searchs | 获取搜索日志的汇总信息
*StatsApi* | [**statsSearchsCount**](docs/StatsApi.md#statsSearchsCount) | **GET** /stats/{app}/searchs-count | 获取搜索访问次数统计
*StatsApi* | [**statsSearchsCounts**](docs/StatsApi.md#statsSearchsCounts) | **GET** /stats/{app}/searchs-counts | 获取多个对象的搜索访问次数统计
*StatsApi* | [**statsSearchsList**](docs/StatsApi.md#statsSearchsList) | **GET** /stats/{app}/searchs-list | 获取搜索访问次数详细列表
*StatsApi* | [**statsTopClicks**](docs/StatsApi.md#statsTopClicks) | **GET** /stats/{app}/top-clicks | 获取点击排行榜
*StatsApi* | [**statsWidgets**](docs/StatsApi.md#statsWidgets) | **GET** /stats/{app}/widgets | 获取模板与组件的统计信息
*WidgetsApi* | [**widgetCreate**](docs/WidgetsApi.md#widgetCreate) | **POST** /widgets/{app} | 创建组件
*WidgetsApi* | [**widgetDelete**](docs/WidgetsApi.md#widgetDelete) | **DELETE** /widgets/{app}/{widget} | 删除组件
*WidgetsApi* | [**widgetDetail**](docs/WidgetsApi.md#widgetDetail) | **GET** /widget/{ident} | 获取UI组件的所有相关信息
*WidgetsApi* | [**widgetDownload**](docs/WidgetsApi.md#widgetDownload) | **GET** /widgets/{app}/{widget}/download | 下载组件应用源码
*WidgetsApi* | [**widgetGet**](docs/WidgetsApi.md#widgetGet) | **GET** /widgets/{app}/{widget} | 获取组件的详情
*WidgetsApi* | [**widgetList**](docs/WidgetsApi.md#widgetList) | **GET** /widgets/{app} | 获取应用的组件列表
*WidgetsApi* | [**widgetLogo**](docs/WidgetsApi.md#widgetLogo) | **POST** /widgets/{app}/{widget}/logo | 设置组件 Logo
*WidgetsApi* | [**widgetUpdate**](docs/WidgetsApi.md#widgetUpdate) | **PUT** /widgets/{app}/{widget} | 修改组件
*WidgetsApi* | [**widgetUpdateSettings**](docs/WidgetsApi.md#widgetUpdateSettings) | **PATCH** /widgets/{app}/{widget} | 修改组件设置参数


## Documentation for Models

 - [AccountBean](docs/AccountBean.md)
 - [Analyze](docs/Analyze.md)
 - [AppBean](docs/AppBean.md)
 - [AppLogBean](docs/AppLogBean.md)
 - [AppLogsBean](docs/AppLogsBean.md)
 - [AppMentorBean](docs/AppMentorBean.md)
 - [AutoCompleteItem](docs/AutoCompleteItem.md)
 - [BlacklistBean](docs/BlacklistBean.md)
 - [CompanyBean](docs/CompanyBean.md)
 - [ContactForm](docs/ContactForm.md)
 - [GlobalOptionForm](docs/GlobalOptionForm.md)
 - [IndexBean](docs/IndexBean.md)
 - [IndexFieldBean](docs/IndexFieldBean.md)
 - [IndexForm](docs/IndexForm.md)
 - [IndexRebuildForm](docs/IndexRebuildForm.md)
 - [IndexSettings](docs/IndexSettings.md)
 - [IndexStatBean](docs/IndexStatBean.md)
 - [IndexTask](docs/IndexTask.md)
 - [IndexTemplate](docs/IndexTemplate.md)
 - [IntelligentMapping](docs/IntelligentMapping.md)
 - [KeywordBindingBean](docs/KeywordBindingBean.md)
 - [MentorForm](docs/MentorForm.md)
 - [Message](docs/Message.md)
 - [Messages](docs/Messages.md)
 - [OauthAppBean](docs/OauthAppBean.md)
 - [OpenidBean](docs/OpenidBean.md)
 - [PayResult](docs/PayResult.md)
 - [PaymentOrder](docs/PaymentOrder.md)
 - [PaymentRecord](docs/PaymentRecord.md)
 - [PaymentService](docs/PaymentService.md)
 - [QueryActionBean](docs/QueryActionBean.md)
 - [QueryBean](docs/QueryBean.md)
 - [QueryForm](docs/QueryForm.md)
 - [QuerySortField](docs/QuerySortField.md)
 - [QueryVariableBean](docs/QueryVariableBean.md)
 - [RecommendBean](docs/RecommendBean.md)
 - [RecordFilter](docs/RecordFilter.md)
 - [SearchEstimateResult](docs/SearchEstimateResult.md)
 - [SearchWord](docs/SearchWord.md)
 - [SearchsDailyStat](docs/SearchsDailyStat.md)
 - [StatIndexBean](docs/StatIndexBean.md)
 - [SynonymsBean](docs/SynonymsBean.md)
 - [TokenBean](docs/TokenBean.md)
 - [TriggerBean](docs/TriggerBean.md)
 - [TriggerLogBean](docs/TriggerLogBean.md)
 - [ValueOfField](docs/ValueOfField.md)
 - [WidgetBean](docs/WidgetBean.md)
 - [WidgetForm](docs/WidgetForm.md)
 - [WidgetStatusForm](docs/WidgetStatusForm.md)


## Documentation for Authorization

Authentication schemes defined for the API:
### TokenAuth

- **Type**: HTTP basic authentication


## Recommendation

It's recommended to create an instance of `ApiClient` per thread in a multithreaded environment to avoid any potential issues.

## Author

indexea.com@gmail.com