package com.tashow.cloud.systemapi.api.sms;

import com.tashow.cloud.common.pojo.CommonResult;
import com.tashow.cloud.systemapi.api.sms.dto.code.SmsCodeSendReqDTO;
import com.tashow.cloud.systemapi.api.sms.dto.code.SmsCodeUseReqDTO;
import com.tashow.cloud.systemapi.api.sms.dto.code.SmsCodeValidateReqDTO;
import com.tashow.cloud.systemapi.enums.ApiConstants;
import jakarta.validation.Valid;
import org.springframework.cloud.openfeign.FeignClient;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.bind.annotation.PutMapping;
import org.springframework.web.bind.annotation.RequestBody;

@FeignClient(name = ApiConstants.NAME) // TODO 芋艿：fallbackFactory =
/** RPC 服务 - 短信验证码 */
public interface SmsCodeApi {

  String PREFIX = ApiConstants.PREFIX + "/oauth2/sms/code";

  @PostMapping(PREFIX + "/send")
  /** 创建短信验证码，并进行发送 */
  CommonResult<Boolean> sendSmsCode(@Valid @RequestBody SmsCodeSendReqDTO reqDTO);

  @PutMapping(PREFIX + "/use")
  /** 验证短信验证码，并进行使用 */
  CommonResult<Boolean> useSmsCode(@Valid @RequestBody SmsCodeUseReqDTO reqDTO);

  @GetMapping(PREFIX + "/validate")
  /** 检查验证码是否有效 */
  CommonResult<Boolean> validateSmsCode(@Valid @RequestBody SmsCodeValidateReqDTO reqDTO);
}
