cn.felord.api.ApprovalApi 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.approval.*;
import cn.felord.domain.common.TemplateId;
import cn.felord.domain.common.UserId;
import retrofit2.http.Body;
import retrofit2.http.POST;
import java.util.List;
/**
* 企业微信审批
*
* @author dax
* @since 2024 /5/25 14:18
*/
public interface ApprovalApi {
/**
* 获取审批模板详情
*
* @param templateId the template id
* @return the detail
* @throws WeComException the weComException
*/
@POST("oa/gettemplatedetail")
ApprovalTmpDetailResponse getTemplateDetail(@Body TemplateId templateId) throws WeComException;
/**
* 创建审批模板
*
* 仅『审批』系统应用、自建应用和代开发自建应用可调用。
*
* @param template the template
* @return the generic response
* @throws WeComException the weComException
*/
@POST("oa/approval/create_template")
GenericResponse createTemplate(@Body ApprovalTempAddRequest template) throws WeComException;
/**
* 更新审批模板
*
* 可调用本接口更新审批模板。更新模板后，管理后台及审批应用内将更新原模板的内容，已配置的审批流程和规则不变。
*
* - 仅『审批』系统应用，自建应用和代开发自建应用可调用
* - 所有应用都可以通过本接口更新自己的模板
* - 『审批』系统应用可以修改管理员手动创建的模板
* - 自建应用和代开发自建应用不可通过本接口更新其他应用创建的模板
*
*
* @param template the template
* @return the we com response
* @throws WeComException the weComException
*/
@POST("oa/approval/update_template")
WeComResponse updateTemplate(@Body ApprovalTempUpdateRequest template) throws WeComException;
/**
* 提交审批申请
*
* 暂不支持通过接口提交[打卡补卡][调班]模板审批单
*
* @param request the request
* @return the generic response
* @throws WeComException the weComException
* @deprecated 使用未过时接口替代
*/
@POST("oa/applyevent")
@Deprecated
GenericResponse applyEvent(@Body ApprovalApplyRequest request) throws WeComException;
/**
* 提交审批申请
*
* @param request the request
* @return the generic response
* @throws WeComException the we com exception
* @since 1.2.7
*/
@POST("oa/applyevent")
GenericResponse applyEvent(@Body ProcessApplyRequest request) throws WeComException;
/**
* 批量获取审批单号
*
* 一次拉取调用最多拉取100个审批记录，可以通过多次拉取的方式来满足需求。
*
* - 接口频率限制 600次/分钟
* - 请求的参数endtime需要大于startime， 起始时间跨度不能超过31天
*
*
* @param request the request
* @return the sp no list response
* @throws WeComException the weComException
*/
@POST("oa/getapprovalinfo")
SpNoListResponse getApprovalInfo(@Body SpNoListRequest request) throws WeComException;
/**
* 获取审批申请详情
* sp_no
*
* @param spNo the sp no
* @return sp no list response
* @throws WeComException the weComException
*/
@POST("oa/getapprovaldetail")
GenericResponse getApprovalDetail(@Body ApprovalSpNo spNo) throws WeComException;
/**
* 查询自建应用审批单当前状态
*
* @param thirdNo the third no thirdNo
* @return the generic response
* @throws WeComException the weComException
*/
@POST("corp/getopenapprovaldata")
GenericResponse getOpenApprovalData(@Body ApprovalThirdNo thirdNo) throws WeComException;
/**
* 获取成员假期余额
*
* 数据来源为人事助手-假期管理
*
* @param userId the user id
* @return the user vacation quota
* @throws WeComException the weComException
*/
@POST("oa/vacation/getuservacationquota")
GenericResponse> getUserVacationQuota(@Body UserId userId) throws WeComException;
/**
* 修改成员假期余额
*
* @param request the request
* @return the one user quota
* @throws WeComException the weComException
*/
@POST("oa/vacation/setoneuserquota")
WeComResponse setOneUserQuota(@Body UserQuotaSettingRequest request) throws WeComException;
}