/*
 * Copyright 2026 Red Hat, Inc. and/or its affiliates
 * and other contributors as indicated by the @author tags.
 *
 * Licensed 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 org.keycloak.admin.client.resource;

import java.util.List;

import jakarta.ws.rs.Consumes;
import jakarta.ws.rs.GET;
import jakarta.ws.rs.POST;
import jakarta.ws.rs.Path;
import jakarta.ws.rs.PathParam;
import jakarta.ws.rs.Produces;
import jakarta.ws.rs.QueryParam;
import jakarta.ws.rs.core.MediaType;
import jakarta.ws.rs.core.Response;

import org.keycloak.representations.idm.GroupRepresentation;

/**
 * @since Keycloak server 26.6.0. All the child endpoints are also available since that version unless mentioned otherwise<p>
 *
 * Organization groups resource for managing groups within an organization.
 */
public interface OrganizationGroupsResource {

    @POST
    @Consumes(MediaType.APPLICATION_JSON)
    Response addTopLevelGroup(GroupRepresentation rep);

    @GET
    @Produces(MediaType.APPLICATION_JSON)
    List<GroupRepresentation> getAll(
            @QueryParam("search") String search,
            @QueryParam("q") String searchQuery,
            @QueryParam("exact") Boolean exact,
            @QueryParam("first") Integer first,
            @QueryParam("max") Integer max,
            @QueryParam("briefRepresentation") boolean briefRepresentation,
            @QueryParam("subGroupsCount") boolean subGroupsCount
    );

    @GET
    @Produces(MediaType.APPLICATION_JSON)
    List<GroupRepresentation> getAll(
            @QueryParam("search") String search,
            @QueryParam("q") String searchQuery,
            @QueryParam("exact") Boolean exact,
            @QueryParam("first") Integer first,
            @QueryParam("max") Integer max,
            @QueryParam("briefRepresentation") boolean briefRepresentation,
            @QueryParam("populateHierarchy") boolean populateHierarchy,
            @QueryParam("subGroupsCount") boolean subGroupsCount
    );

    @GET
    @Path("group-by-path/{path: .*}")
    @Produces(MediaType.APPLICATION_JSON)
    GroupRepresentation getGroupByPath(
            @PathParam("path") String path,
            @QueryParam("subGroupsCount") boolean subGroupsCount
    );

    @Path("{group-id}")
    OrganizationGroupResource group(@PathParam("group-id") String groupId);
}
