package cn.iocoder.byzs.module.system.service.invitecode;

import cn.iocoder.byzs.framework.common.pojo.PageResult;
import cn.iocoder.byzs.module.system.controller.admin.invitecode.vo.InviteCodePageReqVO;
import cn.iocoder.byzs.module.system.controller.admin.invitecode.vo.InviteCodeRespVO;
import cn.iocoder.byzs.module.system.controller.admin.invitecode.vo.InviteCodeSaveReqVO;
import cn.iocoder.byzs.module.system.dal.dataobject.invitecode.InviteCodeDO;
import jakarta.validation.Valid;

import java.util.List;

/**
 * 邀请码 Service 接口
 *
 * @author lyb
 */
public interface InviteCodeService {

    /**
     * 创建邀请码
     *
     * @param createReqVO 创建信息
     * @return 编号
     */
    Long createInviteCode(@Valid InviteCodeSaveReqVO createReqVO);

    /**
     * 更新邀请码
     *
     * @param updateReqVO 更新信息
     */
    void updateInviteCode(@Valid InviteCodeSaveReqVO updateReqVO);

    /**
     * 删除邀请码
     *
     * @param id 编号
     */
    void deleteInviteCode(Long id);

    /**
    * 批量删除邀请码
    *
    * @param ids 编号
    */
    void deleteInviteCodeListByIds(List<Long> ids);

    /**
     * 获得邀请码
     *
     * @param id 编号
     * @return 邀请码
     */
    InviteCodeDO getInviteCode(Long id);

    /**
     * 获得指定邀请码(未使用)
     *
     * @param inviteCode 邀请码
     * @return 邀请码
     */
    InviteCodeDO getUnusedInviteCode(String inviteCode);

    /**
     * 获得用户激活的邀请码
     *
     * @param useUserId 使用用户id
     * @return 邀请码
     */
    List<InviteCodeDO> getInviteCodeByUserId(Long useUserId);

    /**
     * 获得邀请码分页
     *
     * @param pageReqVO 分页查询
     * @return 邀请码分页
     */
    PageResult<InviteCodeRespVO> getInviteCodePage(InviteCodePageReqVO pageReqVO);

}