class

Stripe::Review

Inherits OpenApi::Json < OpenApi::Validatable < JSON::Serializable::Unmapped < JSON::Serializable < Reference < Object

Reviews can be used to supplement automated fraud detection with human expertise. Learn more about Radar and reviewing payments here.

Constants

ERROR_MESSAGE_FOR_CLOSED_REASON = "invalid value for \"closed_reason\", must be one of [approved, disputed, redacted, refunded, refunded_as_fraud]."
ERROR_MESSAGE_FOR_OBJECT = "invalid value for \"object\", must be one of [review]."
ERROR_MESSAGE_FOR_OPENED_REASON = "invalid value for \"opened_reason\", must be one of [manual, rule]."
MAX_LENGTH_FOR_BILLING_ZIP = 5000
MAX_LENGTH_FOR_ID = 5000
MAX_LENGTH_FOR_IP_ADDRESS = 5000
MAX_LENGTH_FOR_REASON = 5000
VALID_VALUES_FOR_CLOSED_REASON = String.static_array("approved", "disputed", "redacted", "refunded", "refunded_as_fraud")
VALID_VALUES_FOR_OBJECT = String.static_array("review")
VALID_VALUES_FOR_OPENED_REASON = String.static_array("manual", "rule")

Constructors

new(pull : JSON::PullParser)
Source
new(*, __pull_for_json_serializable pull : JSON::PullParser)
Source
new(*, billing_zip : String | Nil = nil, charge : Stripe::ReviewCharge | Nil = nil, closed_reason : String | Nil = nil, created : Int64 | Nil = nil, id : String | Nil = nil, ip_address : String | Nil = nil, ip_address_location : Stripe::ReviewIpAddressLocation | Nil = nil, livemode : Bool | Nil = nil, object : String | Nil = nil, open : Bool | Nil = nil, opened_reason : String | Nil = nil, reason : String | Nil = nil, session : Stripe::ReviewSession | Nil = nil, payment_intent : Stripe::ReviewPaymentIntent | Nil = nil)

Initializes the object @param [Hash] attributes Model attributes in the form of hash

Source

Instance methods

==(other : self)

Generates #hash and #== methods from all fields #== @return [Bool] #hash calculates hash code according to all attributes. #hash @return [UInt64] Hash code

billing_zip

The ZIP or postal code of the card used, if applicable.

Source
billing_zip=(new_value : String | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] billing_zip Object to be assigned

Source
charge
Source
charge=(new_value : Stripe::ReviewCharge | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] charge Object to be assigned

Source
closed_reason

The reason the review was closed, or null if it has not yet been closed. One of approved, refunded, refunded_as_fraud, disputed, or redacted.

Source
closed_reason=(new_value : String | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] closed_reason Object to be assigned

Source
created

Time at which the object was created. Measured in seconds since the Unix epoch.

Source
created=(new_value : Int64 | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] created Object to be assigned

Source
hash(hasher)

Generates #hash and #== methods from all fields #== @return [Bool] #hash calculates hash code according to all attributes. #hash @return [UInt64] Hash code

id

Unique identifier for the object.

Source
id=(new_value : String | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] id Object to be assigned

Source
ip_address

The IP address where the payment originated.

Source
ip_address=(new_value : String | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] ip_address Object to be assigned

Source
ip_address_location
Source
ip_address_location=(new_value : Stripe::ReviewIpAddressLocation | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] ip_address_location Object to be assigned

Source
list_invalid_properties

Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properties with the reasons

Source
livemode

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

Source
livemode=(new_value : Bool | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] livemode Object to be assigned

Source
object

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

Source
object=(new_value : String | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] object Object to be assigned

Source
open

If true, the review needs action.

Source
open=(new_value : Bool | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] open Object to be assigned

Source
opened_reason

The reason the review was opened. One of rule or manual.

Source
opened_reason=(new_value : String | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] opened_reason Object to be assigned

Source
payment_intent
Source
payment_intent=(new_value : Stripe::ReviewPaymentIntent | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] payment_intent Object to be assigned

Source
reason

The reason the review is currently open or closed. One of rule, manual, approved, refunded, refunded_as_fraud, disputed, or redacted.

Source
reason=(new_value : String | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] reason Object to be assigned

Source
session
Source
session=(new_value : Stripe::ReviewSession | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] session Object to be assigned

Source
valid?

Check to see if the all the properties in the model are valid @return true if the model is valid

Source