Review.php — Paid Membership Plugin, Ecommerce, User Registration Form, Login Form, User Profile & Restrict Content – ProfilePress 4.17.1

wp-user-avatar / third-party / vendor / stripe / stripe-php / lib / Review.php

wp-user-avatar / third-party / vendor / stripe / stripe-php / lib Last commit date

Review.php

100 lines

1	<?php
2
3	// File generated from our OpenAPI spec
4	namespace ProfilePressVendor\Stripe;
5
6	/**
7	* Reviews can be used to supplement automated fraud detection with human expertise.
8	*
9	* Learn more about <a href="/radar">Radar</a> and reviewing payments
10	* <a href="https://stripe.com/docs/radar/reviews">here</a>.
11	*
12	* @property string $id Unique identifier for the object.
13	* @property string $object String representing the object's type. Objects of the same type share the same value.
14	* @property null\|string $billing_zip The ZIP or postal code of the card used, if applicable.
15	* @property null\|string\|\Stripe\Charge $charge The charge associated with this review.
16	* @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>.
17	* @property int $created Time at which the object was created. Measured in seconds since the Unix epoch.
18	* @property null\|string $ip_address The IP address where the payment originated.
19	* @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.
20	* @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.
21	* @property bool $open If <code>true</code>, the review needs action.
22	* @property string $opened_reason The reason the review was opened. One of <code>rule</code> or <code>manual</code>.
23	* @property null\|string\|\Stripe\PaymentIntent $payment_intent The PaymentIntent ID associated with this review, if one exists.
24	* @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>.
25	* @property null\|\Stripe\StripeObject $session Information related to the browsing session of the user who initiated the payment.
26	*/
27	class Review extends ApiResource
28	{
29	const OBJECT_NAME = 'review';
30	const CLOSED_REASON_APPROVED = 'approved';
31	const CLOSED_REASON_DISPUTED = 'disputed';
32	const CLOSED_REASON_REDACTED = 'redacted';
33	const CLOSED_REASON_REFUNDED = 'refunded';
34	const CLOSED_REASON_REFUNDED_AS_FRAUD = 'refunded_as_fraud';
35	const OPENED_REASON_MANUAL = 'manual';
36	const OPENED_REASON_RULE = 'rule';
37	/**
38	* Returns a list of <code>Review</code> objects that have <code>open</code> set to
39	* <code>true</code>. The objects are sorted in descending order by creation date,
40	* with the most recently created object appearing first.
41	*
42	* @param null\|array $params
43	* @param null\|array\|string $opts
44	*
45	* @throws \Stripe\Exception\ApiErrorException if the request fails
46	*
47	* @return \Stripe\Collection<\Stripe\Review> of ApiResources
48	*/
49	public static function all($params = null, $opts = null)
50	{
51	$url = static::classUrl();
52	return static::_requestPage($url, \ProfilePressVendor\Stripe\Collection::class, $params, $opts);
53	}
54	/**
55	* Retrieves a <code>Review</code> object.
56	*
57	* @param array\|string $id the ID of the API resource to retrieve, or an options array containing an `id` key
58	* @param null\|array\|string $opts
59	*
60	* @throws \Stripe\Exception\ApiErrorException if the request fails
61	*
62	* @return \Stripe\Review
63	*/
64	public static function retrieve($id, $opts = null)
65	{
66	$opts = \ProfilePressVendor\Stripe\Util\RequestOptions::parse($opts);
67	$instance = new static($id, $opts);
68	$instance->refresh();
69	return $instance;
70	}
71	/**
72	* Possible string representations of the current, the opening or the closure reason of the review.
73	* Not all of these enumeration apply to all of the ´reason´ fields. Please consult the Review object to
74	* determine where these are apply.
75	*
76	* @see https://stripe.com/docs/api/radar/reviews/object
77	*/
78	const REASON_APPROVED = 'approved';
79	const REASON_DISPUTED = 'disputed';
80	const REASON_MANUAL = 'manual';
81	const REASON_REFUNDED = 'refunded';
82	const REASON_REFUNDED_AS_FRAUD = 'refunded_as_fraud';
83	const REASON_RULE = 'rule';
84	/**
85	* @param null\|array $params
86	* @param null\|array\|string $opts
87	*
88	* @throws \Stripe\Exception\ApiErrorException if the request fails
89	*
90	* @return \Stripe\Review the approved review
91	*/
92	public function approve($params = null, $opts = null)
93	{
94	$url = $this->instanceUrl() . '/approve';
95	list($response, $opts) = $this->_request('post', $url, $params, $opts);
96	$this->refreshFrom($response, $opts);
97	return $this;
98	}
99	}
100