com.stripe.param.TaxIdCollectionCreateParams 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 Fri May 01 10:51:46 PDT 2020
package com.stripe.param;

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 TaxIdCollectionCreateParams 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;
  /**
   * Type of the tax ID, one of {@code eu_vat}, {@code br_cnpj}, {@code br_cpf}, {@code nz_gst},
   * {@code au_abn}, {@code in_gst}, {@code no_vat}, {@code za_vat}, {@code ch_vat}, {@code mx_rfc},
   * {@code sg_uen}, {@code ru_inn}, {@code ca_bn}, {@code hk_br}, {@code es_cif}, {@code tw_vat},
   * {@code th_vat}, {@code jp_cn}, {@code li_uid}, {@code my_itn}, {@code us_ein}, {@code kr_brn},
   * {@code ca_qst}, {@code my_sst}, or {@code sg_gst}.
   */
  @SerializedName("type")
  Type type;
  /**
   * Value of the tax ID.
   */
  @SerializedName("value")
  String value;

  private TaxIdCollectionCreateParams(List expand, Map extraParams, Type type, String value) {
    this.expand = expand;
    this.extraParams = extraParams;
    this.type = type;
    this.value = value;
  }

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


  public static class Builder {
    private List expand;
    private Map extraParams;
    private Type type;
    private String value;

    /**
     * Finalize and obtain parameter instance from this builder.
     */
    public TaxIdCollectionCreateParams build() {
      return new TaxIdCollectionCreateParams(this.expand, this.extraParams, this.type, this.value);
    }

    /**
     * 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
     * TaxIdCollectionCreateParams#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
     * TaxIdCollectionCreateParams#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
     * TaxIdCollectionCreateParams#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 TaxIdCollectionCreateParams#extraParams} for the field documentation.
     */
    public Builder putAllExtraParam(Map map) {
      if (this.extraParams == null) {
        this.extraParams = new HashMap<>();
      }
      this.extraParams.putAll(map);
      return this;
    }

    /**
     * Type of the tax ID, one of {@code eu_vat}, {@code br_cnpj}, {@code br_cpf}, {@code nz_gst},
     * {@code au_abn}, {@code in_gst}, {@code no_vat}, {@code za_vat}, {@code ch_vat}, {@code
     * mx_rfc}, {@code sg_uen}, {@code ru_inn}, {@code ca_bn}, {@code hk_br}, {@code es_cif}, {@code
     * tw_vat}, {@code th_vat}, {@code jp_cn}, {@code li_uid}, {@code my_itn}, {@code us_ein},
     * {@code kr_brn}, {@code ca_qst}, {@code my_sst}, or {@code sg_gst}.
     */
    public Builder setType(Type type) {
      this.type = type;
      return this;
    }

    /**
     * Value of the tax ID.
     */
    public Builder setValue(String value) {
      this.value = value;
      return this;
    }
  }


  public enum Type implements ApiRequestParams.EnumParam {
    @SerializedName("au_abn")
    AU_ABN("au_abn"), @SerializedName("br_cnpj")
    BR_CNPJ("br_cnpj"), @SerializedName("br_cpf")
    BR_CPF("br_cpf"), @SerializedName("ca_bn")
    CA_BN("ca_bn"), @SerializedName("ca_qst")
    CA_QST("ca_qst"), @SerializedName("ch_vat")
    CH_VAT("ch_vat"), @SerializedName("es_cif")
    ES_CIF("es_cif"), @SerializedName("eu_vat")
    EU_VAT("eu_vat"), @SerializedName("hk_br")
    HK_BR("hk_br"), @SerializedName("in_gst")
    IN_GST("in_gst"), @SerializedName("jp_cn")
    JP_CN("jp_cn"), @SerializedName("kr_brn")
    KR_BRN("kr_brn"), @SerializedName("li_uid")
    LI_UID("li_uid"), @SerializedName("mx_rfc")
    MX_RFC("mx_rfc"), @SerializedName("my_itn")
    MY_ITN("my_itn"), @SerializedName("my_sst")
    MY_SST("my_sst"), @SerializedName("no_vat")
    NO_VAT("no_vat"), @SerializedName("nz_gst")
    NZ_GST("nz_gst"), @SerializedName("ru_inn")
    RU_INN("ru_inn"), @SerializedName("sg_gst")
    SG_GST("sg_gst"), @SerializedName("sg_uen")
    SG_UEN("sg_uen"), @SerializedName("th_vat")
    TH_VAT("th_vat"), @SerializedName("tw_vat")
    TW_VAT("tw_vat"), @SerializedName("us_ein")
    US_EIN("us_ein"), @SerializedName("za_vat")
    ZA_VAT("za_vat");
    private final String value;

    Type(String value) {
      this.value = value;
    }

    @Override
    @java.lang.SuppressWarnings("all")
    @lombok.Generated
    public String getValue() {
      return this.value;
    }
  }

  /**
   * 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;
  }

  /**
   * Type of the tax ID, one of {@code eu_vat}, {@code br_cnpj}, {@code br_cpf}, {@code nz_gst},
   * {@code au_abn}, {@code in_gst}, {@code no_vat}, {@code za_vat}, {@code ch_vat}, {@code mx_rfc},
   * {@code sg_uen}, {@code ru_inn}, {@code ca_bn}, {@code hk_br}, {@code es_cif}, {@code tw_vat},
   * {@code th_vat}, {@code jp_cn}, {@code li_uid}, {@code my_itn}, {@code us_ein}, {@code kr_brn},
   * {@code ca_qst}, {@code my_sst}, or {@code sg_gst}.
   */
  @java.lang.SuppressWarnings("all")
  @lombok.Generated
  public Type getType() {
    return this.type;
  }

  /**
   * Value of the tax ID.
   */
  @java.lang.SuppressWarnings("all")
  @lombok.Generated
  public String getValue() {
    return this.value;
  }
}