stripe 18.5.0 → 18.6.0-alpha.1

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.
Files changed (419) hide show
  1. package/CHANGELOG.md +1413 -11
  2. package/OPENAPI_VERSION +1 -1
  3. package/README.md +1 -0
  4. package/VERSION +1 -1
  5. package/cjs/Error.js +115 -1
  6. package/cjs/RequestSender.js +7 -4
  7. package/cjs/apiVersion.js +2 -3
  8. package/cjs/resources/AccountNotices.js +21 -0
  9. package/cjs/resources/BalanceSettings.js +10 -0
  10. package/cjs/resources/Billing/MeterUsage.js +12 -0
  11. package/cjs/resources/Capital/FinancingOffers.js +21 -0
  12. package/cjs/resources/Capital/FinancingSummary.js +12 -0
  13. package/cjs/resources/Capital/FinancingTransactions.js +17 -0
  14. package/cjs/resources/ExternalAccounts.js +23 -0
  15. package/cjs/resources/FinancialConnections/Accounts.js +5 -0
  16. package/cjs/resources/FinancialConnections/Institutions.js +17 -0
  17. package/cjs/resources/FxQuotes.js +15 -0
  18. package/cjs/resources/Issuing/CreditUnderwritingRecords.js +33 -0
  19. package/cjs/resources/Issuing/DisputeSettlementDetails.js +17 -0
  20. package/cjs/resources/Issuing/FraudLiabilityDebits.js +17 -0
  21. package/cjs/resources/Mandates.js +5 -0
  22. package/cjs/resources/Margins.js +22 -0
  23. package/cjs/resources/Orders.js +24 -0
  24. package/cjs/resources/PaymentAttemptRecords.js +17 -0
  25. package/cjs/resources/PaymentIntents.js +13 -0
  26. package/cjs/resources/PaymentRecords.js +29 -0
  27. package/cjs/resources/Privacy/RedactionJobs.js +42 -0
  28. package/cjs/resources/Quotes.js +32 -0
  29. package/cjs/resources/SubscriptionSchedules.js +4 -0
  30. package/cjs/resources/Subscriptions.js +4 -0
  31. package/cjs/resources/Tax/Associations.js +9 -0
  32. package/cjs/resources/Tax/Forms.js +20 -0
  33. package/cjs/resources/Terminal/OnboardingLinks.js +12 -0
  34. package/cjs/resources/Terminal/ReaderCollectedData.js +12 -0
  35. package/cjs/resources/V2/Billing/BillSettings/Versions.js +17 -0
  36. package/cjs/resources/V2/Billing/BillSettings.js +27 -0
  37. package/cjs/resources/V2/Billing/Cadences.js +23 -0
  38. package/cjs/resources/V2/Billing/CollectionSettings/Versions.js +17 -0
  39. package/cjs/resources/V2/Billing/CollectionSettings.js +30 -0
  40. package/cjs/resources/V2/Billing/CustomPricingUnits.js +25 -0
  41. package/cjs/resources/V2/Billing/Intents/Actions.js +17 -0
  42. package/cjs/resources/V2/Billing/Intents.js +36 -0
  43. package/cjs/resources/V2/Billing/LicenseFeeSubscriptions.js +12 -0
  44. package/cjs/resources/V2/Billing/LicenseFees/Versions.js +17 -0
  45. package/cjs/resources/V2/Billing/LicenseFees.js +27 -0
  46. package/cjs/resources/V2/Billing/LicensedItems.js +25 -0
  47. package/cjs/resources/V2/Billing/MeteredItems.js +22 -0
  48. package/cjs/resources/V2/Billing/PricingPlanSubscriptions.js +17 -0
  49. package/cjs/resources/V2/Billing/PricingPlans/Components.js +29 -0
  50. package/cjs/resources/V2/Billing/PricingPlans/Versions.js +17 -0
  51. package/cjs/resources/V2/Billing/PricingPlans.js +29 -0
  52. package/cjs/resources/V2/Billing/Profiles.js +19 -0
  53. package/cjs/resources/V2/Billing/RateCardSubscriptions.js +29 -0
  54. package/cjs/resources/V2/Billing/RateCards/Rates.js +25 -0
  55. package/cjs/resources/V2/Billing/RateCards/Versions.js +17 -0
  56. package/cjs/resources/V2/Billing/RateCards.js +29 -0
  57. package/cjs/resources/V2/Billing/ServiceActions.js +16 -0
  58. package/cjs/resources/V2/Core/AccountLinks.js +9 -0
  59. package/cjs/resources/V2/Core/Accounts/Persons.js +29 -0
  60. package/cjs/resources/V2/Core/Accounts.js +25 -0
  61. package/cjs/resources/V2/Core/ClaimableSandboxes.js +12 -0
  62. package/cjs/resources/V2/Core/Vault/GbBankAccounts.js +28 -0
  63. package/cjs/resources/V2/Core/Vault/UsBankAccounts.js +24 -0
  64. package/cjs/resources/V2/MoneyManagement/Adjustments.js +17 -0
  65. package/cjs/resources/V2/MoneyManagement/FinancialAccounts.js +25 -0
  66. package/cjs/resources/V2/MoneyManagement/FinancialAddresses.js +21 -0
  67. package/cjs/resources/V2/MoneyManagement/InboundTransfers.js +21 -0
  68. package/cjs/resources/V2/MoneyManagement/OutboundPaymentQuotes.js +16 -0
  69. package/cjs/resources/V2/MoneyManagement/OutboundPayments.js +25 -0
  70. package/cjs/resources/V2/MoneyManagement/OutboundSetupIntents.js +29 -0
  71. package/cjs/resources/V2/MoneyManagement/OutboundTransfers.js +25 -0
  72. package/cjs/resources/V2/MoneyManagement/PayoutMethods.js +25 -0
  73. package/cjs/resources/V2/MoneyManagement/PayoutMethodsBankAccountSpec.js +12 -0
  74. package/cjs/resources/V2/MoneyManagement/ReceivedCredits.js +17 -0
  75. package/cjs/resources/V2/MoneyManagement/ReceivedDebits.js +17 -0
  76. package/cjs/resources/V2/MoneyManagement/TransactionEntries.js +17 -0
  77. package/cjs/resources/V2/MoneyManagement/Transactions.js +17 -0
  78. package/cjs/resources/V2/Payments/OffSessionPayments.js +25 -0
  79. package/cjs/resources/V2/Reporting/ReportRuns.js +13 -0
  80. package/cjs/resources/V2/Reporting/Reports.js +12 -0
  81. package/cjs/resources/V2/Tax/AutomaticRules.js +22 -0
  82. package/cjs/resources/V2/TestHelpers/FinancialAddresses.js +16 -0
  83. package/cjs/resources.js +142 -8
  84. package/cjs/stripe.core.js +27 -1
  85. package/esm/Error.js +100 -0
  86. package/esm/RequestSender.js +7 -4
  87. package/esm/apiVersion.js +1 -2
  88. package/esm/resources/AccountNotices.js +18 -0
  89. package/esm/resources/BalanceSettings.js +7 -0
  90. package/esm/resources/Billing/MeterUsage.js +9 -0
  91. package/esm/resources/Capital/FinancingOffers.js +18 -0
  92. package/esm/resources/Capital/FinancingSummary.js +9 -0
  93. package/esm/resources/Capital/FinancingTransactions.js +14 -0
  94. package/esm/resources/ExternalAccounts.js +20 -0
  95. package/esm/resources/FinancialConnections/Accounts.js +5 -0
  96. package/esm/resources/FinancialConnections/Institutions.js +14 -0
  97. package/esm/resources/FxQuotes.js +12 -0
  98. package/esm/resources/Issuing/CreditUnderwritingRecords.js +30 -0
  99. package/esm/resources/Issuing/DisputeSettlementDetails.js +14 -0
  100. package/esm/resources/Issuing/FraudLiabilityDebits.js +14 -0
  101. package/esm/resources/Mandates.js +5 -0
  102. package/esm/resources/Margins.js +19 -0
  103. package/esm/resources/Orders.js +21 -0
  104. package/esm/resources/PaymentAttemptRecords.js +14 -0
  105. package/esm/resources/PaymentIntents.js +13 -0
  106. package/esm/resources/PaymentRecords.js +26 -0
  107. package/esm/resources/Privacy/RedactionJobs.js +39 -0
  108. package/esm/resources/Quotes.js +32 -0
  109. package/esm/resources/SubscriptionSchedules.js +4 -0
  110. package/esm/resources/Subscriptions.js +4 -0
  111. package/esm/resources/Tax/Associations.js +6 -0
  112. package/esm/resources/Tax/Forms.js +17 -0
  113. package/esm/resources/Terminal/OnboardingLinks.js +9 -0
  114. package/esm/resources/Terminal/ReaderCollectedData.js +9 -0
  115. package/esm/resources/V2/Billing/BillSettings/Versions.js +14 -0
  116. package/esm/resources/V2/Billing/BillSettings.js +24 -0
  117. package/esm/resources/V2/Billing/Cadences.js +20 -0
  118. package/esm/resources/V2/Billing/CollectionSettings/Versions.js +14 -0
  119. package/esm/resources/V2/Billing/CollectionSettings.js +27 -0
  120. package/esm/resources/V2/Billing/CustomPricingUnits.js +22 -0
  121. package/esm/resources/V2/Billing/Intents/Actions.js +14 -0
  122. package/esm/resources/V2/Billing/Intents.js +33 -0
  123. package/esm/resources/V2/Billing/LicenseFeeSubscriptions.js +9 -0
  124. package/esm/resources/V2/Billing/LicenseFees/Versions.js +14 -0
  125. package/esm/resources/V2/Billing/LicenseFees.js +24 -0
  126. package/esm/resources/V2/Billing/LicensedItems.js +22 -0
  127. package/esm/resources/V2/Billing/MeteredItems.js +19 -0
  128. package/esm/resources/V2/Billing/PricingPlanSubscriptions.js +14 -0
  129. package/esm/resources/V2/Billing/PricingPlans/Components.js +26 -0
  130. package/esm/resources/V2/Billing/PricingPlans/Versions.js +14 -0
  131. package/esm/resources/V2/Billing/PricingPlans.js +26 -0
  132. package/esm/resources/V2/Billing/Profiles.js +16 -0
  133. package/esm/resources/V2/Billing/RateCardSubscriptions.js +26 -0
  134. package/esm/resources/V2/Billing/RateCards/Rates.js +22 -0
  135. package/esm/resources/V2/Billing/RateCards/Versions.js +14 -0
  136. package/esm/resources/V2/Billing/RateCards.js +26 -0
  137. package/esm/resources/V2/Billing/ServiceActions.js +13 -0
  138. package/esm/resources/V2/Core/AccountLinks.js +6 -0
  139. package/esm/resources/V2/Core/Accounts/Persons.js +26 -0
  140. package/esm/resources/V2/Core/Accounts.js +22 -0
  141. package/esm/resources/V2/Core/ClaimableSandboxes.js +9 -0
  142. package/esm/resources/V2/Core/Vault/GbBankAccounts.js +25 -0
  143. package/esm/resources/V2/Core/Vault/UsBankAccounts.js +21 -0
  144. package/esm/resources/V2/MoneyManagement/Adjustments.js +14 -0
  145. package/esm/resources/V2/MoneyManagement/FinancialAccounts.js +22 -0
  146. package/esm/resources/V2/MoneyManagement/FinancialAddresses.js +18 -0
  147. package/esm/resources/V2/MoneyManagement/InboundTransfers.js +18 -0
  148. package/esm/resources/V2/MoneyManagement/OutboundPaymentQuotes.js +13 -0
  149. package/esm/resources/V2/MoneyManagement/OutboundPayments.js +22 -0
  150. package/esm/resources/V2/MoneyManagement/OutboundSetupIntents.js +26 -0
  151. package/esm/resources/V2/MoneyManagement/OutboundTransfers.js +22 -0
  152. package/esm/resources/V2/MoneyManagement/PayoutMethods.js +22 -0
  153. package/esm/resources/V2/MoneyManagement/PayoutMethodsBankAccountSpec.js +9 -0
  154. package/esm/resources/V2/MoneyManagement/ReceivedCredits.js +14 -0
  155. package/esm/resources/V2/MoneyManagement/ReceivedDebits.js +14 -0
  156. package/esm/resources/V2/MoneyManagement/TransactionEntries.js +14 -0
  157. package/esm/resources/V2/MoneyManagement/Transactions.js +14 -0
  158. package/esm/resources/V2/Payments/OffSessionPayments.js +22 -0
  159. package/esm/resources/V2/Reporting/ReportRuns.js +10 -0
  160. package/esm/resources/V2/Reporting/Reports.js +9 -0
  161. package/esm/resources/V2/Tax/AutomaticRules.js +19 -0
  162. package/esm/resources/V2/TestHelpers/FinancialAddresses.js +13 -0
  163. package/esm/resources.js +126 -0
  164. package/esm/stripe.core.js +27 -1
  165. package/package.json +1 -1
  166. package/types/AccountLinksResource.d.ts +5 -1
  167. package/types/AccountNotices.d.ts +113 -0
  168. package/types/AccountNoticesResource.d.ts +98 -0
  169. package/types/AccountSessions.d.ts +45 -0
  170. package/types/AccountSessionsResource.d.ts +264 -0
  171. package/types/Accounts.d.ts +212 -1
  172. package/types/AccountsResource.d.ts +544 -0
  173. package/types/BalanceSettings.d.ts +97 -0
  174. package/types/BalanceSettingsResource.d.ts +119 -0
  175. package/types/Billing/AlertTriggereds.d.ts +16 -1
  176. package/types/Billing/Alerts.d.ts +116 -1
  177. package/types/Billing/AlertsResource.d.ts +93 -2
  178. package/types/Billing/CreditBalanceSummary.d.ts +123 -2
  179. package/types/Billing/CreditBalanceSummaryResource.d.ts +20 -3
  180. package/types/Billing/CreditBalanceTransactions.d.ts +118 -2
  181. package/types/Billing/CreditBalanceTransactionsResource.d.ts +12 -4
  182. package/types/Billing/CreditGrants.d.ts +76 -1
  183. package/types/Billing/CreditGrantsResource.d.ts +43 -2
  184. package/types/Billing/MeterUsage.d.ts +32 -0
  185. package/types/Billing/MeterUsageResource.d.ts +685 -0
  186. package/types/Billing/MeterUsageRows.d.ts +49 -0
  187. package/types/BillingPortal/Sessions.d.ts +5 -0
  188. package/types/BillingPortal/SessionsResource.d.ts +12 -4
  189. package/types/Capital/FinancingOffers.d.ts +188 -0
  190. package/types/Capital/FinancingOffersResource.d.ts +97 -0
  191. package/types/Capital/FinancingSummary.d.ts +106 -0
  192. package/types/Capital/FinancingSummaryResource.d.ts +27 -0
  193. package/types/Capital/FinancingTransactions.d.ts +135 -0
  194. package/types/Capital/FinancingTransactionsResource.d.ts +68 -0
  195. package/types/Cards.d.ts +5 -0
  196. package/types/CashBalances.d.ts +5 -0
  197. package/types/Charges.d.ts +171 -10
  198. package/types/ChargesResource.d.ts +1406 -0
  199. package/types/Checkout/Sessions.d.ts +432 -2
  200. package/types/Checkout/SessionsResource.d.ts +570 -2
  201. package/types/ConfirmationTokens.d.ts +125 -0
  202. package/types/Coupons.d.ts +33 -0
  203. package/types/CouponsResource.d.ts +21 -0
  204. package/types/CreditNoteLineItems.d.ts +17 -0
  205. package/types/CreditNotes.d.ts +5 -0
  206. package/types/CreditNotesResource.d.ts +5 -0
  207. package/types/CustomerBalanceTransactions.d.ts +2 -0
  208. package/types/CustomerCashBalanceTransactions.d.ts +2 -0
  209. package/types/CustomerSessions.d.ts +5 -0
  210. package/types/CustomerSessionsResource.d.ts +6 -1
  211. package/types/Customers.d.ts +2 -0
  212. package/types/CustomersResource.d.ts +8 -0
  213. package/types/Discounts.d.ts +10 -0
  214. package/types/Disputes.d.ts +29 -0
  215. package/types/Errors.d.ts +85 -0
  216. package/types/EventTypes.d.ts +664 -0
  217. package/types/Events.d.ts +97 -0
  218. package/types/ExternalAccountsResource.d.ts +304 -0
  219. package/types/FinancialConnections/AccountInferredBalances.d.ts +38 -0
  220. package/types/FinancialConnections/Accounts.d.ts +36 -1
  221. package/types/FinancialConnections/AccountsResource.d.ts +40 -3
  222. package/types/FinancialConnections/Institutions.d.ts +98 -0
  223. package/types/FinancialConnections/InstitutionsResource.d.ts +47 -0
  224. package/types/FinancialConnections/Sessions.d.ts +51 -1
  225. package/types/FinancialConnections/SessionsResource.d.ts +43 -1
  226. package/types/FxQuotes.d.ts +155 -0
  227. package/types/FxQuotesResource.d.ts +130 -0
  228. package/types/Identity/VerificationSessions.d.ts +5 -0
  229. package/types/Identity/VerificationSessionsResource.d.ts +7 -0
  230. package/types/InvoiceItems.d.ts +114 -2
  231. package/types/InvoiceItemsResource.d.ts +117 -6
  232. package/types/InvoiceLineItems.d.ts +158 -3
  233. package/types/InvoicePayments.d.ts +5 -0
  234. package/types/InvoicePaymentsResource.d.ts +10 -1
  235. package/types/Invoices.d.ts +187 -4
  236. package/types/InvoicesResource.d.ts +1535 -19
  237. package/types/Issuing/CardholdersResource.d.ts +2 -1
  238. package/types/Issuing/CardsResource.d.ts +0 -10
  239. package/types/Issuing/CreditUnderwritingRecords.d.ts +451 -0
  240. package/types/Issuing/CreditUnderwritingRecordsResource.d.ts +1032 -0
  241. package/types/Issuing/DisputeSettlementDetails.d.ts +85 -0
  242. package/types/Issuing/DisputeSettlementDetailsResource.d.ts +52 -0
  243. package/types/Issuing/FraudLiabilityDebits.d.ts +52 -0
  244. package/types/Issuing/FraudLiabilityDebitsResource.d.ts +52 -0
  245. package/types/Issuing/Settlements.d.ts +113 -0
  246. package/types/Issuing/Transactions.d.ts +5 -0
  247. package/types/Issuing/TransactionsResource.d.ts +5 -0
  248. package/types/LineItems.d.ts +49 -0
  249. package/types/Mandates.d.ts +135 -1
  250. package/types/MandatesResource.d.ts +31 -0
  251. package/types/Margins.d.ts +56 -0
  252. package/types/MarginsResource.d.ts +114 -0
  253. package/types/Orders.d.ts +1163 -0
  254. package/types/OrdersResource.d.ts +3139 -0
  255. package/types/PaymentAttemptRecords.d.ts +2311 -0
  256. package/types/PaymentAttemptRecordsResource.d.ts +52 -0
  257. package/types/PaymentIntentAmountDetailsLineItems.d.ts +116 -0
  258. package/types/PaymentIntents.d.ts +836 -3
  259. package/types/PaymentIntentsResource.d.ts +11610 -5775
  260. package/types/PaymentLinks.d.ts +6 -0
  261. package/types/PaymentLinksResource.d.ts +12 -0
  262. package/types/PaymentMethodConfigurations.d.ts +180 -0
  263. package/types/PaymentMethodConfigurationsResource.d.ts +250 -0
  264. package/types/PaymentMethods.d.ts +130 -0
  265. package/types/PaymentMethodsResource.d.ts +167 -2
  266. package/types/PaymentRecords.d.ts +2304 -0
  267. package/types/PaymentRecordsResource.d.ts +476 -0
  268. package/types/Prices.d.ts +22 -0
  269. package/types/PricesResource.d.ts +22 -0
  270. package/types/Privacy/RedactionJobValidationErrors.d.ts +60 -0
  271. package/types/Privacy/RedactionJobs.d.ts +111 -0
  272. package/types/Privacy/RedactionJobsResource.d.ts +230 -0
  273. package/types/PromotionCodes.d.ts +5 -0
  274. package/types/PromotionCodesResource.d.ts +10 -0
  275. package/types/QuoteLines.d.ts +634 -0
  276. package/types/QuotePreviewInvoices.d.ts +1751 -0
  277. package/types/QuotePreviewSubscriptionSchedules.d.ts +892 -0
  278. package/types/Quotes.d.ts +594 -1
  279. package/types/QuotesResource.d.ts +2577 -232
  280. package/types/Refunds.d.ts +14 -0
  281. package/types/SetupAttempts.d.ts +51 -1
  282. package/types/SetupIntents.d.ts +210 -2
  283. package/types/SetupIntentsResource.d.ts +938 -4
  284. package/types/Sources.d.ts +29 -0
  285. package/types/SubscriptionItems.d.ts +21 -0
  286. package/types/SubscriptionItemsResource.d.ts +109 -0
  287. package/types/SubscriptionSchedules.d.ts +205 -0
  288. package/types/SubscriptionSchedulesResource.d.ts +1233 -5
  289. package/types/Subscriptions.d.ts +140 -1
  290. package/types/SubscriptionsResource.d.ts +498 -8
  291. package/types/Tax/Associations.d.ts +82 -0
  292. package/types/Tax/AssociationsResource.d.ts +29 -0
  293. package/types/Tax/Forms.d.ts +220 -0
  294. package/types/Tax/FormsResource.d.ts +107 -0
  295. package/types/TaxIds.d.ts +10 -0
  296. package/types/TaxIdsResource.d.ts +10 -0
  297. package/types/Terminal/Configurations.d.ts +9 -0
  298. package/types/Terminal/ConfigurationsResource.d.ts +28 -0
  299. package/types/Terminal/OnboardingLinks.d.ts +57 -0
  300. package/types/Terminal/OnboardingLinksResource.d.ts +62 -0
  301. package/types/Terminal/ReaderCollectedData.d.ts +51 -0
  302. package/types/Terminal/ReaderCollectedDataResource.d.ts +29 -0
  303. package/types/Terminal/Readers.d.ts +20 -0
  304. package/types/TestHelpers/ConfirmationTokensResource.d.ts +126 -0
  305. package/types/TestHelpers/Treasury/ReceivedCreditsResource.d.ts +26 -0
  306. package/types/TestHelpers/Treasury/ReceivedDebitsResource.d.ts +26 -0
  307. package/types/Transfers.d.ts +5 -0
  308. package/types/TransfersResource.d.ts +5 -0
  309. package/types/Treasury/FinancialAccountFeatures.d.ts +7 -0
  310. package/types/Treasury/FinancialAccounts.d.ts +5 -0
  311. package/types/Treasury/FinancialAccountsResource.d.ts +37 -0
  312. package/types/Treasury/OutboundTransfers.d.ts +26 -0
  313. package/types/Treasury/OutboundTransfersResource.d.ts +26 -0
  314. package/types/Treasury/ReceivedCredits.d.ts +26 -0
  315. package/types/Treasury/ReceivedDebits.d.ts +31 -0
  316. package/types/V2/Billing/BillSettingVersions.d.ts +97 -0
  317. package/types/V2/Billing/BillSettings/VersionsResource.d.ts +58 -0
  318. package/types/V2/Billing/BillSettings.d.ts +120 -0
  319. package/types/V2/Billing/BillSettingsResource.d.ts +241 -0
  320. package/types/V2/Billing/Cadences.d.ts +354 -0
  321. package/types/V2/Billing/CadencesResource.d.ts +489 -0
  322. package/types/V2/Billing/CollectionSettingVersions.d.ts +314 -0
  323. package/types/V2/Billing/CollectionSettings/VersionsResource.d.ts +62 -0
  324. package/types/V2/Billing/CollectionSettings.d.ts +337 -0
  325. package/types/V2/Billing/CollectionSettingsResource.d.ts +675 -0
  326. package/types/V2/Billing/CustomPricingUnits.d.ts +56 -0
  327. package/types/V2/Billing/CustomPricingUnitsResource.d.ts +122 -0
  328. package/types/V2/Billing/IntentActions.d.ts +458 -0
  329. package/types/V2/Billing/Intents/ActionsResource.d.ts +58 -0
  330. package/types/V2/Billing/Intents.d.ts +117 -0
  331. package/types/V2/Billing/IntentsResource.d.ts +574 -0
  332. package/types/V2/Billing/LicenseFeeSubscriptions.d.ts +64 -0
  333. package/types/V2/Billing/LicenseFeeSubscriptionsResource.d.ts +28 -0
  334. package/types/V2/Billing/LicenseFeeVersions.d.ts +106 -0
  335. package/types/V2/Billing/LicenseFees/VersionsResource.d.ts +58 -0
  336. package/types/V2/Billing/LicenseFees.d.ts +163 -0
  337. package/types/V2/Billing/LicenseFeesResource.d.ts +290 -0
  338. package/types/V2/Billing/LicensedItems.d.ts +73 -0
  339. package/types/V2/Billing/LicensedItemsResource.d.ts +157 -0
  340. package/types/V2/Billing/MeteredItems.d.ts +101 -0
  341. package/types/V2/Billing/MeteredItemsResource.d.ts +189 -0
  342. package/types/V2/Billing/PricingPlanComponents.d.ts +109 -0
  343. package/types/V2/Billing/PricingPlanSubscriptions.d.ts +134 -0
  344. package/types/V2/Billing/PricingPlanSubscriptionsResource.d.ts +93 -0
  345. package/types/V2/Billing/PricingPlanVersions.d.ts +49 -0
  346. package/types/V2/Billing/PricingPlans/ComponentsResource.d.ts +197 -0
  347. package/types/V2/Billing/PricingPlans/VersionsResource.d.ts +58 -0
  348. package/types/V2/Billing/PricingPlans.d.ts +84 -0
  349. package/types/V2/Billing/PricingPlansResource.d.ts +151 -0
  350. package/types/V2/Billing/Profiles.d.ts +70 -0
  351. package/types/V2/Billing/ProfilesResource.d.ts +150 -0
  352. package/types/V2/Billing/RateCardRates.d.ts +138 -0
  353. package/types/V2/Billing/RateCardSubscriptions.d.ts +134 -0
  354. package/types/V2/Billing/RateCardSubscriptionsResource.d.ts +157 -0
  355. package/types/V2/Billing/RateCardVersions.d.ts +39 -0
  356. package/types/V2/Billing/RateCards/RatesResource.d.ts +209 -0
  357. package/types/V2/Billing/RateCards/VersionsResource.d.ts +58 -0
  358. package/types/V2/Billing/RateCards.d.ts +98 -0
  359. package/types/V2/Billing/RateCardsResource.d.ts +162 -0
  360. package/types/V2/Billing/ServiceActions.d.ts +240 -0
  361. package/types/V2/Billing/ServiceActionsResource.d.ts +302 -0
  362. package/types/V2/Core/AccountLinks.d.ts +168 -0
  363. package/types/V2/Core/AccountLinksResource.d.ts +152 -0
  364. package/types/V2/Core/Accounts/PersonsResource.d.ts +3812 -0
  365. package/types/V2/Core/Accounts.d.ts +8862 -0
  366. package/types/V2/Core/AccountsResource.d.ts +10704 -0
  367. package/types/V2/Core/ClaimableSandboxes.d.ts +349 -0
  368. package/types/V2/Core/ClaimableSandboxesResource.d.ts +310 -0
  369. package/types/V2/Core/Persons.d.ts +1888 -0
  370. package/types/V2/Core/Vault/GbBankAccounts.d.ts +160 -0
  371. package/types/V2/Core/Vault/GbBankAccountsResource.d.ts +172 -0
  372. package/types/V2/Core/Vault/UsBankAccounts.d.ts +70 -0
  373. package/types/V2/Core/Vault/UsBankAccountsResource.d.ts +123 -0
  374. package/types/V2/EventTypes.d.ts +4015 -5
  375. package/types/V2/Events.d.ts +7 -0
  376. package/types/V2/FinancialAddressCreditSimulations.d.ts +27 -0
  377. package/types/V2/FinancialAddressGeneratedMicrodeposits.d.ts +32 -0
  378. package/types/V2/MoneyManagement/Adjustments.d.ts +110 -0
  379. package/types/V2/MoneyManagement/AdjustmentsResource.d.ts +83 -0
  380. package/types/V2/MoneyManagement/FinancialAccounts.d.ts +585 -0
  381. package/types/V2/MoneyManagement/FinancialAccountsResource.d.ts +331 -0
  382. package/types/V2/MoneyManagement/FinancialAddresses.d.ts +314 -0
  383. package/types/V2/MoneyManagement/FinancialAddressesResource.d.ts +289 -0
  384. package/types/V2/MoneyManagement/InboundTransfers.d.ts +206 -0
  385. package/types/V2/MoneyManagement/InboundTransfersResource.d.ts +144 -0
  386. package/types/V2/MoneyManagement/OutboundPaymentQuotes.d.ts +168 -0
  387. package/types/V2/MoneyManagement/OutboundPaymentQuotesResource.d.ts +115 -0
  388. package/types/V2/MoneyManagement/OutboundPayments.d.ts +278 -0
  389. package/types/V2/MoneyManagement/OutboundPaymentsResource.d.ts +242 -0
  390. package/types/V2/MoneyManagement/OutboundSetupIntents.d.ts +97 -0
  391. package/types/V2/MoneyManagement/OutboundSetupIntentsResource.d.ts +296 -0
  392. package/types/V2/MoneyManagement/OutboundTransfers.d.ts +251 -0
  393. package/types/V2/MoneyManagement/OutboundTransfersResource.d.ts +208 -0
  394. package/types/V2/MoneyManagement/PayoutMethods.d.ts +160 -0
  395. package/types/V2/MoneyManagement/PayoutMethodsBankAccountSpecResource.d.ts +41 -0
  396. package/types/V2/MoneyManagement/PayoutMethodsBankAccountSpecs.d.ts +87 -0
  397. package/types/V2/MoneyManagement/PayoutMethodsResource.d.ts +113 -0
  398. package/types/V2/MoneyManagement/ReceivedCredits.d.ts +262 -0
  399. package/types/V2/MoneyManagement/ReceivedCreditsResource.d.ts +78 -0
  400. package/types/V2/MoneyManagement/ReceivedDebits.d.ts +176 -0
  401. package/types/V2/MoneyManagement/ReceivedDebitsResource.d.ts +48 -0
  402. package/types/V2/MoneyManagement/TransactionEntries.d.ts +162 -0
  403. package/types/V2/MoneyManagement/TransactionEntriesResource.d.ts +82 -0
  404. package/types/V2/MoneyManagement/Transactions.d.ts +177 -0
  405. package/types/V2/MoneyManagement/TransactionsResource.d.ts +83 -0
  406. package/types/V2/Payments/OffSessionPayments.d.ts +179 -0
  407. package/types/V2/Payments/OffSessionPaymentsResource.d.ts +174 -0
  408. package/types/V2/Reporting/ReportRuns.d.ts +178 -0
  409. package/types/V2/Reporting/ReportRunsResource.d.ts +99 -0
  410. package/types/V2/Reporting/Reports.d.ts +120 -0
  411. package/types/V2/Reporting/ReportsResource.d.ts +30 -0
  412. package/types/V2/Tax/AutomaticRules.d.ts +53 -0
  413. package/types/V2/Tax/AutomaticRulesResource.d.ts +102 -0
  414. package/types/V2/TestHelpers/FinancialAddressesResource.d.ts +68 -0
  415. package/types/WebhookEndpointsResource.d.ts +78 -0
  416. package/types/Webhooks.d.ts +2 -0
  417. package/types/index.d.ts +265 -0
  418. package/types/lib.d.ts +11 -1
  419. package/types/test/typescriptTest.ts +3 -3
@@ -5,7 +5,246 @@ declare module 'stripe' {
5
5
  export type Event =
6
6
  | Stripe.Events.V1BillingMeterErrorReportTriggeredEvent
7
7
  | Stripe.Events.V1BillingMeterNoMeterFoundEvent
8
- | Stripe.Events.V2CoreEventDestinationPingEvent;
8
+ | Stripe.Events.V2BillingCadenceBilledEvent
9
+ | Stripe.Events.V2BillingCadenceCanceledEvent
10
+ | Stripe.Events.V2BillingCadenceCreatedEvent
11
+ | Stripe.Events.V2BillingCadenceErroredEvent
12
+ | Stripe.Events.V2BillingLicenseFeeCreatedEvent
13
+ | Stripe.Events.V2BillingLicenseFeeUpdatedEvent
14
+ | Stripe.Events.V2BillingLicenseFeeVersionCreatedEvent
15
+ | Stripe.Events.V2BillingLicensedItemCreatedEvent
16
+ | Stripe.Events.V2BillingLicensedItemUpdatedEvent
17
+ | Stripe.Events.V2BillingMeteredItemCreatedEvent
18
+ | Stripe.Events.V2BillingMeteredItemUpdatedEvent
19
+ | Stripe.Events.V2BillingPricingPlanCreatedEvent
20
+ | Stripe.Events.V2BillingPricingPlanUpdatedEvent
21
+ | Stripe.Events.V2BillingPricingPlanComponentCreatedEvent
22
+ | Stripe.Events.V2BillingPricingPlanComponentUpdatedEvent
23
+ | Stripe.Events.V2BillingPricingPlanSubscriptionCollectionAwaitingCustomerActionEvent
24
+ | Stripe.Events.V2BillingPricingPlanSubscriptionCollectionCurrentEvent
25
+ | Stripe.Events.V2BillingPricingPlanSubscriptionCollectionPastDueEvent
26
+ | Stripe.Events.V2BillingPricingPlanSubscriptionCollectionPausedEvent
27
+ | Stripe.Events.V2BillingPricingPlanSubscriptionCollectionUnpaidEvent
28
+ | Stripe.Events.V2BillingPricingPlanSubscriptionServicingActivatedEvent
29
+ | Stripe.Events.V2BillingPricingPlanSubscriptionServicingCanceledEvent
30
+ | Stripe.Events.V2BillingPricingPlanSubscriptionServicingPausedEvent
31
+ | Stripe.Events.V2BillingPricingPlanVersionCreatedEvent
32
+ | Stripe.Events.V2BillingRateCardCreatedEvent
33
+ | Stripe.Events.V2BillingRateCardUpdatedEvent
34
+ | Stripe.Events.V2BillingRateCardRateCreatedEvent
35
+ | Stripe.Events.V2BillingRateCardSubscriptionActivatedEvent
36
+ | Stripe.Events.V2BillingRateCardSubscriptionCanceledEvent
37
+ | Stripe.Events.V2BillingRateCardSubscriptionCollectionAwaitingCustomerActionEvent
38
+ | Stripe.Events.V2BillingRateCardSubscriptionCollectionCurrentEvent
39
+ | Stripe.Events.V2BillingRateCardSubscriptionCollectionPastDueEvent
40
+ | Stripe.Events.V2BillingRateCardSubscriptionCollectionPausedEvent
41
+ | Stripe.Events.V2BillingRateCardSubscriptionCollectionUnpaidEvent
42
+ | Stripe.Events.V2BillingRateCardSubscriptionServicingActivatedEvent
43
+ | Stripe.Events.V2BillingRateCardSubscriptionServicingCanceledEvent
44
+ | Stripe.Events.V2BillingRateCardSubscriptionServicingPausedEvent
45
+ | Stripe.Events.V2BillingRateCardVersionCreatedEvent
46
+ | Stripe.Events.V2CoreAccountClosedEvent
47
+ | Stripe.Events.V2CoreAccountCreatedEvent
48
+ | Stripe.Events.V2CoreAccountUpdatedEvent
49
+ | Stripe.Events.V2CoreAccountIncludingConfigurationCustomerCapabilityStatusUpdatedEvent
50
+ | Stripe.Events.V2CoreAccountIncludingConfigurationCustomerUpdatedEvent
51
+ | Stripe.Events.V2CoreAccountIncludingConfigurationMerchantCapabilityStatusUpdatedEvent
52
+ | Stripe.Events.V2CoreAccountIncludingConfigurationMerchantUpdatedEvent
53
+ | Stripe.Events.V2CoreAccountIncludingConfigurationRecipientCapabilityStatusUpdatedEvent
54
+ | Stripe.Events.V2CoreAccountIncludingConfigurationRecipientUpdatedEvent
55
+ | Stripe.Events.V2CoreAccountIncludingConfigurationStorerCapabilityStatusUpdatedEvent
56
+ | Stripe.Events.V2CoreAccountIncludingConfigurationStorerUpdatedEvent
57
+ | Stripe.Events.V2CoreAccountIncludingDefaultsUpdatedEvent
58
+ | Stripe.Events.V2CoreAccountIncludingIdentityUpdatedEvent
59
+ | Stripe.Events.V2CoreAccountIncludingRequirementsUpdatedEvent
60
+ | Stripe.Events.V2CoreAccountLinkReturnedEvent
61
+ | Stripe.Events.V2CoreAccountPersonCreatedEvent
62
+ | Stripe.Events.V2CoreAccountPersonDeletedEvent
63
+ | Stripe.Events.V2CoreAccountPersonUpdatedEvent
64
+ | Stripe.Events.V2CoreEventDestinationPingEvent
65
+ | Stripe.Events.V2CoreHealthApiErrorFiringEvent
66
+ | Stripe.Events.V2CoreHealthApiErrorResolvedEvent
67
+ | Stripe.Events.V2CoreHealthApiLatencyFiringEvent
68
+ | Stripe.Events.V2CoreHealthApiLatencyResolvedEvent
69
+ | Stripe.Events.V2CoreHealthAuthorizationRateDropFiringEvent
70
+ | Stripe.Events.V2CoreHealthAuthorizationRateDropResolvedEvent
71
+ | Stripe.Events.V2CoreHealthEventGenerationFailureResolvedEvent
72
+ | Stripe.Events.V2CoreHealthFraudRateIncreasedEvent
73
+ | Stripe.Events.V2CoreHealthIssuingAuthorizationRequestTimeoutFiringEvent
74
+ | Stripe.Events.V2CoreHealthIssuingAuthorizationRequestTimeoutResolvedEvent
75
+ | Stripe.Events.V2CoreHealthPaymentMethodErrorFiringEvent
76
+ | Stripe.Events.V2CoreHealthPaymentMethodErrorResolvedEvent
77
+ | Stripe.Events.V2CoreHealthTrafficVolumeDropFiringEvent
78
+ | Stripe.Events.V2CoreHealthTrafficVolumeDropResolvedEvent
79
+ | Stripe.Events.V2CoreHealthWebhookLatencyFiringEvent
80
+ | Stripe.Events.V2CoreHealthWebhookLatencyResolvedEvent
81
+ | Stripe.Events.V2MoneyManagementAdjustmentCreatedEvent
82
+ | Stripe.Events.V2MoneyManagementFinancialAccountCreatedEvent
83
+ | Stripe.Events.V2MoneyManagementFinancialAccountUpdatedEvent
84
+ | Stripe.Events.V2MoneyManagementFinancialAddressActivatedEvent
85
+ | Stripe.Events.V2MoneyManagementFinancialAddressFailedEvent
86
+ | Stripe.Events.V2MoneyManagementInboundTransferAvailableEvent
87
+ | Stripe.Events.V2MoneyManagementInboundTransferBankDebitFailedEvent
88
+ | Stripe.Events.V2MoneyManagementInboundTransferBankDebitProcessingEvent
89
+ | Stripe.Events.V2MoneyManagementInboundTransferBankDebitQueuedEvent
90
+ | Stripe.Events.V2MoneyManagementInboundTransferBankDebitReturnedEvent
91
+ | Stripe.Events.V2MoneyManagementInboundTransferBankDebitSucceededEvent
92
+ | Stripe.Events.V2MoneyManagementOutboundPaymentCanceledEvent
93
+ | Stripe.Events.V2MoneyManagementOutboundPaymentCreatedEvent
94
+ | Stripe.Events.V2MoneyManagementOutboundPaymentFailedEvent
95
+ | Stripe.Events.V2MoneyManagementOutboundPaymentPostedEvent
96
+ | Stripe.Events.V2MoneyManagementOutboundPaymentReturnedEvent
97
+ | Stripe.Events.V2MoneyManagementOutboundPaymentUpdatedEvent
98
+ | Stripe.Events.V2MoneyManagementOutboundTransferCanceledEvent
99
+ | Stripe.Events.V2MoneyManagementOutboundTransferCreatedEvent
100
+ | Stripe.Events.V2MoneyManagementOutboundTransferFailedEvent
101
+ | Stripe.Events.V2MoneyManagementOutboundTransferPostedEvent
102
+ | Stripe.Events.V2MoneyManagementOutboundTransferReturnedEvent
103
+ | Stripe.Events.V2MoneyManagementOutboundTransferUpdatedEvent
104
+ | Stripe.Events.V2MoneyManagementPayoutMethodUpdatedEvent
105
+ | Stripe.Events.V2MoneyManagementReceivedCreditAvailableEvent
106
+ | Stripe.Events.V2MoneyManagementReceivedCreditFailedEvent
107
+ | Stripe.Events.V2MoneyManagementReceivedCreditReturnedEvent
108
+ | Stripe.Events.V2MoneyManagementReceivedCreditSucceededEvent
109
+ | Stripe.Events.V2MoneyManagementReceivedDebitCanceledEvent
110
+ | Stripe.Events.V2MoneyManagementReceivedDebitFailedEvent
111
+ | Stripe.Events.V2MoneyManagementReceivedDebitPendingEvent
112
+ | Stripe.Events.V2MoneyManagementReceivedDebitSucceededEvent
113
+ | Stripe.Events.V2MoneyManagementReceivedDebitUpdatedEvent
114
+ | Stripe.Events.V2MoneyManagementTransactionCreatedEvent
115
+ | Stripe.Events.V2MoneyManagementTransactionUpdatedEvent
116
+ | Stripe.Events.V2PaymentsOffSessionPaymentAuthorizationAttemptFailedEvent
117
+ | Stripe.Events.V2PaymentsOffSessionPaymentAuthorizationAttemptStartedEvent
118
+ | Stripe.Events.V2PaymentsOffSessionPaymentCanceledEvent
119
+ | Stripe.Events.V2PaymentsOffSessionPaymentCreatedEvent
120
+ | Stripe.Events.V2PaymentsOffSessionPaymentFailedEvent
121
+ | Stripe.Events.V2PaymentsOffSessionPaymentSucceededEvent
122
+ | Stripe.Events.V2ReportingReportRunCreatedEvent
123
+ | Stripe.Events.V2ReportingReportRunFailedEvent
124
+ | Stripe.Events.V2ReportingReportRunSucceededEvent
125
+ | Stripe.Events.V2ReportingReportRunUpdatedEvent;
126
+
127
+ export type PushedEvent =
128
+ | Stripe.Events.PushedV1BillingMeterErrorReportTriggeredEvent
129
+ | Stripe.Events.PushedV1BillingMeterNoMeterFoundEvent
130
+ | Stripe.Events.PushedV2BillingCadenceBilledEvent
131
+ | Stripe.Events.PushedV2BillingCadenceCanceledEvent
132
+ | Stripe.Events.PushedV2BillingCadenceCreatedEvent
133
+ | Stripe.Events.PushedV2BillingCadenceErroredEvent
134
+ | Stripe.Events.PushedV2BillingLicenseFeeCreatedEvent
135
+ | Stripe.Events.PushedV2BillingLicenseFeeUpdatedEvent
136
+ | Stripe.Events.PushedV2BillingLicenseFeeVersionCreatedEvent
137
+ | Stripe.Events.PushedV2BillingLicensedItemCreatedEvent
138
+ | Stripe.Events.PushedV2BillingLicensedItemUpdatedEvent
139
+ | Stripe.Events.PushedV2BillingMeteredItemCreatedEvent
140
+ | Stripe.Events.PushedV2BillingMeteredItemUpdatedEvent
141
+ | Stripe.Events.PushedV2BillingPricingPlanCreatedEvent
142
+ | Stripe.Events.PushedV2BillingPricingPlanUpdatedEvent
143
+ | Stripe.Events.PushedV2BillingPricingPlanComponentCreatedEvent
144
+ | Stripe.Events.PushedV2BillingPricingPlanComponentUpdatedEvent
145
+ | Stripe.Events.PushedV2BillingPricingPlanSubscriptionCollectionAwaitingCustomerActionEvent
146
+ | Stripe.Events.PushedV2BillingPricingPlanSubscriptionCollectionCurrentEvent
147
+ | Stripe.Events.PushedV2BillingPricingPlanSubscriptionCollectionPastDueEvent
148
+ | Stripe.Events.PushedV2BillingPricingPlanSubscriptionCollectionPausedEvent
149
+ | Stripe.Events.PushedV2BillingPricingPlanSubscriptionCollectionUnpaidEvent
150
+ | Stripe.Events.PushedV2BillingPricingPlanSubscriptionServicingActivatedEvent
151
+ | Stripe.Events.PushedV2BillingPricingPlanSubscriptionServicingCanceledEvent
152
+ | Stripe.Events.PushedV2BillingPricingPlanSubscriptionServicingPausedEvent
153
+ | Stripe.Events.PushedV2BillingPricingPlanVersionCreatedEvent
154
+ | Stripe.Events.PushedV2BillingRateCardCreatedEvent
155
+ | Stripe.Events.PushedV2BillingRateCardUpdatedEvent
156
+ | Stripe.Events.PushedV2BillingRateCardRateCreatedEvent
157
+ | Stripe.Events.PushedV2BillingRateCardSubscriptionActivatedEvent
158
+ | Stripe.Events.PushedV2BillingRateCardSubscriptionCanceledEvent
159
+ | Stripe.Events.PushedV2BillingRateCardSubscriptionCollectionAwaitingCustomerActionEvent
160
+ | Stripe.Events.PushedV2BillingRateCardSubscriptionCollectionCurrentEvent
161
+ | Stripe.Events.PushedV2BillingRateCardSubscriptionCollectionPastDueEvent
162
+ | Stripe.Events.PushedV2BillingRateCardSubscriptionCollectionPausedEvent
163
+ | Stripe.Events.PushedV2BillingRateCardSubscriptionCollectionUnpaidEvent
164
+ | Stripe.Events.PushedV2BillingRateCardSubscriptionServicingActivatedEvent
165
+ | Stripe.Events.PushedV2BillingRateCardSubscriptionServicingCanceledEvent
166
+ | Stripe.Events.PushedV2BillingRateCardSubscriptionServicingPausedEvent
167
+ | Stripe.Events.PushedV2BillingRateCardVersionCreatedEvent
168
+ | Stripe.Events.PushedV2CoreAccountClosedEvent
169
+ | Stripe.Events.PushedV2CoreAccountCreatedEvent
170
+ | Stripe.Events.PushedV2CoreAccountUpdatedEvent
171
+ | Stripe.Events.PushedV2CoreAccountIncludingConfigurationCustomerCapabilityStatusUpdatedEvent
172
+ | Stripe.Events.PushedV2CoreAccountIncludingConfigurationCustomerUpdatedEvent
173
+ | Stripe.Events.PushedV2CoreAccountIncludingConfigurationMerchantCapabilityStatusUpdatedEvent
174
+ | Stripe.Events.PushedV2CoreAccountIncludingConfigurationMerchantUpdatedEvent
175
+ | Stripe.Events.PushedV2CoreAccountIncludingConfigurationRecipientCapabilityStatusUpdatedEvent
176
+ | Stripe.Events.PushedV2CoreAccountIncludingConfigurationRecipientUpdatedEvent
177
+ | Stripe.Events.PushedV2CoreAccountIncludingConfigurationStorerCapabilityStatusUpdatedEvent
178
+ | Stripe.Events.PushedV2CoreAccountIncludingConfigurationStorerUpdatedEvent
179
+ | Stripe.Events.PushedV2CoreAccountIncludingDefaultsUpdatedEvent
180
+ | Stripe.Events.PushedV2CoreAccountIncludingIdentityUpdatedEvent
181
+ | Stripe.Events.PushedV2CoreAccountIncludingRequirementsUpdatedEvent
182
+ | Stripe.Events.PushedV2CoreAccountLinkReturnedEvent
183
+ | Stripe.Events.PushedV2CoreAccountPersonCreatedEvent
184
+ | Stripe.Events.PushedV2CoreAccountPersonDeletedEvent
185
+ | Stripe.Events.PushedV2CoreAccountPersonUpdatedEvent
186
+ | Stripe.Events.PushedV2CoreEventDestinationPingEvent
187
+ | Stripe.Events.PushedV2CoreHealthApiErrorFiringEvent
188
+ | Stripe.Events.PushedV2CoreHealthApiErrorResolvedEvent
189
+ | Stripe.Events.PushedV2CoreHealthApiLatencyFiringEvent
190
+ | Stripe.Events.PushedV2CoreHealthApiLatencyResolvedEvent
191
+ | Stripe.Events.PushedV2CoreHealthAuthorizationRateDropFiringEvent
192
+ | Stripe.Events.PushedV2CoreHealthAuthorizationRateDropResolvedEvent
193
+ | Stripe.Events.PushedV2CoreHealthEventGenerationFailureResolvedEvent
194
+ | Stripe.Events.PushedV2CoreHealthFraudRateIncreasedEvent
195
+ | Stripe.Events.PushedV2CoreHealthIssuingAuthorizationRequestTimeoutFiringEvent
196
+ | Stripe.Events.PushedV2CoreHealthIssuingAuthorizationRequestTimeoutResolvedEvent
197
+ | Stripe.Events.PushedV2CoreHealthPaymentMethodErrorFiringEvent
198
+ | Stripe.Events.PushedV2CoreHealthPaymentMethodErrorResolvedEvent
199
+ | Stripe.Events.PushedV2CoreHealthTrafficVolumeDropFiringEvent
200
+ | Stripe.Events.PushedV2CoreHealthTrafficVolumeDropResolvedEvent
201
+ | Stripe.Events.PushedV2CoreHealthWebhookLatencyFiringEvent
202
+ | Stripe.Events.PushedV2CoreHealthWebhookLatencyResolvedEvent
203
+ | Stripe.Events.PushedV2MoneyManagementAdjustmentCreatedEvent
204
+ | Stripe.Events.PushedV2MoneyManagementFinancialAccountCreatedEvent
205
+ | Stripe.Events.PushedV2MoneyManagementFinancialAccountUpdatedEvent
206
+ | Stripe.Events.PushedV2MoneyManagementFinancialAddressActivatedEvent
207
+ | Stripe.Events.PushedV2MoneyManagementFinancialAddressFailedEvent
208
+ | Stripe.Events.PushedV2MoneyManagementInboundTransferAvailableEvent
209
+ | Stripe.Events.PushedV2MoneyManagementInboundTransferBankDebitFailedEvent
210
+ | Stripe.Events.PushedV2MoneyManagementInboundTransferBankDebitProcessingEvent
211
+ | Stripe.Events.PushedV2MoneyManagementInboundTransferBankDebitQueuedEvent
212
+ | Stripe.Events.PushedV2MoneyManagementInboundTransferBankDebitReturnedEvent
213
+ | Stripe.Events.PushedV2MoneyManagementInboundTransferBankDebitSucceededEvent
214
+ | Stripe.Events.PushedV2MoneyManagementOutboundPaymentCanceledEvent
215
+ | Stripe.Events.PushedV2MoneyManagementOutboundPaymentCreatedEvent
216
+ | Stripe.Events.PushedV2MoneyManagementOutboundPaymentFailedEvent
217
+ | Stripe.Events.PushedV2MoneyManagementOutboundPaymentPostedEvent
218
+ | Stripe.Events.PushedV2MoneyManagementOutboundPaymentReturnedEvent
219
+ | Stripe.Events.PushedV2MoneyManagementOutboundPaymentUpdatedEvent
220
+ | Stripe.Events.PushedV2MoneyManagementOutboundTransferCanceledEvent
221
+ | Stripe.Events.PushedV2MoneyManagementOutboundTransferCreatedEvent
222
+ | Stripe.Events.PushedV2MoneyManagementOutboundTransferFailedEvent
223
+ | Stripe.Events.PushedV2MoneyManagementOutboundTransferPostedEvent
224
+ | Stripe.Events.PushedV2MoneyManagementOutboundTransferReturnedEvent
225
+ | Stripe.Events.PushedV2MoneyManagementOutboundTransferUpdatedEvent
226
+ | Stripe.Events.PushedV2MoneyManagementPayoutMethodUpdatedEvent
227
+ | Stripe.Events.PushedV2MoneyManagementReceivedCreditAvailableEvent
228
+ | Stripe.Events.PushedV2MoneyManagementReceivedCreditFailedEvent
229
+ | Stripe.Events.PushedV2MoneyManagementReceivedCreditReturnedEvent
230
+ | Stripe.Events.PushedV2MoneyManagementReceivedCreditSucceededEvent
231
+ | Stripe.Events.PushedV2MoneyManagementReceivedDebitCanceledEvent
232
+ | Stripe.Events.PushedV2MoneyManagementReceivedDebitFailedEvent
233
+ | Stripe.Events.PushedV2MoneyManagementReceivedDebitPendingEvent
234
+ | Stripe.Events.PushedV2MoneyManagementReceivedDebitSucceededEvent
235
+ | Stripe.Events.PushedV2MoneyManagementReceivedDebitUpdatedEvent
236
+ | Stripe.Events.PushedV2MoneyManagementTransactionCreatedEvent
237
+ | Stripe.Events.PushedV2MoneyManagementTransactionUpdatedEvent
238
+ | Stripe.Events.PushedV2PaymentsOffSessionPaymentAuthorizationAttemptFailedEvent
239
+ | Stripe.Events.PushedV2PaymentsOffSessionPaymentAuthorizationAttemptStartedEvent
240
+ | Stripe.Events.PushedV2PaymentsOffSessionPaymentCanceledEvent
241
+ | Stripe.Events.PushedV2PaymentsOffSessionPaymentCreatedEvent
242
+ | Stripe.Events.PushedV2PaymentsOffSessionPaymentFailedEvent
243
+ | Stripe.Events.PushedV2PaymentsOffSessionPaymentSucceededEvent
244
+ | Stripe.Events.PushedV2ReportingReportRunCreatedEvent
245
+ | Stripe.Events.PushedV2ReportingReportRunFailedEvent
246
+ | Stripe.Events.PushedV2ReportingReportRunSucceededEvent
247
+ | Stripe.Events.PushedV2ReportingReportRunUpdatedEvent;
9
248
  }
10
249
 
11
250
  namespace Stripe.Events {
@@ -22,6 +261,15 @@ declare module 'stripe' {
22
261
  // Retrieves the object associated with the event.
23
262
  fetchRelatedObject(): Promise<Billing.Meter>;
24
263
  }
264
+ export interface PushedV1BillingMeterErrorReportTriggeredEvent
265
+ extends V2.EventBase {
266
+ type: 'v1.billing.meter.error_report_triggered';
267
+ // Object containing the reference to API resource relevant to the event.
268
+ related_object: Event.RelatedObject;
269
+ // Retrieves the object associated with the event.
270
+ fetchRelatedObject(): Promise<Billing.Meter>;
271
+ pull(): Promise<V1BillingMeterErrorReportTriggeredEvent>;
272
+ }
25
273
 
26
274
  namespace V1BillingMeterErrorReportTriggeredEvent {
27
275
  export interface Data {
@@ -122,6 +370,11 @@ declare module 'stripe' {
122
370
  // Retrieves data specific to this event.
123
371
  data: V1BillingMeterNoMeterFoundEvent.Data;
124
372
  }
373
+ export interface PushedV1BillingMeterNoMeterFoundEvent
374
+ extends V2.EventBase {
375
+ type: 'v1.billing.meter.no_meter_found';
376
+ pull(): Promise<V1BillingMeterNoMeterFoundEvent>;
377
+ }
125
378
 
126
379
  namespace V1BillingMeterNoMeterFoundEvent {
127
380
  export interface Data {
@@ -215,14 +468,3771 @@ declare module 'stripe' {
215
468
  }
216
469
 
217
470
  /**
218
- * A ping event used to test the connection to an EventDestination.
471
+ * Occurs when a billing Cadence generates an invoice.
219
472
  */
220
- export interface V2CoreEventDestinationPingEvent extends V2.EventBase {
221
- type: 'v2.core.event_destination.ping';
473
+ export interface V2BillingCadenceBilledEvent extends V2.EventBase {
474
+ type: 'v2.billing.cadence.billed';
222
475
  // Object containing the reference to API resource relevant to the event.
223
476
  related_object: Event.RelatedObject;
224
477
  // Retrieves the object associated with the event.
225
- fetchRelatedObject(): Promise<V2.EventDestination>;
478
+ fetchRelatedObject(): Promise<V2.Billing.Cadence>;
479
+ }
480
+ export interface PushedV2BillingCadenceBilledEvent extends V2.EventBase {
481
+ type: 'v2.billing.cadence.billed';
482
+ // Object containing the reference to API resource relevant to the event.
483
+ related_object: Event.RelatedObject;
484
+ // Retrieves the object associated with the event.
485
+ fetchRelatedObject(): Promise<V2.Billing.Cadence>;
486
+ pull(): Promise<V2BillingCadenceBilledEvent>;
487
+ }
488
+
489
+ /**
490
+ * Occurs when a billing Cadence is canceled.
491
+ */
492
+ export interface V2BillingCadenceCanceledEvent extends V2.EventBase {
493
+ type: 'v2.billing.cadence.canceled';
494
+ // Object containing the reference to API resource relevant to the event.
495
+ related_object: Event.RelatedObject;
496
+ // Retrieves the object associated with the event.
497
+ fetchRelatedObject(): Promise<V2.Billing.Cadence>;
498
+ }
499
+ export interface PushedV2BillingCadenceCanceledEvent extends V2.EventBase {
500
+ type: 'v2.billing.cadence.canceled';
501
+ // Object containing the reference to API resource relevant to the event.
502
+ related_object: Event.RelatedObject;
503
+ // Retrieves the object associated with the event.
504
+ fetchRelatedObject(): Promise<V2.Billing.Cadence>;
505
+ pull(): Promise<V2BillingCadenceCanceledEvent>;
506
+ }
507
+
508
+ /**
509
+ * Occurs when a billing Cadence is created.
510
+ */
511
+ export interface V2BillingCadenceCreatedEvent extends V2.EventBase {
512
+ type: 'v2.billing.cadence.created';
513
+ // Retrieves data specific to this event.
514
+ data: V2BillingCadenceCreatedEvent.Data;
515
+ // Object containing the reference to API resource relevant to the event.
516
+ related_object: Event.RelatedObject;
517
+ // Retrieves the object associated with the event.
518
+ fetchRelatedObject(): Promise<V2.Billing.Cadence>;
519
+ }
520
+ export interface PushedV2BillingCadenceCreatedEvent extends V2.EventBase {
521
+ type: 'v2.billing.cadence.created';
522
+ // Object containing the reference to API resource relevant to the event.
523
+ related_object: Event.RelatedObject;
524
+ // Retrieves the object associated with the event.
525
+ fetchRelatedObject(): Promise<V2.Billing.Cadence>;
526
+ pull(): Promise<V2BillingCadenceCreatedEvent>;
527
+ }
528
+
529
+ namespace V2BillingCadenceCreatedEvent {
530
+ export interface Data {
531
+ /**
532
+ * Timestamp of when the object was created.
533
+ */
534
+ created: string;
535
+ }
536
+ }
537
+
538
+ /**
539
+ * Occurs when a billing Cadence encounters an error during a tick.
540
+ */
541
+ export interface V2BillingCadenceErroredEvent extends V2.EventBase {
542
+ type: 'v2.billing.cadence.errored';
543
+ // Object containing the reference to API resource relevant to the event.
544
+ related_object: Event.RelatedObject;
545
+ // Retrieves the object associated with the event.
546
+ fetchRelatedObject(): Promise<V2.Billing.Cadence>;
547
+ }
548
+ export interface PushedV2BillingCadenceErroredEvent extends V2.EventBase {
549
+ type: 'v2.billing.cadence.errored';
550
+ // Object containing the reference to API resource relevant to the event.
551
+ related_object: Event.RelatedObject;
552
+ // Retrieves the object associated with the event.
553
+ fetchRelatedObject(): Promise<V2.Billing.Cadence>;
554
+ pull(): Promise<V2BillingCadenceErroredEvent>;
555
+ }
556
+
557
+ /**
558
+ * Occurs when a LicenseFee is created.
559
+ */
560
+ export interface V2BillingLicenseFeeCreatedEvent extends V2.EventBase {
561
+ type: 'v2.billing.license_fee.created';
562
+ // Object containing the reference to API resource relevant to the event.
563
+ related_object: Event.RelatedObject;
564
+ // Retrieves the object associated with the event.
565
+ fetchRelatedObject(): Promise<V2.Billing.LicenseFee>;
566
+ }
567
+ export interface PushedV2BillingLicenseFeeCreatedEvent
568
+ extends V2.EventBase {
569
+ type: 'v2.billing.license_fee.created';
570
+ // Object containing the reference to API resource relevant to the event.
571
+ related_object: Event.RelatedObject;
572
+ // Retrieves the object associated with the event.
573
+ fetchRelatedObject(): Promise<V2.Billing.LicenseFee>;
574
+ pull(): Promise<V2BillingLicenseFeeCreatedEvent>;
575
+ }
576
+
577
+ /**
578
+ * Occurs when a LicenseFee is updated.
579
+ */
580
+ export interface V2BillingLicenseFeeUpdatedEvent extends V2.EventBase {
581
+ type: 'v2.billing.license_fee.updated';
582
+ // Object containing the reference to API resource relevant to the event.
583
+ related_object: Event.RelatedObject;
584
+ // Retrieves the object associated with the event.
585
+ fetchRelatedObject(): Promise<V2.Billing.LicenseFee>;
586
+ }
587
+ export interface PushedV2BillingLicenseFeeUpdatedEvent
588
+ extends V2.EventBase {
589
+ type: 'v2.billing.license_fee.updated';
590
+ // Object containing the reference to API resource relevant to the event.
591
+ related_object: Event.RelatedObject;
592
+ // Retrieves the object associated with the event.
593
+ fetchRelatedObject(): Promise<V2.Billing.LicenseFee>;
594
+ pull(): Promise<V2BillingLicenseFeeUpdatedEvent>;
595
+ }
596
+
597
+ /**
598
+ * Occurs when a LicenseFeeVersion is created.
599
+ */
600
+ export interface V2BillingLicenseFeeVersionCreatedEvent
601
+ extends V2.EventBase {
602
+ type: 'v2.billing.license_fee_version.created';
603
+ // Retrieves data specific to this event.
604
+ data: V2BillingLicenseFeeVersionCreatedEvent.Data;
605
+ // Object containing the reference to API resource relevant to the event.
606
+ related_object: Event.RelatedObject;
607
+ // Retrieves the object associated with the event.
608
+ fetchRelatedObject(): Promise<V2.Billing.LicenseFeeVersion>;
609
+ }
610
+ export interface PushedV2BillingLicenseFeeVersionCreatedEvent
611
+ extends V2.EventBase {
612
+ type: 'v2.billing.license_fee_version.created';
613
+ // Object containing the reference to API resource relevant to the event.
614
+ related_object: Event.RelatedObject;
615
+ // Retrieves the object associated with the event.
616
+ fetchRelatedObject(): Promise<V2.Billing.LicenseFeeVersion>;
617
+ pull(): Promise<V2BillingLicenseFeeVersionCreatedEvent>;
618
+ }
619
+
620
+ namespace V2BillingLicenseFeeVersionCreatedEvent {
621
+ export interface Data {
622
+ /**
623
+ * The ID of the LicenseFee that the LicenseFeeVersion belongs to.
624
+ */
625
+ license_fee_id: string;
626
+ }
627
+ }
628
+
629
+ /**
630
+ * Occurs when a LicensedItem is created.
631
+ */
632
+ export interface V2BillingLicensedItemCreatedEvent extends V2.EventBase {
633
+ type: 'v2.billing.licensed_item.created';
634
+ // Object containing the reference to API resource relevant to the event.
635
+ related_object: Event.RelatedObject;
636
+ // Retrieves the object associated with the event.
637
+ fetchRelatedObject(): Promise<V2.Billing.LicensedItem>;
638
+ }
639
+ export interface PushedV2BillingLicensedItemCreatedEvent
640
+ extends V2.EventBase {
641
+ type: 'v2.billing.licensed_item.created';
642
+ // Object containing the reference to API resource relevant to the event.
643
+ related_object: Event.RelatedObject;
644
+ // Retrieves the object associated with the event.
645
+ fetchRelatedObject(): Promise<V2.Billing.LicensedItem>;
646
+ pull(): Promise<V2BillingLicensedItemCreatedEvent>;
647
+ }
648
+
649
+ /**
650
+ * Occurs when a LicensedItem is updated.
651
+ */
652
+ export interface V2BillingLicensedItemUpdatedEvent extends V2.EventBase {
653
+ type: 'v2.billing.licensed_item.updated';
654
+ // Object containing the reference to API resource relevant to the event.
655
+ related_object: Event.RelatedObject;
656
+ // Retrieves the object associated with the event.
657
+ fetchRelatedObject(): Promise<V2.Billing.LicensedItem>;
658
+ }
659
+ export interface PushedV2BillingLicensedItemUpdatedEvent
660
+ extends V2.EventBase {
661
+ type: 'v2.billing.licensed_item.updated';
662
+ // Object containing the reference to API resource relevant to the event.
663
+ related_object: Event.RelatedObject;
664
+ // Retrieves the object associated with the event.
665
+ fetchRelatedObject(): Promise<V2.Billing.LicensedItem>;
666
+ pull(): Promise<V2BillingLicensedItemUpdatedEvent>;
667
+ }
668
+
669
+ /**
670
+ * Occurs when a MeteredItem is created.
671
+ */
672
+ export interface V2BillingMeteredItemCreatedEvent extends V2.EventBase {
673
+ type: 'v2.billing.metered_item.created';
674
+ // Object containing the reference to API resource relevant to the event.
675
+ related_object: Event.RelatedObject;
676
+ // Retrieves the object associated with the event.
677
+ fetchRelatedObject(): Promise<V2.Billing.MeteredItem>;
678
+ }
679
+ export interface PushedV2BillingMeteredItemCreatedEvent
680
+ extends V2.EventBase {
681
+ type: 'v2.billing.metered_item.created';
682
+ // Object containing the reference to API resource relevant to the event.
683
+ related_object: Event.RelatedObject;
684
+ // Retrieves the object associated with the event.
685
+ fetchRelatedObject(): Promise<V2.Billing.MeteredItem>;
686
+ pull(): Promise<V2BillingMeteredItemCreatedEvent>;
687
+ }
688
+
689
+ /**
690
+ * Occurs when a MeteredItem is updated.
691
+ */
692
+ export interface V2BillingMeteredItemUpdatedEvent extends V2.EventBase {
693
+ type: 'v2.billing.metered_item.updated';
694
+ // Object containing the reference to API resource relevant to the event.
695
+ related_object: Event.RelatedObject;
696
+ // Retrieves the object associated with the event.
697
+ fetchRelatedObject(): Promise<V2.Billing.MeteredItem>;
698
+ }
699
+ export interface PushedV2BillingMeteredItemUpdatedEvent
700
+ extends V2.EventBase {
701
+ type: 'v2.billing.metered_item.updated';
702
+ // Object containing the reference to API resource relevant to the event.
703
+ related_object: Event.RelatedObject;
704
+ // Retrieves the object associated with the event.
705
+ fetchRelatedObject(): Promise<V2.Billing.MeteredItem>;
706
+ pull(): Promise<V2BillingMeteredItemUpdatedEvent>;
707
+ }
708
+
709
+ /**
710
+ * Occurs when a PricingPlan is created.
711
+ */
712
+ export interface V2BillingPricingPlanCreatedEvent extends V2.EventBase {
713
+ type: 'v2.billing.pricing_plan.created';
714
+ // Object containing the reference to API resource relevant to the event.
715
+ related_object: Event.RelatedObject;
716
+ // Retrieves the object associated with the event.
717
+ fetchRelatedObject(): Promise<V2.Billing.PricingPlan>;
718
+ }
719
+ export interface PushedV2BillingPricingPlanCreatedEvent
720
+ extends V2.EventBase {
721
+ type: 'v2.billing.pricing_plan.created';
722
+ // Object containing the reference to API resource relevant to the event.
723
+ related_object: Event.RelatedObject;
724
+ // Retrieves the object associated with the event.
725
+ fetchRelatedObject(): Promise<V2.Billing.PricingPlan>;
726
+ pull(): Promise<V2BillingPricingPlanCreatedEvent>;
727
+ }
728
+
729
+ /**
730
+ * Occurs when a PricingPlan is updated.
731
+ */
732
+ export interface V2BillingPricingPlanUpdatedEvent extends V2.EventBase {
733
+ type: 'v2.billing.pricing_plan.updated';
734
+ // Object containing the reference to API resource relevant to the event.
735
+ related_object: Event.RelatedObject;
736
+ // Retrieves the object associated with the event.
737
+ fetchRelatedObject(): Promise<V2.Billing.PricingPlan>;
738
+ }
739
+ export interface PushedV2BillingPricingPlanUpdatedEvent
740
+ extends V2.EventBase {
741
+ type: 'v2.billing.pricing_plan.updated';
742
+ // Object containing the reference to API resource relevant to the event.
743
+ related_object: Event.RelatedObject;
744
+ // Retrieves the object associated with the event.
745
+ fetchRelatedObject(): Promise<V2.Billing.PricingPlan>;
746
+ pull(): Promise<V2BillingPricingPlanUpdatedEvent>;
747
+ }
748
+
749
+ /**
750
+ * Occurs when a PricingPlanComponent is created.
751
+ */
752
+ export interface V2BillingPricingPlanComponentCreatedEvent
753
+ extends V2.EventBase {
754
+ type: 'v2.billing.pricing_plan_component.created';
755
+ // Retrieves data specific to this event.
756
+ data: V2BillingPricingPlanComponentCreatedEvent.Data;
757
+ // Object containing the reference to API resource relevant to the event.
758
+ related_object: Event.RelatedObject;
759
+ // Retrieves the object associated with the event.
760
+ fetchRelatedObject(): Promise<V2.Billing.PricingPlanComponent>;
761
+ }
762
+ export interface PushedV2BillingPricingPlanComponentCreatedEvent
763
+ extends V2.EventBase {
764
+ type: 'v2.billing.pricing_plan_component.created';
765
+ // Object containing the reference to API resource relevant to the event.
766
+ related_object: Event.RelatedObject;
767
+ // Retrieves the object associated with the event.
768
+ fetchRelatedObject(): Promise<V2.Billing.PricingPlanComponent>;
769
+ pull(): Promise<V2BillingPricingPlanComponentCreatedEvent>;
770
+ }
771
+
772
+ namespace V2BillingPricingPlanComponentCreatedEvent {
773
+ export interface Data {
774
+ /**
775
+ * The ID of the PricingPlan that the PricingPlanComponent belongs to.
776
+ */
777
+ pricing_plan_id: string;
778
+ }
779
+ }
780
+
781
+ /**
782
+ * Occurs when a PricingPlanComponent is updated.
783
+ */
784
+ export interface V2BillingPricingPlanComponentUpdatedEvent
785
+ extends V2.EventBase {
786
+ type: 'v2.billing.pricing_plan_component.updated';
787
+ // Retrieves data specific to this event.
788
+ data: V2BillingPricingPlanComponentUpdatedEvent.Data;
789
+ // Object containing the reference to API resource relevant to the event.
790
+ related_object: Event.RelatedObject;
791
+ // Retrieves the object associated with the event.
792
+ fetchRelatedObject(): Promise<V2.Billing.PricingPlanComponent>;
793
+ }
794
+ export interface PushedV2BillingPricingPlanComponentUpdatedEvent
795
+ extends V2.EventBase {
796
+ type: 'v2.billing.pricing_plan_component.updated';
797
+ // Object containing the reference to API resource relevant to the event.
798
+ related_object: Event.RelatedObject;
799
+ // Retrieves the object associated with the event.
800
+ fetchRelatedObject(): Promise<V2.Billing.PricingPlanComponent>;
801
+ pull(): Promise<V2BillingPricingPlanComponentUpdatedEvent>;
802
+ }
803
+
804
+ namespace V2BillingPricingPlanComponentUpdatedEvent {
805
+ export interface Data {
806
+ /**
807
+ * The ID of the PricingPlan that the PricingPlanComponent belongs to.
808
+ */
809
+ pricing_plan_id: string;
810
+ }
811
+ }
812
+
813
+ /**
814
+ * Occurs when a PricingPlanSubscription's collection is awaiting customer action.
815
+ */
816
+ export interface V2BillingPricingPlanSubscriptionCollectionAwaitingCustomerActionEvent
817
+ extends V2.EventBase {
818
+ type: 'v2.billing.pricing_plan_subscription.collection_awaiting_customer_action';
819
+ // Object containing the reference to API resource relevant to the event.
820
+ related_object: Event.RelatedObject;
821
+ // Retrieves the object associated with the event.
822
+ fetchRelatedObject(): Promise<V2.Billing.PricingPlanSubscription>;
823
+ }
824
+ export interface PushedV2BillingPricingPlanSubscriptionCollectionAwaitingCustomerActionEvent
825
+ extends V2.EventBase {
826
+ type: 'v2.billing.pricing_plan_subscription.collection_awaiting_customer_action';
827
+ // Object containing the reference to API resource relevant to the event.
828
+ related_object: Event.RelatedObject;
829
+ // Retrieves the object associated with the event.
830
+ fetchRelatedObject(): Promise<V2.Billing.PricingPlanSubscription>;
831
+ pull(): Promise<
832
+ V2BillingPricingPlanSubscriptionCollectionAwaitingCustomerActionEvent
833
+ >;
834
+ }
835
+
836
+ /**
837
+ * Occurs when a PricingPlanSubscription's collection is current.
838
+ */
839
+ export interface V2BillingPricingPlanSubscriptionCollectionCurrentEvent
840
+ extends V2.EventBase {
841
+ type: 'v2.billing.pricing_plan_subscription.collection_current';
842
+ // Object containing the reference to API resource relevant to the event.
843
+ related_object: Event.RelatedObject;
844
+ // Retrieves the object associated with the event.
845
+ fetchRelatedObject(): Promise<V2.Billing.PricingPlanSubscription>;
846
+ }
847
+ export interface PushedV2BillingPricingPlanSubscriptionCollectionCurrentEvent
848
+ extends V2.EventBase {
849
+ type: 'v2.billing.pricing_plan_subscription.collection_current';
850
+ // Object containing the reference to API resource relevant to the event.
851
+ related_object: Event.RelatedObject;
852
+ // Retrieves the object associated with the event.
853
+ fetchRelatedObject(): Promise<V2.Billing.PricingPlanSubscription>;
854
+ pull(): Promise<V2BillingPricingPlanSubscriptionCollectionCurrentEvent>;
855
+ }
856
+
857
+ /**
858
+ * Occurs when a PricingPlanSubscription's collection is past due.
859
+ */
860
+ export interface V2BillingPricingPlanSubscriptionCollectionPastDueEvent
861
+ extends V2.EventBase {
862
+ type: 'v2.billing.pricing_plan_subscription.collection_past_due';
863
+ // Object containing the reference to API resource relevant to the event.
864
+ related_object: Event.RelatedObject;
865
+ // Retrieves the object associated with the event.
866
+ fetchRelatedObject(): Promise<V2.Billing.PricingPlanSubscription>;
867
+ }
868
+ export interface PushedV2BillingPricingPlanSubscriptionCollectionPastDueEvent
869
+ extends V2.EventBase {
870
+ type: 'v2.billing.pricing_plan_subscription.collection_past_due';
871
+ // Object containing the reference to API resource relevant to the event.
872
+ related_object: Event.RelatedObject;
873
+ // Retrieves the object associated with the event.
874
+ fetchRelatedObject(): Promise<V2.Billing.PricingPlanSubscription>;
875
+ pull(): Promise<V2BillingPricingPlanSubscriptionCollectionPastDueEvent>;
876
+ }
877
+
878
+ /**
879
+ * Occurs when a PricingPlanSubscription's collection is paused.
880
+ */
881
+ export interface V2BillingPricingPlanSubscriptionCollectionPausedEvent
882
+ extends V2.EventBase {
883
+ type: 'v2.billing.pricing_plan_subscription.collection_paused';
884
+ // Object containing the reference to API resource relevant to the event.
885
+ related_object: Event.RelatedObject;
886
+ // Retrieves the object associated with the event.
887
+ fetchRelatedObject(): Promise<V2.Billing.PricingPlanSubscription>;
888
+ }
889
+ export interface PushedV2BillingPricingPlanSubscriptionCollectionPausedEvent
890
+ extends V2.EventBase {
891
+ type: 'v2.billing.pricing_plan_subscription.collection_paused';
892
+ // Object containing the reference to API resource relevant to the event.
893
+ related_object: Event.RelatedObject;
894
+ // Retrieves the object associated with the event.
895
+ fetchRelatedObject(): Promise<V2.Billing.PricingPlanSubscription>;
896
+ pull(): Promise<V2BillingPricingPlanSubscriptionCollectionPausedEvent>;
897
+ }
898
+
899
+ /**
900
+ * Occurs when a PricingPlanSubscription's collection is unpaid.
901
+ */
902
+ export interface V2BillingPricingPlanSubscriptionCollectionUnpaidEvent
903
+ extends V2.EventBase {
904
+ type: 'v2.billing.pricing_plan_subscription.collection_unpaid';
905
+ // Object containing the reference to API resource relevant to the event.
906
+ related_object: Event.RelatedObject;
907
+ // Retrieves the object associated with the event.
908
+ fetchRelatedObject(): Promise<V2.Billing.PricingPlanSubscription>;
909
+ }
910
+ export interface PushedV2BillingPricingPlanSubscriptionCollectionUnpaidEvent
911
+ extends V2.EventBase {
912
+ type: 'v2.billing.pricing_plan_subscription.collection_unpaid';
913
+ // Object containing the reference to API resource relevant to the event.
914
+ related_object: Event.RelatedObject;
915
+ // Retrieves the object associated with the event.
916
+ fetchRelatedObject(): Promise<V2.Billing.PricingPlanSubscription>;
917
+ pull(): Promise<V2BillingPricingPlanSubscriptionCollectionUnpaidEvent>;
918
+ }
919
+
920
+ /**
921
+ * Occurs when PricingPlanSubscription servicing is activated.
922
+ */
923
+ export interface V2BillingPricingPlanSubscriptionServicingActivatedEvent
924
+ extends V2.EventBase {
925
+ type: 'v2.billing.pricing_plan_subscription.servicing_activated';
926
+ // Object containing the reference to API resource relevant to the event.
927
+ related_object: Event.RelatedObject;
928
+ // Retrieves the object associated with the event.
929
+ fetchRelatedObject(): Promise<V2.Billing.PricingPlanSubscription>;
930
+ }
931
+ export interface PushedV2BillingPricingPlanSubscriptionServicingActivatedEvent
932
+ extends V2.EventBase {
933
+ type: 'v2.billing.pricing_plan_subscription.servicing_activated';
934
+ // Object containing the reference to API resource relevant to the event.
935
+ related_object: Event.RelatedObject;
936
+ // Retrieves the object associated with the event.
937
+ fetchRelatedObject(): Promise<V2.Billing.PricingPlanSubscription>;
938
+ pull(): Promise<V2BillingPricingPlanSubscriptionServicingActivatedEvent>;
939
+ }
940
+
941
+ /**
942
+ * Occurs when PricingPlanSubscription servicing is canceled.
943
+ */
944
+ export interface V2BillingPricingPlanSubscriptionServicingCanceledEvent
945
+ extends V2.EventBase {
946
+ type: 'v2.billing.pricing_plan_subscription.servicing_canceled';
947
+ // Object containing the reference to API resource relevant to the event.
948
+ related_object: Event.RelatedObject;
949
+ // Retrieves the object associated with the event.
950
+ fetchRelatedObject(): Promise<V2.Billing.PricingPlanSubscription>;
951
+ }
952
+ export interface PushedV2BillingPricingPlanSubscriptionServicingCanceledEvent
953
+ extends V2.EventBase {
954
+ type: 'v2.billing.pricing_plan_subscription.servicing_canceled';
955
+ // Object containing the reference to API resource relevant to the event.
956
+ related_object: Event.RelatedObject;
957
+ // Retrieves the object associated with the event.
958
+ fetchRelatedObject(): Promise<V2.Billing.PricingPlanSubscription>;
959
+ pull(): Promise<V2BillingPricingPlanSubscriptionServicingCanceledEvent>;
960
+ }
961
+
962
+ /**
963
+ * Occurs when PricingPlanSubscription servicing is paused.
964
+ */
965
+ export interface V2BillingPricingPlanSubscriptionServicingPausedEvent
966
+ extends V2.EventBase {
967
+ type: 'v2.billing.pricing_plan_subscription.servicing_paused';
968
+ // Object containing the reference to API resource relevant to the event.
969
+ related_object: Event.RelatedObject;
970
+ // Retrieves the object associated with the event.
971
+ fetchRelatedObject(): Promise<V2.Billing.PricingPlanSubscription>;
972
+ }
973
+ export interface PushedV2BillingPricingPlanSubscriptionServicingPausedEvent
974
+ extends V2.EventBase {
975
+ type: 'v2.billing.pricing_plan_subscription.servicing_paused';
976
+ // Object containing the reference to API resource relevant to the event.
977
+ related_object: Event.RelatedObject;
978
+ // Retrieves the object associated with the event.
979
+ fetchRelatedObject(): Promise<V2.Billing.PricingPlanSubscription>;
980
+ pull(): Promise<V2BillingPricingPlanSubscriptionServicingPausedEvent>;
981
+ }
982
+
983
+ /**
984
+ * Occurs when a PricingPlanVersion is created.
985
+ */
986
+ export interface V2BillingPricingPlanVersionCreatedEvent
987
+ extends V2.EventBase {
988
+ type: 'v2.billing.pricing_plan_version.created';
989
+ // Retrieves data specific to this event.
990
+ data: V2BillingPricingPlanVersionCreatedEvent.Data;
991
+ // Object containing the reference to API resource relevant to the event.
992
+ related_object: Event.RelatedObject;
993
+ // Retrieves the object associated with the event.
994
+ fetchRelatedObject(): Promise<V2.Billing.PricingPlanVersion>;
995
+ }
996
+ export interface PushedV2BillingPricingPlanVersionCreatedEvent
997
+ extends V2.EventBase {
998
+ type: 'v2.billing.pricing_plan_version.created';
999
+ // Object containing the reference to API resource relevant to the event.
1000
+ related_object: Event.RelatedObject;
1001
+ // Retrieves the object associated with the event.
1002
+ fetchRelatedObject(): Promise<V2.Billing.PricingPlanVersion>;
1003
+ pull(): Promise<V2BillingPricingPlanVersionCreatedEvent>;
1004
+ }
1005
+
1006
+ namespace V2BillingPricingPlanVersionCreatedEvent {
1007
+ export interface Data {
1008
+ /**
1009
+ * The ID of the PricingPlan that the PricingPlanVersion belongs to.
1010
+ */
1011
+ pricing_plan_id: string;
1012
+ }
1013
+ }
1014
+
1015
+ /**
1016
+ * Occurs when a RateCard is created.
1017
+ */
1018
+ export interface V2BillingRateCardCreatedEvent extends V2.EventBase {
1019
+ type: 'v2.billing.rate_card.created';
1020
+ // Retrieves data specific to this event.
1021
+ data: V2BillingRateCardCreatedEvent.Data;
1022
+ // Object containing the reference to API resource relevant to the event.
1023
+ related_object: Event.RelatedObject;
1024
+ // Retrieves the object associated with the event.
1025
+ fetchRelatedObject(): Promise<V2.Billing.RateCard>;
1026
+ }
1027
+ export interface PushedV2BillingRateCardCreatedEvent extends V2.EventBase {
1028
+ type: 'v2.billing.rate_card.created';
1029
+ // Object containing the reference to API resource relevant to the event.
1030
+ related_object: Event.RelatedObject;
1031
+ // Retrieves the object associated with the event.
1032
+ fetchRelatedObject(): Promise<V2.Billing.RateCard>;
1033
+ pull(): Promise<V2BillingRateCardCreatedEvent>;
1034
+ }
1035
+
1036
+ namespace V2BillingRateCardCreatedEvent {
1037
+ export interface Data {
1038
+ /**
1039
+ * Timestamp of when the object was created.
1040
+ */
1041
+ created: string;
1042
+ }
1043
+ }
1044
+
1045
+ /**
1046
+ * Occurs when a RateCard is updated.
1047
+ */
1048
+ export interface V2BillingRateCardUpdatedEvent extends V2.EventBase {
1049
+ type: 'v2.billing.rate_card.updated';
1050
+ // Object containing the reference to API resource relevant to the event.
1051
+ related_object: Event.RelatedObject;
1052
+ // Retrieves the object associated with the event.
1053
+ fetchRelatedObject(): Promise<V2.Billing.RateCard>;
1054
+ }
1055
+ export interface PushedV2BillingRateCardUpdatedEvent extends V2.EventBase {
1056
+ type: 'v2.billing.rate_card.updated';
1057
+ // Object containing the reference to API resource relevant to the event.
1058
+ related_object: Event.RelatedObject;
1059
+ // Retrieves the object associated with the event.
1060
+ fetchRelatedObject(): Promise<V2.Billing.RateCard>;
1061
+ pull(): Promise<V2BillingRateCardUpdatedEvent>;
1062
+ }
1063
+
1064
+ /**
1065
+ * Occurs when a RateCardRate is created.
1066
+ */
1067
+ export interface V2BillingRateCardRateCreatedEvent extends V2.EventBase {
1068
+ type: 'v2.billing.rate_card_rate.created';
1069
+ // Retrieves data specific to this event.
1070
+ data: V2BillingRateCardRateCreatedEvent.Data;
1071
+ // Object containing the reference to API resource relevant to the event.
1072
+ related_object: Event.RelatedObject;
1073
+ // Retrieves the object associated with the event.
1074
+ fetchRelatedObject(): Promise<V2.Billing.RateCardRate>;
1075
+ }
1076
+ export interface PushedV2BillingRateCardRateCreatedEvent
1077
+ extends V2.EventBase {
1078
+ type: 'v2.billing.rate_card_rate.created';
1079
+ // Object containing the reference to API resource relevant to the event.
1080
+ related_object: Event.RelatedObject;
1081
+ // Retrieves the object associated with the event.
1082
+ fetchRelatedObject(): Promise<V2.Billing.RateCardRate>;
1083
+ pull(): Promise<V2BillingRateCardRateCreatedEvent>;
1084
+ }
1085
+
1086
+ namespace V2BillingRateCardRateCreatedEvent {
1087
+ export interface Data {
1088
+ /**
1089
+ * The ID of the BillableItem which this Rate is associated with.
1090
+ */
1091
+ billable_item: string;
1092
+
1093
+ /**
1094
+ * Timestamp of when the object was created.
1095
+ */
1096
+ created: string;
1097
+
1098
+ /**
1099
+ * The ID of the RateCard which this Rate belongs to.
1100
+ */
1101
+ rate_card: string;
1102
+
1103
+ /**
1104
+ * The ID of the latest RateCard Version when the Rate was created.
1105
+ */
1106
+ rate_card_version: string;
1107
+ }
1108
+ }
1109
+
1110
+ /**
1111
+ * Occurs when a RateCardSubscription is activated.
1112
+ */
1113
+ export interface V2BillingRateCardSubscriptionActivatedEvent
1114
+ extends V2.EventBase {
1115
+ type: 'v2.billing.rate_card_subscription.activated';
1116
+ // Object containing the reference to API resource relevant to the event.
1117
+ related_object: Event.RelatedObject;
1118
+ // Retrieves the object associated with the event.
1119
+ fetchRelatedObject(): Promise<V2.Billing.RateCardSubscription>;
1120
+ }
1121
+ export interface PushedV2BillingRateCardSubscriptionActivatedEvent
1122
+ extends V2.EventBase {
1123
+ type: 'v2.billing.rate_card_subscription.activated';
1124
+ // Object containing the reference to API resource relevant to the event.
1125
+ related_object: Event.RelatedObject;
1126
+ // Retrieves the object associated with the event.
1127
+ fetchRelatedObject(): Promise<V2.Billing.RateCardSubscription>;
1128
+ pull(): Promise<V2BillingRateCardSubscriptionActivatedEvent>;
1129
+ }
1130
+
1131
+ /**
1132
+ * Occurs when a RateCardSubscription is canceled.
1133
+ */
1134
+ export interface V2BillingRateCardSubscriptionCanceledEvent
1135
+ extends V2.EventBase {
1136
+ type: 'v2.billing.rate_card_subscription.canceled';
1137
+ // Object containing the reference to API resource relevant to the event.
1138
+ related_object: Event.RelatedObject;
1139
+ // Retrieves the object associated with the event.
1140
+ fetchRelatedObject(): Promise<V2.Billing.RateCardSubscription>;
1141
+ }
1142
+ export interface PushedV2BillingRateCardSubscriptionCanceledEvent
1143
+ extends V2.EventBase {
1144
+ type: 'v2.billing.rate_card_subscription.canceled';
1145
+ // Object containing the reference to API resource relevant to the event.
1146
+ related_object: Event.RelatedObject;
1147
+ // Retrieves the object associated with the event.
1148
+ fetchRelatedObject(): Promise<V2.Billing.RateCardSubscription>;
1149
+ pull(): Promise<V2BillingRateCardSubscriptionCanceledEvent>;
1150
+ }
1151
+
1152
+ /**
1153
+ * Occurs when a RateCardSubscription's collection is awaiting customer action.
1154
+ */
1155
+ export interface V2BillingRateCardSubscriptionCollectionAwaitingCustomerActionEvent
1156
+ extends V2.EventBase {
1157
+ type: 'v2.billing.rate_card_subscription.collection_awaiting_customer_action';
1158
+ // Object containing the reference to API resource relevant to the event.
1159
+ related_object: Event.RelatedObject;
1160
+ // Retrieves the object associated with the event.
1161
+ fetchRelatedObject(): Promise<V2.Billing.RateCardSubscription>;
1162
+ }
1163
+ export interface PushedV2BillingRateCardSubscriptionCollectionAwaitingCustomerActionEvent
1164
+ extends V2.EventBase {
1165
+ type: 'v2.billing.rate_card_subscription.collection_awaiting_customer_action';
1166
+ // Object containing the reference to API resource relevant to the event.
1167
+ related_object: Event.RelatedObject;
1168
+ // Retrieves the object associated with the event.
1169
+ fetchRelatedObject(): Promise<V2.Billing.RateCardSubscription>;
1170
+ pull(): Promise<
1171
+ V2BillingRateCardSubscriptionCollectionAwaitingCustomerActionEvent
1172
+ >;
1173
+ }
1174
+
1175
+ /**
1176
+ * Occurs when a RateCardSubscription's collection is current.
1177
+ */
1178
+ export interface V2BillingRateCardSubscriptionCollectionCurrentEvent
1179
+ extends V2.EventBase {
1180
+ type: 'v2.billing.rate_card_subscription.collection_current';
1181
+ // Object containing the reference to API resource relevant to the event.
1182
+ related_object: Event.RelatedObject;
1183
+ // Retrieves the object associated with the event.
1184
+ fetchRelatedObject(): Promise<V2.Billing.RateCardSubscription>;
1185
+ }
1186
+ export interface PushedV2BillingRateCardSubscriptionCollectionCurrentEvent
1187
+ extends V2.EventBase {
1188
+ type: 'v2.billing.rate_card_subscription.collection_current';
1189
+ // Object containing the reference to API resource relevant to the event.
1190
+ related_object: Event.RelatedObject;
1191
+ // Retrieves the object associated with the event.
1192
+ fetchRelatedObject(): Promise<V2.Billing.RateCardSubscription>;
1193
+ pull(): Promise<V2BillingRateCardSubscriptionCollectionCurrentEvent>;
1194
+ }
1195
+
1196
+ /**
1197
+ * Occurs when a RateCardSubscription's collection is past due.
1198
+ */
1199
+ export interface V2BillingRateCardSubscriptionCollectionPastDueEvent
1200
+ extends V2.EventBase {
1201
+ type: 'v2.billing.rate_card_subscription.collection_past_due';
1202
+ // Object containing the reference to API resource relevant to the event.
1203
+ related_object: Event.RelatedObject;
1204
+ // Retrieves the object associated with the event.
1205
+ fetchRelatedObject(): Promise<V2.Billing.RateCardSubscription>;
1206
+ }
1207
+ export interface PushedV2BillingRateCardSubscriptionCollectionPastDueEvent
1208
+ extends V2.EventBase {
1209
+ type: 'v2.billing.rate_card_subscription.collection_past_due';
1210
+ // Object containing the reference to API resource relevant to the event.
1211
+ related_object: Event.RelatedObject;
1212
+ // Retrieves the object associated with the event.
1213
+ fetchRelatedObject(): Promise<V2.Billing.RateCardSubscription>;
1214
+ pull(): Promise<V2BillingRateCardSubscriptionCollectionPastDueEvent>;
1215
+ }
1216
+
1217
+ /**
1218
+ * Occurs when a RateCardSubscription's collection is paused.
1219
+ */
1220
+ export interface V2BillingRateCardSubscriptionCollectionPausedEvent
1221
+ extends V2.EventBase {
1222
+ type: 'v2.billing.rate_card_subscription.collection_paused';
1223
+ // Object containing the reference to API resource relevant to the event.
1224
+ related_object: Event.RelatedObject;
1225
+ // Retrieves the object associated with the event.
1226
+ fetchRelatedObject(): Promise<V2.Billing.RateCardSubscription>;
1227
+ }
1228
+ export interface PushedV2BillingRateCardSubscriptionCollectionPausedEvent
1229
+ extends V2.EventBase {
1230
+ type: 'v2.billing.rate_card_subscription.collection_paused';
1231
+ // Object containing the reference to API resource relevant to the event.
1232
+ related_object: Event.RelatedObject;
1233
+ // Retrieves the object associated with the event.
1234
+ fetchRelatedObject(): Promise<V2.Billing.RateCardSubscription>;
1235
+ pull(): Promise<V2BillingRateCardSubscriptionCollectionPausedEvent>;
1236
+ }
1237
+
1238
+ /**
1239
+ * Occurs when a RateCardSubscription's collection is unpaid.
1240
+ */
1241
+ export interface V2BillingRateCardSubscriptionCollectionUnpaidEvent
1242
+ extends V2.EventBase {
1243
+ type: 'v2.billing.rate_card_subscription.collection_unpaid';
1244
+ // Object containing the reference to API resource relevant to the event.
1245
+ related_object: Event.RelatedObject;
1246
+ // Retrieves the object associated with the event.
1247
+ fetchRelatedObject(): Promise<V2.Billing.RateCardSubscription>;
1248
+ }
1249
+ export interface PushedV2BillingRateCardSubscriptionCollectionUnpaidEvent
1250
+ extends V2.EventBase {
1251
+ type: 'v2.billing.rate_card_subscription.collection_unpaid';
1252
+ // Object containing the reference to API resource relevant to the event.
1253
+ related_object: Event.RelatedObject;
1254
+ // Retrieves the object associated with the event.
1255
+ fetchRelatedObject(): Promise<V2.Billing.RateCardSubscription>;
1256
+ pull(): Promise<V2BillingRateCardSubscriptionCollectionUnpaidEvent>;
1257
+ }
1258
+
1259
+ /**
1260
+ * Occurs when RateCardSubscription servicing is activated.
1261
+ */
1262
+ export interface V2BillingRateCardSubscriptionServicingActivatedEvent
1263
+ extends V2.EventBase {
1264
+ type: 'v2.billing.rate_card_subscription.servicing_activated';
1265
+ // Object containing the reference to API resource relevant to the event.
1266
+ related_object: Event.RelatedObject;
1267
+ // Retrieves the object associated with the event.
1268
+ fetchRelatedObject(): Promise<V2.Billing.RateCardSubscription>;
1269
+ }
1270
+ export interface PushedV2BillingRateCardSubscriptionServicingActivatedEvent
1271
+ extends V2.EventBase {
1272
+ type: 'v2.billing.rate_card_subscription.servicing_activated';
1273
+ // Object containing the reference to API resource relevant to the event.
1274
+ related_object: Event.RelatedObject;
1275
+ // Retrieves the object associated with the event.
1276
+ fetchRelatedObject(): Promise<V2.Billing.RateCardSubscription>;
1277
+ pull(): Promise<V2BillingRateCardSubscriptionServicingActivatedEvent>;
1278
+ }
1279
+
1280
+ /**
1281
+ * Occurs when RateCardSubscription servicing is canceled.
1282
+ */
1283
+ export interface V2BillingRateCardSubscriptionServicingCanceledEvent
1284
+ extends V2.EventBase {
1285
+ type: 'v2.billing.rate_card_subscription.servicing_canceled';
1286
+ // Object containing the reference to API resource relevant to the event.
1287
+ related_object: Event.RelatedObject;
1288
+ // Retrieves the object associated with the event.
1289
+ fetchRelatedObject(): Promise<V2.Billing.RateCardSubscription>;
1290
+ }
1291
+ export interface PushedV2BillingRateCardSubscriptionServicingCanceledEvent
1292
+ extends V2.EventBase {
1293
+ type: 'v2.billing.rate_card_subscription.servicing_canceled';
1294
+ // Object containing the reference to API resource relevant to the event.
1295
+ related_object: Event.RelatedObject;
1296
+ // Retrieves the object associated with the event.
1297
+ fetchRelatedObject(): Promise<V2.Billing.RateCardSubscription>;
1298
+ pull(): Promise<V2BillingRateCardSubscriptionServicingCanceledEvent>;
1299
+ }
1300
+
1301
+ /**
1302
+ * Occurs when RateCardSubscription servicing is paused.
1303
+ */
1304
+ export interface V2BillingRateCardSubscriptionServicingPausedEvent
1305
+ extends V2.EventBase {
1306
+ type: 'v2.billing.rate_card_subscription.servicing_paused';
1307
+ // Object containing the reference to API resource relevant to the event.
1308
+ related_object: Event.RelatedObject;
1309
+ // Retrieves the object associated with the event.
1310
+ fetchRelatedObject(): Promise<V2.Billing.RateCardSubscription>;
1311
+ }
1312
+ export interface PushedV2BillingRateCardSubscriptionServicingPausedEvent
1313
+ extends V2.EventBase {
1314
+ type: 'v2.billing.rate_card_subscription.servicing_paused';
1315
+ // Object containing the reference to API resource relevant to the event.
1316
+ related_object: Event.RelatedObject;
1317
+ // Retrieves the object associated with the event.
1318
+ fetchRelatedObject(): Promise<V2.Billing.RateCardSubscription>;
1319
+ pull(): Promise<V2BillingRateCardSubscriptionServicingPausedEvent>;
1320
+ }
1321
+
1322
+ /**
1323
+ * Occurs when a RateCardVersion is created.
1324
+ */
1325
+ export interface V2BillingRateCardVersionCreatedEvent extends V2.EventBase {
1326
+ type: 'v2.billing.rate_card_version.created';
1327
+ // Retrieves data specific to this event.
1328
+ data: V2BillingRateCardVersionCreatedEvent.Data;
1329
+ // Object containing the reference to API resource relevant to the event.
1330
+ related_object: Event.RelatedObject;
1331
+ // Retrieves the object associated with the event.
1332
+ fetchRelatedObject(): Promise<V2.Billing.RateCardVersion>;
1333
+ }
1334
+ export interface PushedV2BillingRateCardVersionCreatedEvent
1335
+ extends V2.EventBase {
1336
+ type: 'v2.billing.rate_card_version.created';
1337
+ // Object containing the reference to API resource relevant to the event.
1338
+ related_object: Event.RelatedObject;
1339
+ // Retrieves the object associated with the event.
1340
+ fetchRelatedObject(): Promise<V2.Billing.RateCardVersion>;
1341
+ pull(): Promise<V2BillingRateCardVersionCreatedEvent>;
1342
+ }
1343
+
1344
+ namespace V2BillingRateCardVersionCreatedEvent {
1345
+ export interface Data {
1346
+ /**
1347
+ * The ID of the RateCard that the RateCardVersion belongs to.
1348
+ */
1349
+ rate_card_id: string;
1350
+ }
1351
+ }
1352
+
1353
+ /**
1354
+ * This event occurs when an account is closed.
1355
+ */
1356
+ export interface V2CoreAccountClosedEvent extends V2.EventBase {
1357
+ type: 'v2.core.account.closed';
1358
+ // Object containing the reference to API resource relevant to the event.
1359
+ related_object: Event.RelatedObject;
1360
+ // Retrieves the object associated with the event.
1361
+ fetchRelatedObject(): Promise<V2.Core.Account>;
1362
+ }
1363
+ export interface PushedV2CoreAccountClosedEvent extends V2.EventBase {
1364
+ type: 'v2.core.account.closed';
1365
+ // Object containing the reference to API resource relevant to the event.
1366
+ related_object: Event.RelatedObject;
1367
+ // Retrieves the object associated with the event.
1368
+ fetchRelatedObject(): Promise<V2.Core.Account>;
1369
+ pull(): Promise<V2CoreAccountClosedEvent>;
1370
+ }
1371
+
1372
+ /**
1373
+ * Occurs when an Account is created.
1374
+ */
1375
+ export interface V2CoreAccountCreatedEvent extends V2.EventBase {
1376
+ type: 'v2.core.account.created';
1377
+ // Object containing the reference to API resource relevant to the event.
1378
+ related_object: Event.RelatedObject;
1379
+ // Retrieves the object associated with the event.
1380
+ fetchRelatedObject(): Promise<V2.Core.Account>;
1381
+ }
1382
+ export interface PushedV2CoreAccountCreatedEvent extends V2.EventBase {
1383
+ type: 'v2.core.account.created';
1384
+ // Object containing the reference to API resource relevant to the event.
1385
+ related_object: Event.RelatedObject;
1386
+ // Retrieves the object associated with the event.
1387
+ fetchRelatedObject(): Promise<V2.Core.Account>;
1388
+ pull(): Promise<V2CoreAccountCreatedEvent>;
1389
+ }
1390
+
1391
+ /**
1392
+ * Occurs when an Account is updated.
1393
+ */
1394
+ export interface V2CoreAccountUpdatedEvent extends V2.EventBase {
1395
+ type: 'v2.core.account.updated';
1396
+ // Object containing the reference to API resource relevant to the event.
1397
+ related_object: Event.RelatedObject;
1398
+ // Retrieves the object associated with the event.
1399
+ fetchRelatedObject(): Promise<V2.Core.Account>;
1400
+ }
1401
+ export interface PushedV2CoreAccountUpdatedEvent extends V2.EventBase {
1402
+ type: 'v2.core.account.updated';
1403
+ // Object containing the reference to API resource relevant to the event.
1404
+ related_object: Event.RelatedObject;
1405
+ // Retrieves the object associated with the event.
1406
+ fetchRelatedObject(): Promise<V2.Core.Account>;
1407
+ pull(): Promise<V2CoreAccountUpdatedEvent>;
1408
+ }
1409
+
1410
+ /**
1411
+ * Occurs when the status of an Account's customer configuration capability is updated.
1412
+ */
1413
+ export interface V2CoreAccountIncludingConfigurationCustomerCapabilityStatusUpdatedEvent
1414
+ extends V2.EventBase {
1415
+ type: 'v2.core.account[configuration.customer].capability_status_updated';
1416
+ // Retrieves data specific to this event.
1417
+ data: V2CoreAccountIncludingConfigurationCustomerCapabilityStatusUpdatedEvent.Data;
1418
+ // Object containing the reference to API resource relevant to the event.
1419
+ related_object: Event.RelatedObject;
1420
+ // Retrieves the object associated with the event.
1421
+ fetchRelatedObject(): Promise<V2.Core.Account>;
1422
+ }
1423
+ export interface PushedV2CoreAccountIncludingConfigurationCustomerCapabilityStatusUpdatedEvent
1424
+ extends V2.EventBase {
1425
+ type: 'v2.core.account[configuration.customer].capability_status_updated';
1426
+ // Object containing the reference to API resource relevant to the event.
1427
+ related_object: Event.RelatedObject;
1428
+ // Retrieves the object associated with the event.
1429
+ fetchRelatedObject(): Promise<V2.Core.Account>;
1430
+ pull(): Promise<
1431
+ V2CoreAccountIncludingConfigurationCustomerCapabilityStatusUpdatedEvent
1432
+ >;
1433
+ }
1434
+
1435
+ namespace V2CoreAccountIncludingConfigurationCustomerCapabilityStatusUpdatedEvent {
1436
+ export interface Data {
1437
+ /**
1438
+ * Open Enum. The capability which had its status updated.
1439
+ */
1440
+ updated_capability: 'automatic_indirect_tax';
1441
+ }
1442
+ }
1443
+
1444
+ /**
1445
+ * Occurs when an Account's customer configuration is updated.
1446
+ */
1447
+ export interface V2CoreAccountIncludingConfigurationCustomerUpdatedEvent
1448
+ extends V2.EventBase {
1449
+ type: 'v2.core.account[configuration.customer].updated';
1450
+ // Object containing the reference to API resource relevant to the event.
1451
+ related_object: Event.RelatedObject;
1452
+ // Retrieves the object associated with the event.
1453
+ fetchRelatedObject(): Promise<V2.Core.Account>;
1454
+ }
1455
+ export interface PushedV2CoreAccountIncludingConfigurationCustomerUpdatedEvent
1456
+ extends V2.EventBase {
1457
+ type: 'v2.core.account[configuration.customer].updated';
1458
+ // Object containing the reference to API resource relevant to the event.
1459
+ related_object: Event.RelatedObject;
1460
+ // Retrieves the object associated with the event.
1461
+ fetchRelatedObject(): Promise<V2.Core.Account>;
1462
+ pull(): Promise<V2CoreAccountIncludingConfigurationCustomerUpdatedEvent>;
1463
+ }
1464
+
1465
+ /**
1466
+ * Occurs when the status of an Account's merchant configuration capability is updated.
1467
+ */
1468
+ export interface V2CoreAccountIncludingConfigurationMerchantCapabilityStatusUpdatedEvent
1469
+ extends V2.EventBase {
1470
+ type: 'v2.core.account[configuration.merchant].capability_status_updated';
1471
+ // Retrieves data specific to this event.
1472
+ data: V2CoreAccountIncludingConfigurationMerchantCapabilityStatusUpdatedEvent.Data;
1473
+ // Object containing the reference to API resource relevant to the event.
1474
+ related_object: Event.RelatedObject;
1475
+ // Retrieves the object associated with the event.
1476
+ fetchRelatedObject(): Promise<V2.Core.Account>;
1477
+ }
1478
+ export interface PushedV2CoreAccountIncludingConfigurationMerchantCapabilityStatusUpdatedEvent
1479
+ extends V2.EventBase {
1480
+ type: 'v2.core.account[configuration.merchant].capability_status_updated';
1481
+ // Object containing the reference to API resource relevant to the event.
1482
+ related_object: Event.RelatedObject;
1483
+ // Retrieves the object associated with the event.
1484
+ fetchRelatedObject(): Promise<V2.Core.Account>;
1485
+ pull(): Promise<
1486
+ V2CoreAccountIncludingConfigurationMerchantCapabilityStatusUpdatedEvent
1487
+ >;
1488
+ }
1489
+
1490
+ namespace V2CoreAccountIncludingConfigurationMerchantCapabilityStatusUpdatedEvent {
1491
+ export interface Data {
1492
+ /**
1493
+ * Open Enum. The capability which had its status updated.
1494
+ */
1495
+ updated_capability: Data.UpdatedCapability;
1496
+ }
1497
+
1498
+ namespace Data {
1499
+ export type UpdatedCapability =
1500
+ | 'ach_debit_payments'
1501
+ | 'acss_debit_payments'
1502
+ | 'affirm_payments'
1503
+ | 'afterpay_clearpay_payments'
1504
+ | 'alma_payments'
1505
+ | 'amazon_pay_payments'
1506
+ | 'au_becs_debit_payments'
1507
+ | 'bacs_debit_payments'
1508
+ | 'bancontact_payments'
1509
+ | 'blik_payments'
1510
+ | 'boleto_payments'
1511
+ | 'card_payments'
1512
+ | 'cartes_bancaires_payments'
1513
+ | 'cashapp_payments'
1514
+ | 'eps_payments'
1515
+ | 'fpx_payments'
1516
+ | 'gb_bank_transfer_payments'
1517
+ | 'grabpay_payments'
1518
+ | 'ideal_payments'
1519
+ | 'jcb_payments'
1520
+ | 'jp_bank_transfer_payments'
1521
+ | 'kakao_pay_payments'
1522
+ | 'klarna_payments'
1523
+ | 'konbini_payments'
1524
+ | 'kr_card_payments'
1525
+ | 'link_payments'
1526
+ | 'mobilepay_payments'
1527
+ | 'multibanco_payments'
1528
+ | 'mx_bank_transfer_payments'
1529
+ | 'naver_pay_payments'
1530
+ | 'oxxo_payments'
1531
+ | 'p24_payments'
1532
+ | 'payco_payments'
1533
+ | 'paynow_payments'
1534
+ | 'stripe_balance.payouts'
1535
+ | 'pay_by_bank_payments'
1536
+ | 'promptpay_payments'
1537
+ | 'revolut_pay_payments'
1538
+ | 'samsung_pay_payments'
1539
+ | 'sepa_bank_transfer_payments'
1540
+ | 'sepa_debit_payments'
1541
+ | 'swish_payments'
1542
+ | 'twint_payments'
1543
+ | 'us_bank_transfer_payments'
1544
+ | 'zip_payments';
1545
+ }
1546
+ }
1547
+
1548
+ /**
1549
+ * Occurs when an Account's merchant configuration is updated.
1550
+ */
1551
+ export interface V2CoreAccountIncludingConfigurationMerchantUpdatedEvent
1552
+ extends V2.EventBase {
1553
+ type: 'v2.core.account[configuration.merchant].updated';
1554
+ // Object containing the reference to API resource relevant to the event.
1555
+ related_object: Event.RelatedObject;
1556
+ // Retrieves the object associated with the event.
1557
+ fetchRelatedObject(): Promise<V2.Core.Account>;
1558
+ }
1559
+ export interface PushedV2CoreAccountIncludingConfigurationMerchantUpdatedEvent
1560
+ extends V2.EventBase {
1561
+ type: 'v2.core.account[configuration.merchant].updated';
1562
+ // Object containing the reference to API resource relevant to the event.
1563
+ related_object: Event.RelatedObject;
1564
+ // Retrieves the object associated with the event.
1565
+ fetchRelatedObject(): Promise<V2.Core.Account>;
1566
+ pull(): Promise<V2CoreAccountIncludingConfigurationMerchantUpdatedEvent>;
1567
+ }
1568
+
1569
+ /**
1570
+ * Occurs when the status of an Account's recipient configuration capability is updated.
1571
+ */
1572
+ export interface V2CoreAccountIncludingConfigurationRecipientCapabilityStatusUpdatedEvent
1573
+ extends V2.EventBase {
1574
+ type: 'v2.core.account[configuration.recipient].capability_status_updated';
1575
+ // Retrieves data specific to this event.
1576
+ data: V2CoreAccountIncludingConfigurationRecipientCapabilityStatusUpdatedEvent.Data;
1577
+ // Object containing the reference to API resource relevant to the event.
1578
+ related_object: Event.RelatedObject;
1579
+ // Retrieves the object associated with the event.
1580
+ fetchRelatedObject(): Promise<V2.Core.Account>;
1581
+ }
1582
+ export interface PushedV2CoreAccountIncludingConfigurationRecipientCapabilityStatusUpdatedEvent
1583
+ extends V2.EventBase {
1584
+ type: 'v2.core.account[configuration.recipient].capability_status_updated';
1585
+ // Object containing the reference to API resource relevant to the event.
1586
+ related_object: Event.RelatedObject;
1587
+ // Retrieves the object associated with the event.
1588
+ fetchRelatedObject(): Promise<V2.Core.Account>;
1589
+ pull(): Promise<
1590
+ V2CoreAccountIncludingConfigurationRecipientCapabilityStatusUpdatedEvent
1591
+ >;
1592
+ }
1593
+
1594
+ namespace V2CoreAccountIncludingConfigurationRecipientCapabilityStatusUpdatedEvent {
1595
+ export interface Data {
1596
+ /**
1597
+ * Open Enum. The capability which had its status updated.
1598
+ */
1599
+ updated_capability: Data.UpdatedCapability;
1600
+ }
1601
+
1602
+ namespace Data {
1603
+ export type UpdatedCapability =
1604
+ | 'bank_accounts.local'
1605
+ | 'bank_accounts.wire'
1606
+ | 'cards'
1607
+ | 'stripe_balance.payouts'
1608
+ | 'stripe_balance.stripe_transfers'
1609
+ | 'stripe.transfers';
1610
+ }
1611
+ }
1612
+
1613
+ /**
1614
+ * Occurs when a Recipient's configuration is updated.
1615
+ */
1616
+ export interface V2CoreAccountIncludingConfigurationRecipientUpdatedEvent
1617
+ extends V2.EventBase {
1618
+ type: 'v2.core.account[configuration.recipient].updated';
1619
+ // Object containing the reference to API resource relevant to the event.
1620
+ related_object: Event.RelatedObject;
1621
+ // Retrieves the object associated with the event.
1622
+ fetchRelatedObject(): Promise<V2.Core.Account>;
1623
+ }
1624
+ export interface PushedV2CoreAccountIncludingConfigurationRecipientUpdatedEvent
1625
+ extends V2.EventBase {
1626
+ type: 'v2.core.account[configuration.recipient].updated';
1627
+ // Object containing the reference to API resource relevant to the event.
1628
+ related_object: Event.RelatedObject;
1629
+ // Retrieves the object associated with the event.
1630
+ fetchRelatedObject(): Promise<V2.Core.Account>;
1631
+ pull(): Promise<V2CoreAccountIncludingConfigurationRecipientUpdatedEvent>;
1632
+ }
1633
+
1634
+ /**
1635
+ * Occurs when the status of an Account's storer configuration capability is updated.
1636
+ */
1637
+ export interface V2CoreAccountIncludingConfigurationStorerCapabilityStatusUpdatedEvent
1638
+ extends V2.EventBase {
1639
+ type: 'v2.core.account[configuration.storer].capability_status_updated';
1640
+ // Retrieves data specific to this event.
1641
+ data: V2CoreAccountIncludingConfigurationStorerCapabilityStatusUpdatedEvent.Data;
1642
+ // Object containing the reference to API resource relevant to the event.
1643
+ related_object: Event.RelatedObject;
1644
+ // Retrieves the object associated with the event.
1645
+ fetchRelatedObject(): Promise<V2.Core.Account>;
1646
+ }
1647
+ export interface PushedV2CoreAccountIncludingConfigurationStorerCapabilityStatusUpdatedEvent
1648
+ extends V2.EventBase {
1649
+ type: 'v2.core.account[configuration.storer].capability_status_updated';
1650
+ // Object containing the reference to API resource relevant to the event.
1651
+ related_object: Event.RelatedObject;
1652
+ // Retrieves the object associated with the event.
1653
+ fetchRelatedObject(): Promise<V2.Core.Account>;
1654
+ pull(): Promise<
1655
+ V2CoreAccountIncludingConfigurationStorerCapabilityStatusUpdatedEvent
1656
+ >;
1657
+ }
1658
+
1659
+ namespace V2CoreAccountIncludingConfigurationStorerCapabilityStatusUpdatedEvent {
1660
+ export interface Data {
1661
+ /**
1662
+ * Open Enum. The capability which had its status updated.
1663
+ */
1664
+ updated_capability: Data.UpdatedCapability;
1665
+ }
1666
+
1667
+ namespace Data {
1668
+ export type UpdatedCapability =
1669
+ | 'financial_addressses.bank_accounts'
1670
+ | 'holds_currencies.eur'
1671
+ | 'holds_currencies.gbp'
1672
+ | 'holds_currencies.usd'
1673
+ | 'inbound_transfers.bank_accounts'
1674
+ | 'outbound_payments.bank_accounts'
1675
+ | 'outbound_payments.cards'
1676
+ | 'outbound_payments.financial_accounts'
1677
+ | 'outbound_transfers.bank_accounts'
1678
+ | 'outbound_transfers.financial_accounts';
1679
+ }
1680
+ }
1681
+
1682
+ /**
1683
+ * Occurs when a Storer's configuration is updated.
1684
+ */
1685
+ export interface V2CoreAccountIncludingConfigurationStorerUpdatedEvent
1686
+ extends V2.EventBase {
1687
+ type: 'v2.core.account[configuration.storer].updated';
1688
+ // Object containing the reference to API resource relevant to the event.
1689
+ related_object: Event.RelatedObject;
1690
+ // Retrieves the object associated with the event.
1691
+ fetchRelatedObject(): Promise<V2.Core.Account>;
1692
+ }
1693
+ export interface PushedV2CoreAccountIncludingConfigurationStorerUpdatedEvent
1694
+ extends V2.EventBase {
1695
+ type: 'v2.core.account[configuration.storer].updated';
1696
+ // Object containing the reference to API resource relevant to the event.
1697
+ related_object: Event.RelatedObject;
1698
+ // Retrieves the object associated with the event.
1699
+ fetchRelatedObject(): Promise<V2.Core.Account>;
1700
+ pull(): Promise<V2CoreAccountIncludingConfigurationStorerUpdatedEvent>;
1701
+ }
1702
+
1703
+ /**
1704
+ * This event occurs when account defaults are created or updated.
1705
+ */
1706
+ export interface V2CoreAccountIncludingDefaultsUpdatedEvent
1707
+ extends V2.EventBase {
1708
+ type: 'v2.core.account[defaults].updated';
1709
+ // Object containing the reference to API resource relevant to the event.
1710
+ related_object: Event.RelatedObject;
1711
+ // Retrieves the object associated with the event.
1712
+ fetchRelatedObject(): Promise<V2.Core.Account>;
1713
+ }
1714
+ export interface PushedV2CoreAccountIncludingDefaultsUpdatedEvent
1715
+ extends V2.EventBase {
1716
+ type: 'v2.core.account[defaults].updated';
1717
+ // Object containing the reference to API resource relevant to the event.
1718
+ related_object: Event.RelatedObject;
1719
+ // Retrieves the object associated with the event.
1720
+ fetchRelatedObject(): Promise<V2.Core.Account>;
1721
+ pull(): Promise<V2CoreAccountIncludingDefaultsUpdatedEvent>;
1722
+ }
1723
+
1724
+ /**
1725
+ * Occurs when an Identity is updated.
1726
+ */
1727
+ export interface V2CoreAccountIncludingIdentityUpdatedEvent
1728
+ extends V2.EventBase {
1729
+ type: 'v2.core.account[identity].updated';
1730
+ // Object containing the reference to API resource relevant to the event.
1731
+ related_object: Event.RelatedObject;
1732
+ // Retrieves the object associated with the event.
1733
+ fetchRelatedObject(): Promise<V2.Core.Account>;
1734
+ }
1735
+ export interface PushedV2CoreAccountIncludingIdentityUpdatedEvent
1736
+ extends V2.EventBase {
1737
+ type: 'v2.core.account[identity].updated';
1738
+ // Object containing the reference to API resource relevant to the event.
1739
+ related_object: Event.RelatedObject;
1740
+ // Retrieves the object associated with the event.
1741
+ fetchRelatedObject(): Promise<V2.Core.Account>;
1742
+ pull(): Promise<V2CoreAccountIncludingIdentityUpdatedEvent>;
1743
+ }
1744
+
1745
+ /**
1746
+ * Occurs when an Account's requirements are updated.
1747
+ */
1748
+ export interface V2CoreAccountIncludingRequirementsUpdatedEvent
1749
+ extends V2.EventBase {
1750
+ type: 'v2.core.account[requirements].updated';
1751
+ // Object containing the reference to API resource relevant to the event.
1752
+ related_object: Event.RelatedObject;
1753
+ // Retrieves the object associated with the event.
1754
+ fetchRelatedObject(): Promise<V2.Core.Account>;
1755
+ }
1756
+ export interface PushedV2CoreAccountIncludingRequirementsUpdatedEvent
1757
+ extends V2.EventBase {
1758
+ type: 'v2.core.account[requirements].updated';
1759
+ // Object containing the reference to API resource relevant to the event.
1760
+ related_object: Event.RelatedObject;
1761
+ // Retrieves the object associated with the event.
1762
+ fetchRelatedObject(): Promise<V2.Core.Account>;
1763
+ pull(): Promise<V2CoreAccountIncludingRequirementsUpdatedEvent>;
1764
+ }
1765
+
1766
+ /**
1767
+ * Occurs when the generated AccountLink is completed.
1768
+ */
1769
+ export interface V2CoreAccountLinkReturnedEvent extends V2.EventBase {
1770
+ type: 'v2.core.account_link.returned';
1771
+ // Retrieves data specific to this event.
1772
+ data: V2CoreAccountLinkReturnedEvent.Data;
1773
+ }
1774
+ export interface PushedV2CoreAccountLinkReturnedEvent extends V2.EventBase {
1775
+ type: 'v2.core.account_link.returned';
1776
+ pull(): Promise<V2CoreAccountLinkReturnedEvent>;
1777
+ }
1778
+
1779
+ namespace V2CoreAccountLinkReturnedEvent {
1780
+ export interface Data {
1781
+ /**
1782
+ * The ID of the v2 account.
1783
+ */
1784
+ account_id: string;
1785
+
1786
+ /**
1787
+ * Configurations on the Account that was onboarded via the account link.
1788
+ */
1789
+ configurations: Array<Data.Configuration>;
1790
+
1791
+ /**
1792
+ * Open Enum. The use case type of the account link that has been completed.
1793
+ */
1794
+ use_case: Data.UseCase;
1795
+ }
1796
+
1797
+ namespace Data {
1798
+ export type Configuration =
1799
+ | 'customer'
1800
+ | 'merchant'
1801
+ | 'recipient'
1802
+ | 'storer';
1803
+
1804
+ export type UseCase = 'account_onboarding' | 'account_update';
1805
+ }
1806
+ }
1807
+
1808
+ /**
1809
+ * Occurs when a Person is created.
1810
+ */
1811
+ export interface V2CoreAccountPersonCreatedEvent extends V2.EventBase {
1812
+ type: 'v2.core.account_person.created';
1813
+ // Retrieves data specific to this event.
1814
+ data: V2CoreAccountPersonCreatedEvent.Data;
1815
+ // Object containing the reference to API resource relevant to the event.
1816
+ related_object: Event.RelatedObject;
1817
+ // Retrieves the object associated with the event.
1818
+ fetchRelatedObject(): Promise<V2.Core.Person>;
1819
+ }
1820
+ export interface PushedV2CoreAccountPersonCreatedEvent
1821
+ extends V2.EventBase {
1822
+ type: 'v2.core.account_person.created';
1823
+ // Object containing the reference to API resource relevant to the event.
1824
+ related_object: Event.RelatedObject;
1825
+ // Retrieves the object associated with the event.
1826
+ fetchRelatedObject(): Promise<V2.Core.Person>;
1827
+ pull(): Promise<V2CoreAccountPersonCreatedEvent>;
1828
+ }
1829
+
1830
+ namespace V2CoreAccountPersonCreatedEvent {
1831
+ export interface Data {
1832
+ /**
1833
+ * The ID of the v2 account.
1834
+ */
1835
+ account_id: string;
1836
+ }
1837
+ }
1838
+
1839
+ /**
1840
+ * Occurs when a Person is deleted.
1841
+ */
1842
+ export interface V2CoreAccountPersonDeletedEvent extends V2.EventBase {
1843
+ type: 'v2.core.account_person.deleted';
1844
+ // Retrieves data specific to this event.
1845
+ data: V2CoreAccountPersonDeletedEvent.Data;
1846
+ // Object containing the reference to API resource relevant to the event.
1847
+ related_object: Event.RelatedObject;
1848
+ // Retrieves the object associated with the event.
1849
+ fetchRelatedObject(): Promise<V2.Core.Person>;
1850
+ }
1851
+ export interface PushedV2CoreAccountPersonDeletedEvent
1852
+ extends V2.EventBase {
1853
+ type: 'v2.core.account_person.deleted';
1854
+ // Object containing the reference to API resource relevant to the event.
1855
+ related_object: Event.RelatedObject;
1856
+ // Retrieves the object associated with the event.
1857
+ fetchRelatedObject(): Promise<V2.Core.Person>;
1858
+ pull(): Promise<V2CoreAccountPersonDeletedEvent>;
1859
+ }
1860
+
1861
+ namespace V2CoreAccountPersonDeletedEvent {
1862
+ export interface Data {
1863
+ /**
1864
+ * The ID of the v2 account.
1865
+ */
1866
+ account_id: string;
1867
+ }
1868
+ }
1869
+
1870
+ /**
1871
+ * Occurs when a Person is updated.
1872
+ */
1873
+ export interface V2CoreAccountPersonUpdatedEvent extends V2.EventBase {
1874
+ type: 'v2.core.account_person.updated';
1875
+ // Retrieves data specific to this event.
1876
+ data: V2CoreAccountPersonUpdatedEvent.Data;
1877
+ // Object containing the reference to API resource relevant to the event.
1878
+ related_object: Event.RelatedObject;
1879
+ // Retrieves the object associated with the event.
1880
+ fetchRelatedObject(): Promise<V2.Core.Person>;
1881
+ }
1882
+ export interface PushedV2CoreAccountPersonUpdatedEvent
1883
+ extends V2.EventBase {
1884
+ type: 'v2.core.account_person.updated';
1885
+ // Object containing the reference to API resource relevant to the event.
1886
+ related_object: Event.RelatedObject;
1887
+ // Retrieves the object associated with the event.
1888
+ fetchRelatedObject(): Promise<V2.Core.Person>;
1889
+ pull(): Promise<V2CoreAccountPersonUpdatedEvent>;
1890
+ }
1891
+
1892
+ namespace V2CoreAccountPersonUpdatedEvent {
1893
+ export interface Data {
1894
+ /**
1895
+ * The ID of the v2 account.
1896
+ */
1897
+ account_id: string;
1898
+ }
1899
+ }
1900
+
1901
+ /**
1902
+ * A ping event used to test the connection to an EventDestination.
1903
+ */
1904
+ export interface V2CoreEventDestinationPingEvent extends V2.EventBase {
1905
+ type: 'v2.core.event_destination.ping';
1906
+ // Object containing the reference to API resource relevant to the event.
1907
+ related_object: Event.RelatedObject;
1908
+ // Retrieves the object associated with the event.
1909
+ fetchRelatedObject(): Promise<V2.EventDestination>;
1910
+ }
1911
+ export interface PushedV2CoreEventDestinationPingEvent
1912
+ extends V2.EventBase {
1913
+ type: 'v2.core.event_destination.ping';
1914
+ // Object containing the reference to API resource relevant to the event.
1915
+ related_object: Event.RelatedObject;
1916
+ // Retrieves the object associated with the event.
1917
+ fetchRelatedObject(): Promise<V2.EventDestination>;
1918
+ pull(): Promise<V2CoreEventDestinationPingEvent>;
1919
+ }
1920
+
1921
+ /**
1922
+ * Occurs when an API error alert is firing.
1923
+ */
1924
+ export interface V2CoreHealthApiErrorFiringEvent extends V2.EventBase {
1925
+ type: 'v2.core.health.api_error.firing';
1926
+ // Retrieves data specific to this event.
1927
+ data: V2CoreHealthApiErrorFiringEvent.Data;
1928
+ }
1929
+ export interface PushedV2CoreHealthApiErrorFiringEvent
1930
+ extends V2.EventBase {
1931
+ type: 'v2.core.health.api_error.firing';
1932
+ pull(): Promise<V2CoreHealthApiErrorFiringEvent>;
1933
+ }
1934
+
1935
+ namespace V2CoreHealthApiErrorFiringEvent {
1936
+ export interface Data {
1937
+ /**
1938
+ * The alert ID.
1939
+ */
1940
+ alert_id: string;
1941
+
1942
+ /**
1943
+ * The grouping key for the alert.
1944
+ */
1945
+ grouping_key: string;
1946
+
1947
+ /**
1948
+ * The user impact.
1949
+ */
1950
+ impact: Data.Impact;
1951
+
1952
+ /**
1953
+ * The time when impact on the user experience was first detected.
1954
+ */
1955
+ started_at: string;
1956
+
1957
+ /**
1958
+ * A short description of the alert.
1959
+ */
1960
+ summary: string;
1961
+ }
1962
+
1963
+ namespace Data {
1964
+ export interface Impact {
1965
+ /**
1966
+ * The canonical path.
1967
+ */
1968
+ canonical_path: string;
1969
+
1970
+ /**
1971
+ * The error code.
1972
+ */
1973
+ error_code: string | null;
1974
+
1975
+ /**
1976
+ * The HTTP method.
1977
+ */
1978
+ http_method: Impact.HttpMethod;
1979
+
1980
+ /**
1981
+ * The HTTP status.
1982
+ */
1983
+ http_status: string;
1984
+
1985
+ /**
1986
+ * The number of impacted requests.
1987
+ */
1988
+ impacted_requests: number;
1989
+ }
1990
+
1991
+ namespace Impact {
1992
+ export type HttpMethod = 'DELETE' | 'GET' | 'POST' | 'PUT';
1993
+ }
1994
+ }
1995
+ }
1996
+
1997
+ /**
1998
+ * Occurs when an API error alert is resolved.
1999
+ */
2000
+ export interface V2CoreHealthApiErrorResolvedEvent extends V2.EventBase {
2001
+ type: 'v2.core.health.api_error.resolved';
2002
+ // Retrieves data specific to this event.
2003
+ data: V2CoreHealthApiErrorResolvedEvent.Data;
2004
+ }
2005
+ export interface PushedV2CoreHealthApiErrorResolvedEvent
2006
+ extends V2.EventBase {
2007
+ type: 'v2.core.health.api_error.resolved';
2008
+ pull(): Promise<V2CoreHealthApiErrorResolvedEvent>;
2009
+ }
2010
+
2011
+ namespace V2CoreHealthApiErrorResolvedEvent {
2012
+ export interface Data {
2013
+ /**
2014
+ * The alert ID.
2015
+ */
2016
+ alert_id: string;
2017
+
2018
+ /**
2019
+ * The grouping key for the alert.
2020
+ */
2021
+ grouping_key: string;
2022
+
2023
+ /**
2024
+ * The user impact.
2025
+ */
2026
+ impact: Data.Impact;
2027
+
2028
+ /**
2029
+ * The time when the user experience has returned to expected levels.
2030
+ */
2031
+ resolved_at: string;
2032
+
2033
+ /**
2034
+ * The time when impact on the user experience was first detected.
2035
+ */
2036
+ started_at: string;
2037
+
2038
+ /**
2039
+ * A short description of the alert.
2040
+ */
2041
+ summary: string;
2042
+ }
2043
+
2044
+ namespace Data {
2045
+ export interface Impact {
2046
+ /**
2047
+ * The canonical path.
2048
+ */
2049
+ canonical_path: string;
2050
+
2051
+ /**
2052
+ * The error code.
2053
+ */
2054
+ error_code: string | null;
2055
+
2056
+ /**
2057
+ * The HTTP method.
2058
+ */
2059
+ http_method: Impact.HttpMethod;
2060
+
2061
+ /**
2062
+ * The HTTP status.
2063
+ */
2064
+ http_status: string;
2065
+
2066
+ /**
2067
+ * The number of impacted requests.
2068
+ */
2069
+ impacted_requests: number;
2070
+ }
2071
+
2072
+ namespace Impact {
2073
+ export type HttpMethod = 'DELETE' | 'GET' | 'POST' | 'PUT';
2074
+ }
2075
+ }
2076
+ }
2077
+
2078
+ /**
2079
+ * Occurs when an API latency alert is firing.
2080
+ */
2081
+ export interface V2CoreHealthApiLatencyFiringEvent extends V2.EventBase {
2082
+ type: 'v2.core.health.api_latency.firing';
2083
+ // Retrieves data specific to this event.
2084
+ data: V2CoreHealthApiLatencyFiringEvent.Data;
2085
+ }
2086
+ export interface PushedV2CoreHealthApiLatencyFiringEvent
2087
+ extends V2.EventBase {
2088
+ type: 'v2.core.health.api_latency.firing';
2089
+ pull(): Promise<V2CoreHealthApiLatencyFiringEvent>;
2090
+ }
2091
+
2092
+ namespace V2CoreHealthApiLatencyFiringEvent {
2093
+ export interface Data {
2094
+ /**
2095
+ * The alert ID.
2096
+ */
2097
+ alert_id: string;
2098
+
2099
+ /**
2100
+ * The grouping key for the alert.
2101
+ */
2102
+ grouping_key: string;
2103
+
2104
+ /**
2105
+ * The user impact.
2106
+ */
2107
+ impact: Data.Impact;
2108
+
2109
+ /**
2110
+ * The time when impact on the user experience was first detected.
2111
+ */
2112
+ started_at: string;
2113
+
2114
+ /**
2115
+ * A short description of the alert.
2116
+ */
2117
+ summary: string;
2118
+ }
2119
+
2120
+ namespace Data {
2121
+ export interface Impact {
2122
+ /**
2123
+ * The canonical path.
2124
+ */
2125
+ canonical_path: string;
2126
+
2127
+ /**
2128
+ * The HTTP method.
2129
+ */
2130
+ http_method: Impact.HttpMethod;
2131
+
2132
+ /**
2133
+ * The HTTP status.
2134
+ */
2135
+ http_status: string;
2136
+
2137
+ /**
2138
+ * The number of impacted requests.
2139
+ */
2140
+ impacted_requests: number;
2141
+ }
2142
+
2143
+ namespace Impact {
2144
+ export type HttpMethod = 'DELETE' | 'GET' | 'POST' | 'PUT';
2145
+ }
2146
+ }
2147
+ }
2148
+
2149
+ /**
2150
+ * Occurs when an API latency alert is resolved.
2151
+ */
2152
+ export interface V2CoreHealthApiLatencyResolvedEvent extends V2.EventBase {
2153
+ type: 'v2.core.health.api_latency.resolved';
2154
+ // Retrieves data specific to this event.
2155
+ data: V2CoreHealthApiLatencyResolvedEvent.Data;
2156
+ }
2157
+ export interface PushedV2CoreHealthApiLatencyResolvedEvent
2158
+ extends V2.EventBase {
2159
+ type: 'v2.core.health.api_latency.resolved';
2160
+ pull(): Promise<V2CoreHealthApiLatencyResolvedEvent>;
2161
+ }
2162
+
2163
+ namespace V2CoreHealthApiLatencyResolvedEvent {
2164
+ export interface Data {
2165
+ /**
2166
+ * The alert ID.
2167
+ */
2168
+ alert_id: string;
2169
+
2170
+ /**
2171
+ * The grouping key for the alert.
2172
+ */
2173
+ grouping_key: string;
2174
+
2175
+ /**
2176
+ * The user impact.
2177
+ */
2178
+ impact: Data.Impact;
2179
+
2180
+ /**
2181
+ * The time when the user experience has returned to expected levels.
2182
+ */
2183
+ resolved_at: string;
2184
+
2185
+ /**
2186
+ * The time when impact on the user experience was first detected.
2187
+ */
2188
+ started_at: string;
2189
+
2190
+ /**
2191
+ * A short description of the alert.
2192
+ */
2193
+ summary: string;
2194
+ }
2195
+
2196
+ namespace Data {
2197
+ export interface Impact {
2198
+ /**
2199
+ * The canonical path.
2200
+ */
2201
+ canonical_path: string;
2202
+
2203
+ /**
2204
+ * The HTTP method.
2205
+ */
2206
+ http_method: Impact.HttpMethod;
2207
+
2208
+ /**
2209
+ * The HTTP status.
2210
+ */
2211
+ http_status: string;
2212
+
2213
+ /**
2214
+ * The number of impacted requests.
2215
+ */
2216
+ impacted_requests: number;
2217
+ }
2218
+
2219
+ namespace Impact {
2220
+ export type HttpMethod = 'DELETE' | 'GET' | 'POST' | 'PUT';
2221
+ }
2222
+ }
2223
+ }
2224
+
2225
+ /**
2226
+ * Occurs when an authorization rate drop alert is firing.
2227
+ */
2228
+ export interface V2CoreHealthAuthorizationRateDropFiringEvent
2229
+ extends V2.EventBase {
2230
+ type: 'v2.core.health.authorization_rate_drop.firing';
2231
+ // Retrieves data specific to this event.
2232
+ data: V2CoreHealthAuthorizationRateDropFiringEvent.Data;
2233
+ }
2234
+ export interface PushedV2CoreHealthAuthorizationRateDropFiringEvent
2235
+ extends V2.EventBase {
2236
+ type: 'v2.core.health.authorization_rate_drop.firing';
2237
+ pull(): Promise<V2CoreHealthAuthorizationRateDropFiringEvent>;
2238
+ }
2239
+
2240
+ namespace V2CoreHealthAuthorizationRateDropFiringEvent {
2241
+ export interface Data {
2242
+ /**
2243
+ * The alert ID.
2244
+ */
2245
+ alert_id: string;
2246
+
2247
+ /**
2248
+ * The grouping key for the alert.
2249
+ */
2250
+ grouping_key: string;
2251
+
2252
+ /**
2253
+ * The user impact.
2254
+ */
2255
+ impact: Data.Impact;
2256
+
2257
+ /**
2258
+ * The time when impact on the user experience was first detected.
2259
+ */
2260
+ started_at: string;
2261
+
2262
+ /**
2263
+ * A short description of the alert.
2264
+ */
2265
+ summary: string;
2266
+ }
2267
+
2268
+ namespace Data {
2269
+ export interface Impact {
2270
+ /**
2271
+ * The type of the charge.
2272
+ */
2273
+ charge_type: Impact.ChargeType;
2274
+
2275
+ /**
2276
+ * The current authorization rate percentage.
2277
+ */
2278
+ current_percentage: string;
2279
+
2280
+ /**
2281
+ * Dimensions that describe what subset of payments are impacted.
2282
+ */
2283
+ dimensions: Array<Impact.Dimension> | null;
2284
+
2285
+ /**
2286
+ * The type of the payment method.
2287
+ */
2288
+ payment_method_type: Impact.PaymentMethodType;
2289
+
2290
+ /**
2291
+ * The previous authorization rate percentage.
2292
+ */
2293
+ previous_percentage: string;
2294
+ }
2295
+
2296
+ namespace Impact {
2297
+ export type ChargeType = 'money_moving' | 'validation';
2298
+
2299
+ export interface Dimension {
2300
+ /**
2301
+ * The issuer dimension.
2302
+ */
2303
+ issuer: string | null;
2304
+
2305
+ /**
2306
+ * The type of the dimension.
2307
+ */
2308
+ type: 'issuer';
2309
+ }
2310
+
2311
+ export type PaymentMethodType =
2312
+ | 'acss_debit'
2313
+ | 'affirm'
2314
+ | 'afterpay_clearpay'
2315
+ | 'alipay'
2316
+ | 'alma'
2317
+ | 'amazon_pay'
2318
+ | 'apple_pay'
2319
+ | 'au_becs_debit'
2320
+ | 'bacs_debit'
2321
+ | 'bancontact'
2322
+ | 'blik'
2323
+ | 'boleto'
2324
+ | 'card'
2325
+ | 'card_present'
2326
+ | 'cartes_bancaires'
2327
+ | 'cashapp'
2328
+ | 'dummy_passthrough_card'
2329
+ | 'eps'
2330
+ | 'fpx'
2331
+ | 'giropay'
2332
+ | 'grabpay'
2333
+ | 'ideal'
2334
+ | 'interac_present'
2335
+ | 'kakao_pay'
2336
+ | 'klarna'
2337
+ | 'konbini'
2338
+ | 'link'
2339
+ | 'mobilepay'
2340
+ | 'multibanco'
2341
+ | 'naver_pay'
2342
+ | 'oxxo'
2343
+ | 'p24'
2344
+ | 'paper_check'
2345
+ | 'paynow'
2346
+ | 'paypal'
2347
+ | 'payto'
2348
+ | 'pay_by_bank'
2349
+ | 'pix'
2350
+ | 'promptpay'
2351
+ | 'revolut_pay'
2352
+ | 'sepa_debit'
2353
+ | 'sofort'
2354
+ | 'swish'
2355
+ | 'twint'
2356
+ | 'upi'
2357
+ | 'wechat_pay'
2358
+ | 'zip';
2359
+ }
2360
+ }
2361
+ }
2362
+
2363
+ /**
2364
+ * Occurs when an authorization rate drop alert is resolved.
2365
+ */
2366
+ export interface V2CoreHealthAuthorizationRateDropResolvedEvent
2367
+ extends V2.EventBase {
2368
+ type: 'v2.core.health.authorization_rate_drop.resolved';
2369
+ // Retrieves data specific to this event.
2370
+ data: V2CoreHealthAuthorizationRateDropResolvedEvent.Data;
2371
+ }
2372
+ export interface PushedV2CoreHealthAuthorizationRateDropResolvedEvent
2373
+ extends V2.EventBase {
2374
+ type: 'v2.core.health.authorization_rate_drop.resolved';
2375
+ pull(): Promise<V2CoreHealthAuthorizationRateDropResolvedEvent>;
2376
+ }
2377
+
2378
+ namespace V2CoreHealthAuthorizationRateDropResolvedEvent {
2379
+ export interface Data {
2380
+ /**
2381
+ * The alert ID.
2382
+ */
2383
+ alert_id: string;
2384
+
2385
+ /**
2386
+ * The grouping key for the alert.
2387
+ */
2388
+ grouping_key: string;
2389
+
2390
+ /**
2391
+ * The user impact.
2392
+ */
2393
+ impact: Data.Impact;
2394
+
2395
+ /**
2396
+ * The time when the user experience has returned to expected levels.
2397
+ */
2398
+ resolved_at: string;
2399
+
2400
+ /**
2401
+ * The time when impact on the user experience was first detected.
2402
+ */
2403
+ started_at: string;
2404
+
2405
+ /**
2406
+ * A short description of the alert.
2407
+ */
2408
+ summary: string;
2409
+ }
2410
+
2411
+ namespace Data {
2412
+ export interface Impact {
2413
+ /**
2414
+ * The type of the charge.
2415
+ */
2416
+ charge_type: Impact.ChargeType;
2417
+
2418
+ /**
2419
+ * The current authorization rate percentage.
2420
+ */
2421
+ current_percentage: string;
2422
+
2423
+ /**
2424
+ * Dimensions that describe what subset of payments are impacted.
2425
+ */
2426
+ dimensions: Array<Impact.Dimension> | null;
2427
+
2428
+ /**
2429
+ * The type of the payment method.
2430
+ */
2431
+ payment_method_type: Impact.PaymentMethodType;
2432
+
2433
+ /**
2434
+ * The previous authorization rate percentage.
2435
+ */
2436
+ previous_percentage: string;
2437
+ }
2438
+
2439
+ namespace Impact {
2440
+ export type ChargeType = 'money_moving' | 'validation';
2441
+
2442
+ export interface Dimension {
2443
+ /**
2444
+ * The issuer dimension.
2445
+ */
2446
+ issuer: string | null;
2447
+
2448
+ /**
2449
+ * The type of the dimension.
2450
+ */
2451
+ type: 'issuer';
2452
+ }
2453
+
2454
+ export type PaymentMethodType =
2455
+ | 'acss_debit'
2456
+ | 'affirm'
2457
+ | 'afterpay_clearpay'
2458
+ | 'alipay'
2459
+ | 'alma'
2460
+ | 'amazon_pay'
2461
+ | 'apple_pay'
2462
+ | 'au_becs_debit'
2463
+ | 'bacs_debit'
2464
+ | 'bancontact'
2465
+ | 'blik'
2466
+ | 'boleto'
2467
+ | 'card'
2468
+ | 'card_present'
2469
+ | 'cartes_bancaires'
2470
+ | 'cashapp'
2471
+ | 'dummy_passthrough_card'
2472
+ | 'eps'
2473
+ | 'fpx'
2474
+ | 'giropay'
2475
+ | 'grabpay'
2476
+ | 'ideal'
2477
+ | 'interac_present'
2478
+ | 'kakao_pay'
2479
+ | 'klarna'
2480
+ | 'konbini'
2481
+ | 'link'
2482
+ | 'mobilepay'
2483
+ | 'multibanco'
2484
+ | 'naver_pay'
2485
+ | 'oxxo'
2486
+ | 'p24'
2487
+ | 'paper_check'
2488
+ | 'paynow'
2489
+ | 'paypal'
2490
+ | 'payto'
2491
+ | 'pay_by_bank'
2492
+ | 'pix'
2493
+ | 'promptpay'
2494
+ | 'revolut_pay'
2495
+ | 'sepa_debit'
2496
+ | 'sofort'
2497
+ | 'swish'
2498
+ | 'twint'
2499
+ | 'upi'
2500
+ | 'wechat_pay'
2501
+ | 'zip';
2502
+ }
2503
+ }
2504
+ }
2505
+
2506
+ /**
2507
+ * Occurs when an event generation failure alert is resolved.
2508
+ */
2509
+ export interface V2CoreHealthEventGenerationFailureResolvedEvent
2510
+ extends V2.EventBase {
2511
+ type: 'v2.core.health.event_generation_failure.resolved';
2512
+ // Retrieves data specific to this event.
2513
+ data: V2CoreHealthEventGenerationFailureResolvedEvent.Data;
2514
+ }
2515
+ export interface PushedV2CoreHealthEventGenerationFailureResolvedEvent
2516
+ extends V2.EventBase {
2517
+ type: 'v2.core.health.event_generation_failure.resolved';
2518
+ pull(): Promise<V2CoreHealthEventGenerationFailureResolvedEvent>;
2519
+ }
2520
+
2521
+ namespace V2CoreHealthEventGenerationFailureResolvedEvent {
2522
+ export interface Data {
2523
+ /**
2524
+ * The alert ID.
2525
+ */
2526
+ alert_id: string;
2527
+
2528
+ /**
2529
+ * The grouping key for the alert.
2530
+ */
2531
+ grouping_key: string;
2532
+
2533
+ /**
2534
+ * The user impact.
2535
+ */
2536
+ impact: Data.Impact;
2537
+
2538
+ /**
2539
+ * The time when the user experience has returned to expected levels.
2540
+ */
2541
+ resolved_at: string;
2542
+
2543
+ /**
2544
+ * A short description of the alert.
2545
+ */
2546
+ summary: string;
2547
+ }
2548
+
2549
+ namespace Data {
2550
+ export interface Impact {
2551
+ /**
2552
+ * The account id the event should have been generated for. Only present when the account is a connected account.
2553
+ */
2554
+ account: string | null;
2555
+
2556
+ /**
2557
+ * The type of event that Stripe failed to generate.
2558
+ */
2559
+ event_type: string;
2560
+
2561
+ /**
2562
+ * Indicates if the event was for livemode or not.
2563
+ */
2564
+ livemode: boolean;
2565
+
2566
+ /**
2567
+ * The number of webhooks that Stripe failed to create and deliver.
2568
+ */
2569
+ missing_delivery_attempts: number;
2570
+
2571
+ /**
2572
+ * The related object id.
2573
+ */
2574
+ related_object_id: string;
2575
+ }
2576
+ }
2577
+ }
2578
+
2579
+ /**
2580
+ * Occurs when the fraud rate has increased.
2581
+ */
2582
+ export interface V2CoreHealthFraudRateIncreasedEvent extends V2.EventBase {
2583
+ type: 'v2.core.health.fraud_rate.increased';
2584
+ // Retrieves data specific to this event.
2585
+ data: V2CoreHealthFraudRateIncreasedEvent.Data;
2586
+ }
2587
+ export interface PushedV2CoreHealthFraudRateIncreasedEvent
2588
+ extends V2.EventBase {
2589
+ type: 'v2.core.health.fraud_rate.increased';
2590
+ pull(): Promise<V2CoreHealthFraudRateIncreasedEvent>;
2591
+ }
2592
+
2593
+ namespace V2CoreHealthFraudRateIncreasedEvent {
2594
+ export interface Data {
2595
+ /**
2596
+ * The alert ID.
2597
+ */
2598
+ alert_id: string;
2599
+
2600
+ /**
2601
+ * The grouping key for the alert.
2602
+ */
2603
+ grouping_key: string;
2604
+
2605
+ /**
2606
+ * The user impact.
2607
+ */
2608
+ impact: Data.Impact;
2609
+
2610
+ /**
2611
+ * The time when the user experience has returned to expected levels.
2612
+ */
2613
+ resolved_at: string | null;
2614
+
2615
+ /**
2616
+ * The time when impact on the user experience was first detected.
2617
+ */
2618
+ started_at: string;
2619
+
2620
+ /**
2621
+ * A short description of the alert.
2622
+ */
2623
+ summary: string;
2624
+ }
2625
+
2626
+ namespace Data {
2627
+ export interface Impact {
2628
+ /**
2629
+ * Fraud attack type.
2630
+ */
2631
+ attack_type: Impact.AttackType;
2632
+
2633
+ /**
2634
+ * The number of impacted requests which are detected.
2635
+ */
2636
+ impacted_requests: number;
2637
+
2638
+ /**
2639
+ * Estimated aggregated amount for the impacted requests.
2640
+ */
2641
+ realized_fraud_amount: V2.Amount;
2642
+ }
2643
+
2644
+ namespace Impact {
2645
+ export type AttackType = 'spike' | 'sustained_attack';
2646
+ }
2647
+ }
2648
+ }
2649
+
2650
+ /**
2651
+ * Occurs when an issuing authorization request timeout alert is firing.
2652
+ */
2653
+ export interface V2CoreHealthIssuingAuthorizationRequestTimeoutFiringEvent
2654
+ extends V2.EventBase {
2655
+ type: 'v2.core.health.issuing_authorization_request_timeout.firing';
2656
+ // Retrieves data specific to this event.
2657
+ data: V2CoreHealthIssuingAuthorizationRequestTimeoutFiringEvent.Data;
2658
+ }
2659
+ export interface PushedV2CoreHealthIssuingAuthorizationRequestTimeoutFiringEvent
2660
+ extends V2.EventBase {
2661
+ type: 'v2.core.health.issuing_authorization_request_timeout.firing';
2662
+ pull(): Promise<
2663
+ V2CoreHealthIssuingAuthorizationRequestTimeoutFiringEvent
2664
+ >;
2665
+ }
2666
+
2667
+ namespace V2CoreHealthIssuingAuthorizationRequestTimeoutFiringEvent {
2668
+ export interface Data {
2669
+ /**
2670
+ * The alert ID.
2671
+ */
2672
+ alert_id: string;
2673
+
2674
+ /**
2675
+ * The grouping key for the alert.
2676
+ */
2677
+ grouping_key: string;
2678
+
2679
+ /**
2680
+ * The user impact.
2681
+ */
2682
+ impact: Data.Impact;
2683
+
2684
+ /**
2685
+ * The time when impact on the user experience was first detected.
2686
+ */
2687
+ started_at: string;
2688
+
2689
+ /**
2690
+ * A short description of the alert.
2691
+ */
2692
+ summary: string;
2693
+ }
2694
+
2695
+ namespace Data {
2696
+ export interface Impact {
2697
+ /**
2698
+ * Estimated aggregated amount for the approved requests.
2699
+ */
2700
+ approved_amount: V2.Amount | null;
2701
+
2702
+ /**
2703
+ * The number of approved requests which are impacted.
2704
+ */
2705
+ approved_impacted_requests: number | null;
2706
+
2707
+ /**
2708
+ * Estimated aggregated amount for the declined requests.
2709
+ */
2710
+ declined_amount: V2.Amount | null;
2711
+
2712
+ /**
2713
+ * The number of declined requests which are impacted.
2714
+ */
2715
+ declined_impacted_requests: number | null;
2716
+ }
2717
+ }
2718
+ }
2719
+
2720
+ /**
2721
+ * Occurs when an issuing authorization request timeout alert is resolved.
2722
+ */
2723
+ export interface V2CoreHealthIssuingAuthorizationRequestTimeoutResolvedEvent
2724
+ extends V2.EventBase {
2725
+ type: 'v2.core.health.issuing_authorization_request_timeout.resolved';
2726
+ // Retrieves data specific to this event.
2727
+ data: V2CoreHealthIssuingAuthorizationRequestTimeoutResolvedEvent.Data;
2728
+ }
2729
+ export interface PushedV2CoreHealthIssuingAuthorizationRequestTimeoutResolvedEvent
2730
+ extends V2.EventBase {
2731
+ type: 'v2.core.health.issuing_authorization_request_timeout.resolved';
2732
+ pull(): Promise<
2733
+ V2CoreHealthIssuingAuthorizationRequestTimeoutResolvedEvent
2734
+ >;
2735
+ }
2736
+
2737
+ namespace V2CoreHealthIssuingAuthorizationRequestTimeoutResolvedEvent {
2738
+ export interface Data {
2739
+ /**
2740
+ * The alert ID.
2741
+ */
2742
+ alert_id: string;
2743
+
2744
+ /**
2745
+ * The grouping key for the alert.
2746
+ */
2747
+ grouping_key: string;
2748
+
2749
+ /**
2750
+ * The user impact.
2751
+ */
2752
+ impact: Data.Impact;
2753
+
2754
+ /**
2755
+ * The time when the user experience has returned to expected levels.
2756
+ */
2757
+ resolved_at: string;
2758
+
2759
+ /**
2760
+ * The time when impact on the user experience was first detected.
2761
+ */
2762
+ started_at: string;
2763
+
2764
+ /**
2765
+ * A short description of the alert.
2766
+ */
2767
+ summary: string;
2768
+ }
2769
+
2770
+ namespace Data {
2771
+ export interface Impact {
2772
+ /**
2773
+ * Estimated aggregated amount for the approved requests.
2774
+ */
2775
+ approved_amount: V2.Amount | null;
2776
+
2777
+ /**
2778
+ * The number of approved requests which are impacted.
2779
+ */
2780
+ approved_impacted_requests: number | null;
2781
+
2782
+ /**
2783
+ * Estimated aggregated amount for the declined requests.
2784
+ */
2785
+ declined_amount: V2.Amount | null;
2786
+
2787
+ /**
2788
+ * The number of declined requests which are impacted.
2789
+ */
2790
+ declined_impacted_requests: number | null;
2791
+ }
2792
+ }
2793
+ }
2794
+
2795
+ /**
2796
+ * Occurs when a payment method error alert is firing.
2797
+ */
2798
+ export interface V2CoreHealthPaymentMethodErrorFiringEvent
2799
+ extends V2.EventBase {
2800
+ type: 'v2.core.health.payment_method_error.firing';
2801
+ // Retrieves data specific to this event.
2802
+ data: V2CoreHealthPaymentMethodErrorFiringEvent.Data;
2803
+ }
2804
+ export interface PushedV2CoreHealthPaymentMethodErrorFiringEvent
2805
+ extends V2.EventBase {
2806
+ type: 'v2.core.health.payment_method_error.firing';
2807
+ pull(): Promise<V2CoreHealthPaymentMethodErrorFiringEvent>;
2808
+ }
2809
+
2810
+ namespace V2CoreHealthPaymentMethodErrorFiringEvent {
2811
+ export interface Data {
2812
+ /**
2813
+ * The alert ID.
2814
+ */
2815
+ alert_id: string;
2816
+
2817
+ /**
2818
+ * The grouping key for the alert.
2819
+ */
2820
+ grouping_key: string;
2821
+
2822
+ /**
2823
+ * The user impact.
2824
+ */
2825
+ impact: Data.Impact;
2826
+
2827
+ /**
2828
+ * The time when impact on the user experience was first detected.
2829
+ */
2830
+ started_at: string;
2831
+
2832
+ /**
2833
+ * A short description of the alert.
2834
+ */
2835
+ summary: string;
2836
+ }
2837
+
2838
+ namespace Data {
2839
+ export interface Impact {
2840
+ /**
2841
+ * The returned error code.
2842
+ */
2843
+ error_code: string | null;
2844
+
2845
+ /**
2846
+ * The number of impacted requests.
2847
+ */
2848
+ impacted_requests: number;
2849
+
2850
+ /**
2851
+ * The type of the payment method.
2852
+ */
2853
+ payment_method_type: Impact.PaymentMethodType;
2854
+ }
2855
+
2856
+ namespace Impact {
2857
+ export type PaymentMethodType =
2858
+ | 'acss_debit'
2859
+ | 'affirm'
2860
+ | 'afterpay_clearpay'
2861
+ | 'alipay'
2862
+ | 'alma'
2863
+ | 'amazon_pay'
2864
+ | 'apple_pay'
2865
+ | 'au_becs_debit'
2866
+ | 'bacs_debit'
2867
+ | 'bancontact'
2868
+ | 'blik'
2869
+ | 'boleto'
2870
+ | 'card'
2871
+ | 'card_present'
2872
+ | 'cartes_bancaires'
2873
+ | 'cashapp'
2874
+ | 'dummy_passthrough_card'
2875
+ | 'eps'
2876
+ | 'fpx'
2877
+ | 'giropay'
2878
+ | 'grabpay'
2879
+ | 'ideal'
2880
+ | 'interac_present'
2881
+ | 'kakao_pay'
2882
+ | 'klarna'
2883
+ | 'konbini'
2884
+ | 'link'
2885
+ | 'mobilepay'
2886
+ | 'multibanco'
2887
+ | 'naver_pay'
2888
+ | 'oxxo'
2889
+ | 'p24'
2890
+ | 'paper_check'
2891
+ | 'paynow'
2892
+ | 'paypal'
2893
+ | 'payto'
2894
+ | 'pay_by_bank'
2895
+ | 'pix'
2896
+ | 'promptpay'
2897
+ | 'revolut_pay'
2898
+ | 'sepa_debit'
2899
+ | 'sofort'
2900
+ | 'swish'
2901
+ | 'twint'
2902
+ | 'upi'
2903
+ | 'wechat_pay'
2904
+ | 'zip';
2905
+ }
2906
+ }
2907
+ }
2908
+
2909
+ /**
2910
+ * Occurs when a payment method error alert is resolved.
2911
+ */
2912
+ export interface V2CoreHealthPaymentMethodErrorResolvedEvent
2913
+ extends V2.EventBase {
2914
+ type: 'v2.core.health.payment_method_error.resolved';
2915
+ // Retrieves data specific to this event.
2916
+ data: V2CoreHealthPaymentMethodErrorResolvedEvent.Data;
2917
+ }
2918
+ export interface PushedV2CoreHealthPaymentMethodErrorResolvedEvent
2919
+ extends V2.EventBase {
2920
+ type: 'v2.core.health.payment_method_error.resolved';
2921
+ pull(): Promise<V2CoreHealthPaymentMethodErrorResolvedEvent>;
2922
+ }
2923
+
2924
+ namespace V2CoreHealthPaymentMethodErrorResolvedEvent {
2925
+ export interface Data {
2926
+ /**
2927
+ * The alert ID.
2928
+ */
2929
+ alert_id: string;
2930
+
2931
+ /**
2932
+ * The grouping key for the alert.
2933
+ */
2934
+ grouping_key: string;
2935
+
2936
+ /**
2937
+ * The user impact.
2938
+ */
2939
+ impact: Data.Impact;
2940
+
2941
+ /**
2942
+ * The time when the user experience has returned to expected levels.
2943
+ */
2944
+ resolved_at: string;
2945
+
2946
+ /**
2947
+ * The time when impact on the user experience was first detected.
2948
+ */
2949
+ started_at: string;
2950
+
2951
+ /**
2952
+ * A short description of the alert.
2953
+ */
2954
+ summary: string;
2955
+ }
2956
+
2957
+ namespace Data {
2958
+ export interface Impact {
2959
+ /**
2960
+ * The returned error code.
2961
+ */
2962
+ error_code: string | null;
2963
+
2964
+ /**
2965
+ * The number of impacted requests.
2966
+ */
2967
+ impacted_requests: number;
2968
+
2969
+ /**
2970
+ * The type of the payment method.
2971
+ */
2972
+ payment_method_type: Impact.PaymentMethodType;
2973
+ }
2974
+
2975
+ namespace Impact {
2976
+ export type PaymentMethodType =
2977
+ | 'acss_debit'
2978
+ | 'affirm'
2979
+ | 'afterpay_clearpay'
2980
+ | 'alipay'
2981
+ | 'alma'
2982
+ | 'amazon_pay'
2983
+ | 'apple_pay'
2984
+ | 'au_becs_debit'
2985
+ | 'bacs_debit'
2986
+ | 'bancontact'
2987
+ | 'blik'
2988
+ | 'boleto'
2989
+ | 'card'
2990
+ | 'card_present'
2991
+ | 'cartes_bancaires'
2992
+ | 'cashapp'
2993
+ | 'dummy_passthrough_card'
2994
+ | 'eps'
2995
+ | 'fpx'
2996
+ | 'giropay'
2997
+ | 'grabpay'
2998
+ | 'ideal'
2999
+ | 'interac_present'
3000
+ | 'kakao_pay'
3001
+ | 'klarna'
3002
+ | 'konbini'
3003
+ | 'link'
3004
+ | 'mobilepay'
3005
+ | 'multibanco'
3006
+ | 'naver_pay'
3007
+ | 'oxxo'
3008
+ | 'p24'
3009
+ | 'paper_check'
3010
+ | 'paynow'
3011
+ | 'paypal'
3012
+ | 'payto'
3013
+ | 'pay_by_bank'
3014
+ | 'pix'
3015
+ | 'promptpay'
3016
+ | 'revolut_pay'
3017
+ | 'sepa_debit'
3018
+ | 'sofort'
3019
+ | 'swish'
3020
+ | 'twint'
3021
+ | 'upi'
3022
+ | 'wechat_pay'
3023
+ | 'zip';
3024
+ }
3025
+ }
3026
+ }
3027
+
3028
+ /**
3029
+ * Occurs when a traffic volume drop alert is firing.
3030
+ */
3031
+ export interface V2CoreHealthTrafficVolumeDropFiringEvent
3032
+ extends V2.EventBase {
3033
+ type: 'v2.core.health.traffic_volume_drop.firing';
3034
+ // Retrieves data specific to this event.
3035
+ data: V2CoreHealthTrafficVolumeDropFiringEvent.Data;
3036
+ }
3037
+ export interface PushedV2CoreHealthTrafficVolumeDropFiringEvent
3038
+ extends V2.EventBase {
3039
+ type: 'v2.core.health.traffic_volume_drop.firing';
3040
+ pull(): Promise<V2CoreHealthTrafficVolumeDropFiringEvent>;
3041
+ }
3042
+
3043
+ namespace V2CoreHealthTrafficVolumeDropFiringEvent {
3044
+ export interface Data {
3045
+ /**
3046
+ * The alert ID.
3047
+ */
3048
+ alert_id: string;
3049
+
3050
+ /**
3051
+ * The grouping key for the alert.
3052
+ */
3053
+ grouping_key: string;
3054
+
3055
+ /**
3056
+ * The user impact.
3057
+ */
3058
+ impact: Data.Impact;
3059
+
3060
+ /**
3061
+ * The time when impact on the user experience was first detected.
3062
+ */
3063
+ started_at: string;
3064
+
3065
+ /**
3066
+ * A short description of the alert.
3067
+ */
3068
+ summary: string;
3069
+ }
3070
+
3071
+ namespace Data {
3072
+ export interface Impact {
3073
+ /**
3074
+ * The total volume of payment requests within the latest observation time window.
3075
+ */
3076
+ actual_traffic: number;
3077
+
3078
+ /**
3079
+ * The expected volume of payment requests within the latest observation time window.
3080
+ */
3081
+ expected_traffic: number | null;
3082
+
3083
+ /**
3084
+ * The size of the observation time window.
3085
+ */
3086
+ time_window: string;
3087
+ }
3088
+ }
3089
+ }
3090
+
3091
+ /**
3092
+ * Occurs when a traffic volume drop alert is resolved.
3093
+ */
3094
+ export interface V2CoreHealthTrafficVolumeDropResolvedEvent
3095
+ extends V2.EventBase {
3096
+ type: 'v2.core.health.traffic_volume_drop.resolved';
3097
+ // Retrieves data specific to this event.
3098
+ data: V2CoreHealthTrafficVolumeDropResolvedEvent.Data;
3099
+ }
3100
+ export interface PushedV2CoreHealthTrafficVolumeDropResolvedEvent
3101
+ extends V2.EventBase {
3102
+ type: 'v2.core.health.traffic_volume_drop.resolved';
3103
+ pull(): Promise<V2CoreHealthTrafficVolumeDropResolvedEvent>;
3104
+ }
3105
+
3106
+ namespace V2CoreHealthTrafficVolumeDropResolvedEvent {
3107
+ export interface Data {
3108
+ /**
3109
+ * The alert ID.
3110
+ */
3111
+ alert_id: string;
3112
+
3113
+ /**
3114
+ * The grouping key for the alert.
3115
+ */
3116
+ grouping_key: string;
3117
+
3118
+ /**
3119
+ * The user impact.
3120
+ */
3121
+ impact: Data.Impact;
3122
+
3123
+ /**
3124
+ * The time when the user experience has returned to expected levels.
3125
+ */
3126
+ resolved_at: string;
3127
+
3128
+ /**
3129
+ * The time when impact on the user experience was first detected.
3130
+ */
3131
+ started_at: string;
3132
+
3133
+ /**
3134
+ * A short description of the alert.
3135
+ */
3136
+ summary: string;
3137
+ }
3138
+
3139
+ namespace Data {
3140
+ export interface Impact {
3141
+ /**
3142
+ * The total volume of payment requests within the latest observation time window.
3143
+ */
3144
+ actual_traffic: number;
3145
+
3146
+ /**
3147
+ * The expected volume of payment requests within the latest observation time window.
3148
+ */
3149
+ expected_traffic: number | null;
3150
+
3151
+ /**
3152
+ * The size of the observation time window.
3153
+ */
3154
+ time_window: string;
3155
+ }
3156
+ }
3157
+ }
3158
+
3159
+ /**
3160
+ * Occurs when a webhook latency alert is firing.
3161
+ */
3162
+ export interface V2CoreHealthWebhookLatencyFiringEvent
3163
+ extends V2.EventBase {
3164
+ type: 'v2.core.health.webhook_latency.firing';
3165
+ // Retrieves data specific to this event.
3166
+ data: V2CoreHealthWebhookLatencyFiringEvent.Data;
3167
+ }
3168
+ export interface PushedV2CoreHealthWebhookLatencyFiringEvent
3169
+ extends V2.EventBase {
3170
+ type: 'v2.core.health.webhook_latency.firing';
3171
+ pull(): Promise<V2CoreHealthWebhookLatencyFiringEvent>;
3172
+ }
3173
+
3174
+ namespace V2CoreHealthWebhookLatencyFiringEvent {
3175
+ export interface Data {
3176
+ /**
3177
+ * The alert ID.
3178
+ */
3179
+ alert_id: string;
3180
+
3181
+ /**
3182
+ * The grouping key for the alert.
3183
+ */
3184
+ grouping_key: string;
3185
+
3186
+ /**
3187
+ * The user impact.
3188
+ */
3189
+ impact: Data.Impact;
3190
+
3191
+ /**
3192
+ * The time when impact on the user experience was first detected.
3193
+ */
3194
+ started_at: string;
3195
+
3196
+ /**
3197
+ * A short description of the alert.
3198
+ */
3199
+ summary: string;
3200
+ }
3201
+
3202
+ namespace Data {
3203
+ export interface Impact {
3204
+ /**
3205
+ * The number of impacted requests.
3206
+ */
3207
+ impacted_requests: number;
3208
+ }
3209
+ }
3210
+ }
3211
+
3212
+ /**
3213
+ * Occurs when a webhook latency alert is resolved.
3214
+ */
3215
+ export interface V2CoreHealthWebhookLatencyResolvedEvent
3216
+ extends V2.EventBase {
3217
+ type: 'v2.core.health.webhook_latency.resolved';
3218
+ // Retrieves data specific to this event.
3219
+ data: V2CoreHealthWebhookLatencyResolvedEvent.Data;
3220
+ }
3221
+ export interface PushedV2CoreHealthWebhookLatencyResolvedEvent
3222
+ extends V2.EventBase {
3223
+ type: 'v2.core.health.webhook_latency.resolved';
3224
+ pull(): Promise<V2CoreHealthWebhookLatencyResolvedEvent>;
3225
+ }
3226
+
3227
+ namespace V2CoreHealthWebhookLatencyResolvedEvent {
3228
+ export interface Data {
3229
+ /**
3230
+ * The alert ID.
3231
+ */
3232
+ alert_id: string;
3233
+
3234
+ /**
3235
+ * The grouping key for the alert.
3236
+ */
3237
+ grouping_key: string;
3238
+
3239
+ /**
3240
+ * The user impact.
3241
+ */
3242
+ impact: Data.Impact;
3243
+
3244
+ /**
3245
+ * The time when the user experience has returned to expected levels.
3246
+ */
3247
+ resolved_at: string;
3248
+
3249
+ /**
3250
+ * The time when impact on the user experience was first detected.
3251
+ */
3252
+ started_at: string;
3253
+
3254
+ /**
3255
+ * A short description of the alert.
3256
+ */
3257
+ summary: string;
3258
+ }
3259
+
3260
+ namespace Data {
3261
+ export interface Impact {
3262
+ /**
3263
+ * The number of impacted requests.
3264
+ */
3265
+ impacted_requests: number;
3266
+ }
3267
+ }
3268
+ }
3269
+
3270
+ /**
3271
+ * Occurs when an Adjustment is created.
3272
+ */
3273
+ export interface V2MoneyManagementAdjustmentCreatedEvent
3274
+ extends V2.EventBase {
3275
+ type: 'v2.money_management.adjustment.created';
3276
+ // Object containing the reference to API resource relevant to the event.
3277
+ related_object: Event.RelatedObject;
3278
+ // Retrieves the object associated with the event.
3279
+ fetchRelatedObject(): Promise<V2.MoneyManagement.Adjustment>;
3280
+ }
3281
+ export interface PushedV2MoneyManagementAdjustmentCreatedEvent
3282
+ extends V2.EventBase {
3283
+ type: 'v2.money_management.adjustment.created';
3284
+ // Object containing the reference to API resource relevant to the event.
3285
+ related_object: Event.RelatedObject;
3286
+ // Retrieves the object associated with the event.
3287
+ fetchRelatedObject(): Promise<V2.MoneyManagement.Adjustment>;
3288
+ pull(): Promise<V2MoneyManagementAdjustmentCreatedEvent>;
3289
+ }
3290
+
3291
+ /**
3292
+ * Occurs when a FinancialAccount is created.
3293
+ */
3294
+ export interface V2MoneyManagementFinancialAccountCreatedEvent
3295
+ extends V2.EventBase {
3296
+ type: 'v2.money_management.financial_account.created';
3297
+ // Object containing the reference to API resource relevant to the event.
3298
+ related_object: Event.RelatedObject;
3299
+ // Retrieves the object associated with the event.
3300
+ fetchRelatedObject(): Promise<V2.MoneyManagement.FinancialAccount>;
3301
+ }
3302
+ export interface PushedV2MoneyManagementFinancialAccountCreatedEvent
3303
+ extends V2.EventBase {
3304
+ type: 'v2.money_management.financial_account.created';
3305
+ // Object containing the reference to API resource relevant to the event.
3306
+ related_object: Event.RelatedObject;
3307
+ // Retrieves the object associated with the event.
3308
+ fetchRelatedObject(): Promise<V2.MoneyManagement.FinancialAccount>;
3309
+ pull(): Promise<V2MoneyManagementFinancialAccountCreatedEvent>;
3310
+ }
3311
+
3312
+ /**
3313
+ * Occurs when a FinancialAccount is updated.
3314
+ */
3315
+ export interface V2MoneyManagementFinancialAccountUpdatedEvent
3316
+ extends V2.EventBase {
3317
+ type: 'v2.money_management.financial_account.updated';
3318
+ // Object containing the reference to API resource relevant to the event.
3319
+ related_object: Event.RelatedObject;
3320
+ // Retrieves the object associated with the event.
3321
+ fetchRelatedObject(): Promise<V2.MoneyManagement.FinancialAccount>;
3322
+ }
3323
+ export interface PushedV2MoneyManagementFinancialAccountUpdatedEvent
3324
+ extends V2.EventBase {
3325
+ type: 'v2.money_management.financial_account.updated';
3326
+ // Object containing the reference to API resource relevant to the event.
3327
+ related_object: Event.RelatedObject;
3328
+ // Retrieves the object associated with the event.
3329
+ fetchRelatedObject(): Promise<V2.MoneyManagement.FinancialAccount>;
3330
+ pull(): Promise<V2MoneyManagementFinancialAccountUpdatedEvent>;
3331
+ }
3332
+
3333
+ /**
3334
+ * Occurs when a FinancialAddress is activated and is ready to receive funds.
3335
+ */
3336
+ export interface V2MoneyManagementFinancialAddressActivatedEvent
3337
+ extends V2.EventBase {
3338
+ type: 'v2.money_management.financial_address.activated';
3339
+ // Object containing the reference to API resource relevant to the event.
3340
+ related_object: Event.RelatedObject;
3341
+ // Retrieves the object associated with the event.
3342
+ fetchRelatedObject(): Promise<V2.MoneyManagement.FinancialAddress>;
3343
+ }
3344
+ export interface PushedV2MoneyManagementFinancialAddressActivatedEvent
3345
+ extends V2.EventBase {
3346
+ type: 'v2.money_management.financial_address.activated';
3347
+ // Object containing the reference to API resource relevant to the event.
3348
+ related_object: Event.RelatedObject;
3349
+ // Retrieves the object associated with the event.
3350
+ fetchRelatedObject(): Promise<V2.MoneyManagement.FinancialAddress>;
3351
+ pull(): Promise<V2MoneyManagementFinancialAddressActivatedEvent>;
3352
+ }
3353
+
3354
+ /**
3355
+ * Occurs when a FinancialAddress fails to activate and can not receive funds.
3356
+ */
3357
+ export interface V2MoneyManagementFinancialAddressFailedEvent
3358
+ extends V2.EventBase {
3359
+ type: 'v2.money_management.financial_address.failed';
3360
+ // Object containing the reference to API resource relevant to the event.
3361
+ related_object: Event.RelatedObject;
3362
+ // Retrieves the object associated with the event.
3363
+ fetchRelatedObject(): Promise<V2.MoneyManagement.FinancialAddress>;
3364
+ }
3365
+ export interface PushedV2MoneyManagementFinancialAddressFailedEvent
3366
+ extends V2.EventBase {
3367
+ type: 'v2.money_management.financial_address.failed';
3368
+ // Object containing the reference to API resource relevant to the event.
3369
+ related_object: Event.RelatedObject;
3370
+ // Retrieves the object associated with the event.
3371
+ fetchRelatedObject(): Promise<V2.MoneyManagement.FinancialAddress>;
3372
+ pull(): Promise<V2MoneyManagementFinancialAddressFailedEvent>;
3373
+ }
3374
+
3375
+ /**
3376
+ * Occurs when an InboundTransfer's funds are made available.
3377
+ */
3378
+ export interface V2MoneyManagementInboundTransferAvailableEvent
3379
+ extends V2.EventBase {
3380
+ type: 'v2.money_management.inbound_transfer.available';
3381
+ // Retrieves data specific to this event.
3382
+ data: V2MoneyManagementInboundTransferAvailableEvent.Data;
3383
+ // Object containing the reference to API resource relevant to the event.
3384
+ related_object: Event.RelatedObject;
3385
+ // Retrieves the object associated with the event.
3386
+ fetchRelatedObject(): Promise<V2.MoneyManagement.InboundTransfer>;
3387
+ }
3388
+ export interface PushedV2MoneyManagementInboundTransferAvailableEvent
3389
+ extends V2.EventBase {
3390
+ type: 'v2.money_management.inbound_transfer.available';
3391
+ // Object containing the reference to API resource relevant to the event.
3392
+ related_object: Event.RelatedObject;
3393
+ // Retrieves the object associated with the event.
3394
+ fetchRelatedObject(): Promise<V2.MoneyManagement.InboundTransfer>;
3395
+ pull(): Promise<V2MoneyManagementInboundTransferAvailableEvent>;
3396
+ }
3397
+
3398
+ namespace V2MoneyManagementInboundTransferAvailableEvent {
3399
+ export interface Data {
3400
+ /**
3401
+ * The transaction ID of the received credit.
3402
+ */
3403
+ transaction_id: string;
3404
+ }
3405
+ }
3406
+
3407
+ /**
3408
+ * Occurs when an InboundTransfer fails.
3409
+ */
3410
+ export interface V2MoneyManagementInboundTransferBankDebitFailedEvent
3411
+ extends V2.EventBase {
3412
+ type: 'v2.money_management.inbound_transfer.bank_debit_failed';
3413
+ // Object containing the reference to API resource relevant to the event.
3414
+ related_object: Event.RelatedObject;
3415
+ // Retrieves the object associated with the event.
3416
+ fetchRelatedObject(): Promise<V2.MoneyManagement.InboundTransfer>;
3417
+ }
3418
+ export interface PushedV2MoneyManagementInboundTransferBankDebitFailedEvent
3419
+ extends V2.EventBase {
3420
+ type: 'v2.money_management.inbound_transfer.bank_debit_failed';
3421
+ // Object containing the reference to API resource relevant to the event.
3422
+ related_object: Event.RelatedObject;
3423
+ // Retrieves the object associated with the event.
3424
+ fetchRelatedObject(): Promise<V2.MoneyManagement.InboundTransfer>;
3425
+ pull(): Promise<V2MoneyManagementInboundTransferBankDebitFailedEvent>;
3426
+ }
3427
+
3428
+ /**
3429
+ * Occurs when an InboundTransfer starts processing.
3430
+ */
3431
+ export interface V2MoneyManagementInboundTransferBankDebitProcessingEvent
3432
+ extends V2.EventBase {
3433
+ type: 'v2.money_management.inbound_transfer.bank_debit_processing';
3434
+ // Object containing the reference to API resource relevant to the event.
3435
+ related_object: Event.RelatedObject;
3436
+ // Retrieves the object associated with the event.
3437
+ fetchRelatedObject(): Promise<V2.MoneyManagement.InboundTransfer>;
3438
+ }
3439
+ export interface PushedV2MoneyManagementInboundTransferBankDebitProcessingEvent
3440
+ extends V2.EventBase {
3441
+ type: 'v2.money_management.inbound_transfer.bank_debit_processing';
3442
+ // Object containing the reference to API resource relevant to the event.
3443
+ related_object: Event.RelatedObject;
3444
+ // Retrieves the object associated with the event.
3445
+ fetchRelatedObject(): Promise<V2.MoneyManagement.InboundTransfer>;
3446
+ pull(): Promise<V2MoneyManagementInboundTransferBankDebitProcessingEvent>;
3447
+ }
3448
+
3449
+ /**
3450
+ * Occurs when an InboundTransfer is queued.
3451
+ */
3452
+ export interface V2MoneyManagementInboundTransferBankDebitQueuedEvent
3453
+ extends V2.EventBase {
3454
+ type: 'v2.money_management.inbound_transfer.bank_debit_queued';
3455
+ // Object containing the reference to API resource relevant to the event.
3456
+ related_object: Event.RelatedObject;
3457
+ // Retrieves the object associated with the event.
3458
+ fetchRelatedObject(): Promise<V2.MoneyManagement.InboundTransfer>;
3459
+ }
3460
+ export interface PushedV2MoneyManagementInboundTransferBankDebitQueuedEvent
3461
+ extends V2.EventBase {
3462
+ type: 'v2.money_management.inbound_transfer.bank_debit_queued';
3463
+ // Object containing the reference to API resource relevant to the event.
3464
+ related_object: Event.RelatedObject;
3465
+ // Retrieves the object associated with the event.
3466
+ fetchRelatedObject(): Promise<V2.MoneyManagement.InboundTransfer>;
3467
+ pull(): Promise<V2MoneyManagementInboundTransferBankDebitQueuedEvent>;
3468
+ }
3469
+
3470
+ /**
3471
+ * Occurs when an InboundTransfer is returned.
3472
+ */
3473
+ export interface V2MoneyManagementInboundTransferBankDebitReturnedEvent
3474
+ extends V2.EventBase {
3475
+ type: 'v2.money_management.inbound_transfer.bank_debit_returned';
3476
+ // Object containing the reference to API resource relevant to the event.
3477
+ related_object: Event.RelatedObject;
3478
+ // Retrieves the object associated with the event.
3479
+ fetchRelatedObject(): Promise<V2.MoneyManagement.InboundTransfer>;
3480
+ }
3481
+ export interface PushedV2MoneyManagementInboundTransferBankDebitReturnedEvent
3482
+ extends V2.EventBase {
3483
+ type: 'v2.money_management.inbound_transfer.bank_debit_returned';
3484
+ // Object containing the reference to API resource relevant to the event.
3485
+ related_object: Event.RelatedObject;
3486
+ // Retrieves the object associated with the event.
3487
+ fetchRelatedObject(): Promise<V2.MoneyManagement.InboundTransfer>;
3488
+ pull(): Promise<V2MoneyManagementInboundTransferBankDebitReturnedEvent>;
3489
+ }
3490
+
3491
+ /**
3492
+ * Occurs when an InboundTransfer succeeds.
3493
+ */
3494
+ export interface V2MoneyManagementInboundTransferBankDebitSucceededEvent
3495
+ extends V2.EventBase {
3496
+ type: 'v2.money_management.inbound_transfer.bank_debit_succeeded';
3497
+ // Object containing the reference to API resource relevant to the event.
3498
+ related_object: Event.RelatedObject;
3499
+ // Retrieves the object associated with the event.
3500
+ fetchRelatedObject(): Promise<V2.MoneyManagement.InboundTransfer>;
3501
+ }
3502
+ export interface PushedV2MoneyManagementInboundTransferBankDebitSucceededEvent
3503
+ extends V2.EventBase {
3504
+ type: 'v2.money_management.inbound_transfer.bank_debit_succeeded';
3505
+ // Object containing the reference to API resource relevant to the event.
3506
+ related_object: Event.RelatedObject;
3507
+ // Retrieves the object associated with the event.
3508
+ fetchRelatedObject(): Promise<V2.MoneyManagement.InboundTransfer>;
3509
+ pull(): Promise<V2MoneyManagementInboundTransferBankDebitSucceededEvent>;
3510
+ }
3511
+
3512
+ /**
3513
+ * Occurs when an OutboundPayment transitions into the canceled state.
3514
+ */
3515
+ export interface V2MoneyManagementOutboundPaymentCanceledEvent
3516
+ extends V2.EventBase {
3517
+ type: 'v2.money_management.outbound_payment.canceled';
3518
+ // Object containing the reference to API resource relevant to the event.
3519
+ related_object: Event.RelatedObject;
3520
+ // Retrieves the object associated with the event.
3521
+ fetchRelatedObject(): Promise<V2.MoneyManagement.OutboundPayment>;
3522
+ }
3523
+ export interface PushedV2MoneyManagementOutboundPaymentCanceledEvent
3524
+ extends V2.EventBase {
3525
+ type: 'v2.money_management.outbound_payment.canceled';
3526
+ // Object containing the reference to API resource relevant to the event.
3527
+ related_object: Event.RelatedObject;
3528
+ // Retrieves the object associated with the event.
3529
+ fetchRelatedObject(): Promise<V2.MoneyManagement.OutboundPayment>;
3530
+ pull(): Promise<V2MoneyManagementOutboundPaymentCanceledEvent>;
3531
+ }
3532
+
3533
+ /**
3534
+ * Occurs when an OutboundPayment is created.
3535
+ */
3536
+ export interface V2MoneyManagementOutboundPaymentCreatedEvent
3537
+ extends V2.EventBase {
3538
+ type: 'v2.money_management.outbound_payment.created';
3539
+ // Object containing the reference to API resource relevant to the event.
3540
+ related_object: Event.RelatedObject;
3541
+ // Retrieves the object associated with the event.
3542
+ fetchRelatedObject(): Promise<V2.MoneyManagement.OutboundPayment>;
3543
+ }
3544
+ export interface PushedV2MoneyManagementOutboundPaymentCreatedEvent
3545
+ extends V2.EventBase {
3546
+ type: 'v2.money_management.outbound_payment.created';
3547
+ // Object containing the reference to API resource relevant to the event.
3548
+ related_object: Event.RelatedObject;
3549
+ // Retrieves the object associated with the event.
3550
+ fetchRelatedObject(): Promise<V2.MoneyManagement.OutboundPayment>;
3551
+ pull(): Promise<V2MoneyManagementOutboundPaymentCreatedEvent>;
3552
+ }
3553
+
3554
+ /**
3555
+ * Occurs when an OutboundPayment transitions into the failed state.
3556
+ */
3557
+ export interface V2MoneyManagementOutboundPaymentFailedEvent
3558
+ extends V2.EventBase {
3559
+ type: 'v2.money_management.outbound_payment.failed';
3560
+ // Object containing the reference to API resource relevant to the event.
3561
+ related_object: Event.RelatedObject;
3562
+ // Retrieves the object associated with the event.
3563
+ fetchRelatedObject(): Promise<V2.MoneyManagement.OutboundPayment>;
3564
+ }
3565
+ export interface PushedV2MoneyManagementOutboundPaymentFailedEvent
3566
+ extends V2.EventBase {
3567
+ type: 'v2.money_management.outbound_payment.failed';
3568
+ // Object containing the reference to API resource relevant to the event.
3569
+ related_object: Event.RelatedObject;
3570
+ // Retrieves the object associated with the event.
3571
+ fetchRelatedObject(): Promise<V2.MoneyManagement.OutboundPayment>;
3572
+ pull(): Promise<V2MoneyManagementOutboundPaymentFailedEvent>;
3573
+ }
3574
+
3575
+ /**
3576
+ * Occurs when an OutboundPayment transitions into the posted state.
3577
+ */
3578
+ export interface V2MoneyManagementOutboundPaymentPostedEvent
3579
+ extends V2.EventBase {
3580
+ type: 'v2.money_management.outbound_payment.posted';
3581
+ // Object containing the reference to API resource relevant to the event.
3582
+ related_object: Event.RelatedObject;
3583
+ // Retrieves the object associated with the event.
3584
+ fetchRelatedObject(): Promise<V2.MoneyManagement.OutboundPayment>;
3585
+ }
3586
+ export interface PushedV2MoneyManagementOutboundPaymentPostedEvent
3587
+ extends V2.EventBase {
3588
+ type: 'v2.money_management.outbound_payment.posted';
3589
+ // Object containing the reference to API resource relevant to the event.
3590
+ related_object: Event.RelatedObject;
3591
+ // Retrieves the object associated with the event.
3592
+ fetchRelatedObject(): Promise<V2.MoneyManagement.OutboundPayment>;
3593
+ pull(): Promise<V2MoneyManagementOutboundPaymentPostedEvent>;
3594
+ }
3595
+
3596
+ /**
3597
+ * Occurs when an OutboundPayment transitions into the returned state.
3598
+ */
3599
+ export interface V2MoneyManagementOutboundPaymentReturnedEvent
3600
+ extends V2.EventBase {
3601
+ type: 'v2.money_management.outbound_payment.returned';
3602
+ // Object containing the reference to API resource relevant to the event.
3603
+ related_object: Event.RelatedObject;
3604
+ // Retrieves the object associated with the event.
3605
+ fetchRelatedObject(): Promise<V2.MoneyManagement.OutboundPayment>;
3606
+ }
3607
+ export interface PushedV2MoneyManagementOutboundPaymentReturnedEvent
3608
+ extends V2.EventBase {
3609
+ type: 'v2.money_management.outbound_payment.returned';
3610
+ // Object containing the reference to API resource relevant to the event.
3611
+ related_object: Event.RelatedObject;
3612
+ // Retrieves the object associated with the event.
3613
+ fetchRelatedObject(): Promise<V2.MoneyManagement.OutboundPayment>;
3614
+ pull(): Promise<V2MoneyManagementOutboundPaymentReturnedEvent>;
3615
+ }
3616
+
3617
+ /**
3618
+ * Occurs when an OutboundPayment is updated.
3619
+ */
3620
+ export interface V2MoneyManagementOutboundPaymentUpdatedEvent
3621
+ extends V2.EventBase {
3622
+ type: 'v2.money_management.outbound_payment.updated';
3623
+ // Object containing the reference to API resource relevant to the event.
3624
+ related_object: Event.RelatedObject;
3625
+ // Retrieves the object associated with the event.
3626
+ fetchRelatedObject(): Promise<V2.MoneyManagement.OutboundPayment>;
3627
+ }
3628
+ export interface PushedV2MoneyManagementOutboundPaymentUpdatedEvent
3629
+ extends V2.EventBase {
3630
+ type: 'v2.money_management.outbound_payment.updated';
3631
+ // Object containing the reference to API resource relevant to the event.
3632
+ related_object: Event.RelatedObject;
3633
+ // Retrieves the object associated with the event.
3634
+ fetchRelatedObject(): Promise<V2.MoneyManagement.OutboundPayment>;
3635
+ pull(): Promise<V2MoneyManagementOutboundPaymentUpdatedEvent>;
3636
+ }
3637
+
3638
+ /**
3639
+ * Occurs when an OutboundTransfer transitions into the canceled state.
3640
+ */
3641
+ export interface V2MoneyManagementOutboundTransferCanceledEvent
3642
+ extends V2.EventBase {
3643
+ type: 'v2.money_management.outbound_transfer.canceled';
3644
+ // Object containing the reference to API resource relevant to the event.
3645
+ related_object: Event.RelatedObject;
3646
+ // Retrieves the object associated with the event.
3647
+ fetchRelatedObject(): Promise<V2.MoneyManagement.OutboundTransfer>;
3648
+ }
3649
+ export interface PushedV2MoneyManagementOutboundTransferCanceledEvent
3650
+ extends V2.EventBase {
3651
+ type: 'v2.money_management.outbound_transfer.canceled';
3652
+ // Object containing the reference to API resource relevant to the event.
3653
+ related_object: Event.RelatedObject;
3654
+ // Retrieves the object associated with the event.
3655
+ fetchRelatedObject(): Promise<V2.MoneyManagement.OutboundTransfer>;
3656
+ pull(): Promise<V2MoneyManagementOutboundTransferCanceledEvent>;
3657
+ }
3658
+
3659
+ /**
3660
+ * Occurs when an OutboundTransfer is created.
3661
+ */
3662
+ export interface V2MoneyManagementOutboundTransferCreatedEvent
3663
+ extends V2.EventBase {
3664
+ type: 'v2.money_management.outbound_transfer.created';
3665
+ // Object containing the reference to API resource relevant to the event.
3666
+ related_object: Event.RelatedObject;
3667
+ // Retrieves the object associated with the event.
3668
+ fetchRelatedObject(): Promise<V2.MoneyManagement.OutboundTransfer>;
3669
+ }
3670
+ export interface PushedV2MoneyManagementOutboundTransferCreatedEvent
3671
+ extends V2.EventBase {
3672
+ type: 'v2.money_management.outbound_transfer.created';
3673
+ // Object containing the reference to API resource relevant to the event.
3674
+ related_object: Event.RelatedObject;
3675
+ // Retrieves the object associated with the event.
3676
+ fetchRelatedObject(): Promise<V2.MoneyManagement.OutboundTransfer>;
3677
+ pull(): Promise<V2MoneyManagementOutboundTransferCreatedEvent>;
3678
+ }
3679
+
3680
+ /**
3681
+ * Occurs when an OutboundTransfer transitions into the failed state.
3682
+ */
3683
+ export interface V2MoneyManagementOutboundTransferFailedEvent
3684
+ extends V2.EventBase {
3685
+ type: 'v2.money_management.outbound_transfer.failed';
3686
+ // Object containing the reference to API resource relevant to the event.
3687
+ related_object: Event.RelatedObject;
3688
+ // Retrieves the object associated with the event.
3689
+ fetchRelatedObject(): Promise<V2.MoneyManagement.OutboundTransfer>;
3690
+ }
3691
+ export interface PushedV2MoneyManagementOutboundTransferFailedEvent
3692
+ extends V2.EventBase {
3693
+ type: 'v2.money_management.outbound_transfer.failed';
3694
+ // Object containing the reference to API resource relevant to the event.
3695
+ related_object: Event.RelatedObject;
3696
+ // Retrieves the object associated with the event.
3697
+ fetchRelatedObject(): Promise<V2.MoneyManagement.OutboundTransfer>;
3698
+ pull(): Promise<V2MoneyManagementOutboundTransferFailedEvent>;
3699
+ }
3700
+
3701
+ /**
3702
+ * Occurs when an OutboundTransfer transitions into the posted state.
3703
+ */
3704
+ export interface V2MoneyManagementOutboundTransferPostedEvent
3705
+ extends V2.EventBase {
3706
+ type: 'v2.money_management.outbound_transfer.posted';
3707
+ // Object containing the reference to API resource relevant to the event.
3708
+ related_object: Event.RelatedObject;
3709
+ // Retrieves the object associated with the event.
3710
+ fetchRelatedObject(): Promise<V2.MoneyManagement.OutboundTransfer>;
3711
+ }
3712
+ export interface PushedV2MoneyManagementOutboundTransferPostedEvent
3713
+ extends V2.EventBase {
3714
+ type: 'v2.money_management.outbound_transfer.posted';
3715
+ // Object containing the reference to API resource relevant to the event.
3716
+ related_object: Event.RelatedObject;
3717
+ // Retrieves the object associated with the event.
3718
+ fetchRelatedObject(): Promise<V2.MoneyManagement.OutboundTransfer>;
3719
+ pull(): Promise<V2MoneyManagementOutboundTransferPostedEvent>;
3720
+ }
3721
+
3722
+ /**
3723
+ * Occurs when an OutboundTransfer transitions into the returned state.
3724
+ */
3725
+ export interface V2MoneyManagementOutboundTransferReturnedEvent
3726
+ extends V2.EventBase {
3727
+ type: 'v2.money_management.outbound_transfer.returned';
3728
+ // Object containing the reference to API resource relevant to the event.
3729
+ related_object: Event.RelatedObject;
3730
+ // Retrieves the object associated with the event.
3731
+ fetchRelatedObject(): Promise<V2.MoneyManagement.OutboundTransfer>;
3732
+ }
3733
+ export interface PushedV2MoneyManagementOutboundTransferReturnedEvent
3734
+ extends V2.EventBase {
3735
+ type: 'v2.money_management.outbound_transfer.returned';
3736
+ // Object containing the reference to API resource relevant to the event.
3737
+ related_object: Event.RelatedObject;
3738
+ // Retrieves the object associated with the event.
3739
+ fetchRelatedObject(): Promise<V2.MoneyManagement.OutboundTransfer>;
3740
+ pull(): Promise<V2MoneyManagementOutboundTransferReturnedEvent>;
3741
+ }
3742
+
3743
+ /**
3744
+ * Event that is emitted every time an Outbound Transfer is updated.
3745
+ */
3746
+ export interface V2MoneyManagementOutboundTransferUpdatedEvent
3747
+ extends V2.EventBase {
3748
+ type: 'v2.money_management.outbound_transfer.updated';
3749
+ // Object containing the reference to API resource relevant to the event.
3750
+ related_object: Event.RelatedObject;
3751
+ // Retrieves the object associated with the event.
3752
+ fetchRelatedObject(): Promise<V2.MoneyManagement.OutboundTransfer>;
3753
+ }
3754
+ export interface PushedV2MoneyManagementOutboundTransferUpdatedEvent
3755
+ extends V2.EventBase {
3756
+ type: 'v2.money_management.outbound_transfer.updated';
3757
+ // Object containing the reference to API resource relevant to the event.
3758
+ related_object: Event.RelatedObject;
3759
+ // Retrieves the object associated with the event.
3760
+ fetchRelatedObject(): Promise<V2.MoneyManagement.OutboundTransfer>;
3761
+ pull(): Promise<V2MoneyManagementOutboundTransferUpdatedEvent>;
3762
+ }
3763
+
3764
+ /**
3765
+ * Occurs when a PayoutMethod is updated.
3766
+ */
3767
+ export interface V2MoneyManagementPayoutMethodUpdatedEvent
3768
+ extends V2.EventBase {
3769
+ type: 'v2.money_management.payout_method.updated';
3770
+ // Object containing the reference to API resource relevant to the event.
3771
+ related_object: Event.RelatedObject;
3772
+ // Retrieves the object associated with the event.
3773
+ fetchRelatedObject(): Promise<V2.MoneyManagement.PayoutMethod>;
3774
+ }
3775
+ export interface PushedV2MoneyManagementPayoutMethodUpdatedEvent
3776
+ extends V2.EventBase {
3777
+ type: 'v2.money_management.payout_method.updated';
3778
+ // Object containing the reference to API resource relevant to the event.
3779
+ related_object: Event.RelatedObject;
3780
+ // Retrieves the object associated with the event.
3781
+ fetchRelatedObject(): Promise<V2.MoneyManagement.PayoutMethod>;
3782
+ pull(): Promise<V2MoneyManagementPayoutMethodUpdatedEvent>;
3783
+ }
3784
+
3785
+ /**
3786
+ * Occurs when a ReceivedCredit's funds are received and are available in your balance.
3787
+ */
3788
+ export interface V2MoneyManagementReceivedCreditAvailableEvent
3789
+ extends V2.EventBase {
3790
+ type: 'v2.money_management.received_credit.available';
3791
+ // Retrieves data specific to this event.
3792
+ data: V2MoneyManagementReceivedCreditAvailableEvent.Data;
3793
+ // Object containing the reference to API resource relevant to the event.
3794
+ related_object: Event.RelatedObject;
3795
+ // Retrieves the object associated with the event.
3796
+ fetchRelatedObject(): Promise<V2.MoneyManagement.ReceivedCredit>;
3797
+ }
3798
+ export interface PushedV2MoneyManagementReceivedCreditAvailableEvent
3799
+ extends V2.EventBase {
3800
+ type: 'v2.money_management.received_credit.available';
3801
+ // Object containing the reference to API resource relevant to the event.
3802
+ related_object: Event.RelatedObject;
3803
+ // Retrieves the object associated with the event.
3804
+ fetchRelatedObject(): Promise<V2.MoneyManagement.ReceivedCredit>;
3805
+ pull(): Promise<V2MoneyManagementReceivedCreditAvailableEvent>;
3806
+ }
3807
+
3808
+ namespace V2MoneyManagementReceivedCreditAvailableEvent {
3809
+ export interface Data {
3810
+ /**
3811
+ * The transaction ID of the received credit.
3812
+ */
3813
+ transaction_id: string;
3814
+ }
3815
+ }
3816
+
3817
+ /**
3818
+ * Occurs when a ReceivedCredit is attempted to your balance and fails. See the status_details for more information.
3819
+ */
3820
+ export interface V2MoneyManagementReceivedCreditFailedEvent
3821
+ extends V2.EventBase {
3822
+ type: 'v2.money_management.received_credit.failed';
3823
+ // Object containing the reference to API resource relevant to the event.
3824
+ related_object: Event.RelatedObject;
3825
+ // Retrieves the object associated with the event.
3826
+ fetchRelatedObject(): Promise<V2.MoneyManagement.ReceivedCredit>;
3827
+ }
3828
+ export interface PushedV2MoneyManagementReceivedCreditFailedEvent
3829
+ extends V2.EventBase {
3830
+ type: 'v2.money_management.received_credit.failed';
3831
+ // Object containing the reference to API resource relevant to the event.
3832
+ related_object: Event.RelatedObject;
3833
+ // Retrieves the object associated with the event.
3834
+ fetchRelatedObject(): Promise<V2.MoneyManagement.ReceivedCredit>;
3835
+ pull(): Promise<V2MoneyManagementReceivedCreditFailedEvent>;
3836
+ }
3837
+
3838
+ /**
3839
+ * Occurs when a ReceivedCredit is reversed, returned to the originator, and deducted from your balance.
3840
+ */
3841
+ export interface V2MoneyManagementReceivedCreditReturnedEvent
3842
+ extends V2.EventBase {
3843
+ type: 'v2.money_management.received_credit.returned';
3844
+ // Object containing the reference to API resource relevant to the event.
3845
+ related_object: Event.RelatedObject;
3846
+ // Retrieves the object associated with the event.
3847
+ fetchRelatedObject(): Promise<V2.MoneyManagement.ReceivedCredit>;
3848
+ }
3849
+ export interface PushedV2MoneyManagementReceivedCreditReturnedEvent
3850
+ extends V2.EventBase {
3851
+ type: 'v2.money_management.received_credit.returned';
3852
+ // Object containing the reference to API resource relevant to the event.
3853
+ related_object: Event.RelatedObject;
3854
+ // Retrieves the object associated with the event.
3855
+ fetchRelatedObject(): Promise<V2.MoneyManagement.ReceivedCredit>;
3856
+ pull(): Promise<V2MoneyManagementReceivedCreditReturnedEvent>;
3857
+ }
3858
+
3859
+ /**
3860
+ * Occurs when a ReceivedCredit succeeds.
3861
+ */
3862
+ export interface V2MoneyManagementReceivedCreditSucceededEvent
3863
+ extends V2.EventBase {
3864
+ type: 'v2.money_management.received_credit.succeeded';
3865
+ // Object containing the reference to API resource relevant to the event.
3866
+ related_object: Event.RelatedObject;
3867
+ // Retrieves the object associated with the event.
3868
+ fetchRelatedObject(): Promise<V2.MoneyManagement.ReceivedCredit>;
3869
+ }
3870
+ export interface PushedV2MoneyManagementReceivedCreditSucceededEvent
3871
+ extends V2.EventBase {
3872
+ type: 'v2.money_management.received_credit.succeeded';
3873
+ // Object containing the reference to API resource relevant to the event.
3874
+ related_object: Event.RelatedObject;
3875
+ // Retrieves the object associated with the event.
3876
+ fetchRelatedObject(): Promise<V2.MoneyManagement.ReceivedCredit>;
3877
+ pull(): Promise<V2MoneyManagementReceivedCreditSucceededEvent>;
3878
+ }
3879
+
3880
+ /**
3881
+ * Occurs when a ReceivedDebit is canceled.
3882
+ */
3883
+ export interface V2MoneyManagementReceivedDebitCanceledEvent
3884
+ extends V2.EventBase {
3885
+ type: 'v2.money_management.received_debit.canceled';
3886
+ // Object containing the reference to API resource relevant to the event.
3887
+ related_object: Event.RelatedObject;
3888
+ // Retrieves the object associated with the event.
3889
+ fetchRelatedObject(): Promise<V2.MoneyManagement.ReceivedDebit>;
3890
+ }
3891
+ export interface PushedV2MoneyManagementReceivedDebitCanceledEvent
3892
+ extends V2.EventBase {
3893
+ type: 'v2.money_management.received_debit.canceled';
3894
+ // Object containing the reference to API resource relevant to the event.
3895
+ related_object: Event.RelatedObject;
3896
+ // Retrieves the object associated with the event.
3897
+ fetchRelatedObject(): Promise<V2.MoneyManagement.ReceivedDebit>;
3898
+ pull(): Promise<V2MoneyManagementReceivedDebitCanceledEvent>;
3899
+ }
3900
+
3901
+ /**
3902
+ * Occurs when a ReceivedDebit fails.
3903
+ */
3904
+ export interface V2MoneyManagementReceivedDebitFailedEvent
3905
+ extends V2.EventBase {
3906
+ type: 'v2.money_management.received_debit.failed';
3907
+ // Object containing the reference to API resource relevant to the event.
3908
+ related_object: Event.RelatedObject;
3909
+ // Retrieves the object associated with the event.
3910
+ fetchRelatedObject(): Promise<V2.MoneyManagement.ReceivedDebit>;
3911
+ }
3912
+ export interface PushedV2MoneyManagementReceivedDebitFailedEvent
3913
+ extends V2.EventBase {
3914
+ type: 'v2.money_management.received_debit.failed';
3915
+ // Object containing the reference to API resource relevant to the event.
3916
+ related_object: Event.RelatedObject;
3917
+ // Retrieves the object associated with the event.
3918
+ fetchRelatedObject(): Promise<V2.MoneyManagement.ReceivedDebit>;
3919
+ pull(): Promise<V2MoneyManagementReceivedDebitFailedEvent>;
3920
+ }
3921
+
3922
+ /**
3923
+ * Occurs when a ReceivedDebit is set to pending.
3924
+ */
3925
+ export interface V2MoneyManagementReceivedDebitPendingEvent
3926
+ extends V2.EventBase {
3927
+ type: 'v2.money_management.received_debit.pending';
3928
+ // Object containing the reference to API resource relevant to the event.
3929
+ related_object: Event.RelatedObject;
3930
+ // Retrieves the object associated with the event.
3931
+ fetchRelatedObject(): Promise<V2.MoneyManagement.ReceivedDebit>;
3932
+ }
3933
+ export interface PushedV2MoneyManagementReceivedDebitPendingEvent
3934
+ extends V2.EventBase {
3935
+ type: 'v2.money_management.received_debit.pending';
3936
+ // Object containing the reference to API resource relevant to the event.
3937
+ related_object: Event.RelatedObject;
3938
+ // Retrieves the object associated with the event.
3939
+ fetchRelatedObject(): Promise<V2.MoneyManagement.ReceivedDebit>;
3940
+ pull(): Promise<V2MoneyManagementReceivedDebitPendingEvent>;
3941
+ }
3942
+
3943
+ /**
3944
+ * Occurs when a ReceivedDebit succeeds.
3945
+ */
3946
+ export interface V2MoneyManagementReceivedDebitSucceededEvent
3947
+ extends V2.EventBase {
3948
+ type: 'v2.money_management.received_debit.succeeded';
3949
+ // Object containing the reference to API resource relevant to the event.
3950
+ related_object: Event.RelatedObject;
3951
+ // Retrieves the object associated with the event.
3952
+ fetchRelatedObject(): Promise<V2.MoneyManagement.ReceivedDebit>;
3953
+ }
3954
+ export interface PushedV2MoneyManagementReceivedDebitSucceededEvent
3955
+ extends V2.EventBase {
3956
+ type: 'v2.money_management.received_debit.succeeded';
3957
+ // Object containing the reference to API resource relevant to the event.
3958
+ related_object: Event.RelatedObject;
3959
+ // Retrieves the object associated with the event.
3960
+ fetchRelatedObject(): Promise<V2.MoneyManagement.ReceivedDebit>;
3961
+ pull(): Promise<V2MoneyManagementReceivedDebitSucceededEvent>;
3962
+ }
3963
+
3964
+ /**
3965
+ * Occurs when a ReceivedDebit is updated.
3966
+ */
3967
+ export interface V2MoneyManagementReceivedDebitUpdatedEvent
3968
+ extends V2.EventBase {
3969
+ type: 'v2.money_management.received_debit.updated';
3970
+ // Object containing the reference to API resource relevant to the event.
3971
+ related_object: Event.RelatedObject;
3972
+ // Retrieves the object associated with the event.
3973
+ fetchRelatedObject(): Promise<V2.MoneyManagement.ReceivedDebit>;
3974
+ }
3975
+ export interface PushedV2MoneyManagementReceivedDebitUpdatedEvent
3976
+ extends V2.EventBase {
3977
+ type: 'v2.money_management.received_debit.updated';
3978
+ // Object containing the reference to API resource relevant to the event.
3979
+ related_object: Event.RelatedObject;
3980
+ // Retrieves the object associated with the event.
3981
+ fetchRelatedObject(): Promise<V2.MoneyManagement.ReceivedDebit>;
3982
+ pull(): Promise<V2MoneyManagementReceivedDebitUpdatedEvent>;
3983
+ }
3984
+
3985
+ /**
3986
+ * Occurs when a Transaction is created.
3987
+ */
3988
+ export interface V2MoneyManagementTransactionCreatedEvent
3989
+ extends V2.EventBase {
3990
+ type: 'v2.money_management.transaction.created';
3991
+ // Object containing the reference to API resource relevant to the event.
3992
+ related_object: Event.RelatedObject;
3993
+ // Retrieves the object associated with the event.
3994
+ fetchRelatedObject(): Promise<V2.MoneyManagement.Transaction>;
3995
+ }
3996
+ export interface PushedV2MoneyManagementTransactionCreatedEvent
3997
+ extends V2.EventBase {
3998
+ type: 'v2.money_management.transaction.created';
3999
+ // Object containing the reference to API resource relevant to the event.
4000
+ related_object: Event.RelatedObject;
4001
+ // Retrieves the object associated with the event.
4002
+ fetchRelatedObject(): Promise<V2.MoneyManagement.Transaction>;
4003
+ pull(): Promise<V2MoneyManagementTransactionCreatedEvent>;
4004
+ }
4005
+
4006
+ /**
4007
+ * Occurs when a Transaction is updated.
4008
+ */
4009
+ export interface V2MoneyManagementTransactionUpdatedEvent
4010
+ extends V2.EventBase {
4011
+ type: 'v2.money_management.transaction.updated';
4012
+ // Object containing the reference to API resource relevant to the event.
4013
+ related_object: Event.RelatedObject;
4014
+ // Retrieves the object associated with the event.
4015
+ fetchRelatedObject(): Promise<V2.MoneyManagement.Transaction>;
4016
+ }
4017
+ export interface PushedV2MoneyManagementTransactionUpdatedEvent
4018
+ extends V2.EventBase {
4019
+ type: 'v2.money_management.transaction.updated';
4020
+ // Object containing the reference to API resource relevant to the event.
4021
+ related_object: Event.RelatedObject;
4022
+ // Retrieves the object associated with the event.
4023
+ fetchRelatedObject(): Promise<V2.MoneyManagement.Transaction>;
4024
+ pull(): Promise<V2MoneyManagementTransactionUpdatedEvent>;
4025
+ }
4026
+
4027
+ /**
4028
+ * Sent after a failed authorization if there are still retries available on the OffSessionPayment.
4029
+ */
4030
+ export interface V2PaymentsOffSessionPaymentAuthorizationAttemptFailedEvent
4031
+ extends V2.EventBase {
4032
+ type: 'v2.payments.off_session_payment.authorization_attempt_failed';
4033
+ // Object containing the reference to API resource relevant to the event.
4034
+ related_object: Event.RelatedObject;
4035
+ // Retrieves the object associated with the event.
4036
+ fetchRelatedObject(): Promise<V2.Payments.OffSessionPayment>;
4037
+ }
4038
+ export interface PushedV2PaymentsOffSessionPaymentAuthorizationAttemptFailedEvent
4039
+ extends V2.EventBase {
4040
+ type: 'v2.payments.off_session_payment.authorization_attempt_failed';
4041
+ // Object containing the reference to API resource relevant to the event.
4042
+ related_object: Event.RelatedObject;
4043
+ // Retrieves the object associated with the event.
4044
+ fetchRelatedObject(): Promise<V2.Payments.OffSessionPayment>;
4045
+ pull(): Promise<
4046
+ V2PaymentsOffSessionPaymentAuthorizationAttemptFailedEvent
4047
+ >;
4048
+ }
4049
+
4050
+ /**
4051
+ * Sent when our internal scheduling system kicks off an attempt at authorization, whether it's a
4052
+ * retry or an initial authorization.
4053
+ */
4054
+ export interface V2PaymentsOffSessionPaymentAuthorizationAttemptStartedEvent
4055
+ extends V2.EventBase {
4056
+ type: 'v2.payments.off_session_payment.authorization_attempt_started';
4057
+ // Object containing the reference to API resource relevant to the event.
4058
+ related_object: Event.RelatedObject;
4059
+ // Retrieves the object associated with the event.
4060
+ fetchRelatedObject(): Promise<V2.Payments.OffSessionPayment>;
4061
+ }
4062
+ export interface PushedV2PaymentsOffSessionPaymentAuthorizationAttemptStartedEvent
4063
+ extends V2.EventBase {
4064
+ type: 'v2.payments.off_session_payment.authorization_attempt_started';
4065
+ // Object containing the reference to API resource relevant to the event.
4066
+ related_object: Event.RelatedObject;
4067
+ // Retrieves the object associated with the event.
4068
+ fetchRelatedObject(): Promise<V2.Payments.OffSessionPayment>;
4069
+ pull(): Promise<
4070
+ V2PaymentsOffSessionPaymentAuthorizationAttemptStartedEvent
4071
+ >;
4072
+ }
4073
+
4074
+ /**
4075
+ * Sent immediately following a user's call to the Off-Session Payments cancel endpoint.
4076
+ */
4077
+ export interface V2PaymentsOffSessionPaymentCanceledEvent
4078
+ extends V2.EventBase {
4079
+ type: 'v2.payments.off_session_payment.canceled';
4080
+ // Object containing the reference to API resource relevant to the event.
4081
+ related_object: Event.RelatedObject;
4082
+ // Retrieves the object associated with the event.
4083
+ fetchRelatedObject(): Promise<V2.Payments.OffSessionPayment>;
4084
+ }
4085
+ export interface PushedV2PaymentsOffSessionPaymentCanceledEvent
4086
+ extends V2.EventBase {
4087
+ type: 'v2.payments.off_session_payment.canceled';
4088
+ // Object containing the reference to API resource relevant to the event.
4089
+ related_object: Event.RelatedObject;
4090
+ // Retrieves the object associated with the event.
4091
+ fetchRelatedObject(): Promise<V2.Payments.OffSessionPayment>;
4092
+ pull(): Promise<V2PaymentsOffSessionPaymentCanceledEvent>;
4093
+ }
4094
+
4095
+ /**
4096
+ * Sent immediately following a user's call to the Off-Session Payments create endpoint.
4097
+ */
4098
+ export interface V2PaymentsOffSessionPaymentCreatedEvent
4099
+ extends V2.EventBase {
4100
+ type: 'v2.payments.off_session_payment.created';
4101
+ // Object containing the reference to API resource relevant to the event.
4102
+ related_object: Event.RelatedObject;
4103
+ // Retrieves the object associated with the event.
4104
+ fetchRelatedObject(): Promise<V2.Payments.OffSessionPayment>;
4105
+ }
4106
+ export interface PushedV2PaymentsOffSessionPaymentCreatedEvent
4107
+ extends V2.EventBase {
4108
+ type: 'v2.payments.off_session_payment.created';
4109
+ // Object containing the reference to API resource relevant to the event.
4110
+ related_object: Event.RelatedObject;
4111
+ // Retrieves the object associated with the event.
4112
+ fetchRelatedObject(): Promise<V2.Payments.OffSessionPayment>;
4113
+ pull(): Promise<V2PaymentsOffSessionPaymentCreatedEvent>;
4114
+ }
4115
+
4116
+ /**
4117
+ * Sent after a failed authorization if there are no retries remaining, or if the failure is unretryable.
4118
+ */
4119
+ export interface V2PaymentsOffSessionPaymentFailedEvent
4120
+ extends V2.EventBase {
4121
+ type: 'v2.payments.off_session_payment.failed';
4122
+ // Object containing the reference to API resource relevant to the event.
4123
+ related_object: Event.RelatedObject;
4124
+ // Retrieves the object associated with the event.
4125
+ fetchRelatedObject(): Promise<V2.Payments.OffSessionPayment>;
4126
+ }
4127
+ export interface PushedV2PaymentsOffSessionPaymentFailedEvent
4128
+ extends V2.EventBase {
4129
+ type: 'v2.payments.off_session_payment.failed';
4130
+ // Object containing the reference to API resource relevant to the event.
4131
+ related_object: Event.RelatedObject;
4132
+ // Retrieves the object associated with the event.
4133
+ fetchRelatedObject(): Promise<V2.Payments.OffSessionPayment>;
4134
+ pull(): Promise<V2PaymentsOffSessionPaymentFailedEvent>;
4135
+ }
4136
+
4137
+ /**
4138
+ * Sent immediately after a successful authorization.
4139
+ */
4140
+ export interface V2PaymentsOffSessionPaymentSucceededEvent
4141
+ extends V2.EventBase {
4142
+ type: 'v2.payments.off_session_payment.succeeded';
4143
+ // Object containing the reference to API resource relevant to the event.
4144
+ related_object: Event.RelatedObject;
4145
+ // Retrieves the object associated with the event.
4146
+ fetchRelatedObject(): Promise<V2.Payments.OffSessionPayment>;
4147
+ }
4148
+ export interface PushedV2PaymentsOffSessionPaymentSucceededEvent
4149
+ extends V2.EventBase {
4150
+ type: 'v2.payments.off_session_payment.succeeded';
4151
+ // Object containing the reference to API resource relevant to the event.
4152
+ related_object: Event.RelatedObject;
4153
+ // Retrieves the object associated with the event.
4154
+ fetchRelatedObject(): Promise<V2.Payments.OffSessionPayment>;
4155
+ pull(): Promise<V2PaymentsOffSessionPaymentSucceededEvent>;
4156
+ }
4157
+
4158
+ /**
4159
+ * Occurs when a ReportRun is created.
4160
+ */
4161
+ export interface V2ReportingReportRunCreatedEvent extends V2.EventBase {
4162
+ type: 'v2.reporting.report_run.created';
4163
+ // Object containing the reference to API resource relevant to the event.
4164
+ related_object: Event.RelatedObject;
4165
+ // Retrieves the object associated with the event.
4166
+ fetchRelatedObject(): Promise<V2.Reporting.ReportRun>;
4167
+ }
4168
+ export interface PushedV2ReportingReportRunCreatedEvent
4169
+ extends V2.EventBase {
4170
+ type: 'v2.reporting.report_run.created';
4171
+ // Object containing the reference to API resource relevant to the event.
4172
+ related_object: Event.RelatedObject;
4173
+ // Retrieves the object associated with the event.
4174
+ fetchRelatedObject(): Promise<V2.Reporting.ReportRun>;
4175
+ pull(): Promise<V2ReportingReportRunCreatedEvent>;
4176
+ }
4177
+
4178
+ /**
4179
+ * Occurs when a ReportRun has failed to complete.
4180
+ */
4181
+ export interface V2ReportingReportRunFailedEvent extends V2.EventBase {
4182
+ type: 'v2.reporting.report_run.failed';
4183
+ // Object containing the reference to API resource relevant to the event.
4184
+ related_object: Event.RelatedObject;
4185
+ // Retrieves the object associated with the event.
4186
+ fetchRelatedObject(): Promise<V2.Reporting.ReportRun>;
4187
+ }
4188
+ export interface PushedV2ReportingReportRunFailedEvent
4189
+ extends V2.EventBase {
4190
+ type: 'v2.reporting.report_run.failed';
4191
+ // Object containing the reference to API resource relevant to the event.
4192
+ related_object: Event.RelatedObject;
4193
+ // Retrieves the object associated with the event.
4194
+ fetchRelatedObject(): Promise<V2.Reporting.ReportRun>;
4195
+ pull(): Promise<V2ReportingReportRunFailedEvent>;
4196
+ }
4197
+
4198
+ /**
4199
+ * Occurs when a ReportRun has successfully completed.
4200
+ */
4201
+ export interface V2ReportingReportRunSucceededEvent extends V2.EventBase {
4202
+ type: 'v2.reporting.report_run.succeeded';
4203
+ // Object containing the reference to API resource relevant to the event.
4204
+ related_object: Event.RelatedObject;
4205
+ // Retrieves the object associated with the event.
4206
+ fetchRelatedObject(): Promise<V2.Reporting.ReportRun>;
4207
+ }
4208
+ export interface PushedV2ReportingReportRunSucceededEvent
4209
+ extends V2.EventBase {
4210
+ type: 'v2.reporting.report_run.succeeded';
4211
+ // Object containing the reference to API resource relevant to the event.
4212
+ related_object: Event.RelatedObject;
4213
+ // Retrieves the object associated with the event.
4214
+ fetchRelatedObject(): Promise<V2.Reporting.ReportRun>;
4215
+ pull(): Promise<V2ReportingReportRunSucceededEvent>;
4216
+ }
4217
+
4218
+ /**
4219
+ * Occurs when a ReportRun is updated.
4220
+ */
4221
+ export interface V2ReportingReportRunUpdatedEvent extends V2.EventBase {
4222
+ type: 'v2.reporting.report_run.updated';
4223
+ // Object containing the reference to API resource relevant to the event.
4224
+ related_object: Event.RelatedObject;
4225
+ // Retrieves the object associated with the event.
4226
+ fetchRelatedObject(): Promise<V2.Reporting.ReportRun>;
4227
+ }
4228
+ export interface PushedV2ReportingReportRunUpdatedEvent
4229
+ extends V2.EventBase {
4230
+ type: 'v2.reporting.report_run.updated';
4231
+ // Object containing the reference to API resource relevant to the event.
4232
+ related_object: Event.RelatedObject;
4233
+ // Retrieves the object associated with the event.
4234
+ fetchRelatedObject(): Promise<V2.Reporting.ReportRun>;
4235
+ pull(): Promise<V2ReportingReportRunUpdatedEvent>;
226
4236
  }
227
4237
  }
228
4238
  }