increase 0.3.3 → 1.0.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 (1110) hide show
  1. checksums.yaml +4 -4
  2. data/.ignore +2 -0
  3. data/CHANGELOG.md +807 -56
  4. data/README.md +209 -254
  5. data/SECURITY.md +3 -0
  6. data/lib/increase/client.rb +287 -43
  7. data/lib/increase/errors.rb +223 -63
  8. data/lib/increase/file_part.rb +55 -0
  9. data/lib/increase/internal/page.rb +86 -0
  10. data/lib/increase/internal/transport/base_client.rb +555 -0
  11. data/lib/increase/internal/transport/pooled_net_requester.rb +209 -0
  12. data/lib/increase/internal/type/array_of.rb +162 -0
  13. data/lib/increase/internal/type/base_model.rb +484 -0
  14. data/lib/increase/internal/type/base_page.rb +55 -0
  15. data/lib/increase/internal/type/boolean.rb +71 -0
  16. data/lib/increase/internal/type/converter.rb +292 -0
  17. data/lib/increase/internal/type/enum.rb +123 -0
  18. data/lib/increase/internal/type/file_input.rb +103 -0
  19. data/lib/increase/internal/type/hash_of.rb +182 -0
  20. data/lib/increase/internal/type/request_parameters.rb +42 -0
  21. data/lib/increase/internal/type/union.rb +230 -0
  22. data/lib/increase/internal/type/unknown.rb +75 -0
  23. data/lib/increase/internal/util.rb +914 -0
  24. data/lib/increase/internal.rb +20 -0
  25. data/lib/increase/models/account.rb +224 -0
  26. data/lib/increase/models/account_balance_params.rb +22 -0
  27. data/lib/increase/models/account_close_params.rb +14 -0
  28. data/lib/increase/models/account_create_params.rb +51 -0
  29. data/lib/increase/models/account_list_params.rb +155 -0
  30. data/lib/increase/models/account_number.rb +209 -0
  31. data/lib/increase/models/account_number_create_params.rb +121 -0
  32. data/lib/increase/models/account_number_list_params.rb +183 -0
  33. data/lib/increase/models/account_number_retrieve_params.rb +14 -0
  34. data/lib/increase/models/account_number_update_params.rb +131 -0
  35. data/lib/increase/models/account_retrieve_params.rb +14 -0
  36. data/lib/increase/models/account_statement.rb +105 -0
  37. data/lib/increase/models/account_statement_list_params.rb +92 -0
  38. data/lib/increase/models/account_statement_retrieve_params.rb +14 -0
  39. data/lib/increase/models/account_transfer.rb +389 -0
  40. data/lib/increase/models/account_transfer_approve_params.rb +14 -0
  41. data/lib/increase/models/account_transfer_cancel_params.rb +14 -0
  42. data/lib/increase/models/account_transfer_create_params.rb +58 -0
  43. data/lib/increase/models/account_transfer_list_params.rb +102 -0
  44. data/lib/increase/models/account_transfer_retrieve_params.rb +14 -0
  45. data/lib/increase/models/account_update_params.rb +22 -0
  46. data/lib/increase/models/ach_prenotification.rb +562 -0
  47. data/lib/increase/models/ach_prenotification_create_params.rb +160 -0
  48. data/lib/increase/models/ach_prenotification_list_params.rb +94 -0
  49. data/lib/increase/models/ach_prenotification_retrieve_params.rb +14 -0
  50. data/lib/increase/models/ach_transfer.rb +1481 -0
  51. data/lib/increase/models/ach_transfer_approve_params.rb +14 -0
  52. data/lib/increase/models/ach_transfer_cancel_params.rb +14 -0
  53. data/lib/increase/models/ach_transfer_create_params.rb +430 -0
  54. data/lib/increase/models/ach_transfer_list_params.rb +168 -0
  55. data/lib/increase/models/ach_transfer_retrieve_params.rb +14 -0
  56. data/lib/increase/models/balance_lookup.rb +63 -0
  57. data/lib/increase/models/bookkeeping_account.rb +104 -0
  58. data/lib/increase/models/bookkeeping_account_balance_params.rb +22 -0
  59. data/lib/increase/models/bookkeeping_account_create_params.rb +60 -0
  60. data/lib/increase/models/bookkeeping_account_list_params.rb +45 -0
  61. data/lib/increase/models/bookkeeping_account_update_params.rb +22 -0
  62. data/lib/increase/models/bookkeeping_balance_lookup.rb +54 -0
  63. data/lib/increase/models/bookkeeping_entry.rb +79 -0
  64. data/lib/increase/models/bookkeeping_entry_list_params.rb +42 -0
  65. data/lib/increase/models/bookkeeping_entry_retrieve_params.rb +14 -0
  66. data/lib/increase/models/bookkeeping_entry_set.rb +116 -0
  67. data/lib/increase/models/bookkeeping_entry_set_create_params.rb +67 -0
  68. data/lib/increase/models/bookkeeping_entry_set_list_params.rb +53 -0
  69. data/lib/increase/models/bookkeeping_entry_set_retrieve_params.rb +14 -0
  70. data/lib/increase/models/card.rb +243 -0
  71. data/lib/increase/models/card_create_params.rb +145 -0
  72. data/lib/increase/models/card_details.rb +78 -0
  73. data/lib/increase/models/card_details_params.rb +14 -0
  74. data/lib/increase/models/card_dispute.rb +302 -0
  75. data/lib/increase/models/card_dispute_create_params.rb +45 -0
  76. data/lib/increase/models/card_dispute_list_params.rb +144 -0
  77. data/lib/increase/models/card_dispute_retrieve_params.rb +14 -0
  78. data/lib/increase/models/card_list_params.rb +142 -0
  79. data/lib/increase/models/card_payment.rb +6511 -0
  80. data/lib/increase/models/card_payment_list_params.rb +99 -0
  81. data/lib/increase/models/card_payment_retrieve_params.rb +14 -0
  82. data/lib/increase/models/card_purchase_supplement.rb +452 -0
  83. data/lib/increase/models/card_purchase_supplement_list_params.rb +93 -0
  84. data/lib/increase/models/card_purchase_supplement_retrieve_params.rb +14 -0
  85. data/lib/increase/models/card_retrieve_params.rb +14 -0
  86. data/lib/increase/models/card_update_params.rb +158 -0
  87. data/lib/increase/models/check_deposit.rb +807 -0
  88. data/lib/increase/models/check_deposit_create_params.rb +57 -0
  89. data/lib/increase/models/check_deposit_list_params.rb +102 -0
  90. data/lib/increase/models/check_deposit_retrieve_params.rb +14 -0
  91. data/lib/increase/models/check_transfer.rb +983 -0
  92. data/lib/increase/models/check_transfer_approve_params.rb +14 -0
  93. data/lib/increase/models/check_transfer_cancel_params.rb +14 -0
  94. data/lib/increase/models/check_transfer_create_params.rb +324 -0
  95. data/lib/increase/models/check_transfer_list_params.rb +166 -0
  96. data/lib/increase/models/check_transfer_retrieve_params.rb +14 -0
  97. data/lib/increase/models/check_transfer_stop_payment_params.rb +39 -0
  98. data/lib/increase/models/declined_transaction.rb +1779 -0
  99. data/lib/increase/models/declined_transaction_list_params.rb +153 -0
  100. data/lib/increase/models/declined_transaction_retrieve_params.rb +14 -0
  101. data/lib/increase/models/digital_card_profile.rb +197 -0
  102. data/lib/increase/models/digital_card_profile_archive_params.rb +14 -0
  103. data/lib/increase/models/digital_card_profile_clone_params.rb +115 -0
  104. data/lib/increase/models/digital_card_profile_create_params.rb +115 -0
  105. data/lib/increase/models/digital_card_profile_list_params.rb +91 -0
  106. data/lib/increase/models/digital_card_profile_retrieve_params.rb +14 -0
  107. data/lib/increase/models/digital_wallet_token.rb +281 -0
  108. data/lib/increase/models/digital_wallet_token_list_params.rb +91 -0
  109. data/lib/increase/models/digital_wallet_token_retrieve_params.rb +14 -0
  110. data/lib/increase/models/document.rb +135 -0
  111. data/lib/increase/models/document_create_params.rb +62 -0
  112. data/lib/increase/models/document_list_params.rb +149 -0
  113. data/lib/increase/models/document_retrieve_params.rb +14 -0
  114. data/lib/increase/models/entity.rb +1476 -0
  115. data/lib/increase/models/entity_archive_beneficial_owner_params.rb +26 -0
  116. data/lib/increase/models/entity_archive_params.rb +14 -0
  117. data/lib/increase/models/entity_confirm_params.rb +26 -0
  118. data/lib/increase/models/entity_create_beneficial_owner_params.rb +412 -0
  119. data/lib/increase/models/entity_create_params.rb +2318 -0
  120. data/lib/increase/models/entity_list_params.rb +135 -0
  121. data/lib/increase/models/entity_retrieve_params.rb +14 -0
  122. data/lib/increase/models/entity_supplemental_document.rb +72 -0
  123. data/lib/increase/models/entity_update_address_params.rb +76 -0
  124. data/lib/increase/models/entity_update_beneficial_owner_address_params.rb +95 -0
  125. data/lib/increase/models/entity_update_industry_code_params.rb +28 -0
  126. data/lib/increase/models/event.rb +363 -0
  127. data/lib/increase/models/event_list_params.rb +395 -0
  128. data/lib/increase/models/event_retrieve_params.rb +14 -0
  129. data/lib/increase/models/event_subscription.rb +408 -0
  130. data/lib/increase/models/event_subscription_create_params.rb +334 -0
  131. data/lib/increase/models/event_subscription_list_params.rb +45 -0
  132. data/lib/increase/models/event_subscription_retrieve_params.rb +14 -0
  133. data/lib/increase/models/event_subscription_update_params.rb +39 -0
  134. data/lib/increase/models/export.rb +152 -0
  135. data/lib/increase/models/export_create_params.rb +444 -0
  136. data/lib/increase/models/export_list_params.rb +188 -0
  137. data/lib/increase/models/export_retrieve_params.rb +14 -0
  138. data/lib/increase/models/external_account.rb +166 -0
  139. data/lib/increase/models/external_account_create_params.rb +92 -0
  140. data/lib/increase/models/external_account_list_params.rb +93 -0
  141. data/lib/increase/models/external_account_retrieve_params.rb +14 -0
  142. data/lib/increase/models/external_account_update_params.rb +91 -0
  143. data/lib/increase/models/file.rb +213 -0
  144. data/lib/increase/models/file_create_params.rb +99 -0
  145. data/lib/increase/models/file_link.rb +90 -0
  146. data/lib/increase/models/file_link_create_params.rb +34 -0
  147. data/lib/increase/models/file_list_params.rb +203 -0
  148. data/lib/increase/models/file_retrieve_params.rb +14 -0
  149. data/lib/increase/models/group.rb +104 -0
  150. data/lib/increase/models/group_retrieve_params.rb +14 -0
  151. data/lib/increase/models/inbound_ach_transfer.rb +1095 -0
  152. data/lib/increase/models/inbound_ach_transfer_create_notification_of_change_params.rb +30 -0
  153. data/lib/increase/models/inbound_ach_transfer_decline_params.rb +69 -0
  154. data/lib/increase/models/inbound_ach_transfer_list_params.rb +145 -0
  155. data/lib/increase/models/inbound_ach_transfer_retrieve_params.rb +14 -0
  156. data/lib/increase/models/inbound_ach_transfer_transfer_return_params.rb +67 -0
  157. data/lib/increase/models/inbound_check_deposit.rb +391 -0
  158. data/lib/increase/models/inbound_check_deposit_decline_params.rb +14 -0
  159. data/lib/increase/models/inbound_check_deposit_list_params.rb +100 -0
  160. data/lib/increase/models/inbound_check_deposit_retrieve_params.rb +14 -0
  161. data/lib/increase/models/inbound_check_deposit_return_params.rb +45 -0
  162. data/lib/increase/models/inbound_mail_item.rb +132 -0
  163. data/lib/increase/models/inbound_mail_item_list_params.rb +91 -0
  164. data/lib/increase/models/inbound_mail_item_retrieve_params.rb +14 -0
  165. data/lib/increase/models/inbound_real_time_payments_transfer.rb +290 -0
  166. data/lib/increase/models/inbound_real_time_payments_transfer_list_params.rb +102 -0
  167. data/lib/increase/models/inbound_real_time_payments_transfer_retrieve_params.rb +14 -0
  168. data/lib/increase/models/inbound_wire_drawdown_request.rb +221 -0
  169. data/lib/increase/models/inbound_wire_drawdown_request_list_params.rb +34 -0
  170. data/lib/increase/models/inbound_wire_drawdown_request_retrieve_params.rb +14 -0
  171. data/lib/increase/models/inbound_wire_transfer.rb +307 -0
  172. data/lib/increase/models/inbound_wire_transfer_list_params.rb +145 -0
  173. data/lib/increase/models/inbound_wire_transfer_retrieve_params.rb +14 -0
  174. data/lib/increase/models/inbound_wire_transfer_reverse_params.rb +36 -0
  175. data/lib/increase/models/intrafi_account_enrollment.rb +121 -0
  176. data/lib/increase/models/intrafi_account_enrollment_create_params.rb +30 -0
  177. data/lib/increase/models/intrafi_account_enrollment_list_params.rb +102 -0
  178. data/lib/increase/models/intrafi_account_enrollment_retrieve_params.rb +14 -0
  179. data/lib/increase/models/intrafi_account_enrollment_unenroll_params.rb +14 -0
  180. data/lib/increase/models/intrafi_balance.rb +180 -0
  181. data/lib/increase/models/intrafi_balance_intrafi_balance_params.rb +14 -0
  182. data/lib/increase/models/intrafi_exclusion.rb +134 -0
  183. data/lib/increase/models/intrafi_exclusion_archive_params.rb +14 -0
  184. data/lib/increase/models/intrafi_exclusion_create_params.rb +30 -0
  185. data/lib/increase/models/intrafi_exclusion_list_params.rb +53 -0
  186. data/lib/increase/models/intrafi_exclusion_retrieve_params.rb +14 -0
  187. data/lib/increase/models/lockbox.rb +182 -0
  188. data/lib/increase/models/lockbox_create_params.rb +38 -0
  189. data/lib/increase/models/lockbox_list_params.rb +102 -0
  190. data/lib/increase/models/lockbox_retrieve_params.rb +14 -0
  191. data/lib/increase/models/lockbox_update_params.rb +52 -0
  192. data/lib/increase/models/oauth_application.rb +106 -0
  193. data/lib/increase/models/oauth_application_list_params.rb +122 -0
  194. data/lib/increase/models/oauth_application_retrieve_params.rb +14 -0
  195. data/lib/increase/models/oauth_connection.rb +104 -0
  196. data/lib/increase/models/oauth_connection_list_params.rb +83 -0
  197. data/lib/increase/models/oauth_connection_retrieve_params.rb +14 -0
  198. data/lib/increase/models/oauth_token.rb +67 -0
  199. data/lib/increase/models/oauth_token_create_params.rb +78 -0
  200. data/lib/increase/models/pending_transaction.rb +1747 -0
  201. data/lib/increase/models/pending_transaction_create_params.rb +43 -0
  202. data/lib/increase/models/pending_transaction_list_params.rb +212 -0
  203. data/lib/increase/models/pending_transaction_release_params.rb +14 -0
  204. data/lib/increase/models/pending_transaction_retrieve_params.rb +14 -0
  205. data/lib/increase/models/physical_card.rb +433 -0
  206. data/lib/increase/models/physical_card_create_params.rb +185 -0
  207. data/lib/increase/models/physical_card_list_params.rb +102 -0
  208. data/lib/increase/models/physical_card_profile.rb +182 -0
  209. data/lib/increase/models/physical_card_profile_archive_params.rb +14 -0
  210. data/lib/increase/models/physical_card_profile_clone_params.rb +85 -0
  211. data/lib/increase/models/physical_card_profile_create_params.rb +93 -0
  212. data/lib/increase/models/physical_card_profile_list_params.rb +97 -0
  213. data/lib/increase/models/physical_card_profile_retrieve_params.rb +14 -0
  214. data/lib/increase/models/physical_card_retrieve_params.rb +14 -0
  215. data/lib/increase/models/physical_card_update_params.rb +39 -0
  216. data/lib/increase/models/program.rb +126 -0
  217. data/lib/increase/models/program_list_params.rb +34 -0
  218. data/lib/increase/models/program_retrieve_params.rb +14 -0
  219. data/lib/increase/models/real_time_decision.rb +1303 -0
  220. data/lib/increase/models/real_time_decision_action_params.rb +351 -0
  221. data/lib/increase/models/real_time_decision_retrieve_params.rb +14 -0
  222. data/lib/increase/models/real_time_payments_transfer.rb +622 -0
  223. data/lib/increase/models/real_time_payments_transfer_approve_params.rb +14 -0
  224. data/lib/increase/models/real_time_payments_transfer_cancel_params.rb +14 -0
  225. data/lib/increase/models/real_time_payments_transfer_create_params.rb +112 -0
  226. data/lib/increase/models/real_time_payments_transfer_list_params.rb +169 -0
  227. data/lib/increase/models/real_time_payments_transfer_retrieve_params.rb +14 -0
  228. data/lib/increase/models/routing_number_list_params.rb +42 -0
  229. data/lib/increase/models/routing_number_list_response.rb +125 -0
  230. data/lib/increase/models/simulations/account_statement_create_params.rb +24 -0
  231. data/lib/increase/models/simulations/account_transfer_complete_params.rb +16 -0
  232. data/lib/increase/models/simulations/ach_transfer_acknowledge_params.rb +16 -0
  233. data/lib/increase/models/simulations/ach_transfer_create_notification_of_change_params.rb +104 -0
  234. data/lib/increase/models/simulations/ach_transfer_return_params.rb +250 -0
  235. data/lib/increase/models/simulations/ach_transfer_settle_params.rb +16 -0
  236. data/lib/increase/models/simulations/ach_transfer_submit_params.rb +16 -0
  237. data/lib/increase/models/simulations/card_authorization_create_params.rb +309 -0
  238. data/lib/increase/models/simulations/card_authorization_create_response.rb +59 -0
  239. data/lib/increase/models/simulations/card_authorization_expiration_create_params.rb +24 -0
  240. data/lib/increase/models/simulations/card_dispute_action_params.rb +55 -0
  241. data/lib/increase/models/simulations/card_fuel_confirmation_create_params.rb +37 -0
  242. data/lib/increase/models/simulations/card_increment_create_params.rb +46 -0
  243. data/lib/increase/models/simulations/card_refund_create_params.rb +28 -0
  244. data/lib/increase/models/simulations/card_reversal_create_params.rb +36 -0
  245. data/lib/increase/models/simulations/card_settlement_create_params.rb +45 -0
  246. data/lib/increase/models/simulations/check_deposit_reject_params.rb +16 -0
  247. data/lib/increase/models/simulations/check_deposit_return_params.rb +16 -0
  248. data/lib/increase/models/simulations/check_deposit_submit_params.rb +16 -0
  249. data/lib/increase/models/simulations/check_transfer_mail_params.rb +16 -0
  250. data/lib/increase/models/simulations/digital_wallet_token_request_create_params.rb +24 -0
  251. data/lib/increase/models/simulations/digital_wallet_token_request_create_response.rb +83 -0
  252. data/lib/increase/models/simulations/document_create_params.rb +24 -0
  253. data/lib/increase/models/simulations/inbound_ach_transfer_create_params.rb +241 -0
  254. data/lib/increase/models/simulations/inbound_check_deposit_create_params.rb +40 -0
  255. data/lib/increase/models/simulations/inbound_funds_hold_release_params.rb +16 -0
  256. data/lib/increase/models/simulations/inbound_funds_hold_release_response.rb +161 -0
  257. data/lib/increase/models/simulations/inbound_mail_item_create_params.rb +44 -0
  258. data/lib/increase/models/simulations/inbound_real_time_payments_transfer_create_params.rb +77 -0
  259. data/lib/increase/models/simulations/inbound_wire_drawdown_request_create_params.rb +186 -0
  260. data/lib/increase/models/simulations/inbound_wire_transfer_create_params.rb +171 -0
  261. data/lib/increase/models/simulations/interest_payment_create_params.rb +59 -0
  262. data/lib/increase/models/simulations/physical_card_advance_shipment_params.rb +57 -0
  263. data/lib/increase/models/simulations/physical_card_tracking_updates_params.rb +81 -0
  264. data/lib/increase/models/simulations/program_create_params.rb +32 -0
  265. data/lib/increase/models/simulations/real_time_payments_transfer_complete_params.rb +113 -0
  266. data/lib/increase/models/simulations/wire_transfer_reverse_params.rb +16 -0
  267. data/lib/increase/models/simulations/wire_transfer_submit_params.rb +16 -0
  268. data/lib/increase/models/supplemental_document_create_params.rb +30 -0
  269. data/lib/increase/models/supplemental_document_list_params.rb +53 -0
  270. data/lib/increase/models/transaction.rb +5823 -0
  271. data/lib/increase/models/transaction_list_params.rb +226 -0
  272. data/lib/increase/models/transaction_retrieve_params.rb +14 -0
  273. data/lib/increase/models/wire_drawdown_request.rb +249 -0
  274. data/lib/increase/models/wire_drawdown_request_create_params.rb +129 -0
  275. data/lib/increase/models/wire_drawdown_request_list_params.rb +91 -0
  276. data/lib/increase/models/wire_drawdown_request_retrieve_params.rb +14 -0
  277. data/lib/increase/models/wire_transfer.rb +677 -0
  278. data/lib/increase/models/wire_transfer_approve_params.rb +14 -0
  279. data/lib/increase/models/wire_transfer_cancel_params.rb +14 -0
  280. data/lib/increase/models/wire_transfer_create_params.rb +151 -0
  281. data/lib/increase/models/wire_transfer_list_params.rb +110 -0
  282. data/lib/increase/models/wire_transfer_retrieve_params.rb +14 -0
  283. data/lib/increase/models.rb +483 -0
  284. data/lib/increase/request_options.rb +77 -0
  285. data/lib/increase/resources/account_numbers.rb +130 -13
  286. data/lib/increase/resources/account_statements.rb +60 -9
  287. data/lib/increase/resources/account_transfers.rb +135 -15
  288. data/lib/increase/resources/accounts.rb +168 -15
  289. data/lib/increase/resources/ach_prenotifications.rb +109 -11
  290. data/lib/increase/resources/ach_transfers.rb +167 -15
  291. data/lib/increase/resources/bookkeeping_accounts.rb +120 -0
  292. data/lib/increase/resources/bookkeeping_entries.rb +64 -0
  293. data/lib/increase/resources/bookkeeping_entry_sets.rb +95 -0
  294. data/lib/increase/resources/card_disputes.rb +91 -11
  295. data/lib/increase/resources/card_payments.rb +68 -0
  296. data/lib/increase/resources/card_purchase_supplements.rb +66 -0
  297. data/lib/increase/resources/cards.rb +146 -15
  298. data/lib/increase/resources/check_deposits.rb +95 -11
  299. data/lib/increase/resources/check_transfers.rb +167 -17
  300. data/lib/increase/resources/declined_transactions.rb +64 -9
  301. data/lib/increase/resources/digital_card_profiles.rb +164 -0
  302. data/lib/increase/resources/digital_wallet_tokens.rb +60 -9
  303. data/lib/increase/resources/documents.rb +89 -10
  304. data/lib/increase/resources/entities.rb +293 -14
  305. data/lib/increase/resources/event_subscriptions.rb +113 -13
  306. data/lib/increase/resources/events.rb +62 -9
  307. data/lib/increase/resources/exports.rb +109 -0
  308. data/lib/increase/resources/external_accounts.rb +125 -13
  309. data/lib/increase/resources/file_links.rb +41 -0
  310. data/lib/increase/resources/files.rb +94 -11
  311. data/lib/increase/resources/groups.rb +26 -7
  312. data/lib/increase/resources/inbound_ach_transfers.rb +154 -0
  313. data/lib/increase/resources/inbound_check_deposits.rb +112 -0
  314. data/lib/increase/resources/inbound_mail_items.rb +66 -0
  315. data/lib/increase/resources/inbound_real_time_payments_transfers.rb +68 -0
  316. data/lib/increase/resources/inbound_wire_drawdown_requests.rb +56 -9
  317. data/lib/increase/resources/inbound_wire_transfers.rb +94 -0
  318. data/lib/increase/resources/intrafi_account_enrollments.rb +112 -0
  319. data/lib/increase/resources/intrafi_balances.rb +36 -0
  320. data/lib/increase/resources/intrafi_exclusions.rb +113 -0
  321. data/lib/increase/resources/lockboxes.rb +122 -0
  322. data/lib/increase/resources/oauth_applications.rb +66 -0
  323. data/lib/increase/resources/oauth_connections.rb +60 -9
  324. data/lib/increase/resources/oauth_tokens.rb +47 -0
  325. data/lib/increase/resources/pending_transactions.rb +122 -10
  326. data/lib/increase/resources/physical_card_profiles.rb +156 -0
  327. data/lib/increase/resources/physical_cards.rb +123 -0
  328. data/lib/increase/resources/programs.rb +62 -0
  329. data/lib/increase/resources/real_time_decisions.rb +63 -9
  330. data/lib/increase/resources/real_time_payments_transfers.rb +157 -0
  331. data/lib/increase/resources/routing_numbers.rb +41 -7
  332. data/lib/increase/resources/simulations/account_statements.rb +39 -0
  333. data/lib/increase/resources/simulations/account_transfers.rb +39 -0
  334. data/lib/increase/resources/simulations/ach_transfers.rb +151 -0
  335. data/lib/increase/resources/simulations/card_authorization_expirations.rb +38 -0
  336. data/lib/increase/resources/simulations/card_authorizations.rb +79 -0
  337. data/lib/increase/resources/simulations/card_disputes.rb +45 -0
  338. data/lib/increase/resources/simulations/card_fuel_confirmations.rb +46 -0
  339. data/lib/increase/resources/simulations/card_increments.rb +46 -0
  340. data/lib/increase/resources/simulations/card_refunds.rb +42 -0
  341. data/lib/increase/resources/simulations/card_reversals.rb +46 -0
  342. data/lib/increase/resources/simulations/card_settlements.rb +49 -0
  343. data/lib/increase/resources/simulations/check_deposits.rb +80 -0
  344. data/lib/increase/resources/simulations/check_transfers.rb +39 -0
  345. data/lib/increase/resources/simulations/digital_wallet_token_requests.rb +39 -0
  346. data/lib/increase/resources/simulations/documents.rb +38 -0
  347. data/lib/increase/resources/simulations/inbound_ach_transfers.rb +73 -0
  348. data/lib/increase/resources/simulations/inbound_check_deposits.rb +47 -0
  349. data/lib/increase/resources/simulations/inbound_funds_holds.rb +37 -0
  350. data/lib/increase/resources/simulations/inbound_mail_items.rb +46 -0
  351. data/lib/increase/resources/simulations/inbound_real_time_payments_transfers.rb +56 -0
  352. data/lib/increase/resources/simulations/inbound_wire_drawdown_requests.rb +81 -0
  353. data/lib/increase/resources/simulations/inbound_wire_transfers.rb +74 -0
  354. data/lib/increase/resources/simulations/interest_payments.rb +50 -0
  355. data/lib/increase/resources/simulations/physical_cards.rb +79 -0
  356. data/lib/increase/resources/simulations/programs.rb +43 -0
  357. data/lib/increase/resources/simulations/real_time_payments_transfers.rb +43 -0
  358. data/lib/increase/resources/simulations/wire_transfers.rb +61 -0
  359. data/lib/increase/resources/simulations.rb +127 -0
  360. data/lib/increase/resources/supplemental_documents.rb +70 -0
  361. data/lib/increase/resources/transactions.rb +64 -9
  362. data/lib/increase/resources/wire_drawdown_requests.rb +109 -11
  363. data/lib/increase/resources/wire_transfers.rb +159 -15
  364. data/lib/increase/version.rb +1 -1
  365. data/lib/increase.rb +386 -22
  366. data/manifest.yaml +15 -0
  367. data/rbi/increase/client.rbi +221 -0
  368. data/rbi/increase/errors.rbi +206 -0
  369. data/rbi/increase/file_part.rbi +37 -0
  370. data/rbi/increase/internal/page.rbi +22 -0
  371. data/rbi/increase/internal/transport/base_client.rbi +293 -0
  372. data/rbi/increase/internal/transport/pooled_net_requester.rbi +79 -0
  373. data/rbi/increase/internal/type/array_of.rbi +104 -0
  374. data/rbi/increase/internal/type/base_model.rbi +302 -0
  375. data/rbi/increase/internal/type/base_page.rbi +42 -0
  376. data/rbi/increase/internal/type/boolean.rbi +56 -0
  377. data/rbi/increase/internal/type/converter.rbi +162 -0
  378. data/rbi/increase/internal/type/enum.rbi +82 -0
  379. data/rbi/increase/internal/type/file_input.rbi +59 -0
  380. data/rbi/increase/internal/type/hash_of.rbi +104 -0
  381. data/rbi/increase/internal/type/request_parameters.rbi +29 -0
  382. data/rbi/increase/internal/type/union.rbi +116 -0
  383. data/rbi/increase/internal/type/unknown.rbi +56 -0
  384. data/rbi/increase/internal/util.rbi +487 -0
  385. data/rbi/increase/internal.rbi +16 -0
  386. data/rbi/increase/models/account.rbi +269 -0
  387. data/rbi/increase/models/account_balance_params.rbi +43 -0
  388. data/rbi/increase/models/account_close_params.rbi +27 -0
  389. data/rbi/increase/models/account_create_params.rbi +80 -0
  390. data/rbi/increase/models/account_list_params.rbi +280 -0
  391. data/rbi/increase/models/account_number.rbi +348 -0
  392. data/rbi/increase/models/account_number_create_params.rbi +262 -0
  393. data/rbi/increase/models/account_number_list_params.rbi +396 -0
  394. data/rbi/increase/models/account_number_retrieve_params.rbi +30 -0
  395. data/rbi/increase/models/account_number_update_params.rbi +320 -0
  396. data/rbi/increase/models/account_retrieve_params.rbi +27 -0
  397. data/rbi/increase/models/account_statement.rbi +136 -0
  398. data/rbi/increase/models/account_statement_list_params.rbi +167 -0
  399. data/rbi/increase/models/account_statement_retrieve_params.rbi +30 -0
  400. data/rbi/increase/models/account_transfer.rbi +634 -0
  401. data/rbi/increase/models/account_transfer_approve_params.rbi +30 -0
  402. data/rbi/increase/models/account_transfer_cancel_params.rbi +30 -0
  403. data/rbi/increase/models/account_transfer_create_params.rbi +83 -0
  404. data/rbi/increase/models/account_transfer_list_params.rbi +177 -0
  405. data/rbi/increase/models/account_transfer_retrieve_params.rbi +30 -0
  406. data/rbi/increase/models/account_update_params.rbi +43 -0
  407. data/rbi/increase/models/ach_prenotification.rbi +1094 -0
  408. data/rbi/increase/models/ach_prenotification_create_params.rbi +294 -0
  409. data/rbi/increase/models/ach_prenotification_list_params.rbi +168 -0
  410. data/rbi/increase/models/ach_prenotification_retrieve_params.rbi +30 -0
  411. data/rbi/increase/models/ach_transfer.rbi +2672 -0
  412. data/rbi/increase/models/ach_transfer_approve_params.rbi +27 -0
  413. data/rbi/increase/models/ach_transfer_cancel_params.rbi +27 -0
  414. data/rbi/increase/models/ach_transfer_create_params.rbi +904 -0
  415. data/rbi/increase/models/ach_transfer_list_params.rbi +330 -0
  416. data/rbi/increase/models/ach_transfer_retrieve_params.rbi +30 -0
  417. data/rbi/increase/models/balance_lookup.rbi +90 -0
  418. data/rbi/increase/models/bookkeeping_account.rbi +165 -0
  419. data/rbi/increase/models/bookkeeping_account_balance_params.rbi +46 -0
  420. data/rbi/increase/models/bookkeeping_account_create_params.rbi +130 -0
  421. data/rbi/increase/models/bookkeeping_account_list_params.rbi +79 -0
  422. data/rbi/increase/models/bookkeeping_account_update_params.rbi +43 -0
  423. data/rbi/increase/models/bookkeeping_balance_lookup.rbi +85 -0
  424. data/rbi/increase/models/bookkeeping_entry.rbi +108 -0
  425. data/rbi/increase/models/bookkeeping_entry_list_params.rbi +73 -0
  426. data/rbi/increase/models/bookkeeping_entry_retrieve_params.rbi +30 -0
  427. data/rbi/increase/models/bookkeeping_entry_set.rbi +162 -0
  428. data/rbi/increase/models/bookkeeping_entry_set_create_params.rbi +110 -0
  429. data/rbi/increase/models/bookkeeping_entry_set_list_params.rbi +90 -0
  430. data/rbi/increase/models/bookkeeping_entry_set_retrieve_params.rbi +30 -0
  431. data/rbi/increase/models/card.rbi +317 -0
  432. data/rbi/increase/models/card_create_params.rbi +241 -0
  433. data/rbi/increase/models/card_details.rbi +103 -0
  434. data/rbi/increase/models/card_details_params.rbi +27 -0
  435. data/rbi/increase/models/card_dispute.rbi +425 -0
  436. data/rbi/increase/models/card_dispute_create_params.rbi +70 -0
  437. data/rbi/increase/models/card_dispute_list_params.rbi +289 -0
  438. data/rbi/increase/models/card_dispute_retrieve_params.rbi +30 -0
  439. data/rbi/increase/models/card_list_params.rbi +252 -0
  440. data/rbi/increase/models/card_payment.rbi +11956 -0
  441. data/rbi/increase/models/card_payment_list_params.rbi +168 -0
  442. data/rbi/increase/models/card_payment_retrieve_params.rbi +30 -0
  443. data/rbi/increase/models/card_purchase_supplement.rbi +687 -0
  444. data/rbi/increase/models/card_purchase_supplement_list_params.rbi +168 -0
  445. data/rbi/increase/models/card_purchase_supplement_retrieve_params.rbi +30 -0
  446. data/rbi/increase/models/card_retrieve_params.rbi +27 -0
  447. data/rbi/increase/models/card_update_params.rbi +267 -0
  448. data/rbi/increase/models/check_deposit.rbi +1393 -0
  449. data/rbi/increase/models/check_deposit_create_params.rbi +78 -0
  450. data/rbi/increase/models/check_deposit_list_params.rbi +174 -0
  451. data/rbi/increase/models/check_deposit_retrieve_params.rbi +30 -0
  452. data/rbi/increase/models/check_transfer.rbi +1670 -0
  453. data/rbi/increase/models/check_transfer_approve_params.rbi +30 -0
  454. data/rbi/increase/models/check_transfer_cancel_params.rbi +30 -0
  455. data/rbi/increase/models/check_transfer_create_params.rbi +573 -0
  456. data/rbi/increase/models/check_transfer_list_params.rbi +332 -0
  457. data/rbi/increase/models/check_transfer_retrieve_params.rbi +30 -0
  458. data/rbi/increase/models/check_transfer_stop_payment_params.rbi +99 -0
  459. data/rbi/increase/models/declined_transaction.rbi +3355 -0
  460. data/rbi/increase/models/declined_transaction_list_params.rbi +322 -0
  461. data/rbi/increase/models/declined_transaction_retrieve_params.rbi +30 -0
  462. data/rbi/increase/models/digital_card_profile.rbi +258 -0
  463. data/rbi/increase/models/digital_card_profile_archive_params.rbi +30 -0
  464. data/rbi/increase/models/digital_card_profile_clone_params.rbi +188 -0
  465. data/rbi/increase/models/digital_card_profile_create_params.rbi +174 -0
  466. data/rbi/increase/models/digital_card_profile_list_params.rbi +203 -0
  467. data/rbi/increase/models/digital_card_profile_retrieve_params.rbi +30 -0
  468. data/rbi/increase/models/digital_wallet_token.rbi +508 -0
  469. data/rbi/increase/models/digital_wallet_token_list_params.rbi +162 -0
  470. data/rbi/increase/models/digital_wallet_token_retrieve_params.rbi +30 -0
  471. data/rbi/increase/models/document.rbi +198 -0
  472. data/rbi/increase/models/document_create_params.rbi +132 -0
  473. data/rbi/increase/models/document_list_params.rbi +289 -0
  474. data/rbi/increase/models/document_retrieve_params.rbi +27 -0
  475. data/rbi/increase/models/entity.rbi +2531 -0
  476. data/rbi/increase/models/entity_archive_beneficial_owner_params.rbi +48 -0
  477. data/rbi/increase/models/entity_archive_params.rbi +27 -0
  478. data/rbi/increase/models/entity_confirm_params.rbi +45 -0
  479. data/rbi/increase/models/entity_create_beneficial_owner_params.rbi +764 -0
  480. data/rbi/increase/models/entity_create_params.rbi +4200 -0
  481. data/rbi/increase/models/entity_list_params.rbi +256 -0
  482. data/rbi/increase/models/entity_retrieve_params.rbi +27 -0
  483. data/rbi/increase/models/entity_supplemental_document.rbi +108 -0
  484. data/rbi/increase/models/entity_update_address_params.rbi +129 -0
  485. data/rbi/increase/models/entity_update_beneficial_owner_address_params.rbi +163 -0
  486. data/rbi/increase/models/entity_update_industry_code_params.rbi +49 -0
  487. data/rbi/increase/models/event.rbi +698 -0
  488. data/rbi/increase/models/event_list_params.rbi +862 -0
  489. data/rbi/increase/models/event_retrieve_params.rbi +27 -0
  490. data/rbi/increase/models/event_subscription.rbi +833 -0
  491. data/rbi/increase/models/event_subscription_create_params.rbi +753 -0
  492. data/rbi/increase/models/event_subscription_list_params.rbi +79 -0
  493. data/rbi/increase/models/event_subscription_retrieve_params.rbi +30 -0
  494. data/rbi/increase/models/event_subscription_update_params.rbi +99 -0
  495. data/rbi/increase/models/export.rbi +196 -0
  496. data/rbi/increase/models/export_create_params.rbi +933 -0
  497. data/rbi/increase/models/export_list_params.rbi +386 -0
  498. data/rbi/increase/models/export_retrieve_params.rbi +27 -0
  499. data/rbi/increase/models/external_account.rbi +236 -0
  500. data/rbi/increase/models/external_account_create_params.rbi +191 -0
  501. data/rbi/increase/models/external_account_list_params.rbi +198 -0
  502. data/rbi/increase/models/external_account_retrieve_params.rbi +30 -0
  503. data/rbi/increase/models/external_account_update_params.rbi +223 -0
  504. data/rbi/increase/models/file.rbi +291 -0
  505. data/rbi/increase/models/file_create_params.rbi +188 -0
  506. data/rbi/increase/models/file_link.rbi +115 -0
  507. data/rbi/increase/models/file_link_create_params.rbi +56 -0
  508. data/rbi/increase/models/file_list_params.rbi +410 -0
  509. data/rbi/increase/models/file_retrieve_params.rbi +27 -0
  510. data/rbi/increase/models/group.rbi +139 -0
  511. data/rbi/increase/models/group_retrieve_params.rbi +27 -0
  512. data/rbi/increase/models/inbound_ach_transfer.rbi +1898 -0
  513. data/rbi/increase/models/inbound_ach_transfer_create_notification_of_change_params.rbi +60 -0
  514. data/rbi/increase/models/inbound_ach_transfer_decline_params.rbi +154 -0
  515. data/rbi/increase/models/inbound_ach_transfer_list_params.rbi +297 -0
  516. data/rbi/increase/models/inbound_ach_transfer_retrieve_params.rbi +30 -0
  517. data/rbi/increase/models/inbound_ach_transfer_transfer_return_params.rbi +149 -0
  518. data/rbi/increase/models/inbound_check_deposit.rbi +609 -0
  519. data/rbi/increase/models/inbound_check_deposit_decline_params.rbi +30 -0
  520. data/rbi/increase/models/inbound_check_deposit_list_params.rbi +176 -0
  521. data/rbi/increase/models/inbound_check_deposit_retrieve_params.rbi +30 -0
  522. data/rbi/increase/models/inbound_check_deposit_return_params.rbi +104 -0
  523. data/rbi/increase/models/inbound_mail_item.rbi +201 -0
  524. data/rbi/increase/models/inbound_mail_item_list_params.rbi +160 -0
  525. data/rbi/increase/models/inbound_mail_item_retrieve_params.rbi +30 -0
  526. data/rbi/increase/models/inbound_real_time_payments_transfer.rbi +516 -0
  527. data/rbi/increase/models/inbound_real_time_payments_transfer_list_params.rbi +184 -0
  528. data/rbi/increase/models/inbound_real_time_payments_transfer_retrieve_params.rbi +30 -0
  529. data/rbi/increase/models/inbound_wire_drawdown_request.rbi +261 -0
  530. data/rbi/increase/models/inbound_wire_drawdown_request_list_params.rbi +62 -0
  531. data/rbi/increase/models/inbound_wire_drawdown_request_retrieve_params.rbi +30 -0
  532. data/rbi/increase/models/inbound_wire_transfer.rbi +400 -0
  533. data/rbi/increase/models/inbound_wire_transfer_list_params.rbi +300 -0
  534. data/rbi/increase/models/inbound_wire_transfer_retrieve_params.rbi +30 -0
  535. data/rbi/increase/models/inbound_wire_transfer_reverse_params.rbi +84 -0
  536. data/rbi/increase/models/intrafi_account_enrollment.rbi +185 -0
  537. data/rbi/increase/models/intrafi_account_enrollment_create_params.rbi +54 -0
  538. data/rbi/increase/models/intrafi_account_enrollment_list_params.rbi +226 -0
  539. data/rbi/increase/models/intrafi_account_enrollment_retrieve_params.rbi +30 -0
  540. data/rbi/increase/models/intrafi_account_enrollment_unenroll_params.rbi +30 -0
  541. data/rbi/increase/models/intrafi_balance.rbi +262 -0
  542. data/rbi/increase/models/intrafi_balance_intrafi_balance_params.rbi +30 -0
  543. data/rbi/increase/models/intrafi_exclusion.rbi +176 -0
  544. data/rbi/increase/models/intrafi_exclusion_archive_params.rbi +30 -0
  545. data/rbi/increase/models/intrafi_exclusion_create_params.rbi +54 -0
  546. data/rbi/increase/models/intrafi_exclusion_list_params.rbi +90 -0
  547. data/rbi/increase/models/intrafi_exclusion_retrieve_params.rbi +30 -0
  548. data/rbi/increase/models/lockbox.rbi +232 -0
  549. data/rbi/increase/models/lockbox_create_params.rbi +65 -0
  550. data/rbi/increase/models/lockbox_list_params.rbi +172 -0
  551. data/rbi/increase/models/lockbox_retrieve_params.rbi +27 -0
  552. data/rbi/increase/models/lockbox_update_params.rbi +97 -0
  553. data/rbi/increase/models/oauth_application.rbi +146 -0
  554. data/rbi/increase/models/oauth_application_list_params.rbi +259 -0
  555. data/rbi/increase/models/oauth_application_retrieve_params.rbi +30 -0
  556. data/rbi/increase/models/oauth_connection.rbi +142 -0
  557. data/rbi/increase/models/oauth_connection_list_params.rbi +183 -0
  558. data/rbi/increase/models/oauth_connection_retrieve_params.rbi +30 -0
  559. data/rbi/increase/models/oauth_token.rbi +98 -0
  560. data/rbi/increase/models/oauth_token_create_params.rbi +133 -0
  561. data/rbi/increase/models/pending_transaction.rbi +3220 -0
  562. data/rbi/increase/models/pending_transaction_create_params.rbi +69 -0
  563. data/rbi/increase/models/pending_transaction_list_params.rbi +475 -0
  564. data/rbi/increase/models/pending_transaction_release_params.rbi +30 -0
  565. data/rbi/increase/models/pending_transaction_retrieve_params.rbi +30 -0
  566. data/rbi/increase/models/physical_card.rbi +691 -0
  567. data/rbi/increase/models/physical_card_create_params.rbi +327 -0
  568. data/rbi/increase/models/physical_card_list_params.rbi +174 -0
  569. data/rbi/increase/models/physical_card_profile.rbi +245 -0
  570. data/rbi/increase/models/physical_card_profile_archive_params.rbi +30 -0
  571. data/rbi/increase/models/physical_card_profile_clone_params.rbi +143 -0
  572. data/rbi/increase/models/physical_card_profile_create_params.rbi +139 -0
  573. data/rbi/increase/models/physical_card_profile_list_params.rbi +219 -0
  574. data/rbi/increase/models/physical_card_profile_retrieve_params.rbi +30 -0
  575. data/rbi/increase/models/physical_card_retrieve_params.rbi +30 -0
  576. data/rbi/increase/models/physical_card_update_params.rbi +83 -0
  577. data/rbi/increase/models/program.rbi +155 -0
  578. data/rbi/increase/models/program_list_params.rbi +59 -0
  579. data/rbi/increase/models/program_retrieve_params.rbi +27 -0
  580. data/rbi/increase/models/real_time_decision.rbi +2466 -0
  581. data/rbi/increase/models/real_time_decision_action_params.rbi +806 -0
  582. data/rbi/increase/models/real_time_decision_retrieve_params.rbi +30 -0
  583. data/rbi/increase/models/real_time_payments_transfer.rbi +1151 -0
  584. data/rbi/increase/models/real_time_payments_transfer_approve_params.rbi +30 -0
  585. data/rbi/increase/models/real_time_payments_transfer_cancel_params.rbi +30 -0
  586. data/rbi/increase/models/real_time_payments_transfer_create_params.rbi +161 -0
  587. data/rbi/increase/models/real_time_payments_transfer_list_params.rbi +351 -0
  588. data/rbi/increase/models/real_time_payments_transfer_retrieve_params.rbi +30 -0
  589. data/rbi/increase/models/routing_number_list_params.rbi +67 -0
  590. data/rbi/increase/models/routing_number_list_response.rbi +246 -0
  591. data/rbi/increase/models/simulations/account_statement_create_params.rbi +45 -0
  592. data/rbi/increase/models/simulations/account_transfer_complete_params.rbi +32 -0
  593. data/rbi/increase/models/simulations/ach_transfer_acknowledge_params.rbi +32 -0
  594. data/rbi/increase/models/simulations/ach_transfer_create_notification_of_change_params.rbi +219 -0
  595. data/rbi/increase/models/simulations/ach_transfer_return_params.rbi +581 -0
  596. data/rbi/increase/models/simulations/ach_transfer_settle_params.rbi +32 -0
  597. data/rbi/increase/models/simulations/ach_transfer_submit_params.rbi +32 -0
  598. data/rbi/increase/models/simulations/card_authorization_create_params.rbi +648 -0
  599. data/rbi/increase/models/simulations/card_authorization_create_response.rbi +123 -0
  600. data/rbi/increase/models/simulations/card_authorization_expiration_create_params.rbi +48 -0
  601. data/rbi/increase/models/simulations/card_dispute_action_params.rbi +124 -0
  602. data/rbi/increase/models/simulations/card_fuel_confirmation_create_params.rbi +58 -0
  603. data/rbi/increase/models/simulations/card_increment_create_params.rbi +73 -0
  604. data/rbi/increase/models/simulations/card_refund_create_params.rbi +50 -0
  605. data/rbi/increase/models/simulations/card_reversal_create_params.rbi +61 -0
  606. data/rbi/increase/models/simulations/card_settlement_create_params.rbi +71 -0
  607. data/rbi/increase/models/simulations/check_deposit_reject_params.rbi +32 -0
  608. data/rbi/increase/models/simulations/check_deposit_return_params.rbi +32 -0
  609. data/rbi/increase/models/simulations/check_deposit_submit_params.rbi +32 -0
  610. data/rbi/increase/models/simulations/check_transfer_mail_params.rbi +32 -0
  611. data/rbi/increase/models/simulations/digital_wallet_token_request_create_params.rbi +45 -0
  612. data/rbi/increase/models/simulations/digital_wallet_token_request_create_response.rbi +167 -0
  613. data/rbi/increase/models/simulations/document_create_params.rbi +45 -0
  614. data/rbi/increase/models/simulations/inbound_ach_transfer_create_params.rbi +508 -0
  615. data/rbi/increase/models/simulations/inbound_check_deposit_create_params.rbi +64 -0
  616. data/rbi/increase/models/simulations/inbound_funds_hold_release_params.rbi +32 -0
  617. data/rbi/increase/models/simulations/inbound_funds_hold_release_response.rbi +280 -0
  618. data/rbi/increase/models/simulations/inbound_mail_item_create_params.rbi +69 -0
  619. data/rbi/increase/models/simulations/inbound_real_time_payments_transfer_create_params.rbi +113 -0
  620. data/rbi/increase/models/simulations/inbound_wire_drawdown_request_create_params.rbi +248 -0
  621. data/rbi/increase/models/simulations/inbound_wire_transfer_create_params.rbi +251 -0
  622. data/rbi/increase/models/simulations/interest_payment_create_params.rbi +89 -0
  623. data/rbi/increase/models/simulations/physical_card_advance_shipment_params.rbi +134 -0
  624. data/rbi/increase/models/simulations/physical_card_tracking_updates_params.rbi +152 -0
  625. data/rbi/increase/models/simulations/program_create_params.rbi +59 -0
  626. data/rbi/increase/models/simulations/real_time_payments_transfer_complete_params.rbi +277 -0
  627. data/rbi/increase/models/simulations/wire_transfer_reverse_params.rbi +32 -0
  628. data/rbi/increase/models/simulations/wire_transfer_submit_params.rbi +32 -0
  629. data/rbi/increase/models/supplemental_document_create_params.rbi +54 -0
  630. data/rbi/increase/models/supplemental_document_list_params.rbi +87 -0
  631. data/rbi/increase/models/transaction.rbi +10456 -0
  632. data/rbi/increase/models/transaction_list_params.rbi +473 -0
  633. data/rbi/increase/models/transaction_retrieve_params.rbi +30 -0
  634. data/rbi/increase/models/wire_drawdown_request.rbi +324 -0
  635. data/rbi/increase/models/wire_drawdown_request_create_params.rbi +179 -0
  636. data/rbi/increase/models/wire_drawdown_request_list_params.rbi +205 -0
  637. data/rbi/increase/models/wire_drawdown_request_retrieve_params.rbi +30 -0
  638. data/rbi/increase/models/wire_transfer.rbi +974 -0
  639. data/rbi/increase/models/wire_transfer_approve_params.rbi +30 -0
  640. data/rbi/increase/models/wire_transfer_cancel_params.rbi +27 -0
  641. data/rbi/increase/models/wire_transfer_create_params.rbi +211 -0
  642. data/rbi/increase/models/wire_transfer_list_params.rbi +185 -0
  643. data/rbi/increase/models/wire_transfer_retrieve_params.rbi +30 -0
  644. data/rbi/increase/models.rbi +517 -0
  645. data/rbi/increase/request_options.rbi +59 -0
  646. data/rbi/increase/resources/account_numbers.rbi +113 -0
  647. data/rbi/increase/resources/account_statements.rbi +50 -0
  648. data/rbi/increase/resources/account_transfers.rbi +110 -0
  649. data/rbi/increase/resources/accounts.rbi +137 -0
  650. data/rbi/increase/resources/ach_prenotifications.rbi +107 -0
  651. data/rbi/increase/resources/ach_transfers.rbi +179 -0
  652. data/rbi/increase/resources/bookkeeping_accounts.rbi +94 -0
  653. data/rbi/increase/resources/bookkeeping_entries.rbi +47 -0
  654. data/rbi/increase/resources/bookkeeping_entry_sets.rbi +75 -0
  655. data/rbi/increase/resources/card_disputes.rbi +78 -0
  656. data/rbi/increase/resources/card_payments.rbi +52 -0
  657. data/rbi/increase/resources/card_purchase_supplements.rbi +51 -0
  658. data/rbi/increase/resources/cards.rbi +134 -0
  659. data/rbi/increase/resources/check_deposits.rbi +81 -0
  660. data/rbi/increase/resources/check_transfers.rbi +146 -0
  661. data/rbi/increase/resources/declined_transactions.rbi +55 -0
  662. data/rbi/increase/resources/digital_card_profiles.rbi +147 -0
  663. data/rbi/increase/resources/digital_wallet_tokens.rbi +49 -0
  664. data/rbi/increase/resources/documents.rbi +75 -0
  665. data/rbi/increase/resources/entities.rbi +241 -0
  666. data/rbi/increase/resources/event_subscriptions.rbi +94 -0
  667. data/rbi/increase/resources/events.rbi +51 -0
  668. data/rbi/increase/resources/exports.rbi +94 -0
  669. data/rbi/increase/resources/external_accounts.rbi +110 -0
  670. data/rbi/increase/resources/file_links.rbi +30 -0
  671. data/rbi/increase/resources/files.rbi +78 -0
  672. data/rbi/increase/resources/groups.rbi +21 -0
  673. data/rbi/increase/resources/inbound_ach_transfers.rbi +114 -0
  674. data/rbi/increase/resources/inbound_check_deposits.rbi +85 -0
  675. data/rbi/increase/resources/inbound_mail_items.rbi +49 -0
  676. data/rbi/increase/resources/inbound_real_time_payments_transfers.rbi +57 -0
  677. data/rbi/increase/resources/inbound_wire_drawdown_requests.rbi +46 -0
  678. data/rbi/increase/resources/inbound_wire_transfers.rbi +72 -0
  679. data/rbi/increase/resources/intrafi_account_enrollments.rbi +86 -0
  680. data/rbi/increase/resources/intrafi_balances.rbi +28 -0
  681. data/rbi/increase/resources/intrafi_exclusions.rbi +86 -0
  682. data/rbi/increase/resources/lockboxes.rbi +98 -0
  683. data/rbi/increase/resources/oauth_applications.rbi +48 -0
  684. data/rbi/increase/resources/oauth_connections.rbi +50 -0
  685. data/rbi/increase/resources/oauth_tokens.rbi +44 -0
  686. data/rbi/increase/resources/pending_transactions.rbi +98 -0
  687. data/rbi/increase/resources/physical_card_profiles.rbi +128 -0
  688. data/rbi/increase/resources/physical_cards.rbi +96 -0
  689. data/rbi/increase/resources/programs.rbi +44 -0
  690. data/rbi/increase/resources/real_time_decisions.rbi +65 -0
  691. data/rbi/increase/resources/real_time_payments_transfers.rbi +141 -0
  692. data/rbi/increase/resources/routing_numbers.rbi +38 -0
  693. data/rbi/increase/resources/simulations/account_statements.rbi +29 -0
  694. data/rbi/increase/resources/simulations/account_transfers.rbi +31 -0
  695. data/rbi/increase/resources/simulations/ach_transfers.rbi +115 -0
  696. data/rbi/increase/resources/simulations/card_authorization_expirations.rbi +28 -0
  697. data/rbi/increase/resources/simulations/card_authorizations.rbi +97 -0
  698. data/rbi/increase/resources/simulations/card_disputes.rbi +38 -0
  699. data/rbi/increase/resources/simulations/card_fuel_confirmations.rbi +34 -0
  700. data/rbi/increase/resources/simulations/card_increments.rbi +38 -0
  701. data/rbi/increase/resources/simulations/card_refunds.rbi +30 -0
  702. data/rbi/increase/resources/simulations/card_reversals.rbi +35 -0
  703. data/rbi/increase/resources/simulations/card_settlements.rbi +40 -0
  704. data/rbi/increase/resources/simulations/check_deposits.rbi +60 -0
  705. data/rbi/increase/resources/simulations/check_transfers.rbi +31 -0
  706. data/rbi/increase/resources/simulations/digital_wallet_token_requests.rbi +31 -0
  707. data/rbi/increase/resources/simulations/documents.rbi +28 -0
  708. data/rbi/increase/resources/simulations/inbound_ach_transfers.rbi +75 -0
  709. data/rbi/increase/resources/simulations/inbound_check_deposits.rbi +39 -0
  710. data/rbi/increase/resources/simulations/inbound_funds_holds.rbi +31 -0
  711. data/rbi/increase/resources/simulations/inbound_mail_items.rbi +36 -0
  712. data/rbi/increase/resources/simulations/inbound_real_time_payments_transfers.rbi +49 -0
  713. data/rbi/increase/resources/simulations/inbound_wire_drawdown_requests.rbi +92 -0
  714. data/rbi/increase/resources/simulations/inbound_wire_transfers.rbi +91 -0
  715. data/rbi/increase/resources/simulations/interest_payments.rbi +41 -0
  716. data/rbi/increase/resources/simulations/physical_cards.rbi +66 -0
  717. data/rbi/increase/resources/simulations/programs.rbi +34 -0
  718. data/rbi/increase/resources/simulations/real_time_payments_transfers.rbi +35 -0
  719. data/rbi/increase/resources/simulations/wire_transfers.rbi +47 -0
  720. data/rbi/increase/resources/simulations.rbi +105 -0
  721. data/rbi/increase/resources/supplemental_documents.rbi +58 -0
  722. data/rbi/increase/resources/transactions.rbi +55 -0
  723. data/rbi/increase/resources/wire_drawdown_requests.rbi +110 -0
  724. data/rbi/increase/resources/wire_transfers.rbi +151 -0
  725. data/rbi/increase/version.rbi +5 -0
  726. data/sig/increase/client.rbs +135 -0
  727. data/sig/increase/errors.rbs +145 -0
  728. data/sig/increase/file_part.rbs +21 -0
  729. data/sig/increase/internal/page.rbs +13 -0
  730. data/sig/increase/internal/transport/base_client.rbs +131 -0
  731. data/sig/increase/internal/transport/pooled_net_requester.rbs +45 -0
  732. data/sig/increase/internal/type/array_of.rbs +48 -0
  733. data/sig/increase/internal/type/base_model.rbs +102 -0
  734. data/sig/increase/internal/type/base_page.rbs +24 -0
  735. data/sig/increase/internal/type/boolean.rbs +26 -0
  736. data/sig/increase/internal/type/converter.rbs +56 -0
  737. data/sig/increase/internal/type/enum.rbs +32 -0
  738. data/sig/increase/internal/type/file_input.rbs +25 -0
  739. data/sig/increase/internal/type/hash_of.rbs +48 -0
  740. data/sig/increase/internal/type/request_parameters.rbs +17 -0
  741. data/sig/increase/internal/type/union.rbs +52 -0
  742. data/sig/increase/internal/type/unknown.rbs +26 -0
  743. data/sig/increase/internal/util.rbs +185 -0
  744. data/sig/increase/internal.rbs +9 -0
  745. data/sig/increase/models/account.rbs +157 -0
  746. data/sig/increase/models/account_balance_params.rbs +25 -0
  747. data/sig/increase/models/account_close_params.rbs +15 -0
  748. data/sig/increase/models/account_create_params.rbs +47 -0
  749. data/sig/increase/models/account_list_params.rbs +149 -0
  750. data/sig/increase/models/account_number.rbs +157 -0
  751. data/sig/increase/models/account_number_create_params.rbs +111 -0
  752. data/sig/increase/models/account_number_list_params.rbs +182 -0
  753. data/sig/increase/models/account_number_retrieve_params.rbs +15 -0
  754. data/sig/increase/models/account_number_update_params.rbs +138 -0
  755. data/sig/increase/models/account_retrieve_params.rbs +15 -0
  756. data/sig/increase/models/account_statement.rbs +70 -0
  757. data/sig/increase/models/account_statement_list_params.rbs +86 -0
  758. data/sig/increase/models/account_statement_retrieve_params.rbs +15 -0
  759. data/sig/increase/models/account_transfer.rbs +266 -0
  760. data/sig/increase/models/account_transfer_approve_params.rbs +15 -0
  761. data/sig/increase/models/account_transfer_cancel_params.rbs +15 -0
  762. data/sig/increase/models/account_transfer_create_params.rbs +48 -0
  763. data/sig/increase/models/account_transfer_list_params.rbs +93 -0
  764. data/sig/increase/models/account_transfer_retrieve_params.rbs +15 -0
  765. data/sig/increase/models/account_update_params.rbs +25 -0
  766. data/sig/increase/models/ach_prenotification.rbs +561 -0
  767. data/sig/increase/models/ach_prenotification_create_params.rbs +148 -0
  768. data/sig/increase/models/ach_prenotification_list_params.rbs +86 -0
  769. data/sig/increase/models/ach_prenotification_retrieve_params.rbs +15 -0
  770. data/sig/increase/models/ach_transfer.rbs +1207 -0
  771. data/sig/increase/models/ach_transfer_approve_params.rbs +15 -0
  772. data/sig/increase/models/ach_transfer_cancel_params.rbs +15 -0
  773. data/sig/increase/models/ach_transfer_create_params.rbs +379 -0
  774. data/sig/increase/models/ach_transfer_list_params.rbs +172 -0
  775. data/sig/increase/models/ach_transfer_retrieve_params.rbs +15 -0
  776. data/sig/increase/models/balance_lookup.rbs +45 -0
  777. data/sig/increase/models/bookkeeping_account.rbs +74 -0
  778. data/sig/increase/models/bookkeeping_account_balance_params.rbs +25 -0
  779. data/sig/increase/models/bookkeeping_account_create_params.rbs +63 -0
  780. data/sig/increase/models/bookkeeping_account_list_params.rbs +38 -0
  781. data/sig/increase/models/bookkeeping_account_update_params.rbs +23 -0
  782. data/sig/increase/models/bookkeeping_balance_lookup.rbs +40 -0
  783. data/sig/increase/models/bookkeeping_entry.rbs +55 -0
  784. data/sig/increase/models/bookkeeping_entry_list_params.rbs +38 -0
  785. data/sig/increase/models/bookkeeping_entry_retrieve_params.rbs +15 -0
  786. data/sig/increase/models/bookkeeping_entry_set.rbs +78 -0
  787. data/sig/increase/models/bookkeeping_entry_set_create_params.rbs +52 -0
  788. data/sig/increase/models/bookkeeping_entry_set_list_params.rbs +49 -0
  789. data/sig/increase/models/bookkeeping_entry_set_retrieve_params.rbs +15 -0
  790. data/sig/increase/models/card.rbs +167 -0
  791. data/sig/increase/models/card_create_params.rbs +126 -0
  792. data/sig/increase/models/card_details.rbs +55 -0
  793. data/sig/increase/models/card_details_params.rbs +15 -0
  794. data/sig/increase/models/card_dispute.rbs +207 -0
  795. data/sig/increase/models/card_dispute_create_params.rbs +34 -0
  796. data/sig/increase/models/card_dispute_list_params.rbs +146 -0
  797. data/sig/increase/models/card_dispute_retrieve_params.rbs +15 -0
  798. data/sig/increase/models/card_list_params.rbs +138 -0
  799. data/sig/increase/models/card_payment.rbs +4955 -0
  800. data/sig/increase/models/card_payment_list_params.rbs +93 -0
  801. data/sig/increase/models/card_payment_retrieve_params.rbs +15 -0
  802. data/sig/increase/models/card_purchase_supplement.rbs +329 -0
  803. data/sig/increase/models/card_purchase_supplement_list_params.rbs +86 -0
  804. data/sig/increase/models/card_purchase_supplement_retrieve_params.rbs +15 -0
  805. data/sig/increase/models/card_retrieve_params.rbs +15 -0
  806. data/sig/increase/models/card_update_params.rbs +147 -0
  807. data/sig/increase/models/check_deposit.rbs +643 -0
  808. data/sig/increase/models/check_deposit_create_params.rbs +48 -0
  809. data/sig/increase/models/check_deposit_list_params.rbs +93 -0
  810. data/sig/increase/models/check_deposit_retrieve_params.rbs +15 -0
  811. data/sig/increase/models/check_transfer.rbs +729 -0
  812. data/sig/increase/models/check_transfer_approve_params.rbs +15 -0
  813. data/sig/increase/models/check_transfer_cancel_params.rbs +15 -0
  814. data/sig/increase/models/check_transfer_create_params.rbs +262 -0
  815. data/sig/increase/models/check_transfer_list_params.rbs +169 -0
  816. data/sig/increase/models/check_transfer_retrieve_params.rbs +15 -0
  817. data/sig/increase/models/check_transfer_stop_payment_params.rbs +45 -0
  818. data/sig/increase/models/declined_transaction.rbs +1469 -0
  819. data/sig/increase/models/declined_transaction_list_params.rbs +159 -0
  820. data/sig/increase/models/declined_transaction_retrieve_params.rbs +15 -0
  821. data/sig/increase/models/digital_card_profile.rbs +129 -0
  822. data/sig/increase/models/digital_card_profile_archive_params.rbs +15 -0
  823. data/sig/increase/models/digital_card_profile_clone_params.rbs +100 -0
  824. data/sig/increase/models/digital_card_profile_create_params.rbs +90 -0
  825. data/sig/increase/models/digital_card_profile_list_params.rbs +92 -0
  826. data/sig/increase/models/digital_card_profile_retrieve_params.rbs +15 -0
  827. data/sig/increase/models/digital_wallet_token.rbs +238 -0
  828. data/sig/increase/models/digital_wallet_token_list_params.rbs +86 -0
  829. data/sig/increase/models/digital_wallet_token_retrieve_params.rbs +15 -0
  830. data/sig/increase/models/document.rbs +103 -0
  831. data/sig/increase/models/document_create_params.rbs +61 -0
  832. data/sig/increase/models/document_list_params.rbs +149 -0
  833. data/sig/increase/models/document_retrieve_params.rbs +15 -0
  834. data/sig/increase/models/entity.rbs +1170 -0
  835. data/sig/increase/models/entity_archive_beneficial_owner_params.rbs +24 -0
  836. data/sig/increase/models/entity_archive_params.rbs +15 -0
  837. data/sig/increase/models/entity_confirm_params.rbs +25 -0
  838. data/sig/increase/models/entity_create_beneficial_owner_params.rbs +333 -0
  839. data/sig/increase/models/entity_create_params.rbs +1889 -0
  840. data/sig/increase/models/entity_list_params.rbs +131 -0
  841. data/sig/increase/models/entity_retrieve_params.rbs +15 -0
  842. data/sig/increase/models/entity_supplemental_document.rbs +50 -0
  843. data/sig/increase/models/entity_update_address_params.rbs +63 -0
  844. data/sig/increase/models/entity_update_beneficial_owner_address_params.rbs +81 -0
  845. data/sig/increase/models/entity_update_industry_code_params.rbs +23 -0
  846. data/sig/increase/models/event.rbs +423 -0
  847. data/sig/increase/models/event_list_params.rbs +482 -0
  848. data/sig/increase/models/event_retrieve_params.rbs +15 -0
  849. data/sig/increase/models/event_subscription.rbs +453 -0
  850. data/sig/increase/models/event_subscription_create_params.rbs +417 -0
  851. data/sig/increase/models/event_subscription_list_params.rbs +38 -0
  852. data/sig/increase/models/event_subscription_retrieve_params.rbs +15 -0
  853. data/sig/increase/models/event_subscription_update_params.rbs +45 -0
  854. data/sig/increase/models/export.rbs +118 -0
  855. data/sig/increase/models/export_create_params.rbs +427 -0
  856. data/sig/increase/models/export_list_params.rbs +195 -0
  857. data/sig/increase/models/export_retrieve_params.rbs +15 -0
  858. data/sig/increase/models/external_account.rbs +123 -0
  859. data/sig/increase/models/external_account_create_params.rbs +88 -0
  860. data/sig/increase/models/external_account_list_params.rbs +93 -0
  861. data/sig/increase/models/external_account_retrieve_params.rbs +15 -0
  862. data/sig/increase/models/external_account_update_params.rbs +100 -0
  863. data/sig/increase/models/file.rbs +196 -0
  864. data/sig/increase/models/file_create_params.rbs +110 -0
  865. data/sig/increase/models/file_link.rbs +60 -0
  866. data/sig/increase/models/file_link_create_params.rbs +30 -0
  867. data/sig/increase/models/file_list_params.rbs +226 -0
  868. data/sig/increase/models/file_retrieve_params.rbs +15 -0
  869. data/sig/increase/models/group.rbs +78 -0
  870. data/sig/increase/models/group_retrieve_params.rbs +15 -0
  871. data/sig/increase/models/inbound_ach_transfer.rbs +886 -0
  872. data/sig/increase/models/inbound_ach_transfer_create_notification_of_change_params.rbs +32 -0
  873. data/sig/increase/models/inbound_ach_transfer_decline_params.rbs +76 -0
  874. data/sig/increase/models/inbound_ach_transfer_list_params.rbs +143 -0
  875. data/sig/increase/models/inbound_ach_transfer_retrieve_params.rbs +15 -0
  876. data/sig/increase/models/inbound_ach_transfer_transfer_return_params.rbs +74 -0
  877. data/sig/increase/models/inbound_check_deposit.rbs +304 -0
  878. data/sig/increase/models/inbound_check_deposit_decline_params.rbs +15 -0
  879. data/sig/increase/models/inbound_check_deposit_list_params.rbs +93 -0
  880. data/sig/increase/models/inbound_check_deposit_retrieve_params.rbs +15 -0
  881. data/sig/increase/models/inbound_check_deposit_return_params.rbs +52 -0
  882. data/sig/increase/models/inbound_mail_item.rbs +100 -0
  883. data/sig/increase/models/inbound_mail_item_list_params.rbs +86 -0
  884. data/sig/increase/models/inbound_mail_item_retrieve_params.rbs +15 -0
  885. data/sig/increase/models/inbound_real_time_payments_transfer.rbs +222 -0
  886. data/sig/increase/models/inbound_real_time_payments_transfer_list_params.rbs +93 -0
  887. data/sig/increase/models/inbound_real_time_payments_transfer_retrieve_params.rbs +15 -0
  888. data/sig/increase/models/inbound_wire_drawdown_request.rbs +140 -0
  889. data/sig/increase/models/inbound_wire_drawdown_request_list_params.rbs +32 -0
  890. data/sig/increase/models/inbound_wire_drawdown_request_retrieve_params.rbs +15 -0
  891. data/sig/increase/models/inbound_wire_transfer.rbs +211 -0
  892. data/sig/increase/models/inbound_wire_transfer_list_params.rbs +143 -0
  893. data/sig/increase/models/inbound_wire_transfer_retrieve_params.rbs +15 -0
  894. data/sig/increase/models/inbound_wire_transfer_reverse_params.rbs +38 -0
  895. data/sig/increase/models/intrafi_account_enrollment.rbs +88 -0
  896. data/sig/increase/models/intrafi_account_enrollment_create_params.rbs +28 -0
  897. data/sig/increase/models/intrafi_account_enrollment_list_params.rbs +107 -0
  898. data/sig/increase/models/intrafi_account_enrollment_retrieve_params.rbs +15 -0
  899. data/sig/increase/models/intrafi_account_enrollment_unenroll_params.rbs +15 -0
  900. data/sig/increase/models/intrafi_balance.rbs +130 -0
  901. data/sig/increase/models/intrafi_balance_intrafi_balance_params.rbs +15 -0
  902. data/sig/increase/models/intrafi_exclusion.rbs +92 -0
  903. data/sig/increase/models/intrafi_exclusion_archive_params.rbs +15 -0
  904. data/sig/increase/models/intrafi_exclusion_create_params.rbs +28 -0
  905. data/sig/increase/models/intrafi_exclusion_list_params.rbs +49 -0
  906. data/sig/increase/models/intrafi_exclusion_retrieve_params.rbs +15 -0
  907. data/sig/increase/models/lockbox.rbs +126 -0
  908. data/sig/increase/models/lockbox_create_params.rbs +36 -0
  909. data/sig/increase/models/lockbox_list_params.rbs +93 -0
  910. data/sig/increase/models/lockbox_retrieve_params.rbs +15 -0
  911. data/sig/increase/models/lockbox_update_params.rbs +58 -0
  912. data/sig/increase/models/oauth_application.rbs +74 -0
  913. data/sig/increase/models/oauth_application_list_params.rbs +123 -0
  914. data/sig/increase/models/oauth_application_retrieve_params.rbs +15 -0
  915. data/sig/increase/models/oauth_connection.rbs +74 -0
  916. data/sig/increase/models/oauth_connection_list_params.rbs +86 -0
  917. data/sig/increase/models/oauth_connection_retrieve_params.rbs +15 -0
  918. data/sig/increase/models/oauth_token.rbs +50 -0
  919. data/sig/increase/models/oauth_token_create_params.rbs +68 -0
  920. data/sig/increase/models/pending_transaction.rbs +1266 -0
  921. data/sig/increase/models/pending_transaction_create_params.rbs +34 -0
  922. data/sig/increase/models/pending_transaction_list_params.rbs +227 -0
  923. data/sig/increase/models/pending_transaction_release_params.rbs +15 -0
  924. data/sig/increase/models/pending_transaction_retrieve_params.rbs +15 -0
  925. data/sig/increase/models/physical_card.rbs +338 -0
  926. data/sig/increase/models/physical_card_create_params.rbs +152 -0
  927. data/sig/increase/models/physical_card_list_params.rbs +93 -0
  928. data/sig/increase/models/physical_card_profile.rbs +136 -0
  929. data/sig/increase/models/physical_card_profile_archive_params.rbs +15 -0
  930. data/sig/increase/models/physical_card_profile_clone_params.rbs +72 -0
  931. data/sig/increase/models/physical_card_profile_create_params.rbs +69 -0
  932. data/sig/increase/models/physical_card_profile_list_params.rbs +104 -0
  933. data/sig/increase/models/physical_card_profile_retrieve_params.rbs +15 -0
  934. data/sig/increase/models/physical_card_retrieve_params.rbs +15 -0
  935. data/sig/increase/models/physical_card_update_params.rbs +41 -0
  936. data/sig/increase/models/program.rbs +87 -0
  937. data/sig/increase/models/program_list_params.rbs +32 -0
  938. data/sig/increase/models/program_retrieve_params.rbs +15 -0
  939. data/sig/increase/models/real_time_decision.rbs +998 -0
  940. data/sig/increase/models/real_time_decision_action_params.rbs +317 -0
  941. data/sig/increase/models/real_time_decision_retrieve_params.rbs +15 -0
  942. data/sig/increase/models/real_time_payments_transfer.rbs +467 -0
  943. data/sig/increase/models/real_time_payments_transfer_approve_params.rbs +15 -0
  944. data/sig/increase/models/real_time_payments_transfer_cancel_params.rbs +15 -0
  945. data/sig/increase/models/real_time_payments_transfer_create_params.rbs +90 -0
  946. data/sig/increase/models/real_time_payments_transfer_list_params.rbs +170 -0
  947. data/sig/increase/models/real_time_payments_transfer_retrieve_params.rbs +15 -0
  948. data/sig/increase/models/routing_number_list_params.rbs +36 -0
  949. data/sig/increase/models/routing_number_list_response.rbs +97 -0
  950. data/sig/increase/models/simulations/account_statement_create_params.rbs +25 -0
  951. data/sig/increase/models/simulations/account_transfer_complete_params.rbs +17 -0
  952. data/sig/increase/models/simulations/ach_transfer_acknowledge_params.rbs +17 -0
  953. data/sig/increase/models/simulations/ach_transfer_create_notification_of_change_params.rbs +117 -0
  954. data/sig/increase/models/simulations/ach_transfer_return_params.rbs +320 -0
  955. data/sig/increase/models/simulations/ach_transfer_settle_params.rbs +17 -0
  956. data/sig/increase/models/simulations/ach_transfer_submit_params.rbs +17 -0
  957. data/sig/increase/models/simulations/card_authorization_create_params.rbs +314 -0
  958. data/sig/increase/models/simulations/card_authorization_create_response.rbs +42 -0
  959. data/sig/increase/models/simulations/card_authorization_expiration_create_params.rbs +26 -0
  960. data/sig/increase/models/simulations/card_dispute_action_params.rbs +59 -0
  961. data/sig/increase/models/simulations/card_fuel_confirmation_create_params.rbs +30 -0
  962. data/sig/increase/models/simulations/card_increment_create_params.rbs +40 -0
  963. data/sig/increase/models/simulations/card_refund_create_params.rbs +26 -0
  964. data/sig/increase/models/simulations/card_reversal_create_params.rbs +32 -0
  965. data/sig/increase/models/simulations/card_settlement_create_params.rbs +36 -0
  966. data/sig/increase/models/simulations/check_deposit_reject_params.rbs +17 -0
  967. data/sig/increase/models/simulations/check_deposit_return_params.rbs +17 -0
  968. data/sig/increase/models/simulations/check_deposit_submit_params.rbs +17 -0
  969. data/sig/increase/models/simulations/check_transfer_mail_params.rbs +17 -0
  970. data/sig/increase/models/simulations/digital_wallet_token_request_create_params.rbs +25 -0
  971. data/sig/increase/models/simulations/digital_wallet_token_request_create_response.rbs +66 -0
  972. data/sig/increase/models/simulations/document_create_params.rbs +25 -0
  973. data/sig/increase/models/simulations/inbound_ach_transfer_create_params.rbs +243 -0
  974. data/sig/increase/models/simulations/inbound_check_deposit_create_params.rbs +34 -0
  975. data/sig/increase/models/simulations/inbound_funds_hold_release_params.rbs +17 -0
  976. data/sig/increase/models/simulations/inbound_funds_hold_release_response.rbs +117 -0
  977. data/sig/increase/models/simulations/inbound_mail_item_create_params.rbs +36 -0
  978. data/sig/increase/models/simulations/inbound_real_time_payments_transfer_create_params.rbs +68 -0
  979. data/sig/increase/models/simulations/inbound_wire_drawdown_request_create_params.rbs +147 -0
  980. data/sig/increase/models/simulations/inbound_wire_transfer_create_params.rbs +138 -0
  981. data/sig/increase/models/simulations/interest_payment_create_params.rbs +54 -0
  982. data/sig/increase/models/simulations/physical_card_advance_shipment_params.rbs +68 -0
  983. data/sig/increase/models/simulations/physical_card_tracking_updates_params.rbs +80 -0
  984. data/sig/increase/models/simulations/program_create_params.rbs +32 -0
  985. data/sig/increase/models/simulations/real_time_payments_transfer_complete_params.rbs +141 -0
  986. data/sig/increase/models/simulations/wire_transfer_reverse_params.rbs +17 -0
  987. data/sig/increase/models/simulations/wire_transfer_submit_params.rbs +17 -0
  988. data/sig/increase/models/supplemental_document_create_params.rbs +28 -0
  989. data/sig/increase/models/supplemental_document_list_params.rbs +47 -0
  990. data/sig/increase/models/transaction.rbs +4400 -0
  991. data/sig/increase/models/transaction_list_params.rbs +253 -0
  992. data/sig/increase/models/transaction_retrieve_params.rbs +15 -0
  993. data/sig/increase/models/wire_drawdown_request.rbs +161 -0
  994. data/sig/increase/models/wire_drawdown_request_create_params.rbs +100 -0
  995. data/sig/increase/models/wire_drawdown_request_list_params.rbs +93 -0
  996. data/sig/increase/models/wire_drawdown_request_retrieve_params.rbs +15 -0
  997. data/sig/increase/models/wire_transfer.rbs +469 -0
  998. data/sig/increase/models/wire_transfer_approve_params.rbs +15 -0
  999. data/sig/increase/models/wire_transfer_cancel_params.rbs +15 -0
  1000. data/sig/increase/models/wire_transfer_create_params.rbs +125 -0
  1001. data/sig/increase/models/wire_transfer_list_params.rbs +100 -0
  1002. data/sig/increase/models/wire_transfer_retrieve_params.rbs +15 -0
  1003. data/sig/increase/models.rbs +441 -0
  1004. data/sig/increase/request_options.rbs +34 -0
  1005. data/sig/increase/resources/account_numbers.rbs +40 -0
  1006. data/sig/increase/resources/account_statements.rbs +20 -0
  1007. data/sig/increase/resources/account_transfers.rbs +40 -0
  1008. data/sig/increase/resources/accounts.rbs +49 -0
  1009. data/sig/increase/resources/ach_prenotifications.rbs +37 -0
  1010. data/sig/increase/resources/ach_transfers.rbs +56 -0
  1011. data/sig/increase/resources/bookkeeping_accounts.rbs +34 -0
  1012. data/sig/increase/resources/bookkeeping_entries.rbs +19 -0
  1013. data/sig/increase/resources/bookkeeping_entry_sets.rbs +27 -0
  1014. data/sig/increase/resources/card_disputes.rbs +28 -0
  1015. data/sig/increase/resources/card_payments.rbs +21 -0
  1016. data/sig/increase/resources/card_purchase_supplements.rbs +20 -0
  1017. data/sig/increase/resources/cards.rbs +46 -0
  1018. data/sig/increase/resources/check_deposits.rbs +30 -0
  1019. data/sig/increase/resources/check_transfers.rbs +50 -0
  1020. data/sig/increase/resources/declined_transactions.rbs +22 -0
  1021. data/sig/increase/resources/digital_card_profiles.rbs +52 -0
  1022. data/sig/increase/resources/digital_wallet_tokens.rbs +20 -0
  1023. data/sig/increase/resources/documents.rbs +28 -0
  1024. data/sig/increase/resources/entities.rbs +76 -0
  1025. data/sig/increase/resources/event_subscriptions.rbs +33 -0
  1026. data/sig/increase/resources/events.rbs +21 -0
  1027. data/sig/increase/resources/exports.rbs +33 -0
  1028. data/sig/increase/resources/external_accounts.rbs +39 -0
  1029. data/sig/increase/resources/file_links.rbs +13 -0
  1030. data/sig/increase/resources/files.rbs +28 -0
  1031. data/sig/increase/resources/groups.rbs +11 -0
  1032. data/sig/increase/resources/inbound_ach_transfers.rbs +41 -0
  1033. data/sig/increase/resources/inbound_check_deposits.rbs +32 -0
  1034. data/sig/increase/resources/inbound_mail_items.rbs +20 -0
  1035. data/sig/increase/resources/inbound_real_time_payments_transfers.rbs +21 -0
  1036. data/sig/increase/resources/inbound_wire_drawdown_requests.rbs +18 -0
  1037. data/sig/increase/resources/inbound_wire_transfers.rbs +28 -0
  1038. data/sig/increase/resources/intrafi_account_enrollments.rbs +32 -0
  1039. data/sig/increase/resources/intrafi_balances.rbs +12 -0
  1040. data/sig/increase/resources/intrafi_exclusions.rbs +31 -0
  1041. data/sig/increase/resources/lockboxes.rbs +36 -0
  1042. data/sig/increase/resources/oauth_applications.rbs +20 -0
  1043. data/sig/increase/resources/oauth_connections.rbs +20 -0
  1044. data/sig/increase/resources/oauth_tokens.rbs +16 -0
  1045. data/sig/increase/resources/pending_transactions.rbs +35 -0
  1046. data/sig/increase/resources/physical_card_profiles.rbs +45 -0
  1047. data/sig/increase/resources/physical_cards.rbs +35 -0
  1048. data/sig/increase/resources/programs.rbs +18 -0
  1049. data/sig/increase/resources/real_time_decisions.rbs +22 -0
  1050. data/sig/increase/resources/real_time_payments_transfers.rbs +48 -0
  1051. data/sig/increase/resources/routing_numbers.rbs +14 -0
  1052. data/sig/increase/resources/simulations/account_statements.rbs +14 -0
  1053. data/sig/increase/resources/simulations/account_transfers.rbs +14 -0
  1054. data/sig/increase/resources/simulations/ach_transfers.rbs +37 -0
  1055. data/sig/increase/resources/simulations/card_authorization_expirations.rbs +14 -0
  1056. data/sig/increase/resources/simulations/card_authorizations.rbs +30 -0
  1057. data/sig/increase/resources/simulations/card_disputes.rbs +16 -0
  1058. data/sig/increase/resources/simulations/card_fuel_confirmations.rbs +15 -0
  1059. data/sig/increase/resources/simulations/card_increments.rbs +16 -0
  1060. data/sig/increase/resources/simulations/card_refunds.rbs +14 -0
  1061. data/sig/increase/resources/simulations/card_reversals.rbs +15 -0
  1062. data/sig/increase/resources/simulations/card_settlements.rbs +16 -0
  1063. data/sig/increase/resources/simulations/check_deposits.rbs +24 -0
  1064. data/sig/increase/resources/simulations/check_transfers.rbs +14 -0
  1065. data/sig/increase/resources/simulations/digital_wallet_token_requests.rbs +14 -0
  1066. data/sig/increase/resources/simulations/documents.rbs +14 -0
  1067. data/sig/increase/resources/simulations/inbound_ach_transfers.rbs +25 -0
  1068. data/sig/increase/resources/simulations/inbound_check_deposits.rbs +16 -0
  1069. data/sig/increase/resources/simulations/inbound_funds_holds.rbs +14 -0
  1070. data/sig/increase/resources/simulations/inbound_mail_items.rbs +16 -0
  1071. data/sig/increase/resources/simulations/inbound_real_time_payments_transfers.rbs +20 -0
  1072. data/sig/increase/resources/simulations/inbound_wire_drawdown_requests.rbs +33 -0
  1073. data/sig/increase/resources/simulations/inbound_wire_transfers.rbs +30 -0
  1074. data/sig/increase/resources/simulations/interest_payments.rbs +18 -0
  1075. data/sig/increase/resources/simulations/physical_cards.rbs +25 -0
  1076. data/sig/increase/resources/simulations/programs.rbs +15 -0
  1077. data/sig/increase/resources/simulations/real_time_payments_transfers.rbs +15 -0
  1078. data/sig/increase/resources/simulations/wire_transfers.rbs +19 -0
  1079. data/sig/increase/resources/simulations.rbs +61 -0
  1080. data/sig/increase/resources/supplemental_documents.rbs +21 -0
  1081. data/sig/increase/resources/transactions.rbs +22 -0
  1082. data/sig/increase/resources/wire_drawdown_requests.rbs +37 -0
  1083. data/sig/increase/resources/wire_transfers.rbs +52 -0
  1084. data/sig/increase/version.rbs +3 -0
  1085. metadata +1068 -176
  1086. data/.rspec +0 -3
  1087. data/.standard.yml +0 -3
  1088. data/Gemfile +0 -6
  1089. data/LICENSE.txt +0 -21
  1090. data/OPENAPI_VERSION +0 -1
  1091. data/Rakefile +0 -10
  1092. data/bin/generate +0 -152
  1093. data/bin/setup +0 -8
  1094. data/generate/resource.rb.erb +0 -18
  1095. data/lib/increase/configuration.rb +0 -50
  1096. data/lib/increase/file_upload.rb +0 -57
  1097. data/lib/increase/middleware/encode_json.rb +0 -57
  1098. data/lib/increase/middleware/parse_json.rb +0 -42
  1099. data/lib/increase/middleware/raise_api_error.rb +0 -13
  1100. data/lib/increase/resource.rb +0 -205
  1101. data/lib/increase/resources/card_profiles.rb +0 -17
  1102. data/lib/increase/resources/inbound_ach_transfer_returns.rb +0 -17
  1103. data/lib/increase/resources/limits.rb +0 -19
  1104. data/lib/increase/resources.rb +0 -4
  1105. data/lib/increase/response_array.rb +0 -19
  1106. data/lib/increase/response_hash.rb +0 -15
  1107. data/lib/increase/util.rb +0 -15
  1108. data/lib/increase/webhook/signature.rb +0 -70
  1109. data/openapi.json +0 -32098
  1110. data/sig/increase.rbs +0 -4
@@ -0,0 +1,1481 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Increase
4
+ module Models
5
+ # @see Increase::Resources::ACHTransfers#create
6
+ class ACHTransfer < Increase::Internal::Type::BaseModel
7
+ # @!attribute id
8
+ # The ACH transfer's identifier.
9
+ #
10
+ # @return [String]
11
+ required :id, String
12
+
13
+ # @!attribute account_id
14
+ # The Account to which the transfer belongs.
15
+ #
16
+ # @return [String]
17
+ required :account_id, String
18
+
19
+ # @!attribute account_number
20
+ # The destination account number.
21
+ #
22
+ # @return [String]
23
+ required :account_number, String
24
+
25
+ # @!attribute acknowledgement
26
+ # After the transfer is acknowledged by FedACH, this will contain supplemental
27
+ # details. The Federal Reserve sends an acknowledgement message for each file that
28
+ # Increase submits.
29
+ #
30
+ # @return [Increase::Models::ACHTransfer::Acknowledgement, nil]
31
+ required :acknowledgement, -> { Increase::ACHTransfer::Acknowledgement }, nil?: true
32
+
33
+ # @!attribute addenda
34
+ # Additional information that will be sent to the recipient.
35
+ #
36
+ # @return [Increase::Models::ACHTransfer::Addenda, nil]
37
+ required :addenda, -> { Increase::ACHTransfer::Addenda }, nil?: true
38
+
39
+ # @!attribute amount
40
+ # The transfer amount in USD cents. A positive amount indicates a credit transfer
41
+ # pushing funds to the receiving account. A negative amount indicates a debit
42
+ # transfer pulling funds from the receiving account.
43
+ #
44
+ # @return [Integer]
45
+ required :amount, Integer
46
+
47
+ # @!attribute approval
48
+ # If your account requires approvals for transfers and the transfer was approved,
49
+ # this will contain details of the approval.
50
+ #
51
+ # @return [Increase::Models::ACHTransfer::Approval, nil]
52
+ required :approval, -> { Increase::ACHTransfer::Approval }, nil?: true
53
+
54
+ # @!attribute cancellation
55
+ # If your account requires approvals for transfers and the transfer was not
56
+ # approved, this will contain details of the cancellation.
57
+ #
58
+ # @return [Increase::Models::ACHTransfer::Cancellation, nil]
59
+ required :cancellation, -> { Increase::ACHTransfer::Cancellation }, nil?: true
60
+
61
+ # @!attribute company_descriptive_date
62
+ # The description of the date of the transfer.
63
+ #
64
+ # @return [String, nil]
65
+ required :company_descriptive_date, String, nil?: true
66
+
67
+ # @!attribute company_discretionary_data
68
+ # The data you chose to associate with the transfer.
69
+ #
70
+ # @return [String, nil]
71
+ required :company_discretionary_data, String, nil?: true
72
+
73
+ # @!attribute company_entry_description
74
+ # The description of the transfer you set to be shown to the recipient.
75
+ #
76
+ # @return [String, nil]
77
+ required :company_entry_description, String, nil?: true
78
+
79
+ # @!attribute company_id
80
+ # The company ID associated with the transfer.
81
+ #
82
+ # @return [String]
83
+ required :company_id, String
84
+
85
+ # @!attribute company_name
86
+ # The name by which the recipient knows you.
87
+ #
88
+ # @return [String, nil]
89
+ required :company_name, String, nil?: true
90
+
91
+ # @!attribute created_at
92
+ # The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
93
+ # the transfer was created.
94
+ #
95
+ # @return [Time]
96
+ required :created_at, Time
97
+
98
+ # @!attribute created_by
99
+ # What object created the transfer, either via the API or the dashboard.
100
+ #
101
+ # @return [Increase::Models::ACHTransfer::CreatedBy, nil]
102
+ required :created_by, -> { Increase::ACHTransfer::CreatedBy }, nil?: true
103
+
104
+ # @!attribute currency
105
+ # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the transfer's
106
+ # currency. For ACH transfers this is always equal to `usd`.
107
+ #
108
+ # @return [Symbol, Increase::Models::ACHTransfer::Currency]
109
+ required :currency, enum: -> { Increase::ACHTransfer::Currency }
110
+
111
+ # @!attribute destination_account_holder
112
+ # The type of entity that owns the account to which the ACH Transfer is being
113
+ # sent.
114
+ #
115
+ # @return [Symbol, Increase::Models::ACHTransfer::DestinationAccountHolder]
116
+ required :destination_account_holder, enum: -> { Increase::ACHTransfer::DestinationAccountHolder }
117
+
118
+ # @!attribute external_account_id
119
+ # The identifier of the External Account the transfer was made to, if any.
120
+ #
121
+ # @return [String, nil]
122
+ required :external_account_id, String, nil?: true
123
+
124
+ # @!attribute funding
125
+ # The type of the account to which the transfer will be sent.
126
+ #
127
+ # @return [Symbol, Increase::Models::ACHTransfer::Funding]
128
+ required :funding, enum: -> { Increase::ACHTransfer::Funding }
129
+
130
+ # @!attribute idempotency_key
131
+ # The idempotency key you chose for this object. This value is unique across
132
+ # Increase and is used to ensure that a request is only processed once. Learn more
133
+ # about [idempotency](https://increase.com/documentation/idempotency-keys).
134
+ #
135
+ # @return [String, nil]
136
+ required :idempotency_key, String, nil?: true
137
+
138
+ # @!attribute inbound_funds_hold
139
+ # Increase will sometimes hold the funds for ACH debit transfers. If funds are
140
+ # held, this sub-object will contain details of the hold.
141
+ #
142
+ # @return [Increase::Models::ACHTransfer::InboundFundsHold, nil]
143
+ required :inbound_funds_hold, -> { Increase::ACHTransfer::InboundFundsHold }, nil?: true
144
+
145
+ # @!attribute individual_id
146
+ # Your identifier for the transfer recipient.
147
+ #
148
+ # @return [String, nil]
149
+ required :individual_id, String, nil?: true
150
+
151
+ # @!attribute individual_name
152
+ # The name of the transfer recipient. This value is information and not verified
153
+ # by the recipient's bank.
154
+ #
155
+ # @return [String, nil]
156
+ required :individual_name, String, nil?: true
157
+
158
+ # @!attribute network
159
+ # The transfer's network.
160
+ #
161
+ # @return [Symbol, Increase::Models::ACHTransfer::Network]
162
+ required :network, enum: -> { Increase::ACHTransfer::Network }
163
+
164
+ # @!attribute notifications_of_change
165
+ # If the receiving bank accepts the transfer but notifies that future transfers
166
+ # should use different details, this will contain those details.
167
+ #
168
+ # @return [Array<Increase::Models::ACHTransfer::NotificationsOfChange>]
169
+ required :notifications_of_change,
170
+ -> { Increase::Internal::Type::ArrayOf[Increase::ACHTransfer::NotificationsOfChange] }
171
+
172
+ # @!attribute pending_transaction_id
173
+ # The ID for the pending transaction representing the transfer. A pending
174
+ # transaction is created when the transfer
175
+ # [requires approval](https://increase.com/documentation/transfer-approvals#transfer-approvals)
176
+ # by someone else in your organization.
177
+ #
178
+ # @return [String, nil]
179
+ required :pending_transaction_id, String, nil?: true
180
+
181
+ # @!attribute preferred_effective_date
182
+ # Configuration for how the effective date of the transfer will be set. This
183
+ # determines same-day vs future-dated settlement timing. If not set, defaults to a
184
+ # `settlement_schedule` of `same_day`. If set, exactly one of the child attributes
185
+ # must be set.
186
+ #
187
+ # @return [Increase::Models::ACHTransfer::PreferredEffectiveDate]
188
+ required :preferred_effective_date, -> { Increase::ACHTransfer::PreferredEffectiveDate }
189
+
190
+ # @!attribute return_
191
+ # If your transfer is returned, this will contain details of the return.
192
+ #
193
+ # @return [Increase::Models::ACHTransfer::Return, nil]
194
+ required :return_, -> { Increase::ACHTransfer::Return }, api_name: :return, nil?: true
195
+
196
+ # @!attribute routing_number
197
+ # The American Bankers' Association (ABA) Routing Transit Number (RTN).
198
+ #
199
+ # @return [String]
200
+ required :routing_number, String
201
+
202
+ # @!attribute settlement
203
+ # A subhash containing information about when and how the transfer settled at the
204
+ # Federal Reserve.
205
+ #
206
+ # @return [Increase::Models::ACHTransfer::Settlement, nil]
207
+ required :settlement, -> { Increase::ACHTransfer::Settlement }, nil?: true
208
+
209
+ # @!attribute standard_entry_class_code
210
+ # The Standard Entry Class (SEC) code to use for the transfer.
211
+ #
212
+ # @return [Symbol, Increase::Models::ACHTransfer::StandardEntryClassCode]
213
+ required :standard_entry_class_code, enum: -> { Increase::ACHTransfer::StandardEntryClassCode }
214
+
215
+ # @!attribute statement_descriptor
216
+ # The descriptor that will show on the recipient's bank statement.
217
+ #
218
+ # @return [String]
219
+ required :statement_descriptor, String
220
+
221
+ # @!attribute status
222
+ # The lifecycle status of the transfer.
223
+ #
224
+ # @return [Symbol, Increase::Models::ACHTransfer::Status]
225
+ required :status, enum: -> { Increase::ACHTransfer::Status }
226
+
227
+ # @!attribute submission
228
+ # After the transfer is submitted to FedACH, this will contain supplemental
229
+ # details. Increase batches transfers and submits a file to the Federal Reserve
230
+ # roughly every 30 minutes. The Federal Reserve processes ACH transfers during
231
+ # weekdays according to their
232
+ # [posted schedule](https://www.frbservices.org/resources/resource-centers/same-day-ach/fedach-processing-schedule.html).
233
+ #
234
+ # @return [Increase::Models::ACHTransfer::Submission, nil]
235
+ required :submission, -> { Increase::ACHTransfer::Submission }, nil?: true
236
+
237
+ # @!attribute transaction_id
238
+ # The ID for the transaction funding the transfer.
239
+ #
240
+ # @return [String, nil]
241
+ required :transaction_id, String, nil?: true
242
+
243
+ # @!attribute type
244
+ # A constant representing the object's type. For this resource it will always be
245
+ # `ach_transfer`.
246
+ #
247
+ # @return [Symbol, Increase::Models::ACHTransfer::Type]
248
+ required :type, enum: -> { Increase::ACHTransfer::Type }
249
+
250
+ # @!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:)
251
+ # Some parameter documentations has been truncated, see
252
+ # {Increase::Models::ACHTransfer} for more details.
253
+ #
254
+ # ACH transfers move funds between your Increase account and any other account
255
+ # accessible by the Automated Clearing House (ACH).
256
+ #
257
+ # @param id [String] The ACH transfer's identifier.
258
+ #
259
+ # @param account_id [String] The Account to which the transfer belongs.
260
+ #
261
+ # @param account_number [String] The destination account number.
262
+ #
263
+ # @param acknowledgement [Increase::Models::ACHTransfer::Acknowledgement, nil] After the transfer is acknowledged by FedACH, this will contain supplemental det
264
+ #
265
+ # @param addenda [Increase::Models::ACHTransfer::Addenda, nil] Additional information that will be sent to the recipient.
266
+ #
267
+ # @param amount [Integer] The transfer amount in USD cents. A positive amount indicates a credit transfer
268
+ #
269
+ # @param approval [Increase::Models::ACHTransfer::Approval, nil] If your account requires approvals for transfers and the transfer was approved,
270
+ #
271
+ # @param cancellation [Increase::Models::ACHTransfer::Cancellation, nil] If your account requires approvals for transfers and the transfer was not approv
272
+ #
273
+ # @param company_descriptive_date [String, nil] The description of the date of the transfer.
274
+ #
275
+ # @param company_discretionary_data [String, nil] The data you chose to associate with the transfer.
276
+ #
277
+ # @param company_entry_description [String, nil] The description of the transfer you set to be shown to the recipient.
278
+ #
279
+ # @param company_id [String] The company ID associated with the transfer.
280
+ #
281
+ # @param company_name [String, nil] The name by which the recipient knows you.
282
+ #
283
+ # @param created_at [Time] The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which th
284
+ #
285
+ # @param created_by [Increase::Models::ACHTransfer::CreatedBy, nil] What object created the transfer, either via the API or the dashboard.
286
+ #
287
+ # @param currency [Symbol, Increase::Models::ACHTransfer::Currency] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the transfer's c
288
+ #
289
+ # @param destination_account_holder [Symbol, Increase::Models::ACHTransfer::DestinationAccountHolder] The type of entity that owns the account to which the ACH Transfer is being sent
290
+ #
291
+ # @param external_account_id [String, nil] The identifier of the External Account the transfer was made to, if any.
292
+ #
293
+ # @param funding [Symbol, Increase::Models::ACHTransfer::Funding] The type of the account to which the transfer will be sent.
294
+ #
295
+ # @param idempotency_key [String, nil] The idempotency key you chose for this object. This value is unique across Incre
296
+ #
297
+ # @param inbound_funds_hold [Increase::Models::ACHTransfer::InboundFundsHold, nil] Increase will sometimes hold the funds for ACH debit transfers. If funds are hel
298
+ #
299
+ # @param individual_id [String, nil] Your identifier for the transfer recipient.
300
+ #
301
+ # @param individual_name [String, nil] The name of the transfer recipient. This value is information and not verified b
302
+ #
303
+ # @param network [Symbol, Increase::Models::ACHTransfer::Network] The transfer's network.
304
+ #
305
+ # @param notifications_of_change [Array<Increase::Models::ACHTransfer::NotificationsOfChange>] If the receiving bank accepts the transfer but notifies that future transfers sh
306
+ #
307
+ # @param pending_transaction_id [String, nil] The ID for the pending transaction representing the transfer. A pending transact
308
+ #
309
+ # @param preferred_effective_date [Increase::Models::ACHTransfer::PreferredEffectiveDate] Configuration for how the effective date of the transfer will be set. This deter
310
+ #
311
+ # @param return_ [Increase::Models::ACHTransfer::Return, nil] If your transfer is returned, this will contain details of the return.
312
+ #
313
+ # @param routing_number [String] The American Bankers' Association (ABA) Routing Transit Number (RTN).
314
+ #
315
+ # @param settlement [Increase::Models::ACHTransfer::Settlement, nil] A subhash containing information about when and how the transfer settled at the
316
+ #
317
+ # @param standard_entry_class_code [Symbol, Increase::Models::ACHTransfer::StandardEntryClassCode] The Standard Entry Class (SEC) code to use for the transfer.
318
+ #
319
+ # @param statement_descriptor [String] The descriptor that will show on the recipient's bank statement.
320
+ #
321
+ # @param status [Symbol, Increase::Models::ACHTransfer::Status] The lifecycle status of the transfer.
322
+ #
323
+ # @param submission [Increase::Models::ACHTransfer::Submission, nil] After the transfer is submitted to FedACH, this will contain supplemental detail
324
+ #
325
+ # @param transaction_id [String, nil] The ID for the transaction funding the transfer.
326
+ #
327
+ # @param type [Symbol, Increase::Models::ACHTransfer::Type] A constant representing the object's type. For this resource it will always be `
328
+
329
+ # @see Increase::Models::ACHTransfer#acknowledgement
330
+ class Acknowledgement < Increase::Internal::Type::BaseModel
331
+ # @!attribute acknowledged_at
332
+ # When the Federal Reserve acknowledged the submitted file containing this
333
+ # transfer.
334
+ #
335
+ # @return [String]
336
+ required :acknowledged_at, String
337
+
338
+ # @!method initialize(acknowledged_at:)
339
+ # Some parameter documentations has been truncated, see
340
+ # {Increase::Models::ACHTransfer::Acknowledgement} for more details.
341
+ #
342
+ # After the transfer is acknowledged by FedACH, this will contain supplemental
343
+ # details. The Federal Reserve sends an acknowledgement message for each file that
344
+ # Increase submits.
345
+ #
346
+ # @param acknowledged_at [String] When the Federal Reserve acknowledged the submitted file containing this transfe
347
+ end
348
+
349
+ # @see Increase::Models::ACHTransfer#addenda
350
+ class Addenda < Increase::Internal::Type::BaseModel
351
+ # @!attribute category
352
+ # The type of the resource. We may add additional possible values for this enum
353
+ # over time; your application should be able to handle such additions gracefully.
354
+ #
355
+ # @return [Symbol, Increase::Models::ACHTransfer::Addenda::Category]
356
+ required :category, enum: -> { Increase::ACHTransfer::Addenda::Category }
357
+
358
+ # @!attribute freeform
359
+ # Unstructured `payment_related_information` passed through with the transfer.
360
+ #
361
+ # @return [Increase::Models::ACHTransfer::Addenda::Freeform, nil]
362
+ required :freeform, -> { Increase::ACHTransfer::Addenda::Freeform }, nil?: true
363
+
364
+ # @!attribute payment_order_remittance_advice
365
+ # Structured ASC X12 820 remittance advice records. Please reach out to
366
+ # [support@increase.com](mailto:support@increase.com) for more information.
367
+ #
368
+ # @return [Increase::Models::ACHTransfer::Addenda::PaymentOrderRemittanceAdvice, nil]
369
+ required :payment_order_remittance_advice,
370
+ -> { Increase::ACHTransfer::Addenda::PaymentOrderRemittanceAdvice },
371
+ nil?: true
372
+
373
+ # @!method initialize(category:, freeform:, payment_order_remittance_advice:)
374
+ # Some parameter documentations has been truncated, see
375
+ # {Increase::Models::ACHTransfer::Addenda} for more details.
376
+ #
377
+ # Additional information that will be sent to the recipient.
378
+ #
379
+ # @param category [Symbol, Increase::Models::ACHTransfer::Addenda::Category] The type of the resource. We may add additional possible values for this enum ov
380
+ #
381
+ # @param freeform [Increase::Models::ACHTransfer::Addenda::Freeform, nil] Unstructured `payment_related_information` passed through with the transfer.
382
+ #
383
+ # @param payment_order_remittance_advice [Increase::Models::ACHTransfer::Addenda::PaymentOrderRemittanceAdvice, nil] Structured ASC X12 820 remittance advice records. Please reach out to [support@i
384
+
385
+ # The type of the resource. We may add additional possible values for this enum
386
+ # over time; your application should be able to handle such additions gracefully.
387
+ #
388
+ # @see Increase::Models::ACHTransfer::Addenda#category
389
+ module Category
390
+ extend Increase::Internal::Type::Enum
391
+
392
+ # Unstructured `payment_related_information` passed through with the transfer.
393
+ FREEFORM = :freeform
394
+
395
+ # Structured ASC X12 820 remittance advice records. Please reach out to [support@increase.com](mailto:support@increase.com) for more information.
396
+ PAYMENT_ORDER_REMITTANCE_ADVICE = :payment_order_remittance_advice
397
+
398
+ # Unknown addenda type.
399
+ OTHER = :other
400
+
401
+ # @!method self.values
402
+ # @return [Array<Symbol>]
403
+ end
404
+
405
+ # @see Increase::Models::ACHTransfer::Addenda#freeform
406
+ class Freeform < Increase::Internal::Type::BaseModel
407
+ # @!attribute entries
408
+ # Each entry represents an addendum sent with the transfer.
409
+ #
410
+ # @return [Array<Increase::Models::ACHTransfer::Addenda::Freeform::Entry>]
411
+ required :entries,
412
+ -> { Increase::Internal::Type::ArrayOf[Increase::ACHTransfer::Addenda::Freeform::Entry] }
413
+
414
+ # @!method initialize(entries:)
415
+ # Unstructured `payment_related_information` passed through with the transfer.
416
+ #
417
+ # @param entries [Array<Increase::Models::ACHTransfer::Addenda::Freeform::Entry>] Each entry represents an addendum sent with the transfer.
418
+
419
+ class Entry < Increase::Internal::Type::BaseModel
420
+ # @!attribute payment_related_information
421
+ # The payment related information passed in the addendum.
422
+ #
423
+ # @return [String]
424
+ required :payment_related_information, String
425
+
426
+ # @!method initialize(payment_related_information:)
427
+ # @param payment_related_information [String] The payment related information passed in the addendum.
428
+ end
429
+ end
430
+
431
+ # @see Increase::Models::ACHTransfer::Addenda#payment_order_remittance_advice
432
+ class PaymentOrderRemittanceAdvice < Increase::Internal::Type::BaseModel
433
+ # @!attribute invoices
434
+ # ASC X12 RMR records for this specific transfer.
435
+ #
436
+ # @return [Array<Increase::Models::ACHTransfer::Addenda::PaymentOrderRemittanceAdvice::Invoice>]
437
+ required :invoices,
438
+ -> {
439
+ Increase::Internal::Type::ArrayOf[Increase::ACHTransfer::Addenda::PaymentOrderRemittanceAdvice::Invoice]
440
+ }
441
+
442
+ # @!method initialize(invoices:)
443
+ # Structured ASC X12 820 remittance advice records. Please reach out to
444
+ # [support@increase.com](mailto:support@increase.com) for more information.
445
+ #
446
+ # @param invoices [Array<Increase::Models::ACHTransfer::Addenda::PaymentOrderRemittanceAdvice::Invoice>] ASC X12 RMR records for this specific transfer.
447
+
448
+ class Invoice < Increase::Internal::Type::BaseModel
449
+ # @!attribute invoice_number
450
+ # The invoice number for this reference, determined in advance with the receiver.
451
+ #
452
+ # @return [String]
453
+ required :invoice_number, String
454
+
455
+ # @!attribute paid_amount
456
+ # The amount that was paid for this invoice in the minor unit of its currency. For
457
+ # dollars, for example, this is cents.
458
+ #
459
+ # @return [Integer]
460
+ required :paid_amount, Integer
461
+
462
+ # @!method initialize(invoice_number:, paid_amount:)
463
+ # Some parameter documentations has been truncated, see
464
+ # {Increase::Models::ACHTransfer::Addenda::PaymentOrderRemittanceAdvice::Invoice}
465
+ # for more details.
466
+ #
467
+ # @param invoice_number [String] The invoice number for this reference, determined in advance with the receiver.
468
+ #
469
+ # @param paid_amount [Integer] The amount that was paid for this invoice in the minor unit of its currency. For
470
+ end
471
+ end
472
+ end
473
+
474
+ # @see Increase::Models::ACHTransfer#approval
475
+ class Approval < Increase::Internal::Type::BaseModel
476
+ # @!attribute approved_at
477
+ # The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
478
+ # the transfer was approved.
479
+ #
480
+ # @return [Time]
481
+ required :approved_at, Time
482
+
483
+ # @!attribute approved_by
484
+ # If the Transfer was approved by a user in the dashboard, the email address of
485
+ # that user.
486
+ #
487
+ # @return [String, nil]
488
+ required :approved_by, String, nil?: true
489
+
490
+ # @!method initialize(approved_at:, approved_by:)
491
+ # Some parameter documentations has been truncated, see
492
+ # {Increase::Models::ACHTransfer::Approval} for more details.
493
+ #
494
+ # If your account requires approvals for transfers and the transfer was approved,
495
+ # this will contain details of the approval.
496
+ #
497
+ # @param approved_at [Time] The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which th
498
+ #
499
+ # @param approved_by [String, nil] If the Transfer was approved by a user in the dashboard, the email address of th
500
+ end
501
+
502
+ # @see Increase::Models::ACHTransfer#cancellation
503
+ class Cancellation < Increase::Internal::Type::BaseModel
504
+ # @!attribute canceled_at
505
+ # The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
506
+ # the Transfer was canceled.
507
+ #
508
+ # @return [Time]
509
+ required :canceled_at, Time
510
+
511
+ # @!attribute canceled_by
512
+ # If the Transfer was canceled by a user in the dashboard, the email address of
513
+ # that user.
514
+ #
515
+ # @return [String, nil]
516
+ required :canceled_by, String, nil?: true
517
+
518
+ # @!method initialize(canceled_at:, canceled_by:)
519
+ # Some parameter documentations has been truncated, see
520
+ # {Increase::Models::ACHTransfer::Cancellation} for more details.
521
+ #
522
+ # If your account requires approvals for transfers and the transfer was not
523
+ # approved, this will contain details of the cancellation.
524
+ #
525
+ # @param canceled_at [Time] The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which th
526
+ #
527
+ # @param canceled_by [String, nil] If the Transfer was canceled by a user in the dashboard, the email address of th
528
+ end
529
+
530
+ # @see Increase::Models::ACHTransfer#created_by
531
+ class CreatedBy < Increase::Internal::Type::BaseModel
532
+ # @!attribute api_key
533
+ # If present, details about the API key that created the transfer.
534
+ #
535
+ # @return [Increase::Models::ACHTransfer::CreatedBy::APIKey, nil]
536
+ required :api_key, -> { Increase::ACHTransfer::CreatedBy::APIKey }, nil?: true
537
+
538
+ # @!attribute category
539
+ # The type of object that created this transfer.
540
+ #
541
+ # @return [Symbol, Increase::Models::ACHTransfer::CreatedBy::Category]
542
+ required :category, enum: -> { Increase::ACHTransfer::CreatedBy::Category }
543
+
544
+ # @!attribute oauth_application
545
+ # If present, details about the OAuth Application that created the transfer.
546
+ #
547
+ # @return [Increase::Models::ACHTransfer::CreatedBy::OAuthApplication, nil]
548
+ required :oauth_application, -> { Increase::ACHTransfer::CreatedBy::OAuthApplication }, nil?: true
549
+
550
+ # @!attribute user
551
+ # If present, details about the User that created the transfer.
552
+ #
553
+ # @return [Increase::Models::ACHTransfer::CreatedBy::User, nil]
554
+ required :user, -> { Increase::ACHTransfer::CreatedBy::User }, nil?: true
555
+
556
+ # @!method initialize(api_key:, category:, oauth_application:, user:)
557
+ # What object created the transfer, either via the API or the dashboard.
558
+ #
559
+ # @param api_key [Increase::Models::ACHTransfer::CreatedBy::APIKey, nil] If present, details about the API key that created the transfer.
560
+ #
561
+ # @param category [Symbol, Increase::Models::ACHTransfer::CreatedBy::Category] The type of object that created this transfer.
562
+ #
563
+ # @param oauth_application [Increase::Models::ACHTransfer::CreatedBy::OAuthApplication, nil] If present, details about the OAuth Application that created the transfer.
564
+ #
565
+ # @param user [Increase::Models::ACHTransfer::CreatedBy::User, nil] If present, details about the User that created the transfer.
566
+
567
+ # @see Increase::Models::ACHTransfer::CreatedBy#api_key
568
+ class APIKey < Increase::Internal::Type::BaseModel
569
+ # @!attribute description
570
+ # The description set for the API key when it was created.
571
+ #
572
+ # @return [String, nil]
573
+ required :description, String, nil?: true
574
+
575
+ # @!method initialize(description:)
576
+ # If present, details about the API key that created the transfer.
577
+ #
578
+ # @param description [String, nil] The description set for the API key when it was created.
579
+ end
580
+
581
+ # The type of object that created this transfer.
582
+ #
583
+ # @see Increase::Models::ACHTransfer::CreatedBy#category
584
+ module Category
585
+ extend Increase::Internal::Type::Enum
586
+
587
+ # An API key. Details will be under the `api_key` object.
588
+ API_KEY = :api_key
589
+
590
+ # An OAuth application you connected to Increase. Details will be under the `oauth_application` object.
591
+ OAUTH_APPLICATION = :oauth_application
592
+
593
+ # A User in the Increase dashboard. Details will be under the `user` object.
594
+ USER = :user
595
+
596
+ # @!method self.values
597
+ # @return [Array<Symbol>]
598
+ end
599
+
600
+ # @see Increase::Models::ACHTransfer::CreatedBy#oauth_application
601
+ class OAuthApplication < Increase::Internal::Type::BaseModel
602
+ # @!attribute name
603
+ # The name of the OAuth Application.
604
+ #
605
+ # @return [String]
606
+ required :name, String
607
+
608
+ # @!method initialize(name:)
609
+ # If present, details about the OAuth Application that created the transfer.
610
+ #
611
+ # @param name [String] The name of the OAuth Application.
612
+ end
613
+
614
+ # @see Increase::Models::ACHTransfer::CreatedBy#user
615
+ class User < Increase::Internal::Type::BaseModel
616
+ # @!attribute email
617
+ # The email address of the User.
618
+ #
619
+ # @return [String]
620
+ required :email, String
621
+
622
+ # @!method initialize(email:)
623
+ # If present, details about the User that created the transfer.
624
+ #
625
+ # @param email [String] The email address of the User.
626
+ end
627
+ end
628
+
629
+ # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the transfer's
630
+ # currency. For ACH transfers this is always equal to `usd`.
631
+ #
632
+ # @see Increase::Models::ACHTransfer#currency
633
+ module Currency
634
+ extend Increase::Internal::Type::Enum
635
+
636
+ # Canadian Dollar (CAD)
637
+ CAD = :CAD
638
+
639
+ # Swiss Franc (CHF)
640
+ CHF = :CHF
641
+
642
+ # Euro (EUR)
643
+ EUR = :EUR
644
+
645
+ # British Pound (GBP)
646
+ GBP = :GBP
647
+
648
+ # Japanese Yen (JPY)
649
+ JPY = :JPY
650
+
651
+ # US Dollar (USD)
652
+ USD = :USD
653
+
654
+ # @!method self.values
655
+ # @return [Array<Symbol>]
656
+ end
657
+
658
+ # The type of entity that owns the account to which the ACH Transfer is being
659
+ # sent.
660
+ #
661
+ # @see Increase::Models::ACHTransfer#destination_account_holder
662
+ module DestinationAccountHolder
663
+ extend Increase::Internal::Type::Enum
664
+
665
+ # The External Account is owned by a business.
666
+ BUSINESS = :business
667
+
668
+ # The External Account is owned by an individual.
669
+ INDIVIDUAL = :individual
670
+
671
+ # It's unknown what kind of entity owns the External Account.
672
+ UNKNOWN = :unknown
673
+
674
+ # @!method self.values
675
+ # @return [Array<Symbol>]
676
+ end
677
+
678
+ # The type of the account to which the transfer will be sent.
679
+ #
680
+ # @see Increase::Models::ACHTransfer#funding
681
+ module Funding
682
+ extend Increase::Internal::Type::Enum
683
+
684
+ # A checking account.
685
+ CHECKING = :checking
686
+
687
+ # A savings account.
688
+ SAVINGS = :savings
689
+
690
+ # @!method self.values
691
+ # @return [Array<Symbol>]
692
+ end
693
+
694
+ # @see Increase::Models::ACHTransfer#inbound_funds_hold
695
+ class InboundFundsHold < Increase::Internal::Type::BaseModel
696
+ # @!attribute id
697
+ # The Inbound Funds Hold identifier.
698
+ #
699
+ # @return [String]
700
+ required :id, String
701
+
702
+ # @!attribute amount
703
+ # The held amount in the minor unit of the account's currency. For dollars, for
704
+ # example, this is cents.
705
+ #
706
+ # @return [Integer]
707
+ required :amount, Integer
708
+
709
+ # @!attribute automatically_releases_at
710
+ # When the hold will be released automatically. Certain conditions may cause it to
711
+ # be released before this time.
712
+ #
713
+ # @return [Time]
714
+ required :automatically_releases_at, Time
715
+
716
+ # @!attribute created_at
717
+ # The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the hold
718
+ # was created.
719
+ #
720
+ # @return [Time]
721
+ required :created_at, Time
722
+
723
+ # @!attribute currency
724
+ # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the hold's
725
+ # currency.
726
+ #
727
+ # @return [Symbol, Increase::Models::ACHTransfer::InboundFundsHold::Currency]
728
+ required :currency, enum: -> { Increase::ACHTransfer::InboundFundsHold::Currency }
729
+
730
+ # @!attribute held_transaction_id
731
+ # The ID of the Transaction for which funds were held.
732
+ #
733
+ # @return [String, nil]
734
+ required :held_transaction_id, String, nil?: true
735
+
736
+ # @!attribute pending_transaction_id
737
+ # The ID of the Pending Transaction representing the held funds.
738
+ #
739
+ # @return [String, nil]
740
+ required :pending_transaction_id, String, nil?: true
741
+
742
+ # @!attribute released_at
743
+ # When the hold was released (if it has been released).
744
+ #
745
+ # @return [Time, nil]
746
+ required :released_at, Time, nil?: true
747
+
748
+ # @!attribute status
749
+ # The status of the hold.
750
+ #
751
+ # @return [Symbol, Increase::Models::ACHTransfer::InboundFundsHold::Status]
752
+ required :status, enum: -> { Increase::ACHTransfer::InboundFundsHold::Status }
753
+
754
+ # @!attribute type
755
+ # A constant representing the object's type. For this resource it will always be
756
+ # `inbound_funds_hold`.
757
+ #
758
+ # @return [Symbol, Increase::Models::ACHTransfer::InboundFundsHold::Type]
759
+ required :type, enum: -> { Increase::ACHTransfer::InboundFundsHold::Type }
760
+
761
+ # @!method initialize(id:, amount:, automatically_releases_at:, created_at:, currency:, held_transaction_id:, pending_transaction_id:, released_at:, status:, type:)
762
+ # Some parameter documentations has been truncated, see
763
+ # {Increase::Models::ACHTransfer::InboundFundsHold} for more details.
764
+ #
765
+ # Increase will sometimes hold the funds for ACH debit transfers. If funds are
766
+ # held, this sub-object will contain details of the hold.
767
+ #
768
+ # @param id [String] The Inbound Funds Hold identifier.
769
+ #
770
+ # @param amount [Integer] The held amount in the minor unit of the account's currency. For dollars, for ex
771
+ #
772
+ # @param automatically_releases_at [Time] When the hold will be released automatically. Certain conditions may cause it to
773
+ #
774
+ # @param created_at [Time] The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the hold wa
775
+ #
776
+ # @param currency [Symbol, Increase::Models::ACHTransfer::InboundFundsHold::Currency] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the hold's curre
777
+ #
778
+ # @param held_transaction_id [String, nil] The ID of the Transaction for which funds were held.
779
+ #
780
+ # @param pending_transaction_id [String, nil] The ID of the Pending Transaction representing the held funds.
781
+ #
782
+ # @param released_at [Time, nil] When the hold was released (if it has been released).
783
+ #
784
+ # @param status [Symbol, Increase::Models::ACHTransfer::InboundFundsHold::Status] The status of the hold.
785
+ #
786
+ # @param type [Symbol, Increase::Models::ACHTransfer::InboundFundsHold::Type] A constant representing the object's type. For this resource it will always be `
787
+
788
+ # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the hold's
789
+ # currency.
790
+ #
791
+ # @see Increase::Models::ACHTransfer::InboundFundsHold#currency
792
+ module Currency
793
+ extend Increase::Internal::Type::Enum
794
+
795
+ # Canadian Dollar (CAD)
796
+ CAD = :CAD
797
+
798
+ # Swiss Franc (CHF)
799
+ CHF = :CHF
800
+
801
+ # Euro (EUR)
802
+ EUR = :EUR
803
+
804
+ # British Pound (GBP)
805
+ GBP = :GBP
806
+
807
+ # Japanese Yen (JPY)
808
+ JPY = :JPY
809
+
810
+ # US Dollar (USD)
811
+ USD = :USD
812
+
813
+ # @!method self.values
814
+ # @return [Array<Symbol>]
815
+ end
816
+
817
+ # The status of the hold.
818
+ #
819
+ # @see Increase::Models::ACHTransfer::InboundFundsHold#status
820
+ module Status
821
+ extend Increase::Internal::Type::Enum
822
+
823
+ # Funds are still being held.
824
+ HELD = :held
825
+
826
+ # Funds have been released.
827
+ COMPLETE = :complete
828
+
829
+ # @!method self.values
830
+ # @return [Array<Symbol>]
831
+ end
832
+
833
+ # A constant representing the object's type. For this resource it will always be
834
+ # `inbound_funds_hold`.
835
+ #
836
+ # @see Increase::Models::ACHTransfer::InboundFundsHold#type
837
+ module Type
838
+ extend Increase::Internal::Type::Enum
839
+
840
+ INBOUND_FUNDS_HOLD = :inbound_funds_hold
841
+
842
+ # @!method self.values
843
+ # @return [Array<Symbol>]
844
+ end
845
+ end
846
+
847
+ # The transfer's network.
848
+ #
849
+ # @see Increase::Models::ACHTransfer#network
850
+ module Network
851
+ extend Increase::Internal::Type::Enum
852
+
853
+ ACH = :ach
854
+
855
+ # @!method self.values
856
+ # @return [Array<Symbol>]
857
+ end
858
+
859
+ class NotificationsOfChange < Increase::Internal::Type::BaseModel
860
+ # @!attribute change_code
861
+ # The required type of change that is being signaled by the receiving financial
862
+ # institution.
863
+ #
864
+ # @return [Symbol, Increase::Models::ACHTransfer::NotificationsOfChange::ChangeCode]
865
+ required :change_code, enum: -> { Increase::ACHTransfer::NotificationsOfChange::ChangeCode }
866
+
867
+ # @!attribute corrected_data
868
+ # The corrected data that should be used in future ACHs to this account. This may
869
+ # contain the suggested new account number or routing number. When the
870
+ # `change_code` is `incorrect_transaction_code`, this field contains an integer.
871
+ # Numbers starting with a 2 encourage changing the `funding` parameter to
872
+ # checking; numbers starting with a 3 encourage changing to savings.
873
+ #
874
+ # @return [String]
875
+ required :corrected_data, String
876
+
877
+ # @!attribute created_at
878
+ # The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
879
+ # the notification occurred.
880
+ #
881
+ # @return [Time]
882
+ required :created_at, Time
883
+
884
+ # @!method initialize(change_code:, corrected_data:, created_at:)
885
+ # Some parameter documentations has been truncated, see
886
+ # {Increase::Models::ACHTransfer::NotificationsOfChange} for more details.
887
+ #
888
+ # @param change_code [Symbol, Increase::Models::ACHTransfer::NotificationsOfChange::ChangeCode] The required type of change that is being signaled by the receiving financial in
889
+ #
890
+ # @param corrected_data [String] The corrected data that should be used in future ACHs to this account. This may
891
+ #
892
+ # @param created_at [Time] The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which th
893
+
894
+ # The required type of change that is being signaled by the receiving financial
895
+ # institution.
896
+ #
897
+ # @see Increase::Models::ACHTransfer::NotificationsOfChange#change_code
898
+ module ChangeCode
899
+ extend Increase::Internal::Type::Enum
900
+
901
+ # The account number was incorrect.
902
+ INCORRECT_ACCOUNT_NUMBER = :incorrect_account_number
903
+
904
+ # The routing number was incorrect.
905
+ INCORRECT_ROUTING_NUMBER = :incorrect_routing_number
906
+
907
+ # Both the routing number and the account number were incorrect.
908
+ INCORRECT_ROUTING_NUMBER_AND_ACCOUNT_NUMBER = :incorrect_routing_number_and_account_number
909
+
910
+ # The transaction code was incorrect. Try changing the `funding` parameter from checking to savings or vice-versa.
911
+ INCORRECT_TRANSACTION_CODE = :incorrect_transaction_code
912
+
913
+ # The account number and the transaction code were incorrect.
914
+ INCORRECT_ACCOUNT_NUMBER_AND_TRANSACTION_CODE = :incorrect_account_number_and_transaction_code
915
+
916
+ # The routing number, account number, and transaction code were incorrect.
917
+ INCORRECT_ROUTING_NUMBER_ACCOUNT_NUMBER_AND_TRANSACTION_CODE =
918
+ :incorrect_routing_number_account_number_and_transaction_code
919
+
920
+ # The receiving depository financial institution identification was incorrect.
921
+ INCORRECT_RECEIVING_DEPOSITORY_FINANCIAL_INSTITUTION_IDENTIFICATION =
922
+ :incorrect_receiving_depository_financial_institution_identification
923
+
924
+ # The individual identification number was incorrect.
925
+ INCORRECT_INDIVIDUAL_IDENTIFICATION_NUMBER = :incorrect_individual_identification_number
926
+
927
+ # The addenda had an incorrect format.
928
+ ADDENDA_FORMAT_ERROR = :addenda_format_error
929
+
930
+ # The standard entry class code was incorrect for an outbound international payment.
931
+ INCORRECT_STANDARD_ENTRY_CLASS_CODE_FOR_OUTBOUND_INTERNATIONAL_PAYMENT =
932
+ :incorrect_standard_entry_class_code_for_outbound_international_payment
933
+
934
+ # The notification of change was misrouted.
935
+ MISROUTED_NOTIFICATION_OF_CHANGE = :misrouted_notification_of_change
936
+
937
+ # The trace number was incorrect.
938
+ INCORRECT_TRACE_NUMBER = :incorrect_trace_number
939
+
940
+ # The company identification number was incorrect.
941
+ INCORRECT_COMPANY_IDENTIFICATION_NUMBER = :incorrect_company_identification_number
942
+
943
+ # The individual identification number or identification number was incorrect.
944
+ INCORRECT_IDENTIFICATION_NUMBER = :incorrect_identification_number
945
+
946
+ # The corrected data was incorrectly formatted.
947
+ INCORRECTLY_FORMATTED_CORRECTED_DATA = :incorrectly_formatted_corrected_data
948
+
949
+ # The discretionary data was incorrect.
950
+ INCORRECT_DISCRETIONARY_DATA = :incorrect_discretionary_data
951
+
952
+ # The routing number was not from the original entry detail record.
953
+ ROUTING_NUMBER_NOT_FROM_ORIGINAL_ENTRY_DETAIL_RECORD =
954
+ :routing_number_not_from_original_entry_detail_record
955
+
956
+ # The depository financial institution account number was not from the original entry detail record.
957
+ DEPOSITORY_FINANCIAL_INSTITUTION_ACCOUNT_NUMBER_NOT_FROM_ORIGINAL_ENTRY_DETAIL_RECORD =
958
+ :depository_financial_institution_account_number_not_from_original_entry_detail_record
959
+
960
+ # The transaction code was incorrect, initiated by the originating depository financial institution.
961
+ INCORRECT_TRANSACTION_CODE_BY_ORIGINATING_DEPOSITORY_FINANCIAL_INSTITUTION =
962
+ :incorrect_transaction_code_by_originating_depository_financial_institution
963
+
964
+ # @!method self.values
965
+ # @return [Array<Symbol>]
966
+ end
967
+ end
968
+
969
+ # @see Increase::Models::ACHTransfer#preferred_effective_date
970
+ class PreferredEffectiveDate < Increase::Internal::Type::BaseModel
971
+ # @!attribute date
972
+ # A specific date in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format to
973
+ # use as the effective date when submitting this transfer.
974
+ #
975
+ # @return [Date, nil]
976
+ required :date, Date, nil?: true
977
+
978
+ # @!attribute settlement_schedule
979
+ # A schedule by which Increase will choose an effective date for the transfer.
980
+ #
981
+ # @return [Symbol, Increase::Models::ACHTransfer::PreferredEffectiveDate::SettlementSchedule, nil]
982
+ required :settlement_schedule,
983
+ enum: -> { Increase::ACHTransfer::PreferredEffectiveDate::SettlementSchedule },
984
+ nil?: true
985
+
986
+ # @!method initialize(date:, settlement_schedule:)
987
+ # Some parameter documentations has been truncated, see
988
+ # {Increase::Models::ACHTransfer::PreferredEffectiveDate} for more details.
989
+ #
990
+ # Configuration for how the effective date of the transfer will be set. This
991
+ # determines same-day vs future-dated settlement timing. If not set, defaults to a
992
+ # `settlement_schedule` of `same_day`. If set, exactly one of the child attributes
993
+ # must be set.
994
+ #
995
+ # @param date [Date, nil] A specific date in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format to
996
+ #
997
+ # @param settlement_schedule [Symbol, Increase::Models::ACHTransfer::PreferredEffectiveDate::SettlementSchedule, nil] A schedule by which Increase will choose an effective date for the transfer.
998
+
999
+ # A schedule by which Increase will choose an effective date for the transfer.
1000
+ #
1001
+ # @see Increase::Models::ACHTransfer::PreferredEffectiveDate#settlement_schedule
1002
+ module SettlementSchedule
1003
+ extend Increase::Internal::Type::Enum
1004
+
1005
+ # The chosen effective date will be the same as the ACH processing date on which the transfer is submitted.
1006
+ # This is necessary, but not sufficient for the transfer to be settled same-day:
1007
+ # it must also be submitted before the last same-day cutoff
1008
+ # and be less than or equal to $1,000.000.00.
1009
+ SAME_DAY = :same_day
1010
+
1011
+ # The chosen effective date will be the business day following the ACH processing date on which the transfer is submitted. The transfer will be settled on that future day.
1012
+ FUTURE_DATED = :future_dated
1013
+
1014
+ # @!method self.values
1015
+ # @return [Array<Symbol>]
1016
+ end
1017
+ end
1018
+
1019
+ # @see Increase::Models::ACHTransfer#return_
1020
+ class Return < Increase::Internal::Type::BaseModel
1021
+ # @!attribute created_at
1022
+ # The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
1023
+ # the transfer was created.
1024
+ #
1025
+ # @return [Time]
1026
+ required :created_at, Time
1027
+
1028
+ # @!attribute raw_return_reason_code
1029
+ # The three character ACH return code, in the range R01 to R85.
1030
+ #
1031
+ # @return [String]
1032
+ required :raw_return_reason_code, String
1033
+
1034
+ # @!attribute return_reason_code
1035
+ # Why the ACH Transfer was returned. This reason code is sent by the receiving
1036
+ # bank back to Increase.
1037
+ #
1038
+ # @return [Symbol, Increase::Models::ACHTransfer::Return::ReturnReasonCode]
1039
+ required :return_reason_code, enum: -> { Increase::ACHTransfer::Return::ReturnReasonCode }
1040
+
1041
+ # @!attribute trace_number
1042
+ # A 15 digit number that was generated by the bank that initiated the return. The
1043
+ # trace number of the return is different than that of the original transfer. ACH
1044
+ # trace numbers are not unique, but along with the amount and date this number can
1045
+ # be used to identify the ACH return at the bank that initiated it.
1046
+ #
1047
+ # @return [String]
1048
+ required :trace_number, String
1049
+
1050
+ # @!attribute transaction_id
1051
+ # The identifier of the Transaction associated with this return.
1052
+ #
1053
+ # @return [String]
1054
+ required :transaction_id, String
1055
+
1056
+ # @!attribute transfer_id
1057
+ # The identifier of the ACH Transfer associated with this return.
1058
+ #
1059
+ # @return [String]
1060
+ required :transfer_id, String
1061
+
1062
+ # @!method initialize(created_at:, raw_return_reason_code:, return_reason_code:, trace_number:, transaction_id:, transfer_id:)
1063
+ # Some parameter documentations has been truncated, see
1064
+ # {Increase::Models::ACHTransfer::Return} for more details.
1065
+ #
1066
+ # If your transfer is returned, this will contain details of the return.
1067
+ #
1068
+ # @param created_at [Time] The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which th
1069
+ #
1070
+ # @param raw_return_reason_code [String] The three character ACH return code, in the range R01 to R85.
1071
+ #
1072
+ # @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
1073
+ #
1074
+ # @param trace_number [String] A 15 digit number that was generated by the bank that initiated the return. The
1075
+ #
1076
+ # @param transaction_id [String] The identifier of the Transaction associated with this return.
1077
+ #
1078
+ # @param transfer_id [String] The identifier of the ACH Transfer associated with this return.
1079
+
1080
+ # Why the ACH Transfer was returned. This reason code is sent by the receiving
1081
+ # bank back to Increase.
1082
+ #
1083
+ # @see Increase::Models::ACHTransfer::Return#return_reason_code
1084
+ module ReturnReasonCode
1085
+ extend Increase::Internal::Type::Enum
1086
+
1087
+ # Code R01. Insufficient funds in the receiving account. Sometimes abbreviated to NSF.
1088
+ INSUFFICIENT_FUND = :insufficient_fund
1089
+
1090
+ # Code R03. The account does not exist or the receiving bank was unable to locate it.
1091
+ NO_ACCOUNT = :no_account
1092
+
1093
+ # Code R02. The account is closed at the receiving bank.
1094
+ ACCOUNT_CLOSED = :account_closed
1095
+
1096
+ # Code R04. The account number is invalid at the receiving bank.
1097
+ INVALID_ACCOUNT_NUMBER_STRUCTURE = :invalid_account_number_structure
1098
+
1099
+ # Code R16. The account at the receiving bank was frozen per the Office of Foreign Assets Control.
1100
+ ACCOUNT_FROZEN_ENTRY_RETURNED_PER_OFAC_INSTRUCTION = :account_frozen_entry_returned_per_ofac_instruction
1101
+
1102
+ # Code R23. The receiving bank account refused a credit transfer.
1103
+ CREDIT_ENTRY_REFUSED_BY_RECEIVER = :credit_entry_refused_by_receiver
1104
+
1105
+ # Code R05. The receiving bank rejected because of an incorrect Standard Entry Class code.
1106
+ UNAUTHORIZED_DEBIT_TO_CONSUMER_ACCOUNT_USING_CORPORATE_SEC_CODE =
1107
+ :unauthorized_debit_to_consumer_account_using_corporate_sec_code
1108
+
1109
+ # Code R29. The corporate customer at the receiving bank reversed the transfer.
1110
+ CORPORATE_CUSTOMER_ADVISED_NOT_AUTHORIZED = :corporate_customer_advised_not_authorized
1111
+
1112
+ # Code R08. The receiving bank stopped payment on this transfer.
1113
+ PAYMENT_STOPPED = :payment_stopped
1114
+
1115
+ # Code R20. The receiving bank account does not perform transfers.
1116
+ NON_TRANSACTION_ACCOUNT = :non_transaction_account
1117
+
1118
+ # Code R09. The receiving bank account does not have enough available balance for the transfer.
1119
+ UNCOLLECTED_FUNDS = :uncollected_funds
1120
+
1121
+ # Code R28. The routing number is incorrect.
1122
+ ROUTING_NUMBER_CHECK_DIGIT_ERROR = :routing_number_check_digit_error
1123
+
1124
+ # Code R10. The customer at the receiving bank reversed the transfer.
1125
+ CUSTOMER_ADVISED_UNAUTHORIZED_IMPROPER_INELIGIBLE_OR_INCOMPLETE =
1126
+ :customer_advised_unauthorized_improper_ineligible_or_incomplete
1127
+
1128
+ # Code R19. The amount field is incorrect or too large.
1129
+ AMOUNT_FIELD_ERROR = :amount_field_error
1130
+
1131
+ # Code R07. The customer at the receiving institution informed their bank that they have revoked authorization for a previously authorized transfer.
1132
+ AUTHORIZATION_REVOKED_BY_CUSTOMER = :authorization_revoked_by_customer
1133
+
1134
+ # Code R13. The routing number is invalid.
1135
+ INVALID_ACH_ROUTING_NUMBER = :invalid_ach_routing_number
1136
+
1137
+ # Code R17. The receiving bank is unable to process a field in the transfer.
1138
+ FILE_RECORD_EDIT_CRITERIA = :file_record_edit_criteria
1139
+
1140
+ # Code R45. The individual name field was invalid.
1141
+ ENR_INVALID_INDIVIDUAL_NAME = :enr_invalid_individual_name
1142
+
1143
+ # Code R06. The originating financial institution asked for this transfer to be returned. The receiving bank is complying with the request.
1144
+ RETURNED_PER_ODFI_REQUEST = :returned_per_odfi_request
1145
+
1146
+ # Code R34. The receiving bank's regulatory supervisor has limited their participation in the ACH network.
1147
+ LIMITED_PARTICIPATION_DFI = :limited_participation_dfi
1148
+
1149
+ # Code R85. The outbound international ACH transfer was incorrect.
1150
+ INCORRECTLY_CODED_OUTBOUND_INTERNATIONAL_PAYMENT = :incorrectly_coded_outbound_international_payment
1151
+
1152
+ # Code R12. A rare return reason. The account was sold to another bank.
1153
+ ACCOUNT_SOLD_TO_ANOTHER_DFI = :account_sold_to_another_dfi
1154
+
1155
+ # Code R25. The addenda record is incorrect or missing.
1156
+ ADDENDA_ERROR = :addenda_error
1157
+
1158
+ # Code R15. A rare return reason. The account holder is deceased.
1159
+ BENEFICIARY_OR_ACCOUNT_HOLDER_DECEASED = :beneficiary_or_account_holder_deceased
1160
+
1161
+ # Code R11. A rare return reason. The customer authorized some payment to the sender, but this payment was not in error.
1162
+ CUSTOMER_ADVISED_NOT_WITHIN_AUTHORIZATION_TERMS = :customer_advised_not_within_authorization_terms
1163
+
1164
+ # Code R74. A rare return reason. Sent in response to a return that was returned with code `field_error`. The latest return should include the corrected field(s).
1165
+ CORRECTED_RETURN = :corrected_return
1166
+
1167
+ # Code R24. A rare return reason. The receiving bank received an exact duplicate entry with the same trace number and amount.
1168
+ DUPLICATE_ENTRY = :duplicate_entry
1169
+
1170
+ # Code R67. A rare return reason. The return this message refers to was a duplicate.
1171
+ DUPLICATE_RETURN = :duplicate_return
1172
+
1173
+ # Code R47. A rare return reason. Only used for US Government agency non-monetary automatic enrollment messages.
1174
+ ENR_DUPLICATE_ENROLLMENT = :enr_duplicate_enrollment
1175
+
1176
+ # Code R43. A rare return reason. Only used for US Government agency non-monetary automatic enrollment messages.
1177
+ ENR_INVALID_DFI_ACCOUNT_NUMBER = :enr_invalid_dfi_account_number
1178
+
1179
+ # Code R44. A rare return reason. Only used for US Government agency non-monetary automatic enrollment messages.
1180
+ ENR_INVALID_INDIVIDUAL_ID_NUMBER = :enr_invalid_individual_id_number
1181
+
1182
+ # Code R46. A rare return reason. Only used for US Government agency non-monetary automatic enrollment messages.
1183
+ ENR_INVALID_REPRESENTATIVE_PAYEE_INDICATOR = :enr_invalid_representative_payee_indicator
1184
+
1185
+ # Code R41. A rare return reason. Only used for US Government agency non-monetary automatic enrollment messages.
1186
+ ENR_INVALID_TRANSACTION_CODE = :enr_invalid_transaction_code
1187
+
1188
+ # Code R40. A rare return reason. Only used for US Government agency non-monetary automatic enrollment messages.
1189
+ ENR_RETURN_OF_ENR_ENTRY = :enr_return_of_enr_entry
1190
+
1191
+ # Code R42. A rare return reason. Only used for US Government agency non-monetary automatic enrollment messages.
1192
+ ENR_ROUTING_NUMBER_CHECK_DIGIT_ERROR = :enr_routing_number_check_digit_error
1193
+
1194
+ # Code R84. A rare return reason. The International ACH Transfer cannot be processed by the gateway.
1195
+ ENTRY_NOT_PROCESSED_BY_GATEWAY = :entry_not_processed_by_gateway
1196
+
1197
+ # Code R69. A rare return reason. One or more of the fields in the ACH were malformed.
1198
+ FIELD_ERROR = :field_error
1199
+
1200
+ # Code R83. A rare return reason. The Foreign receiving bank was unable to settle this ACH transfer.
1201
+ FOREIGN_RECEIVING_DFI_UNABLE_TO_SETTLE = :foreign_receiving_dfi_unable_to_settle
1202
+
1203
+ # Code R80. A rare return reason. The International ACH Transfer is malformed.
1204
+ IAT_ENTRY_CODING_ERROR = :iat_entry_coding_error
1205
+
1206
+ # Code R18. A rare return reason. The ACH has an improper effective entry date field.
1207
+ IMPROPER_EFFECTIVE_ENTRY_DATE = :improper_effective_entry_date
1208
+
1209
+ # Code R39. A rare return reason. The source document related to this ACH, usually an ACH check conversion, was presented to the bank.
1210
+ IMPROPER_SOURCE_DOCUMENT_SOURCE_DOCUMENT_PRESENTED = :improper_source_document_source_document_presented
1211
+
1212
+ # Code R21. A rare return reason. The Company ID field of the ACH was invalid.
1213
+ INVALID_COMPANY_ID = :invalid_company_id
1214
+
1215
+ # Code R82. A rare return reason. The foreign receiving bank identifier for an International ACH Transfer was invalid.
1216
+ INVALID_FOREIGN_RECEIVING_DFI_IDENTIFICATION = :invalid_foreign_receiving_dfi_identification
1217
+
1218
+ # Code R22. A rare return reason. The Individual ID number field of the ACH was invalid.
1219
+ INVALID_INDIVIDUAL_ID_NUMBER = :invalid_individual_id_number
1220
+
1221
+ # Code R53. A rare return reason. Both the Represented Check ("RCK") entry and the original check were presented to the bank.
1222
+ ITEM_AND_RCK_ENTRY_PRESENTED_FOR_PAYMENT = :item_and_rck_entry_presented_for_payment
1223
+
1224
+ # Code R51. A rare return reason. The Represented Check ("RCK") entry is ineligible.
1225
+ ITEM_RELATED_TO_RCK_ENTRY_IS_INELIGIBLE = :item_related_to_rck_entry_is_ineligible
1226
+
1227
+ # Code R26. A rare return reason. The ACH is missing a required field.
1228
+ MANDATORY_FIELD_ERROR = :mandatory_field_error
1229
+
1230
+ # Code R71. A rare return reason. The receiving bank does not recognize the routing number in a dishonored return entry.
1231
+ MISROUTED_DISHONORED_RETURN = :misrouted_dishonored_return
1232
+
1233
+ # Code R61. A rare return reason. The receiving bank does not recognize the routing number in a return entry.
1234
+ MISROUTED_RETURN = :misrouted_return
1235
+
1236
+ # Code R76. A rare return reason. Sent in response to a return, the bank does not find the errors alleged by the returning bank.
1237
+ NO_ERRORS_FOUND = :no_errors_found
1238
+
1239
+ # Code R77. A rare return reason. The receiving bank does not accept the return of the erroneous debit. The funds are not available at the receiving bank.
1240
+ NON_ACCEPTANCE_OF_R62_DISHONORED_RETURN = :non_acceptance_of_r62_dishonored_return
1241
+
1242
+ # Code R81. A rare return reason. The receiving bank does not accept International ACH Transfers.
1243
+ NON_PARTICIPANT_IN_IAT_PROGRAM = :non_participant_in_iat_program
1244
+
1245
+ # Code R31. A rare return reason. A return that has been agreed to be accepted by the receiving bank, despite falling outside of the usual return timeframe.
1246
+ PERMISSIBLE_RETURN_ENTRY = :permissible_return_entry
1247
+
1248
+ # Code R70. A rare return reason. The receiving bank had not approved this return.
1249
+ PERMISSIBLE_RETURN_ENTRY_NOT_ACCEPTED = :permissible_return_entry_not_accepted
1250
+
1251
+ # Code R32. A rare return reason. The receiving bank could not settle this transaction.
1252
+ RDFI_NON_SETTLEMENT = :rdfi_non_settlement
1253
+
1254
+ # Code R30. A rare return reason. The receiving bank does not accept Check Truncation ACH transfers.
1255
+ RDFI_PARTICIPANT_IN_CHECK_TRUNCATION_PROGRAM = :rdfi_participant_in_check_truncation_program
1256
+
1257
+ # Code R14. A rare return reason. The payee is deceased.
1258
+ REPRESENTATIVE_PAYEE_DECEASED_OR_UNABLE_TO_CONTINUE_IN_THAT_CAPACITY =
1259
+ :representative_payee_deceased_or_unable_to_continue_in_that_capacity
1260
+
1261
+ # Code R75. A rare return reason. The originating bank disputes that an earlier `duplicate_entry` return was actually a duplicate.
1262
+ RETURN_NOT_A_DUPLICATE = :return_not_a_duplicate
1263
+
1264
+ # Code R62. A rare return reason. The originating financial institution made a mistake and this return corrects it.
1265
+ RETURN_OF_ERRONEOUS_OR_REVERSING_DEBIT = :return_of_erroneous_or_reversing_debit
1266
+
1267
+ # Code R36. A rare return reason. Return of a malformed credit entry.
1268
+ RETURN_OF_IMPROPER_CREDIT_ENTRY = :return_of_improper_credit_entry
1269
+
1270
+ # Code R35. A rare return reason. Return of a malformed debit entry.
1271
+ RETURN_OF_IMPROPER_DEBIT_ENTRY = :return_of_improper_debit_entry
1272
+
1273
+ # Code R33. A rare return reason. Return of a Destroyed Check ("XKC") entry.
1274
+ RETURN_OF_XCK_ENTRY = :return_of_xck_entry
1275
+
1276
+ # Code R37. A rare return reason. The source document related to this ACH, usually an ACH check conversion, was presented to the bank.
1277
+ SOURCE_DOCUMENT_PRESENTED_FOR_PAYMENT = :source_document_presented_for_payment
1278
+
1279
+ # Code R50. A rare return reason. State law prevents the bank from accepting the Represented Check ("RCK") entry.
1280
+ STATE_LAW_AFFECTING_RCK_ACCEPTANCE = :state_law_affecting_rck_acceptance
1281
+
1282
+ # Code R52. A rare return reason. A stop payment was issued on a Represented Check ("RCK") entry.
1283
+ STOP_PAYMENT_ON_ITEM_RELATED_TO_RCK_ENTRY = :stop_payment_on_item_related_to_rck_entry
1284
+
1285
+ # Code R38. A rare return reason. The source attached to the ACH, usually an ACH check conversion, includes a stop payment.
1286
+ STOP_PAYMENT_ON_SOURCE_DOCUMENT = :stop_payment_on_source_document
1287
+
1288
+ # Code R73. A rare return reason. The bank receiving an `untimely_return` believes it was on time.
1289
+ TIMELY_ORIGINAL_RETURN = :timely_original_return
1290
+
1291
+ # Code R27. A rare return reason. An ACH return's trace number does not match an originated ACH.
1292
+ TRACE_NUMBER_ERROR = :trace_number_error
1293
+
1294
+ # Code R72. A rare return reason. The dishonored return was sent too late.
1295
+ UNTIMELY_DISHONORED_RETURN = :untimely_dishonored_return
1296
+
1297
+ # Code R68. A rare return reason. The return was sent too late.
1298
+ UNTIMELY_RETURN = :untimely_return
1299
+
1300
+ # @!method self.values
1301
+ # @return [Array<Symbol>]
1302
+ end
1303
+ end
1304
+
1305
+ # @see Increase::Models::ACHTransfer#settlement
1306
+ class Settlement < Increase::Internal::Type::BaseModel
1307
+ # @!attribute settled_at
1308
+ # When the funds for this transfer have settled at the destination bank at the
1309
+ # Federal Reserve.
1310
+ #
1311
+ # @return [Time]
1312
+ required :settled_at, Time
1313
+
1314
+ # @!method initialize(settled_at:)
1315
+ # Some parameter documentations has been truncated, see
1316
+ # {Increase::Models::ACHTransfer::Settlement} for more details.
1317
+ #
1318
+ # A subhash containing information about when and how the transfer settled at the
1319
+ # Federal Reserve.
1320
+ #
1321
+ # @param settled_at [Time] When the funds for this transfer have settled at the destination bank at the Fed
1322
+ end
1323
+
1324
+ # The Standard Entry Class (SEC) code to use for the transfer.
1325
+ #
1326
+ # @see Increase::Models::ACHTransfer#standard_entry_class_code
1327
+ module StandardEntryClassCode
1328
+ extend Increase::Internal::Type::Enum
1329
+
1330
+ # Corporate Credit and Debit (CCD).
1331
+ CORPORATE_CREDIT_OR_DEBIT = :corporate_credit_or_debit
1332
+
1333
+ # Corporate Trade Exchange (CTX).
1334
+ CORPORATE_TRADE_EXCHANGE = :corporate_trade_exchange
1335
+
1336
+ # Prearranged Payments and Deposits (PPD).
1337
+ PREARRANGED_PAYMENTS_AND_DEPOSIT = :prearranged_payments_and_deposit
1338
+
1339
+ # Internet Initiated (WEB).
1340
+ INTERNET_INITIATED = :internet_initiated
1341
+
1342
+ # @!method self.values
1343
+ # @return [Array<Symbol>]
1344
+ end
1345
+
1346
+ # The lifecycle status of the transfer.
1347
+ #
1348
+ # @see Increase::Models::ACHTransfer#status
1349
+ module Status
1350
+ extend Increase::Internal::Type::Enum
1351
+
1352
+ # The transfer is pending approval.
1353
+ PENDING_APPROVAL = :pending_approval
1354
+
1355
+ # The transfer belongs to a Transfer Session that is pending confirmation.
1356
+ PENDING_TRANSFER_SESSION_CONFIRMATION = :pending_transfer_session_confirmation
1357
+
1358
+ # The transfer has been canceled.
1359
+ CANCELED = :canceled
1360
+
1361
+ # The transfer is pending submission to the Federal Reserve.
1362
+ PENDING_SUBMISSION = :pending_submission
1363
+
1364
+ # The transfer is pending review by Increase.
1365
+ PENDING_REVIEWING = :pending_reviewing
1366
+
1367
+ # The transfer requires attention from an Increase operator.
1368
+ REQUIRES_ATTENTION = :requires_attention
1369
+
1370
+ # The transfer has been rejected.
1371
+ REJECTED = :rejected
1372
+
1373
+ # The transfer is complete.
1374
+ SUBMITTED = :submitted
1375
+
1376
+ # The transfer has been returned.
1377
+ RETURNED = :returned
1378
+
1379
+ # @!method self.values
1380
+ # @return [Array<Symbol>]
1381
+ end
1382
+
1383
+ # @see Increase::Models::ACHTransfer#submission
1384
+ class Submission < Increase::Internal::Type::BaseModel
1385
+ # @!attribute effective_date
1386
+ # The ACH transfer's effective date as sent to the Federal Reserve. If a specific
1387
+ # date was configured using `preferred_effective_date`, this will match that
1388
+ # value. Otherwise, it will be the date selected (following the specified
1389
+ # settlement schedule) at the time the transfer was submitted.
1390
+ #
1391
+ # @return [Date]
1392
+ required :effective_date, Date
1393
+
1394
+ # @!attribute expected_funds_settlement_at
1395
+ # When the transfer is expected to settle in the recipient's account. Credits may
1396
+ # be available sooner, at the receiving banks discretion. The FedACH schedule is
1397
+ # published
1398
+ # [here](https://www.frbservices.org/resources/resource-centers/same-day-ach/fedach-processing-schedule.html).
1399
+ #
1400
+ # @return [Time]
1401
+ required :expected_funds_settlement_at, Time
1402
+
1403
+ # @!attribute expected_settlement_schedule
1404
+ # The settlement schedule the transfer is expected to follow. This expectation
1405
+ # takes into account the `effective_date`, `submitted_at`, and the amount of the
1406
+ # transfer.
1407
+ #
1408
+ # @return [Symbol, Increase::Models::ACHTransfer::Submission::ExpectedSettlementSchedule]
1409
+ required :expected_settlement_schedule,
1410
+ enum: -> { Increase::ACHTransfer::Submission::ExpectedSettlementSchedule }
1411
+
1412
+ # @!attribute submitted_at
1413
+ # When the ACH transfer was sent to FedACH.
1414
+ #
1415
+ # @return [Time]
1416
+ required :submitted_at, Time
1417
+
1418
+ # @!attribute trace_number
1419
+ # A 15 digit number recorded in the Nacha file and transmitted to the receiving
1420
+ # bank. Along with the amount, date, and originating routing number, this can be
1421
+ # used to identify the ACH transfer at the receiving bank. ACH trace numbers are
1422
+ # not unique, but are
1423
+ # [used to correlate returns](https://increase.com/documentation/ach-returns#ach-returns).
1424
+ #
1425
+ # @return [String]
1426
+ required :trace_number, String
1427
+
1428
+ # @!method initialize(effective_date:, expected_funds_settlement_at:, expected_settlement_schedule:, submitted_at:, trace_number:)
1429
+ # Some parameter documentations has been truncated, see
1430
+ # {Increase::Models::ACHTransfer::Submission} for more details.
1431
+ #
1432
+ # After the transfer is submitted to FedACH, this will contain supplemental
1433
+ # details. Increase batches transfers and submits a file to the Federal Reserve
1434
+ # roughly every 30 minutes. The Federal Reserve processes ACH transfers during
1435
+ # weekdays according to their
1436
+ # [posted schedule](https://www.frbservices.org/resources/resource-centers/same-day-ach/fedach-processing-schedule.html).
1437
+ #
1438
+ # @param effective_date [Date] The ACH transfer's effective date as sent to the Federal Reserve. If a specific
1439
+ #
1440
+ # @param expected_funds_settlement_at [Time] When the transfer is expected to settle in the recipient's account. Credits may
1441
+ #
1442
+ # @param expected_settlement_schedule [Symbol, Increase::Models::ACHTransfer::Submission::ExpectedSettlementSchedule] The settlement schedule the transfer is expected to follow. This expectation tak
1443
+ #
1444
+ # @param submitted_at [Time] When the ACH transfer was sent to FedACH.
1445
+ #
1446
+ # @param trace_number [String] A 15 digit number recorded in the Nacha file and transmitted to the receiving ba
1447
+
1448
+ # The settlement schedule the transfer is expected to follow. This expectation
1449
+ # takes into account the `effective_date`, `submitted_at`, and the amount of the
1450
+ # transfer.
1451
+ #
1452
+ # @see Increase::Models::ACHTransfer::Submission#expected_settlement_schedule
1453
+ module ExpectedSettlementSchedule
1454
+ extend Increase::Internal::Type::Enum
1455
+
1456
+ # The transfer is expected to settle same-day.
1457
+ SAME_DAY = :same_day
1458
+
1459
+ # The transfer is expected to settle on a future date.
1460
+ FUTURE_DATED = :future_dated
1461
+
1462
+ # @!method self.values
1463
+ # @return [Array<Symbol>]
1464
+ end
1465
+ end
1466
+
1467
+ # A constant representing the object's type. For this resource it will always be
1468
+ # `ach_transfer`.
1469
+ #
1470
+ # @see Increase::Models::ACHTransfer#type
1471
+ module Type
1472
+ extend Increase::Internal::Type::Enum
1473
+
1474
+ ACH_TRANSFER = :ach_transfer
1475
+
1476
+ # @!method self.values
1477
+ # @return [Array<Symbol>]
1478
+ end
1479
+ end
1480
+ end
1481
+ end