cn.felord.api.AsynchronousBatchImportApi 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.contactbook.async.BatchPartyRequest;
import cn.felord.domain.contactbook.async.BatchResultResponse;
import cn.felord.domain.contactbook.async.BatchUserRequest;
import retrofit2.http.Body;
import retrofit2.http.GET;
import retrofit2.http.POST;
import retrofit2.http.Query;
/**
* 异步导入接口
*
* @author n1
* @since 2021 /6/18 16:25
*/
public interface AsynchronousBatchImportApi {
/**
* 增量更新成员
*
* @param request the request
* @return the generic response
* @throws WeComException the weComException
*/
@POST("batch/syncuser")
GenericResponse batchSyncUser(@Body BatchUserRequest request) throws WeComException;
/**
* 全量覆盖成员
*
* @param request the request
* @return the generic response
* @throws WeComException the weComException
*/
@POST("batch/replaceuser")
GenericResponse batchSyncReplaceUser(@Body BatchUserRequest request) throws WeComException;
/**
* 全量覆盖部门
*
* @param request the request
* @return the generic response
* @throws WeComException the weComException
*/
@POST("batch/replaceparty")
GenericResponse batchSyncReplaceParty(@Body BatchPartyRequest request) throws WeComException;
/**
* 获取异步任务结果
*
* @param jobId the job id
* @return the result
* @throws WeComException the weComException
*/
@GET("batch/getresult")
BatchResultResponse getResult(@Query("jobid") String jobId) throws WeComException;
}