fi.metatavu.metaform.client.RepliesApi Maven / Gradle / Ivy

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

import fi.metatavu.metaform.ApiClient;
import fi.metatavu.metaform.EncodingUtils;

import fi.metatavu.metaform.client.BadRequest;
import fi.metatavu.metaform.client.Forbidden;
import fi.metatavu.metaform.client.InternalServerError;
import fi.metatavu.metaform.client.NotFound;
import fi.metatavu.metaform.client.Reply;
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 = "2019-07-29T14:02:51.404+03:00")
public interface RepliesApi extends ApiClient.Api {


  /**
   * create new form reply
   * Creates new form reply
    * @param realmId realm id (required)
    * @param metaformId Metaform id (required)
    * @param payload Payload (required)
    * @param updateExisting specifies that existing reply should be updated. DEPRECATED, use replymode instead (optional)
    * @param replyMode specifies reply mode that will be used. possible values UPDATE, REVISION, CUMULATIVE (optional)
   * @return Reply
   */
  @RequestLine("POST /realms/{realmId}/metaforms/{metaformId}/replies?updateExisting={updateExisting}&replyMode={replyMode}")
  @Headers({
    "Content-Type: application/json",
    "Accept: application/json",
  })
  Reply createReply(@Param("realmId") String realmId, @Param("metaformId") UUID metaformId, Reply payload, @Param("updateExisting") Boolean updateExisting, @Param("replyMode") String replyMode);

  /**
   * create new form reply
   * Creates new form reply
   * Note, this is equivalent to the other createReply 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 CreateReplyQueryParams} class that allows for
   * building up this map in a fluent style.
   * @param realmId realm id (required)
   * @param metaformId Metaform id (required)
   * @param payload Payload (required)
   * @param queryParams Map of query parameters as name-value pairs
   *   The following elements may be specified in the query map:
   *   
   *   updateExisting - specifies that existing reply should be updated. DEPRECATED, use replymode instead (optional)
   *   replyMode - specifies reply mode that will be used. possible values UPDATE, REVISION, CUMULATIVE (optional)
   *   
   * @return Reply
   */
  @RequestLine("POST /realms/{realmId}/metaforms/{metaformId}/replies?updateExisting={updateExisting}&replyMode={replyMode}")
  @Headers({
  "Content-Type: application/json",
  "Accept: application/json",
  })
  Reply createReply(@Param("realmId") String realmId, @Param("metaformId") UUID metaformId, Reply payload, @QueryMap(encoded=true) Map queryParams);

  /**
   * A convenience class for generating query parameters for the
   * createReply method in a fluent style.
   */
  public static class CreateReplyQueryParams extends HashMap {
    public CreateReplyQueryParams updateExisting(final Boolean value) {
      put("updateExisting", EncodingUtils.encode(value));
      return this;
    }
    public CreateReplyQueryParams replyMode(final String value) {
      put("replyMode", EncodingUtils.encode(value));
      return this;
    }
  }

  /**
   * Deletes a reply
   * Deletes a reply
    * @param realmId realm id (required)
    * @param metaformId Metaform id (required)
    * @param replyId Reply id (required)
   */
  @RequestLine("DELETE /realms/{realmId}/metaforms/{metaformId}/replies/{replyId}")
  @Headers({
    "Content-Type: application/json",
    "Accept: application/json",
  })
  void deleteReply(@Param("realmId") String realmId, @Param("metaformId") UUID metaformId, @Param("replyId") UUID replyId);

  /**
   * Exports metaform data
   * Exports metaform data
    * @param realmId realm id (required)
    * @param metaformId Metaform id (required)
    * @param format Export results in specified format (XLSX) (required)
   * @return byte[]
   */
  @RequestLine("GET /realms/{realmId}/metaforms/{metaformId}/export?format={format}")
  @Headers({
    "Content-Type: application/json",
    "Accept: application/json",
  })
  byte[] export(@Param("realmId") String realmId, @Param("metaformId") UUID metaformId, @Param("format") String format);

  /**
   * Exports metaform data
   * Exports metaform data
   * Note, this is equivalent to the other export 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 ExportQueryParams} class that allows for
   * building up this map in a fluent style.
   * @param realmId realm id (required)
   * @param metaformId Metaform id (required)
   * @param queryParams Map of query parameters as name-value pairs
   *   The following elements may be specified in the query map:
   *   
   *   format - Export results in specified format (XLSX) (required)
   *   
   * @return byte[]
   */
  @RequestLine("GET /realms/{realmId}/metaforms/{metaformId}/export?format={format}")
  @Headers({
  "Content-Type: application/json",
  "Accept: application/json",
  })
  byte[] export(@Param("realmId") String realmId, @Param("metaformId") UUID metaformId, @QueryMap(encoded=true) Map queryParams);

  /**
   * A convenience class for generating query parameters for the
   * export method in a fluent style.
   */
  public static class ExportQueryParams extends HashMap {
    public ExportQueryParams format(final String value) {
      put("format", EncodingUtils.encode(value));
      return this;
    }
  }

  /**
   * Find a single reply
   * Finds single reply by id
    * @param realmId realm id (required)
    * @param metaformId Metaform id (required)
    * @param replyId Reply id (required)
   * @return Reply
   */
  @RequestLine("GET /realms/{realmId}/metaforms/{metaformId}/replies/{replyId}")
  @Headers({
    "Content-Type: application/json",
    "Accept: application/json",
  })
  Reply findReply(@Param("realmId") String realmId, @Param("metaformId") UUID metaformId, @Param("replyId") UUID replyId);

  /**
   * Lists form replies
   * Lists form replies
    * @param realmId realm id (required)
    * @param metaformId Metaform id (required)
    * @param userId Filter results by user id. If this parameter is not specified all replies are returned, this requires logged user to have proper permission to do so (optional)
    * @param createdBefore Filter results created before specified time (optional)
    * @param createdAfter Filter results created after specified time (optional)
    * @param modifiedBefore Filter results modified before specified time (optional)
    * @param modifiedAfter Filter results modified after specified time (optional)
    * @param includeRevisions Specifies that revisions should be included into response (optional)
    * @param fields Filter results by field values. Format is field:value, multiple values can be added by using comma separator. E.g. field1=value,field2=another (optional)
    * @param firstResult First index of results to be returned (optional)
    * @param maxResults How many items to return at one time (optional)
   * @return List<Reply>
   */
  @RequestLine("GET /realms/{realmId}/metaforms/{metaformId}/replies?userId={userId}&createdBefore={createdBefore}&createdAfter={createdAfter}&modifiedBefore={modifiedBefore}&modifiedAfter={modifiedAfter}&includeRevisions={includeRevisions}&fields={fields}&firstResult={firstResult}&maxResults={maxResults}")
  @Headers({
    "Content-Type: application/json",
    "Accept: application/json",
  })
  List listReplies(@Param("realmId") String realmId, @Param("metaformId") UUID metaformId, @Param("userId") UUID userId, @Param("createdBefore") String createdBefore, @Param("createdAfter") String createdAfter, @Param("modifiedBefore") String modifiedBefore, @Param("modifiedAfter") String modifiedAfter, @Param("includeRevisions") Boolean includeRevisions, @Param("fields") List fields, @Param("firstResult") Integer firstResult, @Param("maxResults") Integer maxResults);

  /**
   * Lists form replies
   * Lists form replies
   * Note, this is equivalent to the other listReplies 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 ListRepliesQueryParams} class that allows for
   * building up this map in a fluent style.
   * @param realmId realm id (required)
   * @param metaformId Metaform id (required)
   * @param queryParams Map of query parameters as name-value pairs
   *   The following elements may be specified in the query map:
   *   
   *   userId - Filter results by user id. If this parameter is not specified all replies are returned, this requires logged user to have proper permission to do so (optional)
   *   createdBefore - Filter results created before specified time (optional)
   *   createdAfter - Filter results created after specified time (optional)
   *   modifiedBefore - Filter results modified before specified time (optional)
   *   modifiedAfter - Filter results modified after specified time (optional)
   *   includeRevisions - Specifies that revisions should be included into response (optional)
   *   fields - Filter results by field values. Format is field:value, multiple values can be added by using comma separator. E.g. field1=value,field2=another (optional)
   *   firstResult - First index of results to be returned (optional)
   *   maxResults - How many items to return at one time (optional)
   *   
   * @return List<Reply>
   */
  @RequestLine("GET /realms/{realmId}/metaforms/{metaformId}/replies?userId={userId}&createdBefore={createdBefore}&createdAfter={createdAfter}&modifiedBefore={modifiedBefore}&modifiedAfter={modifiedAfter}&includeRevisions={includeRevisions}&fields={fields}&firstResult={firstResult}&maxResults={maxResults}")
  @Headers({
  "Content-Type: application/json",
  "Accept: application/json",
  })
  List listReplies(@Param("realmId") String realmId, @Param("metaformId") UUID metaformId, @QueryMap(encoded=true) Map queryParams);

  /**
   * A convenience class for generating query parameters for the
   * listReplies method in a fluent style.
   */
  public static class ListRepliesQueryParams extends HashMap {
    public ListRepliesQueryParams userId(final UUID value) {
      put("userId", EncodingUtils.encode(value));
      return this;
    }
    public ListRepliesQueryParams createdBefore(final String value) {
      put("createdBefore", EncodingUtils.encode(value));
      return this;
    }
    public ListRepliesQueryParams createdAfter(final String value) {
      put("createdAfter", EncodingUtils.encode(value));
      return this;
    }
    public ListRepliesQueryParams modifiedBefore(final String value) {
      put("modifiedBefore", EncodingUtils.encode(value));
      return this;
    }
    public ListRepliesQueryParams modifiedAfter(final String value) {
      put("modifiedAfter", EncodingUtils.encode(value));
      return this;
    }
    public ListRepliesQueryParams includeRevisions(final Boolean value) {
      put("includeRevisions", EncodingUtils.encode(value));
      return this;
    }
    public ListRepliesQueryParams fields(final List value) {
      put("fields", EncodingUtils.encodeCollection(value, "csv"));
      return this;
    }
    public ListRepliesQueryParams firstResult(final Integer value) {
      put("firstResult", EncodingUtils.encode(value));
      return this;
    }
    public ListRepliesQueryParams maxResults(final Integer value) {
      put("maxResults", EncodingUtils.encode(value));
      return this;
    }
  }

  /**
   * Exports reply data
   * Exports reply data
    * @param realmId realm id (required)
    * @param metaformId Metaform id (required)
    * @param replyId Reply id (required)
    * @param format Export results in specified format (PDF) (required)
   * @return byte[]
   */
  @RequestLine("GET /realms/{realmId}/metaforms/{metaformId}/replies/{replyId}/export?format={format}")
  @Headers({
    "Content-Type: application/json",
    "Accept: application/json",
  })
  byte[] replyExport(@Param("realmId") String realmId, @Param("metaformId") UUID metaformId, @Param("replyId") UUID replyId, @Param("format") String format);

  /**
   * Exports reply data
   * Exports reply data
   * Note, this is equivalent to the other replyExport 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 ReplyExportQueryParams} class that allows for
   * building up this map in a fluent style.
   * @param realmId realm id (required)
   * @param metaformId Metaform id (required)
   * @param replyId Reply id (required)
   * @param queryParams Map of query parameters as name-value pairs
   *   The following elements may be specified in the query map:
   *   
   *   format - Export results in specified format (PDF) (required)
   *   
   * @return byte[]
   */
  @RequestLine("GET /realms/{realmId}/metaforms/{metaformId}/replies/{replyId}/export?format={format}")
  @Headers({
  "Content-Type: application/json",
  "Accept: application/json",
  })
  byte[] replyExport(@Param("realmId") String realmId, @Param("metaformId") UUID metaformId, @Param("replyId") UUID replyId, @QueryMap(encoded=true) Map queryParams);

  /**
   * A convenience class for generating query parameters for the
   * replyExport method in a fluent style.
   */
  public static class ReplyExportQueryParams extends HashMap {
    public ReplyExportQueryParams format(final String value) {
      put("format", EncodingUtils.encode(value));
      return this;
    }
  }

  /**
   * Updates reply
   * Updates reply
    * @param realmId realm id (required)
    * @param metaformId Metaform id (required)
    * @param replyId Reply id (required)
    * @param payload Payload (required)
   */
  @RequestLine("PUT /realms/{realmId}/metaforms/{metaformId}/replies/{replyId}")
  @Headers({
    "Content-Type: application/json",
    "Accept: application/json",
  })
  void updateReply(@Param("realmId") String realmId, @Param("metaformId") UUID metaformId, @Param("replyId") UUID replyId, Reply payload);
}