me.chanjar.weixin.cp.api.WxCpOaWeDocService Maven / Gradle / Ivy
package me.chanjar.weixin.cp.api;
import lombok.NonNull;
import me.chanjar.weixin.common.error.WxErrorException;
import me.chanjar.weixin.cp.bean.WxCpBaseResp;
import me.chanjar.weixin.cp.bean.oa.doc.*;
/**
* 企业微信文档相关接口.
* 文档
*
* @author Hugo
*/
public interface WxCpOaWeDocService {
/**
* 新建文档
* 该接口用于新建文档和表格，新建收集表可前往 收集表管理 查看。
*
* 请求方式：POST（HTTPS）
* 请求地址: https://qyapi.weixin.qq.com/cgi-bin/wedoc/create_doc?access_token=ACCESS_TOKEN
*
* @param request 新建文档对应请求参数
* @return url：新建文档的访问链接，docid：新建文档的docid
* @throws WxErrorException the wx error exception
*/
WxCpDocCreateData docCreate(@NonNull WxCpDocCreateRequest request) throws WxErrorException;
/**
* 重命名文档/收集表
* 该接口用于对指定文档/收集表进行重命名。
*
* 请求方式：POST（HTTPS）
* 请求地址: https://qyapi.weixin.qq.com/cgi-bin/wedoc/rename_doc?access_token=ACCESS_TOKEN
*
* @param request 重命名文档/收集表
* @return wx cp base resp
* @throws WxErrorException the wx error exception
*/
WxCpBaseResp docRename(@NonNull WxCpDocRenameRequest request) throws WxErrorException;
/**
* 删除文档/收集表
* 该接口用于删除指定文档/收集表。
*
* 请求方式：POST（HTTPS）
* 请求地址: https://qyapi.weixin.qq.com/cgi-bin/wedoc/del_doc?access_token=ACCESS_TOKEN
*
* @param docId 文档docid（docid、formid只能填其中一个）
* @param formId 收集表id（docid、formid只能填其中一个）
* @return wx cp base resp
* @throws WxErrorException the wx error exception
*/
WxCpBaseResp docDelete(String docId, String formId) throws WxErrorException;
/**
* 获取文档基础信息
* 该接口用于获取指定文档的基础信息。
*
* 请求方式：POST（HTTPS）
* 请求地址: https://qyapi.weixin.qq.com/cgi-bin/wedoc/get_doc_base_info?access_token=ACCESS_TOKEN
*
* @param docId 文档docid
* @return wx cp doc info
* @throws WxErrorException the wx error exception
*/
WxCpDocInfo docInfo(@NonNull String docId) throws WxErrorException;
/**
* 分享文档
* 该接口用于获取文档的分享链接。
*
* 请求方式：POST（HTTPS）
* 请求地址: https://qyapi.weixin.qq.com/cgi-bin/wedoc/doc_share?access_token=ACCESS_TOKEN
*
* @param docId 文档docid
* @return url 文档分享链接
* @throws WxErrorException the wx error exception
*/
WxCpDocShare docShare(@NonNull String docId) throws WxErrorException;
}