stripe 20.1.0 → 20.2.0.pre.beta.1

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 (507) hide show
  1. checksums.yaml +4 -4
  2. data/lib/stripe/api_requestor.rb +4 -0
  3. data/lib/stripe/api_version.rb +2 -2
  4. data/lib/stripe/errors.rb +6 -0
  5. data/lib/stripe/event_types.rb +193 -0
  6. data/lib/stripe/events/unknown_event_notification.rb +1 -0
  7. data/lib/stripe/events/v2_core_account_including_configuration_money_manager_capability_status_updated_event.rb +63 -0
  8. data/lib/stripe/events/v2_core_account_including_configuration_money_manager_updated_event.rb +44 -0
  9. data/lib/stripe/events/v2_core_approval_request_approved_event.rb +44 -0
  10. data/lib/stripe/events/v2_core_approval_request_canceled_event.rb +44 -0
  11. data/lib/stripe/events/v2_core_approval_request_created_event.rb +44 -0
  12. data/lib/stripe/events/v2_core_approval_request_expired_event.rb +44 -0
  13. data/lib/stripe/events/v2_core_approval_request_failed_event.rb +44 -0
  14. data/lib/stripe/events/v2_core_approval_request_rejected_event.rb +44 -0
  15. data/lib/stripe/events/v2_core_approval_request_succeeded_event.rb +44 -0
  16. data/lib/stripe/events/v2_core_batch_job_batch_failed_event.rb +44 -0
  17. data/lib/stripe/events/v2_core_batch_job_canceled_event.rb +44 -0
  18. data/lib/stripe/events/v2_core_batch_job_completed_event.rb +44 -0
  19. data/lib/stripe/events/v2_core_batch_job_created_event.rb +44 -0
  20. data/lib/stripe/events/v2_core_batch_job_ready_for_upload_event.rb +44 -0
  21. data/lib/stripe/events/v2_core_batch_job_timeout_event.rb +44 -0
  22. data/lib/stripe/events/v2_core_batch_job_updated_event.rb +44 -0
  23. data/lib/stripe/events/v2_core_batch_job_upload_timeout_event.rb +44 -0
  24. data/lib/stripe/events/v2_core_batch_job_validating_event.rb +44 -0
  25. data/lib/stripe/events/v2_core_batch_job_validation_failed_event.rb +44 -0
  26. data/lib/stripe/events/v2_core_health_event_generation_failure_resolved_event.rb +78 -0
  27. data/lib/stripe/events/v2_data_query_run_created_event.rb +44 -0
  28. data/lib/stripe/events/v2_data_query_run_failed_event.rb +44 -0
  29. data/lib/stripe/events/v2_data_query_run_succeeded_event.rb +44 -0
  30. data/lib/stripe/events/v2_data_query_run_updated_event.rb +44 -0
  31. data/lib/stripe/events/v2_data_report_run_created_event.rb +44 -0
  32. data/lib/stripe/events/v2_data_report_run_failed_event.rb +44 -0
  33. data/lib/stripe/events/v2_data_report_run_succeeded_event.rb +44 -0
  34. data/lib/stripe/events/v2_data_report_run_updated_event.rb +44 -0
  35. data/lib/stripe/events/v2_data_reporting_query_run_created_event.rb +44 -0
  36. data/lib/stripe/events/v2_data_reporting_query_run_failed_event.rb +44 -0
  37. data/lib/stripe/events/v2_data_reporting_query_run_succeeded_event.rb +44 -0
  38. data/lib/stripe/events/v2_data_reporting_query_run_updated_event.rb +44 -0
  39. data/lib/stripe/events/v2_extend_workflow_run_failed_event.rb +75 -0
  40. data/lib/stripe/events/v2_extend_workflow_run_started_event.rb +44 -0
  41. data/lib/stripe/events/v2_extend_workflow_run_succeeded_event.rb +44 -0
  42. data/lib/stripe/events/v2_money_management_outbound_transfer_canceled_event.rb +44 -0
  43. data/lib/stripe/events/v2_money_management_outbound_transfer_created_event.rb +44 -0
  44. data/lib/stripe/events/v2_money_management_outbound_transfer_failed_event.rb +44 -0
  45. data/lib/stripe/events/v2_money_management_outbound_transfer_posted_event.rb +44 -0
  46. data/lib/stripe/events/v2_money_management_outbound_transfer_returned_event.rb +44 -0
  47. data/lib/stripe/events/v2_money_management_outbound_transfer_under_review_event.rb +44 -0
  48. data/lib/stripe/events/v2_money_management_outbound_transfer_updated_event.rb +44 -0
  49. data/lib/stripe/events/v2_money_management_received_debit_canceled_event.rb +44 -0
  50. data/lib/stripe/events/v2_money_management_received_debit_failed_event.rb +44 -0
  51. data/lib/stripe/events/v2_money_management_received_debit_pending_event.rb +44 -0
  52. data/lib/stripe/events/v2_money_management_received_debit_succeeded_event.rb +44 -0
  53. data/lib/stripe/events/v2_money_management_received_debit_updated_event.rb +44 -0
  54. data/lib/stripe/events/v2_orchestrated_commerce_agreement_confirmed_event.rb +97 -0
  55. data/lib/stripe/events/v2_orchestrated_commerce_agreement_created_event.rb +97 -0
  56. data/lib/stripe/events/v2_orchestrated_commerce_agreement_partially_confirmed_event.rb +97 -0
  57. data/lib/stripe/events/v2_orchestrated_commerce_agreement_terminated_event.rb +97 -0
  58. data/lib/stripe/events/v2_signals_account_evaluation_complete_event.rb +44 -0
  59. data/lib/stripe/events/v2_signals_account_signal_fraudulent_merchant_ready_event.rb +44 -0
  60. data/lib/stripe/events/v2_signals_account_signal_fraudulent_website_ready_event.rb +44 -0
  61. data/lib/stripe/object_types.rb +53 -0
  62. data/lib/stripe/params/account_create_params.rb +299 -1
  63. data/lib/stripe/params/account_notice_list_params.rb +25 -0
  64. data/lib/stripe/params/account_notice_retrieve_params.rb +13 -0
  65. data/lib/stripe/params/account_notice_update_params.rb +36 -0
  66. data/lib/stripe/params/account_session_create_params.rb +191 -0
  67. data/lib/stripe/params/account_update_params.rb +261 -0
  68. data/lib/stripe/params/balance_settings_update_params.rb +9 -1
  69. data/lib/stripe/params/billing/analytics/meter_usage_retrieve_params.rb +65 -0
  70. data/lib/stripe/params/capital/financing_offer_list_params.rb +58 -0
  71. data/lib/stripe/params/capital/financing_offer_mark_delivered_params.rb +15 -0
  72. data/lib/stripe/params/capital/financing_offer_retrieve_params.rb +15 -0
  73. data/lib/stripe/params/capital/financing_summary_retrieve_params.rb +15 -0
  74. data/lib/stripe/params/capital/financing_transaction_list_params.rb +45 -0
  75. data/lib/stripe/params/capital/financing_transaction_retrieve_params.rb +15 -0
  76. data/lib/stripe/params/charge_capture_params.rb +1646 -0
  77. data/lib/stripe/params/charge_update_params.rb +1646 -0
  78. data/lib/stripe/params/checkout/session_create_params.rb +87 -3
  79. data/lib/stripe/params/checkout/session_update_params.rb +161 -1
  80. data/lib/stripe/params/confirmation_token_create_params.rb +92 -0
  81. data/lib/stripe/params/coupon_create_params.rb +17 -1
  82. data/lib/stripe/params/customer_session_create_params.rb +32 -1
  83. data/lib/stripe/params/external_account_create_params.rb +134 -0
  84. data/lib/stripe/params/external_account_delete_params.rb +6 -0
  85. data/lib/stripe/params/external_account_list_params.rb +25 -0
  86. data/lib/stripe/params/external_account_retrieve_params.rb +13 -0
  87. data/lib/stripe/params/external_account_update_params.rb +91 -0
  88. data/lib/stripe/params/financial_connections/account_inferred_balance_list_params.rb +24 -0
  89. data/lib/stripe/params/financial_connections/authorization_retrieve_params.rb +15 -0
  90. data/lib/stripe/params/financial_connections/institution_list_params.rb +24 -0
  91. data/lib/stripe/params/financial_connections/institution_retrieve_params.rb +15 -0
  92. data/lib/stripe/params/financial_connections/session_create_params.rb +38 -1
  93. data/lib/stripe/params/fx_quote_create_params.rb +73 -0
  94. data/lib/stripe/params/fx_quote_list_params.rb +22 -0
  95. data/lib/stripe/params/fx_quote_retrieve_params.rb +13 -0
  96. data/lib/stripe/params/invoice_add_lines_params.rb +33 -1
  97. data/lib/stripe/params/invoice_attach_payment_params.rb +43 -1
  98. data/lib/stripe/params/invoice_create_params.rb +64 -2
  99. data/lib/stripe/params/invoice_create_preview_params.rb +772 -9
  100. data/lib/stripe/params/invoice_detach_payment_params.rb +16 -0
  101. data/lib/stripe/params/invoice_item_create_params.rb +33 -1
  102. data/lib/stripe/params/invoice_item_update_params.rb +33 -1
  103. data/lib/stripe/params/invoice_line_item_update_params.rb +33 -1
  104. data/lib/stripe/params/invoice_update_lines_params.rb +33 -1
  105. data/lib/stripe/params/invoice_update_params.rb +64 -2
  106. data/lib/stripe/params/issuing/cardholder_create_params.rb +2 -1
  107. data/lib/stripe/params/issuing/cardholder_update_params.rb +4 -0
  108. data/lib/stripe/params/issuing/credit_underwriting_record_correct_params.rb +163 -0
  109. data/lib/stripe/params/issuing/credit_underwriting_record_create_from_application_params.rb +50 -0
  110. data/lib/stripe/params/issuing/credit_underwriting_record_create_from_proactive_review_params.rb +128 -0
  111. data/lib/stripe/params/issuing/credit_underwriting_record_list_params.rb +24 -0
  112. data/lib/stripe/params/issuing/credit_underwriting_record_report_decision_params.rb +86 -0
  113. data/lib/stripe/params/issuing/credit_underwriting_record_retrieve_params.rb +15 -0
  114. data/lib/stripe/params/issuing/dispute_settlement_detail_list_params.rb +33 -0
  115. data/lib/stripe/params/issuing/dispute_settlement_detail_retrieve_params.rb +15 -0
  116. data/lib/stripe/params/issuing/fraud_liability_debit_list_params.rb +44 -0
  117. data/lib/stripe/params/issuing/fraud_liability_debit_retrieve_params.rb +15 -0
  118. data/lib/stripe/params/issuing/transaction_list_params.rb +4 -0
  119. data/lib/stripe/params/mandate_list_params.rb +39 -0
  120. data/lib/stripe/params/margin_create_params.rb +25 -0
  121. data/lib/stripe/params/margin_list_params.rb +25 -0
  122. data/lib/stripe/params/margin_retrieve_params.rb +13 -0
  123. data/lib/stripe/params/margin_update_params.rb +22 -0
  124. data/lib/stripe/params/order_create_params.rb +2083 -0
  125. data/lib/stripe/params/order_list_params.rb +25 -0
  126. data/lib/stripe/params/order_retrieve_params.rb +13 -0
  127. data/lib/stripe/params/order_submit_params.rb +16 -0
  128. data/lib/stripe/params/order_update_params.rb +2087 -0
  129. data/lib/stripe/params/payment_intent_capture_params.rb +1643 -1
  130. data/lib/stripe/params/payment_intent_confirm_params.rb +3038 -85
  131. data/lib/stripe/params/payment_intent_create_params.rb +3050 -97
  132. data/lib/stripe/params/payment_intent_decrement_authorization_params.rb +297 -0
  133. data/lib/stripe/params/payment_intent_increment_authorization_params.rb +37 -0
  134. data/lib/stripe/params/payment_intent_trigger_action_params.rb +27 -0
  135. data/lib/stripe/params/payment_intent_update_params.rb +3039 -55
  136. data/lib/stripe/params/payment_method_configuration_create_params.rb +105 -0
  137. data/lib/stripe/params/payment_method_configuration_update_params.rb +105 -0
  138. data/lib/stripe/params/payment_method_create_params.rb +88 -0
  139. data/lib/stripe/params/payment_plan_create_params.rb +128 -0
  140. data/lib/stripe/params/payment_plan_list_params.rb +25 -0
  141. data/lib/stripe/params/payment_plan_retrieve_params.rb +13 -0
  142. data/lib/stripe/params/payment_plan_update_params.rb +105 -0
  143. data/lib/stripe/params/price_update_params.rb +19 -0
  144. data/lib/stripe/params/privacy/redaction_job_cancel_params.rb +15 -0
  145. data/lib/stripe/params/privacy/redaction_job_create_params.rb +67 -0
  146. data/lib/stripe/params/privacy/redaction_job_list_params.rb +27 -0
  147. data/lib/stripe/params/privacy/redaction_job_retrieve_params.rb +15 -0
  148. data/lib/stripe/params/privacy/redaction_job_run_params.rb +15 -0
  149. data/lib/stripe/params/privacy/redaction_job_update_params.rb +18 -0
  150. data/lib/stripe/params/privacy/redaction_job_validate_params.rb +15 -0
  151. data/lib/stripe/params/privacy/redaction_job_validation_error_list_params.rb +24 -0
  152. data/lib/stripe/params/quote_create_params.rb +809 -3
  153. data/lib/stripe/params/quote_line_list_params.rb +22 -0
  154. data/lib/stripe/params/quote_list_lines_params.rb +22 -0
  155. data/lib/stripe/params/quote_list_params.rb +4 -0
  156. data/lib/stripe/params/quote_list_preview_invoice_lines_params.rb +22 -0
  157. data/lib/stripe/params/quote_mark_draft_params.rb +13 -0
  158. data/lib/stripe/params/quote_mark_stale_params.rb +16 -0
  159. data/lib/stripe/params/quote_preview_invoice_list_params.rb +22 -0
  160. data/lib/stripe/params/quote_preview_subscription_schedule_list_params.rb +22 -0
  161. data/lib/stripe/params/quote_reestimate_params.rb +13 -0
  162. data/lib/stripe/params/quote_update_params.rb +817 -4
  163. data/lib/stripe/params/radar/billing_evaluation_create_params.rb +231 -0
  164. data/lib/stripe/params/reserve/hold_list_params.rb +53 -0
  165. data/lib/stripe/params/reserve/hold_retrieve_params.rb +15 -0
  166. data/lib/stripe/params/reserve/plan_list_params.rb +37 -0
  167. data/lib/stripe/params/reserve/plan_retrieve_params.rb +15 -0
  168. data/lib/stripe/params/reserve/release_list_params.rb +41 -0
  169. data/lib/stripe/params/reserve/release_retrieve_params.rb +15 -0
  170. data/lib/stripe/params/setup_intent_confirm_params.rb +122 -3
  171. data/lib/stripe/params/setup_intent_create_params.rb +122 -3
  172. data/lib/stripe/params/setup_intent_update_params.rb +122 -3
  173. data/lib/stripe/params/shared_payment/granted_token_create_params.rb +47 -0
  174. data/lib/stripe/params/shared_payment/granted_token_retrieve_params.rb +15 -0
  175. data/lib/stripe/params/shared_payment/granted_token_revoke_params.rb +15 -0
  176. data/lib/stripe/params/shared_payment/issued_token_create_params.rb +71 -0
  177. data/lib/stripe/params/shared_payment/issued_token_retrieve_params.rb +15 -0
  178. data/lib/stripe/params/shared_payment/issued_token_revoke_params.rb +15 -0
  179. data/lib/stripe/params/subscription_create_params.rb +133 -6
  180. data/lib/stripe/params/subscription_item_create_params.rb +50 -3
  181. data/lib/stripe/params/subscription_item_update_params.rb +33 -2
  182. data/lib/stripe/params/subscription_schedule_amend_params.rb +578 -0
  183. data/lib/stripe/params/subscription_schedule_create_params.rb +167 -5
  184. data/lib/stripe/params/subscription_schedule_update_params.rb +167 -5
  185. data/lib/stripe/params/subscription_update_params.rb +116 -5
  186. data/lib/stripe/params/tax/form_list_params.rb +51 -0
  187. data/lib/stripe/params/tax/form_pdf_params.rb +15 -0
  188. data/lib/stripe/params/tax/form_retrieve_params.rb +15 -0
  189. data/lib/stripe/params/tax/registration_create_params.rb +13 -1
  190. data/lib/stripe/params/terminal/reader_collected_data_retrieve_params.rb +15 -0
  191. data/lib/stripe/params/test_helpers/confirmation_token_create_params.rb +92 -0
  192. data/lib/stripe/params/test_helpers/shared_payment/granted_token_create_params.rb +49 -0
  193. data/lib/stripe/params/test_helpers/shared_payment/granted_token_revoke_params.rb +17 -0
  194. data/lib/stripe/params/test_helpers/treasury/received_credit_create_params.rb +25 -1
  195. data/lib/stripe/params/test_helpers/treasury/received_debit_create_params.rb +25 -1
  196. data/lib/stripe/params/transfer_create_params.rb +4 -0
  197. data/lib/stripe/params/treasury/financial_account_create_params.rb +8 -1
  198. data/lib/stripe/params/treasury/financial_account_features_update_params.rb +4 -1
  199. data/lib/stripe/params/treasury/financial_account_update_features_params.rb +4 -1
  200. data/lib/stripe/params/treasury/financial_account_update_params.rb +8 -1
  201. data/lib/stripe/params/treasury/outbound_payment_create_params.rb +19 -0
  202. data/lib/stripe/params/treasury/outbound_transfer_create_params.rb +24 -0
  203. data/lib/stripe/params/treasury/received_credit_create_params.rb +25 -1
  204. data/lib/stripe/params/treasury/received_debit_create_params.rb +25 -1
  205. data/lib/stripe/params/v2/billing/bill_setting_create_params.rb +74 -0
  206. data/lib/stripe/params/v2/billing/bill_setting_list_params.rb +21 -0
  207. data/lib/stripe/params/v2/billing/bill_setting_retrieve_params.rb +10 -0
  208. data/lib/stripe/params/v2/billing/bill_setting_update_params.rb +80 -0
  209. data/lib/stripe/params/v2/billing/bill_settings/version_list_params.rb +19 -0
  210. data/lib/stripe/params/v2/billing/bill_settings/version_retrieve_params.rb +12 -0
  211. data/lib/stripe/params/v2/billing/cadence_cancel_params.rb +10 -0
  212. data/lib/stripe/params/v2/billing/cadence_create_params.rb +253 -0
  213. data/lib/stripe/params/v2/billing/cadence_list_params.rb +43 -0
  214. data/lib/stripe/params/v2/billing/cadence_retrieve_params.rb +17 -0
  215. data/lib/stripe/params/v2/billing/cadence_update_params.rb +75 -0
  216. data/lib/stripe/params/v2/billing/collection_setting_create_params.rb +257 -0
  217. data/lib/stripe/params/v2/billing/collection_setting_list_params.rb +21 -0
  218. data/lib/stripe/params/v2/billing/collection_setting_retrieve_params.rb +10 -0
  219. data/lib/stripe/params/v2/billing/collection_setting_update_params.rb +263 -0
  220. data/lib/stripe/params/v2/billing/collection_settings/version_list_params.rb +19 -0
  221. data/lib/stripe/params/v2/billing/collection_settings/version_retrieve_params.rb +12 -0
  222. data/lib/stripe/params/v2/billing/profile_create_params.rb +37 -0
  223. data/lib/stripe/params/v2/billing/profile_list_params.rb +40 -0
  224. data/lib/stripe/params/v2/billing/profile_retrieve_params.rb +10 -0
  225. data/lib/stripe/params/v2/billing/profile_update_params.rb +35 -0
  226. data/lib/stripe/params/v2/core/account_create_params.rb +392 -5
  227. data/lib/stripe/params/v2/core/account_token_create_params.rb +29 -1
  228. data/lib/stripe/params/v2/core/account_update_params.rb +376 -4
  229. data/lib/stripe/params/v2/core/approval_request_cancel_params.rb +10 -0
  230. data/lib/stripe/params/v2/core/approval_request_list_params.rb +47 -0
  231. data/lib/stripe/params/v2/core/approval_request_retrieve_params.rb +10 -0
  232. data/lib/stripe/params/v2/core/approval_request_update_params.rb +17 -0
  233. data/lib/stripe/params/v2/core/batch_job_cancel_params.rb +10 -0
  234. data/lib/stripe/params/v2/core/batch_job_create_params.rb +53 -0
  235. data/lib/stripe/params/v2/core/batch_job_retrieve_params.rb +10 -0
  236. data/lib/stripe/params/v2/core/vault/gb_bank_account_create_params.rb +21 -0
  237. data/lib/stripe/params/v2/data/query_run_create_params.rb +50 -0
  238. data/lib/stripe/params/v2/data/query_run_retrieve_params.rb +23 -0
  239. data/lib/stripe/params/v2/data/report_list_params.rb +23 -0
  240. data/lib/stripe/params/v2/data/report_retrieve_params.rb +17 -0
  241. data/lib/stripe/params/v2/data/report_run_create_params.rb +48 -0
  242. data/lib/stripe/params/v2/data/report_run_retrieve_params.rb +23 -0
  243. data/lib/stripe/params/v2/data/reporting/query_run_create_params.rb +31 -0
  244. data/lib/stripe/params/v2/data/reporting/query_run_retrieve_params.rb +12 -0
  245. data/lib/stripe/params/v2/data/schema_list_params.rb +26 -0
  246. data/lib/stripe/params/v2/data/schema_retrieve_params.rb +10 -0
  247. data/lib/stripe/params/v2/extend/workflow_invoke_params.rb +17 -0
  248. data/lib/stripe/params/v2/extend/workflow_list_params.rb +21 -0
  249. data/lib/stripe/params/v2/extend/workflow_retrieve_params.rb +10 -0
  250. data/lib/stripe/params/v2/extend/workflow_run_list_params.rb +23 -0
  251. data/lib/stripe/params/v2/extend/workflow_run_retrieve_params.rb +10 -0
  252. data/lib/stripe/params/v2/iam/activity_log_list_params.rb +23 -0
  253. data/lib/stripe/params/v2/iam/activity_log_retrieve_params.rb +10 -0
  254. data/lib/stripe/params/v2/money_management/financial_account_close_params.rb +30 -0
  255. data/lib/stripe/params/v2/money_management/financial_account_create_params.rb +35 -0
  256. data/lib/stripe/params/v2/money_management/outbound_payment_create_params.rb +21 -0
  257. data/lib/stripe/params/v2/money_management/outbound_payment_quote_create_params.rb +113 -0
  258. data/lib/stripe/params/v2/money_management/outbound_payment_quote_retrieve_params.rb +10 -0
  259. data/lib/stripe/params/v2/money_management/outbound_setup_intent_create_params.rb +40 -1
  260. data/lib/stripe/params/v2/money_management/outbound_setup_intent_update_params.rb +22 -1
  261. data/lib/stripe/params/v2/money_management/outbound_transfer_cancel_params.rb +10 -0
  262. data/lib/stripe/params/v2/money_management/outbound_transfer_create_params.rb +112 -0
  263. data/lib/stripe/params/v2/money_management/outbound_transfer_list_params.rb +48 -0
  264. data/lib/stripe/params/v2/money_management/outbound_transfer_retrieve_params.rb +10 -0
  265. data/lib/stripe/params/v2/money_management/payout_method_disable_params.rb +10 -0
  266. data/lib/stripe/params/v2/money_management/received_debit_list_params.rb +17 -0
  267. data/lib/stripe/params/v2/money_management/received_debit_retrieve_params.rb +10 -0
  268. data/lib/stripe/params/v2/money_management/test_helpers/financial_address_generate_microdeposits_params.rb +12 -0
  269. data/lib/stripe/params/v2/network/business_profile_me_params.rb +10 -0
  270. data/lib/stripe/params/v2/network/business_profile_retrieve_params.rb +10 -0
  271. data/lib/stripe/params/v2/orchestrated_commerce/agreement_confirm_params.rb +10 -0
  272. data/lib/stripe/params/v2/orchestrated_commerce/agreement_create_params.rb +17 -0
  273. data/lib/stripe/params/v2/orchestrated_commerce/agreement_list_params.rb +20 -0
  274. data/lib/stripe/params/v2/orchestrated_commerce/agreement_retrieve_params.rb +10 -0
  275. data/lib/stripe/params/v2/orchestrated_commerce/agreement_terminate_params.rb +10 -0
  276. data/lib/stripe/params/v2/signals/account_activity_create_params.rb +200 -0
  277. data/lib/stripe/params/v2/signals/account_activity_delete_params.rb +10 -0
  278. data/lib/stripe/params/v2/signals/account_activity_retrieve_params.rb +10 -0
  279. data/lib/stripe/params/v2/signals/account_evaluation_create_params.rb +192 -0
  280. data/lib/stripe/params/v2/signals/account_evaluation_retrieve_params.rb +10 -0
  281. data/lib/stripe/params/v2/signals/account_signal_list_params.rb +35 -0
  282. data/lib/stripe/params/v2/signals/account_signal_retrieve_params.rb +10 -0
  283. data/lib/stripe/params.rb +364 -0
  284. data/lib/stripe/resources/account.rb +176 -1
  285. data/lib/stripe/resources/account_notice.rb +94 -0
  286. data/lib/stripe/resources/account_session.rb +81 -0
  287. data/lib/stripe/resources/balance.rb +83 -0
  288. data/lib/stripe/resources/balance_settings.rb +4 -0
  289. data/lib/stripe/resources/billing/alert_triggered.rb +4 -0
  290. data/lib/stripe/resources/billing/analytics/meter_usage.rb +33 -0
  291. data/lib/stripe/resources/billing/analytics/meter_usage_row.rb +38 -0
  292. data/lib/stripe/resources/capital/financing_offer.rb +144 -0
  293. data/lib/stripe/resources/capital/financing_summary.rb +82 -0
  294. data/lib/stripe/resources/capital/financing_transaction.rb +99 -0
  295. data/lib/stripe/resources/card.rb +18 -1
  296. data/lib/stripe/resources/charge.rb +227 -1
  297. data/lib/stripe/resources/checkout/session.rb +91 -3
  298. data/lib/stripe/resources/confirmation_token.rb +131 -0
  299. data/lib/stripe/resources/coupon.rb +26 -1
  300. data/lib/stripe/resources/credit_note_line_item.rb +18 -0
  301. data/lib/stripe/resources/customer.rb +16 -0
  302. data/lib/stripe/resources/customer_session.rb +36 -0
  303. data/lib/stripe/resources/dispute.rb +18 -0
  304. data/lib/stripe/resources/event.rb +64 -1
  305. data/lib/stripe/resources/financial_connections/account.rb +45 -1
  306. data/lib/stripe/resources/financial_connections/account_inferred_balance.rb +35 -0
  307. data/lib/stripe/resources/financial_connections/authorization.rb +24 -1
  308. data/lib/stripe/resources/financial_connections/institution.rb +127 -0
  309. data/lib/stripe/resources/financial_connections/session.rb +92 -0
  310. data/lib/stripe/resources/fx_quote.rb +149 -0
  311. data/lib/stripe/resources/invoice.rb +106 -1
  312. data/lib/stripe/resources/invoice_item.rb +2 -0
  313. data/lib/stripe/resources/invoice_line_item.rb +40 -0
  314. data/lib/stripe/resources/issuing/authorization.rb +16 -0
  315. data/lib/stripe/resources/issuing/card.rb +16 -0
  316. data/lib/stripe/resources/issuing/cardholder.rb +16 -0
  317. data/lib/stripe/resources/issuing/credit_underwriting_record.rb +263 -0
  318. data/lib/stripe/resources/issuing/dispute.rb +16 -1
  319. data/lib/stripe/resources/issuing/dispute_settlement_detail.rb +71 -0
  320. data/lib/stripe/resources/issuing/fraud_liability_debit.rb +51 -0
  321. data/lib/stripe/resources/issuing/settlement.rb +61 -0
  322. data/lib/stripe/resources/issuing/transaction.rb +18 -0
  323. data/lib/stripe/resources/line_item.rb +42 -0
  324. data/lib/stripe/resources/mandate.rb +12 -0
  325. data/lib/stripe/resources/margin.rb +64 -0
  326. data/lib/stripe/resources/order.rb +927 -0
  327. data/lib/stripe/resources/payment_attempt_record.rb +177 -1
  328. data/lib/stripe/resources/payment_intent.rb +1588 -10
  329. data/lib/stripe/resources/payment_method.rb +151 -0
  330. data/lib/stripe/resources/payment_method_configuration.rb +170 -0
  331. data/lib/stripe/resources/payment_plan.rb +213 -0
  332. data/lib/stripe/resources/payment_record.rb +177 -1
  333. data/lib/stripe/resources/price.rb +20 -0
  334. data/lib/stripe/resources/privacy/redaction_job.rb +189 -0
  335. data/lib/stripe/resources/privacy/redaction_job_validation_error.rb +49 -0
  336. data/lib/stripe/resources/quote.rb +569 -2
  337. data/lib/stripe/resources/quote_line.rb +525 -0
  338. data/lib/stripe/resources/quote_preview_invoice.rb +1241 -0
  339. data/lib/stripe/resources/quote_preview_subscription_schedule.rb +968 -0
  340. data/lib/stripe/resources/radar/billing_evaluation.rb +281 -0
  341. data/lib/stripe/resources/radar/value_list_item.rb +15 -1
  342. data/lib/stripe/resources/refund.rb +18 -0
  343. data/lib/stripe/resources/reserve/hold.rb +7 -0
  344. data/lib/stripe/resources/reserve/plan.rb +7 -0
  345. data/lib/stripe/resources/reserve/release.rb +12 -0
  346. data/lib/stripe/resources/setup_attempt.rb +35 -0
  347. data/lib/stripe/resources/setup_intent.rb +38 -1
  348. data/lib/stripe/resources/shared_payment/granted_token.rb +681 -0
  349. data/lib/stripe/resources/shared_payment/issued_token.rb +310 -0
  350. data/lib/stripe/resources/source.rb +54 -0
  351. data/lib/stripe/resources/subscription.rb +73 -0
  352. data/lib/stripe/resources/subscription_item.rb +22 -1
  353. data/lib/stripe/resources/subscription_schedule.rb +198 -3
  354. data/lib/stripe/resources/tax/form.rb +264 -0
  355. data/lib/stripe/resources/tax/registration.rb +16 -1
  356. data/lib/stripe/resources/terminal/reader.rb +8 -0
  357. data/lib/stripe/resources/terminal/reader_collected_data.rb +47 -0
  358. data/lib/stripe/resources/token.rb +15 -1
  359. data/lib/stripe/resources/transfer.rb +2 -0
  360. data/lib/stripe/resources/treasury/financial_account.rb +2 -0
  361. data/lib/stripe/resources/treasury/financial_account_features.rb +2 -0
  362. data/lib/stripe/resources/treasury/outbound_payment.rb +2 -0
  363. data/lib/stripe/resources/treasury/outbound_transfer.rb +30 -0
  364. data/lib/stripe/resources/treasury/received_credit.rb +30 -0
  365. data/lib/stripe/resources/treasury/received_debit.rb +32 -0
  366. data/lib/stripe/resources/v2/billing/bill_setting.rb +102 -0
  367. data/lib/stripe/resources/v2/billing/bill_setting_version.rb +91 -0
  368. data/lib/stripe/resources/v2/billing/cadence.rb +710 -0
  369. data/lib/stripe/resources/v2/billing/collection_setting.rb +327 -0
  370. data/lib/stripe/resources/v2/billing/collection_setting_version.rb +316 -0
  371. data/lib/stripe/resources/v2/billing/profile.rb +47 -0
  372. data/lib/stripe/resources/v2/core/account.rb +802 -2
  373. data/lib/stripe/resources/v2/core/approval_request.rb +395 -0
  374. data/lib/stripe/resources/v2/core/batch_job.rb +536 -0
  375. data/lib/stripe/resources/v2/core/event_notification.rb +1 -0
  376. data/lib/stripe/resources/v2/core/vault/gb_bank_account.rb +91 -1
  377. data/lib/stripe/resources/v2/core/vault/us_bank_account.rb +26 -1
  378. data/lib/stripe/resources/v2/data/query_run.rb +255 -0
  379. data/lib/stripe/resources/v2/data/report.rb +104 -0
  380. data/lib/stripe/resources/v2/data/report_run.rb +246 -0
  381. data/lib/stripe/resources/v2/data/reporting/query_run.rb +142 -0
  382. data/lib/stripe/resources/v2/data/schema.rb +121 -0
  383. data/lib/stripe/resources/v2/extend/workflow.rb +80 -0
  384. data/lib/stripe/resources/v2/extend/workflow_run.rb +158 -0
  385. data/lib/stripe/resources/v2/iam/activity_log.rb +368 -0
  386. data/lib/stripe/resources/v2/money_management/adjustment.rb +4 -0
  387. data/lib/stripe/resources/v2/money_management/financial_account.rb +50 -1
  388. data/lib/stripe/resources/v2/money_management/financial_address_generated_microdeposits.rb +33 -0
  389. data/lib/stripe/resources/v2/money_management/inbound_transfer.rb +2 -0
  390. data/lib/stripe/resources/v2/money_management/outbound_payment.rb +63 -1
  391. data/lib/stripe/resources/v2/money_management/outbound_payment_quote.rb +255 -0
  392. data/lib/stripe/resources/v2/money_management/outbound_setup_intent.rb +31 -1
  393. data/lib/stripe/resources/v2/money_management/outbound_transfer.rb +260 -0
  394. data/lib/stripe/resources/v2/money_management/payout_method.rb +50 -1
  395. data/lib/stripe/resources/v2/money_management/received_credit.rb +2 -0
  396. data/lib/stripe/resources/v2/money_management/received_debit.rb +137 -0
  397. data/lib/stripe/resources/v2/money_management/recipient_verification.rb +2 -0
  398. data/lib/stripe/resources/v2/network/business_profile.rb +84 -0
  399. data/lib/stripe/resources/v2/orchestrated_commerce/agreement.rb +93 -0
  400. data/lib/stripe/resources/v2/signals/account_activity.rb +252 -0
  401. data/lib/stripe/resources/v2/signals/account_evaluation.rb +249 -0
  402. data/lib/stripe/resources/v2/signals/account_signal.rb +184 -0
  403. data/lib/stripe/resources.rb +341 -0
  404. data/lib/stripe/services/account_notice_service.rb +39 -0
  405. data/lib/stripe/services/account_service.rb +15 -0
  406. data/lib/stripe/services/billing/analytics/meter_usage_service.rb +21 -0
  407. data/lib/stripe/services/billing/analytics_service.rb +15 -0
  408. data/lib/stripe/services/billing_service.rb +2 -1
  409. data/lib/stripe/services/capital/financing_offer_service.rb +42 -0
  410. data/lib/stripe/services/capital/financing_summary_service.rb +19 -0
  411. data/lib/stripe/services/capital/financing_transaction_service.rb +31 -0
  412. data/lib/stripe/services/capital_service.rb +15 -0
  413. data/lib/stripe/services/coupon_service.rb +14 -0
  414. data/lib/stripe/services/customer_service.rb +15 -0
  415. data/lib/stripe/services/external_account_service.rb +68 -0
  416. data/lib/stripe/services/financial_connections/account_inferred_balance_service.rb +19 -0
  417. data/lib/stripe/services/financial_connections/account_service.rb +3 -1
  418. data/lib/stripe/services/financial_connections/authorization_service.rb +19 -0
  419. data/lib/stripe/services/financial_connections/institution_service.rb +30 -0
  420. data/lib/stripe/services/financial_connections_service.rb +3 -1
  421. data/lib/stripe/services/fx_quote_service.rb +27 -0
  422. data/lib/stripe/services/invoice_service.rb +11 -0
  423. data/lib/stripe/services/issuing/credit_underwriting_record_service.rb +74 -0
  424. data/lib/stripe/services/issuing/dispute_settlement_detail_service.rb +30 -0
  425. data/lib/stripe/services/issuing/fraud_liability_debit_service.rb +30 -0
  426. data/lib/stripe/services/issuing_service.rb +5 -1
  427. data/lib/stripe/services/mandate_service.rb +5 -0
  428. data/lib/stripe/services/margin_service.rb +50 -0
  429. data/lib/stripe/services/order_service.rb +53 -0
  430. data/lib/stripe/services/payment_intent_service.rb +37 -0
  431. data/lib/stripe/services/payment_plan_service.rb +50 -0
  432. data/lib/stripe/services/privacy/redaction_job_service.rb +104 -0
  433. data/lib/stripe/services/privacy/redaction_job_validation_error_service.rb +19 -0
  434. data/lib/stripe/services/privacy_service.rb +13 -0
  435. data/lib/stripe/services/promotion_code_service.rb +29 -0
  436. data/lib/stripe/services/quote_line_service.rb +17 -0
  437. data/lib/stripe/services/quote_preview_invoice_service.rb +17 -0
  438. data/lib/stripe/services/quote_preview_subscription_schedule_service.rb +17 -0
  439. data/lib/stripe/services/quote_service.rb +49 -1
  440. data/lib/stripe/services/radar/billing_evaluation_service.rb +19 -0
  441. data/lib/stripe/services/radar_service.rb +2 -1
  442. data/lib/stripe/services/reserve/hold_service.rb +30 -0
  443. data/lib/stripe/services/reserve/plan_service.rb +30 -0
  444. data/lib/stripe/services/reserve/release_service.rb +30 -0
  445. data/lib/stripe/services/reserve_service.rb +15 -0
  446. data/lib/stripe/services/shared_payment/granted_token_service.rb +19 -0
  447. data/lib/stripe/services/shared_payment/issued_token_service.rb +41 -0
  448. data/lib/stripe/services/shared_payment_service.rb +14 -0
  449. data/lib/stripe/services/subscription_schedule_service.rb +11 -0
  450. data/lib/stripe/services/subscription_service.rb +45 -0
  451. data/lib/stripe/services/tax/form_service.rb +37 -0
  452. data/lib/stripe/services/tax_service.rb +2 -1
  453. data/lib/stripe/services/terminal/reader_collected_data_service.rb +19 -0
  454. data/lib/stripe/services/terminal_service.rb +2 -1
  455. data/lib/stripe/services/test_helpers/shared_payment/granted_token_service.rb +32 -0
  456. data/lib/stripe/services/test_helpers/shared_payment_service.rb +15 -0
  457. data/lib/stripe/services/test_helpers_service.rb +2 -1
  458. data/lib/stripe/services/v1_services.rb +11 -1
  459. data/lib/stripe/services/v2/billing/bill_setting_service.rb +61 -0
  460. data/lib/stripe/services/v2/billing/bill_settings/version_service.rb +34 -0
  461. data/lib/stripe/services/v2/billing/cadence_service.rb +65 -0
  462. data/lib/stripe/services/v2/billing/collection_setting_service.rb +69 -0
  463. data/lib/stripe/services/v2/billing/collection_settings/version_service.rb +34 -0
  464. data/lib/stripe/services/v2/billing/profile_service.rb +54 -0
  465. data/lib/stripe/services/v2/billing_service.rb +5 -1
  466. data/lib/stripe/services/v2/core/approval_request_service.rb +58 -0
  467. data/lib/stripe/services/v2/core/batch_job_service.rb +43 -0
  468. data/lib/stripe/services/v2/core_service.rb +3 -1
  469. data/lib/stripe/services/v2/data/query_run_service.rb +34 -0
  470. data/lib/stripe/services/v2/data/report_run_service.rb +36 -0
  471. data/lib/stripe/services/v2/data/report_service.rb +34 -0
  472. data/lib/stripe/services/v2/data/reporting/query_run_service.rb +35 -0
  473. data/lib/stripe/services/v2/data/reporting_service.rb +17 -0
  474. data/lib/stripe/services/v2/data/schema_service.rb +32 -0
  475. data/lib/stripe/services/v2/data_service.rb +19 -0
  476. data/lib/stripe/services/v2/extend/workflow_run_service.rb +32 -0
  477. data/lib/stripe/services/v2/extend/workflow_service.rb +45 -0
  478. data/lib/stripe/services/v2/extend_service.rb +16 -0
  479. data/lib/stripe/services/v2/iam/activity_log_service.rb +32 -0
  480. data/lib/stripe/services/v2/iam_service.rb +15 -0
  481. data/lib/stripe/services/v2/money_management/financial_account_service.rb +27 -0
  482. data/lib/stripe/services/v2/money_management/outbound_payment_quote_service.rb +35 -0
  483. data/lib/stripe/services/v2/money_management/outbound_transfer_service.rb +61 -0
  484. data/lib/stripe/services/v2/money_management/payout_method_service.rb +15 -0
  485. data/lib/stripe/services/v2/money_management/received_debit_service.rb +32 -0
  486. data/lib/stripe/services/v2/money_management/test_helpers/financial_address_service.rb +13 -0
  487. data/lib/stripe/services/v2/money_management_service.rb +5 -1
  488. data/lib/stripe/services/v2/network/business_profile_service.rb +32 -0
  489. data/lib/stripe/services/v2/network_service.rb +15 -0
  490. data/lib/stripe/services/v2/orchestrated_commerce/agreement_service.rb +65 -0
  491. data/lib/stripe/services/v2/orchestrated_commerce_service.rb +15 -0
  492. data/lib/stripe/services/v2/signals/account_activity_service.rb +43 -0
  493. data/lib/stripe/services/v2/signals/account_evaluation_service.rb +32 -0
  494. data/lib/stripe/services/v2/signals/account_signal_service.rb +32 -0
  495. data/lib/stripe/services/v2/signals_service.rb +17 -0
  496. data/lib/stripe/services/v2_services.rb +7 -1
  497. data/lib/stripe/services.rb +181 -0
  498. data/lib/stripe/stripe_client.rb +4 -1
  499. data/lib/stripe/stripe_configuration.rb +3 -1
  500. data/lib/stripe/stripe_event_notification_handler.rb +216 -0
  501. data/lib/stripe/stripe_object.rb +1 -1
  502. data/lib/stripe/util.rb +7 -1
  503. data/lib/stripe/version.rb +1 -1
  504. data/lib/stripe.rb +53 -0
  505. data/rbi/stripe/resources/v2/core/event_notification.rbi +2 -0
  506. data/rbi/stripe.rbi +133319 -66595
  507. metadata +331 -3
@@ -0,0 +1,189 @@
1
+ # File generated from our OpenAPI spec
2
+ # frozen_string_literal: true
3
+
4
+ module Stripe
5
+ module Privacy
6
+ # The Redaction Job object redacts Stripe objects. You can use it
7
+ # to coordinate the removal of personal information from selected
8
+ # objects, making them permanently inaccessible in the Stripe Dashboard
9
+ # and API.
10
+ class RedactionJob < APIResource
11
+ extend Stripe::APIOperations::Create
12
+ extend Stripe::APIOperations::List
13
+ extend Stripe::APIOperations::NestedResource
14
+ include Stripe::APIOperations::Save
15
+
16
+ OBJECT_NAME = "privacy.redaction_job"
17
+ def self.object_name
18
+ "privacy.redaction_job"
19
+ end
20
+
21
+ nested_resource_class_methods :validation_error, operations: %i[list]
22
+
23
+ class Objects < ::Stripe::StripeObject
24
+ # Charge object identifiers usually starting with `ch_`
25
+ attr_reader :charges
26
+ # CheckoutSession object identifiers starting with `cs_`
27
+ attr_reader :checkout_sessions
28
+ # Customer object identifiers starting with `cus_`
29
+ attr_reader :customers
30
+ # Identity VerificationSessions object identifiers starting with `vs_`
31
+ attr_reader :identity_verification_sessions
32
+ # Invoice object identifiers starting with `in_`
33
+ attr_reader :invoices
34
+ # Issuing Cardholder object identifiers starting with `ich_`
35
+ attr_reader :issuing_cardholders
36
+ # PaymentIntent object identifiers starting with `pi_`
37
+ attr_reader :payment_intents
38
+ # Fraud ValueListItem object identifiers starting with `rsli_`
39
+ attr_reader :radar_value_list_items
40
+ # SetupIntent object identifiers starting with `seti_`
41
+ attr_reader :setup_intents
42
+
43
+ def self.inner_class_types
44
+ @inner_class_types = {}
45
+ end
46
+
47
+ def self.field_remappings
48
+ @field_remappings = {}
49
+ end
50
+ end
51
+ # Time at which the object was created. Measured in seconds since the Unix epoch.
52
+ attr_reader :created
53
+ # Unique identifier for the object.
54
+ attr_reader :id
55
+ # If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`.
56
+ attr_reader :livemode
57
+ # String representing the object's type. Objects of the same type share the same value.
58
+ attr_reader :object
59
+ # The objects to redact in this job.
60
+ attr_reader :objects
61
+ # The status of the job.
62
+ attr_reader :status
63
+ # Validation behavior determines how a job validates objects for redaction eligibility. Default is `error`.
64
+ attr_reader :validation_behavior
65
+ # The first 10 validation errors for the current validation attempt. Use the validation errors list endpoint to paginate through the full list.
66
+ attr_reader :validation_errors
67
+
68
+ # You can cancel a redaction job when it's in one of these statuses: ready, failed.
69
+ #
70
+ # Canceling the redaction job will abandon its attempt to redact the configured objects. A canceled job cannot be used again.
71
+ def cancel(params = {}, opts = {})
72
+ request_stripe_object(
73
+ method: :post,
74
+ path: format("/v1/privacy/redaction_jobs/%<job>s/cancel", { job: CGI.escape(self["id"]) }),
75
+ params: params,
76
+ opts: opts
77
+ )
78
+ end
79
+
80
+ # You can cancel a redaction job when it's in one of these statuses: ready, failed.
81
+ #
82
+ # Canceling the redaction job will abandon its attempt to redact the configured objects. A canceled job cannot be used again.
83
+ def self.cancel(job, params = {}, opts = {})
84
+ request_stripe_object(
85
+ method: :post,
86
+ path: format("/v1/privacy/redaction_jobs/%<job>s/cancel", { job: CGI.escape(job) }),
87
+ params: params,
88
+ opts: opts
89
+ )
90
+ end
91
+
92
+ # Creates a redaction job. When a job is created, it will start to validate.
93
+ def self.create(params = {}, opts = {})
94
+ request_stripe_object(
95
+ method: :post,
96
+ path: "/v1/privacy/redaction_jobs",
97
+ params: params,
98
+ opts: opts
99
+ )
100
+ end
101
+
102
+ # Returns a list of redaction jobs.
103
+ def self.list(params = {}, opts = {})
104
+ request_stripe_object(
105
+ method: :get,
106
+ path: "/v1/privacy/redaction_jobs",
107
+ params: params,
108
+ opts: opts
109
+ )
110
+ end
111
+
112
+ # Run a redaction job in a ready status.
113
+ #
114
+ # When you run a job, the configured objects will be redacted asynchronously. This action is irreversible and cannot be canceled once started.
115
+ #
116
+ # The status of the job will move to redacting. Once all of the objects are redacted, the status will become succeeded. If the job's validation_behavior is set to fix, the automatic fixes will be applied to objects at this step.
117
+ def run(params = {}, opts = {})
118
+ request_stripe_object(
119
+ method: :post,
120
+ path: format("/v1/privacy/redaction_jobs/%<job>s/run", { job: CGI.escape(self["id"]) }),
121
+ params: params,
122
+ opts: opts
123
+ )
124
+ end
125
+
126
+ # Run a redaction job in a ready status.
127
+ #
128
+ # When you run a job, the configured objects will be redacted asynchronously. This action is irreversible and cannot be canceled once started.
129
+ #
130
+ # The status of the job will move to redacting. Once all of the objects are redacted, the status will become succeeded. If the job's validation_behavior is set to fix, the automatic fixes will be applied to objects at this step.
131
+ def self.run(job, params = {}, opts = {})
132
+ request_stripe_object(
133
+ method: :post,
134
+ path: format("/v1/privacy/redaction_jobs/%<job>s/run", { job: CGI.escape(job) }),
135
+ params: params,
136
+ opts: opts
137
+ )
138
+ end
139
+
140
+ # Updates the properties of a redaction job without running or canceling the job.
141
+ #
142
+ # If the job to update is in a failed status, it will not automatically start to validate. Once you applied all of the changes, use the validate API to start validation again.
143
+ def self.update(job, params = {}, opts = {})
144
+ request_stripe_object(
145
+ method: :post,
146
+ path: format("/v1/privacy/redaction_jobs/%<job>s", { job: CGI.escape(job) }),
147
+ params: params,
148
+ opts: opts
149
+ )
150
+ end
151
+
152
+ # Validate a redaction job when it is in a failed status.
153
+ #
154
+ # When a job is created, it automatically begins to validate on the configured objects' eligibility for redaction. Use this to validate the job again after its validation errors are resolved or the job's validation_behavior is changed.
155
+ #
156
+ # The status of the job will move to validating. Once all of the objects are validated, the status of the job will become ready. If there are any validation errors preventing the job from running, the status will become failed.
157
+ def validate(params = {}, opts = {})
158
+ request_stripe_object(
159
+ method: :post,
160
+ path: format("/v1/privacy/redaction_jobs/%<job>s/validate", { job: CGI.escape(self["id"]) }),
161
+ params: params,
162
+ opts: opts
163
+ )
164
+ end
165
+
166
+ # Validate a redaction job when it is in a failed status.
167
+ #
168
+ # When a job is created, it automatically begins to validate on the configured objects' eligibility for redaction. Use this to validate the job again after its validation errors are resolved or the job's validation_behavior is changed.
169
+ #
170
+ # The status of the job will move to validating. Once all of the objects are validated, the status of the job will become ready. If there are any validation errors preventing the job from running, the status will become failed.
171
+ def self.validate(job, params = {}, opts = {})
172
+ request_stripe_object(
173
+ method: :post,
174
+ path: format("/v1/privacy/redaction_jobs/%<job>s/validate", { job: CGI.escape(job) }),
175
+ params: params,
176
+ opts: opts
177
+ )
178
+ end
179
+
180
+ def self.inner_class_types
181
+ @inner_class_types = { objects: Objects }
182
+ end
183
+
184
+ def self.field_remappings
185
+ @field_remappings = {}
186
+ end
187
+ end
188
+ end
189
+ end
@@ -0,0 +1,49 @@
1
+ # File generated from our OpenAPI spec
2
+ # frozen_string_literal: true
3
+
4
+ module Stripe
5
+ module Privacy
6
+ # The Redaction Job validation error object contains information about
7
+ # errors that affect the ability to redact a specific object in a
8
+ # redaction job.
9
+ class RedactionJobValidationError < APIResource
10
+ OBJECT_NAME = "privacy.redaction_job_validation_error"
11
+ def self.object_name
12
+ "privacy.redaction_job_validation_error"
13
+ end
14
+
15
+ class ErroringObject < ::Stripe::StripeObject
16
+ # Unique identifier for the object.
17
+ attr_reader :id
18
+ # Erroring object type
19
+ attr_reader :object_type
20
+
21
+ def self.inner_class_types
22
+ @inner_class_types = {}
23
+ end
24
+
25
+ def self.field_remappings
26
+ @field_remappings = {}
27
+ end
28
+ end
29
+ # A code indicating the reason for the error.
30
+ attr_reader :code
31
+ # If the error is related to a specific object, this field includes the object's identifier and object type.
32
+ attr_reader :erroring_object
33
+ # Unique identifier for the object.
34
+ attr_reader :id
35
+ # A human-readable message providing more details about the error.
36
+ attr_reader :message
37
+ # String representing the object's type. Objects of the same type share the same value.
38
+ attr_reader :object
39
+
40
+ def self.inner_class_types
41
+ @inner_class_types = { erroring_object: ErroringObject }
42
+ end
43
+
44
+ def self.field_remappings
45
+ @field_remappings = {}
46
+ end
47
+ end
48
+ end
49
+ end