Review.php in GiveWP – Donation Plugin and Fundraising Platform 4.16.6, at vendor/stripe/stripe-php/lib/Review.php

67 lines 3.3 KB Raw Download Zip

1	<?php
2
3	// File generated from our OpenAPI spec
4
5	namespace Stripe;
6
7	/**
8	* Reviews can be used to supplement automated fraud detection with human
9	* expertise.
10	*
11	* Learn more about <a href="/radar">Radar</a> and reviewing payments <a
12	* href="https://stripe.com/docs/radar/reviews">here</a>.
13	*
14	* @property string $id Unique identifier for the object.
15	* @property string $object String representing the object's type. Objects of the same type share the same value.
16	* @property null\|string $billing_zip The ZIP or postal code of the card used, if applicable.
17	* @property null\|string\|\Stripe\Charge $charge The charge associated with this review.
18	* @property null\|string $closed_reason The reason the review was closed, or null if it has not yet been closed. One of <code>approved</code>, <code>refunded</code>, <code>refunded_as_fraud</code>, <code>disputed</code>, or <code>redacted</code>.
19	* @property int $created Time at which the object was created. Measured in seconds since the Unix epoch.
20	* @property null\|string $ip_address The IP address where the payment originated.
21	* @property null\|\Stripe\StripeObject $ip_address_location 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.
22	* @property bool $livemode Has the value <code>true</code> if the object exists in live mode or the value <code>false</code> if the object exists in test mode.
23	* @property bool $open If <code>true</code>, the review needs action.
24	* @property string $opened_reason The reason the review was opened. One of <code>rule</code> or <code>manual</code>.
25	* @property string\|\Stripe\PaymentIntent $payment_intent The PaymentIntent ID associated with this review, if one exists.
26	* @property string $reason The reason the review is currently open or closed. One of <code>rule</code>, <code>manual</code>, <code>approved</code>, <code>refunded</code>, <code>refunded_as_fraud</code>, <code>disputed</code>, or <code>redacted</code>.
27	* @property null\|\Stripe\StripeObject $session Information related to the browsing session of the user who initiated the payment.
28	*/
29	class Review extends ApiResource
30	{
31	const OBJECT_NAME = 'review';
32
33	use ApiOperations\All;
34	use ApiOperations\Retrieve;
35
36	/**
37	* Possible string representations of the current, the opening or the closure reason of the review.
38	* Not all of these enumeration apply to all of the ´reason´ fields. Please consult the Review object to
39	* determine where these are apply.
40	*
41	* @see https://stripe.com/docs/api/radar/reviews/object
42	*/
43	const REASON_APPROVED = 'approved';
44	const REASON_DISPUTED = 'disputed';
45	const REASON_MANUAL = 'manual';
46	const REASON_REFUNDED = 'refunded';
47	const REASON_REFUNDED_AS_FRAUD = 'refunded_as_fraud';
48	const REASON_RULE = 'rule';
49
50	/**
51	* @param null\|array $params
52	* @param null\|array\|string $opts
53	*
54	* @throws \Stripe\Exception\ApiErrorException if the request fails
55	*
56	* @return \Stripe\Review the approved review
57	*/
58	public function approve($params = null, $opts = null)
59	{
60	$url = $this->instanceUrl() . '/approve';
61	list($response, $opts) = $this->_request('post', $url, $params, $opts);
62	$this->refreshFrom($response, $opts);
63
64	return $this;
65	}
66	}
67