stripe 13.3.0 → 13.4.0.pre.beta.1

Sign up to get free protection for your applications and to get access to all the features.
Files changed (743) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +1410 -650
  3. data/OPENAPI_VERSION +1 -1
  4. data/VERSION +1 -1
  5. data/lib/stripe/api_operations/request.rb +1 -0
  6. data/lib/stripe/api_requestor.rb +1 -0
  7. data/lib/stripe/object_types.rb +32 -0
  8. data/lib/stripe/request_params.rb +24 -0
  9. data/lib/stripe/request_signing_authenticator.rb +79 -0
  10. data/lib/stripe/resources/account.rb +5793 -0
  11. data/lib/stripe/resources/account_link.rb +64 -0
  12. data/lib/stripe/resources/account_notice.rb +154 -0
  13. data/lib/stripe/resources/account_session.rb +1002 -0
  14. data/lib/stripe/resources/apple_pay_domain.rb +73 -0
  15. data/lib/stripe/resources/application.rb +23 -0
  16. data/lib/stripe/resources/application_fee.rb +120 -0
  17. data/lib/stripe/resources/application_fee_refund.rb +24 -0
  18. data/lib/stripe/resources/apps/secret.rb +166 -0
  19. data/lib/stripe/resources/balance.rb +162 -0
  20. data/lib/stripe/resources/balance_transaction.rb +141 -0
  21. data/lib/stripe/resources/bank_account.rb +113 -2
  22. data/lib/stripe/resources/billing/alert.rb +166 -0
  23. data/lib/stripe/resources/billing/alert_triggered.rb +31 -0
  24. data/lib/stripe/resources/billing/credit_balance_summary.rb +89 -0
  25. data/lib/stripe/resources/billing/credit_balance_transaction.rb +140 -0
  26. data/lib/stripe/resources/billing/credit_grant.rb +235 -0
  27. data/lib/stripe/resources/billing/meter.rb +203 -0
  28. data/lib/stripe/resources/billing/meter_error_report.rb +70 -0
  29. data/lib/stripe/resources/billing/meter_event.rb +45 -0
  30. data/lib/stripe/resources/billing/meter_event_adjustment.rb +51 -0
  31. data/lib/stripe/resources/billing/meter_event_summary.rb +21 -0
  32. data/lib/stripe/resources/billing_portal/configuration.rb +639 -0
  33. data/lib/stripe/resources/billing_portal/session.rb +313 -0
  34. data/lib/stripe/resources/capability.rb +111 -0
  35. data/lib/stripe/resources/capital/financing_offer.rb +221 -0
  36. data/lib/stripe/resources/capital/financing_summary.rb +77 -0
  37. data/lib/stripe/resources/capital/financing_transaction.rb +147 -0
  38. data/lib/stripe/resources/card.rb +111 -0
  39. data/lib/stripe/resources/cash_balance.rb +22 -0
  40. data/lib/stripe/resources/charge.rb +3687 -0
  41. data/lib/stripe/resources/checkout/session.rb +4162 -0
  42. data/lib/stripe/resources/climate/order.rb +216 -0
  43. data/lib/stripe/resources/climate/product.rb +69 -0
  44. data/lib/stripe/resources/climate/supplier.rb +67 -0
  45. data/lib/stripe/resources/confirmation_token.rb +1855 -0
  46. data/lib/stripe/resources/connect_collection_transfer.rb +29 -0
  47. data/lib/stripe/resources/country_spec.rb +76 -0
  48. data/lib/stripe/resources/coupon.rb +237 -0
  49. data/lib/stripe/resources/credit_note.rb +798 -0
  50. data/lib/stripe/resources/credit_note_line_item.rb +89 -0
  51. data/lib/stripe/resources/customer.rb +995 -0
  52. data/lib/stripe/resources/customer_balance_transaction.rb +39 -0
  53. data/lib/stripe/resources/customer_cash_balance_transaction.rb +136 -0
  54. data/lib/stripe/resources/customer_session.rb +183 -0
  55. data/lib/stripe/resources/discount.rb +41 -0
  56. data/lib/stripe/resources/dispute.rb +767 -0
  57. data/lib/stripe/resources/entitlements/active_entitlement.rb +54 -0
  58. data/lib/stripe/resources/entitlements/active_entitlement_summary.rb +26 -0
  59. data/lib/stripe/resources/entitlements/feature.rb +107 -0
  60. data/lib/stripe/resources/ephemeral_key.rb +26 -0
  61. data/lib/stripe/resources/event.rb +157 -0
  62. data/lib/stripe/resources/exchange_rate.rb +38 -0
  63. data/lib/stripe/resources/file.rb +134 -0
  64. data/lib/stripe/resources/file_link.rb +134 -0
  65. data/lib/stripe/resources/financial_connections/account.rb +307 -0
  66. data/lib/stripe/resources/financial_connections/account_inferred_balance.rb +30 -0
  67. data/lib/stripe/resources/financial_connections/account_owner.rb +24 -0
  68. data/lib/stripe/resources/financial_connections/account_ownership.rb +12 -0
  69. data/lib/stripe/resources/financial_connections/institution.rb +112 -0
  70. data/lib/stripe/resources/financial_connections/session.rb +187 -0
  71. data/lib/stripe/resources/financial_connections/transaction.rb +122 -0
  72. data/lib/stripe/resources/forwarding/request.rb +196 -0
  73. data/lib/stripe/resources/funding_instructions.rb +415 -0
  74. data/lib/stripe/resources/gift_cards/card.rb +245 -0
  75. data/lib/stripe/resources/gift_cards/transaction.rb +313 -0
  76. data/lib/stripe/resources/identity/verification_report.rb +335 -0
  77. data/lib/stripe/resources/identity/verification_session.rb +430 -0
  78. data/lib/stripe/resources/invoice.rb +9348 -0
  79. data/lib/stripe/resources/invoice_item.rb +536 -0
  80. data/lib/stripe/resources/invoice_line_item.rb +409 -0
  81. data/lib/stripe/resources/invoice_payment.rb +72 -0
  82. data/lib/stripe/resources/invoice_rendering_template.rb +79 -0
  83. data/lib/stripe/resources/issuing/authorization.rb +1316 -2
  84. data/lib/stripe/resources/issuing/card.rb +794 -0
  85. data/lib/stripe/resources/issuing/cardholder.rb +768 -0
  86. data/lib/stripe/resources/issuing/credit_underwriting_record.rb +693 -0
  87. data/lib/stripe/resources/issuing/dispute.rb +941 -0
  88. data/lib/stripe/resources/issuing/dispute_settlement_detail.rb +98 -0
  89. data/lib/stripe/resources/issuing/fraud_liability_debit.rb +109 -0
  90. data/lib/stripe/resources/issuing/personalization_design.rb +333 -0
  91. data/lib/stripe/resources/issuing/physical_bundle.rb +76 -0
  92. data/lib/stripe/resources/issuing/settlement.rb +65 -0
  93. data/lib/stripe/resources/issuing/token.rb +221 -0
  94. data/lib/stripe/resources/issuing/transaction.rb +1098 -0
  95. data/lib/stripe/resources/line_item.rb +98 -0
  96. data/lib/stripe/resources/login_link.rb +9 -0
  97. data/lib/stripe/resources/mandate.rb +214 -0
  98. data/lib/stripe/resources/margin.rb +143 -0
  99. data/lib/stripe/resources/order.rb +3238 -0
  100. data/lib/stripe/resources/payment_attempt_record.rb +226 -0
  101. data/lib/stripe/resources/payment_intent.rb +14630 -0
  102. data/lib/stripe/resources/payment_link.rb +1761 -0
  103. data/lib/stripe/resources/payment_method.rb +1981 -0
  104. data/lib/stripe/resources/payment_method_configuration.rb +3137 -0
  105. data/lib/stripe/resources/payment_method_domain.rb +176 -0
  106. data/lib/stripe/resources/payment_record.rb +824 -0
  107. data/lib/stripe/resources/payout.rb +267 -0
  108. data/lib/stripe/resources/person.rb +353 -0
  109. data/lib/stripe/resources/plan.rb +386 -0
  110. data/lib/stripe/resources/price.rb +782 -0
  111. data/lib/stripe/resources/product.rb +636 -0
  112. data/lib/stripe/resources/product_feature.rb +16 -0
  113. data/lib/stripe/resources/promotion_code.rb +261 -0
  114. data/lib/stripe/resources/quote.rb +3404 -0
  115. data/lib/stripe/resources/quote_line.rb +340 -0
  116. data/lib/stripe/resources/quote_preview_invoice.rb +833 -0
  117. data/lib/stripe/resources/quote_preview_subscription_schedule.rb +463 -0
  118. data/lib/stripe/resources/radar/early_fraud_warning.rb +93 -0
  119. data/lib/stripe/resources/radar/value_list.rb +151 -0
  120. data/lib/stripe/resources/radar/value_list_item.rb +113 -0
  121. data/lib/stripe/resources/refund.rb +489 -0
  122. data/lib/stripe/resources/reporting/report_run.rb +182 -0
  123. data/lib/stripe/resources/reporting/report_type.rb +44 -0
  124. data/lib/stripe/resources/reserve_transaction.rb +26 -0
  125. data/lib/stripe/resources/reversal.rb +30 -0
  126. data/lib/stripe/resources/review.rb +135 -0
  127. data/lib/stripe/resources/setup_attempt.rb +474 -0
  128. data/lib/stripe/resources/setup_intent.rb +4371 -0
  129. data/lib/stripe/resources/shipping_rate.rb +303 -0
  130. data/lib/stripe/resources/sigma/scheduled_query_run.rb +67 -0
  131. data/lib/stripe/resources/source.rb +1571 -0
  132. data/lib/stripe/resources/source_mandate_notification.rb +79 -0
  133. data/lib/stripe/resources/source_transaction.rb +114 -0
  134. data/lib/stripe/resources/subscription.rb +2395 -0
  135. data/lib/stripe/resources/subscription_item.rb +502 -0
  136. data/lib/stripe/resources/subscription_schedule.rb +2790 -0
  137. data/lib/stripe/resources/tax/association.rb +100 -0
  138. data/lib/stripe/resources/tax/calculation.rb +474 -0
  139. data/lib/stripe/resources/tax/calculation_line_item.rb +76 -0
  140. data/lib/stripe/resources/tax/form.rb +253 -0
  141. data/lib/stripe/resources/tax/registration.rb +2174 -0
  142. data/lib/stripe/resources/tax/settings.rb +146 -0
  143. data/lib/stripe/resources/tax/transaction.rb +332 -0
  144. data/lib/stripe/resources/tax/transaction_line_item.rb +43 -0
  145. data/lib/stripe/resources/tax_code.rb +41 -0
  146. data/lib/stripe/resources/tax_deducted_at_source.rb +26 -0
  147. data/lib/stripe/resources/tax_id.rb +147 -0
  148. data/lib/stripe/resources/tax_rate.rb +245 -0
  149. data/lib/stripe/resources/terminal/configuration.rb +1175 -0
  150. data/lib/stripe/resources/terminal/connection_token.rb +21 -0
  151. data/lib/stripe/resources/terminal/location.rb +208 -0
  152. data/lib/stripe/resources/terminal/reader.rb +911 -0
  153. data/lib/stripe/resources/terminal/reader_collected_data.rb +45 -0
  154. data/lib/stripe/resources/test_helpers/test_clock.rb +101 -0
  155. data/lib/stripe/resources/token.rb +1337 -0
  156. data/lib/stripe/resources/topup.rb +210 -0
  157. data/lib/stripe/resources/transfer.rb +188 -0
  158. data/lib/stripe/resources/treasury/credit_reversal.rb +113 -0
  159. data/lib/stripe/resources/treasury/debit_reversal.rb +126 -0
  160. data/lib/stripe/resources/treasury/financial_account.rb +766 -0
  161. data/lib/stripe/resources/treasury/financial_account_features.rb +237 -0
  162. data/lib/stripe/resources/treasury/inbound_transfer.rb +285 -0
  163. data/lib/stripe/resources/treasury/outbound_payment.rb +587 -0
  164. data/lib/stripe/resources/treasury/outbound_transfer.rb +428 -0
  165. data/lib/stripe/resources/treasury/received_credit.rb +335 -0
  166. data/lib/stripe/resources/treasury/received_debit.rb +298 -0
  167. data/lib/stripe/resources/treasury/transaction.rb +215 -0
  168. data/lib/stripe/resources/treasury/transaction_entry.rb +193 -0
  169. data/lib/stripe/resources/usage_record.rb +18 -0
  170. data/lib/stripe/resources/usage_record_summary.rb +28 -0
  171. data/lib/stripe/resources/v2/amount.rb +9 -0
  172. data/lib/stripe/resources/v2/billing/meter_event.rb +24 -0
  173. data/lib/stripe/resources/v2/billing/meter_event_adjustment.rb +28 -0
  174. data/lib/stripe/resources/v2/billing/meter_event_session.rb +19 -0
  175. data/lib/stripe/resources/v2/event.rb +35 -0
  176. data/lib/stripe/resources/v2/event_destination.rb +78 -0
  177. data/lib/stripe/resources/webhook_endpoint.rb +148 -0
  178. data/lib/stripe/resources.rb +31 -0
  179. data/lib/stripe/services/account_capability_service.rb +33 -0
  180. data/lib/stripe/services/account_external_account_service.rb +293 -0
  181. data/lib/stripe/services/account_link_service.rb +53 -0
  182. data/lib/stripe/services/account_login_link_service.rb +9 -0
  183. data/lib/stripe/services/account_notice_service.rb +110 -0
  184. data/lib/stripe/services/account_person_service.rb +1014 -0
  185. data/lib/stripe/services/account_service.rb +4862 -0
  186. data/lib/stripe/services/account_session_service.rb +740 -0
  187. data/lib/stripe/services/apple_pay_domain_service.rb +56 -0
  188. data/lib/stripe/services/application_fee_refund_service.rb +60 -0
  189. data/lib/stripe/services/application_fee_service.rb +65 -0
  190. data/lib/stripe/services/apps/secret_service.rb +132 -0
  191. data/lib/stripe/services/balance_service.rb +9 -0
  192. data/lib/stripe/services/balance_transaction_service.rb +80 -0
  193. data/lib/stripe/services/billing/alert_service.rb +125 -0
  194. data/lib/stripe/services/billing/credit_balance_summary_service.rb +41 -0
  195. data/lib/stripe/services/billing/credit_balance_transaction_service.rb +45 -0
  196. data/lib/stripe/services/billing/credit_grant_service.rb +167 -0
  197. data/lib/stripe/services/billing/meter_event_adjustment_service.rb +29 -0
  198. data/lib/stripe/services/billing/meter_event_service.rb +25 -0
  199. data/lib/stripe/services/billing/meter_event_summary_service.rb +46 -0
  200. data/lib/stripe/services/billing/meter_service.rb +142 -0
  201. data/lib/stripe/services/billing_portal/configuration_service.rb +492 -0
  202. data/lib/stripe/services/billing_portal/session_service.rb +192 -0
  203. data/lib/stripe/services/capital/financing_offer_service.rb +121 -0
  204. data/lib/stripe/services/capital/financing_summary_service.rb +28 -0
  205. data/lib/stripe/services/capital/financing_transaction_service.rb +86 -0
  206. data/lib/stripe/services/capital_service.rb +15 -0
  207. data/lib/stripe/services/charge_service.rb +2010 -0
  208. data/lib/stripe/services/checkout/session_line_item_service.rb +21 -0
  209. data/lib/stripe/services/checkout/session_service.rb +2736 -0
  210. data/lib/stripe/services/climate/order_service.rb +113 -0
  211. data/lib/stripe/services/climate/product_service.rb +30 -0
  212. data/lib/stripe/services/climate/supplier_service.rb +30 -0
  213. data/lib/stripe/services/confirmation_token_service.rb +9 -0
  214. data/lib/stripe/services/country_spec_service.rb +30 -0
  215. data/lib/stripe/services/coupon_service.rb +174 -0
  216. data/lib/stripe/services/credit_note_line_item_service.rb +21 -0
  217. data/lib/stripe/services/credit_note_preview_lines_service.rb +184 -0
  218. data/lib/stripe/services/credit_note_service.rb +434 -0
  219. data/lib/stripe/services/customer_balance_transaction_service.rb +72 -0
  220. data/lib/stripe/services/customer_cash_balance_service.rb +30 -0
  221. data/lib/stripe/services/customer_cash_balance_transaction_service.rb +30 -0
  222. data/lib/stripe/services/customer_funding_instructions_service.rb +47 -0
  223. data/lib/stripe/services/customer_payment_method_service.rb +45 -0
  224. data/lib/stripe/services/customer_payment_source_service.rb +208 -0
  225. data/lib/stripe/services/customer_service.rb +684 -0
  226. data/lib/stripe/services/customer_session_service.rb +106 -0
  227. data/lib/stripe/services/customer_tax_id_service.rb +50 -0
  228. data/lib/stripe/services/dispute_service.rb +439 -0
  229. data/lib/stripe/services/entitlements/active_entitlement_service.rb +40 -0
  230. data/lib/stripe/services/entitlements/feature_service.rb +87 -0
  231. data/lib/stripe/services/ephemeral_key_service.rb +40 -0
  232. data/lib/stripe/services/event_service.rb +75 -0
  233. data/lib/stripe/services/exchange_rate_service.rb +30 -0
  234. data/lib/stripe/services/file_link_service.rb +108 -0
  235. data/lib/stripe/services/file_service.rb +102 -0
  236. data/lib/stripe/services/financial_connections/account_inferred_balance_service.rb +40 -0
  237. data/lib/stripe/services/financial_connections/account_owner_service.rb +31 -0
  238. data/lib/stripe/services/financial_connections/account_service.rb +108 -1
  239. data/lib/stripe/services/financial_connections/institution_service.rb +60 -0
  240. data/lib/stripe/services/financial_connections/session_service.rb +108 -0
  241. data/lib/stripe/services/financial_connections/transaction_service.rb +79 -0
  242. data/lib/stripe/services/financial_connections_service.rb +2 -1
  243. data/lib/stripe/services/forwarding/request_service.rb +120 -0
  244. data/lib/stripe/services/gift_cards/card_service.rb +183 -0
  245. data/lib/stripe/services/gift_cards/transaction_service.rb +225 -0
  246. data/lib/stripe/services/gift_cards_service.rb +14 -0
  247. data/lib/stripe/services/identity/verification_report_service.rb +75 -0
  248. data/lib/stripe/services/identity/verification_session_service.rb +261 -0
  249. data/lib/stripe/services/invoice_item_service.rb +454 -0
  250. data/lib/stripe/services/invoice_line_item_service.rb +277 -0
  251. data/lib/stripe/services/invoice_payment_service.rb +58 -0
  252. data/lib/stripe/services/invoice_rendering_template_service.rb +56 -0
  253. data/lib/stripe/services/invoice_service.rb +6375 -1
  254. data/lib/stripe/services/invoice_upcoming_lines_service.rb +2142 -0
  255. data/lib/stripe/services/issuing/authorization_service.rb +118 -0
  256. data/lib/stripe/services/issuing/card_service.rb +525 -0
  257. data/lib/stripe/services/issuing/cardholder_service.rb +599 -0
  258. data/lib/stripe/services/issuing/credit_underwriting_record_service.rb +560 -0
  259. data/lib/stripe/services/issuing/dispute_service.rb +731 -0
  260. data/lib/stripe/services/issuing/dispute_settlement_detail_service.rb +70 -0
  261. data/lib/stripe/services/issuing/fraud_liability_debit_service.rb +90 -0
  262. data/lib/stripe/services/issuing/personalization_design_service.rb +222 -0
  263. data/lib/stripe/services/issuing/physical_bundle_service.rb +45 -0
  264. data/lib/stripe/services/issuing/token_service.rb +83 -0
  265. data/lib/stripe/services/issuing/transaction_service.rb +93 -0
  266. data/lib/stripe/services/issuing_service.rb +5 -1
  267. data/lib/stripe/services/mandate_service.rb +9 -0
  268. data/lib/stripe/services/margin_service.rb +130 -0
  269. data/lib/stripe/services/order_line_item_service.rb +38 -0
  270. data/lib/stripe/services/order_service.rb +2518 -0
  271. data/lib/stripe/services/payment_attempt_record_service.rb +50 -0
  272. data/lib/stripe/services/payment_intent_service.rb +12203 -0
  273. data/lib/stripe/services/payment_link_line_item_service.rb +21 -0
  274. data/lib/stripe/services/payment_link_service.rb +1343 -0
  275. data/lib/stripe/services/payment_method_configuration_service.rb +2148 -0
  276. data/lib/stripe/services/payment_method_domain_service.rb +84 -0
  277. data/lib/stripe/services/payment_method_service.rb +977 -0
  278. data/lib/stripe/services/payment_record_service.rb +610 -0
  279. data/lib/stripe/services/payout_service.rb +182 -0
  280. data/lib/stripe/services/plan_service.rb +296 -0
  281. data/lib/stripe/services/price_service.rb +603 -0
  282. data/lib/stripe/services/product_feature_service.rb +46 -0
  283. data/lib/stripe/services/product_service.rb +533 -0
  284. data/lib/stripe/services/promotion_code_service.rb +203 -0
  285. data/lib/stripe/services/quote_computed_upfront_line_items_service.rb +21 -0
  286. data/lib/stripe/services/quote_line_item_service.rb +21 -0
  287. data/lib/stripe/services/quote_line_service.rb +38 -0
  288. data/lib/stripe/services/quote_preview_invoice_service.rb +38 -0
  289. data/lib/stripe/services/quote_preview_subscription_schedule_service.rb +38 -0
  290. data/lib/stripe/services/quote_service.rb +2628 -1
  291. data/lib/stripe/services/radar/early_fraud_warning_service.rb +70 -0
  292. data/lib/stripe/services/radar/value_list_item_service.rb +90 -0
  293. data/lib/stripe/services/radar/value_list_service.rb +119 -0
  294. data/lib/stripe/services/refund_service.rb +158 -0
  295. data/lib/stripe/services/reporting/report_run_service.rb +122 -0
  296. data/lib/stripe/services/reporting/report_type_service.rb +18 -0
  297. data/lib/stripe/services/review_service.rb +63 -0
  298. data/lib/stripe/services/setup_attempt_service.rb +59 -0
  299. data/lib/stripe/services/setup_intent_service.rb +3923 -0
  300. data/lib/stripe/services/shipping_rate_service.rb +227 -0
  301. data/lib/stripe/services/sigma/scheduled_query_run_service.rb +30 -0
  302. data/lib/stripe/services/source_service.rb +693 -0
  303. data/lib/stripe/services/source_transaction_service.rb +21 -0
  304. data/lib/stripe/services/subscription_item_service.rb +439 -0
  305. data/lib/stripe/services/subscription_item_usage_record_service.rb +21 -0
  306. data/lib/stripe/services/subscription_item_usage_record_summary_service.rb +21 -0
  307. data/lib/stripe/services/subscription_schedule_service.rb +2343 -0
  308. data/lib/stripe/services/subscription_service.rb +1967 -0
  309. data/lib/stripe/services/tax/association_service.rb +32 -0
  310. data/lib/stripe/services/tax/calculation_line_item_service.rb +21 -0
  311. data/lib/stripe/services/tax/calculation_service.rb +235 -0
  312. data/lib/stripe/services/tax/form_service.rb +107 -0
  313. data/lib/stripe/services/tax/registration_service.rb +1398 -0
  314. data/lib/stripe/services/tax/settings_service.rb +82 -0
  315. data/lib/stripe/services/tax/transaction_line_item_service.rb +21 -0
  316. data/lib/stripe/services/tax/transaction_service.rb +128 -0
  317. data/lib/stripe/services/tax_code_service.rb +30 -0
  318. data/lib/stripe/services/tax_id_service.rb +90 -0
  319. data/lib/stripe/services/tax_rate_service.rb +182 -0
  320. data/lib/stripe/services/tax_service.rb +3 -1
  321. data/lib/stripe/services/terminal/configuration_service.rb +901 -0
  322. data/lib/stripe/services/terminal/connection_token_service.rb +13 -0
  323. data/lib/stripe/services/terminal/location_service.rb +165 -0
  324. data/lib/stripe/services/terminal/reader_collected_data_service.rb +28 -0
  325. data/lib/stripe/services/terminal/reader_service.rb +496 -0
  326. data/lib/stripe/services/terminal_service.rb +2 -1
  327. data/lib/stripe/services/test_helpers/confirmation_token_service.rb +762 -0
  328. data/lib/stripe/services/test_helpers/customer_service.rb +21 -0
  329. data/lib/stripe/services/test_helpers/issuing/authorization_service.rb +844 -0
  330. data/lib/stripe/services/test_helpers/issuing/card_service.rb +45 -0
  331. data/lib/stripe/services/test_helpers/issuing/personalization_design_service.rb +43 -0
  332. data/lib/stripe/services/test_helpers/issuing/transaction_service.rb +723 -0
  333. data/lib/stripe/services/test_helpers/refund_service.rb +9 -0
  334. data/lib/stripe/services/test_helpers/terminal/reader_service.rb +48 -0
  335. data/lib/stripe/services/test_helpers/test_clock_service.rb +63 -0
  336. data/lib/stripe/services/test_helpers/treasury/inbound_transfer_service.rb +39 -0
  337. data/lib/stripe/services/test_helpers/treasury/outbound_payment_service.rb +93 -0
  338. data/lib/stripe/services/test_helpers/treasury/outbound_transfer_service.rb +93 -0
  339. data/lib/stripe/services/test_helpers/treasury/received_credit_service.rb +95 -0
  340. data/lib/stripe/services/test_helpers/treasury/received_debit_service.rb +95 -0
  341. data/lib/stripe/services/token_service.rb +1301 -0
  342. data/lib/stripe/services/topup_service.rb +163 -0
  343. data/lib/stripe/services/transfer_reversal_service.rb +74 -0
  344. data/lib/stripe/services/transfer_service.rb +138 -0
  345. data/lib/stripe/services/treasury/credit_reversal_service.rb +67 -0
  346. data/lib/stripe/services/treasury/debit_reversal_service.rb +72 -0
  347. data/lib/stripe/services/treasury/financial_account_features_service.rb +179 -0
  348. data/lib/stripe/services/treasury/financial_account_service.rb +481 -0
  349. data/lib/stripe/services/treasury/inbound_transfer_service.rb +100 -0
  350. data/lib/stripe/services/treasury/outbound_payment_service.rb +296 -0
  351. data/lib/stripe/services/treasury/outbound_transfer_service.rb +147 -0
  352. data/lib/stripe/services/treasury/received_credit_service.rb +58 -0
  353. data/lib/stripe/services/treasury/received_debit_service.rb +45 -0
  354. data/lib/stripe/services/treasury/transaction_entry_service.rb +101 -0
  355. data/lib/stripe/services/treasury/transaction_service.rb +109 -0
  356. data/lib/stripe/services/v1_services.rb +8 -1
  357. data/lib/stripe/services/v2/billing/meter_event_adjustment_service.rb +25 -0
  358. data/lib/stripe/services/v2/billing/meter_event_service.rb +28 -0
  359. data/lib/stripe/services/v2/billing/meter_event_session_service.rb +3 -0
  360. data/lib/stripe/services/v2/billing/meter_event_stream_service.rb +36 -0
  361. data/lib/stripe/services/v2/core/event_destination_service.rb +164 -0
  362. data/lib/stripe/services/v2/core/event_service.rb +20 -0
  363. data/lib/stripe/services/webhook_endpoint_service.rb +110 -0
  364. data/lib/stripe/services.rb +25 -0
  365. data/lib/stripe/stripe_client.rb +2 -2
  366. data/lib/stripe/stripe_configuration.rb +3 -1
  367. data/lib/stripe/stripe_object.rb +8 -3
  368. data/lib/stripe/util.rb +8 -2
  369. data/lib/stripe/version.rb +1 -1
  370. data/lib/stripe.rb +46 -0
  371. data/rbi/stripe/resources/account.rbi +6072 -0
  372. data/rbi/stripe/resources/account_link.rbi +87 -0
  373. data/rbi/stripe/resources/account_notice.rbi +166 -0
  374. data/rbi/stripe/resources/account_session.rbi +1173 -0
  375. data/rbi/stripe/resources/apple_pay_domain.rbi +111 -0
  376. data/rbi/stripe/resources/application.rbi +23 -0
  377. data/rbi/stripe/resources/application_fee.rbi +151 -0
  378. data/rbi/stripe/resources/application_fee_refund.rbi +44 -0
  379. data/rbi/stripe/resources/apps/secret.rbi +229 -0
  380. data/rbi/stripe/resources/balance.rbi +220 -0
  381. data/rbi/stripe/resources/balance_transaction.rbi +182 -0
  382. data/rbi/stripe/resources/bank_account.rbi +156 -0
  383. data/rbi/stripe/resources/billing/alert.rbi +237 -0
  384. data/rbi/stripe/resources/billing/alert_triggered.rbi +33 -0
  385. data/rbi/stripe/resources/billing/credit_balance_summary.rbi +118 -0
  386. data/rbi/stripe/resources/billing/credit_balance_transaction.rbi +181 -0
  387. data/rbi/stripe/resources/billing/credit_grant.rbi +312 -0
  388. data/rbi/stripe/resources/billing/meter.rbi +268 -0
  389. data/rbi/stripe/resources/billing/meter_error_report.rbi +82 -0
  390. data/rbi/stripe/resources/billing/meter_event.rbi +76 -0
  391. data/rbi/stripe/resources/billing/meter_event_adjustment.rbi +75 -0
  392. data/rbi/stripe/resources/billing/meter_event_summary.rbi +39 -0
  393. data/rbi/stripe/resources/billing_portal/configuration.rbi +746 -0
  394. data/rbi/stripe/resources/billing_portal/session.rbi +396 -0
  395. data/rbi/stripe/resources/capability.rbi +152 -0
  396. data/rbi/stripe/resources/capital/financing_offer.rbi +228 -0
  397. data/rbi/stripe/resources/capital/financing_summary.rbi +89 -0
  398. data/rbi/stripe/resources/capital/financing_transaction.rbi +157 -0
  399. data/rbi/stripe/resources/card.rbi +159 -0
  400. data/rbi/stripe/resources/cash_balance.rbi +37 -0
  401. data/rbi/stripe/resources/charge.rbi +4216 -0
  402. data/rbi/stripe/resources/checkout/session.rbi +4627 -0
  403. data/rbi/stripe/resources/climate/order.rbi +298 -0
  404. data/rbi/stripe/resources/climate/product.rbi +98 -0
  405. data/rbi/stripe/resources/climate/supplier.rbi +95 -0
  406. data/rbi/stripe/resources/confirmation_token.rbi +2137 -0
  407. data/rbi/stripe/resources/connect_collection_transfer.rbi +31 -0
  408. data/rbi/stripe/resources/country_spec.rbi +108 -0
  409. data/rbi/stripe/resources/coupon.rbi +305 -0
  410. data/rbi/stripe/resources/credit_note.rbi +918 -0
  411. data/rbi/stripe/resources/credit_note_line_item.rbi +123 -0
  412. data/rbi/stripe/resources/customer.rbi +1188 -0
  413. data/rbi/stripe/resources/customer_balance_transaction.rbi +65 -0
  414. data/rbi/stripe/resources/customer_cash_balance_transaction.rbi +178 -0
  415. data/rbi/stripe/resources/customer_session.rbi +227 -0
  416. data/rbi/stripe/resources/discount.rbi +65 -0
  417. data/rbi/stripe/resources/dispute.rbi +926 -0
  418. data/rbi/stripe/resources/entitlements/active_entitlement.rbi +76 -0
  419. data/rbi/stripe/resources/entitlements/active_entitlement_summary.rbi +26 -0
  420. data/rbi/stripe/resources/entitlements/feature.rbi +146 -0
  421. data/rbi/stripe/resources/ephemeral_key.rbi +51 -0
  422. data/rbi/stripe/resources/event.rbi +221 -0
  423. data/rbi/stripe/resources/exchange_rate.rbi +81 -0
  424. data/rbi/stripe/resources/file.rbi +177 -0
  425. data/rbi/stripe/resources/file_link.rbi +174 -0
  426. data/rbi/stripe/resources/financial_connections/account.rbi +414 -0
  427. data/rbi/stripe/resources/financial_connections/account_inferred_balance.rbi +30 -0
  428. data/rbi/stripe/resources/financial_connections/account_owner.rbi +42 -0
  429. data/rbi/stripe/resources/financial_connections/account_ownership.rbi +26 -0
  430. data/rbi/stripe/resources/financial_connections/institution.rbi +115 -0
  431. data/rbi/stripe/resources/financial_connections/session.rbi +221 -0
  432. data/rbi/stripe/resources/financial_connections/transaction.rbi +153 -0
  433. data/rbi/stripe/resources/forwarding/request.rbi +257 -0
  434. data/rbi/stripe/resources/funding_instructions.rbi +544 -0
  435. data/rbi/stripe/resources/gift_cards/card.rbi +242 -0
  436. data/rbi/stripe/resources/gift_cards/transaction.rbi +298 -0
  437. data/rbi/stripe/resources/identity/verification_report.rbi +427 -0
  438. data/rbi/stripe/resources/identity/verification_session.rbi +601 -0
  439. data/rbi/stripe/resources/invoice.rbi +10584 -0
  440. data/rbi/stripe/resources/invoice_item.rbi +621 -0
  441. data/rbi/stripe/resources/invoice_line_item.rbi +486 -0
  442. data/rbi/stripe/resources/invoice_payment.rbi +86 -0
  443. data/rbi/stripe/resources/invoice_rendering_template.rbi +131 -0
  444. data/rbi/stripe/resources/issuing/authorization.rbi +1511 -0
  445. data/rbi/stripe/resources/issuing/card.rbi +891 -0
  446. data/rbi/stripe/resources/issuing/cardholder.rbi +870 -0
  447. data/rbi/stripe/resources/issuing/credit_underwriting_record.rbi +731 -0
  448. data/rbi/stripe/resources/issuing/dispute.rbi +1077 -0
  449. data/rbi/stripe/resources/issuing/dispute_settlement_detail.rbi +100 -0
  450. data/rbi/stripe/resources/issuing/fraud_liability_debit.rbi +108 -0
  451. data/rbi/stripe/resources/issuing/personalization_design.rbi +395 -0
  452. data/rbi/stripe/resources/issuing/physical_bundle.rbi +102 -0
  453. data/rbi/stripe/resources/issuing/settlement.rbi +78 -0
  454. data/rbi/stripe/resources/issuing/token.rbi +282 -0
  455. data/rbi/stripe/resources/issuing/transaction.rbi +1262 -0
  456. data/rbi/stripe/resources/line_item.rbi +131 -0
  457. data/rbi/stripe/resources/login_link.rbi +20 -0
  458. data/rbi/stripe/resources/mandate.rbi +266 -0
  459. data/rbi/stripe/resources/margin.rbi +151 -0
  460. data/rbi/stripe/resources/order.rbi +3505 -0
  461. data/rbi/stripe/resources/payment_attempt_record.rbi +260 -0
  462. data/rbi/stripe/resources/payment_intent.rbi +16064 -0
  463. data/rbi/stripe/resources/payment_link.rbi +1943 -0
  464. data/rbi/stripe/resources/payment_method.rbi +2287 -0
  465. data/rbi/stripe/resources/payment_method_configuration.rbi +3657 -0
  466. data/rbi/stripe/resources/payment_method_domain.rbi +246 -0
  467. data/rbi/stripe/resources/payment_record.rbi +856 -0
  468. data/rbi/stripe/resources/payout.rbi +357 -0
  469. data/rbi/stripe/resources/person.rbi +461 -0
  470. data/rbi/stripe/resources/plan.rbi +463 -0
  471. data/rbi/stripe/resources/price.rbi +884 -0
  472. data/rbi/stripe/resources/product.rbi +735 -0
  473. data/rbi/stripe/resources/product_feature.rbi +30 -0
  474. data/rbi/stripe/resources/promotion_code.rbi +316 -0
  475. data/rbi/stripe/resources/quote.rbi +3779 -0
  476. data/rbi/stripe/resources/quote_line.rbi +416 -0
  477. data/rbi/stripe/resources/quote_preview_invoice.rbi +1030 -0
  478. data/rbi/stripe/resources/quote_preview_subscription_schedule.rbi +575 -0
  479. data/rbi/stripe/resources/radar/early_fraud_warning.rbi +121 -0
  480. data/rbi/stripe/resources/radar/value_list.rbi +207 -0
  481. data/rbi/stripe/resources/radar/value_list_item.rbi +157 -0
  482. data/rbi/stripe/resources/refund.rbi +615 -0
  483. data/rbi/stripe/resources/reporting/report_run.rbi +232 -0
  484. data/rbi/stripe/resources/reporting/report_type.rbi +75 -0
  485. data/rbi/stripe/resources/reserve_transaction.rbi +27 -0
  486. data/rbi/stripe/resources/reversal.rbi +60 -0
  487. data/rbi/stripe/resources/review.rbi +191 -0
  488. data/rbi/stripe/resources/setup_attempt.rbi +587 -0
  489. data/rbi/stripe/resources/setup_intent.rbi +4726 -0
  490. data/rbi/stripe/resources/shipping_rate.rbi +367 -0
  491. data/rbi/stripe/resources/sigma/scheduled_query_run.rbi +98 -0
  492. data/rbi/stripe/resources/source.rbi +1899 -0
  493. data/rbi/stripe/resources/source_mandate_notification.rbi +90 -0
  494. data/rbi/stripe/resources/source_transaction.rbi +156 -0
  495. data/rbi/stripe/resources/subscription.rbi +2739 -0
  496. data/rbi/stripe/resources/subscription_item.rbi +566 -0
  497. data/rbi/stripe/resources/subscription_schedule.rbi +3157 -0
  498. data/rbi/stripe/resources/tax/association.rbi +107 -0
  499. data/rbi/stripe/resources/tax/calculation.rbi +577 -0
  500. data/rbi/stripe/resources/tax/calculation_line_item.rbi +108 -0
  501. data/rbi/stripe/resources/tax/form.rbi +262 -0
  502. data/rbi/stripe/resources/tax/registration.rbi +2354 -0
  503. data/rbi/stripe/resources/tax/settings.rbi +174 -0
  504. data/rbi/stripe/resources/tax/transaction.rbi +428 -0
  505. data/rbi/stripe/resources/tax/transaction_line_item.rbi +66 -0
  506. data/rbi/stripe/resources/tax_code.rbi +60 -0
  507. data/rbi/stripe/resources/tax_deducted_at_source.rbi +27 -0
  508. data/rbi/stripe/resources/tax_id.rbi +206 -0
  509. data/rbi/stripe/resources/tax_rate.rbi +295 -0
  510. data/rbi/stripe/resources/terminal/configuration.rbi +1302 -0
  511. data/rbi/stripe/resources/terminal/connection_token.rbi +42 -0
  512. data/rbi/stripe/resources/terminal/location.rbi +271 -0
  513. data/rbi/stripe/resources/terminal/reader.rbi +1110 -0
  514. data/rbi/stripe/resources/terminal/reader_collected_data.rbi +48 -0
  515. data/rbi/stripe/resources/test_helpers/test_clock.rbi +159 -0
  516. data/rbi/stripe/resources/token.rbi +1405 -0
  517. data/rbi/stripe/resources/topup.rbi +269 -0
  518. data/rbi/stripe/resources/transfer.rbi +245 -0
  519. data/rbi/stripe/resources/treasury/credit_reversal.rbi +151 -0
  520. data/rbi/stripe/resources/treasury/debit_reversal.rbi +165 -0
  521. data/rbi/stripe/resources/treasury/financial_account.rbi +924 -0
  522. data/rbi/stripe/resources/treasury/financial_account_features.rbi +309 -0
  523. data/rbi/stripe/resources/treasury/inbound_transfer.rbi +361 -0
  524. data/rbi/stripe/resources/treasury/outbound_payment.rbi +702 -0
  525. data/rbi/stripe/resources/treasury/outbound_transfer.rbi +529 -0
  526. data/rbi/stripe/resources/treasury/received_credit.rbi +408 -0
  527. data/rbi/stripe/resources/treasury/received_debit.rbi +367 -0
  528. data/rbi/stripe/resources/treasury/transaction.rbi +261 -0
  529. data/rbi/stripe/resources/treasury/transaction_entry.rbi +234 -0
  530. data/rbi/stripe/resources/usage_record.rbi +37 -0
  531. data/rbi/stripe/resources/usage_record_summary.rbi +45 -0
  532. data/rbi/stripe/resources/v2/amount.rbi +14 -0
  533. data/rbi/stripe/resources/v2/billing/meter_event.rbi +43 -0
  534. data/rbi/stripe/resources/v2/billing/meter_event_adjustment.rbi +48 -0
  535. data/rbi/stripe/resources/v2/billing/meter_event_session.rbi +36 -0
  536. data/rbi/stripe/resources/v2/event.rbi +55 -0
  537. data/rbi/stripe/resources/v2/event_destination.rbi +109 -0
  538. data/rbi/stripe/resources/webhook_endpoint.rbi +208 -0
  539. data/rbi/stripe/services/account_capability_service.rbi +55 -0
  540. data/rbi/stripe/services/account_external_account_service.rbi +358 -0
  541. data/rbi/stripe/services/account_link_service.rbi +67 -0
  542. data/rbi/stripe/services/account_login_link_service.rbi +23 -0
  543. data/rbi/stripe/services/account_notice_service.rbi +103 -0
  544. data/rbi/stripe/services/account_person_service.rbi +1077 -0
  545. data/rbi/stripe/services/account_service.rbi +4948 -0
  546. data/rbi/stripe/services/account_session_service.rbi +873 -0
  547. data/rbi/stripe/services/apple_pay_domain_service.rbi +86 -0
  548. data/rbi/stripe/services/application_fee_refund_service.rbi +101 -0
  549. data/rbi/stripe/services/application_fee_service.rbi +85 -0
  550. data/rbi/stripe/services/apps/secret_service.rbi +175 -0
  551. data/rbi/stripe/services/apps_service.rbi +9 -0
  552. data/rbi/stripe/services/balance_service.rbi +22 -0
  553. data/rbi/stripe/services/balance_transaction_service.rbi +103 -0
  554. data/rbi/stripe/services/billing/alert_service.rbi +172 -0
  555. data/rbi/stripe/services/billing/credit_balance_summary_service.rbi +61 -0
  556. data/rbi/stripe/services/billing/credit_balance_transaction_service.rbi +66 -0
  557. data/rbi/stripe/services/billing/credit_grant_service.rbi +217 -0
  558. data/rbi/stripe/services/billing/meter_event_adjustment_service.rbi +45 -0
  559. data/rbi/stripe/services/billing/meter_event_service.rbi +47 -0
  560. data/rbi/stripe/services/billing/meter_event_summary_service.rbi +62 -0
  561. data/rbi/stripe/services/billing/meter_service.rbi +184 -0
  562. data/rbi/stripe/services/billing_portal/configuration_service.rbi +573 -0
  563. data/rbi/stripe/services/billing_portal/session_service.rbi +233 -0
  564. data/rbi/stripe/services/billing_portal_service.rbi +10 -0
  565. data/rbi/stripe/services/billing_service.rbi +15 -0
  566. data/rbi/stripe/services/capital/financing_offer_service.rbi +108 -0
  567. data/rbi/stripe/services/capital/financing_summary_service.rbi +23 -0
  568. data/rbi/stripe/services/capital/financing_transaction_service.rbi +77 -0
  569. data/rbi/stripe/services/capital_service.rbi +11 -0
  570. data/rbi/stripe/services/charge_service.rbi +2162 -0
  571. data/rbi/stripe/services/checkout/session_line_item_service.rbi +37 -0
  572. data/rbi/stripe/services/checkout/session_service.rbi +2975 -0
  573. data/rbi/stripe/services/checkout_service.rbi +9 -0
  574. data/rbi/stripe/services/climate/order_service.rbi +158 -0
  575. data/rbi/stripe/services/climate/product_service.rbi +51 -0
  576. data/rbi/stripe/services/climate/supplier_service.rbi +51 -0
  577. data/rbi/stripe/services/climate_service.rbi +11 -0
  578. data/rbi/stripe/services/confirmation_token_service.rbi +21 -0
  579. data/rbi/stripe/services/country_spec_service.rbi +49 -0
  580. data/rbi/stripe/services/coupon_service.rbi +220 -0
  581. data/rbi/stripe/services/credit_note_line_item_service.rbi +35 -0
  582. data/rbi/stripe/services/credit_note_preview_lines_service.rbi +200 -0
  583. data/rbi/stripe/services/credit_note_service.rbi +496 -0
  584. data/rbi/stripe/services/customer_balance_transaction_service.rbi +105 -0
  585. data/rbi/stripe/services/customer_cash_balance_service.rbi +49 -0
  586. data/rbi/stripe/services/customer_cash_balance_transaction_service.rbi +49 -0
  587. data/rbi/stripe/services/customer_funding_instructions_service.rbi +67 -0
  588. data/rbi/stripe/services/customer_payment_method_service.rbi +64 -0
  589. data/rbi/stripe/services/customer_payment_source_service.rbi +265 -0
  590. data/rbi/stripe/services/customer_service.rbi +763 -0
  591. data/rbi/stripe/services/customer_session_service.rbi +126 -0
  592. data/rbi/stripe/services/customer_tax_id_service.rbi +80 -0
  593. data/rbi/stripe/services/dispute_service.rbi +500 -0
  594. data/rbi/stripe/services/entitlements/active_entitlement_service.rbi +61 -0
  595. data/rbi/stripe/services/entitlements/feature_service.rbi +122 -0
  596. data/rbi/stripe/services/entitlements_service.rbi +10 -0
  597. data/rbi/stripe/services/ephemeral_key_service.rbi +59 -0
  598. data/rbi/stripe/services/event_service.rbi +94 -0
  599. data/rbi/stripe/services/exchange_rate_service.rbi +49 -0
  600. data/rbi/stripe/services/file_link_service.rbi +141 -0
  601. data/rbi/stripe/services/file_service.rbi +132 -0
  602. data/rbi/stripe/services/financial_connections/account_inferred_balance_service.rbi +37 -0
  603. data/rbi/stripe/services/financial_connections/account_owner_service.rbi +47 -0
  604. data/rbi/stripe/services/financial_connections/account_service.rbi +148 -0
  605. data/rbi/stripe/services/financial_connections/institution_service.rbi +51 -0
  606. data/rbi/stripe/services/financial_connections/session_service.rbi +128 -0
  607. data/rbi/stripe/services/financial_connections/transaction_service.rbi +103 -0
  608. data/rbi/stripe/services/financial_connections_service.rbi +12 -0
  609. data/rbi/stripe/services/forwarding/request_service.rbi +152 -0
  610. data/rbi/stripe/services/forwarding_service.rbi +9 -0
  611. data/rbi/stripe/services/gift_cards/card_service.rbi +162 -0
  612. data/rbi/stripe/services/gift_cards/transaction_service.rbi +198 -0
  613. data/rbi/stripe/services/gift_cards_service.rbi +10 -0
  614. data/rbi/stripe/services/identity/verification_report_service.rbi +98 -0
  615. data/rbi/stripe/services/identity/verification_session_service.rbi +360 -0
  616. data/rbi/stripe/services/identity_service.rbi +10 -0
  617. data/rbi/stripe/services/invoice_item_service.rbi +505 -0
  618. data/rbi/stripe/services/invoice_line_item_service.rbi +320 -0
  619. data/rbi/stripe/services/invoice_payment_service.rbi +49 -0
  620. data/rbi/stripe/services/invoice_rendering_template_service.rbi +91 -0
  621. data/rbi/stripe/services/invoice_service.rbi +7138 -0
  622. data/rbi/stripe/services/invoice_upcoming_lines_service.rbi +2397 -0
  623. data/rbi/stripe/services/issuing/authorization_service.rbi +160 -0
  624. data/rbi/stripe/services/issuing/card_service.rbi +568 -0
  625. data/rbi/stripe/services/issuing/cardholder_service.rbi +668 -0
  626. data/rbi/stripe/services/issuing/credit_underwriting_record_service.rbi +580 -0
  627. data/rbi/stripe/services/issuing/dispute_service.rbi +824 -0
  628. data/rbi/stripe/services/issuing/dispute_settlement_detail_service.rbi +61 -0
  629. data/rbi/stripe/services/issuing/fraud_liability_debit_service.rbi +83 -0
  630. data/rbi/stripe/services/issuing/personalization_design_service.rbi +271 -0
  631. data/rbi/stripe/services/issuing/physical_bundle_service.rbi +66 -0
  632. data/rbi/stripe/services/issuing/token_service.rbi +109 -0
  633. data/rbi/stripe/services/issuing/transaction_service.rbi +119 -0
  634. data/rbi/stripe/services/issuing_service.rbi +19 -0
  635. data/rbi/stripe/services/mandate_service.rbi +21 -0
  636. data/rbi/stripe/services/margin_service.rbi +119 -0
  637. data/rbi/stripe/services/order_line_item_service.rbi +35 -0
  638. data/rbi/stripe/services/order_service.rbi +2669 -0
  639. data/rbi/stripe/services/payment_attempt_record_service.rbi +39 -0
  640. data/rbi/stripe/services/payment_intent_service.rbi +13193 -0
  641. data/rbi/stripe/services/payment_link_line_item_service.rbi +35 -0
  642. data/rbi/stripe/services/payment_link_service.rbi +1447 -0
  643. data/rbi/stripe/services/payment_method_configuration_service.rbi +2465 -0
  644. data/rbi/stripe/services/payment_method_domain_service.rbi +123 -0
  645. data/rbi/stripe/services/payment_method_service.rbi +1032 -0
  646. data/rbi/stripe/services/payment_record_service.rbi +613 -0
  647. data/rbi/stripe/services/payout_service.rbi +228 -0
  648. data/rbi/stripe/services/plan_service.rbi +337 -0
  649. data/rbi/stripe/services/price_service.rbi +657 -0
  650. data/rbi/stripe/services/product_feature_service.rbi +76 -0
  651. data/rbi/stripe/services/product_service.rbi +596 -0
  652. data/rbi/stripe/services/promotion_code_service.rbi +244 -0
  653. data/rbi/stripe/services/quote_computed_upfront_line_items_service.rbi +35 -0
  654. data/rbi/stripe/services/quote_line_item_service.rbi +35 -0
  655. data/rbi/stripe/services/quote_line_service.rbi +35 -0
  656. data/rbi/stripe/services/quote_preview_invoice_service.rbi +35 -0
  657. data/rbi/stripe/services/quote_preview_subscription_schedule_service.rbi +35 -0
  658. data/rbi/stripe/services/quote_service.rbi +2830 -0
  659. data/rbi/stripe/services/radar/early_fraud_warning_service.rbi +95 -0
  660. data/rbi/stripe/services/radar/value_list_item_service.rbi +122 -0
  661. data/rbi/stripe/services/radar/value_list_service.rbi +160 -0
  662. data/rbi/stripe/services/radar_service.rbi +11 -0
  663. data/rbi/stripe/services/refund_service.rbi +208 -0
  664. data/rbi/stripe/services/reporting/report_run_service.rbi +152 -0
  665. data/rbi/stripe/services/reporting/report_type_service.rbi +37 -0
  666. data/rbi/stripe/services/reporting_service.rbi +10 -0
  667. data/rbi/stripe/services/review_service.rbi +93 -0
  668. data/rbi/stripe/services/setup_attempt_service.rbi +73 -0
  669. data/rbi/stripe/services/setup_intent_service.rbi +4204 -0
  670. data/rbi/stripe/services/shipping_rate_service.rbi +274 -0
  671. data/rbi/stripe/services/sigma/scheduled_query_run_service.rbi +51 -0
  672. data/rbi/stripe/services/sigma_service.rbi +9 -0
  673. data/rbi/stripe/services/source_service.rbi +766 -0
  674. data/rbi/stripe/services/source_transaction_service.rbi +35 -0
  675. data/rbi/stripe/services/subscription_item_service.rbi +496 -0
  676. data/rbi/stripe/services/subscription_item_usage_record_service.rbi +41 -0
  677. data/rbi/stripe/services/subscription_item_usage_record_summary_service.rbi +37 -0
  678. data/rbi/stripe/services/subscription_schedule_service.rbi +2613 -0
  679. data/rbi/stripe/services/subscription_service.rbi +2207 -0
  680. data/rbi/stripe/services/tax/association_service.rbi +27 -0
  681. data/rbi/stripe/services/tax/calculation_line_item_service.rbi +37 -0
  682. data/rbi/stripe/services/tax/calculation_service.rbi +267 -0
  683. data/rbi/stripe/services/tax/form_service.rbi +96 -0
  684. data/rbi/stripe/services/tax/registration_service.rbi +1495 -0
  685. data/rbi/stripe/services/tax/settings_service.rbi +106 -0
  686. data/rbi/stripe/services/tax/transaction_line_item_service.rbi +37 -0
  687. data/rbi/stripe/services/tax/transaction_service.rbi +164 -0
  688. data/rbi/stripe/services/tax_code_service.rbi +49 -0
  689. data/rbi/stripe/services/tax_id_service.rbi +128 -0
  690. data/rbi/stripe/services/tax_rate_service.rbi +215 -0
  691. data/rbi/stripe/services/tax_service.rbi +14 -0
  692. data/rbi/stripe/services/terminal/configuration_service.rbi +976 -0
  693. data/rbi/stripe/services/terminal/connection_token_service.rbi +27 -0
  694. data/rbi/stripe/services/terminal/location_service.rbi +211 -0
  695. data/rbi/stripe/services/terminal/reader_collected_data_service.rbi +23 -0
  696. data/rbi/stripe/services/terminal/reader_service.rbi +591 -0
  697. data/rbi/stripe/services/terminal_service.rbi +13 -0
  698. data/rbi/stripe/services/test_helpers/confirmation_token_service.rbi +892 -0
  699. data/rbi/stripe/services/test_helpers/customer_service.rbi +37 -0
  700. data/rbi/stripe/services/test_helpers/issuing/authorization_service.rbi +974 -0
  701. data/rbi/stripe/services/test_helpers/issuing/card_service.rbi +81 -0
  702. data/rbi/stripe/services/test_helpers/issuing/personalization_design_service.rbi +73 -0
  703. data/rbi/stripe/services/test_helpers/issuing/transaction_service.rbi +825 -0
  704. data/rbi/stripe/services/test_helpers/issuing_service.rbi +14 -0
  705. data/rbi/stripe/services/test_helpers/refund_service.rbi +23 -0
  706. data/rbi/stripe/services/test_helpers/terminal/reader_service.rbi +69 -0
  707. data/rbi/stripe/services/test_helpers/terminal_service.rbi +11 -0
  708. data/rbi/stripe/services/test_helpers/test_clock_service.rbi +100 -0
  709. data/rbi/stripe/services/test_helpers/treasury/inbound_transfer_service.rbi +69 -0
  710. data/rbi/stripe/services/test_helpers/treasury/outbound_payment_service.rbi +137 -0
  711. data/rbi/stripe/services/test_helpers/treasury/outbound_transfer_service.rbi +137 -0
  712. data/rbi/stripe/services/test_helpers/treasury/received_credit_service.rbi +130 -0
  713. data/rbi/stripe/services/test_helpers/treasury/received_debit_service.rbi +130 -0
  714. data/rbi/stripe/services/test_helpers/treasury_service.rbi +15 -0
  715. data/rbi/stripe/services/test_helpers_service.rbi +15 -0
  716. data/rbi/stripe/services/token_service.rbi +1357 -0
  717. data/rbi/stripe/services/topup_service.rbi +200 -0
  718. data/rbi/stripe/services/transfer_reversal_service.rbi +111 -0
  719. data/rbi/stripe/services/transfer_service.rbi +174 -0
  720. data/rbi/stripe/services/treasury/credit_reversal_service.rbi +95 -0
  721. data/rbi/stripe/services/treasury/debit_reversal_service.rbi +100 -0
  722. data/rbi/stripe/services/treasury/financial_account_features_service.rbi +226 -0
  723. data/rbi/stripe/services/treasury/financial_account_service.rbi +577 -0
  724. data/rbi/stripe/services/treasury/inbound_transfer_service.rbi +133 -0
  725. data/rbi/stripe/services/treasury/outbound_payment_service.rbi +350 -0
  726. data/rbi/stripe/services/treasury/outbound_transfer_service.rbi +189 -0
  727. data/rbi/stripe/services/treasury/received_credit_service.rbi +79 -0
  728. data/rbi/stripe/services/treasury/received_debit_service.rbi +66 -0
  729. data/rbi/stripe/services/treasury/transaction_entry_service.rbi +125 -0
  730. data/rbi/stripe/services/treasury/transaction_service.rbi +133 -0
  731. data/rbi/stripe/services/treasury_service.rbi +18 -0
  732. data/rbi/stripe/services/v1_services.rbi +83 -0
  733. data/rbi/stripe/services/v2/billing/meter_event_adjustment_service.rbi +43 -0
  734. data/rbi/stripe/services/v2/billing/meter_event_service.rbi +46 -0
  735. data/rbi/stripe/services/v2/billing/meter_event_session_service.rbi +20 -0
  736. data/rbi/stripe/services/v2/billing/meter_event_stream_service.rbi +60 -0
  737. data/rbi/stripe/services/v2/billing_service.rbi +14 -0
  738. data/rbi/stripe/services/v2/core/event_destination_service.rbi +228 -0
  739. data/rbi/stripe/services/v2/core/event_service.rbi +42 -0
  740. data/rbi/stripe/services/v2/core_service.rbi +12 -0
  741. data/rbi/stripe/services/v2_services.rbi +10 -0
  742. data/rbi/stripe/services/webhook_endpoint_service.rbi +149 -0
  743. metadata +435 -4
@@ -0,0 +1,1405 @@
1
+ # File generated from our OpenAPI spec
2
+ # frozen_string_literal: true
3
+
4
+ # typed: true
5
+ module Stripe
6
+ # Tokenization is the process Stripe uses to collect sensitive card or bank
7
+ # account details, or personally identifiable information (PII), directly from
8
+ # your customers in a secure manner. A token representing this information is
9
+ # returned to your server to use. Use our
10
+ # [recommended payments integrations](https://stripe.com/docs/payments) to perform this process
11
+ # on the client-side. This guarantees that no sensitive card data touches your server,
12
+ # and allows your integration to operate in a PCI-compliant way.
13
+ #
14
+ # If you can't use client-side tokenization, you can also create tokens using
15
+ # the API with either your publishable or secret API key. If
16
+ # your integration uses this method, you're responsible for any PCI compliance
17
+ # that it might require, and you must keep your secret API key safe. Unlike with
18
+ # client-side tokenization, your customer's information isn't sent directly to
19
+ # Stripe, so we can't determine how it's handled or stored.
20
+ #
21
+ # You can't store or use tokens more than once. To store card or bank account
22
+ # information for later use, create [Customer](https://stripe.com/docs/api#customers)
23
+ # objects or [External accounts](https://stripe.com/api#external_accounts).
24
+ # [Radar](https://stripe.com/docs/radar), our integrated solution for automatic fraud protection,
25
+ # performs best with integrations that use client-side tokenization.
26
+ class Token < APIResource
27
+ # These bank accounts are payment methods on `Customer` objects.
28
+ #
29
+ # On the other hand [External Accounts](/api#external_accounts) are transfer
30
+ # destinations on `Account` objects for connected accounts.
31
+ # They can be bank accounts or debit cards as well, and are documented in the links above.
32
+ #
33
+ # Related guide: [Bank debits and transfers](/payments/bank-debits-transfers)
34
+ sig { returns(Stripe::BankAccount) }
35
+ attr_reader :bank_account
36
+
37
+ # You can store multiple cards on a customer in order to charge the customer
38
+ # later. You can also store multiple debit cards on a recipient in order to
39
+ # transfer to those cards later.
40
+ #
41
+ # Related guide: [Card payments with Sources](https://stripe.com/docs/sources/cards)
42
+ sig { returns(Stripe::Card) }
43
+ attr_reader :card
44
+
45
+ # IP address of the client that generates the token.
46
+ sig { returns(T.nilable(String)) }
47
+ attr_reader :client_ip
48
+
49
+ # Time at which the object was created. Measured in seconds since the Unix epoch.
50
+ sig { returns(Integer) }
51
+ attr_reader :created
52
+
53
+ # Unique identifier for the object.
54
+ sig { returns(String) }
55
+ attr_reader :id
56
+
57
+ # Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
58
+ sig { returns(T::Boolean) }
59
+ attr_reader :livemode
60
+
61
+ # String representing the object's type. Objects of the same type share the same value.
62
+ sig { returns(String) }
63
+ attr_reader :object
64
+
65
+ # Type of the token: `account`, `bank_account`, `card`, or `pii`.
66
+ sig { returns(String) }
67
+ attr_reader :type
68
+
69
+ # Determines if you have already used this token (you can only use tokens once).
70
+ sig { returns(T::Boolean) }
71
+ attr_reader :used
72
+
73
+ class RetrieveParams < Stripe::RequestParams
74
+ # Specifies which fields in the response should be expanded.
75
+ sig { returns(T::Array[String]) }
76
+ attr_accessor :expand
77
+
78
+ sig { params(expand: T::Array[String]).void }
79
+ def initialize(expand: nil); end
80
+ end
81
+ class CreateParams < Stripe::RequestParams
82
+ class Account < Stripe::RequestParams
83
+ class Company < Stripe::RequestParams
84
+ class Address < Stripe::RequestParams
85
+ # City, district, suburb, town, or village.
86
+ sig { returns(String) }
87
+ attr_accessor :city
88
+
89
+ # Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
90
+ sig { returns(String) }
91
+ attr_accessor :country
92
+
93
+ # Address line 1 (e.g., street, PO Box, or company name).
94
+ sig { returns(String) }
95
+ attr_accessor :line1
96
+
97
+ # Address line 2 (e.g., apartment, suite, unit, or building).
98
+ sig { returns(String) }
99
+ attr_accessor :line2
100
+
101
+ # ZIP or postal code.
102
+ sig { returns(String) }
103
+ attr_accessor :postal_code
104
+
105
+ # State, county, province, or region.
106
+ sig { returns(String) }
107
+ attr_accessor :state
108
+
109
+ sig {
110
+ params(city: String, country: String, line1: String, line2: String, postal_code: String, state: String).void
111
+ }
112
+ def initialize(
113
+ city: nil,
114
+ country: nil,
115
+ line1: nil,
116
+ line2: nil,
117
+ postal_code: nil,
118
+ state: nil
119
+ ); end
120
+ end
121
+ class AddressKana < Stripe::RequestParams
122
+ # City or ward.
123
+ sig { returns(String) }
124
+ attr_accessor :city
125
+
126
+ # Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
127
+ sig { returns(String) }
128
+ attr_accessor :country
129
+
130
+ # Block or building number.
131
+ sig { returns(String) }
132
+ attr_accessor :line1
133
+
134
+ # Building details.
135
+ sig { returns(String) }
136
+ attr_accessor :line2
137
+
138
+ # Postal code.
139
+ sig { returns(String) }
140
+ attr_accessor :postal_code
141
+
142
+ # Prefecture.
143
+ sig { returns(String) }
144
+ attr_accessor :state
145
+
146
+ # Town or cho-me.
147
+ sig { returns(String) }
148
+ attr_accessor :town
149
+
150
+ sig {
151
+ params(city: String, country: String, line1: String, line2: String, postal_code: String, state: String, town: String).void
152
+ }
153
+ def initialize(
154
+ city: nil,
155
+ country: nil,
156
+ line1: nil,
157
+ line2: nil,
158
+ postal_code: nil,
159
+ state: nil,
160
+ town: nil
161
+ ); end
162
+ end
163
+ class AddressKanji < Stripe::RequestParams
164
+ # City or ward.
165
+ sig { returns(String) }
166
+ attr_accessor :city
167
+
168
+ # Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
169
+ sig { returns(String) }
170
+ attr_accessor :country
171
+
172
+ # Block or building number.
173
+ sig { returns(String) }
174
+ attr_accessor :line1
175
+
176
+ # Building details.
177
+ sig { returns(String) }
178
+ attr_accessor :line2
179
+
180
+ # Postal code.
181
+ sig { returns(String) }
182
+ attr_accessor :postal_code
183
+
184
+ # Prefecture.
185
+ sig { returns(String) }
186
+ attr_accessor :state
187
+
188
+ # Town or cho-me.
189
+ sig { returns(String) }
190
+ attr_accessor :town
191
+
192
+ sig {
193
+ params(city: String, country: String, line1: String, line2: String, postal_code: String, state: String, town: String).void
194
+ }
195
+ def initialize(
196
+ city: nil,
197
+ country: nil,
198
+ line1: nil,
199
+ line2: nil,
200
+ postal_code: nil,
201
+ state: nil,
202
+ town: nil
203
+ ); end
204
+ end
205
+ class OwnershipDeclaration < Stripe::RequestParams
206
+ # The Unix timestamp marking when the beneficial owner attestation was made.
207
+ sig { returns(Integer) }
208
+ attr_accessor :date
209
+
210
+ # The IP address from which the beneficial owner attestation was made.
211
+ sig { returns(String) }
212
+ attr_accessor :ip
213
+
214
+ # The user agent of the browser from which the beneficial owner attestation was made.
215
+ sig { returns(String) }
216
+ attr_accessor :user_agent
217
+
218
+ sig { params(date: Integer, ip: String, user_agent: String).void }
219
+ def initialize(date: nil, ip: nil, user_agent: nil); end
220
+ end
221
+ class Verification < Stripe::RequestParams
222
+ class Document < Stripe::RequestParams
223
+ # The back of a document returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `additional_verification`. 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.
224
+ sig { returns(String) }
225
+ attr_accessor :back
226
+
227
+ # The front of a document returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `additional_verification`. 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.
228
+ sig { returns(String) }
229
+ attr_accessor :front
230
+
231
+ sig { params(back: String, front: String).void }
232
+ def initialize(back: nil, front: nil); end
233
+ end
234
+ # A document verifying the business.
235
+ sig { returns(::Stripe::Token::CreateParams::Account::Company::Verification::Document) }
236
+ attr_accessor :document
237
+
238
+ sig {
239
+ params(document: ::Stripe::Token::CreateParams::Account::Company::Verification::Document).void
240
+ }
241
+ def initialize(document: nil); end
242
+ end
243
+ # The company's primary address.
244
+ sig { returns(::Stripe::Token::CreateParams::Account::Company::Address) }
245
+ attr_accessor :address
246
+
247
+ # The Kana variation of the company's primary address (Japan only).
248
+ sig { returns(::Stripe::Token::CreateParams::Account::Company::AddressKana) }
249
+ attr_accessor :address_kana
250
+
251
+ # The Kanji variation of the company's primary address (Japan only).
252
+ sig { returns(::Stripe::Token::CreateParams::Account::Company::AddressKanji) }
253
+ attr_accessor :address_kanji
254
+
255
+ # Whether the company's directors have been provided. Set this Boolean to `true` after creating all the company's directors with [the Persons API](/api/persons) for accounts with a `relationship.director` requirement. This value is not automatically set to `true` after creating directors, so it needs to be updated to indicate all directors have been provided.
256
+ sig { returns(T::Boolean) }
257
+ attr_accessor :directors_provided
258
+
259
+ # Whether the company's executives have been provided. Set this Boolean to `true` after creating all the company's executives with [the Persons API](/api/persons) for accounts with a `relationship.executive` requirement.
260
+ sig { returns(T::Boolean) }
261
+ attr_accessor :executives_provided
262
+
263
+ # The export license ID number of the company, also referred as Import Export Code (India only).
264
+ sig { returns(String) }
265
+ attr_accessor :export_license_id
266
+
267
+ # The purpose code to use for export transactions (India only).
268
+ sig { returns(String) }
269
+ attr_accessor :export_purpose_code
270
+
271
+ # The company's legal name.
272
+ sig { returns(String) }
273
+ attr_accessor :name
274
+
275
+ # The Kana variation of the company's legal name (Japan only).
276
+ sig { returns(String) }
277
+ attr_accessor :name_kana
278
+
279
+ # The Kanji variation of the company's legal name (Japan only).
280
+ sig { returns(String) }
281
+ attr_accessor :name_kanji
282
+
283
+ # Whether the company's owners have been provided. Set this Boolean to `true` after creating all the company's owners with [the Persons API](/api/persons) for accounts with a `relationship.owner` requirement.
284
+ sig { returns(T::Boolean) }
285
+ attr_accessor :owners_provided
286
+
287
+ # This hash is used to attest that the beneficial owner information provided to Stripe is both current and correct.
288
+ sig { returns(::Stripe::Token::CreateParams::Account::Company::OwnershipDeclaration) }
289
+ attr_accessor :ownership_declaration
290
+
291
+ # Whether the user described by the data in the token has been shown the Ownership Declaration and indicated that it is correct.
292
+ sig { returns(T::Boolean) }
293
+ attr_accessor :ownership_declaration_shown_and_signed
294
+
295
+ # The company's phone number (used for verification).
296
+ sig { returns(String) }
297
+ attr_accessor :phone
298
+
299
+ # The identification number given to a company when it is registered or incorporated, if distinct from the identification number used for filing taxes. (Examples are the CIN for companies and LLP IN for partnerships in India, and the Company Registration Number in Hong Kong).
300
+ sig { returns(String) }
301
+ attr_accessor :registration_number
302
+
303
+ # The category identifying the legal structure of the company or legal entity. See [Business structure](/connect/identity-verification#business-structure) for more details. Pass an empty string to unset this value.
304
+ sig { returns(T.nilable(String)) }
305
+ attr_accessor :structure
306
+
307
+ # The business ID number of the company, as appropriate for the company’s country. (Examples are an Employer ID Number in the U.S., a Business Number in Canada, or a Company Number in the UK.)
308
+ sig { returns(String) }
309
+ attr_accessor :tax_id
310
+
311
+ # The jurisdiction in which the `tax_id` is registered (Germany-based companies only).
312
+ sig { returns(String) }
313
+ attr_accessor :tax_id_registrar
314
+
315
+ # The VAT number of the company.
316
+ sig { returns(String) }
317
+ attr_accessor :vat_id
318
+
319
+ # Information on the verification state of the company.
320
+ sig { returns(::Stripe::Token::CreateParams::Account::Company::Verification) }
321
+ attr_accessor :verification
322
+
323
+ sig {
324
+ params(address: ::Stripe::Token::CreateParams::Account::Company::Address, address_kana: ::Stripe::Token::CreateParams::Account::Company::AddressKana, address_kanji: ::Stripe::Token::CreateParams::Account::Company::AddressKanji, directors_provided: T::Boolean, executives_provided: T::Boolean, export_license_id: String, export_purpose_code: String, name: String, name_kana: String, name_kanji: String, owners_provided: T::Boolean, ownership_declaration: ::Stripe::Token::CreateParams::Account::Company::OwnershipDeclaration, ownership_declaration_shown_and_signed: T::Boolean, phone: String, registration_number: String, structure: T.nilable(String), tax_id: String, tax_id_registrar: String, vat_id: String, verification: ::Stripe::Token::CreateParams::Account::Company::Verification).void
325
+ }
326
+ def initialize(
327
+ address: nil,
328
+ address_kana: nil,
329
+ address_kanji: nil,
330
+ directors_provided: nil,
331
+ executives_provided: nil,
332
+ export_license_id: nil,
333
+ export_purpose_code: nil,
334
+ name: nil,
335
+ name_kana: nil,
336
+ name_kanji: nil,
337
+ owners_provided: nil,
338
+ ownership_declaration: nil,
339
+ ownership_declaration_shown_and_signed: nil,
340
+ phone: nil,
341
+ registration_number: nil,
342
+ structure: nil,
343
+ tax_id: nil,
344
+ tax_id_registrar: nil,
345
+ vat_id: nil,
346
+ verification: nil
347
+ ); end
348
+ end
349
+ class Individual < Stripe::RequestParams
350
+ class Address < Stripe::RequestParams
351
+ # City, district, suburb, town, or village.
352
+ sig { returns(String) }
353
+ attr_accessor :city
354
+
355
+ # Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
356
+ sig { returns(String) }
357
+ attr_accessor :country
358
+
359
+ # Address line 1 (e.g., street, PO Box, or company name).
360
+ sig { returns(String) }
361
+ attr_accessor :line1
362
+
363
+ # Address line 2 (e.g., apartment, suite, unit, or building).
364
+ sig { returns(String) }
365
+ attr_accessor :line2
366
+
367
+ # ZIP or postal code.
368
+ sig { returns(String) }
369
+ attr_accessor :postal_code
370
+
371
+ # State, county, province, or region.
372
+ sig { returns(String) }
373
+ attr_accessor :state
374
+
375
+ sig {
376
+ params(city: String, country: String, line1: String, line2: String, postal_code: String, state: String).void
377
+ }
378
+ def initialize(
379
+ city: nil,
380
+ country: nil,
381
+ line1: nil,
382
+ line2: nil,
383
+ postal_code: nil,
384
+ state: nil
385
+ ); end
386
+ end
387
+ class AddressKana < Stripe::RequestParams
388
+ # City or ward.
389
+ sig { returns(String) }
390
+ attr_accessor :city
391
+
392
+ # Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
393
+ sig { returns(String) }
394
+ attr_accessor :country
395
+
396
+ # Block or building number.
397
+ sig { returns(String) }
398
+ attr_accessor :line1
399
+
400
+ # Building details.
401
+ sig { returns(String) }
402
+ attr_accessor :line2
403
+
404
+ # Postal code.
405
+ sig { returns(String) }
406
+ attr_accessor :postal_code
407
+
408
+ # Prefecture.
409
+ sig { returns(String) }
410
+ attr_accessor :state
411
+
412
+ # Town or cho-me.
413
+ sig { returns(String) }
414
+ attr_accessor :town
415
+
416
+ sig {
417
+ params(city: String, country: String, line1: String, line2: String, postal_code: String, state: String, town: String).void
418
+ }
419
+ def initialize(
420
+ city: nil,
421
+ country: nil,
422
+ line1: nil,
423
+ line2: nil,
424
+ postal_code: nil,
425
+ state: nil,
426
+ town: nil
427
+ ); end
428
+ end
429
+ class AddressKanji < Stripe::RequestParams
430
+ # City or ward.
431
+ sig { returns(String) }
432
+ attr_accessor :city
433
+
434
+ # Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
435
+ sig { returns(String) }
436
+ attr_accessor :country
437
+
438
+ # Block or building number.
439
+ sig { returns(String) }
440
+ attr_accessor :line1
441
+
442
+ # Building details.
443
+ sig { returns(String) }
444
+ attr_accessor :line2
445
+
446
+ # Postal code.
447
+ sig { returns(String) }
448
+ attr_accessor :postal_code
449
+
450
+ # Prefecture.
451
+ sig { returns(String) }
452
+ attr_accessor :state
453
+
454
+ # Town or cho-me.
455
+ sig { returns(String) }
456
+ attr_accessor :town
457
+
458
+ sig {
459
+ params(city: String, country: String, line1: String, line2: String, postal_code: String, state: String, town: String).void
460
+ }
461
+ def initialize(
462
+ city: nil,
463
+ country: nil,
464
+ line1: nil,
465
+ line2: nil,
466
+ postal_code: nil,
467
+ state: nil,
468
+ town: nil
469
+ ); end
470
+ end
471
+ class Dob < Stripe::RequestParams
472
+ # The day of birth, between 1 and 31.
473
+ sig { returns(Integer) }
474
+ attr_accessor :day
475
+
476
+ # The month of birth, between 1 and 12.
477
+ sig { returns(Integer) }
478
+ attr_accessor :month
479
+
480
+ # The four-digit year of birth.
481
+ sig { returns(Integer) }
482
+ attr_accessor :year
483
+
484
+ sig { params(day: Integer, month: Integer, year: Integer).void }
485
+ def initialize(day: nil, month: nil, year: nil); end
486
+ end
487
+ class RegisteredAddress < Stripe::RequestParams
488
+ # City, district, suburb, town, or village.
489
+ sig { returns(String) }
490
+ attr_accessor :city
491
+
492
+ # Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
493
+ sig { returns(String) }
494
+ attr_accessor :country
495
+
496
+ # Address line 1 (e.g., street, PO Box, or company name).
497
+ sig { returns(String) }
498
+ attr_accessor :line1
499
+
500
+ # Address line 2 (e.g., apartment, suite, unit, or building).
501
+ sig { returns(String) }
502
+ attr_accessor :line2
503
+
504
+ # ZIP or postal code.
505
+ sig { returns(String) }
506
+ attr_accessor :postal_code
507
+
508
+ # State, county, province, or region.
509
+ sig { returns(String) }
510
+ attr_accessor :state
511
+
512
+ sig {
513
+ params(city: String, country: String, line1: String, line2: String, postal_code: String, state: String).void
514
+ }
515
+ def initialize(
516
+ city: nil,
517
+ country: nil,
518
+ line1: nil,
519
+ line2: nil,
520
+ postal_code: nil,
521
+ state: nil
522
+ ); end
523
+ end
524
+ class Relationship < Stripe::RequestParams
525
+ # Whether the person is a director of the account's legal entity. Directors are typically members of the governing board of the company, or responsible for ensuring the company meets its regulatory obligations.
526
+ sig { returns(T::Boolean) }
527
+ attr_accessor :director
528
+
529
+ # Whether the person has significant responsibility to control, manage, or direct the organization.
530
+ sig { returns(T::Boolean) }
531
+ attr_accessor :executive
532
+
533
+ # Whether the person is an owner of the account’s legal entity.
534
+ sig { returns(T::Boolean) }
535
+ attr_accessor :owner
536
+
537
+ # The percent owned by the person of the account's legal entity.
538
+ sig { returns(T.nilable(Float)) }
539
+ attr_accessor :percent_ownership
540
+
541
+ # The person's title (e.g., CEO, Support Engineer).
542
+ sig { returns(String) }
543
+ attr_accessor :title
544
+
545
+ sig {
546
+ params(director: T::Boolean, executive: T::Boolean, owner: T::Boolean, percent_ownership: T.nilable(Float), title: String).void
547
+ }
548
+ def initialize(
549
+ director: nil,
550
+ executive: nil,
551
+ owner: nil,
552
+ percent_ownership: nil,
553
+ title: nil
554
+ ); end
555
+ end
556
+ class Verification < Stripe::RequestParams
557
+ class AdditionalDocument < Stripe::RequestParams
558
+ # The back of an ID returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `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.
559
+ sig { returns(String) }
560
+ attr_accessor :back
561
+
562
+ # The front of an ID returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `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.
563
+ sig { returns(String) }
564
+ attr_accessor :front
565
+
566
+ sig { params(back: String, front: String).void }
567
+ def initialize(back: nil, front: nil); end
568
+ end
569
+ class Document < Stripe::RequestParams
570
+ # The back of an ID returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `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.
571
+ sig { returns(String) }
572
+ attr_accessor :back
573
+
574
+ # The front of an ID returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `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.
575
+ sig { returns(String) }
576
+ attr_accessor :front
577
+
578
+ sig { params(back: String, front: String).void }
579
+ def initialize(back: nil, front: nil); end
580
+ end
581
+ # A document showing address, either a passport, local ID card, or utility bill from a well-known utility company.
582
+ sig {
583
+ returns(::Stripe::Token::CreateParams::Account::Individual::Verification::AdditionalDocument)
584
+ }
585
+ attr_accessor :additional_document
586
+
587
+ # An identifying document, either a passport or local ID card.
588
+ sig {
589
+ returns(::Stripe::Token::CreateParams::Account::Individual::Verification::Document)
590
+ }
591
+ attr_accessor :document
592
+
593
+ sig {
594
+ params(additional_document: ::Stripe::Token::CreateParams::Account::Individual::Verification::AdditionalDocument, document: ::Stripe::Token::CreateParams::Account::Individual::Verification::Document).void
595
+ }
596
+ def initialize(additional_document: nil, document: nil); end
597
+ end
598
+ # The individual's primary address.
599
+ sig { returns(::Stripe::Token::CreateParams::Account::Individual::Address) }
600
+ attr_accessor :address
601
+
602
+ # The Kana variation of the individual's primary address (Japan only).
603
+ sig { returns(::Stripe::Token::CreateParams::Account::Individual::AddressKana) }
604
+ attr_accessor :address_kana
605
+
606
+ # The Kanji variation of the individual's primary address (Japan only).
607
+ sig { returns(::Stripe::Token::CreateParams::Account::Individual::AddressKanji) }
608
+ attr_accessor :address_kanji
609
+
610
+ # The individual's date of birth.
611
+ sig { returns(T.nilable(::Stripe::Token::CreateParams::Account::Individual::Dob)) }
612
+ attr_accessor :dob
613
+
614
+ # The individual's email address.
615
+ sig { returns(String) }
616
+ attr_accessor :email
617
+
618
+ # The individual's first name.
619
+ sig { returns(String) }
620
+ attr_accessor :first_name
621
+
622
+ # The Kana variation of the individual's first name (Japan only).
623
+ sig { returns(String) }
624
+ attr_accessor :first_name_kana
625
+
626
+ # The Kanji variation of the individual's first name (Japan only).
627
+ sig { returns(String) }
628
+ attr_accessor :first_name_kanji
629
+
630
+ # A list of alternate names or aliases that the individual is known by.
631
+ sig { returns(T.nilable(T::Array[String])) }
632
+ attr_accessor :full_name_aliases
633
+
634
+ # The individual's gender
635
+ sig { returns(String) }
636
+ attr_accessor :gender
637
+
638
+ # The government-issued ID number of the individual, as appropriate for the representative's country. (Examples are a Social Security Number in the U.S., or a Social Insurance Number in Canada). Instead of the number itself, you can also provide a [PII token created with Stripe.js](/js/tokens/create_token?type=pii).
639
+ sig { returns(String) }
640
+ attr_accessor :id_number
641
+
642
+ # The government-issued secondary ID number of the individual, as appropriate for the representative's country, will be used for enhanced verification checks. In Thailand, this would be the laser code found on the back of an ID card. Instead of the number itself, you can also provide a [PII token created with Stripe.js](/js/tokens/create_token?type=pii).
643
+ sig { returns(String) }
644
+ attr_accessor :id_number_secondary
645
+
646
+ # The individual's last name.
647
+ sig { returns(String) }
648
+ attr_accessor :last_name
649
+
650
+ # The Kana variation of the individual's last name (Japan only).
651
+ sig { returns(String) }
652
+ attr_accessor :last_name_kana
653
+
654
+ # The Kanji variation of the individual's last name (Japan only).
655
+ sig { returns(String) }
656
+ attr_accessor :last_name_kanji
657
+
658
+ # The individual's maiden name.
659
+ sig { returns(String) }
660
+ attr_accessor :maiden_name
661
+
662
+ # Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
663
+ sig { returns(T.nilable(T::Hash[String, String])) }
664
+ attr_accessor :metadata
665
+
666
+ # The individual's phone number.
667
+ sig { returns(String) }
668
+ attr_accessor :phone
669
+
670
+ # Indicates if the person or any of their representatives, family members, or other closely related persons, declares that they hold or have held an important public job or function, in any jurisdiction.
671
+ sig { returns(String) }
672
+ attr_accessor :political_exposure
673
+
674
+ # The individual's registered address.
675
+ sig { returns(::Stripe::Token::CreateParams::Account::Individual::RegisteredAddress) }
676
+ attr_accessor :registered_address
677
+
678
+ # Describes the person’s relationship to the account.
679
+ sig { returns(::Stripe::Token::CreateParams::Account::Individual::Relationship) }
680
+ attr_accessor :relationship
681
+
682
+ # The last four digits of the individual's Social Security Number (U.S. only).
683
+ sig { returns(String) }
684
+ attr_accessor :ssn_last_4
685
+
686
+ # The individual's verification document information.
687
+ sig { returns(::Stripe::Token::CreateParams::Account::Individual::Verification) }
688
+ attr_accessor :verification
689
+
690
+ sig {
691
+ params(address: ::Stripe::Token::CreateParams::Account::Individual::Address, address_kana: ::Stripe::Token::CreateParams::Account::Individual::AddressKana, address_kanji: ::Stripe::Token::CreateParams::Account::Individual::AddressKanji, dob: T.nilable(::Stripe::Token::CreateParams::Account::Individual::Dob), email: String, first_name: String, first_name_kana: String, first_name_kanji: String, full_name_aliases: T.nilable(T::Array[String]), gender: String, id_number: String, id_number_secondary: String, last_name: String, last_name_kana: String, last_name_kanji: String, maiden_name: String, metadata: T.nilable(T::Hash[String, String]), phone: String, political_exposure: String, registered_address: ::Stripe::Token::CreateParams::Account::Individual::RegisteredAddress, relationship: ::Stripe::Token::CreateParams::Account::Individual::Relationship, ssn_last_4: String, verification: ::Stripe::Token::CreateParams::Account::Individual::Verification).void
692
+ }
693
+ def initialize(
694
+ address: nil,
695
+ address_kana: nil,
696
+ address_kanji: nil,
697
+ dob: nil,
698
+ email: nil,
699
+ first_name: nil,
700
+ first_name_kana: nil,
701
+ first_name_kanji: nil,
702
+ full_name_aliases: nil,
703
+ gender: nil,
704
+ id_number: nil,
705
+ id_number_secondary: nil,
706
+ last_name: nil,
707
+ last_name_kana: nil,
708
+ last_name_kanji: nil,
709
+ maiden_name: nil,
710
+ metadata: nil,
711
+ phone: nil,
712
+ political_exposure: nil,
713
+ registered_address: nil,
714
+ relationship: nil,
715
+ ssn_last_4: nil,
716
+ verification: nil
717
+ ); end
718
+ end
719
+ # The business type.
720
+ sig { returns(String) }
721
+ attr_accessor :business_type
722
+
723
+ # Information about the company or business.
724
+ sig { returns(::Stripe::Token::CreateParams::Account::Company) }
725
+ attr_accessor :company
726
+
727
+ # Information about the person represented by the account.
728
+ sig { returns(::Stripe::Token::CreateParams::Account::Individual) }
729
+ attr_accessor :individual
730
+
731
+ # Whether the user described by the data in the token has been shown [the Stripe Connected Account Agreement](/connect/account-tokens#stripe-connected-account-agreement). When creating an account token to create a new Connect account, this value must be `true`.
732
+ sig { returns(T::Boolean) }
733
+ attr_accessor :tos_shown_and_accepted
734
+
735
+ sig {
736
+ params(business_type: String, company: ::Stripe::Token::CreateParams::Account::Company, individual: ::Stripe::Token::CreateParams::Account::Individual, tos_shown_and_accepted: T::Boolean).void
737
+ }
738
+ def initialize(
739
+ business_type: nil,
740
+ company: nil,
741
+ individual: nil,
742
+ tos_shown_and_accepted: nil
743
+ ); end
744
+ end
745
+ class BankAccount < Stripe::RequestParams
746
+ # The name of the person or business that owns the bank account. This field is required when attaching the bank account to a `Customer` object.
747
+ sig { returns(String) }
748
+ attr_accessor :account_holder_name
749
+
750
+ # The type of entity that holds the account. It can be `company` or `individual`. This field is required when attaching the bank account to a `Customer` object.
751
+ sig { returns(String) }
752
+ attr_accessor :account_holder_type
753
+
754
+ # The account number for the bank account, in string form. Must be a checking account.
755
+ sig { returns(String) }
756
+ attr_accessor :account_number
757
+
758
+ # The bank account type. This can only be `checking` or `savings` in most countries. In Japan, this can only be `futsu` or `toza`.
759
+ sig { returns(String) }
760
+ attr_accessor :account_type
761
+
762
+ # The country in which the bank account is located.
763
+ sig { returns(String) }
764
+ attr_accessor :country
765
+
766
+ # The currency the bank account is in. This must be a country/currency pairing that [Stripe supports.](https://stripe.com/docs/payouts)
767
+ sig { returns(String) }
768
+ attr_accessor :currency
769
+
770
+ # The ID of a Payment Method with a `type` of `us_bank_account`. The Payment Method's bank account information will be copied and returned as a Bank Account Token. This parameter is exclusive with respect to all other parameters in the `bank_account` hash. You must include the top-level `customer` parameter if the Payment Method is attached to a `Customer` object. If the Payment Method is not attached to a `Customer` object, it will be consumed and cannot be used again. You may not use Payment Methods which were created by a Setup Intent with `attach_to_self=true`.
771
+ sig { returns(String) }
772
+ attr_accessor :payment_method
773
+
774
+ # The routing number, sort code, or other country-appropriate institution number for the bank account. For US bank accounts, this is required and should be the ACH routing number, not the wire routing number. If you are providing an IBAN for `account_number`, this field is not required.
775
+ sig { returns(String) }
776
+ attr_accessor :routing_number
777
+
778
+ sig {
779
+ params(account_holder_name: String, account_holder_type: String, account_number: String, account_type: String, country: String, currency: String, payment_method: String, routing_number: String).void
780
+ }
781
+ def initialize(
782
+ account_holder_name: nil,
783
+ account_holder_type: nil,
784
+ account_number: nil,
785
+ account_type: nil,
786
+ country: nil,
787
+ currency: nil,
788
+ payment_method: nil,
789
+ routing_number: nil
790
+ ); end
791
+ end
792
+ class Card < Stripe::RequestParams
793
+ class Networks < Stripe::RequestParams
794
+ # The customer's preferred card network for co-branded cards. Supports `cartes_bancaires`, `mastercard`, or `visa`. Selection of a network that does not apply to the card will be stored as `invalid_preference` on the card.
795
+ sig { returns(String) }
796
+ attr_accessor :preferred
797
+
798
+ sig { params(preferred: String).void }
799
+ def initialize(preferred: nil); end
800
+ end
801
+ # City / District / Suburb / Town / Village.
802
+ sig { returns(String) }
803
+ attr_accessor :address_city
804
+
805
+ # Billing address country, if provided.
806
+ sig { returns(String) }
807
+ attr_accessor :address_country
808
+
809
+ # Address line 1 (Street address / PO Box / Company name).
810
+ sig { returns(String) }
811
+ attr_accessor :address_line1
812
+
813
+ # Address line 2 (Apartment / Suite / Unit / Building).
814
+ sig { returns(String) }
815
+ attr_accessor :address_line2
816
+
817
+ # State / County / Province / Region.
818
+ sig { returns(String) }
819
+ attr_accessor :address_state
820
+
821
+ # ZIP or postal code.
822
+ sig { returns(String) }
823
+ attr_accessor :address_zip
824
+
825
+ # Required in order to add the card to an account; in all other cases, this parameter is not used. When added to an account, the card (which must be a debit card) can be used as a transfer destination for funds in this currency.
826
+ sig { returns(String) }
827
+ attr_accessor :currency
828
+
829
+ # Card security code. Highly recommended to always include this value.
830
+ sig { returns(String) }
831
+ attr_accessor :cvc
832
+
833
+ # Two-digit number representing the card's expiration month.
834
+ sig { returns(String) }
835
+ attr_accessor :exp_month
836
+
837
+ # Two- or four-digit number representing the card's expiration year.
838
+ sig { returns(String) }
839
+ attr_accessor :exp_year
840
+
841
+ # Cardholder's full name.
842
+ sig { returns(String) }
843
+ attr_accessor :name
844
+
845
+ # Contains information about card networks used to process the payment.
846
+ sig { returns(::Stripe::Token::CreateParams::Card::Networks) }
847
+ attr_accessor :networks
848
+
849
+ # The card number, as a string without any separators.
850
+ sig { returns(String) }
851
+ attr_accessor :number
852
+
853
+ sig {
854
+ params(address_city: String, address_country: String, address_line1: String, address_line2: String, address_state: String, address_zip: String, currency: String, cvc: String, exp_month: String, exp_year: String, name: String, networks: ::Stripe::Token::CreateParams::Card::Networks, number: String).void
855
+ }
856
+ def initialize(
857
+ address_city: nil,
858
+ address_country: nil,
859
+ address_line1: nil,
860
+ address_line2: nil,
861
+ address_state: nil,
862
+ address_zip: nil,
863
+ currency: nil,
864
+ cvc: nil,
865
+ exp_month: nil,
866
+ exp_year: nil,
867
+ name: nil,
868
+ networks: nil,
869
+ number: nil
870
+ ); end
871
+ end
872
+ class CvcUpdate < Stripe::RequestParams
873
+ # The CVC value, in string form.
874
+ sig { returns(String) }
875
+ attr_accessor :cvc
876
+
877
+ sig { params(cvc: String).void }
878
+ def initialize(cvc: nil); end
879
+ end
880
+ class Person < Stripe::RequestParams
881
+ class AdditionalTosAcceptances < Stripe::RequestParams
882
+ class Account < Stripe::RequestParams
883
+ # The Unix timestamp marking when the account representative accepted the service agreement.
884
+ sig { returns(Integer) }
885
+ attr_accessor :date
886
+
887
+ # The IP address from which the account representative accepted the service agreement.
888
+ sig { returns(String) }
889
+ attr_accessor :ip
890
+
891
+ # The user agent of the browser from which the account representative accepted the service agreement.
892
+ sig { returns(T.nilable(String)) }
893
+ attr_accessor :user_agent
894
+
895
+ sig { params(date: Integer, ip: String, user_agent: T.nilable(String)).void }
896
+ def initialize(date: nil, ip: nil, user_agent: nil); end
897
+ end
898
+ # Details on the legal guardian's acceptance of the main Stripe service agreement.
899
+ sig { returns(::Stripe::Token::CreateParams::Person::AdditionalTosAcceptances::Account) }
900
+ attr_accessor :account
901
+
902
+ sig {
903
+ params(account: ::Stripe::Token::CreateParams::Person::AdditionalTosAcceptances::Account).void
904
+ }
905
+ def initialize(account: nil); end
906
+ end
907
+ class Address < Stripe::RequestParams
908
+ # City, district, suburb, town, or village.
909
+ sig { returns(String) }
910
+ attr_accessor :city
911
+
912
+ # Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
913
+ sig { returns(String) }
914
+ attr_accessor :country
915
+
916
+ # Address line 1 (e.g., street, PO Box, or company name).
917
+ sig { returns(String) }
918
+ attr_accessor :line1
919
+
920
+ # Address line 2 (e.g., apartment, suite, unit, or building).
921
+ sig { returns(String) }
922
+ attr_accessor :line2
923
+
924
+ # ZIP or postal code.
925
+ sig { returns(String) }
926
+ attr_accessor :postal_code
927
+
928
+ # State, county, province, or region.
929
+ sig { returns(String) }
930
+ attr_accessor :state
931
+
932
+ sig {
933
+ params(city: String, country: String, line1: String, line2: String, postal_code: String, state: String).void
934
+ }
935
+ def initialize(
936
+ city: nil,
937
+ country: nil,
938
+ line1: nil,
939
+ line2: nil,
940
+ postal_code: nil,
941
+ state: nil
942
+ ); end
943
+ end
944
+ class AddressKana < Stripe::RequestParams
945
+ # City or ward.
946
+ sig { returns(String) }
947
+ attr_accessor :city
948
+
949
+ # Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
950
+ sig { returns(String) }
951
+ attr_accessor :country
952
+
953
+ # Block or building number.
954
+ sig { returns(String) }
955
+ attr_accessor :line1
956
+
957
+ # Building details.
958
+ sig { returns(String) }
959
+ attr_accessor :line2
960
+
961
+ # Postal code.
962
+ sig { returns(String) }
963
+ attr_accessor :postal_code
964
+
965
+ # Prefecture.
966
+ sig { returns(String) }
967
+ attr_accessor :state
968
+
969
+ # Town or cho-me.
970
+ sig { returns(String) }
971
+ attr_accessor :town
972
+
973
+ sig {
974
+ params(city: String, country: String, line1: String, line2: String, postal_code: String, state: String, town: String).void
975
+ }
976
+ def initialize(
977
+ city: nil,
978
+ country: nil,
979
+ line1: nil,
980
+ line2: nil,
981
+ postal_code: nil,
982
+ state: nil,
983
+ town: nil
984
+ ); end
985
+ end
986
+ class AddressKanji < Stripe::RequestParams
987
+ # City or ward.
988
+ sig { returns(String) }
989
+ attr_accessor :city
990
+
991
+ # Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
992
+ sig { returns(String) }
993
+ attr_accessor :country
994
+
995
+ # Block or building number.
996
+ sig { returns(String) }
997
+ attr_accessor :line1
998
+
999
+ # Building details.
1000
+ sig { returns(String) }
1001
+ attr_accessor :line2
1002
+
1003
+ # Postal code.
1004
+ sig { returns(String) }
1005
+ attr_accessor :postal_code
1006
+
1007
+ # Prefecture.
1008
+ sig { returns(String) }
1009
+ attr_accessor :state
1010
+
1011
+ # Town or cho-me.
1012
+ sig { returns(String) }
1013
+ attr_accessor :town
1014
+
1015
+ sig {
1016
+ params(city: String, country: String, line1: String, line2: String, postal_code: String, state: String, town: String).void
1017
+ }
1018
+ def initialize(
1019
+ city: nil,
1020
+ country: nil,
1021
+ line1: nil,
1022
+ line2: nil,
1023
+ postal_code: nil,
1024
+ state: nil,
1025
+ town: nil
1026
+ ); end
1027
+ end
1028
+ class Dob < Stripe::RequestParams
1029
+ # The day of birth, between 1 and 31.
1030
+ sig { returns(Integer) }
1031
+ attr_accessor :day
1032
+
1033
+ # The month of birth, between 1 and 12.
1034
+ sig { returns(Integer) }
1035
+ attr_accessor :month
1036
+
1037
+ # The four-digit year of birth.
1038
+ sig { returns(Integer) }
1039
+ attr_accessor :year
1040
+
1041
+ sig { params(day: Integer, month: Integer, year: Integer).void }
1042
+ def initialize(day: nil, month: nil, year: nil); end
1043
+ end
1044
+ class Documents < Stripe::RequestParams
1045
+ class CompanyAuthorization < Stripe::RequestParams
1046
+ # One or more document ids returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `account_requirement`.
1047
+ sig { returns(T::Array[String]) }
1048
+ attr_accessor :files
1049
+
1050
+ sig { params(files: T::Array[String]).void }
1051
+ def initialize(files: nil); end
1052
+ end
1053
+ class Passport < Stripe::RequestParams
1054
+ # One or more document ids returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `account_requirement`.
1055
+ sig { returns(T::Array[String]) }
1056
+ attr_accessor :files
1057
+
1058
+ sig { params(files: T::Array[String]).void }
1059
+ def initialize(files: nil); end
1060
+ end
1061
+ class Visa < Stripe::RequestParams
1062
+ # One or more document ids returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `account_requirement`.
1063
+ sig { returns(T::Array[String]) }
1064
+ attr_accessor :files
1065
+
1066
+ sig { params(files: T::Array[String]).void }
1067
+ def initialize(files: nil); end
1068
+ end
1069
+ # One or more documents that demonstrate proof that this person is authorized to represent the company.
1070
+ sig { returns(::Stripe::Token::CreateParams::Person::Documents::CompanyAuthorization) }
1071
+ attr_accessor :company_authorization
1072
+
1073
+ # One or more documents showing the person's passport page with photo and personal data.
1074
+ sig { returns(::Stripe::Token::CreateParams::Person::Documents::Passport) }
1075
+ attr_accessor :passport
1076
+
1077
+ # One or more documents showing the person's visa required for living in the country where they are residing.
1078
+ sig { returns(::Stripe::Token::CreateParams::Person::Documents::Visa) }
1079
+ attr_accessor :visa
1080
+
1081
+ sig {
1082
+ params(company_authorization: ::Stripe::Token::CreateParams::Person::Documents::CompanyAuthorization, passport: ::Stripe::Token::CreateParams::Person::Documents::Passport, visa: ::Stripe::Token::CreateParams::Person::Documents::Visa).void
1083
+ }
1084
+ def initialize(company_authorization: nil, passport: nil, visa: nil); end
1085
+ end
1086
+ class RegisteredAddress < Stripe::RequestParams
1087
+ # City, district, suburb, town, or village.
1088
+ sig { returns(String) }
1089
+ attr_accessor :city
1090
+
1091
+ # Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
1092
+ sig { returns(String) }
1093
+ attr_accessor :country
1094
+
1095
+ # Address line 1 (e.g., street, PO Box, or company name).
1096
+ sig { returns(String) }
1097
+ attr_accessor :line1
1098
+
1099
+ # Address line 2 (e.g., apartment, suite, unit, or building).
1100
+ sig { returns(String) }
1101
+ attr_accessor :line2
1102
+
1103
+ # ZIP or postal code.
1104
+ sig { returns(String) }
1105
+ attr_accessor :postal_code
1106
+
1107
+ # State, county, province, or region.
1108
+ sig { returns(String) }
1109
+ attr_accessor :state
1110
+
1111
+ sig {
1112
+ params(city: String, country: String, line1: String, line2: String, postal_code: String, state: String).void
1113
+ }
1114
+ def initialize(
1115
+ city: nil,
1116
+ country: nil,
1117
+ line1: nil,
1118
+ line2: nil,
1119
+ postal_code: nil,
1120
+ state: nil
1121
+ ); end
1122
+ end
1123
+ class Relationship < Stripe::RequestParams
1124
+ # Whether the person is the authorizer of the account's representative.
1125
+ sig { returns(T::Boolean) }
1126
+ attr_accessor :authorizer
1127
+
1128
+ # Whether the person is a director of the account's legal entity. Directors are typically members of the governing board of the company, or responsible for ensuring the company meets its regulatory obligations.
1129
+ sig { returns(T::Boolean) }
1130
+ attr_accessor :director
1131
+
1132
+ # Whether the person has significant responsibility to control, manage, or direct the organization.
1133
+ sig { returns(T::Boolean) }
1134
+ attr_accessor :executive
1135
+
1136
+ # Whether the person is the legal guardian of the account's representative.
1137
+ sig { returns(T::Boolean) }
1138
+ attr_accessor :legal_guardian
1139
+
1140
+ # Whether the person is an owner of the account’s legal entity.
1141
+ sig { returns(T::Boolean) }
1142
+ attr_accessor :owner
1143
+
1144
+ # The percent owned by the person of the account's legal entity.
1145
+ sig { returns(T.nilable(Float)) }
1146
+ attr_accessor :percent_ownership
1147
+
1148
+ # Whether the person is authorized as the primary representative of the account. This is the person nominated by the business to provide information about themselves, and general information about the account. There can only be one representative at any given time. At the time the account is created, this person should be set to the person responsible for opening the account.
1149
+ sig { returns(T::Boolean) }
1150
+ attr_accessor :representative
1151
+
1152
+ # The person's title (e.g., CEO, Support Engineer).
1153
+ sig { returns(String) }
1154
+ attr_accessor :title
1155
+
1156
+ sig {
1157
+ params(authorizer: T::Boolean, director: T::Boolean, executive: T::Boolean, legal_guardian: T::Boolean, owner: T::Boolean, percent_ownership: T.nilable(Float), representative: T::Boolean, title: String).void
1158
+ }
1159
+ def initialize(
1160
+ authorizer: nil,
1161
+ director: nil,
1162
+ executive: nil,
1163
+ legal_guardian: nil,
1164
+ owner: nil,
1165
+ percent_ownership: nil,
1166
+ representative: nil,
1167
+ title: nil
1168
+ ); end
1169
+ end
1170
+ class Verification < Stripe::RequestParams
1171
+ class AdditionalDocument < Stripe::RequestParams
1172
+ # The back of an ID returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `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.
1173
+ sig { returns(String) }
1174
+ attr_accessor :back
1175
+
1176
+ # The front of an ID returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `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.
1177
+ sig { returns(String) }
1178
+ attr_accessor :front
1179
+
1180
+ sig { params(back: String, front: String).void }
1181
+ def initialize(back: nil, front: nil); end
1182
+ end
1183
+ class Document < Stripe::RequestParams
1184
+ # The back of an ID returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `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.
1185
+ sig { returns(String) }
1186
+ attr_accessor :back
1187
+
1188
+ # The front of an ID returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `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.
1189
+ sig { returns(String) }
1190
+ attr_accessor :front
1191
+
1192
+ sig { params(back: String, front: String).void }
1193
+ def initialize(back: nil, front: nil); end
1194
+ end
1195
+ # A document showing address, either a passport, local ID card, or utility bill from a well-known utility company.
1196
+ sig { returns(::Stripe::Token::CreateParams::Person::Verification::AdditionalDocument) }
1197
+ attr_accessor :additional_document
1198
+
1199
+ # An identifying document, either a passport or local ID card.
1200
+ sig { returns(::Stripe::Token::CreateParams::Person::Verification::Document) }
1201
+ attr_accessor :document
1202
+
1203
+ sig {
1204
+ params(additional_document: ::Stripe::Token::CreateParams::Person::Verification::AdditionalDocument, document: ::Stripe::Token::CreateParams::Person::Verification::Document).void
1205
+ }
1206
+ def initialize(additional_document: nil, document: nil); end
1207
+ end
1208
+ # Details on the legal guardian's or authorizer's acceptance of the required Stripe agreements.
1209
+ sig { returns(::Stripe::Token::CreateParams::Person::AdditionalTosAcceptances) }
1210
+ attr_accessor :additional_tos_acceptances
1211
+
1212
+ # The person's address.
1213
+ sig { returns(::Stripe::Token::CreateParams::Person::Address) }
1214
+ attr_accessor :address
1215
+
1216
+ # The Kana variation of the person's address (Japan only).
1217
+ sig { returns(::Stripe::Token::CreateParams::Person::AddressKana) }
1218
+ attr_accessor :address_kana
1219
+
1220
+ # The Kanji variation of the person's address (Japan only).
1221
+ sig { returns(::Stripe::Token::CreateParams::Person::AddressKanji) }
1222
+ attr_accessor :address_kanji
1223
+
1224
+ # The person's date of birth.
1225
+ sig { returns(T.nilable(::Stripe::Token::CreateParams::Person::Dob)) }
1226
+ attr_accessor :dob
1227
+
1228
+ # Documents that may be submitted to satisfy various informational requests.
1229
+ sig { returns(::Stripe::Token::CreateParams::Person::Documents) }
1230
+ attr_accessor :documents
1231
+
1232
+ # The person's email address.
1233
+ sig { returns(String) }
1234
+ attr_accessor :email
1235
+
1236
+ # The person's first name.
1237
+ sig { returns(String) }
1238
+ attr_accessor :first_name
1239
+
1240
+ # The Kana variation of the person's first name (Japan only).
1241
+ sig { returns(String) }
1242
+ attr_accessor :first_name_kana
1243
+
1244
+ # The Kanji variation of the person's first name (Japan only).
1245
+ sig { returns(String) }
1246
+ attr_accessor :first_name_kanji
1247
+
1248
+ # A list of alternate names or aliases that the person is known by.
1249
+ sig { returns(T.nilable(T::Array[String])) }
1250
+ attr_accessor :full_name_aliases
1251
+
1252
+ # The person's gender (International regulations require either "male" or "female").
1253
+ sig { returns(String) }
1254
+ attr_accessor :gender
1255
+
1256
+ # The person's ID number, as appropriate for their country. For example, a social security number in the U.S., social insurance number in Canada, etc. Instead of the number itself, you can also provide a [PII token provided by Stripe.js](https://docs.stripe.com/js/tokens/create_token?type=pii).
1257
+ sig { returns(String) }
1258
+ attr_accessor :id_number
1259
+
1260
+ # The person's secondary ID number, as appropriate for their country, will be used for enhanced verification checks. In Thailand, this would be the laser code found on the back of an ID card. Instead of the number itself, you can also provide a [PII token provided by Stripe.js](https://docs.stripe.com/js/tokens/create_token?type=pii).
1261
+ sig { returns(String) }
1262
+ attr_accessor :id_number_secondary
1263
+
1264
+ # The person's last name.
1265
+ sig { returns(String) }
1266
+ attr_accessor :last_name
1267
+
1268
+ # The Kana variation of the person's last name (Japan only).
1269
+ sig { returns(String) }
1270
+ attr_accessor :last_name_kana
1271
+
1272
+ # The Kanji variation of the person's last name (Japan only).
1273
+ sig { returns(String) }
1274
+ attr_accessor :last_name_kanji
1275
+
1276
+ # The person's maiden name.
1277
+ sig { returns(String) }
1278
+ attr_accessor :maiden_name
1279
+
1280
+ # Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
1281
+ sig { returns(T.nilable(T::Hash[String, String])) }
1282
+ attr_accessor :metadata
1283
+
1284
+ # The country where the person is a national. Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)), or "XX" if unavailable.
1285
+ sig { returns(String) }
1286
+ attr_accessor :nationality
1287
+
1288
+ # The person's phone number.
1289
+ sig { returns(String) }
1290
+ attr_accessor :phone
1291
+
1292
+ # Indicates if the person or any of their representatives, family members, or other closely related persons, declares that they hold or have held an important public job or function, in any jurisdiction.
1293
+ sig { returns(String) }
1294
+ attr_accessor :political_exposure
1295
+
1296
+ # The person's registered address.
1297
+ sig { returns(::Stripe::Token::CreateParams::Person::RegisteredAddress) }
1298
+ attr_accessor :registered_address
1299
+
1300
+ # The relationship that this person has with the account's legal entity.
1301
+ sig { returns(::Stripe::Token::CreateParams::Person::Relationship) }
1302
+ attr_accessor :relationship
1303
+
1304
+ # The last four digits of the person's Social Security number (U.S. only).
1305
+ sig { returns(String) }
1306
+ attr_accessor :ssn_last_4
1307
+
1308
+ # The person's verification status.
1309
+ sig { returns(::Stripe::Token::CreateParams::Person::Verification) }
1310
+ attr_accessor :verification
1311
+
1312
+ sig {
1313
+ params(additional_tos_acceptances: ::Stripe::Token::CreateParams::Person::AdditionalTosAcceptances, address: ::Stripe::Token::CreateParams::Person::Address, address_kana: ::Stripe::Token::CreateParams::Person::AddressKana, address_kanji: ::Stripe::Token::CreateParams::Person::AddressKanji, dob: T.nilable(::Stripe::Token::CreateParams::Person::Dob), documents: ::Stripe::Token::CreateParams::Person::Documents, email: String, first_name: String, first_name_kana: String, first_name_kanji: String, full_name_aliases: T.nilable(T::Array[String]), gender: String, id_number: String, id_number_secondary: String, last_name: String, last_name_kana: String, last_name_kanji: String, maiden_name: String, metadata: T.nilable(T::Hash[String, String]), nationality: String, phone: String, political_exposure: String, registered_address: ::Stripe::Token::CreateParams::Person::RegisteredAddress, relationship: ::Stripe::Token::CreateParams::Person::Relationship, ssn_last_4: String, verification: ::Stripe::Token::CreateParams::Person::Verification).void
1314
+ }
1315
+ def initialize(
1316
+ additional_tos_acceptances: nil,
1317
+ address: nil,
1318
+ address_kana: nil,
1319
+ address_kanji: nil,
1320
+ dob: nil,
1321
+ documents: nil,
1322
+ email: nil,
1323
+ first_name: nil,
1324
+ first_name_kana: nil,
1325
+ first_name_kanji: nil,
1326
+ full_name_aliases: nil,
1327
+ gender: nil,
1328
+ id_number: nil,
1329
+ id_number_secondary: nil,
1330
+ last_name: nil,
1331
+ last_name_kana: nil,
1332
+ last_name_kanji: nil,
1333
+ maiden_name: nil,
1334
+ metadata: nil,
1335
+ nationality: nil,
1336
+ phone: nil,
1337
+ political_exposure: nil,
1338
+ registered_address: nil,
1339
+ relationship: nil,
1340
+ ssn_last_4: nil,
1341
+ verification: nil
1342
+ ); end
1343
+ end
1344
+ class Pii < Stripe::RequestParams
1345
+ # The `id_number` for the PII, in string form.
1346
+ sig { returns(String) }
1347
+ attr_accessor :id_number
1348
+
1349
+ sig { params(id_number: String).void }
1350
+ def initialize(id_number: nil); end
1351
+ end
1352
+ # Information for the account this token represents.
1353
+ sig { returns(::Stripe::Token::CreateParams::Account) }
1354
+ attr_accessor :account
1355
+
1356
+ # The bank account this token will represent.
1357
+ sig { returns(::Stripe::Token::CreateParams::BankAccount) }
1358
+ attr_accessor :bank_account
1359
+
1360
+ # The card this token will represent. If you also pass in a customer, the card must be the ID of a card belonging to the customer. Otherwise, if you do not pass in a customer, this is a dictionary containing a user's credit card details, with the options described below.
1361
+ sig { returns(T.any(::Stripe::Token::CreateParams::Card, String)) }
1362
+ attr_accessor :card
1363
+
1364
+ # Create a token for the customer, which is owned by the application's account. You can only use this with an [OAuth access token](https://stripe.com/docs/connect/standard-accounts) or [Stripe-Account header](https://stripe.com/docs/connect/authentication). Learn more about [cloning saved payment methods](https://stripe.com/docs/connect/cloning-saved-payment-methods).
1365
+ sig { returns(String) }
1366
+ attr_accessor :customer
1367
+
1368
+ # The updated CVC value this token represents.
1369
+ sig { returns(::Stripe::Token::CreateParams::CvcUpdate) }
1370
+ attr_accessor :cvc_update
1371
+
1372
+ # Specifies which fields in the response should be expanded.
1373
+ sig { returns(T::Array[String]) }
1374
+ attr_accessor :expand
1375
+
1376
+ # Information for the person this token represents.
1377
+ sig { returns(::Stripe::Token::CreateParams::Person) }
1378
+ attr_accessor :person
1379
+
1380
+ # The PII this token represents.
1381
+ sig { returns(::Stripe::Token::CreateParams::Pii) }
1382
+ attr_accessor :pii
1383
+
1384
+ sig {
1385
+ params(account: ::Stripe::Token::CreateParams::Account, bank_account: ::Stripe::Token::CreateParams::BankAccount, card: T.any(::Stripe::Token::CreateParams::Card, String), customer: String, cvc_update: ::Stripe::Token::CreateParams::CvcUpdate, expand: T::Array[String], person: ::Stripe::Token::CreateParams::Person, pii: ::Stripe::Token::CreateParams::Pii).void
1386
+ }
1387
+ def initialize(
1388
+ account: nil,
1389
+ bank_account: nil,
1390
+ card: nil,
1391
+ customer: nil,
1392
+ cvc_update: nil,
1393
+ expand: nil,
1394
+ person: nil,
1395
+ pii: nil
1396
+ ); end
1397
+ end
1398
+ # Creates a single-use token that represents a bank account's details.
1399
+ # You can use this token with any v1 API method in place of a bank account dictionary. You can only use this token once. To do so, attach it to a [connected account](https://stripe.com/docs/api#accounts) where [controller.requirement_collection](https://stripe.com/api/accounts/object#account_object-controller-requirement_collection) is application, which includes Custom accounts.
1400
+ sig {
1401
+ params(params: T.any(::Stripe::Token::CreateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Token)
1402
+ }
1403
+ def self.create(params = {}, opts = {}); end
1404
+ end
1405
+ end