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
@@ -113,9 +113,6 @@ module Increase
113
113
  required :unstructured_remittance_information, String, nil?: true
114
114
 
115
115
  # @!method initialize(id:, account_id:, account_number_id:, amount:, confirmation:, created_at:, creditor_name:, currency:, debtor_account_number:, debtor_name:, debtor_routing_number:, decline:, status:, transaction_id:, type:, unique_end_to_end_transaction_reference:, unstructured_remittance_information:)
116
- # Some parameter documentations has been truncated, see
117
- # {Increase::Models::InboundFednowTransfer} for more details.
118
- #
119
116
  # An Inbound FedNow Transfer is a FedNow transfer initiated outside of Increase to
120
117
  # your account.
121
118
  #
@@ -127,13 +124,19 @@ module Increase
127
124
  #
128
125
  # @param amount [Integer] The amount in USD cents.
129
126
  #
130
- # @param confirmation [Increase::Models::InboundFednowTransfer::Confirmation, nil] If your transfer is confirmed, this will contain details of the confirmation.
127
+ # @param confirmation [Increase::Models::InboundFednowTransfer::Confirmation, nil]
128
+ # If your transfer is confirmed, this will contain details of the confirmation.
131
129
  #
132
- # @param created_at [Time] The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which th
130
+ # @param created_at [Time]
131
+ # The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
132
+ # the transfer was created.
133
133
  #
134
- # @param creditor_name [String] The name the sender of the transfer specified as the recipient of the transfer.
134
+ # @param creditor_name [String]
135
+ # The name the sender of the transfer specified as the recipient of the transfer.
135
136
  #
136
- # @param currency [Symbol, Increase::Models::InboundFednowTransfer::Currency] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code of the transfer's cu
137
+ # @param currency [Symbol, Increase::Models::InboundFednowTransfer::Currency]
138
+ # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code of the transfer's
139
+ # currency. This will always be "USD" for a FedNow transfer.
137
140
  #
138
141
  # @param debtor_account_number [String] The account number of the account that sent the transfer.
139
142
  #
@@ -141,17 +144,27 @@ module Increase
141
144
  #
142
145
  # @param debtor_routing_number [String] The routing number of the account that sent the transfer.
143
146
  #
144
- # @param decline [Increase::Models::InboundFednowTransfer::Decline, nil] If your transfer is declined, this will contain details of the decline.
147
+ # @param decline [Increase::Models::InboundFednowTransfer::Decline, nil]
148
+ # If your transfer is declined, this will contain details of the decline.
145
149
  #
146
- # @param status [Symbol, Increase::Models::InboundFednowTransfer::Status] The lifecycle status of the transfer.
150
+ # @param status [Symbol, Increase::Models::InboundFednowTransfer::Status]
151
+ # The lifecycle status of the transfer.
147
152
  #
148
- # @param transaction_id [String, nil] The identifier of the Transaction object created when the transfer was confirmed
153
+ # @param transaction_id [String, nil]
154
+ # The identifier of the Transaction object created when the transfer was
155
+ # confirmed.
149
156
  #
150
- # @param type [Symbol, Increase::Models::InboundFednowTransfer::Type] A constant representing the object's type. For this resource it will always be `
157
+ # @param type [Symbol, Increase::Models::InboundFednowTransfer::Type]
158
+ # A constant representing the object's type. For this resource it will always be
159
+ # `inbound_fednow_transfer`.
151
160
  #
152
- # @param unique_end_to_end_transaction_reference [String, nil] The Unique End-to-end Transaction Reference ([UETR](https://www.swift.com/paymen
161
+ # @param unique_end_to_end_transaction_reference [String, nil]
162
+ # The Unique End-to-end Transaction Reference
163
+ # ([UETR](https://www.swift.com/payments/what-unique-end-end-transaction-reference-uetr))
164
+ # of the transfer.
153
165
  #
154
- # @param unstructured_remittance_information [String, nil] Additional information included with the transfer.
166
+ # @param unstructured_remittance_information [String, nil]
167
+ # Additional information included with the transfer.
155
168
 
156
169
  # @see Increase::Models::InboundFednowTransfer#confirmation
157
170
  class Confirmation < Increase::Internal::Type::BaseModel
@@ -198,7 +211,8 @@ module Increase
198
211
  # @!method initialize(reason:, transfer_id:)
199
212
  # If your transfer is declined, this will contain details of the decline.
200
213
  #
201
- # @param reason [Symbol, Increase::Models::InboundFednowTransfer::Decline::Reason] Why the transfer was declined.
214
+ # @param reason [Symbol, Increase::Models::InboundFednowTransfer::Decline::Reason]
215
+ # Why the transfer was declined.
202
216
  #
203
217
  # @param transfer_id [String] The identifier of the FedNow Transfer that led to this declined transaction.
204
218
 
@@ -39,18 +39,19 @@ module Increase
39
39
  optional :limit, Integer
40
40
 
41
41
  # @!method initialize(account_id: nil, account_number_id: nil, created_at: nil, cursor: nil, limit: nil, request_options: {})
42
- # Some parameter documentations has been truncated, see
43
- # {Increase::Models::InboundFednowTransferListParams} for more details.
44
- #
45
42
  # @param account_id [String] Filter Inbound FedNow Transfers to those belonging to the specified Account.
46
43
  #
47
- # @param account_number_id [String] Filter Inbound FedNow Transfers to ones belonging to the specified Account Numbe
44
+ # @param account_number_id [String]
45
+ # Filter Inbound FedNow Transfers to ones belonging to the specified Account
46
+ # Number.
48
47
  #
49
48
  # @param created_at [Increase::Models::InboundFednowTransferListParams::CreatedAt]
50
49
  #
51
50
  # @param cursor [String] Return the page of entries after this one.
52
51
  #
53
- # @param limit [Integer] Limit the size of the list that is returned. The default (and maximum) is 100 ob
52
+ # @param limit [Integer]
53
+ # Limit the size of the list that is returned. The default (and maximum) is 100
54
+ # objects.
54
55
  #
55
56
  # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}]
56
57
 
@@ -84,16 +85,21 @@ module Increase
84
85
  optional :on_or_before, Time
85
86
 
86
87
  # @!method initialize(after: nil, before: nil, on_or_after: nil, on_or_before: nil)
87
- # Some parameter documentations has been truncated, see
88
- # {Increase::Models::InboundFednowTransferListParams::CreatedAt} for more details.
89
- #
90
- # @param after [Time] Return results after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) tim
88
+ # @param after [Time]
89
+ # Return results after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)
90
+ # timestamp.
91
91
  #
92
- # @param before [Time] Return results before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) ti
92
+ # @param before [Time]
93
+ # Return results before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)
94
+ # timestamp.
93
95
  #
94
- # @param on_or_after [Time] Return results on or after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_860
96
+ # @param on_or_after [Time]
97
+ # Return results on or after this
98
+ # [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.
95
99
  #
96
- # @param on_or_before [Time] Return results on or before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_86
100
+ # @param on_or_before [Time]
101
+ # Return results on or before this
102
+ # [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.
97
103
  end
98
104
  end
99
105
  end
@@ -14,7 +14,8 @@ module Increase
14
14
  required :inbound_fednow_transfer_id, String
15
15
 
16
16
  # @!method initialize(inbound_fednow_transfer_id:, request_options: {})
17
- # @param inbound_fednow_transfer_id [String] The identifier of the Inbound FedNow Transfer to get details for.
17
+ # @param inbound_fednow_transfer_id [String]
18
+ # The identifier of the Inbound FedNow Transfer to get details for.
18
19
  #
19
20
  # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}]
20
21
  end
@@ -68,9 +68,6 @@ module Increase
68
68
  required :type, enum: -> { Increase::InboundMailItem::Type }
69
69
 
70
70
  # @!method initialize(id:, checks:, created_at:, file_id:, lockbox_address_id:, lockbox_recipient_id:, recipient_name:, rejection_reason:, status:, type:)
71
- # Some parameter documentations has been truncated, see
72
- # {Increase::Models::InboundMailItem} for more details.
73
- #
74
71
  # Inbound Mail Items represent pieces of physical mail delivered to a Lockbox
75
72
  # Address. Increase automatically deposits checks mailed to a Lockbox Recipient
76
73
  # into the recipient's Account. Checks that are not matched to a Lockbox Recipient
@@ -80,21 +77,28 @@ module Increase
80
77
  #
81
78
  # @param checks [Array<Increase::Models::InboundMailItem::Check>] The checks in the mail item.
82
79
  #
83
- # @param created_at [Time] The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the Inbound
80
+ # @param created_at [Time]
81
+ # The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the Inbound
82
+ # Mail Item was created.
84
83
  #
85
84
  # @param file_id [String] The identifier for the File containing the scanned contents of the mail item.
86
85
  #
87
86
  # @param lockbox_address_id [String] The identifier for the Lockbox Address that received this mail item.
88
87
  #
89
- # @param lockbox_recipient_id [String, nil] The identifier for the Lockbox Recipient that received this mail item. For mail
88
+ # @param lockbox_recipient_id [String, nil]
89
+ # The identifier for the Lockbox Recipient that received this mail item. For mail
90
+ # items that could not be routed to a Lockbox Recipient, this will be null.
90
91
  #
91
92
  # @param recipient_name [String, nil] The recipient name as written on the mail item.
92
93
  #
93
- # @param rejection_reason [Symbol, Increase::Models::InboundMailItem::RejectionReason, nil] If the mail item has been rejected, why it was rejected.
94
+ # @param rejection_reason [Symbol, Increase::Models::InboundMailItem::RejectionReason, nil]
95
+ # If the mail item has been rejected, why it was rejected.
94
96
  #
95
97
  # @param status [Symbol, Increase::Models::InboundMailItem::Status] If the mail item has been processed.
96
98
  #
97
- # @param type [Symbol, Increase::Models::InboundMailItem::Type] A constant representing the object's type. For this resource it will always be `
99
+ # @param type [Symbol, Increase::Models::InboundMailItem::Type]
100
+ # A constant representing the object's type. For this resource it will always be
101
+ # `inbound_mail_item`.
98
102
 
99
103
  class Check < Increase::Internal::Type::BaseModel
100
104
  # @!attribute amount
@@ -138,7 +142,8 @@ module Increase
138
142
  #
139
143
  # @param front_file_id [String, nil] The identifier for the File containing the front of the check.
140
144
  #
141
- # @param status [Symbol, Increase::Models::InboundMailItem::Check::Status, nil] The status of the Inbound Mail Item Check.
145
+ # @param status [Symbol, Increase::Models::InboundMailItem::Check::Status, nil]
146
+ # The status of the Inbound Mail Item Check.
142
147
 
143
148
  # The status of the Inbound Mail Item Check.
144
149
  #
@@ -22,7 +22,8 @@ module Increase
22
22
  # @!method initialize(inbound_mail_item_id:, checks:, request_options: {})
23
23
  # @param inbound_mail_item_id [String] The identifier of the Inbound Mail Item to action.
24
24
  #
25
- # @param checks [Array<Increase::Models::InboundMailItemActionParams::Check>] The actions to perform on the Inbound Mail Item.
25
+ # @param checks [Array<Increase::Models::InboundMailItemActionParams::Check>]
26
+ # The actions to perform on the Inbound Mail Item.
26
27
  #
27
28
  # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}]
28
29
 
@@ -40,7 +41,8 @@ module Increase
40
41
  optional :account_id, String
41
42
 
42
43
  # @!method initialize(action:, account_id: nil)
43
- # @param action [Symbol, Increase::Models::InboundMailItemActionParams::Check::Action] The action to perform on the Inbound Mail Item.
44
+ # @param action [Symbol, Increase::Models::InboundMailItemActionParams::Check::Action]
45
+ # The action to perform on the Inbound Mail Item.
44
46
  #
45
47
  # @param account_id [String] The identifier of the Account to deposit the check into.
46
48
 
@@ -38,18 +38,18 @@ module Increase
38
38
  optional :lockbox_recipient_id, String
39
39
 
40
40
  # @!method initialize(created_at: nil, cursor: nil, limit: nil, lockbox_address_id: nil, lockbox_recipient_id: nil, request_options: {})
41
- # Some parameter documentations has been truncated, see
42
- # {Increase::Models::InboundMailItemListParams} for more details.
43
- #
44
41
  # @param created_at [Increase::Models::InboundMailItemListParams::CreatedAt]
45
42
  #
46
43
  # @param cursor [String] Return the page of entries after this one.
47
44
  #
48
- # @param limit [Integer] Limit the size of the list that is returned. The default (and maximum) is 100 ob
45
+ # @param limit [Integer]
46
+ # Limit the size of the list that is returned. The default (and maximum) is 100
47
+ # objects.
49
48
  #
50
49
  # @param lockbox_address_id [String] Filter Inbound Mail Items to ones sent to the provided Lockbox Address.
51
50
  #
52
- # @param lockbox_recipient_id [String] Filter Inbound Mail Items to ones sent to the provided Lockbox Recipient.
51
+ # @param lockbox_recipient_id [String]
52
+ # Filter Inbound Mail Items to ones sent to the provided Lockbox Recipient.
53
53
  #
54
54
  # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}]
55
55
 
@@ -83,16 +83,21 @@ module Increase
83
83
  optional :on_or_before, Time
84
84
 
85
85
  # @!method initialize(after: nil, before: nil, on_or_after: nil, on_or_before: nil)
86
- # Some parameter documentations has been truncated, see
87
- # {Increase::Models::InboundMailItemListParams::CreatedAt} for more details.
88
- #
89
- # @param after [Time] Return results after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) tim
86
+ # @param after [Time]
87
+ # Return results after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)
88
+ # timestamp.
90
89
  #
91
- # @param before [Time] Return results before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) ti
90
+ # @param before [Time]
91
+ # Return results before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)
92
+ # timestamp.
92
93
  #
93
- # @param on_or_after [Time] Return results on or after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_860
94
+ # @param on_or_after [Time]
95
+ # Return results on or after this
96
+ # [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.
94
97
  #
95
- # @param on_or_before [Time] Return results on or before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_86
98
+ # @param on_or_before [Time]
99
+ # Return results on or before this
100
+ # [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.
96
101
  end
97
102
  end
98
103
  end
@@ -104,9 +104,6 @@ module Increase
104
104
  required :unstructured_remittance_information, String, nil?: true
105
105
 
106
106
  # @!method initialize(id:, account_id:, account_number_id:, amount:, confirmation:, created_at:, creditor_name:, currency:, debtor_account_number:, debtor_name:, debtor_routing_number:, decline:, status:, transaction_identification:, type:, unstructured_remittance_information:)
107
- # Some parameter documentations has been truncated, see
108
- # {Increase::Models::InboundRealTimePaymentsTransfer} for more details.
109
- #
110
107
  # An Inbound Real-Time Payments Transfer is a Real-Time Payments transfer
111
108
  # initiated outside of Increase to your account.
112
109
  #
@@ -118,13 +115,19 @@ module Increase
118
115
  #
119
116
  # @param amount [Integer] The amount in USD cents.
120
117
  #
121
- # @param confirmation [Increase::Models::InboundRealTimePaymentsTransfer::Confirmation, nil] If your transfer is confirmed, this will contain details of the confirmation.
118
+ # @param confirmation [Increase::Models::InboundRealTimePaymentsTransfer::Confirmation, nil]
119
+ # If your transfer is confirmed, this will contain details of the confirmation.
122
120
  #
123
- # @param created_at [Time] The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which th
121
+ # @param created_at [Time]
122
+ # The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
123
+ # the transfer was created.
124
124
  #
125
- # @param creditor_name [String] The name the sender of the transfer specified as the recipient of the transfer.
125
+ # @param creditor_name [String]
126
+ # The name the sender of the transfer specified as the recipient of the transfer.
126
127
  #
127
- # @param currency [Symbol, Increase::Models::InboundRealTimePaymentsTransfer::Currency] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code of the transfer's cu
128
+ # @param currency [Symbol, Increase::Models::InboundRealTimePaymentsTransfer::Currency]
129
+ # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code of the transfer's
130
+ # currency. This will always be "USD" for a Real-Time Payments transfer.
128
131
  #
129
132
  # @param debtor_account_number [String] The account number of the account that sent the transfer.
130
133
  #
@@ -132,15 +135,20 @@ module Increase
132
135
  #
133
136
  # @param debtor_routing_number [String] The routing number of the account that sent the transfer.
134
137
  #
135
- # @param decline [Increase::Models::InboundRealTimePaymentsTransfer::Decline, nil] If your transfer is declined, this will contain details of the decline.
138
+ # @param decline [Increase::Models::InboundRealTimePaymentsTransfer::Decline, nil]
139
+ # If your transfer is declined, this will contain details of the decline.
136
140
  #
137
- # @param status [Symbol, Increase::Models::InboundRealTimePaymentsTransfer::Status] The lifecycle status of the transfer.
141
+ # @param status [Symbol, Increase::Models::InboundRealTimePaymentsTransfer::Status]
142
+ # The lifecycle status of the transfer.
138
143
  #
139
144
  # @param transaction_identification [String] The Real-Time Payments network identification of the transfer.
140
145
  #
141
- # @param type [Symbol, Increase::Models::InboundRealTimePaymentsTransfer::Type] A constant representing the object's type. For this resource it will always be `
146
+ # @param type [Symbol, Increase::Models::InboundRealTimePaymentsTransfer::Type]
147
+ # A constant representing the object's type. For this resource it will always be
148
+ # `inbound_real_time_payments_transfer`.
142
149
  #
143
- # @param unstructured_remittance_information [String, nil] Additional information included with the transfer.
150
+ # @param unstructured_remittance_information [String, nil]
151
+ # Additional information included with the transfer.
144
152
 
145
153
  # @see Increase::Models::InboundRealTimePaymentsTransfer#confirmation
146
154
  class Confirmation < Increase::Internal::Type::BaseModel
@@ -205,7 +213,8 @@ module Increase
205
213
  #
206
214
  # @param declined_transaction_id [String] The id of the transaction for the declined transfer.
207
215
  #
208
- # @param reason [Symbol, Increase::Models::InboundRealTimePaymentsTransfer::Decline::Reason] The reason for the transfer decline.
216
+ # @param reason [Symbol, Increase::Models::InboundRealTimePaymentsTransfer::Decline::Reason]
217
+ # The reason for the transfer decline.
209
218
 
210
219
  # The reason for the transfer decline.
211
220
  #
@@ -40,18 +40,21 @@ module Increase
40
40
  optional :limit, Integer
41
41
 
42
42
  # @!method initialize(account_id: nil, account_number_id: nil, created_at: nil, cursor: nil, limit: nil, request_options: {})
43
- # Some parameter documentations has been truncated, see
44
- # {Increase::Models::InboundRealTimePaymentsTransferListParams} for more details.
43
+ # @param account_id [String]
44
+ # Filter Inbound Real-Time Payments Transfers to those belonging to the specified
45
+ # Account.
45
46
  #
46
- # @param account_id [String] Filter Inbound Real-Time Payments Transfers to those belonging to the specified
47
- #
48
- # @param account_number_id [String] Filter Inbound Real-Time Payments Transfers to ones belonging to the specified A
47
+ # @param account_number_id [String]
48
+ # Filter Inbound Real-Time Payments Transfers to ones belonging to the specified
49
+ # Account Number.
49
50
  #
50
51
  # @param created_at [Increase::Models::InboundRealTimePaymentsTransferListParams::CreatedAt]
51
52
  #
52
53
  # @param cursor [String] Return the page of entries after this one.
53
54
  #
54
- # @param limit [Integer] Limit the size of the list that is returned. The default (and maximum) is 100 ob
55
+ # @param limit [Integer]
56
+ # Limit the size of the list that is returned. The default (and maximum) is 100
57
+ # objects.
55
58
  #
56
59
  # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}]
57
60
 
@@ -85,17 +88,21 @@ module Increase
85
88
  optional :on_or_before, Time
86
89
 
87
90
  # @!method initialize(after: nil, before: nil, on_or_after: nil, on_or_before: nil)
88
- # Some parameter documentations has been truncated, see
89
- # {Increase::Models::InboundRealTimePaymentsTransferListParams::CreatedAt} for
90
- # more details.
91
- #
92
- # @param after [Time] Return results after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) tim
91
+ # @param after [Time]
92
+ # Return results after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)
93
+ # timestamp.
93
94
  #
94
- # @param before [Time] Return results before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) ti
95
+ # @param before [Time]
96
+ # Return results before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)
97
+ # timestamp.
95
98
  #
96
- # @param on_or_after [Time] Return results on or after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_860
99
+ # @param on_or_after [Time]
100
+ # Return results on or after this
101
+ # [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.
97
102
  #
98
- # @param on_or_before [Time] Return results on or before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_86
103
+ # @param on_or_before [Time]
104
+ # Return results on or before this
105
+ # [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.
99
106
  end
100
107
  end
101
108
  end
@@ -14,7 +14,8 @@ module Increase
14
14
  required :inbound_real_time_payments_transfer_id, String
15
15
 
16
16
  # @!method initialize(inbound_real_time_payments_transfer_id:, request_options: {})
17
- # @param inbound_real_time_payments_transfer_id [String] The identifier of the Inbound Real-Time Payments Transfer to get details for.
17
+ # @param inbound_real_time_payments_transfer_id [String]
18
+ # The identifier of the Inbound Real-Time Payments Transfer to get details for.
18
19
  #
19
20
  # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}]
20
21
  end
@@ -140,9 +140,6 @@ module Increase
140
140
  required :unstructured_remittance_information, String, nil?: true
141
141
 
142
142
  # @!method initialize(id:, amount:, created_at:, creditor_account_number:, creditor_address_line1:, creditor_address_line2:, creditor_address_line3:, creditor_name:, creditor_routing_number:, currency:, debtor_address_line1:, debtor_address_line2:, debtor_address_line3:, debtor_name:, end_to_end_identification:, input_message_accountability_data:, instruction_identification:, recipient_account_number_id:, type:, unique_end_to_end_transaction_reference:, unstructured_remittance_information:)
143
- # Some parameter documentations has been truncated, see
144
- # {Increase::Models::InboundWireDrawdownRequest} for more details.
145
- #
146
143
  # Inbound wire drawdown requests are requests from someone else to send them a
147
144
  # wire. For more information, see our
148
145
  # [Wire Drawdown Requests documentation](/documentation/wire-drawdown-requests).
@@ -151,7 +148,9 @@ module Increase
151
148
  #
152
149
  # @param amount [Integer] The amount being requested in cents.
153
150
  #
154
- # @param created_at [Time] The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which th
151
+ # @param created_at [Time]
152
+ # The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
153
+ # the inbound wire drawdown request was created.
155
154
  #
156
155
  # @param creditor_account_number [String] The creditor's account number.
157
156
  #
@@ -165,7 +164,9 @@ module Increase
165
164
  #
166
165
  # @param creditor_routing_number [String] The creditor's routing number.
167
166
  #
168
- # @param currency [String] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the amount being
167
+ # @param currency [String]
168
+ # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the amount being
169
+ # requested. Will always be "USD".
169
170
  #
170
171
  # @param debtor_address_line1 [String, nil] A free-form address field set by the sender.
171
172
  #
@@ -175,17 +176,29 @@ module Increase
175
176
  #
176
177
  # @param debtor_name [String, nil] A name set by the sender.
177
178
  #
178
- # @param end_to_end_identification [String, nil] A free-form reference string set by the sender, to help identify the drawdown re
179
+ # @param end_to_end_identification [String, nil]
180
+ # A free-form reference string set by the sender, to help identify the drawdown
181
+ # request.
179
182
  #
180
- # @param input_message_accountability_data [String, nil] A unique identifier available to the originating and receiving banks, commonly a
183
+ # @param input_message_accountability_data [String, nil]
184
+ # A unique identifier available to the originating and receiving banks, commonly
185
+ # abbreviated as IMAD. It is created when the wire is submitted to the Fedwire
186
+ # service and is helpful when debugging wires with the originating bank.
181
187
  #
182
188
  # @param instruction_identification [String, nil] The sending bank's identifier for the drawdown request.
183
189
  #
184
- # @param recipient_account_number_id [String] The Account Number from which the recipient of this request is being requested t
190
+ # @param recipient_account_number_id [String]
191
+ # The Account Number from which the recipient of this request is being requested
192
+ # to send funds.
185
193
  #
186
- # @param type [Symbol, Increase::Models::InboundWireDrawdownRequest::Type] A constant representing the object's type. For this resource it will always be `
194
+ # @param type [Symbol, Increase::Models::InboundWireDrawdownRequest::Type]
195
+ # A constant representing the object's type. For this resource it will always be
196
+ # `inbound_wire_drawdown_request`.
187
197
  #
188
- # @param unique_end_to_end_transaction_reference [String, nil] The Unique End-to-end Transaction Reference ([UETR](https://www.swift.com/paymen
198
+ # @param unique_end_to_end_transaction_reference [String, nil]
199
+ # The Unique End-to-end Transaction Reference
200
+ # ([UETR](https://www.swift.com/payments/what-unique-end-end-transaction-reference-uetr))
201
+ # of the drawdown request.
189
202
  #
190
203
  # @param unstructured_remittance_information [String, nil] A free-form message set by the sender.
191
204
 
@@ -21,12 +21,11 @@ module Increase
21
21
  optional :limit, Integer
22
22
 
23
23
  # @!method initialize(cursor: nil, limit: nil, request_options: {})
24
- # Some parameter documentations has been truncated, see
25
- # {Increase::Models::InboundWireDrawdownRequestListParams} for more details.
26
- #
27
24
  # @param cursor [String] Return the page of entries after this one.
28
25
  #
29
- # @param limit [Integer] Limit the size of the list that is returned. The default (and maximum) is 100 ob
26
+ # @param limit [Integer]
27
+ # Limit the size of the list that is returned. The default (and maximum) is 100
28
+ # objects.
30
29
  #
31
30
  # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}]
32
31
  end
@@ -14,7 +14,8 @@ module Increase
14
14
  required :inbound_wire_drawdown_request_id, String
15
15
 
16
16
  # @!method initialize(inbound_wire_drawdown_request_id:, request_options: {})
17
- # @param inbound_wire_drawdown_request_id [String] The identifier of the Inbound Wire Drawdown Request to retrieve.
17
+ # @param inbound_wire_drawdown_request_id [String]
18
+ # The identifier of the Inbound Wire Drawdown Request to retrieve.
18
19
  #
19
20
  # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}]
20
21
  end
@@ -168,15 +168,13 @@ module Increase
168
168
  required :wire_drawdown_request_id, String, nil?: true
169
169
 
170
170
  # @!method initialize(id:, acceptance:, account_id:, account_number_id:, amount:, created_at:, creditor_address_line1:, creditor_address_line2:, creditor_address_line3:, creditor_name:, debtor_address_line1:, debtor_address_line2:, debtor_address_line3:, debtor_name:, description:, end_to_end_identification:, input_message_accountability_data:, instructing_agent_routing_number:, instruction_identification:, purpose:, reversal:, status:, type:, unique_end_to_end_transaction_reference:, unstructured_remittance_information:, wire_drawdown_request_id:)
171
- # Some parameter documentations has been truncated, see
172
- # {Increase::Models::InboundWireTransfer} for more details.
173
- #
174
171
  # An Inbound Wire Transfer is a wire transfer initiated outside of Increase to
175
172
  # your account.
176
173
  #
177
174
  # @param id [String] The inbound wire transfer's identifier.
178
175
  #
179
- # @param acceptance [Increase::Models::InboundWireTransfer::Acceptance, nil] If the transfer is accepted, this will contain details of the acceptance.
176
+ # @param acceptance [Increase::Models::InboundWireTransfer::Acceptance, nil]
177
+ # If the transfer is accepted, this will contain details of the acceptance.
180
178
  #
181
179
  # @param account_id [String] The Account to which the transfer belongs.
182
180
  #
@@ -184,7 +182,9 @@ module Increase
184
182
  #
185
183
  # @param amount [Integer] The amount in USD cents.
186
184
  #
187
- # @param created_at [Time] The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which th
185
+ # @param created_at [Time]
186
+ # The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
187
+ # the inbound wire transfer was created.
188
188
  #
189
189
  # @param creditor_address_line1 [String, nil] A free-form address field set by the sender.
190
190
  #
@@ -204,27 +204,40 @@ module Increase
204
204
  #
205
205
  # @param description [String] An Increase-constructed description of the transfer.
206
206
  #
207
- # @param end_to_end_identification [String, nil] A free-form reference string set by the sender, to help identify the transfer.
207
+ # @param end_to_end_identification [String, nil]
208
+ # A free-form reference string set by the sender, to help identify the transfer.
208
209
  #
209
- # @param input_message_accountability_data [String, nil] A unique identifier available to the originating and receiving banks, commonly a
210
+ # @param input_message_accountability_data [String, nil]
211
+ # A unique identifier available to the originating and receiving banks, commonly
212
+ # abbreviated as IMAD. It is created when the wire is submitted to the Fedwire
213
+ # service and is helpful when debugging wires with the originating bank.
210
214
  #
211
- # @param instructing_agent_routing_number [String, nil] The American Banking Association (ABA) routing number of the bank that sent the
215
+ # @param instructing_agent_routing_number [String, nil]
216
+ # The American Banking Association (ABA) routing number of the bank that sent the
217
+ # wire.
212
218
  #
213
219
  # @param instruction_identification [String, nil] The sending bank's identifier for the wire transfer.
214
220
  #
215
221
  # @param purpose [String, nil] The reason for the wire transfer, as set by the sender.
216
222
  #
217
- # @param reversal [Increase::Models::InboundWireTransfer::Reversal, nil] If the transfer is reversed, this will contain details of the reversal.
223
+ # @param reversal [Increase::Models::InboundWireTransfer::Reversal, nil]
224
+ # If the transfer is reversed, this will contain details of the reversal.
218
225
  #
219
226
  # @param status [Symbol, Increase::Models::InboundWireTransfer::Status] The status of the transfer.
220
227
  #
221
- # @param type [Symbol, Increase::Models::InboundWireTransfer::Type] A constant representing the object's type. For this resource it will always be `
228
+ # @param type [Symbol, Increase::Models::InboundWireTransfer::Type]
229
+ # A constant representing the object's type. For this resource it will always be
230
+ # `inbound_wire_transfer`.
222
231
  #
223
- # @param unique_end_to_end_transaction_reference [String, nil] The Unique End-to-end Transaction Reference ([UETR](https://www.swift.com/paymen
232
+ # @param unique_end_to_end_transaction_reference [String, nil]
233
+ # The Unique End-to-end Transaction Reference
234
+ # ([UETR](https://www.swift.com/payments/what-unique-end-end-transaction-reference-uetr))
235
+ # of the transfer.
224
236
  #
225
237
  # @param unstructured_remittance_information [String, nil] A free-form message set by the sender.
226
238
  #
227
- # @param wire_drawdown_request_id [String, nil] The wire drawdown request the inbound wire transfer is fulfilling.
239
+ # @param wire_drawdown_request_id [String, nil]
240
+ # The wire drawdown request the inbound wire transfer is fulfilling.
228
241
 
229
242
  # @see Increase::Models::InboundWireTransfer#acceptance
230
243
  class Acceptance < Increase::Internal::Type::BaseModel
@@ -242,12 +255,11 @@ module Increase
242
255
  required :transaction_id, String
243
256
 
244
257
  # @!method initialize(accepted_at:, transaction_id:)
245
- # Some parameter documentations has been truncated, see
246
- # {Increase::Models::InboundWireTransfer::Acceptance} for more details.
247
- #
248
258
  # If the transfer is accepted, this will contain details of the acceptance.
249
259
  #
250
- # @param accepted_at [Time] The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which th
260
+ # @param accepted_at [Time]
261
+ # The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
262
+ # the transfer was accepted.
251
263
  #
252
264
  # @param transaction_id [String] The identifier of the transaction for the accepted transfer.
253
265
  end
@@ -268,14 +280,14 @@ module Increase
268
280
  required :reversed_at, Time
269
281
 
270
282
  # @!method initialize(reason:, reversed_at:)
271
- # Some parameter documentations has been truncated, see
272
- # {Increase::Models::InboundWireTransfer::Reversal} for more details.
273
- #
274
283
  # If the transfer is reversed, this will contain details of the reversal.
275
284
  #
276
- # @param reason [Symbol, Increase::Models::InboundWireTransfer::Reversal::Reason] The reason for the reversal.
285
+ # @param reason [Symbol, Increase::Models::InboundWireTransfer::Reversal::Reason]
286
+ # The reason for the reversal.
277
287
  #
278
- # @param reversed_at [Time] The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which th
288
+ # @param reversed_at [Time]
289
+ # The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
290
+ # the transfer was reversed.
279
291
 
280
292
  # The reason for the reversal.
281
293
  #