Package com.stripe.model
Class Review
- java.lang.Object
-
- com.stripe.model.StripeObject
-
- com.stripe.net.ApiResource
-
- com.stripe.model.Review
-
- All Implemented Interfaces:
HasId
,StripeObjectInterface
public class Review extends ApiResource implements HasId
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
Review.Location
static class
Review.Session
-
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 Review()
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description Review
approve()
Approves aReview
object, closing it and removing it from the list of reviews.Review
approve(RequestOptions options)
Approves aReview
object, closing it and removing it from the list of reviews.Review
approve(ReviewApproveParams params)
Approves aReview
object, closing it and removing it from the list of reviews.Review
approve(ReviewApproveParams params, RequestOptions options)
Approves aReview
object, closing it and removing it from the list of reviews.Review
approve(java.util.Map<java.lang.String,java.lang.Object> params)
Approves aReview
object, closing it and removing it from the list of reviews.Review
approve(java.util.Map<java.lang.String,java.lang.Object> params, RequestOptions options)
Approves aReview
object, closing it and removing it from the list of reviews.protected boolean
canEqual(java.lang.Object other)
boolean
equals(java.lang.Object o)
java.lang.String
getBillingZip()
The ZIP or postal code of the card used, if applicable.java.lang.String
getCharge()
Get ID of expandablecharge
object.Charge
getChargeObject()
Get expandedcharge
.java.lang.String
getClosedReason()
The reason the review was closed, or null if it has not yet been closed.java.lang.Long
getCreated()
Time at which the object was created.java.lang.String
getId()
Unique identifier for the object.java.lang.String
getIpAddress()
The IP address where the payment originated.Review.Location
getIpAddressLocation()
Information related to the location of the payment.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.lang.String
getObject()
String representing the object's type.java.lang.Boolean
getOpen()
Iftrue
, the review needs action.java.lang.String
getOpenedReason()
The reason the review was opened.java.lang.String
getPaymentIntent()
Get ID of expandablepaymentIntent
object.PaymentIntent
getPaymentIntentObject()
Get expandedpaymentIntent
.java.lang.String
getReason()
The reason the review is currently open or closed.Review.Session
getSession()
Information related to the browsing session of the user who initiated the payment.int
hashCode()
static ReviewCollection
list(ReviewListParams params)
Returns a list ofReview
objects that haveopen
set totrue
.static ReviewCollection
list(ReviewListParams params, RequestOptions options)
Returns a list ofReview
objects that haveopen
set totrue
.static ReviewCollection
list(java.util.Map<java.lang.String,java.lang.Object> params)
Returns a list ofReview
objects that haveopen
set totrue
.static ReviewCollection
list(java.util.Map<java.lang.String,java.lang.Object> params, RequestOptions options)
Returns a list ofReview
objects that haveopen
set totrue
.static Review
retrieve(java.lang.String review)
Retrieves aReview
object.static Review
retrieve(java.lang.String review, RequestOptions options)
Retrieves aReview
object.static Review
retrieve(java.lang.String review, ReviewRetrieveParams params, RequestOptions options)
Retrieves aReview
object.static Review
retrieve(java.lang.String review, java.util.Map<java.lang.String,java.lang.Object> params, RequestOptions options)
Retrieves aReview
object.void
setBillingZip(java.lang.String billingZip)
The ZIP or postal code of the card used, if applicable.void
setCharge(java.lang.String id)
void
setChargeObject(Charge expandableObject)
void
setClosedReason(java.lang.String closedReason)
The reason the review was closed, or null if it has not yet been closed.void
setCreated(java.lang.Long created)
Time at which the object was created.void
setId(java.lang.String id)
Unique identifier for the object.void
setIpAddress(java.lang.String ipAddress)
The IP address where the payment originated.void
setIpAddressLocation(Review.Location ipAddressLocation)
Information related to the location of the payment.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
setObject(java.lang.String object)
String representing the object's type.void
setOpen(java.lang.Boolean open)
Iftrue
, the review needs action.void
setOpenedReason(java.lang.String openedReason)
The reason the review was opened.void
setPaymentIntent(java.lang.String id)
void
setPaymentIntentObject(PaymentIntent expandableObject)
void
setReason(java.lang.String reason)
The reason the review is currently open or closed.void
setSession(Review.Session session)
Information related to the browsing session of the user who initiated the payment.-
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
-
getCharge
public java.lang.String getCharge()
Get ID of expandablecharge
object.
-
setCharge
public void setCharge(java.lang.String id)
-
getChargeObject
public Charge getChargeObject()
Get expandedcharge
.
-
setChargeObject
public void setChargeObject(Charge expandableObject)
-
getPaymentIntent
public java.lang.String getPaymentIntent()
Get ID of expandablepaymentIntent
object.
-
setPaymentIntent
public void setPaymentIntent(java.lang.String id)
-
getPaymentIntentObject
public PaymentIntent getPaymentIntentObject()
Get expandedpaymentIntent
.
-
setPaymentIntentObject
public void setPaymentIntentObject(PaymentIntent expandableObject)
-
list
public static ReviewCollection list(java.util.Map<java.lang.String,java.lang.Object> params) throws StripeException
Returns a list ofReview
objects that haveopen
set totrue
. The objects are sorted in descending order by creation date, with the most recently created object appearing first.- Throws:
StripeException
-
list
public static ReviewCollection list(java.util.Map<java.lang.String,java.lang.Object> params, RequestOptions options) throws StripeException
Returns a list ofReview
objects that haveopen
set totrue
. The objects are sorted in descending order by creation date, with the most recently created object appearing first.- Throws:
StripeException
-
list
public static ReviewCollection list(ReviewListParams params) throws StripeException
Returns a list ofReview
objects that haveopen
set totrue
. The objects are sorted in descending order by creation date, with the most recently created object appearing first.- Throws:
StripeException
-
list
public static ReviewCollection list(ReviewListParams params, RequestOptions options) throws StripeException
Returns a list ofReview
objects that haveopen
set totrue
. The objects are sorted in descending order by creation date, with the most recently created object appearing first.- Throws:
StripeException
-
retrieve
public static Review retrieve(java.lang.String review) throws StripeException
Retrieves aReview
object.- Throws:
StripeException
-
retrieve
public static Review retrieve(java.lang.String review, RequestOptions options) throws StripeException
Retrieves aReview
object.- Throws:
StripeException
-
retrieve
public static Review retrieve(java.lang.String review, java.util.Map<java.lang.String,java.lang.Object> params, RequestOptions options) throws StripeException
Retrieves aReview
object.- Throws:
StripeException
-
retrieve
public static Review retrieve(java.lang.String review, ReviewRetrieveParams params, RequestOptions options) throws StripeException
Retrieves aReview
object.- Throws:
StripeException
-
approve
public Review approve() throws StripeException
Approves aReview
object, closing it and removing it from the list of reviews.- Throws:
StripeException
-
approve
public Review approve(RequestOptions options) throws StripeException
Approves aReview
object, closing it and removing it from the list of reviews.- Throws:
StripeException
-
approve
public Review approve(java.util.Map<java.lang.String,java.lang.Object> params) throws StripeException
Approves aReview
object, closing it and removing it from the list of reviews.- Throws:
StripeException
-
approve
public Review approve(java.util.Map<java.lang.String,java.lang.Object> params, RequestOptions options) throws StripeException
Approves aReview
object, closing it and removing it from the list of reviews.- Throws:
StripeException
-
approve
public Review approve(ReviewApproveParams params) throws StripeException
Approves aReview
object, closing it and removing it from the list of reviews.- Throws:
StripeException
-
approve
public Review approve(ReviewApproveParams params, RequestOptions options) throws StripeException
Approves aReview
object, closing it and removing it from the list of reviews.- Throws:
StripeException
-
getBillingZip
public java.lang.String getBillingZip()
The ZIP or postal code of the card used, if applicable.
-
getClosedReason
public java.lang.String getClosedReason()
The reason the review was closed, or null if it has not yet been closed. One ofapproved
,refunded
,refunded_as_fraud
,disputed
, orredacted
.
-
getCreated
public java.lang.Long getCreated()
Time at which the object was created. Measured in seconds since the Unix epoch.
-
getIpAddress
public java.lang.String getIpAddress()
The IP address where the payment originated.
-
getIpAddressLocation
public Review.Location getIpAddressLocation()
Information related to the location of the payment. Note that this information is an approximation and attempts to locate the nearest population center - it should not be used to determine a specific address.
-
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
review
.
-
getOpen
public java.lang.Boolean getOpen()
Iftrue
, the review needs action.
-
getOpenedReason
public java.lang.String getOpenedReason()
The reason the review was opened. One ofrule
ormanual
.
-
getReason
public java.lang.String getReason()
The reason the review is currently open or closed. One ofrule
,manual
,approved
,refunded
,refunded_as_fraud
,disputed
, orredacted
.
-
getSession
public Review.Session getSession()
Information related to the browsing session of the user who initiated the payment.
-
setBillingZip
public void setBillingZip(java.lang.String billingZip)
The ZIP or postal code of the card used, if applicable.
-
setClosedReason
public void setClosedReason(java.lang.String closedReason)
The reason the review was closed, or null if it has not yet been closed. One ofapproved
,refunded
,refunded_as_fraud
,disputed
, orredacted
.
-
setCreated
public void setCreated(java.lang.Long created)
Time at which the object was created. Measured in seconds since the Unix epoch.
-
setId
public void setId(java.lang.String id)
Unique identifier for the object.
-
setIpAddress
public void setIpAddress(java.lang.String ipAddress)
The IP address where the payment originated.
-
setIpAddressLocation
public void setIpAddressLocation(Review.Location ipAddressLocation)
Information related to the location of the payment. Note that this information is an approximation and attempts to locate the nearest population center - it should not be used to determine a specific address.
-
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.
-
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
review
.
-
setOpen
public void setOpen(java.lang.Boolean open)
Iftrue
, the review needs action.
-
setOpenedReason
public void setOpenedReason(java.lang.String openedReason)
The reason the review was opened. One ofrule
ormanual
.
-
setReason
public void setReason(java.lang.String reason)
The reason the review is currently open or closed. One ofrule
,manual
,approved
,refunded
,refunded_as_fraud
,disputed
, orredacted
.
-
setSession
public void setSession(Review.Session session)
Information related to the browsing session of the user who initiated the payment.
-
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
-
-