stripe 15.3.0 → 15.4.0.pre.beta.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (591) hide show
  1. checksums.yaml +4 -4
  2. data/API_VERSION +1 -1
  3. data/CHANGELOG.md +1603 -667
  4. data/README.md +1 -1
  5. data/VERSION +1 -1
  6. data/lib/stripe/api_requestor.rb +32 -0
  7. data/lib/stripe/api_version.rb +1 -2
  8. data/lib/stripe/errors.rb +60 -0
  9. data/lib/stripe/event_types.rb +102 -0
  10. data/lib/stripe/events/v2_core_account_closed_event.rb +21 -0
  11. data/lib/stripe/events/v2_core_account_created_event.rb +21 -0
  12. data/lib/stripe/events/v2_core_account_including_configuration_customer_capability_status_updated_event.rb +23 -0
  13. data/lib/stripe/events/v2_core_account_including_configuration_customer_updated_event.rb +21 -0
  14. data/lib/stripe/events/v2_core_account_including_configuration_merchant_capability_status_updated_event.rb +23 -0
  15. data/lib/stripe/events/v2_core_account_including_configuration_merchant_updated_event.rb +21 -0
  16. data/lib/stripe/events/v2_core_account_including_configuration_recipient_capability_status_updated_event.rb +23 -0
  17. data/lib/stripe/events/v2_core_account_including_configuration_recipient_updated_event.rb +21 -0
  18. data/lib/stripe/events/v2_core_account_including_configuration_storer_capability_status_updated_event.rb +23 -0
  19. data/lib/stripe/events/v2_core_account_including_configuration_storer_updated_event.rb +21 -0
  20. data/lib/stripe/events/v2_core_account_including_defaults_updated_event.rb +21 -0
  21. data/lib/stripe/events/v2_core_account_including_identity_updated_event.rb +21 -0
  22. data/lib/stripe/events/v2_core_account_including_requirements_updated_event.rb +21 -0
  23. data/lib/stripe/events/v2_core_account_link_completed_event.rb +13 -0
  24. data/lib/stripe/events/v2_core_account_person_created_event.rb +23 -0
  25. data/lib/stripe/events/v2_core_account_person_deleted_event.rb +23 -0
  26. data/lib/stripe/events/v2_core_account_person_updated_event.rb +23 -0
  27. data/lib/stripe/events/v2_core_account_updated_event.rb +21 -0
  28. data/lib/stripe/events/v2_money_management_adjustment_created_event.rb +21 -0
  29. data/lib/stripe/events/v2_money_management_financial_account_created_event.rb +21 -0
  30. data/lib/stripe/events/v2_money_management_financial_account_updated_event.rb +21 -0
  31. data/lib/stripe/events/v2_money_management_financial_address_activated_event.rb +21 -0
  32. data/lib/stripe/events/v2_money_management_financial_address_failed_event.rb +21 -0
  33. data/lib/stripe/events/v2_money_management_inbound_transfer_available_event.rb +23 -0
  34. data/lib/stripe/events/v2_money_management_inbound_transfer_bank_debit_failed_event.rb +21 -0
  35. data/lib/stripe/events/v2_money_management_inbound_transfer_bank_debit_processing_event.rb +21 -0
  36. data/lib/stripe/events/v2_money_management_inbound_transfer_bank_debit_queued_event.rb +21 -0
  37. data/lib/stripe/events/v2_money_management_inbound_transfer_bank_debit_returned_event.rb +21 -0
  38. data/lib/stripe/events/v2_money_management_inbound_transfer_bank_debit_succeeded_event.rb +21 -0
  39. data/lib/stripe/events/v2_money_management_outbound_payment_canceled_event.rb +21 -0
  40. data/lib/stripe/events/v2_money_management_outbound_payment_created_event.rb +21 -0
  41. data/lib/stripe/events/v2_money_management_outbound_payment_failed_event.rb +21 -0
  42. data/lib/stripe/events/v2_money_management_outbound_payment_posted_event.rb +21 -0
  43. data/lib/stripe/events/v2_money_management_outbound_payment_returned_event.rb +21 -0
  44. data/lib/stripe/events/v2_money_management_outbound_payment_updated_event.rb +21 -0
  45. data/lib/stripe/events/v2_money_management_outbound_transfer_canceled_event.rb +21 -0
  46. data/lib/stripe/events/v2_money_management_outbound_transfer_created_event.rb +21 -0
  47. data/lib/stripe/events/v2_money_management_outbound_transfer_failed_event.rb +21 -0
  48. data/lib/stripe/events/v2_money_management_outbound_transfer_posted_event.rb +21 -0
  49. data/lib/stripe/events/v2_money_management_outbound_transfer_returned_event.rb +21 -0
  50. data/lib/stripe/events/v2_money_management_outbound_transfer_updated_event.rb +21 -0
  51. data/lib/stripe/events/v2_money_management_received_credit_available_event.rb +23 -0
  52. data/lib/stripe/events/v2_money_management_received_credit_failed_event.rb +21 -0
  53. data/lib/stripe/events/v2_money_management_received_credit_returned_event.rb +21 -0
  54. data/lib/stripe/events/v2_money_management_received_credit_succeeded_event.rb +21 -0
  55. data/lib/stripe/events/v2_money_management_received_debit_canceled_event.rb +21 -0
  56. data/lib/stripe/events/v2_money_management_received_debit_failed_event.rb +21 -0
  57. data/lib/stripe/events/v2_money_management_received_debit_pending_event.rb +21 -0
  58. data/lib/stripe/events/v2_money_management_received_debit_succeeded_event.rb +21 -0
  59. data/lib/stripe/events/v2_money_management_received_debit_updated_event.rb +21 -0
  60. data/lib/stripe/events/v2_money_management_transaction_created_event.rb +21 -0
  61. data/lib/stripe/events/v2_money_management_transaction_updated_event.rb +21 -0
  62. data/lib/stripe/events/v2_off_session_payment_requires_capture_event.rb +21 -0
  63. data/lib/stripe/events/v2_payments_off_session_payment_authorization_attempt_failed_event.rb +21 -0
  64. data/lib/stripe/events/v2_payments_off_session_payment_authorization_attempt_started_event.rb +21 -0
  65. data/lib/stripe/events/v2_payments_off_session_payment_canceled_event.rb +21 -0
  66. data/lib/stripe/events/v2_payments_off_session_payment_created_event.rb +21 -0
  67. data/lib/stripe/events/v2_payments_off_session_payment_failed_event.rb +21 -0
  68. data/lib/stripe/events/v2_payments_off_session_payment_succeeded_event.rb +21 -0
  69. data/lib/stripe/object_types.rb +50 -0
  70. data/lib/stripe/resources/account.rb +653 -1
  71. data/lib/stripe/resources/account_notice.rb +123 -0
  72. data/lib/stripe/resources/account_session.rb +256 -1
  73. data/lib/stripe/resources/balance_settings.rb +105 -0
  74. data/lib/stripe/resources/billing/credit_balance_summary.rb +2 -0
  75. data/lib/stripe/resources/billing/credit_balance_transaction.rb +4 -0
  76. data/lib/stripe/resources/billing/credit_grant.rb +10 -0
  77. data/lib/stripe/resources/billing_portal/session.rb +6 -0
  78. data/lib/stripe/resources/capital/financing_offer.rb +179 -0
  79. data/lib/stripe/resources/capital/financing_summary.rb +55 -0
  80. data/lib/stripe/resources/capital/financing_transaction.rb +114 -0
  81. data/lib/stripe/resources/card.rb +2 -0
  82. data/lib/stripe/resources/cash_balance.rb +2 -0
  83. data/lib/stripe/resources/charge.rb +1538 -0
  84. data/lib/stripe/resources/checkout/session.rb +326 -2
  85. data/lib/stripe/resources/confirmation_token.rb +170 -0
  86. data/lib/stripe/resources/coupon.rb +30 -1
  87. data/lib/stripe/resources/credit_note.rb +6 -0
  88. data/lib/stripe/resources/credit_note_line_item.rb +9 -0
  89. data/lib/stripe/resources/customer.rb +2 -0
  90. data/lib/stripe/resources/customer_balance_transaction.rb +2 -0
  91. data/lib/stripe/resources/customer_cash_balance_transaction.rb +2 -0
  92. data/lib/stripe/resources/customer_session.rb +6 -1
  93. data/lib/stripe/resources/discount.rb +2 -0
  94. data/lib/stripe/resources/dispute.rb +2 -0
  95. data/lib/stripe/resources/event.rb +31 -0
  96. data/lib/stripe/resources/financial_connections/account.rb +22 -1
  97. data/lib/stripe/resources/financial_connections/account_inferred_balance.rb +27 -0
  98. data/lib/stripe/resources/financial_connections/institution.rb +92 -0
  99. data/lib/stripe/resources/financial_connections/session.rb +62 -2
  100. data/lib/stripe/resources/fx_quote.rb +184 -0
  101. data/lib/stripe/resources/identity/verification_session.rb +10 -0
  102. data/lib/stripe/resources/invoice.rb +1063 -16
  103. data/lib/stripe/resources/invoice_item.rb +78 -2
  104. data/lib/stripe/resources/invoice_line_item.rb +55 -1
  105. data/lib/stripe/resources/invoice_payment.rb +2 -53
  106. data/lib/stripe/resources/issuing/cardholder.rb +2 -1
  107. data/lib/stripe/resources/issuing/credit_underwriting_record.rb +602 -0
  108. data/lib/stripe/resources/issuing/dispute_settlement_detail.rb +82 -0
  109. data/lib/stripe/resources/issuing/fraud_liability_debit.rb +86 -0
  110. data/lib/stripe/resources/issuing/settlement.rb +53 -0
  111. data/lib/stripe/resources/issuing/transaction.rb +6 -0
  112. data/lib/stripe/resources/line_item.rb +37 -0
  113. data/lib/stripe/resources/mandate.rb +24 -0
  114. data/lib/stripe/resources/margin.rb +115 -0
  115. data/lib/stripe/resources/order.rb +2958 -0
  116. data/lib/stripe/resources/payment_attempt_record.rb +1099 -0
  117. data/lib/stripe/resources/payment_intent.rb +8540 -3584
  118. data/lib/stripe/resources/payment_intent_amount_details_line_item.rb +72 -0
  119. data/lib/stripe/resources/payment_method.rb +192 -1
  120. data/lib/stripe/resources/payment_method_configuration.rb +295 -0
  121. data/lib/stripe/resources/payment_record.rb +1628 -0
  122. data/lib/stripe/resources/payout.rb +6 -0
  123. data/lib/stripe/resources/price.rb +30 -0
  124. data/lib/stripe/resources/privacy/redaction_job.rb +298 -0
  125. data/lib/stripe/resources/privacy/redaction_job_validation_error.rb +33 -0
  126. data/lib/stripe/resources/promotion_code.rb +10 -0
  127. data/lib/stripe/resources/quote.rb +2038 -7
  128. data/lib/stripe/resources/quote_line.rb +274 -0
  129. data/lib/stripe/resources/quote_preview_invoice.rb +663 -0
  130. data/lib/stripe/resources/quote_preview_subscription_schedule.rb +371 -0
  131. data/lib/stripe/resources/refund.rb +9 -0
  132. data/lib/stripe/resources/setup_attempt.rb +21 -0
  133. data/lib/stripe/resources/setup_intent.rb +578 -9
  134. data/lib/stripe/resources/source.rb +29 -0
  135. data/lib/stripe/resources/subscription.rb +288 -9
  136. data/lib/stripe/resources/subscription_item.rb +84 -3
  137. data/lib/stripe/resources/subscription_schedule.rb +1007 -10
  138. data/lib/stripe/resources/tax/association.rb +66 -0
  139. data/lib/stripe/resources/tax/form.rb +211 -0
  140. data/lib/stripe/resources/tax_id.rb +12 -2
  141. data/lib/stripe/resources/terminal/reader.rb +8 -0
  142. data/lib/stripe/resources/terminal/reader_collected_data.rb +31 -0
  143. data/lib/stripe/resources/transfer.rb +6 -0
  144. data/lib/stripe/resources/treasury/financial_account.rb +22 -3
  145. data/lib/stripe/resources/treasury/financial_account_features.rb +2 -0
  146. data/lib/stripe/resources/treasury/outbound_transfer.rb +37 -0
  147. data/lib/stripe/resources/treasury/received_credit.rb +38 -1
  148. data/lib/stripe/resources/treasury/received_debit.rb +40 -1
  149. data/lib/stripe/resources/v2/core/account.rb +1919 -0
  150. data/lib/stripe/resources/v2/core/account_link.rb +56 -0
  151. data/lib/stripe/resources/v2/core/person.rb +276 -0
  152. data/lib/stripe/resources/v2/core/vault/gb_bank_account.rb +74 -0
  153. data/lib/stripe/resources/v2/core/vault/us_bank_account.rb +39 -0
  154. data/lib/stripe/resources/v2/financial_address_credit_simulation.rb +20 -0
  155. data/lib/stripe/resources/v2/financial_address_generated_microdeposits.rb +22 -0
  156. data/lib/stripe/resources/v2/money_management/adjustment.rb +51 -0
  157. data/lib/stripe/resources/v2/money_management/financial_account.rb +77 -0
  158. data/lib/stripe/resources/v2/money_management/financial_address.rb +68 -0
  159. data/lib/stripe/resources/v2/money_management/inbound_transfer.rb +94 -0
  160. data/lib/stripe/resources/v2/money_management/outbound_payment.rb +129 -0
  161. data/lib/stripe/resources/v2/money_management/outbound_payment_quote.rb +82 -0
  162. data/lib/stripe/resources/v2/money_management/outbound_setup_intent.rb +45 -0
  163. data/lib/stripe/resources/v2/money_management/outbound_transfer.rb +117 -0
  164. data/lib/stripe/resources/v2/money_management/payout_method.rb +75 -0
  165. data/lib/stripe/resources/v2/money_management/payout_methods_bank_account_spec.rb +49 -0
  166. data/lib/stripe/resources/v2/money_management/received_credit.rb +122 -0
  167. data/lib/stripe/resources/v2/money_management/received_debit.rb +84 -0
  168. data/lib/stripe/resources/v2/money_management/transaction.rb +78 -0
  169. data/lib/stripe/resources/v2/money_management/transaction_entry.rb +68 -0
  170. data/lib/stripe/resources/v2/payments/off_session_payment.rb +72 -0
  171. data/lib/stripe/resources.rb +106 -0
  172. data/lib/stripe/services/account_notice_service.rb +101 -0
  173. data/lib/stripe/services/account_service.rb +562 -1
  174. data/lib/stripe/services/account_session_service.rb +226 -1
  175. data/lib/stripe/services/balance_settings_service.rb +96 -0
  176. data/lib/stripe/services/billing/credit_balance_summary_service.rb +4 -1
  177. data/lib/stripe/services/billing/credit_balance_transaction_service.rb +4 -0
  178. data/lib/stripe/services/billing/credit_grant_service.rb +8 -0
  179. data/lib/stripe/services/billing_portal/session_service.rb +4 -0
  180. data/lib/stripe/services/capital/financing_offer_service.rb +112 -0
  181. data/lib/stripe/services/capital/financing_summary_service.rb +28 -0
  182. data/lib/stripe/services/capital/financing_transaction_service.rb +79 -0
  183. data/lib/stripe/services/capital_service.rb +15 -0
  184. data/lib/stripe/services/charge_service.rb +1418 -0
  185. data/lib/stripe/services/checkout/session_service.rb +243 -2
  186. data/lib/stripe/services/coupon_service.rb +17 -1
  187. data/lib/stripe/services/credit_note_service.rb +4 -0
  188. data/lib/stripe/services/customer_session_service.rb +4 -1
  189. data/{rbi/stripe/services/account_external_account_service.rbi → lib/stripe/services/external_account_service.rb} +135 -122
  190. data/{rbi/stripe/services/tax/transaction_line_item_service.rbi → lib/stripe/services/financial_connections/account_inferred_balance_service.rb} +21 -17
  191. data/lib/stripe/services/financial_connections/account_service.rb +7 -2
  192. data/{rbi/stripe/services/climate/supplier_service.rbi → lib/stripe/services/financial_connections/institution_service.rb} +36 -25
  193. data/lib/stripe/services/financial_connections/session_service.rb +34 -2
  194. data/lib/stripe/services/financial_connections_service.rb +2 -1
  195. data/lib/stripe/services/fx_quote_service.rb +123 -0
  196. data/lib/stripe/services/identity/verification_session_service.rb +8 -0
  197. data/lib/stripe/services/invoice_item_service.rb +74 -2
  198. data/lib/stripe/services/invoice_line_item_service.rb +33 -1
  199. data/lib/stripe/services/invoice_service.rb +1014 -16
  200. data/lib/stripe/services/issuing/cardholder_service.rb +2 -1
  201. data/lib/stripe/services/issuing/credit_underwriting_record_service.rb +504 -0
  202. data/lib/stripe/services/issuing/dispute_settlement_detail_service.rb +66 -0
  203. data/lib/stripe/services/issuing/fraud_liability_debit_service.rb +83 -0
  204. data/lib/stripe/services/issuing/transaction_service.rb +4 -0
  205. data/lib/stripe/services/issuing_service.rb +5 -1
  206. data/lib/stripe/services/margin_service.rb +119 -0
  207. data/{rbi/stripe/services/source_transaction_service.rbi → lib/stripe/services/order_line_item_service.rb} +20 -16
  208. data/lib/stripe/services/order_service.rb +2388 -0
  209. data/lib/stripe/services/payment_attempt_record_service.rb +49 -0
  210. data/{rbi/stripe/services/quote_line_item_service.rbi → lib/stripe/services/payment_intent_amount_details_line_item_service.rb} +20 -16
  211. data/lib/stripe/services/payment_intent_service.rb +4879 -391
  212. data/lib/stripe/services/payment_method_configuration_service.rb +210 -0
  213. data/lib/stripe/services/payment_method_service.rb +120 -1
  214. data/lib/stripe/services/payment_record_service.rb +542 -0
  215. data/lib/stripe/services/payout_service.rb +4 -0
  216. data/lib/stripe/services/price_service.rb +19 -0
  217. data/lib/stripe/services/privacy/redaction_job_service.rb +240 -0
  218. data/{rbi/stripe/services/tax/calculation_line_item_service.rbi → lib/stripe/services/privacy/redaction_job_validation_error_service.rb} +21 -17
  219. data/lib/stripe/services/privacy_service.rb +13 -0
  220. data/lib/stripe/services/promotion_code_service.rb +8 -0
  221. data/{rbi/stripe/services/credit_note_line_item_service.rbi → lib/stripe/services/quote_line_service.rb} +20 -16
  222. data/{rbi/stripe/services/payment_link_line_item_service.rbi → lib/stripe/services/quote_preview_invoice_service.rb} +20 -16
  223. data/lib/stripe/services/quote_preview_subscription_schedule_service.rb +35 -0
  224. data/lib/stripe/services/quote_service.rb +1723 -8
  225. data/lib/stripe/services/setup_intent_service.rb +538 -9
  226. data/lib/stripe/services/subscription_item_service.rb +75 -3
  227. data/lib/stripe/services/subscription_schedule_service.rb +911 -10
  228. data/lib/stripe/services/subscription_service.rb +249 -9
  229. data/lib/stripe/services/tax/association_service.rb +31 -0
  230. data/lib/stripe/services/tax/form_service.rb +100 -0
  231. data/lib/stripe/services/tax_id_service.rb +8 -2
  232. data/lib/stripe/services/tax_service.rb +3 -1
  233. data/lib/stripe/services/terminal/reader_collected_data_service.rb +28 -0
  234. data/lib/stripe/services/terminal_service.rb +2 -1
  235. data/lib/stripe/services/test_helpers/confirmation_token_service.rb +97 -0
  236. data/lib/stripe/services/test_helpers/treasury/received_credit_service.rb +25 -1
  237. data/lib/stripe/services/test_helpers/treasury/received_debit_service.rb +25 -1
  238. data/lib/stripe/services/transfer_service.rb +4 -0
  239. data/lib/stripe/services/treasury/financial_account_features_service.rb +4 -1
  240. data/lib/stripe/services/treasury/financial_account_service.rb +16 -2
  241. data/lib/stripe/services/treasury/outbound_transfer_service.rb +24 -0
  242. data/lib/stripe/services/v1_services.rb +11 -2
  243. data/lib/stripe/services/v2/core/account_link_service.rb +76 -0
  244. data/lib/stripe/services/v2/core/account_service.rb +4486 -0
  245. data/lib/stripe/services/v2/core/accounts/person_service.rb +1045 -0
  246. data/lib/stripe/services/v2/core/vault/gb_bank_account_service.rb +130 -0
  247. data/lib/stripe/services/v2/core/vault/us_bank_account_service.rb +107 -0
  248. data/lib/stripe/services/v2/core/vault_service.rb +18 -0
  249. data/lib/stripe/services/v2/core_service.rb +4 -1
  250. data/lib/stripe/services/v2/money_management/adjustment_service.rb +74 -0
  251. data/lib/stripe/services/v2/money_management/financial_account_service.rb +116 -0
  252. data/lib/stripe/services/v2/money_management/financial_address_service.rb +82 -0
  253. data/lib/stripe/services/v2/money_management/inbound_transfer_service.rb +125 -0
  254. data/lib/stripe/services/v2/money_management/outbound_payment_quote_service.rb +95 -0
  255. data/lib/stripe/services/v2/money_management/outbound_payment_service.rb +199 -0
  256. data/lib/stripe/services/v2/money_management/outbound_setup_intent_service.rb +235 -0
  257. data/lib/stripe/services/v2/money_management/outbound_transfer_service.rb +172 -0
  258. data/lib/stripe/services/v2/money_management/payout_method_service.rb +90 -0
  259. data/lib/stripe/services/v2/money_management/payout_methods_bank_account_spec_service.rb +32 -0
  260. data/lib/stripe/services/v2/money_management/received_credit_service.rb +70 -0
  261. data/lib/stripe/services/v2/money_management/received_debit_service.rb +43 -0
  262. data/lib/stripe/services/v2/money_management/transaction_entry_service.rb +69 -0
  263. data/lib/stripe/services/v2/money_management/transaction_service.rb +73 -0
  264. data/lib/stripe/services/v2/money_management_service.rb +31 -0
  265. data/lib/stripe/services/v2/payment_service.rb +15 -0
  266. data/lib/stripe/services/v2/payments/off_session_payment_service.rb +137 -0
  267. data/lib/stripe/services/v2/test_helper_service.rb +15 -0
  268. data/lib/stripe/services/v2/test_helpers/financial_address_service.rb +49 -0
  269. data/lib/stripe/services/v2_services.rb +4 -1
  270. data/lib/stripe/services.rb +53 -1
  271. data/lib/stripe/stripe_configuration.rb +3 -1
  272. data/lib/stripe/stripe_object.rb +1 -1
  273. data/lib/stripe/util.rb +7 -1
  274. data/lib/stripe/version.rb +1 -1
  275. data/lib/stripe.rb +53 -0
  276. data/rbi/stripe.rbi +194513 -0
  277. data/stripe.gemspec +4 -1
  278. metadata +164 -325
  279. data/lib/stripe/services/invoice_payment_service.rb +0 -83
  280. data/rbi/stripe/resources/account.rbi +0 -4995
  281. data/rbi/stripe/resources/account_link.rbi +0 -74
  282. data/rbi/stripe/resources/account_session.rbi +0 -1013
  283. data/rbi/stripe/resources/apple_pay_domain.rbi +0 -88
  284. data/rbi/stripe/resources/application.rbi +0 -20
  285. data/rbi/stripe/resources/application_fee.rbi +0 -118
  286. data/rbi/stripe/resources/application_fee_refund.rbi +0 -37
  287. data/rbi/stripe/resources/apps/secret.rbi +0 -195
  288. data/rbi/stripe/resources/balance.rbi +0 -235
  289. data/rbi/stripe/resources/balance_transaction.rbi +0 -147
  290. data/rbi/stripe/resources/bank_account.rbi +0 -127
  291. data/rbi/stripe/resources/billing/alert.rbi +0 -201
  292. data/rbi/stripe/resources/billing/alert_triggered.rbi +0 -28
  293. data/rbi/stripe/resources/billing/credit_balance_summary.rbi +0 -63
  294. data/rbi/stripe/resources/billing/credit_balance_transaction.rbi +0 -147
  295. data/rbi/stripe/resources/billing/credit_grant.rbi +0 -291
  296. data/rbi/stripe/resources/billing/meter.rbi +0 -226
  297. data/rbi/stripe/resources/billing/meter_event.rbi +0 -64
  298. data/rbi/stripe/resources/billing/meter_event_adjustment.rbi +0 -64
  299. data/rbi/stripe/resources/billing/meter_event_summary.rbi +0 -35
  300. data/rbi/stripe/resources/billing_portal/configuration.rbi +0 -645
  301. data/rbi/stripe/resources/billing_portal/session.rbi +0 -345
  302. data/rbi/stripe/resources/capability.rbi +0 -125
  303. data/rbi/stripe/resources/card.rbi +0 -125
  304. data/rbi/stripe/resources/cash_balance.rbi +0 -32
  305. data/rbi/stripe/resources/charge.rbi +0 -2086
  306. data/rbi/stripe/resources/checkout/session.rbi +0 -4060
  307. data/rbi/stripe/resources/climate/order.rbi +0 -245
  308. data/rbi/stripe/resources/climate/product.rbi +0 -75
  309. data/rbi/stripe/resources/climate/supplier.rbi +0 -72
  310. data/rbi/stripe/resources/confirmation_token.rbi +0 -1818
  311. data/rbi/stripe/resources/connect_collection_transfer.rbi +0 -26
  312. data/rbi/stripe/resources/country_spec.rbi +0 -85
  313. data/rbi/stripe/resources/coupon.rbi +0 -250
  314. data/rbi/stripe/resources/credit_note.rbi +0 -752
  315. data/rbi/stripe/resources/credit_note_line_item.rbi +0 -101
  316. data/rbi/stripe/resources/customer.rbi +0 -1005
  317. data/rbi/stripe/resources/customer_balance_transaction.rbi +0 -56
  318. data/rbi/stripe/resources/customer_cash_balance_transaction.rbi +0 -151
  319. data/rbi/stripe/resources/customer_session.rbi +0 -200
  320. data/rbi/stripe/resources/discount.rbi +0 -53
  321. data/rbi/stripe/resources/dispute.rbi +0 -761
  322. data/rbi/stripe/resources/entitlements/active_entitlement.rbi +0 -58
  323. data/rbi/stripe/resources/entitlements/active_entitlement_summary.rbi +0 -23
  324. data/rbi/stripe/resources/entitlements/feature.rbi +0 -117
  325. data/rbi/stripe/resources/ephemeral_key.rbi +0 -44
  326. data/rbi/stripe/resources/event.rbi +0 -149
  327. data/rbi/stripe/resources/exchange_rate.rbi +0 -66
  328. data/rbi/stripe/resources/file.rbi +0 -143
  329. data/rbi/stripe/resources/file_link.rbi +0 -141
  330. data/rbi/stripe/resources/financial_connections/account.rbi +0 -339
  331. data/rbi/stripe/resources/financial_connections/account_owner.rbi +0 -35
  332. data/rbi/stripe/resources/financial_connections/account_ownership.rbi +0 -23
  333. data/rbi/stripe/resources/financial_connections/session.rbi +0 -123
  334. data/rbi/stripe/resources/financial_connections/transaction.rbi +0 -124
  335. data/rbi/stripe/resources/forwarding/request.rbi +0 -216
  336. data/rbi/stripe/resources/funding_instructions.rbi +0 -437
  337. data/rbi/stripe/resources/identity/verification_report.rbi +0 -360
  338. data/rbi/stripe/resources/identity/verification_session.rbi +0 -564
  339. data/rbi/stripe/resources/invoice.rbi +0 -3842
  340. data/rbi/stripe/resources/invoice_item.rbi +0 -470
  341. data/rbi/stripe/resources/invoice_line_item.rbi +0 -432
  342. data/rbi/stripe/resources/invoice_payment.rbi +0 -121
  343. data/rbi/stripe/resources/invoice_rendering_template.rbi +0 -104
  344. data/rbi/stripe/resources/issuing/authorization.rbi +0 -1283
  345. data/rbi/stripe/resources/issuing/card.rbi +0 -741
  346. data/rbi/stripe/resources/issuing/cardholder.rbi +0 -744
  347. data/rbi/stripe/resources/issuing/dispute.rbi +0 -913
  348. data/rbi/stripe/resources/issuing/personalization_design.rbi +0 -338
  349. data/rbi/stripe/resources/issuing/physical_bundle.rbi +0 -79
  350. data/rbi/stripe/resources/issuing/token.rbi +0 -226
  351. data/rbi/stripe/resources/issuing/transaction.rbi +0 -1061
  352. data/rbi/stripe/resources/line_item.rbi +0 -72
  353. data/rbi/stripe/resources/login_link.rbi +0 -19
  354. data/rbi/stripe/resources/mandate.rbi +0 -191
  355. data/rbi/stripe/resources/payment_intent.rbi +0 -9987
  356. data/rbi/stripe/resources/payment_link.rbi +0 -1801
  357. data/rbi/stripe/resources/payment_method.rbi +0 -1770
  358. data/rbi/stripe/resources/payment_method_configuration.rbi +0 -3550
  359. data/rbi/stripe/resources/payment_method_domain.rbi +0 -228
  360. data/rbi/stripe/resources/payout.rbi +0 -300
  361. data/rbi/stripe/resources/person.rbi +0 -401
  362. data/rbi/stripe/resources/plan.rbi +0 -371
  363. data/rbi/stripe/resources/price.rbi +0 -694
  364. data/rbi/stripe/resources/product.rbi +0 -555
  365. data/rbi/stripe/resources/product_feature.rbi +0 -26
  366. data/rbi/stripe/resources/promotion_code.rbi +0 -261
  367. data/rbi/stripe/resources/quote.rbi +0 -1145
  368. data/rbi/stripe/resources/radar/early_fraud_warning.rbi +0 -98
  369. data/rbi/stripe/resources/radar/value_list.rbi +0 -168
  370. data/rbi/stripe/resources/radar/value_list_item.rbi +0 -129
  371. data/rbi/stripe/resources/refund.rbi +0 -523
  372. data/rbi/stripe/resources/reporting/report_run.rbi +0 -191
  373. data/rbi/stripe/resources/reporting/report_type.rbi +0 -57
  374. data/rbi/stripe/resources/reserve_transaction.rbi +0 -23
  375. data/rbi/stripe/resources/reversal.rbi +0 -51
  376. data/rbi/stripe/resources/review.rbi +0 -154
  377. data/rbi/stripe/resources/setup_attempt.rbi +0 -477
  378. data/rbi/stripe/resources/setup_intent.rbi +0 -3978
  379. data/rbi/stripe/resources/shipping_rate.rbi +0 -305
  380. data/rbi/stripe/resources/sigma/scheduled_query_run.rbi +0 -75
  381. data/rbi/stripe/resources/source.rbi +0 -1496
  382. data/rbi/stripe/resources/source_mandate_notification.rbi +0 -77
  383. data/rbi/stripe/resources/source_transaction.rbi +0 -127
  384. data/rbi/stripe/resources/subscription.rbi +0 -2080
  385. data/rbi/stripe/resources/subscription_item.rbi +0 -404
  386. data/rbi/stripe/resources/subscription_schedule.rbi +0 -1645
  387. data/rbi/stripe/resources/tax/calculation.rbi +0 -478
  388. data/rbi/stripe/resources/tax/calculation_line_item.rbi +0 -91
  389. data/rbi/stripe/resources/tax/registration.rbi +0 -2732
  390. data/rbi/stripe/resources/tax/settings.rbi +0 -141
  391. data/rbi/stripe/resources/tax/transaction.rbi +0 -351
  392. data/rbi/stripe/resources/tax/transaction_line_item.rbi +0 -54
  393. data/rbi/stripe/resources/tax_code.rbi +0 -44
  394. data/rbi/stripe/resources/tax_deducted_at_source.rbi +0 -23
  395. data/rbi/stripe/resources/tax_id.rbi +0 -165
  396. data/rbi/stripe/resources/tax_rate.rbi +0 -239
  397. data/rbi/stripe/resources/terminal/configuration.rbi +0 -1387
  398. data/rbi/stripe/resources/terminal/connection_token.rbi +0 -37
  399. data/rbi/stripe/resources/terminal/location.rbi +0 -222
  400. data/rbi/stripe/resources/terminal/reader.rbi +0 -994
  401. data/rbi/stripe/resources/test_helpers/test_clock.rbi +0 -132
  402. data/rbi/stripe/resources/token.rbi +0 -1283
  403. data/rbi/stripe/resources/topup.rbi +0 -222
  404. data/rbi/stripe/resources/transfer.rbi +0 -199
  405. data/rbi/stripe/resources/treasury/credit_reversal.rbi +0 -119
  406. data/rbi/stripe/resources/treasury/debit_reversal.rbi +0 -131
  407. data/rbi/stripe/resources/treasury/financial_account.rbi +0 -869
  408. data/rbi/stripe/resources/treasury/financial_account_features.rbi +0 -260
  409. data/rbi/stripe/resources/treasury/inbound_transfer.rbi +0 -295
  410. data/rbi/stripe/resources/treasury/outbound_payment.rbi +0 -592
  411. data/rbi/stripe/resources/treasury/outbound_transfer.rbi +0 -431
  412. data/rbi/stripe/resources/treasury/received_credit.rbi +0 -302
  413. data/rbi/stripe/resources/treasury/received_debit.rbi +0 -256
  414. data/rbi/stripe/resources/treasury/transaction.rbi +0 -215
  415. data/rbi/stripe/resources/treasury/transaction_entry.rbi +0 -192
  416. data/rbi/stripe/resources/v2/amount.rbi +0 -14
  417. data/rbi/stripe/resources/v2/billing/meter_event.rbi +0 -37
  418. data/rbi/stripe/resources/v2/billing/meter_event_adjustment.rbi +0 -41
  419. data/rbi/stripe/resources/v2/billing/meter_event_session.rbi +0 -31
  420. data/rbi/stripe/resources/v2/event.rbi +0 -48
  421. data/rbi/stripe/resources/v2/event_destination.rbi +0 -91
  422. data/rbi/stripe/resources/webhook_endpoint.rbi +0 -168
  423. data/rbi/stripe/services/account_capability_service.rbi +0 -51
  424. data/rbi/stripe/services/account_link_service.rbi +0 -58
  425. data/rbi/stripe/services/account_login_link_service.rbi +0 -22
  426. data/rbi/stripe/services/account_person_service.rbi +0 -1011
  427. data/rbi/stripe/services/account_service.rbi +0 -4281
  428. data/rbi/stripe/services/account_session_service.rbi +0 -646
  429. data/rbi/stripe/services/apple_pay_domain_service.rbi +0 -76
  430. data/rbi/stripe/services/application_fee_refund_service.rbi +0 -93
  431. data/rbi/stripe/services/application_fee_service.rbi +0 -78
  432. data/rbi/stripe/services/apps/secret_service.rbi +0 -151
  433. data/rbi/stripe/services/apps_service.rbi +0 -9
  434. data/rbi/stripe/services/balance_service.rbi +0 -21
  435. data/rbi/stripe/services/balance_transaction_service.rbi +0 -93
  436. data/rbi/stripe/services/billing/alert_service.rbi +0 -152
  437. data/rbi/stripe/services/billing/credit_balance_summary_service.rbi +0 -68
  438. data/rbi/stripe/services/billing/credit_balance_transaction_service.rbi +0 -59
  439. data/rbi/stripe/services/billing/credit_grant_service.rbi +0 -211
  440. data/rbi/stripe/services/billing/meter_event_adjustment_service.rbi +0 -42
  441. data/rbi/stripe/services/billing/meter_event_service.rbi +0 -42
  442. data/rbi/stripe/services/billing/meter_event_summary_service.rbi +0 -54
  443. data/rbi/stripe/services/billing/meter_service.rbi +0 -163
  444. data/rbi/stripe/services/billing_portal/configuration_service.rbi +0 -511
  445. data/rbi/stripe/services/billing_portal/session_service.rbi +0 -204
  446. data/rbi/stripe/services/billing_portal_service.rbi +0 -10
  447. data/rbi/stripe/services/billing_service.rbi +0 -15
  448. data/rbi/stripe/services/charge_service.rbi +0 -448
  449. data/rbi/stripe/services/checkout/session_line_item_service.rbi +0 -33
  450. data/rbi/stripe/services/checkout/session_service.rbi +0 -2670
  451. data/rbi/stripe/services/checkout_service.rbi +0 -9
  452. data/rbi/stripe/services/climate/order_service.rbi +0 -142
  453. data/rbi/stripe/services/climate/product_service.rbi +0 -46
  454. data/rbi/stripe/services/climate_service.rbi +0 -11
  455. data/rbi/stripe/services/confirmation_token_service.rbi +0 -20
  456. data/rbi/stripe/services/country_spec_service.rbi +0 -44
  457. data/rbi/stripe/services/coupon_service.rbi +0 -194
  458. data/rbi/stripe/services/credit_note_preview_lines_service.rbi +0 -167
  459. data/rbi/stripe/services/credit_note_service.rbi +0 -415
  460. data/rbi/stripe/services/customer_balance_transaction_service.rbi +0 -92
  461. data/rbi/stripe/services/customer_cash_balance_service.rbi +0 -45
  462. data/rbi/stripe/services/customer_cash_balance_transaction_service.rbi +0 -44
  463. data/rbi/stripe/services/customer_funding_instructions_service.rbi +0 -59
  464. data/rbi/stripe/services/customer_payment_method_service.rbi +0 -57
  465. data/rbi/stripe/services/customer_payment_source_service.rbi +0 -232
  466. data/rbi/stripe/services/customer_service.rbi +0 -647
  467. data/rbi/stripe/services/customer_session_service.rbi +0 -116
  468. data/rbi/stripe/services/customer_tax_id_service.rbi +0 -70
  469. data/rbi/stripe/services/dispute_service.rbi +0 -424
  470. data/rbi/stripe/services/entitlements/active_entitlement_service.rbi +0 -55
  471. data/rbi/stripe/services/entitlements/feature_service.rbi +0 -107
  472. data/rbi/stripe/services/entitlements_service.rbi +0 -10
  473. data/rbi/stripe/services/ephemeral_key_service.rbi +0 -53
  474. data/rbi/stripe/services/event_service.rbi +0 -83
  475. data/rbi/stripe/services/exchange_rate_service.rbi +0 -44
  476. data/rbi/stripe/services/file_link_service.rbi +0 -124
  477. data/rbi/stripe/services/file_service.rbi +0 -116
  478. data/rbi/stripe/services/financial_connections/account_owner_service.rbi +0 -42
  479. data/rbi/stripe/services/financial_connections/account_service.rbi +0 -133
  480. data/rbi/stripe/services/financial_connections/session_service.rbi +0 -88
  481. data/rbi/stripe/services/financial_connections/transaction_service.rbi +0 -92
  482. data/rbi/stripe/services/financial_connections_service.rbi +0 -11
  483. data/rbi/stripe/services/forwarding/request_service.rbi +0 -134
  484. data/rbi/stripe/services/forwarding_service.rbi +0 -9
  485. data/rbi/stripe/services/identity/verification_report_service.rbi +0 -87
  486. data/rbi/stripe/services/identity/verification_session_service.rbi +0 -339
  487. data/rbi/stripe/services/identity_service.rbi +0 -10
  488. data/rbi/stripe/services/invoice_item_service.rbi +0 -366
  489. data/rbi/stripe/services/invoice_line_item_service.rbi +0 -259
  490. data/rbi/stripe/services/invoice_payment_service.rbi +0 -71
  491. data/rbi/stripe/services/invoice_rendering_template_service.rbi +0 -82
  492. data/rbi/stripe/services/invoice_service.rbi +0 -3011
  493. data/rbi/stripe/services/issuing/authorization_service.rbi +0 -146
  494. data/rbi/stripe/services/issuing/card_service.rbi +0 -495
  495. data/rbi/stripe/services/issuing/cardholder_service.rbi +0 -587
  496. data/rbi/stripe/services/issuing/dispute_service.rbi +0 -707
  497. data/rbi/stripe/services/issuing/personalization_design_service.rbi +0 -243
  498. data/rbi/stripe/services/issuing/physical_bundle_service.rbi +0 -59
  499. data/rbi/stripe/services/issuing/token_service.rbi +0 -99
  500. data/rbi/stripe/services/issuing/transaction_service.rbi +0 -105
  501. data/rbi/stripe/services/issuing_service.rbi +0 -16
  502. data/rbi/stripe/services/mandate_service.rbi +0 -20
  503. data/rbi/stripe/services/payment_intent_service.rbi +0 -7989
  504. data/rbi/stripe/services/payment_link_service.rbi +0 -1352
  505. data/rbi/stripe/services/payment_method_configuration_service.rbi +0 -2487
  506. data/rbi/stripe/services/payment_method_domain_service.rbi +0 -112
  507. data/rbi/stripe/services/payment_method_service.rbi +0 -781
  508. data/rbi/stripe/services/payout_service.rbi +0 -205
  509. data/rbi/stripe/services/plan_service.rbi +0 -282
  510. data/rbi/stripe/services/price_service.rbi +0 -546
  511. data/rbi/stripe/services/product_feature_service.rbi +0 -67
  512. data/rbi/stripe/services/product_service.rbi +0 -477
  513. data/rbi/stripe/services/promotion_code_service.rbi +0 -214
  514. data/rbi/stripe/services/quote_computed_upfront_line_items_service.rbi +0 -31
  515. data/rbi/stripe/services/quote_service.rbi +0 -699
  516. data/rbi/stripe/services/radar/early_fraud_warning_service.rbi +0 -85
  517. data/rbi/stripe/services/radar/value_list_item_service.rbi +0 -109
  518. data/rbi/stripe/services/radar/value_list_service.rbi +0 -141
  519. data/rbi/stripe/services/radar_service.rbi +0 -11
  520. data/rbi/stripe/services/refund_service.rbi +0 -185
  521. data/rbi/stripe/services/reporting/report_run_service.rbi +0 -135
  522. data/rbi/stripe/services/reporting/report_type_service.rbi +0 -35
  523. data/rbi/stripe/services/reporting_service.rbi +0 -10
  524. data/rbi/stripe/services/review_service.rbi +0 -84
  525. data/rbi/stripe/services/setup_attempt_service.rbi +0 -65
  526. data/rbi/stripe/services/setup_intent_service.rbi +0 -3709
  527. data/rbi/stripe/services/shipping_rate_service.rbi +0 -241
  528. data/rbi/stripe/services/sigma/scheduled_query_run_service.rbi +0 -46
  529. data/rbi/stripe/services/sigma_service.rbi +0 -9
  530. data/rbi/stripe/services/source_service.rbi +0 -663
  531. data/rbi/stripe/services/subscription_item_service.rbi +0 -350
  532. data/rbi/stripe/services/subscription_schedule_service.rbi +0 -1301
  533. data/rbi/stripe/services/subscription_service.rbi +0 -1684
  534. data/rbi/stripe/services/tax/calculation_service.rbi +0 -234
  535. data/rbi/stripe/services/tax/registration_service.rbi +0 -1858
  536. data/rbi/stripe/services/tax/settings_service.rbi +0 -93
  537. data/rbi/stripe/services/tax/transaction_service.rbi +0 -146
  538. data/rbi/stripe/services/tax_code_service.rbi +0 -44
  539. data/rbi/stripe/services/tax_id_service.rbi +0 -110
  540. data/rbi/stripe/services/tax_rate_service.rbi +0 -185
  541. data/rbi/stripe/services/tax_service.rbi +0 -12
  542. data/rbi/stripe/services/terminal/configuration_service.rbi +0 -1118
  543. data/rbi/stripe/services/terminal/connection_token_service.rbi +0 -25
  544. data/rbi/stripe/services/terminal/location_service.rbi +0 -182
  545. data/rbi/stripe/services/terminal/reader_service.rbi +0 -540
  546. data/rbi/stripe/services/terminal_service.rbi +0 -12
  547. data/rbi/stripe/services/test_helpers/confirmation_token_service.rbi +0 -746
  548. data/rbi/stripe/services/test_helpers/customer_service.rbi +0 -33
  549. data/rbi/stripe/services/test_helpers/issuing/authorization_service.rbi +0 -848
  550. data/rbi/stripe/services/test_helpers/issuing/card_service.rbi +0 -76
  551. data/rbi/stripe/services/test_helpers/issuing/personalization_design_service.rbi +0 -69
  552. data/rbi/stripe/services/test_helpers/issuing/transaction_service.rbi +0 -711
  553. data/rbi/stripe/services/test_helpers/issuing_service.rbi +0 -14
  554. data/rbi/stripe/services/test_helpers/refund_service.rbi +0 -22
  555. data/rbi/stripe/services/test_helpers/terminal/reader_service.rbi +0 -93
  556. data/rbi/stripe/services/test_helpers/terminal_service.rbi +0 -11
  557. data/rbi/stripe/services/test_helpers/test_clock_service.rbi +0 -90
  558. data/rbi/stripe/services/test_helpers/treasury/inbound_transfer_service.rbi +0 -64
  559. data/rbi/stripe/services/test_helpers/treasury/outbound_payment_service.rbi +0 -125
  560. data/rbi/stripe/services/test_helpers/treasury/outbound_transfer_service.rbi +0 -125
  561. data/rbi/stripe/services/test_helpers/treasury/received_credit_service.rbi +0 -87
  562. data/rbi/stripe/services/test_helpers/treasury/received_debit_service.rbi +0 -87
  563. data/rbi/stripe/services/test_helpers/treasury_service.rbi +0 -15
  564. data/rbi/stripe/services/test_helpers_service.rbi +0 -15
  565. data/rbi/stripe/services/token_service.rbi +0 -1257
  566. data/rbi/stripe/services/topup_service.rbi +0 -176
  567. data/rbi/stripe/services/transfer_reversal_service.rbi +0 -101
  568. data/rbi/stripe/services/transfer_service.rbi +0 -152
  569. data/rbi/stripe/services/treasury/credit_reversal_service.rbi +0 -84
  570. data/rbi/stripe/services/treasury/debit_reversal_service.rbi +0 -88
  571. data/rbi/stripe/services/treasury/financial_account_features_service.rbi +0 -198
  572. data/rbi/stripe/services/treasury/financial_account_service.rbi +0 -566
  573. data/rbi/stripe/services/treasury/inbound_transfer_service.rbi +0 -117
  574. data/rbi/stripe/services/treasury/outbound_payment_service.rbi +0 -304
  575. data/rbi/stripe/services/treasury/outbound_transfer_service.rbi +0 -157
  576. data/rbi/stripe/services/treasury/received_credit_service.rbi +0 -72
  577. data/rbi/stripe/services/treasury/received_debit_service.rbi +0 -59
  578. data/rbi/stripe/services/treasury/transaction_entry_service.rbi +0 -111
  579. data/rbi/stripe/services/treasury/transaction_service.rbi +0 -122
  580. data/rbi/stripe/services/treasury_service.rbi +0 -18
  581. data/rbi/stripe/services/v1_services.rbi +0 -77
  582. data/rbi/stripe/services/v2/billing/meter_event_adjustment_service.rbi +0 -39
  583. data/rbi/stripe/services/v2/billing/meter_event_service.rbi +0 -42
  584. data/rbi/stripe/services/v2/billing/meter_event_session_service.rbi +0 -18
  585. data/rbi/stripe/services/v2/billing/meter_event_stream_service.rbi +0 -55
  586. data/rbi/stripe/services/v2/billing_service.rbi +0 -14
  587. data/rbi/stripe/services/v2/core/event_destination_service.rbi +0 -192
  588. data/rbi/stripe/services/v2/core/event_service.rbi +0 -36
  589. data/rbi/stripe/services/v2/core_service.rbi +0 -12
  590. data/rbi/stripe/services/v2_services.rbi +0 -10
  591. data/rbi/stripe/services/webhook_endpoint_service.rbi +0 -129
@@ -1,58 +0,0 @@
1
- # File generated from our OpenAPI spec
2
- # frozen_string_literal: true
3
-
4
- # typed: true
5
- module Stripe
6
- module Entitlements
7
- # An active entitlement describes access to a feature for a customer.
8
- class ActiveEntitlement < APIResource
9
- # The [Feature](https://stripe.com/docs/api/entitlements/feature) that the customer is entitled to.
10
- sig { returns(T.any(String, Stripe::Entitlements::Feature)) }
11
- attr_reader :feature
12
- # Unique identifier for the object.
13
- sig { returns(String) }
14
- attr_reader :id
15
- # Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
16
- sig { returns(T::Boolean) }
17
- attr_reader :livemode
18
- # A unique key you provide as your own system identifier. This may be up to 80 characters.
19
- sig { returns(String) }
20
- attr_reader :lookup_key
21
- # String representing the object's type. Objects of the same type share the same value.
22
- sig { returns(String) }
23
- attr_reader :object
24
- class ListParams < Stripe::RequestParams
25
- # The ID of the customer.
26
- sig { returns(String) }
27
- attr_accessor :customer
28
- # 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.
29
- sig { returns(T.nilable(String)) }
30
- attr_accessor :ending_before
31
- # Specifies which fields in the response should be expanded.
32
- sig { returns(T.nilable(T::Array[String])) }
33
- attr_accessor :expand
34
- # A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
35
- sig { returns(T.nilable(Integer)) }
36
- attr_accessor :limit
37
- # 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.
38
- sig { returns(T.nilable(String)) }
39
- attr_accessor :starting_after
40
- sig {
41
- params(customer: String, ending_before: T.nilable(String), expand: T.nilable(T::Array[String]), limit: T.nilable(Integer), starting_after: T.nilable(String)).void
42
- }
43
- def initialize(
44
- customer: nil,
45
- ending_before: nil,
46
- expand: nil,
47
- limit: nil,
48
- starting_after: nil
49
- ); end
50
- end
51
- # Retrieve a list of active entitlements for a customer
52
- sig {
53
- params(params: T.any(::Stripe::Entitlements::ActiveEntitlement::ListParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::ListObject)
54
- }
55
- def self.list(params = {}, opts = {}); end
56
- end
57
- end
58
- end
@@ -1,23 +0,0 @@
1
- # File generated from our OpenAPI spec
2
- # frozen_string_literal: true
3
-
4
- # typed: true
5
- module Stripe
6
- module Entitlements
7
- # A summary of a customer's active entitlements.
8
- class ActiveEntitlementSummary < APIResource
9
- # The customer that is entitled to this feature.
10
- sig { returns(String) }
11
- attr_reader :customer
12
- # The list of entitlements this customer has.
13
- sig { returns(Stripe::ListObject) }
14
- attr_reader :entitlements
15
- # Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
16
- sig { returns(T::Boolean) }
17
- attr_reader :livemode
18
- # String representing the object's type. Objects of the same type share the same value.
19
- sig { returns(String) }
20
- attr_reader :object
21
- end
22
- end
23
- end
@@ -1,117 +0,0 @@
1
- # File generated from our OpenAPI spec
2
- # frozen_string_literal: true
3
-
4
- # typed: true
5
- module Stripe
6
- module Entitlements
7
- # A feature represents a monetizable ability or functionality in your system.
8
- # Features can be assigned to products, and when those products are purchased, Stripe will create an entitlement to the feature for the purchasing customer.
9
- class Feature < APIResource
10
- # Inactive features cannot be attached to new products and will not be returned from the features list endpoint.
11
- sig { returns(T::Boolean) }
12
- attr_reader :active
13
- # Unique identifier for the object.
14
- sig { returns(String) }
15
- attr_reader :id
16
- # Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
17
- sig { returns(T::Boolean) }
18
- attr_reader :livemode
19
- # A unique key you provide as your own system identifier. This may be up to 80 characters.
20
- sig { returns(String) }
21
- attr_reader :lookup_key
22
- # Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
23
- sig { returns(T::Hash[String, String]) }
24
- attr_reader :metadata
25
- # The feature's name, for your own purpose, not meant to be displayable to the customer.
26
- sig { returns(String) }
27
- attr_reader :name
28
- # String representing the object's type. Objects of the same type share the same value.
29
- sig { returns(String) }
30
- attr_reader :object
31
- class ListParams < Stripe::RequestParams
32
- # If set, filter results to only include features with the given archive status.
33
- sig { returns(T.nilable(T::Boolean)) }
34
- attr_accessor :archived
35
- # 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.
36
- sig { returns(T.nilable(String)) }
37
- attr_accessor :ending_before
38
- # Specifies which fields in the response should be expanded.
39
- sig { returns(T.nilable(T::Array[String])) }
40
- attr_accessor :expand
41
- # A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
42
- sig { returns(T.nilable(Integer)) }
43
- attr_accessor :limit
44
- # If set, filter results to only include features with the given lookup_key.
45
- sig { returns(T.nilable(String)) }
46
- attr_accessor :lookup_key
47
- # 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.
48
- sig { returns(T.nilable(String)) }
49
- attr_accessor :starting_after
50
- sig {
51
- params(archived: T.nilable(T::Boolean), ending_before: T.nilable(String), expand: T.nilable(T::Array[String]), limit: T.nilable(Integer), lookup_key: T.nilable(String), starting_after: T.nilable(String)).void
52
- }
53
- def initialize(
54
- archived: nil,
55
- ending_before: nil,
56
- expand: nil,
57
- limit: nil,
58
- lookup_key: nil,
59
- starting_after: nil
60
- ); end
61
- end
62
- class CreateParams < Stripe::RequestParams
63
- # Specifies which fields in the response should be expanded.
64
- sig { returns(T.nilable(T::Array[String])) }
65
- attr_accessor :expand
66
- # A unique key you provide as your own system identifier. This may be up to 80 characters.
67
- sig { returns(String) }
68
- attr_accessor :lookup_key
69
- # Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
70
- sig { returns(T.nilable(T::Hash[String, String])) }
71
- attr_accessor :metadata
72
- # The feature's name, for your own purpose, not meant to be displayable to the customer.
73
- sig { returns(String) }
74
- attr_accessor :name
75
- sig {
76
- params(expand: T.nilable(T::Array[String]), lookup_key: String, metadata: T.nilable(T::Hash[String, String]), name: String).void
77
- }
78
- def initialize(expand: nil, lookup_key: nil, metadata: nil, name: nil); end
79
- end
80
- class UpdateParams < Stripe::RequestParams
81
- # Inactive features cannot be attached to new products and will not be returned from the features list endpoint.
82
- sig { returns(T.nilable(T::Boolean)) }
83
- attr_accessor :active
84
- # Specifies which fields in the response should be expanded.
85
- sig { returns(T.nilable(T::Array[String])) }
86
- attr_accessor :expand
87
- # Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
88
- sig { returns(T.nilable(T.nilable(T.any(String, T::Hash[String, String])))) }
89
- attr_accessor :metadata
90
- # The feature's name, for your own purpose, not meant to be displayable to the customer.
91
- sig { returns(T.nilable(String)) }
92
- attr_accessor :name
93
- sig {
94
- params(active: T.nilable(T::Boolean), expand: T.nilable(T::Array[String]), metadata: T.nilable(T.nilable(T.any(String, T::Hash[String, String]))), name: T.nilable(String)).void
95
- }
96
- def initialize(active: nil, expand: nil, metadata: nil, name: nil); end
97
- end
98
- # Creates a feature
99
- sig {
100
- params(params: T.any(::Stripe::Entitlements::Feature::CreateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Entitlements::Feature)
101
- }
102
- def self.create(params = {}, opts = {}); end
103
-
104
- # Retrieve a list of features
105
- sig {
106
- params(params: T.any(::Stripe::Entitlements::Feature::ListParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::ListObject)
107
- }
108
- def self.list(params = {}, opts = {}); end
109
-
110
- # Update a feature's metadata or permanently deactivate it.
111
- sig {
112
- params(id: String, params: T.any(::Stripe::Entitlements::Feature::UpdateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Entitlements::Feature)
113
- }
114
- def self.update(id, params = {}, opts = {}); end
115
- end
116
- end
117
- 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 EphemeralKey < APIResource
7
- # Time at which the object was created. Measured in seconds since the Unix epoch.
8
- sig { returns(Integer) }
9
- attr_reader :created
10
- # Time at which the key will expire. Measured in seconds since the Unix epoch.
11
- sig { returns(Integer) }
12
- attr_reader :expires
13
- # Unique identifier for the object.
14
- sig { returns(String) }
15
- attr_reader :id
16
- # Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
17
- sig { returns(T::Boolean) }
18
- attr_reader :livemode
19
- # String representing the object's type. Objects of the same type share the same value.
20
- sig { returns(String) }
21
- attr_reader :object
22
- # The key's secret. You can use this value to make authorized requests to the Stripe API.
23
- sig { returns(String) }
24
- attr_reader :secret
25
- class DeleteParams < 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
- # Invalidates a short-lived API key for a given resource.
33
- sig {
34
- params(key: String, params: T.any(::Stripe::EphemeralKey::DeleteParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::EphemeralKey)
35
- }
36
- def self.delete(key, params = {}, opts = {}); end
37
-
38
- # Invalidates a short-lived API key for a given resource.
39
- sig {
40
- params(params: T.any(::Stripe::EphemeralKey::DeleteParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::EphemeralKey)
41
- }
42
- def delete(params = {}, opts = {}); end
43
- end
44
- end
@@ -1,149 +0,0 @@
1
- # File generated from our OpenAPI spec
2
- # frozen_string_literal: true
3
-
4
- # typed: true
5
- module Stripe
6
- # Events are our way of letting you know when something interesting happens in
7
- # your account. When an interesting event occurs, we create a new `Event`
8
- # object. For example, when a charge succeeds, we create a `charge.succeeded`
9
- # event, and when an invoice payment attempt fails, we create an
10
- # `invoice.payment_failed` event. Certain API requests might create multiple
11
- # events. For example, if you create a new subscription for a
12
- # customer, you receive both a `customer.subscription.created` event and a
13
- # `charge.succeeded` event.
14
- #
15
- # Events occur when the state of another API resource changes. The event's data
16
- # field embeds the resource's state at the time of the change. For
17
- # example, a `charge.succeeded` event contains a charge, and an
18
- # `invoice.payment_failed` event contains an invoice.
19
- #
20
- # As with other API resources, you can use endpoints to retrieve an
21
- # [individual event](https://stripe.com/docs/api#retrieve_event) or a [list of events](https://stripe.com/docs/api#list_events)
22
- # from the API. We also have a separate
23
- # [webhooks](http://en.wikipedia.org/wiki/Webhook) system for sending the
24
- # `Event` objects directly to an endpoint on your server. You can manage
25
- # webhooks in your
26
- # [account settings](https://dashboard.stripe.com/account/webhooks). Learn how
27
- # to [listen for events](https://docs.stripe.com/webhooks)
28
- # so that your integration can automatically trigger reactions.
29
- #
30
- # When using [Connect](https://docs.stripe.com/connect), you can also receive event notifications
31
- # that occur in connected accounts. For these events, there's an
32
- # additional `account` attribute in the received `Event` object.
33
- #
34
- # We only guarantee access to events through the [Retrieve Event API](https://stripe.com/docs/api#retrieve_event)
35
- # for 30 days.
36
- class Event < APIResource
37
- class Data < Stripe::StripeObject
38
- # Object containing the API resource relevant to the event. For example, an `invoice.created` event will have a full [invoice object](https://stripe.com/docs/api#invoice_object) as the value of the object key.
39
- sig { returns(T::Hash[String, T.untyped]) }
40
- attr_reader :object
41
- # Object containing the names of the updated attributes and their values prior to the event (only included in events of type `*.updated`). If an array attribute has any updated elements, this object contains the entire array. In Stripe API versions 2017-04-06 or earlier, an updated array attribute in this object includes only the updated array elements.
42
- sig { returns(T::Hash[String, T.untyped]) }
43
- attr_reader :previous_attributes
44
- end
45
- class Request < Stripe::StripeObject
46
- # ID of the API request that caused the event. If null, the event was automatic (e.g., Stripe's automatic subscription handling). Request logs are available in the [dashboard](https://dashboard.stripe.com/logs), but currently not in the API.
47
- sig { returns(T.nilable(String)) }
48
- attr_reader :id
49
- # The idempotency key transmitted during the request, if any. *Note: This property is populated only for events on or after May 23, 2017*.
50
- sig { returns(T.nilable(String)) }
51
- attr_reader :idempotency_key
52
- end
53
- # The connected account that originates the event.
54
- sig { returns(String) }
55
- attr_reader :account
56
- # The Stripe API version used to render `data` when the event was created. The contents of `data` never change, so this value remains static regardless of the API version currently in use. This property is populated only for events created on or after October 31, 2014.
57
- sig { returns(T.nilable(String)) }
58
- attr_reader :api_version
59
- # Authentication context needed to fetch the event or related object.
60
- sig { returns(String) }
61
- attr_reader :context
62
- # Time at which the object was created. Measured in seconds since the Unix epoch.
63
- sig { returns(Integer) }
64
- attr_reader :created
65
- # Attribute for field data
66
- sig { returns(Data) }
67
- attr_reader :data
68
- # Unique identifier for the object.
69
- sig { returns(String) }
70
- attr_reader :id
71
- # Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
72
- sig { returns(T::Boolean) }
73
- attr_reader :livemode
74
- # String representing the object's type. Objects of the same type share the same value.
75
- sig { returns(String) }
76
- attr_reader :object
77
- # Number of webhooks that haven't been successfully delivered (for example, to return a 20x response) to the URLs you specify.
78
- sig { returns(Integer) }
79
- attr_reader :pending_webhooks
80
- # Information on the API request that triggers the event.
81
- sig { returns(T.nilable(Request)) }
82
- attr_reader :request
83
- # Description of the event (for example, `invoice.created` or `charge.refunded`).
84
- sig { returns(String) }
85
- attr_reader :type
86
- class ListParams < Stripe::RequestParams
87
- class Created < Stripe::RequestParams
88
- # Minimum value to filter by (exclusive)
89
- sig { returns(T.nilable(Integer)) }
90
- attr_accessor :gt
91
- # Minimum value to filter by (inclusive)
92
- sig { returns(T.nilable(Integer)) }
93
- attr_accessor :gte
94
- # Maximum value to filter by (exclusive)
95
- sig { returns(T.nilable(Integer)) }
96
- attr_accessor :lt
97
- # Maximum value to filter by (inclusive)
98
- sig { returns(T.nilable(Integer)) }
99
- attr_accessor :lte
100
- sig {
101
- params(gt: T.nilable(Integer), gte: T.nilable(Integer), lt: T.nilable(Integer), lte: T.nilable(Integer)).void
102
- }
103
- def initialize(gt: nil, gte: nil, lt: nil, lte: nil); end
104
- end
105
- # Only return events that were created during the given date interval.
106
- sig { returns(T.nilable(T.any(::Stripe::Event::ListParams::Created, Integer))) }
107
- attr_accessor :created
108
- # Filter events by whether all webhooks were successfully delivered. If false, events which are still pending or have failed all delivery attempts to a webhook endpoint will be returned.
109
- sig { returns(T.nilable(T::Boolean)) }
110
- attr_accessor :delivery_success
111
- # 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.
112
- sig { returns(T.nilable(String)) }
113
- attr_accessor :ending_before
114
- # Specifies which fields in the response should be expanded.
115
- sig { returns(T.nilable(T::Array[String])) }
116
- attr_accessor :expand
117
- # A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
118
- sig { returns(T.nilable(Integer)) }
119
- attr_accessor :limit
120
- # 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.
121
- sig { returns(T.nilable(String)) }
122
- attr_accessor :starting_after
123
- # A string containing a specific event name, or group of events using * as a wildcard. The list will be filtered to include only events with a matching event property.
124
- sig { returns(T.nilable(String)) }
125
- attr_accessor :type
126
- # An array of up to 20 strings containing specific event names. The list will be filtered to include only events with a matching event property. You may pass either `type` or `types`, but not both.
127
- sig { returns(T.nilable(T::Array[String])) }
128
- attr_accessor :types
129
- sig {
130
- params(created: T.nilable(T.any(::Stripe::Event::ListParams::Created, Integer)), delivery_success: T.nilable(T::Boolean), ending_before: T.nilable(String), expand: T.nilable(T::Array[String]), limit: T.nilable(Integer), starting_after: T.nilable(String), type: T.nilable(String), types: T.nilable(T::Array[String])).void
131
- }
132
- def initialize(
133
- created: nil,
134
- delivery_success: nil,
135
- ending_before: nil,
136
- expand: nil,
137
- limit: nil,
138
- starting_after: nil,
139
- type: nil,
140
- types: nil
141
- ); end
142
- end
143
- # List events, going back up to 30 days. Each event data is rendered according to Stripe API version at its creation time, specified in [event object](https://docs.stripe.com/api/events/object) api_version attribute (not according to your current Stripe API version or Stripe-Version header).
144
- sig {
145
- params(params: T.any(::Stripe::Event::ListParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::ListObject)
146
- }
147
- def self.list(params = {}, opts = {}); end
148
- end
149
- end
@@ -1,66 +0,0 @@
1
- # File generated from our OpenAPI spec
2
- # frozen_string_literal: true
3
-
4
- # typed: true
5
- module Stripe
6
- # `ExchangeRate` objects allow you to determine the rates that Stripe is currently
7
- # using to convert from one currency to another. Since this number is variable
8
- # throughout the day, there are various reasons why you might want to know the current
9
- # rate (for example, to dynamically price an item for a user with a default
10
- # payment in a foreign currency).
11
- #
12
- # Please refer to our [Exchange Rates API](https://stripe.com/docs/fx-rates) guide for more details.
13
- #
14
- # *[Note: this integration path is supported but no longer recommended]* Additionally,
15
- # you can guarantee that a charge is made with an exchange rate that you expect is
16
- # current. To do so, you must pass in the exchange_rate to charges endpoints. If the
17
- # value is no longer up to date, the charge won't go through. Please refer to our
18
- # [Using with charges](https://stripe.com/docs/exchange-rates) guide for more details.
19
- #
20
- # -----
21
- #
22
- # &nbsp;
23
- #
24
- # *This Exchange Rates API is a Beta Service and is subject to Stripe's terms of service. You may use the API solely for the purpose of transacting on Stripe. For example, the API may be queried in order to:*
25
- #
26
- # - *localize prices for processing payments on Stripe*
27
- # - *reconcile Stripe transactions*
28
- # - *determine how much money to send to a connected account*
29
- # - *determine app fees to charge a connected account*
30
- #
31
- # *Using this Exchange Rates API beta for any purpose other than to transact on Stripe is strictly prohibited and constitutes a violation of Stripe's terms of service.*
32
- class ExchangeRate < APIResource
33
- # Unique identifier for the object. Represented as the three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html) in lowercase.
34
- sig { returns(String) }
35
- attr_reader :id
36
- # String representing the object's type. Objects of the same type share the same value.
37
- sig { returns(String) }
38
- attr_reader :object
39
- # Hash where the keys are supported currencies and the values are the exchange rate at which the base id currency converts to the key currency.
40
- sig { returns(T::Hash[String, Float]) }
41
- attr_reader :rates
42
- class ListParams < Stripe::RequestParams
43
- # A cursor for use in pagination. `ending_before` is the currency that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with the exchange rate for currency X your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
44
- sig { returns(T.nilable(String)) }
45
- attr_accessor :ending_before
46
- # Specifies which fields in the response should be expanded.
47
- sig { returns(T.nilable(T::Array[String])) }
48
- attr_accessor :expand
49
- # A limit on the number of objects to be returned. Limit can range between 1 and total number of supported payout currencies, and the default is the max.
50
- sig { returns(T.nilable(Integer)) }
51
- attr_accessor :limit
52
- # A cursor for use in pagination. `starting_after` is the currency that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with the exchange rate for currency X, your subsequent call can include `starting_after=X` in order to fetch the next page of the list.
53
- sig { returns(T.nilable(String)) }
54
- attr_accessor :starting_after
55
- sig {
56
- params(ending_before: T.nilable(String), expand: T.nilable(T::Array[String]), limit: T.nilable(Integer), starting_after: T.nilable(String)).void
57
- }
58
- def initialize(ending_before: nil, expand: nil, limit: nil, starting_after: nil); end
59
- end
60
- # Returns a list of objects that contain the rates at which foreign currencies are converted to one another. Only shows the currencies for which Stripe supports.
61
- sig {
62
- params(params: T.any(::Stripe::ExchangeRate::ListParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::ListObject)
63
- }
64
- def self.list(params = {}, opts = {}); end
65
- end
66
- end
@@ -1,143 +0,0 @@
1
- # File generated from our OpenAPI spec
2
- # frozen_string_literal: true
3
-
4
- # typed: true
5
- module Stripe
6
- # This object represents files hosted on Stripe's servers. You can upload
7
- # files with the [create file](https://stripe.com/docs/api#create_file) request
8
- # (for example, when uploading dispute evidence). Stripe also
9
- # creates files independently (for example, the results of a [Sigma scheduled
10
- # query](https://docs.stripe.com/api#scheduled_queries)).
11
- #
12
- # Related guide: [File upload guide](https://stripe.com/docs/file-upload)
13
- class File < APIResource
14
- # Time at which the object was created. Measured in seconds since the Unix epoch.
15
- sig { returns(Integer) }
16
- attr_reader :created
17
- # The file expires and isn't available at this time in epoch seconds.
18
- sig { returns(T.nilable(Integer)) }
19
- attr_reader :expires_at
20
- # The suitable name for saving the file to a filesystem.
21
- sig { returns(T.nilable(String)) }
22
- attr_reader :filename
23
- # Unique identifier for the object.
24
- sig { returns(String) }
25
- attr_reader :id
26
- # A list of [file links](https://stripe.com/docs/api#file_links) that point at this file.
27
- sig { returns(T.nilable(Stripe::ListObject)) }
28
- attr_reader :links
29
- # String representing the object's type. Objects of the same type share the same value.
30
- sig { returns(String) }
31
- attr_reader :object
32
- # The [purpose](https://stripe.com/docs/file-upload#uploading-a-file) of the uploaded file.
33
- sig { returns(String) }
34
- attr_reader :purpose
35
- # The size of the file object in bytes.
36
- sig { returns(Integer) }
37
- attr_reader :size
38
- # A suitable title for the document.
39
- sig { returns(T.nilable(String)) }
40
- attr_reader :title
41
- # The returned file type (for example, `csv`, `pdf`, `jpg`, or `png`).
42
- sig { returns(T.nilable(String)) }
43
- attr_reader :type
44
- # Use your live secret API key to download the file from this URL.
45
- sig { returns(T.nilable(String)) }
46
- attr_reader :url
47
- class ListParams < Stripe::RequestParams
48
- class Created < Stripe::RequestParams
49
- # Minimum value to filter by (exclusive)
50
- sig { returns(T.nilable(Integer)) }
51
- attr_accessor :gt
52
- # Minimum value to filter by (inclusive)
53
- sig { returns(T.nilable(Integer)) }
54
- attr_accessor :gte
55
- # Maximum value to filter by (exclusive)
56
- sig { returns(T.nilable(Integer)) }
57
- attr_accessor :lt
58
- # Maximum value to filter by (inclusive)
59
- sig { returns(T.nilable(Integer)) }
60
- attr_accessor :lte
61
- sig {
62
- params(gt: T.nilable(Integer), gte: T.nilable(Integer), lt: T.nilable(Integer), lte: T.nilable(Integer)).void
63
- }
64
- def initialize(gt: nil, gte: nil, lt: nil, lte: nil); end
65
- end
66
- # Only return files that were created during the given date interval.
67
- sig { returns(T.nilable(T.any(::Stripe::File::ListParams::Created, Integer))) }
68
- attr_accessor :created
69
- # 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.
70
- sig { returns(T.nilable(String)) }
71
- attr_accessor :ending_before
72
- # Specifies which fields in the response should be expanded.
73
- sig { returns(T.nilable(T::Array[String])) }
74
- attr_accessor :expand
75
- # A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
76
- sig { returns(T.nilable(Integer)) }
77
- attr_accessor :limit
78
- # Filter queries by the file purpose. If you don't provide a purpose, the queries return unfiltered files.
79
- sig { returns(T.nilable(String)) }
80
- attr_accessor :purpose
81
- # 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.
82
- sig { returns(T.nilable(String)) }
83
- attr_accessor :starting_after
84
- sig {
85
- params(created: T.nilable(T.any(::Stripe::File::ListParams::Created, Integer)), ending_before: T.nilable(String), expand: T.nilable(T::Array[String]), limit: T.nilable(Integer), purpose: T.nilable(String), starting_after: T.nilable(String)).void
86
- }
87
- def initialize(
88
- created: nil,
89
- ending_before: nil,
90
- expand: nil,
91
- limit: nil,
92
- purpose: nil,
93
- starting_after: nil
94
- ); end
95
- end
96
- class CreateParams < Stripe::RequestParams
97
- class FileLinkData < Stripe::RequestParams
98
- # Set this to `true` to create a file link for the newly created file. Creating a link is only possible when the file's `purpose` is one of the following: `business_icon`, `business_logo`, `customer_signature`, `dispute_evidence`, `issuing_regulatory_reporting`, `pci_document`, `tax_document_user_upload`, or `terminal_reader_splashscreen`.
99
- sig { returns(T::Boolean) }
100
- attr_accessor :create
101
- # The link isn't available after this future timestamp.
102
- sig { returns(T.nilable(Integer)) }
103
- attr_accessor :expires_at
104
- # 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`.
105
- sig { returns(T.nilable(T.nilable(T.any(String, T::Hash[String, String])))) }
106
- attr_accessor :metadata
107
- sig {
108
- params(create: T::Boolean, expires_at: T.nilable(Integer), metadata: T.nilable(T.nilable(T.any(String, T::Hash[String, String])))).void
109
- }
110
- def initialize(create: nil, expires_at: nil, metadata: nil); end
111
- end
112
- # Specifies which fields in the response should be expanded.
113
- sig { returns(T.nilable(T::Array[String])) }
114
- attr_accessor :expand
115
- # A file to upload. Make sure that the specifications follow RFC 2388, which defines file transfers for the `multipart/form-data` protocol.
116
- sig { returns(T.untyped) }
117
- attr_accessor :file
118
- # Optional parameters that automatically create a [file link](https://stripe.com/docs/api#file_links) for the newly created file.
119
- sig { returns(T.nilable(::Stripe::File::CreateParams::FileLinkData)) }
120
- attr_accessor :file_link_data
121
- # The [purpose](https://stripe.com/docs/file-upload#uploading-a-file) of the uploaded file.
122
- sig { returns(String) }
123
- attr_accessor :purpose
124
- sig {
125
- params(expand: T.nilable(T::Array[String]), file: T.untyped, file_link_data: T.nilable(::Stripe::File::CreateParams::FileLinkData), purpose: String).void
126
- }
127
- def initialize(expand: nil, file: nil, file_link_data: nil, purpose: nil); end
128
- end
129
- # To upload a file to Stripe, you need to send a request of type multipart/form-data. Include the file you want to upload in the request, and the parameters for creating a file.
130
- #
131
- # All of Stripe's officially supported Client libraries support sending multipart/form-data.
132
- sig {
133
- params(params: T.any(::Stripe::File::CreateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::File)
134
- }
135
- def self.create(params = {}, opts = {}); end
136
-
137
- # Returns a list of the files that your account has access to. Stripe sorts and returns the files by their creation dates, placing the most recently created files at the top.
138
- sig {
139
- params(params: T.any(::Stripe::File::ListParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::ListObject)
140
- }
141
- def self.list(params = {}, opts = {}); end
142
- end
143
- end