stripe 20.0.0 → 20.1.0-alpha.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +1902 -12
- package/OPENAPI_VERSION +1 -1
- package/README.md +1 -0
- package/VERSION +1 -1
- package/cjs/Error.js +115 -1
- package/cjs/apiVersion.js +2 -3
- package/cjs/resources/AccountNotices.js +21 -0
- package/cjs/resources/BalanceTransfers.js +9 -0
- package/cjs/resources/Billing/Analytics/MeterUsage.js +12 -0
- package/cjs/resources/Capital/FinancingOffers.js +21 -0
- package/cjs/resources/Capital/FinancingSummary.js +12 -0
- package/cjs/resources/Capital/FinancingTransactions.js +17 -0
- package/cjs/resources/DelegatedCheckout/RequestedSessions.js +28 -0
- package/cjs/resources/ExternalAccounts.js +23 -0
- package/cjs/resources/FinancialConnections/Accounts.js +5 -0
- package/cjs/resources/FinancialConnections/Institutions.js +17 -0
- package/cjs/resources/FxQuotes.js +15 -0
- package/cjs/resources/Identity/BlocklistEntries.js +25 -0
- package/cjs/resources/Issuing/CreditUnderwritingRecords.js +33 -0
- package/cjs/resources/Issuing/DisputeSettlementDetails.js +17 -0
- package/cjs/resources/Issuing/FraudLiabilityDebits.js +17 -0
- package/cjs/resources/Issuing/Programs.js +22 -0
- package/cjs/resources/Mandates.js +5 -0
- package/cjs/resources/Margins.js +22 -0
- package/cjs/resources/Orders.js +24 -0
- package/cjs/resources/PaymentIntents.js +8 -0
- package/cjs/resources/PaymentMethods.js +4 -0
- package/cjs/resources/Privacy/RedactionJobs.js +42 -0
- package/cjs/resources/Quotes.js +32 -0
- package/cjs/resources/Radar/AccountEvaluations.js +20 -0
- package/cjs/resources/SubscriptionSchedules.js +4 -0
- package/cjs/resources/Subscriptions.js +4 -0
- package/cjs/resources/Tax/Forms.js +20 -0
- package/cjs/resources/Terminal/ReaderCollectedData.js +12 -0
- package/cjs/resources/TestHelpers/Capital/FinancingOffers.js +16 -0
- package/cjs/resources/V2/Billing/BillSettings/Versions.js +17 -0
- package/cjs/resources/V2/Billing/BillSettings.js +27 -0
- package/cjs/resources/V2/Billing/Cadences.js +23 -0
- package/cjs/resources/V2/Billing/CollectionSettings/Versions.js +17 -0
- package/cjs/resources/V2/Billing/CollectionSettings.js +30 -0
- package/cjs/resources/V2/Billing/CustomPricingUnits.js +25 -0
- package/cjs/resources/V2/Billing/Intents/Actions.js +17 -0
- package/cjs/resources/V2/Billing/Intents.js +36 -0
- package/cjs/resources/V2/Billing/LicenseFeeSubscriptions.js +12 -0
- package/cjs/resources/V2/Billing/LicenseFees/Versions.js +17 -0
- package/cjs/resources/V2/Billing/LicenseFees.js +27 -0
- package/cjs/resources/V2/Billing/LicensedItems.js +25 -0
- package/cjs/resources/V2/Billing/MeteredItems.js +22 -0
- package/cjs/resources/V2/Billing/PricingPlanSubscriptions/Components.js +12 -0
- package/cjs/resources/V2/Billing/PricingPlanSubscriptions.js +26 -0
- package/cjs/resources/V2/Billing/PricingPlans/Components.js +29 -0
- package/cjs/resources/V2/Billing/PricingPlans/Versions.js +17 -0
- package/cjs/resources/V2/Billing/PricingPlans.js +29 -0
- package/cjs/resources/V2/Billing/Profiles.js +19 -0
- package/cjs/resources/V2/Billing/RateCardSubscriptions.js +29 -0
- package/cjs/resources/V2/Billing/RateCards/Rates.js +25 -0
- package/cjs/resources/V2/Billing/RateCards/Versions.js +17 -0
- package/cjs/resources/V2/Billing/RateCards.js +29 -0
- package/cjs/resources/V2/Billing/ServiceActions.js +20 -0
- package/cjs/resources/V2/Core/AccountLinks.js +9 -0
- package/cjs/resources/V2/Core/AccountTokens.js +13 -0
- package/cjs/resources/V2/Core/Accounts/PersonTokens.js +16 -0
- package/cjs/resources/V2/Core/Accounts/Persons.js +29 -0
- package/cjs/resources/V2/Core/Accounts.js +27 -0
- package/cjs/resources/V2/Core/ClaimableSandboxes.js +16 -0
- package/cjs/resources/V2/Core/Vault/GbBankAccounts.js +33 -0
- package/cjs/resources/V2/Core/Vault/UsBankAccounts.js +37 -0
- package/cjs/resources/V2/MoneyManagement/Adjustments.js +17 -0
- package/cjs/resources/V2/MoneyManagement/CurrencyConversions.js +21 -0
- package/cjs/resources/V2/MoneyManagement/FinancialAccounts.js +29 -0
- package/cjs/resources/V2/MoneyManagement/FinancialAddresses.js +21 -0
- package/cjs/resources/V2/MoneyManagement/InboundTransfers.js +21 -0
- package/cjs/resources/V2/MoneyManagement/OutboundPaymentQuotes.js +16 -0
- package/cjs/resources/V2/MoneyManagement/OutboundPayments.js +25 -0
- package/cjs/resources/V2/MoneyManagement/OutboundSetupIntents.js +29 -0
- package/cjs/resources/V2/MoneyManagement/OutboundTransfers.js +25 -0
- package/cjs/resources/V2/MoneyManagement/PayoutMethods.js +25 -0
- package/cjs/resources/V2/MoneyManagement/PayoutMethodsBankAccountSpec.js +12 -0
- package/cjs/resources/V2/MoneyManagement/ReceivedCredits.js +17 -0
- package/cjs/resources/V2/MoneyManagement/ReceivedDebits.js +17 -0
- package/cjs/resources/V2/MoneyManagement/RecipientVerifications.js +20 -0
- package/cjs/resources/V2/MoneyManagement/TransactionEntries.js +17 -0
- package/cjs/resources/V2/MoneyManagement/Transactions.js +17 -0
- package/cjs/resources/V2/Payments/OffSessionPayments.js +29 -0
- package/cjs/resources/V2/Reporting/ReportRuns.js +13 -0
- package/cjs/resources/V2/Reporting/Reports.js +12 -0
- package/cjs/resources/V2/TestHelpers/FinancialAddresses.js +16 -0
- package/cjs/resources/V2/TestHelpers/MoneyManagement.js +12 -0
- package/cjs/resources.js +156 -8
- package/cjs/stripe.core.js +1 -1
- package/esm/Error.js +100 -0
- package/esm/apiVersion.js +1 -2
- package/esm/resources/AccountNotices.js +18 -0
- package/esm/resources/BalanceTransfers.js +6 -0
- package/esm/resources/Billing/Analytics/MeterUsage.js +9 -0
- package/esm/resources/Capital/FinancingOffers.js +18 -0
- package/esm/resources/Capital/FinancingSummary.js +9 -0
- package/esm/resources/Capital/FinancingTransactions.js +14 -0
- package/esm/resources/DelegatedCheckout/RequestedSessions.js +25 -0
- package/esm/resources/ExternalAccounts.js +20 -0
- package/esm/resources/FinancialConnections/Accounts.js +5 -0
- package/esm/resources/FinancialConnections/Institutions.js +14 -0
- package/esm/resources/FxQuotes.js +12 -0
- package/esm/resources/Identity/BlocklistEntries.js +22 -0
- package/esm/resources/Issuing/CreditUnderwritingRecords.js +30 -0
- package/esm/resources/Issuing/DisputeSettlementDetails.js +14 -0
- package/esm/resources/Issuing/FraudLiabilityDebits.js +14 -0
- package/esm/resources/Issuing/Programs.js +19 -0
- package/esm/resources/Mandates.js +5 -0
- package/esm/resources/Margins.js +19 -0
- package/esm/resources/Orders.js +21 -0
- package/esm/resources/PaymentIntents.js +8 -0
- package/esm/resources/PaymentMethods.js +4 -0
- package/esm/resources/Privacy/RedactionJobs.js +39 -0
- package/esm/resources/Quotes.js +32 -0
- package/esm/resources/Radar/AccountEvaluations.js +17 -0
- package/esm/resources/SubscriptionSchedules.js +4 -0
- package/esm/resources/Subscriptions.js +4 -0
- package/esm/resources/Tax/Forms.js +17 -0
- package/esm/resources/Terminal/ReaderCollectedData.js +9 -0
- package/esm/resources/TestHelpers/Capital/FinancingOffers.js +13 -0
- package/esm/resources/V2/Billing/BillSettings/Versions.js +14 -0
- package/esm/resources/V2/Billing/BillSettings.js +24 -0
- package/esm/resources/V2/Billing/Cadences.js +20 -0
- package/esm/resources/V2/Billing/CollectionSettings/Versions.js +14 -0
- package/esm/resources/V2/Billing/CollectionSettings.js +27 -0
- package/esm/resources/V2/Billing/CustomPricingUnits.js +22 -0
- package/esm/resources/V2/Billing/Intents/Actions.js +14 -0
- package/esm/resources/V2/Billing/Intents.js +33 -0
- package/esm/resources/V2/Billing/LicenseFeeSubscriptions.js +9 -0
- package/esm/resources/V2/Billing/LicenseFees/Versions.js +14 -0
- package/esm/resources/V2/Billing/LicenseFees.js +24 -0
- package/esm/resources/V2/Billing/LicensedItems.js +22 -0
- package/esm/resources/V2/Billing/MeteredItems.js +19 -0
- package/esm/resources/V2/Billing/PricingPlanSubscriptions/Components.js +9 -0
- package/esm/resources/V2/Billing/PricingPlanSubscriptions.js +23 -0
- package/esm/resources/V2/Billing/PricingPlans/Components.js +26 -0
- package/esm/resources/V2/Billing/PricingPlans/Versions.js +14 -0
- package/esm/resources/V2/Billing/PricingPlans.js +26 -0
- package/esm/resources/V2/Billing/Profiles.js +16 -0
- package/esm/resources/V2/Billing/RateCardSubscriptions.js +26 -0
- package/esm/resources/V2/Billing/RateCards/Rates.js +22 -0
- package/esm/resources/V2/Billing/RateCards/Versions.js +14 -0
- package/esm/resources/V2/Billing/RateCards.js +26 -0
- package/esm/resources/V2/Billing/ServiceActions.js +17 -0
- package/esm/resources/V2/Core/AccountLinks.js +6 -0
- package/esm/resources/V2/Core/AccountTokens.js +10 -0
- package/esm/resources/V2/Core/Accounts/PersonTokens.js +13 -0
- package/esm/resources/V2/Core/Accounts/Persons.js +26 -0
- package/esm/resources/V2/Core/Accounts.js +24 -0
- package/esm/resources/V2/Core/ClaimableSandboxes.js +13 -0
- package/esm/resources/V2/Core/Vault/GbBankAccounts.js +30 -0
- package/esm/resources/V2/Core/Vault/UsBankAccounts.js +34 -0
- package/esm/resources/V2/MoneyManagement/Adjustments.js +14 -0
- package/esm/resources/V2/MoneyManagement/CurrencyConversions.js +18 -0
- package/esm/resources/V2/MoneyManagement/FinancialAccounts.js +26 -0
- package/esm/resources/V2/MoneyManagement/FinancialAddresses.js +18 -0
- package/esm/resources/V2/MoneyManagement/InboundTransfers.js +18 -0
- package/esm/resources/V2/MoneyManagement/OutboundPaymentQuotes.js +13 -0
- package/esm/resources/V2/MoneyManagement/OutboundPayments.js +22 -0
- package/esm/resources/V2/MoneyManagement/OutboundSetupIntents.js +26 -0
- package/esm/resources/V2/MoneyManagement/OutboundTransfers.js +22 -0
- package/esm/resources/V2/MoneyManagement/PayoutMethods.js +22 -0
- package/esm/resources/V2/MoneyManagement/PayoutMethodsBankAccountSpec.js +9 -0
- package/esm/resources/V2/MoneyManagement/ReceivedCredits.js +14 -0
- package/esm/resources/V2/MoneyManagement/ReceivedDebits.js +14 -0
- package/esm/resources/V2/MoneyManagement/RecipientVerifications.js +17 -0
- package/esm/resources/V2/MoneyManagement/TransactionEntries.js +14 -0
- package/esm/resources/V2/MoneyManagement/Transactions.js +14 -0
- package/esm/resources/V2/Payments/OffSessionPayments.js +26 -0
- package/esm/resources/V2/Reporting/ReportRuns.js +10 -0
- package/esm/resources/V2/Reporting/Reports.js +9 -0
- package/esm/resources/V2/TestHelpers/FinancialAddresses.js +13 -0
- package/esm/resources/V2/TestHelpers/MoneyManagement.js +9 -0
- package/esm/resources.js +142 -0
- package/esm/stripe.core.js +1 -1
- package/package.json +1 -1
- package/types/AccountLinksResource.d.ts +5 -1
- package/types/AccountNotices.d.ts +113 -0
- package/types/AccountNoticesResource.d.ts +98 -0
- package/types/AccountSessions.d.ts +45 -0
- package/types/AccountSessionsResource.d.ts +264 -0
- package/types/Accounts.d.ts +232 -1
- package/types/AccountsResource.d.ts +674 -0
- package/types/ApplicationFees.d.ts +6 -1
- package/types/Balance.d.ts +82 -0
- package/types/BalanceTransactions.d.ts +2 -1
- package/types/BalanceTransfers.d.ts +122 -0
- package/types/BalanceTransfersResource.d.ts +87 -0
- package/types/BankAccounts.d.ts +2 -0
- package/types/Billing/AlertTriggereds.d.ts +16 -1
- package/types/Billing/Alerts.d.ts +116 -1
- package/types/Billing/AlertsResource.d.ts +149 -2
- package/types/Billing/Analytics/MeterUsage.d.ts +31 -0
- package/types/Billing/Analytics/MeterUsageResource.d.ts +694 -0
- package/types/Billing/Analytics/MeterUsageRows.d.ts +58 -0
- package/types/Billing/CreditBalanceSummary.d.ts +123 -2
- package/types/Billing/CreditBalanceSummaryResource.d.ts +20 -3
- package/types/Billing/CreditBalanceTransactions.d.ts +118 -2
- package/types/Billing/CreditBalanceTransactionsResource.d.ts +12 -4
- package/types/Billing/CreditGrants.d.ts +76 -1
- package/types/Billing/CreditGrantsResource.d.ts +45 -4
- package/types/Billing/MeterEventSummaries.d.ts +7 -0
- package/types/Billing/Meters.d.ts +5 -0
- package/types/Billing/MetersResource.d.ts +17 -0
- package/types/BillingPortal/Sessions.d.ts +5 -0
- package/types/BillingPortal/SessionsResource.d.ts +12 -4
- package/types/Capabilities.d.ts +2 -0
- package/types/Capital/FinancingOffers.d.ts +188 -0
- package/types/Capital/FinancingOffersResource.d.ts +97 -0
- package/types/Capital/FinancingSummary.d.ts +106 -0
- package/types/Capital/FinancingSummaryResource.d.ts +27 -0
- package/types/Capital/FinancingTransactions.d.ts +135 -0
- package/types/Capital/FinancingTransactionsResource.d.ts +68 -0
- package/types/Cards.d.ts +19 -0
- package/types/CashBalances.d.ts +5 -0
- package/types/Charges.d.ts +190 -0
- package/types/ChargesResource.d.ts +3855 -75
- package/types/Checkout/Sessions.d.ts +427 -2
- package/types/Checkout/SessionsResource.d.ts +682 -2
- package/types/ConfirmationTokens.d.ts +139 -0
- package/types/Coupons.d.ts +35 -0
- package/types/CouponsResource.d.ts +23 -0
- package/types/CreditNoteLineItems.d.ts +17 -0
- package/types/CreditNotes.d.ts +5 -0
- package/types/CreditNotesResource.d.ts +5 -0
- package/types/CustomerBalanceTransactions.d.ts +2 -0
- package/types/CustomerCashBalanceTransactions.d.ts +2 -0
- package/types/CustomerSessions.d.ts +46 -0
- package/types/CustomerSessionsResource.d.ts +47 -1
- package/types/Customers.d.ts +2 -0
- package/types/CustomersResource.d.ts +8 -0
- package/types/DelegatedCheckout/RequestedSessions.d.ts +419 -0
- package/types/DelegatedCheckout/RequestedSessionsResource.d.ts +599 -0
- package/types/Discounts.d.ts +20 -0
- package/types/Disputes.d.ts +40 -0
- package/types/DisputesResource.d.ts +11 -0
- package/types/Errors.d.ts +85 -0
- package/types/EventTypes.d.ts +630 -0
- package/types/Events.d.ts +96 -0
- package/types/ExternalAccountsResource.d.ts +304 -0
- package/types/FinancialConnections/AccountInferredBalances.d.ts +38 -0
- package/types/FinancialConnections/Accounts.d.ts +36 -1
- package/types/FinancialConnections/AccountsResource.d.ts +40 -3
- package/types/FinancialConnections/Institutions.d.ts +98 -0
- package/types/FinancialConnections/InstitutionsResource.d.ts +47 -0
- package/types/FinancialConnections/Sessions.d.ts +51 -1
- package/types/FinancialConnections/SessionsResource.d.ts +43 -1
- package/types/FxQuotes.d.ts +155 -0
- package/types/FxQuotesResource.d.ts +130 -0
- package/types/Identity/BlocklistEntries.d.ts +78 -0
- package/types/Identity/BlocklistEntriesResource.d.ts +146 -0
- package/types/Identity/VerificationReports.d.ts +10 -0
- package/types/Identity/VerificationReportsResource.d.ts +5 -0
- package/types/Identity/VerificationSessions.d.ts +5 -0
- package/types/Identity/VerificationSessionsResource.d.ts +7 -0
- package/types/InvoiceItems.d.ts +127 -2
- package/types/InvoiceItemsResource.d.ts +117 -6
- package/types/InvoiceLineItems.d.ts +171 -3
- package/types/Invoices.d.ts +216 -4
- package/types/InvoicesResource.d.ts +1787 -10
- package/types/Issuing/CardholdersResource.d.ts +2 -1
- package/types/Issuing/CreditUnderwritingRecords.d.ts +451 -0
- package/types/Issuing/CreditUnderwritingRecordsResource.d.ts +1032 -0
- package/types/Issuing/DisputeSettlementDetails.d.ts +85 -0
- package/types/Issuing/DisputeSettlementDetailsResource.d.ts +52 -0
- package/types/Issuing/FraudLiabilityDebits.d.ts +52 -0
- package/types/Issuing/FraudLiabilityDebitsResource.d.ts +52 -0
- package/types/Issuing/Programs.d.ts +42 -0
- package/types/Issuing/ProgramsResource.d.ts +96 -0
- package/types/Issuing/Settlements.d.ts +113 -0
- package/types/Issuing/Transactions.d.ts +5 -0
- package/types/Issuing/TransactionsResource.d.ts +5 -0
- package/types/LineItems.d.ts +49 -0
- package/types/Mandates.d.ts +135 -1
- package/types/MandatesResource.d.ts +31 -0
- package/types/Margins.d.ts +56 -0
- package/types/MarginsResource.d.ts +114 -0
- package/types/Orders.d.ts +1163 -0
- package/types/OrdersResource.d.ts +5505 -0
- package/types/PaymentAttemptRecords.d.ts +141 -0
- package/types/PaymentIntents.d.ts +779 -3
- package/types/PaymentIntentsResource.d.ts +19573 -6528
- package/types/PaymentLinks.d.ts +6 -0
- package/types/PaymentLinksResource.d.ts +12 -0
- package/types/PaymentMethodBalances.d.ts +63 -0
- package/types/PaymentMethodConfigurations.d.ts +216 -0
- package/types/PaymentMethodConfigurationsResource.d.ts +300 -0
- package/types/PaymentMethods.d.ts +144 -0
- package/types/PaymentMethodsResource.d.ts +199 -2
- package/types/PaymentRecords.d.ts +141 -0
- package/types/Persons.d.ts +30 -0
- package/types/Prices.d.ts +22 -0
- package/types/PricesResource.d.ts +22 -0
- package/types/Privacy/RedactionJobValidationErrors.d.ts +60 -0
- package/types/Privacy/RedactionJobs.d.ts +111 -0
- package/types/Privacy/RedactionJobsResource.d.ts +230 -0
- package/types/PromotionCodes.d.ts +5 -0
- package/types/PromotionCodesResource.d.ts +10 -0
- package/types/QuoteLines.d.ts +651 -0
- package/types/QuotePreviewInvoices.d.ts +1784 -0
- package/types/QuotePreviewSubscriptionSchedules.d.ts +1034 -0
- package/types/Quotes.d.ts +876 -1
- package/types/QuotesResource.d.ts +3255 -292
- package/types/Radar/AccountEvaluations.d.ts +88 -0
- package/types/Radar/AccountEvaluationsResource.d.ts +148 -0
- package/types/Refunds.d.ts +14 -0
- package/types/SetupAttempts.d.ts +51 -1
- package/types/SetupIntents.d.ts +239 -2
- package/types/SetupIntentsResource.d.ts +1044 -4
- package/types/Sources.d.ts +29 -0
- package/types/SubscriptionItems.d.ts +39 -0
- package/types/SubscriptionItemsResource.d.ts +143 -0
- package/types/SubscriptionSchedules.d.ts +329 -0
- package/types/SubscriptionSchedulesResource.d.ts +1525 -59
- package/types/Subscriptions.d.ts +284 -1
- package/types/SubscriptionsResource.d.ts +779 -8
- package/types/Tax/Forms.d.ts +220 -0
- package/types/Tax/FormsResource.d.ts +107 -0
- package/types/TaxIds.d.ts +10 -0
- package/types/TaxIdsResource.d.ts +10 -0
- package/types/Terminal/Configurations.d.ts +9 -0
- package/types/Terminal/ConfigurationsResource.d.ts +28 -0
- package/types/Terminal/ReaderCollectedData.d.ts +51 -0
- package/types/Terminal/ReaderCollectedDataResource.d.ts +29 -0
- package/types/Terminal/Readers.d.ts +20 -0
- package/types/TestHelpers/Capital/FinancingOffersResource.d.ts +130 -0
- package/types/TestHelpers/ConfirmationTokensResource.d.ts +126 -0
- package/types/TestHelpers/Treasury/ReceivedCreditsResource.d.ts +26 -0
- package/types/TestHelpers/Treasury/ReceivedDebitsResource.d.ts +26 -0
- package/types/TokensResource.d.ts +44 -0
- package/types/Transfers.d.ts +9 -0
- package/types/TransfersResource.d.ts +7 -0
- package/types/TransitBalances.d.ts +40 -0
- package/types/Treasury/FinancialAccountFeatures.d.ts +7 -0
- package/types/Treasury/FinancialAccounts.d.ts +5 -0
- package/types/Treasury/FinancialAccountsResource.d.ts +37 -0
- package/types/Treasury/OutboundTransfers.d.ts +26 -0
- package/types/Treasury/OutboundTransfersResource.d.ts +26 -0
- package/types/Treasury/ReceivedCredits.d.ts +26 -0
- package/types/Treasury/ReceivedDebits.d.ts +31 -0
- package/types/V2/Billing/BillSettingVersions.d.ts +97 -0
- package/types/V2/Billing/BillSettings/VersionsResource.d.ts +58 -0
- package/types/V2/Billing/BillSettings.d.ts +120 -0
- package/types/V2/Billing/BillSettingsResource.d.ts +241 -0
- package/types/V2/Billing/Cadences.d.ts +735 -0
- package/types/V2/Billing/CadencesResource.d.ts +516 -0
- package/types/V2/Billing/CollectionSettingVersions.d.ts +318 -0
- package/types/V2/Billing/CollectionSettings/VersionsResource.d.ts +62 -0
- package/types/V2/Billing/CollectionSettings.d.ts +341 -0
- package/types/V2/Billing/CollectionSettingsResource.d.ts +683 -0
- package/types/V2/Billing/CustomPricingUnits.d.ts +56 -0
- package/types/V2/Billing/CustomPricingUnitsResource.d.ts +122 -0
- package/types/V2/Billing/IntentActions.d.ts +459 -0
- package/types/V2/Billing/Intents/ActionsResource.d.ts +58 -0
- package/types/V2/Billing/Intents.d.ts +117 -0
- package/types/V2/Billing/IntentsResource.d.ts +575 -0
- package/types/V2/Billing/LicenseFeeSubscriptions.d.ts +64 -0
- package/types/V2/Billing/LicenseFeeSubscriptionsResource.d.ts +28 -0
- package/types/V2/Billing/LicenseFeeVersions.d.ts +106 -0
- package/types/V2/Billing/LicenseFees/VersionsResource.d.ts +58 -0
- package/types/V2/Billing/LicenseFees.d.ts +164 -0
- package/types/V2/Billing/LicenseFeesResource.d.ts +290 -0
- package/types/V2/Billing/LicensedItems.d.ts +73 -0
- package/types/V2/Billing/LicensedItemsResource.d.ts +157 -0
- package/types/V2/Billing/MeteredItems.d.ts +101 -0
- package/types/V2/Billing/MeteredItemsResource.d.ts +189 -0
- package/types/V2/Billing/PricingPlanComponents.d.ts +109 -0
- package/types/V2/Billing/PricingPlanSubscriptionComponents.d.ts +57 -0
- package/types/V2/Billing/PricingPlanSubscriptions/ComponentsResource.d.ts +40 -0
- package/types/V2/Billing/PricingPlanSubscriptions.d.ts +144 -0
- package/types/V2/Billing/PricingPlanSubscriptionsResource.d.ts +120 -0
- package/types/V2/Billing/PricingPlanVersions.d.ts +49 -0
- package/types/V2/Billing/PricingPlans/ComponentsResource.d.ts +197 -0
- package/types/V2/Billing/PricingPlans/VersionsResource.d.ts +58 -0
- package/types/V2/Billing/PricingPlans.d.ts +84 -0
- package/types/V2/Billing/PricingPlansResource.d.ts +151 -0
- package/types/V2/Billing/Profiles.d.ts +70 -0
- package/types/V2/Billing/ProfilesResource.d.ts +150 -0
- package/types/V2/Billing/RateCardRates.d.ts +144 -0
- package/types/V2/Billing/RateCardSubscriptions.d.ts +144 -0
- package/types/V2/Billing/RateCardSubscriptionsResource.d.ts +157 -0
- package/types/V2/Billing/RateCardVersions.d.ts +39 -0
- package/types/V2/Billing/RateCards/RatesResource.d.ts +203 -0
- package/types/V2/Billing/RateCards/VersionsResource.d.ts +58 -0
- package/types/V2/Billing/RateCards.d.ts +98 -0
- package/types/V2/Billing/RateCardsResource.d.ts +162 -0
- package/types/V2/Billing/ServiceActions.d.ts +298 -0
- package/types/V2/Billing/ServiceActionsResource.d.ts +394 -0
- package/types/V2/Core/AccountLinks.d.ts +168 -0
- package/types/V2/Core/AccountLinksResource.d.ts +152 -0
- package/types/V2/Core/AccountPersonTokens.d.ts +44 -0
- package/types/V2/Core/AccountPersons.d.ts +616 -0
- package/types/V2/Core/AccountTokens.d.ts +44 -0
- package/types/V2/Core/AccountTokensResource.d.ts +1315 -0
- package/types/V2/Core/Accounts/PersonTokensResource.d.ts +509 -0
- package/types/V2/Core/Accounts/PersonsResource.d.ts +1165 -0
- package/types/V2/Core/Accounts.d.ts +8018 -0
- package/types/V2/Core/AccountsResource.d.ts +6997 -0
- package/types/V2/Core/ClaimableSandboxes.d.ts +132 -0
- package/types/V2/Core/ClaimableSandboxesResource.d.ts +74 -0
- package/types/V2/Core/EventTypes.d.ts +4715 -9
- package/types/V2/Core/Events.d.ts +9 -0
- package/types/V2/Core/Vault/GbBankAccounts.d.ts +160 -0
- package/types/V2/Core/Vault/GbBankAccountsResource.d.ts +194 -0
- package/types/V2/Core/Vault/UsBankAccounts.d.ts +116 -0
- package/types/V2/Core/Vault/UsBankAccountsResource.d.ts +198 -0
- package/types/V2/FinancialAddressCreditSimulations.d.ts +27 -0
- package/types/V2/FinancialAddressGeneratedMicrodeposits.d.ts +46 -0
- package/types/V2/MoneyManagement/Adjustments.d.ts +122 -0
- package/types/V2/MoneyManagement/AdjustmentsResource.d.ts +83 -0
- package/types/V2/MoneyManagement/CurrencyConversions.d.ts +98 -0
- package/types/V2/MoneyManagement/CurrencyConversionsResource.d.ts +141 -0
- package/types/V2/MoneyManagement/FinancialAccounts.d.ts +186 -0
- package/types/V2/MoneyManagement/FinancialAccountsResource.d.ts +172 -0
- package/types/V2/MoneyManagement/FinancialAddresses.d.ts +178 -0
- package/types/V2/MoneyManagement/FinancialAddressesResource.d.ts +126 -0
- package/types/V2/MoneyManagement/InboundTransfers.d.ts +250 -0
- package/types/V2/MoneyManagement/InboundTransfersResource.d.ts +156 -0
- package/types/V2/MoneyManagement/OutboundPaymentQuotes.d.ts +222 -0
- package/types/V2/MoneyManagement/OutboundPaymentQuotesResource.d.ts +127 -0
- package/types/V2/MoneyManagement/OutboundPayments.d.ts +323 -0
- package/types/V2/MoneyManagement/OutboundPaymentsResource.d.ts +259 -0
- package/types/V2/MoneyManagement/OutboundSetupIntents.d.ts +97 -0
- package/types/V2/MoneyManagement/OutboundSetupIntentsResource.d.ts +330 -0
- package/types/V2/MoneyManagement/OutboundTransfers.d.ts +296 -0
- package/types/V2/MoneyManagement/OutboundTransfersResource.d.ts +225 -0
- package/types/V2/MoneyManagement/PayoutMethods.d.ts +201 -0
- package/types/V2/MoneyManagement/PayoutMethodsBankAccountSpec.d.ts +93 -0
- package/types/V2/MoneyManagement/PayoutMethodsBankAccountSpecResource.d.ts +41 -0
- package/types/V2/MoneyManagement/PayoutMethodsResource.d.ts +113 -0
- package/types/V2/MoneyManagement/ReceivedCredits.d.ts +331 -0
- package/types/V2/MoneyManagement/ReceivedCreditsResource.d.ts +78 -0
- package/types/V2/MoneyManagement/ReceivedDebits.d.ts +210 -0
- package/types/V2/MoneyManagement/ReceivedDebitsResource.d.ts +48 -0
- package/types/V2/MoneyManagement/RecipientVerifications.d.ts +112 -0
- package/types/V2/MoneyManagement/RecipientVerificationsResource.d.ts +77 -0
- package/types/V2/MoneyManagement/TransactionEntries.d.ts +200 -0
- package/types/V2/MoneyManagement/TransactionEntriesResource.d.ts +82 -0
- package/types/V2/MoneyManagement/Transactions.d.ts +227 -0
- package/types/V2/MoneyManagement/TransactionsResource.d.ts +83 -0
- package/types/V2/Payments/OffSessionPayments.d.ts +249 -0
- package/types/V2/Payments/OffSessionPaymentsResource.d.ts +306 -0
- package/types/V2/Reporting/ReportRuns.d.ts +154 -0
- package/types/V2/Reporting/ReportRunsResource.d.ts +75 -0
- package/types/V2/Reporting/Reports.d.ts +120 -0
- package/types/V2/Reporting/ReportsResource.d.ts +30 -0
- package/types/V2/TestHelpers/FinancialAddressesResource.d.ts +85 -0
- package/types/V2/TestHelpers/MoneyManagementResource.d.ts +49 -0
- package/types/WebhookEndpointsResource.d.ts +76 -0
- package/types/Webhooks.d.ts +2 -0
- package/types/apiVersion.d.ts +1 -2
- package/types/index.d.ts +241 -0
- package/types/lib.d.ts +10 -0
|
@@ -5,12 +5,272 @@ declare module 'stripe' {
|
|
|
5
5
|
export type Event =
|
|
6
6
|
| Stripe.Events.V1BillingMeterErrorReportTriggeredEvent
|
|
7
7
|
| Stripe.Events.V1BillingMeterNoMeterFoundEvent
|
|
8
|
-
| Stripe.Events.
|
|
8
|
+
| Stripe.Events.V2BillingCadenceBilledEvent
|
|
9
|
+
| Stripe.Events.V2BillingCadenceCanceledEvent
|
|
10
|
+
| Stripe.Events.V2BillingCadenceCreatedEvent
|
|
11
|
+
| Stripe.Events.V2BillingLicenseFeeCreatedEvent
|
|
12
|
+
| Stripe.Events.V2BillingLicenseFeeUpdatedEvent
|
|
13
|
+
| Stripe.Events.V2BillingLicenseFeeVersionCreatedEvent
|
|
14
|
+
| Stripe.Events.V2BillingLicensedItemCreatedEvent
|
|
15
|
+
| Stripe.Events.V2BillingLicensedItemUpdatedEvent
|
|
16
|
+
| Stripe.Events.V2BillingMeteredItemCreatedEvent
|
|
17
|
+
| Stripe.Events.V2BillingMeteredItemUpdatedEvent
|
|
18
|
+
| Stripe.Events.V2BillingPricingPlanCreatedEvent
|
|
19
|
+
| Stripe.Events.V2BillingPricingPlanUpdatedEvent
|
|
20
|
+
| Stripe.Events.V2BillingPricingPlanComponentCreatedEvent
|
|
21
|
+
| Stripe.Events.V2BillingPricingPlanComponentUpdatedEvent
|
|
22
|
+
| Stripe.Events.V2BillingPricingPlanSubscriptionCollectionAwaitingCustomerActionEvent
|
|
23
|
+
| Stripe.Events.V2BillingPricingPlanSubscriptionCollectionCurrentEvent
|
|
24
|
+
| Stripe.Events.V2BillingPricingPlanSubscriptionCollectionPastDueEvent
|
|
25
|
+
| Stripe.Events.V2BillingPricingPlanSubscriptionCollectionPausedEvent
|
|
26
|
+
| Stripe.Events.V2BillingPricingPlanSubscriptionCollectionUnpaidEvent
|
|
27
|
+
| Stripe.Events.V2BillingPricingPlanSubscriptionServicingActivatedEvent
|
|
28
|
+
| Stripe.Events.V2BillingPricingPlanSubscriptionServicingCanceledEvent
|
|
29
|
+
| Stripe.Events.V2BillingPricingPlanSubscriptionServicingPausedEvent
|
|
30
|
+
| Stripe.Events.V2BillingPricingPlanVersionCreatedEvent
|
|
31
|
+
| Stripe.Events.V2BillingRateCardCreatedEvent
|
|
32
|
+
| Stripe.Events.V2BillingRateCardUpdatedEvent
|
|
33
|
+
| Stripe.Events.V2BillingRateCardRateCreatedEvent
|
|
34
|
+
| Stripe.Events.V2BillingRateCardSubscriptionActivatedEvent
|
|
35
|
+
| Stripe.Events.V2BillingRateCardSubscriptionCanceledEvent
|
|
36
|
+
| Stripe.Events.V2BillingRateCardSubscriptionCollectionAwaitingCustomerActionEvent
|
|
37
|
+
| Stripe.Events.V2BillingRateCardSubscriptionCollectionCurrentEvent
|
|
38
|
+
| Stripe.Events.V2BillingRateCardSubscriptionCollectionPastDueEvent
|
|
39
|
+
| Stripe.Events.V2BillingRateCardSubscriptionCollectionPausedEvent
|
|
40
|
+
| Stripe.Events.V2BillingRateCardSubscriptionCollectionUnpaidEvent
|
|
41
|
+
| Stripe.Events.V2BillingRateCardSubscriptionServicingActivatedEvent
|
|
42
|
+
| Stripe.Events.V2BillingRateCardSubscriptionServicingCanceledEvent
|
|
43
|
+
| Stripe.Events.V2BillingRateCardSubscriptionServicingPausedEvent
|
|
44
|
+
| Stripe.Events.V2BillingRateCardVersionCreatedEvent
|
|
45
|
+
| Stripe.Events.V2CoreAccountClosedEvent
|
|
46
|
+
| Stripe.Events.V2CoreAccountCreatedEvent
|
|
47
|
+
| Stripe.Events.V2CoreAccountUpdatedEvent
|
|
48
|
+
| Stripe.Events.V2CoreAccountIncludingConfigurationCardCreatorCapabilityStatusUpdatedEvent
|
|
49
|
+
| Stripe.Events.V2CoreAccountIncludingConfigurationCardCreatorUpdatedEvent
|
|
50
|
+
| Stripe.Events.V2CoreAccountIncludingConfigurationCustomerCapabilityStatusUpdatedEvent
|
|
51
|
+
| Stripe.Events.V2CoreAccountIncludingConfigurationCustomerUpdatedEvent
|
|
52
|
+
| Stripe.Events.V2CoreAccountIncludingConfigurationMerchantCapabilityStatusUpdatedEvent
|
|
53
|
+
| Stripe.Events.V2CoreAccountIncludingConfigurationMerchantUpdatedEvent
|
|
54
|
+
| Stripe.Events.V2CoreAccountIncludingConfigurationRecipientCapabilityStatusUpdatedEvent
|
|
55
|
+
| Stripe.Events.V2CoreAccountIncludingConfigurationRecipientUpdatedEvent
|
|
56
|
+
| Stripe.Events.V2CoreAccountIncludingConfigurationStorerCapabilityStatusUpdatedEvent
|
|
57
|
+
| Stripe.Events.V2CoreAccountIncludingConfigurationStorerUpdatedEvent
|
|
58
|
+
| Stripe.Events.V2CoreAccountIncludingDefaultsUpdatedEvent
|
|
59
|
+
| Stripe.Events.V2CoreAccountIncludingIdentityUpdatedEvent
|
|
60
|
+
| Stripe.Events.V2CoreAccountIncludingRequirementsUpdatedEvent
|
|
61
|
+
| Stripe.Events.V2CoreAccountLinkReturnedEvent
|
|
62
|
+
| Stripe.Events.V2CoreAccountPersonCreatedEvent
|
|
63
|
+
| Stripe.Events.V2CoreAccountPersonDeletedEvent
|
|
64
|
+
| Stripe.Events.V2CoreAccountPersonUpdatedEvent
|
|
65
|
+
| Stripe.Events.V2CoreClaimableSandboxClaimedEvent
|
|
66
|
+
| Stripe.Events.V2CoreClaimableSandboxCreatedEvent
|
|
67
|
+
| Stripe.Events.V2CoreClaimableSandboxExpiredEvent
|
|
68
|
+
| Stripe.Events.V2CoreClaimableSandboxExpiringEvent
|
|
69
|
+
| Stripe.Events.V2CoreClaimableSandboxSandboxDetailsOwnerAccountUpdatedEvent
|
|
70
|
+
| Stripe.Events.V2CoreEventDestinationPingEvent
|
|
71
|
+
| Stripe.Events.V2CoreHealthApiErrorFiringEvent
|
|
72
|
+
| Stripe.Events.V2CoreHealthApiErrorResolvedEvent
|
|
73
|
+
| Stripe.Events.V2CoreHealthApiLatencyFiringEvent
|
|
74
|
+
| Stripe.Events.V2CoreHealthApiLatencyResolvedEvent
|
|
75
|
+
| Stripe.Events.V2CoreHealthAuthorizationRateDropFiringEvent
|
|
76
|
+
| Stripe.Events.V2CoreHealthAuthorizationRateDropResolvedEvent
|
|
77
|
+
| Stripe.Events.V2CoreHealthEventGenerationFailureResolvedEvent
|
|
78
|
+
| Stripe.Events.V2CoreHealthFraudRateIncreasedEvent
|
|
79
|
+
| Stripe.Events.V2CoreHealthIssuingAuthorizationRequestErrorsFiringEvent
|
|
80
|
+
| Stripe.Events.V2CoreHealthIssuingAuthorizationRequestErrorsResolvedEvent
|
|
81
|
+
| Stripe.Events.V2CoreHealthIssuingAuthorizationRequestTimeoutFiringEvent
|
|
82
|
+
| Stripe.Events.V2CoreHealthIssuingAuthorizationRequestTimeoutResolvedEvent
|
|
83
|
+
| Stripe.Events.V2CoreHealthPaymentMethodErrorFiringEvent
|
|
84
|
+
| Stripe.Events.V2CoreHealthPaymentMethodErrorResolvedEvent
|
|
85
|
+
| Stripe.Events.V2CoreHealthTrafficVolumeDropFiringEvent
|
|
86
|
+
| Stripe.Events.V2CoreHealthTrafficVolumeDropResolvedEvent
|
|
87
|
+
| Stripe.Events.V2CoreHealthWebhookLatencyFiringEvent
|
|
88
|
+
| Stripe.Events.V2CoreHealthWebhookLatencyResolvedEvent
|
|
89
|
+
| Stripe.Events.V2MoneyManagementAdjustmentCreatedEvent
|
|
90
|
+
| Stripe.Events.V2MoneyManagementFinancialAccountCreatedEvent
|
|
91
|
+
| Stripe.Events.V2MoneyManagementFinancialAccountUpdatedEvent
|
|
92
|
+
| Stripe.Events.V2MoneyManagementFinancialAddressActivatedEvent
|
|
93
|
+
| Stripe.Events.V2MoneyManagementFinancialAddressFailedEvent
|
|
94
|
+
| Stripe.Events.V2MoneyManagementInboundTransferAvailableEvent
|
|
95
|
+
| Stripe.Events.V2MoneyManagementInboundTransferBankDebitFailedEvent
|
|
96
|
+
| Stripe.Events.V2MoneyManagementInboundTransferBankDebitProcessingEvent
|
|
97
|
+
| Stripe.Events.V2MoneyManagementInboundTransferBankDebitQueuedEvent
|
|
98
|
+
| Stripe.Events.V2MoneyManagementInboundTransferBankDebitReturnedEvent
|
|
99
|
+
| Stripe.Events.V2MoneyManagementInboundTransferBankDebitSucceededEvent
|
|
100
|
+
| Stripe.Events.V2MoneyManagementOutboundPaymentCanceledEvent
|
|
101
|
+
| Stripe.Events.V2MoneyManagementOutboundPaymentCreatedEvent
|
|
102
|
+
| Stripe.Events.V2MoneyManagementOutboundPaymentFailedEvent
|
|
103
|
+
| Stripe.Events.V2MoneyManagementOutboundPaymentPostedEvent
|
|
104
|
+
| Stripe.Events.V2MoneyManagementOutboundPaymentReturnedEvent
|
|
105
|
+
| Stripe.Events.V2MoneyManagementOutboundPaymentUpdatedEvent
|
|
106
|
+
| Stripe.Events.V2MoneyManagementOutboundTransferCanceledEvent
|
|
107
|
+
| Stripe.Events.V2MoneyManagementOutboundTransferCreatedEvent
|
|
108
|
+
| Stripe.Events.V2MoneyManagementOutboundTransferFailedEvent
|
|
109
|
+
| Stripe.Events.V2MoneyManagementOutboundTransferPostedEvent
|
|
110
|
+
| Stripe.Events.V2MoneyManagementOutboundTransferReturnedEvent
|
|
111
|
+
| Stripe.Events.V2MoneyManagementOutboundTransferUpdatedEvent
|
|
112
|
+
| Stripe.Events.V2MoneyManagementPayoutMethodUpdatedEvent
|
|
113
|
+
| Stripe.Events.V2MoneyManagementReceivedCreditAvailableEvent
|
|
114
|
+
| Stripe.Events.V2MoneyManagementReceivedCreditFailedEvent
|
|
115
|
+
| Stripe.Events.V2MoneyManagementReceivedCreditReturnedEvent
|
|
116
|
+
| Stripe.Events.V2MoneyManagementReceivedCreditSucceededEvent
|
|
117
|
+
| Stripe.Events.V2MoneyManagementReceivedDebitCanceledEvent
|
|
118
|
+
| Stripe.Events.V2MoneyManagementReceivedDebitFailedEvent
|
|
119
|
+
| Stripe.Events.V2MoneyManagementReceivedDebitPendingEvent
|
|
120
|
+
| Stripe.Events.V2MoneyManagementReceivedDebitSucceededEvent
|
|
121
|
+
| Stripe.Events.V2MoneyManagementReceivedDebitUpdatedEvent
|
|
122
|
+
| Stripe.Events.V2MoneyManagementRecipientVerificationCreatedEvent
|
|
123
|
+
| Stripe.Events.V2MoneyManagementRecipientVerificationUpdatedEvent
|
|
124
|
+
| Stripe.Events.V2MoneyManagementTransactionCreatedEvent
|
|
125
|
+
| Stripe.Events.V2MoneyManagementTransactionUpdatedEvent
|
|
126
|
+
| Stripe.Events.V2PaymentsOffSessionPaymentAttemptFailedEvent
|
|
127
|
+
| Stripe.Events.V2PaymentsOffSessionPaymentAttemptStartedEvent
|
|
128
|
+
| Stripe.Events.V2PaymentsOffSessionPaymentAuthorizationAttemptFailedEvent
|
|
129
|
+
| Stripe.Events.V2PaymentsOffSessionPaymentAuthorizationAttemptStartedEvent
|
|
130
|
+
| Stripe.Events.V2PaymentsOffSessionPaymentCanceledEvent
|
|
131
|
+
| Stripe.Events.V2PaymentsOffSessionPaymentCreatedEvent
|
|
132
|
+
| Stripe.Events.V2PaymentsOffSessionPaymentFailedEvent
|
|
133
|
+
| Stripe.Events.V2PaymentsOffSessionPaymentRequiresCaptureEvent
|
|
134
|
+
| Stripe.Events.V2PaymentsOffSessionPaymentSucceededEvent
|
|
135
|
+
| Stripe.Events.V2ReportingReportRunCreatedEvent
|
|
136
|
+
| Stripe.Events.V2ReportingReportRunFailedEvent
|
|
137
|
+
| Stripe.Events.V2ReportingReportRunSucceededEvent
|
|
138
|
+
| Stripe.Events.V2ReportingReportRunUpdatedEvent;
|
|
9
139
|
|
|
10
140
|
export type EventNotification =
|
|
11
141
|
| Stripe.Events.V1BillingMeterErrorReportTriggeredEventNotification
|
|
12
142
|
| Stripe.Events.V1BillingMeterNoMeterFoundEventNotification
|
|
13
|
-
| Stripe.Events.
|
|
143
|
+
| Stripe.Events.V2BillingCadenceBilledEventNotification
|
|
144
|
+
| Stripe.Events.V2BillingCadenceCanceledEventNotification
|
|
145
|
+
| Stripe.Events.V2BillingCadenceCreatedEventNotification
|
|
146
|
+
| Stripe.Events.V2BillingLicenseFeeCreatedEventNotification
|
|
147
|
+
| Stripe.Events.V2BillingLicenseFeeUpdatedEventNotification
|
|
148
|
+
| Stripe.Events.V2BillingLicenseFeeVersionCreatedEventNotification
|
|
149
|
+
| Stripe.Events.V2BillingLicensedItemCreatedEventNotification
|
|
150
|
+
| Stripe.Events.V2BillingLicensedItemUpdatedEventNotification
|
|
151
|
+
| Stripe.Events.V2BillingMeteredItemCreatedEventNotification
|
|
152
|
+
| Stripe.Events.V2BillingMeteredItemUpdatedEventNotification
|
|
153
|
+
| Stripe.Events.V2BillingPricingPlanCreatedEventNotification
|
|
154
|
+
| Stripe.Events.V2BillingPricingPlanUpdatedEventNotification
|
|
155
|
+
| Stripe.Events.V2BillingPricingPlanComponentCreatedEventNotification
|
|
156
|
+
| Stripe.Events.V2BillingPricingPlanComponentUpdatedEventNotification
|
|
157
|
+
| Stripe.Events.V2BillingPricingPlanSubscriptionCollectionAwaitingCustomerActionEventNotification
|
|
158
|
+
| Stripe.Events.V2BillingPricingPlanSubscriptionCollectionCurrentEventNotification
|
|
159
|
+
| Stripe.Events.V2BillingPricingPlanSubscriptionCollectionPastDueEventNotification
|
|
160
|
+
| Stripe.Events.V2BillingPricingPlanSubscriptionCollectionPausedEventNotification
|
|
161
|
+
| Stripe.Events.V2BillingPricingPlanSubscriptionCollectionUnpaidEventNotification
|
|
162
|
+
| Stripe.Events.V2BillingPricingPlanSubscriptionServicingActivatedEventNotification
|
|
163
|
+
| Stripe.Events.V2BillingPricingPlanSubscriptionServicingCanceledEventNotification
|
|
164
|
+
| Stripe.Events.V2BillingPricingPlanSubscriptionServicingPausedEventNotification
|
|
165
|
+
| Stripe.Events.V2BillingPricingPlanVersionCreatedEventNotification
|
|
166
|
+
| Stripe.Events.V2BillingRateCardCreatedEventNotification
|
|
167
|
+
| Stripe.Events.V2BillingRateCardUpdatedEventNotification
|
|
168
|
+
| Stripe.Events.V2BillingRateCardRateCreatedEventNotification
|
|
169
|
+
| Stripe.Events.V2BillingRateCardSubscriptionActivatedEventNotification
|
|
170
|
+
| Stripe.Events.V2BillingRateCardSubscriptionCanceledEventNotification
|
|
171
|
+
| Stripe.Events.V2BillingRateCardSubscriptionCollectionAwaitingCustomerActionEventNotification
|
|
172
|
+
| Stripe.Events.V2BillingRateCardSubscriptionCollectionCurrentEventNotification
|
|
173
|
+
| Stripe.Events.V2BillingRateCardSubscriptionCollectionPastDueEventNotification
|
|
174
|
+
| Stripe.Events.V2BillingRateCardSubscriptionCollectionPausedEventNotification
|
|
175
|
+
| Stripe.Events.V2BillingRateCardSubscriptionCollectionUnpaidEventNotification
|
|
176
|
+
| Stripe.Events.V2BillingRateCardSubscriptionServicingActivatedEventNotification
|
|
177
|
+
| Stripe.Events.V2BillingRateCardSubscriptionServicingCanceledEventNotification
|
|
178
|
+
| Stripe.Events.V2BillingRateCardSubscriptionServicingPausedEventNotification
|
|
179
|
+
| Stripe.Events.V2BillingRateCardVersionCreatedEventNotification
|
|
180
|
+
| Stripe.Events.V2CoreAccountClosedEventNotification
|
|
181
|
+
| Stripe.Events.V2CoreAccountCreatedEventNotification
|
|
182
|
+
| Stripe.Events.V2CoreAccountUpdatedEventNotification
|
|
183
|
+
| Stripe.Events.V2CoreAccountIncludingConfigurationCardCreatorCapabilityStatusUpdatedEventNotification
|
|
184
|
+
| Stripe.Events.V2CoreAccountIncludingConfigurationCardCreatorUpdatedEventNotification
|
|
185
|
+
| Stripe.Events.V2CoreAccountIncludingConfigurationCustomerCapabilityStatusUpdatedEventNotification
|
|
186
|
+
| Stripe.Events.V2CoreAccountIncludingConfigurationCustomerUpdatedEventNotification
|
|
187
|
+
| Stripe.Events.V2CoreAccountIncludingConfigurationMerchantCapabilityStatusUpdatedEventNotification
|
|
188
|
+
| Stripe.Events.V2CoreAccountIncludingConfigurationMerchantUpdatedEventNotification
|
|
189
|
+
| Stripe.Events.V2CoreAccountIncludingConfigurationRecipientCapabilityStatusUpdatedEventNotification
|
|
190
|
+
| Stripe.Events.V2CoreAccountIncludingConfigurationRecipientUpdatedEventNotification
|
|
191
|
+
| Stripe.Events.V2CoreAccountIncludingConfigurationStorerCapabilityStatusUpdatedEventNotification
|
|
192
|
+
| Stripe.Events.V2CoreAccountIncludingConfigurationStorerUpdatedEventNotification
|
|
193
|
+
| Stripe.Events.V2CoreAccountIncludingDefaultsUpdatedEventNotification
|
|
194
|
+
| Stripe.Events.V2CoreAccountIncludingIdentityUpdatedEventNotification
|
|
195
|
+
| Stripe.Events.V2CoreAccountIncludingRequirementsUpdatedEventNotification
|
|
196
|
+
| Stripe.Events.V2CoreAccountLinkReturnedEventNotification
|
|
197
|
+
| Stripe.Events.V2CoreAccountPersonCreatedEventNotification
|
|
198
|
+
| Stripe.Events.V2CoreAccountPersonDeletedEventNotification
|
|
199
|
+
| Stripe.Events.V2CoreAccountPersonUpdatedEventNotification
|
|
200
|
+
| Stripe.Events.V2CoreClaimableSandboxClaimedEventNotification
|
|
201
|
+
| Stripe.Events.V2CoreClaimableSandboxCreatedEventNotification
|
|
202
|
+
| Stripe.Events.V2CoreClaimableSandboxExpiredEventNotification
|
|
203
|
+
| Stripe.Events.V2CoreClaimableSandboxExpiringEventNotification
|
|
204
|
+
| Stripe.Events.V2CoreClaimableSandboxSandboxDetailsOwnerAccountUpdatedEventNotification
|
|
205
|
+
| Stripe.Events.V2CoreEventDestinationPingEventNotification
|
|
206
|
+
| Stripe.Events.V2CoreHealthApiErrorFiringEventNotification
|
|
207
|
+
| Stripe.Events.V2CoreHealthApiErrorResolvedEventNotification
|
|
208
|
+
| Stripe.Events.V2CoreHealthApiLatencyFiringEventNotification
|
|
209
|
+
| Stripe.Events.V2CoreHealthApiLatencyResolvedEventNotification
|
|
210
|
+
| Stripe.Events.V2CoreHealthAuthorizationRateDropFiringEventNotification
|
|
211
|
+
| Stripe.Events.V2CoreHealthAuthorizationRateDropResolvedEventNotification
|
|
212
|
+
| Stripe.Events.V2CoreHealthEventGenerationFailureResolvedEventNotification
|
|
213
|
+
| Stripe.Events.V2CoreHealthFraudRateIncreasedEventNotification
|
|
214
|
+
| Stripe.Events.V2CoreHealthIssuingAuthorizationRequestErrorsFiringEventNotification
|
|
215
|
+
| Stripe.Events.V2CoreHealthIssuingAuthorizationRequestErrorsResolvedEventNotification
|
|
216
|
+
| Stripe.Events.V2CoreHealthIssuingAuthorizationRequestTimeoutFiringEventNotification
|
|
217
|
+
| Stripe.Events.V2CoreHealthIssuingAuthorizationRequestTimeoutResolvedEventNotification
|
|
218
|
+
| Stripe.Events.V2CoreHealthPaymentMethodErrorFiringEventNotification
|
|
219
|
+
| Stripe.Events.V2CoreHealthPaymentMethodErrorResolvedEventNotification
|
|
220
|
+
| Stripe.Events.V2CoreHealthTrafficVolumeDropFiringEventNotification
|
|
221
|
+
| Stripe.Events.V2CoreHealthTrafficVolumeDropResolvedEventNotification
|
|
222
|
+
| Stripe.Events.V2CoreHealthWebhookLatencyFiringEventNotification
|
|
223
|
+
| Stripe.Events.V2CoreHealthWebhookLatencyResolvedEventNotification
|
|
224
|
+
| Stripe.Events.V2MoneyManagementAdjustmentCreatedEventNotification
|
|
225
|
+
| Stripe.Events.V2MoneyManagementFinancialAccountCreatedEventNotification
|
|
226
|
+
| Stripe.Events.V2MoneyManagementFinancialAccountUpdatedEventNotification
|
|
227
|
+
| Stripe.Events.V2MoneyManagementFinancialAddressActivatedEventNotification
|
|
228
|
+
| Stripe.Events.V2MoneyManagementFinancialAddressFailedEventNotification
|
|
229
|
+
| Stripe.Events.V2MoneyManagementInboundTransferAvailableEventNotification
|
|
230
|
+
| Stripe.Events.V2MoneyManagementInboundTransferBankDebitFailedEventNotification
|
|
231
|
+
| Stripe.Events.V2MoneyManagementInboundTransferBankDebitProcessingEventNotification
|
|
232
|
+
| Stripe.Events.V2MoneyManagementInboundTransferBankDebitQueuedEventNotification
|
|
233
|
+
| Stripe.Events.V2MoneyManagementInboundTransferBankDebitReturnedEventNotification
|
|
234
|
+
| Stripe.Events.V2MoneyManagementInboundTransferBankDebitSucceededEventNotification
|
|
235
|
+
| Stripe.Events.V2MoneyManagementOutboundPaymentCanceledEventNotification
|
|
236
|
+
| Stripe.Events.V2MoneyManagementOutboundPaymentCreatedEventNotification
|
|
237
|
+
| Stripe.Events.V2MoneyManagementOutboundPaymentFailedEventNotification
|
|
238
|
+
| Stripe.Events.V2MoneyManagementOutboundPaymentPostedEventNotification
|
|
239
|
+
| Stripe.Events.V2MoneyManagementOutboundPaymentReturnedEventNotification
|
|
240
|
+
| Stripe.Events.V2MoneyManagementOutboundPaymentUpdatedEventNotification
|
|
241
|
+
| Stripe.Events.V2MoneyManagementOutboundTransferCanceledEventNotification
|
|
242
|
+
| Stripe.Events.V2MoneyManagementOutboundTransferCreatedEventNotification
|
|
243
|
+
| Stripe.Events.V2MoneyManagementOutboundTransferFailedEventNotification
|
|
244
|
+
| Stripe.Events.V2MoneyManagementOutboundTransferPostedEventNotification
|
|
245
|
+
| Stripe.Events.V2MoneyManagementOutboundTransferReturnedEventNotification
|
|
246
|
+
| Stripe.Events.V2MoneyManagementOutboundTransferUpdatedEventNotification
|
|
247
|
+
| Stripe.Events.V2MoneyManagementPayoutMethodUpdatedEventNotification
|
|
248
|
+
| Stripe.Events.V2MoneyManagementReceivedCreditAvailableEventNotification
|
|
249
|
+
| Stripe.Events.V2MoneyManagementReceivedCreditFailedEventNotification
|
|
250
|
+
| Stripe.Events.V2MoneyManagementReceivedCreditReturnedEventNotification
|
|
251
|
+
| Stripe.Events.V2MoneyManagementReceivedCreditSucceededEventNotification
|
|
252
|
+
| Stripe.Events.V2MoneyManagementReceivedDebitCanceledEventNotification
|
|
253
|
+
| Stripe.Events.V2MoneyManagementReceivedDebitFailedEventNotification
|
|
254
|
+
| Stripe.Events.V2MoneyManagementReceivedDebitPendingEventNotification
|
|
255
|
+
| Stripe.Events.V2MoneyManagementReceivedDebitSucceededEventNotification
|
|
256
|
+
| Stripe.Events.V2MoneyManagementReceivedDebitUpdatedEventNotification
|
|
257
|
+
| Stripe.Events.V2MoneyManagementRecipientVerificationCreatedEventNotification
|
|
258
|
+
| Stripe.Events.V2MoneyManagementRecipientVerificationUpdatedEventNotification
|
|
259
|
+
| Stripe.Events.V2MoneyManagementTransactionCreatedEventNotification
|
|
260
|
+
| Stripe.Events.V2MoneyManagementTransactionUpdatedEventNotification
|
|
261
|
+
| Stripe.Events.V2PaymentsOffSessionPaymentAttemptFailedEventNotification
|
|
262
|
+
| Stripe.Events.V2PaymentsOffSessionPaymentAttemptStartedEventNotification
|
|
263
|
+
| Stripe.Events.V2PaymentsOffSessionPaymentAuthorizationAttemptFailedEventNotification
|
|
264
|
+
| Stripe.Events.V2PaymentsOffSessionPaymentAuthorizationAttemptStartedEventNotification
|
|
265
|
+
| Stripe.Events.V2PaymentsOffSessionPaymentCanceledEventNotification
|
|
266
|
+
| Stripe.Events.V2PaymentsOffSessionPaymentCreatedEventNotification
|
|
267
|
+
| Stripe.Events.V2PaymentsOffSessionPaymentFailedEventNotification
|
|
268
|
+
| Stripe.Events.V2PaymentsOffSessionPaymentRequiresCaptureEventNotification
|
|
269
|
+
| Stripe.Events.V2PaymentsOffSessionPaymentSucceededEventNotification
|
|
270
|
+
| Stripe.Events.V2ReportingReportRunCreatedEventNotification
|
|
271
|
+
| Stripe.Events.V2ReportingReportRunFailedEventNotification
|
|
272
|
+
| Stripe.Events.V2ReportingReportRunSucceededEventNotification
|
|
273
|
+
| Stripe.Events.V2ReportingReportRunUpdatedEventNotification;
|
|
14
274
|
}
|
|
15
275
|
|
|
16
276
|
namespace Stripe.Events {
|
|
@@ -233,24 +493,4470 @@ declare module 'stripe' {
|
|
|
233
493
|
}
|
|
234
494
|
}
|
|
235
495
|
|
|
496
|
+
/**
|
|
497
|
+
* Occurs when a billing Cadence generates an invoice.
|
|
498
|
+
*/
|
|
499
|
+
export interface V2BillingCadenceBilledEvent extends V2.Core.EventBase {
|
|
500
|
+
type: 'v2.billing.cadence.billed';
|
|
501
|
+
// Retrieves data specific to this event.
|
|
502
|
+
data: V2BillingCadenceBilledEvent.Data;
|
|
503
|
+
// Object containing the reference to API resource relevant to the event.
|
|
504
|
+
related_object: V2.Core.Events.RelatedObject;
|
|
505
|
+
// Retrieves the object associated with the event.
|
|
506
|
+
fetchRelatedObject(): Promise<V2.Billing.Cadence>;
|
|
507
|
+
}
|
|
508
|
+
export interface V2BillingCadenceBilledEventNotification
|
|
509
|
+
extends V2.Core.EventNotificationBase {
|
|
510
|
+
type: 'v2.billing.cadence.billed';
|
|
511
|
+
// Object containing the reference to API resource relevant to the event.
|
|
512
|
+
related_object: V2.Core.Events.RelatedObject;
|
|
513
|
+
// Retrieves the object associated with the event.
|
|
514
|
+
fetchRelatedObject(): Promise<V2.Billing.Cadence>;
|
|
515
|
+
fetchEvent(): Promise<V2BillingCadenceBilledEvent>;
|
|
516
|
+
}
|
|
517
|
+
|
|
518
|
+
namespace V2BillingCadenceBilledEvent {
|
|
519
|
+
export interface Data {
|
|
520
|
+
/**
|
|
521
|
+
* The IDs of the invoices that were generated by the tick for this Cadence.
|
|
522
|
+
*/
|
|
523
|
+
invoices: Array<string>;
|
|
524
|
+
}
|
|
525
|
+
}
|
|
526
|
+
|
|
527
|
+
/**
|
|
528
|
+
* Occurs when a billing Cadence is canceled.
|
|
529
|
+
*/
|
|
530
|
+
export interface V2BillingCadenceCanceledEvent extends V2.Core.EventBase {
|
|
531
|
+
type: 'v2.billing.cadence.canceled';
|
|
532
|
+
// Object containing the reference to API resource relevant to the event.
|
|
533
|
+
related_object: V2.Core.Events.RelatedObject;
|
|
534
|
+
// Retrieves the object associated with the event.
|
|
535
|
+
fetchRelatedObject(): Promise<V2.Billing.Cadence>;
|
|
536
|
+
}
|
|
537
|
+
export interface V2BillingCadenceCanceledEventNotification
|
|
538
|
+
extends V2.Core.EventNotificationBase {
|
|
539
|
+
type: 'v2.billing.cadence.canceled';
|
|
540
|
+
// Object containing the reference to API resource relevant to the event.
|
|
541
|
+
related_object: V2.Core.Events.RelatedObject;
|
|
542
|
+
// Retrieves the object associated with the event.
|
|
543
|
+
fetchRelatedObject(): Promise<V2.Billing.Cadence>;
|
|
544
|
+
fetchEvent(): Promise<V2BillingCadenceCanceledEvent>;
|
|
545
|
+
}
|
|
546
|
+
|
|
547
|
+
/**
|
|
548
|
+
* Occurs when a billing Cadence is created.
|
|
549
|
+
*/
|
|
550
|
+
export interface V2BillingCadenceCreatedEvent extends V2.Core.EventBase {
|
|
551
|
+
type: 'v2.billing.cadence.created';
|
|
552
|
+
// Retrieves data specific to this event.
|
|
553
|
+
data: V2BillingCadenceCreatedEvent.Data;
|
|
554
|
+
// Object containing the reference to API resource relevant to the event.
|
|
555
|
+
related_object: V2.Core.Events.RelatedObject;
|
|
556
|
+
// Retrieves the object associated with the event.
|
|
557
|
+
fetchRelatedObject(): Promise<V2.Billing.Cadence>;
|
|
558
|
+
}
|
|
559
|
+
export interface V2BillingCadenceCreatedEventNotification
|
|
560
|
+
extends V2.Core.EventNotificationBase {
|
|
561
|
+
type: 'v2.billing.cadence.created';
|
|
562
|
+
// Object containing the reference to API resource relevant to the event.
|
|
563
|
+
related_object: V2.Core.Events.RelatedObject;
|
|
564
|
+
// Retrieves the object associated with the event.
|
|
565
|
+
fetchRelatedObject(): Promise<V2.Billing.Cadence>;
|
|
566
|
+
fetchEvent(): Promise<V2BillingCadenceCreatedEvent>;
|
|
567
|
+
}
|
|
568
|
+
|
|
569
|
+
namespace V2BillingCadenceCreatedEvent {
|
|
570
|
+
export interface Data {
|
|
571
|
+
/**
|
|
572
|
+
* Timestamp of when the object was created.
|
|
573
|
+
*/
|
|
574
|
+
created: string;
|
|
575
|
+
}
|
|
576
|
+
}
|
|
577
|
+
|
|
578
|
+
/**
|
|
579
|
+
* Occurs when a LicenseFee is created.
|
|
580
|
+
*/
|
|
581
|
+
export interface V2BillingLicenseFeeCreatedEvent extends V2.Core.EventBase {
|
|
582
|
+
type: 'v2.billing.license_fee.created';
|
|
583
|
+
// Object containing the reference to API resource relevant to the event.
|
|
584
|
+
related_object: V2.Core.Events.RelatedObject;
|
|
585
|
+
// Retrieves the object associated with the event.
|
|
586
|
+
fetchRelatedObject(): Promise<V2.Billing.LicenseFee>;
|
|
587
|
+
}
|
|
588
|
+
export interface V2BillingLicenseFeeCreatedEventNotification
|
|
589
|
+
extends V2.Core.EventNotificationBase {
|
|
590
|
+
type: 'v2.billing.license_fee.created';
|
|
591
|
+
// Object containing the reference to API resource relevant to the event.
|
|
592
|
+
related_object: V2.Core.Events.RelatedObject;
|
|
593
|
+
// Retrieves the object associated with the event.
|
|
594
|
+
fetchRelatedObject(): Promise<V2.Billing.LicenseFee>;
|
|
595
|
+
fetchEvent(): Promise<V2BillingLicenseFeeCreatedEvent>;
|
|
596
|
+
}
|
|
597
|
+
|
|
598
|
+
/**
|
|
599
|
+
* Occurs when a LicenseFee is updated.
|
|
600
|
+
*/
|
|
601
|
+
export interface V2BillingLicenseFeeUpdatedEvent extends V2.Core.EventBase {
|
|
602
|
+
type: 'v2.billing.license_fee.updated';
|
|
603
|
+
// Object containing the reference to API resource relevant to the event.
|
|
604
|
+
related_object: V2.Core.Events.RelatedObject;
|
|
605
|
+
// Retrieves the object associated with the event.
|
|
606
|
+
fetchRelatedObject(): Promise<V2.Billing.LicenseFee>;
|
|
607
|
+
}
|
|
608
|
+
export interface V2BillingLicenseFeeUpdatedEventNotification
|
|
609
|
+
extends V2.Core.EventNotificationBase {
|
|
610
|
+
type: 'v2.billing.license_fee.updated';
|
|
611
|
+
// Object containing the reference to API resource relevant to the event.
|
|
612
|
+
related_object: V2.Core.Events.RelatedObject;
|
|
613
|
+
// Retrieves the object associated with the event.
|
|
614
|
+
fetchRelatedObject(): Promise<V2.Billing.LicenseFee>;
|
|
615
|
+
fetchEvent(): Promise<V2BillingLicenseFeeUpdatedEvent>;
|
|
616
|
+
}
|
|
617
|
+
|
|
618
|
+
/**
|
|
619
|
+
* Occurs when a LicenseFeeVersion is created.
|
|
620
|
+
*/
|
|
621
|
+
export interface V2BillingLicenseFeeVersionCreatedEvent
|
|
622
|
+
extends V2.Core.EventBase {
|
|
623
|
+
type: 'v2.billing.license_fee_version.created';
|
|
624
|
+
// Retrieves data specific to this event.
|
|
625
|
+
data: V2BillingLicenseFeeVersionCreatedEvent.Data;
|
|
626
|
+
// Object containing the reference to API resource relevant to the event.
|
|
627
|
+
related_object: V2.Core.Events.RelatedObject;
|
|
628
|
+
// Retrieves the object associated with the event.
|
|
629
|
+
fetchRelatedObject(): Promise<V2.Billing.LicenseFeeVersion>;
|
|
630
|
+
}
|
|
631
|
+
export interface V2BillingLicenseFeeVersionCreatedEventNotification
|
|
632
|
+
extends V2.Core.EventNotificationBase {
|
|
633
|
+
type: 'v2.billing.license_fee_version.created';
|
|
634
|
+
// Object containing the reference to API resource relevant to the event.
|
|
635
|
+
related_object: V2.Core.Events.RelatedObject;
|
|
636
|
+
// Retrieves the object associated with the event.
|
|
637
|
+
fetchRelatedObject(): Promise<V2.Billing.LicenseFeeVersion>;
|
|
638
|
+
fetchEvent(): Promise<V2BillingLicenseFeeVersionCreatedEvent>;
|
|
639
|
+
}
|
|
640
|
+
|
|
641
|
+
namespace V2BillingLicenseFeeVersionCreatedEvent {
|
|
642
|
+
export interface Data {
|
|
643
|
+
/**
|
|
644
|
+
* The ID of the LicenseFee that the LicenseFeeVersion belongs to.
|
|
645
|
+
*/
|
|
646
|
+
license_fee_id: string;
|
|
647
|
+
}
|
|
648
|
+
}
|
|
649
|
+
|
|
650
|
+
/**
|
|
651
|
+
* Occurs when a LicensedItem is created.
|
|
652
|
+
*/
|
|
653
|
+
export interface V2BillingLicensedItemCreatedEvent
|
|
654
|
+
extends V2.Core.EventBase {
|
|
655
|
+
type: 'v2.billing.licensed_item.created';
|
|
656
|
+
// Object containing the reference to API resource relevant to the event.
|
|
657
|
+
related_object: V2.Core.Events.RelatedObject;
|
|
658
|
+
// Retrieves the object associated with the event.
|
|
659
|
+
fetchRelatedObject(): Promise<V2.Billing.LicensedItem>;
|
|
660
|
+
}
|
|
661
|
+
export interface V2BillingLicensedItemCreatedEventNotification
|
|
662
|
+
extends V2.Core.EventNotificationBase {
|
|
663
|
+
type: 'v2.billing.licensed_item.created';
|
|
664
|
+
// Object containing the reference to API resource relevant to the event.
|
|
665
|
+
related_object: V2.Core.Events.RelatedObject;
|
|
666
|
+
// Retrieves the object associated with the event.
|
|
667
|
+
fetchRelatedObject(): Promise<V2.Billing.LicensedItem>;
|
|
668
|
+
fetchEvent(): Promise<V2BillingLicensedItemCreatedEvent>;
|
|
669
|
+
}
|
|
670
|
+
|
|
671
|
+
/**
|
|
672
|
+
* Occurs when a LicensedItem is updated.
|
|
673
|
+
*/
|
|
674
|
+
export interface V2BillingLicensedItemUpdatedEvent
|
|
675
|
+
extends V2.Core.EventBase {
|
|
676
|
+
type: 'v2.billing.licensed_item.updated';
|
|
677
|
+
// Object containing the reference to API resource relevant to the event.
|
|
678
|
+
related_object: V2.Core.Events.RelatedObject;
|
|
679
|
+
// Retrieves the object associated with the event.
|
|
680
|
+
fetchRelatedObject(): Promise<V2.Billing.LicensedItem>;
|
|
681
|
+
}
|
|
682
|
+
export interface V2BillingLicensedItemUpdatedEventNotification
|
|
683
|
+
extends V2.Core.EventNotificationBase {
|
|
684
|
+
type: 'v2.billing.licensed_item.updated';
|
|
685
|
+
// Object containing the reference to API resource relevant to the event.
|
|
686
|
+
related_object: V2.Core.Events.RelatedObject;
|
|
687
|
+
// Retrieves the object associated with the event.
|
|
688
|
+
fetchRelatedObject(): Promise<V2.Billing.LicensedItem>;
|
|
689
|
+
fetchEvent(): Promise<V2BillingLicensedItemUpdatedEvent>;
|
|
690
|
+
}
|
|
691
|
+
|
|
692
|
+
/**
|
|
693
|
+
* Occurs when a MeteredItem is created.
|
|
694
|
+
*/
|
|
695
|
+
export interface V2BillingMeteredItemCreatedEvent
|
|
696
|
+
extends V2.Core.EventBase {
|
|
697
|
+
type: 'v2.billing.metered_item.created';
|
|
698
|
+
// Object containing the reference to API resource relevant to the event.
|
|
699
|
+
related_object: V2.Core.Events.RelatedObject;
|
|
700
|
+
// Retrieves the object associated with the event.
|
|
701
|
+
fetchRelatedObject(): Promise<V2.Billing.MeteredItem>;
|
|
702
|
+
}
|
|
703
|
+
export interface V2BillingMeteredItemCreatedEventNotification
|
|
704
|
+
extends V2.Core.EventNotificationBase {
|
|
705
|
+
type: 'v2.billing.metered_item.created';
|
|
706
|
+
// Object containing the reference to API resource relevant to the event.
|
|
707
|
+
related_object: V2.Core.Events.RelatedObject;
|
|
708
|
+
// Retrieves the object associated with the event.
|
|
709
|
+
fetchRelatedObject(): Promise<V2.Billing.MeteredItem>;
|
|
710
|
+
fetchEvent(): Promise<V2BillingMeteredItemCreatedEvent>;
|
|
711
|
+
}
|
|
712
|
+
|
|
713
|
+
/**
|
|
714
|
+
* Occurs when a MeteredItem is updated.
|
|
715
|
+
*/
|
|
716
|
+
export interface V2BillingMeteredItemUpdatedEvent
|
|
717
|
+
extends V2.Core.EventBase {
|
|
718
|
+
type: 'v2.billing.metered_item.updated';
|
|
719
|
+
// Object containing the reference to API resource relevant to the event.
|
|
720
|
+
related_object: V2.Core.Events.RelatedObject;
|
|
721
|
+
// Retrieves the object associated with the event.
|
|
722
|
+
fetchRelatedObject(): Promise<V2.Billing.MeteredItem>;
|
|
723
|
+
}
|
|
724
|
+
export interface V2BillingMeteredItemUpdatedEventNotification
|
|
725
|
+
extends V2.Core.EventNotificationBase {
|
|
726
|
+
type: 'v2.billing.metered_item.updated';
|
|
727
|
+
// Object containing the reference to API resource relevant to the event.
|
|
728
|
+
related_object: V2.Core.Events.RelatedObject;
|
|
729
|
+
// Retrieves the object associated with the event.
|
|
730
|
+
fetchRelatedObject(): Promise<V2.Billing.MeteredItem>;
|
|
731
|
+
fetchEvent(): Promise<V2BillingMeteredItemUpdatedEvent>;
|
|
732
|
+
}
|
|
733
|
+
|
|
734
|
+
/**
|
|
735
|
+
* Occurs when a PricingPlan is created.
|
|
736
|
+
*/
|
|
737
|
+
export interface V2BillingPricingPlanCreatedEvent
|
|
738
|
+
extends V2.Core.EventBase {
|
|
739
|
+
type: 'v2.billing.pricing_plan.created';
|
|
740
|
+
// Object containing the reference to API resource relevant to the event.
|
|
741
|
+
related_object: V2.Core.Events.RelatedObject;
|
|
742
|
+
// Retrieves the object associated with the event.
|
|
743
|
+
fetchRelatedObject(): Promise<V2.Billing.PricingPlan>;
|
|
744
|
+
}
|
|
745
|
+
export interface V2BillingPricingPlanCreatedEventNotification
|
|
746
|
+
extends V2.Core.EventNotificationBase {
|
|
747
|
+
type: 'v2.billing.pricing_plan.created';
|
|
748
|
+
// Object containing the reference to API resource relevant to the event.
|
|
749
|
+
related_object: V2.Core.Events.RelatedObject;
|
|
750
|
+
// Retrieves the object associated with the event.
|
|
751
|
+
fetchRelatedObject(): Promise<V2.Billing.PricingPlan>;
|
|
752
|
+
fetchEvent(): Promise<V2BillingPricingPlanCreatedEvent>;
|
|
753
|
+
}
|
|
754
|
+
|
|
755
|
+
/**
|
|
756
|
+
* Occurs when a PricingPlan is updated.
|
|
757
|
+
*/
|
|
758
|
+
export interface V2BillingPricingPlanUpdatedEvent
|
|
759
|
+
extends V2.Core.EventBase {
|
|
760
|
+
type: 'v2.billing.pricing_plan.updated';
|
|
761
|
+
// Object containing the reference to API resource relevant to the event.
|
|
762
|
+
related_object: V2.Core.Events.RelatedObject;
|
|
763
|
+
// Retrieves the object associated with the event.
|
|
764
|
+
fetchRelatedObject(): Promise<V2.Billing.PricingPlan>;
|
|
765
|
+
}
|
|
766
|
+
export interface V2BillingPricingPlanUpdatedEventNotification
|
|
767
|
+
extends V2.Core.EventNotificationBase {
|
|
768
|
+
type: 'v2.billing.pricing_plan.updated';
|
|
769
|
+
// Object containing the reference to API resource relevant to the event.
|
|
770
|
+
related_object: V2.Core.Events.RelatedObject;
|
|
771
|
+
// Retrieves the object associated with the event.
|
|
772
|
+
fetchRelatedObject(): Promise<V2.Billing.PricingPlan>;
|
|
773
|
+
fetchEvent(): Promise<V2BillingPricingPlanUpdatedEvent>;
|
|
774
|
+
}
|
|
775
|
+
|
|
776
|
+
/**
|
|
777
|
+
* Occurs when a PricingPlanComponent is created.
|
|
778
|
+
*/
|
|
779
|
+
export interface V2BillingPricingPlanComponentCreatedEvent
|
|
780
|
+
extends V2.Core.EventBase {
|
|
781
|
+
type: 'v2.billing.pricing_plan_component.created';
|
|
782
|
+
// Retrieves data specific to this event.
|
|
783
|
+
data: V2BillingPricingPlanComponentCreatedEvent.Data;
|
|
784
|
+
// Object containing the reference to API resource relevant to the event.
|
|
785
|
+
related_object: V2.Core.Events.RelatedObject;
|
|
786
|
+
// Retrieves the object associated with the event.
|
|
787
|
+
fetchRelatedObject(): Promise<V2.Billing.PricingPlanComponent>;
|
|
788
|
+
}
|
|
789
|
+
export interface V2BillingPricingPlanComponentCreatedEventNotification
|
|
790
|
+
extends V2.Core.EventNotificationBase {
|
|
791
|
+
type: 'v2.billing.pricing_plan_component.created';
|
|
792
|
+
// Object containing the reference to API resource relevant to the event.
|
|
793
|
+
related_object: V2.Core.Events.RelatedObject;
|
|
794
|
+
// Retrieves the object associated with the event.
|
|
795
|
+
fetchRelatedObject(): Promise<V2.Billing.PricingPlanComponent>;
|
|
796
|
+
fetchEvent(): Promise<V2BillingPricingPlanComponentCreatedEvent>;
|
|
797
|
+
}
|
|
798
|
+
|
|
799
|
+
namespace V2BillingPricingPlanComponentCreatedEvent {
|
|
800
|
+
export interface Data {
|
|
801
|
+
/**
|
|
802
|
+
* The ID of the PricingPlan that the PricingPlanComponent belongs to.
|
|
803
|
+
*/
|
|
804
|
+
pricing_plan_id: string;
|
|
805
|
+
}
|
|
806
|
+
}
|
|
807
|
+
|
|
808
|
+
/**
|
|
809
|
+
* Occurs when a PricingPlanComponent is updated.
|
|
810
|
+
*/
|
|
811
|
+
export interface V2BillingPricingPlanComponentUpdatedEvent
|
|
812
|
+
extends V2.Core.EventBase {
|
|
813
|
+
type: 'v2.billing.pricing_plan_component.updated';
|
|
814
|
+
// Retrieves data specific to this event.
|
|
815
|
+
data: V2BillingPricingPlanComponentUpdatedEvent.Data;
|
|
816
|
+
// Object containing the reference to API resource relevant to the event.
|
|
817
|
+
related_object: V2.Core.Events.RelatedObject;
|
|
818
|
+
// Retrieves the object associated with the event.
|
|
819
|
+
fetchRelatedObject(): Promise<V2.Billing.PricingPlanComponent>;
|
|
820
|
+
}
|
|
821
|
+
export interface V2BillingPricingPlanComponentUpdatedEventNotification
|
|
822
|
+
extends V2.Core.EventNotificationBase {
|
|
823
|
+
type: 'v2.billing.pricing_plan_component.updated';
|
|
824
|
+
// Object containing the reference to API resource relevant to the event.
|
|
825
|
+
related_object: V2.Core.Events.RelatedObject;
|
|
826
|
+
// Retrieves the object associated with the event.
|
|
827
|
+
fetchRelatedObject(): Promise<V2.Billing.PricingPlanComponent>;
|
|
828
|
+
fetchEvent(): Promise<V2BillingPricingPlanComponentUpdatedEvent>;
|
|
829
|
+
}
|
|
830
|
+
|
|
831
|
+
namespace V2BillingPricingPlanComponentUpdatedEvent {
|
|
832
|
+
export interface Data {
|
|
833
|
+
/**
|
|
834
|
+
* The ID of the PricingPlan that the PricingPlanComponent belongs to.
|
|
835
|
+
*/
|
|
836
|
+
pricing_plan_id: string;
|
|
837
|
+
}
|
|
838
|
+
}
|
|
839
|
+
|
|
840
|
+
/**
|
|
841
|
+
* Occurs when a PricingPlanSubscription's collection is awaiting customer action.
|
|
842
|
+
*/
|
|
843
|
+
export interface V2BillingPricingPlanSubscriptionCollectionAwaitingCustomerActionEvent
|
|
844
|
+
extends V2.Core.EventBase {
|
|
845
|
+
type: 'v2.billing.pricing_plan_subscription.collection_awaiting_customer_action';
|
|
846
|
+
// Object containing the reference to API resource relevant to the event.
|
|
847
|
+
related_object: V2.Core.Events.RelatedObject;
|
|
848
|
+
// Retrieves the object associated with the event.
|
|
849
|
+
fetchRelatedObject(): Promise<V2.Billing.PricingPlanSubscription>;
|
|
850
|
+
}
|
|
851
|
+
export interface V2BillingPricingPlanSubscriptionCollectionAwaitingCustomerActionEventNotification
|
|
852
|
+
extends V2.Core.EventNotificationBase {
|
|
853
|
+
type: 'v2.billing.pricing_plan_subscription.collection_awaiting_customer_action';
|
|
854
|
+
// Object containing the reference to API resource relevant to the event.
|
|
855
|
+
related_object: V2.Core.Events.RelatedObject;
|
|
856
|
+
// Retrieves the object associated with the event.
|
|
857
|
+
fetchRelatedObject(): Promise<V2.Billing.PricingPlanSubscription>;
|
|
858
|
+
fetchEvent(): Promise<
|
|
859
|
+
V2BillingPricingPlanSubscriptionCollectionAwaitingCustomerActionEvent
|
|
860
|
+
>;
|
|
861
|
+
}
|
|
862
|
+
|
|
863
|
+
/**
|
|
864
|
+
* Occurs when a PricingPlanSubscription's collection is current.
|
|
865
|
+
*/
|
|
866
|
+
export interface V2BillingPricingPlanSubscriptionCollectionCurrentEvent
|
|
867
|
+
extends V2.Core.EventBase {
|
|
868
|
+
type: 'v2.billing.pricing_plan_subscription.collection_current';
|
|
869
|
+
// Object containing the reference to API resource relevant to the event.
|
|
870
|
+
related_object: V2.Core.Events.RelatedObject;
|
|
871
|
+
// Retrieves the object associated with the event.
|
|
872
|
+
fetchRelatedObject(): Promise<V2.Billing.PricingPlanSubscription>;
|
|
873
|
+
}
|
|
874
|
+
export interface V2BillingPricingPlanSubscriptionCollectionCurrentEventNotification
|
|
875
|
+
extends V2.Core.EventNotificationBase {
|
|
876
|
+
type: 'v2.billing.pricing_plan_subscription.collection_current';
|
|
877
|
+
// Object containing the reference to API resource relevant to the event.
|
|
878
|
+
related_object: V2.Core.Events.RelatedObject;
|
|
879
|
+
// Retrieves the object associated with the event.
|
|
880
|
+
fetchRelatedObject(): Promise<V2.Billing.PricingPlanSubscription>;
|
|
881
|
+
fetchEvent(): Promise<
|
|
882
|
+
V2BillingPricingPlanSubscriptionCollectionCurrentEvent
|
|
883
|
+
>;
|
|
884
|
+
}
|
|
885
|
+
|
|
886
|
+
/**
|
|
887
|
+
* Occurs when a PricingPlanSubscription's collection is past due.
|
|
888
|
+
*/
|
|
889
|
+
export interface V2BillingPricingPlanSubscriptionCollectionPastDueEvent
|
|
890
|
+
extends V2.Core.EventBase {
|
|
891
|
+
type: 'v2.billing.pricing_plan_subscription.collection_past_due';
|
|
892
|
+
// Object containing the reference to API resource relevant to the event.
|
|
893
|
+
related_object: V2.Core.Events.RelatedObject;
|
|
894
|
+
// Retrieves the object associated with the event.
|
|
895
|
+
fetchRelatedObject(): Promise<V2.Billing.PricingPlanSubscription>;
|
|
896
|
+
}
|
|
897
|
+
export interface V2BillingPricingPlanSubscriptionCollectionPastDueEventNotification
|
|
898
|
+
extends V2.Core.EventNotificationBase {
|
|
899
|
+
type: 'v2.billing.pricing_plan_subscription.collection_past_due';
|
|
900
|
+
// Object containing the reference to API resource relevant to the event.
|
|
901
|
+
related_object: V2.Core.Events.RelatedObject;
|
|
902
|
+
// Retrieves the object associated with the event.
|
|
903
|
+
fetchRelatedObject(): Promise<V2.Billing.PricingPlanSubscription>;
|
|
904
|
+
fetchEvent(): Promise<
|
|
905
|
+
V2BillingPricingPlanSubscriptionCollectionPastDueEvent
|
|
906
|
+
>;
|
|
907
|
+
}
|
|
908
|
+
|
|
909
|
+
/**
|
|
910
|
+
* Occurs when a PricingPlanSubscription's collection is paused.
|
|
911
|
+
*/
|
|
912
|
+
export interface V2BillingPricingPlanSubscriptionCollectionPausedEvent
|
|
913
|
+
extends V2.Core.EventBase {
|
|
914
|
+
type: 'v2.billing.pricing_plan_subscription.collection_paused';
|
|
915
|
+
// Object containing the reference to API resource relevant to the event.
|
|
916
|
+
related_object: V2.Core.Events.RelatedObject;
|
|
917
|
+
// Retrieves the object associated with the event.
|
|
918
|
+
fetchRelatedObject(): Promise<V2.Billing.PricingPlanSubscription>;
|
|
919
|
+
}
|
|
920
|
+
export interface V2BillingPricingPlanSubscriptionCollectionPausedEventNotification
|
|
921
|
+
extends V2.Core.EventNotificationBase {
|
|
922
|
+
type: 'v2.billing.pricing_plan_subscription.collection_paused';
|
|
923
|
+
// Object containing the reference to API resource relevant to the event.
|
|
924
|
+
related_object: V2.Core.Events.RelatedObject;
|
|
925
|
+
// Retrieves the object associated with the event.
|
|
926
|
+
fetchRelatedObject(): Promise<V2.Billing.PricingPlanSubscription>;
|
|
927
|
+
fetchEvent(): Promise<
|
|
928
|
+
V2BillingPricingPlanSubscriptionCollectionPausedEvent
|
|
929
|
+
>;
|
|
930
|
+
}
|
|
931
|
+
|
|
932
|
+
/**
|
|
933
|
+
* Occurs when a PricingPlanSubscription's collection is unpaid.
|
|
934
|
+
*/
|
|
935
|
+
export interface V2BillingPricingPlanSubscriptionCollectionUnpaidEvent
|
|
936
|
+
extends V2.Core.EventBase {
|
|
937
|
+
type: 'v2.billing.pricing_plan_subscription.collection_unpaid';
|
|
938
|
+
// Object containing the reference to API resource relevant to the event.
|
|
939
|
+
related_object: V2.Core.Events.RelatedObject;
|
|
940
|
+
// Retrieves the object associated with the event.
|
|
941
|
+
fetchRelatedObject(): Promise<V2.Billing.PricingPlanSubscription>;
|
|
942
|
+
}
|
|
943
|
+
export interface V2BillingPricingPlanSubscriptionCollectionUnpaidEventNotification
|
|
944
|
+
extends V2.Core.EventNotificationBase {
|
|
945
|
+
type: 'v2.billing.pricing_plan_subscription.collection_unpaid';
|
|
946
|
+
// Object containing the reference to API resource relevant to the event.
|
|
947
|
+
related_object: V2.Core.Events.RelatedObject;
|
|
948
|
+
// Retrieves the object associated with the event.
|
|
949
|
+
fetchRelatedObject(): Promise<V2.Billing.PricingPlanSubscription>;
|
|
950
|
+
fetchEvent(): Promise<
|
|
951
|
+
V2BillingPricingPlanSubscriptionCollectionUnpaidEvent
|
|
952
|
+
>;
|
|
953
|
+
}
|
|
954
|
+
|
|
955
|
+
/**
|
|
956
|
+
* Occurs when PricingPlanSubscription servicing is activated.
|
|
957
|
+
*/
|
|
958
|
+
export interface V2BillingPricingPlanSubscriptionServicingActivatedEvent
|
|
959
|
+
extends V2.Core.EventBase {
|
|
960
|
+
type: 'v2.billing.pricing_plan_subscription.servicing_activated';
|
|
961
|
+
// Object containing the reference to API resource relevant to the event.
|
|
962
|
+
related_object: V2.Core.Events.RelatedObject;
|
|
963
|
+
// Retrieves the object associated with the event.
|
|
964
|
+
fetchRelatedObject(): Promise<V2.Billing.PricingPlanSubscription>;
|
|
965
|
+
}
|
|
966
|
+
export interface V2BillingPricingPlanSubscriptionServicingActivatedEventNotification
|
|
967
|
+
extends V2.Core.EventNotificationBase {
|
|
968
|
+
type: 'v2.billing.pricing_plan_subscription.servicing_activated';
|
|
969
|
+
// Object containing the reference to API resource relevant to the event.
|
|
970
|
+
related_object: V2.Core.Events.RelatedObject;
|
|
971
|
+
// Retrieves the object associated with the event.
|
|
972
|
+
fetchRelatedObject(): Promise<V2.Billing.PricingPlanSubscription>;
|
|
973
|
+
fetchEvent(): Promise<
|
|
974
|
+
V2BillingPricingPlanSubscriptionServicingActivatedEvent
|
|
975
|
+
>;
|
|
976
|
+
}
|
|
977
|
+
|
|
978
|
+
/**
|
|
979
|
+
* Occurs when PricingPlanSubscription servicing is canceled.
|
|
980
|
+
*/
|
|
981
|
+
export interface V2BillingPricingPlanSubscriptionServicingCanceledEvent
|
|
982
|
+
extends V2.Core.EventBase {
|
|
983
|
+
type: 'v2.billing.pricing_plan_subscription.servicing_canceled';
|
|
984
|
+
// Object containing the reference to API resource relevant to the event.
|
|
985
|
+
related_object: V2.Core.Events.RelatedObject;
|
|
986
|
+
// Retrieves the object associated with the event.
|
|
987
|
+
fetchRelatedObject(): Promise<V2.Billing.PricingPlanSubscription>;
|
|
988
|
+
}
|
|
989
|
+
export interface V2BillingPricingPlanSubscriptionServicingCanceledEventNotification
|
|
990
|
+
extends V2.Core.EventNotificationBase {
|
|
991
|
+
type: 'v2.billing.pricing_plan_subscription.servicing_canceled';
|
|
992
|
+
// Object containing the reference to API resource relevant to the event.
|
|
993
|
+
related_object: V2.Core.Events.RelatedObject;
|
|
994
|
+
// Retrieves the object associated with the event.
|
|
995
|
+
fetchRelatedObject(): Promise<V2.Billing.PricingPlanSubscription>;
|
|
996
|
+
fetchEvent(): Promise<
|
|
997
|
+
V2BillingPricingPlanSubscriptionServicingCanceledEvent
|
|
998
|
+
>;
|
|
999
|
+
}
|
|
1000
|
+
|
|
1001
|
+
/**
|
|
1002
|
+
* Occurs when PricingPlanSubscription servicing is paused.
|
|
1003
|
+
*/
|
|
1004
|
+
export interface V2BillingPricingPlanSubscriptionServicingPausedEvent
|
|
1005
|
+
extends V2.Core.EventBase {
|
|
1006
|
+
type: 'v2.billing.pricing_plan_subscription.servicing_paused';
|
|
1007
|
+
// Object containing the reference to API resource relevant to the event.
|
|
1008
|
+
related_object: V2.Core.Events.RelatedObject;
|
|
1009
|
+
// Retrieves the object associated with the event.
|
|
1010
|
+
fetchRelatedObject(): Promise<V2.Billing.PricingPlanSubscription>;
|
|
1011
|
+
}
|
|
1012
|
+
export interface V2BillingPricingPlanSubscriptionServicingPausedEventNotification
|
|
1013
|
+
extends V2.Core.EventNotificationBase {
|
|
1014
|
+
type: 'v2.billing.pricing_plan_subscription.servicing_paused';
|
|
1015
|
+
// Object containing the reference to API resource relevant to the event.
|
|
1016
|
+
related_object: V2.Core.Events.RelatedObject;
|
|
1017
|
+
// Retrieves the object associated with the event.
|
|
1018
|
+
fetchRelatedObject(): Promise<V2.Billing.PricingPlanSubscription>;
|
|
1019
|
+
fetchEvent(): Promise<
|
|
1020
|
+
V2BillingPricingPlanSubscriptionServicingPausedEvent
|
|
1021
|
+
>;
|
|
1022
|
+
}
|
|
1023
|
+
|
|
1024
|
+
/**
|
|
1025
|
+
* Occurs when a PricingPlanVersion is created.
|
|
1026
|
+
*/
|
|
1027
|
+
export interface V2BillingPricingPlanVersionCreatedEvent
|
|
1028
|
+
extends V2.Core.EventBase {
|
|
1029
|
+
type: 'v2.billing.pricing_plan_version.created';
|
|
1030
|
+
// Retrieves data specific to this event.
|
|
1031
|
+
data: V2BillingPricingPlanVersionCreatedEvent.Data;
|
|
1032
|
+
// Object containing the reference to API resource relevant to the event.
|
|
1033
|
+
related_object: V2.Core.Events.RelatedObject;
|
|
1034
|
+
// Retrieves the object associated with the event.
|
|
1035
|
+
fetchRelatedObject(): Promise<V2.Billing.PricingPlanVersion>;
|
|
1036
|
+
}
|
|
1037
|
+
export interface V2BillingPricingPlanVersionCreatedEventNotification
|
|
1038
|
+
extends V2.Core.EventNotificationBase {
|
|
1039
|
+
type: 'v2.billing.pricing_plan_version.created';
|
|
1040
|
+
// Object containing the reference to API resource relevant to the event.
|
|
1041
|
+
related_object: V2.Core.Events.RelatedObject;
|
|
1042
|
+
// Retrieves the object associated with the event.
|
|
1043
|
+
fetchRelatedObject(): Promise<V2.Billing.PricingPlanVersion>;
|
|
1044
|
+
fetchEvent(): Promise<V2BillingPricingPlanVersionCreatedEvent>;
|
|
1045
|
+
}
|
|
1046
|
+
|
|
1047
|
+
namespace V2BillingPricingPlanVersionCreatedEvent {
|
|
1048
|
+
export interface Data {
|
|
1049
|
+
/**
|
|
1050
|
+
* The ID of the PricingPlan that the PricingPlanVersion belongs to.
|
|
1051
|
+
*/
|
|
1052
|
+
pricing_plan_id: string;
|
|
1053
|
+
}
|
|
1054
|
+
}
|
|
1055
|
+
|
|
1056
|
+
/**
|
|
1057
|
+
* Occurs when a RateCard is created.
|
|
1058
|
+
*/
|
|
1059
|
+
export interface V2BillingRateCardCreatedEvent extends V2.Core.EventBase {
|
|
1060
|
+
type: 'v2.billing.rate_card.created';
|
|
1061
|
+
// Retrieves data specific to this event.
|
|
1062
|
+
data: V2BillingRateCardCreatedEvent.Data;
|
|
1063
|
+
// Object containing the reference to API resource relevant to the event.
|
|
1064
|
+
related_object: V2.Core.Events.RelatedObject;
|
|
1065
|
+
// Retrieves the object associated with the event.
|
|
1066
|
+
fetchRelatedObject(): Promise<V2.Billing.RateCard>;
|
|
1067
|
+
}
|
|
1068
|
+
export interface V2BillingRateCardCreatedEventNotification
|
|
1069
|
+
extends V2.Core.EventNotificationBase {
|
|
1070
|
+
type: 'v2.billing.rate_card.created';
|
|
1071
|
+
// Object containing the reference to API resource relevant to the event.
|
|
1072
|
+
related_object: V2.Core.Events.RelatedObject;
|
|
1073
|
+
// Retrieves the object associated with the event.
|
|
1074
|
+
fetchRelatedObject(): Promise<V2.Billing.RateCard>;
|
|
1075
|
+
fetchEvent(): Promise<V2BillingRateCardCreatedEvent>;
|
|
1076
|
+
}
|
|
1077
|
+
|
|
1078
|
+
namespace V2BillingRateCardCreatedEvent {
|
|
1079
|
+
export interface Data {
|
|
1080
|
+
/**
|
|
1081
|
+
* Timestamp of when the object was created.
|
|
1082
|
+
*/
|
|
1083
|
+
created: string;
|
|
1084
|
+
}
|
|
1085
|
+
}
|
|
1086
|
+
|
|
1087
|
+
/**
|
|
1088
|
+
* Occurs when a RateCard is updated.
|
|
1089
|
+
*/
|
|
1090
|
+
export interface V2BillingRateCardUpdatedEvent extends V2.Core.EventBase {
|
|
1091
|
+
type: 'v2.billing.rate_card.updated';
|
|
1092
|
+
// Object containing the reference to API resource relevant to the event.
|
|
1093
|
+
related_object: V2.Core.Events.RelatedObject;
|
|
1094
|
+
// Retrieves the object associated with the event.
|
|
1095
|
+
fetchRelatedObject(): Promise<V2.Billing.RateCard>;
|
|
1096
|
+
}
|
|
1097
|
+
export interface V2BillingRateCardUpdatedEventNotification
|
|
1098
|
+
extends V2.Core.EventNotificationBase {
|
|
1099
|
+
type: 'v2.billing.rate_card.updated';
|
|
1100
|
+
// Object containing the reference to API resource relevant to the event.
|
|
1101
|
+
related_object: V2.Core.Events.RelatedObject;
|
|
1102
|
+
// Retrieves the object associated with the event.
|
|
1103
|
+
fetchRelatedObject(): Promise<V2.Billing.RateCard>;
|
|
1104
|
+
fetchEvent(): Promise<V2BillingRateCardUpdatedEvent>;
|
|
1105
|
+
}
|
|
1106
|
+
|
|
1107
|
+
/**
|
|
1108
|
+
* Occurs when a RateCardRate is created.
|
|
1109
|
+
*/
|
|
1110
|
+
export interface V2BillingRateCardRateCreatedEvent
|
|
1111
|
+
extends V2.Core.EventBase {
|
|
1112
|
+
type: 'v2.billing.rate_card_rate.created';
|
|
1113
|
+
// Retrieves data specific to this event.
|
|
1114
|
+
data: V2BillingRateCardRateCreatedEvent.Data;
|
|
1115
|
+
// Object containing the reference to API resource relevant to the event.
|
|
1116
|
+
related_object: V2.Core.Events.RelatedObject;
|
|
1117
|
+
// Retrieves the object associated with the event.
|
|
1118
|
+
fetchRelatedObject(): Promise<V2.Billing.RateCardRate>;
|
|
1119
|
+
}
|
|
1120
|
+
export interface V2BillingRateCardRateCreatedEventNotification
|
|
1121
|
+
extends V2.Core.EventNotificationBase {
|
|
1122
|
+
type: 'v2.billing.rate_card_rate.created';
|
|
1123
|
+
// Object containing the reference to API resource relevant to the event.
|
|
1124
|
+
related_object: V2.Core.Events.RelatedObject;
|
|
1125
|
+
// Retrieves the object associated with the event.
|
|
1126
|
+
fetchRelatedObject(): Promise<V2.Billing.RateCardRate>;
|
|
1127
|
+
fetchEvent(): Promise<V2BillingRateCardRateCreatedEvent>;
|
|
1128
|
+
}
|
|
1129
|
+
|
|
1130
|
+
namespace V2BillingRateCardRateCreatedEvent {
|
|
1131
|
+
export interface Data {
|
|
1132
|
+
/**
|
|
1133
|
+
* The ID of the BillableItem which this Rate is associated with.
|
|
1134
|
+
*/
|
|
1135
|
+
billable_item: string;
|
|
1136
|
+
|
|
1137
|
+
/**
|
|
1138
|
+
* Timestamp of when the object was created.
|
|
1139
|
+
*/
|
|
1140
|
+
created: string;
|
|
1141
|
+
|
|
1142
|
+
/**
|
|
1143
|
+
* The ID of the RateCard which this Rate belongs to.
|
|
1144
|
+
*/
|
|
1145
|
+
rate_card: string;
|
|
1146
|
+
|
|
1147
|
+
/**
|
|
1148
|
+
* The ID of the latest RateCard Version when the Rate was created.
|
|
1149
|
+
*/
|
|
1150
|
+
rate_card_version: string;
|
|
1151
|
+
}
|
|
1152
|
+
}
|
|
1153
|
+
|
|
1154
|
+
/**
|
|
1155
|
+
* Occurs when a RateCardSubscription is activated.
|
|
1156
|
+
*/
|
|
1157
|
+
export interface V2BillingRateCardSubscriptionActivatedEvent
|
|
1158
|
+
extends V2.Core.EventBase {
|
|
1159
|
+
type: 'v2.billing.rate_card_subscription.activated';
|
|
1160
|
+
// Object containing the reference to API resource relevant to the event.
|
|
1161
|
+
related_object: V2.Core.Events.RelatedObject;
|
|
1162
|
+
// Retrieves the object associated with the event.
|
|
1163
|
+
fetchRelatedObject(): Promise<V2.Billing.RateCardSubscription>;
|
|
1164
|
+
}
|
|
1165
|
+
export interface V2BillingRateCardSubscriptionActivatedEventNotification
|
|
1166
|
+
extends V2.Core.EventNotificationBase {
|
|
1167
|
+
type: 'v2.billing.rate_card_subscription.activated';
|
|
1168
|
+
// Object containing the reference to API resource relevant to the event.
|
|
1169
|
+
related_object: V2.Core.Events.RelatedObject;
|
|
1170
|
+
// Retrieves the object associated with the event.
|
|
1171
|
+
fetchRelatedObject(): Promise<V2.Billing.RateCardSubscription>;
|
|
1172
|
+
fetchEvent(): Promise<V2BillingRateCardSubscriptionActivatedEvent>;
|
|
1173
|
+
}
|
|
1174
|
+
|
|
1175
|
+
/**
|
|
1176
|
+
* Occurs when a RateCardSubscription is canceled.
|
|
1177
|
+
*/
|
|
1178
|
+
export interface V2BillingRateCardSubscriptionCanceledEvent
|
|
1179
|
+
extends V2.Core.EventBase {
|
|
1180
|
+
type: 'v2.billing.rate_card_subscription.canceled';
|
|
1181
|
+
// Object containing the reference to API resource relevant to the event.
|
|
1182
|
+
related_object: V2.Core.Events.RelatedObject;
|
|
1183
|
+
// Retrieves the object associated with the event.
|
|
1184
|
+
fetchRelatedObject(): Promise<V2.Billing.RateCardSubscription>;
|
|
1185
|
+
}
|
|
1186
|
+
export interface V2BillingRateCardSubscriptionCanceledEventNotification
|
|
1187
|
+
extends V2.Core.EventNotificationBase {
|
|
1188
|
+
type: 'v2.billing.rate_card_subscription.canceled';
|
|
1189
|
+
// Object containing the reference to API resource relevant to the event.
|
|
1190
|
+
related_object: V2.Core.Events.RelatedObject;
|
|
1191
|
+
// Retrieves the object associated with the event.
|
|
1192
|
+
fetchRelatedObject(): Promise<V2.Billing.RateCardSubscription>;
|
|
1193
|
+
fetchEvent(): Promise<V2BillingRateCardSubscriptionCanceledEvent>;
|
|
1194
|
+
}
|
|
1195
|
+
|
|
1196
|
+
/**
|
|
1197
|
+
* Occurs when a RateCardSubscription's collection is awaiting customer action.
|
|
1198
|
+
*/
|
|
1199
|
+
export interface V2BillingRateCardSubscriptionCollectionAwaitingCustomerActionEvent
|
|
1200
|
+
extends V2.Core.EventBase {
|
|
1201
|
+
type: 'v2.billing.rate_card_subscription.collection_awaiting_customer_action';
|
|
1202
|
+
// Object containing the reference to API resource relevant to the event.
|
|
1203
|
+
related_object: V2.Core.Events.RelatedObject;
|
|
1204
|
+
// Retrieves the object associated with the event.
|
|
1205
|
+
fetchRelatedObject(): Promise<V2.Billing.RateCardSubscription>;
|
|
1206
|
+
}
|
|
1207
|
+
export interface V2BillingRateCardSubscriptionCollectionAwaitingCustomerActionEventNotification
|
|
1208
|
+
extends V2.Core.EventNotificationBase {
|
|
1209
|
+
type: 'v2.billing.rate_card_subscription.collection_awaiting_customer_action';
|
|
1210
|
+
// Object containing the reference to API resource relevant to the event.
|
|
1211
|
+
related_object: V2.Core.Events.RelatedObject;
|
|
1212
|
+
// Retrieves the object associated with the event.
|
|
1213
|
+
fetchRelatedObject(): Promise<V2.Billing.RateCardSubscription>;
|
|
1214
|
+
fetchEvent(): Promise<
|
|
1215
|
+
V2BillingRateCardSubscriptionCollectionAwaitingCustomerActionEvent
|
|
1216
|
+
>;
|
|
1217
|
+
}
|
|
1218
|
+
|
|
1219
|
+
/**
|
|
1220
|
+
* Occurs when a RateCardSubscription's collection is current.
|
|
1221
|
+
*/
|
|
1222
|
+
export interface V2BillingRateCardSubscriptionCollectionCurrentEvent
|
|
1223
|
+
extends V2.Core.EventBase {
|
|
1224
|
+
type: 'v2.billing.rate_card_subscription.collection_current';
|
|
1225
|
+
// Object containing the reference to API resource relevant to the event.
|
|
1226
|
+
related_object: V2.Core.Events.RelatedObject;
|
|
1227
|
+
// Retrieves the object associated with the event.
|
|
1228
|
+
fetchRelatedObject(): Promise<V2.Billing.RateCardSubscription>;
|
|
1229
|
+
}
|
|
1230
|
+
export interface V2BillingRateCardSubscriptionCollectionCurrentEventNotification
|
|
1231
|
+
extends V2.Core.EventNotificationBase {
|
|
1232
|
+
type: 'v2.billing.rate_card_subscription.collection_current';
|
|
1233
|
+
// Object containing the reference to API resource relevant to the event.
|
|
1234
|
+
related_object: V2.Core.Events.RelatedObject;
|
|
1235
|
+
// Retrieves the object associated with the event.
|
|
1236
|
+
fetchRelatedObject(): Promise<V2.Billing.RateCardSubscription>;
|
|
1237
|
+
fetchEvent(): Promise<
|
|
1238
|
+
V2BillingRateCardSubscriptionCollectionCurrentEvent
|
|
1239
|
+
>;
|
|
1240
|
+
}
|
|
1241
|
+
|
|
1242
|
+
/**
|
|
1243
|
+
* Occurs when a RateCardSubscription's collection is past due.
|
|
1244
|
+
*/
|
|
1245
|
+
export interface V2BillingRateCardSubscriptionCollectionPastDueEvent
|
|
1246
|
+
extends V2.Core.EventBase {
|
|
1247
|
+
type: 'v2.billing.rate_card_subscription.collection_past_due';
|
|
1248
|
+
// Object containing the reference to API resource relevant to the event.
|
|
1249
|
+
related_object: V2.Core.Events.RelatedObject;
|
|
1250
|
+
// Retrieves the object associated with the event.
|
|
1251
|
+
fetchRelatedObject(): Promise<V2.Billing.RateCardSubscription>;
|
|
1252
|
+
}
|
|
1253
|
+
export interface V2BillingRateCardSubscriptionCollectionPastDueEventNotification
|
|
1254
|
+
extends V2.Core.EventNotificationBase {
|
|
1255
|
+
type: 'v2.billing.rate_card_subscription.collection_past_due';
|
|
1256
|
+
// Object containing the reference to API resource relevant to the event.
|
|
1257
|
+
related_object: V2.Core.Events.RelatedObject;
|
|
1258
|
+
// Retrieves the object associated with the event.
|
|
1259
|
+
fetchRelatedObject(): Promise<V2.Billing.RateCardSubscription>;
|
|
1260
|
+
fetchEvent(): Promise<
|
|
1261
|
+
V2BillingRateCardSubscriptionCollectionPastDueEvent
|
|
1262
|
+
>;
|
|
1263
|
+
}
|
|
1264
|
+
|
|
1265
|
+
/**
|
|
1266
|
+
* Occurs when a RateCardSubscription's collection is paused.
|
|
1267
|
+
*/
|
|
1268
|
+
export interface V2BillingRateCardSubscriptionCollectionPausedEvent
|
|
1269
|
+
extends V2.Core.EventBase {
|
|
1270
|
+
type: 'v2.billing.rate_card_subscription.collection_paused';
|
|
1271
|
+
// Object containing the reference to API resource relevant to the event.
|
|
1272
|
+
related_object: V2.Core.Events.RelatedObject;
|
|
1273
|
+
// Retrieves the object associated with the event.
|
|
1274
|
+
fetchRelatedObject(): Promise<V2.Billing.RateCardSubscription>;
|
|
1275
|
+
}
|
|
1276
|
+
export interface V2BillingRateCardSubscriptionCollectionPausedEventNotification
|
|
1277
|
+
extends V2.Core.EventNotificationBase {
|
|
1278
|
+
type: 'v2.billing.rate_card_subscription.collection_paused';
|
|
1279
|
+
// Object containing the reference to API resource relevant to the event.
|
|
1280
|
+
related_object: V2.Core.Events.RelatedObject;
|
|
1281
|
+
// Retrieves the object associated with the event.
|
|
1282
|
+
fetchRelatedObject(): Promise<V2.Billing.RateCardSubscription>;
|
|
1283
|
+
fetchEvent(): Promise<V2BillingRateCardSubscriptionCollectionPausedEvent>;
|
|
1284
|
+
}
|
|
1285
|
+
|
|
1286
|
+
/**
|
|
1287
|
+
* Occurs when a RateCardSubscription's collection is unpaid.
|
|
1288
|
+
*/
|
|
1289
|
+
export interface V2BillingRateCardSubscriptionCollectionUnpaidEvent
|
|
1290
|
+
extends V2.Core.EventBase {
|
|
1291
|
+
type: 'v2.billing.rate_card_subscription.collection_unpaid';
|
|
1292
|
+
// Object containing the reference to API resource relevant to the event.
|
|
1293
|
+
related_object: V2.Core.Events.RelatedObject;
|
|
1294
|
+
// Retrieves the object associated with the event.
|
|
1295
|
+
fetchRelatedObject(): Promise<V2.Billing.RateCardSubscription>;
|
|
1296
|
+
}
|
|
1297
|
+
export interface V2BillingRateCardSubscriptionCollectionUnpaidEventNotification
|
|
1298
|
+
extends V2.Core.EventNotificationBase {
|
|
1299
|
+
type: 'v2.billing.rate_card_subscription.collection_unpaid';
|
|
1300
|
+
// Object containing the reference to API resource relevant to the event.
|
|
1301
|
+
related_object: V2.Core.Events.RelatedObject;
|
|
1302
|
+
// Retrieves the object associated with the event.
|
|
1303
|
+
fetchRelatedObject(): Promise<V2.Billing.RateCardSubscription>;
|
|
1304
|
+
fetchEvent(): Promise<V2BillingRateCardSubscriptionCollectionUnpaidEvent>;
|
|
1305
|
+
}
|
|
1306
|
+
|
|
1307
|
+
/**
|
|
1308
|
+
* Occurs when RateCardSubscription servicing is activated.
|
|
1309
|
+
*/
|
|
1310
|
+
export interface V2BillingRateCardSubscriptionServicingActivatedEvent
|
|
1311
|
+
extends V2.Core.EventBase {
|
|
1312
|
+
type: 'v2.billing.rate_card_subscription.servicing_activated';
|
|
1313
|
+
// Object containing the reference to API resource relevant to the event.
|
|
1314
|
+
related_object: V2.Core.Events.RelatedObject;
|
|
1315
|
+
// Retrieves the object associated with the event.
|
|
1316
|
+
fetchRelatedObject(): Promise<V2.Billing.RateCardSubscription>;
|
|
1317
|
+
}
|
|
1318
|
+
export interface V2BillingRateCardSubscriptionServicingActivatedEventNotification
|
|
1319
|
+
extends V2.Core.EventNotificationBase {
|
|
1320
|
+
type: 'v2.billing.rate_card_subscription.servicing_activated';
|
|
1321
|
+
// Object containing the reference to API resource relevant to the event.
|
|
1322
|
+
related_object: V2.Core.Events.RelatedObject;
|
|
1323
|
+
// Retrieves the object associated with the event.
|
|
1324
|
+
fetchRelatedObject(): Promise<V2.Billing.RateCardSubscription>;
|
|
1325
|
+
fetchEvent(): Promise<
|
|
1326
|
+
V2BillingRateCardSubscriptionServicingActivatedEvent
|
|
1327
|
+
>;
|
|
1328
|
+
}
|
|
1329
|
+
|
|
1330
|
+
/**
|
|
1331
|
+
* Occurs when RateCardSubscription servicing is canceled.
|
|
1332
|
+
*/
|
|
1333
|
+
export interface V2BillingRateCardSubscriptionServicingCanceledEvent
|
|
1334
|
+
extends V2.Core.EventBase {
|
|
1335
|
+
type: 'v2.billing.rate_card_subscription.servicing_canceled';
|
|
1336
|
+
// Object containing the reference to API resource relevant to the event.
|
|
1337
|
+
related_object: V2.Core.Events.RelatedObject;
|
|
1338
|
+
// Retrieves the object associated with the event.
|
|
1339
|
+
fetchRelatedObject(): Promise<V2.Billing.RateCardSubscription>;
|
|
1340
|
+
}
|
|
1341
|
+
export interface V2BillingRateCardSubscriptionServicingCanceledEventNotification
|
|
1342
|
+
extends V2.Core.EventNotificationBase {
|
|
1343
|
+
type: 'v2.billing.rate_card_subscription.servicing_canceled';
|
|
1344
|
+
// Object containing the reference to API resource relevant to the event.
|
|
1345
|
+
related_object: V2.Core.Events.RelatedObject;
|
|
1346
|
+
// Retrieves the object associated with the event.
|
|
1347
|
+
fetchRelatedObject(): Promise<V2.Billing.RateCardSubscription>;
|
|
1348
|
+
fetchEvent(): Promise<
|
|
1349
|
+
V2BillingRateCardSubscriptionServicingCanceledEvent
|
|
1350
|
+
>;
|
|
1351
|
+
}
|
|
1352
|
+
|
|
1353
|
+
/**
|
|
1354
|
+
* Occurs when RateCardSubscription servicing is paused.
|
|
1355
|
+
*/
|
|
1356
|
+
export interface V2BillingRateCardSubscriptionServicingPausedEvent
|
|
1357
|
+
extends V2.Core.EventBase {
|
|
1358
|
+
type: 'v2.billing.rate_card_subscription.servicing_paused';
|
|
1359
|
+
// Object containing the reference to API resource relevant to the event.
|
|
1360
|
+
related_object: V2.Core.Events.RelatedObject;
|
|
1361
|
+
// Retrieves the object associated with the event.
|
|
1362
|
+
fetchRelatedObject(): Promise<V2.Billing.RateCardSubscription>;
|
|
1363
|
+
}
|
|
1364
|
+
export interface V2BillingRateCardSubscriptionServicingPausedEventNotification
|
|
1365
|
+
extends V2.Core.EventNotificationBase {
|
|
1366
|
+
type: 'v2.billing.rate_card_subscription.servicing_paused';
|
|
1367
|
+
// Object containing the reference to API resource relevant to the event.
|
|
1368
|
+
related_object: V2.Core.Events.RelatedObject;
|
|
1369
|
+
// Retrieves the object associated with the event.
|
|
1370
|
+
fetchRelatedObject(): Promise<V2.Billing.RateCardSubscription>;
|
|
1371
|
+
fetchEvent(): Promise<V2BillingRateCardSubscriptionServicingPausedEvent>;
|
|
1372
|
+
}
|
|
1373
|
+
|
|
1374
|
+
/**
|
|
1375
|
+
* Occurs when a RateCardVersion is created.
|
|
1376
|
+
*/
|
|
1377
|
+
export interface V2BillingRateCardVersionCreatedEvent
|
|
1378
|
+
extends V2.Core.EventBase {
|
|
1379
|
+
type: 'v2.billing.rate_card_version.created';
|
|
1380
|
+
// Retrieves data specific to this event.
|
|
1381
|
+
data: V2BillingRateCardVersionCreatedEvent.Data;
|
|
1382
|
+
// Object containing the reference to API resource relevant to the event.
|
|
1383
|
+
related_object: V2.Core.Events.RelatedObject;
|
|
1384
|
+
// Retrieves the object associated with the event.
|
|
1385
|
+
fetchRelatedObject(): Promise<V2.Billing.RateCardVersion>;
|
|
1386
|
+
}
|
|
1387
|
+
export interface V2BillingRateCardVersionCreatedEventNotification
|
|
1388
|
+
extends V2.Core.EventNotificationBase {
|
|
1389
|
+
type: 'v2.billing.rate_card_version.created';
|
|
1390
|
+
// Object containing the reference to API resource relevant to the event.
|
|
1391
|
+
related_object: V2.Core.Events.RelatedObject;
|
|
1392
|
+
// Retrieves the object associated with the event.
|
|
1393
|
+
fetchRelatedObject(): Promise<V2.Billing.RateCardVersion>;
|
|
1394
|
+
fetchEvent(): Promise<V2BillingRateCardVersionCreatedEvent>;
|
|
1395
|
+
}
|
|
1396
|
+
|
|
1397
|
+
namespace V2BillingRateCardVersionCreatedEvent {
|
|
1398
|
+
export interface Data {
|
|
1399
|
+
/**
|
|
1400
|
+
* The ID of the RateCard that the RateCardVersion belongs to.
|
|
1401
|
+
*/
|
|
1402
|
+
rate_card_id: string;
|
|
1403
|
+
}
|
|
1404
|
+
}
|
|
1405
|
+
|
|
1406
|
+
/**
|
|
1407
|
+
* This event occurs when an account is closed.
|
|
1408
|
+
*/
|
|
1409
|
+
export interface V2CoreAccountClosedEvent extends V2.Core.EventBase {
|
|
1410
|
+
type: 'v2.core.account.closed';
|
|
1411
|
+
// Object containing the reference to API resource relevant to the event.
|
|
1412
|
+
related_object: V2.Core.Events.RelatedObject;
|
|
1413
|
+
// Retrieves the object associated with the event.
|
|
1414
|
+
fetchRelatedObject(): Promise<V2.Core.Account>;
|
|
1415
|
+
}
|
|
1416
|
+
export interface V2CoreAccountClosedEventNotification
|
|
1417
|
+
extends V2.Core.EventNotificationBase {
|
|
1418
|
+
type: 'v2.core.account.closed';
|
|
1419
|
+
// Object containing the reference to API resource relevant to the event.
|
|
1420
|
+
related_object: V2.Core.Events.RelatedObject;
|
|
1421
|
+
// Retrieves the object associated with the event.
|
|
1422
|
+
fetchRelatedObject(): Promise<V2.Core.Account>;
|
|
1423
|
+
fetchEvent(): Promise<V2CoreAccountClosedEvent>;
|
|
1424
|
+
}
|
|
1425
|
+
|
|
1426
|
+
/**
|
|
1427
|
+
* Occurs when an Account is created.
|
|
1428
|
+
*/
|
|
1429
|
+
export interface V2CoreAccountCreatedEvent extends V2.Core.EventBase {
|
|
1430
|
+
type: 'v2.core.account.created';
|
|
1431
|
+
// Object containing the reference to API resource relevant to the event.
|
|
1432
|
+
related_object: V2.Core.Events.RelatedObject;
|
|
1433
|
+
// Retrieves the object associated with the event.
|
|
1434
|
+
fetchRelatedObject(): Promise<V2.Core.Account>;
|
|
1435
|
+
}
|
|
1436
|
+
export interface V2CoreAccountCreatedEventNotification
|
|
1437
|
+
extends V2.Core.EventNotificationBase {
|
|
1438
|
+
type: 'v2.core.account.created';
|
|
1439
|
+
// Object containing the reference to API resource relevant to the event.
|
|
1440
|
+
related_object: V2.Core.Events.RelatedObject;
|
|
1441
|
+
// Retrieves the object associated with the event.
|
|
1442
|
+
fetchRelatedObject(): Promise<V2.Core.Account>;
|
|
1443
|
+
fetchEvent(): Promise<V2CoreAccountCreatedEvent>;
|
|
1444
|
+
}
|
|
1445
|
+
|
|
1446
|
+
/**
|
|
1447
|
+
* Occurs when an Account is updated.
|
|
1448
|
+
*/
|
|
1449
|
+
export interface V2CoreAccountUpdatedEvent extends V2.Core.EventBase {
|
|
1450
|
+
type: 'v2.core.account.updated';
|
|
1451
|
+
// Object containing the reference to API resource relevant to the event.
|
|
1452
|
+
related_object: V2.Core.Events.RelatedObject;
|
|
1453
|
+
// Retrieves the object associated with the event.
|
|
1454
|
+
fetchRelatedObject(): Promise<V2.Core.Account>;
|
|
1455
|
+
}
|
|
1456
|
+
export interface V2CoreAccountUpdatedEventNotification
|
|
1457
|
+
extends V2.Core.EventNotificationBase {
|
|
1458
|
+
type: 'v2.core.account.updated';
|
|
1459
|
+
// Object containing the reference to API resource relevant to the event.
|
|
1460
|
+
related_object: V2.Core.Events.RelatedObject;
|
|
1461
|
+
// Retrieves the object associated with the event.
|
|
1462
|
+
fetchRelatedObject(): Promise<V2.Core.Account>;
|
|
1463
|
+
fetchEvent(): Promise<V2CoreAccountUpdatedEvent>;
|
|
1464
|
+
}
|
|
1465
|
+
|
|
1466
|
+
/**
|
|
1467
|
+
* Occurs when the status of an Account's card creator configuration capability is updated.
|
|
1468
|
+
*/
|
|
1469
|
+
export interface V2CoreAccountIncludingConfigurationCardCreatorCapabilityStatusUpdatedEvent
|
|
1470
|
+
extends V2.Core.EventBase {
|
|
1471
|
+
type: 'v2.core.account[configuration.card_creator].capability_status_updated';
|
|
1472
|
+
// Retrieves data specific to this event.
|
|
1473
|
+
data: V2CoreAccountIncludingConfigurationCardCreatorCapabilityStatusUpdatedEvent.Data;
|
|
1474
|
+
// Object containing the reference to API resource relevant to the event.
|
|
1475
|
+
related_object: V2.Core.Events.RelatedObject;
|
|
1476
|
+
// Retrieves the object associated with the event.
|
|
1477
|
+
fetchRelatedObject(): Promise<V2.Core.Account>;
|
|
1478
|
+
}
|
|
1479
|
+
export interface V2CoreAccountIncludingConfigurationCardCreatorCapabilityStatusUpdatedEventNotification
|
|
1480
|
+
extends V2.Core.EventNotificationBase {
|
|
1481
|
+
type: 'v2.core.account[configuration.card_creator].capability_status_updated';
|
|
1482
|
+
// Object containing the reference to API resource relevant to the event.
|
|
1483
|
+
related_object: V2.Core.Events.RelatedObject;
|
|
1484
|
+
// Retrieves the object associated with the event.
|
|
1485
|
+
fetchRelatedObject(): Promise<V2.Core.Account>;
|
|
1486
|
+
fetchEvent(): Promise<
|
|
1487
|
+
V2CoreAccountIncludingConfigurationCardCreatorCapabilityStatusUpdatedEvent
|
|
1488
|
+
>;
|
|
1489
|
+
}
|
|
1490
|
+
|
|
1491
|
+
namespace V2CoreAccountIncludingConfigurationCardCreatorCapabilityStatusUpdatedEvent {
|
|
1492
|
+
export interface Data {
|
|
1493
|
+
/**
|
|
1494
|
+
* Open Enum. The capability which had its status updated.
|
|
1495
|
+
*/
|
|
1496
|
+
updated_capability: Data.UpdatedCapability;
|
|
1497
|
+
}
|
|
1498
|
+
|
|
1499
|
+
namespace Data {
|
|
1500
|
+
export type UpdatedCapability =
|
|
1501
|
+
| 'commercial.celtic.charge_card'
|
|
1502
|
+
| 'commercial.celtic.spend_card'
|
|
1503
|
+
| 'commercial.cross_river_bank.charge_card'
|
|
1504
|
+
| 'commercial.cross_river_bank.spend_card'
|
|
1505
|
+
| 'commercial.lead.prepaid_card'
|
|
1506
|
+
| 'commercial.stripe.charge_card'
|
|
1507
|
+
| 'commercial.stripe.prepaid_card';
|
|
1508
|
+
}
|
|
1509
|
+
}
|
|
1510
|
+
|
|
1511
|
+
/**
|
|
1512
|
+
* Occurs when a Card Creator's configuration is updated.
|
|
1513
|
+
*/
|
|
1514
|
+
export interface V2CoreAccountIncludingConfigurationCardCreatorUpdatedEvent
|
|
1515
|
+
extends V2.Core.EventBase {
|
|
1516
|
+
type: 'v2.core.account[configuration.card_creator].updated';
|
|
1517
|
+
// Object containing the reference to API resource relevant to the event.
|
|
1518
|
+
related_object: V2.Core.Events.RelatedObject;
|
|
1519
|
+
// Retrieves the object associated with the event.
|
|
1520
|
+
fetchRelatedObject(): Promise<V2.Core.Account>;
|
|
1521
|
+
}
|
|
1522
|
+
export interface V2CoreAccountIncludingConfigurationCardCreatorUpdatedEventNotification
|
|
1523
|
+
extends V2.Core.EventNotificationBase {
|
|
1524
|
+
type: 'v2.core.account[configuration.card_creator].updated';
|
|
1525
|
+
// Object containing the reference to API resource relevant to the event.
|
|
1526
|
+
related_object: V2.Core.Events.RelatedObject;
|
|
1527
|
+
// Retrieves the object associated with the event.
|
|
1528
|
+
fetchRelatedObject(): Promise<V2.Core.Account>;
|
|
1529
|
+
fetchEvent(): Promise<
|
|
1530
|
+
V2CoreAccountIncludingConfigurationCardCreatorUpdatedEvent
|
|
1531
|
+
>;
|
|
1532
|
+
}
|
|
1533
|
+
|
|
1534
|
+
/**
|
|
1535
|
+
* Occurs when the status of an Account's customer configuration capability is updated.
|
|
1536
|
+
*/
|
|
1537
|
+
export interface V2CoreAccountIncludingConfigurationCustomerCapabilityStatusUpdatedEvent
|
|
1538
|
+
extends V2.Core.EventBase {
|
|
1539
|
+
type: 'v2.core.account[configuration.customer].capability_status_updated';
|
|
1540
|
+
// Retrieves data specific to this event.
|
|
1541
|
+
data: V2CoreAccountIncludingConfigurationCustomerCapabilityStatusUpdatedEvent.Data;
|
|
1542
|
+
// Object containing the reference to API resource relevant to the event.
|
|
1543
|
+
related_object: V2.Core.Events.RelatedObject;
|
|
1544
|
+
// Retrieves the object associated with the event.
|
|
1545
|
+
fetchRelatedObject(): Promise<V2.Core.Account>;
|
|
1546
|
+
}
|
|
1547
|
+
export interface V2CoreAccountIncludingConfigurationCustomerCapabilityStatusUpdatedEventNotification
|
|
1548
|
+
extends V2.Core.EventNotificationBase {
|
|
1549
|
+
type: 'v2.core.account[configuration.customer].capability_status_updated';
|
|
1550
|
+
// Object containing the reference to API resource relevant to the event.
|
|
1551
|
+
related_object: V2.Core.Events.RelatedObject;
|
|
1552
|
+
// Retrieves the object associated with the event.
|
|
1553
|
+
fetchRelatedObject(): Promise<V2.Core.Account>;
|
|
1554
|
+
fetchEvent(): Promise<
|
|
1555
|
+
V2CoreAccountIncludingConfigurationCustomerCapabilityStatusUpdatedEvent
|
|
1556
|
+
>;
|
|
1557
|
+
}
|
|
1558
|
+
|
|
1559
|
+
namespace V2CoreAccountIncludingConfigurationCustomerCapabilityStatusUpdatedEvent {
|
|
1560
|
+
export interface Data {
|
|
1561
|
+
/**
|
|
1562
|
+
* Open Enum. The capability which had its status updated.
|
|
1563
|
+
*/
|
|
1564
|
+
updated_capability: 'automatic_indirect_tax';
|
|
1565
|
+
}
|
|
1566
|
+
}
|
|
1567
|
+
|
|
1568
|
+
/**
|
|
1569
|
+
* Occurs when an Account's customer configuration is updated.
|
|
1570
|
+
*/
|
|
1571
|
+
export interface V2CoreAccountIncludingConfigurationCustomerUpdatedEvent
|
|
1572
|
+
extends V2.Core.EventBase {
|
|
1573
|
+
type: 'v2.core.account[configuration.customer].updated';
|
|
1574
|
+
// Object containing the reference to API resource relevant to the event.
|
|
1575
|
+
related_object: V2.Core.Events.RelatedObject;
|
|
1576
|
+
// Retrieves the object associated with the event.
|
|
1577
|
+
fetchRelatedObject(): Promise<V2.Core.Account>;
|
|
1578
|
+
}
|
|
1579
|
+
export interface V2CoreAccountIncludingConfigurationCustomerUpdatedEventNotification
|
|
1580
|
+
extends V2.Core.EventNotificationBase {
|
|
1581
|
+
type: 'v2.core.account[configuration.customer].updated';
|
|
1582
|
+
// Object containing the reference to API resource relevant to the event.
|
|
1583
|
+
related_object: V2.Core.Events.RelatedObject;
|
|
1584
|
+
// Retrieves the object associated with the event.
|
|
1585
|
+
fetchRelatedObject(): Promise<V2.Core.Account>;
|
|
1586
|
+
fetchEvent(): Promise<
|
|
1587
|
+
V2CoreAccountIncludingConfigurationCustomerUpdatedEvent
|
|
1588
|
+
>;
|
|
1589
|
+
}
|
|
1590
|
+
|
|
1591
|
+
/**
|
|
1592
|
+
* Occurs when the status of an Account's merchant configuration capability is updated.
|
|
1593
|
+
*/
|
|
1594
|
+
export interface V2CoreAccountIncludingConfigurationMerchantCapabilityStatusUpdatedEvent
|
|
1595
|
+
extends V2.Core.EventBase {
|
|
1596
|
+
type: 'v2.core.account[configuration.merchant].capability_status_updated';
|
|
1597
|
+
// Retrieves data specific to this event.
|
|
1598
|
+
data: V2CoreAccountIncludingConfigurationMerchantCapabilityStatusUpdatedEvent.Data;
|
|
1599
|
+
// Object containing the reference to API resource relevant to the event.
|
|
1600
|
+
related_object: V2.Core.Events.RelatedObject;
|
|
1601
|
+
// Retrieves the object associated with the event.
|
|
1602
|
+
fetchRelatedObject(): Promise<V2.Core.Account>;
|
|
1603
|
+
}
|
|
1604
|
+
export interface V2CoreAccountIncludingConfigurationMerchantCapabilityStatusUpdatedEventNotification
|
|
1605
|
+
extends V2.Core.EventNotificationBase {
|
|
1606
|
+
type: 'v2.core.account[configuration.merchant].capability_status_updated';
|
|
1607
|
+
// Object containing the reference to API resource relevant to the event.
|
|
1608
|
+
related_object: V2.Core.Events.RelatedObject;
|
|
1609
|
+
// Retrieves the object associated with the event.
|
|
1610
|
+
fetchRelatedObject(): Promise<V2.Core.Account>;
|
|
1611
|
+
fetchEvent(): Promise<
|
|
1612
|
+
V2CoreAccountIncludingConfigurationMerchantCapabilityStatusUpdatedEvent
|
|
1613
|
+
>;
|
|
1614
|
+
}
|
|
1615
|
+
|
|
1616
|
+
namespace V2CoreAccountIncludingConfigurationMerchantCapabilityStatusUpdatedEvent {
|
|
1617
|
+
export interface Data {
|
|
1618
|
+
/**
|
|
1619
|
+
* Open Enum. The capability which had its status updated.
|
|
1620
|
+
*/
|
|
1621
|
+
updated_capability: Data.UpdatedCapability;
|
|
1622
|
+
}
|
|
1623
|
+
|
|
1624
|
+
namespace Data {
|
|
1625
|
+
export type UpdatedCapability =
|
|
1626
|
+
| 'ach_debit_payments'
|
|
1627
|
+
| 'acss_debit_payments'
|
|
1628
|
+
| 'affirm_payments'
|
|
1629
|
+
| 'afterpay_clearpay_payments'
|
|
1630
|
+
| 'alma_payments'
|
|
1631
|
+
| 'amazon_pay_payments'
|
|
1632
|
+
| 'au_becs_debit_payments'
|
|
1633
|
+
| 'bacs_debit_payments'
|
|
1634
|
+
| 'bancontact_payments'
|
|
1635
|
+
| 'blik_payments'
|
|
1636
|
+
| 'boleto_payments'
|
|
1637
|
+
| 'card_payments'
|
|
1638
|
+
| 'cartes_bancaires_payments'
|
|
1639
|
+
| 'cashapp_payments'
|
|
1640
|
+
| 'eps_payments'
|
|
1641
|
+
| 'fpx_payments'
|
|
1642
|
+
| 'gb_bank_transfer_payments'
|
|
1643
|
+
| 'grabpay_payments'
|
|
1644
|
+
| 'ideal_payments'
|
|
1645
|
+
| 'jcb_payments'
|
|
1646
|
+
| 'jp_bank_transfer_payments'
|
|
1647
|
+
| 'kakao_pay_payments'
|
|
1648
|
+
| 'klarna_payments'
|
|
1649
|
+
| 'konbini_payments'
|
|
1650
|
+
| 'kr_card_payments'
|
|
1651
|
+
| 'link_payments'
|
|
1652
|
+
| 'mobilepay_payments'
|
|
1653
|
+
| 'multibanco_payments'
|
|
1654
|
+
| 'mx_bank_transfer_payments'
|
|
1655
|
+
| 'naver_pay_payments'
|
|
1656
|
+
| 'oxxo_payments'
|
|
1657
|
+
| 'p24_payments'
|
|
1658
|
+
| 'payco_payments'
|
|
1659
|
+
| 'paynow_payments'
|
|
1660
|
+
| 'stripe_balance.payouts'
|
|
1661
|
+
| 'pay_by_bank_payments'
|
|
1662
|
+
| 'promptpay_payments'
|
|
1663
|
+
| 'revolut_pay_payments'
|
|
1664
|
+
| 'samsung_pay_payments'
|
|
1665
|
+
| 'sepa_bank_transfer_payments'
|
|
1666
|
+
| 'sepa_debit_payments'
|
|
1667
|
+
| 'swish_payments'
|
|
1668
|
+
| 'twint_payments'
|
|
1669
|
+
| 'us_bank_transfer_payments'
|
|
1670
|
+
| 'zip_payments';
|
|
1671
|
+
}
|
|
1672
|
+
}
|
|
1673
|
+
|
|
1674
|
+
/**
|
|
1675
|
+
* Occurs when an Account's merchant configuration is updated.
|
|
1676
|
+
*/
|
|
1677
|
+
export interface V2CoreAccountIncludingConfigurationMerchantUpdatedEvent
|
|
1678
|
+
extends V2.Core.EventBase {
|
|
1679
|
+
type: 'v2.core.account[configuration.merchant].updated';
|
|
1680
|
+
// Object containing the reference to API resource relevant to the event.
|
|
1681
|
+
related_object: V2.Core.Events.RelatedObject;
|
|
1682
|
+
// Retrieves the object associated with the event.
|
|
1683
|
+
fetchRelatedObject(): Promise<V2.Core.Account>;
|
|
1684
|
+
}
|
|
1685
|
+
export interface V2CoreAccountIncludingConfigurationMerchantUpdatedEventNotification
|
|
1686
|
+
extends V2.Core.EventNotificationBase {
|
|
1687
|
+
type: 'v2.core.account[configuration.merchant].updated';
|
|
1688
|
+
// Object containing the reference to API resource relevant to the event.
|
|
1689
|
+
related_object: V2.Core.Events.RelatedObject;
|
|
1690
|
+
// Retrieves the object associated with the event.
|
|
1691
|
+
fetchRelatedObject(): Promise<V2.Core.Account>;
|
|
1692
|
+
fetchEvent(): Promise<
|
|
1693
|
+
V2CoreAccountIncludingConfigurationMerchantUpdatedEvent
|
|
1694
|
+
>;
|
|
1695
|
+
}
|
|
1696
|
+
|
|
1697
|
+
/**
|
|
1698
|
+
* Occurs when the status of an Account's recipient configuration capability is updated.
|
|
1699
|
+
*/
|
|
1700
|
+
export interface V2CoreAccountIncludingConfigurationRecipientCapabilityStatusUpdatedEvent
|
|
1701
|
+
extends V2.Core.EventBase {
|
|
1702
|
+
type: 'v2.core.account[configuration.recipient].capability_status_updated';
|
|
1703
|
+
// Retrieves data specific to this event.
|
|
1704
|
+
data: V2CoreAccountIncludingConfigurationRecipientCapabilityStatusUpdatedEvent.Data;
|
|
1705
|
+
// Object containing the reference to API resource relevant to the event.
|
|
1706
|
+
related_object: V2.Core.Events.RelatedObject;
|
|
1707
|
+
// Retrieves the object associated with the event.
|
|
1708
|
+
fetchRelatedObject(): Promise<V2.Core.Account>;
|
|
1709
|
+
}
|
|
1710
|
+
export interface V2CoreAccountIncludingConfigurationRecipientCapabilityStatusUpdatedEventNotification
|
|
1711
|
+
extends V2.Core.EventNotificationBase {
|
|
1712
|
+
type: 'v2.core.account[configuration.recipient].capability_status_updated';
|
|
1713
|
+
// Object containing the reference to API resource relevant to the event.
|
|
1714
|
+
related_object: V2.Core.Events.RelatedObject;
|
|
1715
|
+
// Retrieves the object associated with the event.
|
|
1716
|
+
fetchRelatedObject(): Promise<V2.Core.Account>;
|
|
1717
|
+
fetchEvent(): Promise<
|
|
1718
|
+
V2CoreAccountIncludingConfigurationRecipientCapabilityStatusUpdatedEvent
|
|
1719
|
+
>;
|
|
1720
|
+
}
|
|
1721
|
+
|
|
1722
|
+
namespace V2CoreAccountIncludingConfigurationRecipientCapabilityStatusUpdatedEvent {
|
|
1723
|
+
export interface Data {
|
|
1724
|
+
/**
|
|
1725
|
+
* Open Enum. The capability which had its status updated.
|
|
1726
|
+
*/
|
|
1727
|
+
updated_capability: Data.UpdatedCapability;
|
|
1728
|
+
}
|
|
1729
|
+
|
|
1730
|
+
namespace Data {
|
|
1731
|
+
export type UpdatedCapability =
|
|
1732
|
+
| 'bank_accounts.local'
|
|
1733
|
+
| 'bank_accounts.wire'
|
|
1734
|
+
| 'cards'
|
|
1735
|
+
| 'crypto_wallets_v2'
|
|
1736
|
+
| 'stripe_balance.payouts'
|
|
1737
|
+
| 'stripe_balance.stripe_transfers'
|
|
1738
|
+
| 'stripe.transfers';
|
|
1739
|
+
}
|
|
1740
|
+
}
|
|
1741
|
+
|
|
1742
|
+
/**
|
|
1743
|
+
* Occurs when a Recipient's configuration is updated.
|
|
1744
|
+
*/
|
|
1745
|
+
export interface V2CoreAccountIncludingConfigurationRecipientUpdatedEvent
|
|
1746
|
+
extends V2.Core.EventBase {
|
|
1747
|
+
type: 'v2.core.account[configuration.recipient].updated';
|
|
1748
|
+
// Object containing the reference to API resource relevant to the event.
|
|
1749
|
+
related_object: V2.Core.Events.RelatedObject;
|
|
1750
|
+
// Retrieves the object associated with the event.
|
|
1751
|
+
fetchRelatedObject(): Promise<V2.Core.Account>;
|
|
1752
|
+
}
|
|
1753
|
+
export interface V2CoreAccountIncludingConfigurationRecipientUpdatedEventNotification
|
|
1754
|
+
extends V2.Core.EventNotificationBase {
|
|
1755
|
+
type: 'v2.core.account[configuration.recipient].updated';
|
|
1756
|
+
// Object containing the reference to API resource relevant to the event.
|
|
1757
|
+
related_object: V2.Core.Events.RelatedObject;
|
|
1758
|
+
// Retrieves the object associated with the event.
|
|
1759
|
+
fetchRelatedObject(): Promise<V2.Core.Account>;
|
|
1760
|
+
fetchEvent(): Promise<
|
|
1761
|
+
V2CoreAccountIncludingConfigurationRecipientUpdatedEvent
|
|
1762
|
+
>;
|
|
1763
|
+
}
|
|
1764
|
+
|
|
1765
|
+
/**
|
|
1766
|
+
* Occurs when the status of an Account's storer configuration capability is updated.
|
|
1767
|
+
*/
|
|
1768
|
+
export interface V2CoreAccountIncludingConfigurationStorerCapabilityStatusUpdatedEvent
|
|
1769
|
+
extends V2.Core.EventBase {
|
|
1770
|
+
type: 'v2.core.account[configuration.storer].capability_status_updated';
|
|
1771
|
+
// Retrieves data specific to this event.
|
|
1772
|
+
data: V2CoreAccountIncludingConfigurationStorerCapabilityStatusUpdatedEvent.Data;
|
|
1773
|
+
// Object containing the reference to API resource relevant to the event.
|
|
1774
|
+
related_object: V2.Core.Events.RelatedObject;
|
|
1775
|
+
// Retrieves the object associated with the event.
|
|
1776
|
+
fetchRelatedObject(): Promise<V2.Core.Account>;
|
|
1777
|
+
}
|
|
1778
|
+
export interface V2CoreAccountIncludingConfigurationStorerCapabilityStatusUpdatedEventNotification
|
|
1779
|
+
extends V2.Core.EventNotificationBase {
|
|
1780
|
+
type: 'v2.core.account[configuration.storer].capability_status_updated';
|
|
1781
|
+
// Object containing the reference to API resource relevant to the event.
|
|
1782
|
+
related_object: V2.Core.Events.RelatedObject;
|
|
1783
|
+
// Retrieves the object associated with the event.
|
|
1784
|
+
fetchRelatedObject(): Promise<V2.Core.Account>;
|
|
1785
|
+
fetchEvent(): Promise<
|
|
1786
|
+
V2CoreAccountIncludingConfigurationStorerCapabilityStatusUpdatedEvent
|
|
1787
|
+
>;
|
|
1788
|
+
}
|
|
1789
|
+
|
|
1790
|
+
namespace V2CoreAccountIncludingConfigurationStorerCapabilityStatusUpdatedEvent {
|
|
1791
|
+
export interface Data {
|
|
1792
|
+
/**
|
|
1793
|
+
* Open Enum. The capability which had its status updated.
|
|
1794
|
+
*/
|
|
1795
|
+
updated_capability: Data.UpdatedCapability;
|
|
1796
|
+
}
|
|
1797
|
+
|
|
1798
|
+
namespace Data {
|
|
1799
|
+
export type UpdatedCapability =
|
|
1800
|
+
| 'financial_addressses.bank_accounts'
|
|
1801
|
+
| 'financial_addressses.crypto_wallets'
|
|
1802
|
+
| 'holds_currencies.eur'
|
|
1803
|
+
| 'holds_currencies.gbp'
|
|
1804
|
+
| 'holds_currencies.usd'
|
|
1805
|
+
| 'holds_currencies.usdc'
|
|
1806
|
+
| 'inbound_transfers.bank_accounts'
|
|
1807
|
+
| 'outbound_payments.bank_accounts'
|
|
1808
|
+
| 'outbound_payments.cards'
|
|
1809
|
+
| 'outbound_payments.crypto_wallets'
|
|
1810
|
+
| 'outbound_payments.financial_accounts'
|
|
1811
|
+
| 'outbound_transfers.bank_accounts'
|
|
1812
|
+
| 'outbound_transfers.crypto_wallets'
|
|
1813
|
+
| 'outbound_transfers.financial_accounts';
|
|
1814
|
+
}
|
|
1815
|
+
}
|
|
1816
|
+
|
|
1817
|
+
/**
|
|
1818
|
+
* Occurs when a Storer's configuration is updated.
|
|
1819
|
+
*/
|
|
1820
|
+
export interface V2CoreAccountIncludingConfigurationStorerUpdatedEvent
|
|
1821
|
+
extends V2.Core.EventBase {
|
|
1822
|
+
type: 'v2.core.account[configuration.storer].updated';
|
|
1823
|
+
// Object containing the reference to API resource relevant to the event.
|
|
1824
|
+
related_object: V2.Core.Events.RelatedObject;
|
|
1825
|
+
// Retrieves the object associated with the event.
|
|
1826
|
+
fetchRelatedObject(): Promise<V2.Core.Account>;
|
|
1827
|
+
}
|
|
1828
|
+
export interface V2CoreAccountIncludingConfigurationStorerUpdatedEventNotification
|
|
1829
|
+
extends V2.Core.EventNotificationBase {
|
|
1830
|
+
type: 'v2.core.account[configuration.storer].updated';
|
|
1831
|
+
// Object containing the reference to API resource relevant to the event.
|
|
1832
|
+
related_object: V2.Core.Events.RelatedObject;
|
|
1833
|
+
// Retrieves the object associated with the event.
|
|
1834
|
+
fetchRelatedObject(): Promise<V2.Core.Account>;
|
|
1835
|
+
fetchEvent(): Promise<
|
|
1836
|
+
V2CoreAccountIncludingConfigurationStorerUpdatedEvent
|
|
1837
|
+
>;
|
|
1838
|
+
}
|
|
1839
|
+
|
|
1840
|
+
/**
|
|
1841
|
+
* This event occurs when account defaults are created or updated.
|
|
1842
|
+
*/
|
|
1843
|
+
export interface V2CoreAccountIncludingDefaultsUpdatedEvent
|
|
1844
|
+
extends V2.Core.EventBase {
|
|
1845
|
+
type: 'v2.core.account[defaults].updated';
|
|
1846
|
+
// Object containing the reference to API resource relevant to the event.
|
|
1847
|
+
related_object: V2.Core.Events.RelatedObject;
|
|
1848
|
+
// Retrieves the object associated with the event.
|
|
1849
|
+
fetchRelatedObject(): Promise<V2.Core.Account>;
|
|
1850
|
+
}
|
|
1851
|
+
export interface V2CoreAccountIncludingDefaultsUpdatedEventNotification
|
|
1852
|
+
extends V2.Core.EventNotificationBase {
|
|
1853
|
+
type: 'v2.core.account[defaults].updated';
|
|
1854
|
+
// Object containing the reference to API resource relevant to the event.
|
|
1855
|
+
related_object: V2.Core.Events.RelatedObject;
|
|
1856
|
+
// Retrieves the object associated with the event.
|
|
1857
|
+
fetchRelatedObject(): Promise<V2.Core.Account>;
|
|
1858
|
+
fetchEvent(): Promise<V2CoreAccountIncludingDefaultsUpdatedEvent>;
|
|
1859
|
+
}
|
|
1860
|
+
|
|
1861
|
+
/**
|
|
1862
|
+
* Occurs when an Identity is updated.
|
|
1863
|
+
*/
|
|
1864
|
+
export interface V2CoreAccountIncludingIdentityUpdatedEvent
|
|
1865
|
+
extends V2.Core.EventBase {
|
|
1866
|
+
type: 'v2.core.account[identity].updated';
|
|
1867
|
+
// Object containing the reference to API resource relevant to the event.
|
|
1868
|
+
related_object: V2.Core.Events.RelatedObject;
|
|
1869
|
+
// Retrieves the object associated with the event.
|
|
1870
|
+
fetchRelatedObject(): Promise<V2.Core.Account>;
|
|
1871
|
+
}
|
|
1872
|
+
export interface V2CoreAccountIncludingIdentityUpdatedEventNotification
|
|
1873
|
+
extends V2.Core.EventNotificationBase {
|
|
1874
|
+
type: 'v2.core.account[identity].updated';
|
|
1875
|
+
// Object containing the reference to API resource relevant to the event.
|
|
1876
|
+
related_object: V2.Core.Events.RelatedObject;
|
|
1877
|
+
// Retrieves the object associated with the event.
|
|
1878
|
+
fetchRelatedObject(): Promise<V2.Core.Account>;
|
|
1879
|
+
fetchEvent(): Promise<V2CoreAccountIncludingIdentityUpdatedEvent>;
|
|
1880
|
+
}
|
|
1881
|
+
|
|
1882
|
+
/**
|
|
1883
|
+
* Occurs when an Account's requirements are updated.
|
|
1884
|
+
*/
|
|
1885
|
+
export interface V2CoreAccountIncludingRequirementsUpdatedEvent
|
|
1886
|
+
extends V2.Core.EventBase {
|
|
1887
|
+
type: 'v2.core.account[requirements].updated';
|
|
1888
|
+
// Object containing the reference to API resource relevant to the event.
|
|
1889
|
+
related_object: V2.Core.Events.RelatedObject;
|
|
1890
|
+
// Retrieves the object associated with the event.
|
|
1891
|
+
fetchRelatedObject(): Promise<V2.Core.Account>;
|
|
1892
|
+
}
|
|
1893
|
+
export interface V2CoreAccountIncludingRequirementsUpdatedEventNotification
|
|
1894
|
+
extends V2.Core.EventNotificationBase {
|
|
1895
|
+
type: 'v2.core.account[requirements].updated';
|
|
1896
|
+
// Object containing the reference to API resource relevant to the event.
|
|
1897
|
+
related_object: V2.Core.Events.RelatedObject;
|
|
1898
|
+
// Retrieves the object associated with the event.
|
|
1899
|
+
fetchRelatedObject(): Promise<V2.Core.Account>;
|
|
1900
|
+
fetchEvent(): Promise<V2CoreAccountIncludingRequirementsUpdatedEvent>;
|
|
1901
|
+
}
|
|
1902
|
+
|
|
1903
|
+
/**
|
|
1904
|
+
* Occurs when the generated AccountLink is completed.
|
|
1905
|
+
*/
|
|
1906
|
+
export interface V2CoreAccountLinkReturnedEvent extends V2.Core.EventBase {
|
|
1907
|
+
type: 'v2.core.account_link.returned';
|
|
1908
|
+
// Retrieves data specific to this event.
|
|
1909
|
+
data: V2CoreAccountLinkReturnedEvent.Data;
|
|
1910
|
+
}
|
|
1911
|
+
export interface V2CoreAccountLinkReturnedEventNotification
|
|
1912
|
+
extends V2.Core.EventNotificationBase {
|
|
1913
|
+
type: 'v2.core.account_link.returned';
|
|
1914
|
+
fetchEvent(): Promise<V2CoreAccountLinkReturnedEvent>;
|
|
1915
|
+
}
|
|
1916
|
+
|
|
1917
|
+
namespace V2CoreAccountLinkReturnedEvent {
|
|
1918
|
+
export interface Data {
|
|
1919
|
+
/**
|
|
1920
|
+
* The ID of the v2 account.
|
|
1921
|
+
*/
|
|
1922
|
+
account_id: string;
|
|
1923
|
+
|
|
1924
|
+
/**
|
|
1925
|
+
* Configurations on the Account that was onboarded via the account link.
|
|
1926
|
+
*/
|
|
1927
|
+
configurations: Array<Data.Configuration>;
|
|
1928
|
+
|
|
1929
|
+
/**
|
|
1930
|
+
* Open Enum. The use case type of the account link that has been completed.
|
|
1931
|
+
*/
|
|
1932
|
+
use_case: Data.UseCase;
|
|
1933
|
+
}
|
|
1934
|
+
|
|
1935
|
+
namespace Data {
|
|
1936
|
+
export type Configuration =
|
|
1937
|
+
| 'customer'
|
|
1938
|
+
| 'merchant'
|
|
1939
|
+
| 'recipient'
|
|
1940
|
+
| 'storer';
|
|
1941
|
+
|
|
1942
|
+
export type UseCase = 'account_onboarding' | 'account_update';
|
|
1943
|
+
}
|
|
1944
|
+
}
|
|
1945
|
+
|
|
1946
|
+
/**
|
|
1947
|
+
* Occurs when a Person is created.
|
|
1948
|
+
*/
|
|
1949
|
+
export interface V2CoreAccountPersonCreatedEvent extends V2.Core.EventBase {
|
|
1950
|
+
type: 'v2.core.account_person.created';
|
|
1951
|
+
// Retrieves data specific to this event.
|
|
1952
|
+
data: V2CoreAccountPersonCreatedEvent.Data;
|
|
1953
|
+
// Object containing the reference to API resource relevant to the event.
|
|
1954
|
+
related_object: V2.Core.Events.RelatedObject;
|
|
1955
|
+
// Retrieves the object associated with the event.
|
|
1956
|
+
fetchRelatedObject(): Promise<V2.Core.AccountPerson>;
|
|
1957
|
+
}
|
|
1958
|
+
export interface V2CoreAccountPersonCreatedEventNotification
|
|
1959
|
+
extends V2.Core.EventNotificationBase {
|
|
1960
|
+
type: 'v2.core.account_person.created';
|
|
1961
|
+
// Object containing the reference to API resource relevant to the event.
|
|
1962
|
+
related_object: V2.Core.Events.RelatedObject;
|
|
1963
|
+
// Retrieves the object associated with the event.
|
|
1964
|
+
fetchRelatedObject(): Promise<V2.Core.AccountPerson>;
|
|
1965
|
+
fetchEvent(): Promise<V2CoreAccountPersonCreatedEvent>;
|
|
1966
|
+
}
|
|
1967
|
+
|
|
1968
|
+
namespace V2CoreAccountPersonCreatedEvent {
|
|
1969
|
+
export interface Data {
|
|
1970
|
+
/**
|
|
1971
|
+
* The ID of the v2 account.
|
|
1972
|
+
*/
|
|
1973
|
+
account_id: string;
|
|
1974
|
+
}
|
|
1975
|
+
}
|
|
1976
|
+
|
|
1977
|
+
/**
|
|
1978
|
+
* Occurs when a Person is deleted.
|
|
1979
|
+
*/
|
|
1980
|
+
export interface V2CoreAccountPersonDeletedEvent extends V2.Core.EventBase {
|
|
1981
|
+
type: 'v2.core.account_person.deleted';
|
|
1982
|
+
// Retrieves data specific to this event.
|
|
1983
|
+
data: V2CoreAccountPersonDeletedEvent.Data;
|
|
1984
|
+
// Object containing the reference to API resource relevant to the event.
|
|
1985
|
+
related_object: V2.Core.Events.RelatedObject;
|
|
1986
|
+
// Retrieves the object associated with the event.
|
|
1987
|
+
fetchRelatedObject(): Promise<V2.Core.AccountPerson>;
|
|
1988
|
+
}
|
|
1989
|
+
export interface V2CoreAccountPersonDeletedEventNotification
|
|
1990
|
+
extends V2.Core.EventNotificationBase {
|
|
1991
|
+
type: 'v2.core.account_person.deleted';
|
|
1992
|
+
// Object containing the reference to API resource relevant to the event.
|
|
1993
|
+
related_object: V2.Core.Events.RelatedObject;
|
|
1994
|
+
// Retrieves the object associated with the event.
|
|
1995
|
+
fetchRelatedObject(): Promise<V2.Core.AccountPerson>;
|
|
1996
|
+
fetchEvent(): Promise<V2CoreAccountPersonDeletedEvent>;
|
|
1997
|
+
}
|
|
1998
|
+
|
|
1999
|
+
namespace V2CoreAccountPersonDeletedEvent {
|
|
2000
|
+
export interface Data {
|
|
2001
|
+
/**
|
|
2002
|
+
* The ID of the v2 account.
|
|
2003
|
+
*/
|
|
2004
|
+
account_id: string;
|
|
2005
|
+
}
|
|
2006
|
+
}
|
|
2007
|
+
|
|
2008
|
+
/**
|
|
2009
|
+
* Occurs when a Person is updated.
|
|
2010
|
+
*/
|
|
2011
|
+
export interface V2CoreAccountPersonUpdatedEvent extends V2.Core.EventBase {
|
|
2012
|
+
type: 'v2.core.account_person.updated';
|
|
2013
|
+
// Retrieves data specific to this event.
|
|
2014
|
+
data: V2CoreAccountPersonUpdatedEvent.Data;
|
|
2015
|
+
// Object containing the reference to API resource relevant to the event.
|
|
2016
|
+
related_object: V2.Core.Events.RelatedObject;
|
|
2017
|
+
// Retrieves the object associated with the event.
|
|
2018
|
+
fetchRelatedObject(): Promise<V2.Core.AccountPerson>;
|
|
2019
|
+
}
|
|
2020
|
+
export interface V2CoreAccountPersonUpdatedEventNotification
|
|
2021
|
+
extends V2.Core.EventNotificationBase {
|
|
2022
|
+
type: 'v2.core.account_person.updated';
|
|
2023
|
+
// Object containing the reference to API resource relevant to the event.
|
|
2024
|
+
related_object: V2.Core.Events.RelatedObject;
|
|
2025
|
+
// Retrieves the object associated with the event.
|
|
2026
|
+
fetchRelatedObject(): Promise<V2.Core.AccountPerson>;
|
|
2027
|
+
fetchEvent(): Promise<V2CoreAccountPersonUpdatedEvent>;
|
|
2028
|
+
}
|
|
2029
|
+
|
|
2030
|
+
namespace V2CoreAccountPersonUpdatedEvent {
|
|
2031
|
+
export interface Data {
|
|
2032
|
+
/**
|
|
2033
|
+
* The ID of the v2 account.
|
|
2034
|
+
*/
|
|
2035
|
+
account_id: string;
|
|
2036
|
+
}
|
|
2037
|
+
}
|
|
2038
|
+
|
|
2039
|
+
/**
|
|
2040
|
+
* Occurs when a claimable sandbox is claimed.
|
|
2041
|
+
*/
|
|
2042
|
+
export interface V2CoreClaimableSandboxClaimedEvent
|
|
2043
|
+
extends V2.Core.EventBase {
|
|
2044
|
+
type: 'v2.core.claimable_sandbox.claimed';
|
|
2045
|
+
// Object containing the reference to API resource relevant to the event.
|
|
2046
|
+
related_object: V2.Core.Events.RelatedObject;
|
|
2047
|
+
// Retrieves the object associated with the event.
|
|
2048
|
+
fetchRelatedObject(): Promise<V2.Core.ClaimableSandbox>;
|
|
2049
|
+
}
|
|
2050
|
+
export interface V2CoreClaimableSandboxClaimedEventNotification
|
|
2051
|
+
extends V2.Core.EventNotificationBase {
|
|
2052
|
+
type: 'v2.core.claimable_sandbox.claimed';
|
|
2053
|
+
// Object containing the reference to API resource relevant to the event.
|
|
2054
|
+
related_object: V2.Core.Events.RelatedObject;
|
|
2055
|
+
// Retrieves the object associated with the event.
|
|
2056
|
+
fetchRelatedObject(): Promise<V2.Core.ClaimableSandbox>;
|
|
2057
|
+
fetchEvent(): Promise<V2CoreClaimableSandboxClaimedEvent>;
|
|
2058
|
+
}
|
|
2059
|
+
|
|
2060
|
+
/**
|
|
2061
|
+
* Occurs when a claimable sandbox is created.
|
|
2062
|
+
*/
|
|
2063
|
+
export interface V2CoreClaimableSandboxCreatedEvent
|
|
2064
|
+
extends V2.Core.EventBase {
|
|
2065
|
+
type: 'v2.core.claimable_sandbox.created';
|
|
2066
|
+
// Object containing the reference to API resource relevant to the event.
|
|
2067
|
+
related_object: V2.Core.Events.RelatedObject;
|
|
2068
|
+
// Retrieves the object associated with the event.
|
|
2069
|
+
fetchRelatedObject(): Promise<V2.Core.ClaimableSandbox>;
|
|
2070
|
+
}
|
|
2071
|
+
export interface V2CoreClaimableSandboxCreatedEventNotification
|
|
2072
|
+
extends V2.Core.EventNotificationBase {
|
|
2073
|
+
type: 'v2.core.claimable_sandbox.created';
|
|
2074
|
+
// Object containing the reference to API resource relevant to the event.
|
|
2075
|
+
related_object: V2.Core.Events.RelatedObject;
|
|
2076
|
+
// Retrieves the object associated with the event.
|
|
2077
|
+
fetchRelatedObject(): Promise<V2.Core.ClaimableSandbox>;
|
|
2078
|
+
fetchEvent(): Promise<V2CoreClaimableSandboxCreatedEvent>;
|
|
2079
|
+
}
|
|
2080
|
+
|
|
2081
|
+
/**
|
|
2082
|
+
* Occurs when a claimable sandbox expires.
|
|
2083
|
+
*/
|
|
2084
|
+
export interface V2CoreClaimableSandboxExpiredEvent
|
|
2085
|
+
extends V2.Core.EventBase {
|
|
2086
|
+
type: 'v2.core.claimable_sandbox.expired';
|
|
2087
|
+
// Object containing the reference to API resource relevant to the event.
|
|
2088
|
+
related_object: V2.Core.Events.RelatedObject;
|
|
2089
|
+
// Retrieves the object associated with the event.
|
|
2090
|
+
fetchRelatedObject(): Promise<V2.Core.ClaimableSandbox>;
|
|
2091
|
+
}
|
|
2092
|
+
export interface V2CoreClaimableSandboxExpiredEventNotification
|
|
2093
|
+
extends V2.Core.EventNotificationBase {
|
|
2094
|
+
type: 'v2.core.claimable_sandbox.expired';
|
|
2095
|
+
// Object containing the reference to API resource relevant to the event.
|
|
2096
|
+
related_object: V2.Core.Events.RelatedObject;
|
|
2097
|
+
// Retrieves the object associated with the event.
|
|
2098
|
+
fetchRelatedObject(): Promise<V2.Core.ClaimableSandbox>;
|
|
2099
|
+
fetchEvent(): Promise<V2CoreClaimableSandboxExpiredEvent>;
|
|
2100
|
+
}
|
|
2101
|
+
|
|
2102
|
+
/**
|
|
2103
|
+
* Occurs when a claimable sandbox is expiring in 7 days.
|
|
2104
|
+
*/
|
|
2105
|
+
export interface V2CoreClaimableSandboxExpiringEvent
|
|
2106
|
+
extends V2.Core.EventBase {
|
|
2107
|
+
type: 'v2.core.claimable_sandbox.expiring';
|
|
2108
|
+
// Object containing the reference to API resource relevant to the event.
|
|
2109
|
+
related_object: V2.Core.Events.RelatedObject;
|
|
2110
|
+
// Retrieves the object associated with the event.
|
|
2111
|
+
fetchRelatedObject(): Promise<V2.Core.ClaimableSandbox>;
|
|
2112
|
+
}
|
|
2113
|
+
export interface V2CoreClaimableSandboxExpiringEventNotification
|
|
2114
|
+
extends V2.Core.EventNotificationBase {
|
|
2115
|
+
type: 'v2.core.claimable_sandbox.expiring';
|
|
2116
|
+
// Object containing the reference to API resource relevant to the event.
|
|
2117
|
+
related_object: V2.Core.Events.RelatedObject;
|
|
2118
|
+
// Retrieves the object associated with the event.
|
|
2119
|
+
fetchRelatedObject(): Promise<V2.Core.ClaimableSandbox>;
|
|
2120
|
+
fetchEvent(): Promise<V2CoreClaimableSandboxExpiringEvent>;
|
|
2121
|
+
}
|
|
2122
|
+
|
|
2123
|
+
/**
|
|
2124
|
+
* Occurs when a claimable sandbox is activated by the user with the intention to go live and your Stripe app is installed on the live account.
|
|
2125
|
+
*/
|
|
2126
|
+
export interface V2CoreClaimableSandboxSandboxDetailsOwnerAccountUpdatedEvent
|
|
2127
|
+
extends V2.Core.EventBase {
|
|
2128
|
+
type: 'v2.core.claimable_sandbox.sandbox_details_owner_account_updated';
|
|
2129
|
+
// Object containing the reference to API resource relevant to the event.
|
|
2130
|
+
related_object: V2.Core.Events.RelatedObject;
|
|
2131
|
+
// Retrieves the object associated with the event.
|
|
2132
|
+
fetchRelatedObject(): Promise<V2.Core.ClaimableSandbox>;
|
|
2133
|
+
}
|
|
2134
|
+
export interface V2CoreClaimableSandboxSandboxDetailsOwnerAccountUpdatedEventNotification
|
|
2135
|
+
extends V2.Core.EventNotificationBase {
|
|
2136
|
+
type: 'v2.core.claimable_sandbox.sandbox_details_owner_account_updated';
|
|
2137
|
+
// Object containing the reference to API resource relevant to the event.
|
|
2138
|
+
related_object: V2.Core.Events.RelatedObject;
|
|
2139
|
+
// Retrieves the object associated with the event.
|
|
2140
|
+
fetchRelatedObject(): Promise<V2.Core.ClaimableSandbox>;
|
|
2141
|
+
fetchEvent(): Promise<
|
|
2142
|
+
V2CoreClaimableSandboxSandboxDetailsOwnerAccountUpdatedEvent
|
|
2143
|
+
>;
|
|
2144
|
+
}
|
|
2145
|
+
|
|
236
2146
|
/**
|
|
237
2147
|
* A ping event used to test the connection to an EventDestination.
|
|
238
2148
|
*/
|
|
239
|
-
export interface V2CoreEventDestinationPingEvent extends V2.Core.EventBase {
|
|
240
|
-
type: 'v2.core.event_destination.ping';
|
|
2149
|
+
export interface V2CoreEventDestinationPingEvent extends V2.Core.EventBase {
|
|
2150
|
+
type: 'v2.core.event_destination.ping';
|
|
2151
|
+
// Object containing the reference to API resource relevant to the event.
|
|
2152
|
+
related_object: V2.Core.Events.RelatedObject;
|
|
2153
|
+
// Retrieves the object associated with the event.
|
|
2154
|
+
fetchRelatedObject(): Promise<V2.Core.EventDestination>;
|
|
2155
|
+
}
|
|
2156
|
+
export interface V2CoreEventDestinationPingEventNotification
|
|
2157
|
+
extends V2.Core.EventNotificationBase {
|
|
2158
|
+
type: 'v2.core.event_destination.ping';
|
|
2159
|
+
// Object containing the reference to API resource relevant to the event.
|
|
2160
|
+
related_object: V2.Core.Events.RelatedObject;
|
|
2161
|
+
// Retrieves the object associated with the event.
|
|
2162
|
+
fetchRelatedObject(): Promise<V2.Core.EventDestination>;
|
|
2163
|
+
fetchEvent(): Promise<V2CoreEventDestinationPingEvent>;
|
|
2164
|
+
}
|
|
2165
|
+
|
|
2166
|
+
/**
|
|
2167
|
+
* Occurs when an API error alert is firing.
|
|
2168
|
+
*/
|
|
2169
|
+
export interface V2CoreHealthApiErrorFiringEvent extends V2.Core.EventBase {
|
|
2170
|
+
type: 'v2.core.health.api_error.firing';
|
|
2171
|
+
// Retrieves data specific to this event.
|
|
2172
|
+
data: V2CoreHealthApiErrorFiringEvent.Data;
|
|
2173
|
+
}
|
|
2174
|
+
export interface V2CoreHealthApiErrorFiringEventNotification
|
|
2175
|
+
extends V2.Core.EventNotificationBase {
|
|
2176
|
+
type: 'v2.core.health.api_error.firing';
|
|
2177
|
+
fetchEvent(): Promise<V2CoreHealthApiErrorFiringEvent>;
|
|
2178
|
+
}
|
|
2179
|
+
|
|
2180
|
+
namespace V2CoreHealthApiErrorFiringEvent {
|
|
2181
|
+
export interface Data {
|
|
2182
|
+
/**
|
|
2183
|
+
* The alert ID.
|
|
2184
|
+
*/
|
|
2185
|
+
alert_id: string;
|
|
2186
|
+
|
|
2187
|
+
/**
|
|
2188
|
+
* The grouping key for the alert.
|
|
2189
|
+
*/
|
|
2190
|
+
grouping_key: string;
|
|
2191
|
+
|
|
2192
|
+
/**
|
|
2193
|
+
* The user impact.
|
|
2194
|
+
*/
|
|
2195
|
+
impact: Data.Impact;
|
|
2196
|
+
|
|
2197
|
+
/**
|
|
2198
|
+
* The time when impact on the user experience was first detected.
|
|
2199
|
+
*/
|
|
2200
|
+
started_at: string;
|
|
2201
|
+
|
|
2202
|
+
/**
|
|
2203
|
+
* A short description of the alert.
|
|
2204
|
+
*/
|
|
2205
|
+
summary: string;
|
|
2206
|
+
}
|
|
2207
|
+
|
|
2208
|
+
namespace Data {
|
|
2209
|
+
export interface Impact {
|
|
2210
|
+
/**
|
|
2211
|
+
* The canonical path.
|
|
2212
|
+
*/
|
|
2213
|
+
canonical_path: string;
|
|
2214
|
+
|
|
2215
|
+
/**
|
|
2216
|
+
* The error code.
|
|
2217
|
+
*/
|
|
2218
|
+
error_code?: string;
|
|
2219
|
+
|
|
2220
|
+
/**
|
|
2221
|
+
* The HTTP method.
|
|
2222
|
+
*/
|
|
2223
|
+
http_method: Impact.HttpMethod;
|
|
2224
|
+
|
|
2225
|
+
/**
|
|
2226
|
+
* The HTTP status.
|
|
2227
|
+
*/
|
|
2228
|
+
http_status: string;
|
|
2229
|
+
|
|
2230
|
+
/**
|
|
2231
|
+
* The number of impacted requests.
|
|
2232
|
+
*/
|
|
2233
|
+
impacted_requests: number;
|
|
2234
|
+
|
|
2235
|
+
/**
|
|
2236
|
+
* The percentage of impacted requests.
|
|
2237
|
+
*/
|
|
2238
|
+
impacted_requests_percentage?: string;
|
|
2239
|
+
}
|
|
2240
|
+
|
|
2241
|
+
namespace Impact {
|
|
2242
|
+
export type HttpMethod = 'DELETE' | 'GET' | 'POST' | 'PUT';
|
|
2243
|
+
}
|
|
2244
|
+
}
|
|
2245
|
+
}
|
|
2246
|
+
|
|
2247
|
+
/**
|
|
2248
|
+
* Occurs when an API error alert is resolved.
|
|
2249
|
+
*/
|
|
2250
|
+
export interface V2CoreHealthApiErrorResolvedEvent
|
|
2251
|
+
extends V2.Core.EventBase {
|
|
2252
|
+
type: 'v2.core.health.api_error.resolved';
|
|
2253
|
+
// Retrieves data specific to this event.
|
|
2254
|
+
data: V2CoreHealthApiErrorResolvedEvent.Data;
|
|
2255
|
+
}
|
|
2256
|
+
export interface V2CoreHealthApiErrorResolvedEventNotification
|
|
2257
|
+
extends V2.Core.EventNotificationBase {
|
|
2258
|
+
type: 'v2.core.health.api_error.resolved';
|
|
2259
|
+
fetchEvent(): Promise<V2CoreHealthApiErrorResolvedEvent>;
|
|
2260
|
+
}
|
|
2261
|
+
|
|
2262
|
+
namespace V2CoreHealthApiErrorResolvedEvent {
|
|
2263
|
+
export interface Data {
|
|
2264
|
+
/**
|
|
2265
|
+
* The grouping key for the alert.
|
|
2266
|
+
*/
|
|
2267
|
+
grouping_key: string;
|
|
2268
|
+
|
|
2269
|
+
/**
|
|
2270
|
+
* The user impact.
|
|
2271
|
+
*/
|
|
2272
|
+
impact: Data.Impact;
|
|
2273
|
+
|
|
2274
|
+
/**
|
|
2275
|
+
* The time when the user experience has returned to expected levels.
|
|
2276
|
+
*/
|
|
2277
|
+
resolved_at: string;
|
|
2278
|
+
|
|
2279
|
+
/**
|
|
2280
|
+
* The time when impact on the user experience was first detected.
|
|
2281
|
+
*/
|
|
2282
|
+
started_at: string;
|
|
2283
|
+
|
|
2284
|
+
/**
|
|
2285
|
+
* A short description of the alert.
|
|
2286
|
+
*/
|
|
2287
|
+
summary: string;
|
|
2288
|
+
}
|
|
2289
|
+
|
|
2290
|
+
namespace Data {
|
|
2291
|
+
export interface Impact {
|
|
2292
|
+
/**
|
|
2293
|
+
* The canonical path.
|
|
2294
|
+
*/
|
|
2295
|
+
canonical_path: string;
|
|
2296
|
+
|
|
2297
|
+
/**
|
|
2298
|
+
* The error code.
|
|
2299
|
+
*/
|
|
2300
|
+
error_code?: string;
|
|
2301
|
+
|
|
2302
|
+
/**
|
|
2303
|
+
* The HTTP method.
|
|
2304
|
+
*/
|
|
2305
|
+
http_method: Impact.HttpMethod;
|
|
2306
|
+
|
|
2307
|
+
/**
|
|
2308
|
+
* The HTTP status.
|
|
2309
|
+
*/
|
|
2310
|
+
http_status: string;
|
|
2311
|
+
|
|
2312
|
+
/**
|
|
2313
|
+
* The number of impacted requests.
|
|
2314
|
+
*/
|
|
2315
|
+
impacted_requests: number;
|
|
2316
|
+
|
|
2317
|
+
/**
|
|
2318
|
+
* The percentage of impacted requests.
|
|
2319
|
+
*/
|
|
2320
|
+
impacted_requests_percentage?: string;
|
|
2321
|
+
}
|
|
2322
|
+
|
|
2323
|
+
namespace Impact {
|
|
2324
|
+
export type HttpMethod = 'DELETE' | 'GET' | 'POST' | 'PUT';
|
|
2325
|
+
}
|
|
2326
|
+
}
|
|
2327
|
+
}
|
|
2328
|
+
|
|
2329
|
+
/**
|
|
2330
|
+
* Occurs when an API latency alert is firing.
|
|
2331
|
+
*/
|
|
2332
|
+
export interface V2CoreHealthApiLatencyFiringEvent
|
|
2333
|
+
extends V2.Core.EventBase {
|
|
2334
|
+
type: 'v2.core.health.api_latency.firing';
|
|
2335
|
+
// Retrieves data specific to this event.
|
|
2336
|
+
data: V2CoreHealthApiLatencyFiringEvent.Data;
|
|
2337
|
+
}
|
|
2338
|
+
export interface V2CoreHealthApiLatencyFiringEventNotification
|
|
2339
|
+
extends V2.Core.EventNotificationBase {
|
|
2340
|
+
type: 'v2.core.health.api_latency.firing';
|
|
2341
|
+
fetchEvent(): Promise<V2CoreHealthApiLatencyFiringEvent>;
|
|
2342
|
+
}
|
|
2343
|
+
|
|
2344
|
+
namespace V2CoreHealthApiLatencyFiringEvent {
|
|
2345
|
+
export interface Data {
|
|
2346
|
+
/**
|
|
2347
|
+
* The alert ID.
|
|
2348
|
+
*/
|
|
2349
|
+
alert_id: string;
|
|
2350
|
+
|
|
2351
|
+
/**
|
|
2352
|
+
* The grouping key for the alert.
|
|
2353
|
+
*/
|
|
2354
|
+
grouping_key: string;
|
|
2355
|
+
|
|
2356
|
+
/**
|
|
2357
|
+
* The user impact.
|
|
2358
|
+
*/
|
|
2359
|
+
impact: Data.Impact;
|
|
2360
|
+
|
|
2361
|
+
/**
|
|
2362
|
+
* The time when impact on the user experience was first detected.
|
|
2363
|
+
*/
|
|
2364
|
+
started_at: string;
|
|
2365
|
+
|
|
2366
|
+
/**
|
|
2367
|
+
* A short description of the alert.
|
|
2368
|
+
*/
|
|
2369
|
+
summary: string;
|
|
2370
|
+
}
|
|
2371
|
+
|
|
2372
|
+
namespace Data {
|
|
2373
|
+
export interface Impact {
|
|
2374
|
+
/**
|
|
2375
|
+
* The canonical path.
|
|
2376
|
+
*/
|
|
2377
|
+
canonical_path: string;
|
|
2378
|
+
|
|
2379
|
+
/**
|
|
2380
|
+
* The HTTP method.
|
|
2381
|
+
*/
|
|
2382
|
+
http_method: Impact.HttpMethod;
|
|
2383
|
+
|
|
2384
|
+
/**
|
|
2385
|
+
* The HTTP status.
|
|
2386
|
+
*/
|
|
2387
|
+
http_status: string;
|
|
2388
|
+
|
|
2389
|
+
/**
|
|
2390
|
+
* The number of impacted requests.
|
|
2391
|
+
*/
|
|
2392
|
+
impacted_requests: number;
|
|
2393
|
+
|
|
2394
|
+
/**
|
|
2395
|
+
* The percentage of impacted requests.
|
|
2396
|
+
*/
|
|
2397
|
+
impacted_requests_percentage?: string;
|
|
2398
|
+
}
|
|
2399
|
+
|
|
2400
|
+
namespace Impact {
|
|
2401
|
+
export type HttpMethod = 'DELETE' | 'GET' | 'POST' | 'PUT';
|
|
2402
|
+
}
|
|
2403
|
+
}
|
|
2404
|
+
}
|
|
2405
|
+
|
|
2406
|
+
/**
|
|
2407
|
+
* Occurs when an API latency alert is resolved.
|
|
2408
|
+
*/
|
|
2409
|
+
export interface V2CoreHealthApiLatencyResolvedEvent
|
|
2410
|
+
extends V2.Core.EventBase {
|
|
2411
|
+
type: 'v2.core.health.api_latency.resolved';
|
|
2412
|
+
// Retrieves data specific to this event.
|
|
2413
|
+
data: V2CoreHealthApiLatencyResolvedEvent.Data;
|
|
2414
|
+
}
|
|
2415
|
+
export interface V2CoreHealthApiLatencyResolvedEventNotification
|
|
2416
|
+
extends V2.Core.EventNotificationBase {
|
|
2417
|
+
type: 'v2.core.health.api_latency.resolved';
|
|
2418
|
+
fetchEvent(): Promise<V2CoreHealthApiLatencyResolvedEvent>;
|
|
2419
|
+
}
|
|
2420
|
+
|
|
2421
|
+
namespace V2CoreHealthApiLatencyResolvedEvent {
|
|
2422
|
+
export interface Data {
|
|
2423
|
+
/**
|
|
2424
|
+
* The grouping key for the alert.
|
|
2425
|
+
*/
|
|
2426
|
+
grouping_key: string;
|
|
2427
|
+
|
|
2428
|
+
/**
|
|
2429
|
+
* The user impact.
|
|
2430
|
+
*/
|
|
2431
|
+
impact: Data.Impact;
|
|
2432
|
+
|
|
2433
|
+
/**
|
|
2434
|
+
* The time when the user experience has returned to expected levels.
|
|
2435
|
+
*/
|
|
2436
|
+
resolved_at: string;
|
|
2437
|
+
|
|
2438
|
+
/**
|
|
2439
|
+
* The time when impact on the user experience was first detected.
|
|
2440
|
+
*/
|
|
2441
|
+
started_at: string;
|
|
2442
|
+
|
|
2443
|
+
/**
|
|
2444
|
+
* A short description of the alert.
|
|
2445
|
+
*/
|
|
2446
|
+
summary: string;
|
|
2447
|
+
}
|
|
2448
|
+
|
|
2449
|
+
namespace Data {
|
|
2450
|
+
export interface Impact {
|
|
2451
|
+
/**
|
|
2452
|
+
* The canonical path.
|
|
2453
|
+
*/
|
|
2454
|
+
canonical_path: string;
|
|
2455
|
+
|
|
2456
|
+
/**
|
|
2457
|
+
* The HTTP method.
|
|
2458
|
+
*/
|
|
2459
|
+
http_method: Impact.HttpMethod;
|
|
2460
|
+
|
|
2461
|
+
/**
|
|
2462
|
+
* The HTTP status.
|
|
2463
|
+
*/
|
|
2464
|
+
http_status: string;
|
|
2465
|
+
|
|
2466
|
+
/**
|
|
2467
|
+
* The number of impacted requests.
|
|
2468
|
+
*/
|
|
2469
|
+
impacted_requests: number;
|
|
2470
|
+
|
|
2471
|
+
/**
|
|
2472
|
+
* The percentage of impacted requests.
|
|
2473
|
+
*/
|
|
2474
|
+
impacted_requests_percentage?: string;
|
|
2475
|
+
}
|
|
2476
|
+
|
|
2477
|
+
namespace Impact {
|
|
2478
|
+
export type HttpMethod = 'DELETE' | 'GET' | 'POST' | 'PUT';
|
|
2479
|
+
}
|
|
2480
|
+
}
|
|
2481
|
+
}
|
|
2482
|
+
|
|
2483
|
+
/**
|
|
2484
|
+
* Occurs when an authorization rate drop alert is firing.
|
|
2485
|
+
*/
|
|
2486
|
+
export interface V2CoreHealthAuthorizationRateDropFiringEvent
|
|
2487
|
+
extends V2.Core.EventBase {
|
|
2488
|
+
type: 'v2.core.health.authorization_rate_drop.firing';
|
|
2489
|
+
// Retrieves data specific to this event.
|
|
2490
|
+
data: V2CoreHealthAuthorizationRateDropFiringEvent.Data;
|
|
2491
|
+
}
|
|
2492
|
+
export interface V2CoreHealthAuthorizationRateDropFiringEventNotification
|
|
2493
|
+
extends V2.Core.EventNotificationBase {
|
|
2494
|
+
type: 'v2.core.health.authorization_rate_drop.firing';
|
|
2495
|
+
fetchEvent(): Promise<V2CoreHealthAuthorizationRateDropFiringEvent>;
|
|
2496
|
+
}
|
|
2497
|
+
|
|
2498
|
+
namespace V2CoreHealthAuthorizationRateDropFiringEvent {
|
|
2499
|
+
export interface Data {
|
|
2500
|
+
/**
|
|
2501
|
+
* The alert ID.
|
|
2502
|
+
*/
|
|
2503
|
+
alert_id: string;
|
|
2504
|
+
|
|
2505
|
+
/**
|
|
2506
|
+
* The grouping key for the alert.
|
|
2507
|
+
*/
|
|
2508
|
+
grouping_key: string;
|
|
2509
|
+
|
|
2510
|
+
/**
|
|
2511
|
+
* The user impact.
|
|
2512
|
+
*/
|
|
2513
|
+
impact: Data.Impact;
|
|
2514
|
+
|
|
2515
|
+
/**
|
|
2516
|
+
* The time when impact on the user experience was first detected.
|
|
2517
|
+
*/
|
|
2518
|
+
started_at: string;
|
|
2519
|
+
|
|
2520
|
+
/**
|
|
2521
|
+
* A short description of the alert.
|
|
2522
|
+
*/
|
|
2523
|
+
summary: string;
|
|
2524
|
+
}
|
|
2525
|
+
|
|
2526
|
+
namespace Data {
|
|
2527
|
+
export interface Impact {
|
|
2528
|
+
/**
|
|
2529
|
+
* The type of the charge.
|
|
2530
|
+
*/
|
|
2531
|
+
charge_type: Impact.ChargeType;
|
|
2532
|
+
|
|
2533
|
+
/**
|
|
2534
|
+
* The current authorization rate percentage.
|
|
2535
|
+
*/
|
|
2536
|
+
current_percentage: string;
|
|
2537
|
+
|
|
2538
|
+
/**
|
|
2539
|
+
* Dimensions that describe what subset of payments are impacted.
|
|
2540
|
+
*/
|
|
2541
|
+
dimensions?: Array<Impact.Dimension>;
|
|
2542
|
+
|
|
2543
|
+
/**
|
|
2544
|
+
* The type of the payment method.
|
|
2545
|
+
*/
|
|
2546
|
+
payment_method_type: Impact.PaymentMethodType;
|
|
2547
|
+
|
|
2548
|
+
/**
|
|
2549
|
+
* The previous authorization rate percentage.
|
|
2550
|
+
*/
|
|
2551
|
+
previous_percentage: string;
|
|
2552
|
+
}
|
|
2553
|
+
|
|
2554
|
+
namespace Impact {
|
|
2555
|
+
export type ChargeType = 'money_moving' | 'validation';
|
|
2556
|
+
|
|
2557
|
+
export interface Dimension {
|
|
2558
|
+
/**
|
|
2559
|
+
* The issuer dimension.
|
|
2560
|
+
*/
|
|
2561
|
+
issuer?: string;
|
|
2562
|
+
|
|
2563
|
+
/**
|
|
2564
|
+
* The type of the dimension.
|
|
2565
|
+
*/
|
|
2566
|
+
type: 'issuer';
|
|
2567
|
+
}
|
|
2568
|
+
|
|
2569
|
+
export type PaymentMethodType =
|
|
2570
|
+
| 'acss_debit'
|
|
2571
|
+
| 'affirm'
|
|
2572
|
+
| 'afterpay_clearpay'
|
|
2573
|
+
| 'alipay'
|
|
2574
|
+
| 'alma'
|
|
2575
|
+
| 'amazon_pay'
|
|
2576
|
+
| 'apple_pay'
|
|
2577
|
+
| 'au_becs_debit'
|
|
2578
|
+
| 'bacs_debit'
|
|
2579
|
+
| 'bancontact'
|
|
2580
|
+
| 'billie'
|
|
2581
|
+
| 'blik'
|
|
2582
|
+
| 'boleto'
|
|
2583
|
+
| 'card'
|
|
2584
|
+
| 'card_present'
|
|
2585
|
+
| 'cartes_bancaires'
|
|
2586
|
+
| 'cashapp'
|
|
2587
|
+
| 'crypto'
|
|
2588
|
+
| 'dummy_passthrough_card'
|
|
2589
|
+
| 'eps'
|
|
2590
|
+
| 'fpx'
|
|
2591
|
+
| 'giropay'
|
|
2592
|
+
| 'grabpay'
|
|
2593
|
+
| 'ideal'
|
|
2594
|
+
| 'interac_present'
|
|
2595
|
+
| 'kakao_pay'
|
|
2596
|
+
| 'klarna'
|
|
2597
|
+
| 'konbini'
|
|
2598
|
+
| 'kriya'
|
|
2599
|
+
| 'kr_card'
|
|
2600
|
+
| 'link'
|
|
2601
|
+
| 'mb_way'
|
|
2602
|
+
| 'mobilepay'
|
|
2603
|
+
| 'mondu'
|
|
2604
|
+
| 'multibanco'
|
|
2605
|
+
| 'naver_pay'
|
|
2606
|
+
| 'ng_bank'
|
|
2607
|
+
| 'ng_bank_transfer'
|
|
2608
|
+
| 'ng_card'
|
|
2609
|
+
| 'ng_market'
|
|
2610
|
+
| 'ng_ussd'
|
|
2611
|
+
| 'ng_wallet'
|
|
2612
|
+
| 'oxxo'
|
|
2613
|
+
| 'p24'
|
|
2614
|
+
| 'paper_check'
|
|
2615
|
+
| 'payco'
|
|
2616
|
+
| 'paynow'
|
|
2617
|
+
| 'paypal'
|
|
2618
|
+
| 'paypay'
|
|
2619
|
+
| 'payto'
|
|
2620
|
+
| 'pay_by_bank'
|
|
2621
|
+
| 'pix'
|
|
2622
|
+
| 'promptpay'
|
|
2623
|
+
| 'rechnung'
|
|
2624
|
+
| 'revolut_pay'
|
|
2625
|
+
| 'samsung_pay'
|
|
2626
|
+
| 'satispay'
|
|
2627
|
+
| 'scalapay'
|
|
2628
|
+
| 'sepa_debit'
|
|
2629
|
+
| 'sequra'
|
|
2630
|
+
| 'sofort'
|
|
2631
|
+
| 'sunbit'
|
|
2632
|
+
| 'swish'
|
|
2633
|
+
| 'twint'
|
|
2634
|
+
| 'upi'
|
|
2635
|
+
| 'us_bank_account'
|
|
2636
|
+
| 'vipps'
|
|
2637
|
+
| 'wechat_pay'
|
|
2638
|
+
| 'zip';
|
|
2639
|
+
}
|
|
2640
|
+
}
|
|
2641
|
+
}
|
|
2642
|
+
|
|
2643
|
+
/**
|
|
2644
|
+
* Occurs when an authorization rate drop alert is resolved.
|
|
2645
|
+
*/
|
|
2646
|
+
export interface V2CoreHealthAuthorizationRateDropResolvedEvent
|
|
2647
|
+
extends V2.Core.EventBase {
|
|
2648
|
+
type: 'v2.core.health.authorization_rate_drop.resolved';
|
|
2649
|
+
// Retrieves data specific to this event.
|
|
2650
|
+
data: V2CoreHealthAuthorizationRateDropResolvedEvent.Data;
|
|
2651
|
+
}
|
|
2652
|
+
export interface V2CoreHealthAuthorizationRateDropResolvedEventNotification
|
|
2653
|
+
extends V2.Core.EventNotificationBase {
|
|
2654
|
+
type: 'v2.core.health.authorization_rate_drop.resolved';
|
|
2655
|
+
fetchEvent(): Promise<V2CoreHealthAuthorizationRateDropResolvedEvent>;
|
|
2656
|
+
}
|
|
2657
|
+
|
|
2658
|
+
namespace V2CoreHealthAuthorizationRateDropResolvedEvent {
|
|
2659
|
+
export interface Data {
|
|
2660
|
+
/**
|
|
2661
|
+
* The grouping key for the alert.
|
|
2662
|
+
*/
|
|
2663
|
+
grouping_key: string;
|
|
2664
|
+
|
|
2665
|
+
/**
|
|
2666
|
+
* The user impact.
|
|
2667
|
+
*/
|
|
2668
|
+
impact: Data.Impact;
|
|
2669
|
+
|
|
2670
|
+
/**
|
|
2671
|
+
* The time when the user experience has returned to expected levels.
|
|
2672
|
+
*/
|
|
2673
|
+
resolved_at: string;
|
|
2674
|
+
|
|
2675
|
+
/**
|
|
2676
|
+
* The time when impact on the user experience was first detected.
|
|
2677
|
+
*/
|
|
2678
|
+
started_at: string;
|
|
2679
|
+
|
|
2680
|
+
/**
|
|
2681
|
+
* A short description of the alert.
|
|
2682
|
+
*/
|
|
2683
|
+
summary: string;
|
|
2684
|
+
}
|
|
2685
|
+
|
|
2686
|
+
namespace Data {
|
|
2687
|
+
export interface Impact {
|
|
2688
|
+
/**
|
|
2689
|
+
* The type of the charge.
|
|
2690
|
+
*/
|
|
2691
|
+
charge_type: Impact.ChargeType;
|
|
2692
|
+
|
|
2693
|
+
/**
|
|
2694
|
+
* The current authorization rate percentage.
|
|
2695
|
+
*/
|
|
2696
|
+
current_percentage: string;
|
|
2697
|
+
|
|
2698
|
+
/**
|
|
2699
|
+
* Dimensions that describe what subset of payments are impacted.
|
|
2700
|
+
*/
|
|
2701
|
+
dimensions?: Array<Impact.Dimension>;
|
|
2702
|
+
|
|
2703
|
+
/**
|
|
2704
|
+
* The type of the payment method.
|
|
2705
|
+
*/
|
|
2706
|
+
payment_method_type: Impact.PaymentMethodType;
|
|
2707
|
+
|
|
2708
|
+
/**
|
|
2709
|
+
* The previous authorization rate percentage.
|
|
2710
|
+
*/
|
|
2711
|
+
previous_percentage: string;
|
|
2712
|
+
}
|
|
2713
|
+
|
|
2714
|
+
namespace Impact {
|
|
2715
|
+
export type ChargeType = 'money_moving' | 'validation';
|
|
2716
|
+
|
|
2717
|
+
export interface Dimension {
|
|
2718
|
+
/**
|
|
2719
|
+
* The issuer dimension.
|
|
2720
|
+
*/
|
|
2721
|
+
issuer?: string;
|
|
2722
|
+
|
|
2723
|
+
/**
|
|
2724
|
+
* The type of the dimension.
|
|
2725
|
+
*/
|
|
2726
|
+
type: 'issuer';
|
|
2727
|
+
}
|
|
2728
|
+
|
|
2729
|
+
export type PaymentMethodType =
|
|
2730
|
+
| 'acss_debit'
|
|
2731
|
+
| 'affirm'
|
|
2732
|
+
| 'afterpay_clearpay'
|
|
2733
|
+
| 'alipay'
|
|
2734
|
+
| 'alma'
|
|
2735
|
+
| 'amazon_pay'
|
|
2736
|
+
| 'apple_pay'
|
|
2737
|
+
| 'au_becs_debit'
|
|
2738
|
+
| 'bacs_debit'
|
|
2739
|
+
| 'bancontact'
|
|
2740
|
+
| 'billie'
|
|
2741
|
+
| 'blik'
|
|
2742
|
+
| 'boleto'
|
|
2743
|
+
| 'card'
|
|
2744
|
+
| 'card_present'
|
|
2745
|
+
| 'cartes_bancaires'
|
|
2746
|
+
| 'cashapp'
|
|
2747
|
+
| 'crypto'
|
|
2748
|
+
| 'dummy_passthrough_card'
|
|
2749
|
+
| 'eps'
|
|
2750
|
+
| 'fpx'
|
|
2751
|
+
| 'giropay'
|
|
2752
|
+
| 'grabpay'
|
|
2753
|
+
| 'ideal'
|
|
2754
|
+
| 'interac_present'
|
|
2755
|
+
| 'kakao_pay'
|
|
2756
|
+
| 'klarna'
|
|
2757
|
+
| 'konbini'
|
|
2758
|
+
| 'kriya'
|
|
2759
|
+
| 'kr_card'
|
|
2760
|
+
| 'link'
|
|
2761
|
+
| 'mb_way'
|
|
2762
|
+
| 'mobilepay'
|
|
2763
|
+
| 'mondu'
|
|
2764
|
+
| 'multibanco'
|
|
2765
|
+
| 'naver_pay'
|
|
2766
|
+
| 'ng_bank'
|
|
2767
|
+
| 'ng_bank_transfer'
|
|
2768
|
+
| 'ng_card'
|
|
2769
|
+
| 'ng_market'
|
|
2770
|
+
| 'ng_ussd'
|
|
2771
|
+
| 'ng_wallet'
|
|
2772
|
+
| 'oxxo'
|
|
2773
|
+
| 'p24'
|
|
2774
|
+
| 'paper_check'
|
|
2775
|
+
| 'payco'
|
|
2776
|
+
| 'paynow'
|
|
2777
|
+
| 'paypal'
|
|
2778
|
+
| 'paypay'
|
|
2779
|
+
| 'payto'
|
|
2780
|
+
| 'pay_by_bank'
|
|
2781
|
+
| 'pix'
|
|
2782
|
+
| 'promptpay'
|
|
2783
|
+
| 'rechnung'
|
|
2784
|
+
| 'revolut_pay'
|
|
2785
|
+
| 'samsung_pay'
|
|
2786
|
+
| 'satispay'
|
|
2787
|
+
| 'scalapay'
|
|
2788
|
+
| 'sepa_debit'
|
|
2789
|
+
| 'sequra'
|
|
2790
|
+
| 'sofort'
|
|
2791
|
+
| 'sunbit'
|
|
2792
|
+
| 'swish'
|
|
2793
|
+
| 'twint'
|
|
2794
|
+
| 'upi'
|
|
2795
|
+
| 'us_bank_account'
|
|
2796
|
+
| 'vipps'
|
|
2797
|
+
| 'wechat_pay'
|
|
2798
|
+
| 'zip';
|
|
2799
|
+
}
|
|
2800
|
+
}
|
|
2801
|
+
}
|
|
2802
|
+
|
|
2803
|
+
/**
|
|
2804
|
+
* Occurs when an event generation failure alert is resolved.
|
|
2805
|
+
*/
|
|
2806
|
+
export interface V2CoreHealthEventGenerationFailureResolvedEvent
|
|
2807
|
+
extends V2.Core.EventBase {
|
|
2808
|
+
type: 'v2.core.health.event_generation_failure.resolved';
|
|
2809
|
+
// Retrieves data specific to this event.
|
|
2810
|
+
data: V2CoreHealthEventGenerationFailureResolvedEvent.Data;
|
|
2811
|
+
}
|
|
2812
|
+
export interface V2CoreHealthEventGenerationFailureResolvedEventNotification
|
|
2813
|
+
extends V2.Core.EventNotificationBase {
|
|
2814
|
+
type: 'v2.core.health.event_generation_failure.resolved';
|
|
2815
|
+
fetchEvent(): Promise<V2CoreHealthEventGenerationFailureResolvedEvent>;
|
|
2816
|
+
}
|
|
2817
|
+
|
|
2818
|
+
namespace V2CoreHealthEventGenerationFailureResolvedEvent {
|
|
2819
|
+
export interface Data {
|
|
2820
|
+
/**
|
|
2821
|
+
* The alert ID.
|
|
2822
|
+
*/
|
|
2823
|
+
alert_id: string;
|
|
2824
|
+
|
|
2825
|
+
/**
|
|
2826
|
+
* The grouping key for the alert.
|
|
2827
|
+
*/
|
|
2828
|
+
grouping_key: string;
|
|
2829
|
+
|
|
2830
|
+
/**
|
|
2831
|
+
* The user impact.
|
|
2832
|
+
*/
|
|
2833
|
+
impact: Data.Impact;
|
|
2834
|
+
|
|
2835
|
+
/**
|
|
2836
|
+
* The time when the user experience has returned to expected levels.
|
|
2837
|
+
*/
|
|
2838
|
+
resolved_at: string;
|
|
2839
|
+
|
|
2840
|
+
/**
|
|
2841
|
+
* A short description of the alert.
|
|
2842
|
+
*/
|
|
2843
|
+
summary: string;
|
|
2844
|
+
}
|
|
2845
|
+
|
|
2846
|
+
namespace Data {
|
|
2847
|
+
export interface Impact {
|
|
2848
|
+
/**
|
|
2849
|
+
* The context the event should have been generated for. Only present when the account is a connected account.
|
|
2850
|
+
*/
|
|
2851
|
+
context?: string;
|
|
2852
|
+
|
|
2853
|
+
/**
|
|
2854
|
+
* The type of event that Stripe failed to generate.
|
|
2855
|
+
*/
|
|
2856
|
+
event_type: string;
|
|
2857
|
+
|
|
2858
|
+
/**
|
|
2859
|
+
* The related object details.
|
|
2860
|
+
*/
|
|
2861
|
+
related_object: Impact.RelatedObject;
|
|
2862
|
+
}
|
|
2863
|
+
|
|
2864
|
+
namespace Impact {
|
|
2865
|
+
export interface RelatedObject {
|
|
2866
|
+
/**
|
|
2867
|
+
* The ID of the related object (e.g., "pi_...").
|
|
2868
|
+
*/
|
|
2869
|
+
id: string;
|
|
2870
|
+
|
|
2871
|
+
/**
|
|
2872
|
+
* The type of the related object (e.g., "payment_intent").
|
|
2873
|
+
*/
|
|
2874
|
+
type: string;
|
|
2875
|
+
|
|
2876
|
+
/**
|
|
2877
|
+
* The API URL for the related object (e.g., "/v1/payment_intents/pi_...").
|
|
2878
|
+
*/
|
|
2879
|
+
url: string;
|
|
2880
|
+
}
|
|
2881
|
+
}
|
|
2882
|
+
}
|
|
2883
|
+
}
|
|
2884
|
+
|
|
2885
|
+
/**
|
|
2886
|
+
* Occurs when the fraud rate has increased.
|
|
2887
|
+
*/
|
|
2888
|
+
export interface V2CoreHealthFraudRateIncreasedEvent
|
|
2889
|
+
extends V2.Core.EventBase {
|
|
2890
|
+
type: 'v2.core.health.fraud_rate.increased';
|
|
2891
|
+
// Retrieves data specific to this event.
|
|
2892
|
+
data: V2CoreHealthFraudRateIncreasedEvent.Data;
|
|
2893
|
+
}
|
|
2894
|
+
export interface V2CoreHealthFraudRateIncreasedEventNotification
|
|
2895
|
+
extends V2.Core.EventNotificationBase {
|
|
2896
|
+
type: 'v2.core.health.fraud_rate.increased';
|
|
2897
|
+
fetchEvent(): Promise<V2CoreHealthFraudRateIncreasedEvent>;
|
|
2898
|
+
}
|
|
2899
|
+
|
|
2900
|
+
namespace V2CoreHealthFraudRateIncreasedEvent {
|
|
2901
|
+
export interface Data {
|
|
2902
|
+
/**
|
|
2903
|
+
* The alert ID.
|
|
2904
|
+
*/
|
|
2905
|
+
alert_id: string;
|
|
2906
|
+
|
|
2907
|
+
/**
|
|
2908
|
+
* The grouping key for the alert.
|
|
2909
|
+
*/
|
|
2910
|
+
grouping_key: string;
|
|
2911
|
+
|
|
2912
|
+
/**
|
|
2913
|
+
* The user impact.
|
|
2914
|
+
*/
|
|
2915
|
+
impact: Data.Impact;
|
|
2916
|
+
|
|
2917
|
+
/**
|
|
2918
|
+
* The time when the user experience has returned to expected levels.
|
|
2919
|
+
*/
|
|
2920
|
+
resolved_at?: string;
|
|
2921
|
+
|
|
2922
|
+
/**
|
|
2923
|
+
* The time when impact on the user experience was first detected.
|
|
2924
|
+
*/
|
|
2925
|
+
started_at: string;
|
|
2926
|
+
|
|
2927
|
+
/**
|
|
2928
|
+
* A short description of the alert.
|
|
2929
|
+
*/
|
|
2930
|
+
summary: string;
|
|
2931
|
+
}
|
|
2932
|
+
|
|
2933
|
+
namespace Data {
|
|
2934
|
+
export interface Impact {
|
|
2935
|
+
/**
|
|
2936
|
+
* Fraud attack type.
|
|
2937
|
+
*/
|
|
2938
|
+
attack_type: Impact.AttackType;
|
|
2939
|
+
|
|
2940
|
+
/**
|
|
2941
|
+
* The number of impacted requests which are detected.
|
|
2942
|
+
*/
|
|
2943
|
+
impacted_requests: number;
|
|
2944
|
+
|
|
2945
|
+
/**
|
|
2946
|
+
* Estimated aggregated amount for the impacted requests.
|
|
2947
|
+
*/
|
|
2948
|
+
realized_fraud_amount: Impact.RealizedFraudAmount;
|
|
2949
|
+
}
|
|
2950
|
+
|
|
2951
|
+
namespace Impact {
|
|
2952
|
+
export type AttackType = 'spike' | 'sustained_attack';
|
|
2953
|
+
|
|
2954
|
+
export interface RealizedFraudAmount {
|
|
2955
|
+
/**
|
|
2956
|
+
* A non-negative integer representing how much to charge in the [smallest currency unit](https://docs.stripe.com/currencies#minor-units).
|
|
2957
|
+
*/
|
|
2958
|
+
value?: number;
|
|
2959
|
+
|
|
2960
|
+
/**
|
|
2961
|
+
* Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).
|
|
2962
|
+
*/
|
|
2963
|
+
currency?: string;
|
|
2964
|
+
}
|
|
2965
|
+
}
|
|
2966
|
+
}
|
|
2967
|
+
}
|
|
2968
|
+
|
|
2969
|
+
/**
|
|
2970
|
+
* Occurs when an issuing authorization request errors alert is firing.
|
|
2971
|
+
*/
|
|
2972
|
+
export interface V2CoreHealthIssuingAuthorizationRequestErrorsFiringEvent
|
|
2973
|
+
extends V2.Core.EventBase {
|
|
2974
|
+
type: 'v2.core.health.issuing_authorization_request_errors.firing';
|
|
2975
|
+
// Retrieves data specific to this event.
|
|
2976
|
+
data: V2CoreHealthIssuingAuthorizationRequestErrorsFiringEvent.Data;
|
|
2977
|
+
}
|
|
2978
|
+
export interface V2CoreHealthIssuingAuthorizationRequestErrorsFiringEventNotification
|
|
2979
|
+
extends V2.Core.EventNotificationBase {
|
|
2980
|
+
type: 'v2.core.health.issuing_authorization_request_errors.firing';
|
|
2981
|
+
fetchEvent(): Promise<
|
|
2982
|
+
V2CoreHealthIssuingAuthorizationRequestErrorsFiringEvent
|
|
2983
|
+
>;
|
|
2984
|
+
}
|
|
2985
|
+
|
|
2986
|
+
namespace V2CoreHealthIssuingAuthorizationRequestErrorsFiringEvent {
|
|
2987
|
+
export interface Data {
|
|
2988
|
+
/**
|
|
2989
|
+
* The grouping key for the alert.
|
|
2990
|
+
*/
|
|
2991
|
+
grouping_key: string;
|
|
2992
|
+
|
|
2993
|
+
/**
|
|
2994
|
+
* The user impact.
|
|
2995
|
+
*/
|
|
2996
|
+
impact: Data.Impact;
|
|
2997
|
+
|
|
2998
|
+
/**
|
|
2999
|
+
* The time when impact on the user experience was first detected.
|
|
3000
|
+
*/
|
|
3001
|
+
started_at: string;
|
|
3002
|
+
|
|
3003
|
+
/**
|
|
3004
|
+
* A short description of the alert.
|
|
3005
|
+
*/
|
|
3006
|
+
summary: string;
|
|
3007
|
+
}
|
|
3008
|
+
|
|
3009
|
+
namespace Data {
|
|
3010
|
+
export interface Impact {
|
|
3011
|
+
/**
|
|
3012
|
+
* Estimated aggregated amount for the approved requests.
|
|
3013
|
+
*/
|
|
3014
|
+
approved_amount?: Impact.ApprovedAmount;
|
|
3015
|
+
|
|
3016
|
+
/**
|
|
3017
|
+
* The number of approved requests which are impacted.
|
|
3018
|
+
*/
|
|
3019
|
+
approved_impacted_requests?: number;
|
|
3020
|
+
|
|
3021
|
+
/**
|
|
3022
|
+
* Estimated aggregated amount for the declined requests.
|
|
3023
|
+
*/
|
|
3024
|
+
declined_amount?: Impact.DeclinedAmount;
|
|
3025
|
+
|
|
3026
|
+
/**
|
|
3027
|
+
* The number of declined requests which are impacted.
|
|
3028
|
+
*/
|
|
3029
|
+
declined_impacted_requests?: number;
|
|
3030
|
+
}
|
|
3031
|
+
|
|
3032
|
+
namespace Impact {
|
|
3033
|
+
export interface ApprovedAmount {
|
|
3034
|
+
/**
|
|
3035
|
+
* A non-negative integer representing how much to charge in the [smallest currency unit](https://docs.stripe.com/currencies#minor-units).
|
|
3036
|
+
*/
|
|
3037
|
+
value?: number;
|
|
3038
|
+
|
|
3039
|
+
/**
|
|
3040
|
+
* Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).
|
|
3041
|
+
*/
|
|
3042
|
+
currency?: string;
|
|
3043
|
+
}
|
|
3044
|
+
|
|
3045
|
+
export interface DeclinedAmount {
|
|
3046
|
+
/**
|
|
3047
|
+
* A non-negative integer representing how much to charge in the [smallest currency unit](https://docs.stripe.com/currencies#minor-units).
|
|
3048
|
+
*/
|
|
3049
|
+
value?: number;
|
|
3050
|
+
|
|
3051
|
+
/**
|
|
3052
|
+
* Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).
|
|
3053
|
+
*/
|
|
3054
|
+
currency?: string;
|
|
3055
|
+
}
|
|
3056
|
+
}
|
|
3057
|
+
}
|
|
3058
|
+
}
|
|
3059
|
+
|
|
3060
|
+
/**
|
|
3061
|
+
* Occurs when an issuing authorization request errors alert is resolved.
|
|
3062
|
+
*/
|
|
3063
|
+
export interface V2CoreHealthIssuingAuthorizationRequestErrorsResolvedEvent
|
|
3064
|
+
extends V2.Core.EventBase {
|
|
3065
|
+
type: 'v2.core.health.issuing_authorization_request_errors.resolved';
|
|
3066
|
+
// Retrieves data specific to this event.
|
|
3067
|
+
data: V2CoreHealthIssuingAuthorizationRequestErrorsResolvedEvent.Data;
|
|
3068
|
+
}
|
|
3069
|
+
export interface V2CoreHealthIssuingAuthorizationRequestErrorsResolvedEventNotification
|
|
3070
|
+
extends V2.Core.EventNotificationBase {
|
|
3071
|
+
type: 'v2.core.health.issuing_authorization_request_errors.resolved';
|
|
3072
|
+
fetchEvent(): Promise<
|
|
3073
|
+
V2CoreHealthIssuingAuthorizationRequestErrorsResolvedEvent
|
|
3074
|
+
>;
|
|
3075
|
+
}
|
|
3076
|
+
|
|
3077
|
+
namespace V2CoreHealthIssuingAuthorizationRequestErrorsResolvedEvent {
|
|
3078
|
+
export interface Data {
|
|
3079
|
+
/**
|
|
3080
|
+
* The grouping key for the alert.
|
|
3081
|
+
*/
|
|
3082
|
+
grouping_key: string;
|
|
3083
|
+
|
|
3084
|
+
/**
|
|
3085
|
+
* The user impact.
|
|
3086
|
+
*/
|
|
3087
|
+
impact: Data.Impact;
|
|
3088
|
+
|
|
3089
|
+
/**
|
|
3090
|
+
* The time when the user experience has returned to expected levels.
|
|
3091
|
+
*/
|
|
3092
|
+
resolved_at: string;
|
|
3093
|
+
|
|
3094
|
+
/**
|
|
3095
|
+
* The time when impact on the user experience was first detected.
|
|
3096
|
+
*/
|
|
3097
|
+
started_at: string;
|
|
3098
|
+
|
|
3099
|
+
/**
|
|
3100
|
+
* A short description of the alert.
|
|
3101
|
+
*/
|
|
3102
|
+
summary: string;
|
|
3103
|
+
}
|
|
3104
|
+
|
|
3105
|
+
namespace Data {
|
|
3106
|
+
export interface Impact {
|
|
3107
|
+
/**
|
|
3108
|
+
* Estimated aggregated amount for the approved requests.
|
|
3109
|
+
*/
|
|
3110
|
+
approved_amount?: Impact.ApprovedAmount;
|
|
3111
|
+
|
|
3112
|
+
/**
|
|
3113
|
+
* The number of approved requests which are impacted.
|
|
3114
|
+
*/
|
|
3115
|
+
approved_impacted_requests?: number;
|
|
3116
|
+
|
|
3117
|
+
/**
|
|
3118
|
+
* Estimated aggregated amount for the declined requests.
|
|
3119
|
+
*/
|
|
3120
|
+
declined_amount?: Impact.DeclinedAmount;
|
|
3121
|
+
|
|
3122
|
+
/**
|
|
3123
|
+
* The number of declined requests which are impacted.
|
|
3124
|
+
*/
|
|
3125
|
+
declined_impacted_requests?: number;
|
|
3126
|
+
}
|
|
3127
|
+
|
|
3128
|
+
namespace Impact {
|
|
3129
|
+
export interface ApprovedAmount {
|
|
3130
|
+
/**
|
|
3131
|
+
* A non-negative integer representing how much to charge in the [smallest currency unit](https://docs.stripe.com/currencies#minor-units).
|
|
3132
|
+
*/
|
|
3133
|
+
value?: number;
|
|
3134
|
+
|
|
3135
|
+
/**
|
|
3136
|
+
* Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).
|
|
3137
|
+
*/
|
|
3138
|
+
currency?: string;
|
|
3139
|
+
}
|
|
3140
|
+
|
|
3141
|
+
export interface DeclinedAmount {
|
|
3142
|
+
/**
|
|
3143
|
+
* A non-negative integer representing how much to charge in the [smallest currency unit](https://docs.stripe.com/currencies#minor-units).
|
|
3144
|
+
*/
|
|
3145
|
+
value?: number;
|
|
3146
|
+
|
|
3147
|
+
/**
|
|
3148
|
+
* Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).
|
|
3149
|
+
*/
|
|
3150
|
+
currency?: string;
|
|
3151
|
+
}
|
|
3152
|
+
}
|
|
3153
|
+
}
|
|
3154
|
+
}
|
|
3155
|
+
|
|
3156
|
+
/**
|
|
3157
|
+
* Occurs when an issuing authorization request timeout alert is firing.
|
|
3158
|
+
*/
|
|
3159
|
+
export interface V2CoreHealthIssuingAuthorizationRequestTimeoutFiringEvent
|
|
3160
|
+
extends V2.Core.EventBase {
|
|
3161
|
+
type: 'v2.core.health.issuing_authorization_request_timeout.firing';
|
|
3162
|
+
// Retrieves data specific to this event.
|
|
3163
|
+
data: V2CoreHealthIssuingAuthorizationRequestTimeoutFiringEvent.Data;
|
|
3164
|
+
}
|
|
3165
|
+
export interface V2CoreHealthIssuingAuthorizationRequestTimeoutFiringEventNotification
|
|
3166
|
+
extends V2.Core.EventNotificationBase {
|
|
3167
|
+
type: 'v2.core.health.issuing_authorization_request_timeout.firing';
|
|
3168
|
+
fetchEvent(): Promise<
|
|
3169
|
+
V2CoreHealthIssuingAuthorizationRequestTimeoutFiringEvent
|
|
3170
|
+
>;
|
|
3171
|
+
}
|
|
3172
|
+
|
|
3173
|
+
namespace V2CoreHealthIssuingAuthorizationRequestTimeoutFiringEvent {
|
|
3174
|
+
export interface Data {
|
|
3175
|
+
/**
|
|
3176
|
+
* The alert ID.
|
|
3177
|
+
*/
|
|
3178
|
+
alert_id: string;
|
|
3179
|
+
|
|
3180
|
+
/**
|
|
3181
|
+
* The grouping key for the alert.
|
|
3182
|
+
*/
|
|
3183
|
+
grouping_key: string;
|
|
3184
|
+
|
|
3185
|
+
/**
|
|
3186
|
+
* The user impact.
|
|
3187
|
+
*/
|
|
3188
|
+
impact: Data.Impact;
|
|
3189
|
+
|
|
3190
|
+
/**
|
|
3191
|
+
* The time when impact on the user experience was first detected.
|
|
3192
|
+
*/
|
|
3193
|
+
started_at: string;
|
|
3194
|
+
|
|
3195
|
+
/**
|
|
3196
|
+
* A short description of the alert.
|
|
3197
|
+
*/
|
|
3198
|
+
summary: string;
|
|
3199
|
+
}
|
|
3200
|
+
|
|
3201
|
+
namespace Data {
|
|
3202
|
+
export interface Impact {
|
|
3203
|
+
/**
|
|
3204
|
+
* Estimated aggregated amount for the approved requests.
|
|
3205
|
+
*/
|
|
3206
|
+
approved_amount?: Impact.ApprovedAmount;
|
|
3207
|
+
|
|
3208
|
+
/**
|
|
3209
|
+
* The number of approved requests which are impacted.
|
|
3210
|
+
*/
|
|
3211
|
+
approved_impacted_requests?: number;
|
|
3212
|
+
|
|
3213
|
+
/**
|
|
3214
|
+
* Estimated aggregated amount for the declined requests.
|
|
3215
|
+
*/
|
|
3216
|
+
declined_amount?: Impact.DeclinedAmount;
|
|
3217
|
+
|
|
3218
|
+
/**
|
|
3219
|
+
* The number of declined requests which are impacted.
|
|
3220
|
+
*/
|
|
3221
|
+
declined_impacted_requests?: number;
|
|
3222
|
+
}
|
|
3223
|
+
|
|
3224
|
+
namespace Impact {
|
|
3225
|
+
export interface ApprovedAmount {
|
|
3226
|
+
/**
|
|
3227
|
+
* A non-negative integer representing how much to charge in the [smallest currency unit](https://docs.stripe.com/currencies#minor-units).
|
|
3228
|
+
*/
|
|
3229
|
+
value?: number;
|
|
3230
|
+
|
|
3231
|
+
/**
|
|
3232
|
+
* Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).
|
|
3233
|
+
*/
|
|
3234
|
+
currency?: string;
|
|
3235
|
+
}
|
|
3236
|
+
|
|
3237
|
+
export interface DeclinedAmount {
|
|
3238
|
+
/**
|
|
3239
|
+
* A non-negative integer representing how much to charge in the [smallest currency unit](https://docs.stripe.com/currencies#minor-units).
|
|
3240
|
+
*/
|
|
3241
|
+
value?: number;
|
|
3242
|
+
|
|
3243
|
+
/**
|
|
3244
|
+
* Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).
|
|
3245
|
+
*/
|
|
3246
|
+
currency?: string;
|
|
3247
|
+
}
|
|
3248
|
+
}
|
|
3249
|
+
}
|
|
3250
|
+
}
|
|
3251
|
+
|
|
3252
|
+
/**
|
|
3253
|
+
* Occurs when an issuing authorization request timeout alert is resolved.
|
|
3254
|
+
*/
|
|
3255
|
+
export interface V2CoreHealthIssuingAuthorizationRequestTimeoutResolvedEvent
|
|
3256
|
+
extends V2.Core.EventBase {
|
|
3257
|
+
type: 'v2.core.health.issuing_authorization_request_timeout.resolved';
|
|
3258
|
+
// Retrieves data specific to this event.
|
|
3259
|
+
data: V2CoreHealthIssuingAuthorizationRequestTimeoutResolvedEvent.Data;
|
|
3260
|
+
}
|
|
3261
|
+
export interface V2CoreHealthIssuingAuthorizationRequestTimeoutResolvedEventNotification
|
|
3262
|
+
extends V2.Core.EventNotificationBase {
|
|
3263
|
+
type: 'v2.core.health.issuing_authorization_request_timeout.resolved';
|
|
3264
|
+
fetchEvent(): Promise<
|
|
3265
|
+
V2CoreHealthIssuingAuthorizationRequestTimeoutResolvedEvent
|
|
3266
|
+
>;
|
|
3267
|
+
}
|
|
3268
|
+
|
|
3269
|
+
namespace V2CoreHealthIssuingAuthorizationRequestTimeoutResolvedEvent {
|
|
3270
|
+
export interface Data {
|
|
3271
|
+
/**
|
|
3272
|
+
* The grouping key for the alert.
|
|
3273
|
+
*/
|
|
3274
|
+
grouping_key: string;
|
|
3275
|
+
|
|
3276
|
+
/**
|
|
3277
|
+
* The user impact.
|
|
3278
|
+
*/
|
|
3279
|
+
impact: Data.Impact;
|
|
3280
|
+
|
|
3281
|
+
/**
|
|
3282
|
+
* The time when the user experience has returned to expected levels.
|
|
3283
|
+
*/
|
|
3284
|
+
resolved_at: string;
|
|
3285
|
+
|
|
3286
|
+
/**
|
|
3287
|
+
* The time when impact on the user experience was first detected.
|
|
3288
|
+
*/
|
|
3289
|
+
started_at: string;
|
|
3290
|
+
|
|
3291
|
+
/**
|
|
3292
|
+
* A short description of the alert.
|
|
3293
|
+
*/
|
|
3294
|
+
summary: string;
|
|
3295
|
+
}
|
|
3296
|
+
|
|
3297
|
+
namespace Data {
|
|
3298
|
+
export interface Impact {
|
|
3299
|
+
/**
|
|
3300
|
+
* Estimated aggregated amount for the approved requests.
|
|
3301
|
+
*/
|
|
3302
|
+
approved_amount?: Impact.ApprovedAmount;
|
|
3303
|
+
|
|
3304
|
+
/**
|
|
3305
|
+
* The number of approved requests which are impacted.
|
|
3306
|
+
*/
|
|
3307
|
+
approved_impacted_requests?: number;
|
|
3308
|
+
|
|
3309
|
+
/**
|
|
3310
|
+
* Estimated aggregated amount for the declined requests.
|
|
3311
|
+
*/
|
|
3312
|
+
declined_amount?: Impact.DeclinedAmount;
|
|
3313
|
+
|
|
3314
|
+
/**
|
|
3315
|
+
* The number of declined requests which are impacted.
|
|
3316
|
+
*/
|
|
3317
|
+
declined_impacted_requests?: number;
|
|
3318
|
+
}
|
|
3319
|
+
|
|
3320
|
+
namespace Impact {
|
|
3321
|
+
export interface ApprovedAmount {
|
|
3322
|
+
/**
|
|
3323
|
+
* A non-negative integer representing how much to charge in the [smallest currency unit](https://docs.stripe.com/currencies#minor-units).
|
|
3324
|
+
*/
|
|
3325
|
+
value?: number;
|
|
3326
|
+
|
|
3327
|
+
/**
|
|
3328
|
+
* Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).
|
|
3329
|
+
*/
|
|
3330
|
+
currency?: string;
|
|
3331
|
+
}
|
|
3332
|
+
|
|
3333
|
+
export interface DeclinedAmount {
|
|
3334
|
+
/**
|
|
3335
|
+
* A non-negative integer representing how much to charge in the [smallest currency unit](https://docs.stripe.com/currencies#minor-units).
|
|
3336
|
+
*/
|
|
3337
|
+
value?: number;
|
|
3338
|
+
|
|
3339
|
+
/**
|
|
3340
|
+
* Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).
|
|
3341
|
+
*/
|
|
3342
|
+
currency?: string;
|
|
3343
|
+
}
|
|
3344
|
+
}
|
|
3345
|
+
}
|
|
3346
|
+
}
|
|
3347
|
+
|
|
3348
|
+
/**
|
|
3349
|
+
* Occurs when a payment method error alert is firing.
|
|
3350
|
+
*/
|
|
3351
|
+
export interface V2CoreHealthPaymentMethodErrorFiringEvent
|
|
3352
|
+
extends V2.Core.EventBase {
|
|
3353
|
+
type: 'v2.core.health.payment_method_error.firing';
|
|
3354
|
+
// Retrieves data specific to this event.
|
|
3355
|
+
data: V2CoreHealthPaymentMethodErrorFiringEvent.Data;
|
|
3356
|
+
}
|
|
3357
|
+
export interface V2CoreHealthPaymentMethodErrorFiringEventNotification
|
|
3358
|
+
extends V2.Core.EventNotificationBase {
|
|
3359
|
+
type: 'v2.core.health.payment_method_error.firing';
|
|
3360
|
+
fetchEvent(): Promise<V2CoreHealthPaymentMethodErrorFiringEvent>;
|
|
3361
|
+
}
|
|
3362
|
+
|
|
3363
|
+
namespace V2CoreHealthPaymentMethodErrorFiringEvent {
|
|
3364
|
+
export interface Data {
|
|
3365
|
+
/**
|
|
3366
|
+
* The alert ID.
|
|
3367
|
+
*/
|
|
3368
|
+
alert_id: string;
|
|
3369
|
+
|
|
3370
|
+
/**
|
|
3371
|
+
* The grouping key for the alert.
|
|
3372
|
+
*/
|
|
3373
|
+
grouping_key: string;
|
|
3374
|
+
|
|
3375
|
+
/**
|
|
3376
|
+
* The user impact.
|
|
3377
|
+
*/
|
|
3378
|
+
impact: Data.Impact;
|
|
3379
|
+
|
|
3380
|
+
/**
|
|
3381
|
+
* The time when impact on the user experience was first detected.
|
|
3382
|
+
*/
|
|
3383
|
+
started_at: string;
|
|
3384
|
+
|
|
3385
|
+
/**
|
|
3386
|
+
* A short description of the alert.
|
|
3387
|
+
*/
|
|
3388
|
+
summary: string;
|
|
3389
|
+
}
|
|
3390
|
+
|
|
3391
|
+
namespace Data {
|
|
3392
|
+
export interface Impact {
|
|
3393
|
+
/**
|
|
3394
|
+
* The returned error code.
|
|
3395
|
+
*/
|
|
3396
|
+
error_code?: string;
|
|
3397
|
+
|
|
3398
|
+
/**
|
|
3399
|
+
* The number of impacted requests.
|
|
3400
|
+
*/
|
|
3401
|
+
impacted_requests: number;
|
|
3402
|
+
|
|
3403
|
+
/**
|
|
3404
|
+
* The percentage of impacted requests.
|
|
3405
|
+
*/
|
|
3406
|
+
impacted_requests_percentage?: string;
|
|
3407
|
+
|
|
3408
|
+
/**
|
|
3409
|
+
* The type of the payment method.
|
|
3410
|
+
*/
|
|
3411
|
+
payment_method_type: Impact.PaymentMethodType;
|
|
3412
|
+
}
|
|
3413
|
+
|
|
3414
|
+
namespace Impact {
|
|
3415
|
+
export type PaymentMethodType =
|
|
3416
|
+
| 'acss_debit'
|
|
3417
|
+
| 'affirm'
|
|
3418
|
+
| 'afterpay_clearpay'
|
|
3419
|
+
| 'alipay'
|
|
3420
|
+
| 'alma'
|
|
3421
|
+
| 'amazon_pay'
|
|
3422
|
+
| 'apple_pay'
|
|
3423
|
+
| 'au_becs_debit'
|
|
3424
|
+
| 'bacs_debit'
|
|
3425
|
+
| 'bancontact'
|
|
3426
|
+
| 'billie'
|
|
3427
|
+
| 'blik'
|
|
3428
|
+
| 'boleto'
|
|
3429
|
+
| 'card'
|
|
3430
|
+
| 'card_present'
|
|
3431
|
+
| 'cartes_bancaires'
|
|
3432
|
+
| 'cashapp'
|
|
3433
|
+
| 'crypto'
|
|
3434
|
+
| 'dummy_passthrough_card'
|
|
3435
|
+
| 'eps'
|
|
3436
|
+
| 'fpx'
|
|
3437
|
+
| 'giropay'
|
|
3438
|
+
| 'grabpay'
|
|
3439
|
+
| 'ideal'
|
|
3440
|
+
| 'interac_present'
|
|
3441
|
+
| 'kakao_pay'
|
|
3442
|
+
| 'klarna'
|
|
3443
|
+
| 'konbini'
|
|
3444
|
+
| 'kriya'
|
|
3445
|
+
| 'kr_card'
|
|
3446
|
+
| 'link'
|
|
3447
|
+
| 'mb_way'
|
|
3448
|
+
| 'mobilepay'
|
|
3449
|
+
| 'mondu'
|
|
3450
|
+
| 'multibanco'
|
|
3451
|
+
| 'naver_pay'
|
|
3452
|
+
| 'ng_bank'
|
|
3453
|
+
| 'ng_bank_transfer'
|
|
3454
|
+
| 'ng_card'
|
|
3455
|
+
| 'ng_market'
|
|
3456
|
+
| 'ng_ussd'
|
|
3457
|
+
| 'ng_wallet'
|
|
3458
|
+
| 'oxxo'
|
|
3459
|
+
| 'p24'
|
|
3460
|
+
| 'paper_check'
|
|
3461
|
+
| 'payco'
|
|
3462
|
+
| 'paynow'
|
|
3463
|
+
| 'paypal'
|
|
3464
|
+
| 'paypay'
|
|
3465
|
+
| 'payto'
|
|
3466
|
+
| 'pay_by_bank'
|
|
3467
|
+
| 'pix'
|
|
3468
|
+
| 'promptpay'
|
|
3469
|
+
| 'rechnung'
|
|
3470
|
+
| 'revolut_pay'
|
|
3471
|
+
| 'samsung_pay'
|
|
3472
|
+
| 'satispay'
|
|
3473
|
+
| 'scalapay'
|
|
3474
|
+
| 'sepa_debit'
|
|
3475
|
+
| 'sequra'
|
|
3476
|
+
| 'sofort'
|
|
3477
|
+
| 'sunbit'
|
|
3478
|
+
| 'swish'
|
|
3479
|
+
| 'twint'
|
|
3480
|
+
| 'upi'
|
|
3481
|
+
| 'us_bank_account'
|
|
3482
|
+
| 'vipps'
|
|
3483
|
+
| 'wechat_pay'
|
|
3484
|
+
| 'zip';
|
|
3485
|
+
}
|
|
3486
|
+
}
|
|
3487
|
+
}
|
|
3488
|
+
|
|
3489
|
+
/**
|
|
3490
|
+
* Occurs when a payment method error alert is resolved.
|
|
3491
|
+
*/
|
|
3492
|
+
export interface V2CoreHealthPaymentMethodErrorResolvedEvent
|
|
3493
|
+
extends V2.Core.EventBase {
|
|
3494
|
+
type: 'v2.core.health.payment_method_error.resolved';
|
|
3495
|
+
// Retrieves data specific to this event.
|
|
3496
|
+
data: V2CoreHealthPaymentMethodErrorResolvedEvent.Data;
|
|
3497
|
+
}
|
|
3498
|
+
export interface V2CoreHealthPaymentMethodErrorResolvedEventNotification
|
|
3499
|
+
extends V2.Core.EventNotificationBase {
|
|
3500
|
+
type: 'v2.core.health.payment_method_error.resolved';
|
|
3501
|
+
fetchEvent(): Promise<V2CoreHealthPaymentMethodErrorResolvedEvent>;
|
|
3502
|
+
}
|
|
3503
|
+
|
|
3504
|
+
namespace V2CoreHealthPaymentMethodErrorResolvedEvent {
|
|
3505
|
+
export interface Data {
|
|
3506
|
+
/**
|
|
3507
|
+
* The grouping key for the alert.
|
|
3508
|
+
*/
|
|
3509
|
+
grouping_key: string;
|
|
3510
|
+
|
|
3511
|
+
/**
|
|
3512
|
+
* The user impact.
|
|
3513
|
+
*/
|
|
3514
|
+
impact: Data.Impact;
|
|
3515
|
+
|
|
3516
|
+
/**
|
|
3517
|
+
* The time when the user experience has returned to expected levels.
|
|
3518
|
+
*/
|
|
3519
|
+
resolved_at: string;
|
|
3520
|
+
|
|
3521
|
+
/**
|
|
3522
|
+
* The time when impact on the user experience was first detected.
|
|
3523
|
+
*/
|
|
3524
|
+
started_at: string;
|
|
3525
|
+
|
|
3526
|
+
/**
|
|
3527
|
+
* A short description of the alert.
|
|
3528
|
+
*/
|
|
3529
|
+
summary: string;
|
|
3530
|
+
}
|
|
3531
|
+
|
|
3532
|
+
namespace Data {
|
|
3533
|
+
export interface Impact {
|
|
3534
|
+
/**
|
|
3535
|
+
* The returned error code.
|
|
3536
|
+
*/
|
|
3537
|
+
error_code?: string;
|
|
3538
|
+
|
|
3539
|
+
/**
|
|
3540
|
+
* The number of impacted requests.
|
|
3541
|
+
*/
|
|
3542
|
+
impacted_requests: number;
|
|
3543
|
+
|
|
3544
|
+
/**
|
|
3545
|
+
* The percentage of impacted requests.
|
|
3546
|
+
*/
|
|
3547
|
+
impacted_requests_percentage?: string;
|
|
3548
|
+
|
|
3549
|
+
/**
|
|
3550
|
+
* The type of the payment method.
|
|
3551
|
+
*/
|
|
3552
|
+
payment_method_type: Impact.PaymentMethodType;
|
|
3553
|
+
}
|
|
3554
|
+
|
|
3555
|
+
namespace Impact {
|
|
3556
|
+
export type PaymentMethodType =
|
|
3557
|
+
| 'acss_debit'
|
|
3558
|
+
| 'affirm'
|
|
3559
|
+
| 'afterpay_clearpay'
|
|
3560
|
+
| 'alipay'
|
|
3561
|
+
| 'alma'
|
|
3562
|
+
| 'amazon_pay'
|
|
3563
|
+
| 'apple_pay'
|
|
3564
|
+
| 'au_becs_debit'
|
|
3565
|
+
| 'bacs_debit'
|
|
3566
|
+
| 'bancontact'
|
|
3567
|
+
| 'billie'
|
|
3568
|
+
| 'blik'
|
|
3569
|
+
| 'boleto'
|
|
3570
|
+
| 'card'
|
|
3571
|
+
| 'card_present'
|
|
3572
|
+
| 'cartes_bancaires'
|
|
3573
|
+
| 'cashapp'
|
|
3574
|
+
| 'crypto'
|
|
3575
|
+
| 'dummy_passthrough_card'
|
|
3576
|
+
| 'eps'
|
|
3577
|
+
| 'fpx'
|
|
3578
|
+
| 'giropay'
|
|
3579
|
+
| 'grabpay'
|
|
3580
|
+
| 'ideal'
|
|
3581
|
+
| 'interac_present'
|
|
3582
|
+
| 'kakao_pay'
|
|
3583
|
+
| 'klarna'
|
|
3584
|
+
| 'konbini'
|
|
3585
|
+
| 'kriya'
|
|
3586
|
+
| 'kr_card'
|
|
3587
|
+
| 'link'
|
|
3588
|
+
| 'mb_way'
|
|
3589
|
+
| 'mobilepay'
|
|
3590
|
+
| 'mondu'
|
|
3591
|
+
| 'multibanco'
|
|
3592
|
+
| 'naver_pay'
|
|
3593
|
+
| 'ng_bank'
|
|
3594
|
+
| 'ng_bank_transfer'
|
|
3595
|
+
| 'ng_card'
|
|
3596
|
+
| 'ng_market'
|
|
3597
|
+
| 'ng_ussd'
|
|
3598
|
+
| 'ng_wallet'
|
|
3599
|
+
| 'oxxo'
|
|
3600
|
+
| 'p24'
|
|
3601
|
+
| 'paper_check'
|
|
3602
|
+
| 'payco'
|
|
3603
|
+
| 'paynow'
|
|
3604
|
+
| 'paypal'
|
|
3605
|
+
| 'paypay'
|
|
3606
|
+
| 'payto'
|
|
3607
|
+
| 'pay_by_bank'
|
|
3608
|
+
| 'pix'
|
|
3609
|
+
| 'promptpay'
|
|
3610
|
+
| 'rechnung'
|
|
3611
|
+
| 'revolut_pay'
|
|
3612
|
+
| 'samsung_pay'
|
|
3613
|
+
| 'satispay'
|
|
3614
|
+
| 'scalapay'
|
|
3615
|
+
| 'sepa_debit'
|
|
3616
|
+
| 'sequra'
|
|
3617
|
+
| 'sofort'
|
|
3618
|
+
| 'sunbit'
|
|
3619
|
+
| 'swish'
|
|
3620
|
+
| 'twint'
|
|
3621
|
+
| 'upi'
|
|
3622
|
+
| 'us_bank_account'
|
|
3623
|
+
| 'vipps'
|
|
3624
|
+
| 'wechat_pay'
|
|
3625
|
+
| 'zip';
|
|
3626
|
+
}
|
|
3627
|
+
}
|
|
3628
|
+
}
|
|
3629
|
+
|
|
3630
|
+
/**
|
|
3631
|
+
* Occurs when a traffic volume drop alert is firing.
|
|
3632
|
+
*/
|
|
3633
|
+
export interface V2CoreHealthTrafficVolumeDropFiringEvent
|
|
3634
|
+
extends V2.Core.EventBase {
|
|
3635
|
+
type: 'v2.core.health.traffic_volume_drop.firing';
|
|
3636
|
+
// Retrieves data specific to this event.
|
|
3637
|
+
data: V2CoreHealthTrafficVolumeDropFiringEvent.Data;
|
|
3638
|
+
}
|
|
3639
|
+
export interface V2CoreHealthTrafficVolumeDropFiringEventNotification
|
|
3640
|
+
extends V2.Core.EventNotificationBase {
|
|
3641
|
+
type: 'v2.core.health.traffic_volume_drop.firing';
|
|
3642
|
+
fetchEvent(): Promise<V2CoreHealthTrafficVolumeDropFiringEvent>;
|
|
3643
|
+
}
|
|
3644
|
+
|
|
3645
|
+
namespace V2CoreHealthTrafficVolumeDropFiringEvent {
|
|
3646
|
+
export interface Data {
|
|
3647
|
+
/**
|
|
3648
|
+
* The alert ID.
|
|
3649
|
+
*/
|
|
3650
|
+
alert_id: string;
|
|
3651
|
+
|
|
3652
|
+
/**
|
|
3653
|
+
* The grouping key for the alert.
|
|
3654
|
+
*/
|
|
3655
|
+
grouping_key: string;
|
|
3656
|
+
|
|
3657
|
+
/**
|
|
3658
|
+
* The user impact.
|
|
3659
|
+
*/
|
|
3660
|
+
impact: Data.Impact;
|
|
3661
|
+
|
|
3662
|
+
/**
|
|
3663
|
+
* The time when impact on the user experience was first detected.
|
|
3664
|
+
*/
|
|
3665
|
+
started_at: string;
|
|
3666
|
+
|
|
3667
|
+
/**
|
|
3668
|
+
* A short description of the alert.
|
|
3669
|
+
*/
|
|
3670
|
+
summary: string;
|
|
3671
|
+
}
|
|
3672
|
+
|
|
3673
|
+
namespace Data {
|
|
3674
|
+
export interface Impact {
|
|
3675
|
+
/**
|
|
3676
|
+
* The total volume of payment requests within the latest observation time window.
|
|
3677
|
+
*/
|
|
3678
|
+
actual_traffic: number;
|
|
3679
|
+
|
|
3680
|
+
/**
|
|
3681
|
+
* The expected volume of payment requests within the latest observation time window.
|
|
3682
|
+
*/
|
|
3683
|
+
expected_traffic?: number;
|
|
3684
|
+
|
|
3685
|
+
/**
|
|
3686
|
+
* The size of the observation time window.
|
|
3687
|
+
*/
|
|
3688
|
+
time_window: string;
|
|
3689
|
+
}
|
|
3690
|
+
}
|
|
3691
|
+
}
|
|
3692
|
+
|
|
3693
|
+
/**
|
|
3694
|
+
* Occurs when a traffic volume drop alert is resolved.
|
|
3695
|
+
*/
|
|
3696
|
+
export interface V2CoreHealthTrafficVolumeDropResolvedEvent
|
|
3697
|
+
extends V2.Core.EventBase {
|
|
3698
|
+
type: 'v2.core.health.traffic_volume_drop.resolved';
|
|
3699
|
+
// Retrieves data specific to this event.
|
|
3700
|
+
data: V2CoreHealthTrafficVolumeDropResolvedEvent.Data;
|
|
3701
|
+
}
|
|
3702
|
+
export interface V2CoreHealthTrafficVolumeDropResolvedEventNotification
|
|
3703
|
+
extends V2.Core.EventNotificationBase {
|
|
3704
|
+
type: 'v2.core.health.traffic_volume_drop.resolved';
|
|
3705
|
+
fetchEvent(): Promise<V2CoreHealthTrafficVolumeDropResolvedEvent>;
|
|
3706
|
+
}
|
|
3707
|
+
|
|
3708
|
+
namespace V2CoreHealthTrafficVolumeDropResolvedEvent {
|
|
3709
|
+
export interface Data {
|
|
3710
|
+
/**
|
|
3711
|
+
* The grouping key for the alert.
|
|
3712
|
+
*/
|
|
3713
|
+
grouping_key: string;
|
|
3714
|
+
|
|
3715
|
+
/**
|
|
3716
|
+
* The user impact.
|
|
3717
|
+
*/
|
|
3718
|
+
impact: Data.Impact;
|
|
3719
|
+
|
|
3720
|
+
/**
|
|
3721
|
+
* The time when the user experience has returned to expected levels.
|
|
3722
|
+
*/
|
|
3723
|
+
resolved_at: string;
|
|
3724
|
+
|
|
3725
|
+
/**
|
|
3726
|
+
* The time when impact on the user experience was first detected.
|
|
3727
|
+
*/
|
|
3728
|
+
started_at: string;
|
|
3729
|
+
|
|
3730
|
+
/**
|
|
3731
|
+
* A short description of the alert.
|
|
3732
|
+
*/
|
|
3733
|
+
summary: string;
|
|
3734
|
+
}
|
|
3735
|
+
|
|
3736
|
+
namespace Data {
|
|
3737
|
+
export interface Impact {
|
|
3738
|
+
/**
|
|
3739
|
+
* The total volume of payment requests within the latest observation time window.
|
|
3740
|
+
*/
|
|
3741
|
+
actual_traffic: number;
|
|
3742
|
+
|
|
3743
|
+
/**
|
|
3744
|
+
* The expected volume of payment requests within the latest observation time window.
|
|
3745
|
+
*/
|
|
3746
|
+
expected_traffic?: number;
|
|
3747
|
+
|
|
3748
|
+
/**
|
|
3749
|
+
* The size of the observation time window.
|
|
3750
|
+
*/
|
|
3751
|
+
time_window: string;
|
|
3752
|
+
}
|
|
3753
|
+
}
|
|
3754
|
+
}
|
|
3755
|
+
|
|
3756
|
+
/**
|
|
3757
|
+
* Occurs when a webhook latency alert is firing.
|
|
3758
|
+
*/
|
|
3759
|
+
export interface V2CoreHealthWebhookLatencyFiringEvent
|
|
3760
|
+
extends V2.Core.EventBase {
|
|
3761
|
+
type: 'v2.core.health.webhook_latency.firing';
|
|
3762
|
+
// Retrieves data specific to this event.
|
|
3763
|
+
data: V2CoreHealthWebhookLatencyFiringEvent.Data;
|
|
3764
|
+
}
|
|
3765
|
+
export interface V2CoreHealthWebhookLatencyFiringEventNotification
|
|
3766
|
+
extends V2.Core.EventNotificationBase {
|
|
3767
|
+
type: 'v2.core.health.webhook_latency.firing';
|
|
3768
|
+
fetchEvent(): Promise<V2CoreHealthWebhookLatencyFiringEvent>;
|
|
3769
|
+
}
|
|
3770
|
+
|
|
3771
|
+
namespace V2CoreHealthWebhookLatencyFiringEvent {
|
|
3772
|
+
export interface Data {
|
|
3773
|
+
/**
|
|
3774
|
+
* The alert ID.
|
|
3775
|
+
*/
|
|
3776
|
+
alert_id: string;
|
|
3777
|
+
|
|
3778
|
+
/**
|
|
3779
|
+
* The grouping key for the alert.
|
|
3780
|
+
*/
|
|
3781
|
+
grouping_key: string;
|
|
3782
|
+
|
|
3783
|
+
/**
|
|
3784
|
+
* The user impact.
|
|
3785
|
+
*/
|
|
3786
|
+
impact: Data.Impact;
|
|
3787
|
+
|
|
3788
|
+
/**
|
|
3789
|
+
* The time when impact on the user experience was first detected.
|
|
3790
|
+
*/
|
|
3791
|
+
started_at: string;
|
|
3792
|
+
|
|
3793
|
+
/**
|
|
3794
|
+
* A short description of the alert.
|
|
3795
|
+
*/
|
|
3796
|
+
summary: string;
|
|
3797
|
+
}
|
|
3798
|
+
|
|
3799
|
+
namespace Data {
|
|
3800
|
+
export interface Impact {
|
|
3801
|
+
/**
|
|
3802
|
+
* The number of impacted requests.
|
|
3803
|
+
*/
|
|
3804
|
+
impacted_requests: number;
|
|
3805
|
+
}
|
|
3806
|
+
}
|
|
3807
|
+
}
|
|
3808
|
+
|
|
3809
|
+
/**
|
|
3810
|
+
* Occurs when a webhook latency alert is resolved.
|
|
3811
|
+
*/
|
|
3812
|
+
export interface V2CoreHealthWebhookLatencyResolvedEvent
|
|
3813
|
+
extends V2.Core.EventBase {
|
|
3814
|
+
type: 'v2.core.health.webhook_latency.resolved';
|
|
3815
|
+
// Retrieves data specific to this event.
|
|
3816
|
+
data: V2CoreHealthWebhookLatencyResolvedEvent.Data;
|
|
3817
|
+
}
|
|
3818
|
+
export interface V2CoreHealthWebhookLatencyResolvedEventNotification
|
|
3819
|
+
extends V2.Core.EventNotificationBase {
|
|
3820
|
+
type: 'v2.core.health.webhook_latency.resolved';
|
|
3821
|
+
fetchEvent(): Promise<V2CoreHealthWebhookLatencyResolvedEvent>;
|
|
3822
|
+
}
|
|
3823
|
+
|
|
3824
|
+
namespace V2CoreHealthWebhookLatencyResolvedEvent {
|
|
3825
|
+
export interface Data {
|
|
3826
|
+
/**
|
|
3827
|
+
* The grouping key for the alert.
|
|
3828
|
+
*/
|
|
3829
|
+
grouping_key: string;
|
|
3830
|
+
|
|
3831
|
+
/**
|
|
3832
|
+
* The user impact.
|
|
3833
|
+
*/
|
|
3834
|
+
impact: Data.Impact;
|
|
3835
|
+
|
|
3836
|
+
/**
|
|
3837
|
+
* The time when the user experience has returned to expected levels.
|
|
3838
|
+
*/
|
|
3839
|
+
resolved_at: string;
|
|
3840
|
+
|
|
3841
|
+
/**
|
|
3842
|
+
* The time when impact on the user experience was first detected.
|
|
3843
|
+
*/
|
|
3844
|
+
started_at: string;
|
|
3845
|
+
|
|
3846
|
+
/**
|
|
3847
|
+
* A short description of the alert.
|
|
3848
|
+
*/
|
|
3849
|
+
summary: string;
|
|
3850
|
+
}
|
|
3851
|
+
|
|
3852
|
+
namespace Data {
|
|
3853
|
+
export interface Impact {
|
|
3854
|
+
/**
|
|
3855
|
+
* The number of impacted requests.
|
|
3856
|
+
*/
|
|
3857
|
+
impacted_requests: number;
|
|
3858
|
+
}
|
|
3859
|
+
}
|
|
3860
|
+
}
|
|
3861
|
+
|
|
3862
|
+
/**
|
|
3863
|
+
* Occurs when an Adjustment is created.
|
|
3864
|
+
*/
|
|
3865
|
+
export interface V2MoneyManagementAdjustmentCreatedEvent
|
|
3866
|
+
extends V2.Core.EventBase {
|
|
3867
|
+
type: 'v2.money_management.adjustment.created';
|
|
3868
|
+
// Object containing the reference to API resource relevant to the event.
|
|
3869
|
+
related_object: V2.Core.Events.RelatedObject;
|
|
3870
|
+
// Retrieves the object associated with the event.
|
|
3871
|
+
fetchRelatedObject(): Promise<V2.MoneyManagement.Adjustment>;
|
|
3872
|
+
}
|
|
3873
|
+
export interface V2MoneyManagementAdjustmentCreatedEventNotification
|
|
3874
|
+
extends V2.Core.EventNotificationBase {
|
|
3875
|
+
type: 'v2.money_management.adjustment.created';
|
|
3876
|
+
// Object containing the reference to API resource relevant to the event.
|
|
3877
|
+
related_object: V2.Core.Events.RelatedObject;
|
|
3878
|
+
// Retrieves the object associated with the event.
|
|
3879
|
+
fetchRelatedObject(): Promise<V2.MoneyManagement.Adjustment>;
|
|
3880
|
+
fetchEvent(): Promise<V2MoneyManagementAdjustmentCreatedEvent>;
|
|
3881
|
+
}
|
|
3882
|
+
|
|
3883
|
+
/**
|
|
3884
|
+
* Occurs when a FinancialAccount is created.
|
|
3885
|
+
*/
|
|
3886
|
+
export interface V2MoneyManagementFinancialAccountCreatedEvent
|
|
3887
|
+
extends V2.Core.EventBase {
|
|
3888
|
+
type: 'v2.money_management.financial_account.created';
|
|
3889
|
+
// Object containing the reference to API resource relevant to the event.
|
|
3890
|
+
related_object: V2.Core.Events.RelatedObject;
|
|
3891
|
+
// Retrieves the object associated with the event.
|
|
3892
|
+
fetchRelatedObject(): Promise<V2.MoneyManagement.FinancialAccount>;
|
|
3893
|
+
}
|
|
3894
|
+
export interface V2MoneyManagementFinancialAccountCreatedEventNotification
|
|
3895
|
+
extends V2.Core.EventNotificationBase {
|
|
3896
|
+
type: 'v2.money_management.financial_account.created';
|
|
3897
|
+
// Object containing the reference to API resource relevant to the event.
|
|
3898
|
+
related_object: V2.Core.Events.RelatedObject;
|
|
3899
|
+
// Retrieves the object associated with the event.
|
|
3900
|
+
fetchRelatedObject(): Promise<V2.MoneyManagement.FinancialAccount>;
|
|
3901
|
+
fetchEvent(): Promise<V2MoneyManagementFinancialAccountCreatedEvent>;
|
|
3902
|
+
}
|
|
3903
|
+
|
|
3904
|
+
/**
|
|
3905
|
+
* Occurs when a FinancialAccount is updated.
|
|
3906
|
+
*/
|
|
3907
|
+
export interface V2MoneyManagementFinancialAccountUpdatedEvent
|
|
3908
|
+
extends V2.Core.EventBase {
|
|
3909
|
+
type: 'v2.money_management.financial_account.updated';
|
|
3910
|
+
// Object containing the reference to API resource relevant to the event.
|
|
3911
|
+
related_object: V2.Core.Events.RelatedObject;
|
|
3912
|
+
// Retrieves the object associated with the event.
|
|
3913
|
+
fetchRelatedObject(): Promise<V2.MoneyManagement.FinancialAccount>;
|
|
3914
|
+
}
|
|
3915
|
+
export interface V2MoneyManagementFinancialAccountUpdatedEventNotification
|
|
3916
|
+
extends V2.Core.EventNotificationBase {
|
|
3917
|
+
type: 'v2.money_management.financial_account.updated';
|
|
3918
|
+
// Object containing the reference to API resource relevant to the event.
|
|
3919
|
+
related_object: V2.Core.Events.RelatedObject;
|
|
3920
|
+
// Retrieves the object associated with the event.
|
|
3921
|
+
fetchRelatedObject(): Promise<V2.MoneyManagement.FinancialAccount>;
|
|
3922
|
+
fetchEvent(): Promise<V2MoneyManagementFinancialAccountUpdatedEvent>;
|
|
3923
|
+
}
|
|
3924
|
+
|
|
3925
|
+
/**
|
|
3926
|
+
* Occurs when a FinancialAddress is activated and is ready to receive funds.
|
|
3927
|
+
*/
|
|
3928
|
+
export interface V2MoneyManagementFinancialAddressActivatedEvent
|
|
3929
|
+
extends V2.Core.EventBase {
|
|
3930
|
+
type: 'v2.money_management.financial_address.activated';
|
|
3931
|
+
// Object containing the reference to API resource relevant to the event.
|
|
3932
|
+
related_object: V2.Core.Events.RelatedObject;
|
|
3933
|
+
// Retrieves the object associated with the event.
|
|
3934
|
+
fetchRelatedObject(): Promise<V2.MoneyManagement.FinancialAddress>;
|
|
3935
|
+
}
|
|
3936
|
+
export interface V2MoneyManagementFinancialAddressActivatedEventNotification
|
|
3937
|
+
extends V2.Core.EventNotificationBase {
|
|
3938
|
+
type: 'v2.money_management.financial_address.activated';
|
|
3939
|
+
// Object containing the reference to API resource relevant to the event.
|
|
3940
|
+
related_object: V2.Core.Events.RelatedObject;
|
|
3941
|
+
// Retrieves the object associated with the event.
|
|
3942
|
+
fetchRelatedObject(): Promise<V2.MoneyManagement.FinancialAddress>;
|
|
3943
|
+
fetchEvent(): Promise<V2MoneyManagementFinancialAddressActivatedEvent>;
|
|
3944
|
+
}
|
|
3945
|
+
|
|
3946
|
+
/**
|
|
3947
|
+
* Occurs when a FinancialAddress fails to activate and can not receive funds.
|
|
3948
|
+
*/
|
|
3949
|
+
export interface V2MoneyManagementFinancialAddressFailedEvent
|
|
3950
|
+
extends V2.Core.EventBase {
|
|
3951
|
+
type: 'v2.money_management.financial_address.failed';
|
|
3952
|
+
// Object containing the reference to API resource relevant to the event.
|
|
3953
|
+
related_object: V2.Core.Events.RelatedObject;
|
|
3954
|
+
// Retrieves the object associated with the event.
|
|
3955
|
+
fetchRelatedObject(): Promise<V2.MoneyManagement.FinancialAddress>;
|
|
3956
|
+
}
|
|
3957
|
+
export interface V2MoneyManagementFinancialAddressFailedEventNotification
|
|
3958
|
+
extends V2.Core.EventNotificationBase {
|
|
3959
|
+
type: 'v2.money_management.financial_address.failed';
|
|
3960
|
+
// Object containing the reference to API resource relevant to the event.
|
|
3961
|
+
related_object: V2.Core.Events.RelatedObject;
|
|
3962
|
+
// Retrieves the object associated with the event.
|
|
3963
|
+
fetchRelatedObject(): Promise<V2.MoneyManagement.FinancialAddress>;
|
|
3964
|
+
fetchEvent(): Promise<V2MoneyManagementFinancialAddressFailedEvent>;
|
|
3965
|
+
}
|
|
3966
|
+
|
|
3967
|
+
/**
|
|
3968
|
+
* Occurs when an InboundTransfer's funds are made available.
|
|
3969
|
+
*/
|
|
3970
|
+
export interface V2MoneyManagementInboundTransferAvailableEvent
|
|
3971
|
+
extends V2.Core.EventBase {
|
|
3972
|
+
type: 'v2.money_management.inbound_transfer.available';
|
|
3973
|
+
// Retrieves data specific to this event.
|
|
3974
|
+
data: V2MoneyManagementInboundTransferAvailableEvent.Data;
|
|
3975
|
+
// Object containing the reference to API resource relevant to the event.
|
|
3976
|
+
related_object: V2.Core.Events.RelatedObject;
|
|
3977
|
+
// Retrieves the object associated with the event.
|
|
3978
|
+
fetchRelatedObject(): Promise<V2.MoneyManagement.InboundTransfer>;
|
|
3979
|
+
}
|
|
3980
|
+
export interface V2MoneyManagementInboundTransferAvailableEventNotification
|
|
3981
|
+
extends V2.Core.EventNotificationBase {
|
|
3982
|
+
type: 'v2.money_management.inbound_transfer.available';
|
|
3983
|
+
// Object containing the reference to API resource relevant to the event.
|
|
3984
|
+
related_object: V2.Core.Events.RelatedObject;
|
|
3985
|
+
// Retrieves the object associated with the event.
|
|
3986
|
+
fetchRelatedObject(): Promise<V2.MoneyManagement.InboundTransfer>;
|
|
3987
|
+
fetchEvent(): Promise<V2MoneyManagementInboundTransferAvailableEvent>;
|
|
3988
|
+
}
|
|
3989
|
+
|
|
3990
|
+
namespace V2MoneyManagementInboundTransferAvailableEvent {
|
|
3991
|
+
export interface Data {
|
|
3992
|
+
/**
|
|
3993
|
+
* The transaction ID of the received credit.
|
|
3994
|
+
*/
|
|
3995
|
+
transaction_id: string;
|
|
3996
|
+
}
|
|
3997
|
+
}
|
|
3998
|
+
|
|
3999
|
+
/**
|
|
4000
|
+
* Occurs when an InboundTransfer fails.
|
|
4001
|
+
*/
|
|
4002
|
+
export interface V2MoneyManagementInboundTransferBankDebitFailedEvent
|
|
4003
|
+
extends V2.Core.EventBase {
|
|
4004
|
+
type: 'v2.money_management.inbound_transfer.bank_debit_failed';
|
|
4005
|
+
// Object containing the reference to API resource relevant to the event.
|
|
4006
|
+
related_object: V2.Core.Events.RelatedObject;
|
|
4007
|
+
// Retrieves the object associated with the event.
|
|
4008
|
+
fetchRelatedObject(): Promise<V2.MoneyManagement.InboundTransfer>;
|
|
4009
|
+
}
|
|
4010
|
+
export interface V2MoneyManagementInboundTransferBankDebitFailedEventNotification
|
|
4011
|
+
extends V2.Core.EventNotificationBase {
|
|
4012
|
+
type: 'v2.money_management.inbound_transfer.bank_debit_failed';
|
|
4013
|
+
// Object containing the reference to API resource relevant to the event.
|
|
4014
|
+
related_object: V2.Core.Events.RelatedObject;
|
|
4015
|
+
// Retrieves the object associated with the event.
|
|
4016
|
+
fetchRelatedObject(): Promise<V2.MoneyManagement.InboundTransfer>;
|
|
4017
|
+
fetchEvent(): Promise<
|
|
4018
|
+
V2MoneyManagementInboundTransferBankDebitFailedEvent
|
|
4019
|
+
>;
|
|
4020
|
+
}
|
|
4021
|
+
|
|
4022
|
+
/**
|
|
4023
|
+
* Occurs when an InboundTransfer starts processing.
|
|
4024
|
+
*/
|
|
4025
|
+
export interface V2MoneyManagementInboundTransferBankDebitProcessingEvent
|
|
4026
|
+
extends V2.Core.EventBase {
|
|
4027
|
+
type: 'v2.money_management.inbound_transfer.bank_debit_processing';
|
|
4028
|
+
// Object containing the reference to API resource relevant to the event.
|
|
4029
|
+
related_object: V2.Core.Events.RelatedObject;
|
|
4030
|
+
// Retrieves the object associated with the event.
|
|
4031
|
+
fetchRelatedObject(): Promise<V2.MoneyManagement.InboundTransfer>;
|
|
4032
|
+
}
|
|
4033
|
+
export interface V2MoneyManagementInboundTransferBankDebitProcessingEventNotification
|
|
4034
|
+
extends V2.Core.EventNotificationBase {
|
|
4035
|
+
type: 'v2.money_management.inbound_transfer.bank_debit_processing';
|
|
4036
|
+
// Object containing the reference to API resource relevant to the event.
|
|
4037
|
+
related_object: V2.Core.Events.RelatedObject;
|
|
4038
|
+
// Retrieves the object associated with the event.
|
|
4039
|
+
fetchRelatedObject(): Promise<V2.MoneyManagement.InboundTransfer>;
|
|
4040
|
+
fetchEvent(): Promise<
|
|
4041
|
+
V2MoneyManagementInboundTransferBankDebitProcessingEvent
|
|
4042
|
+
>;
|
|
4043
|
+
}
|
|
4044
|
+
|
|
4045
|
+
/**
|
|
4046
|
+
* Occurs when an InboundTransfer is queued.
|
|
4047
|
+
*/
|
|
4048
|
+
export interface V2MoneyManagementInboundTransferBankDebitQueuedEvent
|
|
4049
|
+
extends V2.Core.EventBase {
|
|
4050
|
+
type: 'v2.money_management.inbound_transfer.bank_debit_queued';
|
|
4051
|
+
// Object containing the reference to API resource relevant to the event.
|
|
4052
|
+
related_object: V2.Core.Events.RelatedObject;
|
|
4053
|
+
// Retrieves the object associated with the event.
|
|
4054
|
+
fetchRelatedObject(): Promise<V2.MoneyManagement.InboundTransfer>;
|
|
4055
|
+
}
|
|
4056
|
+
export interface V2MoneyManagementInboundTransferBankDebitQueuedEventNotification
|
|
4057
|
+
extends V2.Core.EventNotificationBase {
|
|
4058
|
+
type: 'v2.money_management.inbound_transfer.bank_debit_queued';
|
|
4059
|
+
// Object containing the reference to API resource relevant to the event.
|
|
4060
|
+
related_object: V2.Core.Events.RelatedObject;
|
|
4061
|
+
// Retrieves the object associated with the event.
|
|
4062
|
+
fetchRelatedObject(): Promise<V2.MoneyManagement.InboundTransfer>;
|
|
4063
|
+
fetchEvent(): Promise<
|
|
4064
|
+
V2MoneyManagementInboundTransferBankDebitQueuedEvent
|
|
4065
|
+
>;
|
|
4066
|
+
}
|
|
4067
|
+
|
|
4068
|
+
/**
|
|
4069
|
+
* Occurs when an InboundTransfer is returned.
|
|
4070
|
+
*/
|
|
4071
|
+
export interface V2MoneyManagementInboundTransferBankDebitReturnedEvent
|
|
4072
|
+
extends V2.Core.EventBase {
|
|
4073
|
+
type: 'v2.money_management.inbound_transfer.bank_debit_returned';
|
|
4074
|
+
// Object containing the reference to API resource relevant to the event.
|
|
4075
|
+
related_object: V2.Core.Events.RelatedObject;
|
|
4076
|
+
// Retrieves the object associated with the event.
|
|
4077
|
+
fetchRelatedObject(): Promise<V2.MoneyManagement.InboundTransfer>;
|
|
4078
|
+
}
|
|
4079
|
+
export interface V2MoneyManagementInboundTransferBankDebitReturnedEventNotification
|
|
4080
|
+
extends V2.Core.EventNotificationBase {
|
|
4081
|
+
type: 'v2.money_management.inbound_transfer.bank_debit_returned';
|
|
4082
|
+
// Object containing the reference to API resource relevant to the event.
|
|
4083
|
+
related_object: V2.Core.Events.RelatedObject;
|
|
4084
|
+
// Retrieves the object associated with the event.
|
|
4085
|
+
fetchRelatedObject(): Promise<V2.MoneyManagement.InboundTransfer>;
|
|
4086
|
+
fetchEvent(): Promise<
|
|
4087
|
+
V2MoneyManagementInboundTransferBankDebitReturnedEvent
|
|
4088
|
+
>;
|
|
4089
|
+
}
|
|
4090
|
+
|
|
4091
|
+
/**
|
|
4092
|
+
* Occurs when an InboundTransfer succeeds.
|
|
4093
|
+
*/
|
|
4094
|
+
export interface V2MoneyManagementInboundTransferBankDebitSucceededEvent
|
|
4095
|
+
extends V2.Core.EventBase {
|
|
4096
|
+
type: 'v2.money_management.inbound_transfer.bank_debit_succeeded';
|
|
4097
|
+
// Object containing the reference to API resource relevant to the event.
|
|
4098
|
+
related_object: V2.Core.Events.RelatedObject;
|
|
4099
|
+
// Retrieves the object associated with the event.
|
|
4100
|
+
fetchRelatedObject(): Promise<V2.MoneyManagement.InboundTransfer>;
|
|
4101
|
+
}
|
|
4102
|
+
export interface V2MoneyManagementInboundTransferBankDebitSucceededEventNotification
|
|
4103
|
+
extends V2.Core.EventNotificationBase {
|
|
4104
|
+
type: 'v2.money_management.inbound_transfer.bank_debit_succeeded';
|
|
4105
|
+
// Object containing the reference to API resource relevant to the event.
|
|
4106
|
+
related_object: V2.Core.Events.RelatedObject;
|
|
4107
|
+
// Retrieves the object associated with the event.
|
|
4108
|
+
fetchRelatedObject(): Promise<V2.MoneyManagement.InboundTransfer>;
|
|
4109
|
+
fetchEvent(): Promise<
|
|
4110
|
+
V2MoneyManagementInboundTransferBankDebitSucceededEvent
|
|
4111
|
+
>;
|
|
4112
|
+
}
|
|
4113
|
+
|
|
4114
|
+
/**
|
|
4115
|
+
* Occurs when an OutboundPayment transitions into the canceled state.
|
|
4116
|
+
*/
|
|
4117
|
+
export interface V2MoneyManagementOutboundPaymentCanceledEvent
|
|
4118
|
+
extends V2.Core.EventBase {
|
|
4119
|
+
type: 'v2.money_management.outbound_payment.canceled';
|
|
4120
|
+
// Object containing the reference to API resource relevant to the event.
|
|
4121
|
+
related_object: V2.Core.Events.RelatedObject;
|
|
4122
|
+
// Retrieves the object associated with the event.
|
|
4123
|
+
fetchRelatedObject(): Promise<V2.MoneyManagement.OutboundPayment>;
|
|
4124
|
+
}
|
|
4125
|
+
export interface V2MoneyManagementOutboundPaymentCanceledEventNotification
|
|
4126
|
+
extends V2.Core.EventNotificationBase {
|
|
4127
|
+
type: 'v2.money_management.outbound_payment.canceled';
|
|
4128
|
+
// Object containing the reference to API resource relevant to the event.
|
|
4129
|
+
related_object: V2.Core.Events.RelatedObject;
|
|
4130
|
+
// Retrieves the object associated with the event.
|
|
4131
|
+
fetchRelatedObject(): Promise<V2.MoneyManagement.OutboundPayment>;
|
|
4132
|
+
fetchEvent(): Promise<V2MoneyManagementOutboundPaymentCanceledEvent>;
|
|
4133
|
+
}
|
|
4134
|
+
|
|
4135
|
+
/**
|
|
4136
|
+
* Occurs when an OutboundPayment is created.
|
|
4137
|
+
*/
|
|
4138
|
+
export interface V2MoneyManagementOutboundPaymentCreatedEvent
|
|
4139
|
+
extends V2.Core.EventBase {
|
|
4140
|
+
type: 'v2.money_management.outbound_payment.created';
|
|
4141
|
+
// Object containing the reference to API resource relevant to the event.
|
|
4142
|
+
related_object: V2.Core.Events.RelatedObject;
|
|
4143
|
+
// Retrieves the object associated with the event.
|
|
4144
|
+
fetchRelatedObject(): Promise<V2.MoneyManagement.OutboundPayment>;
|
|
4145
|
+
}
|
|
4146
|
+
export interface V2MoneyManagementOutboundPaymentCreatedEventNotification
|
|
4147
|
+
extends V2.Core.EventNotificationBase {
|
|
4148
|
+
type: 'v2.money_management.outbound_payment.created';
|
|
4149
|
+
// Object containing the reference to API resource relevant to the event.
|
|
4150
|
+
related_object: V2.Core.Events.RelatedObject;
|
|
4151
|
+
// Retrieves the object associated with the event.
|
|
4152
|
+
fetchRelatedObject(): Promise<V2.MoneyManagement.OutboundPayment>;
|
|
4153
|
+
fetchEvent(): Promise<V2MoneyManagementOutboundPaymentCreatedEvent>;
|
|
4154
|
+
}
|
|
4155
|
+
|
|
4156
|
+
/**
|
|
4157
|
+
* Occurs when an OutboundPayment transitions into the failed state.
|
|
4158
|
+
*/
|
|
4159
|
+
export interface V2MoneyManagementOutboundPaymentFailedEvent
|
|
4160
|
+
extends V2.Core.EventBase {
|
|
4161
|
+
type: 'v2.money_management.outbound_payment.failed';
|
|
4162
|
+
// Object containing the reference to API resource relevant to the event.
|
|
4163
|
+
related_object: V2.Core.Events.RelatedObject;
|
|
4164
|
+
// Retrieves the object associated with the event.
|
|
4165
|
+
fetchRelatedObject(): Promise<V2.MoneyManagement.OutboundPayment>;
|
|
4166
|
+
}
|
|
4167
|
+
export interface V2MoneyManagementOutboundPaymentFailedEventNotification
|
|
4168
|
+
extends V2.Core.EventNotificationBase {
|
|
4169
|
+
type: 'v2.money_management.outbound_payment.failed';
|
|
4170
|
+
// Object containing the reference to API resource relevant to the event.
|
|
4171
|
+
related_object: V2.Core.Events.RelatedObject;
|
|
4172
|
+
// Retrieves the object associated with the event.
|
|
4173
|
+
fetchRelatedObject(): Promise<V2.MoneyManagement.OutboundPayment>;
|
|
4174
|
+
fetchEvent(): Promise<V2MoneyManagementOutboundPaymentFailedEvent>;
|
|
4175
|
+
}
|
|
4176
|
+
|
|
4177
|
+
/**
|
|
4178
|
+
* Occurs when an OutboundPayment transitions into the posted state.
|
|
4179
|
+
*/
|
|
4180
|
+
export interface V2MoneyManagementOutboundPaymentPostedEvent
|
|
4181
|
+
extends V2.Core.EventBase {
|
|
4182
|
+
type: 'v2.money_management.outbound_payment.posted';
|
|
4183
|
+
// Object containing the reference to API resource relevant to the event.
|
|
4184
|
+
related_object: V2.Core.Events.RelatedObject;
|
|
4185
|
+
// Retrieves the object associated with the event.
|
|
4186
|
+
fetchRelatedObject(): Promise<V2.MoneyManagement.OutboundPayment>;
|
|
4187
|
+
}
|
|
4188
|
+
export interface V2MoneyManagementOutboundPaymentPostedEventNotification
|
|
4189
|
+
extends V2.Core.EventNotificationBase {
|
|
4190
|
+
type: 'v2.money_management.outbound_payment.posted';
|
|
4191
|
+
// Object containing the reference to API resource relevant to the event.
|
|
4192
|
+
related_object: V2.Core.Events.RelatedObject;
|
|
4193
|
+
// Retrieves the object associated with the event.
|
|
4194
|
+
fetchRelatedObject(): Promise<V2.MoneyManagement.OutboundPayment>;
|
|
4195
|
+
fetchEvent(): Promise<V2MoneyManagementOutboundPaymentPostedEvent>;
|
|
4196
|
+
}
|
|
4197
|
+
|
|
4198
|
+
/**
|
|
4199
|
+
* Occurs when an OutboundPayment transitions into the returned state.
|
|
4200
|
+
*/
|
|
4201
|
+
export interface V2MoneyManagementOutboundPaymentReturnedEvent
|
|
4202
|
+
extends V2.Core.EventBase {
|
|
4203
|
+
type: 'v2.money_management.outbound_payment.returned';
|
|
4204
|
+
// Object containing the reference to API resource relevant to the event.
|
|
4205
|
+
related_object: V2.Core.Events.RelatedObject;
|
|
4206
|
+
// Retrieves the object associated with the event.
|
|
4207
|
+
fetchRelatedObject(): Promise<V2.MoneyManagement.OutboundPayment>;
|
|
4208
|
+
}
|
|
4209
|
+
export interface V2MoneyManagementOutboundPaymentReturnedEventNotification
|
|
4210
|
+
extends V2.Core.EventNotificationBase {
|
|
4211
|
+
type: 'v2.money_management.outbound_payment.returned';
|
|
4212
|
+
// Object containing the reference to API resource relevant to the event.
|
|
4213
|
+
related_object: V2.Core.Events.RelatedObject;
|
|
4214
|
+
// Retrieves the object associated with the event.
|
|
4215
|
+
fetchRelatedObject(): Promise<V2.MoneyManagement.OutboundPayment>;
|
|
4216
|
+
fetchEvent(): Promise<V2MoneyManagementOutboundPaymentReturnedEvent>;
|
|
4217
|
+
}
|
|
4218
|
+
|
|
4219
|
+
/**
|
|
4220
|
+
* Occurs when an OutboundPayment is updated.
|
|
4221
|
+
*/
|
|
4222
|
+
export interface V2MoneyManagementOutboundPaymentUpdatedEvent
|
|
4223
|
+
extends V2.Core.EventBase {
|
|
4224
|
+
type: 'v2.money_management.outbound_payment.updated';
|
|
4225
|
+
// Object containing the reference to API resource relevant to the event.
|
|
4226
|
+
related_object: V2.Core.Events.RelatedObject;
|
|
4227
|
+
// Retrieves the object associated with the event.
|
|
4228
|
+
fetchRelatedObject(): Promise<V2.MoneyManagement.OutboundPayment>;
|
|
4229
|
+
}
|
|
4230
|
+
export interface V2MoneyManagementOutboundPaymentUpdatedEventNotification
|
|
4231
|
+
extends V2.Core.EventNotificationBase {
|
|
4232
|
+
type: 'v2.money_management.outbound_payment.updated';
|
|
4233
|
+
// Object containing the reference to API resource relevant to the event.
|
|
4234
|
+
related_object: V2.Core.Events.RelatedObject;
|
|
4235
|
+
// Retrieves the object associated with the event.
|
|
4236
|
+
fetchRelatedObject(): Promise<V2.MoneyManagement.OutboundPayment>;
|
|
4237
|
+
fetchEvent(): Promise<V2MoneyManagementOutboundPaymentUpdatedEvent>;
|
|
4238
|
+
}
|
|
4239
|
+
|
|
4240
|
+
/**
|
|
4241
|
+
* Occurs when an OutboundTransfer transitions into the canceled state.
|
|
4242
|
+
*/
|
|
4243
|
+
export interface V2MoneyManagementOutboundTransferCanceledEvent
|
|
4244
|
+
extends V2.Core.EventBase {
|
|
4245
|
+
type: 'v2.money_management.outbound_transfer.canceled';
|
|
4246
|
+
// Object containing the reference to API resource relevant to the event.
|
|
4247
|
+
related_object: V2.Core.Events.RelatedObject;
|
|
4248
|
+
// Retrieves the object associated with the event.
|
|
4249
|
+
fetchRelatedObject(): Promise<V2.MoneyManagement.OutboundTransfer>;
|
|
4250
|
+
}
|
|
4251
|
+
export interface V2MoneyManagementOutboundTransferCanceledEventNotification
|
|
4252
|
+
extends V2.Core.EventNotificationBase {
|
|
4253
|
+
type: 'v2.money_management.outbound_transfer.canceled';
|
|
4254
|
+
// Object containing the reference to API resource relevant to the event.
|
|
4255
|
+
related_object: V2.Core.Events.RelatedObject;
|
|
4256
|
+
// Retrieves the object associated with the event.
|
|
4257
|
+
fetchRelatedObject(): Promise<V2.MoneyManagement.OutboundTransfer>;
|
|
4258
|
+
fetchEvent(): Promise<V2MoneyManagementOutboundTransferCanceledEvent>;
|
|
4259
|
+
}
|
|
4260
|
+
|
|
4261
|
+
/**
|
|
4262
|
+
* Occurs when an OutboundTransfer is created.
|
|
4263
|
+
*/
|
|
4264
|
+
export interface V2MoneyManagementOutboundTransferCreatedEvent
|
|
4265
|
+
extends V2.Core.EventBase {
|
|
4266
|
+
type: 'v2.money_management.outbound_transfer.created';
|
|
4267
|
+
// Object containing the reference to API resource relevant to the event.
|
|
4268
|
+
related_object: V2.Core.Events.RelatedObject;
|
|
4269
|
+
// Retrieves the object associated with the event.
|
|
4270
|
+
fetchRelatedObject(): Promise<V2.MoneyManagement.OutboundTransfer>;
|
|
4271
|
+
}
|
|
4272
|
+
export interface V2MoneyManagementOutboundTransferCreatedEventNotification
|
|
4273
|
+
extends V2.Core.EventNotificationBase {
|
|
4274
|
+
type: 'v2.money_management.outbound_transfer.created';
|
|
4275
|
+
// Object containing the reference to API resource relevant to the event.
|
|
4276
|
+
related_object: V2.Core.Events.RelatedObject;
|
|
4277
|
+
// Retrieves the object associated with the event.
|
|
4278
|
+
fetchRelatedObject(): Promise<V2.MoneyManagement.OutboundTransfer>;
|
|
4279
|
+
fetchEvent(): Promise<V2MoneyManagementOutboundTransferCreatedEvent>;
|
|
4280
|
+
}
|
|
4281
|
+
|
|
4282
|
+
/**
|
|
4283
|
+
* Occurs when an OutboundTransfer transitions into the failed state.
|
|
4284
|
+
*/
|
|
4285
|
+
export interface V2MoneyManagementOutboundTransferFailedEvent
|
|
4286
|
+
extends V2.Core.EventBase {
|
|
4287
|
+
type: 'v2.money_management.outbound_transfer.failed';
|
|
4288
|
+
// Object containing the reference to API resource relevant to the event.
|
|
4289
|
+
related_object: V2.Core.Events.RelatedObject;
|
|
4290
|
+
// Retrieves the object associated with the event.
|
|
4291
|
+
fetchRelatedObject(): Promise<V2.MoneyManagement.OutboundTransfer>;
|
|
4292
|
+
}
|
|
4293
|
+
export interface V2MoneyManagementOutboundTransferFailedEventNotification
|
|
4294
|
+
extends V2.Core.EventNotificationBase {
|
|
4295
|
+
type: 'v2.money_management.outbound_transfer.failed';
|
|
4296
|
+
// Object containing the reference to API resource relevant to the event.
|
|
4297
|
+
related_object: V2.Core.Events.RelatedObject;
|
|
4298
|
+
// Retrieves the object associated with the event.
|
|
4299
|
+
fetchRelatedObject(): Promise<V2.MoneyManagement.OutboundTransfer>;
|
|
4300
|
+
fetchEvent(): Promise<V2MoneyManagementOutboundTransferFailedEvent>;
|
|
4301
|
+
}
|
|
4302
|
+
|
|
4303
|
+
/**
|
|
4304
|
+
* Occurs when an OutboundTransfer transitions into the posted state.
|
|
4305
|
+
*/
|
|
4306
|
+
export interface V2MoneyManagementOutboundTransferPostedEvent
|
|
4307
|
+
extends V2.Core.EventBase {
|
|
4308
|
+
type: 'v2.money_management.outbound_transfer.posted';
|
|
4309
|
+
// Object containing the reference to API resource relevant to the event.
|
|
4310
|
+
related_object: V2.Core.Events.RelatedObject;
|
|
4311
|
+
// Retrieves the object associated with the event.
|
|
4312
|
+
fetchRelatedObject(): Promise<V2.MoneyManagement.OutboundTransfer>;
|
|
4313
|
+
}
|
|
4314
|
+
export interface V2MoneyManagementOutboundTransferPostedEventNotification
|
|
4315
|
+
extends V2.Core.EventNotificationBase {
|
|
4316
|
+
type: 'v2.money_management.outbound_transfer.posted';
|
|
4317
|
+
// Object containing the reference to API resource relevant to the event.
|
|
4318
|
+
related_object: V2.Core.Events.RelatedObject;
|
|
4319
|
+
// Retrieves the object associated with the event.
|
|
4320
|
+
fetchRelatedObject(): Promise<V2.MoneyManagement.OutboundTransfer>;
|
|
4321
|
+
fetchEvent(): Promise<V2MoneyManagementOutboundTransferPostedEvent>;
|
|
4322
|
+
}
|
|
4323
|
+
|
|
4324
|
+
/**
|
|
4325
|
+
* Occurs when an OutboundTransfer transitions into the returned state.
|
|
4326
|
+
*/
|
|
4327
|
+
export interface V2MoneyManagementOutboundTransferReturnedEvent
|
|
4328
|
+
extends V2.Core.EventBase {
|
|
4329
|
+
type: 'v2.money_management.outbound_transfer.returned';
|
|
4330
|
+
// Object containing the reference to API resource relevant to the event.
|
|
4331
|
+
related_object: V2.Core.Events.RelatedObject;
|
|
4332
|
+
// Retrieves the object associated with the event.
|
|
4333
|
+
fetchRelatedObject(): Promise<V2.MoneyManagement.OutboundTransfer>;
|
|
4334
|
+
}
|
|
4335
|
+
export interface V2MoneyManagementOutboundTransferReturnedEventNotification
|
|
4336
|
+
extends V2.Core.EventNotificationBase {
|
|
4337
|
+
type: 'v2.money_management.outbound_transfer.returned';
|
|
4338
|
+
// Object containing the reference to API resource relevant to the event.
|
|
4339
|
+
related_object: V2.Core.Events.RelatedObject;
|
|
4340
|
+
// Retrieves the object associated with the event.
|
|
4341
|
+
fetchRelatedObject(): Promise<V2.MoneyManagement.OutboundTransfer>;
|
|
4342
|
+
fetchEvent(): Promise<V2MoneyManagementOutboundTransferReturnedEvent>;
|
|
4343
|
+
}
|
|
4344
|
+
|
|
4345
|
+
/**
|
|
4346
|
+
* Event that is emitted every time an Outbound Transfer is updated.
|
|
4347
|
+
*/
|
|
4348
|
+
export interface V2MoneyManagementOutboundTransferUpdatedEvent
|
|
4349
|
+
extends V2.Core.EventBase {
|
|
4350
|
+
type: 'v2.money_management.outbound_transfer.updated';
|
|
4351
|
+
// Object containing the reference to API resource relevant to the event.
|
|
4352
|
+
related_object: V2.Core.Events.RelatedObject;
|
|
4353
|
+
// Retrieves the object associated with the event.
|
|
4354
|
+
fetchRelatedObject(): Promise<V2.MoneyManagement.OutboundTransfer>;
|
|
4355
|
+
}
|
|
4356
|
+
export interface V2MoneyManagementOutboundTransferUpdatedEventNotification
|
|
4357
|
+
extends V2.Core.EventNotificationBase {
|
|
4358
|
+
type: 'v2.money_management.outbound_transfer.updated';
|
|
4359
|
+
// Object containing the reference to API resource relevant to the event.
|
|
4360
|
+
related_object: V2.Core.Events.RelatedObject;
|
|
4361
|
+
// Retrieves the object associated with the event.
|
|
4362
|
+
fetchRelatedObject(): Promise<V2.MoneyManagement.OutboundTransfer>;
|
|
4363
|
+
fetchEvent(): Promise<V2MoneyManagementOutboundTransferUpdatedEvent>;
|
|
4364
|
+
}
|
|
4365
|
+
|
|
4366
|
+
/**
|
|
4367
|
+
* Occurs when a PayoutMethod is updated.
|
|
4368
|
+
*/
|
|
4369
|
+
export interface V2MoneyManagementPayoutMethodUpdatedEvent
|
|
4370
|
+
extends V2.Core.EventBase {
|
|
4371
|
+
type: 'v2.money_management.payout_method.updated';
|
|
4372
|
+
// Object containing the reference to API resource relevant to the event.
|
|
4373
|
+
related_object: V2.Core.Events.RelatedObject;
|
|
4374
|
+
// Retrieves the object associated with the event.
|
|
4375
|
+
fetchRelatedObject(): Promise<V2.MoneyManagement.PayoutMethod>;
|
|
4376
|
+
}
|
|
4377
|
+
export interface V2MoneyManagementPayoutMethodUpdatedEventNotification
|
|
4378
|
+
extends V2.Core.EventNotificationBase {
|
|
4379
|
+
type: 'v2.money_management.payout_method.updated';
|
|
4380
|
+
// Object containing the reference to API resource relevant to the event.
|
|
4381
|
+
related_object: V2.Core.Events.RelatedObject;
|
|
4382
|
+
// Retrieves the object associated with the event.
|
|
4383
|
+
fetchRelatedObject(): Promise<V2.MoneyManagement.PayoutMethod>;
|
|
4384
|
+
fetchEvent(): Promise<V2MoneyManagementPayoutMethodUpdatedEvent>;
|
|
4385
|
+
}
|
|
4386
|
+
|
|
4387
|
+
/**
|
|
4388
|
+
* Occurs when a ReceivedCredit's funds are received and are available in your balance.
|
|
4389
|
+
*/
|
|
4390
|
+
export interface V2MoneyManagementReceivedCreditAvailableEvent
|
|
4391
|
+
extends V2.Core.EventBase {
|
|
4392
|
+
type: 'v2.money_management.received_credit.available';
|
|
4393
|
+
// Retrieves data specific to this event.
|
|
4394
|
+
data: V2MoneyManagementReceivedCreditAvailableEvent.Data;
|
|
4395
|
+
// Object containing the reference to API resource relevant to the event.
|
|
4396
|
+
related_object: V2.Core.Events.RelatedObject;
|
|
4397
|
+
// Retrieves the object associated with the event.
|
|
4398
|
+
fetchRelatedObject(): Promise<V2.MoneyManagement.ReceivedCredit>;
|
|
4399
|
+
}
|
|
4400
|
+
export interface V2MoneyManagementReceivedCreditAvailableEventNotification
|
|
4401
|
+
extends V2.Core.EventNotificationBase {
|
|
4402
|
+
type: 'v2.money_management.received_credit.available';
|
|
4403
|
+
// Object containing the reference to API resource relevant to the event.
|
|
4404
|
+
related_object: V2.Core.Events.RelatedObject;
|
|
4405
|
+
// Retrieves the object associated with the event.
|
|
4406
|
+
fetchRelatedObject(): Promise<V2.MoneyManagement.ReceivedCredit>;
|
|
4407
|
+
fetchEvent(): Promise<V2MoneyManagementReceivedCreditAvailableEvent>;
|
|
4408
|
+
}
|
|
4409
|
+
|
|
4410
|
+
namespace V2MoneyManagementReceivedCreditAvailableEvent {
|
|
4411
|
+
export interface Data {
|
|
4412
|
+
/**
|
|
4413
|
+
* The transaction ID of the received credit.
|
|
4414
|
+
*/
|
|
4415
|
+
transaction_id: string;
|
|
4416
|
+
}
|
|
4417
|
+
}
|
|
4418
|
+
|
|
4419
|
+
/**
|
|
4420
|
+
* Occurs when a ReceivedCredit is attempted to your balance and fails. See the status_details for more information.
|
|
4421
|
+
*/
|
|
4422
|
+
export interface V2MoneyManagementReceivedCreditFailedEvent
|
|
4423
|
+
extends V2.Core.EventBase {
|
|
4424
|
+
type: 'v2.money_management.received_credit.failed';
|
|
4425
|
+
// Object containing the reference to API resource relevant to the event.
|
|
4426
|
+
related_object: V2.Core.Events.RelatedObject;
|
|
4427
|
+
// Retrieves the object associated with the event.
|
|
4428
|
+
fetchRelatedObject(): Promise<V2.MoneyManagement.ReceivedCredit>;
|
|
4429
|
+
}
|
|
4430
|
+
export interface V2MoneyManagementReceivedCreditFailedEventNotification
|
|
4431
|
+
extends V2.Core.EventNotificationBase {
|
|
4432
|
+
type: 'v2.money_management.received_credit.failed';
|
|
4433
|
+
// Object containing the reference to API resource relevant to the event.
|
|
4434
|
+
related_object: V2.Core.Events.RelatedObject;
|
|
4435
|
+
// Retrieves the object associated with the event.
|
|
4436
|
+
fetchRelatedObject(): Promise<V2.MoneyManagement.ReceivedCredit>;
|
|
4437
|
+
fetchEvent(): Promise<V2MoneyManagementReceivedCreditFailedEvent>;
|
|
4438
|
+
}
|
|
4439
|
+
|
|
4440
|
+
/**
|
|
4441
|
+
* Occurs when a ReceivedCredit is reversed, returned to the originator, and deducted from your balance.
|
|
4442
|
+
*/
|
|
4443
|
+
export interface V2MoneyManagementReceivedCreditReturnedEvent
|
|
4444
|
+
extends V2.Core.EventBase {
|
|
4445
|
+
type: 'v2.money_management.received_credit.returned';
|
|
4446
|
+
// Object containing the reference to API resource relevant to the event.
|
|
4447
|
+
related_object: V2.Core.Events.RelatedObject;
|
|
4448
|
+
// Retrieves the object associated with the event.
|
|
4449
|
+
fetchRelatedObject(): Promise<V2.MoneyManagement.ReceivedCredit>;
|
|
4450
|
+
}
|
|
4451
|
+
export interface V2MoneyManagementReceivedCreditReturnedEventNotification
|
|
4452
|
+
extends V2.Core.EventNotificationBase {
|
|
4453
|
+
type: 'v2.money_management.received_credit.returned';
|
|
4454
|
+
// Object containing the reference to API resource relevant to the event.
|
|
4455
|
+
related_object: V2.Core.Events.RelatedObject;
|
|
4456
|
+
// Retrieves the object associated with the event.
|
|
4457
|
+
fetchRelatedObject(): Promise<V2.MoneyManagement.ReceivedCredit>;
|
|
4458
|
+
fetchEvent(): Promise<V2MoneyManagementReceivedCreditReturnedEvent>;
|
|
4459
|
+
}
|
|
4460
|
+
|
|
4461
|
+
/**
|
|
4462
|
+
* Occurs when a ReceivedCredit succeeds.
|
|
4463
|
+
*/
|
|
4464
|
+
export interface V2MoneyManagementReceivedCreditSucceededEvent
|
|
4465
|
+
extends V2.Core.EventBase {
|
|
4466
|
+
type: 'v2.money_management.received_credit.succeeded';
|
|
4467
|
+
// Object containing the reference to API resource relevant to the event.
|
|
4468
|
+
related_object: V2.Core.Events.RelatedObject;
|
|
4469
|
+
// Retrieves the object associated with the event.
|
|
4470
|
+
fetchRelatedObject(): Promise<V2.MoneyManagement.ReceivedCredit>;
|
|
4471
|
+
}
|
|
4472
|
+
export interface V2MoneyManagementReceivedCreditSucceededEventNotification
|
|
4473
|
+
extends V2.Core.EventNotificationBase {
|
|
4474
|
+
type: 'v2.money_management.received_credit.succeeded';
|
|
4475
|
+
// Object containing the reference to API resource relevant to the event.
|
|
4476
|
+
related_object: V2.Core.Events.RelatedObject;
|
|
4477
|
+
// Retrieves the object associated with the event.
|
|
4478
|
+
fetchRelatedObject(): Promise<V2.MoneyManagement.ReceivedCredit>;
|
|
4479
|
+
fetchEvent(): Promise<V2MoneyManagementReceivedCreditSucceededEvent>;
|
|
4480
|
+
}
|
|
4481
|
+
|
|
4482
|
+
/**
|
|
4483
|
+
* Occurs when a ReceivedDebit is canceled.
|
|
4484
|
+
*/
|
|
4485
|
+
export interface V2MoneyManagementReceivedDebitCanceledEvent
|
|
4486
|
+
extends V2.Core.EventBase {
|
|
4487
|
+
type: 'v2.money_management.received_debit.canceled';
|
|
4488
|
+
// Object containing the reference to API resource relevant to the event.
|
|
4489
|
+
related_object: V2.Core.Events.RelatedObject;
|
|
4490
|
+
// Retrieves the object associated with the event.
|
|
4491
|
+
fetchRelatedObject(): Promise<V2.MoneyManagement.ReceivedDebit>;
|
|
4492
|
+
}
|
|
4493
|
+
export interface V2MoneyManagementReceivedDebitCanceledEventNotification
|
|
4494
|
+
extends V2.Core.EventNotificationBase {
|
|
4495
|
+
type: 'v2.money_management.received_debit.canceled';
|
|
4496
|
+
// Object containing the reference to API resource relevant to the event.
|
|
4497
|
+
related_object: V2.Core.Events.RelatedObject;
|
|
4498
|
+
// Retrieves the object associated with the event.
|
|
4499
|
+
fetchRelatedObject(): Promise<V2.MoneyManagement.ReceivedDebit>;
|
|
4500
|
+
fetchEvent(): Promise<V2MoneyManagementReceivedDebitCanceledEvent>;
|
|
4501
|
+
}
|
|
4502
|
+
|
|
4503
|
+
/**
|
|
4504
|
+
* Occurs when a ReceivedDebit fails.
|
|
4505
|
+
*/
|
|
4506
|
+
export interface V2MoneyManagementReceivedDebitFailedEvent
|
|
4507
|
+
extends V2.Core.EventBase {
|
|
4508
|
+
type: 'v2.money_management.received_debit.failed';
|
|
4509
|
+
// Object containing the reference to API resource relevant to the event.
|
|
4510
|
+
related_object: V2.Core.Events.RelatedObject;
|
|
4511
|
+
// Retrieves the object associated with the event.
|
|
4512
|
+
fetchRelatedObject(): Promise<V2.MoneyManagement.ReceivedDebit>;
|
|
4513
|
+
}
|
|
4514
|
+
export interface V2MoneyManagementReceivedDebitFailedEventNotification
|
|
4515
|
+
extends V2.Core.EventNotificationBase {
|
|
4516
|
+
type: 'v2.money_management.received_debit.failed';
|
|
4517
|
+
// Object containing the reference to API resource relevant to the event.
|
|
4518
|
+
related_object: V2.Core.Events.RelatedObject;
|
|
4519
|
+
// Retrieves the object associated with the event.
|
|
4520
|
+
fetchRelatedObject(): Promise<V2.MoneyManagement.ReceivedDebit>;
|
|
4521
|
+
fetchEvent(): Promise<V2MoneyManagementReceivedDebitFailedEvent>;
|
|
4522
|
+
}
|
|
4523
|
+
|
|
4524
|
+
/**
|
|
4525
|
+
* Occurs when a ReceivedDebit is set to pending.
|
|
4526
|
+
*/
|
|
4527
|
+
export interface V2MoneyManagementReceivedDebitPendingEvent
|
|
4528
|
+
extends V2.Core.EventBase {
|
|
4529
|
+
type: 'v2.money_management.received_debit.pending';
|
|
4530
|
+
// Object containing the reference to API resource relevant to the event.
|
|
4531
|
+
related_object: V2.Core.Events.RelatedObject;
|
|
4532
|
+
// Retrieves the object associated with the event.
|
|
4533
|
+
fetchRelatedObject(): Promise<V2.MoneyManagement.ReceivedDebit>;
|
|
4534
|
+
}
|
|
4535
|
+
export interface V2MoneyManagementReceivedDebitPendingEventNotification
|
|
4536
|
+
extends V2.Core.EventNotificationBase {
|
|
4537
|
+
type: 'v2.money_management.received_debit.pending';
|
|
4538
|
+
// Object containing the reference to API resource relevant to the event.
|
|
4539
|
+
related_object: V2.Core.Events.RelatedObject;
|
|
4540
|
+
// Retrieves the object associated with the event.
|
|
4541
|
+
fetchRelatedObject(): Promise<V2.MoneyManagement.ReceivedDebit>;
|
|
4542
|
+
fetchEvent(): Promise<V2MoneyManagementReceivedDebitPendingEvent>;
|
|
4543
|
+
}
|
|
4544
|
+
|
|
4545
|
+
/**
|
|
4546
|
+
* Occurs when a ReceivedDebit succeeds.
|
|
4547
|
+
*/
|
|
4548
|
+
export interface V2MoneyManagementReceivedDebitSucceededEvent
|
|
4549
|
+
extends V2.Core.EventBase {
|
|
4550
|
+
type: 'v2.money_management.received_debit.succeeded';
|
|
241
4551
|
// Object containing the reference to API resource relevant to the event.
|
|
242
4552
|
related_object: V2.Core.Events.RelatedObject;
|
|
243
4553
|
// Retrieves the object associated with the event.
|
|
244
|
-
fetchRelatedObject(): Promise<V2.
|
|
4554
|
+
fetchRelatedObject(): Promise<V2.MoneyManagement.ReceivedDebit>;
|
|
245
4555
|
}
|
|
246
|
-
export interface
|
|
4556
|
+
export interface V2MoneyManagementReceivedDebitSucceededEventNotification
|
|
247
4557
|
extends V2.Core.EventNotificationBase {
|
|
248
|
-
type: 'v2.
|
|
4558
|
+
type: 'v2.money_management.received_debit.succeeded';
|
|
249
4559
|
// Object containing the reference to API resource relevant to the event.
|
|
250
4560
|
related_object: V2.Core.Events.RelatedObject;
|
|
251
4561
|
// Retrieves the object associated with the event.
|
|
252
|
-
fetchRelatedObject(): Promise<V2.
|
|
253
|
-
fetchEvent(): Promise<
|
|
4562
|
+
fetchRelatedObject(): Promise<V2.MoneyManagement.ReceivedDebit>;
|
|
4563
|
+
fetchEvent(): Promise<V2MoneyManagementReceivedDebitSucceededEvent>;
|
|
4564
|
+
}
|
|
4565
|
+
|
|
4566
|
+
/**
|
|
4567
|
+
* Occurs when a ReceivedDebit is updated.
|
|
4568
|
+
*/
|
|
4569
|
+
export interface V2MoneyManagementReceivedDebitUpdatedEvent
|
|
4570
|
+
extends V2.Core.EventBase {
|
|
4571
|
+
type: 'v2.money_management.received_debit.updated';
|
|
4572
|
+
// Object containing the reference to API resource relevant to the event.
|
|
4573
|
+
related_object: V2.Core.Events.RelatedObject;
|
|
4574
|
+
// Retrieves the object associated with the event.
|
|
4575
|
+
fetchRelatedObject(): Promise<V2.MoneyManagement.ReceivedDebit>;
|
|
4576
|
+
}
|
|
4577
|
+
export interface V2MoneyManagementReceivedDebitUpdatedEventNotification
|
|
4578
|
+
extends V2.Core.EventNotificationBase {
|
|
4579
|
+
type: 'v2.money_management.received_debit.updated';
|
|
4580
|
+
// Object containing the reference to API resource relevant to the event.
|
|
4581
|
+
related_object: V2.Core.Events.RelatedObject;
|
|
4582
|
+
// Retrieves the object associated with the event.
|
|
4583
|
+
fetchRelatedObject(): Promise<V2.MoneyManagement.ReceivedDebit>;
|
|
4584
|
+
fetchEvent(): Promise<V2MoneyManagementReceivedDebitUpdatedEvent>;
|
|
4585
|
+
}
|
|
4586
|
+
|
|
4587
|
+
/**
|
|
4588
|
+
* Occurs when a RecipientVerification is created.
|
|
4589
|
+
*/
|
|
4590
|
+
export interface V2MoneyManagementRecipientVerificationCreatedEvent
|
|
4591
|
+
extends V2.Core.EventBase {
|
|
4592
|
+
type: 'v2.money_management.recipient_verification.created';
|
|
4593
|
+
// Object containing the reference to API resource relevant to the event.
|
|
4594
|
+
related_object: V2.Core.Events.RelatedObject;
|
|
4595
|
+
// Retrieves the object associated with the event.
|
|
4596
|
+
fetchRelatedObject(): Promise<V2.MoneyManagement.RecipientVerification>;
|
|
4597
|
+
}
|
|
4598
|
+
export interface V2MoneyManagementRecipientVerificationCreatedEventNotification
|
|
4599
|
+
extends V2.Core.EventNotificationBase {
|
|
4600
|
+
type: 'v2.money_management.recipient_verification.created';
|
|
4601
|
+
// Object containing the reference to API resource relevant to the event.
|
|
4602
|
+
related_object: V2.Core.Events.RelatedObject;
|
|
4603
|
+
// Retrieves the object associated with the event.
|
|
4604
|
+
fetchRelatedObject(): Promise<V2.MoneyManagement.RecipientVerification>;
|
|
4605
|
+
fetchEvent(): Promise<V2MoneyManagementRecipientVerificationCreatedEvent>;
|
|
4606
|
+
}
|
|
4607
|
+
|
|
4608
|
+
/**
|
|
4609
|
+
* Occurs when a RecipientVerification is updated.
|
|
4610
|
+
*/
|
|
4611
|
+
export interface V2MoneyManagementRecipientVerificationUpdatedEvent
|
|
4612
|
+
extends V2.Core.EventBase {
|
|
4613
|
+
type: 'v2.money_management.recipient_verification.updated';
|
|
4614
|
+
// Object containing the reference to API resource relevant to the event.
|
|
4615
|
+
related_object: V2.Core.Events.RelatedObject;
|
|
4616
|
+
// Retrieves the object associated with the event.
|
|
4617
|
+
fetchRelatedObject(): Promise<V2.MoneyManagement.RecipientVerification>;
|
|
4618
|
+
}
|
|
4619
|
+
export interface V2MoneyManagementRecipientVerificationUpdatedEventNotification
|
|
4620
|
+
extends V2.Core.EventNotificationBase {
|
|
4621
|
+
type: 'v2.money_management.recipient_verification.updated';
|
|
4622
|
+
// Object containing the reference to API resource relevant to the event.
|
|
4623
|
+
related_object: V2.Core.Events.RelatedObject;
|
|
4624
|
+
// Retrieves the object associated with the event.
|
|
4625
|
+
fetchRelatedObject(): Promise<V2.MoneyManagement.RecipientVerification>;
|
|
4626
|
+
fetchEvent(): Promise<V2MoneyManagementRecipientVerificationUpdatedEvent>;
|
|
4627
|
+
}
|
|
4628
|
+
|
|
4629
|
+
/**
|
|
4630
|
+
* Occurs when a Transaction is created.
|
|
4631
|
+
*/
|
|
4632
|
+
export interface V2MoneyManagementTransactionCreatedEvent
|
|
4633
|
+
extends V2.Core.EventBase {
|
|
4634
|
+
type: 'v2.money_management.transaction.created';
|
|
4635
|
+
// Retrieves data specific to this event.
|
|
4636
|
+
data: V2MoneyManagementTransactionCreatedEvent.Data;
|
|
4637
|
+
// Object containing the reference to API resource relevant to the event.
|
|
4638
|
+
related_object: V2.Core.Events.RelatedObject;
|
|
4639
|
+
// Retrieves the object associated with the event.
|
|
4640
|
+
fetchRelatedObject(): Promise<V2.MoneyManagement.Transaction>;
|
|
4641
|
+
}
|
|
4642
|
+
export interface V2MoneyManagementTransactionCreatedEventNotification
|
|
4643
|
+
extends V2.Core.EventNotificationBase {
|
|
4644
|
+
type: 'v2.money_management.transaction.created';
|
|
4645
|
+
// Object containing the reference to API resource relevant to the event.
|
|
4646
|
+
related_object: V2.Core.Events.RelatedObject;
|
|
4647
|
+
// Retrieves the object associated with the event.
|
|
4648
|
+
fetchRelatedObject(): Promise<V2.MoneyManagement.Transaction>;
|
|
4649
|
+
fetchEvent(): Promise<V2MoneyManagementTransactionCreatedEvent>;
|
|
4650
|
+
}
|
|
4651
|
+
|
|
4652
|
+
namespace V2MoneyManagementTransactionCreatedEvent {
|
|
4653
|
+
export interface Data {
|
|
4654
|
+
/**
|
|
4655
|
+
* Id of the v1 Transaction corresponding to this Transaction.
|
|
4656
|
+
*/
|
|
4657
|
+
v1_id?: string;
|
|
4658
|
+
}
|
|
4659
|
+
}
|
|
4660
|
+
|
|
4661
|
+
/**
|
|
4662
|
+
* Occurs when a Transaction is updated.
|
|
4663
|
+
*/
|
|
4664
|
+
export interface V2MoneyManagementTransactionUpdatedEvent
|
|
4665
|
+
extends V2.Core.EventBase {
|
|
4666
|
+
type: 'v2.money_management.transaction.updated';
|
|
4667
|
+
// Object containing the reference to API resource relevant to the event.
|
|
4668
|
+
related_object: V2.Core.Events.RelatedObject;
|
|
4669
|
+
// Retrieves the object associated with the event.
|
|
4670
|
+
fetchRelatedObject(): Promise<V2.MoneyManagement.Transaction>;
|
|
4671
|
+
}
|
|
4672
|
+
export interface V2MoneyManagementTransactionUpdatedEventNotification
|
|
4673
|
+
extends V2.Core.EventNotificationBase {
|
|
4674
|
+
type: 'v2.money_management.transaction.updated';
|
|
4675
|
+
// Object containing the reference to API resource relevant to the event.
|
|
4676
|
+
related_object: V2.Core.Events.RelatedObject;
|
|
4677
|
+
// Retrieves the object associated with the event.
|
|
4678
|
+
fetchRelatedObject(): Promise<V2.MoneyManagement.Transaction>;
|
|
4679
|
+
fetchEvent(): Promise<V2MoneyManagementTransactionUpdatedEvent>;
|
|
4680
|
+
}
|
|
4681
|
+
|
|
4682
|
+
/**
|
|
4683
|
+
* Sent after a failed attempt if there are still retries available on the OffSessionPayment.
|
|
4684
|
+
*/
|
|
4685
|
+
export interface V2PaymentsOffSessionPaymentAttemptFailedEvent
|
|
4686
|
+
extends V2.Core.EventBase {
|
|
4687
|
+
type: 'v2.payments.off_session_payment.attempt_failed';
|
|
4688
|
+
// Object containing the reference to API resource relevant to the event.
|
|
4689
|
+
related_object: V2.Core.Events.RelatedObject;
|
|
4690
|
+
// Retrieves the object associated with the event.
|
|
4691
|
+
fetchRelatedObject(): Promise<V2.Payments.OffSessionPayment>;
|
|
4692
|
+
}
|
|
4693
|
+
export interface V2PaymentsOffSessionPaymentAttemptFailedEventNotification
|
|
4694
|
+
extends V2.Core.EventNotificationBase {
|
|
4695
|
+
type: 'v2.payments.off_session_payment.attempt_failed';
|
|
4696
|
+
// Object containing the reference to API resource relevant to the event.
|
|
4697
|
+
related_object: V2.Core.Events.RelatedObject;
|
|
4698
|
+
// Retrieves the object associated with the event.
|
|
4699
|
+
fetchRelatedObject(): Promise<V2.Payments.OffSessionPayment>;
|
|
4700
|
+
fetchEvent(): Promise<V2PaymentsOffSessionPaymentAttemptFailedEvent>;
|
|
4701
|
+
}
|
|
4702
|
+
|
|
4703
|
+
/**
|
|
4704
|
+
* Sent when our internal scheduling system kicks off an attempt, whether it's a
|
|
4705
|
+
* retry or an initial attempt.
|
|
4706
|
+
*/
|
|
4707
|
+
export interface V2PaymentsOffSessionPaymentAttemptStartedEvent
|
|
4708
|
+
extends V2.Core.EventBase {
|
|
4709
|
+
type: 'v2.payments.off_session_payment.attempt_started';
|
|
4710
|
+
// Object containing the reference to API resource relevant to the event.
|
|
4711
|
+
related_object: V2.Core.Events.RelatedObject;
|
|
4712
|
+
// Retrieves the object associated with the event.
|
|
4713
|
+
fetchRelatedObject(): Promise<V2.Payments.OffSessionPayment>;
|
|
4714
|
+
}
|
|
4715
|
+
export interface V2PaymentsOffSessionPaymentAttemptStartedEventNotification
|
|
4716
|
+
extends V2.Core.EventNotificationBase {
|
|
4717
|
+
type: 'v2.payments.off_session_payment.attempt_started';
|
|
4718
|
+
// Object containing the reference to API resource relevant to the event.
|
|
4719
|
+
related_object: V2.Core.Events.RelatedObject;
|
|
4720
|
+
// Retrieves the object associated with the event.
|
|
4721
|
+
fetchRelatedObject(): Promise<V2.Payments.OffSessionPayment>;
|
|
4722
|
+
fetchEvent(): Promise<V2PaymentsOffSessionPaymentAttemptStartedEvent>;
|
|
4723
|
+
}
|
|
4724
|
+
|
|
4725
|
+
/**
|
|
4726
|
+
* Sent after a failed authorization if there are still retries available on the OffSessionPayment.
|
|
4727
|
+
* This event has been renamed this to attempt_failed, but we are keeping this around for backwards compatibility.
|
|
4728
|
+
*/
|
|
4729
|
+
export interface V2PaymentsOffSessionPaymentAuthorizationAttemptFailedEvent
|
|
4730
|
+
extends V2.Core.EventBase {
|
|
4731
|
+
type: 'v2.payments.off_session_payment.authorization_attempt_failed';
|
|
4732
|
+
// Object containing the reference to API resource relevant to the event.
|
|
4733
|
+
related_object: V2.Core.Events.RelatedObject;
|
|
4734
|
+
// Retrieves the object associated with the event.
|
|
4735
|
+
fetchRelatedObject(): Promise<V2.Payments.OffSessionPayment>;
|
|
4736
|
+
}
|
|
4737
|
+
export interface V2PaymentsOffSessionPaymentAuthorizationAttemptFailedEventNotification
|
|
4738
|
+
extends V2.Core.EventNotificationBase {
|
|
4739
|
+
type: 'v2.payments.off_session_payment.authorization_attempt_failed';
|
|
4740
|
+
// Object containing the reference to API resource relevant to the event.
|
|
4741
|
+
related_object: V2.Core.Events.RelatedObject;
|
|
4742
|
+
// Retrieves the object associated with the event.
|
|
4743
|
+
fetchRelatedObject(): Promise<V2.Payments.OffSessionPayment>;
|
|
4744
|
+
fetchEvent(): Promise<
|
|
4745
|
+
V2PaymentsOffSessionPaymentAuthorizationAttemptFailedEvent
|
|
4746
|
+
>;
|
|
4747
|
+
}
|
|
4748
|
+
|
|
4749
|
+
/**
|
|
4750
|
+
* Sent when our internal scheduling system kicks off an attempt at authorization, whether it's a
|
|
4751
|
+
* retry or an initial authorization.
|
|
4752
|
+
* This event has been renamed this to attempt_failed, but we are keeping this around for backwards compatibility.
|
|
4753
|
+
*/
|
|
4754
|
+
export interface V2PaymentsOffSessionPaymentAuthorizationAttemptStartedEvent
|
|
4755
|
+
extends V2.Core.EventBase {
|
|
4756
|
+
type: 'v2.payments.off_session_payment.authorization_attempt_started';
|
|
4757
|
+
// Object containing the reference to API resource relevant to the event.
|
|
4758
|
+
related_object: V2.Core.Events.RelatedObject;
|
|
4759
|
+
// Retrieves the object associated with the event.
|
|
4760
|
+
fetchRelatedObject(): Promise<V2.Payments.OffSessionPayment>;
|
|
4761
|
+
}
|
|
4762
|
+
export interface V2PaymentsOffSessionPaymentAuthorizationAttemptStartedEventNotification
|
|
4763
|
+
extends V2.Core.EventNotificationBase {
|
|
4764
|
+
type: 'v2.payments.off_session_payment.authorization_attempt_started';
|
|
4765
|
+
// Object containing the reference to API resource relevant to the event.
|
|
4766
|
+
related_object: V2.Core.Events.RelatedObject;
|
|
4767
|
+
// Retrieves the object associated with the event.
|
|
4768
|
+
fetchRelatedObject(): Promise<V2.Payments.OffSessionPayment>;
|
|
4769
|
+
fetchEvent(): Promise<
|
|
4770
|
+
V2PaymentsOffSessionPaymentAuthorizationAttemptStartedEvent
|
|
4771
|
+
>;
|
|
4772
|
+
}
|
|
4773
|
+
|
|
4774
|
+
/**
|
|
4775
|
+
* Sent immediately following a user's call to the Off-Session Payments cancel endpoint.
|
|
4776
|
+
*/
|
|
4777
|
+
export interface V2PaymentsOffSessionPaymentCanceledEvent
|
|
4778
|
+
extends V2.Core.EventBase {
|
|
4779
|
+
type: 'v2.payments.off_session_payment.canceled';
|
|
4780
|
+
// Object containing the reference to API resource relevant to the event.
|
|
4781
|
+
related_object: V2.Core.Events.RelatedObject;
|
|
4782
|
+
// Retrieves the object associated with the event.
|
|
4783
|
+
fetchRelatedObject(): Promise<V2.Payments.OffSessionPayment>;
|
|
4784
|
+
}
|
|
4785
|
+
export interface V2PaymentsOffSessionPaymentCanceledEventNotification
|
|
4786
|
+
extends V2.Core.EventNotificationBase {
|
|
4787
|
+
type: 'v2.payments.off_session_payment.canceled';
|
|
4788
|
+
// Object containing the reference to API resource relevant to the event.
|
|
4789
|
+
related_object: V2.Core.Events.RelatedObject;
|
|
4790
|
+
// Retrieves the object associated with the event.
|
|
4791
|
+
fetchRelatedObject(): Promise<V2.Payments.OffSessionPayment>;
|
|
4792
|
+
fetchEvent(): Promise<V2PaymentsOffSessionPaymentCanceledEvent>;
|
|
4793
|
+
}
|
|
4794
|
+
|
|
4795
|
+
/**
|
|
4796
|
+
* Sent immediately following a user's call to the Off-Session Payments create endpoint.
|
|
4797
|
+
*/
|
|
4798
|
+
export interface V2PaymentsOffSessionPaymentCreatedEvent
|
|
4799
|
+
extends V2.Core.EventBase {
|
|
4800
|
+
type: 'v2.payments.off_session_payment.created';
|
|
4801
|
+
// Object containing the reference to API resource relevant to the event.
|
|
4802
|
+
related_object: V2.Core.Events.RelatedObject;
|
|
4803
|
+
// Retrieves the object associated with the event.
|
|
4804
|
+
fetchRelatedObject(): Promise<V2.Payments.OffSessionPayment>;
|
|
4805
|
+
}
|
|
4806
|
+
export interface V2PaymentsOffSessionPaymentCreatedEventNotification
|
|
4807
|
+
extends V2.Core.EventNotificationBase {
|
|
4808
|
+
type: 'v2.payments.off_session_payment.created';
|
|
4809
|
+
// Object containing the reference to API resource relevant to the event.
|
|
4810
|
+
related_object: V2.Core.Events.RelatedObject;
|
|
4811
|
+
// Retrieves the object associated with the event.
|
|
4812
|
+
fetchRelatedObject(): Promise<V2.Payments.OffSessionPayment>;
|
|
4813
|
+
fetchEvent(): Promise<V2PaymentsOffSessionPaymentCreatedEvent>;
|
|
4814
|
+
}
|
|
4815
|
+
|
|
4816
|
+
/**
|
|
4817
|
+
* Sent after a failed authorization if there are no retries remaining, or if the failure is unretryable.
|
|
4818
|
+
*/
|
|
4819
|
+
export interface V2PaymentsOffSessionPaymentFailedEvent
|
|
4820
|
+
extends V2.Core.EventBase {
|
|
4821
|
+
type: 'v2.payments.off_session_payment.failed';
|
|
4822
|
+
// Object containing the reference to API resource relevant to the event.
|
|
4823
|
+
related_object: V2.Core.Events.RelatedObject;
|
|
4824
|
+
// Retrieves the object associated with the event.
|
|
4825
|
+
fetchRelatedObject(): Promise<V2.Payments.OffSessionPayment>;
|
|
4826
|
+
}
|
|
4827
|
+
export interface V2PaymentsOffSessionPaymentFailedEventNotification
|
|
4828
|
+
extends V2.Core.EventNotificationBase {
|
|
4829
|
+
type: 'v2.payments.off_session_payment.failed';
|
|
4830
|
+
// Object containing the reference to API resource relevant to the event.
|
|
4831
|
+
related_object: V2.Core.Events.RelatedObject;
|
|
4832
|
+
// Retrieves the object associated with the event.
|
|
4833
|
+
fetchRelatedObject(): Promise<V2.Payments.OffSessionPayment>;
|
|
4834
|
+
fetchEvent(): Promise<V2PaymentsOffSessionPaymentFailedEvent>;
|
|
4835
|
+
}
|
|
4836
|
+
|
|
4837
|
+
/**
|
|
4838
|
+
* Sent when the off-session payment becomes available for capture.
|
|
4839
|
+
*/
|
|
4840
|
+
export interface V2PaymentsOffSessionPaymentRequiresCaptureEvent
|
|
4841
|
+
extends V2.Core.EventBase {
|
|
4842
|
+
type: 'v2.payments.off_session_payment.requires_capture';
|
|
4843
|
+
// Object containing the reference to API resource relevant to the event.
|
|
4844
|
+
related_object: V2.Core.Events.RelatedObject;
|
|
4845
|
+
// Retrieves the object associated with the event.
|
|
4846
|
+
fetchRelatedObject(): Promise<V2.Payments.OffSessionPayment>;
|
|
4847
|
+
}
|
|
4848
|
+
export interface V2PaymentsOffSessionPaymentRequiresCaptureEventNotification
|
|
4849
|
+
extends V2.Core.EventNotificationBase {
|
|
4850
|
+
type: 'v2.payments.off_session_payment.requires_capture';
|
|
4851
|
+
// Object containing the reference to API resource relevant to the event.
|
|
4852
|
+
related_object: V2.Core.Events.RelatedObject;
|
|
4853
|
+
// Retrieves the object associated with the event.
|
|
4854
|
+
fetchRelatedObject(): Promise<V2.Payments.OffSessionPayment>;
|
|
4855
|
+
fetchEvent(): Promise<V2PaymentsOffSessionPaymentRequiresCaptureEvent>;
|
|
4856
|
+
}
|
|
4857
|
+
|
|
4858
|
+
/**
|
|
4859
|
+
* Sent immediately after a successful authorization.
|
|
4860
|
+
*/
|
|
4861
|
+
export interface V2PaymentsOffSessionPaymentSucceededEvent
|
|
4862
|
+
extends V2.Core.EventBase {
|
|
4863
|
+
type: 'v2.payments.off_session_payment.succeeded';
|
|
4864
|
+
// Object containing the reference to API resource relevant to the event.
|
|
4865
|
+
related_object: V2.Core.Events.RelatedObject;
|
|
4866
|
+
// Retrieves the object associated with the event.
|
|
4867
|
+
fetchRelatedObject(): Promise<V2.Payments.OffSessionPayment>;
|
|
4868
|
+
}
|
|
4869
|
+
export interface V2PaymentsOffSessionPaymentSucceededEventNotification
|
|
4870
|
+
extends V2.Core.EventNotificationBase {
|
|
4871
|
+
type: 'v2.payments.off_session_payment.succeeded';
|
|
4872
|
+
// Object containing the reference to API resource relevant to the event.
|
|
4873
|
+
related_object: V2.Core.Events.RelatedObject;
|
|
4874
|
+
// Retrieves the object associated with the event.
|
|
4875
|
+
fetchRelatedObject(): Promise<V2.Payments.OffSessionPayment>;
|
|
4876
|
+
fetchEvent(): Promise<V2PaymentsOffSessionPaymentSucceededEvent>;
|
|
4877
|
+
}
|
|
4878
|
+
|
|
4879
|
+
/**
|
|
4880
|
+
* Occurs when a ReportRun is created.
|
|
4881
|
+
*/
|
|
4882
|
+
export interface V2ReportingReportRunCreatedEvent
|
|
4883
|
+
extends V2.Core.EventBase {
|
|
4884
|
+
type: 'v2.reporting.report_run.created';
|
|
4885
|
+
// Object containing the reference to API resource relevant to the event.
|
|
4886
|
+
related_object: V2.Core.Events.RelatedObject;
|
|
4887
|
+
// Retrieves the object associated with the event.
|
|
4888
|
+
fetchRelatedObject(): Promise<V2.Reporting.ReportRun>;
|
|
4889
|
+
}
|
|
4890
|
+
export interface V2ReportingReportRunCreatedEventNotification
|
|
4891
|
+
extends V2.Core.EventNotificationBase {
|
|
4892
|
+
type: 'v2.reporting.report_run.created';
|
|
4893
|
+
// Object containing the reference to API resource relevant to the event.
|
|
4894
|
+
related_object: V2.Core.Events.RelatedObject;
|
|
4895
|
+
// Retrieves the object associated with the event.
|
|
4896
|
+
fetchRelatedObject(): Promise<V2.Reporting.ReportRun>;
|
|
4897
|
+
fetchEvent(): Promise<V2ReportingReportRunCreatedEvent>;
|
|
4898
|
+
}
|
|
4899
|
+
|
|
4900
|
+
/**
|
|
4901
|
+
* Occurs when a ReportRun has failed to complete.
|
|
4902
|
+
*/
|
|
4903
|
+
export interface V2ReportingReportRunFailedEvent extends V2.Core.EventBase {
|
|
4904
|
+
type: 'v2.reporting.report_run.failed';
|
|
4905
|
+
// Object containing the reference to API resource relevant to the event.
|
|
4906
|
+
related_object: V2.Core.Events.RelatedObject;
|
|
4907
|
+
// Retrieves the object associated with the event.
|
|
4908
|
+
fetchRelatedObject(): Promise<V2.Reporting.ReportRun>;
|
|
4909
|
+
}
|
|
4910
|
+
export interface V2ReportingReportRunFailedEventNotification
|
|
4911
|
+
extends V2.Core.EventNotificationBase {
|
|
4912
|
+
type: 'v2.reporting.report_run.failed';
|
|
4913
|
+
// Object containing the reference to API resource relevant to the event.
|
|
4914
|
+
related_object: V2.Core.Events.RelatedObject;
|
|
4915
|
+
// Retrieves the object associated with the event.
|
|
4916
|
+
fetchRelatedObject(): Promise<V2.Reporting.ReportRun>;
|
|
4917
|
+
fetchEvent(): Promise<V2ReportingReportRunFailedEvent>;
|
|
4918
|
+
}
|
|
4919
|
+
|
|
4920
|
+
/**
|
|
4921
|
+
* Occurs when a ReportRun has successfully completed.
|
|
4922
|
+
*/
|
|
4923
|
+
export interface V2ReportingReportRunSucceededEvent
|
|
4924
|
+
extends V2.Core.EventBase {
|
|
4925
|
+
type: 'v2.reporting.report_run.succeeded';
|
|
4926
|
+
// Object containing the reference to API resource relevant to the event.
|
|
4927
|
+
related_object: V2.Core.Events.RelatedObject;
|
|
4928
|
+
// Retrieves the object associated with the event.
|
|
4929
|
+
fetchRelatedObject(): Promise<V2.Reporting.ReportRun>;
|
|
4930
|
+
}
|
|
4931
|
+
export interface V2ReportingReportRunSucceededEventNotification
|
|
4932
|
+
extends V2.Core.EventNotificationBase {
|
|
4933
|
+
type: 'v2.reporting.report_run.succeeded';
|
|
4934
|
+
// Object containing the reference to API resource relevant to the event.
|
|
4935
|
+
related_object: V2.Core.Events.RelatedObject;
|
|
4936
|
+
// Retrieves the object associated with the event.
|
|
4937
|
+
fetchRelatedObject(): Promise<V2.Reporting.ReportRun>;
|
|
4938
|
+
fetchEvent(): Promise<V2ReportingReportRunSucceededEvent>;
|
|
4939
|
+
}
|
|
4940
|
+
|
|
4941
|
+
/**
|
|
4942
|
+
* Occurs when a ReportRun is updated.
|
|
4943
|
+
*/
|
|
4944
|
+
export interface V2ReportingReportRunUpdatedEvent
|
|
4945
|
+
extends V2.Core.EventBase {
|
|
4946
|
+
type: 'v2.reporting.report_run.updated';
|
|
4947
|
+
// Object containing the reference to API resource relevant to the event.
|
|
4948
|
+
related_object: V2.Core.Events.RelatedObject;
|
|
4949
|
+
// Retrieves the object associated with the event.
|
|
4950
|
+
fetchRelatedObject(): Promise<V2.Reporting.ReportRun>;
|
|
4951
|
+
}
|
|
4952
|
+
export interface V2ReportingReportRunUpdatedEventNotification
|
|
4953
|
+
extends V2.Core.EventNotificationBase {
|
|
4954
|
+
type: 'v2.reporting.report_run.updated';
|
|
4955
|
+
// Object containing the reference to API resource relevant to the event.
|
|
4956
|
+
related_object: V2.Core.Events.RelatedObject;
|
|
4957
|
+
// Retrieves the object associated with the event.
|
|
4958
|
+
fetchRelatedObject(): Promise<V2.Reporting.ReportRun>;
|
|
4959
|
+
fetchEvent(): Promise<V2ReportingReportRunUpdatedEvent>;
|
|
254
4960
|
}
|
|
255
4961
|
}
|
|
256
4962
|
}
|