org.bonitasoft.web.client.api.ActorMemberApi Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of bonita-java-client Show documentation
Java client for Bonita REST API
The newest version!
/** 
 * Copyright (C) 2024 BonitaSoft S.A.
 * BonitaSoft, 32 rue Gustave Eiffel - 38000 Grenoble
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 2.0 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program. If not, see .
 */
package org.bonitasoft.web.client.api;

import java.util.HashMap;
import java.util.List;

import org.bonitasoft.web.client.invoker.ApiClient;
import org.bonitasoft.web.client.invoker.EncodingUtils;
import org.bonitasoft.web.client.model.ActorMember;
import org.bonitasoft.web.client.model.ApiResponse;

import feign.*;

@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.8.0")
public interface ActorMemberApi extends ApiClient.Api {

    /**
     * Delete the ActorMember by ID
     * Delete the single ActorMember for the given ID
     * 
     * @param id ID of the ActorMember to delete (required)
     */
    @RequestLine("DELETE /API/bpm/actorMember/{id}")
    @Headers({
            "Accept: application/json",
    })
    void deleteActorMemberById(@Param("id") String id);

    /**
     * Delete the ActorMember by ID
     * Similar to deleteActorMemberById but it also returns the http response headers .
     * Delete the single ActorMember for the given ID
     * 
     * @param id ID of the ActorMember to delete (required)
     */
    @RequestLine("DELETE /API/bpm/actorMember/{id}")
    @Headers({
            "Accept: application/json",
    })
    ApiResponse deleteActorMemberByIdWithHttpInfo(@Param("id") String id);

    /**
     * Finds the ActorMember by ID
     * Returns the single ActorMember for the given ID
     * 
     * @param id ID of the ActorMember to return (required)
     * @return ActorMember
     */
    @RequestLine("GET /API/bpm/actorMember/{id}")
    @Headers({
            "Accept: application/json",
    })
    ActorMember getActorMemberById(@Param("id") String id);

    /**
     * Finds the ActorMember by ID
     * Similar to getActorMemberById but it also returns the http response headers .
     * Returns the single ActorMember for the given ID
     * 
     * @param id ID of the ActorMember to return (required)
     * @return A ApiResponse that wraps the response boyd and the http headers.
     */
    @RequestLine("GET /API/bpm/actorMember/{id}")
    @Headers({
            "Accept: application/json",
    })
    ApiResponse getActorMemberByIdWithHttpInfo(@Param("id") String id);

    /**
     * Finds ActorMembers
     * Finds ActorMembers with pagination params and filters There is a **mandatory** filter on: * `actor_id` For example, retrieve the actorMembers
     * related to the specified actor_id. http://localhost:8080/bonita/API/bpm/actorMember?p=0&c=10&f=actor_id%3d1 You can also filter also
     * on: * `member_type` (user|role|group|roleAndGroup) retrieve only the actorMembers of type user.
     * `/API/bpm/actorMember?p=0&c=10&f=actor_id%3d1&f=member_type%3duser` * `user_id`: retrieve only the
     * actorMembers related to the specified user_id. `/API/bpm/actorMember?p=0&c=10&f=actor_id%3d1&f=user_id%3d101` *
     * `role_id`: retrieve only the actorMembers related to the specified role_id.
     * `/API/bpm/actorMember?p=0&c=10&f=actor_id%3d1&f=role_id%3d101` * `group_id`: retrieve only the
     * actorMembers related to the specified group_id. `/API/bpm/actorMember?p=0&c=10&f=actor_id%3d1&f=group_id%3d101`
     * 
     * @param p index of the page to display (required)
     * @param c maximum number of elements to retrieve (required)
     * @param f can filter on attributes with the format f={filter\\_name}={filter\\_value} with the name/value pair as url encoded string. (optional)
     * @param o can order on attributes (optional)
     * @return List<ActorMember>
     */
    @RequestLine("GET /API/bpm/actorMember?p={p}&c={c}&f={f}&o={o}")
    @Headers({
            "Accept: application/json",
    })
    List searchActorMembers(@Param("p") Integer p, @Param("c") Integer c, @Param("f") List f,
            @Param("o") String o);

    /**
     * Finds ActorMembers
     * Similar to searchActorMembers but it also returns the http response headers .
     * Finds ActorMembers with pagination params and filters There is a **mandatory** filter on: * `actor_id` For example, retrieve the actorMembers
     * related to the specified actor_id. http://localhost:8080/bonita/API/bpm/actorMember?p=0&c=10&f=actor_id%3d1 You can also filter also
     * on: * `member_type` (user|role|group|roleAndGroup) retrieve only the actorMembers of type user.
     * `/API/bpm/actorMember?p=0&c=10&f=actor_id%3d1&f=member_type%3duser` * `user_id`: retrieve only the
     * actorMembers related to the specified user_id. `/API/bpm/actorMember?p=0&c=10&f=actor_id%3d1&f=user_id%3d101` *
     * `role_id`: retrieve only the actorMembers related to the specified role_id.
     * `/API/bpm/actorMember?p=0&c=10&f=actor_id%3d1&f=role_id%3d101` * `group_id`: retrieve only the
     * actorMembers related to the specified group_id. `/API/bpm/actorMember?p=0&c=10&f=actor_id%3d1&f=group_id%3d101`
     * 
     * @param p index of the page to display (required)
     * @param c maximum number of elements to retrieve (required)
     * @param f can filter on attributes with the format f={filter\\_name}={filter\\_value} with the name/value pair as url encoded string. (optional)
     * @param o can order on attributes (optional)
     * @return A ApiResponse that wraps the response boyd and the http headers.
     */
    @RequestLine("GET /API/bpm/actorMember?p={p}&c={c}&f={f}&o={o}")
    @Headers({
            "Accept: application/json",
    })
    ApiResponse> searchActorMembersWithHttpInfo(@Param("p") Integer p, @Param("c") Integer c,
            @Param("f") List f, @Param("o") String o);

    /**
     * Finds ActorMembers
     * Finds ActorMembers with pagination params and filters There is a **mandatory** filter on: * `actor_id` For example, retrieve the actorMembers
     * related to the specified actor_id. http://localhost:8080/bonita/API/bpm/actorMember?p=0&c=10&f=actor_id%3d1 You can also filter also
     * on: * `member_type` (user|role|group|roleAndGroup) retrieve only the actorMembers of type user.
     * `/API/bpm/actorMember?p=0&c=10&f=actor_id%3d1&f=member_type%3duser` * `user_id`: retrieve only the
     * actorMembers related to the specified user_id. `/API/bpm/actorMember?p=0&c=10&f=actor_id%3d1&f=user_id%3d101` *
     * `role_id`: retrieve only the actorMembers related to the specified role_id.
     * `/API/bpm/actorMember?p=0&c=10&f=actor_id%3d1&f=role_id%3d101` * `group_id`: retrieve only the
     * actorMembers related to the specified group_id. `/API/bpm/actorMember?p=0&c=10&f=actor_id%3d1&f=group_id%3d101`
     * Note, this is equivalent to the other searchActorMembers method,
     * but with the query parameters collected into a single Map parameter. This
     * is convenient for services with optional query parameters, especially when
     * used with the {@link SearchActorMembersQueryParams} class that allows for
     * building up this map in a fluent style.
     * 
     * @param queryParams Map of query parameters as name-value pairs
     *        The following elements may be specified in the query map:
     *        
     *        p - index of the page to display (required)
     *        c - maximum number of elements to retrieve (required)
     *        f - can filter on attributes with the format f={filter\\_name}={filter\\_value} with the name/value pair as url encoded string.
     *        (optional)
     *        o - can order on attributes (optional)
     *        
     * @return List<ActorMember>
     */
    @RequestLine("GET /API/bpm/actorMember?p={p}&c={c}&f={f}&o={o}")
    @Headers({
            "Accept: application/json",
    })
    List searchActorMembers(@QueryMap(encoded = true) SearchActorMembersQueryParams queryParams);

    /**
     * Finds ActorMembers
     * Finds ActorMembers with pagination params and filters There is a **mandatory** filter on: * `actor_id` For example, retrieve the actorMembers
     * related to the specified actor_id. http://localhost:8080/bonita/API/bpm/actorMember?p=0&c=10&f=actor_id%3d1 You can also filter also
     * on: * `member_type` (user|role|group|roleAndGroup) retrieve only the actorMembers of type user.
     * `/API/bpm/actorMember?p=0&c=10&f=actor_id%3d1&f=member_type%3duser` * `user_id`: retrieve only the
     * actorMembers related to the specified user_id. `/API/bpm/actorMember?p=0&c=10&f=actor_id%3d1&f=user_id%3d101` *
     * `role_id`: retrieve only the actorMembers related to the specified role_id.
     * `/API/bpm/actorMember?p=0&c=10&f=actor_id%3d1&f=role_id%3d101` * `group_id`: retrieve only the
     * actorMembers related to the specified group_id. `/API/bpm/actorMember?p=0&c=10&f=actor_id%3d1&f=group_id%3d101`
     * Note, this is equivalent to the other searchActorMembers that receives the query parameters as a map,
     * but this one also exposes the Http response headers
     * 
     * @param queryParams Map of query parameters as name-value pairs
     *        The following elements may be specified in the query map:
     *        
     *        p - index of the page to display (required)
     *        c - maximum number of elements to retrieve (required)
     *        f - can filter on attributes with the format f={filter\\_name}={filter\\_value} with the name/value pair as url encoded string.
     *        (optional)
     *        o - can order on attributes (optional)
     *        
     * @return List<ActorMember>
     */
    @RequestLine("GET /API/bpm/actorMember?p={p}&c={c}&f={f}&o={o}")
    @Headers({
            "Accept: application/json",
    })
    ApiResponse> searchActorMembersWithHttpInfo(
            @QueryMap(encoded = true) SearchActorMembersQueryParams queryParams);

    /**
     * A convenience class for generating query parameters for the
     * searchActorMembers method in a fluent style.
     */
    public static class SearchActorMembersQueryParams extends HashMap {

        public SearchActorMembersQueryParams p(final Integer value) {
            put("p", EncodingUtils.encode(value));
            return this;
        }

        public SearchActorMembersQueryParams c(final Integer value) {
            put("c", EncodingUtils.encode(value));
            return this;
        }

        public SearchActorMembersQueryParams f(final List value) {
            put("f", EncodingUtils.encodeCollection(value, "multi"));
            return this;
        }

        public SearchActorMembersQueryParams o(final String value) {
            put("o", EncodingUtils.encode(value));
            return this;
        }
    }
}