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 classReview.Locationstatic classReview.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 Reviewapprove()Approves aReviewobject, closing it and removing it from the list of reviews.Reviewapprove(RequestOptions options)Approves aReviewobject, closing it and removing it from the list of reviews.Reviewapprove(ReviewApproveParams params)Approves aReviewobject, closing it and removing it from the list of reviews.Reviewapprove(ReviewApproveParams params, RequestOptions options)Approves aReviewobject, closing it and removing it from the list of reviews.Reviewapprove(java.util.Map<java.lang.String,java.lang.Object> params)Approves aReviewobject, closing it and removing it from the list of reviews.Reviewapprove(java.util.Map<java.lang.String,java.lang.Object> params, RequestOptions options)Approves aReviewobject, closing it and removing it from the list of reviews.protected booleancanEqual(java.lang.Object other)booleanequals(java.lang.Object o)java.lang.StringgetBillingZip()The ZIP or postal code of the card used, if applicable.java.lang.StringgetCharge()Get ID of expandablechargeobject.ChargegetChargeObject()Get expandedcharge.java.lang.StringgetClosedReason()The reason the review was closed, or null if it has not yet been closed.java.lang.LonggetCreated()Time at which the object was created.java.lang.StringgetId()Unique identifier for the object.java.lang.StringgetIpAddress()The IP address where the payment originated.Review.LocationgetIpAddressLocation()Information related to the location of the payment.java.lang.BooleangetLivemode()Has the valuetrueif the object exists in live mode or the valuefalseif the object exists in test mode.java.lang.StringgetObject()String representing the object's type.java.lang.BooleangetOpen()Iftrue, the review needs action.java.lang.StringgetOpenedReason()The reason the review was opened.java.lang.StringgetPaymentIntent()Get ID of expandablepaymentIntentobject.PaymentIntentgetPaymentIntentObject()Get expandedpaymentIntent.java.lang.StringgetReason()The reason the review is currently open or closed.Review.SessiongetSession()Information related to the browsing session of the user who initiated the payment.inthashCode()static ReviewCollectionlist(ReviewListParams params)Returns a list ofReviewobjects that haveopenset totrue.static ReviewCollectionlist(ReviewListParams params, RequestOptions options)Returns a list ofReviewobjects that haveopenset totrue.static ReviewCollectionlist(java.util.Map<java.lang.String,java.lang.Object> params)Returns a list ofReviewobjects that haveopenset totrue.static ReviewCollectionlist(java.util.Map<java.lang.String,java.lang.Object> params, RequestOptions options)Returns a list ofReviewobjects that haveopenset totrue.static Reviewretrieve(java.lang.String review)Retrieves aReviewobject.static Reviewretrieve(java.lang.String review, RequestOptions options)Retrieves aReviewobject.static Reviewretrieve(java.lang.String review, ReviewRetrieveParams params, RequestOptions options)Retrieves aReviewobject.static Reviewretrieve(java.lang.String review, java.util.Map<java.lang.String,java.lang.Object> params, RequestOptions options)Retrieves aReviewobject.voidsetBillingZip(java.lang.String billingZip)The ZIP or postal code of the card used, if applicable.voidsetCharge(java.lang.String id)voidsetChargeObject(Charge expandableObject)voidsetClosedReason(java.lang.String closedReason)The reason the review was closed, or null if it has not yet been closed.voidsetCreated(java.lang.Long created)Time at which the object was created.voidsetId(java.lang.String id)Unique identifier for the object.voidsetIpAddress(java.lang.String ipAddress)The IP address where the payment originated.voidsetIpAddressLocation(Review.Location ipAddressLocation)Information related to the location of the payment.voidsetLivemode(java.lang.Boolean livemode)Has the valuetrueif the object exists in live mode or the valuefalseif the object exists in test mode.voidsetObject(java.lang.String object)String representing the object's type.voidsetOpen(java.lang.Boolean open)Iftrue, the review needs action.voidsetOpenedReason(java.lang.String openedReason)The reason the review was opened.voidsetPaymentIntent(java.lang.String id)voidsetPaymentIntentObject(PaymentIntent expandableObject)voidsetReason(java.lang.String reason)The reason the review is currently open or closed.voidsetSession(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, 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 expandablechargeobject.
-
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 expandablepaymentIntentobject.
-
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 ofReviewobjects that haveopenset 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 ofReviewobjects that haveopenset 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 ofReviewobjects that haveopenset 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 ofReviewobjects that haveopenset 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 aReviewobject.- Throws:
StripeException
-
retrieve
public static Review retrieve(java.lang.String review, RequestOptions options) throws StripeException
Retrieves aReviewobject.- 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 aReviewobject.- Throws:
StripeException
-
retrieve
public static Review retrieve(java.lang.String review, ReviewRetrieveParams params, RequestOptions options) throws StripeException
Retrieves aReviewobject.- Throws:
StripeException
-
approve
public Review approve() throws StripeException
Approves aReviewobject, closing it and removing it from the list of reviews.- Throws:
StripeException
-
approve
public Review approve(RequestOptions options) throws StripeException
Approves aReviewobject, 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 aReviewobject, 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 aReviewobject, closing it and removing it from the list of reviews.- Throws:
StripeException
-
approve
public Review approve(ReviewApproveParams params) throws StripeException
Approves aReviewobject, closing it and removing it from the list of reviews.- Throws:
StripeException
-
approve
public Review approve(ReviewApproveParams params, RequestOptions options) throws StripeException
Approves aReviewobject, 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, ordisputed.
-
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 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
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 ofruleormanual.
-
getReason
public java.lang.String getReason()
The reason the review is currently open or closed. One ofrule,manual,approved,refunded,refunded_as_fraud, ordisputed.
-
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, ordisputed.
-
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 valuetrueif the object exists in live mode or the valuefalseif 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 ofruleormanual.
-
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, ordisputed.
-
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:
equalsin classjava.lang.Object
-
canEqual
protected boolean canEqual(java.lang.Object other)
-
hashCode
public int hashCode()
- Overrides:
hashCodein classjava.lang.Object
-
-