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
@@ -4,10 +4,6 @@ module Increase
4
4
  module Resources
5
5
  class Simulations
6
6
  class InboundWireTransfers
7
- # Some parameter documentations has been truncated, see
8
- # {Increase::Models::Simulations::InboundWireTransferCreateParams} for more
9
- # details.
10
- #
11
7
  # Simulates an [Inbound Wire Transfer](#inbound-wire-transfers) to your account.
12
8
  #
13
9
  # @overload create(account_number_id:, amount:, creditor_address_line1: nil, creditor_address_line2: nil, creditor_address_line3: nil, creditor_name: nil, debtor_address_line1: nil, debtor_address_line2: nil, debtor_address_line3: nil, debtor_name: nil, end_to_end_identification: nil, instructing_agent_routing_number: nil, instruction_identification: nil, purpose: nil, unique_end_to_end_transaction_reference: nil, unstructured_remittance_information: nil, wire_drawdown_request_id: nil, request_options: {})
@@ -16,35 +12,65 @@ module Increase
16
12
  #
17
13
  # @param amount [Integer] The transfer amount in cents. Must be positive.
18
14
  #
19
- # @param creditor_address_line1 [String] The sending bank will set creditor_address_line1 in production. You can simulate
15
+ # @param creditor_address_line1 [String]
16
+ # The sending bank will set creditor_address_line1 in production. You can simulate
17
+ # any value here.
20
18
  #
21
- # @param creditor_address_line2 [String] The sending bank will set creditor_address_line2 in production. You can simulate
19
+ # @param creditor_address_line2 [String]
20
+ # The sending bank will set creditor_address_line2 in production. You can simulate
21
+ # any value here.
22
22
  #
23
- # @param creditor_address_line3 [String] The sending bank will set creditor_address_line3 in production. You can simulate
23
+ # @param creditor_address_line3 [String]
24
+ # The sending bank will set creditor_address_line3 in production. You can simulate
25
+ # any value here.
24
26
  #
25
- # @param creditor_name [String] The sending bank will set creditor_name in production. You can simulate any valu
27
+ # @param creditor_name [String]
28
+ # The sending bank will set creditor_name in production. You can simulate any
29
+ # value here.
26
30
  #
27
- # @param debtor_address_line1 [String] The sending bank will set debtor_address_line1 in production. You can simulate a
31
+ # @param debtor_address_line1 [String]
32
+ # The sending bank will set debtor_address_line1 in production. You can simulate
33
+ # any value here.
28
34
  #
29
- # @param debtor_address_line2 [String] The sending bank will set debtor_address_line2 in production. You can simulate a
35
+ # @param debtor_address_line2 [String]
36
+ # The sending bank will set debtor_address_line2 in production. You can simulate
37
+ # any value here.
30
38
  #
31
- # @param debtor_address_line3 [String] The sending bank will set debtor_address_line3 in production. You can simulate a
39
+ # @param debtor_address_line3 [String]
40
+ # The sending bank will set debtor_address_line3 in production. You can simulate
41
+ # any value here.
32
42
  #
33
- # @param debtor_name [String] The sending bank will set debtor_name in production. You can simulate any value
43
+ # @param debtor_name [String]
44
+ # The sending bank will set debtor_name in production. You can simulate any value
45
+ # here.
34
46
  #
35
- # @param end_to_end_identification [String] The sending bank will set end_to_end_identification in production. You can simul
47
+ # @param end_to_end_identification [String]
48
+ # The sending bank will set end_to_end_identification in production. You can
49
+ # simulate any value here.
36
50
  #
37
- # @param instructing_agent_routing_number [String] The sending bank will set instructing_agent_routing_number in production. You ca
51
+ # @param instructing_agent_routing_number [String]
52
+ # The sending bank will set instructing_agent_routing_number in production. You
53
+ # can simulate any value here.
38
54
  #
39
- # @param instruction_identification [String] The sending bank will set instruction_identification in production. You can simu
55
+ # @param instruction_identification [String]
56
+ # The sending bank will set instruction_identification in production. You can
57
+ # simulate any value here.
40
58
  #
41
- # @param purpose [String] The sending bank will set purpose in production. You can simulate any value here
59
+ # @param purpose [String]
60
+ # The sending bank will set purpose in production. You can simulate any value
61
+ # here.
42
62
  #
43
- # @param unique_end_to_end_transaction_reference [String] The sending bank will set unique_end_to_end_transaction_reference in production.
63
+ # @param unique_end_to_end_transaction_reference [String]
64
+ # The sending bank will set unique_end_to_end_transaction_reference in production.
65
+ # You can simulate any value here.
44
66
  #
45
- # @param unstructured_remittance_information [String] The sending bank will set unstructured_remittance_information in production. You
67
+ # @param unstructured_remittance_information [String]
68
+ # The sending bank will set unstructured_remittance_information in production. You
69
+ # can simulate any value here.
46
70
  #
47
- # @param wire_drawdown_request_id [String] The identifier of a Wire Drawdown Request the inbound Wire Transfer is fulfillin
71
+ # @param wire_drawdown_request_id [String]
72
+ # The identifier of a Wire Drawdown Request the inbound Wire Transfer is
73
+ # fulfilling.
48
74
  #
49
75
  # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
50
76
  #
@@ -4,9 +4,6 @@ module Increase
4
4
  module Resources
5
5
  class Simulations
6
6
  class InterestPayments
7
- # Some parameter documentations has been truncated, see
8
- # {Increase::Models::Simulations::InterestPaymentCreateParams} for more details.
9
- #
10
7
  # Simulates an interest payment to your account. In production, this happens
11
8
  # automatically on the first of each month.
12
9
  #
@@ -16,11 +13,13 @@ module Increase
16
13
  #
17
14
  # @param amount [Integer] The interest amount in cents. Must be positive.
18
15
  #
19
- # @param accrued_on_account_id [String] The identifier of the Account the Interest accrued on. Defaults to `account_id`.
16
+ # @param accrued_on_account_id [String]
17
+ # The identifier of the Account the Interest accrued on. Defaults to `account_id`.
20
18
  #
21
19
  # @param period_end [Time] The end of the interest period. If not provided, defaults to the current time.
22
20
  #
23
- # @param period_start [Time] The start of the interest period. If not provided, defaults to the current time.
21
+ # @param period_start [Time]
22
+ # The start of the interest period. If not provided, defaults to the current time.
24
23
  #
25
24
  # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
26
25
  #
@@ -4,16 +4,14 @@ module Increase
4
4
  module Resources
5
5
  class Simulations
6
6
  class PendingTransactions
7
- # Some parameter documentations has been truncated, see
8
- # {Increase::Models::Simulations::PendingTransactionReleaseInboundFundsHoldParams}
9
- # for more details.
10
- #
11
7
  # This endpoint simulates immediately releasing an Inbound Funds Hold, which might
12
8
  # be created as a result of, for example, an ACH debit.
13
9
  #
14
10
  # @overload release_inbound_funds_hold(pending_transaction_id, request_options: {})
15
11
  #
16
- # @param pending_transaction_id [String] The pending transaction to release. The pending transaction must have a `inbound
12
+ # @param pending_transaction_id [String]
13
+ # The pending transaction to release. The pending transaction must have a
14
+ # `inbound_funds_hold` source.
17
15
  #
18
16
  # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
19
17
  #
@@ -4,9 +4,6 @@ module Increase
4
4
  module Resources
5
5
  class Simulations
6
6
  class PhysicalCards
7
- # Some parameter documentations has been truncated, see
8
- # {Increase::Models::Simulations::PhysicalCardCreateParams} for more details.
9
- #
10
7
  # This endpoint allows you to simulate receiving a tracking update for a Physical
11
8
  # Card, to simulate the progress of a shipment.
12
9
  #
@@ -14,9 +11,12 @@ module Increase
14
11
  #
15
12
  # @param physical_card_id [String] The Physical Card you would like to action.
16
13
  #
17
- # @param category [Symbol, Increase::Models::Simulations::PhysicalCardCreateParams::Category] The type of tracking event.
14
+ # @param category [Symbol, Increase::Models::Simulations::PhysicalCardCreateParams::Category]
15
+ # The type of tracking event.
18
16
  #
19
- # @param carrier_estimated_delivery_at [Time] The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time when the ca
17
+ # @param carrier_estimated_delivery_at [Time]
18
+ # The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time when the
19
+ # carrier expects the card to be delivered.
20
20
  #
21
21
  # @param city [String] The city where the event took place.
22
22
  #
@@ -48,7 +48,8 @@ module Increase
48
48
  #
49
49
  # @param physical_card_id [String] The Physical Card you would like to action.
50
50
  #
51
- # @param shipment_status [Symbol, Increase::Models::Simulations::PhysicalCardAdvanceShipmentParams::ShipmentStatus] The shipment status to move the Physical Card to.
51
+ # @param shipment_status [Symbol, Increase::Models::Simulations::PhysicalCardAdvanceShipmentParams::ShipmentStatus]
52
+ # The shipment status to move the Physical Card to.
52
53
  #
53
54
  # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
54
55
  #
@@ -13,9 +13,11 @@ module Increase
13
13
  #
14
14
  # @param name [String] The name of the program being added.
15
15
  #
16
- # @param bank [Symbol, Increase::Models::Simulations::ProgramCreateParams::Bank] The bank for the program's accounts, defaults to First Internet Bank.
16
+ # @param bank [Symbol, Increase::Models::Simulations::ProgramCreateParams::Bank]
17
+ # The bank for the program's accounts, defaults to First Internet Bank.
17
18
  #
18
- # @param lending_maximum_extendable_credit [Integer] The maximum extendable credit of the program being added.
19
+ # @param lending_maximum_extendable_credit [Integer]
20
+ # The maximum extendable credit of the program being added.
19
21
  #
20
22
  # @param reserve_account_id [String] The identifier of the Account the Program should be added to is for.
21
23
  #
@@ -11,9 +11,11 @@ module Increase
11
11
  #
12
12
  # @overload complete(real_time_payments_transfer_id, rejection: nil, request_options: {})
13
13
  #
14
- # @param real_time_payments_transfer_id [String] The identifier of the Real-Time Payments Transfer you wish to complete.
14
+ # @param real_time_payments_transfer_id [String]
15
+ # The identifier of the Real-Time Payments Transfer you wish to complete.
15
16
  #
16
- # @param rejection [Increase::Models::Simulations::RealTimePaymentsTransferCompleteParams::Rejection] If set, the simulation will reject the transfer.
17
+ # @param rejection [Increase::Models::Simulations::RealTimePaymentsTransferCompleteParams::Rejection]
18
+ # If set, the simulation will reject the transfer.
17
19
  #
18
20
  # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
19
21
  #
@@ -27,9 +27,6 @@ module Increase
27
27
  )
28
28
  end
29
29
 
30
- # Some parameter documentations has been truncated, see
31
- # {Increase::Models::SupplementalDocumentListParams} for more details.
32
- #
33
30
  # List Entity Supplemental Document Submissions
34
31
  #
35
32
  # @overload list(entity_id:, cursor: nil, idempotency_key: nil, limit: nil, request_options: {})
@@ -38,9 +35,15 @@ module Increase
38
35
  #
39
36
  # @param cursor [String] Return the page of entries after this one.
40
37
  #
41
- # @param idempotency_key [String] Filter records to the one with the specified `idempotency_key` you chose for tha
38
+ # @param idempotency_key [String]
39
+ # Filter records to the one with the specified `idempotency_key` you chose for
40
+ # that object. This value is unique across Increase and is used to ensure that a
41
+ # request is only processed once. Learn more about
42
+ # [idempotency](https://increase.com/documentation/idempotency-keys).
42
43
  #
43
- # @param limit [Integer] Limit the size of the list that is returned. The default (and maximum) is 100 ob
44
+ # @param limit [Integer]
45
+ # Limit the size of the list that is returned. The default (and maximum) is 100
46
+ # objects.
44
47
  #
45
48
  # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
46
49
  #
@@ -3,20 +3,21 @@
3
3
  module Increase
4
4
  module Resources
5
5
  class SwiftTransfers
6
- # Some parameter documentations has been truncated, see
7
- # {Increase::Models::SwiftTransferCreateParams} for more details.
8
- #
9
6
  # Create a Swift Transfer
10
7
  #
11
- # @overload create(account_id:, account_number:, bank_identification_code:, creditor_address:, creditor_name:, debtor_address:, debtor_name:, instructed_amount:, instructed_currency:, source_account_number_id:, unstructured_remittance_information:, require_approval: nil, routing_number: nil, request_options: {})
8
+ # @overload create(account_id:, account_number:, bank_identification_code:, creditor_address:, creditor_name:, debtor_address:, debtor_name:, instructed_amount:, instructed_currency:, source_account_number_id:, unstructured_remittance_information:, intermediary_bank_identification_code: nil, require_approval: nil, routing_number: nil, request_options: {})
12
9
  #
13
10
  # @param account_id [String] The identifier for the account that will send the transfer.
14
11
  #
15
12
  # @param account_number [String] The creditor's account number.
16
13
  #
17
- # @param bank_identification_code [String] The bank identification code (BIC) of the creditor. If it ends with the three-ch
14
+ # @param bank_identification_code [String]
15
+ # The bank identification code (BIC) of the creditor. If it ends with the
16
+ # three-character branch code, this must be 11 characters long. Otherwise this
17
+ # must be 8 characters and the branch code will be assumed to be `XXX`.
18
18
  #
19
- # @param creditor_address [Increase::Models::SwiftTransferCreateParams::CreditorAddress] The creditor's address.
19
+ # @param creditor_address [Increase::Models::SwiftTransferCreateParams::CreditorAddress]
20
+ # The creditor's address.
20
21
  #
21
22
  # @param creditor_name [String] The creditor's name.
22
23
  #
@@ -24,17 +25,29 @@ module Increase
24
25
  #
25
26
  # @param debtor_name [String] The debtor's name.
26
27
  #
27
- # @param instructed_amount [Integer] The amount, in minor units of `instructed_currency`, to send to the creditor.
28
+ # @param instructed_amount [Integer]
29
+ # The amount, in minor units of `instructed_currency`, to send to the creditor.
30
+ #
31
+ # @param instructed_currency [Symbol, Increase::Models::SwiftTransferCreateParams::InstructedCurrency]
32
+ # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code of the
33
+ # instructed amount.
28
34
  #
29
- # @param instructed_currency [Symbol, Increase::Models::SwiftTransferCreateParams::InstructedCurrency] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code of the inst
35
+ # @param source_account_number_id [String]
36
+ # The Account Number to include in the transfer as the debtor's account number.
30
37
  #
31
- # @param source_account_number_id [String] The Account Number to include in the transfer as the debtor's account number.
38
+ # @param unstructured_remittance_information [String]
39
+ # Unstructured remittance information to include in the transfer.
32
40
  #
33
- # @param unstructured_remittance_information [String] Unstructured remittance information to include in the transfer.
41
+ # @param intermediary_bank_identification_code [String]
42
+ # The bank identification code (BIC) of the intermediary bank, if the transfer
43
+ # should be routed through one.
34
44
  #
35
- # @param require_approval [Boolean] Whether the transfer requires explicit approval via the dashboard or API.
45
+ # @param require_approval [Boolean]
46
+ # Whether the transfer requires explicit approval via the dashboard or API.
36
47
  #
37
- # @param routing_number [String] The creditor's bank account routing or transit number. Required in certain count
48
+ # @param routing_number [String]
49
+ # The creditor's bank account routing or transit number. Required in certain
50
+ # countries.
38
51
  #
39
52
  # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
40
53
  #
@@ -72,9 +85,6 @@ module Increase
72
85
  )
73
86
  end
74
87
 
75
- # Some parameter documentations has been truncated, see
76
- # {Increase::Models::SwiftTransferListParams} for more details.
77
- #
78
88
  # List Swift Transfers
79
89
  #
80
90
  # @overload list(account_id: nil, created_at: nil, cursor: nil, idempotency_key: nil, limit: nil, status: nil, request_options: {})
@@ -85,9 +95,15 @@ module Increase
85
95
  #
86
96
  # @param cursor [String] Return the page of entries after this one.
87
97
  #
88
- # @param idempotency_key [String] Filter records to the one with the specified `idempotency_key` you chose for tha
98
+ # @param idempotency_key [String]
99
+ # Filter records to the one with the specified `idempotency_key` you chose for
100
+ # that object. This value is unique across Increase and is used to ensure that a
101
+ # request is only processed once. Learn more about
102
+ # [idempotency](https://increase.com/documentation/idempotency-keys).
89
103
  #
90
- # @param limit [Integer] Limit the size of the list that is returned. The default (and maximum) is 100 ob
104
+ # @param limit [Integer]
105
+ # Limit the size of the list that is returned. The default (and maximum) is 100
106
+ # objects.
91
107
  #
92
108
  # @param status [Increase::Models::SwiftTransferListParams::Status]
93
109
  #
@@ -23,9 +23,6 @@ module Increase
23
23
  )
24
24
  end
25
25
 
26
- # Some parameter documentations has been truncated, see
27
- # {Increase::Models::TransactionListParams} for more details.
28
- #
29
26
  # List Transactions
30
27
  #
31
28
  # @overload list(account_id: nil, category: nil, created_at: nil, cursor: nil, limit: nil, route_id: nil, request_options: {})
@@ -38,9 +35,13 @@ module Increase
38
35
  #
39
36
  # @param cursor [String] Return the page of entries after this one.
40
37
  #
41
- # @param limit [Integer] Limit the size of the list that is returned. The default (and maximum) is 100 ob
38
+ # @param limit [Integer]
39
+ # Limit the size of the list that is returned. The default (and maximum) is 100
40
+ # objects.
42
41
  #
43
- # @param route_id [String] Filter Transactions for those belonging to the specified route. This could be a
42
+ # @param route_id [String]
43
+ # Filter Transactions for those belonging to the specified route. This could be a
44
+ # Card ID or an Account Number ID.
44
45
  #
45
46
  # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
46
47
  #
@@ -3,9 +3,6 @@
3
3
  module Increase
4
4
  module Resources
5
5
  class WireDrawdownRequests
6
- # Some parameter documentations has been truncated, see
7
- # {Increase::Models::WireDrawdownRequestCreateParams} for more details.
8
- #
9
6
  # Create a Wire Drawdown Request
10
7
  #
11
8
  # @overload create(account_number_id:, amount:, creditor_address:, creditor_name:, debtor_address:, debtor_name:, unstructured_remittance_information:, charge_bearer: nil, debtor_account_number: nil, debtor_external_account_id: nil, debtor_routing_number: nil, end_to_end_identification: nil, request_options: {})
@@ -14,25 +11,34 @@ module Increase
14
11
  #
15
12
  # @param amount [Integer] The amount requested from the debtor, in USD cents.
16
13
  #
17
- # @param creditor_address [Increase::Models::WireDrawdownRequestCreateParams::CreditorAddress] The creditor's address.
14
+ # @param creditor_address [Increase::Models::WireDrawdownRequestCreateParams::CreditorAddress]
15
+ # The creditor's address.
18
16
  #
19
17
  # @param creditor_name [String] The creditor's name.
20
18
  #
21
- # @param debtor_address [Increase::Models::WireDrawdownRequestCreateParams::DebtorAddress] The debtor's address.
19
+ # @param debtor_address [Increase::Models::WireDrawdownRequestCreateParams::DebtorAddress]
20
+ # The debtor's address.
22
21
  #
23
22
  # @param debtor_name [String] The debtor's name.
24
23
  #
25
- # @param unstructured_remittance_information [String] Remittance information the debtor will see as part of the request.
24
+ # @param unstructured_remittance_information [String]
25
+ # Remittance information the debtor will see as part of the request.
26
26
  #
27
- # @param charge_bearer [Symbol, Increase::Models::WireDrawdownRequestCreateParams::ChargeBearer] Determines who bears the cost of the drawdown request. Defaults to `shared` if n
27
+ # @param charge_bearer [Symbol, Increase::Models::WireDrawdownRequestCreateParams::ChargeBearer]
28
+ # Determines who bears the cost of the drawdown request. Defaults to `shared` if
29
+ # not specified.
28
30
  #
29
31
  # @param debtor_account_number [String] The debtor's account number.
30
32
  #
31
- # @param debtor_external_account_id [String] The ID of an External Account to initiate a transfer to. If this parameter is pr
33
+ # @param debtor_external_account_id [String]
34
+ # The ID of an External Account to initiate a transfer to. If this parameter is
35
+ # provided, `debtor_account_number` and `debtor_routing_number` must be absent.
32
36
  #
33
37
  # @param debtor_routing_number [String] The debtor's routing number.
34
38
  #
35
- # @param end_to_end_identification [String] A free-form reference string set by the sender mirrored back in the subsequent w
39
+ # @param end_to_end_identification [String]
40
+ # A free-form reference string set by the sender mirrored back in the subsequent
41
+ # wire transfer.
36
42
  #
37
43
  # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
38
44
  #
@@ -70,18 +76,21 @@ module Increase
70
76
  )
71
77
  end
72
78
 
73
- # Some parameter documentations has been truncated, see
74
- # {Increase::Models::WireDrawdownRequestListParams} for more details.
75
- #
76
79
  # List Wire Drawdown Requests
77
80
  #
78
81
  # @overload list(cursor: nil, idempotency_key: nil, limit: nil, status: nil, request_options: {})
79
82
  #
80
83
  # @param cursor [String] Return the page of entries after this one.
81
84
  #
82
- # @param idempotency_key [String] Filter records to the one with the specified `idempotency_key` you chose for tha
85
+ # @param idempotency_key [String]
86
+ # Filter records to the one with the specified `idempotency_key` you chose for
87
+ # that object. This value is unique across Increase and is used to ensure that a
88
+ # request is only processed once. Learn more about
89
+ # [idempotency](https://increase.com/documentation/idempotency-keys).
83
90
  #
84
- # @param limit [Integer] Limit the size of the list that is returned. The default (and maximum) is 100 ob
91
+ # @param limit [Integer]
92
+ # Limit the size of the list that is returned. The default (and maximum) is 100
93
+ # objects.
85
94
  #
86
95
  # @param status [Increase::Models::WireDrawdownRequestListParams::Status]
87
96
  #
@@ -3,9 +3,6 @@
3
3
  module Increase
4
4
  module Resources
5
5
  class WireTransfers
6
- # Some parameter documentations has been truncated, see
7
- # {Increase::Models::WireTransferCreateParams} for more details.
8
- #
9
6
  # Create a Wire Transfer
10
7
  #
11
8
  # @overload create(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: {})
@@ -14,23 +11,36 @@ module Increase
14
11
  #
15
12
  # @param amount [Integer] The transfer amount in USD cents.
16
13
  #
17
- # @param creditor [Increase::Models::WireTransferCreateParams::Creditor] The person or business that is receiving the funds from the transfer.
14
+ # @param creditor [Increase::Models::WireTransferCreateParams::Creditor]
15
+ # The person or business that is receiving the funds from the transfer.
18
16
  #
19
- # @param remittance [Increase::Models::WireTransferCreateParams::Remittance] Additional remittance information related to the wire transfer.
17
+ # @param remittance [Increase::Models::WireTransferCreateParams::Remittance]
18
+ # Additional remittance information related to the wire transfer.
20
19
  #
21
20
  # @param account_number [String] The account number for the destination account.
22
21
  #
23
- # @param debtor [Increase::Models::WireTransferCreateParams::Debtor] The person or business whose funds are being transferred. This is only necessary
22
+ # @param debtor [Increase::Models::WireTransferCreateParams::Debtor]
23
+ # The person or business whose funds are being transferred. This is only necessary
24
+ # if you're transferring from a commingled account. Otherwise, we'll use the
25
+ # associated entity's details.
24
26
  #
25
- # @param external_account_id [String] The ID of an External Account to initiate a transfer to. If this parameter is pr
27
+ # @param external_account_id [String]
28
+ # The ID of an External Account to initiate a transfer to. If this parameter is
29
+ # provided, `account_number` and `routing_number` must be absent.
26
30
  #
27
- # @param inbound_wire_drawdown_request_id [String] The ID of an Inbound Wire Drawdown Request in response to which this transfer is
31
+ # @param inbound_wire_drawdown_request_id [String]
32
+ # The ID of an Inbound Wire Drawdown Request in response to which this transfer is
33
+ # being sent.
28
34
  #
29
- # @param require_approval [Boolean] Whether the transfer requires explicit approval via the dashboard or API.
35
+ # @param require_approval [Boolean]
36
+ # Whether the transfer requires explicit approval via the dashboard or API.
30
37
  #
31
- # @param routing_number [String] The American Bankers' Association (ABA) Routing Transit Number (RTN) for the des
38
+ # @param routing_number [String]
39
+ # The American Bankers' Association (ABA) Routing Transit Number (RTN) for the
40
+ # destination account.
32
41
  #
33
- # @param source_account_number_id [String] The ID of an Account Number that will be passed to the wire's recipient
42
+ # @param source_account_number_id [String]
43
+ # The ID of an Account Number that will be passed to the wire's recipient
34
44
  #
35
45
  # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
36
46
  #
@@ -68,9 +78,6 @@ module Increase
68
78
  )
69
79
  end
70
80
 
71
- # Some parameter documentations has been truncated, see
72
- # {Increase::Models::WireTransferListParams} for more details.
73
- #
74
81
  # List Wire Transfers
75
82
  #
76
83
  # @overload list(account_id: nil, created_at: nil, cursor: nil, external_account_id: nil, idempotency_key: nil, limit: nil, status: nil, request_options: {})
@@ -83,9 +90,15 @@ module Increase
83
90
  #
84
91
  # @param external_account_id [String] Filter Wire Transfers to those made to the specified External Account.
85
92
  #
86
- # @param idempotency_key [String] Filter records to the one with the specified `idempotency_key` you chose for tha
93
+ # @param idempotency_key [String]
94
+ # Filter records to the one with the specified `idempotency_key` you chose for
95
+ # that object. This value is unique across Increase and is used to ensure that a
96
+ # request is only processed once. Learn more about
97
+ # [idempotency](https://increase.com/documentation/idempotency-keys).
87
98
  #
88
- # @param limit [Integer] Limit the size of the list that is returned. The default (and maximum) is 100 ob
99
+ # @param limit [Integer]
100
+ # Limit the size of the list that is returned. The default (and maximum) is 100
101
+ # objects.
89
102
  #
90
103
  # @param status [Increase::Models::WireTransferListParams::Status]
91
104
  #
@@ -1,5 +1,5 @@
1
1
  # frozen_string_literal: true
2
2
 
3
3
  module Increase
4
- VERSION = "1.340.0"
4
+ VERSION = "1.342.0"
5
5
  end
@@ -770,7 +770,7 @@ module Increase
770
770
  Increase::ACHPrenotification::PrenotificationReturn::ReturnReasonCode::TaggedSymbol
771
771
  )
772
772
 
773
- # Code R17. The receiving bank is unable to process a field in the transfer.
773
+ # Code R17. This return code has multiple meanings. The receiving bank was either unable to process a field in the transfer, or believes the transfer was initiated under questionable circumstances (such as fraud), or identified an improperly-initiated reversing entry.
774
774
  FILE_RECORD_EDIT_CRITERIA =
775
775
  T.let(
776
776
  :file_record_edit_criteria,
@@ -1814,6 +1814,15 @@ module Increase
1814
1814
  T.any(Increase::ACHTransfer::Return, Increase::Internal::AnyHash)
1815
1815
  end
1816
1816
 
1817
+ # Additional free-form information included by the receiving bank in the return's
1818
+ # addenda record. This is raw, uninterpreted text whose presence and format are
1819
+ # not guaranteed. For a `file_record_edit_criteria` (R17) return the receiving
1820
+ # bank may set this to `QUESTIONABLE` (optionally followed by more text) to
1821
+ # indicate it believes the transfer was initiated under questionable
1822
+ # circumstances.
1823
+ sig { returns(T.nilable(String)) }
1824
+ attr_accessor :addenda_information
1825
+
1817
1826
  # The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
1818
1827
  # the transfer was created.
1819
1828
  sig { returns(Time) }
@@ -1849,6 +1858,7 @@ module Increase
1849
1858
  # If your transfer is returned, this will contain details of the return.
1850
1859
  sig do
1851
1860
  params(
1861
+ addenda_information: T.nilable(String),
1852
1862
  created_at: Time,
1853
1863
  raw_return_reason_code: String,
1854
1864
  return_reason_code:
@@ -1859,6 +1869,13 @@ module Increase
1859
1869
  ).returns(T.attached_class)
1860
1870
  end
1861
1871
  def self.new(
1872
+ # Additional free-form information included by the receiving bank in the return's
1873
+ # addenda record. This is raw, uninterpreted text whose presence and format are
1874
+ # not guaranteed. For a `file_record_edit_criteria` (R17) return the receiving
1875
+ # bank may set this to `QUESTIONABLE` (optionally followed by more text) to
1876
+ # indicate it believes the transfer was initiated under questionable
1877
+ # circumstances.
1878
+ addenda_information:,
1862
1879
  # The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
1863
1880
  # the transfer was created.
1864
1881
  created_at:,
@@ -1883,6 +1900,7 @@ module Increase
1883
1900
  sig do
1884
1901
  override.returns(
1885
1902
  {
1903
+ addenda_information: T.nilable(String),
1886
1904
  created_at: Time,
1887
1905
  raw_return_reason_code: String,
1888
1906
  return_reason_code:
@@ -2019,7 +2037,7 @@ module Increase
2019
2037
  Increase::ACHTransfer::Return::ReturnReasonCode::TaggedSymbol
2020
2038
  )
2021
2039
 
2022
- # Code R17. The receiving bank is unable to process a field in the transfer.
2040
+ # Code R17. This return code has multiple meanings. The receiving bank was either unable to process a field in the transfer, or believes the transfer was initiated under questionable circumstances (such as fraud), or identified an improperly-initiated reversing entry.
2023
2041
  FILE_RECORD_EDIT_CRITERIA =
2024
2042
  T.let(
2025
2043
  :file_record_edit_criteria,
@@ -205,14 +205,18 @@ module Increase
205
205
  sig { returns(String) }
206
206
  attr_accessor :city
207
207
 
208
- # The two-letter ISO 3166-1 alpha-2 code for the country of the address.
209
- sig { returns(String) }
210
- attr_accessor :country
211
-
212
208
  # The first line of the address. This is usually the street number and street.
213
209
  sig { returns(String) }
214
210
  attr_accessor :line1
215
211
 
212
+ # The two-letter ISO 3166-1 alpha-2 code for the country of the address. Defaults
213
+ # to `US`.
214
+ sig { returns(T.nilable(String)) }
215
+ attr_reader :country
216
+
217
+ sig { params(country: String).void }
218
+ attr_writer :country
219
+
216
220
  # The second line of the address. This might be the floor or room number.
217
221
  sig { returns(T.nilable(String)) }
218
222
  attr_reader :line2
@@ -240,8 +244,8 @@ module Increase
240
244
  sig do
241
245
  params(
242
246
  city: String,
243
- country: String,
244
247
  line1: String,
248
+ country: String,
245
249
  line2: String,
246
250
  state: String,
247
251
  zip: String
@@ -250,10 +254,11 @@ module Increase
250
254
  def self.new(
251
255
  # The city, district, town, or village of the address.
252
256
  city:,
253
- # The two-letter ISO 3166-1 alpha-2 code for the country of the address.
254
- country:,
255
257
  # The first line of the address. This is usually the street number and street.
256
258
  line1:,
259
+ # The two-letter ISO 3166-1 alpha-2 code for the country of the address. Defaults
260
+ # to `US`.
261
+ country: nil,
257
262
  # The second line of the address. This might be the floor or room number.
258
263
  line2: nil,
259
264
  # The two-letter United States Postal Service (USPS) abbreviation for the US
@@ -268,8 +273,8 @@ module Increase
268
273
  override.returns(
269
274
  {
270
275
  city: String,
271
- country: String,
272
276
  line1: String,
277
+ country: String,
273
278
  line2: String,
274
279
  state: String,
275
280
  zip: String