com.stripe.param.TaxIdCollectionCreateParams Maven / Gradle / Ivy
The newest version!
// File generated from our OpenAPI spec
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;
import lombok.Getter;
@Getter
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;
/**
* Required. Type of the tax ID, one of {@code ad_nrt}, {@code ae_trn}, {@code
* al_tin}, {@code am_tin}, {@code ao_tin}, {@code ar_cuit}, {@code au_abn}, {@code au_arn},
* {@code ba_tin}, {@code bb_tin}, {@code bg_uic}, {@code bh_vat}, {@code bo_tin}, {@code
* br_cnpj}, {@code br_cpf}, {@code bs_tin}, {@code by_tin}, {@code ca_bn}, {@code ca_gst_hst},
* {@code ca_pst_bc}, {@code ca_pst_mb}, {@code ca_pst_sk}, {@code ca_qst}, {@code cd_nif}, {@code
* ch_uid}, {@code ch_vat}, {@code cl_tin}, {@code cn_tin}, {@code co_nit}, {@code cr_tin}, {@code
* de_stn}, {@code do_rcn}, {@code ec_ruc}, {@code eg_tin}, {@code es_cif}, {@code eu_oss_vat},
* {@code eu_vat}, {@code gb_vat}, {@code ge_vat}, {@code gn_nif}, {@code hk_br}, {@code hr_oib},
* {@code hu_tin}, {@code id_npwp}, {@code il_vat}, {@code in_gst}, {@code is_vat}, {@code jp_cn},
* {@code jp_rn}, {@code jp_trn}, {@code ke_pin}, {@code kh_tin}, {@code kr_brn}, {@code kz_bin},
* {@code li_uid}, {@code li_vat}, {@code ma_vat}, {@code md_vat}, {@code me_pib}, {@code mk_vat},
* {@code mr_nif}, {@code mx_rfc}, {@code my_frp}, {@code my_itn}, {@code my_sst}, {@code ng_tin},
* {@code no_vat}, {@code no_voec}, {@code np_pan}, {@code nz_gst}, {@code om_vat}, {@code
* pe_ruc}, {@code ph_tin}, {@code ro_tin}, {@code rs_pib}, {@code ru_inn}, {@code ru_kpp}, {@code
* sa_vat}, {@code sg_gst}, {@code sg_uen}, {@code si_tin}, {@code sn_ninea}, {@code sr_fin},
* {@code sv_nit}, {@code th_vat}, {@code tj_tin}, {@code tr_tin}, {@code tw_vat}, {@code tz_vat},
* {@code ua_vat}, {@code ug_tin}, {@code us_ein}, {@code uy_ruc}, {@code uz_tin}, {@code uz_vat},
* {@code ve_rif}, {@code vn_tin}, {@code za_vat}, {@code zm_tin}, or {@code zw_tin}
*/
@SerializedName("type")
Type type;
/** Required. 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;
}
/**
* Required. Type of the tax ID, one of {@code ad_nrt}, {@code ae_trn}, {@code
* al_tin}, {@code am_tin}, {@code ao_tin}, {@code ar_cuit}, {@code au_abn}, {@code au_arn},
* {@code ba_tin}, {@code bb_tin}, {@code bg_uic}, {@code bh_vat}, {@code bo_tin}, {@code
* br_cnpj}, {@code br_cpf}, {@code bs_tin}, {@code by_tin}, {@code ca_bn}, {@code ca_gst_hst},
* {@code ca_pst_bc}, {@code ca_pst_mb}, {@code ca_pst_sk}, {@code ca_qst}, {@code cd_nif},
* {@code ch_uid}, {@code ch_vat}, {@code cl_tin}, {@code cn_tin}, {@code co_nit}, {@code
* cr_tin}, {@code de_stn}, {@code do_rcn}, {@code ec_ruc}, {@code eg_tin}, {@code es_cif},
* {@code eu_oss_vat}, {@code eu_vat}, {@code gb_vat}, {@code ge_vat}, {@code gn_nif}, {@code
* hk_br}, {@code hr_oib}, {@code hu_tin}, {@code id_npwp}, {@code il_vat}, {@code in_gst},
* {@code is_vat}, {@code jp_cn}, {@code jp_rn}, {@code jp_trn}, {@code ke_pin}, {@code kh_tin},
* {@code kr_brn}, {@code kz_bin}, {@code li_uid}, {@code li_vat}, {@code ma_vat}, {@code
* md_vat}, {@code me_pib}, {@code mk_vat}, {@code mr_nif}, {@code mx_rfc}, {@code my_frp},
* {@code my_itn}, {@code my_sst}, {@code ng_tin}, {@code no_vat}, {@code no_voec}, {@code
* np_pan}, {@code nz_gst}, {@code om_vat}, {@code pe_ruc}, {@code ph_tin}, {@code ro_tin},
* {@code rs_pib}, {@code ru_inn}, {@code ru_kpp}, {@code sa_vat}, {@code sg_gst}, {@code
* sg_uen}, {@code si_tin}, {@code sn_ninea}, {@code sr_fin}, {@code sv_nit}, {@code th_vat},
* {@code tj_tin}, {@code tr_tin}, {@code tw_vat}, {@code tz_vat}, {@code ua_vat}, {@code
* ug_tin}, {@code us_ein}, {@code uy_ruc}, {@code uz_tin}, {@code uz_vat}, {@code ve_rif},
* {@code vn_tin}, {@code za_vat}, {@code zm_tin}, or {@code zw_tin}
*/
public Builder setType(TaxIdCollectionCreateParams.Type type) {
this.type = type;
return this;
}
/** Required. Value of the tax ID. */
public Builder setValue(String value) {
this.value = value;
return this;
}
}
public enum Type implements ApiRequestParams.EnumParam {
@SerializedName("ad_nrt")
AD_NRT("ad_nrt"),
@SerializedName("ae_trn")
AE_TRN("ae_trn"),
@SerializedName("al_tin")
AL_TIN("al_tin"),
@SerializedName("am_tin")
AM_TIN("am_tin"),
@SerializedName("ao_tin")
AO_TIN("ao_tin"),
@SerializedName("ar_cuit")
AR_CUIT("ar_cuit"),
@SerializedName("au_abn")
AU_ABN("au_abn"),
@SerializedName("au_arn")
AU_ARN("au_arn"),
@SerializedName("ba_tin")
BA_TIN("ba_tin"),
@SerializedName("bb_tin")
BB_TIN("bb_tin"),
@SerializedName("bg_uic")
BG_UIC("bg_uic"),
@SerializedName("bh_vat")
BH_VAT("bh_vat"),
@SerializedName("bo_tin")
BO_TIN("bo_tin"),
@SerializedName("br_cnpj")
BR_CNPJ("br_cnpj"),
@SerializedName("br_cpf")
BR_CPF("br_cpf"),
@SerializedName("bs_tin")
BS_TIN("bs_tin"),
@SerializedName("by_tin")
BY_TIN("by_tin"),
@SerializedName("ca_bn")
CA_BN("ca_bn"),
@SerializedName("ca_gst_hst")
CA_GST_HST("ca_gst_hst"),
@SerializedName("ca_pst_bc")
CA_PST_BC("ca_pst_bc"),
@SerializedName("ca_pst_mb")
CA_PST_MB("ca_pst_mb"),
@SerializedName("ca_pst_sk")
CA_PST_SK("ca_pst_sk"),
@SerializedName("ca_qst")
CA_QST("ca_qst"),
@SerializedName("cd_nif")
CD_NIF("cd_nif"),
@SerializedName("ch_uid")
CH_UID("ch_uid"),
@SerializedName("ch_vat")
CH_VAT("ch_vat"),
@SerializedName("cl_tin")
CL_TIN("cl_tin"),
@SerializedName("cn_tin")
CN_TIN("cn_tin"),
@SerializedName("co_nit")
CO_NIT("co_nit"),
@SerializedName("cr_tin")
CR_TIN("cr_tin"),
@SerializedName("de_stn")
DE_STN("de_stn"),
@SerializedName("do_rcn")
DO_RCN("do_rcn"),
@SerializedName("ec_ruc")
EC_RUC("ec_ruc"),
@SerializedName("eg_tin")
EG_TIN("eg_tin"),
@SerializedName("es_cif")
ES_CIF("es_cif"),
@SerializedName("eu_oss_vat")
EU_OSS_VAT("eu_oss_vat"),
@SerializedName("eu_vat")
EU_VAT("eu_vat"),
@SerializedName("gb_vat")
GB_VAT("gb_vat"),
@SerializedName("ge_vat")
GE_VAT("ge_vat"),
@SerializedName("gn_nif")
GN_NIF("gn_nif"),
@SerializedName("hk_br")
HK_BR("hk_br"),
@SerializedName("hr_oib")
HR_OIB("hr_oib"),
@SerializedName("hu_tin")
HU_TIN("hu_tin"),
@SerializedName("id_npwp")
ID_NPWP("id_npwp"),
@SerializedName("il_vat")
IL_VAT("il_vat"),
@SerializedName("in_gst")
IN_GST("in_gst"),
@SerializedName("is_vat")
IS_VAT("is_vat"),
@SerializedName("jp_cn")
JP_CN("jp_cn"),
@SerializedName("jp_rn")
JP_RN("jp_rn"),
@SerializedName("jp_trn")
JP_TRN("jp_trn"),
@SerializedName("ke_pin")
KE_PIN("ke_pin"),
@SerializedName("kh_tin")
KH_TIN("kh_tin"),
@SerializedName("kr_brn")
KR_BRN("kr_brn"),
@SerializedName("kz_bin")
KZ_BIN("kz_bin"),
@SerializedName("li_uid")
LI_UID("li_uid"),
@SerializedName("li_vat")
LI_VAT("li_vat"),
@SerializedName("ma_vat")
MA_VAT("ma_vat"),
@SerializedName("md_vat")
MD_VAT("md_vat"),
@SerializedName("me_pib")
ME_PIB("me_pib"),
@SerializedName("mk_vat")
MK_VAT("mk_vat"),
@SerializedName("mr_nif")
MR_NIF("mr_nif"),
@SerializedName("mx_rfc")
MX_RFC("mx_rfc"),
@SerializedName("my_frp")
MY_FRP("my_frp"),
@SerializedName("my_itn")
MY_ITN("my_itn"),
@SerializedName("my_sst")
MY_SST("my_sst"),
@SerializedName("ng_tin")
NG_TIN("ng_tin"),
@SerializedName("no_vat")
NO_VAT("no_vat"),
@SerializedName("no_voec")
NO_VOEC("no_voec"),
@SerializedName("np_pan")
NP_PAN("np_pan"),
@SerializedName("nz_gst")
NZ_GST("nz_gst"),
@SerializedName("om_vat")
OM_VAT("om_vat"),
@SerializedName("pe_ruc")
PE_RUC("pe_ruc"),
@SerializedName("ph_tin")
PH_TIN("ph_tin"),
@SerializedName("ro_tin")
RO_TIN("ro_tin"),
@SerializedName("rs_pib")
RS_PIB("rs_pib"),
@SerializedName("ru_inn")
RU_INN("ru_inn"),
@SerializedName("ru_kpp")
RU_KPP("ru_kpp"),
@SerializedName("sa_vat")
SA_VAT("sa_vat"),
@SerializedName("sg_gst")
SG_GST("sg_gst"),
@SerializedName("sg_uen")
SG_UEN("sg_uen"),
@SerializedName("si_tin")
SI_TIN("si_tin"),
@SerializedName("sn_ninea")
SN_NINEA("sn_ninea"),
@SerializedName("sr_fin")
SR_FIN("sr_fin"),
@SerializedName("sv_nit")
SV_NIT("sv_nit"),
@SerializedName("th_vat")
TH_VAT("th_vat"),
@SerializedName("tj_tin")
TJ_TIN("tj_tin"),
@SerializedName("tr_tin")
TR_TIN("tr_tin"),
@SerializedName("tw_vat")
TW_VAT("tw_vat"),
@SerializedName("tz_vat")
TZ_VAT("tz_vat"),
@SerializedName("ua_vat")
UA_VAT("ua_vat"),
@SerializedName("ug_tin")
UG_TIN("ug_tin"),
@SerializedName("us_ein")
US_EIN("us_ein"),
@SerializedName("uy_ruc")
UY_RUC("uy_ruc"),
@SerializedName("uz_tin")
UZ_TIN("uz_tin"),
@SerializedName("uz_vat")
UZ_VAT("uz_vat"),
@SerializedName("ve_rif")
VE_RIF("ve_rif"),
@SerializedName("vn_tin")
VN_TIN("vn_tin"),
@SerializedName("za_vat")
ZA_VAT("za_vat"),
@SerializedName("zm_tin")
ZM_TIN("zm_tin"),
@SerializedName("zw_tin")
ZW_TIN("zw_tin");
@Getter(onMethod_ = {@Override})
private final String value;
Type(String value) {
this.value = value;
}
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy