diff --git a/weixin-java-cp/src/main/java/com/tencent/wework/Finance.java b/weixin-java-cp/src/main/java/com/tencent/wework/Finance.java index ecc4e6aa9..b1cf36400 100644 --- a/weixin-java-cp/src/main/java/com/tencent/wework/Finance.java +++ b/weixin-java-cp/src/main/java/com/tencent/wework/Finance.java @@ -15,8 +15,7 @@ import java.util.List; * 官方文档： * https://developer.work.weixin.qq.com/document/path/91552 * - * @author Wang_Wong - * created on 2022-01-17 + * @author Wang_Wong created on 2022-01-17 */ @Slf4j public class Finance { @@ -26,130 +25,182 @@ public class Finance { private static final String SO_FILE = "so"; private static final String DLL_FILE = "dll"; - public native static long NewSdk(); + /** + * New sdk long. + * + * @return the long + */ + public native static long NewSdk(); - /** - * 初始化函数 - * Return值=0表示该API调用成功 - * - * @param [in] sdk NewSdk返回的sdk指针 - * @param [in] corpid 调用企业的企业id，例如：wwd08c8exxxx5ab44d，可以在企业微信管理端--我的企业--企业信息查看 - * @param [in] secret 聊天内容存档的Secret，可以在企业微信管理端--管理工具--聊天内容存档查看 - * @return 返回是否初始化成功 - * 0 - 成功 - * !=0 - 失败 - */ - public native static int Init(long sdk, String corpid, String secret); + /** + * 初始化函数 + * Return值=0表示该API调用成功 + * + * @param sdk the sdk + * @param corpid the corpid + * @param secret the secret + * @return 返回是否初始化成功 0 - 成功 !=0 - 失败 + */ + public native static int Init(long sdk, String corpid, String secret); - /** - * 拉取聊天记录函数 - * Return值=0表示该API调用成功 - * - * @param [in] sdk NewSdk返回的sdk指针 - * @param [in] seq 从指定的seq开始拉取消息，注意的是返回的消息从seq+1开始返回，seq为之前接口返回的最大seq值。首次使用请使用seq:0 - * @param [in] limit 一次拉取的消息条数，最大值1000条，超过1000条会返回错误 - * @param [in] proxy 使用代理的请求，需要传入代理的链接。如：socks5://10.0.0.1:8081 或者 http://10.0.0.1:8081 - * @param [in] passwd 代理账号密码，需要传入代理的账号密码。如 user_name:passwd_123 - * @param [out] chatDatas 返回本次拉取消息的数据，slice结构体.内容包括errcode/errmsg，以及每条消息内容。 - * @return 返回是否调用成功 - * 0 - 成功 - * !=0 - 失败 - */ - public native static int GetChatData(long sdk, long seq, long limit, String proxy, String passwd, long timeout, long chatData); + /** + * 拉取聊天记录函数 + * Return值=0表示该API调用成功 + * + * @param sdk the sdk + * @param seq the seq + * @param limit the limit + * @param proxy the proxy + * @param passwd the passwd + * @param timeout the timeout + * @param chatData the chat data + * @return 返回是否调用成功 0 - 成功 !=0 - 失败 + */ + public native static int GetChatData(long sdk, long seq, long limit, String proxy, String passwd, long timeout, long chatData); - /** - * 拉取媒体消息函数 - * Return值=0表示该API调用成功 - * - * @param [in] sdk NewSdk返回的sdk指针 - * @param [in] sdkFileid 从GetChatData返回的聊天消息中，媒体消息包括的sdkfileid - * @param [in] proxy 使用代理的请求，需要传入代理的链接。如：socks5://10.0.0.1:8081 或者 http://10.0.0.1:8081 - * @param [in] passwd 代理账号密码，需要传入代理的账号密码。如 user_name:passwd_123 - * @param [in] indexbuf 媒体消息分片拉取，需要填入每次拉取的索引信息。首次不需要填写，默认拉取512k，后续每次调用只需要将上次调用返回的outindexbuf填入即可。 - * @param [out] media_data 返回本次拉取的媒体数据.MediaData结构体.内容包括data(数据内容)/outindexbuf(下次索引)/is_finish(拉取完成标记) - * @return 返回是否调用成功 - * 0 - 成功 - * !=0 - 失败 - */ - public native static int GetMediaData(long sdk, String indexbuf, String sdkField, String proxy, String passwd, long timeout, long mediaData); + /** + * 拉取媒体消息函数 + * Return值=0表示该API调用成功 + * + * @param sdk the sdk + * @param indexbuf the indexbuf + * @param sdkField the sdk field + * @param proxy the proxy + * @param passwd the passwd + * @param timeout the timeout + * @param mediaData the media data + * @return 返回是否调用成功 0 - 成功 !=0 - 失败 + */ + public native static int GetMediaData(long sdk, String indexbuf, String sdkField, String proxy, String passwd, long timeout, long mediaData); - /** - * @param [in] encrypt_key, getchatdata返回的encrypt_key - * @param [in] encrypt_msg, getchatdata返回的content - * @param [out] msg, 解密的消息明文 - * @return 返回是否调用成功 - * 0 - 成功 - * !=0 - 失败 - * @brief 解析密文 - */ - public native static int DecryptData(long sdk, String encrypt_key, String encrypt_msg, long msg); + /** + * Decrypt data int. + * + * @param sdk the sdk + * @param encrypt_key the encrypt key + * @param encrypt_msg the encrypt msg + * @param msg the msg + * @return 返回是否调用成功 0 - 成功 !=0 - 失败 + * @brief 解析密文 + */ + public native static int DecryptData(long sdk, String encrypt_key, String encrypt_msg, long msg); - public native static void DestroySdk(long sdk); + /** + * Destroy sdk. + * + * @param sdk the sdk + */ + public native static void DestroySdk(long sdk); - public native static long NewSlice(); + /** + * New slice long. + * + * @return the long + */ + public native static long NewSlice(); - /** - * @return - * @brief 释放slice，和NewSlice成对使用 - */ - public native static void FreeSlice(long slice); + /** + * Free slice. + * + * @param slice the slice + * @return + * @brief 释放slice ，和NewSlice成对使用 + */ + public native static void FreeSlice(long slice); - /** - * @return 内容 - * @brief 获取slice内容 - */ - public native static String GetContentFromSlice(long slice); + /** + * Get content from slice string. + * + * @param slice the slice + * @return 内容 string + * @brief 获取slice内容 + */ + public native static String GetContentFromSlice(long slice); - /** - * @return 内容 - * @brief 获取slice内容长度 - */ - public native static int GetSliceLen(long slice); + /** + * Get slice len int. + * + * @param slice the slice + * @return 内容 int + * @brief 获取slice内容长度 + */ + public native static int GetSliceLen(long slice); - public native static long NewMediaData(); + /** + * New media data long. + * + * @return the long + */ + public native static long NewMediaData(); - public native static void FreeMediaData(long mediaData); + /** + * Free media data. + * + * @param mediaData the media data + */ + public native static void FreeMediaData(long mediaData); - /** - * @return outindex - * @brief 获取mediadata outindex - */ - public native static String GetOutIndexBuf(long mediaData); + /** + * Get out index buf string. + * + * @param mediaData the media data + * @return outindex string + * @brief 获取mediadata outindex + */ + public native static String GetOutIndexBuf(long mediaData); - /** - * @return data - * @brief 获取mediadata data数据 - */ - public native static byte[] GetData(long mediaData); + /** + * Get data byte [ ]. + * + * @param mediaData the media data + * @return data byte [ ] + * @brief 获取mediadata data数据 + */ + public native static byte[] GetData(long mediaData); - public native static int GetIndexLen(long mediaData); + /** + * Get index len int. + * + * @param mediaData the media data + * @return the int + */ + public native static int GetIndexLen(long mediaData); - public native static int GetDataLen(long mediaData); + /** + * Get data len int. + * + * @param mediaData the media data + * @return the int + */ + public native static int GetDataLen(long mediaData); - /** - * @return 1完成、0未完成 - * @brief 判断mediadata是否结束 - */ - public native static int IsMediaDataFinish(long mediaData); + /** + * Is media data finish int. + * + * @param mediaData the media data + * @return 1完成 、0未完成 + * @brief 判断mediadata是否结束 + */ + public native static int IsMediaDataFinish(long mediaData); - /** - * 判断Windows环境 - * - * @return - */ - public static boolean isWindows() { + /** + * 判断Windows环境 + * + * @return boolean + */ + public static boolean isWindows() { String osName = System.getProperties().getProperty("os.name"); log.info("Loading System Libraries, Current OS Version Is: {}", osName); return osName.toUpperCase().contains("WINDOWS"); } - /** - * 加载系统类库 - * - * @param libFiles 类库配置文件 - * @param prefixPath 类库文件的前缀路径 - */ - public Finance(List libFiles, String prefixPath) { + /** + * 加载系统类库 + * + * @param libFiles 类库配置文件 + * @param prefixPath 类库文件的前缀路径 + */ + public Finance(List libFiles, String prefixPath) { boolean isWindows = Finance.isWindows(); for (String file : libFiles) { String suffix = file.substring(file.lastIndexOf(".") + 1); @@ -168,14 +219,14 @@ public class Finance { } - /** - * 初始化类库文件 - * - * @param libFiles - * @param prefixPath - * @return - */ - public synchronized static Finance loadingLibraries(List libFiles, String prefixPath) { + /** + * 初始化类库文件 + * + * @param libFiles the lib files + * @param prefixPath the prefix path + * @return finance + */ + public synchronized static Finance loadingLibraries(List libFiles, String prefixPath) { if (finance != null) { return finance; } @@ -183,12 +234,12 @@ public class Finance { return finance; } - /** - * 单例sdk - * - * @return - */ - public synchronized static long SingletonSDK() { + /** + * 单例sdk + * + * @return long + */ + public synchronized static long SingletonSDK() { if (sdk > 0) { return sdk; } @@ -196,12 +247,13 @@ public class Finance { return sdk; } - /** - * 销毁sdk,保证线程可见性 - * - * @return - */ - public synchronized static void DestroySingletonSDK(long destroySDK) { + /** + * 销毁sdk,保证线程可见性 + * + * @param destroySDK the destroy sdk + * @return + */ + public synchronized static void DestroySingletonSDK(long destroySDK) { sdk = 0L; Finance.DestroySdk(destroySDK); } diff --git a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/api/WxCpAgentService.java b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/api/WxCpAgentService.java index d57ca56c2..0c5ccb3b0 100644 --- a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/api/WxCpAgentService.java +++ b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/api/WxCpAgentService.java @@ -8,7 +8,7 @@ import java.util.List; /** * 
  *  管理企业号应用
- *  文档地址：https://work.weixin.qq.com/api/doc#10087
+ *  文档地址：...
  *  Created by huansinho on 2018/4/13.
  *
* @@ -19,11 +19,12 @@ public interface WxCpAgentService { * 
    * 获取企业号应用信息
    * 该API用于获取企业号某个应用的基本信息，包括头像、昵称、帐号类型、认证类型、可见范围等信息
-   * 详情请见: https://work.weixin.qq.com/api/doc#10087
+   * 详情请见: ...
    *
* * @param agentId 企业应用的id - * @return 部门id + * @return wx cp agent + * @throws WxErrorException the wx error exception */ WxCpAgent get(Integer agentId) throws WxErrorException; @@ -31,10 +32,11 @@ public interface WxCpAgentService { * 
    * 设置应用.
    * 仅企业可调用，可设置当前凭证对应的应用；第三方不可调用。
-   * 详情请见: https://work.weixin.qq.com/api/doc#10088
+   * 详情请见: ...
    *
* * @param agentInfo 应用信息 + * @throws WxErrorException the wx error exception */ void set(WxCpAgent agentInfo) throws WxErrorException; @@ -42,9 +44,11 @@ public interface WxCpAgentService { * 
    * 获取应用列表.
    * 企业仅可获取当前凭证对应的应用；第三方仅可获取被授权的应用。
-   * 详情请见: https://work.weixin.qq.com/api/doc#11214
+   * 详情请见: ...
    *
* + * @return the list + * @throws WxErrorException the wx error exception */ List list() throws WxErrorException; diff --git a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/api/WxCpAgentWorkBenchService.java b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/api/WxCpAgentWorkBenchService.java index f0522181d..c50aa2f5f 100644 --- a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/api/WxCpAgentWorkBenchService.java +++ b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/api/WxCpAgentWorkBenchService.java @@ -4,15 +4,36 @@ import me.chanjar.weixin.common.error.WxErrorException; import me.chanjar.weixin.cp.bean.WxCpAgentWorkBench; /** + * The interface Wx cp agent work bench service. + * 工作台自定义展示 + * * @author songshiyu - * created on : create in 16:16 2020/9/27 - * @description: 工作台自定义展示：https://work.weixin.qq.com/api/doc/90000/90135/92535 + * created on 16:16 2020/9/27 */ public interface WxCpAgentWorkBenchService { + /** + * Sets work bench template. + * + * @param wxCpAgentWorkBench the wx cp agent work bench + * @throws WxErrorException the wx error exception + */ void setWorkBenchTemplate(WxCpAgentWorkBench wxCpAgentWorkBench) throws WxErrorException; + /** + * Gets work bench template. + * + * @param agentid the agentid + * @return the work bench template + * @throws WxErrorException the wx error exception + */ String getWorkBenchTemplate(Long agentid) throws WxErrorException; + /** + * Sets work bench data. + * + * @param wxCpAgentWorkBench the wx cp agent work bench + * @throws WxErrorException the wx error exception + */ void setWorkBenchData(WxCpAgentWorkBench wxCpAgentWorkBench) throws WxErrorException; } diff --git a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/api/WxCpChatService.java b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/api/WxCpChatService.java index 9c825d891..60248eb85 100644 --- a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/api/WxCpChatService.java +++ b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/api/WxCpChatService.java @@ -1,8 +1,8 @@ package me.chanjar.weixin.cp.api; import me.chanjar.weixin.common.error.WxErrorException; -import me.chanjar.weixin.cp.bean.message.WxCpAppChatMessage; import me.chanjar.weixin.cp.bean.WxCpChat; +import me.chanjar.weixin.cp.bean.message.WxCpAppChatMessage; import java.util.List; @@ -19,7 +19,7 @@ public interface WxCpChatService { * @param owner 指定群主的id。如果不指定，系统会随机从userlist中选一人作为群主 * @param users 群成员id列表。至少2人，至多500人 * @param chatId 群聊的唯一标志，不能与已有的群重复；字符串类型，最长32个字符。只允许字符0-9及字母a-zA-Z。如果不填，系统会随机生成群id - * @return 创建的群聊会话chatId + * @return 创建的群聊会话chatId string * @throws WxErrorException 异常 */ String create(String name, String owner, List users, String chatId) throws WxErrorException; @@ -40,7 +40,7 @@ public interface WxCpChatService { * 获取群聊会话. * * @param chatId 群聊编号 - * @return 群聊会话 + * @return 群聊会话 wx cp chat * @throws WxErrorException 异常 */ WxCpChat get(String chatId) throws WxErrorException; diff --git a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/api/WxCpDepartmentService.java b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/api/WxCpDepartmentService.java index b8e43cbdc..32a778c28 100644 --- a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/api/WxCpDepartmentService.java +++ b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/api/WxCpDepartmentService.java @@ -23,7 +23,7 @@ public interface WxCpDepartmentService { * * * @param depart 部门 - * @return 部门id + * @return 部门id long * @throws WxErrorException 异常 */ Long create(WxCpDepart depart) throws WxErrorException; @@ -35,7 +35,7 @@ public interface WxCpDepartmentService { * * * @param id 部门id - * @return 部门信息 + * @return 部门信息 wx cp depart * @throws WxErrorException 异常 */ WxCpDepart get(Long id) throws WxErrorException; @@ -47,7 +47,7 @@ public interface WxCpDepartmentService { * * * @param id 部门id。获取指定部门及其下的子部门。非必需，可为null - * @return 获取的部门列表 + * @return 获取的部门列表 list * @throws WxErrorException 异常 */ List list(Long id) throws WxErrorException; @@ -59,7 +59,7 @@ public interface WxCpDepartmentService { * * * @param id 部门id。获取指定部门及其下的子部门（以及子部门的子部门等等，递归）。 如果不填，默认获取全量组织架构 - * @return 子部门ID列表 + * @return 子部门ID列表 list * @throws WxErrorException 异常 */ List simpleList(Long id) throws WxErrorException; diff --git a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/api/WxCpExportService.java b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/api/WxCpExportService.java index 3f13ef38d..24c6ea9dc 100644 --- a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/api/WxCpExportService.java +++ b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/api/WxCpExportService.java @@ -7,9 +7,8 @@ import me.chanjar.weixin.cp.bean.export.WxCpExportResult; /** * 异步导出接口 * - * @author zhongjun - * created on 2022/4/21 - **/ + * @author zhongjun created on 2022/4/21 + */ public interface WxCpExportService { /** @@ -93,7 +92,7 @@ public interface WxCpExportService { * * * @param jobId 异步任务id - * @return 导出结果 + * @return 导出结果 result * @throws WxErrorException . */ WxCpExportResult getResult(String jobId) throws WxErrorException; diff --git a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/api/WxCpExternalContactService.java b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/api/WxCpExternalContactService.java index 0335725c7..f44be6d6c 100644 --- a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/api/WxCpExternalContactService.java +++ b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/api/WxCpExternalContactService.java @@ -56,6 +56,7 @@ public interface WxCpExternalContactService { * @throws WxErrorException the wx error exception */ WxCpContactWayInfo getContactWay(@NonNull String configId) throws WxErrorException; + /** * 更新企业已配置的「联系我」方式 * @@ -142,7 +143,7 @@ public interface WxCpExternalContactService { * 企业和服务商可通过此接口，将微信外部联系人的userid转为微信openid，用于调用支付相关接口。暂不支持企业微信外部联系人（ExternalUserid为wo开头）的userid转openid。 * * @param externalUserid 微信外部联系人的userid - * @return 该企业的外部联系人openid + * @return 该企业的外部联系人openid string * @throws WxErrorException . */ String convertToOpenid(String externalUserid) throws WxErrorException; @@ -165,13 +166,13 @@ public interface WxCpExternalContactService { * * * @param unionid 微信客户的unionid - * @return 该企业的外部联系人ID + * @param openid the openid + * @return 该企业的外部联系人ID string * @throws WxErrorException . */ - String unionidToExternalUserid(@NotNull String unionid,String openid) throws WxErrorException; + String unionidToExternalUserid(@NotNull String unionid, String openid) throws WxErrorException; /** - * * 配置客户群进群方式 * 企业可以在管理后台-客户联系中配置「加入群聊」的二维码或者小程序按钮，客户通过扫描二维码或点击小程序上的按钮，即可加入特定的客户群。 * 企业可通过此接口为具有客户联系功能的成员生成专属的二维码或者小程序按钮。 @@ -179,19 +180,21 @@ public interface WxCpExternalContactService { * 注意: * 通过API添加的配置不会在管理端进行展示，每个企业可通过API最多配置50万个「加入群聊」(与「联系我」共用50万的额度)。 * 文档地址：https://developer.work.weixin.qq.com/document/path/92229 - * @param wxCpGroupJoinWayInfo + * + * @param wxCpGroupJoinWayInfo the wx cp group join way info * @return {@link WxCpGroupJoinWayResult} - * @throws WxErrorException + * @throws WxErrorException the wx error exception */ WxCpGroupJoinWayResult addJoinWay(@NonNull WxCpGroupJoinWayInfo wxCpGroupJoinWayInfo) throws WxErrorException; /** - *更新客户群进群方式配置 + * 更新客户群进群方式配置 * 更新进群方式配置信息。注意：使用覆盖的方式更新。 * 文档地址：https://developer.work.weixin.qq.com/document/path/92229 - * @param wxCpGroupJoinWayInfo - * @return - * @throws WxErrorException + * + * @param wxCpGroupJoinWayInfo the wx cp group join way info + * @return wx cp base resp + * @throws WxErrorException the wx error exception */ WxCpBaseResp updateJoinWay(@NonNull WxCpGroupJoinWayInfo wxCpGroupJoinWayInfo) throws WxErrorException; @@ -199,20 +202,22 @@ public interface WxCpExternalContactService { * 获取客户群进群方式配置 * 获取企业配置的群二维码或小程序按钮。 * 文档地址：https://developer.work.weixin.qq.com/document/path/92229 - * @param configId - * @return - * @throws WxErrorException + * + * @param configId the config id + * @return join way + * @throws WxErrorException the wx error exception */ WxCpGroupJoinWayInfo getJoinWay(@NonNull String configId) throws WxErrorException; /** * 删除客户群进群方式配置 * 文档地址：https://developer.work.weixin.qq.com/document/path/92229 - * @param configId - * @return - * @throws WxErrorException + * + * @param configId the config id + * @return wx cp base resp + * @throws WxErrorException the wx error exception */ - WxCpBaseResp delJoinWay( @NonNull String configId) throws WxErrorException; + WxCpBaseResp delJoinWay(@NonNull String configId) throws WxErrorException; /** * 代开发应用external_userid转换 @@ -231,7 +236,7 @@ public interface WxCpExternalContactService { * * * @param externalUserid 代开发自建应用获取到的外部联系人ID - * @return 该服务商第三方应用下的企业的外部联系人ID + * @return 该服务商第三方应用下的企业的外部联系人ID string * @throws WxErrorException . */ String toServiceExternalUserid(@NotNull String externalUserid) throws WxErrorException; @@ -255,9 +260,9 @@ public interface WxCpExternalContactService { * * * @param unionid 微信客户的unionid - * @param openid 微信客户的openid - * @param corpid 需要换取的企业corpid，不填则拉取所有企业 - * @return 该服务商第三方应用下的企业的外部联系人ID + * @param openid 微信客户的openid + * @param corpid 需要换取的企业corpid，不填则拉取所有企业 + * @return 该服务商第三方应用下的企业的外部联系人ID wx cp external user id list * @throws WxErrorException . */ WxCpExternalUserIdList unionidToExternalUserid3rd(@NotNull String unionid, @NotNull String openid, String corpid) throws WxErrorException; @@ -279,7 +284,7 @@ public interface WxCpExternalContactService { * * * @param externalUserIdList 微信客户的unionid - * @return List 新外部联系人id + * @return List 新外部联系人id * @throws WxErrorException . */ WxCpNewExternalUserIdList getNewExternalUserId(String[] externalUserIdList) throws WxErrorException; @@ -323,8 +328,9 @@ public interface WxCpExternalContactService { * 仅可转换出自己企业下的客户群chat_id * * - * @param opengid 小程序在微信获取到的群ID，参见wx.getGroupEnterInfo(https://developers.weixin.qq.com/miniprogram/dev/api/open-api/group/wx.getGroupEnterInfo.html) - * @return 客户群ID，可以用来调用获取客户群详情 + * @param opengid 小程序在微信获取到的群ID，参见wx.getGroupEnterInfo(https://developers.weixin.qq + * .com/miniprogram/dev/api/open-api/group/wx.getGroupEnterInfo.html) + * @return 客户群ID ，可以用来调用获取客户群详情 * @throws WxErrorException . */ String opengidToChatid(@NotNull String opengid) throws WxErrorException; @@ -405,15 +411,15 @@ public interface WxCpExternalContactService { /** * 获取待分配的离职成员列表 * 企业和第三方可通过此接口，获取所有离职成员的客户列表，并可进一步调用分配离职成员的客户接口将这些客户重新分配给其他企业成员。 - * + *

* 请求方式：POST（HTTPS） * 请求地址：https://qyapi.weixin.qq.com/cgi-bin/externalcontact/get_unassigned_list?access_token=ACCESS_TOKEN * - * @param pageId 分页查询，要查询页号，从0开始 - * @param cursor 分页查询游标，字符串类型，适用于数据量较大的情况，如果使用该参数则无需填写page_id，该参数由上一次调用返回 + * @param pageId 分页查询，要查询页号，从0开始 + * @param cursor 分页查询游标，字符串类型，适用于数据量较大的情况，如果使用该参数则无需填写page_id，该参数由上一次调用返回 * @param pageSize 每次返回的最大记录数，默认为1000，最大值为1000 - * @return - * @throws WxErrorException + * @return wx cp user external unassign list + * @throws WxErrorException the wx error exception */ WxCpUserExternalUnassignList listUnassignedList(Integer pageId, String cursor, Integer pageSize) throws WxErrorException; @@ -463,10 +469,11 @@ public interface WxCpExternalContactService { * @param handOverUserid 原添加成员的userid * @param takeOverUserid 接替成员的userid * @param cursor 分页查询的cursor，每个分页返回的数据不会超过1000条；不填或为空表示获取第一个分页； - * @return 客户转接接口实体 + * @return 客户转接接口实体 wx cp user transfer result resp * @throws WxErrorException the wx error exception */ - WxCpUserTransferResultResp transferResult(@NotNull String handOverUserid, @NotNull String takeOverUserid, String cursor) throws WxErrorException; + WxCpUserTransferResultResp transferResult(@NotNull String handOverUserid, @NotNull String takeOverUserid, + String cursor) throws WxErrorException; /** * 企业可通过此接口，分配离职成员的客户给其他成员。 @@ -503,10 +510,11 @@ public interface WxCpExternalContactService { * @param handOverUserid 原添加成员的userid * @param takeOverUserid 接替成员的userid * @param cursor 分页查询的cursor，每个分页返回的数据不会超过1000条；不填或为空表示获取第一个分页； - * @return 客户转接接口实体 + * @return 客户转接接口实体 wx cp user transfer result resp * @throws WxErrorException the wx error exception */ - WxCpUserTransferResultResp resignedTransferResult(@NotNull String handOverUserid, @NotNull String takeOverUserid, String cursor) throws WxErrorException; + WxCpUserTransferResultResp resignedTransferResult(@NotNull String handOverUserid, @NotNull String takeOverUserid, + String cursor) throws WxErrorException; /** * 

@@ -526,7 +534,8 @@ public interface WxCpExternalContactService {
    * @deprecated 请使用 {@link WxCpExternalContactService#listGroupChat(Integer, String, int, String[])}
    */
   @Deprecated
-  WxCpUserExternalGroupChatList listGroupChat(Integer pageIndex, Integer pageSize, int status, String[] userIds, String[] partyIds) throws WxErrorException;
+  WxCpUserExternalGroupChatList listGroupChat(Integer pageIndex, Integer pageSize, int status, String[] userIds,
+                                              String[] partyIds) throws WxErrorException;
 
   /**
    * 
@@ -553,7 +562,8 @@ public interface WxCpExternalContactService {
    * 微信文档：https://work.weixin.qq.com/api/doc/90000/90135/92122
    * 

    *
-   * @param chatId the chat id
+   * @param chatId   the chat id
+   * @param needName the need name
    * @return group chat
    * @throws WxErrorException the wx error exception
    */
@@ -580,7 +590,7 @@ public interface WxCpExternalContactService {
    *
    * @param chatIds  需要转群主的客户群ID列表。取值范围： 1 ~ 100
    * @param newOwner 新群主ID
-   * @return 分配结果，主要是分配失败的群列表
+   * @return 分配结果 ，主要是分配失败的群列表
    * @throws WxErrorException the wx error exception
    */
   WxCpUserExternalGroupChatTransferResp transferGroupChat(String[] chatIds, String newOwner) throws WxErrorException;
@@ -600,7 +610,8 @@ public interface WxCpExternalContactService {
    * @return user behavior statistic
    * @throws WxErrorException the wx error exception
    */
-  WxCpUserExternalUserBehaviorStatistic getUserBehaviorStatistic(Date startTime, Date endTime, String[] userIds, String[] partyIds) throws WxErrorException;
+  WxCpUserExternalUserBehaviorStatistic getUserBehaviorStatistic(Date startTime, Date endTime, String[] userIds,
+                                                                 String[] partyIds) throws WxErrorException;
 
   /**
    * 
@@ -619,7 +630,9 @@ public interface WxCpExternalContactService {
    * @return group chat statistic
    * @throws WxErrorException the wx error exception
    */
-  WxCpUserExternalGroupChatStatistic getGroupChatStatistic(Date startTime, Integer orderBy, Integer orderAsc, Integer pageIndex, Integer pageSize, String[] userIds, String[] partyIds) throws WxErrorException;
+  WxCpUserExternalGroupChatStatistic getGroupChatStatistic(Date startTime, Integer orderBy, Integer orderAsc,
+                                                           Integer pageIndex, Integer pageSize, String[] userIds,
+                                                           String[] partyIds) throws WxErrorException;
 
   /**
    * 添加企业群发消息任务
@@ -739,10 +752,11 @@ public interface WxCpExternalContactService {
 
   /**
    * 
- *   企业和第三方应用可通过该接口创建客户朋友圈的发表任务。
- *   https://open.work.weixin.qq.com/api/doc/90000/90135/95094
+   *   企业和第三方应用可通过该接口创建客户朋友圈的发表任务。
+   *   https://open.work.weixin.qq.com/api/doc/90000/90135/95094
    * 

-   * @param task
+   *
+   * @param task the task
    * @return wx cp add moment result
    * @throws WxErrorException the wx error exception
    */
@@ -753,9 +767,10 @@ public interface WxCpExternalContactService {
    * 由于发表任务的创建是异步执行的，应用需要再调用该接口以获取创建的结果。
    * https://open.work.weixin.qq.com/api/doc/90000/90135/95094
    * 

+   *
    * @param jobId 异步任务id，最大长度为64字节，由创建发表内容到客户朋友圈任务接口获取
-   * @return
-   * @throws WxErrorException
+   * @return moment task result
+   * @throws WxErrorException the wx error exception
    */
   WxCpGetMomentTaskResult getMomentTaskResult(String jobId) throws WxErrorException;
 
@@ -764,28 +779,30 @@ public interface WxCpExternalContactService {
    * 获取客户朋友圈全部的发表记录 获取企业全部的发表列表
    * https://open.work.weixin.qq.com/api/doc/90000/90135/93333
    *
- * @param startTime 朋友圈记录开始时间。Unix时间戳 - * @param endTime 朋友圈记录结束时间。Unix时间戳 - * @param creator 朋友圈创建人的userid + * + * @param startTime 朋友圈记录开始时间。Unix时间戳 + * @param endTime 朋友圈记录结束时间。Unix时间戳 + * @param creator 朋友圈创建人的userid * @param filterType 朋友圈类型。0：企业发表 1：个人发表 2：所有，包括个人创建以及企业创建，默认情况下为所有类型 - * @param cursor 用于分页查询的游标，字符串类型，由上一次调用返回，首次调用可不填 - * @param limit 返回的最大记录数，整型，最大值100，默认值100，超过最大值时取默认值 - * @return - * @throws WxErrorException + * @param cursor 用于分页查询的游标，字符串类型，由上一次调用返回，首次调用可不填 + * @param limit 返回的最大记录数，整型，最大值100，默认值100，超过最大值时取默认值 + * @return moment list + * @throws WxErrorException the wx error exception */ WxCpGetMomentList getMomentList(Long startTime, Long endTime, String creator, Integer filterType, - String cursor, Integer limit) throws WxErrorException; + String cursor, Integer limit) throws WxErrorException; /** * 
    * 获取客户朋友圈全部的发表记录 获取客户朋友圈企业发表的列表
    * https://open.work.weixin.qq.com/api/doc/90000/90135/93333
    *
+ * * @param momentId 朋友圈id,仅支持企业发表的朋友圈id - * @param cursor 用于分页查询的游标，字符串类型，由上一次调用返回，首次调用可不填 - * @param limit 返回的最大记录数，整型，最大值1000，默认值500，超过最大值时取默认值 - * @return - * @throws WxErrorException + * @param cursor 用于分页查询的游标，字符串类型，由上一次调用返回，首次调用可不填 + * @param limit 返回的最大记录数，整型，最大值1000，默认值500，超过最大值时取默认值 + * @return moment task + * @throws WxErrorException the wx error exception */ WxCpGetMomentTask getMomentTask(String momentId, String cursor, Integer limit) throws WxErrorException; @@ -795,43 +812,46 @@ public interface WxCpExternalContactService { * 获取客户朋友圈全部的发表记录 获取客户朋友圈发表时选择的可见范围 * https://open.work.weixin.qq.com/api/doc/90000/90135/93333 * + * * @param momentId 朋友圈id - * @param userId 企业发表成员userid，如果是企业创建的朋友圈，可以通过获取客户朋友圈企业发表的 - * 列表获取已发表成员userid，如果是个人创建的朋友圈，创建人userid就是企业发表成员userid - * @param cursor 用于分页查询的游标，字符串类型，由上一次调用返回，首次调用可不填 - * @param limit 返回的最大记录数，整型，最大值1000，默认值500，超过最大值时取默认值 - * @return - * @throws WxErrorException + * @param userId 企业发表成员userid，如果是企业创建的朋友圈，可以通过获取客户朋友圈企业发表的 + * 列表获取已发表成员userid，如果是个人创建的朋友圈，创建人userid就是企业发表成员userid + * @param cursor 用于分页查询的游标，字符串类型，由上一次调用返回，首次调用可不填 + * @param limit 返回的最大记录数，整型，最大值1000，默认值500，超过最大值时取默认值 + * @return moment customer list + * @throws WxErrorException the wx error exception */ WxCpGetMomentCustomerList getMomentCustomerList(String momentId, String userId, - String cursor, Integer limit) throws WxErrorException; + String cursor, Integer limit) throws WxErrorException; /** * 
    * 获取客户朋友圈全部的发表记录 获取客户朋友圈发表后的可见客户列表
    * https://open.work.weixin.qq.com/api/doc/90000/90135/93333
    *
+ * * @param momentId 朋友圈id - * @param userId 企业发表成员userid，如果是企业创建的朋友圈，可以通过获取客户朋友圈企业发表的列表获取已发表成员userid， - * 如果是个人创建的朋友圈，创建人userid就是企业发表成员userid - * @param cursor 用于分页查询的游标，字符串类型，由上一次调用返回，首次调用可不填 - * @param limit 返回的最大记录数，整型，最大值5000，默认值3000，超过最大值时取默认值 - * @return - * @throws WxErrorException + * @param userId 企业发表成员userid，如果是企业创建的朋友圈，可以通过获取客户朋友圈企业发表的列表获取已发表成员userid， + * 如果是个人创建的朋友圈，创建人userid就是企业发表成员userid + * @param cursor 用于分页查询的游标，字符串类型，由上一次调用返回，首次调用可不填 + * @param limit 返回的最大记录数，整型，最大值5000，默认值3000，超过最大值时取默认值 + * @return moment send result + * @throws WxErrorException the wx error exception */ WxCpGetMomentSendResult getMomentSendResult(String momentId, String userId, - String cursor, Integer limit) throws WxErrorException; + String cursor, Integer limit) throws WxErrorException; /** * 
    * 获取客户朋友圈全部的发表记录 获取客户朋友圈的互动数据
    * https://open.work.weixin.qq.com/api/doc/90000/90135/93333
    *
+ * * @param momentId 朋友圈id - * @param userId 企业发表成员userid，如果是企业创建的朋友圈，可以通过获取客户朋友圈企业发表的列表获取已发表成员userid， - * 如果是个人创建的朋友圈，创建人userid就是企业发表成员userid - * @return - * @throws WxErrorException + * @param userId 企业发表成员userid，如果是企业创建的朋友圈，可以通过获取客户朋友圈企业发表的列表获取已发表成员userid， + * 如果是个人创建的朋友圈，创建人userid就是企业发表成员userid + * @return moment comments + * @throws WxErrorException the wx error exception */ WxCpGetMomentComments getMomentComments(String momentId, String userId) throws WxErrorException; @@ -842,17 +862,18 @@ public interface WxCpExternalContactService { * https://work.weixin.qq.com/api/doc/90000/90135/93338 * * - * @param chatType 群发任务的类型，默认为single，表示发送给客户，group表示发送给客户群 - * @param startTime 群发任务记录开始时间 - * @param endTime 群发任务记录结束时间 - * @param creator 群发任务创建人企业账号id - * @param filterType 创建人类型。0：企业发表 1：个人发表 2：所有，包括个人创建以及企业创建，默认情况下为所有类型 - * @param limit 返回的最大记录数，整型，最大值100，默认值50，超过最大值时取默认值 - * @param cursor 用于分页查询的游标，字符串类型，由上一次调用返回，首次调用可不填 + * @param chatType 群发任务的类型，默认为single，表示发送给客户，group表示发送给客户群 + * @param startTime 群发任务记录开始时间 + * @param endTime 群发任务记录结束时间 + * @param creator 群发任务创建人企业账号id + * @param filterType 创建人类型。0：企业发表 1：个人发表 2：所有，包括个人创建以及企业创建，默认情况下为所有类型 + * @param limit 返回的最大记录数，整型，最大值100，默认值50，超过最大值时取默认值 + * @param cursor 用于分页查询的游标，字符串类型，由上一次调用返回，首次调用可不填 * @return wx cp base resp * @throws WxErrorException the wx error exception */ - WxCpGroupMsgListResult getGroupMsgListV2(String chatType, @NonNull Date startTime, @NonNull Date endTime, String creator, Integer filterType, Integer limit, String cursor) throws WxErrorException; + WxCpGroupMsgListResult getGroupMsgListV2(String chatType, @NonNull Date startTime, @NonNull Date endTime, + String creator, Integer filterType, Integer limit, String cursor) throws WxErrorException; /** * 
@@ -860,10 +881,10 @@ public interface WxCpExternalContactService {
    * https://work.weixin.qq.com/api/doc/90000/90135/93338#获取企业群发成员执行结果
    *
* - * @param msgid 群发消息的id，通过获取群发记录列表接口返回 - * @param userid 发送成员userid，通过获取群发成员发送任务列表接口返回 - * @param limit 返回的最大记录数，整型，最大值1000，默认值500，超过最大值时取默认值 - * @param cursor 用于分页查询的游标，字符串类型，由上一次调用返回，首次调用可不填 + * @param msgid 群发消息的id，通过获取群发记录列表接口返回 + * @param userid 发送成员userid，通过获取群发成员发送任务列表接口返回 + * @param limit 返回的最大记录数，整型，最大值1000，默认值500，超过最大值时取默认值 + * @param cursor 用于分页查询的游标，字符串类型，由上一次调用返回，首次调用可不填 * @return wx cp base resp * @throws WxErrorException the wx error exception */ @@ -881,7 +902,7 @@ public interface WxCpExternalContactService { * @return wx cp base resp * @throws WxErrorException the wx error exception */ - public WxCpGroupMsgResult getGroupMsgResult(String msgid, Integer limit, String cursor) throws WxErrorException; + WxCpGroupMsgResult getGroupMsgResult(String msgid, Integer limit, String cursor) throws WxErrorException; /** * 
@@ -889,13 +910,13 @@ public interface WxCpExternalContactService {
    * https://work.weixin.qq.com/api/doc/90000/90135/93338#获取群发成员发送任务列表
    *
* - * @param msgid 群发消息的id，通过获取群发记录列表接口返回 - * @param limit 返回的最大记录数，整型，最大值1000，默认值500，超过最大值时取默认值 - * @param cursor 用于分页查询的游标，字符串类型，由上一次调用返回，首次调用可不填 + * @param msgid 群发消息的id，通过获取群发记录列表接口返回 + * @param limit 返回的最大记录数，整型，最大值1000，默认值500，超过最大值时取默认值 + * @param cursor 用于分页查询的游标，字符串类型，由上一次调用返回，首次调用可不填 * @return wx cp base resp * @throws WxErrorException the wx error exception */ - WxCpGroupMsgTaskResult getGroupMsgTask(String msgid, Integer limit, String cursor) throws WxErrorException; + WxCpGroupMsgTaskResult getGroupMsgTask(String msgid, Integer limit, String cursor) throws WxErrorException; /** * 
@@ -903,8 +924,8 @@ public interface WxCpExternalContactService {
    * https://open.work.weixin.qq.com/api/doc/90000/90135/92366#添加入群欢迎语素材
    *
* - * @param template 素材内容 - * @return template_id 欢迎语素材id + * @param template 素材内容 + * @return template_id 欢迎语素材id * @throws WxErrorException the wx error exception */ String addGroupWelcomeTemplate(WxCpGroupWelcomeTemplateResult template) throws WxErrorException; @@ -915,7 +936,7 @@ public interface WxCpExternalContactService { * https://open.work.weixin.qq.com/api/doc/90000/90135/92366#编辑入群欢迎语素材 * * - * @param template + * @param template the template * @return wx cp base resp * @throws WxErrorException the wx error exception */ @@ -927,7 +948,7 @@ public interface WxCpExternalContactService { * https://open.work.weixin.qq.com/api/doc/90000/90135/92366#获取入群欢迎语素材 * * - * @param templateId 群欢迎语的素材id + * @param templateId 群欢迎语的素材id * @return wx cp base resp * @throws WxErrorException the wx error exception */ @@ -940,8 +961,8 @@ public interface WxCpExternalContactService { * https://open.work.weixin.qq.com/api/doc/90000/90135/92366#删除入群欢迎语素材 * * - * @param templateId 群欢迎语的素材id - * @param templateId 授权方安装的应用agentid。仅旧的第三方多应用套件需要填此参数 + * @param templateId 群欢迎语的素材id + * @param agentId the agent id * @return wx cp base resp * @throws WxErrorException the wx error exception */ @@ -953,8 +974,8 @@ public interface WxCpExternalContactService { * https://work.weixin.qq.com/api/doc/90000/90135/95096#获取商品图册列表 * * - * @param limit 返回的最大记录数，整型，最大值100，默认值50，超过最大值时取默认值 - * @param cursor 用于分页查询的游标，字符串类型，由上一次调用返回，首次调用可不填 + * @param limit 返回的最大记录数，整型，最大值100，默认值50，超过最大值时取默认值 + * @param cursor 用于分页查询的游标，字符串类型，由上一次调用返回，首次调用可不填 * @return wx cp base resp * @throws WxErrorException the wx error exception */ @@ -966,7 +987,7 @@ public interface WxCpExternalContactService { * https://work.weixin.qq.com/api/doc/90000/90135/95096#获取商品图册 * * - * @param productId 商品id + * @param productId 商品id * @return wx cp base resp * @throws WxErrorException the wx error exception */ @@ -977,27 +998,29 @@ public interface WxCpExternalContactService { * 上传附件资源 * https://open.work.weixin.qq.com/api/doc/90001/90143/95178 * - * @param mediaType - * @param fileType - * @param attachmentType - * @param inputStream - * @return - * @throws WxErrorException - * @throws IOException + * + * @param mediaType the media type + * @param fileType the file type + * @param attachmentType the attachment type + * @param inputStream the input stream + * @return wx media upload result + * @throws WxErrorException the wx error exception + * @throws IOException the io exception */ WxMediaUploadResult uploadAttachment(String mediaType, String fileType, Integer attachmentType, - InputStream inputStream) throws WxErrorException, IOException; + InputStream inputStream) throws WxErrorException, IOException; /** * 
    * 上传附件资源
    * https://open.work.weixin.qq.com/api/doc/90001/90143/95178
    *
- * @param mediaType - * @param attachmentType - * @param file - * @return - * @throws WxErrorException + * + * @param mediaType the media type + * @param attachmentType the attachment type + * @param file the file + * @return wx media upload result + * @throws WxErrorException the wx error exception */ WxMediaUploadResult uploadAttachment(String mediaType, Integer attachmentType, File file) throws WxErrorException; @@ -1009,8 +1032,12 @@ public interface WxCpExternalContactService { * 请求方式：POST(HTTPS) * 请求地址：https://qyapi.weixin.qq.com/cgi-bin/externalcontact/add_intercept_rule?access_token=ACCESS_TOKEN * 
+   * @param ruleResp the rule resp
+   * @return the wx cp intercept rule result resp
+   * @throws WxErrorException the wx error exception
    */
-  WxCpInterceptRuleResultResp addInterceptRule(WxCpInterceptRuleResp ruleResp) throws  WxErrorException;
+  WxCpInterceptRuleResultResp addInterceptRule(WxCpInterceptRuleResp ruleResp) throws WxErrorException;
+
   /**
    * 
    * 修改敏感词规则
@@ -1018,6 +1045,9 @@ public interface WxCpExternalContactService {
    * 请求方式：POST(HTTPS)
    * 请求地址：https://qyapi.weixin.qq.com/cgi-bin/externalcontact/update_intercept_rule?access_token=ACCESS_TOKEN
    * 
+   * @param ruleResp the rule resp
+   * @return the wx cp intercept rule result resp
+   * @throws WxErrorException the wx error exception
    */
   WxCpInterceptRuleResultResp updateInterceptRule(WxCpInterceptRuleResp ruleResp) throws WxErrorException;
 
@@ -1029,6 +1059,8 @@ public interface WxCpExternalContactService {
    * 请求地址：https://qyapi.weixin.qq.com/cgi-bin/externalcontact/del_intercept_rule?access_token=ACCESS_TOKEN
    * 
    * @param rule_id 规则id
+   * @return the wx cp base resp
+   * @throws WxErrorException the wx error exception
    */
   WxCpBaseResp delInterceptRule(String rule_id) throws WxErrorException;
 
@@ -1037,11 +1069,14 @@ public interface WxCpExternalContactService {
    * 创建商品图册
    * 企业和第三方应用可以通过此接口增加商品
    * 请求方式：POST(HTTPS)
-   * 请求地址：https://qyapi.weixin.qq.com/cgi-bin/externalcontact/add_product_album?access_token=ACCESS_TOKEN
-   * 文档地址：https://developer.work.weixin.qq.com/document/path/95096#%E5%88%9B%E5%BB%BA%E5%95%86%E5%93%81%E5%9B%BE%E5%86%8C
+   * 请求地址：
+   * https://qyapi.weixin.qq.com/cgi-bin/externalcontact/add_product_album?access_token=ACCESS_TOKEN
+   * 文档地址：
+   * https://developer.work.weixin.qq.com/document/path/95096#%E5%88%9B%E5%BB%BA%E5%95%86%E5%93%81%E5%9B%BE%E5%86%8C
    * 
    * @param wxCpProductAlbumInfo 商品图册信息
-   * @return 商品id
+   * @return 商品id string
+   * @throws WxErrorException the wx error exception
    */
   String addProductAlbum(WxCpProductAlbumInfo wxCpProductAlbumInfo) throws WxErrorException;
 
@@ -1050,10 +1085,13 @@ public interface WxCpExternalContactService {
    * 编辑商品图册
    * 企业和第三方应用可以通过此接口修改商品信息
    * 请求方式：POST(HTTPS)
-   * 请求地址：https://qyapi.weixin.qq.com/cgi-bin/externalcontact/update_product_album?access_token=ACCESS_TOKEN
-   * 文档地址：https://developer.work.weixin.qq.com/document/path/95096#%E7%BC%96%E8%BE%91%E5%95%86%E5%93%81%E5%9B%BE%E5%86%8C
+   * 请求地址：
+   * https://qyapi.weixin.qq.com/cgi-bin/externalcontact/update_product_album?access_token=ACCESS_TOKEN
+   * 文档地址：
+   * https://developer.work.weixin.qq.com/document/path/95096#%E7%BC%96%E8%BE%91%E5%95%86%E5%93%81%E5%9B%BE%E5%86%8C
    * 
    * @param wxCpProductAlbumInfo 商品图册信息
+   * @throws WxErrorException the wx error exception
    */
   void updateProductAlbum(WxCpProductAlbumInfo wxCpProductAlbumInfo) throws WxErrorException;
 
@@ -1062,10 +1100,13 @@ public interface WxCpExternalContactService {
    * 删除商品图册
    * 企业和第三方应用可以通过此接口删除商品信息
    * 请求方式：POST(HTTPS)
-   * 请求地址：https://qyapi.weixin.qq.com/cgi-bin/externalcontact/delete_product_album?access_token=ACCESS_TOKEN
-   * 文档地址：https://developer.work.weixin.qq.com/document/path/95096#%E5%88%A0%E9%99%A4%E5%95%86%E5%93%81%E5%9B%BE%E5%86%8C
+   * 请求地址：
+   * https://qyapi.weixin.qq.com/cgi-bin/externalcontact/delete_product_album?access_token=ACCESS_TOKEN
+   * 文档地址：
+   * https://developer.work.weixin.qq.com/document/path/95096#%E5%88%A0%E9%99%A4%E5%95%86%E5%93%81%E5%9B%BE%E5%86%8C
    * 
    * @param productId 商品id
+   * @throws WxErrorException the wx error exception
    */
   void deleteProductAlbum(String productId) throws WxErrorException;
 
diff --git a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/api/WxCpGroupRobotService.java b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/api/WxCpGroupRobotService.java
index 6642cc85f..769cab6f7 100644
--- a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/api/WxCpGroupRobotService.java
+++ b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/api/WxCpGroupRobotService.java
@@ -10,8 +10,7 @@ import java.util.List;
  * 文档地址：https://work.weixin.qq.com/help?doc_id=13376
  * 调用地址：https://qyapi.weixin.qq.com/cgi-bin/webhook/send?key=
  *
- * @author yr
- * created on  2020-8-20
+ * @author yr  created on  2020-8-20
  */
 public interface WxCpGroupRobotService {
 
@@ -92,8 +91,8 @@ public interface WxCpGroupRobotService {
   /**
    * 发送文件类型的消息
    *
-   * @param webhookUrl  webhook地址
-   * @param mediaId 文件id
+   * @param webhookUrl webhook地址
+   * @param mediaId    文件id
    * @throws WxErrorException 异常
    */
   void sendFile(String webhookUrl, String mediaId) throws WxErrorException;
diff --git a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/api/WxCpKfService.java b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/api/WxCpKfService.java
index a9d1bb9af..6f47ab908 100644
--- a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/api/WxCpKfService.java
+++ b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/api/WxCpKfService.java
@@ -2,35 +2,18 @@ package me.chanjar.weixin.cp.api;
 
 import me.chanjar.weixin.common.error.WxErrorException;
 import me.chanjar.weixin.cp.bean.WxCpBaseResp;
-import me.chanjar.weixin.cp.bean.kf.WxCpKfAccountAdd;
-import me.chanjar.weixin.cp.bean.kf.WxCpKfAccountAddResp;
-import me.chanjar.weixin.cp.bean.kf.WxCpKfAccountDel;
-import me.chanjar.weixin.cp.bean.kf.WxCpKfAccountLink;
-import me.chanjar.weixin.cp.bean.kf.WxCpKfAccountLinkResp;
-import me.chanjar.weixin.cp.bean.kf.WxCpKfAccountListResp;
-import me.chanjar.weixin.cp.bean.kf.WxCpKfAccountUpd;
-import me.chanjar.weixin.cp.bean.kf.WxCpKfCustomerBatchGetResp;
-import me.chanjar.weixin.cp.bean.kf.WxCpKfMsgListResp;
-import me.chanjar.weixin.cp.bean.kf.WxCpKfMsgSendRequest;
-import me.chanjar.weixin.cp.bean.kf.WxCpKfMsgSendResp;
-import me.chanjar.weixin.cp.bean.kf.WxCpKfServiceStateResp;
-import me.chanjar.weixin.cp.bean.kf.WxCpKfServiceStateTransResp;
-import me.chanjar.weixin.cp.bean.kf.WxCpKfServiceUpgradeConfigResp;
-import me.chanjar.weixin.cp.bean.kf.WxCpKfServicerListResp;
-import me.chanjar.weixin.cp.bean.kf.WxCpKfServicerOpResp;
 import me.chanjar.weixin.cp.bean.kf.*;
 
 import java.util.List;
 
 /**
  * 微信客服接口
+ * 

+ * 微信客服由腾讯微信团队为企业打造，用于满足企业的客服需求，帮助企业做好客户服务。企业可以在微信内、外各个场景中接入微信客服，
+ * 用户可以发起咨询，企业可以进行回复。
+ * 企业可在微信客服官网使用企业微信扫码开通微信客服，开通后即可使用。
  *
- *  微信客服由腾讯微信团队为企业打造，用于满足企业的客服需求，帮助企业做好客户服务。企业可以在微信内、外各个场景中接入微信客服，
- *  用户可以发起咨询，企业可以进行回复。
- *  企业可在微信客服官网使用企业微信扫码开通微信客服，开通后即可使用。
- *
- * @author Fu
- * created on  2022/1/19 19:25
+ * @author Fu  created on  2022/1/19 19:25
  */
 public interface WxCpKfService {
 
@@ -38,7 +21,7 @@ public interface WxCpKfService {
    * 添加客服帐号，并可设置客服名称和头像。目前一家企业最多可添加10个客服帐号
    *
    * @param add 客服帐号信息
-   * @return result-新创建的客服帐号ID
+   * @return result -新创建的客服帐号ID
    * @throws WxErrorException 异常
    */
   WxCpKfAccountAddResp addAccount(WxCpKfAccountAdd add) throws WxErrorException;
@@ -47,7 +30,7 @@ public interface WxCpKfService {
    * 修改已有的客服帐号，可修改客服名称和头像。
    *
    * @param upd 新的客服账号信息
-   * @return result
+   * @return result wx cp base resp
    * @throws WxErrorException 异常
    */
   WxCpBaseResp updAccount(WxCpKfAccountUpd upd) throws WxErrorException;
@@ -56,26 +39,27 @@ public interface WxCpKfService {
    * 删除已有的客服帐号
    *
    * @param del 要删除的客服帐号
-   * @return result
+   * @return result wx cp base resp
    * @throws WxErrorException 异常
    */
   WxCpBaseResp delAccount(WxCpKfAccountDel del) throws WxErrorException;
 
   /**
    * 获取客服帐号列表，包括所有的客服帐号的客服ID、名称和头像。
+   *
    * @param offset 分页，偏移量, 默认为0
    * @param limit  分页，预期请求的数据量，默认为100，取值范围 1 ~ 100
-   * @return 客服帐号列表
+   * @return 客服帐号列表 wx cp kf account list resp
    * @throws WxErrorException 异常
    */
-  WxCpKfAccountListResp listAccount(Integer offset,Integer limit) throws WxErrorException;
+  WxCpKfAccountListResp listAccount(Integer offset, Integer limit) throws WxErrorException;
 
   /**
    * 企业可通过此接口获取带有不同参数的客服链接，不同客服帐号对应不同的客服链接。获取后，企业可将链接嵌入到网页等场景中，
    * 微信用户点击链接即可向对应的客服帐号发起咨询。企业可依据参数来识别用户的咨询来源等
    *
    * @param link 参数
-   * @return 链接
+   * @return 链接 account link
    * @throws WxErrorException 异常
    */
   WxCpKfAccountLinkResp getAccountLink(WxCpKfAccountLink link) throws WxErrorException;
@@ -83,10 +67,10 @@ public interface WxCpKfService {
   /**
    * 接待人员管理
    * 添加指定客服帐号的接待人员，每个客服帐号目前最多可添加500个接待人员。
-   * @param openKfid 客服帐号ID
-   * @param userIdList 接待人员userid列表。第三方应用填密文userid，即open_userid
-   * 可填充个数：1 ~ 100。超过100个需分批调用。
-   * @return 添加客服账号结果
+   *
+   * @param openKfid   客服帐号ID
+   * @param userIdList 接待人员userid列表。第三方应用填密文userid，即open_userid 可填充个数：1 ~ 100。超过100个需分批调用。
+   * @return 添加客服账号结果 wx cp kf servicer op resp
    * @throws WxErrorException 异常
    */
   WxCpKfServicerOpResp addServicer(String openKfid, List userIdList) throws WxErrorException;
@@ -94,10 +78,10 @@ public interface WxCpKfService {
   /**
    * 接待人员管理
    * 从客服帐号删除接待人员
-   * @param openKfid 客服帐号ID
-   * @param userIdList 接待人员userid列表。第三方应用填密文userid，即open_userid
-   * 可填充个数：1 ~ 100。超过100个需分批调用。
-   * @return 删除客服账号结果
+   *
+   * @param openKfid   客服帐号ID
+   * @param userIdList 接待人员userid列表。第三方应用填密文userid，即open_userid 可填充个数：1 ~ 100。超过100个需分批调用。
+   * @return 删除客服账号结果 wx cp kf servicer op resp
    * @throws WxErrorException 异常
    */
   WxCpKfServicerOpResp delServicer(String openKfid, List userIdList) throws WxErrorException;
@@ -105,8 +89,9 @@ public interface WxCpKfService {
   /**
    * 接待人员管理
    * 获取某个客服帐号的接待人员列表
+   *
    * @param openKfid 客服帐号ID
-   * @return 接待人员列表
+   * @return 接待人员列表 wx cp kf servicer list resp
    * @throws WxErrorException 异常
    */
   WxCpKfServicerListResp listServicer(String openKfid) throws WxErrorException;
@@ -114,10 +99,11 @@ public interface WxCpKfService {
   /**
    * 分配客服会话
    * 获取会话状态
-   * @param openKfid 客服帐号ID
+   *
+   * @param openKfid       客服帐号ID
    * @param externalUserId 微信客户的external_userid
-   * @return
-   * @throws WxErrorException
+   * @return service state
+   * @throws WxErrorException the wx error exception
    */
   WxCpKfServiceStateResp getServiceState(String openKfid, String externalUserId)
     throws WxErrorException;
@@ -125,27 +111,28 @@ public interface WxCpKfService {
   /**
    * 分配客服会话
    * 变更会话状态
-   * @param openKfid 客服帐号ID
+   *
+   * @param openKfid       客服帐号ID
    * @param externalUserId 微信客户的external_userid
-   * @param serviceState 变更的目标状态，状态定义和所允许的变更可参考概述中的流程图和表格
+   * @param serviceState   变更的目标状态，状态定义和所允许的变更可参考概述中的流程图和表格
    * @param servicerUserId 接待人员的userid。第三方应用填密文userid，即open_userid。当state=3时要求必填，接待人员须处于“正在接待”中。
-   * @return 部分状态返回回复语code
-   * @throws WxErrorException
+   * @return 部分状态返回回复语code wx cp kf service state trans resp
+   * @throws WxErrorException the wx error exception
    */
   WxCpKfServiceStateTransResp transServiceState(String openKfid, String externalUserId,
-    Integer serviceState, String servicerUserId) throws WxErrorException;
+                                                Integer serviceState, String servicerUserId) throws WxErrorException;
 
   /**
    * 读取消息
    * 微信客户发送的消息、接待人员在企业微信回复的消息、发送消息接口发送失败事件（如被用户拒收）、客户点击菜单消息的回复消息，
    * 可以通过该接口获取具体的消息内容和事件。不支持读取通过发送消息接口发送的消息。
    * 支持的消息类型：文本、图片、语音、视频、文件、位置、链接、名片、小程序、菜单、事件。
-   * @param cursor 上一次调用时返回的next_cursor，第一次拉取可以不填。不多于64字节
-   * @param token 回调事件返回的token字段，10分钟内有效；可不填，如果不填接口有严格的频率限制。不多于128字节
-   * @param limit 期望请求的数据量，默认值和最大值都为1000。
-   *              注意：可能会出现返回条数少于limit的情况，需结合返回的has_more字段判断是否继续请求。
+   *
+   * @param cursor      上一次调用时返回的next_cursor，第一次拉取可以不填。不多于64字节
+   * @param token       回调事件返回的token字段，10分钟内有效；可不填，如果不填接口有严格的频率限制。不多于128字节
+   * @param limit       期望请求的数据量，默认值和最大值都为1000。              注意：可能会出现返回条数少于limit的情况，需结合返回的has_more字段判断是否继续请求。
    * @param voiceFormat 语音消息类型，0-Amr 1-Silk，默认0。可通过该参数控制返回的语音格式
-   * @return 微信消息
+   * @return 微信消息 wx cp kf msg list resp
    * @throws WxErrorException 异常
    */
   WxCpKfMsgListResp syncMsg(String cursor, String token, Integer limit, Integer voiceFormat)
@@ -156,8 +143,9 @@ public interface WxCpKfService {
    * 当微信客户处于“新接入待处理”或“由智能助手接待”状态下，可调用该接口给用户发送消息。
    * 注意仅当微信客户在主动发送消息给客服后的48小时内，企业可发送消息给客户，最多可发送5条消息；若用户继续发送消息，企业可再次下发消息。
    * 支持发送消息类型：文本、图片、语音、视频、文件、图文、小程序、菜单消息、地理位置。
+   *
    * @param request 发送信息
-   * @return 发送结果
+   * @return 发送结果 wx cp kf msg send resp
    * @throws WxErrorException 异常
    */
   WxCpKfMsgSendResp sendMsg(WxCpKfMsgSendRequest request) throws WxErrorException;
@@ -167,9 +155,9 @@ public interface WxCpKfService {
    * 当特定的事件回调消息包含code字段，或通过接口变更到特定的会话状态，会返回code字段。
    * 开发者可以此code为凭证，调用该接口给用户发送相应事件场景下的消息，如客服欢迎语、客服提示语和会话结束语等。
    * 除"用户进入会话事件"以外，响应消息仅支持会话处于获取该code的会话状态时发送，如将会话转入待接入池时获得的code仅能在会话状态为”待接入池排队中“时发送。
-   *
+   * 

    * 目前支持的事件场景和相关约束如下：
-   *
+   * 

    * 事件场景	                  允许下发条数	code有效期	  支持的消息类型	  获取code途径
    * 用户进入会话，用于发送客服欢迎语	1条	        20秒	      文本、菜单	    事件回调
    * 进入接待池，用于发送排队提示语等	1条	        48小时	      文本	          转接会话接口
@@ -178,17 +166,19 @@ public interface WxCpKfService {
    * 等	                        1条	        48小时	      文本	          事件回调、转接会话接口
    * 结束会话，用于发送结束会话提示语
    * 或满意度评价等	              1条	        20秒	      文本、菜单	    事件回调、转接会话接口
-   * @param request
-   * @return
-   * @throws WxErrorException
+   *
+   * @param request the request
+   * @return wx cp kf msg send resp
+   * @throws WxErrorException the wx error exception
    */
   WxCpKfMsgSendResp sendMsgOnEvent(WxCpKfMsgSendRequest request) throws WxErrorException;
 
   /**
    * 获取客户基础信息
-   * @param externalUserIdList
-   * @return
-   * @throws WxErrorException
+   *
+   * @param externalUserIdList the external user id list
+   * @return wx cp kf customer batch get resp
+   * @throws WxErrorException the wx error exception
    */
   WxCpKfCustomerBatchGetResp customerBatchGet(List externalUserIdList)
     throws WxErrorException;
@@ -198,52 +188,60 @@ public interface WxCpKfService {
    * 获取「客户数据统计」企业汇总数据
    * 通过此接口，可以获取咨询会话数、咨询客户数等企业汇总统计数据
    * 请求方式：POST(HTTPS)
-   * 请求地址：https://qyapi.weixin.qq.com/cgi-bin/kf/get_corp_statistic?access_token=ACCESS_TOKEN
-   * 文档地址：https://developer.work.weixin.qq.com/document/path/95489
+   * 请求地址：
+   * https://qyapi.weixin.qq.com/cgi-bin/kf/get_corp_statistic?access_token=ACCESS_TOKEN
+   * 文档地址：
+   * https://developer.work.weixin.qq.com/document/path/95489
    * 
    * @param request 查询参数
-   * @return 客户数据统计-企业汇总数据
+   * @return 客户数据统计 -企业汇总数据
+   * @throws WxErrorException the wx error exception
    */
   WxCpKfGetCorpStatisticResp getCorpStatistic(WxCpKfGetCorpStatisticRequest request) throws WxErrorException;
 
   // 「升级服务」配置
+
   /**
    * 获取配置的专员与客户群
-   * @return
-   * @throws WxErrorException
+   *
+   * @return upgrade service config
+   * @throws WxErrorException the wx error exception
    */
   WxCpKfServiceUpgradeConfigResp getUpgradeServiceConfig() throws WxErrorException;
 
   /**
    * 升级专员服务
-   * @param openKfid 客服帐号ID
+   *
+   * @param openKfid       客服帐号ID
    * @param externalUserId 微信客户的external_userid
-   * @param userid 服务专员的userid
-   * @param wording 推荐语
-   * @return
-   * @throws WxErrorException
+   * @param userid         服务专员的userid
+   * @param wording        推荐语
+   * @return wx cp base resp
+   * @throws WxErrorException the wx error exception
    */
   WxCpBaseResp upgradeMemberService(String openKfid, String externalUserId,
-    String userid, String wording) throws WxErrorException;
+                                    String userid, String wording) throws WxErrorException;
 
   /**
    * 升级客户群服务
-   * @param openKfid 客服帐号ID
+   *
+   * @param openKfid       客服帐号ID
    * @param externalUserId 微信客户的external_userid
-   * @param chatId 客户群id
-   * @param wording 推荐语
-   * @return
-   * @throws WxErrorException
+   * @param chatId         客户群id
+   * @param wording        推荐语
+   * @return wx cp base resp
+   * @throws WxErrorException the wx error exception
    */
   WxCpBaseResp upgradeGroupchatService(String openKfid, String externalUserId,
-    String chatId, String wording) throws WxErrorException;
+                                       String chatId, String wording) throws WxErrorException;
 
   /**
    * 为客户取消推荐
-   * @param openKfid 客服帐号ID
+   *
+   * @param openKfid       客服帐号ID
    * @param externalUserId 微信客户的external_userid
-   * @return
-   * @throws WxErrorException
+   * @return wx cp base resp
+   * @throws WxErrorException the wx error exception
    */
   WxCpBaseResp cancelUpgradeService(String openKfid, String externalUserId)
     throws WxErrorException;
diff --git a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/api/WxCpLivingService.java b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/api/WxCpLivingService.java
index 240a99943..a2e234419 100644
--- a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/api/WxCpLivingService.java
+++ b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/api/WxCpLivingService.java
@@ -8,8 +8,7 @@ import me.chanjar.weixin.cp.bean.living.*;
  * 企业微信直播接口.
  * 官方文档：https://work.weixin.qq.com/api/doc/90000/90135/93633
  *
- * @author Wang_Wong
- * created on  2021-12-21
+ * @author Wang_Wong  created on  2021-12-21
  */
 public interface WxCpLivingService {
 
@@ -18,7 +17,7 @@ public interface WxCpLivingService {
    * 请求方式： POST（HTTPS）
    * 请求地址： https://qyapi.weixin.qq.com/cgi-bin/living/get_living_code?access_token=ACCESS_TOKEN
    *
-   * @param openId 用户openid
+   * @param openId   用户openid
    * @param livingId 直播id
    * @return living_code 微信观看直播凭证
    * @throws WxErrorException the wx error exception
@@ -31,7 +30,7 @@ public interface WxCpLivingService {
    * 请求地址：https://qyapi.weixin.qq.com/cgi-bin/living/get_living_info?access_token=ACCESS_TOKEN&livingid=LIVINGID
    *
    * @param livingId 直播id
-   * @return 获取的直播详情
+   * @return 获取的直播详情 living info
    * @throws WxErrorException the wx error exception
    */
   WxCpLivingInfo getLivingInfo(@NonNull String livingId) throws WxErrorException;
@@ -39,42 +38,42 @@ public interface WxCpLivingService {
   /**
    * 获取直播观看明细
    * 通过该接口可以获取所有观看直播的人员统计
-   *
+   * 

    * 请求方式：POST（HTTPS）
    * 请求地址：https://qyapi.weixin.qq.com/cgi-bin/living/get_watch_stat?access_token=ACCESS_TOKEN
    *
    * @param livingId 直播id
-   * @param nextKey 上一次调用时返回的next_key，初次调用可以填”0”
-   * @return
-   * @throws WxErrorException
+   * @param nextKey  上一次调用时返回的next_key，初次调用可以填”0”
+   * @return watch stat
+   * @throws WxErrorException the wx error exception
    */
   WxCpWatchStat getWatchStat(@NonNull String livingId, String nextKey) throws WxErrorException;
 
   /**
    * 获取成员直播ID列表
    * 通过此接口可以获取指定成员的所有直播ID
-   *
+   * 

    * 请求方式：POST（HTTPS）
    * 请求地址：https://qyapi.weixin.qq.com/cgi-bin/living/get_user_all_livingid?access_token=ACCESS_TOKEN
    *
    * @param userId 企业成员的userid
    * @param cursor 上一次调用时返回的next_cursor，第一次拉取可以不填
-   * @param limit 每次拉取的数据量，默认值和最大值都为100
-   * @return
-   * @throws WxErrorException
+   * @param limit  每次拉取的数据量，默认值和最大值都为100
+   * @return user all living id
+   * @throws WxErrorException the wx error exception
    */
   WxCpLivingResult.LivingIdResult getUserAllLivingId(@NonNull String userId, String cursor, Integer limit) throws WxErrorException;
 
   /**
    * 获取跳转小程序商城的直播观众信息
    * 通过此接口，开发者可获取跳转小程序商城的直播间(“推广产品”直播)观众id、邀请人id及对应直播间id，以打通卖货直播的“人货场”信息闭环。
-   *
+   * 

    * 请求方式：POST（HTTPS）
    * 请求地址：https://qyapi.weixin.qq.com/cgi-bin/living/get_living_share_info?access_token=ACCESS_TOKEN
    *
    * @param wwShareCode "推广产品"直播观众跳转小程序商城时会在小程序path中带上ww_share_code=xxxxx参数
-   * @return
-   * @throws WxErrorException
+   * @return living share info
+   * @throws WxErrorException the wx error exception
    */
   WxCpLivingShareInfo getLivingShareInfo(@NonNull String wwShareCode) throws WxErrorException;
 
@@ -84,8 +83,8 @@ public interface WxCpLivingService {
    * 请求地址： https://qyapi.weixin.qq.com/cgi-bin/living/create?access_token=ACCESS_TOKEN
    *
    * @param request 创建预约直播请求参数.
-   * @return livingId（直播id）
-   * @throws WxErrorException
+   * @return livingId （直播id）
+   * @throws WxErrorException the wx error exception
    */
   String livingCreate(WxCpLivingCreateRequest request) throws WxErrorException;
 
@@ -95,8 +94,8 @@ public interface WxCpLivingService {
    * 请求地址： https://qyapi.weixin.qq.com/cgi-bin/living/modify?access_token=ACCESS_TOKEN
    *
    * @param request 修改预约直播请求参数.
-   * @return
-   * @throws WxErrorException
+   * @return wx cp living result
+   * @throws WxErrorException the wx error exception
    */
   WxCpLivingResult livingModify(WxCpLivingModifyRequest request) throws WxErrorException;
 
@@ -106,8 +105,8 @@ public interface WxCpLivingService {
    * 请求地址： https://qyapi.weixin.qq.com/cgi-bin/living/cancel?access_token=ACCESS_TOKEN
    *
    * @param livingId 直播id，仅允许取消预约状态下的直播id
-   * @return
-   * @throws WxErrorException
+   * @return wx cp living result
+   * @throws WxErrorException the wx error exception
    */
   WxCpLivingResult livingCancel(@NonNull String livingId) throws WxErrorException;
 
@@ -117,8 +116,8 @@ public interface WxCpLivingService {
    * 请求地址： https://qyapi.weixin.qq.com/cgi-bin/living/delete_replay_data?access_token=ACCESS_TOKEN
    *
    * @param livingId 直播id
-   * @return
-   * @throws WxErrorException
+   * @return wx cp living result
+   * @throws WxErrorException the wx error exception
    */
   WxCpLivingResult deleteReplayData(@NonNull String livingId) throws WxErrorException;
 
diff --git a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/api/WxCpMediaService.java b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/api/WxCpMediaService.java
index d9b53f250..d0d4b661b 100644
--- a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/api/WxCpMediaService.java
+++ b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/api/WxCpMediaService.java
@@ -31,6 +31,9 @@ public interface WxCpMediaService {
    * @param mediaType   媒体类型, 请看{@link me.chanjar.weixin.common.api.WxConsts}
    * @param fileType    文件类型，请看{@link me.chanjar.weixin.common.api.WxConsts}
    * @param inputStream 输入流，需要调用方控制关闭该输入流
+   * @return the wx media upload result
+   * @throws WxErrorException the wx error exception
+   * @throws IOException      the io exception
    */
   WxMediaUploadResult upload(String mediaType, String fileType, InputStream inputStream)
     throws WxErrorException, IOException;
@@ -43,9 +46,9 @@ public interface WxCpMediaService {
    * @param mediaType 媒体类型, 请看{@link me.chanjar.weixin.common.api.WxConsts}
    * @param filename  文件名.例如：wework.txt
    * @param url       远程链接
-   * @return
-   * @throws WxErrorException
-   * @throws IOException
+   * @return wx media upload result
+   * @throws WxErrorException the wx error exception
+   * @throws IOException      the io exception
    */
   WxMediaUploadResult upload(String mediaType, String filename, String url)
     throws WxErrorException, IOException;
@@ -55,7 +58,9 @@ public interface WxCpMediaService {
    *
    * @param mediaType 媒体类型
    * @param file      文件对象
-   * @see #upload(String, String, InputStream)
+   * @return the wx media upload result
+   * @throws WxErrorException the wx error exception
+   * @see #upload(String, String, InputStream) #upload(String, String, InputStream)
    */
   WxMediaUploadResult upload(String mediaType, File file) throws WxErrorException;
 
@@ -67,7 +72,8 @@ public interface WxCpMediaService {
    * 

    *
    * @param mediaId 媒体id
-   * @return 保存到本地的临时文件
+   * @return 保存到本地的临时文件 file
+   * @throws WxErrorException the wx error exception
    */
   File download(String mediaId) throws WxErrorException;
 
@@ -82,7 +88,8 @@ public interface WxCpMediaService {
    * 

    *
    * @param mediaId 媒体id
-   * @return 保存到本地的临时文件
+   * @return 保存到本地的临时文件 jssdk file
+   * @throws WxErrorException the wx error exception
    */
   File getJssdkFile(String mediaId) throws WxErrorException;
 
@@ -96,7 +103,8 @@ public interface WxCpMediaService {
    * 

    *
    * @param file 上传的文件对象
-   * @return 返回图片url
+   * @return 返回图片url string
+   * @throws WxErrorException the wx error exception
    */
   String uploadImg(File file) throws WxErrorException;
 }
diff --git a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/api/WxCpMenuService.java b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/api/WxCpMenuService.java
index 309b98121..07f300dd1 100644
--- a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/api/WxCpMenuService.java
+++ b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/api/WxCpMenuService.java
@@ -22,7 +22,8 @@ public interface WxCpMenuService {
    * 

    *
    * @param menu 菜单对象
-   * @see #create(Integer, WxMenu)
+   * @throws WxErrorException the wx error exception
+   * @see #create(Integer, WxMenu) #create(Integer, WxMenu)
    */
   void create(WxMenu menu) throws WxErrorException;
 
@@ -36,7 +37,8 @@ public interface WxCpMenuService {
    *
    * @param agentId 企业号应用的id
    * @param menu    菜单对象
-   * @see #create(me.chanjar.weixin.common.bean.menu.WxMenu)
+   * @throws WxErrorException the wx error exception
+   * @see #create(me.chanjar.weixin.common.bean.menu.WxMenu) #create(me.chanjar.weixin.common.bean.menu.WxMenu)
    */
   void create(Integer agentId, WxMenu menu) throws WxErrorException;
 
@@ -48,7 +50,8 @@ public interface WxCpMenuService {
    * 注意: 这个方法使用WxCpConfigStorage里的agentId
    * 

    *
-   * @see #delete(Integer)
+   * @throws WxErrorException the wx error exception
+   * @see #delete(Integer) #delete(Integer)
    */
   void delete() throws WxErrorException;
 
@@ -61,7 +64,8 @@ public interface WxCpMenuService {
    * 

    *
    * @param agentId 企业号应用的id
-   * @see #delete()
+   * @throws WxErrorException the wx error exception
+   * @see #delete() #delete()
    */
   void delete(Integer agentId) throws WxErrorException;
 
@@ -73,7 +77,9 @@ public interface WxCpMenuService {
    * 注意: 这个方法使用WxCpConfigStorage里的agentId
    * 

    *
-   * @see #get(Integer)
+   * @return the wx menu
+   * @throws WxErrorException the wx error exception
+   * @see #get(Integer) #get(Integer)
    */
   WxMenu get() throws WxErrorException;
 
@@ -86,7 +92,9 @@ public interface WxCpMenuService {
    *
* * @param agentId 企业号应用的id - * @see #get() + * @return the wx menu + * @throws WxErrorException the wx error exception + * @see #get() #get() */ WxMenu get(Integer agentId) throws WxErrorException; } diff --git a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/api/WxCpMessageService.java b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/api/WxCpMessageService.java index 23caec4e9..fa455bc5f 100644 --- a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/api/WxCpMessageService.java +++ b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/api/WxCpMessageService.java @@ -6,8 +6,7 @@ import me.chanjar.weixin.cp.bean.message.*; /** * 消息推送接口. * - * @author Binary Wang - * created on 2020 -08-30 + * @author Binary Wang created on 2020 -08-30 */ public interface WxCpMessageService { /** @@ -32,7 +31,7 @@ public interface WxCpMessageService { * * * @param timeType 查询哪天的数据，0：当天；1：昨天。默认为0。 - * @return 统计结果 + * @return 统计结果 statistics * @throws WxErrorException the wx error exception */ WxCpMessageSendStatistics getStatistics(int timeType) throws WxErrorException; @@ -61,8 +60,8 @@ public interface WxCpMessageService { * 请求地址： https://qyapi.weixin.qq.com/cgi-bin/externalcontact/message/send?access_token=ACCESS_TOKEN * * @param message 要发送的消息对象 - * @return - * @throws WxErrorException + * @return wx cp school contact message send result + * @throws WxErrorException the wx error exception */ WxCpSchoolContactMessageSendResult sendSchoolContactMessage(WxCpSchoolContactMessage message) throws WxErrorException; diff --git a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/api/WxCpMsgAuditService.java b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/api/WxCpMsgAuditService.java index 09a25f9d2..69ecfa23d 100644 --- a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/api/WxCpMsgAuditService.java +++ b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/api/WxCpMsgAuditService.java @@ -13,8 +13,7 @@ import java.util.List; * 如需自行实现，亦可调用Finance类库函数，进行实现： * com.tencent.wework.Finance * - * @author Wang_Wong - * created on 2022-01-14 + * @author Wang_Wong created on 2022-01-14 */ public interface WxCpMsgAuditService { @@ -26,7 +25,8 @@ public interface WxCpMsgAuditService { * @param proxy 使用代理的请求，需要传入代理的链接。如：socks5://10.0.0.1:8081 或者 http://10.0.0.1:8081，如果没有传null * @param passwd 代理账号密码，需要传入代理的账号密码。如 user_name:passwd_123，如果没有传null * @param timeout 超时时间，根据实际需要填写 - * @return 返回是否调用成功 + * @return 返回是否调用成功 chat datas + * @throws Exception the exception */ WxCpChatDatas getChatDatas(long seq, @NonNull long limit, String proxy, String passwd, @NonNull long timeout) throws Exception; @@ -36,10 +36,11 @@ public interface WxCpMsgAuditService { * @param sdk getChatDatas()获取到的sdk * @param chatData getChatDatas()获取到的聊天数据 * @param pkcs1 使用什么方式进行解密，1代表使用PKCS1进行解密，2代表PKCS8进行解密 ... - * @return 解密后的聊天数据 - * @throws Exception + * @return 解密后的聊天数据 decrypt data + * @throws Exception the exception */ - WxCpChatModel getDecryptData(@NonNull long sdk, @NonNull WxCpChatDatas.WxCpChatData chatData, @NonNull Integer pkcs1) throws Exception; + WxCpChatModel getDecryptData(@NonNull long sdk, @NonNull WxCpChatDatas.WxCpChatData chatData, + @NonNull Integer pkcs1) throws Exception; /** * 获取解密的聊天数据明文 @@ -47,8 +48,8 @@ public interface WxCpMsgAuditService { * @param sdk getChatDatas()获取到的sdk * @param chatData getChatDatas()获取到的聊天数据 * @param pkcs1 使用什么方式进行解密，1代表使用PKCS1进行解密，2代表PKCS8进行解密 ... - * @return 解密后的明文 - * @throws Exception + * @return 解密后的明文 chat plain text + * @throws Exception the exception */ String getChatPlainText(@NonNull long sdk, @NonNull WxCpChatDatas.WxCpChatData chatData, @NonNull Integer pkcs1) throws Exception; @@ -66,9 +67,10 @@ public interface WxCpMsgAuditService { * @param passwd 代理账号密码，需要传入代理的账号密码。如 user_name:passwd_123，如果没有传null * @param timeout 超时时间，分片数据需累加到文件存储。单次最大返回512K字节，如果文件比较大，自行设置长一点，比如timeout=10000 * @param targetFilePath 目标文件绝对路径+实际文件名，比如：/usr/local/file/20220114/474f866b39d10718810d55262af82662.gif - * @throws WxErrorException + * @throws WxErrorException the wx error exception */ - void getMediaFile(@NonNull long sdk, @NonNull String sdkfileid, String proxy, String passwd, @NonNull long timeout, @NonNull String targetFilePath) throws WxErrorException; + void getMediaFile(@NonNull long sdk, @NonNull String sdkfileid, String proxy, String passwd, @NonNull long timeout, + @NonNull String targetFilePath) throws WxErrorException; /** * 获取会话内容存档开启成员列表 @@ -78,8 +80,8 @@ public interface WxCpMsgAuditService { * 请求地址：https://qyapi.weixin.qq.com/cgi-bin/msgaudit/get_permit_user_list?access_token=ACCESS_TOKEN * * @param type 拉取对应版本的开启成员列表。1表示办公版；2表示服务版；3表示企业版。非必填，不填写的时候返回全量成员列表。 - * @return - * @throws WxErrorException + * @return permit user list + * @throws WxErrorException the wx error exception */ List getPermitUserList(Integer type) throws WxErrorException; @@ -91,8 +93,8 @@ public interface WxCpMsgAuditService { * 请求地址：https://qyapi.weixin.qq.com/cgi-bin/msgaudit/groupchat/get?access_token=ACCESS_TOKEN * * @param roomid 待查询的群id - * @return - * @throws WxErrorException + * @return group chat + * @throws WxErrorException the wx error exception */ WxCpGroupChat getGroupChat(@NonNull String roomid) throws WxErrorException; @@ -105,8 +107,8 @@ public interface WxCpMsgAuditService { * 请求方式：POST（HTTPS） * * @param checkAgreeRequest 待查询的会话信息 - * @return - * @throws WxErrorException + * @return wx cp agree info + * @throws WxErrorException the wx error exception */ WxCpAgreeInfo checkSingleAgree(@NonNull WxCpCheckAgreeRequest checkAgreeRequest) throws WxErrorException; diff --git a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/api/WxCpOAuth2Service.java b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/api/WxCpOAuth2Service.java index f524ac94b..a2c47437b 100644 --- a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/api/WxCpOAuth2Service.java +++ b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/api/WxCpOAuth2Service.java @@ -22,7 +22,7 @@ public interface WxCpOAuth2Service { * * * @param state 状态码 - * @return url + * @return url string */ String buildAuthorizationUrl(String state); @@ -34,7 +34,7 @@ public interface WxCpOAuth2Service { * * @param redirectUri 跳转链接地址 * @param state 状态码 - * @return url + * @return url string */ String buildAuthorizationUrl(String redirectUri, String state); @@ -47,7 +47,7 @@ public interface WxCpOAuth2Service { * @param redirectUri 跳转链接地址 * @param state 状态码 * @param scope 取值参考me.chanjar.weixin.common.api.WxConsts.OAuth2Scope类 - * @return url + * @return url string */ String buildAuthorizationUrl(String redirectUri, String state, String scope); @@ -61,9 +61,9 @@ public interface WxCpOAuth2Service { * * * @param code 微信oauth授权返回的代码 - * @return WxCpOauth2UserInfo + * @return WxCpOauth2UserInfo user info * @throws WxErrorException 异常 - * @see #getUserInfo(Integer, String) + * @see #getUserInfo(Integer, String) #getUserInfo(Integer, String) */ WxCpOauth2UserInfo getUserInfo(String code) throws WxErrorException; @@ -80,9 +80,9 @@ public interface WxCpOAuth2Service { * * @param agentId 企业号应用的id * @param code 通过成员授权获取到的code，最大为512字节。每次成员授权带上的code将不一样，code只能使用一次，5分钟未被使用自动过期。 - * @return WxCpOauth2UserInfo + * @return WxCpOauth2UserInfo user info * @throws WxErrorException 异常 - * @see #getUserInfo(String) + * @see #getUserInfo(String) #getUserInfo(String) */ WxCpOauth2UserInfo getUserInfo(Integer agentId, String code) throws WxErrorException; @@ -93,9 +93,9 @@ public interface WxCpOAuth2Service { * 请求方式：GET（HTTPS） * 请求地址：https://qyapi.weixin.qq.com/cgi-bin/school/getuserinfo?access_token=ACCESS_TOKEN&code=CODE * - * @param code - * @return - * @throws WxErrorException + * @param code the code + * @return school user info + * @throws WxErrorException the wx error exception */ WxCpOauth2UserInfo getSchoolUserInfo(String code) throws WxErrorException; @@ -112,7 +112,7 @@ public interface WxCpOAuth2Service { * * * @param userTicket 成员票据 - * @return WxCpUserDetail + * @return WxCpUserDetail user detail * @throws WxErrorException 异常 */ WxCpUserDetail getUserDetail(String userTicket) throws WxErrorException; diff --git a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/api/WxCpOaAgentService.java b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/api/WxCpOaAgentService.java index 61b704460..6b8b98877 100644 --- a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/api/WxCpOaAgentService.java +++ b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/api/WxCpOaAgentService.java @@ -8,21 +8,20 @@ import me.chanjar.weixin.cp.bean.oa.selfagent.WxCpOpenApprovalData; * 企业微信自建应用接口. * https://developer.work.weixin.qq.com/document/path/90269 * - * @author Wang_Wong - * created on 2022-04-06 + * @author Wang_Wong created on 2022-04-06 */ public interface WxCpOaAgentService { /** * 查询第三方应用审批申请当前状态 * 开发者也可主动查询审批单的当前审批状态。 - * + *

* 请求方式： POST（HTTPS） * 请求地址： https://qyapi.weixin.qq.com/cgi-bin/corp/getopenapprovaldata?access_token=ACCESS_TOKEN * - * @param thirdNo - * @return - * @throws WxErrorException + * @param thirdNo the third no + * @return open approval data + * @throws WxErrorException the wx error exception */ WxCpOpenApprovalData getOpenApprovalData(@NonNull String thirdNo) throws WxErrorException; diff --git a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/api/WxCpOaCalendarService.java b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/api/WxCpOaCalendarService.java index fe419f15f..50d5e8d94 100644 --- a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/api/WxCpOaCalendarService.java +++ b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/api/WxCpOaCalendarService.java @@ -8,8 +8,7 @@ import java.util.List; /** * 企业微信日历接口. * - * @author Binary Wang - * created on 2020-09-20 + * @author Binary Wang created on 2020-09-20 */ public interface WxCpOaCalendarService { /** @@ -24,7 +23,7 @@ public interface WxCpOaCalendarService { * * * @param calendar 日历对象 - * @return 日历ID + * @return 日历ID string * @throws WxErrorException . */ String add(WxCpOaCalendar calendar) throws WxErrorException; @@ -60,7 +59,7 @@ public interface WxCpOaCalendarService { * * * @param calIds 日历id列表 - * @return 日历对象列表 + * @return 日历对象列表 list * @throws WxErrorException . */ List get(List calIds) throws WxErrorException; diff --git a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/api/WxCpOaMeetingRoomService.java b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/api/WxCpOaMeetingRoomService.java index 13013c2dc..94535fe1d 100644 --- a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/api/WxCpOaMeetingRoomService.java +++ b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/api/WxCpOaMeetingRoomService.java @@ -8,8 +8,7 @@ import java.util.List; /** * 企业微信会议室接口. * - * @author lm93129 - * created on 2022年8月12日22:33:36 + * @author lm93129 created on 2022年8月12日22:33:36 */ public interface WxCpOaMeetingRoomService { /** @@ -23,7 +22,7 @@ public interface WxCpOaMeetingRoomService { * * * @param meetingRoom 会议室对象 - * @return 会议室ID + * @return 会议室ID string * @throws WxErrorException . */ String addMeetingRoom(WxCpOaMeetingRoom meetingRoom) throws WxErrorException; @@ -39,7 +38,7 @@ public interface WxCpOaMeetingRoomService { * * * @param meetingRoomRequest 会议室查询对象 - * @return 会议室ID + * @return 会议室ID list * @throws WxErrorException . */ List listMeetingRoom(WxCpOaMeetingRoom meetingRoomRequest) throws WxErrorException; diff --git a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/api/WxCpOaScheduleService.java b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/api/WxCpOaScheduleService.java index 7dcca682b..70c108a05 100644 --- a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/api/WxCpOaScheduleService.java +++ b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/api/WxCpOaScheduleService.java @@ -9,8 +9,7 @@ import java.util.List; * 企业微信日程接口. * 官方文档：https://work.weixin.qq.com/api/doc/90000/90135/93648 * - * @author Binary Wang - * created on 2020 -12-25 + * @author Binary Wang created on 2020 -12-25 */ public interface WxCpOaScheduleService { /** diff --git a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/api/WxCpOaService.java b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/api/WxCpOaService.java index 756df126f..ff60b352d 100644 --- a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/api/WxCpOaService.java +++ b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/api/WxCpOaService.java @@ -11,8 +11,7 @@ import java.util.List; /** * 企业微信OA相关接口. * - * @author Element & Wang_Wong - * created on 2019-04-06 10:52 + * @author Element & Wang_Wong created on 2019-04-06 10:52 */ public interface WxCpOaService { @@ -68,7 +67,7 @@ public interface WxCpOaService { * API doc : https://work.weixin.qq.com/api/doc/90000/90135/93384 * * - * @return 打卡规则列表 + * @return 打卡规则列表 crop checkin option * @throws WxErrorException the wx error exception */ List getCropCheckinOption() throws WxErrorException; @@ -104,7 +103,8 @@ public interface WxCpOaService { * @param endTime 结束时间 * @return WxCpApprovalInfo approval info * @throws WxErrorException . - * @see me.chanjar.weixin.cp.api.WxCpOaService#getApprovalInfo me.chanjar.weixin.cp.api.WxCpOaService#getApprovalInfo + * @see me.chanjar.weixin.cp.api.WxCpOaService#getApprovalInfo me.chanjar.weixin.cp.api + * .WxCpOaService#getApprovalInfome.chanjar.weixin.cp.api.WxCpOaService#getApprovalInfo */ WxCpApprovalInfo getApprovalInfo(@NonNull Date startTime, @NonNull Date endTime) throws WxErrorException; @@ -129,12 +129,12 @@ public interface WxCpOaService { * 获取企业假期管理配置 * 企业可通过审批应用或自建应用Secret调用本接口，获取可见范围内员工的“假期管理”配置，包括：各个假期的id、名称、请假单位、时长计算方式、发放规则等。 * 第三方应用可获取应用可见范围内员工的“假期管理”配置，包括：各个假期的id、名称、请假单位、时长计算方式、发放规则等。 - * + *

* 请求方式：GET(HTTPS) * 请求地址：https://qyapi.weixin.qq.com/cgi-bin/oa/vacation/getcorpconf?access_token=ACCESS_TOKEN * - * @return - * @throws WxErrorException + * @return corp conf + * @throws WxErrorException the wx error exception */ WxCpCorpConfInfo getCorpConf() throws WxErrorException; @@ -143,13 +143,13 @@ public interface WxCpOaService { * 获取成员假期余额 * 企业可通过审批应用或自建应用Secret调用本接口，获取可见范围内各个员工的假期余额数据。 * 第三方应用可获取应用可见范围内各个员工的假期余额数据。 - * + *

* 请求方式：POST(HTTPS) * 请求地址：https://qyapi.weixin.qq.com/cgi-bin/oa/vacation/getuservacationquota?access_token=ACCESS_TOKEN * * @param userId 需要获取假期余额的成员的userid - * @return - * @throws WxErrorException + * @return user vacation quota + * @throws WxErrorException the wx error exception */ WxCpUserVacationQuota getUserVacationQuota(@NonNull String userId) throws WxErrorException; @@ -158,15 +158,15 @@ public interface WxCpOaService { * 获取审批数据（旧） * 提示：推荐使用新接口“批量获取审批单号”及“获取审批申请详情”，此接口后续将不再维护、逐步下线。 * 通过本接口来获取公司一段时间内的审批记录。一次拉取调用最多拉取100个审批记录，可以通过多次拉取的方式来满足需求，但调用频率不可超过600次/分。 - * + *

* 请求方式：POST（HTTPS） * 请求地址：https://qyapi.weixin.qq.com/cgi-bin/corp/getapprovaldata?access_token=ACCESS_TOKEN * * @param startTime 获取审批记录的开始时间。Unix时间戳 - * @param endTime 获取审批记录的结束时间。Unix时间戳 + * @param endTime 获取审批记录的结束时间。Unix时间戳 * @param nextSpNum 第一个拉取的审批单号，不填从该时间段的第一个审批单拉取 - * @return - * @throws WxErrorException + * @return approval data + * @throws WxErrorException the wx error exception */ WxCpGetApprovalData getApprovalData(@NonNull Long startTime, @NonNull Long endTime, Long nextSpNum) throws WxErrorException; @@ -175,19 +175,20 @@ public interface WxCpOaService { * 修改成员假期余额 * 企业可通过审批应用或自建应用Secret调用本接口，修改可见范围内员工的“假期余额”。 * 第三方应用可通过应本接口修改应用可见范围内指定员工的“假期余额”。 - * + *

* 请求方式：POST(HTTPS) * 请求地址：https://qyapi.weixin.qq.com/cgi-bin/oa/vacation/setoneuserquota?access_token=ACCESS_TOKEN * - * @param userId 需要修改假期余额的成员的userid - * @param vacationId 假期id + * @param userId 需要修改假期余额的成员的userid + * @param vacationId 假期id * @param leftDuration 设置的假期余额，单位为秒，不能大于1000天或24000小时，当假期时间刻度为按小时请假时，必须为360整倍数，即0.1小时整倍数，按天请假时，必须为8640整倍数，即0.1天整倍数 - * @param timeAttr 假期时间刻度：0-按天请假；1-按小时请假 - * @param remarks 修改备注，用于显示在假期余额的修改记录当中，可对修改行为作说明，不超过200字符 - * @return - * @throws WxErrorException + * @param timeAttr 假期时间刻度：0-按天请假；1-按小时请假 + * @param remarks 修改备注，用于显示在假期余额的修改记录当中，可对修改行为作说明，不超过200字符 + * @return one user quota + * @throws WxErrorException the wx error exception */ - WxCpBaseResp setOneUserQuota(@NonNull String userId, @NonNull Integer vacationId, @NonNull Integer leftDuration, @NonNull Integer timeAttr, String remarks) throws WxErrorException; + WxCpBaseResp setOneUserQuota(@NonNull String userId, @NonNull Integer vacationId, @NonNull Integer leftDuration, + @NonNull Integer timeAttr, String remarks) throws WxErrorException; /** @@ -231,7 +232,7 @@ public interface WxCpOaService { * @param startTime 获取月报的开始时间 * @param endTime 获取月报的结束时间 * @param userIdList 获取月报的userid列表 - * @return 月报数据列表 + * @return 月报数据列表 checkin month data * @throws WxErrorException the wx error exception */ List getCheckinMonthData(Date startTime, Date endTime, List userIdList) throws WxErrorException; @@ -242,7 +243,7 @@ public interface WxCpOaService { * @param startTime 获取排班信息的开始时间。Unix时间戳 * @param endTime 获取排班信息的结束时间。Unix时间戳（与starttime跨度不超过一个月） * @param userIdList 需要获取排班信息的用户列表（不超过100个） - * @return 排班表信息 + * @return 排班表信息 checkin schedule list * @throws WxErrorException the wx error exception */ List getCheckinScheduleList(Date startTime, Date endTime, List userIdList) throws WxErrorException; @@ -255,17 +256,21 @@ public interface WxCpOaService { * @throws WxErrorException the wx error exception */ void setCheckinScheduleList(WxCpSetCheckinSchedule wxCpSetCheckinSchedule) throws WxErrorException; + /** * 

    * 录入打卡人员人脸信息
    * 企业可通过打卡应用Secret调用本接口，为企业打卡人员录入人脸信息，人脸信息仅用于人脸打卡。
    * 上传图片大小限制:图片数据不超过1M
    * 请求方式：POST(HTTPS)
-   * 请求地址：https://qyapi.weixin.qq.com/cgi-bin/checkin/addcheckinuserface?access_token=ACCESS_TOKEN
-   * 文档地址：https://developer.work.weixin.qq.com/document/path/93378
+   * 请求地址：
+   * https://qyapi.weixin.qq.com/cgi-bin/checkin/addcheckinuserface?access_token=ACCESS_TOKEN
+   * 文档地址：
+   * https://developer.work.weixin.qq.com/document/path/93378
    * 
    * @param userId 需要录入的用户id
    * @param userFace 需要录入的人脸图片数据，需要将图片数据base64处理后填入，对已录入的人脸会进行更新处理
+   * @throws WxErrorException the wx error exception
    */
   void addCheckInUserFace(String userId, String userFace) throws WxErrorException;
 }
diff --git a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/api/WxCpOaWeDriveService.java b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/api/WxCpOaWeDriveService.java
index 8954e8693..ad2dc635f 100644
--- a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/api/WxCpOaWeDriveService.java
+++ b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/api/WxCpOaWeDriveService.java
@@ -11,8 +11,7 @@ import java.util.List;
  * 企业微信微盘相关接口.
  * https://developer.work.weixin.qq.com/document/path/93654
  *
- * @author Wang_Wong
- * created on  2022-04-22
+ * @author Wang_Wong created on  2022-04-22
  */
 public interface WxCpOaWeDriveService {
 
@@ -24,8 +23,8 @@ public interface WxCpOaWeDriveService {
    * 请求地址: https://qyapi.weixin.qq.com/cgi-bin/wedrive/space_create?access_token=ACCESS_TOKEN
    *
    * @param request 新建空间对应请求参数
-   * @return spaceid（空间id）
-   * @throws WxErrorException
+   * @return spaceid （空间id）
+   * @throws WxErrorException the wx error exception
    */
   WxCpSpaceCreateData spaceCreate(@NonNull WxCpSpaceCreateRequest request) throws WxErrorException;
 
@@ -37,8 +36,8 @@ public interface WxCpOaWeDriveService {
    * 请求地址: https://qyapi.weixin.qq.com/cgi-bin/wedrive/space_rename?access_token=ACCESS_TOKEN
    *
    * @param request 重命名空间的请求参数
-   * @return
-   * @throws WxErrorException
+   * @return wx cp base resp
+   * @throws WxErrorException the wx error exception
    */
   WxCpBaseResp spaceRename(@NonNull WxCpSpaceRenameRequest request) throws WxErrorException;
 
@@ -49,10 +48,10 @@ public interface WxCpOaWeDriveService {
    * 请求方式：POST（HTTPS）
    * 请求地址: https://qyapi.weixin.qq.com/cgi-bin/wedrive/space_dismiss?access_token=ACCESS_TOKEN
    *
-   * @param userId
-   * @param spaceId
-   * @return
-   * @throws WxErrorException
+   * @param userId  the user id
+   * @param spaceId the space id
+   * @return wx cp base resp
+   * @throws WxErrorException the wx error exception
    */
   WxCpBaseResp spaceDismiss(@NonNull String userId, @NonNull String spaceId) throws WxErrorException;
 
@@ -63,10 +62,10 @@ public interface WxCpOaWeDriveService {
    * 请求方式：POST（HTTPS）
    * 请求地址: https://qyapi.weixin.qq.com/cgi-bin/wedrive/space_info?access_token=ACCESS_TOKEN
    *
-   * @param userId
-   * @param spaceId
-   * @return
-   * @throws WxErrorException
+   * @param userId  the user id
+   * @param spaceId the space id
+   * @return wx cp space info
+   * @throws WxErrorException the wx error exception
    */
   WxCpSpaceInfo spaceInfo(@NonNull String userId, @NonNull String spaceId) throws WxErrorException;
 
@@ -78,8 +77,8 @@ public interface WxCpOaWeDriveService {
    * 请求地址: https://qyapi.weixin.qq.com/cgi-bin/wedrive/space_acl_add?access_token=ACCESS_TOKEN
    *
    * @param request 添加成员/部门请求参数
-   * @return
-   * @throws WxErrorException
+   * @return wx cp base resp
+   * @throws WxErrorException the wx error exception
    */
   WxCpBaseResp spaceAclAdd(@NonNull WxCpSpaceAclAddRequest request) throws WxErrorException;
 
@@ -91,8 +90,8 @@ public interface WxCpOaWeDriveService {
    * 请求地址: https://qyapi.weixin.qq.com/cgi-bin/wedrive/space_acl_del?access_token=ACCESS_TOKEN
    *
    * @param request 移除成员/部门请求参数
-   * @return
-   * @throws WxErrorException
+   * @return wx cp base resp
+   * @throws WxErrorException the wx error exception
    */
   WxCpBaseResp spaceAclDel(@NonNull WxCpSpaceAclDelRequest request) throws WxErrorException;
 
@@ -104,8 +103,8 @@ public interface WxCpOaWeDriveService {
    * 请求地址: https://qyapi.weixin.qq.com/cgi-bin/wedrive/space_setting?access_token=ACCESS_TOKEN
    *
    * @param request 权限管理请求参数
-   * @return
-   * @throws WxErrorException
+   * @return wx cp base resp
+   * @throws WxErrorException the wx error exception
    */
   WxCpBaseResp spaceSetting(@NonNull WxCpSpaceSettingRequest request) throws WxErrorException;
 
@@ -116,10 +115,10 @@ public interface WxCpOaWeDriveService {
    * 请求方式：POST（HTTPS）
    * 请求地址: https://qyapi.weixin.qq.com/cgi-bin/wedrive/space_share?access_token=ACCESS_TOKEN
    *
-   * @param userId
-   * @param spaceId
-   * @return
-   * @throws WxErrorException
+   * @param userId  the user id
+   * @param spaceId the space id
+   * @return wx cp space share
+   * @throws WxErrorException the wx error exception
    */
   WxCpSpaceShare spaceShare(@NonNull String userId, @NonNull String spaceId) throws WxErrorException;
 
@@ -131,8 +130,8 @@ public interface WxCpOaWeDriveService {
    * 请求地址: https://qyapi.weixin.qq.com/cgi-bin/wedrive/file_list?access_token=ACCESS_TOKEN
    *
    * @param request 获取文件列表请求参数
-   * @return
-   * @throws WxErrorException
+   * @return wx cp file list
+   * @throws WxErrorException the wx error exception
    */
   WxCpFileList fileList(@NonNull WxCpFileListRequest request) throws WxErrorException;
 
@@ -144,8 +143,8 @@ public interface WxCpOaWeDriveService {
    * 请求地址: https://qyapi.weixin.qq.com/cgi-bin/wedrive/file_upload?access_token=ACCESS_TOKEN
    *
    * @param request 上传文件请求参数
-   * @return
-   * @throws WxErrorException
+   * @return wx cp file upload
+   * @throws WxErrorException the wx error exception
    */
   WxCpFileUpload fileUpload(@NonNull WxCpFileUploadRequest request) throws WxErrorException;
 
@@ -156,10 +155,10 @@ public interface WxCpOaWeDriveService {
    * 请求方式：POST（HTTPS）
    * 请求地址: https://qyapi.weixin.qq.com/cgi-bin/wedrive/file_download?access_token=ACCESS_TOKEN
    *
-   * @param userId
-   * @param fileId
-   * @return
-   * @throws WxErrorException
+   * @param userId the user id
+   * @param fileId the file id
+   * @return wx cp file download
+   * @throws WxErrorException the wx error exception
    */
   WxCpFileDownload fileDownload(@NonNull String userId, @NonNull String fileId) throws WxErrorException;
 
@@ -170,11 +169,11 @@ public interface WxCpOaWeDriveService {
    * 请求方式：POST（HTTPS）
    * 请求地址: https://qyapi.weixin.qq.com/cgi-bin/wedrive/file_rename?access_token=ACCESS_TOKEN
    *
-   * @param userId
-   * @param fileId
-   * @param newName
-   * @return
-   * @throws WxErrorException
+   * @param userId  the user id
+   * @param fileId  the file id
+   * @param newName the new name
+   * @return wx cp file rename
+   * @throws WxErrorException the wx error exception
    */
   WxCpFileRename fileRename(@NonNull String userId, @NonNull String fileId, @NonNull String newName) throws WxErrorException;
 
@@ -190,8 +189,8 @@ public interface WxCpOaWeDriveService {
    * @param fatherId 父目录fileid, 在根目录时为空间spaceid
    * @param fileType 文件类型, 1:文件夹 3:微文档(文档) 4:微文档(表格)
    * @param fileName 文件名字
-   * @return
-   * @throws WxErrorException
+   * @return wx cp file create
+   * @throws WxErrorException the wx error exception
    */
   WxCpFileCreate fileCreate(@NonNull String userId, @NonNull String spaceId,
                             @NonNull String fatherId, @NonNull Integer fileType, @NonNull String fileName) throws WxErrorException;
@@ -204,8 +203,8 @@ public interface WxCpOaWeDriveService {
    * 请求地址: https://qyapi.weixin.qq.com/cgi-bin/wedrive/file_move?access_token=ACCESS_TOKEN
    *
    * @param request 移动文件的请求参数
-   * @return
-   * @throws WxErrorException
+   * @return wx cp file move
+   * @throws WxErrorException the wx error exception
    */
   WxCpFileMove fileMove(@NonNull WxCpFileMoveRequest request) throws WxErrorException;
 
@@ -218,8 +217,8 @@ public interface WxCpOaWeDriveService {
    *
    * @param userId 操作者userid
    * @param fileId 文件fileid列表
-   * @return
-   * @throws WxErrorException
+   * @return wx cp base resp
+   * @throws WxErrorException the wx error exception
    */
   WxCpBaseResp fileDelete(@NonNull String userId, @NonNull List fileId) throws WxErrorException;
 
@@ -231,8 +230,8 @@ public interface WxCpOaWeDriveService {
    * 请求地址: https://qyapi.weixin.qq.com/cgi-bin/wedrive/file_acl_add?access_token=ACCESS_TOKEN
    *
    * @param request 新增指定人请求参数
-   * @return
-   * @throws WxErrorException
+   * @return wx cp base resp
+   * @throws WxErrorException the wx error exception
    */
   WxCpBaseResp fileAclAdd(@NonNull WxCpFileAclAddRequest request) throws WxErrorException;
 
@@ -244,8 +243,8 @@ public interface WxCpOaWeDriveService {
    * 请求地址: https://qyapi.weixin.qq.com/cgi-bin/wedrive/file_acl_del?access_token=ACCESS_TOKEN
    *
    * @param request 请求参数
-   * @return
-   * @throws WxErrorException
+   * @return wx cp base resp
+   * @throws WxErrorException the wx error exception
    */
   WxCpBaseResp fileAclDel(@NonNull WxCpFileAclDelRequest request) throws WxErrorException;
 
@@ -256,12 +255,12 @@ public interface WxCpOaWeDriveService {
    * 请求方式：POST（HTTPS）
    * 请求地址: https://qyapi.weixin.qq.com/cgi-bin/wedrive/file_setting?access_token=ACCESS_TOKEN
    *
-   * @param userId
-   * @param fileId
-   * @param authScope
-   * @param auth
-   * @return
-   * @throws WxErrorException
+   * @param userId    the user id
+   * @param fileId    the file id
+   * @param authScope the auth scope
+   * @param auth      the auth
+   * @return wx cp base resp
+   * @throws WxErrorException the wx error exception
    */
   WxCpBaseResp fileSetting(@NonNull String userId, @NonNull String fileId, @NonNull Integer authScope, Integer auth) throws WxErrorException;
 
@@ -272,10 +271,10 @@ public interface WxCpOaWeDriveService {
    * 请求方式：POST（HTTPS）
    * 请求地址: https://qyapi.weixin.qq.com/cgi-bin/wedrive/file_share?access_token=ACCESS_TOKEN
    *
-   * @param userId
-   * @param fileId
-   * @return
-   * @throws WxErrorException
+   * @param userId the user id
+   * @param fileId the file id
+   * @return wx cp file share
+   * @throws WxErrorException the wx error exception
    */
   WxCpFileShare fileShare(@NonNull String userId, @NonNull String fileId) throws WxErrorException;
 
@@ -286,10 +285,10 @@ public interface WxCpOaWeDriveService {
    * 请求方式：POST（HTTPS）
    * 请求地址: https://qyapi.weixin.qq.com/cgi-bin/wedrive/file_info?access_token=ACCESS_TOKEN
    *
-   * @param userId
-   * @param fileId
-   * @return
-   * @throws WxErrorException
+   * @param userId the user id
+   * @param fileId the file id
+   * @return wx cp file info
+   * @throws WxErrorException the wx error exception
    */
   WxCpFileInfo fileInfo(@NonNull String userId, @NonNull String fileId) throws WxErrorException;
 
diff --git a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/api/WxCpSchoolHealthService.java b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/api/WxCpSchoolHealthService.java
index 8ee5e8d50..091f24282 100644
--- a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/api/WxCpSchoolHealthService.java
+++ b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/api/WxCpSchoolHealthService.java
@@ -11,8 +11,7 @@ import me.chanjar.weixin.cp.bean.school.health.WxCpGetReportJobInfo;
  * 企业微信家校应用 健康上报接口.
  * https://developer.work.weixin.qq.com/document/path/93676
  *
- * @author Wang_Wong
- * created on : 2022/5/31 9:10
+ * @author Wang_Wong created on : 2022/5/31 9:10
  */
 public interface WxCpSchoolHealthService {
 
@@ -22,8 +21,8 @@ public interface WxCpSchoolHealthService {
    * 请求地址：https://qyapi.weixin.qq.com/cgi-bin/health/get_health_report_stat?access_token=ACCESS_TOKEN
    *
    * @param date 具体某天的使用统计，最长支持获取30天前数据
-   * @return
-   * @throws WxErrorException
+   * @return health report stat
+   * @throws WxErrorException the wx error exception
    */
   WxCpGetHealthReportStat getHealthReportStat(@NonNull String date) throws WxErrorException;
 
@@ -36,8 +35,8 @@ public interface WxCpSchoolHealthService {
    *
    * @param offset 否	分页，偏移量, 默认为0
    * @param limit  否	分页，预期请求的数据量，默认为100，取值范围 1 ~ 100
-   * @return
-   * @throws WxErrorException
+   * @return report job ids
+   * @throws WxErrorException the wx error exception
    */
   WxCpGetReportJobIds getReportJobIds(Integer offset, Integer limit) throws WxErrorException;
 
@@ -50,8 +49,8 @@ public interface WxCpSchoolHealthService {
    *
    * @param jobId 是	任务ID
    * @param date  是	具体某天任务详情，仅支持获取最近14天数据
-   * @return
-   * @throws WxErrorException
+   * @return report job info
+   * @throws WxErrorException the wx error exception
    */
   WxCpGetReportJobInfo getReportJobInfo(@NonNull String jobId, @NonNull String date) throws WxErrorException;
 
@@ -62,12 +61,12 @@ public interface WxCpSchoolHealthService {
    * 请求方式：POST（HTTPS）
    * 请求地址：https://qyapi.weixin.qq.com/cgi-bin/health/get_report_answer?access_token=ACCESS_TOKEN
    *
-   * @param jobId
-   * @param date
-   * @param offset
-   * @param limit
-   * @return
-   * @throws WxErrorException
+   * @param jobId  the job id
+   * @param date   the date
+   * @param offset the offset
+   * @param limit  the limit
+   * @return report answer
+   * @throws WxErrorException the wx error exception
    */
   WxCpGetReportAnswer getReportAnswer(@NonNull String jobId, @NonNull String date, Integer offset, Integer limit) throws WxErrorException;
 
diff --git a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/api/WxCpSchoolService.java b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/api/WxCpSchoolService.java
index 46eab7295..4528abb11 100644
--- a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/api/WxCpSchoolService.java
+++ b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/api/WxCpSchoolService.java
@@ -15,8 +15,7 @@ import java.util.List;
  * 权限说明：
  * 仅复学码应用可以调用
  *
- * @author Wang_Wong
- * created on : 2022/5/31 9:10
+ * @author Wang_Wong created on : 2022/5/31 9:10
  */
 public interface WxCpSchoolService {
 
@@ -25,11 +24,11 @@ public interface WxCpSchoolService {
    * 请求方式： POST（HTTPS）
    * 请求地址： https://qyapi.weixin.qq.com/cgi-bin/school/user/get_teacher_customize_health_info?access_token=ACCESS_TOKEN
    *
-   * @param date
-   * @param nextKey
-   * @param limit
-   * @return
-   * @throws WxErrorException
+   * @param date    the date
+   * @param nextKey the next key
+   * @param limit   the limit
+   * @return teacher customize health info
+   * @throws WxErrorException the wx error exception
    */
   WxCpCustomizeHealthInfo getTeacherCustomizeHealthInfo(@NotNull String date, String nextKey, Integer limit) throws WxErrorException;
 
@@ -38,11 +37,11 @@ public interface WxCpSchoolService {
    * 请求方式： POST（HTTPS）
    * 请求地址： https://qyapi.weixin.qq.com/cgi-bin/school/user/get_student_customize_health_info?access_token=ACCESS_TOKEN
    *
-   * @param date
-   * @param nextKey
-   * @param limit
-   * @return
-   * @throws WxErrorException
+   * @param date    the date
+   * @param nextKey the next key
+   * @param limit   the limit
+   * @return student customize health info
+   * @throws WxErrorException the wx error exception
    */
   WxCpCustomizeHealthInfo getStudentCustomizeHealthInfo(@NotNull String date, String nextKey, Integer limit) throws WxErrorException;
 
@@ -51,10 +50,10 @@ public interface WxCpSchoolService {
    * 请求方式：POST（HTTPS）
    * 请求地址：https://qyapi.weixin.qq.com/cgi-bin/school/user/get_health_qrcode?access_token=ACCESS_TOKEN
    *
-   * @param userIds
-   * @param type
-   * @return
-   * @throws WxErrorException
+   * @param userIds the user ids
+   * @param type    the type
+   * @return health qr code
+   * @throws WxErrorException the wx error exception
    */
   WxCpResultList getHealthQrCode(@NotNull List userIds, @NotNull Integer type) throws WxErrorException;
 
@@ -63,9 +62,9 @@ public interface WxCpSchoolService {
    * 请求方式： POST（HTTPS）
    * 请求地址： https://qyapi.weixin.qq.com/cgi-bin/school/get_payment_result?access_token=ACCESS_TOKEN
    *
-   * @param paymentId
-   * @return
-   * @throws WxErrorException
+   * @param paymentId the payment id
+   * @return payment result
+   * @throws WxErrorException the wx error exception
    */
   WxCpPaymentResult getPaymentResult(@NotNull String paymentId) throws WxErrorException;
 
@@ -74,20 +73,22 @@ public interface WxCpSchoolService {
    * 请求方式： POST（HTTPS）
    * 请求地址： https://qyapi.weixin.qq.com/cgi-bin/school/get_trade?access_token=ACCESS_TOKEN
    *
-   * @param paymentId
-   * @param tradeNo
-   * @return
-   * @throws WxErrorException
+   * @param paymentId the payment id
+   * @param tradeNo   the trade no
+   * @return trade
+   * @throws WxErrorException the wx error exception
    */
   WxCpTrade getTrade(@NotNull String paymentId, @NotNull String tradeNo) throws WxErrorException;
 
   /**
    * 获取直播详情
    * 请求方式：GET（HTTPS）
-   * 请求地址：https://qyapi.weixin.qq.com/cgi-bin/school/living/get_living_info?access_token=ACCESS_TOKEN&livingid=LIVINGID
+   * 请求地址：https://qyapi.weixin.qq.com/cgi-bin/school/living/get_living_info?access_token=ACCESS_TOKEN&livingid
+   * =LIVINGID
    *
-   * @param livingId
-   * @return
+   * @param livingId the living id
+   * @return living info
+   * @throws WxErrorException the wx error exception
    */
   WxCpSchoolLivingInfo getLivingInfo(@NotNull String livingId) throws WxErrorException;
 
@@ -98,11 +99,11 @@ public interface WxCpSchoolService {
    * 请求方式：POST（HTTPS）
    * 请求地址：https://qyapi.weixin.qq.com/cgi-bin/living/get_user_all_livingid?access_token=ACCESS_TOKEN
    *
-   * @param userId
-   * @param cursor
-   * @param limit
-   * @return
-   * @throws WxErrorException
+   * @param userId the user id
+   * @param cursor the cursor
+   * @param limit  the limit
+   * @return user all living id
+   * @throws WxErrorException the wx error exception
    */
   WxCpLivingResult.LivingIdResult getUserAllLivingId(@NonNull String userId, String cursor, Integer limit) throws WxErrorException;
 
@@ -113,10 +114,10 @@ public interface WxCpSchoolService {
    * 请求方式：POST（HTTPS）
    * 请求地址：https://qyapi.weixin.qq.com/cgi-bin/school/living/get_watch_stat?access_token=ACCESS_TOKEN
    *
-   * @param livingId
-   * @param nextKey
-   * @return
-   * @throws WxErrorException
+   * @param livingId the living id
+   * @param nextKey  the next key
+   * @return watch stat
+   * @throws WxErrorException the wx error exception
    */
   WxCpSchoolWatchStat getWatchStat(@NonNull String livingId, String nextKey) throws WxErrorException;
 
@@ -127,10 +128,10 @@ public interface WxCpSchoolService {
    * 请求方式：POST（HTTPS）
    * 请求地址：https://qyapi.weixin.qq.com/cgi-bin/school/living/get_unwatch_stat?access_token=ACCESS_TOKEN
    *
-   * @param livingId
-   * @param nextKey
-   * @return
-   * @throws WxErrorException
+   * @param livingId the living id
+   * @param nextKey  the next key
+   * @return unwatch stat
+   * @throws WxErrorException the wx error exception
    */
   WxCpSchoolUnwatchStat getUnwatchStat(@NonNull String livingId, String nextKey) throws WxErrorException;
 
@@ -139,9 +140,9 @@ public interface WxCpSchoolService {
    * 请求方式： POST（HTTPS）
    * 请求地址： https://qyapi.weixin.qq.com/cgi-bin/living/delete_replay_data?access_token=ACCESS_TOKEN
    *
-   * @param livingId
-   * @return
-   * @throws WxErrorException
+   * @param livingId the living id
+   * @return wx cp living result
+   * @throws WxErrorException the wx error exception
    */
   WxCpLivingResult deleteReplayData(@NonNull String livingId) throws WxErrorException;
 
diff --git a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/api/WxCpSchoolUserService.java b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/api/WxCpSchoolUserService.java
index 18cdc45ed..26cfe3a01 100644
--- a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/api/WxCpSchoolUserService.java
+++ b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/api/WxCpSchoolUserService.java
@@ -12,8 +12,7 @@ import java.util.List;
  * 企业微信家校沟通相关接口.
  * https://developer.work.weixin.qq.com/document/path/91638
  *
- * @author Wang_Wong
- * created on : 2022/6/18 9:10
+ * @author Wang_Wong created on : 2022/6/18 9:10
  */
 public interface WxCpSchoolUserService {
 
@@ -24,9 +23,9 @@ public interface WxCpSchoolUserService {
    * 请求方式：GET（HTTPS）
    * 请求地址：https://qyapi.weixin.qq.com/cgi-bin/user/getuserinfo?access_token=ACCESS_TOKEN&code=CODE
    *
-   * @param code
-   * @return
-   * @throws WxErrorException
+   * @param code the code
+   * @return user info
+   * @throws WxErrorException the wx error exception
    */
   WxCpOauth2UserInfo getUserInfo(@NonNull String code) throws WxErrorException;
 
@@ -37,9 +36,9 @@ public interface WxCpSchoolUserService {
    * 请求方式：GET（HTTPS）
    * 请求地址：https://qyapi.weixin.qq.com/cgi-bin/school/getuserinfo?access_token=ACCESS_TOKEN&code=CODE
    *
-   * @param code
-   * @return
-   * @throws WxErrorException
+   * @param code the code
+   * @return school user info
+   * @throws WxErrorException the wx error exception
    */
   WxCpOauth2UserInfo getSchoolUserInfo(@NonNull String code) throws WxErrorException;
 
@@ -48,11 +47,11 @@ public interface WxCpSchoolUserService {
    * 请求方式：POST（HTTPS）
    * 请求地址：https://qyapi.weixin.qq.com/cgi-bin/school/user/create_student?access_token=ACCESS_TOKEN
    *
-   * @param studentUserId
-   * @param name
-   * @param departments
-   * @return
-   * @throws WxErrorException
+   * @param studentUserId the student user id
+   * @param name          the name
+   * @param departments   the departments
+   * @return wx cp base resp
+   * @throws WxErrorException the wx error exception
    */
   WxCpBaseResp createStudent(@NonNull String studentUserId, @NonNull String name, @NonNull List departments) throws WxErrorException;
 
@@ -61,9 +60,9 @@ public interface WxCpSchoolUserService {
    * 请求方式：POST（HTTPS）
    * 请求地址：https://qyapi.weixin.qq.com/cgi-bin/school/user/batch_create_student?access_token=ACCESS_TOKEN
    *
-   * @param request
-   * @return
-   * @throws WxErrorException
+   * @param request the request
+   * @return wx cp batch result list
+   * @throws WxErrorException the wx error exception
    */
   WxCpBatchResultList batchCreateStudent(@NonNull WxCpBatchCreateStudentRequest request) throws WxErrorException;
 
@@ -72,9 +71,9 @@ public interface WxCpSchoolUserService {
    * 请求方式：POST（HTTPS）
    * 请求地址：https://qyapi.weixin.qq.com/cgi-bin/school/user/batch_delete_student?access_token=ACCESS_TOKEN
    *
-   * @param request
-   * @return
-   * @throws WxErrorException
+   * @param request the request
+   * @return wx cp batch result list
+   * @throws WxErrorException the wx error exception
    */
   WxCpBatchResultList batchDeleteStudent(@NonNull WxCpBatchDeleteStudentRequest request) throws WxErrorException;
 
@@ -83,9 +82,9 @@ public interface WxCpSchoolUserService {
    * 请求方式：POST（HTTPS）
    * 请求地址：https://qyapi.weixin.qq.com/cgi-bin/school/user/batch_update_student?access_token=ACCESS_TOKEN
    *
-   * @param request
-   * @return
-   * @throws WxErrorException
+   * @param request the request
+   * @return wx cp batch result list
+   * @throws WxErrorException the wx error exception
    */
   WxCpBatchResultList batchUpdateStudent(@NonNull WxCpBatchUpdateStudentRequest request) throws WxErrorException;
 
@@ -94,9 +93,9 @@ public interface WxCpSchoolUserService {
    * 请求方式：GET（HTTPS）
    * 请求地址：https://qyapi.weixin.qq.com/cgi-bin/school/user/delete_student?access_token=ACCESS_TOKEN&userid=USERID
    *
-   * @param studentUserId
-   * @return
-   * @throws WxErrorException
+   * @param studentUserId the student user id
+   * @return wx cp base resp
+   * @throws WxErrorException the wx error exception
    */
   WxCpBaseResp deleteStudent(@NonNull String studentUserId) throws WxErrorException;
 
@@ -105,23 +104,24 @@ public interface WxCpSchoolUserService {
    * 请求方式：POST（HTTPS）
    * 请求地址：https://qyapi.weixin.qq.com/cgi-bin/school/user/update_student?access_token=ACCESS_TOKEN
    *
-   * @param studentUserId
-   * @param newStudentUserId
-   * @param name
-   * @param departments
-   * @return
-   * @throws WxErrorException
+   * @param studentUserId    the student user id
+   * @param newStudentUserId the new student user id
+   * @param name             the name
+   * @param departments      the departments
+   * @return wx cp base resp
+   * @throws WxErrorException the wx error exception
    */
-  WxCpBaseResp updateStudent(@NonNull String studentUserId, String newStudentUserId, String name, List departments) throws WxErrorException;
+  WxCpBaseResp updateStudent(@NonNull String studentUserId, String newStudentUserId, String name,
+                             List departments) throws WxErrorException;
 
   /**
    * 创建家长
    * 请求方式：POST（HTTPS）
    * 请求地址：https://qyapi.weixin.qq.com/cgi-bin/school/user/create_parent?access_token=ACCESS_TOKEN
    *
-   * @param request
-   * @return
-   * @throws WxErrorException
+   * @param request the request
+   * @return wx cp base resp
+   * @throws WxErrorException the wx error exception
    */
   WxCpBaseResp createParent(@NonNull WxCpCreateParentRequest request) throws WxErrorException;
 
@@ -130,9 +130,9 @@ public interface WxCpSchoolUserService {
    * 请求方式：POST（HTTPS）
    * 请求地址：https://qyapi.weixin.qq.com/cgi-bin/school/user/batch_create_parent?access_token=ACCESS_TOKEN
    *
-   * @param request
-   * @return
-   * @throws WxErrorException
+   * @param request the request
+   * @return wx cp batch result list
+   * @throws WxErrorException the wx error exception
    */
   WxCpBatchResultList batchCreateParent(@NonNull WxCpBatchCreateParentRequest request) throws WxErrorException;
 
@@ -141,9 +141,9 @@ public interface WxCpSchoolUserService {
    * 请求方式：POST（HTTPS）
    * 请求地址：https://qyapi.weixin.qq.com/cgi-bin/school/user/batch_delete_parent?access_token=ACCESS_TOKEN
    *
-   * @param userIdList
-   * @return
-   * @throws WxErrorException
+   * @param userIdList the user id list
+   * @return wx cp batch result list
+   * @throws WxErrorException the wx error exception
    */
   WxCpBatchResultList batchDeleteParent(@NonNull String... userIdList) throws WxErrorException;
 
@@ -152,9 +152,9 @@ public interface WxCpSchoolUserService {
    * 请求方式：POST（HTTPS）
    * 请求地址：https://qyapi.weixin.qq.com/cgi-bin/school/user/batch_update_parent?access_token=ACCESS_TOKEN
    *
-   * @param request
-   * @return
-   * @throws WxErrorException
+   * @param request the request
+   * @return wx cp batch result list
+   * @throws WxErrorException the wx error exception
    */
   WxCpBatchResultList batchUpdateParent(@NonNull WxCpBatchUpdateParentRequest request) throws WxErrorException;
 
@@ -163,32 +163,34 @@ public interface WxCpSchoolUserService {
    * 请求方式：GET（HTTPS）
    * 请求地址：https://qyapi.weixin.qq.com/cgi-bin/school/user/get?access_token=ACCESS_TOKEN&userid=USERID
    *
-   * @param userId
-   * @return
-   * @throws WxErrorException
+   * @param userId the user id
+   * @return user
+   * @throws WxErrorException the wx error exception
    */
   WxCpUserResult getUser(@NonNull String userId) throws WxErrorException;
 
   /**
    * 获取部门成员详情
    * 请求方式：GET（HTTPS）
-   * 请求地址：https://qyapi.weixin.qq.com/cgi-bin/school/user/list?access_token=ACCESS_TOKEN&department_id=DEPARTMENT_ID&fetch_child=FETCH_CHILD
+   * 请求地址：https://qyapi.weixin.qq.com/cgi-bin/school/user/list?access_token=ACCESS_TOKEN&department_id=DEPARTMENT_ID
+   * &fetch_child=FETCH_CHILD
    *
    * @param departmentId 获取的部门id
    * @param fetchChild   1/0：是否递归获取子部门下面的成员
-   * @return
-   * @throws WxErrorException
+   * @return user list
+   * @throws WxErrorException the wx error exception
    */
   WxCpUserListResult getUserList(@NonNull Integer departmentId, Integer fetchChild) throws WxErrorException;
 
   /**
    * 获取部门家长详情
    * 请求方式：GET（HTTPS）
-   * 请求地址：https://qyapi.weixin.qq.com/cgi-bin/school/user/list_parent?access_token=ACCESS_TOKEN&department_id=DEPARTMENT_ID
+   * 请求地址：https://qyapi.weixin.qq.com/cgi-bin/school/user/list_parent?access_token=ACCESS_TOKEN&department_id
+   * =DEPARTMENT_ID
    *
    * @param departmentId 获取的部门id
-   * @return
-   * @throws WxErrorException
+   * @return user list parent
+   * @throws WxErrorException the wx error exception
    */
   WxCpListParentResult getUserListParent(@NonNull Integer departmentId) throws WxErrorException;
 
@@ -197,9 +199,9 @@ public interface WxCpSchoolUserService {
    * 请求方式：POST（HTTPS）
    * 请求地址：https://qyapi.weixin.qq.com/cgi-bin/school/user/update_parent?access_token=ACCESS_TOKEN
    *
-   * @param request
-   * @return
-   * @throws WxErrorException
+   * @param request the request
+   * @return wx cp base resp
+   * @throws WxErrorException the wx error exception
    */
   WxCpBaseResp updateParent(@NonNull WxCpUpdateParentRequest request) throws WxErrorException;
 
@@ -208,9 +210,9 @@ public interface WxCpSchoolUserService {
    * 请求方式：GET（HTTPS）
    * 请求地址：https://qyapi.weixin.qq.com/cgi-bin/school/user/delete_parent?access_token=ACCESS_TOKEN&userid=USERID
    *
-   * @param userId
-   * @return
-   * @throws WxErrorException
+   * @param userId the user id
+   * @return wx cp base resp
+   * @throws WxErrorException the wx error exception
    */
   WxCpBaseResp deleteParent(@NonNull String userId) throws WxErrorException;
 
@@ -222,8 +224,8 @@ public interface WxCpSchoolUserService {
    * 请求地址：https://qyapi.weixin.qq.com/cgi-bin/school/set_arch_sync_mode?access_token=ACCESS_TOKEN
    *
    * @param archSyncMode 家校通讯录同步模式：1-禁止将标签同步至家校通讯录，2-禁止将家校通讯录同步至标签，3-禁止家校通讯录和标签相互同步
-   * @return
-   * @throws WxErrorException
+   * @return arch sync mode
+   * @throws WxErrorException the wx error exception
    */
   WxCpBaseResp setArchSyncMode(@NonNull Integer archSyncMode) throws WxErrorException;
 
@@ -234,8 +236,8 @@ public interface WxCpSchoolUserService {
    * 请求地址：https://qyapi.weixin.qq.com/cgi-bin/school/department/create?access_token=ACCESS_TOKEN
    *
    * @param request 请求参数对象
-   * @return
-   * @throws WxErrorException
+   * @return wx cp create department
+   * @throws WxErrorException the wx error exception
    */
   WxCpCreateDepartment createDepartment(@NonNull WxCpCreateDepartmentRequest request) throws WxErrorException;
 
@@ -245,9 +247,9 @@ public interface WxCpSchoolUserService {
    * 请求方式：POST（HTTPS）
    * 请求地址：https://qyapi.weixin.qq.com/cgi-bin/school/department/update?access_token=ACCESS_TOKEN
    *
-   * @param request
-   * @return
-   * @throws WxErrorException
+   * @param request the request
+   * @return wx cp base resp
+   * @throws WxErrorException the wx error exception
    */
   WxCpBaseResp updateDepartment(@NonNull WxCpUpdateDepartmentRequest request) throws WxErrorException;
 
@@ -256,9 +258,9 @@ public interface WxCpSchoolUserService {
    * 请求方式：GET（HTTPS）
    * 请求地址：https://qyapi.weixin.qq.com/cgi-bin/school/department/delete?access_token=ACCESS_TOKEN&id=ID
    *
-   * @param id
-   * @return
-   * @throws WxErrorException
+   * @param id the id
+   * @return wx cp base resp
+   * @throws WxErrorException the wx error exception
    */
   WxCpBaseResp deleteDepartment(Integer id) throws WxErrorException;
 
@@ -270,8 +272,8 @@ public interface WxCpSchoolUserService {
    * 请求地址：https://qyapi.weixin.qq.com/cgi-bin/externalcontact/set_subscribe_mode?access_token=ACCESS_TOKEN
    *
    * @param subscribeMode 关注模式, 1:可扫码填写资料加入, 2:禁止扫码填写资料加入
-   * @return
-   * @throws WxErrorException
+   * @return subscribe mode
+   * @throws WxErrorException the wx error exception
    */
   WxCpBaseResp setSubscribeMode(@NonNull Integer subscribeMode) throws WxErrorException;
 
@@ -282,8 +284,8 @@ public interface WxCpSchoolUserService {
    * 请求方式：GET（HTTPS）
    * 请求地址：https://qyapi.weixin.qq.com/cgi-bin/externalcontact/get_subscribe_mode?access_token=ACCESS_TOKEN
    *
-   * @return
-   * @throws WxErrorException
+   * @return subscribe mode
+   * @throws WxErrorException the wx error exception
    */
   Integer getSubscribeMode() throws WxErrorException;
 
@@ -292,11 +294,12 @@ public interface WxCpSchoolUserService {
    * 学校可通过此接口，根据外部联系人的userid（如何获取?），拉取外部联系人详情。
    * 

    * 请求方式：GET（HTTPS）
-   * 请求地址：https://qyapi.weixin.qq.com/cgi-bin/externalcontact/get?access_token=ACCESS_TOKEN&external_userid=EXTERNAL_USERID
+   * 请求地址：https://qyapi.weixin.qq.com/cgi-bin/externalcontact/get?access_token=ACCESS_TOKEN&external_userid
+   * =EXTERNAL_USERID
    *
    * @param externalUserId 外部联系人的userid，注意不是学校成员的帐号
-   * @return
-   * @throws WxErrorException
+   * @return external contact
+   * @throws WxErrorException the wx error exception
    */
   WxCpExternalContact getExternalContact(@NonNull String externalUserId) throws WxErrorException;
 
@@ -307,9 +310,9 @@ public interface WxCpSchoolUserService {
    * 请求方式：GET（HTTPS）
    * 请求地址：https://qyapi.weixin.qq.com/cgi-bin/school/agent/get_allow_scope?access_token=ACCESS_TOKEN&agentid=AGENTID
    *
-   * @param agentId
-   * @return
-   * @throws WxErrorException
+   * @param agentId the agent id
+   * @return allow scope
+   * @throws WxErrorException the wx error exception
    */
   WxCpAllowScope getAllowScope(@NonNull Integer agentId) throws WxErrorException;
 
@@ -320,9 +323,9 @@ public interface WxCpSchoolUserService {
    * 请求方式：POST（HTTPS）
    * 请求地址：https://qyapi.weixin.qq.com/cgi-bin/externalcontact/convert_to_openid?access_token=ACCESS_TOKEN
    *
-   * @param externalUserId
-   * @return
-   * @throws WxErrorException
+   * @param externalUserId the external user id
+   * @return string
+   * @throws WxErrorException the wx error exception
    */
   String convertToOpenId(@NonNull String externalUserId) throws WxErrorException;
 
@@ -331,9 +334,9 @@ public interface WxCpSchoolUserService {
    * 请求方式：GET（HTTPS）
    * 请求地址：https://qyapi.weixin.qq.com/cgi-bin/school/department/list?access_token=ACCESS_TOKEN&id=ID
    *
-   * @param id
-   * @return
-   * @throws WxErrorException
+   * @param id the id
+   * @return wx cp department list
+   * @throws WxErrorException the wx error exception
    */
   WxCpDepartmentList listDepartment(Integer id) throws WxErrorException;
 
@@ -343,8 +346,8 @@ public interface WxCpSchoolUserService {
    * 请求方式：GET（HTTPS）
    * 请求地址：https://qyapi.weixin.qq.com/cgi-bin/externalcontact/get_subscribe_qr_code?access_token=ACCESS_TOKEN
    *
-   * @return
-   * @throws WxErrorException
+   * @return subscribe qr code
+   * @throws WxErrorException the wx error exception
    */
   WxCpSubscribeQrCode getSubscribeQrCode() throws WxErrorException;
 
@@ -353,10 +356,10 @@ public interface WxCpSchoolUserService {
    * 请求方式： POST（HTTPS）
    * 请求地址： https://qyapi.weixin.qq.com/cgi-bin/school/set_upgrade_info?access_token=ACCESS_TOKEN
    *
-   * @param upgradeTime
-   * @param upgradeSwitch
-   * @return
-   * @throws WxErrorException
+   * @param upgradeTime   the upgrade time
+   * @param upgradeSwitch the upgrade switch
+   * @return upgrade info
+   * @throws WxErrorException the wx error exception
    */
   WxCpSetUpgradeInfo setUpgradeInfo(Long upgradeTime, Integer upgradeSwitch) throws WxErrorException;
 
diff --git a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/api/WxCpService.java b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/api/WxCpService.java
index 44237ba8e..8a9bdb19b 100644
--- a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/api/WxCpService.java
+++ b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/api/WxCpService.java
@@ -38,7 +38,7 @@ public interface WxCpService extends WxService {
    *
    * @return the access token
    * @throws WxErrorException the wx error exception
-   * @see #getAccessToken(boolean) #getAccessToken(boolean)#getAccessToken(boolean)
+   * @see #getAccessToken(boolean) #getAccessToken(boolean)#getAccessToken(boolean)#getAccessToken(boolean)
    */
   String getAccessToken() throws WxErrorException;
 
@@ -62,7 +62,7 @@ public interface WxCpService extends WxService {
    *
    * @return the jsapi ticket
    * @throws WxErrorException the wx error exception
-   * @see #getJsapiTicket(boolean) #getJsapiTicket(boolean)#getJsapiTicket(boolean)
+   * @see #getJsapiTicket(boolean) #getJsapiTicket(boolean)#getJsapiTicket(boolean)#getJsapiTicket(boolean)
    */
   String getJsapiTicket() throws WxErrorException;
 
@@ -89,7 +89,7 @@ public interface WxCpService extends WxService {
    *
    * @return the agent jsapi ticket
    * @throws WxErrorException the wx error exception
-   * @see #getJsapiTicket(boolean) #getJsapiTicket(boolean)#getJsapiTicket(boolean)
+   * @see #getJsapiTicket(boolean) #getJsapiTicket(boolean)#getJsapiTicket(boolean)#getJsapiTicket(boolean)
    */
   String getAgentJsapiTicket() throws WxErrorException;
 
@@ -134,7 +134,7 @@ public interface WxCpService extends WxService {
    *
    * @param url url
    * @return the agent jsapi signature
-   * @throws WxErrorException
+   * @throws WxErrorException the wx error exception
    */
   WxCpAgentJsapiSignature createAgentJsapiSignature(String url) throws WxErrorException;
 
@@ -265,6 +265,7 @@ public interface WxCpService extends WxService {
 
   /**
    * 上传用户列表，增量更新成员
+   *
    * @param mediaId 媒体id
    * @return jobId 异步任务id
    * @throws WxErrorException the wx error exception
@@ -310,9 +311,10 @@ public interface WxCpService extends WxService {
 
   /**
    * 构造扫码登录链接 - 构造独立窗口登录二维码
+   *
    * @param redirectUri 重定向地址，需要进行UrlEncode
-   * @param state 用于保持请求和回调的状态，授权请求后原样带回给企业。该参数可用于防止csrf攻击（跨站请求伪造攻击），建议企业带上该参数，可设置为简单的随机数加session进行校验
-   * @return .
+   * @param state       用于保持请求和回调的状态，授权请求后原样带回给企业。该参数可用于防止csrf攻击（跨站请求伪造攻击），建议企业带上该参数，可设置为简单的随机数加session进行校验
+   * @return . string
    */
   String buildQrConnectUrl(String redirectUri, String state);
 
@@ -403,21 +405,21 @@ public interface WxCpService extends WxService {
   /**
    * 获取家校应用复学码相关接口的服务类对象
    *
-   * @return
+   * @return school service
    */
   WxCpSchoolService getSchoolService();
 
   /**
    * 获取家校沟通相关接口的服务类对象
    *
-   * @return
+   * @return school user service
    */
   WxCpSchoolUserService getSchoolUserService();
 
   /**
    * 获取家校应用健康上报的服务类对象
    *
-   * @return
+   * @return school health service
    */
   WxCpSchoolHealthService getSchoolHealthService();
 
@@ -431,21 +433,21 @@ public interface WxCpService extends WxService {
   /**
    * 获取OA 自建应用相关接口的服务类对象
    *
-   * @return
+   * @return oa agent service
    */
   WxCpOaAgentService getOaAgentService();
 
   /**
    * 获取OA效率工具 微盘的服务类对象
    *
-   * @return
+   * @return oa we drive service
    */
   WxCpOaWeDriveService getOaWeDriveService();
 
   /**
    * 获取会话存档相关接口的服务类对象
    *
-   * @return
+   * @return msg audit service
    */
   WxCpMsgAuditService getMsgAuditService();
 
@@ -487,7 +489,7 @@ public interface WxCpService extends WxService {
   /**
    * 获取微信客服服务
    *
-   * @return 微信客服服务
+   * @return 微信客服服务 kf service
    */
   WxCpKfService getKfService();
 
@@ -550,7 +552,7 @@ public interface WxCpService extends WxService {
   /**
    * 获取异步导出服务
    *
-   * @return 异步导出服务
+   * @return 异步导出服务 export service
    */
   WxCpExportService getExportService();
 
diff --git a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/api/WxCpTagService.java b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/api/WxCpTagService.java
index 045264f7d..4469bcc9e 100644
--- a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/api/WxCpTagService.java
+++ b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/api/WxCpTagService.java
@@ -26,7 +26,7 @@ public interface WxCpTagService {
    *
    * @param name 标签名称，长度限制为32个字以内（汉字或英文字母），标签名不可与其他标签重名。
    * @param id   标签id，非负整型，指定此参数时新增的标签会生成对应的标签id，不指定时则以目前最大的id自增。
-   * @return 标签id
+   * @return 标签id string
    * @throws WxErrorException .
    */
   String create(String name, Integer id) throws WxErrorException;
@@ -51,7 +51,7 @@ public interface WxCpTagService {
   /**
    * 获得标签列表.
    *
-   * @return 标签列表
+   * @return 标签列表 list
    * @throws WxErrorException .
    */
   List listAll() throws WxErrorException;
@@ -60,7 +60,7 @@ public interface WxCpTagService {
    * 获取标签成员.
    *
    * @param tagId 标签ID
-   * @return 成员列表
+   * @return 成员列表 list
    * @throws WxErrorException .
    */
   List listUsersByTagId(String tagId) throws WxErrorException;
@@ -70,7 +70,7 @@ public interface WxCpTagService {
    * 对应: http://qydev.weixin.qq.com/wiki/index.php?title=管理标签 中的get接口
    *
    * @param tagId 标签id
-   * @return .
+   * @return . wx cp tag get result
    * @throws WxErrorException .
    */
   WxCpTagGetResult get(String tagId) throws WxErrorException;
@@ -81,7 +81,7 @@ public interface WxCpTagService {
    * @param tagId    标签id
    * @param userIds  用户ID 列表
    * @param partyIds 企业部门ID列表
-   * @return .
+   * @return . wx cp tag add or remove users result
    * @throws WxErrorException .
    */
   WxCpTagAddOrRemoveUsersResult addUsers2Tag(String tagId, List userIds, List partyIds) throws WxErrorException;
@@ -92,7 +92,7 @@ public interface WxCpTagService {
    * @param tagId    标签id
    * @param userIds  用户id列表
    * @param partyIds 企业部门ID列表
-   * @return .
+   * @return . wx cp tag add or remove users result
    * @throws WxErrorException .
    */
   WxCpTagAddOrRemoveUsersResult removeUsersFromTag(String tagId, List userIds, List partyIds) throws WxErrorException;
diff --git a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/api/WxCpTaskCardService.java b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/api/WxCpTaskCardService.java
index 9c401a981..ee28d81e5 100644
--- a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/api/WxCpTaskCardService.java
+++ b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/api/WxCpTaskCardService.java
@@ -11,8 +11,7 @@ import java.util.List;
  *  Updted by HeXiao on 2022-03-09.
  * 

  *
- * @author Jeff
- * created on  2019-05-16
+ * @author Jeff created on  2019-05-16
  */
 public interface WxCpTaskCardService {
 
@@ -27,23 +26,26 @@ public interface WxCpTaskCardService {
    * @param userIds     企业的成员ID列表
    * @param taskId      任务卡片ID
    * @param replaceName 替换文案
+   * @throws WxErrorException the wx error exception
    */
   void update(List userIds, String taskId, String replaceName) throws WxErrorException;
 
 
   /**
    * 更新按钮为不可点击状态
-   * 详情请见https://developer.work.weixin.qq.com/document/path/94888#%E6%9B%B4%E6%96%B0%E6%8C%89%E9%92%AE%E4%B8%BA%E4%B8%8D%E5%8F%AF%E7%82%B9%E5%87%BB%E7%8A%B6%E6%80%81
-   * @param userIds    企业的成员ID列表
-   * @param partyIds   企业的部门ID列表
-   * @param tagIds    企业的标签ID列表
-   * @param atAll     更新整个任务接收人员
-   * @param responseCode  更新卡片所需要消费的code，可通过发消息接口和回调接口返回值获取，一个code只能调用一次该接口，且只能在24小时内调用
-   * @param replaceName   需要更新的按钮的文案
-   * @throws WxErrorException
+   * 详情请见https://developer.work.weixin.qq.com/document/path/94888#%E6%9B%B4%E6%96%B0%E6%8C%89%E9%92%AE%E4%B8%BA%E4%B8
+   * %8D%E5%8F%AF%E7%82%B9%E5%87%BB%E7%8A%B6%E6%80%81
+   *
+   * @param userIds      企业的成员ID列表
+   * @param partyIds     企业的部门ID列表
+   * @param tagIds       企业的标签ID列表
+   * @param atAll        更新整个任务接收人员
+   * @param responseCode 更新卡片所需要消费的code，可通过发消息接口和回调接口返回值获取，一个code只能调用一次该接口，且只能在24小时内调用
+   * @param replaceName  需要更新的按钮的文案
+   * @throws WxErrorException the wx error exception
    */
   void updateTemplateCardButton(List userIds, List partyIds,
-                          List tagIds, Integer atAll, String responseCode,
-                          String replaceName) throws WxErrorException;
+                                List tagIds, Integer atAll, String responseCode,
+                                String replaceName) throws WxErrorException;
 
 }
diff --git a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/api/WxCpUserService.java b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/api/WxCpUserService.java
index d5bd6702c..4b75450ff 100644
--- a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/api/WxCpUserService.java
+++ b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/api/WxCpUserService.java
@@ -132,7 +132,8 @@ public interface WxCpUserService {
    *
    * @param userId  企业内的成员id
    * @param agentId 非必填，整型，仅用于发红包。其它场景该参数不要填，如微信支付、企业转账、电子发票
-   * @return map对象 ，可能包含以下值： - openid 企业微信成员userid对应的openid，若有传参agentid，则是针对该agentid的openid。否则是针对企业微信corpid的openid - appid 应用的appid，若请求包中不包含agentid则不返回appid。该appid在使用微信红包时会用到
+   * @return map对象 ，可能包含以下值： - openid 企业微信成员userid对应的openid，若有传参agentid，则是针对该agentid的openid。否则是针对企业微信corpid的openid -
+   * appid 应用的appid，若请求包中不包含agentid则不返回appid。该appid在使用微信红包时会用到
    * @throws WxErrorException the wx error exception
    */
   Map userId2Openid(String userId, Integer agentId) throws WxErrorException;
@@ -226,9 +227,9 @@ public interface WxCpUserService {
    * 将自建应用或代开发应用获取的userid转换为第三方应用的userid
    * https://developer.work.weixin.qq.com/document/path/95603
    *
-   * @param useridList
+   * @param useridList the userid list
    * @return the WxCpUseridToOpenUseridResult
-   * @throws WxErrorException
+   * @throws WxErrorException the wx error exception
    */
   WxCpUseridToOpenUseridResult useridToOpenUserid(ArrayList useridList) throws WxErrorException;
 
@@ -239,10 +240,10 @@ public interface WxCpUserService {
    * 请求方式：POST（HTTPS）
    * 请求地址：https://qyapi.weixin.qq.com/cgi-bin/user/list_id?access_token=ACCESS_TOKEN
    *
-   * @param cursor
-   * @param limit
-   * @return
-   * @throws WxErrorException
+   * @param cursor the cursor
+   * @param limit  the limit
+   * @return user list id
+   * @throws WxErrorException the wx error exception
    */
   WxCpDeptUserResult getUserListId(String cursor, Integer limit) throws WxErrorException;
 
diff --git a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/api/impl/BaseWxCpServiceImpl.java b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/api/impl/BaseWxCpServiceImpl.java
index 735ccfd85..dea53f5dc 100644
--- a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/api/impl/BaseWxCpServiceImpl.java
+++ b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/api/impl/BaseWxCpServiceImpl.java
@@ -36,34 +36,36 @@ import static me.chanjar.weixin.cp.constant.WxCpApiPathConsts.*;
 /**
  * .
  *
+ * @param  the type parameter
+ * @param 
 the type parameter
  * @author chanjarster
  */
 @Slf4j
 public abstract class BaseWxCpServiceImpl implements WxCpService, RequestHttp {
   private WxCpUserService userService = new WxCpUserServiceImpl(this);
-  private WxCpChatService chatService = new WxCpChatServiceImpl(this);
+  private final WxCpChatService chatService = new WxCpChatServiceImpl(this);
   private WxCpDepartmentService departmentService = new WxCpDepartmentServiceImpl(this);
   private WxCpMediaService mediaService = new WxCpMediaServiceImpl(this);
   private WxCpMenuService menuService = new WxCpMenuServiceImpl(this);
   private WxCpOAuth2Service oauth2Service = new WxCpOAuth2ServiceImpl(this);
   private WxCpTagService tagService = new WxCpTagServiceImpl(this);
   private WxCpAgentService agentService = new WxCpAgentServiceImpl(this);
-  private WxCpOaService oaService = new WxCpOaServiceImpl(this);
-  private WxCpSchoolService schoolService = new WxCpSchoolServiceImpl(this);
-  private WxCpSchoolUserService schoolUserService = new WxCpSchoolUserServiceImpl(this);
-  private WxCpSchoolHealthService schoolHealthService = new WxCpSchoolHealthServiceImpl(this);
-  private WxCpLivingService livingService = new WxCpLivingServiceImpl(this);
-  private WxCpOaAgentService oaAgentService = new WxCpOaAgentServiceImpl(this);
-  private WxCpOaWeDriveService oaWeDriveService = new WxCpOaWeDriveServiceImpl(this);
-  private WxCpMsgAuditService msgAuditService = new WxCpMsgAuditServiceImpl(this);
-  private WxCpTaskCardService taskCardService = new WxCpTaskCardServiceImpl(this);
-  private WxCpExternalContactService externalContactService = new WxCpExternalContactServiceImpl(this);
-  private WxCpGroupRobotService groupRobotService = new WxCpGroupRobotServiceImpl(this);
-  private WxCpMessageService messageService = new WxCpMessageServiceImpl(this);
-  private WxCpOaCalendarService oaCalendarService = new WxCpOaCalendarServiceImpl(this);
-  private WxCpOaMeetingRoomService oaMeetingRoomService = new WxCpOaMeetingRoomServiceImpl(this);
-  private WxCpOaScheduleService oaScheduleService = new WxCpOaOaScheduleServiceImpl(this);
-  private WxCpAgentWorkBenchService workBenchService = new WxCpAgentWorkBenchServiceImpl(this);
+  private final WxCpOaService oaService = new WxCpOaServiceImpl(this);
+  private final WxCpSchoolService schoolService = new WxCpSchoolServiceImpl(this);
+  private final WxCpSchoolUserService schoolUserService = new WxCpSchoolUserServiceImpl(this);
+  private final WxCpSchoolHealthService schoolHealthService = new WxCpSchoolHealthServiceImpl(this);
+  private final WxCpLivingService livingService = new WxCpLivingServiceImpl(this);
+  private final WxCpOaAgentService oaAgentService = new WxCpOaAgentServiceImpl(this);
+  private final WxCpOaWeDriveService oaWeDriveService = new WxCpOaWeDriveServiceImpl(this);
+  private final WxCpMsgAuditService msgAuditService = new WxCpMsgAuditServiceImpl(this);
+  private final WxCpTaskCardService taskCardService = new WxCpTaskCardServiceImpl(this);
+  private final WxCpExternalContactService externalContactService = new WxCpExternalContactServiceImpl(this);
+  private final WxCpGroupRobotService groupRobotService = new WxCpGroupRobotServiceImpl(this);
+  private final WxCpMessageService messageService = new WxCpMessageServiceImpl(this);
+  private final WxCpOaCalendarService oaCalendarService = new WxCpOaCalendarServiceImpl(this);
+  private final WxCpOaMeetingRoomService oaMeetingRoomService = new WxCpOaMeetingRoomServiceImpl(this);
+  private final WxCpOaScheduleService oaScheduleService = new WxCpOaOaScheduleServiceImpl(this);
+  private final WxCpAgentWorkBenchService workBenchService = new WxCpAgentWorkBenchServiceImpl(this);
   private WxCpKfService kfService = new WxCpKfServiceImpl(this);
 
   private WxCpExportService exportService = new WxCpExportServiceImpl(this);
@@ -83,6 +85,9 @@ public abstract class BaseWxCpServiceImpl implements WxCpService, RequestH
    */
   protected final Object globalAgentJsapiTicketRefreshLock = new Object();
 
+  /**
+   * The Config storage.
+   */
   protected WxCpConfigStorage configStorage;
 
   private WxSessionManager sessionManager = new StandardSessionManager();
@@ -234,7 +239,8 @@ public abstract class BaseWxCpServiceImpl implements WxCpService, RequestH
     JsonObject jsonObject = new JsonObject();
     jsonObject.addProperty("corpid", corpId);
     jsonObject.addProperty("provider_secret", providerSecret);
-    return WxCpProviderToken.fromJson(this.post(this.configStorage.getApiUrl(Tp.GET_PROVIDER_TOKEN), jsonObject.toString()));
+    return WxCpProviderToken.fromJson(this.post(this.configStorage.getApiUrl(Tp.GET_PROVIDER_TOKEN),
+      jsonObject.toString()));
   }
 
   @Override
@@ -305,6 +311,18 @@ public abstract class BaseWxCpServiceImpl implements WxCpService, RequestH
     throw new WxRuntimeException("微信服务端异常，超出重试次数");
   }
 
+  /**
+   * Execute internal t.
+   *
+   * @param               the type parameter
+   * @param               the type parameter
+   * @param executor         the executor
+   * @param uri              the uri
+   * @param data             the data
+   * @param doNotAutoRefresh the do not auto refresh
+   * @return the t
+   * @throws WxErrorException the wx error exception
+   */
   protected  T executeInternal(RequestExecutor executor, String uri, E data, boolean doNotAutoRefresh) throws WxErrorException {
     E dataForLog = DataUtils.handleDataWithSecret(data);
 
@@ -439,15 +457,26 @@ public abstract class BaseWxCpServiceImpl implements WxCpService, RequestH
 
   @Override
   public String buildQrConnectUrl(String redirectUri, String state) {
-    return String.format("https://open.work.weixin.qq.com/wwopen/sso/qrConnect?appid=%s&agentid=%s&redirect_uri=%s&state=%s",
+    return String.format("https://open.work.weixin.qq.com/wwopen/sso/qrConnect?appid=%s&agentid=%s&redirect_uri=%s" +
+        "&state=%s",
       this.configStorage.getCorpId(), this.configStorage.getAgentId(),
       URIUtil.encodeURIComponent(redirectUri), StringUtils.trimToEmpty(state));
   }
 
+  /**
+   * Gets tmp dir file.
+   *
+   * @return the tmp dir file
+   */
   public File getTmpDirFile() {
     return this.tmpDirFile;
   }
 
+  /**
+   * Sets tmp dir file.
+   *
+   * @param tmpDirFile the tmp dir file
+   */
   public void setTmpDirFile(File tmpDirFile) {
     this.tmpDirFile = tmpDirFile;
   }
@@ -602,6 +631,11 @@ public abstract class BaseWxCpServiceImpl implements WxCpService, RequestH
     return this.messageService;
   }
 
+  /**
+   * Sets agent service.
+   *
+   * @param agentService the agent service
+   */
   public void setAgentService(WxCpAgentService agentService) {
     this.agentService = agentService;
   }
diff --git a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/api/impl/WxCpAgentWorkBenchServiceImpl.java b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/api/impl/WxCpAgentWorkBenchServiceImpl.java
index 47169998f..3af04c307 100644
--- a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/api/impl/WxCpAgentWorkBenchServiceImpl.java
+++ b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/api/impl/WxCpAgentWorkBenchServiceImpl.java
@@ -7,13 +7,12 @@ import me.chanjar.weixin.cp.api.WxCpAgentWorkBenchService;
 import me.chanjar.weixin.cp.api.WxCpService;
 import me.chanjar.weixin.cp.bean.WxCpAgentWorkBench;
 
-import static me.chanjar.weixin.cp.constant.WxCpApiPathConsts.WorkBench.WORKBENCH_DATA_SET;
-import static me.chanjar.weixin.cp.constant.WxCpApiPathConsts.WorkBench.WORKBENCH_TEMPLATE_GET;
-import static me.chanjar.weixin.cp.constant.WxCpApiPathConsts.WorkBench.WORKBENCH_TEMPLATE_SET;
+import static me.chanjar.weixin.cp.constant.WxCpApiPathConsts.WorkBench.*;
 
 /**
- * @author songshiyu
- * created on  : create in 11:24 2020/9/28
+ * The type Wx cp agent work bench service.
+ *
+ * @author songshiyu  created on  : create in 11:24 2020/9/28
  * @description: 工作台自定义展示实现
  */
 @RequiredArgsConstructor
diff --git a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/api/impl/WxCpChatServiceImpl.java b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/api/impl/WxCpChatServiceImpl.java
index 7783422af..c47785f6e 100644
--- a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/api/impl/WxCpChatServiceImpl.java
+++ b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/api/impl/WxCpChatServiceImpl.java
@@ -6,8 +6,8 @@ import me.chanjar.weixin.common.util.json.GsonParser;
 import me.chanjar.weixin.common.util.json.WxGsonBuilder;
 import me.chanjar.weixin.cp.api.WxCpChatService;
 import me.chanjar.weixin.cp.api.WxCpService;
-import me.chanjar.weixin.cp.bean.message.WxCpAppChatMessage;
 import me.chanjar.weixin.cp.bean.WxCpChat;
+import me.chanjar.weixin.cp.bean.message.WxCpAppChatMessage;
 import me.chanjar.weixin.cp.util.json.WxCpGsonBuilder;
 import org.apache.commons.lang3.StringUtils;
 
diff --git a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/api/impl/WxCpExportServiceImpl.java b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/api/impl/WxCpExportServiceImpl.java
index 30ea5baaa..638dd4e1c 100644
--- a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/api/impl/WxCpExportServiceImpl.java
+++ b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/api/impl/WxCpExportServiceImpl.java
@@ -15,9 +15,8 @@ import static me.chanjar.weixin.cp.constant.WxCpApiPathConsts.Export.*;
 /**
  * 异步导出接口
  *
- * @author zhongjun
- * created on  2022/4/21
- **/
+ * @author zhongjun created on  2022/4/21
+ */
 @RequiredArgsConstructor
 public class WxCpExportServiceImpl implements WxCpExportService {
 
diff --git a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/api/impl/WxCpExternalContactServiceImpl.java b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/api/impl/WxCpExternalContactServiceImpl.java
index aa6cc0366..3373e7ccb 100644
--- a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/api/impl/WxCpExternalContactServiceImpl.java
+++ b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/api/impl/WxCpExternalContactServiceImpl.java
@@ -32,6 +32,8 @@ import java.util.UUID;
 import static me.chanjar.weixin.cp.constant.WxCpApiPathConsts.ExternalContact.*;
 
 /**
+ * The type Wx cp external contact service.
+ *
  * @author 曹祖鹏 & yuanqixun & Mr.Pan & Wang_Wong
  */
 @RequiredArgsConstructor
@@ -153,7 +155,8 @@ public class WxCpExternalContactServiceImpl implements WxCpExternalContactServic
   }
 
   @Override
-  public WxCpExternalUserIdList unionidToExternalUserid3rd(@NotNull String unionid, @NotNull String openid, String corpid) throws WxErrorException {
+  public WxCpExternalUserIdList unionidToExternalUserid3rd(@NotNull String unionid, @NotNull String openid,
+                                                           String corpid) throws WxErrorException {
     JsonObject json = new JsonObject();
     json.addProperty("unionid", unionid);
     json.addProperty("openid", openid);
@@ -277,7 +280,8 @@ public class WxCpExternalContactServiceImpl implements WxCpExternalContactServic
   }
 
   @Override
-  public WxCpUserTransferResultResp transferResult(@NotNull String handOverUserid, @NotNull String takeOverUserid, String cursor) throws WxErrorException {
+  public WxCpUserTransferResultResp transferResult(@NotNull String handOverUserid, @NotNull String takeOverUserid,
+                                                   String cursor) throws WxErrorException {
     JsonObject json = new JsonObject();
     json.addProperty("cursor", cursor);
     json.addProperty("handover_userid", handOverUserid);
@@ -296,7 +300,8 @@ public class WxCpExternalContactServiceImpl implements WxCpExternalContactServic
   }
 
   @Override
-  public WxCpUserTransferResultResp resignedTransferResult(@NotNull String handOverUserid, @NotNull String takeOverUserid, String cursor) throws WxErrorException {
+  public WxCpUserTransferResultResp resignedTransferResult(@NotNull String handOverUserid,
+                                                           @NotNull String takeOverUserid, String cursor) throws WxErrorException {
     JsonObject json = new JsonObject();
     json.addProperty("cursor", cursor);
     json.addProperty("handover_userid", handOverUserid);
@@ -307,7 +312,8 @@ public class WxCpExternalContactServiceImpl implements WxCpExternalContactServic
   }
 
   @Override
-  public WxCpUserExternalGroupChatList listGroupChat(Integer pageIndex, Integer pageSize, int status, String[] userIds, String[] partyIds) throws WxErrorException {
+  public WxCpUserExternalGroupChatList listGroupChat(Integer pageIndex, Integer pageSize, int status,
+                                                     String[] userIds, String[] partyIds) throws WxErrorException {
     JsonObject json = new JsonObject();
     json.addProperty("offset", pageIndex == null ? 0 : pageIndex);
     json.addProperty("limit", pageSize == null ? 100 : pageSize);
@@ -368,7 +374,8 @@ public class WxCpExternalContactServiceImpl implements WxCpExternalContactServic
   }
 
   @Override
-  public WxCpUserExternalUserBehaviorStatistic getUserBehaviorStatistic(Date startTime, Date endTime, String[] userIds, String[] partyIds) throws WxErrorException {
+  public WxCpUserExternalUserBehaviorStatistic getUserBehaviorStatistic(Date startTime, Date endTime,
+                                                                        String[] userIds, String[] partyIds) throws WxErrorException {
     JsonObject json = new JsonObject();
     json.addProperty("start_time", startTime.getTime() / 1000);
     json.addProperty("end_time", endTime.getTime() / 1000);
@@ -386,7 +393,9 @@ public class WxCpExternalContactServiceImpl implements WxCpExternalContactServic
   }
 
   @Override
-  public WxCpUserExternalGroupChatStatistic getGroupChatStatistic(Date startTime, Integer orderBy, Integer orderAsc, Integer pageIndex, Integer pageSize, String[] userIds, String[] partyIds) throws WxErrorException {
+  public WxCpUserExternalGroupChatStatistic getGroupChatStatistic(Date startTime, Integer orderBy, Integer orderAsc,
+                                                                  Integer pageIndex, Integer pageSize,
+                                                                  String[] userIds, String[] partyIds) throws WxErrorException {
     JsonObject json = new JsonObject();
     json.addProperty("day_begin_time", startTime.getTime() / 1000);
     json.addProperty("order_by", orderBy == null ? 1 : orderBy);
@@ -617,7 +626,8 @@ public class WxCpExternalContactServiceImpl implements WxCpExternalContactServic
    * @throws WxErrorException the wx error exception
    */
   @Override
-  public WxCpGroupMsgListResult getGroupMsgListV2(String chatType, @NonNull Date startTime, @NonNull Date endTime, String creator, Integer filterType, Integer limit, String cursor) throws WxErrorException {
+  public WxCpGroupMsgListResult getGroupMsgListV2(String chatType, @NonNull Date startTime, @NonNull Date endTime,
+                                                  String creator, Integer filterType, Integer limit, String cursor) throws WxErrorException {
     JsonObject json = new JsonObject();
     json.addProperty("chat_type", chatType);
     json.addProperty("start_time", startTime.getTime() / 1000);
@@ -843,13 +853,15 @@ public class WxCpExternalContactServiceImpl implements WxCpExternalContactServic
   @Override
   public WxCpInterceptRuleResultResp addInterceptRule(WxCpInterceptRuleResp ruleResp) throws WxErrorException {
     return WxCpInterceptRuleResultResp
-      .fromJson(this.mainService.post(this.mainService.getWxCpConfigStorage().getApiUrl(ADD_INTERCEPT_RULE), ruleResp.toJson()));
+      .fromJson(this.mainService.post(this.mainService.getWxCpConfigStorage().getApiUrl(ADD_INTERCEPT_RULE),
+        ruleResp.toJson()));
   }
 
   @Override
   public WxCpInterceptRuleResultResp updateInterceptRule(WxCpInterceptRuleResp ruleResp) throws WxErrorException {
     return WxCpInterceptRuleResultResp
-      .fromJson(this.mainService.post(this.mainService.getWxCpConfigStorage().getApiUrl(UPDATE_INTERCEPT_RULE), ruleResp.toJson()));
+      .fromJson(this.mainService.post(this.mainService.getWxCpConfigStorage().getApiUrl(UPDATE_INTERCEPT_RULE),
+        ruleResp.toJson()));
   }
 
   @Override
@@ -857,7 +869,8 @@ public class WxCpExternalContactServiceImpl implements WxCpExternalContactServic
     JsonObject jsonObject = new JsonObject();
     jsonObject.addProperty("rule_id", rule_id);
     return WxCpBaseResp
-      .fromJson(this.mainService.post(this.mainService.getWxCpConfigStorage().getApiUrl(DEL_INTERCEPT_RULE), jsonObject));
+      .fromJson(this.mainService.post(this.mainService.getWxCpConfigStorage().getApiUrl(DEL_INTERCEPT_RULE),
+        jsonObject));
   }
 
   @Override
@@ -908,7 +921,7 @@ public class WxCpExternalContactServiceImpl implements WxCpExternalContactServic
     JsonObject json = new JsonObject();
     json.addProperty("config_id", configId);
     final String url = this.mainService.getWxCpConfigStorage().getApiUrl(GET_JOIN_WAY);
-    String responseContent = this.mainService.post(url,json);
+    String responseContent = this.mainService.post(url, json);
 
     return WxCpGroupJoinWayInfo.fromJson(responseContent);
   }
diff --git a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/api/impl/WxCpGroupRobotServiceImpl.java b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/api/impl/WxCpGroupRobotServiceImpl.java
index 6f3d4a617..a5749cbc1 100644
--- a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/api/impl/WxCpGroupRobotServiceImpl.java
+++ b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/api/impl/WxCpGroupRobotServiceImpl.java
@@ -17,8 +17,7 @@ import static me.chanjar.weixin.cp.constant.WxCpConsts.GroupRobotMsgType;
 /**
  * 企业微信群机器人消息发送api 实现
  *
- * @author yr
- * created on  2020-08-20
+ * @author yr  created on  2020-08-20
  */
 @RequiredArgsConstructor
 public class WxCpGroupRobotServiceImpl implements WxCpGroupRobotService {
diff --git a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/api/impl/WxCpKfServiceImpl.java b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/api/impl/WxCpKfServiceImpl.java
index f997708f6..247b1d090 100644
--- a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/api/impl/WxCpKfServiceImpl.java
+++ b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/api/impl/WxCpKfServiceImpl.java
@@ -10,22 +10,6 @@ import me.chanjar.weixin.cp.api.WxCpKfService;
 import me.chanjar.weixin.cp.api.WxCpService;
 import me.chanjar.weixin.cp.bean.WxCpBaseResp;
 import me.chanjar.weixin.cp.bean.kf.*;
-import me.chanjar.weixin.cp.bean.kf.WxCpKfAccountAdd;
-import me.chanjar.weixin.cp.bean.kf.WxCpKfAccountAddResp;
-import me.chanjar.weixin.cp.bean.kf.WxCpKfAccountDel;
-import me.chanjar.weixin.cp.bean.kf.WxCpKfAccountLink;
-import me.chanjar.weixin.cp.bean.kf.WxCpKfAccountLinkResp;
-import me.chanjar.weixin.cp.bean.kf.WxCpKfAccountListResp;
-import me.chanjar.weixin.cp.bean.kf.WxCpKfAccountUpd;
-import me.chanjar.weixin.cp.bean.kf.WxCpKfCustomerBatchGetResp;
-import me.chanjar.weixin.cp.bean.kf.WxCpKfMsgListResp;
-import me.chanjar.weixin.cp.bean.kf.WxCpKfMsgSendRequest;
-import me.chanjar.weixin.cp.bean.kf.WxCpKfMsgSendResp;
-import me.chanjar.weixin.cp.bean.kf.WxCpKfServiceStateResp;
-import me.chanjar.weixin.cp.bean.kf.WxCpKfServiceStateTransResp;
-import me.chanjar.weixin.cp.bean.kf.WxCpKfServiceUpgradeConfigResp;
-import me.chanjar.weixin.cp.bean.kf.WxCpKfServicerListResp;
-import me.chanjar.weixin.cp.bean.kf.WxCpKfServicerOpResp;
 import me.chanjar.weixin.cp.util.json.WxCpGsonBuilder;
 
 import java.util.List;
@@ -35,8 +19,7 @@ import static me.chanjar.weixin.cp.constant.WxCpApiPathConsts.Kf.*;
 /**
  * 微信客服接口-服务实现
  *
- * @author Fu
- * created on  2022/1/19 19:41
+ * @author Fu  created on  2022/1/19 19:41
  */
 @RequiredArgsConstructor
 public class WxCpKfServiceImpl implements WxCpKfService {
@@ -65,7 +48,7 @@ public class WxCpKfServiceImpl implements WxCpKfService {
   }
 
   @Override
-  public WxCpKfAccountListResp listAccount(Integer offset,Integer limit) throws WxErrorException {
+  public WxCpKfAccountListResp listAccount(Integer offset, Integer limit) throws WxErrorException {
     String url = cpService.getWxCpConfigStorage().getApiUrl(ACCOUNT_LIST);
     JsonObject json = new JsonObject();
     if (offset != null) {
@@ -130,7 +113,7 @@ public class WxCpKfServiceImpl implements WxCpKfService {
 
   @Override
   public WxCpKfServiceStateTransResp transServiceState(String openKfid, String externalUserId,
-    Integer serviceState, String servicerUserId) throws WxErrorException {
+                                                       Integer serviceState, String servicerUserId) throws WxErrorException {
     String url = cpService.getWxCpConfigStorage().getApiUrl(SERVICE_STATE_TRANS);
 
     JsonObject json = new JsonObject();
@@ -149,16 +132,16 @@ public class WxCpKfServiceImpl implements WxCpKfService {
     String url = cpService.getWxCpConfigStorage().getApiUrl(SYNC_MSG);
 
     JsonObject json = new JsonObject();
-    if (cursor!=null) {
+    if (cursor != null) {
       json.addProperty("cursor", cursor);
     }
-    if (token!=null) {
+    if (token != null) {
       json.addProperty("token", token);
     }
-    if (limit!=null) {
+    if (limit != null) {
       json.addProperty("limit", limit);
     }
-    if (voiceFormat!=null) {
+    if (voiceFormat != null) {
       json.addProperty("voice_format", voiceFormat);
     }
 
@@ -208,7 +191,7 @@ public class WxCpKfServiceImpl implements WxCpKfService {
 
   @Override
   public WxCpBaseResp upgradeMemberService(String openKfid, String externalUserId,
-    String userid, String wording) throws WxErrorException {
+                                           String userid, String wording) throws WxErrorException {
     String url = cpService.getWxCpConfigStorage().getApiUrl(CUSTOMER_UPGRADE_SERVICE);
 
     JsonObject json = new JsonObject();
@@ -227,7 +210,7 @@ public class WxCpKfServiceImpl implements WxCpKfService {
 
   @Override
   public WxCpBaseResp upgradeGroupchatService(String openKfid, String externalUserId,
-    String chatId, String wording) throws WxErrorException {
+                                              String chatId, String wording) throws WxErrorException {
     String url = cpService.getWxCpConfigStorage().getApiUrl(CUSTOMER_UPGRADE_SERVICE);
 
     JsonObject json = new JsonObject();
@@ -255,6 +238,7 @@ public class WxCpKfServiceImpl implements WxCpKfService {
     String response = cpService.post(url, json);
     return WxCpBaseResp.fromJson(response);
   }
+
   @Override
   public WxCpKfGetCorpStatisticResp getCorpStatistic(WxCpKfGetCorpStatisticRequest request) throws WxErrorException {
     String url = cpService.getWxCpConfigStorage().getApiUrl(GET_CORP_STATISTIC);
diff --git a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/api/impl/WxCpLivingServiceImpl.java b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/api/impl/WxCpLivingServiceImpl.java
index cbdae00dc..b3d9e9a36 100644
--- a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/api/impl/WxCpLivingServiceImpl.java
+++ b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/api/impl/WxCpLivingServiceImpl.java
@@ -20,8 +20,7 @@ import static me.chanjar.weixin.cp.constant.WxCpApiPathConsts.Living.*;
  * 企业微信直播接口实现类.
  * https://developer.work.weixin.qq.com/document/path/93633
  *
- * @author Wang_Wong
- * created on  2021-12-21
+ * @author Wang_Wong created on  2021-12-21
  */
 @Slf4j
 @RequiredArgsConstructor
diff --git a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/api/impl/WxCpMediaServiceImpl.java b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/api/impl/WxCpMediaServiceImpl.java
index 8e88aa20e..7953d69e3 100644
--- a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/api/impl/WxCpMediaServiceImpl.java
+++ b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/api/impl/WxCpMediaServiceImpl.java
@@ -39,7 +39,8 @@ public class WxCpMediaServiceImpl implements WxCpMediaService {
   }
 
   @Override
-  public WxMediaUploadResult upload(String mediaType, String filename, String url) throws WxErrorException, IOException {
+  public WxMediaUploadResult upload(String mediaType, String filename, String url) throws WxErrorException,
+    IOException {
     HttpURLConnection conn = null;
     InputStream inputStream = null;
     try {
@@ -50,7 +51,9 @@ public class WxCpMediaServiceImpl implements WxCpMediaService {
       //防止屏蔽程序抓取而返回403错误
       conn.setRequestProperty("User-Agent", "Mozilla/4.0 (compatible; MSIE 5.0; Windows NT; DigExt)");
       inputStream = conn.getInputStream();
-      return this.mainService.execute(MediaInputStreamUploadRequestExecutor.create(this.mainService.getRequestHttp()), this.mainService.getWxCpConfigStorage().getApiUrl(MEDIA_UPLOAD + mediaType), new InputStreamData(inputStream, filename));
+      return this.mainService.execute(MediaInputStreamUploadRequestExecutor.create(this.mainService.getRequestHttp())
+        , this.mainService.getWxCpConfigStorage().getApiUrl(MEDIA_UPLOAD + mediaType),
+        new InputStreamData(inputStream, filename));
     } finally {
       if (inputStream != null) {
         try {
diff --git a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/api/impl/WxCpMessageServiceImpl.java b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/api/impl/WxCpMessageServiceImpl.java
index 717b559c0..3d74f8249 100644
--- a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/api/impl/WxCpMessageServiceImpl.java
+++ b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/api/impl/WxCpMessageServiceImpl.java
@@ -12,8 +12,7 @@ import me.chanjar.weixin.cp.util.json.WxCpGsonBuilder;
 /**
  * 消息推送接口实现类.
  *
- * @author Binary Wang
- * created on  2020-08-30
+ * @author Binary Wang created on  2020-08-30
  */
 @RequiredArgsConstructor
 public class WxCpMessageServiceImpl implements WxCpMessageService {
diff --git a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/api/impl/WxCpMsgAuditServiceImpl.java b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/api/impl/WxCpMsgAuditServiceImpl.java
index b25c7585b..5f7cbf52a 100644
--- a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/api/impl/WxCpMsgAuditServiceImpl.java
+++ b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/api/impl/WxCpMsgAuditServiceImpl.java
@@ -27,8 +27,7 @@ import static me.chanjar.weixin.cp.constant.WxCpApiPathConsts.MsgAudit.*;
 /**
  * 会话内容存档接口实现类.
  *
- * @author Wang_Wong
- * created on  2022-01-17
+ * @author Wang_Wong  created on  2022-01-17
  */
 @Slf4j
 @RequiredArgsConstructor
@@ -36,7 +35,8 @@ public class WxCpMsgAuditServiceImpl implements WxCpMsgAuditService {
   private final WxCpService cpService;
 
   @Override
-  public WxCpChatDatas getChatDatas(long seq, @NonNull long limit, String proxy, String passwd, @NonNull long timeout) throws Exception {
+  public WxCpChatDatas getChatDatas(long seq, @NonNull long limit, String proxy, String passwd,
+                                    @NonNull long timeout) throws Exception {
     String configPath = cpService.getWxCpConfigStorage().getMsgAuditLibPath();
     if (StringUtils.isEmpty(configPath)) {
       throw new WxErrorException("请配置会话存档sdk文件的路径，不要配错了！！");
@@ -45,7 +45,8 @@ public class WxCpMsgAuditServiceImpl implements WxCpMsgAuditService {
     /**
      * 完整的文件库路径：
      *
-     * /www/osfile/libcrypto-1_1-x64.dll,libssl-1_1-x64.dll,libcurl-x64.dll,WeWorkFinanceSdk.dll,libWeWorkFinanceSdk_Java.so
+     * /www/osfile/libcrypto-1_1-x64.dll,libssl-1_1-x64.dll,libcurl-x64.dll,WeWorkFinanceSdk.dll,
+     * libWeWorkFinanceSdk_Java.so
      */
     // 替换斜杠
     String replacePath = configPath.replace("\\", "/");
@@ -78,7 +79,8 @@ public class WxCpMsgAuditServiceImpl implements WxCpMsgAuditService {
     Finance.loadingLibraries(osLib, prefixPath);
     long sdk = Finance.NewSdk();
 
-    long ret = Finance.Init(sdk, cpService.getWxCpConfigStorage().getCorpId(), cpService.getWxCpConfigStorage().getCorpSecret());
+    long ret = Finance.Init(sdk, cpService.getWxCpConfigStorage().getCorpId(),
+      cpService.getWxCpConfigStorage().getCorpSecret());
     if (ret != 0) {
       Finance.DestroySdk(sdk);
       throw new WxErrorException("init sdk err ret " + ret);
@@ -106,11 +108,21 @@ public class WxCpMsgAuditServiceImpl implements WxCpMsgAuditService {
   }
 
   @Override
-  public WxCpChatModel getDecryptData(@NonNull long sdk, @NonNull WxCpChatDatas.WxCpChatData chatData, @NonNull Integer pkcs1) throws Exception {
+  public WxCpChatModel getDecryptData(@NonNull long sdk, @NonNull WxCpChatDatas.WxCpChatData chatData,
+                                      @NonNull Integer pkcs1) throws Exception {
     String plainText = this.decryptChatData(sdk, chatData, pkcs1);
     return WxCpChatModel.fromJson(plainText);
   }
 
+  /**
+   * Decrypt chat data string.
+   *
+   * @param sdk      the sdk
+   * @param chatData the chat data
+   * @param pkcs1    the pkcs 1
+   * @return the string
+   * @throws Exception the exception
+   */
   public String decryptChatData(long sdk, WxCpChatDatas.WxCpChatData chatData, Integer pkcs1) throws Exception {
     /**
      * 企业获取的会话内容，使用企业自行配置的消息加密公钥进行加密，企业可用自行保存的私钥解开会话内容数据。
@@ -148,16 +160,19 @@ public class WxCpMsgAuditServiceImpl implements WxCpMsgAuditService {
   }
 
   @Override
-  public String getChatPlainText(@NonNull long sdk, WxCpChatDatas.@NonNull WxCpChatData chatData, @NonNull Integer pkcs1) throws Exception {
+  public String getChatPlainText(@NonNull long sdk, WxCpChatDatas.@NonNull WxCpChatData chatData,
+                                 @NonNull Integer pkcs1) throws Exception {
     return this.decryptChatData(sdk, chatData, pkcs1);
   }
 
   @Override
-  public void getMediaFile(@NonNull long sdk, @NonNull String sdkfileid, String proxy, String passwd, @NonNull long timeout, @NonNull String targetFilePath) throws WxErrorException {
+  public void getMediaFile(@NonNull long sdk, @NonNull String sdkfileid, String proxy, String passwd,
+                           @NonNull long timeout, @NonNull String targetFilePath) throws WxErrorException {
     /**
      * 1、媒体文件每次拉取的最大size为512k，因此超过512k的文件需要分片拉取。
      * 2、若该文件未拉取完整，sdk的IsMediaDataFinish接口会返回0，同时通过GetOutIndexBuf接口返回下次拉取需要传入GetMediaData的indexbuf。
-     * 3、indexbuf一般格式如右侧所示，”Range:bytes=524288-1048575“:表示这次拉取的是从524288到1048575的分片。单个文件首次拉取填写的indexbuf为空字符串，拉取后续分片时直接填入上次返回的indexbuf即可。
+     * 3、indexbuf一般格式如右侧所示，”Range:bytes=524288-1048575“:表示这次拉取的是从524288到1048575的分片。单个文件首次拉取填写的indexbuf
+     * 为空字符串，拉取后续分片时直接填入上次返回的indexbuf即可。
      */
     File targetFile = new File(targetFilePath);
     if (!targetFile.getParentFile().exists()) {
@@ -177,7 +192,8 @@ public class WxCpMsgAuditServiceImpl implements WxCpMsgAuditService {
       }
 
       data_len += Finance.GetDataLen(mediaData);
-      log.info("正在分片拉取媒体文件 len:{}, data_len:{}, is_finis:{} \n", Finance.GetIndexLen(mediaData), data_len, Finance.IsMediaDataFinish(mediaData));
+      log.info("正在分片拉取媒体文件 len:{}, data_len:{}, is_finis:{} \n", Finance.GetIndexLen(mediaData), data_len,
+        Finance.IsMediaDataFinish(mediaData));
 
       try {
         // 大于512k的文件会分片拉取，此处需要使用追加写，避免后面的分片覆盖之前的数据。
diff --git a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/api/impl/WxCpOAuth2ServiceImpl.java b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/api/impl/WxCpOAuth2ServiceImpl.java
index aac6e01a4..f5bd61ba9 100644
--- a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/api/impl/WxCpOAuth2ServiceImpl.java
+++ b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/api/impl/WxCpOAuth2ServiceImpl.java
@@ -67,7 +67,9 @@ public class WxCpOAuth2ServiceImpl implements WxCpOAuth2Service {
 
   @Override
   public WxCpOauth2UserInfo getUserInfo(Integer agentId, String code) throws WxErrorException {
-    String responseText = this.mainService.get(String.format(this.mainService.getWxCpConfigStorage().getApiUrl(GET_USER_INFO), code, agentId), null);
+    String responseText =
+      this.mainService.get(String.format(this.mainService.getWxCpConfigStorage().getApiUrl(GET_USER_INFO), code,
+        agentId), null);
     JsonObject jo = GsonParser.parse(responseText);
 
     return WxCpOauth2UserInfo.builder()
@@ -84,7 +86,9 @@ public class WxCpOAuth2ServiceImpl implements WxCpOAuth2Service {
 
   @Override
   public WxCpOauth2UserInfo getSchoolUserInfo(String code) throws WxErrorException {
-    String responseText = this.mainService.get(String.format(this.mainService.getWxCpConfigStorage().getApiUrl(GET_SCHOOL_USER_INFO), code), null);
+    String responseText =
+      this.mainService.get(String.format(this.mainService.getWxCpConfigStorage().getApiUrl(GET_SCHOOL_USER_INFO),
+        code), null);
     JsonObject jo = GsonParser.parse(responseText);
 
     return WxCpOauth2UserInfo.builder()
@@ -98,7 +102,8 @@ public class WxCpOAuth2ServiceImpl implements WxCpOAuth2Service {
   public WxCpUserDetail getUserDetail(String userTicket) throws WxErrorException {
     JsonObject param = new JsonObject();
     param.addProperty("user_ticket", userTicket);
-    String responseText = this.mainService.post(this.mainService.getWxCpConfigStorage().getApiUrl(GET_USER_DETAIL), param.toString());
+    String responseText = this.mainService.post(this.mainService.getWxCpConfigStorage().getApiUrl(GET_USER_DETAIL),
+      param.toString());
     return WxCpGsonBuilder.create().fromJson(responseText, WxCpUserDetail.class);
   }
 }
diff --git a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/api/impl/WxCpOaAgentServiceImpl.java b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/api/impl/WxCpOaAgentServiceImpl.java
index d305a84a3..250ee0cb2 100644
--- a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/api/impl/WxCpOaAgentServiceImpl.java
+++ b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/api/impl/WxCpOaAgentServiceImpl.java
@@ -17,8 +17,7 @@ import static me.chanjar.weixin.cp.constant.WxCpApiPathConsts.Oa.GET_OPEN_APPROV
 /**
  * 企业微信自建应用接口实现类.
  *
- * @author Wang_Wong
- * created on  2022-04-06
+ * @author Wang_Wong created on  2022-04-06
  */
 @Slf4j
 @RequiredArgsConstructor
diff --git a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/api/impl/WxCpOaCalendarServiceImpl.java b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/api/impl/WxCpOaCalendarServiceImpl.java
index da81181e6..ef2420449 100644
--- a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/api/impl/WxCpOaCalendarServiceImpl.java
+++ b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/api/impl/WxCpOaCalendarServiceImpl.java
@@ -17,8 +17,7 @@ import static me.chanjar.weixin.cp.constant.WxCpApiPathConsts.Oa.*;
 /**
  * .
  *
- * @author Binary Wang
- * created on  2020-09-20
+ * @author Binary Wang created on  2020-09-20
  */
 @RequiredArgsConstructor
 public class WxCpOaCalendarServiceImpl implements WxCpOaCalendarService {
diff --git a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/api/impl/WxCpOaMeetingRoomServiceImpl.java b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/api/impl/WxCpOaMeetingRoomServiceImpl.java
index 2bf5b0d57..f486028a0 100644
--- a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/api/impl/WxCpOaMeetingRoomServiceImpl.java
+++ b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/api/impl/WxCpOaMeetingRoomServiceImpl.java
@@ -7,7 +7,6 @@ import me.chanjar.weixin.common.util.json.GsonHelper;
 import me.chanjar.weixin.common.util.json.GsonParser;
 import me.chanjar.weixin.cp.api.WxCpOaMeetingRoomService;
 import me.chanjar.weixin.cp.api.WxCpService;
-
 import me.chanjar.weixin.cp.bean.oa.meetingroom.WxCpOaMeetingRoom;
 import me.chanjar.weixin.cp.util.json.WxCpGsonBuilder;
 
@@ -16,9 +15,10 @@ import java.util.List;
 import static me.chanjar.weixin.cp.constant.WxCpApiPathConsts.Oa.*;
 
 /**
+ * The type Wx cp oa meeting room service.
+ *
  * @author fcat
- * @version 1.0
- * Create by 2022/8/12 23:49
+ * @version 1.0  Create by 2022/8/12 23:49
  */
 @RequiredArgsConstructor
 public class WxCpOaMeetingRoomServiceImpl implements WxCpOaMeetingRoomService {
diff --git a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/api/impl/WxCpOaOaScheduleServiceImpl.java b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/api/impl/WxCpOaOaScheduleServiceImpl.java
index cd9d4ede6..c9a6161b2 100644
--- a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/api/impl/WxCpOaOaScheduleServiceImpl.java
+++ b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/api/impl/WxCpOaOaScheduleServiceImpl.java
@@ -21,8 +21,7 @@ import static me.chanjar.weixin.cp.constant.WxCpApiPathConsts.Oa.*;
 /**
  * 企业微信日程接口实现类.
  *
- * @author Binary Wang
- * created on  2020-12-25
+ * @author Binary Wang created on  2020-12-25
  */
 @Slf4j
 @RequiredArgsConstructor
diff --git a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/api/impl/WxCpOaServiceImpl.java b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/api/impl/WxCpOaServiceImpl.java
index b524bf4d3..289968757 100644
--- a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/api/impl/WxCpOaServiceImpl.java
+++ b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/api/impl/WxCpOaServiceImpl.java
@@ -24,8 +24,7 @@ import static me.chanjar.weixin.cp.constant.WxCpApiPathConsts.Oa.*;
 /**
  * 企业微信 OA 接口实现
  *
- * @author Element
- * created on  2019-04-06 11:20
+ * @author Element  created on  2019-04-06 11:20
  */
 @RequiredArgsConstructor
 public class WxCpOaServiceImpl implements WxCpOaService {
@@ -42,7 +41,8 @@ public class WxCpOaServiceImpl implements WxCpOaService {
   }
 
   @Override
-  public List getCheckinData(Integer openCheckinDataType, @NonNull Date startTime, @NonNull Date endTime,
+  public List getCheckinData(Integer openCheckinDataType, @NonNull Date startTime,
+                                              @NonNull Date endTime,
                                               List userIdList) throws WxErrorException {
     if (userIdList == null || userIdList.size() > USER_IDS_LIMIT) {
       throw new WxRuntimeException("用户列表不能为空，不超过 " + USER_IDS_LIMIT + " 个，若用户超过 " + USER_IDS_LIMIT + " 个，请分批获取");
@@ -197,7 +197,8 @@ public class WxCpOaServiceImpl implements WxCpOaService {
   }
 
   @Override
-  public WxCpBaseResp setOneUserQuota(@NonNull String userId, @NonNull Integer vacationId, @NonNull Integer leftDuration, @NonNull Integer timeAttr, String remarks) throws WxErrorException {
+  public WxCpBaseResp setOneUserQuota(@NonNull String userId, @NonNull Integer vacationId,
+                                      @NonNull Integer leftDuration, @NonNull Integer timeAttr, String remarks) throws WxErrorException {
     final String url = this.mainService.getWxCpConfigStorage().getApiUrl(SET_ONE_USER_QUOTA);
     JsonObject jsonObject = new JsonObject();
     jsonObject.addProperty("userid", userId);
@@ -259,7 +260,8 @@ public class WxCpOaServiceImpl implements WxCpOaService {
   }
 
   @Override
-  public List getCheckinDayData(@NonNull Date startTime, @NonNull Date endTime, List userIdList)
+  public List getCheckinDayData(@NonNull Date startTime, @NonNull Date endTime,
+                                                    List userIdList)
     throws WxErrorException {
     if (userIdList == null || userIdList.size() > USER_IDS_LIMIT) {
       throw new WxRuntimeException("用户列表不能为空，不超过 " + USER_IDS_LIMIT + " 个，若用户超过 " + USER_IDS_LIMIT + " 个，请分批获取");
@@ -289,7 +291,8 @@ public class WxCpOaServiceImpl implements WxCpOaService {
   }
 
   @Override
-  public List getCheckinMonthData(@NonNull Date startTime, @NonNull Date endTime, List userIdList)
+  public List getCheckinMonthData(@NonNull Date startTime, @NonNull Date endTime,
+                                                        List userIdList)
     throws WxErrorException {
     if (userIdList == null || userIdList.size() > USER_IDS_LIMIT) {
       throw new WxRuntimeException("用户列表不能为空，不超过 " + USER_IDS_LIMIT + " 个，若用户超过 " + USER_IDS_LIMIT + " 个，请分批获取");
@@ -319,7 +322,8 @@ public class WxCpOaServiceImpl implements WxCpOaService {
   }
 
   @Override
-  public List getCheckinScheduleList(@NonNull Date startTime, @NonNull Date endTime, List userIdList)
+  public List getCheckinScheduleList(@NonNull Date startTime, @NonNull Date endTime,
+                                                          List userIdList)
     throws WxErrorException {
     if (userIdList == null || userIdList.size() > USER_IDS_LIMIT) {
       throw new WxRuntimeException("用户列表不能为空，不超过 " + USER_IDS_LIMIT + " 个，若用户超过 " + USER_IDS_LIMIT + " 个，请分批获取");
diff --git a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/api/impl/WxCpOaWeDriveServiceImpl.java b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/api/impl/WxCpOaWeDriveServiceImpl.java
index 3d5bb22f0..979e86e55 100644
--- a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/api/impl/WxCpOaWeDriveServiceImpl.java
+++ b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/api/impl/WxCpOaWeDriveServiceImpl.java
@@ -17,8 +17,7 @@ import static me.chanjar.weixin.cp.constant.WxCpApiPathConsts.Oa.*;
 /**
  * 企业微信微盘接口实现类.
  *
- * @author Wang_Wong
- * created on  2022-04-22
+ * @author Wang_Wong  created on  2022-04-22
  */
 @Slf4j
 @RequiredArgsConstructor
@@ -126,7 +125,8 @@ public class WxCpOaWeDriveServiceImpl implements WxCpOaWeDriveService {
   }
 
   @Override
-  public WxCpFileCreate fileCreate(@NonNull String userId, @NonNull String spaceId, @NonNull String fatherId, @NonNull Integer fileType, @NonNull String fileName) throws WxErrorException {
+  public WxCpFileCreate fileCreate(@NonNull String userId, @NonNull String spaceId, @NonNull String fatherId,
+                                   @NonNull Integer fileType, @NonNull String fileName) throws WxErrorException {
     String apiUrl = this.cpService.getWxCpConfigStorage().getApiUrl(FILE_CREATE);
     JsonObject jsonObject = new JsonObject();
     jsonObject.addProperty("userid", userId);
@@ -168,7 +168,8 @@ public class WxCpOaWeDriveServiceImpl implements WxCpOaWeDriveService {
   }
 
   @Override
-  public WxCpBaseResp fileSetting(@NonNull String userId, @NonNull String fileId, @NonNull Integer authScope, Integer auth) throws WxErrorException {
+  public WxCpBaseResp fileSetting(@NonNull String userId, @NonNull String fileId, @NonNull Integer authScope,
+                                  Integer auth) throws WxErrorException {
     String apiUrl = this.cpService.getWxCpConfigStorage().getApiUrl(FILE_SETTING);
     JsonObject jsonObject = new JsonObject();
     jsonObject.addProperty("userid", userId);
diff --git a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/api/impl/WxCpSchoolHealthServiceImpl.java b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/api/impl/WxCpSchoolHealthServiceImpl.java
index 4a96415c0..60f379da8 100644
--- a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/api/impl/WxCpSchoolHealthServiceImpl.java
+++ b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/api/impl/WxCpSchoolHealthServiceImpl.java
@@ -19,8 +19,7 @@ import static me.chanjar.weixin.cp.constant.WxCpApiPathConsts.School.*;
 /**
  * 企业微信家校应用 健康上报接口实现类.
  *
- * @author Wang_Wong
- * created on : 2022/5/31 9:16
+ * @author Wang_Wong created on : 2022/5/31 9:16
  */
 @Slf4j
 @RequiredArgsConstructor
@@ -58,7 +57,8 @@ public class WxCpSchoolHealthServiceImpl implements WxCpSchoolHealthService {
   }
 
   @Override
-  public WxCpGetReportAnswer getReportAnswer(@NonNull String jobId, @NonNull String date, Integer offset, Integer limit) throws WxErrorException {
+  public WxCpGetReportAnswer getReportAnswer(@NonNull String jobId, @NonNull String date, Integer offset,
+                                             Integer limit) throws WxErrorException {
     String apiUrl = this.cpService.getWxCpConfigStorage().getApiUrl(GET_REPORT_ANSWER);
     JsonObject jsonObject = new JsonObject();
     jsonObject.addProperty("jobid", jobId);
diff --git a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/api/impl/WxCpSchoolServiceImpl.java b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/api/impl/WxCpSchoolServiceImpl.java
index eab2d5445..7d8cadca3 100644
--- a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/api/impl/WxCpSchoolServiceImpl.java
+++ b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/api/impl/WxCpSchoolServiceImpl.java
@@ -21,8 +21,7 @@ import static me.chanjar.weixin.cp.constant.WxCpApiPathConsts.School.*;
  * 企业微信家校应用 复学码相关接口实现类.
  * https://developer.work.weixin.qq.com/document/path/93744
  *
- * @author Wang_Wong
- * created on : 2022/6/1 14:05
+ * @author Wang_Wong created on : 2022/6/1 14:05
  */
 @Slf4j
 @RequiredArgsConstructor
diff --git a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/api/impl/WxCpSchoolUserServiceImpl.java b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/api/impl/WxCpSchoolUserServiceImpl.java
index 21c92341d..fac1689e0 100644
--- a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/api/impl/WxCpSchoolUserServiceImpl.java
+++ b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/api/impl/WxCpSchoolUserServiceImpl.java
@@ -24,8 +24,7 @@ import static me.chanjar.weixin.cp.constant.WxCpApiPathConsts.School.*;
  * 企业微信家校沟通相关接口.
  * https://developer.work.weixin.qq.com/document/path/91638
  *
- * @author Wang_Wong
- * created on : 2022/6/18 9:10
+ * @author Wang_Wong created on : 2022/6/18 9:10
  */
 @Slf4j
 @RequiredArgsConstructor
@@ -44,7 +43,8 @@ public class WxCpSchoolUserServiceImpl implements WxCpSchoolUserService {
   }
 
   @Override
-  public WxCpBaseResp createStudent(@NonNull String studentUserId, @NonNull String name, @NonNull List departments) throws WxErrorException {
+  public WxCpBaseResp createStudent(@NonNull String studentUserId, @NonNull String name,
+                                    @NonNull List departments) throws WxErrorException {
     String apiUrl = this.cpService.getWxCpConfigStorage().getApiUrl(CREATE_STUDENT);
     JsonObject jsonObject = new JsonObject();
     jsonObject.addProperty("student_userid", studentUserId);
@@ -87,7 +87,8 @@ public class WxCpSchoolUserServiceImpl implements WxCpSchoolUserService {
   }
 
   @Override
-  public WxCpBaseResp updateStudent(@NonNull String studentUserId, String newStudentUserId, String name, List departments) throws WxErrorException {
+  public WxCpBaseResp updateStudent(@NonNull String studentUserId, String newStudentUserId, String name,
+                                    List departments) throws WxErrorException {
     String apiUrl = this.cpService.getWxCpConfigStorage().getApiUrl(UPDATE_STUDENT);
     JsonObject jsonObject = new JsonObject();
     jsonObject.addProperty("student_userid", studentUserId);
@@ -151,7 +152,8 @@ public class WxCpSchoolUserServiceImpl implements WxCpSchoolUserService {
 
   @Override
   public WxCpUserListResult getUserList(@NonNull Integer departmentId, Integer fetchChild) throws WxErrorException {
-    String apiUrl = String.format(this.cpService.getWxCpConfigStorage().getApiUrl(GET_USER_LIST), departmentId, fetchChild);
+    String apiUrl = String.format(this.cpService.getWxCpConfigStorage().getApiUrl(GET_USER_LIST), departmentId,
+      fetchChild);
     String responseContent = this.cpService.get(apiUrl, null);
     return WxCpUserListResult.fromJson(responseContent);
   }
diff --git a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/api/impl/WxCpServiceApacheHttpClientImpl.java b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/api/impl/WxCpServiceApacheHttpClientImpl.java
index b428bc34a..7e69152a1 100644
--- a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/api/impl/WxCpServiceApacheHttpClientImpl.java
+++ b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/api/impl/WxCpServiceApacheHttpClientImpl.java
@@ -1,8 +1,8 @@
 package me.chanjar.weixin.cp.api.impl;
 
 
-import me.chanjar.weixin.common.enums.WxType;
 import me.chanjar.weixin.common.bean.WxAccessToken;
+import me.chanjar.weixin.common.enums.WxType;
 import me.chanjar.weixin.common.error.WxError;
 import me.chanjar.weixin.common.error.WxErrorException;
 import me.chanjar.weixin.common.error.WxRuntimeException;
@@ -21,6 +21,8 @@ import org.apache.http.impl.client.CloseableHttpClient;
 import java.io.IOException;
 
 /**
+ * The type Wx cp service apache http client.
+ *
  * @author someone
  */
 public class WxCpServiceApacheHttpClientImpl extends BaseWxCpServiceImpl {
@@ -49,7 +51,8 @@ public class WxCpServiceApacheHttpClientImpl extends BaseWxCpServiceImpl {
diff --git a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/api/impl/WxCpServiceOkHttpImpl.java b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/api/impl/WxCpServiceOkHttpImpl.java
index 5fb5a7375..733f68e24 100644
--- a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/api/impl/WxCpServiceOkHttpImpl.java
+++ b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/api/impl/WxCpServiceOkHttpImpl.java
@@ -1,8 +1,8 @@
 package me.chanjar.weixin.cp.api.impl;
 
 import lombok.extern.slf4j.Slf4j;
-import me.chanjar.weixin.common.enums.WxType;
 import me.chanjar.weixin.common.bean.WxAccessToken;
+import me.chanjar.weixin.common.enums.WxType;
 import me.chanjar.weixin.common.error.WxError;
 import me.chanjar.weixin.common.error.WxErrorException;
 import me.chanjar.weixin.common.util.http.HttpType;
@@ -15,6 +15,8 @@ import java.io.IOException;
 import static me.chanjar.weixin.cp.constant.WxCpApiPathConsts.GET_TOKEN;
 
 /**
+ * The type Wx cp service ok http.
+ *
  * @author someone
  */
 @Slf4j
@@ -48,7 +50,8 @@ public class WxCpServiceOkHttpImpl extends BaseWxCpServiceImpl
@@ -18,8 +19,7 @@ import static me.chanjar.weixin.cp.constant.WxCpApiPathConsts.TaskCard.*;
  *  Created by Jeff on 2019-05-16.
  *
* - * @author Jeff - * created on 2019-05-16 + * @author Jeff created on 2019-05-16 */ @RequiredArgsConstructor public class WxCpTaskCardServiceImpl implements WxCpTaskCardService { @@ -41,8 +41,8 @@ public class WxCpTaskCardServiceImpl implements WxCpTaskCardService { @Override public void updateTemplateCardButton(List userIds, List partyIds, - List tagIds, Integer atAll, - String responseCode, String replaceName) throws WxErrorException { + List tagIds, Integer atAll, + String responseCode, String replaceName) throws WxErrorException { Integer agentId = this.mainService.getWxCpConfigStorage().getAgentId(); Map data = new HashMap<>(7); data.put("userids", userIds); diff --git a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/Gender.java b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/Gender.java index 99da96262..b47697ffa 100644 --- a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/Gender.java +++ b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/Gender.java @@ -30,6 +30,12 @@ public enum Gender { private final String genderName; private final String code; + /** + * From code gender. + * + * @param code the code + * @return the gender + */ public static Gender fromCode(String code) { for (Gender a : Gender.values()) { if (a.code.equals(code)) { diff --git a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/WxCpAgent.java b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/WxCpAgent.java index 04b0dd72e..898ca78b5 100644 --- a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/WxCpAgent.java +++ b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/WxCpAgent.java @@ -70,14 +70,28 @@ public class WxCpAgent implements Serializable { @SerializedName("home_url") private String homeUrl; + /** + * From json wx cp agent. + * + * @param json the json + * @return the wx cp agent + */ public static WxCpAgent fromJson(String json) { return WxCpGsonBuilder.create().fromJson(json, WxCpAgent.class); } + /** + * To json string. + * + * @return the string + */ public String toJson() { return WxCpGsonBuilder.create().toJson(this); } + /** + * The type Users. + */ @Data public static class Users implements Serializable { private static final long serialVersionUID = 8801100463558788565L; @@ -86,6 +100,9 @@ public class WxCpAgent implements Serializable { private List users; } + /** + * The type User. + */ @Data public static class User implements Serializable { private static final long serialVersionUID = 7287632514385508024L; @@ -94,12 +111,18 @@ public class WxCpAgent implements Serializable { private String userId; } + /** + * The type Parties. + */ @Data public static class Parties { @SerializedName("partyid") private List partyIds = null; } + /** + * The type Tags. + */ @Data public static class Tags { @SerializedName("tagid") diff --git a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/WxCpAgentWorkBench.java b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/WxCpAgentWorkBench.java index fc2881bda..a2737f723 100644 --- a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/WxCpAgentWorkBench.java +++ b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/WxCpAgentWorkBench.java @@ -14,9 +14,9 @@ import java.io.Serializable; import java.util.List; /** - * @author songshiyu - * created on : create in 16:09 2020/9/27 - * 工作台自定义展示 + * The type Wx cp agent work bench. + * + * @author songshiyu created on : create in 16:09 2020/9/27 工作台自定义展示 */ @Data @Builder @@ -60,6 +60,8 @@ public class WxCpAgentWorkBench implements Serializable { /** * 生成模板Json字符串 + * + * @return the string */ public String toTemplateString() { JsonObject templateObject = new JsonObject(); @@ -74,6 +76,8 @@ public class WxCpAgentWorkBench implements Serializable { /** * 生成用户数据Json字符串 + * + * @return the string */ public String toUserDataString() { JsonObject userDataObject = new JsonObject(); diff --git a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/WxCpBaseResp.java b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/WxCpBaseResp.java index f1b342df0..6bf9a30ae 100644 --- a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/WxCpBaseResp.java +++ b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/WxCpBaseResp.java @@ -10,28 +10,49 @@ import java.io.Serializable; /** * 返回结果 * - * @author yqx & WangWong - * created on 2020/3/16 + * @author yqx & WangWong created on 2020/3/16 */ @Getter @Setter public class WxCpBaseResp implements Serializable { private static final long serialVersionUID = -4301684507150486556L; + /** + * The Errcode. + */ @SerializedName("errcode") protected Long errcode; + /** + * The Errmsg. + */ @SerializedName("errmsg") protected String errmsg; + /** + * Success boolean. + * + * @return the boolean + */ public boolean success() { return getErrcode() == 0; } + /** + * From json wx cp base resp. + * + * @param json the json + * @return the wx cp base resp + */ public static WxCpBaseResp fromJson(String json) { return WxCpGsonBuilder.create().fromJson(json, WxCpBaseResp.class); } + /** + * To json string. + * + * @return the string + */ public String toJson() { return WxCpGsonBuilder.create().toJson(this); } diff --git a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/WxCpDepart.java b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/WxCpDepart.java index 5c640c51c..bc54e7e80 100644 --- a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/WxCpDepart.java +++ b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/WxCpDepart.java @@ -21,10 +21,21 @@ public class WxCpDepart implements Serializable { private Long parentId; private Long order; + /** + * From json wx cp depart. + * + * @param json the json + * @return the wx cp depart + */ public static WxCpDepart fromJson(String json) { return WxCpGsonBuilder.create().fromJson(json, WxCpDepart.class); } + /** + * To json string. + * + * @return the string + */ public String toJson() { return WxCpGsonBuilder.create().toJson(this); } diff --git a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/WxCpInviteResult.java b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/WxCpInviteResult.java index 5ab4f5246..3cbeb7ce7 100644 --- a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/WxCpInviteResult.java +++ b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/WxCpInviteResult.java @@ -21,6 +21,12 @@ public class WxCpInviteResult implements Serializable { return WxCpGsonBuilder.create().toJson(this); } + /** + * From json wx cp invite result. + * + * @param json the json + * @return the wx cp invite result + */ public static WxCpInviteResult fromJson(String json) { return WxCpGsonBuilder.create().fromJson(json, WxCpInviteResult.class); } diff --git a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/WxCpMaJsCode2SessionResult.java b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/WxCpMaJsCode2SessionResult.java index 7291489d9..f4de0b988 100644 --- a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/WxCpMaJsCode2SessionResult.java +++ b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/WxCpMaJsCode2SessionResult.java @@ -27,6 +27,12 @@ public class WxCpMaJsCode2SessionResult implements Serializable { @SerializedName("corpid") private String corpId; + /** + * From json wx cp ma js code 2 session result. + * + * @param json the json + * @return the wx cp ma js code 2 session result + */ public static WxCpMaJsCode2SessionResult fromJson(String json) { return WxCpGsonBuilder.create().fromJson(json, WxCpMaJsCode2SessionResult.class); } diff --git a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/WxCpOauth2UserInfo.java b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/WxCpOauth2UserInfo.java index a35a37c05..433e54a68 100644 --- a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/WxCpOauth2UserInfo.java +++ b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/WxCpOauth2UserInfo.java @@ -13,7 +13,7 @@ import java.io.Serializable; * 用oauth2获取用户信息的结果类 * Created by BinaryWang on 2019/5/26. * - * + *

* 文档1：https://developer.work.weixin.qq.com/document/path/91707 * * @author Binary Wang diff --git a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/WxCpProviderToken.java b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/WxCpProviderToken.java index 2caac57ec..872b96d93 100644 --- a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/WxCpProviderToken.java +++ b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/WxCpProviderToken.java @@ -9,8 +9,7 @@ import java.io.Serializable; /** * 服务商凭证. * - * @author Binary Wang - * created on 2019-11-02 + * @author Binary Wang created on 2019-11-02 */ @Data public class WxCpProviderToken implements Serializable { @@ -28,6 +27,12 @@ public class WxCpProviderToken implements Serializable { @SerializedName("expires_in") private Integer expiresIn; + /** + * From json wx cp provider token. + * + * @param json the json + * @return the wx cp provider token + */ public static WxCpProviderToken fromJson(String json) { return WxCpGsonBuilder.create().fromJson(json, WxCpProviderToken.class); } diff --git a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/WxCpTag.java b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/WxCpTag.java index 8649f0ced..33d3d07b2 100644 --- a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/WxCpTag.java +++ b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/WxCpTag.java @@ -23,10 +23,21 @@ public class WxCpTag implements Serializable { private String name; + /** + * From json wx cp tag. + * + * @param json the json + * @return the wx cp tag + */ public static WxCpTag fromJson(String json) { return WxCpGsonBuilder.create().fromJson(json, WxCpTag.class); } + /** + * To json string. + * + * @return the string + */ public String toJson() { return WxCpGsonBuilder.create().toJson(this); } diff --git a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/WxCpTagAddOrRemoveUsersResult.java b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/WxCpTagAddOrRemoveUsersResult.java index adac17488..c590c6c0e 100644 --- a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/WxCpTagAddOrRemoveUsersResult.java +++ b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/WxCpTagAddOrRemoveUsersResult.java @@ -25,6 +25,12 @@ public class WxCpTagAddOrRemoveUsersResult implements Serializable { return WxCpGsonBuilder.create().toJson(this); } + /** + * From json wx cp tag add or remove users result. + * + * @param json the json + * @return the wx cp tag add or remove users result + */ public static WxCpTagAddOrRemoveUsersResult fromJson(String json) { return WxCpGsonBuilder.create().fromJson(json, WxCpTagAddOrRemoveUsersResult.class); } @@ -41,6 +47,11 @@ public class WxCpTagAddOrRemoveUsersResult implements Serializable { @SerializedName("invalidparty") private String[] invalidParty; + /** + * Gets invalid user list. + * + * @return the invalid user list + */ public List getInvalidUserList() { return this.content2List(this.invalidUsers); } diff --git a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/WxCpTagGetResult.java b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/WxCpTagGetResult.java index 244419b06..3dc34ab65 100644 --- a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/WxCpTagGetResult.java +++ b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/WxCpTagGetResult.java @@ -46,10 +46,21 @@ public class WxCpTagGetResult implements Serializable { @SerializedName("tagname") private String tagname; + /** + * From json wx cp tag get result. + * + * @param json the json + * @return the wx cp tag get result + */ public static WxCpTagGetResult fromJson(String json) { return WxCpGsonBuilder.create().fromJson(json, WxCpTagGetResult.class); } + /** + * To json string. + * + * @return the string + */ public String toJson() { return WxCpGsonBuilder.create().toJson(this); } diff --git a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/WxCpTaskCardUpdateResult.java b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/WxCpTaskCardUpdateResult.java index c22bb2b8a..d4cee5549 100644 --- a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/WxCpTaskCardUpdateResult.java +++ b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/WxCpTaskCardUpdateResult.java @@ -16,8 +16,7 @@ import java.util.List; * Created by Jeff on 2019-05-16. * * - * @author Jeff - * created on 2019-05-16 + * @author Jeff created on 2019-05-16 */ @Data @AllArgsConstructor @@ -36,6 +35,12 @@ public class WxCpTaskCardUpdateResult implements Serializable { @SerializedName("invaliduser") private List invalidUsers; + /** + * From json wx cp task card update result. + * + * @param json the json + * @return the wx cp task card update result + */ public static WxCpTaskCardUpdateResult fromJson(String json) { return WxCpGsonBuilder.create().fromJson(json, WxCpTaskCardUpdateResult.class); } diff --git a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/WxCpTpAdmin.java b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/WxCpTpAdmin.java index 438ef79fd..776726de8 100644 --- a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/WxCpTpAdmin.java +++ b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/WxCpTpAdmin.java @@ -23,6 +23,9 @@ public class WxCpTpAdmin extends WxCpBaseResp { @SerializedName("admin") private List admin; + /** + * The type Admin. + */ @Getter @Setter public static class Admin extends WxCpBaseResp { @@ -30,7 +33,7 @@ public class WxCpTpAdmin extends WxCpBaseResp { @SerializedName("userid") private String userId; - + @SerializedName("open_userid") private String openUserId; @@ -42,6 +45,12 @@ public class WxCpTpAdmin extends WxCpBaseResp { } } + /** + * From json wx cp tp admin. + * + * @param json the json + * @return the wx cp tp admin + */ public static WxCpTpAdmin fromJson(String json) { return WxCpGsonBuilder.create().fromJson(json, WxCpTpAdmin.class); } diff --git a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/WxCpTpAuthInfo.java b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/WxCpTpAuthInfo.java index 1f089e762..fa5021615 100644 --- a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/WxCpTpAuthInfo.java +++ b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/WxCpTpAuthInfo.java @@ -43,6 +43,9 @@ public class WxCpTpAuthInfo extends WxCpBaseResp { @SerializedName("edition_info") private EditionInfo editionInfo; + /** + * The type Dealer corp info. + */ @Getter @Setter public static class DealerCorpInfo extends WxCpBaseResp { @@ -55,6 +58,9 @@ public class WxCpTpAuthInfo extends WxCpBaseResp { private String corpName; } + /** + * The type Auth corp info. + */ @Getter @Setter public static class AuthCorpInfo implements Serializable { @@ -151,6 +157,9 @@ public class WxCpTpAuthInfo extends WxCpBaseResp { } + /** + * The type Agent. + */ @Getter @Setter public static class Agent implements Serializable { @@ -297,6 +306,12 @@ public class WxCpTpAuthInfo extends WxCpBaseResp { } + /** + * From json wx cp tp auth info. + * + * @param json the json + * @return the wx cp tp auth info + */ public static WxCpTpAuthInfo fromJson(String json) { return WxCpGsonBuilder.create().fromJson(json, WxCpTpAuthInfo.class); } diff --git a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/WxCpTpContactSearch.java b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/WxCpTpContactSearch.java index cc84dfd4d..e5e44d18a 100644 --- a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/WxCpTpContactSearch.java +++ b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/WxCpTpContactSearch.java @@ -8,9 +8,11 @@ import me.chanjar.weixin.cp.util.json.WxCpGsonBuilder; import java.io.Serializable; /** + * The type Wx cp tp contact search. + * * @author uianz * @description - * @since 2020/12/23 下午 02:43 + * @since 2020 /12/23 下午 02:43 */ @Data @Accessors(chain = true) @@ -59,6 +61,11 @@ public class WxCpTpContactSearch implements Serializable { @SerializedName("full_match_field") private Integer fullMatchField; + /** + * To json string. + * + * @return the string + */ public String toJson() { return WxCpGsonBuilder.create().toJson(this); } diff --git a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/WxCpTpContactSearchResp.java b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/WxCpTpContactSearchResp.java index 21db4e083..5646d5f10 100644 --- a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/WxCpTpContactSearchResp.java +++ b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/WxCpTpContactSearchResp.java @@ -9,9 +9,11 @@ import java.io.Serializable; import java.util.List; /** + * The type Wx cp tp contact search resp. + * * @author uianz * @description - * @since 2020/12/23 下午 02:55 + * @since 2020 /12/23 下午 02:55 */ @EqualsAndHashCode(callSuper = true) @Data @@ -23,6 +25,9 @@ public class WxCpTpContactSearchResp extends WxCpBaseResp { @SerializedName("query_result") private QueryResult queryResult; + /** + * The type Query result. + */ @Data public static class QueryResult implements Serializable { private static final long serialVersionUID = -4301684507150486556L; @@ -32,6 +37,9 @@ public class WxCpTpContactSearchResp extends WxCpBaseResp { @SerializedName("party") private Party party; + /** + * The type User. + */ @Data public static class User implements Serializable { private static final long serialVersionUID = -4301684507150486556L; @@ -41,6 +49,9 @@ public class WxCpTpContactSearchResp extends WxCpBaseResp { private List openUserId; } + /** + * The type Party. + */ @Data public static class Party implements Serializable { private static final long serialVersionUID = -4301684507150486556L; @@ -51,6 +62,12 @@ public class WxCpTpContactSearchResp extends WxCpBaseResp { } + /** + * From json wx cp tp contact search resp. + * + * @param json the json + * @return the wx cp tp contact search resp + */ public static WxCpTpContactSearchResp fromJson(String json) { return WxCpGsonBuilder.create().fromJson(json, WxCpTpContactSearchResp.class); } diff --git a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/WxCpTpCorp.java b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/WxCpTpCorp.java index efe6d8285..939a4eddf 100644 --- a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/WxCpTpCorp.java +++ b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/WxCpTpCorp.java @@ -32,10 +32,21 @@ public class WxCpTpCorp implements Serializable { @SerializedName("auth_info") private String authInfo; + /** + * From json wx cp tp corp. + * + * @param json the json + * @return the wx cp tp corp + */ public static WxCpTpCorp fromJson(String json) { return WxCpGsonBuilder.create().fromJson(json, WxCpTpCorp.class); } + /** + * To json string. + * + * @return the string + */ public String toJson() { return WxCpGsonBuilder.create().toJson(this); } diff --git a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/WxCpTpDepart.java b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/WxCpTpDepart.java index ab94a6b6b..39d3601a2 100644 --- a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/WxCpTpDepart.java +++ b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/WxCpTpDepart.java @@ -20,10 +20,21 @@ public class WxCpTpDepart implements Serializable { private Integer parentid; private Integer order; + /** + * From json wx cp tp depart. + * + * @param json the json + * @return the wx cp tp depart + */ public static WxCpTpDepart fromJson(String json) { return WxCpGsonBuilder.create().fromJson(json, WxCpTpDepart.class); } + /** + * To json string. + * + * @return the string + */ public String toJson() { return WxCpGsonBuilder.create().toJson(this); } diff --git a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/WxCpTpPermanentCodeInfo.java b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/WxCpTpPermanentCodeInfo.java index eaf10feae..7293ccf30 100644 --- a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/WxCpTpPermanentCodeInfo.java +++ b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/WxCpTpPermanentCodeInfo.java @@ -45,7 +45,7 @@ public class WxCpTpPermanentCodeInfo extends WxCpBaseResp { */ @SerializedName("auth_user_info") private AuthUserInfo authUserInfo; - + /** * 推广二维码安装相关信息 */ @@ -58,6 +58,9 @@ public class WxCpTpPermanentCodeInfo extends WxCpBaseResp { @SerializedName("edition_info") private EditionInfo editionInfo; + /** + * The type Auth corp info. + */ @Getter @Setter public static class AuthCorpInfo implements Serializable { @@ -154,6 +157,9 @@ public class WxCpTpPermanentCodeInfo extends WxCpBaseResp { } + /** + * The type Agent. + */ @Getter @Setter public static class Agent implements Serializable { @@ -284,7 +290,7 @@ public class WxCpTpPermanentCodeInfo extends WxCpBaseResp { @SerializedName("open_userid") private String openUserid; } - + /** * 推广二维码安装相关信息 */ @@ -353,6 +359,12 @@ public class WxCpTpPermanentCodeInfo extends WxCpBaseResp { } + /** + * From json wx cp tp permanent code info. + * + * @param json the json + * @return the wx cp tp permanent code info + */ public static WxCpTpPermanentCodeInfo fromJson(String json) { return WxCpGsonBuilder.create().fromJson(json, WxCpTpPermanentCodeInfo.class); } diff --git a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/WxCpTpPreauthCode.java b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/WxCpTpPreauthCode.java index 6dc9ddc2d..31c61b3a2 100644 --- a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/WxCpTpPreauthCode.java +++ b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/WxCpTpPreauthCode.java @@ -8,19 +8,30 @@ import me.chanjar.weixin.cp.util.json.WxCpGsonBuilder; /** * 预授权码返回 * - * @author yqx - * created on 2020/3/19 + * @author yqx created on 2020/3/19 */ @Getter @Setter public class WxCpTpPreauthCode extends WxCpBaseResp { + /** + * The Pre auth code. + */ @SerializedName("pre_auth_code") String preAuthCode; + /** + * The Expires in. + */ @SerializedName("expires_in") Long expiresIn; + /** + * From json wx cp tp preauth code. + * + * @param json the json + * @return the wx cp tp preauth code + */ public static WxCpTpPreauthCode fromJson(String json) { return WxCpGsonBuilder.create().fromJson(json, WxCpTpPreauthCode.class); } diff --git a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/WxCpTpProlongTryResult.java b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/WxCpTpProlongTryResult.java index 8d89f0de6..427e020a2 100644 --- a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/WxCpTpProlongTryResult.java +++ b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/WxCpTpProlongTryResult.java @@ -7,8 +7,8 @@ import me.chanjar.weixin.cp.util.json.WxCpGsonBuilder; /** * 应用市场延长试用期结果 - * @author leiguoqing - * created on 2022年4月24日 + * + * @author leiguoqing created on 2022年4月24日 */ @Getter @Setter diff --git a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/WxCpTpTag.java b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/WxCpTpTag.java index 73d7a5157..74e1fec3f 100644 --- a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/WxCpTpTag.java +++ b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/WxCpTpTag.java @@ -7,8 +7,10 @@ import me.chanjar.weixin.cp.util.json.WxCpGsonBuilder; import java.io.Serializable; /** + * The type Wx cp tp tag. + * * @author zhangq - * @since 2021-02-14 16:15 16:15 + * @since 2021 -02-14 16:15 16:15 */ @Data public class WxCpTpTag implements Serializable { @@ -20,6 +22,12 @@ public class WxCpTpTag implements Serializable { @SerializedName("tagname") private String tagName; + /** + * Deserialize wx cp tp tag. + * + * @param json the json + * @return the wx cp tp tag + */ public static WxCpTpTag deserialize(String json) { return WxCpGsonBuilder.create().fromJson(json, WxCpTpTag.class); } diff --git a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/WxCpTpTagAddOrRemoveUsersResult.java b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/WxCpTpTagAddOrRemoveUsersResult.java index 8a9fecf21..dfbf25048 100644 --- a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/WxCpTpTagAddOrRemoveUsersResult.java +++ b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/WxCpTpTagAddOrRemoveUsersResult.java @@ -6,11 +6,17 @@ import me.chanjar.weixin.cp.util.json.WxCpGsonBuilder; * 企业微信第三方开发-增加标签成员成员api响应体 * * @author zhangq - * @since 2021/2/14 16:44 + * @since 2021 /2/14 16:44 */ public class WxCpTpTagAddOrRemoveUsersResult extends WxCpTagAddOrRemoveUsersResult { private static final long serialVersionUID = 3490401800490702052L; + /** + * Deserialize wx cp tp tag add or remove users result. + * + * @param json the json + * @return the wx cp tp tag add or remove users result + */ public static WxCpTpTagAddOrRemoveUsersResult deserialize(String json) { return WxCpGsonBuilder.create().fromJson(json, WxCpTpTagAddOrRemoveUsersResult.class); } diff --git a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/WxCpTpTagGetResult.java b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/WxCpTpTagGetResult.java index 4fdc9a58a..162030c95 100644 --- a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/WxCpTpTagGetResult.java +++ b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/WxCpTpTagGetResult.java @@ -6,11 +6,17 @@ import me.chanjar.weixin.cp.util.json.WxCpGsonBuilder; * 获取标签成员接口响应体 * * @author zhangq - * @since 2021/2/14 16:28 + * @since 2021 /2/14 16:28 */ public class WxCpTpTagGetResult extends WxCpTagGetResult { private static final long serialVersionUID = 9051748686315562400L; + /** + * Deserialize wx cp tp tag get result. + * + * @param json the json + * @return the wx cp tp tag get result + */ public static WxCpTpTagGetResult deserialize(String json) { return WxCpGsonBuilder.create().fromJson(json, WxCpTpTagGetResult.class); } diff --git a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/WxCpTpUserDetail.java b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/WxCpTpUserDetail.java index 280939125..a60d387a7 100644 --- a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/WxCpTpUserDetail.java +++ b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/WxCpTpUserDetail.java @@ -6,6 +6,8 @@ import lombok.EqualsAndHashCode; import me.chanjar.weixin.cp.util.json.WxCpGsonBuilder; /** + * The type Wx cp tp user detail. + * * @author huangxiaoming */ @Data @@ -48,6 +50,12 @@ public class WxCpTpUserDetail extends WxCpBaseResp { @SerializedName("qr_code") private String qrCode; + /** + * From json wx cp tp user detail. + * + * @param json the json + * @return the wx cp tp user detail + */ public static WxCpTpUserDetail fromJson(String json) { return WxCpGsonBuilder.create().fromJson(json, WxCpTpUserDetail.class); } diff --git a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/WxCpTpUserInfo.java b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/WxCpTpUserInfo.java index 0138b2a9d..c6664fd0a 100644 --- a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/WxCpTpUserInfo.java +++ b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/WxCpTpUserInfo.java @@ -6,9 +6,10 @@ import lombok.EqualsAndHashCode; import me.chanjar.weixin.cp.util.json.WxCpGsonBuilder; /** + * The type Wx cp tp user info. + * * @author huangxiaoming */ - @Data @EqualsAndHashCode(callSuper = true) public class WxCpTpUserInfo extends WxCpBaseResp { @@ -53,6 +54,12 @@ public class WxCpTpUserInfo extends WxCpBaseResp { @SerializedName("open_userid") private String openUserId; + /** + * From json wx cp tp user info. + * + * @param json the json + * @return the wx cp tp user info + */ public static WxCpTpUserInfo fromJson(String json) { return WxCpGsonBuilder.create().fromJson(json, WxCpTpUserInfo.class); } diff --git a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/WxCpTpXmlPackage.java b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/WxCpTpXmlPackage.java index 4d9d9493a..cdba33229 100644 --- a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/WxCpTpXmlPackage.java +++ b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/WxCpTpXmlPackage.java @@ -26,18 +26,33 @@ public class WxCpTpXmlPackage implements Serializable { */ private Map allFieldsMap; + /** + * The To user name. + */ @XStreamAlias("ToUserName") @XStreamConverter(value = XStreamCDataConverter.class) protected String toUserName; + /** + * The Agent id. + */ @XStreamAlias("AgentID") @XStreamConverter(value = XStreamCDataConverter.class) protected String agentId; + /** + * The Msg encrypt. + */ @XStreamAlias("Encrypt") @XStreamConverter(value = XStreamCDataConverter.class) protected String msgEncrypt; + /** + * From xml wx cp tp xml package. + * + * @param xml the xml + * @return the wx cp tp xml package + */ public static WxCpTpXmlPackage fromXml(String xml) { //修改微信变态的消息内容格式，方便解析 //xml = xml.replace("", ""); diff --git a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/WxCpUser.java b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/WxCpUser.java index 776e347ce..681152c29 100644 --- a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/WxCpUser.java +++ b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/WxCpUser.java @@ -74,26 +74,56 @@ public class WxCpUser implements Serializable { private String[] directLeader; + /** + * Add external attr. + * + * @param externalAttr the external attr + */ public void addExternalAttr(ExternalAttribute externalAttr) { this.externalAttrs.add(externalAttr); } + /** + * Add ext attr. + * + * @param name the name + * @param value the value + */ public void addExtAttr(String name, String value) { this.extAttrs.add(new Attr().setType(0).setName(name).setTextValue(value)); } + /** + * Add ext attr. + * + * @param attr the attr + */ public void addExtAttr(Attr attr) { this.extAttrs.add(attr); } + /** + * From json wx cp user. + * + * @param json the json + * @return the wx cp user + */ public static WxCpUser fromJson(String json) { return WxCpGsonBuilder.create().fromJson(json, WxCpUser.class); } + /** + * To json string. + * + * @return the string + */ public String toJson() { return WxCpGsonBuilder.create().toJson(this); } + /** + * The type Attr. + */ @Data @Accessors(chain = true) @Builder @@ -112,6 +142,9 @@ public class WxCpUser implements Serializable { private String webTitle; } + /** + * The type External attribute. + */ @Data @Builder @NoArgsConstructor @@ -151,6 +184,9 @@ public class WxCpUser implements Serializable { } + /** + * The type Wechat channels. + */ @Data @Builder @NoArgsConstructor diff --git a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/WxCpUserExternalContactInfo.java b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/WxCpUserExternalContactInfo.java index ca6ebb8bb..562bf82ed 100644 --- a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/WxCpUserExternalContactInfo.java +++ b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/WxCpUserExternalContactInfo.java @@ -27,6 +27,9 @@ public class WxCpUserExternalContactInfo implements Serializable { @SerializedName("follow_user") private List followedUsers; + /** + * The type External contact. + */ @Getter @Setter public static class ExternalContact implements Serializable { @@ -63,6 +66,9 @@ public class WxCpUserExternalContactInfo implements Serializable { private ExternalProfile externalProfile; } + /** + * The type External profile. + */ @Setter @Getter public static class ExternalProfile implements Serializable { @@ -72,6 +78,9 @@ public class WxCpUserExternalContactInfo implements Serializable { private List externalAttrs; } + /** + * The type External attribute. + */ @Data @Builder @NoArgsConstructor @@ -79,6 +88,9 @@ public class WxCpUserExternalContactInfo implements Serializable { public static class ExternalAttribute implements Serializable { private static final long serialVersionUID = -5696099236344075582L; + /** + * The type Text. + */ @Setter @Getter public static class Text implements Serializable { @@ -87,6 +99,9 @@ public class WxCpUserExternalContactInfo implements Serializable { private String value; } + /** + * The type Web. + */ @Setter @Getter public static class Web implements Serializable { @@ -96,6 +111,9 @@ public class WxCpUserExternalContactInfo implements Serializable { private String url; } + /** + * The type Mini program. + */ @Setter @Getter public static class MiniProgram implements Serializable { @@ -119,6 +137,9 @@ public class WxCpUserExternalContactInfo implements Serializable { private MiniProgram miniProgram; } + /** + * The type Followed user. + */ @Setter @Getter public static class FollowedUser implements Serializable { @@ -143,10 +164,19 @@ public class WxCpUserExternalContactInfo implements Serializable { } + /** + * From json wx cp user external contact info. + * + * @param json the json + * @return the wx cp user external contact info + */ public static WxCpUserExternalContactInfo fromJson(String json) { return WxCpGsonBuilder.create().fromJson(json, WxCpUserExternalContactInfo.class); } + /** + * The type Tag. + */ @Setter @Getter public static class Tag implements Serializable { diff --git a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/WxCpUseridToOpenUserid.java b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/WxCpUseridToOpenUserid.java index 2b5cfd435..5f2f082a7 100644 --- a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/WxCpUseridToOpenUserid.java +++ b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/WxCpUseridToOpenUserid.java @@ -11,7 +11,6 @@ import java.io.Serializable; * 将自建应用或代开发应用获取的userid转换为第三方应用的userid * 中间对象 * Created by gxh0797 on 2022.07.26. - * */ @Data public class WxCpUseridToOpenUserid implements Serializable { @@ -22,6 +21,12 @@ public class WxCpUseridToOpenUserid implements Serializable { return WxCpGsonBuilder.create().toJson(this); } + /** + * From json wx cp userid to open userid. + * + * @param json the json + * @return the wx cp userid to open userid + */ public static WxCpUseridToOpenUserid fromJson(String json) { return WxCpGsonBuilder.create().fromJson(json, WxCpUseridToOpenUserid.class); } diff --git a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/WxCpUseridToOpenUseridResult.java b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/WxCpUseridToOpenUseridResult.java index 90d002f17..360772883 100644 --- a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/WxCpUseridToOpenUseridResult.java +++ b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/WxCpUseridToOpenUseridResult.java @@ -11,7 +11,6 @@ import java.util.List; * userid转换为open_userid * 将自建应用或代开发应用获取的userid转换为第三方应用的userid * Created by gxh0797 on 2022.07.26. - * */ @Data public class WxCpUseridToOpenUseridResult implements Serializable { @@ -22,6 +21,12 @@ public class WxCpUseridToOpenUseridResult implements Serializable { return WxCpGsonBuilder.create().toJson(this); } + /** + * From json wx cp userid to open userid result. + * + * @param json the json + * @return the wx cp userid to open userid result + */ public static WxCpUseridToOpenUseridResult fromJson(String json) { return WxCpGsonBuilder.create().fromJson(json, WxCpUseridToOpenUseridResult.class); } diff --git a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/WxTpLoginInfo.java b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/WxTpLoginInfo.java index 19ee03e68..5cadc6bca 100644 --- a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/WxTpLoginInfo.java +++ b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/WxTpLoginInfo.java @@ -11,9 +11,8 @@ import java.util.List; /** * 登录信息 * - * @author Jamie.shi - * created on 2020-08-03 17:18 - **/ + * @author Jamie.shi created on 2020-08-03 17:18 + */ @Data @EqualsAndHashCode(callSuper = true) public class WxTpLoginInfo extends WxCpBaseResp { @@ -29,10 +28,19 @@ public class WxTpLoginInfo extends WxCpBaseResp { private AuthInfo authInfo; private List agent; + /** + * From json wx tp login info. + * + * @param json the json + * @return the wx tp login info + */ public static WxTpLoginInfo fromJson(String json) { return WxCpGsonBuilder.create().fromJson(json, WxTpLoginInfo.class); } + /** + * The type User info. + */ @Data public static class UserInfo implements Serializable { private static final long serialVersionUID = -4558358748587735192L; @@ -45,6 +53,9 @@ public class WxTpLoginInfo extends WxCpBaseResp { private String avatar; } + /** + * The type Corp info bean. + */ @Data public static class CorpInfoBean implements Serializable { private static final long serialVersionUID = -3160146744148144984L; @@ -53,12 +64,18 @@ public class WxTpLoginInfo extends WxCpBaseResp { private String corpId; } + /** + * The type Auth info. + */ @Data public static class AuthInfo implements Serializable { private static final long serialVersionUID = -8697184659526210472L; private List department; + /** + * The type Department. + */ @Data public static class Department implements Serializable { private static final long serialVersionUID = -4389328276936557541L; @@ -68,6 +85,9 @@ public class WxTpLoginInfo extends WxCpBaseResp { } } + /** + * The type Agent. + */ @Data public static class Agent implements Serializable { private static final long serialVersionUID = 1461544500964159037L; diff --git a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/export/WxCpExportRequest.java b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/export/WxCpExportRequest.java index ed55debc3..c2b0bce03 100644 --- a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/export/WxCpExportRequest.java +++ b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/export/WxCpExportRequest.java @@ -9,15 +9,15 @@ import java.io.Serializable; /** * 异步导出参数 * - * @author zhongjun - * created on 2022/4/21 - **/ + * @author zhongjun created on 2022/4/21 + */ @Data public class WxCpExportRequest implements Serializable { private static final long serialVersionUID = -8127528999898984359L; /** - * base64encode的加密密钥，长度固定为43，base64decode之后即得到AESKey。加密方式采用AES-256-CBC方式，数据采用PKCS#7填充至32字节的倍数；IV初始向量大小为16字节，取AESKey前16字节，详见：http://tools.ietf.org/html/rfc2315 + * base64encode的加密密钥，长度固定为43，base64decode之后即得到AESKey。加密方式采用AES-256-CBC方式，数据采用PKCS#7填充至32字节的倍数；IV初始向量大小为16字节，取AESKey + * 前16字节，详见：http://tools.ietf.org/html/rfc2315 */ @SerializedName("encoding_aeskey") private String encodingAesKey; @@ -35,6 +35,11 @@ public class WxCpExportRequest implements Serializable { @SerializedName("tagid") private Integer tagId; + /** + * To json string. + * + * @return the string + */ public String toJson() { return WxCpGsonBuilder.create().toJson(this); } diff --git a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/export/WxCpExportResult.java b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/export/WxCpExportResult.java index b03dbeb93..86f52ab8c 100644 --- a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/export/WxCpExportResult.java +++ b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/export/WxCpExportResult.java @@ -10,9 +10,8 @@ import java.util.List; /** * 异步导出响应 * - * @author zhongjun - * created on 2022/4/21 - **/ + * @author zhongjun created on 2022/4/21 + */ @Data @EqualsAndHashCode(callSuper = true) public class WxCpExportResult extends WxCpBaseResp { @@ -27,6 +26,9 @@ public class WxCpExportResult extends WxCpBaseResp { private List dataList; + /** + * The type Export data. + */ @Data public static class ExportData { diff --git a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/external/WxCpAddMomentResult.java b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/external/WxCpAddMomentResult.java index ea055731d..1eb7ad107 100644 --- a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/external/WxCpAddMomentResult.java +++ b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/external/WxCpAddMomentResult.java @@ -9,8 +9,7 @@ import me.chanjar.weixin.cp.util.json.WxCpGsonBuilder; /** * 企业发表内容到客户的朋友圈 创建发表任务结果 * - * @author leiin - * created on 2021-10-29 + * @author leiin created on 2021-10-29 */ @Data @EqualsAndHashCode(callSuper = true) @@ -20,6 +19,12 @@ public class WxCpAddMomentResult extends WxCpBaseResp { @SerializedName("jobid") private String jobId; + /** + * From json wx cp add moment result. + * + * @param json the json + * @return the wx cp add moment result + */ public static WxCpAddMomentResult fromJson(String json) { return WxCpGsonBuilder.create().fromJson(json, WxCpAddMomentResult.class); } diff --git a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/external/WxCpAddMomentTask.java b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/external/WxCpAddMomentTask.java index 53b2a2d11..005c4f3de 100644 --- a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/external/WxCpAddMomentTask.java +++ b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/external/WxCpAddMomentTask.java @@ -16,8 +16,7 @@ import java.util.List; /** * 企业发表内容到客户的朋友圈 创建发表任务 * - * @author leiin - * created on 2021-10-29 + * @author leiin created on 2021-10-29 */ @Data @Builder @@ -31,6 +30,11 @@ public class WxCpAddMomentTask implements Serializable { private List attachments; + /** + * To json string. + * + * @return the string + */ public String toJson() { return WxCpGsonBuilder.create().toJson(this); } diff --git a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/external/WxCpContactWayInfo.java b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/external/WxCpContactWayInfo.java index 66d94da2c..3a6a61902 100644 --- a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/external/WxCpContactWayInfo.java +++ b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/external/WxCpContactWayInfo.java @@ -25,6 +25,9 @@ public class WxCpContactWayInfo implements Serializable { @SerializedName("contact_way") private ContactWay contactWay; + /** + * The type Contact way. + */ @Getter @Setter public static class ContactWay implements Serializable { @@ -157,10 +160,21 @@ public class WxCpContactWayInfo implements Serializable { */ private Conclusion conclusions; + /** + * From json wx cp contact way info . contact way. + * + * @param json the json + * @return the wx cp contact way info . contact way + */ public static WxCpContactWayInfo.ContactWay fromJson(String json) { return WxCpGsonBuilder.create().fromJson(json, WxCpContactWayInfo.ContactWay.class); } + /** + * To json string. + * + * @return the string + */ public String toJson() { return WxCpGsonBuilder.create().toJson(this); } @@ -189,14 +203,28 @@ public class WxCpContactWayInfo implements Serializable { } + /** + * From json wx cp contact way info. + * + * @param json the json + * @return the wx cp contact way info + */ public static WxCpContactWayInfo fromJson(String json) { return WxCpGsonBuilder.create().fromJson(json, WxCpContactWayInfo.class); } + /** + * To json string. + * + * @return the string + */ public String toJson() { return WxCpGsonBuilder.create().toJson(this); } + /** + * The enum Type. + */ public enum TYPE { /** * 单人 @@ -212,6 +240,9 @@ public class WxCpContactWayInfo implements Serializable { } + /** + * The enum Scene. + */ public enum SCENE { /** diff --git a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/external/WxCpContactWayResult.java b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/external/WxCpContactWayResult.java index 789dac318..157a0ecac 100644 --- a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/external/WxCpContactWayResult.java +++ b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/external/WxCpContactWayResult.java @@ -22,6 +22,12 @@ public class WxCpContactWayResult extends WxCpBaseResp { @SerializedName("qr_code") private String qrCode; + /** + * From json wx cp contact way result. + * + * @param json the json + * @return the wx cp contact way result + */ public static WxCpContactWayResult fromJson(String json) { return WxCpGsonBuilder.create().fromJson(json, WxCpContactWayResult.class); } diff --git a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/external/WxCpExternalUserIdList.java b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/external/WxCpExternalUserIdList.java index d8cb46794..693dd8001 100644 --- a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/external/WxCpExternalUserIdList.java +++ b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/external/WxCpExternalUserIdList.java @@ -12,8 +12,7 @@ import java.util.List; /** * 企业客户微信unionid的升级 - 企业客户external_userid列表 * - * @author Mr.Pan - * created on 2021/11/18 + * @author Mr.Pan created on 2021/11/18 */ @Getter @Setter @@ -23,6 +22,9 @@ public class WxCpExternalUserIdList extends WxCpBaseResp { @SerializedName("external_userid_info") private List externalUserIdInfo; + /** + * The type External user id info. + */ @Getter @Setter public static class ExternalUserIdInfo implements Serializable { @@ -48,6 +50,12 @@ public class WxCpExternalUserIdList extends WxCpBaseResp { } + /** + * From json wx cp external user id list. + * + * @param json the json + * @return the wx cp external user id list + */ public static WxCpExternalUserIdList fromJson(String json) { return WxCpGsonBuilder.create().fromJson(json, WxCpExternalUserIdList.class); } diff --git a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/external/WxCpGetMomentComments.java b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/external/WxCpGetMomentComments.java index 52e91b403..b1c914944 100644 --- a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/external/WxCpGetMomentComments.java +++ b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/external/WxCpGetMomentComments.java @@ -13,8 +13,7 @@ import java.util.List; /** * 企业发表内容到客户的朋友圈 获取客户朋友圈的互动数据 * - * @author leiin - * created on 2021-10-29 + * @author leiin created on 2021-10-29 */ @Data @EqualsAndHashCode(callSuper = true) @@ -26,6 +25,9 @@ public class WxCpGetMomentComments extends WxCpBaseResp { @SerializedName("like_list") private List likeList; + /** + * The type Comment like item. + */ @Getter @Setter public static class CommentLikeItem { @@ -37,6 +39,12 @@ public class WxCpGetMomentComments extends WxCpBaseResp { private Long createTime; } + /** + * From json wx cp get moment comments. + * + * @param json the json + * @return the wx cp get moment comments + */ public static WxCpGetMomentComments fromJson(String json) { return WxCpGsonBuilder.create().fromJson(json, WxCpGetMomentComments.class); } diff --git a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/external/WxCpGetMomentCustomerList.java b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/external/WxCpGetMomentCustomerList.java index 6f2b16c8d..c10c2f69d 100644 --- a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/external/WxCpGetMomentCustomerList.java +++ b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/external/WxCpGetMomentCustomerList.java @@ -12,8 +12,7 @@ import java.util.List; /** * 企业发表内容到客户的朋友圈 获取客户朋友圈发表时选择的可见范围 * - * @author leiin - * created on 2021-10-29 + * @author leiin created on 2021-10-29 */ @Data @EqualsAndHashCode(callSuper = true) @@ -25,6 +24,12 @@ public class WxCpGetMomentCustomerList extends WxCpBaseResp { @SerializedName("customer_list") private List customerList; + /** + * From json wx cp get moment customer list. + * + * @param json the json + * @return the wx cp get moment customer list + */ public static WxCpGetMomentCustomerList fromJson(String json) { return WxCpGsonBuilder.create().fromJson(json, WxCpGetMomentCustomerList.class); } diff --git a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/external/WxCpGetMomentList.java b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/external/WxCpGetMomentList.java index 57f615b49..46b17a1b5 100644 --- a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/external/WxCpGetMomentList.java +++ b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/external/WxCpGetMomentList.java @@ -12,8 +12,7 @@ import java.util.List; /** * 企业发表内容到客户的朋友圈 获取企业全部的发表列表 * - * @author leiin - * created on 2021-10-29 + * @author leiin created on 2021-10-29 */ @Data @EqualsAndHashCode(callSuper = true) @@ -25,6 +24,12 @@ public class WxCpGetMomentList extends WxCpBaseResp { @SerializedName("moment_list") private List momentList; + /** + * From json wx cp get moment list. + * + * @param json the json + * @return the wx cp get moment list + */ public static WxCpGetMomentList fromJson(String json) { return WxCpGsonBuilder.create().fromJson(json, WxCpGetMomentList.class); } diff --git a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/external/WxCpGetMomentSendResult.java b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/external/WxCpGetMomentSendResult.java index 813e211fb..80e4f144c 100644 --- a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/external/WxCpGetMomentSendResult.java +++ b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/external/WxCpGetMomentSendResult.java @@ -12,8 +12,7 @@ import java.util.List; /** * 企业发表内容到客户的朋友圈 获取客户朋友圈发表后的可见客户列表 * - * @author leiin - * created on 2021-10-29 + * @author leiin created on 2021-10-29 */ @Data @EqualsAndHashCode(callSuper = true) @@ -25,6 +24,12 @@ public class WxCpGetMomentSendResult extends WxCpBaseResp { @SerializedName("customer_list") private List customerList; + /** + * From json wx cp get moment send result. + * + * @param json the json + * @return the wx cp get moment send result + */ public static WxCpGetMomentSendResult fromJson(String json) { return WxCpGsonBuilder.create().fromJson(json, WxCpGetMomentSendResult.class); } diff --git a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/external/WxCpGetMomentTask.java b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/external/WxCpGetMomentTask.java index 506a5c56e..46740d6e0 100644 --- a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/external/WxCpGetMomentTask.java +++ b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/external/WxCpGetMomentTask.java @@ -13,8 +13,7 @@ import java.util.List; /** * 企业发表内容到客户的朋友圈 获取客户朋友圈企业发表的列表 * - * @author leiin - * created on 2021-10-29 + * @author leiin created on 2021-10-29 */ @Data @EqualsAndHashCode(callSuper = true) @@ -27,6 +26,9 @@ public class WxCpGetMomentTask extends WxCpBaseResp { @SerializedName("task_list") private List taskList; + /** + * The type Moment task item. + */ @Getter @Setter public static class MomentTaskItem { @@ -36,6 +38,12 @@ public class WxCpGetMomentTask extends WxCpBaseResp { private String publishStatus; } + /** + * From json wx cp get moment task. + * + * @param json the json + * @return the wx cp get moment task + */ public static WxCpGetMomentTask fromJson(String json) { return WxCpGsonBuilder.create().fromJson(json, WxCpGetMomentTask.class); } diff --git a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/external/WxCpGetMomentTaskResult.java b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/external/WxCpGetMomentTaskResult.java index c34ce731c..6f6a53504 100644 --- a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/external/WxCpGetMomentTaskResult.java +++ b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/external/WxCpGetMomentTaskResult.java @@ -13,8 +13,7 @@ import me.chanjar.weixin.cp.util.json.WxCpGsonBuilder; /** * 企业发表内容到客户的朋友圈 获取任务创建结果 * - * @author leiin - * created on 2021-10-29 + * @author leiin created on 2021-10-29 */ @Data @EqualsAndHashCode(callSuper = true) @@ -25,6 +24,9 @@ public class WxCpGetMomentTaskResult extends WxCpBaseResp { private String type; private TaskResult result; + /** + * The type Task result. + */ @Getter @Setter public static class TaskResult extends WxCpBaseResp { @@ -37,6 +39,12 @@ public class WxCpGetMomentTaskResult extends WxCpBaseResp { @SerializedName("invalid_external_contact_list") private ExternalContactList invalidExternalContactList; + /** + * From json task result. + * + * @param json the json + * @return the task result + */ public static TaskResult fromJson(String json) { return WxCpGsonBuilder.create().fromJson(json, TaskResult.class); } @@ -46,6 +54,12 @@ public class WxCpGetMomentTaskResult extends WxCpBaseResp { } } + /** + * From json wx cp get moment task result. + * + * @param json the json + * @return the wx cp get moment task result + */ public static WxCpGetMomentTaskResult fromJson(String json) { return WxCpGsonBuilder.create().fromJson(json, WxCpGetMomentTaskResult.class); } diff --git a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/external/WxCpGroupJoinWayInfo.java b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/external/WxCpGroupJoinWayInfo.java index a78aa9098..c181f82bd 100644 --- a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/external/WxCpGroupJoinWayInfo.java +++ b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/external/WxCpGroupJoinWayInfo.java @@ -11,18 +11,23 @@ import java.io.Serializable; import java.util.List; /** - *客户群「加入群聊」对象 + * 客户群「加入群聊」对象 + * * @author Jc */ @Data @NoArgsConstructor -public class WxCpGroupJoinWayInfo implements Serializable { +public class WxCpGroupJoinWayInfo implements Serializable { private static final long serialVersionUID = 5621905029624794129L; @SerializedName("join_way") private JoinWay joinWay; + + /** + * The type Join way. + */ @Getter @Setter - public static class JoinWay implements Serializable { + public static class JoinWay implements Serializable { private static final long serialVersionUID = 5621905029624794122L; /** @@ -68,24 +73,47 @@ public class WxCpGroupJoinWayInfo implements Serializable { @SerializedName("qr_code") private String qrCode; /** - 企业自定义的state参数，用于区分不同的入群渠道。不超过30个UTF-8字符 - 如果有设置此参数，在调用获取客户群详情接口时会返回每个群成员对应的该参数值 + * 企业自定义的state参数，用于区分不同的入群渠道。不超过30个UTF-8字符 + * 如果有设置此参数，在调用获取客户群详情接口时会返回每个群成员对应的该参数值 */ @SerializedName("state") private String state; + /** + * To json string. + * + * @return the string + */ public String toJson() { return WxCpGsonBuilder.create().toJson(this); } + + /** + * From json wx cp group join way info . join way. + * + * @param json the json + * @return the wx cp group join way info . join way + */ public static WxCpGroupJoinWayInfo.JoinWay fromJson(String json) { return WxCpGsonBuilder.create().fromJson(json, WxCpGroupJoinWayInfo.JoinWay.class); } } + /** + * From json wx cp group join way info. + * + * @param json the json + * @return the wx cp group join way info + */ public static WxCpGroupJoinWayInfo fromJson(String json) { return WxCpGsonBuilder.create().fromJson(json, WxCpGroupJoinWayInfo.class); } + /** + * To json string. + * + * @return the string + */ public String toJson() { return WxCpGsonBuilder.create().toJson(this); } diff --git a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/external/WxCpGroupJoinWayResult.java b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/external/WxCpGroupJoinWayResult.java index f77b6089c..adfd90a3a 100644 --- a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/external/WxCpGroupJoinWayResult.java +++ b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/external/WxCpGroupJoinWayResult.java @@ -7,16 +7,23 @@ import me.chanjar.weixin.cp.bean.WxCpBaseResp; import me.chanjar.weixin.cp.util.json.WxCpGsonBuilder; /** - *客户群「加入群聊」配置处理结果 + * 客户群「加入群聊」配置处理结果 + * * @author Jc */ @Data @EqualsAndHashCode(callSuper = true) -public class WxCpGroupJoinWayResult extends WxCpBaseResp { +public class WxCpGroupJoinWayResult extends WxCpBaseResp { private static final long serialVersionUID = 5621905029624794129L; @SerializedName("config_id") private String configId; + /** + * From json wx cp group join way result. + * + * @param json the json + * @return the wx cp group join way result + */ public static WxCpGroupJoinWayResult fromJson(String json) { return WxCpGsonBuilder.create().fromJson(json, WxCpGroupJoinWayResult.class); } diff --git a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/external/WxCpGroupWelcomeTemplateResult.java b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/external/WxCpGroupWelcomeTemplateResult.java index 66b56fb44..5f4fbe569 100644 --- a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/external/WxCpGroupWelcomeTemplateResult.java +++ b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/external/WxCpGroupWelcomeTemplateResult.java @@ -11,8 +11,7 @@ import java.io.Serializable; /** * 入群欢迎语素材. * - * @author Mr.Pan - * created on 2021-11-3 + * @author Mr.Pan created on 2021-11-3 */ @Data @Builder @@ -46,6 +45,12 @@ public class WxCpGroupWelcomeTemplateResult extends WxCpBaseResp implements Seri */ private Integer notify; + /** + * From json wx cp group welcome template result. + * + * @param json the json + * @return the wx cp group welcome template result + */ public static WxCpGroupWelcomeTemplateResult fromJson(String json) { return WxCpGsonBuilder.create().fromJson(json, WxCpGroupWelcomeTemplateResult.class); } diff --git a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/external/WxCpInterceptRuleResp.java b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/external/WxCpInterceptRuleResp.java index ff3d48ce1..a02ea5bd2 100644 --- a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/external/WxCpInterceptRuleResp.java +++ b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/external/WxCpInterceptRuleResp.java @@ -7,14 +7,12 @@ import lombok.Data; import lombok.NoArgsConstructor; import me.chanjar.weixin.cp.util.json.WxCpGsonBuilder; -import java.util.Date; import java.util.List; /** * 新增敏感词规则请求参数封装实体类 * - * @author didi - * created on 2022-04-17 + * @author didi created on 2022-04-17 */ @Data @Builder @@ -35,25 +33,51 @@ public class WxCpInterceptRuleResp { @SerializedName("applicable_range") private ApplicableRange applicableRange; + /** + * The type Applicable range. + */ @Data public static class ApplicableRange { @SerializedName("user_list") private List userList; @SerializedName("department_list") private List departmentList; + + /** + * From json applicable range. + * + * @param json the json + * @return the applicable range + */ public static ApplicableRange fromJson(String json) { return WxCpGsonBuilder.create().fromJson(json, ApplicableRange.class); } + /** + * To json string. + * + * @return the string + */ public String toJson() { return WxCpGsonBuilder.create().toJson(this); } } + /** + * From json wx cp intercept rule resp. + * + * @param json the json + * @return the wx cp intercept rule resp + */ public static WxCpInterceptRuleResp fromJson(String json) { return WxCpGsonBuilder.create().fromJson(json, WxCpInterceptRuleResp.class); } + /** + * To json string. + * + * @return the string + */ public String toJson() { return WxCpGsonBuilder.create().toJson(this); } diff --git a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/external/WxCpInterceptRuleResultResp.java b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/external/WxCpInterceptRuleResultResp.java index 2ce6c28f2..a62e8e41c 100644 --- a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/external/WxCpInterceptRuleResultResp.java +++ b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/external/WxCpInterceptRuleResultResp.java @@ -10,15 +10,22 @@ import java.io.Serializable; /** * 新建敏感词规则负返回结果 + * * @author didi */ @Data @EqualsAndHashCode(callSuper = true) -public class WxCpInterceptRuleResultResp extends WxCpBaseResp implements Serializable { +public class WxCpInterceptRuleResultResp extends WxCpBaseResp implements Serializable { @SerializedName("rule_id") - private String ruleId; + private String ruleId; + /** + * From json wx cp intercept rule result resp. + * + * @param json the json + * @return the wx cp intercept rule result resp + */ public static WxCpInterceptRuleResultResp fromJson(String json) { return WxCpGsonBuilder.create().fromJson(json, WxCpInterceptRuleResultResp.class); } diff --git a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/external/WxCpMsgTemplate.java b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/external/WxCpMsgTemplate.java index 2d5343459..a88f73904 100644 --- a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/external/WxCpMsgTemplate.java +++ b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/external/WxCpMsgTemplate.java @@ -53,10 +53,21 @@ public class WxCpMsgTemplate implements Serializable { */ private List attachments; + /** + * From json wx cp msg template. + * + * @param json the json + * @return the wx cp msg template + */ public static WxCpMsgTemplate fromJson(String json) { return WxCpGsonBuilder.create().fromJson(json, WxCpMsgTemplate.class); } + /** + * To json string. + * + * @return the string + */ public String toJson() { return WxCpGsonBuilder.create().toJson(this); } diff --git a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/external/WxCpMsgTemplateAddResult.java b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/external/WxCpMsgTemplateAddResult.java index 87e0be446..42f796c80 100644 --- a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/external/WxCpMsgTemplateAddResult.java +++ b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/external/WxCpMsgTemplateAddResult.java @@ -28,10 +28,21 @@ public class WxCpMsgTemplateAddResult implements Serializable { @SerializedName("msgid") private String msgId; + /** + * From json wx cp msg template add result. + * + * @param json the json + * @return the wx cp msg template add result + */ public static WxCpMsgTemplateAddResult fromJson(String json) { return WxCpGsonBuilder.create().fromJson(json, WxCpMsgTemplateAddResult.class); } + /** + * To json string. + * + * @return the string + */ public String toJson() { return WxCpGsonBuilder.create().toJson(this); } diff --git a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/external/WxCpNewExternalUserIdList.java b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/external/WxCpNewExternalUserIdList.java index fcf2d06f8..9f7a5c01e 100644 --- a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/external/WxCpNewExternalUserIdList.java +++ b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/external/WxCpNewExternalUserIdList.java @@ -12,8 +12,7 @@ import java.util.List; /** * 企业客户微信unionid的升级 - 企业客户external_userid列表 * - * @author Mr.Pan - * created on 2021/11/18 + * @author Mr.Pan created on 2021/11/18 */ @Getter @Setter @@ -22,6 +21,9 @@ public class WxCpNewExternalUserIdList extends WxCpBaseResp { @SerializedName("items") private List items; + /** + * The type New external user id info. + */ @Getter @Setter public static class NewExternalUserIdInfo implements Serializable { @@ -41,6 +43,12 @@ public class WxCpNewExternalUserIdList extends WxCpBaseResp { } + /** + * From json wx cp new external user id list. + * + * @param json the json + * @return the wx cp new external user id list + */ public static WxCpNewExternalUserIdList fromJson(String json) { return WxCpGsonBuilder.create().fromJson(json, WxCpNewExternalUserIdList.class); } diff --git a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/external/WxCpProductAlbumInfo.java b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/external/WxCpProductAlbumInfo.java index c837d3085..a30fb1600 100644 --- a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/external/WxCpProductAlbumInfo.java +++ b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/external/WxCpProductAlbumInfo.java @@ -46,10 +46,21 @@ public class WxCpProductAlbumInfo implements Serializable { @SerializedName("attachments") private List attachments; + /** + * From json wx cp product album info. + * + * @param json the json + * @return the wx cp product album info + */ public static WxCpProductAlbumInfo fromJson(String json) { return WxCpGsonBuilder.create().fromJson(json, WxCpProductAlbumInfo.class); } + /** + * To json string. + * + * @return the string + */ public String toJson() { return WxCpGsonBuilder.create().toJson(this); } diff --git a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/external/WxCpProductAlbumListResult.java b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/external/WxCpProductAlbumListResult.java index 2b6f4b208..895d13237 100644 --- a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/external/WxCpProductAlbumListResult.java +++ b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/external/WxCpProductAlbumListResult.java @@ -28,6 +28,12 @@ public class WxCpProductAlbumListResult extends WxCpBaseResp implements Serializ @SerializedName("next_cursor") private String nextCursor; + /** + * From json wx cp product album list result. + * + * @param json the json + * @return the wx cp product album list result + */ public static WxCpProductAlbumListResult fromJson(String json) { return WxCpGsonBuilder.create().fromJson(json, WxCpProductAlbumListResult.class); } diff --git a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/external/WxCpProductAlbumResult.java b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/external/WxCpProductAlbumResult.java index 527bfb6eb..8088b8405 100644 --- a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/external/WxCpProductAlbumResult.java +++ b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/external/WxCpProductAlbumResult.java @@ -24,6 +24,12 @@ public class WxCpProductAlbumResult extends WxCpBaseResp implements Serializable @SerializedName("product") private WxCpProductAlbumInfo product; + /** + * From json wx cp product album result. + * + * @param json the json + * @return the wx cp product album result + */ public static WxCpProductAlbumResult fromJson(String json) { return WxCpGsonBuilder.create().fromJson(json, WxCpProductAlbumResult.class); } diff --git a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/external/WxCpUpdateRemarkRequest.java b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/external/WxCpUpdateRemarkRequest.java index c39134086..115e58f34 100644 --- a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/external/WxCpUpdateRemarkRequest.java +++ b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/external/WxCpUpdateRemarkRequest.java @@ -13,8 +13,7 @@ import java.io.Serializable; /** * 修改客户备注信息请求. * - * @author Binary Wang - * created on 2020-09-19 + * @author Binary Wang created on 2020-09-19 */ @Data @Builder @@ -24,6 +23,11 @@ import java.io.Serializable; public class WxCpUpdateRemarkRequest implements Serializable { private static final long serialVersionUID = -4960239393895754138L; + /** + * To json string. + * + * @return the string + */ public String toJson() { return WxCpGsonBuilder.create().toJson(this); } diff --git a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/external/WxCpUserExternalContactList.java b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/external/WxCpUserExternalContactList.java index 29e7e28e5..cc092b647 100644 --- a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/external/WxCpUserExternalContactList.java +++ b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/external/WxCpUserExternalContactList.java @@ -30,31 +30,67 @@ public class WxCpUserExternalContactList implements Serializable { @Expose private List externalUserId = null; + /** + * Gets errcode. + * + * @return the errcode + */ public Long getErrcode() { return errcode; } + /** + * Sets errcode. + * + * @param errcode the errcode + */ public void setErrcode(Long errcode) { this.errcode = errcode; } + /** + * Gets errmsg. + * + * @return the errmsg + */ public String getErrmsg() { return errmsg; } + /** + * Sets errmsg. + * + * @param errmsg the errmsg + */ public void setErrmsg(String errmsg) { this.errmsg = errmsg; } + /** + * Gets external user id. + * + * @return the external user id + */ public List getExternalUserId() { return externalUserId; } + /** + * Sets external user id. + * + * @param externalUserId the external user id + */ public void setExternalUserId(List externalUserId) { this.externalUserId = externalUserId; } + /** + * From json wx cp user external contact list. + * + * @param json the json + * @return the wx cp user external contact list + */ public static WxCpUserExternalContactList fromJson(String json) { return WxCpGsonBuilder.create().fromJson(json, WxCpUserExternalContactList.class); } diff --git a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/external/WxCpUserExternalGroupChatInfo.java b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/external/WxCpUserExternalGroupChatInfo.java index 4eb018db4..88f6c8a64 100644 --- a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/external/WxCpUserExternalGroupChatInfo.java +++ b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/external/WxCpUserExternalGroupChatInfo.java @@ -10,8 +10,9 @@ import java.io.Serializable; import java.util.List; /** - * @author yqx - * created on 2020/3/116 + * The type Wx cp user external group chat info. + * + * @author yqx created on 2020/3/116 */ @Getter @Setter @@ -20,6 +21,9 @@ public class WxCpUserExternalGroupChatInfo extends WxCpBaseResp { @SerializedName("group_chat") private GroupChat groupChat; + /** + * The type Group chat. + */ @Getter @Setter public static class GroupChat implements Serializable { @@ -47,6 +51,9 @@ public class WxCpUserExternalGroupChatInfo extends WxCpBaseResp { private List adminList; } + /** + * The type Group member. + */ @Getter @Setter public static class GroupMember implements Serializable { @@ -110,6 +117,9 @@ public class WxCpUserExternalGroupChatInfo extends WxCpBaseResp { private Invitor invitor; } + /** + * The type Invitor. + */ @Getter @Setter public static class Invitor { @@ -121,6 +131,9 @@ public class WxCpUserExternalGroupChatInfo extends WxCpBaseResp { private String userId; } + /** + * The type Group admin. + */ @Getter @Setter public static class GroupAdmin { @@ -132,6 +145,12 @@ public class WxCpUserExternalGroupChatInfo extends WxCpBaseResp { private String userId; } + /** + * From json wx cp user external group chat info. + * + * @param json the json + * @return the wx cp user external group chat info + */ public static WxCpUserExternalGroupChatInfo fromJson(String json) { return WxCpGsonBuilder.create().fromJson(json, WxCpUserExternalGroupChatInfo.class); } diff --git a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/external/WxCpUserExternalGroupChatList.java b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/external/WxCpUserExternalGroupChatList.java index 5a1bb6fc6..372790894 100644 --- a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/external/WxCpUserExternalGroupChatList.java +++ b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/external/WxCpUserExternalGroupChatList.java @@ -10,8 +10,9 @@ import java.io.Serializable; import java.util.List; /** - * @author yqx - * created on 2020/3/116 + * The type Wx cp user external group chat list. + * + * @author yqx created on 2020/3/116 */ @Getter @Setter @@ -24,6 +25,9 @@ public class WxCpUserExternalGroupChatList extends WxCpBaseResp { @SerializedName("next_cursor") private String nextCursor; + /** + * The type Chat status. + */ @Getter @Setter public static class ChatStatus implements Serializable { @@ -46,6 +50,12 @@ public class WxCpUserExternalGroupChatList extends WxCpBaseResp { } + /** + * From json wx cp user external group chat list. + * + * @param json the json + * @return the wx cp user external group chat list + */ public static WxCpUserExternalGroupChatList fromJson(String json) { return WxCpGsonBuilder.create().fromJson(json, WxCpUserExternalGroupChatList.class); } diff --git a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/external/WxCpUserExternalGroupChatStatistic.java b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/external/WxCpUserExternalGroupChatStatistic.java index 845273286..e8e95d3b9 100644 --- a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/external/WxCpUserExternalGroupChatStatistic.java +++ b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/external/WxCpUserExternalGroupChatStatistic.java @@ -12,8 +12,7 @@ import java.util.List; /** * 联系客户群统计数据 * - * @author yqx - * created on 2020/3/16 + * @author yqx created on 2020/3/16 */ @Getter @Setter @@ -29,6 +28,9 @@ public class WxCpUserExternalGroupChatStatistic extends WxCpBaseResp { @SerializedName("items") private List itemList; + /** + * The type Statistic item. + */ @Getter @Setter public static class StatisticItem implements Serializable { @@ -41,6 +43,9 @@ public class WxCpUserExternalGroupChatStatistic extends WxCpBaseResp { private ItemData itemData; } + /** + * The type Item data. + */ @Getter @Setter public static class ItemData implements Serializable { @@ -89,6 +94,12 @@ public class WxCpUserExternalGroupChatStatistic extends WxCpBaseResp { private int msgTotal; } + /** + * From json wx cp user external group chat statistic. + * + * @param json the json + * @return the wx cp user external group chat statistic + */ public static WxCpUserExternalGroupChatStatistic fromJson(String json) { return WxCpGsonBuilder.create().fromJson(json, WxCpUserExternalGroupChatStatistic.class); } diff --git a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/external/WxCpUserExternalGroupChatTransferResp.java b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/external/WxCpUserExternalGroupChatTransferResp.java index a083198ec..ea3ed3935 100644 --- a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/external/WxCpUserExternalGroupChatTransferResp.java +++ b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/external/WxCpUserExternalGroupChatTransferResp.java @@ -11,8 +11,7 @@ import java.util.List; /** * 分配离职成员的客户群结果 * - * @author pg - * created on 2021年6月21日 + * @author pg created on 2021年6月21日 */ @Getter @Setter @@ -24,6 +23,12 @@ public class WxCpUserExternalGroupChatTransferResp extends WxCpBaseResp { @SerializedName("failed_chat_list") private List failedChatList; + /** + * From json wx cp user external group chat transfer resp. + * + * @param json the json + * @return the wx cp user external group chat transfer resp + */ public static WxCpUserExternalGroupChatTransferResp fromJson(String json) { return WxCpGsonBuilder.create().fromJson(json, WxCpUserExternalGroupChatTransferResp.class); } @@ -32,6 +37,9 @@ public class WxCpUserExternalGroupChatTransferResp extends WxCpBaseResp { return WxCpGsonBuilder.create().toJson(this); } + /** + * The type Group chat failed transfer. + */ @Getter @Setter public static class GroupChatFailedTransfer extends WxCpBaseResp { @@ -42,8 +50,15 @@ public class WxCpUserExternalGroupChatTransferResp extends WxCpBaseResp { @SerializedName("chat_id") private String chatId; + /** + * From json wx cp user external group chat transfer resp . group chat failed transfer. + * + * @param json the json + * @return the wx cp user external group chat transfer resp . group chat failed transfer + */ public static WxCpUserExternalGroupChatTransferResp.GroupChatFailedTransfer fromJson(String json) { - return WxCpGsonBuilder.create().fromJson(json, WxCpUserExternalGroupChatTransferResp.GroupChatFailedTransfer.class); + return WxCpGsonBuilder.create().fromJson(json, + WxCpUserExternalGroupChatTransferResp.GroupChatFailedTransfer.class); } public String toJson() { diff --git a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/external/WxCpUserExternalTagGroupInfo.java b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/external/WxCpUserExternalTagGroupInfo.java index 69e337b82..59815ac8d 100644 --- a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/external/WxCpUserExternalTagGroupInfo.java +++ b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/external/WxCpUserExternalTagGroupInfo.java @@ -11,7 +11,7 @@ import java.io.Serializable; import java.util.List; /** - * + * The type Wx cp user external tag group info. */ @Getter @Setter @@ -20,6 +20,9 @@ public class WxCpUserExternalTagGroupInfo extends WxCpBaseResp { @SerializedName("tag_group") private TagGroup tagGroup; + /** + * The type Tag group. + */ @Getter @Setter public static class TagGroup implements Serializable { @@ -43,11 +46,19 @@ public class WxCpUserExternalTagGroupInfo extends WxCpBaseResp { @SerializedName("tag") private List tag; + /** + * To json string. + * + * @return the string + */ public String toJson() { return WxGsonBuilder.create().toJson(this); } } + /** + * The type Tag. + */ @Getter @Setter public static class Tag implements Serializable { @@ -78,6 +89,12 @@ public class WxCpUserExternalTagGroupInfo extends WxCpBaseResp { return WxGsonBuilder.create().toJson(this); } + /** + * From json wx cp user external tag group info. + * + * @param json the json + * @return the wx cp user external tag group info + */ public static WxCpUserExternalTagGroupInfo fromJson(String json) { return WxCpGsonBuilder.create().fromJson(json, WxCpUserExternalTagGroupInfo.class); } diff --git a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/external/WxCpUserExternalTagGroupList.java b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/external/WxCpUserExternalTagGroupList.java index a4d625729..215eab231 100644 --- a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/external/WxCpUserExternalTagGroupList.java +++ b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/external/WxCpUserExternalTagGroupList.java @@ -11,6 +11,8 @@ import java.io.Serializable; import java.util.List; /** + * The type Wx cp user external tag group list. + * * @author huangxm129 */ @Getter @@ -21,6 +23,9 @@ public class WxCpUserExternalTagGroupList extends WxCpBaseResp { @SerializedName("tag_group") private List tagGroupList; + /** + * The type Tag group. + */ @Getter @Setter public static class TagGroup implements Serializable { @@ -45,6 +50,9 @@ public class WxCpUserExternalTagGroupList extends WxCpBaseResp { @SerializedName("tag") private List tag; + /** + * The type Tag. + */ @Getter @Setter public static class Tag implements Serializable { @@ -75,6 +83,12 @@ public class WxCpUserExternalTagGroupList extends WxCpBaseResp { return WxGsonBuilder.create().toJson(this); } + /** + * From json wx cp user external tag group list. + * + * @param json the json + * @return the wx cp user external tag group list + */ public static WxCpUserExternalTagGroupList fromJson(String json) { return WxCpGsonBuilder.create().fromJson(json, WxCpUserExternalTagGroupList.class); } diff --git a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/external/WxCpUserExternalUnassignList.java b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/external/WxCpUserExternalUnassignList.java index 2038fab01..8605760fa 100644 --- a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/external/WxCpUserExternalUnassignList.java +++ b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/external/WxCpUserExternalUnassignList.java @@ -12,8 +12,7 @@ import java.util.List; /** * 离职员工外部联系人列表 * - * @author yqx & Wang_Wong - * created on 2020/3/15 + * @author yqx & Wang_Wong created on 2020/3/15 */ @Getter @Setter @@ -28,6 +27,9 @@ public class WxCpUserExternalUnassignList extends WxCpBaseResp { @SerializedName("next_cursor") private String nextCursor; + /** + * The type Unassign info. + */ @Getter @Setter public static class UnassignInfo implements Serializable { @@ -52,6 +54,12 @@ public class WxCpUserExternalUnassignList extends WxCpBaseResp { private Long dimissionTime; } + /** + * From json wx cp user external unassign list. + * + * @param json the json + * @return the wx cp user external unassign list + */ public static WxCpUserExternalUnassignList fromJson(String json) { return WxCpGsonBuilder.create().fromJson(json, WxCpUserExternalUnassignList.class); } diff --git a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/external/WxCpUserExternalUserBehaviorStatistic.java b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/external/WxCpUserExternalUserBehaviorStatistic.java index 8d25d8e7e..4c2a41383 100644 --- a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/external/WxCpUserExternalUserBehaviorStatistic.java +++ b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/external/WxCpUserExternalUserBehaviorStatistic.java @@ -12,8 +12,7 @@ import java.util.List; /** * 联系客户统计数据 * - * @author yqx - * created on 2020/3/16 + * @author yqx created on 2020/3/16 */ @Getter @Setter @@ -22,6 +21,9 @@ public class WxCpUserExternalUserBehaviorStatistic extends WxCpBaseResp { @SerializedName("behavior_data") private List behaviorList; + /** + * The type Behavior. + */ @Getter @Setter public static class Behavior implements Serializable { @@ -76,6 +78,12 @@ public class WxCpUserExternalUserBehaviorStatistic extends WxCpBaseResp { private int newContactCnt; } + /** + * From json wx cp user external user behavior statistic. + * + * @param json the json + * @return the wx cp user external user behavior statistic + */ public static WxCpUserExternalUserBehaviorStatistic fromJson(String json) { return WxCpGsonBuilder.create().fromJson(json, WxCpUserExternalUserBehaviorStatistic.class); } diff --git a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/external/WxCpUserTransferCustomerReq.java b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/external/WxCpUserTransferCustomerReq.java index d8607cd80..3b14747d7 100644 --- a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/external/WxCpUserTransferCustomerReq.java +++ b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/external/WxCpUserTransferCustomerReq.java @@ -12,8 +12,7 @@ import java.util.List; /** * 转接在职成员的客户给其他成员，请求对象 * - * @author pg - * created on 2021年6月21日 + * @author pg created on 2021年6月21日 */ @Getter @Setter @@ -43,6 +42,11 @@ public class WxCpUserTransferCustomerReq implements Serializable { @SerializedName("transfer_success_msg") private String transferMsg; + /** + * To json string. + * + * @return the string + */ public String toJson() { return WxCpGsonBuilder.create().toJson(this); } diff --git a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/external/WxCpUserTransferCustomerResp.java b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/external/WxCpUserTransferCustomerResp.java index 40840c4b3..dbb921ad0 100644 --- a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/external/WxCpUserTransferCustomerResp.java +++ b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/external/WxCpUserTransferCustomerResp.java @@ -12,8 +12,7 @@ import java.util.List; /** * 转接在职成员的客户给其他成员，返回对象 * - * @author pg - * created on 2021年6月21日 + * @author pg created on 2021年6月21日 */ @Getter @Setter @@ -24,6 +23,12 @@ public class WxCpUserTransferCustomerResp extends WxCpBaseResp { */ private List customer; + /** + * From json wx cp user transfer customer resp. + * + * @param json the json + * @return the wx cp user transfer customer resp + */ public static WxCpUserTransferCustomerResp fromJson(String json) { return WxCpGsonBuilder.create().fromJson(json, WxCpUserTransferCustomerResp.class); } @@ -49,10 +54,21 @@ public class WxCpUserTransferCustomerResp extends WxCpBaseResp { */ private Integer errcode; + /** + * From json wx cp user transfer customer resp . transfer customer. + * + * @param json the json + * @return the wx cp user transfer customer resp . transfer customer + */ public static WxCpUserTransferCustomerResp.TransferCustomer fromJson(String json) { return WxCpGsonBuilder.create().fromJson(json, WxCpUserTransferCustomerResp.TransferCustomer.class); } + /** + * To json string. + * + * @return the string + */ public String toJson() { return WxCpGsonBuilder.create().toJson(this); } diff --git a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/external/WxCpUserTransferResultResp.java b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/external/WxCpUserTransferResultResp.java index 5cf9df6f4..948d267b4 100644 --- a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/external/WxCpUserTransferResultResp.java +++ b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/external/WxCpUserTransferResultResp.java @@ -12,8 +12,7 @@ import java.util.List; /** * 在职成员的客户转接情况 * - * @author pg - * created on 2021年6月21日 + * @author pg created on 2021年6月21日 */ @Getter @Setter @@ -24,6 +23,12 @@ public class WxCpUserTransferResultResp extends WxCpBaseResp { private List customer; + /** + * From json wx cp user transfer result resp. + * + * @param json the json + * @return the wx cp user transfer result resp + */ public static WxCpUserTransferResultResp fromJson(String json) { return WxCpGsonBuilder.create().fromJson(json, WxCpUserTransferResultResp.class); } @@ -55,15 +60,29 @@ public class WxCpUserTransferResultResp extends WxCpBaseResp { @SerializedName("takeover_time") private Long takeOverTime; + /** + * From json wx cp user transfer result resp . transfer result. + * + * @param json the json + * @return the wx cp user transfer result resp . transfer result + */ public static WxCpUserTransferResultResp.TransferResult fromJson(String json) { return WxCpGsonBuilder.create().fromJson(json, WxCpUserTransferResultResp.TransferResult.class); } + /** + * To json string. + * + * @return the string + */ public String toJson() { return WxCpGsonBuilder.create().toJson(this); } } + /** + * The enum Status. + */ public enum STATUS { /** diff --git a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/external/WxCpUserWithExternalPermission.java b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/external/WxCpUserWithExternalPermission.java index d8366ff3f..ca1fa8cdf 100644 --- a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/external/WxCpUserWithExternalPermission.java +++ b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/external/WxCpUserWithExternalPermission.java @@ -9,6 +9,8 @@ import java.io.Serializable; import java.util.List; /** + * The type Wx cp user with external permission. + * * @author 曹祖鹏 */ @Data @@ -26,6 +28,12 @@ public class WxCpUserWithExternalPermission implements Serializable { @Expose private List followers = null; + /** + * From json wx cp user with external permission. + * + * @param json the json + * @return the wx cp user with external permission + */ public static WxCpUserWithExternalPermission fromJson(String json) { return WxCpGsonBuilder.create().fromJson(json, WxCpUserWithExternalPermission.class); } diff --git a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/external/WxCpWelcomeMsg.java b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/external/WxCpWelcomeMsg.java index 6d37ad6ee..a0aae4b06 100644 --- a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/external/WxCpWelcomeMsg.java +++ b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/external/WxCpWelcomeMsg.java @@ -15,8 +15,7 @@ import java.util.List; /** * 新客户欢迎语. * - * @author Binary Wang - * created on 2020-08-16 + * @author Binary Wang created on 2020-08-16 */ @Data @Builder @@ -32,6 +31,11 @@ public class WxCpWelcomeMsg implements Serializable { private List attachments; + /** + * To json string. + * + * @return the string + */ public String toJson() { return WxCpGsonBuilder.create().toJson(this); } diff --git a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/external/contact/ExternalContact.java b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/external/contact/ExternalContact.java index 41461bc7f..8129ee181 100644 --- a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/external/contact/ExternalContact.java +++ b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/external/contact/ExternalContact.java @@ -9,8 +9,7 @@ import java.util.List; /** * 外部联系人. * - * @author Binary Wang - * created on 2020-11-04 + * @author Binary Wang created on 2020-11-04 */ @Getter @Setter @@ -50,6 +49,9 @@ public class ExternalContact implements Serializable { @SerializedName("external_profile") private ExternalProfile externalProfile; + /** + * The type External profile. + */ @Data public static class ExternalProfile implements Serializable { private static final long serialVersionUID = -2899906589789022765L; @@ -64,6 +66,9 @@ public class ExternalContact implements Serializable { private List externalAttrs; } + /** + * The type Wechat channel. + */ @Data @Builder @NoArgsConstructor @@ -78,6 +83,9 @@ public class ExternalContact implements Serializable { } + /** + * The type External attribute. + */ @Data @Builder @NoArgsConstructor @@ -96,6 +104,9 @@ public class ExternalContact implements Serializable { @SerializedName("miniprogram") private MiniProgram miniProgram; + /** + * The type Text. + */ @Data public static class Text implements Serializable { private static final long serialVersionUID = -8161579335600269094L; @@ -103,6 +114,9 @@ public class ExternalContact implements Serializable { private String value; } + /** + * The type Web. + */ @Data public static class Web implements Serializable { private static final long serialVersionUID = 3664557135411521862L; @@ -111,6 +125,9 @@ public class ExternalContact implements Serializable { private String url; } + /** + * The type Mini program. + */ @Data public static class MiniProgram implements Serializable { private static final long serialVersionUID = -5329210594501835796L; diff --git a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/external/contact/FollowedUser.java b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/external/contact/FollowedUser.java index e4501691e..3dad23605 100644 --- a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/external/contact/FollowedUser.java +++ b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/external/contact/FollowedUser.java @@ -8,8 +8,7 @@ import java.io.Serializable; /** * 添加了外部联系人的企业成员. * - * @author Binary Wang - * created on 2020-11-04 + * @author Binary Wang created on 2020-11-04 */ @Data public class FollowedUser implements Serializable { @@ -53,6 +52,9 @@ public class FollowedUser implements Serializable { @SerializedName("oper_userid") private String operatorUserId; + /** + * The type Tag. + */ @Data public static class Tag implements Serializable { private static final long serialVersionUID = -7556237053703295482L; diff --git a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/external/contact/WxCpExternalContactBatchInfo.java b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/external/contact/WxCpExternalContactBatchInfo.java index 65e332613..de866fb30 100644 --- a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/external/contact/WxCpExternalContactBatchInfo.java +++ b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/external/contact/WxCpExternalContactBatchInfo.java @@ -28,6 +28,9 @@ public class WxCpExternalContactBatchInfo extends WxCpBaseResp implements Serial @SerializedName("next_cursor") private String nextCursor; + /** + * The type External contact info. + */ @Getter @Setter public static class ExternalContactInfo implements Serializable { @@ -41,6 +44,12 @@ public class WxCpExternalContactBatchInfo extends WxCpBaseResp implements Serial } + /** + * From json wx cp external contact batch info. + * + * @param json the json + * @return the wx cp external contact batch info + */ public static WxCpExternalContactBatchInfo fromJson(String json) { return WxCpGsonBuilder.create().fromJson(json, WxCpExternalContactBatchInfo.class); } diff --git a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/external/contact/WxCpExternalContactInfo.java b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/external/contact/WxCpExternalContactInfo.java index cad105e71..1a58c7e1d 100644 --- a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/external/contact/WxCpExternalContactInfo.java +++ b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/external/contact/WxCpExternalContactInfo.java @@ -29,6 +29,12 @@ public class WxCpExternalContactInfo implements Serializable { @SerializedName("next_cursor") private String nextCursor; + /** + * From json wx cp external contact info. + * + * @param json the json + * @return the wx cp external contact info + */ public static WxCpExternalContactInfo fromJson(String json) { return WxCpGsonBuilder.create().fromJson(json, WxCpExternalContactInfo.class); } diff --git a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/external/contact/WxCpGroupMsgListResult.java b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/external/contact/WxCpGroupMsgListResult.java index e8cb1b81c..2b7879375 100644 --- a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/external/contact/WxCpGroupMsgListResult.java +++ b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/external/contact/WxCpGroupMsgListResult.java @@ -31,6 +31,9 @@ public class WxCpGroupMsgListResult extends WxCpBaseResp implements Serializable @SerializedName("next_cursor") private String nextCursor; + /** + * The type External contact group msg info. + */ @Getter @Setter public static class ExternalContactGroupMsgInfo implements Serializable { @@ -53,6 +56,12 @@ public class WxCpGroupMsgListResult extends WxCpBaseResp implements Serializable } + /** + * From json wx cp group msg list result. + * + * @param json the json + * @return the wx cp group msg list result + */ public static WxCpGroupMsgListResult fromJson(String json) { return WxCpGsonBuilder.create().fromJson(json, WxCpGroupMsgListResult.class); } diff --git a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/external/contact/WxCpGroupMsgResult.java b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/external/contact/WxCpGroupMsgResult.java index 5cae404f0..604700b3a 100644 --- a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/external/contact/WxCpGroupMsgResult.java +++ b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/external/contact/WxCpGroupMsgResult.java @@ -28,6 +28,9 @@ public class WxCpGroupMsgResult extends WxCpBaseResp implements Serializable { @SerializedName("next_cursor") private String nextCursor; + /** + * The type External contact group msg detail info. + */ @Getter @Setter public static class ExternalContactGroupMsgDetailInfo implements Serializable { @@ -53,6 +56,12 @@ public class WxCpGroupMsgResult extends WxCpBaseResp implements Serializable { private Long sendTime; } + /** + * From json wx cp group msg result. + * + * @param json the json + * @return the wx cp group msg result + */ public static WxCpGroupMsgResult fromJson(String json) { return WxCpGsonBuilder.create().fromJson(json, WxCpGroupMsgResult.class); } diff --git a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/external/contact/WxCpGroupMsgSendResult.java b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/external/contact/WxCpGroupMsgSendResult.java index 704e53b8d..657c12ff6 100644 --- a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/external/contact/WxCpGroupMsgSendResult.java +++ b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/external/contact/WxCpGroupMsgSendResult.java @@ -28,6 +28,9 @@ public class WxCpGroupMsgSendResult extends WxCpBaseResp implements Serializable @SerializedName("next_cursor") private String nextCursor; + /** + * The type External contact group msg send info. + */ @Getter @Setter public static class ExternalContactGroupMsgSendInfo implements Serializable { @@ -49,6 +52,12 @@ public class WxCpGroupMsgSendResult extends WxCpBaseResp implements Serializable } + /** + * From json wx cp group msg send result. + * + * @param json the json + * @return the wx cp group msg send result + */ public static WxCpGroupMsgSendResult fromJson(String json) { return WxCpGsonBuilder.create().fromJson(json, WxCpGroupMsgSendResult.class); } diff --git a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/external/contact/WxCpGroupMsgTaskResult.java b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/external/contact/WxCpGroupMsgTaskResult.java index 0f2299bb4..f363fc2ee 100644 --- a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/external/contact/WxCpGroupMsgTaskResult.java +++ b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/external/contact/WxCpGroupMsgTaskResult.java @@ -28,6 +28,9 @@ public class WxCpGroupMsgTaskResult extends WxCpBaseResp implements Serializable @SerializedName("next_cursor") private String nextCursor; + /** + * The type External contact group msg task info. + */ @Getter @Setter public static class ExternalContactGroupMsgTaskInfo implements Serializable { @@ -43,6 +46,12 @@ public class WxCpGroupMsgTaskResult extends WxCpBaseResp implements Serializable } + /** + * From json wx cp group msg task result. + * + * @param json the json + * @return the wx cp group msg task result + */ public static WxCpGroupMsgTaskResult fromJson(String json) { return WxCpGsonBuilder.create().fromJson(json, WxCpGroupMsgTaskResult.class); } diff --git a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/external/moment/CustomerItem.java b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/external/moment/CustomerItem.java index 3bcbe03e0..3504d9aed 100644 --- a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/external/moment/CustomerItem.java +++ b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/external/moment/CustomerItem.java @@ -5,6 +5,8 @@ import lombok.Getter; import lombok.Setter; /** + * The type Customer item. + * * @author Boris */ @Getter diff --git a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/external/moment/ExternalContactList.java b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/external/moment/ExternalContactList.java index c9f2e0a58..2d9ac4471 100644 --- a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/external/moment/ExternalContactList.java +++ b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/external/moment/ExternalContactList.java @@ -6,6 +6,9 @@ import lombok.Setter; import java.util.List; +/** + * The type External contact list. + */ @Getter @Setter public class ExternalContactList { diff --git a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/external/moment/MomentInfo.java b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/external/moment/MomentInfo.java index 3fd364ddb..1eabdc145 100644 --- a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/external/moment/MomentInfo.java +++ b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/external/moment/MomentInfo.java @@ -7,6 +7,8 @@ import me.chanjar.weixin.cp.bean.external.msg.*; import java.util.List; /** + * The type Moment info. + * * @author Borisg */ @Data diff --git a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/external/moment/SenderList.java b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/external/moment/SenderList.java index b3f2c387e..35924fbeb 100644 --- a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/external/moment/SenderList.java +++ b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/external/moment/SenderList.java @@ -7,6 +7,8 @@ import lombok.Setter; import java.util.List; /** + * The type Sender list. + * * @author Boris */ @Getter diff --git a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/external/moment/VisibleRange.java b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/external/moment/VisibleRange.java index 1bf6c46cb..596408795 100644 --- a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/external/moment/VisibleRange.java +++ b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/external/moment/VisibleRange.java @@ -7,6 +7,8 @@ import lombok.experimental.Accessors; import java.io.Serializable; /** + * The type Visible range. + * * @author Boris */ @Data diff --git a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/external/msg/Attachment.java b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/external/msg/Attachment.java index d714b093c..6b6efc936 100644 --- a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/external/msg/Attachment.java +++ b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/external/msg/Attachment.java @@ -7,6 +7,8 @@ import me.chanjar.weixin.cp.constant.WxCpConsts; import java.io.Serializable; /** + * The type Attachment. + * * @author chutian0124 */ @Data @@ -27,26 +29,51 @@ public class Attachment implements Serializable { private File file; + /** + * Sets image. + * + * @param image the image + */ public void setImage(Image image) { this.image = image; this.msgType = WxCpConsts.WelcomeMsgType.IMAGE; } + /** + * Sets link. + * + * @param link the link + */ public void setLink(Link link) { this.link = link; this.msgType = WxCpConsts.WelcomeMsgType.LINK; } + /** + * Sets mini program. + * + * @param miniProgram the mini program + */ public void setMiniProgram(MiniProgram miniProgram) { this.miniProgram = miniProgram; this.msgType = WxCpConsts.WelcomeMsgType.MINIPROGRAM; } + /** + * Sets video. + * + * @param video the video + */ public void setVideo(Video video) { this.video = video; this.msgType = WxCpConsts.WelcomeMsgType.VIDEO; } + /** + * Sets file. + * + * @param file the file + */ public void setFile(File file) { this.file = file; this.msgType = WxCpConsts.WelcomeMsgType.FILE; diff --git a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/external/msg/File.java b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/external/msg/File.java index 5bbd1ce38..656f46ba3 100644 --- a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/external/msg/File.java +++ b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/external/msg/File.java @@ -6,8 +6,9 @@ import lombok.Data; import java.io.Serializable; /** - * @author Binary Wang - * created on 2021-08-23 + * The type File. + * + * @author Binary Wang created on 2021-08-23 */ @Data public class File implements Serializable { diff --git a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/external/msg/Image.java b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/external/msg/Image.java index 6eec31b80..cd2cdee29 100644 --- a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/external/msg/Image.java +++ b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/external/msg/Image.java @@ -8,8 +8,7 @@ import java.io.Serializable; /** * 图片消息. * - * @author Binary Wang - * created on 2020-08-16 + * @author Binary Wang created on 2020-08-16 */ @Data public class Image implements Serializable { diff --git a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/external/msg/Link.java b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/external/msg/Link.java index 80e22159a..45ed02fae 100644 --- a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/external/msg/Link.java +++ b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/external/msg/Link.java @@ -8,8 +8,7 @@ import java.io.Serializable; /** * 图文消息. * - * @author Binary Wang - * created on 2020-08-16 + * @author Binary Wang created on 2020-08-16 */ @Data public class Link implements Serializable { diff --git a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/external/msg/Location.java b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/external/msg/Location.java index 74b8b4922..d9a8a019b 100644 --- a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/external/msg/Location.java +++ b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/external/msg/Location.java @@ -5,8 +5,7 @@ import lombok.Data; /** * 地理位置 * - * @author leiin - * created on 2021-10-29 + * @author leiin created on 2021-10-29 */ @Data public class Location { diff --git a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/external/msg/MiniProgram.java b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/external/msg/MiniProgram.java index 1f9037567..013fe882b 100644 --- a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/external/msg/MiniProgram.java +++ b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/external/msg/MiniProgram.java @@ -8,8 +8,7 @@ import java.io.Serializable; /** * 小程序消息. * - * @author Binary Wang - * created on 2020-08-16 + * @author Binary Wang created on 2020-08-16 */ @Data public class MiniProgram implements Serializable { diff --git a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/external/msg/Text.java b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/external/msg/Text.java index a796eeec7..5aeeb4565 100644 --- a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/external/msg/Text.java +++ b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/external/msg/Text.java @@ -8,8 +8,7 @@ import java.io.Serializable; /** * 消息文本消息. * - * @author Binary Wang - * created on 2020-08-16 + * @author Binary Wang created on 2020-08-16 */ @Data @Accessors(chain = true) diff --git a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/external/msg/Video.java b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/external/msg/Video.java index 251972cf9..c1428a662 100644 --- a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/external/msg/Video.java +++ b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/external/msg/Video.java @@ -8,8 +8,7 @@ import java.io.Serializable; /** * 视频消息 * - * @author pg - * created on 2021-6-21 + * @author pg created on 2021-6-21 */ @Data public class Video implements Serializable { diff --git a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/external/product/Attachment.java b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/external/product/Attachment.java index c1480fbb7..960800e11 100644 --- a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/external/product/Attachment.java +++ b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/external/product/Attachment.java @@ -24,6 +24,11 @@ public class Attachment implements Serializable { */ private Image image; + /** + * Sets image. + * + * @param image the image + */ public void setImage(Image image) { this.image = image; this.type = WxCpConsts.ProductAttachmentType.IMAGE; diff --git a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/kf/WxCpKfAccountAdd.java b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/kf/WxCpKfAccountAdd.java index 428c255a3..b1ea05fad 100644 --- a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/kf/WxCpKfAccountAdd.java +++ b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/kf/WxCpKfAccountAdd.java @@ -9,8 +9,7 @@ import java.io.Serializable; /** * 添加客服帐号-请求参数 * - * @author Fu - * created on 2022/1/19 18:59 + * @author Fu created on 2022/1/19 18:59 */ @NoArgsConstructor @Data diff --git a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/kf/WxCpKfAccountAddResp.java b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/kf/WxCpKfAccountAddResp.java index 8a3c0978d..c21849413 100644 --- a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/kf/WxCpKfAccountAddResp.java +++ b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/kf/WxCpKfAccountAddResp.java @@ -10,8 +10,7 @@ import me.chanjar.weixin.cp.util.json.WxCpGsonBuilder; /** * 添加客服帐号-返回结果 * - * @author Fu - * created on 2022/1/19 19:04 + * @author Fu created on 2022/1/19 19:04 */ @EqualsAndHashCode(callSuper = true) @NoArgsConstructor @@ -26,6 +25,12 @@ public class WxCpKfAccountAddResp extends WxCpBaseResp { @SerializedName("open_kfid") private String openKfid; + /** + * From json wx cp kf account add resp. + * + * @param json the json + * @return the wx cp kf account add resp + */ public static WxCpKfAccountAddResp fromJson(String json) { return WxCpGsonBuilder.create().fromJson(json, WxCpKfAccountAddResp.class); } diff --git a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/kf/WxCpKfAccountDel.java b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/kf/WxCpKfAccountDel.java index d68714a6e..bd4bdf30c 100644 --- a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/kf/WxCpKfAccountDel.java +++ b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/kf/WxCpKfAccountDel.java @@ -9,8 +9,7 @@ import java.io.Serializable; /** * 删除客服帐号-请求参数 * - * @author Fu - * created on 2022/1/19 19:09 + * @author Fu created on 2022/1/19 19:09 */ @NoArgsConstructor @Data diff --git a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/kf/WxCpKfAccountLink.java b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/kf/WxCpKfAccountLink.java index b10141245..a903d0fa5 100644 --- a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/kf/WxCpKfAccountLink.java +++ b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/kf/WxCpKfAccountLink.java @@ -9,8 +9,7 @@ import java.io.Serializable; /** * 获取客服帐号链接-请求参数 * - * @author Fu - * created on 2022/1/19 19:18 + * @author Fu created on 2022/1/19 19:18 */ @NoArgsConstructor @Data diff --git a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/kf/WxCpKfAccountLinkResp.java b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/kf/WxCpKfAccountLinkResp.java index 0ef73b9c4..e04a8f56a 100644 --- a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/kf/WxCpKfAccountLinkResp.java +++ b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/kf/WxCpKfAccountLinkResp.java @@ -10,8 +10,7 @@ import me.chanjar.weixin.cp.util.json.WxCpGsonBuilder; /** * 获取客服帐号链接-结果 * - * @author Fu - * created on 2022/1/19 19:18 + * @author Fu created on 2022/1/19 19:18 */ @EqualsAndHashCode(callSuper = true) @NoArgsConstructor @@ -26,6 +25,12 @@ public class WxCpKfAccountLinkResp extends WxCpBaseResp { @SerializedName("url") private String url; + /** + * From json wx cp kf account link resp. + * + * @param json the json + * @return the wx cp kf account link resp + */ public static WxCpKfAccountLinkResp fromJson(String json) { return WxCpGsonBuilder.create().fromJson(json, WxCpKfAccountLinkResp.class); } diff --git a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/kf/WxCpKfAccountListResp.java b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/kf/WxCpKfAccountListResp.java index 0355c2df6..a7ec3c909 100644 --- a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/kf/WxCpKfAccountListResp.java +++ b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/kf/WxCpKfAccountListResp.java @@ -1,6 +1,5 @@ package me.chanjar.weixin.cp.bean.kf; -import com.fasterxml.jackson.annotation.JsonProperty; import com.google.gson.annotations.SerializedName; import lombok.Data; import lombok.EqualsAndHashCode; @@ -13,8 +12,7 @@ import java.util.List; /** * 获取客服帐号列表-结果 * - * @author Fu - * created on 2022/1/19 19:13 + * @author Fu created on 2022/1/19 19:13 */ @EqualsAndHashCode(callSuper = true) @NoArgsConstructor @@ -29,6 +27,9 @@ public class WxCpKfAccountListResp extends WxCpBaseResp { @SerializedName("account_list") private List accountList; + /** + * The type Account list dto. + */ @NoArgsConstructor @Data public static class AccountListDTO { @@ -51,6 +52,12 @@ public class WxCpKfAccountListResp extends WxCpBaseResp { private String avatar; } + /** + * From json wx cp kf account list resp. + * + * @param json the json + * @return the wx cp kf account list resp + */ public static WxCpKfAccountListResp fromJson(String json) { return WxCpGsonBuilder.create().fromJson(json, WxCpKfAccountListResp.class); } diff --git a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/kf/WxCpKfAccountUpd.java b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/kf/WxCpKfAccountUpd.java index a54d1d7ca..fa375c872 100644 --- a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/kf/WxCpKfAccountUpd.java +++ b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/kf/WxCpKfAccountUpd.java @@ -9,8 +9,7 @@ import java.io.Serializable; /** * 修改客服帐号-请求参数 * - * @author Fu - * created on 2022/1/19 19:10 + * @author Fu created on 2022/1/19 19:10 */ @NoArgsConstructor @Data diff --git a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/kf/WxCpKfCustomerBatchGetResp.java b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/kf/WxCpKfCustomerBatchGetResp.java index 964e32204..72b6b1044 100644 --- a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/kf/WxCpKfCustomerBatchGetResp.java +++ b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/kf/WxCpKfCustomerBatchGetResp.java @@ -1,7 +1,6 @@ package me.chanjar.weixin.cp.bean.kf; import com.google.gson.annotations.SerializedName; -import java.util.List; import lombok.Data; import lombok.EqualsAndHashCode; import lombok.NoArgsConstructor; @@ -9,9 +8,12 @@ import me.chanjar.weixin.cp.bean.WxCpBaseResp; import me.chanjar.weixin.cp.bean.external.contact.ExternalContact; import me.chanjar.weixin.cp.util.json.WxCpGsonBuilder; +import java.util.List; + /** - * @author leiin - * created on 2022/1/26 7:56 下午 + * The type Wx cp kf customer batch get resp. + * + * @author leiin created on 2022/1/26 7:56 下午 */ @EqualsAndHashCode(callSuper = true) @NoArgsConstructor @@ -26,6 +28,12 @@ public class WxCpKfCustomerBatchGetResp extends WxCpBaseResp { @SerializedName("invalid_external_userid") private List invalidExternalUserId; + /** + * From json wx cp kf customer batch get resp. + * + * @param json the json + * @return the wx cp kf customer batch get resp + */ public static WxCpKfCustomerBatchGetResp fromJson(String json) { return WxCpGsonBuilder.create().fromJson(json, WxCpKfCustomerBatchGetResp.class); } diff --git a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/kf/WxCpKfGetCorpStatisticRequest.java b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/kf/WxCpKfGetCorpStatisticRequest.java index 604901e7c..d447fb649 100644 --- a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/kf/WxCpKfGetCorpStatisticRequest.java +++ b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/kf/WxCpKfGetCorpStatisticRequest.java @@ -7,9 +7,8 @@ import lombok.NoArgsConstructor; /** * 获取「客户数据统计」企业汇总数据 * - * @author zhongjun - * created on 2022/4/25 - **/ + * @author zhongjun created on 2022/4/25 + */ @NoArgsConstructor @Data public class WxCpKfGetCorpStatisticRequest { diff --git a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/kf/WxCpKfGetCorpStatisticResp.java b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/kf/WxCpKfGetCorpStatisticResp.java index dd3c876da..2243a70ad 100644 --- a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/kf/WxCpKfGetCorpStatisticResp.java +++ b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/kf/WxCpKfGetCorpStatisticResp.java @@ -12,9 +12,8 @@ import java.util.List; /** * 获取「客户数据统计」企业汇总数据 * - * @author zhongjun - * created on 2022/4/25 - **/ + * @author zhongjun created on 2022/4/25 + */ @EqualsAndHashCode(callSuper = true) @NoArgsConstructor @Data @@ -27,6 +26,9 @@ public class WxCpKfGetCorpStatisticResp extends WxCpBaseResp { @SerializedName("statistic_list") private List statisticList; + /** + * The type Statistic list. + */ @NoArgsConstructor @Data public static class StatisticList { @@ -43,6 +45,9 @@ public class WxCpKfGetCorpStatisticResp extends WxCpBaseResp { private Statistic statistic; } + /** + * The type Statistic. + */ @NoArgsConstructor @Data public static class Statistic { @@ -84,12 +89,19 @@ public class WxCpKfGetCorpStatisticResp extends WxCpBaseResp { private Integer aiTransferRate; /** - * 知识命中率。一个自然日内，客户给智能助手发送的消息中，命中知识库的占比。只有在开启了智能回复原生功能并配置了知识库的情况下，才会产生该项统计数据。当api托管了会话分配，智能回复原生功能失效。若不返回，代表没有向配置知识库的智能接待助手发送消息，该项无法计算 + * 知识命中率。一个自然日内，客户给智能助手发送的消息中，命中知识库的占比。只有在开启了智能回复原生功能并配置了知识库的情况下，才会产生该项统计数据。当api + * 托管了会话分配，智能回复原生功能失效。若不返回，代表没有向配置知识库的智能接待助手发送消息，该项无法计算 */ @SerializedName("ai_knowledge_hit_rate") private Integer aiKnowledgeHitRate; } + /** + * From json wx cp kf get corp statistic resp. + * + * @param json the json + * @return the wx cp kf get corp statistic resp + */ public static WxCpKfGetCorpStatisticResp fromJson(String json) { return WxCpGsonBuilder.create().fromJson(json, WxCpKfGetCorpStatisticResp.class); } diff --git a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/kf/WxCpKfMsgListResp.java b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/kf/WxCpKfMsgListResp.java index b2f7545d7..197b65ecd 100644 --- a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/kf/WxCpKfMsgListResp.java +++ b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/kf/WxCpKfMsgListResp.java @@ -1,24 +1,19 @@ package me.chanjar.weixin.cp.bean.kf; import com.google.gson.annotations.SerializedName; -import java.util.List; import lombok.Data; import lombok.EqualsAndHashCode; import lombok.NoArgsConstructor; import me.chanjar.weixin.cp.bean.WxCpBaseResp; -import me.chanjar.weixin.cp.bean.kf.msg.WxCpKfBusinessCardMsg; -import me.chanjar.weixin.cp.bean.kf.msg.WxCpKfEventMsg; -import me.chanjar.weixin.cp.bean.kf.msg.WxCpKfLinkMsg; -import me.chanjar.weixin.cp.bean.kf.msg.WxCpKfLocationMsg; -import me.chanjar.weixin.cp.bean.kf.msg.WxCpKfMenuMsg; -import me.chanjar.weixin.cp.bean.kf.msg.WxCpKfMiniProgramMsg; -import me.chanjar.weixin.cp.bean.kf.msg.WxCpKfResourceMsg; -import me.chanjar.weixin.cp.bean.kf.msg.WxCpKfTextMsg; +import me.chanjar.weixin.cp.bean.kf.msg.*; import me.chanjar.weixin.cp.util.json.WxCpGsonBuilder; +import java.util.List; + /** - * @author leiin - * created on 2022/1/26 5:24 下午 + * The type Wx cp kf msg list resp. + * + * @author leiin created on 2022/1/26 5:24 下午 */ @EqualsAndHashCode(callSuper = true) @NoArgsConstructor @@ -35,6 +30,9 @@ public class WxCpKfMsgListResp extends WxCpBaseResp { @SerializedName("msg_list") private List msgList; + /** + * The type Wx cp kf msg item. + */ @NoArgsConstructor @Data public static class WxCpKfMsgItem { @@ -67,6 +65,12 @@ public class WxCpKfMsgListResp extends WxCpBaseResp { private WxCpKfEventMsg event; } + /** + * From json wx cp kf msg list resp. + * + * @param json the json + * @return the wx cp kf msg list resp + */ public static WxCpKfMsgListResp fromJson(String json) { return WxCpGsonBuilder.create().fromJson(json, WxCpKfMsgListResp.class); } diff --git a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/kf/WxCpKfMsgSendRequest.java b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/kf/WxCpKfMsgSendRequest.java index cef24cfbb..ba451813e 100644 --- a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/kf/WxCpKfMsgSendRequest.java +++ b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/kf/WxCpKfMsgSendRequest.java @@ -3,16 +3,12 @@ package me.chanjar.weixin.cp.bean.kf; import com.google.gson.annotations.SerializedName; import lombok.Data; import lombok.NoArgsConstructor; -import me.chanjar.weixin.cp.bean.kf.msg.WxCpKfLinkMsg; -import me.chanjar.weixin.cp.bean.kf.msg.WxCpKfLocationMsg; -import me.chanjar.weixin.cp.bean.kf.msg.WxCpKfMenuMsg; -import me.chanjar.weixin.cp.bean.kf.msg.WxCpKfMiniProgramMsg; -import me.chanjar.weixin.cp.bean.kf.msg.WxCpKfResourceMsg; -import me.chanjar.weixin.cp.bean.kf.msg.WxCpKfTextMsg; +import me.chanjar.weixin.cp.bean.kf.msg.*; /** - * @author leiin - * created on 2022/1/26 7:00 下午 + * The type Wx cp kf msg send request. + * + * @author leiin created on 2022/1/26 7:00 下午 */ @NoArgsConstructor @Data diff --git a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/kf/WxCpKfMsgSendResp.java b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/kf/WxCpKfMsgSendResp.java index 83b126718..62bd624d8 100644 --- a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/kf/WxCpKfMsgSendResp.java +++ b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/kf/WxCpKfMsgSendResp.java @@ -8,8 +8,9 @@ import me.chanjar.weixin.cp.bean.WxCpBaseResp; import me.chanjar.weixin.cp.util.json.WxCpGsonBuilder; /** - * @author leiin - * created on 2022/1/26 7:41 下午 + * The type Wx cp kf msg send resp. + * + * @author leiin created on 2022/1/26 7:41 下午 */ @EqualsAndHashCode(callSuper = true) @NoArgsConstructor @@ -18,6 +19,12 @@ public class WxCpKfMsgSendResp extends WxCpBaseResp { @SerializedName("msgid") private String msgId; + /** + * From json wx cp kf msg send resp. + * + * @param json the json + * @return the wx cp kf msg send resp + */ public static WxCpKfMsgSendResp fromJson(String json) { return WxCpGsonBuilder.create().fromJson(json, WxCpKfMsgSendResp.class); } diff --git a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/kf/WxCpKfServiceStateResp.java b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/kf/WxCpKfServiceStateResp.java index 343745364..d273cc32d 100644 --- a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/kf/WxCpKfServiceStateResp.java +++ b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/kf/WxCpKfServiceStateResp.java @@ -8,8 +8,9 @@ import me.chanjar.weixin.cp.bean.WxCpBaseResp; import me.chanjar.weixin.cp.util.json.WxCpGsonBuilder; /** - * @author leiin - * created on 2022/1/26 5:00 下午 + * The type Wx cp kf service state resp. + * + * @author leiin created on 2022/1/26 5:00 下午 */ @EqualsAndHashCode(callSuper = true) @NoArgsConstructor @@ -22,6 +23,12 @@ public class WxCpKfServiceStateResp extends WxCpBaseResp { @SerializedName("servicer_userid") private String servicerUserId; + /** + * From json wx cp kf service state resp. + * + * @param json the json + * @return the wx cp kf service state resp + */ public static WxCpKfServiceStateResp fromJson(String json) { return WxCpGsonBuilder.create().fromJson(json, WxCpKfServiceStateResp.class); } diff --git a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/kf/WxCpKfServiceStateTransResp.java b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/kf/WxCpKfServiceStateTransResp.java index a8836dd8e..604efb12a 100644 --- a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/kf/WxCpKfServiceStateTransResp.java +++ b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/kf/WxCpKfServiceStateTransResp.java @@ -8,8 +8,9 @@ import me.chanjar.weixin.cp.bean.WxCpBaseResp; import me.chanjar.weixin.cp.util.json.WxCpGsonBuilder; /** - * @author leiin - * created on 2022/1/26 5:03 下午 + * The type Wx cp kf service state trans resp. + * + * @author leiin created on 2022/1/26 5:03 下午 */ @EqualsAndHashCode(callSuper = true) @NoArgsConstructor @@ -21,6 +22,12 @@ public class WxCpKfServiceStateTransResp extends WxCpBaseResp { @SerializedName("msg_code") private String msgCode; + /** + * From json wx cp kf service state trans resp. + * + * @param json the json + * @return the wx cp kf service state trans resp + */ public static WxCpKfServiceStateTransResp fromJson(String json) { return WxCpGsonBuilder.create().fromJson(json, WxCpKfServiceStateTransResp.class); } diff --git a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/kf/WxCpKfServiceUpgradeConfigResp.java b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/kf/WxCpKfServiceUpgradeConfigResp.java index 150bab725..61eb1b775 100644 --- a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/kf/WxCpKfServiceUpgradeConfigResp.java +++ b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/kf/WxCpKfServiceUpgradeConfigResp.java @@ -1,16 +1,18 @@ package me.chanjar.weixin.cp.bean.kf; import com.google.gson.annotations.SerializedName; -import java.util.List; import lombok.Data; import lombok.EqualsAndHashCode; import lombok.NoArgsConstructor; import me.chanjar.weixin.cp.bean.WxCpBaseResp; import me.chanjar.weixin.cp.util.json.WxCpGsonBuilder; +import java.util.List; + /** - * @author leiin - * created on 2022/4/26 5:21 下午 + * The type Wx cp kf service upgrade config resp. + * + * @author leiin created on 2022/4/26 5:21 下午 */ @EqualsAndHashCode(callSuper = true) @NoArgsConstructor @@ -25,10 +27,19 @@ public class WxCpKfServiceUpgradeConfigResp extends WxCpBaseResp { @SerializedName("groupchat_range") private GroupchatRange groupchatRange; + /** + * From json wx cp kf service upgrade config resp. + * + * @param json the json + * @return the wx cp kf service upgrade config resp + */ public static WxCpKfServiceUpgradeConfigResp fromJson(String json) { return WxCpGsonBuilder.create().fromJson(json, WxCpKfServiceUpgradeConfigResp.class); } + /** + * The type Member range. + */ @Data @NoArgsConstructor public static class MemberRange { @@ -39,6 +50,9 @@ public class WxCpKfServiceUpgradeConfigResp extends WxCpBaseResp { private List departmentIdList; } + /** + * The type Groupchat range. + */ @Data @NoArgsConstructor public static class GroupchatRange { diff --git a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/kf/WxCpKfServicerListResp.java b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/kf/WxCpKfServicerListResp.java index 69b7e97d7..0b3e4636c 100644 --- a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/kf/WxCpKfServicerListResp.java +++ b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/kf/WxCpKfServicerListResp.java @@ -1,16 +1,18 @@ package me.chanjar.weixin.cp.bean.kf; import com.google.gson.annotations.SerializedName; -import java.util.List; import lombok.Data; import lombok.EqualsAndHashCode; import lombok.NoArgsConstructor; import me.chanjar.weixin.cp.bean.WxCpBaseResp; import me.chanjar.weixin.cp.util.json.WxCpGsonBuilder; +import java.util.List; + /** - * @author leiin - * created on 2022/1/26 4:29 下午 + * The type Wx cp kf servicer list resp. + * + * @author leiin created on 2022/1/26 4:29 下午 */ @EqualsAndHashCode(callSuper = true) @NoArgsConstructor @@ -21,6 +23,9 @@ public class WxCpKfServicerListResp extends WxCpBaseResp { @SerializedName("servicer_list") private List servicerList; + /** + * The type Wx cp kf servicer status. + */ @NoArgsConstructor @Data public static class WxCpKfServicerStatus { @@ -29,6 +34,12 @@ public class WxCpKfServicerListResp extends WxCpBaseResp { private Integer status; } + /** + * From json wx cp kf servicer list resp. + * + * @param json the json + * @return the wx cp kf servicer list resp + */ public static WxCpKfServicerListResp fromJson(String json) { return WxCpGsonBuilder.create().fromJson(json, WxCpKfServicerListResp.class); } diff --git a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/kf/WxCpKfServicerOpResp.java b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/kf/WxCpKfServicerOpResp.java index d72b48225..4e48e0234 100644 --- a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/kf/WxCpKfServicerOpResp.java +++ b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/kf/WxCpKfServicerOpResp.java @@ -2,17 +2,18 @@ package me.chanjar.weixin.cp.bean.kf; import com.google.gson.annotations.SerializedName; -import java.util.List; import lombok.Data; import lombok.EqualsAndHashCode; import lombok.NoArgsConstructor; import me.chanjar.weixin.cp.bean.WxCpBaseResp; import me.chanjar.weixin.cp.util.json.WxCpGsonBuilder; +import java.util.List; + /** * 添加/删除客服接待人员返回结果 - * @author leiin - * created on 2022/1/26 4:11 下午 + * + * @author leiin created on 2022/1/26 4:11 下午 */ @EqualsAndHashCode(callSuper = true) @NoArgsConstructor @@ -24,6 +25,9 @@ public class WxCpKfServicerOpResp extends WxCpBaseResp { @SerializedName("result_list") private List resultList; + /** + * The type Wx cp kf servicer resp. + */ @Data @NoArgsConstructor public static class WxCpKfServicerResp extends WxCpBaseResp { @@ -32,6 +36,12 @@ public class WxCpKfServicerOpResp extends WxCpBaseResp { private String userId; } + /** + * From json wx cp kf servicer op resp. + * + * @param json the json + * @return the wx cp kf servicer op resp + */ public static WxCpKfServicerOpResp fromJson(String json) { return WxCpGsonBuilder.create().fromJson(json, WxCpKfServicerOpResp.class); } diff --git a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/kf/msg/WxCpKfBusinessCardMsg.java b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/kf/msg/WxCpKfBusinessCardMsg.java index 22593c330..95fe7f72b 100644 --- a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/kf/msg/WxCpKfBusinessCardMsg.java +++ b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/kf/msg/WxCpKfBusinessCardMsg.java @@ -5,8 +5,9 @@ import lombok.Data; import lombok.NoArgsConstructor; /** - * @author leiin - * created on 2022/1/26 5:35 下午 + * The type Wx cp kf business card msg. + * + * @author leiin created on 2022/1/26 5:35 下午 */ @NoArgsConstructor @Data diff --git a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/kf/msg/WxCpKfEventMsg.java b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/kf/msg/WxCpKfEventMsg.java index 42c4b2450..6febab987 100644 --- a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/kf/msg/WxCpKfEventMsg.java +++ b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/kf/msg/WxCpKfEventMsg.java @@ -5,8 +5,9 @@ import lombok.Data; import lombok.NoArgsConstructor; /** - * @author leiin - * created on 2022/1/26 6:44 下午 + * The type Wx cp kf event msg. + * + * @author leiin created on 2022/1/26 6:44 下午 */ @NoArgsConstructor @Data diff --git a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/kf/msg/WxCpKfLinkMsg.java b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/kf/msg/WxCpKfLinkMsg.java index 2fe2503e1..64809f1eb 100644 --- a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/kf/msg/WxCpKfLinkMsg.java +++ b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/kf/msg/WxCpKfLinkMsg.java @@ -5,8 +5,9 @@ import lombok.Data; import lombok.NoArgsConstructor; /** - * @author leiin - * created on 2022/1/26 5:33 下午 + * The type Wx cp kf link msg. + * + * @author leiin created on 2022/1/26 5:33 下午 */ @NoArgsConstructor @Data diff --git a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/kf/msg/WxCpKfLocationMsg.java b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/kf/msg/WxCpKfLocationMsg.java index 742f5c8a6..6e7fa9ab7 100644 --- a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/kf/msg/WxCpKfLocationMsg.java +++ b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/kf/msg/WxCpKfLocationMsg.java @@ -4,8 +4,9 @@ import lombok.Data; import lombok.NoArgsConstructor; /** - * @author leiin - * created on 2022/1/26 5:32 下午 + * The type Wx cp kf location msg. + * + * @author leiin created on 2022/1/26 5:32 下午 */ @NoArgsConstructor @Data diff --git a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/kf/msg/WxCpKfMenuMsg.java b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/kf/msg/WxCpKfMenuMsg.java index 6153192b8..e994a0a00 100644 --- a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/kf/msg/WxCpKfMenuMsg.java +++ b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/kf/msg/WxCpKfMenuMsg.java @@ -1,15 +1,17 @@ package me.chanjar.weixin.cp.bean.kf.msg; import com.google.gson.annotations.SerializedName; -import java.util.List; import lombok.Data; import lombok.Getter; import lombok.NoArgsConstructor; import lombok.Setter; +import java.util.List; + /** - * @author leiin - * created on 2022/1/26 6:33 下午 + * The type Wx cp kf menu msg. + * + * @author leiin created on 2022/1/26 6:33 下午 */ @NoArgsConstructor @Data @@ -35,6 +37,9 @@ public class WxCpKfMenuMsg { @SerializedName("tail_content") private String tailContent; + /** + * The type Wx cp kf menu item. + */ @NoArgsConstructor @Data public static class WxCpKfMenuItem { @@ -61,6 +66,9 @@ public class WxCpKfMenuMsg { private MiniProgram miniProgram; } + /** + * The type Menu click. + */ @Getter @Setter public static class MenuClick { @@ -81,6 +89,9 @@ public class WxCpKfMenuMsg { private String content; } + /** + * The type Menu view. + */ @Getter @Setter public static class MenuView { @@ -100,6 +111,9 @@ public class WxCpKfMenuMsg { private String content; } + /** + * The type Mini program. + */ @Getter @Setter public static class MiniProgram { diff --git a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/kf/msg/WxCpKfMiniProgramMsg.java b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/kf/msg/WxCpKfMiniProgramMsg.java index 0c9101e1b..49829a729 100644 --- a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/kf/msg/WxCpKfMiniProgramMsg.java +++ b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/kf/msg/WxCpKfMiniProgramMsg.java @@ -5,8 +5,9 @@ import lombok.Data; import lombok.NoArgsConstructor; /** - * @author leiin - * created on 2022/1/26 6:22 下午 + * The type Wx cp kf mini program msg. + * + * @author leiin created on 2022/1/26 6:22 下午 */ @NoArgsConstructor @Data diff --git a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/kf/msg/WxCpKfResourceMsg.java b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/kf/msg/WxCpKfResourceMsg.java index 3deb29b72..fd25095b5 100644 --- a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/kf/msg/WxCpKfResourceMsg.java +++ b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/kf/msg/WxCpKfResourceMsg.java @@ -5,8 +5,9 @@ import lombok.Data; import lombok.NoArgsConstructor; /** - * @author leiin - * created on 2022/1/26 5:31 下午 + * The type Wx cp kf resource msg. + * + * @author leiin created on 2022/1/26 5:31 下午 */ @NoArgsConstructor @Data diff --git a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/kf/msg/WxCpKfTextMsg.java b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/kf/msg/WxCpKfTextMsg.java index 1fd44b49c..22c8eb548 100644 --- a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/kf/msg/WxCpKfTextMsg.java +++ b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/kf/msg/WxCpKfTextMsg.java @@ -5,8 +5,9 @@ import lombok.Data; import lombok.NoArgsConstructor; /** - * @author leiin - * created on 2022/1/26 5:30 下午 + * The type Wx cp kf text msg. + * + * @author leiin created on 2022/1/26 5:30 下午 */ @NoArgsConstructor @Data diff --git a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/license/WxCpTpLicenseAccount.java b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/license/WxCpTpLicenseAccount.java index 4deb42bff..60975f544 100644 --- a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/license/WxCpTpLicenseAccount.java +++ b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/license/WxCpTpLicenseAccount.java @@ -10,8 +10,8 @@ import lombok.experimental.SuperBuilder; /** * 订单账号信息 - * @author Totoro - * created on 2022/6/27 14:04 + * + * @author Totoro created on 2022/6/27 14:04 */ @EqualsAndHashCode(callSuper = true) @Data @@ -28,5 +28,4 @@ public class WxCpTpLicenseAccount extends WxCpTpLicenseBaseAccount { private String activeCode; - } diff --git a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/license/WxCpTpLicenseAccountCount.java b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/license/WxCpTpLicenseAccountCount.java index 69e9cd714..68e8d784d 100644 --- a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/license/WxCpTpLicenseAccountCount.java +++ b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/license/WxCpTpLicenseAccountCount.java @@ -10,8 +10,9 @@ import me.chanjar.weixin.cp.util.json.WxCpGsonBuilder; import java.io.Serializable; /** - * @author Totoro - * created on 2022/6/27 11:54 + * The type Wx cp tp license account count. + * + * @author Totoro created on 2022/6/27 11:54 */ @Data @Builder @@ -25,6 +26,11 @@ public class WxCpTpLicenseAccountCount implements Serializable { @SerializedName("external_contact_count") private Integer externalContactCount; + /** + * To json string. + * + * @return the string + */ public String toJson() { return WxCpGsonBuilder.create().toJson(this); } diff --git a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/license/WxCpTpLicenseAccountDuration.java b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/license/WxCpTpLicenseAccountDuration.java index 49e9db60a..ebc58f1ec 100644 --- a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/license/WxCpTpLicenseAccountDuration.java +++ b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/license/WxCpTpLicenseAccountDuration.java @@ -8,9 +8,9 @@ import lombok.NoArgsConstructor; import java.io.Serializable; /** + * The type Wx cp tp license account duration. * - * @author Totoro - * created on 2022-6-27 11:22:53 + * @author Totoro created on 2022-6-27 11:22:53 */ @Data @Builder @@ -21,4 +21,4 @@ public class WxCpTpLicenseAccountDuration implements Serializable { private Integer months; - } +} diff --git a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/license/WxCpTpLicenseActiveAccount.java b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/license/WxCpTpLicenseActiveAccount.java index 50f3f7cf2..2493c657c 100644 --- a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/license/WxCpTpLicenseActiveAccount.java +++ b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/license/WxCpTpLicenseActiveAccount.java @@ -9,8 +9,9 @@ import lombok.NoArgsConstructor; import java.io.Serializable; /** - * @author Totoro - * created on 2022-6-27 16:26:35 + * The type Wx cp tp license active account. + * + * @author Totoro created on 2022-6-27 16:26:35 */ @Data @Builder diff --git a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/license/WxCpTpLicenseActiveCodeInfo.java b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/license/WxCpTpLicenseActiveCodeInfo.java index 6eb46f8cc..86d70ed8a 100644 --- a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/license/WxCpTpLicenseActiveCodeInfo.java +++ b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/license/WxCpTpLicenseActiveCodeInfo.java @@ -10,8 +10,8 @@ import lombok.experimental.SuperBuilder; /** * 激活码信息 * 文档地址：https://developer.work.weixin.qq.com/document/path/95553 - * @author Totoro - * created on 2022/6/27 14:34 + * + * @author Totoro created on 2022/6/27 14:34 */ @EqualsAndHashCode(callSuper = true) @Data diff --git a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/license/WxCpTpLicenseBaseAccount.java b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/license/WxCpTpLicenseBaseAccount.java index 88ad34070..7e363f4fd 100644 --- a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/license/WxCpTpLicenseBaseAccount.java +++ b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/license/WxCpTpLicenseBaseAccount.java @@ -10,8 +10,8 @@ import java.io.Serializable; /** * 许可证账号基础类 - * @author Totoro - * created on 2022/6/27 14:39 + * + * @author Totoro created on 2022/6/27 14:39 */ @Data @SuperBuilder @@ -32,6 +32,11 @@ public class WxCpTpLicenseBaseAccount implements Serializable { private Integer type; + /** + * To json string. + * + * @return the string + */ public String toJson() { return WxCpGsonBuilder.create().toJson(this); } diff --git a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/license/WxCpTpLicenseCorpAccount.java b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/license/WxCpTpLicenseCorpAccount.java index 871ed8695..05b523ec9 100644 --- a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/license/WxCpTpLicenseCorpAccount.java +++ b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/license/WxCpTpLicenseCorpAccount.java @@ -8,8 +8,9 @@ import lombok.NoArgsConstructor; import lombok.experimental.SuperBuilder; /** - * @author Totoro - * created on 2022/6/27 15:21 + * The type Wx cp tp license corp account. + * + * @author Totoro created on 2022/6/27 15:21 */ @EqualsAndHashCode(callSuper = true) @Data diff --git a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/license/WxCpTpLicenseInvalidAccount.java b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/license/WxCpTpLicenseInvalidAccount.java index 476bc3b88..85994d7ed 100644 --- a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/license/WxCpTpLicenseInvalidAccount.java +++ b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/license/WxCpTpLicenseInvalidAccount.java @@ -8,8 +8,9 @@ import lombok.NoArgsConstructor; import lombok.experimental.SuperBuilder; /** - * @author Totoro - * created on 2022-6-27 15:35:30 + * The type Wx cp tp license invalid account. + * + * @author Totoro created on 2022-6-27 15:35:30 */ @EqualsAndHashCode(callSuper = true) @Data diff --git a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/license/WxCpTpLicenseOrder.java b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/license/WxCpTpLicenseOrder.java index 45cb8227f..0cfbe5b02 100644 --- a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/license/WxCpTpLicenseOrder.java +++ b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/license/WxCpTpLicenseOrder.java @@ -9,8 +9,8 @@ import java.io.Serializable; /** * 详细的订单信息 * 文档地址：https://developer.work.weixin.qq.com/document/path/95648 - * @author Totoro - * created on 2022/6/27 11:38 + * + * @author Totoro created on 2022/6/27 11:38 */ @Data public class WxCpTpLicenseOrder implements Serializable { @@ -45,6 +45,11 @@ public class WxCpTpLicenseOrder implements Serializable { private Long payTime; + /** + * To json string. + * + * @return the string + */ public String toJson() { return WxCpGsonBuilder.create().toJson(this); } diff --git a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/license/WxCpTpLicenseSimpleOrder.java b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/license/WxCpTpLicenseSimpleOrder.java index 036af6a8b..f994fd7a4 100644 --- a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/license/WxCpTpLicenseSimpleOrder.java +++ b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/license/WxCpTpLicenseSimpleOrder.java @@ -10,8 +10,9 @@ import me.chanjar.weixin.cp.util.json.WxCpGsonBuilder; import java.io.Serializable; /** - * @author Totoro - * created on 2022/6/27 11:38 + * The type Wx cp tp license simple order. + * + * @author Totoro created on 2022/6/27 11:38 */ @Data @Builder @@ -26,6 +27,11 @@ public class WxCpTpLicenseSimpleOrder implements Serializable { @SerializedName("order_type") private Integer orderType; + /** + * To json string. + * + * @return the string + */ public String toJson() { return WxCpGsonBuilder.create().toJson(this); } diff --git a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/license/WxCpTpLicenseTransfer.java b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/license/WxCpTpLicenseTransfer.java index 2b2d99812..6be49008b 100644 --- a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/license/WxCpTpLicenseTransfer.java +++ b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/license/WxCpTpLicenseTransfer.java @@ -10,8 +10,8 @@ import java.io.Serializable; /** * 基础的信息 - * @author Totoro - * created on 2022/6/27 15:50 + * + * @author Totoro created on 2022/6/27 15:50 */ @Data @Builder @@ -41,6 +41,4 @@ public class WxCpTpLicenseTransfer implements Serializable { private Integer errCode; - - } diff --git a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/license/account/WxCpTpLicenseActiveInfoByUserResp.java b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/license/account/WxCpTpLicenseActiveInfoByUserResp.java index 10cbe4861..a9284d9d6 100644 --- a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/license/account/WxCpTpLicenseActiveInfoByUserResp.java +++ b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/license/account/WxCpTpLicenseActiveInfoByUserResp.java @@ -12,8 +12,8 @@ import java.util.List; /** * 某个企业成员的激活情况 * 文档地址：https://developer.work.weixin.qq.com/document/path/95555 - * @author Totoro - * created on 2022-6-27 14:51:19 + * + * @author Totoro created on 2022-6-27 14:51:19 */ @EqualsAndHashCode(callSuper = true) @Data @@ -28,6 +28,12 @@ public class WxCpTpLicenseActiveInfoByUserResp extends WxCpBaseResp { private List activeInfoList; + /** + * From json wx cp tp license active info by user resp. + * + * @param json the json + * @return the wx cp tp license active info by user resp + */ public static WxCpTpLicenseActiveInfoByUserResp fromJson(String json) { return WxCpGsonBuilder.create().fromJson(json, WxCpTpLicenseActiveInfoByUserResp.class); } diff --git a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/license/account/WxCpTpLicenseBatchActiveResultResp.java b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/license/account/WxCpTpLicenseBatchActiveResultResp.java index ccc5f3204..f1336af5a 100644 --- a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/license/account/WxCpTpLicenseBatchActiveResultResp.java +++ b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/license/account/WxCpTpLicenseBatchActiveResultResp.java @@ -12,8 +12,8 @@ import java.util.List; /** * 批量激活帐号结果 * 文档地址：https://developer.work.weixin.qq.com/document/path/95553 - * @author Totoro - * created on 2022-6-27 16:19:21 + * + * @author Totoro created on 2022-6-27 16:19:21 */ @EqualsAndHashCode(callSuper = true) @Data @@ -25,8 +25,12 @@ public class WxCpTpLicenseBatchActiveResultResp extends WxCpBaseResp { private List activeResults; - - + /** + * From json wx cp tp license batch active result resp. + * + * @param json the json + * @return the wx cp tp license batch active result resp + */ public static WxCpTpLicenseBatchActiveResultResp fromJson(String json) { return WxCpGsonBuilder.create().fromJson(json, WxCpTpLicenseBatchActiveResultResp.class); } diff --git a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/license/account/WxCpTpLicenseBatchCodeInfoResp.java b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/license/account/WxCpTpLicenseBatchCodeInfoResp.java index c0d7884f4..002970012 100644 --- a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/license/account/WxCpTpLicenseBatchCodeInfoResp.java +++ b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/license/account/WxCpTpLicenseBatchCodeInfoResp.java @@ -12,8 +12,8 @@ import java.util.List; /** * 批量查询的激活码详情 * 文档地址：https://developer.work.weixin.qq.com/document/path/95553 - * @author Totoro - * created on 2022-6-27 14:51:19 + * + * @author Totoro created on 2022-6-27 14:51:19 */ @EqualsAndHashCode(callSuper = true) @Data @@ -27,6 +27,12 @@ public class WxCpTpLicenseBatchCodeInfoResp extends WxCpBaseResp { private List invalidActiveCodeList; + /** + * From json wx cp tp license batch code info resp. + * + * @param json the json + * @return the wx cp tp license batch code info resp + */ public static WxCpTpLicenseBatchCodeInfoResp fromJson(String json) { return WxCpGsonBuilder.create().fromJson(json, WxCpTpLicenseBatchCodeInfoResp.class); } diff --git a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/license/account/WxCpTpLicenseBatchTransferResp.java b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/license/account/WxCpTpLicenseBatchTransferResp.java index f95d463a0..1b24a20a3 100644 --- a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/license/account/WxCpTpLicenseBatchTransferResp.java +++ b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/license/account/WxCpTpLicenseBatchTransferResp.java @@ -12,8 +12,8 @@ import java.util.List; /** * 基础结果返回信息 * 文档地址：https://developer.work.weixin.qq.com/document/path/95673 - * @author Totoro - * created on 2022/6/27 15:49 + * + * @author Totoro created on 2022/6/27 15:49 */ @EqualsAndHashCode(callSuper = true) @Data @@ -23,10 +23,15 @@ public class WxCpTpLicenseBatchTransferResp extends WxCpBaseResp { @SerializedName("transfer_result") private List transferResult; + /** + * From json wx cp tp license batch transfer resp. + * + * @param json the json + * @return the wx cp tp license batch transfer resp + */ public static WxCpTpLicenseBatchTransferResp fromJson(String json) { return WxCpGsonBuilder.create().fromJson(json, WxCpTpLicenseBatchTransferResp.class); } - } diff --git a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/license/account/WxCpTpLicenseCodeInfoResp.java b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/license/account/WxCpTpLicenseCodeInfoResp.java index f649c48a2..152b38d8b 100644 --- a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/license/account/WxCpTpLicenseCodeInfoResp.java +++ b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/license/account/WxCpTpLicenseCodeInfoResp.java @@ -10,8 +10,8 @@ import me.chanjar.weixin.cp.util.json.WxCpGsonBuilder; /** * 查询的激活码详情 * 文档地址：https://developer.work.weixin.qq.com/document/path/95553 - * @author Totoro - * created on 2022/6/27 14:28 + * + * @author Totoro created on 2022/6/27 14:28 */ @EqualsAndHashCode(callSuper = true) @Data @@ -22,6 +22,12 @@ public class WxCpTpLicenseCodeInfoResp extends WxCpBaseResp { private WxCpTpLicenseActiveCodeInfo activeCodeInfo; + /** + * From json wx cp tp license code info resp. + * + * @param json the json + * @return the wx cp tp license code info resp + */ public static WxCpTpLicenseCodeInfoResp fromJson(String json) { return WxCpGsonBuilder.create().fromJson(json, WxCpTpLicenseCodeInfoResp.class); } diff --git a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/license/account/WxCpTpLicenseCorpAccountListResp.java b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/license/account/WxCpTpLicenseCorpAccountListResp.java index 93c64dcfc..79e7f8130 100644 --- a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/license/account/WxCpTpLicenseCorpAccountListResp.java +++ b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/license/account/WxCpTpLicenseCorpAccountListResp.java @@ -12,8 +12,8 @@ import java.util.List; /** * 企业的帐号列表（已激活） * 文档地址：https://developer.work.weixin.qq.com/document/path/95544 - * @author Totoro - * created on 2022/6/27 15:15 + * + * @author Totoro created on 2022/6/27 15:15 */ @EqualsAndHashCode(callSuper = true) @Data @@ -30,6 +30,12 @@ public class WxCpTpLicenseCorpAccountListResp extends WxCpBaseResp { private List orderList; + /** + * From json wx cp tp license corp account list resp. + * + * @param json the json + * @return the wx cp tp license corp account list resp + */ public static WxCpTpLicenseCorpAccountListResp fromJson(String json) { return WxCpGsonBuilder.create().fromJson(json, WxCpTpLicenseCorpAccountListResp.class); } diff --git a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/license/order/WxCpTpLicenseCreateOrderResp.java b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/license/order/WxCpTpLicenseCreateOrderResp.java index a2092f07f..66648b75d 100644 --- a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/license/order/WxCpTpLicenseCreateOrderResp.java +++ b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/license/order/WxCpTpLicenseCreateOrderResp.java @@ -9,8 +9,8 @@ import me.chanjar.weixin.cp.util.json.WxCpGsonBuilder; /** * 订单创建结果 * 文档地址：https://developer.work.weixin.qq.com/document/path/95644 - * @author Totoro - * created on 2022-6-27 11:26:36 + * + * @author Totoro created on 2022-6-27 11:26:36 */ @EqualsAndHashCode(callSuper = true) @Data @@ -21,11 +21,15 @@ public class WxCpTpLicenseCreateOrderResp extends WxCpBaseResp { private String orderId; + /** + * From json wx cp tp license create order resp. + * + * @param json the json + * @return the wx cp tp license create order resp + */ public static WxCpTpLicenseCreateOrderResp fromJson(String json) { return WxCpGsonBuilder.create().fromJson(json, WxCpTpLicenseCreateOrderResp.class); } - - } diff --git a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/license/order/WxCpTpLicenseNewOrderRequest.java b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/license/order/WxCpTpLicenseNewOrderRequest.java index dea1f4dac..232fd9d9e 100644 --- a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/license/order/WxCpTpLicenseNewOrderRequest.java +++ b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/license/order/WxCpTpLicenseNewOrderRequest.java @@ -1,4 +1,5 @@ package me.chanjar.weixin.cp.bean.license.order; + import com.google.gson.annotations.SerializedName; import lombok.AllArgsConstructor; import lombok.Builder; @@ -13,8 +14,8 @@ import java.io.Serializable; /** * 下单购买帐号 * 文档地址：https://developer.work.weixin.qq.com/document/path/95644 - * @author Totoro - * created on 2022/6/27 10:52 + * + * @author Totoro created on 2022/6/27 10:52 */ @Data @Builder @@ -48,13 +49,14 @@ public class WxCpTpLicenseNewOrderRequest implements Serializable { private WxCpTpLicenseAccountDuration accountDuration; - + /** + * To json string. + * + * @return the string + */ public String toJson() { return WxCpGsonBuilder.create().toJson(this); } - - - } diff --git a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/license/order/WxCpTpLicenseOrderAccountListResp.java b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/license/order/WxCpTpLicenseOrderAccountListResp.java index dcb607ef4..295fdb843 100644 --- a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/license/order/WxCpTpLicenseOrderAccountListResp.java +++ b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/license/order/WxCpTpLicenseOrderAccountListResp.java @@ -12,8 +12,8 @@ import java.util.List; /** * 获取订单中的帐号列表 * 文档地址：https://developer.work.weixin.qq.com/document/path/95649 - * @author Totoro - * created on 2022-6-27 14:14:40 + * + * @author Totoro created on 2022-6-27 14:14:40 */ @Data @EqualsAndHashCode(callSuper = true) @@ -30,10 +30,15 @@ public class WxCpTpLicenseOrderAccountListResp extends WxCpBaseResp { private List accountList; + /** + * From json wx cp tp license order account list resp. + * + * @param json the json + * @return the wx cp tp license order account list resp + */ public static WxCpTpLicenseOrderAccountListResp fromJson(String json) { return WxCpGsonBuilder.create().fromJson(json, WxCpTpLicenseOrderAccountListResp.class); } - } diff --git a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/license/order/WxCpTpLicenseOrderInfoResp.java b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/license/order/WxCpTpLicenseOrderInfoResp.java index 1aacda9ed..691aa25a7 100644 --- a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/license/order/WxCpTpLicenseOrderInfoResp.java +++ b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/license/order/WxCpTpLicenseOrderInfoResp.java @@ -9,8 +9,8 @@ import me.chanjar.weixin.cp.util.json.WxCpGsonBuilder; /** * 订单详情结果 * 文档：https://developer.work.weixin.qq.com/document/path/95648 - * @author Totoro - * created on 2022/06/27 11:56:03 + * + * @author Totoro created on 2022/06/27 11:56:03 */ @EqualsAndHashCode(callSuper = true) @Data @@ -21,10 +21,15 @@ public class WxCpTpLicenseOrderInfoResp extends WxCpBaseResp { private WxCpTpLicenseOrder order; + /** + * From json wx cp tp license order info resp. + * + * @param json the json + * @return the wx cp tp license order info resp + */ public static WxCpTpLicenseOrderInfoResp fromJson(String json) { return WxCpGsonBuilder.create().fromJson(json, WxCpTpLicenseOrderInfoResp.class); } - } diff --git a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/license/order/WxCpTpLicenseOrderListResp.java b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/license/order/WxCpTpLicenseOrderListResp.java index 5b4038a13..a9e0e5d32 100644 --- a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/license/order/WxCpTpLicenseOrderListResp.java +++ b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/license/order/WxCpTpLicenseOrderListResp.java @@ -12,8 +12,8 @@ import java.util.List; /** * 获取订单列表详情 * 文档地址：https://developer.work.weixin.qq.com/document/path/95647 - * @author Totoro - * created on 2022/6/27 11:39 + * + * @author Totoro created on 2022/6/27 11:39 */ @Data @EqualsAndHashCode(callSuper = true) @@ -30,10 +30,15 @@ public class WxCpTpLicenseOrderListResp extends WxCpBaseResp { private List orderList; + /** + * From json wx cp tp license order list resp. + * + * @param json the json + * @return the wx cp tp license order list resp + */ public static WxCpTpLicenseOrderListResp fromJson(String json) { return WxCpGsonBuilder.create().fromJson(json, WxCpTpLicenseOrderListResp.class); } - } diff --git a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/license/order/WxCpTpLicenseRenewOrderJobRequest.java b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/license/order/WxCpTpLicenseRenewOrderJobRequest.java index 7c65b4fdd..aabae9459 100644 --- a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/license/order/WxCpTpLicenseRenewOrderJobRequest.java +++ b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/license/order/WxCpTpLicenseRenewOrderJobRequest.java @@ -1,4 +1,5 @@ package me.chanjar.weixin.cp.bean.license.order; + import com.google.gson.annotations.SerializedName; import lombok.AllArgsConstructor; import lombok.Builder; @@ -13,8 +14,8 @@ import java.util.List; /** * 创建下单续期帐号任务 * 文档地址：https://developer.work.weixin.qq.com/document/path/95646 - * @author Totoro - * created on 2022/6/27 11:12 + * + * @author Totoro created on 2022/6/27 11:12 */ @Data @Builder @@ -40,7 +41,11 @@ public class WxCpTpLicenseRenewOrderJobRequest implements Serializable { private String jobId; - + /** + * To json string. + * + * @return the string + */ public String toJson() { return WxCpGsonBuilder.create().toJson(this); } diff --git a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/license/order/WxCpTpLicenseRenewOrderJobResp.java b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/license/order/WxCpTpLicenseRenewOrderJobResp.java index 91e4970fb..31734b5ad 100644 --- a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/license/order/WxCpTpLicenseRenewOrderJobResp.java +++ b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/license/order/WxCpTpLicenseRenewOrderJobResp.java @@ -12,8 +12,8 @@ import java.util.List; /** * 创建下单购买帐号任务返回结果 * 文档地址：https://developer.work.weixin.qq.com/document/path/95646 - * @author Totoro - * created on 2022-6-27 11:15:20 + * + * @author Totoro created on 2022-6-27 11:15:20 */ @EqualsAndHashCode(callSuper = true) @Data @@ -32,12 +32,15 @@ public class WxCpTpLicenseRenewOrderJobResp extends WxCpBaseResp { private List invalidAccountList; - + /** + * From json wx cp tp license renew order job resp. + * + * @param json the json + * @return the wx cp tp license renew order job resp + */ public static WxCpTpLicenseRenewOrderJobResp fromJson(String json) { return WxCpGsonBuilder.create().fromJson(json, WxCpTpLicenseRenewOrderJobResp.class); } - - } diff --git a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/license/order/WxCpTpLicenseRenewOrderRequest.java b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/license/order/WxCpTpLicenseRenewOrderRequest.java index fa7e3d11e..196e02c1c 100644 --- a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/license/order/WxCpTpLicenseRenewOrderRequest.java +++ b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/license/order/WxCpTpLicenseRenewOrderRequest.java @@ -1,4 +1,5 @@ package me.chanjar.weixin.cp.bean.license.order; + import com.google.gson.annotations.SerializedName; import lombok.AllArgsConstructor; import lombok.Builder; @@ -12,8 +13,8 @@ import java.io.Serializable; /** * 续期帐号订单 * 文档地址：https://developer.work.weixin.qq.com/document/path/95646 - * @author Totoro - * created on 2022-6-27 11:21:51 + * + * @author Totoro created on 2022-6-27 11:21:51 */ @Data @Builder @@ -30,6 +31,11 @@ public class WxCpTpLicenseRenewOrderRequest implements Serializable { private WxCpTpLicenseAccountDuration accountDuration; + /** + * To json string. + * + * @return the string + */ public String toJson() { return WxCpGsonBuilder.create().toJson(this); } diff --git a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/living/WxCpLivingCreateRequest.java b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/living/WxCpLivingCreateRequest.java index e733b805d..00d0320cd 100644 --- a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/living/WxCpLivingCreateRequest.java +++ b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/living/WxCpLivingCreateRequest.java @@ -11,8 +11,7 @@ import java.util.List; /** * 创建预约直播请求. * - * @author Wang_Wong - * created on 2021-12-23 + * @author Wang_Wong created on 2021-12-23 */ @Data @Builder @@ -55,6 +54,9 @@ public class WxCpLivingCreateRequest implements Serializable { @SerializedName("activity_detail") private ActivityDetail activityDetail; + /** + * The type Activity detail. + */ @Getter @Setter public static class ActivityDetail implements Serializable { @@ -65,20 +67,42 @@ public class WxCpLivingCreateRequest implements Serializable { @SerializedName("description") private String description; + /** + * From json activity detail. + * + * @param json the json + * @return the activity detail + */ public static ActivityDetail fromJson(String json) { return WxCpGsonBuilder.create().fromJson(json, ActivityDetail.class); } + /** + * To json string. + * + * @return the string + */ public String toJson() { return WxCpGsonBuilder.create().toJson(this); } } + /** + * From json wx cp living create request. + * + * @param json the json + * @return the wx cp living create request + */ public static WxCpLivingCreateRequest fromJson(String json) { return WxCpGsonBuilder.create().fromJson(json, WxCpLivingCreateRequest.class); } + /** + * To json string. + * + * @return the string + */ public String toJson() { return WxCpGsonBuilder.create().toJson(this); } diff --git a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/living/WxCpLivingInfo.java b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/living/WxCpLivingInfo.java index 59ba35cd1..f8fdeb351 100644 --- a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/living/WxCpLivingInfo.java +++ b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/living/WxCpLivingInfo.java @@ -69,10 +69,21 @@ public class WxCpLivingInfo implements Serializable { @SerializedName("subscribe_count") private Integer subscribeCount; + /** + * From json wx cp living info. + * + * @param json the json + * @return the wx cp living info + */ public static WxCpLivingInfo fromJson(String json) { return WxCpGsonBuilder.create().fromJson(json, WxCpLivingInfo.class); } + /** + * To json string. + * + * @return the string + */ public String toJson() { return WxCpGsonBuilder.create().toJson(this); } diff --git a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/living/WxCpLivingModifyRequest.java b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/living/WxCpLivingModifyRequest.java index 358429bee..fe8a44670 100644 --- a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/living/WxCpLivingModifyRequest.java +++ b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/living/WxCpLivingModifyRequest.java @@ -13,8 +13,7 @@ import java.io.Serializable; /** * 创建预约直播请求. * - * @author Wang_Wong - * created on 2021-12-23 + * @author Wang_Wong created on 2021-12-23 */ @Data @Builder @@ -45,10 +44,21 @@ public class WxCpLivingModifyRequest implements Serializable { @SerializedName("type") private Integer type; + /** + * From json wx cp living modify request. + * + * @param json the json + * @return the wx cp living modify request + */ public static WxCpLivingModifyRequest fromJson(String json) { return WxCpGsonBuilder.create().fromJson(json, WxCpLivingModifyRequest.class); } + /** + * To json string. + * + * @return the string + */ public String toJson() { return WxCpGsonBuilder.create().toJson(this); } diff --git a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/living/WxCpLivingResult.java b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/living/WxCpLivingResult.java index 09c912ad8..92f698848 100644 --- a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/living/WxCpLivingResult.java +++ b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/living/WxCpLivingResult.java @@ -23,6 +23,9 @@ public class WxCpLivingResult implements Serializable { @SerializedName("errmsg") private String errmsg; + /** + * The type Living id result. + */ @Getter @Setter public static class LivingIdResult implements Serializable { @@ -34,20 +37,42 @@ public class WxCpLivingResult implements Serializable { @SerializedName("livingid_list") private String[] livingIdList; + /** + * From json living id result. + * + * @param json the json + * @return the living id result + */ public static LivingIdResult fromJson(String json) { return WxCpGsonBuilder.create().fromJson(json, LivingIdResult.class); } + /** + * To json string. + * + * @return the string + */ public String toJson() { return WxCpGsonBuilder.create().toJson(this); } } + /** + * From json wx cp living result. + * + * @param json the json + * @return the wx cp living result + */ public static WxCpLivingResult fromJson(String json) { return WxCpGsonBuilder.create().fromJson(json, WxCpLivingResult.class); } + /** + * To json string. + * + * @return the string + */ public String toJson() { return WxCpGsonBuilder.create().toJson(this); } diff --git a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/living/WxCpLivingShareInfo.java b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/living/WxCpLivingShareInfo.java index f0b96cc96..16f74e253 100644 --- a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/living/WxCpLivingShareInfo.java +++ b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/living/WxCpLivingShareInfo.java @@ -29,10 +29,21 @@ public class WxCpLivingShareInfo implements Serializable { @SerializedName("invitor_external_userid") private String invitorExternalUserid; + /** + * From json wx cp living share info. + * + * @param json the json + * @return the wx cp living share info + */ public static WxCpLivingShareInfo fromJson(String json) { return WxCpGsonBuilder.create().fromJson(json, WxCpLivingShareInfo.class); } + /** + * To json string. + * + * @return the string + */ public String toJson() { return WxCpGsonBuilder.create().toJson(this); } diff --git a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/living/WxCpWatchStat.java b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/living/WxCpWatchStat.java index 4a77bdd45..f1c25a170 100644 --- a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/living/WxCpWatchStat.java +++ b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/living/WxCpWatchStat.java @@ -26,6 +26,9 @@ public class WxCpWatchStat implements Serializable { @SerializedName("stat_info") private StatInfo statInfo; + /** + * The type Stat info. + */ @Getter @Setter public static class StatInfo implements Serializable { @@ -39,6 +42,9 @@ public class WxCpWatchStat implements Serializable { } + /** + * The type User. + */ @Getter @Setter public static class User implements Serializable { @@ -57,6 +63,9 @@ public class WxCpWatchStat implements Serializable { } + /** + * The type External user. + */ @Getter @Setter public static class ExternalUser implements Serializable { @@ -79,10 +88,21 @@ public class WxCpWatchStat implements Serializable { } + /** + * From json wx cp watch stat. + * + * @param json the json + * @return the wx cp watch stat + */ public static WxCpWatchStat fromJson(String json) { return WxCpGsonBuilder.create().fromJson(json, WxCpWatchStat.class); } + /** + * To json string. + * + * @return the string + */ public String toJson() { return WxCpGsonBuilder.create().toJson(this); } diff --git a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/message/WxCpAppChatMessage.java b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/message/WxCpAppChatMessage.java index 10dd3c1b2..e1cbb5c65 100644 --- a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/message/WxCpAppChatMessage.java +++ b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/message/WxCpAppChatMessage.java @@ -75,6 +75,11 @@ public class WxCpAppChatMessage implements Serializable { /** * 构建文本消息. + * + * @param chatId the chat id + * @param content the content + * @param safe the safe + * @return the wx cp app chat message */ public static WxCpAppChatMessage buildTextMsg(String chatId, String content, boolean safe) { final WxCpAppChatMessage message = new WxCpAppChatMessage(); @@ -87,6 +92,8 @@ public class WxCpAppChatMessage implements Serializable { /** * 生成json字符串. + * + * @return the string */ public String toJson() { JsonObject messageJson = new JsonObject(); diff --git a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/message/WxCpGroupRobotMessage.java b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/message/WxCpGroupRobotMessage.java index bb28fa8a2..a0e9be359 100644 --- a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/message/WxCpGroupRobotMessage.java +++ b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/message/WxCpGroupRobotMessage.java @@ -16,8 +16,7 @@ import static me.chanjar.weixin.cp.constant.WxCpConsts.GroupRobotMsgType.*; /** * 微信群机器人消息 * - * @author yr - * created on 2020-08-20 + * @author yr created on 2020-08-20 */ @AllArgsConstructor @NoArgsConstructor @@ -62,6 +61,11 @@ public class WxCpGroupRobotMessage implements Serializable { */ private String mediaId; + /** + * To json string. + * + * @return the string + */ public String toJson() { JsonObject messageJson = new JsonObject(); messageJson.addProperty("msgtype", this.getMsgType()); diff --git a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/message/WxCpLinkedCorpMessage.java b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/message/WxCpLinkedCorpMessage.java index 19461070c..92209fd4e 100644 --- a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/message/WxCpLinkedCorpMessage.java +++ b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/message/WxCpLinkedCorpMessage.java @@ -23,8 +23,7 @@ import static me.chanjar.weixin.cp.constant.WxCpConsts.LinkedCorpMsgType.*; * 互联企业消息. * https://developer.work.weixin.qq.com/document/path/90250 * - * @author Binary Wang - * created on 2020-08-30 + * @author Binary Wang created on 2020-08-30 */ @Data @Builder @@ -44,7 +43,8 @@ public class WxCpLinkedCorpMessage implements Serializable { */ private String[] toUsers; /** - * 部门ID列表，最多支持100个。partyid在互联圈子内唯一。每个元素都是字符串类型，格式为：linked_id/party_id，其中linked_id是互联id，party_id是在互联圈子中的部门id。如果是本企业的部门，则直接传party_id即可。 + * 部门ID列表，最多支持100个。partyid在互联圈子内唯一。每个元素都是字符串类型，格式为：linked_id/party_id，其中linked_id是互联id，party_id是在互联圈子中的部门id + * 。如果是本企业的部门，则直接传party_id即可。 */ private String[] toParties; /** @@ -100,6 +100,11 @@ public class WxCpLinkedCorpMessage implements Serializable { this.msgType = msgType; } + /** + * To json string. + * + * @return the string + */ public String toJson() { JsonObject messageJson = new JsonObject(); diff --git a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/message/WxCpLinkedCorpMessageSendResult.java b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/message/WxCpLinkedCorpMessageSendResult.java index 5008db115..9d264664e 100644 --- a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/message/WxCpLinkedCorpMessageSendResult.java +++ b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/message/WxCpLinkedCorpMessageSendResult.java @@ -9,8 +9,7 @@ import me.chanjar.weixin.cp.util.json.WxCpGsonBuilder; /** * 互联企业的消息推送接口返回实体 * - * @author pg - * created on 2021年6月22日 + * @author pg created on 2021年6月22日 */ @Setter @Getter @@ -31,6 +30,12 @@ public class WxCpLinkedCorpMessageSendResult extends WxCpBaseResp { return WxCpGsonBuilder.create().toJson(this); } + /** + * From json wx cp linked corp message send result. + * + * @param json the json + * @return the wx cp linked corp message send result + */ public static WxCpLinkedCorpMessageSendResult fromJson(String json) { return WxCpGsonBuilder.create().fromJson(json, WxCpLinkedCorpMessageSendResult.class); } diff --git a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/message/WxCpMessage.java b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/message/WxCpMessage.java index 1ce367d9f..c52d564c8 100644 --- a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/message/WxCpMessage.java +++ b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/message/WxCpMessage.java @@ -219,6 +219,8 @@ public class WxCpMessage implements Serializable { /** * 获得文本消息builder. + * + * @return the text builder */ public static TextBuilder TEXT() { return new TextBuilder(); @@ -226,6 +228,8 @@ public class WxCpMessage implements Serializable { /** * 获得文本卡片消息builder. + * + * @return the text card builder */ public static TextCardBuilder TEXTCARD() { return new TextCardBuilder(); @@ -233,6 +237,8 @@ public class WxCpMessage implements Serializable { /** * 获得图片消息builder. + * + * @return the image builder */ public static ImageBuilder IMAGE() { return new ImageBuilder(); @@ -240,6 +246,8 @@ public class WxCpMessage implements Serializable { /** * 获得语音消息builder. + * + * @return the voice builder */ public static VoiceBuilder VOICE() { return new VoiceBuilder(); @@ -247,6 +255,8 @@ public class WxCpMessage implements Serializable { /** * 获得视频消息builder. + * + * @return the video builder */ public static VideoBuilder VIDEO() { return new VideoBuilder(); @@ -254,6 +264,8 @@ public class WxCpMessage implements Serializable { /** * 获得图文消息builder. + * + * @return the news builder */ public static NewsBuilder NEWS() { return new NewsBuilder(); @@ -261,6 +273,8 @@ public class WxCpMessage implements Serializable { /** * 获得mpnews图文消息builder. + * + * @return the mpnews builder */ public static MpnewsBuilder MPNEWS() { return new MpnewsBuilder(); @@ -268,6 +282,8 @@ public class WxCpMessage implements Serializable { /** * 获得markdown消息builder. + * + * @return the markdown msg builder */ public static MarkdownMsgBuilder MARKDOWN() { return new MarkdownMsgBuilder(); @@ -275,6 +291,8 @@ public class WxCpMessage implements Serializable { /** * 获得文件消息builder. + * + * @return the file builder */ public static FileBuilder FILE() { return new FileBuilder(); @@ -282,6 +300,8 @@ public class WxCpMessage implements Serializable { /** * 获得任务卡片消息builder. + * + * @return the task card builder */ public static TaskCardBuilder TASKCARD() { return new TaskCardBuilder(); @@ -289,6 +309,8 @@ public class WxCpMessage implements Serializable { /** * 获得任务卡片消息builder. + * + * @return the template card builder */ public static TemplateCardBuilder TEMPLATECARD() { return new TemplateCardBuilder(); @@ -296,6 +318,8 @@ public class WxCpMessage implements Serializable { /** * 获得小程序通知消息builder. + * + * @return the mini program notice msg builder */ public static MiniProgramNoticeMsgBuilder newMiniProgramNoticeBuilder() { return new MiniProgramNoticeMsgBuilder(); @@ -323,6 +347,11 @@ public class WxCpMessage implements Serializable { this.msgType = msgType; } + /** + * To json string. + * + * @return the string + */ public String toJson() { JsonObject messageJson = new JsonObject(); if (this.getAgentId() != null) { diff --git a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/message/WxCpMessageSendResult.java b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/message/WxCpMessageSendResult.java index fdb72c7a7..2ddf95d8d 100644 --- a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/message/WxCpMessageSendResult.java +++ b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/message/WxCpMessageSendResult.java @@ -25,6 +25,12 @@ public class WxCpMessageSendResult implements Serializable { return WxCpGsonBuilder.create().toJson(this); } + /** + * From json wx cp message send result. + * + * @param json the json + * @return the wx cp message send result + */ public static WxCpMessageSendResult fromJson(String json) { return WxCpGsonBuilder.create().fromJson(json, WxCpMessageSendResult.class); } @@ -53,6 +59,11 @@ public class WxCpMessageSendResult implements Serializable { @SerializedName("response_code") private String responseCode; + /** + * Gets invalid user list. + * + * @return the invalid user list + */ public List getInvalidUserList() { return this.content2List(this.invalidUser); } @@ -65,10 +76,20 @@ public class WxCpMessageSendResult implements Serializable { return Splitter.on("|").splitToList(content); } + /** + * Gets invalid party list. + * + * @return the invalid party list + */ public List getInvalidPartyList() { return this.content2List(this.invalidParty); } + /** + * Gets invalid tag list. + * + * @return the invalid tag list + */ public List getInvalidTagList() { return this.content2List(this.invalidTag); } diff --git a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/message/WxCpMessageSendStatistics.java b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/message/WxCpMessageSendStatistics.java index df83a2320..5b223a2a8 100644 --- a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/message/WxCpMessageSendStatistics.java +++ b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/message/WxCpMessageSendStatistics.java @@ -10,19 +10,27 @@ import java.util.List; /** * 应用消息发送统计信息. * - * @author Binary Wang - * created on 2020-09-13 + * @author Binary Wang created on 2020-09-13 */ @Data public class WxCpMessageSendStatistics implements Serializable { private static final long serialVersionUID = 6031833682211475786L; + /** + * From json wx cp message send statistics. + * + * @param json the json + * @return the wx cp message send statistics + */ public static WxCpMessageSendStatistics fromJson(String json) { return WxCpGsonBuilder.create().fromJson(json, WxCpMessageSendStatistics.class); } private List statistics; + /** + * The type Statistic item. + */ @Data public static class StatisticItem implements Serializable { private static final long serialVersionUID = 6031833682211475786L; diff --git a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/message/WxCpSchoolContactMessage.java b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/message/WxCpSchoolContactMessage.java index 7990a246f..a13205cd6 100644 --- a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/message/WxCpSchoolContactMessage.java +++ b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/message/WxCpSchoolContactMessage.java @@ -24,8 +24,7 @@ import static me.chanjar.weixin.common.api.WxConsts.SchoolContactMsgType.*; * 发送「学校通知」 * https://developer.work.weixin.qq.com/document/path/92321 * - * @author Wang_Wong - * created on 2022-06-29 + * @author Wang_Wong created on 2022-06-29 */ @Data @Builder @@ -148,7 +147,8 @@ public class WxCpSchoolContactMessage implements Serializable { /** * 图文消息（mpnews） - * https://developer.work.weixin.qq.com/document/path/92321#%E5%9B%BE%E6%96%87%E6%B6%88%E6%81%AF%EF%BC%88mpnews%EF%BC%89 + * https://developer.work.weixin.qq.com/document/path/92321#%E5%9B%BE%E6%96%87%E6%B6%88%E6%81%AF%EF%BC%88mpnews%EF + * %BC%89 *

* mpnews类型的图文消息，跟普通的图文消息一致，唯一的差异是图文内容存储在企业微信。 * 多次发送mpnews，会被认为是不同的图文，阅读、点赞的统计会被分开计算。 @@ -173,6 +173,11 @@ public class WxCpSchoolContactMessage implements Serializable { this.msgType = msgType; } + /** + * To json string. + * + * @return the string + */ public String toJson() { JsonObject messageJson = new JsonObject(); diff --git a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/message/WxCpSchoolContactMessageSendResult.java b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/message/WxCpSchoolContactMessageSendResult.java index 584de8a40..a66f9baf7 100644 --- a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/message/WxCpSchoolContactMessageSendResult.java +++ b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/message/WxCpSchoolContactMessageSendResult.java @@ -9,8 +9,7 @@ import me.chanjar.weixin.cp.util.json.WxCpGsonBuilder; * 发送「学校通知」返回实体 * https://developer.work.weixin.qq.com/document/path/92321 * - * @author Wang_Wong - * created on 2022-06-29 + * @author Wang_Wong created on 2022-06-29 */ @Data public class WxCpSchoolContactMessageSendResult extends WxCpBaseResp { @@ -29,6 +28,12 @@ public class WxCpSchoolContactMessageSendResult extends WxCpBaseResp { return WxCpGsonBuilder.create().toJson(this); } + /** + * From json wx cp school contact message send result. + * + * @param json the json + * @return the wx cp school contact message send result + */ public static WxCpSchoolContactMessageSendResult fromJson(String json) { return WxCpGsonBuilder.create().fromJson(json, WxCpSchoolContactMessageSendResult.class); } diff --git a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/message/WxCpTpXmlMessage.java b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/message/WxCpTpXmlMessage.java index c2aef9e13..a3b68c234 100644 --- a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/message/WxCpTpXmlMessage.java +++ b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/message/WxCpTpXmlMessage.java @@ -33,218 +33,386 @@ public class WxCpTpXmlMessage implements Serializable { */ private Map allFieldsMap; + /** + * The Suite id. + */ @XStreamAlias("SuiteId") @XStreamConverter(value = XStreamCDataConverter.class) protected String suiteId; + /** + * The Info type. + */ @XStreamAlias("InfoType") @XStreamConverter(value = XStreamCDataConverter.class) protected String infoType; + /** + * The Time stamp. + */ @XStreamAlias("TimeStamp") @XStreamConverter(value = XStreamCDataConverter.class) protected String timeStamp; + /** + * The Suite ticket. + */ @XStreamAlias("SuiteTicket") @XStreamConverter(value = XStreamCDataConverter.class) protected String suiteTicket; + /** + * The Auth code. + */ @XStreamAlias("AuthCode") @XStreamConverter(value = XStreamCDataConverter.class) protected String authCode; + /** + * The Auth corp id. + */ @XStreamAlias("AuthCorpId") @XStreamConverter(value = XStreamCDataConverter.class) protected String authCorpId; + /** + * The Change type. + */ @XStreamAlias("ChangeType") @XStreamConverter(value = XStreamCDataConverter.class) protected String changeType; + /** + * The User id. + */ @XStreamAlias("UserID") @XStreamConverter(value = XStreamCDataConverter.class) protected String userID; + /** + * The Department. + */ @XStreamAlias("Department") @XStreamConverter(value = IntegerArrayConverter.class) protected Integer[] department; + /** + * The Main department. + */ @XStreamAlias("MainDepartment") @XStreamConverter(value = IntConverter.class) protected Integer mainDepartment; + /** + * The Is leader in dept. + */ @XStreamAlias("IsLeaderInDept") @XStreamConverter(value = IntegerArrayConverter.class) protected Integer[] isLeaderInDept; + /** + * The Mobile. + */ @XStreamAlias("Mobile") @XStreamConverter(value = XStreamCDataConverter.class) protected String mobile; + /** + * The Position. + */ @XStreamAlias("Position") @XStreamConverter(value = XStreamCDataConverter.class) protected String position; + /** + * The Gender. + */ @XStreamAlias("Gender") @XStreamConverter(value = IntConverter.class) protected Integer gender; + /** + * The Email. + */ @XStreamAlias("Email") @XStreamConverter(value = XStreamCDataConverter.class) protected String email; + /** + * The Status. + */ @XStreamAlias("Status") @XStreamConverter(value = XStreamCDataConverter.class) protected String status; + /** + * The Avatar. + */ @XStreamAlias("Avatar") @XStreamConverter(value = XStreamCDataConverter.class) protected String avatar; + /** + * The Alias. + */ @XStreamAlias("Alias") @XStreamConverter(value = XStreamCDataConverter.class) protected String alias; + /** + * The Telephone. + */ @XStreamAlias("Telephone") @XStreamConverter(value = XStreamCDataConverter.class) protected String telephone; + /** + * The Id. + */ @XStreamAlias("Id") @XStreamConverter(value = XStreamCDataConverter.class) protected String id; + /** + * The Name. + */ @XStreamAlias("Name") @XStreamConverter(value = XStreamCDataConverter.class) protected String name; + /** + * The Parent id. + */ @XStreamAlias("ParentId") @XStreamConverter(value = XStreamCDataConverter.class) protected String parentId; + /** + * The Order. + */ @XStreamAlias("Order") @XStreamConverter(value = IntConverter.class) protected Integer order; + /** + * The Tag id. + */ @XStreamAlias("TagId") @XStreamConverter(value = IntConverter.class) protected Integer tagId; + /** + * The Add user items. + */ @XStreamAlias("AddUserItems") @XStreamConverter(value = StringArrayConverter.class) protected String[] addUserItems; + /** + * The Del user items. + */ @XStreamAlias("DelUserItems") @XStreamConverter(value = StringArrayConverter.class) protected String[] delUserItems; + /** + * The Add party items. + */ @XStreamAlias("AddPartyItems") @XStreamConverter(value = IntegerArrayConverter.class) protected Integer[] addPartyItems; + /** + * The Del party items. + */ @XStreamAlias("DelPartyItems") @XStreamConverter(value = IntegerArrayConverter.class) protected Integer[] delPartyItems; - //ref: https://work.weixin.qq.com/api/doc/90001/90143/90585 + /** + * The Service corp id. + */ +//ref: https://work.weixin.qq.com/api/doc/90001/90143/90585 @XStreamAlias("ServiceCorpId") @XStreamConverter(value = XStreamCDataConverter.class) protected String serviceCorpId; + /** + * The Register code. + */ @XStreamAlias("RegisterCode") @XStreamConverter(value = XStreamCDataConverter.class) protected String registerCode; + /** + * The Contact sync. + */ @XStreamAlias("ContactSync") protected ContactSync contactSync; + /** + * The Auth user info. + */ @XStreamAlias("AuthUserInfo") protected AuthUserInfo authUserInfo; + /** + * The Template id. + */ @XStreamAlias("TemplateId") @XStreamConverter(value = XStreamCDataConverter.class) protected String templateId; + /** + * The Create time. + */ @XStreamAlias("CreateTime") protected Long createTime; + /** + * The To user name. + */ @XStreamAlias("ToUserName") @XStreamConverter(value = XStreamCDataConverter.class) protected String toUserName; + /** + * The From user name. + */ @XStreamAlias("FromUserName") @XStreamConverter(value = XStreamCDataConverter.class) protected String fromUserName; + /** + * The Msg type. + */ @XStreamAlias("MsgType") @XStreamConverter(value = XStreamCDataConverter.class) protected String msgType; + /** + * The Event. + */ @XStreamAlias("Event") @XStreamConverter(value = XStreamCDataConverter.class) protected String event; + /** + * The Batch job. + */ @XStreamAlias("BatchJob") protected BatchJob batchJob; + /** + * The External user id. + */ @XStreamAlias("ExternalUserID") @XStreamConverter(value = XStreamCDataConverter.class) protected String externalUserID; + /** + * The State. + */ @XStreamAlias("State") @XStreamConverter(value = XStreamCDataConverter.class) protected String state; + /** + * The Source. + */ @XStreamAlias("Source") @XStreamConverter(value = XStreamCDataConverter.class) protected String source; + /** + * The Fail reason. + */ @XStreamAlias("FailReason") @XStreamConverter(value = XStreamCDataConverter.class) protected String failReason; + /** + * The Chat id. + */ @XStreamAlias("ChatId") @XStreamConverter(value = XStreamCDataConverter.class) protected String chatId; + /** + * The Update detail. + */ @XStreamAlias("UpdateDetail") @XStreamConverter(value = XStreamCDataConverter.class) protected String updateDetail; + /** + * The Join scene. + */ @XStreamAlias("JoinScene") protected Integer joinScene; + /** + * The Quit scene. + */ @XStreamAlias("QuitScene") protected Integer quitScene; + /** + * The Mem change cnt. + */ @XStreamAlias("MemChangeCnt") protected Integer memChangeCnt; + /** + * The Tag type. + */ @XStreamAlias("TagType") @XStreamConverter(value = XStreamCDataConverter.class) protected String tagType; + /** + * The Welcome code. + */ @XStreamAlias("WelcomeCode") @XStreamConverter(value = XStreamCDataConverter.class) protected String welcomeCode; + /** + * The From user. + */ @XStreamAlias("FromUser") @XStreamConverter(value = XStreamCDataConverter.class) protected String fromUser; + /** + * The Content. + */ @XStreamAlias("Content") @XStreamConverter(value = XStreamCDataConverter.class) protected String content; + /** + * The Msg id. + */ @XStreamAlias("MsgId") protected String msgId; + /** + * The Agent id. + */ @XStreamAlias("AgentID") protected String agentID; + /** + * The Pic url. + */ @XStreamAlias("PicUrl") @XStreamConverter(value = XStreamCDataConverter.class) protected String picUrl; + /** + * The Media id. + */ @XStreamAlias("MediaId") @XStreamConverter(value = XStreamCDataConverter.class) protected String mediaId; @@ -334,92 +502,164 @@ public class WxCpTpXmlMessage implements Serializable { @XStreamAlias("NewOrderId") @XStreamConverter(value = XStreamCDataConverter.class) private String newOrderId; - + + /** + * The type Contact sync. + */ @Data @XStreamAlias("ContactSync") public static class ContactSync implements Serializable { private static final long serialVersionUID = 6031833682211475786L; + /** + * The Access token. + */ @XStreamAlias("AccessToken") @XStreamConverter(value = XStreamCDataConverter.class) protected String accessToken; + /** + * The Expires in. + */ @XStreamAlias("ExpiresIn") protected Integer expiresIn; } + /** + * The type Auth user info. + */ @Data @XStreamAlias("AuthUserInfo") public static class AuthUserInfo implements Serializable { + /** + * The User id. + */ @XStreamAlias("UserId") @XStreamConverter(value = XStreamCDataConverter.class) protected String userId; } + /** + * The type Batch job. + */ @Data @XStreamAlias("BatchJob") public static class BatchJob implements Serializable { private static final long serialVersionUID = 6031833682211475786L; + /** + * The Job id. + */ @XStreamAlias("JobId") @XStreamConverter(value = XStreamCDataConverter.class) protected String JobId; + /** + * The Job type. + */ @XStreamAlias("JobType") @XStreamConverter(value = XStreamCDataConverter.class) protected String jobType; + /** + * The Err code. + */ @XStreamAlias("ErrCode") @XStreamConverter(value = IntConverter.class) protected Integer errCode; + /** + * The Err msg. + */ @XStreamAlias("ErrMsg") @XStreamConverter(value = XStreamCDataConverter.class) protected String errMsg; } + /** + * The type Approval info. + */ @Data @XStreamAlias("ApprovalInfo") public static class ApprovalInfo implements Serializable { private static final long serialVersionUID = 6031833682211475786L; + /** + * The Third no. + */ @XStreamAlias("ThirdNo") protected String thirdNo; + /** + * The Open sp name. + */ @XStreamAlias("OpenSpName") protected String openSpName; + /** + * The Open template id. + */ @XStreamAlias("OpenTemplateId") protected String openTemplateId; + /** + * The Open sp status. + */ @XStreamAlias("OpenSpStatus") protected Integer openSpStatus; + /** + * The Apply time. + */ @XStreamAlias("ApplyTime") protected Long applyTime; + /** + * The Apply user name. + */ @XStreamAlias("ApplyUserName") protected String applyUserName; + /** + * The Apply user id. + */ @XStreamAlias("ApplyUserId") protected String applyUserId; + /** + * The Apply user party. + */ @XStreamAlias("ApplyUserParty") protected String applyUserParty; + /** + * The Apply user image. + */ @XStreamAlias("ApplyUserImage") protected String applyUserImage; + /** + * The Approval nodes. + */ @XStreamAlias("ApprovalNodes") protected List approvalNodes; + /** + * The Notify nodes. + */ @XStreamAlias("NotifyNodes") protected List notifyNodes; + /** + * The Approverstep. + */ @XStreamAlias("approverstep") protected Integer approverstep; - //自建/第三方应用调用审批流程引擎，状态通知 + /** + * The type Approval node. + */ +//自建/第三方应用调用审批流程引擎，状态通知 //ref: https://work.weixin.qq.com/api/doc/90001/90143/90376#审批状态通知事件 //1.自建/第三方应用调用审批流程引擎发起申请之后，审批状态发生变化时 //2.自建/第三方应用调用审批流程引擎发起申请之后，在“审批中”状态，有任意审批人进行审批操作时 @@ -428,53 +668,104 @@ public class WxCpTpXmlMessage implements Serializable { public static class ApprovalNode implements Serializable { private static final long serialVersionUID = 6031833682211475786L; + /** + * The Node status. + */ @XStreamAlias("NodeStatus") protected Integer nodeStatus; + /** + * The Node attr. + */ @XStreamAlias("NodeAttr") protected Integer nodeAttr; + /** + * The Node type. + */ @XStreamAlias("NodeType") protected Integer nodeType; + /** + * The Items. + */ @XStreamAlias("Items") protected List items; + /** + * The type Item. + */ @Data @XStreamAlias("Item") public static class Item implements Serializable { private static final long serialVersionUID = 6031833682211475786L; + /** + * The Item name. + */ @XStreamAlias("ItemName") protected String itemName; + /** + * The Item user id. + */ @XStreamAlias("ItemUserId") protected String itemUserId; + /** + * The Item image. + */ @XStreamAlias("ItemImage") protected String itemImage; + /** + * The Item status. + */ @XStreamAlias("ItemStatus") protected Integer itemStatus; + /** + * The Item speech. + */ @XStreamAlias("ItemSpeech") protected String itemSpeech; + /** + * The Item op time. + */ @XStreamAlias("ItemOpTime") protected Long itemOpTime; } } + /** + * The type Notify node. + */ @Data @XStreamAlias("NotifyNode") public static class NotifyNode implements Serializable { private static final long serialVersionUID = 6031833682211475786L; + /** + * The Item name. + */ @XStreamAlias("ItemName") protected String itemName; + /** + * The Item user id. + */ @XStreamAlias("ItemUserId") protected String itemUserId; + /** + * The Item image. + */ @XStreamAlias("ItemImage") protected String itemImage; } } + /** + * From xml wx cp tp xml message. + * + * @param xml the xml + * @return the wx cp tp xml message + */ public static WxCpTpXmlMessage fromXml(String xml) { //修改微信变态的消息内容格式，方便解析 //xml = xml.replace("", ""); diff --git a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/message/WxCpXmlApprovalInfo.java b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/message/WxCpXmlApprovalInfo.java index 33d1375b1..bcb24f8fe 100644 --- a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/message/WxCpXmlApprovalInfo.java +++ b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/message/WxCpXmlApprovalInfo.java @@ -11,10 +11,10 @@ import java.util.List; /** * 审批信息 - * + *

* 审批申请状态变化回调通知 * https://developer.work.weixin.qq.com/document/path/91815 - * + *

* 自建应用审批状态变化通知回调 * https://developer.work.weixin.qq.com/document/path/90269 * @@ -447,7 +447,7 @@ public class WxCpXmlApprovalInfo implements Serializable { /** * 备注意见附件，值是附件media_id */ - @XStreamImplicit(itemFieldName="Attach") + @XStreamImplicit(itemFieldName = "Attach") private List attach; } diff --git a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/message/WxCpXmlMessage.java b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/message/WxCpXmlMessage.java index 6a81a7b50..51e395ab1 100644 --- a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/message/WxCpXmlMessage.java +++ b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/message/WxCpXmlMessage.java @@ -287,6 +287,7 @@ public class WxCpXmlMessage implements Serializable { /** * 企业邮箱;代开发自建应用不返回该字段。 * ISSUE#2584 + * * @see Link */ @XStreamAlias("BizMail") @@ -485,10 +486,10 @@ public class WxCpXmlMessage implements Serializable { /** * 审批消息 - * + *

* 审批申请状态变化回调通知 * https://developer.work.weixin.qq.com/document/path/91815 - * + *

* 自建应用审批状态变化通知回调 * https://developer.work.weixin.qq.com/document/path/90269 */ @@ -496,6 +497,12 @@ public class WxCpXmlMessage implements Serializable { private WxCpXmlApprovalInfo approvalInfo = new WxCpXmlApprovalInfo(); + /** + * From xml wx cp xml message. + * + * @param xml the xml + * @return the wx cp xml message + */ protected static WxCpXmlMessage fromXml(String xml) { //修改微信变态的消息内容格式，方便解析 xml = xml.replace("", ""); @@ -504,6 +511,13 @@ public class WxCpXmlMessage implements Serializable { return xmlMessage; } + /** + * From xml wx cp xml message. + * + * @param xml the xml + * @param agentId the agent id + * @return the wx cp xml message + */ public static WxCpXmlMessage fromXml(String xml, String agentId) { //修改微信变态的消息内容格式，方便解析 xml = xml.replace("", ""); @@ -512,12 +526,25 @@ public class WxCpXmlMessage implements Serializable { return xmlMessage; } + /** + * From xml wx cp xml message. + * + * @param is the is + * @return the wx cp xml message + */ protected static WxCpXmlMessage fromXml(InputStream is) { return XStreamTransformer.fromXml(WxCpXmlMessage.class, is); } /** * 从加密字符串转换. + * + * @param encryptedXml the encrypted xml + * @param wxCpConfigStorage the wx cp config storage + * @param timestamp the timestamp + * @param nonce the nonce + * @param msgSignature the msg signature + * @return the wx cp xml message */ public static WxCpXmlMessage fromEncryptedXml(String encryptedXml, WxCpConfigStorage wxCpConfigStorage, String timestamp, String nonce, String msgSignature) { @@ -533,10 +560,21 @@ public class WxCpXmlMessage implements Serializable { } + /** + * From encrypted xml wx cp xml message. + * + * @param is the is + * @param wxCpConfigStorage the wx cp config storage + * @param timestamp the timestamp + * @param nonce the nonce + * @param msgSignature the msg signature + * @return the wx cp xml message + */ public static WxCpXmlMessage fromEncryptedXml(InputStream is, WxCpConfigStorage wxCpConfigStorage, String timestamp, String nonce, String msgSignature) { try { - return fromEncryptedXml(IOUtils.toString(is, StandardCharsets.UTF_8), wxCpConfigStorage, timestamp, nonce, msgSignature); + return fromEncryptedXml(IOUtils.toString(is, StandardCharsets.UTF_8), wxCpConfigStorage, timestamp, nonce, + msgSignature); } catch (IOException e) { throw new WxRuntimeException(e); } @@ -547,6 +585,9 @@ public class WxCpXmlMessage implements Serializable { return WxCpGsonBuilder.create().toJson(this); } + /** + * The type Scan code info. + */ @Data @XStreamAlias("ScanCodeInfo") public static class ScanCodeInfo implements Serializable { @@ -567,13 +608,22 @@ public class WxCpXmlMessage implements Serializable { private String scanResult; } + /** + * The type Ext attr. + */ @Data public static class ExtAttr implements Serializable { private static final long serialVersionUID = -3418685294606228837L; + /** + * The Items. + */ @XStreamImplicit(itemFieldName = "Item") protected final List items = new ArrayList<>(); + /** + * The type Item. + */ @XStreamAlias("Item") @Data public static class Item implements Serializable { @@ -589,17 +639,26 @@ public class WxCpXmlMessage implements Serializable { } } + /** + * The type Send pics info. + */ @Data @XStreamAlias("SendPicsInfo") public static class SendPicsInfo implements Serializable { private static final long serialVersionUID = -6549728838848064881L; + /** + * The Pic list. + */ @XStreamAlias("PicList") protected final List picList = new ArrayList<>(); @XStreamAlias("Count") private Long count; + /** + * The type Item. + */ @XStreamAlias("item") @Data public static class Item implements Serializable { @@ -611,6 +670,9 @@ public class WxCpXmlMessage implements Serializable { } } + /** + * The type Send location info. + */ @Data @XStreamAlias("SendLocationInfo") public static class SendLocationInfo implements Serializable { diff --git a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/message/WxCpXmlOutEventMessage.java b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/message/WxCpXmlOutEventMessage.java index 2dccf0b45..9a8352244 100644 --- a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/message/WxCpXmlOutEventMessage.java +++ b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/message/WxCpXmlOutEventMessage.java @@ -8,9 +8,10 @@ import me.chanjar.weixin.common.api.WxConsts; import me.chanjar.weixin.common.util.xml.XStreamCDataConverter; /** + * The type Wx cp xml out event message. + * * @author eYoung - * @description: - * created on create at 2021/12/3 16:36 + * @description: created on create at 2021/12/3 16:36 */ @XStreamAlias("xml") @Data @@ -77,6 +78,9 @@ public class WxCpXmlOutEventMessage extends WxCpXmlOutMessage { @XStreamConverter(value = XStreamCDataConverter.class) private String id; + /** + * Instantiates a new Wx cp xml out event message. + */ public WxCpXmlOutEventMessage() { this.msgType = WxConsts.XmlMsgType.EVENT; } diff --git a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/message/WxCpXmlOutImageMessage.java b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/message/WxCpXmlOutImageMessage.java index 99792a2bf..c3f453200 100644 --- a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/message/WxCpXmlOutImageMessage.java +++ b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/message/WxCpXmlOutImageMessage.java @@ -7,6 +7,9 @@ import lombok.EqualsAndHashCode; import me.chanjar.weixin.common.api.WxConsts; import me.chanjar.weixin.common.util.xml.XStreamMediaIdConverter; +/** + * The type Wx cp xml out image message. + */ @XStreamAlias("xml") @Data @EqualsAndHashCode(callSuper = false) @@ -17,6 +20,9 @@ public class WxCpXmlOutImageMessage extends WxCpXmlOutMessage { @XStreamConverter(value = XStreamMediaIdConverter.class) private String mediaId; + /** + * Instantiates a new Wx cp xml out image message. + */ public WxCpXmlOutImageMessage() { this.msgType = WxConsts.XmlMsgType.IMAGE; } diff --git a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/message/WxCpXmlOutMessage.java b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/message/WxCpXmlOutMessage.java index 89c29e25c..b8b5a67b8 100644 --- a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/message/WxCpXmlOutMessage.java +++ b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/message/WxCpXmlOutMessage.java @@ -22,23 +22,37 @@ import java.io.Serializable; public abstract class WxCpXmlOutMessage implements Serializable { private static final long serialVersionUID = 1418629839964153110L; + /** + * The To user name. + */ @XStreamAlias("ToUserName") @XStreamConverter(value = XStreamCDataConverter.class) protected String toUserName; + /** + * The From user name. + */ @XStreamAlias("FromUserName") @XStreamConverter(value = XStreamCDataConverter.class) protected String fromUserName; + /** + * The Create time. + */ @XStreamAlias("CreateTime") protected Long createTime; + /** + * The Msg type. + */ @XStreamAlias("MsgType") @XStreamConverter(value = XStreamCDataConverter.class) protected String msgType; /** * 获得文本消息builder. + * + * @return the text builder */ public static TextBuilder TEXT() { return new TextBuilder(); @@ -46,6 +60,8 @@ public abstract class WxCpXmlOutMessage implements Serializable { /** * 获得图片消息builder. + * + * @return the image builder */ public static ImageBuilder IMAGE() { return new ImageBuilder(); @@ -53,6 +69,8 @@ public abstract class WxCpXmlOutMessage implements Serializable { /** * 获得语音消息builder. + * + * @return the voice builder */ public static VoiceBuilder VOICE() { return new VoiceBuilder(); @@ -60,6 +78,8 @@ public abstract class WxCpXmlOutMessage implements Serializable { /** * 获得视频消息builder. + * + * @return the video builder */ public static VideoBuilder VIDEO() { return new VideoBuilder(); @@ -67,6 +87,8 @@ public abstract class WxCpXmlOutMessage implements Serializable { /** * 获得图文消息builder. + * + * @return the news builder */ public static NewsBuilder NEWS() { return new NewsBuilder(); @@ -74,6 +96,8 @@ public abstract class WxCpXmlOutMessage implements Serializable { /** * 获得任务卡片消息builder. + * + * @return the task card builder */ public static TaskCardBuilder TASK_CARD() { return new TaskCardBuilder(); @@ -81,6 +105,8 @@ public abstract class WxCpXmlOutMessage implements Serializable { /** * 获得任务卡片消息builder. + * + * @return the update button builder */ public static UpdateButtonBuilder UPDATE_BUTTON() { return new UpdateButtonBuilder(); @@ -88,17 +114,27 @@ public abstract class WxCpXmlOutMessage implements Serializable { /** * 获得事件消息builder. + * + * @return the event builder */ public static EventBuilder EVENT() { return new EventBuilder(); } + /** + * To xml string. + * + * @return the string + */ protected String toXml() { return XStreamTransformer.toXml((Class) this.getClass(), this); } /** * 转换成加密的xml格式. + * + * @param wxCpConfigStorage the wx cp config storage + * @return the string */ public String toEncryptedXml(WxCpConfigStorage wxCpConfigStorage) { String plainXml = toXml(); diff --git a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/message/WxCpXmlOutNewsMessage.java b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/message/WxCpXmlOutNewsMessage.java index 7b13ccfca..f77e5d6d5 100644 --- a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/message/WxCpXmlOutNewsMessage.java +++ b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/message/WxCpXmlOutNewsMessage.java @@ -11,28 +11,48 @@ import java.io.Serializable; import java.util.ArrayList; import java.util.List; +/** + * The type Wx cp xml out news message. + */ @XStreamAlias("xml") @Data @EqualsAndHashCode(callSuper = true) public class WxCpXmlOutNewsMessage extends WxCpXmlOutMessage { private static final long serialVersionUID = -5796178637883178826L; + /** + * The Articles. + */ @XStreamAlias("Articles") protected final List articles = new ArrayList<>(); + /** + * The Article count. + */ @XStreamAlias("ArticleCount") protected int articleCount; + /** + * Instantiates a new Wx cp xml out news message. + */ public WxCpXmlOutNewsMessage() { this.msgType = WxConsts.XmlMsgType.NEWS; } + /** + * Add article. + * + * @param item the item + */ public void addArticle(Item item) { this.articles.add(item); this.articleCount = this.articles.size(); } + /** + * The type Item. + */ @XStreamAlias("item") @Data public static class Item implements Serializable { diff --git a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/message/WxCpXmlOutTaskCardMessage.java b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/message/WxCpXmlOutTaskCardMessage.java index 63816f7e4..d5042780f 100644 --- a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/message/WxCpXmlOutTaskCardMessage.java +++ b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/message/WxCpXmlOutTaskCardMessage.java @@ -7,6 +7,9 @@ import lombok.EqualsAndHashCode; import me.chanjar.weixin.common.api.WxConsts; import me.chanjar.weixin.common.util.xml.XStreamReplaceNameConverter; +/** + * The type Wx cp xml out task card message. + */ @XStreamAlias("xml") @Data @EqualsAndHashCode(callSuper = false) @@ -17,6 +20,9 @@ public class WxCpXmlOutTaskCardMessage extends WxCpXmlOutMessage { @XStreamConverter(value = XStreamReplaceNameConverter.class) private String replaceName; + /** + * Instantiates a new Wx cp xml out task card message. + */ public WxCpXmlOutTaskCardMessage() { this.msgType = WxConsts.XmlMsgType.UPDATE_TASKCARD; } diff --git a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/message/WxCpXmlOutTextMessage.java b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/message/WxCpXmlOutTextMessage.java index dfae8fef4..0adda399f 100644 --- a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/message/WxCpXmlOutTextMessage.java +++ b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/message/WxCpXmlOutTextMessage.java @@ -7,6 +7,9 @@ import lombok.EqualsAndHashCode; import me.chanjar.weixin.common.api.WxConsts; import me.chanjar.weixin.common.util.xml.XStreamCDataConverter; +/** + * The type Wx cp xml out text message. + */ @XStreamAlias("xml") @Data @EqualsAndHashCode(callSuper = false) @@ -17,6 +20,9 @@ public class WxCpXmlOutTextMessage extends WxCpXmlOutMessage { @XStreamConverter(value = XStreamCDataConverter.class) private String content; + /** + * Instantiates a new Wx cp xml out text message. + */ public WxCpXmlOutTextMessage() { this.msgType = WxConsts.XmlMsgType.TEXT; } diff --git a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/message/WxCpXmlOutUpdateBtnMessage.java b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/message/WxCpXmlOutUpdateBtnMessage.java index 3072c8900..6c5ef835d 100644 --- a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/message/WxCpXmlOutUpdateBtnMessage.java +++ b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/message/WxCpXmlOutUpdateBtnMessage.java @@ -8,8 +8,9 @@ import me.chanjar.weixin.common.api.WxConsts; import me.chanjar.weixin.common.util.xml.XStreamReplaceNameConverter; /** - * @author nickname263 - * created on 2021-09-23 + * The type Wx cp xml out update btn message. + * + * @author nickname263 created on 2021-09-23 */ @XStreamAlias("xml") @Data @@ -20,6 +21,9 @@ public class WxCpXmlOutUpdateBtnMessage extends WxCpXmlOutMessage { @XStreamConverter(value = XStreamReplaceNameConverter.class) private String replaceName; + /** + * Instantiates a new Wx cp xml out update btn message. + */ public WxCpXmlOutUpdateBtnMessage() { this.msgType = WxConsts.XmlMsgType.UPDATE_BUTTON; } diff --git a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/message/WxCpXmlOutVideoMessage.java b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/message/WxCpXmlOutVideoMessage.java index add435a87..8c78528a6 100644 --- a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/message/WxCpXmlOutVideoMessage.java +++ b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/message/WxCpXmlOutVideoMessage.java @@ -9,43 +9,85 @@ import me.chanjar.weixin.common.util.xml.XStreamCDataConverter; import java.io.Serializable; +/** + * The type Wx cp xml out video message. + */ @XStreamAlias("xml") @Data @EqualsAndHashCode(callSuper = false) public class WxCpXmlOutVideoMessage extends WxCpXmlOutMessage { private static final long serialVersionUID = -8672761162722733622L; + /** + * The Video. + */ @XStreamAlias("Video") protected final Video video = new Video(); + /** + * Instantiates a new Wx cp xml out video message. + */ public WxCpXmlOutVideoMessage() { this.msgType = WxConsts.XmlMsgType.VIDEO; } + /** + * Gets media id. + * + * @return the media id + */ public String getMediaId() { return this.video.getMediaId(); } + /** + * Sets media id. + * + * @param mediaId the media id + */ public void setMediaId(String mediaId) { this.video.setMediaId(mediaId); } + /** + * Gets title. + * + * @return the title + */ public String getTitle() { return this.video.getTitle(); } + /** + * Sets title. + * + * @param title the title + */ public void setTitle(String title) { this.video.setTitle(title); } + /** + * Gets description. + * + * @return the description + */ public String getDescription() { return this.video.getDescription(); } + /** + * Sets description. + * + * @param description the description + */ public void setDescription(String description) { this.video.setDescription(description); } + /** + * The type Video. + */ @Data @XStreamAlias("Video") public static class Video implements Serializable { diff --git a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/message/WxCpXmlOutVoiceMessage.java b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/message/WxCpXmlOutVoiceMessage.java index 7a2e0e49c..ebfd80ab6 100644 --- a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/message/WxCpXmlOutVoiceMessage.java +++ b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/message/WxCpXmlOutVoiceMessage.java @@ -7,6 +7,9 @@ import lombok.EqualsAndHashCode; import me.chanjar.weixin.common.api.WxConsts; import me.chanjar.weixin.common.util.xml.XStreamMediaIdConverter; +/** + * The type Wx cp xml out voice message. + */ @XStreamAlias("xml") @Data @EqualsAndHashCode(callSuper = false) @@ -17,6 +20,9 @@ public class WxCpXmlOutVoiceMessage extends WxCpXmlOutMessage { @XStreamConverter(value = XStreamMediaIdConverter.class) private String mediaId; + /** + * Instantiates a new Wx cp xml out voice message. + */ public WxCpXmlOutVoiceMessage() { this.msgType = WxConsts.XmlMsgType.VOICE; } diff --git a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/messagebuilder/BaseBuilder.java b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/messagebuilder/BaseBuilder.java index ec312c6fb..fcbc578a5 100644 --- a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/messagebuilder/BaseBuilder.java +++ b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/messagebuilder/BaseBuilder.java @@ -4,39 +4,97 @@ import me.chanjar.weixin.common.api.WxConsts; import me.chanjar.weixin.cp.bean.message.WxCpMessage; import org.apache.commons.lang3.StringUtils; +/** + * The type Base builder. + * + * @param the type parameter + */ public class BaseBuilder { + /** + * The Msg type. + */ protected String msgType; + /** + * The Agent id. + */ protected Integer agentId; + /** + * The To user. + */ protected String toUser; + /** + * The To party. + */ protected String toParty; + /** + * The To tag. + */ protected String toTag; + /** + * The Safe. + */ protected String safe; + /** + * Agent id t. + * + * @param agentId the agent id + * @return the t + */ public T agentId(Integer agentId) { this.agentId = agentId; return (T) this; } + /** + * To user t. + * + * @param toUser the to user + * @return the t + */ public T toUser(String toUser) { this.toUser = toUser; return (T) this; } + /** + * To party t. + * + * @param toParty the to party + * @return the t + */ public T toParty(String toParty) { this.toParty = toParty; return (T) this; } + /** + * To tag t. + * + * @param toTag the to tag + * @return the t + */ public T toTag(String toTag) { this.toTag = toTag; return (T) this; } + /** + * Safe t. + * + * @param safe the safe + * @return the t + */ public T safe(String safe) { this.safe = safe; return (T) this; } + /** + * Build wx cp message. + * + * @return the wx cp message + */ public WxCpMessage build() { WxCpMessage m = new WxCpMessage(); m.setAgentId(this.agentId); diff --git a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/messagebuilder/FileBuilder.java b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/messagebuilder/FileBuilder.java index 6b36cf6cf..2d9561486 100644 --- a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/messagebuilder/FileBuilder.java +++ b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/messagebuilder/FileBuilder.java @@ -14,10 +14,19 @@ import me.chanjar.weixin.cp.bean.message.WxCpMessage; public final class FileBuilder extends BaseBuilder { private String mediaId; + /** + * Instantiates a new File builder. + */ public FileBuilder() { this.msgType = WxConsts.KefuMsgType.FILE; } + /** + * Media id file builder. + * + * @param media_id the media id + * @return the file builder + */ public FileBuilder mediaId(String media_id) { this.mediaId = media_id; return this; diff --git a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/messagebuilder/ImageBuilder.java b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/messagebuilder/ImageBuilder.java index 6735385c9..5f88b5965 100644 --- a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/messagebuilder/ImageBuilder.java +++ b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/messagebuilder/ImageBuilder.java @@ -14,10 +14,19 @@ import me.chanjar.weixin.cp.bean.message.WxCpMessage; public final class ImageBuilder extends BaseBuilder { private String mediaId; + /** + * Instantiates a new Image builder. + */ public ImageBuilder() { this.msgType = WxConsts.KefuMsgType.IMAGE; } + /** + * Media id image builder. + * + * @param media_id the media id + * @return the image builder + */ public ImageBuilder mediaId(String media_id) { this.mediaId = media_id; return this; diff --git a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/messagebuilder/MarkdownMsgBuilder.java b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/messagebuilder/MarkdownMsgBuilder.java index 6b6af40ac..ce06eafd2 100644 --- a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/messagebuilder/MarkdownMsgBuilder.java +++ b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/messagebuilder/MarkdownMsgBuilder.java @@ -14,10 +14,19 @@ import me.chanjar.weixin.cp.bean.message.WxCpMessage; public class MarkdownMsgBuilder extends BaseBuilder { private String content; + /** + * Instantiates a new Markdown msg builder. + */ public MarkdownMsgBuilder() { this.msgType = WxConsts.KefuMsgType.MARKDOWN; } + /** + * Content markdown msg builder. + * + * @param content the content + * @return the markdown msg builder + */ public MarkdownMsgBuilder content(String content) { this.content = content; return this; diff --git a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/messagebuilder/MiniProgramNoticeMsgBuilder.java b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/messagebuilder/MiniProgramNoticeMsgBuilder.java index 928ea3863..b21197245 100644 --- a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/messagebuilder/MiniProgramNoticeMsgBuilder.java +++ b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/messagebuilder/MiniProgramNoticeMsgBuilder.java @@ -21,35 +21,74 @@ public class MiniProgramNoticeMsgBuilder extends BaseBuilder contentItems; + /** + * Instantiates a new Mini program notice msg builder. + */ public MiniProgramNoticeMsgBuilder() { this.msgType = WxConsts.KefuMsgType.MINIPROGRAM_NOTICE; } + /** + * App id mini program notice msg builder. + * + * @param appId the app id + * @return the mini program notice msg builder + */ public MiniProgramNoticeMsgBuilder appId(String appId) { this.appId = appId; return this; } + /** + * Page mini program notice msg builder. + * + * @param page the page + * @return the mini program notice msg builder + */ public MiniProgramNoticeMsgBuilder page(String page) { this.page = page; return this; } + /** + * Title mini program notice msg builder. + * + * @param title the title + * @return the mini program notice msg builder + */ public MiniProgramNoticeMsgBuilder title(String title) { this.title = title; return this; } + /** + * Description mini program notice msg builder. + * + * @param description the description + * @return the mini program notice msg builder + */ public MiniProgramNoticeMsgBuilder description(String description) { this.description = description; return this; } + /** + * Content items mini program notice msg builder. + * + * @param contentItems the content items + * @return the mini program notice msg builder + */ public MiniProgramNoticeMsgBuilder contentItems(Map contentItems) { this.contentItems = contentItems; return this; } + /** + * Emphasis first item mini program notice msg builder. + * + * @param emphasisFirstItem the emphasis first item + * @return the mini program notice msg builder + */ public MiniProgramNoticeMsgBuilder emphasisFirstItem(Boolean emphasisFirstItem) { this.emphasisFirstItem = emphasisFirstItem; return this; diff --git a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/messagebuilder/MpnewsBuilder.java b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/messagebuilder/MpnewsBuilder.java index 1d2108900..f9b31cdfc 100644 --- a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/messagebuilder/MpnewsBuilder.java +++ b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/messagebuilder/MpnewsBuilder.java @@ -22,20 +22,41 @@ public final class MpnewsBuilder extends BaseBuilder { private String mediaId; + /** + * Instantiates a new Mpnews builder. + */ public MpnewsBuilder() { this.msgType = WxConsts.KefuMsgType.MPNEWS; } + /** + * Media id mpnews builder. + * + * @param mediaId the media id + * @return the mpnews builder + */ public MpnewsBuilder mediaId(String mediaId) { this.mediaId = mediaId; return this; } + /** + * Add article mpnews builder. + * + * @param articles the articles + * @return the mpnews builder + */ public MpnewsBuilder addArticle(MpnewsArticle... articles) { Collections.addAll(this.articles, articles); return this; } + /** + * Articles mpnews builder. + * + * @param articles the articles + * @return the mpnews builder + */ public MpnewsBuilder articles(List articles) { this.articles = articles; return this; diff --git a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/messagebuilder/NewsBuilder.java b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/messagebuilder/NewsBuilder.java index 4d12a51ce..7d75f5f2b 100644 --- a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/messagebuilder/NewsBuilder.java +++ b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/messagebuilder/NewsBuilder.java @@ -21,15 +21,30 @@ public final class NewsBuilder extends BaseBuilder { private List articles = new ArrayList<>(); + /** + * Instantiates a new News builder. + */ public NewsBuilder() { this.msgType = WxConsts.KefuMsgType.NEWS; } + /** + * Add article news builder. + * + * @param articles the articles + * @return the news builder + */ public NewsBuilder addArticle(NewArticle... articles) { Collections.addAll(this.articles, articles); return this; } + /** + * Articles news builder. + * + * @param articles the articles + * @return the news builder + */ public NewsBuilder articles(List articles) { this.articles = articles; return this; diff --git a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/messagebuilder/TaskCardBuilder.java b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/messagebuilder/TaskCardBuilder.java index a63505eef..f23ada28d 100644 --- a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/messagebuilder/TaskCardBuilder.java +++ b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/messagebuilder/TaskCardBuilder.java @@ -12,8 +12,7 @@ import java.util.List; * 用法: WxCustomMessage m = WxCustomMessage.TASKCARD().title(...)....toUser(...).build(); * * - * @author Jeff - * created on 2019-05-16 + * @author Jeff created on 2019-05-16 */ public class TaskCardBuilder extends BaseBuilder { private String title; @@ -25,30 +24,63 @@ public class TaskCardBuilder extends BaseBuilder { */ private List buttons; + /** + * Instantiates a new Task card builder. + */ public TaskCardBuilder() { this.msgType = WxConsts.KefuMsgType.TASKCARD; } + /** + * Title task card builder. + * + * @param title the title + * @return the task card builder + */ public TaskCardBuilder title(String title) { this.title = title; return this; } + /** + * Description task card builder. + * + * @param description the description + * @return the task card builder + */ public TaskCardBuilder description(String description) { this.description = description; return this; } + /** + * Url task card builder. + * + * @param url the url + * @return the task card builder + */ public TaskCardBuilder url(String url) { this.url = url; return this; } + /** + * Task id task card builder. + * + * @param taskId the task id + * @return the task card builder + */ public TaskCardBuilder taskId(String taskId) { this.taskId = taskId; return this; } + /** + * Buttons task card builder. + * + * @param buttons the buttons + * @return the task card builder + */ public TaskCardBuilder buttons(List buttons) { this.buttons = buttons; return this; diff --git a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/messagebuilder/TemplateCardBuilder.java b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/messagebuilder/TemplateCardBuilder.java index 174c23f29..674bdfa18 100644 --- a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/messagebuilder/TemplateCardBuilder.java +++ b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/messagebuilder/TemplateCardBuilder.java @@ -12,8 +12,7 @@ import java.util.List; * 用法: WxCustomMessage m = WxCustomMessage.TEMPLATECARD().title(...)....toUser(...).build(); * * - * @author yzts - * created on 2019-05-16 + * @author yzts created on 2019-05-16 */ public class TemplateCardBuilder extends BaseBuilder { /** @@ -168,150 +167,327 @@ public class TemplateCardBuilder extends BaseBuilder { private QuoteArea quoteArea; + /** + * Instantiates a new Template card builder. + */ public TemplateCardBuilder() { this.msgType = WxConsts.KefuMsgType.TEMPLATE_CARD; } + /** + * Card type template card builder. + * + * @param cardType the card type + * @return the template card builder + */ public TemplateCardBuilder cardType(String cardType) { this.cardType = cardType; return this; } + /** + * Card image url template card builder. + * + * @param cardImageUrl the card image url + * @return the template card builder + */ public TemplateCardBuilder cardImageUrl(String cardImageUrl) { this.cardImageUrl = cardImageUrl; return this; } + /** + * Card image aspect ratio template card builder. + * + * @param cardImageAspectRatio the card image aspect ratio + * @return the template card builder + */ public TemplateCardBuilder cardImageAspectRatio(Float cardImageAspectRatio) { this.cardImageAspectRatio = cardImageAspectRatio; return this; } + /** + * Action menu desc template card builder. + * + * @param actionMenuDesc the action menu desc + * @return the template card builder + */ public TemplateCardBuilder actionMenuDesc(String actionMenuDesc) { this.actionMenuDesc = actionMenuDesc; return this; } + /** + * Action menu action list template card builder. + * + * @param actionMenuItemList the action menu item list + * @return the template card builder + */ public TemplateCardBuilder actionMenuActionList(List actionMenuItemList) { this.actionMenuActionList = actionMenuItemList; return this; } + /** + * Source icon url template card builder. + * + * @param sourceIconUrl the source icon url + * @return the template card builder + */ public TemplateCardBuilder sourceIconUrl(String sourceIconUrl) { this.sourceIconUrl = sourceIconUrl; return this; } + /** + * Source desc template card builder. + * + * @param sourceDesc the source desc + * @return the template card builder + */ public TemplateCardBuilder sourceDesc(String sourceDesc) { this.sourceDesc = sourceDesc; return this; } + /** + * Source desc color template card builder. + * + * @param sourceDescColor the source desc color + * @return the template card builder + */ public TemplateCardBuilder sourceDescColor(Integer sourceDescColor) { this.sourceDescColor = sourceDescColor; return this; } + /** + * Main title title template card builder. + * + * @param mainTitleTitle the main title title + * @return the template card builder + */ public TemplateCardBuilder mainTitleTitle(String mainTitleTitle) { this.mainTitleTitle = mainTitleTitle; return this; } + /** + * Main title desc template card builder. + * + * @param mainTitleDesc the main title desc + * @return the template card builder + */ public TemplateCardBuilder mainTitleDesc(String mainTitleDesc) { this.mainTitleDesc = mainTitleDesc; return this; } + /** + * Emphasis content title template card builder. + * + * @param emphasisContentTitle the emphasis content title + * @return the template card builder + */ public TemplateCardBuilder emphasisContentTitle(String emphasisContentTitle) { this.emphasisContentTitle = emphasisContentTitle; return this; } + /** + * Emphasis content desc template card builder. + * + * @param emphasisContentDesc the emphasis content desc + * @return the template card builder + */ public TemplateCardBuilder emphasisContentDesc(String emphasisContentDesc) { this.emphasisContentDesc = emphasisContentDesc; return this; } + /** + * Sub title text template card builder. + * + * @param subTitleText the sub title text + * @return the template card builder + */ public TemplateCardBuilder subTitleText(String subTitleText) { this.subTitleText = subTitleText; return this; } + /** + * Vertical contents template card builder. + * + * @param verticalContents the vertical contents + * @return the template card builder + */ public TemplateCardBuilder verticalContents(List verticalContents) { this.verticalContents = verticalContents; return this; } + /** + * Horizontal contents template card builder. + * + * @param horizontalContents the horizontal contents + * @return the template card builder + */ public TemplateCardBuilder horizontalContents(List horizontalContents) { this.horizontalContents = horizontalContents; return this; } + /** + * Jumps template card builder. + * + * @param jumps the jumps + * @return the template card builder + */ public TemplateCardBuilder jumps(List jumps) { this.jumps = jumps; return this; } + /** + * Card action type template card builder. + * + * @param cardActionType the card action type + * @return the template card builder + */ public TemplateCardBuilder cardActionType(Integer cardActionType) { this.cardActionType = cardActionType; return this; } + /** + * Card action url template card builder. + * + * @param cardActionUrl the card action url + * @return the template card builder + */ public TemplateCardBuilder cardActionUrl(String cardActionUrl) { this.cardActionUrl = cardActionUrl; return this; } + /** + * Card action appid template card builder. + * + * @param cardActionAppid the card action appid + * @return the template card builder + */ public TemplateCardBuilder cardActionAppid(String cardActionAppid) { this.cardActionAppid = cardActionAppid; return this; } + /** + * Card action pagepath template card builder. + * + * @param cardActionPagepath the card action pagepath + * @return the template card builder + */ public TemplateCardBuilder cardActionPagepath(String cardActionPagepath) { this.cardActionPagepath = cardActionPagepath; return this; } + /** + * Task id template card builder. + * + * @param taskId the task id + * @return the template card builder + */ public TemplateCardBuilder taskId(String taskId) { this.taskId = taskId; return this; } + /** + * Buttons template card builder. + * + * @param buttons the buttons + * @return the template card builder + */ public TemplateCardBuilder buttons(List buttons) { this.buttons = buttons; return this; } + /** + * Checkbox question key template card builder. + * + * @param checkboxQuestionKey the checkbox question key + * @return the template card builder + */ public TemplateCardBuilder checkboxQuestionKey(String checkboxQuestionKey) { this.checkboxQuestionKey = checkboxQuestionKey; return this; } + /** + * Checkbox mode template card builder. + * + * @param checkboxMode the checkbox mode + * @return the template card builder + */ public TemplateCardBuilder checkboxMode(Integer checkboxMode) { this.checkboxMode = checkboxMode; return this; } + /** + * Options template card builder. + * + * @param options the options + * @return the template card builder + */ public TemplateCardBuilder options(List options) { this.options = options; return this; } + /** + * Submit button text template card builder. + * + * @param submitButtonText the submit button text + * @return the template card builder + */ public TemplateCardBuilder submitButtonText(String submitButtonText) { this.submitButtonText = submitButtonText; return this; } + /** + * Submit button key template card builder. + * + * @param submitButtonKey the submit button key + * @return the template card builder + */ public TemplateCardBuilder submitButtonKey(String submitButtonKey) { this.submitButtonKey = submitButtonKey; return this; } + /** + * Selects template card builder. + * + * @param selects the selects + * @return the template card builder + */ public TemplateCardBuilder selects(List selects) { this.selects = selects; return this; } + /** + * Quote area template card builder. + * + * @param quoteArea the quote area + * @return the template card builder + */ public TemplateCardBuilder quoteArea(QuoteArea quoteArea) { this.quoteArea = quoteArea; return this; diff --git a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/messagebuilder/TextBuilder.java b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/messagebuilder/TextBuilder.java index e072b9a79..40de567f5 100644 --- a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/messagebuilder/TextBuilder.java +++ b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/messagebuilder/TextBuilder.java @@ -14,10 +14,19 @@ import me.chanjar.weixin.cp.bean.message.WxCpMessage; public final class TextBuilder extends BaseBuilder { private String content; + /** + * Instantiates a new Text builder. + */ public TextBuilder() { this.msgType = WxConsts.KefuMsgType.TEXT; } + /** + * Content text builder. + * + * @param content the content + * @return the text builder + */ public TextBuilder content(String content) { this.content = content; return this; diff --git a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/messagebuilder/TextCardBuilder.java b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/messagebuilder/TextCardBuilder.java index 306187ee4..3f58c9954 100644 --- a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/messagebuilder/TextCardBuilder.java +++ b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/messagebuilder/TextCardBuilder.java @@ -18,25 +18,52 @@ public class TextCardBuilder extends BaseBuilder { private String url; private String btnTxt; + /** + * Instantiates a new Text card builder. + */ public TextCardBuilder() { this.msgType = WxConsts.KefuMsgType.TEXTCARD; } + /** + * Title text card builder. + * + * @param title the title + * @return the text card builder + */ public TextCardBuilder title(String title) { this.title = title; return this; } + /** + * Description text card builder. + * + * @param description the description + * @return the text card builder + */ public TextCardBuilder description(String description) { this.description = description; return this; } + /** + * Url text card builder. + * + * @param url the url + * @return the text card builder + */ public TextCardBuilder url(String url) { this.url = url; return this; } + /** + * Btn txt text card builder. + * + * @param btnTxt the btn txt + * @return the text card builder + */ public TextCardBuilder btnTxt(String btnTxt) { this.btnTxt = btnTxt; return this; diff --git a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/messagebuilder/VideoBuilder.java b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/messagebuilder/VideoBuilder.java index 2c7fab5c8..226e9dbe7 100644 --- a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/messagebuilder/VideoBuilder.java +++ b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/messagebuilder/VideoBuilder.java @@ -23,25 +23,52 @@ public final class VideoBuilder extends BaseBuilder { private String description; private String thumbMediaId; + /** + * Instantiates a new Video builder. + */ public VideoBuilder() { this.msgType = WxConsts.KefuMsgType.VIDEO; } + /** + * Media id video builder. + * + * @param mediaId the media id + * @return the video builder + */ public VideoBuilder mediaId(String mediaId) { this.mediaId = mediaId; return this; } + /** + * Title video builder. + * + * @param title the title + * @return the video builder + */ public VideoBuilder title(String title) { this.title = title; return this; } + /** + * Description video builder. + * + * @param description the description + * @return the video builder + */ public VideoBuilder description(String description) { this.description = description; return this; } + /** + * Thumb media id video builder. + * + * @param thumb_media_id the thumb media id + * @return the video builder + */ public VideoBuilder thumbMediaId(String thumb_media_id) { this.thumbMediaId = thumb_media_id; return this; diff --git a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/messagebuilder/VoiceBuilder.java b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/messagebuilder/VoiceBuilder.java index 0e0b9f828..62308a6d4 100644 --- a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/messagebuilder/VoiceBuilder.java +++ b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/messagebuilder/VoiceBuilder.java @@ -14,10 +14,19 @@ import me.chanjar.weixin.cp.bean.message.WxCpMessage; public final class VoiceBuilder extends BaseBuilder { private String mediaId; + /** + * Instantiates a new Voice builder. + */ public VoiceBuilder() { this.msgType = WxConsts.KefuMsgType.VOICE; } + /** + * Media id voice builder. + * + * @param media_id the media id + * @return the voice builder + */ public VoiceBuilder mediaId(String media_id) { this.mediaId = media_id; return this; diff --git a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/msgaudit/WxCpAgreeInfo.java b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/msgaudit/WxCpAgreeInfo.java index 43a36681e..647bebbad 100644 --- a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/msgaudit/WxCpAgreeInfo.java +++ b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/msgaudit/WxCpAgreeInfo.java @@ -27,6 +27,9 @@ public class WxCpAgreeInfo implements Serializable { @SerializedName("agreeinfo") private List agreeInfo; + /** + * The type Agree info. + */ @Getter @Setter public static class AgreeInfo implements Serializable { @@ -44,20 +47,42 @@ public class WxCpAgreeInfo implements Serializable { @SerializedName("agree_status") private String agreeStatus; + /** + * From json agree info. + * + * @param json the json + * @return the agree info + */ public static AgreeInfo fromJson(String json) { return WxCpGsonBuilder.create().fromJson(json, AgreeInfo.class); } + /** + * To json string. + * + * @return the string + */ public String toJson() { return WxCpGsonBuilder.create().toJson(this); } } + /** + * From json wx cp agree info. + * + * @param json the json + * @return the wx cp agree info + */ public static WxCpAgreeInfo fromJson(String json) { return WxCpGsonBuilder.create().fromJson(json, WxCpAgreeInfo.class); } + /** + * To json string. + * + * @return the string + */ public String toJson() { return WxCpGsonBuilder.create().toJson(this); } diff --git a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/msgaudit/WxCpChatDatas.java b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/msgaudit/WxCpChatDatas.java index aa40e9734..89f021939 100644 --- a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/msgaudit/WxCpChatDatas.java +++ b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/msgaudit/WxCpChatDatas.java @@ -12,8 +12,7 @@ import java.util.List; /** * 聊天记录数据内容. * - * @author Wang_Wong - * created on 2022-01-17 + * @author Wang_Wong created on 2022-01-17 */ @Data public class WxCpChatDatas implements Serializable { @@ -31,6 +30,9 @@ public class WxCpChatDatas implements Serializable { @SerializedName("chatdata") private List chatData; + /** + * The type Wx cp chat data. + */ @Getter @Setter public static class WxCpChatData implements Serializable { @@ -51,20 +53,42 @@ public class WxCpChatDatas implements Serializable { @SerializedName("encrypt_chat_msg") private String encryptChatMsg; + /** + * From json wx cp chat data. + * + * @param json the json + * @return the wx cp chat data + */ public static WxCpChatData fromJson(String json) { return WxCpGsonBuilder.create().fromJson(json, WxCpChatData.class); } + /** + * To json string. + * + * @return the string + */ public String toJson() { return WxCpGsonBuilder.create().toJson(this); } } + /** + * From json wx cp chat datas. + * + * @param json the json + * @return the wx cp chat datas + */ public static WxCpChatDatas fromJson(String json) { return WxCpGsonBuilder.create().fromJson(json, WxCpChatDatas.class); } + /** + * To json string. + * + * @return the string + */ public String toJson() { return WxCpGsonBuilder.create().toJson(this); } diff --git a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/msgaudit/WxCpChatModel.java b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/msgaudit/WxCpChatModel.java index 888f7f399..05098e5e0 100644 --- a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/msgaudit/WxCpChatModel.java +++ b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/msgaudit/WxCpChatModel.java @@ -204,15 +204,29 @@ public class WxCpChatModel implements Serializable { @SerializedName("sphfeed") private SphFeed sphFeed; + /** + * From json wx cp chat model. + * + * @param json the json + * @return the wx cp chat model + */ public static WxCpChatModel fromJson(String json) { return WxCpGsonBuilder.create().fromJson(json, WxCpChatModel.class); } + /** + * To json string. + * + * @return the string + */ public String toJson() { return WxCpGsonBuilder.create().toJson(this); } + /** + * The type Text. + */ @Getter @Setter public static class Text implements Serializable { @@ -221,10 +235,21 @@ public class WxCpChatModel implements Serializable { @SerializedName("content") private String content; + /** + * From json text. + * + * @param json the json + * @return the text + */ public static Text fromJson(String json) { return WxCpGsonBuilder.create().fromJson(json, Text.class); } + /** + * To json string. + * + * @return the string + */ public String toJson() { return WxCpGsonBuilder.create().toJson(this); } @@ -232,6 +257,9 @@ public class WxCpChatModel implements Serializable { } + /** + * The type Image. + */ @Getter @Setter public static class Image implements Serializable { @@ -246,10 +274,21 @@ public class WxCpChatModel implements Serializable { @SerializedName("filesize") private Long fileSize; + /** + * From json image. + * + * @param json the json + * @return the image + */ public static Image fromJson(String json) { return WxCpGsonBuilder.create().fromJson(json, Image.class); } + /** + * To json string. + * + * @return the string + */ public String toJson() { return WxCpGsonBuilder.create().toJson(this); } @@ -257,6 +296,9 @@ public class WxCpChatModel implements Serializable { } + /** + * The type Revoke. + */ @Getter @Setter public static class Revoke implements Serializable { @@ -265,10 +307,21 @@ public class WxCpChatModel implements Serializable { @SerializedName("pre_msgid") private String preMsgId; + /** + * From json revoke. + * + * @param json the json + * @return the revoke + */ public static Revoke fromJson(String json) { return WxCpGsonBuilder.create().fromJson(json, Revoke.class); } + /** + * To json string. + * + * @return the string + */ public String toJson() { return WxCpGsonBuilder.create().toJson(this); } @@ -276,6 +329,9 @@ public class WxCpChatModel implements Serializable { } + /** + * The type Agree. + */ @Getter @Setter public static class Agree implements Serializable { @@ -290,10 +346,21 @@ public class WxCpChatModel implements Serializable { @SerializedName(value = "disagree_time") private Long disagreeTime; + /** + * From json agree. + * + * @param json the json + * @return the agree + */ public static Agree fromJson(String json) { return WxCpGsonBuilder.create().fromJson(json, Agree.class); } + /** + * To json string. + * + * @return the string + */ public String toJson() { return WxCpGsonBuilder.create().toJson(this); } @@ -301,6 +368,9 @@ public class WxCpChatModel implements Serializable { } + /** + * The type Voice. + */ @Getter @Setter public static class Voice implements Serializable { @@ -318,10 +388,21 @@ public class WxCpChatModel implements Serializable { @SerializedName("play_length") private Long playLength; + /** + * From json voice. + * + * @param json the json + * @return the voice + */ public static Voice fromJson(String json) { return WxCpGsonBuilder.create().fromJson(json, Voice.class); } + /** + * To json string. + * + * @return the string + */ public String toJson() { return WxCpGsonBuilder.create().toJson(this); } @@ -329,6 +410,9 @@ public class WxCpChatModel implements Serializable { } + /** + * The type Video. + */ @Getter @Setter public static class Video implements Serializable { @@ -346,10 +430,21 @@ public class WxCpChatModel implements Serializable { @SerializedName("play_length") private Long playLength; + /** + * From json video. + * + * @param json the json + * @return the video + */ public static Video fromJson(String json) { return WxCpGsonBuilder.create().fromJson(json, Video.class); } + /** + * To json string. + * + * @return the string + */ public String toJson() { return WxCpGsonBuilder.create().toJson(this); } @@ -357,6 +452,9 @@ public class WxCpChatModel implements Serializable { } + /** + * The type Card. + */ @Getter @Setter public static class Card implements Serializable { @@ -368,10 +466,21 @@ public class WxCpChatModel implements Serializable { @SerializedName("userid") private String userId; + /** + * From json card. + * + * @param json the json + * @return the card + */ public static Card fromJson(String json) { return WxCpGsonBuilder.create().fromJson(json, Card.class); } + /** + * To json string. + * + * @return the string + */ public String toJson() { return WxCpGsonBuilder.create().toJson(this); } @@ -379,6 +488,9 @@ public class WxCpChatModel implements Serializable { } + /** + * The type Location. + */ @Getter @Setter public static class Location implements Serializable { @@ -399,10 +511,21 @@ public class WxCpChatModel implements Serializable { @SerializedName("zoom") private Integer zoom; + /** + * From json location. + * + * @param json the json + * @return the location + */ public static Location fromJson(String json) { return WxCpGsonBuilder.create().fromJson(json, Location.class); } + /** + * To json string. + * + * @return the string + */ public String toJson() { return WxCpGsonBuilder.create().toJson(this); } @@ -410,6 +533,9 @@ public class WxCpChatModel implements Serializable { } + /** + * The type Emotion. + */ @Getter @Setter public static class Emotion implements Serializable { @@ -436,10 +562,21 @@ public class WxCpChatModel implements Serializable { @SerializedName("sdkfileid") private String sdkFileId; + /** + * From json emotion. + * + * @param json the json + * @return the emotion + */ public static Emotion fromJson(String json) { return WxCpGsonBuilder.create().fromJson(json, Emotion.class); } + /** + * To json string. + * + * @return the string + */ public String toJson() { return WxCpGsonBuilder.create().toJson(this); } @@ -447,6 +584,9 @@ public class WxCpChatModel implements Serializable { } + /** + * The type File. + */ @Getter @Setter public static class File implements Serializable { @@ -467,10 +607,21 @@ public class WxCpChatModel implements Serializable { @SerializedName("filesize") private Integer fileSize; + /** + * From json file. + * + * @param json the json + * @return the file + */ public static File fromJson(String json) { return WxCpGsonBuilder.create().fromJson(json, File.class); } + /** + * To json string. + * + * @return the string + */ public String toJson() { return WxCpGsonBuilder.create().toJson(this); } @@ -478,6 +629,9 @@ public class WxCpChatModel implements Serializable { } + /** + * The type Link. + */ @Getter @Setter public static class Link implements Serializable { @@ -495,10 +649,21 @@ public class WxCpChatModel implements Serializable { @SerializedName("image_url") private String imageUrl; + /** + * From json link. + * + * @param json the json + * @return the link + */ public static Link fromJson(String json) { return WxCpGsonBuilder.create().fromJson(json, Link.class); } + /** + * To json string. + * + * @return the string + */ public String toJson() { return WxCpGsonBuilder.create().toJson(this); } @@ -526,10 +691,21 @@ public class WxCpChatModel implements Serializable { @SerializedName("displayname") private String displayName; + /** + * From json weapp. + * + * @param json the json + * @return the weapp + */ public static Weapp fromJson(String json) { return WxCpGsonBuilder.create().fromJson(json, Weapp.class); } + /** + * To json string. + * + * @return the string + */ public String toJson() { return WxCpGsonBuilder.create().toJson(this); } @@ -551,10 +727,21 @@ public class WxCpChatModel implements Serializable { @SerializedName("title") private String title; + /** + * From json chat record. + * + * @param json the json + * @return the chat record + */ public static ChatRecord fromJson(String json) { return WxCpGsonBuilder.create().fromJson(json, ChatRecord.class); } + /** + * To json string. + * + * @return the string + */ public String toJson() { return WxCpGsonBuilder.create().toJson(this); } @@ -562,6 +749,9 @@ public class WxCpChatModel implements Serializable { } + /** + * The type Chat record item. + */ @Getter @Setter public static class ChatRecordItem implements Serializable { @@ -579,10 +769,21 @@ public class WxCpChatModel implements Serializable { @SerializedName("from_chatroom") private Boolean fromChatRoom; + /** + * From json chat record item. + * + * @param json the json + * @return the chat record item + */ public static ChatRecordItem fromJson(String json) { return WxCpGsonBuilder.create().fromJson(json, ChatRecordItem.class); } + /** + * To json string. + * + * @return the string + */ public String toJson() { return WxCpGsonBuilder.create().toJson(this); } @@ -613,10 +814,21 @@ public class WxCpChatModel implements Serializable { @SerializedName("details") private List

details; + /** + * From json collect. + * + * @param json the json + * @return the collect + */ public static Collect fromJson(String json) { return WxCpGsonBuilder.create().fromJson(json, Collect.class); } + /** + * To json string. + * + * @return the string + */ public String toJson() { return WxCpGsonBuilder.create().toJson(this); } @@ -624,6 +836,9 @@ public class WxCpChatModel implements Serializable { } + /** + * The type Details. + */ @Getter @Setter public static class Details implements Serializable { @@ -638,10 +853,21 @@ public class WxCpChatModel implements Serializable { @SerializedName("type") private String type; + /** + * From json details. + * + * @param json the json + * @return the details + */ public static Details fromJson(String json) { return WxCpGsonBuilder.create().fromJson(json, Details.class); } + /** + * To json string. + * + * @return the string + */ public String toJson() { return WxCpGsonBuilder.create().toJson(this); } @@ -669,10 +895,21 @@ public class WxCpChatModel implements Serializable { @SerializedName("wish") private String wish; + /** + * From json redpacket. + * + * @param json the json + * @return the redpacket + */ public static Redpacket fromJson(String json) { return WxCpGsonBuilder.create().fromJson(json, Redpacket.class); } + /** + * To json string. + * + * @return the string + */ public String toJson() { return WxCpGsonBuilder.create().toJson(this); } @@ -712,10 +949,21 @@ public class WxCpChatModel implements Serializable { @SerializedName("status") private Integer status; + /** + * From json meeting. + * + * @param json the json + * @return the meeting + */ public static Meeting fromJson(String json) { return WxCpGsonBuilder.create().fromJson(json, Meeting.class); } + /** + * To json string. + * + * @return the string + */ public String toJson() { return WxCpGsonBuilder.create().toJson(this); } @@ -740,10 +988,21 @@ public class WxCpChatModel implements Serializable { @SerializedName("link_url") private String linkUrl; + /** + * From json doc. + * + * @param json the json + * @return the doc + */ public static Doc fromJson(String json) { return WxCpGsonBuilder.create().fromJson(json, Doc.class); } + /** + * To json string. + * + * @return the string + */ public String toJson() { return WxCpGsonBuilder.create().toJson(this); } @@ -765,10 +1024,21 @@ public class WxCpChatModel implements Serializable { @SerializedName("item") private List newsItem; + /** + * From json info. + * + * @param json the json + * @return the info + */ public static Info fromJson(String json) { return WxCpGsonBuilder.create().fromJson(json, Info.class); } + /** + * To json string. + * + * @return the string + */ public String toJson() { return WxCpGsonBuilder.create().toJson(this); } @@ -796,10 +1066,21 @@ public class WxCpChatModel implements Serializable { @SerializedName("picurl") private String picUrl; + /** + * From json news item. + * + * @param json the json + * @return the news item + */ public static NewsItem fromJson(String json) { return WxCpGsonBuilder.create().fromJson(json, NewsItem.class); } + /** + * To json string. + * + * @return the string + */ public String toJson() { return WxCpGsonBuilder.create().toJson(this); } @@ -836,10 +1117,21 @@ public class WxCpChatModel implements Serializable { @SerializedName("remarks") private String remarks; + /** + * From json calendar. + * + * @param json the json + * @return the calendar + */ public static Calendar fromJson(String json) { return WxCpGsonBuilder.create().fromJson(json, Calendar.class); } + /** + * To json string. + * + * @return the string + */ public String toJson() { return WxCpGsonBuilder.create().toJson(this); } @@ -858,6 +1150,9 @@ public class WxCpChatModel implements Serializable { @SerializedName("item") private List item; + /** + * The type Item. + */ @Getter @Setter public static class Item implements Serializable { @@ -894,14 +1189,28 @@ public class WxCpChatModel implements Serializable { @SerializedName("sharescreendata") private List shareScreenData; + /** + * From json meeting voice call. + * + * @param json the json + * @return the meeting voice call + */ public static MeetingVoiceCall fromJson(String json) { return WxCpGsonBuilder.create().fromJson(json, MeetingVoiceCall.class); } + /** + * To json string. + * + * @return the string + */ public String toJson() { return WxCpGsonBuilder.create().toJson(this); } + /** + * The type Demo file data. + */ @Getter @Setter public static class DemoFileData implements Serializable { @@ -919,16 +1228,30 @@ public class WxCpChatModel implements Serializable { @SerializedName("endtime") private Long endTime; + /** + * From json demo file data. + * + * @param json the json + * @return the demo file data + */ public static DemoFileData fromJson(String json) { return WxCpGsonBuilder.create().fromJson(json, DemoFileData.class); } + /** + * To json string. + * + * @return the string + */ public String toJson() { return WxCpGsonBuilder.create().toJson(this); } } + /** + * The type Share screen data. + */ @Getter @Setter public static class ShareScreenData implements Serializable { @@ -943,10 +1266,21 @@ public class WxCpChatModel implements Serializable { @SerializedName("endtime") private Long endTime; + /** + * From json share screen data. + * + * @param json the json + * @return the share screen data + */ public static ShareScreenData fromJson(String json) { return WxCpGsonBuilder.create().fromJson(json, ShareScreenData.class); } + /** + * To json string. + * + * @return the string + */ public String toJson() { return WxCpGsonBuilder.create().toJson(this); } @@ -973,10 +1307,21 @@ public class WxCpChatModel implements Serializable { @SerializedName("feed_desc") private String feedDesc; + /** + * From json sph feed. + * + * @param json the json + * @return the sph feed + */ public static SphFeed fromJson(String json) { return WxCpGsonBuilder.create().fromJson(json, SphFeed.class); } + /** + * To json string. + * + * @return the string + */ public String toJson() { return WxCpGsonBuilder.create().toJson(this); } diff --git a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/msgaudit/WxCpCheckAgreeRequest.java b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/msgaudit/WxCpCheckAgreeRequest.java index 65745cc18..7e53f0d08 100644 --- a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/msgaudit/WxCpCheckAgreeRequest.java +++ b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/msgaudit/WxCpCheckAgreeRequest.java @@ -11,8 +11,7 @@ import java.util.List; /** * 获取会话同意情况请求参数. * - * @author Wang_Wong - * created on 2022-01-21 + * @author Wang_Wong created on 2022-01-21 */ @Data @Builder @@ -25,14 +24,28 @@ public class WxCpCheckAgreeRequest implements Serializable { @SerializedName("info") private List info; + /** + * From json wx cp check agree request. + * + * @param json the json + * @return the wx cp check agree request + */ public static WxCpCheckAgreeRequest fromJson(String json) { return WxCpGsonBuilder.create().fromJson(json, WxCpCheckAgreeRequest.class); } + /** + * To json string. + * + * @return the string + */ public String toJson() { return WxCpGsonBuilder.create().toJson(this); } + /** + * The type Info. + */ @Getter @Setter public static class Info implements Serializable { @@ -44,10 +57,21 @@ public class WxCpCheckAgreeRequest implements Serializable { @SerializedName("exteranalopenid") private String exteranalOpenId; + /** + * From json info. + * + * @param json the json + * @return the info + */ public static Info fromJson(String json) { return WxCpGsonBuilder.create().fromJson(json, Info.class); } + /** + * To json string. + * + * @return the string + */ public String toJson() { return WxCpGsonBuilder.create().toJson(this); } diff --git a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/msgaudit/WxCpFileItem.java b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/msgaudit/WxCpFileItem.java index 7b7be15c5..384f29f75 100644 --- a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/msgaudit/WxCpFileItem.java +++ b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/msgaudit/WxCpFileItem.java @@ -28,10 +28,21 @@ public class WxCpFileItem implements Serializable { @SerializedName("filesize") private Long fileSize; + /** + * From json wx cp file item. + * + * @param json the json + * @return the wx cp file item + */ public static WxCpFileItem fromJson(String json) { return WxCpGsonBuilder.create().fromJson(json, WxCpFileItem.class); } + /** + * To json string. + * + * @return the string + */ public String toJson() { return WxCpGsonBuilder.create().toJson(this); } diff --git a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/msgaudit/WxCpGroupChat.java b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/msgaudit/WxCpGroupChat.java index 3a2656bfb..f7b4ebdea 100644 --- a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/msgaudit/WxCpGroupChat.java +++ b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/msgaudit/WxCpGroupChat.java @@ -33,6 +33,9 @@ public class WxCpGroupChat implements Serializable { private List members; + /** + * The type Member. + */ @Getter @Setter public class Member implements Serializable { @@ -44,16 +47,33 @@ public class WxCpGroupChat implements Serializable { @SerializedName("jointime") private Long joinTime; + /** + * From json member. + * + * @param json the json + * @return the member + */ public Member fromJson(String json) { return WxCpGsonBuilder.create().fromJson(json, Member.class); } } + /** + * From json wx cp group chat. + * + * @param json the json + * @return the wx cp group chat + */ public static WxCpGroupChat fromJson(String json) { return WxCpGsonBuilder.create().fromJson(json, WxCpGroupChat.class); } + /** + * To json string. + * + * @return the string + */ public String toJson() { return WxCpGsonBuilder.create().toJson(this); } diff --git a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/oa/SummaryInfo.java b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/oa/SummaryInfo.java index 0c498d566..fd7e2e77d 100644 --- a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/oa/SummaryInfo.java +++ b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/oa/SummaryInfo.java @@ -10,8 +10,7 @@ import java.util.List; /** * 摘要行信息，用于定义某一行摘要显示的内容. * - * @author Binary Wang - * created on 2020-07-19 + * @author Binary Wang created on 2020-07-19 */ @Data @Accessors(chain = true) @@ -24,6 +23,9 @@ public class SummaryInfo implements Serializable { @SerializedName("summary_info") private List summaryInfoData; + /** + * The type Summary info data. + */ @Data @Accessors(chain = true) public static class SummaryInfoData implements Serializable { diff --git a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/oa/WxCpApprovalDetailResult.java b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/oa/WxCpApprovalDetailResult.java index 2714cc95f..7d55ff878 100644 --- a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/oa/WxCpApprovalDetailResult.java +++ b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/oa/WxCpApprovalDetailResult.java @@ -24,6 +24,9 @@ public class WxCpApprovalDetailResult implements Serializable { @SerializedName("info") private WxCpApprovalDetail info; + /** + * The type Wx cp approval detail. + */ @Data public static class WxCpApprovalDetail implements Serializable { private static final long serialVersionUID = 1353393306564207170L; diff --git a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/oa/WxCpApprovalInfo.java b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/oa/WxCpApprovalInfo.java index b9c1235f1..70c781df4 100644 --- a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/oa/WxCpApprovalInfo.java +++ b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/oa/WxCpApprovalInfo.java @@ -7,6 +7,8 @@ import java.io.Serializable; import java.util.List; /** + * The type Wx cp approval info. + * * @author element */ @Data diff --git a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/oa/WxCpApprovalInfoQueryFilter.java b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/oa/WxCpApprovalInfoQueryFilter.java index 73e6d81d2..888266c87 100644 --- a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/oa/WxCpApprovalInfoQueryFilter.java +++ b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/oa/WxCpApprovalInfoQueryFilter.java @@ -25,10 +25,18 @@ public class WxCpApprovalInfoQueryFilter implements Serializable { private Object value; + /** + * To json string. + * + * @return the string + */ public String toJson() { return WxGsonBuilder.create().toJson(this); } + /** + * The enum Key. + */ public enum KEY { /** diff --git a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/oa/WxCpCheckinData.java b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/oa/WxCpCheckinData.java index 86c3df17f..6e88f70cb 100644 --- a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/oa/WxCpCheckinData.java +++ b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/oa/WxCpCheckinData.java @@ -9,8 +9,7 @@ import java.util.List; /** * 企业微信打卡数据. * - * @author Element - * created on 2019-04-06 11:01 + * @author Element created on 2019-04-06 11:01 */ @Data public class WxCpCheckinData implements Serializable { diff --git a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/oa/WxCpCheckinDayData.java b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/oa/WxCpCheckinDayData.java index ef3ae1c08..1a8d47c82 100644 --- a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/oa/WxCpCheckinDayData.java +++ b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/oa/WxCpCheckinDayData.java @@ -20,6 +20,9 @@ public class WxCpCheckinDayData implements Serializable { @SerializedName("base_info") private BaseInfo baseInfo; + /** + * The type Base info. + */ @Data public class BaseInfo implements Serializable { @@ -67,6 +70,9 @@ public class WxCpCheckinDayData implements Serializable { @SerializedName("rule_info") private RuleInfo ruleInfo; + /** + * The type Rule info. + */ @Data public class RuleInfo implements Serializable { private static final long serialVersionUID = -5512479811648914189L; @@ -100,6 +106,9 @@ public class WxCpCheckinDayData implements Serializable { @SerializedName("checkintime") private List checkinTime; + /** + * The type Checkin time. + */ @Data public class CheckinTime implements Serializable { private static final long serialVersionUID = 1582835435812966332L; @@ -130,6 +139,9 @@ public class WxCpCheckinDayData implements Serializable { @SerializedName("summary_info") private SummaryInfo summaryInfo; + /** + * The type Summary info. + */ @Data public class SummaryInfo implements Serializable { private static final long serialVersionUID = 3428576099259666595L; @@ -170,6 +182,9 @@ public class WxCpCheckinDayData implements Serializable { @SerializedName("holiday_infos") private List holidayInfos; + /** + * The type Holiday infos. + */ @Data public class HolidayInfos implements Serializable { private static final long serialVersionUID = -6671577072585561527L; @@ -185,6 +200,9 @@ public class WxCpCheckinDayData implements Serializable { @SerializedName("sp_title") private SpTitle spTitle; + /** + * The type Sp title. + */ @Data public class SpTitle implements Serializable { private static final long serialVersionUID = 2148815417115384998L; @@ -194,6 +212,9 @@ public class WxCpCheckinDayData implements Serializable { @SerializedName("data") private List data; + /** + * The type Data. + */ @lombok.Data public class Data implements Serializable { private static final long serialVersionUID = -1672692024530543180L; @@ -217,6 +238,9 @@ public class WxCpCheckinDayData implements Serializable { @SerializedName("sp_description") private SpDescription spDescription; + /** + * The type Sp description. + */ @Data public class SpDescription implements Serializable { @@ -227,6 +251,9 @@ public class WxCpCheckinDayData implements Serializable { @SerializedName("data") private List data; + /** + * The type Data. + */ @lombok.Data public class Data implements Serializable { private static final long serialVersionUID = 3555479101375365805L; @@ -251,6 +278,9 @@ public class WxCpCheckinDayData implements Serializable { @SerializedName("exception_infos") private List exceptionInfos; + /** + * The type Exception infos. + */ @Data public class ExceptionInfos implements Serializable { private static final long serialVersionUID = -5987438373762518299L; @@ -279,6 +309,9 @@ public class WxCpCheckinDayData implements Serializable { @SerializedName("ot_info") private OtInfo otInfo; + /** + * The type Ot info. + */ @Data public class OtInfo implements Serializable { private static final long serialVersionUID = -6557759801572150175L; @@ -307,6 +340,9 @@ public class WxCpCheckinDayData implements Serializable { @SerializedName("sp_items") private List spItems; + /** + * The type Sp item. + */ @Data public class SpItem implements Serializable { private static final long serialVersionUID = 2423158264958352024L; diff --git a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/oa/WxCpCheckinMonthData.java b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/oa/WxCpCheckinMonthData.java index 559c8e46a..d0b98bf5d 100644 --- a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/oa/WxCpCheckinMonthData.java +++ b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/oa/WxCpCheckinMonthData.java @@ -11,7 +11,6 @@ import java.util.List; * * @author longliveh */ - @Data public class WxCpCheckinMonthData implements Serializable { private static final long serialVersionUID = -3062328201807894236L; @@ -22,6 +21,9 @@ public class WxCpCheckinMonthData implements Serializable { @SerializedName("base_info") private BaseInfo baseInfo; + /** + * The type Base info. + */ @Data public static class BaseInfo implements Serializable { private static final long serialVersionUID = -5368331890851903885L; @@ -62,6 +64,9 @@ public class WxCpCheckinMonthData implements Serializable { @SerializedName("rule_info") private RuleInfo ruleInfo; + /** + * The type Rule info. + */ @Data public static class RuleInfo implements Serializable { private static final long serialVersionUID = 9152263355916880710L; @@ -86,6 +91,9 @@ public class WxCpCheckinMonthData implements Serializable { @SerializedName("summary_info") private SummaryInfo summaryInfo; + /** + * The type Summary info. + */ @Data public static class SummaryInfo implements Serializable { private static final long serialVersionUID = -1956770107240513983L; @@ -127,6 +135,9 @@ public class WxCpCheckinMonthData implements Serializable { @SerializedName("exception_infos") private List exceptionInfos; + /** + * The type Exception info. + */ @Data public static class ExceptionInfo implements Serializable { private static final long serialVersionUID = -4855850255704089359L; @@ -155,6 +166,9 @@ public class WxCpCheckinMonthData implements Serializable { @SerializedName("sp_items") private List spItems; + /** + * The type Sp item. + */ @Data public static class SpItem implements Serializable { private static final long serialVersionUID = 224472626753597080L; @@ -202,6 +216,9 @@ public class WxCpCheckinMonthData implements Serializable { @SerializedName("overwork_info") private OverWorkInfo overworkInfo; + /** + * The type Over work info. + */ @Data public static class OverWorkInfo implements Serializable { private static final long serialVersionUID = -9149524232645899305L; diff --git a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/oa/WxCpCheckinOption.java b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/oa/WxCpCheckinOption.java index 6f49ec9eb..db7a78c1b 100644 --- a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/oa/WxCpCheckinOption.java +++ b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/oa/WxCpCheckinOption.java @@ -9,8 +9,7 @@ import java.util.List; /** * 企业微信打卡规则. * - * @author Element - * created on 2019-04-06 13:22 + * @author Element created on 2019-04-06 13:22 */ @Data public class WxCpCheckinOption implements Serializable { @@ -21,6 +20,9 @@ public class WxCpCheckinOption implements Serializable { private Group group; + /** + * The type Checkin date. + */ @Data public static class CheckinDate implements Serializable { private static final long serialVersionUID = -5601722383347110974L; @@ -40,6 +42,9 @@ public class WxCpCheckinOption implements Serializable { private Long limitAheadTime; } + /** + * The type Checkin time. + */ @Data public static class CheckinTime implements Serializable { private static final long serialVersionUID = -8579954143265336276L; @@ -57,6 +62,9 @@ public class WxCpCheckinOption implements Serializable { private Long remindOffWorkSec; } + /** + * The type Group. + */ @Data public static class Group implements Serializable { @@ -103,6 +111,9 @@ public class WxCpCheckinOption implements Serializable { } + /** + * The type Wifi mac info. + */ @Data public static class WifiMacInfo implements Serializable { private static final long serialVersionUID = -4657809185716627368L; @@ -114,6 +125,9 @@ public class WxCpCheckinOption implements Serializable { private String mac; } + /** + * The type Loc info. + */ @Data public static class LocInfo implements Serializable { private static final long serialVersionUID = -618965280668099608L; @@ -130,6 +144,9 @@ public class WxCpCheckinOption implements Serializable { private Long distance; } + /** + * The type Spe day. + */ @Data public static class SpeDay implements Serializable { private static final long serialVersionUID = -3538818921359212748L; diff --git a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/oa/WxCpCheckinSchedule.java b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/oa/WxCpCheckinSchedule.java index 9517a64d4..af310439f 100644 --- a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/oa/WxCpCheckinSchedule.java +++ b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/oa/WxCpCheckinSchedule.java @@ -45,6 +45,9 @@ public class WxCpCheckinSchedule implements Serializable { @SerializedName("schedule") private UserSchedule schedule; + /** + * The type User schedule. + */ @Data public class UserSchedule implements Serializable { private static final long serialVersionUID = 9138985222324576857L; @@ -54,6 +57,9 @@ public class WxCpCheckinSchedule implements Serializable { @SerializedName("scheduleList") private List scheduleList; + /** + * The type Schedule. + */ @Data public class Schedule implements Serializable { @@ -71,6 +77,9 @@ public class WxCpCheckinSchedule implements Serializable { @SerializedName("schedule_info") private ScheduleInfo scheduleInfo; + /** + * The type Schedule info. + */ @Data public class ScheduleInfo implements Serializable { private static final long serialVersionUID = 1317096341116256963L; @@ -93,6 +102,9 @@ public class WxCpCheckinSchedule implements Serializable { private List timeSection; + /** + * The type Time section. + */ @Data public class TimeSection implements Serializable { private static final long serialVersionUID = -3447467962751285748L; diff --git a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/oa/WxCpCorpConfInfo.java b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/oa/WxCpCorpConfInfo.java index 514cb421f..5339cc0ba 100644 --- a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/oa/WxCpCorpConfInfo.java +++ b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/oa/WxCpCorpConfInfo.java @@ -22,6 +22,9 @@ public class WxCpCorpConfInfo extends WxCpBaseResp implements Serializable { @SerializedName("lists") private List lists; + /** + * The type Corp conf. + */ @Getter @Setter public static class CorpConf implements Serializable { @@ -47,6 +50,9 @@ public class WxCpCorpConfInfo extends WxCpBaseResp implements Serializable { } + /** + * The type Quota attr. + */ @Getter @Setter public static class QuotaAttr implements Serializable { @@ -63,6 +69,12 @@ public class WxCpCorpConfInfo extends WxCpBaseResp implements Serializable { } + /** + * From json wx cp corp conf info. + * + * @param json the json + * @return the wx cp corp conf info + */ public static WxCpCorpConfInfo fromJson(String json) { return WxCpGsonBuilder.create().fromJson(json, WxCpCorpConfInfo.class); } diff --git a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/oa/WxCpCropCheckinOption.java b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/oa/WxCpCropCheckinOption.java index f9ab9dd15..98ac78d71 100644 --- a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/oa/WxCpCropCheckinOption.java +++ b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/oa/WxCpCropCheckinOption.java @@ -179,6 +179,9 @@ public class WxCpCropCheckinOption implements Serializable { private Integer offWorkIntervalTime; + /** + * The type Checkin date. + */ @Data public static class CheckinDate implements Serializable { private static final long serialVersionUID = -8560643656775167406L; @@ -219,6 +222,9 @@ public class WxCpCropCheckinOption implements Serializable { private Integer flexOffDutyTime; } + /** + * The type Checkin time. + */ @Data public static class CheckinTime implements Serializable { @@ -248,6 +254,9 @@ public class WxCpCropCheckinOption implements Serializable { private Integer remindOffWorkSec; } + /** + * The type Spe workday. + */ @Data public static class SpeWorkday implements Serializable { @@ -271,6 +280,9 @@ public class WxCpCropCheckinOption implements Serializable { private List checkinTime; } + /** + * The type Spe off day. + */ @Data public static class SpeOffDay implements Serializable { private static final long serialVersionUID = 9214798931489490993L; @@ -287,6 +299,9 @@ public class WxCpCropCheckinOption implements Serializable { private String notes; } + /** + * The type Wifi mac info. + */ @Data public static class WifiMacInfo implements Serializable { @@ -305,6 +320,9 @@ public class WxCpCropCheckinOption implements Serializable { private String wifimac; } + /** + * The type Loc info. + */ @Data public static class LocInfo implements Serializable { @@ -340,6 +358,9 @@ public class WxCpCropCheckinOption implements Serializable { private Integer distance; } + /** + * The type Range. + */ @Data public static class Range implements Serializable { @@ -366,6 +387,9 @@ public class WxCpCropCheckinOption implements Serializable { } + /** + * The type Reporter info. + */ @Data public static class ReporterInfo implements Serializable { private static final long serialVersionUID = 1132450350458936772L; @@ -382,6 +406,9 @@ public class WxCpCropCheckinOption implements Serializable { private long updateTime; } + /** + * The type Reporter. + */ @Data public static class Reporter implements Serializable { @@ -391,6 +418,9 @@ public class WxCpCropCheckinOption implements Serializable { private String userid; } + /** + * The type Ot info. + */ @Data public static class OtInfo implements Serializable { @@ -436,6 +466,9 @@ public class WxCpCropCheckinOption implements Serializable { private OtApplyInfo otapplyinfo; } + /** + * The type Ot check info. + */ @Data public static class OtCheckInfo implements Serializable { @@ -490,6 +523,9 @@ public class WxCpCropCheckinOption implements Serializable { private OtNonworkingDayRestInfo otNonworkingdayRestinfo; } + /** + * The type Ot working day rest info. + */ @Data public static class OtWorkingDayRestInfo implements Serializable { @@ -514,6 +550,9 @@ public class WxCpCropCheckinOption implements Serializable { private CalOtTimeRule calOttimeRule; } + /** + * The type Fix time rule. + */ @Data public static class FixTimeRule implements Serializable { @@ -532,6 +571,9 @@ public class WxCpCropCheckinOption implements Serializable { private Integer fixTimeEndSec; } + /** + * The type Cal ot time rule. + */ @Data public static class CalOtTimeRule implements Serializable { @@ -545,6 +587,9 @@ public class WxCpCropCheckinOption implements Serializable { } + /** + * The type Item. + */ @Data public static class Item implements Serializable { @@ -563,6 +608,9 @@ public class WxCpCropCheckinOption implements Serializable { private Integer restTime; } + /** + * The type Ot nonworking day rest info. + */ @Data public static class OtNonworkingDayRestInfo implements Serializable { @@ -587,6 +635,9 @@ public class WxCpCropCheckinOption implements Serializable { private CalOtTimeRule calOttimeRule; } + /** + * The type Ot apply info. + */ @Data public static class OtApplyInfo implements Serializable { @@ -630,6 +681,9 @@ public class WxCpCropCheckinOption implements Serializable { } + /** + * The type Schedule. + */ @Data public static class Schedule implements Serializable { @@ -710,6 +764,9 @@ public class WxCpCropCheckinOption implements Serializable { } + /** + * The type Time section. + */ @Data public static class TimeSection implements Serializable { private static final long serialVersionUID = 7497252128339062724L; @@ -764,6 +821,9 @@ public class WxCpCropCheckinOption implements Serializable { } + /** + * The type Late rule. + */ @Data public static class LateRule implements Serializable { @@ -783,6 +843,9 @@ public class WxCpCropCheckinOption implements Serializable { private List timerules; } + /** + * The type Time rule. + */ @Data public static class TimeRule implements Serializable { diff --git a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/oa/WxCpDialRecord.java b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/oa/WxCpDialRecord.java index 5ce27e8fe..f8c0956e2 100644 --- a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/oa/WxCpDialRecord.java +++ b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/oa/WxCpDialRecord.java @@ -9,8 +9,7 @@ import java.util.List; /** * 公费电话拨打记录. * - * @author Element - * created on 2019-04-06 15:38 + * @author Element created on 2019-04-06 15:38 */ @Data public class WxCpDialRecord implements Serializable { diff --git a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/oa/WxCpGetApprovalData.java b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/oa/WxCpGetApprovalData.java index 8385ab037..99d24b75a 100644 --- a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/oa/WxCpGetApprovalData.java +++ b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/oa/WxCpGetApprovalData.java @@ -31,6 +31,9 @@ public class WxCpGetApprovalData extends WxCpBaseResp implements Serializable { @SerializedName("data") private List data; + /** + * The type Approval data. + */ @Getter @Setter public static class ApprovalData implements Serializable { @@ -74,6 +77,9 @@ public class WxCpGetApprovalData extends WxCpBaseResp implements Serializable { } + /** + * The type Expense. + */ @Getter @Setter public static class Expense implements Serializable { @@ -90,6 +96,9 @@ public class WxCpGetApprovalData extends WxCpBaseResp implements Serializable { } + /** + * The type Comm. + */ @Getter @Setter public static class Comm implements Serializable { @@ -100,6 +109,9 @@ public class WxCpGetApprovalData extends WxCpBaseResp implements Serializable { } + /** + * The type Item. + */ @Getter @Setter public static class Item implements Serializable { @@ -119,6 +131,12 @@ public class WxCpGetApprovalData extends WxCpBaseResp implements Serializable { } + /** + * From json wx cp get approval data. + * + * @param json the json + * @return the wx cp get approval data + */ public static WxCpGetApprovalData fromJson(String json) { return WxCpGsonBuilder.create().fromJson(json, WxCpGetApprovalData.class); } diff --git a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/oa/WxCpOaApplyEventRequest.java b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/oa/WxCpOaApplyEventRequest.java index d6f800cf9..503a873b3 100644 --- a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/oa/WxCpOaApplyEventRequest.java +++ b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/oa/WxCpOaApplyEventRequest.java @@ -12,8 +12,7 @@ import java.util.List; /** * 提交审批申请 请求对象类. * - * @author Binary Wang - * created on 2020-07-18 + * @author Binary Wang created on 2020-07-18 */ @Data @Accessors(chain = true) @@ -68,10 +67,18 @@ public class WxCpOaApplyEventRequest implements Serializable { @SerializedName("summary_list") private List summaryList; + /** + * To json string. + * + * @return the string + */ public String toJson() { return WxCpGsonBuilder.create().toJson(this); } + /** + * The type Approver. + */ @Data @Accessors(chain = true) public static class Approver implements Serializable { @@ -89,6 +96,9 @@ public class WxCpOaApplyEventRequest implements Serializable { private String[] userIds; } + /** + * The type Apply data. + */ @Data @Accessors(chain = true) public static class ApplyData implements Serializable { diff --git a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/oa/WxCpOaSchedule.java b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/oa/WxCpOaSchedule.java index e61a8566b..53229cd81 100644 --- a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/oa/WxCpOaSchedule.java +++ b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/oa/WxCpOaSchedule.java @@ -12,8 +12,7 @@ import java.util.List; /** * 日程信息bean. * - * @author Binary Wang - * created on 2020-12-25 + * @author Binary Wang created on 2020-12-25 */ @Data @Accessors(chain = true) @@ -90,6 +89,9 @@ public class WxCpOaSchedule implements Serializable, ToJson { return WxCpGsonBuilder.create().toJson(this); } + /** + * The type Attendee. + */ @Data @Accessors(chain = true) public static class Attendee implements Serializable { @@ -112,6 +114,9 @@ public class WxCpOaSchedule implements Serializable, ToJson { private Integer responseStatus; } + /** + * The type Reminder. + */ @Data @Accessors(chain = true) public static class Reminder implements Serializable { diff --git a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/oa/WxCpSetCheckinSchedule.java b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/oa/WxCpSetCheckinSchedule.java index d34d233a3..13329659e 100644 --- a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/oa/WxCpSetCheckinSchedule.java +++ b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/oa/WxCpSetCheckinSchedule.java @@ -32,6 +32,9 @@ public class WxCpSetCheckinSchedule implements Serializable { private Integer yearmonth; + /** + * The type Item. + */ @Data public static class Item implements Serializable { diff --git a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/oa/WxCpTemplateResult.java b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/oa/WxCpTemplateResult.java index b8dd2dbe9..47c0448f8 100644 --- a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/oa/WxCpTemplateResult.java +++ b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/oa/WxCpTemplateResult.java @@ -11,7 +11,7 @@ import java.util.List; /** * 审批模板详情 * - * @author gyv12345@163.com + * @author gyv12345 @163.com */ @Data public class WxCpTemplateResult implements Serializable { diff --git a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/oa/WxCpUserVacationQuota.java b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/oa/WxCpUserVacationQuota.java index 159fcd694..419504554 100644 --- a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/oa/WxCpUserVacationQuota.java +++ b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/oa/WxCpUserVacationQuota.java @@ -22,6 +22,9 @@ public class WxCpUserVacationQuota extends WxCpBaseResp implements Serializable @SerializedName("lists") private List lists; + /** + * The type Vacation quota. + */ @Getter @Setter public static class VacationQuota implements Serializable { @@ -44,6 +47,12 @@ public class WxCpUserVacationQuota extends WxCpBaseResp implements Serializable } + /** + * From json wx cp user vacation quota. + * + * @param json the json + * @return the wx cp user vacation quota + */ public static WxCpUserVacationQuota fromJson(String json) { return WxCpGsonBuilder.create().fromJson(json, WxCpUserVacationQuota.class); } diff --git a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/oa/applydata/ApplyDataContent.java b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/oa/applydata/ApplyDataContent.java index f86ab966e..3ce66ea36 100644 --- a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/oa/applydata/ApplyDataContent.java +++ b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/oa/applydata/ApplyDataContent.java @@ -8,6 +8,8 @@ import java.io.Serializable; import java.util.List; /** + * The type Apply data content. + * * @author element */ @Data diff --git a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/oa/applydata/ContentTitle.java b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/oa/applydata/ContentTitle.java index 24d5fafc2..cfd0702a2 100644 --- a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/oa/applydata/ContentTitle.java +++ b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/oa/applydata/ContentTitle.java @@ -5,6 +5,8 @@ import lombok.Data; import java.io.Serializable; /** + * The type Content title. + * * @author element */ @Data diff --git a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/oa/applydata/ContentValue.java b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/oa/applydata/ContentValue.java index 1c97ce90e..db1e4cedd 100644 --- a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/oa/applydata/ContentValue.java +++ b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/oa/applydata/ContentValue.java @@ -8,6 +8,8 @@ import java.io.Serializable; import java.util.List; /** + * The type Content value. + * * @author element */ @Data @@ -48,6 +50,9 @@ public class ContentValue implements Serializable { @SerializedName("punch_correction") private PunchCorrection punchCorrection; + /** + * The type Date. + */ @Data public static class Date implements Serializable { private static final long serialVersionUID = -6181554080062231138L; @@ -57,12 +62,18 @@ public class ContentValue implements Serializable { private String timestamp; } + /** + * The type Selector. + */ @Data public static class Selector implements Serializable { private static final long serialVersionUID = 7305458759126951773L; private String type; private List