stripe 13.5.0 → 14.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (641) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +33 -3
  3. data/Gemfile +4 -0
  4. data/OPENAPI_VERSION +1 -1
  5. data/README.md +29 -0
  6. data/VERSION +1 -1
  7. data/lib/stripe/api_operations/request.rb +1 -0
  8. data/lib/stripe/api_requestor.rb +3 -0
  9. data/lib/stripe/api_version.rb +1 -1
  10. data/lib/stripe/errors.rb +0 -7
  11. data/lib/stripe/object_types.rb +8 -2
  12. data/lib/stripe/request_params.rb +24 -0
  13. data/lib/stripe/resources/account.rb +4634 -0
  14. data/lib/stripe/resources/account_link.rb +54 -0
  15. data/lib/stripe/resources/account_session.rb +739 -0
  16. data/lib/stripe/resources/apple_pay_domain.rb +54 -0
  17. data/lib/stripe/resources/application.rb +20 -0
  18. data/lib/stripe/resources/application_fee.rb +87 -0
  19. data/lib/stripe/resources/application_fee_refund.rb +17 -0
  20. data/lib/stripe/resources/apps/secret.rb +141 -0
  21. data/lib/stripe/resources/balance.rb +122 -0
  22. data/lib/stripe/resources/balance_transaction.rb +103 -0
  23. data/lib/stripe/resources/bank_account.rb +84 -2
  24. data/lib/stripe/resources/billing/alert.rb +135 -0
  25. data/lib/stripe/resources/billing/alert_triggered.rb +26 -0
  26. data/lib/stripe/resources/billing/credit_balance_summary.rb +40 -0
  27. data/lib/stripe/resources/billing/credit_balance_transaction.rb +107 -0
  28. data/lib/stripe/resources/billing/credit_grant.rb +217 -0
  29. data/lib/stripe/resources/billing/meter.rb +169 -0
  30. data/lib/stripe/resources/billing/meter_event.rb +35 -0
  31. data/lib/stripe/resources/billing/meter_event_adjustment.rb +43 -0
  32. data/lib/stripe/resources/billing/meter_event_summary.rb +15 -0
  33. data/lib/stripe/resources/billing_portal/configuration.rb +553 -0
  34. data/lib/stripe/resources/billing_portal/session.rb +271 -0
  35. data/lib/stripe/resources/capability.rb +84 -0
  36. data/lib/stripe/resources/card.rb +77 -0
  37. data/lib/stripe/resources/cash_balance.rb +17 -0
  38. data/lib/stripe/resources/charge.rb +1612 -0
  39. data/lib/stripe/resources/checkout/session.rb +3530 -6
  40. data/lib/stripe/resources/climate/order.rb +167 -0
  41. data/lib/stripe/resources/climate/product.rb +47 -0
  42. data/lib/stripe/resources/climate/supplier.rb +45 -0
  43. data/lib/stripe/resources/confirmation_token.rb +1448 -0
  44. data/lib/stripe/resources/connect_collection_transfer.rb +24 -0
  45. data/lib/stripe/resources/country_spec.rb +54 -0
  46. data/lib/stripe/resources/coupon.rb +189 -0
  47. data/lib/stripe/resources/credit_note.rb +639 -0
  48. data/lib/stripe/resources/credit_note_line_item.rb +67 -0
  49. data/lib/stripe/resources/customer.rb +824 -0
  50. data/lib/stripe/resources/customer_balance_transaction.rb +29 -0
  51. data/lib/stripe/resources/customer_cash_balance_transaction.rb +109 -0
  52. data/lib/stripe/resources/customer_session.rb +159 -0
  53. data/lib/stripe/resources/discount.rb +29 -0
  54. data/lib/stripe/resources/dispute.rb +610 -0
  55. data/lib/stripe/resources/entitlements/active_entitlement.rb +37 -0
  56. data/lib/stripe/resources/entitlements/active_entitlement_summary.rb +23 -0
  57. data/lib/stripe/resources/entitlements/feature.rb +81 -0
  58. data/lib/stripe/resources/ephemeral_key.rb +21 -0
  59. data/lib/stripe/resources/event.rb +90 -0
  60. data/lib/stripe/resources/exchange_rate.rb +24 -0
  61. data/lib/stripe/resources/file.rb +102 -0
  62. data/lib/stripe/resources/file_link.rb +103 -0
  63. data/lib/stripe/resources/financial_connections/account.rb +237 -0
  64. data/lib/stripe/resources/financial_connections/account_owner.rb +17 -0
  65. data/lib/stripe/resources/financial_connections/account_ownership.rb +9 -0
  66. data/lib/stripe/resources/financial_connections/session.rb +95 -0
  67. data/lib/stripe/resources/financial_connections/transaction.rb +92 -0
  68. data/lib/stripe/resources/forwarding/request.rb +156 -0
  69. data/lib/stripe/resources/funding_instructions.rb +308 -0
  70. data/lib/stripe/resources/identity/verification_report.rb +257 -0
  71. data/lib/stripe/resources/identity/verification_session.rb +352 -0
  72. data/lib/stripe/resources/invoice.rb +3204 -21
  73. data/lib/stripe/resources/invoice_item.rb +400 -0
  74. data/lib/stripe/resources/invoice_line_item.rb +350 -0
  75. data/lib/stripe/resources/invoice_payment.rb +105 -0
  76. data/lib/stripe/resources/invoice_rendering_template.rb +55 -0
  77. data/lib/stripe/resources/issuing/authorization.rb +1104 -0
  78. data/lib/stripe/resources/issuing/card.rb +657 -0
  79. data/lib/stripe/resources/issuing/cardholder.rb +648 -0
  80. data/lib/stripe/resources/issuing/dispute.rb +781 -0
  81. data/lib/stripe/resources/issuing/personalization_design.rb +276 -0
  82. data/lib/stripe/resources/issuing/physical_bundle.rb +54 -0
  83. data/lib/stripe/resources/issuing/token.rb +166 -0
  84. data/lib/stripe/resources/issuing/transaction.rb +912 -0
  85. data/lib/stripe/resources/line_item.rb +47 -0
  86. data/lib/stripe/resources/login_link.rb +7 -0
  87. data/lib/stripe/resources/mandate.rb +142 -0
  88. data/lib/stripe/resources/payment_intent.rb +8650 -0
  89. data/lib/stripe/resources/payment_link.rb +1632 -0
  90. data/lib/stripe/resources/payment_method.rb +1542 -0
  91. data/lib/stripe/resources/payment_method_configuration.rb +2776 -0
  92. data/lib/stripe/resources/payment_method_domain.rb +150 -6
  93. data/lib/stripe/resources/payout.rb +209 -0
  94. data/lib/stripe/resources/person.rb +264 -1
  95. data/lib/stripe/resources/plan.rb +302 -0
  96. data/lib/stripe/resources/price.rb +605 -1
  97. data/lib/stripe/resources/product.rb +472 -0
  98. data/lib/stripe/resources/product_feature.rb +12 -0
  99. data/lib/stripe/resources/promotion_code.rb +212 -0
  100. data/lib/stripe/resources/quote.rb +917 -0
  101. data/lib/stripe/resources/radar/early_fraud_warning.rb +68 -0
  102. data/lib/stripe/resources/radar/value_list.rb +116 -0
  103. data/lib/stripe/resources/radar/value_list_item.rb +86 -0
  104. data/lib/stripe/resources/refund.rb +392 -0
  105. data/lib/stripe/resources/reporting/report_run.rb +141 -0
  106. data/lib/stripe/resources/reporting/report_type.rb +27 -0
  107. data/lib/stripe/resources/reserve_transaction.rb +22 -0
  108. data/lib/stripe/resources/reversal.rb +21 -0
  109. data/lib/stripe/resources/review.rb +99 -0
  110. data/lib/stripe/resources/setup_attempt.rb +368 -0
  111. data/lib/stripe/resources/setup_intent.rb +3473 -0
  112. data/lib/stripe/resources/shipping_rate.rb +250 -0
  113. data/lib/stripe/resources/sigma/scheduled_query_run.rb +45 -0
  114. data/lib/stripe/resources/source.rb +1198 -0
  115. data/lib/stripe/resources/source_mandate_notification.rb +66 -0
  116. data/lib/stripe/resources/source_transaction.rb +85 -0
  117. data/lib/stripe/resources/subscription.rb +1686 -0
  118. data/lib/stripe/resources/subscription_item.rb +313 -5
  119. data/lib/stripe/resources/subscription_schedule.rb +1281 -0
  120. data/lib/stripe/resources/tax/calculation.rb +378 -0
  121. data/lib/stripe/resources/tax/calculation_line_item.rb +56 -0
  122. data/lib/stripe/resources/tax/registration.rb +2373 -0
  123. data/lib/stripe/resources/tax/settings.rb +117 -0
  124. data/lib/stripe/resources/tax/transaction.rb +258 -0
  125. data/lib/stripe/resources/tax/transaction_line_item.rb +31 -0
  126. data/lib/stripe/resources/tax_code.rb +26 -0
  127. data/lib/stripe/resources/tax_deducted_at_source.rb +22 -0
  128. data/lib/stripe/resources/tax_id.rb +112 -0
  129. data/lib/stripe/resources/tax_rate.rb +191 -0
  130. data/lib/stripe/resources/terminal/configuration.rb +1260 -0
  131. data/lib/stripe/resources/terminal/connection_token.rb +18 -0
  132. data/lib/stripe/resources/terminal/location.rb +166 -0
  133. data/lib/stripe/resources/terminal/reader.rb +427 -0
  134. data/lib/stripe/resources/test_helpers/test_clock.rb +77 -0
  135. data/lib/stripe/resources/token.rb +1159 -0
  136. data/lib/stripe/resources/topup.rb +165 -0
  137. data/lib/stripe/resources/transfer.rb +144 -0
  138. data/lib/stripe/resources/treasury/credit_reversal.rb +83 -0
  139. data/lib/stripe/resources/treasury/debit_reversal.rb +94 -0
  140. data/lib/stripe/resources/treasury/financial_account.rb +725 -1
  141. data/lib/stripe/resources/treasury/financial_account_features.rb +189 -0
  142. data/lib/stripe/resources/treasury/inbound_transfer.rb +226 -0
  143. data/lib/stripe/resources/treasury/outbound_payment.rb +486 -0
  144. data/lib/stripe/resources/treasury/outbound_transfer.rb +341 -0
  145. data/lib/stripe/resources/treasury/received_credit.rb +237 -0
  146. data/lib/stripe/resources/treasury/received_debit.rb +196 -0
  147. data/lib/stripe/resources/treasury/transaction.rb +167 -0
  148. data/lib/stripe/resources/treasury/transaction_entry.rb +148 -0
  149. data/lib/stripe/resources/v2/amount.rb +9 -0
  150. data/lib/stripe/resources/v2/billing/meter_event.rb +18 -0
  151. data/lib/stripe/resources/v2/billing/meter_event_adjustment.rb +21 -0
  152. data/lib/stripe/resources/v2/billing/meter_event_session.rb +14 -0
  153. data/lib/stripe/resources/v2/event.rb +28 -0
  154. data/lib/stripe/resources/v2/event_destination.rb +60 -0
  155. data/lib/stripe/resources/webhook_endpoint.rb +113 -0
  156. data/lib/stripe/resources.rb +8 -2
  157. data/lib/stripe/services/account_capability_service.rb +32 -0
  158. data/lib/stripe/services/account_external_account_service.rb +250 -0
  159. data/lib/stripe/services/account_link_service.rb +46 -0
  160. data/lib/stripe/services/account_login_link_service.rb +9 -0
  161. data/lib/stripe/services/account_person_service.rb +875 -0
  162. data/lib/stripe/services/account_service.rb +4000 -0
  163. data/lib/stripe/services/account_session_service.rb +484 -0
  164. data/lib/stripe/services/apple_pay_domain_service.rb +51 -0
  165. data/lib/stripe/services/application_fee_refund_service.rb +54 -0
  166. data/lib/stripe/services/application_fee_service.rb +57 -0
  167. data/lib/stripe/services/apps/secret_service.rb +116 -0
  168. data/lib/stripe/services/balance_service.rb +9 -0
  169. data/lib/stripe/services/balance_transaction_service.rb +69 -0
  170. data/lib/stripe/services/billing/alert_service.rb +113 -0
  171. data/lib/stripe/services/billing/credit_balance_summary_service.rb +48 -0
  172. data/lib/stripe/services/billing/credit_balance_transaction_service.rb +40 -0
  173. data/lib/stripe/services/billing/credit_grant_service.rb +166 -0
  174. data/lib/stripe/services/billing/meter_event_adjustment_service.rb +26 -0
  175. data/lib/stripe/services/billing/meter_event_service.rb +21 -0
  176. data/lib/stripe/services/billing/meter_event_summary_service.rb +39 -0
  177. data/lib/stripe/services/billing/meter_service.rb +130 -0
  178. data/lib/stripe/services/billing_portal/configuration_service.rb +444 -0
  179. data/lib/stripe/services/billing_portal/session_service.rb +173 -0
  180. data/lib/stripe/services/charge_service.rb +402 -0
  181. data/lib/stripe/services/checkout/session_line_item_service.rb +18 -0
  182. data/lib/stripe/services/checkout/session_service.rb +2399 -5
  183. data/lib/stripe/services/climate/order_service.rb +102 -0
  184. data/lib/stripe/services/climate/product_service.rb +27 -0
  185. data/lib/stripe/services/climate/supplier_service.rb +27 -0
  186. data/lib/stripe/services/confirmation_token_service.rb +9 -0
  187. data/lib/stripe/services/country_spec_service.rb +27 -0
  188. data/lib/stripe/services/coupon_service.rb +152 -0
  189. data/lib/stripe/services/credit_note_line_item_service.rb +18 -0
  190. data/lib/stripe/services/credit_note_preview_lines_service.rb +152 -0
  191. data/lib/stripe/services/credit_note_service.rb +365 -0
  192. data/lib/stripe/services/customer_balance_transaction_service.rb +63 -0
  193. data/lib/stripe/services/customer_cash_balance_service.rb +29 -0
  194. data/lib/stripe/services/customer_cash_balance_transaction_service.rb +27 -0
  195. data/lib/stripe/services/customer_funding_instructions_service.rb +42 -0
  196. data/lib/stripe/services/customer_payment_method_service.rb +40 -0
  197. data/lib/stripe/services/customer_payment_source_service.rb +179 -0
  198. data/lib/stripe/services/customer_service.rb +577 -0
  199. data/lib/stripe/services/customer_session_service.rb +96 -0
  200. data/lib/stripe/services/customer_tax_id_service.rb +45 -0
  201. data/lib/stripe/services/dispute_service.rb +374 -0
  202. data/lib/stripe/services/entitlements/active_entitlement_service.rb +36 -0
  203. data/lib/stripe/services/entitlements/feature_service.rb +76 -0
  204. data/lib/stripe/services/ephemeral_key_service.rb +36 -0
  205. data/lib/stripe/services/event_service.rb +65 -0
  206. data/lib/stripe/services/exchange_rate_service.rb +27 -0
  207. data/lib/stripe/services/file_link_service.rb +94 -0
  208. data/lib/stripe/services/file_service.rb +89 -0
  209. data/lib/stripe/services/financial_connections/account_owner_service.rb +27 -0
  210. data/lib/stripe/services/financial_connections/account_service.rb +96 -0
  211. data/lib/stripe/services/financial_connections/session_service.rb +68 -0
  212. data/lib/stripe/services/financial_connections/transaction_service.rb +70 -0
  213. data/lib/stripe/services/forwarding/request_service.rb +106 -0
  214. data/lib/stripe/services/identity/verification_report_service.rb +65 -0
  215. data/lib/stripe/services/identity/verification_session_service.rb +231 -0
  216. data/lib/stripe/services/invoice_item_service.rb +334 -0
  217. data/lib/stripe/services/invoice_line_item_service.rb +221 -0
  218. data/lib/stripe/services/invoice_payment_service.rb +83 -0
  219. data/lib/stripe/services/invoice_rendering_template_service.rb +51 -0
  220. data/lib/stripe/services/invoice_service.rb +2648 -19
  221. data/lib/stripe/services/issuing/authorization_service.rb +104 -0
  222. data/lib/stripe/services/issuing/card_service.rb +455 -0
  223. data/lib/stripe/services/issuing/cardholder_service.rb +525 -0
  224. data/lib/stripe/services/issuing/dispute_service.rb +633 -0
  225. data/lib/stripe/services/issuing/personalization_design_service.rb +193 -0
  226. data/lib/stripe/services/issuing/physical_bundle_service.rb +40 -0
  227. data/lib/stripe/services/issuing/token_service.rb +73 -0
  228. data/lib/stripe/services/issuing/transaction_service.rb +77 -0
  229. data/lib/stripe/services/mandate_service.rb +9 -0
  230. data/lib/stripe/services/payment_intent_service.rb +7054 -0
  231. data/lib/stripe/services/payment_link_line_item_service.rb +18 -0
  232. data/lib/stripe/services/payment_link_service.rb +1276 -0
  233. data/lib/stripe/services/payment_method_configuration_service.rb +2004 -0
  234. data/lib/stripe/services/payment_method_domain_service.rb +79 -3
  235. data/lib/stripe/services/payment_method_service.rb +808 -0
  236. data/lib/stripe/services/payout_service.rb +159 -0
  237. data/lib/stripe/services/plan_service.rb +249 -0
  238. data/lib/stripe/services/price_service.rb +494 -1
  239. data/lib/stripe/services/product_feature_service.rb +42 -0
  240. data/lib/stripe/services/product_service.rb +425 -0
  241. data/lib/stripe/services/promotion_code_service.rb +178 -0
  242. data/lib/stripe/services/quote_computed_upfront_line_items_service.rb +18 -0
  243. data/lib/stripe/services/quote_line_item_service.rb +18 -0
  244. data/lib/stripe/services/quote_service.rb +611 -0
  245. data/lib/stripe/services/radar/early_fraud_warning_service.rb +61 -0
  246. data/lib/stripe/services/radar/value_list_item_service.rb +79 -0
  247. data/lib/stripe/services/radar/value_list_service.rb +103 -0
  248. data/lib/stripe/services/refund_service.rb +137 -0
  249. data/lib/stripe/services/reporting/report_run_service.rb +106 -0
  250. data/lib/stripe/services/reporting/report_type_service.rb +18 -0
  251. data/lib/stripe/services/review_service.rb +56 -0
  252. data/lib/stripe/services/setup_attempt_service.rb +51 -0
  253. data/lib/stripe/services/setup_intent_service.rb +3163 -0
  254. data/lib/stripe/services/shipping_rate_service.rb +200 -0
  255. data/lib/stripe/services/sigma/scheduled_query_run_service.rb +27 -0
  256. data/lib/stripe/services/source_service.rb +601 -0
  257. data/lib/stripe/services/source_transaction_service.rb +18 -0
  258. data/lib/stripe/services/subscription_item_service.rb +282 -5
  259. data/lib/stripe/services/subscription_schedule_service.rb +1062 -0
  260. data/lib/stripe/services/subscription_service.rb +1412 -0
  261. data/lib/stripe/services/tax/calculation_line_item_service.rb +18 -0
  262. data/lib/stripe/services/tax/calculation_service.rb +205 -0
  263. data/lib/stripe/services/tax/registration_service.rb +1564 -0
  264. data/lib/stripe/services/tax/settings_service.rb +74 -0
  265. data/lib/stripe/services/tax/transaction_line_item_service.rb +18 -0
  266. data/lib/stripe/services/tax/transaction_service.rb +111 -0
  267. data/lib/stripe/services/tax_code_service.rb +27 -0
  268. data/lib/stripe/services/tax_id_service.rb +79 -0
  269. data/lib/stripe/services/tax_rate_service.rb +155 -0
  270. data/lib/stripe/services/terminal/configuration_service.rb +997 -0
  271. data/lib/stripe/services/terminal/connection_token_service.rb +12 -0
  272. data/lib/stripe/services/terminal/location_service.rb +144 -0
  273. data/lib/stripe/services/terminal/reader_service.rb +266 -0
  274. data/lib/stripe/services/test_helpers/confirmation_token_service.rb +642 -0
  275. data/lib/stripe/services/test_helpers/customer_service.rb +18 -0
  276. data/lib/stripe/services/test_helpers/issuing/authorization_service.rb +745 -0
  277. data/lib/stripe/services/test_helpers/issuing/card_service.rb +45 -0
  278. data/lib/stripe/services/test_helpers/issuing/personalization_design_service.rb +41 -0
  279. data/lib/stripe/services/test_helpers/issuing/transaction_service.rb +632 -0
  280. data/lib/stripe/services/test_helpers/refund_service.rb +9 -0
  281. data/lib/stripe/services/test_helpers/terminal/reader_service.rb +44 -0
  282. data/lib/stripe/services/test_helpers/test_clock_service.rb +57 -0
  283. data/lib/stripe/services/test_helpers/treasury/inbound_transfer_service.rb +38 -0
  284. data/lib/stripe/services/test_helpers/treasury/outbound_payment_service.rb +87 -0
  285. data/lib/stripe/services/test_helpers/treasury/outbound_transfer_service.rb +87 -0
  286. data/lib/stripe/services/test_helpers/treasury/received_credit_service.rb +60 -0
  287. data/lib/stripe/services/test_helpers/treasury/received_debit_service.rb +60 -0
  288. data/lib/stripe/services/token_service.rb +1140 -0
  289. data/lib/stripe/services/topup_service.rb +142 -0
  290. data/lib/stripe/services/transfer_reversal_service.rb +66 -0
  291. data/lib/stripe/services/transfer_service.rb +119 -0
  292. data/lib/stripe/services/treasury/credit_reversal_service.rb +59 -0
  293. data/lib/stripe/services/treasury/debit_reversal_service.rb +63 -0
  294. data/lib/stripe/services/treasury/financial_account_features_service.rb +166 -0
  295. data/lib/stripe/services/treasury/financial_account_service.rb +485 -1
  296. data/lib/stripe/services/treasury/inbound_transfer_service.rb +88 -0
  297. data/lib/stripe/services/treasury/outbound_payment_service.rb +258 -0
  298. data/lib/stripe/services/treasury/outbound_transfer_service.rb +124 -0
  299. data/lib/stripe/services/treasury/received_credit_service.rb +52 -0
  300. data/lib/stripe/services/treasury/received_debit_service.rb +40 -0
  301. data/lib/stripe/services/treasury/transaction_entry_service.rb +87 -0
  302. data/lib/stripe/services/treasury/transaction_service.rb +95 -0
  303. data/lib/stripe/services/v1_services.rb +2 -1
  304. data/lib/stripe/services/v2/billing/meter_event_adjustment_service.rb +23 -0
  305. data/lib/stripe/services/v2/billing/meter_event_service.rb +25 -0
  306. data/lib/stripe/services/v2/billing/meter_event_session_service.rb +3 -0
  307. data/lib/stripe/services/v2/billing/meter_event_stream_service.rb +33 -0
  308. data/lib/stripe/services/v2/core/event_destination_service.rb +143 -0
  309. data/lib/stripe/services/v2/core/event_service.rb +15 -0
  310. data/lib/stripe/services/webhook_endpoint_service.rb +96 -0
  311. data/lib/stripe/services.rb +1 -3
  312. data/lib/stripe/stripe_client.rb +2 -1
  313. data/lib/stripe/stripe_object.rb +5 -0
  314. data/lib/stripe/version.rb +1 -1
  315. data/lib/stripe.rb +1 -0
  316. data/rbi/stripe/resources/account.rbi +4840 -0
  317. data/rbi/stripe/resources/account_link.rbi +74 -0
  318. data/rbi/stripe/resources/account_session.rbi +894 -0
  319. data/rbi/stripe/resources/apple_pay_domain.rbi +90 -0
  320. data/rbi/stripe/resources/application.rbi +20 -0
  321. data/rbi/stripe/resources/application_fee.rbi +118 -0
  322. data/rbi/stripe/resources/application_fee_refund.rbi +37 -0
  323. data/rbi/stripe/resources/apps/secret.rbi +195 -0
  324. data/rbi/stripe/resources/balance.rbi +180 -0
  325. data/rbi/stripe/resources/balance_transaction.rbi +144 -0
  326. data/rbi/stripe/resources/bank_account.rbi +127 -0
  327. data/rbi/stripe/resources/billing/alert.rbi +201 -0
  328. data/rbi/stripe/resources/billing/alert_triggered.rbi +28 -0
  329. data/rbi/stripe/resources/billing/credit_balance_summary.rbi +63 -0
  330. data/rbi/stripe/resources/billing/credit_balance_transaction.rbi +147 -0
  331. data/rbi/stripe/resources/billing/credit_grant.rbi +291 -0
  332. data/rbi/stripe/resources/billing/meter.rbi +226 -0
  333. data/rbi/stripe/resources/billing/meter_event.rbi +64 -0
  334. data/rbi/stripe/resources/billing/meter_event_adjustment.rbi +64 -0
  335. data/rbi/stripe/resources/billing/meter_event_summary.rbi +35 -0
  336. data/rbi/stripe/resources/billing_portal/configuration.rbi +645 -0
  337. data/rbi/stripe/resources/billing_portal/session.rbi +345 -0
  338. data/rbi/stripe/resources/capability.rbi +125 -0
  339. data/rbi/stripe/resources/card.rbi +125 -0
  340. data/rbi/stripe/resources/cash_balance.rbi +32 -0
  341. data/rbi/stripe/resources/charge.rbi +2054 -0
  342. data/rbi/stripe/resources/checkout/session.rbi +3951 -0
  343. data/rbi/stripe/resources/climate/order.rbi +245 -0
  344. data/rbi/stripe/resources/climate/product.rbi +75 -0
  345. data/rbi/stripe/resources/climate/supplier.rbi +72 -0
  346. data/rbi/stripe/resources/confirmation_token.rbi +1793 -0
  347. data/rbi/stripe/resources/connect_collection_transfer.rbi +26 -0
  348. data/rbi/stripe/resources/country_spec.rbi +85 -0
  349. data/rbi/stripe/resources/coupon.rbi +252 -0
  350. data/rbi/stripe/resources/credit_note.rbi +747 -0
  351. data/rbi/stripe/resources/credit_note_line_item.rbi +101 -0
  352. data/rbi/stripe/resources/customer.rbi +1009 -0
  353. data/rbi/stripe/resources/customer_balance_transaction.rbi +56 -0
  354. data/rbi/stripe/resources/customer_cash_balance_transaction.rbi +151 -0
  355. data/rbi/stripe/resources/customer_session.rbi +200 -0
  356. data/rbi/stripe/resources/discount.rbi +53 -0
  357. data/rbi/stripe/resources/dispute.rbi +761 -0
  358. data/rbi/stripe/resources/entitlements/active_entitlement.rbi +58 -0
  359. data/rbi/stripe/resources/entitlements/active_entitlement_summary.rbi +23 -0
  360. data/rbi/stripe/resources/entitlements/feature.rbi +117 -0
  361. data/rbi/stripe/resources/ephemeral_key.rbi +44 -0
  362. data/rbi/stripe/resources/event.rbi +146 -0
  363. data/rbi/stripe/resources/exchange_rate.rbi +66 -0
  364. data/rbi/stripe/resources/file.rbi +143 -0
  365. data/rbi/stripe/resources/file_link.rbi +141 -0
  366. data/rbi/stripe/resources/financial_connections/account.rbi +339 -0
  367. data/rbi/stripe/resources/financial_connections/account_owner.rbi +35 -0
  368. data/rbi/stripe/resources/financial_connections/account_ownership.rbi +23 -0
  369. data/rbi/stripe/resources/financial_connections/session.rbi +123 -0
  370. data/rbi/stripe/resources/financial_connections/transaction.rbi +124 -0
  371. data/rbi/stripe/resources/forwarding/request.rbi +216 -0
  372. data/rbi/stripe/resources/funding_instructions.rbi +437 -0
  373. data/rbi/stripe/resources/identity/verification_report.rbi +351 -0
  374. data/rbi/stripe/resources/identity/verification_session.rbi +517 -0
  375. data/rbi/stripe/resources/invoice.rbi +3733 -0
  376. data/rbi/stripe/resources/invoice_item.rbi +475 -0
  377. data/rbi/stripe/resources/invoice_line_item.rbi +432 -0
  378. data/rbi/stripe/resources/invoice_payment.rbi +114 -0
  379. data/rbi/stripe/resources/invoice_rendering_template.rbi +104 -0
  380. data/rbi/stripe/resources/issuing/authorization.rbi +1283 -0
  381. data/rbi/stripe/resources/issuing/card.rbi +741 -0
  382. data/rbi/stripe/resources/issuing/cardholder.rbi +744 -0
  383. data/rbi/stripe/resources/issuing/dispute.rbi +913 -0
  384. data/rbi/stripe/resources/issuing/personalization_design.rbi +338 -0
  385. data/rbi/stripe/resources/issuing/physical_bundle.rbi +79 -0
  386. data/rbi/stripe/resources/issuing/token.rbi +226 -0
  387. data/rbi/stripe/resources/issuing/transaction.rbi +1061 -0
  388. data/rbi/stripe/resources/line_item.rbi +72 -0
  389. data/rbi/stripe/resources/login_link.rbi +18 -0
  390. data/rbi/stripe/resources/mandate.rbi +187 -0
  391. data/rbi/stripe/resources/payment_intent.rbi +9731 -0
  392. data/rbi/stripe/resources/payment_link.rbi +1801 -0
  393. data/rbi/stripe/resources/payment_method.rbi +1822 -0
  394. data/rbi/stripe/resources/payment_method_configuration.rbi +3154 -0
  395. data/rbi/stripe/resources/payment_method_domain.rbi +212 -0
  396. data/rbi/stripe/resources/payout.rbi +300 -0
  397. data/rbi/stripe/resources/person.rbi +371 -0
  398. data/rbi/stripe/resources/plan.rbi +373 -0
  399. data/rbi/stripe/resources/price.rbi +694 -0
  400. data/rbi/stripe/resources/product.rbi +557 -0
  401. data/rbi/stripe/resources/product_feature.rbi +26 -0
  402. data/rbi/stripe/resources/promotion_code.rbi +261 -0
  403. data/rbi/stripe/resources/quote.rbi +1123 -0
  404. data/rbi/stripe/resources/radar/early_fraud_warning.rbi +98 -0
  405. data/rbi/stripe/resources/radar/value_list.rbi +170 -0
  406. data/rbi/stripe/resources/radar/value_list_item.rbi +131 -0
  407. data/rbi/stripe/resources/refund.rbi +516 -0
  408. data/rbi/stripe/resources/reporting/report_run.rbi +191 -0
  409. data/rbi/stripe/resources/reporting/report_type.rbi +57 -0
  410. data/rbi/stripe/resources/reserve_transaction.rbi +23 -0
  411. data/rbi/stripe/resources/reversal.rbi +51 -0
  412. data/rbi/stripe/resources/review.rbi +154 -0
  413. data/rbi/stripe/resources/setup_attempt.rbi +477 -0
  414. data/rbi/stripe/resources/setup_intent.rbi +3860 -0
  415. data/rbi/stripe/resources/shipping_rate.rbi +305 -0
  416. data/rbi/stripe/resources/sigma/scheduled_query_run.rbi +75 -0
  417. data/rbi/stripe/resources/source.rbi +1496 -0
  418. data/rbi/stripe/resources/source_mandate_notification.rbi +77 -0
  419. data/rbi/stripe/resources/source_transaction.rbi +127 -0
  420. data/rbi/stripe/resources/subscription.rbi +1964 -0
  421. data/rbi/stripe/resources/subscription_item.rbi +370 -0
  422. data/rbi/stripe/resources/subscription_schedule.rbi +1495 -0
  423. data/rbi/stripe/resources/tax/calculation.rbi +474 -0
  424. data/rbi/stripe/resources/tax/calculation_line_item.rbi +88 -0
  425. data/rbi/stripe/resources/tax/registration.rbi +2485 -0
  426. data/rbi/stripe/resources/tax/settings.rbi +141 -0
  427. data/rbi/stripe/resources/tax/transaction.rbi +351 -0
  428. data/rbi/stripe/resources/tax/transaction_line_item.rbi +54 -0
  429. data/rbi/stripe/resources/tax_code.rbi +44 -0
  430. data/rbi/stripe/resources/tax_deducted_at_source.rbi +23 -0
  431. data/rbi/stripe/resources/tax_id.rbi +167 -0
  432. data/rbi/stripe/resources/tax_rate.rbi +239 -0
  433. data/rbi/stripe/resources/terminal/configuration.rbi +1388 -0
  434. data/rbi/stripe/resources/terminal/connection_token.rbi +37 -0
  435. data/rbi/stripe/resources/terminal/location.rbi +224 -0
  436. data/rbi/stripe/resources/terminal/reader.rbi +587 -0
  437. data/rbi/stripe/resources/test_helpers/test_clock.rbi +134 -0
  438. data/rbi/stripe/resources/token.rbi +1217 -0
  439. data/rbi/stripe/resources/topup.rbi +222 -0
  440. data/rbi/stripe/resources/transfer.rbi +199 -0
  441. data/rbi/stripe/resources/treasury/credit_reversal.rbi +119 -0
  442. data/rbi/stripe/resources/treasury/debit_reversal.rbi +131 -0
  443. data/rbi/stripe/resources/treasury/financial_account.rbi +865 -0
  444. data/rbi/stripe/resources/treasury/financial_account_features.rbi +260 -0
  445. data/rbi/stripe/resources/treasury/inbound_transfer.rbi +295 -0
  446. data/rbi/stripe/resources/treasury/outbound_payment.rbi +592 -0
  447. data/rbi/stripe/resources/treasury/outbound_transfer.rbi +431 -0
  448. data/rbi/stripe/resources/treasury/received_credit.rbi +302 -0
  449. data/rbi/stripe/resources/treasury/received_debit.rbi +256 -0
  450. data/rbi/stripe/resources/treasury/transaction.rbi +215 -0
  451. data/rbi/stripe/resources/treasury/transaction_entry.rbi +192 -0
  452. data/rbi/stripe/resources/v2/amount.rbi +14 -0
  453. data/rbi/stripe/resources/v2/billing/meter_event.rbi +37 -0
  454. data/rbi/stripe/resources/v2/billing/meter_event_adjustment.rbi +41 -0
  455. data/rbi/stripe/resources/v2/billing/meter_event_session.rbi +31 -0
  456. data/rbi/stripe/resources/v2/event.rbi +48 -0
  457. data/rbi/stripe/resources/v2/event_destination.rbi +91 -0
  458. data/rbi/stripe/resources/webhook_endpoint.rbi +170 -0
  459. data/rbi/stripe/services/account_capability_service.rbi +51 -0
  460. data/rbi/stripe/services/account_external_account_service.rbi +306 -0
  461. data/rbi/stripe/services/account_link_service.rbi +58 -0
  462. data/rbi/stripe/services/account_login_link_service.rbi +22 -0
  463. data/rbi/stripe/services/account_person_service.rbi +923 -0
  464. data/rbi/stripe/services/account_service.rbi +4143 -0
  465. data/rbi/stripe/services/account_session_service.rbi +572 -0
  466. data/rbi/stripe/services/apple_pay_domain_service.rbi +78 -0
  467. data/rbi/stripe/services/application_fee_refund_service.rbi +93 -0
  468. data/rbi/stripe/services/application_fee_service.rbi +78 -0
  469. data/rbi/stripe/services/apps/secret_service.rbi +151 -0
  470. data/rbi/stripe/services/apps_service.rbi +9 -0
  471. data/rbi/stripe/services/balance_service.rbi +21 -0
  472. data/rbi/stripe/services/balance_transaction_service.rbi +93 -0
  473. data/rbi/stripe/services/billing/alert_service.rbi +152 -0
  474. data/rbi/stripe/services/billing/credit_balance_summary_service.rbi +68 -0
  475. data/rbi/stripe/services/billing/credit_balance_transaction_service.rbi +59 -0
  476. data/rbi/stripe/services/billing/credit_grant_service.rbi +211 -0
  477. data/rbi/stripe/services/billing/meter_event_adjustment_service.rbi +42 -0
  478. data/rbi/stripe/services/billing/meter_event_service.rbi +42 -0
  479. data/rbi/stripe/services/billing/meter_event_summary_service.rbi +54 -0
  480. data/rbi/stripe/services/billing/meter_service.rbi +163 -0
  481. data/rbi/stripe/services/billing_portal/configuration_service.rbi +511 -0
  482. data/rbi/stripe/services/billing_portal/session_service.rbi +204 -0
  483. data/rbi/stripe/services/billing_portal_service.rbi +10 -0
  484. data/rbi/stripe/services/billing_service.rbi +15 -0
  485. data/rbi/stripe/services/charge_service.rbi +448 -0
  486. data/rbi/stripe/services/checkout/session_line_item_service.rbi +33 -0
  487. data/rbi/stripe/services/checkout/session_service.rbi +2585 -0
  488. data/rbi/stripe/services/checkout_service.rbi +9 -0
  489. data/rbi/stripe/services/climate/order_service.rbi +142 -0
  490. data/rbi/stripe/services/climate/product_service.rbi +46 -0
  491. data/rbi/stripe/services/climate/supplier_service.rbi +46 -0
  492. data/rbi/stripe/services/climate_service.rbi +11 -0
  493. data/rbi/stripe/services/confirmation_token_service.rbi +20 -0
  494. data/rbi/stripe/services/country_spec_service.rbi +44 -0
  495. data/rbi/stripe/services/coupon_service.rbi +196 -0
  496. data/rbi/stripe/services/credit_note_line_item_service.rbi +31 -0
  497. data/rbi/stripe/services/credit_note_preview_lines_service.rbi +167 -0
  498. data/rbi/stripe/services/credit_note_service.rbi +416 -0
  499. data/rbi/stripe/services/customer_balance_transaction_service.rbi +92 -0
  500. data/rbi/stripe/services/customer_cash_balance_service.rbi +45 -0
  501. data/rbi/stripe/services/customer_cash_balance_transaction_service.rbi +44 -0
  502. data/rbi/stripe/services/customer_funding_instructions_service.rbi +59 -0
  503. data/rbi/stripe/services/customer_payment_method_service.rbi +57 -0
  504. data/rbi/stripe/services/customer_payment_source_service.rbi +232 -0
  505. data/rbi/stripe/services/customer_service.rbi +651 -0
  506. data/rbi/stripe/services/customer_session_service.rbi +116 -0
  507. data/rbi/stripe/services/customer_tax_id_service.rbi +72 -0
  508. data/rbi/stripe/services/dispute_service.rbi +424 -0
  509. data/rbi/stripe/services/entitlements/active_entitlement_service.rbi +55 -0
  510. data/rbi/stripe/services/entitlements/feature_service.rbi +107 -0
  511. data/rbi/stripe/services/entitlements_service.rbi +10 -0
  512. data/rbi/stripe/services/ephemeral_key_service.rbi +53 -0
  513. data/rbi/stripe/services/event_service.rbi +83 -0
  514. data/rbi/stripe/services/exchange_rate_service.rbi +44 -0
  515. data/rbi/stripe/services/file_link_service.rbi +124 -0
  516. data/rbi/stripe/services/file_service.rbi +116 -0
  517. data/rbi/stripe/services/financial_connections/account_owner_service.rbi +42 -0
  518. data/rbi/stripe/services/financial_connections/account_service.rbi +133 -0
  519. data/rbi/stripe/services/financial_connections/session_service.rbi +88 -0
  520. data/rbi/stripe/services/financial_connections/transaction_service.rbi +92 -0
  521. data/rbi/stripe/services/financial_connections_service.rbi +11 -0
  522. data/rbi/stripe/services/forwarding/request_service.rbi +134 -0
  523. data/rbi/stripe/services/forwarding_service.rbi +9 -0
  524. data/rbi/stripe/services/identity/verification_report_service.rbi +87 -0
  525. data/rbi/stripe/services/identity/verification_session_service.rbi +323 -0
  526. data/rbi/stripe/services/identity_service.rbi +10 -0
  527. data/rbi/stripe/services/invoice_item_service.rbi +368 -0
  528. data/rbi/stripe/services/invoice_line_item_service.rbi +259 -0
  529. data/rbi/stripe/services/invoice_payment_service.rbi +71 -0
  530. data/rbi/stripe/services/invoice_rendering_template_service.rbi +82 -0
  531. data/rbi/stripe/services/invoice_service.rbi +2920 -0
  532. data/rbi/stripe/services/issuing/authorization_service.rbi +146 -0
  533. data/rbi/stripe/services/issuing/card_service.rbi +495 -0
  534. data/rbi/stripe/services/issuing/cardholder_service.rbi +587 -0
  535. data/rbi/stripe/services/issuing/dispute_service.rbi +707 -0
  536. data/rbi/stripe/services/issuing/personalization_design_service.rbi +243 -0
  537. data/rbi/stripe/services/issuing/physical_bundle_service.rbi +59 -0
  538. data/rbi/stripe/services/issuing/token_service.rbi +99 -0
  539. data/rbi/stripe/services/issuing/transaction_service.rbi +105 -0
  540. data/rbi/stripe/services/issuing_service.rbi +16 -0
  541. data/rbi/stripe/services/mandate_service.rbi +20 -0
  542. data/rbi/stripe/services/payment_intent_service.rbi +7759 -0
  543. data/rbi/stripe/services/payment_link_line_item_service.rbi +31 -0
  544. data/rbi/stripe/services/payment_link_service.rbi +1352 -0
  545. data/rbi/stripe/services/payment_method_configuration_service.rbi +2211 -0
  546. data/rbi/stripe/services/payment_method_domain_service.rbi +112 -0
  547. data/rbi/stripe/services/payment_method_service.rbi +840 -0
  548. data/rbi/stripe/services/payout_service.rbi +205 -0
  549. data/rbi/stripe/services/plan_service.rbi +284 -0
  550. data/rbi/stripe/services/price_service.rbi +546 -0
  551. data/rbi/stripe/services/product_feature_service.rbi +69 -0
  552. data/rbi/stripe/services/product_service.rbi +479 -0
  553. data/rbi/stripe/services/promotion_code_service.rbi +214 -0
  554. data/rbi/stripe/services/quote_computed_upfront_line_items_service.rbi +31 -0
  555. data/rbi/stripe/services/quote_line_item_service.rbi +31 -0
  556. data/rbi/stripe/services/quote_service.rbi +686 -0
  557. data/rbi/stripe/services/radar/early_fraud_warning_service.rbi +85 -0
  558. data/rbi/stripe/services/radar/value_list_item_service.rbi +111 -0
  559. data/rbi/stripe/services/radar/value_list_service.rbi +143 -0
  560. data/rbi/stripe/services/radar_service.rbi +11 -0
  561. data/rbi/stripe/services/refund_service.rbi +185 -0
  562. data/rbi/stripe/services/reporting/report_run_service.rbi +135 -0
  563. data/rbi/stripe/services/reporting/report_type_service.rbi +35 -0
  564. data/rbi/stripe/services/reporting_service.rbi +10 -0
  565. data/rbi/stripe/services/review_service.rbi +84 -0
  566. data/rbi/stripe/services/setup_attempt_service.rbi +65 -0
  567. data/rbi/stripe/services/setup_intent_service.rbi +3596 -0
  568. data/rbi/stripe/services/shipping_rate_service.rbi +241 -0
  569. data/rbi/stripe/services/sigma/scheduled_query_run_service.rbi +46 -0
  570. data/rbi/stripe/services/sigma_service.rbi +9 -0
  571. data/rbi/stripe/services/source_service.rbi +663 -0
  572. data/rbi/stripe/services/source_transaction_service.rbi +31 -0
  573. data/rbi/stripe/services/subscription_item_service.rbi +324 -0
  574. data/rbi/stripe/services/subscription_schedule_service.rbi +1192 -0
  575. data/rbi/stripe/services/subscription_service.rbi +1596 -0
  576. data/rbi/stripe/services/tax/calculation_line_item_service.rbi +33 -0
  577. data/rbi/stripe/services/tax/calculation_service.rbi +230 -0
  578. data/rbi/stripe/services/tax/registration_service.rbi +1689 -0
  579. data/rbi/stripe/services/tax/settings_service.rbi +93 -0
  580. data/rbi/stripe/services/tax/transaction_line_item_service.rbi +33 -0
  581. data/rbi/stripe/services/tax/transaction_service.rbi +146 -0
  582. data/rbi/stripe/services/tax_code_service.rbi +44 -0
  583. data/rbi/stripe/services/tax_id_service.rbi +112 -0
  584. data/rbi/stripe/services/tax_rate_service.rbi +185 -0
  585. data/rbi/stripe/services/tax_service.rbi +12 -0
  586. data/rbi/stripe/services/terminal/configuration_service.rbi +1120 -0
  587. data/rbi/stripe/services/terminal/connection_token_service.rbi +25 -0
  588. data/rbi/stripe/services/terminal/location_service.rbi +184 -0
  589. data/rbi/stripe/services/terminal/reader_service.rbi +344 -0
  590. data/rbi/stripe/services/terminal_service.rbi +12 -0
  591. data/rbi/stripe/services/test_helpers/confirmation_token_service.rbi +746 -0
  592. data/rbi/stripe/services/test_helpers/customer_service.rbi +33 -0
  593. data/rbi/stripe/services/test_helpers/issuing/authorization_service.rbi +848 -0
  594. data/rbi/stripe/services/test_helpers/issuing/card_service.rbi +76 -0
  595. data/rbi/stripe/services/test_helpers/issuing/personalization_design_service.rbi +69 -0
  596. data/rbi/stripe/services/test_helpers/issuing/transaction_service.rbi +711 -0
  597. data/rbi/stripe/services/test_helpers/issuing_service.rbi +14 -0
  598. data/rbi/stripe/services/test_helpers/refund_service.rbi +22 -0
  599. data/rbi/stripe/services/test_helpers/terminal/reader_service.rbi +62 -0
  600. data/rbi/stripe/services/test_helpers/terminal_service.rbi +11 -0
  601. data/rbi/stripe/services/test_helpers/test_clock_service.rbi +92 -0
  602. data/rbi/stripe/services/test_helpers/treasury/inbound_transfer_service.rbi +64 -0
  603. data/rbi/stripe/services/test_helpers/treasury/outbound_payment_service.rbi +125 -0
  604. data/rbi/stripe/services/test_helpers/treasury/outbound_transfer_service.rbi +125 -0
  605. data/rbi/stripe/services/test_helpers/treasury/received_credit_service.rbi +87 -0
  606. data/rbi/stripe/services/test_helpers/treasury/received_debit_service.rbi +87 -0
  607. data/rbi/stripe/services/test_helpers/treasury_service.rbi +15 -0
  608. data/rbi/stripe/services/test_helpers_service.rbi +15 -0
  609. data/rbi/stripe/services/token_service.rbi +1189 -0
  610. data/rbi/stripe/services/topup_service.rbi +176 -0
  611. data/rbi/stripe/services/transfer_reversal_service.rbi +101 -0
  612. data/rbi/stripe/services/transfer_service.rbi +152 -0
  613. data/rbi/stripe/services/treasury/credit_reversal_service.rbi +84 -0
  614. data/rbi/stripe/services/treasury/debit_reversal_service.rbi +88 -0
  615. data/rbi/stripe/services/treasury/financial_account_features_service.rbi +198 -0
  616. data/rbi/stripe/services/treasury/financial_account_service.rbi +562 -0
  617. data/rbi/stripe/services/treasury/inbound_transfer_service.rbi +117 -0
  618. data/rbi/stripe/services/treasury/outbound_payment_service.rbi +304 -0
  619. data/rbi/stripe/services/treasury/outbound_transfer_service.rbi +157 -0
  620. data/rbi/stripe/services/treasury/received_credit_service.rbi +72 -0
  621. data/rbi/stripe/services/treasury/received_debit_service.rbi +59 -0
  622. data/rbi/stripe/services/treasury/transaction_entry_service.rbi +111 -0
  623. data/rbi/stripe/services/treasury/transaction_service.rbi +122 -0
  624. data/rbi/stripe/services/treasury_service.rbi +18 -0
  625. data/rbi/stripe/services/v1_services.rbi +77 -0
  626. data/rbi/stripe/services/v2/billing/meter_event_adjustment_service.rbi +39 -0
  627. data/rbi/stripe/services/v2/billing/meter_event_service.rbi +42 -0
  628. data/rbi/stripe/services/v2/billing/meter_event_session_service.rbi +20 -0
  629. data/rbi/stripe/services/v2/billing/meter_event_stream_service.rbi +55 -0
  630. data/rbi/stripe/services/v2/billing_service.rbi +14 -0
  631. data/rbi/stripe/services/v2/core/event_destination_service.rbi +200 -0
  632. data/rbi/stripe/services/v2/core/event_service.rbi +36 -0
  633. data/rbi/stripe/services/v2/core_service.rbi +12 -0
  634. data/rbi/stripe/services/v2_services.rbi +10 -0
  635. data/rbi/stripe/services/webhook_endpoint_service.rbi +131 -0
  636. metadata +333 -7
  637. data/lib/stripe/resources/usage_record.rb +0 -17
  638. data/lib/stripe/resources/usage_record_summary.rb +0 -12
  639. data/lib/stripe/services/invoice_upcoming_lines_service.rb +0 -17
  640. data/lib/stripe/services/subscription_item_usage_record_service.rb +0 -23
  641. data/lib/stripe/services/subscription_item_usage_record_summary_service.rb +0 -19
@@ -0,0 +1,663 @@
1
+ # File generated from our OpenAPI spec
2
+ # frozen_string_literal: true
3
+
4
+ # typed: true
5
+ module Stripe
6
+ class SourceService < StripeService
7
+ attr_reader :transactions
8
+ class DetachParams < Stripe::RequestParams
9
+ # Specifies which fields in the response should be expanded.
10
+ sig { returns(T.nilable(T::Array[String])) }
11
+ attr_accessor :expand
12
+ sig { params(expand: T.nilable(T::Array[String])).void }
13
+ def initialize(expand: nil); end
14
+ end
15
+ class RetrieveParams < Stripe::RequestParams
16
+ # The client secret of the source. Required if a publishable key is used to retrieve the source.
17
+ sig { returns(T.nilable(String)) }
18
+ attr_accessor :client_secret
19
+ # Specifies which fields in the response should be expanded.
20
+ sig { returns(T.nilable(T::Array[String])) }
21
+ attr_accessor :expand
22
+ sig { params(client_secret: T.nilable(String), expand: T.nilable(T::Array[String])).void }
23
+ def initialize(client_secret: nil, expand: nil); end
24
+ end
25
+ class UpdateParams < Stripe::RequestParams
26
+ class Mandate < Stripe::RequestParams
27
+ class Acceptance < Stripe::RequestParams
28
+ class Offline < Stripe::RequestParams
29
+ # An email to contact you with if a copy of the mandate is requested, required if `type` is `offline`.
30
+ sig { returns(String) }
31
+ attr_accessor :contact_email
32
+ sig { params(contact_email: String).void }
33
+ def initialize(contact_email: nil); end
34
+ end
35
+ class Online < Stripe::RequestParams
36
+ # The Unix timestamp (in seconds) when the mandate was accepted or refused by the customer.
37
+ sig { returns(T.nilable(Integer)) }
38
+ attr_accessor :date
39
+ # The IP address from which the mandate was accepted or refused by the customer.
40
+ sig { returns(T.nilable(String)) }
41
+ attr_accessor :ip
42
+ # The user agent of the browser from which the mandate was accepted or refused by the customer.
43
+ sig { returns(T.nilable(String)) }
44
+ attr_accessor :user_agent
45
+ sig {
46
+ params(date: T.nilable(Integer), ip: T.nilable(String), user_agent: T.nilable(String)).void
47
+ }
48
+ def initialize(date: nil, ip: nil, user_agent: nil); end
49
+ end
50
+ # The Unix timestamp (in seconds) when the mandate was accepted or refused by the customer.
51
+ sig { returns(T.nilable(Integer)) }
52
+ attr_accessor :date
53
+ # The IP address from which the mandate was accepted or refused by the customer.
54
+ sig { returns(T.nilable(String)) }
55
+ attr_accessor :ip
56
+ # The parameters required to store a mandate accepted offline. Should only be set if `mandate[type]` is `offline`
57
+ sig {
58
+ returns(T.nilable(::Stripe::SourceService::UpdateParams::Mandate::Acceptance::Offline))
59
+ }
60
+ attr_accessor :offline
61
+ # The parameters required to store a mandate accepted online. Should only be set if `mandate[type]` is `online`
62
+ sig {
63
+ returns(T.nilable(::Stripe::SourceService::UpdateParams::Mandate::Acceptance::Online))
64
+ }
65
+ attr_accessor :online
66
+ # The status of the mandate acceptance. Either `accepted` (the mandate was accepted) or `refused` (the mandate was refused).
67
+ sig { returns(String) }
68
+ attr_accessor :status
69
+ # The type of acceptance information included with the mandate. Either `online` or `offline`
70
+ sig { returns(T.nilable(String)) }
71
+ attr_accessor :type
72
+ # The user agent of the browser from which the mandate was accepted or refused by the customer.
73
+ sig { returns(T.nilable(String)) }
74
+ attr_accessor :user_agent
75
+ sig {
76
+ params(date: T.nilable(Integer), ip: T.nilable(String), offline: T.nilable(::Stripe::SourceService::UpdateParams::Mandate::Acceptance::Offline), online: T.nilable(::Stripe::SourceService::UpdateParams::Mandate::Acceptance::Online), status: String, type: T.nilable(String), user_agent: T.nilable(String)).void
77
+ }
78
+ def initialize(
79
+ date: nil,
80
+ ip: nil,
81
+ offline: nil,
82
+ online: nil,
83
+ status: nil,
84
+ type: nil,
85
+ user_agent: nil
86
+ ); end
87
+ end
88
+ # The parameters required to notify Stripe of a mandate acceptance or refusal by the customer.
89
+ sig { returns(T.nilable(::Stripe::SourceService::UpdateParams::Mandate::Acceptance)) }
90
+ attr_accessor :acceptance
91
+ # The amount specified by the mandate. (Leave null for a mandate covering all amounts)
92
+ sig { returns(T.nilable(T.nilable(T.any(String, Integer)))) }
93
+ attr_accessor :amount
94
+ # The currency specified by the mandate. (Must match `currency` of the source)
95
+ sig { returns(T.nilable(String)) }
96
+ attr_accessor :currency
97
+ # 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)
98
+ sig { returns(T.nilable(String)) }
99
+ attr_accessor :interval
100
+ # 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).
101
+ sig { returns(T.nilable(String)) }
102
+ attr_accessor :notification_method
103
+ sig {
104
+ params(acceptance: T.nilable(::Stripe::SourceService::UpdateParams::Mandate::Acceptance), amount: T.nilable(T.nilable(T.any(String, Integer))), currency: T.nilable(String), interval: T.nilable(String), notification_method: T.nilable(String)).void
105
+ }
106
+ def initialize(
107
+ acceptance: nil,
108
+ amount: nil,
109
+ currency: nil,
110
+ interval: nil,
111
+ notification_method: nil
112
+ ); end
113
+ end
114
+ class Owner < Stripe::RequestParams
115
+ class Address < Stripe::RequestParams
116
+ # City, district, suburb, town, or village.
117
+ sig { returns(T.nilable(String)) }
118
+ attr_accessor :city
119
+ # Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
120
+ sig { returns(T.nilable(String)) }
121
+ attr_accessor :country
122
+ # Address line 1 (e.g., street, PO Box, or company name).
123
+ sig { returns(T.nilable(String)) }
124
+ attr_accessor :line1
125
+ # Address line 2 (e.g., apartment, suite, unit, or building).
126
+ sig { returns(T.nilable(String)) }
127
+ attr_accessor :line2
128
+ # ZIP or postal code.
129
+ sig { returns(T.nilable(String)) }
130
+ attr_accessor :postal_code
131
+ # State, county, province, or region.
132
+ sig { returns(T.nilable(String)) }
133
+ attr_accessor :state
134
+ sig {
135
+ params(city: T.nilable(String), country: T.nilable(String), line1: T.nilable(String), line2: T.nilable(String), postal_code: T.nilable(String), state: T.nilable(String)).void
136
+ }
137
+ def initialize(
138
+ city: nil,
139
+ country: nil,
140
+ line1: nil,
141
+ line2: nil,
142
+ postal_code: nil,
143
+ state: nil
144
+ ); end
145
+ end
146
+ # Owner's address.
147
+ sig { returns(T.nilable(::Stripe::SourceService::UpdateParams::Owner::Address)) }
148
+ attr_accessor :address
149
+ # Owner's email address.
150
+ sig { returns(T.nilable(String)) }
151
+ attr_accessor :email
152
+ # Owner's full name.
153
+ sig { returns(T.nilable(String)) }
154
+ attr_accessor :name
155
+ # Owner's phone number.
156
+ sig { returns(T.nilable(String)) }
157
+ attr_accessor :phone
158
+ sig {
159
+ params(address: T.nilable(::Stripe::SourceService::UpdateParams::Owner::Address), email: T.nilable(String), name: T.nilable(String), phone: T.nilable(String)).void
160
+ }
161
+ def initialize(address: nil, email: nil, name: nil, phone: nil); end
162
+ end
163
+ class SourceOrder < Stripe::RequestParams
164
+ class Item < Stripe::RequestParams
165
+ # Attribute for param field amount
166
+ sig { returns(T.nilable(Integer)) }
167
+ attr_accessor :amount
168
+ # Attribute for param field currency
169
+ sig { returns(T.nilable(String)) }
170
+ attr_accessor :currency
171
+ # Attribute for param field description
172
+ sig { returns(T.nilable(String)) }
173
+ attr_accessor :description
174
+ # The ID of the SKU being ordered.
175
+ sig { returns(T.nilable(String)) }
176
+ attr_accessor :parent
177
+ # The quantity of this order item. When type is `sku`, this is the number of instances of the SKU to be ordered.
178
+ sig { returns(T.nilable(Integer)) }
179
+ attr_accessor :quantity
180
+ # Attribute for param field type
181
+ sig { returns(T.nilable(String)) }
182
+ attr_accessor :type
183
+ sig {
184
+ params(amount: T.nilable(Integer), currency: T.nilable(String), description: T.nilable(String), parent: T.nilable(String), quantity: T.nilable(Integer), type: T.nilable(String)).void
185
+ }
186
+ def initialize(
187
+ amount: nil,
188
+ currency: nil,
189
+ description: nil,
190
+ parent: nil,
191
+ quantity: nil,
192
+ type: nil
193
+ ); end
194
+ end
195
+ class Shipping < Stripe::RequestParams
196
+ class Address < Stripe::RequestParams
197
+ # City, district, suburb, town, or village.
198
+ sig { returns(T.nilable(String)) }
199
+ attr_accessor :city
200
+ # Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
201
+ sig { returns(T.nilable(String)) }
202
+ attr_accessor :country
203
+ # Address line 1 (e.g., street, PO Box, or company name).
204
+ sig { returns(String) }
205
+ attr_accessor :line1
206
+ # Address line 2 (e.g., apartment, suite, unit, or building).
207
+ sig { returns(T.nilable(String)) }
208
+ attr_accessor :line2
209
+ # ZIP or postal code.
210
+ sig { returns(T.nilable(String)) }
211
+ attr_accessor :postal_code
212
+ # State, county, province, or region.
213
+ sig { returns(T.nilable(String)) }
214
+ attr_accessor :state
215
+ sig {
216
+ params(city: T.nilable(String), country: T.nilable(String), line1: String, line2: T.nilable(String), postal_code: T.nilable(String), state: T.nilable(String)).void
217
+ }
218
+ def initialize(
219
+ city: nil,
220
+ country: nil,
221
+ line1: nil,
222
+ line2: nil,
223
+ postal_code: nil,
224
+ state: nil
225
+ ); end
226
+ end
227
+ # Shipping address.
228
+ sig { returns(::Stripe::SourceService::UpdateParams::SourceOrder::Shipping::Address) }
229
+ attr_accessor :address
230
+ # The delivery service that shipped a physical product, such as Fedex, UPS, USPS, etc.
231
+ sig { returns(T.nilable(String)) }
232
+ attr_accessor :carrier
233
+ # Recipient name.
234
+ sig { returns(T.nilable(String)) }
235
+ attr_accessor :name
236
+ # Recipient phone (including extension).
237
+ sig { returns(T.nilable(String)) }
238
+ attr_accessor :phone
239
+ # 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.
240
+ sig { returns(T.nilable(String)) }
241
+ attr_accessor :tracking_number
242
+ sig {
243
+ params(address: ::Stripe::SourceService::UpdateParams::SourceOrder::Shipping::Address, carrier: T.nilable(String), name: T.nilable(String), phone: T.nilable(String), tracking_number: T.nilable(String)).void
244
+ }
245
+ def initialize(
246
+ address: nil,
247
+ carrier: nil,
248
+ name: nil,
249
+ phone: nil,
250
+ tracking_number: nil
251
+ ); end
252
+ end
253
+ # List of items constituting the order.
254
+ sig {
255
+ returns(T.nilable(T::Array[::Stripe::SourceService::UpdateParams::SourceOrder::Item]))
256
+ }
257
+ attr_accessor :items
258
+ # Shipping address for the order. Required if any of the SKUs are for products that have `shippable` set to true.
259
+ sig { returns(T.nilable(::Stripe::SourceService::UpdateParams::SourceOrder::Shipping)) }
260
+ attr_accessor :shipping
261
+ sig {
262
+ params(items: T.nilable(T::Array[::Stripe::SourceService::UpdateParams::SourceOrder::Item]), shipping: T.nilable(::Stripe::SourceService::UpdateParams::SourceOrder::Shipping)).void
263
+ }
264
+ def initialize(items: nil, shipping: nil); end
265
+ end
266
+ # Amount associated with the source.
267
+ sig { returns(T.nilable(Integer)) }
268
+ attr_accessor :amount
269
+ # Specifies which fields in the response should be expanded.
270
+ sig { returns(T.nilable(T::Array[String])) }
271
+ attr_accessor :expand
272
+ # Information about a mandate possibility attached to a source object (generally for bank debits) as well as its acceptance status.
273
+ sig { returns(T.nilable(::Stripe::SourceService::UpdateParams::Mandate)) }
274
+ attr_accessor :mandate
275
+ # 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`.
276
+ sig { returns(T.nilable(T.nilable(T.any(String, T::Hash[String, String])))) }
277
+ attr_accessor :metadata
278
+ # Information about the owner of the payment instrument that may be used or required by particular source types.
279
+ sig { returns(T.nilable(::Stripe::SourceService::UpdateParams::Owner)) }
280
+ attr_accessor :owner
281
+ # Information about the items and shipping associated with the source. Required for transactional credit (for example Klarna) sources before you can charge it.
282
+ sig { returns(T.nilable(::Stripe::SourceService::UpdateParams::SourceOrder)) }
283
+ attr_accessor :source_order
284
+ sig {
285
+ params(amount: T.nilable(Integer), expand: T.nilable(T::Array[String]), mandate: T.nilable(::Stripe::SourceService::UpdateParams::Mandate), metadata: T.nilable(T.nilable(T.any(String, T::Hash[String, String]))), owner: T.nilable(::Stripe::SourceService::UpdateParams::Owner), source_order: T.nilable(::Stripe::SourceService::UpdateParams::SourceOrder)).void
286
+ }
287
+ def initialize(
288
+ amount: nil,
289
+ expand: nil,
290
+ mandate: nil,
291
+ metadata: nil,
292
+ owner: nil,
293
+ source_order: nil
294
+ ); end
295
+ end
296
+ class CreateParams < Stripe::RequestParams
297
+ class Mandate < Stripe::RequestParams
298
+ class Acceptance < Stripe::RequestParams
299
+ class Offline < Stripe::RequestParams
300
+ # An email to contact you with if a copy of the mandate is requested, required if `type` is `offline`.
301
+ sig { returns(String) }
302
+ attr_accessor :contact_email
303
+ sig { params(contact_email: String).void }
304
+ def initialize(contact_email: nil); end
305
+ end
306
+ class Online < Stripe::RequestParams
307
+ # The Unix timestamp (in seconds) when the mandate was accepted or refused by the customer.
308
+ sig { returns(T.nilable(Integer)) }
309
+ attr_accessor :date
310
+ # The IP address from which the mandate was accepted or refused by the customer.
311
+ sig { returns(T.nilable(String)) }
312
+ attr_accessor :ip
313
+ # The user agent of the browser from which the mandate was accepted or refused by the customer.
314
+ sig { returns(T.nilable(String)) }
315
+ attr_accessor :user_agent
316
+ sig {
317
+ params(date: T.nilable(Integer), ip: T.nilable(String), user_agent: T.nilable(String)).void
318
+ }
319
+ def initialize(date: nil, ip: nil, user_agent: nil); end
320
+ end
321
+ # The Unix timestamp (in seconds) when the mandate was accepted or refused by the customer.
322
+ sig { returns(T.nilable(Integer)) }
323
+ attr_accessor :date
324
+ # The IP address from which the mandate was accepted or refused by the customer.
325
+ sig { returns(T.nilable(String)) }
326
+ attr_accessor :ip
327
+ # The parameters required to store a mandate accepted offline. Should only be set if `mandate[type]` is `offline`
328
+ sig {
329
+ returns(T.nilable(::Stripe::SourceService::CreateParams::Mandate::Acceptance::Offline))
330
+ }
331
+ attr_accessor :offline
332
+ # The parameters required to store a mandate accepted online. Should only be set if `mandate[type]` is `online`
333
+ sig {
334
+ returns(T.nilable(::Stripe::SourceService::CreateParams::Mandate::Acceptance::Online))
335
+ }
336
+ attr_accessor :online
337
+ # The status of the mandate acceptance. Either `accepted` (the mandate was accepted) or `refused` (the mandate was refused).
338
+ sig { returns(String) }
339
+ attr_accessor :status
340
+ # The type of acceptance information included with the mandate. Either `online` or `offline`
341
+ sig { returns(T.nilable(String)) }
342
+ attr_accessor :type
343
+ # The user agent of the browser from which the mandate was accepted or refused by the customer.
344
+ sig { returns(T.nilable(String)) }
345
+ attr_accessor :user_agent
346
+ sig {
347
+ params(date: T.nilable(Integer), ip: T.nilable(String), offline: T.nilable(::Stripe::SourceService::CreateParams::Mandate::Acceptance::Offline), online: T.nilable(::Stripe::SourceService::CreateParams::Mandate::Acceptance::Online), status: String, type: T.nilable(String), user_agent: T.nilable(String)).void
348
+ }
349
+ def initialize(
350
+ date: nil,
351
+ ip: nil,
352
+ offline: nil,
353
+ online: nil,
354
+ status: nil,
355
+ type: nil,
356
+ user_agent: nil
357
+ ); end
358
+ end
359
+ # The parameters required to notify Stripe of a mandate acceptance or refusal by the customer.
360
+ sig { returns(T.nilable(::Stripe::SourceService::CreateParams::Mandate::Acceptance)) }
361
+ attr_accessor :acceptance
362
+ # The amount specified by the mandate. (Leave null for a mandate covering all amounts)
363
+ sig { returns(T.nilable(T.nilable(T.any(String, Integer)))) }
364
+ attr_accessor :amount
365
+ # The currency specified by the mandate. (Must match `currency` of the source)
366
+ sig { returns(T.nilable(String)) }
367
+ attr_accessor :currency
368
+ # 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)
369
+ sig { returns(T.nilable(String)) }
370
+ attr_accessor :interval
371
+ # 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).
372
+ sig { returns(T.nilable(String)) }
373
+ attr_accessor :notification_method
374
+ sig {
375
+ params(acceptance: T.nilable(::Stripe::SourceService::CreateParams::Mandate::Acceptance), amount: T.nilable(T.nilable(T.any(String, Integer))), currency: T.nilable(String), interval: T.nilable(String), notification_method: T.nilable(String)).void
376
+ }
377
+ def initialize(
378
+ acceptance: nil,
379
+ amount: nil,
380
+ currency: nil,
381
+ interval: nil,
382
+ notification_method: nil
383
+ ); end
384
+ end
385
+ class Owner < Stripe::RequestParams
386
+ class Address < Stripe::RequestParams
387
+ # City, district, suburb, town, or village.
388
+ sig { returns(T.nilable(String)) }
389
+ attr_accessor :city
390
+ # Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
391
+ sig { returns(T.nilable(String)) }
392
+ attr_accessor :country
393
+ # Address line 1 (e.g., street, PO Box, or company name).
394
+ sig { returns(T.nilable(String)) }
395
+ attr_accessor :line1
396
+ # Address line 2 (e.g., apartment, suite, unit, or building).
397
+ sig { returns(T.nilable(String)) }
398
+ attr_accessor :line2
399
+ # ZIP or postal code.
400
+ sig { returns(T.nilable(String)) }
401
+ attr_accessor :postal_code
402
+ # State, county, province, or region.
403
+ sig { returns(T.nilable(String)) }
404
+ attr_accessor :state
405
+ sig {
406
+ params(city: T.nilable(String), country: T.nilable(String), line1: T.nilable(String), line2: T.nilable(String), postal_code: T.nilable(String), state: T.nilable(String)).void
407
+ }
408
+ def initialize(
409
+ city: nil,
410
+ country: nil,
411
+ line1: nil,
412
+ line2: nil,
413
+ postal_code: nil,
414
+ state: nil
415
+ ); end
416
+ end
417
+ # Owner's address.
418
+ sig { returns(T.nilable(::Stripe::SourceService::CreateParams::Owner::Address)) }
419
+ attr_accessor :address
420
+ # Owner's email address.
421
+ sig { returns(T.nilable(String)) }
422
+ attr_accessor :email
423
+ # Owner's full name.
424
+ sig { returns(T.nilable(String)) }
425
+ attr_accessor :name
426
+ # Owner's phone number.
427
+ sig { returns(T.nilable(String)) }
428
+ attr_accessor :phone
429
+ sig {
430
+ params(address: T.nilable(::Stripe::SourceService::CreateParams::Owner::Address), email: T.nilable(String), name: T.nilable(String), phone: T.nilable(String)).void
431
+ }
432
+ def initialize(address: nil, email: nil, name: nil, phone: nil); end
433
+ end
434
+ class Receiver < Stripe::RequestParams
435
+ # 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.
436
+ sig { returns(T.nilable(String)) }
437
+ attr_accessor :refund_attributes_method
438
+ sig { params(refund_attributes_method: T.nilable(String)).void }
439
+ def initialize(refund_attributes_method: nil); end
440
+ end
441
+ class Redirect < Stripe::RequestParams
442
+ # 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.
443
+ sig { returns(String) }
444
+ attr_accessor :return_url
445
+ sig { params(return_url: String).void }
446
+ def initialize(return_url: nil); end
447
+ end
448
+ class SourceOrder < Stripe::RequestParams
449
+ class Item < Stripe::RequestParams
450
+ # Attribute for param field amount
451
+ sig { returns(T.nilable(Integer)) }
452
+ attr_accessor :amount
453
+ # Attribute for param field currency
454
+ sig { returns(T.nilable(String)) }
455
+ attr_accessor :currency
456
+ # Attribute for param field description
457
+ sig { returns(T.nilable(String)) }
458
+ attr_accessor :description
459
+ # The ID of the SKU being ordered.
460
+ sig { returns(T.nilable(String)) }
461
+ attr_accessor :parent
462
+ # The quantity of this order item. When type is `sku`, this is the number of instances of the SKU to be ordered.
463
+ sig { returns(T.nilable(Integer)) }
464
+ attr_accessor :quantity
465
+ # Attribute for param field type
466
+ sig { returns(T.nilable(String)) }
467
+ attr_accessor :type
468
+ sig {
469
+ params(amount: T.nilable(Integer), currency: T.nilable(String), description: T.nilable(String), parent: T.nilable(String), quantity: T.nilable(Integer), type: T.nilable(String)).void
470
+ }
471
+ def initialize(
472
+ amount: nil,
473
+ currency: nil,
474
+ description: nil,
475
+ parent: nil,
476
+ quantity: nil,
477
+ type: nil
478
+ ); end
479
+ end
480
+ class Shipping < Stripe::RequestParams
481
+ class Address < Stripe::RequestParams
482
+ # City, district, suburb, town, or village.
483
+ sig { returns(T.nilable(String)) }
484
+ attr_accessor :city
485
+ # Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
486
+ sig { returns(T.nilable(String)) }
487
+ attr_accessor :country
488
+ # Address line 1 (e.g., street, PO Box, or company name).
489
+ sig { returns(String) }
490
+ attr_accessor :line1
491
+ # Address line 2 (e.g., apartment, suite, unit, or building).
492
+ sig { returns(T.nilable(String)) }
493
+ attr_accessor :line2
494
+ # ZIP or postal code.
495
+ sig { returns(T.nilable(String)) }
496
+ attr_accessor :postal_code
497
+ # State, county, province, or region.
498
+ sig { returns(T.nilable(String)) }
499
+ attr_accessor :state
500
+ sig {
501
+ params(city: T.nilable(String), country: T.nilable(String), line1: String, line2: T.nilable(String), postal_code: T.nilable(String), state: T.nilable(String)).void
502
+ }
503
+ def initialize(
504
+ city: nil,
505
+ country: nil,
506
+ line1: nil,
507
+ line2: nil,
508
+ postal_code: nil,
509
+ state: nil
510
+ ); end
511
+ end
512
+ # Shipping address.
513
+ sig { returns(::Stripe::SourceService::CreateParams::SourceOrder::Shipping::Address) }
514
+ attr_accessor :address
515
+ # The delivery service that shipped a physical product, such as Fedex, UPS, USPS, etc.
516
+ sig { returns(T.nilable(String)) }
517
+ attr_accessor :carrier
518
+ # Recipient name.
519
+ sig { returns(T.nilable(String)) }
520
+ attr_accessor :name
521
+ # Recipient phone (including extension).
522
+ sig { returns(T.nilable(String)) }
523
+ attr_accessor :phone
524
+ # 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.
525
+ sig { returns(T.nilable(String)) }
526
+ attr_accessor :tracking_number
527
+ sig {
528
+ params(address: ::Stripe::SourceService::CreateParams::SourceOrder::Shipping::Address, carrier: T.nilable(String), name: T.nilable(String), phone: T.nilable(String), tracking_number: T.nilable(String)).void
529
+ }
530
+ def initialize(
531
+ address: nil,
532
+ carrier: nil,
533
+ name: nil,
534
+ phone: nil,
535
+ tracking_number: nil
536
+ ); end
537
+ end
538
+ # List of items constituting the order.
539
+ sig {
540
+ returns(T.nilable(T::Array[::Stripe::SourceService::CreateParams::SourceOrder::Item]))
541
+ }
542
+ attr_accessor :items
543
+ # Shipping address for the order. Required if any of the SKUs are for products that have `shippable` set to true.
544
+ sig { returns(T.nilable(::Stripe::SourceService::CreateParams::SourceOrder::Shipping)) }
545
+ attr_accessor :shipping
546
+ sig {
547
+ params(items: T.nilable(T::Array[::Stripe::SourceService::CreateParams::SourceOrder::Item]), shipping: T.nilable(::Stripe::SourceService::CreateParams::SourceOrder::Shipping)).void
548
+ }
549
+ def initialize(items: nil, shipping: nil); end
550
+ end
551
+ # 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.
552
+ sig { returns(T.nilable(Integer)) }
553
+ attr_accessor :amount
554
+ # 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.
555
+ sig { returns(T.nilable(String)) }
556
+ attr_accessor :currency
557
+ # The `Customer` to whom the original source is attached to. Must be set when the original source is not a `Source` (e.g., `Card`).
558
+ sig { returns(T.nilable(String)) }
559
+ attr_accessor :customer
560
+ # Specifies which fields in the response should be expanded.
561
+ sig { returns(T.nilable(T::Array[String])) }
562
+ attr_accessor :expand
563
+ # 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.
564
+ sig { returns(T.nilable(String)) }
565
+ attr_accessor :flow
566
+ # Information about a mandate possibility attached to a source object (generally for bank debits) as well as its acceptance status.
567
+ sig { returns(T.nilable(::Stripe::SourceService::CreateParams::Mandate)) }
568
+ attr_accessor :mandate
569
+ # Attribute for param field metadata
570
+ sig { returns(T.nilable(T::Hash[String, String])) }
571
+ attr_accessor :metadata
572
+ # The source to share.
573
+ sig { returns(T.nilable(String)) }
574
+ attr_accessor :original_source
575
+ # Information about the owner of the payment instrument that may be used or required by particular source types.
576
+ sig { returns(T.nilable(::Stripe::SourceService::CreateParams::Owner)) }
577
+ attr_accessor :owner
578
+ # Optional parameters for the receiver flow. Can be set only if the source is a receiver (`flow` is `receiver`).
579
+ sig { returns(T.nilable(::Stripe::SourceService::CreateParams::Receiver)) }
580
+ attr_accessor :receiver
581
+ # Parameters required for the redirect flow. Required if the source is authenticated by a redirect (`flow` is `redirect`).
582
+ sig { returns(T.nilable(::Stripe::SourceService::CreateParams::Redirect)) }
583
+ attr_accessor :redirect
584
+ # Information about the items and shipping associated with the source. Required for transactional credit (for example Klarna) sources before you can charge it.
585
+ sig { returns(T.nilable(::Stripe::SourceService::CreateParams::SourceOrder)) }
586
+ attr_accessor :source_order
587
+ # 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.
588
+ sig { returns(T.nilable(String)) }
589
+ attr_accessor :statement_descriptor
590
+ # An optional token used to create the source. When passed, token properties will override source parameters.
591
+ sig { returns(T.nilable(String)) }
592
+ attr_accessor :token
593
+ # 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)
594
+ sig { returns(T.nilable(String)) }
595
+ attr_accessor :type
596
+ # Attribute for param field usage
597
+ sig { returns(T.nilable(String)) }
598
+ attr_accessor :usage
599
+ sig {
600
+ params(amount: T.nilable(Integer), currency: T.nilable(String), customer: T.nilable(String), expand: T.nilable(T::Array[String]), flow: T.nilable(String), mandate: T.nilable(::Stripe::SourceService::CreateParams::Mandate), metadata: T.nilable(T::Hash[String, String]), original_source: T.nilable(String), owner: T.nilable(::Stripe::SourceService::CreateParams::Owner), receiver: T.nilable(::Stripe::SourceService::CreateParams::Receiver), redirect: T.nilable(::Stripe::SourceService::CreateParams::Redirect), source_order: T.nilable(::Stripe::SourceService::CreateParams::SourceOrder), statement_descriptor: T.nilable(String), token: T.nilable(String), type: T.nilable(String), usage: T.nilable(String)).void
601
+ }
602
+ def initialize(
603
+ amount: nil,
604
+ currency: nil,
605
+ customer: nil,
606
+ expand: nil,
607
+ flow: nil,
608
+ mandate: nil,
609
+ metadata: nil,
610
+ original_source: nil,
611
+ owner: nil,
612
+ receiver: nil,
613
+ redirect: nil,
614
+ source_order: nil,
615
+ statement_descriptor: nil,
616
+ token: nil,
617
+ type: nil,
618
+ usage: nil
619
+ ); end
620
+ end
621
+ class VerifyParams < Stripe::RequestParams
622
+ # Specifies which fields in the response should be expanded.
623
+ sig { returns(T.nilable(T::Array[String])) }
624
+ attr_accessor :expand
625
+ # The values needed to verify the source.
626
+ sig { returns(T::Array[String]) }
627
+ attr_accessor :values
628
+ sig { params(expand: T.nilable(T::Array[String]), values: T::Array[String]).void }
629
+ def initialize(expand: nil, values: nil); end
630
+ end
631
+ # Creates a new source object.
632
+ sig {
633
+ params(params: T.any(::Stripe::SourceService::CreateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Source)
634
+ }
635
+ def create(params = {}, opts = {}); end
636
+
637
+ # Delete a specified source for a given customer.
638
+ sig {
639
+ params(customer: String, id: String, params: T.any(::Stripe::SourceService::DetachParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(T.any(Stripe::Account, Stripe::BankAccount, Stripe::Card, Stripe::Source))
640
+ }
641
+ def detach(customer, id, params = {}, opts = {}); end
642
+
643
+ # Retrieves an existing source object. Supply the unique source ID from a source creation request and Stripe will return the corresponding up-to-date source object information.
644
+ sig {
645
+ params(source: String, params: T.any(::Stripe::SourceService::RetrieveParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Source)
646
+ }
647
+ def retrieve(source, params = {}, opts = {}); end
648
+
649
+ # Updates the specified source by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
650
+ #
651
+ # 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.
652
+ sig {
653
+ params(source: String, params: T.any(::Stripe::SourceService::UpdateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Source)
654
+ }
655
+ def update(source, params = {}, opts = {}); end
656
+
657
+ # Verify a given source.
658
+ sig {
659
+ params(source: String, params: T.any(::Stripe::SourceService::VerifyParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Source)
660
+ }
661
+ def verify(source, params = {}, opts = {}); end
662
+ end
663
+ end