stripe 19.2.0-beta.1 → 19.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 (332) hide show
  1. package/CHANGELOG.md +64 -1433
  2. package/OPENAPI_VERSION +1 -1
  3. package/README.md +0 -1
  4. package/VERSION +1 -1
  5. package/cjs/Error.js +1 -115
  6. package/cjs/apiVersion.js +3 -2
  7. package/cjs/resources/FinancialConnections/Accounts.js +0 -5
  8. package/cjs/resources/Mandates.js +0 -5
  9. package/cjs/resources/PaymentIntents.js +0 -8
  10. package/cjs/resources/PaymentRecords.js +4 -0
  11. package/cjs/resources/Quotes.js +0 -32
  12. package/cjs/resources/SubscriptionSchedules.js +0 -4
  13. package/cjs/resources/Subscriptions.js +0 -4
  14. package/cjs/resources.js +8 -106
  15. package/cjs/stripe.core.js +1 -1
  16. package/esm/Error.js +0 -100
  17. package/esm/apiVersion.js +2 -1
  18. package/esm/resources/FinancialConnections/Accounts.js +0 -5
  19. package/esm/resources/Mandates.js +0 -5
  20. package/esm/resources/PaymentIntents.js +0 -8
  21. package/esm/resources/PaymentRecords.js +4 -0
  22. package/esm/resources/Quotes.js +0 -32
  23. package/esm/resources/SubscriptionSchedules.js +0 -4
  24. package/esm/resources/Subscriptions.js +0 -4
  25. package/esm/resources.js +0 -93
  26. package/esm/stripe.core.js +1 -1
  27. package/package.json +1 -1
  28. package/types/AccountLinksResource.d.ts +1 -5
  29. package/types/AccountSessions.d.ts +0 -45
  30. package/types/AccountSessionsResource.d.ts +0 -264
  31. package/types/Accounts.d.ts +23 -212
  32. package/types/AccountsResource.d.ts +44 -544
  33. package/types/Billing/AlertTriggereds.d.ts +1 -1
  34. package/types/Billing/CreditBalanceSummary.d.ts +0 -5
  35. package/types/Billing/CreditBalanceSummaryResource.d.ts +3 -8
  36. package/types/Billing/CreditBalanceTransactionsResource.d.ts +4 -12
  37. package/types/Billing/CreditGrants.d.ts +0 -5
  38. package/types/Billing/CreditGrantsResource.d.ts +3 -13
  39. package/types/BillingPortal/Configurations.d.ts +1 -1
  40. package/types/BillingPortal/ConfigurationsResource.d.ts +10 -0
  41. package/types/BillingPortal/Sessions.d.ts +0 -5
  42. package/types/BillingPortal/SessionsResource.d.ts +4 -12
  43. package/types/Cards.d.ts +0 -5
  44. package/types/CashBalances.d.ts +0 -5
  45. package/types/Charges.d.ts +1 -172
  46. package/types/ChargesResource.d.ts +0 -1406
  47. package/types/Checkout/Sessions.d.ts +17 -369
  48. package/types/Checkout/SessionsResource.d.ts +23 -635
  49. package/types/ConfirmationTokens.d.ts +1 -125
  50. package/types/Coupons.d.ts +0 -33
  51. package/types/CouponsResource.d.ts +0 -21
  52. package/types/CreditNoteLineItems.d.ts +0 -17
  53. package/types/CreditNotes.d.ts +26 -5
  54. package/types/CreditNotesResource.d.ts +78 -5
  55. package/types/CustomerBalanceTransactions.d.ts +0 -2
  56. package/types/CustomerCashBalanceTransactions.d.ts +0 -2
  57. package/types/CustomerSessions.d.ts +120 -5
  58. package/types/CustomerSessionsResource.d.ts +121 -6
  59. package/types/Customers.d.ts +7 -2
  60. package/types/CustomersResource.d.ts +1 -8
  61. package/types/Discounts.d.ts +0 -10
  62. package/types/Disputes.d.ts +0 -40
  63. package/types/DisputesResource.d.ts +0 -11
  64. package/types/Errors.d.ts +0 -85
  65. package/types/EventTypes.d.ts +0 -630
  66. package/types/Events.d.ts +0 -95
  67. package/types/Files.d.ts +1 -0
  68. package/types/FilesResource.d.ts +2 -0
  69. package/types/FinancialConnections/Accounts.d.ts +1 -36
  70. package/types/FinancialConnections/AccountsResource.d.ts +4 -41
  71. package/types/FinancialConnections/Sessions.d.ts +1 -51
  72. package/types/FinancialConnections/SessionsResource.d.ts +1 -43
  73. package/types/Identity/VerificationSessions.d.ts +0 -5
  74. package/types/Identity/VerificationSessionsResource.d.ts +0 -7
  75. package/types/InvoiceItems.d.ts +0 -10
  76. package/types/InvoiceItemsResource.d.ts +6 -117
  77. package/types/InvoiceLineItems.d.ts +1 -45
  78. package/types/Invoices.d.ts +5 -203
  79. package/types/InvoicesResource.d.ts +4 -1622
  80. package/types/Issuing/CardholdersResource.d.ts +1 -2
  81. package/types/Issuing/Transactions.d.ts +0 -5
  82. package/types/Issuing/TransactionsResource.d.ts +0 -5
  83. package/types/LineItems.d.ts +0 -49
  84. package/types/Mandates.d.ts +1 -135
  85. package/types/MandatesResource.d.ts +0 -31
  86. package/types/PaymentAttemptRecords.d.ts +1 -137
  87. package/types/PaymentAttemptRecordsResource.d.ts +5 -0
  88. package/types/PaymentIntentAmountDetailsLineItems.d.ts +17 -7
  89. package/types/PaymentIntents.d.ts +23 -782
  90. package/types/PaymentIntentsResource.d.ts +4783 -9501
  91. package/types/PaymentLinks.d.ts +34 -6
  92. package/types/PaymentLinksResource.d.ts +88 -12
  93. package/types/PaymentMethodConfigurations.d.ts +46 -190
  94. package/types/PaymentMethodConfigurationsResource.d.ts +100 -300
  95. package/types/PaymentMethods.d.ts +34 -130
  96. package/types/PaymentMethodsResource.d.ts +17 -168
  97. package/types/PaymentRecords.d.ts +1 -137
  98. package/types/PaymentRecordsResource.d.ts +89 -0
  99. package/types/PayoutsResource.d.ts +1 -1
  100. package/types/Prices.d.ts +0 -22
  101. package/types/PricesResource.d.ts +0 -22
  102. package/types/PromotionCodes.d.ts +0 -5
  103. package/types/PromotionCodesResource.d.ts +0 -10
  104. package/types/Quotes.d.ts +1 -594
  105. package/types/QuotesResource.d.ts +290 -2635
  106. package/types/Refunds.d.ts +9 -14
  107. package/types/SetupAttempts.d.ts +2 -51
  108. package/types/SetupIntents.d.ts +59 -209
  109. package/types/SetupIntentsResource.d.ts +132 -952
  110. package/types/Sources.d.ts +0 -29
  111. package/types/SubscriptionItems.d.ts +0 -26
  112. package/types/SubscriptionItemsResource.d.ts +0 -109
  113. package/types/SubscriptionSchedules.d.ts +0 -205
  114. package/types/SubscriptionSchedulesResource.d.ts +4 -1232
  115. package/types/Subscriptions.d.ts +1 -262
  116. package/types/SubscriptionsResource.d.ts +8 -745
  117. package/types/Tax/Registrations.d.ts +9 -0
  118. package/types/Tax/RegistrationsResource.d.ts +12 -0
  119. package/types/TaxIds.d.ts +0 -10
  120. package/types/TaxIdsResource.d.ts +0 -10
  121. package/types/Terminal/Configurations.d.ts +19 -9
  122. package/types/Terminal/ConfigurationsResource.d.ts +44 -28
  123. package/types/Terminal/Readers.d.ts +14 -29
  124. package/types/Terminal/ReadersResource.d.ts +30 -30
  125. package/types/TestHelpers/ConfirmationTokensResource.d.ts +0 -126
  126. package/types/TestHelpers/Terminal/ReadersResource.d.ts +1 -1
  127. package/types/TestHelpers/Treasury/ReceivedCreditsResource.d.ts +0 -26
  128. package/types/TestHelpers/Treasury/ReceivedDebitsResource.d.ts +0 -26
  129. package/types/TokensResource.d.ts +22 -0
  130. package/types/Transfers.d.ts +0 -5
  131. package/types/TransfersResource.d.ts +0 -5
  132. package/types/Treasury/FinancialAccountFeatures.d.ts +0 -7
  133. package/types/Treasury/FinancialAccounts.d.ts +0 -5
  134. package/types/Treasury/FinancialAccountsResource.d.ts +0 -37
  135. package/types/Treasury/OutboundTransfers.d.ts +0 -26
  136. package/types/Treasury/OutboundTransfersResource.d.ts +0 -26
  137. package/types/Treasury/ReceivedCredits.d.ts +0 -26
  138. package/types/Treasury/ReceivedDebits.d.ts +0 -31
  139. package/types/V2/Core/EventTypes.d.ts +10 -1647
  140. package/types/V2/Core/EventsResource.d.ts +29 -3
  141. package/types/WebhookEndpointsResource.d.ts +2 -75
  142. package/types/apiVersion.d.ts +2 -1
  143. package/types/crypto/crypto.d.ts +1 -1
  144. package/types/index.d.ts +0 -153
  145. package/types/lib.d.ts +0 -10
  146. package/cjs/resources/AccountNotices.js +0 -21
  147. package/cjs/resources/Billing/Analytics/MeterUsage.js +0 -12
  148. package/cjs/resources/Capital/FinancingOffers.js +0 -21
  149. package/cjs/resources/Capital/FinancingSummary.js +0 -12
  150. package/cjs/resources/Capital/FinancingTransactions.js +0 -17
  151. package/cjs/resources/ExternalAccounts.js +0 -23
  152. package/cjs/resources/FinancialConnections/Institutions.js +0 -17
  153. package/cjs/resources/FxQuotes.js +0 -15
  154. package/cjs/resources/Issuing/CreditUnderwritingRecords.js +0 -33
  155. package/cjs/resources/Issuing/DisputeSettlementDetails.js +0 -17
  156. package/cjs/resources/Issuing/FraudLiabilityDebits.js +0 -17
  157. package/cjs/resources/Margins.js +0 -22
  158. package/cjs/resources/Orders.js +0 -24
  159. package/cjs/resources/Privacy/RedactionJobs.js +0 -42
  160. package/cjs/resources/Tax/Associations.js +0 -9
  161. package/cjs/resources/Tax/Forms.js +0 -20
  162. package/cjs/resources/Terminal/OnboardingLinks.js +0 -12
  163. package/cjs/resources/Terminal/ReaderCollectedData.js +0 -12
  164. package/cjs/resources/V2/Billing/BillSettings/Versions.js +0 -17
  165. package/cjs/resources/V2/Billing/BillSettings.js +0 -27
  166. package/cjs/resources/V2/Billing/Cadences.js +0 -23
  167. package/cjs/resources/V2/Billing/CollectionSettings/Versions.js +0 -17
  168. package/cjs/resources/V2/Billing/CollectionSettings.js +0 -30
  169. package/cjs/resources/V2/Billing/Profiles.js +0 -19
  170. package/cjs/resources/V2/Core/AccountLinks.js +0 -9
  171. package/cjs/resources/V2/Core/Accounts/Persons.js +0 -29
  172. package/cjs/resources/V2/Core/Accounts.js +0 -25
  173. package/cjs/resources/V2/Core/Vault/GbBankAccounts.js +0 -28
  174. package/cjs/resources/V2/Core/Vault/UsBankAccounts.js +0 -24
  175. package/cjs/resources/V2/MoneyManagement/Adjustments.js +0 -17
  176. package/cjs/resources/V2/MoneyManagement/FinancialAccounts.js +0 -25
  177. package/cjs/resources/V2/MoneyManagement/FinancialAddresses.js +0 -21
  178. package/cjs/resources/V2/MoneyManagement/InboundTransfers.js +0 -21
  179. package/cjs/resources/V2/MoneyManagement/OutboundPaymentQuotes.js +0 -16
  180. package/cjs/resources/V2/MoneyManagement/OutboundPayments.js +0 -25
  181. package/cjs/resources/V2/MoneyManagement/OutboundSetupIntents.js +0 -29
  182. package/cjs/resources/V2/MoneyManagement/OutboundTransfers.js +0 -25
  183. package/cjs/resources/V2/MoneyManagement/PayoutMethods.js +0 -25
  184. package/cjs/resources/V2/MoneyManagement/PayoutMethodsBankAccountSpec.js +0 -12
  185. package/cjs/resources/V2/MoneyManagement/ReceivedCredits.js +0 -17
  186. package/cjs/resources/V2/MoneyManagement/ReceivedDebits.js +0 -17
  187. package/cjs/resources/V2/MoneyManagement/TransactionEntries.js +0 -17
  188. package/cjs/resources/V2/MoneyManagement/Transactions.js +0 -17
  189. package/cjs/resources/V2/Payments/OffSessionPayments.js +0 -29
  190. package/cjs/resources/V2/TestHelpers/FinancialAddresses.js +0 -16
  191. package/esm/resources/AccountNotices.js +0 -18
  192. package/esm/resources/Billing/Analytics/MeterUsage.js +0 -9
  193. package/esm/resources/Capital/FinancingOffers.js +0 -18
  194. package/esm/resources/Capital/FinancingSummary.js +0 -9
  195. package/esm/resources/Capital/FinancingTransactions.js +0 -14
  196. package/esm/resources/ExternalAccounts.js +0 -20
  197. package/esm/resources/FinancialConnections/Institutions.js +0 -14
  198. package/esm/resources/FxQuotes.js +0 -12
  199. package/esm/resources/Issuing/CreditUnderwritingRecords.js +0 -30
  200. package/esm/resources/Issuing/DisputeSettlementDetails.js +0 -14
  201. package/esm/resources/Issuing/FraudLiabilityDebits.js +0 -14
  202. package/esm/resources/Margins.js +0 -19
  203. package/esm/resources/Orders.js +0 -21
  204. package/esm/resources/Privacy/RedactionJobs.js +0 -39
  205. package/esm/resources/Tax/Associations.js +0 -6
  206. package/esm/resources/Tax/Forms.js +0 -17
  207. package/esm/resources/Terminal/OnboardingLinks.js +0 -9
  208. package/esm/resources/Terminal/ReaderCollectedData.js +0 -9
  209. package/esm/resources/V2/Billing/BillSettings/Versions.js +0 -14
  210. package/esm/resources/V2/Billing/BillSettings.js +0 -24
  211. package/esm/resources/V2/Billing/Cadences.js +0 -20
  212. package/esm/resources/V2/Billing/CollectionSettings/Versions.js +0 -14
  213. package/esm/resources/V2/Billing/CollectionSettings.js +0 -27
  214. package/esm/resources/V2/Billing/Profiles.js +0 -16
  215. package/esm/resources/V2/Core/AccountLinks.js +0 -6
  216. package/esm/resources/V2/Core/Accounts/Persons.js +0 -26
  217. package/esm/resources/V2/Core/Accounts.js +0 -22
  218. package/esm/resources/V2/Core/Vault/GbBankAccounts.js +0 -25
  219. package/esm/resources/V2/Core/Vault/UsBankAccounts.js +0 -21
  220. package/esm/resources/V2/MoneyManagement/Adjustments.js +0 -14
  221. package/esm/resources/V2/MoneyManagement/FinancialAccounts.js +0 -22
  222. package/esm/resources/V2/MoneyManagement/FinancialAddresses.js +0 -18
  223. package/esm/resources/V2/MoneyManagement/InboundTransfers.js +0 -18
  224. package/esm/resources/V2/MoneyManagement/OutboundPaymentQuotes.js +0 -13
  225. package/esm/resources/V2/MoneyManagement/OutboundPayments.js +0 -22
  226. package/esm/resources/V2/MoneyManagement/OutboundSetupIntents.js +0 -26
  227. package/esm/resources/V2/MoneyManagement/OutboundTransfers.js +0 -22
  228. package/esm/resources/V2/MoneyManagement/PayoutMethods.js +0 -22
  229. package/esm/resources/V2/MoneyManagement/PayoutMethodsBankAccountSpec.js +0 -9
  230. package/esm/resources/V2/MoneyManagement/ReceivedCredits.js +0 -14
  231. package/esm/resources/V2/MoneyManagement/ReceivedDebits.js +0 -14
  232. package/esm/resources/V2/MoneyManagement/TransactionEntries.js +0 -14
  233. package/esm/resources/V2/MoneyManagement/Transactions.js +0 -14
  234. package/esm/resources/V2/Payments/OffSessionPayments.js +0 -26
  235. package/esm/resources/V2/TestHelpers/FinancialAddresses.js +0 -13
  236. package/types/AccountNotices.d.ts +0 -113
  237. package/types/AccountNoticesResource.d.ts +0 -98
  238. package/types/Billing/Analytics/MeterUsage.d.ts +0 -31
  239. package/types/Billing/Analytics/MeterUsageResource.d.ts +0 -689
  240. package/types/Billing/Analytics/MeterUsageRows.d.ts +0 -51
  241. package/types/Capital/FinancingOffers.d.ts +0 -188
  242. package/types/Capital/FinancingOffersResource.d.ts +0 -97
  243. package/types/Capital/FinancingSummary.d.ts +0 -106
  244. package/types/Capital/FinancingSummaryResource.d.ts +0 -27
  245. package/types/Capital/FinancingTransactions.d.ts +0 -135
  246. package/types/Capital/FinancingTransactionsResource.d.ts +0 -68
  247. package/types/ExternalAccountsResource.d.ts +0 -304
  248. package/types/FinancialConnections/AccountInferredBalances.d.ts +0 -38
  249. package/types/FinancialConnections/Institutions.d.ts +0 -98
  250. package/types/FinancialConnections/InstitutionsResource.d.ts +0 -47
  251. package/types/FxQuotes.d.ts +0 -155
  252. package/types/FxQuotesResource.d.ts +0 -130
  253. package/types/Issuing/CreditUnderwritingRecords.d.ts +0 -451
  254. package/types/Issuing/CreditUnderwritingRecordsResource.d.ts +0 -1032
  255. package/types/Issuing/DisputeSettlementDetails.d.ts +0 -85
  256. package/types/Issuing/DisputeSettlementDetailsResource.d.ts +0 -52
  257. package/types/Issuing/FraudLiabilityDebits.d.ts +0 -52
  258. package/types/Issuing/FraudLiabilityDebitsResource.d.ts +0 -52
  259. package/types/Issuing/Settlements.d.ts +0 -113
  260. package/types/Margins.d.ts +0 -56
  261. package/types/MarginsResource.d.ts +0 -114
  262. package/types/Orders.d.ts +0 -1163
  263. package/types/OrdersResource.d.ts +0 -3139
  264. package/types/Privacy/RedactionJobValidationErrors.d.ts +0 -60
  265. package/types/Privacy/RedactionJobs.d.ts +0 -111
  266. package/types/Privacy/RedactionJobsResource.d.ts +0 -230
  267. package/types/QuoteLines.d.ts +0 -634
  268. package/types/QuotePreviewInvoices.d.ts +0 -1770
  269. package/types/QuotePreviewSubscriptionSchedules.d.ts +0 -908
  270. package/types/Tax/Associations.d.ts +0 -82
  271. package/types/Tax/AssociationsResource.d.ts +0 -29
  272. package/types/Tax/Forms.d.ts +0 -220
  273. package/types/Tax/FormsResource.d.ts +0 -107
  274. package/types/Terminal/OnboardingLinks.d.ts +0 -57
  275. package/types/Terminal/OnboardingLinksResource.d.ts +0 -62
  276. package/types/Terminal/ReaderCollectedData.d.ts +0 -51
  277. package/types/Terminal/ReaderCollectedDataResource.d.ts +0 -29
  278. package/types/V2/Billing/BillSettingVersions.d.ts +0 -97
  279. package/types/V2/Billing/BillSettings/VersionsResource.d.ts +0 -58
  280. package/types/V2/Billing/BillSettings.d.ts +0 -120
  281. package/types/V2/Billing/BillSettingsResource.d.ts +0 -241
  282. package/types/V2/Billing/Cadences.d.ts +0 -686
  283. package/types/V2/Billing/CadencesResource.d.ts +0 -487
  284. package/types/V2/Billing/CollectionSettingVersions.d.ts +0 -314
  285. package/types/V2/Billing/CollectionSettings/VersionsResource.d.ts +0 -62
  286. package/types/V2/Billing/CollectionSettings.d.ts +0 -337
  287. package/types/V2/Billing/CollectionSettingsResource.d.ts +0 -675
  288. package/types/V2/Billing/Profiles.d.ts +0 -70
  289. package/types/V2/Billing/ProfilesResource.d.ts +0 -150
  290. package/types/V2/Core/AccountLinks.d.ts +0 -168
  291. package/types/V2/Core/AccountLinksResource.d.ts +0 -152
  292. package/types/V2/Core/AccountPersons.d.ts +0 -615
  293. package/types/V2/Core/Accounts/PersonsResource.d.ts +0 -1153
  294. package/types/V2/Core/Accounts.d.ts +0 -5919
  295. package/types/V2/Core/AccountsResource.d.ts +0 -4999
  296. package/types/V2/Core/Vault/GbBankAccounts.d.ts +0 -160
  297. package/types/V2/Core/Vault/GbBankAccountsResource.d.ts +0 -172
  298. package/types/V2/Core/Vault/UsBankAccounts.d.ts +0 -70
  299. package/types/V2/Core/Vault/UsBankAccountsResource.d.ts +0 -123
  300. package/types/V2/FinancialAddressCreditSimulations.d.ts +0 -27
  301. package/types/V2/FinancialAddressGeneratedMicrodeposits.d.ts +0 -32
  302. package/types/V2/MoneyManagement/Adjustments.d.ts +0 -110
  303. package/types/V2/MoneyManagement/AdjustmentsResource.d.ts +0 -83
  304. package/types/V2/MoneyManagement/FinancialAccounts.d.ts +0 -148
  305. package/types/V2/MoneyManagement/FinancialAccountsResource.d.ts +0 -147
  306. package/types/V2/MoneyManagement/FinancialAddresses.d.ts +0 -178
  307. package/types/V2/MoneyManagement/FinancialAddressesResource.d.ts +0 -112
  308. package/types/V2/MoneyManagement/InboundTransfers.d.ts +0 -206
  309. package/types/V2/MoneyManagement/InboundTransfersResource.d.ts +0 -144
  310. package/types/V2/MoneyManagement/OutboundPaymentQuotes.d.ts +0 -170
  311. package/types/V2/MoneyManagement/OutboundPaymentQuotesResource.d.ts +0 -115
  312. package/types/V2/MoneyManagement/OutboundPayments.d.ts +0 -278
  313. package/types/V2/MoneyManagement/OutboundPaymentsResource.d.ts +0 -242
  314. package/types/V2/MoneyManagement/OutboundSetupIntents.d.ts +0 -97
  315. package/types/V2/MoneyManagement/OutboundSetupIntentsResource.d.ts +0 -296
  316. package/types/V2/MoneyManagement/OutboundTransfers.d.ts +0 -251
  317. package/types/V2/MoneyManagement/OutboundTransfersResource.d.ts +0 -208
  318. package/types/V2/MoneyManagement/PayoutMethods.d.ts +0 -160
  319. package/types/V2/MoneyManagement/PayoutMethodsBankAccountSpec.d.ts +0 -93
  320. package/types/V2/MoneyManagement/PayoutMethodsBankAccountSpecResource.d.ts +0 -41
  321. package/types/V2/MoneyManagement/PayoutMethodsResource.d.ts +0 -113
  322. package/types/V2/MoneyManagement/ReceivedCredits.d.ts +0 -302
  323. package/types/V2/MoneyManagement/ReceivedCreditsResource.d.ts +0 -78
  324. package/types/V2/MoneyManagement/ReceivedDebits.d.ts +0 -176
  325. package/types/V2/MoneyManagement/ReceivedDebitsResource.d.ts +0 -48
  326. package/types/V2/MoneyManagement/TransactionEntries.d.ts +0 -162
  327. package/types/V2/MoneyManagement/TransactionEntriesResource.d.ts +0 -82
  328. package/types/V2/MoneyManagement/Transactions.d.ts +0 -177
  329. package/types/V2/MoneyManagement/TransactionsResource.d.ts +0 -83
  330. package/types/V2/Payments/OffSessionPayments.d.ts +0 -326
  331. package/types/V2/Payments/OffSessionPaymentsResource.d.ts +0 -401
  332. package/types/V2/TestHelpers/FinancialAddressesResource.d.ts +0 -68
@@ -1,1153 +0,0 @@
1
- // File generated from our OpenAPI spec
2
-
3
- declare module 'stripe' {
4
- namespace Stripe {
5
- namespace V2 {
6
- namespace Core {
7
- namespace Accounts {
8
- interface PersonCreateParams {
9
- /**
10
- * Additional addresses associated with the person.
11
- */
12
- additional_addresses?: Array<PersonCreateParams.AdditionalAddress>;
13
-
14
- /**
15
- * Additional names (e.g. aliases) associated with the person.
16
- */
17
- additional_names?: Array<PersonCreateParams.AdditionalName>;
18
-
19
- /**
20
- * Attestations of accepted terms of service agreements.
21
- */
22
- additional_terms_of_service?: PersonCreateParams.AdditionalTermsOfService;
23
-
24
- /**
25
- * The person's residential address.
26
- */
27
- address?: PersonCreateParams.Address;
28
-
29
- /**
30
- * The person's date of birth.
31
- */
32
- date_of_birth?: PersonCreateParams.DateOfBirth;
33
-
34
- /**
35
- * Documents that may be submitted to satisfy various informational requests.
36
- */
37
- documents?: PersonCreateParams.Documents;
38
-
39
- /**
40
- * Email.
41
- */
42
- email?: string;
43
-
44
- /**
45
- * The person's first name.
46
- */
47
- given_name?: string;
48
-
49
- /**
50
- * The identification numbers (e.g., SSN) associated with the person.
51
- */
52
- id_numbers?: Array<PersonCreateParams.IdNumber>;
53
-
54
- /**
55
- * The person's gender (International regulations require either "male" or "female").
56
- */
57
- legal_gender?: PersonCreateParams.LegalGender;
58
-
59
- /**
60
- * Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
61
- */
62
- metadata?: Stripe.MetadataParam;
63
-
64
- /**
65
- * The nationalities (countries) this person is associated with.
66
- */
67
- nationalities?: Array<string>;
68
-
69
- /**
70
- * The phone number for this person.
71
- */
72
- phone?: string;
73
-
74
- /**
75
- * The person's political exposure.
76
- */
77
- political_exposure?: PersonCreateParams.PoliticalExposure;
78
-
79
- /**
80
- * The relationship that this person has with the Account's business or legal entity.
81
- */
82
- relationship?: PersonCreateParams.Relationship;
83
-
84
- /**
85
- * The script addresses (e.g., non-Latin characters) associated with the person.
86
- */
87
- script_addresses?: PersonCreateParams.ScriptAddresses;
88
-
89
- /**
90
- * The script names (e.g. non-Latin characters) associated with the person.
91
- */
92
- script_names?: PersonCreateParams.ScriptNames;
93
-
94
- /**
95
- * The person's last name.
96
- */
97
- surname?: string;
98
- }
99
-
100
- namespace PersonCreateParams {
101
- interface AdditionalAddress {
102
- /**
103
- * City, district, suburb, town, or village.
104
- */
105
- city?: string;
106
-
107
- /**
108
- * Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
109
- */
110
- country: string;
111
-
112
- /**
113
- * Address line 1 (e.g., street, PO Box, or company name).
114
- */
115
- line1?: string;
116
-
117
- /**
118
- * Address line 2 (e.g., apartment, suite, unit, or building).
119
- */
120
- line2?: string;
121
-
122
- /**
123
- * ZIP or postal code.
124
- */
125
- postal_code?: string;
126
-
127
- /**
128
- * Purpose of additional address.
129
- */
130
- purpose: 'registered';
131
-
132
- /**
133
- * State, county, province, or region.
134
- */
135
- state?: string;
136
-
137
- /**
138
- * Town or cho-me.
139
- */
140
- town?: string;
141
- }
142
-
143
- interface AdditionalName {
144
- /**
145
- * The person's full name.
146
- */
147
- full_name?: string;
148
-
149
- /**
150
- * The person's first or given name.
151
- */
152
- given_name?: string;
153
-
154
- /**
155
- * The purpose or type of the additional name.
156
- */
157
- purpose: AdditionalName.Purpose;
158
-
159
- /**
160
- * The person's last or family name.
161
- */
162
- surname?: string;
163
- }
164
-
165
- namespace AdditionalName {
166
- type Purpose = 'alias' | 'maiden';
167
- }
168
-
169
- interface AdditionalTermsOfService {
170
- /**
171
- * Stripe terms of service agreement.
172
- */
173
- account?: AdditionalTermsOfService.Account;
174
- }
175
-
176
- namespace AdditionalTermsOfService {
177
- interface Account {
178
- /**
179
- * The time when the Account's representative accepted the terms of service. Represented as a RFC 3339 date & time UTC value in millisecond precision, for example: 2022-09-18T13:22:18.123Z.
180
- */
181
- date: string;
182
-
183
- /**
184
- * The IP address from which the Account's representative accepted the terms of service.
185
- */
186
- ip: string;
187
-
188
- /**
189
- * The user agent of the browser from which the Account's representative accepted the terms of service.
190
- */
191
- user_agent?: string;
192
- }
193
- }
194
-
195
- interface Address {
196
- /**
197
- * City, district, suburb, town, or village.
198
- */
199
- city?: string;
200
-
201
- /**
202
- * Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
203
- */
204
- country: string;
205
-
206
- /**
207
- * Address line 1 (e.g., street, PO Box, or company name).
208
- */
209
- line1?: string;
210
-
211
- /**
212
- * Address line 2 (e.g., apartment, suite, unit, or building).
213
- */
214
- line2?: string;
215
-
216
- /**
217
- * ZIP or postal code.
218
- */
219
- postal_code?: string;
220
-
221
- /**
222
- * State, county, province, or region.
223
- */
224
- state?: string;
225
-
226
- /**
227
- * Town or cho-me.
228
- */
229
- town?: string;
230
- }
231
-
232
- interface DateOfBirth {
233
- /**
234
- * The day of birth.
235
- */
236
- day: number;
237
-
238
- /**
239
- * The month of birth.
240
- */
241
- month: number;
242
-
243
- /**
244
- * The year of birth.
245
- */
246
- year: number;
247
- }
248
-
249
- interface Documents {
250
- /**
251
- * One or more documents that demonstrate proof that this person is authorized to represent the company.
252
- */
253
- company_authorization?: Documents.CompanyAuthorization;
254
-
255
- /**
256
- * One or more documents showing the person's passport page with photo and personal data.
257
- */
258
- passport?: Documents.Passport;
259
-
260
- /**
261
- * An identifying document showing the person's name, either a passport or local ID card.
262
- */
263
- primary_verification?: Documents.PrimaryVerification;
264
-
265
- /**
266
- * A document showing address, either a passport, local ID card, or utility bill from a well-known utility company.
267
- */
268
- secondary_verification?: Documents.SecondaryVerification;
269
-
270
- /**
271
- * One or more documents showing the person's visa required for living in the country where they are residing.
272
- */
273
- visa?: Documents.Visa;
274
- }
275
-
276
- namespace Documents {
277
- interface CompanyAuthorization {
278
- /**
279
- * One or more document IDs returned by a [file upload](https://docs.stripe.com/api/persons/update#create_file) with a purpose value of `account_requirement`.
280
- */
281
- files: Array<string>;
282
-
283
- /**
284
- * The format of the document. Currently supports `files` only.
285
- */
286
- type: 'files';
287
- }
288
-
289
- interface Passport {
290
- /**
291
- * One or more document IDs returned by a [file upload](https://docs.stripe.com/api/persons/update#create_file) with a purpose value of `account_requirement`.
292
- */
293
- files: Array<string>;
294
-
295
- /**
296
- * The format of the document. Currently supports `files` only.
297
- */
298
- type: 'files';
299
- }
300
-
301
- interface PrimaryVerification {
302
- /**
303
- * The [file upload](https://docs.stripe.com/api/persons/update#create_file) tokens referring to each side of the document.
304
- */
305
- front_back: PrimaryVerification.FrontBack;
306
-
307
- /**
308
- * The format of the verification document. Currently supports `front_back` only.
309
- */
310
- type: 'front_back';
311
- }
312
-
313
- namespace PrimaryVerification {
314
- interface FrontBack {
315
- /**
316
- * A [file upload](https://docs.stripe.com/api/persons/update#create_file) token representing the back of the verification document. The purpose of the uploaded file should be 'identity_document'. The uploaded file needs to be a color image (smaller than 8,000px by 8,000px), in JPG, PNG, or PDF format, and less than 10 MB in size.
317
- */
318
- back?: string;
319
-
320
- /**
321
- * A [file upload](https://docs.stripe.com/api/persons/update#create_file) token representing the front of the verification document. The purpose of the uploaded file should be 'identity_document'. The uploaded file needs to be a color image (smaller than 8,000px by 8,000px), in JPG, PNG, or PDF format, and less than 10 MB in size.
322
- */
323
- front: string;
324
- }
325
- }
326
-
327
- interface SecondaryVerification {
328
- /**
329
- * The [file upload](https://docs.stripe.com/api/persons/update#create_file) tokens referring to each side of the document.
330
- */
331
- front_back: SecondaryVerification.FrontBack;
332
-
333
- /**
334
- * The format of the verification document. Currently supports `front_back` only.
335
- */
336
- type: 'front_back';
337
- }
338
-
339
- namespace SecondaryVerification {
340
- interface FrontBack {
341
- /**
342
- * A [file upload](https://docs.stripe.com/api/persons/update#create_file) token representing the back of the verification document. The purpose of the uploaded file should be 'identity_document'. The uploaded file needs to be a color image (smaller than 8,000px by 8,000px), in JPG, PNG, or PDF format, and less than 10 MB in size.
343
- */
344
- back?: string;
345
-
346
- /**
347
- * A [file upload](https://docs.stripe.com/api/persons/update#create_file) token representing the front of the verification document. The purpose of the uploaded file should be 'identity_document'. The uploaded file needs to be a color image (smaller than 8,000px by 8,000px), in JPG, PNG, or PDF format, and less than 10 MB in size.
348
- */
349
- front: string;
350
- }
351
- }
352
-
353
- interface Visa {
354
- /**
355
- * One or more document IDs returned by a [file upload](https://docs.stripe.com/api/persons/update#create_file) with a purpose value of `account_requirement`.
356
- */
357
- files: Array<string>;
358
-
359
- /**
360
- * The format of the document. Currently supports `files` only.
361
- */
362
- type: 'files';
363
- }
364
- }
365
-
366
- interface IdNumber {
367
- /**
368
- * The ID number type of an individual.
369
- */
370
- type: IdNumber.Type;
371
-
372
- /**
373
- * The value of the ID number.
374
- */
375
- value: string;
376
- }
377
-
378
- namespace IdNumber {
379
- type Type =
380
- | 'ae_eid'
381
- | 'ao_nif'
382
- | 'az_tin'
383
- | 'bd_brc'
384
- | 'bd_etin'
385
- | 'bd_nid'
386
- | 'br_cpf'
387
- | 'cr_cpf'
388
- | 'cr_dimex'
389
- | 'cr_nite'
390
- | 'de_stn'
391
- | 'do_rcn'
392
- | 'gt_nit'
393
- | 'hk_id'
394
- | 'kz_iin'
395
- | 'mx_rfc'
396
- | 'my_nric'
397
- | 'mz_nuit'
398
- | 'nl_bsn'
399
- | 'pe_dni'
400
- | 'pk_cnic'
401
- | 'pk_snic'
402
- | 'sa_tin'
403
- | 'sg_fin'
404
- | 'sg_nric'
405
- | 'th_lc'
406
- | 'th_pin'
407
- | 'us_itin'
408
- | 'us_itin_last_4'
409
- | 'us_ssn'
410
- | 'us_ssn_last_4';
411
- }
412
-
413
- type LegalGender = 'female' | 'male';
414
-
415
- type PoliticalExposure = 'existing' | 'none';
416
-
417
- interface Relationship {
418
- /**
419
- * Whether the individual is an authorizer of the Account's legal entity.
420
- */
421
- authorizer?: boolean;
422
-
423
- /**
424
- * Indicates whether the person is a director of the associated legal entity.
425
- */
426
- director?: boolean;
427
-
428
- /**
429
- * Indicates whether the person is an executive of the associated legal entity.
430
- */
431
- executive?: boolean;
432
-
433
- /**
434
- * Indicates whether the person is a legal guardian of the associated legal entity.
435
- */
436
- legal_guardian?: boolean;
437
-
438
- /**
439
- * Indicates whether the person is an owner of the associated legal entity.
440
- */
441
- owner?: boolean;
442
-
443
- /**
444
- * The percentage of ownership the person has in the associated legal entity.
445
- */
446
- percent_ownership?: string;
447
-
448
- /**
449
- * Indicates whether the person is a representative of the associated legal entity.
450
- */
451
- representative?: boolean;
452
-
453
- /**
454
- * The title or position the person holds in the associated legal entity.
455
- */
456
- title?: string;
457
- }
458
-
459
- interface ScriptAddresses {
460
- /**
461
- * Kana Address.
462
- */
463
- kana?: ScriptAddresses.Kana;
464
-
465
- /**
466
- * Kanji Address.
467
- */
468
- kanji?: ScriptAddresses.Kanji;
469
- }
470
-
471
- namespace ScriptAddresses {
472
- interface Kana {
473
- /**
474
- * City, district, suburb, town, or village.
475
- */
476
- city?: string;
477
-
478
- /**
479
- * Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
480
- */
481
- country: string;
482
-
483
- /**
484
- * Address line 1 (e.g., street, PO Box, or company name).
485
- */
486
- line1?: string;
487
-
488
- /**
489
- * Address line 2 (e.g., apartment, suite, unit, or building).
490
- */
491
- line2?: string;
492
-
493
- /**
494
- * ZIP or postal code.
495
- */
496
- postal_code?: string;
497
-
498
- /**
499
- * State, county, province, or region.
500
- */
501
- state?: string;
502
-
503
- /**
504
- * Town or cho-me.
505
- */
506
- town?: string;
507
- }
508
-
509
- interface Kanji {
510
- /**
511
- * City, district, suburb, town, or village.
512
- */
513
- city?: string;
514
-
515
- /**
516
- * Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
517
- */
518
- country: string;
519
-
520
- /**
521
- * Address line 1 (e.g., street, PO Box, or company name).
522
- */
523
- line1?: string;
524
-
525
- /**
526
- * Address line 2 (e.g., apartment, suite, unit, or building).
527
- */
528
- line2?: string;
529
-
530
- /**
531
- * ZIP or postal code.
532
- */
533
- postal_code?: string;
534
-
535
- /**
536
- * State, county, province, or region.
537
- */
538
- state?: string;
539
-
540
- /**
541
- * Town or cho-me.
542
- */
543
- town?: string;
544
- }
545
- }
546
-
547
- interface ScriptNames {
548
- /**
549
- * Persons name in kana script.
550
- */
551
- kana?: ScriptNames.Kana;
552
-
553
- /**
554
- * Persons name in kanji script.
555
- */
556
- kanji?: ScriptNames.Kanji;
557
- }
558
-
559
- namespace ScriptNames {
560
- interface Kana {
561
- /**
562
- * The person's first or given name.
563
- */
564
- given_name?: string;
565
-
566
- /**
567
- * The person's last or family name.
568
- */
569
- surname?: string;
570
- }
571
-
572
- interface Kanji {
573
- /**
574
- * The person's first or given name.
575
- */
576
- given_name?: string;
577
-
578
- /**
579
- * The person's last or family name.
580
- */
581
- surname?: string;
582
- }
583
- }
584
- }
585
- }
586
- }
587
-
588
- namespace Core {
589
- namespace Accounts {
590
- interface PersonRetrieveParams {}
591
- }
592
- }
593
-
594
- namespace Core {
595
- namespace Accounts {
596
- interface PersonUpdateParams {
597
- /**
598
- * Additional addresses associated with the person.
599
- */
600
- additional_addresses?: Array<PersonUpdateParams.AdditionalAddress>;
601
-
602
- /**
603
- * Additional names (e.g. aliases) associated with the person.
604
- */
605
- additional_names?: Array<PersonUpdateParams.AdditionalName>;
606
-
607
- /**
608
- * Attestations of accepted terms of service agreements.
609
- */
610
- additional_terms_of_service?: PersonUpdateParams.AdditionalTermsOfService;
611
-
612
- /**
613
- * The primary address associated with the person.
614
- */
615
- address?: Stripe.JapanAddressParam;
616
-
617
- /**
618
- * The person's date of birth.
619
- */
620
- date_of_birth?: PersonUpdateParams.DateOfBirth;
621
-
622
- /**
623
- * Documents that may be submitted to satisfy various informational requests.
624
- */
625
- documents?: PersonUpdateParams.Documents;
626
-
627
- /**
628
- * Email.
629
- */
630
- email?: string;
631
-
632
- /**
633
- * The person's first name.
634
- */
635
- given_name?: string;
636
-
637
- /**
638
- * The identification numbers (e.g., SSN) associated with the person.
639
- */
640
- id_numbers?: Array<PersonUpdateParams.IdNumber>;
641
-
642
- /**
643
- * The person's gender (International regulations require either "male" or "female").
644
- */
645
- legal_gender?: PersonUpdateParams.LegalGender;
646
-
647
- /**
648
- * Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
649
- */
650
- metadata?: Stripe.MetadataParam;
651
-
652
- /**
653
- * The nationalities (countries) this person is associated with.
654
- */
655
- nationalities?: Array<string>;
656
-
657
- /**
658
- * The phone number for this person.
659
- */
660
- phone?: string;
661
-
662
- /**
663
- * The person's political exposure.
664
- */
665
- political_exposure?: PersonUpdateParams.PoliticalExposure;
666
-
667
- /**
668
- * The relationship that this person has with the Account's business or legal entity.
669
- */
670
- relationship?: PersonUpdateParams.Relationship;
671
-
672
- /**
673
- * The script addresses (e.g., non-Latin characters) associated with the person.
674
- */
675
- script_addresses?: PersonUpdateParams.ScriptAddresses;
676
-
677
- /**
678
- * The script names (e.g. non-Latin characters) associated with the person.
679
- */
680
- script_names?: PersonUpdateParams.ScriptNames;
681
-
682
- /**
683
- * The person's last name.
684
- */
685
- surname?: string;
686
- }
687
-
688
- namespace PersonUpdateParams {
689
- interface AdditionalAddress {
690
- /**
691
- * City, district, suburb, town, or village.
692
- */
693
- city?: string;
694
-
695
- /**
696
- * Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
697
- */
698
- country?: string;
699
-
700
- /**
701
- * Address line 1 (e.g., street, PO Box, or company name).
702
- */
703
- line1?: string;
704
-
705
- /**
706
- * Address line 2 (e.g., apartment, suite, unit, or building).
707
- */
708
- line2?: string;
709
-
710
- /**
711
- * ZIP or postal code.
712
- */
713
- postal_code?: string;
714
-
715
- /**
716
- * Purpose of additional address.
717
- */
718
- purpose: 'registered';
719
-
720
- /**
721
- * State, county, province, or region.
722
- */
723
- state?: string;
724
-
725
- /**
726
- * Town or cho-me.
727
- */
728
- town?: string;
729
- }
730
-
731
- interface AdditionalName {
732
- /**
733
- * The person's full name.
734
- */
735
- full_name?: string;
736
-
737
- /**
738
- * The person's first or given name.
739
- */
740
- given_name?: string;
741
-
742
- /**
743
- * The purpose or type of the additional name.
744
- */
745
- purpose: AdditionalName.Purpose;
746
-
747
- /**
748
- * The person's last or family name.
749
- */
750
- surname?: string;
751
- }
752
-
753
- namespace AdditionalName {
754
- type Purpose = 'alias' | 'maiden';
755
- }
756
-
757
- interface AdditionalTermsOfService {
758
- /**
759
- * Stripe terms of service agreement.
760
- */
761
- account?: AdditionalTermsOfService.Account;
762
- }
763
-
764
- namespace AdditionalTermsOfService {
765
- interface Account {
766
- /**
767
- * The time when the Account's representative accepted the terms of service. Represented as a RFC 3339 date & time UTC value in millisecond precision, for example: 2022-09-18T13:22:18.123Z.
768
- */
769
- date?: string;
770
-
771
- /**
772
- * The IP address from which the Account's representative accepted the terms of service.
773
- */
774
- ip?: string;
775
-
776
- /**
777
- * The user agent of the browser from which the Account's representative accepted the terms of service.
778
- */
779
- user_agent?: string;
780
- }
781
- }
782
-
783
- interface DateOfBirth {
784
- /**
785
- * The day of the birth.
786
- */
787
- day: number;
788
-
789
- /**
790
- * The month of birth.
791
- */
792
- month: number;
793
-
794
- /**
795
- * The year of birth.
796
- */
797
- year: number;
798
- }
799
-
800
- interface Documents {
801
- /**
802
- * One or more documents that demonstrate proof that this person is authorized to represent the company.
803
- */
804
- company_authorization?: Documents.CompanyAuthorization;
805
-
806
- /**
807
- * One or more documents showing the person's passport page with photo and personal data.
808
- */
809
- passport?: Documents.Passport;
810
-
811
- /**
812
- * An identifying document showing the person's name, either a passport or local ID card.
813
- */
814
- primary_verification?: Documents.PrimaryVerification;
815
-
816
- /**
817
- * A document showing address, either a passport, local ID card, or utility bill from a well-known utility company.
818
- */
819
- secondary_verification?: Documents.SecondaryVerification;
820
-
821
- /**
822
- * One or more documents showing the person's visa required for living in the country where they are residing.
823
- */
824
- visa?: Documents.Visa;
825
- }
826
-
827
- namespace Documents {
828
- interface CompanyAuthorization {
829
- /**
830
- * One or more document IDs returned by a [file upload](https://docs.stripe.com/api/persons/update#create_file) with a purpose value of `account_requirement`.
831
- */
832
- files: Array<string>;
833
-
834
- /**
835
- * The format of the document. Currently supports `files` only.
836
- */
837
- type: 'files';
838
- }
839
-
840
- interface Passport {
841
- /**
842
- * One or more document IDs returned by a [file upload](https://docs.stripe.com/api/persons/update#create_file) with a purpose value of `account_requirement`.
843
- */
844
- files: Array<string>;
845
-
846
- /**
847
- * The format of the document. Currently supports `files` only.
848
- */
849
- type: 'files';
850
- }
851
-
852
- interface PrimaryVerification {
853
- /**
854
- * The [file upload](https://docs.stripe.com/api/persons/update#create_file) tokens referring to each side of the document.
855
- */
856
- front_back: PrimaryVerification.FrontBack;
857
-
858
- /**
859
- * The format of the verification document. Currently supports `front_back` only.
860
- */
861
- type: 'front_back';
862
- }
863
-
864
- namespace PrimaryVerification {
865
- interface FrontBack {
866
- /**
867
- * A [file upload](https://docs.stripe.com/api/persons/update#create_file) token representing the back of the verification document. The purpose of the uploaded file should be 'identity_document'. The uploaded file needs to be a color image (smaller than 8,000px by 8,000px), in JPG, PNG, or PDF format, and less than 10 MB in size.
868
- */
869
- back?: string;
870
-
871
- /**
872
- * A [file upload](https://docs.stripe.com/api/persons/update#create_file) token representing the front of the verification document. The purpose of the uploaded file should be 'identity_document'. The uploaded file needs to be a color image (smaller than 8,000px by 8,000px), in JPG, PNG, or PDF format, and less than 10 MB in size.
873
- */
874
- front?: string;
875
- }
876
- }
877
-
878
- interface SecondaryVerification {
879
- /**
880
- * The [file upload](https://docs.stripe.com/api/persons/update#create_file) tokens referring to each side of the document.
881
- */
882
- front_back: SecondaryVerification.FrontBack;
883
-
884
- /**
885
- * The format of the verification document. Currently supports `front_back` only.
886
- */
887
- type: 'front_back';
888
- }
889
-
890
- namespace SecondaryVerification {
891
- interface FrontBack {
892
- /**
893
- * A [file upload](https://docs.stripe.com/api/persons/update#create_file) token representing the back of the verification document. The purpose of the uploaded file should be 'identity_document'. The uploaded file needs to be a color image (smaller than 8,000px by 8,000px), in JPG, PNG, or PDF format, and less than 10 MB in size.
894
- */
895
- back?: string;
896
-
897
- /**
898
- * A [file upload](https://docs.stripe.com/api/persons/update#create_file) token representing the front of the verification document. The purpose of the uploaded file should be 'identity_document'. The uploaded file needs to be a color image (smaller than 8,000px by 8,000px), in JPG, PNG, or PDF format, and less than 10 MB in size.
899
- */
900
- front?: string;
901
- }
902
- }
903
-
904
- interface Visa {
905
- /**
906
- * One or more document IDs returned by a [file upload](https://docs.stripe.com/api/persons/update#create_file) with a purpose value of `account_requirement`.
907
- */
908
- files: Array<string>;
909
-
910
- /**
911
- * The format of the document. Currently supports `files` only.
912
- */
913
- type: 'files';
914
- }
915
- }
916
-
917
- interface IdNumber {
918
- /**
919
- * The ID number type of an individual.
920
- */
921
- type: IdNumber.Type;
922
-
923
- /**
924
- * The value of the ID number.
925
- */
926
- value: string;
927
- }
928
-
929
- namespace IdNumber {
930
- type Type =
931
- | 'ae_eid'
932
- | 'ao_nif'
933
- | 'az_tin'
934
- | 'bd_brc'
935
- | 'bd_etin'
936
- | 'bd_nid'
937
- | 'br_cpf'
938
- | 'cr_cpf'
939
- | 'cr_dimex'
940
- | 'cr_nite'
941
- | 'de_stn'
942
- | 'do_rcn'
943
- | 'gt_nit'
944
- | 'hk_id'
945
- | 'kz_iin'
946
- | 'mx_rfc'
947
- | 'my_nric'
948
- | 'mz_nuit'
949
- | 'nl_bsn'
950
- | 'pe_dni'
951
- | 'pk_cnic'
952
- | 'pk_snic'
953
- | 'sa_tin'
954
- | 'sg_fin'
955
- | 'sg_nric'
956
- | 'th_lc'
957
- | 'th_pin'
958
- | 'us_itin'
959
- | 'us_itin_last_4'
960
- | 'us_ssn'
961
- | 'us_ssn_last_4';
962
- }
963
-
964
- type LegalGender = 'female' | 'male';
965
-
966
- type PoliticalExposure = 'existing' | 'none';
967
-
968
- interface Relationship {
969
- /**
970
- * Whether the individual is an authorizer of the Account's legal entity.
971
- */
972
- authorizer?: boolean;
973
-
974
- /**
975
- * Indicates whether the person is a director of the associated legal entity.
976
- */
977
- director?: boolean;
978
-
979
- /**
980
- * Indicates whether the person is an executive of the associated legal entity.
981
- */
982
- executive?: boolean;
983
-
984
- /**
985
- * Indicates whether the person is a legal guardian of the associated legal entity.
986
- */
987
- legal_guardian?: boolean;
988
-
989
- /**
990
- * Indicates whether the person is an owner of the associated legal entity.
991
- */
992
- owner?: boolean;
993
-
994
- /**
995
- * The percentage of ownership the person has in the associated legal entity.
996
- */
997
- percent_ownership?: string;
998
-
999
- /**
1000
- * Indicates whether the person is a representative of the associated legal entity.
1001
- */
1002
- representative?: boolean;
1003
-
1004
- /**
1005
- * The title or position the person holds in the associated legal entity.
1006
- */
1007
- title?: string;
1008
- }
1009
-
1010
- interface ScriptAddresses {
1011
- /**
1012
- * Kana Address.
1013
- */
1014
- kana?: Stripe.JapanAddressParam;
1015
-
1016
- /**
1017
- * Kanji Address.
1018
- */
1019
- kanji?: Stripe.JapanAddressParam;
1020
- }
1021
-
1022
- interface ScriptNames {
1023
- /**
1024
- * Persons name in kana script.
1025
- */
1026
- kana?: ScriptNames.Kana;
1027
-
1028
- /**
1029
- * Persons name in kanji script.
1030
- */
1031
- kanji?: ScriptNames.Kanji;
1032
- }
1033
-
1034
- namespace ScriptNames {
1035
- interface Kana {
1036
- /**
1037
- * The person's first or given name.
1038
- */
1039
- given_name?: string;
1040
-
1041
- /**
1042
- * The person's last or family name.
1043
- */
1044
- surname?: string;
1045
- }
1046
-
1047
- interface Kanji {
1048
- /**
1049
- * The person's first or given name.
1050
- */
1051
- given_name?: string;
1052
-
1053
- /**
1054
- * The person's last or family name.
1055
- */
1056
- surname?: string;
1057
- }
1058
- }
1059
- }
1060
- }
1061
- }
1062
-
1063
- namespace Core {
1064
- namespace Accounts {
1065
- interface PersonListParams {
1066
- /**
1067
- * The upper limit on the number of accounts returned by the List Account request.
1068
- */
1069
- limit?: number;
1070
- }
1071
- }
1072
- }
1073
-
1074
- namespace Core {
1075
- namespace Accounts {
1076
- interface PersonDeleteParams {}
1077
- }
1078
- }
1079
-
1080
- namespace Core {
1081
- namespace Accounts {
1082
- class PersonsResource {
1083
- /**
1084
- * Create a Person associated with an Account.
1085
- */
1086
- create(
1087
- id: string,
1088
- params?: PersonCreateParams,
1089
- options?: RequestOptions
1090
- ): Promise<Stripe.Response<Stripe.V2.Core.AccountPerson>>;
1091
- create(
1092
- id: string,
1093
- options?: RequestOptions
1094
- ): Promise<Stripe.Response<Stripe.V2.Core.AccountPerson>>;
1095
-
1096
- /**
1097
- * Retrieves a Person associated with an Account.
1098
- */
1099
- retrieve(
1100
- accountId: string,
1101
- id: string,
1102
- params?: PersonRetrieveParams,
1103
- options?: RequestOptions
1104
- ): Promise<Stripe.Response<Stripe.V2.Core.AccountPerson>>;
1105
- retrieve(
1106
- accountId: string,
1107
- id: string,
1108
- options?: RequestOptions
1109
- ): Promise<Stripe.Response<Stripe.V2.Core.AccountPerson>>;
1110
-
1111
- /**
1112
- * Updates a Person associated with an Account.
1113
- */
1114
- update(
1115
- accountId: string,
1116
- id: string,
1117
- params?: PersonUpdateParams,
1118
- options?: RequestOptions
1119
- ): Promise<Stripe.Response<Stripe.V2.Core.AccountPerson>>;
1120
-
1121
- /**
1122
- * Returns a list of Persons associated with an Account.
1123
- */
1124
- list(
1125
- id: string,
1126
- params?: PersonListParams,
1127
- options?: RequestOptions
1128
- ): ApiListPromise<Stripe.V2.Core.AccountPerson>;
1129
- list(
1130
- id: string,
1131
- options?: RequestOptions
1132
- ): ApiListPromise<Stripe.V2.Core.AccountPerson>;
1133
-
1134
- /**
1135
- * Delete a Person associated with an Account.
1136
- */
1137
- del(
1138
- accountId: string,
1139
- id: string,
1140
- params?: PersonDeleteParams,
1141
- options?: RequestOptions
1142
- ): Promise<Stripe.Response<Stripe.V2.DeletedObject>>;
1143
- del(
1144
- accountId: string,
1145
- id: string,
1146
- options?: RequestOptions
1147
- ): Promise<Stripe.Response<Stripe.V2.DeletedObject>>;
1148
- }
1149
- }
1150
- }
1151
- }
1152
- }
1153
- }