stripe 15.0.0 → 15.1.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 (617) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +1559 -676
  3. data/Gemfile +1 -1
  4. data/OPENAPI_VERSION +1 -1
  5. data/VERSION +1 -1
  6. data/lib/stripe/api_operations/nested_resource.rb +35 -35
  7. data/lib/stripe/api_requestor.rb +29 -1
  8. data/lib/stripe/api_version.rb +1 -1
  9. data/lib/stripe/connection_manager.rb +1 -3
  10. data/lib/stripe/errors.rb +54 -0
  11. data/lib/stripe/event_types.rb +75 -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_identity_updated_event.rb +21 -0
  19. data/lib/stripe/events/v2_core_account_including_requirements_updated_event.rb +21 -0
  20. data/lib/stripe/events/v2_core_account_link_completed_event.rb +13 -0
  21. data/lib/stripe/events/v2_core_account_person_created_event.rb +23 -0
  22. data/lib/stripe/events/v2_core_account_person_deleted_event.rb +23 -0
  23. data/lib/stripe/events/v2_core_account_person_updated_event.rb +23 -0
  24. data/lib/stripe/events/v2_money_management_financial_account_created_event.rb +21 -0
  25. data/lib/stripe/events/v2_money_management_financial_address_activated_event.rb +21 -0
  26. data/lib/stripe/events/v2_money_management_financial_address_failed_event.rb +21 -0
  27. data/lib/stripe/events/v2_money_management_inbound_transfer_available_event.rb +23 -0
  28. data/lib/stripe/events/v2_money_management_inbound_transfer_bank_debit_failed_event.rb +21 -0
  29. data/lib/stripe/events/v2_money_management_inbound_transfer_bank_debit_processing_event.rb +21 -0
  30. data/lib/stripe/events/v2_money_management_inbound_transfer_bank_debit_queued_event.rb +21 -0
  31. data/lib/stripe/events/v2_money_management_inbound_transfer_bank_debit_returned_event.rb +21 -0
  32. data/lib/stripe/events/v2_money_management_inbound_transfer_bank_debit_succeeded_event.rb +21 -0
  33. data/lib/stripe/events/v2_money_management_outbound_payment_canceled_event.rb +21 -0
  34. data/lib/stripe/events/v2_money_management_outbound_payment_created_event.rb +21 -0
  35. data/lib/stripe/events/v2_money_management_outbound_payment_failed_event.rb +21 -0
  36. data/lib/stripe/events/v2_money_management_outbound_payment_posted_event.rb +21 -0
  37. data/lib/stripe/events/v2_money_management_outbound_payment_returned_event.rb +21 -0
  38. data/lib/stripe/events/v2_money_management_outbound_transfer_canceled_event.rb +21 -0
  39. data/lib/stripe/events/v2_money_management_outbound_transfer_created_event.rb +21 -0
  40. data/lib/stripe/events/v2_money_management_outbound_transfer_failed_event.rb +21 -0
  41. data/lib/stripe/events/v2_money_management_outbound_transfer_posted_event.rb +21 -0
  42. data/lib/stripe/events/v2_money_management_outbound_transfer_returned_event.rb +21 -0
  43. data/lib/stripe/events/v2_money_management_received_credit_available_event.rb +23 -0
  44. data/lib/stripe/events/v2_money_management_received_credit_failed_event.rb +21 -0
  45. data/lib/stripe/events/v2_money_management_received_credit_returned_event.rb +21 -0
  46. data/lib/stripe/events/v2_money_management_received_credit_succeeded_event.rb +21 -0
  47. data/lib/stripe/events/v2_money_management_received_debit_canceled_event.rb +21 -0
  48. data/lib/stripe/events/v2_money_management_received_debit_failed_event.rb +21 -0
  49. data/lib/stripe/events/v2_money_management_received_debit_pending_event.rb +21 -0
  50. data/lib/stripe/events/v2_money_management_received_debit_succeeded_event.rb +21 -0
  51. data/lib/stripe/events/v2_money_management_received_debit_updated_event.rb +21 -0
  52. data/lib/stripe/oauth.rb +1 -1
  53. data/lib/stripe/object_types.rb +53 -0
  54. data/lib/stripe/resources/account.rb +714 -3
  55. data/lib/stripe/resources/account_notice.rb +123 -0
  56. data/lib/stripe/resources/account_session.rb +299 -1
  57. data/lib/stripe/resources/balance_settings.rb +105 -0
  58. data/lib/stripe/resources/billing/credit_balance_summary.rb +2 -0
  59. data/lib/stripe/resources/billing/credit_balance_transaction.rb +4 -0
  60. data/lib/stripe/resources/billing/credit_grant.rb +10 -0
  61. data/lib/stripe/resources/billing/meter_error_report.rb +59 -0
  62. data/lib/stripe/resources/billing_portal/session.rb +6 -0
  63. data/lib/stripe/resources/capital/financing_offer.rb +179 -0
  64. data/lib/stripe/resources/capital/financing_summary.rb +55 -0
  65. data/lib/stripe/resources/capital/financing_transaction.rb +114 -0
  66. data/lib/stripe/resources/card.rb +2 -0
  67. data/lib/stripe/resources/cash_balance.rb +2 -0
  68. data/lib/stripe/resources/charge.rb +1472 -0
  69. data/lib/stripe/resources/checkout/session.rb +368 -9
  70. data/lib/stripe/resources/confirmation_token.rb +243 -4
  71. data/lib/stripe/resources/coupon.rb +31 -2
  72. data/lib/stripe/resources/credit_note.rb +10 -0
  73. data/lib/stripe/resources/credit_note_line_item.rb +9 -0
  74. data/lib/stripe/resources/customer.rb +2 -0
  75. data/lib/stripe/resources/customer_balance_transaction.rb +2 -0
  76. data/lib/stripe/resources/customer_cash_balance_transaction.rb +2 -0
  77. data/lib/stripe/resources/customer_session.rb +6 -1
  78. data/lib/stripe/resources/discount.rb +2 -0
  79. data/lib/stripe/resources/event.rb +33 -0
  80. data/lib/stripe/resources/financial_connections/account.rb +20 -1
  81. data/lib/stripe/resources/financial_connections/account_inferred_balance.rb +27 -0
  82. data/lib/stripe/resources/financial_connections/institution.rb +90 -0
  83. data/lib/stripe/resources/financial_connections/session.rb +62 -2
  84. data/lib/stripe/resources/funding_instructions.rb +1 -1
  85. data/lib/stripe/resources/fx_quote.rb +184 -0
  86. data/lib/stripe/resources/gift_cards/card.rb +208 -0
  87. data/lib/stripe/resources/gift_cards/transaction.rb +272 -0
  88. data/lib/stripe/resources/identity/verification_session.rb +10 -0
  89. data/lib/stripe/resources/invoice.rb +1124 -16
  90. data/lib/stripe/resources/invoice_item.rb +78 -2
  91. data/lib/stripe/resources/invoice_line_item.rb +55 -1
  92. data/lib/stripe/resources/invoice_payment.rb +2 -53
  93. data/lib/stripe/resources/issuing/cardholder.rb +2 -1
  94. data/lib/stripe/resources/issuing/credit_underwriting_record.rb +602 -0
  95. data/lib/stripe/resources/issuing/dispute_settlement_detail.rb +82 -0
  96. data/lib/stripe/resources/issuing/fraud_liability_debit.rb +86 -0
  97. data/lib/stripe/resources/issuing/settlement.rb +53 -0
  98. data/lib/stripe/resources/issuing/transaction.rb +6 -0
  99. data/lib/stripe/resources/line_item.rb +37 -0
  100. data/lib/stripe/resources/login_link.rb +2 -1
  101. data/lib/stripe/resources/mandate.rb +24 -0
  102. data/lib/stripe/resources/margin.rb +115 -0
  103. data/lib/stripe/resources/order.rb +2859 -0
  104. data/lib/stripe/resources/payment_attempt_record.rb +1078 -0
  105. data/lib/stripe/resources/payment_intent.rb +5540 -654
  106. data/lib/stripe/resources/payment_intent_amount_details_line_item.rb +65 -0
  107. data/lib/stripe/resources/payment_method.rb +209 -6
  108. data/lib/stripe/resources/payment_method_configuration.rb +354 -0
  109. data/lib/stripe/resources/payment_method_domain.rb +13 -0
  110. data/lib/stripe/resources/payment_record.rb +1607 -0
  111. data/lib/stripe/resources/payout.rb +6 -0
  112. data/lib/stripe/resources/person.rb +25 -1
  113. data/lib/stripe/resources/price.rb +30 -0
  114. data/lib/stripe/resources/privacy/redaction_job.rb +254 -0
  115. data/lib/stripe/resources/privacy/redaction_job_root_objects.rb +35 -0
  116. data/lib/stripe/resources/privacy/redaction_job_validation_error.rb +25 -0
  117. data/lib/stripe/resources/product.rb +59 -0
  118. data/lib/stripe/resources/promotion_code.rb +10 -0
  119. data/lib/stripe/resources/quote.rb +2042 -6
  120. data/lib/stripe/resources/quote_line.rb +274 -0
  121. data/lib/stripe/resources/quote_preview_invoice.rb +663 -0
  122. data/lib/stripe/resources/quote_preview_subscription_schedule.rb +337 -0
  123. data/lib/stripe/resources/refund.rb +11 -0
  124. data/lib/stripe/resources/setup_attempt.rb +21 -0
  125. data/lib/stripe/resources/setup_intent.rb +617 -21
  126. data/lib/stripe/resources/source.rb +29 -0
  127. data/lib/stripe/resources/subscription.rb +292 -9
  128. data/lib/stripe/resources/subscription_item.rb +84 -3
  129. data/lib/stripe/resources/subscription_schedule.rb +1007 -10
  130. data/lib/stripe/resources/tax/association.rb +89 -0
  131. data/lib/stripe/resources/tax/form.rb +211 -0
  132. data/lib/stripe/resources/tax/registration.rb +180 -0
  133. data/lib/stripe/resources/tax_id.rb +12 -2
  134. data/lib/stripe/resources/terminal/reader.rb +406 -0
  135. data/lib/stripe/resources/terminal/reader_collected_data.rb +31 -0
  136. data/lib/stripe/resources/token.rb +61 -0
  137. data/lib/stripe/resources/transfer.rb +6 -0
  138. data/lib/stripe/resources/treasury/financial_account.rb +22 -3
  139. data/lib/stripe/resources/treasury/financial_account_features.rb +2 -0
  140. data/lib/stripe/resources/treasury/outbound_payment.rb +4 -1
  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 +1715 -0
  145. data/lib/stripe/resources/v2/core/account_link.rb +54 -0
  146. data/lib/stripe/resources/v2/core/person.rb +272 -0
  147. data/lib/stripe/resources/v2/core/vault/gb_bank_account.rb +72 -0
  148. data/lib/stripe/resources/v2/core/vault/us_bank_account.rb +37 -0
  149. data/lib/stripe/resources/v2/financial_address_credit_simulation.rb +18 -0
  150. data/lib/stripe/resources/v2/financial_address_generated_microdeposits.rb +20 -0
  151. data/lib/stripe/resources/v2/money_management/adjustment.rb +49 -0
  152. data/lib/stripe/resources/v2/money_management/financial_account.rb +56 -0
  153. data/lib/stripe/resources/v2/money_management/financial_address.rb +66 -0
  154. data/lib/stripe/resources/v2/money_management/inbound_transfer.rb +92 -0
  155. data/lib/stripe/resources/v2/money_management/outbound_payment.rb +127 -0
  156. data/lib/stripe/resources/v2/money_management/outbound_payment_quote.rb +74 -0
  157. data/lib/stripe/resources/v2/money_management/outbound_setup_intent.rb +43 -0
  158. data/lib/stripe/resources/v2/money_management/outbound_transfer.rb +115 -0
  159. data/lib/stripe/resources/v2/money_management/payout_method.rb +73 -0
  160. data/lib/stripe/resources/v2/money_management/payout_methods_bank_account_spec.rb +47 -0
  161. data/lib/stripe/resources/v2/money_management/received_credit.rb +134 -0
  162. data/lib/stripe/resources/v2/money_management/received_debit.rb +106 -0
  163. data/lib/stripe/resources/v2/money_management/transaction.rb +76 -0
  164. data/lib/stripe/resources/v2/money_management/transaction_entry.rb +66 -0
  165. data/lib/stripe/resources.rb +90 -0
  166. data/lib/stripe/services/account_notice_service.rb +101 -0
  167. data/lib/stripe/services/account_person_service.rb +84 -0
  168. data/lib/stripe/services/account_service.rb +609 -2
  169. data/lib/stripe/services/account_session_service.rb +269 -1
  170. data/lib/stripe/services/application_fee_service.rb +1 -1
  171. data/lib/stripe/services/apps_service.rb +1 -1
  172. data/lib/stripe/services/balance_settings_service.rb +96 -0
  173. data/lib/stripe/services/billing/credit_balance_summary_service.rb +4 -1
  174. data/lib/stripe/services/billing/credit_balance_transaction_service.rb +4 -0
  175. data/lib/stripe/services/billing/credit_grant_service.rb +8 -0
  176. data/lib/stripe/services/billing/meter_service.rb +1 -1
  177. data/lib/stripe/services/billing_portal/session_service.rb +4 -0
  178. data/lib/stripe/services/billing_portal_service.rb +1 -1
  179. data/lib/stripe/services/billing_service.rb +1 -1
  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 +1350 -0
  185. data/lib/stripe/services/checkout/session_service.rb +269 -7
  186. data/lib/stripe/services/checkout_service.rb +1 -1
  187. data/lib/stripe/services/climate_service.rb +1 -1
  188. data/lib/stripe/services/coupon_service.rb +17 -1
  189. data/lib/stripe/services/credit_note_service.rb +5 -1
  190. data/lib/stripe/services/customer_service.rb +1 -1
  191. data/lib/stripe/services/customer_session_service.rb +4 -1
  192. data/lib/stripe/services/entitlements_service.rb +1 -1
  193. data/{rbi/stripe/services/account_external_account_service.rbi → lib/stripe/services/external_account_service.rb} +135 -123
  194. data/{rbi/stripe/services/tax/transaction_line_item_service.rbi → lib/stripe/services/financial_connections/account_inferred_balance_service.rb} +21 -17
  195. data/lib/stripe/services/financial_connections/account_service.rb +8 -3
  196. data/{rbi/stripe/services/climate/supplier_service.rbi → lib/stripe/services/financial_connections/institution_service.rb} +36 -25
  197. data/lib/stripe/services/financial_connections/session_service.rb +34 -2
  198. data/lib/stripe/services/financial_connections_service.rb +3 -2
  199. data/lib/stripe/services/forwarding_service.rb +1 -1
  200. data/lib/stripe/services/fx_quote_service.rb +123 -0
  201. data/lib/stripe/services/gift_cards/card_service.rb +170 -0
  202. data/lib/stripe/services/gift_cards/transaction_service.rb +209 -0
  203. data/lib/stripe/services/gift_cards_service.rb +14 -0
  204. data/lib/stripe/services/identity/verification_session_service.rb +8 -0
  205. data/lib/stripe/services/identity_service.rb +1 -1
  206. data/lib/stripe/services/invoice_item_service.rb +74 -2
  207. data/lib/stripe/services/invoice_line_item_service.rb +33 -1
  208. data/lib/stripe/services/invoice_service.rb +1053 -17
  209. data/lib/stripe/services/issuing/cardholder_service.rb +2 -1
  210. data/lib/stripe/services/issuing/credit_underwriting_record_service.rb +504 -0
  211. data/lib/stripe/services/issuing/dispute_settlement_detail_service.rb +66 -0
  212. data/lib/stripe/services/issuing/fraud_liability_debit_service.rb +83 -0
  213. data/lib/stripe/services/issuing/transaction_service.rb +4 -0
  214. data/lib/stripe/services/issuing_service.rb +6 -2
  215. data/lib/stripe/services/margin_service.rb +119 -0
  216. data/{rbi/stripe/services/source_transaction_service.rbi → lib/stripe/services/order_line_item_service.rb} +20 -16
  217. data/lib/stripe/services/order_service.rb +2268 -0
  218. data/lib/stripe/services/payment_attempt_record_service.rb +49 -0
  219. data/{rbi/stripe/services/quote_line_item_service.rbi → lib/stripe/services/payment_intent_amount_details_line_item_service.rb} +20 -16
  220. data/lib/stripe/services/payment_intent_service.rb +4711 -278
  221. data/lib/stripe/services/payment_link_service.rb +1 -1
  222. data/lib/stripe/services/payment_method_configuration_service.rb +252 -0
  223. data/lib/stripe/services/payment_method_service.rb +137 -6
  224. data/lib/stripe/services/payment_record_service.rb +542 -0
  225. data/lib/stripe/services/payout_service.rb +4 -0
  226. data/lib/stripe/services/price_service.rb +19 -0
  227. data/lib/stripe/services/privacy/redaction_job_service.rb +231 -0
  228. data/{rbi/stripe/services/climate/product_service.rbi → lib/stripe/services/privacy/redaction_job_validation_error_service.rb} +36 -25
  229. data/lib/stripe/services/privacy_service.rb +13 -0
  230. data/lib/stripe/services/product_service.rb +39 -1
  231. data/lib/stripe/services/promotion_code_service.rb +8 -0
  232. data/{rbi/stripe/services/credit_note_line_item_service.rbi → lib/stripe/services/quote_line_service.rb} +20 -16
  233. data/{rbi/stripe/services/payment_link_line_item_service.rbi → lib/stripe/services/quote_preview_invoice_service.rb} +20 -16
  234. data/lib/stripe/services/quote_preview_subscription_schedule_service.rb +35 -0
  235. data/lib/stripe/services/quote_service.rb +1727 -8
  236. data/lib/stripe/services/radar_service.rb +1 -1
  237. data/lib/stripe/services/reporting_service.rb +1 -1
  238. data/lib/stripe/services/setup_intent_service.rb +577 -21
  239. data/lib/stripe/services/sigma_service.rb +1 -1
  240. data/lib/stripe/services/source_service.rb +1 -1
  241. data/lib/stripe/services/subscription_item_service.rb +75 -3
  242. data/lib/stripe/services/subscription_schedule_service.rb +911 -10
  243. data/lib/stripe/services/subscription_service.rb +253 -9
  244. data/lib/stripe/services/tax/association_service.rb +31 -0
  245. data/lib/stripe/services/tax/calculation_service.rb +1 -1
  246. data/lib/stripe/services/tax/form_service.rb +100 -0
  247. data/lib/stripe/services/tax/registration_service.rb +117 -0
  248. data/lib/stripe/services/tax/transaction_service.rb +1 -1
  249. data/lib/stripe/services/tax_id_service.rb +8 -2
  250. data/lib/stripe/services/tax_service.rb +4 -2
  251. data/lib/stripe/services/terminal/reader_collected_data_service.rb +28 -0
  252. data/lib/stripe/services/terminal/reader_service.rb +180 -0
  253. data/lib/stripe/services/terminal_service.rb +3 -2
  254. data/lib/stripe/services/test_helpers/confirmation_token_service.rb +155 -4
  255. data/lib/stripe/services/test_helpers/issuing_service.rb +1 -1
  256. data/lib/stripe/services/test_helpers/terminal/reader_service.rb +43 -0
  257. data/lib/stripe/services/test_helpers/terminal_service.rb +1 -1
  258. data/lib/stripe/services/test_helpers/treasury/received_credit_service.rb +25 -1
  259. data/lib/stripe/services/test_helpers/treasury/received_debit_service.rb +25 -1
  260. data/lib/stripe/services/test_helpers/treasury_service.rb +1 -1
  261. data/lib/stripe/services/test_helpers_service.rb +1 -1
  262. data/lib/stripe/services/token_service.rb +61 -0
  263. data/lib/stripe/services/transfer_service.rb +5 -1
  264. data/lib/stripe/services/treasury/financial_account_features_service.rb +4 -1
  265. data/lib/stripe/services/treasury/financial_account_service.rb +17 -3
  266. data/lib/stripe/services/treasury/outbound_payment_service.rb +4 -1
  267. data/lib/stripe/services/treasury/outbound_transfer_service.rb +24 -0
  268. data/lib/stripe/services/treasury_service.rb +1 -1
  269. data/lib/stripe/services/v1_services.rb +13 -3
  270. data/lib/stripe/services/v2/billing_service.rb +1 -1
  271. data/lib/stripe/services/v2/core/account_link_service.rb +76 -0
  272. data/lib/stripe/services/v2/core/account_service.rb +4130 -0
  273. data/lib/stripe/services/v2/core/accounts/person_service.rb +1040 -0
  274. data/lib/stripe/services/v2/core/vault/gb_bank_account_service.rb +135 -0
  275. data/lib/stripe/services/v2/core/vault/us_bank_account_service.rb +109 -0
  276. data/lib/stripe/services/v2/core/vault_service.rb +18 -0
  277. data/lib/stripe/services/v2/core_service.rb +5 -2
  278. data/lib/stripe/services/v2/money_management/adjustment_service.rb +75 -0
  279. data/lib/stripe/services/v2/money_management/financial_account_service.rb +44 -0
  280. data/lib/stripe/services/v2/money_management/financial_address_service.rb +81 -0
  281. data/lib/stripe/services/v2/money_management/inbound_transfer_service.rb +126 -0
  282. data/lib/stripe/services/v2/money_management/outbound_payment_quote_service.rb +80 -0
  283. data/lib/stripe/services/v2/money_management/outbound_payment_service.rb +202 -0
  284. data/lib/stripe/services/v2/money_management/outbound_setup_intent_service.rb +237 -0
  285. data/lib/stripe/services/v2/money_management/outbound_transfer_service.rb +174 -0
  286. data/lib/stripe/services/v2/money_management/payout_method_service.rb +95 -0
  287. data/lib/stripe/services/v2/money_management/payout_methods_bank_account_spec_service.rb +32 -0
  288. data/lib/stripe/services/v2/money_management/received_credit_service.rb +71 -0
  289. data/lib/stripe/services/v2/money_management/received_debit_service.rb +44 -0
  290. data/lib/stripe/services/v2/money_management/transaction_entry_service.rb +70 -0
  291. data/lib/stripe/services/v2/money_management/transaction_service.rb +74 -0
  292. data/lib/stripe/services/v2/money_management_service.rb +31 -0
  293. data/lib/stripe/services/v2/test_helper_service.rb +15 -0
  294. data/lib/stripe/services/v2/test_helpers/financial_address_service.rb +50 -0
  295. data/lib/stripe/services/v2_services.rb +5 -3
  296. data/lib/stripe/services.rb +54 -1
  297. data/lib/stripe/stripe_configuration.rb +3 -1
  298. data/lib/stripe/stripe_object.rb +1 -1
  299. data/lib/stripe/util.rb +7 -1
  300. data/lib/stripe/version.rb +1 -1
  301. data/lib/stripe.rb +53 -0
  302. data/rbi/stripe.rbi +191592 -0
  303. data/stripe.gemspec +4 -1
  304. metadata +149 -325
  305. data/lib/stripe/services/invoice_payment_service.rb +0 -83
  306. data/rbi/stripe/resources/account.rbi +0 -4840
  307. data/rbi/stripe/resources/account_link.rbi +0 -74
  308. data/rbi/stripe/resources/account_session.rbi +0 -894
  309. data/rbi/stripe/resources/apple_pay_domain.rbi +0 -90
  310. data/rbi/stripe/resources/application.rbi +0 -20
  311. data/rbi/stripe/resources/application_fee.rbi +0 -118
  312. data/rbi/stripe/resources/application_fee_refund.rbi +0 -37
  313. data/rbi/stripe/resources/apps/secret.rbi +0 -195
  314. data/rbi/stripe/resources/balance.rbi +0 -180
  315. data/rbi/stripe/resources/balance_transaction.rbi +0 -144
  316. data/rbi/stripe/resources/bank_account.rbi +0 -127
  317. data/rbi/stripe/resources/billing/alert.rbi +0 -201
  318. data/rbi/stripe/resources/billing/alert_triggered.rbi +0 -28
  319. data/rbi/stripe/resources/billing/credit_balance_summary.rbi +0 -63
  320. data/rbi/stripe/resources/billing/credit_balance_transaction.rbi +0 -147
  321. data/rbi/stripe/resources/billing/credit_grant.rbi +0 -291
  322. data/rbi/stripe/resources/billing/meter.rbi +0 -226
  323. data/rbi/stripe/resources/billing/meter_event.rbi +0 -64
  324. data/rbi/stripe/resources/billing/meter_event_adjustment.rbi +0 -64
  325. data/rbi/stripe/resources/billing/meter_event_summary.rbi +0 -35
  326. data/rbi/stripe/resources/billing_portal/configuration.rbi +0 -645
  327. data/rbi/stripe/resources/billing_portal/session.rbi +0 -345
  328. data/rbi/stripe/resources/capability.rbi +0 -125
  329. data/rbi/stripe/resources/card.rbi +0 -125
  330. data/rbi/stripe/resources/cash_balance.rbi +0 -32
  331. data/rbi/stripe/resources/charge.rbi +0 -2054
  332. data/rbi/stripe/resources/checkout/session.rbi +0 -3951
  333. data/rbi/stripe/resources/climate/order.rbi +0 -245
  334. data/rbi/stripe/resources/climate/product.rbi +0 -75
  335. data/rbi/stripe/resources/climate/supplier.rbi +0 -72
  336. data/rbi/stripe/resources/confirmation_token.rbi +0 -1793
  337. data/rbi/stripe/resources/connect_collection_transfer.rbi +0 -26
  338. data/rbi/stripe/resources/country_spec.rbi +0 -85
  339. data/rbi/stripe/resources/coupon.rbi +0 -252
  340. data/rbi/stripe/resources/credit_note.rbi +0 -747
  341. data/rbi/stripe/resources/credit_note_line_item.rbi +0 -101
  342. data/rbi/stripe/resources/customer.rbi +0 -1009
  343. data/rbi/stripe/resources/customer_balance_transaction.rbi +0 -56
  344. data/rbi/stripe/resources/customer_cash_balance_transaction.rbi +0 -151
  345. data/rbi/stripe/resources/customer_session.rbi +0 -200
  346. data/rbi/stripe/resources/discount.rbi +0 -53
  347. data/rbi/stripe/resources/dispute.rbi +0 -761
  348. data/rbi/stripe/resources/entitlements/active_entitlement.rbi +0 -58
  349. data/rbi/stripe/resources/entitlements/active_entitlement_summary.rbi +0 -23
  350. data/rbi/stripe/resources/entitlements/feature.rbi +0 -117
  351. data/rbi/stripe/resources/ephemeral_key.rbi +0 -44
  352. data/rbi/stripe/resources/event.rbi +0 -146
  353. data/rbi/stripe/resources/exchange_rate.rbi +0 -66
  354. data/rbi/stripe/resources/file.rbi +0 -143
  355. data/rbi/stripe/resources/file_link.rbi +0 -141
  356. data/rbi/stripe/resources/financial_connections/account.rbi +0 -339
  357. data/rbi/stripe/resources/financial_connections/account_owner.rbi +0 -35
  358. data/rbi/stripe/resources/financial_connections/account_ownership.rbi +0 -23
  359. data/rbi/stripe/resources/financial_connections/session.rbi +0 -123
  360. data/rbi/stripe/resources/financial_connections/transaction.rbi +0 -124
  361. data/rbi/stripe/resources/forwarding/request.rbi +0 -216
  362. data/rbi/stripe/resources/funding_instructions.rbi +0 -437
  363. data/rbi/stripe/resources/identity/verification_report.rbi +0 -351
  364. data/rbi/stripe/resources/identity/verification_session.rbi +0 -517
  365. data/rbi/stripe/resources/invoice.rbi +0 -3733
  366. data/rbi/stripe/resources/invoice_item.rbi +0 -475
  367. data/rbi/stripe/resources/invoice_line_item.rbi +0 -432
  368. data/rbi/stripe/resources/invoice_payment.rbi +0 -114
  369. data/rbi/stripe/resources/invoice_rendering_template.rbi +0 -104
  370. data/rbi/stripe/resources/issuing/authorization.rbi +0 -1283
  371. data/rbi/stripe/resources/issuing/card.rbi +0 -741
  372. data/rbi/stripe/resources/issuing/cardholder.rbi +0 -744
  373. data/rbi/stripe/resources/issuing/dispute.rbi +0 -913
  374. data/rbi/stripe/resources/issuing/personalization_design.rbi +0 -338
  375. data/rbi/stripe/resources/issuing/physical_bundle.rbi +0 -79
  376. data/rbi/stripe/resources/issuing/token.rbi +0 -226
  377. data/rbi/stripe/resources/issuing/transaction.rbi +0 -1061
  378. data/rbi/stripe/resources/line_item.rbi +0 -72
  379. data/rbi/stripe/resources/login_link.rbi +0 -18
  380. data/rbi/stripe/resources/mandate.rbi +0 -187
  381. data/rbi/stripe/resources/payment_intent.rbi +0 -9731
  382. data/rbi/stripe/resources/payment_link.rbi +0 -1801
  383. data/rbi/stripe/resources/payment_method.rbi +0 -1822
  384. data/rbi/stripe/resources/payment_method_configuration.rbi +0 -3154
  385. data/rbi/stripe/resources/payment_method_domain.rbi +0 -212
  386. data/rbi/stripe/resources/payout.rbi +0 -300
  387. data/rbi/stripe/resources/person.rbi +0 -371
  388. data/rbi/stripe/resources/plan.rbi +0 -373
  389. data/rbi/stripe/resources/price.rbi +0 -694
  390. data/rbi/stripe/resources/product.rbi +0 -557
  391. data/rbi/stripe/resources/product_feature.rbi +0 -26
  392. data/rbi/stripe/resources/promotion_code.rbi +0 -261
  393. data/rbi/stripe/resources/quote.rbi +0 -1123
  394. data/rbi/stripe/resources/radar/early_fraud_warning.rbi +0 -98
  395. data/rbi/stripe/resources/radar/value_list.rbi +0 -170
  396. data/rbi/stripe/resources/radar/value_list_item.rbi +0 -131
  397. data/rbi/stripe/resources/refund.rbi +0 -516
  398. data/rbi/stripe/resources/reporting/report_run.rbi +0 -191
  399. data/rbi/stripe/resources/reporting/report_type.rbi +0 -57
  400. data/rbi/stripe/resources/reserve_transaction.rbi +0 -23
  401. data/rbi/stripe/resources/reversal.rbi +0 -51
  402. data/rbi/stripe/resources/review.rbi +0 -154
  403. data/rbi/stripe/resources/setup_attempt.rbi +0 -477
  404. data/rbi/stripe/resources/setup_intent.rbi +0 -3860
  405. data/rbi/stripe/resources/shipping_rate.rbi +0 -305
  406. data/rbi/stripe/resources/sigma/scheduled_query_run.rbi +0 -75
  407. data/rbi/stripe/resources/source.rbi +0 -1496
  408. data/rbi/stripe/resources/source_mandate_notification.rbi +0 -77
  409. data/rbi/stripe/resources/source_transaction.rbi +0 -127
  410. data/rbi/stripe/resources/subscription.rbi +0 -1964
  411. data/rbi/stripe/resources/subscription_item.rbi +0 -370
  412. data/rbi/stripe/resources/subscription_schedule.rbi +0 -1495
  413. data/rbi/stripe/resources/tax/calculation.rbi +0 -474
  414. data/rbi/stripe/resources/tax/calculation_line_item.rbi +0 -88
  415. data/rbi/stripe/resources/tax/registration.rbi +0 -2485
  416. data/rbi/stripe/resources/tax/settings.rbi +0 -141
  417. data/rbi/stripe/resources/tax/transaction.rbi +0 -351
  418. data/rbi/stripe/resources/tax/transaction_line_item.rbi +0 -54
  419. data/rbi/stripe/resources/tax_code.rbi +0 -44
  420. data/rbi/stripe/resources/tax_deducted_at_source.rbi +0 -23
  421. data/rbi/stripe/resources/tax_id.rbi +0 -167
  422. data/rbi/stripe/resources/tax_rate.rbi +0 -239
  423. data/rbi/stripe/resources/terminal/configuration.rbi +0 -1388
  424. data/rbi/stripe/resources/terminal/connection_token.rbi +0 -37
  425. data/rbi/stripe/resources/terminal/location.rbi +0 -224
  426. data/rbi/stripe/resources/terminal/reader.rbi +0 -587
  427. data/rbi/stripe/resources/test_helpers/test_clock.rbi +0 -134
  428. data/rbi/stripe/resources/token.rbi +0 -1217
  429. data/rbi/stripe/resources/topup.rbi +0 -222
  430. data/rbi/stripe/resources/transfer.rbi +0 -199
  431. data/rbi/stripe/resources/treasury/credit_reversal.rbi +0 -119
  432. data/rbi/stripe/resources/treasury/debit_reversal.rbi +0 -131
  433. data/rbi/stripe/resources/treasury/financial_account.rbi +0 -865
  434. data/rbi/stripe/resources/treasury/financial_account_features.rbi +0 -260
  435. data/rbi/stripe/resources/treasury/inbound_transfer.rbi +0 -295
  436. data/rbi/stripe/resources/treasury/outbound_payment.rbi +0 -592
  437. data/rbi/stripe/resources/treasury/outbound_transfer.rbi +0 -431
  438. data/rbi/stripe/resources/treasury/received_credit.rbi +0 -302
  439. data/rbi/stripe/resources/treasury/received_debit.rbi +0 -256
  440. data/rbi/stripe/resources/treasury/transaction.rbi +0 -215
  441. data/rbi/stripe/resources/treasury/transaction_entry.rbi +0 -192
  442. data/rbi/stripe/resources/v2/amount.rbi +0 -14
  443. data/rbi/stripe/resources/v2/billing/meter_event.rbi +0 -37
  444. data/rbi/stripe/resources/v2/billing/meter_event_adjustment.rbi +0 -41
  445. data/rbi/stripe/resources/v2/billing/meter_event_session.rbi +0 -31
  446. data/rbi/stripe/resources/v2/event.rbi +0 -48
  447. data/rbi/stripe/resources/v2/event_destination.rbi +0 -91
  448. data/rbi/stripe/resources/webhook_endpoint.rbi +0 -170
  449. data/rbi/stripe/services/account_capability_service.rbi +0 -51
  450. data/rbi/stripe/services/account_link_service.rbi +0 -58
  451. data/rbi/stripe/services/account_login_link_service.rbi +0 -22
  452. data/rbi/stripe/services/account_person_service.rbi +0 -923
  453. data/rbi/stripe/services/account_service.rbi +0 -4143
  454. data/rbi/stripe/services/account_session_service.rbi +0 -572
  455. data/rbi/stripe/services/apple_pay_domain_service.rbi +0 -78
  456. data/rbi/stripe/services/application_fee_refund_service.rbi +0 -93
  457. data/rbi/stripe/services/application_fee_service.rbi +0 -78
  458. data/rbi/stripe/services/apps/secret_service.rbi +0 -151
  459. data/rbi/stripe/services/apps_service.rbi +0 -9
  460. data/rbi/stripe/services/balance_service.rbi +0 -21
  461. data/rbi/stripe/services/balance_transaction_service.rbi +0 -93
  462. data/rbi/stripe/services/billing/alert_service.rbi +0 -152
  463. data/rbi/stripe/services/billing/credit_balance_summary_service.rbi +0 -68
  464. data/rbi/stripe/services/billing/credit_balance_transaction_service.rbi +0 -59
  465. data/rbi/stripe/services/billing/credit_grant_service.rbi +0 -211
  466. data/rbi/stripe/services/billing/meter_event_adjustment_service.rbi +0 -42
  467. data/rbi/stripe/services/billing/meter_event_service.rbi +0 -42
  468. data/rbi/stripe/services/billing/meter_event_summary_service.rbi +0 -54
  469. data/rbi/stripe/services/billing/meter_service.rbi +0 -163
  470. data/rbi/stripe/services/billing_portal/configuration_service.rbi +0 -511
  471. data/rbi/stripe/services/billing_portal/session_service.rbi +0 -204
  472. data/rbi/stripe/services/billing_portal_service.rbi +0 -10
  473. data/rbi/stripe/services/billing_service.rbi +0 -15
  474. data/rbi/stripe/services/charge_service.rbi +0 -448
  475. data/rbi/stripe/services/checkout/session_line_item_service.rbi +0 -33
  476. data/rbi/stripe/services/checkout/session_service.rbi +0 -2585
  477. data/rbi/stripe/services/checkout_service.rbi +0 -9
  478. data/rbi/stripe/services/climate/order_service.rbi +0 -142
  479. data/rbi/stripe/services/climate_service.rbi +0 -11
  480. data/rbi/stripe/services/confirmation_token_service.rbi +0 -20
  481. data/rbi/stripe/services/country_spec_service.rbi +0 -44
  482. data/rbi/stripe/services/coupon_service.rbi +0 -196
  483. data/rbi/stripe/services/credit_note_preview_lines_service.rbi +0 -167
  484. data/rbi/stripe/services/credit_note_service.rbi +0 -416
  485. data/rbi/stripe/services/customer_balance_transaction_service.rbi +0 -92
  486. data/rbi/stripe/services/customer_cash_balance_service.rbi +0 -45
  487. data/rbi/stripe/services/customer_cash_balance_transaction_service.rbi +0 -44
  488. data/rbi/stripe/services/customer_funding_instructions_service.rbi +0 -59
  489. data/rbi/stripe/services/customer_payment_method_service.rbi +0 -57
  490. data/rbi/stripe/services/customer_payment_source_service.rbi +0 -232
  491. data/rbi/stripe/services/customer_service.rbi +0 -651
  492. data/rbi/stripe/services/customer_session_service.rbi +0 -116
  493. data/rbi/stripe/services/customer_tax_id_service.rbi +0 -72
  494. data/rbi/stripe/services/dispute_service.rbi +0 -424
  495. data/rbi/stripe/services/entitlements/active_entitlement_service.rbi +0 -55
  496. data/rbi/stripe/services/entitlements/feature_service.rbi +0 -107
  497. data/rbi/stripe/services/entitlements_service.rbi +0 -10
  498. data/rbi/stripe/services/ephemeral_key_service.rbi +0 -53
  499. data/rbi/stripe/services/event_service.rbi +0 -83
  500. data/rbi/stripe/services/exchange_rate_service.rbi +0 -44
  501. data/rbi/stripe/services/file_link_service.rbi +0 -124
  502. data/rbi/stripe/services/file_service.rbi +0 -116
  503. data/rbi/stripe/services/financial_connections/account_owner_service.rbi +0 -42
  504. data/rbi/stripe/services/financial_connections/account_service.rbi +0 -133
  505. data/rbi/stripe/services/financial_connections/session_service.rbi +0 -88
  506. data/rbi/stripe/services/financial_connections/transaction_service.rbi +0 -92
  507. data/rbi/stripe/services/financial_connections_service.rbi +0 -11
  508. data/rbi/stripe/services/forwarding/request_service.rbi +0 -134
  509. data/rbi/stripe/services/forwarding_service.rbi +0 -9
  510. data/rbi/stripe/services/identity/verification_report_service.rbi +0 -87
  511. data/rbi/stripe/services/identity/verification_session_service.rbi +0 -323
  512. data/rbi/stripe/services/identity_service.rbi +0 -10
  513. data/rbi/stripe/services/invoice_item_service.rbi +0 -368
  514. data/rbi/stripe/services/invoice_line_item_service.rbi +0 -259
  515. data/rbi/stripe/services/invoice_payment_service.rbi +0 -71
  516. data/rbi/stripe/services/invoice_rendering_template_service.rbi +0 -82
  517. data/rbi/stripe/services/invoice_service.rbi +0 -2920
  518. data/rbi/stripe/services/issuing/authorization_service.rbi +0 -146
  519. data/rbi/stripe/services/issuing/card_service.rbi +0 -495
  520. data/rbi/stripe/services/issuing/cardholder_service.rbi +0 -587
  521. data/rbi/stripe/services/issuing/dispute_service.rbi +0 -707
  522. data/rbi/stripe/services/issuing/personalization_design_service.rbi +0 -243
  523. data/rbi/stripe/services/issuing/physical_bundle_service.rbi +0 -59
  524. data/rbi/stripe/services/issuing/token_service.rbi +0 -99
  525. data/rbi/stripe/services/issuing/transaction_service.rbi +0 -105
  526. data/rbi/stripe/services/issuing_service.rbi +0 -16
  527. data/rbi/stripe/services/mandate_service.rbi +0 -20
  528. data/rbi/stripe/services/payment_intent_service.rbi +0 -7759
  529. data/rbi/stripe/services/payment_link_service.rbi +0 -1352
  530. data/rbi/stripe/services/payment_method_configuration_service.rbi +0 -2211
  531. data/rbi/stripe/services/payment_method_domain_service.rbi +0 -112
  532. data/rbi/stripe/services/payment_method_service.rbi +0 -840
  533. data/rbi/stripe/services/payout_service.rbi +0 -205
  534. data/rbi/stripe/services/plan_service.rbi +0 -284
  535. data/rbi/stripe/services/price_service.rbi +0 -546
  536. data/rbi/stripe/services/product_feature_service.rbi +0 -69
  537. data/rbi/stripe/services/product_service.rbi +0 -479
  538. data/rbi/stripe/services/promotion_code_service.rbi +0 -214
  539. data/rbi/stripe/services/quote_computed_upfront_line_items_service.rbi +0 -31
  540. data/rbi/stripe/services/quote_service.rbi +0 -686
  541. data/rbi/stripe/services/radar/early_fraud_warning_service.rbi +0 -85
  542. data/rbi/stripe/services/radar/value_list_item_service.rbi +0 -111
  543. data/rbi/stripe/services/radar/value_list_service.rbi +0 -143
  544. data/rbi/stripe/services/radar_service.rbi +0 -11
  545. data/rbi/stripe/services/refund_service.rbi +0 -185
  546. data/rbi/stripe/services/reporting/report_run_service.rbi +0 -135
  547. data/rbi/stripe/services/reporting/report_type_service.rbi +0 -35
  548. data/rbi/stripe/services/reporting_service.rbi +0 -10
  549. data/rbi/stripe/services/review_service.rbi +0 -84
  550. data/rbi/stripe/services/setup_attempt_service.rbi +0 -65
  551. data/rbi/stripe/services/setup_intent_service.rbi +0 -3596
  552. data/rbi/stripe/services/shipping_rate_service.rbi +0 -241
  553. data/rbi/stripe/services/sigma/scheduled_query_run_service.rbi +0 -46
  554. data/rbi/stripe/services/sigma_service.rbi +0 -9
  555. data/rbi/stripe/services/source_service.rbi +0 -663
  556. data/rbi/stripe/services/subscription_item_service.rbi +0 -324
  557. data/rbi/stripe/services/subscription_schedule_service.rbi +0 -1192
  558. data/rbi/stripe/services/subscription_service.rbi +0 -1596
  559. data/rbi/stripe/services/tax/calculation_line_item_service.rbi +0 -33
  560. data/rbi/stripe/services/tax/calculation_service.rbi +0 -230
  561. data/rbi/stripe/services/tax/registration_service.rbi +0 -1689
  562. data/rbi/stripe/services/tax/settings_service.rbi +0 -93
  563. data/rbi/stripe/services/tax/transaction_service.rbi +0 -146
  564. data/rbi/stripe/services/tax_code_service.rbi +0 -44
  565. data/rbi/stripe/services/tax_id_service.rbi +0 -112
  566. data/rbi/stripe/services/tax_rate_service.rbi +0 -185
  567. data/rbi/stripe/services/tax_service.rbi +0 -12
  568. data/rbi/stripe/services/terminal/configuration_service.rbi +0 -1120
  569. data/rbi/stripe/services/terminal/connection_token_service.rbi +0 -25
  570. data/rbi/stripe/services/terminal/location_service.rbi +0 -184
  571. data/rbi/stripe/services/terminal/reader_service.rbi +0 -344
  572. data/rbi/stripe/services/terminal_service.rbi +0 -12
  573. data/rbi/stripe/services/test_helpers/confirmation_token_service.rbi +0 -746
  574. data/rbi/stripe/services/test_helpers/customer_service.rbi +0 -33
  575. data/rbi/stripe/services/test_helpers/issuing/authorization_service.rbi +0 -848
  576. data/rbi/stripe/services/test_helpers/issuing/card_service.rbi +0 -76
  577. data/rbi/stripe/services/test_helpers/issuing/personalization_design_service.rbi +0 -69
  578. data/rbi/stripe/services/test_helpers/issuing/transaction_service.rbi +0 -711
  579. data/rbi/stripe/services/test_helpers/issuing_service.rbi +0 -14
  580. data/rbi/stripe/services/test_helpers/refund_service.rbi +0 -22
  581. data/rbi/stripe/services/test_helpers/terminal/reader_service.rbi +0 -62
  582. data/rbi/stripe/services/test_helpers/terminal_service.rbi +0 -11
  583. data/rbi/stripe/services/test_helpers/test_clock_service.rbi +0 -92
  584. data/rbi/stripe/services/test_helpers/treasury/inbound_transfer_service.rbi +0 -64
  585. data/rbi/stripe/services/test_helpers/treasury/outbound_payment_service.rbi +0 -125
  586. data/rbi/stripe/services/test_helpers/treasury/outbound_transfer_service.rbi +0 -125
  587. data/rbi/stripe/services/test_helpers/treasury/received_credit_service.rbi +0 -87
  588. data/rbi/stripe/services/test_helpers/treasury/received_debit_service.rbi +0 -87
  589. data/rbi/stripe/services/test_helpers/treasury_service.rbi +0 -15
  590. data/rbi/stripe/services/test_helpers_service.rbi +0 -15
  591. data/rbi/stripe/services/token_service.rbi +0 -1189
  592. data/rbi/stripe/services/topup_service.rbi +0 -176
  593. data/rbi/stripe/services/transfer_reversal_service.rbi +0 -101
  594. data/rbi/stripe/services/transfer_service.rbi +0 -152
  595. data/rbi/stripe/services/treasury/credit_reversal_service.rbi +0 -84
  596. data/rbi/stripe/services/treasury/debit_reversal_service.rbi +0 -88
  597. data/rbi/stripe/services/treasury/financial_account_features_service.rbi +0 -198
  598. data/rbi/stripe/services/treasury/financial_account_service.rbi +0 -562
  599. data/rbi/stripe/services/treasury/inbound_transfer_service.rbi +0 -117
  600. data/rbi/stripe/services/treasury/outbound_payment_service.rbi +0 -304
  601. data/rbi/stripe/services/treasury/outbound_transfer_service.rbi +0 -157
  602. data/rbi/stripe/services/treasury/received_credit_service.rbi +0 -72
  603. data/rbi/stripe/services/treasury/received_debit_service.rbi +0 -59
  604. data/rbi/stripe/services/treasury/transaction_entry_service.rbi +0 -111
  605. data/rbi/stripe/services/treasury/transaction_service.rbi +0 -122
  606. data/rbi/stripe/services/treasury_service.rbi +0 -18
  607. data/rbi/stripe/services/v1_services.rbi +0 -77
  608. data/rbi/stripe/services/v2/billing/meter_event_adjustment_service.rbi +0 -39
  609. data/rbi/stripe/services/v2/billing/meter_event_service.rbi +0 -42
  610. data/rbi/stripe/services/v2/billing/meter_event_session_service.rbi +0 -20
  611. data/rbi/stripe/services/v2/billing/meter_event_stream_service.rbi +0 -55
  612. data/rbi/stripe/services/v2/billing_service.rbi +0 -14
  613. data/rbi/stripe/services/v2/core/event_destination_service.rbi +0 -200
  614. data/rbi/stripe/services/v2/core/event_service.rbi +0 -38
  615. data/rbi/stripe/services/v2/core_service.rbi +0 -12
  616. data/rbi/stripe/services/v2_services.rbi +0 -10
  617. data/rbi/stripe/services/webhook_endpoint_service.rbi +0 -131
@@ -1,517 +0,0 @@
1
- # File generated from our OpenAPI spec
2
- # frozen_string_literal: true
3
-
4
- # typed: true
5
- module Stripe
6
- module Identity
7
- # A VerificationSession guides you through the process of collecting and verifying the identities
8
- # of your users. It contains details about the type of verification, such as what [verification
9
- # check](https://stripe.com/docs/identity/verification-checks) to perform. Only create one VerificationSession for
10
- # each verification in your system.
11
- #
12
- # A VerificationSession transitions through [multiple
13
- # statuses](https://stripe.com/docs/identity/how-sessions-work) throughout its lifetime as it progresses through
14
- # the verification flow. The VerificationSession contains the user's verified data after
15
- # verification checks are complete.
16
- #
17
- # Related guide: [The Verification Sessions API](https://stripe.com/docs/identity/verification-sessions)
18
- class VerificationSession < APIResource
19
- class LastError < Stripe::StripeObject
20
- # A short machine-readable string giving the reason for the verification or user-session failure.
21
- sig { returns(T.nilable(String)) }
22
- attr_reader :code
23
- # A message that explains the reason for verification or user-session failure.
24
- sig { returns(T.nilable(String)) }
25
- attr_reader :reason
26
- end
27
- class Options < Stripe::StripeObject
28
- class Document < Stripe::StripeObject
29
- # Array of strings of allowed identity document types. If the provided identity document isn’t one of the allowed types, the verification check will fail with a document_type_not_allowed error code.
30
- sig { returns(T::Array[String]) }
31
- attr_reader :allowed_types
32
- # Collect an ID number and perform an [ID number check](https://stripe.com/docs/identity/verification-checks?type=id-number) with the document’s extracted name and date of birth.
33
- sig { returns(T::Boolean) }
34
- attr_reader :require_id_number
35
- # Disable image uploads, identity document images have to be captured using the device’s camera.
36
- sig { returns(T::Boolean) }
37
- attr_reader :require_live_capture
38
- # Capture a face image and perform a [selfie check](https://stripe.com/docs/identity/verification-checks?type=selfie) comparing a photo ID and a picture of your user’s face. [Learn more](https://stripe.com/docs/identity/selfie).
39
- sig { returns(T::Boolean) }
40
- attr_reader :require_matching_selfie
41
- end
42
- class Email < Stripe::StripeObject
43
- # Request one time password verification of `provided_details.email`.
44
- sig { returns(T::Boolean) }
45
- attr_reader :require_verification
46
- end
47
- class IdNumber < Stripe::StripeObject; end
48
- class Phone < Stripe::StripeObject
49
- # Request one time password verification of `provided_details.phone`.
50
- sig { returns(T::Boolean) }
51
- attr_reader :require_verification
52
- end
53
- # Attribute for field document
54
- sig { returns(Document) }
55
- attr_reader :document
56
- # Attribute for field email
57
- sig { returns(Email) }
58
- attr_reader :email
59
- # Attribute for field id_number
60
- sig { returns(IdNumber) }
61
- attr_reader :id_number
62
- # Attribute for field phone
63
- sig { returns(Phone) }
64
- attr_reader :phone
65
- end
66
- class ProvidedDetails < Stripe::StripeObject
67
- # Email of user being verified
68
- sig { returns(String) }
69
- attr_reader :email
70
- # Phone number of user being verified
71
- sig { returns(String) }
72
- attr_reader :phone
73
- end
74
- class Redaction < Stripe::StripeObject
75
- # Indicates whether this object and its related objects have been redacted or not.
76
- sig { returns(String) }
77
- attr_reader :status
78
- end
79
- class VerifiedOutputs < Stripe::StripeObject
80
- class Address < Stripe::StripeObject
81
- # City, district, suburb, town, or village.
82
- sig { returns(T.nilable(String)) }
83
- attr_reader :city
84
- # Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
85
- sig { returns(T.nilable(String)) }
86
- attr_reader :country
87
- # Address line 1 (e.g., street, PO Box, or company name).
88
- sig { returns(T.nilable(String)) }
89
- attr_reader :line1
90
- # Address line 2 (e.g., apartment, suite, unit, or building).
91
- sig { returns(T.nilable(String)) }
92
- attr_reader :line2
93
- # ZIP or postal code.
94
- sig { returns(T.nilable(String)) }
95
- attr_reader :postal_code
96
- # State, county, province, or region.
97
- sig { returns(T.nilable(String)) }
98
- attr_reader :state
99
- end
100
- class Dob < Stripe::StripeObject
101
- # Numerical day between 1 and 31.
102
- sig { returns(T.nilable(Integer)) }
103
- attr_reader :day
104
- # Numerical month between 1 and 12.
105
- sig { returns(T.nilable(Integer)) }
106
- attr_reader :month
107
- # The four-digit year.
108
- sig { returns(T.nilable(Integer)) }
109
- attr_reader :year
110
- end
111
- # The user's verified address.
112
- sig { returns(T.nilable(Address)) }
113
- attr_reader :address
114
- # The user’s verified date of birth.
115
- sig { returns(T.nilable(Dob)) }
116
- attr_reader :dob
117
- # The user's verified email address
118
- sig { returns(T.nilable(String)) }
119
- attr_reader :email
120
- # The user's verified first name.
121
- sig { returns(T.nilable(String)) }
122
- attr_reader :first_name
123
- # The user's verified id number.
124
- sig { returns(T.nilable(String)) }
125
- attr_reader :id_number
126
- # The user's verified id number type.
127
- sig { returns(T.nilable(String)) }
128
- attr_reader :id_number_type
129
- # The user's verified last name.
130
- sig { returns(T.nilable(String)) }
131
- attr_reader :last_name
132
- # The user's verified phone number
133
- sig { returns(T.nilable(String)) }
134
- attr_reader :phone
135
- end
136
- # A string to reference this user. This can be a customer ID, a session ID, or similar, and can be used to reconcile this verification with your internal systems.
137
- sig { returns(T.nilable(String)) }
138
- attr_reader :client_reference_id
139
- # The short-lived client secret used by Stripe.js to [show a verification modal](https://stripe.com/docs/js/identity/modal) inside your app. This client secret expires after 24 hours and can only be used once. Don’t store it, log it, embed it in a URL, or expose it to anyone other than the user. Make sure that you have TLS enabled on any page that includes the client secret. Refer to our docs on [passing the client secret to the frontend](https://stripe.com/docs/identity/verification-sessions#client-secret) to learn more.
140
- sig { returns(T.nilable(String)) }
141
- attr_reader :client_secret
142
- # Time at which the object was created. Measured in seconds since the Unix epoch.
143
- sig { returns(Integer) }
144
- attr_reader :created
145
- # Unique identifier for the object.
146
- sig { returns(String) }
147
- attr_reader :id
148
- # If present, this property tells you the last error encountered when processing the verification.
149
- sig { returns(T.nilable(LastError)) }
150
- attr_reader :last_error
151
- # ID of the most recent VerificationReport. [Learn more about accessing detailed verification results.](https://stripe.com/docs/identity/verification-sessions#results)
152
- sig { returns(T.nilable(T.any(String, Stripe::Identity::VerificationReport))) }
153
- attr_reader :last_verification_report
154
- # Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
155
- sig { returns(T::Boolean) }
156
- attr_reader :livemode
157
- # 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.
158
- sig { returns(T::Hash[String, String]) }
159
- attr_reader :metadata
160
- # String representing the object's type. Objects of the same type share the same value.
161
- sig { returns(String) }
162
- attr_reader :object
163
- # A set of options for the session’s verification checks.
164
- sig { returns(T.nilable(Options)) }
165
- attr_reader :options
166
- # Details provided about the user being verified. These details may be shown to the user.
167
- sig { returns(T.nilable(ProvidedDetails)) }
168
- attr_reader :provided_details
169
- # Redaction status of this VerificationSession. If the VerificationSession is not redacted, this field will be null.
170
- sig { returns(T.nilable(Redaction)) }
171
- attr_reader :redaction
172
- # Customer ID
173
- sig { returns(T.nilable(String)) }
174
- attr_reader :related_customer
175
- # Status of this VerificationSession. [Learn more about the lifecycle of sessions](https://stripe.com/docs/identity/how-sessions-work).
176
- sig { returns(String) }
177
- attr_reader :status
178
- # The type of [verification check](https://stripe.com/docs/identity/verification-checks) to be performed.
179
- sig { returns(String) }
180
- attr_reader :type
181
- # The short-lived URL that you use to redirect a user to Stripe to submit their identity information. This URL expires after 48 hours and can only be used once. Don’t store it, log it, send it in emails or expose it to anyone other than the user. Refer to our docs on [verifying identity documents](https://stripe.com/docs/identity/verify-identity-documents?platform=web&type=redirect) to learn how to redirect users to Stripe.
182
- sig { returns(T.nilable(String)) }
183
- attr_reader :url
184
- # The configuration token of a verification flow from the dashboard.
185
- sig { returns(String) }
186
- attr_reader :verification_flow
187
- # The user’s verified data.
188
- sig { returns(T.nilable(VerifiedOutputs)) }
189
- attr_reader :verified_outputs
190
- class ListParams < Stripe::RequestParams
191
- class Created < Stripe::RequestParams
192
- # Minimum value to filter by (exclusive)
193
- sig { returns(T.nilable(Integer)) }
194
- attr_accessor :gt
195
- # Minimum value to filter by (inclusive)
196
- sig { returns(T.nilable(Integer)) }
197
- attr_accessor :gte
198
- # Maximum value to filter by (exclusive)
199
- sig { returns(T.nilable(Integer)) }
200
- attr_accessor :lt
201
- # Maximum value to filter by (inclusive)
202
- sig { returns(T.nilable(Integer)) }
203
- attr_accessor :lte
204
- sig {
205
- params(gt: T.nilable(Integer), gte: T.nilable(Integer), lt: T.nilable(Integer), lte: T.nilable(Integer)).void
206
- }
207
- def initialize(gt: nil, gte: nil, lt: nil, lte: nil); end
208
- end
209
- # A string to reference this user. This can be a customer ID, a session ID, or similar, and can be used to reconcile this verification with your internal systems.
210
- sig { returns(T.nilable(String)) }
211
- attr_accessor :client_reference_id
212
- # Only return VerificationSessions that were created during the given date interval.
213
- sig {
214
- returns(T.nilable(T.any(::Stripe::Identity::VerificationSession::ListParams::Created, Integer)))
215
- }
216
- attr_accessor :created
217
- # 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.
218
- sig { returns(T.nilable(String)) }
219
- attr_accessor :ending_before
220
- # Specifies which fields in the response should be expanded.
221
- sig { returns(T.nilable(T::Array[String])) }
222
- attr_accessor :expand
223
- # A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
224
- sig { returns(T.nilable(Integer)) }
225
- attr_accessor :limit
226
- # Attribute for param field related_customer
227
- sig { returns(T.nilable(String)) }
228
- attr_accessor :related_customer
229
- # 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.
230
- sig { returns(T.nilable(String)) }
231
- attr_accessor :starting_after
232
- # Only return VerificationSessions with this status. [Learn more about the lifecycle of sessions](https://stripe.com/docs/identity/how-sessions-work).
233
- sig { returns(T.nilable(String)) }
234
- attr_accessor :status
235
- sig {
236
- params(client_reference_id: T.nilable(String), created: T.nilable(T.any(::Stripe::Identity::VerificationSession::ListParams::Created, Integer)), ending_before: T.nilable(String), expand: T.nilable(T::Array[String]), limit: T.nilable(Integer), related_customer: T.nilable(String), starting_after: T.nilable(String), status: T.nilable(String)).void
237
- }
238
- def initialize(
239
- client_reference_id: nil,
240
- created: nil,
241
- ending_before: nil,
242
- expand: nil,
243
- limit: nil,
244
- related_customer: nil,
245
- starting_after: nil,
246
- status: nil
247
- ); end
248
- end
249
- class CreateParams < Stripe::RequestParams
250
- class Options < Stripe::RequestParams
251
- class Document < Stripe::RequestParams
252
- # Array of strings of allowed identity document types. If the provided identity document isn’t one of the allowed types, the verification check will fail with a document_type_not_allowed error code.
253
- sig { returns(T.nilable(T::Array[String])) }
254
- attr_accessor :allowed_types
255
- # Collect an ID number and perform an [ID number check](https://stripe.com/docs/identity/verification-checks?type=id-number) with the document’s extracted name and date of birth.
256
- sig { returns(T.nilable(T::Boolean)) }
257
- attr_accessor :require_id_number
258
- # Disable image uploads, identity document images have to be captured using the device’s camera.
259
- sig { returns(T.nilable(T::Boolean)) }
260
- attr_accessor :require_live_capture
261
- # Capture a face image and perform a [selfie check](https://stripe.com/docs/identity/verification-checks?type=selfie) comparing a photo ID and a picture of your user’s face. [Learn more](https://stripe.com/docs/identity/selfie).
262
- sig { returns(T.nilable(T::Boolean)) }
263
- attr_accessor :require_matching_selfie
264
- sig {
265
- params(allowed_types: T.nilable(T::Array[String]), require_id_number: T.nilable(T::Boolean), require_live_capture: T.nilable(T::Boolean), require_matching_selfie: T.nilable(T::Boolean)).void
266
- }
267
- def initialize(
268
- allowed_types: nil,
269
- require_id_number: nil,
270
- require_live_capture: nil,
271
- require_matching_selfie: nil
272
- ); end
273
- end
274
- # Options that apply to the [document check](https://stripe.com/docs/identity/verification-checks?type=document).
275
- sig {
276
- returns(T.nilable(T.nilable(T.any(String, ::Stripe::Identity::VerificationSession::CreateParams::Options::Document))))
277
- }
278
- attr_accessor :document
279
- sig {
280
- params(document: T.nilable(T.nilable(T.any(String, ::Stripe::Identity::VerificationSession::CreateParams::Options::Document)))).void
281
- }
282
- def initialize(document: nil); end
283
- end
284
- class ProvidedDetails < Stripe::RequestParams
285
- # Email of user being verified
286
- sig { returns(T.nilable(String)) }
287
- attr_accessor :email
288
- # Phone number of user being verified
289
- sig { returns(T.nilable(String)) }
290
- attr_accessor :phone
291
- sig { params(email: T.nilable(String), phone: T.nilable(String)).void }
292
- def initialize(email: nil, phone: nil); end
293
- end
294
- # A string to reference this user. This can be a customer ID, a session ID, or similar, and can be used to reconcile this verification with your internal systems.
295
- sig { returns(T.nilable(String)) }
296
- attr_accessor :client_reference_id
297
- # Specifies which fields in the response should be expanded.
298
- sig { returns(T.nilable(T::Array[String])) }
299
- attr_accessor :expand
300
- # 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`.
301
- sig { returns(T.nilable(T::Hash[String, String])) }
302
- attr_accessor :metadata
303
- # A set of options for the session’s verification checks.
304
- sig { returns(T.nilable(::Stripe::Identity::VerificationSession::CreateParams::Options)) }
305
- attr_accessor :options
306
- # Details provided about the user being verified. These details may be shown to the user.
307
- sig {
308
- returns(T.nilable(::Stripe::Identity::VerificationSession::CreateParams::ProvidedDetails))
309
- }
310
- attr_accessor :provided_details
311
- # Customer ID
312
- sig { returns(T.nilable(String)) }
313
- attr_accessor :related_customer
314
- # The URL that the user will be redirected to upon completing the verification flow.
315
- sig { returns(T.nilable(String)) }
316
- attr_accessor :return_url
317
- # The type of [verification check](https://stripe.com/docs/identity/verification-checks) to be performed. You must provide a `type` if not passing `verification_flow`.
318
- sig { returns(T.nilable(String)) }
319
- attr_accessor :type
320
- # The ID of a verification flow from the Dashboard. See https://docs.stripe.com/identity/verification-flows.
321
- sig { returns(T.nilable(String)) }
322
- attr_accessor :verification_flow
323
- sig {
324
- params(client_reference_id: T.nilable(String), expand: T.nilable(T::Array[String]), metadata: T.nilable(T::Hash[String, String]), options: T.nilable(::Stripe::Identity::VerificationSession::CreateParams::Options), provided_details: T.nilable(::Stripe::Identity::VerificationSession::CreateParams::ProvidedDetails), related_customer: T.nilable(String), return_url: T.nilable(String), type: T.nilable(String), verification_flow: T.nilable(String)).void
325
- }
326
- def initialize(
327
- client_reference_id: nil,
328
- expand: nil,
329
- metadata: nil,
330
- options: nil,
331
- provided_details: nil,
332
- related_customer: nil,
333
- return_url: nil,
334
- type: nil,
335
- verification_flow: nil
336
- ); end
337
- end
338
- class UpdateParams < Stripe::RequestParams
339
- class Options < Stripe::RequestParams
340
- class Document < Stripe::RequestParams
341
- # Array of strings of allowed identity document types. If the provided identity document isn’t one of the allowed types, the verification check will fail with a document_type_not_allowed error code.
342
- sig { returns(T.nilable(T::Array[String])) }
343
- attr_accessor :allowed_types
344
- # Collect an ID number and perform an [ID number check](https://stripe.com/docs/identity/verification-checks?type=id-number) with the document’s extracted name and date of birth.
345
- sig { returns(T.nilable(T::Boolean)) }
346
- attr_accessor :require_id_number
347
- # Disable image uploads, identity document images have to be captured using the device’s camera.
348
- sig { returns(T.nilable(T::Boolean)) }
349
- attr_accessor :require_live_capture
350
- # Capture a face image and perform a [selfie check](https://stripe.com/docs/identity/verification-checks?type=selfie) comparing a photo ID and a picture of your user’s face. [Learn more](https://stripe.com/docs/identity/selfie).
351
- sig { returns(T.nilable(T::Boolean)) }
352
- attr_accessor :require_matching_selfie
353
- sig {
354
- params(allowed_types: T.nilable(T::Array[String]), require_id_number: T.nilable(T::Boolean), require_live_capture: T.nilable(T::Boolean), require_matching_selfie: T.nilable(T::Boolean)).void
355
- }
356
- def initialize(
357
- allowed_types: nil,
358
- require_id_number: nil,
359
- require_live_capture: nil,
360
- require_matching_selfie: nil
361
- ); end
362
- end
363
- # Options that apply to the [document check](https://stripe.com/docs/identity/verification-checks?type=document).
364
- sig {
365
- returns(T.nilable(T.nilable(T.any(String, ::Stripe::Identity::VerificationSession::UpdateParams::Options::Document))))
366
- }
367
- attr_accessor :document
368
- sig {
369
- params(document: T.nilable(T.nilable(T.any(String, ::Stripe::Identity::VerificationSession::UpdateParams::Options::Document)))).void
370
- }
371
- def initialize(document: nil); end
372
- end
373
- class ProvidedDetails < Stripe::RequestParams
374
- # Email of user being verified
375
- sig { returns(T.nilable(String)) }
376
- attr_accessor :email
377
- # Phone number of user being verified
378
- sig { returns(T.nilable(String)) }
379
- attr_accessor :phone
380
- sig { params(email: T.nilable(String), phone: T.nilable(String)).void }
381
- def initialize(email: nil, phone: nil); end
382
- end
383
- # Specifies which fields in the response should be expanded.
384
- sig { returns(T.nilable(T::Array[String])) }
385
- attr_accessor :expand
386
- # 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`.
387
- sig { returns(T.nilable(T::Hash[String, String])) }
388
- attr_accessor :metadata
389
- # A set of options for the session’s verification checks.
390
- sig { returns(T.nilable(::Stripe::Identity::VerificationSession::UpdateParams::Options)) }
391
- attr_accessor :options
392
- # Details provided about the user being verified. These details may be shown to the user.
393
- sig {
394
- returns(T.nilable(::Stripe::Identity::VerificationSession::UpdateParams::ProvidedDetails))
395
- }
396
- attr_accessor :provided_details
397
- # The type of [verification check](https://stripe.com/docs/identity/verification-checks) to be performed.
398
- sig { returns(T.nilable(String)) }
399
- attr_accessor :type
400
- sig {
401
- params(expand: T.nilable(T::Array[String]), metadata: T.nilable(T::Hash[String, String]), options: T.nilable(::Stripe::Identity::VerificationSession::UpdateParams::Options), provided_details: T.nilable(::Stripe::Identity::VerificationSession::UpdateParams::ProvidedDetails), type: T.nilable(String)).void
402
- }
403
- def initialize(
404
- expand: nil,
405
- metadata: nil,
406
- options: nil,
407
- provided_details: nil,
408
- type: nil
409
- ); end
410
- end
411
- class CancelParams < Stripe::RequestParams
412
- # Specifies which fields in the response should be expanded.
413
- sig { returns(T.nilable(T::Array[String])) }
414
- attr_accessor :expand
415
- sig { params(expand: T.nilable(T::Array[String])).void }
416
- def initialize(expand: nil); end
417
- end
418
- class RedactParams < Stripe::RequestParams
419
- # Specifies which fields in the response should be expanded.
420
- sig { returns(T.nilable(T::Array[String])) }
421
- attr_accessor :expand
422
- sig { params(expand: T.nilable(T::Array[String])).void }
423
- def initialize(expand: nil); end
424
- end
425
- # A VerificationSession object can be canceled when it is in requires_input [status](https://stripe.com/docs/identity/how-sessions-work).
426
- #
427
- # Once canceled, future submission attempts are disabled. This cannot be undone. [Learn more](https://stripe.com/docs/identity/verification-sessions#cancel).
428
- sig {
429
- params(params: T.any(::Stripe::Identity::VerificationSession::CancelParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Identity::VerificationSession)
430
- }
431
- def cancel(params = {}, opts = {}); end
432
-
433
- # A VerificationSession object can be canceled when it is in requires_input [status](https://stripe.com/docs/identity/how-sessions-work).
434
- #
435
- # Once canceled, future submission attempts are disabled. This cannot be undone. [Learn more](https://stripe.com/docs/identity/verification-sessions#cancel).
436
- sig {
437
- params(session: String, params: T.any(::Stripe::Identity::VerificationSession::CancelParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Identity::VerificationSession)
438
- }
439
- def self.cancel(session, params = {}, opts = {}); end
440
-
441
- # Creates a VerificationSession object.
442
- #
443
- # After the VerificationSession is created, display a verification modal using the session client_secret or send your users to the session's url.
444
- #
445
- # If your API key is in test mode, verification checks won't actually process, though everything else will occur as if in live mode.
446
- #
447
- # Related guide: [Verify your users' identity documents](https://stripe.com/docs/identity/verify-identity-documents)
448
- sig {
449
- params(params: T.any(::Stripe::Identity::VerificationSession::CreateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Identity::VerificationSession)
450
- }
451
- def self.create(params = {}, opts = {}); end
452
-
453
- # Returns a list of VerificationSessions
454
- sig {
455
- params(params: T.any(::Stripe::Identity::VerificationSession::ListParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::ListObject)
456
- }
457
- def self.list(params = {}, opts = {}); end
458
-
459
- # Redact a VerificationSession to remove all collected information from Stripe. This will redact
460
- # the VerificationSession and all objects related to it, including VerificationReports, Events,
461
- # request logs, etc.
462
- #
463
- # A VerificationSession object can be redacted when it is in requires_input or verified
464
- # [status](https://stripe.com/docs/identity/how-sessions-work). Redacting a VerificationSession in requires_action
465
- # state will automatically cancel it.
466
- #
467
- # The redaction process may take up to four days. When the redaction process is in progress, the
468
- # VerificationSession's redaction.status field will be set to processing; when the process is
469
- # finished, it will change to redacted and an identity.verification_session.redacted event
470
- # will be emitted.
471
- #
472
- # Redaction is irreversible. Redacted objects are still accessible in the Stripe API, but all the
473
- # fields that contain personal data will be replaced by the string [redacted] or a similar
474
- # placeholder. The metadata field will also be erased. Redacted objects cannot be updated or
475
- # used for any purpose.
476
- #
477
- # [Learn more](https://stripe.com/docs/identity/verification-sessions#redact).
478
- sig {
479
- params(params: T.any(::Stripe::Identity::VerificationSession::RedactParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Identity::VerificationSession)
480
- }
481
- def redact(params = {}, opts = {}); end
482
-
483
- # Redact a VerificationSession to remove all collected information from Stripe. This will redact
484
- # the VerificationSession and all objects related to it, including VerificationReports, Events,
485
- # request logs, etc.
486
- #
487
- # A VerificationSession object can be redacted when it is in requires_input or verified
488
- # [status](https://stripe.com/docs/identity/how-sessions-work). Redacting a VerificationSession in requires_action
489
- # state will automatically cancel it.
490
- #
491
- # The redaction process may take up to four days. When the redaction process is in progress, the
492
- # VerificationSession's redaction.status field will be set to processing; when the process is
493
- # finished, it will change to redacted and an identity.verification_session.redacted event
494
- # will be emitted.
495
- #
496
- # Redaction is irreversible. Redacted objects are still accessible in the Stripe API, but all the
497
- # fields that contain personal data will be replaced by the string [redacted] or a similar
498
- # placeholder. The metadata field will also be erased. Redacted objects cannot be updated or
499
- # used for any purpose.
500
- #
501
- # [Learn more](https://stripe.com/docs/identity/verification-sessions#redact).
502
- sig {
503
- params(session: String, params: T.any(::Stripe::Identity::VerificationSession::RedactParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Identity::VerificationSession)
504
- }
505
- def self.redact(session, params = {}, opts = {}); end
506
-
507
- # Updates a VerificationSession object.
508
- #
509
- # When the session status is requires_input, you can use this method to update the
510
- # verification check and options.
511
- sig {
512
- params(session: String, params: T.any(::Stripe::Identity::VerificationSession::UpdateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Identity::VerificationSession)
513
- }
514
- def self.update(session, params = {}, opts = {}); end
515
- end
516
- end
517
- end