com.stripe.param.TaxRateUpdateParams Maven / Gradle / Ivy
// Generated by com.stripe.generator.entity.SdkBuilder
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 TaxRateUpdateParams extends ApiRequestParams {
/**
* Flag determining whether the tax rate is active or inactive. Inactive tax rates continue to
* work where they are currently applied however they cannot be used for new applications.
*/
@SerializedName("active")
Boolean active;
/**
* An arbitrary string attached to the tax rate for your internal use only. It will not be visible
* to your customers.
*/
@SerializedName("description")
String description;
/** The display name of the tax rate, which will be shown to users. */
@SerializedName("display_name")
String displayName;
/** 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;
/** The jurisdiction for the tax rate. */
@SerializedName("jurisdiction")
String jurisdiction;
/**
* 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;
private TaxRateUpdateParams(
Boolean active,
String description,
String displayName,
List expand,
Map extraParams,
String jurisdiction,
Map metadata) {
this.active = active;
this.description = description;
this.displayName = displayName;
this.expand = expand;
this.extraParams = extraParams;
this.jurisdiction = jurisdiction;
this.metadata = metadata;
}
public static Builder builder() {
return new com.stripe.param.TaxRateUpdateParams.Builder();
}
public static class Builder {
private Boolean active;
private String description;
private String displayName;
private List expand;
private Map extraParams;
private String jurisdiction;
private Map metadata;
/** Finalize and obtain parameter instance from this builder. */
public TaxRateUpdateParams build() {
return new TaxRateUpdateParams(
this.active,
this.description,
this.displayName,
this.expand,
this.extraParams,
this.jurisdiction,
this.metadata);
}
/**
* Flag determining whether the tax rate is active or inactive. Inactive tax rates continue to
* work where they are currently applied however they cannot be used for new applications.
*/
public Builder setActive(Boolean active) {
this.active = active;
return this;
}
/**
* An arbitrary string attached to the tax rate for your internal use only. It will not be
* visible to your customers.
*/
public Builder setDescription(String description) {
this.description = description;
return this;
}
/** The display name of the tax rate, which will be shown to users. */
public Builder setDisplayName(String displayName) {
this.displayName = displayName;
return this;
}
/**
* 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
* TaxRateUpdateParams#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
* TaxRateUpdateParams#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
* TaxRateUpdateParams#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 TaxRateUpdateParams#extraParams} for the field documentation.
*/
public Builder putAllExtraParam(Map map) {
if (this.extraParams == null) {
this.extraParams = new HashMap<>();
}
this.extraParams.putAll(map);
return this;
}
/** The jurisdiction for the tax rate. */
public Builder setJurisdiction(String jurisdiction) {
this.jurisdiction = jurisdiction;
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
* TaxRateUpdateParams#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 TaxRateUpdateParams#metadata} for the field documentation.
*/
public Builder putAllMetadata(Map map) {
if (this.metadata == null) {
this.metadata = new HashMap<>();
}
this.metadata.putAll(map);
return this;
}
}
}