roomescape-refactored/src/main/kotlin/roomescape/reservation/docs/ReservationAPI.kt

package roomescape.reservation.docs

import io.swagger.v3.oas.annotations.Operation
import io.swagger.v3.oas.annotations.Parameter
import io.swagger.v3.oas.annotations.headers.Header
import io.swagger.v3.oas.annotations.media.Schema
import io.swagger.v3.oas.annotations.responses.ApiResponse
import io.swagger.v3.oas.annotations.responses.ApiResponses
import io.swagger.v3.oas.annotations.tags.Tag
import jakarta.validation.Valid
import org.springframework.http.HttpHeaders
import org.springframework.http.ResponseEntity
import org.springframework.web.bind.annotation.PathVariable
import org.springframework.web.bind.annotation.RequestBody
import org.springframework.web.bind.annotation.RequestParam
import roomescape.auth.web.support.Admin
import roomescape.auth.web.support.LoginRequired
import roomescape.auth.web.support.MemberId
import roomescape.common.dto.response.CommonApiResponse
import roomescape.reservation.web.*
import java.time.LocalDate

@Tag(name = "3. 예약 API", description = "예약 및 대기 정보를 추가 / 조회 / 삭제할 때 사용합니다.")
interface ReservationAPI {

    @Admin
    @Operation(summary = "모든 예약 정보 조회", tags = ["관리자 로그인이 필요한 API"])
    @ApiResponses(ApiResponse(responseCode = "200", description = "성공", useReturnTypeSchema = true))
    fun findReservations(): ResponseEntity<CommonApiResponse<ReservationRetrieveListResponse>>

    @LoginRequired
    @Operation(summary = "자신의 예약 및 대기 조회", tags = ["로그인이 필요한 API"])
    @ApiResponses(ApiResponse(responseCode = "200", description = "성공", useReturnTypeSchema = true))
    fun findReservationsByMemberId(
            @MemberId @Parameter(hidden = true) memberId: Long
    ): ResponseEntity<CommonApiResponse<MyReservationRetrieveListResponse>>

    @Admin
    @Operation(summary = "관리자의 예약 검색", description = "특정 조건에 해당되는 예약 검색", tags = ["관리자 로그인이 필요한 API"])
    @ApiResponses(
            ApiResponse(responseCode = "200", description = "성공", useReturnTypeSchema = true)
    )
    fun searchReservations(
            @RequestParam(required = false) themeId: Long?,
            @RequestParam(required = false) memberId: Long?,
            @RequestParam(required = false) dateFrom: LocalDate?,
            @RequestParam(required = false) dateTo: LocalDate?
    ): ResponseEntity<CommonApiResponse<ReservationRetrieveListResponse>>

    @Admin
    @Operation(summary = "관리자의 예약 취소", tags = ["관리자 로그인이 필요한 API"])
    @ApiResponses(
            ApiResponse(responseCode = "204", description = "성공"),
    )
    fun cancelReservationByAdmin(
            @MemberId @Parameter(hidden = true) memberId: Long,
            @PathVariable("id") reservationId: Long
    ): ResponseEntity<CommonApiResponse<Unit>>

    @LoginRequired
    @Operation(summary = "예약 추가", tags = ["로그인이 필요한 API"])
    @ApiResponses(
            ApiResponse(
                    responseCode = "201",
                    description = "성공",
                    useReturnTypeSchema = true,
                    headers = [Header(name = HttpHeaders.LOCATION, description = "생성된 예약 정보 URL", schema = Schema(example = "/reservations/1"))]
            )
    )
    fun createReservationWithPayment(
            @Valid @RequestBody reservationCreateWithPaymentRequest: ReservationCreateWithPaymentRequest,
            @MemberId @Parameter(hidden = true) memberId: Long
    ): ResponseEntity<CommonApiResponse<ReservationRetrieveResponse>>

    @Admin
    @Operation(summary = "관리자 예약 추가", tags = ["관리자 로그인이 필요한 API"])
    @ApiResponses(
            ApiResponse(
                    responseCode = "201",
                    description = "성공",
                    useReturnTypeSchema = true,
                    headers = [Header(name = HttpHeaders.LOCATION, description = "생성된 예약 정보 URL", schema = Schema(example = "/reservations/1"))],
            )
    )
    fun createReservationByAdmin(
            @Valid @RequestBody adminReservationRequest: AdminReservationCreateRequest,
    ): ResponseEntity<CommonApiResponse<ReservationRetrieveResponse>>

    @Admin
    @Operation(summary = "모든 예약 대기 조회", tags = ["관리자 로그인이 필요한 API"])
    @ApiResponses(ApiResponse(responseCode = "200", description = "성공", useReturnTypeSchema = true))
    fun findAllWaiting(): ResponseEntity<CommonApiResponse<ReservationRetrieveListResponse>>

    @LoginRequired
    @Operation(summary = "예약 대기 신청", tags = ["로그인이 필요한 API"])
    @ApiResponses(
            ApiResponse(
                    responseCode = "201",
                    description = "성공",
                    useReturnTypeSchema = true,
                    headers = [Header(name = HttpHeaders.LOCATION, description = "생성된 예약 정보 URL", schema = Schema(example = "/reservations/1"))]
            )
    )
    fun createWaiting(
            @Valid @RequestBody waitingCreateRequest: WaitingCreateRequest,
            @MemberId @Parameter(hidden = true) memberId: Long,
    ): ResponseEntity<CommonApiResponse<ReservationRetrieveResponse>>

    @LoginRequired
    @Operation(summary = "예약 대기 취소", tags = ["로그인이 필요한 API"])
    @ApiResponses(
            ApiResponse(responseCode = "204", description = "성공"),
    )
    fun cancelWaitingByMember(
            @MemberId @Parameter(hidden = true) memberId: Long,
            @PathVariable("id") @Parameter(description = "예약 ID") reservationId: Long
    ): ResponseEntity<CommonApiResponse<Unit>>

    @Admin
    @Operation(summary = "대기 중인 예약 승인", tags = ["관리자 로그인이 필요한 API"])
    @ApiResponses(
            ApiResponse(responseCode = "200", description = "성공"),
    )
    fun confirmWaiting(
            @MemberId @Parameter(hidden = true) memberId: Long,
            @PathVariable("id") @Parameter(description = "예약 ID") reservationId: Long
    ): ResponseEntity<CommonApiResponse<Unit>>

    @Admin
    @Operation(summary = "대기 중인 예약 거절", tags = ["관리자 로그인이 필요한 API"])
    @ApiResponses(
            ApiResponse(responseCode = "204", description = "대기 중인 예약 거절 성공"),
    )
    fun rejectWaiting(
            @MemberId @Parameter(hidden = true) memberId: Long,
            @PathVariable("id") @Parameter(description = "예약 ID") reservationId: Long
    ): ResponseEntity<CommonApiResponse<Unit>>
}