cn.felord.api.DocApi Maven / Gradle / Ivy
/*
* Copyright (c) 2023. felord.cn
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
* https://www.apache.org/licenses/LICENSE-2.0
* Website:
* https://felord.cn
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package cn.felord.api;
import cn.felord.WeComException;
import cn.felord.domain.GenericResponse;
import cn.felord.domain.WeComResponse;
import cn.felord.domain.common.FormId;
import cn.felord.domain.wedoc.doc.*;
import retrofit2.http.Body;
import retrofit2.http.POST;
/**
* 文档-管理文档
*
* @author dax
* @since 2024/7/19
*/
public interface DocApi {
/**
* 新建文档
*
* 该接口用于新建文档和表格，新建收集表可前往{@link FormApi}查看。
*
* @param request the request
* @return the create doc response
*/
@POST("wedoc/create_doc")
CreateDocResponse createDoc(@Body CreateDocRequest request) throws WeComException;
/**
* 重命名文档
*
* @param docId the doc id
* @return the we com response
*/
@POST("wedoc/rename_doc")
WeComResponse renameDoc(@Body DocId docId) throws WeComException;
/**
* 重命名收集表
*
* @param docId the doc id
* @return the we com response
*/
@POST("wedoc/rename_doc")
WeComResponse renameDoc(@Body FormId docId) throws WeComException;
/**
* 删除文档
*
* @param docId the doc id
* @return the we com response
*/
@POST("wedoc/del_doc")
WeComResponse delDoc(@Body DocId docId) throws WeComException;
/**
* 删除收集表
*
* @param formId the form id
* @return the we com response
*/
@POST("wedoc/del_doc")
WeComResponse delDoc(@Body FormId formId) throws WeComException;
/**
* 获取文档基础信息
*
* - 自建应用需配置到“可调用应用”列表中的应用secret所获取的accesstoken来调用
* - 第三方应用需具有“文档”权限
* - 代开发自建应用需具有“文档”权限
*
*
* @param docId the doc id
* @return the doc base info
*/
@POST("wedoc/get_doc_base_info")
GenericResponse getDocBaseInfo(@Body DocId docId) throws WeComException;
/**
* 分享文档
*
* @param docId the doc id
* @return the we com response
*/
@POST("wedoc/doc_share")
GenericResponse docShare(@Body DocId docId) throws WeComException;
/**
* 分享收集表
*
* @param formId the form id
* @return the we com response
*/
@POST("wedoc/doc_share")
GenericResponse docShare(@Body FormId formId) throws WeComException;
/**
* 获取文档权限信息
*
* @param docId the doc id
* @return the doc auth response
*/
@POST("wedoc/doc_get_auth")
DocAuthResponse docGetAuth(@Body DocId docId) throws WeComException;
/**
* 修改文档查看规则
*
* @param request the request
* @return the we com response
*/
@POST("wedoc/mod_doc_join_rule")
WeComResponse modDocJoinRule(@Body AccessRuleUpdateRequest request) throws WeComException;
/**
* 修改文档通知范围及权限
*
* @param request the request
* @return the we com response
*/
@POST("wedoc/mod_doc_member")
WeComResponse modDocMember(@Body FileMemberUpdateRequest request) throws WeComException;
/**
* 修改文档安全设置
*
* @param setting the setting
* @return the we com response
*/
@POST("wedoc/mod_doc_safty_setting")
WeComResponse modDocSaftySetting(@Body DocSecuritySetting setting) throws WeComException;
}