increase 1.340.0 → 1.342.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (348) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +1 -1
  3. data/lib/increase/client.rb +8 -6
  4. data/lib/increase/internal/type/converter.rb +13 -12
  5. data/lib/increase/models/account.rb +40 -19
  6. data/lib/increase/models/account_create_params.rb +14 -11
  7. data/lib/increase/models/account_list_params.rb +25 -17
  8. data/lib/increase/models/account_number.rb +22 -14
  9. data/lib/increase/models/account_number_create_params.rb +12 -13
  10. data/lib/increase/models/account_number_list_params.rb +26 -20
  11. data/lib/increase/models/account_number_update_params.rb +12 -11
  12. data/lib/increase/models/account_statement.rb +15 -11
  13. data/lib/increase/models/account_statement_list_params.rb +15 -12
  14. data/lib/increase/models/account_transfer.rb +58 -29
  15. data/lib/increase/models/account_transfer_create_params.rb +12 -7
  16. data/lib/increase/models/account_transfer_list_params.rb +20 -12
  17. data/lib/increase/models/ach_prenotification.rb +49 -28
  18. data/lib/increase/models/ach_prenotification_create_params.rb +15 -8
  19. data/lib/increase/models/ach_prenotification_list_params.rb +20 -12
  20. data/lib/increase/models/ach_transfer.rb +220 -105
  21. data/lib/increase/models/ach_transfer_create_params.rb +110 -61
  22. data/lib/increase/models/ach_transfer_list_params.rb +23 -16
  23. data/lib/increase/models/balance_lookup.rb +14 -11
  24. data/lib/increase/models/beneficial_owner_create_params.rb +60 -46
  25. data/lib/increase/models/beneficial_owner_list_params.rb +11 -6
  26. data/lib/increase/models/beneficial_owner_update_params.rb +56 -40
  27. data/lib/increase/models/card.rb +69 -47
  28. data/lib/increase/models/card_create_details_iframe_params.rb +3 -4
  29. data/lib/increase/models/card_create_params.rb +65 -56
  30. data/lib/increase/models/card_details.rb +7 -5
  31. data/lib/increase/models/card_dispute.rb +530 -306
  32. data/lib/increase/models/card_dispute_create_params.rb +271 -175
  33. data/lib/increase/models/card_dispute_list_params.rb +24 -16
  34. data/lib/increase/models/card_dispute_submit_user_submission_params.rb +288 -191
  35. data/lib/increase/models/card_iframe_url.rb +3 -4
  36. data/lib/increase/models/card_list_params.rb +23 -16
  37. data/lib/increase/models/card_payment.rb +1941 -1200
  38. data/lib/increase/models/card_payment_list_params.rb +15 -11
  39. data/lib/increase/models/card_purchase_supplement.rb +37 -25
  40. data/lib/increase/models/card_purchase_supplement_list_params.rb +18 -13
  41. data/lib/increase/models/card_push_transfer.rb +121 -65
  42. data/lib/increase/models/card_push_transfer_create_params.rb +55 -25
  43. data/lib/increase/models/card_push_transfer_list_params.rb +23 -16
  44. data/lib/increase/models/card_token.rb +9 -6
  45. data/lib/increase/models/card_token_capabilities.rb +11 -8
  46. data/lib/increase/models/card_token_list_params.rb +15 -11
  47. data/lib/increase/models/card_update_params.rb +65 -57
  48. data/lib/increase/models/card_validation.rb +76 -43
  49. data/lib/increase/models/card_validation_create_params.rb +11 -7
  50. data/lib/increase/models/card_validation_list_params.rb +23 -16
  51. data/lib/increase/models/check_deposit.rb +103 -52
  52. data/lib/increase/models/check_deposit_create_params.rb +2 -4
  53. data/lib/increase/models/check_deposit_list_params.rb +20 -12
  54. data/lib/increase/models/check_transfer.rb +127 -76
  55. data/lib/increase/models/check_transfer_create_params.rb +91 -51
  56. data/lib/increase/models/check_transfer_list_params.rb +24 -16
  57. data/lib/increase/models/check_transfer_stop_payment_params.rb +2 -1
  58. data/lib/increase/models/declined_transaction.rb +339 -206
  59. data/lib/increase/models/declined_transaction_list_params.rb +18 -15
  60. data/lib/increase/models/digital_card_profile.rb +16 -9
  61. data/lib/increase/models/digital_card_profile_clone_params.rb +2 -1
  62. data/lib/increase/models/digital_card_profile_create_params.rb +2 -1
  63. data/lib/increase/models/digital_card_profile_list_params.rb +12 -9
  64. data/lib/increase/models/digital_wallet_token.rb +26 -17
  65. data/lib/increase/models/digital_wallet_token_list_params.rb +15 -11
  66. data/lib/increase/models/entity.rb +175 -135
  67. data/lib/increase/models/entity_archive_params.rb +3 -4
  68. data/lib/increase/models/entity_beneficial_owner.rb +24 -19
  69. data/lib/increase/models/entity_create_params.rb +395 -290
  70. data/lib/increase/models/entity_list_params.rb +67 -16
  71. data/lib/increase/models/entity_onboarding_session.rb +25 -11
  72. data/lib/increase/models/entity_onboarding_session_create_params.rb +8 -5
  73. data/lib/increase/models/entity_onboarding_session_list_params.rb +12 -9
  74. data/lib/increase/models/entity_supplemental_document.rb +10 -6
  75. data/lib/increase/models/entity_update_params.rb +136 -104
  76. data/lib/increase/models/event.rb +14 -5
  77. data/lib/increase/models/event_list_params.rb +31 -17
  78. data/lib/increase/models/event_subscription.rb +25 -9
  79. data/lib/increase/models/event_subscription_create_params.rb +22 -8
  80. data/lib/increase/models/event_subscription_list_params.rb +8 -5
  81. data/lib/increase/models/event_subscription_update_params.rb +2 -1
  82. data/lib/increase/models/export.rb +69 -30
  83. data/lib/increase/models/export_create_params.rb +76 -46
  84. data/lib/increase/models/export_list_params.rb +26 -17
  85. data/lib/increase/models/external_account.rb +14 -8
  86. data/lib/increase/models/external_account_create_params.rb +7 -6
  87. data/lib/increase/models/external_account_list_params.rb +12 -9
  88. data/lib/increase/models/external_account_update_params.rb +6 -3
  89. data/lib/increase/models/fednow_transfer.rb +62 -32
  90. data/lib/increase/models/fednow_transfer_create_params.rb +11 -8
  91. data/lib/increase/models/fednow_transfer_list_params.rb +25 -17
  92. data/lib/increase/models/file.rb +13 -7
  93. data/lib/increase/models/file_create_params.rb +6 -5
  94. data/lib/increase/models/file_link.rb +17 -8
  95. data/lib/increase/models/file_link_create_params.rb +3 -4
  96. data/lib/increase/models/file_list_params.rb +23 -16
  97. data/lib/increase/models/group.rb +6 -5
  98. data/lib/increase/models/inbound_ach_transfer.rb +115 -51
  99. data/lib/increase/models/inbound_ach_transfer_create_notification_of_change_params.rb +3 -5
  100. data/lib/increase/models/inbound_ach_transfer_decline_params.rb +4 -4
  101. data/lib/increase/models/inbound_ach_transfer_list_params.rb +21 -16
  102. data/lib/increase/models/inbound_ach_transfer_transfer_return_params.rb +6 -5
  103. data/lib/increase/models/inbound_check_deposit.rb +46 -19
  104. data/lib/increase/models/inbound_check_deposit_list_params.rb +18 -12
  105. data/lib/increase/models/inbound_check_deposit_return_params.rb +2 -1
  106. data/lib/increase/models/inbound_fednow_transfer.rb +28 -14
  107. data/lib/increase/models/inbound_fednow_transfer_list_params.rb +18 -12
  108. data/lib/increase/models/inbound_fednow_transfer_retrieve_params.rb +2 -1
  109. data/lib/increase/models/inbound_mail_item.rb +13 -8
  110. data/lib/increase/models/inbound_mail_item_action_params.rb +4 -2
  111. data/lib/increase/models/inbound_mail_item_list_params.rb +17 -12
  112. data/lib/increase/models/inbound_real_time_payments_transfer.rb +21 -12
  113. data/lib/increase/models/inbound_real_time_payments_transfer_list_params.rb +21 -14
  114. data/lib/increase/models/inbound_real_time_payments_transfer_retrieve_params.rb +2 -1
  115. data/lib/increase/models/inbound_wire_drawdown_request.rb +23 -10
  116. data/lib/increase/models/inbound_wire_drawdown_request_list_params.rb +3 -4
  117. data/lib/increase/models/inbound_wire_drawdown_request_retrieve_params.rb +2 -1
  118. data/lib/increase/models/inbound_wire_transfer.rb +51 -22
  119. data/lib/increase/models/inbound_wire_transfer_list_params.rb +24 -17
  120. data/lib/increase/models/inbound_wire_transfer_reverse_params.rb +2 -1
  121. data/lib/increase/models/intrafi_account_enrollment.rb +16 -8
  122. data/lib/increase/models/intrafi_account_enrollment_list_params.rb +12 -9
  123. data/lib/increase/models/intrafi_account_enrollment_retrieve_params.rb +2 -1
  124. data/lib/increase/models/intrafi_account_enrollment_unenroll_params.rb +2 -1
  125. data/lib/increase/models/intrafi_balance.rb +18 -12
  126. data/lib/increase/models/intrafi_exclusion.rb +13 -7
  127. data/lib/increase/models/intrafi_exclusion_archive_params.rb +4 -4
  128. data/lib/increase/models/intrafi_exclusion_create_params.rb +5 -4
  129. data/lib/increase/models/intrafi_exclusion_list_params.rb +8 -5
  130. data/lib/increase/models/lockbox_address.rb +16 -11
  131. data/lib/increase/models/lockbox_address_list_params.rb +20 -12
  132. data/lib/increase/models/lockbox_address_update_params.rb +2 -1
  133. data/lib/increase/models/lockbox_recipient.rb +22 -10
  134. data/lib/increase/models/lockbox_recipient_create_params.rb +5 -5
  135. data/lib/increase/models/lockbox_recipient_list_params.rb +22 -13
  136. data/lib/increase/models/lockbox_recipient_update_params.rb +2 -1
  137. data/lib/increase/models/oauth_application.rb +12 -7
  138. data/lib/increase/models/oauth_application_list_params.rb +18 -15
  139. data/lib/increase/models/oauth_connection.rb +9 -6
  140. data/lib/increase/models/oauth_connection_list_params.rb +10 -9
  141. data/lib/increase/models/oauth_token.rb +6 -5
  142. data/lib/increase/models/oauth_token_create_params.rb +14 -7
  143. data/lib/increase/models/pending_transaction.rb +392 -239
  144. data/lib/increase/models/pending_transaction_create_params.rb +6 -6
  145. data/lib/increase/models/pending_transaction_list_params.rb +23 -19
  146. data/lib/increase/models/physical_card.rb +36 -24
  147. data/lib/increase/models/physical_card_create_params.rb +22 -17
  148. data/lib/increase/models/physical_card_list_params.rb +20 -12
  149. data/lib/increase/models/physical_card_profile.rb +33 -17
  150. data/lib/increase/models/physical_card_profile_clone_params.rb +9 -9
  151. data/lib/increase/models/physical_card_profile_create_params.rb +9 -9
  152. data/lib/increase/models/physical_card_profile_list_params.rb +12 -9
  153. data/lib/increase/models/physical_card_update_params.rb +2 -1
  154. data/lib/increase/models/program.rb +15 -8
  155. data/lib/increase/models/program_list_params.rb +3 -4
  156. data/lib/increase/models/real_time_decision.rb +561 -370
  157. data/lib/increase/models/real_time_decision_action_params.rb +86 -75
  158. data/lib/increase/models/real_time_payments_transfer.rb +90 -47
  159. data/lib/increase/models/real_time_payments_transfer_approve_params.rb +2 -1
  160. data/lib/increase/models/real_time_payments_transfer_cancel_params.rb +2 -1
  161. data/lib/increase/models/real_time_payments_transfer_create_params.rb +24 -12
  162. data/lib/increase/models/real_time_payments_transfer_list_params.rb +28 -19
  163. data/lib/increase/models/routing_number_list_params.rb +3 -4
  164. data/lib/increase/models/routing_number_list_response.rb +11 -8
  165. data/lib/increase/models/simulations/account_revenue_payment_create_params.rb +9 -7
  166. data/lib/increase/models/simulations/ach_transfer_create_notification_of_change_params.rb +5 -6
  167. data/lib/increase/models/simulations/ach_transfer_return_params.rb +18 -6
  168. data/lib/increase/models/simulations/ach_transfer_settle_params.rb +4 -4
  169. data/lib/increase/models/simulations/card_authentication_create_params.rb +10 -8
  170. data/lib/increase/models/simulations/card_authorization_create_params.rb +50 -27
  171. data/lib/increase/models/simulations/card_authorization_create_response.rb +11 -7
  172. data/lib/increase/models/simulations/card_balance_inquiry_create_params.rb +26 -13
  173. data/lib/increase/models/simulations/card_dispute_action_params.rb +39 -19
  174. data/lib/increase/models/simulations/card_fuel_confirmation_create_params.rb +3 -5
  175. data/lib/increase/models/simulations/card_increment_create_params.rb +5 -4
  176. data/lib/increase/models/simulations/card_purchase_supplement_create_params.rb +7 -7
  177. data/lib/increase/models/simulations/card_refund_create_params.rb +10 -6
  178. data/lib/increase/models/simulations/card_reversal_create_params.rb +3 -4
  179. data/lib/increase/models/simulations/card_settlement_create_params.rb +16 -13
  180. data/lib/increase/models/simulations/card_token_create_params.rb +18 -9
  181. data/lib/increase/models/simulations/check_deposit_adjustment_params.rb +8 -5
  182. data/lib/increase/models/simulations/check_deposit_submit_params.rb +9 -10
  183. data/lib/increase/models/simulations/digital_wallet_token_request_create_response.rb +9 -7
  184. data/lib/increase/models/simulations/entity_onboarding_session_submit_params.rb +2 -1
  185. data/lib/increase/models/simulations/entity_update_validation_params.rb +5 -5
  186. data/lib/increase/models/simulations/export_create_params.rb +5 -5
  187. data/lib/increase/models/simulations/inbound_ach_transfer_create_params.rb +20 -12
  188. data/lib/increase/models/simulations/inbound_check_deposit_adjustment_params.rb +5 -6
  189. data/lib/increase/models/simulations/inbound_check_deposit_create_params.rb +6 -6
  190. data/lib/increase/models/simulations/inbound_mail_item_create_params.rb +9 -6
  191. data/lib/increase/models/simulations/inbound_real_time_payments_transfer_create_params.rb +5 -6
  192. data/lib/increase/models/simulations/inbound_wire_drawdown_request_create_params.rb +27 -13
  193. data/lib/increase/models/simulations/inbound_wire_transfer_create_params.rb +45 -19
  194. data/lib/increase/models/simulations/interest_payment_create_params.rb +4 -5
  195. data/lib/increase/models/simulations/pending_transaction_release_inbound_funds_hold_params.rb +3 -5
  196. data/lib/increase/models/simulations/physical_card_advance_shipment_params.rb +2 -1
  197. data/lib/increase/models/simulations/physical_card_create_params.rb +5 -5
  198. data/lib/increase/models/simulations/program_create_params.rb +4 -5
  199. data/lib/increase/models/simulations/real_time_payments_transfer_complete_params.rb +6 -3
  200. data/lib/increase/models/supplemental_document_list_params.rb +8 -5
  201. data/lib/increase/models/swift_transfer.rb +60 -27
  202. data/lib/increase/models/swift_transfer_create_params.rb +40 -20
  203. data/lib/increase/models/swift_transfer_list_params.rb +23 -16
  204. data/lib/increase/models/transaction.rb +1016 -536
  205. data/lib/increase/models/transaction_list_params.rb +21 -16
  206. data/lib/increase/models/unwrap_webhook_event.rb +14 -5
  207. data/lib/increase/models/wire_drawdown_request.rb +44 -26
  208. data/lib/increase/models/wire_drawdown_request_create_params.rb +23 -19
  209. data/lib/increase/models/wire_drawdown_request_list_params.rb +12 -9
  210. data/lib/increase/models/wire_transfer.rb +100 -55
  211. data/lib/increase/models/wire_transfer_create_params.rb +43 -26
  212. data/lib/increase/models/wire_transfer_list_params.rb +23 -16
  213. data/lib/increase/resources/account_numbers.rb +20 -16
  214. data/lib/increase/resources/account_statements.rb +3 -4
  215. data/lib/increase/resources/account_transfers.rb +20 -12
  216. data/lib/increase/resources/accounts.rb +19 -12
  217. data/lib/increase/resources/ach_prenotifications.rb +23 -13
  218. data/lib/increase/resources/ach_transfers.rb +93 -43
  219. data/lib/increase/resources/beneficial_owners.rb +35 -19
  220. data/lib/increase/resources/card_disputes.rb +43 -22
  221. data/lib/increase/resources/card_payments.rb +3 -4
  222. data/lib/increase/resources/card_purchase_supplements.rb +6 -5
  223. data/lib/increase/resources/card_push_transfers.rb +55 -24
  224. data/lib/increase/resources/card_tokens.rb +3 -4
  225. data/lib/increase/resources/card_validations.rb +19 -12
  226. data/lib/increase/resources/cards.rb +33 -22
  227. data/lib/increase/resources/check_deposits.rb +10 -9
  228. data/lib/increase/resources/check_transfers.rb +37 -17
  229. data/lib/increase/resources/declined_transactions.rb +3 -4
  230. data/lib/increase/resources/digital_card_profiles.rb +12 -7
  231. data/lib/increase/resources/digital_wallet_tokens.rb +3 -4
  232. data/lib/increase/resources/entities.rb +69 -33
  233. data/lib/increase/resources/entity_onboarding_sessions.rb +16 -10
  234. data/lib/increase/resources/event_subscriptions.rb +22 -13
  235. data/lib/increase/resources/events.rb +10 -9
  236. data/lib/increase/resources/exports.rb +40 -22
  237. data/lib/increase/resources/external_accounts.rb +21 -14
  238. data/lib/increase/resources/fednow_transfers.rb +21 -14
  239. data/lib/increase/resources/file_links.rb +3 -4
  240. data/lib/increase/resources/files.rb +14 -10
  241. data/lib/increase/resources/inbound_ach_transfers.rb +18 -19
  242. data/lib/increase/resources/inbound_check_deposits.rb +8 -6
  243. data/lib/increase/resources/inbound_fednow_transfers.rb +8 -6
  244. data/lib/increase/resources/inbound_mail_items.rb +7 -6
  245. data/lib/increase/resources/inbound_real_time_payments_transfers.rb +11 -7
  246. data/lib/increase/resources/inbound_wire_drawdown_requests.rb +5 -5
  247. data/lib/increase/resources/inbound_wire_transfers.rb +10 -7
  248. data/lib/increase/resources/intrafi_account_enrollments.rb +12 -7
  249. data/lib/increase/resources/intrafi_exclusions.rb +17 -13
  250. data/lib/increase/resources/lockbox_addresses.rb +10 -6
  251. data/lib/increase/resources/lockbox_recipients.rb +17 -12
  252. data/lib/increase/resources/oauth_applications.rb +3 -4
  253. data/lib/increase/resources/oauth_connections.rb +6 -5
  254. data/lib/increase/resources/oauth_tokens.rb +14 -7
  255. data/lib/increase/resources/pending_transactions.rb +7 -8
  256. data/lib/increase/resources/physical_card_profiles.rb +18 -15
  257. data/lib/increase/resources/physical_cards.rb +17 -12
  258. data/lib/increase/resources/programs.rb +3 -4
  259. data/lib/increase/resources/real_time_decisions.rb +18 -9
  260. data/lib/increase/resources/real_time_payments_transfers.rb +41 -21
  261. data/lib/increase/resources/routing_numbers.rb +3 -4
  262. data/lib/increase/resources/simulations/account_revenue_payments.rb +9 -7
  263. data/lib/increase/resources/simulations/ach_transfers.rb +18 -15
  264. data/lib/increase/resources/simulations/card_authentications.rb +10 -8
  265. data/lib/increase/resources/simulations/card_authorizations.rb +28 -12
  266. data/lib/increase/resources/simulations/card_balance_inquiries.rb +22 -11
  267. data/lib/increase/resources/simulations/card_disputes.rb +6 -5
  268. data/lib/increase/resources/simulations/card_fuel_confirmations.rb +3 -5
  269. data/lib/increase/resources/simulations/card_increments.rb +5 -4
  270. data/lib/increase/resources/simulations/card_purchase_supplements.rb +7 -7
  271. data/lib/increase/resources/simulations/card_refunds.rb +10 -6
  272. data/lib/increase/resources/simulations/card_reversals.rb +3 -4
  273. data/lib/increase/resources/simulations/card_settlements.rb +8 -6
  274. data/lib/increase/resources/simulations/card_tokens.rb +6 -3
  275. data/lib/increase/resources/simulations/check_deposits.rb +11 -9
  276. data/lib/increase/resources/simulations/entities.rb +3 -4
  277. data/lib/increase/resources/simulations/entity_onboarding_sessions.rb +2 -1
  278. data/lib/increase/resources/simulations/exports.rb +5 -5
  279. data/lib/increase/resources/simulations/inbound_ach_transfers.rb +14 -9
  280. data/lib/increase/resources/simulations/inbound_check_deposits.rb +11 -12
  281. data/lib/increase/resources/simulations/inbound_mail_items.rb +9 -6
  282. data/lib/increase/resources/simulations/inbound_real_time_payments_transfers.rb +5 -6
  283. data/lib/increase/resources/simulations/inbound_wire_drawdown_requests.rb +27 -13
  284. data/lib/increase/resources/simulations/inbound_wire_transfers.rb +45 -19
  285. data/lib/increase/resources/simulations/interest_payments.rb +4 -5
  286. data/lib/increase/resources/simulations/pending_transactions.rb +3 -5
  287. data/lib/increase/resources/simulations/physical_cards.rb +7 -6
  288. data/lib/increase/resources/simulations/programs.rb +4 -2
  289. data/lib/increase/resources/simulations/real_time_payments_transfers.rb +4 -2
  290. data/lib/increase/resources/supplemental_documents.rb +8 -5
  291. data/lib/increase/resources/swift_transfers.rb +33 -17
  292. data/lib/increase/resources/transactions.rb +6 -5
  293. data/lib/increase/resources/wire_drawdown_requests.rb +23 -14
  294. data/lib/increase/resources/wire_transfers.rb +29 -16
  295. data/lib/increase/version.rb +1 -1
  296. data/rbi/increase/models/ach_prenotification.rbi +1 -1
  297. data/rbi/increase/models/ach_transfer.rbi +19 -1
  298. data/rbi/increase/models/beneficial_owner_create_params.rbi +13 -8
  299. data/rbi/increase/models/beneficial_owner_update_params.rbi +13 -8
  300. data/rbi/increase/models/check_transfer.rbi +12 -2
  301. data/rbi/increase/models/check_transfer_create_params.rbi +35 -36
  302. data/rbi/increase/models/entity_create_params.rbi +78 -48
  303. data/rbi/increase/models/entity_list_params.rbi +119 -0
  304. data/rbi/increase/models/entity_update_params.rbi +26 -16
  305. data/rbi/increase/models/event.rbi +14 -0
  306. data/rbi/increase/models/event_list_params.rbi +14 -0
  307. data/rbi/increase/models/event_subscription.rbi +14 -0
  308. data/rbi/increase/models/event_subscription_create_params.rbi +14 -0
  309. data/rbi/increase/models/inbound_wire_transfer.rbi +16 -0
  310. data/rbi/increase/models/pending_transaction_create_params.rbi +4 -4
  311. data/rbi/increase/models/simulations/ach_transfer_return_params.rbi +16 -1
  312. data/rbi/increase/models/simulations/card_settlement_create_params.rbi +17 -12
  313. data/rbi/increase/models/simulations/program_create_params.rbi +0 -7
  314. data/rbi/increase/models/swift_transfer.rbi +10 -0
  315. data/rbi/increase/models/swift_transfer_create_params.rbi +13 -0
  316. data/rbi/increase/models/transaction.rbi +19 -1
  317. data/rbi/increase/models/unwrap_webhook_event.rbi +14 -0
  318. data/rbi/increase/resources/entities.rbi +3 -0
  319. data/rbi/increase/resources/pending_transactions.rbi +2 -2
  320. data/rbi/increase/resources/simulations/ach_transfers.rbi +5 -0
  321. data/rbi/increase/resources/simulations/card_settlements.rbi +6 -5
  322. data/rbi/increase/resources/swift_transfers.rbi +4 -0
  323. data/sig/increase/models/ach_prenotification.rbs +1 -1
  324. data/sig/increase/models/ach_transfer.rbs +6 -1
  325. data/sig/increase/models/beneficial_owner_create_params.rbs +7 -5
  326. data/sig/increase/models/beneficial_owner_update_params.rbs +7 -5
  327. data/sig/increase/models/check_transfer.rbs +5 -0
  328. data/sig/increase/models/check_transfer_create_params.rbs +12 -9
  329. data/sig/increase/models/entity_create_params.rbs +42 -30
  330. data/sig/increase/models/entity_list_params.rbs +48 -1
  331. data/sig/increase/models/entity_update_params.rbs +14 -10
  332. data/sig/increase/models/event.rbs +8 -0
  333. data/sig/increase/models/event_list_params.rbs +8 -0
  334. data/sig/increase/models/event_subscription.rbs +8 -0
  335. data/sig/increase/models/event_subscription_create_params.rbs +8 -0
  336. data/sig/increase/models/inbound_wire_transfer.rbs +10 -0
  337. data/sig/increase/models/simulations/ach_transfer_return_params.rbs +8 -1
  338. data/sig/increase/models/simulations/card_settlement_create_params.rbs +7 -5
  339. data/sig/increase/models/simulations/program_create_params.rbs +1 -8
  340. data/sig/increase/models/swift_transfer.rbs +5 -0
  341. data/sig/increase/models/swift_transfer_create_params.rbs +7 -0
  342. data/sig/increase/models/transaction.rbs +6 -1
  343. data/sig/increase/models/unwrap_webhook_event.rbs +8 -0
  344. data/sig/increase/resources/entities.rbs +1 -0
  345. data/sig/increase/resources/simulations/ach_transfers.rbs +1 -0
  346. data/sig/increase/resources/simulations/card_settlements.rbs +1 -1
  347. data/sig/increase/resources/swift_transfers.rbs +1 -0
  348. metadata +2 -2
@@ -3,34 +3,51 @@
3
3
  module Increase
4
4
  module Resources
5
5
  class Entities
6
- # Some parameter documentations has been truncated, see
7
- # {Increase::Models::EntityCreateParams} for more details.
8
- #
9
6
  # Create an Entity
10
7
  #
11
8
  # @overload create(structure:, corporation: nil, description: nil, government_authority: nil, joint: nil, natural_person: nil, risk_rating: nil, supplemental_documents: nil, terms_agreements: nil, third_party_verification: nil, trust: nil, request_options: {})
12
9
  #
13
10
  # @param structure [Symbol, Increase::Models::EntityCreateParams::Structure] The type of Entity to create.
14
11
  #
15
- # @param corporation [Increase::Models::EntityCreateParams::Corporation] Details of the corporation entity to create. Required if `structure` is equal to
12
+ # @param corporation [Increase::Models::EntityCreateParams::Corporation]
13
+ # Details of the corporation entity to create. Required if `structure` is equal to
14
+ # `corporation`.
16
15
  #
17
16
  # @param description [String] The description you choose to give the entity.
18
17
  #
19
- # @param government_authority [Increase::Models::EntityCreateParams::GovernmentAuthority] Details of the Government Authority entity to create. Required if `structure` is
18
+ # @param government_authority [Increase::Models::EntityCreateParams::GovernmentAuthority]
19
+ # Details of the Government Authority entity to create. Required if `structure` is
20
+ # equal to `government_authority`.
20
21
  #
21
- # @param joint [Increase::Models::EntityCreateParams::Joint] Details of the joint entity to create. Required if `structure` is equal to `join
22
+ # @param joint [Increase::Models::EntityCreateParams::Joint]
23
+ # Details of the joint entity to create. Required if `structure` is equal to
24
+ # `joint`.
22
25
  #
23
- # @param natural_person [Increase::Models::EntityCreateParams::NaturalPerson] Details of the natural person entity to create. Required if `structure` is equal
26
+ # @param natural_person [Increase::Models::EntityCreateParams::NaturalPerson]
27
+ # Details of the natural person entity to create. Required if `structure` is equal
28
+ # to `natural_person`. Natural people entities should be submitted with
29
+ # `social_security_number` or `individual_taxpayer_identification_number`
30
+ # identification methods.
24
31
  #
25
- # @param risk_rating [Increase::Models::EntityCreateParams::RiskRating] An assessment of the entity's potential risk of involvement in financial crimes,
32
+ # @param risk_rating [Increase::Models::EntityCreateParams::RiskRating]
33
+ # An assessment of the entity's potential risk of involvement in financial crimes,
34
+ # such as money laundering.
26
35
  #
27
- # @param supplemental_documents [Array<Increase::Models::EntityCreateParams::SupplementalDocument>] Additional documentation associated with the entity.
36
+ # @param supplemental_documents [Array<Increase::Models::EntityCreateParams::SupplementalDocument>]
37
+ # Additional documentation associated with the entity.
28
38
  #
29
- # @param terms_agreements [Array<Increase::Models::EntityCreateParams::TermsAgreement>] The terms that the Entity agreed to. Not all programs are required to submit thi
39
+ # @param terms_agreements [Array<Increase::Models::EntityCreateParams::TermsAgreement>]
40
+ # The terms that the Entity agreed to. Not all programs are required to submit
41
+ # this data.
30
42
  #
31
- # @param third_party_verification [Increase::Models::EntityCreateParams::ThirdPartyVerification] If you are using a third-party service for identity verification, you can use th
43
+ # @param third_party_verification [Increase::Models::EntityCreateParams::ThirdPartyVerification]
44
+ # If you are using a third-party service for identity verification, you can use
45
+ # this field to associate this Entity with the identifier that represents them in
46
+ # that service.
32
47
  #
33
- # @param trust [Increase::Models::EntityCreateParams::Trust] Details of the trust entity to create. Required if `structure` is equal to `trus
48
+ # @param trust [Increase::Models::EntityCreateParams::Trust]
49
+ # Details of the trust entity to create. Required if `structure` is equal to
50
+ # `trust`.
34
51
  #
35
52
  # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
36
53
  #
@@ -68,30 +85,45 @@ module Increase
68
85
  )
69
86
  end
70
87
 
71
- # Some parameter documentations has been truncated, see
72
- # {Increase::Models::EntityUpdateParams} for more details.
73
- #
74
88
  # Update an Entity
75
89
  #
76
90
  # @overload update(entity_id, corporation: nil, details_confirmed_at: nil, government_authority: nil, natural_person: nil, risk_rating: nil, terms_agreements: nil, third_party_verification: nil, trust: nil, request_options: {})
77
91
  #
78
92
  # @param entity_id [String] The entity identifier.
79
93
  #
80
- # @param corporation [Increase::Models::EntityUpdateParams::Corporation] Details of the corporation entity to update. If you specify this parameter and t
94
+ # @param corporation [Increase::Models::EntityUpdateParams::Corporation]
95
+ # Details of the corporation entity to update. If you specify this parameter and
96
+ # the entity is not a corporation, the request will fail.
81
97
  #
82
- # @param details_confirmed_at [Time] When your user last confirmed the Entity's details. Depending on your program, y
98
+ # @param details_confirmed_at [Time]
99
+ # When your user last confirmed the Entity's details. Depending on your program,
100
+ # you may be required to affirmatively confirm details with your users on an
101
+ # annual basis.
83
102
  #
84
- # @param government_authority [Increase::Models::EntityUpdateParams::GovernmentAuthority] Details of the government authority entity to update. If you specify this parame
103
+ # @param government_authority [Increase::Models::EntityUpdateParams::GovernmentAuthority]
104
+ # Details of the government authority entity to update. If you specify this
105
+ # parameter and the entity is not a government authority, the request will fail.
85
106
  #
86
- # @param natural_person [Increase::Models::EntityUpdateParams::NaturalPerson] Details of the natural person entity to update. If you specify this parameter an
107
+ # @param natural_person [Increase::Models::EntityUpdateParams::NaturalPerson]
108
+ # Details of the natural person entity to update. If you specify this parameter
109
+ # and the entity is not a natural person, the request will fail.
87
110
  #
88
- # @param risk_rating [Increase::Models::EntityUpdateParams::RiskRating] An assessment of the entity’s potential risk of involvement in financial crimes,
111
+ # @param risk_rating [Increase::Models::EntityUpdateParams::RiskRating]
112
+ # An assessment of the entity’s potential risk of involvement in financial crimes,
113
+ # such as money laundering.
89
114
  #
90
- # @param terms_agreements [Array<Increase::Models::EntityUpdateParams::TermsAgreement>] New terms that the Entity agreed to. Not all programs are required to submit thi
115
+ # @param terms_agreements [Array<Increase::Models::EntityUpdateParams::TermsAgreement>]
116
+ # New terms that the Entity agreed to. Not all programs are required to submit
117
+ # this data. This will not archive previously submitted terms.
91
118
  #
92
- # @param third_party_verification [Increase::Models::EntityUpdateParams::ThirdPartyVerification] If you are using a third-party service for identity verification, you can use th
119
+ # @param third_party_verification [Increase::Models::EntityUpdateParams::ThirdPartyVerification]
120
+ # If you are using a third-party service for identity verification, you can use
121
+ # this field to associate this Entity with the identifier that represents them in
122
+ # that service.
93
123
  #
94
- # @param trust [Increase::Models::EntityUpdateParams::Trust] Details of the trust entity to update. If you specify this parameter and the ent
124
+ # @param trust [Increase::Models::EntityUpdateParams::Trust]
125
+ # Details of the trust entity to update. If you specify this parameter and the
126
+ # entity is not a trust, the request will fail.
95
127
  #
96
128
  # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
97
129
  #
@@ -109,23 +141,28 @@ module Increase
109
141
  )
110
142
  end
111
143
 
112
- # Some parameter documentations has been truncated, see
113
- # {Increase::Models::EntityListParams} for more details.
114
- #
115
144
  # List Entities
116
145
  #
117
- # @overload list(created_at: nil, cursor: nil, idempotency_key: nil, limit: nil, status: nil, request_options: {})
146
+ # @overload list(created_at: nil, cursor: nil, idempotency_key: nil, limit: nil, status: nil, validation_status: nil, request_options: {})
118
147
  #
119
148
  # @param created_at [Increase::Models::EntityListParams::CreatedAt]
120
149
  #
121
150
  # @param cursor [String] Return the page of entries after this one.
122
151
  #
123
- # @param idempotency_key [String] Filter records to the one with the specified `idempotency_key` you chose for tha
152
+ # @param idempotency_key [String]
153
+ # Filter records to the one with the specified `idempotency_key` you chose for
154
+ # that object. This value is unique across Increase and is used to ensure that a
155
+ # request is only processed once. Learn more about
156
+ # [idempotency](https://increase.com/documentation/idempotency-keys).
124
157
  #
125
- # @param limit [Integer] Limit the size of the list that is returned. The default (and maximum) is 100 ob
158
+ # @param limit [Integer]
159
+ # Limit the size of the list that is returned. The default (and maximum) is 100
160
+ # objects.
126
161
  #
127
162
  # @param status [Increase::Models::EntityListParams::Status]
128
163
  #
164
+ # @param validation_status [Increase::Models::EntityListParams::ValidationStatus]
165
+ #
129
166
  # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
130
167
  #
131
168
  # @return [Increase::Internal::Page<Increase::Models::Entity>]
@@ -144,14 +181,13 @@ module Increase
144
181
  )
145
182
  end
146
183
 
147
- # Some parameter documentations has been truncated, see
148
- # {Increase::Models::EntityArchiveParams} for more details.
149
- #
150
184
  # Archive an Entity
151
185
  #
152
186
  # @overload archive(entity_id, request_options: {})
153
187
  #
154
- # @param entity_id [String] The identifier of the Entity to archive. Any accounts associated with an entity
188
+ # @param entity_id [String]
189
+ # The identifier of the Entity to archive. Any accounts associated with an entity
190
+ # must be closed before the entity can be archived.
155
191
  #
156
192
  # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
157
193
  #
@@ -3,18 +3,21 @@
3
3
  module Increase
4
4
  module Resources
5
5
  class EntityOnboardingSessions
6
- # Some parameter documentations has been truncated, see
7
- # {Increase::Models::EntityOnboardingSessionCreateParams} for more details.
8
- #
9
6
  # Create an Entity Onboarding Session
10
7
  #
11
8
  # @overload create(program_id:, redirect_url:, entity_id: nil, request_options: {})
12
9
  #
13
10
  # @param program_id [String] The identifier of the Program the Entity will be onboarded to.
14
11
  #
15
- # @param redirect_url [String] The URL to redirect the customer to after they complete the onboarding form. The
12
+ # @param redirect_url [String]
13
+ # The URL to redirect the customer to after they complete the onboarding form. The
14
+ # redirect will include `entity_onboarding_session_id` and `entity_id` query
15
+ # parameters.
16
16
  #
17
- # @param entity_id [String] The identifier of an existing Entity to associate with the onboarding session. I
17
+ # @param entity_id [String]
18
+ # The identifier of an existing Entity to associate with the onboarding session.
19
+ # If provided, the onboarding form will display any outstanding tasks required to
20
+ # complete the Entity's onboarding.
18
21
  #
19
22
  # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
20
23
  #
@@ -52,18 +55,21 @@ module Increase
52
55
  )
53
56
  end
54
57
 
55
- # Some parameter documentations has been truncated, see
56
- # {Increase::Models::EntityOnboardingSessionListParams} for more details.
57
- #
58
58
  # List Entity Onboarding Session
59
59
  #
60
60
  # @overload list(cursor: nil, idempotency_key: nil, limit: nil, status: nil, request_options: {})
61
61
  #
62
62
  # @param cursor [String] Return the page of entries after this one.
63
63
  #
64
- # @param idempotency_key [String] Filter records to the one with the specified `idempotency_key` you chose for tha
64
+ # @param idempotency_key [String]
65
+ # Filter records to the one with the specified `idempotency_key` you chose for
66
+ # that object. This value is unique across Increase and is used to ensure that a
67
+ # request is only processed once. Learn more about
68
+ # [idempotency](https://increase.com/documentation/idempotency-keys).
65
69
  #
66
- # @param limit [Integer] Limit the size of the list that is returned. The default (and maximum) is 100 ob
70
+ # @param limit [Integer]
71
+ # Limit the size of the list that is returned. The default (and maximum) is 100
72
+ # objects.
67
73
  #
68
74
  # @param status [Increase::Models::EntityOnboardingSessionListParams::Status]
69
75
  #
@@ -3,22 +3,27 @@
3
3
  module Increase
4
4
  module Resources
5
5
  class EventSubscriptions
6
- # Some parameter documentations has been truncated, see
7
- # {Increase::Models::EventSubscriptionCreateParams} for more details.
8
- #
9
6
  # Create an Event Subscription
10
7
  #
11
8
  # @overload create(url:, oauth_connection_id: nil, selected_event_categories: nil, shared_secret: nil, status: nil, request_options: {})
12
9
  #
13
10
  # @param url [String] The URL you'd like us to send webhooks to.
14
11
  #
15
- # @param oauth_connection_id [String] If specified, this subscription will only receive webhooks for Events associated
12
+ # @param oauth_connection_id [String]
13
+ # If specified, this subscription will only receive webhooks for Events associated
14
+ # with the specified OAuth Connection.
16
15
  #
17
- # @param selected_event_categories [Array<Increase::Models::EventSubscriptionCreateParams::SelectedEventCategory>] If specified, this subscription will only receive webhooks for Events with the s
16
+ # @param selected_event_categories [Array<Increase::Models::EventSubscriptionCreateParams::SelectedEventCategory>]
17
+ # If specified, this subscription will only receive webhooks for Events with the
18
+ # specified `category`. If specifying a Real-Time Decision event category, only
19
+ # one Event Category can be specified for the Event Subscription.
18
20
  #
19
- # @param shared_secret [String] The key that will be used to sign webhooks. If no value is passed, a random stri
21
+ # @param shared_secret [String]
22
+ # The key that will be used to sign webhooks. If no value is passed, a random
23
+ # string will be used as default.
20
24
  #
21
- # @param status [Symbol, Increase::Models::EventSubscriptionCreateParams::Status] The status of the event subscription. Defaults to `active` if not specified.
25
+ # @param status [Symbol, Increase::Models::EventSubscriptionCreateParams::Status]
26
+ # The status of the event subscription. Defaults to `active` if not specified.
22
27
  #
23
28
  # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
24
29
  #
@@ -62,7 +67,8 @@ module Increase
62
67
  #
63
68
  # @param event_subscription_id [String] The identifier of the Event Subscription.
64
69
  #
65
- # @param status [Symbol, Increase::Models::EventSubscriptionUpdateParams::Status] The status to update the Event Subscription with.
70
+ # @param status [Symbol, Increase::Models::EventSubscriptionUpdateParams::Status]
71
+ # The status to update the Event Subscription with.
66
72
  #
67
73
  # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
68
74
  #
@@ -80,18 +86,21 @@ module Increase
80
86
  )
81
87
  end
82
88
 
83
- # Some parameter documentations has been truncated, see
84
- # {Increase::Models::EventSubscriptionListParams} for more details.
85
- #
86
89
  # List Event Subscriptions
87
90
  #
88
91
  # @overload list(cursor: nil, idempotency_key: nil, limit: nil, request_options: {})
89
92
  #
90
93
  # @param cursor [String] Return the page of entries after this one.
91
94
  #
92
- # @param idempotency_key [String] Filter records to the one with the specified `idempotency_key` you chose for tha
95
+ # @param idempotency_key [String]
96
+ # Filter records to the one with the specified `idempotency_key` you chose for
97
+ # that object. This value is unique across Increase and is used to ensure that a
98
+ # request is only processed once. Learn more about
99
+ # [idempotency](https://increase.com/documentation/idempotency-keys).
93
100
  #
94
- # @param limit [Integer] Limit the size of the list that is returned. The default (and maximum) is 100 ob
101
+ # @param limit [Integer]
102
+ # Limit the size of the list that is returned. The default (and maximum) is 100
103
+ # objects.
95
104
  #
96
105
  # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
97
106
  #
@@ -23,14 +23,12 @@ module Increase
23
23
  )
24
24
  end
25
25
 
26
- # Some parameter documentations has been truncated, see
27
- # {Increase::Models::EventListParams} for more details.
28
- #
29
26
  # List Events
30
27
  #
31
28
  # @overload list(associated_object_id: nil, category: nil, created_at: nil, cursor: nil, limit: nil, order_by: nil, request_options: {})
32
29
  #
33
- # @param associated_object_id [String] Filter Events to those belonging to the object with the provided identifier.
30
+ # @param associated_object_id [String]
31
+ # Filter Events to those belonging to the object with the provided identifier.
34
32
  #
35
33
  # @param category [Increase::Models::EventListParams::Category]
36
34
  #
@@ -38,7 +36,9 @@ module Increase
38
36
  #
39
37
  # @param cursor [String] Return the page of entries after this one.
40
38
  #
41
- # @param limit [Integer] Limit the size of the list that is returned. The default (and maximum) is 100 ob
39
+ # @param limit [Integer]
40
+ # Limit the size of the list that is returned. The default (and maximum) is 100
41
+ # objects.
42
42
  #
43
43
  # @param order_by [Increase::Models::EventListParams::OrderBy]
44
44
  #
@@ -64,10 +64,11 @@ module Increase
64
64
  #
65
65
  # @param headers [Hash{String=>String}] The raw HTTP headers that came with the payload
66
66
  #
67
- # @param key [String, nil] The webhook signing key, as the raw secret string. It is Base64-encoded before
68
- # being passed to StandardWebhooks, so to sign a synthetic payload in tests,
69
- # construct the signer the same way:
70
- # StandardWebhooks::Webhook.new(Base64.strict_encode64(key))
67
+ # @param key [String, nil]
68
+ # The webhook signing key, as the raw secret string. It is Base64-encoded before
69
+ # being passed to StandardWebhooks, so to sign a synthetic payload in tests,
70
+ # construct the signer the same way:
71
+ # StandardWebhooks::Webhook.new(Base64.strict_encode64(key))
71
72
  #
72
73
  # @return [Increase::Models::UnwrapWebhookEvent]
73
74
  def unwrap(payload, headers:, key: @client.webhook_secret)
@@ -3,38 +3,52 @@
3
3
  module Increase
4
4
  module Resources
5
5
  class Exports
6
- # Some parameter documentations has been truncated, see
7
- # {Increase::Models::ExportCreateParams} for more details.
8
- #
9
6
  # Create an Export
10
7
  #
11
8
  # @overload create(category:, account_statement_bai2: nil, account_statement_ofx: nil, account_verification_letter: nil, bookkeeping_account_balance_csv: nil, daily_account_balance_csv: nil, entity_csv: nil, fee_csv: nil, funding_instructions: nil, transaction_csv: nil, vendor_csv: nil, voided_check: nil, request_options: {})
12
9
  #
13
10
  # @param category [Symbol, Increase::Models::ExportCreateParams::Category] The type of Export to create.
14
11
  #
15
- # @param account_statement_bai2 [Increase::Models::ExportCreateParams::AccountStatementBai2] Options for the created export. Required if `category` is equal to `account_stat
12
+ # @param account_statement_bai2 [Increase::Models::ExportCreateParams::AccountStatementBai2]
13
+ # Options for the created export. Required if `category` is equal to
14
+ # `account_statement_bai2`.
16
15
  #
17
- # @param account_statement_ofx [Increase::Models::ExportCreateParams::AccountStatementOfx] Options for the created export. Required if `category` is equal to `account_stat
16
+ # @param account_statement_ofx [Increase::Models::ExportCreateParams::AccountStatementOfx]
17
+ # Options for the created export. Required if `category` is equal to
18
+ # `account_statement_ofx`.
18
19
  #
19
- # @param account_verification_letter [Increase::Models::ExportCreateParams::AccountVerificationLetter] Options for the created export. Required if `category` is equal to `account_veri
20
+ # @param account_verification_letter [Increase::Models::ExportCreateParams::AccountVerificationLetter]
21
+ # Options for the created export. Required if `category` is equal to
22
+ # `account_verification_letter`.
20
23
  #
21
- # @param bookkeeping_account_balance_csv [Increase::Models::ExportCreateParams::BookkeepingAccountBalanceCsv] Options for the created export. Required if `category` is equal to
22
- # `bookkeeping\_
24
+ # @param bookkeeping_account_balance_csv [Increase::Models::ExportCreateParams::BookkeepingAccountBalanceCsv]
25
+ # Options for the created export. Required if `category` is equal to
26
+ # `bookkeeping_account_balance_csv`.
23
27
  #
24
- # @param daily_account_balance_csv [Increase::Models::ExportCreateParams::DailyAccountBalanceCsv] Options for the created export. Required if `category` is equal to `daily_accoun
28
+ # @param daily_account_balance_csv [Increase::Models::ExportCreateParams::DailyAccountBalanceCsv]
29
+ # Options for the created export. Required if `category` is equal to
30
+ # `daily_account_balance_csv`.
25
31
  #
26
- # @param entity_csv [Increase::Models::ExportCreateParams::EntityCsv] Options for the created export. Required if `category` is equal to `entity_csv`.
32
+ # @param entity_csv [Increase::Models::ExportCreateParams::EntityCsv]
33
+ # Options for the created export. Required if `category` is equal to `entity_csv`.
27
34
  #
28
- # @param fee_csv [Increase::Models::ExportCreateParams::FeeCsv] Options for the created export. Required if `category` is equal to `fee_csv`.
35
+ # @param fee_csv [Increase::Models::ExportCreateParams::FeeCsv]
36
+ # Options for the created export. Required if `category` is equal to `fee_csv`.
29
37
  #
30
- # @param funding_instructions [Increase::Models::ExportCreateParams::FundingInstructions] Options for the created export. Required if `category` is equal to `funding_inst
38
+ # @param funding_instructions [Increase::Models::ExportCreateParams::FundingInstructions]
39
+ # Options for the created export. Required if `category` is equal to
40
+ # `funding_instructions`.
31
41
  #
32
- # @param transaction_csv [Increase::Models::ExportCreateParams::TransactionCsv] Options for the created export. Required if `category` is equal to
33
- # `transaction\_
42
+ # @param transaction_csv [Increase::Models::ExportCreateParams::TransactionCsv]
43
+ # Options for the created export. Required if `category` is equal to
44
+ # `transaction_csv`.
34
45
  #
35
- # @param vendor_csv [Increase::Models::ExportCreateParams::VendorCsv] Options for the created export. Required if `category` is equal to `vendor_csv`.
46
+ # @param vendor_csv [Increase::Models::ExportCreateParams::VendorCsv]
47
+ # Options for the created export. Required if `category` is equal to `vendor_csv`.
36
48
  #
37
- # @param voided_check [Increase::Models::ExportCreateParams::VoidedCheck] Options for the created export. Required if `category` is equal to `voided_check
49
+ # @param voided_check [Increase::Models::ExportCreateParams::VoidedCheck]
50
+ # Options for the created export. Required if `category` is equal to
51
+ # `voided_check`.
38
52
  #
39
53
  # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
40
54
  #
@@ -72,14 +86,12 @@ module Increase
72
86
  )
73
87
  end
74
88
 
75
- # Some parameter documentations has been truncated, see
76
- # {Increase::Models::ExportListParams} for more details.
77
- #
78
89
  # List Exports
79
90
  #
80
91
  # @overload list(category: nil, created_at: nil, cursor: nil, form_1099_int: nil, form_1099_misc: nil, idempotency_key: nil, limit: nil, status: nil, request_options: {})
81
92
  #
82
- # @param category [Symbol, Increase::Models::ExportListParams::Category] Filter Exports for those with the specified category.
93
+ # @param category [Symbol, Increase::Models::ExportListParams::Category]
94
+ # Filter Exports for those with the specified category.
83
95
  #
84
96
  # @param created_at [Increase::Models::ExportListParams::CreatedAt]
85
97
  #
@@ -89,9 +101,15 @@ module Increase
89
101
  #
90
102
  # @param form_1099_misc [Increase::Models::ExportListParams::Form1099Misc]
91
103
  #
92
- # @param idempotency_key [String] Filter records to the one with the specified `idempotency_key` you chose for tha
104
+ # @param idempotency_key [String]
105
+ # Filter records to the one with the specified `idempotency_key` you chose for
106
+ # that object. This value is unique across Increase and is used to ensure that a
107
+ # request is only processed once. Learn more about
108
+ # [idempotency](https://increase.com/documentation/idempotency-keys).
93
109
  #
94
- # @param limit [Integer] Limit the size of the list that is returned. The default (and maximum) is 100 ob
110
+ # @param limit [Integer]
111
+ # Limit the size of the list that is returned. The default (and maximum) is 100
112
+ # objects.
95
113
  #
96
114
  # @param status [Increase::Models::ExportListParams::Status]
97
115
  #
@@ -3,9 +3,6 @@
3
3
  module Increase
4
4
  module Resources
5
5
  class ExternalAccounts
6
- # Some parameter documentations has been truncated, see
7
- # {Increase::Models::ExternalAccountCreateParams} for more details.
8
- #
9
6
  # Create an External Account
10
7
  #
11
8
  # @overload create(account_number:, description:, routing_number:, account_holder: nil, funding: nil, request_options: {})
@@ -14,11 +11,15 @@ module Increase
14
11
  #
15
12
  # @param description [String] The name you choose for the Account.
16
13
  #
17
- # @param routing_number [String] The American Bankers' Association (ABA) Routing Transit Number (RTN) for the des
14
+ # @param routing_number [String]
15
+ # The American Bankers' Association (ABA) Routing Transit Number (RTN) for the
16
+ # destination account.
18
17
  #
19
- # @param account_holder [Symbol, Increase::Models::ExternalAccountCreateParams::AccountHolder] The type of entity that owns the External Account.
18
+ # @param account_holder [Symbol, Increase::Models::ExternalAccountCreateParams::AccountHolder]
19
+ # The type of entity that owns the External Account.
20
20
  #
21
- # @param funding [Symbol, Increase::Models::ExternalAccountCreateParams::Funding] The type of the destination account. Defaults to `checking`.
21
+ # @param funding [Symbol, Increase::Models::ExternalAccountCreateParams::Funding]
22
+ # The type of the destination account. Defaults to `checking`.
22
23
  #
23
24
  # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
24
25
  #
@@ -62,13 +63,16 @@ module Increase
62
63
  #
63
64
  # @param external_account_id [String] The external account identifier.
64
65
  #
65
- # @param account_holder [Symbol, Increase::Models::ExternalAccountUpdateParams::AccountHolder] The type of entity that owns the External Account.
66
+ # @param account_holder [Symbol, Increase::Models::ExternalAccountUpdateParams::AccountHolder]
67
+ # The type of entity that owns the External Account.
66
68
  #
67
69
  # @param description [String] The description you choose to give the external account.
68
70
  #
69
- # @param funding [Symbol, Increase::Models::ExternalAccountUpdateParams::Funding] The funding type of the External Account.
71
+ # @param funding [Symbol, Increase::Models::ExternalAccountUpdateParams::Funding]
72
+ # The funding type of the External Account.
70
73
  #
71
- # @param status [Symbol, Increase::Models::ExternalAccountUpdateParams::Status] The status of the External Account.
74
+ # @param status [Symbol, Increase::Models::ExternalAccountUpdateParams::Status]
75
+ # The status of the External Account.
72
76
  #
73
77
  # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
74
78
  #
@@ -86,18 +90,21 @@ module Increase
86
90
  )
87
91
  end
88
92
 
89
- # Some parameter documentations has been truncated, see
90
- # {Increase::Models::ExternalAccountListParams} for more details.
91
- #
92
93
  # List External Accounts
93
94
  #
94
95
  # @overload list(cursor: nil, idempotency_key: nil, limit: nil, routing_number: nil, status: nil, request_options: {})
95
96
  #
96
97
  # @param cursor [String] Return the page of entries after this one.
97
98
  #
98
- # @param idempotency_key [String] Filter records to the one with the specified `idempotency_key` you chose for tha
99
+ # @param idempotency_key [String]
100
+ # Filter records to the one with the specified `idempotency_key` you chose for
101
+ # that object. This value is unique across Increase and is used to ensure that a
102
+ # request is only processed once. Learn more about
103
+ # [idempotency](https://increase.com/documentation/idempotency-keys).
99
104
  #
100
- # @param limit [Integer] Limit the size of the list that is returned. The default (and maximum) is 100 ob
105
+ # @param limit [Integer]
106
+ # Limit the size of the list that is returned. The default (and maximum) is 100
107
+ # objects.
101
108
  #
102
109
  # @param routing_number [String] Filter External Accounts to those with the specified Routing Number.
103
110
  #
@@ -3,9 +3,6 @@
3
3
  module Increase
4
4
  module Resources
5
5
  class FednowTransfers
6
- # Some parameter documentations has been truncated, see
7
- # {Increase::Models::FednowTransferCreateParams} for more details.
8
- #
9
6
  # Create a FedNow Transfer
10
7
  #
11
8
  # @overload create(amount:, creditor_name:, debtor_name:, source_account_number_id:, unstructured_remittance_information:, account_number: nil, creditor_address: nil, debtor_address: nil, external_account_id: nil, require_approval: nil, routing_number: nil, request_options: {})
@@ -16,19 +13,25 @@ module Increase
16
13
  #
17
14
  # @param debtor_name [String] The debtor's name.
18
15
  #
19
- # @param source_account_number_id [String] The Account Number to include in the transfer as the debtor's account number.
16
+ # @param source_account_number_id [String]
17
+ # The Account Number to include in the transfer as the debtor's account number.
20
18
  #
21
- # @param unstructured_remittance_information [String] Unstructured remittance information to include in the transfer.
19
+ # @param unstructured_remittance_information [String]
20
+ # Unstructured remittance information to include in the transfer.
22
21
  #
23
22
  # @param account_number [String] The creditor's account number.
24
23
  #
25
- # @param creditor_address [Increase::Models::FednowTransferCreateParams::CreditorAddress] The creditor's address.
24
+ # @param creditor_address [Increase::Models::FednowTransferCreateParams::CreditorAddress]
25
+ # The creditor's address.
26
26
  #
27
27
  # @param debtor_address [Increase::Models::FednowTransferCreateParams::DebtorAddress] The debtor's address.
28
28
  #
29
- # @param external_account_id [String] The ID of an External Account to initiate a transfer to. If this parameter is pr
29
+ # @param external_account_id [String]
30
+ # The ID of an External Account to initiate a transfer to. If this parameter is
31
+ # provided, `account_number` and `routing_number` must be absent.
30
32
  #
31
- # @param require_approval [Boolean] Whether the transfer requires explicit approval via the dashboard or API.
33
+ # @param require_approval [Boolean]
34
+ # Whether the transfer requires explicit approval via the dashboard or API.
32
35
  #
33
36
  # @param routing_number [String] The creditor's bank account routing number.
34
37
  #
@@ -68,9 +71,6 @@ module Increase
68
71
  )
69
72
  end
70
73
 
71
- # Some parameter documentations has been truncated, see
72
- # {Increase::Models::FednowTransferListParams} for more details.
73
- #
74
74
  # List FedNow Transfers
75
75
  #
76
76
  # @overload list(account_id: nil, created_at: nil, cursor: nil, external_account_id: nil, idempotency_key: nil, limit: nil, status: nil, request_options: {})
@@ -81,11 +81,18 @@ module Increase
81
81
  #
82
82
  # @param cursor [String] Return the page of entries after this one.
83
83
  #
84
- # @param external_account_id [String] Filter FedNow Transfers to those made to the specified External Account.
84
+ # @param external_account_id [String]
85
+ # Filter FedNow Transfers to those made to the specified External Account.
85
86
  #
86
- # @param idempotency_key [String] Filter records to the one with the specified `idempotency_key` you chose for tha
87
+ # @param idempotency_key [String]
88
+ # Filter records to the one with the specified `idempotency_key` you chose for
89
+ # that object. This value is unique across Increase and is used to ensure that a
90
+ # request is only processed once. Learn more about
91
+ # [idempotency](https://increase.com/documentation/idempotency-keys).
87
92
  #
88
- # @param limit [Integer] Limit the size of the list that is returned. The default (and maximum) is 100 ob
93
+ # @param limit [Integer]
94
+ # Limit the size of the list that is returned. The default (and maximum) is 100
95
+ # objects.
89
96
  #
90
97
  # @param status [Increase::Models::FednowTransferListParams::Status]
91
98
  #
@@ -3,16 +3,15 @@
3
3
  module Increase
4
4
  module Resources
5
5
  class FileLinks
6
- # Some parameter documentations has been truncated, see
7
- # {Increase::Models::FileLinkCreateParams} for more details.
8
- #
9
6
  # Create a File Link
10
7
  #
11
8
  # @overload create(file_id:, expires_at: nil, request_options: {})
12
9
  #
13
10
  # @param file_id [String] The File to create a File Link for.
14
11
  #
15
- # @param expires_at [Time] The time at which the File Link will expire. The default is 1 hour from the time
12
+ # @param expires_at [Time]
13
+ # The time at which the File Link will expire. The default is 1 hour from the time
14
+ # of the request. The maximum is 1 day from the time of the request.
16
15
  #
17
16
  # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
18
17
  #