Package com.stripe.model.terminal

Class Location

java.lang.Object

com.stripe.model.StripeObject

com.stripe.net.ApiResource

com.stripe.model.terminal.Location

All Implemented Interfaces:

HasId, MetadataStore<Location>, StripeActiveObject, StripeObjectInterface

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

A Location represents a grouping of readers.

Related guide: Fleet management

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Location.AddressKana	For more details about AddressKana, please refer to the API Reference.
static class	Location.AddressKanji	For more details about AddressKanji, please refer to the API Reference.

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
Location()

Method Summary

Modifier and Type	Method	Description
protected boolean	canEqual(Object other)
static Location	create(LocationCreateParams params)	Creates a new Location object.
static Location	create(LocationCreateParams params, RequestOptions options)	Creates a new Location object.
static Location	create(Map<String,Object> params)	Creates a new Location object.
static Location	create(Map<String,Object> params, RequestOptions options)	Creates a new Location object.
Location	delete()	Deletes a Location object.
Location	delete(RequestOptions options)	Deletes a Location object.
Location	delete(Map<String,Object> params)	Deletes a Location object.
Location	delete(Map<String,Object> params, RequestOptions options)	Deletes a Location object.
boolean	equals(Object o)
Address	getAddress()
Location.AddressKana	getAddressKana()
Location.AddressKanji	getAddressKanji()
String	getConfigurationOverrides()	The ID of a configuration that will be used to customize all readers in this location.
Boolean	getDeleted()	Always true for a deleted object.
String	getDisplayName()	The display name of the location.
String	getDisplayNameKana()	The Kana variation of the display name of the location.
String	getDisplayNameKanji()	The Kanji variation of the display name of the location.
String	getId()	Unique identifier for the object.
Boolean	getLivemode()	Has the value true if the object exists in live mode or the value false if the object exists in test mode.
Map<String,String>	getMetadata()	Set of key-value pairs that you can attach to an object.
String	getObject()	String representing the object's type.
String	getPhone()	The phone number of the location.
int	hashCode()
static LocationCollection	list(LocationListParams params)	Returns a list of Location objects.
static LocationCollection	list(LocationListParams params, RequestOptions options)	Returns a list of Location objects.
static LocationCollection	list(Map<String,Object> params)	Returns a list of Location objects.
static LocationCollection	list(Map<String,Object> params, RequestOptions options)	Returns a list of Location objects.
static Location	retrieve(String location)	Retrieves a Location object.
static Location	retrieve(String location, RequestOptions options)	Retrieves a Location object.
static Location	retrieve(String location, LocationRetrieveParams params, RequestOptions options)	Retrieves a Location object.
static Location	retrieve(String location, Map<String,Object> params, RequestOptions options)	Retrieves a Location object.
void	setAddress(Address address)
void	setAddressKana(Location.AddressKana addressKana)
void	setAddressKanji(Location.AddressKanji addressKanji)
void	setConfigurationOverrides(String configurationOverrides)	The ID of a configuration that will be used to customize all readers in this location.
void	setDeleted(Boolean deleted)	Always true for a deleted object.
void	setDisplayName(String displayName)	The display name of the location.
void	setDisplayNameKana(String displayNameKana)	The Kana variation of the display name of the location.
void	setDisplayNameKanji(String displayNameKanji)	The Kanji variation of the display name of the location.
void	setId(String id)	Unique identifier for the object.
void	setLivemode(Boolean livemode)	Has the value true if the object exists in live mode or the value false if the object exists in test mode.
void	setMetadata(Map<String,String> metadata)	Set of key-value pairs that you can attach to an object.
void	setObject(String object)	String representing the object's type.
void	setPhone(String phone)	The phone number of the location.
void	setResponseGetter(StripeResponseGetter responseGetter)	Method is used by the containing object or StripeResponseGetter implementations to set the StripeResponseGetter instance used to make further requests.
Location	update(LocationUpdateParams params)	Updates a Location object by setting the values of the parameters passed.
Location	update(LocationUpdateParams params, RequestOptions options)	Updates a Location object by setting the values of the parameters passed.
Location	update(Map<String,Object> params)	Updates a Location object by setting the values of the parameters passed.
Location	update(Map<String,Object> params, RequestOptions options)	Updates a Location 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

Location

public Location()

Method Details

create

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

Creates a new Location object. For further details, including which address fields are required in each country, see the Manage locations guide.

Throws:

StripeException

create

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

Creates a new Location object. For further details, including which address fields are required in each country, see the Manage locations guide.

Throws:

StripeException

create

public static Location create(LocationCreateParams params)
                       throws StripeException

Creates a new Location object. For further details, including which address fields are required in each country, see the Manage locations guide.

Throws:

StripeException

create

public static Location create(LocationCreateParams params,
 RequestOptions options)
                       throws StripeException

Creates a new Location object. For further details, including which address fields are required in each country, see the Manage locations guide.

Throws:

StripeException

delete

public Location delete()
                throws StripeException

Deletes a Location object.

Throws:

StripeException

delete

public Location delete(RequestOptions options)
                throws StripeException

Deletes a Location object.

Throws:

StripeException

delete

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

Deletes a Location object.

Throws:

StripeException

delete

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

Deletes a Location object.

Throws:

StripeException

list

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

Returns a list of Location objects.

Throws:

StripeException

list

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

Returns a list of Location objects.

Throws:

StripeException

list

public static LocationCollection list(LocationListParams params)
                               throws StripeException

Returns a list of Location objects.

Throws:

StripeException

list

public static LocationCollection list(LocationListParams params,
 RequestOptions options)
                               throws StripeException

Returns a list of Location objects.

Throws:

StripeException

retrieve

public static Location retrieve(String location)
                         throws StripeException

Retrieves a Location object.

Throws:

StripeException

retrieve

public static Location retrieve(String location,
 RequestOptions options)
                         throws StripeException

Retrieves a Location object.

Throws:

StripeException

retrieve

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

Retrieves a Location object.

Throws:

StripeException

retrieve

public static Location retrieve(String location,
 LocationRetrieveParams params,
 RequestOptions options)
                         throws StripeException

Retrieves a Location object.

Throws:

StripeException

update

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

Updates a Location object by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

Specified by:

update in interface MetadataStore<Location>

Throws:

StripeException

update

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

Updates a Location object by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

Specified by:

update in interface MetadataStore<Location>

Throws:

StripeException

update

public Location update(LocationUpdateParams params)
                throws StripeException

Updates a Location object by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

Throws:

StripeException

update

public Location update(LocationUpdateParams params,
 RequestOptions options)
                throws StripeException

Updates a Location object by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

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.

getAddress

public Address getAddress()

getAddressKana

public Location.AddressKana getAddressKana()

getAddressKanji

public Location.AddressKanji getAddressKanji()

getConfigurationOverrides

public String getConfigurationOverrides()

The ID of a configuration that will be used to customize all readers in this location.

getDeleted

public Boolean getDeleted()

Always true for a deleted object.

getDisplayName

public String getDisplayName()

The display name of the location.

getDisplayNameKana

public String getDisplayNameKana()

The Kana variation of the display name of the location.

getDisplayNameKanji

public String getDisplayNameKanji()

The Kanji variation of the display name of the location.

getLivemode

public Boolean getLivemode()

Has the value true if the object exists in live mode or the value false if the object exists in test mode.

getObject

public String getObject()

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

Equal to terminal.location.

getPhone

public String getPhone()

The phone number of the location.

setAddress

public void setAddress(Address address)

setAddressKana

public void setAddressKana(Location.AddressKana addressKana)

setAddressKanji

public void setAddressKanji(Location.AddressKanji addressKanji)

setConfigurationOverrides

public void setConfigurationOverrides(String configurationOverrides)

The ID of a configuration that will be used to customize all readers in this location.

setDeleted

public void setDeleted(Boolean deleted)

Always true for a deleted object.

setDisplayName

public void setDisplayName(String displayName)

The display name of the location.

setDisplayNameKana

public void setDisplayNameKana(String displayNameKana)

The Kana variation of the display name of the location.

setDisplayNameKanji

public void setDisplayNameKanji(String displayNameKanji)

The Kanji variation of the display name of the location.

setId

public void setId(String id)

Unique identifier for the object.

setLivemode

public void setLivemode(Boolean livemode)

Has the value true if the object exists in live mode or the value false if the object exists in test mode.

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.

setObject

public void setObject(String object)

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

Equal to terminal.location.

setPhone

public void setPhone(String phone)

The phone number of the location.

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<Location>