com.stripe.param.ProductUpdateParams 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 com.stripe.param.common.EmptyParam;
import java.math.BigDecimal;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
public class ProductUpdateParams extends ApiRequestParams {
/** Whether the product is available for purchase. */
@SerializedName("active")
Boolean active;
/**
* A list of up to 5 alphanumeric attributes that each SKU can provide values for (e.g.,
* `["color", "size"]`). If a value for `attributes` is specified, the list specified will replace
* the existing attributes list on this product. Any attributes not present after the update will
* be deleted from the SKUs for this product.
*/
@SerializedName("attributes")
Object attributes;
/** A short one-line description of the product, meant to be displayable to the customer. */
@SerializedName("caption")
String caption;
/**
* An array of Connect application names or identifiers that should not be able to order the SKUs
* for this product.
*/
@SerializedName("deactivate_on")
List deactivateOn;
/** The product's description, meant to be displayable to the customer. */
@SerializedName("description")
String description;
/** 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;
/** A list of up to 8 URLs of images for this product, meant to be displayable to the customer. */
@SerializedName("images")
Object images;
/**
* A set of key-value pairs that you can attach to a product object. It can be useful for storing
* additional information about the product in a structured format.
*/
@SerializedName("metadata")
Map metadata;
/**
* The product's name, meant to be displayable to the customer. Applicable to both `service` and
* `good` types.
*/
@SerializedName("name")
String name;
/**
* The dimensions of this product for shipping purposes. A SKU associated with this product can
* override this value by having its own `package_dimensions`.
*/
@SerializedName("package_dimensions")
Object packageDimensions;
/** Whether this product is shipped (i.e., physical goods). Defaults to `true`. */
@SerializedName("shippable")
Boolean shippable;
/**
* An arbitrary string to be displayed on your customer's credit card statement. This may be up to
* 22 characters. The statement description may not include "' characters, and will appear on your
* customer's statement in capital letters. Non-ASCII characters are automatically stripped. While
* most banks display this information consistently, some may display it incorrectly or not at
* all. It must contain at least one letter. May only be set if type=`service`.
*/
@SerializedName("statement_descriptor")
String statementDescriptor;
/**
* A label that represents units of this product, such as seat(s), in Stripe and on customers’
* receipts and invoices. Only available on products of type=`service`.
*/
@SerializedName("unit_label")
String unitLabel;
/** A URL of a publicly-accessible webpage for this product. */
@SerializedName("url")
String url;
private ProductUpdateParams(
Boolean active,
Object attributes,
String caption,
List deactivateOn,
String description,
List expand,
Map extraParams,
Object images,
Map metadata,
String name,
Object packageDimensions,
Boolean shippable,
String statementDescriptor,
String unitLabel,
String url) {
this.active = active;
this.attributes = attributes;
this.caption = caption;
this.deactivateOn = deactivateOn;
this.description = description;
this.expand = expand;
this.extraParams = extraParams;
this.images = images;
this.metadata = metadata;
this.name = name;
this.packageDimensions = packageDimensions;
this.shippable = shippable;
this.statementDescriptor = statementDescriptor;
this.unitLabel = unitLabel;
this.url = url;
}
public static Builder builder() {
return new com.stripe.param.ProductUpdateParams.Builder();
}
public static class Builder {
private Boolean active;
private Object attributes;
private String caption;
private List deactivateOn;
private String description;
private List expand;
private Map extraParams;
private Object images;
private Map metadata;
private String name;
private Object packageDimensions;
private Boolean shippable;
private String statementDescriptor;
private String unitLabel;
private String url;
/** Finalize and obtain parameter instance from this builder. */
public ProductUpdateParams build() {
return new ProductUpdateParams(
this.active,
this.attributes,
this.caption,
this.deactivateOn,
this.description,
this.expand,
this.extraParams,
this.images,
this.metadata,
this.name,
this.packageDimensions,
this.shippable,
this.statementDescriptor,
this.unitLabel,
this.url);
}
/** Whether the product is available for purchase. */
public Builder setActive(Boolean active) {
this.active = active;
return this;
}
/**
* A list of up to 5 alphanumeric attributes that each SKU can provide values for (e.g.,
* `["color", "size"]`). If a value for `attributes` is specified, the list specified will
* replace the existing attributes list on this product. Any attributes not present after the
* update will be deleted from the SKUs for this product.
*/
public Builder setAttributes(EmptyParam attributes) {
this.attributes = attributes;
return this;
}
/**
* A list of up to 5 alphanumeric attributes that each SKU can provide values for (e.g.,
* `["color", "size"]`). If a value for `attributes` is specified, the list specified will
* replace the existing attributes list on this product. Any attributes not present after the
* update will be deleted from the SKUs for this product.
*/
public Builder setAttributes(List attributes) {
this.attributes = attributes;
return this;
}
/** A short one-line description of the product, meant to be displayable to the customer. */
public Builder setCaption(String caption) {
this.caption = caption;
return this;
}
/**
* Add an element to `deactivateOn` list. A list is initialized for the first `add/addAll` call,
* and subsequent calls adds additional elements to the original list. See {@link
* ProductUpdateParams#deactivateOn} for the field documentation.
*/
public Builder addDeactivateOn(String element) {
if (this.deactivateOn == null) {
this.deactivateOn = new ArrayList<>();
}
this.deactivateOn.add(element);
return this;
}
/**
* Add all elements to `deactivateOn` list. A list is initialized for the first `add/addAll`
* call, and subsequent calls adds additional elements to the original list. See {@link
* ProductUpdateParams#deactivateOn} for the field documentation.
*/
public Builder addAllDeactivateOn(List elements) {
if (this.deactivateOn == null) {
this.deactivateOn = new ArrayList<>();
}
this.deactivateOn.addAll(elements);
return this;
}
/** The product's description, meant to be displayable to the customer. */
public Builder setDescription(String description) {
this.description = description;
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
* ProductUpdateParams#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
* ProductUpdateParams#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
* ProductUpdateParams#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 ProductUpdateParams#extraParams} for the field documentation.
*/
public Builder putAllExtraParam(Map map) {
if (this.extraParams == null) {
this.extraParams = new HashMap<>();
}
this.extraParams.putAll(map);
return this;
}
/**
* A list of up to 8 URLs of images for this product, meant to be displayable to the customer.
*/
public Builder setImages(EmptyParam images) {
this.images = images;
return this;
}
/**
* A list of up to 8 URLs of images for this product, meant to be displayable to the customer.
*/
public Builder setImages(List images) {
this.images = images;
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
* ProductUpdateParams#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 ProductUpdateParams#metadata} for the field documentation.
*/
public Builder putAllMetadata(Map map) {
if (this.metadata == null) {
this.metadata = new HashMap<>();
}
this.metadata.putAll(map);
return this;
}
/**
* The product's name, meant to be displayable to the customer. Applicable to both `service` and
* `good` types.
*/
public Builder setName(String name) {
this.name = name;
return this;
}
/**
* The dimensions of this product for shipping purposes. A SKU associated with this product can
* override this value by having its own `package_dimensions`.
*/
public Builder setPackageDimensions(PackageDimensions packageDimensions) {
this.packageDimensions = packageDimensions;
return this;
}
/**
* The dimensions of this product for shipping purposes. A SKU associated with this product can
* override this value by having its own `package_dimensions`.
*/
public Builder setPackageDimensions(EmptyParam packageDimensions) {
this.packageDimensions = packageDimensions;
return this;
}
/** Whether this product is shipped (i.e., physical goods). Defaults to `true`. */
public Builder setShippable(Boolean shippable) {
this.shippable = shippable;
return this;
}
/**
* An arbitrary string to be displayed on your customer's credit card statement. This may be up
* to 22 characters. The statement description may not include "' characters, and will appear on
* your customer's statement in capital letters. Non-ASCII characters are automatically
* stripped. While most banks display this information consistently, some may display it
* incorrectly or not at all. It must contain at least one letter. May only be set if
* type=`service`.
*/
public Builder setStatementDescriptor(String statementDescriptor) {
this.statementDescriptor = statementDescriptor;
return this;
}
/**
* A label that represents units of this product, such as seat(s), in Stripe and on customers’
* receipts and invoices. Only available on products of type=`service`.
*/
public Builder setUnitLabel(String unitLabel) {
this.unitLabel = unitLabel;
return this;
}
/** A URL of a publicly-accessible webpage for this product. */
public Builder setUrl(String url) {
this.url = url;
return this;
}
}
public static class PackageDimensions {
/**
* 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;
/** Height, in inches. Maximum precision is 2 decimal places. */
@SerializedName("height")
BigDecimal height;
/** Length, in inches. Maximum precision is 2 decimal places. */
@SerializedName("length")
BigDecimal length;
/** Weight, in ounces. Maximum precision is 2 decimal places. */
@SerializedName("weight")
BigDecimal weight;
/** Width, in inches. Maximum precision is 2 decimal places. */
@SerializedName("width")
BigDecimal width;
private PackageDimensions(
Map extraParams,
BigDecimal height,
BigDecimal length,
BigDecimal weight,
BigDecimal width) {
this.extraParams = extraParams;
this.height = height;
this.length = length;
this.weight = weight;
this.width = width;
}
public static Builder builder() {
return new com.stripe.param.ProductUpdateParams.PackageDimensions.Builder();
}
public static class Builder {
private Map extraParams;
private BigDecimal height;
private BigDecimal length;
private BigDecimal weight;
private BigDecimal width;
/** Finalize and obtain parameter instance from this builder. */
public PackageDimensions build() {
return new PackageDimensions(
this.extraParams, this.height, this.length, this.weight, this.width);
}
/**
* 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
* ProductUpdateParams.PackageDimensions#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 ProductUpdateParams.PackageDimensions#extraParams} for the field documentation.
*/
public Builder putAllExtraParam(Map map) {
if (this.extraParams == null) {
this.extraParams = new HashMap<>();
}
this.extraParams.putAll(map);
return this;
}
/** Height, in inches. Maximum precision is 2 decimal places. */
public Builder setHeight(BigDecimal height) {
this.height = height;
return this;
}
/** Length, in inches. Maximum precision is 2 decimal places. */
public Builder setLength(BigDecimal length) {
this.length = length;
return this;
}
/** Weight, in ounces. Maximum precision is 2 decimal places. */
public Builder setWeight(BigDecimal weight) {
this.weight = weight;
return this;
}
/** Width, in inches. Maximum precision is 2 decimal places. */
public Builder setWidth(BigDecimal width) {
this.width = width;
return this;
}
}
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy