stripe 15.0.0 → 15.3.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (320) hide show
  1. checksums.yaml +4 -4
  2. data/API_VERSION +1 -0
  3. data/CHANGELOG.md +129 -44
  4. data/CONTRIBUTING.md +25 -0
  5. data/Gemfile +1 -1
  6. data/OPENAPI_VERSION +1 -1
  7. data/README.md +28 -55
  8. data/VERSION +1 -1
  9. data/lib/stripe/api_operations/nested_resource.rb +35 -35
  10. data/lib/stripe/api_requestor.rb +1 -1
  11. data/lib/stripe/api_version.rb +2 -1
  12. data/lib/stripe/connection_manager.rb +1 -3
  13. data/lib/stripe/event_types.rb +1 -0
  14. data/lib/stripe/events/v1_billing_meter_error_report_triggered_event.rb +1 -1
  15. data/lib/stripe/events/v1_billing_meter_no_meter_found_event.rb +1 -1
  16. data/lib/stripe/events/v2_core_event_destination_ping_event.rb +21 -0
  17. data/lib/stripe/oauth.rb +1 -1
  18. data/lib/stripe/resources/account.rb +198 -28
  19. data/lib/stripe/resources/account_session.rb +176 -72
  20. data/lib/stripe/resources/apple_pay_domain.rb +1 -2
  21. data/lib/stripe/resources/balance.rb +42 -0
  22. data/lib/stripe/resources/balance_transaction.rb +2 -0
  23. data/lib/stripe/resources/bank_account.rb +2 -2
  24. data/lib/stripe/resources/billing_portal/session.rb +3 -3
  25. data/lib/stripe/resources/capability.rb +1 -1
  26. data/lib/stripe/resources/charge.rb +43 -20
  27. data/lib/stripe/resources/checkout/session.rb +120 -19
  28. data/lib/stripe/resources/confirmation_token.rb +119 -100
  29. data/lib/stripe/resources/country_spec.rb +1 -1
  30. data/lib/stripe/resources/coupon.rb +2 -3
  31. data/lib/stripe/resources/credit_note.rb +21 -18
  32. data/lib/stripe/resources/customer.rb +4 -6
  33. data/lib/stripe/resources/customer_session.rb +5 -5
  34. data/lib/stripe/resources/dispute.rb +2 -2
  35. data/lib/stripe/resources/event.rb +3 -1
  36. data/lib/stripe/resources/file.rb +1 -1
  37. data/lib/stripe/resources/funding_instructions.rb +1 -1
  38. data/lib/stripe/resources/identity/verification_report.rb +6 -0
  39. data/lib/stripe/resources/identity/verification_session.rb +51 -11
  40. data/lib/stripe/resources/invoice.rb +146 -32
  41. data/lib/stripe/resources/invoice_item.rb +3 -7
  42. data/lib/stripe/resources/invoice_line_item.rb +1 -1
  43. data/lib/stripe/resources/invoice_payment.rb +9 -2
  44. data/lib/stripe/resources/issuing/authorization.rb +8 -8
  45. data/lib/stripe/resources/issuing/card.rb +1 -1
  46. data/lib/stripe/resources/issuing/dispute.rb +3 -3
  47. data/lib/stripe/resources/login_link.rb +2 -1
  48. data/lib/stripe/resources/mandate.rb +3 -0
  49. data/lib/stripe/resources/payment_intent.rb +602 -325
  50. data/lib/stripe/resources/payment_method.rb +76 -117
  51. data/lib/stripe/resources/payment_method_configuration.rb +356 -2
  52. data/lib/stripe/resources/payment_method_domain.rb +15 -2
  53. data/lib/stripe/resources/payout.rb +4 -4
  54. data/lib/stripe/resources/person.rb +27 -3
  55. data/lib/stripe/resources/plan.rb +2 -3
  56. data/lib/stripe/resources/price.rb +1 -1
  57. data/lib/stripe/resources/product.rb +1 -2
  58. data/lib/stripe/resources/quote.rb +28 -3
  59. data/lib/stripe/resources/radar/value_list.rb +1 -2
  60. data/lib/stripe/resources/radar/value_list_item.rb +1 -2
  61. data/lib/stripe/resources/refund.rb +8 -1
  62. data/lib/stripe/resources/reversal.rb +1 -1
  63. data/lib/stripe/resources/review.rb +1 -1
  64. data/lib/stripe/resources/setup_attempt.rb +1 -1
  65. data/lib/stripe/resources/setup_intent.rb +414 -293
  66. data/lib/stripe/resources/source.rb +1 -1
  67. data/lib/stripe/resources/subscription.rb +149 -27
  68. data/lib/stripe/resources/subscription_item.rb +33 -0
  69. data/lib/stripe/resources/subscription_schedule.rb +141 -4
  70. data/lib/stripe/resources/tax/calculation.rb +6 -2
  71. data/lib/stripe/resources/tax/calculation_line_item.rb +2 -0
  72. data/lib/stripe/resources/tax/registration.rb +261 -1
  73. data/lib/stripe/resources/tax/transaction.rb +1 -1
  74. data/lib/stripe/resources/tax_id.rb +3 -4
  75. data/lib/stripe/resources/tax_rate.rb +2 -2
  76. data/lib/stripe/resources/terminal/configuration.rb +2 -2
  77. data/lib/stripe/resources/terminal/location.rb +2 -3
  78. data/lib/stripe/resources/terminal/reader.rb +426 -6
  79. data/lib/stripe/resources/test_helpers/test_clock.rb +1 -2
  80. data/lib/stripe/resources/token.rb +63 -2
  81. data/lib/stripe/resources/transfer.rb +1 -1
  82. data/lib/stripe/resources/treasury/financial_account.rb +5 -1
  83. data/lib/stripe/resources/v2/billing/meter_event.rb +2 -2
  84. data/lib/stripe/resources/v2/billing/meter_event_adjustment.rb +2 -2
  85. data/lib/stripe/resources/v2/billing/meter_event_session.rb +2 -2
  86. data/lib/stripe/resources/v2/event.rb +2 -2
  87. data/lib/stripe/resources/v2/event_destination.rb +2 -2
  88. data/lib/stripe/resources/webhook_endpoint.rb +1 -2
  89. data/lib/stripe/resources.rb +1 -0
  90. data/lib/stripe/services/account_external_account_service.rb +3 -4
  91. data/lib/stripe/services/account_login_link_service.rb +1 -1
  92. data/lib/stripe/services/account_person_service.rb +85 -2
  93. data/lib/stripe/services/account_service.rb +169 -20
  94. data/lib/stripe/services/account_session_service.rb +115 -47
  95. data/lib/stripe/services/apple_pay_domain_service.rb +1 -2
  96. data/lib/stripe/services/application_fee_service.rb +1 -1
  97. data/lib/stripe/services/apps_service.rb +1 -1
  98. data/lib/stripe/services/balance_service.rb +1 -1
  99. data/lib/stripe/services/billing/meter_service.rb +1 -1
  100. data/lib/stripe/services/billing_portal/session_service.rb +1 -1
  101. data/lib/stripe/services/billing_portal_service.rb +1 -1
  102. data/lib/stripe/services/billing_service.rb +1 -1
  103. data/lib/stripe/services/charge_service.rb +4 -4
  104. data/lib/stripe/services/checkout/session_service.rb +94 -15
  105. data/lib/stripe/services/checkout_service.rb +1 -1
  106. data/lib/stripe/services/climate_service.rb +1 -1
  107. data/lib/stripe/services/coupon_service.rb +1 -2
  108. data/lib/stripe/services/credit_note_preview_lines_service.rb +3 -3
  109. data/lib/stripe/services/credit_note_service.rb +14 -15
  110. data/lib/stripe/services/customer_balance_transaction_service.rb +3 -3
  111. data/lib/stripe/services/customer_cash_balance_transaction_service.rb +2 -2
  112. data/lib/stripe/services/customer_payment_method_service.rb +1 -1
  113. data/lib/stripe/services/customer_payment_source_service.rb +1 -1
  114. data/lib/stripe/services/customer_service.rb +5 -7
  115. data/lib/stripe/services/customer_session_service.rb +1 -1
  116. data/lib/stripe/services/customer_tax_id_service.rb +2 -3
  117. data/lib/stripe/services/dispute_service.rb +1 -1
  118. data/lib/stripe/services/entitlements_service.rb +1 -1
  119. data/lib/stripe/services/file_service.rb +1 -1
  120. data/lib/stripe/services/financial_connections/account_service.rb +1 -1
  121. data/lib/stripe/services/financial_connections_service.rb +1 -1
  122. data/lib/stripe/services/forwarding_service.rb +1 -1
  123. data/lib/stripe/services/identity/verification_session_service.rb +21 -5
  124. data/lib/stripe/services/identity_service.rb +1 -1
  125. data/lib/stripe/services/invoice_item_service.rb +1 -2
  126. data/lib/stripe/services/invoice_service.rb +122 -28
  127. data/lib/stripe/services/issuing/authorization_service.rb +4 -4
  128. data/lib/stripe/services/issuing/card_service.rb +1 -1
  129. data/lib/stripe/services/issuing/dispute_service.rb +2 -2
  130. data/lib/stripe/services/issuing_service.rb +1 -1
  131. data/lib/stripe/services/payment_intent_service.rb +563 -313
  132. data/lib/stripe/services/payment_link_service.rb +1 -1
  133. data/lib/stripe/services/payment_method_configuration_service.rb +254 -2
  134. data/lib/stripe/services/payment_method_domain_service.rb +1 -1
  135. data/lib/stripe/services/payment_method_service.rb +59 -105
  136. data/lib/stripe/services/payout_service.rb +2 -2
  137. data/lib/stripe/services/plan_service.rb +2 -3
  138. data/lib/stripe/services/price_service.rb +2 -2
  139. data/lib/stripe/services/product_feature_service.rb +1 -2
  140. data/lib/stripe/services/product_service.rb +3 -4
  141. data/lib/stripe/services/promotion_code_service.rb +1 -1
  142. data/lib/stripe/services/quote_service.rb +21 -4
  143. data/lib/stripe/services/radar/early_fraud_warning_service.rb +1 -1
  144. data/lib/stripe/services/radar/value_list_item_service.rb +1 -2
  145. data/lib/stripe/services/radar/value_list_service.rb +1 -2
  146. data/lib/stripe/services/radar_service.rb +1 -1
  147. data/lib/stripe/services/reporting_service.rb +1 -1
  148. data/lib/stripe/services/setup_intent_service.rb +403 -291
  149. data/lib/stripe/services/sigma_service.rb +1 -1
  150. data/lib/stripe/services/source_service.rb +2 -2
  151. data/lib/stripe/services/subscription_item_service.rb +26 -0
  152. data/lib/stripe/services/subscription_schedule_service.rb +106 -3
  153. data/lib/stripe/services/subscription_service.rb +121 -26
  154. data/lib/stripe/services/tax/calculation_service.rb +6 -2
  155. data/lib/stripe/services/tax/registration_service.rb +170 -1
  156. data/lib/stripe/services/tax/transaction_service.rb +1 -1
  157. data/lib/stripe/services/tax_id_service.rb +2 -3
  158. data/lib/stripe/services/tax_service.rb +1 -1
  159. data/lib/stripe/services/terminal/configuration_service.rb +1 -2
  160. data/lib/stripe/services/terminal/location_service.rb +2 -3
  161. data/lib/stripe/services/terminal/reader_service.rb +196 -2
  162. data/lib/stripe/services/terminal_service.rb +1 -1
  163. data/lib/stripe/services/test_helpers/confirmation_token_service.rb +90 -91
  164. data/lib/stripe/services/test_helpers/issuing_service.rb +1 -1
  165. data/lib/stripe/services/test_helpers/terminal/reader_service.rb +43 -0
  166. data/lib/stripe/services/test_helpers/terminal_service.rb +1 -1
  167. data/lib/stripe/services/test_helpers/test_clock_service.rb +1 -2
  168. data/lib/stripe/services/test_helpers/treasury_service.rb +1 -1
  169. data/lib/stripe/services/test_helpers_service.rb +1 -1
  170. data/lib/stripe/services/token_service.rb +62 -1
  171. data/lib/stripe/services/transfer_service.rb +2 -2
  172. data/lib/stripe/services/treasury/financial_account_service.rb +6 -2
  173. data/lib/stripe/services/treasury_service.rb +1 -1
  174. data/lib/stripe/services/v1_services.rb +1 -1
  175. data/lib/stripe/services/v2/billing/meter_event_session_service.rb +1 -2
  176. data/lib/stripe/services/v2/billing_service.rb +3 -3
  177. data/lib/stripe/services/v2/core/event_destination_service.rb +17 -23
  178. data/lib/stripe/services/v2/core/event_service.rb +1 -2
  179. data/lib/stripe/services/v2/core_service.rb +1 -1
  180. data/lib/stripe/services/v2_services.rb +1 -1
  181. data/lib/stripe/services/webhook_endpoint_service.rb +1 -2
  182. data/lib/stripe/version.rb +1 -1
  183. data/lib/stripe/webhook.rb +1 -1
  184. data/rbi/stripe/resources/account.rbi +190 -35
  185. data/rbi/stripe/resources/account_session.rbi +196 -77
  186. data/rbi/stripe/resources/apple_pay_domain.rbi +1 -3
  187. data/rbi/stripe/resources/balance.rbi +55 -0
  188. data/rbi/stripe/resources/balance_transaction.rbi +3 -0
  189. data/rbi/stripe/resources/bank_account.rbi +2 -2
  190. data/rbi/stripe/resources/billing/alert.rbi +2 -2
  191. data/rbi/stripe/resources/billing_portal/session.rbi +3 -3
  192. data/rbi/stripe/resources/capability.rbi +1 -1
  193. data/rbi/stripe/resources/charge.rbi +52 -20
  194. data/rbi/stripe/resources/checkout/session.rbi +133 -24
  195. data/rbi/stripe/resources/confirmation_token.rbi +140 -115
  196. data/rbi/stripe/resources/country_spec.rbi +1 -1
  197. data/rbi/stripe/resources/coupon.rbi +2 -4
  198. data/rbi/stripe/resources/credit_note.rbi +23 -18
  199. data/rbi/stripe/resources/customer.rbi +4 -8
  200. data/rbi/stripe/resources/customer_session.rbi +5 -5
  201. data/rbi/stripe/resources/dispute.rbi +2 -2
  202. data/rbi/stripe/resources/event.rbi +4 -1
  203. data/rbi/stripe/resources/file.rbi +1 -1
  204. data/rbi/stripe/resources/identity/verification_report.rbi +9 -0
  205. data/rbi/stripe/resources/identity/verification_session.rbi +59 -12
  206. data/rbi/stripe/resources/invoice.rbi +149 -40
  207. data/rbi/stripe/resources/invoice_item.rbi +3 -8
  208. data/rbi/stripe/resources/invoice_line_item.rbi +2 -2
  209. data/rbi/stripe/resources/invoice_payment.rbi +9 -2
  210. data/rbi/stripe/resources/issuing/authorization.rbi +8 -8
  211. data/rbi/stripe/resources/issuing/card.rbi +1 -1
  212. data/rbi/stripe/resources/issuing/dispute.rbi +3 -3
  213. data/rbi/stripe/resources/login_link.rbi +2 -1
  214. data/rbi/stripe/resources/mandate.rbi +4 -0
  215. data/rbi/stripe/resources/payment_intent.rbi +637 -381
  216. data/rbi/stripe/resources/payment_method.rbi +81 -133
  217. data/rbi/stripe/resources/payment_method_configuration.rbi +400 -4
  218. data/rbi/stripe/resources/payment_method_domain.rbi +18 -2
  219. data/rbi/stripe/resources/payout.rbi +4 -4
  220. data/rbi/stripe/resources/person.rbi +33 -3
  221. data/rbi/stripe/resources/plan.rbi +2 -4
  222. data/rbi/stripe/resources/price.rbi +1 -1
  223. data/rbi/stripe/resources/product.rbi +1 -3
  224. data/rbi/stripe/resources/quote.rbi +25 -3
  225. data/rbi/stripe/resources/radar/value_list.rbi +1 -3
  226. data/rbi/stripe/resources/radar/value_list_item.rbi +1 -3
  227. data/rbi/stripe/resources/refund.rbi +8 -1
  228. data/rbi/stripe/resources/reversal.rbi +1 -1
  229. data/rbi/stripe/resources/review.rbi +1 -1
  230. data/rbi/stripe/resources/setup_attempt.rbi +1 -1
  231. data/rbi/stripe/resources/setup_intent.rbi +464 -346
  232. data/rbi/stripe/resources/source.rbi +1 -1
  233. data/rbi/stripe/resources/subscription.rbi +150 -34
  234. data/rbi/stripe/resources/subscription_item.rbi +36 -2
  235. data/rbi/stripe/resources/subscription_schedule.rbi +161 -11
  236. data/rbi/stripe/resources/tax/calculation.rbi +7 -3
  237. data/rbi/stripe/resources/tax/calculation_line_item.rbi +4 -1
  238. data/rbi/stripe/resources/tax/registration.rbi +249 -2
  239. data/rbi/stripe/resources/tax/transaction.rbi +1 -1
  240. data/rbi/stripe/resources/tax_id.rbi +3 -5
  241. data/rbi/stripe/resources/tax_rate.rbi +2 -2
  242. data/rbi/stripe/resources/terminal/configuration.rbi +2 -3
  243. data/rbi/stripe/resources/terminal/location.rbi +4 -6
  244. data/rbi/stripe/resources/terminal/reader.rbi +415 -8
  245. data/rbi/stripe/resources/test_helpers/test_clock.rbi +1 -3
  246. data/rbi/stripe/resources/token.rbi +70 -4
  247. data/rbi/stripe/resources/transfer.rbi +1 -1
  248. data/rbi/stripe/resources/treasury/financial_account.rbi +6 -2
  249. data/rbi/stripe/resources/v2/billing/meter_event.rbi +3 -3
  250. data/rbi/stripe/resources/v2/billing/meter_event_adjustment.rbi +3 -3
  251. data/rbi/stripe/resources/v2/billing/meter_event_session.rbi +3 -3
  252. data/rbi/stripe/resources/v2/event.rbi +3 -3
  253. data/rbi/stripe/resources/v2/event_destination.rbi +3 -3
  254. data/rbi/stripe/resources/webhook_endpoint.rbi +1 -3
  255. data/rbi/stripe/services/account_external_account_service.rbi +3 -5
  256. data/rbi/stripe/services/account_login_link_service.rbi +1 -1
  257. data/rbi/stripe/services/account_person_service.rbi +93 -5
  258. data/rbi/stripe/services/account_service.rbi +166 -28
  259. data/rbi/stripe/services/account_session_service.rbi +126 -52
  260. data/rbi/stripe/services/apple_pay_domain_service.rbi +1 -3
  261. data/rbi/stripe/services/balance_service.rbi +1 -1
  262. data/rbi/stripe/services/billing/alert_service.rbi +2 -2
  263. data/rbi/stripe/services/billing_portal/session_service.rbi +1 -1
  264. data/rbi/stripe/services/charge_service.rbi +4 -4
  265. data/rbi/stripe/services/checkout/session_service.rbi +104 -19
  266. data/rbi/stripe/services/coupon_service.rbi +1 -3
  267. data/rbi/stripe/services/credit_note_preview_lines_service.rbi +3 -3
  268. data/rbi/stripe/services/credit_note_service.rbi +13 -14
  269. data/rbi/stripe/services/customer_balance_transaction_service.rbi +3 -3
  270. data/rbi/stripe/services/customer_cash_balance_transaction_service.rbi +2 -2
  271. data/rbi/stripe/services/customer_payment_method_service.rbi +1 -1
  272. data/rbi/stripe/services/customer_payment_source_service.rbi +1 -1
  273. data/rbi/stripe/services/customer_service.rbi +4 -8
  274. data/rbi/stripe/services/customer_session_service.rbi +1 -1
  275. data/rbi/stripe/services/customer_tax_id_service.rbi +2 -4
  276. data/rbi/stripe/services/dispute_service.rbi +1 -1
  277. data/rbi/stripe/services/file_service.rbi +1 -1
  278. data/rbi/stripe/services/identity/verification_session_service.rbi +22 -6
  279. data/rbi/stripe/services/invoice_item_service.rbi +1 -3
  280. data/rbi/stripe/services/invoice_service.rbi +126 -35
  281. data/rbi/stripe/services/issuing/authorization_service.rbi +4 -4
  282. data/rbi/stripe/services/issuing/card_service.rbi +1 -1
  283. data/rbi/stripe/services/issuing/dispute_service.rbi +2 -2
  284. data/rbi/stripe/services/payment_intent_service.rbi +599 -369
  285. data/rbi/stripe/services/payment_method_configuration_service.rbi +280 -4
  286. data/rbi/stripe/services/payment_method_domain_service.rbi +1 -1
  287. data/rbi/stripe/services/payment_method_service.rbi +62 -121
  288. data/rbi/stripe/services/payout_service.rbi +2 -2
  289. data/rbi/stripe/services/plan_service.rbi +2 -4
  290. data/rbi/stripe/services/price_service.rbi +2 -2
  291. data/rbi/stripe/services/product_feature_service.rbi +1 -3
  292. data/rbi/stripe/services/product_service.rbi +2 -4
  293. data/rbi/stripe/services/promotion_code_service.rbi +1 -1
  294. data/rbi/stripe/services/quote_service.rbi +16 -3
  295. data/rbi/stripe/services/radar/early_fraud_warning_service.rbi +1 -1
  296. data/rbi/stripe/services/radar/value_list_item_service.rbi +1 -3
  297. data/rbi/stripe/services/radar/value_list_service.rbi +1 -3
  298. data/rbi/stripe/services/setup_intent_service.rbi +457 -344
  299. data/rbi/stripe/services/source_service.rbi +1 -1
  300. data/rbi/stripe/services/subscription_item_service.rbi +28 -2
  301. data/rbi/stripe/services/subscription_schedule_service.rbi +119 -10
  302. data/rbi/stripe/services/subscription_service.rbi +121 -33
  303. data/rbi/stripe/services/tax/calculation_service.rbi +6 -2
  304. data/rbi/stripe/services/tax/registration_service.rbi +171 -2
  305. data/rbi/stripe/services/tax_id_service.rbi +2 -4
  306. data/rbi/stripe/services/terminal/configuration_service.rbi +1 -3
  307. data/rbi/stripe/services/terminal/location_service.rbi +4 -6
  308. data/rbi/stripe/services/terminal/reader_service.rbi +200 -4
  309. data/rbi/stripe/services/test_helpers/confirmation_token_service.rbi +106 -106
  310. data/rbi/stripe/services/test_helpers/terminal/reader_service.rbi +31 -0
  311. data/rbi/stripe/services/test_helpers/test_clock_service.rbi +1 -3
  312. data/rbi/stripe/services/token_service.rbi +71 -3
  313. data/rbi/stripe/services/transfer_service.rbi +1 -1
  314. data/rbi/stripe/services/treasury/financial_account_service.rbi +6 -2
  315. data/rbi/stripe/services/v2/billing/meter_event_session_service.rbi +1 -3
  316. data/rbi/stripe/services/v2/billing_service.rbi +1 -1
  317. data/rbi/stripe/services/v2/core/event_destination_service.rbi +14 -22
  318. data/rbi/stripe/services/v2/core/event_service.rbi +1 -3
  319. data/rbi/stripe/services/webhook_endpoint_service.rbi +1 -3
  320. metadata +5 -2
@@ -54,7 +54,7 @@ module Stripe
54
54
  # The account or customer the tax ID belongs to.
55
55
  sig { returns(T.nilable(Owner)) }
56
56
  attr_reader :owner
57
- # Type of the tax ID, one of `ad_nrt`, `ae_trn`, `al_tin`, `am_tin`, `ao_tin`, `ar_cuit`, `au_abn`, `au_arn`, `ba_tin`, `bb_tin`, `bg_uic`, `bh_vat`, `bo_tin`, `br_cnpj`, `br_cpf`, `bs_tin`, `by_tin`, `ca_bn`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `ca_qst`, `cd_nif`, `ch_uid`, `ch_vat`, `cl_tin`, `cn_tin`, `co_nit`, `cr_tin`, `de_stn`, `do_rcn`, `ec_ruc`, `eg_tin`, `es_cif`, `eu_oss_vat`, `eu_vat`, `gb_vat`, `ge_vat`, `gn_nif`, `hk_br`, `hr_oib`, `hu_tin`, `id_npwp`, `il_vat`, `in_gst`, `is_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `ke_pin`, `kh_tin`, `kr_brn`, `kz_bin`, `li_uid`, `li_vat`, `ma_vat`, `md_vat`, `me_pib`, `mk_vat`, `mr_nif`, `mx_rfc`, `my_frp`, `my_itn`, `my_sst`, `ng_tin`, `no_vat`, `no_voec`, `np_pan`, `nz_gst`, `om_vat`, `pe_ruc`, `ph_tin`, `ro_tin`, `rs_pib`, `ru_inn`, `ru_kpp`, `sa_vat`, `sg_gst`, `sg_uen`, `si_tin`, `sn_ninea`, `sr_fin`, `sv_nit`, `th_vat`, `tj_tin`, `tr_tin`, `tw_vat`, `tz_vat`, `ua_vat`, `ug_tin`, `us_ein`, `uy_ruc`, `uz_tin`, `uz_vat`, `ve_rif`, `vn_tin`, `za_vat`, `zm_tin`, or `zw_tin`. Note that some legacy tax IDs have type `unknown`
57
+ # Type of the tax ID, one of `ad_nrt`, `ae_trn`, `al_tin`, `am_tin`, `ao_tin`, `ar_cuit`, `au_abn`, `au_arn`, `aw_tin`, `az_tin`, `ba_tin`, `bb_tin`, `bd_bin`, `bf_ifu`, `bg_uic`, `bh_vat`, `bj_ifu`, `bo_tin`, `br_cnpj`, `br_cpf`, `bs_tin`, `by_tin`, `ca_bn`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `ca_qst`, `cd_nif`, `ch_uid`, `ch_vat`, `cl_tin`, `cm_niu`, `cn_tin`, `co_nit`, `cr_tin`, `cv_nif`, `de_stn`, `do_rcn`, `ec_ruc`, `eg_tin`, `es_cif`, `et_tin`, `eu_oss_vat`, `eu_vat`, `gb_vat`, `ge_vat`, `gn_nif`, `hk_br`, `hr_oib`, `hu_tin`, `id_npwp`, `il_vat`, `in_gst`, `is_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `ke_pin`, `kg_tin`, `kh_tin`, `kr_brn`, `kz_bin`, `la_tin`, `li_uid`, `li_vat`, `ma_vat`, `md_vat`, `me_pib`, `mk_vat`, `mr_nif`, `mx_rfc`, `my_frp`, `my_itn`, `my_sst`, `ng_tin`, `no_vat`, `no_voec`, `np_pan`, `nz_gst`, `om_vat`, `pe_ruc`, `ph_tin`, `ro_tin`, `rs_pib`, `ru_inn`, `ru_kpp`, `sa_vat`, `sg_gst`, `sg_uen`, `si_tin`, `sn_ninea`, `sr_fin`, `sv_nit`, `th_vat`, `tj_tin`, `tr_tin`, `tw_vat`, `tz_vat`, `ua_vat`, `ug_tin`, `us_ein`, `uy_ruc`, `uz_tin`, `uz_vat`, `ve_rif`, `vn_tin`, `za_vat`, `zm_tin`, or `zw_tin`. Note that some legacy tax IDs have type `unknown`
58
58
  sig { returns(String) }
59
59
  attr_reader :type
60
60
  # Value of the tax ID.
@@ -66,9 +66,7 @@ module Stripe
66
66
  # Always true for a deleted object
67
67
  sig { returns(T::Boolean) }
68
68
  attr_reader :deleted
69
- class DeleteParams < Stripe::RequestParams
70
-
71
- end
69
+ class DeleteParams < Stripe::RequestParams; end
72
70
  class ListParams < Stripe::RequestParams
73
71
  class Owner < Stripe::RequestParams
74
72
  # Account the tax ID belongs to. Required when `type=account`
@@ -129,7 +127,7 @@ module Stripe
129
127
  # The account or customer the tax ID belongs to. Defaults to `owner[type]=self`.
130
128
  sig { returns(T.nilable(::Stripe::TaxId::CreateParams::Owner)) }
131
129
  attr_accessor :owner
132
- # Type of the tax ID, one of `ad_nrt`, `ae_trn`, `al_tin`, `am_tin`, `ao_tin`, `ar_cuit`, `au_abn`, `au_arn`, `ba_tin`, `bb_tin`, `bg_uic`, `bh_vat`, `bo_tin`, `br_cnpj`, `br_cpf`, `bs_tin`, `by_tin`, `ca_bn`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `ca_qst`, `cd_nif`, `ch_uid`, `ch_vat`, `cl_tin`, `cn_tin`, `co_nit`, `cr_tin`, `de_stn`, `do_rcn`, `ec_ruc`, `eg_tin`, `es_cif`, `eu_oss_vat`, `eu_vat`, `gb_vat`, `ge_vat`, `gn_nif`, `hk_br`, `hr_oib`, `hu_tin`, `id_npwp`, `il_vat`, `in_gst`, `is_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `ke_pin`, `kh_tin`, `kr_brn`, `kz_bin`, `li_uid`, `li_vat`, `ma_vat`, `md_vat`, `me_pib`, `mk_vat`, `mr_nif`, `mx_rfc`, `my_frp`, `my_itn`, `my_sst`, `ng_tin`, `no_vat`, `no_voec`, `np_pan`, `nz_gst`, `om_vat`, `pe_ruc`, `ph_tin`, `ro_tin`, `rs_pib`, `ru_inn`, `ru_kpp`, `sa_vat`, `sg_gst`, `sg_uen`, `si_tin`, `sn_ninea`, `sr_fin`, `sv_nit`, `th_vat`, `tj_tin`, `tr_tin`, `tw_vat`, `tz_vat`, `ua_vat`, `ug_tin`, `us_ein`, `uy_ruc`, `uz_tin`, `uz_vat`, `ve_rif`, `vn_tin`, `za_vat`, `zm_tin`, or `zw_tin`
130
+ # Type of the tax ID, one of `ad_nrt`, `ae_trn`, `al_tin`, `am_tin`, `ao_tin`, `ar_cuit`, `au_abn`, `au_arn`, `aw_tin`, `az_tin`, `ba_tin`, `bb_tin`, `bd_bin`, `bf_ifu`, `bg_uic`, `bh_vat`, `bj_ifu`, `bo_tin`, `br_cnpj`, `br_cpf`, `bs_tin`, `by_tin`, `ca_bn`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `ca_qst`, `cd_nif`, `ch_uid`, `ch_vat`, `cl_tin`, `cm_niu`, `cn_tin`, `co_nit`, `cr_tin`, `cv_nif`, `de_stn`, `do_rcn`, `ec_ruc`, `eg_tin`, `es_cif`, `et_tin`, `eu_oss_vat`, `eu_vat`, `gb_vat`, `ge_vat`, `gn_nif`, `hk_br`, `hr_oib`, `hu_tin`, `id_npwp`, `il_vat`, `in_gst`, `is_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `ke_pin`, `kg_tin`, `kh_tin`, `kr_brn`, `kz_bin`, `la_tin`, `li_uid`, `li_vat`, `ma_vat`, `md_vat`, `me_pib`, `mk_vat`, `mr_nif`, `mx_rfc`, `my_frp`, `my_itn`, `my_sst`, `ng_tin`, `no_vat`, `no_voec`, `np_pan`, `nz_gst`, `om_vat`, `pe_ruc`, `ph_tin`, `ro_tin`, `rs_pib`, `ru_inn`, `ru_kpp`, `sa_vat`, `sg_gst`, `sg_uen`, `si_tin`, `sn_ninea`, `sr_fin`, `sv_nit`, `th_vat`, `tj_tin`, `tr_tin`, `tw_vat`, `tz_vat`, `ua_vat`, `ug_tin`, `us_ein`, `uy_ruc`, `uz_tin`, `uz_vat`, `ve_rif`, `vn_tin`, `za_vat`, `zm_tin`, or `zw_tin`
133
131
  sig { returns(String) }
134
132
  attr_accessor :type
135
133
  # Value of the tax ID.
@@ -3,9 +3,9 @@
3
3
 
4
4
  # typed: true
5
5
  module Stripe
6
- # Tax rates can be applied to [invoices](https://stripe.com/invoicing/taxes/tax-rates), [subscriptions](https://stripe.com/billing/taxes/tax-rates) and [Checkout Sessions](https://stripe.com/payments/checkout/use-manual-tax-rates) to collect tax.
6
+ # Tax rates can be applied to [invoices](https://docs.stripe.com/invoicing/taxes/tax-rates), [subscriptions](https://docs.stripe.com/billing/taxes/tax-rates) and [Checkout Sessions](https://docs.stripe.com/payments/checkout/use-manual-tax-rates) to collect tax.
7
7
  #
8
- # Related guide: [Tax rates](https://stripe.com/billing/taxes/tax-rates)
8
+ # Related guide: [Tax rates](https://docs.stripe.com/billing/taxes/tax-rates)
9
9
  class TaxRate < APIResource
10
10
  class FlatAmount < Stripe::StripeObject
11
11
  # Amount of the tax when the `rate_type` is `flat_amount`. This positive integer represents how much to charge in the smallest currency unit (e.g., 100 cents to charge $1.00 or 100 to charge ¥100, a zero-decimal currency). The amount value supports up to eight digits (e.g., a value of 99999999 for a USD charge of $999,999.99).
@@ -5,6 +5,7 @@
5
5
  module Stripe
6
6
  module Terminal
7
7
  # A Configurations object represents how features should be configured for terminal readers.
8
+ # For information about how to use it, see the [Terminal configurations documentation](https://docs.stripe.com/terminal/fleet/configurations-overview).
8
9
  class Configuration < APIResource
9
10
  class BbposWiseposE < Stripe::StripeObject
10
11
  # A File ID representing an image to display on the reader
@@ -352,9 +353,7 @@ module Stripe
352
353
  # Always true for a deleted object
353
354
  sig { returns(T::Boolean) }
354
355
  attr_reader :deleted
355
- class DeleteParams < Stripe::RequestParams
356
-
357
- end
356
+ class DeleteParams < Stripe::RequestParams; end
358
357
  class UpdateParams < Stripe::RequestParams
359
358
  class BbposWiseposE < Stripe::RequestParams
360
359
  # A File ID representing an image to display on the reader
@@ -52,9 +52,7 @@ module Stripe
52
52
  # Always true for a deleted object
53
53
  sig { returns(T::Boolean) }
54
54
  attr_reader :deleted
55
- class DeleteParams < Stripe::RequestParams
56
-
57
- end
55
+ class DeleteParams < Stripe::RequestParams; end
58
56
  class UpdateParams < Stripe::RequestParams
59
57
  class Address < Stripe::RequestParams
60
58
  # City, district, suburb, town, or village.
@@ -94,7 +92,7 @@ module Stripe
94
92
  sig { returns(T.nilable(T.nilable(String))) }
95
93
  attr_accessor :configuration_overrides
96
94
  # A name for the location.
97
- sig { returns(T.nilable(String)) }
95
+ sig { returns(T.nilable(T.nilable(String))) }
98
96
  attr_accessor :display_name
99
97
  # Specifies which fields in the response should be expanded.
100
98
  sig { returns(T.nilable(T::Array[String])) }
@@ -103,7 +101,7 @@ module Stripe
103
101
  sig { returns(T.nilable(T.nilable(T.any(String, T::Hash[String, String])))) }
104
102
  attr_accessor :metadata
105
103
  sig {
106
- params(address: T.nilable(::Stripe::Terminal::Location::UpdateParams::Address), configuration_overrides: T.nilable(T.nilable(String)), display_name: T.nilable(String), expand: T.nilable(T::Array[String]), metadata: T.nilable(T.nilable(T.any(String, T::Hash[String, String])))).void
104
+ params(address: T.nilable(::Stripe::Terminal::Location::UpdateParams::Address), configuration_overrides: T.nilable(T.nilable(String)), display_name: T.nilable(T.nilable(String)), expand: T.nilable(T::Array[String]), metadata: T.nilable(T.nilable(T.any(String, T::Hash[String, String])))).void
107
105
  }
108
106
  def initialize(
109
107
  address: nil,
@@ -190,7 +188,7 @@ module Stripe
190
188
  ); end
191
189
  end
192
190
  # Creates a new Location object.
193
- # For further details, including which address fields are required in each country, see the [Manage locations](https://stripe.com/docs/terminal/fleet/locations) guide.
191
+ # For further details, including which address fields are required in each country, see the [Manage locations](https://docs.stripe.com/docs/terminal/fleet/locations) guide.
194
192
  sig {
195
193
  params(params: T.any(::Stripe::Terminal::Location::CreateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Terminal::Location)
196
194
  }
@@ -9,6 +9,168 @@ module Stripe
9
9
  # Related guide: [Connecting to a reader](https://stripe.com/docs/terminal/payments/connect-reader)
10
10
  class Reader < APIResource
11
11
  class Action < Stripe::StripeObject
12
+ class CollectInputs < Stripe::StripeObject
13
+ class Input < Stripe::StripeObject
14
+ class CustomText < Stripe::StripeObject
15
+ # Customize the default description for this input
16
+ sig { returns(T.nilable(String)) }
17
+ attr_reader :description
18
+ # Customize the default label for this input's skip button
19
+ sig { returns(T.nilable(String)) }
20
+ attr_reader :skip_button
21
+ # Customize the default label for this input's submit button
22
+ sig { returns(T.nilable(String)) }
23
+ attr_reader :submit_button
24
+ # Customize the default title for this input
25
+ sig { returns(T.nilable(String)) }
26
+ attr_reader :title
27
+ end
28
+ class Email < Stripe::StripeObject
29
+ # The collected email address
30
+ sig { returns(T.nilable(String)) }
31
+ attr_reader :value
32
+ end
33
+ class Numeric < Stripe::StripeObject
34
+ # The collected number
35
+ sig { returns(T.nilable(String)) }
36
+ attr_reader :value
37
+ end
38
+ class Phone < Stripe::StripeObject
39
+ # The collected phone number
40
+ sig { returns(T.nilable(String)) }
41
+ attr_reader :value
42
+ end
43
+ class Selection < Stripe::StripeObject
44
+ class Choice < Stripe::StripeObject
45
+ # The id to be selected
46
+ sig { returns(T.nilable(String)) }
47
+ attr_reader :id
48
+ # The button style for the choice
49
+ sig { returns(T.nilable(String)) }
50
+ attr_reader :style
51
+ # The text to be selected
52
+ sig { returns(String) }
53
+ attr_reader :text
54
+ end
55
+ # List of possible choices to be selected
56
+ sig { returns(T::Array[Choice]) }
57
+ attr_reader :choices
58
+ # The id of the selected choice
59
+ sig { returns(T.nilable(String)) }
60
+ attr_reader :id
61
+ # The text of the selected choice
62
+ sig { returns(T.nilable(String)) }
63
+ attr_reader :text
64
+ end
65
+ class Signature < Stripe::StripeObject
66
+ # The File ID of a collected signature image
67
+ sig { returns(T.nilable(String)) }
68
+ attr_reader :value
69
+ end
70
+ class Text < Stripe::StripeObject
71
+ # The collected text value
72
+ sig { returns(T.nilable(String)) }
73
+ attr_reader :value
74
+ end
75
+ class Toggle < Stripe::StripeObject
76
+ # The toggle's default value
77
+ sig { returns(T.nilable(String)) }
78
+ attr_reader :default_value
79
+ # The toggle's description text
80
+ sig { returns(T.nilable(String)) }
81
+ attr_reader :description
82
+ # The toggle's title text
83
+ sig { returns(T.nilable(String)) }
84
+ attr_reader :title
85
+ # The toggle's collected value
86
+ sig { returns(T.nilable(String)) }
87
+ attr_reader :value
88
+ end
89
+ # Default text of input being collected.
90
+ sig { returns(T.nilable(CustomText)) }
91
+ attr_reader :custom_text
92
+ # Information about a email being collected using a reader
93
+ sig { returns(Email) }
94
+ attr_reader :email
95
+ # Information about a number being collected using a reader
96
+ sig { returns(Numeric) }
97
+ attr_reader :numeric
98
+ # Information about a phone number being collected using a reader
99
+ sig { returns(Phone) }
100
+ attr_reader :phone
101
+ # Indicate that this input is required, disabling the skip button.
102
+ sig { returns(T.nilable(T::Boolean)) }
103
+ attr_reader :required
104
+ # Information about a selection being collected using a reader
105
+ sig { returns(Selection) }
106
+ attr_reader :selection
107
+ # Information about a signature being collected using a reader
108
+ sig { returns(Signature) }
109
+ attr_reader :signature
110
+ # Indicate that this input was skipped by the user.
111
+ sig { returns(T::Boolean) }
112
+ attr_reader :skipped
113
+ # Information about text being collected using a reader
114
+ sig { returns(Text) }
115
+ attr_reader :text
116
+ # List of toggles being collected. Values are present if collection is complete.
117
+ sig { returns(T.nilable(T::Array[Toggle])) }
118
+ attr_reader :toggles
119
+ # Type of input being collected.
120
+ sig { returns(String) }
121
+ attr_reader :type
122
+ end
123
+ # List of inputs to be collected.
124
+ sig { returns(T::Array[Input]) }
125
+ attr_reader :inputs
126
+ # 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.
127
+ sig { returns(T.nilable(T::Hash[String, String])) }
128
+ attr_reader :metadata
129
+ end
130
+ class CollectPaymentMethod < Stripe::StripeObject
131
+ class CollectConfig < Stripe::StripeObject
132
+ class Tipping < Stripe::StripeObject
133
+ # Amount used to calculate tip suggestions on tipping selection screen for this transaction. Must be a positive integer in the smallest currency unit (e.g., 100 cents to represent $1.00 or 100 to represent ¥100, a zero-decimal currency).
134
+ sig { returns(Integer) }
135
+ attr_reader :amount_eligible
136
+ end
137
+ # Enable customer-initiated cancellation when processing this payment.
138
+ sig { returns(T::Boolean) }
139
+ attr_reader :enable_customer_cancellation
140
+ # Override showing a tipping selection screen on this transaction.
141
+ sig { returns(T::Boolean) }
142
+ attr_reader :skip_tipping
143
+ # Represents a per-transaction tipping configuration
144
+ sig { returns(Tipping) }
145
+ attr_reader :tipping
146
+ end
147
+ # Represents a per-transaction override of a reader configuration
148
+ sig { returns(CollectConfig) }
149
+ attr_reader :collect_config
150
+ # Most recent PaymentIntent processed by the reader.
151
+ sig { returns(T.any(String, Stripe::PaymentIntent)) }
152
+ attr_reader :payment_intent
153
+ # PaymentMethod objects represent your customer's payment instruments.
154
+ # You can use them with [PaymentIntents](https://stripe.com/docs/payments/payment-intents) to collect payments or save them to
155
+ # Customer objects to store instrument details for future payments.
156
+ #
157
+ # Related guides: [Payment Methods](https://stripe.com/docs/payments/payment-methods) and [More Payment Scenarios](https://stripe.com/docs/payments/more-payment-scenarios).
158
+ sig { returns(Stripe::PaymentMethod) }
159
+ attr_reader :payment_method
160
+ end
161
+ class ConfirmPaymentIntent < Stripe::StripeObject
162
+ class ConfirmConfig < Stripe::StripeObject
163
+ # If the customer doesn't abandon authenticating the payment, they're redirected to this URL after completion.
164
+ sig { returns(String) }
165
+ attr_reader :return_url
166
+ end
167
+ # Represents a per-transaction override of a reader configuration
168
+ sig { returns(ConfirmConfig) }
169
+ attr_reader :confirm_config
170
+ # Most recent PaymentIntent processed by the reader.
171
+ sig { returns(T.any(String, Stripe::PaymentIntent)) }
172
+ attr_reader :payment_intent
173
+ end
12
174
  class ProcessPaymentIntent < Stripe::StripeObject
13
175
  class ProcessConfig < Stripe::StripeObject
14
176
  class Tipping < Stripe::StripeObject
@@ -16,9 +178,12 @@ module Stripe
16
178
  sig { returns(Integer) }
17
179
  attr_reader :amount_eligible
18
180
  end
19
- # Enable customer initiated cancellation when processing this payment.
181
+ # Enable customer-initiated cancellation when processing this payment.
20
182
  sig { returns(T::Boolean) }
21
183
  attr_reader :enable_customer_cancellation
184
+ # If the customer doesn't abandon authenticating the payment, they're redirected to this URL after completion.
185
+ sig { returns(String) }
186
+ attr_reader :return_url
22
187
  # Override showing a tipping selection screen on this transaction.
23
188
  sig { returns(T::Boolean) }
24
189
  attr_reader :skip_tipping
@@ -35,7 +200,7 @@ module Stripe
35
200
  end
36
201
  class ProcessSetupIntent < Stripe::StripeObject
37
202
  class ProcessConfig < Stripe::StripeObject
38
- # Enable customer initiated cancellation when processing this SetupIntent.
203
+ # Enable customer-initiated cancellation when processing this SetupIntent.
39
204
  sig { returns(T::Boolean) }
40
205
  attr_reader :enable_customer_cancellation
41
206
  end
@@ -51,7 +216,7 @@ module Stripe
51
216
  end
52
217
  class RefundPayment < Stripe::StripeObject
53
218
  class RefundPaymentConfig < Stripe::StripeObject
54
- # Enable customer initiated cancellation when refunding this payment.
219
+ # Enable customer-initiated cancellation when refunding this payment.
55
220
  sig { returns(T::Boolean) }
56
221
  attr_reader :enable_customer_cancellation
57
222
  end
@@ -116,6 +281,15 @@ module Stripe
116
281
  sig { returns(String) }
117
282
  attr_reader :type
118
283
  end
284
+ # Represents a reader action to collect customer inputs
285
+ sig { returns(CollectInputs) }
286
+ attr_reader :collect_inputs
287
+ # Represents a reader action to collect a payment method
288
+ sig { returns(CollectPaymentMethod) }
289
+ attr_reader :collect_payment_method
290
+ # Represents a reader action to confirm a payment
291
+ sig { returns(ConfirmPaymentIntent) }
292
+ attr_reader :confirm_payment_intent
119
293
  # Failure code, only set if status is `failed`.
120
294
  sig { returns(T.nilable(String)) }
121
295
  attr_reader :failure_code
@@ -147,7 +321,7 @@ module Stripe
147
321
  # The current software version of the reader.
148
322
  sig { returns(T.nilable(String)) }
149
323
  attr_reader :device_sw_version
150
- # Type of reader, one of `bbpos_wisepad3`, `stripe_m2`, `stripe_s700`, `bbpos_chipper2x`, `bbpos_wisepos_e`, `verifone_P400`, `simulated_wisepos_e`, or `mobile_phone_reader`.
324
+ # Device type of the reader.
151
325
  sig { returns(String) }
152
326
  attr_reader :device_type
153
327
  # Unique identifier for the object.
@@ -180,9 +354,7 @@ module Stripe
180
354
  # Always true for a deleted object
181
355
  sig { returns(T::Boolean) }
182
356
  attr_reader :deleted
183
- class DeleteParams < Stripe::RequestParams
184
-
185
- end
357
+ class DeleteParams < Stripe::RequestParams; end
186
358
  class UpdateParams < Stripe::RequestParams
187
359
  # Specifies which fields in the response should be expanded.
188
360
  sig { returns(T.nilable(T::Array[String])) }
@@ -271,6 +443,182 @@ module Stripe
271
443
  sig { params(expand: T.nilable(T::Array[String])).void }
272
444
  def initialize(expand: nil); end
273
445
  end
446
+ class CollectInputsParams < Stripe::RequestParams
447
+ class Input < Stripe::RequestParams
448
+ class CustomText < Stripe::RequestParams
449
+ # The description which will be displayed when collecting this input
450
+ sig { returns(T.nilable(String)) }
451
+ attr_accessor :description
452
+ # The skip button text
453
+ sig { returns(T.nilable(String)) }
454
+ attr_accessor :skip_button
455
+ # The submit button text
456
+ sig { returns(T.nilable(String)) }
457
+ attr_accessor :submit_button
458
+ # The title which will be displayed when collecting this input
459
+ sig { returns(String) }
460
+ attr_accessor :title
461
+ sig {
462
+ params(description: T.nilable(String), skip_button: T.nilable(String), submit_button: T.nilable(String), title: String).void
463
+ }
464
+ def initialize(description: nil, skip_button: nil, submit_button: nil, title: nil); end
465
+ end
466
+ class Selection < Stripe::RequestParams
467
+ class Choice < Stripe::RequestParams
468
+ # The unique identifier for this choice
469
+ sig { returns(String) }
470
+ attr_accessor :id
471
+ # The style of the button which will be shown for this choice
472
+ sig { returns(T.nilable(String)) }
473
+ attr_accessor :style
474
+ # The text which will be shown on the button for this choice
475
+ sig { returns(String) }
476
+ attr_accessor :text
477
+ sig { params(id: String, style: T.nilable(String), text: String).void }
478
+ def initialize(id: nil, style: nil, text: nil); end
479
+ end
480
+ # List of choices for the `selection` input
481
+ sig {
482
+ returns(T::Array[::Stripe::Terminal::Reader::CollectInputsParams::Input::Selection::Choice])
483
+ }
484
+ attr_accessor :choices
485
+ sig {
486
+ params(choices: T::Array[::Stripe::Terminal::Reader::CollectInputsParams::Input::Selection::Choice]).void
487
+ }
488
+ def initialize(choices: nil); end
489
+ end
490
+ class Toggle < Stripe::RequestParams
491
+ # The default value of the toggle
492
+ sig { returns(T.nilable(String)) }
493
+ attr_accessor :default_value
494
+ # The description which will be displayed for the toggle
495
+ sig { returns(T.nilable(String)) }
496
+ attr_accessor :description
497
+ # The title which will be displayed for the toggle
498
+ sig { returns(T.nilable(String)) }
499
+ attr_accessor :title
500
+ sig {
501
+ params(default_value: T.nilable(String), description: T.nilable(String), title: T.nilable(String)).void
502
+ }
503
+ def initialize(default_value: nil, description: nil, title: nil); end
504
+ end
505
+ # Customize the text which will be displayed while collecting this input
506
+ sig { returns(::Stripe::Terminal::Reader::CollectInputsParams::Input::CustomText) }
507
+ attr_accessor :custom_text
508
+ # Indicate that this input is required, disabling the skip button
509
+ sig { returns(T.nilable(T::Boolean)) }
510
+ attr_accessor :required
511
+ # Options for the `selection` input
512
+ sig {
513
+ returns(T.nilable(::Stripe::Terminal::Reader::CollectInputsParams::Input::Selection))
514
+ }
515
+ attr_accessor :selection
516
+ # List of toggles to be displayed and customization for the toggles
517
+ sig {
518
+ returns(T.nilable(T::Array[::Stripe::Terminal::Reader::CollectInputsParams::Input::Toggle]))
519
+ }
520
+ attr_accessor :toggles
521
+ # The type of input to collect
522
+ sig { returns(String) }
523
+ attr_accessor :type
524
+ sig {
525
+ params(custom_text: ::Stripe::Terminal::Reader::CollectInputsParams::Input::CustomText, required: T.nilable(T::Boolean), selection: T.nilable(::Stripe::Terminal::Reader::CollectInputsParams::Input::Selection), toggles: T.nilable(T::Array[::Stripe::Terminal::Reader::CollectInputsParams::Input::Toggle]), type: String).void
526
+ }
527
+ def initialize(
528
+ custom_text: nil,
529
+ required: nil,
530
+ selection: nil,
531
+ toggles: nil,
532
+ type: nil
533
+ ); end
534
+ end
535
+ # Specifies which fields in the response should be expanded.
536
+ sig { returns(T.nilable(T::Array[String])) }
537
+ attr_accessor :expand
538
+ # List of inputs to be collected using the Reader
539
+ sig { returns(T::Array[::Stripe::Terminal::Reader::CollectInputsParams::Input]) }
540
+ attr_accessor :inputs
541
+ # 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`.
542
+ sig { returns(T.nilable(T::Hash[String, String])) }
543
+ attr_accessor :metadata
544
+ sig {
545
+ params(expand: T.nilable(T::Array[String]), inputs: T::Array[::Stripe::Terminal::Reader::CollectInputsParams::Input], metadata: T.nilable(T::Hash[String, String])).void
546
+ }
547
+ def initialize(expand: nil, inputs: nil, metadata: nil); end
548
+ end
549
+ class CollectPaymentMethodParams < Stripe::RequestParams
550
+ class CollectConfig < Stripe::RequestParams
551
+ class Tipping < Stripe::RequestParams
552
+ # Amount used to calculate tip suggestions on tipping selection screen for this transaction. Must be a positive integer in the smallest currency unit (e.g., 100 cents to represent $1.00 or 100 to represent ¥100, a zero-decimal currency).
553
+ sig { returns(T.nilable(Integer)) }
554
+ attr_accessor :amount_eligible
555
+ sig { params(amount_eligible: T.nilable(Integer)).void }
556
+ def initialize(amount_eligible: nil); end
557
+ end
558
+ # This field indicates whether this payment method can be shown again to its customer in a checkout flow. Stripe products such as Checkout and Elements use this field to determine whether a payment method can be shown as a saved payment method in a checkout flow.
559
+ sig { returns(T.nilable(String)) }
560
+ attr_accessor :allow_redisplay
561
+ # Enables cancel button on transaction screens.
562
+ sig { returns(T.nilable(T::Boolean)) }
563
+ attr_accessor :enable_customer_cancellation
564
+ # Override showing a tipping selection screen on this transaction.
565
+ sig { returns(T.nilable(T::Boolean)) }
566
+ attr_accessor :skip_tipping
567
+ # Tipping configuration for this transaction.
568
+ sig {
569
+ returns(T.nilable(::Stripe::Terminal::Reader::CollectPaymentMethodParams::CollectConfig::Tipping))
570
+ }
571
+ attr_accessor :tipping
572
+ sig {
573
+ params(allow_redisplay: T.nilable(String), enable_customer_cancellation: T.nilable(T::Boolean), skip_tipping: T.nilable(T::Boolean), tipping: T.nilable(::Stripe::Terminal::Reader::CollectPaymentMethodParams::CollectConfig::Tipping)).void
574
+ }
575
+ def initialize(
576
+ allow_redisplay: nil,
577
+ enable_customer_cancellation: nil,
578
+ skip_tipping: nil,
579
+ tipping: nil
580
+ ); end
581
+ end
582
+ # Configuration overrides.
583
+ sig {
584
+ returns(T.nilable(::Stripe::Terminal::Reader::CollectPaymentMethodParams::CollectConfig))
585
+ }
586
+ attr_accessor :collect_config
587
+ # Specifies which fields in the response should be expanded.
588
+ sig { returns(T.nilable(T::Array[String])) }
589
+ attr_accessor :expand
590
+ # PaymentIntent ID.
591
+ sig { returns(String) }
592
+ attr_accessor :payment_intent
593
+ sig {
594
+ params(collect_config: T.nilable(::Stripe::Terminal::Reader::CollectPaymentMethodParams::CollectConfig), expand: T.nilable(T::Array[String]), payment_intent: String).void
595
+ }
596
+ def initialize(collect_config: nil, expand: nil, payment_intent: nil); end
597
+ end
598
+ class ConfirmPaymentIntentParams < Stripe::RequestParams
599
+ class ConfirmConfig < Stripe::RequestParams
600
+ # The URL to redirect your customer back to after they authenticate or cancel their payment on the payment method's app or site. If you'd prefer to redirect to a mobile application, you can alternatively supply an application URI scheme.
601
+ sig { returns(T.nilable(String)) }
602
+ attr_accessor :return_url
603
+ sig { params(return_url: T.nilable(String)).void }
604
+ def initialize(return_url: nil); end
605
+ end
606
+ # Configuration overrides.
607
+ sig {
608
+ returns(T.nilable(::Stripe::Terminal::Reader::ConfirmPaymentIntentParams::ConfirmConfig))
609
+ }
610
+ attr_accessor :confirm_config
611
+ # Specifies which fields in the response should be expanded.
612
+ sig { returns(T.nilable(T::Array[String])) }
613
+ attr_accessor :expand
614
+ # PaymentIntent ID.
615
+ sig { returns(String) }
616
+ attr_accessor :payment_intent
617
+ sig {
618
+ params(confirm_config: T.nilable(::Stripe::Terminal::Reader::ConfirmPaymentIntentParams::ConfirmConfig), expand: T.nilable(T::Array[String]), payment_intent: String).void
619
+ }
620
+ def initialize(confirm_config: nil, expand: nil, payment_intent: nil); end
621
+ end
274
622
  class ProcessPaymentIntentParams < Stripe::RequestParams
275
623
  class ProcessConfig < Stripe::RequestParams
276
624
  class Tipping < Stripe::RequestParams
@@ -286,6 +634,9 @@ module Stripe
286
634
  # Enables cancel button on transaction screens.
287
635
  sig { returns(T.nilable(T::Boolean)) }
288
636
  attr_accessor :enable_customer_cancellation
637
+ # The URL to redirect your customer back to after they authenticate or cancel their payment on the payment method's app or site. If you'd prefer to redirect to a mobile application, you can alternatively supply an application URI scheme.
638
+ sig { returns(T.nilable(String)) }
639
+ attr_accessor :return_url
289
640
  # Override showing a tipping selection screen on this transaction.
290
641
  sig { returns(T.nilable(T::Boolean)) }
291
642
  attr_accessor :skip_tipping
@@ -295,11 +646,12 @@ module Stripe
295
646
  }
296
647
  attr_accessor :tipping
297
648
  sig {
298
- params(allow_redisplay: T.nilable(String), enable_customer_cancellation: T.nilable(T::Boolean), skip_tipping: T.nilable(T::Boolean), tipping: T.nilable(::Stripe::Terminal::Reader::ProcessPaymentIntentParams::ProcessConfig::Tipping)).void
649
+ params(allow_redisplay: T.nilable(String), enable_customer_cancellation: T.nilable(T::Boolean), return_url: T.nilable(String), skip_tipping: T.nilable(T::Boolean), tipping: T.nilable(::Stripe::Terminal::Reader::ProcessPaymentIntentParams::ProcessConfig::Tipping)).void
299
650
  }
300
651
  def initialize(
301
652
  allow_redisplay: nil,
302
653
  enable_customer_cancellation: nil,
654
+ return_url: nil,
303
655
  skip_tipping: nil,
304
656
  tipping: nil
305
657
  ); end
@@ -493,6 +845,25 @@ module Stripe
493
845
  type: nil
494
846
  ); end
495
847
  end
848
+ class SucceedInputCollectionParams < Stripe::RequestParams
849
+ # Specifies which fields in the response should be expanded.
850
+ sig { returns(T.nilable(T::Array[String])) }
851
+ attr_accessor :expand
852
+ # This parameter defines the skip behavior for input collection.
853
+ sig { returns(T.nilable(String)) }
854
+ attr_accessor :skip_non_required_inputs
855
+ sig {
856
+ params(expand: T.nilable(T::Array[String]), skip_non_required_inputs: T.nilable(String)).void
857
+ }
858
+ def initialize(expand: nil, skip_non_required_inputs: nil); end
859
+ end
860
+ class TimeoutInputCollectionParams < Stripe::RequestParams
861
+ # Specifies which fields in the response should be expanded.
862
+ sig { returns(T.nilable(T::Array[String])) }
863
+ attr_accessor :expand
864
+ sig { params(expand: T.nilable(T::Array[String])).void }
865
+ def initialize(expand: nil); end
866
+ end
496
867
  # Cancels the current reader action.
497
868
  sig {
498
869
  params(params: T.any(::Stripe::Terminal::Reader::CancelActionParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Terminal::Reader)
@@ -505,6 +876,42 @@ module Stripe
505
876
  }
506
877
  def self.cancel_action(reader, params = {}, opts = {}); end
507
878
 
879
+ # Initiates an input collection flow on a Reader.
880
+ sig {
881
+ params(params: T.any(::Stripe::Terminal::Reader::CollectInputsParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Terminal::Reader)
882
+ }
883
+ def collect_inputs(params = {}, opts = {}); end
884
+
885
+ # Initiates an input collection flow on a Reader.
886
+ sig {
887
+ params(reader: String, params: T.any(::Stripe::Terminal::Reader::CollectInputsParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Terminal::Reader)
888
+ }
889
+ def self.collect_inputs(reader, params = {}, opts = {}); end
890
+
891
+ # Initiates a payment flow on a Reader and updates the PaymentIntent with card details before manual confirmation.
892
+ sig {
893
+ params(params: T.any(::Stripe::Terminal::Reader::CollectPaymentMethodParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Terminal::Reader)
894
+ }
895
+ def collect_payment_method(params = {}, opts = {}); end
896
+
897
+ # Initiates a payment flow on a Reader and updates the PaymentIntent with card details before manual confirmation.
898
+ sig {
899
+ params(reader: String, params: T.any(::Stripe::Terminal::Reader::CollectPaymentMethodParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Terminal::Reader)
900
+ }
901
+ def self.collect_payment_method(reader, params = {}, opts = {}); end
902
+
903
+ # Finalizes a payment on a Reader.
904
+ sig {
905
+ params(params: T.any(::Stripe::Terminal::Reader::ConfirmPaymentIntentParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Terminal::Reader)
906
+ }
907
+ def confirm_payment_intent(params = {}, opts = {}); end
908
+
909
+ # Finalizes a payment on a Reader.
910
+ sig {
911
+ params(reader: String, params: T.any(::Stripe::Terminal::Reader::ConfirmPaymentIntentParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Terminal::Reader)
912
+ }
913
+ def self.confirm_payment_intent(reader, params = {}, opts = {}); end
914
+
508
915
  # Creates a new Reader object.
509
916
  sig {
510
917
  params(params: T.any(::Stripe::Terminal::Reader::CreateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Terminal::Reader)
@@ -48,9 +48,7 @@ module Stripe
48
48
  # Always true for a deleted object
49
49
  sig { returns(T::Boolean) }
50
50
  attr_reader :deleted
51
- class DeleteParams < Stripe::RequestParams
52
-
53
- end
51
+ class DeleteParams < Stripe::RequestParams; end
54
52
  class ListParams < Stripe::RequestParams
55
53
  # A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
56
54
  sig { returns(T.nilable(String)) }