public static class OrderListParams.Builder
extends java.lang.Object
Constructor and Description |
---|
Builder() |
Modifier and Type | Method and Description |
---|---|
OrderListParams.Builder |
addAllExpand(java.util.List<java.lang.String> elements)
Add all elements to `expand` list.
|
OrderListParams.Builder |
addAllId(java.util.List<java.lang.String> elements)
Add all elements to `ids` list.
|
OrderListParams.Builder |
addAllUpstreamId(java.util.List<java.lang.String> elements)
Add all elements to `upstreamIds` list.
|
OrderListParams.Builder |
addExpand(java.lang.String element)
Add an element to `expand` list.
|
OrderListParams.Builder |
addId(java.lang.String element)
Add an element to `ids` list.
|
OrderListParams.Builder |
addUpstreamId(java.lang.String element)
Add an element to `upstreamIds` list.
|
OrderListParams |
build()
Finalize and obtain parameter instance from this builder.
|
OrderListParams.Builder |
putAllExtraParam(java.util.Map<java.lang.String,java.lang.Object> map)
Add all map key/value pairs to `extraParams` map.
|
OrderListParams.Builder |
putExtraParam(java.lang.String key,
java.lang.Object value)
Add a key/value pair to `extraParams` map.
|
OrderListParams.Builder |
setCreated(java.lang.Long created)
Date this order was created.
|
OrderListParams.Builder |
setCreated(OrderListParams.Created created)
Date this order was created.
|
OrderListParams.Builder |
setCustomer(java.lang.String customer)
Only return orders for the given customer.
|
OrderListParams.Builder |
setEndingBefore(java.lang.String endingBefore)
A cursor for use in pagination.
|
OrderListParams.Builder |
setLimit(java.lang.Long limit)
A limit on the number of objects to be returned.
|
OrderListParams.Builder |
setStartingAfter(java.lang.String startingAfter)
A cursor for use in pagination.
|
OrderListParams.Builder |
setStatus(java.lang.String status)
Only return orders that have the given status.
|
OrderListParams.Builder |
setStatusTransitions(OrderListParams.StatusTransitions statusTransitions)
Filter orders based on when they were paid, fulfilled, canceled, or returned.
|
public OrderListParams build()
public OrderListParams.Builder setCreated(OrderListParams.Created created)
public OrderListParams.Builder setCreated(java.lang.Long created)
public OrderListParams.Builder setCustomer(java.lang.String customer)
public OrderListParams.Builder setEndingBefore(java.lang.String endingBefore)
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 OrderListParams.Builder addExpand(java.lang.String element)
OrderListParams.expand
for the field documentation.public OrderListParams.Builder addAllExpand(java.util.List<java.lang.String> elements)
OrderListParams.expand
for the field documentation.public OrderListParams.Builder putExtraParam(java.lang.String key, java.lang.Object value)
OrderListParams.extraParams
for the field documentation.public OrderListParams.Builder putAllExtraParam(java.util.Map<java.lang.String,java.lang.Object> map)
OrderListParams.extraParams
for the field documentation.public OrderListParams.Builder addId(java.lang.String element)
OrderListParams.ids
for the field documentation.public OrderListParams.Builder addAllId(java.util.List<java.lang.String> elements)
OrderListParams.ids
for the field documentation.public OrderListParams.Builder setLimit(java.lang.Long limit)
public OrderListParams.Builder setStartingAfter(java.lang.String startingAfter)
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 OrderListParams.Builder setStatus(java.lang.String status)
created
, paid
, fulfilled
, or refunded
.public OrderListParams.Builder setStatusTransitions(OrderListParams.StatusTransitions statusTransitions)
public OrderListParams.Builder addUpstreamId(java.lang.String element)
OrderListParams.upstreamIds
for the field documentation.public OrderListParams.Builder addAllUpstreamId(java.util.List<java.lang.String> elements)
OrderListParams.upstreamIds
for the field documentation.