updates
This commit is contained in:
Iliyan Angelov
413
Backend/venv/lib/python3.12/site-packages/stripe/_event.py
Normal file
413
Backend/venv/lib/python3.12/site-packages/stripe/_event.py
Normal file
@@ -0,0 +1,413 @@
|
||||
# -*- coding: utf-8 -*-
|
||||
# File generated from our OpenAPI spec
|
||||
from stripe._list_object import ListObject
|
||||
from stripe._listable_api_resource import ListableAPIResource
|
||||
from stripe._stripe_object import StripeObject
|
||||
from typing import ClassVar, Dict, Optional
|
||||
from typing_extensions import Literal, Unpack, TYPE_CHECKING
|
||||
|
||||
if TYPE_CHECKING:
|
||||
from stripe.params._event_list_params import EventListParams
|
||||
from stripe.params._event_retrieve_params import EventRetrieveParams
|
||||
from typing import Any
|
||||
|
||||
|
||||
class Event(ListableAPIResource["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 `Event` object that contains
|
||||
all the relevant information associated with that action, including the affected API
|
||||
resource. For example, a successful payment triggers a `charge.succeeded` event, which
|
||||
contains the `Charge` 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
|
||||
`customer.subscription.created` event and a `charge.succeeded` event.
|
||||
|
||||
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.
|
||||
|
||||
[Connect](https://docs.stripe.com/connect) platforms can also receive event notifications
|
||||
that occur in their connected accounts. These events include an account attribute that
|
||||
identifies the relevant connected account.
|
||||
|
||||
You can access events through the [Retrieve Event API](https://docs.stripe.com/api/events#retrieve_event)
|
||||
for 30 days.
|
||||
"""
|
||||
|
||||
OBJECT_NAME: ClassVar[Literal["event"]] = "event"
|
||||
|
||||
class Data(StripeObject):
|
||||
object: Dict[str, "Any"]
|
||||
"""
|
||||
Object containing the API resource relevant to the event. For example, an `invoice.created` event will have a full [invoice object](https://stripe.com/docs/api#invoice_object) as the value of the object key.
|
||||
"""
|
||||
previous_attributes: Optional[Dict[str, "Any"]]
|
||||
"""
|
||||
Object containing the names of the updated attributes and their values prior to the event (only included in events of type `*.updated`). If an array attribute has any updated elements, this object contains the entire array. In Stripe API versions 2017-04-06 or earlier, an updated array attribute in this object includes only the updated array elements.
|
||||
"""
|
||||
|
||||
class Request(StripeObject):
|
||||
id: Optional[str]
|
||||
"""
|
||||
ID of the API request that caused the event. If null, the event was automatic (e.g., Stripe's automatic subscription handling). Request logs are available in the [dashboard](https://dashboard.stripe.com/logs), but currently not in the API.
|
||||
"""
|
||||
idempotency_key: Optional[str]
|
||||
"""
|
||||
The idempotency key transmitted during the request, if any. *Note: This property is populated only for events on or after May 23, 2017*.
|
||||
"""
|
||||
|
||||
account: Optional[str]
|
||||
"""
|
||||
The connected account that originates the event.
|
||||
"""
|
||||
api_version: Optional[str]
|
||||
"""
|
||||
The Stripe API version used to render `data` when the event was created. The contents of `data` 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.
|
||||
"""
|
||||
context: Optional[str]
|
||||
"""
|
||||
Authentication context needed to fetch the event or related object.
|
||||
"""
|
||||
created: int
|
||||
"""
|
||||
Time at which the object was created. Measured in seconds since the Unix epoch.
|
||||
"""
|
||||
data: Data
|
||||
id: str
|
||||
"""
|
||||
Unique identifier for the object.
|
||||
"""
|
||||
livemode: bool
|
||||
"""
|
||||
Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
|
||||
"""
|
||||
object: Literal["event"]
|
||||
"""
|
||||
String representing the object's type. Objects of the same type share the same value.
|
||||
"""
|
||||
pending_webhooks: int
|
||||
"""
|
||||
Number of webhooks that haven't been successfully delivered (for example, to return a 20x response) to the URLs you specify.
|
||||
"""
|
||||
request: Optional[Request]
|
||||
"""
|
||||
Information on the API request that triggers the event.
|
||||
"""
|
||||
type: Literal[
|
||||
"account.application.authorized",
|
||||
"account.application.deauthorized",
|
||||
"account.external_account.created",
|
||||
"account.external_account.deleted",
|
||||
"account.external_account.updated",
|
||||
"account.updated",
|
||||
"application_fee.created",
|
||||
"application_fee.refund.updated",
|
||||
"application_fee.refunded",
|
||||
"balance.available",
|
||||
"balance_settings.updated",
|
||||
"billing.alert.triggered",
|
||||
"billing_portal.configuration.created",
|
||||
"billing_portal.configuration.updated",
|
||||
"billing_portal.session.created",
|
||||
"capability.updated",
|
||||
"cash_balance.funds_available",
|
||||
"charge.captured",
|
||||
"charge.dispute.closed",
|
||||
"charge.dispute.created",
|
||||
"charge.dispute.funds_reinstated",
|
||||
"charge.dispute.funds_withdrawn",
|
||||
"charge.dispute.updated",
|
||||
"charge.expired",
|
||||
"charge.failed",
|
||||
"charge.pending",
|
||||
"charge.refund.updated",
|
||||
"charge.refunded",
|
||||
"charge.succeeded",
|
||||
"charge.updated",
|
||||
"checkout.session.async_payment_failed",
|
||||
"checkout.session.async_payment_succeeded",
|
||||
"checkout.session.completed",
|
||||
"checkout.session.expired",
|
||||
"climate.order.canceled",
|
||||
"climate.order.created",
|
||||
"climate.order.delayed",
|
||||
"climate.order.delivered",
|
||||
"climate.order.product_substituted",
|
||||
"climate.product.created",
|
||||
"climate.product.pricing_updated",
|
||||
"coupon.created",
|
||||
"coupon.deleted",
|
||||
"coupon.updated",
|
||||
"credit_note.created",
|
||||
"credit_note.updated",
|
||||
"credit_note.voided",
|
||||
"customer.created",
|
||||
"customer.deleted",
|
||||
"customer.discount.created",
|
||||
"customer.discount.deleted",
|
||||
"customer.discount.updated",
|
||||
"customer.source.created",
|
||||
"customer.source.deleted",
|
||||
"customer.source.expiring",
|
||||
"customer.source.updated",
|
||||
"customer.subscription.created",
|
||||
"customer.subscription.deleted",
|
||||
"customer.subscription.paused",
|
||||
"customer.subscription.pending_update_applied",
|
||||
"customer.subscription.pending_update_expired",
|
||||
"customer.subscription.resumed",
|
||||
"customer.subscription.trial_will_end",
|
||||
"customer.subscription.updated",
|
||||
"customer.tax_id.created",
|
||||
"customer.tax_id.deleted",
|
||||
"customer.tax_id.updated",
|
||||
"customer.updated",
|
||||
"customer_cash_balance_transaction.created",
|
||||
"entitlements.active_entitlement_summary.updated",
|
||||
"file.created",
|
||||
"financial_connections.account.created",
|
||||
"financial_connections.account.deactivated",
|
||||
"financial_connections.account.disconnected",
|
||||
"financial_connections.account.reactivated",
|
||||
"financial_connections.account.refreshed_balance",
|
||||
"financial_connections.account.refreshed_ownership",
|
||||
"financial_connections.account.refreshed_transactions",
|
||||
"identity.verification_session.canceled",
|
||||
"identity.verification_session.created",
|
||||
"identity.verification_session.processing",
|
||||
"identity.verification_session.redacted",
|
||||
"identity.verification_session.requires_input",
|
||||
"identity.verification_session.verified",
|
||||
"invoice.created",
|
||||
"invoice.deleted",
|
||||
"invoice.finalization_failed",
|
||||
"invoice.finalized",
|
||||
"invoice.marked_uncollectible",
|
||||
"invoice.overdue",
|
||||
"invoice.overpaid",
|
||||
"invoice.paid",
|
||||
"invoice.payment_action_required",
|
||||
"invoice.payment_attempt_required",
|
||||
"invoice.payment_failed",
|
||||
"invoice.payment_succeeded",
|
||||
"invoice.sent",
|
||||
"invoice.upcoming",
|
||||
"invoice.updated",
|
||||
"invoice.voided",
|
||||
"invoice.will_be_due",
|
||||
"invoice_payment.paid",
|
||||
"invoiceitem.created",
|
||||
"invoiceitem.deleted",
|
||||
"issuing_authorization.created",
|
||||
"issuing_authorization.request",
|
||||
"issuing_authorization.updated",
|
||||
"issuing_card.created",
|
||||
"issuing_card.updated",
|
||||
"issuing_cardholder.created",
|
||||
"issuing_cardholder.updated",
|
||||
"issuing_dispute.closed",
|
||||
"issuing_dispute.created",
|
||||
"issuing_dispute.funds_reinstated",
|
||||
"issuing_dispute.funds_rescinded",
|
||||
"issuing_dispute.submitted",
|
||||
"issuing_dispute.updated",
|
||||
"issuing_personalization_design.activated",
|
||||
"issuing_personalization_design.deactivated",
|
||||
"issuing_personalization_design.rejected",
|
||||
"issuing_personalization_design.updated",
|
||||
"issuing_token.created",
|
||||
"issuing_token.updated",
|
||||
"issuing_transaction.created",
|
||||
"issuing_transaction.purchase_details_receipt_updated",
|
||||
"issuing_transaction.updated",
|
||||
"mandate.updated",
|
||||
"payment_intent.amount_capturable_updated",
|
||||
"payment_intent.canceled",
|
||||
"payment_intent.created",
|
||||
"payment_intent.partially_funded",
|
||||
"payment_intent.payment_failed",
|
||||
"payment_intent.processing",
|
||||
"payment_intent.requires_action",
|
||||
"payment_intent.succeeded",
|
||||
"payment_link.created",
|
||||
"payment_link.updated",
|
||||
"payment_method.attached",
|
||||
"payment_method.automatically_updated",
|
||||
"payment_method.detached",
|
||||
"payment_method.updated",
|
||||
"payout.canceled",
|
||||
"payout.created",
|
||||
"payout.failed",
|
||||
"payout.paid",
|
||||
"payout.reconciliation_completed",
|
||||
"payout.updated",
|
||||
"person.created",
|
||||
"person.deleted",
|
||||
"person.updated",
|
||||
"plan.created",
|
||||
"plan.deleted",
|
||||
"plan.updated",
|
||||
"price.created",
|
||||
"price.deleted",
|
||||
"price.updated",
|
||||
"product.created",
|
||||
"product.deleted",
|
||||
"product.updated",
|
||||
"promotion_code.created",
|
||||
"promotion_code.updated",
|
||||
"quote.accepted",
|
||||
"quote.canceled",
|
||||
"quote.created",
|
||||
"quote.finalized",
|
||||
"radar.early_fraud_warning.created",
|
||||
"radar.early_fraud_warning.updated",
|
||||
"refund.created",
|
||||
"refund.failed",
|
||||
"refund.updated",
|
||||
"reporting.report_run.failed",
|
||||
"reporting.report_run.succeeded",
|
||||
"reporting.report_type.updated",
|
||||
"review.closed",
|
||||
"review.opened",
|
||||
"setup_intent.canceled",
|
||||
"setup_intent.created",
|
||||
"setup_intent.requires_action",
|
||||
"setup_intent.setup_failed",
|
||||
"setup_intent.succeeded",
|
||||
"sigma.scheduled_query_run.created",
|
||||
"source.canceled",
|
||||
"source.chargeable",
|
||||
"source.failed",
|
||||
"source.mandate_notification",
|
||||
"source.refund_attributes_required",
|
||||
"source.transaction.created",
|
||||
"source.transaction.updated",
|
||||
"subscription_schedule.aborted",
|
||||
"subscription_schedule.canceled",
|
||||
"subscription_schedule.completed",
|
||||
"subscription_schedule.created",
|
||||
"subscription_schedule.expiring",
|
||||
"subscription_schedule.released",
|
||||
"subscription_schedule.updated",
|
||||
"tax.settings.updated",
|
||||
"tax_rate.created",
|
||||
"tax_rate.updated",
|
||||
"terminal.reader.action_failed",
|
||||
"terminal.reader.action_succeeded",
|
||||
"terminal.reader.action_updated",
|
||||
"test_helpers.test_clock.advancing",
|
||||
"test_helpers.test_clock.created",
|
||||
"test_helpers.test_clock.deleted",
|
||||
"test_helpers.test_clock.internal_failure",
|
||||
"test_helpers.test_clock.ready",
|
||||
"topup.canceled",
|
||||
"topup.created",
|
||||
"topup.failed",
|
||||
"topup.reversed",
|
||||
"topup.succeeded",
|
||||
"transfer.created",
|
||||
"transfer.reversed",
|
||||
"transfer.updated",
|
||||
"treasury.credit_reversal.created",
|
||||
"treasury.credit_reversal.posted",
|
||||
"treasury.debit_reversal.completed",
|
||||
"treasury.debit_reversal.created",
|
||||
"treasury.debit_reversal.initial_credit_granted",
|
||||
"treasury.financial_account.closed",
|
||||
"treasury.financial_account.created",
|
||||
"treasury.financial_account.features_status_updated",
|
||||
"treasury.inbound_transfer.canceled",
|
||||
"treasury.inbound_transfer.created",
|
||||
"treasury.inbound_transfer.failed",
|
||||
"treasury.inbound_transfer.succeeded",
|
||||
"treasury.outbound_payment.canceled",
|
||||
"treasury.outbound_payment.created",
|
||||
"treasury.outbound_payment.expected_arrival_date_updated",
|
||||
"treasury.outbound_payment.failed",
|
||||
"treasury.outbound_payment.posted",
|
||||
"treasury.outbound_payment.returned",
|
||||
"treasury.outbound_payment.tracking_details_updated",
|
||||
"treasury.outbound_transfer.canceled",
|
||||
"treasury.outbound_transfer.created",
|
||||
"treasury.outbound_transfer.expected_arrival_date_updated",
|
||||
"treasury.outbound_transfer.failed",
|
||||
"treasury.outbound_transfer.posted",
|
||||
"treasury.outbound_transfer.returned",
|
||||
"treasury.outbound_transfer.tracking_details_updated",
|
||||
"treasury.received_credit.created",
|
||||
"treasury.received_credit.failed",
|
||||
"treasury.received_credit.succeeded",
|
||||
"treasury.received_debit.created",
|
||||
"billing.credit_balance_transaction.created",
|
||||
"billing.credit_grant.created",
|
||||
"billing.credit_grant.updated",
|
||||
"billing.meter.created",
|
||||
"billing.meter.deactivated",
|
||||
"billing.meter.reactivated",
|
||||
"billing.meter.updated",
|
||||
]
|
||||
"""
|
||||
Description of the event (for example, `invoice.created` or `charge.refunded`).
|
||||
"""
|
||||
|
||||
@classmethod
|
||||
def list(cls, **params: Unpack["EventListParams"]) -> ListObject["Event"]:
|
||||
"""
|
||||
List events, going back up to 30 days. Each event data is rendered according to Stripe API version at its creation time, specified in [event object](https://docs.stripe.com/api/events/object) api_version attribute (not according to your current Stripe API version or Stripe-Version header).
|
||||
"""
|
||||
result = cls._static_request(
|
||||
"get",
|
||||
cls.class_url(),
|
||||
params=params,
|
||||
)
|
||||
if not isinstance(result, ListObject):
|
||||
raise TypeError(
|
||||
"Expected list object from API, got %s"
|
||||
% (type(result).__name__)
|
||||
)
|
||||
|
||||
return result
|
||||
|
||||
@classmethod
|
||||
async def list_async(
|
||||
cls, **params: Unpack["EventListParams"]
|
||||
) -> ListObject["Event"]:
|
||||
"""
|
||||
List events, going back up to 30 days. Each event data is rendered according to Stripe API version at its creation time, specified in [event object](https://docs.stripe.com/api/events/object) api_version attribute (not according to your current Stripe API version or Stripe-Version header).
|
||||
"""
|
||||
result = await cls._static_request_async(
|
||||
"get",
|
||||
cls.class_url(),
|
||||
params=params,
|
||||
)
|
||||
if not isinstance(result, ListObject):
|
||||
raise TypeError(
|
||||
"Expected list object from API, got %s"
|
||||
% (type(result).__name__)
|
||||
)
|
||||
|
||||
return result
|
||||
|
||||
@classmethod
|
||||
def retrieve(
|
||||
cls, id: str, **params: Unpack["EventRetrieveParams"]
|
||||
) -> "Event":
|
||||
"""
|
||||
Retrieves the details of an event if it was created in the last 30 days. Supply the unique identifier of the event, which you might have received in a webhook.
|
||||
"""
|
||||
instance = cls(id, **params)
|
||||
instance.refresh()
|
||||
return instance
|
||||
|
||||
@classmethod
|
||||
async def retrieve_async(
|
||||
cls, id: str, **params: Unpack["EventRetrieveParams"]
|
||||
) -> "Event":
|
||||
"""
|
||||
Retrieves the details of an event if it was created in the last 30 days. Supply the unique identifier of the event, which you might have received in a webhook.
|
||||
"""
|
||||
instance = cls(id, **params)
|
||||
await instance.refresh_async()
|
||||
return instance
|
||||
|
||||
_inner_class_types = {"data": Data, "request": Request}
|
||||
Reference in New Issue
Block a user