Package com.stripe.model.radar

Class ValueList

java.lang.Object

com.stripe.model.StripeObject

com.stripe.net.ApiResource

com.stripe.model.radar.ValueList

All Implemented Interfaces:

HasId, MetadataStore<ValueList>, StripeActiveObject, StripeObjectInterface

public class ValueList
extends ApiResource
implements HasId, MetadataStore<ValueList>

Value lists allow you to group values together which can then be referenced in rules.

Related guide: Default Stripe lists

Nested Class Summary

Nested classes/interfaces inherited from class com.stripe.net.ApiResource

ApiResource.RequestMethod

Field Summary

Fields inherited from class com.stripe.net.ApiResource

CHARSET, GSON, INTERNAL_GSON

Fields inherited from class com.stripe.model.StripeObject

PRETTY_PRINT_GSON

Constructor Summary

Constructors

Constructor	Description
ValueList()

Method Summary

Modifier and Type	Method	Description
protected boolean	canEqual(Object other)
static ValueList	create(ValueListCreateParams params)	Creates a new ValueList object, which can then be referenced in rules.
static ValueList	create(ValueListCreateParams params, RequestOptions options)	Creates a new ValueList object, which can then be referenced in rules.
static ValueList	create(Map<String,Object> params)	Creates a new ValueList object, which can then be referenced in rules.
static ValueList	create(Map<String,Object> params, RequestOptions options)	Creates a new ValueList object, which can then be referenced in rules.
ValueList	delete()	Deletes a ValueList object, also deleting any items contained within the value list.
ValueList	delete(RequestOptions options)	Deletes a ValueList object, also deleting any items contained within the value list.
ValueList	delete(Map<String,Object> params)	Deletes a ValueList object, also deleting any items contained within the value list.
ValueList	delete(Map<String,Object> params, RequestOptions options)	Deletes a ValueList object, also deleting any items contained within the value list.
boolean	equals(Object o)
String	getAlias()	The name of the value list for use in rules.
Long	getCreated()	Time at which the object was created.
String	getCreatedBy()	The name or email address of the user who created this value list.
Boolean	getDeleted()	Always true for a deleted object.
String	getId()	Unique identifier for the object.
String	getItemType()	The type of items in the value list.
ValueListItemCollection	getListItems()	List of items contained within this value list.
Boolean	getLivemode()	If the object exists in live mode, the value is true.
Map<String,String>	getMetadata()	Set of key-value pairs that you can attach to an object.
String	getName()	The name of the value list.
String	getObject()	String representing the object's type.
int	hashCode()
static ValueListCollection	list(ValueListListParams params)	Returns a list of ValueList objects.
static ValueListCollection	list(ValueListListParams params, RequestOptions options)	Returns a list of ValueList objects.
static ValueListCollection	list(Map<String,Object> params)	Returns a list of ValueList objects.
static ValueListCollection	list(Map<String,Object> params, RequestOptions options)	Returns a list of ValueList objects.
static ValueList	retrieve(String valueList)	Retrieves a ValueList object.
static ValueList	retrieve(String valueList, RequestOptions options)	Retrieves a ValueList object.
static ValueList	retrieve(String valueList, ValueListRetrieveParams params, RequestOptions options)	Retrieves a ValueList object.
static ValueList	retrieve(String valueList, Map<String,Object> params, RequestOptions options)	Retrieves a ValueList object.
void	setAlias(String alias)	The name of the value list for use in rules.
void	setCreated(Long created)	Time at which the object was created.
void	setCreatedBy(String createdBy)	The name or email address of the user who created this value list.
void	setDeleted(Boolean deleted)	Always true for a deleted object.
void	setId(String id)	Unique identifier for the object.
void	setItemType(String itemType)	The type of items in the value list.
void	setListItems(ValueListItemCollection listItems)	List of items contained within this value list.
void	setLivemode(Boolean livemode)	If the object exists in live mode, the value is true.
void	setMetadata(Map<String,String> metadata)	Set of key-value pairs that you can attach to an object.
void	setName(String name)	The name of the value list.
void	setObject(String object)	String representing the object's type.
void	setResponseGetter(StripeResponseGetter responseGetter)	Method is used by the containing object or StripeResponseGetter implementations to set the StripeResponseGetter instance used to make further requests.
ValueList	update(ValueListUpdateParams params)	Updates a ValueList object by setting the values of the parameters passed.
ValueList	update(ValueListUpdateParams params, RequestOptions options)	Updates a ValueList object by setting the values of the parameters passed.
ValueList	update(Map<String,Object> params)	Updates a ValueList object by setting the values of the parameters passed.
ValueList	update(Map<String,Object> params, RequestOptions options)	Updates a ValueList object by setting the values of the parameters passed.

Methods inherited from class com.stripe.net.ApiResource

checkNullTypedParams, getGlobalResponseGetter, getResponseGetter, setExpandableFieldId, setGlobalResponseGetter, urlEncode, urlEncodeId

Methods inherited from class com.stripe.model.StripeObject

deserializeStripeObject, deserializeStripeObject, deserializeStripeObject, deserializeStripeObject, equals, getLastResponse, getRawJsonObject, setLastResponse, toJson, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.stripe.model.StripeActiveObject

trySetResponseGetter

Constructor Details

ValueList

public ValueList()

Method Details

create

public static ValueList create(Map<String,Object> params)
                        throws StripeException

Creates a new ValueList object, which can then be referenced in rules.

Throws:

StripeException

create

public static ValueList create(Map<String,Object> params,
 RequestOptions options)
                        throws StripeException

Creates a new ValueList object, which can then be referenced in rules.

Throws:

StripeException

create

public static ValueList create(ValueListCreateParams params)
                        throws StripeException

Creates a new ValueList object, which can then be referenced in rules.

Throws:

StripeException

create

public static ValueList create(ValueListCreateParams params,
 RequestOptions options)
                        throws StripeException

Creates a new ValueList object, which can then be referenced in rules.

Throws:

StripeException

delete

public ValueList delete()
                 throws StripeException

Deletes a ValueList object, also deleting any items contained within the value list. To be deleted, a value list must not be referenced in any rules.

Throws:

StripeException

delete

public ValueList delete(RequestOptions options)
                 throws StripeException

Deletes a ValueList object, also deleting any items contained within the value list. To be deleted, a value list must not be referenced in any rules.

Throws:

StripeException

delete

public ValueList delete(Map<String,Object> params)
                 throws StripeException

Deletes a ValueList object, also deleting any items contained within the value list. To be deleted, a value list must not be referenced in any rules.

Throws:

StripeException

delete

public ValueList delete(Map<String,Object> params,
 RequestOptions options)
                 throws StripeException

Deletes a ValueList object, also deleting any items contained within the value list. To be deleted, a value list must not be referenced in any rules.

Throws:

StripeException

list

public static ValueListCollection list(Map<String,Object> params)
                                throws StripeException

Returns a list of ValueList objects. The objects are sorted in descending order by creation date, with the most recently created object appearing first.

Throws:

StripeException

list

public static ValueListCollection list(Map<String,Object> params,
 RequestOptions options)
                                throws StripeException

Returns a list of ValueList objects. The objects are sorted in descending order by creation date, with the most recently created object appearing first.

Throws:

StripeException

list

public static ValueListCollection list(ValueListListParams params)
                                throws StripeException

Returns a list of ValueList objects. The objects are sorted in descending order by creation date, with the most recently created object appearing first.

Throws:

StripeException

list

public static ValueListCollection list(ValueListListParams params,
 RequestOptions options)
                                throws StripeException

Returns a list of ValueList objects. The objects are sorted in descending order by creation date, with the most recently created object appearing first.

Throws:

StripeException

retrieve

public static ValueList retrieve(String valueList)
                          throws StripeException

Retrieves a ValueList object.

Throws:

StripeException

retrieve

public static ValueList retrieve(String valueList,
 RequestOptions options)
                          throws StripeException

Retrieves a ValueList object.

Throws:

StripeException

retrieve

public static ValueList retrieve(String valueList,
 Map<String,Object> params,
 RequestOptions options)
                          throws StripeException

Retrieves a ValueList object.

Throws:

StripeException

retrieve

public static ValueList retrieve(String valueList,
 ValueListRetrieveParams params,
 RequestOptions options)
                          throws StripeException

Retrieves a ValueList object.

Throws:

StripeException

update

public ValueList update(Map<String,Object> params)
                 throws StripeException

Updates a ValueList object by setting the values of the parameters passed. Any parameters not provided will be left unchanged. Note that item_type is immutable.

Specified by:

update in interface MetadataStore<ValueList>

Throws:

StripeException

update

public ValueList update(Map<String,Object> params,
 RequestOptions options)
                 throws StripeException

Updates a ValueList object by setting the values of the parameters passed. Any parameters not provided will be left unchanged. Note that item_type is immutable.

Specified by:

update in interface MetadataStore<ValueList>

Throws:

StripeException

update

public ValueList update(ValueListUpdateParams params)
                 throws StripeException

Updates a ValueList object by setting the values of the parameters passed. Any parameters not provided will be left unchanged. Note that item_type is immutable.

Throws:

StripeException

update

public ValueList update(ValueListUpdateParams params,
 RequestOptions options)
                 throws StripeException

Updates a ValueList object by setting the values of the parameters passed. Any parameters not provided will be left unchanged. Note that item_type is immutable.

Throws:

StripeException

setResponseGetter

public void setResponseGetter(StripeResponseGetter responseGetter)

Description copied from interface: StripeActiveObject

Method is used by the containing object or StripeResponseGetter implementations to set the StripeResponseGetter instance used to make further requests.

Specified by:

setResponseGetter in interface StripeActiveObject

Overrides:

setResponseGetter in class ApiResource

Parameters:

responseGetter - the StripeResponseGetter instance to use for making further requests.

getAlias

public String getAlias()

The name of the value list for use in rules.

getCreated

public Long getCreated()

Time at which the object was created. Measured in seconds since the Unix epoch.

getCreatedBy

public String getCreatedBy()

The name or email address of the user who created this value list.

getDeleted

public Boolean getDeleted()

Always true for a deleted object.

getItemType

public String getItemType()

The type of items in the value list. One of card_fingerprint, card_bin, crypto_fingerprint, email, ip_address, country, string, case_sensitive_string, customer_id, sepa_debit_fingerprint, or us_bank_account_fingerprint.

getListItems

public ValueListItemCollection getListItems()

List of items contained within this value list.

getLivemode

public Boolean getLivemode()

If the object exists in live mode, the value is true. If the object exists in test mode, the value is false.

getName

public String getName()

The name of the value list.

getObject

public String getObject()

String representing the object's type. Objects of the same type share the same value.

Equal to radar.value_list.

setAlias

public void setAlias(String alias)

The name of the value list for use in rules.

setCreated

public void setCreated(Long created)

Time at which the object was created. Measured in seconds since the Unix epoch.

setCreatedBy

public void setCreatedBy(String createdBy)

The name or email address of the user who created this value list.

setDeleted

public void setDeleted(Boolean deleted)

Always true for a deleted object.

setId

public void setId(String id)

Unique identifier for the object.

setItemType

public void setItemType(String itemType)

The type of items in the value list. One of card_fingerprint, card_bin, crypto_fingerprint, email, ip_address, country, string, case_sensitive_string, customer_id, sepa_debit_fingerprint, or us_bank_account_fingerprint.

setListItems

public void setListItems(ValueListItemCollection listItems)

List of items contained within this value list.

setLivemode

public void setLivemode(Boolean livemode)

If the object exists in live mode, the value is true. If the object exists in test mode, the value is false.

setMetadata

public void setMetadata(Map<String,String> metadata)

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.

setName

public void setName(String name)

The name of the value list.

setObject

public void setObject(String object)

String representing the object's type. Objects of the same type share the same value.

Equal to radar.value_list.

equals

public boolean equals(Object o)

Overrides:

equals in class Object

canEqual

protected boolean canEqual(Object other)

hashCode

public int hashCode()

Overrides:

hashCode in class Object

getId

public String getId()

Unique identifier for the object.

Specified by:

getId in interface HasId

getMetadata

public Map<String,String> getMetadata()

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.

Specified by:

getMetadata in interface MetadataStore<ValueList>