com.stripe.param.ProductListParams Maven / Gradle / Ivy
// Generated by delombok at Wed Apr 24 18:37:47 PDT 2019
// 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.List;
public class ProductListParams extends ApiRequestParams {
/**
* Only return products that are active or inactive (e.g., pass `false` to list all inactive
* products).
*/
@SerializedName("active")
Boolean active;
/**
* Only return products that were created during the given date interval.
*/
@SerializedName("created")
Object created;
/**
* A cursor for use in pagination. `ending_before` is an object ID that defines your place in the
* list. For instance, if you make a list request and receive 100 objects, starting with
* `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the
* previous page of the list.
*/
@SerializedName("ending_before")
String endingBefore;
/**
* Specifies which fields in the response should be expanded.
*/
@SerializedName("expand")
List expand;
/**
* Only return products with the given IDs.
*/
@SerializedName("ids")
List ids;
/**
* A limit on the number of objects to be returned. Limit can range between 1 and 100, and the
* default is 10.
*/
@SerializedName("limit")
Long limit;
/**
* Only return products that can be shipped (i.e., physical, not digital products).
*/
@SerializedName("shippable")
Boolean shippable;
/**
* A cursor for use in pagination. `starting_after` is an object ID that defines your place in the
* list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`,
* your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of
* the list.
*/
@SerializedName("starting_after")
String startingAfter;
/**
* Only return products of this type.
*/
@SerializedName("type")
Type type;
/**
* Only return products with the given url.
*/
@SerializedName("url")
String url;
private ProductListParams(Boolean active, Object created, String endingBefore, List expand, List ids, Long limit, Boolean shippable, String startingAfter, Type type, String url) {
this.active = active;
this.created = created;
this.endingBefore = endingBefore;
this.expand = expand;
this.ids = ids;
this.limit = limit;
this.shippable = shippable;
this.startingAfter = startingAfter;
this.type = type;
this.url = url;
}
public static Builder builder() {
return new com.stripe.param.ProductListParams.Builder();
}
public static class Builder {
private Boolean active;
private Object created;
private String endingBefore;
private List expand;
private List ids;
private Long limit;
private Boolean shippable;
private String startingAfter;
private Type type;
private String url;
/**
* Finalize and obtain parameter instance from this builder.
*/
public ProductListParams build() {
return new ProductListParams(this.active, this.created, this.endingBefore, this.expand, this.ids, this.limit, this.shippable, this.startingAfter, this.type, this.url);
}
/**
* Only return products that are active or inactive (e.g., pass `false` to list all inactive
* products).
*/
public Builder setActive(Boolean active) {
this.active = active;
return this;
}
/**
* Only return products that were created during the given date interval.
*/
public Builder setCreated(Created created) {
this.created = created;
return this;
}
/**
* Only return products that were created during the given date interval.
*/
public Builder setCreated(Long created) {
this.created = created;
return this;
}
/**
* A cursor for use in pagination. `ending_before` is an object ID that defines your place in
* the list. For instance, if you make a list request and receive 100 objects, starting with
* `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the
* previous page of the list.
*/
public Builder setEndingBefore(String endingBefore) {
this.endingBefore = endingBefore;
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
* ProductListParams#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
* ProductListParams#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 an element to `ids` list. A list is initialized for the first `add/addAll` call, and
* subsequent calls adds additional elements to the original list. See {@link
* ProductListParams#ids} for the field documentation.
*/
public Builder addId(String element) {
if (this.ids == null) {
this.ids = new ArrayList<>();
}
this.ids.add(element);
return this;
}
/**
* Add all elements to `ids` list. A list is initialized for the first `add/addAll` call, and
* subsequent calls adds additional elements to the original list. See {@link
* ProductListParams#ids} for the field documentation.
*/
public Builder addAllId(List elements) {
if (this.ids == null) {
this.ids = new ArrayList<>();
}
this.ids.addAll(elements);
return this;
}
/**
* A limit on the number of objects to be returned. Limit can range between 1 and 100, and the
* default is 10.
*/
public Builder setLimit(Long limit) {
this.limit = limit;
return this;
}
/**
* Only return products that can be shipped (i.e., physical, not digital products).
*/
public Builder setShippable(Boolean shippable) {
this.shippable = shippable;
return this;
}
/**
* A cursor for use in pagination. `starting_after` is an object ID that defines your place in
* the list. For instance, if you make a list request and receive 100 objects, ending with
* `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the
* next page of the list.
*/
public Builder setStartingAfter(String startingAfter) {
this.startingAfter = startingAfter;
return this;
}
/**
* Only return products of this type.
*/
public Builder setType(Type type) {
this.type = type;
return this;
}
/**
* Only return products with the given url.
*/
public Builder setUrl(String url) {
this.url = url;
return this;
}
}
public static class Created {
/**
* Minimum value to filter by (exclusive).
*/
@SerializedName("gt")
Long gt;
/**
* Minimum value to filter by (inclusive).
*/
@SerializedName("gte")
Long gte;
/**
* Maximum value to filter by (exclusive).
*/
@SerializedName("lt")
Long lt;
/**
* Maximum value to filter by (inclusive).
*/
@SerializedName("lte")
Long lte;
private Created(Long gt, Long gte, Long lt, Long lte) {
this.gt = gt;
this.gte = gte;
this.lt = lt;
this.lte = lte;
}
public static Builder builder() {
return new com.stripe.param.ProductListParams.Created.Builder();
}
public static class Builder {
private Long gt;
private Long gte;
private Long lt;
private Long lte;
/** Finalize and obtain parameter instance from this builder. */
public Created build() {
return new Created(this.gt, this.gte, this.lt, this.lte);
}
/** Minimum value to filter by (exclusive). */
public Builder setGt(Long gt) {
this.gt = gt;
return this;
}
/** Minimum value to filter by (inclusive). */
public Builder setGte(Long gte) {
this.gte = gte;
return this;
}
/** Maximum value to filter by (exclusive). */
public Builder setLt(Long lt) {
this.lt = lt;
return this;
}
public Builder setLte(Long lte) {
this.lte = lte;
return this;
}
}
}
/**
* Maximum value to filter by (inclusive).
*/
public enum Type implements ApiRequestParams.EnumParam {
@SerializedName("good")
GOOD("good"), @SerializedName("service")
SERVICE("service");
private final String value;
Type(String value) {
this.value = value;
}
@Override
@java.lang.SuppressWarnings("all")
@lombok.Generated
public String getValue() {
return this.value;
}
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy