com.formkiq.stacks.client.requests.AddDocumentOcrRequest Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of client Show documentation

The Official Client library for FormKiQ

There is a newer version: 1.12.0

/**
 * Copyright [2020] FormKiQ Inc. Licensed under the Apache License, Version 2.0 (the "License"); you
 * may not use this file except in compliance with the License. You may obtain a copy of the License
 * at
 * 
 * http://www.apache.org/licenses/LICENSE-2.0
 * 
 * Unless required by applicable law or agreed to in writing, software distributed under the License
 * is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express
 * or implied. See the License for the specific language governing permissions and limitations under
 * the License.
 */
package com.formkiq.stacks.client.requests;

import java.util.HashMap;
import java.util.List;
import java.util.Map;
import java.util.Optional;
import com.formkiq.stacks.client.ApiRequest;
import com.formkiq.stacks.client.Validate;

/**
 * Creates POST /documents/{documentId}/ocr Request.
 *
 */
public class AddDocumentOcrRequest implements ApiRequest {

  /** Request Parameters. */
  private Map parameters = new HashMap<>();
  /** OCR Parse Types. */
  private List parseTypes;
  /** Request Parameters. */
  private Map paths = new HashMap<>();

  /**
   * constructor.
   */
  public AddDocumentOcrRequest() {}

  @Override
  public void addQueryParameter(final String key, final String value) {
    this.parameters.put(key, value);
  }

  /**
   * Set the DocumentId.
   * 
   * @param documentId {@link String}
   * @return {@link AddDocumentOcrRequest}
   */
  public AddDocumentOcrRequest documentId(final String documentId) {
    this.paths.put("documentId", documentId);
    return this;
  }

  @Override
  public Optional>> getHttpHeaders() {
    return Optional.empty();
  }

  @Override
  public Map getQueryParameters() {
    return this.parameters;
  }

  @Override
  public String getUrlPath() {
    return "documents/" + this.paths.get("documentId") + "/ocr";
  }

  /**
   * Get Parse Types.
   * 
   * @return {@link List} {@link OcrParseType}
   */
  public List parseTypes() {
    return this.parseTypes;
  }

  /**
   * Set Parse Types.
   * 
   * @param types {@link List} {@link OcrParseType}
   * @return {@link AddDocumentOcrRequest}
   */
  public AddDocumentOcrRequest parseTypes(final List types) {
    this.parseTypes = types;
    return this;
  }

  /**
   * Site Identifier.
   * 
   * @param siteId {@link String}
   * @return {@link AddDocumentOcrRequest}
   */
  public AddDocumentOcrRequest siteId(final String siteId) {
    this.parameters.put("siteId", siteId);
    return this;
  }

  @Override
  public void validate() {
    Validate.notNull(this.paths.get("documentId"), "DocumentId is required.");
  }
}