stripe 18.2.0-beta.1 → 18.2.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 (333) hide show
  1. package/CHANGELOG.md +179 -1211
  2. package/OPENAPI_VERSION +1 -1
  3. package/README.md +11 -12
  4. package/VERSION +1 -1
  5. package/cjs/Error.js +1 -91
  6. package/cjs/RequestSender.js +2 -2
  7. package/cjs/StripeResource.js +1 -1
  8. package/cjs/apiVersion.js +1 -1
  9. package/cjs/resources/FinancialConnections/Accounts.js +0 -5
  10. package/cjs/resources/{PaymentAttemptRecords.js → InvoicePayments.js} +4 -4
  11. package/cjs/resources/PaymentIntents.js +0 -13
  12. package/cjs/resources/Quotes.js +0 -32
  13. package/cjs/resources/SubscriptionSchedules.js +0 -4
  14. package/cjs/resources/Terminal/Readers.js +0 -8
  15. package/cjs/resources.js +18 -108
  16. package/cjs/stripe.core.js +1 -1
  17. package/cjs/utils.js +5 -0
  18. package/esm/Error.js +0 -79
  19. package/esm/RequestSender.js +2 -2
  20. package/esm/StripeResource.js +1 -1
  21. package/esm/apiVersion.js +1 -1
  22. package/esm/resources/FinancialConnections/Accounts.js +0 -5
  23. package/esm/resources/{PaymentAttemptRecords.js → InvoicePayments.js} +3 -3
  24. package/esm/resources/PaymentIntents.js +0 -13
  25. package/esm/resources/Quotes.js +0 -32
  26. package/esm/resources/SubscriptionSchedules.js +0 -4
  27. package/esm/resources/Terminal/Readers.js +0 -8
  28. package/esm/resources.js +1 -84
  29. package/esm/stripe.core.js +1 -1
  30. package/esm/utils.js +5 -0
  31. package/package.json +1 -1
  32. package/types/AccountLinksResource.d.ts +1 -5
  33. package/types/AccountSessions.d.ts +52 -32
  34. package/types/AccountSessionsResource.d.ts +23 -246
  35. package/types/Accounts.d.ts +19 -223
  36. package/types/AccountsResource.d.ts +61 -581
  37. package/types/Balance.d.ts +83 -1
  38. package/types/BalanceResource.d.ts +1 -1
  39. package/types/BalanceTransactions.d.ts +10 -0
  40. package/types/BankAccounts.d.ts +3 -3
  41. package/types/Billing/Alerts.d.ts +1 -1
  42. package/types/Billing/AlertsResource.d.ts +2 -2
  43. package/types/Billing/CreditBalanceSummary.d.ts +0 -5
  44. package/types/Billing/CreditBalanceSummaryResource.d.ts +3 -8
  45. package/types/Billing/CreditBalanceTransactionsResource.d.ts +4 -12
  46. package/types/Billing/CreditGrants.d.ts +0 -5
  47. package/types/Billing/CreditGrantsResource.d.ts +1 -11
  48. package/types/BillingPortal/Sessions.d.ts +1 -6
  49. package/types/BillingPortal/SessionsResource.d.ts +4 -12
  50. package/types/Capabilities.d.ts +1 -1
  51. package/types/Cards.d.ts +2 -7
  52. package/types/CashBalances.d.ts +0 -5
  53. package/types/Charges.d.ts +20 -166
  54. package/types/ChargesResource.d.ts +4 -1318
  55. package/types/Checkout/Sessions.d.ts +120 -418
  56. package/types/Checkout/SessionsResource.d.ts +118 -448
  57. package/types/ConfirmationTokens.d.ts +4 -129
  58. package/types/CountrySpecs.d.ts +1 -1
  59. package/types/Coupons.d.ts +0 -33
  60. package/types/CouponsResource.d.ts +0 -21
  61. package/types/CreditNoteLineItems.d.ts +0 -17
  62. package/types/CreditNotes.d.ts +11 -10
  63. package/types/CreditNotesResource.d.ts +7 -13
  64. package/types/CustomerBalanceTransactions.d.ts +0 -2
  65. package/types/CustomerCashBalanceTransactions.d.ts +0 -2
  66. package/types/CustomerSessions.d.ts +3 -8
  67. package/types/CustomerSessionsResource.d.ts +1 -6
  68. package/types/Customers.d.ts +0 -2
  69. package/types/CustomersResource.d.ts +7 -15
  70. package/types/Discounts.d.ts +0 -10
  71. package/types/Disputes.d.ts +1 -1
  72. package/types/DisputesResource.d.ts +1 -1
  73. package/types/Errors.d.ts +2 -69
  74. package/types/EventTypes.d.ts +17 -698
  75. package/types/Events.d.ts +4 -99
  76. package/types/Files.d.ts +1 -1
  77. package/types/FilesResource.d.ts +1 -1
  78. package/types/FinancialConnections/Accounts.d.ts +1 -31
  79. package/types/FinancialConnections/AccountsResource.d.ts +3 -40
  80. package/types/FinancialConnections/Sessions.d.ts +1 -51
  81. package/types/FinancialConnections/SessionsResource.d.ts +1 -43
  82. package/types/Identity/VerificationReports.d.ts +17 -0
  83. package/types/Identity/VerificationSessions.d.ts +19 -7
  84. package/types/Identity/VerificationSessionsResource.d.ts +5 -12
  85. package/types/InvoiceItems.d.ts +1 -11
  86. package/types/InvoiceItemsResource.d.ts +6 -117
  87. package/types/InvoiceLineItems.d.ts +2 -46
  88. package/types/InvoicePayments.d.ts +9 -7
  89. package/types/InvoicePaymentsResource.d.ts +74 -0
  90. package/types/Invoices.d.ts +10 -142
  91. package/types/InvoicesResource.d.ts +66 -1469
  92. package/types/Issuing/AuthorizationsResource.d.ts +4 -4
  93. package/types/Issuing/CardholdersResource.d.ts +1 -2
  94. package/types/Issuing/CardsResource.d.ts +3 -0
  95. package/types/Issuing/DisputesResource.d.ts +2 -2
  96. package/types/Issuing/Transactions.d.ts +0 -5
  97. package/types/Issuing/TransactionsResource.d.ts +0 -5
  98. package/types/LineItems.d.ts +2 -51
  99. package/types/Mandates.d.ts +0 -77
  100. package/types/PaymentIntents.d.ts +145 -856
  101. package/types/PaymentIntentsResource.d.ts +4307 -8780
  102. package/types/PaymentLinks.d.ts +0 -6
  103. package/types/PaymentLinksResource.d.ts +0 -12
  104. package/types/PaymentMethodConfigurations.d.ts +70 -70
  105. package/types/PaymentMethodConfigurationsResource.d.ts +164 -164
  106. package/types/PaymentMethodDomainsResource.d.ts +1 -1
  107. package/types/PaymentMethods.d.ts +4 -129
  108. package/types/PaymentMethodsResource.d.ts +10 -175
  109. package/types/Payouts.d.ts +2 -7
  110. package/types/PayoutsResource.d.ts +2 -7
  111. package/types/Persons.d.ts +10 -10
  112. package/types/PlansResource.d.ts +1 -1
  113. package/types/Prices.d.ts +0 -22
  114. package/types/PricesResource.d.ts +2 -24
  115. package/types/Products.d.ts +0 -39
  116. package/types/ProductsResource.d.ts +1 -37
  117. package/types/PromotionCodes.d.ts +0 -5
  118. package/types/PromotionCodesResource.d.ts +1 -11
  119. package/types/Quotes.d.ts +7 -609
  120. package/types/QuotesResource.d.ts +224 -2578
  121. package/types/Radar/EarlyFraudWarningsResource.d.ts +1 -1
  122. package/types/Refunds.d.ts +6 -15
  123. package/types/Reviews.d.ts +1 -1
  124. package/types/SetupAttempts.d.ts +2 -50
  125. package/types/SetupIntents.d.ts +4 -122
  126. package/types/SetupIntentsResource.d.ts +6 -733
  127. package/types/Sources.d.ts +0 -29
  128. package/types/SourcesResource.d.ts +1 -1
  129. package/types/SubscriptionItems.d.ts +8 -17
  130. package/types/SubscriptionItemsResource.d.ts +28 -109
  131. package/types/SubscriptionSchedules.d.ts +47 -213
  132. package/types/SubscriptionSchedulesResource.d.ts +104 -1243
  133. package/types/Subscriptions.d.ts +16 -102
  134. package/types/SubscriptionsResource.d.ts +80 -407
  135. package/types/Tax/CalculationLineItems.d.ts +5 -0
  136. package/types/Tax/CalculationsResource.d.ts +5 -0
  137. package/types/Tax/RegistrationsResource.d.ts +1 -1
  138. package/types/TaxIds.d.ts +0 -10
  139. package/types/TaxIdsResource.d.ts +0 -10
  140. package/types/TaxRates.d.ts +2 -2
  141. package/types/Terminal/LocationsResource.d.ts +1 -1
  142. package/types/Terminal/Readers.d.ts +7 -89
  143. package/types/Terminal/ReadersResource.d.ts +6 -82
  144. package/types/TestHelpers/ConfirmationTokensResource.d.ts +0 -126
  145. package/types/TestHelpers/Treasury/ReceivedCreditsResource.d.ts +0 -26
  146. package/types/TestHelpers/Treasury/ReceivedDebitsResource.d.ts +0 -26
  147. package/types/Tokens.d.ts +3 -3
  148. package/types/TokensResource.d.ts +8 -8
  149. package/types/TransferReversals.d.ts +1 -1
  150. package/types/Transfers.d.ts +0 -5
  151. package/types/TransfersResource.d.ts +2 -7
  152. package/types/Treasury/FinancialAccountFeatures.d.ts +0 -7
  153. package/types/Treasury/FinancialAccounts.d.ts +0 -5
  154. package/types/Treasury/FinancialAccountsResource.d.ts +0 -37
  155. package/types/Treasury/OutboundTransfers.d.ts +0 -26
  156. package/types/Treasury/OutboundTransfersResource.d.ts +0 -26
  157. package/types/Treasury/ReceivedCredits.d.ts +2 -28
  158. package/types/Treasury/ReceivedDebits.d.ts +0 -31
  159. package/types/V2/EventTypes.d.ts +1 -812
  160. package/types/WebhookEndpointsResource.d.ts +4 -83
  161. package/types/index.d.ts +5 -145
  162. package/types/lib.d.ts +1 -11
  163. package/types/test/typescriptTest.ts +3 -3
  164. package/cjs/resources/AccountNotices.js +0 -21
  165. package/cjs/resources/BalanceSettings.js +0 -10
  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/GiftCards/Cards.js +0 -23
  173. package/cjs/resources/GiftCards/Transactions.js +0 -33
  174. package/cjs/resources/Issuing/CreditUnderwritingRecords.js +0 -33
  175. package/cjs/resources/Issuing/DisputeSettlementDetails.js +0 -17
  176. package/cjs/resources/Issuing/FraudLiabilityDebits.js +0 -17
  177. package/cjs/resources/Margins.js +0 -22
  178. package/cjs/resources/Orders.js +0 -24
  179. package/cjs/resources/PaymentRecords.js +0 -29
  180. package/cjs/resources/Privacy/RedactionJobs.js +0 -42
  181. package/cjs/resources/Tax/Associations.js +0 -9
  182. package/cjs/resources/Tax/Forms.js +0 -20
  183. package/cjs/resources/Terminal/ReaderCollectedData.js +0 -12
  184. package/cjs/resources/V2/Core/AccountLinks.js +0 -9
  185. package/cjs/resources/V2/Core/Accounts/Persons.js +0 -29
  186. package/cjs/resources/V2/Core/Accounts.js +0 -25
  187. package/cjs/resources/V2/Core/Vault/GbBankAccounts.js +0 -28
  188. package/cjs/resources/V2/Core/Vault/UsBankAccounts.js +0 -24
  189. package/cjs/resources/V2/MoneyManagement/Adjustments.js +0 -17
  190. package/cjs/resources/V2/MoneyManagement/FinancialAccounts.js +0 -17
  191. package/cjs/resources/V2/MoneyManagement/FinancialAddresses.js +0 -21
  192. package/cjs/resources/V2/MoneyManagement/InboundTransfers.js +0 -21
  193. package/cjs/resources/V2/MoneyManagement/OutboundPaymentQuotes.js +0 -16
  194. package/cjs/resources/V2/MoneyManagement/OutboundPayments.js +0 -25
  195. package/cjs/resources/V2/MoneyManagement/OutboundSetupIntents.js +0 -29
  196. package/cjs/resources/V2/MoneyManagement/OutboundTransfers.js +0 -25
  197. package/cjs/resources/V2/MoneyManagement/PayoutMethods.js +0 -25
  198. package/cjs/resources/V2/MoneyManagement/PayoutMethodsBankAccountSpec.js +0 -12
  199. package/cjs/resources/V2/MoneyManagement/ReceivedCredits.js +0 -17
  200. package/cjs/resources/V2/MoneyManagement/ReceivedDebits.js +0 -17
  201. package/cjs/resources/V2/MoneyManagement/TransactionEntries.js +0 -17
  202. package/cjs/resources/V2/MoneyManagement/Transactions.js +0 -17
  203. package/cjs/resources/V2/TestHelpers/FinancialAddresses.js +0 -16
  204. package/esm/resources/AccountNotices.js +0 -18
  205. package/esm/resources/BalanceSettings.js +0 -7
  206. package/esm/resources/Capital/FinancingOffers.js +0 -18
  207. package/esm/resources/Capital/FinancingSummary.js +0 -9
  208. package/esm/resources/Capital/FinancingTransactions.js +0 -14
  209. package/esm/resources/ExternalAccounts.js +0 -20
  210. package/esm/resources/FinancialConnections/Institutions.js +0 -14
  211. package/esm/resources/FxQuotes.js +0 -12
  212. package/esm/resources/GiftCards/Cards.js +0 -20
  213. package/esm/resources/GiftCards/Transactions.js +0 -30
  214. package/esm/resources/Issuing/CreditUnderwritingRecords.js +0 -30
  215. package/esm/resources/Issuing/DisputeSettlementDetails.js +0 -14
  216. package/esm/resources/Issuing/FraudLiabilityDebits.js +0 -14
  217. package/esm/resources/Margins.js +0 -19
  218. package/esm/resources/Orders.js +0 -21
  219. package/esm/resources/PaymentRecords.js +0 -26
  220. package/esm/resources/Privacy/RedactionJobs.js +0 -39
  221. package/esm/resources/Tax/Associations.js +0 -6
  222. package/esm/resources/Tax/Forms.js +0 -17
  223. package/esm/resources/Terminal/ReaderCollectedData.js +0 -9
  224. package/esm/resources/V2/Core/AccountLinks.js +0 -6
  225. package/esm/resources/V2/Core/Accounts/Persons.js +0 -26
  226. package/esm/resources/V2/Core/Accounts.js +0 -22
  227. package/esm/resources/V2/Core/Vault/GbBankAccounts.js +0 -25
  228. package/esm/resources/V2/Core/Vault/UsBankAccounts.js +0 -21
  229. package/esm/resources/V2/MoneyManagement/Adjustments.js +0 -14
  230. package/esm/resources/V2/MoneyManagement/FinancialAccounts.js +0 -14
  231. package/esm/resources/V2/MoneyManagement/FinancialAddresses.js +0 -18
  232. package/esm/resources/V2/MoneyManagement/InboundTransfers.js +0 -18
  233. package/esm/resources/V2/MoneyManagement/OutboundPaymentQuotes.js +0 -13
  234. package/esm/resources/V2/MoneyManagement/OutboundPayments.js +0 -22
  235. package/esm/resources/V2/MoneyManagement/OutboundSetupIntents.js +0 -26
  236. package/esm/resources/V2/MoneyManagement/OutboundTransfers.js +0 -22
  237. package/esm/resources/V2/MoneyManagement/PayoutMethods.js +0 -22
  238. package/esm/resources/V2/MoneyManagement/PayoutMethodsBankAccountSpec.js +0 -9
  239. package/esm/resources/V2/MoneyManagement/ReceivedCredits.js +0 -14
  240. package/esm/resources/V2/MoneyManagement/ReceivedDebits.js +0 -14
  241. package/esm/resources/V2/MoneyManagement/TransactionEntries.js +0 -14
  242. package/esm/resources/V2/MoneyManagement/Transactions.js +0 -14
  243. package/esm/resources/V2/TestHelpers/FinancialAddresses.js +0 -13
  244. package/types/AccountNotices.d.ts +0 -113
  245. package/types/AccountNoticesResource.d.ts +0 -98
  246. package/types/BalanceSettings.d.ts +0 -89
  247. package/types/BalanceSettingsResource.d.ts +0 -108
  248. package/types/Billing/MeterErrorReports.d.ts +0 -106
  249. package/types/Capital/FinancingOffers.d.ts +0 -188
  250. package/types/Capital/FinancingOffersResource.d.ts +0 -97
  251. package/types/Capital/FinancingSummary.d.ts +0 -106
  252. package/types/Capital/FinancingSummaryResource.d.ts +0 -27
  253. package/types/Capital/FinancingTransactions.d.ts +0 -135
  254. package/types/Capital/FinancingTransactionsResource.d.ts +0 -68
  255. package/types/ExternalAccountsResource.d.ts +0 -304
  256. package/types/FinancialConnections/AccountInferredBalances.d.ts +0 -38
  257. package/types/FinancialConnections/Institutions.d.ts +0 -93
  258. package/types/FinancialConnections/InstitutionsResource.d.ts +0 -47
  259. package/types/FxQuotes.d.ts +0 -153
  260. package/types/FxQuotesResource.d.ts +0 -130
  261. package/types/GiftCards/Cards.d.ts +0 -118
  262. package/types/GiftCards/CardsResource.d.ts +0 -159
  263. package/types/GiftCards/Transactions.d.ts +0 -129
  264. package/types/GiftCards/TransactionsResource.d.ts +0 -201
  265. package/types/Issuing/CreditUnderwritingRecords.d.ts +0 -451
  266. package/types/Issuing/CreditUnderwritingRecordsResource.d.ts +0 -1032
  267. package/types/Issuing/DisputeSettlementDetails.d.ts +0 -85
  268. package/types/Issuing/DisputeSettlementDetailsResource.d.ts +0 -52
  269. package/types/Issuing/FraudLiabilityDebits.d.ts +0 -52
  270. package/types/Issuing/FraudLiabilityDebitsResource.d.ts +0 -52
  271. package/types/Issuing/Settlements.d.ts +0 -113
  272. package/types/Margins.d.ts +0 -56
  273. package/types/MarginsResource.d.ts +0 -114
  274. package/types/Orders.d.ts +0 -1199
  275. package/types/OrdersResource.d.ts +0 -3001
  276. package/types/PaymentAttemptRecords.d.ts +0 -2112
  277. package/types/PaymentAttemptRecordsResource.d.ts +0 -47
  278. package/types/PaymentIntentAmountDetailsLineItems.d.ts +0 -110
  279. package/types/PaymentRecords.d.ts +0 -2105
  280. package/types/PaymentRecordsResource.d.ts +0 -455
  281. package/types/Privacy/RedactionJobValidationErrors.d.ts +0 -30
  282. package/types/Privacy/RedactionJobs.d.ts +0 -65
  283. package/types/Privacy/RedactionJobsResource.d.ts +0 -218
  284. package/types/QuoteLines.d.ts +0 -634
  285. package/types/QuotePreviewInvoices.d.ts +0 -1697
  286. package/types/QuotePreviewSubscriptionSchedules.d.ts +0 -785
  287. package/types/Tax/Associations.d.ts +0 -126
  288. package/types/Tax/AssociationsResource.d.ts +0 -29
  289. package/types/Tax/Forms.d.ts +0 -220
  290. package/types/Tax/FormsResource.d.ts +0 -107
  291. package/types/Terminal/ReaderCollectedData.d.ts +0 -51
  292. package/types/Terminal/ReaderCollectedDataResource.d.ts +0 -29
  293. package/types/V2/Core/AccountLinks.d.ts +0 -106
  294. package/types/V2/Core/AccountLinksResource.d.ts +0 -90
  295. package/types/V2/Core/Accounts/PersonsResource.d.ts +0 -3770
  296. package/types/V2/Core/Accounts.d.ts +0 -8169
  297. package/types/V2/Core/AccountsResource.d.ts +0 -10203
  298. package/types/V2/Core/Persons.d.ts +0 -1867
  299. package/types/V2/Core/Vault/GbBankAccounts.d.ts +0 -160
  300. package/types/V2/Core/Vault/GbBankAccountsResource.d.ts +0 -172
  301. package/types/V2/Core/Vault/UsBankAccounts.d.ts +0 -70
  302. package/types/V2/Core/Vault/UsBankAccountsResource.d.ts +0 -123
  303. package/types/V2/FinancialAddressCreditSimulations.d.ts +0 -27
  304. package/types/V2/FinancialAddressGeneratedMicrodeposits.d.ts +0 -32
  305. package/types/V2/MoneyManagement/Adjustments.d.ts +0 -110
  306. package/types/V2/MoneyManagement/AdjustmentsResource.d.ts +0 -83
  307. package/types/V2/MoneyManagement/FinancialAccounts.d.ts +0 -546
  308. package/types/V2/MoneyManagement/FinancialAccountsResource.d.ts +0 -52
  309. package/types/V2/MoneyManagement/FinancialAddresses.d.ts +0 -314
  310. package/types/V2/MoneyManagement/FinancialAddressesResource.d.ts +0 -288
  311. package/types/V2/MoneyManagement/InboundTransfers.d.ts +0 -206
  312. package/types/V2/MoneyManagement/InboundTransfersResource.d.ts +0 -144
  313. package/types/V2/MoneyManagement/OutboundPaymentQuotes.d.ts +0 -168
  314. package/types/V2/MoneyManagement/OutboundPaymentQuotesResource.d.ts +0 -115
  315. package/types/V2/MoneyManagement/OutboundPayments.d.ts +0 -278
  316. package/types/V2/MoneyManagement/OutboundPaymentsResource.d.ts +0 -242
  317. package/types/V2/MoneyManagement/OutboundSetupIntents.d.ts +0 -97
  318. package/types/V2/MoneyManagement/OutboundSetupIntentsResource.d.ts +0 -296
  319. package/types/V2/MoneyManagement/OutboundTransfers.d.ts +0 -251
  320. package/types/V2/MoneyManagement/OutboundTransfersResource.d.ts +0 -207
  321. package/types/V2/MoneyManagement/PayoutMethods.d.ts +0 -151
  322. package/types/V2/MoneyManagement/PayoutMethodsBankAccountSpecResource.d.ts +0 -41
  323. package/types/V2/MoneyManagement/PayoutMethodsBankAccountSpecs.d.ts +0 -87
  324. package/types/V2/MoneyManagement/PayoutMethodsResource.d.ts +0 -113
  325. package/types/V2/MoneyManagement/ReceivedCredits.d.ts +0 -285
  326. package/types/V2/MoneyManagement/ReceivedCreditsResource.d.ts +0 -78
  327. package/types/V2/MoneyManagement/ReceivedDebits.d.ts +0 -224
  328. package/types/V2/MoneyManagement/ReceivedDebitsResource.d.ts +0 -48
  329. package/types/V2/MoneyManagement/TransactionEntries.d.ts +0 -155
  330. package/types/V2/MoneyManagement/TransactionEntriesResource.d.ts +0 -82
  331. package/types/V2/MoneyManagement/Transactions.d.ts +0 -170
  332. package/types/V2/MoneyManagement/TransactionsResource.d.ts +0 -83
  333. package/types/V2/TestHelpers/FinancialAddressesResource.d.ts +0 -66
@@ -1,218 +0,0 @@
1
- // File generated from our OpenAPI spec
2
-
3
- declare module 'stripe' {
4
- namespace Stripe {
5
- namespace Privacy {
6
- interface RedactionJobCreateParams {
7
- /**
8
- * The objects at the root level that are subject to redaction.
9
- */
10
- objects: RedactionJobCreateParams.Objects;
11
-
12
- /**
13
- * Specifies which fields in the response should be expanded.
14
- */
15
- expand?: Array<string>;
16
-
17
- /**
18
- * Default is "error". If "error", we will make sure all objects in the graph are
19
- * redactable in the 1st traversal, otherwise error. If "fix", where possible, we will
20
- * auto-fix any validation errors (e.g. by auto-transitioning objects to a terminal
21
- * state, etc.) in the 2nd traversal before redacting
22
- */
23
- validation_behavior?: RedactionJobCreateParams.ValidationBehavior;
24
- }
25
-
26
- namespace RedactionJobCreateParams {
27
- interface Objects {
28
- charges?: Array<string>;
29
-
30
- checkout_sessions?: Array<string>;
31
-
32
- customers?: Array<string>;
33
-
34
- identity_verification_sessions?: Array<string>;
35
-
36
- invoices?: Array<string>;
37
-
38
- issuing_cardholders?: Array<string>;
39
-
40
- issuing_cards?: Array<string>;
41
-
42
- payment_intents?: Array<string>;
43
-
44
- radar_value_list_items?: Array<string>;
45
-
46
- setup_intents?: Array<string>;
47
- }
48
-
49
- type ValidationBehavior = 'error' | 'fix';
50
- }
51
-
52
- interface RedactionJobRetrieveParams {
53
- /**
54
- * Specifies which fields in the response should be expanded.
55
- */
56
- expand?: Array<string>;
57
- }
58
-
59
- interface RedactionJobUpdateParams {
60
- /**
61
- * Specifies which fields in the response should be expanded.
62
- */
63
- expand?: Array<string>;
64
-
65
- validation_behavior?: RedactionJobUpdateParams.ValidationBehavior;
66
- }
67
-
68
- namespace RedactionJobUpdateParams {
69
- type ValidationBehavior = 'error' | 'fix';
70
- }
71
-
72
- interface RedactionJobListParams extends PaginationParams {
73
- /**
74
- * Specifies which fields in the response should be expanded.
75
- */
76
- expand?: Array<string>;
77
-
78
- status?: RedactionJobListParams.Status;
79
- }
80
-
81
- namespace RedactionJobListParams {
82
- type Status =
83
- | 'canceled'
84
- | 'canceling'
85
- | 'created'
86
- | 'failed'
87
- | 'ready'
88
- | 'redacting'
89
- | 'succeeded'
90
- | 'validating';
91
- }
92
-
93
- interface RedactionJobCancelParams {
94
- /**
95
- * Specifies which fields in the response should be expanded.
96
- */
97
- expand?: Array<string>;
98
- }
99
-
100
- interface RedactionJobListValidationErrorsParams
101
- extends PaginationParams {
102
- /**
103
- * Specifies which fields in the response should be expanded.
104
- */
105
- expand?: Array<string>;
106
- }
107
-
108
- interface RedactionJobRunParams {
109
- /**
110
- * Specifies which fields in the response should be expanded.
111
- */
112
- expand?: Array<string>;
113
- }
114
-
115
- interface RedactionJobValidateParams {
116
- /**
117
- * Specifies which fields in the response should be expanded.
118
- */
119
- expand?: Array<string>;
120
- }
121
-
122
- class RedactionJobsResource {
123
- /**
124
- * Create redaction job method
125
- */
126
- create(
127
- params: RedactionJobCreateParams,
128
- options?: RequestOptions
129
- ): Promise<Stripe.Response<Stripe.Privacy.RedactionJob>>;
130
-
131
- /**
132
- * Retrieve redaction job method
133
- */
134
- retrieve(
135
- id: string,
136
- params?: RedactionJobRetrieveParams,
137
- options?: RequestOptions
138
- ): Promise<Stripe.Response<Stripe.Privacy.RedactionJob>>;
139
- retrieve(
140
- id: string,
141
- options?: RequestOptions
142
- ): Promise<Stripe.Response<Stripe.Privacy.RedactionJob>>;
143
-
144
- /**
145
- * Update redaction job method
146
- */
147
- update(
148
- id: string,
149
- params?: RedactionJobUpdateParams,
150
- options?: RequestOptions
151
- ): Promise<Stripe.Response<Stripe.Privacy.RedactionJob>>;
152
-
153
- /**
154
- * List redaction jobs method...
155
- */
156
- list(
157
- params?: RedactionJobListParams,
158
- options?: RequestOptions
159
- ): ApiListPromise<Stripe.Privacy.RedactionJob>;
160
- list(
161
- options?: RequestOptions
162
- ): ApiListPromise<Stripe.Privacy.RedactionJob>;
163
-
164
- /**
165
- * Cancel redaction job method
166
- */
167
- cancel(
168
- id: string,
169
- params?: RedactionJobCancelParams,
170
- options?: RequestOptions
171
- ): Promise<Stripe.Response<Stripe.Privacy.RedactionJob>>;
172
- cancel(
173
- id: string,
174
- options?: RequestOptions
175
- ): Promise<Stripe.Response<Stripe.Privacy.RedactionJob>>;
176
-
177
- /**
178
- * List validation errors method
179
- */
180
- listValidationErrors(
181
- id: string,
182
- params?: RedactionJobListValidationErrorsParams,
183
- options?: RequestOptions
184
- ): ApiListPromise<Stripe.Privacy.RedactionJobValidationError>;
185
- listValidationErrors(
186
- id: string,
187
- options?: RequestOptions
188
- ): ApiListPromise<Stripe.Privacy.RedactionJobValidationError>;
189
-
190
- /**
191
- * Run redaction job method
192
- */
193
- run(
194
- id: string,
195
- params?: RedactionJobRunParams,
196
- options?: RequestOptions
197
- ): Promise<Stripe.Response<Stripe.Privacy.RedactionJob>>;
198
- run(
199
- id: string,
200
- options?: RequestOptions
201
- ): Promise<Stripe.Response<Stripe.Privacy.RedactionJob>>;
202
-
203
- /**
204
- * Validate redaction job method
205
- */
206
- validate(
207
- id: string,
208
- params?: RedactionJobValidateParams,
209
- options?: RequestOptions
210
- ): Promise<Stripe.Response<Stripe.Privacy.RedactionJob>>;
211
- validate(
212
- id: string,
213
- options?: RequestOptions
214
- ): Promise<Stripe.Response<Stripe.Privacy.RedactionJob>>;
215
- }
216
- }
217
- }
218
- }