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
@@ -159,9 +159,6 @@ module Increase
159
159
  required :voided_check, -> { Increase::Export::VoidedCheck }, nil?: true
160
160
 
161
161
  # @!method initialize(id:, account_statement_bai2:, account_statement_ofx:, account_verification_letter:, balance_csv:, bookkeeping_account_balance_csv:, category:, created_at:, daily_account_balance_csv:, dashboard_table_csv:, entity_csv:, fee_csv:, form_1099_int:, form_1099_misc:, funding_instructions:, idempotency_key:, result:, status:, transaction_csv:, type:, vendor_csv:, voided_check:)
162
- # Some parameter documentations has been truncated, see {Increase::Models::Export}
163
- # for more details.
164
- #
165
162
  # Exports are generated files. Some exports can contain a lot of data, like a CSV
166
163
  # of your transactions. Others can be a single document, like a tax form. Since
167
164
  # they can take a while, they are generated asynchronously. We send a webhook when
@@ -170,47 +167,86 @@ module Increase
170
167
  #
171
168
  # @param id [String] The Export identifier.
172
169
  #
173
- # @param account_statement_bai2 [Increase::Models::Export::AccountStatementBai2, nil] Details of the account statement BAI2 export. This field will be present when th
170
+ # @param account_statement_bai2 [Increase::Models::Export::AccountStatementBai2, nil]
171
+ # Details of the account statement BAI2 export. This field will be present when
172
+ # the `category` is equal to `account_statement_bai2`.
174
173
  #
175
- # @param account_statement_ofx [Increase::Models::Export::AccountStatementOfx, nil] Details of the account statement OFX export. This field will be present when the
174
+ # @param account_statement_ofx [Increase::Models::Export::AccountStatementOfx, nil]
175
+ # Details of the account statement OFX export. This field will be present when the
176
+ # `category` is equal to `account_statement_ofx`.
176
177
  #
177
- # @param account_verification_letter [Increase::Models::Export::AccountVerificationLetter, nil] Details of the account verification letter export. This field will be present wh
178
+ # @param account_verification_letter [Increase::Models::Export::AccountVerificationLetter, nil]
179
+ # Details of the account verification letter export. This field will be present
180
+ # when the `category` is equal to `account_verification_letter`.
178
181
  #
179
- # @param balance_csv [Increase::Models::Export::BalanceCsv, nil] Details of the balance CSV export. This field will be present when the `category
182
+ # @param balance_csv [Increase::Models::Export::BalanceCsv, nil]
183
+ # Details of the balance CSV export. This field will be present when the
184
+ # `category` is equal to `balance_csv`.
180
185
  #
181
- # @param bookkeeping_account_balance_csv [Increase::Models::Export::BookkeepingAccountBalanceCsv, nil] Details of the bookkeeping account balance CSV export. This field will be presen
186
+ # @param bookkeeping_account_balance_csv [Increase::Models::Export::BookkeepingAccountBalanceCsv, nil]
187
+ # Details of the bookkeeping account balance CSV export. This field will be
188
+ # present when the `category` is equal to `bookkeeping_account_balance_csv`.
182
189
  #
183
- # @param category [Symbol, Increase::Models::Export::Category] The category of the Export. We may add additional possible values for this enum
190
+ # @param category [Symbol, Increase::Models::Export::Category]
191
+ # The category of the Export. We may add additional possible values for this enum
192
+ # over time; your application should be able to handle that gracefully.
184
193
  #
185
194
  # @param created_at [Time] The time the Export was created.
186
195
  #
187
- # @param daily_account_balance_csv [Increase::Models::Export::DailyAccountBalanceCsv, nil] Details of the daily account balance CSV export. This field will be present when
196
+ # @param daily_account_balance_csv [Increase::Models::Export::DailyAccountBalanceCsv, nil]
197
+ # Details of the daily account balance CSV export. This field will be present when
198
+ # the `category` is equal to `daily_account_balance_csv`.
188
199
  #
189
- # @param dashboard_table_csv [Increase::Models::Export::DashboardTableCsv, nil] Details of the dashboard table CSV export. This field will be present when the `
200
+ # @param dashboard_table_csv [Increase::Models::Export::DashboardTableCsv, nil]
201
+ # Details of the dashboard table CSV export. This field will be present when the
202
+ # `category` is equal to `dashboard_table_csv`.
190
203
  #
191
- # @param entity_csv [Increase::Models::Export::EntityCsv, nil] Details of the entity CSV export. This field will be present when the `category`
204
+ # @param entity_csv [Increase::Models::Export::EntityCsv, nil]
205
+ # Details of the entity CSV export. This field will be present when the `category`
206
+ # is equal to `entity_csv`.
192
207
  #
193
- # @param fee_csv [Increase::Models::Export::FeeCsv, nil] Details of the fee CSV export. This field will be present when the `category` is
208
+ # @param fee_csv [Increase::Models::Export::FeeCsv, nil]
209
+ # Details of the fee CSV export. This field will be present when the `category` is
210
+ # equal to `fee_csv`.
194
211
  #
195
- # @param form_1099_int [Increase::Models::Export::Form1099Int, nil] Details of the Form 1099-INT export. This field will be present when the `catego
212
+ # @param form_1099_int [Increase::Models::Export::Form1099Int, nil]
213
+ # Details of the Form 1099-INT export. This field will be present when the
214
+ # `category` is equal to `form_1099_int`.
196
215
  #
197
- # @param form_1099_misc [Increase::Models::Export::Form1099Misc, nil] Details of the Form 1099-MISC export. This field will be present when the `categ
216
+ # @param form_1099_misc [Increase::Models::Export::Form1099Misc, nil]
217
+ # Details of the Form 1099-MISC export. This field will be present when the
218
+ # `category` is equal to `form_1099_misc`.
198
219
  #
199
- # @param funding_instructions [Increase::Models::Export::FundingInstructions, nil] Details of the funding instructions export. This field will be present when the
220
+ # @param funding_instructions [Increase::Models::Export::FundingInstructions, nil]
221
+ # Details of the funding instructions export. This field will be present when the
222
+ # `category` is equal to `funding_instructions`.
200
223
  #
201
- # @param idempotency_key [String, nil] The idempotency key you chose for this object. This value is unique across Incre
224
+ # @param idempotency_key [String, nil]
225
+ # The idempotency key you chose for this object. This value is unique across
226
+ # Increase and is used to ensure that a request is only processed once. Learn more
227
+ # about [idempotency](https://increase.com/documentation/idempotency-keys).
202
228
  #
203
- # @param result [Increase::Models::Export::Result, nil] The result of the Export. This will be present when the Export's status transiti
229
+ # @param result [Increase::Models::Export::Result, nil]
230
+ # The result of the Export. This will be present when the Export's status
231
+ # transitions to `complete`.
204
232
  #
205
233
  # @param status [Symbol, Increase::Models::Export::Status] The status of the Export.
206
234
  #
207
- # @param transaction_csv [Increase::Models::Export::TransactionCsv, nil] Details of the transaction CSV export. This field will be present when the `cate
235
+ # @param transaction_csv [Increase::Models::Export::TransactionCsv, nil]
236
+ # Details of the transaction CSV export. This field will be present when the
237
+ # `category` is equal to `transaction_csv`.
208
238
  #
209
- # @param type [Symbol, Increase::Models::Export::Type] A constant representing the object's type. For this resource it will always be `
239
+ # @param type [Symbol, Increase::Models::Export::Type]
240
+ # A constant representing the object's type. For this resource it will always be
241
+ # `export`.
210
242
  #
211
- # @param vendor_csv [Increase::Models::Export::VendorCsv, nil] Details of the vendor CSV export. This field will be present when the `category`
243
+ # @param vendor_csv [Increase::Models::Export::VendorCsv, nil]
244
+ # Details of the vendor CSV export. This field will be present when the `category`
245
+ # is equal to `vendor_csv`.
212
246
  #
213
- # @param voided_check [Increase::Models::Export::VoidedCheck, nil] Details of the voided check export. This field will be present when the `categor
247
+ # @param voided_check [Increase::Models::Export::VoidedCheck, nil]
248
+ # Details of the voided check export. This field will be present when the
249
+ # `category` is equal to `voided_check`.
214
250
 
215
251
  # @see Increase::Models::Export#account_statement_bai2
216
252
  class AccountStatementBai2 < Increase::Internal::Type::BaseModel
@@ -263,7 +299,8 @@ module Increase
263
299
  #
264
300
  # @param account_id [String] The Account to create a statement for.
265
301
  #
266
- # @param created_at [Increase::Models::Export::AccountStatementOfx::CreatedAt, nil] Filter transactions by their created date.
302
+ # @param created_at [Increase::Models::Export::AccountStatementOfx::CreatedAt, nil]
303
+ # Filter transactions by their created date.
267
304
 
268
305
  # @see Increase::Models::Export::AccountStatementOfx#created_at
269
306
  class CreatedAt < Increase::Internal::Type::BaseModel
@@ -331,7 +368,8 @@ module Increase
331
368
  #
332
369
  # @param account_id [String, nil] Filter results by Account.
333
370
  #
334
- # @param created_at [Increase::Models::Export::BalanceCsv::CreatedAt, nil] Filter balances by their created date.
371
+ # @param created_at [Increase::Models::Export::BalanceCsv::CreatedAt, nil]
372
+ # Filter balances by their created date.
335
373
 
336
374
  # @see Increase::Models::Export::BalanceCsv#created_at
337
375
  class CreatedAt < Increase::Internal::Type::BaseModel
@@ -498,13 +536,12 @@ module Increase
498
536
  required :created_at, -> { Increase::Export::FeeCsv::CreatedAt }, nil?: true
499
537
 
500
538
  # @!method initialize(created_at:)
501
- # Some parameter documentations has been truncated, see
502
- # {Increase::Models::Export::FeeCsv} for more details.
503
- #
504
539
  # Details of the fee CSV export. This field will be present when the `category` is
505
540
  # equal to `fee_csv`.
506
541
  #
507
- # @param created_at [Increase::Models::Export::FeeCsv::CreatedAt, nil] Filter fees by their created date. The time range must not include any fees that
542
+ # @param created_at [Increase::Models::Export::FeeCsv::CreatedAt, nil]
543
+ # Filter fees by their created date. The time range must not include any fees that
544
+ # are part of an open fee statement.
508
545
 
509
546
  # @see Increase::Models::Export::FeeCsv#created_at
510
547
  class CreatedAt < Increase::Internal::Type::BaseModel
@@ -685,7 +722,8 @@ module Increase
685
722
  #
686
723
  # @param account_id [String, nil] Filter results by Account.
687
724
  #
688
- # @param created_at [Increase::Models::Export::TransactionCsv::CreatedAt, nil] Filter transactions by their created date.
725
+ # @param created_at [Increase::Models::Export::TransactionCsv::CreatedAt, nil]
726
+ # Filter transactions by their created date.
689
727
 
690
728
  # @see Increase::Models::Export::TransactionCsv#created_at
691
729
  class CreatedAt < Increase::Internal::Type::BaseModel
@@ -750,7 +788,8 @@ module Increase
750
788
  #
751
789
  # @param account_number_id [String] The Account Number for the voided check.
752
790
  #
753
- # @param payer [Array<Increase::Models::Export::VoidedCheck::Payer>] The payer information printed on the check.
791
+ # @param payer [Array<Increase::Models::Export::VoidedCheck::Payer>]
792
+ # The payer information printed on the check.
754
793
 
755
794
  class Payer < Increase::Internal::Type::BaseModel
756
795
  # @!attribute line
@@ -89,34 +89,48 @@ module Increase
89
89
  optional :voided_check, -> { Increase::ExportCreateParams::VoidedCheck }
90
90
 
91
91
  # @!method initialize(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: {})
92
- # Some parameter documentations has been truncated, see
93
- # {Increase::Models::ExportCreateParams} for more details.
94
- #
95
92
  # @param category [Symbol, Increase::Models::ExportCreateParams::Category] The type of Export to create.
96
93
  #
97
- # @param account_statement_bai2 [Increase::Models::ExportCreateParams::AccountStatementBai2] Options for the created export. Required if `category` is equal to `account_stat
94
+ # @param account_statement_bai2 [Increase::Models::ExportCreateParams::AccountStatementBai2]
95
+ # Options for the created export. Required if `category` is equal to
96
+ # `account_statement_bai2`.
98
97
  #
99
- # @param account_statement_ofx [Increase::Models::ExportCreateParams::AccountStatementOfx] Options for the created export. Required if `category` is equal to `account_stat
98
+ # @param account_statement_ofx [Increase::Models::ExportCreateParams::AccountStatementOfx]
99
+ # Options for the created export. Required if `category` is equal to
100
+ # `account_statement_ofx`.
100
101
  #
101
- # @param account_verification_letter [Increase::Models::ExportCreateParams::AccountVerificationLetter] Options for the created export. Required if `category` is equal to `account_veri
102
+ # @param account_verification_letter [Increase::Models::ExportCreateParams::AccountVerificationLetter]
103
+ # Options for the created export. Required if `category` is equal to
104
+ # `account_verification_letter`.
102
105
  #
103
- # @param bookkeeping_account_balance_csv [Increase::Models::ExportCreateParams::BookkeepingAccountBalanceCsv] Options for the created export. Required if `category` is equal to
104
- # `bookkeeping\_
106
+ # @param bookkeeping_account_balance_csv [Increase::Models::ExportCreateParams::BookkeepingAccountBalanceCsv]
107
+ # Options for the created export. Required if `category` is equal to
108
+ # `bookkeeping_account_balance_csv`.
105
109
  #
106
- # @param daily_account_balance_csv [Increase::Models::ExportCreateParams::DailyAccountBalanceCsv] Options for the created export. Required if `category` is equal to `daily_accoun
110
+ # @param daily_account_balance_csv [Increase::Models::ExportCreateParams::DailyAccountBalanceCsv]
111
+ # Options for the created export. Required if `category` is equal to
112
+ # `daily_account_balance_csv`.
107
113
  #
108
- # @param entity_csv [Increase::Models::ExportCreateParams::EntityCsv] Options for the created export. Required if `category` is equal to `entity_csv`.
114
+ # @param entity_csv [Increase::Models::ExportCreateParams::EntityCsv]
115
+ # Options for the created export. Required if `category` is equal to `entity_csv`.
109
116
  #
110
- # @param fee_csv [Increase::Models::ExportCreateParams::FeeCsv] Options for the created export. Required if `category` is equal to `fee_csv`.
117
+ # @param fee_csv [Increase::Models::ExportCreateParams::FeeCsv]
118
+ # Options for the created export. Required if `category` is equal to `fee_csv`.
111
119
  #
112
- # @param funding_instructions [Increase::Models::ExportCreateParams::FundingInstructions] Options for the created export. Required if `category` is equal to `funding_inst
120
+ # @param funding_instructions [Increase::Models::ExportCreateParams::FundingInstructions]
121
+ # Options for the created export. Required if `category` is equal to
122
+ # `funding_instructions`.
113
123
  #
114
- # @param transaction_csv [Increase::Models::ExportCreateParams::TransactionCsv] Options for the created export. Required if `category` is equal to
115
- # `transaction\_
124
+ # @param transaction_csv [Increase::Models::ExportCreateParams::TransactionCsv]
125
+ # Options for the created export. Required if `category` is equal to
126
+ # `transaction_csv`.
116
127
  #
117
- # @param vendor_csv [Increase::Models::ExportCreateParams::VendorCsv] Options for the created export. Required if `category` is equal to `vendor_csv`.
128
+ # @param vendor_csv [Increase::Models::ExportCreateParams::VendorCsv]
129
+ # Options for the created export. Required if `category` is equal to `vendor_csv`.
118
130
  #
119
- # @param voided_check [Increase::Models::ExportCreateParams::VoidedCheck] Options for the created export. Required if `category` is equal to `voided_check
131
+ # @param voided_check [Increase::Models::ExportCreateParams::VoidedCheck]
132
+ # Options for the created export. Required if `category` is equal to
133
+ # `voided_check`.
120
134
  #
121
135
  # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}]
122
136
 
@@ -189,17 +203,22 @@ module Increase
189
203
  optional :program_id, String
190
204
 
191
205
  # @!method initialize(account_id: nil, effective_date: nil, program_id: nil)
192
- # Some parameter documentations has been truncated, see
193
- # {Increase::Models::ExportCreateParams::AccountStatementBai2} for more details.
194
- #
195
206
  # Options for the created export. Required if `category` is equal to
196
207
  # `account_statement_bai2`.
197
208
  #
198
- # @param account_id [String] The Account to create a BAI2 report for. If not provided, all open accounts will
209
+ # @param account_id [String]
210
+ # The Account to create a BAI2 report for. If not provided, all open accounts will
211
+ # be included.
199
212
  #
200
- # @param effective_date [Date] The date to create a BAI2 report for. If not provided, the current date will be
213
+ # @param effective_date [Date]
214
+ # The date to create a BAI2 report for. If not provided, the current date will be
215
+ # used. The timezone is UTC. If the current date is used, the report will include
216
+ # intraday balances, otherwise it will include end-of-day balances for the
217
+ # provided date.
201
218
  #
202
- # @param program_id [String] The Program to create a BAI2 report for. If not provided, all open accounts will
219
+ # @param program_id [String]
220
+ # The Program to create a BAI2 report for. If not provided, all open accounts will
221
+ # be included.
203
222
  end
204
223
 
205
224
  class AccountStatementOfx < Increase::Internal::Type::BaseModel
@@ -221,7 +240,8 @@ module Increase
221
240
  #
222
241
  # @param account_id [String] The Account to create a statement for.
223
242
  #
224
- # @param created_at [Increase::Models::ExportCreateParams::AccountStatementOfx::CreatedAt] Filter transactions by their created date.
243
+ # @param created_at [Increase::Models::ExportCreateParams::AccountStatementOfx::CreatedAt]
244
+ # Filter transactions by their created date.
225
245
 
226
246
  # @see Increase::Models::ExportCreateParams::AccountStatementOfx#created_at
227
247
  class CreatedAt < Increase::Internal::Type::BaseModel
@@ -289,14 +309,12 @@ module Increase
289
309
  optional :on_or_before_date, Date
290
310
 
291
311
  # @!method initialize(bookkeeping_account_id: nil, on_or_after_date: nil, on_or_before_date: nil)
292
- # Some parameter documentations has been truncated, see
293
- # {Increase::Models::ExportCreateParams::BookkeepingAccountBalanceCsv} for more
294
- # details.
295
- #
296
312
  # Options for the created export. Required if `category` is equal to
297
313
  # `bookkeeping_account_balance_csv`.
298
314
  #
299
- # @param bookkeeping_account_id [String] Filter exported Bookkeeping Account Balances to the specified Bookkeeping Accoun
315
+ # @param bookkeeping_account_id [String]
316
+ # Filter exported Bookkeeping Account Balances to the specified Bookkeeping
317
+ # Account.
300
318
  #
301
319
  # @param on_or_after_date [Date] Filter exported Balances to those on or after this date.
302
320
  #
@@ -354,7 +372,8 @@ module Increase
354
372
  # @!method initialize(created_at: nil, program_id: nil)
355
373
  # Options for the created export. Required if `category` is equal to `fee_csv`.
356
374
  #
357
- # @param created_at [Increase::Models::ExportCreateParams::FeeCsv::CreatedAt] Filter results by time range on the `created_at` attribute.
375
+ # @param created_at [Increase::Models::ExportCreateParams::FeeCsv::CreatedAt]
376
+ # Filter results by time range on the `created_at` attribute.
358
377
  #
359
378
  # @param program_id [String] Filter exported Fees to the specified Program.
360
379
 
@@ -389,18 +408,23 @@ module Increase
389
408
  optional :on_or_before, Time
390
409
 
391
410
  # @!method initialize(after: nil, before: nil, on_or_after: nil, on_or_before: nil)
392
- # Some parameter documentations has been truncated, see
393
- # {Increase::Models::ExportCreateParams::FeeCsv::CreatedAt} for more details.
394
- #
395
411
  # Filter results by time range on the `created_at` attribute.
396
412
  #
397
- # @param after [Time] Return results after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) tim
413
+ # @param after [Time]
414
+ # Return results after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)
415
+ # timestamp.
398
416
  #
399
- # @param before [Time] Return results before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) ti
417
+ # @param before [Time]
418
+ # Return results before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)
419
+ # timestamp.
400
420
  #
401
- # @param on_or_after [Time] Return results on or after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_860
421
+ # @param on_or_after [Time]
422
+ # Return results on or after this
423
+ # [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.
402
424
  #
403
- # @param on_or_before [Time] Return results on or before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_86
425
+ # @param on_or_before [Time]
426
+ # Return results on or before this
427
+ # [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.
404
428
  end
405
429
  end
406
430
 
@@ -437,7 +461,8 @@ module Increase
437
461
  #
438
462
  # @param account_id [String] Filter exported Transactions to the specified Account.
439
463
  #
440
- # @param created_at [Increase::Models::ExportCreateParams::TransactionCsv::CreatedAt] Filter results by time range on the `created_at` attribute.
464
+ # @param created_at [Increase::Models::ExportCreateParams::TransactionCsv::CreatedAt]
465
+ # Filter results by time range on the `created_at` attribute.
441
466
 
442
467
  # @see Increase::Models::ExportCreateParams::TransactionCsv#created_at
443
468
  class CreatedAt < Increase::Internal::Type::BaseModel
@@ -470,19 +495,23 @@ module Increase
470
495
  optional :on_or_before, Time
471
496
 
472
497
  # @!method initialize(after: nil, before: nil, on_or_after: nil, on_or_before: nil)
473
- # Some parameter documentations has been truncated, see
474
- # {Increase::Models::ExportCreateParams::TransactionCsv::CreatedAt} for more
475
- # details.
476
- #
477
498
  # Filter results by time range on the `created_at` attribute.
478
499
  #
479
- # @param after [Time] Return results after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) tim
500
+ # @param after [Time]
501
+ # Return results after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)
502
+ # timestamp.
480
503
  #
481
- # @param before [Time] Return results before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) ti
504
+ # @param before [Time]
505
+ # Return results before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)
506
+ # timestamp.
482
507
  #
483
- # @param on_or_after [Time] Return results on or after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_860
508
+ # @param on_or_after [Time]
509
+ # Return results on or after this
510
+ # [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.
484
511
  #
485
- # @param on_or_before [Time] Return results on or before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_86
512
+ # @param on_or_before [Time]
513
+ # Return results on or before this
514
+ # [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.
486
515
  end
487
516
  end
488
517
 
@@ -511,7 +540,8 @@ module Increase
511
540
  #
512
541
  # @param account_number_id [String] The Account Number for the voided check.
513
542
  #
514
- # @param payer [Array<Increase::Models::ExportCreateParams::VoidedCheck::Payer>] The payer information to be printed on the check.
543
+ # @param payer [Array<Increase::Models::ExportCreateParams::VoidedCheck::Payer>]
544
+ # The payer information to be printed on the check.
515
545
 
516
546
  class Payer < Increase::Internal::Type::BaseModel
517
547
  # @!attribute line
@@ -56,10 +56,8 @@ module Increase
56
56
  optional :status, -> { Increase::ExportListParams::Status }
57
57
 
58
58
  # @!method initialize(category: nil, created_at: nil, cursor: nil, form_1099_int: nil, form_1099_misc: nil, idempotency_key: nil, limit: nil, status: nil, request_options: {})
59
- # Some parameter documentations has been truncated, see
60
- # {Increase::Models::ExportListParams} for more details.
61
- #
62
- # @param category [Symbol, Increase::Models::ExportListParams::Category] Filter Exports for those with the specified category.
59
+ # @param category [Symbol, Increase::Models::ExportListParams::Category]
60
+ # Filter Exports for those with the specified category.
63
61
  #
64
62
  # @param created_at [Increase::Models::ExportListParams::CreatedAt]
65
63
  #
@@ -69,9 +67,15 @@ module Increase
69
67
  #
70
68
  # @param form_1099_misc [Increase::Models::ExportListParams::Form1099Misc]
71
69
  #
72
- # @param idempotency_key [String] Filter records to the one with the specified `idempotency_key` you chose for tha
70
+ # @param idempotency_key [String]
71
+ # Filter records to the one with the specified `idempotency_key` you chose for
72
+ # that object. This value is unique across Increase and is used to ensure that a
73
+ # request is only processed once. Learn more about
74
+ # [idempotency](https://increase.com/documentation/idempotency-keys).
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 status [Increase::Models::ExportListParams::Status]
77
81
  #
@@ -160,16 +164,21 @@ module Increase
160
164
  optional :on_or_before, Time
161
165
 
162
166
  # @!method initialize(after: nil, before: nil, on_or_after: nil, on_or_before: nil)
163
- # Some parameter documentations has been truncated, see
164
- # {Increase::Models::ExportListParams::CreatedAt} for more details.
165
- #
166
- # @param after [Time] Return results after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) tim
167
+ # @param after [Time]
168
+ # Return results after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)
169
+ # timestamp.
167
170
  #
168
- # @param before [Time] Return results before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) ti
171
+ # @param before [Time]
172
+ # Return results before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)
173
+ # timestamp.
169
174
  #
170
- # @param on_or_after [Time] Return results on or after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_860
175
+ # @param on_or_after [Time]
176
+ # Return results on or after this
177
+ # [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.
171
178
  #
172
- # @param on_or_before [Time] Return results on or before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_86
179
+ # @param on_or_before [Time]
180
+ # Return results on or before this
181
+ # [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.
173
182
  end
174
183
 
175
184
  class Form1099Int < Increase::Internal::Type::BaseModel
@@ -206,10 +215,10 @@ module Increase
206
215
  api_name: :in
207
216
 
208
217
  # @!method initialize(in_: nil)
209
- # Some parameter documentations has been truncated, see
210
- # {Increase::Models::ExportListParams::Status} for more details.
211
- #
212
- # @param in_ [Array<Symbol, Increase::Models::ExportListParams::Status::In>] Filter Exports for those with the specified status or statuses. For GET requests
218
+ # @param in_ [Array<Symbol, Increase::Models::ExportListParams::Status::In>]
219
+ # Filter Exports for those with the specified status or statuses. For GET
220
+ # requests, this should be encoded as a comma-delimited string, such as
221
+ # `?in=one,two,three`.
213
222
 
214
223
  module In
215
224
  extend Increase::Internal::Type::Enum
@@ -69,31 +69,37 @@ module Increase
69
69
  required :type, enum: -> { Increase::ExternalAccount::Type }
70
70
 
71
71
  # @!method initialize(id:, account_holder:, account_number:, created_at:, description:, funding:, idempotency_key:, routing_number:, status:, type:)
72
- # Some parameter documentations has been truncated, see
73
- # {Increase::Models::ExternalAccount} for more details.
74
- #
75
72
  # External Accounts represent accounts at financial institutions other than
76
73
  # Increase. You can use this API to store their details for reuse.
77
74
  #
78
75
  # @param id [String] The External Account's identifier.
79
76
  #
80
- # @param account_holder [Symbol, Increase::Models::ExternalAccount::AccountHolder] The type of entity that owns the External Account.
77
+ # @param account_holder [Symbol, Increase::Models::ExternalAccount::AccountHolder]
78
+ # The type of entity that owns the External Account.
81
79
  #
82
80
  # @param account_number [String] The destination account number.
83
81
  #
84
- # @param created_at [Time] The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which th
82
+ # @param created_at [Time]
83
+ # The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
84
+ # the External Account was created.
85
85
  #
86
86
  # @param description [String] The External Account's description for display purposes.
87
87
  #
88
- # @param funding [Symbol, Increase::Models::ExternalAccount::Funding] The type of the account to which the transfer will be sent.
88
+ # @param funding [Symbol, Increase::Models::ExternalAccount::Funding]
89
+ # The type of the account to which the transfer will be sent.
89
90
  #
90
- # @param idempotency_key [String, nil] The idempotency key you chose for this object. This value is unique across Incre
91
+ # @param idempotency_key [String, nil]
92
+ # The idempotency key you chose for this object. This value is unique across
93
+ # Increase and is used to ensure that a request is only processed once. Learn more
94
+ # about [idempotency](https://increase.com/documentation/idempotency-keys).
91
95
  #
92
96
  # @param routing_number [String] The American Bankers' Association (ABA) Routing Transit Number (RTN).
93
97
  #
94
98
  # @param status [Symbol, Increase::Models::ExternalAccount::Status] The External Account's status.
95
99
  #
96
- # @param type [Symbol, Increase::Models::ExternalAccount::Type] A constant representing the object's type. For this resource it will always be `
100
+ # @param type [Symbol, Increase::Models::ExternalAccount::Type]
101
+ # A constant representing the object's type. For this resource it will always be
102
+ # `external_account`.
97
103
 
98
104
  # The type of entity that owns the External Account.
99
105
  #
@@ -39,18 +39,19 @@ module Increase
39
39
  optional :funding, enum: -> { Increase::ExternalAccountCreateParams::Funding }
40
40
 
41
41
  # @!method initialize(account_number:, description:, routing_number:, account_holder: nil, funding: nil, request_options: {})
42
- # Some parameter documentations has been truncated, see
43
- # {Increase::Models::ExternalAccountCreateParams} for more details.
44
- #
45
42
  # @param account_number [String] The account number for the destination account.
46
43
  #
47
44
  # @param description [String] The name you choose for the Account.
48
45
  #
49
- # @param routing_number [String] The American Bankers' Association (ABA) Routing Transit Number (RTN) for the des
46
+ # @param routing_number [String]
47
+ # The American Bankers' Association (ABA) Routing Transit Number (RTN) for the
48
+ # destination account.
50
49
  #
51
- # @param account_holder [Symbol, Increase::Models::ExternalAccountCreateParams::AccountHolder] The type of entity that owns the External Account.
50
+ # @param account_holder [Symbol, Increase::Models::ExternalAccountCreateParams::AccountHolder]
51
+ # The type of entity that owns the External Account.
52
52
  #
53
- # @param funding [Symbol, Increase::Models::ExternalAccountCreateParams::Funding] The type of the destination account. Defaults to `checking`.
53
+ # @param funding [Symbol, Increase::Models::ExternalAccountCreateParams::Funding]
54
+ # The type of the destination account. Defaults to `checking`.
54
55
  #
55
56
  # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}]
56
57
 
@@ -41,14 +41,17 @@ module Increase
41
41
  optional :status, -> { Increase::ExternalAccountListParams::Status }
42
42
 
43
43
  # @!method initialize(cursor: nil, idempotency_key: nil, limit: nil, routing_number: nil, status: nil, request_options: {})
44
- # Some parameter documentations has been truncated, see
45
- # {Increase::Models::ExternalAccountListParams} for more details.
46
- #
47
44
  # @param cursor [String] Return the page of entries after this one.
48
45
  #
49
- # @param idempotency_key [String] Filter records to the one with the specified `idempotency_key` you chose for tha
46
+ # @param idempotency_key [String]
47
+ # Filter records to the one with the specified `idempotency_key` you chose for
48
+ # that object. This value is unique across Increase and is used to ensure that a
49
+ # request is only processed once. Learn more about
50
+ # [idempotency](https://increase.com/documentation/idempotency-keys).
50
51
  #
51
- # @param limit [Integer] Limit the size of the list that is returned. The default (and maximum) is 100 ob
52
+ # @param limit [Integer]
53
+ # Limit the size of the list that is returned. The default (and maximum) is 100
54
+ # objects.
52
55
  #
53
56
  # @param routing_number [String] Filter External Accounts to those with the specified Routing Number.
54
57
  #
@@ -70,10 +73,10 @@ module Increase
70
73
  api_name: :in
71
74
 
72
75
  # @!method initialize(in_: nil)
73
- # Some parameter documentations has been truncated, see
74
- # {Increase::Models::ExternalAccountListParams::Status} for more details.
75
- #
76
- # @param in_ [Array<Symbol, Increase::Models::ExternalAccountListParams::Status::In>] Filter External Accounts for those with the specified status or statuses. For GE
76
+ # @param in_ [Array<Symbol, Increase::Models::ExternalAccountListParams::Status::In>]
77
+ # Filter External Accounts for those with the specified status or statuses. For
78
+ # GET requests, this should be encoded as a comma-delimited string, such as
79
+ # `?in=one,two,three`.
77
80
 
78
81
  module In
79
82
  extend Increase::Internal::Type::Enum
@@ -40,13 +40,16 @@ module Increase
40
40
  # @!method initialize(external_account_id:, account_holder: nil, description: nil, funding: nil, status: nil, request_options: {})
41
41
  # @param external_account_id [String] The external account identifier.
42
42
  #
43
- # @param account_holder [Symbol, Increase::Models::ExternalAccountUpdateParams::AccountHolder] The type of entity that owns the External Account.
43
+ # @param account_holder [Symbol, Increase::Models::ExternalAccountUpdateParams::AccountHolder]
44
+ # The type of entity that owns the External Account.
44
45
  #
45
46
  # @param description [String] The description you choose to give the external account.
46
47
  #
47
- # @param funding [Symbol, Increase::Models::ExternalAccountUpdateParams::Funding] The funding type of the External Account.
48
+ # @param funding [Symbol, Increase::Models::ExternalAccountUpdateParams::Funding]
49
+ # The funding type of the External Account.
48
50
  #
49
- # @param status [Symbol, Increase::Models::ExternalAccountUpdateParams::Status] The status of the External Account.
51
+ # @param status [Symbol, Increase::Models::ExternalAccountUpdateParams::Status]
52
+ # The status of the External Account.
50
53
  #
51
54
  # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}]
52
55