Package com.stripe.model.terminal
Class Reader
- java.lang.Object
-
- com.stripe.model.StripeObject
-
- com.stripe.net.ApiResource
-
- com.stripe.model.terminal.Reader
-
- All Implemented Interfaces:
HasId,MetadataStore<Reader>,StripeObjectInterface
public class Reader extends ApiResource implements HasId, MetadataStore<Reader>
-
-
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 Reader()
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description protected booleancanEqual(java.lang.Object other)static Readercreate(ReaderCreateParams params)Creates a newReaderobject.static Readercreate(ReaderCreateParams params, RequestOptions options)Creates a newReaderobject.static Readercreate(java.util.Map<java.lang.String,java.lang.Object> params)Creates a newReaderobject.static Readercreate(java.util.Map<java.lang.String,java.lang.Object> params, RequestOptions options)Creates a newReaderobject.Readerdelete()Deletes aReaderobject.Readerdelete(RequestOptions options)Deletes aReaderobject.Readerdelete(java.util.Map<java.lang.String,java.lang.Object> params)Deletes aReaderobject.Readerdelete(java.util.Map<java.lang.String,java.lang.Object> params, RequestOptions options)Deletes aReaderobject.booleanequals(java.lang.Object o)java.lang.BooleangetDeleted()Always true for a deleted object.java.lang.StringgetDeviceSwVersion()The current software version of the reader.java.lang.StringgetDeviceType()Type of reader, one ofbbpos_chipper2xorverifone_P400.java.lang.StringgetId()Unique identifier for the object.java.lang.StringgetIpAddress()The local IP address of the reader.java.lang.StringgetLabel()Custom label given to the reader for easier identification.java.lang.BooleangetLivemode()Has the valuetrueif the object exists in live mode or the valuefalseif the object exists in test mode.java.lang.StringgetLocation()Get ID of expandablelocationobject.LocationgetLocationObject()Get expandedlocation.java.util.Map<java.lang.String,java.lang.String>getMetadata()Set of key-value pairs that you can attach to an object.java.lang.StringgetObject()String representing the object's type.java.lang.StringgetSerialNumber()Serial number of the reader.java.lang.StringgetStatus()The networking status of the reader.inthashCode()static ReaderCollectionlist(ReaderListParams params)Returns a list ofReaderobjects.static ReaderCollectionlist(ReaderListParams params, RequestOptions options)Returns a list ofReaderobjects.static ReaderCollectionlist(java.util.Map<java.lang.String,java.lang.Object> params)Returns a list ofReaderobjects.static ReaderCollectionlist(java.util.Map<java.lang.String,java.lang.Object> params, RequestOptions options)Returns a list ofReaderobjects.static Readerretrieve(java.lang.String reader)Retrieves aReaderobject.static Readerretrieve(java.lang.String reader, RequestOptions options)Retrieves aReaderobject.static Readerretrieve(java.lang.String reader, ReaderRetrieveParams params, RequestOptions options)Retrieves aReaderobject.static Readerretrieve(java.lang.String reader, java.util.Map<java.lang.String,java.lang.Object> params, RequestOptions options)Retrieves aReaderobject.voidsetDeleted(java.lang.Boolean deleted)Always true for a deleted object.voidsetDeviceSwVersion(java.lang.String deviceSwVersion)The current software version of the reader.voidsetDeviceType(java.lang.String deviceType)Type of reader, one ofbbpos_chipper2xorverifone_P400.voidsetId(java.lang.String id)Unique identifier for the object.voidsetIpAddress(java.lang.String ipAddress)The local IP address of the reader.voidsetLabel(java.lang.String label)Custom label given to the reader for easier identification.voidsetLivemode(java.lang.Boolean livemode)Has the valuetrueif the object exists in live mode or the valuefalseif the object exists in test mode.voidsetLocation(java.lang.String id)voidsetLocationObject(Location expandableObject)voidsetMetadata(java.util.Map<java.lang.String,java.lang.String> metadata)Set of key-value pairs that you can attach to an object.voidsetObject(java.lang.String object)String representing the object's type.voidsetSerialNumber(java.lang.String serialNumber)Serial number of the reader.voidsetStatus(java.lang.String status)The networking status of the reader.Readerupdate(ReaderUpdateParams params)Updates aReaderobject by setting the values of the parameters passed.Readerupdate(ReaderUpdateParams params, RequestOptions options)Updates aReaderobject by setting the values of the parameters passed.Readerupdate(java.util.Map<java.lang.String,java.lang.Object> params)Updates aReaderobject by setting the values of the parameters passed.Readerupdate(java.util.Map<java.lang.String,java.lang.Object> params, RequestOptions options)Updates aReaderobject 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, setExpandableFieldId, setStripeResponseGetter, singleClassUrl, singleClassUrl, subresourceUrl, urlEncode, urlEncodeId
-
Methods inherited from class com.stripe.model.StripeObject
equals, getLastResponse, getRawJsonObject, setLastResponse, toJson, toString
-
-
-
-
Method Detail
-
getLocation
public java.lang.String getLocation()
Get ID of expandablelocationobject.
-
setLocation
public void setLocation(java.lang.String id)
-
getLocationObject
public Location getLocationObject()
Get expandedlocation.
-
setLocationObject
public void setLocationObject(Location expandableObject)
-
update
public Reader update(java.util.Map<java.lang.String,java.lang.Object> params) throws StripeException
Updates aReaderobject by setting the values of the parameters passed. Any parameters not provided will be left unchanged.- Specified by:
updatein interfaceMetadataStore<Reader>- Throws:
StripeException
-
update
public Reader update(java.util.Map<java.lang.String,java.lang.Object> params, RequestOptions options) throws StripeException
Updates aReaderobject by setting the values of the parameters passed. Any parameters not provided will be left unchanged.- Specified by:
updatein interfaceMetadataStore<Reader>- Throws:
StripeException
-
update
public Reader update(ReaderUpdateParams params) throws StripeException
Updates aReaderobject by setting the values of the parameters passed. Any parameters not provided will be left unchanged.- Throws:
StripeException
-
update
public Reader update(ReaderUpdateParams params, RequestOptions options) throws StripeException
Updates aReaderobject by setting the values of the parameters passed. Any parameters not provided will be left unchanged.- Throws:
StripeException
-
retrieve
public static Reader retrieve(java.lang.String reader) throws StripeException
Retrieves aReaderobject.- Throws:
StripeException
-
retrieve
public static Reader retrieve(java.lang.String reader, RequestOptions options) throws StripeException
Retrieves aReaderobject.- Throws:
StripeException
-
retrieve
public static Reader retrieve(java.lang.String reader, java.util.Map<java.lang.String,java.lang.Object> params, RequestOptions options) throws StripeException
Retrieves aReaderobject.- Throws:
StripeException
-
retrieve
public static Reader retrieve(java.lang.String reader, ReaderRetrieveParams params, RequestOptions options) throws StripeException
Retrieves aReaderobject.- Throws:
StripeException
-
create
public static Reader create(java.util.Map<java.lang.String,java.lang.Object> params) throws StripeException
Creates a newReaderobject.- Throws:
StripeException
-
create
public static Reader create(java.util.Map<java.lang.String,java.lang.Object> params, RequestOptions options) throws StripeException
Creates a newReaderobject.- Throws:
StripeException
-
create
public static Reader create(ReaderCreateParams params) throws StripeException
Creates a newReaderobject.- Throws:
StripeException
-
create
public static Reader create(ReaderCreateParams params, RequestOptions options) throws StripeException
Creates a newReaderobject.- Throws:
StripeException
-
list
public static ReaderCollection list(java.util.Map<java.lang.String,java.lang.Object> params) throws StripeException
Returns a list ofReaderobjects.- Throws:
StripeException
-
list
public static ReaderCollection list(java.util.Map<java.lang.String,java.lang.Object> params, RequestOptions options) throws StripeException
Returns a list ofReaderobjects.- Throws:
StripeException
-
list
public static ReaderCollection list(ReaderListParams params) throws StripeException
Returns a list ofReaderobjects.- Throws:
StripeException
-
list
public static ReaderCollection list(ReaderListParams params, RequestOptions options) throws StripeException
Returns a list ofReaderobjects.- Throws:
StripeException
-
delete
public Reader delete() throws StripeException
Deletes aReaderobject.- Throws:
StripeException
-
delete
public Reader delete(RequestOptions options) throws StripeException
Deletes aReaderobject.- Throws:
StripeException
-
delete
public Reader delete(java.util.Map<java.lang.String,java.lang.Object> params) throws StripeException
Deletes aReaderobject.- Throws:
StripeException
-
delete
public Reader delete(java.util.Map<java.lang.String,java.lang.Object> params, RequestOptions options) throws StripeException
Deletes aReaderobject.- Throws:
StripeException
-
getDeleted
public java.lang.Boolean getDeleted()
Always true for a deleted object.
-
getDeviceSwVersion
public java.lang.String getDeviceSwVersion()
The current software version of the reader.
-
getDeviceType
public java.lang.String getDeviceType()
Type of reader, one ofbbpos_chipper2xorverifone_P400.
-
getIpAddress
public java.lang.String getIpAddress()
The local IP address of the reader.
-
getLabel
public java.lang.String getLabel()
Custom label given to the reader for easier identification.
-
getLivemode
public java.lang.Boolean getLivemode()
Has the valuetrueif the object exists in live mode or the valuefalseif 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.reader.
-
getSerialNumber
public java.lang.String getSerialNumber()
Serial number of the reader.
-
getStatus
public java.lang.String getStatus()
The networking status of the reader.
-
setDeleted
public void setDeleted(java.lang.Boolean deleted)
Always true for a deleted object.
-
setDeviceSwVersion
public void setDeviceSwVersion(java.lang.String deviceSwVersion)
The current software version of the reader.
-
setDeviceType
public void setDeviceType(java.lang.String deviceType)
Type of reader, one ofbbpos_chipper2xorverifone_P400.
-
setId
public void setId(java.lang.String id)
Unique identifier for the object.
-
setIpAddress
public void setIpAddress(java.lang.String ipAddress)
The local IP address of the reader.
-
setLabel
public void setLabel(java.lang.String label)
Custom label given to the reader for easier identification.
-
setLivemode
public void setLivemode(java.lang.Boolean livemode)
Has the valuetrueif the object exists in live mode or the valuefalseif 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.reader.
-
setSerialNumber
public void setSerialNumber(java.lang.String serialNumber)
Serial number of the reader.
-
setStatus
public void setStatus(java.lang.String status)
The networking status of the reader.
-
equals
public boolean equals(java.lang.Object o)
- Overrides:
equalsin classjava.lang.Object
-
canEqual
protected boolean canEqual(java.lang.Object other)
-
hashCode
public int hashCode()
- Overrides:
hashCodein 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:
getMetadatain interfaceMetadataStore<Reader>
-
-