com.stripe.param.MarginCreateParams Maven / Gradle / Ivy
// File generated from our OpenAPI spec
package com.stripe.param;
import com.google.gson.annotations.SerializedName;
import com.stripe.net.ApiRequestParams;
import java.math.BigDecimal;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import lombok.Getter;
@Getter
public class MarginCreateParams extends ApiRequestParams {
/**
* Whether the margin can be applied to invoices, invoice items, or invoice line items or not.
* Defaults to {@code true}.
*/
@SerializedName("active")
Boolean active;
/** 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;
/**
* 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 {@code metadata}.
*/
@SerializedName("metadata")
Map metadata;
/** Name of the margin, which is displayed to customers, such as on invoices. */
@SerializedName("name")
String name;
/**
* Required. Percent that will be taken off the subtotal before tax (after all
* other discounts and promotions) of any invoice to which the margin is applied.
*/
@SerializedName("percent_off")
BigDecimal percentOff;
private MarginCreateParams(
Boolean active,
List expand,
Map extraParams,
Map metadata,
String name,
BigDecimal percentOff) {
this.active = active;
this.expand = expand;
this.extraParams = extraParams;
this.metadata = metadata;
this.name = name;
this.percentOff = percentOff;
}
public static Builder builder() {
return new Builder();
}
public static class Builder {
private Boolean active;
private List expand;
private Map extraParams;
private Map metadata;
private String name;
private BigDecimal percentOff;
/** Finalize and obtain parameter instance from this builder. */
public MarginCreateParams build() {
return new MarginCreateParams(
this.active, this.expand, this.extraParams, this.metadata, this.name, this.percentOff);
}
/**
* Whether the margin can be applied to invoices, invoice items, or invoice line items or not.
* Defaults to {@code true}.
*/
public Builder setActive(Boolean active) {
this.active = active;
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
* MarginCreateParams#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
* MarginCreateParams#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
* MarginCreateParams#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 MarginCreateParams#extraParams} for the field documentation.
*/
public Builder putAllExtraParam(Map map) {
if (this.extraParams == null) {
this.extraParams = new HashMap<>();
}
this.extraParams.putAll(map);
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
* MarginCreateParams#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 MarginCreateParams#metadata} for the field documentation.
*/
public Builder putAllMetadata(Map map) {
if (this.metadata == null) {
this.metadata = new HashMap<>();
}
this.metadata.putAll(map);
return this;
}
/** Name of the margin, which is displayed to customers, such as on invoices. */
public Builder setName(String name) {
this.name = name;
return this;
}
/**
* Required. Percent that will be taken off the subtotal before tax (after all
* other discounts and promotions) of any invoice to which the margin is applied.
*/
public Builder setPercentOff(BigDecimal percentOff) {
this.percentOff = percentOff;
return this;
}
}
}