/**
 * Copyright (c) 2023, WSO2 LLC. (https://www.wso2.com).
 *
 * WSO2 LLC. licenses this file to you under the Apache License,
 * Version 2.0 (the "License"); you may not use this file except
 * in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied. See the License for the
 * specific language governing permissions and limitations
 * under the License.
 */

package com.wso2.open.banking.application.info.endpoint.api;

import com.wso2.open.banking.application.info.endpoint.model.ApplicationBulkMetadataSuccessDTO;
import com.wso2.open.banking.application.info.endpoint.model.ApplicationInfoErrorDTO;
import com.wso2.open.banking.application.info.endpoint.model.ApplicationSingleMetadataSuccessDTO;
import io.swagger.annotations.Api;
import io.swagger.annotations.ApiOperation;
import io.swagger.annotations.ApiResponse;
import io.swagger.annotations.ApiResponses;

import javax.validation.constraints.NotNull;
import javax.ws.rs.GET;
import javax.ws.rs.Path;
import javax.ws.rs.PathParam;
import javax.ws.rs.Produces;
import javax.ws.rs.QueryParam;
import javax.ws.rs.core.Response;
import java.util.List;

/**
 * ApplicationInfoAPI
 *
 * <p>This specifies a RESTful API for retriving OAuth Application Information
 *
 */
@Path("/")
@Api(value = "/", description = "")
public interface ApplicationInformationApi  {

    /**
     * Retrieve Bulk Application Metadata
     *
     */
    @GET
    @Path("/metadata/")
    @Produces({ "application/json" })
    @ApiOperation(value = "Retrieve Bulk Application Metadata", tags={ "Application Information",  })
    @ApiResponses(value = {
        @ApiResponse(code = 200, message = "OK", response = ApplicationBulkMetadataSuccessDTO.class),
        @ApiResponse(code = 404, message = "Service Provider Data Not Found"),
        @ApiResponse(code = 400, message = "Bad Request", response = ApplicationInfoErrorDTO.class),
        @ApiResponse(code = 500, message = "Internal Server Error", response = ApplicationInfoErrorDTO.class) })
    public Response getBulkApplicationMetadata(@QueryParam("clientIds") @NotNull  List<String> clientIds);

    /**
     * Retrieve All Application Metadata
     *
     */
    @GET
    @Path("/all/metadata")
    @Produces({ "application/json" })
    @ApiOperation(value = "Retrieve Bulk Application Metadata", tags={ "Application Information",  })
    @ApiResponses(value = {
            @ApiResponse(code = 200, message = "OK", response = ApplicationBulkMetadataSuccessDTO.class),
            @ApiResponse(code = 404, message = "Service Provider Data Not Found"),
            @ApiResponse(code = 400, message = "Bad Request", response = ApplicationInfoErrorDTO.class),
            @ApiResponse(code = 500, message = "Internal Server Error", response = ApplicationInfoErrorDTO.class) })
    public Response getAllApplicationMetadata();

    /**
     * Retrieve Single Application Metadata
     *
     */
    @GET
    @Path("/metadata/{id}")
    @Produces({ "application/json" })
    @ApiOperation(value = "Retrieve Single Application Metadata", tags={ "Application Information" })
    @ApiResponses(value = {
        @ApiResponse(code = 200, message = "OK", response = ApplicationSingleMetadataSuccessDTO.class),
        @ApiResponse(code = 404, message = "Service Provider Data Not Found"),
        @ApiResponse(code = 400, message = "Bad Request", response = ApplicationInfoErrorDTO.class),
        @ApiResponse(code = 500, message = "Internal Server Error", response = ApplicationInfoErrorDTO.class) })
    public Response getSingleApplicationMetadata(@PathParam("id") String id);
}

