All Downloads are FREE. Search and download functionalities are using the official Maven repository.

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

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.ApiResponse;
import org.bonitasoft.web.client.model.Tenant;
import org.bonitasoft.web.client.model.TenantCreateRequest;
import org.bonitasoft.web.client.model.TenantUpdateRequest;

import feign.*;

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

    /**
     * Create the Tenant
     * ![edition](https://img.shields.io/badge/edition-entreprise-blue) Create the Tenant. Warning: Since Bonita 7.12, multi-tenancy is deprecated. Creating new
     * tenants is strongly discouraged.
     * 
     * @param body Partial Tenant description (required)
     * @return Tenant
     * @deprecated
     */
    @Deprecated
    @RequestLine("POST /API/platform/tenant")
    @Headers({
            "Content-Type: application/json",
            "Accept: application/json",
    })
    Tenant createTenant(TenantCreateRequest body);

    /**
     * Create the Tenant
     * Similar to createTenant but it also returns the http response headers .
     * ![edition](https://img.shields.io/badge/edition-entreprise-blue) Create the Tenant. Warning: Since Bonita 7.12, multi-tenancy is deprecated. Creating new
     * tenants is strongly discouraged.
     * 
     * @param body Partial Tenant description (required)
     * @return A ApiResponse that wraps the response boyd and the http headers.
     * @deprecated
     */
    @Deprecated
    @RequestLine("POST /API/platform/tenant")
    @Headers({
            "Content-Type: application/json",
            "Accept: application/json",
    })
    ApiResponse createTenantWithHttpInfo(TenantCreateRequest body);

    /**
     * Delete the Tenant by ID
     * ![edition](https://img.shields.io/badge/edition-entreprise-blue) Delete the single Tenant for the given ID
     * 
     * @param id ID of the Tenant to delete (required)
     * @deprecated
     */
    @Deprecated
    @RequestLine("DELETE /API/platform/tenant/{id}")
    @Headers({
            "Accept: application/json",
    })
    void deleteTenantById(@Param("id") String id);

    /**
     * Delete the Tenant by ID
     * Similar to deleteTenantById but it also returns the http response headers .
     * ![edition](https://img.shields.io/badge/edition-entreprise-blue) Delete the single Tenant for the given ID
     * 
     * @param id ID of the Tenant to delete (required)
     * @deprecated
     */
    @Deprecated
    @RequestLine("DELETE /API/platform/tenant/{id}")
    @Headers({
            "Accept: application/json",
    })
    ApiResponse deleteTenantByIdWithHttpInfo(@Param("id") String id);

    /**
     * Finds the Tenant by ID
     * ![edition](https://img.shields.io/badge/edition-entreprise-blue) Returns the single Tenant for the given ID Warning: Since Bonita 7.12, multi-tenancy is
     * deprecated
     * 
     * @param id ID of the Tenant to return (required)
     * @return Tenant
     * @deprecated
     */
    @Deprecated
    @RequestLine("GET /API/platform/tenant/{id}")
    @Headers({
            "Accept: application/json",
    })
    Tenant getTenantById(@Param("id") String id);

    /**
     * Finds the Tenant by ID
     * Similar to getTenantById but it also returns the http response headers .
     * ![edition](https://img.shields.io/badge/edition-entreprise-blue) Returns the single Tenant for the given ID Warning: Since Bonita 7.12, multi-tenancy is
     * deprecated
     * 
     * @param id ID of the Tenant to return (required)
     * @return A ApiResponse that wraps the response boyd and the http headers.
     * @deprecated
     */
    @Deprecated
    @RequestLine("GET /API/platform/tenant/{id}")
    @Headers({
            "Accept: application/json",
    })
    ApiResponse getTenantByIdWithHttpInfo(@Param("id") String id);

    /**
     * Finds Tenants
     * ![edition](https://img.shields.io/badge/edition-entreprise-blue) Finds Tenants with pagination params and filters - can order on `id` - can search
     * on `displayName` - can filter on `displayName` Warning: Since Bonita 7.12, multi-tenancy is deprecated
     * 
     * @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)
     * @param s can search on attributes (optional)
     * @return List<Tenant>
     * @deprecated
     */
    @Deprecated
    @RequestLine("GET /API/platform/tenant?p={p}&c={c}&f={f}&o={o}&s={s}")
    @Headers({
            "Accept: application/json",
    })
    List searchTenants(@Param("p") Integer p, @Param("c") Integer c, @Param("f") List f,
            @Param("o") String o, @Param("s") String s);

    /**
     * Finds Tenants
     * Similar to searchTenants but it also returns the http response headers .
     * ![edition](https://img.shields.io/badge/edition-entreprise-blue) Finds Tenants with pagination params and filters - can order on `id` - can search
     * on `displayName` - can filter on `displayName` Warning: Since Bonita 7.12, multi-tenancy is deprecated
     * 
     * @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)
     * @param s can search on attributes (optional)
     * @return A ApiResponse that wraps the response boyd and the http headers.
     * @deprecated
     */
    @Deprecated
    @RequestLine("GET /API/platform/tenant?p={p}&c={c}&f={f}&o={o}&s={s}")
    @Headers({
            "Accept: application/json",
    })
    ApiResponse> searchTenantsWithHttpInfo(@Param("p") Integer p, @Param("c") Integer c,
            @Param("f") List f, @Param("o") String o, @Param("s") String s);

    /**
     * Finds Tenants
     * ![edition](https://img.shields.io/badge/edition-entreprise-blue) Finds Tenants with pagination params and filters - can order on `id` - can search
     * on `displayName` - can filter on `displayName` Warning: Since Bonita 7.12, multi-tenancy is deprecated
     * Note, this is equivalent to the other searchTenants 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 SearchTenantsQueryParams} 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)
  • *
  • s - can search on attributes (optional)
  • *
* @return List<Tenant> * @deprecated */ @Deprecated @RequestLine("GET /API/platform/tenant?p={p}&c={c}&f={f}&o={o}&s={s}") @Headers({ "Accept: application/json", }) List searchTenants(@QueryMap(encoded = true) SearchTenantsQueryParams queryParams); /** * Finds Tenants * ![edition](https://img.shields.io/badge/edition-entreprise-blue) Finds Tenants with pagination params and filters - can order on `id` - can search * on `displayName` - can filter on `displayName` Warning: Since Bonita 7.12, multi-tenancy is deprecated * Note, this is equivalent to the other searchTenants 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)
  • *
  • s - can search on attributes (optional)
  • *
* @return List<Tenant> * @deprecated */ @Deprecated @RequestLine("GET /API/platform/tenant?p={p}&c={c}&f={f}&o={o}&s={s}") @Headers({ "Accept: application/json", }) ApiResponse> searchTenantsWithHttpInfo(@QueryMap(encoded = true) SearchTenantsQueryParams queryParams); /** * A convenience class for generating query parameters for the * searchTenants method in a fluent style. */ public static class SearchTenantsQueryParams extends HashMap { public SearchTenantsQueryParams p(final Integer value) { put("p", EncodingUtils.encode(value)); return this; } public SearchTenantsQueryParams c(final Integer value) { put("c", EncodingUtils.encode(value)); return this; } public SearchTenantsQueryParams f(final List value) { put("f", EncodingUtils.encodeCollection(value, "multi")); return this; } public SearchTenantsQueryParams o(final String value) { put("o", EncodingUtils.encode(value)); return this; } public SearchTenantsQueryParams s(final String value) { put("s", EncodingUtils.encode(value)); return this; } } /** * Update the Tenant by ID * ![edition](https://img.shields.io/badge/edition-entreprise-blue) ![edition](https://img.shields.io/badge/edition-community-brightgreen) Update a Tenant * Warning: Since Bonita 7.12, multi-tenancy is deprecated * * @param id ID of the Tenant to update. In Subscription edition, it is mandatory; not in Community edition, as there is only one tenant (required) * @param tenantUpdateRequest Partial Tenant description (required) * @deprecated */ @Deprecated @RequestLine("PUT /API/platform/tenant/{id}") @Headers({ "Content-Type: application/json", "Accept: application/json", }) void updateTenantById(@Param("id") String id, TenantUpdateRequest tenantUpdateRequest); /** * Update the Tenant by ID * Similar to updateTenantById but it also returns the http response headers . * ![edition](https://img.shields.io/badge/edition-entreprise-blue) ![edition](https://img.shields.io/badge/edition-community-brightgreen) Update a Tenant * Warning: Since Bonita 7.12, multi-tenancy is deprecated * * @param id ID of the Tenant to update. In Subscription edition, it is mandatory; not in Community edition, as there is only one tenant (required) * @param tenantUpdateRequest Partial Tenant description (required) * @deprecated */ @Deprecated @RequestLine("PUT /API/platform/tenant/{id}") @Headers({ "Content-Type: application/json", "Accept: application/json", }) ApiResponse updateTenantByIdWithHttpInfo(@Param("id") String id, TenantUpdateRequest tenantUpdateRequest); }




© 2015 - 2024 Weber Informatics LLC | Privacy Policy