increase 1.340.0 → 1.342.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (348) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +1 -1
  3. data/lib/increase/client.rb +8 -6
  4. data/lib/increase/internal/type/converter.rb +13 -12
  5. data/lib/increase/models/account.rb +40 -19
  6. data/lib/increase/models/account_create_params.rb +14 -11
  7. data/lib/increase/models/account_list_params.rb +25 -17
  8. data/lib/increase/models/account_number.rb +22 -14
  9. data/lib/increase/models/account_number_create_params.rb +12 -13
  10. data/lib/increase/models/account_number_list_params.rb +26 -20
  11. data/lib/increase/models/account_number_update_params.rb +12 -11
  12. data/lib/increase/models/account_statement.rb +15 -11
  13. data/lib/increase/models/account_statement_list_params.rb +15 -12
  14. data/lib/increase/models/account_transfer.rb +58 -29
  15. data/lib/increase/models/account_transfer_create_params.rb +12 -7
  16. data/lib/increase/models/account_transfer_list_params.rb +20 -12
  17. data/lib/increase/models/ach_prenotification.rb +49 -28
  18. data/lib/increase/models/ach_prenotification_create_params.rb +15 -8
  19. data/lib/increase/models/ach_prenotification_list_params.rb +20 -12
  20. data/lib/increase/models/ach_transfer.rb +220 -105
  21. data/lib/increase/models/ach_transfer_create_params.rb +110 -61
  22. data/lib/increase/models/ach_transfer_list_params.rb +23 -16
  23. data/lib/increase/models/balance_lookup.rb +14 -11
  24. data/lib/increase/models/beneficial_owner_create_params.rb +60 -46
  25. data/lib/increase/models/beneficial_owner_list_params.rb +11 -6
  26. data/lib/increase/models/beneficial_owner_update_params.rb +56 -40
  27. data/lib/increase/models/card.rb +69 -47
  28. data/lib/increase/models/card_create_details_iframe_params.rb +3 -4
  29. data/lib/increase/models/card_create_params.rb +65 -56
  30. data/lib/increase/models/card_details.rb +7 -5
  31. data/lib/increase/models/card_dispute.rb +530 -306
  32. data/lib/increase/models/card_dispute_create_params.rb +271 -175
  33. data/lib/increase/models/card_dispute_list_params.rb +24 -16
  34. data/lib/increase/models/card_dispute_submit_user_submission_params.rb +288 -191
  35. data/lib/increase/models/card_iframe_url.rb +3 -4
  36. data/lib/increase/models/card_list_params.rb +23 -16
  37. data/lib/increase/models/card_payment.rb +1941 -1200
  38. data/lib/increase/models/card_payment_list_params.rb +15 -11
  39. data/lib/increase/models/card_purchase_supplement.rb +37 -25
  40. data/lib/increase/models/card_purchase_supplement_list_params.rb +18 -13
  41. data/lib/increase/models/card_push_transfer.rb +121 -65
  42. data/lib/increase/models/card_push_transfer_create_params.rb +55 -25
  43. data/lib/increase/models/card_push_transfer_list_params.rb +23 -16
  44. data/lib/increase/models/card_token.rb +9 -6
  45. data/lib/increase/models/card_token_capabilities.rb +11 -8
  46. data/lib/increase/models/card_token_list_params.rb +15 -11
  47. data/lib/increase/models/card_update_params.rb +65 -57
  48. data/lib/increase/models/card_validation.rb +76 -43
  49. data/lib/increase/models/card_validation_create_params.rb +11 -7
  50. data/lib/increase/models/card_validation_list_params.rb +23 -16
  51. data/lib/increase/models/check_deposit.rb +103 -52
  52. data/lib/increase/models/check_deposit_create_params.rb +2 -4
  53. data/lib/increase/models/check_deposit_list_params.rb +20 -12
  54. data/lib/increase/models/check_transfer.rb +127 -76
  55. data/lib/increase/models/check_transfer_create_params.rb +91 -51
  56. data/lib/increase/models/check_transfer_list_params.rb +24 -16
  57. data/lib/increase/models/check_transfer_stop_payment_params.rb +2 -1
  58. data/lib/increase/models/declined_transaction.rb +339 -206
  59. data/lib/increase/models/declined_transaction_list_params.rb +18 -15
  60. data/lib/increase/models/digital_card_profile.rb +16 -9
  61. data/lib/increase/models/digital_card_profile_clone_params.rb +2 -1
  62. data/lib/increase/models/digital_card_profile_create_params.rb +2 -1
  63. data/lib/increase/models/digital_card_profile_list_params.rb +12 -9
  64. data/lib/increase/models/digital_wallet_token.rb +26 -17
  65. data/lib/increase/models/digital_wallet_token_list_params.rb +15 -11
  66. data/lib/increase/models/entity.rb +175 -135
  67. data/lib/increase/models/entity_archive_params.rb +3 -4
  68. data/lib/increase/models/entity_beneficial_owner.rb +24 -19
  69. data/lib/increase/models/entity_create_params.rb +395 -290
  70. data/lib/increase/models/entity_list_params.rb +67 -16
  71. data/lib/increase/models/entity_onboarding_session.rb +25 -11
  72. data/lib/increase/models/entity_onboarding_session_create_params.rb +8 -5
  73. data/lib/increase/models/entity_onboarding_session_list_params.rb +12 -9
  74. data/lib/increase/models/entity_supplemental_document.rb +10 -6
  75. data/lib/increase/models/entity_update_params.rb +136 -104
  76. data/lib/increase/models/event.rb +14 -5
  77. data/lib/increase/models/event_list_params.rb +31 -17
  78. data/lib/increase/models/event_subscription.rb +25 -9
  79. data/lib/increase/models/event_subscription_create_params.rb +22 -8
  80. data/lib/increase/models/event_subscription_list_params.rb +8 -5
  81. data/lib/increase/models/event_subscription_update_params.rb +2 -1
  82. data/lib/increase/models/export.rb +69 -30
  83. data/lib/increase/models/export_create_params.rb +76 -46
  84. data/lib/increase/models/export_list_params.rb +26 -17
  85. data/lib/increase/models/external_account.rb +14 -8
  86. data/lib/increase/models/external_account_create_params.rb +7 -6
  87. data/lib/increase/models/external_account_list_params.rb +12 -9
  88. data/lib/increase/models/external_account_update_params.rb +6 -3
  89. data/lib/increase/models/fednow_transfer.rb +62 -32
  90. data/lib/increase/models/fednow_transfer_create_params.rb +11 -8
  91. data/lib/increase/models/fednow_transfer_list_params.rb +25 -17
  92. data/lib/increase/models/file.rb +13 -7
  93. data/lib/increase/models/file_create_params.rb +6 -5
  94. data/lib/increase/models/file_link.rb +17 -8
  95. data/lib/increase/models/file_link_create_params.rb +3 -4
  96. data/lib/increase/models/file_list_params.rb +23 -16
  97. data/lib/increase/models/group.rb +6 -5
  98. data/lib/increase/models/inbound_ach_transfer.rb +115 -51
  99. data/lib/increase/models/inbound_ach_transfer_create_notification_of_change_params.rb +3 -5
  100. data/lib/increase/models/inbound_ach_transfer_decline_params.rb +4 -4
  101. data/lib/increase/models/inbound_ach_transfer_list_params.rb +21 -16
  102. data/lib/increase/models/inbound_ach_transfer_transfer_return_params.rb +6 -5
  103. data/lib/increase/models/inbound_check_deposit.rb +46 -19
  104. data/lib/increase/models/inbound_check_deposit_list_params.rb +18 -12
  105. data/lib/increase/models/inbound_check_deposit_return_params.rb +2 -1
  106. data/lib/increase/models/inbound_fednow_transfer.rb +28 -14
  107. data/lib/increase/models/inbound_fednow_transfer_list_params.rb +18 -12
  108. data/lib/increase/models/inbound_fednow_transfer_retrieve_params.rb +2 -1
  109. data/lib/increase/models/inbound_mail_item.rb +13 -8
  110. data/lib/increase/models/inbound_mail_item_action_params.rb +4 -2
  111. data/lib/increase/models/inbound_mail_item_list_params.rb +17 -12
  112. data/lib/increase/models/inbound_real_time_payments_transfer.rb +21 -12
  113. data/lib/increase/models/inbound_real_time_payments_transfer_list_params.rb +21 -14
  114. data/lib/increase/models/inbound_real_time_payments_transfer_retrieve_params.rb +2 -1
  115. data/lib/increase/models/inbound_wire_drawdown_request.rb +23 -10
  116. data/lib/increase/models/inbound_wire_drawdown_request_list_params.rb +3 -4
  117. data/lib/increase/models/inbound_wire_drawdown_request_retrieve_params.rb +2 -1
  118. data/lib/increase/models/inbound_wire_transfer.rb +51 -22
  119. data/lib/increase/models/inbound_wire_transfer_list_params.rb +24 -17
  120. data/lib/increase/models/inbound_wire_transfer_reverse_params.rb +2 -1
  121. data/lib/increase/models/intrafi_account_enrollment.rb +16 -8
  122. data/lib/increase/models/intrafi_account_enrollment_list_params.rb +12 -9
  123. data/lib/increase/models/intrafi_account_enrollment_retrieve_params.rb +2 -1
  124. data/lib/increase/models/intrafi_account_enrollment_unenroll_params.rb +2 -1
  125. data/lib/increase/models/intrafi_balance.rb +18 -12
  126. data/lib/increase/models/intrafi_exclusion.rb +13 -7
  127. data/lib/increase/models/intrafi_exclusion_archive_params.rb +4 -4
  128. data/lib/increase/models/intrafi_exclusion_create_params.rb +5 -4
  129. data/lib/increase/models/intrafi_exclusion_list_params.rb +8 -5
  130. data/lib/increase/models/lockbox_address.rb +16 -11
  131. data/lib/increase/models/lockbox_address_list_params.rb +20 -12
  132. data/lib/increase/models/lockbox_address_update_params.rb +2 -1
  133. data/lib/increase/models/lockbox_recipient.rb +22 -10
  134. data/lib/increase/models/lockbox_recipient_create_params.rb +5 -5
  135. data/lib/increase/models/lockbox_recipient_list_params.rb +22 -13
  136. data/lib/increase/models/lockbox_recipient_update_params.rb +2 -1
  137. data/lib/increase/models/oauth_application.rb +12 -7
  138. data/lib/increase/models/oauth_application_list_params.rb +18 -15
  139. data/lib/increase/models/oauth_connection.rb +9 -6
  140. data/lib/increase/models/oauth_connection_list_params.rb +10 -9
  141. data/lib/increase/models/oauth_token.rb +6 -5
  142. data/lib/increase/models/oauth_token_create_params.rb +14 -7
  143. data/lib/increase/models/pending_transaction.rb +392 -239
  144. data/lib/increase/models/pending_transaction_create_params.rb +6 -6
  145. data/lib/increase/models/pending_transaction_list_params.rb +23 -19
  146. data/lib/increase/models/physical_card.rb +36 -24
  147. data/lib/increase/models/physical_card_create_params.rb +22 -17
  148. data/lib/increase/models/physical_card_list_params.rb +20 -12
  149. data/lib/increase/models/physical_card_profile.rb +33 -17
  150. data/lib/increase/models/physical_card_profile_clone_params.rb +9 -9
  151. data/lib/increase/models/physical_card_profile_create_params.rb +9 -9
  152. data/lib/increase/models/physical_card_profile_list_params.rb +12 -9
  153. data/lib/increase/models/physical_card_update_params.rb +2 -1
  154. data/lib/increase/models/program.rb +15 -8
  155. data/lib/increase/models/program_list_params.rb +3 -4
  156. data/lib/increase/models/real_time_decision.rb +561 -370
  157. data/lib/increase/models/real_time_decision_action_params.rb +86 -75
  158. data/lib/increase/models/real_time_payments_transfer.rb +90 -47
  159. data/lib/increase/models/real_time_payments_transfer_approve_params.rb +2 -1
  160. data/lib/increase/models/real_time_payments_transfer_cancel_params.rb +2 -1
  161. data/lib/increase/models/real_time_payments_transfer_create_params.rb +24 -12
  162. data/lib/increase/models/real_time_payments_transfer_list_params.rb +28 -19
  163. data/lib/increase/models/routing_number_list_params.rb +3 -4
  164. data/lib/increase/models/routing_number_list_response.rb +11 -8
  165. data/lib/increase/models/simulations/account_revenue_payment_create_params.rb +9 -7
  166. data/lib/increase/models/simulations/ach_transfer_create_notification_of_change_params.rb +5 -6
  167. data/lib/increase/models/simulations/ach_transfer_return_params.rb +18 -6
  168. data/lib/increase/models/simulations/ach_transfer_settle_params.rb +4 -4
  169. data/lib/increase/models/simulations/card_authentication_create_params.rb +10 -8
  170. data/lib/increase/models/simulations/card_authorization_create_params.rb +50 -27
  171. data/lib/increase/models/simulations/card_authorization_create_response.rb +11 -7
  172. data/lib/increase/models/simulations/card_balance_inquiry_create_params.rb +26 -13
  173. data/lib/increase/models/simulations/card_dispute_action_params.rb +39 -19
  174. data/lib/increase/models/simulations/card_fuel_confirmation_create_params.rb +3 -5
  175. data/lib/increase/models/simulations/card_increment_create_params.rb +5 -4
  176. data/lib/increase/models/simulations/card_purchase_supplement_create_params.rb +7 -7
  177. data/lib/increase/models/simulations/card_refund_create_params.rb +10 -6
  178. data/lib/increase/models/simulations/card_reversal_create_params.rb +3 -4
  179. data/lib/increase/models/simulations/card_settlement_create_params.rb +16 -13
  180. data/lib/increase/models/simulations/card_token_create_params.rb +18 -9
  181. data/lib/increase/models/simulations/check_deposit_adjustment_params.rb +8 -5
  182. data/lib/increase/models/simulations/check_deposit_submit_params.rb +9 -10
  183. data/lib/increase/models/simulations/digital_wallet_token_request_create_response.rb +9 -7
  184. data/lib/increase/models/simulations/entity_onboarding_session_submit_params.rb +2 -1
  185. data/lib/increase/models/simulations/entity_update_validation_params.rb +5 -5
  186. data/lib/increase/models/simulations/export_create_params.rb +5 -5
  187. data/lib/increase/models/simulations/inbound_ach_transfer_create_params.rb +20 -12
  188. data/lib/increase/models/simulations/inbound_check_deposit_adjustment_params.rb +5 -6
  189. data/lib/increase/models/simulations/inbound_check_deposit_create_params.rb +6 -6
  190. data/lib/increase/models/simulations/inbound_mail_item_create_params.rb +9 -6
  191. data/lib/increase/models/simulations/inbound_real_time_payments_transfer_create_params.rb +5 -6
  192. data/lib/increase/models/simulations/inbound_wire_drawdown_request_create_params.rb +27 -13
  193. data/lib/increase/models/simulations/inbound_wire_transfer_create_params.rb +45 -19
  194. data/lib/increase/models/simulations/interest_payment_create_params.rb +4 -5
  195. data/lib/increase/models/simulations/pending_transaction_release_inbound_funds_hold_params.rb +3 -5
  196. data/lib/increase/models/simulations/physical_card_advance_shipment_params.rb +2 -1
  197. data/lib/increase/models/simulations/physical_card_create_params.rb +5 -5
  198. data/lib/increase/models/simulations/program_create_params.rb +4 -5
  199. data/lib/increase/models/simulations/real_time_payments_transfer_complete_params.rb +6 -3
  200. data/lib/increase/models/supplemental_document_list_params.rb +8 -5
  201. data/lib/increase/models/swift_transfer.rb +60 -27
  202. data/lib/increase/models/swift_transfer_create_params.rb +40 -20
  203. data/lib/increase/models/swift_transfer_list_params.rb +23 -16
  204. data/lib/increase/models/transaction.rb +1016 -536
  205. data/lib/increase/models/transaction_list_params.rb +21 -16
  206. data/lib/increase/models/unwrap_webhook_event.rb +14 -5
  207. data/lib/increase/models/wire_drawdown_request.rb +44 -26
  208. data/lib/increase/models/wire_drawdown_request_create_params.rb +23 -19
  209. data/lib/increase/models/wire_drawdown_request_list_params.rb +12 -9
  210. data/lib/increase/models/wire_transfer.rb +100 -55
  211. data/lib/increase/models/wire_transfer_create_params.rb +43 -26
  212. data/lib/increase/models/wire_transfer_list_params.rb +23 -16
  213. data/lib/increase/resources/account_numbers.rb +20 -16
  214. data/lib/increase/resources/account_statements.rb +3 -4
  215. data/lib/increase/resources/account_transfers.rb +20 -12
  216. data/lib/increase/resources/accounts.rb +19 -12
  217. data/lib/increase/resources/ach_prenotifications.rb +23 -13
  218. data/lib/increase/resources/ach_transfers.rb +93 -43
  219. data/lib/increase/resources/beneficial_owners.rb +35 -19
  220. data/lib/increase/resources/card_disputes.rb +43 -22
  221. data/lib/increase/resources/card_payments.rb +3 -4
  222. data/lib/increase/resources/card_purchase_supplements.rb +6 -5
  223. data/lib/increase/resources/card_push_transfers.rb +55 -24
  224. data/lib/increase/resources/card_tokens.rb +3 -4
  225. data/lib/increase/resources/card_validations.rb +19 -12
  226. data/lib/increase/resources/cards.rb +33 -22
  227. data/lib/increase/resources/check_deposits.rb +10 -9
  228. data/lib/increase/resources/check_transfers.rb +37 -17
  229. data/lib/increase/resources/declined_transactions.rb +3 -4
  230. data/lib/increase/resources/digital_card_profiles.rb +12 -7
  231. data/lib/increase/resources/digital_wallet_tokens.rb +3 -4
  232. data/lib/increase/resources/entities.rb +69 -33
  233. data/lib/increase/resources/entity_onboarding_sessions.rb +16 -10
  234. data/lib/increase/resources/event_subscriptions.rb +22 -13
  235. data/lib/increase/resources/events.rb +10 -9
  236. data/lib/increase/resources/exports.rb +40 -22
  237. data/lib/increase/resources/external_accounts.rb +21 -14
  238. data/lib/increase/resources/fednow_transfers.rb +21 -14
  239. data/lib/increase/resources/file_links.rb +3 -4
  240. data/lib/increase/resources/files.rb +14 -10
  241. data/lib/increase/resources/inbound_ach_transfers.rb +18 -19
  242. data/lib/increase/resources/inbound_check_deposits.rb +8 -6
  243. data/lib/increase/resources/inbound_fednow_transfers.rb +8 -6
  244. data/lib/increase/resources/inbound_mail_items.rb +7 -6
  245. data/lib/increase/resources/inbound_real_time_payments_transfers.rb +11 -7
  246. data/lib/increase/resources/inbound_wire_drawdown_requests.rb +5 -5
  247. data/lib/increase/resources/inbound_wire_transfers.rb +10 -7
  248. data/lib/increase/resources/intrafi_account_enrollments.rb +12 -7
  249. data/lib/increase/resources/intrafi_exclusions.rb +17 -13
  250. data/lib/increase/resources/lockbox_addresses.rb +10 -6
  251. data/lib/increase/resources/lockbox_recipients.rb +17 -12
  252. data/lib/increase/resources/oauth_applications.rb +3 -4
  253. data/lib/increase/resources/oauth_connections.rb +6 -5
  254. data/lib/increase/resources/oauth_tokens.rb +14 -7
  255. data/lib/increase/resources/pending_transactions.rb +7 -8
  256. data/lib/increase/resources/physical_card_profiles.rb +18 -15
  257. data/lib/increase/resources/physical_cards.rb +17 -12
  258. data/lib/increase/resources/programs.rb +3 -4
  259. data/lib/increase/resources/real_time_decisions.rb +18 -9
  260. data/lib/increase/resources/real_time_payments_transfers.rb +41 -21
  261. data/lib/increase/resources/routing_numbers.rb +3 -4
  262. data/lib/increase/resources/simulations/account_revenue_payments.rb +9 -7
  263. data/lib/increase/resources/simulations/ach_transfers.rb +18 -15
  264. data/lib/increase/resources/simulations/card_authentications.rb +10 -8
  265. data/lib/increase/resources/simulations/card_authorizations.rb +28 -12
  266. data/lib/increase/resources/simulations/card_balance_inquiries.rb +22 -11
  267. data/lib/increase/resources/simulations/card_disputes.rb +6 -5
  268. data/lib/increase/resources/simulations/card_fuel_confirmations.rb +3 -5
  269. data/lib/increase/resources/simulations/card_increments.rb +5 -4
  270. data/lib/increase/resources/simulations/card_purchase_supplements.rb +7 -7
  271. data/lib/increase/resources/simulations/card_refunds.rb +10 -6
  272. data/lib/increase/resources/simulations/card_reversals.rb +3 -4
  273. data/lib/increase/resources/simulations/card_settlements.rb +8 -6
  274. data/lib/increase/resources/simulations/card_tokens.rb +6 -3
  275. data/lib/increase/resources/simulations/check_deposits.rb +11 -9
  276. data/lib/increase/resources/simulations/entities.rb +3 -4
  277. data/lib/increase/resources/simulations/entity_onboarding_sessions.rb +2 -1
  278. data/lib/increase/resources/simulations/exports.rb +5 -5
  279. data/lib/increase/resources/simulations/inbound_ach_transfers.rb +14 -9
  280. data/lib/increase/resources/simulations/inbound_check_deposits.rb +11 -12
  281. data/lib/increase/resources/simulations/inbound_mail_items.rb +9 -6
  282. data/lib/increase/resources/simulations/inbound_real_time_payments_transfers.rb +5 -6
  283. data/lib/increase/resources/simulations/inbound_wire_drawdown_requests.rb +27 -13
  284. data/lib/increase/resources/simulations/inbound_wire_transfers.rb +45 -19
  285. data/lib/increase/resources/simulations/interest_payments.rb +4 -5
  286. data/lib/increase/resources/simulations/pending_transactions.rb +3 -5
  287. data/lib/increase/resources/simulations/physical_cards.rb +7 -6
  288. data/lib/increase/resources/simulations/programs.rb +4 -2
  289. data/lib/increase/resources/simulations/real_time_payments_transfers.rb +4 -2
  290. data/lib/increase/resources/supplemental_documents.rb +8 -5
  291. data/lib/increase/resources/swift_transfers.rb +33 -17
  292. data/lib/increase/resources/transactions.rb +6 -5
  293. data/lib/increase/resources/wire_drawdown_requests.rb +23 -14
  294. data/lib/increase/resources/wire_transfers.rb +29 -16
  295. data/lib/increase/version.rb +1 -1
  296. data/rbi/increase/models/ach_prenotification.rbi +1 -1
  297. data/rbi/increase/models/ach_transfer.rbi +19 -1
  298. data/rbi/increase/models/beneficial_owner_create_params.rbi +13 -8
  299. data/rbi/increase/models/beneficial_owner_update_params.rbi +13 -8
  300. data/rbi/increase/models/check_transfer.rbi +12 -2
  301. data/rbi/increase/models/check_transfer_create_params.rbi +35 -36
  302. data/rbi/increase/models/entity_create_params.rbi +78 -48
  303. data/rbi/increase/models/entity_list_params.rbi +119 -0
  304. data/rbi/increase/models/entity_update_params.rbi +26 -16
  305. data/rbi/increase/models/event.rbi +14 -0
  306. data/rbi/increase/models/event_list_params.rbi +14 -0
  307. data/rbi/increase/models/event_subscription.rbi +14 -0
  308. data/rbi/increase/models/event_subscription_create_params.rbi +14 -0
  309. data/rbi/increase/models/inbound_wire_transfer.rbi +16 -0
  310. data/rbi/increase/models/pending_transaction_create_params.rbi +4 -4
  311. data/rbi/increase/models/simulations/ach_transfer_return_params.rbi +16 -1
  312. data/rbi/increase/models/simulations/card_settlement_create_params.rbi +17 -12
  313. data/rbi/increase/models/simulations/program_create_params.rbi +0 -7
  314. data/rbi/increase/models/swift_transfer.rbi +10 -0
  315. data/rbi/increase/models/swift_transfer_create_params.rbi +13 -0
  316. data/rbi/increase/models/transaction.rbi +19 -1
  317. data/rbi/increase/models/unwrap_webhook_event.rbi +14 -0
  318. data/rbi/increase/resources/entities.rbi +3 -0
  319. data/rbi/increase/resources/pending_transactions.rbi +2 -2
  320. data/rbi/increase/resources/simulations/ach_transfers.rbi +5 -0
  321. data/rbi/increase/resources/simulations/card_settlements.rbi +6 -5
  322. data/rbi/increase/resources/swift_transfers.rbi +4 -0
  323. data/sig/increase/models/ach_prenotification.rbs +1 -1
  324. data/sig/increase/models/ach_transfer.rbs +6 -1
  325. data/sig/increase/models/beneficial_owner_create_params.rbs +7 -5
  326. data/sig/increase/models/beneficial_owner_update_params.rbs +7 -5
  327. data/sig/increase/models/check_transfer.rbs +5 -0
  328. data/sig/increase/models/check_transfer_create_params.rbs +12 -9
  329. data/sig/increase/models/entity_create_params.rbs +42 -30
  330. data/sig/increase/models/entity_list_params.rbs +48 -1
  331. data/sig/increase/models/entity_update_params.rbs +14 -10
  332. data/sig/increase/models/event.rbs +8 -0
  333. data/sig/increase/models/event_list_params.rbs +8 -0
  334. data/sig/increase/models/event_subscription.rbs +8 -0
  335. data/sig/increase/models/event_subscription_create_params.rbs +8 -0
  336. data/sig/increase/models/inbound_wire_transfer.rbs +10 -0
  337. data/sig/increase/models/simulations/ach_transfer_return_params.rbs +8 -1
  338. data/sig/increase/models/simulations/card_settlement_create_params.rbs +7 -5
  339. data/sig/increase/models/simulations/program_create_params.rbs +1 -8
  340. data/sig/increase/models/swift_transfer.rbs +5 -0
  341. data/sig/increase/models/swift_transfer_create_params.rbs +7 -0
  342. data/sig/increase/models/transaction.rbs +6 -1
  343. data/sig/increase/models/unwrap_webhook_event.rbs +8 -0
  344. data/sig/increase/resources/entities.rbs +1 -0
  345. data/sig/increase/resources/simulations/ach_transfers.rbs +1 -0
  346. data/sig/increase/resources/simulations/card_settlements.rbs +1 -1
  347. data/sig/increase/resources/swift_transfers.rbs +1 -0
  348. metadata +2 -2
@@ -73,26 +73,41 @@ module Increase
73
73
  optional :trust, -> { Increase::EntityUpdateParams::Trust }
74
74
 
75
75
  # @!method initialize(entity_id:, corporation: nil, details_confirmed_at: nil, government_authority: nil, natural_person: nil, risk_rating: nil, terms_agreements: nil, third_party_verification: nil, trust: nil, request_options: {})
76
- # Some parameter documentations has been truncated, see
77
- # {Increase::Models::EntityUpdateParams} for more details.
78
- #
79
76
  # @param entity_id [String] The entity identifier.
80
77
  #
81
- # @param corporation [Increase::Models::EntityUpdateParams::Corporation] Details of the corporation entity to update. If you specify this parameter and t
78
+ # @param corporation [Increase::Models::EntityUpdateParams::Corporation]
79
+ # Details of the corporation entity to update. If you specify this parameter and
80
+ # the entity is not a corporation, the request will fail.
82
81
  #
83
- # @param details_confirmed_at [Time] When your user last confirmed the Entity's details. Depending on your program, y
82
+ # @param details_confirmed_at [Time]
83
+ # When your user last confirmed the Entity's details. Depending on your program,
84
+ # you may be required to affirmatively confirm details with your users on an
85
+ # annual basis.
84
86
  #
85
- # @param government_authority [Increase::Models::EntityUpdateParams::GovernmentAuthority] Details of the government authority entity to update. If you specify this parame
87
+ # @param government_authority [Increase::Models::EntityUpdateParams::GovernmentAuthority]
88
+ # Details of the government authority entity to update. If you specify this
89
+ # parameter and the entity is not a government authority, the request will fail.
86
90
  #
87
- # @param natural_person [Increase::Models::EntityUpdateParams::NaturalPerson] Details of the natural person entity to update. If you specify this parameter an
91
+ # @param natural_person [Increase::Models::EntityUpdateParams::NaturalPerson]
92
+ # Details of the natural person entity to update. If you specify this parameter
93
+ # and the entity is not a natural person, the request will fail.
88
94
  #
89
- # @param risk_rating [Increase::Models::EntityUpdateParams::RiskRating] An assessment of the entity’s potential risk of involvement in financial crimes,
95
+ # @param risk_rating [Increase::Models::EntityUpdateParams::RiskRating]
96
+ # An assessment of the entity’s potential risk of involvement in financial crimes,
97
+ # such as money laundering.
90
98
  #
91
- # @param terms_agreements [Array<Increase::Models::EntityUpdateParams::TermsAgreement>] New terms that the Entity agreed to. Not all programs are required to submit thi
99
+ # @param terms_agreements [Array<Increase::Models::EntityUpdateParams::TermsAgreement>]
100
+ # New terms that the Entity agreed to. Not all programs are required to submit
101
+ # this data. This will not archive previously submitted terms.
92
102
  #
93
- # @param third_party_verification [Increase::Models::EntityUpdateParams::ThirdPartyVerification] If you are using a third-party service for identity verification, you can use th
103
+ # @param third_party_verification [Increase::Models::EntityUpdateParams::ThirdPartyVerification]
104
+ # If you are using a third-party service for identity verification, you can use
105
+ # this field to associate this Entity with the identifier that represents them in
106
+ # that service.
94
107
  #
95
- # @param trust [Increase::Models::EntityUpdateParams::Trust] Details of the trust entity to update. If you specify this parameter and the ent
108
+ # @param trust [Increase::Models::EntityUpdateParams::Trust]
109
+ # Details of the trust entity to update. If you specify this parameter and the
110
+ # entity is not a trust, the request will fail.
96
111
  #
97
112
  # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}]
98
113
 
@@ -148,25 +163,36 @@ module Increase
148
163
  optional :website, String
149
164
 
150
165
  # @!method initialize(address: nil, email: nil, incorporation_state: nil, industry_code: nil, legal_identifier: nil, name: nil, website: nil)
151
- # Some parameter documentations has been truncated, see
152
- # {Increase::Models::EntityUpdateParams::Corporation} for more details.
153
- #
154
166
  # Details of the corporation entity to update. If you specify this parameter and
155
167
  # the entity is not a corporation, the request will fail.
156
168
  #
157
- # @param address [Increase::Models::EntityUpdateParams::Corporation::Address] The entity's physical address. Mail receiving locations like PO Boxes and PMB's
169
+ # @param address [Increase::Models::EntityUpdateParams::Corporation::Address]
170
+ # The entity's physical address. Mail receiving locations like PO Boxes and PMB's
171
+ # are disallowed.
158
172
  #
159
- # @param email [String] An email address for the business. Not every program requires an email for submi
173
+ # @param email [String]
174
+ # An email address for the business. Not every program requires an email for
175
+ # submitted Entities.
160
176
  #
161
- # @param incorporation_state [String] The two-letter United States Postal Service (USPS) abbreviation for the corporat
177
+ # @param incorporation_state [String]
178
+ # The two-letter United States Postal Service (USPS) abbreviation for the
179
+ # corporation's state of incorporation.
162
180
  #
163
- # @param industry_code [String] The North American Industry Classification System (NAICS) code for the corporati
181
+ # @param industry_code [String]
182
+ # The North American Industry Classification System (NAICS) code for the
183
+ # corporation's primary line of business. This is a number, like `5132` for
184
+ # `Software Publishers`. A full list of classification codes is available
185
+ # [here](https://increase.com/documentation/data-dictionary#north-american-industry-classification-system-codes).
164
186
  #
165
- # @param legal_identifier [Increase::Models::EntityUpdateParams::Corporation::LegalIdentifier] The legal identifier of the corporation. This is usually the Employer Identifica
187
+ # @param legal_identifier [Increase::Models::EntityUpdateParams::Corporation::LegalIdentifier]
188
+ # The legal identifier of the corporation. This is usually the Employer
189
+ # Identification Number (EIN).
166
190
  #
167
191
  # @param name [String] The legal name of the corporation.
168
192
  #
169
- # @param website [String] A website for the business. Not every program requires a website for submitted E
193
+ # @param website [String]
194
+ # A website for the business. Not every program requires a website for submitted
195
+ # Entities.
170
196
 
171
197
  # @see Increase::Models::EntityUpdateParams::Corporation#address
172
198
  class Address < Increase::Internal::Type::BaseModel
@@ -176,18 +202,19 @@ module Increase
176
202
  # @return [String]
177
203
  required :city, String
178
204
 
179
- # @!attribute country
180
- # The two-letter ISO 3166-1 alpha-2 code for the country of the address.
181
- #
182
- # @return [String]
183
- required :country, String
184
-
185
205
  # @!attribute line1
186
206
  # The first line of the address. This is usually the street number and street.
187
207
  #
188
208
  # @return [String]
189
209
  required :line1, String
190
210
 
211
+ # @!attribute country
212
+ # The two-letter ISO 3166-1 alpha-2 code for the country of the address. Defaults
213
+ # to `US`.
214
+ #
215
+ # @return [String, nil]
216
+ optional :country, String
217
+
191
218
  # @!attribute line2
192
219
  # The second line of the address. This might be the floor or room number.
193
220
  #
@@ -207,22 +234,23 @@ module Increase
207
234
  # @return [String, nil]
208
235
  optional :zip, String
209
236
 
210
- # @!method initialize(city:, country:, line1:, line2: nil, state: nil, zip: nil)
211
- # Some parameter documentations has been truncated, see
212
- # {Increase::Models::EntityUpdateParams::Corporation::Address} for more details.
213
- #
237
+ # @!method initialize(city:, line1:, country: nil, line2: nil, state: nil, zip: nil)
214
238
  # The entity's physical address. Mail receiving locations like PO Boxes and PMB's
215
239
  # are disallowed.
216
240
  #
217
241
  # @param city [String] The city, district, town, or village of the address.
218
242
  #
219
- # @param country [String] The two-letter ISO 3166-1 alpha-2 code for the country of the address.
220
- #
221
243
  # @param line1 [String] The first line of the address. This is usually the street number and street.
222
244
  #
245
+ # @param country [String]
246
+ # The two-letter ISO 3166-1 alpha-2 code for the country of the address. Defaults
247
+ # to `US`.
248
+ #
223
249
  # @param line2 [String] The second line of the address. This might be the floor or room number.
224
250
  #
225
- # @param state [String] The two-letter United States Postal Service (USPS) abbreviation for the US state
251
+ # @param state [String]
252
+ # The two-letter United States Postal Service (USPS) abbreviation for the US
253
+ # state, province, or region of the address. Required in certain countries.
226
254
  #
227
255
  # @param zip [String] The ZIP or postal code of the address. Required in certain countries.
228
256
  end
@@ -243,16 +271,15 @@ module Increase
243
271
  optional :category, enum: -> { Increase::EntityUpdateParams::Corporation::LegalIdentifier::Category }
244
272
 
245
273
  # @!method initialize(value:, category: nil)
246
- # Some parameter documentations has been truncated, see
247
- # {Increase::Models::EntityUpdateParams::Corporation::LegalIdentifier} for more
248
- # details.
249
- #
250
274
  # The legal identifier of the corporation. This is usually the Employer
251
275
  # Identification Number (EIN).
252
276
  #
253
- # @param value [String] The legal identifier itself. For US Employer Identification Numbers, submit nine
277
+ # @param value [String]
278
+ # The legal identifier itself. For US Employer Identification Numbers, submit nine
279
+ # digits with no dashes or other separators.
254
280
  #
255
- # @param category [Symbol, Increase::Models::EntityUpdateParams::Corporation::LegalIdentifier::Category] The category of the legal identifier.
281
+ # @param category [Symbol, Increase::Models::EntityUpdateParams::Corporation::LegalIdentifier::Category]
282
+ # The category of the legal identifier.
256
283
 
257
284
  # The category of the legal identifier.
258
285
  #
@@ -287,13 +314,12 @@ module Increase
287
314
  optional :name, String
288
315
 
289
316
  # @!method initialize(address: nil, name: nil)
290
- # Some parameter documentations has been truncated, see
291
- # {Increase::Models::EntityUpdateParams::GovernmentAuthority} for more details.
292
- #
293
317
  # Details of the government authority entity to update. If you specify this
294
318
  # parameter and the entity is not a government authority, the request will fail.
295
319
  #
296
- # @param address [Increase::Models::EntityUpdateParams::GovernmentAuthority::Address] The entity's physical address. Mail receiving locations like PO Boxes and PMB's
320
+ # @param address [Increase::Models::EntityUpdateParams::GovernmentAuthority::Address]
321
+ # The entity's physical address. Mail receiving locations like PO Boxes and PMB's
322
+ # are disallowed.
297
323
  #
298
324
  # @param name [String] The legal name of the government authority.
299
325
 
@@ -331,10 +357,6 @@ module Increase
331
357
  optional :line2, String
332
358
 
333
359
  # @!method initialize(city:, line1:, state:, zip:, line2: nil)
334
- # Some parameter documentations has been truncated, see
335
- # {Increase::Models::EntityUpdateParams::GovernmentAuthority::Address} for more
336
- # details.
337
- #
338
360
  # The entity's physical address. Mail receiving locations like PO Boxes and PMB's
339
361
  # are disallowed.
340
362
  #
@@ -342,7 +364,9 @@ module Increase
342
364
  #
343
365
  # @param line1 [String] The first line of the address. This is usually the street number and street.
344
366
  #
345
- # @param state [String] The two-letter United States Postal Service (USPS) abbreviation for the state of
367
+ # @param state [String]
368
+ # The two-letter United States Postal Service (USPS) abbreviation for the state of
369
+ # the address.
346
370
  #
347
371
  # @param zip [String] The ZIP code of the address.
348
372
  #
@@ -380,17 +404,21 @@ module Increase
380
404
  optional :name, String
381
405
 
382
406
  # @!method initialize(address: nil, confirmed_no_us_tax_id: nil, identification: nil, name: nil)
383
- # Some parameter documentations has been truncated, see
384
- # {Increase::Models::EntityUpdateParams::NaturalPerson} for more details.
385
- #
386
407
  # Details of the natural person entity to update. If you specify this parameter
387
408
  # and the entity is not a natural person, the request will fail.
388
409
  #
389
- # @param address [Increase::Models::EntityUpdateParams::NaturalPerson::Address] The entity's physical address. Mail receiving locations like PO Boxes and PMB's
410
+ # @param address [Increase::Models::EntityUpdateParams::NaturalPerson::Address]
411
+ # The entity's physical address. Mail receiving locations like PO Boxes and PMB's
412
+ # are disallowed.
390
413
  #
391
- # @param confirmed_no_us_tax_id [Boolean] The identification method for an individual can only be a passport, driver's lic
414
+ # @param confirmed_no_us_tax_id [Boolean]
415
+ # The identification method for an individual can only be a passport, driver's
416
+ # license, or other document if you've confirmed the individual does not have a US
417
+ # tax id (either a Social Security Number or Individual Taxpayer Identification
418
+ # Number).
392
419
  #
393
- # @param identification [Increase::Models::EntityUpdateParams::NaturalPerson::Identification] A means of verifying the person's identity.
420
+ # @param identification [Increase::Models::EntityUpdateParams::NaturalPerson::Identification]
421
+ # A means of verifying the person's identity.
394
422
  #
395
423
  # @param name [String] The legal name of the natural person.
396
424
 
@@ -402,18 +430,19 @@ module Increase
402
430
  # @return [String]
403
431
  required :city, String
404
432
 
405
- # @!attribute country
406
- # The two-letter ISO 3166-1 alpha-2 code for the country of the address.
407
- #
408
- # @return [String]
409
- required :country, String
410
-
411
433
  # @!attribute line1
412
434
  # The first line of the address. This is usually the street number and street.
413
435
  #
414
436
  # @return [String]
415
437
  required :line1, String
416
438
 
439
+ # @!attribute country
440
+ # The two-letter ISO 3166-1 alpha-2 code for the country of the address. Defaults
441
+ # to `US`.
442
+ #
443
+ # @return [String, nil]
444
+ optional :country, String
445
+
417
446
  # @!attribute line2
418
447
  # The second line of the address. This might be the floor or room number.
419
448
  #
@@ -433,22 +462,23 @@ module Increase
433
462
  # @return [String, nil]
434
463
  optional :zip, String
435
464
 
436
- # @!method initialize(city:, country:, line1:, line2: nil, state: nil, zip: nil)
437
- # Some parameter documentations has been truncated, see
438
- # {Increase::Models::EntityUpdateParams::NaturalPerson::Address} for more details.
439
- #
465
+ # @!method initialize(city:, line1:, country: nil, line2: nil, state: nil, zip: nil)
440
466
  # The entity's physical address. Mail receiving locations like PO Boxes and PMB's
441
467
  # are disallowed.
442
468
  #
443
469
  # @param city [String] The city, district, town, or village of the address.
444
470
  #
445
- # @param country [String] The two-letter ISO 3166-1 alpha-2 code for the country of the address.
446
- #
447
471
  # @param line1 [String] The first line of the address. This is usually the street number and street.
448
472
  #
473
+ # @param country [String]
474
+ # The two-letter ISO 3166-1 alpha-2 code for the country of the address. Defaults
475
+ # to `US`.
476
+ #
449
477
  # @param line2 [String] The second line of the address. This might be the floor or room number.
450
478
  #
451
- # @param state [String] The two-letter United States Postal Service (USPS) abbreviation for the US state
479
+ # @param state [String]
480
+ # The two-letter United States Postal Service (USPS) abbreviation for the US
481
+ # state, province, or region of the address. Required in certain countries.
452
482
  #
453
483
  # @param zip [String] The ZIP or postal code of the address. Required in certain countries.
454
484
  end
@@ -496,21 +526,29 @@ module Increase
496
526
  optional :passport, -> { Increase::EntityUpdateParams::NaturalPerson::Identification::Passport }
497
527
 
498
528
  # @!method initialize(method_:, number:, drivers_license: nil, other: nil, passport: nil)
499
- # Some parameter documentations has been truncated, see
500
- # {Increase::Models::EntityUpdateParams::NaturalPerson::Identification} for more
501
- # details.
502
- #
503
529
  # A means of verifying the person's identity.
504
530
  #
505
- # @param method_ [Symbol, Increase::Models::EntityUpdateParams::NaturalPerson::Identification::Method] A method that can be used to verify the individual's identity.
531
+ # @param method_ [Symbol, Increase::Models::EntityUpdateParams::NaturalPerson::Identification::Method]
532
+ # A method that can be used to verify the individual's identity.
506
533
  #
507
- # @param number [String] An identification number that can be used to verify the individual's identity, s
534
+ # @param number [String]
535
+ # An identification number that can be used to verify the individual's identity,
536
+ # such as a social security number. For Social Security Numbers and Individual
537
+ # Taxpayer Identification Numbers, submit nine digits with no dashes or other
538
+ # separators. When testing in sandbox, use one of our
539
+ # [sandbox test values](https://increase.com/documentation/sandbox-test-values).
508
540
  #
509
- # @param drivers_license [Increase::Models::EntityUpdateParams::NaturalPerson::Identification::DriversLicense] Information about the United States driver's license used for identification. Re
541
+ # @param drivers_license [Increase::Models::EntityUpdateParams::NaturalPerson::Identification::DriversLicense]
542
+ # Information about the United States driver's license used for identification.
543
+ # Required if `method` is equal to `drivers_license`.
510
544
  #
511
- # @param other [Increase::Models::EntityUpdateParams::NaturalPerson::Identification::Other] Information about the identification document provided. Required if `method` is
545
+ # @param other [Increase::Models::EntityUpdateParams::NaturalPerson::Identification::Other]
546
+ # Information about the identification document provided. Required if `method` is
547
+ # equal to `other`.
512
548
  #
513
- # @param passport [Increase::Models::EntityUpdateParams::NaturalPerson::Identification::Passport] Information about the passport used for identification. Required if `method` is
549
+ # @param passport [Increase::Models::EntityUpdateParams::NaturalPerson::Identification::Passport]
550
+ # Information about the passport used for identification. Required if `method` is
551
+ # equal to `passport`.
514
552
 
515
553
  # A method that can be used to verify the individual's identity.
516
554
  #
@@ -611,20 +649,20 @@ module Increase
611
649
  optional :expiration_date, Date
612
650
 
613
651
  # @!method initialize(country:, description:, file_id:, back_file_id: nil, expiration_date: nil)
614
- # Some parameter documentations has been truncated, see
615
- # {Increase::Models::EntityUpdateParams::NaturalPerson::Identification::Other} for
616
- # more details.
617
- #
618
652
  # Information about the identification document provided. Required if `method` is
619
653
  # equal to `other`.
620
654
  #
621
- # @param country [String] The two-character ISO 3166-1 code representing the country that issued the docum
655
+ # @param country [String]
656
+ # The two-character ISO 3166-1 code representing the country that issued the
657
+ # document (e.g., `US`).
622
658
  #
623
659
  # @param description [String] A description of the document submitted.
624
660
  #
625
661
  # @param file_id [String] The identifier of the File containing the front of the document.
626
662
  #
627
- # @param back_file_id [String] The identifier of the File containing the back of the document. Not every docume
663
+ # @param back_file_id [String]
664
+ # The identifier of the File containing the back of the document. Not every
665
+ # document has a reverse side.
628
666
  #
629
667
  # @param expiration_date [Date] The document's expiration date in YYYY-MM-DD format.
630
668
  end
@@ -651,14 +689,12 @@ module Increase
651
689
  required :file_id, String
652
690
 
653
691
  # @!method initialize(country:, expiration_date:, file_id:)
654
- # Some parameter documentations has been truncated, see
655
- # {Increase::Models::EntityUpdateParams::NaturalPerson::Identification::Passport}
656
- # for more details.
657
- #
658
692
  # Information about the passport used for identification. Required if `method` is
659
693
  # equal to `passport`.
660
694
  #
661
- # @param country [String] The two-character ISO 3166-1 code representing the country that issued the docum
695
+ # @param country [String]
696
+ # The two-character ISO 3166-1 code representing the country that issued the
697
+ # document (e.g., `US`).
662
698
  #
663
699
  # @param expiration_date [Date] The passport's expiration date in YYYY-MM-DD format.
664
700
  #
@@ -682,15 +718,15 @@ module Increase
682
718
  required :rating, enum: -> { Increase::EntityUpdateParams::RiskRating::Rating }
683
719
 
684
720
  # @!method initialize(rated_at:, rating:)
685
- # Some parameter documentations has been truncated, see
686
- # {Increase::Models::EntityUpdateParams::RiskRating} for more details.
687
- #
688
721
  # An assessment of the entity’s potential risk of involvement in financial crimes,
689
722
  # such as money laundering.
690
723
  #
691
- # @param rated_at [Time] The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the risk ra
724
+ # @param rated_at [Time]
725
+ # The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the risk
726
+ # rating was performed.
692
727
  #
693
- # @param rating [Symbol, Increase::Models::EntityUpdateParams::RiskRating::Rating] The rating given to this entity.
728
+ # @param rating [Symbol, Increase::Models::EntityUpdateParams::RiskRating::Rating]
729
+ # The rating given to this entity.
694
730
 
695
731
  # The rating given to this entity.
696
732
  #
@@ -732,9 +768,6 @@ module Increase
732
768
  required :terms_url, String
733
769
 
734
770
  # @!method initialize(agreed_at:, ip_address:, terms_url:)
735
- # Some parameter documentations has been truncated, see
736
- # {Increase::Models::EntityUpdateParams::TermsAgreement} for more details.
737
- #
738
771
  # @param agreed_at [Time] The timestamp of when the Entity agreed to the terms.
739
772
  #
740
773
  # @param ip_address [String] The IP address the Entity accessed reviewed the terms from.
@@ -762,7 +795,8 @@ module Increase
762
795
  #
763
796
  # @param reference [String] The reference identifier for the third party verification.
764
797
  #
765
- # @param vendor [Symbol, Increase::Models::EntityUpdateParams::ThirdPartyVerification::Vendor] The vendor that was used to perform the verification.
798
+ # @param vendor [Symbol, Increase::Models::EntityUpdateParams::ThirdPartyVerification::Vendor]
799
+ # The vendor that was used to perform the verification.
766
800
 
767
801
  # The vendor that was used to perform the verification.
768
802
  #
@@ -805,13 +839,12 @@ module Increase
805
839
  optional :name, String
806
840
 
807
841
  # @!method initialize(address: nil, name: nil)
808
- # Some parameter documentations has been truncated, see
809
- # {Increase::Models::EntityUpdateParams::Trust} for more details.
810
- #
811
842
  # Details of the trust entity to update. If you specify this parameter and the
812
843
  # entity is not a trust, the request will fail.
813
844
  #
814
- # @param address [Increase::Models::EntityUpdateParams::Trust::Address] The entity's physical address. Mail receiving locations like PO Boxes and PMB's
845
+ # @param address [Increase::Models::EntityUpdateParams::Trust::Address]
846
+ # The entity's physical address. Mail receiving locations like PO Boxes and PMB's
847
+ # are disallowed.
815
848
  #
816
849
  # @param name [String] The legal name of the trust.
817
850
 
@@ -849,9 +882,6 @@ module Increase
849
882
  optional :line2, String
850
883
 
851
884
  # @!method initialize(city:, line1:, state:, zip:, line2: nil)
852
- # Some parameter documentations has been truncated, see
853
- # {Increase::Models::EntityUpdateParams::Trust::Address} for more details.
854
- #
855
885
  # The entity's physical address. Mail receiving locations like PO Boxes and PMB's
856
886
  # are disallowed.
857
887
  #
@@ -859,7 +889,9 @@ module Increase
859
889
  #
860
890
  # @param line1 [String] The first line of the address. This is usually the street number and street.
861
891
  #
862
- # @param state [String] The two-letter United States Postal Service (USPS) abbreviation for the state of
892
+ # @param state [String]
893
+ # The two-letter United States Postal Service (USPS) abbreviation for the state of
894
+ # the address.
863
895
  #
864
896
  # @param zip [String] The ZIP code of the address.
865
897
  #
@@ -43,9 +43,6 @@ module Increase
43
43
  required :type, enum: -> { Increase::Event::Type }
44
44
 
45
45
  # @!method initialize(id:, associated_object_id:, associated_object_type:, category:, created_at:, type:)
46
- # Some parameter documentations has been truncated, see {Increase::Models::Event}
47
- # for more details.
48
- #
49
46
  # Events are records of things that happened to objects at Increase. Events are
50
47
  # accessible via the List Events endpoint and can be delivered to your application
51
48
  # via webhooks. For more information, see our
@@ -57,11 +54,15 @@ module Increase
57
54
  #
58
55
  # @param associated_object_type [String] The type of the object that generated this Event.
59
56
  #
60
- # @param category [Symbol, Increase::Models::Event::Category] The category of the Event. We may add additional possible values for this enum o
57
+ # @param category [Symbol, Increase::Models::Event::Category]
58
+ # The category of the Event. We may add additional possible values for this enum
59
+ # over time; your application should be able to handle such additions gracefully.
61
60
  #
62
61
  # @param created_at [Time] The time the Event was created.
63
62
  #
64
- # @param type [Symbol, Increase::Models::Event::Type] A constant representing the object's type. For this resource it will always be `
63
+ # @param type [Symbol, Increase::Models::Event::Type]
64
+ # A constant representing the object's type. For this resource it will always be
65
+ # `event`.
65
66
 
66
67
  # The category of the Event. We may add additional possible values for this enum
67
68
  # over time; your application should be able to handle such additions gracefully.
@@ -253,6 +254,14 @@ module Increase
253
254
  # Occurs whenever an Inbound Mail Item is updated.
254
255
  INBOUND_MAIL_ITEM_UPDATED = :"inbound_mail_item.updated"
255
256
 
257
+ # Occurs whenever an Inbound Real-Time Payments Request for Payment is created.
258
+ INBOUND_REAL_TIME_PAYMENTS_REQUEST_FOR_PAYMENT_CREATED =
259
+ :"inbound_real_time_payments_request_for_payment.created"
260
+
261
+ # Occurs whenever an Inbound Real-Time Payments Request for Payment is updated.
262
+ INBOUND_REAL_TIME_PAYMENTS_REQUEST_FOR_PAYMENT_UPDATED =
263
+ :"inbound_real_time_payments_request_for_payment.updated"
264
+
256
265
  # Occurs whenever an Inbound Real-Time Payments Transfer is created.
257
266
  INBOUND_REAL_TIME_PAYMENTS_TRANSFER_CREATED = :"inbound_real_time_payments_transfer.created"
258
267
 
@@ -42,10 +42,8 @@ module Increase
42
42
  optional :order_by, -> { Increase::EventListParams::OrderBy }
43
43
 
44
44
  # @!method initialize(associated_object_id: nil, category: nil, created_at: nil, cursor: nil, limit: nil, order_by: nil, request_options: {})
45
- # Some parameter documentations has been truncated, see
46
- # {Increase::Models::EventListParams} for more details.
47
- #
48
- # @param associated_object_id [String] Filter Events to those belonging to the object with the provided identifier.
45
+ # @param associated_object_id [String]
46
+ # Filter Events to those belonging to the object with the provided identifier.
49
47
  #
50
48
  # @param category [Increase::Models::EventListParams::Category]
51
49
  #
@@ -53,7 +51,9 @@ module Increase
53
51
  #
54
52
  # @param cursor [String] Return the page of entries after this one.
55
53
  #
56
- # @param limit [Integer] Limit the size of the list that is returned. The default (and maximum) is 100 ob
54
+ # @param limit [Integer]
55
+ # Limit the size of the list that is returned. The default (and maximum) is 100
56
+ # objects.
57
57
  #
58
58
  # @param order_by [Increase::Models::EventListParams::OrderBy]
59
59
  #
@@ -71,10 +71,10 @@ module Increase
71
71
  api_name: :in
72
72
 
73
73
  # @!method initialize(in_: nil)
74
- # Some parameter documentations has been truncated, see
75
- # {Increase::Models::EventListParams::Category} for more details.
76
- #
77
- # @param in_ [Array<Symbol, Increase::Models::EventListParams::Category::In>] Filter Events for those with the specified category or categories. For GET reque
74
+ # @param in_ [Array<Symbol, Increase::Models::EventListParams::Category::In>]
75
+ # Filter Events for those with the specified category or categories. For GET
76
+ # requests, this should be encoded as a comma-delimited string, such as
77
+ # `?in=one,two,three`.
78
78
 
79
79
  module In
80
80
  extend Increase::Internal::Type::Enum
@@ -262,6 +262,14 @@ module Increase
262
262
  # Occurs whenever an Inbound Mail Item is updated.
263
263
  INBOUND_MAIL_ITEM_UPDATED = :"inbound_mail_item.updated"
264
264
 
265
+ # Occurs whenever an Inbound Real-Time Payments Request for Payment is created.
266
+ INBOUND_REAL_TIME_PAYMENTS_REQUEST_FOR_PAYMENT_CREATED =
267
+ :"inbound_real_time_payments_request_for_payment.created"
268
+
269
+ # Occurs whenever an Inbound Real-Time Payments Request for Payment is updated.
270
+ INBOUND_REAL_TIME_PAYMENTS_REQUEST_FOR_PAYMENT_UPDATED =
271
+ :"inbound_real_time_payments_request_for_payment.updated"
272
+
265
273
  # Occurs whenever an Inbound Real-Time Payments Transfer is created.
266
274
  INBOUND_REAL_TIME_PAYMENTS_TRANSFER_CREATED = :"inbound_real_time_payments_transfer.created"
267
275
 
@@ -455,16 +463,21 @@ module Increase
455
463
  optional :on_or_before, Time
456
464
 
457
465
  # @!method initialize(after: nil, before: nil, on_or_after: nil, on_or_before: nil)
458
- # Some parameter documentations has been truncated, see
459
- # {Increase::Models::EventListParams::CreatedAt} for more details.
460
- #
461
- # @param after [Time] Return results after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) tim
466
+ # @param after [Time]
467
+ # Return results after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)
468
+ # timestamp.
462
469
  #
463
- # @param before [Time] Return results before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) ti
470
+ # @param before [Time]
471
+ # Return results before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)
472
+ # timestamp.
464
473
  #
465
- # @param on_or_after [Time] Return results on or after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_860
474
+ # @param on_or_after [Time]
475
+ # Return results on or after this
476
+ # [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.
466
477
  #
467
- # @param on_or_before [Time] Return results on or before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_86
478
+ # @param on_or_before [Time]
479
+ # Return results on or before this
480
+ # [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.
468
481
  end
469
482
 
470
483
  class OrderBy < Increase::Internal::Type::BaseModel
@@ -481,7 +494,8 @@ module Increase
481
494
  optional :field, enum: -> { Increase::EventListParams::OrderBy::Field }
482
495
 
483
496
  # @!method initialize(direction: nil, field: nil)
484
- # @param direction [Symbol, Increase::Models::EventListParams::OrderBy::Direction] The direction to order in.
497
+ # @param direction [Symbol, Increase::Models::EventListParams::OrderBy::Direction]
498
+ # The direction to order in.
485
499
  #
486
500
  # @param field [Symbol, Increase::Models::EventListParams::OrderBy::Field] The field to order by.
487
501
 
@@ -60,9 +60,6 @@ module Increase
60
60
  required :url, String
61
61
 
62
62
  # @!method initialize(id:, created_at:, idempotency_key:, oauth_connection_id:, selected_event_categories:, status:, type:, url:)
63
- # Some parameter documentations has been truncated, see
64
- # {Increase::Models::EventSubscription} for more details.
65
- #
66
63
  # Webhooks are event notifications we send to you by HTTPS POST requests. Event
67
64
  # Subscriptions are how you configure your application to listen for them. You can
68
65
  # create an Event Subscription through your
@@ -74,15 +71,25 @@ module Increase
74
71
  #
75
72
  # @param created_at [Time] The time the event subscription was created.
76
73
  #
77
- # @param idempotency_key [String, nil] The idempotency key you chose for this object. This value is unique across Incre
74
+ # @param idempotency_key [String, nil]
75
+ # The idempotency key you chose for this object. This value is unique across
76
+ # Increase and is used to ensure that a request is only processed once. Learn more
77
+ # about [idempotency](https://increase.com/documentation/idempotency-keys).
78
78
  #
79
- # @param oauth_connection_id [String, nil] If specified, this subscription will only receive webhooks for Events associated
79
+ # @param oauth_connection_id [String, nil]
80
+ # If specified, this subscription will only receive webhooks for Events associated
81
+ # with this OAuth Connection.
80
82
  #
81
- # @param selected_event_categories [Array<Increase::Models::EventSubscription::SelectedEventCategory>, nil] If specified, this subscription will only receive webhooks for Events with the s
83
+ # @param selected_event_categories [Array<Increase::Models::EventSubscription::SelectedEventCategory>, nil]
84
+ # If specified, this subscription will only receive webhooks for Events with the
85
+ # specified `category`.
82
86
  #
83
- # @param status [Symbol, Increase::Models::EventSubscription::Status] This indicates if we'll send notifications to this subscription.
87
+ # @param status [Symbol, Increase::Models::EventSubscription::Status]
88
+ # This indicates if we'll send notifications to this subscription.
84
89
  #
85
- # @param type [Symbol, Increase::Models::EventSubscription::Type] A constant representing the object's type. For this resource it will always be `
90
+ # @param type [Symbol, Increase::Models::EventSubscription::Type]
91
+ # A constant representing the object's type. For this resource it will always be
92
+ # `event_subscription`.
86
93
  #
87
94
  # @param url [String] The webhook url where we'll send notifications.
88
95
 
@@ -96,7 +103,8 @@ module Increase
96
103
  nil?: true
97
104
 
98
105
  # @!method initialize(event_category:)
99
- # @param event_category [Symbol, Increase::Models::EventSubscription::SelectedEventCategory::EventCategory, nil] The category of the Event.
106
+ # @param event_category [Symbol, Increase::Models::EventSubscription::SelectedEventCategory::EventCategory, nil]
107
+ # The category of the Event.
100
108
 
101
109
  # The category of the Event.
102
110
  #
@@ -287,6 +295,14 @@ module Increase
287
295
  # Occurs whenever an Inbound Mail Item is updated.
288
296
  INBOUND_MAIL_ITEM_UPDATED = :"inbound_mail_item.updated"
289
297
 
298
+ # Occurs whenever an Inbound Real-Time Payments Request for Payment is created.
299
+ INBOUND_REAL_TIME_PAYMENTS_REQUEST_FOR_PAYMENT_CREATED =
300
+ :"inbound_real_time_payments_request_for_payment.created"
301
+
302
+ # Occurs whenever an Inbound Real-Time Payments Request for Payment is updated.
303
+ INBOUND_REAL_TIME_PAYMENTS_REQUEST_FOR_PAYMENT_UPDATED =
304
+ :"inbound_real_time_payments_request_for_payment.updated"
305
+
290
306
  # Occurs whenever an Inbound Real-Time Payments Transfer is created.
291
307
  INBOUND_REAL_TIME_PAYMENTS_TRANSFER_CREATED = :"inbound_real_time_payments_transfer.created"
292
308