fi.metatavu.dcfb.client.CategoriesApi Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of dcfb-api-client Show documentation
Metaform API specifications
There is a newer version: 0.0.31
package fi.metatavu.dcfb.client;

import fi.metatavu.dcfb.ApiClient;
import fi.metatavu.dcfb.EncodingUtils;

import fi.metatavu.dcfb.client.BadRequest;
import fi.metatavu.dcfb.client.Category;
import fi.metatavu.dcfb.client.Forbidden;
import fi.metatavu.dcfb.client.InternalServerError;
import java.util.UUID;

import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import feign.*;

@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2018-09-11T15:10:38.040+03:00")
public interface CategoriesApi extends ApiClient.Api {


  /**
   * Create category
   * Create category
    * @param payload Payload (required)
   * @return Category
   */
  @RequestLine("POST /categories")
  @Headers({
    "Content-Type: application/json",
    "Accept: application/json",
  })
  Category createCategory(Category payload);

  /**
   * deletes an category
   * Delete category
    * @param categoryId Category id (required)
   */
  @RequestLine("DELETE /categories/{categoryId}")
  @Headers({
    "Content-Type: application/json",
    "Accept: application/json",
  })
  void deleteCategory(@Param("categoryId") UUID categoryId);

  /**
   * Finds an category
   * Find category
    * @param categoryId Category id (required)
   * @return Category
   */
  @RequestLine("GET /categories/{categoryId}")
  @Headers({
    "Content-Type: application/json",
    "Accept: application/json",
  })
  Category findCategory(@Param("categoryId") UUID categoryId);

  /**
   * List categories
   * List categories
    * @param parentId Filter by parent category id (optional)
    * @param search Search by free-text query (optional)
    * @param slug Filter by category slug (optional)
    * @param sort Sort results. See CategoryListSort for sort options (optional)
    * @param firstResult First result (optional)
    * @param maxResults Max results (optional)
   * @return List<Category>
   */
  @RequestLine("GET /categories?parentId={parentId}&search={search}&slug={slug}&sort={sort}&firstResult={firstResult}&maxResults={maxResults}")
  @Headers({
    "Content-Type: application/json",
    "Accept: application/json",
  })
  List listCategories(@Param("parentId") UUID parentId, @Param("search") String search, @Param("slug") String slug, @Param("sort") List sort, @Param("firstResult") Long firstResult, @Param("maxResults") Long maxResults);

  /**
   * List categories
   * List categories
   * Note, this is equivalent to the other listCategories 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 ListCategoriesQueryParams} 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:
   *   
   *   parentId - Filter by parent category id (optional)
   *   search - Search by free-text query (optional)
   *   slug - Filter by category slug (optional)
   *   sort - Sort results. See CategoryListSort for sort options (optional)
   *   firstResult - First result (optional)
   *   maxResults - Max results (optional)
   *   
   * @return List<Category>
   */
  @RequestLine("GET /categories?parentId={parentId}&search={search}&slug={slug}&sort={sort}&firstResult={firstResult}&maxResults={maxResults}")
  @Headers({
  "Content-Type: application/json",
  "Accept: application/json",
  })
  List listCategories(@QueryMap(encoded=true) Map queryParams);

  /**
   * A convenience class for generating query parameters for the
   * listCategories method in a fluent style.
   */
  public static class ListCategoriesQueryParams extends HashMap {
    public ListCategoriesQueryParams parentId(final UUID value) {
      put("parentId", EncodingUtils.encode(value));
      return this;
    }
    public ListCategoriesQueryParams search(final String value) {
      put("search", EncodingUtils.encode(value));
      return this;
    }
    public ListCategoriesQueryParams slug(final String value) {
      put("slug", EncodingUtils.encode(value));
      return this;
    }
    public ListCategoriesQueryParams sort(final List value) {
      put("sort", EncodingUtils.encodeCollection(value, "csv"));
      return this;
    }
    public ListCategoriesQueryParams firstResult(final Long value) {
      put("firstResult", EncodingUtils.encode(value));
      return this;
    }
    public ListCategoriesQueryParams maxResults(final Long value) {
      put("maxResults", EncodingUtils.encode(value));
      return this;
    }
  }

  /**
   * updates an category
   * Update category
    * @param categoryId Category id (required)
    * @param payload Payload (required)
   * @return Category
   */
  @RequestLine("PUT /categories/{categoryId}")
  @Headers({
    "Content-Type: application/json",
    "Accept: application/json",
  })
  Category updateCategory(@Param("categoryId") UUID categoryId, Category payload);
}