Alert.php
2 months ago
AlertTriggered.php
2 months ago
CreditBalanceSummary.php
2 months ago
CreditBalanceTransaction.php
2 months ago
CreditGrant.php
2 months ago
Meter.php
2 months ago
MeterEvent.php
2 months ago
MeterEventAdjustment.php
2 months ago
MeterEventSummary.php
2 months ago
Alert.php
120 lines
| 1 | <?php |
| 2 | |
| 3 | // File generated from our OpenAPI spec |
| 4 | namespace ProfilePressVendor\Stripe\Billing; |
| 5 | |
| 6 | /** |
| 7 | * A billing alert is a resource that notifies you when a certain usage threshold on a meter is crossed. For example, you might create a billing alert to notify you when a certain user made 100 API requests. |
| 8 | * |
| 9 | * @property string $id Unique identifier for the object. |
| 10 | * @property string $object String representing the object's type. Objects of the same type share the same value. |
| 11 | * @property string $alert_type Defines the type of the alert. |
| 12 | * @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. |
| 13 | * @property null|string $status Status of the alert. This can be active, inactive or archived. |
| 14 | * @property string $title Title of the alert. |
| 15 | * @property null|\Stripe\StripeObject $usage_threshold Encapsulates configuration of the alert to monitor usage on a specific <a href="https://stripe.com/docs/api/billing/meter">Billing Meter</a>. |
| 16 | */ |
| 17 | class Alert extends \ProfilePressVendor\Stripe\ApiResource |
| 18 | { |
| 19 | const OBJECT_NAME = 'billing.alert'; |
| 20 | const STATUS_ACTIVE = 'active'; |
| 21 | const STATUS_ARCHIVED = 'archived'; |
| 22 | const STATUS_INACTIVE = 'inactive'; |
| 23 | /** |
| 24 | * Creates a billing alert. |
| 25 | * |
| 26 | * @param null|array $params |
| 27 | * @param null|array|string $options |
| 28 | * |
| 29 | * @throws \Stripe\Exception\ApiErrorException if the request fails |
| 30 | * |
| 31 | * @return \Stripe\Billing\Alert the created resource |
| 32 | */ |
| 33 | public static function create($params = null, $options = null) |
| 34 | { |
| 35 | self::_validateParams($params); |
| 36 | $url = static::classUrl(); |
| 37 | list($response, $opts) = static::_staticRequest('post', $url, $params, $options); |
| 38 | $obj = \ProfilePressVendor\Stripe\Util\Util::convertToStripeObject($response->json, $opts); |
| 39 | $obj->setLastResponse($response); |
| 40 | return $obj; |
| 41 | } |
| 42 | /** |
| 43 | * Lists billing active and inactive alerts. |
| 44 | * |
| 45 | * @param null|array $params |
| 46 | * @param null|array|string $opts |
| 47 | * |
| 48 | * @throws \Stripe\Exception\ApiErrorException if the request fails |
| 49 | * |
| 50 | * @return \Stripe\Collection<\Stripe\Billing\Alert> of ApiResources |
| 51 | */ |
| 52 | public static function all($params = null, $opts = null) |
| 53 | { |
| 54 | $url = static::classUrl(); |
| 55 | return static::_requestPage($url, \ProfilePressVendor\Stripe\Collection::class, $params, $opts); |
| 56 | } |
| 57 | /** |
| 58 | * Retrieves a billing alert given an ID. |
| 59 | * |
| 60 | * @param array|string $id the ID of the API resource to retrieve, or an options array containing an `id` key |
| 61 | * @param null|array|string $opts |
| 62 | * |
| 63 | * @throws \Stripe\Exception\ApiErrorException if the request fails |
| 64 | * |
| 65 | * @return \Stripe\Billing\Alert |
| 66 | */ |
| 67 | public static function retrieve($id, $opts = null) |
| 68 | { |
| 69 | $opts = \ProfilePressVendor\Stripe\Util\RequestOptions::parse($opts); |
| 70 | $instance = new static($id, $opts); |
| 71 | $instance->refresh(); |
| 72 | return $instance; |
| 73 | } |
| 74 | /** |
| 75 | * @param null|array $params |
| 76 | * @param null|array|string $opts |
| 77 | * |
| 78 | * @throws \Stripe\Exception\ApiErrorException if the request fails |
| 79 | * |
| 80 | * @return \Stripe\Billing\Alert the activated alert |
| 81 | */ |
| 82 | public function activate($params = null, $opts = null) |
| 83 | { |
| 84 | $url = $this->instanceUrl() . '/activate'; |
| 85 | list($response, $opts) = $this->_request('post', $url, $params, $opts); |
| 86 | $this->refreshFrom($response, $opts); |
| 87 | return $this; |
| 88 | } |
| 89 | /** |
| 90 | * @param null|array $params |
| 91 | * @param null|array|string $opts |
| 92 | * |
| 93 | * @throws \Stripe\Exception\ApiErrorException if the request fails |
| 94 | * |
| 95 | * @return \Stripe\Billing\Alert the archived alert |
| 96 | */ |
| 97 | public function archive($params = null, $opts = null) |
| 98 | { |
| 99 | $url = $this->instanceUrl() . '/archive'; |
| 100 | list($response, $opts) = $this->_request('post', $url, $params, $opts); |
| 101 | $this->refreshFrom($response, $opts); |
| 102 | return $this; |
| 103 | } |
| 104 | /** |
| 105 | * @param null|array $params |
| 106 | * @param null|array|string $opts |
| 107 | * |
| 108 | * @throws \Stripe\Exception\ApiErrorException if the request fails |
| 109 | * |
| 110 | * @return \Stripe\Billing\Alert the deactivated alert |
| 111 | */ |
| 112 | public function deactivate($params = null, $opts = null) |
| 113 | { |
| 114 | $url = $this->instanceUrl() . '/deactivate'; |
| 115 | list($response, $opts) = $this->_request('post', $url, $params, $opts); |
| 116 | $this->refreshFrom($response, $opts); |
| 117 | return $this; |
| 118 | } |
| 119 | } |
| 120 |