fi.metatavu.dcfb.client.PurchaseRequestsApi 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.Forbidden;
import fi.metatavu.dcfb.client.InternalServerError;
import fi.metatavu.dcfb.client.PurchaseRequest;
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 PurchaseRequestsApi extends ApiClient.Api {


  /**
   * Create purchase request
   * Create purchase request
    * @param payload Payload (required)
   * @return PurchaseRequest
   */
  @RequestLine("POST /purchaseRequests")
  @Headers({
    "Content-Type: application/json",
    "Accept: application/json",
  })
  PurchaseRequest createPurchaseRequest(PurchaseRequest payload);

  /**
   * deletes an purchase request
   * Delete purchase request
    * @param purchaseRequestId PurchaseRequest id (required)
   */
  @RequestLine("DELETE /purchaseRequests/{purchaseRequestId}")
  @Headers({
    "Content-Type: application/json",
    "Accept: application/json",
  })
  void deletePurchaseRequest(@Param("purchaseRequestId") UUID purchaseRequestId);

  /**
   * Finds an purchaseRequest
   * Find purchaseRequest
    * @param purchaseRequestId PurchaseRequest id (required)
   * @return List<PurchaseRequest>
   */
  @RequestLine("GET /purchaseRequests/{purchaseRequestId}")
  @Headers({
    "Content-Type: application/json",
    "Accept: application/json",
  })
  List findPurchaseRequest(@Param("purchaseRequestId") UUID purchaseRequestId);

  /**
   * List purchase requests
   * List purchase requests
    * @param categoryIds Filter by category ids (comma delimitered) (optional)
    * @param search Search  by free-text query (optional)
    * @param firstResult First result (optional)
    * @param maxResults Max results (optional)
   * @return List<PurchaseRequest>
   */
  @RequestLine("GET /purchaseRequests?categoryIds={categoryIds}&search={search}&firstResult={firstResult}&maxResults={maxResults}")
  @Headers({
    "Content-Type: application/json",
    "Accept: application/json",
  })
  List listPurchaseRequests(@Param("categoryIds") String categoryIds, @Param("search") String search, @Param("firstResult") Long firstResult, @Param("maxResults") Long maxResults);

  /**
   * List purchase requests
   * List purchase requests
   * Note, this is equivalent to the other listPurchaseRequests 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 ListPurchaseRequestsQueryParams} 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:
   *   
   *   categoryIds - Filter by category ids (comma delimitered) (optional)
   *   search - Search  by free-text query (optional)
   *   firstResult - First result (optional)
   *   maxResults - Max results (optional)
   *   
   * @return List<PurchaseRequest>
   */
  @RequestLine("GET /purchaseRequests?categoryIds={categoryIds}&search={search}&firstResult={firstResult}&maxResults={maxResults}")
  @Headers({
  "Content-Type: application/json",
  "Accept: application/json",
  })
  List listPurchaseRequests(@QueryMap(encoded=true) Map queryParams);

  /**
   * A convenience class for generating query parameters for the
   * listPurchaseRequests method in a fluent style.
   */
  public static class ListPurchaseRequestsQueryParams extends HashMap {
    public ListPurchaseRequestsQueryParams categoryIds(final String value) {
      put("categoryIds", EncodingUtils.encode(value));
      return this;
    }
    public ListPurchaseRequestsQueryParams search(final String value) {
      put("search", EncodingUtils.encode(value));
      return this;
    }
    public ListPurchaseRequestsQueryParams firstResult(final Long value) {
      put("firstResult", EncodingUtils.encode(value));
      return this;
    }
    public ListPurchaseRequestsQueryParams maxResults(final Long value) {
      put("maxResults", EncodingUtils.encode(value));
      return this;
    }
  }

  /**
   * updates an purchase request
   * Update purchase request
    * @param purchaseRequestId PurchaseRequest id (required)
    * @param payload Payload (required)
   * @return PurchaseRequest
   */
  @RequestLine("PUT /purchaseRequests/{purchaseRequestId}")
  @Headers({
    "Content-Type: application/json",
    "Accept: application/json",
  })
  PurchaseRequest updatePurchaseRequest(@Param("purchaseRequestId") UUID purchaseRequestId, PurchaseRequest payload);
}