stripe 15.2.1 → 15.3.0.pre.beta.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (588) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +1602 -674
  3. data/VERSION +1 -1
  4. data/lib/stripe/api_requestor.rb +28 -0
  5. data/lib/stripe/api_version.rb +1 -1
  6. data/lib/stripe/errors.rb +54 -0
  7. data/lib/stripe/event_types.rb +98 -0
  8. data/lib/stripe/events/v2_core_account_closed_event.rb +21 -0
  9. data/lib/stripe/events/v2_core_account_created_event.rb +21 -0
  10. data/lib/stripe/events/v2_core_account_including_configuration_customer_capability_status_updated_event.rb +23 -0
  11. data/lib/stripe/events/v2_core_account_including_configuration_customer_updated_event.rb +21 -0
  12. data/lib/stripe/events/v2_core_account_including_configuration_merchant_capability_status_updated_event.rb +23 -0
  13. data/lib/stripe/events/v2_core_account_including_configuration_merchant_updated_event.rb +21 -0
  14. data/lib/stripe/events/v2_core_account_including_configuration_recipient_capability_status_updated_event.rb +23 -0
  15. data/lib/stripe/events/v2_core_account_including_configuration_recipient_updated_event.rb +21 -0
  16. data/lib/stripe/events/v2_core_account_including_defaults_updated_event.rb +21 -0
  17. data/lib/stripe/events/v2_core_account_including_identity_updated_event.rb +21 -0
  18. data/lib/stripe/events/v2_core_account_including_requirements_updated_event.rb +21 -0
  19. data/lib/stripe/events/v2_core_account_link_completed_event.rb +13 -0
  20. data/lib/stripe/events/v2_core_account_person_created_event.rb +23 -0
  21. data/lib/stripe/events/v2_core_account_person_deleted_event.rb +23 -0
  22. data/lib/stripe/events/v2_core_account_person_updated_event.rb +23 -0
  23. data/lib/stripe/events/v2_core_account_updated_event.rb +21 -0
  24. data/lib/stripe/events/v2_money_management_adjustment_created_event.rb +21 -0
  25. data/lib/stripe/events/v2_money_management_financial_account_created_event.rb +21 -0
  26. data/lib/stripe/events/v2_money_management_financial_account_updated_event.rb +21 -0
  27. data/lib/stripe/events/v2_money_management_financial_address_activated_event.rb +21 -0
  28. data/lib/stripe/events/v2_money_management_financial_address_failed_event.rb +21 -0
  29. data/lib/stripe/events/v2_money_management_inbound_transfer_available_event.rb +23 -0
  30. data/lib/stripe/events/v2_money_management_inbound_transfer_bank_debit_failed_event.rb +21 -0
  31. data/lib/stripe/events/v2_money_management_inbound_transfer_bank_debit_processing_event.rb +21 -0
  32. data/lib/stripe/events/v2_money_management_inbound_transfer_bank_debit_queued_event.rb +21 -0
  33. data/lib/stripe/events/v2_money_management_inbound_transfer_bank_debit_returned_event.rb +21 -0
  34. data/lib/stripe/events/v2_money_management_inbound_transfer_bank_debit_succeeded_event.rb +21 -0
  35. data/lib/stripe/events/v2_money_management_outbound_payment_canceled_event.rb +21 -0
  36. data/lib/stripe/events/v2_money_management_outbound_payment_created_event.rb +21 -0
  37. data/lib/stripe/events/v2_money_management_outbound_payment_failed_event.rb +21 -0
  38. data/lib/stripe/events/v2_money_management_outbound_payment_posted_event.rb +21 -0
  39. data/lib/stripe/events/v2_money_management_outbound_payment_returned_event.rb +21 -0
  40. data/lib/stripe/events/v2_money_management_outbound_payment_updated_event.rb +21 -0
  41. data/lib/stripe/events/v2_money_management_outbound_transfer_canceled_event.rb +21 -0
  42. data/lib/stripe/events/v2_money_management_outbound_transfer_created_event.rb +21 -0
  43. data/lib/stripe/events/v2_money_management_outbound_transfer_failed_event.rb +21 -0
  44. data/lib/stripe/events/v2_money_management_outbound_transfer_posted_event.rb +21 -0
  45. data/lib/stripe/events/v2_money_management_outbound_transfer_returned_event.rb +21 -0
  46. data/lib/stripe/events/v2_money_management_outbound_transfer_updated_event.rb +21 -0
  47. data/lib/stripe/events/v2_money_management_received_credit_available_event.rb +23 -0
  48. data/lib/stripe/events/v2_money_management_received_credit_failed_event.rb +21 -0
  49. data/lib/stripe/events/v2_money_management_received_credit_returned_event.rb +21 -0
  50. data/lib/stripe/events/v2_money_management_received_credit_succeeded_event.rb +21 -0
  51. data/lib/stripe/events/v2_money_management_received_debit_canceled_event.rb +21 -0
  52. data/lib/stripe/events/v2_money_management_received_debit_failed_event.rb +21 -0
  53. data/lib/stripe/events/v2_money_management_received_debit_pending_event.rb +21 -0
  54. data/lib/stripe/events/v2_money_management_received_debit_succeeded_event.rb +21 -0
  55. data/lib/stripe/events/v2_money_management_received_debit_updated_event.rb +21 -0
  56. data/lib/stripe/events/v2_money_management_transaction_created_event.rb +21 -0
  57. data/lib/stripe/events/v2_money_management_transaction_updated_event.rb +21 -0
  58. data/lib/stripe/events/v2_off_session_payment_requires_capture_event.rb +21 -0
  59. data/lib/stripe/events/v2_payments_off_session_payment_authorization_attempt_failed_event.rb +21 -0
  60. data/lib/stripe/events/v2_payments_off_session_payment_authorization_attempt_started_event.rb +21 -0
  61. data/lib/stripe/events/v2_payments_off_session_payment_canceled_event.rb +21 -0
  62. data/lib/stripe/events/v2_payments_off_session_payment_created_event.rb +21 -0
  63. data/lib/stripe/events/v2_payments_off_session_payment_failed_event.rb +21 -0
  64. data/lib/stripe/events/v2_payments_off_session_payment_succeeded_event.rb +21 -0
  65. data/lib/stripe/object_types.rb +50 -0
  66. data/lib/stripe/resources/account.rb +653 -1
  67. data/lib/stripe/resources/account_notice.rb +123 -0
  68. data/lib/stripe/resources/account_session.rb +256 -1
  69. data/lib/stripe/resources/balance_settings.rb +105 -0
  70. data/lib/stripe/resources/billing/credit_balance_summary.rb +2 -0
  71. data/lib/stripe/resources/billing/credit_balance_transaction.rb +4 -0
  72. data/lib/stripe/resources/billing/credit_grant.rb +10 -0
  73. data/lib/stripe/resources/billing_portal/session.rb +6 -0
  74. data/lib/stripe/resources/capital/financing_offer.rb +179 -0
  75. data/lib/stripe/resources/capital/financing_summary.rb +55 -0
  76. data/lib/stripe/resources/capital/financing_transaction.rb +114 -0
  77. data/lib/stripe/resources/card.rb +2 -0
  78. data/lib/stripe/resources/cash_balance.rb +2 -0
  79. data/lib/stripe/resources/charge.rb +1538 -0
  80. data/lib/stripe/resources/checkout/session.rb +330 -2
  81. data/lib/stripe/resources/confirmation_token.rb +170 -0
  82. data/lib/stripe/resources/coupon.rb +30 -1
  83. data/lib/stripe/resources/credit_note.rb +6 -0
  84. data/lib/stripe/resources/credit_note_line_item.rb +9 -0
  85. data/lib/stripe/resources/customer.rb +2 -0
  86. data/lib/stripe/resources/customer_balance_transaction.rb +2 -0
  87. data/lib/stripe/resources/customer_cash_balance_transaction.rb +2 -0
  88. data/lib/stripe/resources/customer_session.rb +6 -1
  89. data/lib/stripe/resources/discount.rb +2 -0
  90. data/lib/stripe/resources/event.rb +31 -0
  91. data/lib/stripe/resources/financial_connections/account.rb +22 -1
  92. data/lib/stripe/resources/financial_connections/account_inferred_balance.rb +27 -0
  93. data/lib/stripe/resources/financial_connections/institution.rb +92 -0
  94. data/lib/stripe/resources/financial_connections/session.rb +62 -2
  95. data/lib/stripe/resources/fx_quote.rb +184 -0
  96. data/lib/stripe/resources/identity/verification_session.rb +10 -0
  97. data/lib/stripe/resources/invoice.rb +1070 -16
  98. data/lib/stripe/resources/invoice_item.rb +78 -2
  99. data/lib/stripe/resources/invoice_line_item.rb +55 -1
  100. data/lib/stripe/resources/invoice_payment.rb +2 -53
  101. data/lib/stripe/resources/issuing/cardholder.rb +2 -1
  102. data/lib/stripe/resources/issuing/credit_underwriting_record.rb +602 -0
  103. data/lib/stripe/resources/issuing/dispute_settlement_detail.rb +82 -0
  104. data/lib/stripe/resources/issuing/fraud_liability_debit.rb +86 -0
  105. data/lib/stripe/resources/issuing/settlement.rb +53 -0
  106. data/lib/stripe/resources/issuing/transaction.rb +6 -0
  107. data/lib/stripe/resources/line_item.rb +37 -0
  108. data/lib/stripe/resources/mandate.rb +24 -0
  109. data/lib/stripe/resources/margin.rb +115 -0
  110. data/lib/stripe/resources/order.rb +2806 -0
  111. data/lib/stripe/resources/payment_attempt_record.rb +1086 -0
  112. data/lib/stripe/resources/payment_intent.rb +7694 -2738
  113. data/lib/stripe/resources/payment_intent_amount_details_line_item.rb +72 -0
  114. data/lib/stripe/resources/payment_method.rb +192 -1
  115. data/lib/stripe/resources/payment_method_configuration.rb +295 -0
  116. data/lib/stripe/resources/payment_record.rb +1615 -0
  117. data/lib/stripe/resources/payout.rb +6 -0
  118. data/lib/stripe/resources/price.rb +30 -0
  119. data/lib/stripe/resources/privacy/redaction_job.rb +298 -0
  120. data/lib/stripe/resources/privacy/redaction_job_validation_error.rb +33 -0
  121. data/lib/stripe/resources/promotion_code.rb +10 -0
  122. data/lib/stripe/resources/quote.rb +2046 -6
  123. data/lib/stripe/resources/quote_line.rb +274 -0
  124. data/lib/stripe/resources/quote_preview_invoice.rb +663 -0
  125. data/lib/stripe/resources/quote_preview_subscription_schedule.rb +364 -0
  126. data/lib/stripe/resources/refund.rb +9 -0
  127. data/lib/stripe/resources/setup_attempt.rb +21 -0
  128. data/lib/stripe/resources/setup_intent.rb +578 -9
  129. data/lib/stripe/resources/source.rb +29 -0
  130. data/lib/stripe/resources/subscription.rb +333 -9
  131. data/lib/stripe/resources/subscription_item.rb +84 -3
  132. data/lib/stripe/resources/subscription_schedule.rb +1013 -10
  133. data/lib/stripe/resources/tax/association.rb +66 -0
  134. data/lib/stripe/resources/tax/form.rb +211 -0
  135. data/lib/stripe/resources/tax_id.rb +12 -2
  136. data/lib/stripe/resources/terminal/reader.rb +156 -0
  137. data/lib/stripe/resources/terminal/reader_collected_data.rb +31 -0
  138. data/lib/stripe/resources/transfer.rb +6 -0
  139. data/lib/stripe/resources/treasury/financial_account.rb +22 -3
  140. data/lib/stripe/resources/treasury/financial_account_features.rb +2 -0
  141. data/lib/stripe/resources/treasury/outbound_transfer.rb +37 -0
  142. data/lib/stripe/resources/treasury/received_credit.rb +38 -1
  143. data/lib/stripe/resources/treasury/received_debit.rb +40 -1
  144. data/lib/stripe/resources/v2/core/account.rb +1746 -0
  145. data/lib/stripe/resources/v2/core/account_link.rb +56 -0
  146. data/lib/stripe/resources/v2/core/person.rb +276 -0
  147. data/lib/stripe/resources/v2/core/vault/gb_bank_account.rb +74 -0
  148. data/lib/stripe/resources/v2/core/vault/us_bank_account.rb +39 -0
  149. data/lib/stripe/resources/v2/financial_address_credit_simulation.rb +20 -0
  150. data/lib/stripe/resources/v2/financial_address_generated_microdeposits.rb +22 -0
  151. data/lib/stripe/resources/v2/money_management/adjustment.rb +51 -0
  152. data/lib/stripe/resources/v2/money_management/financial_account.rb +58 -0
  153. data/lib/stripe/resources/v2/money_management/financial_address.rb +68 -0
  154. data/lib/stripe/resources/v2/money_management/inbound_transfer.rb +94 -0
  155. data/lib/stripe/resources/v2/money_management/outbound_payment.rb +129 -0
  156. data/lib/stripe/resources/v2/money_management/outbound_payment_quote.rb +82 -0
  157. data/lib/stripe/resources/v2/money_management/outbound_setup_intent.rb +45 -0
  158. data/lib/stripe/resources/v2/money_management/outbound_transfer.rb +117 -0
  159. data/lib/stripe/resources/v2/money_management/payout_method.rb +75 -0
  160. data/lib/stripe/resources/v2/money_management/payout_methods_bank_account_spec.rb +49 -0
  161. data/lib/stripe/resources/v2/money_management/received_credit.rb +116 -0
  162. data/lib/stripe/resources/v2/money_management/received_debit.rb +84 -0
  163. data/lib/stripe/resources/v2/money_management/transaction.rb +78 -0
  164. data/lib/stripe/resources/v2/money_management/transaction_entry.rb +68 -0
  165. data/lib/stripe/resources/v2/payments/off_session_payment.rb +72 -0
  166. data/lib/stripe/resources.rb +104 -0
  167. data/lib/stripe/services/account_notice_service.rb +101 -0
  168. data/lib/stripe/services/account_service.rb +562 -1
  169. data/lib/stripe/services/account_session_service.rb +226 -1
  170. data/lib/stripe/services/balance_settings_service.rb +96 -0
  171. data/lib/stripe/services/billing/credit_balance_summary_service.rb +4 -1
  172. data/lib/stripe/services/billing/credit_balance_transaction_service.rb +4 -0
  173. data/lib/stripe/services/billing/credit_grant_service.rb +8 -0
  174. data/lib/stripe/services/billing_portal/session_service.rb +4 -0
  175. data/lib/stripe/services/capital/financing_offer_service.rb +112 -0
  176. data/lib/stripe/services/capital/financing_summary_service.rb +28 -0
  177. data/lib/stripe/services/capital/financing_transaction_service.rb +79 -0
  178. data/lib/stripe/services/capital_service.rb +15 -0
  179. data/lib/stripe/services/charge_service.rb +1418 -0
  180. data/lib/stripe/services/checkout/session_service.rb +247 -2
  181. data/lib/stripe/services/coupon_service.rb +17 -1
  182. data/lib/stripe/services/credit_note_service.rb +4 -0
  183. data/lib/stripe/services/customer_session_service.rb +4 -1
  184. data/{rbi/stripe/services/account_external_account_service.rbi → lib/stripe/services/external_account_service.rb} +135 -122
  185. data/{rbi/stripe/services/tax/transaction_line_item_service.rbi → lib/stripe/services/financial_connections/account_inferred_balance_service.rb} +21 -17
  186. data/lib/stripe/services/financial_connections/account_service.rb +7 -2
  187. data/{rbi/stripe/services/climate/supplier_service.rbi → lib/stripe/services/financial_connections/institution_service.rb} +36 -25
  188. data/lib/stripe/services/financial_connections/session_service.rb +34 -2
  189. data/lib/stripe/services/financial_connections_service.rb +2 -1
  190. data/lib/stripe/services/fx_quote_service.rb +123 -0
  191. data/lib/stripe/services/identity/verification_session_service.rb +8 -0
  192. data/lib/stripe/services/invoice_item_service.rb +74 -2
  193. data/lib/stripe/services/invoice_line_item_service.rb +33 -1
  194. data/lib/stripe/services/invoice_service.rb +1021 -16
  195. data/lib/stripe/services/issuing/cardholder_service.rb +2 -1
  196. data/lib/stripe/services/issuing/credit_underwriting_record_service.rb +504 -0
  197. data/lib/stripe/services/issuing/dispute_settlement_detail_service.rb +66 -0
  198. data/lib/stripe/services/issuing/fraud_liability_debit_service.rb +83 -0
  199. data/lib/stripe/services/issuing/transaction_service.rb +4 -0
  200. data/lib/stripe/services/issuing_service.rb +5 -1
  201. data/lib/stripe/services/margin_service.rb +119 -0
  202. data/{rbi/stripe/services/source_transaction_service.rbi → lib/stripe/services/order_line_item_service.rb} +20 -16
  203. data/lib/stripe/services/order_service.rb +2236 -0
  204. data/lib/stripe/services/payment_attempt_record_service.rb +49 -0
  205. data/{rbi/stripe/services/quote_line_item_service.rbi → lib/stripe/services/payment_intent_amount_details_line_item_service.rb} +20 -16
  206. data/lib/stripe/services/payment_intent_service.rb +4733 -245
  207. data/lib/stripe/services/payment_method_configuration_service.rb +210 -0
  208. data/lib/stripe/services/payment_method_service.rb +120 -1
  209. data/lib/stripe/services/payment_record_service.rb +542 -0
  210. data/lib/stripe/services/payout_service.rb +4 -0
  211. data/lib/stripe/services/price_service.rb +19 -0
  212. data/lib/stripe/services/privacy/redaction_job_service.rb +240 -0
  213. data/{rbi/stripe/services/tax/calculation_line_item_service.rbi → lib/stripe/services/privacy/redaction_job_validation_error_service.rb} +21 -17
  214. data/lib/stripe/services/privacy_service.rb +13 -0
  215. data/lib/stripe/services/promotion_code_service.rb +8 -0
  216. data/{rbi/stripe/services/credit_note_line_item_service.rbi → lib/stripe/services/quote_line_service.rb} +20 -16
  217. data/{rbi/stripe/services/payment_link_line_item_service.rbi → lib/stripe/services/quote_preview_invoice_service.rb} +20 -16
  218. data/lib/stripe/services/quote_preview_subscription_schedule_service.rb +35 -0
  219. data/lib/stripe/services/quote_service.rb +1730 -7
  220. data/lib/stripe/services/setup_intent_service.rb +538 -9
  221. data/lib/stripe/services/subscription_item_service.rb +75 -3
  222. data/lib/stripe/services/subscription_schedule_service.rb +915 -10
  223. data/lib/stripe/services/subscription_service.rb +276 -9
  224. data/lib/stripe/services/tax/association_service.rb +31 -0
  225. data/lib/stripe/services/tax/form_service.rb +100 -0
  226. data/lib/stripe/services/tax_id_service.rb +8 -2
  227. data/lib/stripe/services/tax_service.rb +3 -1
  228. data/lib/stripe/services/terminal/reader_collected_data_service.rb +28 -0
  229. data/lib/stripe/services/terminal/reader_service.rb +90 -0
  230. data/lib/stripe/services/terminal_service.rb +2 -1
  231. data/lib/stripe/services/test_helpers/confirmation_token_service.rb +97 -0
  232. data/lib/stripe/services/test_helpers/treasury/received_credit_service.rb +25 -1
  233. data/lib/stripe/services/test_helpers/treasury/received_debit_service.rb +25 -1
  234. data/lib/stripe/services/transfer_service.rb +4 -0
  235. data/lib/stripe/services/treasury/financial_account_features_service.rb +4 -1
  236. data/lib/stripe/services/treasury/financial_account_service.rb +16 -2
  237. data/lib/stripe/services/treasury/outbound_transfer_service.rb +24 -0
  238. data/lib/stripe/services/v1_services.rb +11 -2
  239. data/lib/stripe/services/v2/core/account_link_service.rb +76 -0
  240. data/lib/stripe/services/v2/core/account_service.rb +4138 -0
  241. data/lib/stripe/services/v2/core/accounts/person_service.rb +1046 -0
  242. data/lib/stripe/services/v2/core/vault/gb_bank_account_service.rb +131 -0
  243. data/lib/stripe/services/v2/core/vault/us_bank_account_service.rb +107 -0
  244. data/lib/stripe/services/v2/core/vault_service.rb +18 -0
  245. data/lib/stripe/services/v2/core_service.rb +4 -1
  246. data/lib/stripe/services/v2/money_management/adjustment_service.rb +74 -0
  247. data/lib/stripe/services/v2/money_management/financial_account_service.rb +43 -0
  248. data/lib/stripe/services/v2/money_management/financial_address_service.rb +81 -0
  249. data/lib/stripe/services/v2/money_management/inbound_transfer_service.rb +125 -0
  250. data/lib/stripe/services/v2/money_management/outbound_payment_quote_service.rb +95 -0
  251. data/lib/stripe/services/v2/money_management/outbound_payment_service.rb +200 -0
  252. data/lib/stripe/services/v2/money_management/outbound_setup_intent_service.rb +235 -0
  253. data/lib/stripe/services/v2/money_management/outbound_transfer_service.rb +172 -0
  254. data/lib/stripe/services/v2/money_management/payout_method_service.rb +91 -0
  255. data/lib/stripe/services/v2/money_management/payout_methods_bank_account_spec_service.rb +32 -0
  256. data/lib/stripe/services/v2/money_management/received_credit_service.rb +70 -0
  257. data/lib/stripe/services/v2/money_management/received_debit_service.rb +43 -0
  258. data/lib/stripe/services/v2/money_management/transaction_entry_service.rb +69 -0
  259. data/lib/stripe/services/v2/money_management/transaction_service.rb +73 -0
  260. data/lib/stripe/services/v2/money_management_service.rb +31 -0
  261. data/lib/stripe/services/v2/payment_service.rb +15 -0
  262. data/lib/stripe/services/v2/payments/off_session_payment_service.rb +138 -0
  263. data/lib/stripe/services/v2/test_helper_service.rb +15 -0
  264. data/lib/stripe/services/v2/test_helpers/financial_address_service.rb +49 -0
  265. data/lib/stripe/services/v2_services.rb +5 -2
  266. data/lib/stripe/services.rb +53 -1
  267. data/lib/stripe/stripe_configuration.rb +3 -1
  268. data/lib/stripe/stripe_object.rb +1 -1
  269. data/lib/stripe/util.rb +7 -1
  270. data/lib/stripe/version.rb +1 -1
  271. data/lib/stripe/webhook.rb +1 -1
  272. data/lib/stripe.rb +53 -0
  273. data/rbi/stripe.rbi +191636 -0
  274. data/stripe.gemspec +4 -1
  275. metadata +162 -325
  276. data/lib/stripe/services/invoice_payment_service.rb +0 -83
  277. data/rbi/stripe/resources/account.rbi +0 -4926
  278. data/rbi/stripe/resources/account_link.rbi +0 -74
  279. data/rbi/stripe/resources/account_session.rbi +0 -1013
  280. data/rbi/stripe/resources/apple_pay_domain.rbi +0 -88
  281. data/rbi/stripe/resources/application.rbi +0 -20
  282. data/rbi/stripe/resources/application_fee.rbi +0 -118
  283. data/rbi/stripe/resources/application_fee_refund.rbi +0 -37
  284. data/rbi/stripe/resources/apps/secret.rbi +0 -195
  285. data/rbi/stripe/resources/balance.rbi +0 -235
  286. data/rbi/stripe/resources/balance_transaction.rbi +0 -147
  287. data/rbi/stripe/resources/bank_account.rbi +0 -127
  288. data/rbi/stripe/resources/billing/alert.rbi +0 -201
  289. data/rbi/stripe/resources/billing/alert_triggered.rbi +0 -28
  290. data/rbi/stripe/resources/billing/credit_balance_summary.rbi +0 -63
  291. data/rbi/stripe/resources/billing/credit_balance_transaction.rbi +0 -147
  292. data/rbi/stripe/resources/billing/credit_grant.rbi +0 -291
  293. data/rbi/stripe/resources/billing/meter.rbi +0 -226
  294. data/rbi/stripe/resources/billing/meter_event.rbi +0 -64
  295. data/rbi/stripe/resources/billing/meter_event_adjustment.rbi +0 -64
  296. data/rbi/stripe/resources/billing/meter_event_summary.rbi +0 -35
  297. data/rbi/stripe/resources/billing_portal/configuration.rbi +0 -645
  298. data/rbi/stripe/resources/billing_portal/session.rbi +0 -345
  299. data/rbi/stripe/resources/capability.rbi +0 -125
  300. data/rbi/stripe/resources/card.rbi +0 -125
  301. data/rbi/stripe/resources/cash_balance.rbi +0 -32
  302. data/rbi/stripe/resources/charge.rbi +0 -2069
  303. data/rbi/stripe/resources/checkout/session.rbi +0 -4004
  304. data/rbi/stripe/resources/climate/order.rbi +0 -245
  305. data/rbi/stripe/resources/climate/product.rbi +0 -75
  306. data/rbi/stripe/resources/climate/supplier.rbi +0 -72
  307. data/rbi/stripe/resources/confirmation_token.rbi +0 -1807
  308. data/rbi/stripe/resources/connect_collection_transfer.rbi +0 -26
  309. data/rbi/stripe/resources/country_spec.rbi +0 -85
  310. data/rbi/stripe/resources/coupon.rbi +0 -250
  311. data/rbi/stripe/resources/credit_note.rbi +0 -752
  312. data/rbi/stripe/resources/credit_note_line_item.rbi +0 -101
  313. data/rbi/stripe/resources/customer.rbi +0 -1005
  314. data/rbi/stripe/resources/customer_balance_transaction.rbi +0 -56
  315. data/rbi/stripe/resources/customer_cash_balance_transaction.rbi +0 -151
  316. data/rbi/stripe/resources/customer_session.rbi +0 -200
  317. data/rbi/stripe/resources/discount.rbi +0 -53
  318. data/rbi/stripe/resources/dispute.rbi +0 -761
  319. data/rbi/stripe/resources/entitlements/active_entitlement.rbi +0 -58
  320. data/rbi/stripe/resources/entitlements/active_entitlement_summary.rbi +0 -23
  321. data/rbi/stripe/resources/entitlements/feature.rbi +0 -117
  322. data/rbi/stripe/resources/ephemeral_key.rbi +0 -44
  323. data/rbi/stripe/resources/event.rbi +0 -149
  324. data/rbi/stripe/resources/exchange_rate.rbi +0 -66
  325. data/rbi/stripe/resources/file.rbi +0 -143
  326. data/rbi/stripe/resources/file_link.rbi +0 -141
  327. data/rbi/stripe/resources/financial_connections/account.rbi +0 -339
  328. data/rbi/stripe/resources/financial_connections/account_owner.rbi +0 -35
  329. data/rbi/stripe/resources/financial_connections/account_ownership.rbi +0 -23
  330. data/rbi/stripe/resources/financial_connections/session.rbi +0 -123
  331. data/rbi/stripe/resources/financial_connections/transaction.rbi +0 -124
  332. data/rbi/stripe/resources/forwarding/request.rbi +0 -216
  333. data/rbi/stripe/resources/funding_instructions.rbi +0 -437
  334. data/rbi/stripe/resources/identity/verification_report.rbi +0 -360
  335. data/rbi/stripe/resources/identity/verification_session.rbi +0 -526
  336. data/rbi/stripe/resources/invoice.rbi +0 -3812
  337. data/rbi/stripe/resources/invoice_item.rbi +0 -473
  338. data/rbi/stripe/resources/invoice_line_item.rbi +0 -432
  339. data/rbi/stripe/resources/invoice_payment.rbi +0 -121
  340. data/rbi/stripe/resources/invoice_rendering_template.rbi +0 -104
  341. data/rbi/stripe/resources/issuing/authorization.rbi +0 -1283
  342. data/rbi/stripe/resources/issuing/card.rbi +0 -741
  343. data/rbi/stripe/resources/issuing/cardholder.rbi +0 -744
  344. data/rbi/stripe/resources/issuing/dispute.rbi +0 -913
  345. data/rbi/stripe/resources/issuing/personalization_design.rbi +0 -338
  346. data/rbi/stripe/resources/issuing/physical_bundle.rbi +0 -79
  347. data/rbi/stripe/resources/issuing/token.rbi +0 -226
  348. data/rbi/stripe/resources/issuing/transaction.rbi +0 -1061
  349. data/rbi/stripe/resources/line_item.rbi +0 -72
  350. data/rbi/stripe/resources/login_link.rbi +0 -19
  351. data/rbi/stripe/resources/mandate.rbi +0 -187
  352. data/rbi/stripe/resources/payment_intent.rbi +0 -9647
  353. data/rbi/stripe/resources/payment_link.rbi +0 -1801
  354. data/rbi/stripe/resources/payment_method.rbi +0 -1761
  355. data/rbi/stripe/resources/payment_method_configuration.rbi +0 -3550
  356. data/rbi/stripe/resources/payment_method_domain.rbi +0 -228
  357. data/rbi/stripe/resources/payout.rbi +0 -300
  358. data/rbi/stripe/resources/person.rbi +0 -401
  359. data/rbi/stripe/resources/plan.rbi +0 -371
  360. data/rbi/stripe/resources/price.rbi +0 -694
  361. data/rbi/stripe/resources/product.rbi +0 -555
  362. data/rbi/stripe/resources/product_feature.rbi +0 -26
  363. data/rbi/stripe/resources/promotion_code.rbi +0 -261
  364. data/rbi/stripe/resources/quote.rbi +0 -1126
  365. data/rbi/stripe/resources/radar/early_fraud_warning.rbi +0 -98
  366. data/rbi/stripe/resources/radar/value_list.rbi +0 -168
  367. data/rbi/stripe/resources/radar/value_list_item.rbi +0 -129
  368. data/rbi/stripe/resources/refund.rbi +0 -523
  369. data/rbi/stripe/resources/reporting/report_run.rbi +0 -191
  370. data/rbi/stripe/resources/reporting/report_type.rbi +0 -57
  371. data/rbi/stripe/resources/reserve_transaction.rbi +0 -23
  372. data/rbi/stripe/resources/reversal.rbi +0 -51
  373. data/rbi/stripe/resources/review.rbi +0 -154
  374. data/rbi/stripe/resources/setup_attempt.rbi +0 -477
  375. data/rbi/stripe/resources/setup_intent.rbi +0 -3655
  376. data/rbi/stripe/resources/shipping_rate.rbi +0 -305
  377. data/rbi/stripe/resources/sigma/scheduled_query_run.rbi +0 -75
  378. data/rbi/stripe/resources/source.rbi +0 -1496
  379. data/rbi/stripe/resources/source_mandate_notification.rbi +0 -77
  380. data/rbi/stripe/resources/source_transaction.rbi +0 -127
  381. data/rbi/stripe/resources/subscription.rbi +0 -2027
  382. data/rbi/stripe/resources/subscription_item.rbi +0 -404
  383. data/rbi/stripe/resources/subscription_schedule.rbi +0 -1623
  384. data/rbi/stripe/resources/tax/calculation.rbi +0 -478
  385. data/rbi/stripe/resources/tax/calculation_line_item.rbi +0 -91
  386. data/rbi/stripe/resources/tax/registration.rbi +0 -2713
  387. data/rbi/stripe/resources/tax/settings.rbi +0 -141
  388. data/rbi/stripe/resources/tax/transaction.rbi +0 -351
  389. data/rbi/stripe/resources/tax/transaction_line_item.rbi +0 -54
  390. data/rbi/stripe/resources/tax_code.rbi +0 -44
  391. data/rbi/stripe/resources/tax_deducted_at_source.rbi +0 -23
  392. data/rbi/stripe/resources/tax_id.rbi +0 -165
  393. data/rbi/stripe/resources/tax_rate.rbi +0 -239
  394. data/rbi/stripe/resources/terminal/configuration.rbi +0 -1386
  395. data/rbi/stripe/resources/terminal/connection_token.rbi +0 -37
  396. data/rbi/stripe/resources/terminal/location.rbi +0 -222
  397. data/rbi/stripe/resources/terminal/reader.rbi +0 -847
  398. data/rbi/stripe/resources/test_helpers/test_clock.rbi +0 -132
  399. data/rbi/stripe/resources/token.rbi +0 -1283
  400. data/rbi/stripe/resources/topup.rbi +0 -222
  401. data/rbi/stripe/resources/transfer.rbi +0 -199
  402. data/rbi/stripe/resources/treasury/credit_reversal.rbi +0 -119
  403. data/rbi/stripe/resources/treasury/debit_reversal.rbi +0 -131
  404. data/rbi/stripe/resources/treasury/financial_account.rbi +0 -865
  405. data/rbi/stripe/resources/treasury/financial_account_features.rbi +0 -260
  406. data/rbi/stripe/resources/treasury/inbound_transfer.rbi +0 -295
  407. data/rbi/stripe/resources/treasury/outbound_payment.rbi +0 -592
  408. data/rbi/stripe/resources/treasury/outbound_transfer.rbi +0 -431
  409. data/rbi/stripe/resources/treasury/received_credit.rbi +0 -302
  410. data/rbi/stripe/resources/treasury/received_debit.rbi +0 -256
  411. data/rbi/stripe/resources/treasury/transaction.rbi +0 -215
  412. data/rbi/stripe/resources/treasury/transaction_entry.rbi +0 -192
  413. data/rbi/stripe/resources/v2/amount.rbi +0 -14
  414. data/rbi/stripe/resources/v2/billing/meter_event.rbi +0 -37
  415. data/rbi/stripe/resources/v2/billing/meter_event_adjustment.rbi +0 -41
  416. data/rbi/stripe/resources/v2/billing/meter_event_session.rbi +0 -31
  417. data/rbi/stripe/resources/v2/event.rbi +0 -48
  418. data/rbi/stripe/resources/v2/event_destination.rbi +0 -91
  419. data/rbi/stripe/resources/webhook_endpoint.rbi +0 -168
  420. data/rbi/stripe/services/account_capability_service.rbi +0 -51
  421. data/rbi/stripe/services/account_link_service.rbi +0 -58
  422. data/rbi/stripe/services/account_login_link_service.rbi +0 -22
  423. data/rbi/stripe/services/account_person_service.rbi +0 -1011
  424. data/rbi/stripe/services/account_service.rbi +0 -4213
  425. data/rbi/stripe/services/account_session_service.rbi +0 -646
  426. data/rbi/stripe/services/apple_pay_domain_service.rbi +0 -76
  427. data/rbi/stripe/services/application_fee_refund_service.rbi +0 -93
  428. data/rbi/stripe/services/application_fee_service.rbi +0 -78
  429. data/rbi/stripe/services/apps/secret_service.rbi +0 -151
  430. data/rbi/stripe/services/apps_service.rbi +0 -9
  431. data/rbi/stripe/services/balance_service.rbi +0 -21
  432. data/rbi/stripe/services/balance_transaction_service.rbi +0 -93
  433. data/rbi/stripe/services/billing/alert_service.rbi +0 -152
  434. data/rbi/stripe/services/billing/credit_balance_summary_service.rbi +0 -68
  435. data/rbi/stripe/services/billing/credit_balance_transaction_service.rbi +0 -59
  436. data/rbi/stripe/services/billing/credit_grant_service.rbi +0 -211
  437. data/rbi/stripe/services/billing/meter_event_adjustment_service.rbi +0 -42
  438. data/rbi/stripe/services/billing/meter_event_service.rbi +0 -42
  439. data/rbi/stripe/services/billing/meter_event_summary_service.rbi +0 -54
  440. data/rbi/stripe/services/billing/meter_service.rbi +0 -163
  441. data/rbi/stripe/services/billing_portal/configuration_service.rbi +0 -511
  442. data/rbi/stripe/services/billing_portal/session_service.rbi +0 -204
  443. data/rbi/stripe/services/billing_portal_service.rbi +0 -10
  444. data/rbi/stripe/services/billing_service.rbi +0 -15
  445. data/rbi/stripe/services/charge_service.rbi +0 -448
  446. data/rbi/stripe/services/checkout/session_line_item_service.rbi +0 -33
  447. data/rbi/stripe/services/checkout/session_service.rbi +0 -2614
  448. data/rbi/stripe/services/checkout_service.rbi +0 -9
  449. data/rbi/stripe/services/climate/order_service.rbi +0 -142
  450. data/rbi/stripe/services/climate/product_service.rbi +0 -46
  451. data/rbi/stripe/services/climate_service.rbi +0 -11
  452. data/rbi/stripe/services/confirmation_token_service.rbi +0 -20
  453. data/rbi/stripe/services/country_spec_service.rbi +0 -44
  454. data/rbi/stripe/services/coupon_service.rbi +0 -194
  455. data/rbi/stripe/services/credit_note_preview_lines_service.rbi +0 -167
  456. data/rbi/stripe/services/credit_note_service.rbi +0 -415
  457. data/rbi/stripe/services/customer_balance_transaction_service.rbi +0 -92
  458. data/rbi/stripe/services/customer_cash_balance_service.rbi +0 -45
  459. data/rbi/stripe/services/customer_cash_balance_transaction_service.rbi +0 -44
  460. data/rbi/stripe/services/customer_funding_instructions_service.rbi +0 -59
  461. data/rbi/stripe/services/customer_payment_method_service.rbi +0 -57
  462. data/rbi/stripe/services/customer_payment_source_service.rbi +0 -232
  463. data/rbi/stripe/services/customer_service.rbi +0 -647
  464. data/rbi/stripe/services/customer_session_service.rbi +0 -116
  465. data/rbi/stripe/services/customer_tax_id_service.rbi +0 -70
  466. data/rbi/stripe/services/dispute_service.rbi +0 -424
  467. data/rbi/stripe/services/entitlements/active_entitlement_service.rbi +0 -55
  468. data/rbi/stripe/services/entitlements/feature_service.rbi +0 -107
  469. data/rbi/stripe/services/entitlements_service.rbi +0 -10
  470. data/rbi/stripe/services/ephemeral_key_service.rbi +0 -53
  471. data/rbi/stripe/services/event_service.rbi +0 -83
  472. data/rbi/stripe/services/exchange_rate_service.rbi +0 -44
  473. data/rbi/stripe/services/file_link_service.rbi +0 -124
  474. data/rbi/stripe/services/file_service.rbi +0 -116
  475. data/rbi/stripe/services/financial_connections/account_owner_service.rbi +0 -42
  476. data/rbi/stripe/services/financial_connections/account_service.rbi +0 -133
  477. data/rbi/stripe/services/financial_connections/session_service.rbi +0 -88
  478. data/rbi/stripe/services/financial_connections/transaction_service.rbi +0 -92
  479. data/rbi/stripe/services/financial_connections_service.rbi +0 -11
  480. data/rbi/stripe/services/forwarding/request_service.rbi +0 -134
  481. data/rbi/stripe/services/forwarding_service.rbi +0 -9
  482. data/rbi/stripe/services/identity/verification_report_service.rbi +0 -87
  483. data/rbi/stripe/services/identity/verification_session_service.rbi +0 -323
  484. data/rbi/stripe/services/identity_service.rbi +0 -10
  485. data/rbi/stripe/services/invoice_item_service.rbi +0 -366
  486. data/rbi/stripe/services/invoice_line_item_service.rbi +0 -259
  487. data/rbi/stripe/services/invoice_payment_service.rbi +0 -71
  488. data/rbi/stripe/services/invoice_rendering_template_service.rbi +0 -82
  489. data/rbi/stripe/services/invoice_service.rbi +0 -2981
  490. data/rbi/stripe/services/issuing/authorization_service.rbi +0 -146
  491. data/rbi/stripe/services/issuing/card_service.rbi +0 -495
  492. data/rbi/stripe/services/issuing/cardholder_service.rbi +0 -587
  493. data/rbi/stripe/services/issuing/dispute_service.rbi +0 -707
  494. data/rbi/stripe/services/issuing/personalization_design_service.rbi +0 -243
  495. data/rbi/stripe/services/issuing/physical_bundle_service.rbi +0 -59
  496. data/rbi/stripe/services/issuing/token_service.rbi +0 -99
  497. data/rbi/stripe/services/issuing/transaction_service.rbi +0 -105
  498. data/rbi/stripe/services/issuing_service.rbi +0 -16
  499. data/rbi/stripe/services/mandate_service.rbi +0 -20
  500. data/rbi/stripe/services/payment_intent_service.rbi +0 -7659
  501. data/rbi/stripe/services/payment_link_service.rbi +0 -1352
  502. data/rbi/stripe/services/payment_method_configuration_service.rbi +0 -2487
  503. data/rbi/stripe/services/payment_method_domain_service.rbi +0 -112
  504. data/rbi/stripe/services/payment_method_service.rbi +0 -776
  505. data/rbi/stripe/services/payout_service.rbi +0 -205
  506. data/rbi/stripe/services/plan_service.rbi +0 -282
  507. data/rbi/stripe/services/price_service.rbi +0 -546
  508. data/rbi/stripe/services/product_feature_service.rbi +0 -67
  509. data/rbi/stripe/services/product_service.rbi +0 -477
  510. data/rbi/stripe/services/promotion_code_service.rbi +0 -214
  511. data/rbi/stripe/services/quote_computed_upfront_line_items_service.rbi +0 -31
  512. data/rbi/stripe/services/quote_service.rbi +0 -686
  513. data/rbi/stripe/services/radar/early_fraud_warning_service.rbi +0 -85
  514. data/rbi/stripe/services/radar/value_list_item_service.rbi +0 -109
  515. data/rbi/stripe/services/radar/value_list_service.rbi +0 -141
  516. data/rbi/stripe/services/radar_service.rbi +0 -11
  517. data/rbi/stripe/services/refund_service.rbi +0 -185
  518. data/rbi/stripe/services/reporting/report_run_service.rbi +0 -135
  519. data/rbi/stripe/services/reporting/report_type_service.rbi +0 -35
  520. data/rbi/stripe/services/reporting_service.rbi +0 -10
  521. data/rbi/stripe/services/review_service.rbi +0 -84
  522. data/rbi/stripe/services/setup_attempt_service.rbi +0 -65
  523. data/rbi/stripe/services/setup_intent_service.rbi +0 -3391
  524. data/rbi/stripe/services/shipping_rate_service.rbi +0 -241
  525. data/rbi/stripe/services/sigma/scheduled_query_run_service.rbi +0 -46
  526. data/rbi/stripe/services/sigma_service.rbi +0 -9
  527. data/rbi/stripe/services/source_service.rbi +0 -663
  528. data/rbi/stripe/services/subscription_item_service.rbi +0 -350
  529. data/rbi/stripe/services/subscription_schedule_service.rbi +0 -1290
  530. data/rbi/stripe/services/subscription_service.rbi +0 -1648
  531. data/rbi/stripe/services/tax/calculation_service.rbi +0 -234
  532. data/rbi/stripe/services/tax/registration_service.rbi +0 -1845
  533. data/rbi/stripe/services/tax/settings_service.rbi +0 -93
  534. data/rbi/stripe/services/tax/transaction_service.rbi +0 -146
  535. data/rbi/stripe/services/tax_code_service.rbi +0 -44
  536. data/rbi/stripe/services/tax_id_service.rbi +0 -110
  537. data/rbi/stripe/services/tax_rate_service.rbi +0 -185
  538. data/rbi/stripe/services/tax_service.rbi +0 -12
  539. data/rbi/stripe/services/terminal/configuration_service.rbi +0 -1118
  540. data/rbi/stripe/services/terminal/connection_token_service.rbi +0 -25
  541. data/rbi/stripe/services/terminal/location_service.rbi +0 -182
  542. data/rbi/stripe/services/terminal/reader_service.rbi +0 -455
  543. data/rbi/stripe/services/terminal_service.rbi +0 -12
  544. data/rbi/stripe/services/test_helpers/confirmation_token_service.rbi +0 -739
  545. data/rbi/stripe/services/test_helpers/customer_service.rbi +0 -33
  546. data/rbi/stripe/services/test_helpers/issuing/authorization_service.rbi +0 -848
  547. data/rbi/stripe/services/test_helpers/issuing/card_service.rbi +0 -76
  548. data/rbi/stripe/services/test_helpers/issuing/personalization_design_service.rbi +0 -69
  549. data/rbi/stripe/services/test_helpers/issuing/transaction_service.rbi +0 -711
  550. data/rbi/stripe/services/test_helpers/issuing_service.rbi +0 -14
  551. data/rbi/stripe/services/test_helpers/refund_service.rbi +0 -22
  552. data/rbi/stripe/services/test_helpers/terminal/reader_service.rbi +0 -93
  553. data/rbi/stripe/services/test_helpers/terminal_service.rbi +0 -11
  554. data/rbi/stripe/services/test_helpers/test_clock_service.rbi +0 -90
  555. data/rbi/stripe/services/test_helpers/treasury/inbound_transfer_service.rbi +0 -64
  556. data/rbi/stripe/services/test_helpers/treasury/outbound_payment_service.rbi +0 -125
  557. data/rbi/stripe/services/test_helpers/treasury/outbound_transfer_service.rbi +0 -125
  558. data/rbi/stripe/services/test_helpers/treasury/received_credit_service.rbi +0 -87
  559. data/rbi/stripe/services/test_helpers/treasury/received_debit_service.rbi +0 -87
  560. data/rbi/stripe/services/test_helpers/treasury_service.rbi +0 -15
  561. data/rbi/stripe/services/test_helpers_service.rbi +0 -15
  562. data/rbi/stripe/services/token_service.rbi +0 -1257
  563. data/rbi/stripe/services/topup_service.rbi +0 -176
  564. data/rbi/stripe/services/transfer_reversal_service.rbi +0 -101
  565. data/rbi/stripe/services/transfer_service.rbi +0 -152
  566. data/rbi/stripe/services/treasury/credit_reversal_service.rbi +0 -84
  567. data/rbi/stripe/services/treasury/debit_reversal_service.rbi +0 -88
  568. data/rbi/stripe/services/treasury/financial_account_features_service.rbi +0 -198
  569. data/rbi/stripe/services/treasury/financial_account_service.rbi +0 -562
  570. data/rbi/stripe/services/treasury/inbound_transfer_service.rbi +0 -117
  571. data/rbi/stripe/services/treasury/outbound_payment_service.rbi +0 -304
  572. data/rbi/stripe/services/treasury/outbound_transfer_service.rbi +0 -157
  573. data/rbi/stripe/services/treasury/received_credit_service.rbi +0 -72
  574. data/rbi/stripe/services/treasury/received_debit_service.rbi +0 -59
  575. data/rbi/stripe/services/treasury/transaction_entry_service.rbi +0 -111
  576. data/rbi/stripe/services/treasury/transaction_service.rbi +0 -122
  577. data/rbi/stripe/services/treasury_service.rbi +0 -18
  578. data/rbi/stripe/services/v1_services.rbi +0 -77
  579. data/rbi/stripe/services/v2/billing/meter_event_adjustment_service.rbi +0 -39
  580. data/rbi/stripe/services/v2/billing/meter_event_service.rbi +0 -42
  581. data/rbi/stripe/services/v2/billing/meter_event_session_service.rbi +0 -18
  582. data/rbi/stripe/services/v2/billing/meter_event_stream_service.rbi +0 -55
  583. data/rbi/stripe/services/v2/billing_service.rbi +0 -14
  584. data/rbi/stripe/services/v2/core/event_destination_service.rbi +0 -192
  585. data/rbi/stripe/services/v2/core/event_service.rbi +0 -36
  586. data/rbi/stripe/services/v2/core_service.rbi +0 -12
  587. data/rbi/stripe/services/v2_services.rbi +0 -10
  588. data/rbi/stripe/services/webhook_endpoint_service.rbi +0 -129
@@ -1,415 +0,0 @@
1
- # File generated from our OpenAPI spec
2
- # frozen_string_literal: true
3
-
4
- # typed: true
5
- module Stripe
6
- class CreditNoteService < StripeService
7
- attr_reader :line_items
8
- attr_reader :preview_lines
9
- class ListParams < Stripe::RequestParams
10
- class Created < Stripe::RequestParams
11
- # Minimum value to filter by (exclusive)
12
- sig { returns(T.nilable(Integer)) }
13
- attr_accessor :gt
14
- # Minimum value to filter by (inclusive)
15
- sig { returns(T.nilable(Integer)) }
16
- attr_accessor :gte
17
- # Maximum value to filter by (exclusive)
18
- sig { returns(T.nilable(Integer)) }
19
- attr_accessor :lt
20
- # Maximum value to filter by (inclusive)
21
- sig { returns(T.nilable(Integer)) }
22
- attr_accessor :lte
23
- sig {
24
- params(gt: T.nilable(Integer), gte: T.nilable(Integer), lt: T.nilable(Integer), lte: T.nilable(Integer)).void
25
- }
26
- def initialize(gt: nil, gte: nil, lt: nil, lte: nil); end
27
- end
28
- # Only return credit notes that were created during the given date interval.
29
- sig { returns(T.nilable(T.any(::Stripe::CreditNoteService::ListParams::Created, Integer))) }
30
- attr_accessor :created
31
- # Only return credit notes for the customer specified by this customer ID.
32
- sig { returns(T.nilable(String)) }
33
- attr_accessor :customer
34
- # 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.
35
- sig { returns(T.nilable(String)) }
36
- attr_accessor :ending_before
37
- # Specifies which fields in the response should be expanded.
38
- sig { returns(T.nilable(T::Array[String])) }
39
- attr_accessor :expand
40
- # Only return credit notes for the invoice specified by this invoice ID.
41
- sig { returns(T.nilable(String)) }
42
- attr_accessor :invoice
43
- # A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
44
- sig { returns(T.nilable(Integer)) }
45
- attr_accessor :limit
46
- # 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.
47
- sig { returns(T.nilable(String)) }
48
- attr_accessor :starting_after
49
- sig {
50
- params(created: T.nilable(T.any(::Stripe::CreditNoteService::ListParams::Created, Integer)), customer: T.nilable(String), ending_before: T.nilable(String), expand: T.nilable(T::Array[String]), invoice: T.nilable(String), limit: T.nilable(Integer), starting_after: T.nilable(String)).void
51
- }
52
- def initialize(
53
- created: nil,
54
- customer: nil,
55
- ending_before: nil,
56
- expand: nil,
57
- invoice: nil,
58
- limit: nil,
59
- starting_after: nil
60
- ); end
61
- end
62
- class CreateParams < Stripe::RequestParams
63
- class Line < Stripe::RequestParams
64
- class TaxAmount < Stripe::RequestParams
65
- # The amount, in cents (or local equivalent), of the tax.
66
- sig { returns(Integer) }
67
- attr_accessor :amount
68
- # The id of the tax rate for this tax amount. The tax rate must have been automatically created by Stripe.
69
- sig { returns(String) }
70
- attr_accessor :tax_rate
71
- # The amount on which tax is calculated, in cents (or local equivalent).
72
- sig { returns(Integer) }
73
- attr_accessor :taxable_amount
74
- sig { params(amount: Integer, tax_rate: String, taxable_amount: Integer).void }
75
- def initialize(amount: nil, tax_rate: nil, taxable_amount: nil); end
76
- end
77
- # The line item amount to credit. Only valid when `type` is `invoice_line_item`. If invoice is set up with `automatic_tax[enabled]=true`, this amount is tax exclusive
78
- sig { returns(T.nilable(Integer)) }
79
- attr_accessor :amount
80
- # The description of the credit note line item. Only valid when the `type` is `custom_line_item`.
81
- sig { returns(T.nilable(String)) }
82
- attr_accessor :description
83
- # The invoice line item to credit. Only valid when the `type` is `invoice_line_item`.
84
- sig { returns(T.nilable(String)) }
85
- attr_accessor :invoice_line_item
86
- # The line item quantity to credit.
87
- sig { returns(T.nilable(Integer)) }
88
- attr_accessor :quantity
89
- # A list of up to 10 tax amounts for the credit note line item. Cannot be mixed with `tax_rates`.
90
- sig {
91
- returns(T.nilable(T.nilable(T.any(String, T::Array[::Stripe::CreditNoteService::CreateParams::Line::TaxAmount]))))
92
- }
93
- attr_accessor :tax_amounts
94
- # The tax rates which apply to the credit note line item. Only valid when the `type` is `custom_line_item` and cannot be mixed with `tax_amounts`.
95
- sig { returns(T.nilable(T.nilable(T.any(String, T::Array[String])))) }
96
- attr_accessor :tax_rates
97
- # Type of the credit note line item, one of `invoice_line_item` or `custom_line_item`
98
- sig { returns(String) }
99
- attr_accessor :type
100
- # The integer unit amount in cents (or local equivalent) of the credit note line item. This `unit_amount` will be multiplied by the quantity to get the full amount to credit for this line item. Only valid when `type` is `custom_line_item`.
101
- sig { returns(T.nilable(Integer)) }
102
- attr_accessor :unit_amount
103
- # Same as `unit_amount`, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set.
104
- sig { returns(T.nilable(String)) }
105
- attr_accessor :unit_amount_decimal
106
- sig {
107
- params(amount: T.nilable(Integer), description: T.nilable(String), invoice_line_item: T.nilable(String), quantity: T.nilable(Integer), tax_amounts: T.nilable(T.nilable(T.any(String, T::Array[::Stripe::CreditNoteService::CreateParams::Line::TaxAmount]))), tax_rates: T.nilable(T.nilable(T.any(String, T::Array[String]))), type: String, unit_amount: T.nilable(Integer), unit_amount_decimal: T.nilable(String)).void
108
- }
109
- def initialize(
110
- amount: nil,
111
- description: nil,
112
- invoice_line_item: nil,
113
- quantity: nil,
114
- tax_amounts: nil,
115
- tax_rates: nil,
116
- type: nil,
117
- unit_amount: nil,
118
- unit_amount_decimal: nil
119
- ); end
120
- end
121
- class Refund < Stripe::RequestParams
122
- # Amount of the refund that applies to this credit note, in cents (or local equivalent). Defaults to the entire refund amount.
123
- sig { returns(T.nilable(Integer)) }
124
- attr_accessor :amount_refunded
125
- # ID of an existing refund to link this credit note to.
126
- sig { returns(T.nilable(String)) }
127
- attr_accessor :refund
128
- sig { params(amount_refunded: T.nilable(Integer), refund: T.nilable(String)).void }
129
- def initialize(amount_refunded: nil, refund: nil); end
130
- end
131
- class ShippingCost < Stripe::RequestParams
132
- # The ID of the shipping rate to use for this order.
133
- sig { returns(T.nilable(String)) }
134
- attr_accessor :shipping_rate
135
- sig { params(shipping_rate: T.nilable(String)).void }
136
- def initialize(shipping_rate: nil); end
137
- end
138
- # The integer amount in cents (or local equivalent) representing the total amount of the credit note.
139
- sig { returns(T.nilable(Integer)) }
140
- attr_accessor :amount
141
- # The integer amount in cents (or local equivalent) representing the amount to credit the customer's balance, which will be automatically applied to their next invoice.
142
- sig { returns(T.nilable(Integer)) }
143
- attr_accessor :credit_amount
144
- # The date when this credit note is in effect. Same as `created` unless overwritten. When defined, this value replaces the system-generated 'Date of issue' printed on the credit note PDF.
145
- sig { returns(T.nilable(Integer)) }
146
- attr_accessor :effective_at
147
- # Type of email to send to the customer, one of `credit_note` or `none` and the default is `credit_note`.
148
- sig { returns(T.nilable(String)) }
149
- attr_accessor :email_type
150
- # Specifies which fields in the response should be expanded.
151
- sig { returns(T.nilable(T::Array[String])) }
152
- attr_accessor :expand
153
- # ID of the invoice.
154
- sig { returns(String) }
155
- attr_accessor :invoice
156
- # Line items that make up the credit note.
157
- sig { returns(T.nilable(T::Array[::Stripe::CreditNoteService::CreateParams::Line])) }
158
- attr_accessor :lines
159
- # The credit note's memo appears on the credit note PDF.
160
- sig { returns(T.nilable(String)) }
161
- attr_accessor :memo
162
- # 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`.
163
- sig { returns(T.nilable(T::Hash[String, String])) }
164
- attr_accessor :metadata
165
- # The integer amount in cents (or local equivalent) representing the amount that is credited outside of Stripe.
166
- sig { returns(T.nilable(Integer)) }
167
- attr_accessor :out_of_band_amount
168
- # Reason for issuing this credit note, one of `duplicate`, `fraudulent`, `order_change`, or `product_unsatisfactory`
169
- sig { returns(T.nilable(String)) }
170
- attr_accessor :reason
171
- # The integer amount in cents (or local equivalent) representing the amount to refund. If set, a refund will be created for the charge associated with the invoice.
172
- sig { returns(T.nilable(Integer)) }
173
- attr_accessor :refund_amount
174
- # Refunds to link to this credit note.
175
- sig { returns(T.nilable(T::Array[::Stripe::CreditNoteService::CreateParams::Refund])) }
176
- attr_accessor :refunds
177
- # When shipping_cost contains the shipping_rate from the invoice, the shipping_cost is included in the credit note.
178
- sig { returns(T.nilable(::Stripe::CreditNoteService::CreateParams::ShippingCost)) }
179
- attr_accessor :shipping_cost
180
- sig {
181
- params(amount: T.nilable(Integer), credit_amount: T.nilable(Integer), effective_at: T.nilable(Integer), email_type: T.nilable(String), expand: T.nilable(T::Array[String]), invoice: String, lines: T.nilable(T::Array[::Stripe::CreditNoteService::CreateParams::Line]), memo: T.nilable(String), metadata: T.nilable(T::Hash[String, String]), out_of_band_amount: T.nilable(Integer), reason: T.nilable(String), refund_amount: T.nilable(Integer), refunds: T.nilable(T::Array[::Stripe::CreditNoteService::CreateParams::Refund]), shipping_cost: T.nilable(::Stripe::CreditNoteService::CreateParams::ShippingCost)).void
182
- }
183
- def initialize(
184
- amount: nil,
185
- credit_amount: nil,
186
- effective_at: nil,
187
- email_type: nil,
188
- expand: nil,
189
- invoice: nil,
190
- lines: nil,
191
- memo: nil,
192
- metadata: nil,
193
- out_of_band_amount: nil,
194
- reason: nil,
195
- refund_amount: nil,
196
- refunds: nil,
197
- shipping_cost: nil
198
- ); end
199
- end
200
- class RetrieveParams < Stripe::RequestParams
201
- # Specifies which fields in the response should be expanded.
202
- sig { returns(T.nilable(T::Array[String])) }
203
- attr_accessor :expand
204
- sig { params(expand: T.nilable(T::Array[String])).void }
205
- def initialize(expand: nil); end
206
- end
207
- class UpdateParams < Stripe::RequestParams
208
- # Specifies which fields in the response should be expanded.
209
- sig { returns(T.nilable(T::Array[String])) }
210
- attr_accessor :expand
211
- # Credit note memo.
212
- sig { returns(T.nilable(String)) }
213
- attr_accessor :memo
214
- # 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`.
215
- sig { returns(T.nilable(T::Hash[String, String])) }
216
- attr_accessor :metadata
217
- sig {
218
- params(expand: T.nilable(T::Array[String]), memo: T.nilable(String), metadata: T.nilable(T::Hash[String, String])).void
219
- }
220
- def initialize(expand: nil, memo: nil, metadata: nil); end
221
- end
222
- class PreviewParams < Stripe::RequestParams
223
- class Line < Stripe::RequestParams
224
- class TaxAmount < Stripe::RequestParams
225
- # The amount, in cents (or local equivalent), of the tax.
226
- sig { returns(Integer) }
227
- attr_accessor :amount
228
- # The id of the tax rate for this tax amount. The tax rate must have been automatically created by Stripe.
229
- sig { returns(String) }
230
- attr_accessor :tax_rate
231
- # The amount on which tax is calculated, in cents (or local equivalent).
232
- sig { returns(Integer) }
233
- attr_accessor :taxable_amount
234
- sig { params(amount: Integer, tax_rate: String, taxable_amount: Integer).void }
235
- def initialize(amount: nil, tax_rate: nil, taxable_amount: nil); end
236
- end
237
- # The line item amount to credit. Only valid when `type` is `invoice_line_item`. If invoice is set up with `automatic_tax[enabled]=true`, this amount is tax exclusive
238
- sig { returns(T.nilable(Integer)) }
239
- attr_accessor :amount
240
- # The description of the credit note line item. Only valid when the `type` is `custom_line_item`.
241
- sig { returns(T.nilable(String)) }
242
- attr_accessor :description
243
- # The invoice line item to credit. Only valid when the `type` is `invoice_line_item`.
244
- sig { returns(T.nilable(String)) }
245
- attr_accessor :invoice_line_item
246
- # The line item quantity to credit.
247
- sig { returns(T.nilable(Integer)) }
248
- attr_accessor :quantity
249
- # A list of up to 10 tax amounts for the credit note line item. Cannot be mixed with `tax_rates`.
250
- sig {
251
- returns(T.nilable(T.nilable(T.any(String, T::Array[::Stripe::CreditNoteService::PreviewParams::Line::TaxAmount]))))
252
- }
253
- attr_accessor :tax_amounts
254
- # The tax rates which apply to the credit note line item. Only valid when the `type` is `custom_line_item` and cannot be mixed with `tax_amounts`.
255
- sig { returns(T.nilable(T.nilable(T.any(String, T::Array[String])))) }
256
- attr_accessor :tax_rates
257
- # Type of the credit note line item, one of `invoice_line_item` or `custom_line_item`
258
- sig { returns(String) }
259
- attr_accessor :type
260
- # The integer unit amount in cents (or local equivalent) of the credit note line item. This `unit_amount` will be multiplied by the quantity to get the full amount to credit for this line item. Only valid when `type` is `custom_line_item`.
261
- sig { returns(T.nilable(Integer)) }
262
- attr_accessor :unit_amount
263
- # Same as `unit_amount`, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set.
264
- sig { returns(T.nilable(String)) }
265
- attr_accessor :unit_amount_decimal
266
- sig {
267
- params(amount: T.nilable(Integer), description: T.nilable(String), invoice_line_item: T.nilable(String), quantity: T.nilable(Integer), tax_amounts: T.nilable(T.nilable(T.any(String, T::Array[::Stripe::CreditNoteService::PreviewParams::Line::TaxAmount]))), tax_rates: T.nilable(T.nilable(T.any(String, T::Array[String]))), type: String, unit_amount: T.nilable(Integer), unit_amount_decimal: T.nilable(String)).void
268
- }
269
- def initialize(
270
- amount: nil,
271
- description: nil,
272
- invoice_line_item: nil,
273
- quantity: nil,
274
- tax_amounts: nil,
275
- tax_rates: nil,
276
- type: nil,
277
- unit_amount: nil,
278
- unit_amount_decimal: nil
279
- ); end
280
- end
281
- class Refund < Stripe::RequestParams
282
- # Amount of the refund that applies to this credit note, in cents (or local equivalent). Defaults to the entire refund amount.
283
- sig { returns(T.nilable(Integer)) }
284
- attr_accessor :amount_refunded
285
- # ID of an existing refund to link this credit note to.
286
- sig { returns(T.nilable(String)) }
287
- attr_accessor :refund
288
- sig { params(amount_refunded: T.nilable(Integer), refund: T.nilable(String)).void }
289
- def initialize(amount_refunded: nil, refund: nil); end
290
- end
291
- class ShippingCost < Stripe::RequestParams
292
- # The ID of the shipping rate to use for this order.
293
- sig { returns(T.nilable(String)) }
294
- attr_accessor :shipping_rate
295
- sig { params(shipping_rate: T.nilable(String)).void }
296
- def initialize(shipping_rate: nil); end
297
- end
298
- # The integer amount in cents (or local equivalent) representing the total amount of the credit note.
299
- sig { returns(T.nilable(Integer)) }
300
- attr_accessor :amount
301
- # The integer amount in cents (or local equivalent) representing the amount to credit the customer's balance, which will be automatically applied to their next invoice.
302
- sig { returns(T.nilable(Integer)) }
303
- attr_accessor :credit_amount
304
- # The date when this credit note is in effect. Same as `created` unless overwritten. When defined, this value replaces the system-generated 'Date of issue' printed on the credit note PDF.
305
- sig { returns(T.nilable(Integer)) }
306
- attr_accessor :effective_at
307
- # Type of email to send to the customer, one of `credit_note` or `none` and the default is `credit_note`.
308
- sig { returns(T.nilable(String)) }
309
- attr_accessor :email_type
310
- # Specifies which fields in the response should be expanded.
311
- sig { returns(T.nilable(T::Array[String])) }
312
- attr_accessor :expand
313
- # ID of the invoice.
314
- sig { returns(String) }
315
- attr_accessor :invoice
316
- # Line items that make up the credit note.
317
- sig { returns(T.nilable(T::Array[::Stripe::CreditNoteService::PreviewParams::Line])) }
318
- attr_accessor :lines
319
- # The credit note's memo appears on the credit note PDF.
320
- sig { returns(T.nilable(String)) }
321
- attr_accessor :memo
322
- # 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`.
323
- sig { returns(T.nilable(T::Hash[String, String])) }
324
- attr_accessor :metadata
325
- # The integer amount in cents (or local equivalent) representing the amount that is credited outside of Stripe.
326
- sig { returns(T.nilable(Integer)) }
327
- attr_accessor :out_of_band_amount
328
- # Reason for issuing this credit note, one of `duplicate`, `fraudulent`, `order_change`, or `product_unsatisfactory`
329
- sig { returns(T.nilable(String)) }
330
- attr_accessor :reason
331
- # The integer amount in cents (or local equivalent) representing the amount to refund. If set, a refund will be created for the charge associated with the invoice.
332
- sig { returns(T.nilable(Integer)) }
333
- attr_accessor :refund_amount
334
- # Refunds to link to this credit note.
335
- sig { returns(T.nilable(T::Array[::Stripe::CreditNoteService::PreviewParams::Refund])) }
336
- attr_accessor :refunds
337
- # When shipping_cost contains the shipping_rate from the invoice, the shipping_cost is included in the credit note.
338
- sig { returns(T.nilable(::Stripe::CreditNoteService::PreviewParams::ShippingCost)) }
339
- attr_accessor :shipping_cost
340
- sig {
341
- params(amount: T.nilable(Integer), credit_amount: T.nilable(Integer), effective_at: T.nilable(Integer), email_type: T.nilable(String), expand: T.nilable(T::Array[String]), invoice: String, lines: T.nilable(T::Array[::Stripe::CreditNoteService::PreviewParams::Line]), memo: T.nilable(String), metadata: T.nilable(T::Hash[String, String]), out_of_band_amount: T.nilable(Integer), reason: T.nilable(String), refund_amount: T.nilable(Integer), refunds: T.nilable(T::Array[::Stripe::CreditNoteService::PreviewParams::Refund]), shipping_cost: T.nilable(::Stripe::CreditNoteService::PreviewParams::ShippingCost)).void
342
- }
343
- def initialize(
344
- amount: nil,
345
- credit_amount: nil,
346
- effective_at: nil,
347
- email_type: nil,
348
- expand: nil,
349
- invoice: nil,
350
- lines: nil,
351
- memo: nil,
352
- metadata: nil,
353
- out_of_band_amount: nil,
354
- reason: nil,
355
- refund_amount: nil,
356
- refunds: nil,
357
- shipping_cost: nil
358
- ); end
359
- end
360
- class VoidCreditNoteParams < Stripe::RequestParams
361
- # Specifies which fields in the response should be expanded.
362
- sig { returns(T.nilable(T::Array[String])) }
363
- attr_accessor :expand
364
- sig { params(expand: T.nilable(T::Array[String])).void }
365
- def initialize(expand: nil); end
366
- end
367
- # Issue a credit note to adjust the amount of a finalized invoice. A credit note will first reduce the invoice's amount_remaining (and amount_due), but not below zero.
368
- # This amount is indicated by the credit note's pre_payment_amount. The excess amount is indicated by post_payment_amount, and it can result in any combination of the following:
369
- #
370
- #
371
- # Refunds: create a new refund (using refund_amount) or link existing refunds (using refunds).
372
- # Customer balance credit: credit the customer's balance (using credit_amount) which will be automatically applied to their next invoice when it's finalized.
373
- # Outside of Stripe credit: record the amount that is or will be credited outside of Stripe (using out_of_band_amount).
374
- #
375
- #
376
- # The sum of refunds, customer balance credits, and outside of Stripe credits must equal the post_payment_amount.
377
- #
378
- # You may issue multiple credit notes for an invoice. Each credit note may increment the invoice's pre_payment_credit_notes_amount,
379
- # post_payment_credit_notes_amount, or both, depending on the invoice's amount_remaining at the time of credit note creation.
380
- sig {
381
- params(params: T.any(::Stripe::CreditNoteService::CreateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::CreditNote)
382
- }
383
- def create(params = {}, opts = {}); end
384
-
385
- # Returns a list of credit notes.
386
- sig {
387
- params(params: T.any(::Stripe::CreditNoteService::ListParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::ListObject)
388
- }
389
- def list(params = {}, opts = {}); end
390
-
391
- # Get a preview of a credit note without creating it.
392
- sig {
393
- params(params: T.any(::Stripe::CreditNoteService::PreviewParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::CreditNote)
394
- }
395
- def preview(params = {}, opts = {}); end
396
-
397
- # Retrieves the credit note object with the given identifier.
398
- sig {
399
- params(id: String, params: T.any(::Stripe::CreditNoteService::RetrieveParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::CreditNote)
400
- }
401
- def retrieve(id, params = {}, opts = {}); end
402
-
403
- # Updates an existing credit note.
404
- sig {
405
- params(id: String, params: T.any(::Stripe::CreditNoteService::UpdateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::CreditNote)
406
- }
407
- def update(id, params = {}, opts = {}); end
408
-
409
- # Marks a credit note as void. Learn more about [voiding credit notes](https://docs.stripe.com/docs/billing/invoices/credit-notes#voiding).
410
- sig {
411
- params(id: String, params: T.any(::Stripe::CreditNoteService::VoidCreditNoteParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::CreditNote)
412
- }
413
- def void_credit_note(id, params = {}, opts = {}); end
414
- end
415
- end
@@ -1,92 +0,0 @@
1
- # File generated from our OpenAPI spec
2
- # frozen_string_literal: true
3
-
4
- # typed: true
5
- module Stripe
6
- class CustomerBalanceTransactionService < StripeService
7
- class ListParams < Stripe::RequestParams
8
- # 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.
9
- sig { returns(T.nilable(String)) }
10
- attr_accessor :ending_before
11
- # Specifies which fields in the response should be expanded.
12
- sig { returns(T.nilable(T::Array[String])) }
13
- attr_accessor :expand
14
- # A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
15
- sig { returns(T.nilable(Integer)) }
16
- attr_accessor :limit
17
- # 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.
18
- sig { returns(T.nilable(String)) }
19
- attr_accessor :starting_after
20
- sig {
21
- params(ending_before: T.nilable(String), expand: T.nilable(T::Array[String]), limit: T.nilable(Integer), starting_after: T.nilable(String)).void
22
- }
23
- def initialize(ending_before: nil, expand: nil, limit: nil, starting_after: nil); end
24
- end
25
- class CreateParams < Stripe::RequestParams
26
- # The integer amount in **cents (or local equivalent)** to apply to the customer's credit balance.
27
- sig { returns(Integer) }
28
- attr_accessor :amount
29
- # 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). Specifies the [`invoice_credit_balance`](https://stripe.com/docs/api/customers/object#customer_object-invoice_credit_balance) that this transaction will apply to. If the customer's `currency` is not set, it will be updated to this value.
30
- sig { returns(String) }
31
- attr_accessor :currency
32
- # An arbitrary string attached to the object. Often useful for displaying to users.
33
- sig { returns(T.nilable(String)) }
34
- attr_accessor :description
35
- # Specifies which fields in the response should be expanded.
36
- sig { returns(T.nilable(T::Array[String])) }
37
- attr_accessor :expand
38
- # 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`.
39
- sig { returns(T.nilable(T.nilable(T.any(String, T::Hash[String, String])))) }
40
- attr_accessor :metadata
41
- sig {
42
- params(amount: Integer, currency: String, description: T.nilable(String), expand: T.nilable(T::Array[String]), metadata: T.nilable(T.nilable(T.any(String, T::Hash[String, String])))).void
43
- }
44
- def initialize(amount: nil, currency: nil, description: nil, expand: nil, metadata: nil); end
45
- end
46
- class RetrieveParams < Stripe::RequestParams
47
- # Specifies which fields in the response should be expanded.
48
- sig { returns(T.nilable(T::Array[String])) }
49
- attr_accessor :expand
50
- sig { params(expand: T.nilable(T::Array[String])).void }
51
- def initialize(expand: nil); end
52
- end
53
- class UpdateParams < Stripe::RequestParams
54
- # An arbitrary string attached to the object. Often useful for displaying to users.
55
- sig { returns(T.nilable(String)) }
56
- attr_accessor :description
57
- # Specifies which fields in the response should be expanded.
58
- sig { returns(T.nilable(T::Array[String])) }
59
- attr_accessor :expand
60
- # 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`.
61
- sig { returns(T.nilable(T.nilable(T.any(String, T::Hash[String, String])))) }
62
- attr_accessor :metadata
63
- sig {
64
- params(description: T.nilable(String), expand: T.nilable(T::Array[String]), metadata: T.nilable(T.nilable(T.any(String, T::Hash[String, String])))).void
65
- }
66
- def initialize(description: nil, expand: nil, metadata: nil); end
67
- end
68
- # Creates an immutable transaction that updates the customer's credit [balance](https://docs.stripe.com/docs/billing/customer/balance).
69
- sig {
70
- params(customer: String, params: T.any(::Stripe::CustomerBalanceTransactionService::CreateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::CustomerBalanceTransaction)
71
- }
72
- def create(customer, params = {}, opts = {}); end
73
-
74
- # Returns a list of transactions that updated the customer's [balances](https://docs.stripe.com/docs/billing/customer/balance).
75
- sig {
76
- params(customer: String, params: T.any(::Stripe::CustomerBalanceTransactionService::ListParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::ListObject)
77
- }
78
- def list(customer, params = {}, opts = {}); end
79
-
80
- # Retrieves a specific customer balance transaction that updated the customer's [balances](https://docs.stripe.com/docs/billing/customer/balance).
81
- sig {
82
- params(customer: String, transaction: String, params: T.any(::Stripe::CustomerBalanceTransactionService::RetrieveParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::CustomerBalanceTransaction)
83
- }
84
- def retrieve(customer, transaction, params = {}, opts = {}); end
85
-
86
- # Most credit balance transaction fields are immutable, but you may update its description and metadata.
87
- sig {
88
- params(customer: String, transaction: String, params: T.any(::Stripe::CustomerBalanceTransactionService::UpdateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::CustomerBalanceTransaction)
89
- }
90
- def update(customer, transaction, params = {}, opts = {}); end
91
- end
92
- end
@@ -1,45 +0,0 @@
1
- # File generated from our OpenAPI spec
2
- # frozen_string_literal: true
3
-
4
- # typed: true
5
- module Stripe
6
- class CustomerCashBalanceService < StripeService
7
- class RetrieveParams < Stripe::RequestParams
8
- # Specifies which fields in the response should be expanded.
9
- sig { returns(T.nilable(T::Array[String])) }
10
- attr_accessor :expand
11
- sig { params(expand: T.nilable(T::Array[String])).void }
12
- def initialize(expand: nil); end
13
- end
14
- class UpdateParams < Stripe::RequestParams
15
- class Settings < Stripe::RequestParams
16
- # Controls how funds transferred by the customer are applied to payment intents and invoices. Valid options are `automatic`, `manual`, or `merchant_default`. For more information about these reconciliation modes, see [Reconciliation](https://stripe.com/docs/payments/customer-balance/reconciliation).
17
- sig { returns(T.nilable(String)) }
18
- attr_accessor :reconciliation_mode
19
- sig { params(reconciliation_mode: T.nilable(String)).void }
20
- def initialize(reconciliation_mode: nil); end
21
- end
22
- # Specifies which fields in the response should be expanded.
23
- sig { returns(T.nilable(T::Array[String])) }
24
- attr_accessor :expand
25
- # A hash of settings for this cash balance.
26
- sig { returns(T.nilable(::Stripe::CustomerCashBalanceService::UpdateParams::Settings)) }
27
- attr_accessor :settings
28
- sig {
29
- params(expand: T.nilable(T::Array[String]), settings: T.nilable(::Stripe::CustomerCashBalanceService::UpdateParams::Settings)).void
30
- }
31
- def initialize(expand: nil, settings: nil); end
32
- end
33
- # Retrieves a customer's cash balance.
34
- sig {
35
- params(customer: String, params: T.any(::Stripe::CustomerCashBalanceService::RetrieveParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::CashBalance)
36
- }
37
- def retrieve(customer, params = {}, opts = {}); end
38
-
39
- # Changes the settings on a customer's cash balance.
40
- sig {
41
- params(customer: String, params: T.any(::Stripe::CustomerCashBalanceService::UpdateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::CashBalance)
42
- }
43
- def update(customer, params = {}, opts = {}); end
44
- end
45
- end
@@ -1,44 +0,0 @@
1
- # File generated from our OpenAPI spec
2
- # frozen_string_literal: true
3
-
4
- # typed: true
5
- module Stripe
6
- class CustomerCashBalanceTransactionService < StripeService
7
- class ListParams < Stripe::RequestParams
8
- # 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.
9
- sig { returns(T.nilable(String)) }
10
- attr_accessor :ending_before
11
- # Specifies which fields in the response should be expanded.
12
- sig { returns(T.nilable(T::Array[String])) }
13
- attr_accessor :expand
14
- # A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
15
- sig { returns(T.nilable(Integer)) }
16
- attr_accessor :limit
17
- # 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.
18
- sig { returns(T.nilable(String)) }
19
- attr_accessor :starting_after
20
- sig {
21
- params(ending_before: T.nilable(String), expand: T.nilable(T::Array[String]), limit: T.nilable(Integer), starting_after: T.nilable(String)).void
22
- }
23
- def initialize(ending_before: nil, expand: nil, limit: nil, starting_after: nil); end
24
- end
25
- class RetrieveParams < Stripe::RequestParams
26
- # Specifies which fields in the response should be expanded.
27
- sig { returns(T.nilable(T::Array[String])) }
28
- attr_accessor :expand
29
- sig { params(expand: T.nilable(T::Array[String])).void }
30
- def initialize(expand: nil); end
31
- end
32
- # Returns a list of transactions that modified the customer's [cash balance](https://docs.stripe.com/docs/payments/customer-balance).
33
- sig {
34
- params(customer: String, params: T.any(::Stripe::CustomerCashBalanceTransactionService::ListParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::ListObject)
35
- }
36
- def list(customer, params = {}, opts = {}); end
37
-
38
- # Retrieves a specific cash balance transaction, which updated the customer's [cash balance](https://docs.stripe.com/docs/payments/customer-balance).
39
- sig {
40
- params(customer: String, transaction: String, params: T.any(::Stripe::CustomerCashBalanceTransactionService::RetrieveParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::CustomerCashBalanceTransaction)
41
- }
42
- def retrieve(customer, transaction, params = {}, opts = {}); end
43
- end
44
- end
@@ -1,59 +0,0 @@
1
- # File generated from our OpenAPI spec
2
- # frozen_string_literal: true
3
-
4
- # typed: true
5
- module Stripe
6
- class CustomerFundingInstructionsService < StripeService
7
- class CreateParams < Stripe::RequestParams
8
- class BankTransfer < Stripe::RequestParams
9
- class EuBankTransfer < Stripe::RequestParams
10
- # The desired country code of the bank account information. Permitted values include: `BE`, `DE`, `ES`, `FR`, `IE`, or `NL`.
11
- sig { returns(String) }
12
- attr_accessor :country
13
- sig { params(country: String).void }
14
- def initialize(country: nil); end
15
- end
16
- # Configuration for eu_bank_transfer funding type.
17
- sig {
18
- returns(T.nilable(::Stripe::CustomerFundingInstructionsService::CreateParams::BankTransfer::EuBankTransfer))
19
- }
20
- attr_accessor :eu_bank_transfer
21
- # List of address types that should be returned in the financial_addresses response. If not specified, all valid types will be returned.
22
- #
23
- # Permitted values include: `sort_code`, `zengin`, `iban`, or `spei`.
24
- sig { returns(T.nilable(T::Array[String])) }
25
- attr_accessor :requested_address_types
26
- # The type of the `bank_transfer`
27
- sig { returns(String) }
28
- attr_accessor :type
29
- sig {
30
- params(eu_bank_transfer: T.nilable(::Stripe::CustomerFundingInstructionsService::CreateParams::BankTransfer::EuBankTransfer), requested_address_types: T.nilable(T::Array[String]), type: String).void
31
- }
32
- def initialize(eu_bank_transfer: nil, requested_address_types: nil, type: nil); end
33
- end
34
- # Additional parameters for `bank_transfer` funding types
35
- sig { returns(::Stripe::CustomerFundingInstructionsService::CreateParams::BankTransfer) }
36
- attr_accessor :bank_transfer
37
- # 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).
38
- sig { returns(String) }
39
- attr_accessor :currency
40
- # Specifies which fields in the response should be expanded.
41
- sig { returns(T.nilable(T::Array[String])) }
42
- attr_accessor :expand
43
- # The `funding_type` to get the instructions for.
44
- sig { returns(String) }
45
- attr_accessor :funding_type
46
- sig {
47
- params(bank_transfer: ::Stripe::CustomerFundingInstructionsService::CreateParams::BankTransfer, currency: String, expand: T.nilable(T::Array[String]), funding_type: String).void
48
- }
49
- def initialize(bank_transfer: nil, currency: nil, expand: nil, funding_type: nil); end
50
- end
51
- # Retrieve funding instructions for a customer cash balance. If funding instructions do not yet exist for the customer, new
52
- # funding instructions will be created. If funding instructions have already been created for a given customer, the same
53
- # funding instructions will be retrieved. In other words, we will return the same funding instructions each time.
54
- sig {
55
- params(customer: String, params: T.any(::Stripe::CustomerFundingInstructionsService::CreateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::FundingInstructions)
56
- }
57
- def create(customer, params = {}, opts = {}); end
58
- end
59
- end