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.wfc.omada.config.FeignConfig;
import org.wfc.omada.api.sitesetting.model.CorrectSimQuota;
import org.wfc.omada.api.sitesetting.model.OperationResponseSimQuotaSetting;
import org.wfc.omada.api.sitesetting.model.OperationResponseWithoutResult;
import org.wfc.omada.api.sitesetting.model.SimQuotaSetting;

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

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

    /**
     * POST /openapi/v1/{omadacId}/sites/{siteId}/sim/correct : Correct SIM data
     * Correct SIM data.&lt;br/&gt;&lt;br/&gt;The interface requires one of the permissions: &lt;br/&gt;Site Settings Manager Modify&lt;br/&gt;&lt;br/&gt;The possible error code for the interface in the returned body is one of the following error codes (non generic error codes): &lt;br/&gt;-35400  -  The adopted gateway does not support SIM configurations.
     *
     * @param omadacId Omada ID (required)
     * @param siteId Site ID (required)
     * @param correctSimQuota  (optional)
     * @return OK (status code 200)
     */
    @ApiOperation(value = "Correct SIM data", nickname = "correctSimQuota", notes = "Correct SIM data.<br/><br/>The interface requires one of the permissions: <br/>Site Settings Manager Modify<br/><br/>The possible error code for the interface in the returned body is one of the following error codes (non generic error codes): <br/>-35400  -  The adopted gateway does not support SIM configurations.", response = OperationResponseWithoutResult.class, tags={ "Omada/SIM","SIM", })
    @ApiResponses(value = { 
        @ApiResponse(code = 200, message = "OK", response = OperationResponseWithoutResult.class) })
    @RequestMapping(value = "/openapi/v1/${omada.omadac-id}/sites/{siteId}/sim/correct",
        produces = "*/*", 
        consumes = "application/json",
        method = RequestMethod.POST)
    ResponseEntity<OperationResponseWithoutResult> correctSimQuota(@ApiParam(value = "Site ID",required=true) @PathVariable("siteId") String siteId,@ApiParam(value = ""  )  @Valid @RequestBody(required = false) CorrectSimQuota correctSimQuota);


    /**
     * PATCH /openapi/v1/{omadacId}/sites/{siteId}/sim/quota : Modify SIM data setting
     * Modify SIM data setting.&lt;br/&gt;&lt;br/&gt;The interface requires one of the permissions: &lt;br/&gt;Site Settings Manager Modify&lt;br/&gt;&lt;br/&gt;The possible error code for the interface in the returned body is one of the following error codes (non generic error codes): &lt;br/&gt;-35400  -  The adopted gateway does not support SIM configurations.
     *
     * @param omadacId Omada ID (required)
     * @param siteId Site ID (required)
     * @param simQuotaSetting  (optional)
     * @return OK (status code 200)
     */
    @ApiOperation(value = "Modify SIM data setting", nickname = "modifySimQuotaSetting", notes = "Modify SIM data setting.<br/><br/>The interface requires one of the permissions: <br/>Site Settings Manager Modify<br/><br/>The possible error code for the interface in the returned body is one of the following error codes (non generic error codes): <br/>-35400  -  The adopted gateway does not support SIM configurations.", response = OperationResponseWithoutResult.class, tags={ "Omada/SIM","SIM", })
    @ApiResponses(value = { 
        @ApiResponse(code = 200, message = "OK", response = OperationResponseWithoutResult.class) })
    @RequestMapping(value = "/openapi/v1/${omada.omadac-id}/sites/{siteId}/sim/quota",
        produces = "*/*", 
        consumes = "application/json",
        method = RequestMethod.PATCH)
    ResponseEntity<OperationResponseWithoutResult> modifySimQuotaSetting(@ApiParam(value = "Site ID",required=true) @PathVariable("siteId") String siteId,@ApiParam(value = ""  )  @Valid @RequestBody(required = false) SimQuotaSetting simQuotaSetting);


    /**
     * GET /openapi/v1/{omadacId}/sites/{siteId}/sim/quota : Get SIM data setting
     * Get SIM data setting.&lt;br/&gt;&lt;br/&gt;The interface requires one of the permissions: &lt;br/&gt;Site Settings Manager View Only&lt;br/&gt;&lt;br/&gt;The possible error code for the interface in the returned body is one of the following error codes (non generic error codes): &lt;br/&gt;-35400  -  The adopted gateway does not support SIM configurations.
     *
     * @param omadacId Omada ID (required)
     * @param siteId Site ID (required)
     * @return OK (status code 200)
     */
    @ApiOperation(value = "Get SIM data setting", nickname = "querySimQuotaSetting", notes = "Get SIM data setting.<br/><br/>The interface requires one of the permissions: <br/>Site Settings Manager View Only<br/><br/>The possible error code for the interface in the returned body is one of the following error codes (non generic error codes): <br/>-35400  -  The adopted gateway does not support SIM configurations.", response = OperationResponseSimQuotaSetting.class, tags={ "Omada/SIM","SIM", })
    @ApiResponses(value = { 
        @ApiResponse(code = 200, message = "OK", response = OperationResponseSimQuotaSetting.class) })
    @RequestMapping(value = "/openapi/v1/${omada.omadac-id}/sites/{siteId}/sim/quota",
        produces = "*/*", 
        method = RequestMethod.GET)
    ResponseEntity<OperationResponseSimQuotaSetting> querySimQuotaSetting(@ApiParam(value = "Site ID",required=true) @PathVariable("siteId") String siteId);

}
