stripe 13.6.0.pre.beta.1 → 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 (556) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +699 -1457
  3. data/OPENAPI_VERSION +1 -1
  4. data/README.md +29 -0
  5. data/VERSION +1 -1
  6. data/lib/stripe/api_requestor.rb +2 -0
  7. data/lib/stripe/api_version.rb +1 -1
  8. data/lib/stripe/errors.rb +0 -7
  9. data/lib/stripe/object_types.rb +0 -26
  10. data/lib/stripe/resources/account.rb +83 -614
  11. data/lib/stripe/resources/account_session.rb +1 -247
  12. data/lib/stripe/resources/apple_pay_domain.rb +0 -9
  13. data/lib/stripe/resources/application_fee.rb +1 -10
  14. data/lib/stripe/resources/balance.rb +0 -9
  15. data/lib/stripe/resources/balance_transaction.rb +2 -11
  16. data/lib/stripe/resources/bank_account.rb +1 -1
  17. data/lib/stripe/resources/billing/alert.rb +0 -9
  18. data/lib/stripe/resources/billing/credit_balance_summary.rb +0 -48
  19. data/lib/stripe/resources/billing/credit_balance_transaction.rb +0 -9
  20. data/lib/stripe/resources/billing/credit_grant.rb +4 -13
  21. data/lib/stripe/resources/billing/meter.rb +1 -10
  22. data/lib/stripe/resources/billing_portal/configuration.rb +0 -9
  23. data/lib/stripe/resources/card.rb +2 -4
  24. data/lib/stripe/resources/charge.rb +35 -1457
  25. data/lib/stripe/resources/checkout/session.rb +100 -293
  26. data/lib/stripe/resources/climate/order.rb +0 -9
  27. data/lib/stripe/resources/climate/product.rb +0 -9
  28. data/lib/stripe/resources/climate/supplier.rb +0 -9
  29. data/lib/stripe/resources/confirmation_token.rb +74 -156
  30. data/lib/stripe/resources/country_spec.rb +0 -9
  31. data/lib/stripe/resources/coupon.rb +0 -9
  32. data/lib/stripe/resources/credit_note.rb +14 -35
  33. data/lib/stripe/resources/credit_note_line_item.rb +14 -12
  34. data/lib/stripe/resources/customer.rb +12 -28
  35. data/lib/stripe/resources/customer_balance_transaction.rb +3 -1
  36. data/lib/stripe/resources/dispute.rb +0 -9
  37. data/lib/stripe/resources/entitlements/active_entitlement.rb +0 -9
  38. data/lib/stripe/resources/entitlements/feature.rb +0 -9
  39. data/lib/stripe/resources/event.rb +0 -40
  40. data/lib/stripe/resources/exchange_rate.rb +0 -9
  41. data/lib/stripe/resources/file.rb +0 -9
  42. data/lib/stripe/resources/file_link.rb +0 -9
  43. data/lib/stripe/resources/financial_connections/account.rb +0 -23
  44. data/lib/stripe/resources/financial_connections/session.rb +1 -65
  45. data/lib/stripe/resources/financial_connections/transaction.rb +0 -9
  46. data/lib/stripe/resources/forwarding/request.rb +0 -9
  47. data/lib/stripe/resources/identity/verification_report.rb +0 -9
  48. data/lib/stripe/resources/identity/verification_session.rb +0 -9
  49. data/lib/stripe/resources/invoice.rb +225 -5120
  50. data/lib/stripe/resources/invoice_item.rb +65 -110
  51. data/lib/stripe/resources/invoice_line_item.rb +106 -89
  52. data/lib/stripe/resources/invoice_payment.rb +53 -4
  53. data/lib/stripe/resources/invoice_rendering_template.rb +0 -12
  54. data/lib/stripe/resources/issuing/authorization.rb +0 -9
  55. data/lib/stripe/resources/issuing/card.rb +0 -9
  56. data/lib/stripe/resources/issuing/cardholder.rb +1 -11
  57. data/lib/stripe/resources/issuing/dispute.rb +0 -9
  58. data/lib/stripe/resources/issuing/personalization_design.rb +0 -9
  59. data/lib/stripe/resources/issuing/physical_bundle.rb +0 -9
  60. data/lib/stripe/resources/issuing/token.rb +0 -9
  61. data/lib/stripe/resources/issuing/transaction.rb +0 -15
  62. data/lib/stripe/resources/line_item.rb +0 -28
  63. data/lib/stripe/resources/mandate.rb +6 -33
  64. data/lib/stripe/resources/payment_intent.rb +642 -4975
  65. data/lib/stripe/resources/payment_link.rb +84 -15
  66. data/lib/stripe/resources/payment_method.rb +74 -187
  67. data/lib/stripe/resources/payment_method_configuration.rb +87 -214
  68. data/lib/stripe/resources/payment_method_domain.rb +9 -18
  69. data/lib/stripe/resources/payout.rb +0 -9
  70. data/lib/stripe/resources/person.rb +9 -9
  71. data/lib/stripe/resources/plan.rb +0 -15
  72. data/lib/stripe/resources/price.rb +2 -47
  73. data/lib/stripe/resources/product.rb +0 -68
  74. data/lib/stripe/resources/promotion_code.rb +0 -9
  75. data/lib/stripe/resources/quote.rb +8 -2037
  76. data/lib/stripe/resources/radar/early_fraud_warning.rb +0 -9
  77. data/lib/stripe/resources/radar/value_list.rb +0 -9
  78. data/lib/stripe/resources/radar/value_list_item.rb +0 -9
  79. data/lib/stripe/resources/refund.rb +13 -18
  80. data/lib/stripe/resources/reporting/report_run.rb +0 -9
  81. data/lib/stripe/resources/reporting/report_type.rb +0 -9
  82. data/lib/stripe/resources/review.rb +2 -11
  83. data/lib/stripe/resources/setup_attempt.rb +11 -16
  84. data/lib/stripe/resources/setup_intent.rb +158 -540
  85. data/lib/stripe/resources/shipping_rate.rb +0 -9
  86. data/lib/stripe/resources/sigma/scheduled_query_run.rb +0 -9
  87. data/lib/stripe/resources/source.rb +0 -41
  88. data/lib/stripe/resources/subscription.rb +14 -385
  89. data/lib/stripe/resources/subscription_item.rb +9 -134
  90. data/lib/stripe/resources/subscription_schedule.rb +14 -1135
  91. data/lib/stripe/resources/tax/calculation.rb +0 -9
  92. data/lib/stripe/resources/tax/registration.rb +1 -10
  93. data/lib/stripe/resources/tax/settings.rb +0 -9
  94. data/lib/stripe/resources/tax/transaction.rb +0 -9
  95. data/lib/stripe/resources/tax_code.rb +0 -9
  96. data/lib/stripe/resources/tax_id.rb +0 -9
  97. data/lib/stripe/resources/tax_rate.rb +0 -9
  98. data/lib/stripe/resources/terminal/configuration.rb +214 -14
  99. data/lib/stripe/resources/terminal/location.rb +0 -9
  100. data/lib/stripe/resources/terminal/reader.rb +0 -408
  101. data/lib/stripe/resources/test_helpers/test_clock.rb +0 -9
  102. data/lib/stripe/resources/token.rb +1 -10
  103. data/lib/stripe/resources/topup.rb +0 -9
  104. data/lib/stripe/resources/transfer.rb +0 -9
  105. data/lib/stripe/resources/treasury/credit_reversal.rb +0 -9
  106. data/lib/stripe/resources/treasury/debit_reversal.rb +0 -9
  107. data/lib/stripe/resources/treasury/financial_account.rb +4 -32
  108. data/lib/stripe/resources/treasury/financial_account_features.rb +0 -2
  109. data/lib/stripe/resources/treasury/inbound_transfer.rb +0 -9
  110. data/lib/stripe/resources/treasury/outbound_payment.rb +0 -9
  111. data/lib/stripe/resources/treasury/outbound_transfer.rb +0 -46
  112. data/lib/stripe/resources/treasury/received_credit.rb +1 -47
  113. data/lib/stripe/resources/treasury/received_debit.rb +1 -49
  114. data/lib/stripe/resources/treasury/transaction.rb +0 -9
  115. data/lib/stripe/resources/treasury/transaction_entry.rb +0 -9
  116. data/lib/stripe/resources/v2/event.rb +1 -0
  117. data/lib/stripe/resources/v2/event_destination.rb +1 -0
  118. data/lib/stripe/resources/webhook_endpoint.rb +0 -9
  119. data/lib/stripe/resources.rb +0 -25
  120. data/lib/stripe/services/account_external_account_service.rb +1 -1
  121. data/lib/stripe/services/account_service.rb +68 -509
  122. data/lib/stripe/services/account_session_service.rb +1 -217
  123. data/lib/stripe/services/balance_transaction_service.rb +1 -1
  124. data/lib/stripe/services/billing/credit_balance_summary_service.rb +2 -2
  125. data/lib/stripe/services/billing/credit_grant_service.rb +2 -2
  126. data/lib/stripe/services/billing/meter_service.rb +1 -1
  127. data/lib/stripe/services/charge_service.rb +1 -1335
  128. data/lib/stripe/services/checkout/session_service.rb +60 -168
  129. data/lib/stripe/services/credit_note_preview_lines_service.rb +0 -4
  130. data/lib/stripe/services/credit_note_service.rb +0 -8
  131. data/lib/stripe/services/customer_service.rb +0 -16
  132. data/lib/stripe/services/financial_connections/account_service.rb +1 -3
  133. data/lib/stripe/services/financial_connections/session_service.rb +1 -30
  134. data/lib/stripe/services/financial_connections_service.rb +1 -2
  135. data/lib/stripe/services/invoice_item_service.rb +34 -88
  136. data/lib/stripe/services/invoice_line_item_service.rb +25 -41
  137. data/lib/stripe/services/invoice_payment_service.rb +33 -5
  138. data/lib/stripe/services/invoice_service.rb +210 -3147
  139. data/lib/stripe/services/issuing/cardholder_service.rb +1 -2
  140. data/lib/stripe/services/issuing/transaction_service.rb +0 -4
  141. data/lib/stripe/services/issuing_service.rb +1 -5
  142. data/lib/stripe/services/payment_intent_service.rb +568 -4513
  143. data/lib/stripe/services/payment_link_service.rb +59 -6
  144. data/lib/stripe/services/payment_method_configuration_service.rb +62 -146
  145. data/lib/stripe/services/payment_method_domain_service.rb +6 -6
  146. data/lib/stripe/services/payment_method_service.rb +49 -119
  147. data/lib/stripe/services/plan_service.rb +0 -4
  148. data/lib/stripe/services/price_service.rb +2 -25
  149. data/lib/stripe/services/product_service.rb +0 -38
  150. data/lib/stripe/services/quote_service.rb +9 -1716
  151. data/lib/stripe/services/setup_intent_service.rb +158 -492
  152. data/lib/stripe/services/subscription_item_service.rb +5 -111
  153. data/lib/stripe/services/subscription_schedule_service.rb +14 -1005
  154. data/lib/stripe/services/subscription_service.rb +13 -323
  155. data/lib/stripe/services/tax/registration_service.rb +1 -1
  156. data/lib/stripe/services/tax_service.rb +1 -3
  157. data/lib/stripe/services/terminal/configuration_service.rb +170 -4
  158. data/lib/stripe/services/terminal/reader_service.rb +0 -177
  159. data/lib/stripe/services/terminal_service.rb +1 -2
  160. data/lib/stripe/services/test_helpers/confirmation_token_service.rb +49 -87
  161. data/lib/stripe/services/test_helpers/terminal/reader_service.rb +0 -43
  162. data/lib/stripe/services/test_helpers/treasury/received_credit_service.rb +1 -25
  163. data/lib/stripe/services/test_helpers/treasury/received_debit_service.rb +1 -25
  164. data/lib/stripe/services/token_service.rb +1 -1
  165. data/lib/stripe/services/treasury/financial_account_features_service.rb +1 -4
  166. data/lib/stripe/services/treasury/financial_account_service.rb +3 -17
  167. data/lib/stripe/services/treasury/outbound_transfer_service.rb +0 -24
  168. data/lib/stripe/services/v1_services.rb +2 -8
  169. data/lib/stripe/services/v2/core/event_destination_service.rb +1 -4
  170. data/lib/stripe/services/v2/core/event_service.rb +1 -4
  171. data/lib/stripe/services.rb +0 -27
  172. data/lib/stripe/stripe_client.rb +1 -0
  173. data/lib/stripe/stripe_configuration.rb +1 -3
  174. data/lib/stripe/util.rb +1 -7
  175. data/lib/stripe/version.rb +1 -1
  176. data/lib/stripe.rb +0 -45
  177. data/rbi/stripe/resources/account.rbi +1131 -1479
  178. data/rbi/stripe/resources/account_link.rbi +9 -9
  179. data/rbi/stripe/resources/account_session.rbi +118 -367
  180. data/rbi/stripe/resources/apple_pay_domain.rbi +8 -15
  181. data/rbi/stripe/resources/application_fee.rbi +15 -20
  182. data/rbi/stripe/resources/apps/secret.rbi +20 -20
  183. data/rbi/stripe/resources/balance.rbi +0 -7
  184. data/rbi/stripe/resources/balance_transaction.rbi +19 -24
  185. data/rbi/stripe/resources/bank_account.rbi +1 -1
  186. data/rbi/stripe/resources/billing/alert.rbi +23 -28
  187. data/rbi/stripe/resources/billing/credit_balance_summary.rbi +0 -53
  188. data/rbi/stripe/resources/billing/credit_balance_transaction.rbi +6 -13
  189. data/rbi/stripe/resources/billing/credit_grant.rbi +30 -37
  190. data/rbi/stripe/resources/billing/meter.rbi +19 -26
  191. data/rbi/stripe/resources/billing/meter_event.rbi +4 -4
  192. data/rbi/stripe/resources/billing/meter_event_adjustment.rbi +5 -5
  193. data/rbi/stripe/resources/billing_portal/configuration.rbi +86 -81
  194. data/rbi/stripe/resources/billing_portal/session.rbi +31 -27
  195. data/rbi/stripe/resources/card.rbi +2 -5
  196. data/rbi/stripe/resources/charge.rbi +136 -1576
  197. data/rbi/stripe/resources/checkout/session.rbi +631 -748
  198. data/rbi/stripe/resources/climate/order.rbi +20 -25
  199. data/rbi/stripe/resources/climate/product.rbi +5 -12
  200. data/rbi/stripe/resources/climate/supplier.rbi +5 -12
  201. data/rbi/stripe/resources/confirmation_token.rbi +274 -268
  202. data/rbi/stripe/resources/country_spec.rbi +5 -12
  203. data/rbi/stripe/resources/coupon.rbi +34 -39
  204. data/rbi/stripe/resources/credit_note.rbi +134 -146
  205. data/rbi/stripe/resources/credit_note_line_item.rbi +20 -18
  206. data/rbi/stripe/resources/customer.rbi +172 -164
  207. data/rbi/stripe/resources/customer_balance_transaction.rbi +4 -1
  208. data/rbi/stripe/resources/customer_session.rbi +19 -15
  209. data/rbi/stripe/resources/dispute.rbi +92 -95
  210. data/rbi/stripe/resources/entitlements/active_entitlement.rbi +5 -12
  211. data/rbi/stripe/resources/entitlements/feature.rbi +15 -22
  212. data/rbi/stripe/resources/ephemeral_key.rbi +2 -2
  213. data/rbi/stripe/resources/event.rbi +16 -60
  214. data/rbi/stripe/resources/exchange_rate.rbi +5 -12
  215. data/rbi/stripe/resources/file.rbi +20 -25
  216. data/rbi/stripe/resources/file_link.rbi +23 -28
  217. data/rbi/stripe/resources/financial_connections/account.rbi +25 -44
  218. data/rbi/stripe/resources/financial_connections/session.rbi +12 -75
  219. data/rbi/stripe/resources/financial_connections/transaction.rbi +16 -19
  220. data/rbi/stripe/resources/forwarding/request.rbi +21 -24
  221. data/rbi/stripe/resources/identity/verification_report.rbi +18 -21
  222. data/rbi/stripe/resources/identity/verification_session.rbi +60 -61
  223. data/rbi/stripe/resources/invoice.rbi +723 -5918
  224. data/rbi/stripe/resources/invoice_item.rbi +138 -177
  225. data/rbi/stripe/resources/invoice_line_item.rbi +199 -264
  226. data/rbi/stripe/resources/invoice_payment.rbi +51 -7
  227. data/rbi/stripe/resources/invoice_rendering_template.rbi +10 -20
  228. data/rbi/stripe/resources/issuing/authorization.rbi +216 -199
  229. data/rbi/stripe/resources/issuing/card.rbi +104 -101
  230. data/rbi/stripe/resources/issuing/cardholder.rbi +120 -108
  231. data/rbi/stripe/resources/issuing/dispute.rbi +164 -151
  232. data/rbi/stripe/resources/issuing/personalization_design.rbi +61 -56
  233. data/rbi/stripe/resources/issuing/physical_bundle.rbi +7 -14
  234. data/rbi/stripe/resources/issuing/token.rbi +16 -21
  235. data/rbi/stripe/resources/issuing/transaction.rbi +180 -176
  236. data/rbi/stripe/resources/line_item.rbi +0 -36
  237. data/rbi/stripe/resources/mandate.rbi +8 -40
  238. data/rbi/stripe/resources/payment_intent.rbi +2252 -6482
  239. data/rbi/stripe/resources/payment_link.rbi +346 -211
  240. data/rbi/stripe/resources/payment_method.rbi +226 -330
  241. data/rbi/stripe/resources/payment_method_configuration.rbi +602 -685
  242. data/rbi/stripe/resources/payment_method_domain.rbi +26 -31
  243. data/rbi/stripe/resources/payout.rbi +43 -42
  244. data/rbi/stripe/resources/person.rbi +9 -9
  245. data/rbi/stripe/resources/plan.rbi +51 -63
  246. data/rbi/stripe/resources/price.rbi +114 -151
  247. data/rbi/stripe/resources/product.rbi +90 -152
  248. data/rbi/stripe/resources/promotion_code.rbi +42 -47
  249. data/rbi/stripe/resources/quote.rbi +168 -2231
  250. data/rbi/stripe/resources/radar/early_fraud_warning.rbi +17 -20
  251. data/rbi/stripe/resources/radar/value_list.rbi +24 -29
  252. data/rbi/stripe/resources/radar/value_list_item.rbi +18 -21
  253. data/rbi/stripe/resources/refund.rbi +52 -51
  254. data/rbi/stripe/resources/reporting/report_run.rbi +27 -30
  255. data/rbi/stripe/resources/reporting/report_type.rbi +2 -9
  256. data/rbi/stripe/resources/review.rbi +17 -22
  257. data/rbi/stripe/resources/setup_attempt.rbi +25 -32
  258. data/rbi/stripe/resources/setup_intent.rbi +900 -1102
  259. data/rbi/stripe/resources/shipping_rate.rbi +41 -46
  260. data/rbi/stripe/resources/sigma/scheduled_query_run.rbi +5 -12
  261. data/rbi/stripe/resources/source.rbi +132 -179
  262. data/rbi/stripe/resources/subscription.rbi +363 -707
  263. data/rbi/stripe/resources/subscription_item.rbi +69 -177
  264. data/rbi/stripe/resources/subscription_schedule.rbi +289 -1447
  265. data/rbi/stripe/resources/tax/calculation.rbi +43 -48
  266. data/rbi/stripe/resources/tax/registration.rbi +217 -170
  267. data/rbi/stripe/resources/tax/settings.rbi +14 -21
  268. data/rbi/stripe/resources/tax/transaction.rbi +20 -25
  269. data/rbi/stripe/resources/tax_code.rbi +5 -12
  270. data/rbi/stripe/resources/tax_id.rbi +15 -22
  271. data/rbi/stripe/resources/tax_rate.rbi +34 -39
  272. data/rbi/stripe/resources/terminal/configuration.rbi +457 -212
  273. data/rbi/stripe/resources/terminal/connection_token.rbi +3 -3
  274. data/rbi/stripe/resources/terminal/location.rbi +28 -35
  275. data/rbi/stripe/resources/terminal/reader.rbi +71 -441
  276. data/rbi/stripe/resources/test_helpers/test_clock.rbi +12 -17
  277. data/rbi/stripe/resources/token.rbi +288 -263
  278. data/rbi/stripe/resources/topup.rbi +35 -38
  279. data/rbi/stripe/resources/transfer.rbi +27 -32
  280. data/rbi/stripe/resources/treasury/credit_reversal.rbi +10 -17
  281. data/rbi/stripe/resources/treasury/debit_reversal.rbi +11 -18
  282. data/rbi/stripe/resources/treasury/financial_account.rbi +125 -130
  283. data/rbi/stripe/resources/treasury/financial_account_features.rbi +0 -3
  284. data/rbi/stripe/resources/treasury/inbound_transfer.rbi +22 -29
  285. data/rbi/stripe/resources/treasury/outbound_payment.rbi +82 -79
  286. data/rbi/stripe/resources/treasury/outbound_transfer.rbi +44 -86
  287. data/rbi/stripe/resources/treasury/received_credit.rbi +18 -64
  288. data/rbi/stripe/resources/treasury/received_debit.rbi +17 -66
  289. data/rbi/stripe/resources/treasury/transaction.rbi +27 -28
  290. data/rbi/stripe/resources/treasury/transaction_entry.rbi +25 -26
  291. data/rbi/stripe/resources/v2/amount.rbi +1 -1
  292. data/rbi/stripe/resources/v2/event.rbi +1 -0
  293. data/rbi/stripe/resources/v2/event_destination.rbi +1 -0
  294. data/rbi/stripe/resources/webhook_endpoint.rbi +18 -25
  295. data/rbi/stripe/services/account_capability_service.rbi +7 -7
  296. data/rbi/stripe/services/account_external_account_service.rbi +52 -52
  297. data/rbi/stripe/services/account_link_service.rbi +9 -9
  298. data/rbi/stripe/services/account_login_link_service.rbi +2 -2
  299. data/rbi/stripe/services/account_person_service.rbi +221 -201
  300. data/rbi/stripe/services/account_service.rbi +1221 -1345
  301. data/rbi/stripe/services/account_session_service.rbi +115 -346
  302. data/rbi/stripe/services/apple_pay_domain_service.rbi +10 -10
  303. data/rbi/stripe/services/application_fee_refund_service.rbi +16 -14
  304. data/rbi/stripe/services/application_fee_service.rbi +18 -14
  305. data/rbi/stripe/services/apps/secret_service.rbi +20 -20
  306. data/rbi/stripe/services/balance_service.rbi +2 -2
  307. data/rbi/stripe/services/balance_transaction_service.rbi +22 -18
  308. data/rbi/stripe/services/billing/alert_service.rbi +23 -23
  309. data/rbi/stripe/services/billing/credit_balance_summary_service.rbi +10 -10
  310. data/rbi/stripe/services/billing/credit_balance_transaction_service.rbi +8 -8
  311. data/rbi/stripe/services/billing/credit_grant_service.rbi +32 -30
  312. data/rbi/stripe/services/billing/meter_event_adjustment_service.rbi +7 -5
  313. data/rbi/stripe/services/billing/meter_event_service.rbi +4 -4
  314. data/rbi/stripe/services/billing/meter_event_summary_service.rbi +6 -6
  315. data/rbi/stripe/services/billing/meter_service.rbi +21 -21
  316. data/rbi/stripe/services/billing_portal/configuration_service.rbi +90 -76
  317. data/rbi/stripe/services/billing_portal/session_service.rbi +29 -27
  318. data/rbi/stripe/services/charge_service.rbi +96 -1464
  319. data/rbi/stripe/services/checkout/session_line_item_service.rbi +5 -5
  320. data/rbi/stripe/services/checkout/session_service.rbi +555 -591
  321. data/rbi/stripe/services/climate/order_service.rbi +22 -20
  322. data/rbi/stripe/services/climate/product_service.rbi +7 -7
  323. data/rbi/stripe/services/climate/supplier_service.rbi +7 -7
  324. data/rbi/stripe/services/confirmation_token_service.rbi +2 -2
  325. data/rbi/stripe/services/country_spec_service.rbi +7 -7
  326. data/rbi/stripe/services/coupon_service.rbi +40 -34
  327. data/rbi/stripe/services/credit_note_line_item_service.rbi +5 -5
  328. data/rbi/stripe/services/credit_note_preview_lines_service.rbi +35 -35
  329. data/rbi/stripe/services/credit_note_service.rbi +81 -85
  330. data/rbi/stripe/services/customer_balance_transaction_service.rbi +15 -15
  331. data/rbi/stripe/services/customer_cash_balance_service.rbi +7 -7
  332. data/rbi/stripe/services/customer_cash_balance_transaction_service.rbi +7 -7
  333. data/rbi/stripe/services/customer_funding_instructions_service.rbi +5 -5
  334. data/rbi/stripe/services/customer_payment_method_service.rbi +9 -9
  335. data/rbi/stripe/services/customer_payment_source_service.rbi +48 -44
  336. data/rbi/stripe/services/customer_service.rbi +143 -139
  337. data/rbi/stripe/services/customer_session_service.rbi +21 -15
  338. data/rbi/stripe/services/customer_tax_id_service.rbi +9 -9
  339. data/rbi/stripe/services/dispute_service.rbi +92 -90
  340. data/rbi/stripe/services/entitlements/active_entitlement_service.rbi +7 -7
  341. data/rbi/stripe/services/entitlements/feature_service.rbi +17 -17
  342. data/rbi/stripe/services/ephemeral_key_service.rbi +8 -8
  343. data/rbi/stripe/services/event_service.rbi +18 -16
  344. data/rbi/stripe/services/exchange_rate_service.rbi +7 -7
  345. data/rbi/stripe/services/file_link_service.rbi +25 -23
  346. data/rbi/stripe/services/file_service.rbi +22 -20
  347. data/rbi/stripe/services/financial_connections/account_owner_service.rbi +5 -5
  348. data/rbi/stripe/services/financial_connections/account_service.rbi +22 -21
  349. data/rbi/stripe/services/financial_connections/session_service.rbi +16 -39
  350. data/rbi/stripe/services/financial_connections/transaction_service.rbi +16 -14
  351. data/rbi/stripe/services/financial_connections_service.rbi +0 -1
  352. data/rbi/stripe/services/forwarding/request_service.rbi +21 -19
  353. data/rbi/stripe/services/identity/verification_report_service.rbi +18 -16
  354. data/rbi/stripe/services/identity/verification_session_service.rbi +62 -56
  355. data/rbi/stripe/services/invoice_item_service.rbi +99 -155
  356. data/rbi/stripe/services/invoice_line_item_service.rbi +71 -82
  357. data/rbi/stripe/services/invoice_payment_service.rbi +39 -12
  358. data/rbi/stripe/services/invoice_rendering_template_service.rbi +13 -13
  359. data/rbi/stripe/services/invoice_service.rbi +679 -3799
  360. data/rbi/stripe/services/issuing/authorization_service.rbi +32 -26
  361. data/rbi/stripe/services/issuing/card_service.rbi +102 -86
  362. data/rbi/stripe/services/issuing/cardholder_service.rbi +122 -103
  363. data/rbi/stripe/services/issuing/dispute_service.rbi +152 -146
  364. data/rbi/stripe/services/issuing/personalization_design_service.rbi +52 -42
  365. data/rbi/stripe/services/issuing/physical_bundle_service.rbi +9 -9
  366. data/rbi/stripe/services/issuing/token_service.rbi +20 -16
  367. data/rbi/stripe/services/issuing/transaction_service.rbi +25 -23
  368. data/rbi/stripe/services/issuing_service.rbi +0 -3
  369. data/rbi/stripe/services/mandate_service.rbi +2 -2
  370. data/rbi/stripe/services/payment_intent_service.rbi +2312 -6081
  371. data/rbi/stripe/services/payment_link_line_item_service.rbi +5 -5
  372. data/rbi/stripe/services/payment_link_service.rbi +303 -201
  373. data/rbi/stripe/services/payment_method_configuration_service.rbi +616 -620
  374. data/rbi/stripe/services/payment_method_domain_service.rbi +25 -23
  375. data/rbi/stripe/services/payment_method_service.rbi +192 -249
  376. data/rbi/stripe/services/payout_service.rbi +45 -37
  377. data/rbi/stripe/services/plan_service.rbi +53 -55
  378. data/rbi/stripe/services/price_service.rbi +124 -129
  379. data/rbi/stripe/services/product_feature_service.rbi +9 -9
  380. data/rbi/stripe/services/product_service.rbi +94 -122
  381. data/rbi/stripe/services/promotion_code_service.rbi +46 -42
  382. data/rbi/stripe/services/quote_computed_upfront_line_items_service.rbi +5 -5
  383. data/rbi/stripe/services/quote_line_item_service.rbi +5 -5
  384. data/rbi/stripe/services/quote_service.rbi +159 -1863
  385. data/rbi/stripe/services/radar/early_fraud_warning_service.rbi +17 -15
  386. data/rbi/stripe/services/radar/value_list_item_service.rbi +20 -16
  387. data/rbi/stripe/services/radar/value_list_service.rbi +28 -24
  388. data/rbi/stripe/services/refund_service.rbi +37 -33
  389. data/rbi/stripe/services/reporting/report_run_service.rbi +29 -25
  390. data/rbi/stripe/services/reporting/report_type_service.rbi +4 -4
  391. data/rbi/stripe/services/review_service.rbi +17 -15
  392. data/rbi/stripe/services/setup_attempt_service.rbi +13 -11
  393. data/rbi/stripe/services/setup_intent_service.rbi +1028 -1062
  394. data/rbi/stripe/services/shipping_rate_service.rbi +47 -41
  395. data/rbi/stripe/services/sigma/scheduled_query_run_service.rbi +7 -7
  396. data/rbi/stripe/services/source_service.rbi +149 -133
  397. data/rbi/stripe/services/source_transaction_service.rbi +5 -5
  398. data/rbi/stripe/services/subscription_item_service.rbi +61 -159
  399. data/rbi/stripe/services/subscription_schedule_service.rbi +289 -1305
  400. data/rbi/stripe/services/subscription_service.rbi +366 -640
  401. data/rbi/stripe/services/tax/calculation_line_item_service.rbi +5 -5
  402. data/rbi/stripe/services/tax/calculation_service.rbi +40 -38
  403. data/rbi/stripe/services/tax/registration_service.rbi +337 -165
  404. data/rbi/stripe/services/tax/settings_service.rbi +16 -16
  405. data/rbi/stripe/services/tax/transaction_line_item_service.rbi +5 -5
  406. data/rbi/stripe/services/tax/transaction_service.rbi +19 -15
  407. data/rbi/stripe/services/tax_code_service.rbi +7 -7
  408. data/rbi/stripe/services/tax_id_service.rbi +17 -17
  409. data/rbi/stripe/services/tax_rate_service.rbi +36 -34
  410. data/rbi/stripe/services/tax_service.rbi +0 -2
  411. data/rbi/stripe/services/terminal/configuration_service.rbi +464 -204
  412. data/rbi/stripe/services/terminal/connection_token_service.rbi +3 -3
  413. data/rbi/stripe/services/terminal/location_service.rbi +30 -30
  414. data/rbi/stripe/services/terminal/reader_service.rbi +57 -226
  415. data/rbi/stripe/services/terminal_service.rbi +0 -1
  416. data/rbi/stripe/services/test_helpers/confirmation_token_service.rbi +157 -198
  417. data/rbi/stripe/services/test_helpers/customer_service.rbi +3 -3
  418. data/rbi/stripe/services/test_helpers/issuing/authorization_service.rbi +180 -168
  419. data/rbi/stripe/services/test_helpers/issuing/card_service.rbi +10 -10
  420. data/rbi/stripe/services/test_helpers/issuing/personalization_design_service.rbi +11 -9
  421. data/rbi/stripe/services/test_helpers/issuing/transaction_service.rbi +151 -145
  422. data/rbi/stripe/services/test_helpers/refund_service.rbi +2 -2
  423. data/rbi/stripe/services/test_helpers/terminal/reader_service.rbi +10 -39
  424. data/rbi/stripe/services/test_helpers/test_clock_service.rbi +14 -12
  425. data/rbi/stripe/services/test_helpers/treasury/inbound_transfer_service.rbi +9 -9
  426. data/rbi/stripe/services/test_helpers/treasury/outbound_payment_service.rbi +20 -18
  427. data/rbi/stripe/services/test_helpers/treasury/outbound_transfer_service.rbi +20 -18
  428. data/rbi/stripe/services/test_helpers/treasury/received_credit_service.rbi +11 -38
  429. data/rbi/stripe/services/test_helpers/treasury/received_debit_service.rbi +11 -38
  430. data/rbi/stripe/services/token_service.rbi +292 -258
  431. data/rbi/stripe/services/topup_service.rbi +37 -33
  432. data/rbi/stripe/services/transfer_reversal_service.rbi +18 -16
  433. data/rbi/stripe/services/transfer_service.rbi +29 -27
  434. data/rbi/stripe/services/treasury/credit_reversal_service.rbi +12 -12
  435. data/rbi/stripe/services/treasury/debit_reversal_service.rbi +13 -13
  436. data/rbi/stripe/services/treasury/financial_account_features_service.rbi +23 -26
  437. data/rbi/stripe/services/treasury/financial_account_service.rbi +92 -96
  438. data/rbi/stripe/services/treasury/inbound_transfer_service.rbi +15 -15
  439. data/rbi/stripe/services/treasury/outbound_payment_service.rbi +60 -56
  440. data/rbi/stripe/services/treasury/outbound_transfer_service.rbi +24 -49
  441. data/rbi/stripe/services/treasury/received_credit_service.rbi +11 -9
  442. data/rbi/stripe/services/treasury/received_debit_service.rbi +8 -8
  443. data/rbi/stripe/services/treasury/transaction_entry_service.rbi +25 -21
  444. data/rbi/stripe/services/treasury/transaction_service.rbi +31 -23
  445. data/rbi/stripe/services/v1_services.rbi +1 -7
  446. data/rbi/stripe/services/v2/billing/meter_event_service.rbi +3 -3
  447. data/rbi/stripe/services/v2/billing/meter_event_stream_service.rbi +3 -3
  448. data/rbi/stripe/services/v2/core/event_destination_service.rbi +21 -24
  449. data/rbi/stripe/services/v2/core/event_service.rbi +3 -6
  450. data/rbi/stripe/services/webhook_endpoint_service.rbi +20 -20
  451. metadata +4 -109
  452. data/lib/stripe/request_signing_authenticator.rb +0 -79
  453. data/lib/stripe/resources/account_notice.rb +0 -132
  454. data/lib/stripe/resources/billing/meter_error_report.rb +0 -59
  455. data/lib/stripe/resources/capital/financing_offer.rb +0 -188
  456. data/lib/stripe/resources/capital/financing_summary.rb +0 -64
  457. data/lib/stripe/resources/capital/financing_transaction.rb +0 -123
  458. data/lib/stripe/resources/financial_connections/account_inferred_balance.rb +0 -27
  459. data/lib/stripe/resources/financial_connections/institution.rb +0 -99
  460. data/lib/stripe/resources/gift_cards/card.rb +0 -217
  461. data/lib/stripe/resources/gift_cards/transaction.rb +0 -281
  462. data/lib/stripe/resources/issuing/credit_underwriting_record.rb +0 -611
  463. data/lib/stripe/resources/issuing/dispute_settlement_detail.rb +0 -84
  464. data/lib/stripe/resources/issuing/fraud_liability_debit.rb +0 -95
  465. data/lib/stripe/resources/issuing/settlement.rb +0 -49
  466. data/lib/stripe/resources/margin.rb +0 -124
  467. data/lib/stripe/resources/order.rb +0 -2868
  468. data/lib/stripe/resources/payment_attempt_record.rb +0 -184
  469. data/lib/stripe/resources/payment_record.rb +0 -715
  470. data/lib/stripe/resources/quote_line.rb +0 -274
  471. data/lib/stripe/resources/quote_preview_invoice.rb +0 -652
  472. data/lib/stripe/resources/quote_preview_subscription_schedule.rb +0 -362
  473. data/lib/stripe/resources/tax/association.rb +0 -89
  474. data/lib/stripe/resources/tax/form.rb +0 -220
  475. data/lib/stripe/resources/terminal/reader_collected_data.rb +0 -40
  476. data/lib/stripe/resources/usage_record.rb +0 -30
  477. data/lib/stripe/resources/usage_record_summary.rb +0 -33
  478. data/lib/stripe/services/account_notice_service.rb +0 -101
  479. data/lib/stripe/services/capital/financing_offer_service.rb +0 -112
  480. data/lib/stripe/services/capital/financing_summary_service.rb +0 -28
  481. data/lib/stripe/services/capital/financing_transaction_service.rb +0 -79
  482. data/lib/stripe/services/capital_service.rb +0 -15
  483. data/lib/stripe/services/financial_connections/account_inferred_balance_service.rb +0 -37
  484. data/lib/stripe/services/financial_connections/institution_service.rb +0 -57
  485. data/lib/stripe/services/gift_cards/card_service.rb +0 -170
  486. data/lib/stripe/services/gift_cards/transaction_service.rb +0 -209
  487. data/lib/stripe/services/gift_cards_service.rb +0 -14
  488. data/lib/stripe/services/invoice_upcoming_lines_service.rb +0 -1881
  489. data/lib/stripe/services/issuing/credit_underwriting_record_service.rb +0 -504
  490. data/lib/stripe/services/issuing/dispute_settlement_detail_service.rb +0 -66
  491. data/lib/stripe/services/issuing/fraud_liability_debit_service.rb +0 -83
  492. data/lib/stripe/services/margin_service.rb +0 -119
  493. data/lib/stripe/services/order_line_item_service.rb +0 -35
  494. data/lib/stripe/services/order_service.rb +0 -2268
  495. data/lib/stripe/services/payment_attempt_record_service.rb +0 -49
  496. data/lib/stripe/services/payment_record_service.rb +0 -542
  497. data/lib/stripe/services/quote_line_service.rb +0 -35
  498. data/lib/stripe/services/quote_preview_invoice_service.rb +0 -35
  499. data/lib/stripe/services/quote_preview_subscription_schedule_service.rb +0 -35
  500. data/lib/stripe/services/subscription_item_usage_record_service.rb +0 -41
  501. data/lib/stripe/services/subscription_item_usage_record_summary_service.rb +0 -37
  502. data/lib/stripe/services/tax/association_service.rb +0 -31
  503. data/lib/stripe/services/tax/form_service.rb +0 -100
  504. data/lib/stripe/services/terminal/reader_collected_data_service.rb +0 -28
  505. data/rbi/stripe/resources/account_notice.rbi +0 -139
  506. data/rbi/stripe/resources/billing/meter_error_report.rbi +0 -71
  507. data/rbi/stripe/resources/capital/financing_offer.rbi +0 -190
  508. data/rbi/stripe/resources/capital/financing_summary.rbi +0 -74
  509. data/rbi/stripe/resources/capital/financing_transaction.rbi +0 -130
  510. data/rbi/stripe/resources/financial_connections/account_inferred_balance.rbi +0 -27
  511. data/rbi/stripe/resources/financial_connections/institution.rbi +0 -99
  512. data/rbi/stripe/resources/gift_cards/card.rbi +0 -206
  513. data/rbi/stripe/resources/gift_cards/transaction.rbi +0 -257
  514. data/rbi/stripe/resources/issuing/credit_underwriting_record.rbi +0 -622
  515. data/rbi/stripe/resources/issuing/dispute_settlement_detail.rbi +0 -83
  516. data/rbi/stripe/resources/issuing/fraud_liability_debit.rbi +0 -90
  517. data/rbi/stripe/resources/issuing/settlement.rbi +0 -62
  518. data/rbi/stripe/resources/margin.rbi +0 -127
  519. data/rbi/stripe/resources/order.rbi +0 -3036
  520. data/rbi/stripe/resources/payment_attempt_record.rbi +0 -215
  521. data/rbi/stripe/resources/payment_record.rbi +0 -722
  522. data/rbi/stripe/resources/quote_line.rbi +0 -350
  523. data/rbi/stripe/resources/quote_preview_invoice.rbi +0 -850
  524. data/rbi/stripe/resources/quote_preview_subscription_schedule.rbi +0 -474
  525. data/rbi/stripe/resources/tax/association.rbi +0 -94
  526. data/rbi/stripe/resources/tax/form.rbi +0 -224
  527. data/rbi/stripe/resources/terminal/reader_collected_data.rbi +0 -41
  528. data/rbi/stripe/resources/usage_record.rbi +0 -32
  529. data/rbi/stripe/resources/usage_record_summary.rbi +0 -38
  530. data/rbi/stripe/services/account_notice_service.rbi +0 -90
  531. data/rbi/stripe/services/capital/financing_offer_service.rbi +0 -95
  532. data/rbi/stripe/services/capital/financing_summary_service.rbi +0 -22
  533. data/rbi/stripe/services/capital/financing_transaction_service.rbi +0 -68
  534. data/rbi/stripe/services/capital_service.rbi +0 -11
  535. data/rbi/stripe/services/financial_connections/account_inferred_balance_service.rbi +0 -33
  536. data/rbi/stripe/services/financial_connections/institution_service.rbi +0 -46
  537. data/rbi/stripe/services/gift_cards/card_service.rbi +0 -142
  538. data/rbi/stripe/services/gift_cards/transaction_service.rbi +0 -174
  539. data/rbi/stripe/services/gift_cards_service.rbi +0 -10
  540. data/rbi/stripe/services/invoice_upcoming_lines_service.rbi +0 -2023
  541. data/rbi/stripe/services/issuing/credit_underwriting_record_service.rbi +0 -498
  542. data/rbi/stripe/services/issuing/dispute_settlement_detail_service.rbi +0 -55
  543. data/rbi/stripe/services/issuing/fraud_liability_debit_service.rbi +0 -73
  544. data/rbi/stripe/services/margin_service.rbi +0 -104
  545. data/rbi/stripe/services/order_line_item_service.rbi +0 -31
  546. data/rbi/stripe/services/order_service.rbi +0 -2320
  547. data/rbi/stripe/services/payment_attempt_record_service.rbi +0 -36
  548. data/rbi/stripe/services/payment_record_service.rbi +0 -521
  549. data/rbi/stripe/services/quote_line_service.rbi +0 -31
  550. data/rbi/stripe/services/quote_preview_invoice_service.rbi +0 -31
  551. data/rbi/stripe/services/quote_preview_subscription_schedule_service.rbi +0 -31
  552. data/rbi/stripe/services/subscription_item_usage_record_service.rbi +0 -37
  553. data/rbi/stripe/services/subscription_item_usage_record_summary_service.rbi +0 -33
  554. data/rbi/stripe/services/tax/association_service.rbi +0 -25
  555. data/rbi/stripe/services/tax/form_service.rbi +0 -85
  556. data/rbi/stripe/services/terminal/reader_collected_data_service.rbi +0 -22
@@ -7,46 +7,48 @@ module Stripe
7
7
  class ListParams < Stripe::RequestParams
8
8
  class Created < Stripe::RequestParams
9
9
  # Minimum value to filter by (exclusive)
10
- sig { returns(Integer) }
10
+ sig { returns(T.nilable(Integer)) }
11
11
  attr_accessor :gt
12
12
  # Minimum value to filter by (inclusive)
13
- sig { returns(Integer) }
13
+ sig { returns(T.nilable(Integer)) }
14
14
  attr_accessor :gte
15
15
  # Maximum value to filter by (exclusive)
16
- sig { returns(Integer) }
16
+ sig { returns(T.nilable(Integer)) }
17
17
  attr_accessor :lt
18
18
  # Maximum value to filter by (inclusive)
19
- sig { returns(Integer) }
19
+ sig { returns(T.nilable(Integer)) }
20
20
  attr_accessor :lte
21
- sig { params(gt: Integer, gte: Integer, lt: Integer, lte: Integer).void }
21
+ sig {
22
+ params(gt: T.nilable(Integer), gte: T.nilable(Integer), lt: T.nilable(Integer), lte: T.nilable(Integer)).void
23
+ }
22
24
  def initialize(gt: nil, gte: nil, lt: nil, lte: nil); end
23
25
  end
24
26
  # Only return charges that were created during the given date interval.
25
- sig { returns(T.any(::Stripe::ChargeService::ListParams::Created, Integer)) }
27
+ sig { returns(T.nilable(T.any(::Stripe::ChargeService::ListParams::Created, Integer))) }
26
28
  attr_accessor :created
27
29
  # Only return charges for the customer specified by this customer ID.
28
- sig { returns(String) }
30
+ sig { returns(T.nilable(String)) }
29
31
  attr_accessor :customer
30
32
  # A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
31
- sig { returns(String) }
33
+ sig { returns(T.nilable(String)) }
32
34
  attr_accessor :ending_before
33
35
  # Specifies which fields in the response should be expanded.
34
- sig { returns(T::Array[String]) }
36
+ sig { returns(T.nilable(T::Array[String])) }
35
37
  attr_accessor :expand
36
38
  # A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
37
- sig { returns(Integer) }
39
+ sig { returns(T.nilable(Integer)) }
38
40
  attr_accessor :limit
39
41
  # Only return charges that were created by the PaymentIntent specified by this PaymentIntent ID.
40
- sig { returns(String) }
42
+ sig { returns(T.nilable(String)) }
41
43
  attr_accessor :payment_intent
42
44
  # A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
43
- sig { returns(String) }
45
+ sig { returns(T.nilable(String)) }
44
46
  attr_accessor :starting_after
45
47
  # Only return charges for this transfer group, limited to 100.
46
- sig { returns(String) }
48
+ sig { returns(T.nilable(String)) }
47
49
  attr_accessor :transfer_group
48
50
  sig {
49
- params(created: T.any(::Stripe::ChargeService::ListParams::Created, Integer), customer: String, ending_before: String, expand: T::Array[String], limit: Integer, payment_intent: String, starting_after: String, transfer_group: String).void
51
+ params(created: T.nilable(T.any(::Stripe::ChargeService::ListParams::Created, Integer)), customer: T.nilable(String), ending_before: T.nilable(String), expand: T.nilable(T::Array[String]), limit: T.nilable(Integer), payment_intent: T.nilable(String), starting_after: T.nilable(String), transfer_group: T.nilable(String)).void
50
52
  }
51
53
  def initialize(
52
54
  created: nil,
@@ -65,40 +67,40 @@ module Stripe
65
67
  sig { returns(String) }
66
68
  attr_accessor :account
67
69
  # The amount to transfer to the destination account without creating an `Application Fee` object. Cannot be combined with the `application_fee` parameter. Must be less than or equal to the charge amount.
68
- sig { returns(Integer) }
70
+ sig { returns(T.nilable(Integer)) }
69
71
  attr_accessor :amount
70
- sig { params(account: String, amount: Integer).void }
72
+ sig { params(account: String, amount: T.nilable(Integer)).void }
71
73
  def initialize(account: nil, amount: nil); end
72
74
  end
73
75
  class RadarOptions < Stripe::RequestParams
74
76
  # A [Radar Session](https://stripe.com/docs/radar/radar-session) is a snapshot of the browser metadata and device details that help Radar make more accurate predictions on your payments.
75
- sig { returns(String) }
77
+ sig { returns(T.nilable(String)) }
76
78
  attr_accessor :session
77
- sig { params(session: String).void }
79
+ sig { params(session: T.nilable(String)).void }
78
80
  def initialize(session: nil); end
79
81
  end
80
82
  class Shipping < Stripe::RequestParams
81
83
  class Address < Stripe::RequestParams
82
84
  # City, district, suburb, town, or village.
83
- sig { returns(String) }
85
+ sig { returns(T.nilable(String)) }
84
86
  attr_accessor :city
85
87
  # Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
86
- sig { returns(String) }
88
+ sig { returns(T.nilable(String)) }
87
89
  attr_accessor :country
88
90
  # Address line 1 (e.g., street, PO Box, or company name).
89
- sig { returns(String) }
91
+ sig { returns(T.nilable(String)) }
90
92
  attr_accessor :line1
91
93
  # Address line 2 (e.g., apartment, suite, unit, or building).
92
- sig { returns(String) }
94
+ sig { returns(T.nilable(String)) }
93
95
  attr_accessor :line2
94
96
  # ZIP or postal code.
95
- sig { returns(String) }
97
+ sig { returns(T.nilable(String)) }
96
98
  attr_accessor :postal_code
97
99
  # State, county, province, or region.
98
- sig { returns(String) }
100
+ sig { returns(T.nilable(String)) }
99
101
  attr_accessor :state
100
102
  sig {
101
- params(city: String, country: String, line1: String, line2: String, postal_code: String, state: String).void
103
+ 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
102
104
  }
103
105
  def initialize(
104
106
  city: nil,
@@ -113,93 +115,93 @@ module Stripe
113
115
  sig { returns(::Stripe::ChargeService::CreateParams::Shipping::Address) }
114
116
  attr_accessor :address
115
117
  # The delivery service that shipped a physical product, such as Fedex, UPS, USPS, etc.
116
- sig { returns(String) }
118
+ sig { returns(T.nilable(String)) }
117
119
  attr_accessor :carrier
118
120
  # Recipient name.
119
121
  sig { returns(String) }
120
122
  attr_accessor :name
121
123
  # Recipient phone (including extension).
122
- sig { returns(String) }
124
+ sig { returns(T.nilable(String)) }
123
125
  attr_accessor :phone
124
126
  # 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.
125
- sig { returns(String) }
127
+ sig { returns(T.nilable(String)) }
126
128
  attr_accessor :tracking_number
127
129
  sig {
128
- params(address: ::Stripe::ChargeService::CreateParams::Shipping::Address, carrier: String, name: String, phone: String, tracking_number: String).void
130
+ params(address: ::Stripe::ChargeService::CreateParams::Shipping::Address, carrier: T.nilable(String), name: String, phone: T.nilable(String), tracking_number: T.nilable(String)).void
129
131
  }
130
132
  def initialize(address: nil, carrier: nil, name: nil, phone: nil, tracking_number: nil); end
131
133
  end
132
134
  class TransferData < Stripe::RequestParams
133
135
  # The amount transferred to the destination account, if specified. By default, the entire charge amount is transferred to the destination account.
134
- sig { returns(Integer) }
136
+ sig { returns(T.nilable(Integer)) }
135
137
  attr_accessor :amount
136
138
  # ID of an existing, connected Stripe account.
137
139
  sig { returns(String) }
138
140
  attr_accessor :destination
139
- sig { params(amount: Integer, destination: String).void }
141
+ sig { params(amount: T.nilable(Integer), destination: String).void }
140
142
  def initialize(amount: nil, destination: nil); end
141
143
  end
142
144
  # Amount intended to be collected by this payment. A positive integer representing how much to charge in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal) (e.g., 100 cents to charge $1.00 or 100 to charge ¥100, a zero-decimal currency). The minimum amount is $0.50 US or [equivalent in charge currency](https://stripe.com/docs/currencies#minimum-and-maximum-charge-amounts). The amount value supports up to eight digits (e.g., a value of 99999999 for a USD charge of $999,999.99).
143
- sig { returns(Integer) }
145
+ sig { returns(T.nilable(Integer)) }
144
146
  attr_accessor :amount
145
147
  # Attribute for param field application_fee
146
- sig { returns(Integer) }
148
+ sig { returns(T.nilable(Integer)) }
147
149
  attr_accessor :application_fee
148
150
  # A fee in cents (or local equivalent) that will be applied to the charge and transferred to the application owner's Stripe account. The request must be made with an OAuth key or the `Stripe-Account` header in order to take an application fee. For more information, see the application fees [documentation](https://stripe.com/docs/connect/direct-charges#collect-fees).
149
- sig { returns(Integer) }
151
+ sig { returns(T.nilable(Integer)) }
150
152
  attr_accessor :application_fee_amount
151
153
  # Whether to immediately capture the charge. Defaults to `true`. When `false`, the charge issues an authorization (or pre-authorization), and will need to be [captured](https://stripe.com/docs/api#capture_charge) later. Uncaptured charges expire after a set number of days (7 by default). For more information, see the [authorizing charges and settling later](https://stripe.com/docs/charges/placing-a-hold) documentation.
152
- sig { returns(T::Boolean) }
154
+ sig { returns(T.nilable(T::Boolean)) }
153
155
  attr_accessor :capture
154
156
  # 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).
155
- sig { returns(String) }
157
+ sig { returns(T.nilable(String)) }
156
158
  attr_accessor :currency
157
159
  # The ID of an existing customer that will be charged in this request.
158
- sig { returns(String) }
160
+ sig { returns(T.nilable(String)) }
159
161
  attr_accessor :customer
160
162
  # An arbitrary string which you can attach to a `Charge` object. It is displayed when in the web interface alongside the charge. Note that if you use Stripe to send automatic email receipts to your customers, your receipt emails will include the `description` of the charge(s) that they are describing.
161
- sig { returns(String) }
163
+ sig { returns(T.nilable(String)) }
162
164
  attr_accessor :description
163
165
  # Attribute for param field destination
164
- sig { returns(::Stripe::ChargeService::CreateParams::Destination) }
166
+ sig { returns(T.nilable(::Stripe::ChargeService::CreateParams::Destination)) }
165
167
  attr_accessor :destination
166
168
  # Specifies which fields in the response should be expanded.
167
- sig { returns(T::Array[String]) }
169
+ sig { returns(T.nilable(T::Array[String])) }
168
170
  attr_accessor :expand
169
171
  # 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`.
170
- sig { returns(T.nilable(T::Hash[String, String])) }
172
+ sig { returns(T.nilable(T.nilable(T.any(String, T::Hash[String, String])))) }
171
173
  attr_accessor :metadata
172
174
  # The Stripe account ID for which these funds are intended. Automatically set if you use the `destination` parameter. For details, see [Creating Separate Charges and Transfers](https://stripe.com/docs/connect/separate-charges-and-transfers#settlement-merchant).
173
- sig { returns(String) }
175
+ sig { returns(T.nilable(String)) }
174
176
  attr_accessor :on_behalf_of
175
177
  # Options to configure Radar. See [Radar Session](https://stripe.com/docs/radar/radar-session) for more information.
176
- sig { returns(::Stripe::ChargeService::CreateParams::RadarOptions) }
178
+ sig { returns(T.nilable(::Stripe::ChargeService::CreateParams::RadarOptions)) }
177
179
  attr_accessor :radar_options
178
180
  # The email address to which this charge's [receipt](https://stripe.com/docs/dashboard/receipts) will be sent. The receipt will not be sent until the charge is paid, and no receipts will be sent for test mode charges. If this charge is for a [Customer](https://stripe.com/docs/api/customers/object), the email address specified here will override the customer's email address. If `receipt_email` is specified for a charge in live mode, a receipt will be sent regardless of your [email settings](https://dashboard.stripe.com/account/emails).
179
- sig { returns(String) }
181
+ sig { returns(T.nilable(String)) }
180
182
  attr_accessor :receipt_email
181
183
  # Shipping information for the charge. Helps prevent fraud on charges for physical goods.
182
- sig { returns(::Stripe::ChargeService::CreateParams::Shipping) }
184
+ sig { returns(T.nilable(::Stripe::ChargeService::CreateParams::Shipping)) }
183
185
  attr_accessor :shipping
184
186
  # A payment source to be charged. This can be the ID of a [card](https://stripe.com/docs/api#cards) (i.e., credit or debit card), a [bank account](https://stripe.com/docs/api#bank_accounts), a [source](https://stripe.com/docs/api#sources), a [token](https://stripe.com/docs/api#tokens), or a [connected account](https://stripe.com/docs/connect/account-debits#charging-a-connected-account). For certain sources---namely, [cards](https://stripe.com/docs/api#cards), [bank accounts](https://stripe.com/docs/api#bank_accounts), and attached [sources](https://stripe.com/docs/api#sources)---you must also pass the ID of the associated customer.
185
- sig { returns(String) }
187
+ sig { returns(T.nilable(String)) }
186
188
  attr_accessor :source
187
189
  # For a non-card charge, text that appears on the customer's statement as the statement descriptor. This value overrides the account's default statement descriptor. For information about requirements, including the 22-character limit, see [the Statement Descriptor docs](https://docs.stripe.com/get-started/account/statement-descriptors).
188
190
  #
189
191
  # For a card charge, this value is ignored unless you don't specify a `statement_descriptor_suffix`, in which case this value is used as the suffix.
190
- sig { returns(String) }
192
+ sig { returns(T.nilable(String)) }
191
193
  attr_accessor :statement_descriptor
192
194
  # Provides information about a card charge. Concatenated to the account's [statement descriptor prefix](https://docs.stripe.com/get-started/account/statement-descriptors#static) to form the complete statement descriptor that appears on the customer's statement. If the account has no prefix value, the suffix is concatenated to the account's statement descriptor.
193
- sig { returns(String) }
195
+ sig { returns(T.nilable(String)) }
194
196
  attr_accessor :statement_descriptor_suffix
195
197
  # An optional dictionary including the account to automatically transfer to as part of a destination charge. [See the Connect documentation](https://stripe.com/docs/connect/destination-charges) for details.
196
- sig { returns(::Stripe::ChargeService::CreateParams::TransferData) }
198
+ sig { returns(T.nilable(::Stripe::ChargeService::CreateParams::TransferData)) }
197
199
  attr_accessor :transfer_data
198
200
  # A string that identifies this transaction as part of a group. For details, see [Grouping transactions](https://stripe.com/docs/connect/separate-charges-and-transfers#transfer-options).
199
- sig { returns(String) }
201
+ sig { returns(T.nilable(String)) }
200
202
  attr_accessor :transfer_group
201
203
  sig {
202
- params(amount: Integer, application_fee: Integer, application_fee_amount: Integer, capture: T::Boolean, currency: String, customer: String, description: String, destination: ::Stripe::ChargeService::CreateParams::Destination, expand: T::Array[String], metadata: T.nilable(T::Hash[String, String]), on_behalf_of: String, radar_options: ::Stripe::ChargeService::CreateParams::RadarOptions, receipt_email: String, shipping: ::Stripe::ChargeService::CreateParams::Shipping, source: String, statement_descriptor: String, statement_descriptor_suffix: String, transfer_data: ::Stripe::ChargeService::CreateParams::TransferData, transfer_group: String).void
204
+ params(amount: T.nilable(Integer), application_fee: T.nilable(Integer), application_fee_amount: T.nilable(Integer), capture: T.nilable(T::Boolean), currency: T.nilable(String), customer: T.nilable(String), description: T.nilable(String), destination: T.nilable(::Stripe::ChargeService::CreateParams::Destination), expand: T.nilable(T::Array[String]), metadata: T.nilable(T.nilable(T.any(String, T::Hash[String, String]))), on_behalf_of: T.nilable(String), radar_options: T.nilable(::Stripe::ChargeService::CreateParams::RadarOptions), receipt_email: T.nilable(String), shipping: T.nilable(::Stripe::ChargeService::CreateParams::Shipping), source: T.nilable(String), statement_descriptor: T.nilable(String), statement_descriptor_suffix: T.nilable(String), transfer_data: T.nilable(::Stripe::ChargeService::CreateParams::TransferData), transfer_group: T.nilable(String)).void
203
205
  }
204
206
  def initialize(
205
207
  amount: nil,
@@ -225,722 +227,41 @@ module Stripe
225
227
  end
226
228
  class RetrieveParams < Stripe::RequestParams
227
229
  # Specifies which fields in the response should be expanded.
228
- sig { returns(T::Array[String]) }
230
+ sig { returns(T.nilable(T::Array[String])) }
229
231
  attr_accessor :expand
230
- sig { params(expand: T::Array[String]).void }
232
+ sig { params(expand: T.nilable(T::Array[String])).void }
231
233
  def initialize(expand: nil); end
232
234
  end
233
235
  class UpdateParams < Stripe::RequestParams
234
236
  class FraudDetails < Stripe::RequestParams
235
237
  # Either `safe` or `fraudulent`.
236
- sig { returns(T.nilable(String)) }
238
+ sig { returns(T.nilable(T.any(String, String))) }
237
239
  attr_accessor :user_report
238
- sig { params(user_report: T.nilable(String)).void }
240
+ sig { params(user_report: T.nilable(T.any(String, String))).void }
239
241
  def initialize(user_report: nil); end
240
242
  end
241
- class PaymentDetails < Stripe::RequestParams
242
- class CarRental < Stripe::RequestParams
243
- class Affiliate < Stripe::RequestParams
244
- # The name of the affiliate that originated the purchase.
245
- sig { returns(String) }
246
- attr_accessor :name
247
- sig { params(name: String).void }
248
- def initialize(name: nil); end
249
- end
250
- class Delivery < Stripe::RequestParams
251
- class Recipient < Stripe::RequestParams
252
- # The email of the recipient the ticket is delivered to.
253
- sig { returns(String) }
254
- attr_accessor :email
255
- # The name of the recipient the ticket is delivered to.
256
- sig { returns(String) }
257
- attr_accessor :name
258
- # The phone number of the recipient the ticket is delivered to.
259
- sig { returns(String) }
260
- attr_accessor :phone
261
- sig { params(email: String, name: String, phone: String).void }
262
- def initialize(email: nil, name: nil, phone: nil); end
263
- end
264
- # The delivery method for the payment
265
- sig { returns(String) }
266
- attr_accessor :mode
267
- # Details of the recipient.
268
- sig {
269
- returns(::Stripe::ChargeService::UpdateParams::PaymentDetails::CarRental::Delivery::Recipient)
270
- }
271
- attr_accessor :recipient
272
- sig {
273
- params(mode: String, recipient: ::Stripe::ChargeService::UpdateParams::PaymentDetails::CarRental::Delivery::Recipient).void
274
- }
275
- def initialize(mode: nil, recipient: nil); end
276
- end
277
- class Driver < Stripe::RequestParams
278
- # Full name of the person or entity on the car reservation.
279
- sig { returns(String) }
280
- attr_accessor :name
281
- sig { params(name: String).void }
282
- def initialize(name: nil); end
283
- end
284
- class PickupAddress < Stripe::RequestParams
285
- # City, district, suburb, town, or village.
286
- sig { returns(String) }
287
- attr_accessor :city
288
- # Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
289
- sig { returns(String) }
290
- attr_accessor :country
291
- # Address line 1 (e.g., street, PO Box, or company name).
292
- sig { returns(String) }
293
- attr_accessor :line1
294
- # Address line 2 (e.g., apartment, suite, unit, or building).
295
- sig { returns(String) }
296
- attr_accessor :line2
297
- # ZIP or postal code.
298
- sig { returns(String) }
299
- attr_accessor :postal_code
300
- # State, county, province, or region.
301
- sig { returns(String) }
302
- attr_accessor :state
303
- sig {
304
- params(city: String, country: String, line1: String, line2: String, postal_code: String, state: String).void
305
- }
306
- def initialize(
307
- city: nil,
308
- country: nil,
309
- line1: nil,
310
- line2: nil,
311
- postal_code: nil,
312
- state: nil
313
- ); end
314
- end
315
- class ReturnAddress < Stripe::RequestParams
316
- # City, district, suburb, town, or village.
317
- sig { returns(String) }
318
- attr_accessor :city
319
- # Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
320
- sig { returns(String) }
321
- attr_accessor :country
322
- # Address line 1 (e.g., street, PO Box, or company name).
323
- sig { returns(String) }
324
- attr_accessor :line1
325
- # Address line 2 (e.g., apartment, suite, unit, or building).
326
- sig { returns(String) }
327
- attr_accessor :line2
328
- # ZIP or postal code.
329
- sig { returns(String) }
330
- attr_accessor :postal_code
331
- # State, county, province, or region.
332
- sig { returns(String) }
333
- attr_accessor :state
334
- sig {
335
- params(city: String, country: String, line1: String, line2: String, postal_code: String, state: String).void
336
- }
337
- def initialize(
338
- city: nil,
339
- country: nil,
340
- line1: nil,
341
- line2: nil,
342
- postal_code: nil,
343
- state: nil
344
- ); end
345
- end
346
- # Affiliate details for this purchase.
347
- sig {
348
- returns(::Stripe::ChargeService::UpdateParams::PaymentDetails::CarRental::Affiliate)
349
- }
350
- attr_accessor :affiliate
351
- # The booking number associated with the car rental.
352
- sig { returns(String) }
353
- attr_accessor :booking_number
354
- # Class code of the car.
355
- sig { returns(String) }
356
- attr_accessor :car_class_code
357
- # Make of the car.
358
- sig { returns(String) }
359
- attr_accessor :car_make
360
- # Model of the car.
361
- sig { returns(String) }
362
- attr_accessor :car_model
363
- # The name of the rental car company.
364
- sig { returns(String) }
365
- attr_accessor :company
366
- # The customer service phone number of the car rental company.
367
- sig { returns(String) }
368
- attr_accessor :customer_service_phone_number
369
- # Number of days the car is being rented.
370
- sig { returns(Integer) }
371
- attr_accessor :days_rented
372
- # Delivery details for this purchase.
373
- sig {
374
- returns(::Stripe::ChargeService::UpdateParams::PaymentDetails::CarRental::Delivery)
375
- }
376
- attr_accessor :delivery
377
- # The details of the passengers in the travel reservation
378
- sig {
379
- returns(T::Array[::Stripe::ChargeService::UpdateParams::PaymentDetails::CarRental::Driver])
380
- }
381
- attr_accessor :drivers
382
- # List of additional charges being billed.
383
- sig { returns(T::Array[String]) }
384
- attr_accessor :extra_charges
385
- # Indicates if the customer did not keep nor cancel their booking.
386
- sig { returns(T::Boolean) }
387
- attr_accessor :no_show
388
- # Car pick-up address.
389
- sig {
390
- returns(::Stripe::ChargeService::UpdateParams::PaymentDetails::CarRental::PickupAddress)
391
- }
392
- attr_accessor :pickup_address
393
- # Car pick-up time. Measured in seconds since the Unix epoch.
394
- sig { returns(Integer) }
395
- attr_accessor :pickup_at
396
- # Rental rate.
397
- sig { returns(Integer) }
398
- attr_accessor :rate_amount
399
- # The frequency at which the rate amount is applied. One of `day`, `week` or `month`
400
- sig { returns(String) }
401
- attr_accessor :rate_interval
402
- # The name of the person or entity renting the car.
403
- sig { returns(String) }
404
- attr_accessor :renter_name
405
- # Car return address.
406
- sig {
407
- returns(::Stripe::ChargeService::UpdateParams::PaymentDetails::CarRental::ReturnAddress)
408
- }
409
- attr_accessor :return_address
410
- # Car return time. Measured in seconds since the Unix epoch.
411
- sig { returns(Integer) }
412
- attr_accessor :return_at
413
- # Indicates whether the goods or services are tax-exempt or tax is not collected.
414
- sig { returns(T::Boolean) }
415
- attr_accessor :tax_exempt
416
- sig {
417
- params(affiliate: ::Stripe::ChargeService::UpdateParams::PaymentDetails::CarRental::Affiliate, booking_number: String, car_class_code: String, car_make: String, car_model: String, company: String, customer_service_phone_number: String, days_rented: Integer, delivery: ::Stripe::ChargeService::UpdateParams::PaymentDetails::CarRental::Delivery, drivers: T::Array[::Stripe::ChargeService::UpdateParams::PaymentDetails::CarRental::Driver], extra_charges: T::Array[String], no_show: T::Boolean, pickup_address: ::Stripe::ChargeService::UpdateParams::PaymentDetails::CarRental::PickupAddress, pickup_at: Integer, rate_amount: Integer, rate_interval: String, renter_name: String, return_address: ::Stripe::ChargeService::UpdateParams::PaymentDetails::CarRental::ReturnAddress, return_at: Integer, tax_exempt: T::Boolean).void
418
- }
419
- def initialize(
420
- affiliate: nil,
421
- booking_number: nil,
422
- car_class_code: nil,
423
- car_make: nil,
424
- car_model: nil,
425
- company: nil,
426
- customer_service_phone_number: nil,
427
- days_rented: nil,
428
- delivery: nil,
429
- drivers: nil,
430
- extra_charges: nil,
431
- no_show: nil,
432
- pickup_address: nil,
433
- pickup_at: nil,
434
- rate_amount: nil,
435
- rate_interval: nil,
436
- renter_name: nil,
437
- return_address: nil,
438
- return_at: nil,
439
- tax_exempt: nil
440
- ); end
441
- end
442
- class EventDetails < Stripe::RequestParams
443
- class Address < Stripe::RequestParams
444
- # City, district, suburb, town, or village.
445
- sig { returns(String) }
446
- attr_accessor :city
447
- # Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
448
- sig { returns(String) }
449
- attr_accessor :country
450
- # Address line 1 (e.g., street, PO Box, or company name).
451
- sig { returns(String) }
452
- attr_accessor :line1
453
- # Address line 2 (e.g., apartment, suite, unit, or building).
454
- sig { returns(String) }
455
- attr_accessor :line2
456
- # ZIP or postal code.
457
- sig { returns(String) }
458
- attr_accessor :postal_code
459
- # State, county, province, or region.
460
- sig { returns(String) }
461
- attr_accessor :state
462
- sig {
463
- params(city: String, country: String, line1: String, line2: String, postal_code: String, state: String).void
464
- }
465
- def initialize(
466
- city: nil,
467
- country: nil,
468
- line1: nil,
469
- line2: nil,
470
- postal_code: nil,
471
- state: nil
472
- ); end
473
- end
474
- class Affiliate < Stripe::RequestParams
475
- # The name of the affiliate that originated the purchase.
476
- sig { returns(String) }
477
- attr_accessor :name
478
- sig { params(name: String).void }
479
- def initialize(name: nil); end
480
- end
481
- class Delivery < Stripe::RequestParams
482
- class Recipient < Stripe::RequestParams
483
- # The email of the recipient the ticket is delivered to.
484
- sig { returns(String) }
485
- attr_accessor :email
486
- # The name of the recipient the ticket is delivered to.
487
- sig { returns(String) }
488
- attr_accessor :name
489
- # The phone number of the recipient the ticket is delivered to.
490
- sig { returns(String) }
491
- attr_accessor :phone
492
- sig { params(email: String, name: String, phone: String).void }
493
- def initialize(email: nil, name: nil, phone: nil); end
494
- end
495
- # The delivery method for the payment
496
- sig { returns(String) }
497
- attr_accessor :mode
498
- # Details of the recipient.
499
- sig {
500
- returns(::Stripe::ChargeService::UpdateParams::PaymentDetails::EventDetails::Delivery::Recipient)
501
- }
502
- attr_accessor :recipient
503
- sig {
504
- params(mode: String, recipient: ::Stripe::ChargeService::UpdateParams::PaymentDetails::EventDetails::Delivery::Recipient).void
505
- }
506
- def initialize(mode: nil, recipient: nil); end
507
- end
508
- # Indicates if the tickets are digitally checked when entering the venue.
509
- sig { returns(T::Boolean) }
510
- attr_accessor :access_controlled_venue
511
- # The event location's address.
512
- sig {
513
- returns(::Stripe::ChargeService::UpdateParams::PaymentDetails::EventDetails::Address)
514
- }
515
- attr_accessor :address
516
- # Affiliate details for this purchase.
517
- sig {
518
- returns(::Stripe::ChargeService::UpdateParams::PaymentDetails::EventDetails::Affiliate)
519
- }
520
- attr_accessor :affiliate
521
- # The name of the company
522
- sig { returns(String) }
523
- attr_accessor :company
524
- # Delivery details for this purchase.
525
- sig {
526
- returns(::Stripe::ChargeService::UpdateParams::PaymentDetails::EventDetails::Delivery)
527
- }
528
- attr_accessor :delivery
529
- # Event end time. Measured in seconds since the Unix epoch.
530
- sig { returns(Integer) }
531
- attr_accessor :ends_at
532
- # Type of the event entertainment (concert, sports event etc)
533
- sig { returns(String) }
534
- attr_accessor :genre
535
- # The name of the event.
536
- sig { returns(String) }
537
- attr_accessor :name
538
- # Event start time. Measured in seconds since the Unix epoch.
539
- sig { returns(Integer) }
540
- attr_accessor :starts_at
541
- sig {
542
- params(access_controlled_venue: T::Boolean, address: ::Stripe::ChargeService::UpdateParams::PaymentDetails::EventDetails::Address, affiliate: ::Stripe::ChargeService::UpdateParams::PaymentDetails::EventDetails::Affiliate, company: String, delivery: ::Stripe::ChargeService::UpdateParams::PaymentDetails::EventDetails::Delivery, ends_at: Integer, genre: String, name: String, starts_at: Integer).void
543
- }
544
- def initialize(
545
- access_controlled_venue: nil,
546
- address: nil,
547
- affiliate: nil,
548
- company: nil,
549
- delivery: nil,
550
- ends_at: nil,
551
- genre: nil,
552
- name: nil,
553
- starts_at: nil
554
- ); end
555
- end
556
- class Flight < Stripe::RequestParams
557
- class Affiliate < Stripe::RequestParams
558
- # The name of the affiliate that originated the purchase.
559
- sig { returns(String) }
560
- attr_accessor :name
561
- sig { params(name: String).void }
562
- def initialize(name: nil); end
563
- end
564
- class Delivery < Stripe::RequestParams
565
- class Recipient < Stripe::RequestParams
566
- # The email of the recipient the ticket is delivered to.
567
- sig { returns(String) }
568
- attr_accessor :email
569
- # The name of the recipient the ticket is delivered to.
570
- sig { returns(String) }
571
- attr_accessor :name
572
- # The phone number of the recipient the ticket is delivered to.
573
- sig { returns(String) }
574
- attr_accessor :phone
575
- sig { params(email: String, name: String, phone: String).void }
576
- def initialize(email: nil, name: nil, phone: nil); end
577
- end
578
- # The delivery method for the payment
579
- sig { returns(String) }
580
- attr_accessor :mode
581
- # Details of the recipient.
582
- sig {
583
- returns(::Stripe::ChargeService::UpdateParams::PaymentDetails::Flight::Delivery::Recipient)
584
- }
585
- attr_accessor :recipient
586
- sig {
587
- params(mode: String, recipient: ::Stripe::ChargeService::UpdateParams::PaymentDetails::Flight::Delivery::Recipient).void
588
- }
589
- def initialize(mode: nil, recipient: nil); end
590
- end
591
- class Passenger < Stripe::RequestParams
592
- # Full name of the person or entity on the flight reservation.
593
- sig { returns(String) }
594
- attr_accessor :name
595
- sig { params(name: String).void }
596
- def initialize(name: nil); end
597
- end
598
- class Segment < Stripe::RequestParams
599
- # The flight segment amount.
600
- sig { returns(Integer) }
601
- attr_accessor :amount
602
- # The International Air Transport Association (IATA) airport code for the arrival airport.
603
- sig { returns(String) }
604
- attr_accessor :arrival_airport
605
- # The arrival time for the flight segment. Measured in seconds since the Unix epoch.
606
- sig { returns(Integer) }
607
- attr_accessor :arrives_at
608
- # The International Air Transport Association (IATA) carrier code of the carrier operating the flight segment.
609
- sig { returns(String) }
610
- attr_accessor :carrier
611
- # The departure time for the flight segment. Measured in seconds since the Unix epoch.
612
- sig { returns(Integer) }
613
- attr_accessor :departs_at
614
- # The International Air Transport Association (IATA) airport code for the departure airport.
615
- sig { returns(String) }
616
- attr_accessor :departure_airport
617
- # The flight number associated with the segment
618
- sig { returns(String) }
619
- attr_accessor :flight_number
620
- # The fare class for the segment.
621
- sig { returns(String) }
622
- attr_accessor :service_class
623
- sig {
624
- params(amount: Integer, arrival_airport: String, arrives_at: Integer, carrier: String, departs_at: Integer, departure_airport: String, flight_number: String, service_class: String).void
625
- }
626
- def initialize(
627
- amount: nil,
628
- arrival_airport: nil,
629
- arrives_at: nil,
630
- carrier: nil,
631
- departs_at: nil,
632
- departure_airport: nil,
633
- flight_number: nil,
634
- service_class: nil
635
- ); end
636
- end
637
- # Affiliate details for this purchase.
638
- sig { returns(::Stripe::ChargeService::UpdateParams::PaymentDetails::Flight::Affiliate) }
639
- attr_accessor :affiliate
640
- # The agency number (i.e. International Air Transport Association (IATA) agency number) of the travel agency that made the booking.
641
- sig { returns(String) }
642
- attr_accessor :agency_number
643
- # The International Air Transport Association (IATA) carrier code of the carrier that issued the ticket.
644
- sig { returns(String) }
645
- attr_accessor :carrier
646
- # Delivery details for this purchase.
647
- sig { returns(::Stripe::ChargeService::UpdateParams::PaymentDetails::Flight::Delivery) }
648
- attr_accessor :delivery
649
- # The name of the person or entity on the reservation.
650
- sig { returns(String) }
651
- attr_accessor :passenger_name
652
- # The details of the passengers in the travel reservation.
653
- sig {
654
- returns(T::Array[::Stripe::ChargeService::UpdateParams::PaymentDetails::Flight::Passenger])
655
- }
656
- attr_accessor :passengers
657
- # The individual flight segments associated with the trip.
658
- sig {
659
- returns(T::Array[::Stripe::ChargeService::UpdateParams::PaymentDetails::Flight::Segment])
660
- }
661
- attr_accessor :segments
662
- # The ticket number associated with the travel reservation.
663
- sig { returns(String) }
664
- attr_accessor :ticket_number
665
- sig {
666
- params(affiliate: ::Stripe::ChargeService::UpdateParams::PaymentDetails::Flight::Affiliate, agency_number: String, carrier: String, delivery: ::Stripe::ChargeService::UpdateParams::PaymentDetails::Flight::Delivery, passenger_name: String, passengers: T::Array[::Stripe::ChargeService::UpdateParams::PaymentDetails::Flight::Passenger], segments: T::Array[::Stripe::ChargeService::UpdateParams::PaymentDetails::Flight::Segment], ticket_number: String).void
667
- }
668
- def initialize(
669
- affiliate: nil,
670
- agency_number: nil,
671
- carrier: nil,
672
- delivery: nil,
673
- passenger_name: nil,
674
- passengers: nil,
675
- segments: nil,
676
- ticket_number: nil
677
- ); end
678
- end
679
- class Lodging < Stripe::RequestParams
680
- class Address < Stripe::RequestParams
681
- # City, district, suburb, town, or village.
682
- sig { returns(String) }
683
- attr_accessor :city
684
- # Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
685
- sig { returns(String) }
686
- attr_accessor :country
687
- # Address line 1 (e.g., street, PO Box, or company name).
688
- sig { returns(String) }
689
- attr_accessor :line1
690
- # Address line 2 (e.g., apartment, suite, unit, or building).
691
- sig { returns(String) }
692
- attr_accessor :line2
693
- # ZIP or postal code.
694
- sig { returns(String) }
695
- attr_accessor :postal_code
696
- # State, county, province, or region.
697
- sig { returns(String) }
698
- attr_accessor :state
699
- sig {
700
- params(city: String, country: String, line1: String, line2: String, postal_code: String, state: String).void
701
- }
702
- def initialize(
703
- city: nil,
704
- country: nil,
705
- line1: nil,
706
- line2: nil,
707
- postal_code: nil,
708
- state: nil
709
- ); end
710
- end
711
- class Affiliate < Stripe::RequestParams
712
- # The name of the affiliate that originated the purchase.
713
- sig { returns(String) }
714
- attr_accessor :name
715
- sig { params(name: String).void }
716
- def initialize(name: nil); end
717
- end
718
- class Delivery < Stripe::RequestParams
719
- class Recipient < Stripe::RequestParams
720
- # The email of the recipient the ticket is delivered to.
721
- sig { returns(String) }
722
- attr_accessor :email
723
- # The name of the recipient the ticket is delivered to.
724
- sig { returns(String) }
725
- attr_accessor :name
726
- # The phone number of the recipient the ticket is delivered to.
727
- sig { returns(String) }
728
- attr_accessor :phone
729
- sig { params(email: String, name: String, phone: String).void }
730
- def initialize(email: nil, name: nil, phone: nil); end
731
- end
732
- # The delivery method for the payment
733
- sig { returns(String) }
734
- attr_accessor :mode
735
- # Details of the recipient.
736
- sig {
737
- returns(::Stripe::ChargeService::UpdateParams::PaymentDetails::Lodging::Delivery::Recipient)
738
- }
739
- attr_accessor :recipient
740
- sig {
741
- params(mode: String, recipient: ::Stripe::ChargeService::UpdateParams::PaymentDetails::Lodging::Delivery::Recipient).void
742
- }
743
- def initialize(mode: nil, recipient: nil); end
744
- end
745
- class Passenger < Stripe::RequestParams
746
- # Full name of the person or entity on the lodging reservation.
747
- sig { returns(String) }
748
- attr_accessor :name
749
- sig { params(name: String).void }
750
- def initialize(name: nil); end
751
- end
752
- # The lodging location's address.
753
- sig { returns(::Stripe::ChargeService::UpdateParams::PaymentDetails::Lodging::Address) }
754
- attr_accessor :address
755
- # The number of adults on the booking
756
- sig { returns(Integer) }
757
- attr_accessor :adults
758
- # Affiliate details for this purchase.
759
- sig { returns(::Stripe::ChargeService::UpdateParams::PaymentDetails::Lodging::Affiliate) }
760
- attr_accessor :affiliate
761
- # The booking number associated with the lodging reservation.
762
- sig { returns(String) }
763
- attr_accessor :booking_number
764
- # The lodging category
765
- sig { returns(String) }
766
- attr_accessor :category
767
- # Loding check-in time. Measured in seconds since the Unix epoch.
768
- sig { returns(Integer) }
769
- attr_accessor :checkin_at
770
- # Lodging check-out time. Measured in seconds since the Unix epoch.
771
- sig { returns(Integer) }
772
- attr_accessor :checkout_at
773
- # The customer service phone number of the lodging company.
774
- sig { returns(String) }
775
- attr_accessor :customer_service_phone_number
776
- # The daily lodging room rate.
777
- sig { returns(Integer) }
778
- attr_accessor :daily_room_rate_amount
779
- # Delivery details for this purchase.
780
- sig { returns(::Stripe::ChargeService::UpdateParams::PaymentDetails::Lodging::Delivery) }
781
- attr_accessor :delivery
782
- # List of additional charges being billed.
783
- sig { returns(T::Array[String]) }
784
- attr_accessor :extra_charges
785
- # Indicates whether the lodging location is compliant with the Fire Safety Act.
786
- sig { returns(T::Boolean) }
787
- attr_accessor :fire_safety_act_compliance
788
- # The name of the lodging location.
789
- sig { returns(String) }
790
- attr_accessor :name
791
- # Indicates if the customer did not keep their booking while failing to cancel the reservation.
792
- sig { returns(T::Boolean) }
793
- attr_accessor :no_show
794
- # The number of rooms on the booking
795
- sig { returns(Integer) }
796
- attr_accessor :number_of_rooms
797
- # The details of the passengers in the travel reservation
798
- sig {
799
- returns(T::Array[::Stripe::ChargeService::UpdateParams::PaymentDetails::Lodging::Passenger])
800
- }
801
- attr_accessor :passengers
802
- # The phone number of the lodging location.
803
- sig { returns(String) }
804
- attr_accessor :property_phone_number
805
- # The room class for this purchase.
806
- sig { returns(String) }
807
- attr_accessor :room_class
808
- # The number of room nights
809
- sig { returns(Integer) }
810
- attr_accessor :room_nights
811
- # The total tax amount associating with the room reservation.
812
- sig { returns(Integer) }
813
- attr_accessor :total_room_tax_amount
814
- # The total tax amount
815
- sig { returns(Integer) }
816
- attr_accessor :total_tax_amount
817
- sig {
818
- params(address: ::Stripe::ChargeService::UpdateParams::PaymentDetails::Lodging::Address, adults: Integer, affiliate: ::Stripe::ChargeService::UpdateParams::PaymentDetails::Lodging::Affiliate, booking_number: String, category: String, checkin_at: Integer, checkout_at: Integer, customer_service_phone_number: String, daily_room_rate_amount: Integer, delivery: ::Stripe::ChargeService::UpdateParams::PaymentDetails::Lodging::Delivery, extra_charges: T::Array[String], fire_safety_act_compliance: T::Boolean, name: String, no_show: T::Boolean, number_of_rooms: Integer, passengers: T::Array[::Stripe::ChargeService::UpdateParams::PaymentDetails::Lodging::Passenger], property_phone_number: String, room_class: String, room_nights: Integer, total_room_tax_amount: Integer, total_tax_amount: Integer).void
819
- }
820
- def initialize(
821
- address: nil,
822
- adults: nil,
823
- affiliate: nil,
824
- booking_number: nil,
825
- category: nil,
826
- checkin_at: nil,
827
- checkout_at: nil,
828
- customer_service_phone_number: nil,
829
- daily_room_rate_amount: nil,
830
- delivery: nil,
831
- extra_charges: nil,
832
- fire_safety_act_compliance: nil,
833
- name: nil,
834
- no_show: nil,
835
- number_of_rooms: nil,
836
- passengers: nil,
837
- property_phone_number: nil,
838
- room_class: nil,
839
- room_nights: nil,
840
- total_room_tax_amount: nil,
841
- total_tax_amount: nil
842
- ); end
843
- end
844
- class Subscription < Stripe::RequestParams
845
- class Affiliate < Stripe::RequestParams
846
- # The name of the affiliate that originated the purchase.
847
- sig { returns(String) }
848
- attr_accessor :name
849
- sig { params(name: String).void }
850
- def initialize(name: nil); end
851
- end
852
- class BillingInterval < Stripe::RequestParams
853
- # The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
854
- sig { returns(Integer) }
855
- attr_accessor :count
856
- # Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
857
- sig { returns(String) }
858
- attr_accessor :interval
859
- sig { params(count: Integer, interval: String).void }
860
- def initialize(count: nil, interval: nil); end
861
- end
862
- # Affiliate details for this purchase.
863
- sig {
864
- returns(::Stripe::ChargeService::UpdateParams::PaymentDetails::Subscription::Affiliate)
865
- }
866
- attr_accessor :affiliate
867
- # Info whether the subscription will be auto renewed upon expiry.
868
- sig { returns(T::Boolean) }
869
- attr_accessor :auto_renewal
870
- # Subscription billing details for this purchase.
871
- sig {
872
- returns(::Stripe::ChargeService::UpdateParams::PaymentDetails::Subscription::BillingInterval)
873
- }
874
- attr_accessor :billing_interval
875
- # Subscription end time. Measured in seconds since the Unix epoch.
876
- sig { returns(Integer) }
877
- attr_accessor :ends_at
878
- # Name of the product on subscription. e.g. Apple Music Subscription
879
- sig { returns(String) }
880
- attr_accessor :name
881
- # Subscription start time. Measured in seconds since the Unix epoch.
882
- sig { returns(Integer) }
883
- attr_accessor :starts_at
884
- sig {
885
- params(affiliate: ::Stripe::ChargeService::UpdateParams::PaymentDetails::Subscription::Affiliate, auto_renewal: T::Boolean, billing_interval: ::Stripe::ChargeService::UpdateParams::PaymentDetails::Subscription::BillingInterval, ends_at: Integer, name: String, starts_at: Integer).void
886
- }
887
- def initialize(
888
- affiliate: nil,
889
- auto_renewal: nil,
890
- billing_interval: nil,
891
- ends_at: nil,
892
- name: nil,
893
- starts_at: nil
894
- ); end
895
- end
896
- # Car rental details for this PaymentIntent.
897
- sig { returns(::Stripe::ChargeService::UpdateParams::PaymentDetails::CarRental) }
898
- attr_accessor :car_rental
899
- # Event details for this PaymentIntent
900
- sig { returns(::Stripe::ChargeService::UpdateParams::PaymentDetails::EventDetails) }
901
- attr_accessor :event_details
902
- # Flight reservation details for this PaymentIntent
903
- sig { returns(::Stripe::ChargeService::UpdateParams::PaymentDetails::Flight) }
904
- attr_accessor :flight
905
- # Lodging reservation details for this PaymentIntent
906
- sig { returns(::Stripe::ChargeService::UpdateParams::PaymentDetails::Lodging) }
907
- attr_accessor :lodging
908
- # Subscription details for this PaymentIntent
909
- sig { returns(::Stripe::ChargeService::UpdateParams::PaymentDetails::Subscription) }
910
- attr_accessor :subscription
911
- sig {
912
- params(car_rental: ::Stripe::ChargeService::UpdateParams::PaymentDetails::CarRental, event_details: ::Stripe::ChargeService::UpdateParams::PaymentDetails::EventDetails, flight: ::Stripe::ChargeService::UpdateParams::PaymentDetails::Flight, lodging: ::Stripe::ChargeService::UpdateParams::PaymentDetails::Lodging, subscription: ::Stripe::ChargeService::UpdateParams::PaymentDetails::Subscription).void
913
- }
914
- def initialize(
915
- car_rental: nil,
916
- event_details: nil,
917
- flight: nil,
918
- lodging: nil,
919
- subscription: nil
920
- ); end
921
- end
922
243
  class Shipping < Stripe::RequestParams
923
244
  class Address < Stripe::RequestParams
924
245
  # City, district, suburb, town, or village.
925
- sig { returns(String) }
246
+ sig { returns(T.nilable(String)) }
926
247
  attr_accessor :city
927
248
  # Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
928
- sig { returns(String) }
249
+ sig { returns(T.nilable(String)) }
929
250
  attr_accessor :country
930
251
  # Address line 1 (e.g., street, PO Box, or company name).
931
- sig { returns(String) }
252
+ sig { returns(T.nilable(String)) }
932
253
  attr_accessor :line1
933
254
  # Address line 2 (e.g., apartment, suite, unit, or building).
934
- sig { returns(String) }
255
+ sig { returns(T.nilable(String)) }
935
256
  attr_accessor :line2
936
257
  # ZIP or postal code.
937
- sig { returns(String) }
258
+ sig { returns(T.nilable(String)) }
938
259
  attr_accessor :postal_code
939
260
  # State, county, province, or region.
940
- sig { returns(String) }
261
+ sig { returns(T.nilable(String)) }
941
262
  attr_accessor :state
942
263
  sig {
943
- params(city: String, country: String, line1: String, line2: String, postal_code: String, state: String).void
264
+ 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
944
265
  }
945
266
  def initialize(
946
267
  city: nil,
@@ -955,51 +276,48 @@ module Stripe
955
276
  sig { returns(::Stripe::ChargeService::UpdateParams::Shipping::Address) }
956
277
  attr_accessor :address
957
278
  # The delivery service that shipped a physical product, such as Fedex, UPS, USPS, etc.
958
- sig { returns(String) }
279
+ sig { returns(T.nilable(String)) }
959
280
  attr_accessor :carrier
960
281
  # Recipient name.
961
282
  sig { returns(String) }
962
283
  attr_accessor :name
963
284
  # Recipient phone (including extension).
964
- sig { returns(String) }
285
+ sig { returns(T.nilable(String)) }
965
286
  attr_accessor :phone
966
287
  # 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.
967
- sig { returns(String) }
288
+ sig { returns(T.nilable(String)) }
968
289
  attr_accessor :tracking_number
969
290
  sig {
970
- params(address: ::Stripe::ChargeService::UpdateParams::Shipping::Address, carrier: String, name: String, phone: String, tracking_number: String).void
291
+ params(address: ::Stripe::ChargeService::UpdateParams::Shipping::Address, carrier: T.nilable(String), name: String, phone: T.nilable(String), tracking_number: T.nilable(String)).void
971
292
  }
972
293
  def initialize(address: nil, carrier: nil, name: nil, phone: nil, tracking_number: nil); end
973
294
  end
974
295
  # The ID of an existing customer that will be associated with this request. This field may only be updated if there is no existing associated customer with this charge.
975
- sig { returns(String) }
296
+ sig { returns(T.nilable(String)) }
976
297
  attr_accessor :customer
977
298
  # An arbitrary string which you can attach to a charge object. It is displayed when in the web interface alongside the charge. Note that if you use Stripe to send automatic email receipts to your customers, your receipt emails will include the `description` of the charge(s) that they are describing.
978
- sig { returns(String) }
299
+ sig { returns(T.nilable(String)) }
979
300
  attr_accessor :description
980
301
  # Specifies which fields in the response should be expanded.
981
- sig { returns(T::Array[String]) }
302
+ sig { returns(T.nilable(T::Array[String])) }
982
303
  attr_accessor :expand
983
304
  # A set of key-value pairs you can attach to a charge giving information about its riskiness. If you believe a charge is fraudulent, include a `user_report` key with a value of `fraudulent`. If you believe a charge is safe, include a `user_report` key with a value of `safe`. Stripe will use the information you send to improve our fraud detection algorithms.
984
- sig { returns(::Stripe::ChargeService::UpdateParams::FraudDetails) }
305
+ sig { returns(T.nilable(::Stripe::ChargeService::UpdateParams::FraudDetails)) }
985
306
  attr_accessor :fraud_details
986
307
  # 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`.
987
- sig { returns(T.nilable(T::Hash[String, String])) }
308
+ sig { returns(T.nilable(T.nilable(T.any(String, T::Hash[String, String])))) }
988
309
  attr_accessor :metadata
989
- # Provides industry-specific information about the charge.
990
- sig { returns(::Stripe::ChargeService::UpdateParams::PaymentDetails) }
991
- attr_accessor :payment_details
992
310
  # This is the email address that the receipt for this charge will be sent to. If this field is updated, then a new email receipt will be sent to the updated address.
993
- sig { returns(String) }
311
+ sig { returns(T.nilable(String)) }
994
312
  attr_accessor :receipt_email
995
313
  # Shipping information for the charge. Helps prevent fraud on charges for physical goods.
996
- sig { returns(::Stripe::ChargeService::UpdateParams::Shipping) }
314
+ sig { returns(T.nilable(::Stripe::ChargeService::UpdateParams::Shipping)) }
997
315
  attr_accessor :shipping
998
316
  # A string that identifies this transaction as part of a group. `transfer_group` may only be provided if it has not been set. See the [Connect documentation](https://stripe.com/docs/connect/separate-charges-and-transfers#transfer-options) for details.
999
- sig { returns(String) }
317
+ sig { returns(T.nilable(String)) }
1000
318
  attr_accessor :transfer_group
1001
319
  sig {
1002
- params(customer: String, description: String, expand: T::Array[String], fraud_details: ::Stripe::ChargeService::UpdateParams::FraudDetails, metadata: T.nilable(T::Hash[String, String]), payment_details: ::Stripe::ChargeService::UpdateParams::PaymentDetails, receipt_email: String, shipping: ::Stripe::ChargeService::UpdateParams::Shipping, transfer_group: String).void
320
+ params(customer: T.nilable(String), description: T.nilable(String), expand: T.nilable(T::Array[String]), fraud_details: T.nilable(::Stripe::ChargeService::UpdateParams::FraudDetails), metadata: T.nilable(T.nilable(T.any(String, T::Hash[String, String]))), receipt_email: T.nilable(String), shipping: T.nilable(::Stripe::ChargeService::UpdateParams::Shipping), transfer_group: T.nilable(String)).void
1003
321
  }
1004
322
  def initialize(
1005
323
  customer: nil,
@@ -1007,7 +325,6 @@ module Stripe
1007
325
  expand: nil,
1008
326
  fraud_details: nil,
1009
327
  metadata: nil,
1010
- payment_details: nil,
1011
328
  receipt_email: nil,
1012
329
  shipping: nil,
1013
330
  transfer_group: nil
@@ -1015,752 +332,67 @@ module Stripe
1015
332
  end
1016
333
  class SearchParams < Stripe::RequestParams
1017
334
  # Specifies which fields in the response should be expanded.
1018
- sig { returns(T::Array[String]) }
335
+ sig { returns(T.nilable(T::Array[String])) }
1019
336
  attr_accessor :expand
1020
337
  # A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
1021
- sig { returns(Integer) }
338
+ sig { returns(T.nilable(Integer)) }
1022
339
  attr_accessor :limit
1023
340
  # A cursor for pagination across multiple pages of results. Don't include this parameter on the first call. Use the next_page value returned in a previous response to request subsequent results.
1024
- sig { returns(String) }
341
+ sig { returns(T.nilable(String)) }
1025
342
  attr_accessor :page
1026
343
  # The search query string. See [search query language](https://stripe.com/docs/search#search-query-language) and the list of supported [query fields for charges](https://stripe.com/docs/search#query-fields-for-charges).
1027
344
  sig { returns(String) }
1028
345
  attr_accessor :query
1029
- sig { params(expand: T::Array[String], limit: Integer, page: String, query: String).void }
346
+ sig {
347
+ params(expand: T.nilable(T::Array[String]), limit: T.nilable(Integer), page: T.nilable(String), query: String).void
348
+ }
1030
349
  def initialize(expand: nil, limit: nil, page: nil, query: nil); end
1031
350
  end
1032
351
  class CaptureParams < Stripe::RequestParams
1033
- class PaymentDetails < Stripe::RequestParams
1034
- class CarRental < Stripe::RequestParams
1035
- class Affiliate < Stripe::RequestParams
1036
- # The name of the affiliate that originated the purchase.
1037
- sig { returns(String) }
1038
- attr_accessor :name
1039
- sig { params(name: String).void }
1040
- def initialize(name: nil); end
1041
- end
1042
- class Delivery < Stripe::RequestParams
1043
- class Recipient < Stripe::RequestParams
1044
- # The email of the recipient the ticket is delivered to.
1045
- sig { returns(String) }
1046
- attr_accessor :email
1047
- # The name of the recipient the ticket is delivered to.
1048
- sig { returns(String) }
1049
- attr_accessor :name
1050
- # The phone number of the recipient the ticket is delivered to.
1051
- sig { returns(String) }
1052
- attr_accessor :phone
1053
- sig { params(email: String, name: String, phone: String).void }
1054
- def initialize(email: nil, name: nil, phone: nil); end
1055
- end
1056
- # The delivery method for the payment
1057
- sig { returns(String) }
1058
- attr_accessor :mode
1059
- # Details of the recipient.
1060
- sig {
1061
- returns(::Stripe::ChargeService::CaptureParams::PaymentDetails::CarRental::Delivery::Recipient)
1062
- }
1063
- attr_accessor :recipient
1064
- sig {
1065
- params(mode: String, recipient: ::Stripe::ChargeService::CaptureParams::PaymentDetails::CarRental::Delivery::Recipient).void
1066
- }
1067
- def initialize(mode: nil, recipient: nil); end
1068
- end
1069
- class Driver < Stripe::RequestParams
1070
- # Full name of the person or entity on the car reservation.
1071
- sig { returns(String) }
1072
- attr_accessor :name
1073
- sig { params(name: String).void }
1074
- def initialize(name: nil); end
1075
- end
1076
- class PickupAddress < Stripe::RequestParams
1077
- # City, district, suburb, town, or village.
1078
- sig { returns(String) }
1079
- attr_accessor :city
1080
- # Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
1081
- sig { returns(String) }
1082
- attr_accessor :country
1083
- # Address line 1 (e.g., street, PO Box, or company name).
1084
- sig { returns(String) }
1085
- attr_accessor :line1
1086
- # Address line 2 (e.g., apartment, suite, unit, or building).
1087
- sig { returns(String) }
1088
- attr_accessor :line2
1089
- # ZIP or postal code.
1090
- sig { returns(String) }
1091
- attr_accessor :postal_code
1092
- # State, county, province, or region.
1093
- sig { returns(String) }
1094
- attr_accessor :state
1095
- sig {
1096
- params(city: String, country: String, line1: String, line2: String, postal_code: String, state: String).void
1097
- }
1098
- def initialize(
1099
- city: nil,
1100
- country: nil,
1101
- line1: nil,
1102
- line2: nil,
1103
- postal_code: nil,
1104
- state: nil
1105
- ); end
1106
- end
1107
- class ReturnAddress < Stripe::RequestParams
1108
- # City, district, suburb, town, or village.
1109
- sig { returns(String) }
1110
- attr_accessor :city
1111
- # Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
1112
- sig { returns(String) }
1113
- attr_accessor :country
1114
- # Address line 1 (e.g., street, PO Box, or company name).
1115
- sig { returns(String) }
1116
- attr_accessor :line1
1117
- # Address line 2 (e.g., apartment, suite, unit, or building).
1118
- sig { returns(String) }
1119
- attr_accessor :line2
1120
- # ZIP or postal code.
1121
- sig { returns(String) }
1122
- attr_accessor :postal_code
1123
- # State, county, province, or region.
1124
- sig { returns(String) }
1125
- attr_accessor :state
1126
- sig {
1127
- params(city: String, country: String, line1: String, line2: String, postal_code: String, state: String).void
1128
- }
1129
- def initialize(
1130
- city: nil,
1131
- country: nil,
1132
- line1: nil,
1133
- line2: nil,
1134
- postal_code: nil,
1135
- state: nil
1136
- ); end
1137
- end
1138
- # Affiliate details for this purchase.
1139
- sig {
1140
- returns(::Stripe::ChargeService::CaptureParams::PaymentDetails::CarRental::Affiliate)
1141
- }
1142
- attr_accessor :affiliate
1143
- # The booking number associated with the car rental.
1144
- sig { returns(String) }
1145
- attr_accessor :booking_number
1146
- # Class code of the car.
1147
- sig { returns(String) }
1148
- attr_accessor :car_class_code
1149
- # Make of the car.
1150
- sig { returns(String) }
1151
- attr_accessor :car_make
1152
- # Model of the car.
1153
- sig { returns(String) }
1154
- attr_accessor :car_model
1155
- # The name of the rental car company.
1156
- sig { returns(String) }
1157
- attr_accessor :company
1158
- # The customer service phone number of the car rental company.
1159
- sig { returns(String) }
1160
- attr_accessor :customer_service_phone_number
1161
- # Number of days the car is being rented.
1162
- sig { returns(Integer) }
1163
- attr_accessor :days_rented
1164
- # Delivery details for this purchase.
1165
- sig {
1166
- returns(::Stripe::ChargeService::CaptureParams::PaymentDetails::CarRental::Delivery)
1167
- }
1168
- attr_accessor :delivery
1169
- # The details of the passengers in the travel reservation
1170
- sig {
1171
- returns(T::Array[::Stripe::ChargeService::CaptureParams::PaymentDetails::CarRental::Driver])
1172
- }
1173
- attr_accessor :drivers
1174
- # List of additional charges being billed.
1175
- sig { returns(T::Array[String]) }
1176
- attr_accessor :extra_charges
1177
- # Indicates if the customer did not keep nor cancel their booking.
1178
- sig { returns(T::Boolean) }
1179
- attr_accessor :no_show
1180
- # Car pick-up address.
1181
- sig {
1182
- returns(::Stripe::ChargeService::CaptureParams::PaymentDetails::CarRental::PickupAddress)
1183
- }
1184
- attr_accessor :pickup_address
1185
- # Car pick-up time. Measured in seconds since the Unix epoch.
1186
- sig { returns(Integer) }
1187
- attr_accessor :pickup_at
1188
- # Rental rate.
1189
- sig { returns(Integer) }
1190
- attr_accessor :rate_amount
1191
- # The frequency at which the rate amount is applied. One of `day`, `week` or `month`
1192
- sig { returns(String) }
1193
- attr_accessor :rate_interval
1194
- # The name of the person or entity renting the car.
1195
- sig { returns(String) }
1196
- attr_accessor :renter_name
1197
- # Car return address.
1198
- sig {
1199
- returns(::Stripe::ChargeService::CaptureParams::PaymentDetails::CarRental::ReturnAddress)
1200
- }
1201
- attr_accessor :return_address
1202
- # Car return time. Measured in seconds since the Unix epoch.
1203
- sig { returns(Integer) }
1204
- attr_accessor :return_at
1205
- # Indicates whether the goods or services are tax-exempt or tax is not collected.
1206
- sig { returns(T::Boolean) }
1207
- attr_accessor :tax_exempt
1208
- sig {
1209
- params(affiliate: ::Stripe::ChargeService::CaptureParams::PaymentDetails::CarRental::Affiliate, booking_number: String, car_class_code: String, car_make: String, car_model: String, company: String, customer_service_phone_number: String, days_rented: Integer, delivery: ::Stripe::ChargeService::CaptureParams::PaymentDetails::CarRental::Delivery, drivers: T::Array[::Stripe::ChargeService::CaptureParams::PaymentDetails::CarRental::Driver], extra_charges: T::Array[String], no_show: T::Boolean, pickup_address: ::Stripe::ChargeService::CaptureParams::PaymentDetails::CarRental::PickupAddress, pickup_at: Integer, rate_amount: Integer, rate_interval: String, renter_name: String, return_address: ::Stripe::ChargeService::CaptureParams::PaymentDetails::CarRental::ReturnAddress, return_at: Integer, tax_exempt: T::Boolean).void
1210
- }
1211
- def initialize(
1212
- affiliate: nil,
1213
- booking_number: nil,
1214
- car_class_code: nil,
1215
- car_make: nil,
1216
- car_model: nil,
1217
- company: nil,
1218
- customer_service_phone_number: nil,
1219
- days_rented: nil,
1220
- delivery: nil,
1221
- drivers: nil,
1222
- extra_charges: nil,
1223
- no_show: nil,
1224
- pickup_address: nil,
1225
- pickup_at: nil,
1226
- rate_amount: nil,
1227
- rate_interval: nil,
1228
- renter_name: nil,
1229
- return_address: nil,
1230
- return_at: nil,
1231
- tax_exempt: nil
1232
- ); end
1233
- end
1234
- class EventDetails < Stripe::RequestParams
1235
- class Address < Stripe::RequestParams
1236
- # City, district, suburb, town, or village.
1237
- sig { returns(String) }
1238
- attr_accessor :city
1239
- # Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
1240
- sig { returns(String) }
1241
- attr_accessor :country
1242
- # Address line 1 (e.g., street, PO Box, or company name).
1243
- sig { returns(String) }
1244
- attr_accessor :line1
1245
- # Address line 2 (e.g., apartment, suite, unit, or building).
1246
- sig { returns(String) }
1247
- attr_accessor :line2
1248
- # ZIP or postal code.
1249
- sig { returns(String) }
1250
- attr_accessor :postal_code
1251
- # State, county, province, or region.
1252
- sig { returns(String) }
1253
- attr_accessor :state
1254
- sig {
1255
- params(city: String, country: String, line1: String, line2: String, postal_code: String, state: String).void
1256
- }
1257
- def initialize(
1258
- city: nil,
1259
- country: nil,
1260
- line1: nil,
1261
- line2: nil,
1262
- postal_code: nil,
1263
- state: nil
1264
- ); end
1265
- end
1266
- class Affiliate < Stripe::RequestParams
1267
- # The name of the affiliate that originated the purchase.
1268
- sig { returns(String) }
1269
- attr_accessor :name
1270
- sig { params(name: String).void }
1271
- def initialize(name: nil); end
1272
- end
1273
- class Delivery < Stripe::RequestParams
1274
- class Recipient < Stripe::RequestParams
1275
- # The email of the recipient the ticket is delivered to.
1276
- sig { returns(String) }
1277
- attr_accessor :email
1278
- # The name of the recipient the ticket is delivered to.
1279
- sig { returns(String) }
1280
- attr_accessor :name
1281
- # The phone number of the recipient the ticket is delivered to.
1282
- sig { returns(String) }
1283
- attr_accessor :phone
1284
- sig { params(email: String, name: String, phone: String).void }
1285
- def initialize(email: nil, name: nil, phone: nil); end
1286
- end
1287
- # The delivery method for the payment
1288
- sig { returns(String) }
1289
- attr_accessor :mode
1290
- # Details of the recipient.
1291
- sig {
1292
- returns(::Stripe::ChargeService::CaptureParams::PaymentDetails::EventDetails::Delivery::Recipient)
1293
- }
1294
- attr_accessor :recipient
1295
- sig {
1296
- params(mode: String, recipient: ::Stripe::ChargeService::CaptureParams::PaymentDetails::EventDetails::Delivery::Recipient).void
1297
- }
1298
- def initialize(mode: nil, recipient: nil); end
1299
- end
1300
- # Indicates if the tickets are digitally checked when entering the venue.
1301
- sig { returns(T::Boolean) }
1302
- attr_accessor :access_controlled_venue
1303
- # The event location's address.
1304
- sig {
1305
- returns(::Stripe::ChargeService::CaptureParams::PaymentDetails::EventDetails::Address)
1306
- }
1307
- attr_accessor :address
1308
- # Affiliate details for this purchase.
1309
- sig {
1310
- returns(::Stripe::ChargeService::CaptureParams::PaymentDetails::EventDetails::Affiliate)
1311
- }
1312
- attr_accessor :affiliate
1313
- # The name of the company
1314
- sig { returns(String) }
1315
- attr_accessor :company
1316
- # Delivery details for this purchase.
1317
- sig {
1318
- returns(::Stripe::ChargeService::CaptureParams::PaymentDetails::EventDetails::Delivery)
1319
- }
1320
- attr_accessor :delivery
1321
- # Event end time. Measured in seconds since the Unix epoch.
1322
- sig { returns(Integer) }
1323
- attr_accessor :ends_at
1324
- # Type of the event entertainment (concert, sports event etc)
1325
- sig { returns(String) }
1326
- attr_accessor :genre
1327
- # The name of the event.
1328
- sig { returns(String) }
1329
- attr_accessor :name
1330
- # Event start time. Measured in seconds since the Unix epoch.
1331
- sig { returns(Integer) }
1332
- attr_accessor :starts_at
1333
- sig {
1334
- params(access_controlled_venue: T::Boolean, address: ::Stripe::ChargeService::CaptureParams::PaymentDetails::EventDetails::Address, affiliate: ::Stripe::ChargeService::CaptureParams::PaymentDetails::EventDetails::Affiliate, company: String, delivery: ::Stripe::ChargeService::CaptureParams::PaymentDetails::EventDetails::Delivery, ends_at: Integer, genre: String, name: String, starts_at: Integer).void
1335
- }
1336
- def initialize(
1337
- access_controlled_venue: nil,
1338
- address: nil,
1339
- affiliate: nil,
1340
- company: nil,
1341
- delivery: nil,
1342
- ends_at: nil,
1343
- genre: nil,
1344
- name: nil,
1345
- starts_at: nil
1346
- ); end
1347
- end
1348
- class Flight < Stripe::RequestParams
1349
- class Affiliate < Stripe::RequestParams
1350
- # The name of the affiliate that originated the purchase.
1351
- sig { returns(String) }
1352
- attr_accessor :name
1353
- sig { params(name: String).void }
1354
- def initialize(name: nil); end
1355
- end
1356
- class Delivery < Stripe::RequestParams
1357
- class Recipient < Stripe::RequestParams
1358
- # The email of the recipient the ticket is delivered to.
1359
- sig { returns(String) }
1360
- attr_accessor :email
1361
- # The name of the recipient the ticket is delivered to.
1362
- sig { returns(String) }
1363
- attr_accessor :name
1364
- # The phone number of the recipient the ticket is delivered to.
1365
- sig { returns(String) }
1366
- attr_accessor :phone
1367
- sig { params(email: String, name: String, phone: String).void }
1368
- def initialize(email: nil, name: nil, phone: nil); end
1369
- end
1370
- # The delivery method for the payment
1371
- sig { returns(String) }
1372
- attr_accessor :mode
1373
- # Details of the recipient.
1374
- sig {
1375
- returns(::Stripe::ChargeService::CaptureParams::PaymentDetails::Flight::Delivery::Recipient)
1376
- }
1377
- attr_accessor :recipient
1378
- sig {
1379
- params(mode: String, recipient: ::Stripe::ChargeService::CaptureParams::PaymentDetails::Flight::Delivery::Recipient).void
1380
- }
1381
- def initialize(mode: nil, recipient: nil); end
1382
- end
1383
- class Passenger < Stripe::RequestParams
1384
- # Full name of the person or entity on the flight reservation.
1385
- sig { returns(String) }
1386
- attr_accessor :name
1387
- sig { params(name: String).void }
1388
- def initialize(name: nil); end
1389
- end
1390
- class Segment < Stripe::RequestParams
1391
- # The flight segment amount.
1392
- sig { returns(Integer) }
1393
- attr_accessor :amount
1394
- # The International Air Transport Association (IATA) airport code for the arrival airport.
1395
- sig { returns(String) }
1396
- attr_accessor :arrival_airport
1397
- # The arrival time for the flight segment. Measured in seconds since the Unix epoch.
1398
- sig { returns(Integer) }
1399
- attr_accessor :arrives_at
1400
- # The International Air Transport Association (IATA) carrier code of the carrier operating the flight segment.
1401
- sig { returns(String) }
1402
- attr_accessor :carrier
1403
- # The departure time for the flight segment. Measured in seconds since the Unix epoch.
1404
- sig { returns(Integer) }
1405
- attr_accessor :departs_at
1406
- # The International Air Transport Association (IATA) airport code for the departure airport.
1407
- sig { returns(String) }
1408
- attr_accessor :departure_airport
1409
- # The flight number associated with the segment
1410
- sig { returns(String) }
1411
- attr_accessor :flight_number
1412
- # The fare class for the segment.
1413
- sig { returns(String) }
1414
- attr_accessor :service_class
1415
- sig {
1416
- params(amount: Integer, arrival_airport: String, arrives_at: Integer, carrier: String, departs_at: Integer, departure_airport: String, flight_number: String, service_class: String).void
1417
- }
1418
- def initialize(
1419
- amount: nil,
1420
- arrival_airport: nil,
1421
- arrives_at: nil,
1422
- carrier: nil,
1423
- departs_at: nil,
1424
- departure_airport: nil,
1425
- flight_number: nil,
1426
- service_class: nil
1427
- ); end
1428
- end
1429
- # Affiliate details for this purchase.
1430
- sig { returns(::Stripe::ChargeService::CaptureParams::PaymentDetails::Flight::Affiliate) }
1431
- attr_accessor :affiliate
1432
- # The agency number (i.e. International Air Transport Association (IATA) agency number) of the travel agency that made the booking.
1433
- sig { returns(String) }
1434
- attr_accessor :agency_number
1435
- # The International Air Transport Association (IATA) carrier code of the carrier that issued the ticket.
1436
- sig { returns(String) }
1437
- attr_accessor :carrier
1438
- # Delivery details for this purchase.
1439
- sig { returns(::Stripe::ChargeService::CaptureParams::PaymentDetails::Flight::Delivery) }
1440
- attr_accessor :delivery
1441
- # The name of the person or entity on the reservation.
1442
- sig { returns(String) }
1443
- attr_accessor :passenger_name
1444
- # The details of the passengers in the travel reservation.
1445
- sig {
1446
- returns(T::Array[::Stripe::ChargeService::CaptureParams::PaymentDetails::Flight::Passenger])
1447
- }
1448
- attr_accessor :passengers
1449
- # The individual flight segments associated with the trip.
1450
- sig {
1451
- returns(T::Array[::Stripe::ChargeService::CaptureParams::PaymentDetails::Flight::Segment])
1452
- }
1453
- attr_accessor :segments
1454
- # The ticket number associated with the travel reservation.
1455
- sig { returns(String) }
1456
- attr_accessor :ticket_number
1457
- sig {
1458
- params(affiliate: ::Stripe::ChargeService::CaptureParams::PaymentDetails::Flight::Affiliate, agency_number: String, carrier: String, delivery: ::Stripe::ChargeService::CaptureParams::PaymentDetails::Flight::Delivery, passenger_name: String, passengers: T::Array[::Stripe::ChargeService::CaptureParams::PaymentDetails::Flight::Passenger], segments: T::Array[::Stripe::ChargeService::CaptureParams::PaymentDetails::Flight::Segment], ticket_number: String).void
1459
- }
1460
- def initialize(
1461
- affiliate: nil,
1462
- agency_number: nil,
1463
- carrier: nil,
1464
- delivery: nil,
1465
- passenger_name: nil,
1466
- passengers: nil,
1467
- segments: nil,
1468
- ticket_number: nil
1469
- ); end
1470
- end
1471
- class Lodging < Stripe::RequestParams
1472
- class Address < Stripe::RequestParams
1473
- # City, district, suburb, town, or village.
1474
- sig { returns(String) }
1475
- attr_accessor :city
1476
- # Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
1477
- sig { returns(String) }
1478
- attr_accessor :country
1479
- # Address line 1 (e.g., street, PO Box, or company name).
1480
- sig { returns(String) }
1481
- attr_accessor :line1
1482
- # Address line 2 (e.g., apartment, suite, unit, or building).
1483
- sig { returns(String) }
1484
- attr_accessor :line2
1485
- # ZIP or postal code.
1486
- sig { returns(String) }
1487
- attr_accessor :postal_code
1488
- # State, county, province, or region.
1489
- sig { returns(String) }
1490
- attr_accessor :state
1491
- sig {
1492
- params(city: String, country: String, line1: String, line2: String, postal_code: String, state: String).void
1493
- }
1494
- def initialize(
1495
- city: nil,
1496
- country: nil,
1497
- line1: nil,
1498
- line2: nil,
1499
- postal_code: nil,
1500
- state: nil
1501
- ); end
1502
- end
1503
- class Affiliate < Stripe::RequestParams
1504
- # The name of the affiliate that originated the purchase.
1505
- sig { returns(String) }
1506
- attr_accessor :name
1507
- sig { params(name: String).void }
1508
- def initialize(name: nil); end
1509
- end
1510
- class Delivery < Stripe::RequestParams
1511
- class Recipient < Stripe::RequestParams
1512
- # The email of the recipient the ticket is delivered to.
1513
- sig { returns(String) }
1514
- attr_accessor :email
1515
- # The name of the recipient the ticket is delivered to.
1516
- sig { returns(String) }
1517
- attr_accessor :name
1518
- # The phone number of the recipient the ticket is delivered to.
1519
- sig { returns(String) }
1520
- attr_accessor :phone
1521
- sig { params(email: String, name: String, phone: String).void }
1522
- def initialize(email: nil, name: nil, phone: nil); end
1523
- end
1524
- # The delivery method for the payment
1525
- sig { returns(String) }
1526
- attr_accessor :mode
1527
- # Details of the recipient.
1528
- sig {
1529
- returns(::Stripe::ChargeService::CaptureParams::PaymentDetails::Lodging::Delivery::Recipient)
1530
- }
1531
- attr_accessor :recipient
1532
- sig {
1533
- params(mode: String, recipient: ::Stripe::ChargeService::CaptureParams::PaymentDetails::Lodging::Delivery::Recipient).void
1534
- }
1535
- def initialize(mode: nil, recipient: nil); end
1536
- end
1537
- class Passenger < Stripe::RequestParams
1538
- # Full name of the person or entity on the lodging reservation.
1539
- sig { returns(String) }
1540
- attr_accessor :name
1541
- sig { params(name: String).void }
1542
- def initialize(name: nil); end
1543
- end
1544
- # The lodging location's address.
1545
- sig { returns(::Stripe::ChargeService::CaptureParams::PaymentDetails::Lodging::Address) }
1546
- attr_accessor :address
1547
- # The number of adults on the booking
1548
- sig { returns(Integer) }
1549
- attr_accessor :adults
1550
- # Affiliate details for this purchase.
1551
- sig {
1552
- returns(::Stripe::ChargeService::CaptureParams::PaymentDetails::Lodging::Affiliate)
1553
- }
1554
- attr_accessor :affiliate
1555
- # The booking number associated with the lodging reservation.
1556
- sig { returns(String) }
1557
- attr_accessor :booking_number
1558
- # The lodging category
1559
- sig { returns(String) }
1560
- attr_accessor :category
1561
- # Loding check-in time. Measured in seconds since the Unix epoch.
1562
- sig { returns(Integer) }
1563
- attr_accessor :checkin_at
1564
- # Lodging check-out time. Measured in seconds since the Unix epoch.
1565
- sig { returns(Integer) }
1566
- attr_accessor :checkout_at
1567
- # The customer service phone number of the lodging company.
1568
- sig { returns(String) }
1569
- attr_accessor :customer_service_phone_number
1570
- # The daily lodging room rate.
1571
- sig { returns(Integer) }
1572
- attr_accessor :daily_room_rate_amount
1573
- # Delivery details for this purchase.
1574
- sig { returns(::Stripe::ChargeService::CaptureParams::PaymentDetails::Lodging::Delivery) }
1575
- attr_accessor :delivery
1576
- # List of additional charges being billed.
1577
- sig { returns(T::Array[String]) }
1578
- attr_accessor :extra_charges
1579
- # Indicates whether the lodging location is compliant with the Fire Safety Act.
1580
- sig { returns(T::Boolean) }
1581
- attr_accessor :fire_safety_act_compliance
1582
- # The name of the lodging location.
1583
- sig { returns(String) }
1584
- attr_accessor :name
1585
- # Indicates if the customer did not keep their booking while failing to cancel the reservation.
1586
- sig { returns(T::Boolean) }
1587
- attr_accessor :no_show
1588
- # The number of rooms on the booking
1589
- sig { returns(Integer) }
1590
- attr_accessor :number_of_rooms
1591
- # The details of the passengers in the travel reservation
1592
- sig {
1593
- returns(T::Array[::Stripe::ChargeService::CaptureParams::PaymentDetails::Lodging::Passenger])
1594
- }
1595
- attr_accessor :passengers
1596
- # The phone number of the lodging location.
1597
- sig { returns(String) }
1598
- attr_accessor :property_phone_number
1599
- # The room class for this purchase.
1600
- sig { returns(String) }
1601
- attr_accessor :room_class
1602
- # The number of room nights
1603
- sig { returns(Integer) }
1604
- attr_accessor :room_nights
1605
- # The total tax amount associating with the room reservation.
1606
- sig { returns(Integer) }
1607
- attr_accessor :total_room_tax_amount
1608
- # The total tax amount
1609
- sig { returns(Integer) }
1610
- attr_accessor :total_tax_amount
1611
- sig {
1612
- params(address: ::Stripe::ChargeService::CaptureParams::PaymentDetails::Lodging::Address, adults: Integer, affiliate: ::Stripe::ChargeService::CaptureParams::PaymentDetails::Lodging::Affiliate, booking_number: String, category: String, checkin_at: Integer, checkout_at: Integer, customer_service_phone_number: String, daily_room_rate_amount: Integer, delivery: ::Stripe::ChargeService::CaptureParams::PaymentDetails::Lodging::Delivery, extra_charges: T::Array[String], fire_safety_act_compliance: T::Boolean, name: String, no_show: T::Boolean, number_of_rooms: Integer, passengers: T::Array[::Stripe::ChargeService::CaptureParams::PaymentDetails::Lodging::Passenger], property_phone_number: String, room_class: String, room_nights: Integer, total_room_tax_amount: Integer, total_tax_amount: Integer).void
1613
- }
1614
- def initialize(
1615
- address: nil,
1616
- adults: nil,
1617
- affiliate: nil,
1618
- booking_number: nil,
1619
- category: nil,
1620
- checkin_at: nil,
1621
- checkout_at: nil,
1622
- customer_service_phone_number: nil,
1623
- daily_room_rate_amount: nil,
1624
- delivery: nil,
1625
- extra_charges: nil,
1626
- fire_safety_act_compliance: nil,
1627
- name: nil,
1628
- no_show: nil,
1629
- number_of_rooms: nil,
1630
- passengers: nil,
1631
- property_phone_number: nil,
1632
- room_class: nil,
1633
- room_nights: nil,
1634
- total_room_tax_amount: nil,
1635
- total_tax_amount: nil
1636
- ); end
1637
- end
1638
- class Subscription < Stripe::RequestParams
1639
- class Affiliate < Stripe::RequestParams
1640
- # The name of the affiliate that originated the purchase.
1641
- sig { returns(String) }
1642
- attr_accessor :name
1643
- sig { params(name: String).void }
1644
- def initialize(name: nil); end
1645
- end
1646
- class BillingInterval < Stripe::RequestParams
1647
- # The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
1648
- sig { returns(Integer) }
1649
- attr_accessor :count
1650
- # Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
1651
- sig { returns(String) }
1652
- attr_accessor :interval
1653
- sig { params(count: Integer, interval: String).void }
1654
- def initialize(count: nil, interval: nil); end
1655
- end
1656
- # Affiliate details for this purchase.
1657
- sig {
1658
- returns(::Stripe::ChargeService::CaptureParams::PaymentDetails::Subscription::Affiliate)
1659
- }
1660
- attr_accessor :affiliate
1661
- # Info whether the subscription will be auto renewed upon expiry.
1662
- sig { returns(T::Boolean) }
1663
- attr_accessor :auto_renewal
1664
- # Subscription billing details for this purchase.
1665
- sig {
1666
- returns(::Stripe::ChargeService::CaptureParams::PaymentDetails::Subscription::BillingInterval)
1667
- }
1668
- attr_accessor :billing_interval
1669
- # Subscription end time. Measured in seconds since the Unix epoch.
1670
- sig { returns(Integer) }
1671
- attr_accessor :ends_at
1672
- # Name of the product on subscription. e.g. Apple Music Subscription
1673
- sig { returns(String) }
1674
- attr_accessor :name
1675
- # Subscription start time. Measured in seconds since the Unix epoch.
1676
- sig { returns(Integer) }
1677
- attr_accessor :starts_at
1678
- sig {
1679
- params(affiliate: ::Stripe::ChargeService::CaptureParams::PaymentDetails::Subscription::Affiliate, auto_renewal: T::Boolean, billing_interval: ::Stripe::ChargeService::CaptureParams::PaymentDetails::Subscription::BillingInterval, ends_at: Integer, name: String, starts_at: Integer).void
1680
- }
1681
- def initialize(
1682
- affiliate: nil,
1683
- auto_renewal: nil,
1684
- billing_interval: nil,
1685
- ends_at: nil,
1686
- name: nil,
1687
- starts_at: nil
1688
- ); end
1689
- end
1690
- # Car rental details for this PaymentIntent.
1691
- sig { returns(::Stripe::ChargeService::CaptureParams::PaymentDetails::CarRental) }
1692
- attr_accessor :car_rental
1693
- # Event details for this PaymentIntent
1694
- sig { returns(::Stripe::ChargeService::CaptureParams::PaymentDetails::EventDetails) }
1695
- attr_accessor :event_details
1696
- # Flight reservation details for this PaymentIntent
1697
- sig { returns(::Stripe::ChargeService::CaptureParams::PaymentDetails::Flight) }
1698
- attr_accessor :flight
1699
- # Lodging reservation details for this PaymentIntent
1700
- sig { returns(::Stripe::ChargeService::CaptureParams::PaymentDetails::Lodging) }
1701
- attr_accessor :lodging
1702
- # Subscription details for this PaymentIntent
1703
- sig { returns(::Stripe::ChargeService::CaptureParams::PaymentDetails::Subscription) }
1704
- attr_accessor :subscription
1705
- sig {
1706
- params(car_rental: ::Stripe::ChargeService::CaptureParams::PaymentDetails::CarRental, event_details: ::Stripe::ChargeService::CaptureParams::PaymentDetails::EventDetails, flight: ::Stripe::ChargeService::CaptureParams::PaymentDetails::Flight, lodging: ::Stripe::ChargeService::CaptureParams::PaymentDetails::Lodging, subscription: ::Stripe::ChargeService::CaptureParams::PaymentDetails::Subscription).void
1707
- }
1708
- def initialize(
1709
- car_rental: nil,
1710
- event_details: nil,
1711
- flight: nil,
1712
- lodging: nil,
1713
- subscription: nil
1714
- ); end
1715
- end
1716
352
  class TransferData < Stripe::RequestParams
1717
353
  # The amount transferred to the destination account, if specified. By default, the entire charge amount is transferred to the destination account.
1718
- sig { returns(Integer) }
354
+ sig { returns(T.nilable(Integer)) }
1719
355
  attr_accessor :amount
1720
- sig { params(amount: Integer).void }
356
+ sig { params(amount: T.nilable(Integer)).void }
1721
357
  def initialize(amount: nil); end
1722
358
  end
1723
- # The amount to capture, which must be less than or equal to the original amount. Any additional amount will be automatically refunded.
1724
- sig { returns(Integer) }
359
+ # The amount to capture, which must be less than or equal to the original amount.
360
+ sig { returns(T.nilable(Integer)) }
1725
361
  attr_accessor :amount
1726
362
  # An application fee to add on to this charge.
1727
- sig { returns(Integer) }
363
+ sig { returns(T.nilable(Integer)) }
1728
364
  attr_accessor :application_fee
1729
365
  # An application fee amount to add on to this charge, which must be less than or equal to the original amount.
1730
- sig { returns(Integer) }
366
+ sig { returns(T.nilable(Integer)) }
1731
367
  attr_accessor :application_fee_amount
1732
368
  # Specifies which fields in the response should be expanded.
1733
- sig { returns(T::Array[String]) }
369
+ sig { returns(T.nilable(T::Array[String])) }
1734
370
  attr_accessor :expand
1735
- # Provides industry-specific information about the charge.
1736
- sig { returns(::Stripe::ChargeService::CaptureParams::PaymentDetails) }
1737
- attr_accessor :payment_details
1738
371
  # The email address to send this charge's receipt to. This will override the previously-specified email address for this charge, if one was set. Receipts will not be sent in test mode.
1739
- sig { returns(String) }
372
+ sig { returns(T.nilable(String)) }
1740
373
  attr_accessor :receipt_email
1741
374
  # For a non-card charge, text that appears on the customer's statement as the statement descriptor. This value overrides the account's default statement descriptor. For information about requirements, including the 22-character limit, see [the Statement Descriptor docs](https://docs.stripe.com/get-started/account/statement-descriptors).
1742
375
  #
1743
376
  # For a card charge, this value is ignored unless you don't specify a `statement_descriptor_suffix`, in which case this value is used as the suffix.
1744
- sig { returns(String) }
377
+ sig { returns(T.nilable(String)) }
1745
378
  attr_accessor :statement_descriptor
1746
379
  # Provides information about a card charge. Concatenated to the account's [statement descriptor prefix](https://docs.stripe.com/get-started/account/statement-descriptors#static) to form the complete statement descriptor that appears on the customer's statement. If the account has no prefix value, the suffix is concatenated to the account's statement descriptor.
1747
- sig { returns(String) }
380
+ sig { returns(T.nilable(String)) }
1748
381
  attr_accessor :statement_descriptor_suffix
1749
382
  # An optional dictionary including the account to automatically transfer to as part of a destination charge. [See the Connect documentation](https://stripe.com/docs/connect/destination-charges) for details.
1750
- sig { returns(::Stripe::ChargeService::CaptureParams::TransferData) }
383
+ sig { returns(T.nilable(::Stripe::ChargeService::CaptureParams::TransferData)) }
1751
384
  attr_accessor :transfer_data
1752
385
  # A string that identifies this transaction as part of a group. `transfer_group` may only be provided if it has not been set. See the [Connect documentation](https://stripe.com/docs/connect/separate-charges-and-transfers#transfer-options) for details.
1753
- sig { returns(String) }
386
+ sig { returns(T.nilable(String)) }
1754
387
  attr_accessor :transfer_group
1755
388
  sig {
1756
- params(amount: Integer, application_fee: Integer, application_fee_amount: Integer, expand: T::Array[String], payment_details: ::Stripe::ChargeService::CaptureParams::PaymentDetails, receipt_email: String, statement_descriptor: String, statement_descriptor_suffix: String, transfer_data: ::Stripe::ChargeService::CaptureParams::TransferData, transfer_group: String).void
389
+ params(amount: T.nilable(Integer), application_fee: T.nilable(Integer), application_fee_amount: T.nilable(Integer), expand: T.nilable(T::Array[String]), receipt_email: T.nilable(String), statement_descriptor: T.nilable(String), statement_descriptor_suffix: T.nilable(String), transfer_data: T.nilable(::Stripe::ChargeService::CaptureParams::TransferData), transfer_group: T.nilable(String)).void
1757
390
  }
1758
391
  def initialize(
1759
392
  amount: nil,
1760
393
  application_fee: nil,
1761
394
  application_fee_amount: nil,
1762
395
  expand: nil,
1763
- payment_details: nil,
1764
396
  receipt_email: nil,
1765
397
  statement_descriptor: nil,
1766
398
  statement_descriptor_suffix: nil,