com.icthh.xm.commons.gen.api.TenantsApi Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of xm-commons-tenant-endpoint Show documentation
xm-commons-tenant-endpoint
The newest version!
/**
 * NOTE: This class is auto generated by the swagger code generator program (2.4.37).
 * https://github.com/swagger-api/swagger-codegen
 * Do not edit the class manually.
 */
package com.icthh.xm.commons.gen.api;

import com.icthh.xm.commons.gen.model.Tenant;
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 jakarta.validation.Valid;
import jakarta.validation.constraints.*;
import java.util.List;
@jakarta.annotation.Generated(value = "io.swagger.codegen.languages.SpringCodegen", date = "2024-12-20T09:51:47.961Z")

@Validated
@Api(value = "tenants", description = "the tenants API")
@RequestMapping(value = "/api")
public interface TenantsApi {

    @ApiOperation(value = "Create tenant", nickname = "addTenant", notes = "", tags={ "tenant", })
    @ApiResponses(value = { 
        @ApiResponse(code = 200, message = "Tenant create successful"),
        @ApiResponse(code = 401, message = "Unauthorized"),
        @ApiResponse(code = 403, message = "Forbidden"),
        @ApiResponse(code = 404, message = "Not Found") })
    @RequestMapping(value = "/tenants",
        produces = { "application/json" }, 
        consumes = { "application/json" },
        method = RequestMethod.POST)
    ResponseEntity addTenant(@ApiParam(value = "Tenant object that needs to be added to the store" ,required=true )  @Valid @RequestBody Tenant body);


    @ApiOperation(value = "Delete tenant by passed name", nickname = "deleteTenant", notes = "", tags={ "tenant", })
    @ApiResponses(value = { 
        @ApiResponse(code = 200, message = "Tenant delete successful"),
        @ApiResponse(code = 401, message = "Unauthorized"),
        @ApiResponse(code = 403, message = "Forbidden"),
        @ApiResponse(code = 404, message = "Not Found") })
    @RequestMapping(value = "/tenants/{tenantKey}",
        method = RequestMethod.DELETE)
    ResponseEntity deleteTenant(@ApiParam(value = "Name of tenant to delete",required=true) @PathVariable("tenantKey") String tenantKey);


    @ApiOperation(value = "Get all tenant info", nickname = "getAllTenantInfo", notes = "", response = Tenant.class, responseContainer = "List", tags={ "tenant", })
    @ApiResponses(value = { 
        @ApiResponse(code = 200, message = "successful operation", response = Tenant.class, responseContainer = "List"),
        @ApiResponse(code = 401, message = "Unauthorized"),
        @ApiResponse(code = 403, message = "Forbidden"),
        @ApiResponse(code = 404, message = "Not Found") })
    @RequestMapping(value = "/tenants",
        produces = { "application/json" }, 
        method = RequestMethod.GET)
    ResponseEntity> getAllTenantInfo();


    @ApiOperation(value = "Get tenant info by name", nickname = "getTenant", notes = "Request return tenants info which find by passed tenants name", response = Tenant.class, tags={ "tenant", })
    @ApiResponses(value = { 
        @ApiResponse(code = 200, message = "Tenant delete successful", response = Tenant.class),
        @ApiResponse(code = 401, message = "Unauthorized"),
        @ApiResponse(code = 403, message = "Forbidden"),
        @ApiResponse(code = 404, message = "Not Found") })
    @RequestMapping(value = "/tenants/{tenantKey}",
        produces = { "application/json" }, 
        method = RequestMethod.GET)
    ResponseEntity getTenant(@ApiParam(value = "Name of tenant to find",required=true) @PathVariable("tenantKey") String tenantKey);


    @ApiOperation(value = "Tenant management", nickname = "manageTenant", notes = "Request for managing tenants info by passed tenant name", tags={ "tenant", })
    @ApiResponses(value = { 
        @ApiResponse(code = 200, message = "Tenant changed successful"),
        @ApiResponse(code = 401, message = "Unauthorized"),
        @ApiResponse(code = 403, message = "Forbidden"),
        @ApiResponse(code = 404, message = "Not Found") })
    @RequestMapping(value = "/tenants/{tenantKey}",
        consumes = { "application/json" },
        method = RequestMethod.PUT)
    ResponseEntity manageTenant(@ApiParam(value = "Name of tenant to manage",required=true) @PathVariable("tenantKey") String tenantKey,@ApiParam(value = "Updated status for tenant" ,required=true )  @Valid @RequestBody String body);

}