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>
,StripeObjectInterface
public class Location extends ApiResource implements HasId, MetadataStore<Location>
-
-
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
-
Fields inherited from class com.stripe.model.StripeObject
PRETTY_PRINT_GSON
-
-
Constructor Summary
Constructors Constructor Description Location()
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description protected boolean
canEqual(java.lang.Object other)
static Location
create(LocationCreateParams params)
Creates a newLocation
object.static Location
create(LocationCreateParams params, RequestOptions options)
Creates a newLocation
object.static Location
create(java.util.Map<java.lang.String,java.lang.Object> params)
Creates a newLocation
object.static Location
create(java.util.Map<java.lang.String,java.lang.Object> params, RequestOptions options)
Creates a newLocation
object.Location
delete()
Deletes aLocation
object.Location
delete(RequestOptions options)
Deletes aLocation
object.Location
delete(java.util.Map<java.lang.String,java.lang.Object> params)
Deletes aLocation
object.Location
delete(java.util.Map<java.lang.String,java.lang.Object> params, RequestOptions options)
Deletes aLocation
object.boolean
equals(java.lang.Object o)
Address
getAddress()
java.lang.Boolean
getDeleted()
Always true for a deleted object.java.lang.String
getDisplayName()
The display name of the location.java.lang.String
getId()
Unique identifier for the object.java.lang.Boolean
getLivemode()
Has the valuetrue
if the object exists in live mode or the valuefalse
if the object exists in test mode.java.util.Map<java.lang.String,java.lang.String>
getMetadata()
Set of key-value pairs that you can attach to an object.java.lang.String
getObject()
String representing the object's type.int
hashCode()
static LocationCollection
list(LocationListParams params)
Returns a list ofLocation
objects.static LocationCollection
list(LocationListParams params, RequestOptions options)
Returns a list ofLocation
objects.static LocationCollection
list(java.util.Map<java.lang.String,java.lang.Object> params)
Returns a list ofLocation
objects.static LocationCollection
list(java.util.Map<java.lang.String,java.lang.Object> params, RequestOptions options)
Returns a list ofLocation
objects.static Location
retrieve(java.lang.String location)
Retrieves aLocation
object.static Location
retrieve(java.lang.String location, RequestOptions options)
Retrieves aLocation
object.static Location
retrieve(java.lang.String location, LocationRetrieveParams params, RequestOptions options)
Retrieves aLocation
object.static Location
retrieve(java.lang.String location, java.util.Map<java.lang.String,java.lang.Object> params, RequestOptions options)
Retrieves aLocation
object.void
setAddress(Address address)
void
setDeleted(java.lang.Boolean deleted)
Always true for a deleted object.void
setDisplayName(java.lang.String displayName)
The display name of the location.void
setId(java.lang.String id)
Unique identifier for the object.void
setLivemode(java.lang.Boolean livemode)
Has the valuetrue
if the object exists in live mode or the valuefalse
if the object exists in test mode.void
setMetadata(java.util.Map<java.lang.String,java.lang.String> metadata)
Set of key-value pairs that you can attach to an object.void
setObject(java.lang.String object)
String representing the object's type.Location
update(LocationUpdateParams params)
Updates aLocation
object by setting the values of the parameters passed.Location
update(LocationUpdateParams params, RequestOptions options)
Updates aLocation
object by setting the values of the parameters passed.Location
update(java.util.Map<java.lang.String,java.lang.Object> params)
Updates aLocation
object by setting the values of the parameters passed.Location
update(java.util.Map<java.lang.String,java.lang.Object> params, RequestOptions options)
Updates aLocation
object by setting the values of the parameters passed.-
Methods inherited from class com.stripe.net.ApiResource
checkNullTypedParams, classUrl, classUrl, instanceUrl, instanceUrl, request, request, requestCollection, requestCollection, requestSearchResult, requestSearchResult, requestStream, requestStream, setExpandableFieldId, setStripeResponseGetter, singleClassUrl, singleClassUrl, subresourceUrl, urlEncode, urlEncodeId
-
Methods inherited from class com.stripe.model.StripeObject
equals, getLastResponse, getRawJsonObject, setLastResponse, toJson, toString
-
-
-
-
Method Detail
-
retrieve
public static Location retrieve(java.lang.String location) throws StripeException
Retrieves aLocation
object.- Throws:
StripeException
-
retrieve
public static Location retrieve(java.lang.String location, RequestOptions options) throws StripeException
Retrieves aLocation
object.- Throws:
StripeException
-
retrieve
public static Location retrieve(java.lang.String location, java.util.Map<java.lang.String,java.lang.Object> params, RequestOptions options) throws StripeException
Retrieves aLocation
object.- Throws:
StripeException
-
retrieve
public static Location retrieve(java.lang.String location, LocationRetrieveParams params, RequestOptions options) throws StripeException
Retrieves aLocation
object.- Throws:
StripeException
-
create
public static Location create(java.util.Map<java.lang.String,java.lang.Object> params) throws StripeException
Creates a newLocation
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(java.util.Map<java.lang.String,java.lang.Object> params, RequestOptions options) throws StripeException
Creates a newLocation
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 newLocation
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 newLocation
object. For further details, including which address fields are required in each country, see the Manage locations guide.- Throws:
StripeException
-
update
public Location update(java.util.Map<java.lang.String,java.lang.Object> params) throws StripeException
Updates aLocation
object by setting the values of the parameters passed. Any parameters not provided will be left unchanged.- Specified by:
update
in interfaceMetadataStore<Location>
- Throws:
StripeException
-
update
public Location update(java.util.Map<java.lang.String,java.lang.Object> params, RequestOptions options) throws StripeException
Updates aLocation
object by setting the values of the parameters passed. Any parameters not provided will be left unchanged.- Specified by:
update
in interfaceMetadataStore<Location>
- Throws:
StripeException
-
update
public Location update(LocationUpdateParams params) throws StripeException
Updates aLocation
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 aLocation
object by setting the values of the parameters passed. Any parameters not provided will be left unchanged.- Throws:
StripeException
-
list
public static LocationCollection list(java.util.Map<java.lang.String,java.lang.Object> params) throws StripeException
Returns a list ofLocation
objects.- Throws:
StripeException
-
list
public static LocationCollection list(java.util.Map<java.lang.String,java.lang.Object> params, RequestOptions options) throws StripeException
Returns a list ofLocation
objects.- Throws:
StripeException
-
list
public static LocationCollection list(LocationListParams params) throws StripeException
Returns a list ofLocation
objects.- Throws:
StripeException
-
list
public static LocationCollection list(LocationListParams params, RequestOptions options) throws StripeException
Returns a list ofLocation
objects.- Throws:
StripeException
-
delete
public Location delete() throws StripeException
Deletes aLocation
object.- Throws:
StripeException
-
delete
public Location delete(RequestOptions options) throws StripeException
Deletes aLocation
object.- Throws:
StripeException
-
delete
public Location delete(java.util.Map<java.lang.String,java.lang.Object> params) throws StripeException
Deletes aLocation
object.- Throws:
StripeException
-
delete
public Location delete(java.util.Map<java.lang.String,java.lang.Object> params, RequestOptions options) throws StripeException
Deletes aLocation
object.- Throws:
StripeException
-
getAddress
public Address getAddress()
-
getDeleted
public java.lang.Boolean getDeleted()
Always true for a deleted object.
-
getDisplayName
public java.lang.String getDisplayName()
The display name of the location.
-
getLivemode
public java.lang.Boolean getLivemode()
Has the valuetrue
if the object exists in live mode or the valuefalse
if the object exists in test mode.
-
getObject
public java.lang.String getObject()
String representing the object's type. Objects of the same type share the same value.Equal to
terminal.location
.
-
setAddress
public void setAddress(Address address)
-
setDeleted
public void setDeleted(java.lang.Boolean deleted)
Always true for a deleted object.
-
setDisplayName
public void setDisplayName(java.lang.String displayName)
The display name of the location.
-
setId
public void setId(java.lang.String id)
Unique identifier for the object.
-
setLivemode
public void setLivemode(java.lang.Boolean livemode)
Has the valuetrue
if the object exists in live mode or the valuefalse
if the object exists in test mode.
-
setMetadata
public void setMetadata(java.util.Map<java.lang.String,java.lang.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(java.lang.String object)
String representing the object's type. Objects of the same type share the same value.Equal to
terminal.location
.
-
equals
public boolean equals(java.lang.Object o)
- Overrides:
equals
in classjava.lang.Object
-
canEqual
protected boolean canEqual(java.lang.Object other)
-
hashCode
public int hashCode()
- Overrides:
hashCode
in classjava.lang.Object
-
getId
public java.lang.String getId()
Unique identifier for the object.
-
getMetadata
public java.util.Map<java.lang.String,java.lang.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 interfaceMetadataStore<Location>
-
-