/*
 * Copyright 2024 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.DELETE;
import jakarta.ws.rs.DefaultValue;
import jakarta.ws.rs.GET;
import jakarta.ws.rs.Path;
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;
import org.keycloak.representations.idm.MemberRepresentation;
import org.keycloak.representations.idm.OrganizationRepresentation;

public interface OrganizationMemberResource {

    @GET
    @Produces(MediaType.APPLICATION_JSON)
    MemberRepresentation toRepresentation();

    @DELETE
    Response delete();

    /**
     * Returns the organizations associated with the user
     *
     * @since Keycloak server 26
     * @return the organizations associated with the user
     */
    @Path("organizations")
    @GET
    @Produces(MediaType.APPLICATION_JSON)
    List<OrganizationRepresentation> getOrganizations();

    /**
     * Returns the organizations associated with the user
     *
     * @param briefRepresentation if false, return the full representation. Otherwise, only the basic fields are returned. It is true by default. Parameter supported since Keycloak 26.3. It is assumed to be false for the older Keycloak server versions.
     * @since Keycloak server 26
     * @return the organizations associated with the user
     */
    @Path("organizations")
    @GET
    @Produces(MediaType.APPLICATION_JSON)
    List<OrganizationRepresentation> getOrganizations(
            @QueryParam("briefRepresentation") @DefaultValue("true") boolean briefRepresentation);

    /**
     * Returns the organization group memberships for this member
     *
     * @param firstResult the position of the first result to be processed (pagination offset)
     * @param maxResults the maximum number of results to be returned
     * @param briefRepresentation if false, return the full representation. Otherwise, only the basic fields are returned. It is true by default.
     * @since Keycloak server 26.6.0
     * @return the organization groups the member belongs to
     */
    @Path("groups")
    @GET
    @Produces(MediaType.APPLICATION_JSON)
    List<GroupRepresentation> groups(
            @QueryParam("first") Integer firstResult,
            @QueryParam("max") Integer maxResults,
            @QueryParam("briefRepresentation") @DefaultValue("true") boolean briefRepresentation);

    /**
     * Returns the organization group memberships for this member
     *
     * @param firstResult the position of the first result to be processed (pagination offset)
     * @param maxResults the maximum number of results to be returned
     * @param search a case-insensitive search string to filter groups by name. If {@code null} or blank, no filtering is applied.
     * @param briefRepresentation if false, return the full representation. Otherwise, only the basic fields are returned. It is true by default.
     * @since Keycloak server 26.6.0
     * @return the organization groups the member belongs to
     */
    @Path("groups")
    @GET
    @Produces(MediaType.APPLICATION_JSON)
    List<GroupRepresentation> groups(
            @QueryParam("first") Integer firstResult,
            @QueryParam("max") Integer maxResults,
            @QueryParam("search") String search,
            @QueryParam("briefRepresentation") @DefaultValue("true") boolean briefRepresentation);
}
