com.stripe.param.terminal.ReaderListParams Maven / Gradle / Ivy
// Generated by delombok at Tue Jun 18 17:32:51 PDT 2019
// Generated by com.stripe.generator.entity.SdkBuilder
package com.stripe.param.terminal;
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 ReaderListParams extends ApiRequestParams {
/**
* 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;
/**
* 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 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;
/**
* A location ID to filter the response list to only readers at the specific location.
*/
@SerializedName("location")
String location;
/**
* To [group
* objects](https://stripe.com/docs/terminal/payments/connect#grouping-objects-by-connected-account)
* on your platform account by connected account, set this parameter to the connected account ID.
*/
@SerializedName("operator_account")
String operatorAccount;
/**
* 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;
/**
* A status filter to filter readers to only offline or online readers.
*/
@SerializedName("status")
Object status;
private ReaderListParams(String endingBefore, List expand, Map extraParams, Long limit, String location, String operatorAccount, String startingAfter, Object status) {
this.endingBefore = endingBefore;
this.expand = expand;
this.extraParams = extraParams;
this.limit = limit;
this.location = location;
this.operatorAccount = operatorAccount;
this.startingAfter = startingAfter;
this.status = status;
}
public static Builder builder() {
return new com.stripe.param.terminal.ReaderListParams.Builder();
}
public static class Builder {
private String endingBefore;
private List expand;
private Map extraParams;
private Long limit;
private String location;
private String operatorAccount;
private String startingAfter;
private Object status;
/**
* Finalize and obtain parameter instance from this builder.
*/
public ReaderListParams build() {
return new ReaderListParams(this.endingBefore, this.expand, this.extraParams, this.limit, this.location, this.operatorAccount, this.startingAfter, this.status);
}
/**
* 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
* ReaderListParams#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
* ReaderListParams#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
* ReaderListParams#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 ReaderListParams#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 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;
}
/**
* A location ID to filter the response list to only readers at the specific location.
*/
public Builder setLocation(String location) {
this.location = location;
return this;
}
/**
* To [group
* objects](https://stripe.com/docs/terminal/payments/connect#grouping-objects-by-connected-account)
* on your platform account by connected account, set this parameter to the connected account
* ID.
*/
public Builder setOperatorAccount(String operatorAccount) {
this.operatorAccount = operatorAccount;
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;
}
/**
* A status filter to filter readers to only offline or online readers.
*/
public Builder setStatus(Status status) {
this.status = status;
return this;
}
/**
* A status filter to filter readers to only offline or online readers.
*/
public Builder setStatus(String status) {
this.status = status;
return this;
}
}
public enum Status implements ApiRequestParams.EnumParam {
@SerializedName("offline")
OFFLINE("offline"), @SerializedName("online")
ONLINE("online");
private final String value;
Status(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