increase 1.340.0 → 1.341.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 (306) 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 +48 -27
  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 +199 -103
  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 +48 -37
  25. data/lib/increase/models/beneficial_owner_list_params.rb +11 -6
  26. data/lib/increase/models/beneficial_owner_update_params.rb +44 -31
  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 +124 -75
  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 +323 -236
  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 +112 -86
  76. data/lib/increase/models/event.rb +6 -5
  77. data/lib/increase/models/event_list_params.rb +23 -17
  78. data/lib/increase/models/event_subscription.rb +17 -9
  79. data/lib/increase/models/event_subscription_create_params.rb +14 -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 +33 -21
  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 +3 -4
  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 +6 -5
  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 -2
  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 +48 -26
  202. data/lib/increase/models/swift_transfer_create_params.rb +28 -19
  203. data/lib/increase/models/swift_transfer_list_params.rb +23 -16
  204. data/lib/increase/models/transaction.rb +995 -534
  205. data/lib/increase/models/transaction_list_params.rb +21 -16
  206. data/lib/increase/models/unwrap_webhook_event.rb +6 -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 +12 -14
  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 +6 -5
  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 +28 -16
  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/check_transfer.rbi +8 -0
  297. data/rbi/increase/models/check_transfer_create_params.rbi +35 -36
  298. data/rbi/increase/models/entity_list_params.rbi +119 -0
  299. data/rbi/increase/models/pending_transaction_create_params.rbi +4 -4
  300. data/rbi/increase/resources/entities.rbi +3 -0
  301. data/rbi/increase/resources/pending_transactions.rbi +2 -2
  302. data/sig/increase/models/check_transfer.rbs +5 -0
  303. data/sig/increase/models/check_transfer_create_params.rbs +12 -9
  304. data/sig/increase/models/entity_list_params.rbs +48 -1
  305. data/sig/increase/resources/entities.rbs +1 -0
  306. metadata +2 -2
@@ -251,9 +251,6 @@ module Increase
251
251
  required :type, enum: -> { Increase::ACHTransfer::Type }
252
252
 
253
253
  # @!method initialize(id:, account_id:, account_number:, acknowledgement:, addenda:, amount:, approval:, cancellation:, company_descriptive_date:, company_discretionary_data:, company_entry_description:, company_id:, company_name:, created_at:, created_by:, currency:, destination_account_holder:, external_account_id:, funding:, idempotency_key:, inbound_funds_hold:, individual_id:, individual_name:, network:, notifications_of_change:, pending_transaction_id:, preferred_effective_date:, return_:, routing_number:, settlement:, standard_entry_class_code:, statement_descriptor:, status:, submission:, transaction_id:, type:)
254
- # Some parameter documentations has been truncated, see
255
- # {Increase::Models::ACHTransfer} for more details.
256
- #
257
254
  # ACH transfers move funds between your Increase account and any other account
258
255
  # accessible by the Automated Clearing House (ACH).
259
256
  #
@@ -263,71 +260,124 @@ module Increase
263
260
  #
264
261
  # @param account_number [String] The receiver's account number.
265
262
  #
266
- # @param acknowledgement [Increase::Models::ACHTransfer::Acknowledgement, nil] After the transfer is acknowledged by FedACH, this will contain supplemental det
263
+ # @param acknowledgement [Increase::Models::ACHTransfer::Acknowledgement, nil]
264
+ # After the transfer is acknowledged by FedACH, this will contain supplemental
265
+ # details. The Federal Reserve sends an acknowledgement message for each file that
266
+ # Increase submits.
267
267
  #
268
- # @param addenda [Increase::Models::ACHTransfer::Addenda, nil] Additional information that will be sent to the recipient.
268
+ # @param addenda [Increase::Models::ACHTransfer::Addenda, nil]
269
+ # Additional information that will be sent to the recipient.
269
270
  #
270
- # @param amount [Integer] The transfer amount in USD cents. A positive amount indicates a credit transfer
271
+ # @param amount [Integer]
272
+ # The transfer amount in USD cents. A positive amount indicates a credit transfer
273
+ # pushing funds to the receiving account. A negative amount indicates a debit
274
+ # transfer pulling funds from the receiving account.
271
275
  #
272
- # @param approval [Increase::Models::ACHTransfer::Approval, nil] If your account requires approvals for transfers and the transfer was approved,
276
+ # @param approval [Increase::Models::ACHTransfer::Approval, nil]
277
+ # If your account requires approvals for transfers and the transfer was approved,
278
+ # this will contain details of the approval.
273
279
  #
274
- # @param cancellation [Increase::Models::ACHTransfer::Cancellation, nil] If your account requires approvals for transfers and the transfer was not approv
280
+ # @param cancellation [Increase::Models::ACHTransfer::Cancellation, nil]
281
+ # If your account requires approvals for transfers and the transfer was not
282
+ # approved, this will contain details of the cancellation.
275
283
  #
276
284
  # @param company_descriptive_date [String, nil] The description of the date of the transfer.
277
285
  #
278
286
  # @param company_discretionary_data [String, nil] The data you chose to associate with the transfer.
279
287
  #
280
- # @param company_entry_description [String, nil] The description of the transfer you set to be shown to the recipient.
288
+ # @param company_entry_description [String, nil]
289
+ # The description of the transfer you set to be shown to the recipient.
281
290
  #
282
291
  # @param company_id [String] The company ID associated with the transfer.
283
292
  #
284
293
  # @param company_name [String, nil] The name by which the recipient knows you.
285
294
  #
286
- # @param created_at [Time] The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which th
295
+ # @param created_at [Time]
296
+ # The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
297
+ # the transfer was created.
287
298
  #
288
- # @param created_by [Increase::Models::ACHTransfer::CreatedBy, nil] What object created the transfer, either via the API or the dashboard.
299
+ # @param created_by [Increase::Models::ACHTransfer::CreatedBy, nil]
300
+ # What object created the transfer, either via the API or the dashboard.
289
301
  #
290
- # @param currency [Symbol, Increase::Models::ACHTransfer::Currency] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the transfer's c
302
+ # @param currency [Symbol, Increase::Models::ACHTransfer::Currency]
303
+ # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the transfer's
304
+ # currency. For ACH transfers this is always equal to `usd`.
291
305
  #
292
- # @param destination_account_holder [Symbol, Increase::Models::ACHTransfer::DestinationAccountHolder] The type of entity that owns the receiver's account.
306
+ # @param destination_account_holder [Symbol, Increase::Models::ACHTransfer::DestinationAccountHolder]
307
+ # The type of entity that owns the receiver's account.
293
308
  #
294
- # @param external_account_id [String, nil] The identifier of the External Account the transfer was made to, if any.
309
+ # @param external_account_id [String, nil]
310
+ # The identifier of the External Account the transfer was made to, if any.
295
311
  #
296
312
  # @param funding [Symbol, Increase::Models::ACHTransfer::Funding] The type of the receiver's bank account.
297
313
  #
298
- # @param idempotency_key [String, nil] The idempotency key you chose for this object. This value is unique across Incre
314
+ # @param idempotency_key [String, nil]
315
+ # The idempotency key you chose for this object. This value is unique across
316
+ # Increase and is used to ensure that a request is only processed once. Learn more
317
+ # about [idempotency](https://increase.com/documentation/idempotency-keys).
299
318
  #
300
- # @param inbound_funds_hold [Increase::Models::ACHTransfer::InboundFundsHold, nil] Increase will sometimes hold the funds for ACH debit transfers. If funds are hel
319
+ # @param inbound_funds_hold [Increase::Models::ACHTransfer::InboundFundsHold, nil]
320
+ # Increase will sometimes hold the funds for ACH debit transfers. If funds are
321
+ # held, this sub-object will contain details of the hold.
301
322
  #
302
- # @param individual_id [String, nil] Your internal identifier for the transfer recipient. This value is informational
323
+ # @param individual_id [String, nil]
324
+ # Your internal identifier for the transfer recipient. This value is informational
325
+ # and not verified by the recipient's bank.
303
326
  #
304
- # @param individual_name [String, nil] The name of the transfer recipient. This value is informational and not verified
327
+ # @param individual_name [String, nil]
328
+ # The name of the transfer recipient. This value is informational and not verified
329
+ # by the recipient's bank.
305
330
  #
306
331
  # @param network [Symbol, Increase::Models::ACHTransfer::Network] The transfer's network.
307
332
  #
308
- # @param notifications_of_change [Array<Increase::Models::ACHTransfer::NotificationsOfChange>] If the receiving bank notifies that future transfers should use different detail
333
+ # @param notifications_of_change [Array<Increase::Models::ACHTransfer::NotificationsOfChange>]
334
+ # If the receiving bank notifies that future transfers should use different
335
+ # details, this will contain those details.
309
336
  #
310
- # @param pending_transaction_id [String, nil] The ID for the pending transaction representing the transfer. A pending transact
337
+ # @param pending_transaction_id [String, nil]
338
+ # The ID for the pending transaction representing the transfer. A pending
339
+ # transaction is created when the transfer
340
+ # [requires approval](https://increase.com/documentation/transfer-approvals#transfer-approvals)
341
+ # by someone else in your organization.
311
342
  #
312
- # @param preferred_effective_date [Increase::Models::ACHTransfer::PreferredEffectiveDate] Configuration for how the effective date of the transfer will be set. This deter
343
+ # @param preferred_effective_date [Increase::Models::ACHTransfer::PreferredEffectiveDate]
344
+ # Configuration for how the effective date of the transfer will be set. This
345
+ # determines same-day vs future-dated settlement timing. If not set, defaults to a
346
+ # `settlement_schedule` of `same_day`. If set, exactly one of the child attributes
347
+ # must be set.
313
348
  #
314
- # @param return_ [Increase::Models::ACHTransfer::Return, nil] If your transfer is returned, this will contain details of the return.
349
+ # @param return_ [Increase::Models::ACHTransfer::Return, nil]
350
+ # If your transfer is returned, this will contain details of the return.
315
351
  #
316
- # @param routing_number [String] The American Bankers' Association (ABA) Routing Transit Number (RTN) of the rece
352
+ # @param routing_number [String]
353
+ # The American Bankers' Association (ABA) Routing Transit Number (RTN) of the
354
+ # receiver's bank.
317
355
  #
318
- # @param settlement [Increase::Models::ACHTransfer::Settlement, nil] A subhash containing information about when and how the transfer settled at the
356
+ # @param settlement [Increase::Models::ACHTransfer::Settlement, nil]
357
+ # A subhash containing information about when and how the transfer settled at the
358
+ # Federal Reserve.
319
359
  #
320
- # @param standard_entry_class_code [Symbol, Increase::Models::ACHTransfer::StandardEntryClassCode] The [Standard Entry Class (SEC) code](/documentation/ach-standard-entry-class-co
360
+ # @param standard_entry_class_code [Symbol, Increase::Models::ACHTransfer::StandardEntryClassCode]
361
+ # The
362
+ # [Standard Entry Class (SEC) code](/documentation/ach-standard-entry-class-codes)
363
+ # to use for the transfer.
321
364
  #
322
365
  # @param statement_descriptor [String] The descriptor that will show on the recipient's bank statement.
323
366
  #
324
367
  # @param status [Symbol, Increase::Models::ACHTransfer::Status] The lifecycle status of the transfer.
325
368
  #
326
- # @param submission [Increase::Models::ACHTransfer::Submission, nil] After the transfer is submitted to FedACH, this will contain supplemental detail
369
+ # @param submission [Increase::Models::ACHTransfer::Submission, nil]
370
+ # After the transfer is submitted to FedACH, this will contain supplemental
371
+ # details. Increase batches transfers and submits a file to the Federal Reserve
372
+ # roughly every 30 minutes. The Federal Reserve processes ACH transfers during
373
+ # weekdays according to their
374
+ # [posted schedule](https://www.frbservices.org/resources/resource-centers/same-day-ach/fedach-processing-schedule.html).
327
375
  #
328
376
  # @param transaction_id [String, nil] The ID for the transaction funding the transfer.
329
377
  #
330
- # @param type [Symbol, Increase::Models::ACHTransfer::Type] A constant representing the object's type. For this resource it will always be `
378
+ # @param type [Symbol, Increase::Models::ACHTransfer::Type]
379
+ # A constant representing the object's type. For this resource it will always be
380
+ # `ach_transfer`.
331
381
 
332
382
  # @see Increase::Models::ACHTransfer#acknowledgement
333
383
  class Acknowledgement < Increase::Internal::Type::BaseModel
@@ -339,14 +389,13 @@ module Increase
339
389
  required :acknowledged_at, String
340
390
 
341
391
  # @!method initialize(acknowledged_at:)
342
- # Some parameter documentations has been truncated, see
343
- # {Increase::Models::ACHTransfer::Acknowledgement} for more details.
344
- #
345
392
  # After the transfer is acknowledged by FedACH, this will contain supplemental
346
393
  # details. The Federal Reserve sends an acknowledgement message for each file that
347
394
  # Increase submits.
348
395
  #
349
- # @param acknowledged_at [String] When the Federal Reserve acknowledged the submitted file containing this transfe
396
+ # @param acknowledged_at [String]
397
+ # When the Federal Reserve acknowledged the submitted file containing this
398
+ # transfer.
350
399
  end
351
400
 
352
401
  # @see Increase::Models::ACHTransfer#addenda
@@ -374,16 +423,18 @@ module Increase
374
423
  nil?: true
375
424
 
376
425
  # @!method initialize(category:, freeform: nil, payment_order_remittance_advice: nil)
377
- # Some parameter documentations has been truncated, see
378
- # {Increase::Models::ACHTransfer::Addenda} for more details.
379
- #
380
426
  # Additional information that will be sent to the recipient.
381
427
  #
382
- # @param category [Symbol, Increase::Models::ACHTransfer::Addenda::Category] The type of the resource. We may add additional possible values for this enum ov
428
+ # @param category [Symbol, Increase::Models::ACHTransfer::Addenda::Category]
429
+ # The type of the resource. We may add additional possible values for this enum
430
+ # over time; your application should be able to handle such additions gracefully.
383
431
  #
384
- # @param freeform [Increase::Models::ACHTransfer::Addenda::Freeform, nil] Unstructured `payment_related_information` passed through with the transfer.
432
+ # @param freeform [Increase::Models::ACHTransfer::Addenda::Freeform, nil]
433
+ # Unstructured `payment_related_information` passed through with the transfer.
385
434
  #
386
- # @param payment_order_remittance_advice [Increase::Models::ACHTransfer::Addenda::PaymentOrderRemittanceAdvice, nil] Structured ASC X12 820 remittance advice records. Please reach out to [support@i
435
+ # @param payment_order_remittance_advice [Increase::Models::ACHTransfer::Addenda::PaymentOrderRemittanceAdvice, nil]
436
+ # Structured ASC X12 820 remittance advice records. Please reach out to
437
+ # [support@increase.com](mailto:support@increase.com) for more information.
387
438
 
388
439
  # The type of the resource. We may add additional possible values for this enum
389
440
  # over time; your application should be able to handle such additions gracefully.
@@ -417,7 +468,8 @@ module Increase
417
468
  # @!method initialize(entries:)
418
469
  # Unstructured `payment_related_information` passed through with the transfer.
419
470
  #
420
- # @param entries [Array<Increase::Models::ACHTransfer::Addenda::Freeform::Entry>] Each entry represents an addendum sent with the transfer.
471
+ # @param entries [Array<Increase::Models::ACHTransfer::Addenda::Freeform::Entry>]
472
+ # Each entry represents an addendum sent with the transfer.
421
473
 
422
474
  class Entry < Increase::Internal::Type::BaseModel
423
475
  # @!attribute payment_related_information
@@ -444,7 +496,8 @@ module Increase
444
496
  # Structured ASC X12 820 remittance advice records. Please reach out to
445
497
  # [support@increase.com](mailto:support@increase.com) for more information.
446
498
  #
447
- # @param invoices [Array<Increase::Models::ACHTransfer::Addenda::PaymentOrderRemittanceAdvice::Invoice>] ASC X12 RMR records for this specific transfer.
499
+ # @param invoices [Array<Increase::Models::ACHTransfer::Addenda::PaymentOrderRemittanceAdvice::Invoice>]
500
+ # ASC X12 RMR records for this specific transfer.
448
501
 
449
502
  class Invoice < Increase::Internal::Type::BaseModel
450
503
  # @!attribute invoice_number
@@ -461,13 +514,12 @@ module Increase
461
514
  required :paid_amount, Integer
462
515
 
463
516
  # @!method initialize(invoice_number:, paid_amount:)
464
- # Some parameter documentations has been truncated, see
465
- # {Increase::Models::ACHTransfer::Addenda::PaymentOrderRemittanceAdvice::Invoice}
466
- # for more details.
467
- #
468
- # @param invoice_number [String] The invoice number for this reference, determined in advance with the receiver.
517
+ # @param invoice_number [String]
518
+ # The invoice number for this reference, determined in advance with the receiver.
469
519
  #
470
- # @param paid_amount [Integer] The amount that was paid for this invoice in the minor unit of its currency. For
520
+ # @param paid_amount [Integer]
521
+ # The amount that was paid for this invoice in the minor unit of its currency. For
522
+ # dollars, for example, this is cents.
471
523
  end
472
524
  end
473
525
  end
@@ -489,15 +541,16 @@ module Increase
489
541
  required :approved_by, String, nil?: true
490
542
 
491
543
  # @!method initialize(approved_at:, approved_by:)
492
- # Some parameter documentations has been truncated, see
493
- # {Increase::Models::ACHTransfer::Approval} for more details.
494
- #
495
544
  # If your account requires approvals for transfers and the transfer was approved,
496
545
  # this will contain details of the approval.
497
546
  #
498
- # @param approved_at [Time] The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which th
547
+ # @param approved_at [Time]
548
+ # The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
549
+ # the transfer was approved.
499
550
  #
500
- # @param approved_by [String, nil] If the Transfer was approved by a user in the dashboard, the email address of th
551
+ # @param approved_by [String, nil]
552
+ # If the Transfer was approved by a user in the dashboard, the email address of
553
+ # that user.
501
554
  end
502
555
 
503
556
  # @see Increase::Models::ACHTransfer#cancellation
@@ -517,15 +570,16 @@ module Increase
517
570
  required :canceled_by, String, nil?: true
518
571
 
519
572
  # @!method initialize(canceled_at:, canceled_by:)
520
- # Some parameter documentations has been truncated, see
521
- # {Increase::Models::ACHTransfer::Cancellation} for more details.
522
- #
523
573
  # If your account requires approvals for transfers and the transfer was not
524
574
  # approved, this will contain details of the cancellation.
525
575
  #
526
- # @param canceled_at [Time] The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which th
576
+ # @param canceled_at [Time]
577
+ # The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
578
+ # the Transfer was canceled.
527
579
  #
528
- # @param canceled_by [String, nil] If the Transfer was canceled by a user in the dashboard, the email address of th
580
+ # @param canceled_by [String, nil]
581
+ # If the Transfer was canceled by a user in the dashboard, the email address of
582
+ # that user.
529
583
  end
530
584
 
531
585
  # @see Increase::Models::ACHTransfer#created_by
@@ -557,13 +611,17 @@ module Increase
557
611
  # @!method initialize(category:, api_key: nil, oauth_application: nil, user: nil)
558
612
  # What object created the transfer, either via the API or the dashboard.
559
613
  #
560
- # @param category [Symbol, Increase::Models::ACHTransfer::CreatedBy::Category] The type of object that created this transfer.
614
+ # @param category [Symbol, Increase::Models::ACHTransfer::CreatedBy::Category]
615
+ # The type of object that created this transfer.
561
616
  #
562
- # @param api_key [Increase::Models::ACHTransfer::CreatedBy::APIKey, nil] If present, details about the API key that created the transfer.
617
+ # @param api_key [Increase::Models::ACHTransfer::CreatedBy::APIKey, nil]
618
+ # If present, details about the API key that created the transfer.
563
619
  #
564
- # @param oauth_application [Increase::Models::ACHTransfer::CreatedBy::OAuthApplication, nil] If present, details about the OAuth Application that created the transfer.
620
+ # @param oauth_application [Increase::Models::ACHTransfer::CreatedBy::OAuthApplication, nil]
621
+ # If present, details about the OAuth Application that created the transfer.
565
622
  #
566
- # @param user [Increase::Models::ACHTransfer::CreatedBy::User, nil] If present, details about the User that created the transfer.
623
+ # @param user [Increase::Models::ACHTransfer::CreatedBy::User, nil]
624
+ # If present, details about the User that created the transfer.
567
625
 
568
626
  # The type of object that created this transfer.
569
627
  #
@@ -744,19 +802,24 @@ module Increase
744
802
  required :type, enum: -> { Increase::ACHTransfer::InboundFundsHold::Type }
745
803
 
746
804
  # @!method initialize(amount:, automatically_releases_at:, created_at:, currency:, held_transaction_id:, pending_transaction_id:, released_at:, status:, type:)
747
- # Some parameter documentations has been truncated, see
748
- # {Increase::Models::ACHTransfer::InboundFundsHold} for more details.
749
- #
750
805
  # Increase will sometimes hold the funds for ACH debit transfers. If funds are
751
806
  # held, this sub-object will contain details of the hold.
752
807
  #
753
- # @param amount [Integer] The held amount in the minor unit of the account's currency. For dollars, for ex
808
+ # @param amount [Integer]
809
+ # The held amount in the minor unit of the account's currency. For dollars, for
810
+ # example, this is cents.
754
811
  #
755
- # @param automatically_releases_at [Time] When the hold will be released automatically. Certain conditions may cause it to
812
+ # @param automatically_releases_at [Time]
813
+ # When the hold will be released automatically. Certain conditions may cause it to
814
+ # be released before this time.
756
815
  #
757
- # @param created_at [Time] The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the hold wa
816
+ # @param created_at [Time]
817
+ # The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the hold
818
+ # was created.
758
819
  #
759
- # @param currency [Symbol, Increase::Models::ACHTransfer::InboundFundsHold::Currency] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the hold's curre
820
+ # @param currency [Symbol, Increase::Models::ACHTransfer::InboundFundsHold::Currency]
821
+ # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the hold's
822
+ # currency.
760
823
  #
761
824
  # @param held_transaction_id [String, nil] The ID of the Transaction for which funds were held.
762
825
  #
@@ -766,7 +829,9 @@ module Increase
766
829
  #
767
830
  # @param status [Symbol, Increase::Models::ACHTransfer::InboundFundsHold::Status] The status of the hold.
768
831
  #
769
- # @param type [Symbol, Increase::Models::ACHTransfer::InboundFundsHold::Type] A constant representing the object's type. For this resource it will always be `
832
+ # @param type [Symbol, Increase::Models::ACHTransfer::InboundFundsHold::Type]
833
+ # A constant representing the object's type. For this resource it will always be
834
+ # `inbound_funds_hold`.
770
835
 
771
836
  # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the hold's
772
837
  # currency.
@@ -867,20 +932,26 @@ module Increase
867
932
  required :created_at, Time
868
933
 
869
934
  # @!method initialize(change_code:, corrected_account_funding:, corrected_account_number:, corrected_individual_id:, corrected_routing_number:, created_at:)
870
- # Some parameter documentations has been truncated, see
871
- # {Increase::Models::ACHTransfer::NotificationsOfChange} for more details.
872
- #
873
- # @param change_code [Symbol, Increase::Models::ACHTransfer::NotificationsOfChange::ChangeCode] The required type of change that is being signaled by the receiving financial in
935
+ # @param change_code [Symbol, Increase::Models::ACHTransfer::NotificationsOfChange::ChangeCode]
936
+ # The required type of change that is being signaled by the receiving financial
937
+ # institution.
874
938
  #
875
- # @param corrected_account_funding [Symbol, Increase::Models::ACHTransfer::NotificationsOfChange::CorrectedAccountFunding, nil] The corrected account funding type that should be used in future ACHs to this ac
939
+ # @param corrected_account_funding [Symbol, Increase::Models::ACHTransfer::NotificationsOfChange::CorrectedAccountFunding, nil]
940
+ # The corrected account funding type that should be used in future ACHs to this
941
+ # account. This is derived from the corrected transaction code.
876
942
  #
877
- # @param corrected_account_number [String, nil] The corrected account number that should be used in future ACHs to this account.
943
+ # @param corrected_account_number [String, nil]
944
+ # The corrected account number that should be used in future ACHs to this account.
878
945
  #
879
- # @param corrected_individual_id [String, nil] The corrected individual identifier that should be used in future ACHs.
946
+ # @param corrected_individual_id [String, nil]
947
+ # The corrected individual identifier that should be used in future ACHs.
880
948
  #
881
- # @param corrected_routing_number [String, nil] The corrected routing number that should be used in future ACHs to this account.
949
+ # @param corrected_routing_number [String, nil]
950
+ # The corrected routing number that should be used in future ACHs to this account.
882
951
  #
883
- # @param created_at [Time] The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which th
952
+ # @param created_at [Time]
953
+ # The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
954
+ # the notification occurred.
884
955
 
885
956
  # The required type of change that is being signaled by the receiving financial
886
957
  # institution.
@@ -998,17 +1069,17 @@ module Increase
998
1069
  nil?: true
999
1070
 
1000
1071
  # @!method initialize(date:, settlement_schedule:)
1001
- # Some parameter documentations has been truncated, see
1002
- # {Increase::Models::ACHTransfer::PreferredEffectiveDate} for more details.
1003
- #
1004
1072
  # Configuration for how the effective date of the transfer will be set. This
1005
1073
  # determines same-day vs future-dated settlement timing. If not set, defaults to a
1006
1074
  # `settlement_schedule` of `same_day`. If set, exactly one of the child attributes
1007
1075
  # must be set.
1008
1076
  #
1009
- # @param date [Date, nil] A specific date in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format to
1077
+ # @param date [Date, nil]
1078
+ # A specific date in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format to
1079
+ # use as the effective date when submitting this transfer.
1010
1080
  #
1011
- # @param settlement_schedule [Symbol, Increase::Models::ACHTransfer::PreferredEffectiveDate::SettlementSchedule, nil] A schedule by which Increase will choose an effective date for the transfer.
1081
+ # @param settlement_schedule [Symbol, Increase::Models::ACHTransfer::PreferredEffectiveDate::SettlementSchedule, nil]
1082
+ # A schedule by which Increase will choose an effective date for the transfer.
1012
1083
 
1013
1084
  # A schedule by which Increase will choose an effective date for the transfer.
1014
1085
  #
@@ -1075,22 +1146,29 @@ module Increase
1075
1146
  required :transfer_id, String
1076
1147
 
1077
1148
  # @!method initialize(created_at:, raw_return_reason_code:, return_reason_code:, trace_number:, transaction_id:, transfer_id:)
1078
- # Some parameter documentations has been truncated, see
1079
- # {Increase::Models::ACHTransfer::Return} for more details.
1080
- #
1081
1149
  # If your transfer is returned, this will contain details of the return.
1082
1150
  #
1083
- # @param created_at [Time] The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which th
1151
+ # @param created_at [Time]
1152
+ # The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
1153
+ # the transfer was created.
1084
1154
  #
1085
1155
  # @param raw_return_reason_code [String] The three character ACH return code, in the range R01 to R85.
1086
1156
  #
1087
- # @param return_reason_code [Symbol, Increase::Models::ACHTransfer::Return::ReturnReasonCode] Why the ACH Transfer was returned. This reason code is sent by the receiving ban
1157
+ # @param return_reason_code [Symbol, Increase::Models::ACHTransfer::Return::ReturnReasonCode]
1158
+ # Why the ACH Transfer was returned. This reason code is sent by the receiving
1159
+ # bank back to Increase.
1088
1160
  #
1089
- # @param trace_number [String] A 15 digit number that was generated by the bank that initiated the return. The
1161
+ # @param trace_number [String]
1162
+ # A 15 digit number that was generated by the bank that initiated the return. The
1163
+ # trace number of the return is different than that of the original transfer. ACH
1164
+ # trace numbers are not unique, but along with the amount and date this number can
1165
+ # be used to identify the ACH return at the bank that initiated it.
1090
1166
  #
1091
1167
  # @param transaction_id [String] The identifier of the Transaction associated with this return.
1092
1168
  #
1093
- # @param transfer_id [String] The identifier of the ACH Transfer associated with this return. This matches the
1169
+ # @param transfer_id [String]
1170
+ # The identifier of the ACH Transfer associated with this return. This matches the
1171
+ # original Transaction's `source.ach_transfer_intention.transfer_id`.
1094
1172
 
1095
1173
  # Why the ACH Transfer was returned. This reason code is sent by the receiving
1096
1174
  # bank back to Increase.
@@ -1327,13 +1405,12 @@ module Increase
1327
1405
  required :settled_at, Time
1328
1406
 
1329
1407
  # @!method initialize(settled_at:)
1330
- # Some parameter documentations has been truncated, see
1331
- # {Increase::Models::ACHTransfer::Settlement} for more details.
1332
- #
1333
1408
  # A subhash containing information about when and how the transfer settled at the
1334
1409
  # Federal Reserve.
1335
1410
  #
1336
- # @param settled_at [Time] When the funds for this transfer have settled at the destination bank at the Fed
1411
+ # @param settled_at [Time]
1412
+ # When the funds for this transfer have settled at the destination bank at the
1413
+ # Federal Reserve.
1337
1414
  end
1338
1415
 
1339
1416
  # The
@@ -1454,26 +1531,45 @@ module Increase
1454
1531
  required :trace_number, String
1455
1532
 
1456
1533
  # @!method initialize(administrative_returns_expected_by:, effective_date:, expected_funds_settlement_at:, expected_settlement_schedule:, submitted_at:, trace_number:)
1457
- # Some parameter documentations has been truncated, see
1458
- # {Increase::Models::ACHTransfer::Submission} for more details.
1459
- #
1460
1534
  # After the transfer is submitted to FedACH, this will contain supplemental
1461
1535
  # details. Increase batches transfers and submits a file to the Federal Reserve
1462
1536
  # roughly every 30 minutes. The Federal Reserve processes ACH transfers during
1463
1537
  # weekdays according to their
1464
1538
  # [posted schedule](https://www.frbservices.org/resources/resource-centers/same-day-ach/fedach-processing-schedule.html).
1465
1539
  #
1466
- # @param administrative_returns_expected_by [Time] The timestamp by which any administrative returns are expected to be received by
1467
- #
1468
- # @param effective_date [Date] The ACH transfer's effective date as sent to the Federal Reserve. If a specific
1469
- #
1470
- # @param expected_funds_settlement_at [Time] When the transfer is expected to settle in the recipient's account. Credits may
1471
- #
1472
- # @param expected_settlement_schedule [Symbol, Increase::Models::ACHTransfer::Submission::ExpectedSettlementSchedule] The settlement schedule the transfer is expected to follow. This expectation tak
1540
+ # @param administrative_returns_expected_by [Time]
1541
+ # The timestamp by which any administrative returns are expected to be received
1542
+ # by. This follows the NACHA guidelines for return windows, which are: "In
1543
+ # general, return entries must be received by the RDFI’s ACH Operator by its
1544
+ # deposit deadline for the return entry to be made available to the ODFI no later
1545
+ # than the opening of business on the second banking day following the Settlement
1546
+ # Date of the original entry.".
1547
+ #
1548
+ # @param effective_date [Date]
1549
+ # The ACH transfer's effective date as sent to the Federal Reserve. If a specific
1550
+ # date was configured using `preferred_effective_date`, this will match that
1551
+ # value. Otherwise, it will be the date selected (following the specified
1552
+ # settlement schedule) at the time the transfer was submitted.
1553
+ #
1554
+ # @param expected_funds_settlement_at [Time]
1555
+ # When the transfer is expected to settle in the recipient's account. Credits may
1556
+ # be available sooner, at the receiving bank's discretion. The FedACH schedule is
1557
+ # published
1558
+ # [here](https://www.frbservices.org/resources/resource-centers/same-day-ach/fedach-processing-schedule.html).
1559
+ #
1560
+ # @param expected_settlement_schedule [Symbol, Increase::Models::ACHTransfer::Submission::ExpectedSettlementSchedule]
1561
+ # The settlement schedule the transfer is expected to follow. This expectation
1562
+ # takes into account the `effective_date`, `submitted_at`, and the amount of the
1563
+ # transfer.
1473
1564
  #
1474
1565
  # @param submitted_at [Time] When the ACH transfer was sent to FedACH.
1475
1566
  #
1476
- # @param trace_number [String] A 15 digit number recorded in the Nacha file and transmitted to the receiving ba
1567
+ # @param trace_number [String]
1568
+ # A 15 digit number recorded in the Nacha file and transmitted to the receiving
1569
+ # bank. Along with the amount, date, and originating routing number, this can be
1570
+ # used to identify the ACH transfer at the receiving bank. ACH trace numbers are
1571
+ # not unique, but are
1572
+ # [used to correlate returns](https://increase.com/documentation/ach-returns#ach-returns).
1477
1573
 
1478
1574
  # The settlement schedule the transfer is expected to follow. This expectation
1479
1575
  # takes into account the `effective_date`, `submitted_at`, and the amount of the