increase 1.340.0 → 1.341.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (306) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +1 -1
  3. data/lib/increase/client.rb +8 -6
  4. data/lib/increase/internal/type/converter.rb +13 -12
  5. data/lib/increase/models/account.rb +40 -19
  6. data/lib/increase/models/account_create_params.rb +14 -11
  7. data/lib/increase/models/account_list_params.rb +25 -17
  8. data/lib/increase/models/account_number.rb +22 -14
  9. data/lib/increase/models/account_number_create_params.rb +12 -13
  10. data/lib/increase/models/account_number_list_params.rb +26 -20
  11. data/lib/increase/models/account_number_update_params.rb +12 -11
  12. data/lib/increase/models/account_statement.rb +15 -11
  13. data/lib/increase/models/account_statement_list_params.rb +15 -12
  14. data/lib/increase/models/account_transfer.rb +58 -29
  15. data/lib/increase/models/account_transfer_create_params.rb +12 -7
  16. data/lib/increase/models/account_transfer_list_params.rb +20 -12
  17. data/lib/increase/models/ach_prenotification.rb +48 -27
  18. data/lib/increase/models/ach_prenotification_create_params.rb +15 -8
  19. data/lib/increase/models/ach_prenotification_list_params.rb +20 -12
  20. data/lib/increase/models/ach_transfer.rb +199 -103
  21. data/lib/increase/models/ach_transfer_create_params.rb +110 -61
  22. data/lib/increase/models/ach_transfer_list_params.rb +23 -16
  23. data/lib/increase/models/balance_lookup.rb +14 -11
  24. data/lib/increase/models/beneficial_owner_create_params.rb +48 -37
  25. data/lib/increase/models/beneficial_owner_list_params.rb +11 -6
  26. data/lib/increase/models/beneficial_owner_update_params.rb +44 -31
  27. data/lib/increase/models/card.rb +69 -47
  28. data/lib/increase/models/card_create_details_iframe_params.rb +3 -4
  29. data/lib/increase/models/card_create_params.rb +65 -56
  30. data/lib/increase/models/card_details.rb +7 -5
  31. data/lib/increase/models/card_dispute.rb +530 -306
  32. data/lib/increase/models/card_dispute_create_params.rb +271 -175
  33. data/lib/increase/models/card_dispute_list_params.rb +24 -16
  34. data/lib/increase/models/card_dispute_submit_user_submission_params.rb +288 -191
  35. data/lib/increase/models/card_iframe_url.rb +3 -4
  36. data/lib/increase/models/card_list_params.rb +23 -16
  37. data/lib/increase/models/card_payment.rb +1941 -1200
  38. data/lib/increase/models/card_payment_list_params.rb +15 -11
  39. data/lib/increase/models/card_purchase_supplement.rb +37 -25
  40. data/lib/increase/models/card_purchase_supplement_list_params.rb +18 -13
  41. data/lib/increase/models/card_push_transfer.rb +121 -65
  42. data/lib/increase/models/card_push_transfer_create_params.rb +55 -25
  43. data/lib/increase/models/card_push_transfer_list_params.rb +23 -16
  44. data/lib/increase/models/card_token.rb +9 -6
  45. data/lib/increase/models/card_token_capabilities.rb +11 -8
  46. data/lib/increase/models/card_token_list_params.rb +15 -11
  47. data/lib/increase/models/card_update_params.rb +65 -57
  48. data/lib/increase/models/card_validation.rb +76 -43
  49. data/lib/increase/models/card_validation_create_params.rb +11 -7
  50. data/lib/increase/models/card_validation_list_params.rb +23 -16
  51. data/lib/increase/models/check_deposit.rb +103 -52
  52. data/lib/increase/models/check_deposit_create_params.rb +2 -4
  53. data/lib/increase/models/check_deposit_list_params.rb +20 -12
  54. data/lib/increase/models/check_transfer.rb +124 -75
  55. data/lib/increase/models/check_transfer_create_params.rb +91 -51
  56. data/lib/increase/models/check_transfer_list_params.rb +24 -16
  57. data/lib/increase/models/check_transfer_stop_payment_params.rb +2 -1
  58. data/lib/increase/models/declined_transaction.rb +339 -206
  59. data/lib/increase/models/declined_transaction_list_params.rb +18 -15
  60. data/lib/increase/models/digital_card_profile.rb +16 -9
  61. data/lib/increase/models/digital_card_profile_clone_params.rb +2 -1
  62. data/lib/increase/models/digital_card_profile_create_params.rb +2 -1
  63. data/lib/increase/models/digital_card_profile_list_params.rb +12 -9
  64. data/lib/increase/models/digital_wallet_token.rb +26 -17
  65. data/lib/increase/models/digital_wallet_token_list_params.rb +15 -11
  66. data/lib/increase/models/entity.rb +175 -135
  67. data/lib/increase/models/entity_archive_params.rb +3 -4
  68. data/lib/increase/models/entity_beneficial_owner.rb +24 -19
  69. data/lib/increase/models/entity_create_params.rb +323 -236
  70. data/lib/increase/models/entity_list_params.rb +67 -16
  71. data/lib/increase/models/entity_onboarding_session.rb +25 -11
  72. data/lib/increase/models/entity_onboarding_session_create_params.rb +8 -5
  73. data/lib/increase/models/entity_onboarding_session_list_params.rb +12 -9
  74. data/lib/increase/models/entity_supplemental_document.rb +10 -6
  75. data/lib/increase/models/entity_update_params.rb +112 -86
  76. data/lib/increase/models/event.rb +6 -5
  77. data/lib/increase/models/event_list_params.rb +23 -17
  78. data/lib/increase/models/event_subscription.rb +17 -9
  79. data/lib/increase/models/event_subscription_create_params.rb +14 -8
  80. data/lib/increase/models/event_subscription_list_params.rb +8 -5
  81. data/lib/increase/models/event_subscription_update_params.rb +2 -1
  82. data/lib/increase/models/export.rb +69 -30
  83. data/lib/increase/models/export_create_params.rb +76 -46
  84. data/lib/increase/models/export_list_params.rb +26 -17
  85. data/lib/increase/models/external_account.rb +14 -8
  86. data/lib/increase/models/external_account_create_params.rb +7 -6
  87. data/lib/increase/models/external_account_list_params.rb +12 -9
  88. data/lib/increase/models/external_account_update_params.rb +6 -3
  89. data/lib/increase/models/fednow_transfer.rb +62 -32
  90. data/lib/increase/models/fednow_transfer_create_params.rb +11 -8
  91. data/lib/increase/models/fednow_transfer_list_params.rb +25 -17
  92. data/lib/increase/models/file.rb +13 -7
  93. data/lib/increase/models/file_create_params.rb +6 -5
  94. data/lib/increase/models/file_link.rb +17 -8
  95. data/lib/increase/models/file_link_create_params.rb +3 -4
  96. data/lib/increase/models/file_list_params.rb +23 -16
  97. data/lib/increase/models/group.rb +6 -5
  98. data/lib/increase/models/inbound_ach_transfer.rb +115 -51
  99. data/lib/increase/models/inbound_ach_transfer_create_notification_of_change_params.rb +3 -5
  100. data/lib/increase/models/inbound_ach_transfer_decline_params.rb +4 -4
  101. data/lib/increase/models/inbound_ach_transfer_list_params.rb +21 -16
  102. data/lib/increase/models/inbound_ach_transfer_transfer_return_params.rb +6 -5
  103. data/lib/increase/models/inbound_check_deposit.rb +46 -19
  104. data/lib/increase/models/inbound_check_deposit_list_params.rb +18 -12
  105. data/lib/increase/models/inbound_check_deposit_return_params.rb +2 -1
  106. data/lib/increase/models/inbound_fednow_transfer.rb +28 -14
  107. data/lib/increase/models/inbound_fednow_transfer_list_params.rb +18 -12
  108. data/lib/increase/models/inbound_fednow_transfer_retrieve_params.rb +2 -1
  109. data/lib/increase/models/inbound_mail_item.rb +13 -8
  110. data/lib/increase/models/inbound_mail_item_action_params.rb +4 -2
  111. data/lib/increase/models/inbound_mail_item_list_params.rb +17 -12
  112. data/lib/increase/models/inbound_real_time_payments_transfer.rb +21 -12
  113. data/lib/increase/models/inbound_real_time_payments_transfer_list_params.rb +21 -14
  114. data/lib/increase/models/inbound_real_time_payments_transfer_retrieve_params.rb +2 -1
  115. data/lib/increase/models/inbound_wire_drawdown_request.rb +23 -10
  116. data/lib/increase/models/inbound_wire_drawdown_request_list_params.rb +3 -4
  117. data/lib/increase/models/inbound_wire_drawdown_request_retrieve_params.rb +2 -1
  118. data/lib/increase/models/inbound_wire_transfer.rb +33 -21
  119. data/lib/increase/models/inbound_wire_transfer_list_params.rb +24 -17
  120. data/lib/increase/models/inbound_wire_transfer_reverse_params.rb +2 -1
  121. data/lib/increase/models/intrafi_account_enrollment.rb +16 -8
  122. data/lib/increase/models/intrafi_account_enrollment_list_params.rb +12 -9
  123. data/lib/increase/models/intrafi_account_enrollment_retrieve_params.rb +2 -1
  124. data/lib/increase/models/intrafi_account_enrollment_unenroll_params.rb +2 -1
  125. data/lib/increase/models/intrafi_balance.rb +18 -12
  126. data/lib/increase/models/intrafi_exclusion.rb +13 -7
  127. data/lib/increase/models/intrafi_exclusion_archive_params.rb +4 -4
  128. data/lib/increase/models/intrafi_exclusion_create_params.rb +5 -4
  129. data/lib/increase/models/intrafi_exclusion_list_params.rb +8 -5
  130. data/lib/increase/models/lockbox_address.rb +16 -11
  131. data/lib/increase/models/lockbox_address_list_params.rb +20 -12
  132. data/lib/increase/models/lockbox_address_update_params.rb +2 -1
  133. data/lib/increase/models/lockbox_recipient.rb +22 -10
  134. data/lib/increase/models/lockbox_recipient_create_params.rb +5 -5
  135. data/lib/increase/models/lockbox_recipient_list_params.rb +22 -13
  136. data/lib/increase/models/lockbox_recipient_update_params.rb +2 -1
  137. data/lib/increase/models/oauth_application.rb +12 -7
  138. data/lib/increase/models/oauth_application_list_params.rb +18 -15
  139. data/lib/increase/models/oauth_connection.rb +9 -6
  140. data/lib/increase/models/oauth_connection_list_params.rb +10 -9
  141. data/lib/increase/models/oauth_token.rb +6 -5
  142. data/lib/increase/models/oauth_token_create_params.rb +14 -7
  143. data/lib/increase/models/pending_transaction.rb +392 -239
  144. data/lib/increase/models/pending_transaction_create_params.rb +6 -6
  145. data/lib/increase/models/pending_transaction_list_params.rb +23 -19
  146. data/lib/increase/models/physical_card.rb +36 -24
  147. data/lib/increase/models/physical_card_create_params.rb +22 -17
  148. data/lib/increase/models/physical_card_list_params.rb +20 -12
  149. data/lib/increase/models/physical_card_profile.rb +33 -17
  150. data/lib/increase/models/physical_card_profile_clone_params.rb +9 -9
  151. data/lib/increase/models/physical_card_profile_create_params.rb +9 -9
  152. data/lib/increase/models/physical_card_profile_list_params.rb +12 -9
  153. data/lib/increase/models/physical_card_update_params.rb +2 -1
  154. data/lib/increase/models/program.rb +15 -8
  155. data/lib/increase/models/program_list_params.rb +3 -4
  156. data/lib/increase/models/real_time_decision.rb +561 -370
  157. data/lib/increase/models/real_time_decision_action_params.rb +86 -75
  158. data/lib/increase/models/real_time_payments_transfer.rb +90 -47
  159. data/lib/increase/models/real_time_payments_transfer_approve_params.rb +2 -1
  160. data/lib/increase/models/real_time_payments_transfer_cancel_params.rb +2 -1
  161. data/lib/increase/models/real_time_payments_transfer_create_params.rb +24 -12
  162. data/lib/increase/models/real_time_payments_transfer_list_params.rb +28 -19
  163. data/lib/increase/models/routing_number_list_params.rb +3 -4
  164. data/lib/increase/models/routing_number_list_response.rb +11 -8
  165. data/lib/increase/models/simulations/account_revenue_payment_create_params.rb +9 -7
  166. data/lib/increase/models/simulations/ach_transfer_create_notification_of_change_params.rb +5 -6
  167. data/lib/increase/models/simulations/ach_transfer_return_params.rb +3 -4
  168. data/lib/increase/models/simulations/ach_transfer_settle_params.rb +4 -4
  169. data/lib/increase/models/simulations/card_authentication_create_params.rb +10 -8
  170. data/lib/increase/models/simulations/card_authorization_create_params.rb +50 -27
  171. data/lib/increase/models/simulations/card_authorization_create_response.rb +11 -7
  172. data/lib/increase/models/simulations/card_balance_inquiry_create_params.rb +26 -13
  173. data/lib/increase/models/simulations/card_dispute_action_params.rb +39 -19
  174. data/lib/increase/models/simulations/card_fuel_confirmation_create_params.rb +3 -5
  175. data/lib/increase/models/simulations/card_increment_create_params.rb +5 -4
  176. data/lib/increase/models/simulations/card_purchase_supplement_create_params.rb +7 -7
  177. data/lib/increase/models/simulations/card_refund_create_params.rb +10 -6
  178. data/lib/increase/models/simulations/card_reversal_create_params.rb +3 -4
  179. data/lib/increase/models/simulations/card_settlement_create_params.rb +6 -5
  180. data/lib/increase/models/simulations/card_token_create_params.rb +18 -9
  181. data/lib/increase/models/simulations/check_deposit_adjustment_params.rb +8 -5
  182. data/lib/increase/models/simulations/check_deposit_submit_params.rb +9 -10
  183. data/lib/increase/models/simulations/digital_wallet_token_request_create_response.rb +9 -7
  184. data/lib/increase/models/simulations/entity_onboarding_session_submit_params.rb +2 -1
  185. data/lib/increase/models/simulations/entity_update_validation_params.rb +5 -5
  186. data/lib/increase/models/simulations/export_create_params.rb +5 -5
  187. data/lib/increase/models/simulations/inbound_ach_transfer_create_params.rb +20 -12
  188. data/lib/increase/models/simulations/inbound_check_deposit_adjustment_params.rb +5 -6
  189. data/lib/increase/models/simulations/inbound_check_deposit_create_params.rb +6 -6
  190. data/lib/increase/models/simulations/inbound_mail_item_create_params.rb +9 -6
  191. data/lib/increase/models/simulations/inbound_real_time_payments_transfer_create_params.rb +5 -6
  192. data/lib/increase/models/simulations/inbound_wire_drawdown_request_create_params.rb +27 -13
  193. data/lib/increase/models/simulations/inbound_wire_transfer_create_params.rb +45 -19
  194. data/lib/increase/models/simulations/interest_payment_create_params.rb +4 -5
  195. data/lib/increase/models/simulations/pending_transaction_release_inbound_funds_hold_params.rb +3 -5
  196. data/lib/increase/models/simulations/physical_card_advance_shipment_params.rb +2 -1
  197. data/lib/increase/models/simulations/physical_card_create_params.rb +5 -5
  198. data/lib/increase/models/simulations/program_create_params.rb +4 -2
  199. data/lib/increase/models/simulations/real_time_payments_transfer_complete_params.rb +6 -3
  200. data/lib/increase/models/supplemental_document_list_params.rb +8 -5
  201. data/lib/increase/models/swift_transfer.rb +48 -26
  202. data/lib/increase/models/swift_transfer_create_params.rb +28 -19
  203. data/lib/increase/models/swift_transfer_list_params.rb +23 -16
  204. data/lib/increase/models/transaction.rb +995 -534
  205. data/lib/increase/models/transaction_list_params.rb +21 -16
  206. data/lib/increase/models/unwrap_webhook_event.rb +6 -5
  207. data/lib/increase/models/wire_drawdown_request.rb +44 -26
  208. data/lib/increase/models/wire_drawdown_request_create_params.rb +23 -19
  209. data/lib/increase/models/wire_drawdown_request_list_params.rb +12 -9
  210. data/lib/increase/models/wire_transfer.rb +100 -55
  211. data/lib/increase/models/wire_transfer_create_params.rb +43 -26
  212. data/lib/increase/models/wire_transfer_list_params.rb +23 -16
  213. data/lib/increase/resources/account_numbers.rb +20 -16
  214. data/lib/increase/resources/account_statements.rb +3 -4
  215. data/lib/increase/resources/account_transfers.rb +20 -12
  216. data/lib/increase/resources/accounts.rb +19 -12
  217. data/lib/increase/resources/ach_prenotifications.rb +23 -13
  218. data/lib/increase/resources/ach_transfers.rb +93 -43
  219. data/lib/increase/resources/beneficial_owners.rb +35 -19
  220. data/lib/increase/resources/card_disputes.rb +43 -22
  221. data/lib/increase/resources/card_payments.rb +3 -4
  222. data/lib/increase/resources/card_purchase_supplements.rb +6 -5
  223. data/lib/increase/resources/card_push_transfers.rb +55 -24
  224. data/lib/increase/resources/card_tokens.rb +3 -4
  225. data/lib/increase/resources/card_validations.rb +19 -12
  226. data/lib/increase/resources/cards.rb +33 -22
  227. data/lib/increase/resources/check_deposits.rb +10 -9
  228. data/lib/increase/resources/check_transfers.rb +37 -17
  229. data/lib/increase/resources/declined_transactions.rb +3 -4
  230. data/lib/increase/resources/digital_card_profiles.rb +12 -7
  231. data/lib/increase/resources/digital_wallet_tokens.rb +3 -4
  232. data/lib/increase/resources/entities.rb +69 -33
  233. data/lib/increase/resources/entity_onboarding_sessions.rb +16 -10
  234. data/lib/increase/resources/event_subscriptions.rb +22 -13
  235. data/lib/increase/resources/events.rb +10 -9
  236. data/lib/increase/resources/exports.rb +40 -22
  237. data/lib/increase/resources/external_accounts.rb +21 -14
  238. data/lib/increase/resources/fednow_transfers.rb +21 -14
  239. data/lib/increase/resources/file_links.rb +3 -4
  240. data/lib/increase/resources/files.rb +14 -10
  241. data/lib/increase/resources/inbound_ach_transfers.rb +18 -19
  242. data/lib/increase/resources/inbound_check_deposits.rb +8 -6
  243. data/lib/increase/resources/inbound_fednow_transfers.rb +8 -6
  244. data/lib/increase/resources/inbound_mail_items.rb +7 -6
  245. data/lib/increase/resources/inbound_real_time_payments_transfers.rb +11 -7
  246. data/lib/increase/resources/inbound_wire_drawdown_requests.rb +5 -5
  247. data/lib/increase/resources/inbound_wire_transfers.rb +10 -7
  248. data/lib/increase/resources/intrafi_account_enrollments.rb +12 -7
  249. data/lib/increase/resources/intrafi_exclusions.rb +17 -13
  250. data/lib/increase/resources/lockbox_addresses.rb +10 -6
  251. data/lib/increase/resources/lockbox_recipients.rb +17 -12
  252. data/lib/increase/resources/oauth_applications.rb +3 -4
  253. data/lib/increase/resources/oauth_connections.rb +6 -5
  254. data/lib/increase/resources/oauth_tokens.rb +14 -7
  255. data/lib/increase/resources/pending_transactions.rb +7 -8
  256. data/lib/increase/resources/physical_card_profiles.rb +18 -15
  257. data/lib/increase/resources/physical_cards.rb +17 -12
  258. data/lib/increase/resources/programs.rb +3 -4
  259. data/lib/increase/resources/real_time_decisions.rb +18 -9
  260. data/lib/increase/resources/real_time_payments_transfers.rb +41 -21
  261. data/lib/increase/resources/routing_numbers.rb +3 -4
  262. data/lib/increase/resources/simulations/account_revenue_payments.rb +9 -7
  263. data/lib/increase/resources/simulations/ach_transfers.rb +12 -14
  264. data/lib/increase/resources/simulations/card_authentications.rb +10 -8
  265. data/lib/increase/resources/simulations/card_authorizations.rb +28 -12
  266. data/lib/increase/resources/simulations/card_balance_inquiries.rb +22 -11
  267. data/lib/increase/resources/simulations/card_disputes.rb +6 -5
  268. data/lib/increase/resources/simulations/card_fuel_confirmations.rb +3 -5
  269. data/lib/increase/resources/simulations/card_increments.rb +5 -4
  270. data/lib/increase/resources/simulations/card_purchase_supplements.rb +7 -7
  271. data/lib/increase/resources/simulations/card_refunds.rb +10 -6
  272. data/lib/increase/resources/simulations/card_reversals.rb +3 -4
  273. data/lib/increase/resources/simulations/card_settlements.rb +6 -5
  274. data/lib/increase/resources/simulations/card_tokens.rb +6 -3
  275. data/lib/increase/resources/simulations/check_deposits.rb +11 -9
  276. data/lib/increase/resources/simulations/entities.rb +3 -4
  277. data/lib/increase/resources/simulations/entity_onboarding_sessions.rb +2 -1
  278. data/lib/increase/resources/simulations/exports.rb +5 -5
  279. data/lib/increase/resources/simulations/inbound_ach_transfers.rb +14 -9
  280. data/lib/increase/resources/simulations/inbound_check_deposits.rb +11 -12
  281. data/lib/increase/resources/simulations/inbound_mail_items.rb +9 -6
  282. data/lib/increase/resources/simulations/inbound_real_time_payments_transfers.rb +5 -6
  283. data/lib/increase/resources/simulations/inbound_wire_drawdown_requests.rb +27 -13
  284. data/lib/increase/resources/simulations/inbound_wire_transfers.rb +45 -19
  285. data/lib/increase/resources/simulations/interest_payments.rb +4 -5
  286. data/lib/increase/resources/simulations/pending_transactions.rb +3 -5
  287. data/lib/increase/resources/simulations/physical_cards.rb +7 -6
  288. data/lib/increase/resources/simulations/programs.rb +4 -2
  289. data/lib/increase/resources/simulations/real_time_payments_transfers.rb +4 -2
  290. data/lib/increase/resources/supplemental_documents.rb +8 -5
  291. data/lib/increase/resources/swift_transfers.rb +28 -16
  292. data/lib/increase/resources/transactions.rb +6 -5
  293. data/lib/increase/resources/wire_drawdown_requests.rb +23 -14
  294. data/lib/increase/resources/wire_transfers.rb +29 -16
  295. data/lib/increase/version.rb +1 -1
  296. data/rbi/increase/models/check_transfer.rbi +8 -0
  297. data/rbi/increase/models/check_transfer_create_params.rbi +35 -36
  298. data/rbi/increase/models/entity_list_params.rbi +119 -0
  299. data/rbi/increase/models/pending_transaction_create_params.rbi +4 -4
  300. data/rbi/increase/resources/entities.rbi +3 -0
  301. data/rbi/increase/resources/pending_transactions.rbi +2 -2
  302. data/sig/increase/models/check_transfer.rbs +5 -0
  303. data/sig/increase/models/check_transfer_create_params.rbs +12 -9
  304. data/sig/increase/models/entity_list_params.rbs +48 -1
  305. data/sig/increase/resources/entities.rbs +1 -0
  306. metadata +2 -2
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: deae4b48118e89a25a1559893ff12bc9722e553b9eeba2ddaa76ed37f78f7d9c
4
- data.tar.gz: 9bcd9d146a853046d5b901b3f0e42841865677558650431c2d24f31e33c052a9
3
+ metadata.gz: ab4493ffa54abfc98fa5da905c198e1bb148b8c48196b143d6673e465f92d545
4
+ data.tar.gz: 52aea4fdf7ef614d1f6eca7156416eb519a927aa6617251514dbe0d1546de7ca
5
5
  SHA512:
6
- metadata.gz: b6e84bfe78d5de6423532cbbf4556010c4bd0e4696ba8a31840465d4b36d9fb6820b5015a5ce8d7dbf4c68a24658e19b70dc8b9a69f393e2dae8f46e9e1d5206
7
- data.tar.gz: 9f081ff4b25b781f9dbe47ffc12cc81856e1ab58a3cd47e937d5d85e27cd1e40ea310d664543d74ef8a378cc40a26bca2da6a866ae758c122130f07e795dde51
6
+ metadata.gz: 8eb6199c0fe350de36591f66b19d8332249559d6be63f271b4244365b4483df3cd5e142421ddaebce22c77a4f32df1f7d0cbe12bd0cb7c37802e55c07fdc4a05
7
+ data.tar.gz: e828cef340e904a77629bfd7e79f32e1c327d7252ae044450a5a8ac6d2b06bbb8a16d7acf9d609eeb5f234de1077ab024b3f8e116d5201d459ebb6d98ac74b4b
data/README.md CHANGED
@@ -15,7 +15,7 @@ To use this gem, install via Bundler by adding the following to your application
15
15
  <!-- x-release-please-start-version -->
16
16
 
17
17
  ```ruby
18
- gem "increase", "~> 1.340.0"
18
+ gem "increase", "~> 1.341.0"
19
19
  ```
20
20
 
21
21
  <!-- x-release-please-end -->
@@ -212,15 +212,17 @@ module Increase
212
212
  #
213
213
  # @param webhook_secret [String, nil] Defaults to `ENV["INCREASE_WEBHOOK_SECRET"]`
214
214
  #
215
- # @param environment [:production, :sandbox, nil] Specifies the environment to use for the API.
215
+ # @param environment [:production, :sandbox, nil]
216
+ # Specifies the environment to use for the API.
216
217
  #
217
- # Each environment maps to a different base URL:
218
+ # Each environment maps to a different base URL:
218
219
  #
219
- # - `production` corresponds to `https://api.increase.com`
220
- # - `sandbox` corresponds to `https://sandbox.increase.com`
220
+ # - `production` corresponds to `https://api.increase.com`
221
+ # - `sandbox` corresponds to `https://sandbox.increase.com`
221
222
  #
222
- # @param base_url [String, nil] Override the default base URL for the API, e.g.,
223
- # `"https://api.example.com/v2/"`. Defaults to `ENV["INCREASE_BASE_URL"]`
223
+ # @param base_url [String, nil]
224
+ # Override the default base URL for the API, e.g.,
225
+ # `"https://api.example.com/v2/"`. Defaults to `ENV["INCREASE_BASE_URL"]`
224
226
  #
225
227
  # @param max_retries [Integer] Max number of retries to attempt after a failed retryable request.
226
228
  #
@@ -156,22 +156,23 @@ module Increase
156
156
  #
157
157
  # @param value [Object]
158
158
  #
159
- # @param state [Hash{Symbol=>Object}] The `strictness` is one of `true`, `false`. This informs the coercion strategy
160
- # when we have to decide between multiple possible conversion targets:
159
+ # @param state [Hash{Symbol=>Object}]
160
+ # The `strictness` is one of `true`, `false`. This informs the coercion strategy
161
+ # when we have to decide between multiple possible conversion targets:
161
162
  #
162
- # - `true`: the conversion must be exact, with minimum coercion.
163
- # - `false`: the conversion can be approximate, with some coercion.
163
+ # - `true`: the conversion must be exact, with minimum coercion.
164
+ # - `false`: the conversion can be approximate, with some coercion.
164
165
  #
165
- # The `exactness` is `Hash` with keys being one of `yes`, `no`, or `maybe`. For
166
- # any given conversion attempt, the exactness will be updated based on how closely
167
- # the value recursively matches the target type:
166
+ # The `exactness` is `Hash` with keys being one of `yes`, `no`, or `maybe`. For
167
+ # any given conversion attempt, the exactness will be updated based on how closely
168
+ # the value recursively matches the target type:
168
169
  #
169
- # - `yes`: the value can be converted to the target type with minimum coercion.
170
- # - `maybe`: the value can be converted to the target type with some reasonable
171
- # coercion.
172
- # - `no`: the value cannot be converted to the target type.
170
+ # - `yes`: the value can be converted to the target type with minimum coercion.
171
+ # - `maybe`: the value can be converted to the target type with some reasonable
172
+ # coercion.
173
+ # - `no`: the value cannot be converted to the target type.
173
174
  #
174
- # See implementation below for more details.
175
+ # See implementation below for more details.
175
176
  #
176
177
  # @option state [Boolean] :translate_names
177
178
  #
@@ -114,43 +114,64 @@ module Increase
114
114
  required :type, enum: -> { Increase::Account::Type }
115
115
 
116
116
  # @!method initialize(id:, account_revenue_rate:, bank:, closed_at:, created_at:, currency:, entity_id:, funding:, idempotency_key:, informational_entity_id:, interest_rate:, loan:, name:, program_id:, status:, type:)
117
- # Some parameter documentations has been truncated, see
118
- # {Increase::Models::Account} for more details.
119
- #
120
117
  # Accounts are your bank accounts with Increase. They store money, receive
121
118
  # transfers, and send payments. They earn interest and have depository insurance.
122
119
  #
123
120
  # @param id [String] The Account identifier.
124
121
  #
125
- # @param account_revenue_rate [String, nil] The account revenue rate currently being earned on the account, as a string cont
122
+ # @param account_revenue_rate [String, nil]
123
+ # The account revenue rate currently being earned on the account, as a string
124
+ # containing a decimal number. For example, a 1% account revenue rate would be
125
+ # represented as "0.01". Account revenue is a type of non-interest income accrued
126
+ # on the account.
126
127
  #
127
128
  # @param bank [Symbol, Increase::Models::Account::Bank] The bank the Account is with.
128
129
  #
129
- # @param closed_at [Time, nil] The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the Account
130
+ # @param closed_at [Time, nil]
131
+ # The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the Account
132
+ # was closed.
130
133
  #
131
- # @param created_at [Time] The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the Account
134
+ # @param created_at [Time]
135
+ # The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the Account
136
+ # was created.
132
137
  #
133
- # @param currency [Symbol, Increase::Models::Account::Currency] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the Account curr
138
+ # @param currency [Symbol, Increase::Models::Account::Currency]
139
+ # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the Account
140
+ # currency.
134
141
  #
135
142
  # @param entity_id [String] The identifier for the Entity the Account belongs to.
136
143
  #
137
- # @param funding [Symbol, Increase::Models::Account::Funding] Whether the Account is funded by a loan or by deposits.
144
+ # @param funding [Symbol, Increase::Models::Account::Funding]
145
+ # Whether the Account is funded by a loan or by deposits.
138
146
  #
139
- # @param idempotency_key [String, nil] The idempotency key you chose for this object. This value is unique across Incre
147
+ # @param idempotency_key [String, nil]
148
+ # The idempotency key you chose for this object. This value is unique across
149
+ # Increase and is used to ensure that a request is only processed once. Learn more
150
+ # about [idempotency](https://increase.com/documentation/idempotency-keys).
140
151
  #
141
- # @param informational_entity_id [String, nil] The identifier of an Entity that, while not owning the Account, is associated wi
152
+ # @param informational_entity_id [String, nil]
153
+ # The identifier of an Entity that, while not owning the Account, is associated
154
+ # with its activity.
142
155
  #
143
- # @param interest_rate [String] The interest rate currently being earned on the account, as a string containing
156
+ # @param interest_rate [String]
157
+ # The interest rate currently being earned on the account, as a string containing
158
+ # a decimal number. For example, a 1% interest rate would be represented as
159
+ # "0.01".
144
160
  #
145
- # @param loan [Increase::Models::Account::Loan, nil] The Account's loan-related information, if the Account is a loan account.
161
+ # @param loan [Increase::Models::Account::Loan, nil]
162
+ # The Account's loan-related information, if the Account is a loan account.
146
163
  #
147
164
  # @param name [String] The name you choose for the Account.
148
165
  #
149
- # @param program_id [String] The identifier of the Program determining the compliance and commercial terms of
166
+ # @param program_id [String]
167
+ # The identifier of the Program determining the compliance and commercial terms of
168
+ # this Account.
150
169
  #
151
170
  # @param status [Symbol, Increase::Models::Account::Status] The status of the Account.
152
171
  #
153
- # @param type [Symbol, Increase::Models::Account::Type] A constant representing the object's type. For this resource it will always be `
172
+ # @param type [Symbol, Increase::Models::Account::Type]
173
+ # A constant representing the object's type. For this resource it will always be
174
+ # `account`.
154
175
 
155
176
  # The bank the Account is with.
156
177
  #
@@ -235,20 +256,20 @@ module Increase
235
256
  required :statement_payment_type, enum: -> { Increase::Account::Loan::StatementPaymentType }
236
257
 
237
258
  # @!method initialize(credit_limit:, grace_period_days:, maturity_date:, statement_day_of_month:, statement_payment_type:)
238
- # Some parameter documentations has been truncated, see
239
- # {Increase::Models::Account::Loan} for more details.
240
- #
241
259
  # The Account's loan-related information, if the Account is a loan account.
242
260
  #
243
261
  # @param credit_limit [Integer] The maximum amount of money that can be borrowed on the Account.
244
262
  #
245
- # @param grace_period_days [Integer] The number of days after the statement date that the Account can be past due bef
263
+ # @param grace_period_days [Integer]
264
+ # The number of days after the statement date that the Account can be past due
265
+ # before being considered delinquent.
246
266
  #
247
267
  # @param maturity_date [Date, nil] The date on which the loan matures.
248
268
  #
249
269
  # @param statement_day_of_month [Integer] The day of the month on which the loan statement is generated.
250
270
  #
251
- # @param statement_payment_type [Symbol, Increase::Models::Account::Loan::StatementPaymentType] The type of payment for the loan.
271
+ # @param statement_payment_type [Symbol, Increase::Models::Account::Loan::StatementPaymentType]
272
+ # The type of payment for the loan.
252
273
 
253
274
  # The type of payment for the loan.
254
275
  #
@@ -47,20 +47,23 @@ module Increase
47
47
  optional :program_id, String
48
48
 
49
49
  # @!method initialize(name:, entity_id: nil, funding: nil, informational_entity_id: nil, loan: nil, program_id: nil, request_options: {})
50
- # Some parameter documentations has been truncated, see
51
- # {Increase::Models::AccountCreateParams} for more details.
52
- #
53
50
  # @param name [String] The name you choose for the Account.
54
51
  #
55
52
  # @param entity_id [String] The identifier for the Entity that will own the Account.
56
53
  #
57
- # @param funding [Symbol, Increase::Models::AccountCreateParams::Funding] Whether the Account is funded by a loan or by deposits.
54
+ # @param funding [Symbol, Increase::Models::AccountCreateParams::Funding]
55
+ # Whether the Account is funded by a loan or by deposits.
58
56
  #
59
- # @param informational_entity_id [String] The identifier of an Entity that, while not owning the Account, is associated wi
57
+ # @param informational_entity_id [String]
58
+ # The identifier of an Entity that, while not owning the Account, is associated
59
+ # with its activity. This is generally the beneficiary of the funds.
60
60
  #
61
61
  # @param loan [Increase::Models::AccountCreateParams::Loan] The loan details for the account.
62
62
  #
63
- # @param program_id [String] The identifier for the Program that this Account falls under. Required if your G
63
+ # @param program_id [String]
64
+ # The identifier for the Program that this Account falls under. Required if your
65
+ # Group operates more than one Program. List your [Programs](#programs) to find
66
+ # their identifiers.
64
67
  #
65
68
  # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}]
66
69
 
@@ -111,18 +114,18 @@ module Increase
111
114
  optional :maturity_date, Date
112
115
 
113
116
  # @!method initialize(credit_limit:, grace_period_days:, statement_day_of_month:, statement_payment_type:, maturity_date: nil)
114
- # Some parameter documentations has been truncated, see
115
- # {Increase::Models::AccountCreateParams::Loan} for more details.
116
- #
117
117
  # The loan details for the account.
118
118
  #
119
119
  # @param credit_limit [Integer] The maximum amount of money that can be drawn from the Account.
120
120
  #
121
- # @param grace_period_days [Integer] The number of days after the statement date that the Account can be past due bef
121
+ # @param grace_period_days [Integer]
122
+ # The number of days after the statement date that the Account can be past due
123
+ # before being considered delinquent.
122
124
  #
123
125
  # @param statement_day_of_month [Integer] The day of the month on which the loan statement is generated.
124
126
  #
125
- # @param statement_payment_type [Symbol, Increase::Models::AccountCreateParams::Loan::StatementPaymentType] The type of statement payment for the account.
127
+ # @param statement_payment_type [Symbol, Increase::Models::AccountCreateParams::Loan::StatementPaymentType]
128
+ # The type of statement payment for the account.
126
129
  #
127
130
  # @param maturity_date [Date] The date on which the loan matures.
128
131
 
@@ -58,20 +58,24 @@ module Increase
58
58
  optional :status, -> { Increase::AccountListParams::Status }
59
59
 
60
60
  # @!method initialize(created_at: nil, cursor: nil, entity_id: nil, idempotency_key: nil, informational_entity_id: nil, limit: nil, program_id: nil, status: nil, request_options: {})
61
- # Some parameter documentations has been truncated, see
62
- # {Increase::Models::AccountListParams} for more details.
63
- #
64
61
  # @param created_at [Increase::Models::AccountListParams::CreatedAt]
65
62
  #
66
63
  # @param cursor [String] Return the page of entries after this one.
67
64
  #
68
65
  # @param entity_id [String] Filter Accounts for those belonging to the specified Entity.
69
66
  #
70
- # @param idempotency_key [String] Filter records to the one with the specified `idempotency_key` you chose for tha
67
+ # @param idempotency_key [String]
68
+ # Filter records to the one with the specified `idempotency_key` you chose for
69
+ # that object. This value is unique across Increase and is used to ensure that a
70
+ # request is only processed once. Learn more about
71
+ # [idempotency](https://increase.com/documentation/idempotency-keys).
71
72
  #
72
- # @param informational_entity_id [String] Filter Accounts for those belonging to the specified Entity as informational.
73
+ # @param informational_entity_id [String]
74
+ # Filter Accounts for those belonging to the specified Entity as informational.
73
75
  #
74
- # @param limit [Integer] Limit the size of the list that is returned. The default (and maximum) is 100 ob
76
+ # @param limit [Integer]
77
+ # Limit the size of the list that is returned. The default (and maximum) is 100
78
+ # objects.
75
79
  #
76
80
  # @param program_id [String] Filter Accounts for those in a specific Program.
77
81
  #
@@ -109,16 +113,21 @@ module Increase
109
113
  optional :on_or_before, Time
110
114
 
111
115
  # @!method initialize(after: nil, before: nil, on_or_after: nil, on_or_before: nil)
112
- # Some parameter documentations has been truncated, see
113
- # {Increase::Models::AccountListParams::CreatedAt} for more details.
114
- #
115
- # @param after [Time] Return results after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) tim
116
+ # @param after [Time]
117
+ # Return results after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)
118
+ # timestamp.
116
119
  #
117
- # @param before [Time] Return results before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) ti
120
+ # @param before [Time]
121
+ # Return results before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)
122
+ # timestamp.
118
123
  #
119
- # @param on_or_after [Time] Return results on or after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_860
124
+ # @param on_or_after [Time]
125
+ # Return results on or after this
126
+ # [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.
120
127
  #
121
- # @param on_or_before [Time] Return results on or before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_86
128
+ # @param on_or_before [Time]
129
+ # Return results on or before this
130
+ # [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.
122
131
  end
123
132
 
124
133
  class Status < Increase::Internal::Type::BaseModel
@@ -132,10 +141,9 @@ module Increase
132
141
  api_name: :in
133
142
 
134
143
  # @!method initialize(in_: nil)
135
- # Some parameter documentations has been truncated, see
136
- # {Increase::Models::AccountListParams::Status} for more details.
137
- #
138
- # @param in_ [Array<Symbol, Increase::Models::AccountListParams::Status::In>] Filter Accounts for those with the specified status. For GET requests, this shou
144
+ # @param in_ [Array<Symbol, Increase::Models::AccountListParams::Status::In>]
145
+ # Filter Accounts for those with the specified status. For GET requests, this
146
+ # should be encoded as a comma-delimited string, such as `?in=one,two,three`.
139
147
 
140
148
  module In
141
149
  extend Increase::Internal::Type::Enum
@@ -76,9 +76,6 @@ module Increase
76
76
  required :type, enum: -> { Increase::AccountNumber::Type }
77
77
 
78
78
  # @!method initialize(id:, account_id:, account_number:, created_at:, idempotency_key:, inbound_ach:, inbound_checks:, name:, routing_number:, status:, type:)
79
- # Some parameter documentations has been truncated, see
80
- # {Increase::Models::AccountNumber} for more details.
81
- #
82
79
  # Each account can have multiple account and routing numbers. We recommend that
83
80
  # you use a set per vendor. This is similar to how you use different passwords for
84
81
  # different websites. Account numbers can also be used to seamlessly reconcile
@@ -91,21 +88,32 @@ module Increase
91
88
  #
92
89
  # @param account_number [String] The account number.
93
90
  #
94
- # @param created_at [Time] The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the Account
91
+ # @param created_at [Time]
92
+ # The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the Account
93
+ # Number was created.
95
94
  #
96
- # @param idempotency_key [String, nil] The idempotency key you chose for this object. This value is unique across Incre
95
+ # @param idempotency_key [String, nil]
96
+ # The idempotency key you chose for this object. This value is unique across
97
+ # Increase and is used to ensure that a request is only processed once. Learn more
98
+ # about [idempotency](https://increase.com/documentation/idempotency-keys).
97
99
  #
98
- # @param inbound_ach [Increase::Models::AccountNumber::InboundACH] Properties related to how this Account Number handles inbound ACH transfers.
100
+ # @param inbound_ach [Increase::Models::AccountNumber::InboundACH]
101
+ # Properties related to how this Account Number handles inbound ACH transfers.
99
102
  #
100
- # @param inbound_checks [Increase::Models::AccountNumber::InboundChecks] Properties related to how this Account Number should handle inbound check withdr
103
+ # @param inbound_checks [Increase::Models::AccountNumber::InboundChecks]
104
+ # Properties related to how this Account Number should handle inbound check
105
+ # withdrawals.
101
106
  #
102
107
  # @param name [String] The name you choose for the Account Number.
103
108
  #
104
109
  # @param routing_number [String] The American Bankers' Association (ABA) Routing Transit Number (RTN).
105
110
  #
106
- # @param status [Symbol, Increase::Models::AccountNumber::Status] This indicates if payments can be made to the Account Number.
111
+ # @param status [Symbol, Increase::Models::AccountNumber::Status]
112
+ # This indicates if payments can be made to the Account Number.
107
113
  #
108
- # @param type [Symbol, Increase::Models::AccountNumber::Type] A constant representing the object's type. For this resource it will always be `
114
+ # @param type [Symbol, Increase::Models::AccountNumber::Type]
115
+ # A constant representing the object's type. For this resource it will always be
116
+ # `account_number`.
109
117
 
110
118
  # @see Increase::Models::AccountNumber#inbound_ach
111
119
  class InboundACH < Increase::Internal::Type::BaseModel
@@ -117,12 +125,11 @@ module Increase
117
125
  required :debit_status, enum: -> { Increase::AccountNumber::InboundACH::DebitStatus }
118
126
 
119
127
  # @!method initialize(debit_status:)
120
- # Some parameter documentations has been truncated, see
121
- # {Increase::Models::AccountNumber::InboundACH} for more details.
122
- #
123
128
  # Properties related to how this Account Number handles inbound ACH transfers.
124
129
  #
125
- # @param debit_status [Symbol, Increase::Models::AccountNumber::InboundACH::DebitStatus] Whether ACH debits are allowed against this Account Number. Note that they will
130
+ # @param debit_status [Symbol, Increase::Models::AccountNumber::InboundACH::DebitStatus]
131
+ # Whether ACH debits are allowed against this Account Number. Note that they will
132
+ # still be declined if this is `allowed` if the Account Number is not active.
126
133
 
127
134
  # Whether ACH debits are allowed against this Account Number. Note that they will
128
135
  # still be declined if this is `allowed` if the Account Number is not active.
@@ -154,7 +161,8 @@ module Increase
154
161
  # Properties related to how this Account Number should handle inbound check
155
162
  # withdrawals.
156
163
  #
157
- # @param status [Symbol, Increase::Models::AccountNumber::InboundChecks::Status] How Increase should process checks with this account number printed on them.
164
+ # @param status [Symbol, Increase::Models::AccountNumber::InboundChecks::Status]
165
+ # How Increase should process checks with this account number printed on them.
158
166
 
159
167
  # How Increase should process checks with this account number printed on them.
160
168
  #
@@ -33,16 +33,16 @@ module Increase
33
33
  optional :inbound_checks, -> { Increase::AccountNumberCreateParams::InboundChecks }
34
34
 
35
35
  # @!method initialize(account_id:, name:, inbound_ach: nil, inbound_checks: nil, request_options: {})
36
- # Some parameter documentations has been truncated, see
37
- # {Increase::Models::AccountNumberCreateParams} for more details.
38
- #
39
36
  # @param account_id [String] The Account the Account Number should belong to.
40
37
  #
41
38
  # @param name [String] The name you choose for the Account Number.
42
39
  #
43
- # @param inbound_ach [Increase::Models::AccountNumberCreateParams::InboundACH] Options related to how this Account Number should handle inbound ACH transfers.
40
+ # @param inbound_ach [Increase::Models::AccountNumberCreateParams::InboundACH]
41
+ # Options related to how this Account Number should handle inbound ACH transfers.
44
42
  #
45
- # @param inbound_checks [Increase::Models::AccountNumberCreateParams::InboundChecks] Options related to how this Account Number should handle inbound check withdrawa
43
+ # @param inbound_checks [Increase::Models::AccountNumberCreateParams::InboundChecks]
44
+ # Options related to how this Account Number should handle inbound check
45
+ # withdrawals.
46
46
  #
47
47
  # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}]
48
48
 
@@ -56,12 +56,12 @@ module Increase
56
56
  required :debit_status, enum: -> { Increase::AccountNumberCreateParams::InboundACH::DebitStatus }
57
57
 
58
58
  # @!method initialize(debit_status:)
59
- # Some parameter documentations has been truncated, see
60
- # {Increase::Models::AccountNumberCreateParams::InboundACH} for more details.
61
- #
62
59
  # Options related to how this Account Number should handle inbound ACH transfers.
63
60
  #
64
- # @param debit_status [Symbol, Increase::Models::AccountNumberCreateParams::InboundACH::DebitStatus] Whether ACH debits are allowed against this Account Number. Note that ACH debits
61
+ # @param debit_status [Symbol, Increase::Models::AccountNumberCreateParams::InboundACH::DebitStatus]
62
+ # Whether ACH debits are allowed against this Account Number. Note that ACH debits
63
+ # will be declined if this is `allowed` but the Account Number is not active. If
64
+ # you do not specify this field, the default is `allowed`.
65
65
 
66
66
  # Whether ACH debits are allowed against this Account Number. Note that ACH debits
67
67
  # will be declined if this is `allowed` but the Account Number is not active. If
@@ -91,13 +91,12 @@ module Increase
91
91
  required :status, enum: -> { Increase::AccountNumberCreateParams::InboundChecks::Status }
92
92
 
93
93
  # @!method initialize(status:)
94
- # Some parameter documentations has been truncated, see
95
- # {Increase::Models::AccountNumberCreateParams::InboundChecks} for more details.
96
- #
97
94
  # Options related to how this Account Number should handle inbound check
98
95
  # withdrawals.
99
96
  #
100
- # @param status [Symbol, Increase::Models::AccountNumberCreateParams::InboundChecks::Status] How Increase should process checks with this account number printed on them. If
97
+ # @param status [Symbol, Increase::Models::AccountNumberCreateParams::InboundChecks::Status]
98
+ # How Increase should process checks with this account number printed on them. If
99
+ # you do not specify this field, the default is `check_transfers_only`.
101
100
 
102
101
  # How Increase should process checks with this account number printed on them. If
103
102
  # you do not specify this field, the default is `check_transfers_only`.
@@ -51,9 +51,6 @@ module Increase
51
51
  optional :status, -> { Increase::AccountNumberListParams::Status }
52
52
 
53
53
  # @!method initialize(account_id: nil, ach_debit_status: nil, created_at: nil, cursor: nil, idempotency_key: nil, limit: nil, status: nil, request_options: {})
54
- # Some parameter documentations has been truncated, see
55
- # {Increase::Models::AccountNumberListParams} for more details.
56
- #
57
54
  # @param account_id [String] Filter Account Numbers to those belonging to the specified Account.
58
55
  #
59
56
  # @param ach_debit_status [Increase::Models::AccountNumberListParams::ACHDebitStatus]
@@ -62,9 +59,15 @@ module Increase
62
59
  #
63
60
  # @param cursor [String] Return the page of entries after this one.
64
61
  #
65
- # @param idempotency_key [String] Filter records to the one with the specified `idempotency_key` you chose for tha
62
+ # @param idempotency_key [String]
63
+ # Filter records to the one with the specified `idempotency_key` you chose for
64
+ # that object. This value is unique across Increase and is used to ensure that a
65
+ # request is only processed once. Learn more about
66
+ # [idempotency](https://increase.com/documentation/idempotency-keys).
66
67
  #
67
- # @param limit [Integer] Limit the size of the list that is returned. The default (and maximum) is 100 ob
68
+ # @param limit [Integer]
69
+ # Limit the size of the list that is returned. The default (and maximum) is 100
70
+ # objects.
68
71
  #
69
72
  # @param status [Increase::Models::AccountNumberListParams::Status]
70
73
  #
@@ -83,10 +86,9 @@ module Increase
83
86
  api_name: :in
84
87
 
85
88
  # @!method initialize(in_: nil)
86
- # Some parameter documentations has been truncated, see
87
- # {Increase::Models::AccountNumberListParams::ACHDebitStatus} for more details.
88
- #
89
- # @param in_ [Array<Symbol, Increase::Models::AccountNumberListParams::ACHDebitStatus::In>] The ACH Debit status to retrieve Account Numbers for. For GET requests, this sho
89
+ # @param in_ [Array<Symbol, Increase::Models::AccountNumberListParams::ACHDebitStatus::In>]
90
+ # The ACH Debit status to retrieve Account Numbers for. For GET requests, this
91
+ # should be encoded as a comma-delimited string, such as `?in=one,two,three`.
90
92
 
91
93
  module In
92
94
  extend Increase::Internal::Type::Enum
@@ -132,16 +134,21 @@ module Increase
132
134
  optional :on_or_before, Time
133
135
 
134
136
  # @!method initialize(after: nil, before: nil, on_or_after: nil, on_or_before: nil)
135
- # Some parameter documentations has been truncated, see
136
- # {Increase::Models::AccountNumberListParams::CreatedAt} for more details.
137
+ # @param after [Time]
138
+ # Return results after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)
139
+ # timestamp.
137
140
  #
138
- # @param after [Time] Return results after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) tim
141
+ # @param before [Time]
142
+ # Return results before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)
143
+ # timestamp.
139
144
  #
140
- # @param before [Time] Return results before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) ti
145
+ # @param on_or_after [Time]
146
+ # Return results on or after this
147
+ # [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.
141
148
  #
142
- # @param on_or_after [Time] Return results on or after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_860
143
- #
144
- # @param on_or_before [Time] Return results on or before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_86
149
+ # @param on_or_before [Time]
150
+ # Return results on or before this
151
+ # [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.
145
152
  end
146
153
 
147
154
  class Status < Increase::Internal::Type::BaseModel
@@ -157,10 +164,9 @@ module Increase
157
164
  api_name: :in
158
165
 
159
166
  # @!method initialize(in_: nil)
160
- # Some parameter documentations has been truncated, see
161
- # {Increase::Models::AccountNumberListParams::Status} for more details.
162
- #
163
- # @param in_ [Array<Symbol, Increase::Models::AccountNumberListParams::Status::In>] The status to retrieve Account Numbers for. For GET requests, this should be enc
167
+ # @param in_ [Array<Symbol, Increase::Models::AccountNumberListParams::Status::In>]
168
+ # The status to retrieve Account Numbers for. For GET requests, this should be
169
+ # encoded as a comma-delimited string, such as `?in=one,two,three`.
164
170
 
165
171
  module In
166
172
  extend Increase::Internal::Type::Enum
@@ -39,18 +39,19 @@ module Increase
39
39
  optional :status, enum: -> { Increase::AccountNumberUpdateParams::Status }
40
40
 
41
41
  # @!method initialize(account_number_id:, inbound_ach: nil, inbound_checks: nil, name: nil, status: nil, request_options: {})
42
- # Some parameter documentations has been truncated, see
43
- # {Increase::Models::AccountNumberUpdateParams} for more details.
44
- #
45
42
  # @param account_number_id [String] The identifier of the Account Number.
46
43
  #
47
- # @param inbound_ach [Increase::Models::AccountNumberUpdateParams::InboundACH] Options related to how this Account Number handles inbound ACH transfers.
44
+ # @param inbound_ach [Increase::Models::AccountNumberUpdateParams::InboundACH]
45
+ # Options related to how this Account Number handles inbound ACH transfers.
48
46
  #
49
- # @param inbound_checks [Increase::Models::AccountNumberUpdateParams::InboundChecks] Options related to how this Account Number should handle inbound check withdrawa
47
+ # @param inbound_checks [Increase::Models::AccountNumberUpdateParams::InboundChecks]
48
+ # Options related to how this Account Number should handle inbound check
49
+ # withdrawals.
50
50
  #
51
51
  # @param name [String] The name you choose for the Account Number.
52
52
  #
53
- # @param status [Symbol, Increase::Models::AccountNumberUpdateParams::Status] This indicates if transfers can be made to the Account Number.
53
+ # @param status [Symbol, Increase::Models::AccountNumberUpdateParams::Status]
54
+ # This indicates if transfers can be made to the Account Number.
54
55
  #
55
56
  # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}]
56
57
 
@@ -63,12 +64,11 @@ module Increase
63
64
  optional :debit_status, enum: -> { Increase::AccountNumberUpdateParams::InboundACH::DebitStatus }
64
65
 
65
66
  # @!method initialize(debit_status: nil)
66
- # Some parameter documentations has been truncated, see
67
- # {Increase::Models::AccountNumberUpdateParams::InboundACH} for more details.
68
- #
69
67
  # Options related to how this Account Number handles inbound ACH transfers.
70
68
  #
71
- # @param debit_status [Symbol, Increase::Models::AccountNumberUpdateParams::InboundACH::DebitStatus] Whether ACH debits are allowed against this Account Number. Note that ACH debits
69
+ # @param debit_status [Symbol, Increase::Models::AccountNumberUpdateParams::InboundACH::DebitStatus]
70
+ # Whether ACH debits are allowed against this Account Number. Note that ACH debits
71
+ # will be declined if this is `allowed` but the Account Number is not active.
72
72
 
73
73
  # Whether ACH debits are allowed against this Account Number. Note that ACH debits
74
74
  # will be declined if this is `allowed` but the Account Number is not active.
@@ -99,7 +99,8 @@ module Increase
99
99
  # Options related to how this Account Number should handle inbound check
100
100
  # withdrawals.
101
101
  #
102
- # @param status [Symbol, Increase::Models::AccountNumberUpdateParams::InboundChecks::Status] How Increase should process checks with this account number printed on them.
102
+ # @param status [Symbol, Increase::Models::AccountNumberUpdateParams::InboundChecks::Status]
103
+ # How Increase should process checks with this account number printed on them.
103
104
 
104
105
  # How Increase should process checks with this account number printed on them.
105
106
  #