package org.wfc.omada.api.sitesetting;

import io.swagger.annotations.Api;
import io.swagger.annotations.ApiOperation;
import io.swagger.annotations.ApiParam;
import io.swagger.annotations.ApiResponse;
import io.swagger.annotations.ApiResponses;
import org.springframework.cloud.openfeign.FeignClient;
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.RequestMapping;
import org.springframework.web.bind.annotation.RequestMethod;
import org.springframework.web.bind.annotation.RequestParam;
import org.wfc.omada.config.FeignConfig;
import org.wfc.omada.api.sitesetting.model.BandwidthControl;
import org.wfc.omada.api.sitesetting.model.BandwidthControlRule;
import org.wfc.omada.api.sitesetting.model.OperationResponseBandwidthControl;
import org.wfc.omada.api.sitesetting.model.OperationResponseGridVoBandwidthControlRule;
import org.wfc.omada.api.sitesetting.model.OperationResponseWithoutResult;
import org.wfc.omada.api.sitesetting.model.TransmissionDragSortIndexOpenapiVo;

import javax.validation.Valid;
import javax.validation.constraints.NotNull;
@javax.annotation.Generated(value = "org.openapitools.codegen.languages.SpringCodegen", date = "2024-12-04T11:31:51.978+08:00[Asia/Shanghai]")

@Validated
@Api(value = "OmadaBandwidthControl", description = "the OmadaBandwidthControl API")
@FeignClient(name="OmadaBandwidthControlApi", url = "${omada.omada-url}", configuration = FeignConfig.class)
public interface OmadaBandwidthControlApi {

    /**
     * POST /openapi/v1/{omadacId}/sites/{siteId}/bandwidth-control/rules : Create bandwidth control rule
     * Create bandwidth control rule.&lt;br/&gt;&lt;br/&gt;The interface requires one of the permissions: &lt;br/&gt;Site Settings Manager Modify
     *
     * @param omadacId Omada ID (required)
     * @param siteId Site ID (required)
     * @param bandwidthControlRule  (optional)
     * @return OK (status code 200)
     */
    @ApiOperation(value = "Create bandwidth control rule", nickname = "createBandwidthCtrlRule", notes = "Create bandwidth control rule.<br/><br/>The interface requires one of the permissions: <br/>Site Settings Manager Modify", response = OperationResponseWithoutResult.class, tags={ "Omada/Bandwidth Control","Bandwidth Control", })
    @ApiResponses(value = { 
        @ApiResponse(code = 200, message = "OK", response = OperationResponseWithoutResult.class) })
    @RequestMapping(value = "/openapi/v1/${omada.omadac-id}/sites/{siteId}/bandwidth-control/rules",
        produces = "*/*", 
        consumes = "application/json",
        method = RequestMethod.POST)
    ResponseEntity<OperationResponseWithoutResult> createBandwidthCtrlRule(@ApiParam(value = "Site ID",required=true) @PathVariable("siteId") String siteId,@ApiParam(value = ""  )  @Valid @RequestBody(required = false) BandwidthControlRule bandwidthControlRule);


    /**
     * DELETE /openapi/v1/{omadacId}/sites/{siteId}/bandwidth-control/rules/{ruleId} : Delete bandwidth control rule
     * Delete bandwidth control rule.&lt;br/&gt;&lt;br/&gt;The interface requires one of the permissions: &lt;br/&gt;Site Settings Manager Modify
     *
     * @param omadacId Omada ID (required)
     * @param siteId Site ID (required)
     * @param ruleId Bandwidth control rule ID (required)
     * @return OK (status code 200)
     */
    @ApiOperation(value = "Delete bandwidth control rule", nickname = "deleteBandwidthCtrlRule", notes = "Delete bandwidth control rule.<br/><br/>The interface requires one of the permissions: <br/>Site Settings Manager Modify", response = OperationResponseWithoutResult.class, tags={ "Omada/Bandwidth Control","Bandwidth Control", })
    @ApiResponses(value = { 
        @ApiResponse(code = 200, message = "OK", response = OperationResponseWithoutResult.class) })
    @RequestMapping(value = "/openapi/v1/${omada.omadac-id}/sites/{siteId}/bandwidth-control/rules/{ruleId}",
        produces = "*/*", 
        method = RequestMethod.DELETE)
    ResponseEntity<OperationResponseWithoutResult> deleteBandwidthCtrlRule(@ApiParam(value = "Site ID",required=true) @PathVariable("siteId") String siteId,@ApiParam(value = "Bandwidth control rule ID",required=true) @PathVariable("ruleId") String ruleId);


    /**
     * GET /openapi/v1/{omadacId}/sites/{siteId}/bandwidth-control : Get bandwidth control
     * Get bandwidth control.&lt;br/&gt;&lt;br/&gt;The interface requires one of the permissions: &lt;br/&gt;Site Settings Manager View Only
     *
     * @param omadacId Omada ID (required)
     * @param siteId Site ID (required)
     * @return OK (status code 200)
     */
    @ApiOperation(value = "Get bandwidth control", nickname = "getBandwidthCtrl", notes = "Get bandwidth control.<br/><br/>The interface requires one of the permissions: <br/>Site Settings Manager View Only", response = OperationResponseBandwidthControl.class, tags={ "Omada/Bandwidth Control","Bandwidth Control", })
    @ApiResponses(value = { 
        @ApiResponse(code = 200, message = "OK", response = OperationResponseBandwidthControl.class) })
    @RequestMapping(value = "/openapi/v1/${omada.omadac-id}/sites/{siteId}/bandwidth-control",
        produces = "*/*", 
        method = RequestMethod.GET)
    ResponseEntity<OperationResponseBandwidthControl> getBandwidthCtrl(@ApiParam(value = "Site ID",required=true) @PathVariable("siteId") String siteId);


    /**
     * GET /openapi/v1/{omadacId}/sites/{siteId}/bandwidth-control/rules : Get bandwidth control rule list
     * Get bandwidth control rule list.&lt;br/&gt;&lt;br/&gt;The interface requires one of the permissions: &lt;br/&gt;Site Settings Manager View Only
     *
     * @param omadacId Omada ID (required)
     * @param siteId Site ID (required)
     * @param page Start page number. Start from 1. (required)
     * @param pageSize Number of entries per page. It should be within the range of 1–1000. (required)
     * @return OK (status code 200)
     */
    @ApiOperation(value = "Get bandwidth control rule list", nickname = "getGridBandwidthCtrlRule", notes = "Get bandwidth control rule list.<br/><br/>The interface requires one of the permissions: <br/>Site Settings Manager View Only", response = OperationResponseGridVoBandwidthControlRule.class, tags={ "Omada/Bandwidth Control","Bandwidth Control", })
    @ApiResponses(value = { 
        @ApiResponse(code = 200, message = "OK", response = OperationResponseGridVoBandwidthControlRule.class) })
    @RequestMapping(value = "/openapi/v1/${omada.omadac-id}/sites/{siteId}/bandwidth-control/rules",
        produces = "*/*", 
        method = RequestMethod.GET)
    ResponseEntity<OperationResponseGridVoBandwidthControlRule> getGridBandwidthCtrlRule(@ApiParam(value = "Site ID",required=true) @PathVariable("siteId") String siteId,@NotNull @ApiParam(value = "Start page number. Start from 1.", required = true) @Valid @RequestParam(value = "page", required = true) Integer page,@NotNull @ApiParam(value = "Number of entries per page. It should be within the range of 1–1000.", required = true) @Valid @RequestParam(value = "pageSize", required = true) Integer pageSize);


    /**
     * PATCH /openapi/v1/{omadacId}/sites/{siteId}/bandwidth-control : Modify bandwidth control
     * Modify bandwidth control.&lt;br/&gt;&lt;br/&gt;The interface requires one of the permissions: &lt;br/&gt;Site Settings Manager Modify
     *
     * @param omadacId Omada ID (required)
     * @param siteId Site ID (required)
     * @param bandwidthControl  (optional)
     * @return OK (status code 200)
     */
    @ApiOperation(value = "Modify bandwidth control", nickname = "modifyBandwidthCtrl", notes = "Modify bandwidth control.<br/><br/>The interface requires one of the permissions: <br/>Site Settings Manager Modify", response = OperationResponseWithoutResult.class, tags={ "Omada/Bandwidth Control","Bandwidth Control", })
    @ApiResponses(value = { 
        @ApiResponse(code = 200, message = "OK", response = OperationResponseWithoutResult.class) })
    @RequestMapping(value = "/openapi/v1/${omada.omadac-id}/sites/{siteId}/bandwidth-control",
        produces = "*/*", 
        consumes = "application/json",
        method = RequestMethod.PATCH)
    ResponseEntity<OperationResponseWithoutResult> modifyBandwidthCtrl(@ApiParam(value = "Site ID",required=true) @PathVariable("siteId") String siteId,@ApiParam(value = ""  )  @Valid @RequestBody(required = false) BandwidthControl bandwidthControl);


    /**
     * PATCH /openapi/v1/{omadacId}/sites/{siteId}/bandwidth-control/rules/{ruleId} : Modify bandwidth control rule
     * Modify bandwidth control rule.&lt;br/&gt;&lt;br/&gt;The interface requires one of the permissions: &lt;br/&gt;Site Settings Manager Modify
     *
     * @param omadacId Omada ID (required)
     * @param siteId Site ID (required)
     * @param ruleId Bandwidth control rule ID (required)
     * @param bandwidthControlRule  (optional)
     * @return OK (status code 200)
     */
    @ApiOperation(value = "Modify bandwidth control rule", nickname = "modifyBandwidthCtrlRule", notes = "Modify bandwidth control rule.<br/><br/>The interface requires one of the permissions: <br/>Site Settings Manager Modify", response = OperationResponseWithoutResult.class, tags={ "Omada/Bandwidth Control","Bandwidth Control", })
    @ApiResponses(value = { 
        @ApiResponse(code = 200, message = "OK", response = OperationResponseWithoutResult.class) })
    @RequestMapping(value = "/openapi/v1/${omada.omadac-id}/sites/{siteId}/bandwidth-control/rules/{ruleId}",
        produces = "*/*", 
        consumes = "application/json",
        method = RequestMethod.PATCH)
    ResponseEntity<OperationResponseWithoutResult> modifyBandwidthCtrlRule(@ApiParam(value = "Site ID",required=true) @PathVariable("siteId") String siteId,@ApiParam(value = "Bandwidth control rule ID",required=true) @PathVariable("ruleId") String ruleId,@ApiParam(value = ""  )  @Valid @RequestBody(required = false) BandwidthControlRule bandwidthControlRule);


    /**
     * PATCH /openapi/v1/{omadacId}/sites/{siteId}/bandwidth-control/rules : Modify bandwidth control rule index
     * Modify bandwidth control rule index.&lt;br/&gt;&lt;br/&gt;The interface requires one of the permissions: &lt;br/&gt;Site Settings Manager Modify
     *
     * @param omadacId Omada ID (required)
     * @param siteId Site ID (required)
     * @param transmissionDragSortIndexOpenapiVo  (optional)
     * @return OK (status code 200)
     */
    @ApiOperation(value = "Modify bandwidth control rule index", nickname = "modifyBandwidthCtrlRuleIndex", notes = "Modify bandwidth control rule index.<br/><br/>The interface requires one of the permissions: <br/>Site Settings Manager Modify", response = OperationResponseWithoutResult.class, tags={ "Omada/Bandwidth Control","Bandwidth Control", })
    @ApiResponses(value = { 
        @ApiResponse(code = 200, message = "OK", response = OperationResponseWithoutResult.class) })
    @RequestMapping(value = "/openapi/v1/${omada.omadac-id}/sites/{siteId}/bandwidth-control/rules",
        produces = "*/*", 
        consumes = "application/json",
        method = RequestMethod.PATCH)
    ResponseEntity<OperationResponseWithoutResult> modifyBandwidthCtrlRuleIndex(@ApiParam(value = "Site ID",required=true) @PathVariable("siteId") String siteId,@ApiParam(value = ""  )  @Valid @RequestBody(required = false) TransmissionDragSortIndexOpenapiVo transmissionDragSortIndexOpenapiVo);

}
