stripe 15.3.0 → 15.4.0.pre.beta.2

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 (591) hide show
  1. checksums.yaml +4 -4
  2. data/API_VERSION +1 -1
  3. data/CHANGELOG.md +1603 -667
  4. data/README.md +1 -1
  5. data/VERSION +1 -1
  6. data/lib/stripe/api_requestor.rb +32 -0
  7. data/lib/stripe/api_version.rb +1 -2
  8. data/lib/stripe/errors.rb +60 -0
  9. data/lib/stripe/event_types.rb +102 -0
  10. data/lib/stripe/events/v2_core_account_closed_event.rb +21 -0
  11. data/lib/stripe/events/v2_core_account_created_event.rb +21 -0
  12. data/lib/stripe/events/v2_core_account_including_configuration_customer_capability_status_updated_event.rb +23 -0
  13. data/lib/stripe/events/v2_core_account_including_configuration_customer_updated_event.rb +21 -0
  14. data/lib/stripe/events/v2_core_account_including_configuration_merchant_capability_status_updated_event.rb +23 -0
  15. data/lib/stripe/events/v2_core_account_including_configuration_merchant_updated_event.rb +21 -0
  16. data/lib/stripe/events/v2_core_account_including_configuration_recipient_capability_status_updated_event.rb +23 -0
  17. data/lib/stripe/events/v2_core_account_including_configuration_recipient_updated_event.rb +21 -0
  18. data/lib/stripe/events/v2_core_account_including_configuration_storer_capability_status_updated_event.rb +23 -0
  19. data/lib/stripe/events/v2_core_account_including_configuration_storer_updated_event.rb +21 -0
  20. data/lib/stripe/events/v2_core_account_including_defaults_updated_event.rb +21 -0
  21. data/lib/stripe/events/v2_core_account_including_identity_updated_event.rb +21 -0
  22. data/lib/stripe/events/v2_core_account_including_requirements_updated_event.rb +21 -0
  23. data/lib/stripe/events/v2_core_account_link_completed_event.rb +13 -0
  24. data/lib/stripe/events/v2_core_account_person_created_event.rb +23 -0
  25. data/lib/stripe/events/v2_core_account_person_deleted_event.rb +23 -0
  26. data/lib/stripe/events/v2_core_account_person_updated_event.rb +23 -0
  27. data/lib/stripe/events/v2_core_account_updated_event.rb +21 -0
  28. data/lib/stripe/events/v2_money_management_adjustment_created_event.rb +21 -0
  29. data/lib/stripe/events/v2_money_management_financial_account_created_event.rb +21 -0
  30. data/lib/stripe/events/v2_money_management_financial_account_updated_event.rb +21 -0
  31. data/lib/stripe/events/v2_money_management_financial_address_activated_event.rb +21 -0
  32. data/lib/stripe/events/v2_money_management_financial_address_failed_event.rb +21 -0
  33. data/lib/stripe/events/v2_money_management_inbound_transfer_available_event.rb +23 -0
  34. data/lib/stripe/events/v2_money_management_inbound_transfer_bank_debit_failed_event.rb +21 -0
  35. data/lib/stripe/events/v2_money_management_inbound_transfer_bank_debit_processing_event.rb +21 -0
  36. data/lib/stripe/events/v2_money_management_inbound_transfer_bank_debit_queued_event.rb +21 -0
  37. data/lib/stripe/events/v2_money_management_inbound_transfer_bank_debit_returned_event.rb +21 -0
  38. data/lib/stripe/events/v2_money_management_inbound_transfer_bank_debit_succeeded_event.rb +21 -0
  39. data/lib/stripe/events/v2_money_management_outbound_payment_canceled_event.rb +21 -0
  40. data/lib/stripe/events/v2_money_management_outbound_payment_created_event.rb +21 -0
  41. data/lib/stripe/events/v2_money_management_outbound_payment_failed_event.rb +21 -0
  42. data/lib/stripe/events/v2_money_management_outbound_payment_posted_event.rb +21 -0
  43. data/lib/stripe/events/v2_money_management_outbound_payment_returned_event.rb +21 -0
  44. data/lib/stripe/events/v2_money_management_outbound_payment_updated_event.rb +21 -0
  45. data/lib/stripe/events/v2_money_management_outbound_transfer_canceled_event.rb +21 -0
  46. data/lib/stripe/events/v2_money_management_outbound_transfer_created_event.rb +21 -0
  47. data/lib/stripe/events/v2_money_management_outbound_transfer_failed_event.rb +21 -0
  48. data/lib/stripe/events/v2_money_management_outbound_transfer_posted_event.rb +21 -0
  49. data/lib/stripe/events/v2_money_management_outbound_transfer_returned_event.rb +21 -0
  50. data/lib/stripe/events/v2_money_management_outbound_transfer_updated_event.rb +21 -0
  51. data/lib/stripe/events/v2_money_management_received_credit_available_event.rb +23 -0
  52. data/lib/stripe/events/v2_money_management_received_credit_failed_event.rb +21 -0
  53. data/lib/stripe/events/v2_money_management_received_credit_returned_event.rb +21 -0
  54. data/lib/stripe/events/v2_money_management_received_credit_succeeded_event.rb +21 -0
  55. data/lib/stripe/events/v2_money_management_received_debit_canceled_event.rb +21 -0
  56. data/lib/stripe/events/v2_money_management_received_debit_failed_event.rb +21 -0
  57. data/lib/stripe/events/v2_money_management_received_debit_pending_event.rb +21 -0
  58. data/lib/stripe/events/v2_money_management_received_debit_succeeded_event.rb +21 -0
  59. data/lib/stripe/events/v2_money_management_received_debit_updated_event.rb +21 -0
  60. data/lib/stripe/events/v2_money_management_transaction_created_event.rb +21 -0
  61. data/lib/stripe/events/v2_money_management_transaction_updated_event.rb +21 -0
  62. data/lib/stripe/events/v2_off_session_payment_requires_capture_event.rb +21 -0
  63. data/lib/stripe/events/v2_payments_off_session_payment_authorization_attempt_failed_event.rb +21 -0
  64. data/lib/stripe/events/v2_payments_off_session_payment_authorization_attempt_started_event.rb +21 -0
  65. data/lib/stripe/events/v2_payments_off_session_payment_canceled_event.rb +21 -0
  66. data/lib/stripe/events/v2_payments_off_session_payment_created_event.rb +21 -0
  67. data/lib/stripe/events/v2_payments_off_session_payment_failed_event.rb +21 -0
  68. data/lib/stripe/events/v2_payments_off_session_payment_succeeded_event.rb +21 -0
  69. data/lib/stripe/object_types.rb +50 -0
  70. data/lib/stripe/resources/account.rb +653 -1
  71. data/lib/stripe/resources/account_notice.rb +123 -0
  72. data/lib/stripe/resources/account_session.rb +256 -1
  73. data/lib/stripe/resources/balance_settings.rb +105 -0
  74. data/lib/stripe/resources/billing/credit_balance_summary.rb +2 -0
  75. data/lib/stripe/resources/billing/credit_balance_transaction.rb +4 -0
  76. data/lib/stripe/resources/billing/credit_grant.rb +10 -0
  77. data/lib/stripe/resources/billing_portal/session.rb +6 -0
  78. data/lib/stripe/resources/capital/financing_offer.rb +179 -0
  79. data/lib/stripe/resources/capital/financing_summary.rb +55 -0
  80. data/lib/stripe/resources/capital/financing_transaction.rb +114 -0
  81. data/lib/stripe/resources/card.rb +2 -0
  82. data/lib/stripe/resources/cash_balance.rb +2 -0
  83. data/lib/stripe/resources/charge.rb +1538 -0
  84. data/lib/stripe/resources/checkout/session.rb +326 -2
  85. data/lib/stripe/resources/confirmation_token.rb +170 -0
  86. data/lib/stripe/resources/coupon.rb +30 -1
  87. data/lib/stripe/resources/credit_note.rb +6 -0
  88. data/lib/stripe/resources/credit_note_line_item.rb +9 -0
  89. data/lib/stripe/resources/customer.rb +2 -0
  90. data/lib/stripe/resources/customer_balance_transaction.rb +2 -0
  91. data/lib/stripe/resources/customer_cash_balance_transaction.rb +2 -0
  92. data/lib/stripe/resources/customer_session.rb +6 -1
  93. data/lib/stripe/resources/discount.rb +2 -0
  94. data/lib/stripe/resources/dispute.rb +2 -0
  95. data/lib/stripe/resources/event.rb +31 -0
  96. data/lib/stripe/resources/financial_connections/account.rb +22 -1
  97. data/lib/stripe/resources/financial_connections/account_inferred_balance.rb +27 -0
  98. data/lib/stripe/resources/financial_connections/institution.rb +92 -0
  99. data/lib/stripe/resources/financial_connections/session.rb +62 -2
  100. data/lib/stripe/resources/fx_quote.rb +184 -0
  101. data/lib/stripe/resources/identity/verification_session.rb +10 -0
  102. data/lib/stripe/resources/invoice.rb +1063 -16
  103. data/lib/stripe/resources/invoice_item.rb +78 -2
  104. data/lib/stripe/resources/invoice_line_item.rb +55 -1
  105. data/lib/stripe/resources/invoice_payment.rb +2 -53
  106. data/lib/stripe/resources/issuing/cardholder.rb +2 -1
  107. data/lib/stripe/resources/issuing/credit_underwriting_record.rb +602 -0
  108. data/lib/stripe/resources/issuing/dispute_settlement_detail.rb +82 -0
  109. data/lib/stripe/resources/issuing/fraud_liability_debit.rb +86 -0
  110. data/lib/stripe/resources/issuing/settlement.rb +53 -0
  111. data/lib/stripe/resources/issuing/transaction.rb +6 -0
  112. data/lib/stripe/resources/line_item.rb +37 -0
  113. data/lib/stripe/resources/mandate.rb +24 -0
  114. data/lib/stripe/resources/margin.rb +115 -0
  115. data/lib/stripe/resources/order.rb +2958 -0
  116. data/lib/stripe/resources/payment_attempt_record.rb +1099 -0
  117. data/lib/stripe/resources/payment_intent.rb +8540 -3584
  118. data/lib/stripe/resources/payment_intent_amount_details_line_item.rb +72 -0
  119. data/lib/stripe/resources/payment_method.rb +192 -1
  120. data/lib/stripe/resources/payment_method_configuration.rb +295 -0
  121. data/lib/stripe/resources/payment_record.rb +1628 -0
  122. data/lib/stripe/resources/payout.rb +6 -0
  123. data/lib/stripe/resources/price.rb +30 -0
  124. data/lib/stripe/resources/privacy/redaction_job.rb +298 -0
  125. data/lib/stripe/resources/privacy/redaction_job_validation_error.rb +33 -0
  126. data/lib/stripe/resources/promotion_code.rb +10 -0
  127. data/lib/stripe/resources/quote.rb +2038 -7
  128. data/lib/stripe/resources/quote_line.rb +274 -0
  129. data/lib/stripe/resources/quote_preview_invoice.rb +663 -0
  130. data/lib/stripe/resources/quote_preview_subscription_schedule.rb +371 -0
  131. data/lib/stripe/resources/refund.rb +9 -0
  132. data/lib/stripe/resources/setup_attempt.rb +21 -0
  133. data/lib/stripe/resources/setup_intent.rb +578 -9
  134. data/lib/stripe/resources/source.rb +29 -0
  135. data/lib/stripe/resources/subscription.rb +288 -9
  136. data/lib/stripe/resources/subscription_item.rb +84 -3
  137. data/lib/stripe/resources/subscription_schedule.rb +1007 -10
  138. data/lib/stripe/resources/tax/association.rb +66 -0
  139. data/lib/stripe/resources/tax/form.rb +211 -0
  140. data/lib/stripe/resources/tax_id.rb +12 -2
  141. data/lib/stripe/resources/terminal/reader.rb +8 -0
  142. data/lib/stripe/resources/terminal/reader_collected_data.rb +31 -0
  143. data/lib/stripe/resources/transfer.rb +6 -0
  144. data/lib/stripe/resources/treasury/financial_account.rb +22 -3
  145. data/lib/stripe/resources/treasury/financial_account_features.rb +2 -0
  146. data/lib/stripe/resources/treasury/outbound_transfer.rb +37 -0
  147. data/lib/stripe/resources/treasury/received_credit.rb +38 -1
  148. data/lib/stripe/resources/treasury/received_debit.rb +40 -1
  149. data/lib/stripe/resources/v2/core/account.rb +1919 -0
  150. data/lib/stripe/resources/v2/core/account_link.rb +56 -0
  151. data/lib/stripe/resources/v2/core/person.rb +276 -0
  152. data/lib/stripe/resources/v2/core/vault/gb_bank_account.rb +74 -0
  153. data/lib/stripe/resources/v2/core/vault/us_bank_account.rb +39 -0
  154. data/lib/stripe/resources/v2/financial_address_credit_simulation.rb +20 -0
  155. data/lib/stripe/resources/v2/financial_address_generated_microdeposits.rb +22 -0
  156. data/lib/stripe/resources/v2/money_management/adjustment.rb +51 -0
  157. data/lib/stripe/resources/v2/money_management/financial_account.rb +77 -0
  158. data/lib/stripe/resources/v2/money_management/financial_address.rb +68 -0
  159. data/lib/stripe/resources/v2/money_management/inbound_transfer.rb +94 -0
  160. data/lib/stripe/resources/v2/money_management/outbound_payment.rb +129 -0
  161. data/lib/stripe/resources/v2/money_management/outbound_payment_quote.rb +82 -0
  162. data/lib/stripe/resources/v2/money_management/outbound_setup_intent.rb +45 -0
  163. data/lib/stripe/resources/v2/money_management/outbound_transfer.rb +117 -0
  164. data/lib/stripe/resources/v2/money_management/payout_method.rb +75 -0
  165. data/lib/stripe/resources/v2/money_management/payout_methods_bank_account_spec.rb +49 -0
  166. data/lib/stripe/resources/v2/money_management/received_credit.rb +122 -0
  167. data/lib/stripe/resources/v2/money_management/received_debit.rb +84 -0
  168. data/lib/stripe/resources/v2/money_management/transaction.rb +78 -0
  169. data/lib/stripe/resources/v2/money_management/transaction_entry.rb +68 -0
  170. data/lib/stripe/resources/v2/payments/off_session_payment.rb +72 -0
  171. data/lib/stripe/resources.rb +106 -0
  172. data/lib/stripe/services/account_notice_service.rb +101 -0
  173. data/lib/stripe/services/account_service.rb +562 -1
  174. data/lib/stripe/services/account_session_service.rb +226 -1
  175. data/lib/stripe/services/balance_settings_service.rb +96 -0
  176. data/lib/stripe/services/billing/credit_balance_summary_service.rb +4 -1
  177. data/lib/stripe/services/billing/credit_balance_transaction_service.rb +4 -0
  178. data/lib/stripe/services/billing/credit_grant_service.rb +8 -0
  179. data/lib/stripe/services/billing_portal/session_service.rb +4 -0
  180. data/lib/stripe/services/capital/financing_offer_service.rb +112 -0
  181. data/lib/stripe/services/capital/financing_summary_service.rb +28 -0
  182. data/lib/stripe/services/capital/financing_transaction_service.rb +79 -0
  183. data/lib/stripe/services/capital_service.rb +15 -0
  184. data/lib/stripe/services/charge_service.rb +1418 -0
  185. data/lib/stripe/services/checkout/session_service.rb +243 -2
  186. data/lib/stripe/services/coupon_service.rb +17 -1
  187. data/lib/stripe/services/credit_note_service.rb +4 -0
  188. data/lib/stripe/services/customer_session_service.rb +4 -1
  189. data/{rbi/stripe/services/account_external_account_service.rbi → lib/stripe/services/external_account_service.rb} +135 -122
  190. data/{rbi/stripe/services/tax/transaction_line_item_service.rbi → lib/stripe/services/financial_connections/account_inferred_balance_service.rb} +21 -17
  191. data/lib/stripe/services/financial_connections/account_service.rb +7 -2
  192. data/{rbi/stripe/services/climate/supplier_service.rbi → lib/stripe/services/financial_connections/institution_service.rb} +36 -25
  193. data/lib/stripe/services/financial_connections/session_service.rb +34 -2
  194. data/lib/stripe/services/financial_connections_service.rb +2 -1
  195. data/lib/stripe/services/fx_quote_service.rb +123 -0
  196. data/lib/stripe/services/identity/verification_session_service.rb +8 -0
  197. data/lib/stripe/services/invoice_item_service.rb +74 -2
  198. data/lib/stripe/services/invoice_line_item_service.rb +33 -1
  199. data/lib/stripe/services/invoice_service.rb +1014 -16
  200. data/lib/stripe/services/issuing/cardholder_service.rb +2 -1
  201. data/lib/stripe/services/issuing/credit_underwriting_record_service.rb +504 -0
  202. data/lib/stripe/services/issuing/dispute_settlement_detail_service.rb +66 -0
  203. data/lib/stripe/services/issuing/fraud_liability_debit_service.rb +83 -0
  204. data/lib/stripe/services/issuing/transaction_service.rb +4 -0
  205. data/lib/stripe/services/issuing_service.rb +5 -1
  206. data/lib/stripe/services/margin_service.rb +119 -0
  207. data/{rbi/stripe/services/source_transaction_service.rbi → lib/stripe/services/order_line_item_service.rb} +20 -16
  208. data/lib/stripe/services/order_service.rb +2388 -0
  209. data/lib/stripe/services/payment_attempt_record_service.rb +49 -0
  210. data/{rbi/stripe/services/quote_line_item_service.rbi → lib/stripe/services/payment_intent_amount_details_line_item_service.rb} +20 -16
  211. data/lib/stripe/services/payment_intent_service.rb +4879 -391
  212. data/lib/stripe/services/payment_method_configuration_service.rb +210 -0
  213. data/lib/stripe/services/payment_method_service.rb +120 -1
  214. data/lib/stripe/services/payment_record_service.rb +542 -0
  215. data/lib/stripe/services/payout_service.rb +4 -0
  216. data/lib/stripe/services/price_service.rb +19 -0
  217. data/lib/stripe/services/privacy/redaction_job_service.rb +240 -0
  218. data/{rbi/stripe/services/tax/calculation_line_item_service.rbi → lib/stripe/services/privacy/redaction_job_validation_error_service.rb} +21 -17
  219. data/lib/stripe/services/privacy_service.rb +13 -0
  220. data/lib/stripe/services/promotion_code_service.rb +8 -0
  221. data/{rbi/stripe/services/credit_note_line_item_service.rbi → lib/stripe/services/quote_line_service.rb} +20 -16
  222. data/{rbi/stripe/services/payment_link_line_item_service.rbi → lib/stripe/services/quote_preview_invoice_service.rb} +20 -16
  223. data/lib/stripe/services/quote_preview_subscription_schedule_service.rb +35 -0
  224. data/lib/stripe/services/quote_service.rb +1723 -8
  225. data/lib/stripe/services/setup_intent_service.rb +538 -9
  226. data/lib/stripe/services/subscription_item_service.rb +75 -3
  227. data/lib/stripe/services/subscription_schedule_service.rb +911 -10
  228. data/lib/stripe/services/subscription_service.rb +249 -9
  229. data/lib/stripe/services/tax/association_service.rb +31 -0
  230. data/lib/stripe/services/tax/form_service.rb +100 -0
  231. data/lib/stripe/services/tax_id_service.rb +8 -2
  232. data/lib/stripe/services/tax_service.rb +3 -1
  233. data/lib/stripe/services/terminal/reader_collected_data_service.rb +28 -0
  234. data/lib/stripe/services/terminal_service.rb +2 -1
  235. data/lib/stripe/services/test_helpers/confirmation_token_service.rb +97 -0
  236. data/lib/stripe/services/test_helpers/treasury/received_credit_service.rb +25 -1
  237. data/lib/stripe/services/test_helpers/treasury/received_debit_service.rb +25 -1
  238. data/lib/stripe/services/transfer_service.rb +4 -0
  239. data/lib/stripe/services/treasury/financial_account_features_service.rb +4 -1
  240. data/lib/stripe/services/treasury/financial_account_service.rb +16 -2
  241. data/lib/stripe/services/treasury/outbound_transfer_service.rb +24 -0
  242. data/lib/stripe/services/v1_services.rb +11 -2
  243. data/lib/stripe/services/v2/core/account_link_service.rb +76 -0
  244. data/lib/stripe/services/v2/core/account_service.rb +4486 -0
  245. data/lib/stripe/services/v2/core/accounts/person_service.rb +1045 -0
  246. data/lib/stripe/services/v2/core/vault/gb_bank_account_service.rb +130 -0
  247. data/lib/stripe/services/v2/core/vault/us_bank_account_service.rb +107 -0
  248. data/lib/stripe/services/v2/core/vault_service.rb +18 -0
  249. data/lib/stripe/services/v2/core_service.rb +4 -1
  250. data/lib/stripe/services/v2/money_management/adjustment_service.rb +74 -0
  251. data/lib/stripe/services/v2/money_management/financial_account_service.rb +116 -0
  252. data/lib/stripe/services/v2/money_management/financial_address_service.rb +82 -0
  253. data/lib/stripe/services/v2/money_management/inbound_transfer_service.rb +125 -0
  254. data/lib/stripe/services/v2/money_management/outbound_payment_quote_service.rb +95 -0
  255. data/lib/stripe/services/v2/money_management/outbound_payment_service.rb +199 -0
  256. data/lib/stripe/services/v2/money_management/outbound_setup_intent_service.rb +235 -0
  257. data/lib/stripe/services/v2/money_management/outbound_transfer_service.rb +172 -0
  258. data/lib/stripe/services/v2/money_management/payout_method_service.rb +90 -0
  259. data/lib/stripe/services/v2/money_management/payout_methods_bank_account_spec_service.rb +32 -0
  260. data/lib/stripe/services/v2/money_management/received_credit_service.rb +70 -0
  261. data/lib/stripe/services/v2/money_management/received_debit_service.rb +43 -0
  262. data/lib/stripe/services/v2/money_management/transaction_entry_service.rb +69 -0
  263. data/lib/stripe/services/v2/money_management/transaction_service.rb +73 -0
  264. data/lib/stripe/services/v2/money_management_service.rb +31 -0
  265. data/lib/stripe/services/v2/payment_service.rb +15 -0
  266. data/lib/stripe/services/v2/payments/off_session_payment_service.rb +137 -0
  267. data/lib/stripe/services/v2/test_helper_service.rb +15 -0
  268. data/lib/stripe/services/v2/test_helpers/financial_address_service.rb +49 -0
  269. data/lib/stripe/services/v2_services.rb +4 -1
  270. data/lib/stripe/services.rb +53 -1
  271. data/lib/stripe/stripe_configuration.rb +3 -1
  272. data/lib/stripe/stripe_object.rb +1 -1
  273. data/lib/stripe/util.rb +7 -1
  274. data/lib/stripe/version.rb +1 -1
  275. data/lib/stripe.rb +53 -0
  276. data/rbi/stripe.rbi +194513 -0
  277. data/stripe.gemspec +4 -1
  278. metadata +164 -325
  279. data/lib/stripe/services/invoice_payment_service.rb +0 -83
  280. data/rbi/stripe/resources/account.rbi +0 -4995
  281. data/rbi/stripe/resources/account_link.rbi +0 -74
  282. data/rbi/stripe/resources/account_session.rbi +0 -1013
  283. data/rbi/stripe/resources/apple_pay_domain.rbi +0 -88
  284. data/rbi/stripe/resources/application.rbi +0 -20
  285. data/rbi/stripe/resources/application_fee.rbi +0 -118
  286. data/rbi/stripe/resources/application_fee_refund.rbi +0 -37
  287. data/rbi/stripe/resources/apps/secret.rbi +0 -195
  288. data/rbi/stripe/resources/balance.rbi +0 -235
  289. data/rbi/stripe/resources/balance_transaction.rbi +0 -147
  290. data/rbi/stripe/resources/bank_account.rbi +0 -127
  291. data/rbi/stripe/resources/billing/alert.rbi +0 -201
  292. data/rbi/stripe/resources/billing/alert_triggered.rbi +0 -28
  293. data/rbi/stripe/resources/billing/credit_balance_summary.rbi +0 -63
  294. data/rbi/stripe/resources/billing/credit_balance_transaction.rbi +0 -147
  295. data/rbi/stripe/resources/billing/credit_grant.rbi +0 -291
  296. data/rbi/stripe/resources/billing/meter.rbi +0 -226
  297. data/rbi/stripe/resources/billing/meter_event.rbi +0 -64
  298. data/rbi/stripe/resources/billing/meter_event_adjustment.rbi +0 -64
  299. data/rbi/stripe/resources/billing/meter_event_summary.rbi +0 -35
  300. data/rbi/stripe/resources/billing_portal/configuration.rbi +0 -645
  301. data/rbi/stripe/resources/billing_portal/session.rbi +0 -345
  302. data/rbi/stripe/resources/capability.rbi +0 -125
  303. data/rbi/stripe/resources/card.rbi +0 -125
  304. data/rbi/stripe/resources/cash_balance.rbi +0 -32
  305. data/rbi/stripe/resources/charge.rbi +0 -2086
  306. data/rbi/stripe/resources/checkout/session.rbi +0 -4060
  307. data/rbi/stripe/resources/climate/order.rbi +0 -245
  308. data/rbi/stripe/resources/climate/product.rbi +0 -75
  309. data/rbi/stripe/resources/climate/supplier.rbi +0 -72
  310. data/rbi/stripe/resources/confirmation_token.rbi +0 -1818
  311. data/rbi/stripe/resources/connect_collection_transfer.rbi +0 -26
  312. data/rbi/stripe/resources/country_spec.rbi +0 -85
  313. data/rbi/stripe/resources/coupon.rbi +0 -250
  314. data/rbi/stripe/resources/credit_note.rbi +0 -752
  315. data/rbi/stripe/resources/credit_note_line_item.rbi +0 -101
  316. data/rbi/stripe/resources/customer.rbi +0 -1005
  317. data/rbi/stripe/resources/customer_balance_transaction.rbi +0 -56
  318. data/rbi/stripe/resources/customer_cash_balance_transaction.rbi +0 -151
  319. data/rbi/stripe/resources/customer_session.rbi +0 -200
  320. data/rbi/stripe/resources/discount.rbi +0 -53
  321. data/rbi/stripe/resources/dispute.rbi +0 -761
  322. data/rbi/stripe/resources/entitlements/active_entitlement.rbi +0 -58
  323. data/rbi/stripe/resources/entitlements/active_entitlement_summary.rbi +0 -23
  324. data/rbi/stripe/resources/entitlements/feature.rbi +0 -117
  325. data/rbi/stripe/resources/ephemeral_key.rbi +0 -44
  326. data/rbi/stripe/resources/event.rbi +0 -149
  327. data/rbi/stripe/resources/exchange_rate.rbi +0 -66
  328. data/rbi/stripe/resources/file.rbi +0 -143
  329. data/rbi/stripe/resources/file_link.rbi +0 -141
  330. data/rbi/stripe/resources/financial_connections/account.rbi +0 -339
  331. data/rbi/stripe/resources/financial_connections/account_owner.rbi +0 -35
  332. data/rbi/stripe/resources/financial_connections/account_ownership.rbi +0 -23
  333. data/rbi/stripe/resources/financial_connections/session.rbi +0 -123
  334. data/rbi/stripe/resources/financial_connections/transaction.rbi +0 -124
  335. data/rbi/stripe/resources/forwarding/request.rbi +0 -216
  336. data/rbi/stripe/resources/funding_instructions.rbi +0 -437
  337. data/rbi/stripe/resources/identity/verification_report.rbi +0 -360
  338. data/rbi/stripe/resources/identity/verification_session.rbi +0 -564
  339. data/rbi/stripe/resources/invoice.rbi +0 -3842
  340. data/rbi/stripe/resources/invoice_item.rbi +0 -470
  341. data/rbi/stripe/resources/invoice_line_item.rbi +0 -432
  342. data/rbi/stripe/resources/invoice_payment.rbi +0 -121
  343. data/rbi/stripe/resources/invoice_rendering_template.rbi +0 -104
  344. data/rbi/stripe/resources/issuing/authorization.rbi +0 -1283
  345. data/rbi/stripe/resources/issuing/card.rbi +0 -741
  346. data/rbi/stripe/resources/issuing/cardholder.rbi +0 -744
  347. data/rbi/stripe/resources/issuing/dispute.rbi +0 -913
  348. data/rbi/stripe/resources/issuing/personalization_design.rbi +0 -338
  349. data/rbi/stripe/resources/issuing/physical_bundle.rbi +0 -79
  350. data/rbi/stripe/resources/issuing/token.rbi +0 -226
  351. data/rbi/stripe/resources/issuing/transaction.rbi +0 -1061
  352. data/rbi/stripe/resources/line_item.rbi +0 -72
  353. data/rbi/stripe/resources/login_link.rbi +0 -19
  354. data/rbi/stripe/resources/mandate.rbi +0 -191
  355. data/rbi/stripe/resources/payment_intent.rbi +0 -9987
  356. data/rbi/stripe/resources/payment_link.rbi +0 -1801
  357. data/rbi/stripe/resources/payment_method.rbi +0 -1770
  358. data/rbi/stripe/resources/payment_method_configuration.rbi +0 -3550
  359. data/rbi/stripe/resources/payment_method_domain.rbi +0 -228
  360. data/rbi/stripe/resources/payout.rbi +0 -300
  361. data/rbi/stripe/resources/person.rbi +0 -401
  362. data/rbi/stripe/resources/plan.rbi +0 -371
  363. data/rbi/stripe/resources/price.rbi +0 -694
  364. data/rbi/stripe/resources/product.rbi +0 -555
  365. data/rbi/stripe/resources/product_feature.rbi +0 -26
  366. data/rbi/stripe/resources/promotion_code.rbi +0 -261
  367. data/rbi/stripe/resources/quote.rbi +0 -1145
  368. data/rbi/stripe/resources/radar/early_fraud_warning.rbi +0 -98
  369. data/rbi/stripe/resources/radar/value_list.rbi +0 -168
  370. data/rbi/stripe/resources/radar/value_list_item.rbi +0 -129
  371. data/rbi/stripe/resources/refund.rbi +0 -523
  372. data/rbi/stripe/resources/reporting/report_run.rbi +0 -191
  373. data/rbi/stripe/resources/reporting/report_type.rbi +0 -57
  374. data/rbi/stripe/resources/reserve_transaction.rbi +0 -23
  375. data/rbi/stripe/resources/reversal.rbi +0 -51
  376. data/rbi/stripe/resources/review.rbi +0 -154
  377. data/rbi/stripe/resources/setup_attempt.rbi +0 -477
  378. data/rbi/stripe/resources/setup_intent.rbi +0 -3978
  379. data/rbi/stripe/resources/shipping_rate.rbi +0 -305
  380. data/rbi/stripe/resources/sigma/scheduled_query_run.rbi +0 -75
  381. data/rbi/stripe/resources/source.rbi +0 -1496
  382. data/rbi/stripe/resources/source_mandate_notification.rbi +0 -77
  383. data/rbi/stripe/resources/source_transaction.rbi +0 -127
  384. data/rbi/stripe/resources/subscription.rbi +0 -2080
  385. data/rbi/stripe/resources/subscription_item.rbi +0 -404
  386. data/rbi/stripe/resources/subscription_schedule.rbi +0 -1645
  387. data/rbi/stripe/resources/tax/calculation.rbi +0 -478
  388. data/rbi/stripe/resources/tax/calculation_line_item.rbi +0 -91
  389. data/rbi/stripe/resources/tax/registration.rbi +0 -2732
  390. data/rbi/stripe/resources/tax/settings.rbi +0 -141
  391. data/rbi/stripe/resources/tax/transaction.rbi +0 -351
  392. data/rbi/stripe/resources/tax/transaction_line_item.rbi +0 -54
  393. data/rbi/stripe/resources/tax_code.rbi +0 -44
  394. data/rbi/stripe/resources/tax_deducted_at_source.rbi +0 -23
  395. data/rbi/stripe/resources/tax_id.rbi +0 -165
  396. data/rbi/stripe/resources/tax_rate.rbi +0 -239
  397. data/rbi/stripe/resources/terminal/configuration.rbi +0 -1387
  398. data/rbi/stripe/resources/terminal/connection_token.rbi +0 -37
  399. data/rbi/stripe/resources/terminal/location.rbi +0 -222
  400. data/rbi/stripe/resources/terminal/reader.rbi +0 -994
  401. data/rbi/stripe/resources/test_helpers/test_clock.rbi +0 -132
  402. data/rbi/stripe/resources/token.rbi +0 -1283
  403. data/rbi/stripe/resources/topup.rbi +0 -222
  404. data/rbi/stripe/resources/transfer.rbi +0 -199
  405. data/rbi/stripe/resources/treasury/credit_reversal.rbi +0 -119
  406. data/rbi/stripe/resources/treasury/debit_reversal.rbi +0 -131
  407. data/rbi/stripe/resources/treasury/financial_account.rbi +0 -869
  408. data/rbi/stripe/resources/treasury/financial_account_features.rbi +0 -260
  409. data/rbi/stripe/resources/treasury/inbound_transfer.rbi +0 -295
  410. data/rbi/stripe/resources/treasury/outbound_payment.rbi +0 -592
  411. data/rbi/stripe/resources/treasury/outbound_transfer.rbi +0 -431
  412. data/rbi/stripe/resources/treasury/received_credit.rbi +0 -302
  413. data/rbi/stripe/resources/treasury/received_debit.rbi +0 -256
  414. data/rbi/stripe/resources/treasury/transaction.rbi +0 -215
  415. data/rbi/stripe/resources/treasury/transaction_entry.rbi +0 -192
  416. data/rbi/stripe/resources/v2/amount.rbi +0 -14
  417. data/rbi/stripe/resources/v2/billing/meter_event.rbi +0 -37
  418. data/rbi/stripe/resources/v2/billing/meter_event_adjustment.rbi +0 -41
  419. data/rbi/stripe/resources/v2/billing/meter_event_session.rbi +0 -31
  420. data/rbi/stripe/resources/v2/event.rbi +0 -48
  421. data/rbi/stripe/resources/v2/event_destination.rbi +0 -91
  422. data/rbi/stripe/resources/webhook_endpoint.rbi +0 -168
  423. data/rbi/stripe/services/account_capability_service.rbi +0 -51
  424. data/rbi/stripe/services/account_link_service.rbi +0 -58
  425. data/rbi/stripe/services/account_login_link_service.rbi +0 -22
  426. data/rbi/stripe/services/account_person_service.rbi +0 -1011
  427. data/rbi/stripe/services/account_service.rbi +0 -4281
  428. data/rbi/stripe/services/account_session_service.rbi +0 -646
  429. data/rbi/stripe/services/apple_pay_domain_service.rbi +0 -76
  430. data/rbi/stripe/services/application_fee_refund_service.rbi +0 -93
  431. data/rbi/stripe/services/application_fee_service.rbi +0 -78
  432. data/rbi/stripe/services/apps/secret_service.rbi +0 -151
  433. data/rbi/stripe/services/apps_service.rbi +0 -9
  434. data/rbi/stripe/services/balance_service.rbi +0 -21
  435. data/rbi/stripe/services/balance_transaction_service.rbi +0 -93
  436. data/rbi/stripe/services/billing/alert_service.rbi +0 -152
  437. data/rbi/stripe/services/billing/credit_balance_summary_service.rbi +0 -68
  438. data/rbi/stripe/services/billing/credit_balance_transaction_service.rbi +0 -59
  439. data/rbi/stripe/services/billing/credit_grant_service.rbi +0 -211
  440. data/rbi/stripe/services/billing/meter_event_adjustment_service.rbi +0 -42
  441. data/rbi/stripe/services/billing/meter_event_service.rbi +0 -42
  442. data/rbi/stripe/services/billing/meter_event_summary_service.rbi +0 -54
  443. data/rbi/stripe/services/billing/meter_service.rbi +0 -163
  444. data/rbi/stripe/services/billing_portal/configuration_service.rbi +0 -511
  445. data/rbi/stripe/services/billing_portal/session_service.rbi +0 -204
  446. data/rbi/stripe/services/billing_portal_service.rbi +0 -10
  447. data/rbi/stripe/services/billing_service.rbi +0 -15
  448. data/rbi/stripe/services/charge_service.rbi +0 -448
  449. data/rbi/stripe/services/checkout/session_line_item_service.rbi +0 -33
  450. data/rbi/stripe/services/checkout/session_service.rbi +0 -2670
  451. data/rbi/stripe/services/checkout_service.rbi +0 -9
  452. data/rbi/stripe/services/climate/order_service.rbi +0 -142
  453. data/rbi/stripe/services/climate/product_service.rbi +0 -46
  454. data/rbi/stripe/services/climate_service.rbi +0 -11
  455. data/rbi/stripe/services/confirmation_token_service.rbi +0 -20
  456. data/rbi/stripe/services/country_spec_service.rbi +0 -44
  457. data/rbi/stripe/services/coupon_service.rbi +0 -194
  458. data/rbi/stripe/services/credit_note_preview_lines_service.rbi +0 -167
  459. data/rbi/stripe/services/credit_note_service.rbi +0 -415
  460. data/rbi/stripe/services/customer_balance_transaction_service.rbi +0 -92
  461. data/rbi/stripe/services/customer_cash_balance_service.rbi +0 -45
  462. data/rbi/stripe/services/customer_cash_balance_transaction_service.rbi +0 -44
  463. data/rbi/stripe/services/customer_funding_instructions_service.rbi +0 -59
  464. data/rbi/stripe/services/customer_payment_method_service.rbi +0 -57
  465. data/rbi/stripe/services/customer_payment_source_service.rbi +0 -232
  466. data/rbi/stripe/services/customer_service.rbi +0 -647
  467. data/rbi/stripe/services/customer_session_service.rbi +0 -116
  468. data/rbi/stripe/services/customer_tax_id_service.rbi +0 -70
  469. data/rbi/stripe/services/dispute_service.rbi +0 -424
  470. data/rbi/stripe/services/entitlements/active_entitlement_service.rbi +0 -55
  471. data/rbi/stripe/services/entitlements/feature_service.rbi +0 -107
  472. data/rbi/stripe/services/entitlements_service.rbi +0 -10
  473. data/rbi/stripe/services/ephemeral_key_service.rbi +0 -53
  474. data/rbi/stripe/services/event_service.rbi +0 -83
  475. data/rbi/stripe/services/exchange_rate_service.rbi +0 -44
  476. data/rbi/stripe/services/file_link_service.rbi +0 -124
  477. data/rbi/stripe/services/file_service.rbi +0 -116
  478. data/rbi/stripe/services/financial_connections/account_owner_service.rbi +0 -42
  479. data/rbi/stripe/services/financial_connections/account_service.rbi +0 -133
  480. data/rbi/stripe/services/financial_connections/session_service.rbi +0 -88
  481. data/rbi/stripe/services/financial_connections/transaction_service.rbi +0 -92
  482. data/rbi/stripe/services/financial_connections_service.rbi +0 -11
  483. data/rbi/stripe/services/forwarding/request_service.rbi +0 -134
  484. data/rbi/stripe/services/forwarding_service.rbi +0 -9
  485. data/rbi/stripe/services/identity/verification_report_service.rbi +0 -87
  486. data/rbi/stripe/services/identity/verification_session_service.rbi +0 -339
  487. data/rbi/stripe/services/identity_service.rbi +0 -10
  488. data/rbi/stripe/services/invoice_item_service.rbi +0 -366
  489. data/rbi/stripe/services/invoice_line_item_service.rbi +0 -259
  490. data/rbi/stripe/services/invoice_payment_service.rbi +0 -71
  491. data/rbi/stripe/services/invoice_rendering_template_service.rbi +0 -82
  492. data/rbi/stripe/services/invoice_service.rbi +0 -3011
  493. data/rbi/stripe/services/issuing/authorization_service.rbi +0 -146
  494. data/rbi/stripe/services/issuing/card_service.rbi +0 -495
  495. data/rbi/stripe/services/issuing/cardholder_service.rbi +0 -587
  496. data/rbi/stripe/services/issuing/dispute_service.rbi +0 -707
  497. data/rbi/stripe/services/issuing/personalization_design_service.rbi +0 -243
  498. data/rbi/stripe/services/issuing/physical_bundle_service.rbi +0 -59
  499. data/rbi/stripe/services/issuing/token_service.rbi +0 -99
  500. data/rbi/stripe/services/issuing/transaction_service.rbi +0 -105
  501. data/rbi/stripe/services/issuing_service.rbi +0 -16
  502. data/rbi/stripe/services/mandate_service.rbi +0 -20
  503. data/rbi/stripe/services/payment_intent_service.rbi +0 -7989
  504. data/rbi/stripe/services/payment_link_service.rbi +0 -1352
  505. data/rbi/stripe/services/payment_method_configuration_service.rbi +0 -2487
  506. data/rbi/stripe/services/payment_method_domain_service.rbi +0 -112
  507. data/rbi/stripe/services/payment_method_service.rbi +0 -781
  508. data/rbi/stripe/services/payout_service.rbi +0 -205
  509. data/rbi/stripe/services/plan_service.rbi +0 -282
  510. data/rbi/stripe/services/price_service.rbi +0 -546
  511. data/rbi/stripe/services/product_feature_service.rbi +0 -67
  512. data/rbi/stripe/services/product_service.rbi +0 -477
  513. data/rbi/stripe/services/promotion_code_service.rbi +0 -214
  514. data/rbi/stripe/services/quote_computed_upfront_line_items_service.rbi +0 -31
  515. data/rbi/stripe/services/quote_service.rbi +0 -699
  516. data/rbi/stripe/services/radar/early_fraud_warning_service.rbi +0 -85
  517. data/rbi/stripe/services/radar/value_list_item_service.rbi +0 -109
  518. data/rbi/stripe/services/radar/value_list_service.rbi +0 -141
  519. data/rbi/stripe/services/radar_service.rbi +0 -11
  520. data/rbi/stripe/services/refund_service.rbi +0 -185
  521. data/rbi/stripe/services/reporting/report_run_service.rbi +0 -135
  522. data/rbi/stripe/services/reporting/report_type_service.rbi +0 -35
  523. data/rbi/stripe/services/reporting_service.rbi +0 -10
  524. data/rbi/stripe/services/review_service.rbi +0 -84
  525. data/rbi/stripe/services/setup_attempt_service.rbi +0 -65
  526. data/rbi/stripe/services/setup_intent_service.rbi +0 -3709
  527. data/rbi/stripe/services/shipping_rate_service.rbi +0 -241
  528. data/rbi/stripe/services/sigma/scheduled_query_run_service.rbi +0 -46
  529. data/rbi/stripe/services/sigma_service.rbi +0 -9
  530. data/rbi/stripe/services/source_service.rbi +0 -663
  531. data/rbi/stripe/services/subscription_item_service.rbi +0 -350
  532. data/rbi/stripe/services/subscription_schedule_service.rbi +0 -1301
  533. data/rbi/stripe/services/subscription_service.rbi +0 -1684
  534. data/rbi/stripe/services/tax/calculation_service.rbi +0 -234
  535. data/rbi/stripe/services/tax/registration_service.rbi +0 -1858
  536. data/rbi/stripe/services/tax/settings_service.rbi +0 -93
  537. data/rbi/stripe/services/tax/transaction_service.rbi +0 -146
  538. data/rbi/stripe/services/tax_code_service.rbi +0 -44
  539. data/rbi/stripe/services/tax_id_service.rbi +0 -110
  540. data/rbi/stripe/services/tax_rate_service.rbi +0 -185
  541. data/rbi/stripe/services/tax_service.rbi +0 -12
  542. data/rbi/stripe/services/terminal/configuration_service.rbi +0 -1118
  543. data/rbi/stripe/services/terminal/connection_token_service.rbi +0 -25
  544. data/rbi/stripe/services/terminal/location_service.rbi +0 -182
  545. data/rbi/stripe/services/terminal/reader_service.rbi +0 -540
  546. data/rbi/stripe/services/terminal_service.rbi +0 -12
  547. data/rbi/stripe/services/test_helpers/confirmation_token_service.rbi +0 -746
  548. data/rbi/stripe/services/test_helpers/customer_service.rbi +0 -33
  549. data/rbi/stripe/services/test_helpers/issuing/authorization_service.rbi +0 -848
  550. data/rbi/stripe/services/test_helpers/issuing/card_service.rbi +0 -76
  551. data/rbi/stripe/services/test_helpers/issuing/personalization_design_service.rbi +0 -69
  552. data/rbi/stripe/services/test_helpers/issuing/transaction_service.rbi +0 -711
  553. data/rbi/stripe/services/test_helpers/issuing_service.rbi +0 -14
  554. data/rbi/stripe/services/test_helpers/refund_service.rbi +0 -22
  555. data/rbi/stripe/services/test_helpers/terminal/reader_service.rbi +0 -93
  556. data/rbi/stripe/services/test_helpers/terminal_service.rbi +0 -11
  557. data/rbi/stripe/services/test_helpers/test_clock_service.rbi +0 -90
  558. data/rbi/stripe/services/test_helpers/treasury/inbound_transfer_service.rbi +0 -64
  559. data/rbi/stripe/services/test_helpers/treasury/outbound_payment_service.rbi +0 -125
  560. data/rbi/stripe/services/test_helpers/treasury/outbound_transfer_service.rbi +0 -125
  561. data/rbi/stripe/services/test_helpers/treasury/received_credit_service.rbi +0 -87
  562. data/rbi/stripe/services/test_helpers/treasury/received_debit_service.rbi +0 -87
  563. data/rbi/stripe/services/test_helpers/treasury_service.rbi +0 -15
  564. data/rbi/stripe/services/test_helpers_service.rbi +0 -15
  565. data/rbi/stripe/services/token_service.rbi +0 -1257
  566. data/rbi/stripe/services/topup_service.rbi +0 -176
  567. data/rbi/stripe/services/transfer_reversal_service.rbi +0 -101
  568. data/rbi/stripe/services/transfer_service.rbi +0 -152
  569. data/rbi/stripe/services/treasury/credit_reversal_service.rbi +0 -84
  570. data/rbi/stripe/services/treasury/debit_reversal_service.rbi +0 -88
  571. data/rbi/stripe/services/treasury/financial_account_features_service.rbi +0 -198
  572. data/rbi/stripe/services/treasury/financial_account_service.rbi +0 -566
  573. data/rbi/stripe/services/treasury/inbound_transfer_service.rbi +0 -117
  574. data/rbi/stripe/services/treasury/outbound_payment_service.rbi +0 -304
  575. data/rbi/stripe/services/treasury/outbound_transfer_service.rbi +0 -157
  576. data/rbi/stripe/services/treasury/received_credit_service.rbi +0 -72
  577. data/rbi/stripe/services/treasury/received_debit_service.rbi +0 -59
  578. data/rbi/stripe/services/treasury/transaction_entry_service.rbi +0 -111
  579. data/rbi/stripe/services/treasury/transaction_service.rbi +0 -122
  580. data/rbi/stripe/services/treasury_service.rbi +0 -18
  581. data/rbi/stripe/services/v1_services.rbi +0 -77
  582. data/rbi/stripe/services/v2/billing/meter_event_adjustment_service.rbi +0 -39
  583. data/rbi/stripe/services/v2/billing/meter_event_service.rbi +0 -42
  584. data/rbi/stripe/services/v2/billing/meter_event_session_service.rbi +0 -18
  585. data/rbi/stripe/services/v2/billing/meter_event_stream_service.rbi +0 -55
  586. data/rbi/stripe/services/v2/billing_service.rbi +0 -14
  587. data/rbi/stripe/services/v2/core/event_destination_service.rbi +0 -192
  588. data/rbi/stripe/services/v2/core/event_service.rbi +0 -36
  589. data/rbi/stripe/services/v2/core_service.rbi +0 -12
  590. data/rbi/stripe/services/v2_services.rbi +0 -10
  591. data/rbi/stripe/services/webhook_endpoint_service.rbi +0 -129
@@ -1,994 +0,0 @@
1
- # File generated from our OpenAPI spec
2
- # frozen_string_literal: true
3
-
4
- # typed: true
5
- module Stripe
6
- module Terminal
7
- # A Reader represents a physical device for accepting payment details.
8
- #
9
- # Related guide: [Connecting to a reader](https://stripe.com/docs/terminal/payments/connect-reader)
10
- class Reader < APIResource
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
174
- class ProcessPaymentIntent < Stripe::StripeObject
175
- class ProcessConfig < Stripe::StripeObject
176
- class Tipping < Stripe::StripeObject
177
- # 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).
178
- sig { returns(Integer) }
179
- attr_reader :amount_eligible
180
- end
181
- # Enable customer-initiated cancellation when processing this payment.
182
- sig { returns(T::Boolean) }
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
187
- # Override showing a tipping selection screen on this transaction.
188
- sig { returns(T::Boolean) }
189
- attr_reader :skip_tipping
190
- # Represents a per-transaction tipping configuration
191
- sig { returns(Tipping) }
192
- attr_reader :tipping
193
- end
194
- # Most recent PaymentIntent processed by the reader.
195
- sig { returns(T.any(String, Stripe::PaymentIntent)) }
196
- attr_reader :payment_intent
197
- # Represents a per-transaction override of a reader configuration
198
- sig { returns(ProcessConfig) }
199
- attr_reader :process_config
200
- end
201
- class ProcessSetupIntent < Stripe::StripeObject
202
- class ProcessConfig < Stripe::StripeObject
203
- # Enable customer-initiated cancellation when processing this SetupIntent.
204
- sig { returns(T::Boolean) }
205
- attr_reader :enable_customer_cancellation
206
- end
207
- # ID of a card PaymentMethod generated from the card_present PaymentMethod that may be attached to a Customer for future transactions. Only present if it was possible to generate a card PaymentMethod.
208
- sig { returns(String) }
209
- attr_reader :generated_card
210
- # Represents a per-setup override of a reader configuration
211
- sig { returns(ProcessConfig) }
212
- attr_reader :process_config
213
- # Most recent SetupIntent processed by the reader.
214
- sig { returns(T.any(String, Stripe::SetupIntent)) }
215
- attr_reader :setup_intent
216
- end
217
- class RefundPayment < Stripe::StripeObject
218
- class RefundPaymentConfig < Stripe::StripeObject
219
- # Enable customer-initiated cancellation when refunding this payment.
220
- sig { returns(T::Boolean) }
221
- attr_reader :enable_customer_cancellation
222
- end
223
- # The amount being refunded.
224
- sig { returns(Integer) }
225
- attr_reader :amount
226
- # Charge that is being refunded.
227
- sig { returns(T.any(String, Stripe::Charge)) }
228
- attr_reader :charge
229
- # 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.
230
- sig { returns(T::Hash[String, String]) }
231
- attr_reader :metadata
232
- # Payment intent that is being refunded.
233
- sig { returns(T.any(String, Stripe::PaymentIntent)) }
234
- attr_reader :payment_intent
235
- # The reason for the refund.
236
- sig { returns(String) }
237
- attr_reader :reason
238
- # Unique identifier for the refund object.
239
- sig { returns(T.any(String, Stripe::Refund)) }
240
- attr_reader :refund
241
- # Boolean indicating whether the application fee should be refunded when refunding this charge. If a full charge refund is given, the full application fee will be refunded. Otherwise, the application fee will be refunded in an amount proportional to the amount of the charge refunded. An application fee can be refunded only by the application that created the charge.
242
- sig { returns(T::Boolean) }
243
- attr_reader :refund_application_fee
244
- # Represents a per-transaction override of a reader configuration
245
- sig { returns(RefundPaymentConfig) }
246
- attr_reader :refund_payment_config
247
- # Boolean indicating whether the transfer should be reversed when refunding this charge. The transfer will be reversed proportionally to the amount being refunded (either the entire or partial amount). A transfer can be reversed only by the application that created the charge.
248
- sig { returns(T::Boolean) }
249
- attr_reader :reverse_transfer
250
- end
251
- class SetReaderDisplay < Stripe::StripeObject
252
- class Cart < Stripe::StripeObject
253
- class LineItem < Stripe::StripeObject
254
- # The amount of the line item. A positive integer in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal).
255
- sig { returns(Integer) }
256
- attr_reader :amount
257
- # Description of the line item.
258
- sig { returns(String) }
259
- attr_reader :description
260
- # The quantity of the line item.
261
- sig { returns(Integer) }
262
- attr_reader :quantity
263
- end
264
- # Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).
265
- sig { returns(String) }
266
- attr_reader :currency
267
- # List of line items in the cart.
268
- sig { returns(T::Array[LineItem]) }
269
- attr_reader :line_items
270
- # Tax amount for the entire cart. A positive integer in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal).
271
- sig { returns(T.nilable(Integer)) }
272
- attr_reader :tax
273
- # Total amount for the entire cart, including tax. A positive integer in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal).
274
- sig { returns(Integer) }
275
- attr_reader :total
276
- end
277
- # Cart object to be displayed by the reader.
278
- sig { returns(T.nilable(Cart)) }
279
- attr_reader :cart
280
- # Type of information to be displayed by the reader.
281
- sig { returns(String) }
282
- attr_reader :type
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
293
- # Failure code, only set if status is `failed`.
294
- sig { returns(T.nilable(String)) }
295
- attr_reader :failure_code
296
- # Detailed failure message, only set if status is `failed`.
297
- sig { returns(T.nilable(String)) }
298
- attr_reader :failure_message
299
- # Represents a reader action to process a payment intent
300
- sig { returns(ProcessPaymentIntent) }
301
- attr_reader :process_payment_intent
302
- # Represents a reader action to process a setup intent
303
- sig { returns(ProcessSetupIntent) }
304
- attr_reader :process_setup_intent
305
- # Represents a reader action to refund a payment
306
- sig { returns(RefundPayment) }
307
- attr_reader :refund_payment
308
- # Represents a reader action to set the reader display
309
- sig { returns(SetReaderDisplay) }
310
- attr_reader :set_reader_display
311
- # Status of the action performed by the reader.
312
- sig { returns(String) }
313
- attr_reader :status
314
- # Type of action performed by the reader.
315
- sig { returns(String) }
316
- attr_reader :type
317
- end
318
- # The most recent action performed by the reader.
319
- sig { returns(T.nilable(Action)) }
320
- attr_reader :action
321
- # The current software version of the reader.
322
- sig { returns(T.nilable(String)) }
323
- attr_reader :device_sw_version
324
- # Device type of the reader.
325
- sig { returns(String) }
326
- attr_reader :device_type
327
- # Unique identifier for the object.
328
- sig { returns(String) }
329
- attr_reader :id
330
- # The local IP address of the reader.
331
- sig { returns(T.nilable(String)) }
332
- attr_reader :ip_address
333
- # Custom label given to the reader for easier identification.
334
- sig { returns(String) }
335
- attr_reader :label
336
- # Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
337
- sig { returns(T::Boolean) }
338
- attr_reader :livemode
339
- # The location identifier of the reader.
340
- sig { returns(T.nilable(T.any(String, Stripe::Terminal::Location))) }
341
- attr_reader :location
342
- # 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.
343
- sig { returns(T::Hash[String, String]) }
344
- attr_reader :metadata
345
- # String representing the object's type. Objects of the same type share the same value.
346
- sig { returns(String) }
347
- attr_reader :object
348
- # Serial number of the reader.
349
- sig { returns(String) }
350
- attr_reader :serial_number
351
- # The networking status of the reader. We do not recommend using this field in flows that may block taking payments.
352
- sig { returns(T.nilable(String)) }
353
- attr_reader :status
354
- # Always true for a deleted object
355
- sig { returns(T::Boolean) }
356
- attr_reader :deleted
357
- class DeleteParams < Stripe::RequestParams; end
358
- class UpdateParams < Stripe::RequestParams
359
- # Specifies which fields in the response should be expanded.
360
- sig { returns(T.nilable(T::Array[String])) }
361
- attr_accessor :expand
362
- # The new label of the reader.
363
- sig { returns(T.nilable(T.nilable(String))) }
364
- attr_accessor :label
365
- # 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`.
366
- sig { returns(T.nilable(T.nilable(T.any(String, T::Hash[String, String])))) }
367
- attr_accessor :metadata
368
- sig {
369
- params(expand: T.nilable(T::Array[String]), label: T.nilable(T.nilable(String)), metadata: T.nilable(T.nilable(T.any(String, T::Hash[String, String])))).void
370
- }
371
- def initialize(expand: nil, label: nil, metadata: nil); end
372
- end
373
- class ListParams < Stripe::RequestParams
374
- # Filters readers by device type
375
- sig { returns(T.nilable(String)) }
376
- attr_accessor :device_type
377
- # 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.
378
- sig { returns(T.nilable(String)) }
379
- attr_accessor :ending_before
380
- # Specifies which fields in the response should be expanded.
381
- sig { returns(T.nilable(T::Array[String])) }
382
- attr_accessor :expand
383
- # A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
384
- sig { returns(T.nilable(Integer)) }
385
- attr_accessor :limit
386
- # A location ID to filter the response list to only readers at the specific location
387
- sig { returns(T.nilable(String)) }
388
- attr_accessor :location
389
- # Filters readers by serial number
390
- sig { returns(T.nilable(String)) }
391
- attr_accessor :serial_number
392
- # A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
393
- sig { returns(T.nilable(String)) }
394
- attr_accessor :starting_after
395
- # A status filter to filter readers to only offline or online readers
396
- sig { returns(T.nilable(String)) }
397
- attr_accessor :status
398
- sig {
399
- params(device_type: T.nilable(String), ending_before: T.nilable(String), expand: T.nilable(T::Array[String]), limit: T.nilable(Integer), location: T.nilable(String), serial_number: T.nilable(String), starting_after: T.nilable(String), status: T.nilable(String)).void
400
- }
401
- def initialize(
402
- device_type: nil,
403
- ending_before: nil,
404
- expand: nil,
405
- limit: nil,
406
- location: nil,
407
- serial_number: nil,
408
- starting_after: nil,
409
- status: nil
410
- ); end
411
- end
412
- class CreateParams < Stripe::RequestParams
413
- # Specifies which fields in the response should be expanded.
414
- sig { returns(T.nilable(T::Array[String])) }
415
- attr_accessor :expand
416
- # Custom label given to the reader for easier identification. If no label is specified, the registration code will be used.
417
- sig { returns(T.nilable(String)) }
418
- attr_accessor :label
419
- # The location to assign the reader to.
420
- sig { returns(T.nilable(String)) }
421
- attr_accessor :location
422
- # 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`.
423
- sig { returns(T.nilable(T.nilable(T.any(String, T::Hash[String, String])))) }
424
- attr_accessor :metadata
425
- # A code generated by the reader used for registering to an account.
426
- sig { returns(String) }
427
- attr_accessor :registration_code
428
- sig {
429
- params(expand: T.nilable(T::Array[String]), label: T.nilable(String), location: T.nilable(String), metadata: T.nilable(T.nilable(T.any(String, T::Hash[String, String]))), registration_code: String).void
430
- }
431
- def initialize(
432
- expand: nil,
433
- label: nil,
434
- location: nil,
435
- metadata: nil,
436
- registration_code: nil
437
- ); end
438
- end
439
- class CancelActionParams < Stripe::RequestParams
440
- # Specifies which fields in the response should be expanded.
441
- sig { returns(T.nilable(T::Array[String])) }
442
- attr_accessor :expand
443
- sig { params(expand: T.nilable(T::Array[String])).void }
444
- def initialize(expand: nil); end
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
622
- class ProcessPaymentIntentParams < Stripe::RequestParams
623
- class ProcessConfig < Stripe::RequestParams
624
- class Tipping < Stripe::RequestParams
625
- # 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).
626
- sig { returns(T.nilable(Integer)) }
627
- attr_accessor :amount_eligible
628
- sig { params(amount_eligible: T.nilable(Integer)).void }
629
- def initialize(amount_eligible: nil); end
630
- end
631
- # 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.
632
- sig { returns(T.nilable(String)) }
633
- attr_accessor :allow_redisplay
634
- # Enables cancel button on transaction screens.
635
- sig { returns(T.nilable(T::Boolean)) }
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
640
- # Override showing a tipping selection screen on this transaction.
641
- sig { returns(T.nilable(T::Boolean)) }
642
- attr_accessor :skip_tipping
643
- # Tipping configuration for this transaction.
644
- sig {
645
- returns(T.nilable(::Stripe::Terminal::Reader::ProcessPaymentIntentParams::ProcessConfig::Tipping))
646
- }
647
- attr_accessor :tipping
648
- sig {
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
650
- }
651
- def initialize(
652
- allow_redisplay: nil,
653
- enable_customer_cancellation: nil,
654
- return_url: nil,
655
- skip_tipping: nil,
656
- tipping: nil
657
- ); end
658
- end
659
- # Specifies which fields in the response should be expanded.
660
- sig { returns(T.nilable(T::Array[String])) }
661
- attr_accessor :expand
662
- # PaymentIntent ID
663
- sig { returns(String) }
664
- attr_accessor :payment_intent
665
- # Configuration overrides
666
- sig {
667
- returns(T.nilable(::Stripe::Terminal::Reader::ProcessPaymentIntentParams::ProcessConfig))
668
- }
669
- attr_accessor :process_config
670
- sig {
671
- params(expand: T.nilable(T::Array[String]), payment_intent: String, process_config: T.nilable(::Stripe::Terminal::Reader::ProcessPaymentIntentParams::ProcessConfig)).void
672
- }
673
- def initialize(expand: nil, payment_intent: nil, process_config: nil); end
674
- end
675
- class ProcessSetupIntentParams < Stripe::RequestParams
676
- class ProcessConfig < Stripe::RequestParams
677
- # Enables cancel button on transaction screens.
678
- sig { returns(T.nilable(T::Boolean)) }
679
- attr_accessor :enable_customer_cancellation
680
- sig { params(enable_customer_cancellation: T.nilable(T::Boolean)).void }
681
- def initialize(enable_customer_cancellation: nil); end
682
- end
683
- # 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.
684
- sig { returns(String) }
685
- attr_accessor :allow_redisplay
686
- # Specifies which fields in the response should be expanded.
687
- sig { returns(T.nilable(T::Array[String])) }
688
- attr_accessor :expand
689
- # Configuration overrides
690
- sig {
691
- returns(T.nilable(::Stripe::Terminal::Reader::ProcessSetupIntentParams::ProcessConfig))
692
- }
693
- attr_accessor :process_config
694
- # SetupIntent ID
695
- sig { returns(String) }
696
- attr_accessor :setup_intent
697
- sig {
698
- params(allow_redisplay: String, expand: T.nilable(T::Array[String]), process_config: T.nilable(::Stripe::Terminal::Reader::ProcessSetupIntentParams::ProcessConfig), setup_intent: String).void
699
- }
700
- def initialize(
701
- allow_redisplay: nil,
702
- expand: nil,
703
- process_config: nil,
704
- setup_intent: nil
705
- ); end
706
- end
707
- class RefundPaymentParams < Stripe::RequestParams
708
- class RefundPaymentConfig < Stripe::RequestParams
709
- # Enables cancel button on transaction screens.
710
- sig { returns(T.nilable(T::Boolean)) }
711
- attr_accessor :enable_customer_cancellation
712
- sig { params(enable_customer_cancellation: T.nilable(T::Boolean)).void }
713
- def initialize(enable_customer_cancellation: nil); end
714
- end
715
- # A positive integer in __cents__ representing how much of this charge to refund.
716
- sig { returns(T.nilable(Integer)) }
717
- attr_accessor :amount
718
- # ID of the Charge to refund.
719
- sig { returns(T.nilable(String)) }
720
- attr_accessor :charge
721
- # Specifies which fields in the response should be expanded.
722
- sig { returns(T.nilable(T::Array[String])) }
723
- attr_accessor :expand
724
- # 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`.
725
- sig { returns(T.nilable(T::Hash[String, String])) }
726
- attr_accessor :metadata
727
- # ID of the PaymentIntent to refund.
728
- sig { returns(T.nilable(String)) }
729
- attr_accessor :payment_intent
730
- # Boolean indicating whether the application fee should be refunded when refunding this charge. If a full charge refund is given, the full application fee will be refunded. Otherwise, the application fee will be refunded in an amount proportional to the amount of the charge refunded. An application fee can be refunded only by the application that created the charge.
731
- sig { returns(T.nilable(T::Boolean)) }
732
- attr_accessor :refund_application_fee
733
- # Configuration overrides
734
- sig {
735
- returns(T.nilable(::Stripe::Terminal::Reader::RefundPaymentParams::RefundPaymentConfig))
736
- }
737
- attr_accessor :refund_payment_config
738
- # Boolean indicating whether the transfer should be reversed when refunding this charge. The transfer will be reversed proportionally to the amount being refunded (either the entire or partial amount). A transfer can be reversed only by the application that created the charge.
739
- sig { returns(T.nilable(T::Boolean)) }
740
- attr_accessor :reverse_transfer
741
- sig {
742
- params(amount: T.nilable(Integer), charge: T.nilable(String), expand: T.nilable(T::Array[String]), metadata: T.nilable(T::Hash[String, String]), payment_intent: T.nilable(String), refund_application_fee: T.nilable(T::Boolean), refund_payment_config: T.nilable(::Stripe::Terminal::Reader::RefundPaymentParams::RefundPaymentConfig), reverse_transfer: T.nilable(T::Boolean)).void
743
- }
744
- def initialize(
745
- amount: nil,
746
- charge: nil,
747
- expand: nil,
748
- metadata: nil,
749
- payment_intent: nil,
750
- refund_application_fee: nil,
751
- refund_payment_config: nil,
752
- reverse_transfer: nil
753
- ); end
754
- end
755
- class SetReaderDisplayParams < Stripe::RequestParams
756
- class Cart < Stripe::RequestParams
757
- class LineItem < Stripe::RequestParams
758
- # The price of the item in cents.
759
- sig { returns(Integer) }
760
- attr_accessor :amount
761
- # The description or name of the item.
762
- sig { returns(String) }
763
- attr_accessor :description
764
- # The quantity of the line item being purchased.
765
- sig { returns(Integer) }
766
- attr_accessor :quantity
767
- sig { params(amount: Integer, description: String, quantity: Integer).void }
768
- def initialize(amount: nil, description: nil, quantity: nil); end
769
- end
770
- # Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).
771
- sig { returns(String) }
772
- attr_accessor :currency
773
- # Array of line items that were purchased.
774
- sig {
775
- returns(T::Array[::Stripe::Terminal::Reader::SetReaderDisplayParams::Cart::LineItem])
776
- }
777
- attr_accessor :line_items
778
- # The amount of tax in cents.
779
- sig { returns(T.nilable(Integer)) }
780
- attr_accessor :tax
781
- # Total balance of cart due in cents.
782
- sig { returns(Integer) }
783
- attr_accessor :total
784
- sig {
785
- params(currency: String, line_items: T::Array[::Stripe::Terminal::Reader::SetReaderDisplayParams::Cart::LineItem], tax: T.nilable(Integer), total: Integer).void
786
- }
787
- def initialize(currency: nil, line_items: nil, tax: nil, total: nil); end
788
- end
789
- # Cart
790
- sig { returns(T.nilable(::Stripe::Terminal::Reader::SetReaderDisplayParams::Cart)) }
791
- attr_accessor :cart
792
- # Specifies which fields in the response should be expanded.
793
- sig { returns(T.nilable(T::Array[String])) }
794
- attr_accessor :expand
795
- # Type
796
- sig { returns(String) }
797
- attr_accessor :type
798
- sig {
799
- params(cart: T.nilable(::Stripe::Terminal::Reader::SetReaderDisplayParams::Cart), expand: T.nilable(T::Array[String]), type: String).void
800
- }
801
- def initialize(cart: nil, expand: nil, type: nil); end
802
- end
803
- class PresentPaymentMethodParams < Stripe::RequestParams
804
- class CardPresent < Stripe::RequestParams
805
- # The card number, as a string without any separators.
806
- sig { returns(T.nilable(String)) }
807
- attr_accessor :number
808
- sig { params(number: T.nilable(String)).void }
809
- def initialize(number: nil); end
810
- end
811
- class InteracPresent < Stripe::RequestParams
812
- # Card Number
813
- sig { returns(T.nilable(String)) }
814
- attr_accessor :number
815
- sig { params(number: T.nilable(String)).void }
816
- def initialize(number: nil); end
817
- end
818
- # Simulated on-reader tip amount.
819
- sig { returns(T.nilable(Integer)) }
820
- attr_accessor :amount_tip
821
- # Simulated data for the card_present payment method.
822
- sig {
823
- returns(T.nilable(::Stripe::Terminal::Reader::PresentPaymentMethodParams::CardPresent))
824
- }
825
- attr_accessor :card_present
826
- # Specifies which fields in the response should be expanded.
827
- sig { returns(T.nilable(T::Array[String])) }
828
- attr_accessor :expand
829
- # Simulated data for the interac_present payment method.
830
- sig {
831
- returns(T.nilable(::Stripe::Terminal::Reader::PresentPaymentMethodParams::InteracPresent))
832
- }
833
- attr_accessor :interac_present
834
- # Simulated payment type.
835
- sig { returns(T.nilable(String)) }
836
- attr_accessor :type
837
- sig {
838
- params(amount_tip: T.nilable(Integer), card_present: T.nilable(::Stripe::Terminal::Reader::PresentPaymentMethodParams::CardPresent), expand: T.nilable(T::Array[String]), interac_present: T.nilable(::Stripe::Terminal::Reader::PresentPaymentMethodParams::InteracPresent), type: T.nilable(String)).void
839
- }
840
- def initialize(
841
- amount_tip: nil,
842
- card_present: nil,
843
- expand: nil,
844
- interac_present: nil,
845
- type: nil
846
- ); end
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
867
- # Cancels the current reader action.
868
- sig {
869
- params(params: T.any(::Stripe::Terminal::Reader::CancelActionParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Terminal::Reader)
870
- }
871
- def cancel_action(params = {}, opts = {}); end
872
-
873
- # Cancels the current reader action.
874
- sig {
875
- params(reader: String, params: T.any(::Stripe::Terminal::Reader::CancelActionParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Terminal::Reader)
876
- }
877
- def self.cancel_action(reader, params = {}, opts = {}); end
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
-
915
- # Creates a new Reader object.
916
- sig {
917
- params(params: T.any(::Stripe::Terminal::Reader::CreateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Terminal::Reader)
918
- }
919
- def self.create(params = {}, opts = {}); end
920
-
921
- # Deletes a Reader object.
922
- sig {
923
- params(reader: String, params: T.any(::Stripe::Terminal::Reader::DeleteParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Terminal::Reader)
924
- }
925
- def self.delete(reader, params = {}, opts = {}); end
926
-
927
- # Deletes a Reader object.
928
- sig {
929
- params(params: T.any(::Stripe::Terminal::Reader::DeleteParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Terminal::Reader)
930
- }
931
- def delete(params = {}, opts = {}); end
932
-
933
- # Returns a list of Reader objects.
934
- sig {
935
- params(params: T.any(::Stripe::Terminal::Reader::ListParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::ListObject)
936
- }
937
- def self.list(params = {}, opts = {}); end
938
-
939
- # Initiates a payment flow on a Reader.
940
- sig {
941
- params(params: T.any(::Stripe::Terminal::Reader::ProcessPaymentIntentParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Terminal::Reader)
942
- }
943
- def process_payment_intent(params = {}, opts = {}); end
944
-
945
- # Initiates a payment flow on a Reader.
946
- sig {
947
- params(reader: String, params: T.any(::Stripe::Terminal::Reader::ProcessPaymentIntentParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Terminal::Reader)
948
- }
949
- def self.process_payment_intent(reader, params = {}, opts = {}); end
950
-
951
- # Initiates a setup intent flow on a Reader.
952
- sig {
953
- params(params: T.any(::Stripe::Terminal::Reader::ProcessSetupIntentParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Terminal::Reader)
954
- }
955
- def process_setup_intent(params = {}, opts = {}); end
956
-
957
- # Initiates a setup intent flow on a Reader.
958
- sig {
959
- params(reader: String, params: T.any(::Stripe::Terminal::Reader::ProcessSetupIntentParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Terminal::Reader)
960
- }
961
- def self.process_setup_intent(reader, params = {}, opts = {}); end
962
-
963
- # Initiates a refund on a Reader
964
- sig {
965
- params(params: T.any(::Stripe::Terminal::Reader::RefundPaymentParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Terminal::Reader)
966
- }
967
- def refund_payment(params = {}, opts = {}); end
968
-
969
- # Initiates a refund on a Reader
970
- sig {
971
- params(reader: String, params: T.any(::Stripe::Terminal::Reader::RefundPaymentParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Terminal::Reader)
972
- }
973
- def self.refund_payment(reader, params = {}, opts = {}); end
974
-
975
- # Sets reader display to show cart details.
976
- sig {
977
- params(params: T.any(::Stripe::Terminal::Reader::SetReaderDisplayParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Terminal::Reader)
978
- }
979
- def set_reader_display(params = {}, opts = {}); end
980
-
981
- # Sets reader display to show cart details.
982
- sig {
983
- params(reader: String, params: T.any(::Stripe::Terminal::Reader::SetReaderDisplayParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Terminal::Reader)
984
- }
985
- def self.set_reader_display(reader, params = {}, opts = {}); end
986
-
987
- # Updates a Reader object by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
988
- sig {
989
- params(reader: String, params: T.any(::Stripe::Terminal::Reader::UpdateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Terminal::Reader)
990
- }
991
- def self.update(reader, params = {}, opts = {}); end
992
- end
993
- end
994
- end