stripe 18.6.0-alpha.2 → 19.0.0

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 (447) hide show
  1. package/CHANGELOG.md +85 -1429
  2. package/OPENAPI_VERSION +1 -1
  3. package/README.md +19 -6
  4. package/VERSION +1 -1
  5. package/cjs/Error.js +1 -115
  6. package/cjs/RequestSender.js +10 -4
  7. package/cjs/StripeContext.js +56 -0
  8. package/cjs/apiVersion.js +3 -2
  9. package/cjs/net/FetchHttpClient.js +1 -1
  10. package/cjs/resources/FinancialConnections/Accounts.js +0 -5
  11. package/cjs/resources/Mandates.js +0 -5
  12. package/cjs/resources/PaymentIntents.js +0 -13
  13. package/cjs/resources/Quotes.js +0 -32
  14. package/cjs/resources/SubscriptionSchedules.js +0 -4
  15. package/cjs/resources/Subscriptions.js +0 -4
  16. package/cjs/resources/V2/Core/Events.js +1 -1
  17. package/cjs/resources.js +8 -140
  18. package/cjs/stripe.core.js +19 -24
  19. package/esm/Error.js +0 -100
  20. package/esm/RequestSender.js +10 -4
  21. package/esm/StripeContext.js +52 -0
  22. package/esm/apiVersion.js +2 -1
  23. package/esm/net/FetchHttpClient.js +1 -1
  24. package/esm/resources/FinancialConnections/Accounts.js +0 -5
  25. package/esm/resources/Mandates.js +0 -5
  26. package/esm/resources/PaymentIntents.js +0 -13
  27. package/esm/resources/Quotes.js +0 -32
  28. package/esm/resources/SubscriptionSchedules.js +0 -4
  29. package/esm/resources/Subscriptions.js +0 -4
  30. package/esm/resources/V2/Core/Events.js +1 -1
  31. package/esm/resources.js +0 -125
  32. package/esm/stripe.core.js +19 -24
  33. package/package.json +4 -4
  34. package/types/AccountLinksResource.d.ts +1 -5
  35. package/types/AccountSessions.d.ts +0 -75
  36. package/types/AccountSessionsResource.d.ts +0 -306
  37. package/types/Accounts.d.ts +5 -207
  38. package/types/AccountsResource.d.ts +4 -528
  39. package/types/BalanceSettings.d.ts +12 -6
  40. package/types/BalanceSettingsResource.d.ts +15 -10
  41. package/types/BankAccounts.d.ts +4 -0
  42. package/types/Billing/AlertTriggereds.d.ts +1 -16
  43. package/types/Billing/Alerts.d.ts +1 -116
  44. package/types/Billing/AlertsResource.d.ts +3 -94
  45. package/types/Billing/CreditBalanceSummary.d.ts +2 -123
  46. package/types/Billing/CreditBalanceSummaryResource.d.ts +3 -20
  47. package/types/Billing/CreditBalanceTransactions.d.ts +2 -118
  48. package/types/Billing/CreditBalanceTransactionsResource.d.ts +4 -12
  49. package/types/Billing/CreditGrants.d.ts +1 -76
  50. package/types/Billing/CreditGrantsResource.d.ts +2 -43
  51. package/types/BillingPortal/Configurations.d.ts +7 -0
  52. package/types/BillingPortal/ConfigurationsResource.d.ts +14 -0
  53. package/types/BillingPortal/Sessions.d.ts +0 -5
  54. package/types/BillingPortal/SessionsResource.d.ts +4 -12
  55. package/types/Capabilities.d.ts +4 -0
  56. package/types/Cards.d.ts +1 -6
  57. package/types/CashBalances.d.ts +0 -5
  58. package/types/Charges.d.ts +11 -169
  59. package/types/ChargesResource.d.ts +0 -1406
  60. package/types/Checkout/Sessions.d.ts +191 -405
  61. package/types/Checkout/SessionsResource.d.ts +332 -557
  62. package/types/ConfirmationTokens.d.ts +0 -120
  63. package/types/Coupons.d.ts +0 -33
  64. package/types/CouponsResource.d.ts +0 -21
  65. package/types/CreditNoteLineItems.d.ts +0 -17
  66. package/types/CreditNotes.d.ts +0 -5
  67. package/types/CreditNotesResource.d.ts +0 -5
  68. package/types/CustomerBalanceTransactions.d.ts +0 -2
  69. package/types/CustomerCashBalanceTransactions.d.ts +0 -2
  70. package/types/CustomerSessions.d.ts +0 -5
  71. package/types/CustomerSessionsResource.d.ts +1 -6
  72. package/types/Customers.d.ts +10 -2
  73. package/types/CustomersResource.d.ts +20 -7
  74. package/types/Discounts.d.ts +32 -24
  75. package/types/Disputes.d.ts +6 -29
  76. package/types/Errors.d.ts +0 -85
  77. package/types/EventTypes.d.ts +0 -664
  78. package/types/Events.d.ts +0 -97
  79. package/types/ExchangeRates.d.ts +2 -0
  80. package/types/ExchangeRatesResource.d.ts +6 -0
  81. package/types/FinancialConnections/Accounts.d.ts +1 -36
  82. package/types/FinancialConnections/AccountsResource.d.ts +3 -40
  83. package/types/FinancialConnections/Sessions.d.ts +1 -51
  84. package/types/FinancialConnections/SessionsResource.d.ts +1 -43
  85. package/types/Identity/VerificationSessions.d.ts +0 -5
  86. package/types/Identity/VerificationSessionsResource.d.ts +0 -7
  87. package/types/InvoiceItems.d.ts +21 -105
  88. package/types/InvoiceItemsResource.d.ts +6 -117
  89. package/types/InvoiceLineItems.d.ts +3 -158
  90. package/types/InvoicePayments.d.ts +0 -5
  91. package/types/InvoicePaymentsResource.d.ts +1 -10
  92. package/types/Invoices.d.ts +7 -188
  93. package/types/InvoicesResource.d.ts +49 -1523
  94. package/types/Issuing/CardholdersResource.d.ts +5 -6
  95. package/types/Issuing/Cards.d.ts +5 -0
  96. package/types/Issuing/CardsResource.d.ts +14 -4
  97. package/types/Issuing/Transactions.d.ts +0 -5
  98. package/types/Issuing/TransactionsResource.d.ts +0 -5
  99. package/types/LineItems.d.ts +0 -49
  100. package/types/Mandates.d.ts +1 -135
  101. package/types/MandatesResource.d.ts +0 -31
  102. package/types/PaymentIntents.d.ts +5 -820
  103. package/types/PaymentIntentsResource.d.ts +5643 -11279
  104. package/types/PaymentLinks.d.ts +0 -6
  105. package/types/PaymentLinksResource.d.ts +5 -12
  106. package/types/PaymentMethodConfigurations.d.ts +0 -180
  107. package/types/PaymentMethodConfigurationsResource.d.ts +28 -228
  108. package/types/PaymentMethods.d.ts +0 -125
  109. package/types/PaymentMethodsResource.d.ts +2 -172
  110. package/types/Persons.d.ts +4 -0
  111. package/types/Prices.d.ts +0 -22
  112. package/types/PricesResource.d.ts +0 -22
  113. package/types/PromotionCodes.d.ts +16 -14
  114. package/types/PromotionCodesResource.d.ts +15 -13
  115. package/types/Quotes.d.ts +9 -589
  116. package/types/QuotesResource.d.ts +290 -2619
  117. package/types/Refunds.d.ts +0 -14
  118. package/types/Reviews.d.ts +2 -0
  119. package/types/SetupAttempts.d.ts +3 -51
  120. package/types/SetupIntents.d.ts +4 -210
  121. package/types/SetupIntentsResource.d.ts +3 -913
  122. package/types/Sources.d.ts +1 -30
  123. package/types/SubscriptionItems.d.ts +0 -21
  124. package/types/SubscriptionItemsResource.d.ts +0 -109
  125. package/types/SubscriptionSchedules.d.ts +16 -205
  126. package/types/SubscriptionSchedulesResource.d.ts +21 -1243
  127. package/types/Subscriptions.d.ts +17 -140
  128. package/types/SubscriptionsResource.d.ts +49 -502
  129. package/types/Tax/CalculationsResource.d.ts +5 -5
  130. package/types/Tax/Settings.d.ts +7 -0
  131. package/types/TaxIds.d.ts +0 -10
  132. package/types/TaxIdsResource.d.ts +0 -10
  133. package/types/Terminal/Configurations.d.ts +9 -9
  134. package/types/Terminal/ConfigurationsResource.d.ts +26 -28
  135. package/types/Terminal/Locations.d.ts +95 -0
  136. package/types/Terminal/LocationsResource.d.ts +59 -6
  137. package/types/Terminal/Readers.d.ts +0 -20
  138. package/types/TestHelpers/ConfirmationTokensResource.d.ts +0 -118
  139. package/types/TestHelpers/Issuing/AuthorizationsResource.d.ts +79 -0
  140. package/types/TestHelpers/Treasury/ReceivedCreditsResource.d.ts +0 -26
  141. package/types/TestHelpers/Treasury/ReceivedDebitsResource.d.ts +0 -26
  142. package/types/Transfers.d.ts +0 -5
  143. package/types/TransfersResource.d.ts +0 -5
  144. package/types/Treasury/FinancialAccountFeatures.d.ts +0 -7
  145. package/types/Treasury/FinancialAccounts.d.ts +0 -5
  146. package/types/Treasury/FinancialAccountsResource.d.ts +0 -37
  147. package/types/Treasury/OutboundTransfers.d.ts +0 -26
  148. package/types/Treasury/OutboundTransfersResource.d.ts +0 -26
  149. package/types/Treasury/ReceivedCredits.d.ts +0 -26
  150. package/types/Treasury/ReceivedDebits.d.ts +0 -31
  151. package/types/V2/Core/EventDestinations.d.ts +166 -0
  152. package/types/V2/Core/EventDestinationsResource.d.ts +14 -14
  153. package/types/V2/Core/EventTypes.d.ts +256 -0
  154. package/types/V2/Core/Events.d.ts +77 -0
  155. package/types/V2/Core/EventsResource.d.ts +4 -4
  156. package/types/V2/DeletedObject.d.ts +22 -0
  157. package/types/V2/EventMisc.d.ts +72 -0
  158. package/types/WebhookEndpointsResource.d.ts +2 -79
  159. package/types/Webhooks.d.ts +0 -2
  160. package/types/apiVersion.d.ts +2 -1
  161. package/types/index.d.ts +8 -270
  162. package/types/lib.d.ts +4 -14
  163. package/types/test/typescriptTest.ts +43 -0
  164. package/cjs/resources/AccountNotices.js +0 -21
  165. package/cjs/resources/Billing/MeterUsage.js +0 -12
  166. package/cjs/resources/Capital/FinancingOffers.js +0 -21
  167. package/cjs/resources/Capital/FinancingSummary.js +0 -12
  168. package/cjs/resources/Capital/FinancingTransactions.js +0 -17
  169. package/cjs/resources/ExternalAccounts.js +0 -23
  170. package/cjs/resources/FinancialConnections/Institutions.js +0 -17
  171. package/cjs/resources/FxQuotes.js +0 -15
  172. package/cjs/resources/Issuing/CreditUnderwritingRecords.js +0 -33
  173. package/cjs/resources/Issuing/DisputeSettlementDetails.js +0 -17
  174. package/cjs/resources/Issuing/FraudLiabilityDebits.js +0 -17
  175. package/cjs/resources/Margins.js +0 -22
  176. package/cjs/resources/Orders.js +0 -24
  177. package/cjs/resources/PaymentAttemptRecords.js +0 -17
  178. package/cjs/resources/PaymentRecords.js +0 -29
  179. package/cjs/resources/Privacy/RedactionJobs.js +0 -42
  180. package/cjs/resources/Tax/Associations.js +0 -9
  181. package/cjs/resources/Tax/Forms.js +0 -20
  182. package/cjs/resources/Terminal/OnboardingLinks.js +0 -12
  183. package/cjs/resources/Terminal/ReaderCollectedData.js +0 -12
  184. package/cjs/resources/V2/Billing/BillSettings/Versions.js +0 -17
  185. package/cjs/resources/V2/Billing/BillSettings.js +0 -27
  186. package/cjs/resources/V2/Billing/Cadences.js +0 -23
  187. package/cjs/resources/V2/Billing/CollectionSettings/Versions.js +0 -17
  188. package/cjs/resources/V2/Billing/CollectionSettings.js +0 -30
  189. package/cjs/resources/V2/Billing/CustomPricingUnits.js +0 -25
  190. package/cjs/resources/V2/Billing/Intents/Actions.js +0 -17
  191. package/cjs/resources/V2/Billing/Intents.js +0 -36
  192. package/cjs/resources/V2/Billing/LicenseFeeSubscriptions.js +0 -12
  193. package/cjs/resources/V2/Billing/LicenseFees/Versions.js +0 -17
  194. package/cjs/resources/V2/Billing/LicenseFees.js +0 -27
  195. package/cjs/resources/V2/Billing/LicensedItems.js +0 -25
  196. package/cjs/resources/V2/Billing/MeteredItems.js +0 -22
  197. package/cjs/resources/V2/Billing/PricingPlanSubscriptions.js +0 -17
  198. package/cjs/resources/V2/Billing/PricingPlans/Components.js +0 -29
  199. package/cjs/resources/V2/Billing/PricingPlans/Versions.js +0 -17
  200. package/cjs/resources/V2/Billing/PricingPlans.js +0 -29
  201. package/cjs/resources/V2/Billing/Profiles.js +0 -19
  202. package/cjs/resources/V2/Billing/RateCardSubscriptions.js +0 -29
  203. package/cjs/resources/V2/Billing/RateCards/Rates.js +0 -25
  204. package/cjs/resources/V2/Billing/RateCards/Versions.js +0 -17
  205. package/cjs/resources/V2/Billing/RateCards.js +0 -29
  206. package/cjs/resources/V2/Billing/ServiceActions.js +0 -16
  207. package/cjs/resources/V2/Core/AccountLinks.js +0 -9
  208. package/cjs/resources/V2/Core/Accounts/Persons.js +0 -29
  209. package/cjs/resources/V2/Core/Accounts.js +0 -25
  210. package/cjs/resources/V2/Core/ClaimableSandboxes.js +0 -16
  211. package/cjs/resources/V2/Core/Vault/GbBankAccounts.js +0 -28
  212. package/cjs/resources/V2/Core/Vault/UsBankAccounts.js +0 -24
  213. package/cjs/resources/V2/MoneyManagement/Adjustments.js +0 -17
  214. package/cjs/resources/V2/MoneyManagement/FinancialAccounts.js +0 -25
  215. package/cjs/resources/V2/MoneyManagement/FinancialAddresses.js +0 -21
  216. package/cjs/resources/V2/MoneyManagement/InboundTransfers.js +0 -21
  217. package/cjs/resources/V2/MoneyManagement/OutboundPaymentQuotes.js +0 -16
  218. package/cjs/resources/V2/MoneyManagement/OutboundPayments.js +0 -25
  219. package/cjs/resources/V2/MoneyManagement/OutboundSetupIntents.js +0 -29
  220. package/cjs/resources/V2/MoneyManagement/OutboundTransfers.js +0 -25
  221. package/cjs/resources/V2/MoneyManagement/PayoutMethods.js +0 -25
  222. package/cjs/resources/V2/MoneyManagement/PayoutMethodsBankAccountSpec.js +0 -12
  223. package/cjs/resources/V2/MoneyManagement/ReceivedCredits.js +0 -17
  224. package/cjs/resources/V2/MoneyManagement/ReceivedDebits.js +0 -17
  225. package/cjs/resources/V2/MoneyManagement/TransactionEntries.js +0 -17
  226. package/cjs/resources/V2/MoneyManagement/Transactions.js +0 -17
  227. package/cjs/resources/V2/Payments/OffSessionPayments.js +0 -25
  228. package/cjs/resources/V2/Reporting/ReportRuns.js +0 -13
  229. package/cjs/resources/V2/Reporting/Reports.js +0 -12
  230. package/cjs/resources/V2/Tax/AutomaticRules.js +0 -22
  231. package/cjs/resources/V2/TestHelpers/FinancialAddresses.js +0 -16
  232. package/esm/resources/AccountNotices.js +0 -18
  233. package/esm/resources/Billing/MeterUsage.js +0 -9
  234. package/esm/resources/Capital/FinancingOffers.js +0 -18
  235. package/esm/resources/Capital/FinancingSummary.js +0 -9
  236. package/esm/resources/Capital/FinancingTransactions.js +0 -14
  237. package/esm/resources/ExternalAccounts.js +0 -20
  238. package/esm/resources/FinancialConnections/Institutions.js +0 -14
  239. package/esm/resources/FxQuotes.js +0 -12
  240. package/esm/resources/Issuing/CreditUnderwritingRecords.js +0 -30
  241. package/esm/resources/Issuing/DisputeSettlementDetails.js +0 -14
  242. package/esm/resources/Issuing/FraudLiabilityDebits.js +0 -14
  243. package/esm/resources/Margins.js +0 -19
  244. package/esm/resources/Orders.js +0 -21
  245. package/esm/resources/PaymentAttemptRecords.js +0 -14
  246. package/esm/resources/PaymentRecords.js +0 -26
  247. package/esm/resources/Privacy/RedactionJobs.js +0 -39
  248. package/esm/resources/Tax/Associations.js +0 -6
  249. package/esm/resources/Tax/Forms.js +0 -17
  250. package/esm/resources/Terminal/OnboardingLinks.js +0 -9
  251. package/esm/resources/Terminal/ReaderCollectedData.js +0 -9
  252. package/esm/resources/V2/Billing/BillSettings/Versions.js +0 -14
  253. package/esm/resources/V2/Billing/BillSettings.js +0 -24
  254. package/esm/resources/V2/Billing/Cadences.js +0 -20
  255. package/esm/resources/V2/Billing/CollectionSettings/Versions.js +0 -14
  256. package/esm/resources/V2/Billing/CollectionSettings.js +0 -27
  257. package/esm/resources/V2/Billing/CustomPricingUnits.js +0 -22
  258. package/esm/resources/V2/Billing/Intents/Actions.js +0 -14
  259. package/esm/resources/V2/Billing/Intents.js +0 -33
  260. package/esm/resources/V2/Billing/LicenseFeeSubscriptions.js +0 -9
  261. package/esm/resources/V2/Billing/LicenseFees/Versions.js +0 -14
  262. package/esm/resources/V2/Billing/LicenseFees.js +0 -24
  263. package/esm/resources/V2/Billing/LicensedItems.js +0 -22
  264. package/esm/resources/V2/Billing/MeteredItems.js +0 -19
  265. package/esm/resources/V2/Billing/PricingPlanSubscriptions.js +0 -14
  266. package/esm/resources/V2/Billing/PricingPlans/Components.js +0 -26
  267. package/esm/resources/V2/Billing/PricingPlans/Versions.js +0 -14
  268. package/esm/resources/V2/Billing/PricingPlans.js +0 -26
  269. package/esm/resources/V2/Billing/Profiles.js +0 -16
  270. package/esm/resources/V2/Billing/RateCardSubscriptions.js +0 -26
  271. package/esm/resources/V2/Billing/RateCards/Rates.js +0 -22
  272. package/esm/resources/V2/Billing/RateCards/Versions.js +0 -14
  273. package/esm/resources/V2/Billing/RateCards.js +0 -26
  274. package/esm/resources/V2/Billing/ServiceActions.js +0 -13
  275. package/esm/resources/V2/Core/AccountLinks.js +0 -6
  276. package/esm/resources/V2/Core/Accounts/Persons.js +0 -26
  277. package/esm/resources/V2/Core/Accounts.js +0 -22
  278. package/esm/resources/V2/Core/ClaimableSandboxes.js +0 -13
  279. package/esm/resources/V2/Core/Vault/GbBankAccounts.js +0 -25
  280. package/esm/resources/V2/Core/Vault/UsBankAccounts.js +0 -21
  281. package/esm/resources/V2/MoneyManagement/Adjustments.js +0 -14
  282. package/esm/resources/V2/MoneyManagement/FinancialAccounts.js +0 -22
  283. package/esm/resources/V2/MoneyManagement/FinancialAddresses.js +0 -18
  284. package/esm/resources/V2/MoneyManagement/InboundTransfers.js +0 -18
  285. package/esm/resources/V2/MoneyManagement/OutboundPaymentQuotes.js +0 -13
  286. package/esm/resources/V2/MoneyManagement/OutboundPayments.js +0 -22
  287. package/esm/resources/V2/MoneyManagement/OutboundSetupIntents.js +0 -26
  288. package/esm/resources/V2/MoneyManagement/OutboundTransfers.js +0 -22
  289. package/esm/resources/V2/MoneyManagement/PayoutMethods.js +0 -22
  290. package/esm/resources/V2/MoneyManagement/PayoutMethodsBankAccountSpec.js +0 -9
  291. package/esm/resources/V2/MoneyManagement/ReceivedCredits.js +0 -14
  292. package/esm/resources/V2/MoneyManagement/ReceivedDebits.js +0 -14
  293. package/esm/resources/V2/MoneyManagement/TransactionEntries.js +0 -14
  294. package/esm/resources/V2/MoneyManagement/Transactions.js +0 -14
  295. package/esm/resources/V2/Payments/OffSessionPayments.js +0 -22
  296. package/esm/resources/V2/Reporting/ReportRuns.js +0 -10
  297. package/esm/resources/V2/Reporting/Reports.js +0 -9
  298. package/esm/resources/V2/Tax/AutomaticRules.js +0 -19
  299. package/esm/resources/V2/TestHelpers/FinancialAddresses.js +0 -13
  300. package/types/AccountNotices.d.ts +0 -113
  301. package/types/AccountNoticesResource.d.ts +0 -98
  302. package/types/Billing/MeterUsage.d.ts +0 -32
  303. package/types/Billing/MeterUsageResource.d.ts +0 -685
  304. package/types/Billing/MeterUsageRows.d.ts +0 -49
  305. package/types/Capital/FinancingOffers.d.ts +0 -188
  306. package/types/Capital/FinancingOffersResource.d.ts +0 -97
  307. package/types/Capital/FinancingSummary.d.ts +0 -106
  308. package/types/Capital/FinancingSummaryResource.d.ts +0 -27
  309. package/types/Capital/FinancingTransactions.d.ts +0 -135
  310. package/types/Capital/FinancingTransactionsResource.d.ts +0 -68
  311. package/types/ExternalAccountsResource.d.ts +0 -304
  312. package/types/FinancialConnections/AccountInferredBalances.d.ts +0 -38
  313. package/types/FinancialConnections/Institutions.d.ts +0 -98
  314. package/types/FinancialConnections/InstitutionsResource.d.ts +0 -47
  315. package/types/FxQuotes.d.ts +0 -155
  316. package/types/FxQuotesResource.d.ts +0 -130
  317. package/types/Issuing/CreditUnderwritingRecords.d.ts +0 -451
  318. package/types/Issuing/CreditUnderwritingRecordsResource.d.ts +0 -1032
  319. package/types/Issuing/DisputeSettlementDetails.d.ts +0 -85
  320. package/types/Issuing/DisputeSettlementDetailsResource.d.ts +0 -52
  321. package/types/Issuing/FraudLiabilityDebits.d.ts +0 -52
  322. package/types/Issuing/FraudLiabilityDebitsResource.d.ts +0 -52
  323. package/types/Issuing/Settlements.d.ts +0 -113
  324. package/types/Margins.d.ts +0 -56
  325. package/types/MarginsResource.d.ts +0 -114
  326. package/types/Orders.d.ts +0 -1163
  327. package/types/OrdersResource.d.ts +0 -3139
  328. package/types/PaymentAttemptRecords.d.ts +0 -2311
  329. package/types/PaymentAttemptRecordsResource.d.ts +0 -52
  330. package/types/PaymentIntentAmountDetailsLineItems.d.ts +0 -116
  331. package/types/PaymentRecords.d.ts +0 -2304
  332. package/types/PaymentRecordsResource.d.ts +0 -476
  333. package/types/Privacy/RedactionJobValidationErrors.d.ts +0 -60
  334. package/types/Privacy/RedactionJobs.d.ts +0 -111
  335. package/types/Privacy/RedactionJobsResource.d.ts +0 -230
  336. package/types/QuoteLines.d.ts +0 -634
  337. package/types/QuotePreviewInvoices.d.ts +0 -1751
  338. package/types/QuotePreviewSubscriptionSchedules.d.ts +0 -892
  339. package/types/Tax/Associations.d.ts +0 -82
  340. package/types/Tax/AssociationsResource.d.ts +0 -29
  341. package/types/Tax/Forms.d.ts +0 -220
  342. package/types/Tax/FormsResource.d.ts +0 -107
  343. package/types/Terminal/OnboardingLinks.d.ts +0 -57
  344. package/types/Terminal/OnboardingLinksResource.d.ts +0 -62
  345. package/types/Terminal/ReaderCollectedData.d.ts +0 -51
  346. package/types/Terminal/ReaderCollectedDataResource.d.ts +0 -29
  347. package/types/ThinEvent.d.ts +0 -36
  348. package/types/V2/Billing/BillSettingVersions.d.ts +0 -97
  349. package/types/V2/Billing/BillSettings/VersionsResource.d.ts +0 -58
  350. package/types/V2/Billing/BillSettings.d.ts +0 -120
  351. package/types/V2/Billing/BillSettingsResource.d.ts +0 -241
  352. package/types/V2/Billing/Cadences.d.ts +0 -360
  353. package/types/V2/Billing/CadencesResource.d.ts +0 -497
  354. package/types/V2/Billing/CollectionSettingVersions.d.ts +0 -314
  355. package/types/V2/Billing/CollectionSettings/VersionsResource.d.ts +0 -62
  356. package/types/V2/Billing/CollectionSettings.d.ts +0 -337
  357. package/types/V2/Billing/CollectionSettingsResource.d.ts +0 -675
  358. package/types/V2/Billing/CustomPricingUnits.d.ts +0 -56
  359. package/types/V2/Billing/CustomPricingUnitsResource.d.ts +0 -122
  360. package/types/V2/Billing/IntentActions.d.ts +0 -459
  361. package/types/V2/Billing/Intents/ActionsResource.d.ts +0 -58
  362. package/types/V2/Billing/Intents.d.ts +0 -117
  363. package/types/V2/Billing/IntentsResource.d.ts +0 -575
  364. package/types/V2/Billing/LicenseFeeSubscriptions.d.ts +0 -64
  365. package/types/V2/Billing/LicenseFeeSubscriptionsResource.d.ts +0 -28
  366. package/types/V2/Billing/LicenseFeeVersions.d.ts +0 -106
  367. package/types/V2/Billing/LicenseFees/VersionsResource.d.ts +0 -58
  368. package/types/V2/Billing/LicenseFees.d.ts +0 -163
  369. package/types/V2/Billing/LicenseFeesResource.d.ts +0 -290
  370. package/types/V2/Billing/LicensedItems.d.ts +0 -73
  371. package/types/V2/Billing/LicensedItemsResource.d.ts +0 -157
  372. package/types/V2/Billing/MeteredItems.d.ts +0 -101
  373. package/types/V2/Billing/MeteredItemsResource.d.ts +0 -189
  374. package/types/V2/Billing/PricingPlanComponents.d.ts +0 -109
  375. package/types/V2/Billing/PricingPlanSubscriptions.d.ts +0 -144
  376. package/types/V2/Billing/PricingPlanSubscriptionsResource.d.ts +0 -93
  377. package/types/V2/Billing/PricingPlanVersions.d.ts +0 -49
  378. package/types/V2/Billing/PricingPlans/ComponentsResource.d.ts +0 -197
  379. package/types/V2/Billing/PricingPlans/VersionsResource.d.ts +0 -58
  380. package/types/V2/Billing/PricingPlans.d.ts +0 -84
  381. package/types/V2/Billing/PricingPlansResource.d.ts +0 -151
  382. package/types/V2/Billing/Profiles.d.ts +0 -70
  383. package/types/V2/Billing/ProfilesResource.d.ts +0 -150
  384. package/types/V2/Billing/RateCardRates.d.ts +0 -138
  385. package/types/V2/Billing/RateCardSubscriptions.d.ts +0 -144
  386. package/types/V2/Billing/RateCardSubscriptionsResource.d.ts +0 -157
  387. package/types/V2/Billing/RateCardVersions.d.ts +0 -39
  388. package/types/V2/Billing/RateCards/RatesResource.d.ts +0 -209
  389. package/types/V2/Billing/RateCards/VersionsResource.d.ts +0 -58
  390. package/types/V2/Billing/RateCards.d.ts +0 -98
  391. package/types/V2/Billing/RateCardsResource.d.ts +0 -162
  392. package/types/V2/Billing/ServiceActions.d.ts +0 -264
  393. package/types/V2/Billing/ServiceActionsResource.d.ts +0 -326
  394. package/types/V2/Core/AccountLinks.d.ts +0 -168
  395. package/types/V2/Core/AccountLinksResource.d.ts +0 -152
  396. package/types/V2/Core/Accounts/PersonsResource.d.ts +0 -3812
  397. package/types/V2/Core/Accounts.d.ts +0 -8862
  398. package/types/V2/Core/AccountsResource.d.ts +0 -10704
  399. package/types/V2/Core/ClaimableSandboxes.d.ts +0 -387
  400. package/types/V2/Core/ClaimableSandboxesResource.d.ts +0 -329
  401. package/types/V2/Core/Persons.d.ts +0 -1888
  402. package/types/V2/Core/Vault/GbBankAccounts.d.ts +0 -160
  403. package/types/V2/Core/Vault/GbBankAccountsResource.d.ts +0 -172
  404. package/types/V2/Core/Vault/UsBankAccounts.d.ts +0 -70
  405. package/types/V2/Core/Vault/UsBankAccountsResource.d.ts +0 -123
  406. package/types/V2/EventDestinations.d.ts +0 -164
  407. package/types/V2/EventTypes.d.ts +0 -4319
  408. package/types/V2/Events.d.ts +0 -82
  409. package/types/V2/FinancialAddressCreditSimulations.d.ts +0 -27
  410. package/types/V2/FinancialAddressGeneratedMicrodeposits.d.ts +0 -32
  411. package/types/V2/MoneyManagement/Adjustments.d.ts +0 -110
  412. package/types/V2/MoneyManagement/AdjustmentsResource.d.ts +0 -83
  413. package/types/V2/MoneyManagement/FinancialAccounts.d.ts +0 -585
  414. package/types/V2/MoneyManagement/FinancialAccountsResource.d.ts +0 -331
  415. package/types/V2/MoneyManagement/FinancialAddresses.d.ts +0 -314
  416. package/types/V2/MoneyManagement/FinancialAddressesResource.d.ts +0 -289
  417. package/types/V2/MoneyManagement/InboundTransfers.d.ts +0 -206
  418. package/types/V2/MoneyManagement/InboundTransfersResource.d.ts +0 -144
  419. package/types/V2/MoneyManagement/OutboundPaymentQuotes.d.ts +0 -168
  420. package/types/V2/MoneyManagement/OutboundPaymentQuotesResource.d.ts +0 -115
  421. package/types/V2/MoneyManagement/OutboundPayments.d.ts +0 -278
  422. package/types/V2/MoneyManagement/OutboundPaymentsResource.d.ts +0 -242
  423. package/types/V2/MoneyManagement/OutboundSetupIntents.d.ts +0 -97
  424. package/types/V2/MoneyManagement/OutboundSetupIntentsResource.d.ts +0 -296
  425. package/types/V2/MoneyManagement/OutboundTransfers.d.ts +0 -251
  426. package/types/V2/MoneyManagement/OutboundTransfersResource.d.ts +0 -208
  427. package/types/V2/MoneyManagement/PayoutMethods.d.ts +0 -160
  428. package/types/V2/MoneyManagement/PayoutMethodsBankAccountSpecResource.d.ts +0 -41
  429. package/types/V2/MoneyManagement/PayoutMethodsBankAccountSpecs.d.ts +0 -87
  430. package/types/V2/MoneyManagement/PayoutMethodsResource.d.ts +0 -113
  431. package/types/V2/MoneyManagement/ReceivedCredits.d.ts +0 -262
  432. package/types/V2/MoneyManagement/ReceivedCreditsResource.d.ts +0 -78
  433. package/types/V2/MoneyManagement/ReceivedDebits.d.ts +0 -176
  434. package/types/V2/MoneyManagement/ReceivedDebitsResource.d.ts +0 -48
  435. package/types/V2/MoneyManagement/TransactionEntries.d.ts +0 -162
  436. package/types/V2/MoneyManagement/TransactionEntriesResource.d.ts +0 -82
  437. package/types/V2/MoneyManagement/Transactions.d.ts +0 -177
  438. package/types/V2/MoneyManagement/TransactionsResource.d.ts +0 -83
  439. package/types/V2/Payments/OffSessionPayments.d.ts +0 -179
  440. package/types/V2/Payments/OffSessionPaymentsResource.d.ts +0 -174
  441. package/types/V2/Reporting/ReportRuns.d.ts +0 -178
  442. package/types/V2/Reporting/ReportRunsResource.d.ts +0 -99
  443. package/types/V2/Reporting/Reports.d.ts +0 -120
  444. package/types/V2/Reporting/ReportsResource.d.ts +0 -30
  445. package/types/V2/Tax/AutomaticRules.d.ts +0 -53
  446. package/types/V2/Tax/AutomaticRulesResource.d.ts +0 -102
  447. package/types/V2/TestHelpers/FinancialAddressesResource.d.ts +0 -68
@@ -1,83 +0,0 @@
1
- // File generated from our OpenAPI spec
2
-
3
- declare module 'stripe' {
4
- namespace Stripe {
5
- namespace V2 {
6
- namespace MoneyManagement {
7
- interface TransactionRetrieveParams {}
8
- }
9
-
10
- namespace MoneyManagement {
11
- interface TransactionListParams {
12
- /**
13
- * Filter for Transactions created at an exact time.
14
- */
15
- created?: string;
16
-
17
- /**
18
- * Filter for Transactions created after the specified timestamp.
19
- */
20
- created_gt?: string;
21
-
22
- /**
23
- * Filter for Transactions created at or after the specified timestamp.
24
- */
25
- created_gte?: string;
26
-
27
- /**
28
- * Filter for Transactions created before the specified timestamp.
29
- */
30
- created_lt?: string;
31
-
32
- /**
33
- * Filter for Transactions created at or before the specified timestamp.
34
- */
35
- created_lte?: string;
36
-
37
- /**
38
- * Filter for Transactions belonging to a FinancialAccount.
39
- */
40
- financial_account?: string;
41
-
42
- /**
43
- * Filter for Transactions corresponding to a Flow.
44
- */
45
- flow?: string;
46
-
47
- /**
48
- * The page limit.
49
- */
50
- limit?: number;
51
- }
52
- }
53
-
54
- namespace MoneyManagement {
55
- class TransactionsResource {
56
- /**
57
- * Retrieves the details of a Transaction by ID.
58
- */
59
- retrieve(
60
- id: string,
61
- params?: TransactionRetrieveParams,
62
- options?: RequestOptions
63
- ): Promise<Stripe.Response<Stripe.V2.MoneyManagement.Transaction>>;
64
- retrieve(
65
- id: string,
66
- options?: RequestOptions
67
- ): Promise<Stripe.Response<Stripe.V2.MoneyManagement.Transaction>>;
68
-
69
- /**
70
- * Returns a list of Transactions that match the provided filters.
71
- */
72
- list(
73
- params?: TransactionListParams,
74
- options?: RequestOptions
75
- ): ApiListPromise<Stripe.V2.MoneyManagement.Transaction>;
76
- list(
77
- options?: RequestOptions
78
- ): ApiListPromise<Stripe.V2.MoneyManagement.Transaction>;
79
- }
80
- }
81
- }
82
- }
83
- }
@@ -1,179 +0,0 @@
1
- // File generated from our OpenAPI spec
2
-
3
- declare module 'stripe' {
4
- namespace Stripe {
5
- namespace V2 {
6
- namespace Payments {
7
- /**
8
- * OffSessionPayment resource.
9
- */
10
- interface OffSessionPayment {
11
- /**
12
- * Unique identifier for the object..
13
- */
14
- id: string;
15
-
16
- /**
17
- * String representing the object's type. Objects of the same type share the same value of the object field.
18
- */
19
- object: 'v2.payments.off_session_payment';
20
-
21
- /**
22
- * The “presentment amount” to be collected from the customer.
23
- */
24
- amount_requested: Amount;
25
-
26
- /**
27
- * The frequency of the underlying payment.
28
- */
29
- cadence: OffSessionPayment.Cadence;
30
-
31
- /**
32
- * ID of the owning compartment.
33
- */
34
- compartment_id: string;
35
-
36
- /**
37
- * Creation time of the OffSessionPayment. Represented as a RFC 3339 date & time UTC
38
- * value in millisecond precision, for example: 2022-09-18T13:22:18.123Z.
39
- */
40
- created: string;
41
-
42
- /**
43
- * ID of the Customer to which this OffSessionPayment belongs.
44
- */
45
- customer: string;
46
-
47
- /**
48
- * The reason why the OffSessionPayment failed.
49
- */
50
- failure_reason: OffSessionPayment.FailureReason | null;
51
-
52
- /**
53
- * The payment error encountered in the previous attempt to authorize the payment.
54
- */
55
- last_authorization_attempt_error: string | null;
56
-
57
- /**
58
- * Payment attempt record for the latest attempt, if one exists.
59
- */
60
- latest_payment_attempt_record: string | null;
61
-
62
- /**
63
- * Has the value true if the object exists in live mode or the value false if the object exists in test mode.
64
- */
65
- livemode: boolean;
66
-
67
- /**
68
- * Set of [key-value pairs](https://docs.corp.stripe.com/api/metadata) that you can
69
- * attach to an object. This can be useful for storing additional information about
70
- * the object in a structured format. Learn more about
71
- * [storing information in metadata](https://docs.corp.stripe.com/payments/payment-intents#storing-information-in-metadata).
72
- */
73
- metadata: Stripe.Metadata;
74
-
75
- /**
76
- * The account (if any) for which the funds of the OffSessionPayment are intended.
77
- */
78
- on_behalf_of: string | null;
79
-
80
- /**
81
- * ID of the payment method used in this OffSessionPayment.
82
- */
83
- payment_method: string;
84
-
85
- /**
86
- * Payment record associated with the OffSessionPayment.
87
- */
88
- payment_record: string | null;
89
-
90
- /**
91
- * Details about the OffSessionPayment retries.
92
- */
93
- retry_details: OffSessionPayment.RetryDetails;
94
-
95
- /**
96
- * Text that appears on the customer's statement as the statement descriptor for a
97
- * non-card charge. This value overrides the account's default statement descriptor.
98
- * For information about requirements, including the 22-character limit, see the
99
- * [Statement Descriptor docs](https://docs.stripe.com/get-started/account/statement-descriptors).
100
- */
101
- statement_descriptor: string | null;
102
-
103
- /**
104
- * Provides information about a card charge. Concatenated to the account's
105
- * [statement descriptor prefix](https://docs.stripe.com/get-started/account/statement-descriptors#static)
106
- * to form the complete statement descriptor that appears on the customer's statement.
107
- */
108
- statement_descriptor_suffix: string | null;
109
-
110
- /**
111
- * Status of this OffSessionPayment, one of `pending`, `pending_retry`, `processing`,
112
- * `failed`, `canceled`, `requires_capture`, or `succeeded`.
113
- */
114
- status: OffSessionPayment.Status;
115
-
116
- /**
117
- * Test clock that can be used to advance the retry attempts in a sandbox.
118
- */
119
- test_clock: string | null;
120
-
121
- /**
122
- * The data that automatically creates a Transfer after the payment finalizes. Learn more about the use case for [connected accounts](https://docs.corp.stripe.com/payments/connected-accounts).
123
- */
124
- transfer_data: OffSessionPayment.TransferData | null;
125
- }
126
-
127
- namespace OffSessionPayment {
128
- type Cadence = 'recurring' | 'unscheduled';
129
-
130
- type FailureReason = 'rejected_by_partner' | 'retries_exhausted';
131
-
132
- interface RetryDetails {
133
- /**
134
- * Number of authorization attempts so far.
135
- */
136
- attempts: number;
137
-
138
- /**
139
- * Indicates the strategy for how you want Stripe to retry the payment.
140
- */
141
- retry_strategy: RetryDetails.RetryStrategy;
142
- }
143
-
144
- namespace RetryDetails {
145
- type RetryStrategy = 'none' | 'smart';
146
- }
147
-
148
- type Status =
149
- | 'canceled'
150
- | 'failed'
151
- | 'pending'
152
- | 'pending_retry'
153
- | 'processing'
154
- | 'requires_capture'
155
- | 'succeeded';
156
-
157
- interface TransferData {
158
- /**
159
- * The amount transferred to the destination account. This transfer will occur
160
- * automatically after the payment succeeds. If no amount is specified, by default
161
- * the entire payment amount is transferred to the destination account. The amount
162
- * must be less than or equal to the
163
- * [amount_requested](https://docs.corp.stripe.com/api/v2/off-session-payments/object?api-version=2025-05-28.preview#v2_off_session_payment_object-amount_requested),
164
- * and must be a positive integer representing how much to transfer in the smallest
165
- * currency unit (e.g., 100 cents to charge $1.00).
166
- */
167
- amount: number | null;
168
-
169
- /**
170
- * The account (if any) that the payment is attributed to for tax reporting, and
171
- * where funds from the payment are transferred to after payment success.
172
- */
173
- destination: string;
174
- }
175
- }
176
- }
177
- }
178
- }
179
- }
@@ -1,174 +0,0 @@
1
- // File generated from our OpenAPI spec
2
-
3
- declare module 'stripe' {
4
- namespace Stripe {
5
- namespace V2 {
6
- namespace Payments {
7
- interface OffSessionPaymentCreateParams {
8
- /**
9
- * The “presentment amount” to be collected from the customer.
10
- */
11
- amount: Amount;
12
-
13
- /**
14
- * The frequency of the underlying payment.
15
- */
16
- cadence: OffSessionPaymentCreateParams.Cadence;
17
-
18
- /**
19
- * ID of the Customer to which this OffSessionPayment belongs.
20
- */
21
- customer: string;
22
-
23
- /**
24
- * Set of [key-value pairs](https://docs.corp.stripe.com/api/metadata) that you can
25
- * attach to an object. This can be useful for storing additional information about
26
- * the object in a structured format. Learn more about
27
- * [storing information in metadata](https://docs.corp.stripe.com/payments/payment-intents#storing-information-in-metadata).
28
- */
29
- metadata: Stripe.MetadataParam;
30
-
31
- /**
32
- * ID of the payment method used in this OffSessionPayment.
33
- */
34
- payment_method: string;
35
-
36
- /**
37
- * The account (if any) for which the funds of the OffSessionPayment are intended.
38
- */
39
- on_behalf_of?: string;
40
-
41
- /**
42
- * Details about the OffSessionPayment retries.
43
- */
44
- retry_details?: OffSessionPaymentCreateParams.RetryDetails;
45
-
46
- /**
47
- * Text that appears on the customer's statement as the statement descriptor for a
48
- * non-card charge. This value overrides the account's default statement descriptor.
49
- * For information about requirements, including the 22-character limit, see the
50
- * [Statement Descriptor docs](https://docs.stripe.com/get-started/account/statement-descriptors).
51
- */
52
- statement_descriptor?: string;
53
-
54
- /**
55
- * Provides information about a card charge. Concatenated to the account's
56
- * [statement descriptor prefix](https://docs.stripe.com/get-started/account/statement-descriptors#static)
57
- * to form the complete statement descriptor that appears on the customer's statement.
58
- */
59
- statement_descriptor_suffix?: string;
60
-
61
- /**
62
- * Test clock that can be used to advance the retry attempts in a sandbox.
63
- */
64
- test_clock?: string;
65
-
66
- /**
67
- * The data that automatically creates a Transfer after the payment finalizes. Learn more about the use case for [connected accounts](https://docs.corp.stripe.com/payments/connected-accounts).
68
- */
69
- transfer_data?: OffSessionPaymentCreateParams.TransferData;
70
- }
71
-
72
- namespace OffSessionPaymentCreateParams {
73
- type Cadence = 'recurring' | 'unscheduled';
74
-
75
- interface RetryDetails {
76
- /**
77
- * Indicates the strategy for how you want Stripe to retry the payment.
78
- */
79
- retry_strategy: RetryDetails.RetryStrategy;
80
- }
81
-
82
- namespace RetryDetails {
83
- type RetryStrategy = 'none' | 'smart';
84
- }
85
-
86
- interface TransferData {
87
- /**
88
- * The amount transferred to the destination account. This transfer will occur
89
- * automatically after the payment succeeds. If no amount is specified, by default
90
- * the entire payment amount is transferred to the destination account. The amount
91
- * must be less than or equal to the
92
- * [amount_requested](https://docs.corp.stripe.com/api/v2/off-session-payments/object?api-version=2025-05-28.preview#v2_off_session_payment_object-amount_requested),
93
- * and must be a positive integer representing how much to transfer in the smallest
94
- * currency unit (e.g., 100 cents to charge $1.00).
95
- */
96
- amount?: number;
97
-
98
- /**
99
- * The account (if any) that the payment is attributed to for tax reporting, and
100
- * where funds from the payment are transferred to after payment success.
101
- */
102
- destination: string;
103
- }
104
- }
105
- }
106
-
107
- namespace Payments {
108
- interface OffSessionPaymentRetrieveParams {}
109
- }
110
-
111
- namespace Payments {
112
- interface OffSessionPaymentListParams {
113
- /**
114
- * The page size limit. If not provided, the default is 20.
115
- */
116
- limit?: number;
117
- }
118
- }
119
-
120
- namespace Payments {
121
- interface OffSessionPaymentCancelParams {}
122
- }
123
-
124
- namespace Payments {
125
- class OffSessionPaymentsResource {
126
- /**
127
- * Creates an OffSessionPayment object.
128
- */
129
- create(
130
- params: OffSessionPaymentCreateParams,
131
- options?: RequestOptions
132
- ): Promise<Stripe.Response<Stripe.V2.Payments.OffSessionPayment>>;
133
-
134
- /**
135
- * Retrieves the details of an OffSessionPayment that has previously been created.
136
- */
137
- retrieve(
138
- id: string,
139
- params?: OffSessionPaymentRetrieveParams,
140
- options?: RequestOptions
141
- ): Promise<Stripe.Response<Stripe.V2.Payments.OffSessionPayment>>;
142
- retrieve(
143
- id: string,
144
- options?: RequestOptions
145
- ): Promise<Stripe.Response<Stripe.V2.Payments.OffSessionPayment>>;
146
-
147
- /**
148
- * Returns a list of OffSessionPayments matching a filter.
149
- */
150
- list(
151
- params?: OffSessionPaymentListParams,
152
- options?: RequestOptions
153
- ): ApiListPromise<Stripe.V2.Payments.OffSessionPayment>;
154
- list(
155
- options?: RequestOptions
156
- ): ApiListPromise<Stripe.V2.Payments.OffSessionPayment>;
157
-
158
- /**
159
- * Cancel an OffSessionPayment that has previously been created.
160
- */
161
- cancel(
162
- id: string,
163
- params?: OffSessionPaymentCancelParams,
164
- options?: RequestOptions
165
- ): Promise<Stripe.Response<Stripe.V2.Payments.OffSessionPayment>>;
166
- cancel(
167
- id: string,
168
- options?: RequestOptions
169
- ): Promise<Stripe.Response<Stripe.V2.Payments.OffSessionPayment>>;
170
- }
171
- }
172
- }
173
- }
174
- }
@@ -1,178 +0,0 @@
1
- // File generated from our OpenAPI spec
2
-
3
- declare module 'stripe' {
4
- namespace Stripe {
5
- namespace V2 {
6
- namespace Reporting {
7
- /**
8
- * The `ReportRun` object represents an instance of a `Report` generated with specific
9
- * run parameters. Once the object is created, Stripe begins processing the report. When
10
- * the report has finished running, it will give you a reference to the results.
11
- */
12
- interface ReportRun {
13
- /**
14
- * The unique identifier of the `ReportRun` object.
15
- */
16
- id: string;
17
-
18
- /**
19
- * String representing the object's type. Objects of the same type share the same value of the object field.
20
- */
21
- object: 'v2.reporting.report_run';
22
-
23
- /**
24
- * Time at which the object was created.
25
- */
26
- created: string;
27
-
28
- /**
29
- * Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
30
- */
31
- livemode: boolean;
32
-
33
- /**
34
- * The unique identifier of the `Report` object which was run.
35
- */
36
- report: string;
37
-
38
- /**
39
- * The human-readable name of the `Report` which was run.
40
- */
41
- report_name: string;
42
-
43
- /**
44
- * The parameters used to customize the generation of the report.
45
- */
46
- report_parameters: {
47
- [key: string]: ReportRun.ReportParameters;
48
- };
49
-
50
- /**
51
- * Details how to retrieve the results of a successfully completed `ReportRun`.
52
- */
53
- result: ReportRun.Result | null;
54
-
55
- /**
56
- * The options specified for customizing the output file of the `ReportRun`.
57
- */
58
- result_options: ReportRun.ResultOptions | null;
59
-
60
- /**
61
- * The current status of the `ReportRun`.
62
- */
63
- status: ReportRun.Status;
64
-
65
- /**
66
- * Additional details about the current state of the `ReportRun`. The field is currently only populated when a `ReportRun`
67
- * is in the `failed` state, providing more information about why the report failed to generate successfully.
68
- */
69
- status_details: {
70
- [key: string]: ReportRun.StatusDetails;
71
- };
72
- }
73
-
74
- namespace ReportRun {
75
- interface ReportParameters {
76
- /**
77
- * Parameter with an array data type.
78
- */
79
- array_value: ReportParameters.ArrayValue | null;
80
-
81
- /**
82
- * Parameter with a string data type.
83
- */
84
- string_value: string | null;
85
-
86
- /**
87
- * Parameter with a timestamp data type.
88
- */
89
- timestamp_value: string | null;
90
- }
91
-
92
- namespace ReportParameters {
93
- interface ArrayValue {
94
- /**
95
- * The list of string values in the array.
96
- */
97
- items: Array<string>;
98
- }
99
- }
100
-
101
- interface Result {
102
- /**
103
- * Contains metadata about the file produced by the `ReportRun`, including
104
- * its content type, size, and a URL to download its contents.
105
- */
106
- file: Result.File;
107
-
108
- /**
109
- * The type of the `ReportRun` result.
110
- */
111
- type: 'file';
112
- }
113
-
114
- namespace Result {
115
- interface File {
116
- /**
117
- * The content type of the file.
118
- */
119
- content_type: File.ContentType;
120
-
121
- /**
122
- * A pre-signed URL that allows secure, time-limited access to download the file.
123
- */
124
- download_url: File.DownloadUrl;
125
-
126
- /**
127
- * The total size of the file in bytes.
128
- */
129
- size: number;
130
- }
131
-
132
- namespace File {
133
- type ContentType = 'csv' | 'zip';
134
-
135
- interface DownloadUrl {
136
- /**
137
- * The time that the URL expires.
138
- */
139
- expires_at: string | null;
140
-
141
- /**
142
- * The URL that can be used for accessing the file.
143
- */
144
- url: string;
145
- }
146
- }
147
- }
148
-
149
- interface ResultOptions {
150
- /**
151
- * If set, the generated report file will be compressed into a ZIP folder.
152
- * This is useful for reducing file size and download time for large reports.
153
- */
154
- compress_file: boolean | null;
155
- }
156
-
157
- type Status = 'failed' | 'running' | 'succeeded';
158
-
159
- interface StatusDetails {
160
- /**
161
- * Error code categorizing the reason the `ReportRun` failed.
162
- */
163
- error_code: StatusDetails.ErrorCode | null;
164
-
165
- /**
166
- * Error message with additional details about the failure.
167
- */
168
- error_message: string | null;
169
- }
170
-
171
- namespace StatusDetails {
172
- type ErrorCode = 'file_size_above_limit' | 'internal_error';
173
- }
174
- }
175
- }
176
- }
177
- }
178
- }