/**
 * NOTE: This class is auto generated by the swagger code generator program (2.4.7).
 * https://github.com/swagger-api/swagger-codegen
 * Do not edit the class manually.
 */
package io.swagger.api;

import java.math.BigDecimal;
import io.swagger.model.GetUser;
import io.swagger.model.LoginUserDto;
import io.swagger.model.ModelApiResponse;
import io.swagger.model.RegisterUserDto;
import io.swagger.annotations.*;
import org.springframework.http.ResponseEntity;
import org.springframework.validation.annotation.Validated;
import org.springframework.web.bind.annotation.PathVariable;
import org.springframework.web.bind.annotation.RequestBody;
import org.springframework.web.bind.annotation.RequestHeader;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestMethod;
import org.springframework.web.bind.annotation.RequestParam;
import org.springframework.web.bind.annotation.RequestPart;
import org.springframework.web.multipart.MultipartFile;

import javax.validation.Valid;
import javax.validation.constraints.*;
import java.util.List;
@javax.annotation.Generated(value = "io.swagger.codegen.languages.SpringCodegen", date = "2020-03-21T15:10:52.859+01:00")

@Api(value = "user", description = "the user API")
public interface UserApi {

    @ApiOperation(value = "Get user by user name", nickname = "getUserById", notes = "", response = GetUser.class, authorizations = {
        @Authorization(value = "whatisleft_auth", scopes = {
            @AuthorizationScope(scope = "logged", description = "Logged user"),
            @AuthorizationScope(scope = "admin", description = "Logged as admin.")
            })
    }, tags={ "user", })
    @ApiResponses(value = {
        @ApiResponse(code = 200, message = "User fetched succesfully", response = GetUser.class),
        @ApiResponse(code = 400, message = "Invalid username supplied"),
        @ApiResponse(code = 401, message = "You are not allowed to fetch user information's."),
        @ApiResponse(code = 404, message = "User not found") })
    @RequestMapping(value = "/user/{userId}",
        produces = { "application/json" },
        method = RequestMethod.GET)
    ResponseEntity<GetUser> getUserById(@ApiParam(value = "Id of user that should be fetched.",required=true) @PathVariable("userId") BigDecimal userId);


    @ApiOperation(value = "Updated user", nickname = "updateUser", notes = "This can only be done by the logged in user.", response = GetUser.class, authorizations = {
        @Authorization(value = "whatisleft_auth", scopes = {
            @AuthorizationScope(scope = "logged", description = "Logged user"),
            @AuthorizationScope(scope = "admin", description = "Logged as admin.")
            })
    }, tags={ "user", })
    @ApiResponses(value = {
        @ApiResponse(code = 200, message = "User removed succesfully", response = GetUser.class),
        @ApiResponse(code = 400, message = "Invalid user supplied"),
        @ApiResponse(code = 401, message = "You are not allowed to edit user information's."),
        @ApiResponse(code = 404, message = "User not found") })
    @RequestMapping(value = "/user/{userId}",
        produces = { "application/json" },
        method = RequestMethod.PUT)
    ResponseEntity<GetUser> updateUser(@ApiParam(value = "Id of user who's information should be changed",required=true) @PathVariable("userId") BigDecimal userId,@ApiParam(value = "Updated user object" ,required=true )  @Valid @RequestBody GetUser body);


    @ApiOperation(value = "Logs user into the system by registered account", nickname = "userLoginGet", notes = "", tags={ "user", })
    @ApiResponses(value = {
        @ApiResponse(code = 200, message = "Logged in"),
        @ApiResponse(code = 400, message = "Check your email or password."),
        @ApiResponse(code = 404, message = "User not found") })
    @RequestMapping(value = "/user/login",
        produces = { "application/json" },
        method = RequestMethod.POST)
    ResponseEntity<Void> userLoginPost(@ApiParam(value = "Login user dto"  )  @Valid @RequestBody LoginUserDto payload);


    @ApiOperation(value = "Create new user", nickname = "userRegisterPost", notes = "", tags={ "user", })
    @ApiResponses(value = {
        @ApiResponse(code = 201, message = "User Created"),
        @ApiResponse(code = 400, message = "Passed data is invalid.", response = ModelApiResponse.class) })
    @RequestMapping(value = "/user/register",
        produces = { "application/json" },
        consumes = { "application/json" },
        method = RequestMethod.POST)
    ResponseEntity<Void> userRegisterPost(@ApiParam(value = "Register user dto"  )  @Valid @RequestBody RegisterUserDto payload);


    @ApiOperation(value = "Delete user", nickname = "userUserIdDelete", notes = "", authorizations = {
        @Authorization(value = "whatisleft_auth", scopes = {
            @AuthorizationScope(scope = "admin", description = "Logged as admin.")
            })
    }, tags={ "user", })
    @ApiResponses(value = {
        @ApiResponse(code = 204, message = "User removed successfully"),
        @ApiResponse(code = 400, message = "Id is invalid"),
        @ApiResponse(code = 401, message = "You are not allowed to delete user."),
        @ApiResponse(code = 404, message = "User not found") })
    @RequestMapping(value = "/user/{userId}",
        produces = { "application/json" },
        method = RequestMethod.DELETE)
    ResponseEntity<Void> userUserIdDelete(@ApiParam(value = "User's Id who will be removed",required=true) @PathVariable("userId") BigDecimal userId);

}