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
@@ -169,9 +169,6 @@ module Increase
169
169
  required :unique_end_to_end_transaction_reference, String, nil?: true
170
170
 
171
171
  # @!method initialize(id:, account_id:, account_number:, amount:, approval:, cancellation:, created_at:, created_by:, creditor:, currency:, debtor:, external_account_id:, idempotency_key:, inbound_wire_drawdown_request_id:, network:, pending_transaction_id:, remittance:, reversal:, routing_number:, source_account_number_id:, status:, submission:, transaction_id:, type:, unique_end_to_end_transaction_reference:)
172
- # Some parameter documentations has been truncated, see
173
- # {Increase::Models::WireTransfer} for more details.
174
- #
175
172
  # Wire transfers move funds between your Increase account and any other account
176
173
  # accessible by Fedwire.
177
174
  #
@@ -183,33 +180,56 @@ module Increase
183
180
  #
184
181
  # @param amount [Integer] The transfer amount in USD cents.
185
182
  #
186
- # @param approval [Increase::Models::WireTransfer::Approval, nil] If your account requires approvals for transfers and the transfer was approved,
183
+ # @param approval [Increase::Models::WireTransfer::Approval, nil]
184
+ # If your account requires approvals for transfers and the transfer was approved,
185
+ # this will contain details of the approval.
187
186
  #
188
- # @param cancellation [Increase::Models::WireTransfer::Cancellation, nil] If your account requires approvals for transfers and the transfer was not approv
187
+ # @param cancellation [Increase::Models::WireTransfer::Cancellation, nil]
188
+ # If your account requires approvals for transfers and the transfer was not
189
+ # approved, this will contain details of the cancellation.
189
190
  #
190
- # @param created_at [Time] The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which th
191
+ # @param created_at [Time]
192
+ # The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
193
+ # the transfer was created.
191
194
  #
192
- # @param created_by [Increase::Models::WireTransfer::CreatedBy, nil] What object created the transfer, either via the API or the dashboard.
195
+ # @param created_by [Increase::Models::WireTransfer::CreatedBy, nil]
196
+ # What object created the transfer, either via the API or the dashboard.
193
197
  #
194
- # @param creditor [Increase::Models::WireTransfer::Creditor, nil] The person or business that is receiving the funds from the transfer.
198
+ # @param creditor [Increase::Models::WireTransfer::Creditor, nil]
199
+ # The person or business that is receiving the funds from the transfer.
195
200
  #
196
- # @param currency [Symbol, Increase::Models::WireTransfer::Currency] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the transfer's c
201
+ # @param currency [Symbol, Increase::Models::WireTransfer::Currency]
202
+ # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the transfer's
203
+ # currency. For wire transfers this is always equal to `usd`.
197
204
  #
198
- # @param debtor [Increase::Models::WireTransfer::Debtor, nil] The person or business whose funds are being transferred.
205
+ # @param debtor [Increase::Models::WireTransfer::Debtor, nil]
206
+ # The person or business whose funds are being transferred.
199
207
  #
200
- # @param external_account_id [String, nil] The identifier of the External Account the transfer was made to, if any.
208
+ # @param external_account_id [String, nil]
209
+ # The identifier of the External Account the transfer was made to, if any.
201
210
  #
202
- # @param idempotency_key [String, nil] The idempotency key you chose for this object. This value is unique across Incre
211
+ # @param idempotency_key [String, nil]
212
+ # The idempotency key you chose for this object. This value is unique across
213
+ # Increase and is used to ensure that a request is only processed once. Learn more
214
+ # about [idempotency](https://increase.com/documentation/idempotency-keys).
203
215
  #
204
- # @param inbound_wire_drawdown_request_id [String, nil] The ID of an Inbound Wire Drawdown Request in response to which this transfer wa
216
+ # @param inbound_wire_drawdown_request_id [String, nil]
217
+ # The ID of an Inbound Wire Drawdown Request in response to which this transfer
218
+ # was sent.
205
219
  #
206
220
  # @param network [Symbol, Increase::Models::WireTransfer::Network] The transfer's network.
207
221
  #
208
- # @param pending_transaction_id [String, nil] The ID for the pending transaction representing the transfer. A pending transact
222
+ # @param pending_transaction_id [String, nil]
223
+ # The ID for the pending transaction representing the transfer. A pending
224
+ # transaction is created when the transfer
225
+ # [requires approval](https://increase.com/documentation/transfer-approvals#transfer-approvals)
226
+ # by someone else in your organization.
209
227
  #
210
- # @param remittance [Increase::Models::WireTransfer::Remittance, nil] Remittance information sent with the wire transfer.
228
+ # @param remittance [Increase::Models::WireTransfer::Remittance, nil]
229
+ # Remittance information sent with the wire transfer.
211
230
  #
212
- # @param reversal [Increase::Models::WireTransfer::Reversal, nil] If your transfer is reversed, this will contain details of the reversal.
231
+ # @param reversal [Increase::Models::WireTransfer::Reversal, nil]
232
+ # If your transfer is reversed, this will contain details of the reversal.
213
233
  #
214
234
  # @param routing_number [String] The American Bankers' Association (ABA) Routing Transit Number (RTN).
215
235
  #
@@ -217,13 +237,20 @@ module Increase
217
237
  #
218
238
  # @param status [Symbol, Increase::Models::WireTransfer::Status] The lifecycle status of the transfer.
219
239
  #
220
- # @param submission [Increase::Models::WireTransfer::Submission, nil] After the transfer is submitted to Fedwire, this will contain supplemental detai
240
+ # @param submission [Increase::Models::WireTransfer::Submission, nil]
241
+ # After the transfer is submitted to Fedwire, this will contain supplemental
242
+ # details.
221
243
  #
222
244
  # @param transaction_id [String, nil] The ID for the transaction funding the transfer.
223
245
  #
224
- # @param type [Symbol, Increase::Models::WireTransfer::Type] A constant representing the object's type. For this resource it will always be `
246
+ # @param type [Symbol, Increase::Models::WireTransfer::Type]
247
+ # A constant representing the object's type. For this resource it will always be
248
+ # `wire_transfer`.
225
249
  #
226
- # @param unique_end_to_end_transaction_reference [String, nil] The unique end-to-end transaction reference ([UETR](https://www.swift.com/paymen
250
+ # @param unique_end_to_end_transaction_reference [String, nil]
251
+ # The unique end-to-end transaction reference
252
+ # ([UETR](https://www.swift.com/payments/what-unique-end-end-transaction-reference-uetr))
253
+ # of the transfer.
227
254
 
228
255
  # @see Increase::Models::WireTransfer#approval
229
256
  class Approval < Increase::Internal::Type::BaseModel
@@ -242,15 +269,16 @@ module Increase
242
269
  required :approved_by, String, nil?: true
243
270
 
244
271
  # @!method initialize(approved_at:, approved_by:)
245
- # Some parameter documentations has been truncated, see
246
- # {Increase::Models::WireTransfer::Approval} for more details.
247
- #
248
272
  # If your account requires approvals for transfers and the transfer was approved,
249
273
  # this will contain details of the approval.
250
274
  #
251
- # @param approved_at [Time] The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which th
275
+ # @param approved_at [Time]
276
+ # The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
277
+ # the transfer was approved.
252
278
  #
253
- # @param approved_by [String, nil] If the Transfer was approved by a user in the dashboard, the email address of th
279
+ # @param approved_by [String, nil]
280
+ # If the Transfer was approved by a user in the dashboard, the email address of
281
+ # that user.
254
282
  end
255
283
 
256
284
  # @see Increase::Models::WireTransfer#cancellation
@@ -270,15 +298,16 @@ module Increase
270
298
  required :canceled_by, String, nil?: true
271
299
 
272
300
  # @!method initialize(canceled_at:, canceled_by:)
273
- # Some parameter documentations has been truncated, see
274
- # {Increase::Models::WireTransfer::Cancellation} for more details.
275
- #
276
301
  # If your account requires approvals for transfers and the transfer was not
277
302
  # approved, this will contain details of the cancellation.
278
303
  #
279
- # @param canceled_at [Time] The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which th
304
+ # @param canceled_at [Time]
305
+ # The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
306
+ # the Transfer was canceled.
280
307
  #
281
- # @param canceled_by [String, nil] If the Transfer was canceled by a user in the dashboard, the email address of th
308
+ # @param canceled_by [String, nil]
309
+ # If the Transfer was canceled by a user in the dashboard, the email address of
310
+ # that user.
282
311
  end
283
312
 
284
313
  # @see Increase::Models::WireTransfer#created_by
@@ -310,13 +339,17 @@ module Increase
310
339
  # @!method initialize(category:, api_key: nil, oauth_application: nil, user: nil)
311
340
  # What object created the transfer, either via the API or the dashboard.
312
341
  #
313
- # @param category [Symbol, Increase::Models::WireTransfer::CreatedBy::Category] The type of object that created this transfer.
342
+ # @param category [Symbol, Increase::Models::WireTransfer::CreatedBy::Category]
343
+ # The type of object that created this transfer.
314
344
  #
315
- # @param api_key [Increase::Models::WireTransfer::CreatedBy::APIKey, nil] If present, details about the API key that created the transfer.
345
+ # @param api_key [Increase::Models::WireTransfer::CreatedBy::APIKey, nil]
346
+ # If present, details about the API key that created the transfer.
316
347
  #
317
- # @param oauth_application [Increase::Models::WireTransfer::CreatedBy::OAuthApplication, nil] If present, details about the OAuth Application that created the transfer.
348
+ # @param oauth_application [Increase::Models::WireTransfer::CreatedBy::OAuthApplication, nil]
349
+ # If present, details about the OAuth Application that created the transfer.
318
350
  #
319
- # @param user [Increase::Models::WireTransfer::CreatedBy::User, nil] If present, details about the User that created the transfer.
351
+ # @param user [Increase::Models::WireTransfer::CreatedBy::User, nil]
352
+ # If present, details about the User that created the transfer.
320
353
 
321
354
  # The type of object that created this transfer.
322
355
  #
@@ -412,7 +445,8 @@ module Increase
412
445
  # @!method initialize(unstructured:)
413
446
  # The person or business's address.
414
447
  #
415
- # @param unstructured [Increase::Models::WireTransfer::Creditor::Address::Unstructured, nil] Unstructured address lines.
448
+ # @param unstructured [Increase::Models::WireTransfer::Creditor::Address::Unstructured, nil]
449
+ # Unstructured address lines.
416
450
 
417
451
  # @see Increase::Models::WireTransfer::Creditor::Address#unstructured
418
452
  class Unstructured < Increase::Internal::Type::BaseModel
@@ -492,7 +526,8 @@ module Increase
492
526
  # @!method initialize(unstructured:)
493
527
  # The person or business's address.
494
528
  #
495
- # @param unstructured [Increase::Models::WireTransfer::Debtor::Address::Unstructured, nil] Unstructured address lines.
529
+ # @param unstructured [Increase::Models::WireTransfer::Debtor::Address::Unstructured, nil]
530
+ # Unstructured address lines.
496
531
 
497
532
  # @see Increase::Models::WireTransfer::Debtor::Address#unstructured
498
533
  class Unstructured < Increase::Internal::Type::BaseModel
@@ -561,16 +596,18 @@ module Increase
561
596
  optional :unstructured, -> { Increase::WireTransfer::Remittance::Unstructured }, nil?: true
562
597
 
563
598
  # @!method initialize(category:, tax: nil, unstructured: nil)
564
- # Some parameter documentations has been truncated, see
565
- # {Increase::Models::WireTransfer::Remittance} for more details.
566
- #
567
599
  # Remittance information sent with the wire transfer.
568
600
  #
569
- # @param category [Symbol, Increase::Models::WireTransfer::Remittance::Category] The type of remittance information being passed.
601
+ # @param category [Symbol, Increase::Models::WireTransfer::Remittance::Category]
602
+ # The type of remittance information being passed.
570
603
  #
571
- # @param tax [Increase::Models::WireTransfer::Remittance::Tax, nil] Internal Revenue Service (IRS) tax repayment information. Required if `category`
604
+ # @param tax [Increase::Models::WireTransfer::Remittance::Tax, nil]
605
+ # Internal Revenue Service (IRS) tax repayment information. Required if `category`
606
+ # is equal to `tax`.
572
607
  #
573
- # @param unstructured [Increase::Models::WireTransfer::Remittance::Unstructured, nil] Unstructured remittance information. Required if `category` is equal to `unstruc
608
+ # @param unstructured [Increase::Models::WireTransfer::Remittance::Unstructured, nil]
609
+ # Unstructured remittance information. Required if `category` is equal to
610
+ # `unstructured`.
574
611
 
575
612
  # The type of remittance information being passed.
576
613
  #
@@ -611,15 +648,16 @@ module Increase
611
648
  required :type_code, String
612
649
 
613
650
  # @!method initialize(date:, identification_number:, type_code:)
614
- # Some parameter documentations has been truncated, see
615
- # {Increase::Models::WireTransfer::Remittance::Tax} for more details.
616
- #
617
651
  # Internal Revenue Service (IRS) tax repayment information. Required if `category`
618
652
  # is equal to `tax`.
619
653
  #
620
- # @param date [Date] The month and year the tax payment is for, in YYYY-MM-DD format. The day is igno
654
+ # @param date [Date]
655
+ # The month and year the tax payment is for, in YYYY-MM-DD format. The day is
656
+ # ignored.
621
657
  #
622
- # @param identification_number [String] The 9-digit Tax Identification Number (TIN) or Employer Identification Number (E
658
+ # @param identification_number [String]
659
+ # The 9-digit Tax Identification Number (TIN) or Employer Identification Number
660
+ # (EIN).
623
661
  #
624
662
  # @param type_code [String] The 5-character tax type code.
625
663
  end
@@ -731,20 +769,22 @@ module Increase
731
769
  required :wire_transfer_id, String
732
770
 
733
771
  # @!method initialize(amount:, created_at:, debtor_routing_number:, description:, input_cycle_date:, input_message_accountability_data:, input_sequence_number:, input_source:, instruction_identification:, return_reason_additional_information:, return_reason_code:, return_reason_code_description:, transaction_id:, wire_transfer_id:)
734
- # Some parameter documentations has been truncated, see
735
- # {Increase::Models::WireTransfer::Reversal} for more details.
736
- #
737
772
  # If your transfer is reversed, this will contain details of the reversal.
738
773
  #
739
774
  # @param amount [Integer] The amount that was reversed in USD cents.
740
775
  #
741
- # @param created_at [Time] The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which th
776
+ # @param created_at [Time]
777
+ # The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
778
+ # the reversal was created.
742
779
  #
743
780
  # @param debtor_routing_number [String, nil] The debtor's routing number.
744
781
  #
745
- # @param description [String] The description on the reversal message from Fedwire, set by the reversing bank.
782
+ # @param description [String]
783
+ # The description on the reversal message from Fedwire, set by the reversing bank.
746
784
  #
747
- # @param input_cycle_date [Date] The Fedwire cycle date for the wire reversal. The "Fedwire day" begins at 9:00 P
785
+ # @param input_cycle_date [Date]
786
+ # The Fedwire cycle date for the wire reversal. The "Fedwire day" begins at 9:00
787
+ # PM Eastern Time on the evening before the `cycle date`.
748
788
  #
749
789
  # @param input_message_accountability_data [String] The Fedwire transaction identifier.
750
790
  #
@@ -754,11 +794,16 @@ module Increase
754
794
  #
755
795
  # @param instruction_identification [String, nil] The sending bank's identifier for the reversal.
756
796
  #
757
- # @param return_reason_additional_information [String, nil] Additional information about the reason for the reversal.
797
+ # @param return_reason_additional_information [String, nil]
798
+ # Additional information about the reason for the reversal.
758
799
  #
759
- # @param return_reason_code [String, nil] A code provided by the sending bank giving a reason for the reversal. The common
800
+ # @param return_reason_code [String, nil]
801
+ # A code provided by the sending bank giving a reason for the reversal. The common
802
+ # return reason codes are
803
+ # [documented here](/documentation/wire-reversals#reversal-reason-codes).
760
804
  #
761
- # @param return_reason_code_description [String, nil] An Increase-generated description of the `return_reason_code`.
805
+ # @param return_reason_code_description [String, nil]
806
+ # An Increase-generated description of the `return_reason_code`.
762
807
  #
763
808
  # @param transaction_id [String] The ID for the Transaction associated with the transfer reversal.
764
809
  #
@@ -79,30 +79,40 @@ module Increase
79
79
  optional :source_account_number_id, String
80
80
 
81
81
  # @!method initialize(account_id:, amount:, creditor:, remittance:, account_number: nil, debtor: nil, external_account_id: nil, inbound_wire_drawdown_request_id: nil, require_approval: nil, routing_number: nil, source_account_number_id: nil, request_options: {})
82
- # Some parameter documentations has been truncated, see
83
- # {Increase::Models::WireTransferCreateParams} for more details.
84
- #
85
82
  # @param account_id [String] The identifier for the account that will send the transfer.
86
83
  #
87
84
  # @param amount [Integer] The transfer amount in USD cents.
88
85
  #
89
- # @param creditor [Increase::Models::WireTransferCreateParams::Creditor] The person or business that is receiving the funds from the transfer.
86
+ # @param creditor [Increase::Models::WireTransferCreateParams::Creditor]
87
+ # The person or business that is receiving the funds from the transfer.
90
88
  #
91
- # @param remittance [Increase::Models::WireTransferCreateParams::Remittance] Additional remittance information related to the wire transfer.
89
+ # @param remittance [Increase::Models::WireTransferCreateParams::Remittance]
90
+ # Additional remittance information related to the wire transfer.
92
91
  #
93
92
  # @param account_number [String] The account number for the destination account.
94
93
  #
95
- # @param debtor [Increase::Models::WireTransferCreateParams::Debtor] The person or business whose funds are being transferred. This is only necessary
94
+ # @param debtor [Increase::Models::WireTransferCreateParams::Debtor]
95
+ # The person or business whose funds are being transferred. This is only necessary
96
+ # if you're transferring from a commingled account. Otherwise, we'll use the
97
+ # associated entity's details.
96
98
  #
97
- # @param external_account_id [String] The ID of an External Account to initiate a transfer to. If this parameter is pr
99
+ # @param external_account_id [String]
100
+ # The ID of an External Account to initiate a transfer to. If this parameter is
101
+ # provided, `account_number` and `routing_number` must be absent.
98
102
  #
99
- # @param inbound_wire_drawdown_request_id [String] The ID of an Inbound Wire Drawdown Request in response to which this transfer is
103
+ # @param inbound_wire_drawdown_request_id [String]
104
+ # The ID of an Inbound Wire Drawdown Request in response to which this transfer is
105
+ # being sent.
100
106
  #
101
- # @param require_approval [Boolean] Whether the transfer requires explicit approval via the dashboard or API.
107
+ # @param require_approval [Boolean]
108
+ # Whether the transfer requires explicit approval via the dashboard or API.
102
109
  #
103
- # @param routing_number [String] The American Bankers' Association (ABA) Routing Transit Number (RTN) for the des
110
+ # @param routing_number [String]
111
+ # The American Bankers' Association (ABA) Routing Transit Number (RTN) for the
112
+ # destination account.
104
113
  #
105
- # @param source_account_number_id [String] The ID of an Account Number that will be passed to the wire's recipient
114
+ # @param source_account_number_id [String]
115
+ # The ID of an Account Number that will be passed to the wire's recipient
106
116
  #
107
117
  # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}]
108
118
 
@@ -124,7 +134,8 @@ module Increase
124
134
  #
125
135
  # @param name [String] The person or business's name.
126
136
  #
127
- # @param address [Increase::Models::WireTransferCreateParams::Creditor::Address] The person or business's address.
137
+ # @param address [Increase::Models::WireTransferCreateParams::Creditor::Address]
138
+ # The person or business's address.
128
139
 
129
140
  # @see Increase::Models::WireTransferCreateParams::Creditor#address
130
141
  class Address < Increase::Internal::Type::BaseModel
@@ -137,7 +148,8 @@ module Increase
137
148
  # @!method initialize(unstructured:)
138
149
  # The person or business's address.
139
150
  #
140
- # @param unstructured [Increase::Models::WireTransferCreateParams::Creditor::Address::Unstructured] Unstructured address lines.
151
+ # @param unstructured [Increase::Models::WireTransferCreateParams::Creditor::Address::Unstructured]
152
+ # Unstructured address lines.
141
153
 
142
154
  # @see Increase::Models::WireTransferCreateParams::Creditor::Address#unstructured
143
155
  class Unstructured < Increase::Internal::Type::BaseModel
@@ -193,16 +205,18 @@ module Increase
193
205
  optional :unstructured, -> { Increase::WireTransferCreateParams::Remittance::Unstructured }
194
206
 
195
207
  # @!method initialize(category:, tax: nil, unstructured: nil)
196
- # Some parameter documentations has been truncated, see
197
- # {Increase::Models::WireTransferCreateParams::Remittance} for more details.
198
- #
199
208
  # Additional remittance information related to the wire transfer.
200
209
  #
201
- # @param category [Symbol, Increase::Models::WireTransferCreateParams::Remittance::Category] The type of remittance information being passed.
210
+ # @param category [Symbol, Increase::Models::WireTransferCreateParams::Remittance::Category]
211
+ # The type of remittance information being passed.
202
212
  #
203
- # @param tax [Increase::Models::WireTransferCreateParams::Remittance::Tax] Internal Revenue Service (IRS) tax repayment information. Required if `category`
213
+ # @param tax [Increase::Models::WireTransferCreateParams::Remittance::Tax]
214
+ # Internal Revenue Service (IRS) tax repayment information. Required if `category`
215
+ # is equal to `tax`.
204
216
  #
205
- # @param unstructured [Increase::Models::WireTransferCreateParams::Remittance::Unstructured] Unstructured remittance information. Required if `category` is equal to `unstruc
217
+ # @param unstructured [Increase::Models::WireTransferCreateParams::Remittance::Unstructured]
218
+ # Unstructured remittance information. Required if `category` is equal to
219
+ # `unstructured`.
206
220
 
207
221
  # The type of remittance information being passed.
208
222
  #
@@ -243,15 +257,16 @@ module Increase
243
257
  required :type_code, String
244
258
 
245
259
  # @!method initialize(date:, identification_number:, type_code:)
246
- # Some parameter documentations has been truncated, see
247
- # {Increase::Models::WireTransferCreateParams::Remittance::Tax} for more details.
248
- #
249
260
  # Internal Revenue Service (IRS) tax repayment information. Required if `category`
250
261
  # is equal to `tax`.
251
262
  #
252
- # @param date [Date] The month and year the tax payment is for, in YYYY-MM-DD format. The day is igno
263
+ # @param date [Date]
264
+ # The month and year the tax payment is for, in YYYY-MM-DD format. The day is
265
+ # ignored.
253
266
  #
254
- # @param identification_number [String] The 9-digit Tax Identification Number (TIN) or Employer Identification Number (E
267
+ # @param identification_number [String]
268
+ # The 9-digit Tax Identification Number (TIN) or Employer Identification Number
269
+ # (EIN).
255
270
  #
256
271
  # @param type_code [String] The 5-character tax type code.
257
272
  end
@@ -292,7 +307,8 @@ module Increase
292
307
  #
293
308
  # @param name [String] The person or business's name.
294
309
  #
295
- # @param address [Increase::Models::WireTransferCreateParams::Debtor::Address] The person or business's address.
310
+ # @param address [Increase::Models::WireTransferCreateParams::Debtor::Address]
311
+ # The person or business's address.
296
312
 
297
313
  # @see Increase::Models::WireTransferCreateParams::Debtor#address
298
314
  class Address < Increase::Internal::Type::BaseModel
@@ -305,7 +321,8 @@ module Increase
305
321
  # @!method initialize(unstructured:)
306
322
  # The person or business's address.
307
323
  #
308
- # @param unstructured [Increase::Models::WireTransferCreateParams::Debtor::Address::Unstructured] Unstructured address lines.
324
+ # @param unstructured [Increase::Models::WireTransferCreateParams::Debtor::Address::Unstructured]
325
+ # Unstructured address lines.
309
326
 
310
327
  # @see Increase::Models::WireTransferCreateParams::Debtor::Address#unstructured
311
328
  class Unstructured < Increase::Internal::Type::BaseModel
@@ -52,9 +52,6 @@ module Increase
52
52
  optional :status, -> { Increase::WireTransferListParams::Status }
53
53
 
54
54
  # @!method initialize(account_id: nil, created_at: nil, cursor: nil, external_account_id: nil, idempotency_key: nil, limit: nil, status: nil, request_options: {})
55
- # Some parameter documentations has been truncated, see
56
- # {Increase::Models::WireTransferListParams} for more details.
57
- #
58
55
  # @param account_id [String] Filter Wire Transfers to those belonging to the specified Account.
59
56
  #
60
57
  # @param created_at [Increase::Models::WireTransferListParams::CreatedAt]
@@ -63,9 +60,15 @@ module Increase
63
60
  #
64
61
  # @param external_account_id [String] Filter Wire Transfers to those made to the specified External Account.
65
62
  #
66
- # @param idempotency_key [String] Filter records to the one with the specified `idempotency_key` you chose for tha
63
+ # @param idempotency_key [String]
64
+ # Filter records to the one with the specified `idempotency_key` you chose for
65
+ # that object. This value is unique across Increase and is used to ensure that a
66
+ # request is only processed once. Learn more about
67
+ # [idempotency](https://increase.com/documentation/idempotency-keys).
67
68
  #
68
- # @param limit [Integer] Limit the size of the list that is returned. The default (and maximum) is 100 ob
69
+ # @param limit [Integer]
70
+ # Limit the size of the list that is returned. The default (and maximum) is 100
71
+ # objects.
69
72
  #
70
73
  # @param status [Increase::Models::WireTransferListParams::Status]
71
74
  #
@@ -101,16 +104,21 @@ module Increase
101
104
  optional :on_or_before, Time
102
105
 
103
106
  # @!method initialize(after: nil, before: nil, on_or_after: nil, on_or_before: nil)
104
- # Some parameter documentations has been truncated, see
105
- # {Increase::Models::WireTransferListParams::CreatedAt} for more details.
106
- #
107
- # @param after [Time] Return results after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) tim
107
+ # @param after [Time]
108
+ # Return results after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)
109
+ # timestamp.
108
110
  #
109
- # @param before [Time] Return results before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) ti
111
+ # @param before [Time]
112
+ # Return results before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)
113
+ # timestamp.
110
114
  #
111
- # @param on_or_after [Time] Return results on or after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_860
115
+ # @param on_or_after [Time]
116
+ # Return results on or after this
117
+ # [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.
112
118
  #
113
- # @param on_or_before [Time] Return results on or before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_86
119
+ # @param on_or_before [Time]
120
+ # Return results on or before this
121
+ # [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.
114
122
  end
115
123
 
116
124
  class Status < Increase::Internal::Type::BaseModel
@@ -124,10 +132,9 @@ module Increase
124
132
  api_name: :in
125
133
 
126
134
  # @!method initialize(in_: nil)
127
- # Some parameter documentations has been truncated, see
128
- # {Increase::Models::WireTransferListParams::Status} for more details.
129
- #
130
- # @param in_ [Array<Symbol, Increase::Models::WireTransferListParams::Status::In>] Return results whose value is in the provided list. For GET requests, this shoul
135
+ # @param in_ [Array<Symbol, Increase::Models::WireTransferListParams::Status::In>]
136
+ # Return results whose value is in the provided list. For GET requests, this
137
+ # should be encoded as a comma-delimited string, such as `?in=one,two,three`.
131
138
 
132
139
  module In
133
140
  extend Increase::Internal::Type::Enum
@@ -3,9 +3,6 @@
3
3
  module Increase
4
4
  module Resources
5
5
  class AccountNumbers
6
- # Some parameter documentations has been truncated, see
7
- # {Increase::Models::AccountNumberCreateParams} for more details.
8
- #
9
6
  # Create an Account Number
10
7
  #
11
8
  # @overload create(account_id:, name:, inbound_ach: nil, inbound_checks: nil, request_options: {})
@@ -14,9 +11,12 @@ module Increase
14
11
  #
15
12
  # @param name [String] The name you choose for the Account Number.
16
13
  #
17
- # @param inbound_ach [Increase::Models::AccountNumberCreateParams::InboundACH] Options related to how this Account Number should handle inbound ACH transfers.
14
+ # @param inbound_ach [Increase::Models::AccountNumberCreateParams::InboundACH]
15
+ # Options related to how this Account Number should handle inbound ACH transfers.
18
16
  #
19
- # @param inbound_checks [Increase::Models::AccountNumberCreateParams::InboundChecks] Options related to how this Account Number should handle inbound check withdrawa
17
+ # @param inbound_checks [Increase::Models::AccountNumberCreateParams::InboundChecks]
18
+ # Options related to how this Account Number should handle inbound check
19
+ # withdrawals.
20
20
  #
21
21
  # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
22
22
  #
@@ -54,22 +54,23 @@ module Increase
54
54
  )
55
55
  end
56
56
 
57
- # Some parameter documentations has been truncated, see
58
- # {Increase::Models::AccountNumberUpdateParams} for more details.
59
- #
60
57
  # Update an Account Number
61
58
  #
62
59
  # @overload update(account_number_id, inbound_ach: nil, inbound_checks: nil, name: nil, status: nil, request_options: {})
63
60
  #
64
61
  # @param account_number_id [String] The identifier of the Account Number.
65
62
  #
66
- # @param inbound_ach [Increase::Models::AccountNumberUpdateParams::InboundACH] Options related to how this Account Number handles inbound ACH transfers.
63
+ # @param inbound_ach [Increase::Models::AccountNumberUpdateParams::InboundACH]
64
+ # Options related to how this Account Number handles inbound ACH transfers.
67
65
  #
68
- # @param inbound_checks [Increase::Models::AccountNumberUpdateParams::InboundChecks] Options related to how this Account Number should handle inbound check withdrawa
66
+ # @param inbound_checks [Increase::Models::AccountNumberUpdateParams::InboundChecks]
67
+ # Options related to how this Account Number should handle inbound check
68
+ # withdrawals.
69
69
  #
70
70
  # @param name [String] The name you choose for the Account Number.
71
71
  #
72
- # @param status [Symbol, Increase::Models::AccountNumberUpdateParams::Status] This indicates if transfers can be made to the Account Number.
72
+ # @param status [Symbol, Increase::Models::AccountNumberUpdateParams::Status]
73
+ # This indicates if transfers can be made to the Account Number.
73
74
  #
74
75
  # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
75
76
  #
@@ -87,9 +88,6 @@ module Increase
87
88
  )
88
89
  end
89
90
 
90
- # Some parameter documentations has been truncated, see
91
- # {Increase::Models::AccountNumberListParams} for more details.
92
- #
93
91
  # List Account Numbers
94
92
  #
95
93
  # @overload list(account_id: nil, ach_debit_status: nil, created_at: nil, cursor: nil, idempotency_key: nil, limit: nil, status: nil, request_options: {})
@@ -102,9 +100,15 @@ module Increase
102
100
  #
103
101
  # @param cursor [String] Return the page of entries after this one.
104
102
  #
105
- # @param idempotency_key [String] Filter records to the one with the specified `idempotency_key` you chose for tha
103
+ # @param idempotency_key [String]
104
+ # Filter records to the one with the specified `idempotency_key` you chose for
105
+ # that object. This value is unique across Increase and is used to ensure that a
106
+ # request is only processed once. Learn more about
107
+ # [idempotency](https://increase.com/documentation/idempotency-keys).
106
108
  #
107
- # @param limit [Integer] Limit the size of the list that is returned. The default (and maximum) is 100 ob
109
+ # @param limit [Integer]
110
+ # Limit the size of the list that is returned. The default (and maximum) is 100
111
+ # objects.
108
112
  #
109
113
  # @param status [Increase::Models::AccountNumberListParams::Status]
110
114
  #
@@ -23,9 +23,6 @@ module Increase
23
23
  )
24
24
  end
25
25
 
26
- # Some parameter documentations has been truncated, see
27
- # {Increase::Models::AccountStatementListParams} for more details.
28
- #
29
26
  # List Account Statements
30
27
  #
31
28
  # @overload list(account_id: nil, cursor: nil, limit: nil, statement_period_start: nil, request_options: {})
@@ -34,7 +31,9 @@ module Increase
34
31
  #
35
32
  # @param cursor [String] Return the page of entries after this one.
36
33
  #
37
- # @param limit [Integer] Limit the size of the list that is returned. The default (and maximum) is 100 ob
34
+ # @param limit [Integer]
35
+ # Limit the size of the list that is returned. The default (and maximum) is 100
36
+ # objects.
38
37
  #
39
38
  # @param statement_period_start [Increase::Models::AccountStatementListParams::StatementPeriodStart]
40
39
  #