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.MacFiltering;
import org.wfc.omada.api.sitesetting.model.MacFilteringGeneralSetting;
import org.wfc.omada.api.sitesetting.model.OperationResponseGridVoMacFiltering;
import org.wfc.omada.api.sitesetting.model.OperationResponseMacFilteringGeneralSetting;
import org.wfc.omada.api.sitesetting.model.OperationResponseWithoutResult;

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 = "OmadaMacFiltering", description = "the OmadaMacFiltering API")
@FeignClient(name="OmadaMacFilteringApi", url = "${omada.omada-url}", configuration = FeignConfig.class)
public interface OmadaMacFilteringApi {

    /**
     * POST /openapi/v1/{omadacId}/sites/{siteId}/mac-filters : Create MAC filtering
     * Create MAC filtering.&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 macFiltering  (optional)
     * @return OK (status code 200)
     */
    @ApiOperation(value = "Create MAC filtering", nickname = "createMacFiltering", notes = "Create MAC filtering.<br/><br/>The interface requires one of the permissions: <br/>Site Settings Manager Modify", response = OperationResponseWithoutResult.class, tags={ "Omada/MAC Filtering","MAC Filtering", })
    @ApiResponses(value = { 
        @ApiResponse(code = 200, message = "OK", response = OperationResponseWithoutResult.class) })
    @RequestMapping(value = "/openapi/v1/${omada.omadac-id}/sites/{siteId}/mac-filters",
        produces = "*/*", 
        consumes = "application/json",
        method = RequestMethod.POST)
    ResponseEntity<OperationResponseWithoutResult> createMacFiltering(@ApiParam(value = "Site ID",required=true) @PathVariable("siteId") String siteId,@ApiParam(value = ""  )  @Valid @RequestBody(required = false) MacFiltering macFiltering);


    /**
     * DELETE /openapi/v1/{omadacId}/sites/{siteId}/mac-filters/{filterId} : Delete MAC filtering
     * Delete MAC filtering.&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 filterId MAC filtering ID (required)
     * @return OK (status code 200)
     */
    @ApiOperation(value = "Delete MAC filtering", nickname = "deleteMacFiltering", notes = "Delete MAC filtering.<br/><br/>The interface requires one of the permissions: <br/>Site Settings Manager Modify", response = OperationResponseWithoutResult.class, tags={ "Omada/MAC Filtering","MAC Filtering", })
    @ApiResponses(value = { 
        @ApiResponse(code = 200, message = "OK", response = OperationResponseWithoutResult.class) })
    @RequestMapping(value = "/openapi/v1/${omada.omadac-id}/sites/{siteId}/mac-filters/{filterId}",
        produces = "*/*", 
        method = RequestMethod.DELETE)
    ResponseEntity<OperationResponseWithoutResult> deleteMacFiltering(@ApiParam(value = "Site ID",required=true) @PathVariable("siteId") String siteId,@ApiParam(value = "MAC filtering ID",required=true) @PathVariable("filterId") String filterId);


    /**
     * GET /openapi/v1/{omadacId}/sites/{siteId}/mac-filters/allow : Get allow MAC filtering list
     * Get allow MAC filtering 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 allow MAC filtering list", nickname = "getGridAllowMacFiltering", notes = "Get allow MAC filtering list.<br/><br/>The interface requires one of the permissions: <br/>Site Settings Manager View Only", response = OperationResponseGridVoMacFiltering.class, tags={ "Omada/MAC Filtering","MAC Filtering", })
    @ApiResponses(value = { 
        @ApiResponse(code = 200, message = "OK", response = OperationResponseGridVoMacFiltering.class) })
    @RequestMapping(value = "/openapi/v1/${omada.omadac-id}/sites/{siteId}/mac-filters/allow",
        produces = "*/*", 
        method = RequestMethod.GET)
    ResponseEntity<OperationResponseGridVoMacFiltering> getGridAllowMacFiltering(@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);


    /**
     * GET /openapi/v1/{omadacId}/sites/{siteId}/mac-filters/deny : Get deny MAC filtering list
     * Get deny MAC filtering 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 deny MAC filtering list", nickname = "getGridDenyMacFiltering", notes = "Get deny MAC filtering list.<br/><br/>The interface requires one of the permissions: <br/>Site Settings Manager View Only", response = OperationResponseGridVoMacFiltering.class, tags={ "Omada/MAC Filtering","MAC Filtering", })
    @ApiResponses(value = { 
        @ApiResponse(code = 200, message = "OK", response = OperationResponseGridVoMacFiltering.class) })
    @RequestMapping(value = "/openapi/v1/${omada.omadac-id}/sites/{siteId}/mac-filters/deny",
        produces = "*/*", 
        method = RequestMethod.GET)
    ResponseEntity<OperationResponseGridVoMacFiltering> getGridDenyMacFiltering(@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);


    /**
     * GET /openapi/v1/{omadacId}/sites/{siteId}/mac-filter : Get MAC filtering general setting
     * Get MAC filtering general setting.&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 MAC filtering general setting", nickname = "getMacFilteringGeneralSetting", notes = "Get MAC filtering general setting.<br/><br/>The interface requires one of the permissions: <br/>Site Settings Manager View Only", response = OperationResponseMacFilteringGeneralSetting.class, tags={ "Omada/MAC Filtering","MAC Filtering", })
    @ApiResponses(value = { 
        @ApiResponse(code = 200, message = "OK", response = OperationResponseMacFilteringGeneralSetting.class) })
    @RequestMapping(value = "/openapi/v1/${omada.omadac-id}/sites/{siteId}/mac-filter",
        produces = "*/*", 
        method = RequestMethod.GET)
    ResponseEntity<OperationResponseMacFilteringGeneralSetting> getMacFilteringGeneralSetting(@ApiParam(value = "Site ID",required=true) @PathVariable("siteId") String siteId);


    /**
     * PATCH /openapi/v1/{omadacId}/sites/{siteId}/mac-filters/{filterId} : Modify MAC filtering
     * Modify MAC filtering.&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 filterId MAC filtering ID (required)
     * @param macFiltering  (optional)
     * @return OK (status code 200)
     */
    @ApiOperation(value = "Modify MAC filtering", nickname = "modifyMacFiltering", notes = "Modify MAC filtering.<br/><br/>The interface requires one of the permissions: <br/>Site Settings Manager Modify", response = OperationResponseWithoutResult.class, tags={ "Omada/MAC Filtering","MAC Filtering", })
    @ApiResponses(value = { 
        @ApiResponse(code = 200, message = "OK", response = OperationResponseWithoutResult.class) })
    @RequestMapping(value = "/openapi/v1/${omada.omadac-id}/sites/{siteId}/mac-filters/{filterId}",
        produces = "*/*", 
        consumes = "application/json",
        method = RequestMethod.PATCH)
    ResponseEntity<OperationResponseWithoutResult> modifyMacFiltering(@ApiParam(value = "Site ID",required=true) @PathVariable("siteId") String siteId,@ApiParam(value = "MAC filtering ID",required=true) @PathVariable("filterId") String filterId,@ApiParam(value = ""  )  @Valid @RequestBody(required = false) MacFiltering macFiltering);


    /**
     * PATCH /openapi/v1/{omadacId}/sites/{siteId}/mac-filter : Modify MAC filtering general setting
     * Modify MAC filtering general setting.&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 macFilteringGeneralSetting  (optional)
     * @return OK (status code 200)
     */
    @ApiOperation(value = "Modify MAC filtering general setting", nickname = "modifyMacFilteringGeneralSetting", notes = "Modify MAC filtering general setting.<br/><br/>The interface requires one of the permissions: <br/>Site Settings Manager Modify", response = OperationResponseWithoutResult.class, tags={ "Omada/MAC Filtering","MAC Filtering", })
    @ApiResponses(value = { 
        @ApiResponse(code = 200, message = "OK", response = OperationResponseWithoutResult.class) })
    @RequestMapping(value = "/openapi/v1/${omada.omadac-id}/sites/{siteId}/mac-filter",
        produces = "*/*", 
        consumes = "application/json",
        method = RequestMethod.PATCH)
    ResponseEntity<OperationResponseWithoutResult> modifyMacFilteringGeneralSetting(@ApiParam(value = "Site ID",required=true) @PathVariable("siteId") String siteId,@ApiParam(value = ""  )  @Valid @RequestBody(required = false) MacFilteringGeneralSetting macFilteringGeneralSetting);

}
