stripe 13.3.0 → 13.4.0.pre.beta.1

Sign up to get free protection for your applications and to get access to all the features.
Files changed (743) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +1410 -650
  3. data/OPENAPI_VERSION +1 -1
  4. data/VERSION +1 -1
  5. data/lib/stripe/api_operations/request.rb +1 -0
  6. data/lib/stripe/api_requestor.rb +1 -0
  7. data/lib/stripe/object_types.rb +32 -0
  8. data/lib/stripe/request_params.rb +24 -0
  9. data/lib/stripe/request_signing_authenticator.rb +79 -0
  10. data/lib/stripe/resources/account.rb +5793 -0
  11. data/lib/stripe/resources/account_link.rb +64 -0
  12. data/lib/stripe/resources/account_notice.rb +154 -0
  13. data/lib/stripe/resources/account_session.rb +1002 -0
  14. data/lib/stripe/resources/apple_pay_domain.rb +73 -0
  15. data/lib/stripe/resources/application.rb +23 -0
  16. data/lib/stripe/resources/application_fee.rb +120 -0
  17. data/lib/stripe/resources/application_fee_refund.rb +24 -0
  18. data/lib/stripe/resources/apps/secret.rb +166 -0
  19. data/lib/stripe/resources/balance.rb +162 -0
  20. data/lib/stripe/resources/balance_transaction.rb +141 -0
  21. data/lib/stripe/resources/bank_account.rb +113 -2
  22. data/lib/stripe/resources/billing/alert.rb +166 -0
  23. data/lib/stripe/resources/billing/alert_triggered.rb +31 -0
  24. data/lib/stripe/resources/billing/credit_balance_summary.rb +89 -0
  25. data/lib/stripe/resources/billing/credit_balance_transaction.rb +140 -0
  26. data/lib/stripe/resources/billing/credit_grant.rb +235 -0
  27. data/lib/stripe/resources/billing/meter.rb +203 -0
  28. data/lib/stripe/resources/billing/meter_error_report.rb +70 -0
  29. data/lib/stripe/resources/billing/meter_event.rb +45 -0
  30. data/lib/stripe/resources/billing/meter_event_adjustment.rb +51 -0
  31. data/lib/stripe/resources/billing/meter_event_summary.rb +21 -0
  32. data/lib/stripe/resources/billing_portal/configuration.rb +639 -0
  33. data/lib/stripe/resources/billing_portal/session.rb +313 -0
  34. data/lib/stripe/resources/capability.rb +111 -0
  35. data/lib/stripe/resources/capital/financing_offer.rb +221 -0
  36. data/lib/stripe/resources/capital/financing_summary.rb +77 -0
  37. data/lib/stripe/resources/capital/financing_transaction.rb +147 -0
  38. data/lib/stripe/resources/card.rb +111 -0
  39. data/lib/stripe/resources/cash_balance.rb +22 -0
  40. data/lib/stripe/resources/charge.rb +3687 -0
  41. data/lib/stripe/resources/checkout/session.rb +4162 -0
  42. data/lib/stripe/resources/climate/order.rb +216 -0
  43. data/lib/stripe/resources/climate/product.rb +69 -0
  44. data/lib/stripe/resources/climate/supplier.rb +67 -0
  45. data/lib/stripe/resources/confirmation_token.rb +1855 -0
  46. data/lib/stripe/resources/connect_collection_transfer.rb +29 -0
  47. data/lib/stripe/resources/country_spec.rb +76 -0
  48. data/lib/stripe/resources/coupon.rb +237 -0
  49. data/lib/stripe/resources/credit_note.rb +798 -0
  50. data/lib/stripe/resources/credit_note_line_item.rb +89 -0
  51. data/lib/stripe/resources/customer.rb +995 -0
  52. data/lib/stripe/resources/customer_balance_transaction.rb +39 -0
  53. data/lib/stripe/resources/customer_cash_balance_transaction.rb +136 -0
  54. data/lib/stripe/resources/customer_session.rb +183 -0
  55. data/lib/stripe/resources/discount.rb +41 -0
  56. data/lib/stripe/resources/dispute.rb +767 -0
  57. data/lib/stripe/resources/entitlements/active_entitlement.rb +54 -0
  58. data/lib/stripe/resources/entitlements/active_entitlement_summary.rb +26 -0
  59. data/lib/stripe/resources/entitlements/feature.rb +107 -0
  60. data/lib/stripe/resources/ephemeral_key.rb +26 -0
  61. data/lib/stripe/resources/event.rb +157 -0
  62. data/lib/stripe/resources/exchange_rate.rb +38 -0
  63. data/lib/stripe/resources/file.rb +134 -0
  64. data/lib/stripe/resources/file_link.rb +134 -0
  65. data/lib/stripe/resources/financial_connections/account.rb +307 -0
  66. data/lib/stripe/resources/financial_connections/account_inferred_balance.rb +30 -0
  67. data/lib/stripe/resources/financial_connections/account_owner.rb +24 -0
  68. data/lib/stripe/resources/financial_connections/account_ownership.rb +12 -0
  69. data/lib/stripe/resources/financial_connections/institution.rb +112 -0
  70. data/lib/stripe/resources/financial_connections/session.rb +187 -0
  71. data/lib/stripe/resources/financial_connections/transaction.rb +122 -0
  72. data/lib/stripe/resources/forwarding/request.rb +196 -0
  73. data/lib/stripe/resources/funding_instructions.rb +415 -0
  74. data/lib/stripe/resources/gift_cards/card.rb +245 -0
  75. data/lib/stripe/resources/gift_cards/transaction.rb +313 -0
  76. data/lib/stripe/resources/identity/verification_report.rb +335 -0
  77. data/lib/stripe/resources/identity/verification_session.rb +430 -0
  78. data/lib/stripe/resources/invoice.rb +9348 -0
  79. data/lib/stripe/resources/invoice_item.rb +536 -0
  80. data/lib/stripe/resources/invoice_line_item.rb +409 -0
  81. data/lib/stripe/resources/invoice_payment.rb +72 -0
  82. data/lib/stripe/resources/invoice_rendering_template.rb +79 -0
  83. data/lib/stripe/resources/issuing/authorization.rb +1316 -2
  84. data/lib/stripe/resources/issuing/card.rb +794 -0
  85. data/lib/stripe/resources/issuing/cardholder.rb +768 -0
  86. data/lib/stripe/resources/issuing/credit_underwriting_record.rb +693 -0
  87. data/lib/stripe/resources/issuing/dispute.rb +941 -0
  88. data/lib/stripe/resources/issuing/dispute_settlement_detail.rb +98 -0
  89. data/lib/stripe/resources/issuing/fraud_liability_debit.rb +109 -0
  90. data/lib/stripe/resources/issuing/personalization_design.rb +333 -0
  91. data/lib/stripe/resources/issuing/physical_bundle.rb +76 -0
  92. data/lib/stripe/resources/issuing/settlement.rb +65 -0
  93. data/lib/stripe/resources/issuing/token.rb +221 -0
  94. data/lib/stripe/resources/issuing/transaction.rb +1098 -0
  95. data/lib/stripe/resources/line_item.rb +98 -0
  96. data/lib/stripe/resources/login_link.rb +9 -0
  97. data/lib/stripe/resources/mandate.rb +214 -0
  98. data/lib/stripe/resources/margin.rb +143 -0
  99. data/lib/stripe/resources/order.rb +3238 -0
  100. data/lib/stripe/resources/payment_attempt_record.rb +226 -0
  101. data/lib/stripe/resources/payment_intent.rb +14630 -0
  102. data/lib/stripe/resources/payment_link.rb +1761 -0
  103. data/lib/stripe/resources/payment_method.rb +1981 -0
  104. data/lib/stripe/resources/payment_method_configuration.rb +3137 -0
  105. data/lib/stripe/resources/payment_method_domain.rb +176 -0
  106. data/lib/stripe/resources/payment_record.rb +824 -0
  107. data/lib/stripe/resources/payout.rb +267 -0
  108. data/lib/stripe/resources/person.rb +353 -0
  109. data/lib/stripe/resources/plan.rb +386 -0
  110. data/lib/stripe/resources/price.rb +782 -0
  111. data/lib/stripe/resources/product.rb +636 -0
  112. data/lib/stripe/resources/product_feature.rb +16 -0
  113. data/lib/stripe/resources/promotion_code.rb +261 -0
  114. data/lib/stripe/resources/quote.rb +3404 -0
  115. data/lib/stripe/resources/quote_line.rb +340 -0
  116. data/lib/stripe/resources/quote_preview_invoice.rb +833 -0
  117. data/lib/stripe/resources/quote_preview_subscription_schedule.rb +463 -0
  118. data/lib/stripe/resources/radar/early_fraud_warning.rb +93 -0
  119. data/lib/stripe/resources/radar/value_list.rb +151 -0
  120. data/lib/stripe/resources/radar/value_list_item.rb +113 -0
  121. data/lib/stripe/resources/refund.rb +489 -0
  122. data/lib/stripe/resources/reporting/report_run.rb +182 -0
  123. data/lib/stripe/resources/reporting/report_type.rb +44 -0
  124. data/lib/stripe/resources/reserve_transaction.rb +26 -0
  125. data/lib/stripe/resources/reversal.rb +30 -0
  126. data/lib/stripe/resources/review.rb +135 -0
  127. data/lib/stripe/resources/setup_attempt.rb +474 -0
  128. data/lib/stripe/resources/setup_intent.rb +4371 -0
  129. data/lib/stripe/resources/shipping_rate.rb +303 -0
  130. data/lib/stripe/resources/sigma/scheduled_query_run.rb +67 -0
  131. data/lib/stripe/resources/source.rb +1571 -0
  132. data/lib/stripe/resources/source_mandate_notification.rb +79 -0
  133. data/lib/stripe/resources/source_transaction.rb +114 -0
  134. data/lib/stripe/resources/subscription.rb +2395 -0
  135. data/lib/stripe/resources/subscription_item.rb +502 -0
  136. data/lib/stripe/resources/subscription_schedule.rb +2790 -0
  137. data/lib/stripe/resources/tax/association.rb +100 -0
  138. data/lib/stripe/resources/tax/calculation.rb +474 -0
  139. data/lib/stripe/resources/tax/calculation_line_item.rb +76 -0
  140. data/lib/stripe/resources/tax/form.rb +253 -0
  141. data/lib/stripe/resources/tax/registration.rb +2174 -0
  142. data/lib/stripe/resources/tax/settings.rb +146 -0
  143. data/lib/stripe/resources/tax/transaction.rb +332 -0
  144. data/lib/stripe/resources/tax/transaction_line_item.rb +43 -0
  145. data/lib/stripe/resources/tax_code.rb +41 -0
  146. data/lib/stripe/resources/tax_deducted_at_source.rb +26 -0
  147. data/lib/stripe/resources/tax_id.rb +147 -0
  148. data/lib/stripe/resources/tax_rate.rb +245 -0
  149. data/lib/stripe/resources/terminal/configuration.rb +1175 -0
  150. data/lib/stripe/resources/terminal/connection_token.rb +21 -0
  151. data/lib/stripe/resources/terminal/location.rb +208 -0
  152. data/lib/stripe/resources/terminal/reader.rb +911 -0
  153. data/lib/stripe/resources/terminal/reader_collected_data.rb +45 -0
  154. data/lib/stripe/resources/test_helpers/test_clock.rb +101 -0
  155. data/lib/stripe/resources/token.rb +1337 -0
  156. data/lib/stripe/resources/topup.rb +210 -0
  157. data/lib/stripe/resources/transfer.rb +188 -0
  158. data/lib/stripe/resources/treasury/credit_reversal.rb +113 -0
  159. data/lib/stripe/resources/treasury/debit_reversal.rb +126 -0
  160. data/lib/stripe/resources/treasury/financial_account.rb +766 -0
  161. data/lib/stripe/resources/treasury/financial_account_features.rb +237 -0
  162. data/lib/stripe/resources/treasury/inbound_transfer.rb +285 -0
  163. data/lib/stripe/resources/treasury/outbound_payment.rb +587 -0
  164. data/lib/stripe/resources/treasury/outbound_transfer.rb +428 -0
  165. data/lib/stripe/resources/treasury/received_credit.rb +335 -0
  166. data/lib/stripe/resources/treasury/received_debit.rb +298 -0
  167. data/lib/stripe/resources/treasury/transaction.rb +215 -0
  168. data/lib/stripe/resources/treasury/transaction_entry.rb +193 -0
  169. data/lib/stripe/resources/usage_record.rb +18 -0
  170. data/lib/stripe/resources/usage_record_summary.rb +28 -0
  171. data/lib/stripe/resources/v2/amount.rb +9 -0
  172. data/lib/stripe/resources/v2/billing/meter_event.rb +24 -0
  173. data/lib/stripe/resources/v2/billing/meter_event_adjustment.rb +28 -0
  174. data/lib/stripe/resources/v2/billing/meter_event_session.rb +19 -0
  175. data/lib/stripe/resources/v2/event.rb +35 -0
  176. data/lib/stripe/resources/v2/event_destination.rb +78 -0
  177. data/lib/stripe/resources/webhook_endpoint.rb +148 -0
  178. data/lib/stripe/resources.rb +31 -0
  179. data/lib/stripe/services/account_capability_service.rb +33 -0
  180. data/lib/stripe/services/account_external_account_service.rb +293 -0
  181. data/lib/stripe/services/account_link_service.rb +53 -0
  182. data/lib/stripe/services/account_login_link_service.rb +9 -0
  183. data/lib/stripe/services/account_notice_service.rb +110 -0
  184. data/lib/stripe/services/account_person_service.rb +1014 -0
  185. data/lib/stripe/services/account_service.rb +4862 -0
  186. data/lib/stripe/services/account_session_service.rb +740 -0
  187. data/lib/stripe/services/apple_pay_domain_service.rb +56 -0
  188. data/lib/stripe/services/application_fee_refund_service.rb +60 -0
  189. data/lib/stripe/services/application_fee_service.rb +65 -0
  190. data/lib/stripe/services/apps/secret_service.rb +132 -0
  191. data/lib/stripe/services/balance_service.rb +9 -0
  192. data/lib/stripe/services/balance_transaction_service.rb +80 -0
  193. data/lib/stripe/services/billing/alert_service.rb +125 -0
  194. data/lib/stripe/services/billing/credit_balance_summary_service.rb +41 -0
  195. data/lib/stripe/services/billing/credit_balance_transaction_service.rb +45 -0
  196. data/lib/stripe/services/billing/credit_grant_service.rb +167 -0
  197. data/lib/stripe/services/billing/meter_event_adjustment_service.rb +29 -0
  198. data/lib/stripe/services/billing/meter_event_service.rb +25 -0
  199. data/lib/stripe/services/billing/meter_event_summary_service.rb +46 -0
  200. data/lib/stripe/services/billing/meter_service.rb +142 -0
  201. data/lib/stripe/services/billing_portal/configuration_service.rb +492 -0
  202. data/lib/stripe/services/billing_portal/session_service.rb +192 -0
  203. data/lib/stripe/services/capital/financing_offer_service.rb +121 -0
  204. data/lib/stripe/services/capital/financing_summary_service.rb +28 -0
  205. data/lib/stripe/services/capital/financing_transaction_service.rb +86 -0
  206. data/lib/stripe/services/capital_service.rb +15 -0
  207. data/lib/stripe/services/charge_service.rb +2010 -0
  208. data/lib/stripe/services/checkout/session_line_item_service.rb +21 -0
  209. data/lib/stripe/services/checkout/session_service.rb +2736 -0
  210. data/lib/stripe/services/climate/order_service.rb +113 -0
  211. data/lib/stripe/services/climate/product_service.rb +30 -0
  212. data/lib/stripe/services/climate/supplier_service.rb +30 -0
  213. data/lib/stripe/services/confirmation_token_service.rb +9 -0
  214. data/lib/stripe/services/country_spec_service.rb +30 -0
  215. data/lib/stripe/services/coupon_service.rb +174 -0
  216. data/lib/stripe/services/credit_note_line_item_service.rb +21 -0
  217. data/lib/stripe/services/credit_note_preview_lines_service.rb +184 -0
  218. data/lib/stripe/services/credit_note_service.rb +434 -0
  219. data/lib/stripe/services/customer_balance_transaction_service.rb +72 -0
  220. data/lib/stripe/services/customer_cash_balance_service.rb +30 -0
  221. data/lib/stripe/services/customer_cash_balance_transaction_service.rb +30 -0
  222. data/lib/stripe/services/customer_funding_instructions_service.rb +47 -0
  223. data/lib/stripe/services/customer_payment_method_service.rb +45 -0
  224. data/lib/stripe/services/customer_payment_source_service.rb +208 -0
  225. data/lib/stripe/services/customer_service.rb +684 -0
  226. data/lib/stripe/services/customer_session_service.rb +106 -0
  227. data/lib/stripe/services/customer_tax_id_service.rb +50 -0
  228. data/lib/stripe/services/dispute_service.rb +439 -0
  229. data/lib/stripe/services/entitlements/active_entitlement_service.rb +40 -0
  230. data/lib/stripe/services/entitlements/feature_service.rb +87 -0
  231. data/lib/stripe/services/ephemeral_key_service.rb +40 -0
  232. data/lib/stripe/services/event_service.rb +75 -0
  233. data/lib/stripe/services/exchange_rate_service.rb +30 -0
  234. data/lib/stripe/services/file_link_service.rb +108 -0
  235. data/lib/stripe/services/file_service.rb +102 -0
  236. data/lib/stripe/services/financial_connections/account_inferred_balance_service.rb +40 -0
  237. data/lib/stripe/services/financial_connections/account_owner_service.rb +31 -0
  238. data/lib/stripe/services/financial_connections/account_service.rb +108 -1
  239. data/lib/stripe/services/financial_connections/institution_service.rb +60 -0
  240. data/lib/stripe/services/financial_connections/session_service.rb +108 -0
  241. data/lib/stripe/services/financial_connections/transaction_service.rb +79 -0
  242. data/lib/stripe/services/financial_connections_service.rb +2 -1
  243. data/lib/stripe/services/forwarding/request_service.rb +120 -0
  244. data/lib/stripe/services/gift_cards/card_service.rb +183 -0
  245. data/lib/stripe/services/gift_cards/transaction_service.rb +225 -0
  246. data/lib/stripe/services/gift_cards_service.rb +14 -0
  247. data/lib/stripe/services/identity/verification_report_service.rb +75 -0
  248. data/lib/stripe/services/identity/verification_session_service.rb +261 -0
  249. data/lib/stripe/services/invoice_item_service.rb +454 -0
  250. data/lib/stripe/services/invoice_line_item_service.rb +277 -0
  251. data/lib/stripe/services/invoice_payment_service.rb +58 -0
  252. data/lib/stripe/services/invoice_rendering_template_service.rb +56 -0
  253. data/lib/stripe/services/invoice_service.rb +6375 -1
  254. data/lib/stripe/services/invoice_upcoming_lines_service.rb +2142 -0
  255. data/lib/stripe/services/issuing/authorization_service.rb +118 -0
  256. data/lib/stripe/services/issuing/card_service.rb +525 -0
  257. data/lib/stripe/services/issuing/cardholder_service.rb +599 -0
  258. data/lib/stripe/services/issuing/credit_underwriting_record_service.rb +560 -0
  259. data/lib/stripe/services/issuing/dispute_service.rb +731 -0
  260. data/lib/stripe/services/issuing/dispute_settlement_detail_service.rb +70 -0
  261. data/lib/stripe/services/issuing/fraud_liability_debit_service.rb +90 -0
  262. data/lib/stripe/services/issuing/personalization_design_service.rb +222 -0
  263. data/lib/stripe/services/issuing/physical_bundle_service.rb +45 -0
  264. data/lib/stripe/services/issuing/token_service.rb +83 -0
  265. data/lib/stripe/services/issuing/transaction_service.rb +93 -0
  266. data/lib/stripe/services/issuing_service.rb +5 -1
  267. data/lib/stripe/services/mandate_service.rb +9 -0
  268. data/lib/stripe/services/margin_service.rb +130 -0
  269. data/lib/stripe/services/order_line_item_service.rb +38 -0
  270. data/lib/stripe/services/order_service.rb +2518 -0
  271. data/lib/stripe/services/payment_attempt_record_service.rb +50 -0
  272. data/lib/stripe/services/payment_intent_service.rb +12203 -0
  273. data/lib/stripe/services/payment_link_line_item_service.rb +21 -0
  274. data/lib/stripe/services/payment_link_service.rb +1343 -0
  275. data/lib/stripe/services/payment_method_configuration_service.rb +2148 -0
  276. data/lib/stripe/services/payment_method_domain_service.rb +84 -0
  277. data/lib/stripe/services/payment_method_service.rb +977 -0
  278. data/lib/stripe/services/payment_record_service.rb +610 -0
  279. data/lib/stripe/services/payout_service.rb +182 -0
  280. data/lib/stripe/services/plan_service.rb +296 -0
  281. data/lib/stripe/services/price_service.rb +603 -0
  282. data/lib/stripe/services/product_feature_service.rb +46 -0
  283. data/lib/stripe/services/product_service.rb +533 -0
  284. data/lib/stripe/services/promotion_code_service.rb +203 -0
  285. data/lib/stripe/services/quote_computed_upfront_line_items_service.rb +21 -0
  286. data/lib/stripe/services/quote_line_item_service.rb +21 -0
  287. data/lib/stripe/services/quote_line_service.rb +38 -0
  288. data/lib/stripe/services/quote_preview_invoice_service.rb +38 -0
  289. data/lib/stripe/services/quote_preview_subscription_schedule_service.rb +38 -0
  290. data/lib/stripe/services/quote_service.rb +2628 -1
  291. data/lib/stripe/services/radar/early_fraud_warning_service.rb +70 -0
  292. data/lib/stripe/services/radar/value_list_item_service.rb +90 -0
  293. data/lib/stripe/services/radar/value_list_service.rb +119 -0
  294. data/lib/stripe/services/refund_service.rb +158 -0
  295. data/lib/stripe/services/reporting/report_run_service.rb +122 -0
  296. data/lib/stripe/services/reporting/report_type_service.rb +18 -0
  297. data/lib/stripe/services/review_service.rb +63 -0
  298. data/lib/stripe/services/setup_attempt_service.rb +59 -0
  299. data/lib/stripe/services/setup_intent_service.rb +3923 -0
  300. data/lib/stripe/services/shipping_rate_service.rb +227 -0
  301. data/lib/stripe/services/sigma/scheduled_query_run_service.rb +30 -0
  302. data/lib/stripe/services/source_service.rb +693 -0
  303. data/lib/stripe/services/source_transaction_service.rb +21 -0
  304. data/lib/stripe/services/subscription_item_service.rb +439 -0
  305. data/lib/stripe/services/subscription_item_usage_record_service.rb +21 -0
  306. data/lib/stripe/services/subscription_item_usage_record_summary_service.rb +21 -0
  307. data/lib/stripe/services/subscription_schedule_service.rb +2343 -0
  308. data/lib/stripe/services/subscription_service.rb +1967 -0
  309. data/lib/stripe/services/tax/association_service.rb +32 -0
  310. data/lib/stripe/services/tax/calculation_line_item_service.rb +21 -0
  311. data/lib/stripe/services/tax/calculation_service.rb +235 -0
  312. data/lib/stripe/services/tax/form_service.rb +107 -0
  313. data/lib/stripe/services/tax/registration_service.rb +1398 -0
  314. data/lib/stripe/services/tax/settings_service.rb +82 -0
  315. data/lib/stripe/services/tax/transaction_line_item_service.rb +21 -0
  316. data/lib/stripe/services/tax/transaction_service.rb +128 -0
  317. data/lib/stripe/services/tax_code_service.rb +30 -0
  318. data/lib/stripe/services/tax_id_service.rb +90 -0
  319. data/lib/stripe/services/tax_rate_service.rb +182 -0
  320. data/lib/stripe/services/tax_service.rb +3 -1
  321. data/lib/stripe/services/terminal/configuration_service.rb +901 -0
  322. data/lib/stripe/services/terminal/connection_token_service.rb +13 -0
  323. data/lib/stripe/services/terminal/location_service.rb +165 -0
  324. data/lib/stripe/services/terminal/reader_collected_data_service.rb +28 -0
  325. data/lib/stripe/services/terminal/reader_service.rb +496 -0
  326. data/lib/stripe/services/terminal_service.rb +2 -1
  327. data/lib/stripe/services/test_helpers/confirmation_token_service.rb +762 -0
  328. data/lib/stripe/services/test_helpers/customer_service.rb +21 -0
  329. data/lib/stripe/services/test_helpers/issuing/authorization_service.rb +844 -0
  330. data/lib/stripe/services/test_helpers/issuing/card_service.rb +45 -0
  331. data/lib/stripe/services/test_helpers/issuing/personalization_design_service.rb +43 -0
  332. data/lib/stripe/services/test_helpers/issuing/transaction_service.rb +723 -0
  333. data/lib/stripe/services/test_helpers/refund_service.rb +9 -0
  334. data/lib/stripe/services/test_helpers/terminal/reader_service.rb +48 -0
  335. data/lib/stripe/services/test_helpers/test_clock_service.rb +63 -0
  336. data/lib/stripe/services/test_helpers/treasury/inbound_transfer_service.rb +39 -0
  337. data/lib/stripe/services/test_helpers/treasury/outbound_payment_service.rb +93 -0
  338. data/lib/stripe/services/test_helpers/treasury/outbound_transfer_service.rb +93 -0
  339. data/lib/stripe/services/test_helpers/treasury/received_credit_service.rb +95 -0
  340. data/lib/stripe/services/test_helpers/treasury/received_debit_service.rb +95 -0
  341. data/lib/stripe/services/token_service.rb +1301 -0
  342. data/lib/stripe/services/topup_service.rb +163 -0
  343. data/lib/stripe/services/transfer_reversal_service.rb +74 -0
  344. data/lib/stripe/services/transfer_service.rb +138 -0
  345. data/lib/stripe/services/treasury/credit_reversal_service.rb +67 -0
  346. data/lib/stripe/services/treasury/debit_reversal_service.rb +72 -0
  347. data/lib/stripe/services/treasury/financial_account_features_service.rb +179 -0
  348. data/lib/stripe/services/treasury/financial_account_service.rb +481 -0
  349. data/lib/stripe/services/treasury/inbound_transfer_service.rb +100 -0
  350. data/lib/stripe/services/treasury/outbound_payment_service.rb +296 -0
  351. data/lib/stripe/services/treasury/outbound_transfer_service.rb +147 -0
  352. data/lib/stripe/services/treasury/received_credit_service.rb +58 -0
  353. data/lib/stripe/services/treasury/received_debit_service.rb +45 -0
  354. data/lib/stripe/services/treasury/transaction_entry_service.rb +101 -0
  355. data/lib/stripe/services/treasury/transaction_service.rb +109 -0
  356. data/lib/stripe/services/v1_services.rb +8 -1
  357. data/lib/stripe/services/v2/billing/meter_event_adjustment_service.rb +25 -0
  358. data/lib/stripe/services/v2/billing/meter_event_service.rb +28 -0
  359. data/lib/stripe/services/v2/billing/meter_event_session_service.rb +3 -0
  360. data/lib/stripe/services/v2/billing/meter_event_stream_service.rb +36 -0
  361. data/lib/stripe/services/v2/core/event_destination_service.rb +164 -0
  362. data/lib/stripe/services/v2/core/event_service.rb +20 -0
  363. data/lib/stripe/services/webhook_endpoint_service.rb +110 -0
  364. data/lib/stripe/services.rb +25 -0
  365. data/lib/stripe/stripe_client.rb +2 -2
  366. data/lib/stripe/stripe_configuration.rb +3 -1
  367. data/lib/stripe/stripe_object.rb +8 -3
  368. data/lib/stripe/util.rb +8 -2
  369. data/lib/stripe/version.rb +1 -1
  370. data/lib/stripe.rb +46 -0
  371. data/rbi/stripe/resources/account.rbi +6072 -0
  372. data/rbi/stripe/resources/account_link.rbi +87 -0
  373. data/rbi/stripe/resources/account_notice.rbi +166 -0
  374. data/rbi/stripe/resources/account_session.rbi +1173 -0
  375. data/rbi/stripe/resources/apple_pay_domain.rbi +111 -0
  376. data/rbi/stripe/resources/application.rbi +23 -0
  377. data/rbi/stripe/resources/application_fee.rbi +151 -0
  378. data/rbi/stripe/resources/application_fee_refund.rbi +44 -0
  379. data/rbi/stripe/resources/apps/secret.rbi +229 -0
  380. data/rbi/stripe/resources/balance.rbi +220 -0
  381. data/rbi/stripe/resources/balance_transaction.rbi +182 -0
  382. data/rbi/stripe/resources/bank_account.rbi +156 -0
  383. data/rbi/stripe/resources/billing/alert.rbi +237 -0
  384. data/rbi/stripe/resources/billing/alert_triggered.rbi +33 -0
  385. data/rbi/stripe/resources/billing/credit_balance_summary.rbi +118 -0
  386. data/rbi/stripe/resources/billing/credit_balance_transaction.rbi +181 -0
  387. data/rbi/stripe/resources/billing/credit_grant.rbi +312 -0
  388. data/rbi/stripe/resources/billing/meter.rbi +268 -0
  389. data/rbi/stripe/resources/billing/meter_error_report.rbi +82 -0
  390. data/rbi/stripe/resources/billing/meter_event.rbi +76 -0
  391. data/rbi/stripe/resources/billing/meter_event_adjustment.rbi +75 -0
  392. data/rbi/stripe/resources/billing/meter_event_summary.rbi +39 -0
  393. data/rbi/stripe/resources/billing_portal/configuration.rbi +746 -0
  394. data/rbi/stripe/resources/billing_portal/session.rbi +396 -0
  395. data/rbi/stripe/resources/capability.rbi +152 -0
  396. data/rbi/stripe/resources/capital/financing_offer.rbi +228 -0
  397. data/rbi/stripe/resources/capital/financing_summary.rbi +89 -0
  398. data/rbi/stripe/resources/capital/financing_transaction.rbi +157 -0
  399. data/rbi/stripe/resources/card.rbi +159 -0
  400. data/rbi/stripe/resources/cash_balance.rbi +37 -0
  401. data/rbi/stripe/resources/charge.rbi +4216 -0
  402. data/rbi/stripe/resources/checkout/session.rbi +4627 -0
  403. data/rbi/stripe/resources/climate/order.rbi +298 -0
  404. data/rbi/stripe/resources/climate/product.rbi +98 -0
  405. data/rbi/stripe/resources/climate/supplier.rbi +95 -0
  406. data/rbi/stripe/resources/confirmation_token.rbi +2137 -0
  407. data/rbi/stripe/resources/connect_collection_transfer.rbi +31 -0
  408. data/rbi/stripe/resources/country_spec.rbi +108 -0
  409. data/rbi/stripe/resources/coupon.rbi +305 -0
  410. data/rbi/stripe/resources/credit_note.rbi +918 -0
  411. data/rbi/stripe/resources/credit_note_line_item.rbi +123 -0
  412. data/rbi/stripe/resources/customer.rbi +1188 -0
  413. data/rbi/stripe/resources/customer_balance_transaction.rbi +65 -0
  414. data/rbi/stripe/resources/customer_cash_balance_transaction.rbi +178 -0
  415. data/rbi/stripe/resources/customer_session.rbi +227 -0
  416. data/rbi/stripe/resources/discount.rbi +65 -0
  417. data/rbi/stripe/resources/dispute.rbi +926 -0
  418. data/rbi/stripe/resources/entitlements/active_entitlement.rbi +76 -0
  419. data/rbi/stripe/resources/entitlements/active_entitlement_summary.rbi +26 -0
  420. data/rbi/stripe/resources/entitlements/feature.rbi +146 -0
  421. data/rbi/stripe/resources/ephemeral_key.rbi +51 -0
  422. data/rbi/stripe/resources/event.rbi +221 -0
  423. data/rbi/stripe/resources/exchange_rate.rbi +81 -0
  424. data/rbi/stripe/resources/file.rbi +177 -0
  425. data/rbi/stripe/resources/file_link.rbi +174 -0
  426. data/rbi/stripe/resources/financial_connections/account.rbi +414 -0
  427. data/rbi/stripe/resources/financial_connections/account_inferred_balance.rbi +30 -0
  428. data/rbi/stripe/resources/financial_connections/account_owner.rbi +42 -0
  429. data/rbi/stripe/resources/financial_connections/account_ownership.rbi +26 -0
  430. data/rbi/stripe/resources/financial_connections/institution.rbi +115 -0
  431. data/rbi/stripe/resources/financial_connections/session.rbi +221 -0
  432. data/rbi/stripe/resources/financial_connections/transaction.rbi +153 -0
  433. data/rbi/stripe/resources/forwarding/request.rbi +257 -0
  434. data/rbi/stripe/resources/funding_instructions.rbi +544 -0
  435. data/rbi/stripe/resources/gift_cards/card.rbi +242 -0
  436. data/rbi/stripe/resources/gift_cards/transaction.rbi +298 -0
  437. data/rbi/stripe/resources/identity/verification_report.rbi +427 -0
  438. data/rbi/stripe/resources/identity/verification_session.rbi +601 -0
  439. data/rbi/stripe/resources/invoice.rbi +10584 -0
  440. data/rbi/stripe/resources/invoice_item.rbi +621 -0
  441. data/rbi/stripe/resources/invoice_line_item.rbi +486 -0
  442. data/rbi/stripe/resources/invoice_payment.rbi +86 -0
  443. data/rbi/stripe/resources/invoice_rendering_template.rbi +131 -0
  444. data/rbi/stripe/resources/issuing/authorization.rbi +1511 -0
  445. data/rbi/stripe/resources/issuing/card.rbi +891 -0
  446. data/rbi/stripe/resources/issuing/cardholder.rbi +870 -0
  447. data/rbi/stripe/resources/issuing/credit_underwriting_record.rbi +731 -0
  448. data/rbi/stripe/resources/issuing/dispute.rbi +1077 -0
  449. data/rbi/stripe/resources/issuing/dispute_settlement_detail.rbi +100 -0
  450. data/rbi/stripe/resources/issuing/fraud_liability_debit.rbi +108 -0
  451. data/rbi/stripe/resources/issuing/personalization_design.rbi +395 -0
  452. data/rbi/stripe/resources/issuing/physical_bundle.rbi +102 -0
  453. data/rbi/stripe/resources/issuing/settlement.rbi +78 -0
  454. data/rbi/stripe/resources/issuing/token.rbi +282 -0
  455. data/rbi/stripe/resources/issuing/transaction.rbi +1262 -0
  456. data/rbi/stripe/resources/line_item.rbi +131 -0
  457. data/rbi/stripe/resources/login_link.rbi +20 -0
  458. data/rbi/stripe/resources/mandate.rbi +266 -0
  459. data/rbi/stripe/resources/margin.rbi +151 -0
  460. data/rbi/stripe/resources/order.rbi +3505 -0
  461. data/rbi/stripe/resources/payment_attempt_record.rbi +260 -0
  462. data/rbi/stripe/resources/payment_intent.rbi +16064 -0
  463. data/rbi/stripe/resources/payment_link.rbi +1943 -0
  464. data/rbi/stripe/resources/payment_method.rbi +2287 -0
  465. data/rbi/stripe/resources/payment_method_configuration.rbi +3657 -0
  466. data/rbi/stripe/resources/payment_method_domain.rbi +246 -0
  467. data/rbi/stripe/resources/payment_record.rbi +856 -0
  468. data/rbi/stripe/resources/payout.rbi +357 -0
  469. data/rbi/stripe/resources/person.rbi +461 -0
  470. data/rbi/stripe/resources/plan.rbi +463 -0
  471. data/rbi/stripe/resources/price.rbi +884 -0
  472. data/rbi/stripe/resources/product.rbi +735 -0
  473. data/rbi/stripe/resources/product_feature.rbi +30 -0
  474. data/rbi/stripe/resources/promotion_code.rbi +316 -0
  475. data/rbi/stripe/resources/quote.rbi +3779 -0
  476. data/rbi/stripe/resources/quote_line.rbi +416 -0
  477. data/rbi/stripe/resources/quote_preview_invoice.rbi +1030 -0
  478. data/rbi/stripe/resources/quote_preview_subscription_schedule.rbi +575 -0
  479. data/rbi/stripe/resources/radar/early_fraud_warning.rbi +121 -0
  480. data/rbi/stripe/resources/radar/value_list.rbi +207 -0
  481. data/rbi/stripe/resources/radar/value_list_item.rbi +157 -0
  482. data/rbi/stripe/resources/refund.rbi +615 -0
  483. data/rbi/stripe/resources/reporting/report_run.rbi +232 -0
  484. data/rbi/stripe/resources/reporting/report_type.rbi +75 -0
  485. data/rbi/stripe/resources/reserve_transaction.rbi +27 -0
  486. data/rbi/stripe/resources/reversal.rbi +60 -0
  487. data/rbi/stripe/resources/review.rbi +191 -0
  488. data/rbi/stripe/resources/setup_attempt.rbi +587 -0
  489. data/rbi/stripe/resources/setup_intent.rbi +4726 -0
  490. data/rbi/stripe/resources/shipping_rate.rbi +367 -0
  491. data/rbi/stripe/resources/sigma/scheduled_query_run.rbi +98 -0
  492. data/rbi/stripe/resources/source.rbi +1899 -0
  493. data/rbi/stripe/resources/source_mandate_notification.rbi +90 -0
  494. data/rbi/stripe/resources/source_transaction.rbi +156 -0
  495. data/rbi/stripe/resources/subscription.rbi +2739 -0
  496. data/rbi/stripe/resources/subscription_item.rbi +566 -0
  497. data/rbi/stripe/resources/subscription_schedule.rbi +3157 -0
  498. data/rbi/stripe/resources/tax/association.rbi +107 -0
  499. data/rbi/stripe/resources/tax/calculation.rbi +577 -0
  500. data/rbi/stripe/resources/tax/calculation_line_item.rbi +108 -0
  501. data/rbi/stripe/resources/tax/form.rbi +262 -0
  502. data/rbi/stripe/resources/tax/registration.rbi +2354 -0
  503. data/rbi/stripe/resources/tax/settings.rbi +174 -0
  504. data/rbi/stripe/resources/tax/transaction.rbi +428 -0
  505. data/rbi/stripe/resources/tax/transaction_line_item.rbi +66 -0
  506. data/rbi/stripe/resources/tax_code.rbi +60 -0
  507. data/rbi/stripe/resources/tax_deducted_at_source.rbi +27 -0
  508. data/rbi/stripe/resources/tax_id.rbi +206 -0
  509. data/rbi/stripe/resources/tax_rate.rbi +295 -0
  510. data/rbi/stripe/resources/terminal/configuration.rbi +1302 -0
  511. data/rbi/stripe/resources/terminal/connection_token.rbi +42 -0
  512. data/rbi/stripe/resources/terminal/location.rbi +271 -0
  513. data/rbi/stripe/resources/terminal/reader.rbi +1110 -0
  514. data/rbi/stripe/resources/terminal/reader_collected_data.rbi +48 -0
  515. data/rbi/stripe/resources/test_helpers/test_clock.rbi +159 -0
  516. data/rbi/stripe/resources/token.rbi +1405 -0
  517. data/rbi/stripe/resources/topup.rbi +269 -0
  518. data/rbi/stripe/resources/transfer.rbi +245 -0
  519. data/rbi/stripe/resources/treasury/credit_reversal.rbi +151 -0
  520. data/rbi/stripe/resources/treasury/debit_reversal.rbi +165 -0
  521. data/rbi/stripe/resources/treasury/financial_account.rbi +924 -0
  522. data/rbi/stripe/resources/treasury/financial_account_features.rbi +309 -0
  523. data/rbi/stripe/resources/treasury/inbound_transfer.rbi +361 -0
  524. data/rbi/stripe/resources/treasury/outbound_payment.rbi +702 -0
  525. data/rbi/stripe/resources/treasury/outbound_transfer.rbi +529 -0
  526. data/rbi/stripe/resources/treasury/received_credit.rbi +408 -0
  527. data/rbi/stripe/resources/treasury/received_debit.rbi +367 -0
  528. data/rbi/stripe/resources/treasury/transaction.rbi +261 -0
  529. data/rbi/stripe/resources/treasury/transaction_entry.rbi +234 -0
  530. data/rbi/stripe/resources/usage_record.rbi +37 -0
  531. data/rbi/stripe/resources/usage_record_summary.rbi +45 -0
  532. data/rbi/stripe/resources/v2/amount.rbi +14 -0
  533. data/rbi/stripe/resources/v2/billing/meter_event.rbi +43 -0
  534. data/rbi/stripe/resources/v2/billing/meter_event_adjustment.rbi +48 -0
  535. data/rbi/stripe/resources/v2/billing/meter_event_session.rbi +36 -0
  536. data/rbi/stripe/resources/v2/event.rbi +55 -0
  537. data/rbi/stripe/resources/v2/event_destination.rbi +109 -0
  538. data/rbi/stripe/resources/webhook_endpoint.rbi +208 -0
  539. data/rbi/stripe/services/account_capability_service.rbi +55 -0
  540. data/rbi/stripe/services/account_external_account_service.rbi +358 -0
  541. data/rbi/stripe/services/account_link_service.rbi +67 -0
  542. data/rbi/stripe/services/account_login_link_service.rbi +23 -0
  543. data/rbi/stripe/services/account_notice_service.rbi +103 -0
  544. data/rbi/stripe/services/account_person_service.rbi +1077 -0
  545. data/rbi/stripe/services/account_service.rbi +4948 -0
  546. data/rbi/stripe/services/account_session_service.rbi +873 -0
  547. data/rbi/stripe/services/apple_pay_domain_service.rbi +86 -0
  548. data/rbi/stripe/services/application_fee_refund_service.rbi +101 -0
  549. data/rbi/stripe/services/application_fee_service.rbi +85 -0
  550. data/rbi/stripe/services/apps/secret_service.rbi +175 -0
  551. data/rbi/stripe/services/apps_service.rbi +9 -0
  552. data/rbi/stripe/services/balance_service.rbi +22 -0
  553. data/rbi/stripe/services/balance_transaction_service.rbi +103 -0
  554. data/rbi/stripe/services/billing/alert_service.rbi +172 -0
  555. data/rbi/stripe/services/billing/credit_balance_summary_service.rbi +61 -0
  556. data/rbi/stripe/services/billing/credit_balance_transaction_service.rbi +66 -0
  557. data/rbi/stripe/services/billing/credit_grant_service.rbi +217 -0
  558. data/rbi/stripe/services/billing/meter_event_adjustment_service.rbi +45 -0
  559. data/rbi/stripe/services/billing/meter_event_service.rbi +47 -0
  560. data/rbi/stripe/services/billing/meter_event_summary_service.rbi +62 -0
  561. data/rbi/stripe/services/billing/meter_service.rbi +184 -0
  562. data/rbi/stripe/services/billing_portal/configuration_service.rbi +573 -0
  563. data/rbi/stripe/services/billing_portal/session_service.rbi +233 -0
  564. data/rbi/stripe/services/billing_portal_service.rbi +10 -0
  565. data/rbi/stripe/services/billing_service.rbi +15 -0
  566. data/rbi/stripe/services/capital/financing_offer_service.rbi +108 -0
  567. data/rbi/stripe/services/capital/financing_summary_service.rbi +23 -0
  568. data/rbi/stripe/services/capital/financing_transaction_service.rbi +77 -0
  569. data/rbi/stripe/services/capital_service.rbi +11 -0
  570. data/rbi/stripe/services/charge_service.rbi +2162 -0
  571. data/rbi/stripe/services/checkout/session_line_item_service.rbi +37 -0
  572. data/rbi/stripe/services/checkout/session_service.rbi +2975 -0
  573. data/rbi/stripe/services/checkout_service.rbi +9 -0
  574. data/rbi/stripe/services/climate/order_service.rbi +158 -0
  575. data/rbi/stripe/services/climate/product_service.rbi +51 -0
  576. data/rbi/stripe/services/climate/supplier_service.rbi +51 -0
  577. data/rbi/stripe/services/climate_service.rbi +11 -0
  578. data/rbi/stripe/services/confirmation_token_service.rbi +21 -0
  579. data/rbi/stripe/services/country_spec_service.rbi +49 -0
  580. data/rbi/stripe/services/coupon_service.rbi +220 -0
  581. data/rbi/stripe/services/credit_note_line_item_service.rbi +35 -0
  582. data/rbi/stripe/services/credit_note_preview_lines_service.rbi +200 -0
  583. data/rbi/stripe/services/credit_note_service.rbi +496 -0
  584. data/rbi/stripe/services/customer_balance_transaction_service.rbi +105 -0
  585. data/rbi/stripe/services/customer_cash_balance_service.rbi +49 -0
  586. data/rbi/stripe/services/customer_cash_balance_transaction_service.rbi +49 -0
  587. data/rbi/stripe/services/customer_funding_instructions_service.rbi +67 -0
  588. data/rbi/stripe/services/customer_payment_method_service.rbi +64 -0
  589. data/rbi/stripe/services/customer_payment_source_service.rbi +265 -0
  590. data/rbi/stripe/services/customer_service.rbi +763 -0
  591. data/rbi/stripe/services/customer_session_service.rbi +126 -0
  592. data/rbi/stripe/services/customer_tax_id_service.rbi +80 -0
  593. data/rbi/stripe/services/dispute_service.rbi +500 -0
  594. data/rbi/stripe/services/entitlements/active_entitlement_service.rbi +61 -0
  595. data/rbi/stripe/services/entitlements/feature_service.rbi +122 -0
  596. data/rbi/stripe/services/entitlements_service.rbi +10 -0
  597. data/rbi/stripe/services/ephemeral_key_service.rbi +59 -0
  598. data/rbi/stripe/services/event_service.rbi +94 -0
  599. data/rbi/stripe/services/exchange_rate_service.rbi +49 -0
  600. data/rbi/stripe/services/file_link_service.rbi +141 -0
  601. data/rbi/stripe/services/file_service.rbi +132 -0
  602. data/rbi/stripe/services/financial_connections/account_inferred_balance_service.rbi +37 -0
  603. data/rbi/stripe/services/financial_connections/account_owner_service.rbi +47 -0
  604. data/rbi/stripe/services/financial_connections/account_service.rbi +148 -0
  605. data/rbi/stripe/services/financial_connections/institution_service.rbi +51 -0
  606. data/rbi/stripe/services/financial_connections/session_service.rbi +128 -0
  607. data/rbi/stripe/services/financial_connections/transaction_service.rbi +103 -0
  608. data/rbi/stripe/services/financial_connections_service.rbi +12 -0
  609. data/rbi/stripe/services/forwarding/request_service.rbi +152 -0
  610. data/rbi/stripe/services/forwarding_service.rbi +9 -0
  611. data/rbi/stripe/services/gift_cards/card_service.rbi +162 -0
  612. data/rbi/stripe/services/gift_cards/transaction_service.rbi +198 -0
  613. data/rbi/stripe/services/gift_cards_service.rbi +10 -0
  614. data/rbi/stripe/services/identity/verification_report_service.rbi +98 -0
  615. data/rbi/stripe/services/identity/verification_session_service.rbi +360 -0
  616. data/rbi/stripe/services/identity_service.rbi +10 -0
  617. data/rbi/stripe/services/invoice_item_service.rbi +505 -0
  618. data/rbi/stripe/services/invoice_line_item_service.rbi +320 -0
  619. data/rbi/stripe/services/invoice_payment_service.rbi +49 -0
  620. data/rbi/stripe/services/invoice_rendering_template_service.rbi +91 -0
  621. data/rbi/stripe/services/invoice_service.rbi +7138 -0
  622. data/rbi/stripe/services/invoice_upcoming_lines_service.rbi +2397 -0
  623. data/rbi/stripe/services/issuing/authorization_service.rbi +160 -0
  624. data/rbi/stripe/services/issuing/card_service.rbi +568 -0
  625. data/rbi/stripe/services/issuing/cardholder_service.rbi +668 -0
  626. data/rbi/stripe/services/issuing/credit_underwriting_record_service.rbi +580 -0
  627. data/rbi/stripe/services/issuing/dispute_service.rbi +824 -0
  628. data/rbi/stripe/services/issuing/dispute_settlement_detail_service.rbi +61 -0
  629. data/rbi/stripe/services/issuing/fraud_liability_debit_service.rbi +83 -0
  630. data/rbi/stripe/services/issuing/personalization_design_service.rbi +271 -0
  631. data/rbi/stripe/services/issuing/physical_bundle_service.rbi +66 -0
  632. data/rbi/stripe/services/issuing/token_service.rbi +109 -0
  633. data/rbi/stripe/services/issuing/transaction_service.rbi +119 -0
  634. data/rbi/stripe/services/issuing_service.rbi +19 -0
  635. data/rbi/stripe/services/mandate_service.rbi +21 -0
  636. data/rbi/stripe/services/margin_service.rbi +119 -0
  637. data/rbi/stripe/services/order_line_item_service.rbi +35 -0
  638. data/rbi/stripe/services/order_service.rbi +2669 -0
  639. data/rbi/stripe/services/payment_attempt_record_service.rbi +39 -0
  640. data/rbi/stripe/services/payment_intent_service.rbi +13193 -0
  641. data/rbi/stripe/services/payment_link_line_item_service.rbi +35 -0
  642. data/rbi/stripe/services/payment_link_service.rbi +1447 -0
  643. data/rbi/stripe/services/payment_method_configuration_service.rbi +2465 -0
  644. data/rbi/stripe/services/payment_method_domain_service.rbi +123 -0
  645. data/rbi/stripe/services/payment_method_service.rbi +1032 -0
  646. data/rbi/stripe/services/payment_record_service.rbi +613 -0
  647. data/rbi/stripe/services/payout_service.rbi +228 -0
  648. data/rbi/stripe/services/plan_service.rbi +337 -0
  649. data/rbi/stripe/services/price_service.rbi +657 -0
  650. data/rbi/stripe/services/product_feature_service.rbi +76 -0
  651. data/rbi/stripe/services/product_service.rbi +596 -0
  652. data/rbi/stripe/services/promotion_code_service.rbi +244 -0
  653. data/rbi/stripe/services/quote_computed_upfront_line_items_service.rbi +35 -0
  654. data/rbi/stripe/services/quote_line_item_service.rbi +35 -0
  655. data/rbi/stripe/services/quote_line_service.rbi +35 -0
  656. data/rbi/stripe/services/quote_preview_invoice_service.rbi +35 -0
  657. data/rbi/stripe/services/quote_preview_subscription_schedule_service.rbi +35 -0
  658. data/rbi/stripe/services/quote_service.rbi +2830 -0
  659. data/rbi/stripe/services/radar/early_fraud_warning_service.rbi +95 -0
  660. data/rbi/stripe/services/radar/value_list_item_service.rbi +122 -0
  661. data/rbi/stripe/services/radar/value_list_service.rbi +160 -0
  662. data/rbi/stripe/services/radar_service.rbi +11 -0
  663. data/rbi/stripe/services/refund_service.rbi +208 -0
  664. data/rbi/stripe/services/reporting/report_run_service.rbi +152 -0
  665. data/rbi/stripe/services/reporting/report_type_service.rbi +37 -0
  666. data/rbi/stripe/services/reporting_service.rbi +10 -0
  667. data/rbi/stripe/services/review_service.rbi +93 -0
  668. data/rbi/stripe/services/setup_attempt_service.rbi +73 -0
  669. data/rbi/stripe/services/setup_intent_service.rbi +4204 -0
  670. data/rbi/stripe/services/shipping_rate_service.rbi +274 -0
  671. data/rbi/stripe/services/sigma/scheduled_query_run_service.rbi +51 -0
  672. data/rbi/stripe/services/sigma_service.rbi +9 -0
  673. data/rbi/stripe/services/source_service.rbi +766 -0
  674. data/rbi/stripe/services/source_transaction_service.rbi +35 -0
  675. data/rbi/stripe/services/subscription_item_service.rbi +496 -0
  676. data/rbi/stripe/services/subscription_item_usage_record_service.rbi +41 -0
  677. data/rbi/stripe/services/subscription_item_usage_record_summary_service.rbi +37 -0
  678. data/rbi/stripe/services/subscription_schedule_service.rbi +2613 -0
  679. data/rbi/stripe/services/subscription_service.rbi +2207 -0
  680. data/rbi/stripe/services/tax/association_service.rbi +27 -0
  681. data/rbi/stripe/services/tax/calculation_line_item_service.rbi +37 -0
  682. data/rbi/stripe/services/tax/calculation_service.rbi +267 -0
  683. data/rbi/stripe/services/tax/form_service.rbi +96 -0
  684. data/rbi/stripe/services/tax/registration_service.rbi +1495 -0
  685. data/rbi/stripe/services/tax/settings_service.rbi +106 -0
  686. data/rbi/stripe/services/tax/transaction_line_item_service.rbi +37 -0
  687. data/rbi/stripe/services/tax/transaction_service.rbi +164 -0
  688. data/rbi/stripe/services/tax_code_service.rbi +49 -0
  689. data/rbi/stripe/services/tax_id_service.rbi +128 -0
  690. data/rbi/stripe/services/tax_rate_service.rbi +215 -0
  691. data/rbi/stripe/services/tax_service.rbi +14 -0
  692. data/rbi/stripe/services/terminal/configuration_service.rbi +976 -0
  693. data/rbi/stripe/services/terminal/connection_token_service.rbi +27 -0
  694. data/rbi/stripe/services/terminal/location_service.rbi +211 -0
  695. data/rbi/stripe/services/terminal/reader_collected_data_service.rbi +23 -0
  696. data/rbi/stripe/services/terminal/reader_service.rbi +591 -0
  697. data/rbi/stripe/services/terminal_service.rbi +13 -0
  698. data/rbi/stripe/services/test_helpers/confirmation_token_service.rbi +892 -0
  699. data/rbi/stripe/services/test_helpers/customer_service.rbi +37 -0
  700. data/rbi/stripe/services/test_helpers/issuing/authorization_service.rbi +974 -0
  701. data/rbi/stripe/services/test_helpers/issuing/card_service.rbi +81 -0
  702. data/rbi/stripe/services/test_helpers/issuing/personalization_design_service.rbi +73 -0
  703. data/rbi/stripe/services/test_helpers/issuing/transaction_service.rbi +825 -0
  704. data/rbi/stripe/services/test_helpers/issuing_service.rbi +14 -0
  705. data/rbi/stripe/services/test_helpers/refund_service.rbi +23 -0
  706. data/rbi/stripe/services/test_helpers/terminal/reader_service.rbi +69 -0
  707. data/rbi/stripe/services/test_helpers/terminal_service.rbi +11 -0
  708. data/rbi/stripe/services/test_helpers/test_clock_service.rbi +100 -0
  709. data/rbi/stripe/services/test_helpers/treasury/inbound_transfer_service.rbi +69 -0
  710. data/rbi/stripe/services/test_helpers/treasury/outbound_payment_service.rbi +137 -0
  711. data/rbi/stripe/services/test_helpers/treasury/outbound_transfer_service.rbi +137 -0
  712. data/rbi/stripe/services/test_helpers/treasury/received_credit_service.rbi +130 -0
  713. data/rbi/stripe/services/test_helpers/treasury/received_debit_service.rbi +130 -0
  714. data/rbi/stripe/services/test_helpers/treasury_service.rbi +15 -0
  715. data/rbi/stripe/services/test_helpers_service.rbi +15 -0
  716. data/rbi/stripe/services/token_service.rbi +1357 -0
  717. data/rbi/stripe/services/topup_service.rbi +200 -0
  718. data/rbi/stripe/services/transfer_reversal_service.rbi +111 -0
  719. data/rbi/stripe/services/transfer_service.rbi +174 -0
  720. data/rbi/stripe/services/treasury/credit_reversal_service.rbi +95 -0
  721. data/rbi/stripe/services/treasury/debit_reversal_service.rbi +100 -0
  722. data/rbi/stripe/services/treasury/financial_account_features_service.rbi +226 -0
  723. data/rbi/stripe/services/treasury/financial_account_service.rbi +577 -0
  724. data/rbi/stripe/services/treasury/inbound_transfer_service.rbi +133 -0
  725. data/rbi/stripe/services/treasury/outbound_payment_service.rbi +350 -0
  726. data/rbi/stripe/services/treasury/outbound_transfer_service.rbi +189 -0
  727. data/rbi/stripe/services/treasury/received_credit_service.rbi +79 -0
  728. data/rbi/stripe/services/treasury/received_debit_service.rbi +66 -0
  729. data/rbi/stripe/services/treasury/transaction_entry_service.rbi +125 -0
  730. data/rbi/stripe/services/treasury/transaction_service.rbi +133 -0
  731. data/rbi/stripe/services/treasury_service.rbi +18 -0
  732. data/rbi/stripe/services/v1_services.rbi +83 -0
  733. data/rbi/stripe/services/v2/billing/meter_event_adjustment_service.rbi +43 -0
  734. data/rbi/stripe/services/v2/billing/meter_event_service.rbi +46 -0
  735. data/rbi/stripe/services/v2/billing/meter_event_session_service.rbi +20 -0
  736. data/rbi/stripe/services/v2/billing/meter_event_stream_service.rbi +60 -0
  737. data/rbi/stripe/services/v2/billing_service.rbi +14 -0
  738. data/rbi/stripe/services/v2/core/event_destination_service.rbi +228 -0
  739. data/rbi/stripe/services/v2/core/event_service.rbi +42 -0
  740. data/rbi/stripe/services/v2/core_service.rbi +12 -0
  741. data/rbi/stripe/services/v2_services.rbi +10 -0
  742. data/rbi/stripe/services/webhook_endpoint_service.rbi +149 -0
  743. metadata +435 -4
@@ -0,0 +1,1899 @@
1
+ # File generated from our OpenAPI spec
2
+ # frozen_string_literal: true
3
+
4
+ # typed: true
5
+ module Stripe
6
+ # `Source` objects allow you to accept a variety of payment methods. They
7
+ # represent a customer's payment instrument, and can be used with the Stripe API
8
+ # just like a `Card` object: once chargeable, they can be charged, or can be
9
+ # attached to customers.
10
+ #
11
+ # Stripe doesn't recommend using the deprecated [Sources API](https://stripe.com/docs/api/sources).
12
+ # We recommend that you adopt the [PaymentMethods API](https://stripe.com/docs/api/payment_methods).
13
+ # This newer API provides access to our latest features and payment method types.
14
+ #
15
+ # Related guides: [Sources API](https://stripe.com/docs/sources) and [Sources & Customers](https://stripe.com/docs/sources/customers).
16
+ class Source < APIResource
17
+ class AchCreditTransfer < Stripe::StripeObject
18
+ # Attribute for field account_number
19
+ sig { returns(T.nilable(String)) }
20
+ attr_reader :account_number
21
+
22
+ # Attribute for field bank_name
23
+ sig { returns(T.nilable(String)) }
24
+ attr_reader :bank_name
25
+
26
+ # Attribute for field fingerprint
27
+ sig { returns(T.nilable(String)) }
28
+ attr_reader :fingerprint
29
+
30
+ # Attribute for field refund_account_holder_name
31
+ sig { returns(T.nilable(String)) }
32
+ attr_reader :refund_account_holder_name
33
+
34
+ # Attribute for field refund_account_holder_type
35
+ sig { returns(T.nilable(String)) }
36
+ attr_reader :refund_account_holder_type
37
+
38
+ # Attribute for field refund_routing_number
39
+ sig { returns(T.nilable(String)) }
40
+ attr_reader :refund_routing_number
41
+
42
+ # Attribute for field routing_number
43
+ sig { returns(T.nilable(String)) }
44
+ attr_reader :routing_number
45
+
46
+ # Attribute for field swift_code
47
+ sig { returns(T.nilable(String)) }
48
+ attr_reader :swift_code
49
+ end
50
+ class AchDebit < Stripe::StripeObject
51
+ # Attribute for field bank_name
52
+ sig { returns(T.nilable(String)) }
53
+ attr_reader :bank_name
54
+
55
+ # Attribute for field country
56
+ sig { returns(T.nilable(String)) }
57
+ attr_reader :country
58
+
59
+ # Attribute for field fingerprint
60
+ sig { returns(T.nilable(String)) }
61
+ attr_reader :fingerprint
62
+
63
+ # Attribute for field last4
64
+ sig { returns(T.nilable(String)) }
65
+ attr_reader :last4
66
+
67
+ # Attribute for field routing_number
68
+ sig { returns(T.nilable(String)) }
69
+ attr_reader :routing_number
70
+
71
+ # Attribute for field type
72
+ sig { returns(T.nilable(String)) }
73
+ attr_reader :type
74
+ end
75
+ class AcssDebit < Stripe::StripeObject
76
+ # Attribute for field bank_address_city
77
+ sig { returns(T.nilable(String)) }
78
+ attr_reader :bank_address_city
79
+
80
+ # Attribute for field bank_address_line_1
81
+ sig { returns(T.nilable(String)) }
82
+ attr_reader :bank_address_line_1
83
+
84
+ # Attribute for field bank_address_line_2
85
+ sig { returns(T.nilable(String)) }
86
+ attr_reader :bank_address_line_2
87
+
88
+ # Attribute for field bank_address_postal_code
89
+ sig { returns(T.nilable(String)) }
90
+ attr_reader :bank_address_postal_code
91
+
92
+ # Attribute for field bank_name
93
+ sig { returns(T.nilable(String)) }
94
+ attr_reader :bank_name
95
+
96
+ # Attribute for field category
97
+ sig { returns(T.nilable(String)) }
98
+ attr_reader :category
99
+
100
+ # Attribute for field country
101
+ sig { returns(T.nilable(String)) }
102
+ attr_reader :country
103
+
104
+ # Attribute for field fingerprint
105
+ sig { returns(T.nilable(String)) }
106
+ attr_reader :fingerprint
107
+
108
+ # Attribute for field last4
109
+ sig { returns(T.nilable(String)) }
110
+ attr_reader :last4
111
+
112
+ # Attribute for field routing_number
113
+ sig { returns(T.nilable(String)) }
114
+ attr_reader :routing_number
115
+ end
116
+ class Alipay < Stripe::StripeObject
117
+ # Attribute for field data_string
118
+ sig { returns(T.nilable(String)) }
119
+ attr_reader :data_string
120
+
121
+ # Attribute for field native_url
122
+ sig { returns(T.nilable(String)) }
123
+ attr_reader :native_url
124
+
125
+ # Attribute for field statement_descriptor
126
+ sig { returns(T.nilable(String)) }
127
+ attr_reader :statement_descriptor
128
+ end
129
+ class AuBecsDebit < Stripe::StripeObject
130
+ # Attribute for field bsb_number
131
+ sig { returns(T.nilable(String)) }
132
+ attr_reader :bsb_number
133
+
134
+ # Attribute for field fingerprint
135
+ sig { returns(T.nilable(String)) }
136
+ attr_reader :fingerprint
137
+
138
+ # Attribute for field last4
139
+ sig { returns(T.nilable(String)) }
140
+ attr_reader :last4
141
+ end
142
+ class Bancontact < Stripe::StripeObject
143
+ # Attribute for field bank_code
144
+ sig { returns(T.nilable(String)) }
145
+ attr_reader :bank_code
146
+
147
+ # Attribute for field bank_name
148
+ sig { returns(T.nilable(String)) }
149
+ attr_reader :bank_name
150
+
151
+ # Attribute for field bic
152
+ sig { returns(T.nilable(String)) }
153
+ attr_reader :bic
154
+
155
+ # Attribute for field iban_last4
156
+ sig { returns(T.nilable(String)) }
157
+ attr_reader :iban_last4
158
+
159
+ # Attribute for field preferred_language
160
+ sig { returns(T.nilable(String)) }
161
+ attr_reader :preferred_language
162
+
163
+ # Attribute for field statement_descriptor
164
+ sig { returns(T.nilable(String)) }
165
+ attr_reader :statement_descriptor
166
+ end
167
+ class Card < Stripe::StripeObject
168
+ # Attribute for field address_line1_check
169
+ sig { returns(T.nilable(String)) }
170
+ attr_reader :address_line1_check
171
+
172
+ # Attribute for field address_zip_check
173
+ sig { returns(T.nilable(String)) }
174
+ attr_reader :address_zip_check
175
+
176
+ # Attribute for field brand
177
+ sig { returns(T.nilable(String)) }
178
+ attr_reader :brand
179
+
180
+ # Attribute for field country
181
+ sig { returns(T.nilable(String)) }
182
+ attr_reader :country
183
+
184
+ # Attribute for field cvc_check
185
+ sig { returns(T.nilable(String)) }
186
+ attr_reader :cvc_check
187
+
188
+ # Attribute for field description
189
+ sig { returns(String) }
190
+ attr_reader :description
191
+
192
+ # Attribute for field dynamic_last4
193
+ sig { returns(T.nilable(String)) }
194
+ attr_reader :dynamic_last4
195
+
196
+ # Attribute for field exp_month
197
+ sig { returns(T.nilable(Integer)) }
198
+ attr_reader :exp_month
199
+
200
+ # Attribute for field exp_year
201
+ sig { returns(T.nilable(Integer)) }
202
+ attr_reader :exp_year
203
+
204
+ # Attribute for field fingerprint
205
+ sig { returns(String) }
206
+ attr_reader :fingerprint
207
+
208
+ # Attribute for field funding
209
+ sig { returns(T.nilable(String)) }
210
+ attr_reader :funding
211
+
212
+ # Attribute for field iin
213
+ sig { returns(String) }
214
+ attr_reader :iin
215
+
216
+ # Attribute for field issuer
217
+ sig { returns(String) }
218
+ attr_reader :issuer
219
+
220
+ # Attribute for field last4
221
+ sig { returns(T.nilable(String)) }
222
+ attr_reader :last4
223
+
224
+ # Attribute for field name
225
+ sig { returns(T.nilable(String)) }
226
+ attr_reader :name
227
+
228
+ # Attribute for field three_d_secure
229
+ sig { returns(String) }
230
+ attr_reader :three_d_secure
231
+
232
+ # Attribute for field tokenization_method
233
+ sig { returns(T.nilable(String)) }
234
+ attr_reader :tokenization_method
235
+ end
236
+ class CardPresent < Stripe::StripeObject
237
+ # Attribute for field application_cryptogram
238
+ sig { returns(String) }
239
+ attr_reader :application_cryptogram
240
+
241
+ # Attribute for field application_preferred_name
242
+ sig { returns(String) }
243
+ attr_reader :application_preferred_name
244
+
245
+ # Attribute for field authorization_code
246
+ sig { returns(T.nilable(String)) }
247
+ attr_reader :authorization_code
248
+
249
+ # Attribute for field authorization_response_code
250
+ sig { returns(String) }
251
+ attr_reader :authorization_response_code
252
+
253
+ # Attribute for field brand
254
+ sig { returns(T.nilable(String)) }
255
+ attr_reader :brand
256
+
257
+ # Attribute for field country
258
+ sig { returns(T.nilable(String)) }
259
+ attr_reader :country
260
+
261
+ # Attribute for field cvm_type
262
+ sig { returns(String) }
263
+ attr_reader :cvm_type
264
+
265
+ # Attribute for field data_type
266
+ sig { returns(T.nilable(String)) }
267
+ attr_reader :data_type
268
+
269
+ # Attribute for field dedicated_file_name
270
+ sig { returns(String) }
271
+ attr_reader :dedicated_file_name
272
+
273
+ # Attribute for field description
274
+ sig { returns(String) }
275
+ attr_reader :description
276
+
277
+ # Attribute for field emv_auth_data
278
+ sig { returns(String) }
279
+ attr_reader :emv_auth_data
280
+
281
+ # Attribute for field evidence_customer_signature
282
+ sig { returns(T.nilable(String)) }
283
+ attr_reader :evidence_customer_signature
284
+
285
+ # Attribute for field evidence_transaction_certificate
286
+ sig { returns(T.nilable(String)) }
287
+ attr_reader :evidence_transaction_certificate
288
+
289
+ # Attribute for field exp_month
290
+ sig { returns(T.nilable(Integer)) }
291
+ attr_reader :exp_month
292
+
293
+ # Attribute for field exp_year
294
+ sig { returns(T.nilable(Integer)) }
295
+ attr_reader :exp_year
296
+
297
+ # Attribute for field fingerprint
298
+ sig { returns(String) }
299
+ attr_reader :fingerprint
300
+
301
+ # Attribute for field funding
302
+ sig { returns(T.nilable(String)) }
303
+ attr_reader :funding
304
+
305
+ # Attribute for field iin
306
+ sig { returns(String) }
307
+ attr_reader :iin
308
+
309
+ # Attribute for field issuer
310
+ sig { returns(String) }
311
+ attr_reader :issuer
312
+
313
+ # Attribute for field last4
314
+ sig { returns(T.nilable(String)) }
315
+ attr_reader :last4
316
+
317
+ # Attribute for field pos_device_id
318
+ sig { returns(T.nilable(String)) }
319
+ attr_reader :pos_device_id
320
+
321
+ # Attribute for field pos_entry_mode
322
+ sig { returns(String) }
323
+ attr_reader :pos_entry_mode
324
+
325
+ # Attribute for field read_method
326
+ sig { returns(T.nilable(String)) }
327
+ attr_reader :read_method
328
+
329
+ # Attribute for field reader
330
+ sig { returns(T.nilable(String)) }
331
+ attr_reader :reader
332
+
333
+ # Attribute for field terminal_verification_results
334
+ sig { returns(String) }
335
+ attr_reader :terminal_verification_results
336
+
337
+ # Attribute for field transaction_status_information
338
+ sig { returns(String) }
339
+ attr_reader :transaction_status_information
340
+ end
341
+ class CodeVerification < Stripe::StripeObject
342
+ # The number of attempts remaining to authenticate the source object with a verification code.
343
+ sig { returns(Integer) }
344
+ attr_reader :attempts_remaining
345
+
346
+ # The status of the code verification, either `pending` (awaiting verification, `attempts_remaining` should be greater than 0), `succeeded` (successful verification) or `failed` (failed verification, cannot be verified anymore as `attempts_remaining` should be 0).
347
+ sig { returns(String) }
348
+ attr_reader :status
349
+ end
350
+ class Eps < Stripe::StripeObject
351
+ # Attribute for field reference
352
+ sig { returns(T.nilable(String)) }
353
+ attr_reader :reference
354
+
355
+ # Attribute for field statement_descriptor
356
+ sig { returns(T.nilable(String)) }
357
+ attr_reader :statement_descriptor
358
+ end
359
+ class Giropay < Stripe::StripeObject
360
+ # Attribute for field bank_code
361
+ sig { returns(T.nilable(String)) }
362
+ attr_reader :bank_code
363
+
364
+ # Attribute for field bank_name
365
+ sig { returns(T.nilable(String)) }
366
+ attr_reader :bank_name
367
+
368
+ # Attribute for field bic
369
+ sig { returns(T.nilable(String)) }
370
+ attr_reader :bic
371
+
372
+ # Attribute for field statement_descriptor
373
+ sig { returns(T.nilable(String)) }
374
+ attr_reader :statement_descriptor
375
+ end
376
+ class Ideal < Stripe::StripeObject
377
+ # Attribute for field bank
378
+ sig { returns(T.nilable(String)) }
379
+ attr_reader :bank
380
+
381
+ # Attribute for field bic
382
+ sig { returns(T.nilable(String)) }
383
+ attr_reader :bic
384
+
385
+ # Attribute for field iban_last4
386
+ sig { returns(T.nilable(String)) }
387
+ attr_reader :iban_last4
388
+
389
+ # Attribute for field statement_descriptor
390
+ sig { returns(T.nilable(String)) }
391
+ attr_reader :statement_descriptor
392
+ end
393
+ class Klarna < Stripe::StripeObject
394
+ # Attribute for field background_image_url
395
+ sig { returns(String) }
396
+ attr_reader :background_image_url
397
+
398
+ # Attribute for field client_token
399
+ sig { returns(T.nilable(String)) }
400
+ attr_reader :client_token
401
+
402
+ # Attribute for field first_name
403
+ sig { returns(String) }
404
+ attr_reader :first_name
405
+
406
+ # Attribute for field last_name
407
+ sig { returns(String) }
408
+ attr_reader :last_name
409
+
410
+ # Attribute for field locale
411
+ sig { returns(String) }
412
+ attr_reader :locale
413
+
414
+ # Attribute for field logo_url
415
+ sig { returns(String) }
416
+ attr_reader :logo_url
417
+
418
+ # Attribute for field page_title
419
+ sig { returns(String) }
420
+ attr_reader :page_title
421
+
422
+ # Attribute for field pay_later_asset_urls_descriptive
423
+ sig { returns(String) }
424
+ attr_reader :pay_later_asset_urls_descriptive
425
+
426
+ # Attribute for field pay_later_asset_urls_standard
427
+ sig { returns(String) }
428
+ attr_reader :pay_later_asset_urls_standard
429
+
430
+ # Attribute for field pay_later_name
431
+ sig { returns(String) }
432
+ attr_reader :pay_later_name
433
+
434
+ # Attribute for field pay_later_redirect_url
435
+ sig { returns(String) }
436
+ attr_reader :pay_later_redirect_url
437
+
438
+ # Attribute for field pay_now_asset_urls_descriptive
439
+ sig { returns(String) }
440
+ attr_reader :pay_now_asset_urls_descriptive
441
+
442
+ # Attribute for field pay_now_asset_urls_standard
443
+ sig { returns(String) }
444
+ attr_reader :pay_now_asset_urls_standard
445
+
446
+ # Attribute for field pay_now_name
447
+ sig { returns(String) }
448
+ attr_reader :pay_now_name
449
+
450
+ # Attribute for field pay_now_redirect_url
451
+ sig { returns(String) }
452
+ attr_reader :pay_now_redirect_url
453
+
454
+ # Attribute for field pay_over_time_asset_urls_descriptive
455
+ sig { returns(String) }
456
+ attr_reader :pay_over_time_asset_urls_descriptive
457
+
458
+ # Attribute for field pay_over_time_asset_urls_standard
459
+ sig { returns(String) }
460
+ attr_reader :pay_over_time_asset_urls_standard
461
+
462
+ # Attribute for field pay_over_time_name
463
+ sig { returns(String) }
464
+ attr_reader :pay_over_time_name
465
+
466
+ # Attribute for field pay_over_time_redirect_url
467
+ sig { returns(String) }
468
+ attr_reader :pay_over_time_redirect_url
469
+
470
+ # Attribute for field payment_method_categories
471
+ sig { returns(String) }
472
+ attr_reader :payment_method_categories
473
+
474
+ # Attribute for field purchase_country
475
+ sig { returns(String) }
476
+ attr_reader :purchase_country
477
+
478
+ # Attribute for field purchase_type
479
+ sig { returns(String) }
480
+ attr_reader :purchase_type
481
+
482
+ # Attribute for field redirect_url
483
+ sig { returns(String) }
484
+ attr_reader :redirect_url
485
+
486
+ # Attribute for field shipping_delay
487
+ sig { returns(Integer) }
488
+ attr_reader :shipping_delay
489
+
490
+ # Attribute for field shipping_first_name
491
+ sig { returns(String) }
492
+ attr_reader :shipping_first_name
493
+
494
+ # Attribute for field shipping_last_name
495
+ sig { returns(String) }
496
+ attr_reader :shipping_last_name
497
+ end
498
+ class Multibanco < Stripe::StripeObject
499
+ # Attribute for field entity
500
+ sig { returns(T.nilable(String)) }
501
+ attr_reader :entity
502
+
503
+ # Attribute for field reference
504
+ sig { returns(T.nilable(String)) }
505
+ attr_reader :reference
506
+
507
+ # Attribute for field refund_account_holder_address_city
508
+ sig { returns(T.nilable(String)) }
509
+ attr_reader :refund_account_holder_address_city
510
+
511
+ # Attribute for field refund_account_holder_address_country
512
+ sig { returns(T.nilable(String)) }
513
+ attr_reader :refund_account_holder_address_country
514
+
515
+ # Attribute for field refund_account_holder_address_line1
516
+ sig { returns(T.nilable(String)) }
517
+ attr_reader :refund_account_holder_address_line1
518
+
519
+ # Attribute for field refund_account_holder_address_line2
520
+ sig { returns(T.nilable(String)) }
521
+ attr_reader :refund_account_holder_address_line2
522
+
523
+ # Attribute for field refund_account_holder_address_postal_code
524
+ sig { returns(T.nilable(String)) }
525
+ attr_reader :refund_account_holder_address_postal_code
526
+
527
+ # Attribute for field refund_account_holder_address_state
528
+ sig { returns(T.nilable(String)) }
529
+ attr_reader :refund_account_holder_address_state
530
+
531
+ # Attribute for field refund_account_holder_name
532
+ sig { returns(T.nilable(String)) }
533
+ attr_reader :refund_account_holder_name
534
+
535
+ # Attribute for field refund_iban
536
+ sig { returns(T.nilable(String)) }
537
+ attr_reader :refund_iban
538
+ end
539
+ class Owner < Stripe::StripeObject
540
+ class Address < Stripe::StripeObject
541
+ # City, district, suburb, town, or village.
542
+ sig { returns(T.nilable(String)) }
543
+ attr_reader :city
544
+
545
+ # Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
546
+ sig { returns(T.nilable(String)) }
547
+ attr_reader :country
548
+
549
+ # Address line 1 (e.g., street, PO Box, or company name).
550
+ sig { returns(T.nilable(String)) }
551
+ attr_reader :line1
552
+
553
+ # Address line 2 (e.g., apartment, suite, unit, or building).
554
+ sig { returns(T.nilable(String)) }
555
+ attr_reader :line2
556
+
557
+ # ZIP or postal code.
558
+ sig { returns(T.nilable(String)) }
559
+ attr_reader :postal_code
560
+
561
+ # State, county, province, or region.
562
+ sig { returns(T.nilable(String)) }
563
+ attr_reader :state
564
+ end
565
+ class VerifiedAddress < Stripe::StripeObject
566
+ # City, district, suburb, town, or village.
567
+ sig { returns(T.nilable(String)) }
568
+ attr_reader :city
569
+
570
+ # Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
571
+ sig { returns(T.nilable(String)) }
572
+ attr_reader :country
573
+
574
+ # Address line 1 (e.g., street, PO Box, or company name).
575
+ sig { returns(T.nilable(String)) }
576
+ attr_reader :line1
577
+
578
+ # Address line 2 (e.g., apartment, suite, unit, or building).
579
+ sig { returns(T.nilable(String)) }
580
+ attr_reader :line2
581
+
582
+ # ZIP or postal code.
583
+ sig { returns(T.nilable(String)) }
584
+ attr_reader :postal_code
585
+
586
+ # State, county, province, or region.
587
+ sig { returns(T.nilable(String)) }
588
+ attr_reader :state
589
+ end
590
+ # Owner's address.
591
+ sig { returns(T.nilable(Address)) }
592
+ attr_reader :address
593
+
594
+ # Owner's email address.
595
+ sig { returns(T.nilable(String)) }
596
+ attr_reader :email
597
+
598
+ # Owner's full name.
599
+ sig { returns(T.nilable(String)) }
600
+ attr_reader :name
601
+
602
+ # Owner's phone number (including extension).
603
+ sig { returns(T.nilable(String)) }
604
+ attr_reader :phone
605
+
606
+ # Verified owner's address. Verified values are verified or provided by the payment method directly (and if supported) at the time of authorization or settlement. They cannot be set or mutated.
607
+ sig { returns(T.nilable(VerifiedAddress)) }
608
+ attr_reader :verified_address
609
+
610
+ # Verified owner's email address. Verified values are verified or provided by the payment method directly (and if supported) at the time of authorization or settlement. They cannot be set or mutated.
611
+ sig { returns(T.nilable(String)) }
612
+ attr_reader :verified_email
613
+
614
+ # Verified owner's full name. Verified values are verified or provided by the payment method directly (and if supported) at the time of authorization or settlement. They cannot be set or mutated.
615
+ sig { returns(T.nilable(String)) }
616
+ attr_reader :verified_name
617
+
618
+ # Verified owner's phone number (including extension). Verified values are verified or provided by the payment method directly (and if supported) at the time of authorization or settlement. They cannot be set or mutated.
619
+ sig { returns(T.nilable(String)) }
620
+ attr_reader :verified_phone
621
+ end
622
+ class P24 < Stripe::StripeObject
623
+ # Attribute for field reference
624
+ sig { returns(T.nilable(String)) }
625
+ attr_reader :reference
626
+ end
627
+ class Paypal < Stripe::StripeObject
628
+ # Attribute for field billing_agreement
629
+ sig { returns(T.nilable(String)) }
630
+ attr_reader :billing_agreement
631
+
632
+ # Attribute for field fingerprint
633
+ sig { returns(T.nilable(String)) }
634
+ attr_reader :fingerprint
635
+
636
+ # Attribute for field payer_id
637
+ sig { returns(T.nilable(String)) }
638
+ attr_reader :payer_id
639
+
640
+ # Attribute for field reference_id
641
+ sig { returns(String) }
642
+ attr_reader :reference_id
643
+
644
+ # Attribute for field reference_transaction_amount
645
+ sig { returns(String) }
646
+ attr_reader :reference_transaction_amount
647
+
648
+ # Attribute for field reference_transaction_charged
649
+ sig { returns(T::Boolean) }
650
+ attr_reader :reference_transaction_charged
651
+
652
+ # Attribute for field statement_descriptor
653
+ sig { returns(T.nilable(String)) }
654
+ attr_reader :statement_descriptor
655
+
656
+ # Attribute for field transaction_id
657
+ sig { returns(String) }
658
+ attr_reader :transaction_id
659
+
660
+ # Attribute for field verified_email
661
+ sig { returns(T.nilable(String)) }
662
+ attr_reader :verified_email
663
+ end
664
+ class Receiver < Stripe::StripeObject
665
+ # The address of the receiver source. This is the value that should be communicated to the customer to send their funds to.
666
+ sig { returns(T.nilable(String)) }
667
+ attr_reader :address
668
+
669
+ # The total amount that was moved to your balance. This is almost always equal to the amount charged. In rare cases when customers deposit excess funds and we are unable to refund those, those funds get moved to your balance and show up in amount_charged as well. The amount charged is expressed in the source's currency.
670
+ sig { returns(Integer) }
671
+ attr_reader :amount_charged
672
+
673
+ # The total amount received by the receiver source. `amount_received = amount_returned + amount_charged` should be true for consumed sources unless customers deposit excess funds. The amount received is expressed in the source's currency.
674
+ sig { returns(Integer) }
675
+ attr_reader :amount_received
676
+
677
+ # The total amount that was returned to the customer. The amount returned is expressed in the source's currency.
678
+ sig { returns(Integer) }
679
+ attr_reader :amount_returned
680
+
681
+ # Type of refund attribute method, one of `email`, `manual`, or `none`.
682
+ sig { returns(String) }
683
+ attr_reader :refund_attributes_method
684
+
685
+ # Type of refund attribute status, one of `missing`, `requested`, or `available`.
686
+ sig { returns(String) }
687
+ attr_reader :refund_attributes_status
688
+ end
689
+ class Redirect < Stripe::StripeObject
690
+ # The failure reason for the redirect, either `user_abort` (the customer aborted or dropped out of the redirect flow), `declined` (the authentication failed or the transaction was declined), or `processing_error` (the redirect failed due to a technical error). Present only if the redirect status is `failed`.
691
+ sig { returns(T.nilable(String)) }
692
+ attr_reader :failure_reason
693
+
694
+ # The URL you provide to redirect the customer to after they authenticated their payment.
695
+ sig { returns(String) }
696
+ attr_reader :return_url
697
+
698
+ # The status of the redirect, either `pending` (ready to be used by your customer to authenticate the transaction), `succeeded` (succesful authentication, cannot be reused) or `not_required` (redirect should not be used) or `failed` (failed authentication, cannot be reused).
699
+ sig { returns(String) }
700
+ attr_reader :status
701
+
702
+ # The URL provided to you to redirect a customer to as part of a `redirect` authentication flow.
703
+ sig { returns(String) }
704
+ attr_reader :url
705
+ end
706
+ class SepaCreditTransfer < Stripe::StripeObject
707
+ # Attribute for field bank_name
708
+ sig { returns(T.nilable(String)) }
709
+ attr_reader :bank_name
710
+
711
+ # Attribute for field bic
712
+ sig { returns(T.nilable(String)) }
713
+ attr_reader :bic
714
+
715
+ # Attribute for field iban
716
+ sig { returns(T.nilable(String)) }
717
+ attr_reader :iban
718
+
719
+ # Attribute for field refund_account_holder_address_city
720
+ sig { returns(T.nilable(String)) }
721
+ attr_reader :refund_account_holder_address_city
722
+
723
+ # Attribute for field refund_account_holder_address_country
724
+ sig { returns(T.nilable(String)) }
725
+ attr_reader :refund_account_holder_address_country
726
+
727
+ # Attribute for field refund_account_holder_address_line1
728
+ sig { returns(T.nilable(String)) }
729
+ attr_reader :refund_account_holder_address_line1
730
+
731
+ # Attribute for field refund_account_holder_address_line2
732
+ sig { returns(T.nilable(String)) }
733
+ attr_reader :refund_account_holder_address_line2
734
+
735
+ # Attribute for field refund_account_holder_address_postal_code
736
+ sig { returns(T.nilable(String)) }
737
+ attr_reader :refund_account_holder_address_postal_code
738
+
739
+ # Attribute for field refund_account_holder_address_state
740
+ sig { returns(T.nilable(String)) }
741
+ attr_reader :refund_account_holder_address_state
742
+
743
+ # Attribute for field refund_account_holder_name
744
+ sig { returns(T.nilable(String)) }
745
+ attr_reader :refund_account_holder_name
746
+
747
+ # Attribute for field refund_iban
748
+ sig { returns(T.nilable(String)) }
749
+ attr_reader :refund_iban
750
+ end
751
+ class SepaDebit < Stripe::StripeObject
752
+ # Attribute for field bank_code
753
+ sig { returns(T.nilable(String)) }
754
+ attr_reader :bank_code
755
+
756
+ # Attribute for field branch_code
757
+ sig { returns(T.nilable(String)) }
758
+ attr_reader :branch_code
759
+
760
+ # Attribute for field country
761
+ sig { returns(T.nilable(String)) }
762
+ attr_reader :country
763
+
764
+ # Attribute for field fingerprint
765
+ sig { returns(T.nilable(String)) }
766
+ attr_reader :fingerprint
767
+
768
+ # Attribute for field last4
769
+ sig { returns(T.nilable(String)) }
770
+ attr_reader :last4
771
+
772
+ # Attribute for field mandate_reference
773
+ sig { returns(T.nilable(String)) }
774
+ attr_reader :mandate_reference
775
+
776
+ # Attribute for field mandate_url
777
+ sig { returns(T.nilable(String)) }
778
+ attr_reader :mandate_url
779
+ end
780
+ class Sofort < Stripe::StripeObject
781
+ # Attribute for field bank_code
782
+ sig { returns(T.nilable(String)) }
783
+ attr_reader :bank_code
784
+
785
+ # Attribute for field bank_name
786
+ sig { returns(T.nilable(String)) }
787
+ attr_reader :bank_name
788
+
789
+ # Attribute for field bic
790
+ sig { returns(T.nilable(String)) }
791
+ attr_reader :bic
792
+
793
+ # Attribute for field country
794
+ sig { returns(T.nilable(String)) }
795
+ attr_reader :country
796
+
797
+ # Attribute for field iban_last4
798
+ sig { returns(T.nilable(String)) }
799
+ attr_reader :iban_last4
800
+
801
+ # Attribute for field preferred_language
802
+ sig { returns(T.nilable(String)) }
803
+ attr_reader :preferred_language
804
+
805
+ # Attribute for field statement_descriptor
806
+ sig { returns(T.nilable(String)) }
807
+ attr_reader :statement_descriptor
808
+ end
809
+ class SourceOrder < Stripe::StripeObject
810
+ class Item < Stripe::StripeObject
811
+ # The amount (price) for this order item.
812
+ sig { returns(T.nilable(Integer)) }
813
+ attr_reader :amount
814
+
815
+ # This currency of this order item. Required when `amount` is present.
816
+ sig { returns(T.nilable(String)) }
817
+ attr_reader :currency
818
+
819
+ # Human-readable description for this order item.
820
+ sig { returns(T.nilable(String)) }
821
+ attr_reader :description
822
+
823
+ # The ID of the associated object for this line item. Expandable if not null (e.g., expandable to a SKU).
824
+ sig { returns(T.nilable(String)) }
825
+ attr_reader :parent
826
+
827
+ # The quantity of this order item. When type is `sku`, this is the number of instances of the SKU to be ordered.
828
+ sig { returns(Integer) }
829
+ attr_reader :quantity
830
+
831
+ # The type of this order item. Must be `sku`, `tax`, or `shipping`.
832
+ sig { returns(T.nilable(String)) }
833
+ attr_reader :type
834
+ end
835
+ class Shipping < Stripe::StripeObject
836
+ class Address < Stripe::StripeObject
837
+ # City, district, suburb, town, or village.
838
+ sig { returns(T.nilable(String)) }
839
+ attr_reader :city
840
+
841
+ # Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
842
+ sig { returns(T.nilable(String)) }
843
+ attr_reader :country
844
+
845
+ # Address line 1 (e.g., street, PO Box, or company name).
846
+ sig { returns(T.nilable(String)) }
847
+ attr_reader :line1
848
+
849
+ # Address line 2 (e.g., apartment, suite, unit, or building).
850
+ sig { returns(T.nilable(String)) }
851
+ attr_reader :line2
852
+
853
+ # ZIP or postal code.
854
+ sig { returns(T.nilable(String)) }
855
+ attr_reader :postal_code
856
+
857
+ # State, county, province, or region.
858
+ sig { returns(T.nilable(String)) }
859
+ attr_reader :state
860
+ end
861
+ # Attribute for field address
862
+ sig { returns(Address) }
863
+ attr_reader :address
864
+
865
+ # The delivery service that shipped a physical product, such as Fedex, UPS, USPS, etc.
866
+ sig { returns(T.nilable(String)) }
867
+ attr_reader :carrier
868
+
869
+ # Recipient name.
870
+ sig { returns(String) }
871
+ attr_reader :name
872
+
873
+ # Recipient phone (including extension).
874
+ sig { returns(T.nilable(String)) }
875
+ attr_reader :phone
876
+
877
+ # The tracking number for a physical product, obtained from the delivery service. If multiple tracking numbers were generated for this purchase, please separate them with commas.
878
+ sig { returns(T.nilable(String)) }
879
+ attr_reader :tracking_number
880
+ end
881
+ # A positive integer in the smallest currency unit (that is, 100 cents for $1.00, or 1 for ¥1, Japanese Yen being a zero-decimal currency) representing the total amount for the order.
882
+ sig { returns(Integer) }
883
+ attr_reader :amount
884
+
885
+ # 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).
886
+ sig { returns(String) }
887
+ attr_reader :currency
888
+
889
+ # The email address of the customer placing the order.
890
+ sig { returns(String) }
891
+ attr_reader :email
892
+
893
+ # List of items constituting the order.
894
+ sig { returns(T.nilable(T::Array[Item])) }
895
+ attr_reader :items
896
+
897
+ # Attribute for field shipping
898
+ sig { returns(Shipping) }
899
+ attr_reader :shipping
900
+ end
901
+ class ThreeDSecure < Stripe::StripeObject
902
+ # Attribute for field address_line1_check
903
+ sig { returns(T.nilable(String)) }
904
+ attr_reader :address_line1_check
905
+
906
+ # Attribute for field address_zip_check
907
+ sig { returns(T.nilable(String)) }
908
+ attr_reader :address_zip_check
909
+
910
+ # Attribute for field authenticated
911
+ sig { returns(T.nilable(T::Boolean)) }
912
+ attr_reader :authenticated
913
+
914
+ # Attribute for field brand
915
+ sig { returns(T.nilable(String)) }
916
+ attr_reader :brand
917
+
918
+ # Attribute for field card
919
+ sig { returns(T.nilable(String)) }
920
+ attr_reader :card
921
+
922
+ # Attribute for field country
923
+ sig { returns(T.nilable(String)) }
924
+ attr_reader :country
925
+
926
+ # Attribute for field customer
927
+ sig { returns(T.nilable(String)) }
928
+ attr_reader :customer
929
+
930
+ # Attribute for field cvc_check
931
+ sig { returns(T.nilable(String)) }
932
+ attr_reader :cvc_check
933
+
934
+ # Attribute for field description
935
+ sig { returns(String) }
936
+ attr_reader :description
937
+
938
+ # Attribute for field dynamic_last4
939
+ sig { returns(T.nilable(String)) }
940
+ attr_reader :dynamic_last4
941
+
942
+ # Attribute for field exp_month
943
+ sig { returns(T.nilable(Integer)) }
944
+ attr_reader :exp_month
945
+
946
+ # Attribute for field exp_year
947
+ sig { returns(T.nilable(Integer)) }
948
+ attr_reader :exp_year
949
+
950
+ # Attribute for field fingerprint
951
+ sig { returns(String) }
952
+ attr_reader :fingerprint
953
+
954
+ # Attribute for field funding
955
+ sig { returns(T.nilable(String)) }
956
+ attr_reader :funding
957
+
958
+ # Attribute for field iin
959
+ sig { returns(String) }
960
+ attr_reader :iin
961
+
962
+ # Attribute for field issuer
963
+ sig { returns(String) }
964
+ attr_reader :issuer
965
+
966
+ # Attribute for field last4
967
+ sig { returns(T.nilable(String)) }
968
+ attr_reader :last4
969
+
970
+ # Attribute for field name
971
+ sig { returns(T.nilable(String)) }
972
+ attr_reader :name
973
+
974
+ # Attribute for field three_d_secure
975
+ sig { returns(String) }
976
+ attr_reader :three_d_secure
977
+
978
+ # Attribute for field tokenization_method
979
+ sig { returns(T.nilable(String)) }
980
+ attr_reader :tokenization_method
981
+ end
982
+ class Wechat < Stripe::StripeObject
983
+ # Attribute for field prepay_id
984
+ sig { returns(String) }
985
+ attr_reader :prepay_id
986
+
987
+ # Attribute for field qr_code_url
988
+ sig { returns(T.nilable(String)) }
989
+ attr_reader :qr_code_url
990
+
991
+ # Attribute for field statement_descriptor
992
+ sig { returns(String) }
993
+ attr_reader :statement_descriptor
994
+ end
995
+ # Attribute for field ach_credit_transfer
996
+ sig { returns(AchCreditTransfer) }
997
+ attr_reader :ach_credit_transfer
998
+
999
+ # Attribute for field ach_debit
1000
+ sig { returns(AchDebit) }
1001
+ attr_reader :ach_debit
1002
+
1003
+ # Attribute for field acss_debit
1004
+ sig { returns(AcssDebit) }
1005
+ attr_reader :acss_debit
1006
+
1007
+ # Attribute for field alipay
1008
+ sig { returns(Alipay) }
1009
+ attr_reader :alipay
1010
+
1011
+ # 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. The field defaults to “unspecified”.
1012
+ sig { returns(T.nilable(String)) }
1013
+ attr_reader :allow_redisplay
1014
+
1015
+ # A positive integer in the smallest currency unit (that is, 100 cents for $1.00, or 1 for ¥1, Japanese Yen being a zero-decimal currency) representing the total amount associated with the source. This is the amount for which the source will be chargeable once ready. Required for `single_use` sources.
1016
+ sig { returns(T.nilable(Integer)) }
1017
+ attr_reader :amount
1018
+
1019
+ # Attribute for field au_becs_debit
1020
+ sig { returns(AuBecsDebit) }
1021
+ attr_reader :au_becs_debit
1022
+
1023
+ # Attribute for field bancontact
1024
+ sig { returns(Bancontact) }
1025
+ attr_reader :bancontact
1026
+
1027
+ # Attribute for field card
1028
+ sig { returns(Card) }
1029
+ attr_reader :card
1030
+
1031
+ # Attribute for field card_present
1032
+ sig { returns(CardPresent) }
1033
+ attr_reader :card_present
1034
+
1035
+ # The client secret of the source. Used for client-side retrieval using a publishable key.
1036
+ sig { returns(String) }
1037
+ attr_reader :client_secret
1038
+
1039
+ # Attribute for field code_verification
1040
+ sig { returns(CodeVerification) }
1041
+ attr_reader :code_verification
1042
+
1043
+ # Time at which the object was created. Measured in seconds since the Unix epoch.
1044
+ sig { returns(Integer) }
1045
+ attr_reader :created
1046
+
1047
+ # Three-letter [ISO code for the currency](https://stripe.com/docs/currencies) associated with the source. This is the currency for which the source will be chargeable once ready. Required for `single_use` sources.
1048
+ sig { returns(T.nilable(String)) }
1049
+ attr_reader :currency
1050
+
1051
+ # The ID of the customer to which this source is attached. This will not be present when the source has not been attached to a customer.
1052
+ sig { returns(String) }
1053
+ attr_reader :customer
1054
+
1055
+ # Attribute for field eps
1056
+ sig { returns(Eps) }
1057
+ attr_reader :eps
1058
+
1059
+ # The authentication `flow` of the source. `flow` is one of `redirect`, `receiver`, `code_verification`, `none`.
1060
+ sig { returns(String) }
1061
+ attr_reader :flow
1062
+
1063
+ # Attribute for field giropay
1064
+ sig { returns(Giropay) }
1065
+ attr_reader :giropay
1066
+
1067
+ # Unique identifier for the object.
1068
+ sig { returns(String) }
1069
+ attr_reader :id
1070
+
1071
+ # Attribute for field ideal
1072
+ sig { returns(Ideal) }
1073
+ attr_reader :ideal
1074
+
1075
+ # Attribute for field klarna
1076
+ sig { returns(Klarna) }
1077
+ attr_reader :klarna
1078
+
1079
+ # Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
1080
+ sig { returns(T::Boolean) }
1081
+ attr_reader :livemode
1082
+
1083
+ # 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.
1084
+ sig { returns(T.nilable(T::Hash[String, String])) }
1085
+ attr_reader :metadata
1086
+
1087
+ # Attribute for field multibanco
1088
+ sig { returns(Multibanco) }
1089
+ attr_reader :multibanco
1090
+
1091
+ # String representing the object's type. Objects of the same type share the same value.
1092
+ sig { returns(String) }
1093
+ attr_reader :object
1094
+
1095
+ # Information about the owner of the payment instrument that may be used or required by particular source types.
1096
+ sig { returns(T.nilable(Owner)) }
1097
+ attr_reader :owner
1098
+
1099
+ # Attribute for field p24
1100
+ sig { returns(P24) }
1101
+ attr_reader :p24
1102
+
1103
+ # Attribute for field paypal
1104
+ sig { returns(Paypal) }
1105
+ attr_reader :paypal
1106
+
1107
+ # Attribute for field receiver
1108
+ sig { returns(Receiver) }
1109
+ attr_reader :receiver
1110
+
1111
+ # Attribute for field redirect
1112
+ sig { returns(Redirect) }
1113
+ attr_reader :redirect
1114
+
1115
+ # Attribute for field sepa_credit_transfer
1116
+ sig { returns(SepaCreditTransfer) }
1117
+ attr_reader :sepa_credit_transfer
1118
+
1119
+ # Attribute for field sepa_debit
1120
+ sig { returns(SepaDebit) }
1121
+ attr_reader :sepa_debit
1122
+
1123
+ # Attribute for field sofort
1124
+ sig { returns(Sofort) }
1125
+ attr_reader :sofort
1126
+
1127
+ # Attribute for field source_order
1128
+ sig { returns(SourceOrder) }
1129
+ attr_reader :source_order
1130
+
1131
+ # Extra information about a source. This will appear on your customer's statement every time you charge the source.
1132
+ sig { returns(T.nilable(String)) }
1133
+ attr_reader :statement_descriptor
1134
+
1135
+ # The status of the source, one of `canceled`, `chargeable`, `consumed`, `failed`, or `pending`. Only `chargeable` sources can be used to create a charge.
1136
+ sig { returns(String) }
1137
+ attr_reader :status
1138
+
1139
+ # Attribute for field three_d_secure
1140
+ sig { returns(ThreeDSecure) }
1141
+ attr_reader :three_d_secure
1142
+
1143
+ # The `type` of the source. The `type` is a payment method, one of `ach_credit_transfer`, `ach_debit`, `alipay`, `bancontact`, `card`, `card_present`, `eps`, `giropay`, `ideal`, `multibanco`, `klarna`, `p24`, `sepa_debit`, `sofort`, `three_d_secure`, or `wechat`. An additional hash is included on the source with a name matching this value. It contains additional information specific to the [payment method](https://stripe.com/docs/sources) used.
1144
+ sig { returns(String) }
1145
+ attr_reader :type
1146
+
1147
+ # Either `reusable` or `single_use`. Whether this source should be reusable or not. Some source types may or may not be reusable by construction, while others may leave the option at creation. If an incompatible value is passed, an error will be returned.
1148
+ sig { returns(T.nilable(String)) }
1149
+ attr_reader :usage
1150
+
1151
+ # Attribute for field wechat
1152
+ sig { returns(Wechat) }
1153
+ attr_reader :wechat
1154
+
1155
+ class RetrieveParams < Stripe::RequestParams
1156
+ # The client secret of the source. Required if a publishable key is used to retrieve the source.
1157
+ sig { returns(String) }
1158
+ attr_accessor :client_secret
1159
+
1160
+ # Specifies which fields in the response should be expanded.
1161
+ sig { returns(T::Array[String]) }
1162
+ attr_accessor :expand
1163
+
1164
+ sig { params(client_secret: String, expand: T::Array[String]).void }
1165
+ def initialize(client_secret: nil, expand: nil); end
1166
+ end
1167
+ class UpdateParams < Stripe::RequestParams
1168
+ class Mandate < Stripe::RequestParams
1169
+ class Acceptance < Stripe::RequestParams
1170
+ class Offline < Stripe::RequestParams
1171
+ # An email to contact you with if a copy of the mandate is requested, required if `type` is `offline`.
1172
+ sig { returns(String) }
1173
+ attr_accessor :contact_email
1174
+
1175
+ sig { params(contact_email: String).void }
1176
+ def initialize(contact_email: nil); end
1177
+ end
1178
+ class Online < Stripe::RequestParams
1179
+ # The Unix timestamp (in seconds) when the mandate was accepted or refused by the customer.
1180
+ sig { returns(Integer) }
1181
+ attr_accessor :date
1182
+
1183
+ # The IP address from which the mandate was accepted or refused by the customer.
1184
+ sig { returns(String) }
1185
+ attr_accessor :ip
1186
+
1187
+ # The user agent of the browser from which the mandate was accepted or refused by the customer.
1188
+ sig { returns(String) }
1189
+ attr_accessor :user_agent
1190
+
1191
+ sig { params(date: Integer, ip: String, user_agent: String).void }
1192
+ def initialize(date: nil, ip: nil, user_agent: nil); end
1193
+ end
1194
+ # The Unix timestamp (in seconds) when the mandate was accepted or refused by the customer.
1195
+ sig { returns(Integer) }
1196
+ attr_accessor :date
1197
+
1198
+ # The IP address from which the mandate was accepted or refused by the customer.
1199
+ sig { returns(String) }
1200
+ attr_accessor :ip
1201
+
1202
+ # The parameters required to store a mandate accepted offline. Should only be set if `mandate[type]` is `offline`
1203
+ sig { returns(::Stripe::Source::UpdateParams::Mandate::Acceptance::Offline) }
1204
+ attr_accessor :offline
1205
+
1206
+ # The parameters required to store a mandate accepted online. Should only be set if `mandate[type]` is `online`
1207
+ sig { returns(::Stripe::Source::UpdateParams::Mandate::Acceptance::Online) }
1208
+ attr_accessor :online
1209
+
1210
+ # The status of the mandate acceptance. Either `accepted` (the mandate was accepted) or `refused` (the mandate was refused).
1211
+ sig { returns(String) }
1212
+ attr_accessor :status
1213
+
1214
+ # The type of acceptance information included with the mandate. Either `online` or `offline`
1215
+ sig { returns(String) }
1216
+ attr_accessor :type
1217
+
1218
+ # The user agent of the browser from which the mandate was accepted or refused by the customer.
1219
+ sig { returns(String) }
1220
+ attr_accessor :user_agent
1221
+
1222
+ sig {
1223
+ params(date: Integer, ip: String, offline: ::Stripe::Source::UpdateParams::Mandate::Acceptance::Offline, online: ::Stripe::Source::UpdateParams::Mandate::Acceptance::Online, status: String, type: String, user_agent: String).void
1224
+ }
1225
+ def initialize(
1226
+ date: nil,
1227
+ ip: nil,
1228
+ offline: nil,
1229
+ online: nil,
1230
+ status: nil,
1231
+ type: nil,
1232
+ user_agent: nil
1233
+ ); end
1234
+ end
1235
+ # The parameters required to notify Stripe of a mandate acceptance or refusal by the customer.
1236
+ sig { returns(::Stripe::Source::UpdateParams::Mandate::Acceptance) }
1237
+ attr_accessor :acceptance
1238
+
1239
+ # The amount specified by the mandate. (Leave null for a mandate covering all amounts)
1240
+ sig { returns(T.nilable(Integer)) }
1241
+ attr_accessor :amount
1242
+
1243
+ # The currency specified by the mandate. (Must match `currency` of the source)
1244
+ sig { returns(String) }
1245
+ attr_accessor :currency
1246
+
1247
+ # The interval of debits permitted by the mandate. Either `one_time` (just permitting a single debit), `scheduled` (with debits on an agreed schedule or for clearly-defined events), or `variable`(for debits with any frequency)
1248
+ sig { returns(String) }
1249
+ attr_accessor :interval
1250
+
1251
+ # The method Stripe should use to notify the customer of upcoming debit instructions and/or mandate confirmation as required by the underlying debit network. Either `email` (an email is sent directly to the customer), `manual` (a `source.mandate_notification` event is sent to your webhooks endpoint and you should handle the notification) or `none` (the underlying debit network does not require any notification).
1252
+ sig { returns(String) }
1253
+ attr_accessor :notification_method
1254
+
1255
+ sig {
1256
+ params(acceptance: ::Stripe::Source::UpdateParams::Mandate::Acceptance, amount: T.nilable(Integer), currency: String, interval: String, notification_method: String).void
1257
+ }
1258
+ def initialize(
1259
+ acceptance: nil,
1260
+ amount: nil,
1261
+ currency: nil,
1262
+ interval: nil,
1263
+ notification_method: nil
1264
+ ); end
1265
+ end
1266
+ class Owner < Stripe::RequestParams
1267
+ class Address < Stripe::RequestParams
1268
+ # City, district, suburb, town, or village.
1269
+ sig { returns(String) }
1270
+ attr_accessor :city
1271
+
1272
+ # Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
1273
+ sig { returns(String) }
1274
+ attr_accessor :country
1275
+
1276
+ # Address line 1 (e.g., street, PO Box, or company name).
1277
+ sig { returns(String) }
1278
+ attr_accessor :line1
1279
+
1280
+ # Address line 2 (e.g., apartment, suite, unit, or building).
1281
+ sig { returns(String) }
1282
+ attr_accessor :line2
1283
+
1284
+ # ZIP or postal code.
1285
+ sig { returns(String) }
1286
+ attr_accessor :postal_code
1287
+
1288
+ # State, county, province, or region.
1289
+ sig { returns(String) }
1290
+ attr_accessor :state
1291
+
1292
+ sig {
1293
+ params(city: String, country: String, line1: String, line2: String, postal_code: String, state: String).void
1294
+ }
1295
+ def initialize(
1296
+ city: nil,
1297
+ country: nil,
1298
+ line1: nil,
1299
+ line2: nil,
1300
+ postal_code: nil,
1301
+ state: nil
1302
+ ); end
1303
+ end
1304
+ # Owner's address.
1305
+ sig { returns(::Stripe::Source::UpdateParams::Owner::Address) }
1306
+ attr_accessor :address
1307
+
1308
+ # Owner's email address.
1309
+ sig { returns(String) }
1310
+ attr_accessor :email
1311
+
1312
+ # Owner's full name.
1313
+ sig { returns(String) }
1314
+ attr_accessor :name
1315
+
1316
+ # Owner's phone number.
1317
+ sig { returns(String) }
1318
+ attr_accessor :phone
1319
+
1320
+ sig {
1321
+ params(address: ::Stripe::Source::UpdateParams::Owner::Address, email: String, name: String, phone: String).void
1322
+ }
1323
+ def initialize(address: nil, email: nil, name: nil, phone: nil); end
1324
+ end
1325
+ class SourceOrder < Stripe::RequestParams
1326
+ class Item < Stripe::RequestParams
1327
+ # Attribute for param field amount
1328
+ sig { returns(Integer) }
1329
+ attr_accessor :amount
1330
+
1331
+ # Attribute for param field currency
1332
+ sig { returns(String) }
1333
+ attr_accessor :currency
1334
+
1335
+ # Attribute for param field description
1336
+ sig { returns(String) }
1337
+ attr_accessor :description
1338
+
1339
+ # The ID of the SKU being ordered.
1340
+ sig { returns(String) }
1341
+ attr_accessor :parent
1342
+
1343
+ # The quantity of this order item. When type is `sku`, this is the number of instances of the SKU to be ordered.
1344
+ sig { returns(Integer) }
1345
+ attr_accessor :quantity
1346
+
1347
+ # Attribute for param field type
1348
+ sig { returns(String) }
1349
+ attr_accessor :type
1350
+
1351
+ sig {
1352
+ params(amount: Integer, currency: String, description: String, parent: String, quantity: Integer, type: String).void
1353
+ }
1354
+ def initialize(
1355
+ amount: nil,
1356
+ currency: nil,
1357
+ description: nil,
1358
+ parent: nil,
1359
+ quantity: nil,
1360
+ type: nil
1361
+ ); end
1362
+ end
1363
+ class Shipping < Stripe::RequestParams
1364
+ class Address < Stripe::RequestParams
1365
+ # City, district, suburb, town, or village.
1366
+ sig { returns(String) }
1367
+ attr_accessor :city
1368
+
1369
+ # Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
1370
+ sig { returns(String) }
1371
+ attr_accessor :country
1372
+
1373
+ # Address line 1 (e.g., street, PO Box, or company name).
1374
+ sig { returns(String) }
1375
+ attr_accessor :line1
1376
+
1377
+ # Address line 2 (e.g., apartment, suite, unit, or building).
1378
+ sig { returns(String) }
1379
+ attr_accessor :line2
1380
+
1381
+ # ZIP or postal code.
1382
+ sig { returns(String) }
1383
+ attr_accessor :postal_code
1384
+
1385
+ # State, county, province, or region.
1386
+ sig { returns(String) }
1387
+ attr_accessor :state
1388
+
1389
+ sig {
1390
+ params(city: String, country: String, line1: String, line2: String, postal_code: String, state: String).void
1391
+ }
1392
+ def initialize(
1393
+ city: nil,
1394
+ country: nil,
1395
+ line1: nil,
1396
+ line2: nil,
1397
+ postal_code: nil,
1398
+ state: nil
1399
+ ); end
1400
+ end
1401
+ # Shipping address.
1402
+ sig { returns(::Stripe::Source::UpdateParams::SourceOrder::Shipping::Address) }
1403
+ attr_accessor :address
1404
+
1405
+ # The delivery service that shipped a physical product, such as Fedex, UPS, USPS, etc.
1406
+ sig { returns(String) }
1407
+ attr_accessor :carrier
1408
+
1409
+ # Recipient name.
1410
+ sig { returns(String) }
1411
+ attr_accessor :name
1412
+
1413
+ # Recipient phone (including extension).
1414
+ sig { returns(String) }
1415
+ attr_accessor :phone
1416
+
1417
+ # The tracking number for a physical product, obtained from the delivery service. If multiple tracking numbers were generated for this purchase, please separate them with commas.
1418
+ sig { returns(String) }
1419
+ attr_accessor :tracking_number
1420
+
1421
+ sig {
1422
+ params(address: ::Stripe::Source::UpdateParams::SourceOrder::Shipping::Address, carrier: String, name: String, phone: String, tracking_number: String).void
1423
+ }
1424
+ def initialize(
1425
+ address: nil,
1426
+ carrier: nil,
1427
+ name: nil,
1428
+ phone: nil,
1429
+ tracking_number: nil
1430
+ ); end
1431
+ end
1432
+ # List of items constituting the order.
1433
+ sig { returns(T::Array[::Stripe::Source::UpdateParams::SourceOrder::Item]) }
1434
+ attr_accessor :items
1435
+
1436
+ # Shipping address for the order. Required if any of the SKUs are for products that have `shippable` set to true.
1437
+ sig { returns(::Stripe::Source::UpdateParams::SourceOrder::Shipping) }
1438
+ attr_accessor :shipping
1439
+
1440
+ sig {
1441
+ params(items: T::Array[::Stripe::Source::UpdateParams::SourceOrder::Item], shipping: ::Stripe::Source::UpdateParams::SourceOrder::Shipping).void
1442
+ }
1443
+ def initialize(items: nil, shipping: nil); end
1444
+ end
1445
+ # Amount associated with the source.
1446
+ sig { returns(Integer) }
1447
+ attr_accessor :amount
1448
+
1449
+ # Specifies which fields in the response should be expanded.
1450
+ sig { returns(T::Array[String]) }
1451
+ attr_accessor :expand
1452
+
1453
+ # Information about a mandate possibility attached to a source object (generally for bank debits) as well as its acceptance status.
1454
+ sig { returns(::Stripe::Source::UpdateParams::Mandate) }
1455
+ attr_accessor :mandate
1456
+
1457
+ # 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`.
1458
+ sig { returns(T.nilable(T::Hash[String, String])) }
1459
+ attr_accessor :metadata
1460
+
1461
+ # Information about the owner of the payment instrument that may be used or required by particular source types.
1462
+ sig { returns(::Stripe::Source::UpdateParams::Owner) }
1463
+ attr_accessor :owner
1464
+
1465
+ # Information about the items and shipping associated with the source. Required for transactional credit (for example Klarna) sources before you can charge it.
1466
+ sig { returns(::Stripe::Source::UpdateParams::SourceOrder) }
1467
+ attr_accessor :source_order
1468
+
1469
+ sig {
1470
+ params(amount: Integer, expand: T::Array[String], mandate: ::Stripe::Source::UpdateParams::Mandate, metadata: T.nilable(T::Hash[String, String]), owner: ::Stripe::Source::UpdateParams::Owner, source_order: ::Stripe::Source::UpdateParams::SourceOrder).void
1471
+ }
1472
+ def initialize(
1473
+ amount: nil,
1474
+ expand: nil,
1475
+ mandate: nil,
1476
+ metadata: nil,
1477
+ owner: nil,
1478
+ source_order: nil
1479
+ ); end
1480
+ end
1481
+ class CreateParams < Stripe::RequestParams
1482
+ class Mandate < Stripe::RequestParams
1483
+ class Acceptance < Stripe::RequestParams
1484
+ class Offline < Stripe::RequestParams
1485
+ # An email to contact you with if a copy of the mandate is requested, required if `type` is `offline`.
1486
+ sig { returns(String) }
1487
+ attr_accessor :contact_email
1488
+
1489
+ sig { params(contact_email: String).void }
1490
+ def initialize(contact_email: nil); end
1491
+ end
1492
+ class Online < Stripe::RequestParams
1493
+ # The Unix timestamp (in seconds) when the mandate was accepted or refused by the customer.
1494
+ sig { returns(Integer) }
1495
+ attr_accessor :date
1496
+
1497
+ # The IP address from which the mandate was accepted or refused by the customer.
1498
+ sig { returns(String) }
1499
+ attr_accessor :ip
1500
+
1501
+ # The user agent of the browser from which the mandate was accepted or refused by the customer.
1502
+ sig { returns(String) }
1503
+ attr_accessor :user_agent
1504
+
1505
+ sig { params(date: Integer, ip: String, user_agent: String).void }
1506
+ def initialize(date: nil, ip: nil, user_agent: nil); end
1507
+ end
1508
+ # The Unix timestamp (in seconds) when the mandate was accepted or refused by the customer.
1509
+ sig { returns(Integer) }
1510
+ attr_accessor :date
1511
+
1512
+ # The IP address from which the mandate was accepted or refused by the customer.
1513
+ sig { returns(String) }
1514
+ attr_accessor :ip
1515
+
1516
+ # The parameters required to store a mandate accepted offline. Should only be set if `mandate[type]` is `offline`
1517
+ sig { returns(::Stripe::Source::CreateParams::Mandate::Acceptance::Offline) }
1518
+ attr_accessor :offline
1519
+
1520
+ # The parameters required to store a mandate accepted online. Should only be set if `mandate[type]` is `online`
1521
+ sig { returns(::Stripe::Source::CreateParams::Mandate::Acceptance::Online) }
1522
+ attr_accessor :online
1523
+
1524
+ # The status of the mandate acceptance. Either `accepted` (the mandate was accepted) or `refused` (the mandate was refused).
1525
+ sig { returns(String) }
1526
+ attr_accessor :status
1527
+
1528
+ # The type of acceptance information included with the mandate. Either `online` or `offline`
1529
+ sig { returns(String) }
1530
+ attr_accessor :type
1531
+
1532
+ # The user agent of the browser from which the mandate was accepted or refused by the customer.
1533
+ sig { returns(String) }
1534
+ attr_accessor :user_agent
1535
+
1536
+ sig {
1537
+ params(date: Integer, ip: String, offline: ::Stripe::Source::CreateParams::Mandate::Acceptance::Offline, online: ::Stripe::Source::CreateParams::Mandate::Acceptance::Online, status: String, type: String, user_agent: String).void
1538
+ }
1539
+ def initialize(
1540
+ date: nil,
1541
+ ip: nil,
1542
+ offline: nil,
1543
+ online: nil,
1544
+ status: nil,
1545
+ type: nil,
1546
+ user_agent: nil
1547
+ ); end
1548
+ end
1549
+ # The parameters required to notify Stripe of a mandate acceptance or refusal by the customer.
1550
+ sig { returns(::Stripe::Source::CreateParams::Mandate::Acceptance) }
1551
+ attr_accessor :acceptance
1552
+
1553
+ # The amount specified by the mandate. (Leave null for a mandate covering all amounts)
1554
+ sig { returns(T.nilable(Integer)) }
1555
+ attr_accessor :amount
1556
+
1557
+ # The currency specified by the mandate. (Must match `currency` of the source)
1558
+ sig { returns(String) }
1559
+ attr_accessor :currency
1560
+
1561
+ # The interval of debits permitted by the mandate. Either `one_time` (just permitting a single debit), `scheduled` (with debits on an agreed schedule or for clearly-defined events), or `variable`(for debits with any frequency)
1562
+ sig { returns(String) }
1563
+ attr_accessor :interval
1564
+
1565
+ # The method Stripe should use to notify the customer of upcoming debit instructions and/or mandate confirmation as required by the underlying debit network. Either `email` (an email is sent directly to the customer), `manual` (a `source.mandate_notification` event is sent to your webhooks endpoint and you should handle the notification) or `none` (the underlying debit network does not require any notification).
1566
+ sig { returns(String) }
1567
+ attr_accessor :notification_method
1568
+
1569
+ sig {
1570
+ params(acceptance: ::Stripe::Source::CreateParams::Mandate::Acceptance, amount: T.nilable(Integer), currency: String, interval: String, notification_method: String).void
1571
+ }
1572
+ def initialize(
1573
+ acceptance: nil,
1574
+ amount: nil,
1575
+ currency: nil,
1576
+ interval: nil,
1577
+ notification_method: nil
1578
+ ); end
1579
+ end
1580
+ class Owner < Stripe::RequestParams
1581
+ class Address < Stripe::RequestParams
1582
+ # City, district, suburb, town, or village.
1583
+ sig { returns(String) }
1584
+ attr_accessor :city
1585
+
1586
+ # Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
1587
+ sig { returns(String) }
1588
+ attr_accessor :country
1589
+
1590
+ # Address line 1 (e.g., street, PO Box, or company name).
1591
+ sig { returns(String) }
1592
+ attr_accessor :line1
1593
+
1594
+ # Address line 2 (e.g., apartment, suite, unit, or building).
1595
+ sig { returns(String) }
1596
+ attr_accessor :line2
1597
+
1598
+ # ZIP or postal code.
1599
+ sig { returns(String) }
1600
+ attr_accessor :postal_code
1601
+
1602
+ # State, county, province, or region.
1603
+ sig { returns(String) }
1604
+ attr_accessor :state
1605
+
1606
+ sig {
1607
+ params(city: String, country: String, line1: String, line2: String, postal_code: String, state: String).void
1608
+ }
1609
+ def initialize(
1610
+ city: nil,
1611
+ country: nil,
1612
+ line1: nil,
1613
+ line2: nil,
1614
+ postal_code: nil,
1615
+ state: nil
1616
+ ); end
1617
+ end
1618
+ # Owner's address.
1619
+ sig { returns(::Stripe::Source::CreateParams::Owner::Address) }
1620
+ attr_accessor :address
1621
+
1622
+ # Owner's email address.
1623
+ sig { returns(String) }
1624
+ attr_accessor :email
1625
+
1626
+ # Owner's full name.
1627
+ sig { returns(String) }
1628
+ attr_accessor :name
1629
+
1630
+ # Owner's phone number.
1631
+ sig { returns(String) }
1632
+ attr_accessor :phone
1633
+
1634
+ sig {
1635
+ params(address: ::Stripe::Source::CreateParams::Owner::Address, email: String, name: String, phone: String).void
1636
+ }
1637
+ def initialize(address: nil, email: nil, name: nil, phone: nil); end
1638
+ end
1639
+ class Receiver < Stripe::RequestParams
1640
+ # The method Stripe should use to request information needed to process a refund or mispayment. Either `email` (an email is sent directly to the customer) or `manual` (a `source.refund_attributes_required` event is sent to your webhooks endpoint). Refer to each payment method's documentation to learn which refund attributes may be required.
1641
+ sig { returns(String) }
1642
+ attr_accessor :refund_attributes_method
1643
+
1644
+ sig { params(refund_attributes_method: String).void }
1645
+ def initialize(refund_attributes_method: nil); end
1646
+ end
1647
+ class Redirect < Stripe::RequestParams
1648
+ # The URL you provide to redirect the customer back to you after they authenticated their payment. It can use your application URI scheme in the context of a mobile application.
1649
+ sig { returns(String) }
1650
+ attr_accessor :return_url
1651
+
1652
+ sig { params(return_url: String).void }
1653
+ def initialize(return_url: nil); end
1654
+ end
1655
+ class SourceOrder < Stripe::RequestParams
1656
+ class Item < Stripe::RequestParams
1657
+ # Attribute for param field amount
1658
+ sig { returns(Integer) }
1659
+ attr_accessor :amount
1660
+
1661
+ # Attribute for param field currency
1662
+ sig { returns(String) }
1663
+ attr_accessor :currency
1664
+
1665
+ # Attribute for param field description
1666
+ sig { returns(String) }
1667
+ attr_accessor :description
1668
+
1669
+ # The ID of the SKU being ordered.
1670
+ sig { returns(String) }
1671
+ attr_accessor :parent
1672
+
1673
+ # The quantity of this order item. When type is `sku`, this is the number of instances of the SKU to be ordered.
1674
+ sig { returns(Integer) }
1675
+ attr_accessor :quantity
1676
+
1677
+ # Attribute for param field type
1678
+ sig { returns(String) }
1679
+ attr_accessor :type
1680
+
1681
+ sig {
1682
+ params(amount: Integer, currency: String, description: String, parent: String, quantity: Integer, type: String).void
1683
+ }
1684
+ def initialize(
1685
+ amount: nil,
1686
+ currency: nil,
1687
+ description: nil,
1688
+ parent: nil,
1689
+ quantity: nil,
1690
+ type: nil
1691
+ ); end
1692
+ end
1693
+ class Shipping < Stripe::RequestParams
1694
+ class Address < Stripe::RequestParams
1695
+ # City, district, suburb, town, or village.
1696
+ sig { returns(String) }
1697
+ attr_accessor :city
1698
+
1699
+ # Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
1700
+ sig { returns(String) }
1701
+ attr_accessor :country
1702
+
1703
+ # Address line 1 (e.g., street, PO Box, or company name).
1704
+ sig { returns(String) }
1705
+ attr_accessor :line1
1706
+
1707
+ # Address line 2 (e.g., apartment, suite, unit, or building).
1708
+ sig { returns(String) }
1709
+ attr_accessor :line2
1710
+
1711
+ # ZIP or postal code.
1712
+ sig { returns(String) }
1713
+ attr_accessor :postal_code
1714
+
1715
+ # State, county, province, or region.
1716
+ sig { returns(String) }
1717
+ attr_accessor :state
1718
+
1719
+ sig {
1720
+ params(city: String, country: String, line1: String, line2: String, postal_code: String, state: String).void
1721
+ }
1722
+ def initialize(
1723
+ city: nil,
1724
+ country: nil,
1725
+ line1: nil,
1726
+ line2: nil,
1727
+ postal_code: nil,
1728
+ state: nil
1729
+ ); end
1730
+ end
1731
+ # Shipping address.
1732
+ sig { returns(::Stripe::Source::CreateParams::SourceOrder::Shipping::Address) }
1733
+ attr_accessor :address
1734
+
1735
+ # The delivery service that shipped a physical product, such as Fedex, UPS, USPS, etc.
1736
+ sig { returns(String) }
1737
+ attr_accessor :carrier
1738
+
1739
+ # Recipient name.
1740
+ sig { returns(String) }
1741
+ attr_accessor :name
1742
+
1743
+ # Recipient phone (including extension).
1744
+ sig { returns(String) }
1745
+ attr_accessor :phone
1746
+
1747
+ # The tracking number for a physical product, obtained from the delivery service. If multiple tracking numbers were generated for this purchase, please separate them with commas.
1748
+ sig { returns(String) }
1749
+ attr_accessor :tracking_number
1750
+
1751
+ sig {
1752
+ params(address: ::Stripe::Source::CreateParams::SourceOrder::Shipping::Address, carrier: String, name: String, phone: String, tracking_number: String).void
1753
+ }
1754
+ def initialize(
1755
+ address: nil,
1756
+ carrier: nil,
1757
+ name: nil,
1758
+ phone: nil,
1759
+ tracking_number: nil
1760
+ ); end
1761
+ end
1762
+ # List of items constituting the order.
1763
+ sig { returns(T::Array[::Stripe::Source::CreateParams::SourceOrder::Item]) }
1764
+ attr_accessor :items
1765
+
1766
+ # Shipping address for the order. Required if any of the SKUs are for products that have `shippable` set to true.
1767
+ sig { returns(::Stripe::Source::CreateParams::SourceOrder::Shipping) }
1768
+ attr_accessor :shipping
1769
+
1770
+ sig {
1771
+ params(items: T::Array[::Stripe::Source::CreateParams::SourceOrder::Item], shipping: ::Stripe::Source::CreateParams::SourceOrder::Shipping).void
1772
+ }
1773
+ def initialize(items: nil, shipping: nil); end
1774
+ end
1775
+ # Amount associated with the source. This is the amount for which the source will be chargeable once ready. Required for `single_use` sources. Not supported for `receiver` type sources, where charge amount may not be specified until funds land.
1776
+ sig { returns(Integer) }
1777
+ attr_accessor :amount
1778
+
1779
+ # Three-letter [ISO code for the currency](https://stripe.com/docs/currencies) associated with the source. This is the currency for which the source will be chargeable once ready.
1780
+ sig { returns(String) }
1781
+ attr_accessor :currency
1782
+
1783
+ # The `Customer` to whom the original source is attached to. Must be set when the original source is not a `Source` (e.g., `Card`).
1784
+ sig { returns(String) }
1785
+ attr_accessor :customer
1786
+
1787
+ # Specifies which fields in the response should be expanded.
1788
+ sig { returns(T::Array[String]) }
1789
+ attr_accessor :expand
1790
+
1791
+ # The authentication `flow` of the source to create. `flow` is one of `redirect`, `receiver`, `code_verification`, `none`. It is generally inferred unless a type supports multiple flows.
1792
+ sig { returns(String) }
1793
+ attr_accessor :flow
1794
+
1795
+ # Information about a mandate possibility attached to a source object (generally for bank debits) as well as its acceptance status.
1796
+ sig { returns(::Stripe::Source::CreateParams::Mandate) }
1797
+ attr_accessor :mandate
1798
+
1799
+ # Attribute for param field metadata
1800
+ sig { returns(T::Hash[String, String]) }
1801
+ attr_accessor :metadata
1802
+
1803
+ # The source to share.
1804
+ sig { returns(String) }
1805
+ attr_accessor :original_source
1806
+
1807
+ # Information about the owner of the payment instrument that may be used or required by particular source types.
1808
+ sig { returns(::Stripe::Source::CreateParams::Owner) }
1809
+ attr_accessor :owner
1810
+
1811
+ # Optional parameters for the receiver flow. Can be set only if the source is a receiver (`flow` is `receiver`).
1812
+ sig { returns(::Stripe::Source::CreateParams::Receiver) }
1813
+ attr_accessor :receiver
1814
+
1815
+ # Parameters required for the redirect flow. Required if the source is authenticated by a redirect (`flow` is `redirect`).
1816
+ sig { returns(::Stripe::Source::CreateParams::Redirect) }
1817
+ attr_accessor :redirect
1818
+
1819
+ # Information about the items and shipping associated with the source. Required for transactional credit (for example Klarna) sources before you can charge it.
1820
+ sig { returns(::Stripe::Source::CreateParams::SourceOrder) }
1821
+ attr_accessor :source_order
1822
+
1823
+ # An arbitrary string to be displayed on your customer's statement. As an example, if your website is `RunClub` and the item you're charging for is a race ticket, you may want to specify a `statement_descriptor` of `RunClub 5K race ticket.` While many payment types will display this information, some may not display it at all.
1824
+ sig { returns(String) }
1825
+ attr_accessor :statement_descriptor
1826
+
1827
+ # An optional token used to create the source. When passed, token properties will override source parameters.
1828
+ sig { returns(String) }
1829
+ attr_accessor :token
1830
+
1831
+ # The `type` of the source to create. Required unless `customer` and `original_source` are specified (see the [Cloning card Sources](https://stripe.com/docs/sources/connect#cloning-card-sources) guide)
1832
+ sig { returns(String) }
1833
+ attr_accessor :type
1834
+
1835
+ # Attribute for param field usage
1836
+ sig { returns(String) }
1837
+ attr_accessor :usage
1838
+
1839
+ sig {
1840
+ params(amount: Integer, currency: String, customer: String, expand: T::Array[String], flow: String, mandate: ::Stripe::Source::CreateParams::Mandate, metadata: T::Hash[String, String], original_source: String, owner: ::Stripe::Source::CreateParams::Owner, receiver: ::Stripe::Source::CreateParams::Receiver, redirect: ::Stripe::Source::CreateParams::Redirect, source_order: ::Stripe::Source::CreateParams::SourceOrder, statement_descriptor: String, token: String, type: String, usage: String).void
1841
+ }
1842
+ def initialize(
1843
+ amount: nil,
1844
+ currency: nil,
1845
+ customer: nil,
1846
+ expand: nil,
1847
+ flow: nil,
1848
+ mandate: nil,
1849
+ metadata: nil,
1850
+ original_source: nil,
1851
+ owner: nil,
1852
+ receiver: nil,
1853
+ redirect: nil,
1854
+ source_order: nil,
1855
+ statement_descriptor: nil,
1856
+ token: nil,
1857
+ type: nil,
1858
+ usage: nil
1859
+ ); end
1860
+ end
1861
+ class VerifyParams < Stripe::RequestParams
1862
+ # Specifies which fields in the response should be expanded.
1863
+ sig { returns(T::Array[String]) }
1864
+ attr_accessor :expand
1865
+
1866
+ # The values needed to verify the source.
1867
+ sig { returns(T::Array[String]) }
1868
+ attr_accessor :values
1869
+
1870
+ sig { params(expand: T::Array[String], values: T::Array[String]).void }
1871
+ def initialize(expand: nil, values: nil); end
1872
+ end
1873
+ # Creates a new source object.
1874
+ sig {
1875
+ params(params: T.any(::Stripe::Source::CreateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Source)
1876
+ }
1877
+ def self.create(params = {}, opts = {}); end
1878
+
1879
+ # Updates the specified source by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
1880
+ #
1881
+ # This request accepts the metadata and owner as arguments. It is also possible to update type specific information for selected payment methods. Please refer to our [payment method guides](https://stripe.com/docs/sources) for more detail.
1882
+ sig {
1883
+ params(id: String, params: T.any(::Stripe::Source::UpdateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Source)
1884
+ }
1885
+ def self.update(id, params = {}, opts = {}); end
1886
+
1887
+ # Verify a given source.
1888
+ sig {
1889
+ params(params: T.any(::Stripe::Source::VerifyParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Source)
1890
+ }
1891
+ def verify(params = {}, opts = {}); end
1892
+
1893
+ # Verify a given source.
1894
+ sig {
1895
+ params(source: String, params: T.any(::Stripe::Source::VerifyParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Source)
1896
+ }
1897
+ def self.verify(source, params = {}, opts = {}); end
1898
+ end
1899
+ end