Upgrade 1-11.38

vendor/stripe/stripe-php/lib/Event.php

@@ -5,35 +5,23 @@
 namespace Stripe;
 
 /**
- * Events are our way of letting you know when something interesting happens in
- * your account. When an interesting event occurs, we create a new <code>Event</code>
- * object. For example, when a charge succeeds, we create a <code>charge.succeeded</code>
- * event, and when an invoice payment attempt fails, we create an
- * <code>invoice.payment_failed</code> event. Certain API requests might create multiple
- * events. For example, if you create a new subscription for a
- * customer, you receive both a <code>customer.subscription.created</code> event and a
- * <code>charge.succeeded</code> event.
+ * Snapshot events allow you to track and react to activity in your Stripe integration. When
+ * the state of another API resource changes, Stripe creates an <code>Event</code> object that contains
+ * all the relevant information associated with that action, including the affected API
+ * resource. For example, a successful payment triggers a <code>charge.succeeded</code> event, which
+ * contains the <code>Charge</code> in the event's data property. Some actions trigger multiple events.
+ * For example, if you create a new subscription for a customer, it triggers both a
+ * <code>customer.subscription.created</code> event and a <code>charge.succeeded</code> event.
  *
- * Events occur when the state of another API resource changes. The event's data
- * field embeds the resource's state at the time of the change. For
- * example, a <code>charge.succeeded</code> event contains a charge, and an
- * <code>invoice.payment_failed</code> event contains an invoice.
+ * Configure an event destination in your account to listen for events that represent actions
+ * your integration needs to respond to. Additionally, you can retrieve an individual event or
+ * a list of events from the API.
  *
- * As with other API resources, you can use endpoints to retrieve an
- * <a href="https://stripe.com/docs/api#retrieve_event">individual event</a> or a <a href="https://stripe.com/docs/api#list_events">list of events</a>
- * from the API. We also have a separate
- * <a href="http://en.wikipedia.org/wiki/Webhook">webhooks</a> system for sending the
- * <code>Event</code> objects directly to an endpoint on your server. You can manage
- * webhooks in your
- * <a href="https://dashboard.stripe.com/account/webhooks">account settings</a>. Learn how
- * to <a href="https://docs.stripe.com/webhooks">listen for events</a>
- * so that your integration can automatically trigger reactions.
+ * <a href="https://docs.stripe.com/connect">Connect</a> platforms can also receive event notifications
+ * that occur in their connected accounts. These events include an account attribute that
+ * identifies the relevant connected account.
  *
- * When using <a href="https://docs.stripe.com/connect">Connect</a>, you can also receive event notifications
- * that occur in connected accounts. For these events, there's an
- * additional <code>account</code> attribute in the received <code>Event</code> object.
- *
- * We only guarantee access to events through the <a href="https://stripe.com/docs/api#retrieve_event">Retrieve Event API</a>
+ * You can access events through the <a href="https://docs.stripe.com/api/events#retrieve_event">Retrieve Event API</a>
  * for 30 days.
  *
  * This class includes constants for the possible string representations of
@@ -42,7 +30,7 @@ namespace Stripe;
  * @property string $id Unique identifier for the object.
  * @property string $object String representing the object's type. Objects of the same type share the same value.
  * @property null|string $account The connected account that originates the event.
- * @property null|string $api_version The Stripe API version used to render <code>data</code>. This property is populated only for events on or after October 31, 2014.
+ * @property null|string $api_version The Stripe API version used to render <code>data</code> when the event was created. The contents of <code>data</code> never change, so this value remains static regardless of the API version currently in use. This property is populated only for events created on or after October 31, 2014.
  * @property null|string $context Authentication context needed to fetch the event or related object.
  * @property int $created Time at which the object was created. Measured in seconds since the Unix epoch.
  * @property (object{object: StripeObject, previous_attributes?: StripeObject}&StripeObject) $data
@@ -65,6 +53,7 @@ class Event extends ApiResource
     const APPLICATION_FEE_REFUNDED = 'application_fee.refunded';
     const APPLICATION_FEE_REFUND_UPDATED = 'application_fee.refund.updated';
     const BALANCE_AVAILABLE = 'balance.available';
+    const BALANCE_SETTINGS_UPDATED = 'balance_settings.updated';
     const BILLING_ALERT_TRIGGERED = 'billing.alert.triggered';
     const BILLING_CREDIT_BALANCE_TRANSACTION_CREATED = 'billing.credit_balance_transaction.created';
     const BILLING_CREDIT_GRANT_CREATED = 'billing.credit_grant.created';
@@ -132,6 +121,7 @@ class Event extends ApiResource
     const CUSTOMER_UPDATED = 'customer.updated';
     const ENTITLEMENTS_ACTIVE_ENTITLEMENT_SUMMARY_UPDATED = 'entitlements.active_entitlement_summary.updated';
     const FILE_CREATED = 'file.created';
+    const FINANCIAL_CONNECTIONS_ACCOUNT_ACCOUNT_NUMBERS_UPDATED = 'financial_connections.account.account_numbers_updated';
     const FINANCIAL_CONNECTIONS_ACCOUNT_CREATED = 'financial_connections.account.created';
     const FINANCIAL_CONNECTIONS_ACCOUNT_DEACTIVATED = 'financial_connections.account.deactivated';
     const FINANCIAL_CONNECTIONS_ACCOUNT_DISCONNECTED = 'financial_connections.account.disconnected';
@@ -139,6 +129,7 @@ class Event extends ApiResource
     const FINANCIAL_CONNECTIONS_ACCOUNT_REFRESHED_BALANCE = 'financial_connections.account.refreshed_balance';
     const FINANCIAL_CONNECTIONS_ACCOUNT_REFRESHED_OWNERSHIP = 'financial_connections.account.refreshed_ownership';
     const FINANCIAL_CONNECTIONS_ACCOUNT_REFRESHED_TRANSACTIONS = 'financial_connections.account.refreshed_transactions';
+    const FINANCIAL_CONNECTIONS_ACCOUNT_UPCOMING_ACCOUNT_NUMBER_EXPIRY = 'financial_connections.account.upcoming_account_number_expiry';
     const IDENTITY_VERIFICATION_SESSION_CANCELED = 'identity.verification_session.canceled';
     const IDENTITY_VERIFICATION_SESSION_CREATED = 'identity.verification_session.created';
     const IDENTITY_VERIFICATION_SESSION_PROCESSING = 'identity.verification_session.processing';
@@ -156,6 +147,7 @@ class Event extends ApiResource
     const INVOICE_OVERPAID = 'invoice.overpaid';
     const INVOICE_PAID = 'invoice.paid';
     const INVOICE_PAYMENT_ACTION_REQUIRED = 'invoice.payment_action_required';
+    const INVOICE_PAYMENT_ATTEMPT_REQUIRED = 'invoice.payment_attempt_required';
     const INVOICE_PAYMENT_FAILED = 'invoice.payment_failed';
     const INVOICE_PAYMENT_PAID = 'invoice_payment.paid';
     const INVOICE_PAYMENT_SUCCEEDED = 'invoice.payment_succeeded';
@@ -233,6 +225,13 @@ class Event extends ApiResource
     const REPORTING_REPORT_RUN_FAILED = 'reporting.report_run.failed';
     const REPORTING_REPORT_RUN_SUCCEEDED = 'reporting.report_run.succeeded';
     const REPORTING_REPORT_TYPE_UPDATED = 'reporting.report_type.updated';
+    const RESERVE_HOLD_CREATED = 'reserve.hold.created';
+    const RESERVE_HOLD_UPDATED = 'reserve.hold.updated';
+    const RESERVE_PLAN_CREATED = 'reserve.plan.created';
+    const RESERVE_PLAN_DISABLED = 'reserve.plan.disabled';
+    const RESERVE_PLAN_EXPIRED = 'reserve.plan.expired';
+    const RESERVE_PLAN_UPDATED = 'reserve.plan.updated';
+    const RESERVE_RELEASE_CREATED = 'reserve.release.created';
     const REVIEW_CLOSED = 'review.closed';
     const REVIEW_OPENED = 'review.opened';
     const SETUP_INTENT_CANCELED = 'setup_intent.canceled';
@@ -260,6 +259,7 @@ class Event extends ApiResource
     const TAX_SETTINGS_UPDATED = 'tax.settings.updated';
     const TERMINAL_READER_ACTION_FAILED = 'terminal.reader.action_failed';
     const TERMINAL_READER_ACTION_SUCCEEDED = 'terminal.reader.action_succeeded';
+    const TERMINAL_READER_ACTION_UPDATED = 'terminal.reader.action_updated';
     const TEST_HELPERS_TEST_CLOCK_ADVANCING = 'test_helpers.test_clock.advancing';
     const TEST_HELPERS_TEST_CLOCK_CREATED = 'test_helpers.test_clock.created';
     const TEST_HELPERS_TEST_CLOCK_DELETED = 'test_helpers.test_clock.deleted';
@@ -314,6 +314,7 @@ class Event extends ApiResource
     const TYPE_APPLICATION_FEE_REFUNDED = 'application_fee.refunded';
     const TYPE_APPLICATION_FEE_REFUND_UPDATED = 'application_fee.refund.updated';
     const TYPE_BALANCE_AVAILABLE = 'balance.available';
+    const TYPE_BALANCE_SETTINGS_UPDATED = 'balance_settings.updated';
     const TYPE_BILLING_ALERT_TRIGGERED = 'billing.alert.triggered';
     const TYPE_BILLING_CREDIT_BALANCE_TRANSACTION_CREATED = 'billing.credit_balance_transaction.created';
     const TYPE_BILLING_CREDIT_GRANT_CREATED = 'billing.credit_grant.created';
@@ -381,6 +382,7 @@ class Event extends ApiResource
     const TYPE_CUSTOMER_UPDATED = 'customer.updated';
     const TYPE_ENTITLEMENTS_ACTIVE_ENTITLEMENT_SUMMARY_UPDATED = 'entitlements.active_entitlement_summary.updated';
     const TYPE_FILE_CREATED = 'file.created';
+    const TYPE_FINANCIAL_CONNECTIONS_ACCOUNT_ACCOUNT_NUMBERS_UPDATED = 'financial_connections.account.account_numbers_updated';
     const TYPE_FINANCIAL_CONNECTIONS_ACCOUNT_CREATED = 'financial_connections.account.created';
     const TYPE_FINANCIAL_CONNECTIONS_ACCOUNT_DEACTIVATED = 'financial_connections.account.deactivated';
     const TYPE_FINANCIAL_CONNECTIONS_ACCOUNT_DISCONNECTED = 'financial_connections.account.disconnected';
@@ -388,6 +390,7 @@ class Event extends ApiResource
     const TYPE_FINANCIAL_CONNECTIONS_ACCOUNT_REFRESHED_BALANCE = 'financial_connections.account.refreshed_balance';
     const TYPE_FINANCIAL_CONNECTIONS_ACCOUNT_REFRESHED_OWNERSHIP = 'financial_connections.account.refreshed_ownership';
     const TYPE_FINANCIAL_CONNECTIONS_ACCOUNT_REFRESHED_TRANSACTIONS = 'financial_connections.account.refreshed_transactions';
+    const TYPE_FINANCIAL_CONNECTIONS_ACCOUNT_UPCOMING_ACCOUNT_NUMBER_EXPIRY = 'financial_connections.account.upcoming_account_number_expiry';
     const TYPE_IDENTITY_VERIFICATION_SESSION_CANCELED = 'identity.verification_session.canceled';
     const TYPE_IDENTITY_VERIFICATION_SESSION_CREATED = 'identity.verification_session.created';
     const TYPE_IDENTITY_VERIFICATION_SESSION_PROCESSING = 'identity.verification_session.processing';
@@ -405,6 +408,7 @@ class Event extends ApiResource
     const TYPE_INVOICE_OVERPAID = 'invoice.overpaid';
     const TYPE_INVOICE_PAID = 'invoice.paid';
     const TYPE_INVOICE_PAYMENT_ACTION_REQUIRED = 'invoice.payment_action_required';
+    const TYPE_INVOICE_PAYMENT_ATTEMPT_REQUIRED = 'invoice.payment_attempt_required';
     const TYPE_INVOICE_PAYMENT_FAILED = 'invoice.payment_failed';
     const TYPE_INVOICE_PAYMENT_PAID = 'invoice_payment.paid';
     const TYPE_INVOICE_PAYMENT_SUCCEEDED = 'invoice.payment_succeeded';
@@ -482,6 +486,13 @@ class Event extends ApiResource
     const TYPE_REPORTING_REPORT_RUN_FAILED = 'reporting.report_run.failed';
     const TYPE_REPORTING_REPORT_RUN_SUCCEEDED = 'reporting.report_run.succeeded';
     const TYPE_REPORTING_REPORT_TYPE_UPDATED = 'reporting.report_type.updated';
+    const TYPE_RESERVE_HOLD_CREATED = 'reserve.hold.created';
+    const TYPE_RESERVE_HOLD_UPDATED = 'reserve.hold.updated';
+    const TYPE_RESERVE_PLAN_CREATED = 'reserve.plan.created';
+    const TYPE_RESERVE_PLAN_DISABLED = 'reserve.plan.disabled';
+    const TYPE_RESERVE_PLAN_EXPIRED = 'reserve.plan.expired';
+    const TYPE_RESERVE_PLAN_UPDATED = 'reserve.plan.updated';
+    const TYPE_RESERVE_RELEASE_CREATED = 'reserve.release.created';
     const TYPE_REVIEW_CLOSED = 'review.closed';
     const TYPE_REVIEW_OPENED = 'review.opened';
     const TYPE_SETUP_INTENT_CANCELED = 'setup_intent.canceled';
@@ -509,6 +520,7 @@ class Event extends ApiResource
     const TYPE_TAX_SETTINGS_UPDATED = 'tax.settings.updated';
     const TYPE_TERMINAL_READER_ACTION_FAILED = 'terminal.reader.action_failed';
     const TYPE_TERMINAL_READER_ACTION_SUCCEEDED = 'terminal.reader.action_succeeded';
+    const TYPE_TERMINAL_READER_ACTION_UPDATED = 'terminal.reader.action_updated';
     const TYPE_TEST_HELPERS_TEST_CLOCK_ADVANCING = 'test_helpers.test_clock.advancing';
     const TYPE_TEST_HELPERS_TEST_CLOCK_CREATED = 'test_helpers.test_clock.created';
     const TYPE_TEST_HELPERS_TEST_CLOCK_DELETED = 'test_helpers.test_clock.deleted';