com.stripe.param.terminal.ReaderCreateParams Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of stripe-java Show documentation
Stripe Java Bindings
There is a newer version: 28.2.0
// Generated by delombok at Tue Jan 14 08:43:16 PST 2020
package com.stripe.param.terminal;

import com.google.gson.annotations.SerializedName;
import com.stripe.net.ApiRequestParams;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Map;

public class ReaderCreateParams extends ApiRequestParams {
  /**
   * Specifies which fields in the response should be expanded.
   */
  @SerializedName("expand")
  List expand;
  /**
   * Map of extra parameters for custom features not available in this client library. The content
   * in this map is not serialized under this field's {@code @SerializedName} value. Instead, each
   * key/value pair is serialized as if the key is a root-level field (serialized) name in this
   * param object. Effectively, this map is flattened to its parent instance.
   */
  @SerializedName(ApiRequestParams.EXTRA_PARAMS_KEY)
  Map extraParams;
  /**
   * Custom label given to the reader for easier identification. If no label is specified, the
   * registration code will be used.
   */
  @SerializedName("label")
  String label;
  /**
   * The location to assign the reader to. If no location is specified, the reader will be assigned
   * to the account's default location.
   */
  @SerializedName("location")
  String location;
  /**
   * Set of key-value pairs that you can attach to an object. This can be useful for storing
   * additional information about the object in a structured format. Individual keys can be unset by
   * posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
   */
  @SerializedName("metadata")
  Map metadata;
  /**
   * To [group
   * objects](https://stripe.com/docs/terminal/payments/connect#grouping-objects-by-connected-account)
   * on your platform account by connected account, set this parameter to the connected account ID.
   */
  @SerializedName("operator_account")
  String operatorAccount;
  /**
   * A code generated by the reader used for registering to an account.
   */
  @SerializedName("registration_code")
  String registrationCode;

  private ReaderCreateParams(List expand, Map extraParams, String label, String location, Map metadata, String operatorAccount, String registrationCode) {
    this.expand = expand;
    this.extraParams = extraParams;
    this.label = label;
    this.location = location;
    this.metadata = metadata;
    this.operatorAccount = operatorAccount;
    this.registrationCode = registrationCode;
  }

  public static Builder builder() {
    return new Builder();
  }


  public static class Builder {
    private List expand;
    private Map extraParams;
    private String label;
    private String location;
    private Map metadata;
    private String operatorAccount;
    private String registrationCode;

    /** Finalize and obtain parameter instance from this builder. */
    public ReaderCreateParams build() {
      return new ReaderCreateParams(this.expand, this.extraParams, this.label, this.location, this.metadata, this.operatorAccount, this.registrationCode);
    }

    /**
     * Add an element to `expand` list. A list is initialized for the first `add/addAll` call, and
     * subsequent calls adds additional elements to the original list. See {@link
     * ReaderCreateParams#expand} for the field documentation.
     */
    public Builder addExpand(String element) {
      if (this.expand == null) {
        this.expand = new ArrayList<>();
      }
      this.expand.add(element);
      return this;
    }

    /**
     * Add all elements to `expand` list. A list is initialized for the first `add/addAll` call, and
     * subsequent calls adds additional elements to the original list. See {@link
     * ReaderCreateParams#expand} for the field documentation.
     */
    public Builder addAllExpand(List elements) {
      if (this.expand == null) {
        this.expand = new ArrayList<>();
      }
      this.expand.addAll(elements);
      return this;
    }

    /**
     * Add a key/value pair to `extraParams` map. A map is initialized for the first `put/putAll`
     * call, and subsequent calls add additional key/value pairs to the original map. See {@link
     * ReaderCreateParams#extraParams} for the field documentation.
     */
    public Builder putExtraParam(String key, Object value) {
      if (this.extraParams == null) {
        this.extraParams = new HashMap<>();
      }
      this.extraParams.put(key, value);
      return this;
    }

    /**
     * Add all map key/value pairs to `extraParams` map. A map is initialized for the first
     * `put/putAll` call, and subsequent calls add additional key/value pairs to the original map.
     * See {@link ReaderCreateParams#extraParams} for the field documentation.
     */
    public Builder putAllExtraParam(Map map) {
      if (this.extraParams == null) {
        this.extraParams = new HashMap<>();
      }
      this.extraParams.putAll(map);
      return this;
    }

    /**
     * Custom label given to the reader for easier identification. If no label is specified, the
     * registration code will be used.
     */
    public Builder setLabel(String label) {
      this.label = label;
      return this;
    }

    /**
     * The location to assign the reader to. If no location is specified, the reader will be
     * assigned to the account's default location.
     */
    public Builder setLocation(String location) {
      this.location = location;
      return this;
    }

    /**
     * Add a key/value pair to `metadata` map. A map is initialized for the first `put/putAll` call,
     * and subsequent calls add additional key/value pairs to the original map. See {@link
     * ReaderCreateParams#metadata} for the field documentation.
     */
    public Builder putMetadata(String key, String value) {
      if (this.metadata == null) {
        this.metadata = new HashMap<>();
      }
      this.metadata.put(key, value);
      return this;
    }

    /**
     * Add all map key/value pairs to `metadata` map. A map is initialized for the first
     * `put/putAll` call, and subsequent calls add additional key/value pairs to the original map.
     * See {@link ReaderCreateParams#metadata} for the field documentation.
     */
    public Builder putAllMetadata(Map map) {
      if (this.metadata == null) {
        this.metadata = new HashMap<>();
      }
      this.metadata.putAll(map);
      return this;
    }

    /**
     * To [group
     * objects](https://stripe.com/docs/terminal/payments/connect#grouping-objects-by-connected-account)
     * on your platform account by connected account, set this parameter to the connected account
     * ID.
     */
    public Builder setOperatorAccount(String operatorAccount) {
      this.operatorAccount = operatorAccount;
      return this;
    }

    /** A code generated by the reader used for registering to an account. */
    public Builder setRegistrationCode(String registrationCode) {
      this.registrationCode = registrationCode;
      return this;
    }
  }

  /**
   * Specifies which fields in the response should be expanded.
   */
  @java.lang.SuppressWarnings("all")
  @lombok.Generated
  public List getExpand() {
    return this.expand;
  }

  /**
   * Map of extra parameters for custom features not available in this client library. The content
   * in this map is not serialized under this field's {@code @SerializedName} value. Instead, each
   * key/value pair is serialized as if the key is a root-level field (serialized) name in this
   * param object. Effectively, this map is flattened to its parent instance.
   */
  @java.lang.SuppressWarnings("all")
  @lombok.Generated
  public Map getExtraParams() {
    return this.extraParams;
  }

  /**
   * Custom label given to the reader for easier identification. If no label is specified, the
   * registration code will be used.
   */
  @java.lang.SuppressWarnings("all")
  @lombok.Generated
  public String getLabel() {
    return this.label;
  }

  /**
   * The location to assign the reader to. If no location is specified, the reader will be assigned
   * to the account's default location.
   */
  @java.lang.SuppressWarnings("all")
  @lombok.Generated
  public String getLocation() {
    return this.location;
  }

  /**
   * Set of key-value pairs that you can attach to an object. This can be useful for storing
   * additional information about the object in a structured format. Individual keys can be unset by
   * posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
   */
  @java.lang.SuppressWarnings("all")
  @lombok.Generated
  public Map getMetadata() {
    return this.metadata;
  }

  /**
   * To [group
   * objects](https://stripe.com/docs/terminal/payments/connect#grouping-objects-by-connected-account)
   * on your platform account by connected account, set this parameter to the connected account ID.
   */
  @java.lang.SuppressWarnings("all")
  @lombok.Generated
  public String getOperatorAccount() {
    return this.operatorAccount;
  }

  /**
   * A code generated by the reader used for registering to an account.
   */
  @java.lang.SuppressWarnings("all")
  @lombok.Generated
  public String getRegistrationCode() {
    return this.registrationCode;
  }
}